dlls/setupapi/tests/stringtable.c

   1 /*
   2  * Unit test suite for StringTable functions
   3  *
   4  * Copyright 2005 Steven Edwards for ReactOS
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20 /*
  21  * TODO:
  22  * Add test for StringTableStringFromIdEx
  23  */
  24
  25 #include <stdarg.h>
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "wingdi.h"
  30 #include "winuser.h"
  31 #include "winreg.h"
  32 #include "winnls.h"
  33 #include "setupapi.h"
  34
  35 #include "wine/test.h"
  36
  37 DECLARE_HANDLE(HSTRING_TABLE);
  38
  39 /* Flags for StringTableAddString and StringTableLookUpString */
  40 #define ST_CASE_SENSITIVE_COMPARE       0x00000001
  41
  42 static DWORD    (WINAPI *pStringTableAddString)(HSTRING_TABLE, LPWSTR, DWORD);
  43 static DWORD    (WINAPI *pStringTableAddStringEx)(HSTRING_TABLE, LPWSTR, DWORD, LPVOID, DWORD);
  44 static VOID     (WINAPI *pStringTableDestroy)(HSTRING_TABLE);
  45 static HSTRING_TABLE (WINAPI *pStringTableDuplicate)(HSTRING_TABLE hStringTable);
  46 static HSTRING_TABLE (WINAPI *pStringTableInitialize)(VOID);
  47 static HSTRING_TABLE (WINAPI *pStringTableInitializeEx)(DWORD, DWORD);
  48 static DWORD    (WINAPI *pStringTableLookUpString)(HSTRING_TABLE, LPWSTR, DWORD);
  49 static DWORD    (WINAPI *pStringTableLookUpStringEx)(HSTRING_TABLE, LPWSTR, DWORD, LPVOID, DWORD);
  50 static LPWSTR   (WINAPI *pStringTableStringFromId)(HSTRING_TABLE, DWORD);
  51 static BOOL     (WINAPI *pStringTableGetExtraData)(HSTRING_TABLE, ULONG, void*, ULONG);
  52
  53 static WCHAR string[] = {'s','t','r','i','n','g',0};
  54 static WCHAR String[] = {'S','t','r','i','n','g',0};
  55 static WCHAR foo[] = {'f','o','o',0};
  56
  57 static void load_it_up(void)
  58 {
  59     HMODULE hdll = GetModuleHandleA("setupapi.dll");
  60
  61 #define X(f) if (!(p##f = (void*)GetProcAddress(hdll, #f))) \
  62                  p##f = (void*)GetProcAddress(hdll, "pSetup"#f);
  63     X(StringTableInitialize);
  64     X(StringTableInitializeEx);
  65     X(StringTableAddString);
  66     X(StringTableAddStringEx);
  67     X(StringTableDuplicate);
  68     X(StringTableDestroy);
  69     X(StringTableLookUpString);
  70     X(StringTableLookUpStringEx);
  71     X(StringTableStringFromId);
  72     X(StringTableGetExtraData);
  73 #undef X
  74 }
  75
  76 static void test_StringTableAddString(void)
  77 {
  78     DWORD retval, hstring, hString, hfoo;
  79     HSTRING_TABLE table;
  80
  81     table = pStringTableInitialize();
  82     ok(table != NULL, "failed to initialize string table\n");
  83
  84     /* case insensitive */
  85     hstring=pStringTableAddString(table,string,0);
  86     ok(hstring!=-1,"Failed to add string to String Table\n");
  87
  88     retval=pStringTableAddString(table,String,0);
  89     ok(retval!=-1,"Failed to add String to String Table\n");
  90     ok(hstring==retval,"string handle %x != String handle %x in String Table\n", hstring, retval);
  91
  92     hfoo=pStringTableAddString(table,foo,0);
  93     ok(hfoo!=-1,"Failed to add foo to String Table\n");
  94     ok(hfoo!=hstring,"foo and string share the same ID %x in String Table\n", hfoo);
  95
  96     /* case sensitive */
  97     hString=pStringTableAddString(table,String,ST_CASE_SENSITIVE_COMPARE);
  98     ok(hstring!=hString,"String handle and string share same ID %x in Table\n", hstring);
  99
 100     pStringTableDestroy(table);
 101 }
 102
 103 static void test_StringTableAddStringEx(void)
 104 {
 105     DWORD retval, hstring, hString, hfoo, extra;
 106     HANDLE table;
 107     BOOL ret;
 108
 109     table = pStringTableInitialize();
 110     ok(table != NULL,"Failed to Initialize String Table\n");
 111
 112     /* case insensitive */
 113     hstring = pStringTableAddStringEx(table, string, 0, NULL, 0);
 114     ok(hstring != -1, "Failed to add string to String Table\n");
 115
 116     retval = pStringTableAddStringEx(table, String, 0, NULL, 0);
 117     ok(retval != -1, "Failed to add String to String Table\n");
 118     ok(hstring == retval, "string handle %x != String handle %x in String Table\n", hstring, retval);
 119
 120     hfoo = pStringTableAddStringEx(table, foo, 0, NULL, 0);
 121     ok(hfoo != -1, "Failed to add foo to String Table\n");
 122     ok(hfoo != hstring, "foo and string share the same ID %x in String Table\n", hfoo);
 123
 124     /* case sensitive */
 125     hString = pStringTableAddStringEx(table, String, ST_CASE_SENSITIVE_COMPARE, NULL, 0);
 126     ok(hstring != hString, "String handle and string share same ID %x in Table\n", hstring);
 127
 128     pStringTableDestroy(table);
 129
 130     /* set same string twice but with different extra */
 131     table = pStringTableInitializeEx(4, 0);
 132     ok(table != NULL, "Failed to Initialize String Table\n");
 133
 134     extra = 10;
 135     hstring = pStringTableAddStringEx(table, string, 0, &extra, 4);
 136     ok(hstring != -1, "failed to add string, %d\n", hstring);
 137
 138     extra = 0;
 139     ret = pStringTableGetExtraData(table, hstring, &extra, 4);
 140     ok(ret && extra == 10, "got %d, extra %d\n", ret, extra);
 141
 142     extra = 11;
 143     hstring = pStringTableAddStringEx(table, string, 0, &extra, 4);
 144     ok(hstring != -1, "failed to add string, %d\n", hstring);
 145
 146     extra = 0;
 147     ret = pStringTableGetExtraData(table, hstring, &extra, 4);
 148     ok(ret && extra == 10, "got %d, extra %d\n", ret, extra);
 149
 150     pStringTableDestroy(table);
 151 }
 152
 153 static void test_StringTableDuplicate(void)
 154 {
 155     HSTRING_TABLE table, table2;
 156
 157     table = pStringTableInitialize();
 158     ok(table != NULL,"Failed to Initialize String Table\n");
 159
 160     table2=pStringTableDuplicate(table);
 161     ok(table2!=NULL,"Failed to duplicate String Table\n");
 162
 163     pStringTableDestroy(table);
 164     pStringTableDestroy(table2);
 165 }
 166
 167 static void test_StringTableLookUpString(void)
 168 {
 169     DWORD retval, retval2, hstring, hString, hfoo;
 170     HSTRING_TABLE table, table2;
 171
 172     table = pStringTableInitialize();
 173     ok(table != NULL,"failed to initialize string table\n");
 174
 175     hstring = pStringTableAddString(table, string, 0);
 176     ok(hstring != ~0u, "failed to add 'string' to string table\n");
 177
 178     hString = pStringTableAddString(table, String, 0);
 179     ok(hString != ~0u,"failed to add 'String' to string table\n");
 180
 181     hfoo = pStringTableAddString(table, foo, 0);
 182     ok(hfoo != ~0u, "failed to add 'foo' to string table\n");
 183
 184     table2 = pStringTableDuplicate(table);
 185     ok(table2 != NULL, "Failed to duplicate String Table\n");
 186
 187     /* case insensitive */
 188     retval=pStringTableLookUpString(table,string,0);
 189     ok(retval!=-1,"Failed find string in String Table 1\n");
 190     ok(retval==hstring,
 191         "Lookup for string (%x) does not match previous handle (%x) in String Table 1\n",
 192         retval, hstring);
 193
 194     retval=pStringTableLookUpString(table2,string,0);
 195     ok(retval!=-1,"Failed find string in String Table 2\n");
 196
 197     retval=pStringTableLookUpString(table,String,0);
 198     ok(retval!=-1,"Failed find String in String Table 1\n");
 199
 200     retval=pStringTableLookUpString(table2,String,0);
 201     ok(retval!=-1,"Failed find String in String Table 2\n");
 202
 203     retval=pStringTableLookUpString(table,foo,0);
 204     ok(retval!=-1,"Failed find foo in String Table 1\n");
 205     ok(retval==hfoo,
 206         "Lookup for foo (%x) does not match previous handle (%x) in String Table 1\n",
 207         retval, hfoo);
 208
 209     retval=pStringTableLookUpString(table2,foo,0);
 210     ok(retval!=-1,"Failed find foo in String Table 2\n");
 211
 212     /* case sensitive */
 213     retval=pStringTableLookUpString(table,string,ST_CASE_SENSITIVE_COMPARE);
 214     retval2=pStringTableLookUpString(table,String,ST_CASE_SENSITIVE_COMPARE);
 215     ok(retval!=retval2,"Lookup of string equals String in Table 1\n");
 216     ok(retval==hString,
 217         "Lookup for String (%x) does not match previous handle (%x) in String Table 1\n",
 218         retval, hString);
 219
 220     pStringTableDestroy(table);
 221     pStringTableDestroy(table2);
 222 }
 223
 224 static void test_StringTableLookUpStringEx(void)
 225 {
 226     static WCHAR uilevel[] = {'U','I','L','E','V','E','L',0};
 227     DWORD retval, retval2, hstring, hString, hfoo, data;
 228     HSTRING_TABLE table, table2;
 229     char buffer[4];
 230
 231     table = pStringTableInitialize();
 232     ok(table != NULL,"Failed to Initialize String Table\n");
 233
 234     hstring = pStringTableAddString(table, string, 0);
 235     ok(hstring != ~0u, "failed to add 'string' to string table\n");
 236
 237     hString = pStringTableAddString(table, String, 0);
 238     ok(hString != ~0u,"failed to add 'String' to string table\n");
 239
 240     hfoo = pStringTableAddString(table, foo, 0);
 241     ok(hfoo != ~0u, "failed to add 'foo' to string table\n");
 242
 243     table2 = pStringTableDuplicate(table);
 244     ok(table2 != NULL, "Failed to duplicate String Table\n");
 245
 246     /* case insensitive */
 247     retval = pStringTableLookUpStringEx(table, string, 0, NULL, 0);
 248     ok(retval != ~0u, "Failed find string in String Table 1\n");
 249     ok(retval == hstring,
 250         "Lookup for string (%x) does not match previous handle (%x) in String Table 1\n",
 251         retval, hstring);
 252
 253     retval = pStringTableLookUpStringEx(table2, string, 0, NULL, 0);
 254     ok(retval != ~0u, "Failed find string in String Table 2\n");
 255
 256     retval = pStringTableLookUpStringEx(table, String, 0, NULL, 0);
 257     ok(retval != ~0u, "Failed find String in String Table 1\n");
 258
 259     retval = pStringTableLookUpStringEx(table2, String, 0, NULL, 0);
 260     ok(retval != ~0u, "Failed find String in String Table 2\n");
 261
 262     retval=pStringTableLookUpStringEx(table, foo, 0, NULL, 0);
 263     ok(retval != ~0u, "Failed find foo in String Table 1\n");
 264     ok(retval == hfoo,
 265         "Lookup for foo (%x) does not match previous handle (%x) in String Table 1\n",
 266         retval, hfoo);
 267
 268     retval = pStringTableLookUpStringEx(table2, foo, 0, NULL, 0);
 269     ok(retval != ~0u, "Failed find foo in String Table 2\n");
 270
 271     /* case sensitive */
 272     retval = pStringTableLookUpStringEx(table, string,ST_CASE_SENSITIVE_COMPARE, NULL, 0);
 273     retval2 = pStringTableLookUpStringEx(table, String, ST_CASE_SENSITIVE_COMPARE, NULL, 0);
 274     ok(retval != retval2, "Lookup of string equals String in Table 1\n");
 275     ok(retval == hString,
 276         "Lookup for String (%x) does not match previous handle (%x) in String Table 1\n",
 277         retval, hString);
 278
 279     pStringTableDestroy(table);
 280
 281     table = pStringTableInitializeEx(0x1000, 0);
 282     ok(table != NULL, "failed to initialize string table\n");
 283
 284     data = 0xaaaaaaaa;
 285     retval = pStringTableAddStringEx(table, uilevel, 0x5, &data, sizeof(data));
 286     ok(retval != ~0u, "failed to add 'UILEVEL' to string table\n");
 287
 288     memset(buffer, 0x55, sizeof(buffer));
 289     retval = pStringTableLookUpStringEx(table, uilevel, ST_CASE_SENSITIVE_COMPARE, buffer, 0);
 290     ok(retval != ~0u, "failed find 'UILEVEL' in string table\n");
 291     ok(memcmp(buffer, &data, 4), "unexpected data\n");
 292
 293     memset(buffer, 0x55, sizeof(buffer));
 294     retval = pStringTableLookUpStringEx(table, uilevel, ST_CASE_SENSITIVE_COMPARE, buffer, 2);
 295     ok(retval != ~0u, "failed find 'UILEVEL' in string table\n");
 296     ok(!memcmp(buffer, &data, 2), "unexpected data\n");
 297
 298     memset(buffer, 0x55, sizeof(buffer));
 299     retval = pStringTableLookUpStringEx(table, uilevel, ST_CASE_SENSITIVE_COMPARE, buffer, sizeof(buffer));
 300     ok(retval != ~0u, "failed find 'UILEVEL' in string table\n");
 301     ok(!memcmp(buffer, &data, 4), "unexpected data\n");
 302
 303     pStringTableDestroy(table);
 304     pStringTableDestroy(table2);
 305 }
 306
 307 static void test_StringTableStringFromId(void)
 308 {
 309     HSTRING_TABLE table;
 310     WCHAR *string2;
 311     DWORD id, id2;
 312
 313     table = pStringTableInitialize();
 314     ok(table != NULL, "Failed to Initialize String Table\n");
 315
 316     id = pStringTableAddString(table, string, 0);
 317     ok(id != -1, "failed to add 'string' to string table\n");
 318
 319     /* correct */
 320     id2 = pStringTableLookUpString(table, string, 0);
 321     ok(id2 == id, "got %d and %d\n", id2, id);
 322
 323     string2 = pStringTableStringFromId(table, id2);
 324     ok(string2 != NULL, "failed to lookup string %d\n", id2);
 325     ok(!lstrcmpiW(string, string2), "got %s, expected %s\n", wine_dbgstr_w(string2), wine_dbgstr_w(string));
 326
 327     pStringTableDestroy(table);
 328 }
 329
 330 struct stringtable {
 331     char     *data;
 332     ULONG     nextoffset;
 333     ULONG     allocated;
 334     DWORD_PTR unk[2];
 335     ULONG     max_extra_size;
 336     LCID      lcid;
 337 };
 338
 339 static void test_stringtable_layout(void)
 340 {
 341     struct stringtable *ptr;
 342     HSTRING_TABLE table;
 343
 344     table = pStringTableInitialize();
 345     ok(table != NULL,"failed to initialize string table\n");
 346
 347     ptr = (struct stringtable*)table;
 348     ok(ptr->data != NULL, "got %p\n", ptr->data);
 349     /* first data offset is right after bucket area */
 350     ok(ptr->nextoffset == 509*sizeof(DWORD), "got %d\n", ptr->nextoffset);
 351     ok(ptr->allocated != 0, "got %d\n", ptr->allocated);
 352 todo_wine {
 353     ok(ptr->unk[0] != 0, "got %lx\n", ptr->unk[0]);
 354     ok(ptr->unk[1] != 0, "got %lx\n", ptr->unk[1]);
 355 }
 356     ok(ptr->max_extra_size == 0, "got %d\n", ptr->max_extra_size);
 357     ok(ptr->lcid == GetThreadLocale(), "got %x, thread lcid %x\n", ptr->lcid, GetThreadLocale());
 358
 359     pStringTableDestroy(table);
 360 }
 361
 362 START_TEST(stringtable)
 363 {
 364     load_it_up();
 365
 366     test_StringTableAddString();
 367     test_StringTableAddStringEx();
 368     test_StringTableDuplicate();
 369     test_StringTableLookUpString();
 370     test_StringTableLookUpStringEx();
 371     test_StringTableStringFromId();
 372     test_stringtable_layout();
 373 }