components.lua

-- Luanti
-- Copyright (C) 2022 rubenwardy
-- SPDX-License-Identifier: LGPL-2.1-or-later

local make = {}


-- This file defines various component constructors, of the form:
--
--     make.component(setting)
--
-- `setting` is a table representing the settingtype.
--
-- A component is a table with the following:
--
-- * `full_width`: (Optional) true if the component shouldn't reserve space for info / reset.
-- * `info_text`: (Optional) string, informational text shown in an info icon.
-- * `setting`: (Optional) the setting.
-- * `max_w`: (Optional) maximum width, `avail_w` will never exceed this.
-- * `resettable`: (Optional) if this is true, a reset button is shown.
-- * `get_formspec = function(self, avail_w)`:
--     * `avail_w` is the available width for the component.
--     * Returns `fs, used_height`.
--     * `fs` is a string for the formspec.
--       Components should be relative to `0,0`, and not exceed `avail_w` or the returned `used_height`.
--     * `used_height` is the space used by components in `fs`.
-- * `spacing`: (Optional) the vertical margin to be added before the component (default 0.25)
-- * `on_submit = function(self, fields, parent)`:
--     * `fields`: submitted formspec fields
--     * `parent`: the fstk element for the settings UI, use to show dialogs
--     * Return true if the event was handled, to prevent future components receiving it.


local function get_label(setting)
	local show_technical_names = core.settings:get_bool("show_technical_names")
	if not show_technical_names and setting.readable_name then
		if setting.source then
			local source = setting.source
			return core.get_content_translation(source.path, source.textdomain,
					core.translate(source.textdomain, setting.readable_name))
		end
		return fgettext(setting.readable_name)
	end
	return setting.name
end


local function is_valid_number(value)
	return type(value) == "number" and not (value ~= value or value >= math.huge or value <= -math.huge)
end


function make.heading(text, info_text)
	return {
		full_width = true,
		info_text = info_text,
		get_formspec = function(self, avail_w)
			return ("label[0,0.6;%s]box[0,0.9;%f,0.05;#ccc6]"):format(core.formspec_escape(text), avail_w), 1.2
		end,
	}
end


function make.unavail_list(settings)
	return {
		full_width = true,
		get_formspec = function(self, avail_w)
			local h = 0.2
			local fs = {}
			for _, setting in ipairs(settings) do
				fs[#fs + 1] = ("label[0.3,%f;%s]"):format(h,
					core.colorize("#bbb", core.formspec_escape(get_label(setting))))
				h = h + 0.4
			end
			return table.concat(fs, ""), h
		end,
	}
end

function make.note(text)
	return {
		full_width = true,
		get_formspec = function(self, avail_w)
			-- Assuming label height 0.4:
			-- Position at y=0 to eat 0.2 of the padding above, leave 0.05.
			-- The returned used_height doesn't include padding.
			return ("label[0,0;%s]"):format(core.colorize("#bbb", core.formspec_escape(text))), 0.2
		end,
	}
end


--- Used for string and numeric style fields
---
--- @param converter Function to coerce values from strings.
--- @param validator Validator function, optional. Returns true when valid.
--- @param stringifier Function to convert values to strings, optional.
local function make_field(converter, validator, stringifier)
	return function(setting)
		return {
			info_text = setting.comment,
			setting = setting,

			get_formspec = function(self, avail_w)
				local value = core.settings:get(setting.name) or setting.default
				self.resettable = core.settings:has(setting.name)

				local fs = ("field[0,0.3;%f,0.8;%s;%s;%s]"):format(
					avail_w - 1.5, setting.name, get_label(setting), core.formspec_escape(value))
				fs = fs .. ("field_enter_after_edit[%s;true]"):format(setting.name)
				fs = fs .. ("field_close_on_enter[%s;false]"):format(setting.name) -- for pause menu env
				fs = fs .. ("button[%f,0.3;1.5,0.8;%s;%s]"):format(avail_w - 1.5, "set_" .. setting.name, fgettext("Set"))

				return fs, 1.1
			end,

			on_submit = function(self, fields)
				if fields["set_" .. setting.name] or fields.key_enter_field == setting.name then
					local value = converter(fields[setting.name])
					if value == nil or (validator and not validator(value)) then
						return true
					end

					if setting.min then
						value = math.max(value, setting.min)
					end
					if setting.max then
						value = math.min(value, setting.max)
					end
					core.settings:set(setting.name, (stringifier or tostring)(value))
					return true
				end
			end,
		}
	end
end


make.float = make_field(tonumber, is_valid_number, function(x)
	local str = tostring(x)
	if str:match("^[+-]?%d+$") then
		str = str .. ".0"
	end
	return str
end)
make.int = make_field(function(x)
	local value = tonumber(x)
	return value and math.floor(value)
end, is_valid_number)
make.string = make_field(tostring, nil)


function make.bool(setting)
	return {
		info_text = setting.comment,
		setting = setting,

		get_formspec = function(self, avail_w)
			local value = core.settings:get_bool(setting.name, core.is_yes(setting.default))
			self.resettable = core.settings:has(setting.name)

			local fs = ("checkbox[0,0.25;%s;%s;%s]"):format(
				setting.name, get_label(setting), tostring(value))
			return fs, 0.5
		end,

		on_submit = function(self, fields)
			if fields[setting.name] == nil then
				return false
			end

			core.settings:set_bool(setting.name, core.is_yes(fields[setting.name]))
			return true
		end,
	}
end


function make.enum(setting)
	return {
		info_text = setting.comment,
		setting = setting,
		max_w = 4.5,

		get_formspec = function(self, avail_w)
			local value = core.settings:get(setting.name) or setting.default
			self.resettable = core.settings:has(setting.name)

			local labels = setting.option_labels or {}

			local items = {}
			for i, option in ipairs(setting.values) do
				items[i] = core.formspec_escape(labels[option] or option)
			end

			local selected_idx = table.indexof(setting.values, value)
			local fs = "label[0,0.1;" .. get_label(setting) .. "]"

			fs = fs .. ("dropdown[0,0.3;%f,0.8;%s;%s;%d;true]"):format(
				avail_w, setting.name, table.concat(items, ","), selected_idx, value)

			return fs, 1.1
		end,

		on_submit = function(self, fields)
			local old_value = core.settings:get(setting.name) or setting.default
			local idx = tonumber(fields[setting.name]) or 0
			local value = setting.values[idx]
			if value == nil or value == old_value then
				return false
			end

			core.settings:set(setting.name, value)
			return true
		end,
	}
end


local function make_path(setting)
	return {
		info_text = setting.comment,
		setting = setting,

		get_formspec = function(self, avail_w)
			local value = core.settings:get(setting.name) or setting.default
			self.resettable = core.settings:has(setting.name)

			local fs = ("field[0,0.3;%f,0.8;%s;%s;%s]"):format(
				avail_w - 3, setting.name, get_label(setting), core.formspec_escape(value))
			fs = fs .. ("field_enter_after_edit[%s;true]"):format(setting.name)
			fs = fs .. ("field_close_on_enter[%s;false]"):format(setting.name) -- for pause menu env
			fs = fs .. ("button[%f,0.3;1.5,0.8;%s;%s]"):format(avail_w - 3, "pick_" .. setting.name, fgettext("Browse"))
			fs = fs .. ("button[%f,0.3;1.5,0.8;%s;%s]"):format(avail_w - 1.5, "set_" .. setting.name, fgettext("Set"))

			return fs, 1.1
		end,

		on_submit = function(self, fields)
			local dialog_name = "dlg_path_" .. setting.name
			if fields["pick_" .. setting.name] then
				local is_file = setting.type ~= "path"
				core.show_path_select_dialog(dialog_name,
					is_file and fgettext_ne("Select file") or fgettext_ne("Select directory"), is_file)
				return true
			end
			if fields[dialog_name .. "_accepted"] then
				local value = fields[dialog_name .. "_accepted"]
				if value ~= nil then
					core.settings:set(setting.name, value)
				end
				return true
			end
			if fields["set_" .. setting.name] or fields.key_enter_field == setting.name then
				local value = fields[setting.name]
				if value ~= nil then
					core.settings:set(setting.name, value)
				end
				return true
			end
		end,
	}
end

if PLATFORM == "Android" or INIT == "pause_menu" then
	-- The Irrlicht file picker doesn't work on Android.
	-- Access to the Irrlicht file picker isn't implemented in the pause menu.
	-- We want to delete the Irrlicht file picker anyway, so any time spent on
	-- that would be wasted.
	make.path = make.string
	make.filepath = make.string
else
	make.path = make_path
	make.filepath = make_path
end


function make.v3f(setting)
	return {
		info_text = setting.comment,
		setting = setting,

		get_formspec = function(self, avail_w)
			local value = vector.from_string(core.settings:get(setting.name) or setting.default)
			self.resettable = core.settings:has(setting.name)

			-- Allocate space for "Set" button
			avail_w = avail_w - 1

			local fs = "label[0,0.1;" .. get_label(setting) .. "]"

			local field_width = (avail_w - 3*0.25) / 3

			fs = fs .. ("field[%f,0.6;%f,0.8;%s;%s;%s]"):format(
				0, field_width, setting.name .. "_x", "X", value.x)
			fs = fs .. ("field[%f,0.6;%f,0.8;%s;%s;%s]"):format(
				field_width + 0.25, field_width, setting.name .. "_y", "Y", value.y)
			fs = fs .. ("field[%f,0.6;%f,0.8;%s;%s;%s]"):format(
				2 * (field_width + 0.25), field_width, setting.name .. "_z", "Z", value.z)

			fs = fs .. ("field_enter_after_edit[%s;true]"):format(setting.name .. "_x")
			fs = fs .. ("field_enter_after_edit[%s;true]"):format(setting.name .. "_y")
			fs = fs .. ("field_enter_after_edit[%s;true]"):format(setting.name .. "_z")
			-- for pause menu env
			fs = fs .. ("field_close_on_enter[%s;false]"):format(setting.name .. "_x")
			fs = fs .. ("field_close_on_enter[%s;false]"):format(setting.name .. "_y")
			fs = fs .. ("field_close_on_enter[%s;false]"):format(setting.name .. "_z")

			fs = fs .. ("button[%f,0.6;1,0.8;%s;%s]"):format(avail_w, "set_" .. setting.name, fgettext("Set"))

			return fs, 1.4
		end,

		on_submit = function(self, fields)
			if fields["set_" .. setting.name]  or
					fields.key_enter_field == setting.name .. "_x" or
					fields.key_enter_field == setting.name .. "_y" or
					fields.key_enter_field == setting.name .. "_z" then
				local x = tonumber(fields[setting.name .. "_x"])
				local y = tonumber(fields[setting.name .. "_y"])
				local z = tonumber(fields[setting.name .. "_z"])
				if is_valid_number(x) and is_valid_number(y) and is_valid_number(z) then
					core.settings:set(setting.name, vector.new(x, y, z):to_string())
				else
					core.log("error", "Invalid vector: " .. dump({x, y, z}))
				end
				return true
			end
		end,
	}
end


function make.flags(setting)
	local checkboxes = {}

	return {
		info_text = setting.comment,
		setting = setting,

		get_formspec = function(self, avail_w)
			local fs = {
				"label[0,0.1;" .. get_label(setting) .. "]",
			}

			self.resettable = core.settings:has(setting.name)

			checkboxes = {}
			for _, name in ipairs(setting.possible) do
				checkboxes[name] = false
			end
			local function apply_flags(flag_string, what)
				local prefixed_flags = {}
				for _, name in ipairs(flag_string:split(",")) do
					prefixed_flags[name:trim()] = true
				end
				for _, name in ipairs(setting.possible) do
					local enabled = prefixed_flags[name]
					local disabled = prefixed_flags["no" .. name]
					if enabled and disabled then
						core.log("warning", "Flag " .. name .. " in " .. what .. " " ..
								setting.name .. " both enabled and disabled, ignoring")
					elseif enabled then
						checkboxes[name] = true
					elseif disabled then
						checkboxes[name] = false
					end
				end
			end
			-- First apply the default, which is necessary since flags
			-- which are not overridden may be missing from the value.
			apply_flags(setting.default, "default for setting")
			local value = core.settings:get(setting.name)
			if value then
				apply_flags(value, "setting")
			end

			local columns = math.max(math.floor(avail_w / 2.5), 1)
			local column_width = avail_w / columns
			local x = 0
			local y = 0.55

			for _, possible in ipairs(setting.possible) do
				if x >= avail_w then
					x = 0
					y = y + 0.5
				end

				local is_checked = checkboxes[possible]
				fs[#fs + 1] = ("checkbox[%f,%f;%s;%s;%s]"):format(
					x, y, setting.name .. "_" .. possible,
					core.formspec_escape(possible), tostring(is_checked))
				x = x + column_width
			end

			return table.concat(fs, ""), y + 0.25
		end,

		on_submit = function(self, fields)
			local changed = false
			for name, _ in pairs(checkboxes) do
				local value = fields[setting.name .. "_" .. name]
				if value ~= nil then
					checkboxes[name] = core.is_yes(value)
					changed = true
				end
			end

			if changed then
				local values = {}
				for _, name in ipairs(setting.possible) do
					if checkboxes[name] then
						table.insert(values, name)
					else
						table.insert(values, "no" .. name)
					end
				end

				core.settings:set(setting.name, table.concat(values, ","))
			end
			return changed
		end
	}
end


local function make_noise_params(setting)
	return {
		info_text = setting.comment,
		setting = setting,

		get_formspec = function(self, avail_w)
			-- The "defaults" noise parameter flag doesn't reset a noise
			-- setting to its default value, so we offer a regular reset button.
			self.resettable = core.settings:has(setting.name)

			local fs = "label[0,0.4;" .. get_label(setting) .. "]" ..
					("button[%f,0;2.5,0.8;%s;%s]"):format(avail_w - 2.5, "edit_" .. setting.name, fgettext("Edit"))
			return fs, 0.8
		end,

		on_submit = function(self, fields, tabview)
			if fields["edit_" .. setting.name] then
				local dlg = create_change_mapgen_flags_dlg(setting)
				dlg:set_parent(tabview)
				tabview:hide()
				dlg:show()

				return true
			end
		end,
	}
end

local function has_keybinding_conflict(t1, t2)
	for _, v1 in pairs(t1) do
		for _, v2 in pairs(t2) do
			if core.are_keycodes_equal(v1, v2) then
				return true
			end
		end
	end
	return false
end

local function get_key_setting(name)
	return core.settings:get(name):split("|")
end

-- Setting names where an empty field shall be shown to assign new keybindings.
local key_add_empty = {}

function make.key(setting)
	local btn_bind = "bind_" .. setting.name
	local btn_clear = "unbind_" .. setting.name
	local btn_add = "add_" .. setting.name
	local function add_conflict_warnings(fs, height)
		local value = get_key_setting(setting.name)
		if value == "" then
			return height
		end

		local critical_keys = {
			keymap_drop = true,
			keymap_dig = true,
			keymap_place = true,
		}

		for _, o in ipairs(core.full_settingtypes) do
			if o.type == "key" and o.name ~= setting.name and
					has_keybinding_conflict(get_key_setting(o.name), value) then

				local is_current_close_world = setting.name == "keymap_close_world"
				local is_other_close_world = o.name == "keymap_close_world"
				local is_current_critical = critical_keys[setting.name]
				local is_other_critical = critical_keys[o.name]

				if (is_other_critical or is_current_critical) or
						(not is_current_close_world and not is_other_close_world) then
					table.insert(fs, ("label[0,%f;%s]"):format(height + 0.3,
							core.colorize(mt_color_orange, fgettext([[Conflicts with "$1"]], fgettext(o.readable_name)))))
					height = height + 0.6
				end
			end
		end
		return height
	end

	local add_empty = key_add_empty[setting.name]
	key_add_empty[setting.name] = nil

	return {
		info_text = setting.comment,
		setting = setting,
		spacing = 0.1,

		get_formspec = function(self, avail_w)
			local value_string = core.settings:get(setting.name) or ""
			local default_value = setting.default or ""
			self.resettable = core.settings:has(setting.name) and (value_string ~= default_value)
			local value_width = math.max(2.5, avail_w / 2)
			local value = get_key_setting(setting.name)
			local fs = {
				("label[0,0.4;%s]"):format(get_label(setting)),
			}

			local function add_keybinding_row(idx)
				local btn_bind_width = value_width - 1.6
				local has_value = value[idx]
				local y = (idx - 1) * 0.8
				if not has_value then
					btn_bind_width = idx == 1 and value_width or (value_width - 0.8)
				end
				table.insert(fs, ("button_key[%f,%f;%f,0.8;%s_%d;%s]"):format(
						value_width, y, btn_bind_width,
						btn_bind, idx, core.formspec_escape(value[idx] or "")))
				if has_value then
					table.insert(fs, ("image_button[%f,%f;0.8,0.8;%s;%s_%d;]"):format(
							avail_w - 1.6, y,
							core.formspec_escape(defaulttexturedir .. "clear.png"),
							btn_clear, idx))
					table.insert(fs, ("tooltip[%s_%d;%s]"):format(btn_clear, idx,
							fgettext("Remove keybinding")))
				end
			end

			local height = #value * 0.8
			for i = 1, #value do
				add_keybinding_row(i)
			end
			if add_empty or #value == 0 then
				add_keybinding_row(#value+1)
				height = height + 0.8
			else
				table.insert(fs, ("image_button[%f,%f;0.8,0.8;%s;%s;]"):format(
						avail_w - 0.8, height - 0.8,
						core.formspec_escape(defaulttexturedir .. "plus.png"), btn_add))
				table.insert(fs, ("tooltip[%s;%s]"):format(btn_add, fgettext("Add keybinding")))
			end

			height = add_conflict_warnings(fs, height)
			return table.concat(fs), height
		end,

		on_submit = function(self, fields)
			if fields[btn_add] then
				key_add_empty[setting.name] = true
				return true
			end
			local value = get_key_setting(setting.name)
			for i = 1, #value + 1 do
				if fields[("%s_%d"):format(btn_bind, i)] then
					value[i] = fields[("%s_%d"):format(btn_bind, i)]
					core.settings:set(setting.name, table.concat(value, "|"))
					return true
				elseif fields[("%s_%d"):format(btn_clear, i)] then
					table.remove(value, i)
					core.settings:set(setting.name, table.concat(value, "|"))
					return true
				end
			end
		end,
	}
end

if INIT == "pause_menu" then
	-- Making the noise parameter dialog work in the pause menu settings would
	-- require porting "FSTK" (at least the dialog API) from the mainmenu formspec
	-- API to the in-game formspec API.
	-- There's no reason you'd want to adjust mapgen noise parameter settings
	-- in-game (they only apply to new worlds, hidden as [world_creation]),
	-- so there's no reason to implement this.
	local empty = function()
		return { get_formspec = function() return "", 0 end }
	end
	make.noise_params_2d = empty
	make.noise_params_3d = empty
else
	make.noise_params_2d = make_noise_params
	make.noise_params_3d = make_noise_params
end


return make