pgnreader.h

Go to the documentation of this file.

// Hoover Chess Utilities / PGN reader
// Copyright (C) 2022-2025  Sami Kiminki
//
// This program 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.
//
// This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef HOOVER_CHESS_UTILS__PGN_READER__PGNREADER_H_INCLUDED
#define HOOVER_CHESS_UTILS__PGN_READER__PGNREADER_H_INCLUDED
 
#include "chessboard.h"
#include "pgnreader-error.h"
#include "pgnreader-types.h"
 
#include <cstddef>
#include <cstdint>
#include <format>
#include <string_view>
 
namespace hoover_chess_utils::pgn_reader
{
 
class ChessBoard;
 
 
enum class PgnReaderOnErrorAction
{
    Abort,
 
    ContinueFromNextGame,
 
};
 
struct PgnErrorInfo
{
    std::uint64_t lineNumber;
};
 
class PgnReaderActions
{
public:
    virtual void gameStart()
    {
    }
 
    virtual void pgnTag(std::string_view key, std::string_view value)
    {
        static_cast<void>(key);
        static_cast<void>(value);
    }
 
    virtual void moveTextSection() { }
 
    virtual void comment(std::string_view comment)
    {
        static_cast<void>(comment);
    }
 
    virtual void gameTerminated(PgnResult result)
    {
        static_cast<void>(result);
    }
 
    virtual void setBoardReferences(const ChessBoard &curBoard, const ChessBoard &prevBoard)
    {
        static_cast<void>(curBoard);
        static_cast<void>(prevBoard);
    }
 
    virtual void afterMove(Move move)
    {
        static_cast<void>(move);
    }
 
    virtual void nag(std::uint8_t nagNum)
    {
        static_cast<void>(nagNum);
    }
 
    virtual void variationStart()
    {
    }
 
    virtual void variationEnd()
    {
    }
 
    virtual void endOfPGN()
    {
    }
 
    virtual PgnReaderOnErrorAction onError(const PgnError &error, const PgnErrorInfo &additionalInfo)
    {
        static_cast<void>(error);
        static_cast<void>(additionalInfo);
 
        return PgnReaderOnErrorAction::Abort;
    }
};
 
enum class PgnReaderActionClass : unsigned int
{
    PgnTag = 0U,
 
    Move,
 
    NAG,
 
    Variation,
 
    Comment,
};
 
class PgnReaderActionFilter
{
private:
    std::uint32_t m_filterBits { };
 
    static constexpr std::uint32_t actionBit(PgnReaderActionClass action) noexcept
    {
        const unsigned int shift { static_cast<unsigned int>(action) };
        if (shift < 32U) [[likely]]
        {
            return UINT32_C(1) << shift;
        }
        else [[unlikely]]
        {
            return 0U;
        }
    }
 
    constexpr void enablePack() noexcept
    {
    }
 
    template <typename... Args>
    constexpr void enablePack(PgnReaderActionClass action, Args... rest) noexcept
    {
        set(action, true);
        enablePack(rest...);
    }
 
public:
    template <typename... Args>
    constexpr PgnReaderActionFilter(Args... enabled) noexcept
    {
        enablePack(enabled...);
    }
 
    constexpr inline void set(PgnReaderActionClass action, bool enable) noexcept
    {
        const std::uint32_t mask { actionBit(action) };
 
        if (enable)
            m_filterBits |= mask;
        else
            m_filterBits &= ~mask;
    }
 
    constexpr inline bool isEnabled(PgnReaderActionClass action) noexcept
    {
        return (m_filterBits & actionBit(action)) != 0U;
    }
 
    constexpr inline std::uint32_t getBitMask() noexcept
    {
        return m_filterBits;
    }
};
 
class PgnReader
{
public:
    static void readFromMemory(std::string_view pgn, PgnReaderActions &actions, PgnReaderActionFilter filter);
};
 
 
}
 
#endif