Repository navigation
Expand file tree
/
Copy patharg_parser.lua
More file actions
436 lines (369 loc) · 10.9 KB
/
Copy patharg_parser.lua
File metadata and controls
436 lines (369 loc) · 10.9 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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
local lazy = require("diffview.lazy")
local oop = require("diffview.oop")
local utils = lazy.require("diffview.utils") ---@module "diffview.utils"
local M = {}
local short_flag_pat = { "^[-+](%a)=?(.*)" }
local long_flag_pat = { "^%-%-(%a[%a%d-]*)=?(.*)", "^%+%+(%a[%a%d-]*)=?(.*)" }
---@class ArgObject : diffview.Object
---@field flags table<string, string[]>
---@field args string[]
---@field post_args string[]
local ArgObject = oop.create_class("ArgObject")
---ArgObject constructor.
---@param flags table<string, string[]>
---@param args string[]
function ArgObject:init(flags, args, post_args)
self.flags = flags
self.args = args
self.post_args = post_args
end
---@class ArgObject.GetFlagSpec
---@field plain? boolean Never cast string values to booleans.
---@field expect_list? boolean Return a list of all defined values for the given flag.
---@field expect_string? boolean Inferred boolean values are changed to be empty strings.
---@field no_empty? boolean Return nil if the value is an empty string. Implies `expect_string`.
---@field expand? boolean Expand wildcards and special keywords (`:h expand()`).
---Get a flag value.
---@param names string|string[] Flag synonyms
---@param opt? ArgObject.GetFlagSpec
---@return string[]|string|boolean
function ArgObject:get_flag(names, opt)
opt = opt or {}
if opt.no_empty then
opt.expect_string = true
end
if type(names) ~= "table" then
names = { names }
end
local values = {}
for _, name in ipairs(names) do
if self.flags[name] then
utils.vec_push(values, unpack(self.flags[name]))
end
end
values = utils.tbl_fmap(values, function(v)
if opt.expect_string and v == "true" then
-- Undo inferred boolean values
if opt.no_empty then
return nil
end
v = ""
elseif not opt.plain and (v == "true" or v == "false") then
-- Cast to boolean
v = v == "true"
end
if opt.expand then
v = vim.fn.expand(v)
end
return v
end)
-- If a list isn't expected: return the last defined value for this flag.
return opt.expect_list and values or values[#values]
end
---@class FlagValueMap : diffview.Object
---@field map table<string, string[]|fun(name_lead: string, arg_lead: string): string[]>
local FlagValueMap = oop.create_class("FlagValueMap")
---FlagValueMap constructor
function FlagValueMap:init()
self.map = {}
end
---@param flag_synonyms string[]
---@param producer? string[]|fun(name_lead: string, arg_lead: string): string[]
function FlagValueMap:put(flag_synonyms, producer)
for _, flag in ipairs(flag_synonyms) do
local char = flag:sub(1, 1)
if char ~= "-" and char ~= "+" then
if #flag > 1 then
flag = "--" .. flag
else
flag = "-" .. flag
end
end
self.map[flag] = producer or { "true", "false" }
self.map[#self.map + 1] = flag
end
end
---Get list of possible values for a given flag.
---@param flag_name string
---@return string[]
function FlagValueMap:get(flag_name)
local char = flag_name:sub(1, 1)
if char ~= "-" and char ~= "+" then
if #flag_name > 1 then
flag_name = "--" .. flag_name
else
flag_name = "-" .. flag_name
end
end
if type(self.map[flag_name]) == "function" then
local is_short = utils.str_match(flag_name, short_flag_pat) ~= nil
return self.map[flag_name](flag_name .. (not is_short and "=" or ""), "")
end
return self.map[flag_name] --[[@as string[] ]]
end
---Get a list of all flag names.
---@return string[]
function FlagValueMap:get_all_names()
return utils.vec_slice(self.map)
end
---@param arg_lead string
---@return string[]?
function FlagValueMap:get_completion(arg_lead)
arg_lead = arg_lead or ""
local name
local is_short = utils.str_match(arg_lead, short_flag_pat) ~= nil
if is_short then
name = arg_lead:sub(1, 2)
arg_lead = arg_lead:match("..=?(.*)") or ""
else
name = arg_lead:gsub("=.*", "")
arg_lead = arg_lead:match("=(.*)") or ""
end
local name_lead = name .. (not is_short and "=" or "")
local values = self.map[name]
if type(values) == "function" then
values = values(name_lead, arg_lead)
end
if not values then
return nil
end
local items = {}
for _, v in ipairs(values) do
local e_lead, _ = vim.pesc(arg_lead)
if v:match(e_lead) then
items[#items + 1] = name_lead .. v
end
end
return items
end
---Parse args and create an ArgObject.
---@param args string[]
---@return ArgObject
function M.parse(args)
local flags = {}
local pre_args = {}
local post_args = {}
for i, arg in ipairs(args) do
if arg == "--" then
for j = i + 1, #args do
table.insert(post_args, args[j])
end
break
end
local flag, value
flag, value = utils.str_match(arg, short_flag_pat)
if flag then
value = (value == "") and "true" or value
if not flags[flag] then
flags[flag] = {}
end
table.insert(flags[flag], value)
goto continue
end
flag, value = utils.str_match(arg, long_flag_pat)
if flag then
value = (value == "") and "true" or value
if not flags[flag] then
flags[flag] = {}
end
table.insert(flags[flag], value)
goto continue
end
table.insert(pre_args, arg)
::continue::
end
return ArgObject(flags, pre_args, post_args)
end
---Split the line range from an EX command arg.
---@param arg string
---@return string range, string command
function M.split_ex_range(arg)
local idx = arg:match(".*()%A")
if not idx then
return "", arg
end
local slice = arg:sub(idx or 1)
idx = slice:match("[^']()%a")
if idx then
return arg:sub(1, (#arg - #slice) + idx - 1), slice:sub(idx)
end
return arg, ""
end
---@class CmdLineContext
---@field cmd_line string
---@field args string[] # The tokenized list of arguments.
---@field raw_args string[] # The unprocessed list of arguments. Contains syntax characters, such as quotes.
---@field arg_lead string # The leading part of the current argument.
---@field lead_quote string? # If present: the quote character used for the current argument.
---@field cur_pos integer # The cursor position in the command line.
---@field argidx integer # Index of the current argument.
---@field divideridx integer # The index of the end-of-options token. (default: math.huge)
---@field range string? # Ex command range.
---@field between boolean # The current position is between two arguments.
---@class arg_parser.scan.Opt
---@field cur_pos? integer # The current cursor position in the command line.
---@field allow_quoted? boolean # Everything between a pair of quotes should be treated as part of a single argument. (default: true)
---@field allow_ex_range? boolean # The command line may contain an EX command range. (default: false)
---Tokenize a command line string.
---@param cmd_line string
---@param opt? arg_parser.scan.Opt
---@return CmdLineContext
function M.scan(cmd_line, opt)
opt = vim.tbl_extend("keep", opt or {}, {
cur_pos = #cmd_line + 1,
allow_quoted = true,
allow_ex_range = false,
}) --[[@as arg_parser.scan.Opt ]]
local args = {}
local raw_args = {}
local arg_lead
local divideridx = math.huge
local argidx
local between = false
local cur_quote, lead_quote
local arg, raw_arg = "", ""
local h, i = -1, 1
while i <= #cmd_line do
local char = cmd_line:sub(i, i)
if not argidx and i > opt.cur_pos then
argidx = #args + 1
arg_lead = arg
lead_quote = cur_quote
if h < opt.cur_pos then
between = true
end
end
if char == "\\" then
arg = arg .. char
raw_arg = raw_arg .. char
if i < #cmd_line then
i = i + 1
arg = arg .. cmd_line:sub(i, i)
raw_arg = raw_arg .. cmd_line:sub(i, i)
end
h = i
elseif cur_quote then
if char == cur_quote then
cur_quote = nil
else
arg = arg .. char
end
raw_arg = raw_arg .. char
h = i
elseif opt.allow_quoted and (char == [[']] or char == [["]]) then
cur_quote = char
raw_arg = raw_arg .. char
h = i
elseif char:match("%s") then
if arg ~= "" then
table.insert(args, arg)
if arg == "--" and i - 1 < #cmd_line then
divideridx = #args
end
end
if raw_arg ~= "" then
table.insert(raw_args, raw_arg)
end
arg = ""
raw_arg = ""
-- Skip whitespace
i = i + cmd_line:sub(i, -1):match("^%s+()") - 2
else
arg = arg .. char
raw_arg = raw_arg .. char
h = i
end
i = i + 1
end
if #arg > 0 then
table.insert(args, arg)
table.insert(raw_args, raw_arg)
if not arg_lead then
arg_lead = arg
lead_quote = cur_quote
end
if arg == "--" and cmd_line:sub(#cmd_line, #cmd_line) ~= "-" then
divideridx = #args
end
end
if not argidx then
argidx = #args
if cmd_line:sub(#cmd_line, #cmd_line):match("%s") then
argidx = argidx + 1
end
end
local range
if #args > 0 then
if opt.allow_ex_range then
range, args[1] = M.split_ex_range(args[1])
_, raw_args[1] = M.split_ex_range(raw_args[1])
end
if args[1] == "" then
table.remove(args, 1)
table.remove(raw_args, 1)
argidx = math.max(argidx - 1, 1)
divideridx = math.max(divideridx - 1, 1)
end
end
return {
cmd_line = cmd_line,
args = args,
raw_args = raw_args,
arg_lead = arg_lead or "",
lead_quote = lead_quote,
cur_pos = opt.cur_pos,
argidx = argidx,
divideridx = divideridx,
range = range ~= "" and range or nil,
between = between,
}
end
---Filter completion candidates.
---@param arg_lead string
---@param candidates string[]
---@return string[]
function M.filter_candidates(arg_lead, candidates)
arg_lead, _ = vim.pesc(arg_lead)
return vim.tbl_filter(function(item)
return item:match(arg_lead)
end, candidates)
end
---Process completion candidates.
---@param candidates string[]
---@param ctx CmdLineContext
---@param input_cmp boolean? Completion for |input()|.
---@return string[]
function M.process_candidates(candidates, ctx, input_cmp)
if not candidates then
return {}
end
local cmd_lead = ""
local ex_lead = (ctx.lead_quote or "") .. ctx.arg_lead
if ctx.arg_lead and ctx.arg_lead:find("[^\\]%s") then
ex_lead = (ctx.lead_quote or "") .. ctx.arg_lead:match(".*[^\\]%s(.*)")
end
if input_cmp then
cmd_lead = ctx.cmd_line:sub(1, ctx.cur_pos - #ex_lead)
end
local ret = vim.tbl_map(function(v)
if v:match("^" .. vim.pesc(ctx.arg_lead)) then
return cmd_lead .. ex_lead .. v:sub(#ctx.arg_lead + 1)
elseif input_cmp then
return cmd_lead .. v
end
return (ctx.lead_quote or "") .. v
end, candidates)
return M.filter_candidates(cmd_lead .. ex_lead, ret)
end
function M.ambiguous_bool(value, default, truthy, falsy)
if vim.tbl_contains(truthy, value) then
return true
end
if vim.tbl_contains(falsy, value) then
return false
end
return default
end
M.ArgObject = ArgObject
M.FlagValueMap = FlagValueMap
return M