Neovim-qt: GuiRenderLigatures Issues

Created on 1 Oct 2020 · 15Comments · Source: equalsraf/neovim-qt

@kierun

Creating a bug here so as to not spam the large thread.

From #166:

Ah, I see. The runtime was wrong, installed and I can see ligatures.

screenshot

I mean, they are horribly broken but that could be my font.

screenshot1

Which it is.

However, using the mouse now causes neovim to crash… Should I open a new bug for that?

Yes, please provide more details on your GuiRenderLigatures issues here.

Sorry for the break, the changes are still experimental.

Please be specific, I'm not sure what each screenshot above correlates to.

What font are you using? Steps leading up to the issues? What specific actions result in a crash?

Here is the feature on my machine:

Source

jgehrig

All 15 comments

√ (master|…56); cmake -G Ninja -DCMAKE_INSTALL_PREFIX=$HOME ..
[…] ← I can paste those is need be.
 (master|…56); ninja -j 5 install
[…] ← I can paste those is need be.
√ (master|…56); nvim-qt --version
NVIM-QT v0.2.17.9999
Build type:
Compilation: -Wall -Wextra -Wno-unused-parameter -Wunused-variable -std=c++11
Qt Version: 5.14.2
Environment:
  nvim: nvim
  args: --cmd let &rtp.=',/home/yann/share/nvim-qt/runtime' --cmd set termguicolors
  runtime: /home/yann/share/nvim-qt/runtime

NVIM v0.4.4
Build type: Debug
LuaJIT 2.0.5
Compilation: /usr/bin/cc -g -Wall -Wextra -pedantic -Wno-unused-parameter -Wstrict-prototypes -std=gnu99 -Wshadow -Wconversion -Wmissing-prototypes -Wimplicit-fallthrough -Wvla -fstack-protector-strong -fno-common -fdiagnostics-color=always -DINCLUDE_GENERATED_DECLARATIONS -D_GNU_SOURCE -DNVIM_MSGPACK_HAS_FLOAT32 -DNVIM_UNIBI_HAS_VAR_FROM -I/home/yann/src/neovim/build/config -I/home/yann/src/neovim/src -I/home/yann/src/neovim/.deps/usr/include -I/usr/include -I/home/yann/src/neovim/build/src/nvim/auto -I/home/yann/src/neovim/build/include
Compiled by [email protected]

Features: +acl +iconv +tui
See ":help feature-compile"

   system vimrc file: "$VIM/sysinit.vim"
  fall-back for $VIM: "/home/yann/share/nvim"

Run :checkhealth for more info

Then running it, I get:

screenshot

Font is Monoid Nerd Font. However, any mouse input (left, middle, and right click) gets me this:
screenshot1

kierun on 1 Oct 2020

Another oddness: the font width appears to be variable!

Peek 2020-10-01 16-22

This is using a PrgamataPro patched (with Nerd Fonts) font. At the end, I did a left mouse click.

kierun on 1 Oct 2020

Font is Monoid Nerd Font. However, any mouse input (left, middle, and right click) gets me this:

The input issues are unrelated to GuiRenderLigatures. A bisect suggests 3a59d6bd6e24a0935272a87e4300f97472e40d13 is to blame.

I will file a new bug (or pull request) shortly...

jgehrig on 1 Oct 2020

👍1

Another oddness: the font width appears to be variable!

Interesting... Is the font you are using well-formed? Is there a space before b?

The raw characters like == and their equivalent ligature must be the same width.

Here is my machine with Fira Code:
Cursor_Movement_Ligatures

File Content:

a == b
a != b
a -> b
a => b

Your machine looks okay for Monoid. Does the issue disappear when you change fonts? Does the issue disappear on :GuiRenderLigatures 0?

jgehrig on 1 Oct 2020

What setting causes the highlight lines to appear vertically and horizontally outward from the cursor?

The feature has some interesting implications. GuiRenderLigatures 1 renders entire lines and GuiRenderLigatures 0 renders individual cells. With your config, cursor movements trigger an entire screen redraw... Ouch!

Have you noticed any performance degradation? Lagging?

I'd like to do some testing and performance profiling with your configuration...

jgehrig on 1 Oct 2020

Is the font you are using well-formed? Is there a space before b?

Not sure. I've had issues with PragmataPro and Nerd Font so that could be it. I'll try with Monid.

Your machine looks okay for Monoid. Does the issue disappear when you change fonts?

Yes, it does:

Peek 2020-10-02 08-34

What setting causes the highlight lines to appear vertically and horizontally outward from the cursor?

Neovim but should work in vim too:

  set cursorcolumn
  set cursorline

The feature has some interesting implications. GuiRenderLigatures 1 renders entire lines and GuiRenderLigatures 0 renders individual cells. With your config, cursor movements trigger an entire screen redraw... Ouch!

☹ That's not good. I might get ride of those.

Have you noticed any performance degradation? Lagging?

Not really but my machine is not being taxed by window manager and things like that…

I'd like to do some testing and performance profiling with your configuration...

Here it all is, in its horribly mess… I should clean it up but I am so so so lazy…

kierun on 2 Oct 2020

frowning_face That's not good. I might get ride of those.

No need to change, keep the settings as you like them. I am also unable to perceive any slowness.

This is purely theoretical and may not be a concern in practice :)

Not sure. I've had issues with PragmataPro and Nerd Font so that could be it. I'll try with Monid.

Could you provide link or information on how to install this specific font?

I would like to understand what causes the appearing/disappearing space before 'b'.

jgehrig on 2 Oct 2020

Cursor disappears on the second character of the ligatures.
Also, when the cursor is on the first character the second character disappears.

2020-10-03 11 31 36

khalidchawtany on 3 Oct 2020

@khalidchawtany Thanks for the bug report!

I cannot reproduce on Linux or Windows with Fira Code or Monoid. Testing on MacOS pending, no VM access right now.

Can you provide a minimal repro case? It would be helpful to have: file, colorschme, and specific font.

I assume your platform is MacOS?

jgehrig on 3 Oct 2020

MacOS version: 10.15.7 (19H2)
I tried using another font like Fira Code and none of the cursor or the character disappear!

Kapture 2020-10-03 at 22 43 44

The font with the problem is Operator Mono, I patched it to support ligatures myself.

Kapture 2020-10-03 at 22 30 24

./nvim-qt --version
NVIM-QT v0.2.17.9999
Build type: Release
Compilation: -Wall -Wextra -Wno-unused-parameter -Wunused-variable -std=c++11
Qt Version: 5.15.1
Environment:
  nvim: nvim
  args: --cmd let &rtp.=',/Users/juju/Development/Applications/neovim-qt/neovim-qt/build/bin/nvim-qt.app/Contents/MacOS/../Resources/runtime' --cmd set termguicolors
  runtime: /Users/juju/Development/Applications/neovim-qt/neovim-qt/build/bin/nvim-qt.app/Contents/MacOS/../Resources/runtime

NVIM v0.5.0-c10c2fab5
Build type: Release
LuaJIT 2.0.5
Compilation: /usr/bin/clang -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=1 -DNDEBUG -Wall -Wextra -pedantic -Wno-unused-parameter -Wstrict-prototypes -std=gnu99 -Wshadow -Wconversion -Wmissing-prototypes -Wimplicit-fallthrough -Wvla -fstack-protector-strong -fno-common -fdiagnostics-color=auto -DINCLUDE_GENERATED_DECLARATIONS -D_GNU_SOURCE -DNVIM_MSGPACK_HAS_FLOAT32 -DNVIM_UNIBI_HAS_VAR_FROM -DMIN_LOG_LEVEL=3 -I/tmp/neovim-20201002-12405-1hnb1sr/build/config -I/tmp/neovim-20201002-12405-1hnb1sr/src -I/usr/local/include -I/tmp/neovim-20201002-12405-1hnb1sr/deps-build/include -I/Library/Developer/CommandLineTools/SDKs/MacOSX10.15.sdk/usr/include -I/usr/local/opt/gettext/include -I/tmp/neovim-20201002-12405-1hnb1sr/build/src/nvim/auto -I/tmp/neovim-20201002-12405-1hnb1sr/build/include
Compiled by [email protected]

Features: +acl +iconv +tui
See ":help feature-compile"

   system vimrc file: "$VIM/sysinit.vim"
  fall-back for $VIM: "/usr/local/Cellar/neovim/HEAD-c10c2fa/share/nvim"

Run :checkhealth for more info

khalidchawtany on 3 Oct 2020

The font with the problem is Operator Mono, I patched it to support ligatures myself.

Ahhhhh, interesting. The Qt API I used is vaguely documented. The glyphs for that font are probably presented in a format I did not expect.

Could you provide the TTF/OTF file or install instructions?

jgehrig on 3 Oct 2020

https://github.com/kiliman/operator-mono-lig is the tool used to patch the font (Support ligatures).

The font can be obtained from https://www.typography.com/fonts/operator/styles/operatormono but you have to pay for :(

Edit:
I found the font in github just search for (github operator mono otf)

khalidchawtany on 3 Oct 2020

@khalidchawtany @kierun

It looks like both have a similar issue: non-working non-free ligatures fonts.

If you can provide me a copy of the fonts privately, I will use them for debugging purposes only and I will delete the files afterwards. You can find my email in git logs (trying to avoid directly posting it, spam).

Otherwise, you can try to debug the issues on your respective machines.

Best guess, there is an issue near these lines:
https://github.com/equalsraf/neovim-qt/blob/e16af64771c9a20992ab2901142c1321165b6c74/src/gui/shellwidget/shellwidget.cpp#L481-L512

jgehrig on 4 Oct 2020

👍1