fix: improve string width calculation #247
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flrgh
added a commit
to flrgh/nvim-notify
that referenced
this pull request
Jun 20, 2024
Some misbehaving plugin code was sending very large messages to `vim.notify()`, which would trigger an exception when calculating the max line width for rendering: ``` [...]/notify/render/default.lua:6: too many results to unpack ``` To fix this, I updated the implementation to calculate the max line width in-place. This ultimately ends up being much more efficient because it is not creating a new table with `vim.tbl_map()`. Here's some benchmark data: https://gist.github.com/flrgh/349aecd8ca35d20cf0526ec8b218657c In the large input benchmarks, the new function is ~2x faster. For small inputs (which are probably most common for `vim.notify()`), the speedup is even larger at 3-4x. Other changes: 1. I noticed the same snippet appeared in multiple render modules, so I factored it out into `notify.util.max_line_width()` and added a unit test 2. I updated the calculation to use `vim.api.nvim_strwidth()` when available (see rcarriga#247).
flrgh
added a commit
to flrgh/nvim-notify
that referenced
this pull request
Jun 20, 2024
Some misbehaving plugin code was sending very large messages to `vim.notify()`, which would trigger an exception when calculating the max line width for rendering: ``` [...]/notify/render/default.lua:6: too many results to unpack ``` To fix this, I updated the implementation to calculate the max line width in-place. This ultimately ends up being much more efficient because it is not creating a new table with `vim.tbl_map()`. Here's some benchmark data: https://gist.github.com/flrgh/349aecd8ca35d20cf0526ec8b218657c In the large input benchmarks, the new function is ~2x faster. For small inputs (which are probably most common for `vim.notify()`), the speedup is even larger at 3-4x. Other changes: 1. I noticed the same snippet appeared in multiple render modules, so I factored it out into `notify.util.max_line_width()` and added a unit test 2. I updated the calculation to use `vim.api.nvim_strwidth()` when available (see rcarriga#247).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I found that sometimes notifications are not rendered correctly. Here is an example:
Such glitches can be caused by several factors: UTF-16 surrogate pairs (accidentally taken into account here and here), combining character sequences, fullwidth characters, etc.
To fix the problem, this PR makes the following changes:
#operator to determine the position of extmarks, as it requires simply byte indices.vim.api.nvim_strwidthinstead ofvim.fn.strcharsorvim.str_utfindexto more reliably calculate the width of a string on screen.Tested with NeoVim
v0.5.1andv0.10.0-nightly.Limitations
vim.api.nvim_strwidthworks well in many cases, but is not perfect (e.g., for emojis).