ZFFramework
 
Loading...
Searching...
No Matches
ZFProtocolZFPath.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFProtocolZFPath_h_
7#define _ZFI_ZFProtocolZFPath_h_
8
9#include "ZFCore/ZFProtocol.h"
10#include "ZFCore/ZFFile.h"
11ZF_NAMESPACE_GLOBAL_BEGIN
12
16ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFCore, ZFPath)
17public:
21 virtual const zfstring &pathForModule(void) zfpurevirtual;
25 virtual const zfstring &pathForModuleFile(void) zfpurevirtual;
26
30 virtual const zfstring &pathForSetting(void) zfpurevirtual;
34 virtual void pathForSetting(ZF_IN const zfstring &path) zfpurevirtual;
35
39 virtual const zfstring &pathForStorage(void) zfpurevirtual;
43 virtual void pathForStorage(ZF_IN const zfstring &path) zfpurevirtual;
44
48 virtual const zfstring &pathForStorageShared(void) zfpurevirtual;
52 virtual void pathForStorageShared(ZF_IN const zfstring &path) zfpurevirtual;
53
57 virtual const zfstring &pathForCache(void) zfpurevirtual;
61 virtual void pathForCache(ZF_IN const zfstring &path) zfpurevirtual;
65 virtual void pathForCacheClear(void) {
66 ZFFileRemove(this->pathForCache(), ZF_HINT("isRecursive")zftrue, ZF_HINT("isForce")zftrue);
67 }
68ZFPROTOCOL_INTERFACE_END(ZFPath)
69
70ZF_NAMESPACE_GLOBAL_END
71#endif // #ifndef _ZFI_ZFProtocolZFPath_h_
72
ZFLIB_ZFCore
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
zftrue
#define zftrue
bool true type
Definition ZFCoreTypeDef_CoreType.h:107
zfstring
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
ZF_HINT
#define ZF_HINT(...)
dummy macro to show a hint
Definition ZFCoreUtilMacro.h:48
ZFFile.h
file utility
ZFFileRemove
zfbool ZFFileRemove(const zfchar *path, zfbool isRecursive=(_ZFT_t_zftrue), zfbool isForce=(_ZFT_t_zftrue))
delete a file or directory from srcPath to dstPath
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
ZFProtocol.h
protocol definitions for ZFFramework
ZFPROTOCOL_INTERFACE_END
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:414
ZFPROTOCOL_INTERFACE_BEGIN
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:408
ZFPInterface_ZFPath::pathForModuleFile
virtual const zfstring & pathForModuleFile(void)=0
see ZFPathForModuleFile
ZFPInterface_ZFPath::pathForStorage
virtual const zfstring & pathForStorage(void)=0
see ZFPathForStorage
ZFPInterface_ZFPath::pathForModule
virtual const zfstring & pathForModule(void)=0
see ZFPathForModule
ZFPInterface_ZFPath::pathForStorage
virtual void pathForStorage(const zfstring &path)=0
see ZFPathForStorage
ZFPInterface_ZFPath::pathForStorageShared
virtual const zfstring & pathForStorageShared(void)=0
see ZFPathForStorageShared
ZFPInterface_ZFPath::pathForCacheClear
virtual void pathForCacheClear(void)
see ZFPathForCacheClear
Definition ZFProtocolZFPath.h:65
ZFPInterface_ZFPath::pathForStorageShared
virtual void pathForStorageShared(const zfstring &path)=0
see ZFPathForStorageShared
ZFPInterface_ZFPath::pathForCache
virtual const zfstring & pathForCache(void)=0
see ZFPathForCache
ZFPInterface_ZFPath::pathForCache
virtual void pathForCache(const zfstring &path)=0
see ZFPathForCache
ZFPInterface_ZFPath::pathForSetting
virtual const zfstring & pathForSetting(void)=0
see ZFPathForSetting
ZFPInterface_ZFPath::pathForSetting
virtual void pathForSetting(const zfstring &path)=0
see ZFPathForSetting