Add minetest.rgba function that returns ColorString from RGBA or RGB values
[oweals/minetest.git] / builtin / common / misc_helpers.lua
1 -- Minetest: builtin/misc_helpers.lua
2
3 --------------------------------------------------------------------------------
4 -- Localize functions to avoid table lookups (better performance).
5 local string_sub, string_find = string.sub, string.find
6
7 --------------------------------------------------------------------------------
8 function basic_dump(o)
9         local tp = type(o)
10         if tp == "number" then
11                 return tostring(o)
12         elseif tp == "string" then
13                 return string.format("%q", o)
14         elseif tp == "boolean" then
15                 return tostring(o)
16         elseif tp == "nil" then
17                 return "nil"
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         else
24                 return string.format("<%s>", tp)
25         end
26 end
27
28 local keywords = {
29         ["and"] = true,
30         ["break"] = true,
31         ["do"] = true,
32         ["else"] = true,
33         ["elseif"] = true,
34         ["end"] = true,
35         ["false"] = true,
36         ["for"] = true,
37         ["function"] = true,
38         ["goto"] = true,  -- Lua 5.2
39         ["if"] = true,
40         ["in"] = true,
41         ["local"] = true,
42         ["nil"] = true,
43         ["not"] = true,
44         ["or"] = true,
45         ["repeat"] = true,
46         ["return"] = true,
47         ["then"] = true,
48         ["true"] = true,
49         ["until"] = true,
50         ["while"] = true,
51 }
52 local function is_valid_identifier(str)
53         if not str:find("^[a-zA-Z_][a-zA-Z0-9_]*$") or keywords[str] then
54                 return false
55         end
56         return true
57 end
58
59 --------------------------------------------------------------------------------
60 -- Dumps values in a line-per-value format.
61 -- For example, {test = {"Testing..."}} becomes:
62 --   _["test"] = {}
63 --   _["test"][1] = "Testing..."
64 -- This handles tables as keys and circular references properly.
65 -- It also handles multiple references well, writing the table only once.
66 -- The dumped argument is internal-only.
67
68 function dump2(o, name, dumped)
69         name = name or "_"
70         -- "dumped" is used to keep track of serialized tables to handle
71         -- multiple references and circular tables properly.
72         -- It only contains tables as keys.  The value is the name that
73         -- the table has in the dump, eg:
74         -- {x = {"y"}} -> dumped[{"y"}] = '_["x"]'
75         dumped = dumped or {}
76         if type(o) ~= "table" then
77                 return string.format("%s = %s\n", name, basic_dump(o))
78         end
79         if dumped[o] then
80                 return string.format("%s = %s\n", name, dumped[o])
81         end
82         dumped[o] = name
83         -- This contains a list of strings to be concatenated later (because
84         -- Lua is slow at individual concatenation).
85         local t = {}
86         for k, v in pairs(o) do
87                 local keyStr
88                 if type(k) == "table" then
89                         if dumped[k] then
90                                 keyStr = dumped[k]
91                         else
92                                 -- Key tables don't have a name, so use one of
93                                 -- the form _G["table: 0xFFFFFFF"]
94                                 keyStr = string.format("_G[%q]", tostring(k))
95                                 -- Dump key table
96                                 t[#t + 1] = dump2(k, keyStr, dumped)
97                         end
98                 else
99                         keyStr = basic_dump(k)
100                 end
101                 local vname = string.format("%s[%s]", name, keyStr)
102                 t[#t + 1] = dump2(v, vname, dumped)
103         end
104         return string.format("%s = {}\n%s", name, table.concat(t))
105 end
106
107 --------------------------------------------------------------------------------
108 -- This dumps values in a one-statement format.
109 -- For example, {test = {"Testing..."}} becomes:
110 -- [[{
111 --      test = {
112 --              "Testing..."
113 --      }
114 -- }]]
115 -- This supports tables as keys, but not circular references.
116 -- It performs poorly with multiple references as it writes out the full
117 -- table each time.
118 -- The indent field specifies a indentation string, it defaults to a tab.
119 -- Use the empty string to disable indentation.
120 -- The dumped and level arguments are internal-only.
121
122 function dump(o, indent, nested, level)
123         if type(o) ~= "table" then
124                 return basic_dump(o)
125         end
126         -- Contains table -> true/nil of currently nested tables
127         nested = nested or {}
128         if nested[o] then
129                 return "<circular reference>"
130         end
131         nested[o] = true
132         indent = indent or "\t"
133         level = level or 1
134         local t = {}
135         local dumped_indexes = {}
136         for i, v in ipairs(o) do
137                 t[#t + 1] = dump(v, indent, nested, level + 1)
138                 dumped_indexes[i] = true
139         end
140         for k, v in pairs(o) do
141                 if not dumped_indexes[k] then
142                         if type(k) ~= "string" or not is_valid_identifier(k) then
143                                 k = "["..dump(k, indent, nested, level + 1).."]"
144                         end
145                         v = dump(v, indent, nested, level + 1)
146                         t[#t + 1] = k.." = "..v
147                 end
148         end
149         nested[o] = nil
150         if indent ~= "" then
151                 local indent_str = "\n"..string.rep(indent, level)
152                 local end_indent_str = "\n"..string.rep(indent, level - 1)
153                 return string.format("{%s%s%s}",
154                                 indent_str,
155                                 table.concat(t, ","..indent_str),
156                                 end_indent_str)
157         end
158         return "{"..table.concat(t, ", ").."}"
159 end
160
161 --------------------------------------------------------------------------------
162 function string.split(str, delim, include_empty, max_splits, sep_is_pattern)
163         delim = delim or ","
164         max_splits = max_splits or -1
165         local items = {}
166         local pos, len, seplen = 1, #str, #delim
167         local plain = not sep_is_pattern
168         max_splits = max_splits + 1
169         repeat
170                 local np, npe = string_find(str, delim, pos, plain)
171                 np, npe = (np or (len+1)), (npe or (len+1))
172                 if (not np) or (max_splits == 1) then
173                         np = len + 1
174                         npe = np
175                 end
176                 local s = string_sub(str, pos, np - 1)
177                 if include_empty or (s ~= "") then
178                         max_splits = max_splits - 1
179                         items[#items + 1] = s
180                 end
181                 pos = npe + 1
182         until (max_splits == 0) or (pos > (len + 1))
183         return items
184 end
185
186 --------------------------------------------------------------------------------
187 function table.indexof(list, val)
188         for i, v in ipairs(list) do
189                 if v == val then
190                         return i
191                 end
192         end
193         return -1
194 end
195
196 assert(table.indexof({"foo", "bar"}, "foo") == 1)
197 assert(table.indexof({"foo", "bar"}, "baz") == -1)
198
199 --------------------------------------------------------------------------------
200 if INIT ~= "client" then
201         function file_exists(filename)
202                 local f = io.open(filename, "r")
203                 if f == nil then
204                         return false
205                 else
206                         f:close()
207                         return true
208                 end
209         end
210 end
211 --------------------------------------------------------------------------------
212 function string:trim()
213         return (self:gsub("^%s*(.-)%s*$", "%1"))
214 end
215
216 assert(string.trim("\n \t\tfoo bar\t ") == "foo bar")
217
218 --------------------------------------------------------------------------------
219 function math.hypot(x, y)
220         local t
221         x = math.abs(x)
222         y = math.abs(y)
223         t = math.min(x, y)
224         x = math.max(x, y)
225         if x == 0 then return 0 end
226         t = t / x
227         return x * math.sqrt(1 + t * t)
228 end
229
230 --------------------------------------------------------------------------------
231 function math.sign(x, tolerance)
232         tolerance = tolerance or 0
233         if x > tolerance then
234                 return 1
235         elseif x < -tolerance then
236                 return -1
237         end
238         return 0
239 end
240
241 --------------------------------------------------------------------------------
242 function get_last_folder(text,count)
243         local parts = text:split(DIR_DELIM)
244
245         if count == nil then
246                 return parts[#parts]
247         end
248
249         local retval = ""
250         for i=1,count,1 do
251                 retval = retval .. parts[#parts - (count-i)] .. DIR_DELIM
252         end
253
254         return retval
255 end
256
257 --------------------------------------------------------------------------------
258 function cleanup_path(temppath)
259
260         local parts = temppath:split("-")
261         temppath = ""
262         for i=1,#parts,1 do
263                 if temppath ~= "" then
264                         temppath = temppath .. "_"
265                 end
266                 temppath = temppath .. parts[i]
267         end
268
269         parts = temppath:split(".")
270         temppath = ""
271         for i=1,#parts,1 do
272                 if temppath ~= "" then
273                         temppath = temppath .. "_"
274                 end
275                 temppath = temppath .. parts[i]
276         end
277
278         parts = temppath:split("'")
279         temppath = ""
280         for i=1,#parts,1 do
281                 if temppath ~= "" then
282                         temppath = temppath .. ""
283                 end
284                 temppath = temppath .. parts[i]
285         end
286
287         parts = temppath:split(" ")
288         temppath = ""
289         for i=1,#parts,1 do
290                 if temppath ~= "" then
291                         temppath = temppath
292                 end
293                 temppath = temppath .. parts[i]
294         end
295
296         return temppath
297 end
298
299 function core.formspec_escape(text)
300         if text ~= nil then
301                 text = string.gsub(text,"\\","\\\\")
302                 text = string.gsub(text,"%]","\\]")
303                 text = string.gsub(text,"%[","\\[")
304                 text = string.gsub(text,";","\\;")
305                 text = string.gsub(text,",","\\,")
306         end
307         return text
308 end
309
310
311 function core.wrap_text(text, charlimit)
312         local retval = {}
313
314         local current_idx = 1
315
316         local start,stop = string_find(text, " ", current_idx)
317         local nl_start,nl_stop = string_find(text, "\n", current_idx)
318         local gotnewline = false
319         if nl_start ~= nil and (start == nil or nl_start < start) then
320                 start = nl_start
321                 stop = nl_stop
322                 gotnewline = true
323         end
324         local last_line = ""
325         while start ~= nil do
326                 if string.len(last_line) + (stop-start) > charlimit then
327                         retval[#retval + 1] = last_line
328                         last_line = ""
329                 end
330
331                 if last_line ~= "" then
332                         last_line = last_line .. " "
333                 end
334
335                 last_line = last_line .. string_sub(text, current_idx, stop - 1)
336
337                 if gotnewline then
338                         retval[#retval + 1] = last_line
339                         last_line = ""
340                         gotnewline = false
341                 end
342                 current_idx = stop+1
343
344                 start,stop = string_find(text, " ", current_idx)
345                 nl_start,nl_stop = string_find(text, "\n", current_idx)
346
347                 if nl_start ~= nil and (start == nil or nl_start < start) then
348                         start = nl_start
349                         stop = nl_stop
350                         gotnewline = true
351                 end
352         end
353
354         --add last part of text
355         if string.len(last_line) + (string.len(text) - current_idx) > charlimit then
356                         retval[#retval + 1] = last_line
357                         retval[#retval + 1] = string_sub(text, current_idx)
358         else
359                 last_line = last_line .. " " .. string_sub(text, current_idx)
360                 retval[#retval + 1] = last_line
361         end
362
363         return retval
364 end
365
366 --------------------------------------------------------------------------------
367
368 if INIT == "game" then
369         local dirs1 = {9, 18, 7, 12}
370         local dirs2 = {20, 23, 22, 21}
371
372         function core.rotate_and_place(itemstack, placer, pointed_thing,
373                                 infinitestacks, orient_flags)
374                 orient_flags = orient_flags or {}
375
376                 local unode = core.get_node_or_nil(pointed_thing.under)
377                 if not unode then
378                         return
379                 end
380                 local undef = core.registered_nodes[unode.name]
381                 if undef and undef.on_rightclick then
382                         undef.on_rightclick(pointed_thing.under, unode, placer,
383                                         itemstack, pointed_thing)
384                         return
385                 end
386                 local fdir = core.dir_to_facedir(placer:get_look_dir())
387                 local wield_name = itemstack:get_name()
388
389                 local above = pointed_thing.above
390                 local under = pointed_thing.under
391                 local iswall = (above.y == under.y)
392                 local isceiling = not iswall and (above.y < under.y)
393                 local anode = core.get_node_or_nil(above)
394                 if not anode then
395                         return
396                 end
397                 local pos = pointed_thing.above
398                 local node = anode
399
400                 if undef and undef.buildable_to then
401                         pos = pointed_thing.under
402                         node = unode
403                         iswall = false
404                 end
405
406                 if core.is_protected(pos, placer:get_player_name()) then
407                         core.record_protection_violation(pos,
408                                         placer:get_player_name())
409                         return
410                 end
411
412                 local ndef = core.registered_nodes[node.name]
413                 if not ndef or not ndef.buildable_to then
414                         return
415                 end
416
417                 if orient_flags.force_floor then
418                         iswall = false
419                         isceiling = false
420                 elseif orient_flags.force_ceiling then
421                         iswall = false
422                         isceiling = true
423                 elseif orient_flags.force_wall then
424                         iswall = true
425                         isceiling = false
426                 elseif orient_flags.invert_wall then
427                         iswall = not iswall
428                 end
429
430                 if iswall then
431                         core.set_node(pos, {name = wield_name,
432                                         param2 = dirs1[fdir + 1]})
433                 elseif isceiling then
434                         if orient_flags.force_facedir then
435                                 core.set_node(pos, {name = wield_name,
436                                                 param2 = 20})
437                         else
438                                 core.set_node(pos, {name = wield_name,
439                                                 param2 = dirs2[fdir + 1]})
440                         end
441                 else -- place right side up
442                         if orient_flags.force_facedir then
443                                 core.set_node(pos, {name = wield_name,
444                                                 param2 = 0})
445                         else
446                                 core.set_node(pos, {name = wield_name,
447                                                 param2 = fdir})
448                         end
449                 end
450
451                 if not infinitestacks then
452                         itemstack:take_item()
453                         return itemstack
454                 end
455         end
456
457
458 --------------------------------------------------------------------------------
459 --Wrapper for rotate_and_place() to check for sneak and assume Creative mode
460 --implies infinite stacks when performing a 6d rotation.
461 --------------------------------------------------------------------------------
462
463
464         core.rotate_node = function(itemstack, placer, pointed_thing)
465                 core.rotate_and_place(itemstack, placer, pointed_thing,
466                                 core.settings:get_bool("creative_mode"),
467                                 {invert_wall = placer:get_player_control().sneak})
468                 return itemstack
469         end
470 end
471
472 --------------------------------------------------------------------------------
473 function core.explode_table_event(evt)
474         if evt ~= nil then
475                 local parts = evt:split(":")
476                 if #parts == 3 then
477                         local t = parts[1]:trim()
478                         local r = tonumber(parts[2]:trim())
479                         local c = tonumber(parts[3]:trim())
480                         if type(r) == "number" and type(c) == "number"
481                                         and t ~= "INV" then
482                                 return {type=t, row=r, column=c}
483                         end
484                 end
485         end
486         return {type="INV", row=0, column=0}
487 end
488
489 --------------------------------------------------------------------------------
490 function core.explode_textlist_event(evt)
491         if evt ~= nil then
492                 local parts = evt:split(":")
493                 if #parts == 2 then
494                         local t = parts[1]:trim()
495                         local r = tonumber(parts[2]:trim())
496                         if type(r) == "number" and t ~= "INV" then
497                                 return {type=t, index=r}
498                         end
499                 end
500         end
501         return {type="INV", index=0}
502 end
503
504 --------------------------------------------------------------------------------
505 function core.explode_scrollbar_event(evt)
506         local retval = core.explode_textlist_event(evt)
507
508         retval.value = retval.index
509         retval.index = nil
510
511         return retval
512 end
513
514 --------------------------------------------------------------------------------
515 function core.rgba(r, g, b, a)
516         return a and string.format("#%02X%02X%02X%02X", r, g, b, a) or
517                         string.format("#%02X%02X%02X", r, g, b)
518 end
519
520 --------------------------------------------------------------------------------
521 function core.pos_to_string(pos, decimal_places)
522         local x = pos.x
523         local y = pos.y
524         local z = pos.z
525         if decimal_places ~= nil then
526                 x = string.format("%." .. decimal_places .. "f", x)
527                 y = string.format("%." .. decimal_places .. "f", y)
528                 z = string.format("%." .. decimal_places .. "f", z)
529         end
530         return "(" .. x .. "," .. y .. "," .. z .. ")"
531 end
532
533 --------------------------------------------------------------------------------
534 function core.string_to_pos(value)
535         if value == nil then
536                 return nil
537         end
538
539         local p = {}
540         p.x, p.y, p.z = string.match(value, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
541         if p.x and p.y and p.z then
542                 p.x = tonumber(p.x)
543                 p.y = tonumber(p.y)
544                 p.z = tonumber(p.z)
545                 return p
546         end
547         local p = {}
548         p.x, p.y, p.z = string.match(value, "^%( *([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+) *%)$")
549         if p.x and p.y and p.z then
550                 p.x = tonumber(p.x)
551                 p.y = tonumber(p.y)
552                 p.z = tonumber(p.z)
553                 return p
554         end
555         return nil
556 end
557
558 assert(core.string_to_pos("10.0, 5, -2").x == 10)
559 assert(core.string_to_pos("( 10.0, 5, -2)").z == -2)
560 assert(core.string_to_pos("asd, 5, -2)") == nil)
561
562 --------------------------------------------------------------------------------
563 function core.string_to_area(value)
564         local p1, p2 = unpack(value:split(") ("))
565         if p1 == nil or p2 == nil then
566                 return nil
567         end
568
569         p1 = core.string_to_pos(p1 .. ")")
570         p2 = core.string_to_pos("(" .. p2)
571         if p1 == nil or p2 == nil then
572                 return nil
573         end
574
575         return p1, p2
576 end
577
578 local function test_string_to_area()
579         local p1, p2 = core.string_to_area("(10.0, 5, -2) (  30.2,   4, -12.53)")
580         assert(p1.x == 10.0 and p1.y == 5 and p1.z == -2)
581         assert(p2.x == 30.2 and p2.y == 4 and p2.z == -12.53)
582
583         p1, p2 = core.string_to_area("(10.0, 5, -2  30.2,   4, -12.53")
584         assert(p1 == nil and p2 == nil)
585
586         p1, p2 = core.string_to_area("(10.0, 5,) -2  fgdf2,   4, -12.53")
587         assert(p1 == nil and p2 == nil)
588 end
589
590 test_string_to_area()
591
592 --------------------------------------------------------------------------------
593 function table.copy(t, seen)
594         local n = {}
595         seen = seen or {}
596         seen[t] = n
597         for k, v in pairs(t) do
598                 n[(type(k) == "table" and (seen[k] or table.copy(k, seen))) or k] =
599                         (type(v) == "table" and (seen[v] or table.copy(v, seen))) or v
600         end
601         return n
602 end
603 --------------------------------------------------------------------------------
604 -- mainmenu only functions
605 --------------------------------------------------------------------------------
606 if INIT == "mainmenu" then
607         function core.get_game(index)
608                 local games = game.get_games()
609
610                 if index > 0 and index <= #games then
611                         return games[index]
612                 end
613
614                 return nil
615         end
616 end
617
618 if INIT == "client" or INIT == "mainmenu" then
619         function fgettext_ne(text, ...)
620                 text = core.gettext(text)
621                 local arg = {n=select('#', ...), ...}
622                 if arg.n >= 1 then
623                         -- Insert positional parameters ($1, $2, ...)
624                         local result = ''
625                         local pos = 1
626                         while pos <= text:len() do
627                                 local newpos = text:find('[$]', pos)
628                                 if newpos == nil then
629                                         result = result .. text:sub(pos)
630                                         pos = text:len() + 1
631                                 else
632                                         local paramindex =
633                                                 tonumber(text:sub(newpos+1, newpos+1))
634                                         result = result .. text:sub(pos, newpos-1)
635                                                 .. tostring(arg[paramindex])
636                                         pos = newpos + 2
637                                 end
638                         end
639                         text = result
640                 end
641                 return text
642         end
643
644         function fgettext(text, ...)
645                 return core.formspec_escape(fgettext_ne(text, ...))
646         end
647 end
648
649 local ESCAPE_CHAR = string.char(0x1b)
650
651 function core.get_color_escape_sequence(color)
652         return ESCAPE_CHAR .. "(c@" .. color .. ")"
653 end
654
655 function core.get_background_escape_sequence(color)
656         return ESCAPE_CHAR .. "(b@" .. color .. ")"
657 end
658
659 function core.colorize(color, message)
660         local lines = tostring(message):split("\n", true)
661         local color_code = core.get_color_escape_sequence(color)
662
663         for i, line in ipairs(lines) do
664                 lines[i] = color_code .. line
665         end
666
667         return table.concat(lines, "\n") .. core.get_color_escape_sequence("#ffffff")
668 end
669
670
671 function core.strip_foreground_colors(str)
672         return (str:gsub(ESCAPE_CHAR .. "%(c@[^)]+%)", ""))
673 end
674
675 function core.strip_background_colors(str)
676         return (str:gsub(ESCAPE_CHAR .. "%(b@[^)]+%)", ""))
677 end
678
679 function core.strip_colors(str)
680         return (str:gsub(ESCAPE_CHAR .. "%([bc]@[^)]+%)", ""))
681 end
682
683 --------------------------------------------------------------------------------
684 -- Returns the exact coordinate of a pointed surface
685 --------------------------------------------------------------------------------
686 function core.pointed_thing_to_face_pos(placer, pointed_thing)
687         local eye_offset_first = placer:get_eye_offset()
688         local node_pos = pointed_thing.under
689         local camera_pos = placer:get_pos()
690         local pos_off = vector.multiply(
691                         vector.subtract(pointed_thing.above, node_pos), 0.5)
692         local look_dir = placer:get_look_dir()
693         local offset, nc
694         local oc = {}
695
696         for c, v in pairs(pos_off) do
697                 if nc or v == 0 then
698                         oc[#oc + 1] = c
699                 else
700                         offset = v
701                         nc = c
702                 end
703         end
704
705         local fine_pos = {[nc] = node_pos[nc] + offset}
706         camera_pos.y = camera_pos.y + 1.625 + eye_offset_first.y / 10
707         local f = (node_pos[nc] + offset - camera_pos[nc]) / look_dir[nc]
708
709         for i = 1, #oc do
710                 fine_pos[oc[i]] = camera_pos[oc[i]] + look_dir[oc[i]] * f
711         end
712         return fine_pos
713 end
714
715 function core.string_to_privs(str, delim)
716         assert(type(str) == "string")
717         delim = delim or ','
718         local privs = {}
719         for _, priv in pairs(string.split(str, delim)) do
720                 privs[priv:trim()] = true
721         end
722         return privs
723 end
724
725 function core.privs_to_string(privs, delim)
726         assert(type(privs) == "table")
727         delim = delim or ','
728         local list = {}
729         for priv, bool in pairs(privs) do
730                 if bool then
731                         list[#list + 1] = priv
732                 end
733         end
734         return table.concat(list, delim)
735 end
736
737 assert(core.string_to_privs("a,b").b == true)
738 assert(core.privs_to_string({a=true,b=true}) == "a,b")