Add musical symbols for unicode completions #54182

NeroBlackstone · 2024-04-22T03:42:11Z

I found that julia was missing some useful music notation unicode completions and sometimes had to copy and paste these unicodes to use the published package.

So I picked out some unicode music symbols that might be useful, named from the unicode standard.

I didn't add the test, I don't think it's necessary.

Thanks for reviewing. Please reply if any changes are needed.

kimikage · 2024-04-22T04:36:41Z

I am fine with this PR being merged, but I think we need to consider the original meaning of the completion.

julia> \two ＃ TAB
\twocaps                \twocups                \twoheaddownarrow
\twoheadleftarrow       \twoheadleftarrowtail   \twoheadleftdbkarrow
\twoheadmapsfrom        \twoheadmapsto          \twoheadrightarrow
\twoheadrightarrowtail  \twoheaduparrow         \twoheaduparrowcircle
\twonotes

Wouldn't it be better to extend what is used in a particular field with a particular package?

NeroBlackstone · 2024-04-22T05:13:51Z

I am fine with this PR being merged, but I think we need to consider the original meaning of the completion.

julia> \two ＃ TAB
\twocaps                \twocups                \twoheaddownarrow
\twoheadleftarrow       \twoheadleftarrowtail   \twoheadleftdbkarrow
\twoheadmapsfrom        \twoheadmapsto          \twoheadrightarrow
\twoheadrightarrowtail  \twoheaduparrow         \twoheaduparrowcircle
\twonotes

Wouldn't it be better to extend what is used in a particular field with a particular package?

Agree. My question is, is it possible to extend Unicode completion using a third party package?

kimikage · 2024-04-22T05:43:41Z

My question is, is it possible to extend Unicode completion using a third party package?

I believe you got the solution.
https://discourse.julialang.org/t/how-to-custom-unicode-completions/113304/3

Something like:

module MusicalSymbolCompletions

import REPL

function __init__()
    isdefined(REPL, :REPLCompletions) || return
    isdefined(REPL.REPLCompletions, :latex_symbols) || return
    REPL.REPLCompletions.latex_symbols["\\dflat"] = "𝄫"
end

end

NeroBlackstone · 2024-04-22T06:24:09Z

My question is, is it possible to extend Unicode completion using a third party package?

I believe you got the solution. https://discourse.julialang.org/t/how-to-custom-unicode-completions/113304/3

Something like:
module MusicalSymbolCompletions

import REPL

function __init__()
    isdefined(REPL, :REPLCompletions) || return
    isdefined(REPL.REPLCompletions, :latex_symbols) || return
    REPL.REPLCompletions.latex_symbols["\\dflat"] = "𝄫"
end

end

Nice! I will respect the maintainer's decision whether or not to merge this pull request. Or just pick a few to merge. Feel free to merge or close this pull request.

stdlib/REPL/src/latex_symbols.jl

stevengj · 2024-04-22T12:11:12Z

It's cool that Unicode has all of these symbols, but if we want to add some more to base (not to a package) perhaps we should limit the additions to a few of the most common and well-known symbols.

LilithHafner · 2024-04-22T12:33:20Z

I don't love that we have our own custom mapping from strings to unicode characters. It is not friendly to users who switch between Julia and other programs that define similar though not identical mappings.

Given that we do have this mapping, I think we should

Continue to add common characters to it as requested (merge this PR)
Support all Unicode symbols by official name (e.g. \MUSICAL_SYMBOL_SINGLE_BARLINE)
Try to find and adopt a canonical mapping from strings to characters that is more ergonomic than unicode (e.g. latex?)

NeroBlackstone · 2024-04-22T12:34:52Z

It's cool that Unicode has all of these symbols, but if we want to add some more to base (not to a package) perhaps we should limit the additions to a few of the most common and well-known symbols.

Strongly agree, unicode completions in the REPL should be representative and reduce uncommon symbols. I have removed Mensural notation and Gregorian notation because they are rarely used.
I believe the updated list contains the most commonly used Unicode symbols in modern music notation.
If you think we need to pare it down further, I can go ahead and pick out more common musical symbols.

LilithHafner

I cross checked this PR (at a3ad268) against https://www.unicode.org/charts/nameslist/c_1D100.html and found no typos or mistranscriptions.

One inconsistency is musicalbreve vs musicbrace/musicbracket. We should use a single prefix: either music or musical, I don't have much preference for which. Music is shorter, and this is for user input type once read never. Musical is the term unicode uses.

Some additional characters that may warrant the music(al) prefix:

"\\tr"=>"𝆖",
"\\turn"=>"𝆗",
"\\invertedturn"=>"𝆘",
"\\turnslash"=>"𝆙",

That said, I couldn't (after a brief search) find any other unicode characters that could plausibly be called "tr" or "turn" (with the possible exception of "turnstyle" ⊢.

NeroBlackstone · 2024-04-22T13:23:25Z

Some additional characters that may warrant the music(al) prefix:
"\\tr"=>"𝆖",
"\\turn"=>"𝆗",
"\\invertedturn"=>"𝆘",
"\\turnslash"=>"𝆙",

I have added "music" prefix for these symbols.

Another change is barline:

        # Bars
    "\\musicsinglebarline"=>"𝄀",
    "\\musicdoublebarline"=>"𝄁",
    "\\musicfinalbarline"=>"𝄂",
    "\\musicreversefinalbarline"=>"𝄃",

I think these symbols may easily confuse users, and it must be noted that they are symbols specifically representing musical notation, so I add "music“ prefix

stdlib/REPL/src/latex_symbols.jl

change naming Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>

LilithHafner

Thank you!

stdlib/REPL/src/latex_symbols.jl

NeroBlackstone · 2024-04-23T05:23:18Z

In consideration of the controversy, I once again removed some symbols that were difficult to read or confusing. Only key symbols such as Accidentals, Codas, Clefs, Rests, Notes are retained.

LilithHafner · 2024-04-23T16:15:35Z

@topolarity, does this seem reasonable to you in its current state?

topolarity · 2024-04-23T23:15:28Z

Maybe this is worth sending to triage for more feedback?

I'm significantly happier with the latest version, but many glyphs are still difficult to read/distinguish and I think this is something of a departure from the conventions for Unicode completions so far (which are mostly math symbols/letters, exponents, etc.)

LilithHafner · 2024-04-24T00:14:18Z

a departure from the conventions for Unicode completions so far (which are mostly math symbols/letters, exponents, etc.)

As Julia's usage extends outside of math, IMO it makes sense to expand Unicode completions.

stevengj · 2024-04-24T00:18:15Z

We have all the emoji, too… I'm inclined to be permissive with any symbol that a large number of people might reasonably recognize and use (excluding language-specific symbols that have their own input methods already), and the common music symbols certainly qualify.

NeroBlackstone · 2024-04-24T02:21:46Z

Considering that REPL Unicode completion can be extended through third-party packages, I'm actually neutral on whether this PR will be merged or not.

If adding a lot of music symbols is considered too radical, I think it would be acceptable to just add Accidental to provide basic support for MusicTheory.jl.

But I still believe that other musical Unicode symbols can bring potential benefits.

LilithHafner · 2024-04-25T02:34:07Z

@tecosaur has a link to a latex symbol table that might have some of these. Barring external, conflicting, canonical names for these symbols, triage is happy with this.

In general, this sort of addition is perfectly fine/good.

LilithHafner · 2024-04-28T20:48:30Z

Chapter 7 of https://ctan.org/pkg/comprehensive lists some (all?) latex musical symbols defined across 12 distinct packages with distinct naming conventions. Some arbitrarily chosen examples:

\musDoubleFlat
\musDoubleSharp
\doublesharp
\flatflat
(but not sharpsharp or doubleflat)

\musEighth
\eightNote

\bassclef (not fclef)

\wholeNote
\fullnote
...

Seems eclectic and not possible to follow sensibly.

I'm going to go ahead and merge soon unless anyone thinks there's a problem with this PR in it's current state.

stdlib/REPL/src/latex_symbols.jl

tecosaur · 2024-04-29T16:24:30Z

Regarding chapter 7 of The LaTeX comprehensive symbols list, it's inconsistent across packages, but the package I think would be worth using as a reference would be lillyglyphs.

Your names are mostly consistent with lillyglyphs, but there are a few differences that I think may be worth drawing attention to:

gclef vs clefg, the lillypond package uses clefX instead of Xclef, and with tab completion in mind I think this seems a bit nicer
flatflat instead of doubleflat, I'm not sure which is more discoverable, but I think it's worth considering at least
having eighthnote and quaver (etc.) be aliases, this seems nice for discoverability if we don't require unique ascii names for unicode chars.

Other than these comments, this PR looks good to me 🙂. Thanks for making it!

NeroBlackstone · 2024-04-30T09:08:34Z

Thank you very much for the review and provided a very good reference, but I don't quite agree with the naming of lillyglyphs.

gclef vs clefg, the lillypond package uses clefX instead of Xclef, and with tab completion in mind I think this seems a bit nicer

I think gclef is more intuitive, that's how we call it.

flatflat instead of doubleflat, I'm not sure which is more discoverable, but I think it's worth considering at least

Same, I think it's important to be consistent with spoken language. I guess no one will call this "flat flat", in reality we would just call it "double flat".

NeroBlackstone · 2024-04-30T09:20:13Z

having eighthnote and quaver (etc.) be aliases, this seems nice for discoverability if we don't require unique ascii names for unicode chars.

I think the naming of Notes and Rests is still worth discussing, my current naming is to be consistent with the existing quarternote and eighthnote:

julia/stdlib/REPL/src/latex_symbols.jl

Lines 809 to 810 in 69036e1

"\\quarternote" => "♩",

"\\eighthnote" => "♪",

I find a better naming in SMuFL

    "\\rest8th"=>"𝄾",
    "\\rest16th"=>"𝄿",
    "\\rest32th"=>"𝅀",
    "\\rest64th"=>"𝅁",
    "\\rest128th"=>"𝅂",

Obviously SMuFL's naming is more readable, but would be inconsistent with existing naming if adopted.

NeroBlackstone · 2024-04-30T09:32:45Z

Maybe?

# Music Symbols - Rests
"\\multirest" => "𝄺",
"\\wholerest" => "𝄻",
"\\halfrest" => "𝄼",
"\\rest4th" => "𝄽",
"\\rest8th" => "𝄾",
"\\rest16th" => "𝄿",
"\\rest32th" => "𝅀",
"\\rest64th" => "𝅁",
"\\rest128th" => "𝅂",
# Music Symbols - Notes
"\\musicbreve" => "𝅜",
"\\wholenote" => "𝅝",
"\\halfnote" => "𝅗𝅥",
"\\note4th" => "𝅘𝅥", #U+1D15F
"\\note8th" => "𝅘𝅥𝅮", #U+1D160
"\\note16th" => "𝅘𝅥𝅯",
"\\note32th" => "𝅘𝅥𝅰",
"\\note64th" => "𝅘𝅥𝅱",
"\\note128th" => "𝅘𝅥𝅲",

In this way, newly added Musical Symbols can remain compatible with existing Miscellaneous Symbols.

"\\quarternote" => "♩", #U+2669
"\\eighthnote" => "♪", #U+266A

stevengj · 2024-04-30T15:39:18Z

The advantage of putting \clefg rather than \gclef is that you can tab-complete \clef<TAB> to get a list of all the clefs. Similarly for \flatflat vs. \doubleflat — the former is more discoverable from tab-completing \flat. Similarly for the \rest8th etc naming from SMuFL.

NeroBlackstone · 2024-04-30T16:04:04Z

The advantage of putting \clefg rather than \gclef is that you can tab-complete \clef<TAB> to get a list of all the clefs. Similarly for \flatflat vs. \doubleflat — the former is more discoverable from tab-completing \flat. Similarly for the \rest8th etc naming from SMuFL.

Thanks for reminding me! I didn't notice that Unicode completion only starts from the beginning of the string!
I think I'll take these suggestions, thanks for the heads up.

stdlib/REPL/src/latex_symbols.jl

NeroBlackstone added 3 commits April 22, 2024 11:34

add musical symbols

b8c1bee

fix trailing whitespace

8745577

fix naming

ca6c4b2

jariji approved these changes Apr 22, 2024

View reviewed changes

stevengj reviewed Apr 22, 2024

View reviewed changes

stdlib/REPL/src/latex_symbols.jl Outdated Show resolved Hide resolved

Pick out the more common symbols

a3ad268

LilithHafner reviewed Apr 22, 2024

View reviewed changes

change naming

3f94945

LilithHafner reviewed Apr 22, 2024

View reviewed changes

stdlib/REPL/src/latex_symbols.jl Outdated Show resolved Hide resolved

Update stdlib/REPL/src/latex_symbols.jl

9ad7be9

change naming Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>

LilithHafner approved these changes Apr 22, 2024

View reviewed changes

LilithHafner mentioned this pull request Apr 22, 2024

Cohesive and complete unicode tab completion story. #54186

Open

2 tasks

LilithHafner added the merge me PR is reviewed. Merge when all tests are passing label Apr 22, 2024

topolarity reviewed Apr 23, 2024

View reviewed changes

stdlib/REPL/src/latex_symbols.jl Outdated Show resolved Hide resolved

remove some symbols

87df7b6

Merge branch 'master' into music-unicode

8ba49dd

LilithHafner removed the merge me PR is reviewed. Merge when all tests are passing label Apr 23, 2024

LilithHafner added the triage This should be discussed on a triage call label Apr 24, 2024

LilithHafner removed the triage This should be discussed on a triage call label Apr 25, 2024

tecosaur reviewed Apr 29, 2024

View reviewed changes

stdlib/REPL/src/latex_symbols.jl Show resolved Hide resolved

Merge branch 'JuliaLang:master' into music-unicode

1360cd2

change naming

ffb9ca6

NeroBlackstone added 2 commits May 1, 2024 00:17

change naming

28cae5a

fix naming

6157372

stevengj reviewed Apr 30, 2024

View reviewed changes

stdlib/REPL/src/latex_symbols.jl Outdated Show resolved Hide resolved

rename

638b1d4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add musical symbols for unicode completions #54182

Add musical symbols for unicode completions #54182

NeroBlackstone commented Apr 22, 2024

kimikage commented Apr 22, 2024

NeroBlackstone commented Apr 22, 2024

kimikage commented Apr 22, 2024 •

edited

NeroBlackstone commented Apr 22, 2024

stevengj commented Apr 22, 2024

LilithHafner commented Apr 22, 2024 •

edited

NeroBlackstone commented Apr 22, 2024 •

edited

LilithHafner left a comment

NeroBlackstone commented Apr 22, 2024

LilithHafner left a comment

NeroBlackstone commented Apr 23, 2024

LilithHafner commented Apr 23, 2024

topolarity commented Apr 23, 2024

LilithHafner commented Apr 24, 2024

stevengj commented Apr 24, 2024 •

edited

NeroBlackstone commented Apr 24, 2024

LilithHafner commented Apr 25, 2024

LilithHafner commented Apr 28, 2024

tecosaur commented Apr 29, 2024

NeroBlackstone commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024 •

edited

stevengj commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024

Add musical symbols for unicode completions #54182

Are you sure you want to change the base?

Add musical symbols for unicode completions #54182

Conversation

NeroBlackstone commented Apr 22, 2024

kimikage commented Apr 22, 2024

NeroBlackstone commented Apr 22, 2024

kimikage commented Apr 22, 2024 • edited

NeroBlackstone commented Apr 22, 2024

stevengj commented Apr 22, 2024

LilithHafner commented Apr 22, 2024 • edited

NeroBlackstone commented Apr 22, 2024 • edited

LilithHafner left a comment

Choose a reason for hiding this comment

NeroBlackstone commented Apr 22, 2024

LilithHafner left a comment

Choose a reason for hiding this comment

NeroBlackstone commented Apr 23, 2024

LilithHafner commented Apr 23, 2024

topolarity commented Apr 23, 2024

LilithHafner commented Apr 24, 2024

stevengj commented Apr 24, 2024 • edited

NeroBlackstone commented Apr 24, 2024

LilithHafner commented Apr 25, 2024

LilithHafner commented Apr 28, 2024

tecosaur commented Apr 29, 2024

NeroBlackstone commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024 • edited

stevengj commented Apr 30, 2024

NeroBlackstone commented Apr 30, 2024

kimikage commented Apr 22, 2024 •

edited

LilithHafner commented Apr 22, 2024 •

edited

NeroBlackstone commented Apr 22, 2024 •

edited

stevengj commented Apr 24, 2024 •

edited

NeroBlackstone commented Apr 30, 2024 •

edited