Support for highlighting all search matches (hlsearch) (#1762)

* Support for highlighting all search matches (hlsearch) hlsearch is implemented efficiently using the buffer's line array, somewhat similarly to the syntax highlighting. Unlike the syntax highlighter which highlights the entire file, hlsearch searches for matches for the displayed lines only. Matches are searched when the given line is displayed first time or after it was modified. Otherwise the previously found matches are used. * Add UnhighlightSearch action and add it to the list of actions triggered by Esc key by default. * Add comment explaining the purpose of search map * Add hlsearch colors to colorschemes Mostly just copied from the corresponding original (mostly vim) colorschemes. * Highlight matches during/after replace as well As a side effect it also changes the last search value, i.e. affects FindNext and FindPrevious, but it's probably fine. In vim it works the same way. * Improve hlsearch option description
2026-03-17 06:17:12 +09:00 · 2021-09-28 22:39:03 +02:00
parent 9ad4437a98
commit ffbb257434
36 changed files with 197 additions and 22 deletions
--- a/runtime/colorschemes/atom-dark.micro
+++ b/runtime/colorschemes/atom-dark.micro
@@ -11,6 +11,7 @@ color-link special "#A6E22E,#1D1F21"
 color-link underlined "#D33682,#1D1F21"
 color-link error "bold #FF4444,#1D1F21"
 color-link todo "bold #FF8844,#1D1F21"
+color-link hlsearch "#000000,#B4EC85"
 color-link statusline "#1D1F21,#C5C8C6"
 color-link tabbar "#1D1F21,#C5C8C6"
 color-link indent-char "#505050,#1D1F21"
--- a/runtime/colorschemes/bubblegum.micro
+++ b/runtime/colorschemes/bubblegum.micro
@@ -12,6 +12,7 @@ color-link special "167,231"
 color-link error "231, 160"
 color-link underlined "underline 241,231"
 color-link todo "246,231"
+color-link hlsearch "231,136"
 color-link statusline "241,254"
 color-link tabbar "241,254"
 color-link diff-added "34"
--- a/runtime/colorschemes/cmc-16.micro
+++ b/runtime/colorschemes/cmc-16.micro
@@ -26,6 +26,7 @@ color-link special "magenta"
 color-link ignore "default"
 color-link error "bold ,brightred"
 color-link todo "underline black,brightyellow"
+color-link hlsearch "white,darkgreen"
 color-link indent-char ",brightgreen"
 color-link line-number "green"
 color-link line-number.scrollbar "green"
--- a/runtime/colorschemes/cmc-tc.micro
+++ b/runtime/colorschemes/cmc-tc.micro
@@ -21,6 +21,7 @@ color-link special "#b57edc"
 color-link ignore "default"
 color-link error "bold ,#e34234"
 color-link todo "bold underline #888888,#f26522"
+color-link hlsearch "#b7b7b7,#32593d"
 color-link indent-char ",#bdecb6"
 color-link line-number "#bdecb6,#36393e"
 color-link line-number.scrollbar "#3eb489"
--- a/runtime/colorschemes/darcula.micro
+++ b/runtime/colorschemes/darcula.micro
@@ -12,6 +12,7 @@ color-link special "#CC8242,#242424"
 color-link underlined "#D33682,#242424"
 color-link error "bold #CB4B16,#242424"
 color-link todo "bold #D33682,#242424"
+color-link hlsearch "#CCCCCC,#32593D"
 color-link statusline "#242424,#CCCCCC"
 color-link tabbar "#242424,#CCCCCC"
 color-link indent-char "#4F4F4F,#242424"
--- a/runtime/colorschemes/default.micro
+++ b/runtime/colorschemes/default.micro
@@ -12,6 +12,7 @@ color-link special "#A6E22E,#282828"
 color-link underlined "#D33682,#282828"
 color-link error "bold #CB4B16,#282828"
 color-link todo "bold #D33682,#282828"
+color-link hlsearch "#282828,#E6DB74"
 color-link statusline "#282828,#F8F8F2"
 color-link tabbar "#282828,#F8F8F2"
 color-link indent-char "#505050,#282828"
--- a/runtime/colorschemes/dracula-tc.micro
+++ b/runtime/colorschemes/dracula-tc.micro
@@ -24,6 +24,8 @@ color-link underlined "#FF79C6"
 color-link error "bold #FF5555"
 color-link todo "bold #FF79C6"

+color-link hlsearch "#282A36,#50FA7B"
+
 color-link diff-added "#50FA7B"
 color-link diff-modified "#FFB86C"
 color-link diff-deleted "#FF5555"
--- a/runtime/colorschemes/dukedark-tc.micro
+++ b/runtime/colorschemes/dukedark-tc.micro
@@ -15,6 +15,7 @@ color-link divider "#001e28,#d0d0d0"
 color-link error "#cb4b16,#001e28"
 color-link gutter-error "#cb4b16,#001e28"
 color-link gutter-warning "#fce94f,#001e28"
+color-link hlsearch "#ffffff,#005028"
 color-link identifier "#00c8a0,#001e28"
 color-link identifier.class "#00c8a0,#001e28"
 color-link indent-char "#a0a0a0,#001e28"
--- a/runtime/colorschemes/dukelight-tc.micro
+++ b/runtime/colorschemes/dukelight-tc.micro
@@ -15,6 +15,7 @@ color-link divider "#f0f0f0,#004080"
 color-link error "#500000,#f0f0f0"
 color-link gutter-error "#500000,#f0f0f0"
 color-link gutter-warning "#dcc800,#f0f0f0"
+color-link hlsearch "#000000,#b8d8e8"
 color-link identifier "bold #0078a0,#f0f0f0"
 color-link identifier.class "bold #0078a0,#f0f0f0"
 color-link indent-char "#404040,#f0f0f0"
--- a/runtime/colorschemes/dukeubuntu-tc.micro
+++ b/runtime/colorschemes/dukeubuntu-tc.micro
@@ -15,6 +15,7 @@ color-link divider "#2d0023,#d0d0d0"
 color-link error "#cb4b16,#2d0023"
 color-link gutter-error "#cb4b16,#2d0023"
 color-link gutter-warning "#fce94f,#2d0023"
+color-link hlsearch "#ffffff,#005028"
 color-link identifier "#00c8a0,#2d0023"
 color-link identifier.class "#00c8a0,#2d0023"
 color-link indent-char "#a0a0a0,#2d0023"
--- a/runtime/colorschemes/geany.micro
+++ b/runtime/colorschemes/geany.micro
@@ -12,6 +12,7 @@ color-link type "blue"
 color-link type.extended "default"
 color-link error "red"
 color-link todo "bold cyan"
+color-link hlsearch "black,brightcyan"
 color-link indent-char "bold black"
 color-link line-number ""
 color-link current-line-number ""
--- a/runtime/colorschemes/gotham.micro
+++ b/runtime/colorschemes/gotham.micro
@@ -11,6 +11,7 @@ color-link special "#D26937,#0C1014"
 color-link underlined "#EDB443,#0C1014"
 color-link error "bold #C23127,#0C1014"
 color-link todo "bold #888CA6,#0C1014"
+color-link hlsearch "#091F2E,#EDB443"
 color-link statusline "#091F2E,#599CAB"
 color-link indent-char "#505050,#0C1014"
 color-link line-number "#245361,#11151C"
--- a/runtime/colorschemes/gruvbox-tc.micro
+++ b/runtime/colorschemes/gruvbox-tc.micro
@@ -11,6 +11,7 @@ color-link type "#fb4934,#282828"
 color-link special "#d79921,#282828"
 color-link underlined "underline #282828"
 color-link error "#9d0006,#282828"
+color-link hlsearch "#282828,#fabd2f"
 color-link diff-added "#00AF00"
 color-link diff-modified "#FFAF00"
 color-link diff-deleted "#D70000"
--- a/runtime/colorschemes/gruvbox.micro
+++ b/runtime/colorschemes/gruvbox.micro
@@ -11,6 +11,7 @@ color-link special "172,235"
 color-link underlined "underline 109,235"
 color-link error "235,124"
 color-link todo "bold 223,235"
+color-link hlsearch "235,214"
 color-link diff-added "34"
 color-link diff-modified "214"
 color-link diff-deleted "160"
--- a/runtime/colorschemes/material-tc.micro
+++ b/runtime/colorschemes/material-tc.micro
@@ -14,6 +14,7 @@ color-link divider "#263238,#80DEEA"
 color-link error "bold #263238,#F07178"
 color-link gutter-error "#EEFFFF,#F07178"
 color-link gutter-warning "#EEFFFF,#FFF176"
+color-link hlsearch "#FFFFFF,#546E7A"
 color-link identifier "#82AAFF,#263238"
 color-link identifier.macro "#FFCB6B,#263238"
 color-link indent-char "#505050,#263238"
--- a/runtime/colorschemes/monokai-dark.micro
+++ b/runtime/colorschemes/monokai-dark.micro
@@ -11,6 +11,7 @@ color-link special "#A6E22E"
 color-link underlined "#D33682"
 color-link error "bold #CB4B16"
 color-link todo "bold #D33682"
+color-link hlsearch "#1D0000,#E6DB74"
 color-link statusline "#282828,#F8F8F2"
 color-link indent-char "#505050,#282828"
 color-link line-number "#AAAAAA,#282828"
--- a/runtime/colorschemes/monokai.micro
+++ b/runtime/colorschemes/monokai.micro
@@ -12,6 +12,7 @@ color-link special "#A6E22E,#282828"
 color-link underlined "#D33682,#282828"
 color-link error "bold #CB4B16,#282828"
 color-link todo "bold #D33682,#282828"
+color-link hlsearch "#282828,#E6DB74"
 color-link statusline "#282828,#F8F8F2"
 color-link tabbar "#282828,#F8F8F2"
 color-link indent-char "#505050,#282828"
--- a/runtime/colorschemes/one-dark.micro
+++ b/runtime/colorschemes/one-dark.micro
@@ -15,6 +15,7 @@ color-link diff-modified "#FFAF00"
 color-link diff-deleted "#D70000"
 color-link gutter-error "#9B859D"
 color-link gutter-warning "#9B859D"
+color-link hlsearch "#21252C,#E5C07B"
 color-link identifier "#61AFEF"
 color-link identifier.class "#C678DD"
 color-link identifier.var "#C678DD"
--- a/runtime/colorschemes/railscast.micro
+++ b/runtime/colorschemes/railscast.micro
@@ -11,6 +11,7 @@ color-link underlined "#cc7833,#2b2b2b"
 color-link todo "bold #cc7833,#2b2b2b"
 color-link error "bold #cc7833,#2b2b2b"
 color-link gutter-error "#cc7833,#11151C"
+color-link hlsearch "#e6e1dc,#474d5c"
 color-link indent-char "#414141,#2b2b2b"
 color-link line-number "#a1a1a1,#232323"
 color-link current-line-number "#e6e1dc,#2b2b2b"
--- a/runtime/colorschemes/simple.micro
+++ b/runtime/colorschemes/simple.micro
@@ -9,6 +9,7 @@ color-link special "magenta"
 color-link ignore "default"
 color-link error ",brightred"
 color-link todo ",brightyellow"
+color-link hlsearch "black,yellow"
 color-link indent-char "black"
 color-link line-number "yellow"
 color-link current-line-number "red"
--- a/runtime/colorschemes/solarized-tc.micro
+++ b/runtime/colorschemes/solarized-tc.micro
@@ -11,6 +11,7 @@ color-link special "#268BD2,#002833"
 color-link underlined "#D33682,#002833"
 color-link error "bold #CB4B16,#002833"
 color-link todo "bold #D33682,#002833"
+color-link hlsearch "#002833,#B58900"
 color-link statusline "#003541,#839496"
 color-link tabbar "#003541,#839496"
 color-link indent-char "#003541,#002833"
--- a/runtime/colorschemes/solarized.micro
+++ b/runtime/colorschemes/solarized.micro
@@ -10,6 +10,7 @@ color-link special "blue"
 color-link underlined "magenta"
 color-link error "bold brightred"
 color-link todo "bold magenta"
+color-link hlsearch "black,yellow"
 color-link statusline "black,brightblue"
 color-link tabbar "black,brightblue"
 color-link indent-char "black"
--- a/runtime/colorschemes/sunny-day.micro
+++ b/runtime/colorschemes/sunny-day.micro
@@ -11,6 +11,7 @@ color-link special "22"
 color-link underlined "61,230"
 color-link error "88"
 color-link todo "210"
+color-link hlsearch "0,253"
 color-link statusline "233,229"
 color-link tabbar "233,229"
 color-link indent-char "229"
--- a/runtime/colorschemes/twilight.micro
+++ b/runtime/colorschemes/twilight.micro
@@ -15,6 +15,7 @@ color-link diff-modified "#FFAF00"
 color-link diff-deleted "#D70000"
 color-link gutter-error "#9B859D"
 color-link gutter-warning "#9B859D"
+color-link hlsearch "#141414,#C0C000"
 color-link identifier "#9B703F"
 color-link identifier.class "#DAD085"
 color-link identifier.var "#7587A6"
--- a/runtime/colorschemes/zenburn.micro
+++ b/runtime/colorschemes/zenburn.micro
@@ -12,6 +12,7 @@ color-link special "181,237"
 color-link underlined "188,237"
 color-link error "115,236"
 color-link todo "bold 254,237"
+color-link hlsearch "230,22"
 color-link statusline "186,236"
 color-link tabbar "186,236"
 color-link indent-char "238,237"
--- a/runtime/help/options.md
+++ b/runtime/help/options.md
@@ -159,6 +159,15 @@ Here are the available options:
 	default value: `unknown`. This will be automatically overridden depending
    on the file you open.

+* `hlsearch`: highlight all instances of the searched text after a successful
+   search. This highlighting can be turned off via `UnhighlightSearch` action
+   (triggered by Esc key by default) or toggled on/off via `ToggleHighlightSearch`
+   action. Note that these actions don't change `hlsearch` setting.
+   As long as `hlsearch` is set to true, after the next search the highlighting
+   is turned on again.
+
+	default value: `false`
+
 * `incsearch`: enable incremental search in "Find" prompt (matching as you type).

 	default value: `true`