proc-node.hpp

Go to the documentation of this file.

/*
  PROC-NODE.hpp  -  Key abstraction of the Render Engine: a Processing Node

   Copyright (C)
     2008,            Hermann Vosseler <Ichthyostega@web.de>

  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.

*/

#ifndef STEAM_ENGINE_PROC_NODE_H
#define STEAM_ENGINE_PROC_NODE_H

#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "lib/hash-value.h"
//#include "steam/asset/proc.hpp"
//#include "steam/mobject/parameter.hpp"
#include "steam/engine/buffhandle.hpp"
#include "steam/engine/turnout-system.hpp"
#include "lib/ref-array.hpp" 
#include "lib/format-string.hpp"
#include "lib/several.hpp"

#include <string>
#include <vector>
#include <optional>



namespace steam {
namespace engine {
  namespace err = lumiera::error;

  using std::move;
  using std::string;
  using lib::HashVal;
  using util::_Fmt;
  
  class ProcID;
  class ProcNode;
  class ProcNodeDiagnostic;
  
  using ProcNodeRef = std::reference_wrapper<ProcNode>;
  using OptionalBuff = std::optional<BuffHandle>;
  
  
  class Port
//  : util::MoveOnly     //////////////////////////////////////////////////OOO not clear if necessary here, and requires us to declare the ctors!!! See Turnout
    : util::NonCopyable  
    {
    public:
      virtual ~Port();  
      Port (ProcID& id) : procID{id} { }
      
      virtual BuffHandle weave (TurnoutSystem&, OptionalBuff =std::nullopt)   =0;
      
//    // compiler does not generate a move-ctor automatically due to explicit dtor
//    Port()       = default;
//    Port(Port&&) = default;
      ProcID& procID;
    };
  
  using PortRef = std::reference_wrapper<Port>;
  
  class Connectivity
    {
    public: /* === public information record describing the node graph === */
      using Ports = lib::Several<Port>;
      using Leads = lib::Several<ProcNodeRef>;
      
      Ports ports;
      Leads leads;
      
      
//  protected:
      Connectivity (Ports&& pr, Leads&& lr)
        : ports(move(pr))
        , leads(move(lr))
        { }
      
      
      /* ==== strategy API for configuring the node operation ==== */
      
      friend class ProcNode;                               
      
#if false 
      virtual BuffHandle
      callDown (StateClosure_OBSOLETE& currentProcess, uint requiredOutputNr)  const =0;
#endif    
      
    };
  
  
  
  
  class ProcNode
    : util::NonCopyable
    {
      
      Connectivity wiring_;
      
    public:
      ProcNode (Connectivity&& con)
        : wiring_(move(con))
        { }
      
      
      
    public:
      
      Port&
      getPort (uint portIdx)
        {
          if (portIdx >= wiring_.ports.size())
            throw err::Logic{_Fmt{"Accessing node-port #%d, while only %d ports are defined."}
                     % portIdx % wiring_.ports.size()
                ,LERR_(INDEX_BOUNDS)
                };
          return wiring_.ports[portIdx];
        }
      
#if false 
      BuffHandle
      pull (StateClosure_OBSOLETE& currentProcess, uint requestedOutputNr=0)  const
        {
          return this->wiringConfig_.callDown (currentProcess, requestedOutputNr);
        }
#endif    
      
      friend class ProcNodeDiagnostic;
    };
  
  
  class ProcNodeDiagnostic
    : util::MoveOnly
    {
      ProcNode& n_;
      
    public:
      ProcNodeDiagnostic (ProcNode& theNode)
        : n_{theNode}
        { }
      
      auto& leads() { return n_.wiring_.leads; }
      auto& ports() { return n_.wiring_.ports; }
      
      bool isSrc()  { return n_.wiring_.leads.empty(); }
      
      bool
      isValid()
        {
          return 0 < ports().size();
        }
      
      string getNodeSpec();   
      HashVal getNodeHash();  
      
      string getPortSpec  (uint portIdx);  
      HashVal getPortHash (uint portIdx);  
    };
  
  inline ProcNodeDiagnostic
  watch (ProcNode& theNode)
  {
    return ProcNodeDiagnostic{theNode};
  }
  
  
}} // namespace steam::engine
#endif /*STEAM_ENGINE_PROC_NODE_H*/