#include <TNativeFile_Win.h>

Inheritance diagram for TNativeFile:

Public Member Functions
	TNativeFile (TNativeFileSystem *a_pFileSystem)

	TNativeFile (const TNativeFile &other)

	~TNativeFile ()

virtual TSIZE	Read (void *a_pDst, TSIZE a_uiSize) OVERRIDE
	Reads specified number of bytes from the file into the buffer.

virtual TSIZE	Write (const void *a_pSrc, TSIZE a_uiSize) OVERRIDE
	Writes specified number of bytes to the file from the buffer.

virtual TBOOL	Seek (TINT a_iOffset, TSEEK a_eOrigin=TSEEK_CUR) OVERRIDE
	Shifts current file cursor based on the specified offset and origin.

virtual TSIZE	Tell () OVERRIDE

virtual void	FlushBuffers () OVERRIDE
	Flushes write buffers.

virtual TSIZE	GetSize () OVERRIDE

virtual TUINT64	GetDate () OVERRIDE

virtual TCHAR	GetCChar () OVERRIDE
	Reads one character of type TCHAR from the file.

virtual TWCHAR	GetWChar () OVERRIDE
	Reads one character of type wchar from the file.

virtual TINT	PutCChar (TCHAR a_cCharacter) OVERRIDE
	Writes one character of type TCHAR to the file.

virtual TINT	PutWChar (TWCHAR a_wcCharacter) OVERRIDE
	Writes one character of type wchar to the file.

virtual TINT	CPrintf (const TCHAR *a_szFormat,...) OVERRIDE
	Analogue of printf but writes result to the file.

virtual TINT	WPrintf (const TWCHAR *a_wszFormat,...) OVERRIDE
	Analogue of wprintf but writes result to the file.

TBOOL	Open (const TString8 &a_FileName, TFILEMODE a_Mode)

void	Close ()

Public Member Functions inherited from TFile
	TFile (TFileSystem *a_pFS)

	TFile (const TFile &a_rOther)

virtual	~TFile ()

TFileSystem *	GetFileSystem () const

void	Destroy ()

Static Public Attributes
static constexpr TUINT32	BUFFER_SIZE = 0x800

Protected Attributes
void *	m_Handle

TUINT32	m_Position

TUINT32	m_RBufferPosition

TUINT32	m_PrevBufferPos

TUINT32	m_LastBufferSize

TCHAR *	m_RBuffer

TCHAR *	m_WBuffer

TUINT32	m_WriteBufferUsed

TBOOL	m_WriteBuffered

Additional Inherited Members
Static Public Member Functions inherited from TFile
static TString8	ConcatPath (const TString8 &a_rcPath1, const TString8 &a_rcPath2)

static TString8	SimplifyPath (const TString8 &a_rcPath)

static TFile *	Create (const TString8 &a_rcFilename, TFILEMODE a_eMode=TFILEMODE_READ)

Detailed Description

Definition at line 22 of file TNativeFile_Win.h.

Constructor & Destructor Documentation

◆ TNativeFile() [1/2]

TNativeFile::TNativeFile ( TNativeFileSystem * a_pFileSystem )

Definition at line 162 of file TNativeFile_Win.cpp.

    : TFile( pFS )
{
    m_Handle          = INVALID_HANDLE_VALUE;
    m_Position        = -1;
    m_RBufferPosition = -1;
    m_PrevBufferPos   = -1;
    m_LastBufferSize  = 0;
    m_RBuffer         = TNULL;
    m_WBuffer         = TNULL;
    m_WriteBufferUsed = 0;
    m_WriteBuffered   = TTRUE;
}

◆ TNativeFile() [2/2]

TNativeFile::TNativeFile ( const TNativeFile & other )

Definition at line 176 of file TNativeFile_Win.cpp.

    : TFile( other )
{
    m_Handle          = other.m_Handle;
    m_Position        = other.m_Position;
    m_RBufferPosition = other.m_RBufferPosition;
    m_PrevBufferPos   = other.m_PrevBufferPos;
    m_LastBufferSize  = other.m_LastBufferSize;
    m_RBuffer         = other.m_RBuffer;
    m_WBuffer         = other.m_WBuffer;
    m_WriteBufferUsed = other.m_WriteBufferUsed;
    m_WriteBuffered   = other.m_WriteBuffered;
}

◆ ~TNativeFile()

TNativeFile::~TNativeFile ( )

Definition at line 191 of file TNativeFile_Win.cpp.

192{

193}

Member Function Documentation

◆ Close()

void TNativeFile::Close ( )

Definition at line 638 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
    CloseHandle( m_Handle );
 
    m_Handle          = INVALID_HANDLE_VALUE;
    m_Position        = -1;
    m_RBufferPosition = -1;
    m_PrevBufferPos   = -1;
    m_LastBufferSize  = -1;
 
    if ( m_RBuffer != TNULL )
    {
        TFree( m_RBuffer );
        m_RBuffer = TNULL;
    }
 
    if ( m_WBuffer != TNULL )
    {
        TFree( m_WBuffer );
        m_WBuffer = TNULL;
    }
}

◆ CPrintf()

TINT TNativeFile::CPrintf	(	const TCHAR *	a_szFormat,
			... )

virtual

Analogue of printf but writes result to the file.

Returns: number of characters written

Implements TFile.

Definition at line 524 of file TNativeFile_Win.cpp.

{
    va_list args;
    va_start( args, a_szFormat );
 
    TCHAR str[ 512 ];
 
    TINT iResult = T2String8::FormatV( str, TARRAYSIZE( str ), a_szFormat, args );
 
    va_end( args );
 
    Write( str, iResult );
 
    return iResult;
}

◆ FlushBuffers()

void TNativeFile::FlushBuffers ( )

virtual

Flushes write buffers.

Reimplemented from TFile.

Definition at line 662 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
}

◆ GetCChar()

TCHAR TNativeFile::GetCChar ( )

virtual

Reads one character of type TCHAR from the file.

Returns: the read character

Implements TFile.

Definition at line 456 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
 
    if ( m_RBuffer != TNULL )
    {
        TUINT32 curBufferPos = m_Position / BUFFER_SIZE * BUFFER_SIZE;
        if ( ( curBufferPos == m_PrevBufferPos ) && ( m_Position - curBufferPos <= m_LastBufferSize - 1 ) )
        {
            TCHAR c = m_RBuffer[ m_Position - curBufferPos ];
            m_Position += sizeof( c );
            return c;
        }
    }
 
    TCHAR result;
    if ( Read( &result, sizeof( result ) ) != sizeof( result ) )
        return -1;
 
    return result;
}

◆ GetDate()

TUINT64 TNativeFile::GetDate ( )

virtual

Returns: last write time

Reimplemented from TFile.

Definition at line 571 of file TNativeFile_Win.cpp.

{
    TUINT64 uiLastWriteTime = 0;
 
    if ( m_Handle != TNULL )
    {
        GetFileTime( m_Handle, NULL, NULL, (LPFILETIME)&uiLastWriteTime );
    }
 
    return uiLastWriteTime;
}

◆ GetSize()

TSIZE TNativeFile::GetSize ( )

virtual

Returns: size of the file

Implements TFile.

Definition at line 558 of file TNativeFile_Win.cpp.

{
    m_RBufferPosition = SetFilePointer( m_Handle, 0, TNULL, TSEEK_END );
 
    if ( m_RBufferPosition == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR )
    {
        return 0;
    }
 
    return m_RBufferPosition;
}

◆ GetWChar()

TWCHAR TNativeFile::GetWChar ( )

virtual

Reads one character of type wchar from the file.

Returns: the read character

Implements TFile.

Definition at line 479 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
 
    if ( m_RBuffer != TNULL )
    {
        TUINT32 curBufferPos = m_Position / BUFFER_SIZE * BUFFER_SIZE;
        if ( ( curBufferPos == m_PrevBufferPos ) && ( m_Position - curBufferPos <= m_LastBufferSize - 1 ) )
        {
            TWCHAR c = *TREINTERPRETCAST( TWCHAR*, &m_RBuffer[ m_Position - curBufferPos ] );
            m_Position += sizeof( c );
            return c;
        }
    }
 
    TWCHAR result;
    if ( Read( &result, sizeof( result ) ) != sizeof( result ) )
        return L'\xFFFF';
 
    return result;
}

◆ Open()

TBOOL TNativeFile::Open	(	const TString8 &	a_FileName,
		TFILEMODE	a_Mode )

Definition at line 584 of file TNativeFile_Win.cpp.

{
    TASSERT( a_FileName.IsIndexValid( 0 ), "TNativeFile::Open - wrong filename" );
 
    DWORD dwCreationDisposition = OPEN_EXISTING;
    DWORD dwDesiredAccess       = 0;
    DWORD dwShareMode           = 0;
 
    dwDesiredAccess |= ( a_Mode & TFILEMODE_READ ) ? GENERIC_READ : dwDesiredAccess;
    dwDesiredAccess |= ( a_Mode & TFILEMODE_WRITE ) ? GENERIC_WRITE : dwDesiredAccess;
    dwDesiredAccess |= ( a_Mode & TFILEMODE_READWRITE ) ? ( GENERIC_READ | GENERIC_WRITE ) : dwDesiredAccess;
 
    if ( a_Mode & TFILEMODE_CREATENEW )
    {
        dwShareMode           = FILE_SHARE_READ;
        dwCreationDisposition = CREATE_ALWAYS;
        dwDesiredAccess |= GENERIC_WRITE;
    }
 
    if ( dwDesiredAccess == 0 )
    {
        TWARN( "WARNING: File created with no access mode, assuming WRITEONLY\n" );
        dwDesiredAccess = GENERIC_WRITE;
    }
 
    m_Handle = CreateFileA( a_FileName.GetString(), dwDesiredAccess, dwShareMode, NULL, dwCreationDisposition, NULL, NULL );
 
    if ( m_Handle != INVALID_HANDLE_VALUE )
    {
        m_Position        = 0;
        m_RBufferPosition = 0;
        m_PrevBufferPos   = -1;
        m_LastBufferSize  = 0;
 
        if ( a_Mode & TFILEMODE_NOBUFFER )
        {
            m_WriteBuffered = TFALSE;
        }
        else
        {
            m_RBuffer       = (TCHAR*)TMalloc( BUFFER_SIZE );
            m_WBuffer       = (TCHAR*)TMalloc( BUFFER_SIZE );
            m_WriteBuffered = TTRUE;
        }
    }
    else
    {
        return TFALSE;
    }
 
    return TTRUE;
}

◆ PutCChar()

TINT TNativeFile::PutCChar ( TCHAR a_cCharacter )

virtual

Writes one character of type TCHAR to the file.

Returns: code of the written character

Implements TFile.

Definition at line 502 of file TNativeFile_Win.cpp.

{
    if ( Write( &a_cCharacter, 1 ) != 1 )
    {
        return -1;
    }
 
    return a_cCharacter & 0xFF;
}

◆ PutWChar()

TINT TNativeFile::PutWChar ( TWCHAR a_wcCharacter )

virtual

Writes one character of type wchar to the file.

Returns: number of written bytes

Implements TFile.

Definition at line 513 of file TNativeFile_Win.cpp.

{
    if ( Write( &a_wcCharacter, 2 ) != 2 )
    {
        return -1;
    }
 
    return a_wcCharacter & 0xFFFF;
}

◆ Read()

TSIZE TNativeFile::Read	(	void *	a_pDst,
		TSIZE	a_uiSize )

virtual

Reads specified number of bytes from the file into the buffer.

Parameters

a_pDst	destination buffer
a_uiSize	number of bytes to read

Returns: the number of read bytes

Implements TFile.

Definition at line 289 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
 
    if ( a_uiSize < 1 ) return 0;
 
    if ( m_RBuffer != TNULL )
    {
        TSIZE  readedCount  = 0;
        TSIZE  startPos     = m_Position;
        TSIZE  curBufferPos = startPos / BUFFER_SIZE * BUFFER_SIZE;
        TSIZE  newBufferPos = ( startPos + a_uiSize ) / BUFFER_SIZE * BUFFER_SIZE;
        LPVOID curPosBuffer = a_pDst;
 
        if ( curBufferPos != newBufferPos )
        {
            if ( curBufferPos == m_PrevBufferPos )
            {
                DWORD readCount = m_LastBufferSize - ( startPos - curBufferPos );
 
                if ( readCount > 0 )
                {
                    TUtil::MemCopy( a_pDst, m_RBuffer + startPos - curBufferPos, readCount );
 
                    curPosBuffer = (TCHAR*)a_pDst + readCount;
                    m_Position += readCount;
                    readedCount = readCount;
                }
            }
 
            DWORD toReadCount = newBufferPos - m_Position;
            curBufferPos      = newBufferPos;
 
            if ( toReadCount > 0 )
            {
                TUINT32 readed = ReadUnbuffered( curPosBuffer, toReadCount );
                curPosBuffer   = (TCHAR*)curPosBuffer + readed;
                readedCount += readed;
 
                if ( readed != toReadCount )
                {
                    // end of file?
                    return readedCount;
                }
            }
        }
 
        if ( readedCount != a_uiSize && LoadBuffer( curBufferPos ) )
        {
            a_uiSize -= readedCount;
            DWORD bufferLeftSize = m_Position - curBufferPos;
            DWORD readCount      = m_LastBufferSize - bufferLeftSize;
            readCount            = TMath::Min<DWORD>( readCount, a_uiSize );
 
            if ( readCount > 0 )
            {
                TUtil::MemCopy( curPosBuffer, m_RBuffer + bufferLeftSize, readCount );
                m_Position += readCount;
                readedCount += readCount;
            }
        }
 
        return readedCount;
    }
 
    return ReadUnbuffered( a_pDst, a_uiSize );
}

◆ Seek()

TBOOL TNativeFile::Seek	(	TINT	a_iOffset,
		TSEEK	a_eOrigin = TSEEK_CUR )

virtual

Shifts current file cursor based on the specified offset and origin.

Parameters

a_iOffset	number of characters to shift the position
a_eOrigin	position to which a_iOffset is added

Returns: TTRUE if succeeded

Implements TFile.

Definition at line 426 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
 
    if ( a_eOrigin == TSEEK_SET )
    {
        m_Position = a_iOffset;
    }
    else if ( a_eOrigin == TSEEK_CUR )
    {
        m_Position += a_iOffset;
    }
    else if ( a_eOrigin == TSEEK_END )
    {
        m_RBufferPosition = SetFilePointer( m_Handle, a_iOffset, TNULL, FILE_END );
 
        if ( m_RBufferPosition == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR )
        {
            return TFALSE;
        }
 
        m_Position = m_RBufferPosition;
    }
 
    if ( m_Position < 0 ) m_Position = 0;
 
    return TTRUE;
}

◆ Tell()

TSIZE TNativeFile::Tell ( )

virtual

Returns: current position of the file cursor

Implements TFile.

Definition at line 419 of file TNativeFile_Win.cpp.

{
    FlushWriteBuffer();
    return m_Position;
}

◆ WPrintf()

TINT TNativeFile::WPrintf	(	const TWCHAR *	a_wszFormat,
			... )

virtual

Analogue of wprintf but writes result to the file.

Returns: number of characters written

Implements TFile.

Definition at line 541 of file TNativeFile_Win.cpp.

{
    va_list args;
    va_start( args, a_wszFormat );
 
    TWCHAR str[ 512 ];
 
    TINT iResult = T2String16::FormatV( str, TARRAYSIZE( str ), a_wszFormat, args );
 
    Write( str, iResult * sizeof( TWCHAR ) );
 
    va_end( args );
 
    return iResult;
}

◆ Write()

TSIZE TNativeFile::Write	(	const void *	a_pSrc,
		TSIZE	a_uiSize )

virtual

Writes specified number of bytes to the file from the buffer.

Parameters

a_pSrc	sourde buffer
a_uiSize	number of bytes to write

Returns: the number of written bytes

Implements TFile.

Definition at line 358 of file TNativeFile_Win.cpp.

{
    if ( m_RBufferPosition != m_Position )
    {
        TASSERT( TFALSE == m_WriteBuffered || m_WriteBufferUsed == 0 );
        m_RBufferPosition = SetFilePointer( m_Handle, m_Position, NULL, FILE_BEGIN );
 
        if ( m_RBufferPosition == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR )
        {
            return 0;
        }
 
        m_Position = m_RBufferPosition;
    }
 
    if ( m_WriteBuffered == TFALSE )
    {
        DWORD written;
        BOOL  bRes = WriteFile( m_Handle, buffer, size, &written, NULL );
 
        if ( bRes == FALSE )
        {
            return 0;
        }
 
        m_RBufferPosition += written;
        m_Position = m_RBufferPosition;
        return written;
    }
 
    // Flush write buffer if data doesn't fit it
    if ( m_WriteBufferUsed + size >= BUFFER_SIZE )
    {
        FlushWriteBuffer();
    }
 
    if ( size < BUFFER_SIZE )
    {
        // Data fits the write buffer so append it to it
        TUtil::MemCopy( m_WBuffer + m_WriteBufferUsed, buffer, size );
        m_WriteBufferUsed += size;
        return size;
    }
    else
    {
        // Data doesn't fit the write buffer at all so write it right now
        DWORD written;
        BOOL  bRes = WriteFile( m_Handle, buffer, size, &written, NULL );
 
        if ( bRes != FALSE )
        {
            m_RBufferPosition += size;
            m_Position = m_RBufferPosition;
            return written;
        }
    }
 
    return 0;
}

Member Data Documentation

◆ BUFFER_SIZE

TUINT32 TNativeFile::BUFFER_SIZE = 0x800

staticconstexpr

Definition at line 25 of file TNativeFile_Win.h.

◆ m_Handle

void* TNativeFile::m_Handle

protected

Definition at line 59 of file TNativeFile_Win.h.

◆ m_LastBufferSize

TUINT32 TNativeFile::m_LastBufferSize

protected

Definition at line 63 of file TNativeFile_Win.h.

◆ m_Position

TUINT32 TNativeFile::m_Position

protected

Definition at line 60 of file TNativeFile_Win.h.

◆ m_PrevBufferPos

TUINT32 TNativeFile::m_PrevBufferPos

protected

Definition at line 62 of file TNativeFile_Win.h.

◆ m_RBuffer

TCHAR* TNativeFile::m_RBuffer

protected

Definition at line 64 of file TNativeFile_Win.h.

◆ m_RBufferPosition

TUINT32 TNativeFile::m_RBufferPosition

protected

Definition at line 61 of file TNativeFile_Win.h.

◆ m_WBuffer

TCHAR* TNativeFile::m_WBuffer

protected

Definition at line 65 of file TNativeFile_Win.h.

◆ m_WriteBuffered

TBOOL TNativeFile::m_WriteBuffered

protected

Definition at line 67 of file TNativeFile_Win.h.

◆ m_WriteBufferUsed

TUINT32 TNativeFile::m_WriteBufferUsed

protected

Definition at line 66 of file TNativeFile_Win.h.

The documentation for this class was generated from the following files:

D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/Windows/TNativeFile_Win.h
D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/Windows/TNativeFile_Win.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TNativeFile() [1/2]

◆ TNativeFile() [2/2]

◆ ~TNativeFile()

Member Function Documentation

◆ Close()

◆ CPrintf()

◆ FlushBuffers()

◆ GetCChar()

◆ GetDate()

◆ GetSize()

◆ GetWChar()

◆ Open()

◆ PutCChar()

◆ PutWChar()

◆ Read()

◆ Seek()

◆ Tell()

◆ WPrintf()

◆ Write()

Member Data Documentation

◆ BUFFER_SIZE

◆ m_Handle

◆ m_LastBufferSize

◆ m_Position

◆ m_PrevBufferPos

◆ m_RBuffer

◆ m_RBufferPosition

◆ m_WBuffer

◆ m_WriteBuffered

◆ m_WriteBufferUsed