]> git.lizzy.rs Git - minetest.git/blob - builtin/common/misc_helpers.lua
core.rotate_node: Run callbacks like with any regular placed node (#6648)
[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, max_length, as_table)
312         local result = {}
313         local line = {}
314         if #text <= max_length then
315                 return as_table and {text} or text
316         end
317
318         for word in text:gmatch('%S+') do
319                 local cur_length = #table.concat(line, ' ')
320                 if cur_length > 0 and cur_length + #word + 1 >= max_length then
321                         -- word wouldn't fit on current line, move to next line
322                         table.insert(result, table.concat(line, ' '))
323                         line = {}
324                 end
325                 table.insert(line, word)
326         end
327
328         table.insert(result, table.concat(line, ' '))
329         return as_table and result or table.concat(result, '\n')
330 end
331
332 --------------------------------------------------------------------------------
333
334 if INIT == "game" then
335         local dirs1 = {9, 18, 7, 12}
336         local dirs2 = {20, 23, 22, 21}
337
338         function core.rotate_and_place(itemstack, placer, pointed_thing,
339                                 infinitestacks, orient_flags)
340                 orient_flags = orient_flags or {}
341
342                 local unode = core.get_node_or_nil(pointed_thing.under)
343                 if not unode then
344                         return
345                 end
346                 local undef = core.registered_nodes[unode.name]
347                 if undef and undef.on_rightclick then
348                         return undef.on_rightclick(pointed_thing.under, unode, placer,
349                                         itemstack, pointed_thing)
350                 end
351                 local fdir = placer and core.dir_to_facedir(placer:get_look_dir()) or 0
352
353                 local above = pointed_thing.above
354                 local under = pointed_thing.under
355                 local iswall = (above.y == under.y)
356                 local isceiling = not iswall and (above.y < under.y)
357
358                 if undef and undef.buildable_to then
359                         iswall = false
360                 end
361
362                 if orient_flags.force_floor then
363                         iswall = false
364                         isceiling = false
365                 elseif orient_flags.force_ceiling then
366                         iswall = false
367                         isceiling = true
368                 elseif orient_flags.force_wall then
369                         iswall = true
370                         isceiling = false
371                 elseif orient_flags.invert_wall then
372                         iswall = not iswall
373                 end
374
375                 local param2 = fdir
376                 if iswall then
377                         param2 = dirs1[fdir + 1]
378                 elseif isceiling then
379                         if orient_flags.force_facedir then
380                                 cparam2 = 20
381                         else
382                                 param2 = dirs2[fdir + 1]
383                         end
384                 else -- place right side up
385                         if orient_flags.force_facedir then
386                                 param2 = 0
387                         end
388                 end
389
390                 local old_itemstack = ItemStack(itemstack)
391                 local new_itemstack, removed = core.item_place_node(
392                         itemstack, placer, pointed_thing, param2
393                 )
394                 return infinitestacks and old_itemstack or new_itemstack
395         end
396
397
398 --------------------------------------------------------------------------------
399 --Wrapper for rotate_and_place() to check for sneak and assume Creative mode
400 --implies infinite stacks when performing a 6d rotation.
401 --------------------------------------------------------------------------------
402         local creative_mode_cache = core.settings:get_bool("creative_mode")
403         local function is_creative(name)
404                 return creative_mode_cache or
405                                 core.check_player_privs(name, {creative = true})
406         end
407
408         core.rotate_node = function(itemstack, placer, pointed_thing)
409                 local name = placer and placer:get_player_name() or ""
410                 local invert_wall = placer and placer:get_player_control().sneak or false
411                 core.rotate_and_place(itemstack, placer, pointed_thing,
412                                 is_creative(name),
413                                 {invert_wall = invert_wall})
414                 return itemstack
415         end
416 end
417
418 --------------------------------------------------------------------------------
419 function core.explode_table_event(evt)
420         if evt ~= nil then
421                 local parts = evt:split(":")
422                 if #parts == 3 then
423                         local t = parts[1]:trim()
424                         local r = tonumber(parts[2]:trim())
425                         local c = tonumber(parts[3]:trim())
426                         if type(r) == "number" and type(c) == "number"
427                                         and t ~= "INV" then
428                                 return {type=t, row=r, column=c}
429                         end
430                 end
431         end
432         return {type="INV", row=0, column=0}
433 end
434
435 --------------------------------------------------------------------------------
436 function core.explode_textlist_event(evt)
437         if evt ~= nil then
438                 local parts = evt:split(":")
439                 if #parts == 2 then
440                         local t = parts[1]:trim()
441                         local r = tonumber(parts[2]:trim())
442                         if type(r) == "number" and t ~= "INV" then
443                                 return {type=t, index=r}
444                         end
445                 end
446         end
447         return {type="INV", index=0}
448 end
449
450 --------------------------------------------------------------------------------
451 function core.explode_scrollbar_event(evt)
452         local retval = core.explode_textlist_event(evt)
453
454         retval.value = retval.index
455         retval.index = nil
456
457         return retval
458 end
459
460 --------------------------------------------------------------------------------
461 function core.rgba(r, g, b, a)
462         return a and string.format("#%02X%02X%02X%02X", r, g, b, a) or
463                         string.format("#%02X%02X%02X", r, g, b)
464 end
465
466 --------------------------------------------------------------------------------
467 function core.pos_to_string(pos, decimal_places)
468         local x = pos.x
469         local y = pos.y
470         local z = pos.z
471         if decimal_places ~= nil then
472                 x = string.format("%." .. decimal_places .. "f", x)
473                 y = string.format("%." .. decimal_places .. "f", y)
474                 z = string.format("%." .. decimal_places .. "f", z)
475         end
476         return "(" .. x .. "," .. y .. "," .. z .. ")"
477 end
478
479 --------------------------------------------------------------------------------
480 function core.string_to_pos(value)
481         if value == nil then
482                 return nil
483         end
484
485         local p = {}
486         p.x, p.y, p.z = string.match(value, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
487         if p.x and p.y and p.z then
488                 p.x = tonumber(p.x)
489                 p.y = tonumber(p.y)
490                 p.z = tonumber(p.z)
491                 return p
492         end
493         local p = {}
494         p.x, p.y, p.z = string.match(value, "^%( *([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+) *%)$")
495         if p.x and p.y and p.z then
496                 p.x = tonumber(p.x)
497                 p.y = tonumber(p.y)
498                 p.z = tonumber(p.z)
499                 return p
500         end
501         return nil
502 end
503
504 assert(core.string_to_pos("10.0, 5, -2").x == 10)
505 assert(core.string_to_pos("( 10.0, 5, -2)").z == -2)
506 assert(core.string_to_pos("asd, 5, -2)") == nil)
507
508 --------------------------------------------------------------------------------
509 function core.string_to_area(value)
510         local p1, p2 = unpack(value:split(") ("))
511         if p1 == nil or p2 == nil then
512                 return nil
513         end
514
515         p1 = core.string_to_pos(p1 .. ")")
516         p2 = core.string_to_pos("(" .. p2)
517         if p1 == nil or p2 == nil then
518                 return nil
519         end
520
521         return p1, p2
522 end
523
524 local function test_string_to_area()
525         local p1, p2 = core.string_to_area("(10.0, 5, -2) (  30.2,   4, -12.53)")
526         assert(p1.x == 10.0 and p1.y == 5 and p1.z == -2)
527         assert(p2.x == 30.2 and p2.y == 4 and p2.z == -12.53)
528
529         p1, p2 = core.string_to_area("(10.0, 5, -2  30.2,   4, -12.53")
530         assert(p1 == nil and p2 == nil)
531
532         p1, p2 = core.string_to_area("(10.0, 5,) -2  fgdf2,   4, -12.53")
533         assert(p1 == nil and p2 == nil)
534 end
535
536 test_string_to_area()
537
538 --------------------------------------------------------------------------------
539 function table.copy(t, seen)
540         local n = {}
541         seen = seen or {}
542         seen[t] = n
543         for k, v in pairs(t) do
544                 n[(type(k) == "table" and (seen[k] or table.copy(k, seen))) or k] =
545                         (type(v) == "table" and (seen[v] or table.copy(v, seen))) or v
546         end
547         return n
548 end
549 --------------------------------------------------------------------------------
550 -- mainmenu only functions
551 --------------------------------------------------------------------------------
552 if INIT == "mainmenu" then
553         function core.get_game(index)
554                 local games = game.get_games()
555
556                 if index > 0 and index <= #games then
557                         return games[index]
558                 end
559
560                 return nil
561         end
562 end
563
564 if INIT == "client" or INIT == "mainmenu" then
565         function fgettext_ne(text, ...)
566                 text = core.gettext(text)
567                 local arg = {n=select('#', ...), ...}
568                 if arg.n >= 1 then
569                         -- Insert positional parameters ($1, $2, ...)
570                         local result = ''
571                         local pos = 1
572                         while pos <= text:len() do
573                                 local newpos = text:find('[$]', pos)
574                                 if newpos == nil then
575                                         result = result .. text:sub(pos)
576                                         pos = text:len() + 1
577                                 else
578                                         local paramindex =
579                                                 tonumber(text:sub(newpos+1, newpos+1))
580                                         result = result .. text:sub(pos, newpos-1)
581                                                 .. tostring(arg[paramindex])
582                                         pos = newpos + 2
583                                 end
584                         end
585                         text = result
586                 end
587                 return text
588         end
589
590         function fgettext(text, ...)
591                 return core.formspec_escape(fgettext_ne(text, ...))
592         end
593 end
594
595 local ESCAPE_CHAR = string.char(0x1b)
596
597 function core.get_color_escape_sequence(color)
598         return ESCAPE_CHAR .. "(c@" .. color .. ")"
599 end
600
601 function core.get_background_escape_sequence(color)
602         return ESCAPE_CHAR .. "(b@" .. color .. ")"
603 end
604
605 function core.colorize(color, message)
606         local lines = tostring(message):split("\n", true)
607         local color_code = core.get_color_escape_sequence(color)
608
609         for i, line in ipairs(lines) do
610                 lines[i] = color_code .. line
611         end
612
613         return table.concat(lines, "\n") .. core.get_color_escape_sequence("#ffffff")
614 end
615
616
617 function core.strip_foreground_colors(str)
618         return (str:gsub(ESCAPE_CHAR .. "%(c@[^)]+%)", ""))
619 end
620
621 function core.strip_background_colors(str)
622         return (str:gsub(ESCAPE_CHAR .. "%(b@[^)]+%)", ""))
623 end
624
625 function core.strip_colors(str)
626         return (str:gsub(ESCAPE_CHAR .. "%([bc]@[^)]+%)", ""))
627 end
628
629 function core.translate(textdomain, str, ...)
630         local start_seq
631         if textdomain == "" then
632                 start_seq = ESCAPE_CHAR .. "T"
633         else
634                 start_seq = ESCAPE_CHAR .. "(T@" .. textdomain .. ")"
635         end
636         local arg = {n=select('#', ...), ...}
637         local end_seq = ESCAPE_CHAR .. "E"
638         local arg_index = 1
639         local translated = str:gsub("@(.)", function(matched)
640                 local c = string.byte(matched)
641                 if string.byte("1") <= c and c <= string.byte("9") then
642                         local a = c - string.byte("0")
643                         if a ~= arg_index then
644                                 error("Escape sequences in string given to core.translate " ..
645                                         "are not in the correct order: got @" .. matched ..
646                                         "but expected @" .. tostring(arg_index))
647                         end
648                         if a > arg.n then
649                                 error("Not enough arguments provided to core.translate")
650                         end
651                         arg_index = arg_index + 1
652                         return ESCAPE_CHAR .. "F" .. arg[a] .. ESCAPE_CHAR .. "E"
653                 elseif matched == "n" then
654                         return "\n"
655                 else
656                         return matched
657                 end
658         end)
659         if arg_index < arg.n + 1 then
660                 error("Too many arguments provided to core.translate")
661         end
662         return start_seq .. translated .. end_seq
663 end
664
665 function core.get_translator(textdomain)
666         return function(str, ...) return core.translate(textdomain or "", str, ...) end
667 end
668
669 --------------------------------------------------------------------------------
670 -- Returns the exact coordinate of a pointed surface
671 --------------------------------------------------------------------------------
672 function core.pointed_thing_to_face_pos(placer, pointed_thing)
673         local eye_offset_first = placer:get_eye_offset()
674         local node_pos = pointed_thing.under
675         local camera_pos = placer:get_pos()
676         local pos_off = vector.multiply(
677                         vector.subtract(pointed_thing.above, node_pos), 0.5)
678         local look_dir = placer:get_look_dir()
679         local offset, nc
680         local oc = {}
681
682         for c, v in pairs(pos_off) do
683                 if nc or v == 0 then
684                         oc[#oc + 1] = c
685                 else
686                         offset = v
687                         nc = c
688                 end
689         end
690
691         local fine_pos = {[nc] = node_pos[nc] + offset}
692         camera_pos.y = camera_pos.y + 1.625 + eye_offset_first.y / 10
693         local f = (node_pos[nc] + offset - camera_pos[nc]) / look_dir[nc]
694
695         for i = 1, #oc do
696                 fine_pos[oc[i]] = camera_pos[oc[i]] + look_dir[oc[i]] * f
697         end
698         return fine_pos
699 end
700
701 function core.string_to_privs(str, delim)
702         assert(type(str) == "string")
703         delim = delim or ','
704         local privs = {}
705         for _, priv in pairs(string.split(str, delim)) do
706                 privs[priv:trim()] = true
707         end
708         return privs
709 end
710
711 function core.privs_to_string(privs, delim)
712         assert(type(privs) == "table")
713         delim = delim or ','
714         local list = {}
715         for priv, bool in pairs(privs) do
716                 if bool then
717                         list[#list + 1] = priv
718                 end
719         end
720         return table.concat(list, delim)
721 end
722
723 assert(core.string_to_privs("a,b").b == true)
724 assert(core.privs_to_string({a=true,b=true}) == "a,b")