From 78749a6af2c3c5e559b042107f0143c6a5be77b3 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Thu, 28 Aug 2025 10:29:19 -0400 Subject: [PATCH 01/19] dev: Added QS/KS castle checking; simplified moveList pruning --- Piece.cpp | 7 +++---- Piece.hpp | 18 +++++++++++++++--- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/Piece.cpp b/Piece.cpp index f15180a..251e5e9 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -126,10 +126,9 @@ std::vector King::getLegalMoves(const Square &from, const Board &board) co // will this actually work? moveList.erase( std::remove_if(moveList.begin(), moveList.end(), - [&](const Square &x) { - return std::find(x.begin(), x.end(), !x.isValid()) != x.end(); - }), - moveList.end()); + [&](const auto &x) { + return !x.to.isValid(); + })); return moveList; } diff --git a/Piece.hpp b/Piece.hpp index 8d407c8..7f24412 100644 --- a/Piece.hpp +++ b/Piece.hpp @@ -11,6 +11,7 @@ #pragma once #include +#include #include #include #include @@ -34,6 +35,10 @@ enum File { A = 0, B = 1, C = 2, D = 3, E = 4, F = 5, G = 6, H = 7, INVALID_FILE = 255 }; +enum CastleSide { + KINGSIDE = 1, QUEENSIDE = 2 +}; + struct Square { Rank rank; File file; @@ -101,11 +106,18 @@ class King : public Piece { return inCheck; } - bool checkForCastle() const { - return canCastle; + bool checkForCastle(enum CastleSide side) const { + if(side == KINGSIDE) { + return canCastleKS; + } else if(side == QUEENSIDE) { + return canCastleQS; + } else { + return false; + } } protected: - bool canCastle = true; + bool canCastleQS = true; + bool canCastleKS = true; bool inCheck = false; }; From 7722a84b2e9e529b144889ceeb4cc6d879e68b4e Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Thu, 28 Aug 2025 10:41:59 -0400 Subject: [PATCH 02/19] astyle: reformatted all files --- Board.cpp | 152 +++++++++++++++++++++++++-------------------------- Piece.cpp | 48 ++++++++++++---- Piece.hpp | 14 ++--- main.cpp | 2 +- strFuncs.cpp | 3 +- 5 files changed, 120 insertions(+), 99 deletions(-) diff --git a/Board.cpp b/Board.cpp index 32590ad..933dfcc 100644 --- a/Board.cpp +++ b/Board.cpp @@ -31,9 +31,8 @@ Board::Board() { boardGrid.resize(8); - for(int i = 0; i < 8; i++) { + for(int i = 0; i < 8; i++) boardGrid[i].resize(8); - } } Board::~Board() { @@ -92,9 +91,8 @@ void Board::setupInitialPosition() { int setupFromFEN(std::string strFEN) { std::vector splitFEN = split(strFEN, ' '); - if(splitFEN.size() != 6) { // a valid FEN *must* contain 6 fields + if(splitFEN.size() != 6) // a valid FEN *must* contain 6 fields return -1; - } std::vector splitField1 = split(splitFEN[0], '/'); int rank = 0, file = 0; int skip = 0; @@ -108,80 +106,80 @@ int setupFromFEN(std::string strFEN) { continue; } switch(sym) { - case 'R': - // white rook - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - break; - case 'r': - // black rook - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - break; - case 'N': - // white knight - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - break; - case 'n': - // black knight - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - break; - case 'B': - // white bishop - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - break; - case 'b': - // black bishop - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - break; - case 'Q': - // white queen - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - break; - case 'q': - // black queen; - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - break; - case 'K': - // white king - if(wKingPlaced) { - // invalid FEN, more than 1 white king + case 'R': + // white rook + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + break; + case 'r': + // black rook + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + break; + case 'N': + // white knight + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + break; + case 'n': + // black knight + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + break; + case 'B': + // white bishop + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + break; + case 'b': + // black bishop + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + break; + case 'Q': + // white queen + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + break; + case 'q': + // black queen; + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + break; + case 'K': + // white king + if(wKingPlaced) { + // invalid FEN, more than 1 white king + return -1; + } else { + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + wKingPlaced = true; + } + break; + case 'k': + // black king + if(bKingPlaced) { + // invalid FEN, more than 1 black king + return -1; + } else { + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + bKingPlaced = true; + } + break; + case 'P': + // white pawn + boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + break; + case 'p': + // black pawn + boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + break; + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + skip = atoi(sym); + break; + default: + // invalid character? return -1; - } else { - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - wKingPlaced = true; - } - break; - case 'k': - // black king - if(bKingPlaced) { - // invalid FEN, more than 1 black king - return -1; - } else { - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - bKingPlaced = true; - } - break; - case 'P': - // white pawn - boardGrid[rank][file] = std::make_unique(PIECE_WHITE); - break; - case 'p': - // black pawn - boardGrid[rank][file] = std::make_unique(PIECE_BLACK); - break; - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - skip = atoi(sym); - break; - default: - // invalid character? - return -1; } file++; } diff --git a/Piece.cpp b/Piece.cpp index 251e5e9..95ab9f3 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -22,6 +22,28 @@ std::vector Piece::getLegalMoves(const Square &from, const Board &board) c std::vector moveList; return moveList; } +bool King::checkForCheck() const { + std::vector> kingVulnerable = { + {-1, 0}, // Up + {-1, -1}, // up-left + {-1, 1}, // up-right + {1, 0}, // Down + {1, -1}, // down-left + {1, 1}, // down-right + {0, -1}, // Left + {0, 1}, // Right + {-1, -2}, // 1 + {-1, 2}, // 2 + {-2, -1}, // 3 + {-2, 1}, // 4 + {1, -2}, // 5 + {1, 2}, // 6 + {2, -1}, // 7 + {2, 1} // 8 + }; + // locate our King + return inCheck; +} std::vector King::getLegalMoves(const Square &from, const Board &board) const { std::vector moveList; @@ -97,18 +119,20 @@ std::vector King::getLegalMoves(const Square &from, const Board &board) co if(target && (target->getColour() != this->getColour())) { // is it occupied & an enemy? if((target->getPieceType() == QUEEN || target->getPieceType() == BISHOP) && diagonal) { // we are being attacked diagonally on this square, so remove it - moves.to.rank = INVALID_RANK; moves.to.file = INVALID_FILE; - } - else if(target->getPieceType() == KNIGHT && knight) { + moves.to.rank = INVALID_RANK; + moves.to.file = INVALID_FILE; + } else if(target->getPieceType() == KNIGHT && knight) { // we are being attacked by a knight, so remove it - moves.to.rank = INVALID_RANK; moves.to.file = INVALID_FILE; - } - else if(target->getPieceType() == ROOK || target->getPieceType() == QUEEN && (!diagonal && !knight)) { + moves.to.rank = INVALID_RANK; + moves.to.file = INVALID_FILE; + } else if(target->getPieceType() == ROOK || target->getPieceType() == QUEEN && (!diagonal && !knight)) { // again, being attacked, remove it - moves.to.rank = INVALID_RANK; moves.to.file = INVALID_FILE; + moves.to.rank = INVALID_RANK; + moves.to.file = INVALID_FILE; } if(target->getPieceType() == PAWN && (abs(r - startSquare.rank) == 1 && abs(f - startSquare.file) == 1)) { - moves.to.rank = INVALID_RANK; moves.to.file = INVALID_FILE; + moves.to.rank = INVALID_RANK; + moves.to.file = INVALID_FILE; } } if(target && (target->getColour() == this->getColour())) { @@ -125,10 +149,10 @@ std::vector King::getLegalMoves(const Square &from, const Board &board) co } // will this actually work? moveList.erase( - std::remove_if(moveList.begin(), moveList.end(), - [&](const auto &x) { - return !x.to.isValid(); - })); + std::remove_if(moveList.begin(), moveList.end(), + [&](const auto & x) { + return !x.to.isValid(); + })); return moveList; } diff --git a/Piece.hpp b/Piece.hpp index 7f24412..b2cd0cb 100644 --- a/Piece.hpp +++ b/Piece.hpp @@ -92,6 +92,7 @@ class Piece { }; class King : public Piece { + private: friend class Board; public: @@ -102,18 +103,17 @@ class King : public Piece { } virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; - bool checkForCheck() const { - return inCheck; - } + bool checkForCheck() const; bool checkForCastle(enum CastleSide side) const { - if(side == KINGSIDE) { + if(side == KINGSIDE) return canCastleKS; - } else if(side == QUEENSIDE) { + + else if(side == QUEENSIDE) return canCastleQS; - } else { + + else return false; - } } protected: bool canCastleQS = true; diff --git a/main.cpp b/main.cpp index 616443f..ee3b5e1 100644 --- a/main.cpp +++ b/main.cpp @@ -114,7 +114,7 @@ uint8_t initSystem(void) { SDI1R = 0b0100; // RB8 RPA0R = 0b0001; // U1TX SYSKEY = 0x12345678; // lock SYSKEY - ANSELBCLR = 0xFFFF; // port A all digital + ANSELBCLR = 0xFFFF; // port B all digital SL_TRIS = 0; // RA0 as output SL_LAT = 1; // set high /* Set up SPI1 */ diff --git a/strFuncs.cpp b/strFuncs.cpp index 9e09da6..a4a2da3 100644 --- a/strFuncs.cpp +++ b/strFuncs.cpp @@ -4,9 +4,8 @@ template void split(const std::string &s, char delim, Out result) { std::istringstream iss(s); std::string item; - while (std::getline(iss, item, delim)) { + while(std::getline(iss, item, delim)) *result++ = item; - } } std::vector split(const std::string &s, char delim) { From 22fe7bdf0b8aab9d13aaa433c96cff77d11234a2 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Thu, 28 Aug 2025 10:45:41 -0400 Subject: [PATCH 03/19] organize: moved include files to inc/ --- Board.cpp | 4 ++-- NeoPixel.cpp | 2 +- Piece.cpp | 2 +- Board.hpp => inc/Board.hpp | 0 NeoPixel.hpp => inc/NeoPixel.hpp | 0 Piece.hpp => inc/Piece.hpp | 0 main.cpp | 6 +++--- 7 files changed, 7 insertions(+), 7 deletions(-) rename Board.hpp => inc/Board.hpp (100%) rename NeoPixel.hpp => inc/NeoPixel.hpp (100%) rename Piece.hpp => inc/Piece.hpp (100%) diff --git a/Board.cpp b/Board.cpp index 933dfcc..38eaed5 100644 --- a/Board.cpp +++ b/Board.cpp @@ -6,7 +6,7 @@ // This Source Code Form is "Incompatible With Secondary Licenses", as // defined by the Mozilla Public License, v. 2.0. -#include "Board.hpp" +#include "inc/Board.hpp" #include "inc/strFuncs.hpp" /* @@ -40,7 +40,7 @@ Board::~Board() { void Board::setupInitialPosition() { // set up the board grid with smart pointers - // initialize each square with a Piece + // initialize each square with a Piece or nullptr playerTurn = PL_WHITE; for(int i = 0; i < 8; i++) { switch(i) { diff --git a/NeoPixel.cpp b/NeoPixel.cpp index 343310f..68ba1dc 100644 --- a/NeoPixel.cpp +++ b/NeoPixel.cpp @@ -6,7 +6,7 @@ // This Source Code Form is "Incompatible With Secondary Licenses", as // defined by the Mozilla Public License, v. 2.0. -#include "NeoPixel.hpp" +#include "inc/NeoPixel.hpp" uint8_t setNeoPixel(uint8_t index, uint8_t red, uint8_t green, uint8_t blue) { return 0; diff --git a/Piece.cpp b/Piece.cpp index 95ab9f3..e0ed418 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -6,7 +6,7 @@ // This Source Code Form is "Incompatible With Secondary Licenses", as // defined by the Mozilla Public License, v. 2.0. -#include "Piece.hpp" +#include "inc/Piece.hpp" Piece::~Piece() { return; diff --git a/Board.hpp b/inc/Board.hpp similarity index 100% rename from Board.hpp rename to inc/Board.hpp diff --git a/NeoPixel.hpp b/inc/NeoPixel.hpp similarity index 100% rename from NeoPixel.hpp rename to inc/NeoPixel.hpp diff --git a/Piece.hpp b/inc/Piece.hpp similarity index 100% rename from Piece.hpp rename to inc/Piece.hpp diff --git a/main.cpp b/main.cpp index ee3b5e1..51059d6 100644 --- a/main.cpp +++ b/main.cpp @@ -49,9 +49,9 @@ #include // for ISR macros #include -#include "Board.hpp" -#include "Piece.hpp" -#include "NeoPixel.hpp" +#include "inc/Board.hpp" +#include "inc/Piece.hpp" +#include "inc/NeoPixel.hpp" #define F_CPU 12000000UL // 12MHz #define F_PER 6000000UL // 6MHz From 76c0c3ce8be9a1cf3a9adbaebeb62beb3521c98e Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Fri, 29 Aug 2025 04:16:20 -0400 Subject: [PATCH 04/19] FEN: more work on FEN decoding, handling field 2 and 3 --- Board.cpp | 66 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 55 insertions(+), 11 deletions(-) diff --git a/Board.cpp b/Board.cpp index 38eaed5..68f61bf 100644 --- a/Board.cpp +++ b/Board.cpp @@ -89,22 +89,17 @@ void Board::setupInitialPosition() { return; } -int setupFromFEN(std::string strFEN) { +int Board::setupFromFEN(std::string strFEN) { std::vector splitFEN = split(strFEN, ' '); - if(splitFEN.size() != 6) // a valid FEN *must* contain 6 fields + if(splitFEN.size() != 6) // a valid FEN *must* contain 6 fields return -1; + // ====== START OF FIELD 1 ====== std::vector splitField1 = split(splitFEN[0], '/'); int rank = 0, file = 0; int skip = 0; bool wKingPlaced = false, bKingPlaced = false; for(auto &ranks : splitField1) { for(auto &sym : ranks) { - if(skip) { - boardGrid[rank][file] = nullptr; // remove reference - skip--; - file++; - continue; - } switch(sym) { case 'R': // white rook @@ -173,17 +168,62 @@ int setupFromFEN(std::string strFEN) { case '5': case '6': case '7': - case '8': - case '9': - skip = atoi(sym); + case '8': { + std::string skipStr(1, sym); + skip = atoi(skipStr.c_str()); + skip--; // fix off by 1 error + do { + boardGrid[rank][file] = nullptr; // remove reference + file = (file < 8) ? file + 1 : 0; + } while(--skip); break; + } default: // invalid character? return -1; + break; } file++; + if(file > 7) { + file = 0; + break; + } } rank++; + if(rank > 7) + break; + } + // ======= END OF FIELD 1 ====== + // ======= START OF FIELD 2 ====== + std::string w = "w"; + std::string b = "b"; + if(splitFEN[1] == w) + playerTurn = PL_WHITE; + else if(splitFEN[1] == b) + playerTurn = PL_BLACK; + else { + // invalid FEN + return -1; + } + // ====== END OF FIELD 2 ====== + // ====== START OF FIELD 3 ====== + std::string k = "k", K = "K", q = "q", Q = "Q"; + if(splitFEN[2] == "-") { + // nobody can castle, either side + // locate Kings and set appropriate variables + // canCastleKS, canCastleQS + } + if(splitFEN[2].find(k) != std::string::npos) { + // black king can castle kingside + } + if(splitFEN[2].find(K) != std::string::npos) { + // white king can castle kingside + } + if(splitFEN[2].find(q) != std::string::npos) { + // black king can castle queenside + } + if(splitFEN[2].find(Q) != std::string::npos) { + // white king can castle queenside } return 0; } @@ -198,4 +238,8 @@ void Board::deserializeBoard(uint64_t incomingBoard) { boardRows[i] = (incomingBoard >> (8 * i)) & 0xFF; // how do we then figure out what has moved? return; +} + +std::unique_ptr &Board::getPieceAt(Square square) { + return boardGrid[square.rank][square.file]; } \ No newline at end of file From 21fae88bdbe37cdc8346188dd594f1ae8bcc3fd5 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Fri, 29 Aug 2025 04:17:16 -0400 Subject: [PATCH 05/19] fmt: reformatted code, changed some function signatures, fairly minor --- Piece.cpp | 16 +-- inc/Board.hpp | 46 +++++---- inc/Piece.hpp | 16 +-- main.cpp | 2 + nbproject/configurations.xml | 186 +++++++++++++++++++++++++++++++++-- 5 files changed, 216 insertions(+), 50 deletions(-) diff --git a/Piece.cpp b/Piece.cpp index e0ed418..ccfd82a 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -18,11 +18,11 @@ Piece::~Piece() { // so this is just a stub that does nothing. it doesn't matter // because only the derived class versions should be called. -std::vector Piece::getLegalMoves(const Square &from, const Board &board) const { +std::vector Piece::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; return moveList; } -bool King::checkForCheck() const { +bool King::checkForCheck(Board &board) const { std::vector> kingVulnerable = { {-1, 0}, // Up {-1, -1}, // up-left @@ -45,7 +45,7 @@ bool King::checkForCheck() const { return inCheck; } -std::vector King::getLegalMoves(const Square &from, const Board &board) const { +std::vector King::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; std::vector> directions = { {-1, 0}, // Up @@ -156,7 +156,7 @@ std::vector King::getLegalMoves(const Square &from, const Board &board) co return moveList; } -std::vector Rook::getLegalMoves(const Square &from, const Board &board) const { +std::vector Rook::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; const int directions[4][2] = { {-1, 0}, // Up @@ -186,22 +186,22 @@ std::vector Rook::getLegalMoves(const Square &from, const Board &board) co return moveList; } -std::vector Queen::getLegalMoves(const Square &from, const Board &board) const { +std::vector Queen::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; return moveList; } -std::vector Knight::getLegalMoves(const Square &from, const Board &board) const { +std::vector Knight::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; return moveList; } -std::vector Bishop::getLegalMoves(const Square &from, const Board &board) const { +std::vector Bishop::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; return moveList; } -std::vector Pawn::getLegalMoves(const Square &from, const Board &board) const { +std::vector Pawn::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; const int directions[2][4][2] = { { diff --git a/inc/Board.hpp b/inc/Board.hpp index 4076b32..599b29e 100644 --- a/inc/Board.hpp +++ b/inc/Board.hpp @@ -9,39 +9,37 @@ #ifndef BOARD_HPP #define BOARD_HPP -#include -#include #include +#include +#include +#include + #include "Piece.hpp" // why do I have to forward declare all these?! class Piece; -enum Players { - PL_WHITE, PL_BLACK -}; +enum Players { PL_WHITE, PL_BLACK }; struct Square; class Board { - private: - friend class Piece; - Players playerTurn; - public: - // this should be protected, but even when Piece is declared as a friend, - // accessing it in Piece.cpp threw an error - std::vector>> boardGrid; - Board(); - virtual ~Board(); - void setupInitialPosition(); - Piece *getPieceAt(Square square); - void movePiece(Square from, Square to); - int setupFromFEN(std::string strFEN); - bool isInBounds(Square square) const; - bool isEmpty(Square square) const; - uint64_t serialBoard = 0xFFFF00000000FFFF; // opening position - void deserializeBoard(uint64_t incomingBoard); - +private: + friend class Piece; + Players playerTurn; +public: + // this should be protected, but even when Piece is declared as a friend, + // accessing it in Piece.cpp threw an error + std::vector>> boardGrid; + Board(); + virtual ~Board(); + void setupInitialPosition(); + std::unique_ptr &getPieceAt(Square square); + void movePiece(Square from, Square to); + int setupFromFEN(std::string strFEN); + bool isInBounds(Square square) const; + bool isEmpty(Square square) const; + uint64_t serialBoard = 0xFFFF00000000FFFF; // opening position + void deserializeBoard(uint64_t incomingBoard); }; #endif // BOARD_HPP - diff --git a/inc/Piece.hpp b/inc/Piece.hpp index b2cd0cb..15132dd 100644 --- a/inc/Piece.hpp +++ b/inc/Piece.hpp @@ -68,7 +68,7 @@ class Piece { Piece(PieceColour pColour) : colour(pColour) { } virtual ~Piece(); - virtual std::vector getLegalMoves(const Square &from, const Board &board) const; + virtual std::vector getLegalMoves(const Square &from, Board &board) const; PieceColour getColour() const { return colour; @@ -101,9 +101,9 @@ class King : public Piece { pieceSymbol = 'K'; pieceType = KING; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; - bool checkForCheck() const; + bool checkForCheck(Board &board) const; bool checkForCastle(enum CastleSide side) const { if(side == KINGSIDE) @@ -130,7 +130,7 @@ class Rook : public Piece { pieceSymbol = 'R'; pieceType = ROOK; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; }; class Queen : public Piece { @@ -142,7 +142,7 @@ class Queen : public Piece { pieceSymbol = 'Q'; pieceType = QUEEN; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; }; class Knight : public Piece { @@ -154,7 +154,7 @@ class Knight : public Piece { pieceSymbol = 'N'; pieceType = KNIGHT; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; }; class Bishop : public Piece { @@ -166,7 +166,7 @@ class Bishop : public Piece { pieceSymbol = 'B'; pieceType = BISHOP; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; }; class Pawn : public Piece { @@ -178,7 +178,7 @@ class Pawn : public Piece { pieceSymbol = 'P'; pieceType = PAWN; } - virtual std::vector getLegalMoves(const Square &from, const Board &board) const override; + virtual std::vector getLegalMoves(const Square &from, Board &board) const override; }; #endif // PIECE_HPP diff --git a/main.cpp b/main.cpp index 51059d6..fa1ca31 100644 --- a/main.cpp +++ b/main.cpp @@ -179,6 +179,8 @@ extern "C" int main(void) { initInterrupts(); Board gameBoard; NeoPixel boardLights(64); + + gameBoard.setupInitialPosition(); while(1) { } } diff --git a/nbproject/configurations.xml b/nbproject/configurations.xml index 2a6fe8d..28d6976 100644 --- a/nbproject/configurations.xml +++ b/nbproject/configurations.xml @@ -54,7 +54,7 @@ PIC32MX270F256B - noID + snap XC32 4.60 2 @@ -73,7 +73,7 @@ false - true + false @@ -87,7 +87,7 @@ false false - false + true @@ -103,12 +103,12 @@ - + - + @@ -141,7 +141,7 @@ - + @@ -171,7 +171,7 @@ - + @@ -214,18 +214,18 @@ - + - + - + @@ -261,6 +261,172 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From e5a124d1935137f0777d50b7c1f4455699f88d2f Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sat, 30 Aug 2025 18:45:04 -0400 Subject: [PATCH 06/19] FEN: major portion of FEN import is working and tested --- Board.cpp | 57 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 8 deletions(-) diff --git a/Board.cpp b/Board.cpp index 68f61bf..86cf960 100644 --- a/Board.cpp +++ b/Board.cpp @@ -97,6 +97,7 @@ int Board::setupFromFEN(std::string strFEN) { std::vector splitField1 = split(splitFEN[0], '/'); int rank = 0, file = 0; int skip = 0; + Square whiteKing, blackKing; bool wKingPlaced = false, bKingPlaced = false; for(auto &ranks : splitField1) { for(auto &sym : ranks) { @@ -104,34 +105,42 @@ int Board::setupFromFEN(std::string strFEN) { case 'R': // white rook boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + file++; break; case 'r': // black rook boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + file++; break; case 'N': // white knight boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + file++; break; case 'n': // black knight boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + file++; break; case 'B': // white bishop boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + file++; break; case 'b': // black bishop boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + file++; break; case 'Q': // white queen boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + file++; break; case 'q': // black queen; boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + file++; break; case 'K': // white king @@ -141,6 +150,10 @@ int Board::setupFromFEN(std::string strFEN) { } else { boardGrid[rank][file] = std::make_unique(PIECE_WHITE); wKingPlaced = true; + // store king position for later + whiteKing.file = file; + whiteKing.rank = rank; + file++; } break; case 'k': @@ -151,15 +164,21 @@ int Board::setupFromFEN(std::string strFEN) { } else { boardGrid[rank][file] = std::make_unique(PIECE_BLACK); bKingPlaced = true; + // store king position for later + blackKing.file = file; + blackKing.rank = rank; + file++; } break; case 'P': // white pawn boardGrid[rank][file] = std::make_unique(PIECE_WHITE); + file++; break; case 'p': // black pawn boardGrid[rank][file] = std::make_unique(PIECE_BLACK); + file++; break; case '1': case '2': @@ -171,11 +190,10 @@ int Board::setupFromFEN(std::string strFEN) { case '8': { std::string skipStr(1, sym); skip = atoi(skipStr.c_str()); - skip--; // fix off by 1 error - do { - boardGrid[rank][file] = nullptr; // remove reference - file = (file < 8) ? file + 1 : 0; - } while(--skip); + //skip--; // fix off by 1 error + while(skip--) { + boardGrid[rank][file++] = nullptr; // remove reference + } break; } default: @@ -183,7 +201,6 @@ int Board::setupFromFEN(std::string strFEN) { return -1; break; } - file++; if(file > 7) { file = 0; break; @@ -208,23 +225,47 @@ int Board::setupFromFEN(std::string strFEN) { // ====== END OF FIELD 2 ====== // ====== START OF FIELD 3 ====== std::string k = "k", K = "K", q = "q", Q = "Q"; + auto &bKing = this->getPieceAt(blackKing); + auto &wKing = this->getPieceAt(whiteKing); if(splitFEN[2] == "-") { // nobody can castle, either side - // locate Kings and set appropriate variables - // canCastleKS, canCastleQS + bKing->setCastleKS(false); + bKing->setCastleQS(false); + wKing->setCastleKS(false); + wKing->setCastleQS(false); } if(splitFEN[2].find(k) != std::string::npos) { // black king can castle kingside + bKing->setCastleKS(true); } if(splitFEN[2].find(K) != std::string::npos) { // white king can castle kingside + wKing->setCastleKS(true); } if(splitFEN[2].find(q) != std::string::npos) { // black king can castle queenside + bKing->setCastleQS(true); } if(splitFEN[2].find(Q) != std::string::npos) { // white king can castle queenside + wKing->setCastleQS(true); } + // ====== END OF FIELD 3 ====== + // ====== START OF FIELD 4 ====== + // if a pawn has just moved and can be attacked enPassant, it will be listed here + + +#ifdef DEBUG + for(auto &ranks : boardGrid) { + for(auto &files : ranks) { + if(files) + std::cout << files->getPieceName() << " "; + else + std::cout << "E "; + } + std::cout << "\n"; + } +#endif return 0; } From 6773da28fbd9d716a8eac75ca6b1dc692c998994 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sat, 30 Aug 2025 18:46:18 -0400 Subject: [PATCH 07/19] Piece: expanding getLegalMoves for Queen/Knight/Bishop --- Piece.cpp | 53 +++++++++++++++++++++++++++++++++++- inc/Board.hpp | 2 ++ inc/Piece.hpp | 12 +++++++- nbproject/configurations.xml | 8 ++++-- 4 files changed, 70 insertions(+), 5 deletions(-) diff --git a/Piece.cpp b/Piece.cpp index ccfd82a..a9d81ad 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -12,6 +12,9 @@ Piece::~Piece() { return; } +// TODO: Add operator overload for << to allow easy printing +// TODO: Test getPieceAt() function to see if it works as intended + // because the Piece class is instantiated in another class using // unique_ptr, non-pure virtual functions apparently *must* // have definitions, or the linker freaks out @@ -164,7 +167,7 @@ std::vector Rook::getLegalMoves(const Square &from, Board &board) const { {0, -1}, // Left {0, 1} // Right }; - for(auto& dir : directions) { + for(auto &dir : directions) { int r = from.rank + dir[0]; int f = from.file + dir[1]; while(r >= 0 && r < 8 && f >= 0 && f < 8) { @@ -188,16 +191,64 @@ std::vector Rook::getLegalMoves(const Square &from, Board &board) const { std::vector Queen::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; + std::vector> directions = { + {-1, 0}, // Up + {-1, -1}, // up-left + {-1, 1}, // up-right + {1, 0}, // Down + {1, -1}, // down-left + {1, 1}, // down-right + {0, -1}, // Left + {0, 1} // Right + }; + for(auto &dir : directions) { + // establish r/f for square to check + int r = from.rank + dir[0]; + int f = from.file + dir[1]; + auto ra = static_cast(r); + auto fi = static_cast(f); + Square targetSquare = {ra, fi}; + while(r >= 0 && r < 8 && f >= 0 && f < 8) { + const auto &target = board.boardGrid[r][f]; // examine the target square + if(!target) { // if square is empty (NULL) + moveList.push_back({from, targetSquare}); // then it's potentially a legal move + } else if(target && target->getColour() != this->getColour()) { // if it's occupied with a piece of opposite colour + moveList.push_back({from, targetSquare}); // then again it's potentially legal + break; + } else { + // otherwise it's one of our pieces + break; + } + r += dir[0]; + f += dir[1]; + } + } return moveList; } std::vector Knight::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; + std::vector> directions = { + {-1, -2}, + {-1, 2}, + {-2, -1}, + {-2, 1}, + {1, -2}, + {1, 2}, + {2, -1}, + {2, 1} + }; return moveList; } std::vector Bishop::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; + std::vector> directions = { + {-1, -1}, // up-left + {-1, 1}, // up-right + {1, -1}, // down-left + {1, 1}, // down-right + }; return moveList; } diff --git a/inc/Board.hpp b/inc/Board.hpp index 599b29e..286437f 100644 --- a/inc/Board.hpp +++ b/inc/Board.hpp @@ -13,6 +13,7 @@ #include #include #include +#include #include "Piece.hpp" @@ -32,6 +33,7 @@ public: std::vector>> boardGrid; Board(); virtual ~Board(); + void setupInitialPosition(); std::unique_ptr &getPieceAt(Square square); void movePiece(Square from, Square to); diff --git a/inc/Piece.hpp b/inc/Piece.hpp index 15132dd..af0d3cf 100644 --- a/inc/Piece.hpp +++ b/inc/Piece.hpp @@ -8,7 +8,6 @@ #ifndef PIECE_HPP #define PIECE_HPP -#pragma once #include #include @@ -115,6 +114,13 @@ class King : public Piece { else return false; } + + void setCastleQS(bool canCastle) { + canCastleQS = canCastle; + } + void setCastleKS(bool canCastle) { + canCastleKS = canCastle; + } protected: bool canCastleQS = true; bool canCastleKS = true; @@ -179,6 +185,10 @@ class Pawn : public Piece { pieceType = PAWN; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; + void promote(const Square &promotionSquare, Board &board, PieceType promoteTo); +protected: + bool vulnEnPassant = false; + bool firstMove = true; }; #endif // PIECE_HPP diff --git a/nbproject/configurations.xml b/nbproject/configurations.xml index 28d6976..bda203e 100644 --- a/nbproject/configurations.xml +++ b/nbproject/configurations.xml @@ -4,10 +4,10 @@ - Board.hpp - Piece.hpp - NeoPixel.hpp inc/strFuncs.hpp + inc/Board.hpp + inc/NeoPixel.hpp + inc/Piece.hpp + From b68169dd2bf0055718703038212ad7f413bf147c Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Mon, 1 Sep 2025 01:42:42 -0400 Subject: [PATCH 08/19] cool: I added figlet headings because I'm that cool --- Piece.cpp | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/Piece.cpp b/Piece.cpp index a9d81ad..0efc5d3 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -25,6 +25,28 @@ std::vector Piece::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; return moveList; } + +bool Piece::finalMoveChecks(std::vector *moveList, Board &board) { + // This function needs to do the final checks before declaring a move legal + // Check to see if the piece that is being moves is currently blocking check + // Check to see if a castle is trying to go through check or out of check + // Check if it's a piece trying to capture the King (though this shouldn't happen normally) + return true; +} + +// *INDENT-OFF* +// ## +// ## ## +// ## +// ## ## ## # ## #### +// ## # ## ## ## ## # +// ### ## ## ## ## # +// ## # ## ## ## ### +// ## ## ## ## ### ## +// #### +// # # +// #### +// *INDENT-ON* bool King::checkForCheck(Board &board) const { std::vector> kingVulnerable = { {-1, 0}, // Up @@ -159,6 +181,16 @@ std::vector King::getLegalMoves(const Square &from, Board &board) const { return moveList; } +// *INDENT-OFF* +// ## +// ## +// ## # ### ### ## ## +// #### ## ## ## ## ## # +// ## ## ## ## ## ### +// ## ## ## ## ## ## # +// ## ### ### ## ## +// *INDENT-OM* + std::vector Rook::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; const int directions[4][2] = { @@ -189,6 +221,16 @@ std::vector Rook::getLegalMoves(const Square &from, Board &board) const { return moveList; } +// *INDENT-OFF* +// ### ## ## ### ### # ## +// ## # ## # ## # ## # ## ## +// ## # ## # #### #### ## ## +// ## # ## # ## ## ## ## +// ### ### ### ### ## ### +// ## +// ### +// *INDENT-ON* + std::vector Queen::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; std::vector> directions = { @@ -226,6 +268,21 @@ std::vector Queen::getLegalMoves(const Square &from, Board &board) const { return moveList; } +// *INDENT-OFF* +// +// ## +// ## ## ## # +// ## ## ## +// ## ## # ## ## #### #### ### +// ## # ## ## ## ## # ## # ## +// ### ## ## ## ## # ## # ## +// ## # ## ## ## ### ## # ## +// ## ## ## ### ## ## ## ## ## +// #### +// # # +// #### +// *INDENT-ON* + std::vector Knight::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; std::vector> directions = { @@ -241,6 +298,20 @@ std::vector Knight::getLegalMoves(const Square &from, Board &board) const return moveList; } +// *INDENT-OFF* +// +// ## +// ## ## ## +// ## ## +// ### ## ## #### ### ### +// ## # ## ## ## # ## ## ## # +// ## # ## ### ## # ## ## ## # +// ## # ## ## ## # ## ## ## # +// ### ## ### ## ## ### ### +// ## +// ### +// *INDENT-ON* + std::vector Bishop::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; std::vector> directions = { @@ -252,6 +323,16 @@ std::vector Bishop::getLegalMoves(const Square &from, Board &board) const return moveList; } +// *INDENT-OFF* +// ### ## # # ## # ## +// ## # # ## # # # ## ## +// ## # ### # ### ## ## +// ## # # # #### ## ## +// ### ##### # # ## ### +// ## +// ### +// *INDENT-ON* + std::vector Pawn::getLegalMoves(const Square &from, Board &board) const { std::vector moveList; const int directions[2][4][2] = { From ca6468cc62a535dcddc6d506e1fd40de1f25cdf4 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sun, 7 Sep 2025 17:46:48 -0400 Subject: [PATCH 09/19] docs: temporarily added docs/ to .gitignore as they are not ready --- .gitignore | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 18a9398..5de3e82 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,6 @@ chessmcu_default/ # End of https://www.toptal.com/developers/gitignore/api/mplabx -localTest/ \ No newline at end of file +localTest/ +docs/ +.ca/ \ No newline at end of file From 8e381cf109b7533bcb9704ba5e17ce4381e5c339 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sun, 7 Sep 2025 17:57:15 -0400 Subject: [PATCH 10/19] docs: Starting to add Doxygen comments --- Board.cpp | 28 +++++++++++++++++++++++++++ inc/Piece.hpp | 52 ++++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 75 insertions(+), 5 deletions(-) diff --git a/Board.cpp b/Board.cpp index 86cf960..a5f95f5 100644 --- a/Board.cpp +++ b/Board.cpp @@ -88,6 +88,22 @@ void Board::setupInitialPosition() { } return; } +/** + * Sets entire board to nullptr + */ +void Board::clearBoard() { + for(int i = 0; i < 8; i++) { + for(int j = 0; j < 8; j++) { + boardGrid[i][j] = nullptr; + } + } +} + +/** + * Takes a FEN string and creates a board to that spec + * @param strFEN A full FEN string + * @return Returns -1 on failure, 0 on success + */ int Board::setupFromFEN(std::string strFEN) { std::vector splitFEN = split(strFEN, ' '); @@ -269,6 +285,18 @@ int Board::setupFromFEN(std::string strFEN) { return 0; } +void Board::nextTurn() { + playerTurn = (playerTurn == PL_WHITE) ? PL_BLACK : PL_WHITE; // switch to other player's turn + // do initial checks -- is their king in check? do they have any legal moves? + // stalemate check - do we really need to call getLegalMoves() on every single Piece? +} + +/** + * This function should only be called after you have confirmed the move is legal! + * This will execute the move and assume you've already checked it. + * @param from The Square on which the Piece is departing + * @param to The Square to which the Piece is moving to + */ void Board::movePiece(Square from, Square to) { return; } diff --git a/inc/Piece.hpp b/inc/Piece.hpp index af0d3cf..a57dc95 100644 --- a/inc/Piece.hpp +++ b/inc/Piece.hpp @@ -9,6 +9,19 @@ #ifndef PIECE_HPP #define PIECE_HPP +/** @file Piece.hpp + * @brief The header files for the Piece class. + * + * This file contains not only the definition of the Piece class itself, but also all + * of the derived classes (King, Queen, Rook, etc.) I was considering having them be in + * separate files, but each derived class does not contain that much code, so keeping them + * all in one place seemed easier to deal with. This may change in the future! + * + * Also defined here are important enums that help abstract chess terms, for example the + * PieceType, PieceColour, Rank, File, etc. These allow the code to be more readable and + * it helps make it obvious what certain bits of code are doing. + */ + #include #include #include @@ -38,28 +51,44 @@ enum CastleSide { KINGSIDE = 1, QUEENSIDE = 2 }; +/** @struct Square + * A struct that represents a square on the chess board. + */ struct Square { - Rank rank; - File file; + Rank rank; /**< enum Rank rank represents the rank of the Square */ + File file; /**< enum File file represents the file of the Square */ + /** + * A function to test if the square is a valid square on the chessboard + * @return True if the square is within the chessboard, False otherwise + */ bool isValid() const { return rank >= 0 && rank < 8 && file >= 0 && file < 8; } }; - +/** + * A struct representing the start and end squares of a Move. + */ struct Move { Square from; Square to; }; +/** + * @class Piece Piece.hpp "inc/Piece.hpp" + * @brief A class abstracting chess pieces + * + * This is a polymorphic base class containing the basic properties all chess pieces have. + * It is intended to be extended by a child class for each piece Type, i.e. King, Queen, etc. + */ class Piece { private: friend class Board; protected: PieceColour colour; PieceType pieceType; - std::string pieceName; - char pieceSymbol; + std::string pieceName; /**< std::string pieceName is a string showing the full name of the piece, i.e. "PAWN" */ + std::string pieceSymbol; /**< std::string pieceSymbol is a single character, using the standard algebraic chess notation, ie N for Knight */ bool hasMoved = false; public: @@ -88,6 +117,19 @@ class Piece { bool checkIfMoved() const { return hasMoved; } + /** + * A virtual const function that should get all legal moves for a piece, but it may + * include some moves that need to be pruned, like those exposing the king to check. + * Still working out how to handle this. + * + * @param from the Square the Piece is currently on + * @param board A reference to the Board we are analyzing + * @return std::vector of Move: a list of all potentially legal moves + */ + virtual std::vector getLegalMoves(const Square &from, Board &board) const; + + bool finalMoveChecks(std::vector *moveList, Board &board); + }; class King : public Piece { From f05dd6d90f05d39750eddbc2bd02d866ead3c3f1 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sun, 7 Sep 2025 17:59:16 -0400 Subject: [PATCH 11/19] dev: Updates to Board and Piece, formatted code --- Board.cpp | 51 +++++++++++----------- Piece.cpp | 107 +++++++++++++++++++++++------------------------ inc/Board.hpp | 41 +++++++++--------- inc/Piece.hpp | 35 ++++++++-------- inc/strFuncs.hpp | 2 +- main.cpp | 7 ++-- 6 files changed, 122 insertions(+), 121 deletions(-) diff --git a/Board.cpp b/Board.cpp index a5f95f5..f5901e2 100644 --- a/Board.cpp +++ b/Board.cpp @@ -93,9 +93,8 @@ void Board::setupInitialPosition() { */ void Board::clearBoard() { for(int i = 0; i < 8; i++) { - for(int j = 0; j < 8; j++) { + for(int j = 0; j < 8; j++) boardGrid[i][j] = nullptr; - } } } @@ -167,8 +166,8 @@ int Board::setupFromFEN(std::string strFEN) { boardGrid[rank][file] = std::make_unique(PIECE_WHITE); wKingPlaced = true; // store king position for later - whiteKing.file = file; - whiteKing.rank = rank; + whiteKing.file = static_cast(file); + whiteKing.rank = static_cast(rank); file++; } break; @@ -181,8 +180,8 @@ int Board::setupFromFEN(std::string strFEN) { boardGrid[rank][file] = std::make_unique(PIECE_BLACK); bKingPlaced = true; // store king position for later - blackKing.file = file; - blackKing.rank = rank; + blackKing.file = static_cast(file); + blackKing.rank = static_cast(rank); file++; } break; @@ -241,8 +240,11 @@ int Board::setupFromFEN(std::string strFEN) { // ====== END OF FIELD 2 ====== // ====== START OF FIELD 3 ====== std::string k = "k", K = "K", q = "q", Q = "Q"; - auto &bKing = this->getPieceAt(blackKing); - auto &wKing = this->getPieceAt(whiteKing); + // yeah this is hacky af but it works... blame SO + Piece *baseBKing = getPieceAt(blackKing).get(); + Piece *baseWKing = getPieceAt(whiteKing).get(); + King *bKing = dynamic_cast(baseBKing); + King *wKing = dynamic_cast(baseWKing); if(splitFEN[2] == "-") { // nobody can castle, either side bKing->setCastleKS(false); @@ -269,19 +271,17 @@ int Board::setupFromFEN(std::string strFEN) { // ====== END OF FIELD 3 ====== // ====== START OF FIELD 4 ====== // if a pawn has just moved and can be attacked enPassant, it will be listed here - - -#ifdef DEBUG - for(auto &ranks : boardGrid) { - for(auto &files : ranks) { - if(files) - std::cout << files->getPieceName() << " "; - else - std::cout << "E "; - } - std::cout << "\n"; - } -#endif +//#ifdef DEBUG +// for(auto &ranks : boardGrid) { +// for(auto &files : ranks) { +// if(files) +// std::cout << files->getPieceName() << " "; +// else +// std::cout << "E "; +// } +// std::cout << "\n"; +// } +//#endif return 0; } @@ -302,13 +302,16 @@ void Board::movePiece(Square from, Square to) { } void Board::deserializeBoard(uint64_t incomingBoard) { - uint8_t boardRows[8]; + union { + uint8_t boardRows[8]; + uint64_t fullBoard; + } serialBoard; for(int i = 0; i < 8; i++) - boardRows[i] = (incomingBoard >> (8 * i)) & 0xFF; + serialBoard.boardRows[i] = static_cast((incomingBoard >> (8 * i)) & 0xFF); // how do we then figure out what has moved? return; } std::unique_ptr &Board::getPieceAt(Square square) { - return boardGrid[square.rank][square.file]; + return boardGrid[static_cast(square.rank)][static_cast(square.file)]; } \ No newline at end of file diff --git a/Piece.cpp b/Piece.cpp index 0efc5d3..61f85bb 100644 --- a/Piece.cpp +++ b/Piece.cpp @@ -35,17 +35,16 @@ bool Piece::finalMoveChecks(std::vector *moveList, Board &board) { } // *INDENT-OFF* -// ## -// ## ## -// ## -// ## ## ## # ## #### -// ## # ## ## ## ## # -// ### ## ## ## ## # -// ## # ## ## ## ### -// ## ## ## ## ### ## -// #### -// # # -// #### +// +// ## # +// # +// # ## ## # ## ## # +// # # # # # # # +// ## # # # # # +// # # # # # # # +// ## ## ##### ### ## ### +// # +// ### // *INDENT-ON* bool King::checkForCheck(Board &board) const { std::vector> kingVulnerable = { @@ -182,13 +181,15 @@ std::vector King::getLegalMoves(const Square &from, Board &board) const { } // *INDENT-OFF* -// ## -// ## -// ## # ### ### ## ## -// #### ## ## ## ## ## # -// ## ## ## ## ## ### -// ## ## ## ## ## ## # -// ## ### ### ## ## +// +// ## +// # +// # ### ## ## # ## +// # # # # # # # +// # # # # # ## +// # # # # # # # +// #### ## ## ## ## +// // *INDENT-OM* std::vector Rook::getLegalMoves(const Square &from, Board &board) const { @@ -222,13 +223,13 @@ std::vector Rook::getLegalMoves(const Square &from, Board &board) const { } // *INDENT-OFF* -// ### ## ## ### ### # ## -// ## # ## # ## # ## # ## ## -// ## # ## # #### #### ## ## -// ## # ## # ## ## ## ## -// ### ### ### ### ## ### -// ## -// ### +// ## # ## ## ## ## # ## +// # # # # # # # # # # +// # # # # ### ### # # +// # # # # # # # # +// ### ## # ### ### ### ## +// # +// ### // *INDENT-ON* std::vector Queen::getLegalMoves(const Square &from, Board &board) const { @@ -269,18 +270,15 @@ std::vector Queen::getLegalMoves(const Square &from, Board &board) const { } // *INDENT-OFF* -// -// ## -// ## ## ## # -// ## ## ## -// ## ## # ## ## #### #### ### -// ## # ## ## ## ## # ## # ## -// ### ## ## ## ## # ## # ## -// ## # ## ## ## ### ## # ## -// ## ## ## ### ## ## ## ## ## -// #### -// # # -// #### +// ## # ## # +// # # # +// # ## # ## ## ## # ### #### +// # # # # # # # # # # +// ## # # # # # # # # +// # # # # # # # # # # # +// ## ## ### ## ##### ### ### ## ## +// # +// ### // *INDENT-ON* std::vector Knight::getLegalMoves(const Square &from, Board &board) const { @@ -299,17 +297,15 @@ std::vector Knight::getLegalMoves(const Square &from, Board &board) const } // *INDENT-OFF* -// -// ## -// ## ## ## -// ## ## -// ### ## ## #### ### ### -// ## # ## ## ## # ## ## ## # -// ## # ## ### ## # ## ## ## # -// ## # ## ## ## # ## ## ## # -// ### ## ### ## ## ### ### -// ## -// ### +// ## # ## +// # # +// ### ## ### ### ## # ## +// # # # # # # # # # # +// # # # ## # # # # # # +// # # # # # # # # # # +// #### ##### ### ### ## ## ### +// # +// ### // *INDENT-ON* std::vector Bishop::getLegalMoves(const Square &from, Board &board) const { @@ -324,13 +320,14 @@ std::vector Bishop::getLegalMoves(const Square &from, Board &board) const } // *INDENT-OFF* -// ### ## # # ## # ## -// ## # # ## # # # ## ## -// ## # ### # ### ## ## -// ## # # # #### ## ## -// ### ##### # # ## ### -// ## -// ### +// +// # ## ## # # ## # ## +// # # # # # # # # +// # # ### # # # # # +// # # # # # # # # +// ### ## # # # ### ## +// # +// ### // *INDENT-ON* std::vector Pawn::getLegalMoves(const Square &from, Board &board) const { diff --git a/inc/Board.hpp b/inc/Board.hpp index 286437f..c0dbaac 100644 --- a/inc/Board.hpp +++ b/inc/Board.hpp @@ -13,7 +13,6 @@ #include #include #include -#include #include "Piece.hpp" @@ -24,24 +23,28 @@ enum Players { PL_WHITE, PL_BLACK }; struct Square; class Board { -private: - friend class Piece; - Players playerTurn; -public: - // this should be protected, but even when Piece is declared as a friend, - // accessing it in Piece.cpp threw an error - std::vector>> boardGrid; - Board(); - virtual ~Board(); - - void setupInitialPosition(); - std::unique_ptr &getPieceAt(Square square); - void movePiece(Square from, Square to); - int setupFromFEN(std::string strFEN); - bool isInBounds(Square square) const; - bool isEmpty(Square square) const; - uint64_t serialBoard = 0xFFFF00000000FFFF; // opening position - void deserializeBoard(uint64_t incomingBoard); + private: + friend class Piece; // this doesn't seem to do anything + Players playerTurn; + public: + // this should be protected, but even when Piece is declared as a friend, + // accessing it in Piece.cpp threw an error + std::vector>> boardGrid; + Board(); + virtual ~Board(); + + void setupInitialPosition(); + + void clearBoard(); + std::unique_ptr &getPieceAt(Square square); + void movePiece(Square from, Square to); + void nextTurn(); + int setupFromFEN(std::string strFEN); + bool isInBounds(Square square) const; + bool isEmpty(Square square) const; + // serial shift register stuff + uint64_t serialBoard = 0xFFFF00000000FFFF; // opening position + void deserializeBoard(uint64_t incomingBoard); }; #endif // BOARD_HPP diff --git a/inc/Piece.hpp b/inc/Piece.hpp index a57dc95..762c57d 100644 --- a/inc/Piece.hpp +++ b/inc/Piece.hpp @@ -11,12 +11,12 @@ /** @file Piece.hpp * @brief The header files for the Piece class. - * + * * This file contains not only the definition of the Piece class itself, but also all * of the derived classes (King, Queen, Rook, etc.) I was considering having them be in * separate files, but each derived class does not contain that much code, so keeping them * all in one place seemed easier to deal with. This may change in the future! - * + * * Also defined here are important enums that help abstract chess terms, for example the * PieceType, PieceColour, Rank, File, etc. These allow the code to be more readable and * it helps make it obvious what certain bits of code are doing. @@ -77,7 +77,7 @@ struct Move { /** * @class Piece Piece.hpp "inc/Piece.hpp" * @brief A class abstracting chess pieces - * + * * This is a polymorphic base class containing the basic properties all chess pieces have. * It is intended to be extended by a child class for each piece Type, i.e. King, Queen, etc. */ @@ -88,7 +88,8 @@ class Piece { PieceColour colour; PieceType pieceType; std::string pieceName; /**< std::string pieceName is a string showing the full name of the piece, i.e. "PAWN" */ - std::string pieceSymbol; /**< std::string pieceSymbol is a single character, using the standard algebraic chess notation, ie N for Knight */ + std::string + pieceSymbol; /**< std::string pieceSymbol is a single character, using the standard algebraic chess notation, ie N for Knight */ bool hasMoved = false; public: @@ -96,7 +97,7 @@ class Piece { Piece(PieceColour pColour) : colour(pColour) { } virtual ~Piece(); - virtual std::vector getLegalMoves(const Square &from, Board &board) const; + PieceColour getColour() const { return colour; @@ -106,7 +107,7 @@ class Piece { return pieceName; } - char getPieceSymbol() const { + std::string getPieceSymbol() const { return pieceSymbol; } @@ -121,7 +122,7 @@ class Piece { * A virtual const function that should get all legal moves for a piece, but it may * include some moves that need to be pruned, like those exposing the king to check. * Still working out how to handle this. - * + * * @param from the Square the Piece is currently on * @param board A reference to the Board we are analyzing * @return std::vector of Move: a list of all potentially legal moves @@ -129,7 +130,7 @@ class Piece { virtual std::vector getLegalMoves(const Square &from, Board &board) const; bool finalMoveChecks(std::vector *moveList, Board &board); - + }; class King : public Piece { @@ -139,7 +140,7 @@ class King : public Piece { King(PieceColour colour) : Piece(colour) { pieceName = "King"; - pieceSymbol = 'K'; + pieceSymbol = "K"; pieceType = KING; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; @@ -149,14 +150,12 @@ class King : public Piece { bool checkForCastle(enum CastleSide side) const { if(side == KINGSIDE) return canCastleKS; - else if(side == QUEENSIDE) return canCastleQS; - else return false; } - + void setCastleQS(bool canCastle) { canCastleQS = canCastle; } @@ -175,7 +174,7 @@ class Rook : public Piece { Rook(PieceColour colour) : Piece(colour) { pieceName = "Rook"; - pieceSymbol = 'R'; + pieceSymbol = "R"; pieceType = ROOK; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; @@ -187,7 +186,7 @@ class Queen : public Piece { Queen(PieceColour colour) : Piece(colour) { pieceName = "Queen"; - pieceSymbol = 'Q'; + pieceSymbol = "Q"; pieceType = QUEEN; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; @@ -199,7 +198,7 @@ class Knight : public Piece { Knight(PieceColour colour) : Piece(colour) { pieceName = "Knight"; - pieceSymbol = 'N'; + pieceSymbol = "N"; pieceType = KNIGHT; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; @@ -211,7 +210,7 @@ class Bishop : public Piece { Bishop(PieceColour colour) : Piece(colour) { pieceName = "Bishop"; - pieceSymbol = 'B'; + pieceSymbol = "B"; pieceType = BISHOP; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; @@ -223,12 +222,12 @@ class Pawn : public Piece { Pawn(PieceColour colour) : Piece(colour) { pieceName = "Pawn"; - pieceSymbol = 'P'; + pieceSymbol = "P"; pieceType = PAWN; } virtual std::vector getLegalMoves(const Square &from, Board &board) const override; void promote(const Square &promotionSquare, Board &board, PieceType promoteTo); -protected: + protected: bool vulnEnPassant = false; bool firstMove = true; }; diff --git a/inc/strFuncs.hpp b/inc/strFuncs.hpp index 2ea4945..ce929d0 100644 --- a/inc/strFuncs.hpp +++ b/inc/strFuncs.hpp @@ -1,4 +1,4 @@ -/* +/* * File: strFuncs.hpp * Author: amr * diff --git a/main.cpp b/main.cpp index fa1ca31..b014297 100644 --- a/main.cpp +++ b/main.cpp @@ -157,8 +157,8 @@ void initInterrupts(void) { INTCONbits.MVEC = 1; // Enable multi-vector interrupts __builtin_enable_interrupts(); IPC10bits.DMA0IP = 3; // Priority level 3 - IFS1CLR = _IFS1_DMA0IF_MASK; // Clear interrupt flag - IEC1SET = _IEC1_DMA0IE_MASK; // Enable DMA1 interrupt +// IFS1CLR = _IFS1_DMA0IF_MASK; // Clear interrupt flag +// IEC1SET = _IEC1_DMA0IE_MASK; // Enable DMA1 interrupt } void startSPI_DMA_Transfer(void) { @@ -179,7 +179,6 @@ extern "C" int main(void) { initInterrupts(); Board gameBoard; NeoPixel boardLights(64); - gameBoard.setupInitialPosition(); while(1) { } @@ -193,7 +192,7 @@ extern "C" void __ISR(_DMA0_VECTOR, IPL3AUTO) DMA0Handler(void) { DCH0INTCLR = _DCH0INT_CHBCIF_MASK; // Clear block complete flag // DMA RX completed — spi_rx_buffer[] now contains the data } - IFS1CLR = _IFS1_DMA0IF_MASK; // Clear global DMA0 IRQ flag +// IFS1CLR = _IFS1_DMA0IF_MASK; // Clear global DMA0 IRQ flag } //extern "C" void __ISR(_USB1_VECTOR, IPL4AUTO) USBHandler(void) { From 6e05baa87d1716c18d6d32ba08a108d0fd2aed85 Mon Sep 17 00:00:00 2001 From: "A.M. Rowsell" Date: Sun, 7 Sep 2025 18:00:30 -0400 Subject: [PATCH 12/19] docs: Added Doxygen config --- Doxyfile | 2988 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2988 insertions(+) create mode 100644 Doxyfile diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..85dcf26 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2988 @@ +# Doxyfile 1.14.0 + +# This file describes the settings to be used by the documentation system +# Doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "FrznChessboard MCU Code" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewers a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "All the code for the MCU inside the chessboard" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = /home/amr/Pictures/frznchess_pawn_30.png + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where Doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = /home/amr/MPLABXProjects/chessmcu.X/docs + +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise cause +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by Doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which Doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where Doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by Doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and Doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make Doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by Doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 6. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 6 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \# +# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let Doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# Doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then Doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run Doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 2 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = DATETIME + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and macOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# Doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by Doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by Doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents Doxygen's defaults, run Doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by Doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, Doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = /home/amr/MPLABXProjects/chessmcu.X + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cxxm \ + *.cpp \ + *.cppm \ + *.ccm \ + *.c++ \ + *.c++m \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which Doxygen is +# run. + +EXCLUDE = ./localTest/ \ + ./build/ + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that Doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by Doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which Doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then Doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by Doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not Doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank Doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that Doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that Doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of Doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank Doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that Doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank Doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that Doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by Doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 249 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 64 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 215 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, Doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# Doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by Doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has more details information than the tab index, you +# could consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines +# if an additional navigation panel is shown at the right hand side of the +# screen, displaying an outline of the contents of the main page, similar to +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to +# NO, this option has no effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +PAGE_OUTLINE_PANEL = YES + +# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if +# the side bar is limited to only the treeview area (value NO) or if it should +# extend to the full height of the window (value YES). Setting this to YES gives +# a layout similar to e.g. https://docs.readthedocs.io with more room for +# contents, but less room for the project logo, title, and description. If +# GENERATE_TREEVIEW is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# Doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# Doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the JavaScript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /