Fix LaTeX completions of Greek variants, add \frakI and \frakR (#39148)

* Fix LaTeX completions of Greek variants, add \frakI and \frakR

* Remove \Join completion

It is redundant with \join

* Add canonical symbol->LaTeX mapping for ambiguous cases

A test checks that all ambiguous cases are handled.

* Replace \dots suggestion with \ldots

Author: knuesel

stdlib/REPL/src/docview.jl

@@ -334,7 +334,11 @@ function symbol_latex(s::String)
                                         REPLCompletions.emoji_symbols))
             symbols_latex[v] = k
         end
+
+        # Overwrite with canonical mapping when a symbol has several completions (#39148)
+        merge!(symbols_latex, REPLCompletions.symbols_latex_canonical)
     end
+
     return get(symbols_latex, s, "")
 end
 function repl_latex(io::IO, s::String)

stdlib/REPL/src/latex_symbols.jl

@@ -76,6 +76,10 @@ end
 # Finally, we also add some symbols manually (at the top) as needed,
 # and edited others for consistency (e.g. #21646 and #14751).
 
+# When a symbol has several completions, a canonical reverse mapping is
+# specified at the bottom of this file. The complete reverse mapping is
+# generated lazily in docview.jl.
+
 # "font" prefixes
 const bold = "\\bf"
 const italic = "\\it"
@@ -182,7 +186,7 @@ const latex_symbols = Dict(
     "\\^iota" => "ᶥ",
     "\\^phi" => "ᵠ",
     "\\^chi" => "ᵡ",
-    "\\^Phi" => "ᶲ",
+    "\\^ltphi" => "ᶲ",
     "\\^uparrow" => "ꜛ",
     "\\^downarrow" => "ꜜ",
     "\\^!" => "ꜝ",
@@ -1827,6 +1831,7 @@ const latex_symbols = Dict(
     frak*"E" => "𝔈",  # mathematical fraktur capital e
     frak*"F" => "𝔉",  # mathematical fraktur capital f
     frak*"G" => "𝔊",  # mathematical fraktur capital g
+    frak*"I" => "ℑ",  # black-letter capital i (manual addition)
     frak*"J" => "𝔍",  # mathematical fraktur capital j
     frak*"K" => "𝔎",  # mathematical fraktur capital k
     frak*"L" => "𝔏",  # mathematical fraktur capital l
@@ -1835,6 +1840,7 @@ const latex_symbols = Dict(
     frak*"O" => "𝔒",  # mathematical fraktur capital o
     frak*"P" => "𝔓",  # mathematical fraktur capital p
     frak*"Q" => "𝔔",  # mathematical fraktur capital q
+    frak*"R" => "ℜ",  # black-letter capital r (manual addition)
     frak*"S" => "𝔖",  # mathematical fraktur capital s
     frak*"T" => "𝔗",  # mathematical fraktur capital t
     frak*"U" => "𝔘",  # mathematical fraktur capital u
@@ -2257,7 +2263,7 @@ const latex_symbols = Dict(
     bold*"beta" => "𝛃",  # mathematical bold small beta
     bold*"gamma" => "𝛄",  # mathematical bold small gamma
     bold*"delta" => "𝛅",  # mathematical bold small delta
-    bold*"epsilon" => "𝛆",  # mathematical bold small epsilon
+    bold*"varepsilon" => "𝛆",  # mathematical bold small epsilon
     bold*"zeta" => "𝛇",  # mathematical bold small zeta
     bold*"eta" => "𝛈",  # mathematical bold small eta
     bold*"theta" => "𝛉",  # mathematical bold small theta
@@ -2279,7 +2285,7 @@ const latex_symbols = Dict(
     bold*"psi" => "𝛙",  # mathematical bold small psi
     bold*"omega" => "𝛚",  # mathematical bold small omega
     bold*"partial" => "𝛛",  # mathematical bold partial differential
-    bold*"varepsilon" => "𝛜",  # mathematical bold epsilon symbol
+    bold*"epsilon" => "𝛜",  # mathematical bold epsilon symbol
     bold*"vartheta" => "𝛝",  # mathematical bold theta symbol
     bold*"varkappa" => "𝛞",  # mathematical bold kappa symbol
     bold*"phi" => "𝛟",  # mathematical bold phi symbol
@@ -2315,7 +2321,7 @@ const latex_symbols = Dict(
     italic*"beta" => "𝛽",  # mathematical italic small beta
     italic*"gamma" => "𝛾",  # mathematical italic small gamma
     italic*"delta" => "𝛿",  # mathematical italic small delta
-    italic*"epsilon" => "𝜀",  # mathematical italic small epsilon
+    italic*"varepsilon" => "𝜀",  # mathematical italic small epsilon
     italic*"zeta" => "𝜁",  # mathematical italic small zeta
     italic*"eta" => "𝜂",  # mathematical italic small eta
     italic*"theta" => "𝜃",  # mathematical italic small theta
@@ -2332,15 +2338,15 @@ const latex_symbols = Dict(
     italic*"sigma" => "𝜎",  # mathematical italic small sigma
     italic*"tau" => "𝜏",  # mathematical italic small tau
     italic*"upsilon" => "𝜐",  # mathematical italic small upsilon
-    italic*"phi" => "𝜑",  # mathematical italic small phi
+    italic*"varphi" => "𝜑",  # mathematical italic small phi
     italic*"chi" => "𝜒",  # mathematical italic small chi
     italic*"psi" => "𝜓",  # mathematical italic small psi
     italic*"omega" => "𝜔",  # mathematical italic small omega
     italic*"partial" => "𝜕",  # mathematical italic partial differential
-    italic*"varepsilon" => "𝜖",  # mathematical italic epsilon symbol
+    italic*"epsilon" => "𝜖",  # mathematical italic epsilon symbol
     italic*"vartheta" => "𝜗",  # mathematical italic theta symbol
     italic*"varkappa" => "𝜘",  # mathematical italic kappa symbol
-    italic*"varphi" => "𝜙",  # mathematical italic phi symbol
+    italic*"phi" => "𝜙",  # mathematical italic phi symbol
     italic*"varrho" => "𝜚",  # mathematical italic rho symbol
     italic*"varpi" => "𝜛",  # mathematical italic pi symbol
     bolditalic*"Alpha" => "𝜜",  # mathematical bold italic capital alpha
@@ -2373,7 +2379,7 @@ const latex_symbols = Dict(
     bolditalic*"beta" => "𝜷",  # mathematical bold italic small beta
     bolditalic*"gamma" => "𝜸",  # mathematical bold italic small gamma
     bolditalic*"delta" => "𝜹",  # mathematical bold italic small delta
-    bolditalic*"epsilon" => "𝜺",  # mathematical bold italic small epsilon
+    bolditalic*"varepsilon" => "𝜺",  # mathematical bold italic small epsilon
     bolditalic*"zeta" => "𝜻",  # mathematical bold italic small zeta
     bolditalic*"eta" => "𝜼",  # mathematical bold italic small eta
     bolditalic*"theta" => "𝜽",  # mathematical bold italic small theta
@@ -2390,15 +2396,15 @@ const latex_symbols = Dict(
     bolditalic*"sigma" => "𝝈",  # mathematical bold italic small sigma
     bolditalic*"tau" => "𝝉",  # mathematical bold italic small tau
     bolditalic*"upsilon" => "𝝊",  # mathematical bold italic small upsilon
-    bolditalic*"phi" => "𝝋",  # mathematical bold italic small phi
+    bolditalic*"varphi" => "𝝋",  # mathematical bold italic small phi
     bolditalic*"chi" => "𝝌",  # mathematical bold italic small chi
     bolditalic*"psi" => "𝝍",  # mathematical bold italic small psi
     bolditalic*"omega" => "𝝎",  # mathematical bold italic small omega
     bolditalic*"partial" => "𝝏",  # mathematical bold italic partial differential
-    bolditalic*"varepsilon" => "𝝐",  # mathematical bold italic epsilon symbol
+    bolditalic*"epsilon" => "𝝐",  # mathematical bold italic epsilon symbol
     bolditalic*"vartheta" => "𝝑",  # mathematical bold italic theta symbol
     bolditalic*"varkappa" => "𝝒",  # mathematical bold italic kappa symbol
-    bolditalic*"varphi" => "𝝓",  # mathematical bold italic phi symbol
+    bolditalic*"phi" => "𝝓",  # mathematical bold italic phi symbol
     bolditalic*"varrho" => "𝝔",  # mathematical bold italic rho symbol
     bolditalic*"varpi" => "𝝕",  # mathematical bold italic pi symbol
     boldsans*"Alpha" => "𝝖",  # mathematical sans-serif bold capital alpha
@@ -2431,7 +2437,7 @@ const latex_symbols = Dict(
     boldsans*"beta" => "𝝱",  # mathematical sans-serif bold small beta
     boldsans*"gamma" => "𝝲",  # mathematical sans-serif bold small gamma
     boldsans*"delta" => "𝝳",  # mathematical sans-serif bold small delta
-    boldsans*"epsilon" => "𝝴",  # mathematical sans-serif bold small epsilon
+    boldsans*"varepsilon" => "𝝴",  # mathematical sans-serif bold small epsilon
     boldsans*"zeta" => "𝝵",  # mathematical sans-serif bold small zeta
     boldsans*"eta" => "𝝶",  # mathematical sans-serif bold small eta
     boldsans*"theta" => "𝝷",  # mathematical sans-serif bold small theta
@@ -2448,15 +2454,15 @@ const latex_symbols = Dict(
     boldsans*"sigma" => "𝞂",  # mathematical sans-serif bold small sigma
     boldsans*"tau" => "𝞃",  # mathematical sans-serif bold small tau
     boldsans*"upsilon" => "𝞄",  # mathematical sans-serif bold small upsilon
-    boldsans*"phi" => "𝞅",  # mathematical sans-serif bold small phi
+    boldsans*"varphi" => "𝞅",  # mathematical sans-serif bold small phi
     boldsans*"chi" => "𝞆",  # mathematical sans-serif bold small chi
     boldsans*"psi" => "𝞇",  # mathematical sans-serif bold small psi
     boldsans*"omega" => "𝞈",  # mathematical sans-serif bold small omega
     boldsans*"partial" => "𝞉",  # mathematical sans-serif bold partial differential
-    boldsans*"varepsilon" => "𝞊",  # mathematical sans-serif bold epsilon symbol
+    boldsans*"epsilon" => "𝞊",  # mathematical sans-serif bold epsilon symbol
     boldsans*"vartheta" => "𝞋",  # mathematical sans-serif bold theta symbol
     boldsans*"varkappa" => "𝞌",  # mathematical sans-serif bold kappa symbol
-    boldsans*"varphi" => "𝞍",  # mathematical sans-serif bold phi symbol
+    boldsans*"phi" => "𝞍",  # mathematical sans-serif bold phi symbol
     boldsans*"varrho" => "𝞎",  # mathematical sans-serif bold rho symbol
     boldsans*"varpi" => "𝞏",  # mathematical sans-serif bold pi symbol
     bolditalicsans*"Alpha" => "𝞐",  # mathematical sans-serif bold italic capital alpha
@@ -2489,7 +2495,7 @@ const latex_symbols = Dict(
     bolditalicsans*"beta" => "𝞫",  # mathematical sans-serif bold italic small beta
     bolditalicsans*"gamma" => "𝞬",  # mathematical sans-serif bold italic small gamma
     bolditalicsans*"delta" => "𝞭",  # mathematical sans-serif bold italic small delta
-    bolditalicsans*"epsilon" => "𝞮",  # mathematical sans-serif bold italic small epsilon
+    bolditalicsans*"varepsilon" => "𝞮",  # mathematical sans-serif bold italic small epsilon
     bolditalicsans*"zeta" => "𝞯",  # mathematical sans-serif bold italic small zeta
     bolditalicsans*"eta" => "𝞰",  # mathematical sans-serif bold italic small eta
     bolditalicsans*"theta" => "𝞱",  # mathematical sans-serif bold italic small theta
@@ -2506,15 +2512,15 @@ const latex_symbols = Dict(
     bolditalicsans*"sigma" => "𝞼",  # mathematical sans-serif bold italic small sigma
     bolditalicsans*"tau" => "𝞽",  # mathematical sans-serif bold italic small tau
     bolditalicsans*"upsilon" => "𝞾",  # mathematical sans-serif bold italic small upsilon
-    bolditalicsans*"phi" => "𝞿",  # mathematical sans-serif bold italic small phi
+    bolditalicsans*"varphi" => "𝞿",  # mathematical sans-serif bold italic small phi
     bolditalicsans*"chi" => "𝟀",  # mathematical sans-serif bold italic small chi
     bolditalicsans*"psi" => "𝟁",  # mathematical sans-serif bold italic small psi
     bolditalicsans*"omega" => "𝟂",  # mathematical sans-serif bold italic small omega
     bolditalicsans*"partial" => "𝟃",  # mathematical sans-serif bold italic partial differential
-    bolditalicsans*"varepsilon" => "𝟄",  # mathematical sans-serif bold italic epsilon symbol
+    bolditalicsans*"epsilon" => "𝟄",  # mathematical sans-serif bold italic epsilon symbol
     bolditalicsans*"vartheta" => "𝟅",  # mathematical sans-serif bold italic theta symbol
     bolditalicsans*"varkappa" => "𝟆",  # mathematical sans-serif bold italic kappa symbol
-    bolditalicsans*"varphi" => "𝟇",  # mathematical sans-serif bold italic phi symbol
+    bolditalicsans*"phi" => "𝟇",  # mathematical sans-serif bold italic phi symbol
     bolditalicsans*"varrho" => "𝟈",  # mathematical sans-serif bold italic rho symbol
     bolditalicsans*"varpi" => "𝟉",  # mathematical sans-serif bold italic pi symbol
     bold*"Digamma" => "\U1d7ca",  # mathematical bold capital digamma
@@ -2575,7 +2581,6 @@ const latex_symbols = Dict(
     "\\leftouterjoin" => "⟕",  # left outer join
     "\\rightouterjoin" => "⟖",  # right outer join
     "\\fullouterjoin" => "⟗",  # full outer join
-    "\\Join" => "⨝",  # join
     "\\join" => "⨝",  # join
     "\\underbar" => "̲",  # combining low line
     "\\underleftrightarrow" => "͍",  # underleftrightarrow accent
@@ -2613,3 +2618,37 @@ const latex_symbols = Dict(
     "\\0/3" => "↉", # vulgar fraction zero thirds
     "\\1/4" => "¼", # vulgar fraction one quarter
 )
+
+
+# Canonical reverse mapping for symbols that have several completions (#39148).
+#
+# These duplicate mappings can be investigated with the folllowing commands:
+#=
+ls = REPL.REPLCompletions.latex_symbols; symbols = values(ls)
+duplicates = [v for v in unique(symbols) if count(==(v), symbols) > 1]
+[(v, REPL.symbol_latex(v)) => findall(==(v), ls) for v in duplicates]
+=#
+const symbols_latex_canonical = Dict(
+    "ð" => "\\dh",
+    "…" => "\\ldots",
+    "∅" => "\\emptyset",
+    "ℯ" => "\\euler",
+    "♀" => "\\female",
+    "≥" => "\\ge",
+    "⟺" => "\\iff",
+    "ℑ" => "\\Im",
+    "⟸" => "\\impliedby",
+    "⟹" => "\\implies",
+    "≤" => "\\le",
+    "⟦" => "\\llbracket",
+    "♂" => "\\male",
+    "∇" => "\\del",
+    "ℎ" => "\\planck",
+    "ℜ" => "\\Re",
+    "⟧" => "\\rrbracket",
+    "√" => "\\sqrt",
+    "̶" => "\\sout",
+    "→" => "\\to",
+    "ε" => "\\varepsilon",
+    "⊻" => "\\xor",
+)

stdlib/REPL/test/docview.jl

@@ -1,7 +1,7 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
 using Test
-import REPL
+import REPL, REPL.REPLCompletions
 import Markdown
 
 @testset "symbol completion" begin
@@ -19,6 +19,11 @@ import Markdown
             Core.eval(Main, REPL.helpmode(buf, "ᵞ₁₂₃¹²³α"))
             String(take!(buf))
         end, "\"ᵞ₁₂₃¹²³α\" can be typed by \\^gamma<tab>\\_123<tab>\\^123<tab>\\alpha<tab>\n")
+
+    # Check that all symbols with several completions have a canonical mapping (#39148)
+    symbols = values(REPLCompletions.latex_symbols)
+    duplicates = [v for v in unique(symbols) if count(==(v), symbols) > 1]
+    @test all(duplicates .∈ Ref(keys(REPLCompletions.symbols_latex_canonical)))
 end
 
 @testset "Non-Markdown" begin