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>
  16 #include <core/state_fwd.h>
  17 #include "common.h"
  18 #include "entitytoken.h"
  19
  20 class ActionCollection;
  21 class ChessTable;
  22 class Engine;
  23 class IColor;
  24 class PGN;
  25 class UI;
  26 class UserEntity;
  27
  28 /**
  29   * @b Controller is the base abstract class for all controllers in Tagua.
  30   * Tagua can be used in different modes, such as game editing or position editing.
  31   * Each mode corresponds to a concrete subclass of Controller, and defines its behaviour
  32   * in response to user events (history navigation, move executions...).
  33   * By default, events are routed to the user entity returned by the virtual function
  34   * entity.
  35   */
  36 class Controller : public boost::enable_shared_from_this<Controller> {
  37 protected:
  38   ChessTable* m_view;
  39   virtual boost::shared_ptr<UserEntity> entity() const = 0;
  40 public:
  41   Controller(ChessTable* view);
  42   virtual ~Controller();
  43
  44   /**
  45     * Variant specific actions.
  46     */
  47   virtual ActionCollection* variantActions() const = 0;
  48
  49   /**
  50     * Variant associated to the controller.
  51     */
  52   virtual QString variant() const = 0;
  53
  54   /**
  55     * Terminate activity, create another controller and delegate everything to it.
  56     * @return The delegate controller, or simply @b this if controller does not need
  57     * to be terminated.
  58     */
  59   virtual boost::shared_ptr<Controller> end() { return shared_from_this(); }
  60
  61   /**
  62     * Detach from resources without disposing them.
  63     */
  64   virtual void detach() { }
  65
  66   /**
  67     * Clear board. Undefined for almost all controllers.
  68     * @return Whether the action has been successfully executed.
  69     */
  70   virtual bool clearBoard() { return false; }
  71
  72   /**
  73     * Set starting position on the board. Undefined for almost all controllers.
  74     * @return Whether the action has been successfully executed.
  75     */
  76   virtual bool setStartingPosition() { return false; }
  77
  78   /**
  79     * Set a position on the board. Undefined for almost all controllers.
  80     * @param fen The position to be set, in FEN notation.
  81     * @return Whether the action has been successfully executed.
  82     */
  83   virtual bool setFEN(const QString&) { return false; }
  84
  85   /**
  86     * Get a FEN string representing the current position on the board.
  87     */
  88   virtual QString fen() { return ""; }
  89
  90   /**
  91     * @return current position, or a null shared_ptr if no current position
  92     * concept is defined for this controller.
  93     */
  94   virtual StatePtr currentPosition() const { return StatePtr(); }
  95
  96   /**
  97     * Change turn. Used for example in edit position mode.
  98     */
  99   virtual void setTurn(int) { }
 100
 101   /**
 102     * Forward a movelist undo call.
 103     */
 104   virtual bool undo();
 105
 106   /**
 107     * Forward a movelist redo call.
 108     */
 109   virtual bool redo();
 110
 111   /**
 112     * Forward a movelist truncate call.
 113     */
 114   virtual bool truncate();
 115
 116   /**
 117     * Forward a movelist promote variation call.
 118     */
 119   virtual bool promoteVariation();
 120
 121   /**
 122    * Navigate back in history.
 123    */
 124   virtual bool back();
 125
 126   /**
 127    * Navigate forward in history.
 128    */
 129   virtual bool forward();
 130
 131   /**
 132    * Warp to the beginning of the history.
 133    */
 134   virtual void gotoFirst();
 135
 136   /**
 137    * Warp to the end of the history.
 138    */
 139   virtual void gotoLast();
 140
 141   /**
 142     * Save game.
 143     */
 144   virtual QString save();
 145
 146   /**
 147     * Load game from a PGN.
 148     */
 149   virtual void loadPGN(const PGN&);
 150
 151   /**
 152     * Create a CTRL Action.
 153     * @sa UI::createCtrlAction
 154     */
 155   virtual void createCtrlAction() { }
 156
 157   /**
 158     * Destroy a CTRL Action.
 159     * @sa UI::createCtrlAction.
 160     */
 161   virtual void destroyCtrlAction() { };
 162
 163   /**
 164     * Let an engine play as player @a side.
 165     * @return a token which uniquely identifies the engine entity
 166     *         and can be used to remove it from the entity list.
 167     */
 168   virtual EntityToken addPlayingEngine(const IColor* /*side*/,
 169       const boost::shared_ptr<Engine>&) { return EntityToken(); }
 170
 171   /**
 172     * Remove an entity from the controller list.
 173     */
 174   virtual void removeEntity(const EntityToken&) { }
 175
 176   virtual void reloadSettings() = 0;
 177
 178   /**
 179     * Set owning user interface.
 180     * Used to setup callbacks towards the main window, like action state
 181     * change notifications.
 182     */
 183   virtual void setUI(UI& ui) = 0;
 184
 185   /**
 186     * Called whenever a controller becomes active in the main window.
 187     */
 188   virtual void activate() = 0;
 189 };
 190
 191
 192 #endif