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"
10ZF_NAMESPACE_GLOBAL_BEGIN
11
15ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFCore, ZFRes)
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 void *resOpen(ZF_IN const zfchar *resPath);
46 virtual zfbool resClose(ZF_IN void *token);
47
51 virtual zfindex resTell(ZF_IN void *token);
55 virtual zfbool resSeek(
56 ZF_IN void *token
57 , ZF_IN zfindex byteSize
58 , ZF_IN_OPT ZFSeekPos seekPos = ZFSeekPosBegin
59 );
60
64 virtual zfindex resRead(
65 ZF_IN void *token
66 , ZF_IN void *buf
67 , ZF_IN zfindex maxByteSize
68 );
69
73 virtual zfbool resFindFirst(
74 ZF_IN_OUT ZFIOFindData::Impl &fd
75 , ZF_IN const zfchar *resPath
76 );
80 virtual zfbool resFindNext(ZF_IN_OUT ZFIOFindData::Impl &fd);
84 virtual void resFindClose(ZF_IN_OUT ZFIOFindData::Impl &fd);
85ZFPROTOCOL_INTERFACE_END(ZFRes)
86
87ZF_NAMESPACE_GLOBAL_END
88#endif // #ifndef _ZFI_ZFProtocolZFRes_h_
89
ZFLIB_ZFCore
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
zfchar
_ZFT_t_zfchar zfchar
char wrapper
Definition ZFCoreTypeDef_CharType.h:17
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
ZF_IN_OPT
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:184
ZF_IN_OUT
#define ZF_IN_OUT
dummy macro that shows the param used as required input and output
Definition ZFCoreTypeDef_ClassType.h:196
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zfindex
_ZFT_t_zfindex zfindex
similar to size_t, used for index and size only
Definition ZFCoreTypeDef_CoreType.h:154
ZFSeekPos
ZFSeekPos
seek position similar to SEEK_SET of FILE operation
Definition ZFCoreTypeDef_OtherType.h:47
zfstring
zft_zfstring< zfchar > zfstring
see zft_zfstring
Definition ZFCoreTypeDef_StringType.h:15
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_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
ZFProtocolZFFile.h
protocol for ZFFile
ZFIOFindData::Impl
for impl to achieve custom find logic
Definition ZFIODef_fwd.h:110
ZFPInterface_ZFRes::resTell
virtual zfindex resTell(void *token)
see ZFResTell
ZFPInterface_ZFRes::resIsDir
virtual zfbool resIsDir(const zfchar *resPath)
see ZFResIsDir
ZFPInterface_ZFRes::resOpen
virtual void * resOpen(const zfchar *resPath)
see ZFResOpen
ZFPInterface_ZFRes::resClose
virtual zfbool resClose(void *token)
see ZFResClose
ZFPInterface_ZFRes::resFindFirst
virtual zfbool resFindFirst(ZFIOFindData::Impl &fd, const zfchar *resPath)
see ZFResFindFirst, ZFFileFindFirst
ZFPInterface_ZFRes::resIsExist
virtual zfbool resIsExist(const zfchar *resPath)
see ZFResIsExist
ZFPInterface_ZFRes::resFindClose
virtual void resFindClose(ZFIOFindData::Impl &fd)
see ZFResFindClose, ZFFileFindClose
ZFPInterface_ZFRes::resRead
virtual zfindex resRead(void *token, void *buf, zfindex maxByteSize)
see ZFResRead
ZFPInterface_ZFRes::resFindNext
virtual zfbool resFindNext(ZFIOFindData::Impl &fd)
see ZFResFindNext, ZFFileFindNext
ZFPInterface_ZFRes::resSeek
virtual zfbool resSeek(void *token, zfindex byteSize, ZFSeekPos seekPos=ZFSeekPosBegin)
see ZFResSeek
ZFPInterface_ZFRes::resRootPath
virtual const zfstring & resRootPath(void)
util method to access root path for file res impl