add some hover action to the overlay

plugins/lua/stockpiles.lua

@@ -6,12 +6,13 @@ local logistics = require('plugins.logistics')
 local overlay = require('plugins.overlay')
 local widgets = require('gui.widgets')
 
-local STOCKPILES_DIR = "dfhack-config/stockpiles";
+local STOCKPILES_DIR = 'dfhack-config/stockpiles';
-local STOCKPILES_LIBRARY_DIR = "hack/data/stockpiles";
+local STOCKPILES_LIBRARY_DIR = 'hack/data/stockpiles';
 
 --------------------
 -- plugin logic
 --------------------
+
 local function get_sp_name(name, num)
     if #name > 0 then return name end
     return ('Stockpile %d'):format(num)
@@ -26,7 +27,7 @@ local function print_status()
         print(STATUS_FMT:format('ID', 'Name'))
         print(STATUS_FMT:format('------', '----------'))
     end
-    for _,sp in ipairs(sps) do
+    for _, sp in ipairs(sps) do
         print(STATUS_FMT:format(sp.id, get_sp_name(sp.name, sp.stockpile_number)))
     end
 end
@@ -38,16 +39,14 @@ local function list_dir(path, prefix, filters)
         return
     end
     local normalized_filters = {}
-    for _,filter in ipairs(filters or {}) do
+    for _, filter in ipairs(filters or {}) do table.insert(normalized_filters, filter:lower()) end
-        table.insert(normalized_filters, filter:lower())
+    for _, v in ipairs(paths) do
-    end
-    for _,v in ipairs(paths) do
         local normalized_path = prefix .. v.path:lower()
         if v.isdir or not normalized_path:endswith('.dfstock') then goto continue end
         normalized_path = normalized_path:sub(1, -9)
         if #normalized_filters > 0 then
             local matched = false
-            for _,filter in ipairs(normalized_filters) do
+            for _, filter in ipairs(normalized_filters) do
                 if normalized_path:find(filter, 1, true) then
                     matched = true
                     break
@@ -66,9 +65,7 @@ local function list_settings_files(filters)
 end
 
 local function assert_safe_name(name)
-    if not name or #name == 0 then
+    if not name or #name == 0 then qerror('name missing or empty') end
-        qerror('name missing or empty')
-    end
     if name:find('[^%w._]') then
         qerror('name can only contain numbers, letters, periods, and underscores')
     end
@@ -81,27 +78,19 @@ local function get_sp_id(opts)
     return nil
 end
 
-local included_elements = {
+local included_elements = {containers=1, general=2, categories=4, types=8, features=16}
-    containers=1,
-    general=2,
-    categories=4,
-    types=8,
-    features=16,
-}
 
 function export_stockpile(name, opts)
     assert_safe_name(name)
     name = STOCKPILES_DIR .. '/' .. name
 
     local includedElements = 0
-    for _,inc in ipairs(opts.includes) do
+    for _, inc in ipairs(opts.includes) do
         includedElements = includedElements | included_elements[inc]
     end
 
     if includedElements == 0 then
-        for _,v in pairs(included_elements) do
+        for _, v in pairs(included_elements) do includedElements = includedElements | v end
-            includedElements = includedElements | v
-        end
     end
 
     stockpiles_export(name, get_sp_id(opts), includedElements)
@@ -132,10 +121,8 @@ end
 
 local function parse_include(arg)
     local includes = argparse.stringList(arg, 'include')
-    for _,v in ipairs(includes) do
+    for _, v in ipairs(includes) do
-        if not included_elements[v] then
+        if not included_elements[v] then qerror(('invalid included element: "%s"'):format(v)) end
-            qerror(('invalid included element: "%s"'):format(v))
-        end
     end
     return includes
 end
@@ -143,9 +130,7 @@ end
 local valid_modes = {set=true, enable=true, disable=true}
 
 local function parse_mode(arg)
-    if not valid_modes[arg] then
+    if not valid_modes[arg] then qerror(('invalid mode: "%s"'):format(arg)) end
-        qerror(('invalid mode: "%s"'):format(arg))
-    end
     return arg
 end
 
@@ -160,25 +145,49 @@ local function process_args(opts, args)
     opts.filters = {}
 
     return argparse.processArgsGetopt(args, {
-            {'f', 'filter', hasArg=true,
+        {
-            handler=function(arg) opts.filters = argparse.stringList(arg) end},
+            'h',
-            {'h', 'help', handler=function() opts.help = true end},
+            'help',
-            {'i', 'include', hasArg=true,
+            handler=function()
-             handler=function(arg) opts.includes = parse_include(arg) end},
+                opts.help = true
-            {'m', 'mode', hasArg=true,
+            end,
-             handler=function(arg) opts.mode = parse_mode(arg) end},
+        }, {
-            {'s', 'stockpile', hasArg=true,
+            'm',
-             handler=function(arg) opts.id = argparse.nonnegativeInt(arg, 'stockpile') end},
+            'mode',
-        })
+            hasArg=true,
+            handler=function(arg)
+                opts.mode = parse_mode(arg)
+            end,
+        }, {
+            'f',
+            'filter',
+            hasArg=true,
+            handler=function(arg)
+                opts.filters = argparse.stringList(arg)
+            end,
+        }, {
+            'i',
+            'include',
+            hasArg=true,
+            handler=function(arg)
+                opts.includes = parse_include(arg)
+            end,
+        }, {
+            's',
+            'stockpile',
+            hasArg=true,
+            handler=function(arg)
+                opts.id = argparse.nonnegativeInt(arg, 'stockpile')
+            end,
+        },
+    })
 end
 
 function parse_commandline(args)
     local opts = {}
     local positionals = process_args(opts, args)
 
-    if opts.help or not positionals then
+    if opts.help or not positionals then return false end
-        return false
-    end
 
     local command = table.remove(positionals, 1)
     if not command or command == 'status' then
@@ -196,115 +205,182 @@ function parse_commandline(args)
     return true
 end
 
+--
+-- dialogs
 --------------------
+
+StockpilesExport = defclass(StockpilesExport, widgets.Window)
+StockpilesExport.ATTRS{
+    frame_title='My Window',
+    frame={w=50, h=45},
+    resizable=true,
+    resize_min={w=50, h=20}, -- try to allow users to shrink your windows
+}
+
+function StockpilesExport:init()
+    self:addviews{
+        -- add subview widgets here
+    }
+end
+
+function StockpilesExport:onInput(keys)
+    -- if required
+end
+
+StockpilesExportScreen = defclass(StockpilesExportScreen, gui.ZScreenModal)
+StockpilesExportScreen.ATTRS{focus_path='stockpiles/export'}
+
+function StockpilesExportScreen:init()
+    self:addviews{StockpilesExport{}}
+end
+
+function StockpilesExportScreen:onDismiss()
+    export_view = nil
+end
+
+local function do_export()
+    export_view = export_view and export_view:raise() or StockpilesExportScreen{}:show()
+end
+
+--
 -- StockpilesOverlay
 --------------------
 
 StockpilesOverlay = defclass(StockpilesOverlay, overlay.OverlayWidget)
 StockpilesOverlay.ATTRS{
-    default_pos = {x = 53, y = -6},
+    default_pos={x=53, y=-6},
-    default_enabled = true,
+    default_enabled=true,
-    viewscreens = 'dwarfmode/Some/Stockpile',
+    viewscreens='dwarfmode/Some/Stockpile',
-    frame = {w = 27, h = 10},
+    frame={w=27, h=11},
 }
 
 function StockpilesOverlay:init()
     self.minimized = false
-
+    self.hovered = false
-    local main_panel = widgets.Panel{
+
-        frame = {t = 0, l = 0, r = 0, b = 0},
+    local main_panel = widgets.ResizingPanel{
-        frame_style = gui.MEDIUM_FRAME,
+        view_id='main',
-        frame_background = gui.CLEAR_PEN,
+        frame={t=0, l=0, r=0},
-        visible = function() return not self.minimized end,
+        frame_style=gui.MEDIUM_FRAME,
-        subviews = {
+        frame_background=gui.CLEAR_PEN,
+        autoarrange_subviews=true,
+        visible=function()
+            return not self.minimized
+        end,
+        subviews={
             widgets.HotkeyLabel{
-                frame = {t = 0, l = 0},
+                frame={t=0, l=0},
-                label = 'apply settings',
+                label='apply settings',
-                key = 'CUSTOM_CTRL_I',
+                key='CUSTOM_CTRL_I',
-                auto_width = true,
+                on_activate=do_import,
-                on_activate = do_import,
+            }, widgets.HotkeyLabel{
-            },
+                frame={t=1, l=0},
-            widgets.HotkeyLabel{
+                label='export settings',
-                frame = {t = 1, l = 0},
+                key='CUSTOM_CTRL_E',
-                label = 'export settings',
+                on_activate=do_export,
-                key = 'CUSTOM_CTRL_E',
+            }, widgets.Panel{
-                auto_width = true,
+                frame={t=2, h=4},
-                on_activate = do_export,
+                subviews={
-            },
+                    widgets.Label{
-            widgets.Label{
+                        frame={t=1, l=0, h=2},
-                frame = {t = 3, l = 0},
+                        auto_height=false,
-                text = {
+                        text={'Designate items brought', NEWLINE, 'to this stockpile for:'},
-                    'Designate items brought', NEWLINE,
+                    },
-                    'to this stockpile for:'
                 },
-            },
+                visible=function()
-            widgets.ToggleHotkeyLabel{
+                    return self.hovered or self.subviews.melt:getOptionValue() or
-                view_id = 'melt',
+                                   self.subviews.trade:getOptionValue() or
-                frame = {t = 5, l = 2},
+                                   self.subviews.dump:getOptionValue()
-                label = 'melting',
+                end,
-                key = 'CUSTOM_CTRL_M',
+            }, widgets.ToggleHotkeyLabel{
-                on_change = self:callback('toggleLogisticsFeature', 'melt'),
+                view_id='melt',
-            },
+                frame={t=6, l=2},
-            widgets.ToggleHotkeyLabel{
+                label='melting',
-                view_id = 'trade',
+                key='CUSTOM_CTRL_M',
-                frame = {t = 6, l = 2},
+                on_change=self:callback('toggleLogisticsFeature', 'melt'),
-                label = 'trading',
+                visible=function()
-                key = 'CUSTOM_CTRL_T',
+                    return self.hovered or self.subviews.melt:getOptionValue()
-                on_change = self:callback('toggleLogisticsFeature', 'trade'),
+                end,
-            },
+            }, widgets.ToggleHotkeyLabel{
-            widgets.ToggleHotkeyLabel{
+                view_id='trade',
-                view_id = 'dump',
+                frame={t=7, l=2},
-                frame = {t = 7, l = 2},
+                label='trading',
-                label = 'dumping',
+                key='CUSTOM_CTRL_T',
-                key = 'CUSTOM_CTRL_D',
+                on_change=self:callback('toggleLogisticsFeature', 'trade'),
-                on_change = self:callback('toggleLogisticsFeature', 'dump'),
+                visible=function()
+                    return self.hovered or self.subviews.trade:getOptionValue()
+                end,
+            }, widgets.ToggleHotkeyLabel{
+                view_id='dump',
+                frame={t=8, l=2},
+                label='dumping',
+                key='CUSTOM_CTRL_D',
+                on_change=self:callback('toggleLogisticsFeature', 'dump'),
+                visible=function()
+                    return self.hovered or self.subviews.dump:getOptionValue()
+                end,
             },
         },
     }
 
     local minimized_panel = widgets.Panel{
-        frame = {t = 0, r = 0, w = 3, h = 1},
+        frame={t=0, r=0, w=3, h=1},
-        subviews = {
+        subviews={
-            widgets.Label{
-                frame = {t = 0, l = 0, w = 1, h = 1},
-                text = '[',
-                text_pen = COLOR_RED,
-                visible = function() return self.minimized end,
-            },
             widgets.Label{
-                frame = {t = 0, l = 1, w = 1, h = 1},
+                frame={t=0, l=0, w=1, h=1},
-                text = {{text = function() return self.minimized and string.char(31) or string.char(30) end}},
+                text='[',
-                text_pen = dfhack.pen.parse{fg = COLOR_BLACK, bg = COLOR_GREY},
+                text_pen=COLOR_RED,
-                text_hpen = dfhack.pen.parse{fg = COLOR_BLACK, bg = COLOR_WHITE},
+                visible=function()
-                on_click = function() self.minimized = not self.minimized end,
+                    return self.minimized
-            },
+                end,
-            widgets.Label{
+            }, widgets.Label{
-                frame = {t = 0, r = 0, w = 1, h = 1},
+                frame={t=0, l=1, w=1, h=1},
-                text = ']',
+                text={
-                text_pen = COLOR_RED,
+                    {
-                visible = function() return self.minimized end,
+                        text=function()
+                            return self.minimized and string.char(31) or string.char(30)
+                        end,
+                    },
+                },
+                text_pen=dfhack.pen.parse{fg=COLOR_BLACK, bg=COLOR_GREY},
+                text_hpen=dfhack.pen.parse{fg=COLOR_BLACK, bg=COLOR_WHITE},
+                on_click=self:callback('toggleMinimized'),
+            }, widgets.Label{
+                frame={t=0, r=0, w=1, h=1},
+                text=']',
+                text_pen=COLOR_RED,
+                visible=function()
+                    return self.minimized
+                end,
             },
         },
     }
 
-    self:addviews{
+    self:addviews{main_panel, minimized_panel}
-        main_panel,
-        minimized_panel,
-    }
 end
 
 function StockpilesOverlay:overlay_onupdate()
+    -- periodically pick up changes made from other interfaces
     self.cur_stockpile = nil
 end
 
 function StockpilesOverlay:onRenderFrame()
     local sp = dfhack.gui.getSelectedStockpile()
+    local sp_updated = false
     if self.cur_stockpile ~= sp then
         local config = logistics.logistics_getStockpileConfigs(sp.stockpile_number)[1]
         self.subviews.melt:setOption(config.melt == 1)
         self.subviews.trade:setOption(config.trade == 1)
         self.subviews.dump:setOption(config.dump == 1)
         self.cur_stockpile = sp
+        sp_updated = true
+    end
+    local prev_hovered = self.hovered
+    self.hovered = not not (self.hovered and self:getMouseFramePos() or
+                           self.subviews.main:getMousePos())
+    if self.hovered ~= prev_hovered or sp_updated then
+        self:updateLayout()
+        df.global.gps.force_full_display_count = 1
     end
 end
 
@@ -313,20 +389,24 @@ function StockpilesOverlay:toggleLogisticsFeature(feature)
     local config = logistics.logistics_getStockpileConfigs(sp.stockpile_number)[1]
     -- logical xor
     logistics.logistics_setStockpileConfig(config.stockpile_number,
-        (feature == 'melt') ~= (config.melt == 1),
+            (feature == 'melt') ~= (config.melt == 1), (feature == 'trade') ~= (config.trade == 1),
-        (feature == 'trade') ~= (config.trade == 1),
+            (feature == 'dump') ~= (config.dump == 1))
-        (feature == 'dump') ~= (config.dump == 1))
+    self.cur_stockpile = nil
+end
+
+function StockpilesOverlay:toggleMinimized()
+    self.minimized = not self.minimized
+    self.cur_stockpile = nil
 end
 
 function StockpilesOverlay:onInput(keys)
     if keys.CUSTOM_ALT_M then
-        self.minimized = not self.minimized
+        self:toggleMinimized()
         return true
     end
     return StockpilesOverlay.super.onInput(self, keys)
 end
 
-OVERLAY_WIDGETS = {
+OVERLAY_WIDGETS = {overlay=StockpilesOverlay}
-    overlay = StockpilesOverlay,
+
-}
 return _ENV