Transient hlsearch #11
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
Let hlsearch automatically dissipate after a configured timeout period. This feature is off by default and can be activated by setting g:LoupeHlSearchTimeout to a positive number (of milliseconds) in a version of Vim (or Neovim) that supports timers. Events that call loupe#hlmatch (highlighting the match under the cursor) will also call loupe#hlsearch, which schedules the deactivation of hlsearch. The callback that actually turns off hlsearch will only do so if called by the most recent timer, so multiple `n` jumps, for example, effectively extend the life of hlsearch. I had hoped to implement this using :nohlsearch rather than manipulating the 'hlsearch' user option, but Vim saves and restores the highlight state when calling user functions, so :nohlsearch has no effect. Given the nature of this feature, manipulating 'hlsearch' seems reasonable.
Scoping the hlsearch_timer to a window can lead to an error if you change windows before the timer finishes. The callback (loupe#private#clear_hlsearch) will run in a window that has no w:hlsearch_timer defined, E121: Undefined variable: w:hlsearch_timer or it might run in a window that has an outdated w:hlsearch_timer value, and hlsearch will never be cleared. Since 'hlsearch' is a global option anyway, the easy fix seems to be the correct one: make hlsearch_timer global as well.
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.
Why
It would be nice to be able to make
'hlsearch'automatically dissipate after a configured timeout period, leaving only the match under the cursor highlighted.Demo
How
This feature is off by default and can be activated by setting
g:LoupeHlSearchTimeoutto a positive number (of milliseconds) in a version of Vim (or Neovim) that supports timers.The autocommand and mappings that currently call
loupe#hlmatch(highlighting the match under the cursor) will also callloupe#hlsearch, which sets'hlsearch'and schedules a timer to deactivate it. The callback that handles deactivation only does so for the most recent timer, so multiplenjumps, for example, extend the life of'hlsearch'.Notes
I initially tried to implement this using
:nohlsearchrather than manipulating the'hlsearch'user option, but Vim saves and restores the highlight state when calling and returning from user functions, so:nohlsearchwas useless. Given the nature of this feature, manipulating'hlsearch'seems pretty reasonable.I suppose it might be nice to make the highlight under the cursor transient as well, but I haven't implemented that yet.