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/engine/buffhandle.hpp"
#include "steam/engine/turnout-system.hpp"
#include "lib/format-string.hpp"
#include "lib/several.hpp"
 
#include <string>
#include <optional>
 
 
 
namespace steam {
namespace engine {
  namespace err = lumiera::error;
 
  using std::move;
  using std::string;
  using std::nullopt;
  using std::optional;
  using lib::HashVal;
  using util::_Fmt;
  
  class ProcID;
  class ProcNode;
  class ProcNodeDiagnostic;
  
  using ProcNodeRef = std::reference_wrapper<ProcNode>;
  using OptionalBuff = std::optional<BuffHandle>;
  
  
  const size_t MAX_NODE_ARG = LUMIERA_MAX_ORDINAL_NUMBER / 2;
  
  
  
  class Port
    : util::NonCopyable
    {
    public:
      virtual ~Port();  
      Port (ProcID& id) : procID{id} { }
      
      virtual BuffHandle weave (TurnoutSystem&, OptionalBuff =std::nullopt)   =0;
      
      ProcID& procID;
      
      friend bool operator== (Port const& pl, Port const& pr){ return    & pl == & pr;}
      friend bool operator!= (Port const& pl, Port const& pr){ return not (pl == pr); }
    };
  
  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;
      
      Connectivity (Ports&& pr, Leads&& lr)
        : ports(move(pr))
        , leads(move(lr))
        { }
      
    };
  
  
  
  
  class ProcNode
    : util::NonCopyable
    {
      
      Connectivity wiring_;
      
    public:
      ProcNode (Connectivity&& con)
        : wiring_(move(con))
        { }
      
      
      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];
        }
      
      friend bool operator== (ProcNode const& nl, ProcNode const& nr){ return    & nl == & nr;}
      friend bool operator!= (ProcNode const& nl, ProcNode const& nr){ return not (nl == nr); }
      
      
      /*************************************************************/
      BuffHandle
      pull (uint portIdx, BuffHandle output, Time nomTime, ProcessKey procKey)
        {
          TurnoutSystem turnoutSystem{nomTime, procKey};
          return getPort(portIdx).weave (turnoutSystem, output);
        }
      
      friend class ProcNodeDiagnostic;
    };
  
  
  /* ========== Diagnostic and Testing ========== */
  
  class PortDiagnostic;
  
  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 getNodeName();   
      string getNodeSpec();   
      HashVal getNodeHash();  
      
      string getPortSpec  (uint portIdx);  
      HashVal getPortHash (uint portIdx);  
      
      ProcNodeDiagnostic watchLead(uint leadIdx);
      PortDiagnostic     watchPort(uint portIdx);
    };
  
  inline ProcNodeDiagnostic
  watch (ProcNode& theNode)
  {
    return ProcNodeDiagnostic{theNode};
  }
  
  
  
  class PortDiagnostic
    : util::MoveOnly
    {
      Port& p_;
      
    public:
      PortDiagnostic (Port& thePort)
        : p_{thePort}
        { }
      
      lib::Several<PortRef> const& srcPorts();
      
      bool isSrc()  { return srcPorts().empty(); }
      
      string getProcName();   
      string getProcSpec();   
      HashVal getProcHash();  
      
      PortDiagnostic watchLead(uint leadIdx);
      
      bool verify_connected (uint input, Port&);
      bool verify_connected (Port&);
    };
  
  inline PortDiagnostic
  watch (Port& thePort)
  {
    return PortDiagnostic{thePort};
  }
  
  
  
  
  class _ConCheck
    : util::MoveOnly
    {
      ProcNodeDiagnostic anchor;
      ProcNode*          srcNode{nullptr};
      Port*              srcPort{nullptr};
      optional<uint>     leadNo{nullopt};
      optional<uint>     portNo{nullopt};
      optional<uint>     srcNo {nullopt};
      optional<uint>     srcPNo{nullopt};
      
    public:
      _ConCheck (ProcNode& n)
        : anchor{watch(n)}
        { }
      
      operator bool();
      
      _ConCheck to (ProcNode& n) { srcNode = &n; return move(*this); }
      _ConCheck to (Port& p)     { srcPort = &p; return move(*this); }
      _ConCheck asLead (uint idx){ leadNo = idx; return move(*this); }
      _ConCheck toLead (uint idx){ leadNo = idx; return move(*this); }
      _ConCheck asSrc  (uint idx){ srcNo  = idx; return move(*this); }
      _ConCheck port   (uint idx){ portNo = idx; return move(*this); }
      _ConCheck atPort (uint idx){ srcPNo = idx; return move(*this); }
    };
  
  inline _ConCheck
  is_linked (ProcNode& n)
  {
    return _ConCheck{n};
  }
  
  
}} // namespace steam::engine
#endif /*STEAM_ENGINE_PROC_NODE_H*/