src/kboard.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 LOWLEVEL_H
  12 #define LOWLEVEL_H
  13
  14
  15 class GraphicalAPI;
  16
  17
  18 /**
  19   * @file kboard.h
  20   * @brief Low level abstract classes used by the interface framework.
  21   *
  22   * This file includes definitions for abstract classes used from within
  23   * the interface framework to access variant details using dynamic time
  24   * polymorphism.
  25   *
  26   * One of the big problems with this approach is what I call 'lack of
  27   * functional dependency support' for runtime polymorphism.
  28   * What is missing is the ability to override a virtual member function
  29   * in a derived class changing its signature. Or better, it is possible
  30   * to only change its return type with a covariant type, while it would
  31   * often be useful to change any of its argument types with covariant or
  32   * even controvariant types.
  33   * For controvariant types, I foresee no problems, and all type checking
  34   * can be done statically (of course the method has to be dynamically
  35   * bound) as they are now.
  36   * When using covariant types, the compiler could insert appropriate
  37   * dynamic cast's and type checks in the calling code, when there's no
  38   * way to know the exact type of an argument at compile time.
  39   *
  40   * The file @ref kboard_wrapped.h tries to address this problem doing part
  41   * of the compiler's work. One exception is that type checking code
  42   * is inserted in a method wrapper, instead of the calling place, so
  43   * even calling a method of a noncasted instance would cause some
  44   * upcast / downcast overhead; this is negligible, though, because
  45   * that scenario is rather unlikely, since wrapped classes are always
  46   * kept in variables of abstract types.
  47   */
  48
  49 #include <map>
  50 #include <boost/shared_ptr.hpp>
  51 #include <QString>
  52 #include <QStringList>
  53 #include "point.h"
  54 #include "usermove.h"
  55 #include "index.h"
  56 #include "option.h"
  57 #include "decoratedmove.h"
  58 #include "interactiontype.h"
  59 #include "fwd.h"
  60
  61
  62 /**
  63   * @brief A superclass for all the piece classes.
  64   */
  65 class AbstractPiece {
  66 public:
  67   typedef boost::shared_ptr<AbstractPiece> Ptr;
  68   virtual ~AbstractPiece() { }
  69
  70   /**
  71     * Piece equality. Return false if the second pointer
  72     * is null.
  73     */
  74   virtual bool equals(AbstractPiece::Ptr other) const = 0;
  75
  76   /**
  77     * Return a unique key for the piece.
  78     * Used to store pixmaps.
  79     */
  80   virtual QString name() const = 0;
  81
  82   /**
  83     * Create a deep copy of the piece.
  84     */
  85   virtual AbstractPiece::Ptr clone() const = 0;
  86 };
  87
  88
  89 /**
  90   * @brief A superclass for all the move classes.
  91   *
  92   * An abstract move is simply something that can serialize
  93   * itself either as SAN notation, or as coordinate notation.
  94   */
  95 class AbstractMove {
  96 public:
  97   typedef boost::shared_ptr<AbstractMove> Ptr;
  98   virtual ~AbstractMove() { }
  99
 100   /**
 101     * Return a compact SAN representation for the move.
 102     */
 103   virtual QString SAN(boost::shared_ptr<AbstractPosition> ref) const = 0;
 104
 105   /**
 106     * Return a decorated representation for the move.
 107     */
 108   virtual DecoratedMove toDecoratedMove(boost::shared_ptr<AbstractPosition> ref) const = 0;
 109
 110   /**
 111     * Return the move in coordinate notation.
 112     */
 113   virtual QString toString(boost::shared_ptr<AbstractPosition> ref) const = 0;
 114
 115   /**
 116     * Convert the move to a normal user move. Used to
 117     * perform move highlighting.
 118     */
 119   virtual NormalUserMove toUserMove() const = 0;
 120
 121   /**
 122     * Checks if the two moves are equal.
 123     */
 124   virtual bool equals(Ptr other) const = 0;
 125
 126 };
 127
 128
 129 /**
 130   * @brief Superclass for pools
 131   *
 132   * A general interface for pools.
 133   */
 134 class AbstractPool {
 135 public:
 136   typedef boost::shared_ptr<AbstractPool> Ptr;
 137   virtual ~AbstractPool() {}
 138
 139   /**
 140     * \return the number of items in the pool
 141     */
 142   virtual int size() = 0;
 143
 144   /**
 145     * Inserts a piece in the pool, preferably at the position \a pref_index.
 146     * But the pool can be unpredictable and the piece can be placed at an arbitrary position.
 147     * \return the position at which the item was placed.
 148     */
 149   virtual int insert(int pref_index, AbstractPiece::Ptr piece) = 0;
 150
 151   /**
 152     * Gets the piece at the position \a index in the pool.
 153     */
 154   virtual AbstractPiece::Ptr get(int index) = 0;
 155
 156   /**
 157     * Removes the piece at the position \a index in the pool.
 158     * \return the removed piece.
 159     */
 160   virtual AbstractPiece::Ptr take(int index) = 0;
 161 };
 162
 163
 164
 165 /**
 166   * @brief A superclass for all the position classes.
 167   *
 168   * A general interface for positions. It is used from within
 169   * the graphical framework to validate external input wrt
 170   * the played variant.
 171   */
 172 class AbstractPosition {
 173 public:
 174   typedef boost::shared_ptr<AbstractPosition> Ptr;
 175   typedef boost::shared_ptr<AbstractPool> PoolPtr;
 176   virtual ~AbstractPosition() { }
 177
 178   /**
 179     * Return board size in logical units. This could be
 180     * static if C++ permitted virtual static functions.
 181     */
 182   virtual Point size() const = 0;
 183
 184   /**
 185     * Returns the text to be used for the border surrounding this position in a board
 186     */
 187   virtual QStringList borderCoords() const = 0;
 188
 189   /**
 190     * Create the starting piece setup.
 191     */
 192   virtual void setup() = 0;
 193
 194   /**
 195     * Retrieve the piece on square @a p.
 196     * Return a null pointer if that square is empty.
 197     */
 198   virtual AbstractPiece::Ptr get(const Point& p) const = 0;
 199
 200   /**
 201     * Set a piece on the board.
 202     */
 203   virtual void set(const Point& p, AbstractPiece::Ptr piece) = 0;
 204
 205   /**
 206     * \return an interface to modify the pool of the board relative to \a player
 207     */
 208 //   virtual AbstractPool::Ptr pool(int player) = 0;
 209
 210   /**
 211     * \return 1 if the piece can be moved, -1 if could be moved in the future (premove), or else 0.
 212     */
 213   virtual InteractionType movable(const Point& p) const = 0;
 214
 215   /**
 216     * \return 1 if this pool can be dropped, -1 if could be dropped in the future (premove), or else 0.
 217     */
 218   virtual InteractionType droppable(int) const = 0;
 219
 220   /**
 221     * \return an id corresponding to the player
 222     * who is in turn.
 223     */
 224   virtual int turn() const = 0;
 225
 226   /**
 227     * Sets the player on move
 228     */
 229   virtual void setTurn(int) = 0;
 230
 231   /**
 232     * \return the player that just moved
 233     */
 234   virtual int previousTurn() const = 0;
 235
 236   /**
 237     * Switch to the next player.
 238     */
 239   virtual void switchTurn() = 0;
 240
 241   /**
 242     * Check move legality. Set move fields as needed.
 243     * Return whether the move is legal.
 244     * This function should return immediately if \a m
 245     * has already been tested.
 246     */
 247   virtual bool testMove(AbstractMove::Ptr m) const = 0;
 248
 249   /**
 250     * Execute move \a m. Assume that \a m is legal and tested.
 251     */
 252   virtual void move(AbstractMove::Ptr m) = 0;
 253
 254   /**
 255     * Create a deep copy of the position.
 256     */
 257   virtual AbstractPosition::Ptr clone() const = 0;
 258
 259   /**
 260     * Make the position equal to the given one.
 261     */
 262   virtual void copyFrom(const AbstractPosition::Ptr&) = 0;
 263
 264   /**
 265     * Tests if two positions are equal.
 266     */
 267   virtual bool equals(AbstractPosition::Ptr p) const = 0;
 268
 269   /**
 270     * Return a move from an algebraic notation, or a null pointer.
 271     */
 272   virtual AbstractMove::Ptr getMove(const class AlgebraicNotation&) const = 0;
 273
 274   /**
 275     * Return a move from an algebraic notation, or a null pointer.
 276     */
 277   virtual AbstractMove::Ptr getMove(const QString&) const = 0;
 278
 279   /**
 280     * Return a string representing the current state of the position.
 281     */
 282   virtual QString state() const = 0;
 283
 284   /**
 285     * Return a FEN representation for the position, assuming
 286     * @a halfmove as halfmove clock and @a fullmove as full move
 287     * number.
 288     */
 289   virtual QString fen(int halfmove, int fullmove) const = 0;
 290
 291   /**
 292     * A piece somehow representing or related to the move
 293     * which has to be drawn by the interface.
 294     * Examples:
 295     * * for one click moves, the piece that would
 296     *    appear on the square.
 297     * * for promotions in chesslike variants, the promoted
 298     *   piece.
 299     * @note Return a null pointer if the move has no valid
 300     *       piece hint defined.
 301     */
 302   virtual AbstractPiece::Ptr moveHint(AbstractMove::Ptr) const = 0;
 303
 304   /**
 305     * Variant introspection
 306     */
 307   virtual QString variant() const = 0;
 308
 309   /**
 310     * For debugging
 311     */
 312   virtual void dump() const = 0;
 313 };
 314
 315 class AnimationGroup;
 316
 317 /**
 318   * @brief An abstract superclass for all animator classes.
 319   *
 320   * An animator is a class which is given a difference between
 321   * a graphical and a logical position, and schedules an animation
 322   * which graphically does an update.
 323   * If the difference is due to a move, the animator tries to
 324   * create a smooth animation which could possibly work for many
 325   * chess-like variants, and then fills in the gaps with a direct
 326   * update.
 327   */
 328 class AbstractAnimator {
 329 public:
 330   typedef boost::shared_ptr<AbstractAnimator> Ptr;
 331   virtual ~AbstractAnimator() { }
 332
 333   /**
 334     * Sync the graphical position with the given position.
 335     */
 336   virtual AnimationPtr warp(AbstractPosition::Ptr) = 0;
 337
 338   /**
 339     * Animate forward syncing to the given position.
 340     */
 341   virtual AnimationPtr forward(AbstractPosition::Ptr, AbstractMove::Ptr) = 0;
 342
 343   /**
 344     * Animate back syncing to the given position.
 345     */
 346   virtual AnimationPtr back(AbstractPosition::Ptr, AbstractMove::Ptr) = 0;
 347 };
 348
 349
 350 class VariantInfo {
 351 public:
 352   virtual ~VariantInfo() { }
 353   virtual AbstractPosition::Ptr createPosition() = 0;
 354   virtual AbstractPosition::Ptr createCustomPosition(const OptList& l) = 0;
 355   virtual AbstractPosition::Ptr createPositionFromFEN(const QString& fen) = 0;
 356   virtual AbstractPosition::Ptr createChessboard(int turn, bool, bool, bool, bool, const Point&) = 0;
 357   virtual void forallPieces(class PieceFunction&) = 0;
 358   virtual int moveListLayout() const = 0;
 359   virtual AbstractAnimator::Ptr createAnimator(GraphicalAPI* graphical_api) = 0;
 360   virtual AbstractMove::Ptr createNormalMove(const NormalUserMove&) = 0;
 361   virtual AbstractMove::Ptr createDropMove(const DropUserMove&) = 0;
 362   virtual AbstractMove::Ptr getVerboseMove(int turn, const class VerboseNotation&) const = 0;
 363
 364   /**
 365     * \return if moves are done by just clicking
 366     */
 367   virtual bool simpleMoves() = 0;
 368
 369   /**
 370     * \return the name of the variant
 371     */
 372   virtual QString name() const = 0;
 373
 374   /**
 375     * \return the name of the theme proxy variant, ie the variant whose theme can be used
 376     * for the current one (for instance crazyhouse can use chess themes).
 377     */
 378   virtual QString themeProxy() const = 0;
 379
 380   /**
 381     * \return the (subvariant) options that can be specified for position creation, such as board size, etc
 382     */
 383   virtual OptList positionOptions() const = 0;
 384 };
 385
 386 #endif // LOWLEVEL_H