Skip to content

Commit bf2ce26

Browse files
committed
Load the JULIA_*_COLOR env vars for compat
As we change more code to use the StyledStrings approach, it would be nice to try to maintain compatibility with old user customisations as much as possible.
1 parent 5536500 commit bf2ce26

File tree

3 files changed

+135
-0
lines changed

3 files changed

+135
-0
lines changed

src/StyledStrings.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ include("faces.jl")
1212
include("regioniterator.jl")
1313
include("io.jl")
1414
include("stylemacro.jl")
15+
include("legacy.jl")
1516

1617
function __init__()
1718
userfaces = joinpath(first(DEPOT_PATH), "config", "faces.toml")
1819
isfile(userfaces) && loaduserfaces!(userfaces)
20+
Legacy.load_env_colors!()
1921
end
2022

2123
if Base.generating_output()

src/legacy.jl

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# This file is a part of Julia. License is MIT: https://julialang.org/license
2+
3+
# StyledStrings provides a new way of handling colored output, however the
4+
# ~decade of colored printing in Julia before now has left us with a legacy,
5+
# and we should try to maintain compatibility as much as reasonable possible.
6+
7+
module Legacy
8+
9+
using ..StyledStrings: SimpleColor, Face, loadface!
10+
11+
"""
12+
A mapping from 256-color codes indicies to 8-bit colours.
13+
"""
14+
const ANSI_256_COLORS =
15+
map(SimpleColor,
16+
[0x000000, 0x800000, 0x008000, 0x808000, 0x000080, 0x800080, 0x008080,
17+
0xc0c0c0, 0x808080, 0xff0000, 0x00ff00, 0xffff00, 0x0000ff, 0xff00ff,
18+
0x00ffff, 0xffffff, 0x000000, 0x00005f, 0x000087, 0x0000af, 0x0000d7,
19+
0x0000ff, 0x005f00, 0x005f5f, 0x005f87, 0x005faf, 0x005fd7, 0x005fff,
20+
0x008700, 0x00875f, 0x008787, 0x0087af, 0x0087d7, 0x0087ff, 0x00af00,
21+
0x00af5f, 0x00af87, 0x00afaf, 0x00afd7, 0x00afff, 0x00d700, 0x00d75f,
22+
0x00d787, 0x00d7af, 0x00d7d7, 0x00d7ff, 0x00ff00, 0x00ff5f, 0x00ff87,
23+
0x00ffaf, 0x00ffd7, 0x00ffff, 0x5f0000, 0x5f005f, 0x5f0087, 0x5f00af,
24+
0x5f00d7, 0x5f00ff, 0x5f5f00, 0x5f5f5f, 0x5f5f87, 0x5f5faf, 0x5f5fd7,
25+
0x5f5fff, 0x5f8700, 0x5f875f, 0x5f8787, 0x5f87af, 0x5f87d7, 0x5f87ff,
26+
0x5faf00, 0x5faf5f, 0x5faf87, 0x5fafaf, 0x5fafd7, 0x5fafff, 0x5fd700,
27+
0x5fd75f, 0x5fd787, 0x5fd7af, 0x5fd7d7, 0x5fd7ff, 0x5fff00, 0x5fff5f,
28+
0x5fff87, 0x5fffaf, 0x5fffd7, 0x5fffff, 0x870000, 0x87005f, 0x870087,
29+
0x8700af, 0x8700d7, 0x8700ff, 0x875f00, 0x875f5f, 0x875f87, 0x875faf,
30+
0x875fd7, 0x875fff, 0x878700, 0x87875f, 0x878787, 0x8787af, 0x8787d7,
31+
0x8787ff, 0x87af00, 0x87af5f, 0x87af87, 0x87afaf, 0x87afd7, 0x87afff,
32+
0x87d700, 0x87d75f, 0x87d787, 0x87d7af, 0x87d7d7, 0x87d7ff, 0x87ff00,
33+
0x87ff5f, 0x87ff87, 0x87ffaf, 0x87ffd7, 0x87ffff, 0xaf0000, 0xaf005f,
34+
0xaf0087, 0xaf00af, 0xaf00d7, 0xaf00ff, 0xaf5f00, 0xaf5f5f, 0xaf5f87,
35+
0xaf5faf, 0xaf5fd7, 0xaf5fff, 0xaf8700, 0xaf875f, 0xaf8787, 0xaf87af,
36+
0xaf87d7, 0xaf87ff, 0xafaf00, 0xafaf5f, 0xafaf87, 0xafafaf, 0xafafd7,
37+
0xafafff, 0xafd700, 0xafd75f, 0xafd787, 0xafd7af, 0xafd7d7, 0xafd7ff,
38+
0xafff00, 0xafff5f, 0xafff87, 0xafffaf, 0xafffd7, 0xafffff, 0xd70000,
39+
0xd7005f, 0xd70087, 0xd700af, 0xd700d7, 0xd700ff, 0xd75f00, 0xd75f5f,
40+
0xd75f87, 0xd75faf, 0xd75fd7, 0xd75fff, 0xd78700, 0xd7875f, 0xd78787,
41+
0xd787af, 0xd787d7, 0xd787ff, 0xd7af00, 0xd7af5f, 0xd7af87, 0xd7afaf,
42+
0xd7afd7, 0xd7afff, 0xd7d700, 0xd7d75f, 0xd7d787, 0xd7d7af, 0xd7d7d7,
43+
0xd7d7ff, 0xd7ff00, 0xd7ff5f, 0xd7ff87, 0xd7ffaf, 0xd7ffd7, 0xd7ffff,
44+
0xff0000, 0xff005f, 0xff0087, 0xff00af, 0xff00d7, 0xff00ff, 0xff5f00,
45+
0xff5f5f, 0xff5f87, 0xff5faf, 0xff5fd7, 0xff5fff, 0xff8700, 0xff875f,
46+
0xff8787, 0xff87af, 0xff87d7, 0xff87ff, 0xffaf00, 0xffaf5f, 0xffaf87,
47+
0xffafaf, 0xffafd7, 0xffafff, 0xffd700, 0xffd75f, 0xffd787, 0xffd7af,
48+
0xffd7d7, 0xffd7ff, 0xffff00, 0xffff5f, 0xffff87, 0xffffaf, 0xffffd7,
49+
0xffffff, 0x080808, 0x121212, 0x1c1c1c, 0x262626, 0x303030, 0x3a3a3a,
50+
0x444444, 0x4e4e4e, 0x585858, 0x626262, 0x6c6c6c, 0x767676, 0x808080,
51+
0x8a8a8a, 0x949494, 0x9e9e9e, 0xa8a8a8, 0xb2b2b2, 0xbcbcbc, 0xc6c6c6,
52+
0xd0d0d0, 0xdadada, 0xe4e4e4, 0xeeeeee])
53+
54+
"""
55+
A mapping from old named colours to the new names, specifically from `light_*`
56+
to `bright_*`.
57+
"""
58+
const RENAMED_COLORS = Dict{Symbol, Symbol}(
59+
:light_black => :bright_black,
60+
:light_red => :bright_red,
61+
:light_green => :bright_green,
62+
:light_yellow => :bright_yellow,
63+
:light_blue => :bright_blue,
64+
:light_magenta => :bright_magenta,
65+
:light_cyan => :bright_cyan,
66+
:light_white => :bright_white)
67+
68+
legacy_color(color::Symbol) = SimpleColor(get(RENAMED_COLORS, color, color))
69+
legacy_color(color256::Int) = get(ANSI_256_COLORS, color256+1, nothing)
70+
71+
"""
72+
legacy_color(color::Union{String, Symbol, Int})
73+
74+
Attempt to obtain a `SimpleColor` for a "legacy" color value `color`.
75+
76+
When this is not possible, `nothing` is returned.
77+
"""
78+
function legacy_color(color::String)
79+
namedcolours = ("black", "red", "green", "yellow", "blue", "magenta",
80+
"cyan", "white", "bright_black", "grey", "gray",
81+
"bright_red", "bright_green", "bright_yellow",
82+
"bright_blue", "bright_magenta", "bright_cyan",
83+
"bright_white", "light_black", "light_red", "light_green",
84+
"light_yellow", "light_blue", "light_magenta", "light_cyan",
85+
"light_white")
86+
if color in namedcolours
87+
legacy_color(Symbol(color))
88+
elseif 0 <= (color256 = something(tryparse(Int, color), -1)) <= 255
89+
legacy_color(color256)
90+
else
91+
nothing
92+
end
93+
end
94+
95+
"""
96+
load_env_colors!()
97+
98+
Try to emulate the effect of the various `*_color()` functions of `Base`, by
99+
loading any specified colours as foregrounds of the relevant faces.
100+
"""
101+
function load_env_colors!()
102+
for (fname, envkey) in ((:error, "JULIA_ERROR_COLOR"),
103+
(:warn, "JULIA_WARN_COLOR"),
104+
(:info, "JULIA_INFO_COLOR"),
105+
(:log_debug, "JULIA_DEBUG_COLOR"))
106+
if haskey(ENV, envkey)
107+
ecolor = legacy_color(ENV[envkey])
108+
if !isnothing(ecolor)
109+
loadface!(fname => Face(foreground = ecolor))
110+
end
111+
end
112+
end
113+
end
114+
115+
end

test/runtests.jl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,3 +207,21 @@ end
207207
@macroexpand styled"{(foreground=$color):val}"
208208
end
209209
end
210+
211+
@testset "Legacy" begin
212+
@test StyledStrings.Legacy.legacy_color(:blue) == SimpleColor(:blue)
213+
@test StyledStrings.Legacy.legacy_color(:light_blue) == SimpleColor(:bright_blue)
214+
@test StyledStrings.Legacy.legacy_color(-1) === nothing
215+
@test StyledStrings.Legacy.legacy_color(0) == SimpleColor(0x000000)
216+
@test StyledStrings.Legacy.legacy_color(44) == SimpleColor(0x00d7d7)
217+
@test StyledStrings.Legacy.legacy_color(255) == SimpleColor(0xeeeeee)
218+
@test StyledStrings.Legacy.legacy_color(256) === nothing
219+
@test StyledStrings.Legacy.legacy_color("blue") == SimpleColor(:blue)
220+
@test StyledStrings.Legacy.legacy_color("light_blue") == SimpleColor(:bright_blue)
221+
@test StyledStrings.Legacy.legacy_color("-1") === nothing
222+
@test StyledStrings.Legacy.legacy_color("0") == SimpleColor(0x000000)
223+
@test StyledStrings.Legacy.legacy_color("44") == SimpleColor(0x00d7d7)
224+
@test StyledStrings.Legacy.legacy_color("255") == SimpleColor(0xeeeeee)
225+
@test StyledStrings.Legacy.legacy_color("256") === nothing
226+
@test StyledStrings.Legacy.legacy_color("invalid") === nothing
227+
end

0 commit comments

Comments
 (0)