pgngame.h

/*
    This file is part of Cute Chess.

    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 PGNGAME_H
#define PGNGAME_H

#include <QMap>
#include <QString>
#include <QVector>
#include <QList>
#include <QPair>
#include <QDate>
#include <climits>
#include "board/genericmove.h"
#include "board/result.h"
class QTextStream;
class PgnStream;
class EcoNode;
class QObject;
namespace Chess { class Board; }


class LIB_EXPORT PgnGame
{
    public:
        enum PgnMode
        {
            Minimal,
            Verbose
        };

        struct MoveData
        {
            quint64 key;
            Chess::GenericMove move;
            QString moveString;
            QString comment;
        };

        PgnGame();
        bool isNull() const;
        void clear();

        QList< QPair<QString, QString> > tags() const;
        const QVector<MoveData>& moves() const;
        void addMove(const MoveData& data, bool addEco = true);
        void setMove(int ply, const MoveData& data);

        Chess::Board* createBoard() const;

        bool read(PgnStream& in, int maxMoves = INT_MAX - 1,
                  bool addEco = true);
        bool write(QTextStream& out, PgnMode mode = Verbose) const;
        bool write(const QString& filename, PgnMode mode = Verbose) const;
        
        bool isStandard() const;
        QString tagValue(const QString& tag) const;
        QString event() const;
        QString site() const;
        QDate date() const;
        int round() const;
        QString playerName(Chess::Side side) const;
        Chess::Result result() const;
        QString variant() const;
        Chess::Side startingSide() const;
        QString startingFenString() const;

        void setTag(const QString& tag, const QString& value);
        void setEvent(const QString& event);
        void setSite(const QString& site);
        void setDate(const QDate& date);
        void setRound(int round);
        void setPlayerName(Chess::Side side, const QString& name);
        void setResult(const Chess::Result& result);
        void setVariant(const QString& variant);
        void setStartingSide(Chess::Side side);
        void setStartingFenString(Chess::Side side, const QString& fen);
        void setResultDescription(const QString& description);

        void setTagReceiver(QObject* receiver);
        void setGameStartTime(const QDateTime& dateTime);
        void setGameEndTime(const QDateTime& dateTime);

        QMap<int, int> extractScores() const;

    private:
        bool parseMove(PgnStream& in, bool addEco);
        
        Chess::Side m_startingSide;
        const EcoNode* m_eco;
        QMap<QString, QString> m_tags;
        QVector<MoveData> m_moves;
        QObject* m_tagReceiver;
        QString m_initialComment;
        static QString timeStamp(const QDateTime& dateTime);
        QDateTime m_gameStartTime;
};

extern LIB_EXPORT PgnStream& operator>>(PgnStream& in, PgnGame& game);

extern LIB_EXPORT QTextStream& operator<<(QTextStream& out, const PgnGame& game);

#endif // PGNGAME_H