src/core/state.h

   1 /*
   2   Copyright (c) 2007 Paolo Capriotti <p.capriotti@gmail.com>
   3             (c) 2007 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 CORE__STATE_H
  12 #define CORE__STATE_H
  13
  14 #include "taguaobject.h"
  15
  16 class Board;
  17 class IColor;
  18 class Move;
  19
  20 /**
  21   * @brief The state of the game in a given moment of time.
  22   *
  23   * A State component encapsulates the global state of the game, i.e.
  24   * what pieces are on the board or on the pool, and game flags like
  25   * the en-passant square for chess.
  26   *
  27   * A State component also provides methods to setup the initial
  28   * configuration and to make a move.
  29   */
  30 class TAGUA_EXPORT IState {
  31 public:
  32   virtual ~IState();
  33
  34   virtual IState* clone() const = 0;
  35
  36   /**
  37     * Setup the initial configuration of pieces and reset all flags.
  38     */
  39   virtual void setup() = 0;
  40
  41   /**
  42     * @return The piece board.
  43     */
  44   virtual const Board* board() const = 0;
  45   virtual Board* board() = 0;
  46
  47   /**
  48     * @return The player who plays next.
  49     */
  50   virtual const IColor* turn() const = 0;
  51
  52   /**
  53     * Change the current turn.
  54     */
  55   virtual void setTurn(const IColor* turn) = 0;
  56
  57   /**
  58     * @return Whether two states are equal.
  59     */
  60   virtual bool equals(IState* other) const = 0;
  61
  62   /**
  63     * Make this state equal to the given one.
  64     */
  65   virtual void assign(const IState* other) = 0;
  66
  67   /**
  68     * Play a move.
  69     */
  70   virtual void move(const Move& move) = 0;
  71
  72   /**
  73     * @return Current flags.
  74     */
  75   virtual TaguaObject flags() const = 0;
  76
  77   /**
  78     * @return The opponent of @a color.
  79     */
  80   virtual const IColor* opponent(const IColor* color) const = 0;
  81
  82   /**
  83     * Set next turn as the current turn.
  84     */
  85   virtual void advanceTurn() = 0;
  86 };
  87
  88 #endif // CORE__STATE_H