Merge branch 'develop' into fix-follow-overlay

Author: ab9rf

.github/workflows/build-windows.yml

@@ -71,6 +71,7 @@ jobs:
       - name: Install build dependencies
         run: |
           choco install sccache
+          pip install Jinja2
       - name: Install doc dependencies
         if: inputs.docs
         run: |

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.35.0
+  rev: 0.36.0
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_policy(SET CMP0048 NEW)
 cmake_policy(SET CMP0074 NEW)
 
 # set up versioning.
-set(DF_VERSION "53.08")
+set(DF_VERSION "53.09")
 set(DFHACK_RELEASE "r1")
 set(DFHACK_PRERELEASE FALSE)
 

docs/changelog.txt

@@ -59,12 +59,35 @@ Template for new versions:
 ## New Features
 
 ## Fixes
+- `autochop`: the report will no longer throw a C++ exception when burrows are defined.
 - `suspendmanager`: Fix the overlay appearing where it should not when following a unit
 
 ## 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
+
+# 53.09-r1
+
+## New Tools
+
+## New Features
+- `tweak`: ``drawbridge-tiles``: Make it so raised bridges render with different tiles in ASCII mode to make it more obvious that they ARE raised (and to indicate their direction)
+
+## Fixes
+- ``Filesystem::as_string`` now always uses UTF-8 encoding rather than using the system locale encoding
+
+## Misc Improvements
+
+## Documentation
+
 ## API
 
 ## Lua

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``,

docs/plugins/tweak.rst

@@ -45,6 +45,9 @@ Commands
     Fixes crafted items not wearing out over time (:bug:`6003`). With this
     tweak, items made from cloth and leather will gain a level of wear every 20
     in-game years.
+``drawbridge-tiles``
+    Makes raising bridges in ASCII mode render with different tiles when they
+    are raised.
 ``eggs-fertile``
     Displays an indicator on fertile eggs.
 ``fast-heat``

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/include/modules/Filesystem.h

@@ -77,12 +77,13 @@ namespace DFHack {
         DFHACK_EXPORT std::filesystem::path canonicalize(std::filesystem::path p) noexcept;
         inline std::string as_string(const std::filesystem::path path) noexcept
         {
-            auto pStr = path.string();
-            if constexpr (std::filesystem::path::preferred_separator != '/')
-            {
-                std::ranges::replace(pStr, std::filesystem::path::preferred_separator, '/');
-            }
-            return pStr;
+            // this just mashes the utf-8 into a std::string without any conversion
+            // this is largely because we use utf-8 everywhere internally as much as we can
+            // but we should ultimately convert to using u8strings for strings that are utf-8
+            // and use a different string type for strings encoded in cp437 or in the locale codepage
+            std::u8string pstr = path.generic_u8string();
+            return std::string((char*)pstr.c_str());
+
         }
         DFHACK_EXPORT std::filesystem::path getInstallDir() noexcept;
         DFHACK_EXPORT std::filesystem::path getBaseDir() noexcept;

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();