]> git.lizzy.rs Git - minetest.git/blobdiff - builtin/common/misc_helpers.lua
Add minetest.rgba function that returns ColorString from RGBA or RGB values
[minetest.git] / builtin / common / misc_helpers.lua
index 713555109cad1ac4e792e52e3c874c64af6c3e1e..776be29d899f86b79340010590f2aa6655f0dc6c 100644 (file)
@@ -1,5 +1,9 @@
 -- Minetest: builtin/misc_helpers.lua
 
+--------------------------------------------------------------------------------
+-- Localize functions to avoid table lookups (better performance).
+local string_sub, string_find = string.sub, string.find
+
 --------------------------------------------------------------------------------
 function basic_dump(o)
        local tp = type(o)
@@ -89,13 +93,13 @@ function dump2(o, name, dumped)
                                -- the form _G["table: 0xFFFFFFF"]
                                keyStr = string.format("_G[%q]", tostring(k))
                                -- Dump key table
-                               table.insert(t, dump2(k, keyStr, dumped))
+                               t[#t + 1] = dump2(k, keyStr, dumped)
                        end
                else
                        keyStr = basic_dump(k)
                end
                local vname = string.format("%s[%s]", name, keyStr)
-               table.insert(t, dump2(v, vname, dumped))
+               t[#t + 1] = dump2(v, vname, dumped)
        end
        return string.format("%s = {}\n%s", name, table.concat(t))
 end
@@ -130,7 +134,7 @@ function dump(o, indent, nested, level)
        local t = {}
        local dumped_indexes = {}
        for i, v in ipairs(o) do
-               table.insert(t, dump(v, indent, nested, level + 1))
+               t[#t + 1] = dump(v, indent, nested, level + 1)
                dumped_indexes[i] = true
        end
        for k, v in pairs(o) do
@@ -139,7 +143,7 @@ function dump(o, indent, nested, level)
                                k = "["..dump(k, indent, nested, level + 1).."]"
                        end
                        v = dump(v, indent, nested, level + 1)
-                       table.insert(t, k.." = "..v)
+                       t[#t + 1] = k.." = "..v
                end
        end
        nested[o] = nil
@@ -155,44 +159,55 @@ function dump(o, indent, nested, level)
 end
 
 --------------------------------------------------------------------------------
-function string.split(str, delim, include_empty, max_splits)
+function string.split(str, delim, include_empty, max_splits, sep_is_pattern)
        delim = delim or ","
-       max_splits = max_splits or 0
-       local fields = {}
-       local num_splits = 0
-       local last_pos = 0
-       for part, pos in str:gmatch("(.-)[" .. delim .. "]()") do
-               last_pos = pos
-               if include_empty or part ~= "" then
-                       num_splits = num_splits + 1
-                       fields[num_splits] = part
-                       if max_splits > 0 and num_splits + 1 >= max_splits then
-                               break
-                       end
+       max_splits = max_splits or -1
+       local items = {}
+       local pos, len, seplen = 1, #str, #delim
+       local plain = not sep_is_pattern
+       max_splits = max_splits + 1
+       repeat
+               local np, npe = string_find(str, delim, pos, plain)
+               np, npe = (np or (len+1)), (npe or (len+1))
+               if (not np) or (max_splits == 1) then
+                       np = len + 1
+                       npe = np
                end
-       end
-       -- Handle the last field
-       if max_splits <= 0 or num_splits <= max_splits then
-               local last_part = str:sub(last_pos)
-               if include_empty or last_part ~= "" then
-                       fields[num_splits + 1] = last_part
+               local s = string_sub(str, pos, np - 1)
+               if include_empty or (s ~= "") then
+                       max_splits = max_splits - 1
+                       items[#items + 1] = s
+               end
+               pos = npe + 1
+       until (max_splits == 0) or (pos > (len + 1))
+       return items
+end
+
+--------------------------------------------------------------------------------
+function table.indexof(list, val)
+       for i, v in ipairs(list) do
+               if v == val then
+                       return i
                end
        end
-       return fields
+       return -1
 end
 
+assert(table.indexof({"foo", "bar"}, "foo") == 1)
+assert(table.indexof({"foo", "bar"}, "baz") == -1)
 
 --------------------------------------------------------------------------------
-function file_exists(filename)
-       local f = io.open(filename, "r")
-       if f==nil then
-               return false
-       else
-               f:close()
-               return true
+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"))
@@ -293,13 +308,13 @@ function core.formspec_escape(text)
 end
 
 
-function core.splittext(text,charlimit)
+function core.wrap_text(text, charlimit)
        local retval = {}
 
        local current_idx = 1
 
-       local start,stop = string.find(text," ",current_idx)
-       local nl_start,nl_stop = string.find(text,"\n",current_idx)
+       local start,stop = string_find(text, " ", current_idx)
+       local nl_start,nl_stop = string_find(text, "\n", current_idx)
        local gotnewline = false
        if nl_start ~= nil and (start == nil or nl_start < start) then
                start = nl_start
@@ -309,7 +324,7 @@ function core.splittext(text,charlimit)
        local last_line = ""
        while start ~= nil do
                if string.len(last_line) + (stop-start) > charlimit then
-                       table.insert(retval,last_line)
+                       retval[#retval + 1] = last_line
                        last_line = ""
                end
 
@@ -317,17 +332,17 @@ function core.splittext(text,charlimit)
                        last_line = last_line .. " "
                end
 
-               last_line = last_line .. string.sub(text,current_idx,stop -1)
+               last_line = last_line .. string_sub(text, current_idx, stop - 1)
 
                if gotnewline then
-                       table.insert(retval,last_line)
+                       retval[#retval + 1] = last_line
                        last_line = ""
                        gotnewline = false
                end
                current_idx = stop+1
 
-               start,stop = string.find(text," ",current_idx)
-               nl_start,nl_stop = string.find(text,"\n",current_idx)
+               start,stop = string_find(text, " ", current_idx)
+               nl_start,nl_stop = string_find(text, "\n", current_idx)
 
                if nl_start ~= nil and (start == nil or nl_start < start) then
                        start = nl_start
@@ -338,11 +353,11 @@ function core.splittext(text,charlimit)
 
        --add last part of text
        if string.len(last_line) + (string.len(text) - current_idx) > charlimit then
-                       table.insert(retval,last_line)
-                       table.insert(retval,string.sub(text,current_idx))
+                       retval[#retval + 1] = last_line
+                       retval[#retval + 1] = string_sub(text, current_idx)
        else
-               last_line = last_line .. " " .. string.sub(text,current_idx)
-               table.insert(retval,last_line)
+               last_line = last_line .. " " .. string_sub(text, current_idx)
+               retval[#retval + 1] = last_line
        end
 
        return retval
@@ -368,7 +383,6 @@ if INIT == "game" then
                                        itemstack, pointed_thing)
                        return
                end
-               local pitch = placer:get_look_pitch()
                local fdir = core.dir_to_facedir(placer:get_look_dir())
                local wield_name = itemstack:get_name()
 
@@ -415,14 +429,14 @@ if INIT == "game" then
 
                if iswall then
                        core.set_node(pos, {name = wield_name,
-                                       param2 = dirs1[fdir+1]})
+                                       param2 = dirs1[fdir + 1]})
                elseif isceiling then
                        if orient_flags.force_facedir then
                                core.set_node(pos, {name = wield_name,
                                                param2 = 20})
                        else
                                core.set_node(pos, {name = wield_name,
-                                               param2 = dirs2[fdir+1]})
+                                               param2 = dirs2[fdir + 1]})
                        end
                else -- place right side up
                        if orient_flags.force_facedir then
@@ -449,7 +463,7 @@ if INIT == "game" then
 
        core.rotate_node = function(itemstack, placer, pointed_thing)
                core.rotate_and_place(itemstack, placer, pointed_thing,
-                               core.setting_getbool("creative_mode"),
+                               core.settings:get_bool("creative_mode"),
                                {invert_wall = placer:get_player_control().sneak})
                return itemstack
        end
@@ -498,22 +512,94 @@ function core.explode_scrollbar_event(evt)
 end
 
 --------------------------------------------------------------------------------
-function core.pos_to_string(pos)
-       return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
+function core.rgba(r, g, b, a)
+       return a and string.format("#%02X%02X%02X%02X", r, g, b, a) or
+                       string.format("#%02X%02X%02X", r, g, b)
+end
+
+--------------------------------------------------------------------------------
+function core.pos_to_string(pos, decimal_places)
+       local x = pos.x
+       local y = pos.y
+       local z = pos.z
+       if decimal_places ~= nil then
+               x = string.format("%." .. decimal_places .. "f", x)
+               y = string.format("%." .. decimal_places .. "f", y)
+               z = string.format("%." .. decimal_places .. "f", z)
+       end
+       return "(" .. x .. "," .. y .. "," .. z .. ")"
+end
+
+--------------------------------------------------------------------------------
+function core.string_to_pos(value)
+       if value == nil then
+               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
+       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
+       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
+       end
+
+       return p1, p2
 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, p2 = core.string_to_area("(10.0, 5, -2  30.2,   4, -12.53")
+       assert(p1 == nil and p2 == nil)
+
+       p1, p2 = core.string_to_area("(10.0, 5,) -2  fgdf2,   4, -12.53")
+       assert(p1 == nil and p2 == nil)
+end
+
+test_string_to_area()
+
 --------------------------------------------------------------------------------
 function table.copy(t, seen)
        local n = {}
        seen = seen or {}
        seen[t] = n
        for k, v in pairs(t) do
-               n[type(k) ~= "table" and k or seen[k] or table.copy(k, seen)] =
-                       type(v) ~= "table" and v or seen[v] or table.copy(v, seen)
+               n[(type(k) == "table" and (seen[k] or table.copy(k, seen))) or k] =
+                       (type(v) == "table" and (seen[v] or table.copy(v, seen))) or v
        end
        return n
 end
-
 --------------------------------------------------------------------------------
 -- mainmenu only functions
 --------------------------------------------------------------------------------
@@ -527,8 +613,10 @@ if INIT == "mainmenu" then
 
                return nil
        end
+end
 
-       function fgettext(text, ...)
+if INIT == "client" or INIT == "mainmenu" then
+       function fgettext_ne(text, ...)
                text = core.gettext(text)
                local arg = {n=select('#', ...), ...}
                if arg.n >= 1 then
@@ -550,7 +638,101 @@ if INIT == "mainmenu" then
                        end
                        text = result
                end
-               return core.formspec_escape(text)
+               return text
+       end
+
+       function fgettext(text, ...)
+               return core.formspec_escape(fgettext_ne(text, ...))
+       end
+end
+
+local ESCAPE_CHAR = string.char(0x1b)
+
+function core.get_color_escape_sequence(color)
+       return ESCAPE_CHAR .. "(c@" .. color .. ")"
+end
+
+function core.get_background_escape_sequence(color)
+       return ESCAPE_CHAR .. "(b@" .. color .. ")"
+end
+
+function core.colorize(color, message)
+       local lines = tostring(message):split("\n", true)
+       local color_code = core.get_color_escape_sequence(color)
+
+       for i, line in ipairs(lines) do
+               lines[i] = color_code .. line
+       end
+
+       return table.concat(lines, "\n") .. core.get_color_escape_sequence("#ffffff")
+end
+
+
+function core.strip_foreground_colors(str)
+       return (str:gsub(ESCAPE_CHAR .. "%(c@[^)]+%)", ""))
+end
+
+function core.strip_background_colors(str)
+       return (str:gsub(ESCAPE_CHAR .. "%(b@[^)]+%)", ""))
+end
+
+function core.strip_colors(str)
+       return (str:gsub(ESCAPE_CHAR .. "%([bc]@[^)]+%)", ""))
+end
+
+--------------------------------------------------------------------------------
+-- Returns the exact coordinate of a pointed surface
+--------------------------------------------------------------------------------
+function core.pointed_thing_to_face_pos(placer, pointed_thing)
+       local eye_offset_first = placer:get_eye_offset()
+       local node_pos = pointed_thing.under
+       local camera_pos = placer:get_pos()
+       local pos_off = vector.multiply(
+                       vector.subtract(pointed_thing.above, node_pos), 0.5)
+       local look_dir = placer:get_look_dir()
+       local offset, nc
+       local oc = {}
+
+       for c, v in pairs(pos_off) do
+               if nc or v == 0 then
+                       oc[#oc + 1] = c
+               else
+                       offset = v
+                       nc = c
+               end
+       end
+
+       local fine_pos = {[nc] = node_pos[nc] + offset}
+       camera_pos.y = camera_pos.y + 1.625 + eye_offset_first.y / 10
+       local f = (node_pos[nc] + offset - camera_pos[nc]) / look_dir[nc]
+
+       for i = 1, #oc do
+               fine_pos[oc[i]] = camera_pos[oc[i]] + look_dir[oc[i]] * f
+       end
+       return fine_pos
+end
+
+function core.string_to_privs(str, delim)
+       assert(type(str) == "string")
+       delim = delim or ','
+       local privs = {}
+       for _, priv in pairs(string.split(str, delim)) do
+               privs[priv:trim()] = true
+       end
+       return privs
+end
+
+function core.privs_to_string(privs, delim)
+       assert(type(privs) == "table")
+       delim = delim or ','
+       local list = {}
+       for priv, bool in pairs(privs) do
+               if bool then
+                       list[#list + 1] = priv
+               end
        end
+       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")