TClass Class Reference

#include <TClass.h>

Public Types
using	CreateObject_t = TObject* (*)()
using	CreateObjectInPlace_t = TObject* (*)( void* a_pPtr )
using	Initialise_t = void ( * )()
using	Deinitialise_t = void ( * )()
using	RecurseTreeCheck_t = TBOOL ( * )( TClass*, void* )
using	RecurseTreeBaseBeginCb_t = void ( * )( TClass*, void* )
using	RecurseTreeBaseEndCb_t = void ( * )( TClass*, void* )

Public Member Functions
	TClass (const TCHAR *a_szName, TClass *a_pParentClass, CreateObject_t a_fnCreate, CreateObjectInPlace_t a_fnCreateInPlace, Initialise_t a_fnInitialise, Deinitialise_t a_fnUnitialise, TUINT16 a_uiVersionMajor, TUINT16 a_uiVersionMinor, TUINT32 a_uiClassSize, TUINT32 a_uiClassAlignment)
constexpr	TClass (const TCHAR *a_szName, CreateObject_t a_fnCreate, CreateObjectInPlace_t a_fnCreateInPlace, Initialise_t a_fnInitialise, Deinitialise_t a_fnUnitialise, TUINT16 a_uiVersionMajor, TUINT16 a_uiVersionMinor, TUINT32 a_uiClassSize, TUINT32 a_uiClassAlignment)
	~TClass ()
void	Initialize ()
void	RecurseTree (RecurseTreeBaseBeginCb_t fBaseBegin, RecurseTreeBaseEndCb_t fBaseEnd, RecurseTreeCheck_t fCheck, void *custom)
void	RecurseTree2 (RecurseTreeBaseBeginCb_t fBaseBegin, RecurseTreeBaseEndCb_t fBaseEnd, RecurseTreeCheck_t fCheck, void *custom)
class TObject *	CreateObject () const
TBOOL	IsA (TClass *pClass)
TBOOL	IsExactly (TClass *toCompare) const
TBOOL	IsInitialized () const
TClass *	GetParent ()
const TCHAR *	GetName () const
TUINT16	GetVersionMajor () const
TUINT16	GetVersionMinor () const
TUINT32	GetMaxSizeOfDerivedClasses ()
TUINT32	GetMaxAlignmentOfDerivedClasses ()
TBOOL	operator== (const TClass *other) const

Static Public Member Functions
static TBOOL	TryInitialize (TClass *tClass)
static TClass *	FindRecurse (const TCHAR *const &name, TClass *parent, TBOOL hasPrevious)
static TClass *	Find (const TCHAR *name, TClass *parent=TNULL)

Detailed Description

Definition at line 7 of file TClass.h.

Member Typedef Documentation

CreateObject_t

using TClass::CreateObject_t = TObject* (*)()

Definition at line 10 of file TClass.h.

CreateObjectInPlace_t

using TClass::CreateObjectInPlace_t = TObject* (*)( void* a_pPtr )

Definition at line 11 of file TClass.h.

Deinitialise_t

using TClass::Deinitialise_t = void ( * )()

Definition at line 13 of file TClass.h.

Initialise_t

using TClass::Initialise_t = void ( * )()

Definition at line 12 of file TClass.h.

RecurseTreeBaseBeginCb_t

using TClass::RecurseTreeBaseBeginCb_t = void ( * )( TClass*, void* )

Definition at line 16 of file TClass.h.

RecurseTreeBaseEndCb_t

using TClass::RecurseTreeBaseEndCb_t = void ( * )( TClass*, void* )

Definition at line 17 of file TClass.h.

RecurseTreeCheck_t

using TClass::RecurseTreeCheck_t = TBOOL ( * )( TClass*, void* )

Definition at line 15 of file TClass.h.

Constructor & Destructor Documentation

TClass() [1/2]

TClass::TClass	(	const TCHAR *	a_szName,
		TClass *	a_pParentClass,
		CreateObject_t	a_fnCreate,
		CreateObjectInPlace_t	a_fnCreateInPlace,
		Initialise_t	a_fnInitialise,
		Deinitialise_t	a_fnUnitialise,
		TUINT16	a_uiVersionMajor,
		TUINT16	a_uiVersionMinor,
		TUINT32	a_uiClassSize,
		TUINT32	a_uiClassAlignment )

Definition at line 14 of file TClass.cpp.

    : m_szName( a_szName ), m_pParent( a_pParentClass ), m_fnCreate( a_fnCreate ), m_fnCreateInPlace( a_fnCreateInPlace ), m_fnInitialise( a_fnInitialise ), m_fnDeinitialise( a_fnUnitialise ), m_uiVersionMajor( a_uiVersionMajor ), m_uiVersionMinor( a_uiVersionMinor ), m_uiClassSize( a_uiClassSize ), m_uiClassAlignment( a_uiClassAlignment ), m_bInitialised( TFALSE )
{
    if ( m_pParent )
    {
        TClass* pClass = m_pParent->m_pLastChildren;
 
        while ( pClass != TNULL )
        {
            if ( pClass == this ) return;
            pClass = pClass->m_pPrevious;
        }
 
        m_pPrevious                = m_pParent->m_pLastChildren;
        m_pParent->m_pLastChildren = this;
    }
}

TClass() [2/2]

TClass::TClass ( const TCHAR * a_szName, CreateObject_t a_fnCreate, CreateObjectInPlace_t a_fnCreateInPlace, Initialise_t a_fnInitialise, Deinitialise_t a_fnUnitialise, TUINT16 a_uiVersionMajor, TUINT16 a_uiVersionMinor, TUINT32 a_uiClassSize, TUINT32 a_uiClassAlignment )

inlineconstexpr

Definition at line 33 of file TClass.h.

        : m_szName( a_szName ), m_pParent( TNULL ), m_pPrevious( TNULL ), m_pLastChildren( TNULL ), m_fnCreate( a_fnCreate ), m_fnCreateInPlace( a_fnCreateInPlace ), m_fnInitialise( a_fnInitialise ), m_fnDeinitialise( a_fnUnitialise ), m_uiVersionMajor( a_uiVersionMajor ), m_uiVersionMinor( a_uiVersionMinor ), m_uiClassSize( a_uiClassSize ), m_uiClassAlignment( a_uiClassAlignment ), m_bInitialised( TFALSE )
    {}

~TClass()

TClass::~TClass

(

)

Definition at line 32 of file TClass.cpp.

{
    m_pLastChildren = TNULL;
    m_pPrevious     = TNULL;
    m_pParent       = TNULL;
 
    // Uninitialize static
    if ( m_bInitialised && m_fnDeinitialise )
    {
        m_bInitialised = TFALSE;
        m_fnDeinitialise();
    }
}

Member Function Documentation

CreateObject()

TObject * TClass::CreateObject

(

)

const

Definition at line 116 of file TClass.cpp.

{
    if ( m_fnCreate != TNULL )
    {
        return m_fnCreate();
    }
 
    return TNULL;
}

Find()

TClass * TClass::Find ( const TCHAR * name, TClass * parent = TNULL )

static

Definition at line 110 of file TClass.cpp.

{
    if ( parent == TNULL ) parent = &TObject::TClassObjectName;
    return FindRecurse( name, parent, TFALSE );
}

FindRecurse()

TClass * TClass::FindRecurse ( const TCHAR *const & name, TClass * parent, TBOOL hasPrevious )

static

Definition at line 82 of file TClass.cpp.

{
    while ( parent )
    {
        TClass* previous   = hasPrevious ? parent->m_pPrevious : TNULL;
        TINT    difference = Toshi::TStringManager::String8CompareNoCase( parent->m_szName, name, -1 );
 
        if ( difference == 0 )
        {
            return parent;
        }
 
        if ( parent->m_pLastChildren )
        {
            TClass* result = FindRecurse( name, parent->m_pLastChildren, TTRUE );
 
            if ( result )
            {
                return result;
            }
        }
 
        parent = previous;
    }
 
    return TNULL;
}

GetMaxAlignmentOfDerivedClasses()

TUINT32 TClass::GetMaxAlignmentOfDerivedClasses

(

)

Definition at line 170 of file TClass.cpp.

{
    auto GetMaxAlignmentOfClass = []( TClass* a_pClass, void* a_pAlignment ) -> TBOOL {
        if ( *(TUINT32*)a_pAlignment < a_pClass->m_uiClassAlignment )
        {
            *(TUINT32*)a_pAlignment = a_pClass->m_uiClassAlignment;
        }
 
        return TTRUE;
    };
 
    TUINT32 uiAlignment = 0;
    if ( GetMaxAlignmentOfClass( this, &uiAlignment ) )
    {
        RecurseTree2( TNULL, TNULL, GetMaxAlignmentOfClass, &uiAlignment );
    }
 
    return uiAlignment;
}

GetMaxSizeOfDerivedClasses()

TUINT32 TClass::GetMaxSizeOfDerivedClasses

(

)

Definition at line 150 of file TClass.cpp.

{
    auto GetMaxSizeOfClass = []( TClass* a_pClass, void* a_pSize ) -> TBOOL {
        if ( *(TUINT32*)a_pSize < a_pClass->m_uiClassSize )
        {
            *(TUINT32*)a_pSize = a_pClass->m_uiClassSize;
        }
 
        return TTRUE;
    };
 
    TUINT32 uiClassSize = 0;
    if ( GetMaxSizeOfClass( this, &uiClassSize ) )
    {
        RecurseTree2( TNULL, TNULL, GetMaxSizeOfClass, &uiClassSize );
    }
 
    return uiClassSize;
}

GetName()

const TCHAR * TClass::GetName ( ) const

inline

Definition at line 58 of file TClass.h.

{ return m_szName; }

GetParent()

TClass * TClass::GetParent ( )

inline

Definition at line 57 of file TClass.h.

{ return static_cast<TClass*>( m_pParent ); }

GetVersionMajor()

TUINT16 TClass::GetVersionMajor ( ) const

inline

Definition at line 59 of file TClass.h.

{ return m_uiVersionMajor; }

GetVersionMinor()

TUINT16 TClass::GetVersionMinor ( ) const

inline

Definition at line 60 of file TClass.h.

{ return m_uiVersionMinor; }

Initialize()

void TClass::Initialize

(

)

Definition at line 46 of file TClass.cpp.

{
    if ( m_fnInitialise )
    {
        m_fnInitialise();
        m_bInitialised = TTRUE;
    }
}

IsA()

TBOOL TClass::IsA

(

TClass *

pClass

)

Definition at line 126 of file TClass.cpp.

{
    if ( cmpClass->m_pLastChildren == TNULL )
    {
        return ( this == cmpClass );
    }
    else
    {
        TClass* pClass = this;
 
        while ( pClass != TNULL )
        {
            if ( pClass == cmpClass )
            {
                return TTRUE;
            }
 
            pClass = pClass->m_pParent;
        }
    }
 
    return TFALSE;
}

IsExactly()

TBOOL TClass::IsExactly ( TClass * toCompare ) const

inline

Definition at line 55 of file TClass.h.

{ return this == toCompare; }

IsInitialized()

TBOOL TClass::IsInitialized ( ) const

inline

Definition at line 56 of file TClass.h.

{ return m_bInitialised; }

operator==()

TBOOL TClass::operator== ( const TClass * other ) const

inline

Definition at line 72 of file TClass.h.

{ return this == other; }

RecurseTree()

void TClass::RecurseTree	(	RecurseTreeBaseBeginCb_t	fBaseBegin,
		RecurseTreeBaseEndCb_t	fBaseEnd,
		RecurseTreeCheck_t	fCheck,
		void *	custom )

Definition at line 55 of file TClass.cpp.

{
    TBOOL valid = fCheck( this, custom );
 
    if ( valid )
    {
        if ( fBaseBegin ) fBaseBegin( this, custom );
        RecurseTree2( fBaseBegin, fBaseEnd, fCheck, custom );
        if ( fBaseEnd ) fBaseEnd( this, custom );
    }
}

RecurseTree2()

void TClass::RecurseTree2	(	RecurseTreeBaseBeginCb_t	fBaseBegin,
		RecurseTreeBaseEndCb_t	fBaseEnd,
		RecurseTreeCheck_t	fCheck,
		void *	custom )

Definition at line 67 of file TClass.cpp.

{
    for ( TClass* pClass = m_pLastChildren; pClass != TNULL; pClass = pClass->m_pPrevious )
    {
        if ( fCheck ) fCheck( pClass, custom );
 
        if ( pClass->m_pLastChildren )
        {
            if ( fBaseBegin ) fBaseBegin( pClass, custom );
            pClass->RecurseTree2( fBaseBegin, fBaseEnd, fCheck, custom );
            if ( fBaseEnd ) fBaseEnd( pClass, custom );
        }
    }
}

TryInitialize()

TBOOL TClass::TryInitialize ( TClass * tClass )

static

Definition at line 190 of file TClass.cpp.

{
    if ( !tClass->IsInitialized() )
    {
        tClass->Initialize();
    }
 
    return TTRUE;
}

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TClass.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TClass.cpp