src/entities/userentity.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 USERENTITY_H
  12 #define USERENTITY_H
  13
  14 #ifndef GAMEBASEDRULES_H
  15 #define GAMEBASEDRULES_H
  16
  17 #include "entity.h"
  18 #include "fwd.h"
  19 #include "kboard.h"
  20 #include "usermove.h"
  21 #include "agent.h"
  22
  23 class PGN;
  24
  25 class TurnTest {
  26 public:
  27   virtual ~TurnTest() { }
  28   virtual bool operator()(int turn) const = 0;
  29 };
  30
  31 class FreeTurnTest : public TurnTest {
  32 public:
  33   virtual bool operator()(int) const { return true; }
  34 };
  35
  36 class NoTurnTest : public TurnTest {
  37 public:
  38   virtual bool operator()(int) const { return false; }
  39 };
  40
  41 class OneTurnTest : public TurnTest {
  42   int m_turn;
  43 public:
  44   OneTurnTest(int turn)
  45   : m_turn(turn) { }
  46   virtual bool operator()(int turn) const {
  47     return turn == m_turn;
  48   }
  49 };
  50
  51 class UserEntity : public Entity
  52                  , public Agent {
  53 protected:
  54   boost::shared_ptr<TurnTest> m_turn_test;
  55   bool m_editing_tools;
  56   int m_promotion;
  57 public:
  58   UserEntity(const GamePtr& game, int);
  59   virtual void setTurnTest(const boost::shared_ptr<TurnTest>& test) { m_turn_test = test; }
  60   virtual void enableEditingTools(bool value);
  61
  62   // promotion
  63   void changePromotionType(int type) { m_promotion = type; }
  64   void setPromotion(NormalUserMove& move) { move.promotionType = m_promotion; }
  65   int promotionType() const { return m_promotion; }
  66
  67   /**
  68     * Return a PGN for the game.
  69     */
  70   virtual QString save() const = 0;
  71
  72   /**
  73     * Load the content of a PGN inside the game.
  74     */
  75   virtual void loadPGN(const PGN& pgn) = 0;
  76
  77   virtual AbstractMove::Ptr testMove(const NormalUserMove& m) const = 0;
  78   virtual AbstractMove::Ptr testMove(const DropUserMove& m) const = 0;
  79   virtual bool testPremove(const NormalUserMove& m) const = 0;
  80   virtual bool testPremove(const DropUserMove&) const = 0;
  81   virtual void executeMove(AbstractMove::Ptr move) = 0;
  82   virtual void addPremove(const NormalUserMove& m) = 0;
  83   virtual void addPremove(const DropUserMove& m) = 0;
  84   virtual void cancelPremove() = 0;
  85   virtual void handleRightClick(const Point&) const;
  86
  87   virtual InteractionType validTurn(const Point&) const = 0;
  88   virtual InteractionType validTurn(int) const = 0;
  89   virtual bool movable(const Point&) const = 0;
  90   virtual bool oneClickMoves() const { return false; }
  91
  92   /**
  93     * Jump to the end of the game.
  94     */
  95   virtual bool gotoFirst() = 0;
  96
  97   /**
  98     * Jump to the beginning of the game.
  99     */
 100   virtual bool gotoLast() = 0;
 101
 102   /**
 103     * Jump to an arbitrary index.
 104     */
 105   virtual bool goTo(const Index& index) = 0;
 106
 107   /**
 108     * Go forward one move in the game.
 109     */
 110   virtual bool forward() = 0;
 111
 112   /**
 113     * Go back one move in the game.
 114     */
 115   virtual bool back() = 0;
 116
 117   /**
 118     * Undo the last editing action.
 119     */
 120   virtual bool undo() = 0;
 121
 122   /**
 123     * Redo the last editing action.
 124     */
 125   virtual bool redo() = 0;
 126
 127   /**
 128     * Remove the current position.
 129     */
 130   virtual bool truncate() = 0;
 131
 132   /**
 133     * Promote the current variation to mainline.
 134     */
 135   virtual bool promoteVariation() = 0;
 136
 137   /**
 138     * Move hint.
 139     * @sa AbstractPosition::moveHint
 140     */
 141   virtual AbstractPiece::Ptr moveHint(AbstractMove::Ptr) const { return AbstractPiece::Ptr(); }
 142
 143   virtual bool canDetach() const;
 144 };
 145
 146
 147 #endif // GAMEBASEDRULES_H
 148
 149
 150 #endif // USERENTITY_H