1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
/*****************************************************************************/
/* TLogHelper.cpp Copyright (c) Ladislav Zezula 2013 */
/*---------------------------------------------------------------------------*/
/* Helper class for reporting StormLib tests */
/* This file should be included directly from Test.cpp using #include */
/*---------------------------------------------------------------------------*/
/* Date Ver Who Comment */
/* -------- ---- --- ------- */
/* 26.11.13 1.00 Lad The first version of TLogHelper.cpp */
/*****************************************************************************/
//-----------------------------------------------------------------------------
// Definition of the TLogHelper class
class TLogHelper
{
public:
TLogHelper(const char * szTestName);
~TLogHelper();
#if defined(UNICODE) || defined(UNICODE)
// TCHAR-based functions. They are only needed on UNICODE builds.
// On ANSI builds is TCHAR = char, so we don't need them at all
int PrintWithClreol(const TCHAR * szFormat, va_list argList, bool bPrintPrefix, bool bPrintLastError, bool bPrintEndOfLine);
int PrintErrorVa(const TCHAR * szFormat, ...);
int PrintError(const TCHAR * szFormat, const TCHAR * szFileName = NULL);
#endif // defined(UNICODE) || defined(UNICODE)
// ANSI functions
int PrintWithClreol(const char * szFormat, va_list argList, bool bPrintPrefix, bool bPrintLastError, bool bPrintEndOfLine);
void PrintProgress(const char * szFormat, ...);
void PrintMessage(const char * szFormat, ...);
int PrintErrorVa(const char * szFormat, ...);
int PrintError(const char * szFormat, const char * szFileName = NULL);
protected:
int GetConsoleWidth();
const char * szTestName; // Title of the text
size_t nTextLength; // Length of the previous progress message
bool bMessagePrinted;
};
//-----------------------------------------------------------------------------
// Constructor and destructor
TLogHelper::TLogHelper(const char * szName)
{
// Fill the test line structure
szTestName = szName;
nTextLength = 0;
bMessagePrinted = false;
// Show the user that a test is running
PrintProgress("Running test \"%s\" ...", szTestName);
}
TLogHelper::~TLogHelper()
{
// If no message has been printed, show "OK"
if(bMessagePrinted == false)
PrintMessage("Running test \"%s\" ... OK", szTestName);
}
//-----------------------------------------------------------------------------
// TCHAR-based functions. They are only needed on UNICODE builds.
// On ANSI builds is TCHAR = char, so we don't need them at all
#if defined(UNICODE) || defined(UNICODE)
int TLogHelper::PrintWithClreol(const TCHAR * szFormat, va_list argList, bool bPrintPrefix, bool bPrintLastError, bool bPrintEndOfLine)
{
TCHAR szOneLineBuff[0x200];
TCHAR * szSaveBuffer;
TCHAR * szBuffer = szOneLineBuff;
int nRemainingWidth;
int nConsoleWidth = GetConsoleWidth();
int nLength = 0;
int nError = GetLastError();
// Always start the buffer with '\r'
*szBuffer++ = '\r';
szSaveBuffer = szBuffer;
// Print the prefix, if needed
if(szTestName != NULL && bPrintPrefix)
{
while(szTestName[nLength] != 0)
*szBuffer++ = szTestName[nLength++];
*szBuffer++ = ':';
*szBuffer++ = ' ';
}
// Format the message itself
if(szFormat != NULL)
{
nLength = _vstprintf(szBuffer, szFormat, argList);
szBuffer += nLength;
}
// Print the last error, if needed
if(bPrintLastError)
{
nLength = _stprintf(szBuffer, _T(" (error code: %u)"), nError);
szBuffer += nLength;
}
// Shall we pad the string?
if((szBuffer - szSaveBuffer) < nConsoleWidth)
{
// Calculate the remaining width
nRemainingWidth = GetConsoleWidth() - (int)(szBuffer - szSaveBuffer) - 1;
// Pad the string with spaces to fill it up to the end of the line
for(int i = 0; i < nRemainingWidth; i++)
*szBuffer++ = 0x20;
// Pad the buffer with backslashes to fill it up to the end of the line
for(int i = 0; i < nRemainingWidth; i++)
*szBuffer++ = 0x08;
}
// Put the newline, if requested
*szBuffer++ = bPrintEndOfLine ? '\n' : 0;
*szBuffer = 0;
// Remember if we printed a message
if(bPrintEndOfLine)
bMessagePrinted = true;
// Spit out the text in one single printf
_tprintf(szOneLineBuff);
return nError;
}
int TLogHelper::PrintErrorVa(const TCHAR * szFormat, ...)
{
va_list argList;
int nResult;
va_start(argList, szFormat);
nResult = PrintWithClreol(szFormat, argList, true, true, true);
va_end(argList);
return nResult;
}
int TLogHelper::PrintError(const TCHAR * szFormat, const TCHAR * szFileName)
{
return PrintErrorVa(szFormat, szFileName);
}
#endif // defined(UNICODE) || defined(UNICODE)
//-----------------------------------------------------------------------------
// ANSI functions
int TLogHelper::PrintWithClreol(const char * szFormat, va_list argList, bool bPrintPrefix, bool bPrintLastError, bool bPrintEndOfLine)
{
char szOneLineBuff[0x200];
char * szSaveBuffer;
char * szBuffer = szOneLineBuff;
int nRemainingWidth;
int nConsoleWidth = GetConsoleWidth();
int nLength = 0;
int nError = GetLastError();
// Always start the buffer with '\r'
*szBuffer++ = '\r';
szSaveBuffer = szBuffer;
// Print the prefix, if needed
if(szTestName != NULL && bPrintPrefix)
{
while(szTestName[nLength] != 0)
*szBuffer++ = szTestName[nLength++];
*szBuffer++ = ':';
*szBuffer++ = ' ';
}
// Format the message itself
if(szFormat != NULL)
{
nLength = vsprintf(szBuffer, szFormat, argList);
szBuffer += nLength;
}
// Print the last error, if needed
if(bPrintLastError)
{
nLength = sprintf(szBuffer, " (error code: %u)", nError);
szBuffer += nLength;
}
// Shall we pad the string?
if((szBuffer - szSaveBuffer) < nConsoleWidth)
{
// Calculate the remaining width
nRemainingWidth = GetConsoleWidth() - (int)(szBuffer - szSaveBuffer) - 1;
// Pad the string with spaces to fill it up to the end of the line
for(int i = 0; i < nRemainingWidth; i++)
*szBuffer++ = 0x20;
// Pad the buffer with backslashes to fill it up to the end of the line
for(int i = 0; i < nRemainingWidth; i++)
*szBuffer++ = 0x08;
}
// Put the newline, if requested
*szBuffer++ = bPrintEndOfLine ? '\n' : 0;
*szBuffer = 0;
// Remember if we printed a message
if(bPrintEndOfLine)
bMessagePrinted = true;
// Spit out the text in one single printf
printf(szOneLineBuff);
return nError;
}
void TLogHelper::PrintProgress(const char * szFormat, ...)
{
va_list argList;
va_start(argList, szFormat);
PrintWithClreol(szFormat, argList, true, false, false);
va_end(argList);
}
void TLogHelper::PrintMessage(const char * szFormat, ...)
{
va_list argList;
va_start(argList, szFormat);
PrintWithClreol(szFormat, argList, true, false, true);
va_end(argList);
}
int TLogHelper::PrintErrorVa(const char * szFormat, ...)
{
va_list argList;
int nResult;
va_start(argList, szFormat);
nResult = PrintWithClreol(szFormat, argList, true, true, true);
va_end(argList);
return nResult;
}
int TLogHelper::PrintError(const char * szFormat, const char * szFileName)
{
return PrintErrorVa(szFormat, szFileName);
}
//-----------------------------------------------------------------------------
// Protected functions
int TLogHelper::GetConsoleWidth()
{
#ifdef PLATFORM_WINDOWS
CONSOLE_SCREEN_BUFFER_INFO ScreenInfo;
GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &ScreenInfo);
return (int)(ScreenInfo.srWindow.Right - ScreenInfo.srWindow.Left);
#else
// On non-Windows platforms, we assume that width of the console line
// is 80 characters
return 80;
#endif
}
|
