1 -- Minetest: builtin/misc_helpers.lua
3 --------------------------------------------------------------------------------
4 -- Localize functions to avoid table lookups (better performance).
5 local string_sub, string_find = string.sub, string.find
7 --------------------------------------------------------------------------------
8 local function basic_dump(o)
10 if tp == "number" then
12 elseif tp == "string" then
13 return string.format("%q", o)
14 elseif tp == "boolean" then
16 elseif tp == "nil" then
18 -- Uncomment for full function dumping support.
19 -- Not currently enabled because bytecode isn't very human-readable and
20 -- dump's output is intended for humans.
21 --elseif tp == "function" then
22 -- return string.format("loadstring(%q)", string.dump(o))
23 elseif tp == "userdata" then
26 return string.format("<%s>", tp)
40 ["goto"] = true, -- Lua 5.2
54 local function is_valid_identifier(str)
55 if not str:find("^[a-zA-Z_][a-zA-Z0-9_]*$") or keywords[str] then
61 --------------------------------------------------------------------------------
62 -- Dumps values in a line-per-value format.
63 -- For example, {test = {"Testing..."}} becomes:
65 -- _["test"][1] = "Testing..."
66 -- This handles tables as keys and circular references properly.
67 -- It also handles multiple references well, writing the table only once.
68 -- The dumped argument is internal-only.
70 function dump2(o, name, dumped)
72 -- "dumped" is used to keep track of serialized tables to handle
73 -- multiple references and circular tables properly.
74 -- It only contains tables as keys. The value is the name that
75 -- the table has in the dump, eg:
76 -- {x = {"y"}} -> dumped[{"y"}] = '_["x"]'
78 if type(o) ~= "table" then
79 return string.format("%s = %s\n", name, basic_dump(o))
82 return string.format("%s = %s\n", name, dumped[o])
85 -- This contains a list of strings to be concatenated later (because
86 -- Lua is slow at individual concatenation).
88 for k, v in pairs(o) do
90 if type(k) == "table" then
94 -- Key tables don't have a name, so use one of
95 -- the form _G["table: 0xFFFFFFF"]
96 keyStr = string.format("_G[%q]", tostring(k))
98 t[#t + 1] = dump2(k, keyStr, dumped)
101 keyStr = basic_dump(k)
103 local vname = string.format("%s[%s]", name, keyStr)
104 t[#t + 1] = dump2(v, vname, dumped)
106 return string.format("%s = {}\n%s", name, table.concat(t))
109 --------------------------------------------------------------------------------
110 -- This dumps values in a one-statement format.
111 -- For example, {test = {"Testing..."}} becomes:
117 -- This supports tables as keys, but not circular references.
118 -- It performs poorly with multiple references as it writes out the full
120 -- The indent field specifies a indentation string, it defaults to a tab.
121 -- Use the empty string to disable indentation.
122 -- The dumped and level arguments are internal-only.
124 function dump(o, indent, nested, level)
126 if not level and t == "userdata" then
127 -- when userdata (e.g. player) is passed directly, print its metatable:
128 return "userdata metatable: " .. dump(getmetatable(o))
134 -- Contains table -> true/nil of currently nested tables
135 nested = nested or {}
137 return "<circular reference>"
140 indent = indent or "\t"
144 local dumped_indexes = {}
145 for i, v in ipairs(o) do
146 ret[#ret + 1] = dump(v, indent, nested, level + 1)
147 dumped_indexes[i] = true
149 for k, v in pairs(o) do
150 if not dumped_indexes[k] then
151 if type(k) ~= "string" or not is_valid_identifier(k) then
152 k = "["..dump(k, indent, nested, level + 1).."]"
154 v = dump(v, indent, nested, level + 1)
155 ret[#ret + 1] = k.." = "..v
160 local indent_str = "\n"..string.rep(indent, level)
161 local end_indent_str = "\n"..string.rep(indent, level - 1)
162 return string.format("{%s%s%s}",
164 table.concat(ret, ","..indent_str),
167 return "{"..table.concat(ret, ", ").."}"
170 --------------------------------------------------------------------------------
171 function string.split(str, delim, include_empty, max_splits, sep_is_pattern)
173 max_splits = max_splits or -2
175 local pos, len = 1, #str
176 local plain = not sep_is_pattern
177 max_splits = max_splits + 1
179 local np, npe = string_find(str, delim, pos, plain)
180 np, npe = (np or (len+1)), (npe or (len+1))
181 if (not np) or (max_splits == 1) then
185 local s = string_sub(str, pos, np - 1)
186 if include_empty or (s ~= "") then
187 max_splits = max_splits - 1
188 items[#items + 1] = s
191 until (max_splits == 0) or (pos > (len + 1))
195 --------------------------------------------------------------------------------
196 function table.indexof(list, val)
197 for i, v in ipairs(list) do
205 --------------------------------------------------------------------------------
206 function string:trim()
207 return (self:gsub("^%s*(.-)%s*$", "%1"))
210 --------------------------------------------------------------------------------
211 function math.hypot(x, y)
212 return math.sqrt(x * x + y * y)
215 --------------------------------------------------------------------------------
216 function math.sign(x, tolerance)
217 tolerance = tolerance or 0
218 if x > tolerance then
220 elseif x < -tolerance then
226 --------------------------------------------------------------------------------
227 function math.factorial(x)
228 assert(x % 1 == 0 and x >= 0, "factorial expects a non-negative integer")
230 -- 171! is greater than the biggest double, no need to calculate
241 function math.round(x)
243 return math.floor(x + 0.5)
245 return math.ceil(x - 0.5)
249 function core.formspec_escape(text)
251 text = string.gsub(text,"\\","\\\\")
252 text = string.gsub(text,"%]","\\]")
253 text = string.gsub(text,"%[","\\[")
254 text = string.gsub(text,";","\\;")
255 text = string.gsub(text,",","\\,")
261 function core.wrap_text(text, max_length, as_table)
264 if #text <= max_length then
265 return as_table and {text} or text
268 for word in text:gmatch('%S+') do
269 local cur_length = #table.concat(line, ' ')
270 if cur_length > 0 and cur_length + #word + 1 >= max_length then
271 -- word wouldn't fit on current line, move to next line
272 table.insert(result, table.concat(line, ' '))
275 table.insert(line, word)
278 table.insert(result, table.concat(line, ' '))
279 return as_table and result or table.concat(result, '\n')
282 --------------------------------------------------------------------------------
284 if INIT == "game" then
285 local dirs1 = {9, 18, 7, 12}
286 local dirs2 = {20, 23, 22, 21}
288 function core.rotate_and_place(itemstack, placer, pointed_thing,
289 infinitestacks, orient_flags, prevent_after_place)
290 orient_flags = orient_flags or {}
292 local unode = core.get_node_or_nil(pointed_thing.under)
296 local undef = core.registered_nodes[unode.name]
297 local sneaking = placer and placer:get_player_control().sneak
298 if undef and undef.on_rightclick and not sneaking then
299 return undef.on_rightclick(pointed_thing.under, unode, placer,
300 itemstack, pointed_thing)
302 local fdir = placer and core.dir_to_facedir(placer:get_look_dir()) or 0
304 local above = pointed_thing.above
305 local under = pointed_thing.under
306 local iswall = (above.y == under.y)
307 local isceiling = not iswall and (above.y < under.y)
309 if undef and undef.buildable_to then
313 if orient_flags.force_floor then
316 elseif orient_flags.force_ceiling then
319 elseif orient_flags.force_wall then
322 elseif orient_flags.invert_wall then
328 param2 = dirs1[fdir + 1]
329 elseif isceiling then
330 if orient_flags.force_facedir then
333 param2 = dirs2[fdir + 1]
335 else -- place right side up
336 if orient_flags.force_facedir then
341 local old_itemstack = ItemStack(itemstack)
342 local new_itemstack = core.item_place_node(itemstack, placer,
343 pointed_thing, param2, prevent_after_place)
344 return infinitestacks and old_itemstack or new_itemstack
348 --------------------------------------------------------------------------------
349 --Wrapper for rotate_and_place() to check for sneak and assume Creative mode
350 --implies infinite stacks when performing a 6d rotation.
351 --------------------------------------------------------------------------------
352 core.rotate_node = function(itemstack, placer, pointed_thing)
353 local name = placer and placer:get_player_name() or ""
354 local invert_wall = placer and placer:get_player_control().sneak or false
355 return core.rotate_and_place(itemstack, placer, pointed_thing,
356 core.is_creative_enabled(name),
357 {invert_wall = invert_wall}, true)
361 --------------------------------------------------------------------------------
362 function core.explode_table_event(evt)
364 local parts = evt:split(":")
366 local t = parts[1]:trim()
367 local r = tonumber(parts[2]:trim())
368 local c = tonumber(parts[3]:trim())
369 if type(r) == "number" and type(c) == "number"
371 return {type=t, row=r, column=c}
375 return {type="INV", row=0, column=0}
378 --------------------------------------------------------------------------------
379 function core.explode_textlist_event(evt)
381 local parts = evt:split(":")
383 local t = parts[1]:trim()
384 local r = tonumber(parts[2]:trim())
385 if type(r) == "number" and t ~= "INV" then
386 return {type=t, index=r}
390 return {type="INV", index=0}
393 --------------------------------------------------------------------------------
394 function core.explode_scrollbar_event(evt)
395 local retval = core.explode_textlist_event(evt)
397 retval.value = retval.index
403 --------------------------------------------------------------------------------
404 function core.rgba(r, g, b, a)
405 return a and string.format("#%02X%02X%02X%02X", r, g, b, a) or
406 string.format("#%02X%02X%02X", r, g, b)
409 --------------------------------------------------------------------------------
410 function core.pos_to_string(pos, decimal_places)
414 if decimal_places ~= nil then
415 x = string.format("%." .. decimal_places .. "f", x)
416 y = string.format("%." .. decimal_places .. "f", y)
417 z = string.format("%." .. decimal_places .. "f", z)
419 return "(" .. x .. "," .. y .. "," .. z .. ")"
422 --------------------------------------------------------------------------------
423 function core.string_to_pos(value)
428 value = value:match("^%((.-)%)$") or value -- strip parentheses
430 local x, y, z = value:trim():match("^([%d.-]+)[,%s]%s*([%d.-]+)[,%s]%s*([%d.-]+)$")
431 if x and y and z then
435 return vector.new(x, y, z)
442 --------------------------------------------------------------------------------
445 local rel_num_cap = "(~?-?%d*%.?%d*)" -- may be overly permissive as this will be tonumber'ed anyways
446 local num_delim = "[,%s]%s*"
447 local pattern = "^" .. table.concat({rel_num_cap, rel_num_cap, rel_num_cap}, num_delim) .. "$"
449 local function parse_area_string(pos, relative_to)
451 pp.x, pp.y, pp.z = pos:trim():match(pattern)
452 return core.parse_coordinates(pp.x, pp.y, pp.z, relative_to)
455 function core.string_to_area(value, relative_to)
456 local p1, p2 = value:match("^%((.-)%)%s*%((.-)%)$")
461 p1 = parse_area_string(p1, relative_to)
462 p2 = parse_area_string(p2, relative_to)
464 if p1 == nil or p2 == nil then
472 --------------------------------------------------------------------------------
473 function table.copy(t, seen)
477 for k, v in pairs(t) do
478 n[(type(k) == "table" and (seen[k] or table.copy(k, seen))) or k] =
479 (type(v) == "table" and (seen[v] or table.copy(v, seen))) or v
485 function table.insert_all(t, other)
493 function table.key_value_swap(t)
495 for k,v in pairs(t) do
502 function table.shuffle(t, from, to, random)
505 random = random or math.random
506 local n = to - from + 1
509 local l = from + random(0, n-1)
510 t[l], t[r] = t[r], t[l]
516 --------------------------------------------------------------------------------
517 -- mainmenu only functions
518 --------------------------------------------------------------------------------
519 if INIT == "mainmenu" then
520 function core.get_game(index)
521 local games = core.get_games()
523 if index > 0 and index <= #games then
531 if core.gettext then -- for client and mainmenu
532 function fgettext_ne(text, ...)
533 text = core.gettext(text)
534 local arg = {n=select('#', ...), ...}
536 -- Insert positional parameters ($1, $2, ...)
539 while pos <= text:len() do
540 local newpos = text:find('[$]', pos)
541 if newpos == nil then
542 result = result .. text:sub(pos)
546 tonumber(text:sub(newpos+1, newpos+1))
547 result = result .. text:sub(pos, newpos-1)
548 .. tostring(arg[paramindex])
557 function fgettext(text, ...)
558 return core.formspec_escape(fgettext_ne(text, ...))
562 local ESCAPE_CHAR = string.char(0x1b)
564 function core.get_color_escape_sequence(color)
565 return ESCAPE_CHAR .. "(c@" .. color .. ")"
568 function core.get_background_escape_sequence(color)
569 return ESCAPE_CHAR .. "(b@" .. color .. ")"
572 function core.colorize(color, message)
573 local lines = tostring(message):split("\n", true)
574 local color_code = core.get_color_escape_sequence(color)
576 for i, line in ipairs(lines) do
577 lines[i] = color_code .. line
580 return table.concat(lines, "\n") .. core.get_color_escape_sequence("#ffffff")
584 function core.strip_foreground_colors(str)
585 return (str:gsub(ESCAPE_CHAR .. "%(c@[^)]+%)", ""))
588 function core.strip_background_colors(str)
589 return (str:gsub(ESCAPE_CHAR .. "%(b@[^)]+%)", ""))
592 function core.strip_colors(str)
593 return (str:gsub(ESCAPE_CHAR .. "%([bc]@[^)]+%)", ""))
596 function core.translate(textdomain, str, ...)
598 if textdomain == "" then
599 start_seq = ESCAPE_CHAR .. "T"
601 start_seq = ESCAPE_CHAR .. "(T@" .. textdomain .. ")"
603 local arg = {n=select('#', ...), ...}
604 local end_seq = ESCAPE_CHAR .. "E"
606 local translated = str:gsub("@(.)", function(matched)
607 local c = string.byte(matched)
608 if string.byte("1") <= c and c <= string.byte("9") then
609 local a = c - string.byte("0")
610 if a ~= arg_index then
611 error("Escape sequences in string given to core.translate " ..
612 "are not in the correct order: got @" .. matched ..
613 "but expected @" .. tostring(arg_index))
616 error("Not enough arguments provided to core.translate")
618 arg_index = arg_index + 1
619 return ESCAPE_CHAR .. "F" .. arg[a] .. ESCAPE_CHAR .. "E"
620 elseif matched == "n" then
626 if arg_index < arg.n + 1 then
627 error("Too many arguments provided to core.translate")
629 return start_seq .. translated .. end_seq
632 function core.get_translator(textdomain)
633 return function(str, ...) return core.translate(textdomain or "", str, ...) end
636 --------------------------------------------------------------------------------
637 -- Returns the exact coordinate of a pointed surface
638 --------------------------------------------------------------------------------
639 function core.pointed_thing_to_face_pos(placer, pointed_thing)
640 -- Avoid crash in some situations when player is inside a node, causing
641 -- 'above' to equal 'under'.
642 if vector.equals(pointed_thing.above, pointed_thing.under) then
643 return pointed_thing.under
646 local eye_height = placer:get_properties().eye_height
647 local eye_offset_first = placer:get_eye_offset()
648 local node_pos = pointed_thing.under
649 local camera_pos = placer:get_pos()
650 local pos_off = vector.multiply(
651 vector.subtract(pointed_thing.above, node_pos), 0.5)
652 local look_dir = placer:get_look_dir()
656 for c, v in pairs(pos_off) do
665 local fine_pos = {[nc] = node_pos[nc] + offset}
666 camera_pos.y = camera_pos.y + eye_height + eye_offset_first.y / 10
667 local f = (node_pos[nc] + offset - camera_pos[nc]) / look_dir[nc]
670 fine_pos[oc[i]] = camera_pos[oc[i]] + look_dir[oc[i]] * f
675 function core.string_to_privs(str, delim)
676 assert(type(str) == "string")
679 for _, priv in pairs(string.split(str, delim)) do
680 privs[priv:trim()] = true
685 function core.privs_to_string(privs, delim)
686 assert(type(privs) == "table")
689 for priv, bool in pairs(privs) do
691 list[#list + 1] = priv
694 return table.concat(list, delim)
697 function core.is_nan(number)
698 return number ~= number
701 --[[ Helper function for parsing an optionally relative number
702 of a chat command parameter, using the chat command tilde notation.
705 * arg: String snippet containing the number; possible values:
706 * "<number>": return as number
707 * "~<number>": return relative_to + <number>
708 * "~": return relative_to
709 * Anything else will return `nil`
710 * relative_to: Number to which the `arg` number might be relative to
713 A number or `nil`, depending on `arg.
716 * `core.parse_relative_number("5", 10)` returns 5
717 * `core.parse_relative_number("~5", 10)` returns 15
718 * `core.parse_relative_number("~", 10)` returns 10
720 function core.parse_relative_number(arg, relative_to)
723 elseif arg == "~" then
725 elseif string.sub(arg, 1, 1) == "~" then
726 local number = tonumber(string.sub(arg, 2))
730 if core.is_nan(number) or number == math.huge or number == -math.huge then
733 return relative_to + number
735 local number = tonumber(arg)
736 if core.is_nan(number) or number == math.huge or number == -math.huge then
743 --[[ Helper function to parse coordinates that might be relative
744 to another position; supports chat command tilde notation.
745 Intended to be used in chat command parameter parsing.
748 * x, y, z: Parsed x, y, and z coordinates as strings
749 * relative_to: Position to which to compare the position
751 Syntax of x, y and z:
752 * "<number>": return as number
753 * "~<number>": return <number> + player position on this axis
754 * "~": return player position on this axis
756 Returns: a vector or nil for invalid input or if player does not exist
758 function core.parse_coordinates(x, y, z, relative_to)
759 if not relative_to then
760 x, y, z = tonumber(x), tonumber(y), tonumber(z)
761 return x and y and z and { x = x, y = y, z = z }
763 local rx = core.parse_relative_number(x, relative_to.x)
764 local ry = core.parse_relative_number(y, relative_to.y)
765 local rz = core.parse_relative_number(z, relative_to.z)
766 return rx and ry and rz and { x = rx, y = ry, z = rz }