mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-08-29 18:41:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

API: nvim_get_commands(): always return keys

Browse Source 
- Always return all keys, with at least NIL value.
- Require `opts` param to be {"builtin":false}
- Validate `opts` param
This commit is contained in:
Justin M. Keyes
2018-05-10 23:37:56 +02:00
parent 25b6304840
commit 9fa7727ce0
5 changed files with 134 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/nvim/api/buffer.c
View File

@@ -479,12 +479,11 @@ ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err)
return keymap_array(mode, buf);
}
/// Gets a list of dictionaries describing buffer-local commands.
/// The "buffer" key in the returned dictionary reflects the buffer
/// handle where the command is present.
/// Gets a list of maps describing buffer-local |user-commands|.
///
/// @param buffer Buffer handle.
/// @param opts Optional parameters, currently always
/// @param buffer Buffer handle.
/// @param opts Optional parameters. Currently only supports
/// {"builtin":false}
/// @param[out] err Error details, if any.
///
/// @returns Array of dictionaries describing commands.
@@ -492,6 +491,25 @@ ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts,
Error *err)
FUNC_API_SINCE(4)
{
for (size_t i = 0; i < opts.size; i++) {
String k = opts.items[i].key;
Object v = opts.items[i].value;
if (!strequal("builtin", k.data)) {
api_set_error(err, kErrorTypeValidation, "unexpected key: %s",
k.data);
return (Array)ARRAY_DICT_INIT;
}
if (v.type != kObjectTypeBoolean || v.data.boolean != false) {
api_set_error(err, kErrorTypeValidation,
"builtin commands not supported yet");
return (Array)ARRAY_DICT_INIT;
}
}
if (buffer == -1) {
return commands_array(NULL);
}
buf_T *buf = find_buffer_by_handle(buffer, err);
if (!buf) {
return (Array)ARRAY_DICT_INIT;

16
src/nvim/api/private/helpers.c
View File

@@ -685,7 +685,7 @@ tabpage_T *find_tab_by_handle(Tabpage tabpage, Error *err)
String cchar_to_string(char c)
{
char buf[] = { c, NUL };
return (String) {
return (String){
.data = xmemdupz(buf, 1),
.size = (c != NUL) ? 1 : 0
};
@@ -701,13 +701,13 @@ String cchar_to_string(char c)
String cstr_to_string(const char *str)
{
if (str == NULL) {
return (String) STRING_INIT;
return (String)STRING_INIT;
}
size_t len = strlen(str);
return (String) {
.data = xmemdupz(str, len),
.size = len
return (String){
.data = xmemdupz(str, len),
.size = len,
};
}
@@ -722,7 +722,7 @@ String cstr_to_string(const char *str)
String cbuf_to_string(const char *buf, size_t size)
FUNC_ATTR_NONNULL_ALL
{
return (String) {
return (String){
.data = xmemdupz(buf, size),
.size = size
};
@@ -737,9 +737,9 @@ String cbuf_to_string(const char *buf, size_t size)
String cstr_as_string(char *str) FUNC_ATTR_PURE
{
if (str == NULL) {
return (String) STRING_INIT;
return (String)STRING_INIT;
}
return (String) { .data = str, .size = strlen(str) };
return (String){ .data = str, .size = strlen(str) };
}
/// Converts from type Object to a VimL value.

8
src/nvim/api/vim.c
View File

@@ -959,17 +959,17 @@ ArrayOf(Dictionary) nvim_get_keymap(String mode)
return keymap_array(mode, NULL);
}
/// Gets a list of dictionaries describing global(non-buffer) commands.
/// Gets a list of maps describing global |user-commands|.
///
/// @param opts Holds the API Metadata describing what type of commands
/// are needed.
/// @param opts Optional parameters. Currently only supports
/// {"builtin":false}
/// @param[out] err Error details, if any.
///
/// @returns Array of dictionaries describing commands.
ArrayOf(Dictionary) nvim_get_commands(Dictionary opts, Error *err)
FUNC_API_SINCE(4)
{
return commands_array(NULL);
return nvim_buf_get_commands(-1, opts, err);
}
/// Returns a 2-tuple (Array), where item 0 is the current channel id and item

79
src/nvim/ex_docmd.c
View File

@@ -9972,28 +9972,26 @@ bool cmd_can_preview(char_u *cmd)
/// Gets a list of maps describing user-commands defined for buffer `buf`
/// or defined globally if `buf` is NULL.
///
/// @param buf Buffer to inspect, or NULL to get global commands.
/// @param buf Buffer to inspect, or NULL to get global user-commands.
///
/// @return Array of dictionaries describing commands
ArrayOf(Dictionary) commands_array(buf_T *buf)
{
Array rv = ARRAY_DICT_INIT;
garray_T *gap;
if (buf == NULL) {
gap = &ucmds;
} else {
gap = &buf->b_ucmds;
}
Object obj = NIL;
char str[10];
garray_T *gap = (buf == NULL) ? &ucmds : &buf->b_ucmds;
for (int i = 0; i < gap->ga_len; i++) {
char arg[2] = { 0, 0 };
Dictionary d = ARRAY_DICT_INIT;
char Range[10] = "";
ucmd_T *cmd = USER_CMD_GA(gap, i);
// Name
PUT(d, "name", STRING_OBJ(cstr_to_string((char *)cmd->uc_name)));
PUT(d, "definition", STRING_OBJ(cstr_to_string((char *)cmd->uc_rep)));
PUT(d, "script_id", INTEGER_OBJ(cmd->uc_scriptID));
// Argument
// "nargs" key
switch (cmd->uc_argt & (EXTRA|NOSPC|NEEDARG)) {
case 0: arg[0] = '0'; break;
case(EXTRA): arg[0] = '*'; break;
@@ -10001,52 +9999,47 @@ ArrayOf(Dictionary) commands_array(buf_T *buf)
case(EXTRA|NEEDARG): arg[0] = '+'; break;
case(EXTRA|NOSPC|NEEDARG): arg[0] = '1'; break;
}
PUT(d, "nargs", STRING_OBJ(cstr_to_string((char *)arg)));
PUT(d, "nargs", STRING_OBJ(cstr_to_string(arg)));
// Definition
PUT(d, "definition", STRING_OBJ(cstr_to_string((char *)cmd->uc_rep)));
// Complete
char *cmd_compl = get_command_complete(cmd->uc_compl);
if (cmd_compl != NULL) {
PUT(d, "complete", STRING_OBJ(cstr_to_string(cmd_compl)));
}
PUT(d, "complete", (cmd_compl == NULL
? NIL : STRING_OBJ(cstr_to_string(cmd_compl))));
PUT(d, "complete_arg", cmd->uc_compl_arg == NULL
? NIL : STRING_OBJ(cstr_to_string((char *)cmd->uc_compl_arg)));
// Complete Arg
if (cmd->uc_compl_arg != NULL) {
PUT(d, "complete_arg",
STRING_OBJ(cstr_to_string((char *)cmd->uc_compl_arg)));
}
// Range
if (cmd->uc_argt & (RANGE|COUNT)) {
if (cmd->uc_argt & COUNT) {
// -count=N
snprintf((char *)Range, sizeof(Range), "%" PRId64 "c",
(int64_t)cmd->uc_def);
} else if (cmd->uc_argt & DFLALL) {
Range[0] = '%';
} else if (cmd->uc_def >= 0) {
// -range=N
snprintf((char *)Range, sizeof(Range), "%" PRId64 "",
(int64_t)cmd->uc_def);
obj = NIL;
if (cmd->uc_argt & COUNT) {
if (cmd->uc_def >= 0) {
snprintf(str, sizeof(str), "%" PRId64, (int64_t)cmd->uc_def);
obj = STRING_OBJ(cstr_to_string(str)); // -count=N
} else {
Range[0] = '.';
obj = STRING_OBJ(cstr_to_string("0")); // -count
}
PUT(d, "range", STRING_OBJ(cstr_to_string((char *)Range)));
}
PUT(d, "count", obj);
// Address
obj = NIL;
if (cmd->uc_argt & RANGE) {
if (cmd->uc_argt & DFLALL) {
obj = STRING_OBJ(cstr_to_string("%")); // -range=%
} else if (cmd->uc_def >= 0) {
snprintf(str, sizeof(str), "%" PRId64, (int64_t)cmd->uc_def);
obj = STRING_OBJ(cstr_to_string(str)); // -range=N
} else {
obj = STRING_OBJ(cstr_to_string(".")); // -range
}
}
PUT(d, "range", obj);
obj = NIL;
for (int j = 0; addr_type_complete[j].expand != -1; j++) {
if (addr_type_complete[j].expand != ADDR_LINES
&& addr_type_complete[j].expand == cmd->uc_addr_type) {
PUT(d, "addr", STRING_OBJ(cstr_to_string(addr_type_complete[j].name)));
obj = STRING_OBJ(cstr_to_string(addr_type_complete[j].name));
break;
}
}
// ScriptID
PUT(d, "script_id", INTEGER_OBJ(cmd->uc_scriptID));
PUT(d, "addr", obj);
ADD(rv, DICTIONARY_OBJ(d));
}