command-setup.hpp

Go to the documentation of this file.

/*
  COMMAND-INSTANCE-SETUP.hpp  -  Key abstraction for steam/edit operations and UNDO management

  Copyright (C)         Lumiera.org
    2017,               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 CONTROL_COMMAND_SETUP_H
#define CONTROL_COMMAND_SETUP_H

#include "lib/error.hpp"
#include "lib/nocopy.hpp"
#include "steam/control/command.hpp"
#include "lib/symbol.hpp"

#include <functional>
#include <string>




namespace steam {
namespace control {
  
  using std::string;
  using lib::Symbol;
  
  class CommandDef;
  
  using DefinitionClosure = std::function<void(CommandDef&)>;
  
  
  
  class CommandSetup
    : util::Cloneable   // copy-construction allowed, but no assignment
    {
      Symbol cmdID_;
      
    public:
     ~CommandSetup();
      CommandSetup (Symbol cmdID);
      
      operator Symbol const&()  const
        {
          return cmdID_;
        }
      operator string()  const
        {
          return string{cmdID_};
        }
      
      CommandSetup& operator= (DefinitionClosure);
      
      static void invokeDefinitionClosures();
      
      static size_t pendingCnt();
      
      friend bool
      operator== (CommandSetup const& left, CommandSetup const& right)
      {
        return left.cmdID_ == right.cmdID_;
      }
      friend bool
      operator!= (CommandSetup const& left, CommandSetup const& right)
      {
        return left.cmdID_ != right.cmdID_;
      }
    };
  
  
  
  
  #define COMMAND_DEFINITION(_NAME_) \
    CommandSetup _NAME_ = CommandSetup{STRINGIFY(_NAME_)}  = [&](CommandDef& def)
  
  
  
}} // namespace steam::control
#endif /*CONTROL_COMMAND_SETUP_H*/