mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-05 00:36:57 +00:00
184 lines
5.4 KiB
C++
184 lines
5.4 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_FILE_H
|
|
#define COMMON_FILE_H
|
|
|
|
#include "common/scummsys.h"
|
|
#include "common/fs.h"
|
|
#include "common/noncopyable.h"
|
|
#include "common/str.h"
|
|
#include "common/stream.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_files Files
|
|
* @ingroup common
|
|
*
|
|
* @brief API for operations on files.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
class Archive;
|
|
|
|
/**
|
|
* @todo vital to document this core class properly!!! For both users and implementors
|
|
*/
|
|
class File : public SeekableReadStream, public NonCopyable {
|
|
protected:
|
|
/** File handle to the actual file; 0 if no file is open. */
|
|
SeekableReadStream *_handle;
|
|
|
|
/** The name of this file, kept for debugging purposes. */
|
|
String _name;
|
|
|
|
public:
|
|
File();
|
|
virtual ~File();
|
|
|
|
/**
|
|
* Check if a given file exists in any of the current default paths,
|
|
* as defined by SearchMan.
|
|
*
|
|
* @param filename The file to check for.
|
|
* @return True if the file exists, false otherwise.
|
|
*/
|
|
static bool exists(const Path &filename);
|
|
|
|
/**
|
|
* Try to open the file with the given file name, by searching SearchMan.
|
|
* @note Must not be called if this file is already open (i.e. if isOpen returns true).
|
|
*
|
|
* @param filename Name of the file to open.
|
|
* @return True if the file was opened successfully, false otherwise.
|
|
*/
|
|
virtual bool open(const Path &filename);
|
|
|
|
/**
|
|
* Try to open the file with the given file name from within the given archive.
|
|
* @note Must not be called if this file is already open (i.e. if isOpen returns true).
|
|
*
|
|
* @param filename Name of the file to open.
|
|
* @param archive Archive in which to search for the file.
|
|
* @return True if the file was opened successfully, false otherwise.
|
|
*/
|
|
virtual bool open(const Path &filename, Archive &archive);
|
|
|
|
/**
|
|
* Try to open the file corresponding to the given node. Will check whether the
|
|
* node actually refers to an existing file (and not a directory), and handle
|
|
* those cases gracefully.
|
|
* @note Must not be called if this file already is open (i.e. if isOpen returns true).
|
|
*
|
|
* @param node The node to consider.
|
|
* @return True if the file was opened successfully, false otherwise.
|
|
*/
|
|
virtual bool open(const FSNode &node);
|
|
|
|
/**
|
|
* Try to 'open' the given stream. That is, wrap around it, and if the stream
|
|
* is a NULL pointer, gracefully treat this as if opening failed.
|
|
* @note Must not be called if this file already is open (i.e. if isOpen returns true).
|
|
*
|
|
* @param stream Pointer to a SeekableReadStream, or 0.
|
|
* @param name String describing the 'file' corresponding to the stream.
|
|
* @return True if the stream was non-zero, false otherwise.
|
|
*/
|
|
virtual bool open(SeekableReadStream *stream, const String &name);
|
|
|
|
/**
|
|
* Close the file, if open.
|
|
*/
|
|
virtual void close();
|
|
|
|
/**
|
|
* Check if the object opened a file successfully.
|
|
*
|
|
* @return True if any file is opened, false otherwise.
|
|
*/
|
|
bool isOpen() const;
|
|
|
|
/**
|
|
* Return the file name of the opened file for debugging purposes.
|
|
*
|
|
* @return The file name of the opened file.
|
|
*/
|
|
const char *getName() const { return _name.c_str(); }
|
|
|
|
bool err() const override; /*!< Implement abstract Stream method. */
|
|
void clearErr() override; /*!< Implement abstract Stream method. */
|
|
bool eos() const override; /*!< Implement abstract SeekableReadStream method. */
|
|
|
|
int64 pos() const override; /*!< Implement abstract SeekableReadStream method. */
|
|
int64 size() const override; /*!< Implement abstract SeekableReadStream method. */
|
|
bool seek(int64 offs, int whence = SEEK_SET) override; /*!< Implement abstract SeekableReadStream method. */
|
|
uint32 read(void *dataPtr, uint32 dataSize) override; /*!< Implement abstract SeekableReadStream method. */
|
|
};
|
|
|
|
|
|
/**
|
|
* @todo Document this class
|
|
*
|
|
* Some design ideas:
|
|
* - automatically drop all files into dumps/ dir? Might not be desired in all cases
|
|
*/
|
|
class DumpFile : public SeekableWriteStream, public NonCopyable {
|
|
protected:
|
|
/** File handle to the actual file. 0 if no file is open. */
|
|
WriteStream *_handle;
|
|
|
|
public:
|
|
DumpFile();
|
|
virtual ~DumpFile();
|
|
|
|
virtual bool open(const String &filename, bool createPath = false);
|
|
virtual bool open(const FSNode &node);
|
|
|
|
virtual void close();
|
|
|
|
/**
|
|
* Check if the object opened a file successfully.
|
|
*
|
|
* @return True if any file is opened, false otherwise.
|
|
*/
|
|
bool isOpen() const;
|
|
|
|
bool err() const override;
|
|
void clearErr() override;
|
|
|
|
uint32 write(const void *dataPtr, uint32 dataSize) override;
|
|
|
|
bool flush() override;
|
|
|
|
int64 pos() const override;
|
|
|
|
bool seek(int64 offset, int whence = SEEK_SET) override;
|
|
int64 size() const override;
|
|
};
|
|
|
|
/** @} */
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|