1/**
2 * This file is part of the mingw-w64 runtime package.
3 * No warranty is given; refer to the file DISCLAIMER within this package.
4 */
5
6#ifndef __PATHCCH_H__
7#define __PATHCCH_H__
8
9#include <apiset.h>
10#include <apisetcconv.h>
11#include <minwindef.h>
12#include <minwinbase.h>
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
18#if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_APP)
19
20#define VOLUME_PREFIX L"\\\\?\\Volume"
21#define VOLUME_PREFIX_LEN (ARRAYSIZE (VOLUME_PREFIX) - 1)
22
23#define PATHCCH_MAX_CCH 0x8000
24
25typedef enum PATHCCH_OPTIONS {
26 PATHCCH_NONE = 0x0,
27 PATHCCH_ALLOW_LONG_PATHS = 0x01,
28 PATHCCH_FORCE_ENABLE_LONG_NAME_PROCESS = 0x02,
29 PATHCCH_FORCE_DISABLE_LONG_NAME_PROCESS = 0x04,
30 PATHCCH_DO_NOT_NORMALIZE_SEGMENTS = 0x08,
31 PATHCCH_ENSURE_IS_EXTENDED_LENGTH_PATH = 0x10,
32 PATHCCH_ENSURE_TRAILING_SLASH = 0x020,
33 PATHCCH_CANONICALIZE_SLASHES = 0x040
34} PATHCCH_OPTIONS;
35DEFINE_ENUM_FLAG_OPERATORS(PATHCCH_OPTIONS)
36
37 WINPATHCCHAPI HRESULT APIENTRY PathAllocCombine (PCWSTR pszPathIn, PCWSTR pszMore, unsigned long dwFlags, PWSTR *ppszPathOut);
38 WINPATHCCHAPI HRESULT APIENTRY PathAllocCanonicalize (PCWSTR pszPathIn, unsigned long dwFlags, PWSTR *ppszPathOut);
39 WINPATHCCHAPI HRESULT APIENTRY PathCchAddBackslash (PWSTR pszPath, size_t cchPath);
40 WINPATHCCHAPI HRESULT APIENTRY PathCchAddBackslashEx (PWSTR pszPath, size_t cchPath, PWSTR *ppszEnd, size_t *pcchRemaining);
41 WINPATHCCHAPI HRESULT APIENTRY PathCchAddExtension (PWSTR pszPath, size_t cchPath, PCWSTR pszExt);
42 WINPATHCCHAPI HRESULT APIENTRY PathCchAppend (PWSTR pszPath, size_t cchPath, PCWSTR pszMore);
43 WINPATHCCHAPI HRESULT APIENTRY PathCchAppendEx (PWSTR pszPath, size_t cchPath, PCWSTR pszMore, unsigned long dwFlags);
44 WINPATHCCHAPI HRESULT APIENTRY PathCchCanonicalize (PWSTR pszPathOut, size_t cchPathOut, PCWSTR pszPathIn);
45 WINPATHCCHAPI HRESULT APIENTRY PathCchCanonicalizeEx (PWSTR pszPathOut, size_t cchPathOut, PCWSTR pszPathIn, unsigned long dwFlags);
46 WINPATHCCHAPI HRESULT APIENTRY PathCchCombine (PWSTR pszPathOut, size_t cchPathOut, PCWSTR pszPathIn, PCWSTR pszMore);
47 WINPATHCCHAPI HRESULT APIENTRY PathCchCombineEx (PWSTR pszPathOut, size_t cchPathOut, PCWSTR pszPathIn, PCWSTR pszMore, unsigned long dwFlags);
48 WINPATHCCHAPI HRESULT APIENTRY PathCchFindExtension (PCWSTR pszPath, size_t cchPath, PCWSTR *ppszExt);
49 WINPATHCCHAPI WINBOOL APIENTRY PathCchIsRoot (PCWSTR pszPath);
50 WINPATHCCHAPI HRESULT APIENTRY PathCchRemoveBackslashEx (PWSTR pszPath, size_t cchPath, PWSTR *ppszEnd, size_t *pcchRemaining);
51 WINPATHCCHAPI HRESULT APIENTRY PathCchRemoveBackslash (PWSTR pszPath, size_t cchPath);
52 WINPATHCCHAPI HRESULT APIENTRY PathCchRemoveExtension (PWSTR pszPath, size_t cchPath);
53 WINPATHCCHAPI HRESULT APIENTRY PathCchRemoveFileSpec (PWSTR pszPath, size_t cchPath);
54 WINPATHCCHAPI HRESULT APIENTRY PathCchRenameExtension (PWSTR pszPath, size_t cchPath, PCWSTR pszExt);
55 WINPATHCCHAPI HRESULT APIENTRY PathCchSkipRoot (PCWSTR pszPath, PCWSTR *ppszRootEnd);
56 WINPATHCCHAPI HRESULT APIENTRY PathCchStripPrefix (PWSTR pszPath, size_t cchPath);
57 WINPATHCCHAPI HRESULT APIENTRY PathCchStripToRoot (PWSTR pszPath, size_t cchPath);
58 WINPATHCCHAPI WINBOOL APIENTRY PathIsUNCEx (PCWSTR pszPath, PCWSTR *ppszServer);
59
60#ifndef PATHCCH_NO_DEPRECATE
61#undef PathAddBackslash
62#undef PathAddBackslashA
63#undef PathAddBackslashW
64
65#undef PathAddExtension
66#undef PathAddExtensionA
67#undef PathAddExtensionW
68
69#undef PathAppend
70#undef PathAppendA
71#undef PathAppendW
72
73#undef PathCanonicalize
74#undef PathCanonicalizeA
75#undef PathCanonicalizeW
76
77#undef PathCombine
78#undef PathCombineA
79#undef PathCombineW
80
81#undef PathRenameExtension
82#undef PathRenameExtensionA
83#undef PathRenameExtensionW
84
85#ifndef DEPRECATE_SUPPORTED
86#define PathIsRelativeWorker PathIsRelativeWorker_is_internal_to_pathcch;
87#define StrIsEqualWorker StrIsEqualWorker_is_internal_to_pathcch;
88#define FindPreviousBackslashWorker FindPreviousBackslashWorker_is_internal_to_pathcch;
89#define IsHexDigitWorker IsHexDigitWorker_is_internal_to_pathcch;
90#define StringIsGUIDWorker StringIsGUIDWorker_is_internal_to_pathcch;
91#define PathIsVolumeGUIDWorker PathIsVolumeGUIDWorker_is_internal_to_pathcch;
92#define IsValidExtensionWorker IsValidExtensionWorker_is_internal_to_pathcch;
93
94#define PathAddBackslash PathAddBackslash_instead_use_PathCchAddBackslash;
95#define PathAddBackslashA PathAddBackslash_instead_use_PathCchAddBackslash;
96#define PathAddBackslashW PathAddBackslash_instead_use_PathCchAddBackslash;
97
98#define PathAddExtension PathAddExtension_instead_use_PathCchAddExtension;
99#define PathAddExtensionA PathAddExtension_instead_use_PathCchAddExtension;
100#define PathAddExtensionW PathAddExtension_instead_use_PathCchAddExtension;
101
102#define PathAppend PathAppend_instead_use_PathCchAppend;
103#define PathAppendA PathAppend_instead_use_PathCchAppend;
104#define PathAppendW PathAppend_instead_use_PathCchAppend;
105
106#define PathCanonicalize PathCanonicalize_instead_use_PathCchCanonicalize;
107#define PathCanonicalizeA PathCanonicalize_instead_use_PathCchCanonicalize;
108#define PathCanonicalizeW PathCanonicalize_instead_use_PathCchCanonicalize;
109
110#define PathCombine PathCombine_instead_use_PathCchCombine;
111#define PathCombineA PathCombine_instead_use_PathCchCombine;
112#define PathCombineW PathCombine_instead_use_PathCchCombine;
113
114#define PathRenameExtension PathRenameExtension_instead_use_PathCchRenameExtension;
115#define PathRenameExtensionA PathRenameExtension_instead_use_PathCchRenameExtension;
116#define PathRenameExtensionW PathRenameExtension_instead_use_PathCchRenameExtension;
117#endif
118#endif
119#endif
120
121#ifdef __cplusplus
122}
123#endif
124
125#ifdef __cplusplus
126
127#if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_APP)
128 __CRT_INLINE WINBOOL PathIsUNCEx (PWSTR path, PWSTR *pserver) {
129 return PathIsUNCEx (const_cast<PCWSTR> (path), const_cast<PCWSTR *> (pserver));
130 }
131
132 __CRT_INLINE HRESULT PathCchSkipRoot (PWSTR path, PWSTR *prootend) {
133 return PathCchSkipRoot (const_cast<PCWSTR> (path), const_cast<PCWSTR *> (prootend));
134 }
135
136 __CRT_INLINE HRESULT PathCchFindExtension (PWSTR path, size_t n, PWSTR *pext) {
137 return PathCchFindExtension (const_cast<PCWSTR> (path), n, const_cast<PCWSTR *> (pext));
138}
139#endif
140#endif
141
142#endif