TTSFO Class Reference

#include <TTRB.h>

Inheritance diagram for TTSFO:

Classes
struct	HunkMark

Public Types
enum	ERROR_ : ERROR { ERROR_OK , ERROR_UNKNOWN , ERROR_FILE }
typedef TUINT8	ERROR

Public Member Functions
	TTSFO ()
	~TTSFO ()
TUINT32	WriteAlignmentPad ()
	Aligns current position to 4.
TTSFO::ERROR	Create (const TCHAR *filepath, const TCHAR *magic="TRBF", Endianess endianess=Endianess_Little)
	Creates file for writing.
void	Close ()
	Closes the file.
TSIZE	BeginForm (const TCHAR *name)
	Begin a new form and saves it's info.
TSIZE	EndForm ()
	Ends the current form if it exists.
TBOOL	OpenHunk (HunkMark *hunkMark, const TCHAR *hunkName)
	Opens new hunk.
TBOOL	CloseHunk (HunkMark *hunkMark)
	Closes the hunk.
TUINT32	WriteHunk (TUINT32 hunkName, void *buffer=nullptr, TSIZE bufferSize=0)
	Writes a hunk of data.
template<class T>
TUINT32	Write (const T &value)
TUINT32	WriteRaw (const void *buffer, TSIZE size)
TUINT32	WriteCompressed (const void *buffer, TSIZE size)
void	WriteBool (TBOOL value)
void	WriteInt8 (int8_t value)
void	WriteUInt8 (TUINT8 value)
void	WriteUInt16 (TUINT16 value)
void	WriteInt32 (TINT32 value)
void	WriteUInt32 (TUINT32 value)
void	WriteFloat (float value)
void	WriteVector3 (TVector3 &value)
void	WriteVector4 (TVector4 &value)
void	WriteQuaternion (TQuaternion &value)
Public Member Functions inherited from TTSF
	TTSF ()
	~TTSF ()=default
Endianess	GetEndianess () const

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 117 of file TTRB.h.

Member Typedef Documentation

ERROR

typedef TUINT8 TTSFO::ERROR

Definition at line 120 of file TTRB.h.

Member Enumeration Documentation

ERROR_

enum TTSFO::ERROR_ : ERROR

Enumerator
ERROR_OK
ERROR_UNKNOWN
ERROR_FILE

Definition at line 121 of file TTRB.h.

    {
        ERROR_OK,
        ERROR_UNKNOWN,
        ERROR_FILE
    };

Constructor & Destructor Documentation

TTSFO()

TTSFO::TTSFO ( )

inline

Definition at line 135 of file TTRB.h.

        : m_PositionCount( 0 ), m_Positions() {}

~TTSFO()

TTSFO::~TTSFO ( )

inline

Definition at line 137 of file TTRB.h.

{ Close(); }

Member Function Documentation

BeginForm()

TSIZE TTSFO::BeginForm

(

const TCHAR *

name

)

Begin a new form and saves it's info.

Parameters

name	- 4 bytes long value which will be written after the hunk

Returns

number of written bytes

Definition at line 238 of file TTSF.cpp.

{
    TASSERT( m_pFile != TNULL, "TTSFO is not created" );
 
    TTSF::Hunk hunk{ TFourCC( "FORM" ), 0 };
    auto       nameValue = TFourCC( name );
 
    if ( m_Endianess == Endianess_Big )
    {
        hunk.Name = PARSEDWORD_BIG( hunk.Name );
        nameValue = PARSEDWORD_BIG( nameValue );
    }
 
    m_Positions[ m_PositionCount++ ] = m_pFile->Tell();
 
    auto written1 = Write( hunk );
    auto written2 = Write( nameValue );
 
    return written1 + written2;
}

Close()

void TTSFO::Close

(

)

Closes the file.

Definition at line 228 of file TTSF.cpp.

{
    if ( m_pFile != TNULL )
    {
        EndForm();
        m_pFile->Destroy();
        m_pFile = TNULL;
    }
}

CloseHunk()

TBOOL TTSFO::CloseHunk

(

HunkMark *

hunkMark

)

Closes the hunk.

Parameters

hunkMark

- pointer to TTSFO::HunkMark which has to be closed

Returns

always TTRUE

Definition at line 295 of file TTSF.cpp.

{
    TASSERT( hunkMark != TNULL, "HunkMark is TNULL" );
    auto oldPos = m_pFile->Tell();
 
    m_pFile->Seek( hunkMark->Pos, TSEEK_SET );
    WriteHunk( hunkMark->Name, TNULL, ( oldPos - hunkMark->Pos ) - sizeof( TTSF::Hunk ) );
    m_pFile->Seek( oldPos, TSEEK_SET );
    TTSFO::WriteAlignmentPad();
 
    return TTRUE;
}

Create()

TTSFO::ERROR TTSFO::Create	(	const TCHAR *	filepath,
		const TCHAR *	magic = "TRBF",
		Endianess	endianess = Endianess_Little )

Creates file for writing.

Parameters

filepath	- path to the file
magic	- magic value which is placed after the first hunk

Returns

TTRB::ERROR_OK if successful

Definition at line 198 of file TTSF.cpp.

{
    m_pFile = TFile::Create( filepath, TFILEMODE_CREATENEW | TFILEMODE_WRITE );
 
    if ( m_pFile != TNULL )
    {
        TTSF::Hunk hunk{ TFourCCLE( "TSFL" ), 0 };
        TUINT32    magicValue = TFourCC( magic );
 
        if ( endianess == Endianess_Big )
        {
            hunk.Name = TFourCCLE( "TSFB" );
            hunk.Size = PARSEDWORD_BIG( hunk.Size );
        }
 
        Write( hunk );
        Write( magicValue );
 
        m_Endianess                    = endianess;
        m_Positions[ m_PositionCount ] = 0;
        m_PositionCount += 1;
 
        return TTRB::ERROR_OK;
    }
    else
    {
        return TTSFO::ERROR_FILE;
    }
}

EndForm()

TSIZE TTSFO::EndForm

(

)

Ends the current form if it exists.

Returns

size of the form

Definition at line 259 of file TTSF.cpp.

{
    TASSERT( m_pFile != TNULL, "TTSFO is not created" );
 
    if ( m_PositionCount > 0 )
    {
        auto formPosition = m_Positions[ --m_PositionCount ];
 
        auto oldPos   = m_pFile->Tell();
        auto formSize = ( oldPos - formPosition ) - 8;
 
        if ( m_Endianess == Endianess_Big )
        {
            formSize = PARSEDWORD_BIG( formSize );
        }
 
        m_pFile->Seek( formPosition + 4, TSEEK_SET );
        Write( formSize );
        m_pFile->Seek( oldPos, TSEEK_SET );
 
        return formSize;
    }
 
    return 0;
}

OpenHunk()

TBOOL TTSFO::OpenHunk	(	HunkMark *	hunkMark,
		const TCHAR *	hunkName )

Opens new hunk.

Parameters

hunkMark	- pointer to TTSFO::HunkMark which has to be opened
hunkName	- 4 bytes long name of the hunk

Returns

always TTRUE

Definition at line 285 of file TTSF.cpp.

{
    TASSERT( hunkMark != TNULL, "HunkMark is TNULL" );
    hunkMark->Name = TFourCC( hunkName );
    hunkMark->Pos  = m_pFile->Tell();
 
    WriteHunk( hunkMark->Name, TNULL, 0 );
    return TTRUE;
}

Write()

template<class T>

TUINT32 TTSFO::Write ( const T & value )

inline

Definition at line 216 of file TTRB.h.

    {
        TASSERT( m_pFile != TNULL, "TTSFO is not created" );
        return m_pFile->Write( &value, sizeof( T ) );
    }

WriteAlignmentPad()

TUINT32 TTSFO::WriteAlignmentPad ( )

inline

Aligns current position to 4.

Returns

number of written bytes

Definition at line 144 of file TTRB.h.

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

WriteBool()

void TTSFO::WriteBool ( TBOOL value )

inline

Definition at line 236 of file TTRB.h.

{ Write( value ); }

WriteCompressed()

TUINT32 TTSFO::WriteCompressed ( const void * buffer, TSIZE size )

inline

Definition at line 228 of file TTRB.h.

    {
        TASSERT( m_pFile != TNULL, "TTSFO is not created" );
        TUINT32 writtenSize = TCompress::Compress( m_pFile, (TBYTE*)buffer, size, 0, m_Endianess == Endianess_Big );
        WriteAlignmentPad();
        return writtenSize;
    }

WriteFloat()

void TTSFO::WriteFloat ( float value )

inline

Definition at line 242 of file TTRB.h.

{ Write( value ); }

WriteHunk()

TUINT32 TTSFO::WriteHunk	(	TUINT32	hunkName,
		void *	buffer = nullptr,
		TSIZE	bufferSize = 0 )

Writes a hunk of data.

Parameters

hunkName	- magic value that is used to identificate hunk (use TMAKEFOUR to get it)
buffer	- pointer to the buffer of data (can be TNULL)
bufferSize	- size of the buffer (can be 0)

Returns

number of written bytes

Definition at line 308 of file TTSF.cpp.

{
    TTSF::Hunk hunk{ hunkName, bufferSize };
 
    // Convert endianess
    if ( m_Endianess == Endianess_Big )
    {
        hunk.Name = PARSEDWORD_BIG( hunk.Name );
        hunk.Size = PARSEDWORD_BIG( hunk.Size );
    }
 
    // Write hunk
    TSIZE writtenSize = Write( hunk );
 
    // Write buffer
    if ( buffer != TNULL && bufferSize > 0 )
    {
        writtenSize += m_pFile->Write( buffer, bufferSize );
    }
 
    // Return num of written bytes
    return writtenSize + TTSFO::WriteAlignmentPad();
}

WriteInt32()

void TTSFO::WriteInt32 ( TINT32 value )

inline

Definition at line 240 of file TTRB.h.

{ Write( value ); }

WriteInt8()

void TTSFO::WriteInt8 ( int8_t value )

inline

Definition at line 237 of file TTRB.h.

{ Write( value ); }

WriteQuaternion()

void TTSFO::WriteQuaternion ( TQuaternion & value )

inline

Definition at line 245 of file TTRB.h.

{ Write( value ); }

WriteRaw()

TUINT32 TTSFO::WriteRaw ( const void * buffer, TSIZE size )

inline

Definition at line 222 of file TTRB.h.

    {
        TASSERT( m_pFile != TNULL, "TTSFO is not created" );
        return m_pFile->Write( buffer, size );
    }

WriteUInt16()

void TTSFO::WriteUInt16 ( TUINT16 value )

inline

Definition at line 239 of file TTRB.h.

{ Write( value ); }

WriteUInt32()

void TTSFO::WriteUInt32 ( TUINT32 value )

inline

Definition at line 241 of file TTRB.h.

{ Write( value ); }

WriteUInt8()

void TTSFO::WriteUInt8 ( TUINT8 value )

inline

Definition at line 238 of file TTRB.h.

{ Write( value ); }

WriteVector3()

void TTSFO::WriteVector3 ( TVector3 & value )

inline

Definition at line 243 of file TTRB.h.

{ Write( value ); }

WriteVector4()

void TTSFO::WriteVector4 ( TVector4 & value )

inline

Definition at line 244 of file TTRB.h.

{ Write( value ); }

---

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