[ROSAUTOTEST]
[reactos.git] / rostests / rosautotest / tools.cpp
1 /*
2 * PROJECT: ReactOS Automatic Testing Utility
3 * LICENSE: GNU GPLv2 or any later version as published by the Free Software Foundation
4 * PURPOSE: Various helper functions
5 * COPYRIGHT: Copyright 2008-2009 Colin Finck <colin@reactos.org>
6 */
7
8 #include "precomp.h"
9
10 #define DBGPRINT_BUFSIZE 511
11 static const char HexCharacters[] = "0123456789ABCDEF";
12
13 /**
14 * Escapes a string according to RFC 1738.
15 * Required for passing parameters to the web service.
16 *
17 * @param Input
18 * Constant pointer to a char array, which contains the input buffer to escape.
19 *
20 * @return
21 * The escaped string as std::string.
22 */
23 string
24 EscapeString(const char* Input)
25 {
26 string ReturnedString;
27
28 do
29 {
30 if(strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.~", *Input))
31 {
32 /* It's a character we don't need to escape, just add it to the output string */
33 ReturnedString += *Input;
34 }
35 else
36 {
37 /* We need to escape this character */
38 ReturnedString += '%';
39 ReturnedString += HexCharacters[((UCHAR)*Input >> 4) % 16];
40 ReturnedString += HexCharacters[(UCHAR)*Input % 16];
41 }
42 }
43 while(*++Input);
44
45 return ReturnedString;
46 }
47
48 /**
49 * Escapes a string according to RFC 1738.
50 * Required for passing parameters to the web service.
51 *
52 * @param Input
53 * Pointer to a std::string, which contains the input buffer to escape.
54 *
55 * @return
56 * The escaped string as std::string.
57 */
58 string
59 EscapeString(const string& Input)
60 {
61 return EscapeString(Input.c_str());
62 }
63
64 /**
65 * Determines whether a string contains entirely numeric values.
66 *
67 * @param Input
68 * Constant pointer to a char array containing the input to check.
69 *
70 * @return
71 * true if the string is entirely numeric, false otherwise.
72 */
73 bool
74 IsNumber(const char* Input)
75 {
76 do
77 {
78 if(!isdigit(*Input))
79 return false;
80
81 ++Input;
82 }
83 while(*Input);
84
85 return true;
86 }
87
88 /**
89 * Outputs a string through the standard output and the debug output.
90 * The string may have LF or CRLF line endings.
91 *
92 * @param String
93 * The std::string to output
94 */
95 string
96 StringOut(const string& String, bool forcePrint)
97 {
98 char DbgString[DBGPRINT_BUFSIZE + 1];
99 size_t i, start = 0, last_newline = 0, size = 0, curr_pos = 0;
100 string NewString;
101
102 /* Unify the line endings (the piped output of the tests may use CRLF) */
103 for(i = 0; i < String.size(); i++)
104 {
105 /* If this is a CRLF line-ending, only copy a \n to the new string and skip the next character */
106 if(String[i] == '\r' && String[i + 1] == '\n')
107 {
108 NewString += '\n';
109 ++i;
110 }
111 else
112 {
113 /* Otherwise copy the string */
114 NewString += String[i];
115 }
116
117 curr_pos = NewString.size();
118
119 /* Try to print whole lines but obey the 512 bytes chunk size limit*/
120 if(NewString[curr_pos - 1] == '\n' || (curr_pos - start) == DBGPRINT_BUFSIZE)
121 {
122 if((curr_pos - start) >= DBGPRINT_BUFSIZE)
123 {
124 /* No newlines so far, or the string just fits */
125 if(last_newline <= start || ((curr_pos - start == DBGPRINT_BUFSIZE) && NewString[curr_pos - 1] == '\n'))
126 {
127 size = curr_pos - start;
128 memcpy(DbgString, NewString.c_str() + start, size);
129 start = curr_pos;
130 }
131 else
132 {
133 size = last_newline - start;
134 memcpy(DbgString, NewString.c_str() + start, size);
135 start = last_newline;
136 }
137
138 DbgString[size] = 0;
139 DbgPrint(DbgString);
140 }
141
142 last_newline = curr_pos;
143 }
144 }
145
146 /* Output the string */
147 cout << NewString;
148
149 size = curr_pos - start;
150
151 /* Only print if forced to or if the rest is a whole line */
152 if(forcePrint == true || NewString[curr_pos - 1] == '\n')
153 {
154 memcpy(DbgString, NewString.c_str() + start, size);
155 DbgString[size] = 0;
156 DbgPrint(DbgString);
157
158 NewString.clear();
159 return NewString;
160 }
161
162 /* Return the remaining chunk */
163 return NewString.substr(start, size);
164 }
165
166 /**
167 * Gets a value from a specified INI file and returns it converted to ASCII.
168 *
169 * @param AppName
170 * Constant pointer to a WCHAR array with the INI section to look in (lpAppName parameter passed to GetPrivateProfileStringW)
171 *
172 * @param KeyName
173 * Constant pointer to a WCHAR array containing the key to look for in the specified section (lpKeyName parameter passed to GetPrivateProfileStringW)
174 *
175 * @param FileName
176 * Constant pointer to a WCHAR array containing the path to the INI file
177 *
178 * @return
179 * Returns the data of the value as std::string or an empty string if no data could be retrieved.
180 */
181 string
182 GetINIValue(PCWCH AppName, PCWCH KeyName, PCWCH FileName)
183 {
184 DWORD Length;
185 PCHAR AsciiBuffer;
186 string ReturnedString;
187 WCHAR Buffer[2048];
188
189 /* Load the value into a temporary Unicode buffer */
190 Length = GetPrivateProfileStringW(AppName, KeyName, NULL, Buffer, sizeof(Buffer) / sizeof(WCHAR), FileName);
191
192 if(Length)
193 {
194 /* Convert the string to ASCII charset */
195 AsciiBuffer = new char[Length + 1];
196 WideCharToMultiByte(CP_ACP, 0, Buffer, Length + 1, AsciiBuffer, Length + 1, NULL, NULL);
197
198 ReturnedString = AsciiBuffer;
199 delete[] AsciiBuffer;
200 }
201
202 return ReturnedString;
203 }
204
205 /**
206 * Converts an ASCII string to a Unicode one.
207 *
208 * @param AsciiString
209 * Constant pointer to a char array containing the ASCII string
210 *
211 * @return
212 * The Unicode string as std::wstring
213 */
214 wstring
215 AsciiToUnicode(const char* AsciiString)
216 {
217 DWORD Length;
218 PWSTR UnicodeString;
219 wstring ReturnString;
220
221 Length = MultiByteToWideChar(CP_ACP, 0, AsciiString, -1, NULL, 0);
222
223 UnicodeString = new WCHAR[Length];
224 MultiByteToWideChar(CP_ACP, 0, AsciiString, -1, UnicodeString, Length);
225 ReturnString = UnicodeString;
226 delete UnicodeString;
227
228 return ReturnString;
229 }
230
231 /**
232 * Converts an ASCII string to a Unicode one.
233 *
234 * @param AsciiString
235 * Pointer to a std::string containing the ASCII string
236 *
237 * @return
238 * The Unicode string as std::wstring
239 */
240 wstring
241 AsciiToUnicode(const string& AsciiString)
242 {
243 return AsciiToUnicode(AsciiString.c_str());
244 }
245
246 /**
247 * Converts a Unicode string to an ASCII one.
248 *
249 * @param UnicodeString
250 * Constant pointer to a WCHAR array containing the Unicode string
251 *
252 * @return
253 * The ASCII string as std::string
254 */
255 string
256 UnicodeToAscii(PCWSTR UnicodeString)
257 {
258 DWORD Length;
259 PCHAR AsciiString;
260 string ReturnString;
261
262 Length = WideCharToMultiByte(CP_ACP, 0, UnicodeString, -1, NULL, 0, NULL, NULL);
263
264 AsciiString = new char[Length];
265 WideCharToMultiByte(CP_ACP, 0, UnicodeString, -1, AsciiString, Length, NULL, NULL);
266 ReturnString = AsciiString;
267 delete AsciiString;
268
269 return ReturnString;
270 }
271
272 /**
273 * Converts a Unicode string to an ASCII one.
274 *
275 * @param UnicodeString
276 * Pointer to a std::wstring containing the Unicode string
277 *
278 * @return
279 * The ASCII string as std::string
280 */
281 string
282 UnicodeToAscii(const wstring& UnicodeString)
283 {
284 return UnicodeToAscii(UnicodeString.c_str());
285 }