moduleInterface.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 _MODULE_INTERFACE_HPP_INCLUDED
#define _MODULE_INTERFACE_HPP_INCLUDED

#include <string>
#include <cstring>
#include <list>
#include <vector>
#include "config/configurationBase.hpp"
#include "module/constructor.hpp"

namespace _Wolframe {
namespace module {

class BuilderBase
{
public:
        virtual ~BuilderBase()                          {}

        virtual const char* objectClassName() const = 0;
        virtual ObjectConstructorBase::ObjectType objectType() const = 0;
        virtual ObjectConstructorBase* constructor() = 0;
};

class SimpleBuilder
        :public BuilderBase
{
        friend class ModulesDirectory;
public:
        SimpleBuilder( const char* builderID )
                : m_className( builderID )              {}

        virtual ~SimpleBuilder()                        {}

        virtual const char* objectClassName() const     { return m_className; }

        virtual ObjectConstructorBase::ObjectType objectType() const = 0;
        virtual ObjectConstructorBase* constructor() = 0;
protected:
        const char* m_className;
};

class ConfiguredBuilder
        :public BuilderBase
{
        friend class ModulesDirectory;
public:
        ConfiguredBuilder( const char* title, const char* section, const char* keyword,
                           const char* className )
                : m_title( title ), m_section( section ), m_keyword( keyword ),
                  m_className( className )              {}

        virtual ~ConfiguredBuilder()                    {}

        virtual const char* objectClassName() const     { return m_className; }

        virtual ObjectConstructorBase::ObjectType objectType() const = 0;

        virtual config::NamedConfiguration* configuration( const char* logPrefix ) = 0;

        virtual ObjectConstructorBase* constructor() = 0;

protected:
        const char* m_title;            
        const char* m_section;          
        const char* m_keyword;          //< configuration keyword (element)
        const char* m_className;        //< class name of the object
};


template < class Tconstructor, class Tconf >
class ConfiguredBuilderDescription : public ConfiguredBuilder
{
public:
        ConfiguredBuilderDescription( const char* title, const char* section,
                                      const char* keyword, const char* className )
                : ConfiguredBuilder( title, section, keyword, className )       {}

        virtual ~ConfiguredBuilderDescription()         {}

        virtual config::NamedConfiguration* configuration( const char* logPrefix )      {
                return new Tconf( m_title, logPrefix, m_keyword );
        }
        virtual ObjectConstructorBase::ObjectType objectType() const    {
                return m_constructor.objectType();
        }
        virtual ObjectConstructorBase* constructor()    {
                return &m_constructor;
        }
private:
        Tconstructor    m_constructor;
};


//*********** Module interface *********

typedef BuilderBase* (*createBuilderFunc)();


struct ModuleEntryPoint
{
        enum    SignSize        {
                MODULE_SIGN_SIZE = 16
        };

        char signature[ MODULE_SIGN_SIZE];              
        unsigned short ifaceVersion;                    
        const char* name;                               
        createBuilderFunc* createBuilder;               
public:
        ModuleEntryPoint( unsigned short iVer, const char* modName, createBuilderFunc* createBuilder_)
                : ifaceVersion( iVer ), name( modName ), createBuilder( createBuilder_ )
        {
                std::memset ( signature, 0, MODULE_SIGN_SIZE);
                std::memcpy ( signature, "Wolframe Module", std::strlen("Wolframe Module"));
        }
};

extern "C" ModuleEntryPoint entryPoint;

}} // namespace _Wolframe::module

#endif // _MODULE_INTERFACE_HPP_INCLUDED