From c4d3bd252d2f9f496f2ea6e7b4c00430fdd47783 Mon Sep 17 00:00:00 2001
From: alek13 <alek13.me@gmail.com>
Date: Thu, 9 Jan 2025 02:01:30 +0300
Subject: [PATCH] Mount Gen: config form: use `base_classes.Form`. Closes #1904

---
 mods/lord/World/mountgen/src/mountgen.lua     |   3 +-
 .../mountgen/src/mountgen/config/Form.lua     | 129 ++++++++++++++++++
 .../World/mountgen/src/mountgen/tools.lua     |  13 +-
 mods/lord/World/mountgen/src/mountgen/ui.lua  | 114 ----------------
 4 files changed, 138 insertions(+), 121 deletions(-)
 create mode 100644 mods/lord/World/mountgen/src/mountgen/config/Form.lua
 delete mode 100644 mods/lord/World/mountgen/src/mountgen/ui.lua

diff --git a/mods/lord/World/mountgen/src/mountgen.lua b/mods/lord/World/mountgen/src/mountgen.lua
index e60e1b9e0..12a0edc99 100644
--- a/mods/lord/World/mountgen/src/mountgen.lua
+++ b/mods/lord/World/mountgen/src/mountgen.lua
@@ -1,11 +1,10 @@
 
 mountgen = {}
-mountgen.required_priv = "server"
+mountgen.required_priv = 'server'
 
 require('mountgen.algorithms.cone')
 require('mountgen.algorithms.diamond_square')
 require('mountgen.config')
-require('mountgen.ui')
 require('mountgen.tools')
 
 
diff --git a/mods/lord/World/mountgen/src/mountgen/config/Form.lua b/mods/lord/World/mountgen/src/mountgen/config/Form.lua
new file mode 100644
index 000000000..ad4c09248
--- /dev/null
+++ b/mods/lord/World/mountgen/src/mountgen/config/Form.lua
@@ -0,0 +1,129 @@
+local Generator = require('mountgen.Generator')
+
+local S      = minetest.get_mod_translator()
+local Logger = minetest.get_mod_logger()
+local spec   = minetest.formspec
+
+
+--- @class mountgen.config.Form: base_classes.Form.Base
+local Form = base_classes.Form:personal():extended({
+	--- @const
+	--- @type string
+	NAME = 'mountgen:configure',
+})
+
+
+--- @param config table
+--- @return string
+function Form:get_spec(config)
+	local formspec = ''
+	local width = 8
+	local bw = 5 - 0.5
+	local pos = 0.5
+
+	formspec = formspec .. spec.label(3.5, pos - 0.3, S('Mountain creation tool'))
+	pos = pos + 0.5
+	formspec = formspec .. spec.label(3.5, pos - 0.3, S('USE WITH CAUTION!'))
+	pos = pos + 1
+
+	-- метод
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Method'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_method', '', config.METHOD)
+	pos = pos + 0.8
+	-- угол горы
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Angle'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_angle', '', config.ANGLE)
+	pos = pos + 0.8
+	-- основание
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Foot height'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_base', '', config.Y0)
+	pos = pos + 0.8
+	-- снежная линия
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Snow line'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_snow_line', '', config.SNOW_LINE)
+	pos = pos + 0.8
+	-- сглаживание на крупном масштабе
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Big scale smooth'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_big', '', config.rk_big)
+	pos = pos + 0.8
+	-- сглаживание на малом масштабе
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Small scale smooth'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_small', '', config.rk_small)
+	pos = pos + 0.8
+	-- граница мелкого масштаба (лог2)
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Small scale (log2)'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_thr', '', config.rk_thr)
+	pos = pos + 0.8
+
+	-- грунт сверху
+	formspec = formspec .. spec.label(0.5, pos - 0.3, S('Top dirt'))
+	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_top_cover', '', config.top_cover)
+	pos = pos + 0.8
+
+
+	formspec = formspec .. spec.button(1, pos, 3, 1, 'save_main', S('Save'))
+	formspec = formspec .. spec.button(4, pos, 3, 1, 'generate', S('Generate'))
+	pos = pos + 1
+
+	formspec = spec.size(width, pos) .. formspec
+
+	return formspec
+end
+
+--- @private
+--- @param config table
+--- @return boolean
+local function validate_config(config)
+	for k, v in pairs(config) do
+		if v == nil then
+			return false
+		end
+	end
+	if config.ANGLE < 15 or config.ANGLE > 90 then
+		return false
+	end
+	return true
+end
+
+--- @protected
+--- @param fields table
+--- @return nil|boolean return `true` for stop propagation of handling
+function Form:handle(fields)
+	local can_edit = minetest.get_player_privs(self.player_name)[mountgen.required_priv]
+	if not can_edit then
+		return
+	end
+
+	if fields['save_main'] ~= nil or fields['generate'] ~= nil then
+		local config     = {}
+		config.METHOD    = fields['edit_method']
+		config.ANGLE     = tonumber(fields['edit_angle']) or 0
+		config.Y0        = tonumber(fields['edit_base']) or 0
+		config.SNOW_LINE = tonumber(fields['edit_snow_line']) or 0
+		config.rk_big    = tonumber(fields['edit_rk_big']) or 0
+		config.rk_small  = tonumber(fields['edit_rk_small']) or 0
+		config.rk_thr    = tonumber(fields['edit_rk_thr']) or 0
+		config.top_cover = fields['edit_top_cover']
+		if validate_config(config) then
+			mountgen.config.METHOD    = config.METHOD
+			mountgen.config.ANGLE     = config.ANGLE
+			mountgen.config.Y0        = config.Y0
+			mountgen.config.SNOW_LINE = config.SNOW_LINE
+			mountgen.config.rk_big    = config.rk_big
+			mountgen.config.rk_small  = config.rk_small
+			mountgen.config.rk_thr    = config.rk_thr
+			mountgen.config.top_cover = config.top_cover
+		end
+	end
+
+	if fields['generate'] ~= nil then
+		local top_position = minetest.get_player_by_name(self.player_name):get_pos()
+		local config       = mountgen.config
+		Logger.action('use mount stick at ' .. top_position.x .. ' ' .. top_position.y .. ' ' .. top_position.z)
+		Logger.action('parameters: ' .. dump(mountgen.config))
+		Generator:new(top_position, config):run()
+	end
+end
+
+
+return Form:register()
diff --git a/mods/lord/World/mountgen/src/mountgen/tools.lua b/mods/lord/World/mountgen/src/mountgen/tools.lua
index 255483951..da4a79ab0 100644
--- a/mods/lord/World/mountgen/src/mountgen/tools.lua
+++ b/mods/lord/World/mountgen/src/mountgen/tools.lua
@@ -1,17 +1,20 @@
+local Form = require('mountgen.config.Form')
+
+
 local S = minetest.get_mod_translator()
 
 
-minetest.register_tool("mountgen:mount_tool", {
-	description = S("Mountain tool"),
-	inventory_image = "mountgen_tool.png",
+minetest.register_tool('mountgen:mount_tool', {
+	description = S('Mountain tool'),
+	inventory_image = 'mountgen_tool.png',
 	on_use = function(itemstack, placer, pointed_thing)
-		-- show configure menu
 		local user_name = placer:get_player_name()
 		local can_access = minetest.get_player_privs(user_name)[mountgen.required_priv]
 		if not can_access then
 			return
 		end
-		mountgen.show_config_menu(user_name, mountgen.config)
+
+		Form:new(placer):open(mountgen.config)
 	end,
 	group = {},
 	on_drop = function(itemstack, dropper, pos)
diff --git a/mods/lord/World/mountgen/src/mountgen/ui.lua b/mods/lord/World/mountgen/src/mountgen/ui.lua
deleted file mode 100644
index 075f72eab..000000000
--- a/mods/lord/World/mountgen/src/mountgen/ui.lua
+++ /dev/null
@@ -1,114 +0,0 @@
-local Generator = require('mountgen.Generator')
-
-local S      = minetest.get_mod_translator()
-local Logger = minetest.get_mod_logger()
-local spec   = minetest.formspec
-
-
-mountgen.show_config_menu = function(user_name, config)
-	local formspec = ""
-	local width = 8
-	local bw = 5 - 0.5
-	local pos = 0.5
-
-	formspec = formspec .. spec.label(3.5, pos - 0.3, S("Mountain creation tool"))
-	pos = pos + 0.5
-	formspec = formspec .. spec.label(3.5, pos - 0.3, S("USE WITH CAUTION!"))
-	pos = pos + 1
-
-	-- метод
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Method"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_method', '', config.METHOD)
-	pos = pos + 0.8
-	-- угол горы
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Angle"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_angle', '', config.ANGLE)
-	pos = pos + 0.8
-	-- основание
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Foot height"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_base', '', config.Y0)
-	pos = pos + 0.8
-	-- снежная линия
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Snow line"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_snow_line', '', config.SNOW_LINE)
-	pos = pos + 0.8
-	-- сглаживание на крупном масштабе
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Big scale smooth"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_big', '', config.rk_big)
-	pos = pos + 0.8
-	-- сглаживание на малом масштабе
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Small scale smooth"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_small', '', config.rk_small)
-	pos = pos + 0.8
-	-- граница мелкого масштаба (лог2)
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Small scale (log2)"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_rk_thr', '', config.rk_thr)
-	pos = pos + 0.8
-
-	-- грунт сверху
-	formspec = formspec .. spec.label(0.5, pos - 0.3, S("Top dirt"))
-	formspec = formspec .. spec.field(3, pos, bw, 0.5, 'edit_top_cover', '', config.top_cover)
-	pos = pos + 0.8
-
-
-	formspec = formspec .. spec.button(1, pos, 3, 1, 'save_main', S("Save"))
-	formspec = formspec .. spec.button(4, pos, 3, 1, 'generate', S("Generate"))
-	pos = pos + 1
-
-	formspec = spec.size(width, pos) .. formspec
-
-	minetest.show_formspec(user_name, "mountgen:configure", formspec)
-end
-
-local function validate_config(config)
-	for k, v in pairs(config) do
-		if v == nil then
-			return false
-		end
-	end
-	if config.ANGLE < 15 or config.ANGLE > 90 then
-		return false
-	end
-	return true
-end
-
-minetest.register_on_player_receive_fields(function(clicker, formname, fields)
-	local player = clicker:get_player_name()
-	local can_edit = minetest.get_player_privs(player)[mountgen.required_priv]
-	if not can_edit then
-		return
-	end
-
-	if formname == "mountgen:configure" then
-		-- handling main form
-		if fields["save_main"] ~= nil or fields["generate"] ~= nil then
-			local config     = {}
-			config.METHOD    = fields["edit_method"]
-			config.ANGLE     = tonumber(fields["edit_angle"]) or 0
-			config.Y0        = tonumber(fields["edit_base"]) or 0
-			config.SNOW_LINE = tonumber(fields["edit_snow_line"]) or 0
-			config.rk_big    = tonumber(fields["edit_rk_big"]) or 0
-			config.rk_small  = tonumber(fields["edit_rk_small"]) or 0
-			config.rk_thr    = tonumber(fields["edit_rk_thr"]) or 0
-			config.top_cover = fields["edit_top_cover"]
-			if validate_config(config) then
-				mountgen.config.METHOD    = config.METHOD
-				mountgen.config.ANGLE     = config.ANGLE
-				mountgen.config.Y0        = config.Y0
-				mountgen.config.SNOW_LINE = config.SNOW_LINE
-				mountgen.config.rk_big    = config.rk_big
-				mountgen.config.rk_small  = config.rk_small
-				mountgen.config.rk_thr    = config.rk_thr
-				mountgen.config.top_cover = config.top_cover
-			end
-		end
-
-		if fields["generate"] ~= nil then
-			local top_position = clicker:get_pos()
-			local config       = mountgen.config
-			Logger.action("use mount stick at " .. top_position.x .. " " .. top_position.y .. " " .. top_position.z)
-			Logger.action("parameters: " .. dump(mountgen.config))
-			Generator:new(top_position, config):run()
-		end
-	end
-end)