23#include <winpr/winpr.h>
24#include <winpr/tchar.h>
25#include <winpr/error.h>
26#include <winpr/wtypes.h>
30#ifdef WINPR_HAVE_PATHCCH_H
41#define PATHCCH_ALLOW_LONG_PATHS \
44#define VOLUME_PREFIX _T("\\\\?\\Volume")
45#define VOLUME_PREFIX_LEN ((sizeof(VOLUME_PREFIX) / sizeof(TCHAR)) - 1)
52#define PATHCCH_MAX_CCH 0x8000
55 WINPR_API HRESULT PathCchAddBackslashA(PSTR pszPath,
size_t cchPath);
58 WINPR_API HRESULT PathCchAddBackslashW(PWSTR pszPath,
size_t cchPath);
61 WINPR_API HRESULT PathCchRemoveBackslashA(PSTR pszPath,
size_t cchPath);
64 WINPR_API HRESULT PathCchRemoveBackslashW(PWSTR pszPath,
size_t cchPath);
67 WINPR_API HRESULT PathCchAddBackslashExA(PSTR pszPath,
size_t cchPath, PSTR* ppszEnd,
68 size_t* pcchRemaining);
71 WINPR_API HRESULT PathCchAddBackslashExW(PWSTR pszPath,
size_t cchPath, PWSTR* ppszEnd,
72 size_t* pcchRemaining);
75 WINPR_API HRESULT PathCchRemoveBackslashExA(PSTR pszPath,
size_t cchPath, PSTR* ppszEnd,
76 size_t* pcchRemaining);
79 WINPR_API HRESULT PathCchRemoveBackslashExW(PWSTR pszPath,
size_t cchPath, PWSTR* ppszEnd,
80 size_t* pcchRemaining);
83 WINPR_API HRESULT PathCchAddExtensionA(PSTR pszPath,
size_t cchPath, PCSTR pszExt);
86 WINPR_API HRESULT PathCchAddExtensionW(PWSTR pszPath,
size_t cchPath, PCWSTR pszExt);
89 WINPR_API HRESULT PathCchAppendA(PSTR pszPath,
size_t cchPath, PCSTR pszMore);
92 WINPR_API HRESULT PathCchAppendW(PWSTR pszPath,
size_t cchPath, PCWSTR pszMore);
95 WINPR_API HRESULT PathCchAppendExA(PSTR pszPath,
size_t cchPath, PCSTR pszMore,
96 unsigned long dwFlags);
99 WINPR_API HRESULT PathCchAppendExW(PWSTR pszPath,
size_t cchPath, PCWSTR pszMore,
100 unsigned long dwFlags);
103 WINPR_API HRESULT PathCchCanonicalizeA(PSTR pszPathOut,
size_t cchPathOut, PCSTR pszPathIn);
106 WINPR_API HRESULT PathCchCanonicalizeW(PWSTR pszPathOut,
size_t cchPathOut, PCWSTR pszPathIn);
109 WINPR_API HRESULT PathCchCanonicalizeExA(PSTR pszPathOut,
size_t cchPathOut, PCSTR pszPathIn,
110 unsigned long dwFlags);
113 WINPR_API HRESULT PathCchCanonicalizeExW(PWSTR pszPathOut,
size_t cchPathOut, PCWSTR pszPathIn,
114 unsigned long dwFlags);
117 WINPR_API HRESULT PathAllocCanonicalizeA(PCSTR pszPathIn,
unsigned long dwFlags,
121 WINPR_API HRESULT PathAllocCanonicalizeW(PCWSTR pszPathIn,
unsigned long dwFlags,
125 WINPR_API HRESULT PathCchCombineA(PSTR pszPathOut,
size_t cchPathOut, PCSTR pszPathIn,
129 WINPR_API HRESULT PathCchCombineW(PWSTR pszPathOut,
size_t cchPathOut, PCWSTR pszPathIn,
133 WINPR_API HRESULT PathCchCombineExA(PSTR pszPathOut,
size_t cchPathOut, PCSTR pszPathIn,
134 PCSTR pszMore,
unsigned long dwFlags);
137 WINPR_API HRESULT PathCchCombineExW(PWSTR pszPathOut,
size_t cchPathOut, PCWSTR pszPathIn,
138 PCWSTR pszMore,
unsigned long dwFlags);
141 WINPR_API HRESULT PathAllocCombineA(PCSTR pszPathIn, PCSTR pszMore,
unsigned long dwFlags,
145 WINPR_API HRESULT PathAllocCombineW(PCWSTR pszPathIn, PCWSTR pszMore,
unsigned long dwFlags,
149 WINPR_API HRESULT PathCchFindExtensionA(PCSTR pszPath,
size_t cchPath, PCSTR* ppszExt);
152 WINPR_API HRESULT PathCchFindExtensionW(PCWSTR pszPath,
size_t cchPath, PCWSTR* ppszExt);
155 WINPR_API HRESULT PathCchRenameExtensionA(PSTR pszPath,
size_t cchPath, PCSTR pszExt);
158 WINPR_API HRESULT PathCchRenameExtensionW(PWSTR pszPath,
size_t cchPath, PCWSTR pszExt);
161 WINPR_API HRESULT PathCchRemoveExtensionA(PSTR pszPath,
size_t cchPath);
164 WINPR_API HRESULT PathCchRemoveExtensionW(PWSTR pszPath,
size_t cchPath);
167 WINPR_API BOOL PathCchIsRootA(PCSTR pszPath);
170 WINPR_API BOOL PathCchIsRootW(PCWSTR pszPath);
173 WINPR_API BOOL PathIsUNCExA(PCSTR pszPath, PCSTR* ppszServer);
176 WINPR_API BOOL PathIsUNCExW(PCWSTR pszPath, PCWSTR* ppszServer);
179 WINPR_API HRESULT PathCchSkipRootA(PCSTR pszPath, PCSTR* ppszRootEnd);
182 WINPR_API HRESULT PathCchSkipRootW(PCWSTR pszPath, PCWSTR* ppszRootEnd);
185 WINPR_API HRESULT PathCchStripToRootA(PSTR pszPath,
size_t cchPath);
188 WINPR_API HRESULT PathCchStripToRootW(PWSTR pszPath,
size_t cchPath);
191 WINPR_API HRESULT PathCchStripPrefixA(PSTR pszPath,
size_t cchPath);
194 WINPR_API HRESULT PathCchStripPrefixW(PWSTR pszPath,
size_t cchPath);
197 WINPR_API HRESULT PathCchRemoveFileSpecA(PSTR pszPath,
size_t cchPath);
200 WINPR_API HRESULT PathCchRemoveFileSpecW(PWSTR pszPath,
size_t cchPath);
203#define PathCchAddBackslash PathCchAddBackslashW
204#define PathCchRemoveBackslash PathCchRemoveBackslashW
205#define PathCchAddBackslashEx PathCchAddBackslashExW
206#define PathCchRemoveBackslashEx PathCchRemoveBackslashExW
207#define PathCchAddExtension PathCchAddExtensionW
208#define PathCchAppend PathCchAppendW
209#define PathCchAppendEx PathCchAppendExW
210#define PathCchCanonicalize PathCchCanonicalizeW
211#define PathCchCanonicalizeEx PathCchCanonicalizeExW
212#define PathAllocCanonicalize PathAllocCanonicalizeW
213#define PathCchCombine PathCchCombineW
214#define PathCchCombineEx PathCchCombineExW
215#define PathAllocCombine PathAllocCombineW
216#define PathCchFindExtension PathCchFindExtensionW
217#define PathCchRenameExtension PathCchRenameExtensionW
218#define PathCchRemoveExtension PathCchRemoveExtensionW
219#define PathCchIsRoot PathCchIsRootW
220#define PathIsUNCEx PathIsUNCExW
221#define PathCchSkipRoot PathCchSkipRootW
222#define PathCchStripToRoot PathCchStripToRootW
223#define PathCchStripPrefix PathCchStripPrefixW
224#define PathCchRemoveFileSpec PathCchRemoveFileSpecW
226#define PathCchAddBackslash PathCchAddBackslashA
227#define PathCchRemoveBackslash PathCchRemoveBackslashA
228#define PathCchAddBackslashEx PathCchAddBackslashExA
229#define PathCchRemoveBackslashEx PathCchRemoveBackslashExA
230#define PathCchAddExtension PathCchAddExtensionA
231#define PathCchAppend PathCchAppendA
232#define PathCchAppendEx PathCchAppendExA
233#define PathCchCanonicalize PathCchCanonicalizeA
234#define PathCchCanonicalizeEx PathCchCanonicalizeExA
235#define PathAllocCanonicalize PathAllocCanonicalizeA
236#define PathCchCombine PathCchCombineA
237#define PathCchCombineEx PathCchCombineExA
238#define PathAllocCombine PathAllocCombineA
239#define PathCchFindExtension PathCchFindExtensionA
240#define PathCchRenameExtension PathCchRenameExtensionA
241#define PathCchRemoveExtension PathCchRemoveExtensionA
242#define PathCchIsRoot PathCchIsRootA
243#define PathIsUNCEx PathIsUNCExA
244#define PathCchSkipRoot PathCchSkipRootA
245#define PathCchStripToRoot PathCchStripToRootA
246#define PathCchStripPrefix PathCchStripPrefixA
247#define PathCchRemoveFileSpec PathCchRemoveFileSpecA
253 WINPR_API HRESULT PathCchAddSlashA(PSTR pszPath,
size_t cchPath);
256 WINPR_API HRESULT PathCchAddSlashW(PWSTR pszPath,
size_t cchPath);
259 WINPR_API HRESULT PathCchAddSlashExA(PSTR pszPath,
size_t cchPath, PSTR* ppszEnd,
260 size_t* pcchRemaining);
263 WINPR_API HRESULT PathCchAddSlashExW(PWSTR pszPath,
size_t cchPath, PWSTR* ppszEnd,
264 size_t* pcchRemaining);
267 WINPR_API HRESULT UnixPathCchAddExtensionA(PSTR pszPath,
size_t cchPath, PCSTR pszExt);
270 WINPR_API HRESULT UnixPathCchAddExtensionW(PWSTR pszPath,
size_t cchPath, PCWSTR pszExt);
273 WINPR_API HRESULT UnixPathCchAppendA(PSTR pszPath,
size_t cchPath, PCSTR pszMore);
276 WINPR_API HRESULT UnixPathCchAppendW(PWSTR pszPath,
size_t cchPath, PCWSTR pszMore);
279 WINPR_API HRESULT UnixPathAllocCombineA(PCSTR pszPathIn, PCSTR pszMore,
unsigned long dwFlags,
283 WINPR_API HRESULT UnixPathAllocCombineW(PCWSTR pszPathIn, PCWSTR pszMore,
unsigned long dwFlags,
287#define PathCchAddSlash PathCchAddSlashW
288#define PathCchAddSlashEx PathCchAddSlashExW
289#define UnixPathCchAddExtension UnixPathCchAddExtensionW
290#define UnixPathCchAppend UnixPathCchAppendW
291#define UnixPathAllocCombine UnixPathAllocCombineW
293#define PathCchAddSlash PathCchAddSlashA
294#define PathCchAddSlashEx PathCchAddSlashExA
295#define UnixPathCchAddExtension UnixPathCchAddExtensionA
296#define UnixPathCchAppend UnixPathCchAppendA
297#define UnixPathAllocCombine UnixPathAllocCombineA
303 WINPR_API HRESULT PathCchAddSeparatorA(PSTR pszPath,
size_t cchPath);
306 WINPR_API HRESULT PathCchAddSeparatorW(PWSTR pszPath,
size_t cchPath);
309 WINPR_API HRESULT PathCchAddSeparatorExA(PSTR pszPath,
size_t cchPath, PSTR* ppszEnd,
310 size_t* pcchRemaining);
313 WINPR_API HRESULT PathCchAddSeparatorExW(PWSTR pszPath,
size_t cchPath, PWSTR* ppszEnd,
314 size_t* pcchRemaining);
317 WINPR_API HRESULT NativePathCchAddExtensionA(PSTR pszPath,
size_t cchPath, PCSTR pszExt);
320 WINPR_API HRESULT NativePathCchAddExtensionW(PWSTR pszPath,
size_t cchPath, PCWSTR pszExt);
323 WINPR_API HRESULT NativePathCchAppendA(PSTR pszPath,
size_t cchPath, PCSTR pszMore);
326 WINPR_API HRESULT NativePathCchAppendW(PWSTR pszPath,
size_t cchPath, PCWSTR pszMore);
329 WINPR_API HRESULT NativePathAllocCombineA(PCSTR pszPathIn, PCSTR pszMore,
unsigned long dwFlags,
333 WINPR_API HRESULT NativePathAllocCombineW(PCWSTR pszPathIn, PCWSTR pszMore,
334 unsigned long dwFlags, PWSTR* ppszPathOut);
337#define PathCchAddSeparator PathCchAddSeparatorW
338#define PathCchAddSeparatorEx PathCchAddSeparatorExW
339#define NativePathCchAddExtension NativePathCchAddExtensionW
340#define NativePathCchAppend NativePathCchAppendW
341#define NativePathAllocCombine NativePathAllocCombineW
343#define PathCchAddSeparator PathCchAddSeparatorA
344#define PathCchAddSeparatorEx PathCchAddSeparatorExA
345#define NativePathCchAddExtension NativePathCchAddExtensionA
346#define NativePathCchAppend NativePathCchAppendA
347#define NativePathAllocCombine NativePathAllocCombineA
352#define PATH_STYLE_WINDOWS 0x00000001
353#define PATH_STYLE_UNIX 0x00000002
354#define PATH_STYLE_NATIVE 0x00000003
356#define PATH_SHARED_LIB_EXT_WITH_DOT 0x00000001
357#define PATH_SHARED_LIB_EXT_APPLE_SO 0x00000002
358#define PATH_SHARED_LIB_EXT_EXPLICIT 0x80000000
359#define PATH_SHARED_LIB_EXT_EXPLICIT_DLL 0x80000001
360#define PATH_SHARED_LIB_EXT_EXPLICIT_SO 0x80000002
361#define PATH_SHARED_LIB_EXT_EXPLICIT_DYLIB 0x80000003
364 WINPR_API HRESULT PathCchConvertStyleA(PSTR pszPath,
size_t cchPath,
unsigned long dwFlags);
366 WINPR_API HRESULT PathCchConvertStyleW(PWSTR pszPath,
size_t cchPath,
unsigned long dwFlags);
369 WINPR_API
char PathGetSeparatorA(
unsigned long dwFlags);
372 WINPR_API WCHAR PathGetSeparatorW(
unsigned long dwFlags);
375 WINPR_API PCSTR PathGetSharedLibraryExtensionA(
unsigned long dwFlags);
378 WINPR_API PCWSTR PathGetSharedLibraryExtensionW(
unsigned long dwFlags);
381#define PathCchConvertStyle PathCchConvertStyleW
382#define PathGetSeparator PathGetSeparatorW
383#define PathGetSharedLibraryExtension PathGetSharedLibraryExtensionW
385#define PathCchConvertStyle PathCchConvertStyleA
386#define PathGetSeparator PathGetSeparatorW
387#define PathGetSharedLibraryExtension PathGetSharedLibraryExtensionA
404 KNOWN_PATH_XDG_DATA_HOME = 3,
405 KNOWN_PATH_XDG_CONFIG_HOME = 4,
406 KNOWN_PATH_XDG_CACHE_HOME = 5,
407 KNOWN_PATH_XDG_RUNTIME_DIR = 6,
408 KNOWN_PATH_SYSTEM_CONFIG_HOME = 7
429 WINPR_ATTR_MALLOC(free, 1)
430 WINPR_API
char* winpr_GetConfigFilePath(BOOL system, const
char* filename);
441 WINPR_ATTR_MALLOC(free, 1)
442 WINPR_ATTR_FORMAT_ARG(2, 3)
443 WINPR_API
char* winpr_GetConfigFilePathV(BOOL system, WINPR_FORMAT_ARG const
char* filename,
456 WINPR_ATTR_MALLOC(free, 1)
457 WINPR_ATTR_FORMAT_ARG(2, 0)
458 WINPR_API
char* winpr_GetConfigFilePathVA(BOOL system, WINPR_FORMAT_ARG const
char* filename,
462 WINPR_API const
char* GetKnownPathIdString(
int id);
464 WINPR_ATTR_MALLOC(free, 1)
465 WINPR_API
char* GetKnownPath(eKnownPathTypes
id);
467 WINPR_ATTR_MALLOC(free, 1)
468 WINPR_API
char* GetKnownSubPath(eKnownPathTypes
id, const
char* path);
478 WINPR_ATTR_MALLOC(free, 1)
479 WINPR_ATTR_FORMAT_ARG(2, 3)
480 WINPR_API
char* GetKnownSubPathV(eKnownPathTypes
id, const
char* path, ...);
491 WINPR_ATTR_MALLOC(free, 1)
492 WINPR_ATTR_FORMAT_ARG(2, 0)
493 WINPR_API
char* GetKnownSubPathVA(eKnownPathTypes
id, const
char* path, va_list ap);
495 WINPR_ATTR_MALLOC(free, 1)
496 WINPR_API
char* GetEnvironmentPath(
char* name);
498 WINPR_ATTR_MALLOC(free, 1)
499 WINPR_API
char* GetEnvironmentSubPath(
char* name, const
char* path);
509 WINPR_ATTR_MALLOC(free, 1)
510 WINPR_ATTR_FORMAT_ARG(2, 3)
511 WINPR_API
char* GetEnvironmentSubPathV(
char* name, WINPR_FORMAT_ARG const
char* path, ...);
523 WINPR_ATTR_MALLOC(free, 1)
524 WINPR_ATTR_FORMAT_ARG(2, 0)
525 WINPR_API
char* GetEnvironmentSubPathVA(
char* name, WINPR_FORMAT_ARG const
char* path,
528 WINPR_ATTR_MALLOC(free, 1)
529 WINPR_API
char* GetCombinedPath(const
char* basePath, const
char* subPath);
543 WINPR_ATTR_MALLOC(free, 1)
544 WINPR_ATTR_FORMAT_ARG(2, 3)
545 WINPR_API
char* GetCombinedPathV(const
char* basePath, WINPR_FORMAT_ARG const
char* subPathFmt,
560 WINPR_ATTR_MALLOC(free, 1)
561 WINPR_ATTR_FORMAT_ARG(2, 0)
562 WINPR_API
char* GetCombinedPathVA(const
char* basePath, WINPR_FORMAT_ARG const
char* subPathFmt,
566 WINPR_API BOOL PathMakePathA(LPCSTR path, LPSECURITY_ATTRIBUTES lpAttributes);
569 WINPR_API BOOL PathMakePathW(LPCWSTR path, LPSECURITY_ATTRIBUTES lpAttributes);
571#if !defined(_WIN32) || defined(_UWP)
574 WINPR_API BOOL PathIsRelativeA(LPCSTR pszPath);
577 WINPR_API BOOL PathIsRelativeW(LPCWSTR pszPath);
580 WINPR_API BOOL PathFileExistsA(LPCSTR pszPath);
583 WINPR_API BOOL PathFileExistsW(LPCWSTR pszPath);
586 WINPR_API BOOL PathIsDirectoryEmptyA(LPCSTR pszPath);
589 WINPR_API BOOL PathIsDirectoryEmptyW(LPCWSTR pszPath);
592#define PathFileExists PathFileExistsW
593#define PathIsDirectoryEmpty PathIsDirectoryEmptyW
595#define PathFileExists PathFileExistsA
596#define PathIsDirectoryEmpty PathIsDirectoryEmptyA
602 WINPR_API BOOL winpr_MoveFile(LPCSTR lpExistingFileName, LPCSTR lpNewFileName);
605 WINPR_API BOOL winpr_MoveFileEx(LPCSTR lpExistingFileName, LPCSTR lpNewFileName, DWORD dwFlags);
607 WINPR_API BOOL winpr_DeleteFile(
const char* lpFileName);
609 WINPR_API BOOL winpr_RemoveDirectory(LPCSTR lpPathName);
611 WINPR_API BOOL winpr_RemoveDirectory_RecursiveA(LPCSTR lpPathName);
613 WINPR_API BOOL winpr_RemoveDirectory_RecursiveW(LPCWSTR lpPathName);
616 WINPR_API BOOL winpr_PathFileExists(
const char* pszPath);
619 WINPR_API BOOL winpr_PathMakePath(
const char* path, LPSECURITY_ATTRIBUTES lpAttributes);