xref: /reactos/dll/win32/shell32/shfldr.h (revision 6ae11ba0)
1 
2 /*
3  *  Virtual Folder
4  *  common definitions
5  *
6  *  Copyright 1997 Marcus Meissner
7  *  Copyright 1998, 1999, 2002 Juergen Schmied
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef _SHFLDR_H_
25 #define _SHFLDR_H_
26 
27 #define CHARS_IN_GUID 39
28 
29 typedef struct {
30     WORD colnameid; // Column title text resource id passed to LoadString
31     WORD colstate;  // SHCOLSTATEF returned by IShellFolder2::GetDefaultColumnState
32                     // HACK: SHCOLSTATEF truncated to WORD to reduce .rdata section size
33     WORD fmt;       // LVCFMT_*
34     WORD cxChar;    // Column width hint
35 } shvheader;
36 /*
37  * CFSFolder column indices. CDesktopFolder MUST use the same indices!
38  * According to the documentation for IShellFolder2::GetDetailsOf,
39  * the first 4 columns for SFGAO_FILESYSTEM items must be Name, Size, Type, Modified date
40 For Details See:
41 https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-ishellfolder2-getdetailsof
42  */
43 #define SHFSF_COL_NAME          0
44 #define SHFSF_COL_SIZE          1
45 #define SHFSF_COL_TYPE          2 // SHGFI_TYPENAME
46 #define SHFSF_COL_MDATE         3 // Modified date
47 #define SHFSF_COL_FATTS         4 // File attributes
48 #define SHFSF_COL_COMMENT       5
49 
50 typedef struct _REQUIREDREGITEM
51 {
52     REFCLSID clsid;
53     LPCSTR pszCpl;
54     BYTE Order; // According to Geoff Chappell, required items have a fixed sort order
55 } REQUIREDREGITEM;
56 
57 typedef struct _REGFOLDERINFO
58 {
59     PIDLTYPE PidlType;
60     BYTE Count; // Count of required items
61     const REQUIREDREGITEM *Items;
62     REFCLSID clsid;
63     LPCWSTR pszParsingPath;
64     LPCWSTR pszEnumKeyName;
65 } REGFOLDERINFO;
66 
67 typedef struct _REGFOLDERINITDATA
68 {
69     IShellFolder *psfOuter;
70     const REGFOLDERINFO *pInfo;
71 } REGFOLDERINITDATA, *PREGFOLDERINITDATA;
72 
73 HRESULT CRegFolder_CreateInstance(PREGFOLDERINITDATA pInit, LPCITEMIDLIST pidlRoot, REFIID riid, void **ppv);
74 
75 #define GET_SHGDN_FOR(dwFlags)         ((DWORD)dwFlags & (DWORD)0x0000FF00)
76 #define GET_SHGDN_RELATION(dwFlags)    ((DWORD)dwFlags & (DWORD)0x000000FF)
77 #define IS_SHGDN_FOR_PARSING(flags) ( ((flags) & (SHGDN_FORADDRESSBAR | SHGDN_FORPARSING)) == SHGDN_FORPARSING)
78 #define IS_SHGDN_DESKTOPABSOLUTEPARSING(flags) ( ((flags) & (SHGDN_FORADDRESSBAR | SHGDN_FORPARSING | 0xFF)) == SHGDN_FORPARSING)
79 
80 static inline SFGAOF
SHELL_CreateFolderEnumItemAttributeQuery(SHCONTF Flags,BOOL ForRegItem)81 SHELL_CreateFolderEnumItemAttributeQuery(SHCONTF Flags, BOOL ForRegItem)
82 {
83     SFGAOF query = SFGAO_FOLDER | (ForRegItem ? SFGAO_NONENUMERATED : 0);
84     if (!(Flags & SHCONTF_INCLUDEHIDDEN))
85         query |= SFGAO_HIDDEN;
86     if (!(Flags & SHCONTF_INCLUDESUPERHIDDEN))
87         query |= SFGAO_HIDDEN | SFGAO_SYSTEM;
88     return query;
89 }
90 
91 SHCONTF
92 SHELL_GetDefaultFolderEnumSHCONTF();
93 
94 BOOL
95 SHELL_IncludeItemInFolderEnum(IShellFolder *pSF, PCUITEMID_CHILD pidl, SFGAOF Query, SHCONTF Flags);
96 
97 HRESULT
98 Shell_NextElement(
99     _Inout_ LPWSTR *ppch,
100     _Out_ LPWSTR pszOut,
101     _In_ INT cchOut,
102     _In_ BOOL bValidate);
103 
104 HRESULT SHELL32_ParseNextElement (IShellFolder2 * psf, HWND hwndOwner, LPBC pbc, LPITEMIDLIST * pidlInOut,
105                   LPOLESTR szNext, DWORD * pEaten, DWORD * pdwAttributes);
106 
107 HRESULT SHELL32_GetDisplayNameOfChild (IShellFolder2 * psf, LPCITEMIDLIST pidl, DWORD dwFlags, LPSTRRET strRet);
108 
109 HRESULT SHELL32_GetFSItemAttributes(IShellFolder * psf, LPCITEMIDLIST pidl, LPDWORD pdwAttributes);
110 
111 HRESULT SHELL32_CompareDetails(IShellFolder2* isf, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2);
112 
113 HRESULT SHELL32_CompareChildren(IShellFolder2* psf, LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2);
114 
115 #ifdef __cplusplus
116 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, PERSIST_FOLDER_TARGET_INFO* ppfti,
117                 LPCITEMIDLIST pidlChild, const GUID* clsid, REFIID riid, LPVOID *ppvOut);
118 
119 HRESULT SHELL32_CoCreateInitSF (LPCITEMIDLIST pidlRoot, const GUID* clsid,
120                                 int csidl, REFIID riid, LPVOID *ppvOut);
121 #endif
122 
123 HRESULT SHELL32_BindToSF (LPCITEMIDLIST pidlRoot, PERSIST_FOLDER_TARGET_INFO* ppfti,
124                 LPCITEMIDLIST pidl, const GUID* clsid, REFIID riid, LPVOID *ppvOut);
125 
126 extern "C"
127 BOOL HCR_RegOpenClassIDKey(REFIID riid, HKEY *hkey);
128 
129 void AddFSClassKeysToArray(UINT cidl, PCUITEMID_CHILD_ARRAY apidl, HKEY* array, UINT* cKeys);
130 
131 HRESULT CDefViewBckgrndMenu_CreateInstance(IShellFolder* psf, REFIID riid, void **ppv);
132 
133 HRESULT SH_GetApidlFromDataObject(IDataObject *pDataObject, PIDLIST_ABSOLUTE* ppidlfolder, PUITEMID_CHILD **apidlItems, UINT *pcidl);
134 
SHELL32_GUIDToStringA(REFGUID guid,LPSTR str)135 static __inline int SHELL32_GUIDToStringA (REFGUID guid, LPSTR str)
136 {
137     return sprintf(str, "{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
138             guid.Data1, guid.Data2, guid.Data3,
139             guid.Data4[0], guid.Data4[1], guid.Data4[2], guid.Data4[3],
140             guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
141 }
142 
SHELL32_GUIDToStringW(REFGUID guid,LPWSTR str)143 static __inline int SHELL32_GUIDToStringW (REFGUID guid, LPWSTR str)
144 {
145     static const WCHAR fmtW[] =
146      { '{','%','0','8','l','X','-','%','0','4','X','-','%','0','4','X','-',
147      '%','0','2','X','%','0','2','X','-',
148      '%','0','2','X','%','0','2','X','%','0','2','X','%','0','2','X',
149      '%','0','2','X','%','0','2','X','}',0 };
150     return swprintf(str, fmtW,
151             guid.Data1, guid.Data2, guid.Data3,
152             guid.Data4[0], guid.Data4[1], guid.Data4[2], guid.Data4[3],
153             guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
154 }
155 
156 void SHELL_FS_ProcessDisplayFilename(LPWSTR szPath, DWORD dwFlags);
157 BOOL SHELL_FS_HideExtension(LPCWSTR pwszPath);
158 
159 LSTATUS AddClassKeyToArray(const WCHAR* szClass, HKEY* array, UINT* cKeys);
160 LSTATUS AddClsidKeyToArray(REFCLSID clsid, HKEY* array, UINT* cKeys);
161 
162 #ifdef __cplusplus
163 
SHSetStrRet(LPSTRRET pStrRet,DWORD resId)164 HRESULT inline SHSetStrRet(LPSTRRET pStrRet, DWORD resId)
165 {
166     return SHSetStrRet(pStrRet, shell32_hInstance, resId);
167 }
168 
169 #endif
170 
171 #endif /* _SHFLDR_H_ */
172