TFile Class Reference

#include <TFile.h>

Inheritance diagram for TFile:

Public Member Functions
	TFile (TFileSystem *a_pFS)
	TFile (const TFile &a_rOther)
virtual TSIZE	Read (void *a_pDst, TSIZE a_uiSize)=0
	Reads specified number of bytes from the file into the buffer.
virtual TSIZE	Write (const void *a_pSrc, TSIZE a_uiSize)=0
	Writes specified number of bytes to the file from the buffer.
virtual TBOOL	Seek (TINT a_iOffset, TSEEK a_eOrigin=TSEEK_CUR)=0
	Shifts current file cursor based on the specified offset and origin.
virtual TSIZE	Tell ()=0
virtual void	FlushBuffers ()
	Flushes write buffers.
virtual TSIZE	GetSize ()=0
virtual TUINT64	GetDate ()
virtual TCHAR	GetCChar ()=0
	Reads one character of type TCHAR from the file.
virtual TWCHAR	GetWChar ()=0
	Reads one character of type wchar from the file.
virtual TINT	PutCChar (TCHAR a_cCharacter)=0
	Writes one character of type TCHAR to the file.
virtual TINT	PutWChar (TWCHAR a_wcCharacter)=0
	Writes one character of type wchar to the file.
virtual TINT	CPrintf (const TCHAR *a_szFormat,...)=0
	Analogue of printf but writes result to the file.
virtual TINT	WPrintf (const TWCHAR *a_wszFormat,...)=0
	Analogue of wprintf but writes result to the file.
virtual	~TFile ()
TFileSystem *	GetFileSystem () const
void	Destroy ()

Static Public Member Functions
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 127 of file TFile.h.

Constructor & Destructor Documentation

TFile() [1/2]

TFile::TFile

(

TFileSystem *

a_pFS

)

Definition at line 13 of file TFile.cpp.

{
    m_pFileSystem = pFS;
}

TFile() [2/2]

TFile::TFile

(

const TFile &

a_rOther

)

Definition at line 18 of file TFile.cpp.

{
    m_pFileSystem = other.GetFileSystem();
}

~TFile()

TFile::~TFile ( )

virtual

Definition at line 24 of file TFile.cpp.

{
}

Member Function Documentation

ConcatPath()

TString8 TFile::ConcatPath ( const TString8 & a_rcPath1, const TString8 & a_rcPath2 )

static

Definition at line 48 of file TFile.cpp.

{
    TString8 strResult;
 
    TINT iPath1StartPos = 0;
    TINT iPath2StartPos = 0;
 
    // Copy filesystem/volume name from a_rcPath1 or a_rcPath2
    // prioritizing the one in a_rcPath2
    TINT iColonPos = a_rcPath2.FindReverse( ':' );
 
    if ( iColonPos == -1 )
    {
        iColonPos = a_rcPath1.FindReverse( ':' );
 
        if ( iColonPos > -1 )
        {
            // Copy volume/filesystem name from the first path
            iPath1StartPos = iColonPos + 1;
            strResult.Concat( a_rcPath1, iPath1StartPos );
        }
    }
    else
    {
        // Copy volume/filesystem name from the second path
        iPath2StartPos = iColonPos + 1;
        strResult.Concat( a_rcPath2, iPath2StartPos );
 
        // Ignore everything before the ':' character in the first path
        iPath1StartPos = a_rcPath1.FindReverse( ':' ) + 1;
    }
 
    TINT iPath1Length = a_rcPath1.Length();
    TINT iPath2Length = a_rcPath2.Length();
 
    if ( iPath2StartPos < iPath2Length &&
         ( a_rcPath2[ iPath2StartPos ] == '/' || a_rcPath2[ iPath2StartPos ] == '\\' ) )
    {
        // The second path starts from a filesystem/volume root so ignore the first path
        strResult += a_rcPath2.GetString( iPath2StartPos );
    }
    else
    {
        // Concat the first path with the second one trimming parts like 'C:' or 'native:' and etc.
        strResult += a_rcPath1.GetString( iPath1StartPos );
        if ( iPath1StartPos < iPath1Length && iPath2StartPos < iPath2Length &&
             a_rcPath1[ iPath1Length - 1 ] != '/' && a_rcPath1[ iPath1Length - 1 ] != '\\' )
        {
            strResult += "/";
        }
 
        strResult += a_rcPath2.GetString( iPath2StartPos );
    }
 
    return SimplifyPath( strResult );
}

CPrintf()

virtual TINT TFile::CPrintf ( const TCHAR * a_szFormat, ... )

pure virtual

Analogue of printf but writes result to the file.

Returns

number of characters written

Implemented in TNativeFile.

Create()

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

static

Definition at line 29 of file TFile.cpp.

{
    TASSERT( filename.IsIndexValid( 0 ), "filename is empty" );
 
    TFile* pFile = TFileManager::GetSingletonSafe()->CreateFile( filename, mode );
 
    if ( pFile != TNULL )
    {
        TTRACE( "TFile::Create - Created file %s with mode %hu\n", filename.GetString(), mode );
    }
    else
    {
        TTRACE( "TFile::Create - Failed to create file %s with mode %hu\n", filename.GetString(), mode );
    }
 
    return pFile;
}

Destroy()

void TFile::Destroy

(

)

Definition at line 184 of file TFile.cpp.

{
    TVALIDPTR( m_pFileSystem );
    m_pFileSystem->DestroyFile( this );
}

FlushBuffers()

virtual void TFile::FlushBuffers ( )

inlinevirtual

Flushes write buffers.

Reimplemented in TNativeFile.

Definition at line 165 of file TFile.h.

{}

GetCChar()

virtual TCHAR TFile::GetCChar ( )

pure virtual

Reads one character of type TCHAR from the file.

Returns

the read character

Implemented in TNativeFile.

GetDate()

virtual TUINT64 TFile::GetDate ( )

inlinevirtual

Returns

last write time

Reimplemented in TNativeFile.

Definition at line 176 of file TFile.h.

{ return 0; }

GetFileSystem()

TFileSystem * TFile::GetFileSystem ( ) const

inline

Definition at line 216 of file TFile.h.

    {
        return m_pFileSystem;
    }

GetSize()

virtual TSIZE TFile::GetSize ( )

pure virtual

Returns

size of the file

Implemented in TNativeFile.

GetWChar()

virtual TWCHAR TFile::GetWChar ( )

pure virtual

Reads one character of type wchar from the file.

Returns

the read character

Implemented in TNativeFile.

PutCChar()

virtual TINT TFile::PutCChar ( TCHAR a_cCharacter )

pure virtual

Writes one character of type TCHAR to the file.

Returns

code of the written character

Implemented in TNativeFile.

PutWChar()

virtual TINT TFile::PutWChar ( TWCHAR a_wcCharacter )

pure virtual

Writes one character of type wchar to the file.

Returns

number of written bytes

Implemented in TNativeFile.

Read()

virtual TSIZE TFile::Read ( void * a_pDst, TSIZE a_uiSize )

pure 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

Implemented in TNativeFile.

Seek()

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

pure 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

Implemented in TNativeFile.

SimplifyPath()

TString8 TFile::SimplifyPath ( const TString8 & a_rcPath )

static

Definition at line 106 of file TFile.cpp.

{
    TString8 strPath = a_rcPath;
    FixPathSlashesBack( strPath );
 
    TINT     iPos = 0;
    TString8 strResult;
 
    // Keep filesystem/volume/protocol name in the simplified path and leave it as it is
    TINT iColonPos = strPath.FindReverse( ':' );
    if ( iColonPos > -1 )
    {
        iPos = iColonPos + 1;
        strResult.Concat( strPath, iPos );
    }
 
    if ( strPath[ iPos ] == '/' )
    {
        iPos += 1;
        strResult += "/";
    }
 
    TINT iInitialResultLength = strResult.Length();
    TINT iResultLength        = iInitialResultLength;
 
    strPath += "/";
    TINT iSlashPos = strPath.Find( '/', iPos );
 
    do
    {
        // Is the path over?
        if ( iSlashPos < 0 )
        {
            if ( iInitialResultLength < strResult.Length() )
            {
                strResult.Truncate( strResult.Length() - 1 );
            }
 
            return strResult;
        }
 
        if ( !strncmp( strPath.GetString( iPos ), "../", 3 ) )
        {
            if ( iResultLength == strResult.Length() )
            {
                // Can't go back to a previous dir since it's the only one
                strResult += "../";
                iResultLength += 3;
            }
            else
            {
                // Truncate the path removing the current dir
                TINT iTruncateTo;
 
                if ( strResult.Length() > 1 && ( iTruncateTo = strResult.FindReverse( '/', strResult.Length() - 2 ), iResultLength <= iTruncateTo ) )
                {
                    strResult.Truncate( iTruncateTo + 1 );
                }
                else
                {
                    strResult.Truncate( iResultLength );
                }
            }
        }
        // Add anything except './'
        else if ( strncmp( strPath.GetString( iPos ), "./", 2 ) != 0 )
        {
            strResult.Concat( strPath.GetString( iPos ), ( iSlashPos - iPos ) + 1 );
        }
 
        iPos      = iSlashPos + 1;
        iSlashPos = strPath.Find( '/', iPos );
 
    } while ( TTRUE );
}

Tell()

virtual TSIZE TFile::Tell ( )

pure virtual

Returns

current position of the file cursor

Implemented in TNativeFile.

WPrintf()

virtual TINT TFile::WPrintf ( const TWCHAR * a_wszFormat, ... )

pure virtual

Analogue of wprintf but writes result to the file.

Returns

number of characters written

Implemented in TNativeFile.

Write()

virtual TSIZE TFile::Write ( const void * a_pSrc, TSIZE a_uiSize )

pure 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

Implemented in TNativeFile.

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/File/TFile.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/File/TFile.cpp