Fix core.wrap_text and make its behaviour consistent with the docs

Code based on initial implementation by @dsohler.

diff --git a/builtin/common/misc_helpers.lua b/builtin/common/misc_helpers.lua
index 0bdd4b02ad9f14a8ab22f6265d6ce85e7c1df8e7..4840dcbaaa74e8602572ece1ac073b4bf9a76183 100644 (file)
--- a/builtin/common/misc_helpers.lua
+++ b/builtin/common/misc_helpers.lua
@@ -308,59 +308,25 @@ function core.formspec_escape(text)
 end
 
 
-function core.wrap_text(text, charlimit)
-       local retval = {}
-
-       local current_idx = 1
-
-       local start,stop = string_find(text, " ", current_idx)
-       local nl_start,nl_stop = string_find(text, "\n", current_idx)
-       local gotnewline = false
-       if nl_start ~= nil and (start == nil or nl_start < start) then
-               start = nl_start
-               stop = nl_stop
-               gotnewline = true
-       end
-       local last_line = ""
-       while start ~= nil do
-               if string.len(last_line) + (stop-start) > charlimit then
-                       retval[#retval + 1] = last_line
-                       last_line = ""
+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
+
+       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
-
-               if last_line ~= "" then
-                       last_line = last_line .. " "
-               end
-
-               last_line = last_line .. string_sub(text, current_idx, stop - 1)
-
-               if gotnewline then
-                       retval[#retval + 1] = last_line
-                       last_line = ""
-                       gotnewline = false
-               end
-               current_idx = stop+1
-
-               start,stop = string_find(text, " ", current_idx)
-               nl_start,nl_stop = string_find(text, "\n", current_idx)
-
-               if nl_start ~= nil and (start == nil or nl_start < start) then
-                       start = nl_start
-                       stop = nl_stop
-                       gotnewline = true
-               end
-       end
-
-       --add last part of text
-       if string.len(last_line) + (string.len(text) - current_idx) > charlimit then
-                       retval[#retval + 1] = last_line
-                       retval[#retval + 1] = string_sub(text, current_idx)
-       else
-               last_line = last_line .. " " .. string_sub(text, current_idx)
-               retval[#retval + 1] = last_line
+               table.insert(line, word)
        end
 
-       return retval
+       table.insert(result, table.concat(line, ' '))
+       return as_table and result or table.concat(result, '\n')
 end
 
 --------------------------------------------------------------------------------

diff --git a/builtin/mainmenu/common.lua b/builtin/mainmenu/common.lua
index fa7ae583b5826016ef670680356b965a471e545e..7eb941775b9b67fc86fe4aeb365ba78402a2f9b1 100644 (file)
--- a/builtin/mainmenu/common.lua
+++ b/builtin/mainmenu/common.lua
@@ -250,7 +250,7 @@ end
 
 --------------------------------------------------------------------------------
 function text2textlist(xpos, ypos, width, height, tl_name, textlen, text, transparency)
-       local textlines = core.wrap_text(text, textlen)
+       local textlines = core.wrap_text(text, textlen, true)
        local retval = "textlist[" .. xpos .. "," .. ypos .. ";" .. width ..
                        "," .. height .. ";" .. tl_name .. ";"
 

diff --git a/builtin/mainmenu/tab_mods.lua b/builtin/mainmenu/tab_mods.lua
index 9510a9e18a7fa3028c6c561d2d3be4ae9083472b..7f95355a9729f8af1c401938c7cc6f320ccdc97e 100644 (file)
--- a/builtin/mainmenu/tab_mods.lua
+++ b/builtin/mainmenu/tab_mods.lua
@@ -75,7 +75,7 @@ local function get_formspec(tabview, name, tabdata)
                if error == nil then
                        local descriptiontext = descriptionfile:read("*all")
 
-                       descriptionlines = core.wrap_text(descriptiontext, 42)
+                       descriptionlines = core.wrap_text(descriptiontext, 42, true)
                        descriptionfile:close()
                else
                        descriptionlines = {}

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 03c825689adf6b95279ede5aec2a9083dc589124..f0e6931db7636a904429f948f00cd25701c658e0 100644 (file)
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2128,9 +2128,11 @@ Helper functions
     * e.g. `string:split("a,b", ",") == {"a","b"}`
 * `string:trim()`
     * e.g. `string.trim("\n \t\tfoo bar\t ") == "foo bar"`
-* `minetest.wrap_text(str, limit)`: returns a string
-    * Adds new lines to the string to keep it within the specified character limit
+* `minetest.wrap_text(str, limit, [as_table])`: returns a string or table
+    * Adds newlines to the string to keep it within the specified character limit
+      Note that returned lines may be longer than the limit since it only splits at word borders.
     * limit: Maximal amount of characters in one line
+    * as_table: optional, if true return table of lines instead of string
 * `minetest.pos_to_string({x=X,y=Y,z=Z}, decimal_places))`: returns string `"(X,Y,Z)"`
     * Convert position to a printable string
       Optional: 'decimal_places' will round the x, y and z of the pos to the given decimal place.