]> git.lizzy.rs Git - minetest.git/blobdiff - builtin/common/misc_helpers.lua
Deserialization: Restore backwards compat (#12519)
[minetest.git] / builtin / common / misc_helpers.lua
index 199f13cd1d940d5ad55d1f885d980b413f7b0741..467f188049614df3a40328bb6ae58095e4d6bd10 100644 (file)
@@ -5,7 +5,7 @@
 local string_sub, string_find = string.sub, string.find
 
 --------------------------------------------------------------------------------
-function basic_dump(o)
+local function basic_dump(o)
        local tp = type(o)
        if tp == "number" then
                return tostring(o)
@@ -20,6 +20,8 @@ function basic_dump(o)
        -- dump's output is intended for humans.
        --elseif tp == "function" then
        --      return string.format("loadstring(%q)", string.dump(o))
+       elseif tp == "userdata" then
+               return tostring(o)
        else
                return string.format("<%s>", tp)
        end
@@ -200,38 +202,14 @@ function table.indexof(list, val)
        return -1
 end
 
-assert(table.indexof({"foo", "bar"}, "foo") == 1)
-assert(table.indexof({"foo", "bar"}, "baz") == -1)
-
---------------------------------------------------------------------------------
-if INIT ~= "client" then
-       function file_exists(filename)
-               local f = io.open(filename, "r")
-               if f == nil then
-                       return false
-               else
-                       f:close()
-                       return true
-               end
-       end
-end
 --------------------------------------------------------------------------------
 function string:trim()
-       return (self:gsub("^%s*(.-)%s*$", "%1"))
+       return self:match("^%s*(.-)%s*$")
 end
 
-assert(string.trim("\n \t\tfoo bar\t ") == "foo bar")
-
 --------------------------------------------------------------------------------
 function math.hypot(x, y)
-       local t
-       x = math.abs(x)
-       y = math.abs(y)
-       t = math.min(x, y)
-       x = math.max(x, y)
-       if x == 0 then return 0 end
-       t = t / x
-       return x * math.sqrt(1 + t * t)
+       return math.sqrt(x * x + y * y)
 end
 
 --------------------------------------------------------------------------------
@@ -259,73 +237,24 @@ function math.factorial(x)
        return v
 end
 
---------------------------------------------------------------------------------
-function get_last_folder(text,count)
-       local parts = text:split(DIR_DELIM)
-
-       if count == nil then
-               return parts[#parts]
-       end
 
-       local retval = ""
-       for i=1,count,1 do
-               retval = retval .. parts[#parts - (count-i)] .. DIR_DELIM
+function math.round(x)
+       if x >= 0 then
+               return math.floor(x + 0.5)
        end
-
-       return retval
-end
-
---------------------------------------------------------------------------------
-function cleanup_path(temppath)
-
-       local parts = temppath:split("-")
-       temppath = ""
-       for i=1,#parts,1 do
-               if temppath ~= "" then
-                       temppath = temppath .. "_"
-               end
-               temppath = temppath .. parts[i]
-       end
-
-       parts = temppath:split(".")
-       temppath = ""
-       for i=1,#parts,1 do
-               if temppath ~= "" then
-                       temppath = temppath .. "_"
-               end
-               temppath = temppath .. parts[i]
-       end
-
-       parts = temppath:split("'")
-       temppath = ""
-       for i=1,#parts,1 do
-               if temppath ~= "" then
-                       temppath = temppath .. ""
-               end
-               temppath = temppath .. parts[i]
-       end
-
-       parts = temppath:split(" ")
-       temppath = ""
-       for i=1,#parts,1 do
-               if temppath ~= "" then
-                       temppath = temppath
-               end
-               temppath = temppath .. parts[i]
-       end
-
-       return temppath
+       return math.ceil(x - 0.5)
 end
 
+local formspec_escapes = {
+       ["\\"] = "\\\\",
+       ["["] = "\\[",
+       ["]"] = "\\]",
+       [";"] = "\\;",
+       [","] = "\\,"
+}
 function core.formspec_escape(text)
-       if text ~= nil then
-               text = string.gsub(text,"\\","\\\\")
-               text = string.gsub(text,"%]","\\]")
-               text = string.gsub(text,"%[","\\[")
-               text = string.gsub(text,";","\\;")
-               text = string.gsub(text,",","\\,")
-       end
-       return text
+       -- Use explicit character set instead of dot here because it doubles the performance
+       return text and string.gsub(text, "[\\%[%];,]", formspec_escapes)
 end
 
 
@@ -336,18 +265,21 @@ function core.wrap_text(text, max_length, as_table)
                return as_table and {text} or text
        end
 
-       for word in text:gmatch('%S+') do
-               local cur_length = #table.concat(line, ' ')
-               if cur_length > 0 and cur_length + #word + 1 >= max_length then
+       local line_length = 0
+       for word in text:gmatch("%S+") do
+               if line_length > 0 and line_length + #word + 1 >= max_length then
                        -- word wouldn't fit on current line, move to next line
-                       table.insert(result, table.concat(line, ' '))
-                       line = {}
+                       table.insert(result, table.concat(line, " "))
+                       line = {word}
+                       line_length = #word
+               else
+                       table.insert(line, word)
+                       line_length = line_length + 1 + #word
                end
-               table.insert(line, word)
        end
 
-       table.insert(result, table.concat(line, ' '))
-       return as_table and result or table.concat(result, '\n')
+       table.insert(result, table.concat(line, " "))
+       return as_table and result or table.concat(result, "\n")
 end
 
 --------------------------------------------------------------------------------
@@ -365,7 +297,8 @@ if INIT == "game" then
                        return
                end
                local undef = core.registered_nodes[unode.name]
-               if undef and undef.on_rightclick then
+               local sneaking = placer and placer:get_player_control().sneak
+               if undef and undef.on_rightclick and not sneaking then
                        return undef.on_rightclick(pointed_thing.under, unode, placer,
                                        itemstack, pointed_thing)
                end
@@ -419,18 +352,12 @@ if INIT == "game" then
 --Wrapper for rotate_and_place() to check for sneak and assume Creative mode
 --implies infinite stacks when performing a 6d rotation.
 --------------------------------------------------------------------------------
-       local creative_mode_cache = core.settings:get_bool("creative_mode")
-       local function is_creative(name)
-               return creative_mode_cache or
-                               core.check_player_privs(name, {creative = true})
-       end
-
        core.rotate_node = function(itemstack, placer, pointed_thing)
                local name = placer and placer:get_player_name() or ""
                local invert_wall = placer and placer:get_player_control().sneak or false
                return core.rotate_and_place(itemstack, placer, pointed_thing,
-                               is_creative(name),
-                               {invert_wall = invert_wall}, true)
+                       core.is_creative_enabled(name),
+                       {invert_wall = invert_wall}, true)
        end
 end
 
@@ -501,59 +428,50 @@ function core.string_to_pos(value)
                return nil
        end
 
-       local p = {}
-       p.x, p.y, p.z = string.match(value, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
-       if p.x and p.y and p.z then
-               p.x = tonumber(p.x)
-               p.y = tonumber(p.y)
-               p.z = tonumber(p.z)
-               return p
-       end
-       p = {}
-       p.x, p.y, p.z = string.match(value, "^%( *([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+) *%)$")
-       if p.x and p.y and p.z then
-               p.x = tonumber(p.x)
-               p.y = tonumber(p.y)
-               p.z = tonumber(p.z)
-               return p
+       value = value:match("^%((.-)%)$") or value -- strip parentheses
+
+       local x, y, z = value:trim():match("^([%d.-]+)[,%s]%s*([%d.-]+)[,%s]%s*([%d.-]+)$")
+       if x and y and z then
+               x = tonumber(x)
+               y = tonumber(y)
+               z = tonumber(z)
+               return vector.new(x, y, z)
        end
+
        return nil
 end
 
-assert(core.string_to_pos("10.0, 5, -2").x == 10)
-assert(core.string_to_pos("( 10.0, 5, -2)").z == -2)
-assert(core.string_to_pos("asd, 5, -2)") == nil)
 
 --------------------------------------------------------------------------------
-function core.string_to_area(value)
-       local p1, p2 = unpack(value:split(") ("))
-       if p1 == nil or p2 == nil then
-               return nil
-       end
 
-       p1 = core.string_to_pos(p1 .. ")")
-       p2 = core.string_to_pos("(" .. p2)
-       if p1 == nil or p2 == nil then
-               return nil
+do
+       local rel_num_cap = "(~?-?%d*%.?%d*)" -- may be overly permissive as this will be tonumber'ed anyways
+       local num_delim = "[,%s]%s*"
+       local pattern = "^" .. table.concat({rel_num_cap, rel_num_cap, rel_num_cap}, num_delim) .. "$"
+
+       local function parse_area_string(pos, relative_to)
+               local pp = {}
+               pp.x, pp.y, pp.z = pos:trim():match(pattern)
+               return core.parse_coordinates(pp.x, pp.y, pp.z, relative_to)
        end
 
-       return p1, p2
-end
+       function core.string_to_area(value, relative_to)
+               local p1, p2 = value:match("^%((.-)%)%s*%((.-)%)$")
+               if not p1 then
+                       return
+               end
 
-local function test_string_to_area()
-       local p1, p2 = core.string_to_area("(10.0, 5, -2) (  30.2,   4, -12.53)")
-       assert(p1.x == 10.0 and p1.y == 5 and p1.z == -2)
-       assert(p2.x == 30.2 and p2.y == 4 and p2.z == -12.53)
+               p1 = parse_area_string(p1, relative_to)
+               p2 = parse_area_string(p2, relative_to)
 
-       p1, p2 = core.string_to_area("(10.0, 5, -2  30.2,   4, -12.53")
-       assert(p1 == nil and p2 == nil)
+               if p1 == nil or p2 == nil then
+                       return
+               end
 
-       p1, p2 = core.string_to_area("(10.0, 5,) -2  fgdf2,   4, -12.53")
-       assert(p1 == nil and p2 == nil)
+               return p1, p2
+       end
 end
 
-test_string_to_area()
-
 --------------------------------------------------------------------------------
 function table.copy(t, seen)
        local n = {}
@@ -584,6 +502,20 @@ function table.key_value_swap(t)
 end
 
 
+function table.shuffle(t, from, to, random)
+       from = from or 1
+       to = to or #t
+       random = random or math.random
+       local n = to - from + 1
+       while n > 1 do
+               local r = from + n-1
+               local l = from + random(0, n-1)
+               t[l], t[r] = t[r], t[l]
+               n = n-1
+       end
+end
+
+
 --------------------------------------------------------------------------------
 -- mainmenu only functions
 --------------------------------------------------------------------------------
@@ -599,7 +531,7 @@ if INIT == "mainmenu" then
        end
 end
 
-if INIT == "client" or INIT == "mainmenu" then
+if core.gettext then -- for client and mainmenu
        function fgettext_ne(text, ...)
                text = core.gettext(text)
                local arg = {n=select('#', ...), ...}
@@ -765,5 +697,74 @@ function core.privs_to_string(privs, delim)
        return table.concat(list, delim)
 end
 
-assert(core.string_to_privs("a,b").b == true)
-assert(core.privs_to_string({a=true,b=true}) == "a,b")
+function core.is_nan(number)
+       return number ~= number
+end
+
+--[[ Helper function for parsing an optionally relative number
+of a chat command parameter, using the chat command tilde notation.
+
+Parameters:
+* arg: String snippet containing the number; possible values:
+    * "<number>": return as number
+    * "~<number>": return relative_to + <number>
+    * "~": return relative_to
+    * Anything else will return `nil`
+* relative_to: Number to which the `arg` number might be relative to
+
+Returns:
+A number or `nil`, depending on `arg.
+
+Examples:
+* `core.parse_relative_number("5", 10)` returns 5
+* `core.parse_relative_number("~5", 10)` returns 15
+* `core.parse_relative_number("~", 10)` returns 10
+]]
+function core.parse_relative_number(arg, relative_to)
+       if not arg then
+               return nil
+       elseif arg == "~" then
+               return relative_to
+       elseif string.sub(arg, 1, 1) == "~" then
+               local number = tonumber(string.sub(arg, 2))
+               if not number then
+                       return nil
+               end
+               if core.is_nan(number) or number == math.huge or number == -math.huge then
+                       return nil
+               end
+               return relative_to + number
+       else
+               local number = tonumber(arg)
+               if core.is_nan(number) or number == math.huge or number == -math.huge then
+                       return nil
+               end
+               return number
+       end
+end
+
+--[[ Helper function to parse coordinates that might be relative
+to another position; supports chat command tilde notation.
+Intended to be used in chat command parameter parsing.
+
+Parameters:
+* x, y, z: Parsed x, y, and z coordinates as strings
+* relative_to: Position to which to compare the position
+
+Syntax of x, y and z:
+* "<number>": return as number
+* "~<number>": return <number> + player position on this axis
+* "~": return player position on this axis
+
+Returns: a vector or nil for invalid input or if player does not exist
+]]
+function core.parse_coordinates(x, y, z, relative_to)
+       if not relative_to then
+               x, y, z = tonumber(x), tonumber(y), tonumber(z)
+               return x and y and z and { x = x, y = y, z = z }
+       end
+       local rx = core.parse_relative_number(x, relative_to.x)
+       local ry = core.parse_relative_number(y, relative_to.y)
+       local rz = core.parse_relative_number(z, relative_to.z)
+       return rx and ry and rz and { x = rx, y = ry, z = rz }
+end