fslib/init.lua

fslib = {}

local formspecs = {}

local id = 1

minetest.register_on_leaveplayer(function(player)
	formspecs[player:get_player_name()] = nil
end)

-- S-expression formspec AST to string; purely a syntactical string building helper unaware of semantics
local function build_formspec(formspec)
	local rope = {}
	local function write(text)
		return table.insert(rope, text)
	end
	local function write_escaped(text)
		return write(minetest.formspec_escape(text))
	end
	local function write_primitive(param, write_func)
		write_func = write_func or write_escaped
		if param == true then
			return write_func"true"
		end
		if param == false then
			return write_func"false"
		end
		local type_ = type(param)
		if type_ == "number" then
			return write_func((param % 1 == 0 and "%d" or "%f"):format(param))
		end
		if type_ == "string" then
			return write_func(param)
		end
		error("primitive type expected, got " .. type_)
	end
	local function write_options(options, delim)
		local options_pushed = false
		for key, value in pairs(options) do
			if type(key) == "string" then
				if options_pushed then
					write(delim)
				end
				write_escaped(key)
				write"="
				write_primitive(value)
				options_pushed = true
			end
		end
	end
	local function write_hypertext_escaped(text)
		return write_escaped(text:gsub(".", { ["\\"] = [[\\]], ["<"] = [[\<]] }))
	end
	local function write_hypertext_primitive(value)
		return write_primitive(value, write_hypertext_escaped)
	end
	local function write_hypertext(element)
		local mt = getmetatable(element) or {}
		if mt.tag_name then
			write"<"
			write_hypertext_escaped(mt.tag_name)
			for k, v in pairs(element) do
				if type(k) == "string" then
					write" "
					write_hypertext_primitive(k)
					write"="
					write_hypertext_primitive(v)
				end
			end
			write">"
		end
		if mt.self_enclosing then
			assert(#element == 0)
			return
		end
		for _, child in ipairs(element) do
			if type(child) == "string" then
				write_hypertext_primitive(child)
			else
				write_hypertext(child)
			end
		end
		if mt.tag_name then
			write"</"
			write_hypertext_escaped(mt.tag_name)
			write">"
		end
	end
	for _, element in ipairs(formspec) do
		if type(element) == "string" then -- assume top-level elements are simply formspec elements in string form
			write(element)
		else
			write(element[1])
			write"["
			local len = #element
			for index = 2, len do
				if index > 2 then write";" end
				local param = element[index]
				if type(param) == "table" then
					local mt = getmetatable(param)
					if mt and mt.hypertext then
						write_hypertext(param)
					elseif param[1] == nil then -- sub-options or empty table
						write_options(param, ",")
					else -- comma-delimited subparam list
						for subindex, subparam in ipairs(param) do
							if subindex > 1 then write"," end
							write_primitive(subparam)
						end
					end
				else
					write_primitive(param)
				end
			end
			if len == 1 then -- options element or empty table
				write_options(element, ";")
			end
			write"]"
			write"\n" -- for debugging purposes (improved readability)
		end
	end
	return table.concat(rope)
end

function fslib.build_formspec(formspec)
	if type(formspec) == "table" then
		return build_formspec(formspec)
	end
	return formspec
end

local self_enclosing = modlib.table.set{"item", "img", "tag", "global"}
fslib.hypertext_tags = modlib.func.memoize(function(tag_name)
	local metatable = {
		hypertext = true,
		tag_name = tag_name,
		self_enclosing = self_enclosing[tag_name]
	}
	return function(table)
		return setmetatable(table, metatable)
	end
end)

fslib.hypertext_root = fslib.hypertext_tags[false]

function fslib.show_formspec(player, formspec, handler)
	formspec = fslib.build_formspec(formspec)
	local player_name = player:get_player_name()
	local formspec_name = ("fslib:%d"):format(id)
	formspecs[player_name] = {
		name = formspec_name,
		handler = handler or modlib.func.no_op,
	}
	id = id + 1
	if id > 2^50 then id = 1 end
	minetest.show_formspec(player_name, formspec_name, formspec)
	return formspec_name
end

function fslib.reshow_formspec(player, formspec_name, formspec)
	local player_name = player:get_player_name()
	assert(formspecs[player_name].name == formspec_name)
	minetest.show_formspec(player_name, formspec_name, fslib.build_formspec(formspec))
end

function fslib.close_formspec(player)
	local player_name = player:get_player_name()
	local formspec = assert(formspecs[player_name])
	formspecs[player_name] = nil
	minetest.close_formspec(player_name, formspec.name)
end

minetest.register_on_player_receive_fields(function(player, formname, fields)
	local player_name = player:get_player_name()
	local formspec = formspecs[player_name]
	if formname ~= (formspec or {}).name then return end
	if fields.quit then
		formspecs[player_name] = nil
	end
	local updated_formspec = formspec.handler(fields)
	if updated_formspec then
		if fields.quit then
			fslib.show_formspec(player, updated_formspec, formspec.handler)
		else
			minetest.show_formspec(player_name, formspec.name, fslib.build_formspec(updated_formspec))
		end
	end
	return true -- don't call remaining functions
end)