ZFFramework
 
Loading...
Searching...
No Matches
ZFIODef_path.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFIODef_path_h_
7#define _ZFI_ZFIODef_path_h_
8
9#include "ZFIODef_fwd.h"
10
11ZF_NAMESPACE_GLOBAL_BEGIN
12
13// ============================================================
14// cwd
20ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, ZFPathForCwd)
26ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, zfbool, ZFPathForCwd
27 , ZFMP_IN(const zfstring &, path)
28 )
33ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, ZFPathForCwdOrModule)
34
35// ============================================================
36// module
43ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForModule)
51ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForModuleFile)
52
53// ============================================================
54// setting
55ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
63ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForSettingOnUpdate)
64ZF_NAMESPACE_END(ZFGlobalEvent)
65
72ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForSetting)
76ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForSetting
77 , ZFMP_IN(const zfstring &, path)
78 )
79
80// ============================================================
81// storage
82ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
90ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForStorageOnUpdate)
91ZF_NAMESPACE_END(ZFGlobalEvent)
92
99ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForStorage)
103ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForStorage
104 , ZFMP_IN(const zfstring &, path)
105 )
106
107// ============================================================
108// storage shared
109ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
117ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForStorageSharedOnUpdate)
118ZF_NAMESPACE_END(ZFGlobalEvent)
119
130ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForStorageShared)
134ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForStorageShared
135 , ZFMP_IN(const zfstring &, path)
136 )
137
138// ============================================================
139// cache
140ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
148ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheOnUpdate)
154ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheBeforeClear)
160ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheAfterClear)
161ZF_NAMESPACE_END(ZFGlobalEvent)
162
171ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForCache)
175ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForCache
176 , ZFMP_IN(const zfstring &, path)
177 )
181ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, void, ZFPathForCacheClear)
182
183ZF_NAMESPACE_GLOBAL_END
184#endif // #ifndef _ZFI_ZFIODef_path_h_
185
ZFLIB_ZFCore
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zfstring
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
ZFIODef_fwd.h
abstract IO
ZFPathForStorage
const zfstring & ZFPathForStorage()
get a proper storage path that app can write files to
ZFPathForModuleFile
const zfstring & ZFPathForModuleFile()
get module's path, e.g. "/path/module.exe"
ZFPathForStorageShared
const zfstring & ZFPathForStorageShared()
get a proper shared storage path that app can write files to, and other app can access
ZFPathForSetting
const zfstring & ZFPathForSetting()
get a proper data path that app can save settings to
ZFPathForCache
const zfstring & ZFPathForCache()
get a proper cache path that app can write files to
ZFPathForCwd
zfstring ZFPathForCwd()
get current working directory
ZFPathForCwdOrModule
zfstring ZFPathForCwdOrModule()
util method to access ZFPathForCwd, return ZFPathForModule if not available
ZFPathForModule
const zfstring & ZFPathForModule()
get module's parent's path, e.g. "/path"
ZFPathForCacheClear
void ZFPathForCacheClear()
clear all caches under ZFPathForCache
ZFMP_IN
#define ZFMP_IN(ParamType, paramName)
macro to wrap param types for ZFMETHOD_INLINE_0 series
Definition ZFMethod.h:105
ZFMETHOD_FUNC_DECLARE_0
#define ZFMETHOD_FUNC_DECLARE_0(ZFLIB_, ReturnType, MethodName)
declare function type of ZFMethod
Definition ZFMethodFuncDeclare.h:493
ZFMETHOD_FUNC_DECLARE_1
#define ZFMETHOD_FUNC_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:624
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_END
#define ZF_NAMESPACE_END(NameSpace)
end namespace
Definition ZFNamespace.h:60
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
ZF_NAMESPACE_BEGIN
#define ZF_NAMESPACE_BEGIN(NameSpace)
begin namespace
Definition ZFNamespace.h:40
ZFEVENT_GLOBAL
#define ZFEVENT_GLOBAL(ZFLIB_, YourEvent)
declare a observer event in global scope, see ZFEVENT
Definition ZFObjectObserver.h:369
ZFGlobalEvent
Definition ZFApp.h:13