ZFFramework
 
Loading...
Searching...
No Matches
ZFIODef_pathInfo.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFIODef_pathInfo_h_
7#define _ZFI_ZFIODef_pathInfo_h_
8
9#include "ZFIODef_fwd.h"
10
12
13// ============================================================
16 , ZFMP_IN(const ZFPathInfo &, pathInfo)
17 )
20 , ZFMP_IN(const ZFPathInfo &, pathInfo)
21 )
24 , ZFMP_IN_OUT(zfstring &, ret)
25 , ZFMP_IN(const ZFPathInfo &, pathInfo)
26 )
29 , ZFMP_IN_OUT(zfstring &, ret)
30 , ZFMP_IN(const ZFPathInfo &, pathInfo)
31 , ZFMP_IN(const zfstring &, childName)
32 )
35 , ZFMP_IN_OUT(zfstring &, ret)
36 , ZFMP_IN(const ZFPathInfo &, pathInfo)
37 )
40 , ZFMP_IN(const ZFPathInfo &, pathInfo)
41 , ZFMP_IN_OPT(zfbool, autoCreateParent, zftrue)
42 )
45 , ZFMP_IN(const ZFPathInfo &, pathInfo)
46 , ZFMP_IN_OPT(zfbool, isRecursive, zftrue)
47 , ZFMP_IN_OPT(zfbool, isForce, zftrue)
48 )
51 , ZFMP_IN(const ZFPathInfo &, pathInfoFrom)
52 , ZFMP_IN(const zfstring &, pathDataTo)
53 , ZFMP_IN_OPT(zfbool, isForce, zftrue)
54 )
55
58 , ZFMP_IN(const ZFPathInfo &, pathInfo)
60 , ZFMP_IN_OPT(zfbool, autoCreateParent, zftrue)
61 )
62
63// ============================================================
64// utils
73 , ZFMP_IN_OPT(const zfstring &, localPath, zfnull)
74 )
79 , ZFMP_OUT(ZFPathInfo &, ret)
80 , ZFMP_IN(const ZFPathInfo &, pathInfo)
81 , ZFMP_IN(const zfstring &, childPath)
82 )
87 , ZFMP_OUT(zfstring &, ret)
88 , ZFMP_IN(const ZFPathInfo &, pathInfo)
89 , ZFMP_IN(const zfstring &, childPath)
90 )
95 , ZFMP_IN(const ZFPathInfo &, pathInfo)
96 , ZFMP_IN(const zfstring &, childPath)
97 )
98
99// ============================================================
100// ZFInputForPathInfo
113#define ZFCallbackSerializeType_ZFInputForPathInfo "ZFInputForPathInfo"
114
126 , ZFMP_IN(const ZFPathInfo &, pathInfo)
136 , ZFMP_IN_OUT(ZFCallback &, ret)
137 , ZFMP_IN(const ZFPathInfo &, pathInfo)
139
142 , ZFMP_IN(ZFIOToken *, token)
146 , ZFMP_IN_OUT(ZFCallback &, ret)
147 , ZFMP_IN(ZFIOToken *, token)
149
150// ============================================================
151// ZFOutputForPathInfo
164#define ZFCallbackSerializeType_ZFOutputForPathInfo "ZFOutputForPathInfo"
165
177 , ZFMP_IN(const ZFPathInfo &, pathInfo)
187 , ZFMP_IN_OUT(ZFCallback &, ret)
188 , ZFMP_IN(const ZFPathInfo &, pathInfo)
190
193 , ZFMP_IN(ZFIOToken *, token)
197 , ZFMP_IN_OUT(ZFCallback &, ret)
198 , ZFMP_IN(ZFIOToken *, token)
200
201// ============================================================
202// ZFInputForLocal
215#define ZFCallbackSerializeType_ZFInputForLocal "ZFInputForLocal"
216
230 , ZFMP_IN(const zfstring &, localPath)
231 , ZFMP_IN(const ZFPathInfo &, pathInfo)
237 , ZFMP_OUT(ZFCallback &, ret)
238 , ZFMP_IN(const zfstring &, localPath)
239 , ZFMP_IN(const ZFPathInfo &, pathInfo)
241
242// ============================================================
243// ZFOutputForLocal
256#define ZFCallbackSerializeType_ZFOutputForLocal "ZFOutputForLocal"
257
272 , ZFMP_IN(const zfstring &, localPath)
273 , ZFMP_IN(const ZFPathInfo &, pathInfo)
279 , ZFMP_OUT(ZFCallback &, ret)
280 , ZFMP_IN(const zfstring &, localPath)
281 , ZFMP_IN(const ZFPathInfo &, pathInfo)
283
284// ============================================================
289 , ZFMP_IN_OUT(ZFCallback &, ret)
290 , ZFMP_IN(const ZFPathInfo &, pathInfo)
297 , ZFMP_IN_OUT(ZFCallback &, ret)
298 , ZFMP_IN(const ZFPathInfo &, pathInfo)
301
302// ============================================================
326 , ZFMP_OUT(ZFPathInfo &, chainPathInfo)
327 , ZFMP_IN_OUT(zfstring &, pathData)
328 , ZFMP_IN(const zfchar *, pathDataOrig)
332 , ZFMP_OUT(zfstring &, chainPathInfoString)
333 , ZFMP_IN_OUT(zfstring &, pathData)
334 , ZFMP_IN(const zfchar *, pathDataOrig)
338 , ZFMP_IN_OUT(zfstring &, ret)
339 , ZFMP_IN(const ZFPathInfo &, chainPathInfo)
340 , ZFMP_IN(const zfchar *, pathData)
344 , ZFMP_IN(const ZFPathInfo &, chainPathInfo)
345 , ZFMP_IN(const zfchar *, pathData)
347
348extern ZFLIB_ZFCore const zfchar _ZFP_ZFPathInfoChainCharMap[256];
356#define ZFPathInfoChainCharMap() _ZFP_ZFPathInfoChainCharMap
357
359#endif // #ifndef _ZFI_ZFIODef_pathInfo_h_
360
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
_ZFT_t_zfchar zfchar
char wrapper
Definition ZFCoreTypeDef_CharType.h:17
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
#define zftrue
bool true type
Definition ZFCoreTypeDef_CoreType.h:107
#define zfnull
same as NULL, defined for future use
Definition ZFCoreTypeDef_CoreType.h:88
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
abstract IO
ZFOutput ZFOutputForPathInfo(const ZFPathInfo &pathInfo)
util to create a file output callback
ZFInput ZFInputForPathInfoToken(ZFIOToken *token)
see ZFInputForPathInfo
zfbool ZFIOMove(const ZFPathInfo &pathInfoFrom, const zfstring &pathDataTo, zfbool isForce=(_ZFT_t_zftrue))
see ZFIOImplForPathType
void ZFInputMarkSerializable(ZFCallback &ret, const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Read))
util to mark a ZFInput serializable with specified pathInfo
zfbool ZFOutputForLocalT(ZFCallback &ret, const zfstring &localPath, const ZFPathInfo &pathInfo)
see ZFOutputForLocal
ZFOutput ZFOutputForPathInfoToken(ZFIOToken *token)
see ZFOutputForPathInfo
zfbool ZFIOPathCreate(const ZFPathInfo &pathInfo, zfbool autoCreateParent=(_ZFT_t_zftrue))
see ZFIOImplForPathType
ZFOutput ZFOutputForLocal(const zfstring &localPath, const ZFPathInfo &pathInfo)
util to create a file output callback
zfbool ZFIOIsExist(const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
zfbool ZFInputForPathInfoTokenT(ZFCallback &ret, ZFIOToken *token)
see ZFInputForPathInfo
zfbool ZFPathInfoChainDecode(ZFPathInfo &chainPathInfo, zfstring &pathData, const zfchar *pathDataOrig)
util for impl to parse chained path data
zfbool ZFInputForPathInfoT(ZFCallback &ret, const ZFPathInfo &pathInfo)
see ZFInputForPathInfo
ZFPathInfo ZFLocalPathInfo(const zfstring &localPath=(zft_zfnull))
return local path info for current context
zfbool ZFPathInfoForLocalT(ZFPathInfo &ret, const ZFPathInfo &pathInfo, const zfstring &childPath)
util to make a child path info relative to existing one
zfbool ZFInputForLocalT(ZFCallback &ret, const zfstring &localPath, const ZFPathInfo &pathInfo)
see ZFInputForLocal
void ZFPathInfoChainEncodeT(zfstring &ret, const ZFPathInfo &chainPathInfo, const zfchar *pathData)
see ZFPathInfoChainDecode
zfbool ZFPathInfoChainDecodeString(zfstring &chainPathInfoString, zfstring &pathData, const zfchar *pathDataOrig)
see ZFPathInfoChainDecode
zfbool ZFIOToParent(zfstring &ret, const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
zfstring ZFPathInfoChainEncode(const ZFPathInfo &chainPathInfo, const zfchar *pathData)
see ZFPathInfoChainDecode
zfbool ZFIOToFileName(zfstring &ret, const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
void ZFOutputMarkSerializable(ZFCallback &ret, const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Write))
util to mark a ZFOutput serializable with specified pathInfo
ZFPathInfo ZFPathInfoForLocal(const ZFPathInfo &pathInfo, const zfstring &childPath)
see ZFPathInfoForLocalT
zfbool ZFOutputForPathInfoTokenT(ZFCallback &ret, ZFIOToken *token)
see ZFOutputForPathInfo
zfbool ZFIORemove(const ZFPathInfo &pathInfo, zfbool isRecursive=(_ZFT_t_zftrue), zfbool isForce=(_ZFT_t_zftrue))
see ZFIOImplForPathType
zfbool ZFIOToChild(zfstring &ret, const ZFPathInfo &pathInfo, const zfstring &childName)
see ZFIOImplForPathType
ZFInput ZFInputForPathInfo(const ZFPathInfo &pathInfo)
util to create a file input callback
zfautoT< ZFIOToken > ZFIOOpen(const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags, zfbool autoCreateParent=(_ZFT_t_zftrue))
see ZFIOImplForPathType
zfbool ZFOutputForPathInfoT(ZFCallback &ret, const ZFPathInfo &pathInfo)
see ZFOutputForPathInfo
ZFInput ZFInputForLocal(const zfstring &localPath, const ZFPathInfo &pathInfo)
util to create a file input callback
zfbool ZFIOIsDir(const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
#define ZFMP_IN_OUT(ParamType, paramName)
see ZFMP_IN
Definition ZFMethod.h:117
#define ZFMP_OUT(ParamType, paramName)
see ZFMP_IN
Definition ZFMethod.h:111
#define ZFMP_IN_OPT(ParamType, paramName, DefaultValue)
see ZFMP_IN
Definition ZFMethod.h:108
#define ZFMP_IN(ParamType, paramName)
macro to wrap param types for ZFMETHOD_INLINE_0 series
Definition ZFMethod.h:105
#define ZFMETHOD_FUNC_DECLARE_2(ZFLIB_, ReturnType, MethodName, ZFMP_0, ZFMP_1)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:763
#define ZFMETHOD_FUNC_DECLARE_3(ZFLIB_, ReturnType, MethodName, ZFMP_0, ZFMP_1, ZFMP_2)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:910
#define ZFMETHOD_FUNC_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:624
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
callback used by ZFFramework
Definition ZFCallback.h:98
see v_ZFIOOpenOption, ZFIOOpenOptionFlagsToString, ZFIOOpenOptionFlagsFromString
Definition ZFIODef_fwd.h:49
see ZFIOImplForPathType
Definition ZFIODef_fwd.h:164
general input callback
Definition ZFIOCallback_input.h:35
general output callback
Definition ZFIOCallback_output.h:37
path related info storage for impl, actual meaning of the info depends on impl
Definition ZFPathInfo.h:34
file open option
Definition ZFIODef_fwd.h:41
type restrict version of zfauto
Definition zfautoFwd.h:113