Backport main changes: 4d04102 to f6035eb

Author: KristofferC

docs/src/internals.md

@@ -25,6 +25,7 @@ StyledStrings.resetfaces!
 StyledStrings.termcolor
 StyledStrings.termcolor24bit
 StyledStrings.termcolor8bit
+StyledStrings.load_customisations!
 ```
 
 ## Styled Markup parsing

src/StyledStrings.jl

@@ -23,14 +23,35 @@ include("legacy.jl")
 
 using .StyledMarkup
 
-function __init__()
-    term_env = get(ENV, "TERM", @static Sys.iswindows() ? "" : "dumb")
-    global current_terminfo = load_terminfo(term_env)
+const HAVE_LOADED_CUSTOMISATIONS = Base.Threads.Atomic{Bool}(false)
+
+"""
+    load_customisations!(; force::Bool=false)
+
+Load customisations from the user's `faces.toml` file, if it exists as well as
+the current environment.
+
+This function should be called before producing any output in situations where
+the user's customisations should be considered.
+
+Unless `force` is set, customisations are only applied when this function is
+called for the first time, and subsequent calls are a no-op.
+"""
+function load_customisations!(; force::Bool=false)
+    !force && HAVE_LOADED_CUSTOMISATIONS[] && return
     if !isempty(DEPOT_PATH)
         userfaces = joinpath(first(DEPOT_PATH), "config", "faces.toml")
         isfile(userfaces) && loaduserfaces!(userfaces)
     end
     Legacy.load_env_colors!()
+    HAVE_LOADED_CUSTOMISATIONS[] = true
+    nothing
+end
+
+function __init__()
+    term_env = get(ENV, "TERM", @static Sys.iswindows() ? "" : "dumb")
+    global current_terminfo = load_terminfo(term_env)
+    load_customisations!()
 end
 
 if generating_output()

src/faces.jl

@@ -27,7 +27,15 @@ struct SimpleColor
 end
 
 SimpleColor(r::Integer, g::Integer, b::Integer) = SimpleColor((; r=UInt8(r), g=UInt8(g), b=UInt8(b)))
-SimpleColor(rgb::UInt32) = SimpleColor(reverse(reinterpret(UInt8, [rgb]))[2:end]...)
+
+function SimpleColor(rgb::UInt32)
+    b, g, r, _ = @static if VERSION >= v"1.10"
+        reinterpret(UInt8, [htol(rgb)])
+    else
+        reinterpret(UInt8, [htol(rgb)])
+    end
+    SimpleColor(r, g, b)
+end
 
 Base.convert(::Type{SimpleColor}, rgb::RGBTuple) = SimpleColor(rgb)
 Base.convert(::Type{SimpleColor}, namedcolor::Symbol) = SimpleColor(namedcolor)
@@ -477,7 +485,7 @@ function withfaces(f, keyvals_itr)
             FACES.current[][name] = face
         elseif face isa Symbol
             FACES.current[][name] =
-                something(get(old, face, nothing), get(FACES.current[], face, Face()))
+                something(get(old, face, nothing), get(Face, FACES.current[], face))
         elseif face isa Vector{Symbol}
             FACES.current[][name] = Face(inherit=face)
         elseif haskey(FACES.current[], name)
@@ -511,25 +519,30 @@ later faces taking priority.
 """
 function Base.merge(a::Face, b::Face)
     if isempty(b.inherit)
-        Face(ifelse(isnothing(b.font),          a.font,          b.font),
-             if isnothing(b.height)      a.height
-             elseif isnothing(a.height)  b.height
-             elseif b.height isa Int     b.height
-             elseif a.height isa Int     round(Int, a.height * b.height)
-             else a.height * b.height end,
-             ifelse(isnothing(b.weight),        a.weight,        b.weight),
-             ifelse(isnothing(b.slant),         a.slant,         b.slant),
-             ifelse(isnothing(b.foreground),    a.foreground,    b.foreground),
-             ifelse(isnothing(b.background),    a.background,    b.background),
-             ifelse(isnothing(b.underline),     a.underline,     b.underline),
-             ifelse(isnothing(b.strikethrough), a.strikethrough, b.strikethrough),
-             ifelse(isnothing(b.inverse),       a.inverse,       b.inverse),
+        # Extract the heights to help type inference a bit to be able
+        # to narrow the types in e.g. `aheight * bheight`
+        aheight = a.height
+        bheight = b.height
+        abheight = if isnothing(bheight) aheight
+        elseif isnothing(aheight) bheight
+        elseif bheight isa Int bheight
+        elseif aheight isa Int round(Int, aheight * bheight)
+        else aheight * bheight end
+        Face(if isnothing(b.font)          a.font          else b.font          end,
+             abheight,
+             if isnothing(b.weight)        a.weight        else b.weight        end,
+             if isnothing(b.slant)         a.slant         else b.slant         end,
+             if isnothing(b.foreground)    a.foreground    else b.foreground    end,
+             if isnothing(b.background)    a.background    else b.background    end,
+             if isnothing(b.underline)     a.underline     else b.underline     end,
+             if isnothing(b.strikethrough) a.strikethrough else b.strikethrough end,
+             if isnothing(b.inverse)       a.inverse       else b.inverse       end,
              a.inherit)
     else
         b_noinherit = Face(
             b.font, b.height, b.weight, b.slant, b.foreground, b.background,
             b.underline, b.strikethrough, b.inverse, Symbol[])
-        b_inheritance = map(fname -> get(FACES.current[], fname, Face()), Iterators.reverse(b.inherit))
+        b_inheritance = map(fname -> get(Face, FACES.current[], fname), Iterators.reverse(b.inherit))
         b_resolved = merge(foldl(merge, b_inheritance), b_noinherit)
         merge(a, b_resolved)
     end
@@ -539,6 +552,11 @@ Base.merge(a::Face, b::Face, others::Face...) = merge(merge(a, b), others...)
 
 ## Getting the combined face from a set of properties ##
 
+# Putting these inside `getface` causes the julia compiler to box it
+_mergedface(face::Face) = face
+_mergedface(face::Symbol) = get(Face, FACES.current[], face)
+_mergedface(faces::Vector) = mapfoldl(_mergedface, merge, Iterators.reverse(faces))
+
 """
     getface(faces)
 
@@ -547,10 +565,7 @@ Obtain the final merged face from `faces`, an iterator of
 """
 function getface(faces)
     isempty(faces) && return FACES.current[][:default]
-    mergedface(face::Face) = face
-    mergedface(face::Symbol) = get(FACES.current[], face, Face())
-    mergedface(faces::Vector) = mapfoldl(mergedface, merge, Iterators.reverse(faces))
-    combined = mapfoldl(mergedface, merge, faces)::Face
+    combined = mapfoldl(_mergedface, merge, faces)::Face
     if !isempty(combined.inherit)
         combined = merge(Face(), combined)
     end
@@ -568,7 +583,7 @@ function getface(annotations::Vector{Pair{Symbol, Any}})
 end
 
 getface(face::Face) = merge(FACES.current[][:default], merge(Face(), face))
-getface(face::Symbol) = getface(get(FACES.current[], face, Face()))
+getface(face::Symbol) = getface(get(Face, FACES.current[], face))
 
 """
     getface()

src/io.jl

@@ -32,18 +32,18 @@ const ANSI_4BIT_COLORS = Dict{Symbol, Int}(
 """
     ansi_4bit_color_code(color::Symbol, background::Bool=false)
 
-Provide the color code (30-37, 40-47, 90-97, 100-107) for `color`, as a string.
+Provide the color code (30-37, 40-47, 90-97, 100-107) for `color`, as an integer.
 When `background` is set the background variant will be provided, otherwise
 the provided code is for setting the foreground color.
 """
 function ansi_4bit_color_code(color::Symbol, background::Bool=false)
-    if haskey(ANSI_4BIT_COLORS, color)
-        code = ANSI_4BIT_COLORS[color]
+    code = get(ANSI_4BIT_COLORS, color, nothing)
+    if code !== nothing
         code >= 8 && (code += 52)
         background && (code += 10)
-        string(code + 30)
+        code + 30
     else
-        ifelse(background, "49", "39")
+        ifelse(background, 49, 39)
     end
 end
 
@@ -124,15 +124,17 @@ function termcolor(io::IO, color::SimpleColor, category::Char)
     elseif (fg = get(FACES.current[], color.value, getface()).foreground) != SimpleColor(color.value)
         termcolor(io, fg, category)
     else
-        print(io, "\e[",
-              if category == '3' || category == '4'
-                  ansi_4bit_color_code(color.value, category == '4')
-              elseif category == '5'
-                  if haskey(ANSI_4BIT_COLORS, color.value)
-                      string("58;5;", ANSI_4BIT_COLORS[color.value])
-                  else "59" end
-              end,
-              'm')
+        print(io, "\e[")
+        if category == '3' || category == '4'
+            print(io, ansi_4bit_color_code(color.value, category == '4'))
+        elseif category == '5'
+            if haskey(ANSI_4BIT_COLORS, color.value)
+                print(io, "58;5;", ANSI_4BIT_COLORS[color.value])
+            else
+                print(io, "59")
+            end
+         end
+         print(io, "m")
     end
 end
 

src/regioniterator.jl

@@ -78,7 +78,7 @@ function eachregion(s::SubString{<:AnnotatedString}, pos::UnitRange{Int}=firstin
 end
 
 """
-    annotation_events(string::AbstractString, annots::Vector{Tuple{UnitRange{Int64}, Pair{Symbol, Any}}}, subregion::UnitRange{Int})
+    annotation_events(string::AbstractString, annots::Vector{Tuple{UnitRange{Int}, Pair{Symbol, Any}}}, subregion::UnitRange{Int})
     annotation_events(string::AnnotatedString, subregion::UnitRange{Int})
 
 Find all annotation "change events" that occur within a `subregion` of `annots`,
@@ -89,7 +89,7 @@ index::Int}` where `pos` is the position of the event, `active` is a boolean
 indicating whether the annotation is being activated or deactivated, and `index`
 is the index of the annotation in question.
 """
-function annotation_events(s::AbstractString, annots::Vector{Tuple{UnitRange{Int64}, Pair{Symbol, Any}}}, subregion::UnitRange{Int})
+function annotation_events(s::AbstractString, annots::Vector{Tuple{UnitRange{Int}, Pair{Symbol, Any}}}, subregion::UnitRange{Int})
     events = Vector{NamedTuple{(:pos, :active, :index), Tuple{Int, Bool, Int}}}() # Position, Active?, Annotation index
     for (i, (region, _)) in enumerate(annots)
         if !isempty(intersect(subregion, region))

test/runtests.jl

@@ -516,11 +516,11 @@ end
 
 @testset "ANSI encoding" begin
     # 4-bit color
-    @test StyledStrings.ansi_4bit_color_code(:cyan, false) == "36"
-    @test StyledStrings.ansi_4bit_color_code(:cyan, true) == "46"
-    @test StyledStrings.ansi_4bit_color_code(:bright_cyan, false) == "96"
-    @test StyledStrings.ansi_4bit_color_code(:bright_cyan, true) == "106"
-    @test StyledStrings.ansi_4bit_color_code(:nonexistant) == "39"
+    @test StyledStrings.ansi_4bit_color_code(:cyan, false) == 36
+    @test StyledStrings.ansi_4bit_color_code(:cyan, true) == 46
+    @test StyledStrings.ansi_4bit_color_code(:bright_cyan, false) == 96
+    @test StyledStrings.ansi_4bit_color_code(:bright_cyan, true) == 106
+    @test StyledStrings.ansi_4bit_color_code(:nonexistant) == 39
     # 8-bit color
     @test sprint(StyledStrings.termcolor8bit, (r=0x40, g=0x63, b=0xd8), '3') == "\e[38;5;26m"
     @test sprint(StyledStrings.termcolor8bit, (r=0x38, g=0x98, b=0x26), '3') == "\e[38;5;28m"