xref: /freebsd/stand/lua/color.lua (revision 5bb3134a8c21cb87b30e135ef168483f0333dabb)
1--
2-- SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3--
4-- Copyright (c) 2015 Pedro Souza <pedrosouza@freebsd.org>
5-- All rights reserved.
6--
7-- Redistribution and use in source and binary forms, with or without
8-- modification, are permitted provided that the following conditions
9-- are met:
10-- 1. Redistributions of source code must retain the above copyright
11--    notice, this list of conditions and the following disclaimer.
12-- 2. Redistributions in binary form must reproduce the above copyright
13--    notice, this list of conditions and the following disclaimer in the
14--    documentation and/or other materials provided with the distribution.
15--
16-- THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19-- ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26-- SUCH DAMAGE.
27--
28-- $FreeBSD$
29--
30
31local core = require("core")
32local hook = require("hook")
33
34local color = {}
35
36local function recalcDisabled()
37	color.disabled = not color.isEnabled()
38end
39
40-- Module exports
41color.BLACK   = 0
42color.RED     = 1
43color.GREEN   = 2
44color.YELLOW  = 3
45color.BLUE    = 4
46color.MAGENTA = 5
47color.CYAN    = 6
48color.WHITE   = 7
49
50color.DEFAULT = 9
51color.BRIGHT  = 1
52color.DIM     = 2
53
54function color.isEnabled()
55	local c = loader.getenv("loader_color")
56	if c ~= nil then
57		return c:lower() ~= "no" and c ~= "0"
58	end
59	return true
60end
61
62function color.escapefg(color_value)
63	if color.disabled then
64		return ''
65	end
66	return core.KEYSTR_CSI .. "3" .. color_value .. "m"
67end
68
69function color.resetfg()
70	if color.disabled then
71		return ''
72	end
73	return color.escapefg(color.DEFAULT)
74end
75
76function color.escapebg(color_value)
77	if color.disabled then
78		return ''
79	end
80	return core.KEYSTR_CSI .. "4" .. color_value .. "m"
81end
82
83function color.resetbg()
84	if color.disabled then
85		return ''
86	end
87	return color.escapebg(color.DEFAULT)
88end
89
90function color.escape(fg_color, bg_color, attribute)
91	if color.disabled then
92		return ""
93	end
94	if attribute == nil then
95		attribute = ""
96	else
97		attribute = attribute .. ";"
98	end
99	return core.KEYSTR_CSI .. attribute ..
100	    "3" .. fg_color .. ";4" .. bg_color .. "m"
101end
102
103function color.default()
104	if color.disabled then
105		return ""
106	end
107	return color.escape(color.DEFAULT, color.DEFAULT)
108end
109
110function color.highlight(str)
111	if color.disabled then
112		return str
113	end
114	-- We need to reset attributes as well as color scheme here, just in
115	-- case the terminal defaults don't match what we're expecting.
116	return core.KEYSTR_CSI .. "1m" .. str .. core.KEYSTR_CSI .. "22m"
117end
118
119recalcDisabled()
120hook.register("config.loaded", recalcDisabled)
121
122return color
123