From 25b630484023716977c3fe2790c13b41f9db9f30 Mon Sep 17 00:00:00 2001 From: Nimit Bhardwaj Date: Sat, 24 Feb 2018 15:44:51 +0530 Subject: API: nvim_get_commands() --- src/nvim/api/buffer.c | 21 +++++++++++++++++++++ src/nvim/api/private/helpers.c | 4 ++-- src/nvim/api/vim.c | 13 +++++++++++++ 3 files changed, 36 insertions(+), 2 deletions(-) (limited to 'src/nvim/api') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 023f434f9d..c4508a0c81 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -24,6 +24,7 @@ #include "nvim/syntax.h" #include "nvim/window.h" #include "nvim/undo.h" +#include "nvim/ex_docmd.h" #ifdef INCLUDE_GENERATED_DECLARATIONS # include "api/buffer.c.generated.h" @@ -478,6 +479,26 @@ 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. +/// +/// @param buffer Buffer handle. +/// @param opts Optional parameters, currently always +/// @param[out] err Error details, if any. +/// +/// @returns Array of dictionaries describing commands. +ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts, + Error *err) + FUNC_API_SINCE(4) +{ + buf_T *buf = find_buffer_by_handle(buffer, err); + if (!buf) { + return (Array)ARRAY_DICT_INIT; + } + return commands_array(buf); +} + /// Sets a buffer-scoped (b:) variable /// /// @param buffer Buffer handle diff --git a/src/nvim/api/private/helpers.c b/src/nvim/api/private/helpers.c index b922036893..03f1a882d3 100644 --- a/src/nvim/api/private/helpers.c +++ b/src/nvim/api/private/helpers.c @@ -701,7 +701,7 @@ 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); @@ -1149,7 +1149,7 @@ void api_set_error(Error *err, ErrorType errType, const char *format, ...) /// /// @param mode The abbreviation for the mode /// @param buf The buffer to get the mapping array. NULL for global -/// @returns An array of maparg() like dictionaries describing mappings +/// @returns Array of maparg()-like dictionaries describing mappings ArrayOf(Dictionary) keymap_array(String mode, buf_T *buf) { Array mappings = ARRAY_DICT_INIT; diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index df4912a51e..38e64fd6ed 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -959,6 +959,19 @@ ArrayOf(Dictionary) nvim_get_keymap(String mode) return keymap_array(mode, NULL); } +/// Gets a list of dictionaries describing global(non-buffer) commands. +/// +/// @param opts Holds the API Metadata describing what type of commands +/// are needed. +/// @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); +} + /// Returns a 2-tuple (Array), where item 0 is the current channel id and item /// 1 is the |api-metadata| map (Dictionary). /// -- cgit From 9fa7727ce047e8e2e13f9fbf60d5defe9cf45060 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Thu, 10 May 2018 23:37:56 +0200 Subject: API: nvim_get_commands(): always return keys - Always return all keys, with at least NIL value. - Require `opts` param to be {"builtin":false} - Validate `opts` param --- src/nvim/api/buffer.c | 28 +++++++++++++++++++++++----- src/nvim/api/private/helpers.c | 16 ++++++++-------- src/nvim/api/vim.c | 8 ++++---- 3 files changed, 35 insertions(+), 17 deletions(-) (limited to 'src/nvim/api') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index c4508a0c81..878c8aad87 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -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; diff --git a/src/nvim/api/private/helpers.c b/src/nvim/api/private/helpers.c index 03f1a882d3..17ee3ed711 100644 --- a/src/nvim/api/private/helpers.c +++ b/src/nvim/api/private/helpers.c @@ -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. diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 38e64fd6ed..065b8d1ce2 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -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 -- cgit From 738bffea2cbb810ad1d3a3aa5bfeb88392260a8a Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Fri, 11 May 2018 07:50:00 +0200 Subject: API: nvim_get_commands(): more attributes Support more :command attributes: -bang -bar -register --- src/nvim/api/buffer.c | 9 ++++----- src/nvim/api/vim.c | 10 ++++++---- 2 files changed, 10 insertions(+), 9 deletions(-) (limited to 'src/nvim/api') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 878c8aad87..19f92f002d 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -459,14 +459,13 @@ Integer nvim_buf_get_changedtick(Buffer buffer, Error *err) return buf->b_changedtick; } -/// Gets a list of dictionaries describing buffer-local mappings. -/// The "buffer" key in the returned dictionary reflects the buffer -/// handle where the mapping is present. +/// Gets a list of buffer-local |mapping| definitions. /// /// @param mode Mode short-name ("n", "i", "v", ...) /// @param buffer Buffer handle /// @param[out] err Error details, if any -/// @returns Array of maparg()-like dictionaries describing mappings +/// @returns Array of maparg()-like dictionaries describing mappings. +/// The "buffer" key holds the associated buffer handle. ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err) FUNC_API_SINCE(3) { @@ -479,7 +478,7 @@ ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err) return keymap_array(mode, buf); } -/// Gets a list of maps describing buffer-local |user-commands|. +/// Gets a list of buffer-local |user-commands|. /// /// @param buffer Buffer handle. /// @param opts Optional parameters. Currently only supports diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 065b8d1ce2..305cc1a43c 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -948,18 +948,20 @@ Dictionary nvim_get_mode(void) return rv; } -/// Gets a list of dictionaries describing global (non-buffer) mappings. -/// The "buffer" key in the returned dictionary is always zero. +/// Gets a list of global (non-buffer-local) |mapping| definitions. /// /// @param mode Mode short-name ("n", "i", "v", ...) -/// @returns Array of maparg()-like dictionaries describing mappings +/// @returns Array of maparg()-like dictionaries describing mappings. +/// The "buffer" key is always zero. ArrayOf(Dictionary) nvim_get_keymap(String mode) FUNC_API_SINCE(3) { return keymap_array(mode, NULL); } -/// Gets a list of maps describing global |user-commands|. +/// Gets a list of global (non-buffer-local) Ex commands. +/// +/// Currently only |user-commands| are supported, not builtin Ex commands. /// /// @param opts Optional parameters. Currently only supports /// {"builtin":false} -- cgit From cb6672853a0df3dbe5202621d818ef1c2da7432c Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Fri, 11 May 2018 20:59:53 +0200 Subject: API: nvim_get_commands(): builtin is irrelevant for buffer-local builtin commands are never buffer-local, so we can return empty for that case. --- src/nvim/api/buffer.c | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) (limited to 'src/nvim/api') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 19f92f002d..eda7fcd74c 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -481,8 +481,7 @@ ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err) /// Gets a list of buffer-local |user-commands|. /// /// @param buffer Buffer handle. -/// @param opts Optional parameters. Currently only supports -/// {"builtin":false} +/// @param opts Optional parameters. Currently not used. /// @param[out] err Error details, if any. /// /// @returns Array of dictionaries describing commands. @@ -490,27 +489,31 @@ ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts, Error *err) FUNC_API_SINCE(4) { + bool global = (buffer == -1); + bool builtin = false; + 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); + 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 (strequal("builtin", k.data)) { + builtin = v.data.boolean; } } - if (buffer == -1) { + if (global) { + if (builtin) { + api_set_error(err, kErrorTypeValidation, "builtin=true not implemented"); + return (Array)ARRAY_DICT_INIT; + } return commands_array(NULL); } buf_T *buf = find_buffer_by_handle(buffer, err); - if (!buf) { + if (builtin || !buf) { return (Array)ARRAY_DICT_INIT; } return commands_array(buf); -- cgit From 137eedb4edab1643b47282cce4ca07dd2ee42a63 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Fri, 11 May 2018 21:26:05 +0200 Subject: API: nvim_get_commands(): return Dictionary --- src/nvim/api/buffer.c | 17 ++++++++--------- src/nvim/api/vim.c | 10 +++++----- 2 files changed, 13 insertions(+), 14 deletions(-) (limited to 'src/nvim/api') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index eda7fcd74c..fa4ad27e60 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -467,7 +467,7 @@ Integer nvim_buf_get_changedtick(Buffer buffer, Error *err) /// @returns Array of maparg()-like dictionaries describing mappings. /// The "buffer" key holds the associated buffer handle. ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err) - FUNC_API_SINCE(3) + FUNC_API_SINCE(3) { buf_T *buf = find_buffer_by_handle(buffer, err); @@ -478,16 +478,15 @@ ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err) return keymap_array(mode, buf); } -/// Gets a list of buffer-local |user-commands|. +/// Gets a map of buffer-local |user-commands|. /// /// @param buffer Buffer handle. /// @param opts Optional parameters. Currently not used. /// @param[out] err Error details, if any. /// -/// @returns Array of dictionaries describing commands. -ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts, - Error *err) - FUNC_API_SINCE(4) +/// @returns Map of maps describing commands. +Dictionary nvim_buf_get_commands(Buffer buffer, Dictionary opts, Error *err) + FUNC_API_SINCE(4) { bool global = (buffer == -1); bool builtin = false; @@ -497,7 +496,7 @@ ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts, 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; + return (Dictionary)ARRAY_DICT_INIT; } if (strequal("builtin", k.data)) { builtin = v.data.boolean; @@ -507,14 +506,14 @@ ArrayOf(Dictionary) nvim_buf_get_commands(Buffer buffer, Dictionary opts, if (global) { if (builtin) { api_set_error(err, kErrorTypeValidation, "builtin=true not implemented"); - return (Array)ARRAY_DICT_INIT; + return (Dictionary)ARRAY_DICT_INIT; } return commands_array(NULL); } buf_T *buf = find_buffer_by_handle(buffer, err); if (builtin || !buf) { - return (Array)ARRAY_DICT_INIT; + return (Dictionary)ARRAY_DICT_INIT; } return commands_array(buf); } diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 305cc1a43c..7a951d4e67 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -954,12 +954,12 @@ Dictionary nvim_get_mode(void) /// @returns Array of maparg()-like dictionaries describing mappings. /// The "buffer" key is always zero. ArrayOf(Dictionary) nvim_get_keymap(String mode) - FUNC_API_SINCE(3) + FUNC_API_SINCE(3) { return keymap_array(mode, NULL); } -/// Gets a list of global (non-buffer-local) Ex commands. +/// Gets a map of global (non-buffer-local) Ex commands. /// /// Currently only |user-commands| are supported, not builtin Ex commands. /// @@ -967,9 +967,9 @@ ArrayOf(Dictionary) nvim_get_keymap(String mode) /// {"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) +/// @returns Map of maps describing commands. +Dictionary nvim_get_commands(Dictionary opts, Error *err) + FUNC_API_SINCE(4) { return nvim_buf_get_commands(-1, opts, err); } -- cgit