FIFE 2008.0
vfssourceprovider.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_VFSSOURCEPROVIDER_H
00023 #define FIFE_VFS_VFSSOURCEPROVIDER_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 "util/base/exception.h"
00035 
00036 namespace FIFE {
00037 
00038     class VFSSource;
00039 
00049     class VFSSourceProvider{
00050         public:
00051             VFSSourceProvider(const std::string& name);
00052             virtual ~VFSSourceProvider();
00053 
00058             const std::string& getName() const;
00059 
00063             void setVFS(VFS* vfs);
00064 
00065             VFS* getVFS() const {
00066                 if(!m_vfs) throw NotSet("Attempt to load from VFSSourceProvider without setting a VFS!");
00067                 return m_vfs;
00068             }
00069 
00076             virtual bool isReadable(const std::string& file) const = 0;
00077 
00083             virtual VFSSource* createSource(const std::string& file) const = 0;
00084 
00085         private:
00086 
00087             VFS* m_vfs;
00088             std::string m_name;
00089     };
00090 }
00091 
00092 #endif
 All Classes Namespaces Functions Variables Enumerations Enumerator