├── LICENSE
├── README.md
├── doc
    └── mini-cursorword.txt
└── lua
    └── mini
        └── cursorword.lua


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Evgeni Chasnovski
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <img src="https://github.com/echasnovski/media/blob/main/mini.nvim/logo/logo_cursorword.png" style="width: 100%"/>
  2 | 
  3 | <!-- badges: start -->
  4 | [![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)
  5 | <!-- badges: end -->
  6 | 
  7 | ### Automatic highlighting of word under cursor
  8 | 
  9 | See more details in [Features](#features) and [help file](doc/mini-cursorword.txt).
 10 | 
 11 | ---
 12 | 
 13 | ⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/README.md) if you want to mention this module.
 14 | 
 15 | ⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
 16 | 
 17 | ⦿ See the repository page to learn about common design principles and configuration recipes.
 18 | 
 19 | ---
 20 | 
 21 | If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
 22 | 
 23 | ## Demo
 24 | 
 25 | https://user-images.githubusercontent.com/24854248/173044454-0e4ab873-6e73-448d-838f-45f4b2be876b.mp4
 26 | 
 27 | ## Features
 28 | 
 29 | - Current word under cursor can be highlighted differently.
 30 | - "Word under cursor" is meant as in Vim's `<cword>`: something user would get as 'iw' text object.
 31 | - Highlighting stops in insert and terminal modes.
 32 | 
 33 | ## Installation
 34 | 
 35 | This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
 36 | 
 37 | There are two branches to install from:
 38 | 
 39 | - `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
 40 | - `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
 41 | 
 42 | Here are code snippets for some common installation methods (use only one):
 43 | 
 44 | <details>
 45 | <summary>With <a href="https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-deps.md">mini.deps</a></summary>
 46 | <table>
 47 |     <thead>
 48 |         <tr>
 49 |             <th>Github repo</th>
 50 |             <th>Branch</th> <th>Code snippet</th>
 51 |         </tr>
 52 |     </thead>
 53 |     <tbody>
 54 |         <tr>
 55 |             <td rowspan=2>'mini.nvim' library</td> <td>Main</td> <td rowspan=2><i>Follow recommended 'mini.deps' installation</i></td>
 56 |         </tr>
 57 |         <tr>
 58 |             <td>Stable</td>
 59 |         </tr>
 60 |         <tr>
 61 |             <td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>add('echasnovski/mini.cursorword')</code></td>
 62 |         </tr>
 63 |         <tr>
 64 |             <td>Stable</td> <td><code>add({ source = 'echasnovski/mini.cursorword', checkout = 'stable' })</code></td>
 65 |         </tr>
 66 |     </tbody>
 67 | </table>
 68 | </details>
 69 | 
 70 | <details>
 71 | <summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
 72 | <table>
 73 |     <thead>
 74 |         <tr>
 75 |             <th>Github repo</th>
 76 |             <th>Branch</th> <th>Code snippet</th>
 77 |         </tr>
 78 |     </thead>
 79 |     <tbody>
 80 |         <tr>
 81 |             <td rowspan=2>'mini.nvim' library</td>
 82 |             <td>Main</td> <td><code>{ 'echasnovski/mini.nvim', version = false },</code></td>
 83 |         </tr>
 84 |         <tr>
 85 |             <td>Stable</td> <td><code>{ 'echasnovski/mini.nvim', version = '*' },</code></td>
 86 |         </tr>
 87 |         <tr>
 88 |             <td rowspan=2>Standalone plugin</td>
 89 |             <td>Main</td> <td><code>{ 'echasnovski/mini.cursorword', version = false },</code></td>
 90 |         </tr>
 91 |         <tr>
 92 |             <td>Stable</td> <td><code>{ 'echasnovski/mini.cursorword', version = '*' },</code></td>
 93 |         </tr>
 94 |     </tbody>
 95 | </table>
 96 | </details>
 97 | 
 98 | <details>
 99 | <summary>With <a href="https://github.com/junegunn/vim-plug">junegunn/vim-plug</a></summary>
100 | <table>
101 |     <thead>
102 |         <tr>
103 |             <th>Github repo</th>
104 |             <th>Branch</th> <th>Code snippet</th>
105 |         </tr>
106 |     </thead>
107 |     <tbody>
108 |         <tr>
109 |             <td rowspan=2>'mini.nvim' library</td>
110 |             <td>Main</td> <td><code>Plug 'echasnovski/mini.nvim'</code></td>
111 |         </tr>
112 |         <tr>
113 |             <td>Stable</td> <td><code>Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }</code></td>
114 |         </tr>
115 |         <tr>
116 |             <td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>Plug 'echasnovski/mini.cursorword'</code></td>
117 |         </tr>
118 |         <tr>
119 |             <td>Stable</td> <td><code>Plug 'echasnovski/mini.cursorword', { 'branch': 'stable' }</code></td>
120 |         </tr>
121 |     </tbody>
122 | </table>
123 | </details>
124 | 
125 | <br>
126 | 
127 | **Important**: don't forget to call `require('mini.cursorword').setup()` to enable its functionality.
128 | 
129 | **Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
130 | - Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
131 | - Install plugin in other place with shorter path.
132 | 
133 | ## Default config
134 | 
135 | ```lua
136 | -- No need to copy this inside `setup()`. Will be used automatically.
137 | {
138 |   -- Delay (in ms) between when cursor moved and when highlighting appeared
139 |   delay = 100,
140 | }
141 | ```
142 | 
143 | ## Similar plugins
144 | 
145 | - [RRethy/vim-illuminate](https://github.com/RRethy/vim-illuminate)
146 | - [itchyny/vim-cursorword](https://github.com/itchyny/vim-cursorword)
147 | 


--------------------------------------------------------------------------------
/doc/mini-cursorword.txt:
--------------------------------------------------------------------------------
  1 | *mini.cursorword* Autohighlight word under cursor
  2 | *MiniCursorword*
  3 | 
  4 | MIT License Copyright (c) 2021 Evgeni Chasnovski
  5 | 
  6 | ==============================================================================
  7 | 
  8 | Features:
  9 | - Autohighlight word under cursor with customizable delay.
 10 | 
 11 | - Current word under cursor can be highlighted differently.
 12 | 
 13 | - Highlighting is triggered only if current cursor character is a |[:keyword:]|.
 14 | 
 15 | - Highlighting stops in insert and terminal modes.
 16 | 
 17 | - "Word under cursor" is meant as in Vim's |<cword>|: something user would
 18 |   get as 'iw' text object.
 19 | 
 20 | # Setup ~
 21 | 
 22 | This module needs a setup with `require('mini.cursorword').setup({})`
 23 | (replace `{}` with your `config` table). It will create global Lua table
 24 | `MiniCursorword` which you can use for scripting or manually (with
 25 | `:lua MiniCursorword.*`).
 26 | 
 27 | See |MiniCursorword.config| for `config` structure and default values.
 28 | 
 29 | You can override runtime config settings locally to buffer inside
 30 | `vim.b.minicursorword_config` which should have same structure as
 31 | `MiniCursorword.config`. See |mini.nvim-buffer-local-config| for more details.
 32 | 
 33 | # Highlight groups ~
 34 | 
 35 | * `MiniCursorword` - highlight group of a non-current cursor word.
 36 |   Default: plain underline.
 37 | 
 38 | * `MiniCursorwordCurrent` - highlight group of a current word under cursor.
 39 |   Default: links to `MiniCursorword` (so `:hi clear MiniCursorwordCurrent`
 40 |   will lead to showing `MiniCursorword` highlight group).
 41 |   Note: To not highlight it, use the following Lua code: >lua
 42 | 
 43 |   vim.api.nvim_set_hl(0, 'MiniCursorwordCurrent', {})
 44 | <
 45 | To change any highlight group, modify it directly with |:highlight|.
 46 | 
 47 | # Disabling ~
 48 | 
 49 | To disable core functionality, set `vim.g.minicursorword_disable` (globally) or
 50 | `vim.b.minicursorword_disable` (for a buffer) to `true`. Considering high
 51 | number of different scenarios and customization intentions, writing exact
 52 | rules for disabling module's functionality is left to user. See
 53 | |mini.nvim-disabling-recipes| for common recipes. Note: after disabling
 54 | there might be highlighting left; it will be removed after next
 55 | highlighting update.
 56 | 
 57 | Module-specific disabling:
 58 | - Don't show highlighting if cursor is on the word that is in a blocklist
 59 |   of current filetype. In this example, blocklist for "lua" is "local" and
 60 |   "require" words, for "javascript" - "import": >lua
 61 | 
 62 |   _G.cursorword_blocklist = function()
 63 |     local curword = vim.fn.expand('<cword>')
 64 |     local filetype = vim.bo.filetype
 65 | 
 66 |     -- Add any disabling global or filetype-specific logic here
 67 |     local blocklist = {}
 68 |     if filetype == 'lua' then
 69 |       blocklist = { 'local', 'require' }
 70 |     elseif filetype == 'javascript' then
 71 |       blocklist = { 'import' }
 72 |     end
 73 | 
 74 |     vim.b.minicursorword_disable = vim.tbl_contains(blocklist, curword)
 75 |   end
 76 | 
 77 |   -- Make sure to add this autocommand *before* calling module's `setup()`.
 78 |   vim.cmd('au CursorMoved * lua _G.cursorword_blocklist()')
 79 | <
 80 | ------------------------------------------------------------------------------
 81 |                                                         *MiniCursorword.setup()*
 82 |                         `MiniCursorword.setup`({config})
 83 | Module setup
 84 | 
 85 | Parameters ~
 86 | {config} `(table|nil)` Module config table. See |MiniCursorword.config|.
 87 | 
 88 | Usage ~
 89 | >lua
 90 |   require('mini.cursorword').setup() -- use default config
 91 |   -- OR
 92 |   require('mini.cursorword').setup({}) -- replace {} with your config table
 93 | <
 94 | ------------------------------------------------------------------------------
 95 |                                                          *MiniCursorword.config*
 96 |                             `MiniCursorword.config`
 97 | Module config
 98 | 
 99 | Default values:
100 | >lua
101 |   MiniCursorword.config = {
102 |     -- Delay (in ms) between when cursor moved and when highlighting appeared
103 |     delay = 100,
104 |   }
105 | <
106 | 
107 |  vim:tw=78:ts=8:noet:ft=help:norl:


--------------------------------------------------------------------------------
/lua/mini/cursorword.lua:
--------------------------------------------------------------------------------
  1 | --- *mini.cursorword* Autohighlight word under cursor
  2 | --- *MiniCursorword*
  3 | ---
  4 | --- MIT License Copyright (c) 2021 Evgeni Chasnovski
  5 | ---
  6 | --- ==============================================================================
  7 | ---
  8 | --- Features:
  9 | --- - Autohighlight word under cursor with customizable delay.
 10 | ---
 11 | --- - Current word under cursor can be highlighted differently.
 12 | ---
 13 | --- - Highlighting is triggered only if current cursor character is a |[:keyword:]|.
 14 | ---
 15 | --- - Highlighting stops in insert and terminal modes.
 16 | ---
 17 | --- - "Word under cursor" is meant as in Vim's |<cword>|: something user would
 18 | ---   get as 'iw' text object.
 19 | ---
 20 | --- # Setup ~
 21 | ---
 22 | --- This module needs a setup with `require('mini.cursorword').setup({})`
 23 | --- (replace `{}` with your `config` table). It will create global Lua table
 24 | --- `MiniCursorword` which you can use for scripting or manually (with
 25 | --- `:lua MiniCursorword.*`).
 26 | ---
 27 | --- See |MiniCursorword.config| for `config` structure and default values.
 28 | ---
 29 | --- You can override runtime config settings locally to buffer inside
 30 | --- `vim.b.minicursorword_config` which should have same structure as
 31 | --- `MiniCursorword.config`. See |mini.nvim-buffer-local-config| for more details.
 32 | ---
 33 | --- # Highlight groups ~
 34 | ---
 35 | --- * `MiniCursorword` - highlight group of a non-current cursor word.
 36 | ---   Default: plain underline.
 37 | ---
 38 | --- * `MiniCursorwordCurrent` - highlight group of a current word under cursor.
 39 | ---   Default: links to `MiniCursorword` (so `:hi clear MiniCursorwordCurrent`
 40 | ---   will lead to showing `MiniCursorword` highlight group).
 41 | ---   Note: To not highlight it, use the following Lua code: >lua
 42 | ---
 43 | ---   vim.api.nvim_set_hl(0, 'MiniCursorwordCurrent', {})
 44 | --- <
 45 | --- To change any highlight group, modify it directly with |:highlight|.
 46 | ---
 47 | --- # Disabling ~
 48 | ---
 49 | --- To disable core functionality, set `vim.g.minicursorword_disable` (globally) or
 50 | --- `vim.b.minicursorword_disable` (for a buffer) to `true`. Considering high
 51 | --- number of different scenarios and customization intentions, writing exact
 52 | --- rules for disabling module's functionality is left to user. See
 53 | --- |mini.nvim-disabling-recipes| for common recipes. Note: after disabling
 54 | --- there might be highlighting left; it will be removed after next
 55 | --- highlighting update.
 56 | ---
 57 | --- Module-specific disabling:
 58 | --- - Don't show highlighting if cursor is on the word that is in a blocklist
 59 | ---   of current filetype. In this example, blocklist for "lua" is "local" and
 60 | ---   "require" words, for "javascript" - "import": >lua
 61 | ---
 62 | ---   _G.cursorword_blocklist = function()
 63 | ---     local curword = vim.fn.expand('<cword>')
 64 | ---     local filetype = vim.bo.filetype
 65 | ---
 66 | ---     -- Add any disabling global or filetype-specific logic here
 67 | ---     local blocklist = {}
 68 | ---     if filetype == 'lua' then
 69 | ---       blocklist = { 'local', 'require' }
 70 | ---     elseif filetype == 'javascript' then
 71 | ---       blocklist = { 'import' }
 72 | ---     end
 73 | ---
 74 | ---     vim.b.minicursorword_disable = vim.tbl_contains(blocklist, curword)
 75 | ---   end
 76 | ---
 77 | ---   -- Make sure to add this autocommand *before* calling module's `setup()`.
 78 | ---   vim.cmd('au CursorMoved * lua _G.cursorword_blocklist()')
 79 | --- <
 80 | 
 81 | -- Module definition ==========================================================
 82 | local MiniCursorword = {}
 83 | local H = {}
 84 | 
 85 | --- Module setup
 86 | ---
 87 | ---@param config table|nil Module config table. See |MiniCursorword.config|.
 88 | ---
 89 | ---@usage >lua
 90 | ---   require('mini.cursorword').setup() -- use default config
 91 | ---   -- OR
 92 | ---   require('mini.cursorword').setup({}) -- replace {} with your config table
 93 | --- <
 94 | MiniCursorword.setup = function(config)
 95 |   -- Export module
 96 |   _G.MiniCursorword = MiniCursorword
 97 | 
 98 |   -- Setup config
 99 |   config = H.setup_config(config)
100 | 
101 |   -- Apply config
102 |   H.apply_config(config)
103 | 
104 |   -- Define behavior
105 |   H.create_autocommands()
106 | 
107 |   -- Create default highlighting
108 |   H.create_default_hl()
109 | end
110 | 
111 | --- Module config
112 | ---
113 | --- Default values:
114 | ---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
115 | MiniCursorword.config = {
116 |   -- Delay (in ms) between when cursor moved and when highlighting appeared
117 |   delay = 100,
118 | }
119 | --minidoc_afterlines_end
120 | 
121 | -- Module functionality =======================================================
122 | 
123 | -- Helper data ================================================================
124 | -- Module default config
125 | H.default_config = vim.deepcopy(MiniCursorword.config)
126 | 
127 | -- Delay timer
128 | H.timer = vim.loop.new_timer()
129 | 
130 | -- Information about last match highlighting (stored *per window*):
131 | -- - Key: windows' unique buffer identifiers.
132 | -- - Value: table with:
133 | --     - `id` field for match id (from `vim.fn.matchadd()`).
134 | --     - `word` field for matched word.
135 | H.window_matches = {}
136 | 
137 | -- Helper functionality =======================================================
138 | -- Settings -------------------------------------------------------------------
139 | H.setup_config = function(config)
140 |   H.check_type('config', config, 'table', true)
141 |   config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})
142 | 
143 |   H.check_type('delay', config.delay, 'number')
144 | 
145 |   return config
146 | end
147 | 
148 | H.apply_config = function(config)
149 |   MiniCursorword.config = config
150 | 
151 |   -- Make `setup()` to proper reset module
152 |   for _, m in ipairs(vim.fn.getmatches()) do
153 |     if vim.startswith(m.group, 'MiniCursorword') then vim.fn.matchdelete(m.id) end
154 |   end
155 | end
156 | 
157 | H.create_autocommands = function()
158 |   local gr = vim.api.nvim_create_augroup('MiniCursorword', {})
159 | 
160 |   local au = function(event, pattern, callback, desc)
161 |     vim.api.nvim_create_autocmd(event, { group = gr, pattern = pattern, callback = callback, desc = desc })
162 |   end
163 | 
164 |   au('CursorMoved', '*', H.auto_highlight, 'Auto highlight cursorword')
165 |   au({ 'InsertEnter', 'TermEnter', 'QuitPre' }, '*', H.auto_unhighlight, 'Auto unhighlight cursorword')
166 |   au('ModeChanged', '*:[^i]', H.auto_highlight, 'Auto highlight cursorword')
167 | 
168 |   au('ColorScheme', '*', H.create_default_hl, 'Ensure colors')
169 |   au('FileType', 'TelescopePrompt', function() vim.b.minicursorword_disable = true end, 'Disable locally')
170 | end
171 | 
172 | --stylua: ignore
173 | H.create_default_hl = function()
174 |   vim.api.nvim_set_hl(0, 'MiniCursorword',        { default = true, underline = true })
175 |   vim.api.nvim_set_hl(0, 'MiniCursorwordCurrent', { default = true, link = 'MiniCursorword' })
176 | end
177 | 
178 | H.is_disabled = function() return vim.g.minicursorword_disable == true or vim.b.minicursorword_disable == true end
179 | 
180 | H.get_config = function(config)
181 |   return vim.tbl_deep_extend('force', MiniCursorword.config, vim.b.minicursorword_config or {}, config or {})
182 | end
183 | 
184 | -- Autocommands ---------------------------------------------------------------
185 | H.auto_highlight = function()
186 |   -- Stop any possible previous delayed highlighting
187 |   H.timer:stop()
188 | 
189 |   -- Stop highlighting immediately if module is disabled when cursor is not on
190 |   -- 'keyword'
191 |   if not H.should_highlight() then return H.unhighlight() end
192 | 
193 |   -- Get current information
194 |   local win_id = vim.api.nvim_get_current_win()
195 |   local win_match = H.window_matches[win_id] or {}
196 |   local curword = H.get_cursor_word()
197 | 
198 |   -- Only immediately update highlighting of current word under cursor if
199 |   -- currently highlighted word equals one under cursor
200 |   if win_match.word == curword then
201 |     H.unhighlight(true)
202 |     H.highlight(true)
203 |     return
204 |   end
205 | 
206 |   -- Stop highlighting previous match (if it exists)
207 |   H.unhighlight()
208 | 
209 |   -- Delay highlighting
210 |   H.timer:start(
211 |     H.get_config().delay,
212 |     0,
213 |     vim.schedule_wrap(function()
214 |       -- Ensure that always only one word is highlighted
215 |       H.unhighlight()
216 |       H.highlight()
217 |     end)
218 |   )
219 | end
220 | 
221 | H.auto_unhighlight = function()
222 |   -- Stop any possible previous delayed highlighting
223 |   H.timer:stop()
224 |   H.unhighlight()
225 | end
226 | 
227 | -- Highlighting ---------------------------------------------------------------
228 | ---@param only_current boolean|nil Whether to forcefully highlight only current word
229 | ---   under cursor.
230 | ---@private
231 | H.highlight = function(only_current)
232 |   -- A modified version of https://stackoverflow.com/a/25233145
233 |   -- Using `matchadd()` instead of a simpler `:match` to tweak priority of
234 |   -- 'current word' highlighting: with `:match` it is higher than for
235 |   -- `incsearch` which is not convenient.
236 |   local win_id = vim.api.nvim_get_current_win()
237 |   if not vim.api.nvim_win_is_valid(win_id) then return end
238 | 
239 |   if not H.should_highlight() then return end
240 | 
241 |   H.window_matches[win_id] = H.window_matches[win_id] or {}
242 | 
243 |   -- Add match highlight for current word under cursor
244 |   local current_word_pattern = [[\k*\%#\k*]]
245 |   local match_id_current = vim.fn.matchadd('MiniCursorwordCurrent', current_word_pattern, -1)
246 |   H.window_matches[win_id].id_current = match_id_current
247 | 
248 |   -- Don't add main match id if not needed or if one is already present
249 |   if only_current or H.window_matches[win_id].id ~= nil then return end
250 | 
251 |   -- Add match highlight for non-current word under cursor. NOTEs:
252 |   -- - Using `\(...\)\@!` allows to not match current word.
253 |   -- - Using 'very nomagic' ('\V') allows not escaping.
254 |   -- - Using `\<` and `\>` matches whole word (and not as part).
255 |   local curword = H.get_cursor_word()
256 |   local pattern = string.format([[\(%s\)\@!\&\V\<%s\>]], current_word_pattern, curword)
257 |   local match_id = vim.fn.matchadd('MiniCursorword', pattern, -1)
258 | 
259 |   -- Store information about highlight
260 |   H.window_matches[win_id].id = match_id
261 |   H.window_matches[win_id].word = curword
262 | end
263 | 
264 | ---@param only_current boolean|nil Whether to remove highlighting only of current
265 | ---   word under cursor.
266 | ---@private
267 | H.unhighlight = function(only_current)
268 |   -- Don't do anything if there is no valid information to act upon
269 |   local win_id = vim.api.nvim_get_current_win()
270 |   local win_match = H.window_matches[win_id]
271 |   if not vim.api.nvim_win_is_valid(win_id) or win_match == nil then return end
272 | 
273 |   -- Use `pcall` because there is an error if match id is not present. It can
274 |   -- happen if something else called `clearmatches`.
275 |   pcall(vim.fn.matchdelete, win_match.id_current)
276 |   H.window_matches[win_id].id_current = nil
277 | 
278 |   if not only_current then
279 |     pcall(vim.fn.matchdelete, win_match.id)
280 |     H.window_matches[win_id] = nil
281 |   end
282 | end
283 | 
284 | H.should_highlight = function() return not H.is_disabled() and H.is_cursor_on_keyword() end
285 | 
286 | -- Utilities ------------------------------------------------------------------
287 | H.error = function(msg) error('(mini.cursorword) ' .. msg, 0) end
288 | 
289 | H.check_type = function(name, val, ref, allow_nil)
290 |   if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
291 |   H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
292 | end
293 | 
294 | H.is_cursor_on_keyword = function()
295 |   local col = vim.fn.col('.')
296 |   local curchar = vim.api.nvim_get_current_line():sub(col, col)
297 | 
298 |   -- Use `pcall()` to catch `E5108` (can happen in binary files, see #112)
299 |   local ok, match_res = pcall(vim.fn.match, curchar, '[[:keyword:]]')
300 |   return ok and match_res >= 0
301 | end
302 | 
303 | H.get_cursor_word = function() return vim.fn.escape(vim.fn.expand('<cword>'), [[\/]]) end
304 | 
305 | return MiniCursorword
306 | 


--------------------------------------------------------------------------------