ZFFramework
 
Loading...
Searching...
No Matches
ZFIO_res.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFIO_res_h_
7#define _ZFI_ZFIO_res_h_
8
9#include "ZFIODef.h"
11
19
20// ============================================================
21// ZFInputForRes
32 , ZFMP_IN(const zfstring &, resFilePath)
33 ) {
34 ZFInput ret;
35 ZFInputForPathInfoT(ret, ZFPathInfo(ZFPathType_res(), resFilePath));
36 return ret;
37}
38
39// ============================================================
58 , ZFMP_IN(const ZFPathInfo &, pathInfo)
59 )
62 , ZFMP_IN(const ZFPathInfo &, pathInfo)
63 )
76 , ZFMP_OUT(ZFPathInfo &, resExtPath)
77 , ZFMP_IN(const zfstring &, resPath)
78 )
79
80// ============================================================
86 , ZFMP_IN(const zfstring &, resPath)
87 )
93 , ZFMP_IN(const zfstring &, resPath)
94 )
95
104 , ZFMP_IN(const zfstring &, resPath)
118
143 , ZFMP_IN(const zfstring &, resPath)
149 , ZFMP_IN(void *, token)
151
156 , ZFMP_IN(void *, token)
162 , ZFMP_IN(void *, token)
163 , ZFMP_IN(zfindex, byteSize)
164 , ZFMP_IN_OPT(ZFSeekPos, seekPos, ZFSeekPosBegin)
166
171 , ZFMP_IN(void *, token)
172 , ZFMP_IN(void *, buf)
173 , ZFMP_IN(zfindex, maxByteSize)
175
180 , ZFMP_IN(void *, token)
182
184#endif // #ifndef _ZFI_ZFIO_res_h_
185
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
_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
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
zfindex ZFResRead(void *token, void *buf, zfindex maxByteSize)
see ZFResOpen ZFFileRead
zfindex ZFResSize(void *token)
see ZFResOpen, ZFFileSize
const zfstring & ZFPathType_res()
see ZFPathInfo
void * ZFResOpen(const zfstring &resPath)
open a resource file for read only, see ZFFileOpen
zfbool ZFResClose(void *token)
see ZFResOpen ZFFileClose
zfbool ZFResFindFirst(ZFIOFindData &fd, const zfstring &resPath)
zfbool ZFResIsExist(const zfstring &resPath)
return true if res file specified by path is exist
void ZFResExtPathAdd(const ZFPathInfo &pathInfo)
add an additional path to search as resource files
ZFCoreArray< ZFPathInfo > ZFResExtPathList()
see ZFResExtPathAdd
zfbool ZFResSeek(void *token, zfindex byteSize, ZFSeekPos seekPos=(ZFSeekPosBegin))
see ZFResOpen ZFFileSeek
zfbool ZFResExtPathCheck(ZFPathInfo &resExtPath, const zfstring &resPath)
see ZFResExtPathAdd
void ZFResFindClose(ZFIOFindData &fd)
void ZFResExtPathRemove(const ZFPathInfo &pathInfo)
see ZFResExtPathAdd
zfbool ZFResFindNext(ZFIOFindData &fd)
ZFInput ZFInputForRes(const zfstring &resFilePath)
util to create a resource file input callback, see ZFResOpen for what resource file is
Definition ZFIO_res.h:33
zfindex ZFResTell(void *token)
see ZFResOpen ZFFileTell
zfbool ZFResIsDir(const zfstring &resPath)
return true if res file specified by path is a directory
abstract IO
#define ZFIO_DECLARE(ZFLIB_, pathType)
see ZFIOImplForPathType
Definition ZFIODef_fwd.h:515
zfbool ZFInputForPathInfoT(ZFCallback &ret, const ZFPathInfo &pathInfo)
see ZFInputForPathInfo
#define ZFMP_IN_OUT(ParamType, paramName)
see ZFMP_IN
Definition ZFMethod.h:117
#define ZFMP_OUT(ParamType, paramName)
see ZFMP_IN
Definition ZFMethod.h:111
#define ZFMP_IN_OPT(ParamType, paramName, DefaultValue)
see ZFMP_IN
Definition ZFMethod.h:108
#define ZFMP_IN(ParamType, paramName)
macro to wrap param types for ZFMETHOD_INLINE_0 series
Definition ZFMethod.h:105
#define ZFMETHOD_FUNC_DECLARE_2(ZFLIB_, ReturnType, MethodName, ZFMP_0, ZFMP_1)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:763
#define ZFMETHOD_FUNC_INLINE_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:692
#define ZFMETHOD_FUNC_DECLARE_3(ZFLIB_, ReturnType, MethodName, ZFMP_0, ZFMP_1, ZFMP_2)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:910
#define ZFMETHOD_FUNC_DECLARE_0(ZFLIB_, ReturnType, MethodName)
declare function type of ZFMethod
Definition ZFMethodFuncDeclare.h:493
#define ZFMETHOD_FUNC_DECLARE_1(ZFLIB_, ReturnType, MethodName, ZFMP_0)
see ZFMETHOD_FUNC_DECLARE_0
Definition ZFMethodFuncDeclare.h:624
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
light weight array
Definition ZFCoreArray.h:331
data used by ZFIO when finding files
Definition ZFIODef_fwd.h:71
general input callback
Definition ZFIOCallback_input.h:35
path related info storage for impl, actual meaning of the info depends on impl
Definition ZFPathInfo.h:34