Avoid changing 'undolevels' when creating an undo break. #1534
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.
Setting the 'undolevels' option to any value has the side effect of creating an undo break. UltiSnips uses the below construct to create an undo break with the goal of leaving 'undolevels' unmodified:
However, if a local 'undolevels' option has been set to a different value than the global option, the assignment above has the unintended effect of changing the global 'undolevels' value to the local value.
Use
&g:undolevels
to explicitly read and modify only the global option value, avoiding undesired option changes.See the related pull request vim/vim#12729 suggesting related Vim documentation changes.
Currently, UltiSnips crashes on Neovim due in part to the issue described in this pull request: neovim/neovim#24574 (but already fixed by neovim/neovim#24501).
To trigger this crash:
Launch Neovim:
Split the buffer into two windows:
Launch a substitute command:
Trigger a snippet, leading to an error similar to:
In the final line, the error
Vim(let):E474: Invalid argument
derives from Neovim's cmdpreview feature leaving the buffer-local 'undolevels' value set toLONG_MAX
, which (on some machines) is outside the range ofint
that Neovim currently enforces for all options.So in addition to properly retaining the global 'undolevels' option value, this change to UltiSnips also avoids the above UltiSnips crash on Neovim.