Merge branch 'develop' of https://github.com/DFHack/dfhack into orders-search

Author: pajawojciech

.github/workflows/build-windows.yml

@@ -68,9 +68,14 @@ jobs:
     name: Build win64
     runs-on: windows-2022
     steps:
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
       - name: Install build dependencies
         run: |
           choco install sccache
+          pip install Jinja2
       - name: Install doc dependencies
         if: inputs.docs
         run: |

.pre-commit-config.yaml

@@ -20,11 +20,11 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.35.0
+  rev: 0.36.1
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks
-  rev: v1.5.5
+  rev: v1.5.6
   hooks:
     - id: forbid-tabs
       exclude_types:

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.10")
 set(DFHACK_RELEASE "r1")
 set(DFHACK_PRERELEASE FALSE)
 

docs/changelog.txt

@@ -58,9 +58,59 @@ Template for new versions:
 
 ## New Features
 - `orders`: added search overlay to find and navigate to matching manager orders with arrow indicators
+- `sort`: Add death cause button to dead/missing tab in the creatures screen
 
 ## Fixes
 
+## Misc Improvements
+- Core: DFHack now validates vtable pointers in objects read from memory and will throw an exception instead of crashing when an invalid vtable pointer is encountered. This makes it easier to identify which DF data structure contains corrupted data when this manifests in the form of a bad vtable pointer, and shifts blame for such crashes from DFHack to DF.
+
+## Documentation
+
+## API
+- Added ``Maps::addMaterialSpatter``: add a spatter of the specified material + state to the indicated tile, returning whatever amount wouldn't fit in the tile.
+- Added ``Maps::addItemSpatter``: add a spatter of the specified item + material + growth print to the indicated tile, returning whatever amount wouldn't fit in the tile.
+- Added ``Items::pickGrowthPrint``: given a plant material and a growth index, returns the print variant corresponding to the current in-game time.
+- Added ``Items::useStandardMaterial``: given an item type, returns true if the item is made of a specific material and false if it has a race and caste instead.
+
+## Lua
+- Added ``Maps::addMaterialSpatter`` as ``dfhack.maps.addMaterialSpatter``.
+- Added ``Maps::addItemSpatter`` as ``dfhack.maps.addItemSpatter``.
+
+## Removed
+
+# 53.10-r1
+
+## New Tools
+
+## 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

docs/dev/Lua API.rst

@@ -2490,9 +2490,30 @@ Maps module
   Removes an aquifer from the given tile position.
   Returns *true* or *false* depending on success.
 
+* ``dfhack.maps.addMaterialSpatter(pos, mat, matg, state, amount)``
+
+  Adds a material spatter to the specified map tile. If the tile is already
+  full of that spatter, returns the amount left over.
+
+  Specifying a state of -1 (None) will automatically choose either Solid,
+  Liquid, or Gas based on the material properties and the tile temperature.
+
+* ``dfhack.maps.addItemSpatter(pos, i_type, i_subtype, subcat1, subcat2, print_variant, amount)``
+
+  Adds an item spatter to the specified map tile. If the tile is already
+  full of that spatter, returns the amount left over.
+
+  For plant growths, specifying a print_variant of -1 will automatically
+  choose an appropriate value. For other item types, this field is ignored.
+
 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/DataDefs.cpp

@@ -370,7 +370,7 @@ const virtual_identity *virtual_identity::find(void *vtable)
 
     // If using a reader/writer lock, re-grab as write here, and recheck
     Core &core = Core::getInstance();
-    std::string name = core.p->doReadClassName(vtable);
+    std::string name = core.p->readClassName(vtable);
 
     auto name_it = (*name_lookup).find(name);
     if (name_it != (*name_lookup).end()) {

library/LuaApi.cpp

@@ -2783,6 +2783,40 @@ static int maps_removeTileAquifer(lua_State* L)
     return 1;
 }
 
+static int maps_addMaterialSpatter(lua_State *L)
+{
+    int32_t rv;
+    df::coord pos;
+
+    Lua::CheckDFAssign(L, &pos, 1);
+    int16_t mat = lua_tointeger(L, 2);
+    int32_t matg = lua_tointeger(L, 3);
+    df::matter_state state = (df::matter_state)lua_tointeger(L, 4);
+    int32_t amount = lua_tointeger(L, 5);
+    rv = Maps::addMaterialSpatter(pos, mat, matg, state, amount);
+
+    lua_pushinteger(L, rv);
+    return 1;
+}
+
+static int maps_addItemSpatter(lua_State *L)
+{
+    int32_t rv;
+    df::coord pos;
+
+    Lua::CheckDFAssign(L, &pos, 1);
+    df::item_type i_type = (df::item_type)lua_tointeger(L, 2);
+    int16_t i_subtype = lua_tointeger(L, 3);
+    int16_t i_subcat1 = lua_tointeger(L, 4);
+    int32_t i_subcat2 = lua_tointeger(L, 5);
+    int32_t print_variant = lua_tointeger(L, 6);
+    int32_t amount = lua_tointeger(L, 7);
+    rv = Maps::addItemSpatter(pos, i_type, i_subtype, i_subcat1, i_subcat2, print_variant, amount);
+
+    lua_pushinteger(L, rv);
+    return 1;
+}
+
 static const luaL_Reg dfhack_maps_funcs[] = {
     { "isValidTilePos", maps_isValidTilePos },
     { "isTileVisible", maps_isTileVisible },
@@ -2798,6 +2832,8 @@ static const luaL_Reg dfhack_maps_funcs[] = {
     { "isTileHeavyAquifer", maps_isTileHeavyAquifer },
     { "setTileAquifer", maps_setTileAquifer },
     { "removeTileAquifer", maps_removeTileAquifer },
+    { "addMaterialSpatter", maps_addMaterialSpatter },
+    { "addItemSpatter", maps_addItemSpatter },
     { NULL, NULL }
 };
 

library/Process.cpp

@@ -236,6 +236,9 @@ Process::~Process()
 
 string Process::doReadClassName (void * vptr)
 {
+    if (!checkValidAddress(vptr))
+        throw std::runtime_error(fmt::format("invalid vtable ptr {}", vptr));
+
     char* rtti = Process::readPtr(((char*)vptr - sizeof(void*)));
 #ifndef WIN32
     char* typestring = Process::readPtr(rtti + sizeof(void*));
@@ -591,6 +594,20 @@ void Process::getMemRanges(vector<t_memrange>& ranges)
 }
 #endif
 
+bool Process::checkValidAddress(void* ptr)
+{
+    uintptr_t addr = reinterpret_cast<uintptr_t>(ptr);
+    auto validate = [&] (t_memrange& r) {
+        uintptr_t lo = reinterpret_cast<uintptr_t>(r.start);
+        uintptr_t hi = reinterpret_cast<uintptr_t>(r.end);
+        return addr >= lo && addr < hi;
+        };
+    std::vector<t_memrange> mr;
+    getMemRanges(mr);
+    bool valid = std::any_of(mr.begin(), mr.end(), validate);
+    return valid;
+}
+
 uintptr_t Process::getBase()
 {
 #if WIN32

library/include/MemAccess.h

@@ -221,7 +221,7 @@ namespace DFHack
 
         std::string readClassName(void* vptr)
         {
-            std::map<void*, std::string>::iterator it = classNameCache.find(vptr);
+            auto it = classNameCache.find(vptr);
             if (it != classNameCache.end())
                 return it->second;
             return classNameCache[vptr] = doReadClassName(vptr);
@@ -247,6 +247,9 @@ namespace DFHack
         /// get virtual memory ranges of the process (what is mapped where)
         static void getMemRanges(std::vector<t_memrange>& ranges);
 
+        /// check if an address has a mapping
+        bool checkValidAddress(void* ptr);
+
         /// get the symbol table extension of this process
         std::shared_ptr<DFHack::VersionInfo> getDescriptor()
         {