file.h

Go to the documentation of this file.

/* 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#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 {

class Archive;

class File : public SeekableReadStream, public NonCopyable {
protected:
    SeekableReadStream *_handle;

    String _name;

public:
    File();
    virtual ~File();

    static bool exists(const String &filename);

    virtual bool open(const String &filename);

    virtual bool open(const String &filename, Archive &archive);

    virtual bool open(const FSNode &node);

    virtual bool open(SeekableReadStream *stream, const String &name);

    virtual void close();

    bool isOpen() const;

    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

    int32 pos() const override; // implement abstract SeekableReadStream method
    int32 size() const override;    // implement abstract SeekableReadStream method
    bool seek(int32 offs, int whence = SEEK_SET) override;  // implement abstract SeekableReadStream method
    uint32 read(void *dataPtr, uint32 dataSize) override;   // implement abstract SeekableReadStream method
};


class DumpFile : public SeekableWriteStream, public NonCopyable {
protected:
    WriteStream *_handle;

public:
    DumpFile();
    virtual ~DumpFile();

    virtual bool open(const String &filename, bool createPath = false);
    virtual bool open(const FSNode &node);

    virtual void close();

    bool isOpen() const;

    bool err() const override;
    void clearErr() override;

    virtual uint32 write(const void *dataPtr, uint32 dataSize) override;

    virtual bool flush() override;

    virtual int32 pos() const override;

    virtual bool seek(int32 offset, int whence = SEEK_SET) override;
    virtual int32 size() const override;
};

} // End of namespace Common

#endif