dlls/shell32/pidl.h

   1 /*
   2  * internal pidl functions
   3  *
   4  * Copyright 1998 Juergen Schmied
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * NOTES:
  21  *
  22  * DO NOT use this definitions outside the shell32.dll !
  23  *
  24  * The contents of a pidl should never used from a application
  25  * directly.
  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 #include "shlobj.h"
  38
  39 /*
  40 * the pidl does cache fileattributes to speed up SHGetAttributes when
  41 * displaying a big number of files.
  42 *
  43 * a pidl of NULL means the desktop
  44 *
  45 * The structure of the pidl seems to be a union. The first byte of the
  46 * PIDLDATA desribes the type of pidl.
  47 *
  48 *       object        ! first byte /  ! format       ! living space
  49 *                     ! size
  50 *       ----------------------------------------------------------------
  51 *       my computer     0x1F/20         mycomp (2)      (usual)
  52 *       network         0x1F            mycomp
  53 *       bitbucket       0x1F            mycomp
  54 *       drive           0x23/25         drive           (usual)
  55 *       drive           0x25/25         drive           (lnk/persistant)
  56 *       drive           0x29/25         drive
  57 *       shell extension 0x2E            mycomp
  58 *       drive           0x2F            drive           (lnk/persistant)
  59 *       folder/file     0x30            folder/file (1) (lnk/persistant)
  60 *       folder          0x31            folder          (usual)
  61 *       valueA          0x32            file            (ANSI file name)
  62 *       valueW          0x34            file            (Unicode file name)
  63 *       workgroup       0x41            network (3)
  64 *       computer        0x42            network (4)
  65 *       whole network   0x47            network (5)
  66 *       MSITStore       0x61            htmlhlp (7)
  67 *       history/favorites 0xb1          file
  68 *       share           0xc3            network (6)
  69 *
  70 * guess: the persistant elements are non tracking
  71 *
  72 * (1) dummy byte is used, attributes are empty
  73 * (2) IID_MyComputer = 20D04FE0L-3AEA-1069-A2D8-08002B30309D
  74 * (3) two strings       "workgroup" "microsoft network"
  75 * (4) one string        "\\sirius"
  76 * (5) one string        "whole network"
  77 * (6) one string        "\\sirius\c"
  78 * (7) contains string   "mk:@MSITStore:C:\path\file.chm::/path/filename.htm"
  79 *               GUID    871C5380-42A0-1069-A2EA-08002B30309D
  80 */
  81
  82 #define PT_DESKTOP      0x00 /* internal */
  83 #define PT_MYCOMP       0x1F
  84 #define PT_DRIVE        0x23
  85 #define PT_DRIVE2       0x25
  86 #define PT_DRIVE3       0x29
  87 #define PT_SPECIAL      0x2E
  88 #define PT_DRIVE1       0x2F
  89 #define PT_FOLDER1      0x30
  90 #define PT_FOLDER       0x31
  91 #define PT_VALUE        0x32
  92 #define PT_WORKGRP      0x41
  93 #define PT_COMP         0x42
  94 #define PT_NETWORK      0x47
  95 #define PT_IESPECIAL1   0x61
  96 #define PT_IESPECIAL2   0xb1
  97 #define PT_SHARE        0xc3
  98
  99 #include "pshpack1.h"
 100 typedef BYTE PIDLTYPE;
 101
 102 typedef struct tagPIDLDATA
 103 {       PIDLTYPE type;                  /*00*/
 104         union
 105         { struct
 106           { BYTE dummy;                 /*01*/
 107             GUID guid;                  /*02*/
 108             BYTE dummy1;                /*18*/
 109           } mycomp;
 110           struct
 111           { CHAR szDriveName[20];       /*01*/
 112             DWORD dwUnknown;            /*21*/
 113             /* the drive seems to be 25 bytes every time */
 114           } drive;
 115           struct
 116           { BYTE dummy;                 /*01 is 0x00 for files or dirs */
 117             DWORD dwFileSize;           /*02*/
 118             WORD uFileDate;             /*06*/
 119             WORD uFileTime;             /*08*/
 120             WORD uFileAttribs;          /*10*/
 121             CHAR szNames[1];            /*12*/
 122             /* Here are comming two strings. The first is the long name.
 123             The second the dos name when needed or just 0x00 */
 124           } file, folder, generic;
 125           struct
 126           { WORD dummy;         /*01*/
 127             CHAR szNames[1];    /*03*/
 128           } network;
 129           struct
 130           { WORD dummy;         /*01*/
 131             DWORD dummy1;       /*02*/
 132             CHAR szName[1];     /*06*/ /* teminated by 0x00 0x00 */
 133           } htmlhelp;
 134         }u;
 135 } PIDLDATA, *LPPIDLDATA;
 136 #include "poppack.h"
 137
 138 /*
 139  * getting special values from simple pidls
 140  */
 141 DWORD   _ILSimpleGetText        (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 142 BOOL    _ILGetFileDate          (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 143 DWORD   _ILGetFileSize          (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 144 BOOL    _ILGetExtension         (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 145 void    _ILGetFileType          (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 146 DWORD   _ILGetFileAttributes    (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
 147
 148 BOOL    _ILGetFileDateTime      (LPCITEMIDLIST pidl, FILETIME *ft);
 149 DWORD   _ILGetDrive             (LPCITEMIDLIST, LPSTR, UINT);
 150
 151 /*
 152  * testing simple pidls
 153  */
 154 BOOL    _ILIsDesktop            (LPCITEMIDLIST pidl);
 155 BOOL    _ILIsMyComputer         (LPCITEMIDLIST pidl);
 156 BOOL    _ILIsDrive              (LPCITEMIDLIST pidl);
 157 BOOL    _ILIsFolder             (LPCITEMIDLIST pidl);
 158 BOOL    _ILIsValue              (LPCITEMIDLIST pidl);
 159 BOOL    _ILIsSpecialFolder      (LPCITEMIDLIST pidl);
 160 BOOL    _ILIsPidlSimple         (LPCITEMIDLIST pidl);
 161
 162 /*
 163  * simple pidls from strings
 164  */
 165 LPITEMIDLIST    _ILCreate       (PIDLTYPE,LPCVOID,UINT);
 166
 167 LPITEMIDLIST    _ILCreateDesktop        (void);
 168 LPITEMIDLIST    _ILCreateMyComputer     (void);
 169 LPITEMIDLIST    _ILCreateIExplore       (void);
 170 LPITEMIDLIST    _ILCreateControl        (void);
 171 LPITEMIDLIST    _ILCreatePrinter        (void);
 172 LPITEMIDLIST    _ILCreateNetwork        (void);
 173 LPITEMIDLIST    _ILCreateBitBucket      (void);
 174 LPITEMIDLIST    _ILCreateDrive          (LPCSTR);
 175 LPITEMIDLIST    _ILCreateFolder         (WIN32_FIND_DATAA * stffile);
 176 LPITEMIDLIST    _ILCreateValue          (WIN32_FIND_DATAA * stffile);
 177 LPITEMIDLIST    _ILCreateSpecial        (LPCSTR szGUID);
 178 LPITEMIDLIST    _ILCreateFromPathA      (LPCSTR szPath);
 179
 180 /*
 181  * helper functions (getting struct-pointer)
 182  */
 183 LPPIDLDATA      _ILGetDataPointer       (LPCITEMIDLIST);
 184 LPSTR           _ILGetTextPointer       (LPCITEMIDLIST);
 185 LPSTR           _ILGetSTextPointer      (LPCITEMIDLIST);
 186 REFIID          _ILGetGUIDPointer       (LPCITEMIDLIST pidl);
 187
 188 /*
 189  * debug helper
 190  */
 191 void    pdump   (LPCITEMIDLIST pidl);
 192 BOOL    pcheck  (LPCITEMIDLIST pidl);
 193
 194 /*
 195  * aPidl helper
 196  */
 197 void _ILFreeaPidl(LPITEMIDLIST * apidl, UINT cidl);
 198 LPITEMIDLIST * _ILCopyaPidl(LPITEMIDLIST * apidlsrc, UINT cidl);
 199 LPITEMIDLIST * _ILCopyCidaToaPidl(LPITEMIDLIST* pidl, LPIDA cida);
 200
 201 BOOL WINAPI ILGetDisplayNameExA(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPSTR path, DWORD type);
 202 BOOL WINAPI ILGetDisplayNameExW(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPWSTR path, DWORD type);
 203
 204 #endif