src/engine.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 ENGINE_H
  12 #define ENGINE_H
  13
  14 #include <KProcess>
  15
  16 #include <boost/weak_ptr.hpp>
  17 #include <queue>
  18 #include <core/state_fwd.h>
  19 #include "console.h"
  20
  21 class Move;
  22 class EngineNotifier;
  23
  24 /**
  25   * @brief An external chess engine.
  26   *
  27   * This class incapsulates a connection with
  28   * an external engine process in a protocol
  29   * independent way.
  30   */
  31 class Engine : public QObject, public TextNotifier {
  32 Q_OBJECT
  33 protected:
  34   QString m_path;
  35   QStringList m_arguments;
  36   KProcess m_engine;
  37   QString m_workPath;
  38   boost::shared_ptr<Console> m_console;
  39   boost::weak_ptr<EngineNotifier> m_notifier;
  40   std::queue<QString> m_command_queue;
  41   int m_side;
  42
  43   virtual void initializeEngine() = 0;
  44 public:
  45   /**
  46     * Create an engine, setting the path to the engine
  47     * program and its arguments.
  48     */
  49   Engine(const QString& path, const QStringList& arguments);
  50
  51   void setWorkingPath(const QString& workPath) { m_workPath = workPath; }
  52   void setSide(int side) { m_side = side; }
  53
  54   virtual ~Engine();
  55
  56   /**
  57     * Start the engine program. The initialization will
  58     * take place automatically after the program has started.
  59     */
  60   void start();
  61
  62   /**
  63     * Send a command to the engine.
  64     */
  65   void sendCommand(const QString& command, bool echo = true);
  66
  67   /**
  68     * Send a move to the engine.
  69     */
  70   virtual void sendMove(const Move& move, const StatePtr& ref) = 0;
  71
  72   /**
  73     * Back up a move.
  74     * @param pos The position before the move. Used if the engine
  75     *            does not support the undo command.
  76     */
  77   virtual void backUp(const StatePtr& pos) = 0;
  78
  79   virtual void setBoard(const StatePtr& pos) = 0;
  80
  81   virtual void startAnalysis() = 0;
  82   virtual void stopAnalysis() = 0;
  83
  84   /**
  85     * Begin a new game.
  86     */
  87   virtual void reset() = 0;
  88
  89   /**
  90     * Start playing.
  91     */
  92   virtual void play() = 0;
  93
  94   /**
  95     * Stop the engine.
  96     */
  97   virtual void stop() = 0;
  98
  99   /**
 100     * Receive a user command.
 101     */
 102   virtual void textNotify(const QString& text);
 103
 104   void setNotifier(const boost::shared_ptr<EngineNotifier>& notifier);
 105   void setConsole(const boost::shared_ptr<Console>& console);
 106 private Q_SLOTS:
 107   void engineRunning();
 108   void processInput();
 109
 110 Q_SIGNALS:
 111
 112   /**
 113     * Emitted when the engine sends a command to the interface.
 114     */
 115   void receivedCommand(const QString& command);
 116
 117   /**
 118     * Emitted when the engine exits (or crashes, etc...).
 119     */
 120   void lostConnection();
 121 };
 122
 123 #endif // ENGINE_H