src/controllers/abstract.h

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@gmail.com>
   3             (c) 2006 Maurizio Monge <maurizio.monge@kdemail.net>
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9 */
  10
  11 #ifndef CONTROLLER_H
  12 #define CONTROLLER_H
  13
  14 #include <boost/enable_shared_from_this.hpp>
  15 #include <qstring.h>
  16 #include "common.h"
  17 #include "entitytoken.h"
  18 #include "fwd.h"
  19
  20 class ChessTable;
  21 class UserEntity;
  22 class Engine;
  23 class PGN;
  24 class ActionCollection;
  25
  26 /**
  27   * @b Controller is the base abstract class for all controllers in Tagua.
  28   * Tagua can be used in different modes, such as game editing or position editing.
  29   * Each mode corresponds to a concrete subclass of Controller, and defines its behaviour
  30   * in response to user events (history navigation, move executions...).
  31   * By default, events are routed to the user entity returned by the virtual function
  32   * entity.
  33   */
  34 class Controller : public boost::enable_shared_from_this<Controller> {
  35 protected:
  36   ChessTable* m_view;
  37   virtual boost::shared_ptr<UserEntity> entity() const = 0;
  38 public:
  39   Controller(ChessTable* view);
  40   virtual ~Controller();
  41
  42   /**
  43     * Variant specific actions.
  44     */
  45   virtual ActionCollection* variantActions() const = 0;
  46
  47   /**
  48     * Variant associated to the controller.
  49     */
  50   virtual QString variant() const = 0;
  51
  52   /**
  53     * Terminate activity, create another controller and delegate everything to it.
  54     * @return The delegate controller, or simply @b this if controller does not need
  55     * to be terminated.
  56     */
  57   virtual boost::shared_ptr<Controller> end() { return shared_from_this(); }
  58
  59   /**
  60     * Detach from resources without disposing them.
  61     */
  62   virtual void detach() { }
  63
  64   /**
  65     * Clear board. Undefined for almost all controllers.
  66     * @return Whether the action has been successfully executed.
  67     */
  68   virtual bool clearBoard() { return false; }
  69
  70   /**
  71     * Set starting position on the board. Undefined for almost all controllers.
  72     * @return Whether the action has been successfully executed.
  73     */
  74   virtual bool setStartingPosition() { return false; }
  75
  76   /**
  77     * Set a position on the board. Undefined for almost all controllers.
  78     * @param fen The position to be set, in FEN notation.
  79     * @return Whether the action has been successfully executed.
  80     */
  81   virtual bool setFEN(const QString&) { return false; }
  82
  83   /**
  84     * Get a FEN string representing the current position on the board.
  85     */
  86   virtual QString fen() { return ""; }
  87
  88   /**
  89     * @return current position, or a null shared_ptr if no current position
  90     * concept is defined for this controller.
  91     */
  92   virtual PositionPtr currentPosition() const { return PositionPtr(); }
  93
  94   /**
  95     * Change turn. Used for example in edit position mode.
  96     */
  97   virtual void setTurn(int) { }
  98
  99   /**
 100     * Forward a movelist undo call.
 101     */
 102   virtual bool undo();
 103
 104   /**
 105     * Forward a movelist redo call.
 106     */
 107   virtual bool redo();
 108
 109   /**
 110     * Forward a movelist truncate call.
 111     */
 112   virtual bool truncate();
 113
 114   /**
 115     * Forward a movelist promote variation call.
 116     */
 117   virtual bool promoteVariation();
 118
 119   /**
 120    * Navigate back in history.
 121    */
 122   virtual bool back();
 123
 124   /**
 125    * Navigate forward in history.
 126    */
 127   virtual bool forward();
 128
 129   /**
 130    * Warp to the beginning of the history.
 131    */
 132   virtual void gotoFirst();
 133
 134   /**
 135    * Warp to the end of the history.
 136    */
 137   virtual void gotoLast();
 138
 139   /**
 140     * Save game.
 141     */
 142   virtual QString save();
 143
 144   /**
 145     * Load game from a PGN.
 146     */
 147   virtual void loadPGN(const PGN&);
 148
 149   /**
 150     * Create a CTRL Action.
 151     * @sa UI::createCtrlAction
 152     */
 153   virtual void createCtrlAction() { }
 154
 155   /**
 156     * Destroy a CTRL Action.
 157     * @sa UI::createCtrlAction.
 158     */
 159   virtual void destroyCtrlAction() { };
 160
 161   /**
 162     * Let an engine play as player @a side.
 163     * @return a token which uniquely identifies the engine entity
 164     *         and can be used to remove it from the entity list.
 165     */
 166   virtual EntityToken addPlayingEngine(int /*side*/, const boost::shared_ptr<Engine>&) { return EntityToken(); }
 167
 168   /**
 169     * Remove an entity from the controller list.
 170     */
 171   virtual void removeEntity(const EntityToken&) { }
 172 };
 173
 174
 175 #endif