doc/_z_f_protocol_z_f_file_8h_source.html

#ifndef _ZFI_ZFProtocolZFFile_h_

#define _ZFI_ZFProtocolZFFile_h_


#include "ZFCore/ZFProtocol.h"

#include "ZFCore/ZFFile.h"

ZF_NAMESPACE_GLOBAL_BEGIN


ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFCore, ZFFile)

public:

    virtual zfbool fileIsExist(ZF_IN const zfchar *path) zfpurevirtual;

    virtual zfbool isDir(ZF_IN const zfchar *path) zfpurevirtual;


    virtual zfbool filePathCreate(

            ZF_IN const zfchar *path

            , ZF_IN_OPT zfbool autoMakeParent = zffalse

            ) zfpurevirtual;

    virtual zfbool fileCopy(

            ZF_IN const zfchar *srcPath

            , ZF_IN const zfchar *dstPath

            , ZF_IN_OPT zfbool isRecursive = zftrue

            , ZF_IN_OPT zfbool isForce = zftrue

            ) zfpurevirtual;

    virtual zfbool fileMove(

            ZF_IN const zfchar *srcPath

            , ZF_IN const zfchar *dstPath

            , ZF_IN_OPT zfbool isForce = zftrue

            ) zfpurevirtual;

    virtual zfbool fileRemove(

            ZF_IN const zfchar *path

            , ZF_IN_OPT zfbool isRecursive = zftrue

            , ZF_IN_OPT zfbool isForce = zftrue

            ) zfpurevirtual;


    virtual zfbool fileFindFirst(

            ZF_IN_OUT ZFFileFindData::Impl &fd

            , ZF_IN const zfchar *path

            ) zfpurevirtual;

    virtual zfbool fileFindNext(ZF_IN_OUT ZFFileFindData::Impl &fd) zfpurevirtual;

    virtual void fileFindClose(ZF_IN_OUT ZFFileFindData::Impl &fd) zfpurevirtual;


    virtual void *fileOpen(

            ZF_IN const zfchar *filePath

            , ZF_IN_OPT ZFFileOpenOptionFlags flag = v_ZFFileOpenOption::e_Read

            ) zfpurevirtual;

    virtual zfbool fileClose(ZF_IN void *token) zfpurevirtual;


    virtual zfindex fileTell(ZF_IN void *token) zfpurevirtual;

    virtual zfbool fileSeek(

            ZF_IN void *token

            , ZF_IN zfindex byteSize

            , ZF_IN_OPT ZFSeekPos position = ZFSeekPosBegin

            ) zfpurevirtual;


    virtual zfindex fileRead(

            ZF_IN void *token

            , ZF_IN void *buf

            , ZF_IN zfindex maxByteSize

            ) zfpurevirtual;


    virtual zfindex fileWrite(

            ZF_IN void *token

            , ZF_IN const void *src

            , ZF_IN zfindex maxByteSize

            ) zfpurevirtual;

    virtual void fileFlush(ZF_IN void *token) zfpurevirtual;

    virtual zfbool fileIsEof(ZF_IN void *token) zfpurevirtual;

    virtual zfbool fileIsError(ZF_IN void *token) zfpurevirtual;

ZFPROTOCOL_INTERFACE_END(ZFFile)


ZF_NAMESPACE_GLOBAL_END

#endif // #ifndef _ZFI_ZFProtocolZFFile_h_


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

zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68

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

zftrue
#define zftrue
bool true type
Definition ZFCoreTypeDef_CoreType.h:107

zffalse
#define zffalse
bool false type
Definition ZFCoreTypeDef_CoreType.h:111

ZFSeekPos
ZFSeekPos
seek position similar to SEEK_SET of FILE operation
Definition ZFCoreTypeDef_OtherType.h:47

ZFFile.h
file utility

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.h
protocol definitions for ZFFramework

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

ZFFileFindData::Impl
for impl to achieve custom find logic
Definition ZFFile_fwd.h:92

ZFFileOpenOptionFlags
see v_ZFFileOpenOption, ZFFileOpenOptionFlagsToString, ZFFileOpenOptionFlagsFromString
Definition ZFFile_fwd.h:44

ZFPInterface_ZFFile::fileRead
virtual zfindex fileRead(void *token, void *buf, zfindex maxByteSize)=0
see ZFFileRead

ZFPInterface_ZFFile::isDir
virtual zfbool isDir(const zfchar *path)=0
see ZFFileIsDir

ZFPInterface_ZFFile::fileFindClose
virtual void fileFindClose(ZFFileFindData::Impl &fd)=0
see ZFFileFindClose, fileFindFirst

ZFPInterface_ZFFile::fileWrite
virtual zfindex fileWrite(void *token, const void *src, zfindex maxByteSize)=0
see ZFFileWrite

ZFPInterface_ZFFile::fileMove
virtual zfbool fileMove(const zfchar *srcPath, const zfchar *dstPath, zfbool isForce=_ZFT_t_zftrue)=0
see ZFFileMove

ZFPInterface_ZFFile::filePathCreate
virtual zfbool filePathCreate(const zfchar *path, zfbool autoMakeParent=_ZFT_t_zffalse)=0
see ZFPathCreate

ZFPInterface_ZFFile::fileFindFirst
virtual zfbool fileFindFirst(ZFFileFindData::Impl &fd, const zfchar *path)=0
see ZFFileFindFirst

ZFPInterface_ZFFile::fileRemove
virtual zfbool fileRemove(const zfchar *path, zfbool isRecursive=_ZFT_t_zftrue, zfbool isForce=_ZFT_t_zftrue)=0
see ZFFileRemove

ZFPInterface_ZFFile::fileIsEof
virtual zfbool fileIsEof(void *token)=0
see ZFFileIsEof

ZFPInterface_ZFFile::fileFlush
virtual void fileFlush(void *token)=0
see ZFFileFlush

ZFPInterface_ZFFile::fileSeek
virtual zfbool fileSeek(void *token, zfindex byteSize, ZFSeekPos position=ZFSeekPosBegin)=0
see ZFFileSeek

ZFPInterface_ZFFile::fileCopy
virtual zfbool fileCopy(const zfchar *srcPath, const zfchar *dstPath, zfbool isRecursive=_ZFT_t_zftrue, zfbool isForce=_ZFT_t_zftrue)=0
see ZFFileCopy

ZFPInterface_ZFFile::fileFindNext
virtual zfbool fileFindNext(ZFFileFindData::Impl &fd)=0
see ZFFileFindNext, fileFindFirst

ZFPInterface_ZFFile::fileIsExist
virtual zfbool fileIsExist(const zfchar *path)=0
see ZFFileIsExist

ZFPInterface_ZFFile::fileTell
virtual zfindex fileTell(void *token)=0
see ZFFileTell

ZFPInterface_ZFFile::fileClose
virtual zfbool fileClose(void *token)=0
see ZFFileClose

ZFPInterface_ZFFile::fileOpen
virtual void * fileOpen(const zfchar *filePath, ZFFileOpenOptionFlags flag=v_ZFFileOpenOption::e_Read)=0
see ZFFileOpen

ZFPInterface_ZFFile::fileIsError
virtual zfbool fileIsError(void *token)=0
see ZFFileIsError

v_ZFFileOpenOption::e_Read
@ e_Read
Read(1 << 1)
Definition ZFFile_fwd.h:36