vfssource.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_VFSSOURCE_H
00023 #define FIFE_VFS_VFSSOURCE_H
00024 
00025 // Standard C++ library includes
00026 #include <string>
00027 
00028 // 3rd party library includes
00029 
00030 // FIFE includes
00031 // These includes are split up in two parts, separated by one empty line
00032 // First block: files included from the FIFE root src directory
00033 // Second block: files included from the same folder
00034 #include "vfs.h"
00035 
00036 namespace FIFE {
00037 
00038     class RawData;
00046     class VFSSource {
00047         public:
00048             VFSSource(VFS* vfs);
00049             virtual ~VFSSource();
00050 
00056             virtual bool fileExists(const std::string& file) const = 0;
00057 
00060             VFS* getVFS() const { return m_vfs; }
00061 
00068             virtual RawData* open(const std::string& file) const = 0;
00069 
00075             virtual std::set<std::string> listFiles(const std::string& path) const = 0;
00076 
00082             virtual std::set<std::string> listDirectories(const std::string& path) const = 0;
00083 
00084         protected:
00085             std::string fixPath(std::string path) const;
00086 
00087         private:
00088             VFS* m_vfs;
00089     };
00090 
00091 }
00092 
00093 #endif
Generated on Wed Nov 23 13:04:43 2011 for FIFE by  doxygen 1.6.3