src/core/pool.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__POOL_H
  12 #define CORE__POOL_H
  13
  14 class Piece;
  15
  16 /**
  17   * @brief A collection of pieces.
  18   *
  19   * A pool is a collection of pieces, typically displayed on the side
  20   * of the board. Some games define special rules for moving pieces
  21   * into and out from the pools.
  22   */
  23 class IPool {
  24 public:
  25   virtual ~IPool();
  26
  27   virtual IPool* clone() const = 0;
  28
  29   /**
  30     * @return Whether two pools are equal, i.e. contain the same pieces.
  31     */
  32   virtual bool equals(const IPool* other) const = 0;
  33
  34   /**
  35     * @return Whether this pool is empty.
  36     */
  37   virtual bool empty() const = 0;
  38
  39   /**
  40     * @return The number of pieces in this pool.
  41     */
  42   virtual int size() const = 0;
  43
  44   /**
  45     * Insert a new piece into the pool.
  46     * Note that @a index is just a hint where the piece is to be
  47     * added, and pool implementations may decide to put the piece
  48     * at a different index.
  49     * @returns The actual index where the newly inserted piece can be found.
  50     */
  51   virtual int insert(int index, const Piece& piece) = 0;
  52
  53   /**
  54     * Retrieve a piece from the pool.
  55     * @param index The index of the piece to retrieve.
  56     */
  57   virtual Piece get(int index) const = 0;
  58
  59   /**
  60     * Delete a piece from the pool.
  61     * @param index The index of the piece to delete.
  62     * @returns The piece removed from the pool by this call.
  63     */
  64   virtual Piece take(int index) = 0;
  65
  66   /**
  67     * Delete a piece from the pool.
  68     * @param piece The piece to delete.
  69     * @returns Whether the specified piece has successfully been deleted.
  70     */
  71   virtual bool take(const Piece& piece) = 0;
  72 };
  73
  74 #endif // CORE__POOL_H