hl-todo-mode: Fontify using hl-todo--regexp only #29
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
Previously we used `font-lock-flush' and `font-lock-ensure' instead. Most built-in minor-modes that call `font-lock-add-keywords' (with `nil' as MODE), only call the former, which doesn't appear to always get the job done. Additionally calling `font-lock-ensure' as we did isn't much; it re-fontifies the complete buffer, which can be costly and it has been reported that it sometimes fails to actually do so. Directly fontifying just our own keyword using `hl-todo--regexp' for the complete buffer seems to be a good compromise and should also be more reliable.
This was referenced Oct 3, 2018
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.
Previously we used
font-lock-flushandfont-lock-ensureinstead. Most built-in minor-modes that callfont-lock-add-keywords(withnilas MODE), only call the former, which doesn't appear to always get the job done. Additionally callingfont-lock-ensureas we did isn`t much; it re-fontifies the complete buffer, which can be costly and it has been reported that it sometimes fails to actually do so.Directly fontifying just our own keyword using
hl-todo--regexpfor the complete buffer seems to be a good compromise and should also be more reliable.This should fix #22 and #26.
smerge-modeuses the same approach but that's not necessarily so because its author has the same doubts aboutfont-lock-flushandfont-lock-ensurethat I have. That package uses a regexp that matches across more than one line, in which case things get even more complicated. Anyway, if it works for multi-line matches then matches within a single line should be no problem at all. Still, I would not necessarily recommend that all keyword-adding minor-modes use this approach.This should be much faster than using
font-lock-flushandfont-lock-ensureand not much slower than using just the former.