adapt to gui.dflayout overhaul

devel/dflayout now highlights the "demo" element when the mouse cursor
is over the (computed) real UI element

Author: ChrisJohnsen

devel/dflayout.lua

@@ -57,13 +57,13 @@ end
 --
 -- Note: The returned function does not return a separate body rect; subviews
 -- will be able to overwrite the normal UI-drawn frame!
----@param toolbar DFLayout.Toolbar
+---@param el DFLayout.DynamicUIElement
 ---@param dy_fn fun(): integer
 ---@return function
-local function get_computeFrame_fn(toolbar, dy_fn)
+local function get_computeFrame_fn(el, dy_fn)
     return function(self, parent_rect)
         local ir = gui.get_interface_rect()
-        local frame = toolbar.frame(ir)
+        local frame = el.frame_fn(ir)
         return gui.mkdims_wh(
             ir.x1 + frame.l,
             ir.y1 + frame.t + dy_fn(),
@@ -72,93 +72,182 @@ local function get_computeFrame_fn(toolbar, dy_fn)
     end
 end
 
----@param buttons DFLayout.Toolbar.NamedButtons
-local function buttons_string(buttons)
-    local sorted = {}
-    for _, button in pairs(buttons) do
-        utils.insert_sorted(sorted, button, 'offset')
+---@param buttons DFLayout.Toolbar.Layout
+local function buttons_tokens(buttons)
+    local sorted_buttons = {}
+    for button_name, button in pairs(buttons) do
+        utils.insert_sorted(sorted_buttons, {
+            name = button_name,
+            offset = button.offset,
+            width = button.width,
+        }, 'offset')
     end
-    -- For a one-column button, use | to indicate the button's position.
-    -- For wider buttons, use shapes like /\ or /--\ to illustrate the
-    -- button's position and width.
-    local str = ''
-    for i, o in ipairs(sorted) do
-        if o.offset > #str then
-            str = str .. (' '):rep(o.offset - #str)
-        end
-        if o.width == 1 then
-            str = str .. '|'
-        elseif o.width > 1 then
-            str = str .. '/' .. ('-'):rep(o.width - 2) .. '\\'
+    local offset = 0
+    local sorted_button_names = {}
+    local tokens_by_name = {}
+    for _, button_info in ipairs(sorted_buttons) do
+        table.insert(sorted_button_names, button_info.name)
+        local token = { gap = button_info.offset - offset, width = button_info.width }
+        if button_info.width == 1 then
+            -- For a one-column button, use | to indicate the button's position.
+            token.text = '|'
+        elseif button_info.width > 1 then
+            -- For wider buttons, use shapes like /\ or /--\ to illustrate the
+            -- button's position and width.
+            token.text = '/' .. ('-'):rep(button_info.width - 2) .. '\\'
         end
+        offset = button_info.offset + button_info.width
+        tokens_by_name[button_info.name] = token
     end
-    return str
+    return sorted_button_names, tokens_by_name
+end
+
+local normal_frame_style = function(...)
+    local style = gui.FRAME_THIN(...)
+    style.signature_pen = false
+    return style
 end
 
+local hover_frame_style = function(...)
+    local style = gui.FRAME_BOLD(...)
+    style.signature_pen = false
+    return style
+end
+
+---@class ToolbarDemo.ToolbarInfo
+---@field el DFLayout.DynamicUIElement
+---@field buttons DFLayout.Toolbar.Layout
+---@field button_els table<string, DFLayout.DynamicUIElement>
+---@field demo_dy fun(): integer
+
 ---@class ToolbarDemo.attrs: widgets.Panel.attrs
 ---@class ToolbarDemo.attrs.partial: widgets.Panel.attrs.partial
----@class ToolbarDemo.initTable: ToolbarDemo.attrs.partial, { toolbar?: DFLayout.Toolbar, toolbar_dy?: fun(): integer }
+---@field toolbar_info? ToolbarDemo.ToolbarInfo
+---@class ToolbarDemo.initTable: ToolbarDemo.attrs.partial
 ---@class ToolbarDemo: widgets.Panel
 ---@field super widgets.Panel
 ---@field ATTRS ToolbarDemo.attrs|fun(attributes: ToolbarDemo.attrs.partial)
 ---@overload fun(init_table: ToolbarDemo.initTable): self
 ToolbarDemo = defclass(ToolbarDemo, widgets.Panel)
 ToolbarDemo.ATTRS{
-    frame_style = function(...)
-        local style = gui.FRAME_THIN(...)
-        style.signature_pen = false
-        return style
-    end,
+    frame_style = normal_frame_style,
     visible = fort_toolbars_visible,
     frame_background = { ch = 32, bg = COLOR_BLACK },
 }
 
 ---@param args ToolbarDemo.initTable
 function ToolbarDemo:init(args)
     self.label = widgets.Label{ frame = { l = 0 } }
-    if args.toolbar and args.toolbar_dy then
-        self:update_to_toolbar(args.toolbar, args.toolbar_dy)
+    if args.toolbar_info then
+        self:update_to_toolbar(args.toolbar_info)
     end
     self:addviews{ self.label }
 end
 
----@param toolbar DFLayout.Toolbar
----@param dy fun(): integer
----@return unknown
-function ToolbarDemo:update_to_toolbar(toolbar, dy)
-    -- set button representation string
-    local text = buttons_string(toolbar.buttons)
-    local l_inset = 0
-    if text:sub(1, 1) == ' ' then
-        -- don't overwrite the left border edge with a plain space
-        l_inset = 1
-        text = text:sub(2)
+---@param toolbar_info ToolbarDemo.ToolbarInfo
+---@return ToolbarDemo
+function ToolbarDemo:update_to_toolbar(toolbar_info)
+    local order, named_tokens = buttons_tokens(toolbar_info.buttons)
+    function set_button_text(lit_button_name)
+        local lit = false
+        local tokens = {}
+        for _, name in ipairs(order) do
+            local token = copyall(named_tokens[name])
+            if name == lit_button_name then
+                lit = true
+                token.pen = { fg = COLOR_BLACK, bg = COLOR_BLUE }
+            end
+            table.insert(tokens, token)
+        end
+        self.label:setText(tokens)
+        return lit
     end
-    self.label.frame.l = l_inset
-    self.label:setText(text)
+
+    set_button_text()
 
     -- track actual toolbar, but with a y offset
-    self.computeFrame = get_computeFrame_fn(toolbar, dy)
+    self.computeFrame = get_computeFrame_fn(toolbar_info.el, toolbar_info.demo_dy)
+
+    self.toolbar_el = toolbar_info.el
+    self.button_els = toolbar_info.button_els
+    self.set_button_text = set_button_text
 
     return self
 end
 
+-- capture computed locations of toolbar and buttons
+function ToolbarDemo:postUpdateLayout()
+    local ir = gui.get_interface_rect()
+    local function vr(el)
+        local f = el.frame_fn(ir)
+        return gui.ViewRect{ rect = gui.mkdims_wh(ir.x1 + f.l, ir.y1 + f.t, f.w, f.h) }
+    end
+    if self.toolbar_el then
+        self.toolbar_vr = vr(self.toolbar_el)
+    end
+    if self.button_els then
+        local vrs = {}
+        for name, el in pairs(self.button_els) do
+            vrs[name] = vr(el)
+        end
+        self.toolbar_button_vrs = vrs
+    end
+end
+
+function ToolbarDemo:render(...)
+    if self.toolbar_vr then
+        if self:getMousePos(self.toolbar_vr) then
+            self.frame_style = hover_frame_style
+            if self.toolbar_button_vrs then
+                local lit = false
+                for button_name, button_vr in pairs(self.toolbar_button_vrs) do
+                    if self:getMousePos(button_vr) then
+                        if self.set_button_text(button_name) then
+                            lit = true
+                            break
+                        end
+                    end
+                end
+                if not lit then
+                    self.set_button_text()
+                end
+            end
+        else
+            self.frame_style = normal_frame_style
+            self.set_button_text()
+        end
+    end
+    return ToolbarDemo.super.render(self, ...)
+end
+
 local left_toolbar_demo = ToolbarDemo{
     frame_title = 'left toolbar',
-    toolbar = layout.fort.toolbars.left,
-    toolbar_dy = primary_toolbar_dy,
+    toolbar_info = {
+        el = layout.elements.fort.toolbars.left,
+        buttons = layout.element_layouts.fort.toolbars.left.buttons,
+        button_els = layout.elements.fort.toolbar_buttons.left,
+        demo_dy = primary_toolbar_dy,
+    },
 }
 
 local center_toolbar_demo = ToolbarDemo{
     frame_title = 'center toolbar',
-    toolbar = layout.fort.toolbars.center,
-    toolbar_dy = primary_toolbar_dy,
+    toolbar_info = {
+        el = layout.elements.fort.toolbars.center,
+        buttons = layout.element_layouts.fort.toolbars.center.buttons,
+        button_els = layout.elements.fort.toolbar_buttons.center,
+        demo_dy = primary_toolbar_dy,
+    },
 }
 
 local right_toolbar_demo = ToolbarDemo{
     frame_title = 'right toolbar',
-    toolbar = layout.fort.toolbars.right,
-    toolbar_dy = primary_toolbar_dy,
+    toolbar_info = {
+        el = layout.elements.fort.toolbars.right,
+        buttons = layout.element_layouts.fort.toolbars.right.buttons,
+        button_els = layout.elements.fort.toolbar_buttons.right,
+        demo_dy = primary_toolbar_dy,
+    }
 }
 
 local secondary_toolbar_demo = ToolbarDemo{
@@ -187,7 +276,12 @@ local function update_fort_toolbars(secondary)
         local function dy()
             return -layout.SECONDARY_TOOLBAR_HEIGHT
         end
-        secondary_toolbar_demo:update_to_toolbar(layout.fort.secondary_toolbars[secondary], dy)
+        secondary_toolbar_demo:update_to_toolbar{
+            el = layout.elements.fort.secondary_toolbars[secondary],
+            buttons = layout.element_layouts.fort.secondary_toolbars[secondary].buttons,
+            button_els = layout.elements.fort.secondary_toolbar_buttons[secondary],
+            demo_dy = dy
+        }
         updateLayout(secondary_toolbar_demo)
         secondary_visible = true
     else
@@ -199,56 +293,56 @@ local function update_fort_toolbars(secondary)
     updateLayout(center_toolbar_demo)
 end
 
-local tool_from_designation = {
+local secondary_toolbar_from_designation = {
     -- df.main_designation_type.NONE -- not a tool
-    [df.main_designation_type.DIG_DIG] = 'dig',
-    [df.main_designation_type.DIG_REMOVE_STAIRS_RAMPS] = 'dig',
-    [df.main_designation_type.DIG_STAIR_UP] = 'dig',
-    [df.main_designation_type.DIG_STAIR_UPDOWN] = 'dig',
-    [df.main_designation_type.DIG_STAIR_DOWN] = 'dig',
-    [df.main_designation_type.DIG_RAMP] = 'dig',
-    [df.main_designation_type.DIG_CHANNEL] = 'dig',
-    [df.main_designation_type.CHOP] = 'chop',
-    [df.main_designation_type.GATHER] = 'gather',
-    [df.main_designation_type.SMOOTH] = 'smooth',
-    [df.main_designation_type.TRACK] = 'smooth',
-    [df.main_designation_type.ENGRAVE] = 'smooth',
-    [df.main_designation_type.FORTIFY] = 'smooth',
+    [df.main_designation_type.DIG_DIG] = 'DIG',
+    [df.main_designation_type.DIG_REMOVE_STAIRS_RAMPS] = 'DIG',
+    [df.main_designation_type.DIG_STAIR_UP] = 'DIG',
+    [df.main_designation_type.DIG_STAIR_UPDOWN] = 'DIG',
+    [df.main_designation_type.DIG_STAIR_DOWN] = 'DIG',
+    [df.main_designation_type.DIG_RAMP] = 'DIG',
+    [df.main_designation_type.DIG_CHANNEL] = 'DIG',
+    [df.main_designation_type.CHOP] = 'CHOP',
+    [df.main_designation_type.GATHER] = 'GATHER',
+    [df.main_designation_type.SMOOTH] = 'SMOOTH',
+    [df.main_designation_type.TRACK] = 'SMOOTH',
+    [df.main_designation_type.ENGRAVE] = 'SMOOTH',
+    [df.main_designation_type.FORTIFY] = 'SMOOTH',
     -- df.main_designation_type.REMOVE_CONSTRUCTION -- not used?
-    [df.main_designation_type.CLAIM] = 'mass_designation',
-    [df.main_designation_type.UNCLAIM] = 'mass_designation',
-    [df.main_designation_type.MELT] = 'mass_designation',
-    [df.main_designation_type.NO_MELT] = 'mass_designation',
-    [df.main_designation_type.DUMP] = 'mass_designation',
-    [df.main_designation_type.NO_DUMP] = 'mass_designation',
-    [df.main_designation_type.HIDE] = 'mass_designation',
-    [df.main_designation_type.NO_HIDE] = 'mass_designation',
+    [df.main_designation_type.CLAIM] = 'ITEM_BUILDING',
+    [df.main_designation_type.UNCLAIM] = 'ITEM_BUILDING',
+    [df.main_designation_type.MELT] = 'ITEM_BUILDING',
+    [df.main_designation_type.NO_MELT] = 'ITEM_BUILDING',
+    [df.main_designation_type.DUMP] = 'ITEM_BUILDING',
+    [df.main_designation_type.NO_DUMP] = 'ITEM_BUILDING',
+    [df.main_designation_type.HIDE] = 'ITEM_BUILDING',
+    [df.main_designation_type.NO_HIDE] = 'ITEM_BUILDING',
     -- df.main_designation_type.TOGGLE_ENGRAVING -- not used?
-    [df.main_designation_type.DIG_FROM_MARKER] = 'dig',
-    [df.main_designation_type.DIG_TO_MARKER] = 'dig',
-    [df.main_designation_type.CHOP_FROM_MARKER] = 'chop',
-    [df.main_designation_type.CHOP_TO_MARKER] = 'chop',
-    [df.main_designation_type.GATHER_FROM_MARKER] = 'gather',
-    [df.main_designation_type.GATHER_TO_MARKER] = 'gather',
-    [df.main_designation_type.SMOOTH_FROM_MARKER] = 'smooth',
-    [df.main_designation_type.SMOOTH_TO_MARKER] = 'smooth',
-    [df.main_designation_type.DESIGNATE_TRAFFIC_HIGH] = 'traffic',
-    [df.main_designation_type.DESIGNATE_TRAFFIC_NORMAL] = 'traffic',
-    [df.main_designation_type.DESIGNATE_TRAFFIC_LOW] = 'traffic',
-    [df.main_designation_type.DESIGNATE_TRAFFIC_RESTRICTED] = 'traffic',
-    [df.main_designation_type.ERASE] = 'erase',
+    [df.main_designation_type.DIG_FROM_MARKER] = 'DIG',
+    [df.main_designation_type.DIG_TO_MARKER] = 'DIG',
+    [df.main_designation_type.CHOP_FROM_MARKER] = 'CHOP',
+    [df.main_designation_type.CHOP_TO_MARKER] = 'CHOP',
+    [df.main_designation_type.GATHER_FROM_MARKER] = 'GATHER',
+    [df.main_designation_type.GATHER_TO_MARKER] = 'GATHER',
+    [df.main_designation_type.SMOOTH_FROM_MARKER] = 'SMOOTH',
+    [df.main_designation_type.SMOOTH_TO_MARKER] = 'SMOOTH',
+    [df.main_designation_type.DESIGNATE_TRAFFIC_HIGH] = 'TRAFFIC',
+    [df.main_designation_type.DESIGNATE_TRAFFIC_NORMAL] = 'TRAFFIC',
+    [df.main_designation_type.DESIGNATE_TRAFFIC_LOW] = 'TRAFFIC',
+    [df.main_designation_type.DESIGNATE_TRAFFIC_RESTRICTED] = 'TRAFFIC',
+    [df.main_designation_type.ERASE] = 'ERASE',
 }
-local tool_from_bottom = {
+local secondary_toolbar_from_bottom = {
     -- df.main_bottom_mode_type.NONE
     -- df.main_bottom_mode_type.BUILDING
     -- df.main_bottom_mode_type.BUILDING_PLACEMENT
     -- df.main_bottom_mode_type.BUILDING_PICK_MATERIALS
     -- df.main_bottom_mode_type.ZONE
     -- df.main_bottom_mode_type.ZONE_PAINT
-    [df.main_bottom_mode_type.STOCKPILE] = 'stockpile',
-    [df.main_bottom_mode_type.STOCKPILE_PAINT] = 'stockpile_paint',
+    [df.main_bottom_mode_type.STOCKPILE] = 'MAIN_STOCKPILE_MODE',
+    [df.main_bottom_mode_type.STOCKPILE_PAINT] = 'STOCKPILE_NEW',
     -- df.main_bottom_mode_type.BURROW
-    [df.main_bottom_mode_type.BURROW_PAINT] = 'burrow_paint'
+    [df.main_bottom_mode_type.BURROW_PAINT] = 'Add new burrow',
     -- df.main_bottom_mode_type.HAULING
     -- df.main_bottom_mode_type.ARENA_UNIT
     -- df.main_bottom_mode_type.ARENA_TREE
@@ -262,11 +356,11 @@ local tool_from_bottom = {
 local function active_secondary()
     local designation = df.global.game.main_interface.main_designation_selected
     if designation ~= df.main_designation_type.NONE then
-        return tool_from_designation[designation]
+        return secondary_toolbar_from_designation[designation]
     end
     local bottom = df.global.game.main_interface.bottom_mode_selected
     if bottom ~= df.main_bottom_mode_type.NONE then
-        return tool_from_bottom[bottom]
+        return secondary_toolbar_from_bottom[bottom]
     end
 end