axmol/cocos/platform/CCFileStream.h

87 lines
2.0 KiB
C
Raw Normal View History

2020-08-27 00:21:44 +08:00
// Copyright (c) 2018-2019 HALX99
// Copyright (c) 2020 c4games.com
#pragma once
#include <string>
#include "platform/CCPlatformConfig.h"
#include "platform/CCPlatformMacros.h"
NS_CC_BEGIN
2021-12-25 10:04:45 +08:00
class CC_DLL FileStream
{
public:
virtual ~FileStream() = default;
2021-12-25 10:04:45 +08:00
enum class Mode
{
2020-08-27 10:19:21 +08:00
READ,
WRITE,
APPEND,
2021-07-04 16:40:34 +08:00
OVERLAPPED,
};
/**
2021-12-25 10:04:45 +08:00
* Open a file
* @param path file to open
* @param mode File open mode, being READ | WRITE | APPEND
* @return true if successful, false if not
*/
virtual bool open(const std::string& path, FileStream::Mode mode) = 0;
/**
2021-12-25 10:04:45 +08:00
* Close a file stream
* @return 0 if successful, -1 if not
*/
virtual int close() = 0;
/**
2021-12-25 10:04:45 +08:00
* Seek to position in a file stream
* @param offset how many bytes to move within the stream
* @param origin SEEK_SET | SEEK_CUR | SEEK_END
* @return 0 if successful, -1 if not
*/
virtual int seek(int64_t offset, int origin) = 0;
/**
2021-12-25 10:04:45 +08:00
* Read data from file stream
* @param buf pointer to data
* @param size the amount of data to read in bytes
* @return amount of data read successfully, -1 if error
*/
virtual int read(void* buf, unsigned int size) = 0;
/**
2021-12-25 10:04:45 +08:00
* Write data to file stream
* @param buf pointer to data
* @param size the amount of data to write in bytes
* @return amount of data written successfully, -1 if error
*/
virtual int write(const void* buf, unsigned int size) = 0;
/**
2021-12-25 10:04:45 +08:00
* Get the current position in the file stream
* @return current position, -1 if error
*/
virtual int64_t tell() = 0;
/**
2021-12-25 10:04:45 +08:00
* Get the size of the file stream
* @return stream size, -1 if error (Mode::WRITE and Mode::APPEND may return -1)
*/
virtual int64_t size() = 0;
/**
2021-12-25 10:04:45 +08:00
* Get status of file stream
* @return true if open, false if closed
*/
virtual bool isOpen() const = 0;
virtual operator bool() const { return isOpen(); }
protected:
2021-12-25 10:04:45 +08:00
FileStream(){};
};
NS_CC_END