ZFFramework
 
Loading...
Searching...
No Matches
ZFFile_path.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFFile_path_h_
7#define _ZFI_ZFFile_path_h_
8
9#include "ZFFile_fwd.h"
10ZF_NAMESPACE_GLOBAL_BEGIN
11
12// ============================================================
13// cwd
19ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, ZFPathForCwd)
25ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, zfbool, ZFPathForCwd
26 , ZFMP_IN(const zfstring &, path)
27 )
32ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, zfstring, ZFPathForCwdOrModule)
33
34// ============================================================
35// module
42ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForModule)
50ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForModuleFile)
51
52// ============================================================
53// setting
54ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
62ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForSettingOnUpdate)
63ZF_NAMESPACE_END(ZFGlobalEvent)
64
71ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForSetting)
75ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForSetting
76 , ZFMP_IN(const zfstring &, path)
77 )
78
79// ============================================================
80// storage
81ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
89ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForStorageOnUpdate)
90ZF_NAMESPACE_END(ZFGlobalEvent)
91
98ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForStorage)
102ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForStorage
103 , ZFMP_IN(const zfstring &, path)
104 )
105
106// ============================================================
107// storage shared
108ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
116ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForStorageSharedOnUpdate)
117ZF_NAMESPACE_END(ZFGlobalEvent)
118
129ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForStorageShared)
133ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForStorageShared
134 , ZFMP_IN(const zfstring &, path)
135 )
136
137// ============================================================
138// cache
139ZF_NAMESPACE_BEGIN(ZFGlobalEvent)
147ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheOnUpdate)
153ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheBeforeClear)
159ZFEVENT_GLOBAL(ZFLIB_ZFCore, ZFPathForCacheAfterClear)
160ZF_NAMESPACE_END(ZFGlobalEvent)
161
170ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, const zfstring &, ZFPathForCache)
174ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFCore, void, ZFPathForCache
175 , ZFMP_IN(const zfstring &, path)
176 )
180ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFCore, void, ZFPathForCacheClear)
181
182ZF_NAMESPACE_GLOBAL_END
183#endif // #ifndef _ZFI_ZFFile_path_h_
184
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
ZFFile_fwd.h
file utility
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