Merge pull request #152 from Longwater1234/dev

Author: Longwater1234

BUILDING.md

@@ -34,7 +34,7 @@ cmake --build . --config Release --target all
 ![cmake_screenshot](cmake/cmake_gui_screenshot.png)
 
 - Set "Source Folder" (1) to this project root. Then set "Build Folder" (2) to a NEW _relative_ folder `/build` or `/out`. See image above. Then (3) click "**Configure**",
-- In the next screen, Choose **Unix Makefiles** on Linux; choose **Xcode** on Mac. Choose **Visual Studio** on Windows. Then click OK to save. 
+- In the next screen, Choose **Unix Makefiles** if on Linux; choose **XCode** if on Mac. Choose **Visual Studio** if on Windows. Then click OK to save. 
 - Make sure CMAKE_BUILD_TYPE is **Release**.
 - Click Configure once again, then **Generate**.
-- Finally, open build folder, then run `make all` in Terminal (Linux). On Windows and MacOS, click open project for building.
+- Finally, on Windows and MacOS, click **Open Project** for building in respective IDE. On Linux desktop, open build folder, then run `make all` in Terminal. 

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.20 FATAL_ERROR)
 
-project("SpaceCheckers" VERSION 1.0.9
+project("SpaceCheckers" VERSION 1.0.10
  HOMEPAGE_URL "https://github.com/Longwater1234/space-checkers")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
@@ -14,12 +14,11 @@ endif()
 # ==== UPDATE ME HERE ===========
 # Absolute path where you installed SFML (Required on Windows)
 set(SFML_HOME "C:/SFML/SFML-2.6.1") 
+set(SFML_DIR ${SFML_HOME}/lib/cmake/SFML)  
 # ==========================
 
 # Collect all sources
 file(GLOB_RECURSE GAME_SRC "src/*.cpp" "src/*.hpp")  
-set(SFML_DIR ${SFML_HOME}/lib/cmake/SFML)  
-
 find_package(SFML 2.6 REQUIRED COMPONENTS "graphics" "window" "system") 
 
 # download extra libs  
@@ -47,7 +46,7 @@ include_directories(${SFML_HOME}/include)
 if(MSVC)
   target_compile_options(SpaceCheckers PRIVATE /W4 /sdl /Qvec-report:1)
 else()  
-  target_compile_options(SpaceCheckers PRIVATE -Wall) 
+  target_compile_options(SpaceCheckers PRIVATE -Wall -Werror=overflow) 
 endif()
 
 # COPY resources folder to destination

README.md

@@ -56,7 +56,7 @@ The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).
 
 ## Building Instructions
 
-Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific build guide with XCode, please refer to [instructions](cmake/macbundle.cmake)
+Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific build guide with XCode, please [see this doc](cmake/README.md)
 
 ### License
 

cmake/README.md

@@ -1,6 +1,6 @@
 ## What's 'macbundle.cmake' for?
 
-This contains cmake instructions to build MacOS GUI `.app` bundle. It embeds the icon to the app bundle. It also copies all static assets into the bundle at build time.
+This contains CMake script to build MacOS GUI `.app` bundle. It embeds the icon to the app bundle. It also copies all static assets into the bundle at build time.
 
 If you installed SFML as "Frameworks", you will need to tell XCode to copy them into the bundle before Building. Follow these steps: 
 

src/CaptureTarget.hpp

@@ -1,5 +1,4 @@
 #pragma once
-#include <ostream>
 
 namespace chk
 {
@@ -11,14 +10,6 @@ struct CaptureTarget
     short preyPieceId{-1};  // ID of the piece that MUST be captured
     int preyCellIdx{-1};    // the cell hosting this piece
     int hunterNextCell{-1}; // destination of hunter AFTER capturing enemy
-
-    // override output operator
-    friend std::ostream &operator<<(std::ostream &os, const CaptureTarget &target)
-    {
-        os << "preyPieceId: " << target.preyPieceId << " preyCellIdx: " << target.preyCellIdx
-           << "hunterNextCell: " << target.hunterNextCell;
-        return os;
-    }
 };
 
 } // namespace chk

src/Cell.hpp

@@ -60,7 +60,7 @@ inline void Cell::draw(sf::RenderTarget &target, sf::RenderStates states) const
 }
 
 /**
- * Whether this cell is in even numbered row
+ * Whether this cell is in even-numbered row
  * @return TRUE or FALSE
  */
 inline bool Cell::getIsEvenRow() const

src/CircularBuffer.hpp

@@ -22,7 +22,7 @@ template <typename T> class CircularBuffer
         m_deque.resize(max_capacity);
     }
     CircularBuffer() = delete;
-    CircularBuffer(CircularBuffer &&other) = delete;
+    CircularBuffer &operator=(const CircularBuffer &) = delete;
     CircularBuffer(CircularBuffer &other) = delete;
     void addItem(const T &item);
     T &getTop() noexcept;

src/MainMenu.hpp

@@ -14,28 +14,35 @@
 #include <SFML/Window/Mouse.hpp>
 #include <memory>
 #include <string>
+
 namespace chk
 {
 constexpr auto ICON_PATH = "win-icon-16.png";
 constexpr auto FONT_PATH = "notosans-regular.ttf";
-constexpr auto APP_VERSION = "v1.0.9";
+constexpr auto APP_VERSION = "v1.0.10";
 
 enum class UserChoice
 {
     LOCAL_PLAY = 38483, // playing offline
     ONLINE_PLAY,        // playing online
 };
 
+/**
+ * Shown first when game is launched
+ */
 class MainMenu final
 {
   public:
     explicit MainMenu(sf::RenderWindow *windowPtr);
+    MainMenu() = delete;
+    MainMenu(const MainMenu &) = delete;
+    MainMenu &operator=(const MainMenu &) = delete;
     chk::UserChoice runMainLoop();
 
   private:
     void init();
     sf::RenderWindow *window;
-    sf::Texture mainImage;
+    sf::Texture bgroundImage;
     sf::RectangleShape mainFrame;
     sf::RectangleShape localBtn;
     sf::RectangleShape onlineBtn;
@@ -49,12 +56,12 @@ inline MainMenu::MainMenu(sf::RenderWindow *windowPtr)
 {
     this->window = windowPtr;
     this->mainFrame = sf::RectangleShape(sf::Vector2f(600, 700));
-    if (!this->mainImage.loadFromFile(chk::getResourcePath("main_menu_en.png")))
+    if (!this->bgroundImage.loadFromFile(chk::getResourcePath("main_menu_en.png")))
     {
-        perror("cannot find home image");
+        perror("cannot find background image");
         exit(EXIT_FAILURE);
     }
-    mainFrame.setTexture(&this->mainImage);
+    mainFrame.setTexture(&this->bgroundImage);
     mainFrame.setPosition(0, 0);
     sf::Image appIcon;
     if (appIcon.loadFromFile(chk::getResourcePath(ICON_PATH)))
@@ -92,6 +99,7 @@ inline void MainMenu::init()
 
 /**
  * Listen for GUI events, and store the selected choice to `result`
+ * @param result Output will be written into this
  */
 inline void MainMenu::handleEvents(chk::UserChoice &result)
 {
@@ -123,8 +131,8 @@ inline void MainMenu::handleEvents(chk::UserChoice &result)
 }
 
 /**
- * The main loop, renders the main menu screen, returning user choice for game Mode
- * @return The selected result
+ * The main loop, renders the main menu screen at 60FPS
+ * @return user choice for game Mode
  */
 inline chk::UserChoice MainMenu::runMainLoop()
 {
@@ -148,7 +156,7 @@ inline chk::UserChoice MainMenu::runMainLoop()
         {
             this->localBtn.setOutlineThickness(0);
         }
-        if (this->onlineBtn.getGlobalBounds().contains(sf::Vector2f(mousePos)))
+        if (this->onlineBtn.getGlobalBounds().contains(sf::Vector2f{mousePos}))
         {
             this->onlineBtn.setOutlineColor(DARK_BROWN);
             this->onlineBtn.setOutlineThickness(5.0f);

src/WsClient.cpp

@@ -1,7 +1,7 @@
 #include "WsClient.hpp"
 
-using namespace chk;
-
+namespace chk
+{
 chk::WsClient::WsClient()
 {
     ix::initNetSystem();
@@ -87,10 +87,10 @@ void WsClient::showPublicServerWindow(bool &showPublic)
     ImGui::SetNextWindowSize(ImVec2{300.0f, 300.0f});
     if (ImGui::Begin("Public Servers", nullptr, ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse))
     {
-        static int current_idx = 0;
+        static size_t current_idx{0};
         if (ImGui::BeginListBox("Select One"))
         {
-            for (int i = 0; i < publicServers.size(); ++i)
+            for (size_t i = 0; i < publicServers.size(); ++i)
             {
                 const bool selected = (i == current_idx);
                 if (ImGui::Selectable(publicServers.at(i).name.c_str(), selected))
@@ -138,7 +138,7 @@ void WsClient::asyncFetchPublicServers()
  * Parse the JSON response of server list then display them
  * @param response From the previous request
  */
-void chk::WsClient::parseServerList(const cpr::Response &response)
+void WsClient::parseServerList(const cpr::Response &response)
 {
     if (response.status_code != 200)
     {
@@ -174,7 +174,7 @@ void chk::WsClient::parseServerList(const cpr::Response &response)
 /**
  * Reset all local states to FALSE or empty string
  */
-void chk::WsClient::resetAllStates()
+void WsClient::resetAllStates()
 {
     this->isConnected = false;
     this->connClicked = false;
@@ -186,13 +186,13 @@ void chk::WsClient::resetAllStates()
 /**
  * Run main loop of showing connection window, tryConnect, and handle exchanges
  */
-void chk::WsClient::runMainLoop()
+void WsClient::runMainLoop()
 {
 
     // clang-format off
     if (!isConnected) {
         if (!connClicked) {
-           this->showConnectWindow();
+            this->showConnectWindow();
         } else {
             this->tryConnect(final_address);
         }
@@ -201,12 +201,12 @@ void chk::WsClient::runMainLoop()
     else {
         this->runServerLoop();
     }
-   
-    if (this->isDead) { 
-       // some error happened 🙁
-       if (this->_onDeathCallback != nullptr) {
-           _onDeathCallback(this->deathNote);
-       }
+    
+    if (this->isDead) {
+        // some error happened 🙁
+        if (this->_onDeathCallback != nullptr) {
+            _onDeathCallback(this->deathNote);
+        }
         this->showErrorPopup();
     } else if (this->haveWinner) {
         this->showWinnerPopup();
@@ -218,7 +218,7 @@ void chk::WsClient::runMainLoop()
  * Try to connect to Server
  * @param address server IP or URI
  */
-void chk::WsClient::tryConnect(std::string_view address)
+void WsClient::tryConnect(std::string_view address)
 {
     this->webSocketPtr->setUrl(address.data());
     if (!this->isConnected)
@@ -348,7 +348,7 @@ bool WsClient::replyServer(const chk::payload::BasePayload &payload) const
 /**
  * Exchange messages with the server and update the game accordingly. if any error happen, close connection
  */
-void chk::WsClient::runServerLoop()
+void WsClient::runServerLoop()
 {
     for (const auto &msg : this->msgBuffer.getAll())
     {
@@ -454,7 +454,7 @@ void WsClient::showErrorPopup()
 /**
  * Show winner/loser popup window.
  */
-void WsClient::showWinnerPopup()
+void chk::WsClient::showWinnerPopup()
 {
     // Always center this next dialog
     ImVec2 center = ImGui::GetMainViewport()->GetCenter();
@@ -472,4 +472,5 @@ void WsClient::showWinnerPopup()
         }
         ImGui::EndPopup();
     }
-}
+}
+} // namespace chk

src/main.cpp

@@ -62,7 +62,7 @@ int main()
     // create pieces and give each player their own
     manager->createAllPieces();
 
-    // Storing currently clicked Piece. (NOTE: using curly braces)
+    // Storing currently clicked Piece. (NOTE: using curly braces for constructor)
     chk::CircularBuffer<short> circularBuffer{1};
 
     // THE STATUS TEXT