doc/_z_f_i_o_callback__fwd_8h_source.html

#ifndef _ZFI_ZFIOCallback_fwd_h_

#define _ZFI_ZFIOCallback_fwd_h_


#include "ZFCallback.h"

ZF_NAMESPACE_GLOBAL_BEGIN


// ============================================================

#define ZFCallbackTagKeyword_ioOwner "ZFCallbackTagKeyword_ioOwner"

extern ZFLIB_ZFCore zfindex ZFIOCallbackCalcFSeek(

        ZF_IN zfindex offset

        , ZF_IN zfindex length

        , ZF_IN zfindex curPos

        , ZF_IN zfindex seekByteSize

        , ZF_IN ZFSeekPos seekPos

        );


// ============================================================


ZFCALLBACK_DECLARE_BEGIN(ZFLIB_ZFCore, ZFIOCallback, ZFCallback)

public:

    zfbool ioSeek(

            ZF_IN zfindex byteSize

            , ZF_IN_OPT ZFSeekPos pos = ZFSeekPosBegin

            ) const;

    zfindex ioTell(void) const;

    zfindex ioSize(void) const;


    void ioOwner(ZF_IN ZFObject *ioOwner) {

        this->callbackTag(ZFCallbackTagKeyword_ioOwner, ioOwner);

    }


    zfany ioOwner(void) const {

        return this->callbackTag(ZFCallbackTagKeyword_ioOwner);

    }


_ZFP_ZFCALLBACK_DECLARE_END_NO_ALIAS(ZFLIB_ZFCore, ZFIOCallback, ZFCallback)


ZF_NAMESPACE_GLOBAL_END

#endif // #ifndef _ZFI_ZFIOCallback_fwd_h_


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:458

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:180

ZF_IN_OPT
#define ZF_IN_OPT
dummy macro that shows the param used as optional input
Definition ZFCoreTypeDef_ClassType.h:184

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

ZFIOCallbackCalcFSeek
zfindex ZFIOCallbackCalcFSeek(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:39

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:96

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:62

ZFIOCallback::ioSeek
zfbool ioSeek(zfindex byteSize, ZFSeekPos pos=ZFSeekPosBegin) const
similar to FILE's ZFFileSeek

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:91

ZFIOCallback::ioTell
zfindex ioTell(void) const
similar to FILE's ZFFileTell, return current's index or zfindexMax() if the callback doesn't support ...

ZFIOCallback::ioOwner
void ioOwner(ZFObject *ioOwner)
util to set ZFCallbackTagKeyword_ioOwner
Definition ZFIOCallback_fwd.h:85

ZFObject
base class of all objects
Definition ZFObjectCore.h:209

zfany
util method to cast ZFObject types freely
Definition zfany.h:35