xboardengine.h

/*
    This file is part of Cute Chess.
    Copyright (C) 2008-2018 Cute Chess authors

    Cute Chess is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Cute Chess is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Cute Chess.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef XBOARDENGINE_H
#define XBOARDENGINE_H

#include "chessengine.h"
#include "board/board.h"

using XboardFeature = std::pair<QString, QString>;

class LIB_EXPORT XboardEngine : public ChessEngine
{
    Q_OBJECT

    public:
        XboardEngine(QObject* parent = nullptr);

        // Inherited from ChessEngine
        virtual void endGame(const Chess::Result& result);
        virtual void makeMove(const Chess::Move& move);
        virtual QString protocol() const;

    protected:
        // Inherited from ChessEngine
        virtual bool sendPing();
        virtual void sendStop();
        virtual void sendQuit();
        virtual void startProtocol();
        virtual void startGame();
        virtual void startThinking();
        virtual void parseLine(const QString& line);
        virtual void sendOption(const QString& name, const QVariant& value);
        virtual bool restartsBetweenGames() const;

        QList<XboardFeature> parseFeatures(const QString& featureArgs);

        MoveEvaluation parsePv(const QStringRef& pvString);

        EngineOption* parseOption(const QString& line);

    protected slots:
        // Inherited from ChessEngine
        virtual void onTimeout();

        void initialize();

    private:
        void setFeature(const QString& name, const QString& val);
        void setForceMode(bool enable);
        void sendTimeLeft();
        void finishGame();
        QString moveString(const Chess::Move& move);
        int adaptScore(int score) const;
        const QString transformMove(const QString& str, int height, int shift) const;
        
        bool m_forceMode;
        bool m_drawOnNextMove;
        
        // Engine features
        bool m_ftName;
        bool m_ftPing;
        bool m_ftSetboard;
        bool m_ftTime;
        bool m_ftUsermove;
        bool m_ftReuse;
        bool m_ftNps;
        
        bool m_gotResult;
        int m_lastPing;
        Chess::Move m_nextMove;
        QString m_nextMoveString;
        Chess::Board::MoveNotation m_notation;
        QTimer* m_initTimer;
};

#endif // XBOARDENGINE_H