| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_VFS_VFSSOURCE_H |
| 23 |
#define FIFE_VFS_VFSSOURCE_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
#include <string> |
| 27 |
|
| 28 |
// 3rd party library includes |
| 29 |
|
| 30 |
// FIFE includes |
| 31 |
// These includes are split up in two parts, separated by one empty line |
| 32 |
// First block: files included from the FIFE root src directory |
| 33 |
// Second block: files included from the same folder |
| 34 |
#include "vfs.h" |
| 35 |
|
| 36 |
namespace FIFE { |
| 37 |
|
| 38 |
class RawData; |
| 39 |
/** VFSSource abstract baseclass |
| 40 |
* |
| 41 |
* VFSSources are used to provide transparent access to diffrent archives/filesystems etc. |
| 42 |
* Examples are VFSHostSystem |
| 43 |
* @see VFS |
| 44 |
* @see VFSSourceProvider |
| 45 |
*/ |
| 46 |
class VFSSource { |
| 47 |
public: |
| 48 |
VFSSource(VFS* vfs); |
| 49 |
virtual ~VFSSource(); |
| 50 |
|
| 51 |
/** check if the given file exists |
| 52 |
* |
| 53 |
* @param file filename to check |
| 54 |
* @return true if it exists, false otherwise |
| 55 |
*/ |
| 56 |
virtual bool fileExists(const std::string& file) const = 0; |
| 57 |
|
| 58 |
/** get the VFS this source is associated with. |
| 59 |
*/ |
| 60 |
VFS* getVFS() const { return m_vfs; } |
| 61 |
|
| 62 |
/** open a file inside this source |
| 63 |
* |
| 64 |
* @param file the file to open |
| 65 |
* @return a new RawData* |
| 66 |
* @throws CannotOpenFile if the file can't be found |
| 67 |
*/ |
| 68 |
virtual RawData* open(const std::string& file) const = 0; |
| 69 |
|
| 70 |
/** list all files in a directory of this source |
| 71 |
* |
| 72 |
* @param path path to list files in |
| 73 |
* Will return an empty list on \b any error |
| 74 |
*/ |
| 75 |
virtual std::set<std::string> listFiles(const std::string& path) const = 0; |
| 76 |
|
| 77 |
/** list all directories in a directory of this source |
| 78 |
* |
| 79 |
* @param path path to list directories in |
| 80 |
* Will return an empty list on \b any error |
| 81 |
*/ |
| 82 |
virtual std::set<std::string> listDirectories(const std::string& path) const = 0; |
| 83 |
|
| 84 |
protected: |
| 85 |
std::string fixPath(std::string path) const; |
| 86 |
|
| 87 |
private: |
| 88 |
VFS* m_vfs; |
| 89 |
}; |
| 90 |
|
| 91 |
} |
| 92 |
|
| 93 |
#endif |