Debian Codegraph @

engine/core/vfs/directoryprovider.h

raw
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_DIRECTORYPROVIDER_H
23 #define FIFE_VFS_DIRECTORYPROVIDER_H
24
25 // Standard C++ library includes
26 #include <string>
27 #include <map>
28
29 // 3rd party library includes
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35 #include "vfssourceprovider.h"
36
37 namespace FIFE {
38
39 class VFSSource;
40
41 /** Provider for OS directories.
42 */
43 class DirectoryProvider : public VFSSourceProvider {
44 public:
45 DirectoryProvider() : VFSSourceProvider("OS Directory") { }
46
47 /** Check if a given directory is readable.
48 * The path must either be an absolute path or relative
49 * to the current working directory where the client was launched
50 *
51 * @param path the filename to check
52 * @return true if readable, false otherwise
53 */
54 virtual bool isReadable(const std::string& path) const;
55
56 /** Create a new instance of a VFSSource initialized with the given directory
57 * This will only pass if the path is readable and recognized
58 * as a directory as per the description of isReadable
59 *
60 * @param path the directory to open
61 * @return the new VFSSource
62 */
63 virtual VFSSource* createSource(const std::string& path);
64
65 /** Get the source instance of the path
66 *
67 * @param path The source path
68 * @return A VFSSource or NULL of none is present
69 */
70 virtual VFSSource* getSource(const std::string& path) const;
71
72 /** Check whether the provider already has created a source with that path
73 *
74 * @param path The path to the source
75 * @return true if the provider has already created a source with that path, false if not
76 */
77 virtual bool hasSource(const std::string & path) const;
78 private:
79 std::string m_name;
80 std::map<std::string, VFSSource* > m_sources;
81
82 };
83 }
84
85 #endif