kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 18:55:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20364 from zeertzjq/parse-cmd-omit

Browse Source 
fix(api)!: nvim_parse_cmd omit "count" "range" "reg" if not supported
This commit is contained in:
bfredl 2022-09-30 09:59:45 +02:00 committed by GitHub
commit b414e9fdbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 72 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/doc/api.txt
View File

@ -1811,15 +1811,15 @@ nvim_parse_cmd({str}, {opts}) *nvim_parse_cmd()*
Return: ~
Dictionary containing command information, with these keys:
• cmd: (string) Command name.
• range: (array) Command <range>. Can have 0-2 elements depending on
how many items the range contains. Has no elements if command
doesn't accept a range or if no range was specified, one element if
only a single range item was specified and two elements if both
range items were specified.
• count: (number) Any |<count>| that was supplied to the command. -1
if command cannot take a count.
• reg: (string) The optional command |<register>|, if specified. Empty
string if not specified or if command cannot take a register.
• range: (array) (optional) Command range (|<line1>| |<line2>|).
Omitted if command doesn't accept a range. Otherwise, has no
elements if no range was specified, one element if only a single
range item was specified, or two elements if both range items were
specified.
• count: (number) (optional) Command |<count>|. Omitted if command
cannot take a count.
• reg: (string) (optional) Command |<register>|. Omitted if command
cannot take a register.
• bang: (boolean) Whether command contains a |<bang>| (!) modifier.
• args: (array) Command arguments.
• addr: (string) Value of |:command-addr|. Uses short name.

37
src/nvim/api/command.c
View File

@ -31,14 +31,15 @@
/// @param[out] err Error details, if any.
/// @return Dictionary containing command information, with these keys:
/// - cmd: (string) Command name.
/// - range: (array) Command <range>. Can have 0-2 elements depending on how many items the
/// range contains. Has no elements if command doesn't accept a range or if
/// no range was specified, one element if only a single range item was
/// specified and two elements if both range items were specified.
/// - count: (number) Any |<count>| that was supplied to the command. -1 if command cannot
/// take a count.
/// - reg: (string) The optional command |<register>|, if specified. Empty string if not
/// specified or if command cannot take a register.
/// - range: (array) (optional) Command range (|<line1>| |<line2>|).
/// Omitted if command doesn't accept a range.
/// Otherwise, has no elements if no range was specified, one element if
/// only a single range item was specified, or two elements if both range
/// items were specified.
/// - count: (number) (optional) Command |<count>|.
/// Omitted if command cannot take a count.
/// - reg: (string) (optional) Command |<register>|.
/// Omitted if command cannot take a register.
/// - bang: (boolean) Whether command contains a |<bang>| (!) modifier.
/// - args: (array) Command arguments.
/// - addr: (string) Value of |:command-addr|. Uses short name.
@ -142,15 +143,15 @@ Dictionary nvim_parse_cmd(String str, Dictionary opts, Error *err)
PUT(result, "cmd", CSTR_TO_OBJ((char *)get_command_name(NULL, ea.cmdidx)));
}
if ((ea.argt & EX_RANGE) && ea.addr_count > 0) {
if (ea.argt & EX_RANGE) {
Array range = ARRAY_DICT_INIT;
if (ea.addr_count > 1) {
ADD(range, INTEGER_OBJ(ea.line1));
if (ea.addr_count > 0) {
if (ea.addr_count > 1) {
ADD(range, INTEGER_OBJ(ea.line1));
}
ADD(range, INTEGER_OBJ(ea.line2));
}
ADD(range, INTEGER_OBJ(ea.line2));
PUT(result, "range", ARRAY_OBJ(range));
} else {
PUT(result, "range", ARRAY_OBJ(ARRAY_DICT_INIT));
}
if (ea.argt & EX_COUNT) {
@ -161,12 +162,12 @@ Dictionary nvim_parse_cmd(String str, Dictionary opts, Error *err)
} else {
PUT(result, "count", INTEGER_OBJ(0));
}
} else {
PUT(result, "count", INTEGER_OBJ(-1));
}
char reg[2] = { (char)ea.regname, NUL };
PUT(result, "reg", CSTR_TO_OBJ(reg));
if (ea.argt & EX_REGSTR) {
char reg[2] = { (char)ea.regname, NUL };
PUT(result, "reg", CSTR_TO_OBJ(reg));
}
PUT(result, "bang", BOOLEAN_OBJ(ea.forceit));
PUT(result, "args", ARRAY_OBJ(args));

66
test/functional/api/vim_spec.lua
View File

@ -3178,9 +3178,6 @@ describe('API', function()
cmd = 'echo',
args = { 'foo' },
bang = false,
range = {},
count = -1,
reg = '',
addr = 'none',
magic = {
file = false,
@ -3221,8 +3218,6 @@ describe('API', function()
args = { '/math.random/math.max/' },
bang = false,
range = { 4, 6 },
count = -1,
reg = '',
addr = 'line',
magic = {
file = false,
@ -3264,7 +3259,6 @@ describe('API', function()
bang = false,
range = { 1 },
count = 1,
reg = '',
addr = 'buf',
magic = {
file = false,
@ -3305,7 +3299,6 @@ describe('API', function()
args = {},
bang = false,
range = {},
count = -1,
reg = '+',
addr = 'line',
magic = {
@ -3340,6 +3333,45 @@ describe('API', function()
vertical = false,
}
}, meths.parse_cmd('put +', {}))
eq({
cmd = 'put',
args = {},
bang = false,
range = {},
reg = '',
addr = 'line',
magic = {
file = false,
bar = true
},
nargs = '0',
nextcmd = '',
mods = {
browse = false,
confirm = false,
emsg_silent = false,
filter = {
pattern = "",
force = false
},
hide = false,
horizontal = false,
keepalt = false,
keepjumps = false,
keepmarks = false,
keeppatterns = false,
lockmarks = false,
noautocmd = false,
noswapfile = false,
sandbox = false,
silent = false,
split = "",
tab = -1,
unsilent = false,
verbose = -1,
vertical = false,
}
}, meths.parse_cmd('put', {}))
end)
it('works with range, count and register', function()
eq({
@ -3389,8 +3421,6 @@ describe('API', function()
args = {},
bang = true,
range = {},
count = -1,
reg = '',
addr = 'line',
magic = {
file = true,
@ -3431,8 +3461,6 @@ describe('API', function()
args = { 'foo.txt' },
bang = false,
range = {},
count = -1,
reg = '',
addr = '?',
magic = {
file = true,
@ -3471,8 +3499,6 @@ describe('API', function()
args = { 'foo.txt' },
bang = false,
range = {},
count = -1,
reg = '',
addr = '?',
magic = {
file = true,
@ -3514,8 +3540,6 @@ describe('API', function()
args = { 'test', 'it' },
bang = true,
range = { 4, 6 },
count = -1,
reg = '',
addr = 'line',
magic = {
file = false,
@ -3556,8 +3580,6 @@ describe('API', function()
args = { 'a.txt' },
bang = false,
range = {},
count = -1,
reg = '',
addr = 'arg',
magic = {
file = true,
@ -3598,9 +3620,6 @@ describe('API', function()
cmd = 'MyCommand',
args = { 'test it' },
bang = false,
range = {},
count = -1,
reg = '',
addr = 'none',
magic = {
file = false,
@ -3692,8 +3711,6 @@ describe('API', function()
args = {'x'},
bang = true,
range = {3, 4},
count = -1,
reg = '',
addr = 'line',
magic = {
file = false,
@ -3731,6 +3748,11 @@ describe('API', function()
eq('', funcs.getreg('/'))
eq('', funcs.histget('search'))
end)
it('result can be used directly by nvim_cmd #20051', function()
eq("foo", meths.cmd(meths.parse_cmd('echo "foo"', {}), { output = true }))
meths.cmd(meths.parse_cmd("set cursorline", {}), {})
eq(true, meths.get_option_value("cursorline", {}))
end)
end)
describe('nvim_cmd', function()
it('works', function ()