FIFE 2008.0
vfs.h
00001 /***************************************************************************
00002  *   Copyright (C) 2005-2008 by the FIFE team                              *
00003  *   http://www.fifengine.de                                               *
00004  *   This file is part of FIFE.                                            *
00005  *                                                                         *
00006  *   FIFE is free software; you can redistribute it and/or                 *
00007  *   modify it under the terms of the GNU Lesser General Public            *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2.1 of the License, or (at your option) any later version.    *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful,       *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the                 *
00018  *   Free Software Foundation, Inc.,                                       *
00019  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
00020  ***************************************************************************/
00021 
00022 #ifndef FIFE_VFS_VFS_H
00023 #define FIFE_VFS_VFS_H
00024 
00025 // Standard C++ library includes
00026 #include <set>
00027 #include <string>
00028 #include <vector>
00029 
00030 // 3rd party library includes
00031 #include <boost/shared_ptr.hpp>
00032 
00033 // FIFE includes
00034 // These includes are split up in two parts, separated by one empty line
00035 // First block: files included from the FIFE root src directory
00036 // Second block: files included from the same folder
00037 
00038 namespace FIFE {
00039 
00040     class RawData;
00041 
00042     class VFSSourceProvider;
00043     class VFSSource;
00044 
00056     class VFS {
00057         public:
00061             VFS();
00062 
00065             virtual ~VFS();
00066 
00067             void cleanup();
00068 
00075             void addProvider(VFSSourceProvider* provider);
00076 
00083             VFSSource* createSource(const std::string& path) const;
00084 
00088             void addNewSource(const std::string& path);
00089 
00090 
00092             void addSource(VFSSource* source);
00093 
00095             void removeSource(VFSSource* source);
00096 
00102             bool exists(const std::string& file) const;
00103 
00109             bool isDirectory(const std::string& path) const;
00110 
00117             RawData* open(const std::string& path);
00118 
00124             std::set<std::string> listFiles(const std::string& path) const;
00125 
00135             std::set<std::string> listFiles(const std::string& path, const std::string& filterregex) const;
00136 
00142             std::set<std::string> listDirectories(const std::string& path) const;
00143 
00150             std::set<std::string> listDirectories(const std::string& path, const std::string& filterregex) const;
00151 
00152         private:
00153             typedef std::vector<VFSSourceProvider*> type_providers;
00154             type_providers m_providers;
00155 
00156             typedef std::vector<VFSSource*> type_sources;
00157             type_sources m_sources;
00158 
00159             typedef std::set<std::string> type_usedfiles;
00160             mutable type_usedfiles m_usedfiles;
00161 
00162             std::set<std::string> filterList(const std::set<std::string>& list, const std::string& fregex) const;
00163             VFSSource* getSourceForFile(const std::string& file) const;
00164     };
00165 
00166 }
00167 
00168 #endif
 All Classes Namespaces Functions Variables Enumerations Enumerator