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
22 #include "wine/port.h"
26 #include <sys/types.h>
38 #include "wine/debug.h"
44 #include "shell32_main.h"
45 #include "undocshell.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(shell
);
50 /********************** THE ICON CACHE ********************************/
52 #define INVALID_INDEX -1
56 LPWSTR sSourceFile
; /* file (not path!) containing the icon */
57 DWORD dwSourceIndex
; /* index within the file, if it is a resoure ID it will be negated */
58 DWORD dwListIndex
; /* index within the iconlist */
59 DWORD dwFlags
; /* GIL_* flags */
61 } SIC_ENTRY
, * LPSIC_ENTRY
;
63 static HDPA sic_hdpa
= 0;
65 static CRITICAL_SECTION SHELL32_SicCS
;
66 static CRITICAL_SECTION_DEBUG critsect_debug
=
69 { &critsect_debug
.ProcessLocksList
, &critsect_debug
.ProcessLocksList
},
70 0, 0, { 0, (DWORD
)(__FILE__
": SHELL32_SicCS") }
72 static CRITICAL_SECTION SHELL32_SicCS
= { &critsect_debug
, -1, 0, 0, 0, 0 };
74 /*****************************************************************************
78 * Callback for DPA_Search
80 static INT CALLBACK
SIC_CompareEntries( LPVOID p1
, LPVOID p2
, LPARAM lparam
)
81 { TRACE("%p %p %8lx\n", p1
, p2
, lparam
);
83 if (((LPSIC_ENTRY
)p1
)->dwSourceIndex
!= ((LPSIC_ENTRY
)p2
)->dwSourceIndex
) /* first the faster one*/
86 if (strcmpiW(((LPSIC_ENTRY
)p1
)->sSourceFile
,((LPSIC_ENTRY
)p2
)->sSourceFile
))
91 /*****************************************************************************
92 * SIC_IconAppend [internal]
95 * appends an icon pair to the end of the cache
97 static INT
SIC_IconAppend (LPCWSTR sSourceFile
, INT dwSourceIndex
, HICON hSmallIcon
, HICON hBigIcon
)
99 INT ret
, index
, index1
;
100 WCHAR path
[MAX_PATH
];
101 TRACE("%s %i %p %p\n", debugstr_w(sSourceFile
), dwSourceIndex
, hSmallIcon
,hBigIcon
);
103 lpsice
= (LPSIC_ENTRY
) SHAlloc (sizeof (SIC_ENTRY
));
105 GetFullPathNameW(sSourceFile
, MAX_PATH
, path
, NULL
);
106 lpsice
->sSourceFile
= HeapAlloc( GetProcessHeap(), 0, (strlenW(path
)+1)*sizeof(WCHAR
) );
107 strcpyW( lpsice
->sSourceFile
, path
);
109 lpsice
->dwSourceIndex
= dwSourceIndex
;
111 EnterCriticalSection(&SHELL32_SicCS
);
113 index
= DPA_InsertPtr(sic_hdpa
, 0x7fff, lpsice
);
114 if ( INVALID_INDEX
== index
)
116 HeapFree(GetProcessHeap(), 0, lpsice
->sSourceFile
);
122 index
= ImageList_AddIcon (ShellSmallIconList
, hSmallIcon
);
123 index1
= ImageList_AddIcon (ShellBigIconList
, hBigIcon
);
127 FIXME("iconlists out of sync 0x%x 0x%x\n", index
, index1
);
129 lpsice
->dwListIndex
= index
;
130 ret
= lpsice
->dwListIndex
;
133 LeaveCriticalSection(&SHELL32_SicCS
);
136 /****************************************************************************
137 * SIC_LoadIcon [internal]
140 * gets small/big icon by number from a file
142 static INT
SIC_LoadIcon (LPCWSTR sSourceFile
, INT dwSourceIndex
)
143 { HICON hiconLarge
=0;
146 #if defined(__CYGWIN__) || defined (__MINGW32__) || defined(_MSC_VER)
147 static UINT (WINAPI
*PrivateExtractIconExW
)(LPCWSTR
,int,HICON
*,HICON
*,UINT
) = NULL
;
149 if (!PrivateExtractIconExW
) {
150 HMODULE hUser32
= GetModuleHandleA("user32");
151 PrivateExtractIconExW
= (UINT(WINAPI
*)(LPCWSTR
,int,HICON
*,HICON
*,UINT
)) GetProcAddress(hUser32
, "PrivateExtractIconExW");
154 if (PrivateExtractIconExW
)
155 PrivateExtractIconExW(sSourceFile
, dwSourceIndex
, &hiconLarge
, &hiconSmall
, 1);
159 PrivateExtractIconsW(sSourceFile
, dwSourceIndex
, 32, 32, &hiconLarge
, NULL
, 1, 0);
160 PrivateExtractIconsW(sSourceFile
, dwSourceIndex
, 16, 16, &hiconSmall
, NULL
, 1, 0);
163 if ( !hiconLarge
|| !hiconSmall
)
165 WARN("failure loading icon %i from %s (%p %p)\n", dwSourceIndex
, debugstr_w(sSourceFile
), hiconLarge
, hiconSmall
);
168 return SIC_IconAppend (sSourceFile
, dwSourceIndex
, hiconSmall
, hiconLarge
);
170 /*****************************************************************************
171 * SIC_GetIconIndex [internal]
174 * sSourceFile [IN] filename of file containing the icon
175 * index [IN] index/resID (negated) in this file
178 * look in the cache for a proper icon. if not available the icon is taken
179 * from the file and cached
181 INT
SIC_GetIconIndex (LPCWSTR sSourceFile
, INT dwSourceIndex
)
184 INT ret
, index
= INVALID_INDEX
;
185 WCHAR path
[MAX_PATH
];
187 TRACE("%s %i\n", debugstr_w(sSourceFile
), dwSourceIndex
);
189 GetFullPathNameW(sSourceFile
, MAX_PATH
, path
, NULL
);
190 sice
.sSourceFile
= path
;
191 sice
.dwSourceIndex
= dwSourceIndex
;
193 EnterCriticalSection(&SHELL32_SicCS
);
195 if (NULL
!= DPA_GetPtr (sic_hdpa
, 0))
197 /* search linear from position 0*/
198 index
= DPA_Search (sic_hdpa
, &sice
, 0, SIC_CompareEntries
, 0, 0);
201 if ( INVALID_INDEX
== index
)
203 ret
= SIC_LoadIcon (sSourceFile
, dwSourceIndex
);
208 ret
= ((LPSIC_ENTRY
)DPA_GetPtr(sic_hdpa
, index
))->dwListIndex
;
211 LeaveCriticalSection(&SHELL32_SicCS
);
214 /*****************************************************************************
215 * SIC_Initialize [internal]
218 * hack to load the resources from the shell32.dll under a different dll name
219 * will be removed when the resource-compiler is ready
221 BOOL
SIC_Initialize(void)
225 int cx_small
, cy_small
;
226 int cx_large
, cy_large
;
228 cx_small
= GetSystemMetrics(SM_CXSMICON
);
229 cy_small
= GetSystemMetrics(SM_CYSMICON
);
230 cx_large
= GetSystemMetrics(SM_CXICON
);
231 cy_large
= GetSystemMetrics(SM_CYICON
);
235 if (sic_hdpa
) /* already initialized?*/
238 sic_hdpa
= DPA_Create(16);
245 ShellSmallIconList
= ImageList_Create(16,16,ILC_COLOR32
|ILC_MASK
,0,0x20);
246 ShellBigIconList
= ImageList_Create(32,32,ILC_COLOR32
|ILC_MASK
,0,0x20);
248 ImageList_SetBkColor(ShellSmallIconList
, CLR_NONE
);
249 ImageList_SetBkColor(ShellBigIconList
, CLR_NONE
);
251 for (index
=1; index
<39; index
++)
253 hSm
= (HICON
)LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(index
), IMAGE_ICON
, cx_small
, cy_small
, LR_SHARED
);
254 hLg
= (HICON
)LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(index
), IMAGE_ICON
, cx_large
, cy_large
, LR_SHARED
);
258 hSm
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(1), IMAGE_ICON
, cx_small
, cy_small
, LR_SHARED
);
259 hLg
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(1), IMAGE_ICON
, cx_large
, cy_large
, LR_SHARED
);
261 SIC_IconAppend (swShell32Name
, index
, hSm
, hLg
);
264 TRACE("hIconSmall=%p hIconBig=%p\n",ShellSmallIconList
, ShellBigIconList
);
268 /*************************************************************************
273 static INT CALLBACK
sic_free( LPVOID ptr
, LPVOID lparam
)
275 HeapFree(GetProcessHeap(), 0, ((LPSIC_ENTRY
)ptr
)->sSourceFile
);
280 void SIC_Destroy(void)
284 EnterCriticalSection(&SHELL32_SicCS
);
286 if (sic_hdpa
) DPA_DestroyCallback(sic_hdpa
, sic_free
, NULL
);
289 ImageList_Destroy(ShellSmallIconList
);
290 ShellSmallIconList
= 0;
291 ImageList_Destroy(ShellBigIconList
);
292 ShellBigIconList
= 0;
294 LeaveCriticalSection(&SHELL32_SicCS
);
295 DeleteCriticalSection(&SHELL32_SicCS
);
298 /*************************************************************************
299 * Shell_GetImageList [SHELL32.71]
302 * imglist[1|2] [OUT] pointer which receives imagelist handles
305 BOOL WINAPI
Shell_GetImageList(HIMAGELIST
* lpBigList
, HIMAGELIST
* lpSmallList
)
306 { TRACE("(%p,%p)\n",lpBigList
,lpSmallList
);
308 { *lpBigList
= ShellBigIconList
;
311 { *lpSmallList
= ShellSmallIconList
;
317 /*************************************************************************
318 * PidlToSicIndex [INTERNAL]
321 * sh [IN] IShellFolder
325 * pIndex [OUT] index within the SIC
328 BOOL
PidlToSicIndex (
336 WCHAR szIconFile
[MAX_PATH
]; /* file containing the icon */
337 INT iSourceIndex
; /* index or resID(negated) in this file */
341 TRACE("sf=%p pidl=%p %s\n", sh
, pidl
, bBigIcon
?"Big":"Small");
343 if (SUCCEEDED (IShellFolder_GetUIObjectOf(sh
, 0, 1, &pidl
, &IID_IExtractIconW
, 0, (void **)&ei
)))
345 if (SUCCEEDED(IExtractIconW_GetIconLocation(ei
, uFlags
, szIconFile
, MAX_PATH
, &iSourceIndex
, &dwFlags
)))
347 *pIndex
= SIC_GetIconIndex(szIconFile
, iSourceIndex
);
350 IExtractIconW_Release(ei
);
353 if (INVALID_INDEX
== *pIndex
) /* default icon when failed */
359 /*************************************************************************
360 * SHMapPIDLToSystemImageListIndex [SHELL32.77]
363 * sh [IN] pointer to an instance of IShellFolder
365 * pIndex [OUT][OPTIONAL] SIC index for big icon
368 int WINAPI
SHMapPIDLToSystemImageListIndex(
375 TRACE("(SF=%p,pidl=%p,%p)\n",sh
,pidl
,pIndex
);
379 if (!PidlToSicIndex ( sh
, pidl
, 1, 0, pIndex
))
382 if (!PidlToSicIndex ( sh
, pidl
, 0, 0, &Index
))
388 /*************************************************************************
389 * Shell_GetCachedImageIndex [SHELL32.72]
392 INT WINAPI
Shell_GetCachedImageIndexA(LPCSTR szPath
, INT nIndex
, BOOL bSimulateDoc
)
397 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_a(szPath
), nIndex
, bSimulateDoc
);
399 len
= MultiByteToWideChar( CP_ACP
, 0, szPath
, -1, NULL
, 0 );
400 szTemp
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) );
401 MultiByteToWideChar( CP_ACP
, 0, szPath
, -1, szTemp
, len
);
403 ret
= SIC_GetIconIndex( szTemp
, nIndex
);
405 HeapFree( GetProcessHeap(), 0, szTemp
);
410 INT WINAPI
Shell_GetCachedImageIndexW(LPCWSTR szPath
, INT nIndex
, BOOL bSimulateDoc
)
412 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_w(szPath
), nIndex
, bSimulateDoc
);
414 return SIC_GetIconIndex(szPath
, nIndex
);
417 INT WINAPI
Shell_GetCachedImageIndexAW(LPCVOID szPath
, INT nIndex
, BOOL bSimulateDoc
)
418 { if( SHELL_OsIsUnicode())
419 return Shell_GetCachedImageIndexW(szPath
, nIndex
, bSimulateDoc
);
420 return Shell_GetCachedImageIndexA(szPath
, nIndex
, bSimulateDoc
);
423 /*************************************************************************
424 * ExtractIconEx [SHELL32.@]
426 UINT WINAPI
ExtractIconExAW(LPCVOID lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
427 { if (SHELL_OsIsUnicode())
428 return ExtractIconExW ( lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
429 return ExtractIconExA ( lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
432 /*************************************************************************
433 * ExtractIconExW [SHELL32.@]
436 * -1 file is not valid
437 * or number of icons extracted
439 UINT WINAPI
ExtractIconExW(LPCWSTR lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
441 /* get entry point of undocumented function PrivateExtractIconExW() in user32 */
442 #if defined(__CYGWIN__) || defined (__MINGW32__) || defined(_MSC_VER)
443 static UINT (WINAPI
*PrivateExtractIconExW
)(LPCWSTR
,int,HICON
*,HICON
*,UINT
) = NULL
;
445 if (!PrivateExtractIconExW
) {
446 HMODULE hUser32
= GetModuleHandleA("user32");
447 PrivateExtractIconExW
= (UINT(WINAPI
*)(LPCWSTR
,int,HICON
*,HICON
*,UINT
)) GetProcAddress(hUser32
, "PrivateExtractIconExW");
449 if (!PrivateExtractIconExW
)
454 TRACE("%s %i %p %p %i\n", debugstr_w(lpszFile
), nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
456 return PrivateExtractIconExW(lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
459 /*************************************************************************
460 * ExtractIconExA [SHELL32.@]
462 UINT WINAPI
ExtractIconExA(LPCSTR lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
465 INT len
= MultiByteToWideChar(CP_ACP
, 0, lpszFile
, -1, NULL
, 0);
466 LPWSTR lpwstrFile
= HeapAlloc(GetProcessHeap(), 0, len
* sizeof(WCHAR
));
468 TRACE("%s %i %p %p %i\n", lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
470 MultiByteToWideChar(CP_ACP
, 0, lpszFile
, -1, lpwstrFile
, len
);
471 ret
= ExtractIconExW (lpwstrFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
472 HeapFree(GetProcessHeap(), 0, lpwstrFile
);
476 /*************************************************************************
477 * ExtractAssociatedIconA (SHELL32.@)
479 * Return icon for given file (either from file itself or from associated
480 * executable) and patch parameters if needed.
482 HICON WINAPI
ExtractAssociatedIconA(HINSTANCE hInst
, LPSTR lpIconPath
, LPWORD lpiIcon
)
490 lpiIcon
= &wDummyIcon
;
492 hIcon
= ExtractIconA(hInst
, lpIconPath
, *lpiIcon
);
494 if( hIcon
< (HICON
)2 )
495 { if( hIcon
== (HICON
)1 ) /* no icons found in given file */
496 { char tempPath
[0x80];
497 HINSTANCE uRet
= FindExecutableA(lpIconPath
,NULL
,tempPath
);
499 if( uRet
> (HINSTANCE
)32 && tempPath
[0] )
500 { strcpy(lpIconPath
,tempPath
);
501 hIcon
= ExtractIconA(hInst
, lpIconPath
, *lpiIcon
);
502 if( hIcon
> (HICON
)2 )
508 if( hIcon
== (HICON
)1 )
509 *lpiIcon
= 2; /* MSDOS icon - we found .exe but no icons in it */
511 *lpiIcon
= 6; /* generic icon - found nothing */
513 if (GetModuleFileNameA(hInst
, lpIconPath
, 0x80))
515 /* terminate string (GetModuleFileName doesn't do if buffer is too small) */
516 lpIconPath
[0x80 - 1] = '\0';
517 hIcon
= LoadIconA( hInst
, MAKEINTRESOURCEA(*lpiIcon
));
523 /*************************************************************************
524 * ExtractAssociatedIconExW (SHELL32.@)
526 * Return icon for given file (either from file itself or from associated
527 * executable) and patch parameters if needed.
529 HICON WINAPI
ExtractAssociatedIconExW(HINSTANCE hInst
, LPWSTR lpIconPath
, LPWORD lpiIconIdx
, LPWORD lpiIconId
)
531 FIXME("%p %s %p %p): stub\n", hInst
, debugstr_w(lpIconPath
), lpiIconIdx
, lpiIconId
);
535 /*************************************************************************
536 * ExtractAssociatedIconExA (SHELL32.@)
538 * Return icon for given file (either from file itself or from associated
539 * executable) and patch parameters if needed.
541 HICON WINAPI
ExtractAssociatedIconExA(HINSTANCE hInst
, LPSTR lpIconPath
, LPWORD lpiIconIdx
, LPWORD lpiIconId
)
544 INT len
= MultiByteToWideChar( CP_ACP
, 0, lpIconPath
, -1, NULL
, 0 );
545 LPWSTR lpwstrFile
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) );
547 TRACE("%p %s %p %p)\n", hInst
, lpIconPath
, lpiIconIdx
, lpiIconId
);
549 MultiByteToWideChar( CP_ACP
, 0, lpIconPath
, -1, lpwstrFile
, len
);
550 ret
= ExtractAssociatedIconExW(hInst
, lpwstrFile
, lpiIconIdx
, lpiIconId
);
551 HeapFree(GetProcessHeap(), 0, lpwstrFile
);
556 /****************************************************************************
557 * SHDefExtractIconW [SHELL32.@]
559 HRESULT WINAPI
SHDefExtractIconW(LPCWSTR pszIconFile
, int iIndex
, UINT uFlags
,
560 HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIconSize
)
564 WARN("%s %d 0x%08x %p %p %d, semi-stub\n", debugstr_w(pszIconFile
), iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
566 ret
= PrivateExtractIconsW(pszIconFile
, iIndex
, nIconSize
, nIconSize
, hIcons
, NULL
, 2, LR_DEFAULTCOLOR
);
567 /* FIXME: deal with uFlags parameter which contains GIL_ flags */
568 if (ret
== 0xFFFFFFFF)
571 *phiconLarge
= hIcons
[0];
572 *phiconSmall
= hIcons
[1];
578 /****************************************************************************
579 * SHDefExtractIconA [SHELL32.@]
581 HRESULT WINAPI
SHDefExtractIconA(LPCSTR pszIconFile
, int iIndex
, UINT uFlags
,
582 HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIconSize
)
585 INT len
= MultiByteToWideChar(CP_ACP
, 0, pszIconFile
, -1, NULL
, 0);
586 LPWSTR lpwstrFile
= HeapAlloc(GetProcessHeap(), 0, len
* sizeof(WCHAR
));
588 TRACE("%s %d 0x%08x %p %p %d\n", pszIconFile
, iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
590 MultiByteToWideChar(CP_ACP
, 0, pszIconFile
, -1, lpwstrFile
, len
);
591 ret
= SHDefExtractIconW(lpwstrFile
, iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
592 HeapFree(GetProcessHeap(), 0, lpwstrFile
);