abstract-fs.h

/* 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 BACKENDS_ABSTRACT_FS_H
#define BACKENDS_ABSTRACT_FS_H

#include "common/array.h"
#include "common/str.h"
#include "common/fs.h"

class AbstractFSNode;

typedef Common::Array<AbstractFSNode *> AbstractFSList;

class AbstractFSNode {
protected:
    friend class Common::FSNode;
    typedef Common::FSNode::ListMode ListMode;

    virtual AbstractFSNode *getChild(const Common::String &name) const = 0;

    virtual AbstractFSNode *getParent() const = 0;

    static const char *lastPathComponent(const Common::String &str, const char sep);

public:
    static Common::FSNode makeFSNode(AbstractFSNode *realNode) {
        return Common::FSNode(realNode);
    }

    virtual ~AbstractFSNode() {}

    /*
     * Indicates whether the object referred by this path exists in the filesystem or not.
     */
    virtual bool exists() const = 0;

    virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const = 0;

    virtual Common::U32String getDisplayName() const = 0;

    virtual Common::String getName() const = 0;

    virtual Common::String getPath() const = 0;

    virtual bool isDirectory() const = 0;

    virtual bool isReadable() const = 0;

    virtual bool isWritable() const = 0;


    virtual Common::SeekableReadStream *createReadStream() = 0;

    virtual Common::SeekableReadStream *createReadStreamForAltStream(Common::AltStreamType altStreamType);

    virtual Common::SeekableWriteStream *createWriteStream(bool atomic) = 0;

    virtual bool createDirectory() = 0;
};



#endif //BACKENDS_ABSTRACT_FS_H