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 void
  96 StringOut(const string& String)
  97 {
  98     char DbgString[DBGPRINT_BUFSIZE + 1];
  99     size_t i;
 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
 118     /* Output the string.
 119        For DbgPrint, this must be done in chunks of 512 bytes. */
 120     cout << NewString;
 121
 122     for(i = 0; i < NewString.size(); i += DBGPRINT_BUFSIZE)
 123     {
 124         size_t BytesToCopy;
 125
 126         if(NewString.size() - i > DBGPRINT_BUFSIZE)
 127             BytesToCopy = DBGPRINT_BUFSIZE;
 128         else
 129             BytesToCopy = NewString.size() - i;
 130
 131         memcpy(DbgString, NewString.c_str() + i, BytesToCopy);
 132         DbgString[BytesToCopy] = 0;
 133
 134         DbgPrint(DbgString);
 135     }
 136 }
 137
 138 /**
 139  * Gets a value from a specified INI file and returns it converted to ASCII.
 140  *
 141  * @param AppName
 142  * Constant pointer to a WCHAR array with the INI section to look in (lpAppName parameter passed to GetPrivateProfileStringW)
 143  *
 144  * @param KeyName
 145  * Constant pointer to a WCHAR array containing the key to look for in the specified section (lpKeyName parameter passed to GetPrivateProfileStringW)
 146  *
 147  * @param FileName
 148  * Constant pointer to a WCHAR array containing the path to the INI file
 149  *
 150  * @return
 151  * Returns the data of the value as std::string or an empty string if no data could be retrieved.
 152  */
 153 string
 154 GetINIValue(PCWCH AppName, PCWCH KeyName, PCWCH FileName)
 155 {
 156     DWORD Length;
 157     PCHAR AsciiBuffer;
 158     string ReturnedString;
 159     WCHAR Buffer[2048];
 160
 161     /* Load the value into a temporary Unicode buffer */
 162     Length = GetPrivateProfileStringW(AppName, KeyName, NULL, Buffer, sizeof(Buffer) / sizeof(WCHAR), FileName);
 163
 164     if(Length)
 165     {
 166         /* Convert the string to ASCII charset */
 167         AsciiBuffer = new char[Length + 1];
 168         WideCharToMultiByte(CP_ACP, 0, Buffer, Length + 1, AsciiBuffer, Length + 1, NULL, NULL);
 169
 170         ReturnedString = AsciiBuffer;
 171         delete AsciiBuffer;
 172     }
 173
 174     return ReturnedString;
 175 }
 176
 177 /**
 178  * Converts an ASCII string to a Unicode one.
 179  *
 180  * @param AsciiString
 181  * Constant pointer to a char array containing the ASCII string
 182  *
 183  * @return
 184  * The Unicode string as std::wstring
 185  */
 186 wstring
 187 AsciiToUnicode(const char* AsciiString)
 188 {
 189     DWORD Length;
 190     PWSTR UnicodeString;
 191     wstring ReturnString;
 192
 193     Length = MultiByteToWideChar(CP_ACP, 0, AsciiString, -1, NULL, 0);
 194
 195     UnicodeString = new WCHAR[Length];
 196     MultiByteToWideChar(CP_ACP, 0, AsciiString, -1, UnicodeString, Length);
 197     ReturnString = UnicodeString;
 198     delete UnicodeString;
 199
 200     return ReturnString;
 201 }
 202
 203 /**
 204  * Converts an ASCII string to a Unicode one.
 205  *
 206  * @param AsciiString
 207  * Pointer to a std::string containing the ASCII string
 208  *
 209  * @return
 210  * The Unicode string as std::wstring
 211  */
 212 wstring
 213 AsciiToUnicode(const string& AsciiString)
 214 {
 215     return AsciiToUnicode(AsciiString.c_str());
 216 }
 217
 218 /**
 219  * Converts a Unicode string to an ASCII one.
 220  *
 221  * @param UnicodeString
 222  * Constant pointer to a WCHAR array containing the Unicode string
 223  *
 224  * @return
 225  * The ASCII string as std::string
 226  */
 227 string
 228 UnicodeToAscii(PCWSTR UnicodeString)
 229 {
 230     DWORD Length;
 231     PCHAR AsciiString;
 232     string ReturnString;
 233
 234     Length = WideCharToMultiByte(CP_ACP, 0, UnicodeString, -1, NULL, 0, NULL, NULL);
 235
 236     AsciiString = new char[Length];
 237     WideCharToMultiByte(CP_ACP, 0, UnicodeString, -1, AsciiString, Length, NULL, NULL);
 238     ReturnString = AsciiString;
 239     delete AsciiString;
 240
 241     return ReturnString;
 242 }
 243
 244 /**
 245  * Converts a Unicode string to an ASCII one.
 246  *
 247  * @param UnicodeString
 248  * Pointer to a std::wstring containing the Unicode string
 249  *
 250  * @return
 251  * The ASCII string as std::string
 252  */
 253 string
 254 UnicodeToAscii(const wstring& UnicodeString)
 255 {
 256     return UnicodeToAscii(UnicodeString.c_str());
 257 }