]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - builtin/common/misc_helpers.lua
Add relative numbers for commands by prepending ~ (#9588)
[dragonfireclient.git] / builtin / common / misc_helpers.lua
index 9c7349726d51f37bb8af6e6d958be04d0e58fb65..83f17da7bcdb6f0ca9101cd08dbba34ab18041a8 100644 (file)
 -- Minetest: builtin/misc_helpers.lua
 
 --------------------------------------------------------------------------------
-function basic_dump2(o)
-       if type(o) == "number" then
+-- Localize functions to avoid table lookups (better performance).
+local string_sub, string_find = string.sub, string.find
+
+--------------------------------------------------------------------------------
+local function basic_dump(o)
+       local tp = type(o)
+       if tp == "number" then
                return tostring(o)
-       elseif type(o) == "string" then
+       elseif tp == "string" then
                return string.format("%q", o)
-       elseif type(o) == "boolean" then
+       elseif tp == "boolean" then
                return tostring(o)
-       elseif type(o) == "function" then
-               return "<function>"
-       elseif type(o) == "userdata" then
-               return "<userdata>"
-       elseif type(o) == "nil" then
+       elseif tp == "nil" then
                return "nil"
+       -- Uncomment for full function dumping support.
+       -- Not currently enabled because bytecode isn't very human-readable and
+       -- 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
-               error("cannot dump a " .. type(o))
-               return nil
+               return string.format("<%s>", tp)
+       end
+end
+
+local keywords = {
+       ["and"] = true,
+       ["break"] = true,
+       ["do"] = true,
+       ["else"] = true,
+       ["elseif"] = true,
+       ["end"] = true,
+       ["false"] = true,
+       ["for"] = true,
+       ["function"] = true,
+       ["goto"] = true,  -- Lua 5.2
+       ["if"] = true,
+       ["in"] = true,
+       ["local"] = true,
+       ["nil"] = true,
+       ["not"] = true,
+       ["or"] = true,
+       ["repeat"] = true,
+       ["return"] = true,
+       ["then"] = true,
+       ["true"] = true,
+       ["until"] = true,
+       ["while"] = true,
+}
+local function is_valid_identifier(str)
+       if not str:find("^[a-zA-Z_][a-zA-Z0-9_]*$") or keywords[str] then
+               return false
        end
+       return true
 end
 
 --------------------------------------------------------------------------------
+-- Dumps values in a line-per-value format.
+-- For example, {test = {"Testing..."}} becomes:
+--   _["test"] = {}
+--   _["test"][1] = "Testing..."
+-- This handles tables as keys and circular references properly.
+-- It also handles multiple references well, writing the table only once.
+-- The dumped argument is internal-only.
+
 function dump2(o, name, dumped)
        name = name or "_"
+       -- "dumped" is used to keep track of serialized tables to handle
+       -- multiple references and circular tables properly.
+       -- It only contains tables as keys.  The value is the name that
+       -- the table has in the dump, eg:
+       -- {x = {"y"}} -> dumped[{"y"}] = '_["x"]'
        dumped = dumped or {}
-       io.write(name, " = ")
-       if type(o) == "number" or type(o) == "string" or type(o) == "boolean"
-                       or type(o) == "function" or type(o) == "nil"
-                       or type(o) == "userdata" then
-               io.write(basic_dump2(o), "\n")
-       elseif type(o) == "table" then
-               if dumped[o] then
-                       io.write(dumped[o], "\n")
-               else
-                       dumped[o] = name
-                       io.write("{}\n") -- new table
-                       for k,v in pairs(o) do
-                               local fieldname = string.format("%s[%s]", name, basic_dump2(k))
-                               dump2(v, fieldname, dumped)
+       if type(o) ~= "table" then
+               return string.format("%s = %s\n", name, basic_dump(o))
+       end
+       if dumped[o] then
+               return string.format("%s = %s\n", name, dumped[o])
+       end
+       dumped[o] = name
+       -- This contains a list of strings to be concatenated later (because
+       -- Lua is slow at individual concatenation).
+       local t = {}
+       for k, v in pairs(o) do
+               local keyStr
+               if type(k) == "table" then
+                       if dumped[k] then
+                               keyStr = dumped[k]
+                       else
+                               -- Key tables don't have a name, so use one of
+                               -- the form _G["table: 0xFFFFFFF"]
+                               keyStr = string.format("_G[%q]", tostring(k))
+                               -- Dump key table
+                               t[#t + 1] = dump2(k, keyStr, dumped)
                        end
+               else
+                       keyStr = basic_dump(k)
                end
-       else
-               error("cannot dump a " .. type(o))
-               return nil
+               local vname = string.format("%s[%s]", name, keyStr)
+               t[#t + 1] = dump2(v, vname, dumped)
        end
+       return string.format("%s = {}\n%s", name, table.concat(t))
 end
 
 --------------------------------------------------------------------------------
-function dump(o, dumped)
-       dumped = dumped or {}
-       if type(o) == "number" then
-               return tostring(o)
-       elseif type(o) == "string" then
-               return string.format("%q", o)
-       elseif type(o) == "table" then
-               if dumped[o] then
-                       return "<circular reference>"
-               end
-               dumped[o] = true
-               local t = {}
-               for k,v in pairs(o) do
-                       t[#t+1] = "[" .. dump(k, dumped) .. "] = " .. dump(v, dumped)
+-- This dumps values in a one-statement format.
+-- For example, {test = {"Testing..."}} becomes:
+-- [[{
+--     test = {
+--             "Testing..."
+--     }
+-- }]]
+-- This supports tables as keys, but not circular references.
+-- It performs poorly with multiple references as it writes out the full
+-- table each time.
+-- The indent field specifies a indentation string, it defaults to a tab.
+-- Use the empty string to disable indentation.
+-- The dumped and level arguments are internal-only.
+
+function dump(o, indent, nested, level)
+       local t = type(o)
+       if not level and t == "userdata" then
+               -- when userdata (e.g. player) is passed directly, print its metatable:
+               return "userdata metatable: " .. dump(getmetatable(o))
+       end
+       if t ~= "table" then
+               return basic_dump(o)
+       end
+
+       -- Contains table -> true/nil of currently nested tables
+       nested = nested or {}
+       if nested[o] then
+               return "<circular reference>"
+       end
+       nested[o] = true
+       indent = indent or "\t"
+       level = level or 1
+
+       local ret = {}
+       local dumped_indexes = {}
+       for i, v in ipairs(o) do
+               ret[#ret + 1] = dump(v, indent, nested, level + 1)
+               dumped_indexes[i] = true
+       end
+       for k, v in pairs(o) do
+               if not dumped_indexes[k] then
+                       if type(k) ~= "string" or not is_valid_identifier(k) then
+                               k = "["..dump(k, indent, nested, level + 1).."]"
+                       end
+                       v = dump(v, indent, nested, level + 1)
+                       ret[#ret + 1] = k.." = "..v
                end
-               return "{" .. table.concat(t, ", ") .. "}"
-       elseif type(o) == "boolean" then
-               return tostring(o)
-       elseif type(o) == "function" then
-               return "<function>"
-       elseif type(o) == "userdata" then
-               return "<userdata>"
-       elseif type(o) == "nil" then
-               return "nil"
-       else
-               error("cannot dump a " .. type(o))
-               return nil
        end
+       nested[o] = nil
+       if indent ~= "" then
+               local indent_str = "\n"..string.rep(indent, level)
+               local end_indent_str = "\n"..string.rep(indent, level - 1)
+               return string.format("{%s%s%s}",
+                               indent_str,
+                               table.concat(ret, ","..indent_str),
+                               end_indent_str)
+       end
+       return "{"..table.concat(ret, ", ").."}"
 end
 
 --------------------------------------------------------------------------------
-function string:split(sep)
-       local sep, fields = sep or ",", {}
-       local pattern = string.format("([^%s]+)", sep)
-       self:gsub(pattern, function(c) fields[#fields+1] = c end)
-       return fields
+function string.split(str, delim, include_empty, max_splits, sep_is_pattern)
+       delim = delim or ","
+       max_splits = max_splits or -2
+       local items = {}
+       local pos, len = 1, #str
+       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
+               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 file_exists(filename)
-       local f = io.open(filename, "r")
-       if f==nil then
-               return false
-       else
-               f:close()
-               return true
+function table.indexof(list, val)
+       for i, v in ipairs(list) do
+               if v == val then
+                       return i
+               end
        end
+       return -1
 end
 
 --------------------------------------------------------------------------------
@@ -101,80 +207,46 @@ 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
 
 --------------------------------------------------------------------------------
-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
-       end
-       
-       return retval
+function math.sign(x, tolerance)
+       tolerance = tolerance or 0
+       if x > tolerance then
+               return 1
+       elseif x < -tolerance then
+               return -1
+       end
+       return 0
 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]
+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 v = 1
+       for k = 2, x do
+               v = v * k
+       end
+       return v
+end
+
+
+function math.round(x)
+       if x >= 0 then
+               return math.floor(x + 0.5)
        end
-       
-       return temppath
+       return math.ceil(x - 0.5)
 end
 
-local tbl = engine or minetest
-function tbl.formspec_escape(text)
+
+function core.formspec_escape(text)
        if text ~= nil then
                text = string.gsub(text,"\\","\\\\")
                text = string.gsub(text,"%]","\\]")
@@ -186,113 +258,58 @@ function tbl.formspec_escape(text)
 end
 
 
-function tbl.splittext(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 gotnewline = false
-       if nl_start ~= nil and (start == nil or nl_start < start) then
-               start = nl_start
-               stop = nl_stop
-               gotnewline = true
+function core.wrap_text(text, max_length, as_table)
+       local result = {}
+       local line = {}
+       if #text <= max_length then
+               return as_table and {text} or text
        end
-       local last_line = ""
-       while start ~= nil do
-               if string.len(last_line) + (stop-start) > charlimit then
-                       table.insert(retval,last_line)
-                       last_line = ""
-               end
-               
-               if last_line ~= "" then
-                       last_line = last_line .. " "
-               end
-               
-               last_line = last_line .. string.sub(text,current_idx,stop -1)
-               
-               if gotnewline then
-                       table.insert(retval,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)
-       
-               if nl_start ~= nil and (start == nil or nl_start < start) then
-                       start = nl_start
-                       stop = nl_stop
-                       gotnewline = true
+
+       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
+                       -- word wouldn't fit on current line, move to next line
+                       table.insert(result, table.concat(line, ' '))
+                       line = {}
                end
+               table.insert(line, word)
        end
-       
-       --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))
-       else
-               last_line = last_line .. " " .. string.sub(text,current_idx)
-               table.insert(retval,last_line)
-       end
-       
-       return retval
+
+       table.insert(result, table.concat(line, ' '))
+       return as_table and result or table.concat(result, '\n')
 end
 
 --------------------------------------------------------------------------------
 
-if minetest then
+if INIT == "game" then
        local dirs1 = {9, 18, 7, 12}
        local dirs2 = {20, 23, 22, 21}
 
-       function minetest.rotate_and_place(itemstack, placer, pointed_thing,
-                               infinitestacks, orient_flags)
+       function core.rotate_and_place(itemstack, placer, pointed_thing,
+                       infinitestacks, orient_flags, prevent_after_place)
                orient_flags = orient_flags or {}
 
-               local unode = minetest.get_node_or_nil(pointed_thing.under)
+               local unode = core.get_node_or_nil(pointed_thing.under)
                if not unode then
                        return
                end
-               local undef = minetest.registered_nodes[unode.name]
-               if undef and undef.on_rightclick then
-                       undef.on_rightclick(pointed_thing.under, unode, placer,
+               local undef = core.registered_nodes[unode.name]
+               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)
-                       return
                end
-               local pitch = placer:get_look_pitch()
-               local fdir = minetest.dir_to_facedir(placer:get_look_dir())
-               local wield_name = itemstack:get_name()
+               local fdir = placer and core.dir_to_facedir(placer:get_look_dir()) or 0
 
                local above = pointed_thing.above
                local under = pointed_thing.under
                local iswall = (above.y == under.y)
                local isceiling = not iswall and (above.y < under.y)
-               local anode = minetest.get_node_or_nil(above)
-               if not anode then
-                       return
-               end
-               local pos = pointed_thing.above
-               local node = anode
 
                if undef and undef.buildable_to then
-                       pos = pointed_thing.under
-                       node = unode
                        iswall = false
                end
 
-               if minetest.is_protected(pos, placer:get_player_name()) then
-                       minetest.record_protection_violation(pos,
-                                       placer:get_player_name())
-                       return
-               end
-
-               local ndef = minetest.registered_nodes[node.name]
-               if not ndef or not ndef.buildable_to then
-                       return
-               end
-
                if orient_flags.force_floor then
                        iswall = false
                        isceiling = false
@@ -306,31 +323,25 @@ if minetest then
                        iswall = not iswall
                end
 
+               local param2 = fdir
                if iswall then
-                       minetest.set_node(pos, {name = wield_name,
-                                       param2 = dirs1[fdir+1]})
+                       param2 = dirs1[fdir + 1]
                elseif isceiling then
                        if orient_flags.force_facedir then
-                               minetest.set_node(pos, {name = wield_name,
-                                               param2 = 20})
+                               param2 = 20
                        else
-                               minetest.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
-                               minetest.set_node(pos, {name = wield_name,
-                                               param2 = 0})
-                       else
-                               minetest.set_node(pos, {name = wield_name,
-                                               param2 = fdir})
+                               param2 = 0
                        end
                end
 
-               if not infinitestacks then
-                       itemstack:take_item()
-                       return itemstack
-               end
+               local old_itemstack = ItemStack(itemstack)
+               local new_itemstack = core.item_place_node(itemstack, placer,
+                               pointed_thing, param2, prevent_after_place)
+               return infinitestacks and old_itemstack or new_itemstack
        end
 
 
@@ -338,25 +349,25 @@ if minetest then
 --Wrapper for rotate_and_place() to check for sneak and assume Creative mode
 --implies infinite stacks when performing a 6d rotation.
 --------------------------------------------------------------------------------
-
-
-       minetest.rotate_node = function(itemstack, placer, pointed_thing)
-               minetest.rotate_and_place(itemstack, placer, pointed_thing,
-                               minetest.setting_getbool("creative_mode"),
-                               {invert_wall = placer:get_player_control().sneak})
-               return itemstack
+       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,
+                       core.is_creative_enabled(name),
+                       {invert_wall = invert_wall}, true)
        end
 end
 
 --------------------------------------------------------------------------------
-function tbl.explode_table_event(evt)
+function core.explode_table_event(evt)
        if evt ~= nil then
                local parts = evt:split(":")
                if #parts == 3 then
                        local t = parts[1]:trim()
                        local r = tonumber(parts[2]:trim())
                        local c = tonumber(parts[3]:trim())
-                       if type(r) == "number" and type(c) == "number" and t ~= "INV" then
+                       if type(r) == "number" and type(c) == "number"
+                                       and t ~= "INV" then
                                return {type=t, row=r, column=c}
                        end
                end
@@ -365,7 +376,7 @@ function tbl.explode_table_event(evt)
 end
 
 --------------------------------------------------------------------------------
-function tbl.explode_textlist_event(evt)
+function core.explode_textlist_event(evt)
        if evt ~= nil then
                local parts = evt:split(":")
                if #parts == 2 then
@@ -379,50 +390,378 @@ function tbl.explode_textlist_event(evt)
        return {type="INV", index=0}
 end
 
+--------------------------------------------------------------------------------
+function core.explode_scrollbar_event(evt)
+       local retval = core.explode_textlist_event(evt)
+
+       retval.value = retval.index
+       retval.index = nil
+
+       return retval
+end
+
+--------------------------------------------------------------------------------
+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
+
+       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
+
+
+--------------------------------------------------------------------------------
+
+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
+
+       function core.string_to_area(value, relative_to)
+               local p1, p2 = value:match("^%((.-)%)%s*%((.-)%)$")
+               if not p1 then
+                       return
+               end
+
+               p1 = parse_area_string(p1, relative_to)
+               p2 = parse_area_string(p2, relative_to)
+
+               if p1 == nil or p2 == nil then
+                       return
+               end
+
+               return p1, p2
+       end
+end
+
+--------------------------------------------------------------------------------
+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 (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
+
+
+function table.insert_all(t, other)
+       for i=1, #other do
+               t[#t + 1] = other[i]
+       end
+       return t
+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
 --------------------------------------------------------------------------------
-if engine ~= nil then
-       engine.get_game = function(index)
-               local games = game.get_games()
-               
+if INIT == "mainmenu" then
+       function core.get_game(index)
+               local games = core.get_games()
+
                if index > 0 and index <= #games then
                        return games[index]
                end
-               
+
                return nil
        end
-       
-       function fgettext(text, ...)
-               text = engine.gettext(text)
+end
+
+if core.gettext then -- for client and mainmenu
+       function fgettext_ne(text, ...)
+               text = core.gettext(text)
                local arg = {n=select('#', ...), ...}
                if arg.n >= 1 then
                        -- Insert positional parameters ($1, $2, ...)
-                       result = ''
-                       pos = 1
+                       local result = ''
+                       local pos = 1
                        while pos <= text:len() do
-                               newpos = text:find('[$]', pos)
+                               local newpos = text:find('[$]', pos)
                                if newpos == nil then
                                        result = result .. text:sub(pos)
                                        pos = text:len() + 1
                                else
-                                       paramindex = tonumber(text:sub(newpos+1, newpos+1))
-                                       result = result .. text:sub(pos, newpos-1) .. tostring(arg[paramindex])
+                                       local paramindex =
+                                               tonumber(text:sub(newpos+1, newpos+1))
+                                       result = result .. text:sub(pos, newpos-1)
+                                               .. tostring(arg[paramindex])
                                        pos = newpos + 2
                                end
                        end
                        text = result
                end
-               return engine.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
+
+function core.translate(textdomain, str, ...)
+       local start_seq
+       if textdomain == "" then
+               start_seq = ESCAPE_CHAR .. "T"
+       else
+               start_seq = ESCAPE_CHAR .. "(T@" .. textdomain .. ")"
+       end
+       local arg = {n=select('#', ...), ...}
+       local end_seq = ESCAPE_CHAR .. "E"
+       local arg_index = 1
+       local translated = str:gsub("@(.)", function(matched)
+               local c = string.byte(matched)
+               if string.byte("1") <= c and c <= string.byte("9") then
+                       local a = c - string.byte("0")
+                       if a ~= arg_index then
+                               error("Escape sequences in string given to core.translate " ..
+                                       "are not in the correct order: got @" .. matched ..
+                                       "but expected @" .. tostring(arg_index))
+                       end
+                       if a > arg.n then
+                               error("Not enough arguments provided to core.translate")
+                       end
+                       arg_index = arg_index + 1
+                       return ESCAPE_CHAR .. "F" .. arg[a] .. ESCAPE_CHAR .. "E"
+               elseif matched == "n" then
+                       return "\n"
+               else
+                       return matched
+               end
+       end)
+       if arg_index < arg.n + 1 then
+               error("Too many arguments provided to core.translate")
        end
+       return start_seq .. translated .. end_seq
 end
+
+function core.get_translator(textdomain)
+       return function(str, ...) return core.translate(textdomain or "", str, ...) end
+end
+
 --------------------------------------------------------------------------------
--- core only fct
+-- Returns the exact coordinate of a pointed surface
 --------------------------------------------------------------------------------
-if minetest ~= nil then
-       --------------------------------------------------------------------------------
-       function minetest.pos_to_string(pos)
-               return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
+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
+       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 + eye_height + 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
 
+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