ZFFramework
 
Loading...
Searching...
No Matches
ZFProtocolZFRes.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFProtocolZFRes_h_
7#define _ZFI_ZFProtocolZFRes_h_
8
9#include "ZFProtocolZFFile.h"
11
16
17public:
27 virtual const zfstring &resRootPath(void);
28
29public:
33 virtual zfbool resIsExist(ZF_IN const zfchar *resPath);
37 virtual zfbool resIsDir(ZF_IN const zfchar *resPath);
38
42 virtual zfbool resCopy(
43 ZF_IN const zfchar *resPath
44 , ZF_IN const zfchar *dstPath
45 , ZF_IN_OPT zfbool isRecursive = zftrue
46 , ZF_IN_OPT zfbool isForce = zftrue
47 );
51 virtual void *resOpen(ZF_IN const zfchar *resPath);
55 virtual zfbool resClose(ZF_IN void *token);
56
60 virtual zfindex resTell(ZF_IN void *token);
64 virtual zfbool resSeek(
65 ZF_IN void *token
66 , ZF_IN zfindex byteSize
67 , ZF_IN_OPT ZFSeekPos position = ZFSeekPosBegin
68 );
69
74 ZF_IN void *token
75 , ZF_IN void *buf
76 , ZF_IN zfindex maxByteSize
77 );
78
82 virtual zfbool resIsEof(ZF_IN void *token);
86 virtual zfbool resIsError(ZF_IN void *token);
87
93 , ZF_IN const zfchar *resPath
94 );
104
106#endif // #ifndef _ZFI_ZFProtocolZFRes_h_
107
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
_ZFT_t_zfchar zfchar
char wrapper
Definition ZFCoreTypeDef_CharType.h:17
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:184
#define ZF_IN_OUT
dummy macro that shows the param used as required input and output
Definition ZFCoreTypeDef_ClassType.h:196
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
_ZFT_t_zfindex zfindex
similar to size_t, used for index and size only
Definition ZFCoreTypeDef_CoreType.h:154
#define zftrue
bool true type
Definition ZFCoreTypeDef_CoreType.h:107
ZFSeekPos
seek position similar to SEEK_SET of FILE operation
Definition ZFCoreTypeDef_OtherType.h:47
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:414
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:408
protocol for ZFFile
for impl to achieve custom find logic
Definition ZFFile_fwd.h:92
virtual zfindex resTell(void *token)
see ZFResTell
virtual zfbool resIsDir(const zfchar *resPath)
see ZFResIsDir
virtual zfbool resFindFirst(ZFFileFindData::Impl &fd, const zfchar *resPath)
see ZFResFindFirst, ZFFileFindFirst
virtual zfbool resIsEof(void *token)
see ZFResIsEof
virtual void * resOpen(const zfchar *resPath)
see ZFResOpen
virtual zfbool resClose(void *token)
see ZFResClose
virtual zfbool resIsExist(const zfchar *resPath)
see ZFResIsExist
virtual zfbool resCopy(const zfchar *resPath, const zfchar *dstPath, zfbool isRecursive=_ZFT_t_zftrue, zfbool isForce=_ZFT_t_zftrue)
see ZFResCopy
virtual zfbool resIsError(void *token)
see ZFResIsError
virtual void resFindClose(ZFFileFindData::Impl &fd)
see ZFResFindClose, ZFFileFindClose
virtual zfbool resSeek(void *token, zfindex byteSize, ZFSeekPos position=ZFSeekPosBegin)
see ZFResSeek
virtual zfindex resRead(void *token, void *buf, zfindex maxByteSize)
see ZFResRead
virtual zfbool resFindNext(ZFFileFindData::Impl &fd)
see ZFResFindNext, ZFFileFindNext
virtual const zfstring & resRootPath(void)
util method to access root path for file res impl