2 * shell icon cache (SIC)
4 * Copyright 1998, 1999 Juergen Schmied
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <sys/types.h>
34 #include "wine/winuser16.h"
35 #include "wine/winbase16.h"
37 #include "wine/debug.h"
43 #include "shell32_main.h"
44 #include "undocshell.h"
47 WINE_DEFAULT_DEBUG_CHANNEL(shell);
49 /********************** THE ICON CACHE ********************************/
51 #define INVALID_INDEX -1
55 LPSTR sSourceFile; /* file (not path!) containing the icon */
56 DWORD dwSourceIndex; /* index within the file, if it is a resoure ID it will be negated */
57 DWORD dwListIndex; /* index within the iconlist */
58 DWORD dwFlags; /* GIL_* flags */
60 } SIC_ENTRY, * LPSIC_ENTRY;
62 static HDPA sic_hdpa = 0;
64 static CRITICAL_SECTION SHELL32_SicCS;
65 static CRITICAL_SECTION_DEBUG critsect_debug =
68 { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
69 0, 0, { 0, (DWORD)(__FILE__ ": SHELL32_SicCS") }
71 static CRITICAL_SECTION SHELL32_SicCS = { &critsect_debug, -1, 0, 0, 0, 0 };
73 /*****************************************************************************
77 * Callback for DPA_Search
79 static INT CALLBACK SIC_CompareEntries( LPVOID p1, LPVOID p2, LPARAM lparam)
80 { TRACE("%p %p %8lx\n", p1, p2, lparam);
82 if (((LPSIC_ENTRY)p1)->dwSourceIndex != ((LPSIC_ENTRY)p2)->dwSourceIndex) /* first the faster one*/
85 if (strcasecmp(((LPSIC_ENTRY)p1)->sSourceFile,((LPSIC_ENTRY)p2)->sSourceFile))
90 /*****************************************************************************
91 * SIC_IconAppend [internal]
94 * appends an icon pair to the end of the cache
96 static INT SIC_IconAppend (LPCSTR sSourceFile, INT dwSourceIndex, HICON hSmallIcon, HICON hBigIcon)
98 INT ret, index, index1;
100 TRACE("%s %i %p %p\n", sSourceFile, dwSourceIndex, hSmallIcon ,hBigIcon);
102 lpsice = (LPSIC_ENTRY) SHAlloc (sizeof (SIC_ENTRY));
104 path = PathFindFileNameA(sSourceFile);
105 lpsice->sSourceFile = HeapAlloc( GetProcessHeap(), 0, strlen(path)+1 );
106 strcpy( lpsice->sSourceFile, path );
108 lpsice->dwSourceIndex = dwSourceIndex;
110 EnterCriticalSection(&SHELL32_SicCS);
112 index = DPA_InsertPtr(sic_hdpa, 0x7fff, lpsice);
113 if ( INVALID_INDEX == index )
115 HeapFree(GetProcessHeap(), 0, lpsice->sSourceFile);
121 index = ImageList_AddIcon (ShellSmallIconList, hSmallIcon);
122 index1= ImageList_AddIcon (ShellBigIconList, hBigIcon);
126 FIXME("iconlists out of sync 0x%x 0x%x\n", index, index1);
128 lpsice->dwListIndex = index;
129 ret = lpsice->dwListIndex;
132 LeaveCriticalSection(&SHELL32_SicCS);
135 /****************************************************************************
136 * SIC_LoadIcon [internal]
139 * gets small/big icon by number from a file
141 static INT SIC_LoadIcon (LPCSTR sSourceFile, INT dwSourceIndex)
142 { HICON hiconLarge=0;
145 PrivateExtractIconsA( sSourceFile, dwSourceIndex, 32, 32, &hiconLarge, 0, 1, 0 );
146 PrivateExtractIconsA( sSourceFile, dwSourceIndex, 16, 16, &hiconSmall, 0, 1, 0 );
148 if ( !hiconLarge || !hiconSmall)
150 WARN("failure loading icon %i from %s (%p %p)\n", dwSourceIndex, sSourceFile, hiconLarge, hiconSmall);
153 return SIC_IconAppend (sSourceFile, dwSourceIndex, hiconSmall, hiconLarge);
155 /*****************************************************************************
156 * SIC_GetIconIndex [internal]
159 * sSourceFile [IN] filename of file containing the icon
160 * index [IN] index/resID (negated) in this file
163 * look in the cache for a proper icon. if not available the icon is taken
164 * from the file and cached
166 INT SIC_GetIconIndex (LPCSTR sSourceFile, INT dwSourceIndex )
168 INT ret, index = INVALID_INDEX;
170 TRACE("%s %i\n", sSourceFile, dwSourceIndex);
172 sice.sSourceFile = PathFindFileNameA(sSourceFile);
173 sice.dwSourceIndex = dwSourceIndex;
175 EnterCriticalSection(&SHELL32_SicCS);
177 if (NULL != DPA_GetPtr (sic_hdpa, 0))
179 /* search linear from position 0*/
180 index = DPA_Search (sic_hdpa, &sice, 0, SIC_CompareEntries, 0, 0);
183 if ( INVALID_INDEX == index )
185 ret = SIC_LoadIcon (sSourceFile, dwSourceIndex);
190 ret = ((LPSIC_ENTRY)DPA_GetPtr(sic_hdpa, index))->dwListIndex;
193 LeaveCriticalSection(&SHELL32_SicCS);
196 /****************************************************************************
197 * SIC_GetIcon [internal]
200 * retrieves the specified icon from the iconcache. if not found tries to load the icon
202 static HICON WINE_UNUSED SIC_GetIcon (LPCSTR sSourceFile, INT dwSourceIndex, BOOL bSmallIcon )
205 TRACE("%s %i\n", sSourceFile, dwSourceIndex);
207 index = SIC_GetIconIndex(sSourceFile, dwSourceIndex);
209 if (INVALID_INDEX == index)
211 return (HICON)INVALID_INDEX;
215 return ImageList_GetIcon(ShellSmallIconList, index, ILD_NORMAL);
216 return ImageList_GetIcon(ShellBigIconList, index, ILD_NORMAL);
219 /*****************************************************************************
220 * SIC_Initialize [internal]
223 * hack to load the resources from the shell32.dll under a different dll name
224 * will be removed when the resource-compiler is ready
226 BOOL SIC_Initialize(void)
233 if (sic_hdpa) /* already initialized?*/
236 sic_hdpa = DPA_Create(16);
243 ShellSmallIconList = ImageList_Create(16,16,ILC_COLORDDB | ILC_MASK,0,0x20);
244 ShellBigIconList = ImageList_Create(32,32,ILC_COLORDDB | ILC_MASK,0,0x20);
246 ImageList_SetBkColor(ShellSmallIconList, GetSysColor(COLOR_WINDOW));
247 ImageList_SetBkColor(ShellBigIconList, GetSysColor(COLOR_WINDOW));
249 for (index=1; index<39; index++)
251 hSm = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, 16, 16,LR_SHARED);
252 hLg = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, 32, 32,LR_SHARED);
256 hSm = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(0), IMAGE_ICON, 16, 16,LR_SHARED);
257 hLg = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(0), IMAGE_ICON, 32, 32,LR_SHARED);
259 SIC_IconAppend ("shell32.dll", index, hSm, hLg);
262 TRACE("hIconSmall=%p hIconBig=%p\n",ShellSmallIconList, ShellBigIconList);
266 /*************************************************************************
271 static INT CALLBACK sic_free( LPVOID ptr, LPVOID lparam )
273 HeapFree(GetProcessHeap(), 0, ((LPSIC_ENTRY)ptr)->sSourceFile);
278 void SIC_Destroy(void)
282 EnterCriticalSection(&SHELL32_SicCS);
284 if (sic_hdpa) DPA_DestroyCallback(sic_hdpa, sic_free, NULL );
288 LeaveCriticalSection(&SHELL32_SicCS);
289 DeleteCriticalSection(&SHELL32_SicCS);
291 /*************************************************************************
292 * Shell_GetImageList [SHELL32.71]
295 * imglist[1|2] [OUT] pointer which recive imagelist handles
298 BOOL WINAPI Shell_GetImageList(HIMAGELIST * lpBigList, HIMAGELIST * lpSmallList)
299 { TRACE("(%p,%p)\n",lpBigList,lpSmallList);
301 { *lpBigList = ShellBigIconList;
304 { *lpSmallList = ShellSmallIconList;
309 /*************************************************************************
310 * PidlToSicIndex [INTERNAL]
313 * sh [IN] IShellFolder
317 * pIndex [OUT] index within the SIC
320 BOOL PidlToSicIndex (
328 char szIconFile[MAX_PATH]; /* file containing the icon */
329 INT iSourceIndex; /* index or resID(negated) in this file */
333 TRACE("sf=%p pidl=%p %s\n", sh, pidl, bBigIcon?"Big":"Small");
335 if (SUCCEEDED (IShellFolder_GetUIObjectOf(sh, 0, 1, &pidl, &IID_IExtractIconA, 0, (void **)&ei)))
337 if (SUCCEEDED(IExtractIconA_GetIconLocation(ei, uFlags, szIconFile, MAX_PATH, &iSourceIndex, &dwFlags)))
339 *pIndex = SIC_GetIconIndex(szIconFile, iSourceIndex);
342 IExtractIconA_Release(ei);
345 if (INVALID_INDEX == *pIndex) /* default icon when failed */
352 /*************************************************************************
353 * SHMapPIDLToSystemImageListIndex [SHELL32.77]
356 * sh [IN] pointer to an instance of IShellFolder
358 * pIndex [OUT][OPTIONAL] SIC index for big icon
361 int WINAPI SHMapPIDLToSystemImageListIndex(
368 TRACE("(SF=%p,pidl=%p,%p)\n",sh,pidl,pIndex);
372 PidlToSicIndex ( sh, pidl, 1, 0, pIndex);
373 PidlToSicIndex ( sh, pidl, 0, 0, &Index);
377 /*************************************************************************
378 * Shell_GetCachedImageIndex [SHELL32.72]
381 INT WINAPI Shell_GetCachedImageIndexA(LPCSTR szPath, INT nIndex, BOOL bSimulateDoc)
383 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_a(szPath), nIndex, bSimulateDoc);
384 return SIC_GetIconIndex(szPath, nIndex);
387 INT WINAPI Shell_GetCachedImageIndexW(LPCWSTR szPath, INT nIndex, BOOL bSimulateDoc)
389 LPSTR sTemp = HEAP_strdupWtoA (GetProcessHeap(),0,szPath);
391 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_w(szPath), nIndex, bSimulateDoc);
393 ret = SIC_GetIconIndex(sTemp, nIndex);
394 HeapFree(GetProcessHeap(),0,sTemp);
398 INT WINAPI Shell_GetCachedImageIndexAW(LPCVOID szPath, INT nIndex, BOOL bSimulateDoc)
399 { if( SHELL_OsIsUnicode())
400 return Shell_GetCachedImageIndexW(szPath, nIndex, bSimulateDoc);
401 return Shell_GetCachedImageIndexA(szPath, nIndex, bSimulateDoc);
404 /*************************************************************************
405 * ExtractIconEx [SHELL32.@]
407 UINT WINAPI ExtractIconExAW(LPCVOID lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
408 { if (SHELL_OsIsUnicode())
409 return ExtractIconExW ( lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
410 return ExtractIconExA ( lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
413 /*************************************************************************
414 * ExtractIconExW [SHELL32.@]
417 * -1 file is not valid
418 * or number of icons extracted
420 UINT WINAPI ExtractIconExW(LPCWSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
422 TRACE("%s %i %p %p %i\n", debugstr_w(lpszFile), nIconIndex, phiconLarge, phiconSmall, nIcons);
424 return PrivateExtractIconExW(lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
427 /*************************************************************************
428 * ExtractIconExA [SHELL32.@]
430 UINT WINAPI ExtractIconExA(LPCSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
433 INT len = MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, NULL, 0);
434 LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
436 TRACE("%s %i %p %p %i\n", lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
438 MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, lpwstrFile, len);
439 ret = ExtractIconExW (lpwstrFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
440 HeapFree(GetProcessHeap(), 0, lpwstrFile);
444 /*************************************************************************
445 * ExtractAssociatedIconA (SHELL32.@)
447 * Return icon for given file (either from file itself or from associated
448 * executable) and patch parameters if needed.
450 HICON WINAPI ExtractAssociatedIconA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIcon)
458 lpiIcon = &wDummyIcon;
460 hIcon = ExtractIconA(hInst, lpIconPath, *lpiIcon);
462 if( hIcon < (HICON)2 )
463 { if( hIcon == (HICON)1 ) /* no icons found in given file */
464 { char tempPath[0x80];
465 HINSTANCE uRet = FindExecutableA(lpIconPath,NULL,tempPath);
467 if( uRet > (HINSTANCE)32 && tempPath[0] )
468 { strcpy(lpIconPath,tempPath);
469 hIcon = ExtractIconA(hInst, lpIconPath, *lpiIcon);
470 if( hIcon > (HICON)2 )
476 if( hIcon == (HICON)1 )
477 *lpiIcon = 2; /* MSDOS icon - we found .exe but no icons in it */
479 *lpiIcon = 6; /* generic icon - found nothing */
481 GetModuleFileNameA(hInst, lpIconPath, 0x80);
482 hIcon = LoadIconA( hInst, MAKEINTRESOURCEA(*lpiIcon));
487 /*************************************************************************
488 * ExtractAssociatedIconExW (SHELL32.@)
490 * Return icon for given file (either from file itself or from associated
491 * executable) and patch parameters if needed.
493 HICON WINAPI ExtractAssociatedIconExW(HINSTANCE hInst, LPWSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
495 FIXME("%p %s %p %p): stub\n", hInst, debugstr_w(lpIconPath), lpiIconIdx, lpiIconId);
499 /*************************************************************************
500 * ExtractAssociatedIconExA (SHELL32.@)
502 * Return icon for given file (either from file itself or from associated
503 * executable) and patch parameters if needed.
505 HICON WINAPI ExtractAssociatedIconExA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
508 INT len = MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, NULL, 0 );
509 LPWSTR lpwstrFile = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) );
511 TRACE("%p %s %p %p)\n", hInst, lpIconPath, lpiIconIdx, lpiIconId);
513 MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, lpwstrFile, len );
514 ret = ExtractAssociatedIconExW(hInst, lpwstrFile, lpiIconIdx, lpiIconId);
515 HeapFree(GetProcessHeap(), 0, lpwstrFile);
520 /****************************************************************************
521 * SHDefExtractIconW [SHELL32.@]
523 HRESULT WINAPI SHDefExtractIconW(LPCWSTR pszIconFile, int iIndex, UINT uFlags,
524 HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
528 WARN("%s %d 0x%08x %p %p %d, semi-stub\n", debugstr_w(pszIconFile), iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
530 ret = PrivateExtractIconsW(pszIconFile, iIndex, nIconSize, nIconSize, hIcons, NULL, 2, LR_DEFAULTCOLOR);
531 /* FIXME: deal with uFlags parameter which contains GIL_ flags */
532 if (ret == 0xFFFFFFFF)
535 *phiconLarge = hIcons[0];
536 *phiconSmall = hIcons[1];
542 /****************************************************************************
543 * SHDefExtractIconA [SHELL32.@]
545 HRESULT WINAPI SHDefExtractIconA(LPCSTR pszIconFile, int iIndex, UINT uFlags,
546 HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
549 INT len = MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, NULL, 0);
550 LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
552 TRACE("%s %d 0x%08x %p %p %d\n", pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
554 MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, lpwstrFile, len);
555 ret = SHDefExtractIconW(lpwstrFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
556 HeapFree(GetProcessHeap(), 0, lpwstrFile);