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