148 lines
4.5 KiB
Lua
148 lines
4.5 KiB
Lua
-- SPDX-FileCopyrightText: 2020 The CC: Tweaked Developers
|
|
--
|
|
-- SPDX-License-Identifier: MPL-2.0
|
|
|
|
--- Various utilities for working with strings and text.
|
|
--
|
|
-- @module cc.strings
|
|
-- @since 1.95.0
|
|
-- @see textutils For additional string related utilities.
|
|
|
|
local expect = (require and require("cc.expect") or dofile("rom/modules/main/cc/expect.lua")).expect
|
|
|
|
--[[- Wraps a block of text, so that each line fits within the given width.
|
|
|
|
This may be useful if you want to wrap text before displaying it to a
|
|
[`monitor`] or [`printer`] without using [print][`_G.print`].
|
|
|
|
@tparam string text The string to wrap.
|
|
@tparam[opt] number width The width to constrain to, defaults to the width of
|
|
the terminal.
|
|
@treturn { string... } The wrapped input string as a list of lines.
|
|
@usage Wrap a string and write it to the terminal.
|
|
|
|
term.clear()
|
|
local lines = require "cc.strings".wrap("This is a long piece of text", 10)
|
|
for i = 1, #lines do
|
|
term.setCursorPos(1, i)
|
|
term.write(lines[i])
|
|
end
|
|
]]
|
|
local function wrap(text, width)
|
|
expect(1, text, "string")
|
|
expect(2, width, "number", "nil")
|
|
width = width or term.getSize()
|
|
|
|
|
|
local lines, lines_n, current_line = {}, 0, ""
|
|
local function push_line()
|
|
lines_n = lines_n + 1
|
|
lines[lines_n] = current_line
|
|
current_line = ""
|
|
end
|
|
|
|
local pos, length = 1, #text
|
|
local sub, match = string.sub, string.match
|
|
while pos <= length do
|
|
local head = sub(text, pos, pos)
|
|
if head == " " or head == "\t" then
|
|
local whitespace = match(text, "^[ \t]+", pos)
|
|
current_line = current_line .. whitespace
|
|
pos = pos + #whitespace
|
|
elseif head == "\n" then
|
|
push_line()
|
|
pos = pos + 1
|
|
else
|
|
local word = match(text, "^[^ \t\n]+", pos)
|
|
pos = pos + #word
|
|
if #word > width then
|
|
-- Print a multiline word
|
|
while #word > 0 do
|
|
local space_remaining = width - #current_line - 1
|
|
if space_remaining <= 0 then
|
|
push_line()
|
|
space_remaining = width
|
|
end
|
|
|
|
current_line = current_line .. sub(word, 1, space_remaining)
|
|
word = sub(word, space_remaining + 1)
|
|
end
|
|
else
|
|
-- Print a word normally
|
|
if width - #current_line < #word then push_line() end
|
|
current_line = current_line .. word
|
|
end
|
|
end
|
|
end
|
|
|
|
push_line()
|
|
|
|
-- Trim whitespace longer than width.
|
|
for k, line in pairs(lines) do
|
|
line = line:sub(1, width)
|
|
lines[k] = line
|
|
end
|
|
|
|
return lines
|
|
end
|
|
|
|
--- Makes the input string a fixed width. This either truncates it, or pads it
|
|
-- with spaces.
|
|
--
|
|
-- @tparam string line The string to normalise.
|
|
-- @tparam[opt] number width The width to constrain to, defaults to the width of
|
|
-- the terminal.
|
|
--
|
|
-- @treturn string The string with a specific width.
|
|
-- @usage require "cc.strings".ensure_width("a short string", 20)
|
|
-- @usage require "cc.strings".ensure_width("a rather long string which is truncated", 20)
|
|
local function ensure_width(line, width)
|
|
expect(1, line, "string")
|
|
expect(2, width, "number", "nil")
|
|
width = width or term.getSize()
|
|
|
|
line = line:sub(1, width)
|
|
if #line < width then
|
|
line = line .. (" "):rep(width - #line)
|
|
end
|
|
|
|
return line
|
|
end
|
|
|
|
--- Splits a string in a table.
|
|
--
|
|
-- @tparam string inputstr The string to split.
|
|
-- @tparam string sep The separator to split the string at
|
|
-- @tparam number split_count How many times the string should be splitted.
|
|
-- @treturn table A table containing the splitted strings.
|
|
-- @usage args = textutils.splitString("arg1 arg2", " ")
|
|
-- @since edit this if it goes live (I hope it does)
|
|
local function split(inputstr, sep, split_count)
|
|
expect(1, inputstr, "string")
|
|
expect(2, sep, "string", "nil")
|
|
expect(3, split_count, "number", "nil")
|
|
if sep == nil then
|
|
sep = "%s"
|
|
end
|
|
if split_count == nil then
|
|
split_count = -1
|
|
end
|
|
local splitted_table = {}
|
|
local splitted_amount = 0
|
|
for str in string.gmatch(inputstr, "([^" .. sep .. "]+)") do
|
|
if splitted_amount == split_count then
|
|
break
|
|
else
|
|
table.insert(splitted_table, str)
|
|
splitted_amount = splitted_amount + 1
|
|
end
|
|
end
|
|
return splitted_table
|
|
end
|
|
|
|
return {
|
|
wrap = wrap,
|
|
ensure_width = ensure_width,
|
|
split = split,
|
|
}
|