]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - builtin/common/misc_helpers.lua
Improve shadow filters (#12195)
[dragonfireclient.git] / builtin / common / misc_helpers.lua
index 43a6dda48239ecd118b88a07f658180cbeb1c441..f5f89acd7942acdfb6963064fb42437e745d8bba 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
@@ -128,6 +130,7 @@ function dump(o, indent, nested, level)
        if t ~= "table" then
                return basic_dump(o)
        end
+
        -- Contains table -> true/nil of currently nested tables
        nested = nested or {}
        if nested[o] then
@@ -136,10 +139,11 @@ function dump(o, indent, nested, level)
        nested[o] = true
        indent = indent or "\t"
        level = level or 1
-       local t = {}
+
+       local ret = {}
        local dumped_indexes = {}
        for i, v in ipairs(o) do
-               t[#t + 1] = dump(v, indent, nested, level + 1)
+               ret[#ret + 1] = dump(v, indent, nested, level + 1)
                dumped_indexes[i] = true
        end
        for k, v in pairs(o) do
@@ -148,7 +152,7 @@ function dump(o, indent, nested, level)
                                k = "["..dump(k, indent, nested, level + 1).."]"
                        end
                        v = dump(v, indent, nested, level + 1)
-                       t[#t + 1] = k.." = "..v
+                       ret[#ret + 1] = k.." = "..v
                end
        end
        nested[o] = nil
@@ -157,18 +161,18 @@ function dump(o, indent, nested, level)
                local end_indent_str = "\n"..string.rep(indent, level - 1)
                return string.format("{%s%s%s}",
                                indent_str,
-                               table.concat(t, ","..indent_str),
+                               table.concat(ret, ","..indent_str),
                                end_indent_str)
        end
-       return "{"..table.concat(t, ", ").."}"
+       return "{"..table.concat(ret, ", ").."}"
 end
 
 --------------------------------------------------------------------------------
 function string.split(str, delim, include_empty, max_splits, sep_is_pattern)
        delim = delim or ","
-       max_splits = max_splits or -1
+       max_splits = max_splits or -2
        local items = {}
-       local pos, len, seplen = 1, #str, #delim
+       local pos, len = 1, #str
        local plain = not sep_is_pattern
        max_splits = max_splits + 1
        repeat
@@ -198,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"))
 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
 
 --------------------------------------------------------------------------------
@@ -244,63 +224,28 @@ function math.sign(x, tolerance)
 end
 
 --------------------------------------------------------------------------------
-function get_last_folder(text,count)
-       local parts = text:split(DIR_DELIM)
-
-       if count == nil then
-               return parts[#parts]
+function math.factorial(x)
+       assert(x % 1 == 0 and x >= 0, "factorial expects a non-negative integer")
+       if x >= 171 then
+               -- 171! is greater than the biggest double, no need to calculate
+               return math.huge
        end
-
-       local retval = ""
-       for i=1,count,1 do
-               retval = retval .. parts[#parts - (count-i)] .. DIR_DELIM
+       local v = 1
+       for k = 2, x do
+               v = v * k
        end
-
-       return retval
+       return v
 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]
+function math.round(x)
+       if x >= 0 then
+               return math.floor(x + 0.5)
        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
 
+
 function core.formspec_escape(text)
        if text ~= nil then
                text = string.gsub(text,"\\","\\\\")
@@ -349,7 +294,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
@@ -382,7 +328,7 @@ if INIT == "game" then
                        param2 = dirs1[fdir + 1]
                elseif isceiling then
                        if orient_flags.force_facedir then
-                               cparam2 = 20
+                               param2 = 20
                        else
                                param2 = dirs2[fdir + 1]
                        end
@@ -393,9 +339,8 @@ if INIT == "game" then
                end
 
                local old_itemstack = ItemStack(itemstack)
-               local new_itemstack, removed = core.item_place_node(
-                       itemstack, placer, pointed_thing, param2, prevent_after_place
-               )
+               local new_itemstack = core.item_place_node(itemstack, placer,
+                               pointed_thing, param2, prevent_after_place)
                return infinitestacks and old_itemstack or new_itemstack
        end
 
@@ -404,19 +349,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
-               core.rotate_and_place(itemstack, placer, pointed_thing,
-                               is_creative(name),
-                               {invert_wall = invert_wall}, true)
-               return itemstack
+               return core.rotate_and_place(itemstack, placer, pointed_thing,
+                       core.is_creative_enabled(name),
+                       {invert_wall = invert_wall}, true)
        end
 end
 
@@ -487,28 +425,23 @@ 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
+       local x, y, z = string.match(value, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
+       if x and y and z then
+               x = tonumber(x)
+               y = tonumber(y)
+               z = tonumber(z)
+               return vector.new(x, y, z)
        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
+       x, y, z = string.match(value, "^%( *([%d.-]+)[, ] *([%d.-]+)[, ] *([%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)
@@ -561,6 +494,29 @@ function table.insert_all(t, other)
 end
 
 
+function table.key_value_swap(t)
+       local ti = {}
+       for k,v in pairs(t) do
+               ti[v] = k
+       end
+       return ti
+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
 --------------------------------------------------------------------------------
@@ -576,7 +532,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('#', ...), ...}
@@ -685,6 +641,12 @@ end
 -- Returns the exact coordinate of a pointed surface
 --------------------------------------------------------------------------------
 function core.pointed_thing_to_face_pos(placer, pointed_thing)
+       -- Avoid crash in some situations when player is inside a node, causing
+       -- 'above' to equal 'under'.
+       if vector.equals(pointed_thing.above, pointed_thing.under) then
+               return pointed_thing.under
+       end
+
        local eye_height = placer:get_properties().eye_height
        local eye_offset_first = placer:get_eye_offset()
        local node_pos = pointed_thing.under
@@ -736,5 +698,6 @@ 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