src/entities/userentity.h

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@gmail.com>
   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 <core/interactiontype.h>
  18 #include <core/move.h>
  19 #include <core/piece.h>
  20 #include <core/turnpolicy.h>
  21
  22 #include "entity.h"
  23 #include "agent.h"
  24
  25 class PGN;
  26
  27 class UserEntity : public Entity
  28                  , public Agent {
  29 protected:
  30   TurnPolicy::Collection m_turn_test;
  31   bool m_editing_tools;
  32 public:
  33   UserEntity(const GamePtr& game);
  34   virtual TurnPolicy::Collection& turnTest() { return m_turn_test; }
  35   virtual void enableEditingTools(bool value);
  36
  37   /**
  38     * Return a PGN for the game.
  39     */
  40   virtual QString save() const = 0;
  41
  42   /**
  43     * Load the content of a PGN inside the game.
  44     */
  45   virtual void loadPGN(const PGN& pgn) = 0;
  46
  47   virtual bool testMove(Move& m) const = 0;
  48
  49   virtual bool testPremove(const Move& m) const = 0;
  50   virtual void executeMove(const Move& move) = 0;
  51   virtual void addPremove(const Move& m) = 0;
  52   virtual void cancelPremove() = 0;
  53   virtual void handleRightClick(const Point&) const;
  54
  55   virtual InteractionType validTurn(const Point&) const = 0;
  56   virtual InteractionType validTurn(const IColor*) const = 0;
  57   virtual bool movable(const Point&) const = 0;
  58   virtual bool oneClickMoves() const { return false; }
  59
  60   /**
  61     * Jump to the end of the game.
  62     */
  63   virtual bool gotoFirst() = 0;
  64
  65   /**
  66     * Jump to the beginning of the game.
  67     */
  68   virtual bool gotoLast() = 0;
  69
  70   /**
  71     * Jump to an arbitrary index.
  72     */
  73   virtual bool goTo(const Index& index) = 0;
  74
  75   /**
  76     * Go forward one move in the game.
  77     */
  78   virtual bool forward() = 0;
  79
  80   /**
  81     * Go back one move in the game.
  82     */
  83   virtual bool back() = 0;
  84
  85   /**
  86     * Undo the last editing action.
  87     */
  88   virtual bool undo() = 0;
  89
  90   /**
  91     * Redo the last editing action.
  92     */
  93   virtual bool redo() = 0;
  94
  95   /**
  96     * Remove the current position.
  97     */
  98   virtual bool truncate() = 0;
  99
 100   /**
 101     * Promote the current variation to mainline.
 102     */
 103   virtual bool promoteVariation() = 0;
 104
 105   /**
 106     * Move hint.
 107     */
 108   virtual Piece moveHint(const Move&) const { return Piece(); }
 109
 110   virtual bool canDetach() const;
 111 };
 112
 113
 114 #endif // GAMEBASEDRULES_H
 115
 116
 117 #endif // USERENTITY_H