registry.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Authors: Andreas Vogel, Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG_BRIDGE__REGISTRY__
#define __H__UG_BRIDGE__REGISTRY__
 
#include <vector>
#include <string>
#include <cstring>
#include <typeinfo>
#include <iostream>
#include <boost/function.hpp>
#include <boost/type_traits.hpp>
 
 
#include "global_function.h"
#include "class.h"
#include "param_to_type_value_list.h"
#include "parameter_stack.h"
#include "common/ug_config.h"
 
namespace ug
{
namespace bridge
{
 
//  PREDECLARATIONS
class Registry;
 
 
typedef boost::function<void (Registry* pReg)> FuncRegistryChanged;
 
 
class UG_API ClassGroupDesc
{
  public:
    ClassGroupDesc() : m_defaultClass(NULL) {}
 
    void set_name(const std::string& name)  {m_name = name;}
 
    const std::string& name() const     {return m_name;}
 
    void add_class(IExportedClass* c, const std::string& tag)
      {m_classes.push_back(c); m_classTags.push_back(tag);}
 
    size_t num_classes() const      {return m_classes.size();}
 
    bool empty() const          {return num_classes() == 0;}
 
    IExportedClass* get_class(size_t i) {return m_classes[i];}
 
    const IExportedClass* get_class(size_t i) const {return m_classes[i];}
 
    const std::string& get_class_tag(size_t i) const{return m_classTags[i];}
 
    void set_default_class(size_t i)  {m_defaultClass = m_classes[i];}
 
    IExportedClass* get_default_class() const {return m_defaultClass;}
 
  private:
    std::string           m_name;
 
    std::vector<IExportedClass*>  m_classes;
 
    std::vector<std::string>    m_classTags;
 
    IExportedClass*         m_defaultClass;
};
 
 
 
class UG_API Registry {
  public:
    Registry();
 
    ~Registry();
    
    void set_force_construct_via_smart_pointer(bool bForceConstructionWithSmartPtr);
 
  //  callbacks
 
    void add_callback(FuncRegistryChanged callback);
 
    bool registry_changed();
 
  // global functions
    
    template<typename TFunc>
    Registry& add_function(std::string funcName, TFunc func, std::string group = "",
                           std::string retValInfos = "", std::string paramInfos = "",
                           std::string tooltip = "", std::string help = "");
 
    template<typename TFunc>
    ExportedFunction*
    add_and_get_function(std::string funcName, TFunc func, std::string group = "",
                         std::string retValInfos = "", std::string paramInfos = "",
                         std::string tooltip = "", std::string help = "");
 
    size_t num_functions() const;
 
    ExportedFunction& get_function(size_t ind);
    const ExportedFunction& get_function(size_t ind) const;
 
    size_t num_overloads(size_t ind) const;
 
    ExportedFunction& get_overload(size_t funcInd, size_t oInd);
 
    ExportedFunctionGroup& get_function_group(size_t ind);
 
    ExportedFunctionGroup* get_exported_function_group(const std::string& name);
 
  // classes
 
    template <typename TClass>
    ExportedClass<TClass>& add_class_(std::string className,
                                       std::string group = "",
                                       std::string tooltip = "");
 
    template <typename TClass, typename TBaseClass>
    ExportedClass<TClass>& add_class_(std::string className,
                                       std::string group = "",
                                       std::string tooltip = "");
 
    template <typename TClass, typename TBaseClass1, typename TBaseClass2>
    ExportedClass<TClass>& add_class_(std::string className,
                                       std::string group = "",
                                       std::string tooltip = "");
 
    template <typename TClass>
    ExportedClass<TClass>& get_class_();
 
    size_t num_classes() const;
 
    const IExportedClass& get_class(size_t ind) const;
 
    IExportedClass* get_class(const std::string& name);
 
    const IExportedClass* get_class(const std::string& name) const;
 
    bool check_consistency();
 
 
  // class-groups
 
    size_t num_class_groups() const;
 
    const ClassGroupDesc* get_class_group(size_t i) const;
 
    ClassGroupDesc* get_class_group(size_t i);
 
 
    ClassGroupDesc* get_class_group(const std::string& name);
 
 
    const ClassGroupDesc* get_class_group(const std::string& name) const;
 
 
    void add_class_to_group(std::string className, std::string groupName,
                            std::string classTag = "");
 
 
    bool classname_registered(const std::string& name);
 
    bool groupname_registered(const std::string& name);
 
    bool functionname_registered(const std::string& name);
 
  protected:
    template <typename TClass, typename TBaseClass>
    void check_base_class(const std::string& className);
 
  private:
  //  disallow copy
    Registry(const Registry& reg);
    
    std::vector<ExportedFunctionGroup*> m_vFunction;
 
    std::vector<IExportedClass*> m_vClass;
 
    std::vector<ClassGroupDesc*> m_vClassGroups;
 
    std::vector<FuncRegistryChanged> m_callbacksRegChanged;
 
    bool m_bForceConstructionWithSmartPtr;
};
 
// end group registry
 
} // end namespace registry
 
} // end namespace ug
 
//  include implementation
#include "registry_impl.h"
 
#endif /* __H__UG_BRIDGE__REGISTRY__ */