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>
35 #include "wine/winuser16.h"
36 #include "wine/winbase16.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 LPSTR 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 (strcasecmp(((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 (LPCSTR sSourceFile
, INT dwSourceIndex
, HICON hSmallIcon
, HICON hBigIcon
)
99 INT ret
, index
, index1
;
101 TRACE("%s %i %p %p\n", sSourceFile
, dwSourceIndex
, hSmallIcon
,hBigIcon
);
103 lpsice
= (LPSIC_ENTRY
) SHAlloc (sizeof (SIC_ENTRY
));
105 GetFullPathNameA(sSourceFile
, MAX_PATH
, path
, NULL
);
106 lpsice
->sSourceFile
= HeapAlloc( GetProcessHeap(), 0, strlen(path
)+1 );
107 strcpy( 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 (LPCSTR sSourceFile
, INT dwSourceIndex
)
143 { HICON hiconLarge
=0;
146 PrivateExtractIconsA( sSourceFile
, dwSourceIndex
, 32, 32, &hiconLarge
, 0, 1, 0 );
147 PrivateExtractIconsA( sSourceFile
, dwSourceIndex
, 16, 16, &hiconSmall
, 0, 1, 0 );
149 if ( !hiconLarge
|| !hiconSmall
)
151 WARN("failure loading icon %i from %s (%p %p)\n", dwSourceIndex
, sSourceFile
, hiconLarge
, hiconSmall
);
154 return SIC_IconAppend (sSourceFile
, dwSourceIndex
, hiconSmall
, hiconLarge
);
156 /*****************************************************************************
157 * SIC_GetIconIndex [internal]
160 * sSourceFile [IN] filename of file containing the icon
161 * index [IN] index/resID (negated) in this file
164 * look in the cache for a proper icon. if not available the icon is taken
165 * from the file and cached
167 INT
SIC_GetIconIndex (LPCSTR sSourceFile
, INT dwSourceIndex
)
169 INT ret
, index
= INVALID_INDEX
;
172 TRACE("%s %i\n", sSourceFile
, dwSourceIndex
);
174 GetFullPathNameA(sSourceFile
, MAX_PATH
, path
, NULL
);
175 sice
.sSourceFile
= path
;
176 sice
.dwSourceIndex
= dwSourceIndex
;
178 EnterCriticalSection(&SHELL32_SicCS
);
180 if (NULL
!= DPA_GetPtr (sic_hdpa
, 0))
182 /* search linear from position 0*/
183 index
= DPA_Search (sic_hdpa
, &sice
, 0, SIC_CompareEntries
, 0, 0);
186 if ( INVALID_INDEX
== index
)
188 ret
= SIC_LoadIcon (sSourceFile
, dwSourceIndex
);
193 ret
= ((LPSIC_ENTRY
)DPA_GetPtr(sic_hdpa
, index
))->dwListIndex
;
196 LeaveCriticalSection(&SHELL32_SicCS
);
199 /****************************************************************************
200 * SIC_GetIcon [internal]
203 * retrieves the specified icon from the iconcache. if not found tries to load the icon
205 static HICON WINE_UNUSED
SIC_GetIcon (LPCSTR sSourceFile
, INT dwSourceIndex
, BOOL bSmallIcon
)
208 TRACE("%s %i\n", sSourceFile
, dwSourceIndex
);
210 index
= SIC_GetIconIndex(sSourceFile
, dwSourceIndex
);
212 if (INVALID_INDEX
== index
)
214 return (HICON
)INVALID_INDEX
;
218 return ImageList_GetIcon(ShellSmallIconList
, index
, ILD_NORMAL
);
219 return ImageList_GetIcon(ShellBigIconList
, index
, ILD_NORMAL
);
222 /*****************************************************************************
223 * SIC_Initialize [internal]
226 * hack to load the resources from the shell32.dll under a different dll name
227 * will be removed when the resource-compiler is ready
229 BOOL
SIC_Initialize(void)
236 if (sic_hdpa
) /* already initialized?*/
239 sic_hdpa
= DPA_Create(16);
246 ShellSmallIconList
= ImageList_Create(16,16,ILC_COLOR32
|ILC_MASK
,0,0x20);
247 ShellBigIconList
= ImageList_Create(32,32,ILC_COLOR32
|ILC_MASK
,0,0x20);
249 ImageList_SetBkColor(ShellSmallIconList
, CLR_NONE
);
250 ImageList_SetBkColor(ShellBigIconList
, CLR_NONE
);
252 for (index
=1; index
<39; index
++)
254 hSm
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(index
), IMAGE_ICON
, 16, 16,LR_SHARED
);
255 hLg
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(index
), IMAGE_ICON
, 32, 32,LR_SHARED
);
259 hSm
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(0), IMAGE_ICON
, 16, 16,LR_SHARED
);
260 hLg
= LoadImageA(shell32_hInstance
, MAKEINTRESOURCEA(0), IMAGE_ICON
, 32, 32,LR_SHARED
);
262 SIC_IconAppend (sShell32Name
, index
, hSm
, hLg
);
265 TRACE("hIconSmall=%p hIconBig=%p\n",ShellSmallIconList
, ShellBigIconList
);
269 /*************************************************************************
274 static INT CALLBACK
sic_free( LPVOID ptr
, LPVOID lparam
)
276 HeapFree(GetProcessHeap(), 0, ((LPSIC_ENTRY
)ptr
)->sSourceFile
);
281 void SIC_Destroy(void)
285 EnterCriticalSection(&SHELL32_SicCS
);
287 if (sic_hdpa
) DPA_DestroyCallback(sic_hdpa
, sic_free
, NULL
);
291 LeaveCriticalSection(&SHELL32_SicCS
);
292 DeleteCriticalSection(&SHELL32_SicCS
);
294 /*************************************************************************
295 * Shell_GetImageList [SHELL32.71]
298 * imglist[1|2] [OUT] pointer which recive imagelist handles
301 BOOL WINAPI
Shell_GetImageList(HIMAGELIST
* lpBigList
, HIMAGELIST
* lpSmallList
)
302 { TRACE("(%p,%p)\n",lpBigList
,lpSmallList
);
304 { *lpBigList
= ShellBigIconList
;
307 { *lpSmallList
= ShellSmallIconList
;
312 /*************************************************************************
313 * PidlToSicIndex [INTERNAL]
316 * sh [IN] IShellFolder
320 * pIndex [OUT] index within the SIC
323 BOOL
PidlToSicIndex (
331 char szIconFile
[MAX_PATH
]; /* file containing the icon */
332 INT iSourceIndex
; /* index or resID(negated) in this file */
336 TRACE("sf=%p pidl=%p %s\n", sh
, pidl
, bBigIcon
?"Big":"Small");
338 if (SUCCEEDED (IShellFolder_GetUIObjectOf(sh
, 0, 1, &pidl
, &IID_IExtractIconA
, 0, (void **)&ei
)))
340 if (SUCCEEDED(IExtractIconA_GetIconLocation(ei
, uFlags
, szIconFile
, MAX_PATH
, &iSourceIndex
, &dwFlags
)))
342 *pIndex
= SIC_GetIconIndex(szIconFile
, iSourceIndex
);
345 IExtractIconA_Release(ei
);
348 if (INVALID_INDEX
== *pIndex
) /* default icon when failed */
355 /*************************************************************************
356 * SHMapPIDLToSystemImageListIndex [SHELL32.77]
359 * sh [IN] pointer to an instance of IShellFolder
361 * pIndex [OUT][OPTIONAL] SIC index for big icon
364 int WINAPI
SHMapPIDLToSystemImageListIndex(
371 TRACE("(SF=%p,pidl=%p,%p)\n",sh
,pidl
,pIndex
);
375 PidlToSicIndex ( sh
, pidl
, 1, 0, pIndex
);
376 PidlToSicIndex ( sh
, pidl
, 0, 0, &Index
);
380 /*************************************************************************
381 * Shell_GetCachedImageIndex [SHELL32.72]
384 INT WINAPI
Shell_GetCachedImageIndexA(LPCSTR szPath
, INT nIndex
, BOOL bSimulateDoc
)
386 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_a(szPath
), nIndex
, bSimulateDoc
);
387 return SIC_GetIconIndex(szPath
, nIndex
);
390 INT WINAPI
Shell_GetCachedImageIndexW(LPCWSTR szPath
, INT nIndex
, BOOL bSimulateDoc
)
392 LPSTR sTemp
= HEAP_strdupWtoA (GetProcessHeap(),0,szPath
);
394 WARN("(%s,%08x,%08x) semi-stub.\n",debugstr_w(szPath
), nIndex
, bSimulateDoc
);
396 ret
= SIC_GetIconIndex(sTemp
, nIndex
);
397 HeapFree(GetProcessHeap(),0,sTemp
);
401 INT WINAPI
Shell_GetCachedImageIndexAW(LPCVOID szPath
, INT nIndex
, BOOL bSimulateDoc
)
402 { if( SHELL_OsIsUnicode())
403 return Shell_GetCachedImageIndexW(szPath
, nIndex
, bSimulateDoc
);
404 return Shell_GetCachedImageIndexA(szPath
, nIndex
, bSimulateDoc
);
407 /*************************************************************************
408 * ExtractIconEx [SHELL32.@]
410 UINT WINAPI
ExtractIconExAW(LPCVOID lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
411 { if (SHELL_OsIsUnicode())
412 return ExtractIconExW ( lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
413 return ExtractIconExA ( lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
416 /*************************************************************************
417 * ExtractIconExW [SHELL32.@]
420 * -1 file is not valid
421 * or number of icons extracted
423 UINT WINAPI
ExtractIconExW(LPCWSTR lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
425 TRACE("%s %i %p %p %i\n", debugstr_w(lpszFile
), nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
427 return PrivateExtractIconExW(lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
430 /*************************************************************************
431 * ExtractIconExA [SHELL32.@]
433 UINT WINAPI
ExtractIconExA(LPCSTR lpszFile
, INT nIconIndex
, HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIcons
)
436 INT len
= MultiByteToWideChar(CP_ACP
, 0, lpszFile
, -1, NULL
, 0);
437 LPWSTR lpwstrFile
= HeapAlloc(GetProcessHeap(), 0, len
* sizeof(WCHAR
));
439 TRACE("%s %i %p %p %i\n", lpszFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
441 MultiByteToWideChar(CP_ACP
, 0, lpszFile
, -1, lpwstrFile
, len
);
442 ret
= ExtractIconExW (lpwstrFile
, nIconIndex
, phiconLarge
, phiconSmall
, nIcons
);
443 HeapFree(GetProcessHeap(), 0, lpwstrFile
);
447 /*************************************************************************
448 * ExtractAssociatedIconA (SHELL32.@)
450 * Return icon for given file (either from file itself or from associated
451 * executable) and patch parameters if needed.
453 HICON WINAPI
ExtractAssociatedIconA(HINSTANCE hInst
, LPSTR lpIconPath
, LPWORD lpiIcon
)
461 lpiIcon
= &wDummyIcon
;
463 hIcon
= ExtractIconA(hInst
, lpIconPath
, *lpiIcon
);
465 if( hIcon
< (HICON
)2 )
466 { if( hIcon
== (HICON
)1 ) /* no icons found in given file */
467 { char tempPath
[0x80];
468 HINSTANCE uRet
= FindExecutableA(lpIconPath
,NULL
,tempPath
);
470 if( uRet
> (HINSTANCE
)32 && tempPath
[0] )
471 { strcpy(lpIconPath
,tempPath
);
472 hIcon
= ExtractIconA(hInst
, lpIconPath
, *lpiIcon
);
473 if( hIcon
> (HICON
)2 )
479 if( hIcon
== (HICON
)1 )
480 *lpiIcon
= 2; /* MSDOS icon - we found .exe but no icons in it */
482 *lpiIcon
= 6; /* generic icon - found nothing */
484 GetModuleFileNameA(hInst
, lpIconPath
, 0x80);
485 hIcon
= LoadIconA( hInst
, MAKEINTRESOURCEA(*lpiIcon
));
490 /*************************************************************************
491 * ExtractAssociatedIconExW (SHELL32.@)
493 * Return icon for given file (either from file itself or from associated
494 * executable) and patch parameters if needed.
496 HICON WINAPI
ExtractAssociatedIconExW(HINSTANCE hInst
, LPWSTR lpIconPath
, LPWORD lpiIconIdx
, LPWORD lpiIconId
)
498 FIXME("%p %s %p %p): stub\n", hInst
, debugstr_w(lpIconPath
), lpiIconIdx
, lpiIconId
);
502 /*************************************************************************
503 * ExtractAssociatedIconExA (SHELL32.@)
505 * Return icon for given file (either from file itself or from associated
506 * executable) and patch parameters if needed.
508 HICON WINAPI
ExtractAssociatedIconExA(HINSTANCE hInst
, LPSTR lpIconPath
, LPWORD lpiIconIdx
, LPWORD lpiIconId
)
511 INT len
= MultiByteToWideChar( CP_ACP
, 0, lpIconPath
, -1, NULL
, 0 );
512 LPWSTR lpwstrFile
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) );
514 TRACE("%p %s %p %p)\n", hInst
, lpIconPath
, lpiIconIdx
, lpiIconId
);
516 MultiByteToWideChar( CP_ACP
, 0, lpIconPath
, -1, lpwstrFile
, len
);
517 ret
= ExtractAssociatedIconExW(hInst
, lpwstrFile
, lpiIconIdx
, lpiIconId
);
518 HeapFree(GetProcessHeap(), 0, lpwstrFile
);
523 /****************************************************************************
524 * SHDefExtractIconW [SHELL32.@]
526 HRESULT WINAPI
SHDefExtractIconW(LPCWSTR pszIconFile
, int iIndex
, UINT uFlags
,
527 HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIconSize
)
531 WARN("%s %d 0x%08x %p %p %d, semi-stub\n", debugstr_w(pszIconFile
), iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
533 ret
= PrivateExtractIconsW(pszIconFile
, iIndex
, nIconSize
, nIconSize
, hIcons
, NULL
, 2, LR_DEFAULTCOLOR
);
534 /* FIXME: deal with uFlags parameter which contains GIL_ flags */
535 if (ret
== 0xFFFFFFFF)
538 *phiconLarge
= hIcons
[0];
539 *phiconSmall
= hIcons
[1];
545 /****************************************************************************
546 * SHDefExtractIconA [SHELL32.@]
548 HRESULT WINAPI
SHDefExtractIconA(LPCSTR pszIconFile
, int iIndex
, UINT uFlags
,
549 HICON
* phiconLarge
, HICON
* phiconSmall
, UINT nIconSize
)
552 INT len
= MultiByteToWideChar(CP_ACP
, 0, pszIconFile
, -1, NULL
, 0);
553 LPWSTR lpwstrFile
= HeapAlloc(GetProcessHeap(), 0, len
* sizeof(WCHAR
));
555 TRACE("%s %d 0x%08x %p %p %d\n", pszIconFile
, iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
557 MultiByteToWideChar(CP_ACP
, 0, pszIconFile
, -1, lpwstrFile
, len
);
558 ret
= SHDefExtractIconW(lpwstrFile
, iIndex
, uFlags
, phiconLarge
, phiconSmall
, nIconSize
);
559 HeapFree(GetProcessHeap(), 0, lpwstrFile
);