dlls/twain_32/tests/dsm.c

   1 /* Unit test suite for Twain DSM functions
   2  *
   3  * Copyright 2009 Jeremy White, CodeWeavers, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  */
  20 #include <stdarg.h>
  21 #include <assert.h>
  22 #include "windef.h"
  23 #include "winbase.h"
  24 #include "wingdi.h"
  25 #include "winerror.h"
  26 #include "winuser.h"
  27 #include "twain.h"
  28
  29 #include "wine/test.h"
  30
  31 static DSMENTRYPROC pDSM_Entry;
  32
  33 static BOOL dsm_RegisterWindowClasses(void)
  34 {
  35     WNDCLASSA cls;
  36
  37     cls.style = 0;
  38     cls.lpfnWndProc = DefWindowProc;
  39     cls.cbClsExtra = 0;
  40     cls.cbWndExtra = 0;
  41     cls.hInstance = GetModuleHandleA(0);
  42     cls.hIcon = 0;
  43     cls.hCursor = LoadCursorA(0, IDC_ARROW);
  44     cls.hbrBackground = GetStockObject(WHITE_BRUSH);
  45     cls.lpszMenuName = NULL;
  46     cls.lpszClassName = "TWAIN_dsm_class";
  47     if (!RegisterClassA(&cls)) return FALSE;
  48
  49     return TRUE;
  50 }
  51
  52
  53 static void get_condition_code(TW_IDENTITY *appid, TW_IDENTITY *source, TW_STATUS *status)
  54 {
  55     TW_UINT16 rc;
  56     rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_STATUS, MSG_GET, status);
  57     ok(rc == TWRC_SUCCESS, "Condition code not available, rc %d\n", rc);
  58 }
  59
  60 static BOOL get_onevalue(TW_HANDLE hcontainer, TW_UINT32 *ret, TW_UINT16 *type)
  61 {
  62     TW_ONEVALUE *onev;
  63     onev = GlobalLock(hcontainer);
  64     if (onev)
  65     {
  66         *ret = onev->Item;
  67         if (type)
  68             *type = onev->ItemType;
  69         GlobalUnlock(hcontainer);
  70         return TRUE;
  71     }
  72     return FALSE;
  73 }
  74
  75 static TW_HANDLE alloc_and_set_onevalue(TW_UINT32 val, TW_UINT16 type)
  76 {
  77     TW_HANDLE hcontainer;
  78     TW_ONEVALUE *onev;
  79     hcontainer = GlobalAlloc(0, sizeof(*onev));
  80     if (hcontainer)
  81     {
  82         onev = GlobalLock(hcontainer);
  83         if (onev)
  84         {
  85             onev->ItemType = type;
  86             onev->Item = val;
  87             GlobalUnlock(hcontainer);
  88         }
  89         else
  90         {
  91             GlobalFree(hcontainer);
  92             hcontainer = 0;
  93         }
  94     }
  95     return hcontainer;
  96 }
  97
  98 static void check_get(TW_CAPABILITY *pCapability,
  99                 TW_UINT32 orig_value, TW_UINT32 default_value, TW_UINT32 *suggested_set_value)
 100 {
 101     void *p;
 102     if (suggested_set_value)
 103         *suggested_set_value = orig_value + 1;
 104     p = GlobalLock(pCapability->hContainer);
 105     if (p)
 106     {
 107         if (pCapability->ConType == TWON_ONEVALUE)
 108         {
 109             TW_ONEVALUE *onev = (TW_ONEVALUE *) p;
 110             ok(onev->Item == orig_value, "MSG_GET of 0x%x returned 0x%x, expecting 0x%x\n",
 111                 pCapability->Cap, onev->Item, orig_value);
 112         }
 113         else if (pCapability->ConType == TWON_ENUMERATION)
 114         {
 115             int i;
 116             TW_UINT8 *p8;
 117             TW_UINT16 *p16;
 118             TW_UINT32 *p32;
 119             TW_ENUMERATION *enumv = (TW_ENUMERATION *) p;
 120             p8 = enumv->ItemList;
 121             p16 = (TW_UINT16 *) p8;
 122             p32 = (TW_UINT32 *) p8;
 123             trace("MSG_GET of 0x%x returned %d items:\n", pCapability->Cap, enumv->NumItems);
 124             for (i = 0; i < enumv->NumItems; i++)
 125             {
 126                 if (enumv->ItemType == TWTY_UINT8 || enumv->ItemType == TWTY_INT8)
 127                     trace("  %d: 0x%x\n", i, p8[i]);
 128                 if (enumv->ItemType == TWTY_UINT16 || enumv->ItemType == TWTY_INT16)
 129                     trace("  %d: 0x%x\n", i, p16[i]);
 130                 if (enumv->ItemType == TWTY_UINT32 || enumv->ItemType == TWTY_INT32)
 131                     trace("  %d: 0x%x\n", i, p32[i]);
 132             }
 133             if (enumv->ItemType == TWTY_UINT16 || enumv->ItemType == TWTY_INT16)
 134             {
 135                 ok(p16[enumv->CurrentIndex] == orig_value,
 136                     "Type 0x%x, values from MSG_GET (0x%x) and MSG_GETCURRENT (0x%x) do not match.\n",
 137                     pCapability->Cap, p16[enumv->CurrentIndex], orig_value);
 138                 ok(p16[enumv->DefaultIndex] == default_value,
 139                     "Type 0x%x, values from MSG_GET (0x%x) and MSG_GETDEFAULT (0x%x) do not match.\n",
 140                     pCapability->Cap, p16[enumv->DefaultIndex], default_value);
 141                 if (suggested_set_value)
 142                     *suggested_set_value = p16[(enumv->CurrentIndex + 1) % enumv->NumItems];
 143             }
 144             if (enumv->ItemType == TWTY_UINT32 || enumv->ItemType == TWTY_INT32)
 145             {
 146                 ok(p32[enumv->CurrentIndex] == orig_value,
 147                     "Type 0x%x, values from MSG_GET (0x%x) and MSG_GETCURRENT (0x%x) do not match.\n",
 148                     pCapability->Cap, p32[enumv->CurrentIndex], orig_value);
 149                 ok(p32[enumv->DefaultIndex] == default_value,
 150                     "Type 0x%x, values from MSG_GET (0x%x) and MSG_GETDEFAULT (0x%x) do not match.\n",
 151                     pCapability->Cap, p32[enumv->DefaultIndex], default_value);
 152                 if (suggested_set_value)
 153                     *suggested_set_value = p32[(enumv->CurrentIndex + 1) % enumv->NumItems];
 154             }
 155         }
 156         else
 157             trace("MSG_GET on type 0x%x returned type 0x%x, which we didn't check.\n", pCapability->Cap, pCapability->ConType);
 158         GlobalUnlock(pCapability->hContainer);
 159     }
 160 }
 161
 162 static void test_onevalue_cap(TW_IDENTITY *appid, TW_IDENTITY *source, TW_UINT16 captype, TW_UINT16 type, TW_INT32 expected_support)
 163 {
 164     TW_UINT16 rc;
 165     TW_UINT16 rtype;
 166     TW_STATUS status;
 167     TW_CAPABILITY cap;
 168     TW_UINT32 orig_value = 0;
 169     TW_UINT32 new_value;
 170     TW_UINT32 default_value = 0;
 171     TW_INT32 actual_support;
 172
 173     memset(&cap, 0, sizeof(cap));
 174     cap.Cap = captype;
 175     cap.ConType = TWON_DONTCARE16;
 176
 177     rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_QUERYSUPPORT, &cap);
 178     get_condition_code(appid, source, &status);
 179     ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 180             "Error [rc %d|cc %d] doing MSG_QUERYSUPPORT for type 0x%x\n", rc, status.ConditionCode, captype);
 181     if (rc != TWRC_SUCCESS)
 182         return;
 183     ok(get_onevalue(cap.hContainer, (TW_UINT32 *) &actual_support, NULL), "Returned cap.hContainer invalid for QuerySupport on type 0x%x\n", captype);
 184     ok(actual_support == expected_support,
 185             "Error:  expected support 0x%x for type 0x%x, got 0x%x\n", expected_support,
 186             captype, actual_support);
 187
 188
 189     if (actual_support & TWQC_GETCURRENT)
 190     {
 191         memset(&cap, 0, sizeof(cap));
 192         cap.Cap = captype;
 193         cap.ConType = TWON_DONTCARE16;
 194
 195         rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_GETCURRENT, &cap);
 196         get_condition_code(appid, source, &status);
 197         ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 198                 "Error [rc %d|cc %d] doing MSG_GETCURRENT for type 0x%x\n", rc, status.ConditionCode, captype);
 199         if (rc == TWRC_SUCCESS)
 200         {
 201             ok(get_onevalue(cap.hContainer, &orig_value, &rtype), "Returned cap.hContainer invalid for GETCURRENT on type 0x%x\n", captype);
 202             ok(rtype == type, "Returned GETCURRENT type 0x%x for cap 0x%x is not expected 0x%x\n", rtype, captype, type);
 203             GlobalFree(cap.hContainer);
 204         }
 205     }
 206
 207     if (actual_support & TWQC_GETDEFAULT)
 208     {
 209         memset(&cap, 0, sizeof(cap));
 210         cap.Cap = captype;
 211         cap.ConType = TWON_DONTCARE16;
 212
 213         rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_GETDEFAULT, &cap);
 214         get_condition_code(appid, source, &status);
 215         ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 216                 "Error [rc %d|cc %d] doing MSG_GETDEFAULT for type 0x%x\n", rc, status.ConditionCode, captype);
 217         if (rc == TWRC_SUCCESS)
 218         {
 219             ok(get_onevalue(cap.hContainer, &default_value, &rtype), "Returned cap.hContainer invalid for GETDEFAULT on type 0x%x\n", captype);
 220             ok(rtype == type, "Returned GETDEFAULT type 0x%x for cap 0x%x is not expected 0x%x\n", rtype, captype, type);
 221             GlobalFree(cap.hContainer);
 222         }
 223     }
 224
 225     new_value = orig_value;
 226     if (actual_support & TWQC_GET)
 227     {
 228         memset(&cap, 0, sizeof(cap));
 229         cap.Cap = captype;
 230         cap.ConType = TWON_DONTCARE16;
 231
 232         rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_GET, &cap);
 233         get_condition_code(appid, source, &status);
 234         ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 235                 "Error [rc %d|cc %d] doing MSG_GET for type 0x%x\n", rc, status.ConditionCode, captype);
 236         check_get(&cap, orig_value, default_value, &new_value);
 237         if (rc == TWRC_SUCCESS)
 238             GlobalFree(cap.hContainer);
 239     }
 240
 241     if (actual_support & TWQC_SET)
 242     {
 243         memset(&cap, 0, sizeof(cap));
 244         cap.Cap = captype;
 245         cap.ConType = TWON_ONEVALUE;
 246         cap.hContainer = alloc_and_set_onevalue(new_value, type);
 247
 248         rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_SET, &cap);
 249         get_condition_code(appid, source, &status);
 250         ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 251                 "Error [rc %d|cc %d] doing MSG_SET for type 0x%x\n", rc, status.ConditionCode, captype);
 252         GlobalFree(cap.hContainer);
 253     }
 254
 255     if (actual_support & TWQC_RESET)
 256     {
 257         memset(&cap, 0, sizeof(cap));
 258         cap.Cap = captype;
 259         cap.ConType = TWON_DONTCARE16;
 260
 261         rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_RESET, &cap);
 262         get_condition_code(appid, source, &status);
 263         ok(rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS,
 264                 "Error [rc %d|cc %d] doing MSG_RESET for type 0x%x\n", rc, status.ConditionCode, captype);
 265         if (rc == TWRC_SUCCESS)
 266             GlobalFree(cap.hContainer);
 267     }
 268 }
 269
 270
 271 static void test_single_source(TW_IDENTITY *appid, TW_IDENTITY *source)
 272 {
 273     TW_UINT16 rc;
 274     TW_STATUS status;
 275     TW_CAPABILITY cap;
 276     UINT16 capabilities[CAP_CUSTOMBASE];
 277
 278     memset(&cap, 0, sizeof(cap));
 279     cap.Cap = CAP_SUPPORTEDCAPS;
 280     cap.ConType = TWON_DONTCARE16;
 281
 282     rc = pDSM_Entry(appid, source, DG_CONTROL, DAT_CAPABILITY, MSG_GET, &cap);
 283     get_condition_code(appid, source, &status);
 284     ok(rc == TWRC_SUCCESS || status.ConditionCode == TWCC_SUCCESS,
 285             "Error obtaining CAP_SUPPORTEDCAPS\n");
 286
 287     memset(capabilities, 0, sizeof(capabilities));
 288     if (rc == TWRC_SUCCESS && cap.ConType == TWON_ARRAY)
 289     {
 290         TW_ARRAY *a;
 291         a = GlobalLock(cap.hContainer);
 292         if (a)
 293         {
 294             if (a->ItemType == TWTY_UINT16)
 295             {
 296                 int i;
 297                 UINT16 *u = (UINT16 *) a->ItemList;
 298                 trace("%d Capabilities:\n", a->NumItems);
 299                 for (i = 0; i < a->NumItems; i++)
 300                     if (u[i] < sizeof(capabilities) / sizeof(capabilities[0]))
 301                     {
 302                         capabilities[u[i]] = 1;
 303                         trace("  %d: 0x%x\n", i, u[i]);
 304                     }
 305             }
 306             GlobalUnlock(cap.hContainer);
 307         }
 308     }
 309
 310     /* For Twain 1.6, all sources must support: */
 311     ok(capabilities[CAP_SUPPORTEDCAPS], "CAP_SUPPORTEDCAPS not supported\n");
 312     todo_wine
 313     ok(capabilities[CAP_XFERCOUNT], "CAP_XFERCOUNT not supported\n");
 314     todo_wine
 315     ok(capabilities[CAP_UICONTROLLABLE], "CAP_UICONTROLLABLE not supported\n");
 316
 317     if (source->SupportedGroups & DG_IMAGE)
 318     {
 319         /* For Twain 1.6:
 320             Sources that supply image information must support DG_CONTROL / DAT_CAPABILITY /
 321             MSG_GET, MSG_GETCURRENT, MSG_GETDEFAULT on:
 322         */
 323         todo_wine
 324         ok(capabilities[ICAP_COMPRESSION], "ICAP_COMPRESSION not supported\n");
 325         todo_wine
 326         ok(capabilities[ICAP_PLANARCHUNKY], "ICAP_PLANARCHUNKY not supported\n");
 327         todo_wine
 328         ok(capabilities[ICAP_PHYSICALHEIGHT], "ICAP_PHYSICALHEIGHT not supported\n");
 329         todo_wine
 330         ok(capabilities[ICAP_PHYSICALWIDTH], "ICAP_PHYSICALWIDTH not supported\n");
 331         todo_wine
 332         ok(capabilities[ICAP_PIXELFLAVOR], "ICAP_PIXELFLAVOR not supported\n");
 333
 334         /* For Twain 1.6:
 335             Sources that supply image information must support DG_CONTROL / DAT_CAPABILITY /
 336             MSG_GET, MSG_GETCURRENT, MSG_GETDEFAULT, MSG_RESET and MSG_SET on:
 337         */
 338         todo_wine
 339         ok(capabilities[ICAP_BITDEPTH], "ICAP_BITDEPTH not supported\n");
 340         todo_wine
 341         ok(capabilities[ICAP_BITORDER], "ICAP_BITORDER not supported\n");
 342         todo_wine
 343         ok(capabilities[ICAP_PIXELTYPE], "ICAP_PIXELTYPE not supported\n");
 344         todo_wine
 345         ok(capabilities[ICAP_UNITS], "ICAP_UNITS not supported\n");
 346         ok(capabilities[ICAP_XFERMECH], "ICAP_XFERMECH not supported\n");
 347         if (capabilities[ICAP_XFERMECH])
 348             test_onevalue_cap(appid, source, ICAP_XFERMECH, TWTY_UINT16,
 349                 TWQC_GET | TWQC_SET | TWQC_GETDEFAULT | TWQC_GETCURRENT | TWQC_RESET);
 350         todo_wine
 351         ok(capabilities[ICAP_XRESOLUTION], "ICAP_XRESOLUTION not supported\n");
 352         todo_wine
 353         ok(capabilities[ICAP_YRESOLUTION], "ICAP_YRESOLUTION not supported\n");
 354     }
 355 }
 356
 357 static void test_sources(TW_IDENTITY *appid)
 358 {
 359     TW_UINT16 rc;
 360     TW_IDENTITY source;
 361     TW_STATUS status;
 362     int scannercount = 0;
 363
 364     memset(&source, 0, sizeof(source));
 365     rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_GETFIRST, &source);
 366     get_condition_code(appid, NULL, &status);
 367     ok( (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS) ||
 368         (rc == TWRC_FAILURE && status.ConditionCode == TWCC_NODS),
 369             "Get first invalid condition code, rc %d, cc %d\n", rc, status.ConditionCode);
 370
 371     while (rc == TWRC_SUCCESS)
 372     {
 373         scannercount++;
 374         trace("[Scanner %d|Version %d.%d(%s)|Protocol %d.%d|SupportedGroups 0x%x|Manufacturer %s|Family %s|ProductName %s]\n",
 375             scannercount,
 376             source.Version.MajorNum, source.Version.MinorNum, source.Version.Info,
 377             source.ProtocolMajor, source.ProtocolMinor, source.SupportedGroups,
 378             source.Manufacturer, source.ProductFamily, source.ProductName);
 379         memset(&source, 0, sizeof(source));
 380         rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_GETNEXT, &source);
 381         get_condition_code(appid, NULL, &status);
 382         ok(rc == TWRC_SUCCESS || rc == TWRC_ENDOFLIST, "Get next source failed, rc %d, cc %d\n", rc, status.ConditionCode);
 383     }
 384
 385     memset(&source, 0, sizeof(source));
 386     rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_GETDEFAULT, &source);
 387     get_condition_code(appid, NULL, &status);
 388     ok( (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS) ||
 389         (rc == TWRC_FAILURE && status.ConditionCode == TWCC_NODS),
 390             "Get default invalid condition code, rc %d, cc %d\n", rc, status.ConditionCode);
 391
 392     if (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS)
 393     {
 394         rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_OPENDS, &source);
 395         get_condition_code(appid, NULL, &status);
 396
 397         if (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS)
 398         {
 399             rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_CLOSEDS, &source);
 400             get_condition_code(appid, NULL, &status);
 401             ok(rc == TWRC_SUCCESS, "Close DS Failed, rc %d, cc %d\n", rc, status.ConditionCode);
 402         }
 403     }
 404
 405     if (winetest_interactive)
 406     {
 407         trace("Interactive, so trying userselect\n");
 408         memset(&source, 0, sizeof(source));
 409         rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_USERSELECT, &source);
 410         get_condition_code(appid, NULL, &status);
 411         ok(rc == TWRC_SUCCESS || rc == TWRC_CANCEL, "Userselect failed, rc %d, cc %d\n", rc, status.ConditionCode);
 412
 413         if (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS)
 414         {
 415             rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_OPENDS, &source);
 416             get_condition_code(appid, NULL, &status);
 417             if (rc == TWRC_SUCCESS && status.ConditionCode == TWCC_SUCCESS)
 418             {
 419                 test_single_source(appid, &source);
 420                 rc = pDSM_Entry(appid, NULL, DG_CONTROL, DAT_IDENTITY, MSG_CLOSEDS, &source);
 421                 get_condition_code(appid, NULL, &status);
 422                 ok(rc == TWRC_SUCCESS, "Close DS Failed, rc %d, cc %d\n", rc, status.ConditionCode);
 423             }
 424         }
 425     }
 426
 427 }
 428
 429 START_TEST(dsm)
 430 {
 431     TW_IDENTITY appid;
 432     TW_UINT16 rc;
 433     HANDLE hwnd;
 434     HMODULE htwain;
 435
 436     if (!dsm_RegisterWindowClasses()) assert(0);
 437
 438     htwain = LoadLibraryA("twain_32.dll");
 439     if (! htwain)
 440     {
 441         skip("twain_32.dll not available, skipping tests\n");
 442         return;
 443     }
 444     pDSM_Entry = (void*)GetProcAddress(htwain, "DSM_Entry");
 445     ok(pDSM_Entry != NULL, "Unable to GetProcAddress DSM_Entry\n");
 446     if (! pDSM_Entry)
 447     {
 448         skip("DSM_Entry not available, skipping tests\n");
 449         return;
 450     }
 451
 452     memset(&appid, 0, sizeof(appid));
 453     appid.Version.Language = TWLG_ENGLISH_USA;
 454     appid.Version.Country = TWCY_USA;
 455     appid.ProtocolMajor = TWON_PROTOCOLMAJOR;
 456     appid.ProtocolMinor = TWON_PROTOCOLMINOR;
 457     appid.SupportedGroups = DG_CONTROL | DG_IMAGE;
 458
 459     hwnd = CreateWindow("TWAIN_dsm_class", "Twain Test", 0,
 460                         CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
 461                         NULL, NULL, GetModuleHandleA(0), NULL);
 462
 463     rc = pDSM_Entry(&appid, NULL, DG_CONTROL, DAT_PARENT, MSG_OPENDSM, (TW_MEMREF) &hwnd);
 464     ok(rc == TWRC_SUCCESS, "MSG_OPENDSM returned %d\n", rc);
 465
 466     test_sources(&appid);
 467
 468     rc = pDSM_Entry(&appid, NULL, DG_CONTROL, DAT_PARENT, MSG_CLOSEDSM, (TW_MEMREF) &hwnd);
 469     ok(rc == TWRC_SUCCESS, "MSG_CLOSEDSM returned %d\n", rc);
 470
 471     DestroyWindow(hwnd);
 472     FreeLibrary(htwain);
 473 }