summaryrefslogtreecommitdiff
path: root/stowables-dotlocal/share/nvim/site/pack/manual/start/nvim-surround-v2.1.7/lua/nvim-surround/init.lua
blob: 95d184fad3e48382cf859839e27fa9cc903d4c3e (plain)
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
356
357
358
359
360
361
362
363
364
365
local buffer = require("nvim-surround.buffer")
local cache = require("nvim-surround.cache")
local config = require("nvim-surround.config")
local input = require("nvim-surround.input")
local utils = require("nvim-surround.utils")

local M = {}

-- Setup the plugin with user-defined options.
---@param user_opts user_options|nil The user options.
M.setup = function(user_opts)
    config.setup(user_opts)
end

-- Configure the plugin on a per-buffer basis.
---@param buffer_opts user_options|nil The buffer-local options.
M.buffer_setup = function(buffer_opts)
    config.buffer_setup(buffer_opts)
end

-- Add delimiters around the cursor, in insert mode.
---@param args { line_mode: boolean } Whether or not the delimiters should get put on new lines.
M.insert_surround = function(args)
    local char = input.get_char()
    local curpos = buffer.get_curpos()
    local delimiters = config.get_delimiters(char, args.line_mode)
    if not delimiters then
        return
    end

    buffer.insert_text(curpos, delimiters[2])
    buffer.insert_text(curpos, delimiters[1])
    buffer.set_curpos({ curpos[1] + #delimiters[1] - 1, curpos[2] + #delimiters[1][#delimiters[1]] })
    -- Indent the cursor to the correct level, if added line-wise
    curpos = buffer.get_curpos()
    config.get_opts().indent_lines(curpos[1], curpos[1] + #delimiters[1] + #delimiters[2] - 2)
    buffer.set_curpos(curpos)
    if args.line_mode then
        local lnum = buffer.get_curpos()[1]
        vim.cmd(lnum .. "left " .. vim.fn.indent(lnum + 1) + vim.fn.shiftwidth())
        buffer.set_curpos({ lnum, #buffer.get_line(lnum) + 1 })
    end
end

-- Holds the current position of the cursor, since calling opfunc will erase it.
M.normal_curpos = nil
-- Detects if plugin is currently prompting the user for a motion / delimiter.
M.pending_surround = false
-- Add delimiters around a motion.
---@param args { selection: selection, delimiters: delimiter_pair, line_mode: boolean }
---@return "g@"|nil
M.normal_surround = function(args)
    -- Call the operatorfunc if it has not been called yet
    if not args.selection then
        -- Clear the normal cache (since it was user-called)
        cache.normal = { line_mode = args.line_mode }
        M.normal_curpos = buffer.get_curpos()
        M.pending_surround = true

        vim.go.operatorfunc = "v:lua.require'nvim-surround'.normal_callback"
        return "g@"
    end

    local first_pos = args.selection.first_pos
    local last_pos = { args.selection.last_pos[1], args.selection.last_pos[2] + 1 }

    buffer.insert_text(last_pos, args.delimiters[2])
    buffer.insert_text(first_pos, args.delimiters[1])
    buffer.restore_curpos({
        first_pos = first_pos,
        old_pos = M.normal_curpos,
    })

    if args.line_mode then
        config.get_opts().indent_lines(first_pos[1], last_pos[1] + #args.delimiters[1] + #args.delimiters[2] - 2)
    end
    M.pending_surround = false
end

-- Add delimiters around a visual selection.
---@param args { line_mode: boolean, curpos: position }
M.visual_surround = function(args)
    -- Get a character and selection from the user
    local ins_char = input.get_char()

    if vim.fn.visualmode() == "V" then
        args.line_mode = true
    end
    local delimiters = config.get_delimiters(ins_char, args.line_mode)
    local first_pos, last_pos = buffer.get_mark("<"), buffer.get_mark(">")
    if not delimiters or not first_pos or not last_pos then
        return
    end

    if vim.fn.visualmode() == "\22" then -- Visual block mode case (add delimiters to every line)
        if vim.o.selection == "exclusive" then
            last_pos[2] = last_pos[2] - 1
        end
        -- Get (visually) what columns the start and end are located at
        local first_disp = vim.fn.strdisplaywidth(buffer.get_line(first_pos[1]):sub(1, first_pos[2] - 1)) + 1
        local last_disp = vim.fn.strdisplaywidth(buffer.get_line(last_pos[1]):sub(1, last_pos[2] - 1)) + 1
        -- Find the min/max for some variables, since visual blocks can either go diagonally or anti-diagonally
        local mn_disp, mx_disp = math.min(first_disp, last_disp), math.max(first_disp, last_disp)
        local mn_lnum, mx_lnum = math.min(first_pos[1], last_pos[1]), math.max(first_pos[1], last_pos[1])
        -- Surround each line with the delimiter pair, last to first (for indexing reasons)
        for lnum = mx_lnum, mn_lnum, -1 do
            local line = buffer.get_line(lnum)
            local index = buffer.get_last_byte({ lnum, 1 })[2]
            -- The current display count should be >= the desired one
            while vim.fn.strdisplaywidth(line:sub(1, index)) < mx_disp and index <= #line do
                index = buffer.get_last_byte({ lnum, index + 1 })[2]
            end
            -- Go to the end of the current character
            index = buffer.get_last_byte({ lnum, index })[2]
            buffer.insert_text({ lnum, index + 1 }, delimiters[2])
            index = 1
            -- The current display count should be <= the desired one
            while vim.fn.strdisplaywidth(line:sub(1, index - 1)) + 1 < mn_disp and index <= #line do
                index = buffer.get_last_byte({ lnum, index })[2] + 1
            end
            if vim.fn.strdisplaywidth(line:sub(1, index - 1)) + 1 > mn_disp then
                -- Go to the beginning of the previous character
                index = buffer.get_first_byte({ lnum, index - 1 })[2]
            end
            buffer.insert_text({ lnum, index }, delimiters[1])
        end
    else -- Regular visual mode case
        if vim.o.selection == "exclusive" then
            last_pos[2] = last_pos[2] - 1
        end

        last_pos = buffer.get_last_byte(last_pos)
        buffer.insert_text({ last_pos[1], last_pos[2] + 1 }, delimiters[2])
        buffer.insert_text(first_pos, delimiters[1])
    end

    config.get_opts().indent_lines(first_pos[1], last_pos[1] + #delimiters[1] + #delimiters[2] - 2)
    buffer.restore_curpos({
        first_pos = first_pos,
        old_pos = args.curpos,
    })
end

-- Delete a surrounding delimiter pair, if it exists.
---@param args { del_char: string, curpos: position }|nil
---@return "g@l"|nil
M.delete_surround = function(args)
    -- Call the operatorfunc if it has not been called yet
    if not args then
        -- Clear the delete cache (since it was user-called)
        cache.delete = {}

        vim.go.operatorfunc = "v:lua.require'nvim-surround'.delete_callback"
        return "g@l"
    end

    -- Get the selections to delete
    local selections = utils.get_nearest_selections(args.del_char, "delete")

    if selections then
        -- Delete the right selection first to ensure selection positions are correct
        buffer.delete_selection(selections.right)
        buffer.delete_selection(selections.left)
        config.get_opts().indent_lines(
            selections.left.first_pos[1],
            selections.left.first_pos[1] + selections.right.first_pos[1] - selections.left.last_pos[1]
        )
        buffer.restore_curpos({
            first_pos = selections.left.first_pos,
            old_pos = args.curpos,
        })
    end

    cache.set_callback("v:lua.require'nvim-surround'.delete_callback")
end

-- Change a surrounding delimiter pair, if it exists.
---@param args { curpos: position, del_char: string, add_delimiters: add_func, line_mode: boolean }
---@return "g@l"|nil
M.change_surround = function(args)
    -- Call the operatorfunc if it has not been called yet
    if not args.del_char or not args.add_delimiters then
        -- Clear the change cache (since it was user-called)
        cache.change = { line_mode = args.line_mode }

        vim.go.operatorfunc = "v:lua.require'nvim-surround'.change_callback"
        return "g@l"
    end

    buffer.set_curpos(args.curpos)
    -- Get the selections to change, as well as the delimiters to replace those selections
    local selections = utils.get_nearest_selections(args.del_char, "change")
    local delimiters = args.add_delimiters()
    if selections and delimiters then
        -- Avoid adding any, and remove any existing whitespace after the
        -- opening delimiter if only whitespace exists between it and the end
        -- of the line. Avoid adding or removing leading whitespace before the
        -- closing delimiter if only whitespace exists between it and the
        -- beginning of the line.

        local space_begin, space_end = buffer.get_line(selections.left.last_pos[1]):find("%s*$")
        if space_begin - 1 <= selections.left.last_pos[2] then -- Whitespace is adjacent to opening delimiter
            -- Trim trailing whitespace from opening delimiter
            delimiters[1][#delimiters[1]] = delimiters[1][#delimiters[1]]:gsub("%s+$", "")
            -- Grow selection end to include trailing whitespace, so it gets removed
            selections.left.last_pos[2] = space_end
        end

        space_begin, space_end = buffer.get_line(selections.right.first_pos[1]):find("^%s*")
        if space_end + 1 >= selections.right.first_pos[2] then -- Whitespace is adjacent to closing delimiter
            -- Trim leading whitespace from closing delimiter
            delimiters[2][1] = delimiters[2][1]:gsub("^%s+", "")
            -- Shrink selection beginning to exclude leading whitespace, so it remains unchanged
            selections.right.first_pos[2] = space_end + 1
        end

        -- Change the right selection first to ensure selection positions are correct
        buffer.change_selection(selections.right, delimiters[2])
        buffer.change_selection(selections.left, delimiters[1])
        buffer.restore_curpos({
            first_pos = selections.left.first_pos,
            old_pos = args.curpos,
        })

        if args.line_mode then
            local first_pos = selections.left.first_pos
            local last_pos = selections.right.last_pos

            config.get_opts().indent_lines(first_pos[1], last_pos[1] + #delimiters[1] + #delimiters[2] - 2)
        end
    end

    cache.set_callback("v:lua.require'nvim-surround'.change_callback")
end

--[====================================================================================================================[
                                                   Callback Functions
--]====================================================================================================================]

---@param mode "char"|"line"|"block"
M.normal_callback = function(mode)
    buffer.restore_curpos({ old_pos = M.normal_curpos })
    -- Adjust the ] mark if the operator was in line-mode, e.g. `ip` or `3j`
    if mode == "line" then
        local first_pos = buffer.get_mark("[")
        local last_pos = buffer.get_mark("]")
        if not (first_pos and last_pos) then
            M.pending_surround = false
            return
        end
        first_pos = { first_pos[1], 1 }
        last_pos = { last_pos[1], #buffer.get_line(last_pos[1]) }
        buffer.set_mark("[", first_pos)
        buffer.set_mark("]", last_pos)
    end
    -- Move the last position to the last byte of the character, if necessary
    ---@diagnostic disable-next-line
    buffer.set_mark("]", buffer.get_last_byte(buffer.get_mark("]")))

    buffer.adjust_mark("[")
    buffer.adjust_mark("]")
    local selection = {
        first_pos = buffer.get_mark("["),
        last_pos = buffer.get_mark("]"),
    }
    if not selection.first_pos or not selection.last_pos then
        M.pending_surround = false
        return
    end
    -- Highlight the range and set a timer to clear it if necessary
    local highlight = config.get_opts().highlight
    if highlight.duration then
        buffer.highlight_selection(selection)
        if highlight.duration > 0 then
            vim.defer_fn(buffer.clear_highlights, highlight.duration)
        end
    end
    -- Get a character input and the delimiters (if not cached)
    if not cache.normal.delimiters then
        local char = input.get_char()
        -- Get the delimiter pair based on the input character
        cache.normal.delimiters = config.get_delimiters(char, cache.normal.line_mode)
        if not cache.normal.delimiters then
            M.pending_surround = false
            buffer.clear_highlights()
            return
        end
    end
    -- Clear the highlights right after the action is no longer pending
    buffer.clear_highlights()

    -- Call the normal surround function with some arguments
    M.normal_surround({
        delimiters = cache.normal.delimiters,
        selection = selection,
        line_mode = cache.normal.line_mode,
    })
end

M.delete_callback = function()
    -- Save the current position of the cursor
    local curpos = buffer.get_curpos()
    -- Get a character input if not cached
    cache.delete.char = cache.delete.char or input.get_char()
    if not cache.delete.char then
        return
    end

    M.delete_surround({
        del_char = cache.delete.char,
        curpos = curpos,
    })
end

M.change_callback = function()
    -- Save the current position of the cursor
    local curpos = buffer.get_curpos()
    if not cache.change.del_char or not cache.change.add_delimiters then
        local del_char = config.get_alias(input.get_char())
        local change = config.get_change(del_char)
        local selections = utils.get_nearest_selections(del_char, "change")
        if not (del_char and change and selections) then
            return
        end

        -- Highlight the range and set a timer to clear it if necessary
        local highlight = config.get_opts().highlight
        if highlight.duration then
            buffer.highlight_selection(selections.left)
            buffer.highlight_selection(selections.right)
            if highlight.duration > 0 then
                vim.defer_fn(buffer.clear_highlights, highlight.duration)
            end
        end

        -- Get the new surrounding pair, querying the user for more input if no replacement is provided
        local ins_char, delimiters
        if change and change.replacement then
            delimiters = change.replacement()
        else
            ins_char = input.get_char()
            delimiters = config.get_delimiters(ins_char, cache.change.line_mode)
        end

        -- Clear the highlights after getting the replacement surround
        buffer.clear_highlights()
        if not delimiters then
            return
        end

        -- Set the cache
        cache.change = {
            del_char = del_char,
            add_delimiters = function()
                return delimiters
            end,
            line_mode = cache.change.line_mode,
        }
    end
    local args = vim.deepcopy(cache.change)
    args.curpos = curpos
    M.change_surround(args) ---@diagnostic disable-line: param-type-mismatch
end

return M