Registry.h

Go to the documentation of this file.

/*

             *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2018
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **

*/
#pragma once

#include "PlugDescriptor.h"
#include "Version.h"

  namespace maquina
  {
    class Node;
    class Value;
    class NodePlugin;
    class NodeLoaderPlugin;
    class Registry
    {
    public:
      virtual ~Registry() {};

      using Factory = std::function<std::shared_ptr<NodePlugin>( Node *node )>;


      virtual void register_node(
        const char *class_name,       
        const char *base_class_name,  
        Factory factory,              
        const std::vector<PlugDescriptor> &plug_desc, 
        const char *ui_descriptor = ""     
        ) = 0;


      virtual void register_node(
        const char *class_name,       
        const char *base_class_name,  
        const std::vector<PlugDescriptor> &plug_desc, 
        const char *ui_descriptor = "" 
        ) = 0;

      virtual void register_node_loader(const std::shared_ptr<NodeLoaderPlugin>& node_loader) = 0;

      /* \raise{std::runtime_error,RuntimeError} in case the value is already registered or the parent type name does not exist. */
      template<class UD>
      void register_value(
        const char *parent_type_name = "Value"   // The parent's value type_name
        )
      {
        std::shared_ptr<UD> default_value = std::make_shared<UD>();
        register_value(default_value->type_name().c_str(), default_value, parent_type_name);
      };

      /* \raise{std::runtime_error,RuntimeError} in case the value is already registered or the parent type name does not exist. */
      virtual void register_value(
        const char *type_name,          // The value type_name
        std::shared_ptr<const maquina::UserData> default_value, /* The UserData for the default_value. That UserData will be shared by all the default value
        instance of that type. It should not be modified. */
        const char *parent_type_name = "Value"   // The parent's value type_name
        ) = 0;

    };

    MAQUINA_EXPORT Registry& registry();

    MAQUINA_EXPORT Value default_value(const maquina::StringView& type_name);
  }

#define MAQUINA_DECLARE_PLUGINS extern "C" MAQUINA_DLL_EXPORT int rumba_sdk_version; int rumba_sdk_version = RUMBA_SDK_BETA_VERSION;
#define MAQUINA_REGISTER_PLUGINS extern "C" MAQUINA_DLL_EXPORT void rumba_register_plugins( ::maquina::Registry &r )