Mercurial > fife-parpg

comparison engine/core/vfs/vfsdirectory.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program 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 *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_VFS_VFSHOSTSYSTEM_H
23 #define FIFE_VFS_VFSHOSTSYSTEM_H
24
25 // Standard C++ library includes
26
27 // 3rd party library includes
28
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33 #include "vfssource.h"
34
35 namespace FIFE {
36
37 /** The most basic VFSSource for "normal" filesystems.
38 * For example, '/' or './tests/data'.
39 *
40 * Uses boost_filesystem to achieve Plattform independancy.
41 * This also means you have to use slashes as directory
42 * separators.
43 */
44 class VFSDirectory : public VFSSource {
45 public:
46 /** Constructor
47 * Creates the given file system's VFS Source, Uses boost_filesystem to
48 * achieve Plattform independancy.
49 */
50 VFSDirectory(VFS* vfs, const std::string& root = "./");
51 /** Destructor
52 */
53 virtual ~VFSDirectory();
54
55 /** Tests whether a file can be opened.
56 * @param filename The file to test.
57 * @return True, if the file filename can be opened.
58 */
59 virtual bool fileExists(const std::string& filename) const;
60 /** Opens a file.
61 * @param filename The file to open.
62 */
63 virtual RawData* open(const std::string& filename) const;
64
65 /** List files in a directory
66 * @param path The directory to list the files in
67 * @return A string list of filenames
68 * Will return an empty list on \b any error
69 */
70 std::set<std::string> listFiles(const std::string& path) const;
71
72 /** List directories in a directory
73 * @param path The directory to list the directories in
74 * @return A string list of directories
75 * Will return an empty list on \b any error
76 */
77 std::set<std::string> listDirectories(const std::string& path) const;
78
79 private:
80 std::string m_root;
81
82 std::set<std::string> list(const std::string& path, bool directorys) const;
83
84 };
85
86 }
87
88 #endif