/*
  test/NEXUS.hpp  -  fake user interface backbone for test support

  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.

*/


/** @file test/nexus.hpp
 ** A generic interface element instrumented for unit testing.
 ** All relevant building blocks within the Lumiera GTK UI are based on
 ** gui::model::Tangible, meaning that any generic effect of interface interactions
 ** can be expressed in terms of this interface contract. As far as the UI participates
 ** in interactions with the lower layers, like e.g. command invocation, structure updates
 ** and state notifications, these processes can be modelled and verified with the help
 ** of a specially prepared Tangible instance. This gui::test::MockElm provides the
 ** necessary instrumentation to observe what has been invoked and received.
 ** 
 ** @todo initial draft and WIP-WIP-WIP as of 11/2015
 ** 
 ** @see abstract-tangible-test.cpp
 ** 
 */


#ifndef GUI_TEST_NEXUS_H_
#define GUI_TEST_NEXUS_H_


#include "lib/error.hpp"
#include "lib/idi/entry-id.hpp"
//#include "lib/util.hpp"
#include "gui/model/tangible.hpp"
#include "lib/diff/record.hpp"

#include <boost/noncopyable.hpp>
#include <string>


namespace gui {
namespace test{
  
//  using lib::HashVal;
//  using util::isnil;
  using lib::idi::EntryID;
  using lib::diff::Record;
  using std::string;
  
  
  /**
   * Mock UI element or controller.
   * Within Lumiera, all interface components of relevance are based
   * on the [Tangible] interface, which we mock here for unit testing.
   * This special implementation is instrumented to [log][lib::test::EventLog]
   * any invocation and any messages sent or received through the UI Backbone,
   * which is formed by the [UiBus].
   * 
   * @todo some usage details
   * @see abstract-tangible-test.cpp
   */
  class Nexus
    : boost::noncopyable
    {
      
      /* ==== Tangible interface ==== */
      
      virtual void
      act (GenNode command)  override
        {
          UNIMPLEMENTED ("");
        }
      virtual void note (GenNode mark)     =0;
      virtual void mark (GenNode mark)     =0;
      
      virtual void act  (EntryID subject, GenNode command)  =0;
      virtual void note (EntryID subject, GenNode mark)     =0;
      virtual void mark (EntryID subject, GenNode mark)     =0;
      
      
    protected:
    public:
      explicit
      MockElm(string id)
        : gui::model::Tangible(TODO_generate_identity, TestNexus::hook())
        { }
      
      explicit
      MockElm(EntryID identity, ctrl::BusTerm&& nexus =TestNexus::hook())
        { }
    };
  
  
  
}} // namespace gui::test
#endif /*GUI_TEST_NEXUS_H_*/