/*
  ELEMENT.hpp  -  a generic element in the UI-Model

  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 element.hpp
 ** Generic building block in the Lumiera GUI model.
 ** A model::Element has a unique identifier, which is tied to the
 ** identification scheme used in the "real" model in Proc-Layer.
 ** Model elements can be addressed receive mutations caused by changes
 ** and rebuilding of elements within the Session; moreover, a generic
 ** representation of attributes is provided.
 ** 
 ** @note as of 1/2015 this is a first draft and WIP-WIP-WIP
 ** @todo WIP  ///////////////////////TICKET #959
 ** 
 ** @see ////TODO_test usage example
 ** @see element.cpp implementation
 ** 
 */


#ifndef GUI_MODEL_ELEMENT_H
#define GUI_MODEL_ELEMENT_H


#include "lib/error.hpp"
#include "lib/hash-value.h"
//#include "lib/symbol.hpp"
#include "lib/util.hpp"

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


  
namespace gui {
namespace model {
  
  using lib::HashVal;
  using util::isnil;
  using std::string;
  
  
  /**
   * Basic (abstracted) view of...
   * 
   * @see SomeSystem
   * @see NA_test
   */
  template<class X>
  class Element
    {
      string nothing_;
      
    public:
      explicit
      Element (string const& b)
        : nothing_(b)
        { }
      
      // using default copy/assignment
      
      
      
      /* == Adapter interface for == */
      
      void
      setSolution (string const& solution ="")
        {
          UNIMPLEMENTED ("tbw");
#if false /////////////////////////////////////////////////////////////////////////////////////////////////////////////UNIMPLEMENTED :: TICKET #888
          if (isDeaf())
            this->transmogrify (solution);
#endif    /////////////////////////////////////////////////////////////////////////////////////////////////////////////UNIMPLEMENTED :: TICKET #888
        }
      
      
    protected:
      void maybe ()  const;
      
      
      friend HashVal
      hash_value (Element const& entry)
      {
        return hash_value (entry.nothing_);
      }
    };
  
  
  
  
  
  
  /** @internal in case
   */
  template<class X>
  inline void
  Element<X>::maybe ()  const
  {
    UNIMPLEMENTED ("tbw");
  }
  
  
  
  
  
}} // namespace gui::model
#endif /*GUI_MODEL_ELEMENT_H*/
