Wed, 02 Sep 2026 17:11:56 +0200
improve error reporting in PGN parser - resolves #958
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright 2016 Mike Becker. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * */ #ifndef PGN_H #define PGN_H #include "rules.h" #include <stdio.h> #ifdef __cplusplus extern "C" { #endif enum pgn_error_code { pgn_no_error = 0, pgn_error_missing_quote, pgn_error_missing_bracket, pgn_error_missing_brace, pgn_error_missing_dot, pgn_error_result_syntax, pgn_error_result_mismatch, pgn_error_unexpected_eof, pgn_error_move, }; typedef struct { size_t position; enum pgn_error_code code; int move_error; // TODO: should probably also be an enum eventually unsigned move_half_number; } pgn_result; pgn_result read_pgn(FILE *stream, GameState *gamestate); int write_pgn(FILE* stream, const GameState *gamestate, bool export_comments); pgn_result parse_pgn(const char *data, GameState *gamestate); char *create_pgn(const GameState *gamestate, bool export_comments); // TODO: this function looks a bit misplaced const char *pgn_player_name(const GameState *gamestate, Color color); const char* pgn_error_str(int code); #ifdef __cplusplus } #endif #endif /* PGN_H */