indicator renaming

graphics/elements/indicators/IconIndicator.lua

@@ -0,0 +1,80 @@
+-- Icon Indicator Graphics Element
+
+local element = require("graphics.element")
+
+---@class icon_sym_color
+---@field color cpair
+---@field symbol string
+
+---@class icon_indicator_args
+---@field label string indicator label
+---@field states table state color and symbol table
+---@field value? integer|boolean default state, defaults to 1 (true = 2, false = 1)
+---@field min_label_width? integer label length if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer auto incremented if omitted
+---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
+
+-- new icon indicator
+---@nodiscard
+---@param args icon_indicator_args
+---@return graphics_element element, element_id id
+local function icon(args)
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.states) == "table", "states is a required field")
+
+    args.height = 1
+    args.width = math.max(args.min_label_width or 1, string.len(args.label)) + 4
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    e.value = args.value or 1
+    if e.value == true then e.value = 2 end
+
+    -- state blit strings
+    local state_blit_cmds = {}
+    for i = 1, #args.states do
+        local sym_color = args.states[i]    ---@type icon_sym_color
+
+        table.insert(state_blit_cmds, {
+            text = " " .. sym_color.symbol .. " ",
+            fgd = string.rep(sym_color.color.blit_fgd, 3),
+            bkg = string.rep(sym_color.color.blit_bkg, 3)
+        })
+    end
+
+    -- on state change
+    ---@param new_state integer|boolean indicator state
+    function e.on_update(new_state)
+        new_state = new_state or 1
+        if new_state == true then new_state = 2 end
+
+        local blit_cmd = state_blit_cmds[new_state]
+        e.value = new_state
+        e.w_set_cur(1, 1)
+        e.w_blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
+    end
+
+    -- set indicator state
+    ---@param val integer|boolean indicator state
+    function e.set_value(val) e.on_update(val) end
+
+    -- element redraw
+    function e.redraw()
+        e.w_set_cur(5, 1)
+        e.w_write(args.label)
+
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
+
+    return e.complete()
+end
+
+return icon