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
24 #include <sys/types.h>
33 #include "wine/winuser16.h"
34 #include "wine/winbase16.h"
36 #include "wine/debug.h"
41 #include "shell32_main.h"
42 #include "undocshell.h"
45 WINE_DEFAULT_DEBUG_CHANNEL(shell);
47 /********************** THE ICON CACHE ********************************/
49 #define INVALID_INDEX -1
53 LPSTR sSourceFile; /* file (not path!) containing the icon */
54 DWORD dwSourceIndex; /* index within the file, if it is a resoure ID it will be negated */
55 DWORD dwListIndex; /* index within the iconlist */
56 DWORD dwFlags; /* GIL_* flags */
58 } SIC_ENTRY, * LPSIC_ENTRY;
60 static HDPA sic_hdpa = 0;
62 static CRITICAL_SECTION SHELL32_SicCS;
63 static CRITICAL_SECTION_DEBUG critsect_debug =
66 { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
67 0, 0, { 0, (DWORD)(__FILE__ ": SHELL32_SicCS") }
69 static CRITICAL_SECTION SHELL32_SicCS = { &critsect_debug, -1, 0, 0, 0, 0 };
71 /*****************************************************************************
75 * Callback for DPA_Search
77 static INT CALLBACK SIC_CompareEntries( LPVOID p1, LPVOID p2, LPARAM lparam)
78 { TRACE("%p %p %8lx\n", p1, p2, lparam);
80 if (((LPSIC_ENTRY)p1)->dwSourceIndex != ((LPSIC_ENTRY)p2)->dwSourceIndex) /* first the faster one*/
83 if (strcasecmp(((LPSIC_ENTRY)p1)->sSourceFile,((LPSIC_ENTRY)p2)->sSourceFile))
88 /*****************************************************************************
89 * SIC_IconAppend [internal]
92 * appends a icon pair to the end of the cache
94 static INT SIC_IconAppend (LPCSTR sSourceFile, INT dwSourceIndex, HICON hSmallIcon, HICON hBigIcon)
96 INT ret, index, index1;
98 TRACE("%s %i %p %p\n", sSourceFile, dwSourceIndex, hSmallIcon ,hBigIcon);
100 lpsice = (LPSIC_ENTRY) SHAlloc (sizeof (SIC_ENTRY));
102 path = PathFindFileNameA(sSourceFile);
103 lpsice->sSourceFile = HeapAlloc( GetProcessHeap(), 0, strlen(path)+1 );
104 strcpy( lpsice->sSourceFile, path );
106 lpsice->dwSourceIndex = dwSourceIndex;
108 EnterCriticalSection(&SHELL32_SicCS);
110 index = DPA_InsertPtr(sic_hdpa, 0x7fff, lpsice);
111 if ( INVALID_INDEX == index )
118 index = ImageList_AddIcon (ShellSmallIconList, hSmallIcon);
119 index1= ImageList_AddIcon (ShellBigIconList, hBigIcon);
123 FIXME("iconlists out of sync 0x%x 0x%x\n", index, index1);
125 lpsice->dwListIndex = index;
126 ret = lpsice->dwListIndex;
129 LeaveCriticalSection(&SHELL32_SicCS);
132 /****************************************************************************
133 * SIC_LoadIcon [internal]
136 * gets small/big icon by number from a file
138 static INT SIC_LoadIcon (LPCSTR sSourceFile, INT dwSourceIndex)
139 { HICON hiconLarge=0;
142 PrivateExtractIconsA( sSourceFile, dwSourceIndex, 32, 32, &hiconLarge, 0, 1, 0 );
143 PrivateExtractIconsA( sSourceFile, dwSourceIndex, 16, 16, &hiconSmall, 0, 1, 0 );
145 if ( !hiconLarge || !hiconSmall)
147 WARN("failure loading icon %i from %s (%p %p)\n", dwSourceIndex, sSourceFile, hiconLarge, hiconSmall);
150 return SIC_IconAppend (sSourceFile, dwSourceIndex, hiconSmall, hiconLarge);
152 /*****************************************************************************
153 * SIC_GetIconIndex [internal]
156 * sSourceFile [IN] filename of file containing the icon
157 * index [IN] index/resID (negated) in this file
160 * look in the cache for a proper icon. if not available the icon is taken
161 * from the file and cached
163 INT SIC_GetIconIndex (LPCSTR sSourceFile, INT dwSourceIndex )
165 INT ret, index = INVALID_INDEX;
167 TRACE("%s %i\n", sSourceFile, dwSourceIndex);
169 sice.sSourceFile = PathFindFileNameA(sSourceFile);
170 sice.dwSourceIndex = dwSourceIndex;
172 EnterCriticalSection(&SHELL32_SicCS);
174 if (NULL != DPA_GetPtr (sic_hdpa, 0))
176 /* search linear from position 0*/
177 index = DPA_Search (sic_hdpa, &sice, 0, SIC_CompareEntries, 0, 0);
180 if ( INVALID_INDEX == index )
182 ret = SIC_LoadIcon (sSourceFile, dwSourceIndex);
187 ret = ((LPSIC_ENTRY)DPA_GetPtr(sic_hdpa, index))->dwListIndex;
190 LeaveCriticalSection(&SHELL32_SicCS);
193 /****************************************************************************
194 * SIC_GetIcon [internal]
197 * retrieves the specified icon from the iconcache. if not found tries to load the icon
199 static HICON WINE_UNUSED SIC_GetIcon (LPCSTR sSourceFile, INT dwSourceIndex, BOOL bSmallIcon )
202 TRACE("%s %i\n", sSourceFile, dwSourceIndex);
204 index = SIC_GetIconIndex(sSourceFile, dwSourceIndex);
206 if (INVALID_INDEX == index)
208 return (HICON)INVALID_INDEX;
212 return ImageList_GetIcon(ShellSmallIconList, index, ILD_NORMAL);
213 return ImageList_GetIcon(ShellBigIconList, index, ILD_NORMAL);
216 /*****************************************************************************
217 * SIC_Initialize [internal]
220 * hack to load the resources from the shell32.dll under a different dll name
221 * will be removed when the resource-compiler is ready
223 BOOL SIC_Initialize(void)
230 if (sic_hdpa) /* already initialized?*/
233 sic_hdpa = DPA_Create(16);
240 ShellSmallIconList = ImageList_Create(16,16,ILC_COLORDDB | ILC_MASK,0,0x20);
241 ShellBigIconList = ImageList_Create(32,32,ILC_COLORDDB | ILC_MASK,0,0x20);
243 ImageList_SetBkColor(ShellSmallIconList, GetSysColor(COLOR_WINDOW));
244 ImageList_SetBkColor(ShellBigIconList, GetSysColor(COLOR_WINDOW));
246 for (index=1; index<39; index++)
248 hSm = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, 16, 16,LR_SHARED);
249 hLg = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(index), IMAGE_ICON, 32, 32,LR_SHARED);
253 hSm = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(0), IMAGE_ICON, 16, 16,LR_SHARED);
254 hLg = LoadImageA(shell32_hInstance, MAKEINTRESOURCEA(0), IMAGE_ICON, 32, 32,LR_SHARED);
256 SIC_IconAppend ("shell32.dll", index, hSm, hLg);
259 TRACE("hIconSmall=%p hIconBig=%p\n",ShellSmallIconList, ShellBigIconList);
263 /*************************************************************************
268 void SIC_Destroy(void)
275 EnterCriticalSection(&SHELL32_SicCS);
277 if (sic_hdpa && NULL != DPA_GetPtr (sic_hdpa, 0))
279 for (i=0; i < DPA_GetPtrCount(sic_hdpa); ++i)
281 lpsice = DPA_GetPtr(sic_hdpa, i);
284 DPA_Destroy(sic_hdpa);
289 LeaveCriticalSection(&SHELL32_SicCS);
290 DeleteCriticalSection(&SHELL32_SicCS);
292 /*************************************************************************
293 * Shell_GetImageList [SHELL32.71]
296 * imglist[1|2] [OUT] pointer which recive imagelist handles
299 BOOL WINAPI Shell_GetImageList(HIMAGELIST * lpBigList, HIMAGELIST * lpSmallList)
300 { TRACE("(%p,%p)\n",lpBigList,lpSmallList);
302 { *lpBigList = ShellBigIconList;
305 { *lpSmallList = ShellSmallIconList;
310 /*************************************************************************
311 * PidlToSicIndex [INTERNAL]
314 * sh [IN] IShellFolder
318 * pIndex [OUT] index within the SIC
321 BOOL PidlToSicIndex (
329 char szIconFile[MAX_PATH]; /* file containing the icon */
330 INT iSourceIndex; /* index or resID(negated) in this file */
334 TRACE("sf=%p pidl=%p %s\n", sh, pidl, bBigIcon?"Big":"Small");
336 if (SUCCEEDED (IShellFolder_GetUIObjectOf(sh, 0, 1, &pidl, &IID_IExtractIconA, 0, (void **)&ei)))
338 if (SUCCEEDED(IExtractIconA_GetIconLocation(ei, uFlags, szIconFile, MAX_PATH, &iSourceIndex, &dwFlags)))
340 *pIndex = SIC_GetIconIndex(szIconFile, iSourceIndex);
343 IExtractIconA_Release(ei);
346 if (INVALID_INDEX == *pIndex) /* default icon when failed */
353 /*************************************************************************
354 * SHMapPIDLToSystemImageListIndex [SHELL32.77]
357 * sh [IN] pointer to an instance of IShellFolder
359 * pIndex [OUT][OPTIONAL] SIC index for big icon
362 int WINAPI SHMapPIDLToSystemImageListIndex(
369 TRACE("(SF=%p,pidl=%p,%p)\n",sh,pidl,pIndex);
373 PidlToSicIndex ( sh, pidl, 1, 0, pIndex);
374 PidlToSicIndex ( sh, pidl, 0, 0, &Index);
378 /*************************************************************************
379 * Shell_GetCachedImageIndex [SHELL32.72]
382 INT WINAPI Shell_GetCachedImageIndexA(LPCSTR szPath, INT nIndex, BOOL bSimulateDoc)
384 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_a(szPath), nIndex, bSimulateDoc);
385 return SIC_GetIconIndex(szPath, nIndex);
388 INT WINAPI Shell_GetCachedImageIndexW(LPCWSTR szPath, INT nIndex, BOOL bSimulateDoc)
390 LPSTR sTemp = HEAP_strdupWtoA (GetProcessHeap(),0,szPath);
392 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_w(szPath), nIndex, bSimulateDoc);
394 ret = SIC_GetIconIndex(sTemp, nIndex);
395 HeapFree(GetProcessHeap(),0,sTemp);
399 INT WINAPI Shell_GetCachedImageIndexAW(LPCVOID szPath, INT nIndex, BOOL bSimulateDoc)
400 { if( SHELL_OsIsUnicode())
401 return Shell_GetCachedImageIndexW(szPath, nIndex, bSimulateDoc);
402 return Shell_GetCachedImageIndexA(szPath, nIndex, bSimulateDoc);
405 /*************************************************************************
406 * ExtractIconEx [SHELL32.@]
408 UINT WINAPI ExtractIconExAW(LPCVOID lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
409 { if (SHELL_OsIsUnicode())
410 return ExtractIconExW ( lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
411 return ExtractIconExA ( lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
414 /*************************************************************************
415 * ExtractIconExW [SHELL32.@]
418 * -1 file is not valid
419 * or number of icons extracted
421 UINT WINAPI ExtractIconExW(LPCWSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
423 TRACE("%s %i %p %p %i\n", debugstr_w(lpszFile), nIconIndex, phiconLarge, phiconSmall, nIcons);
425 return PrivateExtractIconExW(lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
428 /*************************************************************************
429 * ExtractIconExA [SHELL32.@]
431 UINT WINAPI ExtractIconExA(LPCSTR lpszFile, INT nIconIndex, HICON * phiconLarge, HICON * phiconSmall, UINT nIcons)
434 INT len = MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, NULL, 0);
435 LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
437 TRACE("%s %i %p %p %i\n", lpszFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
439 MultiByteToWideChar(CP_ACP, 0, lpszFile, -1, lpwstrFile, len);
440 ret = ExtractIconExW (lpwstrFile, nIconIndex, phiconLarge, phiconSmall, nIcons);
441 HeapFree(GetProcessHeap(), 0, lpwstrFile);
445 /*************************************************************************
446 * ExtractAssociatedIconA (SHELL32.@)
448 * Return icon for given file (either from file itself or from associated
449 * executable) and patch parameters if needed.
451 HICON WINAPI ExtractAssociatedIconA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIcon)
459 lpiIcon = &wDummyIcon;
461 hIcon = ExtractIconA(hInst, lpIconPath, *lpiIcon);
463 if( hIcon < (HICON)2 )
464 { if( hIcon == (HICON)1 ) /* no icons found in given file */
465 { char tempPath[0x80];
466 HINSTANCE uRet = FindExecutableA(lpIconPath,NULL,tempPath);
468 if( uRet > (HINSTANCE)32 && tempPath[0] )
469 { strcpy(lpIconPath,tempPath);
470 hIcon = ExtractIconA(hInst, lpIconPath, *lpiIcon);
471 if( hIcon > (HICON)2 )
477 if( hIcon == (HICON)1 )
478 *lpiIcon = 2; /* MSDOS icon - we found .exe but no icons in it */
480 *lpiIcon = 6; /* generic icon - found nothing */
482 GetModuleFileNameA(hInst, lpIconPath, 0x80);
483 hIcon = LoadIconA( hInst, MAKEINTRESOURCEA(*lpiIcon));
488 /*************************************************************************
489 * ExtractAssociatedIconExW (SHELL32.@)
491 * Return icon for given file (either from file itself or from associated
492 * executable) and patch parameters if needed.
494 HICON WINAPI ExtractAssociatedIconExW(HINSTANCE hInst, LPWSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
496 FIXME("%p %s %p %p): stub\n", hInst, debugstr_w(lpIconPath), lpiIconIdx, lpiIconId);
500 /*************************************************************************
501 * ExtractAssociatedIconExA (SHELL32.@)
503 * Return icon for given file (either from file itself or from associated
504 * executable) and patch parameters if needed.
506 HICON WINAPI ExtractAssociatedIconExA(HINSTANCE hInst, LPSTR lpIconPath, LPWORD lpiIconIdx, LPWORD lpiIconId)
509 INT len = MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, NULL, 0 );
510 LPWSTR lpwstrFile = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) );
512 TRACE("%p %s %p %p)\n", hInst, lpIconPath, lpiIconIdx, lpiIconId);
514 MultiByteToWideChar( CP_ACP, 0, lpIconPath, -1, lpwstrFile, len );
515 ret = ExtractAssociatedIconExW(hInst, lpwstrFile, lpiIconIdx, lpiIconId);
516 HeapFree(GetProcessHeap(), 0, lpwstrFile);
521 /****************************************************************************
522 * SHDefExtractIconW [SHELL32.@]
524 HRESULT WINAPI SHDefExtractIconW(LPCWSTR pszIconFile, int iIndex, UINT uFlags,
525 HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
529 WARN("%s %d 0x%08x %p %p %d, semi-stub\n", debugstr_w(pszIconFile), iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
531 ret = PrivateExtractIconsW(pszIconFile, iIndex, nIconSize, nIconSize, hIcons, NULL, 2, LR_DEFAULTCOLOR);
532 /* FIXME: deal with uFlags parameter which contains GIL_ flags */
533 if (ret == 0xFFFFFFFF)
536 *phiconLarge = hIcons[0];
537 *phiconSmall = hIcons[1];
543 /****************************************************************************
544 * SHDefExtractIconA [SHELL32.@]
546 HRESULT WINAPI SHDefExtractIconA(LPCSTR pszIconFile, int iIndex, UINT uFlags,
547 HICON* phiconLarge, HICON* phiconSmall, UINT nIconSize)
550 INT len = MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, NULL, 0);
551 LPWSTR lpwstrFile = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
553 TRACE("%s %d 0x%08x %p %p %d\n", pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
555 MultiByteToWideChar(CP_ACP, 0, pszIconFile, -1, lpwstrFile, len);
556 ret = SHDefExtractIconW(lpwstrFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
557 HeapFree(GetProcessHeap(), 0, lpwstrFile);