configurationBase.hpp

Go to the documentation of this file.

/************************************************************************

 Copyright (C) 2011 - 2014 Project Wolframe.
 All rights reserved.

 This file is part of Project Wolframe.

 Commercial Usage
    Licensees holding valid Project Wolframe Commercial licenses may
    use this file in accordance with the Project Wolframe
    Commercial License Agreement provided with the Software or,
    alternatively, in accordance with the terms contained
    in a written agreement between the licensee and Project Wolframe.

 GNU General Public License Usage
    Alternatively, you can redistribute this file and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Wolframe 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 Wolframe.  If not, see <http://www.gnu.org/licenses/>.

 If you have questions regarding the use of this file, please contact
 Project Wolframe.

************************************************************************/

#ifndef _CONFIGURATION_BASE_HPP_INCLUDED
#define _CONFIGURATION_BASE_HPP_INCLUDED

#include "config/configurationTree.hpp"
#include <string>
#include <ostream>
#include <list>

// forward definition
namespace _Wolframe { namespace module {
        class ModulesDirectory;
}} // namespace _Wolframe::module

namespace _Wolframe {
namespace config {


class ConfigurationBase
{
public:
        ConfigurationBase( const char* sectionName_, const char* logParent_, const char* logName_ )
        {
                m_sectionName = sectionName_ ? sectionName_ : "";
                m_logPrefix = logParent_ ? logParent_ : "";
                if ( logName_ && *logName_ != '\0' )    {
                        m_logPrefix += logName_;
                        m_logPrefix += ": ";
                }
        }

        virtual ~ConfigurationBase()                    {}

        const std::string& sectionName() const          { return m_sectionName; }

        const std::string& logPrefix() const            { return m_logPrefix; }

        virtual bool parse( const ConfigurationNode& cfgTree, const std::string& node,
                            const module::ModulesDirectory* modules ) = 0;

        virtual void setCanonicalPathes( const std::string& /* refPath */ )     {}

        virtual bool check() const                      { return true; }

        // these functions are not implemented / implementable yet
        // and I am not sure if it should be here or not
        // virtual bool test() const = 0;

        virtual void print( std::ostream& os, size_t indent = 0 ) const = 0;

private:
        std::string                     m_sectionName;
        std::string                     m_logPrefix;
};


class NamedConfiguration : public ConfigurationBase
{
public:
        NamedConfiguration( const char* sectionName_, const char* logParent_, const char* logPrefix_ )
                : ConfigurationBase( sectionName_, logParent_, logPrefix_ )     {}

        virtual ~NamedConfiguration()                           {}

        virtual const char* className() const = 0;
};

}} // namespace _Wolframe::config

#endif // _CONFIGURATION_BASE_HPP_INCLUDED