openingsuite.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 OPENINGSUITE_H
#define OPENINGSUITE_H

#include <QVector>
#include "pgngame.h"
class QString;
class QFile;
class QTextStream;
class PgnStream;

class LIB_EXPORT OpeningSuite
{
    public:
        enum Format
        {
            EpdFormat,  
            PgnFormat   
        };

        enum Order
        {
            SequentialOrder,    
            RandomOrder     
        };

        OpeningSuite(const QString& fen);
        OpeningSuite(const QString& fileName,
                 Format format,
                 Order order = SequentialOrder,
                 int startIndex = 0);
        ~OpeningSuite();

        Format format() const;
        Order order() const;
        bool isNull() const;

        bool initialize();
        PgnGame nextGame(int maxPlies);

    private:
        struct FilePosition
        {
            qint64 pos;
            qint64 lineNumber;
        };

        FilePosition getPgnPos();
        FilePosition getEpdPos();

        Format m_format;
        Order m_order;
        int m_gamesRead;
        int m_gameIndex;
        int m_startIndex;
        QString m_fileName;
        QString m_fen;
        QFile* m_file;
        QTextStream* m_epdStream;
        PgnStream* m_pgnStream;
        QVector<FilePosition> m_filePositions;
};

#endif // OPENINGSUITE_H