Add functions to strip color information. (#5472)

This commit is contained in:
Diego Martínez 2017-03-28 16:55:39 -03:00 committed by Loïc Blot
parent 1b299b4039
commit 81c3dc32a8
3 changed files with 26 additions and 1 deletions

@ -640,6 +640,8 @@ if INIT == "client" or INIT == "mainmenu" then
end end
end end
local ESCAPE_CHAR = string.char(0x1b)
-- Client-sided mods don't have access to getbool -- Client-sided mods don't have access to getbool
if core.setting_getbool and core.setting_getbool("disable_escape_sequences") then if core.setting_getbool and core.setting_getbool("disable_escape_sequences") then
@ -657,7 +659,6 @@ if core.setting_getbool and core.setting_getbool("disable_escape_sequences") the
else else
local ESCAPE_CHAR = string.char(0x1b)
function core.get_color_escape_sequence(color) function core.get_color_escape_sequence(color)
return ESCAPE_CHAR .. "(c@" .. color .. ")" return ESCAPE_CHAR .. "(c@" .. color .. ")"
end end
@ -678,3 +679,15 @@ else
end end
end 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

@ -818,6 +818,12 @@ The following functions provide escape sequences:
* `color` is a ColorString * `color` is a ColorString
* The escape sequence sets the background of the whole text element to * The escape sequence sets the background of the whole text element to
`color`. Only defined for item descriptions and tooltips. `color`. Only defined for item descriptions and tooltips.
* `color.strip_foreground_colors(str)`
* Removes foreground colors added by `get_color_escape_sequence`.
* `color.strip_background_colors(str)`
* Removes background colors added by `get_background_escape_sequence`.
* `color.strip_colors(str)`
* Removes all color escape sequences.
`ColorString` `ColorString`
------------- -------------

@ -1872,6 +1872,12 @@ The following functions provide escape sequences:
* `color` is a ColorString * `color` is a ColorString
* The escape sequence sets the background of the whole text element to * The escape sequence sets the background of the whole text element to
`color`. Only defined for item descriptions and tooltips. `color`. Only defined for item descriptions and tooltips.
* `color.strip_foreground_colors(str)`
* Removes foreground colors added by `get_color_escape_sequence`.
* `color.strip_background_colors(str)`
* Removes background colors added by `get_background_escape_sequence`.
* `color.strip_colors(str)`
* Removes all color escape sequences.
Spatial Vectors Spatial Vectors
--------------- ---------------