TTSFI Class Reference

#include <TTRB.h>

Inheritance diagram for TTSFI:

Public Member Functions
	TTSFI ()
	~TTSFI ()
TUINT32	ReadAlignmentPad ()
TUINT32	Open (TFile *a_pFile)
TUINT32	Open (const TCHAR *a_szFilePath)
TUINT32	PushForm ()
TUINT32	PopForm ()
void	ReadRaw (void *dst, TUINT32 size)
template<class T>
void	Read (T *a_pDst)
template<class T>
void	Read (T *a_pDst, TUINT a_uiCount)
TUINT8	ReadHunk ()
TUINT8	SkipHunk ()
TUINT8	ReadFORM (TFORM *section)
TUINT8	ReadHunkData (void *dest)
void	Close (TBOOL free=true)
void	ReadCompressed (void *buffer, TUINT32 size)
void	CompressSection (TFile *file, TBYTE *data, TUINT32 unk2, TUINT32 unk3)
const Hunk &	GetCurrentHunk () const
Public Member Functions inherited from TTSF
	TTSF ()
	~TTSF ()=default
Endianess	GetEndianess () const

Friends
class	TTRB

Additional Inherited Members
Static Public Attributes inherited from TTSF
static constexpr TUINT32	IDMAGICB = TFourCC( "TSFB" )
static constexpr TUINT32	IDMAGICL = TFourCC( "TSFL" )
Protected Attributes inherited from TTSF
Endianess	m_Endianess
TFile *	m_pFile

Detailed Description

Definition at line 73 of file TTRB.h.

Constructor & Destructor Documentation

TTSFI()

TTSFI::TTSFI

(

)

Definition at line 186 of file TTSF.cpp.

{
    m_pFile         = TNULL;
    m_FileInfoCount = 0;
    m_UNKFLAG       = TFALSE;
    m_ReadPos       = 0;
    TUtil::MemClear( m_FileInfo, sizeof( m_FileInfo ) );
    m_Magic            = 0;
    m_CurrentHunk.Name = 0;
    m_CurrentHunk.Size = 0;
}

~TTSFI()

TTSFI::~TTSFI ( )

inline

Definition at line 80 of file TTRB.h.

{ Close(); }

Member Function Documentation

Close()

void TTSFI::Close

(

TBOOL

free = true

)

Definition at line 156 of file TTSF.cpp.

{
    PopForm();
 
    if ( m_pFile != TNULL && free )
    {
        m_pFile->Destroy();
    }
 
    m_pFile         = TNULL;
    m_FileInfoCount = 0;
}

CompressSection()

void TTSFI::CompressSection ( TFile * file, TBYTE * data, TUINT32 unk2, TUINT32 unk3 )

inline

Definition at line 103 of file TTRB.h.

{ TCompress::Compress( file, data, unk2, unk3, m_Endianess ); }

GetCurrentHunk()

const Hunk & TTSFI::GetCurrentHunk ( ) const

inline

Definition at line 105 of file TTRB.h.

{ return m_CurrentHunk; }

Open() [1/2]

TUINT32 TTSFI::Open

(

const TCHAR *

a_szFilePath

)

Definition at line 58 of file TTSF.cpp.

{
    TFile* pFile    = TFile::Create( a_szFilePath );
    auto   uiResult = Open( pFile );
    m_UNKFLAG       = TFALSE;
    return uiResult;
}

Open() [2/2]

TUINT32 TTSFI::Open

(

TFile *

a_pFile

)

Definition at line 13 of file TTSF.cpp.

{
    m_pFile         = a_pFile;
    m_FileInfoCount = 0;
    m_UNKFLAG       = TFALSE;
 
    if ( m_pFile == TNULL )
    {
        return TTRB::ERROR_NO_FILE;
    }
 
    m_UNKFLAG = TTRUE;
 
    m_pFile->Read( &m_Header, sizeof( TTSFI::Header ) );
 
    if ( m_Header.Magic == IDMAGICL )
    {
        m_Endianess = Endianess_Little;
    }
    else
    {
        if ( m_Header.Magic != IDMAGICB )
        {
            return TTRB::ERROR_NOT_TRB;
        }
 
        m_Endianess = Endianess_Big;
    }
 
    m_ReadPos += m_pFile->Read( &m_Magic, 4 );
 
    if ( m_Endianess == Endianess_Big )
    {
        m_Header.FileSize = PARSEDWORD_BIG( m_Header.FileSize );
        m_Magic           = PARSEDWORD_BIG( m_Magic );
    }
 
    m_CurrentHunk.Name = m_Header.Magic;
    m_CurrentHunk.Size = m_Header.FileSize;
    PushForm();
 
    return TTRB::ERROR_OK;
}

PopForm()

TUINT32 TTSFI::PopForm

(

)

Definition at line 84 of file TTSF.cpp.

{
    if ( m_FileInfoCount < 1 ) return TTRB::ERROR_NO_FILEINFO_ON_STACK;
 
    m_FileInfoCount--;
    auto& fileInfo = m_FileInfo[ m_FileInfoCount ];
 
    m_CurrentHunk.Size = fileInfo.FileSize;
    m_ReadPos          = m_pFile->Tell() - fileInfo.FileStartOffset;
 
    TUINT32 alignedPos = TAlignNumUp( m_CurrentHunk.Size );
    m_pFile->Seek( alignedPos - m_ReadPos, TSEEK_CUR );
    m_ReadPos = alignedPos;
 
    return TTRB::ERROR_OK;
}

PushForm()

TUINT32 TTSFI::PushForm

(

)

Definition at line 67 of file TTSF.cpp.

{
    if ( m_CurrentHunk.Name != TFourCC( "FORM" ) &&
         m_CurrentHunk.Name != TFourCC( "TSFL" ) &&
         m_CurrentHunk.Name != TFourCC( "TSFB" ) )
    {
        return TTRB::ERROR_WRONG_MAGIC;
    }
 
    m_FileInfo[ m_FileInfoCount ].FileStartOffset = m_pFile->Tell() - 4;
    m_FileInfo[ m_FileInfoCount ].FileSize        = m_CurrentHunk.Size;
    m_FileInfoCount++;
 
    return TTRB::ERROR_OK;
}

Read() [1/2]

template<class T>

void TTSFI::Read ( T * a_pDst )

inline

Definition at line 92 of file TTRB.h.

{ m_ReadPos += m_pFile->Read( a_pDst, sizeof( T ) ); }

Read() [2/2]

template<class T>

void TTSFI::Read ( T * a_pDst, TUINT a_uiCount )

inline

Definition at line 93 of file TTRB.h.

{ m_ReadPos += m_pFile->Read( a_pDst, a_uiCount * sizeof( T ) ); }

ReadAlignmentPad()

TUINT32 TTSFI::ReadAlignmentPad

(

)

Definition at line 332 of file TTSF.cpp.

{
    TASSERT( m_pFile != TNULL, "File is TNULL" );
 
    static TCHAR s_AlignBuffer[ 4 ];
    TUINT8       alignValue = 4 - ( m_pFile->Tell() & 3 );
 
    if ( alignValue != 4 )
    {
        return m_pFile->Read( s_AlignBuffer, alignValue );
    }
 
    return 0;
}

ReadCompressed()

void TTSFI::ReadCompressed	(	void *	buffer,
		TUINT32	size )

Definition at line 170 of file TTSF.cpp.

{
    TCompress::Header header;
 
    TUINT32 headerStart = m_pFile->Tell();
    int8_t  error       = TCompress::GetHeader( m_pFile, header );
 
    if ( error == TCOMPRESS_ERROR_OK )
    {
        TUINT32 headerSize = m_pFile->Tell() - headerStart;
        TCompress::Decompress( m_pFile, &header, (TBYTE*)buffer, size );
        m_ReadPos += header.CompressedSize + headerSize;
    }
}

ReadFORM()

TUINT8 TTSFI::ReadFORM

(

TFORM *

section

)

Definition at line 128 of file TTSF.cpp.

{
    if ( m_CurrentHunk.Name != TFourCC( "FORM" ) )
    {
        return TTRB::ERROR_WRONG_MAGIC;
    }
 
    m_ReadPos += m_pFile->Read( section, sizeof( TFORM ) );
 
    return TTRB::ERROR_OK;
}

ReadHunk()

TUINT8 TTSFI::ReadHunk

(

)

Definition at line 102 of file TTSF.cpp.

{
    m_pFile->Read( &m_CurrentHunk, sizeof( Hunk ) );
 
    if ( m_Endianess != Endianess_Little )
    {
        m_CurrentHunk.Name = PARSEDWORD_BIG( m_CurrentHunk.Name );
        m_CurrentHunk.Size = PARSEDWORD_BIG( m_CurrentHunk.Size );
    }
 
    m_ReadPos = 0;
 
    return TTRB::ERROR_OK;
}

ReadHunkData()

TUINT8 TTSFI::ReadHunkData

(

void *

dest

)

Definition at line 141 of file TTSF.cpp.

{
    if ( m_CurrentHunk.Name == TFourCC( "FORM" ) )
    {
        return TTRB::ERROR_FORM_MAGIC;
    }
 
    TASSERT( m_ReadPos == 0, "m_ReadPos should be zero" );
    m_ReadPos += m_pFile->Read( dst, m_CurrentHunk.Size );
    m_ReadPos += TTSFI::ReadAlignmentPad();
 
    return TTRB::ERROR_OK;
}

ReadRaw()

void TTSFI::ReadRaw	(	void *	dst,
		TUINT32	size )

Definition at line 347 of file TTSF.cpp.

{
    m_ReadPos += m_pFile->Read( dst, size );
}

SkipHunk()

TUINT8 TTSFI::SkipHunk

(

)

Definition at line 118 of file TTSF.cpp.

{
    TUINT32 alignedSize = TAlignNumUp( m_CurrentHunk.Size );
    m_pFile->Seek( alignedSize - m_ReadPos, TSEEK_CUR );
    m_ReadPos = alignedSize;
 
    return TTRB::ERROR_OK;
}

Friends And Related Symbol Documentation

TTRB

friend class TTRB

friend

Definition at line 76 of file TTRB.h.

---

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

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