#344 graphics assertion overhaul

graphics/elements/controls/app.lua

@@ -24,10 +24,10 @@ local MOUSE_CLICK = core.events.MOUSE_CLICK
 ---@param args app_button_args
 ---@return graphics_element element, element_id id
 local function app_button(args)
-    assert(type(args.text) == "string", "controls.app: text is a required field")
-    assert(type(args.title) == "string", "controls.app: title is a required field")
-    assert(type(args.callback) == "function", "controls.app: callback is a required field")
-    assert(type(args.app_fg_bg) == "table", "controls.app: app_fg_bg is a required field")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.title) == "string", "title is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.app_fg_bg) == "table", "app_fg_bg is a required field")
 
     args.height = 4
     args.width = 5

graphics/elements/controls/checkbox.lua

@@ -18,8 +18,8 @@ local element = require("graphics.element")
 ---@param args checkbox_args
 ---@return graphics_element element, element_id id
 local function checkbox(args)
-    assert(type(args.label) == "string", "controls.checkbox: label is a required field")
-    assert(type(args.box_fg_bg) == "table", "controls.checkbox: box_fg_bg is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.box_fg_bg) == "table", "box_fg_bg is a required field")
 
     args.can_focus = true
     args.height = 1

graphics/elements/controls/hazard_button.lua

@@ -21,9 +21,9 @@ local element = require("graphics.element")
 ---@param args hazard_button_args
 ---@return graphics_element element, element_id id
 local function hazard_button(args)
-    assert(type(args.text) == "string", "controls.hazard_button: text is a required field")
-    assert(type(args.accent) == "number", "controls.hazard_button: accent is a required field")
-    assert(type(args.callback) == "function", "controls.hazard_button: callback is a required field")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.accent) == "number", "accent is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
 
     args.height = 3
     args.width = string.len(args.text) + 4

graphics/elements/controls/multi_button.lua

@@ -29,11 +29,11 @@ local element = require("graphics.element")
 ---@param args multi_button_args
 ---@return graphics_element element, element_id id
 local function multi_button(args)
-    assert(type(args.options) == "table", "controls.multi_button: options is a required field")
-    assert(#args.options > 0, "controls.multi_button: at least one option is required")
-    assert(type(args.callback) == "function", "controls.multi_button: callback is a required field")
-    assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "controls.multi_button: default must be nil or a number > 0")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "controls.multi_button: min_width must be nil or a number > 0")
+    element.assert(type(args.options) == "table", "options is a required field")
+    element.assert(#args.options > 0, "at least one option is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     -- single line
     args.height = 1

graphics/elements/controls/push_button.lua

@@ -26,9 +26,9 @@ local KEY_CLICK = core.events.KEY_CLICK
 ---@param args push_button_args
 ---@return graphics_element element, element_id id
 local function push_button(args)
-    assert(type(args.text) == "string", "controls.push_button: text is a required field")
-    assert(type(args.callback) == "function", "controls.push_button: callback is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "controls.push_button: min_width must be nil or a number > 0")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     local text_width = string.len(args.text)
 

graphics/elements/controls/radio_2d.lua

@@ -27,12 +27,12 @@ local element = require("graphics.element")
 ---@param args radio_2d_args
 ---@return graphics_element element, element_id id
 local function radio_2d_button(args)
-    assert(type(args.options) == "table" and #args.options > 0, "controls.radio_2d: options should be a table with length >= 1")
-    assert(util.is_int(args.rows) and util.is_int(args.columns), "controls.radio_2d: rows/columns must be integers")
-    assert((args.rows * args.columns) >= #args.options, "controls.radio_2d: rows x columns size insufficient for provided number of options")
-    assert(type(args.radio_colors) == "table", "controls.radio_2d: radio_colors is a required field")
-    assert(type(args.select_color) == "number" or type(args.color_map) == "table", "controls.radio_2d: select_color or color_map is required")
-    assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "controls.radio_2d: default must be nil or a number > 0")
+    element.assert(type(args.options) == "table" and #args.options > 0, "options should be a table with length >= 1")
+    element.assert(util.is_int(args.rows) and util.is_int(args.columns), "rows/columns must be integers")
+    element.assert((args.rows * args.columns) >= #args.options, "rows x columns size insufficient for provided number of options")
+    element.assert(type(args.radio_colors) == "table", "radio_colors is a required field")
+    element.assert(type(args.select_color) == "number" or type(args.color_map) == "table", "select_color or color_map is required")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
 
     local array = {}
     local col_widths = {}

graphics/elements/controls/radio_button.lua

@@ -25,14 +25,12 @@ local KEY_CLICK = core.events.KEY_CLICK
 ---@param args radio_button_args
 ---@return graphics_element element, element_id id
 local function radio_button(args)
-    assert(type(args.options) == "table", "controls.radio_button: options is a required field")
-    assert(#args.options > 0, "controls.radio_button: at least one option is required")
-    assert(type(args.radio_colors) == "table", "controls.radio_button: radio_colors is a required field")
-    assert(type(args.select_color) == "number", "controls.radio_button: select_color is a required field")
-    assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0),
-        "controls.radio_button: default must be nil or a number > 0")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "controls.radio_button: min_width must be nil or a number > 0")
+    element.assert(type(args.options) == "table", "options is a required field")
+    element.assert(#args.options > 0, "at least one option is required")
+    element.assert(type(args.radio_colors) == "table", "radio_colors is a required field")
+    element.assert(type(args.select_color) == "number", "select_color is a required field")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     -- determine widths
     local max_width = 1

graphics/elements/controls/sidebar.lua

@@ -27,16 +27,16 @@ local MOUSE_CLICK = core.events.MOUSE_CLICK
 ---@param args sidebar_args
 ---@return graphics_element element, element_id id
 local function sidebar(args)
-    assert(type(args.tabs) == "table", "controls.sidebar: tabs is a required field")
-    assert(#args.tabs > 0, "controls.sidebar: at least one tab is required")
-    assert(type(args.callback) == "function", "controls.sidebar: callback is a required field")
+    element.assert(type(args.tabs) == "table", "tabs is a required field")
+    element.assert(#args.tabs > 0, "at least one tab is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
 
     args.width = 3
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    assert(e.frame.h >= (#args.tabs * 3), "graphics.elements.controls.sidebar: height insufficent to display all tabs")
+    element.assert(e.frame.h >= (#args.tabs * 3), "height insufficent to display all tabs")
 
     -- default to 1st tab
     e.value = 1

graphics/elements/controls/spinbox_numeric.lua

@@ -29,8 +29,8 @@ local function spinbox(args)
     local wn_prec = args.whole_num_precision
     local fr_prec = args.fractional_precision
 
-    assert(util.is_int(wn_prec), "controls.spinbox_numeric: whole number precision must be an integer")
-    assert(util.is_int(fr_prec), "controls.spinbox_numeric: fractional precision must be an integer")
+    element.assert(util.is_int(wn_prec), "whole number precision must be an integer")
+    element.assert(util.is_int(fr_prec), "fractional precision must be an integer")
 
     local fmt, fmt_init ---@type string, string
 
@@ -44,7 +44,7 @@ local function spinbox(args)
 
     local dec_point_x = args.whole_num_precision + 1
 
-    assert(type(args.arrow_fg_bg) == "table", "controls.spinbox_numeric: arrow_fg_bg is a required field")
+    element.assert(type(args.arrow_fg_bg) == "table", "arrow_fg_bg is a required field")
 
     -- determine widths
     args.width = wn_prec + fr_prec + util.trinary(fr_prec > 0, 1, 0)

graphics/elements/controls/switch_button.lua

@@ -21,10 +21,10 @@ local element = require("graphics.element")
 ---@param args switch_button_args
 ---@return graphics_element element, element_id id
 local function switch_button(args)
-    assert(type(args.text) == "string", "controls.switch_button: text is a required field")
-    assert(type(args.callback) == "function", "controls.switch_button: callback is a required field")
-    assert(type(args.active_fg_bg) == "table", "controls.switch_button: active_fg_bg is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "controls.switch_button: min_width must be nil or a number > 0")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.active_fg_bg) == "table", "active_fg_bg is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     local text_width = string.len(args.text)
 

graphics/elements/controls/tabbar.lua

@@ -27,10 +27,10 @@ local element = require("graphics.element")
 ---@param args tabbar_args
 ---@return graphics_element element, element_id id
 local function tabbar(args)
-    assert(type(args.tabs) == "table", "controls.tabbar: tabs is a required field")
-    assert(#args.tabs > 0, "controls.tabbar: at least one tab is required")
-    assert(type(args.callback) == "function", "controls.tabbar: callback is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "controls.tabbar: min_width must be nil or a number > 0")
+    element.assert(type(args.tabs) == "table", "tabs is a required field")
+    element.assert(#args.tabs > 0, "at least one tab is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     args.height = 1
 
@@ -48,7 +48,7 @@ local function tabbar(args)
     -- create new graphics element base object
     local e = element.new(args)
 
-    assert(e.frame.w >= (button_width * #args.tabs), "graphics.elements.controls.tabbar: width insufficent to display all tabs")
+    element.assert(e.frame.w >= (button_width * #args.tabs), "width insufficent to display all tabs")
 
     -- default to 1st tab
     e.value = 1