refactor: separate libutil (#484)

Author: benthevining

CMakeLists.txt

@@ -33,6 +33,7 @@ cpack_add_component_group (
     ben_bot_all DISPLAY_NAME "BenBot" DESCRIPTION "All components of BenBot" EXPANDED BOLD_TITLE
 )
 
+add_subdirectory (libutil)
 add_subdirectory (libchess)
 add_subdirectory (libbenbot)
 add_subdirectory (ben-bot)

ben-bot/main.cpp

@@ -22,7 +22,7 @@
 #include <iterator>
 #include <libbenbot/engine/Engine.hpp>
 #include <libchess/uci/Printing.hpp>
-#include <libchess/util/Console.hpp>
+#include <libutil/Console.hpp>
 #include <span>
 #include <string>
 #include <string_view>
@@ -104,7 +104,7 @@ using chess::uci::printing::info_string;
 
 int main(const int argc, const char** argv)
 try {
-    chess::util::enable_utf8_console_output();
+    util::enable_utf8_console_output();
 
     const auto [noLoop, uciCommand] = Arguments::parse(argc, argv);
 

docs/top-level-groups.txt

@@ -1,11 +1,26 @@
+/** @defgroup util Utilities
+    General utilities not specifically related to chess.
+ */
+
+/** @namespace util
+    This namespace contains generic utilities.
+    @ingroup util
+ */
+
 /** @defgroup libchess libchess
     A general purpose chess library and generic chess engine backend.
  */
 
+/** @namespace chess
+    This namespace contains the libchess chess library.
+    @ingroup libchess
+ */
+
 /** @defgroup libbenbot libbenbot
     BenBot's evaluation and search logic, implemented as a library.
  */
 
-/** @defgroup benbot BenBot
-    Code outside the libraries, in the engine executable itself.
+/** @namespace ben_bot
+    This namespace contains all BenBot-specific code.
+    @ingroup libbenbot
  */

libbenbot/include/libbenbot/engine/ColorPrinting.hpp

@@ -22,9 +22,9 @@
 
 #include <string_view>
 
-namespace chess::util::strings {
+namespace util::strings {
 struct TextTable;
-} // namespace chess::util::strings
+} // namespace util::strings
 
 namespace chess::game {
 struct Position;
@@ -42,13 +42,16 @@ using std::string_view;
 /** Prints the given table with bold headings, faint outlines,
     and regular content cells.
  */
-void print_colored_table(const chess::util::strings::TextTable& table);
+void print_colored_table(
+    const util::strings::TextTable& table);
 
 /** Prints the given position with faint file/rank labels. */
-void print_colored_board(const Position& pos, bool utf8);
+void print_colored_board(
+    const Position& pos, bool utf8);
 
 /** Prints the given label faintly, and the info as regular text. */
-void print_labeled_info(string_view label, string_view info);
+void print_labeled_info(
+    string_view label, string_view info);
 
 /** @} */
 

libbenbot/src/data-structures/TranspositionTable.cpp

@@ -29,8 +29,8 @@
 #include <libbenbot/eval/Score.hpp>
 #include <libbenbot/search/Bounds.hpp>
 #include <libchess/game/Position.hpp>
-#include <libchess/util/Math.hpp>
-#include <libchess/util/Memory.hpp>
+#include <libutil/Math.hpp>
+#include <libutil/Memory.hpp>
 #include <memory>
 #include <new>
 #include <numeric>
@@ -162,7 +162,7 @@ void TranspositionTable::resize(const size_t sizeMB)
     clusterCount = newClusterCount;
 
     table = static_cast<Cluster*>(
-        chess::util::memory::page_aligned_alloc(
+        util::memory::page_aligned_alloc(
             clusterCount * sizeof(Cluster)));
 
     if (table == nullptr) {
@@ -183,7 +183,7 @@ void TranspositionTable::deallocate()
 {
     std::destroy_n(table, clusterCount);
 
-    chess::util::memory::page_aligned_free(table);
+    util::memory::page_aligned_free(table);
 
     table        = nullptr;
     clusterCount = 0uz;
@@ -219,7 +219,7 @@ void TranspositionTable::new_search() noexcept
 auto TranspositionTable::find_cluster(const Position::Hash key) const noexcept -> std::span<Entry>
 {
     return index_table(
-        chess::util::math::mul_hi64(key, clusterCount))
+        util::math::mul_hi64(key, clusterCount))
         .records;
 }
 
@@ -333,7 +333,7 @@ void TranspositionTable::store(const Position& pos, const TTData& record)
 
 void TranspositionTable::prefetch(const Position& pos) const noexcept
 {
-    chess::util::memory::prefetch(
+    util::memory::prefetch(
         find_cluster(pos.hash).data());
 }
 

libbenbot/src/engine/Bench.cpp

@@ -29,10 +29,10 @@
 #include <libbenbot/search/Thread.hpp>
 #include <libchess/notation/EPD.hpp>
 #include <libchess/uci/Printing.hpp>
-#include <libchess/util/Chrono.hpp>
-#include <libchess/util/Files.hpp>
-#include <libchess/util/Strings.hpp>
-#include <libchess/util/Threading.hpp>
+#include <libutil/Chrono.hpp>
+#include <libutil/Files.hpp>
+#include <libutil/Strings.hpp>
+#include <libutil/Threading.hpp>
 #include <memory>
 #include <numeric>
 #include <ranges>
@@ -47,7 +47,6 @@ using std::size_t;
 using std::string_view;
 using uci::printing::info_string;
 
-namespace util     = chess::util;
 namespace notation = chess::notation;
 
 namespace {
@@ -218,7 +217,7 @@ void Engine::run_bench(const string_view arguments) const
     const auto epdPath = absolute(std::filesystem::path { filePath });
 
     [[maybe_unused]] const auto result
-        = util::load_file_as_string(epdPath)
+        = util::files::load(epdPath)
               .transform([this, defaultDepth, absPathStr = epdPath.string()](const string_view fileContent) {
                   info_string(std::format("Running bench for {}...", absPathStr));
 

libbenbot/src/engine/ColorPrinting.cpp

@@ -18,8 +18,8 @@
 #include <libbenbot/engine/ColorPrinting.hpp>
 #include <libbenbot/engine/Engine.hpp>
 #include <libchess/game/Position.hpp>
-#include <libchess/util/Strings.hpp>
-#include <libchess/util/TextTable.hpp>
+#include <libutil/Strings.hpp>
+#include <libutil/TextTable.hpp>
 #include <ranges>
 #include <string_view>
 #include <termcolor/termcolor.hpp>
@@ -35,7 +35,7 @@ namespace {
     {
         using Lines = beman::inplace_vector::inplace_vector<string_view, MaxLines>;
 
-        return chess::util::strings::lines_view(input)
+        return util::strings::lines_view(input)
              | std::views::take(MaxLines)
              | std::ranges::to<Lines>();
     }
@@ -57,13 +57,14 @@ void Engine::print_logo_and_version() const
          << termcolor::reset;
 }
 
-void print_colored_table(const chess::util::strings::TextTable& table)
+void print_colored_table(
+    const util::strings::TextTable& table)
 {
     table.print(
         [](const string_view heading) {
             // we want the heading text to be underlined, but not the
             // whitespace that follows the text to complete the cell
-            const auto trimmed = chess::util::strings::trim(heading);
+            const auto trimmed = util::strings::trim(heading);
 
             cout << termcolor::bold << termcolor::underline
                  << trimmed
@@ -85,7 +86,8 @@ void print_colored_table(const chess::util::strings::TextTable& table)
     cout << termcolor::reset;
 }
 
-void print_colored_board(const Position& pos, const bool utf8)
+void print_colored_board(
+    const Position& pos, const bool utf8)
 {
     const auto boardStr = utf8 ? print_utf8(pos) : print_ascii(pos);
 
@@ -101,7 +103,8 @@ void print_colored_board(const Position& pos, const bool utf8)
          << termcolor::reset;
 }
 
-void print_labeled_info(const string_view label, const string_view info)
+void print_labeled_info(
+    const string_view label, const string_view info)
 {
     cout << termcolor::white << label << termcolor::reset << info << '\n';
 }

libbenbot/src/engine/Engine.cpp

@@ -24,9 +24,9 @@
 #include <libchess/notation/MoveFormats.hpp>
 #include <libchess/uci/Options.hpp>
 #include <libchess/uci/Printing.hpp>
-#include <libchess/util/Files.hpp>
-#include <libchess/util/Logger.hpp>
-#include <libchess/util/Variant.hpp>
+#include <libutil/Files.hpp>
+#include <libutil/Logger.hpp>
+#include <libutil/Variant.hpp>
 #include <magic_enum/magic_enum.hpp>
 #include <nlohmann/json.hpp>
 #include <ranges>
@@ -132,7 +132,7 @@ void Engine::start_file_logger(const string_view arg)
     }
 
     [[maybe_unused]] const auto result
-        = chess::util::start_file_logger(path { arg })
+        = util::start_file_logger(path { arg })
               .transform_error(info_string);
 }
 
@@ -167,7 +167,7 @@ void Engine::write_config_file(const string_view arg) const
             continue;
 
         std::visit(
-            chess::util::Visitor {
+            util::Visitor {
                 [&optionsData, name = opt->get_name()](const auto value) {
                     optionsData[name] = value;
                 } },
@@ -182,7 +182,7 @@ void Engine::write_config_file(const string_view arg) const
     const auto filePath = absolute(path { arg });
 
     [[maybe_unused]] const auto result
-        = chess::util::overwrite_file(
+        = util::files::overwrite(
             filePath, data.dump(2))
               .transform([&filePath] {
                   info_string(std::format(
@@ -206,7 +206,7 @@ void Engine::read_config_file(const path& file)
     const auto filePath = absolute(file);
 
     [[maybe_unused]] const auto result
-        = chess::util::load_file_as_string(filePath)
+        = util::files::load(filePath)
               .transform([this, &filePath](const string_view fileContent) {
                   const auto data = json::parse(fileContent);
 

libbenbot/src/engine/Perft.cpp

@@ -19,15 +19,13 @@
 #include <libchess/moves/Move.hpp>
 #include <libchess/moves/Perft.hpp>
 #include <libchess/uci/Printing.hpp>
-#include <libchess/util/Strings.hpp>
+#include <libutil/Strings.hpp>
 #include <nlohmann/json.hpp>
 #include <print>
 #include <string>
 
 namespace ben_bot {
 
-namespace util = chess::util;
-
 using uci::printing::info_string;
 
 namespace {

libbenbot/src/engine/Printing.cpp

@@ -23,8 +23,8 @@
 #include <libchess/notation/FEN.hpp>
 #include <libchess/notation/MoveFormats.hpp>
 #include <libchess/uci/Printing.hpp>
-#include <libchess/util/Strings.hpp>
-#include <libchess/util/TextTable.hpp>
+#include <libutil/Strings.hpp>
+#include <libutil/TextTable.hpp>
 #include <magic_enum/magic_enum.hpp>
 #include <print>
 #include <string>
@@ -33,13 +33,12 @@
 
 namespace ben_bot {
 
-using Result = search::Result;
-
-using chess::util::strings::trim;
 using std::println;
 using uci::printing::info_string;
+using util::strings::trim;
 
-using chess::util::strings::TextTable;
+using Result = search::Result;
+using util::strings::TextTable;
 
 auto Engine::get_name() const -> std::string
 {