Merge branch 'develop' into job-helpers

Author: chdoc

.github/workflows/generate-symbols.yml

@@ -134,7 +134,7 @@ jobs:
           +quit
         tar xjf dfhack-symbols-linux64-build.tar.bz2 -C DF_steam
         xml/symbols_gen_linux.sh ${{ inputs.version == 'auto' && '50.0' || inputs.version }} STEAM DF_steam
-        if [ "${{ inputs.version }}" = "auto" ]; then
+        if [ "${{ inputs.version }}" == "auto" ]; then
           while pgrep dwarfort; do
             echo "waiting for DF to exit"
             sleep 0.5

CMakeLists.txt

@@ -6,8 +6,8 @@ cmake_policy(SET CMP0048 NEW)
 cmake_policy(SET CMP0074 NEW)
 
 # set up versioning.
-set(DF_VERSION "52.02")
-set(DFHACK_RELEASE "r2")
+set(DF_VERSION "52.03")
+set(DFHACK_RELEASE "r1.1")
 set(DFHACK_PRERELEASE FALSE)
 
 set(DFHACK_VERSION "${DF_VERSION}-${DFHACK_RELEASE}")

docs/changelog.txt

@@ -35,7 +35,6 @@ Template for new versions:
 ## Documentation
 
 ## API
-- Added GUI focus strings for new_arena: ``/Loading`` and ``/Mods``
 
 ## Lua
 
@@ -57,6 +56,7 @@ Template for new versions:
 ## New Features
 
 ## Fixes
+- ``Units::getReadableName`` will no longer append a comma to the names of histfigs with no profession
 
 ## Misc Improvements
 
@@ -70,6 +70,45 @@ Template for new versions:
 
 ## Removed
 
+# 52.03-r1.1
+
+## New Tools
+
+## New Features
+
+## Fixes
+- job descriptions of mix dye job will display proper dye names
+
+## Misc Improvements
+
+## Documentation
+
+## API
+
+## Lua
+
+## Removed
+
+# 52.03-r1
+
+## New Tools
+
+## New Features
+
+## Fixes
+- `preserve-rooms` will no longer hang on startup in the presence of a cycle in the replacement relationship of noble positions
+
+## Misc Improvements
+
+## Documentation
+
+## API
+- Adjusted the logic inside ``Military::removeFromSquad`` to more closely match the game's own behavior
+
+## Lua
+
+## Removed
+
 # 52.02-r2
 
 ## New Tools

docs/plugins/orders.rst

@@ -151,7 +151,7 @@ game does not provide sufficient order conditions. Please enable ``automilk``,
 types of jobs.
 
 Note that the jugs are specifically made out of wood. This is so, as long as
-you don't may any other "Tools" out of wood, you can have a stockpile just for
+you don't make any other "Tools" out of wood, you can have a stockpile just for
 jugs by restricting a finished goods stockpile to only take wooden tools.
 
 Armok's additional note: "shleggings? Yes,

library/LuaApi.cpp

@@ -629,7 +629,7 @@ void Lua::Push(lua_State *L, const Screen::Pen &info)
         return;
     }
 
-    new (L) Pen(info);
+    Lua::make_lua_userdata<Pen>(L, info);
 
     lua_rawgetp(L, LUA_REGISTRYINDEX, &DFHACK_PEN_TOKEN);
     lua_setmetatable(L, -2);
@@ -1128,7 +1128,7 @@ static int dfhack_random_init(lua_State *L)
 
 static int dfhack_random_new(lua_State *L)
 {
-    new (L) MersenneRNG();
+    Lua::make_lua_userdata<MersenneRNG>(L);
 
     lua_rawgetp(L, LUA_REGISTRYINDEX, &DFHACK_RANDOM_TOKEN);
     lua_setmetatable(L, -2);
@@ -1212,19 +1212,19 @@ static int dfhack_random_perlin(lua_State *L)
     switch (size)
     {
         case 1: {
-            auto pdata = new (L) PerlinNoise1D<float>();
+            auto pdata = Lua::make_lua_userdata<PerlinNoise1D<float>>(L);
             pdata->init(*prng);
             lua_pushcclosure(L, eval_perlin_1, 1);
             break;
         }
         case 2: {
-            auto pdata = new (L) PerlinNoise2D<float>();
+            auto pdata = Lua::make_lua_userdata<PerlinNoise2D<float>>(L);
             pdata->init(*prng);
             lua_pushcclosure(L, eval_perlin_2, 1);
             break;
         }
         case 3: {
-            auto pdata = new (L) PerlinNoise3D<float>();
+            auto pdata = Lua::make_lua_userdata<PerlinNoise3D<float>>(L);
             pdata->init(*prng);
             lua_pushcclosure(L, eval_perlin_3, 1);
             break;

library/LuaWrapper.cpp

@@ -168,12 +168,15 @@ static void BuildTypeMetatable(lua_State *state, const type_identity *type);
 void LuaWrapper::push_object_ref(lua_State *state, void *ptr)
 {
     // stack: [metatable]
-    auto ref = (DFRefHeader*)lua_newuserdata(state, sizeof(DFRefHeader));
-    ref->ptr = ptr;
-    ref->field_info = NULL;
-    ref->tag_ptr = NULL;
-    ref->tag_identity = NULL;
-    ref->tag_attr = NULL;
+    void* stg = lua_newuserdata(state, sizeof(DFRefHeader));
+    new (stg) DFRefHeader
+    {
+        .ptr = ptr,
+        .field_info = NULL,
+        .tag_ptr = NULL,
+        .tag_identity = NULL,
+        .tag_attr = NULL,
+    };
 
     lua_swap(state);
     lua_setmetatable(state, -2);

library/include/LuaTools.h

@@ -44,11 +44,6 @@ distribution.
 #include <lua.h>
 #include <lauxlib.h>
 
-/// Allocate a new user data object and push it on the stack
-inline void *operator new (std::size_t size, lua_State *L) {
-    return lua_newuserdata(L, size);
-}
-
 namespace DFHack {
     class function_identity_base;
     struct MaterialInfo;
@@ -67,6 +62,20 @@ namespace DFHack::Lua {
      */
     DFHACK_EXPORT lua_State *Open(color_ostream &out, lua_State *state = NULL);
 
+    /**
+     * Allocate a lua userdata and construct a C++ object in that userdata's storage space
+     * The C++ object must be trivially destructible as lua GC will _not_ call the object's destructor
+     * be aware that the created userdata is left on the Lua stack as well as returned to the caller
+     */
+    template <typename T, typename... Args>
+        requires (std::is_trivially_destructible_v<T>)
+    T* make_lua_userdata(lua_State* L, Args&&... args)
+    {
+        void* stg = lua_newuserdata(L, sizeof(T));
+        T * obj = ::new (stg) T(std::forward<Args>(args)...);
+        return obj;
+    }
+
     DFHACK_EXPORT void PushDFHack(lua_State *state);
     DFHACK_EXPORT void PushBaseGlobals(lua_State *state);
 

library/modules/Filesystem.cpp

@@ -238,7 +238,8 @@ std::filesystem::path Filesystem::getInstallDir() noexcept
 std::filesystem::path Filesystem::getBaseDir() noexcept
 {
     auto getsavebase = []() {
-        if (df::global::init->media.flag.is_set(df::enums::init_media_flags::PORTABLE_MODE))
+        // assume portable mode is _on_ if init is missing
+        if (!df::global::init || df::global::init->media.flag.is_set(df::enums::init_media_flags::PORTABLE_MODE))
             return DFSDL::DFSDL_GetBasePath();
         else
             return DFSDL::DFSDL_GetPrefPath("Bay 12 Games", "Dwarf Fortress");

library/modules/Job.cpp

@@ -677,6 +677,9 @@ std::string Job::getName(df::job *job)
     button->matgloss = job->mat_index;
     button->specflag = job->specflag;
     button->job_item_flag = job->material_category;
+    button->specdata = job->specdata;
+    button->art_specifier_id1 = job->art_spec.id;
+    button->art_specifier_id2 = job->art_spec.subid;
 
     button->text(&desc);
     delete button;

library/modules/Military.cpp

@@ -477,42 +477,53 @@ bool Military::addToSquad(int32_t unit_id, int32_t squad_id, int32_t squad_pos)
 
 bool Military::removeFromSquad(int32_t unit_id)
 {
+    // based on unitst::remove_squad_info
     df::unit *unit = df::unit::find(unit_id);
     if (unit == nullptr || unit->military.squad_id == -1 || unit->military.squad_position == -1)
         return false;
 
-    int32_t squad_id = unit->military.squad_id;
-    df::squad* squad = df::squad::find(squad_id);
-    if (squad == nullptr)
-        return false;
+    // abort individual training
+    if (unit->individual_drills.size())
+        unit->flags3.bits.verify_personal_training = true;
 
+    int32_t squad_id = unit->military.squad_id;
     int32_t squad_pos = unit->military.squad_position;
-    df::squad_position* pos = vector_get(squad->positions, squad_pos);
-    if (pos == nullptr)
-        return false;
 
-    df::historical_figure* hf = df::historical_figure::find(unit->hist_figure_id);
-    if (hf == nullptr)
-        return false;
+    df::squad* squad = df::squad::find(squad_id);
+
+    if (squad)
+    {
+        df::squad_position* pos = vector_get(squad->positions, squad_pos);
+        if (pos)
+        {
+            // based on unitst::remove_squad_activity_info
+            FOR_ENUM_ITEMS(squad_event_type, i)
+            {
+                auto activity_entry = df::activity_entry::find(pos->activities[i]);
+                if (activity_entry)
+                {
+                    auto activity_event = binsearch_in_vector(activity_entry->events, &df::activity_event::event_id, pos->events[i]);
+                    if (activity_event)
+                    {
+                        activity_event->removeParticipant(unit->hist_figure_id, unit->id, false);
+                        pos->activities[i] = -1;
+                        pos->events[i] = -1;
+                    }
+                }
+            }
 
-    // remove from squad information
-    pos->occupant = -1;
+            // remove from squad position
+            pos->occupant = -1;
+        }
+    }
     // remove from unit information
     unit->military.squad_id = -1;
     unit->military.squad_position = -1;
 
-    // abort individual training
-    if (unit->individual_drills.size()) {
-        unit->flags3.bits.verify_personal_training = true;
-    }
-
-    // remove unit from squad activities
-    auto activity_entry = binsearch_in_vector(df::global::world->activities.all,&df::activity_entry::id,squad->activity);
-    if (activity_entry) {
-        for (auto const activity_event : activity_entry->events) {
-            activity_event->removeParticipant(unit->hist_figure_id, unit->id, false);
-        }
-    }
+    // remove entity squad link
+    df::historical_figure* hf = df::historical_figure::find(unit->hist_figure_id);
+    if (hf == nullptr || squad == nullptr)
+        return false;
 
     if (squad_pos == 0) // is unit a commander?
         remove_officer_entity_link(hf, squad);