ZFFramework
 
Loading...
Searching...
No Matches
ZFIOCallback_fwd.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFIOCallback_fwd_h_
7#define _ZFI_ZFIOCallback_fwd_h_
8
9#include "ZFCallback.h"
10ZF_NAMESPACE_GLOBAL_BEGIN
11
12// ============================================================
41#define ZFCallbackTagKeyword_ioOwner "ZFCallbackTagKeyword_ioOwner"
52extern ZFLIB_ZFCore zfindex ZFIOCallbackCalcSeek(
53 ZF_IN zfindex offset
54 , ZF_IN zfindex length
55 , ZF_IN zfindex curPos
56 , ZF_IN zfindex seekByteSize
57 , ZF_IN ZFSeekPos seekPos
58 );
59
60// ============================================================
64ZFCALLBACK_DECLARE_BEGIN(ZFLIB_ZFCore, ZFIOCallback, ZFCallback)
65public:
69 void ioFlush(void) const;
75 zfbool ioSeek(
76 ZF_IN zfindex byteSize
77 , ZF_IN_OPT ZFSeekPos seekPos = ZFSeekPosBegin
78 ) const;
82 zfindex ioTell(void) const;
86 zfindex ioSize(void) const;
87
91 zfbool ioClose(void) const;
92
99
102 zfany ioOwner(void) const {
103 return this->callbackTag(ZFCallbackTagKeyword_ioOwner);
104 }
105_ZFP_ZFCALLBACK_DECLARE_END(ZFLIB_ZFCore, ZFIOCallback, ZFCallback)
106
107ZF_NAMESPACE_GLOBAL_END
108#endif // #ifndef _ZFI_ZFIOCallback_fwd_h_
109
ZFCallback.h
header for ZFCallback
ZFCALLBACK_DECLARE_BEGIN
#define ZFCALLBACK_DECLARE_BEGIN(ZFLIB_, CallbackTypeName, ParentType)
util macro to declare a child type of ZFCallback
Definition ZFCallback.h:488
ZFLIB_ZFCore
#define ZFLIB_ZFCore
used to export symbols
Definition ZFCoreEnvDef.h:30
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:184
ZF_IN_OPT
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:188
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
ZFIOCallbackCalcSeek
zfindex ZFIOCallbackCalcSeek(zfindex offset, zfindex length, zfindex curPos, zfindex seekByteSize, ZFSeekPos seekPos)
util method for ZFIOCallback::ioSeek's implementations to calculate seek index
ZFCallbackTagKeyword_ioOwner
#define ZFCallbackTagKeyword_ioOwner
for advance user only
Definition ZFIOCallback_fwd.h:41
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
ZFCallback
callback used by ZFFramework
Definition ZFCallback.h:98
ZFCallback::callbackTag
void callbackTag(const zfstring &key, ZFObject *tag)
retain and store a autoreleased object attached to this callback, or set null to remove
ZFIOCallback
abstract base class, use ZFOutput or ZFInput
Definition ZFIOCallback_fwd.h:64
ZFIOCallback::ioClose
zfbool ioClose(void) const
close the io callback
ZFIOCallback::ioSize
zfindex ioSize(void) const
calculate the callback's size or return zfindexMax() if not supported
ZFIOCallback::ioOwner
zfany ioOwner(void) const
util to get ZFCallbackTagKeyword_ioOwner
Definition ZFIOCallback_fwd.h:102
ZFIOCallback::ioSeek
zfbool ioSeek(zfindex byteSize, ZFSeekPos seekPos=ZFSeekPosBegin) const
similar to FILE's ZFFileSeek
ZFIOCallback::ioTell
zfindex ioTell(void) const
similar to FILE's ZFFileTell, return current's index or zfindexMax() if the callback doesn't support ...
ZFIOCallback::ioFlush
void ioFlush(void) const
similar to FILE's ZFFileFlush
ZFIOCallback::ioOwner
void ioOwner(ZFObject *ioOwner)
util to set ZFCallbackTagKeyword_ioOwner
Definition ZFIOCallback_fwd.h:96
ZFObject
base class of all objects
Definition ZFObjectCore.h:196
zfany
util method to cast ZFObject types freely
Definition zfany.h:35