Merge branch 'develop' into random

Author: myk002

data/art/design.png

@@ -63,6 +63,7 @@ DoctorVanGogh           DoctorVanGogh
 Donald Ruegsegger       hashaash
 doomchild               doomchild
 Droseran                Droseran
+dvantwisk               dvantwisk
 DwarvenM                DwarvenM
 Eamon Bode              eamondo2                Baron Von Munchhausen
 EarthPulseAcademy       EarthPulseAcademy

docs/about/Authors.rst

@@ -59,15 +59,19 @@ Template for new versions:
 - `getplants`: will no longer crash when faced with plants with growths that do not drop seeds when processed
 - `getplants`: use updated formula for calculating whether plant growths are ripe
 - `getplants`: fix logic for determining whether plant growths have been picked
+- `gui/teleport`: adapt to new behavior in DF 51.11 to avoid a crash when teleporting items into mid-air
 
 ## Misc Improvements
+- All places where units are listed in DFHack tools now show the translated English name in addition to the native name. In particular, this makes units searchable by English name in `gui/sitemap`.
 
 ## Documentation
 
 ## API
 - ``Random`` module: added SplitmixRNG class, implements the Splitmix64 RNG used by Dwarf Fortress for "simple" randomness
 
 ## Lua
+- ``script-manager``: new ``get_active_mods()`` function for getting information on active mods
+- ``script-manager``: new ``get_mod_info_metadata()`` function for getting information out of mod ``info.txt`` files
 
 ## Removed
 
@@ -81,6 +85,7 @@ Template for new versions:
 ## Fixes
 - `preserve-rooms`: will no longer crash when a civzone is assigned to a unit that does not exist
 - `gui/design`: fix misaligned shape icons
+- `script-manager`: fix lua scripts in mods not being reloaded properly upon entering a saved world on Windows.
 
 # 51.11-r1
 
@@ -104,6 +109,7 @@ Template for new versions:
 - ``Buildings`` module: add ``getOwner`` (using the ``Units::get_cached_unit_by_global_id`` mechanic) to reflect changes in 51.11
 - ``Units::teleport``: projectile information is now cleared for teleported units
 - ``Buildings::setOwner``: updated for changes in 51.11
+- ``Items::getDescription``: fixed display of quality levels, now displays ALL item designations (in correct order) and obeys SHOW_IMP_QUALITY
 
 ## Lua
 - ``dfhack.military.addToSquad``: expose Military API function

docs/changelog.txt

@@ -1773,17 +1773,18 @@ Units module
   Get human-readable baby or child name (e.g., "dwarven baby" or
   "dwarven child").
 
-* ``dfhack.units.getReadableName(unit or historical_figure)``
+* ``dfhack.units.getReadableName(unit or historical_figure[, skip_english])``
 
-  Returns a string that includes the language name of the unit (if any), the
-  race of the unit (if different from fort), whether it is trained for war or
-  hunting, any syndrome-given descriptions (such as "necromancer"), the
-  training level (if tame), and profession or noble role. If a
-  ``historical_figure`` is passed instead of a unit, some information
-  (e.g., agitation status) is not available, and the profession may be
-  different (e.g., "Monk") from what is displayed in fort mode.
+  Returns a string that includes the native and english language name (if
+  ``skip_english`` is not ``true``) of the unit (if any), the race of the unit
+  (if different from fort), whether it is trained for war or hunting, any
+  syndrome-given descriptions (such as "necromancer"), the training level (if
+  tame), and profession or noble role. If a ``historical_figure`` is passed
+  instead of a unit, some information (e.g., agitation status) is not
+  available, and the profession may be different (e.g., "Monk") from what is
+  displayed in fort mode.
 
-* ``dfhack.units.getAge(unit[,true_age])``
+* ``dfhack.units.getAge(unit[, true_age])``
 
   Returns the age of the unit in years as a floating-point value.
   If ``true_age`` is true, ignores false identities.
@@ -3338,12 +3339,14 @@ and are only documented here for completeness:
 
 * ``dfhack.internal.findScript(name)``
 
-  Searches `script paths <script-paths>` for the script ``name`` and returns the
-  path of the first file found, or ``nil`` on failure.
+  Searches `script paths <script-paths>` for the script ``name`` (which
+  includes the ``.lua`` extension) and returns the absolute path of the first
+  file found, or ``nil`` on failure. Slashes in the path are canonicalized to
+  forward slashes.
 
   .. note::
-    This requires an extension to be specified (``.lua`` or ``.rb``) - use
-    ``dfhack.findScript()`` to include the ``.lua`` extension automatically.
+    You can use the ``dfhack.findScript()`` wrapper if you want to specify the
+    script name without the ``.lua`` extension.
 
 * ``dfhack.internal.runCommand(command[, use_console])``
 
@@ -3783,6 +3786,29 @@ paths will be relative to the top level game directory and will end in a slash
   Which would open ``dfhack-config/mods/my_awesome_mod/settings.json``. After
   calling ``getModStatePath``, the returned directory is guaranteed to exist.
 
+* ``get_active_mods()``
+
+  Returns a list of all active mods in the current world. The list elements are
+  tables containing the following fields:
+
+    - id: mod id
+    - name: mod display name
+    - version: mod display version
+    - numeric_version: numeric mod version
+    - path: path to the mod directory
+    - vanilla: true if this is a vanilla mod
+
+* ``get_mod_info_metadata(mod_path, tags)``
+
+  Returns a table with the values of the given tags from the ``info.txt`` file
+  in the given mod directory. The ``mod_path`` argument must be a path to a mod
+  directory (retrieved, say, from ``get_active_mods()``). The ``tags`` argument
+  is a string or a list of strings representing the tags to retrieve. The
+  function will return a table with the tag names as keys and their values as
+  values. If a requested tag includes the string ``NUMERIC_``, it will return
+  the numeric value for that tag (e.g., ``NUMERIC_VERSION`` will return the
+  numeric version of the mod as a number instead of a string).
+
 utils
 =====
 

docs/dev/Lua API.rst

@@ -2291,10 +2291,11 @@ static int units_assignTrainer(lua_State *L) {
 }
 
 static int units_getReadablename(lua_State *L) {
+    bool skip_english = lua_toboolean(L, 2); // defaults to false
     if (auto unit = Lua::GetDFObject<df::unit>(L, 1))
-        Lua::Push(L, Units::getReadableName(unit));
+        Lua::Push(L, Units::getReadableName(unit, skip_english));
     else if (auto hf = Lua::GetDFObject<df::historical_figure>(L, 1))
-        Lua::Push(L, Units::getReadableName(hf));
+        Lua::Push(L, Units::getReadableName(hf, skip_english));
     else
         luaL_argerror(L, 1, "Expected a unit or a historical figure");
     return 1;
@@ -3965,7 +3966,7 @@ static int internal_findScript(lua_State *L)
     const char *name = luaL_checkstring(L, 1);
     std::filesystem::path path = Core::getInstance().findScript(name);
     if (!path.empty())
-        lua_pushstring(L, path.string().c_str());
+        lua_pushstring(L, Filesystem::as_string(path).c_str());
     else
         lua_pushnil(L);
     return 1;

library/LuaApi.cpp

@@ -281,9 +281,9 @@ DFHACK_EXPORT std::string getRaceBabyName(df::unit *unit, bool plural = false);
 DFHACK_EXPORT std::string getRaceChildNameById(int32_t race_id, bool plural = false);
 DFHACK_EXPORT std::string getRaceChildName(df::unit *unit, bool plural = false);
 // Full readable name including profession. HF profession might be different from unit profession.
-DFHACK_EXPORT std::string getReadableName(df::historical_figure *hf);
+DFHACK_EXPORT std::string getReadableName(df::historical_figure *hf, bool skip_english = false);
 // Full readable name including profession, curse name, and tame description.
-DFHACK_EXPORT std::string getReadableName(df::unit *unit);
+DFHACK_EXPORT std::string getReadableName(df::unit *unit, bool skip_english = false);
 
 // Unit's age (in non-integer years). Ignore false identities if true_age.
 DFHACK_EXPORT double getAge(df::unit *unit, bool true_age = false);

library/include/modules/Units.h

@@ -994,13 +994,13 @@ local valid_script_flags = {
     scripts = {required = false},
 }
 
-local warned_scripts = {}
+local checked_scripts = {}
 
 function dfhack.run_script(name,...)
-    if not warned_scripts[name] then
+    if not checked_scripts[name] then
+        checked_scripts[name] = true
         local helpdb = require('helpdb')
         if helpdb.has_tag(name, 'unavailable') then
-            warned_scripts[name] = true
             dfhack.printerr(('UNTESTED WARNING: the "%s" script has not been validated to work well with this version of DF.'):format(name))
             dfhack.printerr('It may not work as expected, or it may corrupt your game.')
             qerror('Please run the command again to ignore this warning and proceed.')

library/lua/dfhack.lua

@@ -88,25 +88,52 @@ local INSTALLED_MODS_PATH = 'data/installed_mods/'
 -- changes to the files)
 local MOD_PATH_ROOTS = {WORKSHOP_MODS_PATH, MODS_PATH, INSTALLED_MODS_PATH}
 
-local function get_mod_id_and_version(path)
-    local idfile = path .. '/info.txt'
+-- returns the values of the given list of tags from the info.txt file in the given mod directory
+-- if a requested tag includes the string 'NUMERIC_', it will return the numeric value for that tag
+-- (e.g. NUMERIC_VERSION will return the numeric version of the mod as a number instead of a string).
+function get_mod_info_metadata(mod_path, tags)
+    local idfile = mod_path .. '/info.txt'
     local ok, lines = pcall(io.lines, idfile)
     if not ok then return end
-    local id, version
+
+    if type(tags) ~= 'table' then
+        tags = {tags}
+    end
+
+    local tag_regexes = {}
+    for _,tag in ipairs(tags) do
+        local tag_regex = ('^%%[%s:'):format(tag)
+        if tag:find('NUMERIC_') then
+            -- note this doesn't go all the way to the closing brace since some people put
+            -- non-number characters in here, and DF only reads the leading digits for
+            -- numeric fields
+            tag_regex = tag_regex .. '(%d+)'
+        else
+            tag_regex = tag_regex .. '([^%]]+)'
+        end
+        tag_regexes[tag] = tag_regex
+    end
+
+    local values = {}
     for line in lines do
-        if not id then
-            _,_,id = line:find('^%[ID:([^%]]+)%]')
+        local _,_,info_tag = line:find('^%[([^:]+):')
+        if not info_tag or not tag_regexes[info_tag] then
+            goto continue
         end
-        if not version then
-            -- note this doesn't include the closing brace since some people put
-            -- non-number characters in here, and DF only reads the leading digits
-            -- as the numeric version
-            _,_,version = line:find('^%[NUMERIC_VERSION:(%d+)')
+        local _,_,value = line:find(tag_regexes[info_tag])
+        if value then
+            values[info_tag] = value
         end
-        -- note that we do *not* want to break out of this loop early since
-        -- lines has to hit EOF to close the file
+        ::continue::
     end
-    return id, version
+
+    return values
+end
+
+local function get_mod_id_and_version(path)
+    local values = get_mod_info_metadata(path, {'ID', 'NUMERIC_VERSION'})
+    if not values then return end
+    return values.ID, values.NUMERIC_VERSION
 end
 
 local function add_mod_paths(mod_paths, id, base_path, subdir)
@@ -172,6 +199,35 @@ function get_mod_paths(installed_subdir, active_subdir)
     return mod_paths
 end
 
+-- returns a list of tables in load order with the following fields:
+--   id: mod id
+--   name: mod display name
+--   version: mod display version
+--   numeric_version: numeric mod version
+--   path: path to the mod directory
+--   vanilla: true if this is a vanilla mod
+function get_active_mods()
+    if not dfhack.isWorldLoaded() then return {} end
+
+    local mods = {}
+
+    local ol = df.global.world.object_loader
+
+    for idx=0,#ol.object_load_order_id-1 do
+        local path = ol.object_load_order_src_dir[idx].value
+        table.insert(mods, {
+            id=ol.object_load_order_id[idx].value,
+            name=ol.object_load_order_name[idx].value,
+            version=ol.object_load_order_displayed_version[idx].value,
+            numeric_version=ol.object_load_order_numeric_version[idx],
+            path=path,
+            vanilla=path:startswith('data/vanilla/'), -- windows also uses forward slashes
+        })
+    end
+
+    return mods
+end
+
 function get_mod_script_paths()
     local paths = {}
     for _,v in ipairs(get_mod_paths('scripts_modinstalled', 'scripts_modactive')) do

library/lua/script-manager.lua

@@ -49,6 +49,7 @@ distribution.
 #include "df/caravan_state.h"
 #include "df/creature_raw.h"
 #include "df/dfhack_material_category.h"
+#include "df/d_init.h"
 #include "df/entity_buy_prices.h"
 #include "df/entity_buy_requests.h"
 #include "df/entity_raw.h"
@@ -678,14 +679,54 @@ string Items::getDescription(df::item *item, int type, bool decorate) {
     item->getItemDescription(&tmp, type);
 
     if (decorate) {
-        addQuality(tmp, item->getQuality());
+        // Special indicators get added in a specific order
+        // Innermost is at the top, and outermost is at the bottom
 
-        if (item->isImproved()) {
+        // First, figure out the quality levels we're going to display
+        int craftquality = item->getQuality();
+        int craftquality_only_imps = item->getImprovementQuality();
+        bool has_displayed_item_improvements = item->isImproved();
+        if (!has_displayed_item_improvements && (craftquality < craftquality_only_imps))
+            craftquality = craftquality_only_imps;
+
+        // First, actual item quality
+        addQuality(tmp, craftquality);
+
+        // Next, magic enchants
+        if (item->getMagic() != NULL)
+            tmp = '\x11' + tmp + '\x10'; // <| |>
+
+        // Next, improvements
+        if (has_displayed_item_improvements) {
             tmp = '\xAE' + tmp + '\xAF'; // («) + tmp + (»)
-            addQuality(tmp, item->getImprovementQuality());
+            if (df::global::d_init->display.flags.is_set(d_init_flags1::SHOW_IMP_QUALITY))
+                addQuality(tmp, craftquality_only_imps);
+        }
+
+        // Dwarf mode only, forbid/foreign
+        if (*df::global::gamemode == game_mode::DWARF) {
+            if (item->flags.bits.forbid)
+                tmp = '{' + tmp + '}';
+            if (item->flags.bits.foreign)
+                tmp = '(' + tmp + ')';
+        }
+
+        // Wear
+        switch (item->getWear())
+        {
+            case 1: tmp = 'x' + tmp + 'x'; break;
+            case 2: tmp = 'X' + tmp + 'X'; break;
+            case 3: tmp = "XX" + tmp + "XX"; break;
         }
-        if (item->flags.bits.foreign)
-            tmp = "(" + tmp + ")";
+
+        // Fire
+        if (item->flags.bits.on_fire)
+            tmp = '\x13' + tmp + '\x13'; // !! !!
+
+        // Finally, Adventure civzone
+        if ((*df::global::gamemode == game_mode::ADVENTURE) &&
+            Items::getGeneralRef(item, general_ref_type::BUILDING_CIVZONE_ASSIGNED) != NULL)
+            tmp = '$' + tmp + '$';
     }
     return tmp;
 }
@@ -721,13 +762,6 @@ string Items::getReadableDescription(df::item *item) {
     CHECK_NULL_POINTER(item);
     auto desc = get_base_desc(item);
 
-    switch (item->getWear())
-    {
-        case 1: desc = "x" + desc + "x"; break; // Worn
-        case 2: desc = "X" + desc + "X"; break; // Threadbare
-        case 3: desc = "XX" + desc + "XX"; break; // Tattered
-    }
-
     if (auto gref = Items::getGeneralRef(item, general_ref_type::CONTAINS_UNIT)) {
         if (auto unit = gref->getUnit())
         {
@@ -816,9 +850,12 @@ static bool detachItem(df::item *item)
         }
     }
 
-    if (auto ref = virtual_cast<df::general_ref_projectile>(Items::getGeneralRef(item, general_ref_type::PROJECTILE)))
-        return linked_list_remove(&world->projectiles.all, ref->projectile_id)
-            && removeRef(item->general_refs, general_ref_type::PROJECTILE, ref->getID());
+    if (auto ref = virtual_cast<df::general_ref_projectile>(Items::getGeneralRef(item, general_ref_type::PROJECTILE))) {
+        auto proj_id = ref->projectile_id;
+        bool isRefRemoved = removeRef(item->general_refs, general_ref_type::PROJECTILE, proj_id);
+        bool isLinkRemoved = linked_list_remove(&world->projectiles.all, proj_id);
+        return isRefRemoved && isLinkRemoved;
+    }
 
     if (item->flags.bits.on_ground) {
         if (!removeItemOnGround(item))