loic/pgnp
1
0
Fork 0
mirror of https://gitlab.com/manzerbredes/pgnp.git synced 2025-04-06 10:06:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Loic Guegan 2022-01-26 21:31:40 +01:00
parent bd98bcb931
commit 92350c7cc9
1 changed files with 10 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -8,8 +8,8 @@ PGN specification can be found [here](https://www.chessclub.com/help/PGN-spec).
# Features # Features
- Basic PGN parsing (tags, move, comments, variations, NAG, etc.) - Basic PGN parsing (tags, move, comments, variations, NAG, etc.)
- Merged PGN files parsing (several games in one file) - Parse PGN files that contains multiple games
- Handle very large file (max is 2^(sizeof(unsigned long long)*8) bytes) - Handle very large files: up to 2^(sizeof(unsigned long long)*8) bytes
- Efficiency - Efficiency
# How to use it ? # How to use it ?
@ -21,21 +21,11 @@ executable.
Somewhere at the beginning of the file: Somewhere at the beginning of the file:
#include "pgnp.hpp" #include "pgnp.hpp"
Load PGN from file: Load PGN from file/string:
pgnp::PGN pgn; pgnp::PGN pgn;
try { try {
pgn.FromFile("pgn.txt"); pgn.FromFile("pgn.txt"); // Or pgn.FromString("YOUR PGN CONTENT HERE");
pgn.ParseNextGame();
}
catch(...){
// Handle exceptions
}
Load PGN from string:
pgnp::PGN pgn;
pgn.FromString("YOUR PGN CONTENT HERE");
try {
pgn.ParseNextGame(); pgn.ParseNextGame();
} }
catch(...){ catch(...){
@ -43,27 +33,27 @@ Load PGN from string:
} }
Various API calls: Various API calls:
bool hasRound=pgn.HasTag("Round"); // Check if tag exists bool hasRound=pgn.HasTag("Round"); // Check if a tag exists
try { try {
pgn.STRCheck(); // Perform a Seven Tag Roster check pgn.STRCheck(); // Perform a Seven Tag Roster check
} }
catch(...){ catch(...){
// Handle exceptions // Handle exceptions
} }
std::vector<std::string> tags=pgn.GetTagList(); // Get a list of tags std::vector<std::string> tags=pgn.GetTagList(); // Get the list of tags in current game
std::string tagValue=GetTagValue("Date"); // Get the value of a tag std::string tagValue=GetTagValue("Date"); // Get the value of a tag in current game
Access to moves: Access to moves:
pgnp::HalfMove *moves=new pgnp::HalfMove(); pgnp::HalfMove *moves=new pgnp::HalfMove();
pgn.GetMoves(moves); // Get the tree of half moves (do not forget to call "delete move" later on) pgn.GetMoves(moves); // Get the tree of half moves
int length=moves->GetLength(); // Get the number of half moves in the move MainLine int length=moves->GetLength(); // Get the number of half move in the current MainLine
// Public members: // Public members:
// moves->variations contains variations of the current move // moves->variations contains variations of the current move
// moves->isBlack boolean that says if current half move is for the black side // moves->isBlack boolean that says if current half move is for the black side
// Check pgnp.hpp for more infos for the other fields (comments, count, etc.) // Check pgnp.hpp for more infos for the other fields (comments, count, etc.)
# CMake Integration # CMake Integration
By using the `add_subdirectory()` on this repository you will be able to use the following cmake calls in you project: By using the `add_subdirectory()` directive on this repository, you will be able to use the following cmake calls in your project:
include_directories(${PGNP_INCLUDE_DIR}) include_directories(${PGNP_INCLUDE_DIR})
target_link_libraries(<YOUR_TARGET> pgnp) target_link_libraries(<YOUR_TARGET> pgnp)