vfs.h

/***************************************************************************
 *   Copyright (C) 2005-2008 by the FIFE team                              *
 *   http://www.fifengine.de                                               *
 *   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_VFS_H
#define FIFE_VFS_VFS_H

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

// 3rd party library includes
#include <boost/shared_ptr.hpp>

// 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/singleton.h"


namespace FIFE {

    class RawData;

    class VFSSourceProvider;
    class VFSSource;

    class VFS : public DynamicSingleton<VFS>{
        public:
            VFS();

            virtual ~VFS();

            void cleanup();

            void addProvider(VFSSourceProvider* provider);

            VFSSource* createSource(const std::string& path) const;

            void addNewSource(const std::string& path);


            void addSource(VFSSource* source);

            void removeSource(VFSSource* source);

            bool exists(const std::string& file) const;

            bool isDirectory(const std::string& path) const;

            RawData* open(const std::string& path);

            std::set<std::string> listFiles(const std::string& path) const;

            std::set<std::string> listFiles(const std::string& path, const std::string& filterregex) const;

            std::set<std::string> listDirectories(const std::string& path) const;

            std::set<std::string> listDirectories(const std::string& path, const std::string& filterregex) const;

        private:
            typedef std::vector<VFSSourceProvider*> type_providers;
            type_providers m_providers;

            typedef std::vector<VFSSource*> type_sources;
            type_sources m_sources;

            typedef std::set<std::string> type_usedfiles;
            mutable type_usedfiles m_usedfiles;

            std::set<std::string> filterList(const std::set<std::string>& list, const std::string& fregex) const;
            VFSSource* getSourceForFile(const std::string& file) const;
    };

}

#endif