cc-mek-scada/graphics/elements/indicators/state.lua

-- State (Text) Indicator Graphics Element

local util    = require("scada-common.util")

local element = require("graphics.element")

---@class state_text_color
---@field color cpair
---@field text string

---@class state_indicator_args
---@field states table state color and text table
---@field value? integer default state, defaults to 1
---@field min_width? integer max state text length if omitted
---@field parent graphics_element
---@field id? string element id
---@field x? integer 1 if omitted
---@field y? integer 1 if omitted
---@field height? integer 1 if omitted, must be an odd number
---@field fg_bg? cpair foreground/background colors

-- new state indicator
---@param args state_indicator_args
---@return graphics_element element, element_id id
local function state_indicator(args)
    assert(type(args.states) == "table", "graphics.elements.indicators.state: states is a required field")

    -- determine height
    if util.is_int(args.height) then
        assert(args.height % 2 == 1, "graphics.elements.indicators.state: height should be an odd number")
    else
        args.height = 1
    end

    -- initial guess at width
    args.width = args.min_width or 1

    -- state blit strings
    local state_blit_cmds = {}
    for i = 1, #args.states do
        local state_def = args.states[i]    ---@type state_text_color

        -- re-determine width
        if string.len(state_def.text) > args.width then
            args.width = string.len(state_def.text)
        end

        local text = util.pad(state_def.text, args.width)

        table.insert(state_blit_cmds, {
            text = text,
            fgd = util.strrep(state_def.color.blit_fgd, string.len(text)),
            bkg = util.strrep(state_def.color.blit_bkg, string.len(text))
        })
    end

    -- create new graphics element base object
    local e = element.new(args)

    -- on state change
    ---@param new_state integer indicator state
    function e.on_update(new_state)
        local blit_cmd = state_blit_cmds[new_state]
        e.window.setCursorPos(1, 1)
        e.window.blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
    end

    -- initial draw
    e.on_update(args.value or 1)

    return e.get()
end

return state_indicator