Merge branch 'develop' into testing

Author: myk002

docs/dev/overlay-dev-guide.rst

@@ -72,6 +72,21 @@ beyond your everyday `widgets.Widget <widget>`:
     screen, but the returned screen can instantiate and configure any new views
     that it wants to. See the `hotkeys` DFHack logo widget for an example.
 
+    The ``overlay_trigger()`` function enables the activation of overlay widgets
+    via the command line interface (CLI) or keybindings.
+    For example, executing ``overlay trigger notes.map_notes add Kitchen``::
+
+        function MyOverlayWidget:overlay_trigger(arg1, arg2)
+            if arg1 == 'add' then
+                -- Add a new note to the map
+                self:addSomething(arg2)
+            elseif arg1 == 'delete' then
+                self:deleteSomething(arg2)
+            end
+        end
+
+    This allows for dynamic updates to UI overlays directly from the CLI.
+
 If the widget can take up a variable amount of space on the screen, and you want
 the widget to adjust its position according to the size of its contents, you can
 modify ``self.frame.w`` and ``self.frame.h`` at any time -- in ``init()`` or in
@@ -207,7 +222,7 @@ If you need to improve performance, here are some potential options:
    and change the start offset every time you scan.
 
 2. Reduce the frequency of state updates by moving calcuations to
-   ``overlay_onupdate`` and setting the valud of the
+   ``overlay_onupdate`` and setting the value of the
    ``overlay_onupdate_max_freq_seconds`` attribute appropriately
 
 3. Move hotspots into C++ code, either in a new core library function or in a

docs/plugins/overlay.rst

@@ -49,6 +49,9 @@ Examples
 ``overlay trigger hotkeys.menu``
     Trigger the `hotkeys` menu widget so that it shows its popup menu. This is
     what is run when you hit :kbd:`Ctrl`:kbd:`Shift`:kbd:`C`.
+``overlay trigger notes.map_notes add Kitchen``
+    Trigger the `notes` overlay widget so that it shows its new note popup
+    with given title.
 
 Widget position
 ---------------

docs/plugins/preserve-rooms.rst

@@ -19,7 +19,9 @@ This tool mitigates both issues. It records when units leave the map and
 reserves their assigned bedrooms, offices, etc. for them. The zones will be
 disabled in their absence (so other units don't steal them), and will be
 re-enabled and reassigned to them when they appear back on the map. If they die
-away from the fort, the zone will become unreserved and available for reuse.
+away from the fort, the zone will become unreserved and available for reuse. If
+they are captured and held prisoner, their room will continue to be reserved in
+their name in the (optimistic) hope of their safe return.
 
 When you click on an assignable zone, you will also now have the option to
 associate the room with a noble or administrative role. The room will be

plugins/lua/orders.lua

@@ -448,7 +448,7 @@ LaborRestrictionsOverlay.ATTRS{
     frame={w=57, h=15},
 }
 
-local function can_set_labors()
+function can_set_labors()
     for _,fs in ipairs(dfhack.gui.getFocusStrings(dfhack.gui.getDFViewscreen(true))) do
         if fs:endswith('WORKER_ASSIGNMENT') then
             return false

plugins/lua/overlay.lua

@@ -383,7 +383,11 @@ local function do_trigger(args, quiet)
     do_by_names_or_numbers(args[1], function(name, db_entry)
         local widget = db_entry.widget
         if widget.overlay_trigger then
-            register_trigger_lock_screen(widget:overlay_trigger(), name)
+            register_trigger_lock_screen(
+                widget:overlay_trigger(table.unpack(args, 2)),
+                name
+            )
+
             if not quiet then
                 print(('triggered widget %s'):format(name))
             end

plugins/lua/preserve-rooms.lua

@@ -15,7 +15,7 @@ DEBUG = DEBUG or false
 --
 
 -- updated on world load
-local code_lookup = {}
+code_lookup = code_lookup or {}
 
 function assignToRole(code, bld)
     local group_codes = code_lookup[code:lower()]
@@ -111,7 +111,7 @@ ReservedWidget.ATTRS{
     version=2,
 }
 
-local new_world_loaded = true
+new_world_loaded = true
 
 local CONFLICTING_TOOLTIPS = utils.invert{
     df.main_hover_instruction.ZoneRepaint,
@@ -222,15 +222,19 @@ end
 local mi = df.global.game.main_interface
 
 function ReservedWidget:onInput(keys)
-    if not CONFLICTING_TOOLTIPS[mi.current_hover] and ReservedWidget.super.onInput(self, keys) then
-        return true
-    end
     if keys._MOUSE_L and
         (preserve_rooms_isReserved() or preserve_rooms_getRoleAssignment() ~= '')
     then
         if self.subviews.pause_mask:getMousePos() then return true end
         if self.subviews.add_mask:getMousePos() then return true end
     end
+    if CONFLICTING_TOOLTIPS[mi.current_hover] then
+        return false
+    end
+    if mi.entering_building_name and keys._STRING then
+        return false
+    end
+    return ReservedWidget.super.onInput(self, keys)
 end
 
 function ReservedWidget:render(dc)
@@ -276,7 +280,7 @@ local function add_options(options, choices, codes)
 end
 
 -- updated on world load
-local codes = {}
+codes = codes or {}
 
 function ReservedWidget:refresh_role_list()
     local options, choices = {{label='None', value={''}, pen=COLOR_YELLOW}}, {'None'}

plugins/preserve-rooms.cpp

@@ -358,26 +358,52 @@ static void assign_nobles(color_ostream &out) {
     }
 }
 
+static bool scrub_id_from_entries(int32_t id, int32_t key, unordered_map<int32_t, vector<int32_t>> & entries) {
+    auto it = entries.find(key);
+    if (it == entries.end())
+        return false;
+    auto & entry_ids = it->second;
+    vector_erase_at(entry_ids, linear_index(entry_ids, id));
+    if (entry_ids.empty()) {
+        entries.erase(it);
+        return true;
+    }
+    return false;
+}
+
+// clear the reservation for a zone
 static void clear_reservation(color_ostream &out, int32_t zone_id, df::building_civzonest * zone = NULL) {
     auto it = reserved_zones.find(zone_id);
     if (it == reserved_zones.end())
         return;
-    for (auto hfid : it->second) {
-        auto pending_it = pending_reassignment.find(hfid);
-        if (pending_it != pending_reassignment.end()) {
-            auto & zone_ids = pending_it->second;
-            vector_erase_at(zone_ids, linear_index(zone_ids, zone_id));
-            if (zone_ids.empty())
-                pending_reassignment.erase(pending_it);
-        }
-    }
+    for (int32_t hfid : it->second)
+        scrub_id_from_entries(zone_id, hfid, pending_reassignment);
     reserved_zones.erase(zone_id);
     if (!zone)
         zone = virtual_cast<df::building_civzonest>(df::building::find(zone_id));
     if (zone)
         zone->spec_sub_flag.bits.active = true;
 }
 
+// stop reserving zones for dead units
+static void scrub_reservations(color_ostream &out) {
+    vector<int32_t> hfids_to_scrub;
+    for (auto &[hfid, zone_ids] : pending_reassignment) {
+        if (auto hf = df::historical_figure::find(hfid); hf && hf->died_year == -1)
+            continue;
+        DEBUG(cycle,out).print("removed reservation for dead or culled hfid %d\n", hfid);
+        hfids_to_scrub.push_back(hfid);
+        for (int32_t zone_id : zone_ids) {
+            if (scrub_id_from_entries(hfid, zone_id, reserved_zones)) {
+                if (auto zone = virtual_cast<df::building_civzonest>(df::building::find(zone_id)))
+                    zone->spec_sub_flag.bits.active = true;
+            }
+        }
+    }
+    for (int32_t hfid : hfids_to_scrub)
+        pending_reassignment.erase(hfid);
+}
+
 // handles when units disappear from their assignments compared to the last scan
 static void handle_missing_assignments(color_ostream &out,
     const unordered_set<int32_t> & active_unit_ids,
@@ -411,9 +437,9 @@ static void handle_missing_assignments(color_ostream &out,
             continue;
         // unit is off-map or is dead; if we can assign room to spouse then we don't need to reserve the room
         auto spouse_hf = df::historical_figure::find(spouse_hfid);
+        auto spouse = spouse_hf ? df::unit::find(spouse_hf->unit_id) : nullptr;
         if (spouse_hf && share_with_spouse) {
-            if (auto spouse = df::unit::find(spouse_hf->unit_id);
-                spouse && Units::isActive(spouse) && !Units::isDead(spouse) && active_unit_ids.contains(spouse->id))
+            if (spouse && Units::isActive(spouse) && !Units::isDead(spouse) && active_unit_ids.contains(spouse->id))
             {
                 DEBUG(cycle,out).print("assigning zone %d (%s) to spouse %s\n",
                     zone_id, ENUM_KEY_STR(civzone_type, zone->type).c_str(),
@@ -430,7 +456,7 @@ static void handle_missing_assignments(color_ostream &out,
             DF2CONSOLE(Units::getReadableName(unit)).c_str());
         pending_reassignment[hfid].push_back(zone_id);
         reserved_zones[zone_id].push_back(hfid);
-        if (share_with_spouse && spouse_hfid > -1) {
+        if (share_with_spouse && spouse) {
             DEBUG(cycle,out).print("registering spouse unit for reassignment to zone %d (%s): hfid=%d\n",
                 zone_id, ENUM_KEY_STR(civzone_type, zone->type).c_str(), spouse_hfid);
             pending_reassignment[spouse_hfid].push_back(zone_id);
@@ -489,6 +515,8 @@ static void do_cycle(color_ostream &out) {
         DEBUG(cycle,out).print("tracking zone assignments: bedrooms: %zd, offices: %zd, dining halls: %zd, tombs: %zd\n",
             last_known_assignments_bedroom.size(), last_known_assignments_office.size(),
             last_known_assignments_dining.size(), last_known_assignments_tomb.size());
+
+        scrub_reservations(out);
     }
 
     if (config.get_bool(CONFIG_TRACK_ROLES)) {