2 * INF file parsing tests
4 * Copyright 2002, 2005 Alexandre Julliard for CodeWeavers
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.
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.
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
31 #include "wine/test.h"
33 /* function pointers */
34 static HMODULE hSetupAPI;
35 static LPCWSTR (WINAPI *pSetupGetField)(PINFCONTEXT,DWORD);
37 static void init_function_pointers(void)
39 hSetupAPI = LoadLibraryA("setupapi.dll");
43 pSetupGetField = (void *)GetProcAddress(hSetupAPI, "pSetupGetField");
46 static const char tmpfile[] = ".\\tmp.inf";
48 /* some large strings */
49 #define A255 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
50 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
51 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
52 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
54 #define A400 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
55 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
56 "aaaaaaaaaaaaaaaa" A256
57 #define A511 A255 A256
58 #define A4097 "a" A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256 A256
60 #define STD_HEADER "[Version]\r\nSignature=\"$CHICAGO$\"\r\n"
62 #define STR_SECTION "[Strings]\nfoo=aaa\nbar=bbb\nloop=%loop2%\nloop2=%loop%\n" \
63 "per%%cent=abcd\nper=1\ncent=2\n22=foo\n" \
65 "verybig=" A400 A400 A400 "\n"
67 /* create a new file with specified contents and open it */
68 static HINF test_file_contents( const char *data, UINT *err_line )
71 HANDLE handle = CreateFileA( tmpfile, GENERIC_READ|GENERIC_WRITE,
72 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, CREATE_ALWAYS, 0, 0 );
73 if (handle == INVALID_HANDLE_VALUE) return 0;
74 if (!WriteFile( handle, data, strlen(data), &res, NULL )) trace( "write error\n" );
75 CloseHandle( handle );
76 return SetupOpenInfFileA( tmpfile, 0, INF_STYLE_WIN4, err_line );
79 static const char *get_string_field( INFCONTEXT *context, DWORD index )
81 static char buffer[MAX_INF_STRING_LENGTH+32];
82 if (SetupGetStringFieldA( context, index, buffer, sizeof(buffer), NULL )) return buffer;
86 static const char *get_line_text( INFCONTEXT *context )
88 static char buffer[MAX_INF_STRING_LENGTH+32];
89 if (SetupGetLineTextA( context, 0, 0, 0, buffer, sizeof(buffer), NULL )) return buffer;
94 /* Test various valid/invalid file formats */
104 /* file contents expected error (or 0) errline todo */
105 { "\r\n", ERROR_WRONG_INF_STYLE, 0, 0 },
106 { "abcd\r\n", ERROR_WRONG_INF_STYLE, 0, 1 },
107 { "[Version]\r\n", ERROR_WRONG_INF_STYLE, 0, 0 },
108 { "[Version]\nSignature=", ERROR_WRONG_INF_STYLE, 0, 0 },
109 { "[Version]\nSignature=foo", ERROR_WRONG_INF_STYLE, 0, 0 },
110 { "[version]\nsignature=$chicago$", 0, 0, 0 },
111 { "[VERSION]\nSIGNATURE=$CHICAGO$", 0, 0, 0 },
112 { "[Version]\nSignature=$chicago$,abcd", 0, 0, 0 },
113 { "[Version]\nabc=def\nSignature=$chicago$", 0, 0, 0 },
114 { "[Version]\nabc=def\n[Version]\nSignature=$chicago$", 0, 0, 0 },
115 { STD_HEADER, 0, 0, 0 },
116 { STD_HEADER "[]\r\n", 0, 0, 0 },
117 { STD_HEADER "]\r\n", 0, 0, 0 },
118 { STD_HEADER "[" A255 "]\r\n", 0, 0, 0 },
119 { STD_HEADER "[ab\r\n", ERROR_BAD_SECTION_NAME_LINE, 3, 0 },
120 { STD_HEADER "\n\n[ab\x1a]\n", ERROR_BAD_SECTION_NAME_LINE, 5, 0 },
121 { STD_HEADER "[" A256 "]\r\n", ERROR_SECTION_NAME_TOO_LONG, 3, 0 },
122 { "[abc]\n" STD_HEADER, 0, 0, 0 },
123 { "abc\r\n" STD_HEADER, ERROR_EXPECTED_SECTION_NAME, 1, 0 },
124 { ";\n;\nabc\r\n" STD_HEADER, ERROR_EXPECTED_SECTION_NAME, 3, 0 },
125 { ";\n;\nab\nab\n" STD_HEADER, ERROR_EXPECTED_SECTION_NAME, 3, 0 },
126 { ";aa\n;bb\n" STD_HEADER, 0, 0, 0 },
127 { STD_HEADER " [TestSection\x00] \n", ERROR_BAD_SECTION_NAME_LINE, 3, 0 },
128 { STD_HEADER " [Test\x00Section] \n", ERROR_BAD_SECTION_NAME_LINE, 3, 0 },
129 { STD_HEADER " [TestSection\x00] \n", ERROR_BAD_SECTION_NAME_LINE, 3, 0 },
130 { STD_HEADER " [Test\x00Section] \n", ERROR_BAD_SECTION_NAME_LINE, 3, 0 },
133 static void test_invalid_files(void)
140 for (i = 0; i < sizeof(invalid_files)/sizeof(invalid_files[0]); i++)
142 SetLastError( 0xdeadbeef );
143 err_line = 0xdeadbeef;
144 hinf = test_file_contents( invalid_files[i].data, &err_line );
145 err = GetLastError();
146 trace( "hinf=%p err=0x%x line=%d\n", hinf, err, err_line );
147 if (invalid_files[i].error) /* should fail */
149 ok( hinf == INVALID_HANDLE_VALUE, "file %u: Open succeeded\n", i );
150 if (invalid_files[i].todo) todo_wine
152 ok( err == invalid_files[i].error, "file %u: Bad error %u/%u\n",
153 i, err, invalid_files[i].error );
154 ok( err_line == invalid_files[i].err_line, "file %u: Bad error line %d/%d\n",
155 i, err_line, invalid_files[i].err_line );
159 ok( err == invalid_files[i].error, "file %u: Bad error %u/%u\n",
160 i, err, invalid_files[i].error );
161 ok( err_line == invalid_files[i].err_line, "file %u: Bad error line %d/%d\n",
162 i, err_line, invalid_files[i].err_line );
165 else /* should succeed */
167 ok( hinf != INVALID_HANDLE_VALUE, "file %u: Open failed\n", i );
168 ok( err == 0, "file %u: Error code set to %u\n", i, err );
170 if (hinf != INVALID_HANDLE_VALUE) SetupCloseInfFile( hinf );
175 /* Test various section names */
184 /* file contents section name error code */
185 { STD_HEADER "[TestSection]", "TestSection", 0 },
186 { STD_HEADER "[TestSection]\n", "TestSection", 0 },
187 { STD_HEADER "[TESTSECTION]\r\n", "TestSection", 0 },
188 { STD_HEADER "[TestSection]\n[abc]", "testsection", 0 },
189 { STD_HEADER ";[TestSection]\n", "TestSection", ERROR_SECTION_NOT_FOUND },
190 { STD_HEADER "[TestSection]\n", "Bad name", ERROR_SECTION_NOT_FOUND },
192 { STD_HEADER "[TestSection] \r\n", "TestSection", 0 },
193 { STD_HEADER " [TestSection]\r\n", "TestSection", 0 },
194 { STD_HEADER " [TestSection] dummy\r\n", "TestSection", 0 },
195 { STD_HEADER " [TestSection] [foo]\r\n", "TestSection", 0 },
196 { STD_HEADER " [ Test Section ] dummy\r\n", " Test Section ", 0 },
197 { STD_HEADER "[TestSection] \032\ndummy", "TestSection", 0 },
198 { STD_HEADER "[TestSection] \n\032dummy", "TestSection", 0 },
199 /* special chars in section name */
200 { STD_HEADER "[Test[Section]\r\n", "Test[Section", 0 },
201 { STD_HEADER "[Test[S]ection]\r\n", "Test[S", 0 },
202 { STD_HEADER "[Test[[[Section]\r\n", "Test[[[Section", 0 },
203 { STD_HEADER "[]\r\n", "", 0 },
204 { STD_HEADER "[[[]\n", "[[", 0 },
205 { STD_HEADER "[Test\"Section]\r\n", "Test\"Section", 0 },
206 { STD_HEADER "[Test\\Section]\r\n", "Test\\Section", 0 },
207 { STD_HEADER "[Test\\ Section]\r\n", "Test\\ Section", 0 },
208 { STD_HEADER "[Test;Section]\r\n", "Test;Section", 0 },
209 /* various control chars */
210 { STD_HEADER " [Test\r\b\tSection] \n", "Test\r\b\tSection", 0 },
214 static void test_section_names(void)
222 for (i = 0; i < sizeof(section_names)/sizeof(section_names[0]); i++)
224 SetLastError( 0xdeadbeef );
225 hinf = test_file_contents( section_names[i].data, &err_line );
226 ok( hinf != INVALID_HANDLE_VALUE, "line %u: open failed err %u\n", i, GetLastError() );
227 if (hinf == INVALID_HANDLE_VALUE) continue;
229 ret = SetupGetLineCountA( hinf, section_names[i].section );
230 err = GetLastError();
231 trace( "hinf=%p ret=%d err=0x%x\n", hinf, ret, err );
234 ok( !section_names[i].error, "line %u: section name %s found\n",
235 i, section_names[i].section );
236 ok( !err, "line %u: bad error code %u\n", i, err );
240 ok( section_names[i].error, "line %u: section name %s not found\n",
241 i, section_names[i].section );
242 ok( err == section_names[i].error, "line %u: bad error %u/%u\n",
243 i, err, section_names[i].error );
245 SetupCloseInfFile( hinf );
250 /* Test various key and value names */
256 const char *fields[10];
259 /* file contents expected key expected fields */
260 { "ab=cd", "ab", { "cd" } },
261 { "ab=cd,ef,gh,ij", "ab", { "cd", "ef", "gh", "ij" } },
262 { "ab", "ab", { "ab" } },
263 { "ab,cd", NULL, { "ab", "cd" } },
264 { "ab,cd=ef", NULL, { "ab", "cd=ef" } },
265 { "=abcd,ef", "", { "abcd", "ef" } },
267 { "ba\\\ncd=ef", "bacd", { "ef" } },
268 { "ab \\ \ncd=ef", "abcd", { "ef" } },
269 { "ab\\\ncd,ef", NULL, { "abcd", "ef" } },
270 { "ab \\ ;cc\ncd=ef", "abcd", { "ef" } },
271 { "ab \\ \\ \ncd=ef", "abcd", { "ef" } },
272 { "ba \\ dc=xx", "ba \\ dc", { "xx" } },
273 { "ba \\\\ \nc=d", "bac", { "d" } },
274 { "a=b\\\\c", "a", { "b\\\\c" } },
275 { "ab=cd \\ ", "ab", { "cd" } },
276 { "ba=c \\ \n \\ \n a", "ba", { "ca" } },
277 { "ba=c \\ \n \\ a", "ba", { "c\\ a" } },
278 { " \\ a= \\ b", "\\ a", { "\\ b" } },
280 { "Ab\"Cd\"=Ef", "AbCd", { "Ef" } },
281 { "Ab\"Cd=Ef\"", "AbCd=Ef", { "AbCd=Ef" } },
282 { "ab\"\"\"cd,ef=gh\"", "ab\"cd,ef=gh", { "ab\"cd,ef=gh" } },
283 { "ab\"\"cd=ef", "abcd", { "ef" } },
284 { "ab\"\"cd=ef,gh", "abcd", { "ef", "gh" } },
285 { "ab=cd\"\"ef", "ab", { "cdef" } },
286 { "ab=cd\",\"ef", "ab", { "cd,ef" } },
287 { "ab=cd\",ef", "ab", { "cd,ef" } },
288 { "ab=cd\",ef\\\nab", "ab", { "cd,ef\\" } },
290 { " a b = c , d \n", "a b", { "c", "d" } },
291 { " a b = c ,\" d\" \n", "a b", { "c", " d" } },
292 { " a b\r = c\r\n", "a b", { "c" } },
294 { "a=b,,,c,,,d", "a", { "b", "", "", "c", "", "", "d" } },
295 { "a=b,\"\",c,\" \",d", "a", { "b", "", "c", " ", "d" } },
296 { "=,,b", "", { "", "", "b" } },
297 { ",=,,b", NULL, { "", "=", "", "b" } },
298 { "a=\n", "a", { "" } },
301 { "ab=c\032d", "ab", { "c" } },
302 { "ab\032=cd", "ab", { "ab" } },
304 { "abcd=ef\x0gh", "abcd", { "ef" } },
305 /* multiple sections with same name */
306 { "[Test2]\nab\n[Test]\nee=ff\n", "ee", { "ff" } },
307 /* string substitution */
308 { "%foo%=%bar%\n" STR_SECTION, "aaa", { "bbb" } },
309 { "%foo%xx=%bar%yy\n" STR_SECTION, "aaaxx", { "bbbyy" } },
310 { "%% %foo%=%bar%\n" STR_SECTION, "% aaa", { "bbb" } },
311 { "%f\"o\"o%=ccc\n" STR_SECTION, "aaa", { "ccc" } },
312 { "abc=%bar;bla%\n" STR_SECTION, "abc", { "%bar" } },
313 { "loop=%loop%\n" STR_SECTION, "loop", { "%loop2%" } },
314 { "%per%%cent%=100\n" STR_SECTION, "12", { "100" } },
315 { "a=%big%\n" STR_SECTION, "a", { A400 } },
316 { "a=%verybig%\n" STR_SECTION, "a", { A511 } }, /* truncated to 511 */
317 { "a=%big%%big%%big%%big%\n" STR_SECTION, "a", { A400 A400 A400 A400 } },
318 { "a=%big%%big%%big%%big%%big%%big%%big%%big%%big%\n" STR_SECTION, "a", { A400 A400 A400 A400 A400 A400 A400 A400 A400 } },
319 { "a=%big%%big%%big%%big%%big%%big%%big%%big%%big%%big%%big%\n" STR_SECTION, "a", { A4097 /*MAX_INF_STRING_LENGTH+1*/ } },
322 /* check the key of a certain line */
323 static const char *check_key( INFCONTEXT *context, const char *wanted )
325 const char *key = get_string_field( context, 0 );
326 DWORD err = GetLastError();
330 ok( !wanted, "missing key %s\n", wanted );
331 ok( err == 0 || err == ERROR_INVALID_PARAMETER, "last error set to %u\n", err );
335 ok( !strcmp( key, wanted ), "bad key %s/%s\n", key, wanted );
336 ok( err == 0, "last error set to %u\n", err );
341 static void test_key_names(void)
343 char buffer[MAX_INF_STRING_LENGTH+32];
344 const char *key, *line;
345 unsigned int i, index, count;
352 for (i = 0; i < sizeof(key_names)/sizeof(key_names[0]); i++)
354 strcpy( buffer, STD_HEADER "[Test]\n" );
355 strcat( buffer, key_names[i].data );
356 SetLastError( 0xdeadbeef );
357 hinf = test_file_contents( buffer, &err_line );
358 ok( hinf != INVALID_HANDLE_VALUE, "line %u: open failed err %u\n", i, GetLastError() );
359 if (hinf == INVALID_HANDLE_VALUE) continue;
361 ret = SetupFindFirstLineA( hinf, "Test", 0, &context );
364 key = check_key( &context, key_names[i].key );
366 buffer[0] = buffer[1] = 0; /* build the full line */
367 for (index = 0; ; index++)
369 const char *field = get_string_field( &context, index + 1 );
370 err = GetLastError();
373 ok( err == 0, "line %u: bad error %u\n", i, err );
374 if (key_names[i].fields[index])
375 ok( !strcmp( field, key_names[i].fields[index] ), "line %u: bad field %s/%s\n",
376 i, field, key_names[i].fields[index] );
378 ok( 0, "line %u: got extra field %s\n", i, field );
379 strcat( buffer, "," );
380 strcat( buffer, field );
384 ok( err == 0 || err == ERROR_INVALID_PARAMETER,
385 "line %u: bad error %u\n", i, err );
386 if (key_names[i].fields[index])
387 ok( 0, "line %u: missing field %s\n", i, key_names[i].fields[index] );
389 if (!key_names[i].fields[index]) break;
391 count = SetupGetFieldCount( &context );
392 ok( count == index, "line %u: bad count %d/%d\n", i, index, count );
394 line = get_line_text( &context );
395 ok( line != NULL, "line %u: SetupGetLineText failed\n", i );
396 if (line) ok( !strcmp( line, buffer+1 ), "line %u: bad text %s/%s\n", i, line, buffer+1 );
398 SetupCloseInfFile( hinf );
403 static void test_close_inf_file(void)
405 SetLastError(0xdeadbeef);
406 SetupCloseInfFile(NULL);
407 ok(GetLastError() == 0xdeadbeef, "Expected 0xdeadbeef, got %u\n", GetLastError());
409 SetLastError(0xdeadbeef);
410 SetupCloseInfFile(INVALID_HANDLE_VALUE);
411 ok(GetLastError() == 0xdeadbeef, "Expected 0xdeadbeef, got %u\n", GetLastError());
415 static const char *contents = "[Version]\n"
416 "Signature=\"$Windows NT$\"\n"
417 "FileVersion=5.1.1.2\n"
419 "RTMQFE=\"%RTMGFE_NAME%\",SP1RTM,"A4097"\n"
421 "RTMQFE_NAME = \"RTMQFE\"\n";
423 static const WCHAR getfield_res[][20] =
425 {'R','T','M','Q','F','E',0},
426 {'%','R','T','M','G','F','E','_','N','A','M','E','%',0},
427 {'S','P','1','R','T','M',0},
430 static void test_pSetupGetField(void)
439 hinf = test_file_contents( contents, &err );
440 ok( hinf != NULL, "Expected valid INF file\n" );
442 ret = SetupFindFirstLine( hinf, "FileBranchInfo", NULL, &context );
443 ok( ret, "Failed to find first line\n" );
445 /* native Windows crashes if a NULL context is sent in */
447 for ( i = 0; i < 3; i++ )
449 field = pSetupGetField( &context, i );
450 ok( field != NULL, "Failed to get field %i\n", i );
451 ok( !lstrcmpW( getfield_res[i], field ), "Wrong string returned\n" );
453 ret = HeapFree( GetProcessHeap(), 0, (LPVOID)field );
454 ok( !ret, "Expected HeapFree to fail\n" );
455 ok( GetLastError() == ERROR_INVALID_PARAMETER,
456 "Expected ERROR_INVALID_PARAMETER, got %u\n", GetLastError() );
459 field = pSetupGetField( &context, 3 );
460 ok( field != NULL, "Failed to get field 3\n" );
461 ok( lstrlenW( field ) == 511, "Expected 511, got %d\n", lstrlenW( field ) );
463 field = pSetupGetField( &context, 4 );
464 ok( field == NULL, "Expected NULL, got %p\n", field );
465 ok( GetLastError() == ERROR_INVALID_PARAMETER,
466 "Expected ERROR_INVALID_PARAMETER, got %u\n", GetLastError() );
468 SetupCloseInfFile( hinf );
473 init_function_pointers();
474 test_invalid_files();
475 test_section_names();
477 test_close_inf_file();
478 test_pSetupGetField();
479 DeleteFileA( tmpfile );