pgnstream.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 PGNSTREAM_H
#define PGNSTREAM_H

#include <QtGlobal>
#include <QString>
class QIODevice;
namespace Chess { class Board; }


class LIB_EXPORT PgnStream
{
    public:
        enum Status
        {
            Ok,         
            ReadPastEnd 
        };
        enum TokenType
        {
            NoToken,
            PgnMove,
            PgnMoveNumber,
            PgnTag,
            PgnComment,
            PgnLineComment,
            PgnNag,
            PgnResult,
            Unknown
        };

        explicit PgnStream(const QString& variant = "standard");
        explicit PgnStream(QIODevice* device,
                   const QString& variant = "standard");
        explicit PgnStream(const QByteArray* string,
                   const QString& variant = "standard");

        ~PgnStream();

        Chess::Board* board();

        QIODevice* device() const;
        void setDevice(QIODevice* device);

        const QByteArray* string() const;
        void setString(const QByteArray* string);

        QString variant() const;
        bool setVariant(const QString& variant);

        bool isOpen() const;

        qint64 pos() const;

        qint64 lineNumber() const;

        void reset();

        char readChar();
        void rewindChar();
        void rewind();
        bool seek(qint64 pos, qint64 lineNumber = 1);

        Status status() const;

        bool nextGame();
        TokenType readNext();

        QByteArray tokenString() const;
        TokenType tokenType() const;

        QByteArray tagName() const;
        QByteArray tagValue() const;
    private:
        enum Phase
        {
            OutOfGame,
            InTags,
            InGame
        };

        void parseUntil(const char* chars);
        void parseTag();
        void parseComment(char opBracket);

        Chess::Board* m_board;
        qint64 m_pos;
        qint64 m_lineNumber;
        char m_lastChar;
        QByteArray m_tokenString;
        QByteArray m_tagName;
        QByteArray m_tagValue;
        TokenType m_tokenType;
        QIODevice* m_device;
        const QByteArray* m_string;
        Status m_status;
        Phase m_phase;
};

#endif // PGNSTREAM_H