mini.nvim/lua/mini/cursorword.lua at main · hbak/mini.nvim

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

-- Documentation ==============================================================

--- Autohighlight word under cursor with customizable delay. Current word under

--- cursor can be highlighted differently. Highlighting is triggered only if

--- current cursor character is a |[:keyword:]|. "Word under cursor" is meant

--- as in Vim's |<cword>|: something user would get as 'iw' text object.

--- Highlighting stops in insert and terminal modes.

---

--- # Setup~

---

--- This module needs a setup with `require('mini.cursorword').setup({})`

--- (replace `{}` with your `config` table). It will create global Lua table

--- `MiniCursorword` which you can use for scripting or manually (with

--- `:lua MiniCursorword.*`).

---

--- See |MiniCursorword.config| for `config` structure and default values.

---

--- You can override runtime config settings locally to buffer inside

--- `vim.b.minicursorword_config` which should have same structure as

--- `MiniCursorword.config`. See |mini.nvim-buffer-local-config| for more details.

---

--- # Highlight groups~

---

--- * `MiniCursorword` - highlight group of cursor word. Default: plain underline.

--- * `MiniCursorwordCurrent` - highlight group of a current word under

--- cursor. It will be displayed on top of `MiniCursorword`

--- (so `:hi clear MiniCursorwordCurrent` will lead to showing

--- `MiniCursorword` highlight group). Note: To not highlight it, use

--- `:hi! MiniCursorwordCurrent gui=nocombine guifg=NONE guibg=NONE` .

---

--- To change any highlight group, modify it directly with |:highlight|.

---

--- # Disabling~

---

--- To disable core functionality, set `g:minicursorword_disable` (globally) or

--- `b:minicursorword_disable` (for a buffer) to `v:true`. Considering high

--- number of different scenarios and customization intentions, writing exact

--- rules for disabling module's functionality is left to user. See

--- |mini.nvim-disabling-recipes| for common recipes. Note: after disabling

--- there might be highlighting left; it will be removed after next

--- highlighting update.

---

--- Module-specific disabling:

--- - Don't show highlighting if cursor is on the word that is in a blocklist

--- of current filetype. In this example, blocklist for "lua" is "local" and

--- "require" words, for "javascript" - "import":

--- >

--- _G.cursorword_blocklist = function()

--- local curword = vim.fn.expand('<cword>')

--- local filetype = vim.api.nvim_buf_get_option(0, 'filetype')

---

--- -- Add any disabling global or filetype-specific logic here

--- local blocklist = {}

--- if filetype == 'lua' then

--- blocklist = { 'local', 'require' }

--- elseif filetype == 'javascript' then

--- blocklist = { 'import' }

--- end

---

--- vim.b.minicursorword_disable = vim.tbl_contains(blocklist, curword)

--- end

---

--- -- Make sure to add this autocommand *before* calling module's `setup()`.

--- vim.cmd('au CursorMoved * lua _G.cursorword_blocklist()')

---@tag mini.cursorword

---@tag MiniCursorword

-- Module definition ==========================================================

local MiniCursorword = {}

local H = {}

--- Module setup

---

---@param config table Module config table. See |MiniCursorword.config|.

---

---@usage `require('mini.cursorword').setup({})` (replace `{}` with your `config` table)

MiniCursorword.setup = function(config)

-- TODO: Remove after support for Neovim<0.6 is dropped

if vim.fn.has('nvim-0.6') == 0 then

vim.notify(

'(mini.cursorword) Official support for Neovim<0.6 will soon be dropped. Update to a newer version of Neovim.'

)

end

-- Export module

_G.MiniCursorword = MiniCursorword

-- Setup config

config = H.setup_config(config)

-- Apply config

H.apply_config(config)

-- Module behavior

vim.api.nvim_exec(

[[augroup MiniCursorword

au!

au CursorMoved * lua MiniCursorword.auto_highlight()

au InsertEnter,TermEnter,QuitPre * lua MiniCursorword.auto_unhighlight()

au FileType TelescopePrompt let b:minicursorword_disable=v:true

augroup END]],

false

)

if vim.fn.exists('##ModeChanged') == 1 then

vim.api.nvim_exec(

-- Call `auto_highlight` on mode change to respect `minicursorword_disable`

[[augroup MiniCursorword

au ModeChanged *:[^i] lua MiniCursorword.auto_highlight()

augroup END]],

false

)

end

-- Create highlighting

vim.api.nvim_exec(

[[hi default MiniCursorword cterm=underline gui=underline

hi default link MiniCursorwordCurrent MiniCursorword]],

false

)

end

--- Module config

---

--- Default values:

---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)

MiniCursorword.config = {

-- Delay (in ms) between when cursor moved and when highlighting appeared

delay = 100,

}

--minidoc_afterlines_end

-- Module functionality =======================================================

--- Auto highlight word under cursor

---

--- Designed to be used with |autocmd|. No need to use it directly,

--- everything is setup in |MiniCursorword.setup|.

MiniCursorword.auto_highlight = function()

-- Stop any possible previous delayed highlighting

H.timer:stop()

-- Stop highlighting immediately if module is disabled when cursor is not on

-- 'keyword'

if H.is_disabled() or not H.is_cursor_on_keyword() then

H.unhighlight()

return

end

-- Get current information

local win_id = vim.api.nvim_get_current_win()

local win_match = H.window_matches[win_id] or {}

local curword = H.get_cursor_word()

-- Only immediately update highlighting of current word under cursor if

-- currently highlighted word equals one under cursor

if win_match.word == curword then

H.unhighlight(true)

H.highlight(true)

return

end

-- Stop highlighting previous match (if it exists)

H.unhighlight()

-- Delay highlighting

H.timer:start(

H.get_config().delay,

vim.schedule_wrap(function()

-- Ensure that always only one word is highlighted

H.unhighlight()

H.highlight()

end)

)

end

--- Auto unhighlight word under cursor

---

--- Designed to be used with |autocmd|. No need to use it directly, everything

--- is setup in |MiniCursorword.setup|.

MiniCursorword.auto_unhighlight = function()

-- Stop any possible previous delayed highlighting

H.timer:stop()

H.unhighlight()

end

-- Helper data ================================================================

-- Module default config

H.default_config = MiniCursorword.config

-- Delay timer

H.timer = vim.loop.new_timer()

-- Information about last match highlighting (stored *per window*):

-- - Key: windows' unique buffer identifiers.

-- - Value: table with:

-- - `id` field for match id (from `vim.fn.matchadd()`).

-- - `word` field for matched word.

H.window_matches = {}

-- Helper functionality =======================================================

-- Settings -------------------------------------------------------------------

H.setup_config = function(config)

-- General idea: if some table elements are not present in user-supplied

-- `config`, take them from default config

vim.validate({ config = { config, 'table', true } })

config = vim.tbl_deep_extend('force', H.default_config, config or {})

vim.validate({ delay = { config.delay, 'number' } })

return config

end

H.apply_config = function(config) MiniCursorword.config = config end

H.is_disabled = function() return vim.g.minicursorword_disable == true or vim.b.minicursorword_disable == true end

H.get_config = function(config)

return vim.tbl_deep_extend('force', MiniCursorword.config, vim.b.minicursorword_config or {}, config or {})

end

-- Highlighting ---------------------------------------------------------------

---@param only_current boolean Whether to forcefuly highlight only current word

--- under cursor.

---@private

H.highlight = function(only_current)

-- A modified version of https://stackoverflow.com/a/25233145

-- Using `matchadd()` instead of a simpler `:match` to tweak priority of

-- 'current word' highlighting: with `:match` it is higher than for

-- `incsearch` which is not convenient.

local win_id = vim.api.nvim_get_current_win()

if not vim.api.nvim_win_is_valid(win_id) then return end

H.window_matches[win_id] = H.window_matches[win_id] or {}

-- Add match highlight for current word under cursor with low priority

local match_id_current = vim.fn.matchadd('MiniCursorwordCurrent', [[\k*\%#\k*]], -1)

H.window_matches[win_id].id_current = match_id_current

-- Don't add main match id if not needed or if one is already present

if only_current or H.window_matches[win_id].id ~= nil then return end

-- Make highlighting for cursor word with pattern being 'very nomagic' ('\V')

-- and matching whole word ('\<' and '\>')

local curword = H.get_cursor_word()

local curpattern = string.format([[\V\<%s\>]], curword)

-- Add match highlight with even lower priority for current word to be on top

local match_id = vim.fn.matchadd('MiniCursorword', curpattern, -2)

-- Store information about highlight

H.window_matches[win_id].id = match_id

H.window_matches[win_id].word = curword

end

---@param only_current boolean Whether to remove highlighting only of current

--- word under cursor.

---@private

H.unhighlight = function(only_current)

-- Don't do anything if there is no valid information to act upon

local win_id = vim.api.nvim_get_current_win()

local win_match = H.window_matches[win_id]

if not vim.api.nvim_win_is_valid(win_id) or win_match == nil then return end

-- Use `pcall` because there is an error if match id is not present. It can

-- happen if something else called `clearmatches`.

pcall(vim.fn.matchdelete, win_match.id_current)

H.window_matches[win_id].id_current = nil

if not only_current then

pcall(vim.fn.matchdelete, win_match.id)

H.window_matches[win_id] = nil

end

H.is_cursor_on_keyword = function()

local col = vim.fn.col('.')

local curchar = vim.api.nvim_get_current_line():sub(col, col)

-- Use `pcall()` to catch `E5108` (can happen in binary files, see #112)

local ok, match_res = pcall(vim.fn.match, curchar, '[[:keyword:]]')

return ok and match_res >= 0

end

H.get_cursor_word = function() return vim.fn.escape(vim.fn.expand('<cword>'), [[\/]]) end

return MiniCursorword

FilesExpand file tree

cursorword.lua

Latest commit

History

cursorword.lua

File metadata and controls