bus-term.hpp

Go to the documentation of this file.

/*
  BUS-TERM.hpp  -  connection point for UI elements to the UI-Bus

  Copyright (C)         Lumiera.org
    2015,               Hermann Vosseler <Ichthyostega@web.de>

  This program 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.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef STAGE_CTRL_BUS_TERM_H
#define STAGE_CTRL_BUS_TERM_H


#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "lib/idi/entry-id.hpp"
#include "lib/diff/gen-node.hpp"

#include <utility>
#include <string>


namespace lib {
  namespace diff { class MutationMessage; }
}
namespace stage {
namespace model {
  class Tangible;
}
namespace ctrl{
  
  using lib::idi::EntryID;
  using lib::diff::GenNode;
  using lib::diff::MutationMessage;
  using std::string;
  
  
  class BusTerm
    : util::MoveOnly
    {
    protected:
      using EntryID = lib::idi::BareEntryID;
      using Tangible = stage::model::Tangible;
      
      EntryID endpointID_;
      BusTerm& theBus_;
      
    public:
      using ID = EntryID const&;
      
      virtual ~BusTerm();  
      
      virtual void act  (GenNode const& command);
      virtual void note (ID subject, GenNode const& mark);
      virtual bool mark (ID subject, GenNode const& mark);
      
      virtual size_t markAll (GenNode const& mark);
      virtual bool change (ID subject, MutationMessage&& diff);
      
      virtual operator string()  const;
      
      void note (GenNode const& mark);
      
      ID getID()  const { return endpointID_; }
      
      
      BusTerm attach (ID, Tangible& newNode);
      
      BusTerm(BusTerm&&)      = default;
      
    protected:
      BusTerm(ID identity, BusTerm& attached_to)
        : endpointID_(identity)
        , theBus_(attached_to)
        { }
      
      virtual BusTerm& routeAdd(ID,Tangible&);
      virtual void routeDetach(ID)  noexcept;
      
      bool isShortCircuit(ID)  const noexcept;
    };
  
  
  
  
  inline void
  BusTerm::note (GenNode const& mark)
  {
    theBus_.note (this->endpointID_, mark);
  }
  
  inline bool
  BusTerm::isShortCircuit(ID otherID)  const noexcept
  {
    return &theBus_ == this
        or otherID == endpointID_;
  }
  
  
  
}} // namespace stage::ctrl
#endif /*STAGE_CTRL_BUS_TERM_H*/