ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

abstract-fs.h

Go to the documentation of this file.
00001 /* ScummVM - Graphic Adventure Engine
00002  *
00003  * ScummVM is the legal property of its developers, whose names
00004  * are too numerous to list here. Please refer to the COPYRIGHT
00005  * file distributed with this source distribution.
00006  *
00007  * This program is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU General Public License
00009  * as published by the Free Software Foundation; either version 2
00010  * of the License, or (at your option) any later version.
00011  *
00012  * This program is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020  *
00021  */
00022 
00023 #ifndef BACKENDS_ABSTRACT_FS_H
00024 #define BACKENDS_ABSTRACT_FS_H
00025 
00026 #include "common/array.h"
00027 #include "common/str.h"
00028 #include "common/fs.h"
00029 
00030 class AbstractFSNode;
00031 
00032 typedef Common::Array<AbstractFSNode *> AbstractFSList;
00033 
00042 class AbstractFSNode {
00043 protected:
00044     friend class Common::FSNode;
00045     typedef Common::FSNode::ListMode ListMode;
00046 
00064     virtual AbstractFSNode *getChild(const Common::String &name) const = 0;
00065 
00070     virtual AbstractFSNode *getParent() const = 0;
00071 
00083     static const char *lastPathComponent(const Common::String &str, const char sep);
00084 
00085 public:
00096     static Common::FSNode makeFSNode(AbstractFSNode *realNode) {
00097         return Common::FSNode(realNode);
00098     }
00099 
00103     virtual ~AbstractFSNode() {}
00104 
00105     /*
00106      * Indicates whether the object referred by this path exists in the filesystem or not.
00107      */
00108     virtual bool exists() const = 0;
00109 
00120     virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const = 0;
00121 
00127     virtual Common::String getDisplayName() const { return getName(); }
00128 
00138     virtual Common::String getName() const = 0;
00139 
00143     virtual Common::String getPath() const = 0;
00144 
00148     virtual bool isDirectory() const = 0;
00149 
00161     virtual bool isReadable() const = 0;
00162 
00174     virtual bool isWritable() const = 0;
00175 
00176 
00184     virtual Common::SeekableReadStream *createReadStream() = 0;
00185 
00193     virtual Common::WriteStream *createWriteStream() = 0;
00194 
00202     virtual bool create(bool isDirectoryFlag) = 0;
00203 };
00204 
00205 
00206 
00207 #endif //BACKENDS_ABSTRACT_FS_H


Generated on Sat Mar 23 2019 05:01:14 for ResidualVM by doxygen 1.7.1
curved edge   curved edge