TUtil Class Reference

#include <TUtil.h>

Inheritance diagram for TUtil:

Classes
struct	LogEvent
struct	TOSHIParams

Public Types
enum	LogType {   LogType_Info , LogType_Warning , LogType_Error , LogType_Critical ,   LogType_NUMOF }

Public Member Functions
	TUtil ()
	~TUtil ()=default
Public Member Functions inherited from TSingleton< TUtil >
	TSingleton (const TSingleton &)=delete
	TSingleton (const TSingleton &&)=delete
TSingleton &	operator= (const TSingleton &)=delete
TSingleton &	operator= (const TSingleton &&)=delete

Static Public Member Functions
static constexpr const TCHAR *	LogTypeToString (LogType a_eType)
static TBOOL	ToshiCreate (const TOSHIParams &a_rToshiParams)
static void	ToshiDestroy ()
static const TCHAR *	GetTime ()
static void	MemSet (void *ptr, TINT value, TSIZE size)
static void *	MemCopy (void *dst, const void *src, TSIZE size)
static void	MemClear (void *ptr, TSIZE size)
static TINT	MemCompare (const void *ptr1, const void *ptr2, TSIZE size)
static void *	MemMove (void *dst, const void *src, TSIZE size)
template<class T>
static void	Fill (T *a_pStart, T *a_pEnd, const T &a_rcValue=T())
static void	Log (const TCHAR *a_szFormat,...)
static void	Log (LogType a_eLogType, const TCHAR *a_szFormat,...)
static void	TrimLog (const TCHAR *fileExtension, TSIZE trimTo)
static void	LogDown ()
static void	LogUp ()
static void	LogConsole (const TCHAR *a_szFormat,...)
static void	LogSet (TLogFile *a_logFile)
static TLogFile *	GetCurrentLogFile ()
static TEmitter< TUtil, TUtil::LogEvent > &	GetLogEmitter ()
static TMutex &	GetGlobalMutex ()
static TPString8Pool *	SetTPStringPool (TPString8Pool *a_pStringPool)
static TPString8Pool *	GetTPStringPool ()
static const TOSHIParams &	GetToshiParameters ()
static void	CRCInitialise ()
static TUINT32	CRC32 (void *buffer, TUINT32 len)
Static Public Member Functions inherited from TSingleton< TUtil >
static TFORCEINLINE TUtil *	CreateSingleton (Args &&... args)
static TFORCEINLINE D *	CreateSingleton (Args &&... args)
static TFORCEINLINE void	DestroySingleton ()
static TFORCEINLINE TUtil *	GetSingletonSafe ()
static TFORCEINLINE TBOOL	IsSingletonCreated ()
static TFORCEINLINE TUtil *	GetSingleton ()

Static Public Attributes
static constexpr const TCHAR *	kTypeStrings []
static TUINT32	s_aiCRC32LUT [(256)] = {}

Additional Inherited Members
Protected Member Functions inherited from TSingleton< TUtil >
TFORCEINLINE	TSingleton ()
TFORCEINLINE	~TSingleton ()
Static Protected Attributes inherited from TSingleton< TUtil >
static TUtil *	ms_pSingleton

Detailed Description

Definition at line 13 of file TUtil.h.

Member Enumeration Documentation

LogType

enum TUtil::LogType

Enumerator
LogType_Info
LogType_Warning
LogType_Error
LogType_Critical
LogType_NUMOF

Definition at line 20 of file TUtil.h.

    {
        LogType_Info,
        LogType_Warning,
        LogType_Error,
        LogType_Critical,
        LogType_NUMOF
    };

Constructor & Destructor Documentation

TUtil()

TUtil::TUtil

(

)

Definition at line 142 of file TUtil.cpp.

    : m_LogEmitter( this )
{
    m_pDefaultLogFile = TNULL;
    m_pCurrentLogFile = TNULL;
}

~TUtil()

TUtil::~TUtil ( )

default

Member Function Documentation

CRC32()

TUINT32 TUtil::CRC32 ( void * buffer, TUINT32 len )

static

Definition at line 201 of file TUtil.cpp.

{
    TBYTE*  bytes = (TBYTE*)buffer;
    TUINT32 crc   = 0;
 
    while ( len-- )
        crc = crc32upd( s_aiCRC32LUT, crc, *bytes++ );
 
    return CRC32POST( crc );
}

CRCInitialise()

void TUtil::CRCInitialise ( )

static

Definition at line 182 of file TUtil.cpp.

{
    TUINT32 crc;
 
    for ( TINT i = 0; i < CRC_TABSIZE; i++ )
    {
        crc = i;
        for ( TINT j = 8; j > 0; j-- )
        {
            if ( crc & 1 )
                crc = ( crc >> 1 ) ^ CRC32POLY;
            else
                crc >>= 1;
        }
        s_aiCRC32LUT[ i ] = crc;
    }
}

Fill()

template<class T>

static void TUtil::Fill ( T * a_pStart, T * a_pEnd, const T & a_rcValue = T() )

inlinestatic

Definition at line 96 of file TUtil.h.

    {
        for ( ; a_pStart != a_pEnd; a_pStart++ )
            *a_pStart = a_rcValue;
    }

GetCurrentLogFile()

static TLogFile * TUtil::GetCurrentLogFile ( )

inlinestatic

Definition at line 116 of file TUtil.h.

{ return ms_pSingleton->m_pCurrentLogFile; }

GetGlobalMutex()

static TMutex & TUtil::GetGlobalMutex ( )

inlinestatic

Definition at line 119 of file TUtil.h.

{ return ms_oGlobalMutex; }

GetLogEmitter()

static TEmitter< TUtil, TUtil::LogEvent > & TUtil::GetLogEmitter ( )

inlinestatic

Definition at line 117 of file TUtil.h.

{ return ms_pSingleton->m_LogEmitter; }

GetTime()

const TCHAR * TUtil::GetTime ( )

static

Definition at line 54 of file TUtil_Win.cpp.

{
    time_t t   = time( NULL );
    TCHAR* str = ctime( &t );
    return strtok( str, "\n" );
}

GetToshiParameters()

static const TOSHIParams & TUtil::GetToshiParameters ( )

inlinestatic

Definition at line 129 of file TUtil.h.

    {
        return ms_oToshiParams;
    }

GetTPStringPool()

static TPString8Pool * TUtil::GetTPStringPool ( )

inlinestatic

Definition at line 123 of file TUtil.h.

    {
        TASSERT( ms_poStringPool != TNULL );
        return *ms_poStringPool;
    }

Log() [1/2]

void TUtil::Log ( const TCHAR * a_szFormat, ... )

static

Definition at line 65 of file TUtil.cpp.

{
    if ( IsSingletonCreated() && GetCurrentLogFile() )
    {
        auto pLogFile = GetCurrentLogFile();
 
        T2FormatString2048 formatString;
 
        va_list args;
        va_start( args, a_szFormat );
        formatString.FormatV( a_szFormat, args );
        va_end( args );
 
        pLogFile->Log( LogType_Info, ms_oToshiParams.szLogAppName, ms_oToshiParams.szLogAppDirName, formatString.Get() );
        GetLogEmitter().Throw( LogEvent( pLogFile, LogType_Info, formatString.Get() ) );
    }
}

Log() [2/2]

void TUtil::Log ( LogType a_eLogType, const TCHAR * a_szFormat, ... )

static

Definition at line 83 of file TUtil.cpp.

{
    auto pLogFile = GetCurrentLogFile();
 
    if ( pLogFile )
    {
        T2FormatString2048 formatString;
 
        va_list args;
        va_start( args, a_szFormat );
        formatString.FormatV( a_szFormat, args );
        va_end( args );
 
        pLogFile->Log( a_eLogType, ms_oToshiParams.szLogAppName, ms_oToshiParams.szLogAppDirName, formatString.Get() );
        GetLogEmitter().Throw( LogEvent( pLogFile, a_eLogType, formatString.Get() ) );
    }
}

LogConsole()

void TUtil::LogConsole ( const TCHAR * a_szFormat, ... )

static

Definition at line 111 of file TUtil.cpp.

{
    auto pLogFile = GetCurrentLogFile();
 
    if ( pLogFile )
    {
        T2FormatString2048 formatString;
 
        va_list args;
        va_start( args, a_szFormat );
        formatString.FormatV( a_szFormat, args );
        va_end( args );
 
        OutputDebugStringA( formatString.Get() );
        printf( formatString.Get() );
    }
}

LogDown()

void TUtil::LogDown ( )

static

Definition at line 101 of file TUtil.cpp.

{
    TUtil::GetSingletonSafe()->m_pCurrentLogFile->Down();
}

LogSet()

void TUtil::LogSet ( TLogFile * a_logFile )

static

Definition at line 129 of file TUtil.cpp.

{
    Log( "Changing log file." );
    TUtil* pUtil = TUtil::GetSingleton();
 
    if ( pUtil->m_pCurrentLogFile )
    {
        pUtil->m_pCurrentLogFile->Close();
    }
 
    pUtil->m_pCurrentLogFile = ( !a_pLogFile ) ? pUtil->m_pDefaultLogFile : a_pLogFile;
}

LogTypeToString()

static constexpr const TCHAR * TUtil::LogTypeToString ( LogType a_eType )

inlinestaticconstexpr

Definition at line 36 of file TUtil.h.

    {
        TSTATICASSERT( Toshi::TUtil::LogType_NUMOF == TARRAYSIZE( kTypeStrings ) );
 
        return a_eType >= LogType_Info && a_eType < LogType_NUMOF ?
            kTypeStrings[ a_eType ] :
            "UNKNOWN";
    }

LogUp()

void TUtil::LogUp ( )

static

Definition at line 106 of file TUtil.cpp.

{
    TUtil::GetSingletonSafe()->m_pCurrentLogFile->Up();
}

MemClear()

static void TUtil::MemClear ( void * ptr, TSIZE size )

inlinestatic

Definition at line 91 of file TUtil.h.

{ std::memset( ptr, 0, size ); }

MemCompare()

static TINT TUtil::MemCompare ( const void * ptr1, const void * ptr2, TSIZE size )

inlinestatic

Definition at line 92 of file TUtil.h.

{ return std::memcmp( ptr1, ptr2, size ); }

MemCopy()

static void * TUtil::MemCopy ( void * dst, const void * src, TSIZE size )

inlinestatic

Definition at line 90 of file TUtil.h.

{ return std::memcpy( dst, src, size ); }

MemMove()

static void * TUtil::MemMove ( void * dst, const void * src, TSIZE size )

inlinestatic

Definition at line 93 of file TUtil.h.

{ return std::memmove( dst, src, size ); }

MemSet()

static void TUtil::MemSet ( void * ptr, TINT value, TSIZE size )

inlinestatic

Definition at line 89 of file TUtil.h.

{ std::memset( ptr, value, size ); }

SetTPStringPool()

static TPString8Pool * TUtil::SetTPStringPool ( TPString8Pool * a_pStringPool )

inlinestatic

Definition at line 121 of file TUtil.h.

{ return std::exchange( *ms_poStringPool, a_pStringPool ); }

ToshiCreate()

TBOOL TUtil::ToshiCreate ( const TOSHIParams & a_rToshiParams )

static

Definition at line 149 of file TUtil.cpp.

{
    ms_oToshiParams = a_rToshiParams;
 
    TSystemManager::Create();
    CreateKernelInterface();
    TFileManager::Create();
    CreateTPStringPool();
    Create();
 
    return TTRUE;
}

ToshiDestroy()

void TUtil::ToshiDestroy ( )

static

Definition at line 167 of file TUtil.cpp.

{
    TIMPLEMENT();
    ms_oGlobalMutex.Destroy();
 
    TModelManager::Uninitialise();
}

TrimLog()

void TUtil::TrimLog ( const TCHAR * fileExtension, TSIZE trimTo )

static

Definition at line 16 of file TUtil_Win.cpp.

{
    // and yes they actually did it with std
 
    WIN32_FIND_DATAA        ffd;
    std::queue<std::string> queue;
 
    HANDLE hFind = FindFirstFileA( fileName, &ffd );
 
    if ( INVALID_HANDLE_VALUE == hFind )
    {
        FindClose( hFind );
        return;
    }
 
    do
    {
        if ( ffd.dwFileAttributes & FILE_ATTRIBUTE_ARCHIVE )
        {
            queue.push( ffd.cFileName );
        }
 
        BOOL found = FindNextFileA( hFind, &ffd );
 
        if ( !found )
        {
            FindClose( hFind );
            do
            {
                DeleteFileA( queue.front().c_str() );
                queue.pop();
            } while ( queue.size() > trimTo );
            return;
        }
 
    } while ( TTRUE );
}

Member Data Documentation

kTypeStrings

const TCHAR* TUtil::kTypeStrings[]

staticconstexpr

Initial value:

= {
        "Info",
        "Warning",
        "Error",
        "Critical"
    }

Definition at line 29 of file TUtil.h.

                                                   {
        "Info",
        "Warning",
        "Error",
        "Critical"
    };

s_aiCRC32LUT

TUINT32 TUtil::s_aiCRC32LUT[(256)] = {}

inlinestatic

Definition at line 183 of file TUtil.h.

{};

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TUtil.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Platform/Windows/TUtil_Win.cpp
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/TUtil.cpp