vfssourceprovider.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VFS_VFSSOURCEPROVIDER_H
#define FIFE_VFS_VFSSOURCEPROVIDER_H

// Standard C++ library includes
#include <string>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/exception.h"

namespace FIFE {

    class VFSSource;

    class VFSSourceProvider{
        public:
            VFSSourceProvider(const std::string& name);
            virtual ~VFSSourceProvider();

            const std::string& getName() const;

            void setVFS(VFS* vfs);

            VFS* getVFS() const {
                if(!m_vfs) throw NotSet("Attempt to load from VFSSourceProvider without setting a VFS!");
                return m_vfs;
            }

            virtual bool isReadable(const std::string& file) const = 0;

            virtual VFSSource* createSource(const std::string& file) = 0;

            virtual VFSSource* getSource(const std::string& path) const = 0;

            virtual bool hasSource(const std::string & path) const = 0;

        private:

            VFS* m_vfs;
            std::string m_name;
    };
}

#endif