PlugDescriptor.h

Go to the documentation of this file.

/*

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

*/
#pragma once

#include "Value.h"
#include "Plug.h"
#include "Ptr.h"

  namespace maquina
  {
    class ConditionalEvalContext;
    class Value;
    class EvalContext;
    class PartialInvalidation;
    using PartialInvalidationPtr = Ptr<const PartialInvalidation>;

    class PlugDescriptor
    {
    public:
      enum Flags
      {
        none            = 0,
        cache           = 1 << 0,   
        time_varying    = 1 << 1,   
        serial          = 1 << 3,   
        graph_invisible = 1 << 8,   
        hidden          = 1 << 8,   
        channel         = 1 << 9,   
        constant        = 1 << 10,  
        cache_exact     = 1 << 11,  
        main            = 1 << 12,  
        auto_connect    = 1 << 13,  
        no_input        = 1 << 15,  
        background      = 1 << 30   
      };

      struct InternalDependencies
      {
        InternalDependencies
        (
          const char* plug_name, 
          int time_offset = 0,   
          bool (*evaluate)(const ConditionalEvalContext& context, int dep) = nullptr 
        ) : 
          _plug_name(plug_name),
          _time_offset(time_offset),
          _evaluate(evaluate)
        {}

        const char* _plug_name;
        int _time_offset;
        bool (*_evaluate)(const ConditionalEvalContext& context, int dep) = nullptr;
      };

      struct ExternalDependencies
      {
        ExternalDependencies
          (
            const char* plug_name,
            const Value& default_value
          ) :
          _plug_name(plug_name),
          _default_value(default_value)
        {
        }

        const char* _plug_name;
        Value _default_value;
      };


      PlugDescriptor(
        const char* plug_name, 
        const Value& default_value, 
        uint32_t flags = serial,     
        const char* ui = "" 
      ) :
        _plug_name(plug_name),
        _default_value(default_value),
        _flags(flags),
        _ui(ui)
      {}


      PlugDescriptor(
        const char *plug_name, 
        const Value &default_value, 
        uint32_t flags,     
        const char* ui, 
        const std::function<Value(EvalContext&)>& eval_handler, 
        const std::vector<InternalDependencies> &intern_deps, 
        PartialInvalidationPtr (*partial_invalidation_handler)(const Plug& plug, int dep, const PartialInvalidationPtr& pi) = nullptr, 
        bool (*dyn_evaluate)(const ConditionalEvalContext& context, int dep) = nullptr, 
        int first_extern_deps = -1,                           
        const std::vector<ExternalDependencies> &extern_deps = {} 
      ) :
        _plug_name(plug_name),
        _default_value(default_value),
        _flags(flags),
        _ui(ui),
        _eval_handler(eval_handler),
        _intern_deps(intern_deps),
        _partial_invalidation_handler(partial_invalidation_handler),
        _dyn_evaluate(dyn_evaluate),
        _first_extern_deps(first_extern_deps),
        _extern_deps(extern_deps)
      {
        _has_conditional_evaluation = _dyn_evaluate != nullptr;
        for(const auto& intern_dep : _intern_deps)
          _has_conditional_evaluation |= intern_dep._evaluate != nullptr;
      }

    public:

      std::string _plug_name;
      Value _default_value;
      uint32_t _flags = 0;
      std::string _ui;
      std::function<Value(EvalContext&)> _eval_handler;
      std::vector<InternalDependencies> _intern_deps;
      PartialInvalidationPtr (*_partial_invalidation_handler)(const Plug& plug, int dep, const PartialInvalidationPtr& pi) = nullptr;
      bool (*_dyn_evaluate)(const ConditionalEvalContext& context, int dep) = nullptr;
      int _first_extern_deps = -1;
      std::vector<ExternalDependencies> _extern_deps;
      bool _has_conditional_evaluation = false; // true if _dyn_evaluate or at least one _intern_deps entry has an _evaluate function
    };
  }