Loader.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_LOADER_H_
#define _MIRA_LOADER_H_

#ifndef Q_MOC_RUN
#include <boost/filesystem/path.hpp>
#include <boost/filesystem/operations.hpp>
#include <boost/assign.hpp>
#endif

#include <factory/Factory.h>
#include <xml/XMLDom.h>

#include <fw/FrameworkExports.h>

namespace mira {


class ConfigurationLoader;

class MIRA_FRAMEWORK_EXPORT ConfigurationPreparePlugin : public Object
{
    MIRA_ABSTRACT_OBJECT(ConfigurationPreparePlugin)
public:
    virtual ~ConfigurationPreparePlugin() {}

    virtual void prepareDocument(XMLDom& xml) = 0;

    virtual int getOrder() const = 0;
};

typedef boost::shared_ptr<ConfigurationPreparePlugin> ConfigurationPreparePluginPtr;


class MIRA_FRAMEWORK_EXPORT ConfigurationLoaderPlugin : public Object
{
    MIRA_ABSTRACT_OBJECT(ConfigurationLoaderPlugin)
public:
    virtual ~ConfigurationLoaderPlugin() {}

    virtual void startDocument(ConfigurationLoader* ioLoader) {};

    virtual void endDocument(ConfigurationLoader* ioLoader) {};

    virtual void parseNode(const XMLDom::const_iterator& node,
                           ConfigurationLoader* ioLoader) = 0;
};

typedef boost::shared_ptr<ConfigurationLoaderPlugin> ConfigurationLoaderPluginPtr;


class MIRA_FRAMEWORK_EXPORT ConfigurationLoader
{
public:
    typedef std::map<std::string, std::string> Context;
public:

    ConfigurationLoader(bool unknownTagWarning = true);

    void registerPreparePlugin(ConfigurationPreparePluginPtr plugin);
    void registerLoaderPlugin(const ClassProxy& plugin);

    void prepare(XMLDom& ioXML);
    void load(const XMLDom& xml);

    Context& getContext()
    {
        return mContext;
    }


    void parseNode(const XMLDom::const_iterator& node);
    void parse(const XMLDom::const_iterator& iNode);


private:

    struct CompareConfigurationPreparePlugin {
        bool operator()(const ConfigurationPreparePluginPtr& a,
                        const ConfigurationPreparePluginPtr& b) const {
            return a->getOrder() < b->getOrder();
        }
    };

    Context mContext;
    typedef std::set<ConfigurationPreparePluginPtr,
                     CompareConfigurationPreparePlugin> PreparePluginMap;

    typedef std::vector<std::pair<ClassProxy, ConfigurationLoaderPluginPtr>> LoaderPluginSet;
    typedef std::map<std::string, LoaderPluginSet> LoaderPluginMap;

    bool mEnableUnknownTagWarnings;

    PreparePluginMap mPreparePlugins;

    LoaderPluginMap mLoaderPluginsMap;
    LoaderPluginSet mLoaderPlugins;

    bool mAddedInfoToException;
};


}

#endif