Mirror/StormLib
1
0
Fork 0
mirror of https://github.com/ladislav-zezula/StormLib.git synced 2026-01-16 21:30:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
cdceb0c5275d0ea9b1bbaadf5d6ee29dbb80a2fb
StormLib/test/TLogHelper.cpp
Ladislav Zezula cdceb0c527 Fixed regression tests
2023-01-16 21:22:25 +01:00

506 lines
15 KiB
C++
Raw Blame History

/*****************************************************************************/
/* TLogHelper.cpp Copyright (c) Ladislav Zezula 2013 */
/*---------------------------------------------------------------------------*/
/* Helper class for reporting StormLib tests */
/* This file should be included directly from StormTest.cpp using #include */
/*---------------------------------------------------------------------------*/
/* Date Ver Who Comment */
/* -------- ---- --- ------- */
/* 26.11.13 1.00 Lad Created */
/*****************************************************************************/
//-----------------------------------------------------------------------------
// String replacements for format strings
#if defined(STORMLIB_WINDOWS) || defined(CASCLIB_PLATFORM_WINDOWS)
#define TEST_PLATFORM_WINDOWS
#endif
#ifdef _MSC_VER
#define fmt_I64u_t _T("%I64u")
#define fmt_I64u_a "%I64u"
#define fmt_I64X_t _T("%I64X")
#define fmt_I64X_a "%I64X"
#else
#define fmt_I64u_t _T("%llu")
#define fmt_I64u_a "%llu"
#define fmt_I64X_t _T("%llX")
#define fmt_I64X_a "%llX"
#endif
#ifdef __STORMLIB_SELF__
#define TEST_MIN STORMLIB_MIN
#else
#define TEST_MIN CASCLIB_MIN
#endif
//-----------------------------------------------------------------------------
// Local functions
inline DWORD TestInterlockedIncrement(DWORD * PtrValue)
{
#ifdef TEST_PLATFORM_WINDOWS
return (DWORD)InterlockedIncrement((LONG *)(PtrValue));
#elif defined(__GNUC__)
return __sync_add_and_fetch(PtrValue, 1);
#else
#define INTERLOCKED_NOT_SUPPORTED
return ++(*PtrValue);
#endif
}
inline DWORD Test_GetLastError()
{
#if defined(CASCLIB_PLATFORM_WINDOWS)
return GetCascError();
#else
return GetLastError();
#endif
}
void TestStrCopy(char * szTarget, size_t cchTarget, const char * szSource, size_t cchSource = -1)
{
size_t cchToCopy;
if(cchTarget > 0)
{
// Make sure we know the length
if(cchSource == -1)
cchSource = strlen(szSource);
cchToCopy = TEST_MIN((cchTarget - 1), cchSource);
// Copy the string
memcpy(szTarget, szSource, cchToCopy);
szTarget[cchToCopy] = 0;
}
}
void TestStrCopy(char * szTarget, size_t cchTarget, const wchar_t * szSource, size_t cchSource = -1)
{
size_t cchToCopy;
if(cchTarget > 0)
{
// Make sure we know the length
if(cchSource == -1)
cchSource = wcslen(szSource);
cchToCopy = TEST_MIN((cchTarget - 1), cchSource);
wcstombs(szTarget, szSource, cchToCopy);
szTarget[cchToCopy] = 0;
}
}
wchar_t * CopyFormatCharacter(wchar_t * szBuffer, const wchar_t *& szFormat)
{
static const wchar_t * szStringFormat = _T("%s");
static const wchar_t * szUint64Format = fmt_I64u_t;
// String format
if(szFormat[0] == '%')
{
if(szFormat[1] == 's')
{
_tcscpy(szBuffer, szStringFormat);
szFormat += 2;
return szBuffer + _tcslen(szStringFormat);
}
// Replace %I64u with the proper platform-dependent suffix
if(szFormat[1] == 'I' && szFormat[2] == '6' && szFormat[3] == '4' && szFormat[4] == 'u')
{
_tcscpy(szBuffer, szUint64Format);
szFormat += 5;
return szBuffer + _tcslen(szUint64Format);
}
}
// Copy the character as-is
*szBuffer++ = *szFormat++;
return szBuffer;
}
char * CopyFormatCharacter(char * szBuffer, const char *& szFormat)
{
static const char * szStringFormat = "\"%s\"";
static const char * szUint64Format = fmt_I64u_a;
// String format
if(szFormat[0] == '%')
{
if(szFormat[1] == 's')
{
TestStrCopy(szBuffer, 32, szStringFormat);
szFormat += 2;
return szBuffer + strlen(szStringFormat);
}
// Replace %I64u with the proper platform-dependent suffix
if(szFormat[1] == 'I' && szFormat[2] == '6' && szFormat[3] == '4' && szFormat[4] == 'u')
{
TestStrCopy(szBuffer, 32, szUint64Format);
szFormat += 5;
return szBuffer + strlen(szUint64Format);
}
}
// Copy the character as-is
*szBuffer++ = *szFormat++;
return szBuffer;
}
size_t TestStrPrintfV(char * buffer, size_t nCount, const char * format, va_list argList)
{
return vsnprintf(buffer, nCount, format, argList);
}
size_t TestStrPrintf(char * buffer, size_t nCount, const char * format, ...)
{
va_list argList;
size_t length;
// Start the argument list
va_start(argList, format);
length = TestStrPrintfV(buffer, nCount, format, argList);
va_end(argList);
return length;
}
size_t TestStrPrintfV(wchar_t * buffer, size_t nCount, const wchar_t * format, va_list argList)
{
#ifdef TEST_PLATFORM_WINDOWS
return _vsnwprintf(buffer, nCount, format, argList);
#else
return vswprintf(buffer, nCount, format, argList);
#endif
}
size_t TestStrPrintf(wchar_t * buffer, size_t nCount, const wchar_t * format, ...)
{
va_list argList;
size_t length;
// Start the argument list
va_start(argList, format);
length = TestStrPrintfV(buffer, nCount, format, argList);
va_end(argList);
return length;
}
//-----------------------------------------------------------------------------
// Definition of the TLogHelper class
class TLogHelper
{
public:
//
// Constructor and destructor
//
TLogHelper(const char * szNewMainTitle = NULL, const TCHAR * szNewSubTitle1 = NULL, const TCHAR * szNewSubTitle2 = NULL)
{
TCHAR szMainTitleT[0x80];
// Fill the variables
memset(this, 0, sizeof(TLogHelper));
UserString = "";
UserCount = 1;
UserTotal = 1;
// Fill the test line structure
szMainTitle = szNewMainTitle;
szSubTitle1 = szNewSubTitle1;
szSubTitle2 = szNewSubTitle2;
// Copy the UNICODE main title
StringCopy(szMainTitleT, _countof(szMainTitleT), szMainTitle);
// Print the initial information
if(szNewMainTitle != NULL)
{
if(szSubTitle1 != NULL && szSubTitle2 != NULL)
nPrevPrinted = _tprintf(_T("\rRunning %s (%s+%s) ..."), szMainTitleT, szSubTitle1, szSubTitle2);
else if(szSubTitle1 != NULL)
nPrevPrinted = _tprintf(_T("\rRunning %s (%s) ..."), szMainTitleT, szSubTitle1);
else
nPrevPrinted = _tprintf(_T("\rRunning %s ..."), szMainTitleT);
}
}
TLogHelper::~TLogHelper()
{
// Print a verdict, if no verdict was printed yet
if(bMessagePrinted == false)
{
PrintVerdict(ERROR_SUCCESS);
}
}
//
// Measurement of elapsed time
//
bool TimeElapsed(DWORD Milliseconds)
{
bool bTimeElapsed = false;
#ifdef TEST_PLATFORM_WINDOWS
if(GetTickCount() > (TickCount + Milliseconds))
{
TickCount = GetTickCount();
if(TestInterlockedIncrement(&TimeTrigger) == 1)
{
bTimeElapsed = true;
}
}
#endif
return bTimeElapsed;
}
//
// Printing functions
//
template <typename XCHAR>
DWORD PrintWithClreol(const XCHAR * szFormat, va_list argList, bool bPrintPrefix, bool bPrintLastError, bool bPrintEndOfLine)
{
char * szBufferPtr;
char * szBufferEnd;
size_t nNewPrinted;
size_t nLength = 0;
DWORD dwErrCode = Test_GetLastError();
XCHAR szMessage[0x200];
char szBuffer[0x200];
// Always start the buffer with '\r'
szBufferEnd = szBuffer + _countof(szBuffer);
szBufferPtr = szBuffer;
*szBufferPtr++ = '\r';
// Print the prefix, if needed
if(szMainTitle != NULL && bPrintPrefix)
{
while(szMainTitle[nLength] != 0)
*szBufferPtr++ = szMainTitle[nLength++];
*szBufferPtr++ = ':';
*szBufferPtr++ = ' ';
}
// Construct the message
nLength = TestStrPrintfV(szMessage, _countof(szMessage), szFormat, argList);
TestStrCopy(szBufferPtr, (szBufferEnd - szBufferPtr), szMessage);
szBufferPtr += nLength;
// Append the last error
if(bPrintLastError)
{
nLength = TestStrPrintf(szBufferPtr, (szBufferEnd - szBufferPtr), " (error code: %u)", dwErrCode);
szBufferPtr += nLength;
}
// Remember how much did we print
nNewPrinted = (szBufferPtr - szBuffer);
// Shall we pad the string?
if((nLength = (szBufferPtr - szBuffer - 1)) < nPrevPrinted)
{
size_t nPadding = nPrevPrinted - nLength;
if((size_t)(nLength + nPadding) > (size_t)(szBufferEnd - szBufferPtr))
nPadding = (szBufferEnd - szBufferPtr);
memset(szBufferPtr, ' ', nPadding);
szBufferPtr += nPadding;
}
// Shall we add new line?
if((bPrintEndOfLine != false) && (szBufferPtr < szBufferEnd))
*szBufferPtr++ = '\n';
*szBufferPtr = 0;
// Remember if we printed a message
if(bPrintEndOfLine != false)
{
bMessagePrinted = true;
nPrevPrinted = 0;
}
else
{
nPrevPrinted = nNewPrinted;
}
// Finally print the message
printf("%s", szBuffer);
nMessageCounter++;
return dwErrCode;
}
template <typename XCHAR>
void PrintProgress(const XCHAR * szFormat, ...)
{
va_list argList;
// Always reset the time trigger
TimeTrigger = 0;
// Only print progress when the cooldown is ready
if(ProgressReady())
{
va_start(argList, szFormat);
PrintWithClreol(szFormat, argList, true, false, false);
va_end(argList);
}
}
template <typename XCHAR>
void PrintMessage(const XCHAR * szFormat, ...)
{
va_list argList;
va_start(argList, szFormat);
PrintWithClreol(szFormat, argList, true, false, true);
va_end(argList);
}
void PrintTotalTime()
{
DWORD TotalTime = SetEndTime();
if(TotalTime != 0)
PrintMessage("TotalTime: %u.%u second(s)", (TotalTime / 1000), (TotalTime % 1000));
PrintMessage("Work complete.");
}
template <typename XCHAR>
int PrintErrorVa(const XCHAR * szFormat, ...)
{
va_list argList;
int nResult;
va_start(argList, szFormat);
nResult = PrintWithClreol(szFormat, argList, true, true, true);
va_end(argList);
return nResult;
}
template <typename XCHAR>
int PrintError(const XCHAR * szFormat, const XCHAR * szFileName = NULL)
{
return PrintErrorVa(szFormat, szFileName);
}
// Print final verdict
DWORD PrintVerdict(DWORD dwErrCode = ERROR_SUCCESS)
{
LPCTSTR szSaveSubTitle1 = szSubTitle1;
LPCTSTR szSaveSubTitle2 = szSubTitle2;
TCHAR szSaveMainTitle[0x80];
// Set both to NULL so they won't be printed
StringCopy(szSaveMainTitle, _countof(szSaveMainTitle), szMainTitle);
szSubTitle1 = NULL;
szSubTitle2 = NULL;
szMainTitle = NULL;
// Print the final information
if(szSaveMainTitle[0] != 0)
{
if(DontPrintResult == false)
{
LPCTSTR szVerdict = (dwErrCode == ERROR_SUCCESS) ? _T("succeeded") : _T("failed");
if(szSaveSubTitle1 != NULL && szSaveSubTitle2 != NULL)
PrintMessage(_T("%s (%s+%s) %s."), szSaveMainTitle, szSaveSubTitle1, szSaveSubTitle2, szVerdict);
else if(szSaveSubTitle1 != NULL)
PrintMessage(_T("%s (%s) %s."), szSaveMainTitle, szSaveSubTitle1, szVerdict);
else
PrintMessage(_T("%s %s."), szSaveMainTitle, szVerdict);
}
else
{
PrintProgress(" ");
printf("\r");
}
}
// Return the error code so the caller can pass it fuhrter
return dwErrCode;
}
//
// Time functions
//
ULONGLONG GetCurrentThreadTime()
{
#ifdef _WIN32
ULONGLONG TempTime = 0;
GetSystemTimeAsFileTime((LPFILETIME)(&TempTime));
return ((TempTime) / 10 / 1000);
//ULONGLONG KernelTime = 0;
//ULONGLONG UserTime = 0;
//ULONGLONG TempTime = 0;
//GetThreadTimes(GetCurrentThread(), (LPFILETIME)&TempTime, (LPFILETIME)&TempTime, (LPFILETIME)&KernelTime, (LPFILETIME)&UserTime);
//return ((KernelTime + UserTime) / 10 / 1000);
#else
return time(NULL) * 1000;
#endif
}
bool ProgressReady()
{
time_t dwTickCount = time(NULL);
bool bResult = false;
if(dwTickCount > dwPrevTickCount)
{
dwPrevTickCount = dwTickCount;
bResult = true;
}
return bResult;
}
ULONGLONG SetStartTime()
{
StartTime = GetCurrentThreadTime();
return StartTime;
}
DWORD SetEndTime()
{
EndTime = GetCurrentThreadTime();
return (DWORD)(EndTime - StartTime);
}
ULONGLONG StartTime; // Start time of an operation, in milliseconds
ULONGLONG EndTime; // End time of an operation, in milliseconds
const char * UserString;
unsigned int UserCount;
unsigned int UserTotal;
DWORD TickCount;
DWORD TimeTrigger; // For triggering elapsed timers
DWORD DontPrintResult:1; // If true, supress printing result from the destructor
protected:
const char * szMainTitle; // Title of the text (usually name)
const TCHAR * szSubTitle1; // Title of the text (can be name of the tested file)
const TCHAR * szSubTitle2; // Title of the text (can be name of the tested file)
size_t nMessageCounter;
size_t nPrevPrinted; // Length of the previously printed message
time_t dwPrevTickCount;
bool bMessagePrinted;
};
Reference in New Issue View Git Blame Copy Permalink