implement import/export/autoload for work details

Author: myk002

changelog.txt

@@ -29,6 +29,7 @@ Template for new versions:
 ## New Tools
 
 ## New Features
+- `gui/settings-manager`: add import, export, and autoload for work details
 
 ## Fixes
 

docs/gui/settings-manager.rst

@@ -16,14 +16,18 @@ Usage
     gui/settings-manager load-difficulty
     gui/settings-manager save-standing-orders
     gui/settings-manager load-standing-orders
+    gui/settings-manager save-work-details
+    gui/settings-manager load-work-details
 
 Difficulty can be saved and loaded on the embark "preparation" screen or in an
-active fort. Standing orders can only be saved and loaded in an active fort.
+active fort. Standing orders and work details can only be saved and loaded in
+an active fort.
 
 If auto-restoring of difficulty settings is turned on, it happens when the
-embark "preparation" screen is loaded. If auto-restoring of standing orders
-settings is turned on, it happens when the fort is loaded for the first time
-(just like all other Autostart commands configured in `gui/control-panel`).
+embark "preparation" screen is loaded. If auto-restoring of standing orders or
+work details definitions is turned on, it happens when the fort is loaded for
+the first time (just like all other Autostart commands configured in
+`gui/control-panel`).
 
 Overlays
 --------
@@ -39,3 +43,12 @@ You will see a new panel that allows you to save and restore your settings for
 standing orders. You can also toggle whether the saved standing orders are
 automatically restored when you embark on a new fort. This will toggle the
 relevant command in `gui/control-panel` on the Automation -> Autostart page.
+
+There is a similar panel on the Labor -> Work Details page that allows for
+saving and restoring of work detail definitons. Be aware that work detail
+assignments to units cannot be saved, so you have to assign the work details to
+individual units after you restore the definitions. Another caveat is that DF
+doesn't evaluate work detail definitions until a change (any change) is made on
+the work details screen. Therefore, after importing work detail definitions,
+including auto-loading them for new embarks, you have to go to the work details
+page and make a change before your imported work details will take effect.

gui/settings-manager.lua

@@ -227,54 +227,30 @@ function DifficultySettingsOverlay:get_df_struct()
 end
 
 ------------------------------
--- StandingOrdersOverlay
+-- ImportExportAutoOverlay
 --
 
-StandingOrdersOverlay = defclass(StandingOrdersOverlay, overlay.OverlayWidget)
-StandingOrdersOverlay.ATTRS {
-    desc='Adds buttons to the standing orders screen for saving and restoring settings.',
-    default_pos={x=6, y=-5},
-    viewscreens='dwarfmode/Info/LABOR/STANDING_ORDERS/AUTOMATED_WORKSHOPS',
+ImportExportAutoOverlay = defclass(ImportExportAutoOverlay, overlay.OverlayWidget)
+ImportExportAutoOverlay.ATTRS {
     default_enabled=true,
-    frame={w=78, h=5},
     frame_style=gui.MEDIUM_FRAME,
     frame_background=gui.CLEAR_PEN,
+    save_label=DEFAULT_NIL,
+    load_label=DEFAULT_NIL,
+    auto_label=DEFAULT_NIL,
+    save_fn=DEFAULT_NIL,
+    load_fn=DEFAULT_NIL,
+    has_data_fn=DEFAULT_NIL,
+    autostart_command=DEFAULT_NIL,
 }
 
-local li = df.global.plotinfo.labor_info
-
-local function save_standing_orders()
-    local standing_orders = {}
-    for name, val in pairs(df.global) do
-        if name:startswith('standing_orders_') then
-            standing_orders[name] = val
-        end
-    end
-    config.data.standing_orders = standing_orders
-    local chores = {}
-    chores.enabled = li.flags.children_do_chores
-    chores.labors = utils.clone(li.chores)
-    config.data.chores = chores
-    config:write()
-end
-
-local function load_standing_orders()
-    for name, val in pairs(config.data.standing_orders or {}) do
-        df.global[name] = val
-    end
-    li.flags.children_do_chores = not not safe_index(config.data.chores, 'enabled')
-    for i, val in ipairs(safe_index(config.data.chores, 'labors') or {}) do
-        li.chores[i-1] = val
-    end
-end
-
-function StandingOrdersOverlay:init()
+function ImportExportAutoOverlay:init()
     self:addviews{
         widgets.HotkeyLabel{
             view_id='save',
             frame={l=0, t=0, w=39},
             key='CUSTOM_CTRL_E',
-            label='Save standing orders (all tabs)',
+            label=self.save_label,
             on_activate=self:callback('do_save'),
         },
         widgets.Label{
@@ -288,9 +264,9 @@ function StandingOrdersOverlay:init()
             view_id='load',
             frame={l=42, t=0, w=34},
             key='CUSTOM_CTRL_I',
-            label='Load saved standing orders',
+            label=self.load_label,
             on_activate=self:callback('do_load'),
-            enabled=function() return next(config.data.standing_orders or {}) end,
+            enabled=self.has_data_fn,
         },
         widgets.Label{
             view_id='load_flash',
@@ -303,38 +279,37 @@ function StandingOrdersOverlay:init()
             view_id='auto',
             frame={l=0, t=2},
             key='CUSTOM_CTRL_A',
-            label='Apply saved settings for new embarks:',
+            label=self.auto_label,
             on_change=self:callback('do_auto'),
-            enabled=function() return next(config.data.standing_orders or {}) end,
+            enabled=self.has_data_fn,
         },
     }
 end
 
-function StandingOrdersOverlay:do_save()
+function ImportExportAutoOverlay:do_save()
     flash(self, 'save')
-    save_standing_orders()
+    self.save_fn()
 end
 
-function StandingOrdersOverlay:do_load()
+function ImportExportAutoOverlay:do_load()
     flash(self, 'load')
-    load_standing_orders()
+    self.load_fn()
 end
 
-local autostart_command = 'gui/settings-manager load-standing-orders'
-
-SOMessage = defclass(SOMessage, widgets.Window)
-SOMessage.ATTRS {
+AutoMessage = defclass(AutoMessage, widgets.Window)
+AutoMessage.ATTRS {
     frame={w=61, h=9},
+    autostart_command=DEFAULT_NIL,
     enabled=DEFAULT_NIL,
 }
 
-function SOMessage:init()
+function AutoMessage:init()
     self:addviews{
         widgets.Label{
             view_id='label',
             frame={t=0, l=0},
             text={
-                'The "', autostart_command, '" command', NEWLINE,
+                'The "', self.autostart_command, '" command', NEWLINE,
                 'has been ',
                 {text=self.enabled and 'enabled' or 'disabled', pen=self.enabled and COLOR_GREEN or COLOR_LIGHTRED},
                 ' in the ',
@@ -363,37 +338,173 @@ function SOMessage:init()
     }
 end
 
-SOMessageScreen = defclass(SOMessageScreen, gui.ZScreenModal)
-SOMessageScreen.ATTRS {
+AutoMessageScreen = defclass(AutoMessageScreen, gui.ZScreenModal)
+AutoMessageScreen.ATTRS {
     focus_path='settings-manager/prompt',
+    autostart_command=DEFAULT_NIL,
     enabled=DEFAULT_NIL,
 }
 
-function SOMessageScreen:init()
+function AutoMessageScreen:init()
     self:addviews{
-        SOMessage{
+        AutoMessage{
             frame_title=(self.enabled and 'Enabled' or 'Disabled')..' auto-restore',
-            enabled=self.enabled
+            autostart_command=self.autostart_command,
+            enabled=self.enabled,
         },
     }
 end
 
-function StandingOrdersOverlay:do_auto(val)
-    dfhack.run_script('control-panel', (val and '' or 'no') .. 'autostart', autostart_command)
-    SOMessageScreen{enabled=val}:show()
+function ImportExportAutoOverlay:do_auto(val)
+    dfhack.run_script('control-panel', (val and '' or 'no') .. 'autostart', self.autostart_command)
+    AutoMessageScreen{autostart_command=self.autostart_command, enabled=val}:show()
 end
 
-function StandingOrdersOverlay:onRenderFrame(dc, rect)
-    StandingOrdersOverlay.super.onRenderFrame(self, dc, rect)
-    local enabled = control_panel.get_autostart(autostart_command)
+function ImportExportAutoOverlay:onRenderFrame(dc, rect)
+    ImportExportAutoOverlay.super.onRenderFrame(self, dc, rect)
+    local enabled = control_panel.get_autostart(self.autostart_command)
     self.subviews.auto:setOption(enabled)
 end
 
+------------------------------
+-- StandingOrdersOverlay
+--
+
+local li = df.global.plotinfo.labor_info
+
+local function save_standing_orders()
+    local standing_orders = {}
+    for name, val in pairs(df.global) do
+        if name:startswith('standing_orders_') then
+            standing_orders[name] = val
+        end
+    end
+    config.data.standing_orders = standing_orders
+    local chores = {}
+    chores.enabled = li.flags.children_do_chores
+    chores.labors = utils.clone(li.chores)
+    config.data.chores = chores
+    config:write()
+end
+
+local function load_standing_orders()
+    for name, val in pairs(config.data.standing_orders or {}) do
+        df.global[name] = val
+    end
+    li.flags.children_do_chores = not not safe_index(config.data.chores, 'enabled')
+    for i, val in ipairs(safe_index(config.data.chores, 'labors') or {}) do
+        li.chores[i-1] = val
+    end
+end
+
+local function has_saved_standing_orders()
+    return next(config.data.standing_orders or {})
+end
+
+StandingOrdersOverlay = defclass(StandingOrdersOverlay, ImportExportAutoOverlay)
+StandingOrdersOverlay.ATTRS {
+    desc='Adds buttons to the standing orders screen for saving and restoring settings.',
+    default_pos={x=6, y=-5},
+    viewscreens='dwarfmode/Info/LABOR/STANDING_ORDERS/AUTOMATED_WORKSHOPS',
+    frame={w=78, h=5},
+    save_label='Save standing orders (all tabs)',
+    load_label='Load saved standing orders',
+    auto_label='Apply saved settings for new embarks:',
+    save_fn=save_standing_orders,
+    load_fn=load_standing_orders,
+    has_data_fn=has_saved_standing_orders,
+    autostart_command='gui/settings-manager load-standing-orders',
+}
+
+------------------------------
+-- WorkDetailsOverlay
+--
+
+local function clone_wd_flags(flags)
+    return {
+        cannot_be_everybody=flags.cannot_be_everybody,
+        no_modify=flags.no_modify,
+        mode=flags.mode,
+    }
+end
+
+local function save_work_details()
+    local details = {}
+    for idx, wd in ipairs(li.work_details) do
+        local detail = {
+            name=wd.name,
+            icon=wd.icon,
+            work_detail_flags=clone_wd_flags(wd.work_detail_flags),
+            allowed_labors=utils.clone(wd.allowed_labors),
+        }
+        details[idx+1] = detail
+    end
+    config.data.work_details = details
+    config:write()
+end
+
+local function load_work_details()
+    if not config.data.work_details or #config.data.work_details < 10 then
+        -- not enough data to cover built-in work details
+        return
+    end
+    li.work_details:resize(#config.data.work_details)
+    -- keep unit assignments for overwritten indices
+    for idx, wd in ipairs(config.data.work_details) do
+        local detail = {
+            new=df.work_detail,
+            name=wd.name,
+            icon=wd.icon,
+            work_detail_flags=wd.work_detail_flags,
+        }
+        li.work_details[idx-1] = detail
+        local al = li.work_details[idx-1].allowed_labors
+        for i,v in ipairs(wd.allowed_labors) do
+            al[i-1] = v
+        end
+    end
+    local scr = dfhack.gui.getDFViewscreen(true)
+    if dfhack.gui.matchFocusString('dwarfmode/Info/LABOR/WORK_DETAILS', scr) then
+        gui.simulateInput(scr, 'LEAVESCREEN')
+        gui.simulateInput(scr, 'D_LABOR')
+    end
+end
+
+local function has_saved_work_details()
+    return next(config.data.work_details or {})
+end
+
+WorkDetailsOverlay = defclass(WorkDetailsOverlay, ImportExportAutoOverlay)
+WorkDetailsOverlay.ATTRS {
+    desc='Adds buttons to the work details screen for saving and restoring settings.',
+    default_pos={x=80, y=-5},
+    viewscreens='dwarfmode/Info/LABOR/WORK_DETAILS',
+    frame={w=35, h=5},
+    save_label='Save work details',
+    load_label='Load work details',
+    auto_label='Load for new embarks:',
+    save_fn=save_work_details,
+    load_fn=load_work_details,
+    has_data_fn=has_saved_work_details,
+    autostart_command='gui/settings-manager load-work-details',
+}
+
+function WorkDetailsOverlay:init()
+    self.subviews.save.frame.w = 25
+    self.subviews.save_flash.frame.l = 10
+    self.subviews.load.frame.t = 1
+    self.subviews.load.frame.l = 0
+    self.subviews.load.frame.w = 25
+    self.subviews.load_flash.frame.t = 1
+    self.subviews.load_flash.frame.l = 10
+end
+
 OVERLAY_WIDGETS = {
     embark_difficulty=DifficultyEmbarkOverlay,
     embark_notification=DifficultyEmbarkNotificationOverlay,
     settings_difficulty=DifficultySettingsOverlay,
     standing_orders=StandingOrdersOverlay,
+    work_details=WorkDetailsOverlay,
 }
 
 if dfhack_flags.module then
@@ -447,6 +558,16 @@ elseif command == 'load-standing-orders' then
     else
         qerror('must be in a loaded fort')
     end
+elseif command == 'save-work-details' then
+    if is_fort then save_work_details()
+    else
+        qerror('must be in a loaded fort')
+    end
+elseif command == 'load-work-details' then
+    if is_fort then load_work_details()
+    else
+        qerror('must be in a loaded fort')
+    end
 else
     print(dfhack.script_help())
 end

internal/control-panel/registry.lua

@@ -40,6 +40,8 @@ COMMANDS_BY_IDX = {
         params={'--time', '1', '--timeUnits', 'months', '--command', '[', 'cleanowned', 'X', ']'}},
     {command='gui/settings-manager load-standing-orders', group='automation', mode='run',
         desc='Go to the Standing Orders tab in the Labor screen to save your current settings.'},
+    {command='gui/settings-manager load-work-details', group='automation', mode='run',
+        desc='Go to the Work Details tab in the Labor screen to save your current definitions.'},
     {command='nestboxes', group='automation', mode='enable'},
     {command='orders-sort', help_command='orders', group='automation', mode='repeat',
         desc='Sort manager orders by repeat frequency so one-time orders can be completed.',