Merge pull request #58 from Kolaru/compat_with_makie

Setup to fix compat issue with Makie

Author: Kolaru

.gitignore

@@ -0,0 +1 @@
+Manifest.toml

Project.toml

@@ -1,7 +1,7 @@
 name = "MathTeXEngine"
 uuid = "0a4f8689-d25c-4efe-a92b-7142dfc1aa53"
 authors = ["Benoît Richard <kolaru@hotmail.com>"]
-version = "0.3.3"
+version = "0.4.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
@@ -19,7 +19,7 @@ AbstractTrees = "0.3"
 Automa = "0.8"
 DataStructures = "0.18"
 FreeTypeAbstraction = "0.9"
-GeometryBasics = "0.4.1"
+GeometryBasics = "0.4.1, 0.4.2"
 LaTeXStrings = "1.2"
-RelocatableFolders = "0.1"
+RelocatableFolders = "0.1, 0.2"
 julia = "1.3"

prototype/Project.toml

@@ -0,0 +1,8 @@
+[deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+MakieCore = "20f20a25-4f0e-4fdf-b5d1-57303727442b"
+MathTeXEngine = "0a4f8689-d25c-4efe-a92b-7142dfc1aa53"

src/prototype.jl prototype/prototype.jlsrc/prototype.jl renamed to prototype/prototype.jl

@@ -1,21 +1,29 @@
+using Pkg
+
+Pkg.activate("prototype")
+
 using MathTeXEngine
 using CairoMakie
 using Colors
 using GeometryBasics
 using LaTeXStrings
 
 import MathTeXEngine: TeXChar, VLine, HLine, leftinkbound, descender, inkwidth,
-    topinkbound, advance, bottominkbound, rightinkbound, ascender
+    topinkbound, hadvance, bottominkbound, rightinkbound, ascender,
+    height_insensitive_boundingbox
 
 draw_texelement!(args... ; size=64) = nothing
 
 function draw_texelement!(ax, texchar::TeXChar, position, scale ; size=64)
-    x = (position[1] + leftinkbound(texchar)) * size
-    y = (position[2] + descender(texchar.font) * scale) * size
+    x = position[1] * size
+    y = position[2] * size
     text!(ax, string(texchar.char), font=texchar.font,
         position=Point2f(x, y),
         textsize=size*scale,
-        space=:data)
+        space=:data,
+        markerspace=:data,
+        align=(:left, :baseline),
+        offset=(0, 0))
 end
 
 function draw_texelement!(ax, line::VLine, position, scale ; size=64)
@@ -25,7 +33,7 @@ function draw_texelement!(ax, line::VLine, position, scale ; size=64)
     x1 = xmid + lw
     y1 = y0 + line.height * scale
     points = Point2f[(x0, y0), (x0, y1), (x1, y1), (x1, y0)]
-    poly!(ax, points .* size, color=:black, shading=false, linewidth=0)
+    poly!(ax, points .* size, color=:black, shading=false)
 end
 
 function draw_texelement!(ax, line::HLine, position, scale ; size=64)
@@ -35,7 +43,7 @@ function draw_texelement!(ax, line::HLine, position, scale ; size=64)
     y0 = ymid - lw
     y1 = ymid + lw
     points = Point2f[(x0, y0), (x0, y1), (x1, y1), (x1, y0)]
-    mesh!(ax, points .* size, color=:black, shading=false)
+    poly!(ax, points .* size, color=:black, shading=false)
 end
 
 draw_texelement_helpers!(args... ; size=64) = nothing
@@ -47,17 +55,21 @@ function draw_texelement_helpers!(ax, texchar::TeXChar, position, scale ; size=6
     # their position is relative to the baseline, so we need to offset them
     y = position[2] * size
     w = inkwidth(texchar) * size * scale
-    a = advance(texchar) * size * scale
+    a = hadvance(texchar) * size * scale
     top = topinkbound(texchar) * size * scale
     bottom = bottominkbound(texchar) * size * scale
     left = leftinkbound(texchar) * size * scale
     right = rightinkbound(texchar) * size * scale
 
-    asc = ascender(texchar) * size * scale
-    desc = descender(texchar) * size * scale
+    hbbox = height_insensitive_boundingbox(texchar, nothing)
+    asc = (origin(hbbox)[2] + widths(hbbox)[2]) * size * scale
+    desc = origin(hbbox)[2] * size * scale
+
+    # asc = ascender(texchar) * size * scale
+    # desc = descender(texchar) * size * scale
 
     # The space between th origin and the left ink bound
-    mesh!(ax,
+    poly!(ax,
         Point2f[
             (x, y + bottom),
             (x + left, y + bottom),
@@ -69,7 +81,7 @@ function draw_texelement_helpers!(ax, texchar::TeXChar, position, scale ; size=6
     )
 
     # The advance after the right inkbound
-    mesh!(ax,
+    poly!(ax,
         Point2f[
             (x + right, y + bottom),
             (x + a, y + bottom),
@@ -81,7 +93,7 @@ function draw_texelement_helpers!(ax, texchar::TeXChar, position, scale ; size=6
     )
 
     # The descender
-    mesh!(ax,
+    poly!(ax,
         Point2f[
             (x + left, y),
             (x + right, y),
@@ -93,7 +105,7 @@ function draw_texelement_helpers!(ax, texchar::TeXChar, position, scale ; size=6
     )
 
     # The inkbound above the baseline
-    mesh!(ax,
+    poly!(ax,
         Point2f[
             (x + left, y),
             (x + right, y),
@@ -134,13 +146,14 @@ function makie_tex!(
 end
 
 begin  # Quick test
-    fig = Figure(resolution=(1800, 600))
+    fig = Figure(resolution=(1800, 1000))
     fig[1, 1] = Label(fig, "LaTeX in Makie.jl", tellwidth=false, textsize=64)
     ax = Axis(fig[2, 1])
+    hidedecorations!(ax)
     ax.aspect = DataAspect()
-    tex = L"\lim_{L →\infty} \gamma A^\sqrt{2 + 3 + 2} z^2 = \sum_{k = 1}^N \vec{v}_{(a + \bar{a})_k} + \sqrt{j} x! \quad \mathrm{when} \quad \sqrt{\frac{\Omega-2}{4+a+x}} < \int_{0}^{2π} |\sin(\mu x)| dx"
+    tex = L"\sum \lim_{L →\infty} \gamma A^\sqrt{A + j + 2 + 3 + 2 + L} z^2 = \sum_{k = 1}^N \vec{v}_{(a + \bar{a})_k} + \sqrt{j} x! \quad \mathrm{when} \quad \sqrt{\frac{\Omega-2}{4+a+x}} < \int_{0}^{2π} |\sin(\mu x)| dx"
 
-    makie_tex!(ax, tex, debug=true, size=300)
-    makie_tex!(ax, L"\sum x_k y_k", debug=true, size=300, position=(0, -5))
+    makie_tex!(ax, tex, debug=true, size=64)
+    fig[3, 1] = Label(fig, tex, tellwidth=false, tellheight=false, textsize=40)
     fig
 end

src/MathTeXEngine.jl

@@ -7,14 +7,16 @@ using Automa
 using FreeTypeAbstraction
 using LaTeXStrings
 
-import Automa.RegExp: @re_str
-import DataStructures: Stack
+using Automa.RegExp: @re_str
+using DataStructures: Stack
+using GeometryBasics: Point2f, Rect2f
+using REPL.REPLCompletions: latex_symbols
+using RelocatableFolders
+
 import FreeTypeAbstraction:
     ascender, boundingbox, descender, get_extent, hadvance, inkheight, inkwidth,
-    leftinkbound, rightinkbound, topinkbound, bottominkbound
-import GeometryBasics: Point2f
-import REPL.REPLCompletions: latex_symbols
-import RelocatableFolders
+    height_insensitive_boundingbox, leftinkbound, rightinkbound,
+    topinkbound, bottominkbound
 
 const re = Automa.RegExp
 

src/engine/fonts.jl

@@ -71,14 +71,16 @@ struct FontFamily
     font_modifiers::Dict{Symbol, Dict{Symbol, Symbol}}
     special_chars::Dict{Char, Tuple{String, Char}}
     slant_angle::Float64
+    thickness::Float64
 end
 
 FontFamily(fonts) = FontFamily(
     fonts,
     _default_font_mapping,
     _default_font_modifiers,
     _symbol_to_computer_modern,
-    15)
+    15,
+    0.0375)
 FontFamily() = FontFamily(_default_fonts)
 
 """
@@ -109,19 +111,12 @@ end
 slant_angle(font_family) = font_family.slant_angle * π / 180
 
 # Few helper functions
-"""
-    thickness(font::FTFont)
-
-The thickness of the underline for the given font.
-"""
-thickness(font::FTFont) = font.underline_thickness / font.units_per_EM
-
 """
     thickness(font::FontFamily)
 
 The thickness of the underline for the given font set.
 """
-thickness(font_family::FontFamily) = thickness(get_font(font_family, :regular))
+thickness(font_family::FontFamily) = font_family.thickness
 
 """
     xheight(font::FTFont)

src/engine/layout.jl

@@ -50,7 +50,7 @@ function tex_layout(expr, state)
         elseif head == :decorated
             core, sub, super = tex_layout.(args, state)
 
-            core_width = advance(core)
+            core_width = hadvance(core)
 
             return Group(
                 [core, sub, super],
@@ -69,7 +69,7 @@ function tex_layout(expr, state)
             right_scale = max(1, height / inkheight(right))
             scales = [left_scale, 1, right_scale]
 
-            dxs = advance.(elements) .* scales
+            dxs = hadvance.(elements) .* scales
             xs = [0, cumsum(dxs[1:end-1])...]
 
             # TODO Height calculation for the parenthesis looks wrong
@@ -177,7 +177,7 @@ function tex_layout(expr, state)
                 [sqrt, hline, content, Space(1.2)],
                 Point2f[
                     (0, y0),
-                    (rightinkbound(sqrt) - lw/2, y - lw/2),
+                    (rightinkbound(sqrt) - lw/2, y + lw/2),
                     (rightinkbound(sqrt), 0),
                     (rightinkbound(content), 0)
                 ]
@@ -231,7 +231,7 @@ tex_layout(::Nothing, state) = Space(0)
 Layout the elements horizontally, like normal text.
 """
 function horizontal_layout(elements)
-    dxs = advance.(elements)
+    dxs = hadvance.(elements)
     xs = [0, cumsum(dxs[1:end-1])...]
 
     return Group(elements, Point2f.(xs, 0))

src/engine/texelements.jl

@@ -40,12 +40,12 @@ Return the position of the highest position the ink of the element uses.
 function topinkbound end
 
 """
-    advance(elem::TeXElement)
+    hadvance(elem::TeXElement)
 
 Return the horizontal distance between the origin of the element and the origin of the
 next element to be drawn, without kerning.
 """
-advance(x::TeXElement) = inkwidth(x)
+hadvance(x::TeXElement) = inkwidth(x)
 
 """
     ascender(elem::TeXElement)
@@ -112,6 +112,13 @@ inkheight(x::TeXElement) = topinkbound(x) - bottominkbound(x)
 
 A MathTeX character with an associated font.
 
+TeXChar implement all functions defined for FreeTypeAbstraction.FontExtents
+and can be used instead to get all geometric information about the
+character.
+
+This is especially useful since for fonts that require some adjustement for the
+proper positioning of math symbols.
+
 Fields
 ======
     - char::Char The code point of the glyph representing the char.
@@ -143,13 +150,14 @@ function TeXChar(char, state::LayoutState, char_type)
         char)
 end
 
-TeXChar(char::Char, font::FTFont) = TeXChar(char, font, false, char)
+TeXChar(char::Char, font::FTFont) =
+    TeXChar(char, font, false, char)
 
 for inkfunc in (:leftinkbound, :rightinkbound, :bottominkbound, :topinkbound)
     @eval $inkfunc(char::TeXChar) = $inkfunc(get_extent(char.font, char.char))
 end
 
-advance(char::TeXChar) = hadvance(get_extent(char.font, char.char))
+hadvance(char::TeXChar) = hadvance(get_extent(char.font, char.char))
 xheight(char::TeXChar) = xheight(char.font)
 
 function ascender(char::TeXChar)
@@ -180,6 +188,13 @@ function descender(char::TeXChar)
     return descender(char.font)
 end
 
+function FreeTypeAbstraction.height_insensitive_boundingbox(char::TeXChar, font)
+    return Rect2f(
+        leftinkbound(char), descender(char),
+        inkwidth(char), ascender(char) - descender(char)
+    )
+end
+
 Base.show(io::IO, tc::TeXChar) =
     print(io, "TeXChar '$(tc.represented_char)' [U+$(uppercase(string(codepoint(tc.char), base=16, pad=4))) in $(tc.font.family_name) - $(tc.font.style_name)]")
 
@@ -290,8 +305,8 @@ function topinkbound(g::Group)
     return maximum(tops)
 end
 
-function advance(g::Group)
-    adv = xpositions(g) .+ advance.(g.elements) .* g.scales
+function hadvance(g::Group)
+    adv = xpositions(g) .+ hadvance.(g.elements) .* g.scales
     return maximum(adv)
 end
 

src/parser/commands_data.jl

@@ -25,7 +25,7 @@ relation_commands = split(raw"""
     \preceq     \succeq     \simeq   \mid
     \ll         \gg         \asymp   \parallel
     \subset     \supset     \approx  \bowtie
-    \subseteq   \supseteq   \cong    \Join
+    \subseteq   \supseteq   \cong    \join
     \sqsubset   \sqsupset   \neq     \smile
     \sqsubseteq \sqsupseteq \doteq   \frown
     \in         \ni         \propto  \vdash