Skip to content

More consistent legacy color conversion #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 11, 2024
Merged

More consistent legacy color conversion #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/internals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ StyledStrings.ANSI_4BIT_COLORS
StyledStrings.FACES
StyledStrings.HTML_BASIC_COLORS
StyledStrings.Legacy.ANSI_256_COLORS
StyledStrings.Legacy.NAMED_COLORS
StyledStrings.Legacy.RENAMED_COLORS
StyledStrings.Legacy.legacy_color
StyledStrings.Legacy.load_env_colors!
Expand Down
43 changes: 27 additions & 16 deletions src/legacy.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ module Legacy

using ..StyledStrings: SimpleColor, Face, loadface!, face!

"""
legacy_color(color::Union{String, Symbol, Int})

Attempt to obtain a `SimpleColor` for a "legacy" color value `color`.

When this is not possible, `nothing` is returned.
"""
function legacy_color end

"""
A mapping from 256-color codes indicies to 8-bit colours.
"""
Expand Down Expand Up @@ -51,6 +60,19 @@ const ANSI_256_COLORS =
0x8a8a8a, 0x949494, 0x9e9e9e, 0xa8a8a8, 0xb2b2b2, 0xbcbcbc, 0xc6c6c6,
0xd0d0d0, 0xdadada, 0xe4e4e4, 0xeeeeee])

legacy_color(color256::Int) = get(ANSI_256_COLORS, color256+1, nothing)

"""
A list of all named colors recognised, including both the old `light_*` and new
`bright_*` named colors.
"""
const NAMED_COLORS =
(:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white,
:bright_black, :grey, :gray, :bright_red, :bright_green, :bright_yellow,
:bright_blue, :bright_magenta, :bright_cyan, :bright_white, :light_black,
:light_red, :light_green, :light_yellow, :light_blue, :light_magenta,
:light_cyan, :light_white)

"""
A mapping from old named colours to the new names, specifically from `light_*`
to `bright_*`.
Expand All @@ -65,24 +87,13 @@ const RENAMED_COLORS = Dict{Symbol, Symbol}(
:light_cyan => :bright_cyan,
:light_white => :bright_white)

legacy_color(color::Symbol) = SimpleColor(get(RENAMED_COLORS, color, color))
legacy_color(color256::Int) = get(ANSI_256_COLORS, color256+1, nothing)

"""
legacy_color(color::Union{String, Symbol, Int})

Attempt to obtain a `SimpleColor` for a "legacy" color value `color`.
legacy_color(color::Symbol) =
if color in NAMED_COLORS
SimpleColor(get(RENAMED_COLORS, color, color))
end

When this is not possible, `nothing` is returned.
"""
function legacy_color(color::String)
namedcolours = ("black", "red", "green", "yellow", "blue", "magenta",
"cyan", "white", "bright_black", "grey", "gray",
"bright_red", "bright_green", "bright_yellow",
"bright_blue", "bright_magenta", "bright_cyan",
"bright_white", "light_black", "light_red", "light_green",
"light_yellow", "light_blue", "light_magenta", "light_cyan",
"light_white")
namedcolours = String.(NAMED_COLORS)
if color in namedcolours
legacy_color(Symbol(color))
elseif 0 <= (color256 = something(tryparse(Int, color), -1)) <= 255
Expand Down