weak deps

Author: t-bltg

.github/workflows/format-check.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install JuliaFormatter and format
         run: |
           julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
-          julia -e 'using JuliaFormatter; format(["src", "test"], verbose=true)'
+          julia -e 'using JuliaFormatter; format(["src", "ext", "test"], verbose=true)'
       - name: Format check
         run: |
           julia -e '

Project.toml

@@ -12,7 +12,6 @@ Contour = "d38c429a-6771-53c6-b99e-75d170b6e991"
 Crayons = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
-FreeType = "b38be410-82b0-50bf-ab77-7b57e271db43"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MarchingCubes = "299715c1-40a9-479a-aaf9-4a633d36f717"
 NaNMath = "77ba4419-2d1f-58cd-9bb1-8ffee604a2e3"
@@ -40,9 +39,18 @@ StatsBase = "0.33"
 Unitful = "1"
 julia = "1.6"
 
+[weakdeps]
+FreeType = "b38be410-82b0-50bf-ab77-7b57e271db43"
+ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254"
+
+[extensions]
+FreeTypeExt = "FreeType"
+ImageInTerminalExt = "ImageInTerminal"
+
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+FreeType = "b38be410-82b0-50bf-ab77-7b57e271db43"
 ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
@@ -53,4 +61,4 @@ TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
 TimerOutputs = "a759f4b9-e2f1-59dc-863e-4aeb61b1ea8f"
 
 [targets]
-test = ["Aqua", "DataFrames", "ImageInTerminal", "ImageMagick", "Random", "ReferenceTests", "StableRNGs", "Test", "TestImages", "TimerOutputs"]
+test = ["Aqua", "DataFrames", "FreeType", "ImageInTerminal", "ImageMagick", "Random", "ReferenceTests", "StableRNGs", "Test", "TestImages", "TimerOutputs"]

src/freetype.jl renamed to ext/FreeTypeExt.jl

@@ -1,13 +1,12 @@
 # adapted from github.com/JuliaGraphics/FreeTypeAbstraction.jl/blob/master/src/rendering.jl
 # credits to the `FreeTypeAbstraction` authors
 
-module FreeTypeRendering
+module FreeTypeExt
 
-using ..StaticArrays
-using ..ColorTypes
-using FreeType
-
-export get_font_face, render_string!
+import UnicodePlots
+isdefined(Base, :get_extension) ? (using FreeType) : (using ..FreeType)    
+using StaticArrays
+using ColorTypes
 
 const REGULAR_STYLES = "regular", "normal", "medium", "standard", "roman", "book"
 const FT_LIB = FT_Library[C_NULL]
@@ -85,7 +84,7 @@ fallback_fonts() =
 
 const FT_FONTS = Dict{String,FTFont}()
 
-function get_font_face(font = nothing, fallback = fallback_fonts())
+function UnicodePlots.get_font_face(font = nothing, fallback = fallback_fonts())
     face = nothing
     for name ∈ filter(!isnothing, (font, "JuliaMono", fallback...))
         if (face = get(FT_FONTS, name, nothing)) ≡ nothing
@@ -287,7 +286,7 @@ Uses the conventions of freetype.org/freetype2/docs/glyphs/glyphs-3.html
 * `gstr`: background string or array of chars (for background sizing)
 * `incx`: extra x spacing
 """
-function render_string!(
+function UnicodePlots.render_string!(
     img::AbstractMatrix{T},
     fstr::Union{AbstractVector{Char},String},
     face::FTFont,

ext/ImageInTerminalExt.jl

@@ -0,0 +1,24 @@
+module ImageInTerminalExt
+
+import UnicodePlots
+isdefined(Base, :get_extension) ? (import ImageInTerminal) : (import ..ImageInTerminal)    
+using ColorTypes
+
+UnicodePlots.sixel_encode(args...; kw...) = ImageInTerminal.sixel_encode(args...; kw...)
+UnicodePlots.imshow(args...; kw...) = ImageInTerminal.imshow(args...; kw...)
+
+function UnicodePlots.terminal_specs(img)
+    if ImageInTerminal.choose_sixel(img)
+        ans = ImageInTerminal.Sixel.TerminalTools.query_terminal("\e[16t", stdout)
+        if ans isa String && (m = match(r"\e\[6;(\d+);(\d+)t", ans)) ≢ nothing
+            char_h, char_w = tryparse.(Int, m.captures)
+            return char_h ≢ nothing && char_w ≢ nothing, char_h, char_w
+        end
+    end
+    false, nothing, nothing
+end
+
+UnicodePlots.imageplot(img::AbstractArray{<:Colorant}; kw...) =
+    UnicodePlots.Plot(UnicodePlots.ImageGraphics(img); border = :corners, kw...)
+
+end

src/UnicodePlots.jl

@@ -95,8 +95,6 @@ include("canvas/heatmapcanvas.jl")
 include("description.jl")
 include("volume.jl")
 
-include("freetype.jl")
-using .FreeTypeRendering
 include("plot.jl")
 include("show.jl")
 
@@ -115,6 +113,8 @@ include("interface/boxplot.jl")
 include("interface/polarplot.jl")
 include("interface/imageplot.jl")
 
+isdefined(Base, :get_extension) || import Requires
+
 function __init__()
     if (terminal_24bit() || forced_24bit()) && !forced_8bit()
         truecolors!()
@@ -123,9 +123,13 @@ function __init__()
         colors256!()
         faintcolors!()
     end
-    Requires.@require ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254" begin
-        imageplot(img::AbstractArray{<:Colorant}; kw...) =
-            Plot(ImageGraphics(img); border = :corners, kw...)
+    @static if !isdefined(Base, :get_extension)
+        Requires.@require ImageInTerminal = "d8c32880-2388-543b-8c61-d9f865259254" include(
+            "../ext/ImageInTerminalExt.jl",
+        )
+        Requires.@require FreeType = "b38be410-82b0-50bf-ab77-7b57e271db43" include(
+            "../ext/FreeTypeExt.jl",
+        )
     end
     nothing
 end

src/graphics/imagegraphics.jl

@@ -24,19 +24,14 @@ end
 @inline nrows(c::ImageGraphics) = first(c.encoded_size)
 @inline ncols(c::ImageGraphics) = last(c.encoded_size)
 
+# `ImageInTerminalExt` placeholders
+function terminal_specs end
+function sixel_encode end
+function imshow end
+
 function preprocess!(io::IO, c::ImageGraphics)
     ctx = IOContext(PipeBuffer(), :displaysize => displaysize(io))
-    c.sixel[] = false
-    char_h = char_w = nothing  # determine the terminal caret size, in pixels
-    # COV_EXCL_START
-    if ImageInTerminal.choose_sixel(c.img)
-        ans = ImageInTerminal.Sixel.TerminalTools.query_terminal("\e[16t", stdout)
-        if ans isa String && (m = match(r"\e\[6;(\d+);(\d+)t", ans)) ≢ nothing
-            char_h, char_w = tryparse.(Int, m.captures)
-            c.sixel[] = char_h ≢ nothing && char_w ≢ nothing
-        end
-    end
-    # COV_EXCL_STOP
+    c.sixel[], char_h, char_w = terminal_specs(c.img)
     postprocess = c -> begin
         c.encoded_size .= (0, 0)
         empty!(c.chars)
@@ -49,7 +44,7 @@ function preprocess!(io::IO, c::ImageGraphics)
         # COV_EXCL_START
         # it is better to encode the whole image in a single pass
         # otherwise, issues with the last line (see previous implementation)
-        ImageInTerminal.sixel_encode(ctx, c.img)
+        sixel_encode(ctx, c.img)
         push!(c.chars, read(ctx, String) |> collect)
         length(1:char_h:img_h), ceil(Int, img_w / char_w)
         # COV_EXCL_STOP
@@ -69,7 +64,7 @@ function preprocess!(io::IO, c::ImageGraphics)
             end
             nothing
         end
-        ImageInTerminal.imshow(ctx, c.img; callback)
+        imshow(ctx, c.img; callback)
         length(c.chars), length(c.chars |> first)
     end
     postprocess

src/show.jl

@@ -398,6 +398,10 @@ function _show(end_io::IO, print_nocol, print_color, p::Plot)
     )
 end
 
+# `FreeTypeExt` placeholders
+function get_font_face end
+function render_string! end
+
 """
     png_image(p::Plot, font = nothing, pixelsize = 32, transparent = true, foreground = nothing, background = nothing, bounding_box = nothing, bounding_box_glyph = nothing)
 

test/runtests.jl

@@ -1,4 +1,4 @@
-using ImageInTerminal
+using ImageInTerminal, FreeType
 using UnicodePlots, Test
 
 import UnicodePlots: lines!, points!, pixel!, nrows, ncols