[SHELL32]
[reactos.git] / dll / win32 / shell32 / wine / pidl.h
1 /*
2 * internal pidl functions
3 *
4 * Copyright 1998 Juergen Schmied
5 * Copyright 2004 Juan Lang
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 *
21 * NOTES:
22 *
23 * DO NOT use these definitions outside the shell32.dll!
24 *
25 * The contents of a pidl should never be used directly from an application.
26 *
27 * Undocumented:
28 * MS says: the abID of SHITEMID should be treated as binary data and not
29 * be interpreted by applications. Applies to everyone but MS itself.
30 * Word95 interprets the contents of abID (Filesize/Date) so we have to go
31 * for binary compatibility here.
32 */
33
34 #ifndef __WINE_PIDL_H
35 #define __WINE_PIDL_H
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /*
42 * the pidl does cache fileattributes to speed up SHGetAttributes when
43 * displaying a big number of files.
44 *
45 * a pidl of NULL means the desktop
46 *
47 * The structure of the pidl seems to be a union. The first byte of the
48 * PIDLDATA describes the type of pidl.
49 *
50 * object ! first byte / ! format ! living space
51 * ! size
52 * ----------------------------------------------------------------
53 * my computer 0x1F/20 guid (2) (usual)
54 * network 0x1F guid
55 * bitbucket 0x1F guid
56 * drive 0x23/25 drive (usual)
57 * drive 0x25/25 drive (lnk/persistent)
58 * drive 0x29/25 drive
59 * shell extension 0x2E guid
60 * drive 0x2F drive (lnk/persistent)
61 * folder/file 0x30 folder/file (1) (lnk/persistent)
62 * folder 0x31 folder (usual)
63 * valueA 0x32 file (ANSI file name)
64 * valueW 0x34 file (Unicode file name)
65 * workgroup 0x41 network (3)
66 * computer 0x42 network (4)
67 * net provider 0x46 network
68 * whole network 0x47 network (5)
69 * MSITStore 0x61 htmlhlp (7)
70 * printers/ras connections 0x70 guid
71 * history/favorites 0xb1 file
72 * share 0xc3 network (6)
73 *
74 * guess: the persistent elements are non tracking
75 *
76 * (1) dummy byte is used, attributes are empty
77 * (2) IID_MyComputer = 20D04FE0L-3AEA-1069-A2D8-08002B30309D
78 * (3) two strings "workgroup" "Microsoft Network"
79 * (4) two strings "\\sirius" "Microsoft Network"
80 * (5) one string "Entire Network"
81 * (6) two strings "\\sirius\c" "Microsoft Network"
82 * (7) contains string "mk:@MSITStore:C:\path\file.chm::/path/filename.htm"
83 * GUID 871C5380-42A0-1069-A2EA-08002B30309D
84 */
85
86 #define PT_CPLAPPLET 0x00
87 #define PT_GUID 0x1F
88 #define PT_DRIVE 0x23
89 #define PT_DRIVE2 0x25
90 #define PT_DRIVE3 0x29
91 #define PT_SHELLEXT 0x2E
92 #define PT_DRIVE1 0x2F
93 #define PT_FOLDER1 0x30
94 #define PT_FOLDER 0x31
95 #define PT_VALUE 0x32
96 #define PT_VALUEW 0x34
97 #define PT_FOLDERW 0x35
98 #define PT_WORKGRP 0x41
99 #define PT_COMP 0x42
100 #define PT_NETPROVIDER 0x46
101 #define PT_NETWORK 0x47
102 #define PT_IESPECIAL1 0x61
103 #define PT_YAGUID 0x70 /* yet another guid.. */
104 #define PT_IESPECIAL2 0xb1
105 #define PT_SHARE 0xc3
106
107 #include "pshpack1.h"
108 typedef BYTE PIDLTYPE;
109
110 typedef struct tagPIDLCPanelStruct
111 {
112 BYTE dummy; /*01 is 0x00 */
113 DWORD iconIdx; /*02 negative icon ID */
114 WORD offsDispName; /*06*/
115 WORD offsComment; /*08*/
116 CHAR szName[1]; /*10*/ /* terminated by 0x00, followed by display name and comment string */
117 } PIDLCPanelStruct;
118
119 #ifdef __REACTOS__
120
121 typedef struct tagPIDLFontStruct
122 {
123 BYTE dummy;
124 WORD offsFile;
125 WCHAR szName[1];
126 } PIDLFontStruct;
127
128 typedef struct tagPIDLPrinterStruct
129 {
130 BYTE dummy;
131 DWORD Attributes;
132 WORD offsServer;
133 WCHAR szName[1];
134 } PIDLPrinterStruct;
135
136 typedef struct tagPIDLRecycleStruct
137 {
138 FILETIME LastModification;
139 FILETIME DeletionTime;
140 ULARGE_INTEGER FileSize;
141 ULARGE_INTEGER PhysicalFileSize;
142 DWORD Attributes;
143 WCHAR szName[1];
144 } PIDLRecycleStruct;
145
146 #endif /* !__REACTOS__ */
147
148 typedef struct tagGUIDStruct
149 {
150 BYTE dummy; /* offset 01 is unknown */
151 GUID guid; /* offset 02 */
152 } GUIDStruct;
153
154 typedef struct tagDriveStruct
155 {
156 CHAR szDriveName[20]; /*01*/
157 WORD unknown; /*21*/
158 } DriveStruct;
159
160 typedef struct tagFileStruct
161 {
162 BYTE dummy; /*01 is 0x00 for files or dirs */
163 DWORD dwFileSize; /*02*/
164 WORD uFileDate; /*06*/
165 WORD uFileTime; /*08*/
166 WORD uFileAttribs; /*10*/
167 CHAR szNames[1]; /*12*/
168 /* Here are coming two strings. The first is the long name.
169 The second the dos name when needed or just 0x00 */
170 } FileStruct;
171
172 /* At least on WinXP, this struct is appended with 2-byte-alignment to FileStruct. There follows
173 * a WORD member after the wszName string, which gives the offset from the beginning of the PIDL
174 * to the FileStructW member. */
175 typedef struct tagFileStructW {
176 WORD cbLen;
177 BYTE dummy1[6];
178 WORD uCreationDate;
179 WORD uCreationTime;
180 WORD uLastAccessDate;
181 WORD uLastAccessTime;
182 BYTE dummy2[4];
183 WCHAR wszName[1];
184 } FileStructW;
185
186 typedef struct tagValueW
187 {
188 WCHAR name[1];
189 } ValueWStruct;
190
191 typedef struct tagPIDLDATA
192 { PIDLTYPE type; /*00*/
193 union
194 {
195 struct tagGUIDStruct guid;
196 struct tagDriveStruct drive;
197 struct tagFileStruct file;
198 struct
199 { WORD dummy; /*01*/
200 CHAR szNames[1]; /*03*/
201 } network;
202 struct
203 { WORD dummy; /*01*/
204 DWORD dummy1; /*02*/
205 CHAR szName[1]; /*06*/ /* terminated by 0x00 0x00 */
206 } htmlhelp;
207 struct tagPIDLCPanelStruct cpanel;
208 struct tagValueW valueW;
209 #ifdef __REACTOS__
210 struct tagPIDLFontStruct cfont;
211 struct tagPIDLPrinterStruct cprinter;
212 struct tagPIDLRecycleStruct crecycle;
213 #endif
214 }u;
215 } PIDLDATA, *LPPIDLDATA;
216 #include "poppack.h"
217
218 /*
219 * getting special values from simple pidls
220 */
221 DWORD _ILSimpleGetText (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
222 DWORD _ILSimpleGetTextW (LPCITEMIDLIST pidl, LPWSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
223 BOOL _ILGetFileDate (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
224 DWORD _ILGetFileSize (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
225 BOOL _ILGetExtension (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
226 void _ILGetFileType (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
227 DWORD _ILGetFileAttributes (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize) DECLSPEC_HIDDEN;
228
229 BOOL _ILGetFileDateTime (LPCITEMIDLIST pidl, FILETIME *ft) DECLSPEC_HIDDEN;
230 DWORD _ILGetDrive (LPCITEMIDLIST, LPSTR, UINT) DECLSPEC_HIDDEN;
231
232 /*
233 * testing simple pidls
234 */
235 BOOL _ILIsUnicode (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
236 BOOL _ILIsDesktop (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
237 BOOL _ILIsMyComputer (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
238 #ifdef __REACTOS__
239 BOOL _ILIsPrinter (LPCITEMIDLIST pidl);
240 BOOL _ILIsMyDocuments (LPCITEMIDLIST pidl);
241 BOOL _ILIsControlPanel (LPCITEMIDLIST pidl);
242 BOOL _ILIsBitBucket (LPCITEMIDLIST pidl);
243 BOOL _ILIsAdminTools (LPCITEMIDLIST pidl);
244 BOOL _ILIsNetHood (LPCITEMIDLIST pidl);
245 #endif
246 BOOL _ILIsDrive (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
247 BOOL _ILIsFolder (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
248 BOOL _ILIsValue (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
249 BOOL _ILIsSpecialFolder (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
250 BOOL _ILIsPidlSimple (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
251 BOOL _ILIsCPanelStruct (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
252 static inline
253 BOOL _ILIsEqualSimple (LPCITEMIDLIST pidlA, LPCITEMIDLIST pidlB)
254 {
255 return (pidlA->mkid.cb > 0 && !memcmp(pidlA, pidlB, pidlA->mkid.cb)) ||
256 (!pidlA->mkid.cb && !pidlB->mkid.cb);
257 }
258 static inline
259 BOOL _ILIsEmpty (LPCITEMIDLIST pidl) { return _ILIsDesktop(pidl); }
260
261 /*
262 * simple pidls
263 */
264
265 /* Creates a PIDL with guid format and type type, which must be one of PT_GUID,
266 * PT_SHELLEXT, or PT_YAGUID.
267 */
268 LPITEMIDLIST _ILCreateGuid(PIDLTYPE type, REFIID guid) DECLSPEC_HIDDEN;
269
270 /* Like _ILCreateGuid, but using the string szGUID. */
271 LPITEMIDLIST _ILCreateGuidFromStrA(LPCSTR szGUID) DECLSPEC_HIDDEN;
272 LPITEMIDLIST _ILCreateGuidFromStrW(LPCWSTR szGUID) DECLSPEC_HIDDEN;
273
274 /* Commonly used PIDLs representing file system objects. */
275 LPITEMIDLIST _ILCreateDesktop (void) DECLSPEC_HIDDEN;
276 LPITEMIDLIST _ILCreateFromFindDataW(const WIN32_FIND_DATAW *stffile) DECLSPEC_HIDDEN;
277 HRESULT _ILCreateFromPathW (LPCWSTR szPath, LPITEMIDLIST* ppidl) DECLSPEC_HIDDEN;
278
279 /* Other helpers */
280 LPITEMIDLIST _ILCreateMyComputer (void) DECLSPEC_HIDDEN;
281 LPITEMIDLIST _ILCreateMyDocuments (void) DECLSPEC_HIDDEN;
282 LPITEMIDLIST _ILCreateIExplore (void) DECLSPEC_HIDDEN;
283 LPITEMIDLIST _ILCreateControlPanel (void) DECLSPEC_HIDDEN;
284 LPITEMIDLIST _ILCreatePrinters (void) DECLSPEC_HIDDEN;
285 LPITEMIDLIST _ILCreateNetwork (void) DECLSPEC_HIDDEN;
286 LPITEMIDLIST _ILCreateNetHood (void) DECLSPEC_HIDDEN;
287 #ifdef __REACTOS__
288 LPITEMIDLIST _ILCreateAdminTools (void);
289 LPITEMIDLIST _ILCreateFont (void);
290 #endif
291 LPITEMIDLIST _ILCreateBitBucket (void) DECLSPEC_HIDDEN;
292 LPITEMIDLIST _ILCreateDrive (LPCWSTR) DECLSPEC_HIDDEN;
293 LPITEMIDLIST _ILCreateEntireNetwork (void) DECLSPEC_HIDDEN;
294
295 /*
296 * helper functions (getting struct-pointer)
297 */
298 LPPIDLDATA _ILGetDataPointer (LPCITEMIDLIST) DECLSPEC_HIDDEN;
299 LPSTR _ILGetTextPointer (LPCITEMIDLIST) DECLSPEC_HIDDEN;
300 IID *_ILGetGUIDPointer (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
301 FileStructW *_ILGetFileStructW (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
302
303 /*
304 * debug helper
305 */
306 void pdump (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
307 BOOL pcheck (LPCITEMIDLIST pidl) DECLSPEC_HIDDEN;
308
309 /*
310 * aPidl helper
311 */
312 void _ILFreeaPidl(LPITEMIDLIST * apidl, UINT cidl) DECLSPEC_HIDDEN;
313 LPITEMIDLIST * _ILCopyaPidl(const LPCITEMIDLIST * apidlsrc, UINT cidl) DECLSPEC_HIDDEN;
314 LPITEMIDLIST * _ILCopyCidaToaPidl(LPITEMIDLIST* pidl, const CIDA * cida) DECLSPEC_HIDDEN;
315
316 BOOL ILGetDisplayNameExW(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPWSTR path, DWORD type) DECLSPEC_HIDDEN;
317
318 #ifdef __cplusplus
319 } /* extern "C" */
320 #endif
321
322 #endif /* __WINE_PIDL_H */