FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
vfssource.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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;
46  class VFSSource {
47  public:
48  VFSSource(VFS* vfs);
49  virtual ~VFSSource();
50 
56  virtual bool fileExists(const std::string& file) const = 0;
57 
60  VFS* getVFS() const { return m_vfs; }
61 
68  virtual RawData* open(const std::string& file) const = 0;
69 
75  virtual std::set<std::string> listFiles(const std::string& path) const = 0;
76 
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:
89  };
90 
91 }
92 
93 #endif
virtual std::set< std::string > listDirectories(const std::string &path) const =0
list all directories in a directory of this source
virtual bool fileExists(const std::string &file) const =0
check if the given file exists
VFSSource abstract baseclass.
Definition: vfssource.h:46
VFS * getVFS() const
get the VFS this source is associated with.
Definition: vfssource.h:60
virtual ~VFSSource()
Definition: vfssource.cpp:39
the main VFS (virtual file system) class
Definition: vfs.h:58
VFSSource(VFS *vfs)
Definition: vfssource.cpp:36
std::string fixPath(std::string path) const
Definition: vfssource.cpp:45
virtual std::set< std::string > listFiles(const std::string &path) const =0
list all files in a directory of this source
virtual RawData * open(const std::string &file) const =0
open a file inside this source
Used to access diffrent kinds of data.
Definition: rawdata.h:48