1 /* Unit test suite for SHLWAPI Compact List and IStream ordinal functions
3 * Copyright 2002 Jon Griffiths
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #include "wine/test.h"
27 typedef struct tagSHLWAPI_CLIST
31 } SHLWAPI_CLIST, *LPSHLWAPI_CLIST;
33 typedef const SHLWAPI_CLIST* LPCSHLWAPI_CLIST;
36 static const SHLWAPI_CLIST SHLWAPI_CLIST_items[] =
52 /* Dummy IStream object for testing calls */
68 LPCSHLWAPI_CLIST item;
73 HRESULT WINAPI QueryInterface(_IDummyStream *This,REFIID riid, LPVOID *ppvObj)
78 static ULONG WINAPI AddRef(_IDummyStream *This)
80 return InterlockedIncrement(&This->ref);
83 static ULONG WINAPI Release(_IDummyStream *This)
85 return InterlockedDecrement(&This->ref);
88 static HRESULT WINAPI Read(_IDummyStream* This, LPVOID lpMem, ULONG ulSize,
94 if (This->failreadcall)
96 return STG_E_ACCESSDENIED;
98 else if (This->failreadsize)
100 *lpRead = ulSize + 8;
103 else if (This->readreturnlarge)
105 *((ULONG*)lpMem) = 0xffff01;
107 This->readreturnlarge = FALSE;
110 if (ulSize == sizeof(ULONG))
112 /* Read size of item */
113 *((ULONG*)lpMem) = This->item->ulSize ? This->item->ulSize + sizeof(SHLWAPI_CLIST) : 0;
119 char* buff = (char*)lpMem;
122 if (!This->item->ulSize)
124 This->readbeyondend = TRUE;
126 return E_FAIL; /* Should never happen */
128 *((ULONG*)lpMem) = This->item->ulId;
131 for (i = 0; i < This->item->ulSize; i++)
139 static HRESULT WINAPI Write(_IDummyStream* This, LPVOID lpMem, ULONG ulSize,
145 if (This->failwritecall)
147 return STG_E_ACCESSDENIED;
149 else if (This->failwritesize)
158 static HRESULT WINAPI Seek(_IDummyStream* This, LARGE_INTEGER dlibMove,
159 DWORD dwOrigin, ULARGE_INTEGER* plibNewPosition)
162 This->pos.QuadPart = dlibMove.QuadPart;
164 plibNewPosition->QuadPart = dlibMove.QuadPart;
168 static HRESULT WINAPI Stat(_IDummyStream* This, STATSTG* pstatstg,
172 if (This->failstatcall)
175 pstatstg->cbSize.QuadPart = This->pos.QuadPart;
180 static void* iclvt[] =
192 NULL, /* LockRegion */
193 NULL, /* UnlockRegion */
198 /* Function ptrs for ordinal calls */
199 static HMODULE SHLWAPI_hshlwapi = 0;
201 static VOID (WINAPI *pSHLWAPI_19)(LPSHLWAPI_CLIST);
202 static HRESULT (WINAPI *pSHLWAPI_20)(LPSHLWAPI_CLIST*,LPCSHLWAPI_CLIST);
203 static BOOL (WINAPI *pSHLWAPI_21)(LPSHLWAPI_CLIST*,ULONG);
204 static LPSHLWAPI_CLIST (WINAPI *pSHLWAPI_22)(LPSHLWAPI_CLIST,ULONG);
205 static HRESULT (WINAPI *pSHLWAPI_17)(_IDummyStream*,LPSHLWAPI_CLIST);
206 static HRESULT (WINAPI *pSHLWAPI_18)(_IDummyStream*,LPSHLWAPI_CLIST*);
208 static BOOL (WINAPI *pSHLWAPI_166)(_IDummyStream*);
209 static HRESULT (WINAPI *pSHLWAPI_184)(_IDummyStream*,LPVOID,ULONG);
210 static HRESULT (WINAPI *pSHLWAPI_212)(_IDummyStream*,LPCVOID,ULONG);
211 static HRESULT (WINAPI *pSHLWAPI_213)(_IDummyStream*);
212 static HRESULT (WINAPI *pSHLWAPI_214)(_IDummyStream*,ULARGE_INTEGER*);
215 static void InitFunctionPtrs(void)
217 SHLWAPI_hshlwapi = GetModuleHandleA("shlwapi.dll");
219 pSHLWAPI_17 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)17);
220 ok(pSHLWAPI_17 != 0, "No Ordinal 17\n");
221 pSHLWAPI_18 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)18);
222 ok(pSHLWAPI_18 != 0, "No Ordinal 18\n");
223 pSHLWAPI_19 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)19);
224 ok(pSHLWAPI_19 != 0, "No Ordinal 19\n");
225 pSHLWAPI_20 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)20);
226 ok(pSHLWAPI_20 != 0, "No Ordinal 20\n");
227 pSHLWAPI_21 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)21);
228 ok(pSHLWAPI_21 != 0, "No Ordinal 21\n");
229 pSHLWAPI_22 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)22);
230 ok(pSHLWAPI_22 != 0, "No Ordinal 22\n");
231 pSHLWAPI_166 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)166);
232 ok(pSHLWAPI_166 != 0, "No Ordinal 166\n");
233 pSHLWAPI_184 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)184);
234 ok(pSHLWAPI_184 != 0, "No Ordinal 184\n");
235 pSHLWAPI_212 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)212);
236 ok(pSHLWAPI_212 != 0, "No Ordinal 212\n");
237 pSHLWAPI_213 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)213);
238 ok(pSHLWAPI_213 != 0, "No Ordinal 213\n");
239 pSHLWAPI_214 = (void *)GetProcAddress( SHLWAPI_hshlwapi, (LPSTR)214);
240 ok(pSHLWAPI_214 != 0, "No Ordinal 214\n");
243 static void InitDummyStream(_IDummyStream* iface)
245 iface->lpVtbl = (void*)iclvt;
247 iface->readcalls = 0;
248 iface->failreadcall = FALSE;
249 iface->failreadsize = FALSE;
250 iface->readbeyondend = FALSE;
251 iface->readreturnlarge = FALSE;
252 iface->writecalls = 0;
253 iface->failwritecall = FALSE;
254 iface->failwritesize = FALSE;
255 iface->seekcalls = 0;
256 iface->statcalls = 0;
257 iface->failstatcall = FALSE;
258 iface->item = SHLWAPI_CLIST_items;
259 iface->pos.QuadPart = 0;
263 static void test_CList(void)
265 _IDummyStream streamobj;
266 LPSHLWAPI_CLIST list = NULL;
267 LPCSHLWAPI_CLIST item = SHLWAPI_CLIST_items;
269 LPSHLWAPI_CLIST inserted;
273 if (!pSHLWAPI_17 || !pSHLWAPI_18 || !pSHLWAPI_19 || !pSHLWAPI_20 ||
274 !pSHLWAPI_21 || !pSHLWAPI_22)
277 /* Populate a list and test the items are added correctly */
280 /* Create item and fill with data */
281 inserted = (LPSHLWAPI_CLIST)buff;
282 inserted->ulSize = item->ulSize + sizeof(SHLWAPI_CLIST);
283 inserted->ulId = item->ulId;
284 for (i = 0; i < item->ulSize; i++)
285 buff[sizeof(SHLWAPI_CLIST)+i] = i*2;
288 hRet = pSHLWAPI_20(&list, inserted);
289 ok(hRet > S_OK, "failed list add\n");
293 ok(list && list->ulSize, "item not added\n");
296 inserted = pSHLWAPI_22(list, item->ulId);
297 ok(inserted != NULL, "lost after adding\n");
299 ok(!inserted || inserted->ulId != ~0U, "find returned a container\n");
302 if (inserted && inserted->ulSize & 0x3)
305 ok(inserted[-1].ulId == ~0U, "invalid size is not countained\n");
306 ok(inserted[-1].ulSize > inserted->ulSize+sizeof(SHLWAPI_CLIST),
307 "container too small\n");
311 ok(inserted->ulSize==item->ulSize+sizeof(SHLWAPI_CLIST),
312 "id %d wrong size %d\n", inserted->ulId, inserted->ulSize);
317 LPBYTE bufftest = (LPBYTE)inserted;
319 for (i = 0; i < inserted->ulSize - sizeof(SHLWAPI_CLIST); i++)
320 if (bufftest[sizeof(SHLWAPI_CLIST)+i] != i*2)
323 ok(bDataOK == TRUE, "data corrupted on insert\n");
325 ok(!inserted || inserted->ulId==item->ulId, "find got wrong item\n");
331 InitDummyStream(&streamobj);
333 hRet = pSHLWAPI_17(&streamobj, list);
334 ok(hRet == S_OK, "write failed\n");
337 /* 1 call for each element, + 1 for OK (use our null element for this) */
338 ok(streamobj.writecalls == sizeof(SHLWAPI_CLIST_items)/sizeof(SHLWAPI_CLIST),
339 "wrong call count\n");
340 ok(streamobj.readcalls == 0,"called Read() in write\n");
341 ok(streamobj.seekcalls == 0,"called Seek() in write\n");
344 /* Failure cases for writing */
345 InitDummyStream(&streamobj);
346 streamobj.failwritecall = TRUE;
347 hRet = pSHLWAPI_17(&streamobj, list);
348 ok(hRet == STG_E_ACCESSDENIED, "changed object failure return\n");
349 ok(streamobj.writecalls == 1, "called object after failure\n");
350 ok(streamobj.readcalls == 0,"called Read() after failure\n");
351 ok(streamobj.seekcalls == 0,"called Seek() after failure\n");
353 InitDummyStream(&streamobj);
354 streamobj.failwritesize = TRUE;
355 hRet = pSHLWAPI_17(&streamobj, list);
356 ok(hRet == STG_E_MEDIUMFULL, "changed size failure return\n");
357 ok(streamobj.writecalls == 1, "called object after size failure\n");
358 ok(streamobj.readcalls == 0,"called Read() after failure\n");
359 ok(streamobj.seekcalls == 0,"called Seek() after failure\n");
361 /* Invalid inputs for adding */
362 inserted = (LPSHLWAPI_CLIST)buff;
363 inserted->ulSize = sizeof(SHLWAPI_CLIST) -1;
365 hRet = pSHLWAPI_20(&list, inserted);
366 /* The call succeeds but the item is not inserted, except on some early
367 * versions which return failure. Wine behaves like later versions.
371 ok(hRet == S_OK, "failed bad element size\n");
373 inserted = pSHLWAPI_22(list, 33);
374 ok(inserted == NULL, "inserted bad element size\n");
376 inserted = (LPSHLWAPI_CLIST)buff;
377 inserted->ulSize = 44;
378 inserted->ulId = ~0U;
379 hRet = pSHLWAPI_20(&list, inserted);
380 /* See comment above, some early versions fail this call */
383 ok(hRet == S_OK, "failed adding a container\n");
385 item = SHLWAPI_CLIST_items;
387 /* Look for nonexistent item in populated list */
388 inserted = pSHLWAPI_22(list, 99999999);
389 ok(inserted == NULL, "found a nonexistent item\n");
394 BOOL bRet = pSHLWAPI_21(&list, item->ulId);
395 ok(bRet == TRUE, "couldn't find item to delete\n");
399 /* Look for nonexistent item in empty list */
400 inserted = pSHLWAPI_22(list, 99999999);
401 ok(inserted == NULL, "found an item in empty list\n");
403 /* Create a list by reading in data */
404 InitDummyStream(&streamobj);
406 hRet = pSHLWAPI_18(&streamobj, &list);
407 ok(hRet == S_OK, "failed create from Read()\n");
410 ok(streamobj.readbeyondend == FALSE, "read beyond end\n");
411 /* 2 calls per item, but only 1 for the terminator */
412 ok(streamobj.readcalls == sizeof(SHLWAPI_CLIST_items)/sizeof(SHLWAPI_CLIST)*2-1,
413 "wrong call count\n");
414 ok(streamobj.writecalls == 0, "called Write() from create\n");
415 ok(streamobj.seekcalls == 0,"called Seek() from create\n");
417 item = SHLWAPI_CLIST_items;
419 /* Check the items were added correctly */
422 inserted = pSHLWAPI_22(list, item->ulId);
423 ok(inserted != NULL, "lost after adding\n");
425 ok(!inserted || inserted->ulId != ~0U, "find returned a container\n");
428 if (inserted && inserted->ulSize & 0x3)
431 ok(inserted[-1].ulId == ~0U, "invalid size is not countained\n");
432 ok(inserted[-1].ulSize > inserted->ulSize+sizeof(SHLWAPI_CLIST),
433 "container too small\n");
437 ok(inserted->ulSize==item->ulSize+sizeof(SHLWAPI_CLIST),
438 "id %d wrong size %d\n", inserted->ulId, inserted->ulSize);
440 ok(!inserted || inserted->ulId==item->ulId, "find got wrong item\n");
444 LPBYTE bufftest = (LPBYTE)inserted;
446 for (i = 0; i < inserted->ulSize - sizeof(SHLWAPI_CLIST); i++)
447 if (bufftest[sizeof(SHLWAPI_CLIST)+i] != i*2)
450 ok(bDataOK == TRUE, "data corrupted on insert\n");
456 /* Failure cases for reading */
457 InitDummyStream(&streamobj);
458 streamobj.failreadcall = TRUE;
459 hRet = pSHLWAPI_18(&streamobj, &list);
460 ok(hRet == STG_E_ACCESSDENIED, "changed object failure return\n");
461 ok(streamobj.readbeyondend == FALSE, "read beyond end\n");
462 ok(streamobj.readcalls == 1, "called object after read failure\n");
463 ok(streamobj.writecalls == 0,"called Write() after read failure\n");
464 ok(streamobj.seekcalls == 0,"called Seek() after read failure\n");
466 /* Read returns large object */
467 InitDummyStream(&streamobj);
468 streamobj.readreturnlarge = TRUE;
469 hRet = pSHLWAPI_18(&streamobj, &list);
470 ok(hRet == S_OK, "failed create from Read() with large item\n");
471 ok(streamobj.readbeyondend == FALSE, "read beyond end\n");
472 ok(streamobj.readcalls == 1,"wrong call count\n");
473 ok(streamobj.writecalls == 0,"called Write() after read failure\n");
474 ok(streamobj.seekcalls == 2,"wrong Seek() call count (%d)\n", streamobj.seekcalls);
479 static BOOL test_SHLWAPI_166(void)
481 _IDummyStream streamobj;
487 InitDummyStream(&streamobj);
488 bRet = pSHLWAPI_166(&streamobj);
491 return FALSE; /* This version doesn't support stream ops on clists */
493 ok(streamobj.readcalls == 0, "called Read()\n");
494 ok(streamobj.writecalls == 0, "called Write()\n");
495 ok(streamobj.seekcalls == 0, "called Seek()\n");
496 ok(streamobj.statcalls == 1, "wrong call count\n");
498 streamobj.statcalls = 0;
499 streamobj.pos.QuadPart = 50001;
501 bRet = pSHLWAPI_166(&streamobj);
503 ok(bRet == FALSE, "failed after seek adjusted\n");
504 ok(streamobj.readcalls == 0, "called Read()\n");
505 ok(streamobj.writecalls == 0, "called Write()\n");
506 ok(streamobj.seekcalls == 0, "called Seek()\n");
507 ok(streamobj.statcalls == 1, "wrong call count\n");
510 InitDummyStream(&streamobj);
511 streamobj.pos.QuadPart = 50001;
512 streamobj.failstatcall = TRUE; /* 1: Stat() Bad, Read() OK */
513 bRet = pSHLWAPI_166(&streamobj);
514 ok(bRet == FALSE, "should be FALSE after read is OK\n");
515 ok(streamobj.readcalls == 1, "wrong call count\n");
516 ok(streamobj.writecalls == 0, "called Write()\n");
517 ok(streamobj.seekcalls == 1, "wrong call count\n");
518 ok(streamobj.statcalls == 1, "wrong call count\n");
519 ok(streamobj.pos.QuadPart == 0, "Didn't seek to start\n");
521 InitDummyStream(&streamobj);
522 streamobj.pos.QuadPart = 50001;
523 streamobj.failstatcall = TRUE;
524 streamobj.failreadcall = TRUE; /* 2: Stat() Bad, Read() Bad Also */
525 bRet = pSHLWAPI_166(&streamobj);
526 ok(bRet == TRUE, "Should be true after read fails\n");
527 ok(streamobj.readcalls == 1, "wrong call count\n");
528 ok(streamobj.writecalls == 0, "called Write()\n");
529 ok(streamobj.seekcalls == 0, "Called Seek()\n");
530 ok(streamobj.statcalls == 1, "wrong call count\n");
531 ok(streamobj.pos.QuadPart == 50001, "called Seek() after read failed\n");
535 static void test_SHLWAPI_184(void)
537 _IDummyStream streamobj;
544 InitDummyStream(&streamobj);
545 hRet = pSHLWAPI_184(&streamobj, buff, sizeof(buff));
547 ok(hRet == S_OK, "failed Read()\n");
548 ok(streamobj.readcalls == 1, "wrong call count\n");
549 ok(streamobj.writecalls == 0, "called Write()\n");
550 ok(streamobj.seekcalls == 0, "called Seek()\n");
553 static void test_SHLWAPI_212(void)
555 _IDummyStream streamobj;
562 InitDummyStream(&streamobj);
563 hRet = pSHLWAPI_212(&streamobj, buff, sizeof(buff));
565 ok(hRet == S_OK, "failed Write()\n");
566 ok(streamobj.readcalls == 0, "called Read()\n");
567 ok(streamobj.writecalls == 1, "wrong call count\n");
568 ok(streamobj.seekcalls == 0, "called Seek()\n");
571 static void test_SHLWAPI_213(void)
573 _IDummyStream streamobj;
578 if (!pSHLWAPI_213 || !pSHLWAPI_214)
581 InitDummyStream(&streamobj);
583 Seek(&streamobj, ll, 0, NULL); /* Seek to 5000l */
585 streamobj.seekcalls = 0;
586 pSHLWAPI_213(&streamobj); /* Should rewind */
587 ok(streamobj.statcalls == 0, "called Stat()\n");
588 ok(streamobj.readcalls == 0, "called Read()\n");
589 ok(streamobj.writecalls == 0, "called Write()\n");
590 ok(streamobj.seekcalls == 1, "wrong call count\n");
593 hRet = pSHLWAPI_214(&streamobj, &ul);
594 ok(hRet == S_OK, "failed Stat()\n");
595 ok(ul.QuadPart == 0, "213 didn't rewind stream\n");
598 static void test_SHLWAPI_214(void)
600 _IDummyStream streamobj;
608 InitDummyStream(&streamobj);
610 Seek(&streamobj, ll, 0, NULL);
612 streamobj.seekcalls = 0;
613 hRet = pSHLWAPI_214(&streamobj, &ul);
615 ok(hRet == S_OK, "failed Stat()\n");
616 ok(streamobj.statcalls == 1, "wrong call count\n");
617 ok(streamobj.readcalls == 0, "called Read()\n");
618 ok(streamobj.writecalls == 0, "called Write()\n");
619 ok(streamobj.seekcalls == 0, "called Seek()\n");
620 ok(ul.QuadPart == 5000l, "Stat gave wrong size\n");
629 /* Test streaming if this version supports it */
630 if (test_SHLWAPI_166())