Merge branch 'main' into levenshtein-distance

Author: benthevining

libbenbot/include/libbenbot/search/Callbacks.hpp

@@ -20,17 +20,16 @@
 #pragma once
 
 #include <functional>
+#include <libchess/moves/Move.hpp>
 #include <string>
 
-namespace chess::moves {
-struct Move;
-}
-
 namespace ben_bot::search {
 
 struct Options;
 struct Result;
 
+using chess::moves::Move;
+
 /** This struct encapsulates a set of functions that will be called to
     process search progress and results. Search results are always
     retrieved through these callbacks.
@@ -53,6 +52,12 @@ struct Callbacks final {
      */
     Callback onIteration;
 
+    /** Function object that will be invoked with each root move being searched.
+        The second argument is the index of the current move in the list of moves
+        being searched.
+     */
+    std::function<void(Move, size_t)> onRootMove;
+
     /** Can be safely called without checking if ``onSearchStart`` is null. */
     void search_start(const Options& options) const
     {
@@ -78,14 +83,22 @@ struct Callbacks final {
         }
     }
 
+    /** Can be safely called without checking if ``onRootMove`` is null. */
+    void root_move(const Move move, const size_t idx) const
+    {
+        if (onRootMove != nullptr) {
+            onRootMove(move, idx);
+        }
+    }
+
     /** Creates a set of callbacks that print UCI-formatted information and bestmove
         output to standard output.
 
         @param isDebugMode Function object that should return true if debug information
         should be included in the information output.
      */
     [[nodiscard]] static auto make_uci_printer(
-        std::function<bool()>&& isDebugMode)
+        std::function<bool()> isDebugMode)
         -> Callbacks;
 
     /** Creates a set of callbacks that print search information in a human-readable
@@ -97,7 +110,7 @@ struct Callbacks final {
         @note The output produced by these callbacks does not conform to the UCI protocol!
      */
     [[nodiscard]] static auto make_pretty_printer(
-        std::function<std::string(chess::moves::Move)>&& printMove)
+        std::function<std::string(Move)>&& printMove)
         -> Callbacks;
 };
 

libbenbot/src/search/Callbacks.cpp

@@ -37,19 +37,27 @@
 namespace ben_bot::search {
 
 auto Callbacks::make_uci_printer(
-    std::function<bool()>&& isDebugMode)
+    std::function<bool()> isDebugMode)
     -> Callbacks
 {
-    auto printInfo = [isDebug = std::move(isDebugMode)](const Result& res) {
-        search_info(res.to_libchess(isDebug()));
+    namespace uci_printing = chess::uci::printing;
+
+    auto printInfo = [isDebugMode](const Result& res) {
+        search_info(res.to_libchess(isDebugMode()));
     };
 
     return {
         .onSearchStart    = nullptr,
         .onSearchComplete = [printInfo](const Result& res) {
             printInfo(res);
-            chess::uci::printing::best_move(res.best_move(), res.ponder_move()); },
-        .onIteration      = printInfo
+            uci_printing::best_move(res.best_move(), res.ponder_move()); },
+        .onIteration      = printInfo,
+        .onRootMove       = [isDebugMode](const Move move, const size_t idx) {
+            if (isDebugMode()) {
+                uci_printing::currmove_info(
+                    move,
+                    idx + 1uz); // convert 0-based -> 1-based index
+            } }
     };
 }
 
@@ -314,7 +322,8 @@ auto Callbacks::make_pretty_printer(
             print_table_header();
         },
         .onSearchComplete = printIteration,
-        .onIteration      = printIteration
+        .onIteration      = printIteration,
+        .onRootMove       = nullptr
     };
 }
 

libbenbot/src/search/Search.cpp

@@ -362,7 +362,8 @@ namespace {
         const Position&     position,
         TranspositionTable& transTable,
         Interrupter&        interrupter,
-        KillerMoves&        killerMoves)
+        KillerMoves&        killerMoves,
+        const Callbacks&    callbacks)
         -> RootSearchResult
     {
         const Timer timer;
@@ -377,8 +378,11 @@ namespace {
         MoveList pv;
 
         bool foundPV = false;
+        auto moveIdx = 0uz;
 
         for (const auto move : options.movesToSearch) {
+            callbacks.root_move(move, moveIdx++);
+
             PvList childPV;
 
             auto create_context = [depth, &transTable, &interrupter, &stats, &childPV, &killerMoves](const Bounds boundsToUse, const Position& pos) {
@@ -485,7 +489,8 @@ void Context::search() // NOLINT(readability-function-cognitive-complexity)
         if (interrupter.should_abort(0uz))
             break;
 
-        const auto res = root_search(depth, options, position, transTable, interrupter, killerMoves);
+        const auto res = root_search(
+            depth, options, position, transTable, interrupter, killerMoves, callbacks);
 
         if (interrupter.was_aborted())
             break;

libchess/include/libchess/uci/Printing.hpp

@@ -56,13 +56,22 @@ void best_move(
     Move                bestMove,
     std::optional<Move> ponderMove);
 
+/** Informs the GUI that the engine is currently searching the given move.
+
+    @note For the first move, ``moveNum`` should be 1, not 0!
+
+    @ingroup uci
+ */
+void currmove_info(
+    Move currentMove, size_t moveNum);
+
 /** This POD struct encapsulates the various information that can be printed
     about a search.
 
     @ingroup uci
     @see search_info()
 
-    @todo ``multipv``, ``currmove``, ``currmovenumber``, ``refutation``, ``currline``
+    @todo ``refutation``, ``currline``
  */
 struct SearchInfo final {
     /** Represents the engine's evaluation of the line it is currently searching. */

libchess/src/uci/Printing.cpp

@@ -69,6 +69,16 @@ void best_move(
     cout.flush();
 }
 
+void currmove_info(
+    const Move currentMove, const size_t moveNum)
+{
+    println(cout,
+        "info currmove {} currmovenumber {}",
+        to_uci(currentMove), moveNum);
+
+    cout.flush();
+}
+
 auto SearchInfo::Score::MateIn::moves() const noexcept -> int
 {
     return [ply = plies]() mutable {