Merge pull request #5702 from ab9rf/autochop-report-fix

fix autochop report bug

Author: ab9rf

docs/changelog.txt

@@ -59,14 +59,17 @@ Template for new versions:
 ## New Features
 
 ## Fixes
+- `autochop`: the report will no longer throw a C++ exception when burrows are defined.
 
 ## Misc Improvements
 
 ## Documentation
 
 ## API
+- Added ``Burrows::getName``: obtains the name of a burrow, or the same placeholder name that DF would show if the burrow is unnamed.
 
 ## Lua
+- Added ``Burrows::getName`` as ``dfhack.burrows.getName``.
 
 ## Removed
 

docs/dev/Lua API.rst

@@ -2489,6 +2489,11 @@ Maps module
 Burrows module
 --------------
 
+* ``dfhack.burrows.getName(burrow)``
+
+  Returns the name of the burrow.
+  If the burrow has no set name, returns the same placeholder name that DF would show in the UI.
+
 * ``dfhack.burrows.findByName(name[, ignore_final_plus])``
 
   Returns the burrow pointer or *nil*. if ``ignore_final_plus`` is ``true``,

library/include/modules/Burrows.h

@@ -45,6 +45,8 @@ namespace DFHack
 {
 namespace Burrows
 {
+    DFHACK_EXPORT std::string getName(df::burrow* burrow);
+
     DFHACK_EXPORT df::burrow *findByName(std::string name, bool ignore_final_plus = false);
 
     // Units

library/modules/Burrows.cpp

@@ -52,6 +52,13 @@ using namespace df::enums;
 using df::global::world;
 using df::global::plotinfo;
 
+std::string Burrows::getName(df::burrow* burrow)
+{
+    CHECK_NULL_POINTER(burrow);
+    return burrow->name.empty() ? fmt::format("Burrow {}", burrow->id + 1) : burrow->name;
+}
+
+
 df::burrow *Burrows::findByName(std::string name, bool ignore_final_plus)
 {
     auto &vec = df::burrow::get_vector();

plugins/autochop.cpp

@@ -669,9 +669,8 @@ static void autochop_printStatus(color_ostream &out) {
     for (auto &burrow : plotinfo->burrows.list) {
         name_width = std::max(name_width, (int)burrow->name.size());
     }
-    name_width = -name_width; // left justify
 
-    constexpr auto fmt = "{:{}}  {:4}  {:4}  {:8}  {:5}  {:6}  {:7}\n";
+    constexpr auto fmt = "{:<{}}  {:4}  {:4}  {:8}  {:5}  {:6}  {:7}\n";
     out.print(fmt, "burrow name", name_width, " id ", "chop", "clearcut", "trees", "marked", "protect");
     out.print(fmt, "-----------", name_width, "----", "----", "--------", "-----", "------", "-------");
 
@@ -689,7 +688,7 @@ static void autochop_printStatus(color_ostream &out) {
             protect_edible = c.get_bool(BURROW_CONFIG_PROTECT_EDIBLE);
             protect_cookable = c.get_bool(BURROW_CONFIG_PROTECT_COOKABLE);
         }
-        out.print(fmt, burrow->name, name_width, burrow->id,
+        out.print(fmt, Burrows::getName(burrow), name_width, burrow->id,
                 chop ? "[x]" : "[ ]", clearcut ? "[x]" : "[ ]",
                 tree_counts[burrow->id],
                 designated_tree_counts[burrow->id],