feat: piece square table editor has optional button to write default state to source tree (#570)

Author: benthevining

gui/libgui/CMakeLists.txt

@@ -81,6 +81,7 @@ target_compile_definitions (
     libgui
     PRIVATE
         "$<${config_debug}:BENBOT_RES_SRC_TREE_PATH=\"${CMAKE_CURRENT_LIST_DIR}/resources/res\">"
+        "$<${config_debug}:BENBOT_PST_RES_SRC_TREE_PATH=\"${PROJECT_SOURCE_DIR}/libbenbot/resources/res/piece_square_tables.json\">"
 )
 
 add_library (ben_bot::libgui ALIAS libgui)

gui/libgui/include/libgui/AppSettingsPanel.hpp

@@ -44,10 +44,9 @@ struct AppSettings final {
     };
 
     /** Error popup context used for writing the current application state
-        to the resource files in the source tree. This is only used if the
-        ``BENBOT_RES_SRC_TREE_PATH`` symbol is defined.
+        to the resource files in the source tree.
      */
-    [[maybe_unused]] ErrorPopup defaultStateSaveError { "State save error" };
+    [[maybe_unused]] ErrorPopup defaultStateSaveError { "Default state save error" };
 
     /** Serializes this state to a JSON string. */
     [[nodiscard]] auto to_string() const -> std::string;

gui/libgui/include/libgui/PSTEditor.hpp

@@ -20,6 +20,7 @@
 #pragma once
 
 #include <libbenbot/eval/PieceSquareTables.hpp>
+#include <libgui/ErrorPopup.hpp>
 #include <libgui/FileDialogContext.hpp>
 
 namespace ben_bot {
@@ -48,6 +49,11 @@ struct PSTEditorState final {
         "PieceSquareTables.json",
         { { "JSON", "json" } }
     };
+
+    /** Error popup context used for writing the default tables
+        to the source tree.
+     */
+    [[maybe_unused]] ErrorPopup defaultStateSaveError { "Default PST save error" };
 };
 
 /** Renders a piece square table editor.

gui/libgui/src/PSTEditor.cpp

@@ -21,13 +21,15 @@
 #include <libchess/board/File.hpp>
 #include <libchess/board/Rank.hpp>
 #include <libchess/board/Square.hpp>
+#include <libgui/ErrorPopup.hpp>
 #include <libgui/FileDialogContext.hpp>
 #include <libgui/PSTEditor.hpp>
 #include <libutil/Console.hpp>
 #include <libutil/Files.hpp>
 #include <magic_enum/magic_enum.hpp>
 #include <string>
 #include <string_view>
+#include <utility>
 
 namespace ben_bot::gui {
 
@@ -103,6 +105,23 @@ namespace {
             ImGui::SetItemTooltip("Reset to engine's current tables");
     }
 
+    [[maybe_unused]] void render_save_default_button(
+        const Tables& tables, ErrorPopup& error, const path& sourceTreeFile, const bool showTooltips)
+    {
+        if (ImGui::Button("Save default")) {
+            [[maybe_unused]] const auto result
+                = util::files::overwrite(sourceTreeFile, tables.to_string())
+                      .transform_error([&error](string&& message) {
+                          return error.set_error(std::move(message));
+                      });
+        }
+
+        if (showTooltips)
+            ImGui::SetItemTooltip("Save tables as default in source tree");
+
+        error.render();
+    }
+
     void render_table_type_selector(
         Tables::TableType& selectedType, const bool showTooltips)
     {
@@ -160,24 +179,12 @@ namespace {
 
         ImGui::EndTable();
     }
-
-    void render_pst_values(
-        Tables& tables, Tables::TableType& selectedType, const bool showTooltips)
-    {
-        render_table_type_selector(
-            selectedType, showTooltips);
-
-        render_value_grid(
-            tables, selectedType);
-    }
 } // namespace
 
 void render_pst_editor(
     PSTEditorState& state, Engine& engine, const bool showTooltips)
 {
     if (ImGui::Begin("Piece square tables")) {
-        // overwrite default in source tree
-
         render_reset_button(
             state.tables, showTooltips);
 
@@ -187,8 +194,18 @@ void render_pst_editor(
         render_engine_interop_buttons(
             state.tables, engine, showTooltips);
 
-        render_pst_values(
-            state.tables, state.selectedType, showTooltips);
+#ifdef BENBOT_PST_RES_SRC_TREE_PATH
+        render_save_default_button(
+            state.tables, state.defaultStateSaveError,
+            path { BENBOT_PST_RES_SRC_TREE_PATH },
+            showTooltips);
+#endif
+
+        render_table_type_selector(
+            state.selectedType, showTooltips);
+
+        render_value_grid(
+            state.tables, state.selectedType);
     }
 
     ImGui::End();