docs: Added Doxygen config

.gitignore

@@ -39,4 +39,6 @@ chessmcu_default/
 
 # End of https://www.toptal.com/developers/gitignore/api/mplabx
 
-localTest/
+localTest/
+docs/
+.ca/

Board.cpp

@@ -88,6 +88,21 @@ 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<std::string> splitFEN = split(strFEN, ' ');
@@ -151,8 +166,8 @@ int Board::setupFromFEN(std::string strFEN) {
                         boardGrid[rank][file] = std::make_unique<King>(PIECE_WHITE);
                         wKingPlaced = true;
                         // store king position for later
-                        whiteKing.file = file;
-                        whiteKing.rank = rank;
+                        whiteKing.file = static_cast<File>(file);
+                        whiteKing.rank = static_cast<Rank>(rank);
                         file++;
                     }
                     break;
@@ -165,8 +180,8 @@ int Board::setupFromFEN(std::string strFEN) {
                         boardGrid[rank][file] = std::make_unique<King>(PIECE_BLACK);
                         bKingPlaced = true;
                         // store king position for later
-                        blackKing.file = file;
-                        blackKing.rank = rank;
+                        blackKing.file = static_cast<File>(file);
+                        blackKing.rank = static_cast<Rank>(rank);
                         file++;
                     }
                     break;
@@ -225,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<King *>(baseBKing);
+    King *wKing = dynamic_cast<King *>(baseWKing);
     if(splitFEN[2] == "-") {
         // nobody can castle, either side
         bKing->setCastleKS(false);
@@ -253,34 +271,47 @@ 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;
 }
 
+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;
 }
 
 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<uint8_t>((incomingBoard >> (8 * i)) & 0xFF);
     // how do we then figure out what has moved?
     return;
 }
 
 std::unique_ptr<Piece> &Board::getPieceAt(Square square) {
-    return boardGrid[square.rank][square.file];
+    return boardGrid[static_cast<int>(square.rank)][static_cast<int>(square.file)];
 }

Piece.cpp

@@ -25,6 +25,27 @@ std::vector<Move> Piece::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     return moveList;
 }
+
+bool Piece::finalMoveChecks(std::vector<Move> *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<std::vector<int>> kingVulnerable = {
         {-1, 0}, // Up
@@ -159,6 +180,18 @@ std::vector<Move> King::getLegalMoves(const Square &from, Board &board) const {
     return moveList;
 }
 
+// *INDENT-OFF*
+//
+//                    ##    
+//                     #    
+//    # ###  ##   ##   # ## 
+//     #    #  # #  #  # #  
+//     #    #  # #  #  ##   
+//     #    #  # #  #  # #  
+//    ####   ##   ##  ## ## 
+//
+// *INDENT-OM*
+
 std::vector<Move> Rook::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     const int directions[4][2] = {
@@ -189,6 +222,16 @@ std::vector<Move> Rook::getLegalMoves(const Square &from, Board &board) const {
     return moveList;
 }
 
+// *INDENT-OFF*
+//     ## # ## ##   ##   ##  # ##   
+//    #  #   #  #  #  # #  #  #  #  
+//    #  #   #  #  ###  ###   #  #  
+//    #  #   #  #  #    #     #  #  
+//     ###    ## #  ###  ### ### ## 
+//       #                          
+//      ###                                                                         
+// *INDENT-ON*
+
 std::vector<Move> Queen::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     std::vector<std::vector<int>> directions = {
@@ -226,6 +269,18 @@ std::vector<Move> Queen::getLegalMoves(const Square &from, Board &board) const {
     return moveList;
 }
 
+// *INDENT-OFF*
+//    ##             #         ##      #    
+//     #                        #      #    
+//     # ## # ##    ##    ## #  ###   ####  
+//     # #   #  #    #   #  #   #  #   #    
+//     ##    #  #    #   #  #   #  #   #    
+//     # #   #  #    #   #  #   #  #   #  # 
+//    ## ## ### ## #####  ###  ### ##   ##  
+//                          #               
+//                       ###                
+// *INDENT-ON*
+
 std::vector<Move> Knight::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     std::vector<std::vector<int>> directions = {
@@ -241,6 +296,18 @@ std::vector<Move> Knight::getLegalMoves(const Square &from, Board &board) const
     return moveList;
 }
 
+// *INDENT-OFF*
+//    ##      #        ##                
+//     #                #                
+//     ###   ##    ###  ###    ##  # ##  
+//     #  #   #   #     #  #  #  #  #  # 
+//     #  #   #    ##   #  #  #  #  #  # 
+//     #  #   #      #  #  #  #  #  #  # 
+//    ####  ##### ###  ### ##  ##   ###  
+//                                  #    
+//                                 ###   
+// *INDENT-ON*
+
 std::vector<Move> Bishop::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     std::vector<std::vector<int>> directions = {
@@ -252,6 +319,17 @@ std::vector<Move> Bishop::getLegalMoves(const Square &from, Board &board) const
     return moveList;
 }
 
+// *INDENT-OFF*
+//
+//    # ##   ##   # # ## # ##   
+//     #  #    #  # # #   #  #  
+//     #  #  ###  # # #   #  #  
+//     #  # #  #   # #    #  #  
+//     ###   ## #  # #   ### ## 
+//     #                        
+//    ###                       
+// *INDENT-ON*
+
 std::vector<Move> Pawn::getLegalMoves(const Square &from, Board &board) const {
     std::vector<Move> moveList;
     const int directions[2][4][2] = {

inc/Board.hpp

@@ -13,7 +13,6 @@
 #include <memory>
 #include <string>
 #include <vector>
-#include <iostream>
 
 #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<std::vector<std::unique_ptr<Piece>>> boardGrid;
-  Board();
-  virtual ~Board();
-  
-  void setupInitialPosition();
-  std::unique_ptr<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; // 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<std::vector<std::unique_ptr<Piece>>> boardGrid;
+    Board();
+    virtual ~Board();
+
+    void setupInitialPosition();
+
+    void clearBoard();
+    std::unique_ptr<Piece> &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

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 <cstdint>
 #include <algorithm>
 #include <utility>
@@ -38,28 +51,45 @@ 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:
@@ -67,7 +97,7 @@ class Piece {
     Piece(PieceColour pColour) : colour(pColour) {
     }
     virtual ~Piece();
-    virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const;
+
 
     PieceColour getColour() const {
         return colour;
@@ -77,7 +107,7 @@ class Piece {
         return pieceName;
     }
 
-    char getPieceSymbol() const {
+    std::string getPieceSymbol() const {
         return pieceSymbol;
     }
 
@@ -88,6 +118,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<Move> getLegalMoves(const Square &from, Board &board) const;
+
+    bool finalMoveChecks(std::vector<Move> *moveList, Board &board);
+
 };
 
 class King : public Piece {
@@ -97,7 +140,7 @@ class King : public Piece {
 
     King(PieceColour colour) : Piece(colour) {
         pieceName = "King";
-        pieceSymbol = 'K';
+        pieceSymbol = "K";
         pieceType = KING;
     }
     virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const override;
@@ -107,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;
     }
@@ -133,7 +174,7 @@ class Rook : public Piece {
 
     Rook(PieceColour colour) : Piece(colour) {
         pieceName = "Rook";
-        pieceSymbol = 'R';
+        pieceSymbol = "R";
         pieceType = ROOK;
     }
     virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const override;
@@ -145,7 +186,7 @@ class Queen : public Piece {
 
     Queen(PieceColour colour) : Piece(colour) {
         pieceName = "Queen";
-        pieceSymbol = 'Q';
+        pieceSymbol = "Q";
         pieceType = QUEEN;
     }
     virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const override;
@@ -157,7 +198,7 @@ class Knight : public Piece {
 
     Knight(PieceColour colour) : Piece(colour) {
         pieceName = "Knight";
-        pieceSymbol = 'N';
+        pieceSymbol = "N";
         pieceType = KNIGHT;
     }
     virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const override;
@@ -169,7 +210,7 @@ class Bishop : public Piece {
 
     Bishop(PieceColour colour) : Piece(colour) {
         pieceName = "Bishop";
-        pieceSymbol = 'B';
+        pieceSymbol = "B";
         pieceType = BISHOP;
     }
     virtual std::vector<Move> getLegalMoves(const Square &from, Board &board) const override;
@@ -181,12 +222,12 @@ class Pawn : public Piece {
 
     Pawn(PieceColour colour) : Piece(colour) {
         pieceName = "Pawn";
-        pieceSymbol = 'P';
+        pieceSymbol = "P";
         pieceType = PAWN;
     }
     virtual std::vector<Move> 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;
 };

inc/strFuncs.hpp

@@ -1,4 +1,4 @@
-/* 
+/*
  * File:   strFuncs.hpp
  * Author: amr
  *

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) {