Repository navigation
Expand file tree
/
Copy pathjump.lua
More file actions
355 lines (302 loc) · 11.5 KB
/
Copy pathjump.lua
File metadata and controls
355 lines (302 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
-- MIT License Copyright (c) 2021 Evgeni Chasnovski, Adam Blažek
---@brief [[
--- Minimal and fast module for smarter jumping to a single character. Inspired
--- by 'rhysd/clever-f.vim'.
---
--- Features:
--- - Extend f, F, t, T to work on multiple lines.
--- - Repeat jump by pressing f, F, t, T again. It is reset when cursor moved
--- as a result of not jumping.
--- - Highlight (after customizable delay) of all possible target characters.
--- - Normal, Visual, and Operator-pending (with full dot-repeat) modes are
--- supported.
---
--- # Setup
---
--- This module needs a setup with `require('mini.jump').setup({})`
--- (replace `{}` with your `config` table). It will create global Lua table
--- `MiniJump` which you can use for scripting or manually (with
--- `:lua MiniJump.*`).
---
--- Default `config`:
--- <code>
--- {
--- -- Mappings. Use `''` (empty string) to disable one.
--- mappings = {
--- forward = 'f',
--- backward = 'F',
--- forward_till = 't',
--- backward_till = 'T',
--- repeat_jump = ';',
--- },
---
--- -- Delay (in ms) between jump and highlighting all possible jumps. Set to a
--- -- very big number (like 10^7) to virtually disable highlighting.
--- highlight_delay = 250,
--- }
--- </code>
--- #Highlight groups
---
--- - `MiniJump` - all possible cursor positions.
---
--- # Disabling
---
--- To disable core functionality, set `g:minijump_disable` (globally) or
--- `b:minijump_disable` (for a buffer) to `v:true`.
---@brief ]]
---@tag MiniJump mini.jump
-- Module and its helper --
local MiniJump = {}
local H = {}
--- Module setup
---
---@param config table: Module config table.
---@usage `require('mini.jump').setup({})` (replace `{}` with your `config` table)
function MiniJump.setup(config)
-- Export module
_G.MiniJump = MiniJump
-- Setup config
config = H.setup_config(config)
-- Apply config
H.apply_config(config)
-- Module behavior
vim.cmd([[autocmd CursorMoved * lua MiniJump.on_cursormoved()]])
vim.cmd([[autocmd BufLeave,InsertEnter * lua MiniJump.stop_jumping()]])
-- Highlight groups
vim.cmd([[hi default link MiniJump SpellRare]])
end
-- Module config --
MiniJump.config = {
mappings = {
forward = 'f',
backward = 'F',
forward_till = 't',
backward_till = 'T',
repeat_jump = ';',
},
-- Delay (in ms) between jump and highlighting all possible jumps. Set to a
-- very big number (like 10^7) to virtually disable highlighting.
highlight_delay = 250,
}
-- Module functionality --
--- Jump to target
---
--- Takes a string and jumps to its first occurrence in desrired direction.
---
---@param target string: The string to jump to.
---@param backward boolean: Whether to jump backward. Default: latest used value or `false`.
---@param till boolean: Whether to jump just before/after the match instead of exactly on target. Also ignore matches that don't have anything before/after them. Default: latest used value or `false`.
---@param n_times number: Number of times to perform a jump. Default: latest used value or 1.
function MiniJump.jump(target, backward, till, n_times)
if H.is_disabled() then
return
end
-- Cache inputs for future use
H.update_cache(target, backward, till, n_times)
-- Construct search and highlight patterns
local flags = H.cache.backward and 'Wb' or 'W'
local pattern, hl_pattern = [[\V%s]], [[\V%s]]
if H.cache.till then
if H.cache.backward then
pattern, hl_pattern = [[\V\(%s\)\@<=\.]], [[\V%s\.\@=]]
flags = ('%se'):format(flags)
else
pattern, hl_pattern = [[\V\.\(%s\)\@=]], [[\V\.\@<=%s]]
end
end
local escaped_target = vim.fn.escape(H.cache.target, [[\]])
pattern, hl_pattern = pattern:format(escaped_target), hl_pattern:format(escaped_target)
-- Delay highlighting after stopping previous one
H.timer:stop()
H.timer:start(
MiniJump.config.highlight_delay,
0,
vim.schedule_wrap(function()
H.highlight(hl_pattern)
end)
)
-- Make jump(s)
H.n_cursor_moved = 0
H.jumping = true
for _ = 1, H.cache.n_times do
vim.fn.search(pattern, flags)
end
-- Open enough folds to show jump
vim.cmd([[normal! zv]])
end
--- Make smart jump
---
--- If the last movement was a jump, perform another jump with the same target.
--- Otherwise, wait for a target input (via |getchar()|). Respects |v:count|.
---
---@param backward boolean: Whether to jump backward. Default: latest used value or `false`.
---@param till boolean: Whether to jump just before/after the match instead of exactly on target. Also ignore matches that don't have anything before/after them. Default: latest used value or `false`.
function MiniJump.smart_jump(backward, till)
if H.is_disabled() then
return
end
-- Jumping should stop after mode change. Use `mode(1)` to track 'omap' case.
local cur_mode = vim.fn.mode(1)
if H.cache.mode ~= cur_mode then
MiniJump.stop_jumping()
end
-- Ask for target only when needed
local target
if not H.jumping or H.cache.target == nil then
target = H.get_target()
end
H.update_cache(target, backward, till, vim.v.count1)
MiniJump.jump()
end
--- Make expression jump
---
--- Cache information about the jump and return string with command to perform
--- jump. Designed to be used inside Operator-pending mapping (see
--- |omap-info|). Always asks for target (via |getchar()|). Respects |v:count|.
---
---@param backward boolean: Whether to jump backward. Default: latest used value or `false`.
---@param till boolean: Whether to jump just before/after the match instead of exactly on target. Also ignore matches that don't have anything before/after them. Default: latest used value or `false`.
function MiniJump.expr_jump(backward, till)
if H.is_disabled() then
return ''
end
-- Always ask for `target` as this will be used only in operator-pending
-- mode. Dot-repeat will be implemented via expression-mapping.
H.update_cache(H.get_target(), backward, till, vim.v.count1)
return vim.api.nvim_replace_termcodes('v:<C-u>lua MiniJump.jump()<CR>', true, true, true)
end
--- Stop jumping
---
--- Removes highlights (if any) and forces the next smart jump to prompt for
--- the target. Automatically called on appropriate Neovim |events|.
function MiniJump.stop_jumping()
H.timer:stop()
H.jumping = false
H.unhighlight()
end
--- Act on |CursorMoved|.
function MiniJump.on_cursormoved()
-- Check `H.jumping` to avoid unneccessary actions on every CursorMoved
if H.jumping then
H.n_cursor_moved = H.n_cursor_moved + 1
-- Stop jumping only if `CursorMoved` was not a result of smart jump
if H.n_cursor_moved > 1 then
MiniJump.stop_jumping()
end
end
end
-- Helper data --
-- Module default config
H.default_config = MiniJump.config
-- Cache for the latest jump
H.cache = { mode = nil, target = nil, backward = false, till = false, n_times = 1 }
-- Indicator of whether inside smart jumping
H.jumping = false
-- Counter of number of CursorMoved events
H.n_cursor_moved = 0
-- Highlight 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()`).
-- - `pattern` field for highlighted pattern.
H.window_matches = {}
-- Settings --
function H.setup_config(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({
mappings = { config.mappings, 'table' },
['mappings.forward'] = { config.mappings.forward, 'string' },
['mappings.backward'] = { config.mappings.backward, 'string' },
['mappings.forward_till'] = { config.mappings.forward_till, 'string' },
['mappings.backward_till'] = { config.mappings.backward_till, 'string' },
highlight_delay = { config.highlight_delay, 'number' },
})
return config
end
function H.apply_config(config)
MiniJump.config = config
H.map('n', config.mappings.forward, [[<Cmd>lua MiniJump.smart_jump(false, false)<CR>]])
H.map('n', config.mappings.backward, [[<Cmd>lua MiniJump.smart_jump(true, false)<CR>]])
H.map('n', config.mappings.forward_till, [[<Cmd>lua MiniJump.smart_jump(false, true)<CR>]])
H.map('n', config.mappings.backward_till, [[<Cmd>lua MiniJump.smart_jump(true, true)<CR>]])
H.map('n', config.mappings.repeat_jump, [[<Cmd>lua MiniJump.jump()<CR>]])
H.map('x', config.mappings.forward, [[<Cmd>lua MiniJump.smart_jump(false, false)<CR>]])
H.map('x', config.mappings.backward, [[<Cmd>lua MiniJump.smart_jump(true, false)<CR>]])
H.map('x', config.mappings.forward_till, [[<Cmd>lua MiniJump.smart_jump(false, true)<CR>]])
H.map('x', config.mappings.backward_till, [[<Cmd>lua MiniJump.smart_jump(true, true)<CR>]])
H.map('x', config.mappings.repeat_jump, [[<Cmd>lua MiniJump.jump()<CR>]])
H.map('o', config.mappings.forward, [[v:lua.MiniJump.expr_jump(v:false, v:false)]], { expr = true })
H.map('o', config.mappings.backward, [[v:lua.MiniJump.expr_jump(v:true, v:false)]], { expr = true })
H.map('o', config.mappings.forward_till, [[v:lua.MiniJump.expr_jump(v:false, v:true)]], { expr = true })
H.map('o', config.mappings.backward_till, [[v:lua.MiniJump.expr_jump(v:true, v:true)]], { expr = true })
H.map('o', config.mappings.repeat_jump, [[v:lua.MiniJump.expr_jump()]], { expr = true })
end
function H.is_disabled()
return vim.g.minijump_disable == true or vim.b.minijump_disable == true
end
-- Highlighting --
function H.highlight(pattern)
local win_id = vim.api.nvim_get_current_win()
local match_info = H.window_matches[win_id]
-- Don't do anything if already highlighting input pattern
if match_info and match_info.pattern == pattern then
return
end
-- Stop highlighting possible previous pattern. Needed to adjust highlighting
-- when inside jumping but a different kind one. Example: first jump with
-- `till = false` and then, without jumping stop, jump to same character with
-- `till = true`. If this character is first on line, highlighting should change
H.unhighlight()
local match_id = vim.fn.matchadd('MiniJump', pattern)
H.window_matches[win_id] = { id = match_id, pattern = pattern }
end
function H.unhighlight()
-- Remove highlighting from all windows as jumping is intended to work only
-- in current window. This will work also from other (usually popup) window.
for win_id, match_info in pairs(H.window_matches) do
if vim.api.nvim_win_is_valid(win_id) then
-- 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, match_info.id, win_id)
H.window_matches[win_id] = nil
end
end
end
-- Various helpers --
function H.update_cache(target, backward, till, n_times)
H.cache.mode = vim.fn.mode(1)
-- Don't use `? and <1> or <2>` because it doesn't work when `<1>` is `false`
if target ~= nil then
H.cache.target = target
end
if backward ~= nil then
H.cache.backward = backward
end
if till ~= nil then
H.cache.till = till
end
if n_times ~= nil then
H.cache.n_times = n_times
end
end
function H.get_target()
local char = vim.fn.getchar()
-- Allow `<Esc>` to early exit
if char == 27 then
return
end
return vim.fn.nr2char(char)
end
function H.map(mode, key, rhs, opts)
if key == '' then
return
end
opts = vim.tbl_deep_extend('force', { noremap = true }, opts or {})
vim.api.nvim_set_keymap(mode, key, rhs, opts)
end
return MiniJump