TTRB Class Reference

#include <TTRB.h>

Classes
struct	Header
struct	RELCEntry
struct	SecInfo
struct	SYMB
struct	TTRBSymbol

Public Types
enum	ERROR_ : ERROR {   ERROR_OK = 0 , ERROR_NO_HEADER = 1 , ERROR_NOT_TRBF = 2 , ERROR_PARSE_ERROR = 3 ,   ERROR_WRONG_MAGIC = 4 , ERROR_FORM_MAGIC = 5 , ERROR_NO_FILE = 6 , ERROR_NOT_TRB = 7 ,   ERROR_NO_FILEINFO_ON_STACK = 8 }
enum	AllocType_ : AllocType { AllocType_Unk0 = 0 , AllocType_Unk1 = 1 , AllocType_Unk2 = 2 }
typedef TUINT8	ERROR
typedef TUINT8	AllocType
using	t_MemoryFuncAlloc = void* (*)( AllocType alloctype, TUINT32 size, TINT16 unk1, TUINT32 unk2, void* userData )
using	t_MemoryFuncDealloc = void ( * )( AllocType alloctype, void* ptr, TINT16 unk1, TUINT32 unk2, void* userData )

Public Member Functions
	TTRB ()
	~TTRB ()
ERROR	Load (const TCHAR *a_szFilePath, TUINT32 a_uiUnknown=0)
TINT	GetSymbolIndex (const TCHAR *symbName)
void *	GetSymbolAddress (const TCHAR *symbName)
void *	GetSymbolAddress (TTRBSymbol &symb)
void	Close ()
template<typename T>
T *	CastSymbol (const TCHAR *symbName)
SecInfo *	GetSectionInfoList () const
SecInfo *	GetSectionInfo (TINT index) const
TTRBSymbol *	GetSymbol (TINT index) const
TTRBSymbol *	GetSymbol (const TCHAR *a_symbolName)
const TCHAR *	GetSymbolName (TINT index) const
const TCHAR *	GetSymbolName (TTRBSymbol *symbol) const
TINT32	GetNumSymbols () const
SYMB *	GetSymbolTable () const
void	DeleteSymbolTable ()
void	SetMemoryFunctions (t_MemoryFuncAlloc allocator, t_MemoryFuncDealloc deallocator, void *userdata)

Static Public Member Functions
static TUINT32	GetHeaderSize (TUINT32 count)
static TUINT32	GetSymbolTableSize (TUINT32 count)
static TINT16	HashString (const TCHAR *str)

Detailed Description

Definition at line 252 of file TTRB.h.

Member Typedef Documentation

AllocType

typedef TUINT8 TTRB::AllocType

Definition at line 269 of file TTRB.h.

ERROR

typedef TUINT8 TTRB::ERROR

Definition at line 255 of file TTRB.h.

t_MemoryFuncAlloc

using TTRB::t_MemoryFuncAlloc = void* (*)( AllocType alloctype, TUINT32 size, TINT16 unk1, TUINT32 unk2, void* userData )

Definition at line 277 of file TTRB.h.

t_MemoryFuncDealloc

using TTRB::t_MemoryFuncDealloc = void ( * )( AllocType alloctype, void* ptr, TINT16 unk1, TUINT32 unk2, void* userData )

Definition at line 278 of file TTRB.h.

Member Enumeration Documentation

AllocType_

enum TTRB::AllocType_ : AllocType

Enumerator
AllocType_Unk0
AllocType_Unk1
AllocType_Unk2

Definition at line 270 of file TTRB.h.

    {
        AllocType_Unk0 = 0,
        AllocType_Unk1 = 1,
        AllocType_Unk2 = 2,
    };

ERROR_

enum TTRB::ERROR_ : ERROR

Enumerator
ERROR_OK
ERROR_NO_HEADER
ERROR_NOT_TRBF
ERROR_PARSE_ERROR
ERROR_WRONG_MAGIC
ERROR_FORM_MAGIC
ERROR_NO_FILE
ERROR_NOT_TRB
ERROR_NO_FILEINFO_ON_STACK

Definition at line 256 of file TTRB.h.

    {
        ERROR_OK                   = 0,
        ERROR_NO_HEADER            = 1,
        ERROR_NOT_TRBF             = 2,
        ERROR_PARSE_ERROR          = 3,
        ERROR_WRONG_MAGIC          = 4,
        ERROR_FORM_MAGIC           = 5,
        ERROR_NO_FILE              = 6,
        ERROR_NOT_TRB              = 7,
        ERROR_NO_FILEINFO_ON_STACK = 8,
    };

Constructor & Destructor Documentation

TTRB()

TTRB::TTRB

(

)

Definition at line 24 of file TTRB.cpp.

{
    m_pHeader = TNULL;
    m_SYMB    = TNULL;
    SetMemoryFunctions( s_cbDefAllocator, s_cbDefDeallocator, s_pDefAllocatorUserData );
}

~TTRB()

TTRB::~TTRB

(

)

Definition at line 32 of file TTRB.cpp.

{
    Close();
}

Member Function Documentation

CastSymbol()

template<typename T>

T * TTRB::CastSymbol ( const TCHAR * symbName )

inline

Definition at line 334 of file TTRB.h.

{ return TSTATICCAST( T, GetSymbolAddress( symbName ) ); }

Close()

void TTRB::Close

(

)

Definition at line 289 of file TTRB.cpp.

{
    if ( m_pHeader != TNULL )
    {
        for ( TINT i = 0; i < m_pHeader->m_i32SectionCount; i++ )
        {
            auto sec = GetSectionInfo( i );
 
            if ( sec->m_Data != TNULL )
            {
                m_MemDeallocator( AllocType_Unk1, sec->m_Data, sec->m_Unk1, sec->m_Unk2, m_MemUserData );
            }
        }
 
        m_MemDeallocator( AllocType_Unk0, m_pHeader, 0, 0, m_MemUserData );
        m_pHeader = TNULL;
    }
 
    DeleteSymbolTable();
}

DeleteSymbolTable()

void TTRB::DeleteSymbolTable

(

)

Definition at line 319 of file TTRB.cpp.

{
    if ( m_SYMB != TNULL )
    {
        m_MemDeallocator( AllocType_Unk2, m_SYMB, 0, 0, m_MemUserData );
        m_SYMB = TNULL;
    }
}

GetHeaderSize()

static TUINT32 TTRB::GetHeaderSize ( TUINT32 count )

inlinestatic

Definition at line 352 of file TTRB.h.

{ return sizeof( SecInfo ) * count + sizeof( Header ); }

GetNumSymbols()

TINT32 TTRB::GetNumSymbols ( ) const

inline

Definition at line 343 of file TTRB.h.

{ return m_SYMB->m_i32SymbCount; }

GetSectionInfo()

SecInfo * TTRB::GetSectionInfo ( TINT index ) const

inline

Definition at line 337 of file TTRB.h.

{ return GetSectionInfoList() + index; }

GetSectionInfoList()

SecInfo * TTRB::GetSectionInfoList ( ) const

inline

Definition at line 336 of file TTRB.h.

{ return reinterpret_cast<SecInfo*>( m_pHeader + 1 ); }

GetSymbol() [1/2]

TTRB::TTRBSymbol * TTRB::GetSymbol

(

const TCHAR *

a_symbolName

)

Definition at line 383 of file TTRB.cpp.

{
    TINT index = GetSymbolIndex( a_symbolName );
    if ( index == -1 )
    {
        return TNULL;
    }
 
    return GetSymbol( index );
}

GetSymbol() [2/2]

TTRB::TTRBSymbol * TTRB::GetSymbol

(

TINT

index

)

const

Definition at line 368 of file TTRB.cpp.

{
    if ( m_SYMB == TNULL )
    {
        return TNULL;
    }
    else if ( index < m_SYMB->m_i32SymbCount )
    {
        return reinterpret_cast<TTRBSymbol*>( m_SYMB + 1 ) + index;
    }
 
    return TNULL;
}

GetSymbolAddress() [1/2]

void * TTRB::GetSymbolAddress

(

const TCHAR *

symbName

)

Definition at line 251 of file TTRB.cpp.

{
    auto index = GetSymbolIndex( symbName );
 
    if ( m_SYMB != TNULL && index != -1 && index < m_SYMB->m_i32SymbCount )
    {
        auto entry = GetSymbol( index );
        return static_cast<TCHAR*>( GetSection( entry->HDRX ) ) + entry->DataOffset;
    }
 
    return TNULL;
}

GetSymbolAddress() [2/2]

void * TTRB::GetSymbolAddress ( TTRBSymbol & symb )

inline

Definition at line 328 of file TTRB.h.

{ return static_cast<TCHAR*>( GetSection( symb.HDRX ) ) + symb.DataOffset; }

GetSymbolIndex()

TINT TTRB::GetSymbolIndex

(

const TCHAR *

symbName

)

Definition at line 265 of file TTRB.cpp.

{
    if ( m_SYMB != TNULL )
    {
        short hash = HashString( symbName );
 
        for ( TINT i = 0; i < m_SYMB->m_i32SymbCount; i++ )
        {
            auto symbol = GetSymbol( i );
 
            if ( symbol->NameHash == hash )
            {
                if ( Toshi::TStringManager::String8Compare( symbName, GetSymbolName( symbol ), -1 ) == 0 )
                {
                    return i;
                }
            }
        }
    }
 
    return -1;
}

GetSymbolName() [1/2]

const TCHAR * TTRB::GetSymbolName

(

TINT

index

)

const

Definition at line 357 of file TTRB.cpp.

{
    if ( m_SYMB == TNULL )
    {
        return TNULL;
    }
 
    return GetSymbolName( reinterpret_cast<TTRBSymbol*>( m_SYMB + 1 ) + index );
}

GetSymbolName() [2/2]

const TCHAR * TTRB::GetSymbolName

(

TTRBSymbol *

symbol

)

const

Definition at line 343 of file TTRB.cpp.

{
    if ( m_SYMB == TNULL )
    {
        return TNULL;
    }
 
    return reinterpret_cast<const TCHAR*>(
        reinterpret_cast<uintptr_t>( m_SYMB ) +
        GetSymbolTableSize( m_SYMB->m_i32SymbCount ) +
        symbol->NameOffset
    );
}

GetSymbolTable()

SYMB * TTRB::GetSymbolTable ( ) const

inline

Definition at line 345 of file TTRB.h.

{ return m_SYMB; }

GetSymbolTableSize()

static TUINT32 TTRB::GetSymbolTableSize ( TUINT32 count )

inlinestatic

Definition at line 354 of file TTRB.h.

{ return sizeof( TTRBSymbol ) * count + sizeof( SYMB ); }

HashString()

TINT16 TTRB::HashString ( const TCHAR * str )

static

Definition at line 328 of file TTRB.cpp.

{
    TINT16 hash = 0;
    TCHAR  character;
 
    while ( *str != '\0' )
    {
        character = *( str++ );
        hash      = (TINT16)character + hash * 0x1f;
    }
 
    return hash;
}

Load()

TTRB::ERROR TTRB::Load	(	const TCHAR *	a_szFilePath,
		TUINT32	a_uiUnknown = 0 )

Definition at line 38 of file TTRB.cpp.

{
    TPROFILER_SCOPE();
    ERROR error = m_TTSFI.Open( a_szFilePath );
 
    if ( error == ERROR_OK )
    {
        if ( m_TTSFI.m_Magic == TFourCC( "TRBF" ) )
        {
            m_UNK = a_uiUnknown;
 
            if ( ProcessForm( m_TTSFI ) )
            {
                error = ERROR_OK;
            }
            else
            {
                error = ERROR_PARSE_ERROR;
            }
        }
        else
        {
            error = ERROR_NOT_TRBF;
        }
    }
    else
    {
        error = ERROR_NO_HEADER;
    }
 
    m_TTSFI.Close();
    return error;
}

SetMemoryFunctions()

void TTRB::SetMemoryFunctions	(	t_MemoryFuncAlloc	allocator,
		t_MemoryFuncDealloc	deallocator,
		void *	userdata )

Definition at line 311 of file TTRB.cpp.

{
    m_MemAllocator   = allocator;
    m_MemDeallocator = deallocator;
    m_MemUserData    = userdata;
}

---

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/TTRB.cpp