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 zfstring &, pathDataTo)
52 , ZFMP_IN(const ZFPathInfo &, pathInfoFrom)
53 , ZFMP_IN_OPT(zfbool, isForce, zftrue)
54 )
57 , ZFMP_IN(const ZFPathInfo &, pathInfo)
58 )
61 , ZFMP_IN(const ZFPathInfo &, pathInfo)
62 , ZFMP_IN(zftimet, time)
63 )
64
67 , ZFMP_IN(const ZFPathInfo &, pathInfo)
69 , ZFMP_IN_OPT(zfbool, autoCreateParent, zftrue)
70 )
71
72// ============================================================
73// utils
82 , ZFMP_IN_OPT(const zfstring &, localPath, zfnull)
83 )
88 , ZFMP_OUT(ZFPathInfo &, ret)
89 , ZFMP_IN(const ZFPathInfo &, pathInfo)
90 , ZFMP_IN(const zfstring &, childPath)
91 )
96 , ZFMP_OUT(zfstring &, ret)
97 , ZFMP_IN(const ZFPathInfo &, pathInfo)
98 , ZFMP_IN(const zfstring &, childPath)
99 )
104 , ZFMP_IN(const ZFPathInfo &, pathInfo)
105 , ZFMP_IN(const zfstring &, childPath)
107
108// ============================================================
109// ZFInputForPathInfo
122#define ZFCallbackSerializeType_ZFInputForPathInfo "ZFInputForPathInfo"
123
135 , ZFMP_IN(const ZFPathInfo &, pathInfo)
145 , ZFMP_IN_OUT(ZFCallback &, ret)
146 , ZFMP_IN(const ZFPathInfo &, pathInfo)
148
151 , ZFMP_IN(ZFIOToken *, token)
155 , ZFMP_IN_OUT(ZFCallback &, ret)
156 , ZFMP_IN(ZFIOToken *, token)
158
159// ============================================================
160// ZFOutputForPathInfo
174#define ZFCallbackSerializeType_ZFOutputForPathInfo "ZFOutputForPathInfo"
175
187 , ZFMP_IN(const ZFPathInfo &, pathInfo)
198 , ZFMP_IN_OUT(ZFCallback &, ret)
199 , ZFMP_IN(const ZFPathInfo &, pathInfo)
202
205 , ZFMP_IN(ZFIOToken *, token)
209 , ZFMP_IN_OUT(ZFCallback &, ret)
210 , ZFMP_IN(ZFIOToken *, token)
212
213// ============================================================
214// ZFInputForLocal
227#define ZFCallbackSerializeType_ZFInputForLocal "ZFInputForLocal"
228
242 , ZFMP_IN(const zfstring &, localPath)
243 , ZFMP_IN(const ZFPathInfo &, pathInfo)
249 , ZFMP_OUT(ZFCallback &, ret)
250 , ZFMP_IN(const zfstring &, localPath)
251 , ZFMP_IN(const ZFPathInfo &, pathInfo)
253
254// ============================================================
255// ZFOutputForLocal
269#define ZFCallbackSerializeType_ZFOutputForLocal "ZFOutputForLocal"
270
285 , ZFMP_IN(const zfstring &, localPath)
286 , ZFMP_IN(const ZFPathInfo &, pathInfo)
293 , ZFMP_OUT(ZFCallback &, ret)
294 , ZFMP_IN(const zfstring &, localPath)
295 , ZFMP_IN(const ZFPathInfo &, pathInfo)
298
299// ============================================================
304 , ZFMP_IN_OUT(ZFCallback &, ret)
305 , ZFMP_IN(const ZFPathInfo &, pathInfo)
311 , ZFMP_IN_OUT(ZFCallback &, ret)
312 , ZFMP_IN(const ZFPathInfo &, pathInfo)
315
316// ============================================================
340 , ZFMP_OUT(ZFPathInfo &, chainPathInfo)
341 , ZFMP_IN_OUT(zfstring &, pathData)
342 , ZFMP_IN(const zfchar *, pathDataOrig)
346 , ZFMP_OUT(zfstring &, chainPathInfoString)
347 , ZFMP_IN_OUT(zfstring &, pathData)
348 , ZFMP_IN(const zfchar *, pathDataOrig)
352 , ZFMP_IN_OUT(zfstring &, ret)
353 , ZFMP_IN(const ZFPathInfo &, chainPathInfo)
354 , ZFMP_IN(const zfchar *, pathData)
358 , ZFMP_IN(const ZFPathInfo &, chainPathInfo)
359 , ZFMP_IN(const zfchar *, pathData)
361
362extern ZFLIB_ZFCore const zfchar _ZFP_ZFPathInfoChainCharMap[256];
370#define ZFPathInfoChainCharMap() _ZFP_ZFPathInfoChainCharMap
371
373#endif // #ifndef _ZFI_ZFIODef_pathInfo_h_
374
#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
_zft_zftimet zftimet
time unit, ensured at least 64 bit, ensured signed
Definition ZFCoreTypeDef_CoreType.h:203
#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
ZFInput ZFInputForIOToken(ZFIOToken *token)
see ZFInputForPathInfo
zfbool ZFIOPathCreate(const ZFPathInfo &pathInfo, zfbool autoCreateParent=(_ZFT_t_zftrue))
see ZFIOImplForPathType
zfbool ZFIOIsExist(const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
zfbool ZFPathInfoChainDecode(ZFPathInfo &chainPathInfo, zfstring &pathData, const zfchar *pathDataOrig)
util for impl to parse chained path data
zfbool ZFOutputForLocalT(ZFCallback &ret, const zfstring &localPath, const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Write))
see ZFOutputForLocal
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
zfbool ZFOutputForIOTokenT(ZFCallback &ret, ZFIOToken *token)
see ZFOutputForPathInfo
zfbool ZFIOMove(const zfstring &pathDataTo, const ZFPathInfo &pathInfoFrom, zfbool isForce=(_ZFT_t_zftrue))
see ZFIOImplForPathType
void ZFPathInfoChainEncodeT(zfstring &ret, const ZFPathInfo &chainPathInfo, const zfchar *pathData)
see ZFPathInfoChainDecode
void ZFInputMarkSerializable(ZFCallback &ret, const ZFPathInfo &pathInfo)
util to mark a ZFInput serializable with specified pathInfo
zfbool ZFPathInfoChainDecodeString(zfstring &chainPathInfoString, zfstring &pathData, const zfchar *pathDataOrig)
see ZFPathInfoChainDecode
ZFOutput ZFOutputForIOToken(ZFIOToken *token)
see ZFOutputForPathInfo
zfbool ZFOutputForPathInfoT(ZFCallback &ret, const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Write))
see ZFOutputForPathInfo
zftimet ZFIOModTime(const ZFPathInfo &pathInfo)
see ZFIOImplForPathType
zfbool ZFInputForIOTokenT(ZFCallback &ret, ZFIOToken *token)
see ZFInputForPathInfo
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
ZFOutput ZFOutputForLocal(const zfstring &localPath, const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Write))
util to create a file output callback
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 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
ZFOutput ZFOutputForPathInfo(const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags=(v_ZFIOOpenOption::e_Write))
util to create a file output callback
zfautoT< ZFIOToken > ZFIOOpen(const ZFPathInfo &pathInfo, ZFIOOpenOptionFlags flags, zfbool autoCreateParent=(_ZFT_t_zftrue))
see ZFIOImplForPathType
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_4(ZFLIB_, ReturnType, MethodName, ZFMP_0, ZFMP_1, ZFMP_2, ZFMP_3)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:1065
#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:36
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
@ e_Write
Write(1 << 1)
Definition ZFIODef_fwd.h:43
type restrict version of zfauto
Definition zfautoFwd.h:108