source: code/branches/usability/src/libraries/core/Loader.h @ 9215

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

/**
    @defgroup Loader Loader
    @ingroup XML
*/

/**
    @file
    @ingroup XML Loader
*/

#ifndef _Loader_H__
#define _Loader_H__

#include "CorePrereqs.h"

#include <map>
#include <vector>
#include "ClassTreeMask.h"

namespace orxonox
{
    class _CoreExport Loader
    {
        public:
            static bool open(const XMLFile* file, const ClassTreeMask& mask = ClassTreeMask());
            static void close();
            static void close(const XMLFile* file);

            static void add(const XMLFile* file, const ClassTreeMask& mask = ClassTreeMask());
            static void remove(const XMLFile* file);

            static bool load(const ClassTreeMask& mask = ClassTreeMask(), bool verbose = true);
            static void unload(const ClassTreeMask& mask = ClassTreeMask());
            static bool reload(const ClassTreeMask& mask = ClassTreeMask(), bool verbose = true);

            static bool load(const XMLFile* file, const ClassTreeMask& mask = ClassTreeMask(),
                             bool verbose = true, bool bRemoveLuaTags = false);
            static void unload(const XMLFile* file, const ClassTreeMask& mask = ClassTreeMask());
            static bool reload(const XMLFile* file, const ClassTreeMask& mask = ClassTreeMask(), bool verbose = true);

            static std::string replaceLuaTags(const std::string& text);
            static std::string removeLuaTags(const std::string& text);

            static ClassTreeMask currentMask_s;

        private:
            static bool getLuaTags(const std::string& text, std::map<size_t, bool>& luaTags);

            static std::vector<std::pair<const XMLFile*, ClassTreeMask> > files_s;
    };
}

#endif /* _Loader_H__ */