Merge pull request #1298 from myk002/myk_export

[exportlegends] add race filter on histfig page

Author: myk002

changelog.txt

@@ -37,6 +37,7 @@ Template for new versions:
 - `caravan`: If you have managed to select an item that is ethically unacceptable to the merchant, an "Ethics warning" badge will now appear next to the "Trade" button. Clicking on the badge will show you which items that you have selected are problematic. The dialog has a button that you can click to deselect the problematic items in the trade list.
 - `confirm`: If you have ethically unacceptable items selected for trade, the "Are you sure you want to trade" confirmation will warn you about them
 - `quickfort`: ``#zone`` blueprints now integrated with `preserve-rooms` so you can create a zone and automatically assign it to a noble or administrative role
+- `exportlegends`: option to filter by race on historical figures page
 
 ## Fixes
 - `timestream`: ensure child growth events (that is, a child's transition to adulthood) are not skipped; existing "overage" children will be automatically fixed within a year

docs/exportlegends.rst

@@ -11,7 +11,10 @@ about your world so that it can be browsed with external programs like
 get with vanilla export functionality, and many external tools depend on this
 extra information.
 
-By default, ``exportlegends`` hooks into the standard vanilla ``Export XML`` button and runs in the background when you click it, allowing both the vanilla export and the extended data export to execute simultaneously. You can continue to browse legends mode via the vanilla UI while the export is running.
+By default, ``exportlegends`` hooks into the standard vanilla ``Export XML``
+button and runs in the background when you click it, allowing both the vanilla
+export and the extended data export to execute simultaneously. You can continue
+to browse legends mode via the vanilla UI while the export is running.
 
 To use:
 
@@ -35,7 +38,11 @@ Usage
 Overlay
 -------
 
-This script also provides an overlay that is managed by the `overlay` framework.
+This script also provides several overlays that are managed by the `overlay`
+framework.
+
+**exportlegends.export**
+
 When the overlay is enabled, a toggle for exporting extended legends data will
 appear below the vanilla "Export XML" button. If the toggle is enabled when the
 "Export XML" button is clicked, then ``exportlegends`` will run alongside the
@@ -45,6 +52,13 @@ While the extended data is being exported, a status line will appear in place
 of the toggle, reporting the current export target and the overall percent
 complete.
 
-There is an additional overlay that masks out the "Done" button while the
-extended export is running. This prevents the player from exiting legends mode
-before the export is complete.
+**exportlegends.mask**
+
+This overlay masks out the "Done" button while the extended export is running.
+This prevents the player from accidentally exiting legends mode before the
+export is complete.
+
+**exportlegends.histfigfilter**
+
+This overlay adds a filter widget to the Historical Figures legends page.
+Clicking the widget allows you to filter the list of historical figures by race.

exportlegends.lua

@@ -2,10 +2,11 @@
 --luacheck-flags: strictsubtype
 --@ module=true
 
-local gui = require('gui')
-local overlay = require('plugins.overlay')
+local asyncexport = reqscript('internal/exportlegends/asyncexport')
+local racefilter = reqscript('internal/exportlegends/racefilter')
 local script = require('gui.script')
-local widgets = require('gui.widgets')
+
+local GLOBAL_KEY = 'exportlegends'
 
 -- Get the date of the world as a string
 -- Format: "YYYYY-MM-DD"
@@ -42,10 +43,7 @@ local function table_containskey(self, key)
     return false
 end
 
-progress_item = progress_item or ''
-num_done = num_done or -1
-num_total = num_total or -1
-last_update_ms = 0
+local last_update_ms = 0
 
 -- should be frequent enough so that user can still effectively use
 -- the vanilla legends UI to browse while export is in progress
@@ -62,12 +60,12 @@ end
 --luacheck: skip
 local function progress_ipairs(vector, desc, skip_count, interval)
     desc = desc or 'item'
-    progress_item = desc
+    asyncexport.progress_item = desc
     interval = interval or 10000
     local cb = ipairs(vector)
     return function(vector, k, ...)
         if not skip_count then
-            num_done = num_done + 1
+            asyncexport.num_done = asyncexport.num_done + 1
         end
         if k then
             if #vector >= interval and (k % interval == 0 or k == #vector - 1) then
@@ -80,7 +78,7 @@ local function progress_ipairs(vector, desc, skip_count, interval)
 end
 
 local function make_chunk(name, vector, fn)
-    num_total = num_total + #vector
+    asyncexport.num_total = asyncexport.num_total + #vector
     return {
         name=name,
         vector=vector,
@@ -1016,113 +1014,32 @@ local function export_more_legends_xml()
 end
 
 local function wrap_export()
-    if num_total >= 0 then
+    if asyncexport.num_total >= 0 then
         qerror('exportlegends already in progress')
     end
-    num_total = 0
-    num_done = 0
-    progress_item = 'basic info'
+    asyncexport.num_total = 0
+    asyncexport.num_done = 0
+    asyncexport.progress_item = 'basic info'
     yield_if_timeout()
     local ok, err = pcall(export_more_legends_xml)
     if not ok then
         dfhack.printerr(err)
     end
-    num_total = -1
-    num_done = -1
-    progress_item = ''
-end
-
--- -------------------
--- LegendsOverlay
---
-
-LegendsOverlay = defclass(LegendsOverlay, overlay.OverlayWidget)
-LegendsOverlay.ATTRS{
-    desc='Adds extended export progress bar to the legends main screen.',
-    default_pos={x=2, y=2},
-    default_enabled=true,
-    viewscreens='legends/Default',
-    frame={w=55, h=5},
-}
-
-function LegendsOverlay:init()
-    self:addviews{
-        widgets.Panel{
-            view_id='button_mask',
-            frame={t=0, l=0, w=15, h=3},
-        },
-        widgets.BannerPanel{
-            frame={b=0, l=0, r=0, h=1},
-            subviews={
-                widgets.ToggleHotkeyLabel{
-                    view_id='do_export',
-                    frame={t=0, l=1, r=1},
-                    label='Also export DFHack extended legends data:',
-                    key='CUSTOM_CTRL_D',
-                    visible=function() return num_total < 0 end,
-                },
-                widgets.Label{
-                    frame={t=0, l=1},
-                    text={
-                        'Exporting ',
-                        {width=27, text=function() return progress_item end},
-                        ' ',
-                        {text=function() return ('%.2f'):format((num_done * 100) / num_total) end, pen=COLOR_YELLOW},
-                        '% complete'
-                    },
-                    visible=function() return num_total >= 0 end,
-                },
-            },
-        },
-    }
-end
-
-function LegendsOverlay:onInput(keys)
-    if keys._MOUSE_L and num_total < 0 and
-        self.subviews.button_mask:getMousePos() and
-        self.subviews.do_export:getOptionValue()
-    then
-        script.start(wrap_export)
-    end
-    return LegendsOverlay.super.onInput(self, keys)
+    asyncexport.reset_state()
 end
 
--- -------------------
--- DoneMaskOverlay
---
-
-DoneMaskOverlay = defclass(DoneMaskOverlay, overlay.OverlayWidget)
-DoneMaskOverlay.ATTRS{
-    desc='Prevents legends mode from being exited while an export is in progress.',
-    default_pos={x=-2, y=2},
-    default_enabled=true,
-    viewscreens='legends',
-    frame={w=9, h=3},
+OVERLAY_WIDGETS = {
+    export=asyncexport.LegendsOverlay,
+    mask=asyncexport.DoneMaskOverlay,
+    histfigfilter=racefilter.RaceFilterOverlay,
 }
 
-function DoneMaskOverlay:init()
-    self:addviews{
-        widgets.Panel{
-            frame_background=gui.CLEAR_PEN,
-            visible=function() return num_total >= 0 end,
-        }
-    }
-end
-
-function DoneMaskOverlay:onInput(keys)
-    if num_total >= 0 then
-        if keys.LEAVESCREEN or (keys._MOUSE_L and self:getMousePos()) then
-            return true
-        end
+dfhack.onStateChange[GLOBAL_KEY] = function(sc)
+    if sc == SC_VIEWSCREEN_CHANGED and df.viewscreen_choose_game_typest:is_instance(dfhack.gui.getDFViewscreen(true)) then
+        asyncexport.reset_state()
     end
-    return DoneMaskOverlay.super.onInput(self, keys)
 end
 
-OVERLAY_WIDGETS = {
-    export=LegendsOverlay,
-    mask=DoneMaskOverlay,
-}
-
 if dfhack_flags.module then
     return
 end

internal/exportlegends/asyncexport.lua

@@ -0,0 +1,104 @@
+--@module = true
+
+local gui = require('gui')
+local overlay = require('plugins.overlay')
+local widgets = require('gui.widgets')
+
+progress_item = nil
+num_done = nil
+num_total = nil
+
+function reset_state()
+    progress_item = ''
+    num_done = -1
+    num_total = -1
+end
+reset_state()
+
+-- -------------------
+-- LegendsOverlay
+--
+
+LegendsOverlay = defclass(LegendsOverlay, overlay.OverlayWidget)
+LegendsOverlay.ATTRS{
+    desc='Adds extended export progress bar to the legends main screen.',
+    default_pos={x=2, y=2},
+    default_enabled=true,
+    viewscreens='legends',
+    frame={w=55, h=5},
+}
+
+function LegendsOverlay:init()
+    self:addviews{
+        widgets.Panel{
+            view_id='button_mask',
+            frame={t=0, l=0, w=15, h=3},
+        },
+        widgets.BannerPanel{
+            frame={b=0, l=0, r=0, h=1},
+            visible=function() return dfhack.gui.matchFocusString('legends/Default', dfhack.gui.getDFViewscreen(true)) end,
+            subviews={
+                widgets.ToggleHotkeyLabel{
+                    view_id='do_export',
+                    frame={t=0, l=1, r=1},
+                    label='Also export DFHack extended legends data:',
+                    key='CUSTOM_CTRL_D',
+                    visible=function() return num_total < 0 end,
+                },
+                widgets.Label{
+                    frame={t=0, l=1},
+                    text={
+                        'Exporting ',
+                        {width=27, text=function() return progress_item end},
+                        ' ',
+                        {text=function() return ('%.2f'):format((num_done * 100) / num_total) end, pen=COLOR_YELLOW},
+                        '% complete'
+                    },
+                    visible=function() return num_total >= 0 end,
+                },
+            },
+        },
+    }
+end
+
+function LegendsOverlay:onInput(keys)
+    if keys._MOUSE_L and self.subviews.button_mask:getMousePos() and self.subviews.do_export:getOptionValue() then
+        if num_total < 0 then
+            dfhack.run_script('exportlegends')
+        else
+            return true
+        end
+    end
+    return LegendsOverlay.super.onInput(self, keys)
+end
+
+-- -------------------
+-- DoneMaskOverlay
+--
+
+DoneMaskOverlay = defclass(DoneMaskOverlay, overlay.OverlayWidget)
+DoneMaskOverlay.ATTRS{
+    desc='Prevents legends mode from being exited while an export is in progress.',
+    default_pos={x=-2, y=2},
+    default_enabled=true,
+    viewscreens='legends',
+    frame={w=9, h=3},
+}
+
+function DoneMaskOverlay:init()
+    self:addviews{
+        widgets.Panel{
+            frame_background=gui.CLEAR_PEN,
+            visible=function() return num_total >= 0 end,
+        }
+    }
+end
+
+function DoneMaskOverlay:onInput(keys)
+    if num_total >= 0 then
+        if keys.LEAVESCREEN or (keys._MOUSE_L and self:getMousePos()) then
+            return true
+        end
+    end
+    return DoneMaskOverlay.super.onInput(self, keys)
+end