Command.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */


#ifndef ANA_PROCESSOR_COMMAND_H
#define ANA_PROCESSOR_COMMAND_H


//--- header files ------------------------------------------------------------

#include <map>
#include <string>

class Tree;


//--- class declarations ------------------------------------------------------


namespace anatomist
{
  class Serializer;
  class Unserializer;
  class CommandReader;
  struct CommandContext;

  class Command
  {
  public:
    virtual ~Command();

    virtual void execute();
    virtual void undo();
    virtual void redo();

    typedef Command* (*Reader)( const Tree &, CommandContext * );

    virtual std::string name() const = 0;

    virtual void write( Tree & com, Serializer *ser ) const;

  protected:
    Command();

    virtual void doit() = 0;
    virtual void undoit();

  private:
    Command(const Command&);
    Command& operator=(const Command&);
  };


  //--- class declarations ----------------------------------------------------

  class RegularCommand : public Command
  {
  public:
    virtual ~RegularCommand();

  protected:
    RegularCommand();
  };


  //--- class declarations ----------------------------------------------------

  class SerializingCommand
  {
  public:
    virtual ~SerializingCommand();
    CommandContext *context() { return _context; }
    const CommandContext *context() const { return _context; }

  protected:
    SerializingCommand( CommandContext * );

    CommandContext *_context;
  };


  //--- class declarations ----------------------------------------------------

  class WaitCommand : public Command
  {
  public:
    virtual ~WaitCommand();

    virtual void execute();
    virtual void undo();
    virtual void redo();

  protected:
    WaitCommand();
  };

}


#endif