git.oblomov.eu Git - wine/blob - dlls/shell32/pidl.h

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