git.oblomov.eu Git - wine/blob - dlls/comctl32/comctl32undoc.c

   1 /*
   2  * Undocumented functions from COMCTL32.DLL
   3  *
   4  * Copyright 1998 Eric Kohl
   5  *           1998 Juergen Schmied <j.schmied@metronet.de>
   6  *           2000 Eric Kohl for CodeWeavers
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * NOTES
  23  *     All of these functions are UNDOCUMENTED!! And I mean UNDOCUMENTED!!!!
  24  *     Do NOT rely on names or contents of undocumented structures and types!!!
  25  *     These functions are used by EXPLORER.EXE, IEXPLORE.EXE and
  26  *     COMCTL32.DLL (internally).
  27  *
  28  */
  29 #include "config.h"
  30 #include "wine/port.h"
  31
  32 #include <stdarg.h>
  33 #include <string.h>
  34 #include <ctype.h>
  35 #include <limits.h>
  36
  37 #define COBJMACROS
  38 #define NONAMELESSUNION
  39 #define NONAMELESSSTRUCT
  40
  41 #include "windef.h"
  42 #include "winbase.h"
  43 #include "wingdi.h"
  44 #include "winuser.h"
  45 #include "winnls.h"
  46 #include "winreg.h"
  47 #include "commctrl.h"
  48 #include "objbase.h"
  49 #include "winerror.h"
  50
  51 #include "wine/unicode.h"
  52 #include "comctl32.h"
  53
  54 #include "wine/debug.h"
  55
  56 WINE_DEFAULT_DEBUG_CHANNEL(commctrl);
  57
  58 static const WCHAR strMRUList[] = { 'M','R','U','L','i','s','t',0 };
  59
  60 /**************************************************************************
  61  * Alloc [COMCTL32.71]
  62  *
  63  * Allocates memory block from the dll's private heap
  64  *
  65  * PARAMS
  66  *     dwSize [I] size of the allocated memory block
  67  *
  68  * RETURNS
  69  *     Success: pointer to allocated memory block
  70  *     Failure: NULL
  71  */
  72 LPVOID WINAPI Alloc (DWORD dwSize)
  73 {
  74     return LocalAlloc( LMEM_ZEROINIT, dwSize );
  75 }
  76
  77
  78 /**************************************************************************
  79  * ReAlloc [COMCTL32.72]
  80  *
  81  * Changes the size of an allocated memory block or allocates a memory
  82  * block using the dll's private heap.
  83  *
  84  * PARAMS
  85  *     lpSrc  [I] pointer to memory block which will be resized
  86  *     dwSize [I] new size of the memory block.
  87  *
  88  * RETURNS
  89  *     Success: pointer to the resized memory block
  90  *     Failure: NULL
  91  *
  92  * NOTES
  93  *     If lpSrc is a NULL-pointer, then ReAlloc allocates a memory
  94  *     block like Alloc.
  95  */
  96 LPVOID WINAPI ReAlloc (LPVOID lpSrc, DWORD dwSize)
  97 {
  98     if (lpSrc)
  99         return LocalReAlloc( lpSrc, dwSize, LMEM_ZEROINIT | LMEM_MOVEABLE );
 100     else
 101         return LocalAlloc( LMEM_ZEROINIT, dwSize);
 102 }
 103
 104
 105 /**************************************************************************
 106  * Free [COMCTL32.73]
 107  *
 108  * Frees an allocated memory block from the dll's private heap.
 109  *
 110  * PARAMS
 111  *     lpMem [I] pointer to memory block which will be freed
 112  *
 113  * RETURNS
 114  *     Success: TRUE
 115  *     Failure: FALSE
 116  */
 117 BOOL WINAPI Free (LPVOID lpMem)
 118 {
 119     return !LocalFree( lpMem );
 120 }
 121
 122
 123 /**************************************************************************
 124  * GetSize [COMCTL32.74]
 125  *
 126  * Retrieves the size of the specified memory block from the dll's
 127  * private heap.
 128  *
 129  * PARAMS
 130  *     lpMem [I] pointer to an allocated memory block
 131  *
 132  * RETURNS
 133  *     Success: size of the specified memory block
 134  *     Failure: 0
 135  */
 136 DWORD WINAPI GetSize (LPVOID lpMem)
 137 {
 138     return LocalSize( lpMem );
 139 }
 140
 141
 142 /**************************************************************************
 143  * MRU-Functions  {COMCTL32}
 144  *
 145  * NOTES
 146  * The MRU-Api is a set of functions to manipulate lists of M.R.U. (Most Recently
 147  * Used) items. It is an undocumented Api that is used (at least) by the shell
 148  * and explorer to implement their recent documents feature.
 149  *
 150  * Since these functions are undocumented, they are unsupported by MS and
 151  * may change at any time.
 152  *
 153  * Internally, the list is implemented as a last in, last out list of items
 154  * persisted into the system registry under a caller chosen key. Each list
 155  * item is given a one character identifier in the Ascii range from 'a' to
 156  * '}'. A list of the identifiers in order from newest to oldest is stored
 157  * under the same key in a value named "MRUList".
 158  *
 159  * Items are re-ordered by changing the order of the values in the MRUList
 160  * value. When a new item is added, it becomes the new value of the oldest
 161  * identifier, and that identifier is moved to the front of the MRUList value.
 162  *
 163  * Wine stores MRU-lists in the same registry format as Windows, so when
 164  * switching between the builtin and native comctl32.dll no problems or
 165  * incompatibilities should occur.
 166  *
 167  * The following undocumented structure is used to create an MRU-list:
 168  *|typedef INT (CALLBACK *MRUStringCmpFn)(LPCTSTR lhs, LPCTSTR rhs);
 169  *|typedef INT (CALLBACK *MRUBinaryCmpFn)(LPCVOID lhs, LPCVOID rhs, DWORD length);
 170  *|
 171  *|typedef struct tagCREATEMRULIST
 172  *|{
 173  *|    DWORD   cbSize;
 174  *|    DWORD   nMaxItems;
 175  *|    DWORD   dwFlags;
 176  *|    HKEY    hKey;
 177  *|    LPCTSTR lpszSubKey;
 178  *|    PROC    lpfnCompare;
 179  *|} CREATEMRULIST, *LPCREATEMRULIST;
 180  *
 181  * MEMBERS
 182  *  cbSize      [I] The size of the CREATEMRULIST structure. This must be set
 183  *                  to sizeof(CREATEMRULIST) by the caller.
 184  *  nMaxItems   [I] The maximum number of items allowed in the list. Because
 185  *                  of the limited number of identifiers, this should be set to
 186  *                  a value from 1 to 30 by the caller.
 187  *  dwFlags     [I] If bit 0 is set, the list will be used to store binary
 188  *                  data, otherwise it is assumed to store strings. If bit 1
 189  *                  is set, every change made to the list will be reflected in
 190  *                  the registry immediately, otherwise changes will only be
 191  *                  written when the list is closed.
 192  *  hKey        [I] The registry key that the list should be written under.
 193  *                  This must be supplied by the caller.
 194  *  lpszSubKey  [I] A caller supplied name of a subkey under hKey to write
 195  *                  the list to. This may not be blank.
 196  *  lpfnCompare [I] A caller supplied comparison function, which may be either
 197  *                  an MRUStringCmpFn if dwFlags does not have bit 0 set, or a
 198  *                  MRUBinaryCmpFn otherwise.
 199  *
 200  * FUNCTIONS
 201  *  - Create an MRU-list with CreateMRUList() or CreateMRUListLazy().
 202  *  - Add items to an MRU-list with AddMRUString() or AddMRUData().
 203  *  - Remove items from an MRU-list with DelMRUString().
 204  *  - Find data in an MRU-list with FindMRUString() or FindMRUData().
 205  *  - Iterate through an MRU-list with EnumMRUList().
 206  *  - Free an MRU-list with FreeMRUList().
 207  */
 208
 209 typedef struct tagCREATEMRULISTA
 210 {
 211     DWORD  cbSize;
 212     DWORD  nMaxItems;
 213     DWORD  dwFlags;
 214     HKEY   hKey;
 215     LPCSTR lpszSubKey;
 216     PROC   lpfnCompare;
 217 } CREATEMRULISTA, *LPCREATEMRULISTA;
 218
 219 typedef struct tagCREATEMRULISTW
 220 {
 221     DWORD   cbSize;
 222     DWORD   nMaxItems;
 223     DWORD   dwFlags;
 224     HKEY    hKey;
 225     LPCWSTR lpszSubKey;
 226     PROC    lpfnCompare;
 227 } CREATEMRULISTW, *LPCREATEMRULISTW;
 228
 229 /* dwFlags */
 230 #define MRUF_STRING_LIST  0 /* list will contain strings */
 231 #define MRUF_BINARY_LIST  1 /* list will contain binary data */
 232 #define MRUF_DELAYED_SAVE 2 /* only save list order to reg. is FreeMRUList */
 233
 234 /* If list is a string list lpfnCompare has the following prototype
 235  * int CALLBACK MRUCompareString(LPCSTR s1, LPCSTR s2)
 236  * for binary lists the prototype is
 237  * int CALLBACK MRUCompareBinary(LPCVOID data1, LPCVOID data2, DWORD cbData)
 238  * where cbData is the no. of bytes to compare.
 239  * Need to check what return value means identical - 0?
 240  */
 241
 242 typedef struct tagWINEMRUITEM
 243 {
 244     DWORD          size;        /* size of data stored               */
 245     DWORD          itemFlag;    /* flags                             */
 246     BYTE           datastart;
 247 } WINEMRUITEM, *LPWINEMRUITEM;
 248
 249 /* itemFlag */
 250 #define WMRUIF_CHANGED   0x0001 /* this dataitem changed             */
 251
 252 typedef struct tagWINEMRULIST
 253 {
 254     CREATEMRULISTW extview;     /* original create information       */
 255     BOOL           isUnicode;   /* is compare fn Unicode */
 256     DWORD          wineFlags;   /* internal flags                    */
 257     DWORD          cursize;     /* current size of realMRU           */
 258     LPWSTR         realMRU;     /* pointer to string of index names  */
 259     LPWINEMRUITEM  *array;      /* array of pointers to data         */
 260                                 /* in 'a' to 'z' order               */
 261 } WINEMRULIST, *LPWINEMRULIST;
 262
 263 /* wineFlags */
 264 #define WMRUF_CHANGED  0x0001   /* MRU list has changed              */
 265
 266 /**************************************************************************
 267  *              MRU_SaveChanged (internal)
 268  *
 269  * Local MRU saving code
 270  */
 271 static void MRU_SaveChanged ( LPWINEMRULIST mp )
 272 {
 273     UINT i, err;
 274     HKEY newkey;
 275     WCHAR realname[2];
 276     LPWINEMRUITEM witem;
 277
 278     /* or should we do the following instead of RegOpenKeyEx:
 279      */
 280
 281     /* open the sub key */
 282     if ((err = RegOpenKeyExW( mp->extview.hKey, mp->extview.lpszSubKey,
 283                               0, KEY_WRITE, &newkey))) {
 284         /* not present - what to do ??? */
 285         ERR("Could not open key, error=%d, attempting to create\n",
 286             err);
 287         if ((err = RegCreateKeyExW( mp->extview.hKey, mp->extview.lpszSubKey,
 288                                     0,
 289                                     NULL,
 290                                     REG_OPTION_NON_VOLATILE,
 291                                     KEY_READ | KEY_WRITE,
 292                                     0,
 293                                     &newkey,
 294                                     0))) {
 295             ERR("failed to create key /%s/, err=%d\n",
 296                 debugstr_w(mp->extview.lpszSubKey), err);
 297             return;
 298         }
 299     }
 300     if (mp->wineFlags & WMRUF_CHANGED) {
 301         mp->wineFlags &= ~WMRUF_CHANGED;
 302         err = RegSetValueExW(newkey, strMRUList, 0, REG_SZ, (LPBYTE)mp->realMRU,
 303                              (strlenW(mp->realMRU) + 1)*sizeof(WCHAR));
 304         if (err) {
 305             ERR("error saving MRUList, err=%d\n", err);
 306         }
 307         TRACE("saving MRUList=/%s/\n", debugstr_w(mp->realMRU));
 308     }
 309     realname[1] = 0;
 310     for(i=0; i<mp->cursize; i++) {
 311         witem = mp->array[i];
 312         if (witem->itemFlag & WMRUIF_CHANGED) {
 313             witem->itemFlag &= ~WMRUIF_CHANGED;
 314             realname[0] = 'a' + i;
 315             err = RegSetValueExW(newkey, realname, 0,
 316                                  (mp->extview.dwFlags & MRUF_BINARY_LIST) ?
 317                                  REG_BINARY : REG_SZ,
 318                                  &witem->datastart, witem->size);
 319             if (err) {
 320                 ERR("error saving /%s/, err=%d\n", debugstr_w(realname), err);
 321             }
 322             TRACE("saving value for name /%s/ size=%ld\n",
 323                   debugstr_w(realname), witem->size);
 324         }
 325     }
 326     RegCloseKey( newkey );
 327 }
 328
 329 /**************************************************************************
 330  *              FreeMRUList [COMCTL32.152]
 331  *
 332  * Frees a most-recently-used items list.
 333  *
 334  * PARAMS
 335  *     hMRUList [I] Handle to list.
 336  *
 337  * RETURNS
 338  *     Nothing.
 339  */
 340 void WINAPI FreeMRUList (HANDLE hMRUList)
 341 {
 342     LPWINEMRULIST mp = (LPWINEMRULIST)hMRUList;
 343     UINT i;
 344
 345     TRACE("(%p)\n", hMRUList);
 346     if (!hMRUList)
 347         return;
 348
 349     if (mp->wineFlags & WMRUF_CHANGED) {
 350         /* need to open key and then save the info */
 351         MRU_SaveChanged( mp );
 352     }
 353
 354     for(i=0; i<mp->extview.nMaxItems; i++) {
 355         if (mp->array[i])
 356             Free(mp->array[i]);
 357     }
 358     Free(mp->realMRU);
 359     Free(mp->array);
 360     Free((LPWSTR)mp->extview.lpszSubKey);
 361     Free(mp);
 362 }
 363
 364
 365 /**************************************************************************
 366  *                  FindMRUData [COMCTL32.169]
 367  *
 368  * Searches binary list for item that matches lpData of length cbData.
 369  * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
 370  * corresponding to item's reg. name will be stored in it ('a' -> 0).
 371  *
 372  * PARAMS
 373  *    hList [I] list handle
 374  *    lpData [I] data to find
 375  *    cbData [I] length of data
 376  *    lpRegNum [O] position in registry (maybe NULL)
 377  *
 378  * RETURNS
 379  *    Position in list 0 -> MRU.  -1 if item not found.
 380  */
 381 INT WINAPI FindMRUData (HANDLE hList, LPCVOID lpData, DWORD cbData,
 382                         LPINT lpRegNum)
 383 {
 384     LPWINEMRULIST mp = (LPWINEMRULIST)hList;
 385     INT ret;
 386     UINT i;
 387     LPSTR dataA = NULL;
 388
 389     if (!mp->extview.lpfnCompare) {
 390         ERR("MRU list not properly created. No compare procedure.\n");
 391         return -1;
 392     }
 393
 394     if(!(mp->extview.dwFlags & MRUF_BINARY_LIST) && !mp->isUnicode) {
 395         DWORD len = WideCharToMultiByte(CP_ACP, 0, lpData, -1,
 396                                         NULL, 0, NULL, NULL);
 397         dataA = Alloc(len);
 398         WideCharToMultiByte(CP_ACP, 0, lpData, -1, dataA, len, NULL, NULL);
 399     }
 400
 401     for(i=0; i<mp->cursize; i++) {
 402         if (mp->extview.dwFlags & MRUF_BINARY_LIST) {
 403             if (!mp->extview.lpfnCompare(lpData, &mp->array[i]->datastart,
 404                                          cbData))
 405                 break;
 406         }
 407         else {
 408             if(mp->isUnicode) {
 409                 if (!mp->extview.lpfnCompare(lpData, &mp->array[i]->datastart))
 410                     break;
 411             } else {
 412                 DWORD len = WideCharToMultiByte(CP_ACP, 0,
 413                                                 (LPWSTR)&mp->array[i]->datastart, -1,
 414                                                 NULL, 0, NULL, NULL);
 415                 LPSTR itemA = Alloc(len);
 416                 INT cmp;
 417                 WideCharToMultiByte(CP_ACP, 0, (LPWSTR)&mp->array[i]->datastart, -1,
 418                                     itemA, len, NULL, NULL);
 419
 420                 cmp = mp->extview.lpfnCompare(dataA, itemA);
 421                 Free(itemA);
 422                 if(!cmp)
 423                     break;
 424             }
 425         }
 426     }
 427     if(dataA)
 428         Free(dataA);
 429     if (i < mp->cursize)
 430         ret = i;
 431     else
 432         ret = -1;
 433     if (lpRegNum && (ret != -1))
 434         *lpRegNum = 'a' + i;
 435
 436     TRACE("(%p, %p, %ld, %p) returning %d\n",
 437            hList, lpData, cbData, lpRegNum, ret);
 438
 439     return ret;
 440 }
 441
 442
 443 /**************************************************************************
 444  *              AddMRUData [COMCTL32.167]
 445  *
 446  * Add item to MRU binary list.  If item already exists in list then it is
 447  * simply moved up to the top of the list and not added again.  If list is
 448  * full then the least recently used item is removed to make room.
 449  *
 450  * PARAMS
 451  *     hList [I] Handle to list.
 452  *     lpData [I] ptr to data to add.
 453  *     cbData [I] no. of bytes of data.
 454  *
 455  * RETURNS
 456  *     No. corresponding to registry name where value is stored 'a' -> 0 etc.
 457  *     -1 on error.
 458  */
 459 INT WINAPI AddMRUData (HANDLE hList, LPCVOID lpData, DWORD cbData)
 460 {
 461     LPWINEMRULIST mp = (LPWINEMRULIST)hList;
 462     LPWINEMRUITEM witem;
 463     INT i, replace;
 464
 465     if ((replace = FindMRUData (hList, lpData, cbData, NULL)) >= 0) {
 466         /* Item exists, just move it to the front */
 467         LPWSTR pos = strchrW(mp->realMRU, replace + 'a');
 468         while (pos > mp->realMRU)
 469         {
 470             pos[0] = pos[-1];
 471             pos--;
 472         }
 473     }
 474     else {
 475         /* either add a new entry or replace oldest */
 476         if (mp->cursize < mp->extview.nMaxItems) {
 477             /* Add in a new item */
 478             replace = mp->cursize;
 479             mp->cursize++;
 480         }
 481         else {
 482             /* get the oldest entry and replace data */
 483             replace = mp->realMRU[mp->cursize - 1] - 'a';
 484             Free(mp->array[replace]);
 485         }
 486
 487         /* Allocate space for new item and move in the data */
 488         mp->array[replace] = witem = Alloc(cbData + sizeof(WINEMRUITEM));
 489         witem->itemFlag |= WMRUIF_CHANGED;
 490         witem->size = cbData;
 491         memcpy( &witem->datastart, lpData, cbData);
 492
 493         /* now rotate MRU list */
 494         for(i=mp->cursize-1; i>=1; i--)
 495             mp->realMRU[i] = mp->realMRU[i-1];
 496     }
 497
 498     /* The new item gets the front spot */
 499     mp->wineFlags |= WMRUF_CHANGED;
 500     mp->realMRU[0] = replace + 'a';
 501
 502     TRACE("(%p, %p, %ld) adding data, /%c/ now most current\n",
 503           hList, lpData, cbData, replace+'a');
 504
 505     if (!(mp->extview.dwFlags & MRUF_DELAYED_SAVE)) {
 506         /* save changed stuff right now */
 507         MRU_SaveChanged( mp );
 508     }
 509
 510     return replace;
 511 }
 512
 513 /**************************************************************************
 514  *              AddMRUStringW [COMCTL32.401]
 515  *
 516  * Add an item to an MRU string list.
 517  *
 518  * PARAMS
 519  *     hList      [I] Handle to list.
 520  *     lpszString [I] The string to add.
 521  *
 522  * RETURNS
 523  *   Success: The number corresponding to the registry name where the string
 524  *            has been stored (0 maps to 'a', 1 to 'b' and so on).
 525  *   Failure: -1, if hList is NULL or memory allocation fails. If lpszString
 526  *            is invalid, the function returns 0, and GetLastError() returns
 527  *            ERROR_INVALID_PARAMETER. The last error value is set only in
 528  *            this case.
 529  *
 530  * NOTES
 531  *  -If lpszString exists in the list already, it is moved to the top of the
 532  *   MRU list (it is not duplicated).
 533  *  -If the list is full the least recently used list entry is replaced with
 534  *   lpszString.
 535  *  -If this function returns 0 you should check the last error value to
 536  *   ensure the call really succeeded.
 537  */
 538 INT WINAPI AddMRUStringW(HANDLE hList, LPCWSTR lpszString)
 539 {
 540     TRACE("(%p,%s)\n", hList, debugstr_w(lpszString));
 541
 542     if (!hList)
 543         return -1;
 544
 545     if (!lpszString || IsBadStringPtrW(lpszString, -1))
 546     {
 547         SetLastError(ERROR_INVALID_PARAMETER);
 548         return 0;
 549     }
 550
 551     return AddMRUData(hList, lpszString,
 552                       (strlenW(lpszString) + 1) * sizeof(WCHAR));
 553 }
 554
 555 /**************************************************************************
 556  *              AddMRUStringA [COMCTL32.153]
 557  *
 558  * See AddMRUStringW.
 559  */
 560 INT WINAPI AddMRUStringA(HANDLE hList, LPCSTR lpszString)
 561 {
 562     DWORD len;
 563     LPWSTR stringW;
 564     INT ret;
 565
 566     TRACE("(%p,%s)\n", hList, debugstr_a(lpszString));
 567
 568     if (!hList)
 569         return -1;
 570
 571     if (IsBadStringPtrA(lpszString, -1))
 572     {
 573         SetLastError(ERROR_INVALID_PARAMETER);
 574         return 0;
 575     }
 576
 577     len = MultiByteToWideChar(CP_ACP, 0, lpszString, -1, NULL, 0) * sizeof(WCHAR);
 578     stringW = Alloc(len);
 579     if (!stringW)
 580         return -1;
 581
 582     MultiByteToWideChar(CP_ACP, 0, lpszString, -1, stringW, len/sizeof(WCHAR));
 583     ret = AddMRUData(hList, stringW, len);
 584     Free(stringW);
 585     return ret;
 586 }
 587
 588 /**************************************************************************
 589  *              DelMRUString [COMCTL32.156]
 590  *
 591  * Removes item from either string or binary list (despite its name)
 592  *
 593  * PARAMS
 594  *    hList [I] list handle
 595  *    nItemPos [I] item position to remove 0 -> MRU
 596  *
 597  * RETURNS
 598  *    TRUE if successful, FALSE if nItemPos is out of range.
 599  */
 600 BOOL WINAPI DelMRUString(HANDLE hList, INT nItemPos)
 601 {
 602     FIXME("(%p, %d): stub\n", hList, nItemPos);
 603     return TRUE;
 604 }
 605
 606 /**************************************************************************
 607  *                  FindMRUStringW [COMCTL32.402]
 608  *
 609  * See FindMRUStringA.
 610  */
 611 INT WINAPI FindMRUStringW (HANDLE hList, LPCWSTR lpszString, LPINT lpRegNum)
 612 {
 613   return FindMRUData(hList, lpszString,
 614                      (lstrlenW(lpszString) + 1) * sizeof(WCHAR), lpRegNum);
 615 }
 616
 617 /**************************************************************************
 618  *                  FindMRUStringA [COMCTL32.155]
 619  *
 620  * Searches string list for item that matches lpszString.
 621  * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
 622  * corresponding to item's reg. name will be stored in it ('a' -> 0).
 623  *
 624  * PARAMS
 625  *    hList [I] list handle
 626  *    lpszString [I] string to find
 627  *    lpRegNum [O] position in registry (maybe NULL)
 628  *
 629  * RETURNS
 630  *    Position in list 0 -> MRU.  -1 if item not found.
 631  */
 632 INT WINAPI FindMRUStringA (HANDLE hList, LPCSTR lpszString, LPINT lpRegNum)
 633 {
 634     DWORD len = MultiByteToWideChar(CP_ACP, 0, lpszString, -1, NULL, 0);
 635     LPWSTR stringW = Alloc(len * sizeof(WCHAR));
 636     INT ret;
 637
 638     MultiByteToWideChar(CP_ACP, 0, lpszString, -1, stringW, len);
 639     ret = FindMRUData(hList, stringW, len * sizeof(WCHAR), lpRegNum);
 640     Free(stringW);
 641     return ret;
 642 }
 643
 644 /*************************************************************************
 645  *                 CreateMRUListLazy_common (internal)
 646  */
 647 static HANDLE CreateMRUListLazy_common(LPWINEMRULIST mp)
 648 {
 649     UINT i, err;
 650     HKEY newkey;
 651     DWORD datasize, dwdisp;
 652     WCHAR realname[2];
 653     LPWINEMRUITEM witem;
 654     DWORD type;
 655
 656     /* get space to save indices that will turn into names
 657      * but in order of most to least recently used
 658      */
 659     mp->realMRU = Alloc((mp->extview.nMaxItems + 2) * sizeof(WCHAR));
 660
 661     /* get space to save pointers to actual data in order of
 662      * 'a' to 'z' (0 to n).
 663      */
 664     mp->array = Alloc(mp->extview.nMaxItems * sizeof(LPVOID));
 665
 666     /* open the sub key */
 667     if ((err = RegCreateKeyExW( mp->extview.hKey, mp->extview.lpszSubKey,
 668                                 0,
 669                                 NULL,
 670                                 REG_OPTION_NON_VOLATILE,
 671                                 KEY_READ | KEY_WRITE,
 672                                 0,
 673                                 &newkey,
 674                                 &dwdisp))) {
 675         /* error - what to do ??? */
 676         ERR("(%lu %lu %lx %p %s %p): Could not open key, error=%d\n",
 677             mp->extview.cbSize, mp->extview.nMaxItems, mp->extview.dwFlags,
 678             mp->extview.hKey, debugstr_w(mp->extview.lpszSubKey),
 679                                  mp->extview.lpfnCompare, err);
 680         return 0;
 681     }
 682
 683     /* get values from key 'MRUList' */
 684     if (newkey) {
 685         datasize = (mp->extview.nMaxItems + 1) * sizeof(WCHAR);
 686         if((err=RegQueryValueExW( newkey, strMRUList, 0, &type,
 687                                   (LPBYTE)mp->realMRU, &datasize))) {
 688             /* not present - set size to 1 (will become 0 later) */
 689             datasize = 1;
 690             *mp->realMRU = 0;
 691         }
 692         else
 693             datasize /= sizeof(WCHAR);
 694
 695         TRACE("MRU list = %s, datasize = %ld\n", debugstr_w(mp->realMRU), datasize);
 696
 697         mp->cursize = datasize - 1;
 698         /* datasize now has number of items in the MRUList */
 699
 700         /* get actual values for each entry */
 701         realname[1] = 0;
 702         for(i=0; i<mp->cursize; i++) {
 703             realname[0] = 'a' + i;
 704             if(RegQueryValueExW( newkey, realname, 0, &type, 0, &datasize)) {
 705                 /* not present - what to do ??? */
 706                 ERR("Key %s not found 1\n", debugstr_w(realname));
 707             }
 708             mp->array[i] = witem = Alloc(datasize + sizeof(WINEMRUITEM));
 709             witem->size = datasize;
 710             if(RegQueryValueExW( newkey, realname, 0, &type,
 711                                  &witem->datastart, &datasize)) {
 712                 /* not present - what to do ??? */
 713                 ERR("Key %s not found 2\n", debugstr_w(realname));
 714             }
 715         }
 716         RegCloseKey( newkey );
 717     }
 718     else
 719         mp->cursize = 0;
 720
 721     TRACE("(%lu %lu %lx %p %s %p): Current Size = %ld\n",
 722           mp->extview.cbSize, mp->extview.nMaxItems, mp->extview.dwFlags,
 723           mp->extview.hKey, debugstr_w(mp->extview.lpszSubKey),
 724           mp->extview.lpfnCompare, mp->cursize);
 725     return (HANDLE)mp;
 726 }
 727
 728 /**************************************************************************
 729  *                  CreateMRUListLazyW [COMCTL32.404]
 730  *
 731  * See CreateMRUListLazyA.
 732  */
 733 HANDLE WINAPI CreateMRUListLazyW (LPCREATEMRULISTW lpcml, DWORD dwParam2,
 734                                   DWORD dwParam3, DWORD dwParam4)
 735 {
 736     LPWINEMRULIST mp;
 737
 738     /* Native does not check for a NULL lpcml */
 739
 740     if (lpcml->cbSize != sizeof(CREATEMRULISTW) || !lpcml->hKey ||
 741         IsBadStringPtrW(lpcml->lpszSubKey, -1))
 742         return NULL;
 743
 744     mp = Alloc(sizeof(WINEMRULIST));
 745     memcpy(&mp->extview, lpcml, sizeof(CREATEMRULISTW));
 746     mp->extview.lpszSubKey = Alloc((strlenW(lpcml->lpszSubKey) + 1) * sizeof(WCHAR));
 747     strcpyW((LPWSTR)mp->extview.lpszSubKey, lpcml->lpszSubKey);
 748     mp->isUnicode = TRUE;
 749
 750     return CreateMRUListLazy_common(mp);
 751 }
 752
 753 /**************************************************************************
 754  *                  CreateMRUListLazyA [COMCTL32.157]
 755  *
 756  * Creates a most-recently-used list.
 757  *
 758  * PARAMS
 759  *     lpcml    [I] ptr to CREATEMRULIST structure.
 760  *     dwParam2 [I] Unknown
 761  *     dwParam3 [I] Unknown
 762  *     dwParam4 [I] Unknown
 763  *
 764  * RETURNS
 765  *     Handle to MRU list.
 766  */
 767 HANDLE WINAPI CreateMRUListLazyA (LPCREATEMRULISTA lpcml, DWORD dwParam2,
 768                                   DWORD dwParam3, DWORD dwParam4)
 769 {
 770     LPWINEMRULIST mp;
 771     DWORD len;
 772
 773     /* Native does not check for a NULL lpcml */
 774
 775     if (lpcml->cbSize != sizeof(CREATEMRULISTA) || !lpcml->hKey ||
 776         IsBadStringPtrA(lpcml->lpszSubKey, -1))
 777         return 0;
 778
 779     mp = Alloc(sizeof(WINEMRULIST));
 780     memcpy(&mp->extview, lpcml, sizeof(CREATEMRULISTW));
 781     len = MultiByteToWideChar(CP_ACP, 0, lpcml->lpszSubKey, -1, NULL, 0);
 782     mp->extview.lpszSubKey = Alloc(len * sizeof(WCHAR));
 783     MultiByteToWideChar(CP_ACP, 0, lpcml->lpszSubKey, -1,
 784                         (LPWSTR)mp->extview.lpszSubKey, len);
 785     mp->isUnicode = FALSE;
 786     return CreateMRUListLazy_common(mp);
 787 }
 788
 789 /**************************************************************************
 790  *              CreateMRUListW [COMCTL32.400]
 791  *
 792  * See CreateMRUListA.
 793  */
 794 HANDLE WINAPI CreateMRUListW (LPCREATEMRULISTW lpcml)
 795 {
 796     return CreateMRUListLazyW(lpcml, 0, 0, 0);
 797 }
 798
 799 /**************************************************************************
 800  *              CreateMRUListA [COMCTL32.151]
 801  *
 802  * Creates a most-recently-used list.
 803  *
 804  * PARAMS
 805  *     lpcml [I] ptr to CREATEMRULIST structure.
 806  *
 807  * RETURNS
 808  *     Handle to MRU list.
 809  */
 810 HANDLE WINAPI CreateMRUListA (LPCREATEMRULISTA lpcml)
 811 {
 812      return CreateMRUListLazyA (lpcml, 0, 0, 0);
 813 }
 814
 815
 816 /**************************************************************************
 817  *                EnumMRUListW [COMCTL32.403]
 818  *
 819  * Enumerate item in a most-recenty-used list
 820  *
 821  * PARAMS
 822  *    hList [I] list handle
 823  *    nItemPos [I] item position to enumerate
 824  *    lpBuffer [O] buffer to receive item
 825  *    nBufferSize [I] size of buffer
 826  *
 827  * RETURNS
 828  *    For binary lists specifies how many bytes were copied to buffer, for
 829  *    string lists specifies full length of string.  Enumerating past the end
 830  *    of list returns -1.
 831  *    If lpBuffer == NULL or nItemPos is -ve return value is no. of items in
 832  *    the list.
 833  */
 834 INT WINAPI EnumMRUListW (HANDLE hList, INT nItemPos, LPVOID lpBuffer,
 835                          DWORD nBufferSize)
 836 {
 837     LPWINEMRULIST mp = (LPWINEMRULIST) hList;
 838     LPWINEMRUITEM witem;
 839     INT desired, datasize;
 840
 841     if (nItemPos >= mp->cursize) return -1;
 842     if ((nItemPos < 0) || !lpBuffer) return mp->cursize;
 843     desired = mp->realMRU[nItemPos];
 844     desired -= 'a';
 845     TRACE("nItemPos=%d, desired=%d\n", nItemPos, desired);
 846     witem = mp->array[desired];
 847     datasize = min( witem->size, nBufferSize );
 848     memcpy( lpBuffer, &witem->datastart, datasize);
 849     TRACE("(%p, %d, %p, %ld): returning len=%d\n",
 850           hList, nItemPos, lpBuffer, nBufferSize, datasize);
 851     return datasize;
 852 }
 853
 854 /**************************************************************************
 855  *                EnumMRUListA [COMCTL32.154]
 856  *
 857  * See EnumMRUListW.
 858  */
 859 INT WINAPI EnumMRUListA (HANDLE hList, INT nItemPos, LPVOID lpBuffer,
 860                          DWORD nBufferSize)
 861 {
 862     LPWINEMRULIST mp = (LPWINEMRULIST) hList;
 863     LPWINEMRUITEM witem;
 864     INT desired, datasize;
 865     DWORD lenA;
 866
 867     if (nItemPos >= mp->cursize) return -1;
 868     if ((nItemPos < 0) || !lpBuffer) return mp->cursize;
 869     desired = mp->realMRU[nItemPos];
 870     desired -= 'a';
 871     TRACE("nItemPos=%d, desired=%d\n", nItemPos, desired);
 872     witem = mp->array[desired];
 873     if(mp->extview.dwFlags & MRUF_BINARY_LIST) {
 874         datasize = min( witem->size, nBufferSize );
 875         memcpy( lpBuffer, &witem->datastart, datasize);
 876     } else {
 877         lenA = WideCharToMultiByte(CP_ACP, 0, (LPWSTR)&witem->datastart, -1,
 878                                    NULL, 0, NULL, NULL);
 879         datasize = min( witem->size, nBufferSize );
 880         WideCharToMultiByte(CP_ACP, 0, (LPWSTR)&witem->datastart, -1,
 881                             lpBuffer, datasize, NULL, NULL);
 882     }
 883     TRACE("(%p, %d, %p, %ld): returning len=%d\n",
 884           hList, nItemPos, lpBuffer, nBufferSize, datasize);
 885     return datasize;
 886 }
 887
 888
 889 /**************************************************************************
 890  * Str_GetPtrA [COMCTL32.233]
 891  *
 892  * Copies a string into a destination buffer.
 893  *
 894  * PARAMS
 895  *     lpSrc   [I] Source string
 896  *     lpDest  [O] Destination buffer
 897  *     nMaxLen [I] Size of buffer in characters
 898  *
 899  * RETURNS
 900  *     The number of characters copied.
 901  */
 902 INT WINAPI Str_GetPtrA (LPCSTR lpSrc, LPSTR lpDest, INT nMaxLen)
 903 {
 904     INT len;
 905
 906     TRACE("(%p %p %d)\n", lpSrc, lpDest, nMaxLen);
 907
 908     if (!lpDest && lpSrc)
 909         return strlen (lpSrc);
 910
 911     if (nMaxLen == 0)
 912         return 0;
 913
 914     if (lpSrc == NULL) {
 915         lpDest[0] = '\0';
 916         return 0;
 917     }
 918
 919     len = strlen (lpSrc);
 920     if (len >= nMaxLen)
 921         len = nMaxLen - 1;
 922
 923     RtlMoveMemory (lpDest, lpSrc, len);
 924     lpDest[len] = '\0';
 925
 926     return len;
 927 }
 928
 929
 930 /**************************************************************************
 931  * Str_SetPtrA [COMCTL32.234]
 932  *
 933  * Makes a copy of a string, allocating memory if necessary.
 934  *
 935  * PARAMS
 936  *     lppDest [O] Pointer to destination string
 937  *     lpSrc   [I] Source string
 938  *
 939  * RETURNS
 940  *     Success: TRUE
 941  *     Failure: FALSE
 942  *
 943  * NOTES
 944  *     Set lpSrc to NULL to free the memory allocated by a previous call
 945  *     to this function.
 946  */
 947 BOOL WINAPI Str_SetPtrA (LPSTR *lppDest, LPCSTR lpSrc)
 948 {
 949     TRACE("(%p %p)\n", lppDest, lpSrc);
 950
 951     if (lpSrc) {
 952         LPSTR ptr = ReAlloc (*lppDest, strlen (lpSrc) + 1);
 953         if (!ptr)
 954             return FALSE;
 955         strcpy (ptr, lpSrc);
 956         *lppDest = ptr;
 957     }
 958     else {
 959         if (*lppDest) {
 960             Free (*lppDest);
 961             *lppDest = NULL;
 962         }
 963     }
 964
 965     return TRUE;
 966 }
 967
 968
 969 /**************************************************************************
 970  * Str_GetPtrW [COMCTL32.235]
 971  *
 972  * See Str_GetPtrA.
 973  */
 974 INT WINAPI Str_GetPtrW (LPCWSTR lpSrc, LPWSTR lpDest, INT nMaxLen)
 975 {
 976     INT len;
 977
 978     TRACE("(%p %p %d)\n", lpSrc, lpDest, nMaxLen);
 979
 980     if (!lpDest && lpSrc)
 981         return strlenW (lpSrc);
 982
 983     if (nMaxLen == 0)
 984         return 0;
 985
 986     if (lpSrc == NULL) {
 987         lpDest[0] = L'\0';
 988         return 0;
 989     }
 990
 991     len = strlenW (lpSrc);
 992     if (len >= nMaxLen)
 993         len = nMaxLen - 1;
 994
 995     RtlMoveMemory (lpDest, lpSrc, len*sizeof(WCHAR));
 996     lpDest[len] = L'\0';
 997
 998     return len;
 999 }
1000
1001
1002 /**************************************************************************
1003  * Str_SetPtrW [COMCTL32.236]
1004  *
1005  * See Str_SetPtrA.
1006  */
1007 BOOL WINAPI Str_SetPtrW (LPWSTR *lppDest, LPCWSTR lpSrc)
1008 {
1009     TRACE("(%p %p)\n", lppDest, lpSrc);
1010
1011     if (lpSrc) {
1012         INT len = strlenW (lpSrc) + 1;
1013         LPWSTR ptr = ReAlloc (*lppDest, len * sizeof(WCHAR));
1014         if (!ptr)
1015             return FALSE;
1016         strcpyW (ptr, lpSrc);
1017         *lppDest = ptr;
1018     }
1019     else {
1020         if (*lppDest) {
1021             Free (*lppDest);
1022             *lppDest = NULL;
1023         }
1024     }
1025
1026     return TRUE;
1027 }
1028
1029
1030 /**************************************************************************
1031  * Str_GetPtrWtoA [internal]
1032  *
1033  * Converts a unicode string into a multi byte string
1034  *
1035  * PARAMS
1036  *     lpSrc   [I] Pointer to the unicode source string
1037  *     lpDest  [O] Pointer to caller supplied storage for the multi byte string
1038  *     nMaxLen [I] Size, in bytes, of the destination buffer
1039  *
1040  * RETURNS
1041  *     Length, in bytes, of the converted string.
1042  */
1043
1044 INT Str_GetPtrWtoA (LPCWSTR lpSrc, LPSTR lpDest, INT nMaxLen)
1045 {
1046     INT len;
1047
1048     TRACE("(%s %p %d)\n", debugstr_w(lpSrc), lpDest, nMaxLen);
1049
1050     if (!lpDest && lpSrc)
1051         return WideCharToMultiByte(CP_ACP, 0, lpSrc, -1, 0, 0, NULL, NULL);
1052
1053     if (nMaxLen == 0)
1054         return 0;
1055
1056     if (lpSrc == NULL) {
1057         lpDest[0] = '\0';
1058         return 0;
1059     }
1060
1061     len = WideCharToMultiByte(CP_ACP, 0, lpSrc, -1, 0, 0, NULL, NULL);
1062     if (len >= nMaxLen)
1063         len = nMaxLen - 1;
1064
1065     WideCharToMultiByte(CP_ACP, 0, lpSrc, -1, lpDest, len, NULL, NULL);
1066     lpDest[len] = '\0';
1067
1068     return len;
1069 }
1070
1071
1072 /**************************************************************************
1073  * Str_SetPtrAtoW [internal]
1074  *
1075  * Converts a multi byte string to a unicode string.
1076  * If the pointer to the destination buffer is NULL a buffer is allocated.
1077  * If the destination buffer is too small to keep the converted multi byte
1078  * string the destination buffer is reallocated. If the source pointer is
1079  * NULL, the destination buffer is freed.
1080  *
1081  * PARAMS
1082  *     lppDest [I/O] pointer to a pointer to the destination buffer
1083  *     lpSrc   [I] pointer to a multi byte string
1084  *
1085  * RETURNS
1086  *     TRUE: conversion successful
1087  *     FALSE: error
1088  */
1089 BOOL Str_SetPtrAtoW (LPWSTR *lppDest, LPCSTR lpSrc)
1090 {
1091     TRACE("(%p %s)\n", lppDest, lpSrc);
1092
1093     if (lpSrc) {
1094         INT len = MultiByteToWideChar(CP_ACP,0,lpSrc,-1,NULL,0);
1095         LPWSTR ptr = ReAlloc (*lppDest, len*sizeof(WCHAR));
1096
1097         if (!ptr)
1098             return FALSE;
1099         MultiByteToWideChar(CP_ACP,0,lpSrc,-1,ptr,len);
1100         *lppDest = ptr;
1101     }
1102     else {
1103         if (*lppDest) {
1104             Free (*lppDest);
1105             *lppDest = NULL;
1106         }
1107     }
1108
1109     return TRUE;
1110 }
1111
1112
1113 /**************************************************************************
1114  * Notification functions
1115  */
1116
1117 typedef struct tagNOTIFYDATA
1118 {
1119     HWND hwndFrom;
1120     HWND hwndTo;
1121     DWORD  dwParam3;
1122     DWORD  dwParam4;
1123     DWORD  dwParam5;
1124     DWORD  dwParam6;
1125 } NOTIFYDATA, *LPNOTIFYDATA;
1126
1127
1128 /**************************************************************************
1129  * DoNotify [Internal]
1130  */
1131
1132 static LRESULT DoNotify (LPNOTIFYDATA lpNotify, UINT uCode, LPNMHDR lpHdr)
1133 {
1134     NMHDR nmhdr;
1135     LPNMHDR lpNmh = NULL;
1136     UINT idFrom = 0;
1137
1138     TRACE("(%p %p %d %p 0x%08lx)\n",
1139            lpNotify->hwndFrom, lpNotify->hwndTo, uCode, lpHdr,
1140            lpNotify->dwParam5);
1141
1142     if (!lpNotify->hwndTo)
1143         return 0;
1144
1145     if (lpNotify->hwndFrom == (HWND)-1) {
1146         lpNmh = lpHdr;
1147         idFrom = lpHdr->idFrom;
1148     }
1149     else {
1150         if (lpNotify->hwndFrom)
1151             idFrom = GetDlgCtrlID (lpNotify->hwndFrom);
1152
1153         lpNmh = (lpHdr) ? lpHdr : &nmhdr;
1154
1155         lpNmh->hwndFrom = lpNotify->hwndFrom;
1156         lpNmh->idFrom = idFrom;
1157         lpNmh->code = uCode;
1158     }
1159
1160     return SendMessageW (lpNotify->hwndTo, WM_NOTIFY, idFrom, (LPARAM)lpNmh);
1161 }
1162
1163
1164 /**************************************************************************
1165  * SendNotify [COMCTL32.341]
1166  *
1167  * Sends a WM_NOTIFY message to the specified window.
1168  *
1169  * PARAMS
1170  *     hwndTo   [I] Window to receive the message
1171  *     hwndFrom [I] Window that the message is from (see notes)
1172  *     uCode    [I] Notification code
1173  *     lpHdr    [I] The NMHDR and any additional information to send or NULL
1174  *
1175  * RETURNS
1176  *     Success: return value from notification
1177  *     Failure: 0
1178  *
1179  * NOTES
1180  *     If hwndFrom is -1 then the identifier of the control sending the
1181  *     message is taken from the NMHDR structure.
1182  *     If hwndFrom is not -1 then lpHdr can be NULL.
1183  */
1184 LRESULT WINAPI SendNotify (HWND hwndTo, HWND hwndFrom, UINT uCode, LPNMHDR lpHdr)
1185 {
1186     NOTIFYDATA notify;
1187
1188     TRACE("(%p %p %d %p)\n",
1189            hwndTo, hwndFrom, uCode, lpHdr);
1190
1191     notify.hwndFrom = hwndFrom;
1192     notify.hwndTo   = hwndTo;
1193     notify.dwParam5 = 0;
1194     notify.dwParam6 = 0;
1195
1196     return DoNotify (&notify, uCode, lpHdr);
1197 }
1198
1199
1200 /**************************************************************************
1201  * SendNotifyEx [COMCTL32.342]
1202  *
1203  * Sends a WM_NOTIFY message to the specified window.
1204  *
1205  * PARAMS
1206  *     hwndFrom [I] Window to receive the message
1207  *     hwndTo   [I] Window that the message is from
1208  *     uCode    [I] Notification code
1209  *     lpHdr    [I] The NMHDR and any additional information to send or NULL
1210  *     dwParam5 [I] Unknown
1211  *
1212  * RETURNS
1213  *     Success: return value from notification
1214  *     Failure: 0
1215  *
1216  * NOTES
1217  *     If hwndFrom is -1 then the identifier of the control sending the
1218  *     message is taken from the NMHDR structure.
1219  *     If hwndFrom is not -1 then lpHdr can be NULL.
1220  */
1221 LRESULT WINAPI SendNotifyEx (HWND hwndTo, HWND hwndFrom, UINT uCode,
1222                              LPNMHDR lpHdr, DWORD dwParam5)
1223 {
1224     NOTIFYDATA notify;
1225     HWND hwndNotify;
1226
1227     TRACE("(%p %p %d %p 0x%08lx)\n",
1228            hwndFrom, hwndTo, uCode, lpHdr, dwParam5);
1229
1230     hwndNotify = hwndTo;
1231     if (!hwndTo) {
1232         if (IsWindow (hwndFrom)) {
1233             hwndNotify = GetParent (hwndFrom);
1234             if (!hwndNotify)
1235                 return 0;
1236         }
1237     }
1238
1239     notify.hwndFrom = hwndFrom;
1240     notify.hwndTo   = hwndNotify;
1241     notify.dwParam5 = dwParam5;
1242     notify.dwParam6 = 0;
1243
1244     return DoNotify (&notify, uCode, lpHdr);
1245 }