Mercurial > fife-parpg

comparison engine/core/vfs/directoryprovider.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_DIRECTORYPROVIDER_H
23 #define FIFE_VFS_DIRECTORYPROVIDER_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 "vfssourceprovider.h"
35
36 namespace FIFE {
37
38 class VFSSource;
39
40 /** Provider for OS directories.
41 */
42 class DirectoryProvider : public VFSSourceProvider {
43 public:
44 DirectoryProvider() : VFSSourceProvider("OS Directory") { }
45
46 /** Check if a given directory is readable for this VFSSource.
47 * Directory sources must be denoted by a trailing '/', otherwise VFS will consider
48 * the source to be a file, and unreadable asa a directory.
49 *
50 * @param file the filename to check
51 * @return true if readable, false otherwise
52 */
53 virtual bool isReadable(const std::string& path) const;
54
55 /** Create a new instance of a VFSSource initialized with the given directory
56 *
57 * @param file the directory to open
58 * @return the new VFSSource
59 */
60 virtual VFSSource* createSource(const std::string& path) const;
61
62 private:
63 std::string m_name;
64
65 };
66 }
67
68 #endif