turnout.hpp

Go to the documentation of this file.

/*
  TURNOUT.hpp  -  Fixed standard scheme to generate data within a Render Node

   Copyright (C)
     2008,            Hermann Vosseler <Ichthyostega@web.de>
     2024,            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_TURNOUT_H
#define STEAM_ENGINE_TURNOUT_H

#include "steam/common.hpp"
#include "steam/engine/proc-node.hpp"
#include "steam/engine/turnout-system.hpp"
#include "steam/engine/feed-manifold.hpp"
//#include "vault/gear/job.h"
//#include "steam/engine/exit-node.hpp"
//#include "lib/time/timevalue.hpp"
//#include "lib/linked-elements.hpp"
#include "lib/several.hpp"
//#include "lib/util-foreach.hpp"
//#include "lib/iter-adapter.hpp"
#include "lib/meta/function.hpp"
//#include "lib/itertools.hpp"
//#include "lib/util.hpp"      ////////OOO wegen manifoldSiz<FUN>()

#include <utility>
#include <array>
//#include <stack>


namespace steam {
namespace engine {
  
  using std::forward;
  using lib::Several;
  
  
  template<class ADA>
  constexpr bool
  _verify_usable_as_InvocationAdapter()
  {
    ASSERT_MEMBER_FUNCTOR (&ADA::connect, void(uint, uint));
    ASSERT_MEMBER_FUNCTOR (&ADA::invoke, void());
    return sizeof(ADA);
  }
  
  
  
  template<class INVO>
  struct SimpleWeavingPattern
    : INVO
    {
      using Feed = typename INVO::Feed;
      
      static_assert (_verify_usable_as_InvocationAdapter<Feed>());
      
      Several<PortRef>   leadPort;
      Several<BuffDescr> outTypes;
      
      uint resultSlot{0};
      
      template<typename...ARGS>
      SimpleWeavingPattern (Several<PortRef>&&   pr
                           ,Several<BuffDescr>&& dr
                           ,uint resultIdx
                           ,ARGS&& ...args)
        : INVO{forward<ARGS>(args)...}
        , leadPort{move(pr)}
        , outTypes{move(dr)}
        , resultSlot{resultIdx}
        { }
      
      
      Feed
      mount()
        {
          return INVO::buildFeed();
        }
      
      void
      pull (Feed& feed, TurnoutSystem& turnoutSys)
        {
          for (uint i=0; i<leadPort.size(); ++i)
            {
              BuffHandle inputData = leadPort[i].get().weave (turnoutSys);
              feed.inBuff.createAt(i, move(inputData));
            }
        }
      
      void
      shed (Feed& feed, OptionalBuff outBuff)
        {
          for (uint i=0; i<outTypes.size(); ++i)
            {
              BuffHandle resultData =
                i == resultSlot and outBuff? *outBuff
                                           : outTypes[i].lockBuffer();
              feed.outBuff.createAt(i, move(resultData));
            }
          feed.connect (leadPort.size(),outTypes.size());
        }
      
      void
      weft (Feed& feed)
        {
          feed.invoke();                 // process data
        }
      
      BuffHandle
      fix (Feed& feed)
        {
          for (uint i=0; i<leadPort.size(); ++i)
            {
              feed.inBuff[i].release();
            }
          for (uint i=0; i<outTypes.size(); ++i)
            {
              feed.outBuff[i].emit();    // state transition: data ready
              if (i != resultSlot)
                feed.outBuff[i].release();
            }
          ENSURE (resultSlot < INVO::MAX_SIZ, "invalid result buffer configured.");
          return feed.outBuff[resultSlot];
        }
      
    };
  
  
  template<class PAT>
  class Turnout
    : public Port
    , public PAT
//    , util::MoveOnly
    {
      using Feed = typename PAT::Feed;
      
    public:
      template<typename...INIT>
      Turnout (ProcID& id, INIT&& ...init)
        : Port{id}
        , PAT{forward<INIT> (init)...}
        { }
      
      BuffHandle
      weave (TurnoutSystem& turnoutSys, OptionalBuff outBuff =std::nullopt)  override
        {
          Feed feed = PAT::mount();
          PAT::pull(feed, turnoutSys);
          PAT::shed(feed, outBuff);
          PAT::weft(feed);
          return PAT::fix (feed);
        }
    };

  
  
  
}}// namespace steam::engine
#endif /*STEAM_ENGINE_TURNOUT_H*/