src/controllers/abstract.h

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@sns.it>
   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   ActionCollection* m_variant_actions;
  38   virtual boost::shared_ptr<UserEntity> entity() const = 0;
  39 public:
  40   Controller(ChessTable* view);
  41   virtual ~Controller();
  42
  43   /**
  44     * Variant specific actions.
  45     */
  46   ActionCollection* variantActions() const;
  47
  48   /**
  49     * Variant associated to the controller.
  50     */
  51   virtual QString variant() const = 0;
  52
  53   /**
  54     * Terminate activity, create another controller and delegate everything to it.
  55     * @return The delegate controller, or simply @b this if controller does not need
  56     * to be terminated.
  57     */
  58   virtual boost::shared_ptr<Controller> end() { return shared_from_this(); }
  59
  60   /**
  61     * Detach from resources without disposing them.
  62     */
  63   virtual void detach() { }
  64
  65   /**
  66     * Clear board. Undefined for almost all controllers.
  67     * @return Whether the action has been successfully executed.
  68     */
  69   virtual bool clearBoard() { return false; }
  70
  71   /**
  72     * Set starting position on the board. Undefined for almost all controllers.
  73     * @return Whether the action has been successfully executed.
  74     */
  75   virtual bool setStartingPosition() { return false; }
  76
  77   /**
  78     * Set a position on the board. Undefined for almost all controllers.
  79     * @param fen The position to be set, in FEN notation.
  80     * @return Whether the action has been successfully executed.
  81     */
  82   virtual bool setFEN(const QString&) { return false; }
  83
  84   /**
  85     * Get a FEN string representing the current position on the board.
  86     */
  87   virtual QString fen() { return ""; }
  88
  89   /**
  90     * @return current position, or a null shared_ptr if no current position
  91     * concept is defined for this controller.
  92     */
  93   virtual PositionPtr currentPosition() const { return PositionPtr(); }
  94
  95   /**
  96     * Change turn. Used for example in edit position mode.
  97     */
  98   virtual void setTurn(int) { }
  99
 100   /**
 101     * Forward a movelist undo call.
 102     */
 103   virtual bool undo();
 104
 105   /**
 106     * Forward a movelist redo call.
 107     */
 108   virtual bool redo();
 109
 110   /**
 111     * Forward a movelist truncate call.
 112     */
 113   virtual bool truncate();
 114
 115   /**
 116     * Forward a movelist promote variation call.
 117     */
 118   virtual bool promoteVariation();
 119
 120   /**
 121    * Navigate back in history.
 122    */
 123   virtual bool back();
 124
 125   /**
 126    * Navigate forward in history.
 127    */
 128   virtual bool forward();
 129
 130   /**
 131    * Warp to the beginning of the history.
 132    */
 133   virtual void gotoFirst();
 134
 135   /**
 136    * Warp to the end of the history.
 137    */
 138   virtual void gotoLast();
 139
 140   /**
 141     * Save game.
 142     */
 143   virtual QString save();
 144
 145   /**
 146     * Load game from a PGN.
 147     */
 148   virtual void loadPGN(const PGN&);
 149
 150   /**
 151     * Create a CTRL Action.
 152     * @sa UI::createCtrlAction
 153     */
 154   virtual void createCtrlAction() { }
 155
 156   /**
 157     * Destroy a CTRL Action.
 158     * @sa UI::createCtrlAction.
 159     */
 160   virtual void destroyCtrlAction() { };
 161
 162   /**
 163     * Let an engine play as player @a side.
 164     * @return a token which uniquely identifies the engine entity
 165     *         and can be used to remove it from the entity list.
 166     */
 167   virtual EntityToken addPlayingEngine(int /*side*/, const boost::shared_ptr<Engine>&) { return EntityToken(); }
 168
 169   /**
 170     * Remove an entity from the controller list.
 171     */
 172   virtual void removeEntity(const EntityToken&) { }
 173 };
 174
 175
 176 #endif