From 7ce2d63fef6d377a41f1364c08a016d3997d9d28 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:08 -0300 Subject: [PATCH 01/19] API: Cleanup: Remove unnecessary NULL checks --- src/nvim/api/buffer.c | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index e73823e5c3..f66d65b849 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -115,9 +115,7 @@ StringArray buffer_get_slice(Buffer buffer, end: if (err->set) { for (size_t i = 0; i < rv.size; i++) { - if (rv.items[i].data != NULL) { - free(rv.items[i].data); - } + free(rv.items[i].data); } free(rv.items); @@ -240,10 +238,8 @@ void buffer_set_slice(Buffer buffer, } end: - for (uint32_t i = 0; i < new_len; i++) { - if (lines[i] != NULL) { - free(lines[i]); - } + for (size_t i = 0; i < new_len; i++) { + free(lines[i]); } free(lines); From 28eb3796b9d60e3c9e360b4cc7b2790c68a6db57 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:12 -0300 Subject: [PATCH 02/19] API: Bugfix: Check that error isn't set in buffer_get_line --- src/nvim/api/buffer.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index f66d65b849..09528b016b 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -56,7 +56,7 @@ String buffer_get_line(Buffer buffer, Integer index, Error *err) String rv = {.size = 0}; StringArray slice = buffer_get_slice(buffer, index, index, true, true, err); - if (slice.size) { + if (!err->set && slice.size) { rv = slice.items[0]; } From ee60683b9a5159e184c41f0dbd8121f082521019 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:14 -0300 Subject: [PATCH 03/19] API: Bugfix: Remove wrong increment statement from buffer_set_slice --- src/nvim/api/buffer.c | 1 - 1 file changed, 1 deletion(-) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 09528b016b..fd3c76cc39 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -219,7 +219,6 @@ void buffer_set_slice(Buffer buffer, // Same as with replacing lines[i] = NULL; - i++; extra++; } From c6483aa2fae07654f8a874a0c479916de33ec592 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:17 -0300 Subject: [PATCH 04/19] API: Bugfix: Fix loop condition in vim_list_runtime_paths --- src/nvim/api/vim.c | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 505844e651..5796d7bc0e 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -94,14 +94,12 @@ StringArray vim_list_runtime_paths(void) rtp++; } - // index - uint32_t i = 0; // Allocate memory for the copies rv.items = xmalloc(sizeof(String) * rv.size); // reset the position rtp = p_rtp; // Start copying - while (*rtp != NUL) { + for (size_t i = 0; i < rv.size && *rtp != NUL; i++) { rv.items[i].data = xmalloc(MAXPATHL); // Copy the path from 'runtimepath' to rv.items[i] int length = copy_option_part(&rtp, @@ -110,7 +108,6 @@ StringArray vim_list_runtime_paths(void) ","); assert(length >= 0); rv.items[i].size = (size_t)length; - i++; } return rv; From 677d30d7966dd2766bbf20665791c568dacc427a Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:19 -0300 Subject: [PATCH 05/19] API: Bugfix: Use 0-terminated string in vim_strwidth While the mb_string2cells function accepts a length parameter, it only seems to work properly with 0-terminated strings, since valgrind reports a conditional jump that depends on uninitialized values(means it reads after the string boundaries which could result in overflows or wrong results) --- src/nvim/api/vim.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 5796d7bc0e..1f335cf5e0 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -73,7 +73,10 @@ Integer vim_strwidth(String str, Error *err) return 0; } - return mb_string2cells((char_u *)str.data, (int)str.size); + char *buf = xstrndup(str.data, str.size); + Integer rv = mb_string2cells((char_u *)buf, -1); + free(buf); + return rv; } StringArray vim_list_runtime_paths(void) From 399a0e37405a0f68ef3373c8ad9bcfa94ee0f649 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:21 -0300 Subject: [PATCH 06/19] API: Bugfix: Terminate directory string in vim_change_directory Also check that the string length is not equal or greater than MAXPATHL. --- src/nvim/api/vim.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 1f335cf5e0..8cf4fb04d7 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -118,8 +118,14 @@ StringArray vim_list_runtime_paths(void) void vim_change_directory(String dir, Error *err) { + if (dir.size >= MAXPATHL) { + set_api_error("directory string is too long", err); + return; + } + char string[MAXPATHL]; strncpy(string, dir.data, dir.size); + string[dir.size] = NUL; try_start(); From 72e3125f452ae7224162da8e940e20b00680d41a Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:25 -0300 Subject: [PATCH 07/19] API: Refactor: Move non-public files to private subdirectory --- src/nvim/CMakeLists.txt | 17 ++++------------- src/nvim/api/buffer.c | 4 ++-- src/nvim/api/buffer.h | 2 +- src/nvim/api/{ => private}/defs.h | 0 src/nvim/api/{ => private}/helpers.c | 4 ++-- src/nvim/api/{ => private}/helpers.h | 2 +- src/nvim/api/tabpage.c | 4 ++-- src/nvim/api/tabpage.h | 2 +- src/nvim/api/vim.c | 4 ++-- src/nvim/api/vim.h | 2 +- src/nvim/api/window.c | 4 ++-- src/nvim/api/window.h | 2 +- src/nvim/os/msgpack_rpc.h | 2 +- 13 files changed, 20 insertions(+), 29 deletions(-) rename src/nvim/api/{ => private}/defs.h (100%) rename src/nvim/api/{ => private}/helpers.c (99%) rename src/nvim/api/{ => private}/helpers.h (98%) diff --git a/src/nvim/CMakeLists.txt b/src/nvim/CMakeLists.txt index d9ec65af86..ad45f3ad3b 100644 --- a/src/nvim/CMakeLists.txt +++ b/src/nvim/CMakeLists.txt @@ -6,17 +6,6 @@ file(GLOB API_HEADERS api/*.h) set(MSGPACK_RPC_HEADER ${PROJECT_SOURCE_DIR}/src/nvim/os/msgpack_rpc.h) set(MSGPACK_DISPATCH ${GENERATED_DIR}/msgpack_dispatch.c) -# Remove helpers.h from API_HEADERS since it doesn't contain public API -# functions -foreach(sfile ${API_HEADERS}) - get_filename_component(f ${sfile} NAME) - if(${f} MATCHES "^(helpers.h)$") - list(APPEND to_remove ${sfile}) - endif() -endforeach() -list(REMOVE_ITEM API_HEADERS ${to_remove}) -set(to_remove) - file(MAKE_DIRECTORY ${GENERATED_DIR}) add_custom_command(OUTPUT ${MSGPACK_DISPATCH} @@ -42,6 +31,7 @@ list(APPEND NEOVIM_SOURCES "${MSGPACK_DISPATCH}") file( GLOB OS_SOURCES os/*.c ) file( GLOB API_SOURCES api/*.c ) +file( GLOB API_PRIV_SOURCES api/private/*.c ) set(CONV_SRCS api.c @@ -110,13 +100,14 @@ list(APPEND NVIM_LINK_LIBRARIES ${CMAKE_THREAD_LIBS_INIT}) if(NOT DEFINED ENV{SKIP_EXEC}) - add_executable(nvim ${NEOVIM_SOURCES} ${OS_SOURCES} ${API_SOURCES}) + add_executable(nvim ${NEOVIM_SOURCES} ${OS_SOURCES} ${API_SOURCES} + ${API_PRIV_SOURCES}) target_link_libraries(nvim ${NVIM_LINK_LIBRARIES}) install(TARGETS nvim RUNTIME DESTINATION bin) endif() if(NOT DEFINED ENV{SKIP_UNITTEST}) add_library(nvim-test MODULE EXCLUDE_FROM_ALL ${NEOVIM_SOURCES} - ${OS_SOURCES} ${API_SOURCES}) + ${OS_SOURCES} ${API_SOURCES} ${API_PRIV_SOURCES}) target_link_libraries(nvim-test ${NVIM_LINK_LIBRARIES}) endif() diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index fd3c76cc39..9a4285d74c 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -4,8 +4,8 @@ #include #include "nvim/api/buffer.h" -#include "nvim/api/helpers.h" -#include "nvim/api/defs.h" +#include "nvim/api/private/helpers.h" +#include "nvim/api/private/defs.h" #include "nvim/vim.h" #include "nvim/buffer.h" #include "nvim/memline.h" diff --git a/src/nvim/api/buffer.h b/src/nvim/api/buffer.h index 5f39589679..2350f7f41d 100644 --- a/src/nvim/api/buffer.h +++ b/src/nvim/api/buffer.h @@ -4,7 +4,7 @@ #include #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" /// Gets the buffer line count /// diff --git a/src/nvim/api/defs.h b/src/nvim/api/private/defs.h similarity index 100% rename from src/nvim/api/defs.h rename to src/nvim/api/private/defs.h diff --git a/src/nvim/api/helpers.c b/src/nvim/api/private/helpers.c similarity index 99% rename from src/nvim/api/helpers.c rename to src/nvim/api/private/helpers.c index a193c8721e..a7d155382c 100644 --- a/src/nvim/api/helpers.c +++ b/src/nvim/api/private/helpers.c @@ -2,8 +2,8 @@ #include #include -#include "nvim/api/helpers.h" -#include "nvim/api/defs.h" +#include "nvim/api/private/helpers.h" +#include "nvim/api/private/defs.h" #include "nvim/vim.h" #include "nvim/buffer.h" #include "nvim/window.h" diff --git a/src/nvim/api/helpers.h b/src/nvim/api/private/helpers.h similarity index 98% rename from src/nvim/api/helpers.h rename to src/nvim/api/private/helpers.h index f93487d62f..da7e357d04 100644 --- a/src/nvim/api/helpers.h +++ b/src/nvim/api/private/helpers.h @@ -3,7 +3,7 @@ #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" #include "nvim/vim.h" #define set_api_error(message, err) \ diff --git a/src/nvim/api/tabpage.c b/src/nvim/api/tabpage.c index fc50723ba5..f4e5f2857a 100644 --- a/src/nvim/api/tabpage.c +++ b/src/nvim/api/tabpage.c @@ -4,8 +4,8 @@ #include "nvim/api/tabpage.h" #include "nvim/api/vim.h" -#include "nvim/api/defs.h" -#include "nvim/api/helpers.h" +#include "nvim/api/private/defs.h" +#include "nvim/api/private/helpers.h" Integer tabpage_get_window_count(Tabpage tabpage, Error *err) { diff --git a/src/nvim/api/tabpage.h b/src/nvim/api/tabpage.h index ef049fb644..abf4377ee4 100644 --- a/src/nvim/api/tabpage.h +++ b/src/nvim/api/tabpage.h @@ -4,7 +4,7 @@ #include #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" /// Gets the number of windows in a tabpage /// diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 8cf4fb04d7..cfde53b0a8 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -4,8 +4,8 @@ #include #include "nvim/api/vim.h" -#include "nvim/api/helpers.h" -#include "nvim/api/defs.h" +#include "nvim/api/private/helpers.h" +#include "nvim/api/private/defs.h" #include "nvim/api/buffer.h" #include "nvim/vim.h" #include "nvim/buffer.h" diff --git a/src/nvim/api/vim.h b/src/nvim/api/vim.h index 4ecc9fc2d0..2a712c19a1 100644 --- a/src/nvim/api/vim.h +++ b/src/nvim/api/vim.h @@ -4,7 +4,7 @@ #include #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" /// Send keys to vim input buffer, simulating user input. /// diff --git a/src/nvim/api/window.c b/src/nvim/api/window.c index 8e21034c40..73487d9c49 100644 --- a/src/nvim/api/window.c +++ b/src/nvim/api/window.c @@ -3,8 +3,8 @@ #include #include "nvim/api/window.h" -#include "nvim/api/defs.h" -#include "nvim/api/helpers.h" +#include "nvim/api/private/defs.h" +#include "nvim/api/private/helpers.h" #include "nvim/vim.h" #include "nvim/window.h" #include "nvim/screen.h" diff --git a/src/nvim/api/window.h b/src/nvim/api/window.h index 525b7f86c7..4c036ff5d7 100644 --- a/src/nvim/api/window.h +++ b/src/nvim/api/window.h @@ -4,7 +4,7 @@ #include #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" /// Gets the current buffer in a window /// diff --git a/src/nvim/os/msgpack_rpc.h b/src/nvim/os/msgpack_rpc.h index 0e9d474d8d..0f644273cd 100644 --- a/src/nvim/os/msgpack_rpc.h +++ b/src/nvim/os/msgpack_rpc.h @@ -6,7 +6,7 @@ #include -#include "nvim/api/defs.h" +#include "nvim/api/private/defs.h" /// Validates the basic structure of the msgpack-rpc call and fills `res` /// with the basic response structure. From 7dfc7bc2e17151dc545c3f2f339515c1b946e586 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:28 -0300 Subject: [PATCH 08/19] API: Refactor: Implement api/handle module This module will be used to implement remote management of objects through the API. Object types to be registered must have a `uint64_t` field named 'handle'. --- src/nvim/api/private/handle.c | 31 +++++++++++++++++++++++++++++++ src/nvim/api/private/handle.h | 14 ++++++++++++++ src/nvim/map.c | 1 + src/nvim/map.h | 1 + src/nvim/os_unix.c | 2 ++ 5 files changed, 49 insertions(+) create mode 100644 src/nvim/api/private/handle.c create mode 100644 src/nvim/api/private/handle.h diff --git a/src/nvim/api/private/handle.c b/src/nvim/api/private/handle.c new file mode 100644 index 0000000000..3bf519bc58 --- /dev/null +++ b/src/nvim/api/private/handle.c @@ -0,0 +1,31 @@ +#include + +#include "nvim/vim.h" +#include "nvim/map.h" +#include "nvim/api/private/handle.h" + +#define HANDLE_INIT(name) name##_handles = map_new(uint64_t)() + +#define HANDLE_IMPL(type, name) \ + static Map(uint64_t) *name##_handles = NULL; \ + \ + type *handle_get_##name(uint64_t handle) \ + { \ + return map_get(uint64_t)(name##_handles, handle); \ + } \ + \ + void handle_register_##name(type *name) \ + { \ + assert(!name->handle); \ + name->handle = next_handle++; \ + map_put(uint64_t)(name##_handles, name->handle, name); \ + } \ + \ + void handle_unregister_##name(type *name) \ + { \ + map_del(uint64_t)(name##_handles, name->handle); \ + } + +void handle_init() +{ +} diff --git a/src/nvim/api/private/handle.h b/src/nvim/api/private/handle.h new file mode 100644 index 0000000000..b9ed507ce9 --- /dev/null +++ b/src/nvim/api/private/handle.h @@ -0,0 +1,14 @@ +#ifndef NVIM_API_HANDLE_H +#define NVIM_API_HANDLE_H + +#include "nvim/vim.h" + +#define HANDLE_DECLS(type, name) \ + type *handle_get_##name(uint64_t handle); \ + void handle_register_##name(type *name); \ + void handle_unregister_##name(type *name); + +void handle_init(void); + +#endif // NVIM_API_HANDLE_H + diff --git a/src/nvim/map.c b/src/nvim/map.c index 28fd0af61c..559a5f261a 100644 --- a/src/nvim/map.c +++ b/src/nvim/map.c @@ -85,3 +85,4 @@ MAP_IMPL(cstr_t) MAP_IMPL(ptr_t) +MAP_IMPL(uint64_t) diff --git a/src/nvim/map.h b/src/nvim/map.h index ae47561deb..dba56dc5aa 100644 --- a/src/nvim/map.h +++ b/src/nvim/map.h @@ -21,6 +21,7 @@ MAP_DECLS(cstr_t) MAP_DECLS(ptr_t) +MAP_DECLS(uint64_t) #define map_new(T) map_##T##_new #define map_free(T) map_##T##_free diff --git a/src/nvim/os_unix.c b/src/nvim/os_unix.c index 52627b6a8b..e0b838ed26 100644 --- a/src/nvim/os_unix.c +++ b/src/nvim/os_unix.c @@ -27,6 +27,7 @@ #include +#include "nvim/api/private/handle.h" #include "nvim/vim.h" #include "nvim/os_unix.h" #include "nvim/buffer.h" @@ -542,6 +543,7 @@ int mch_nodetype(char_u *name) void mch_early_init() { + handle_init(); time_init(); } From ed99198ff1a3c2b6aad88b03e838a1337f83c4dc Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:30 -0300 Subject: [PATCH 09/19] API: Refactor: Register/unregister created/destroyed buffers - Add the 'handle' field to `buf_T` - Add declare/implement functions for registering/unregistering/retrieving buffers - Register/unregister buffers when they are created/destroyed. --- src/nvim/api/private/handle.c | 5 +++++ src/nvim/api/private/handle.h | 4 ++++ src/nvim/buffer.c | 3 +++ src/nvim/buffer_defs.h | 1 + 4 files changed, 13 insertions(+) diff --git a/src/nvim/api/private/handle.c b/src/nvim/api/private/handle.c index 3bf519bc58..97f5cd88b5 100644 --- a/src/nvim/api/private/handle.c +++ b/src/nvim/api/private/handle.c @@ -26,6 +26,11 @@ map_del(uint64_t)(name##_handles, name->handle); \ } +static uint64_t next_handle = 1; + +HANDLE_IMPL(buf_T, buffer) + void handle_init() { + HANDLE_INIT(buffer); } diff --git a/src/nvim/api/private/handle.h b/src/nvim/api/private/handle.h index b9ed507ce9..846b20dff2 100644 --- a/src/nvim/api/private/handle.h +++ b/src/nvim/api/private/handle.h @@ -2,13 +2,17 @@ #define NVIM_API_HANDLE_H #include "nvim/vim.h" +#include "nvim/buffer_defs.h" #define HANDLE_DECLS(type, name) \ type *handle_get_##name(uint64_t handle); \ void handle_register_##name(type *name); \ void handle_unregister_##name(type *name); +HANDLE_DECLS(buf_T, buffer) + void handle_init(void); + #endif // NVIM_API_HANDLE_H diff --git a/src/nvim/buffer.c b/src/nvim/buffer.c index ffb62add3c..7c50b1721c 100644 --- a/src/nvim/buffer.c +++ b/src/nvim/buffer.c @@ -26,6 +26,7 @@ #include +#include "nvim/api/private/handle.h" #include "nvim/vim.h" #include "nvim/buffer.h" #include "nvim/charset.h" @@ -538,6 +539,7 @@ void buf_freeall(buf_T *buf, int flags) */ static void free_buffer(buf_T *buf) { + handle_unregister_buffer(buf); free_buffer_stuff(buf, TRUE); unref_var_dict(buf->b_vars); aubuflocal_remove(buf); @@ -1362,6 +1364,7 @@ buflist_new ( } if (buf != curbuf || curbuf == NULL) { buf = xcalloc(1, sizeof(buf_T)); + handle_register_buffer(buf); /* init b: variables */ buf->b_vars = dict_alloc(); init_var_dict(buf->b_vars, &buf->b_bufvar, VAR_SCOPE); diff --git a/src/nvim/buffer_defs.h b/src/nvim/buffer_defs.h index d658da9502..6634ba72a6 100644 --- a/src/nvim/buffer_defs.h +++ b/src/nvim/buffer_defs.h @@ -401,6 +401,7 @@ typedef struct { */ struct file_buffer { + uint64_t handle; // unique identifier for the buffer memline_T b_ml; /* associated memline (also contains line count) */ From 20848c4064fc82c160d68770b2e64f5115f0bf60 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:33 -0300 Subject: [PATCH 10/19] API: Refactor: Register/unregister created/destroyed windows - Add the 'handle' field to `win_T` - Add declare/implement functions for registering/unregistering/retrieving windows - Register/unregister windows when they are created/destroyed. --- src/nvim/api/private/handle.c | 2 ++ src/nvim/api/private/handle.h | 1 + src/nvim/buffer_defs.h | 1 + src/nvim/window.c | 4 ++++ 4 files changed, 8 insertions(+) diff --git a/src/nvim/api/private/handle.c b/src/nvim/api/private/handle.c index 97f5cd88b5..3dfe05d59f 100644 --- a/src/nvim/api/private/handle.c +++ b/src/nvim/api/private/handle.c @@ -29,8 +29,10 @@ static uint64_t next_handle = 1; HANDLE_IMPL(buf_T, buffer) +HANDLE_IMPL(win_T, window) void handle_init() { HANDLE_INIT(buffer); + HANDLE_INIT(window); } diff --git a/src/nvim/api/private/handle.h b/src/nvim/api/private/handle.h index 846b20dff2..29c80e10d4 100644 --- a/src/nvim/api/private/handle.h +++ b/src/nvim/api/private/handle.h @@ -10,6 +10,7 @@ void handle_unregister_##name(type *name); HANDLE_DECLS(buf_T, buffer) +HANDLE_DECLS(win_T, window) void handle_init(void); diff --git a/src/nvim/buffer_defs.h b/src/nvim/buffer_defs.h index 6634ba72a6..68f70d7bf3 100644 --- a/src/nvim/buffer_defs.h +++ b/src/nvim/buffer_defs.h @@ -840,6 +840,7 @@ struct matchitem { * All row numbers are relative to the start of the window, except w_winrow. */ struct window_S { + uint64_t handle; buf_T *w_buffer; /* buffer we are a window into (used often, keep it the first item!) */ diff --git a/src/nvim/window.c b/src/nvim/window.c index 851e9cead7..a0a325f950 100644 --- a/src/nvim/window.c +++ b/src/nvim/window.c @@ -6,6 +6,7 @@ * See README.txt for an overview of the Vim source code. */ +#include "nvim/api/private/handle.h" #include "nvim/vim.h" #include "nvim/window.h" #include "nvim/buffer.h" @@ -3568,6 +3569,7 @@ static win_T *win_alloc(win_T *after, int hidden) * allocate window structure and linesizes arrays */ win_T *new_wp = xcalloc(1, sizeof(win_T)); + handle_register_window(new_wp); win_alloc_lines(new_wp); /* init w: variables */ @@ -3583,6 +3585,7 @@ static win_T *win_alloc(win_T *after, int hidden) */ if (!hidden) win_append(after, new_wp); + new_wp->w_wincol = 0; new_wp->w_width = Columns; @@ -3618,6 +3621,7 @@ win_free ( buf_T *buf; wininfo_T *wip; + handle_unregister_window(wp); clearFolding(wp); /* reduce the reference count to the argument list. */ From 5fdf854f78eb1a87acb2d28b3d941d988bd1b74e Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:35 -0300 Subject: [PATCH 11/19] API: Refactor: Register/unregister created/destroyed tabpages - Add the 'handle' field to `tabpage_T` - Add declare/implement functions for registering/unregistering/retrieving tabpages - Register/unregister tabpages when they are created/destroyed. --- src/nvim/api/private/handle.c | 2 ++ src/nvim/api/private/handle.h | 1 + src/nvim/buffer_defs.h | 1 + src/nvim/window.c | 2 ++ 4 files changed, 6 insertions(+) diff --git a/src/nvim/api/private/handle.c b/src/nvim/api/private/handle.c index 3dfe05d59f..88d176fccb 100644 --- a/src/nvim/api/private/handle.c +++ b/src/nvim/api/private/handle.c @@ -30,9 +30,11 @@ static uint64_t next_handle = 1; HANDLE_IMPL(buf_T, buffer) HANDLE_IMPL(win_T, window) +HANDLE_IMPL(tabpage_T, tabpage) void handle_init() { HANDLE_INIT(buffer); HANDLE_INIT(window); + HANDLE_INIT(tabpage); } diff --git a/src/nvim/api/private/handle.h b/src/nvim/api/private/handle.h index 29c80e10d4..27df453233 100644 --- a/src/nvim/api/private/handle.h +++ b/src/nvim/api/private/handle.h @@ -11,6 +11,7 @@ HANDLE_DECLS(buf_T, buffer) HANDLE_DECLS(win_T, window) +HANDLE_DECLS(tabpage_T, tabpage) void handle_init(void); diff --git a/src/nvim/buffer_defs.h b/src/nvim/buffer_defs.h index 68f70d7bf3..0a24280b4a 100644 --- a/src/nvim/buffer_defs.h +++ b/src/nvim/buffer_defs.h @@ -738,6 +738,7 @@ struct diffblock_S { */ typedef struct tabpage_S tabpage_T; struct tabpage_S { + uint64_t handle; tabpage_T *tp_next; /* next tabpage or NULL */ frame_T *tp_topframe; /* topframe for the windows */ win_T *tp_curwin; /* current window in this Tab page */ diff --git a/src/nvim/window.c b/src/nvim/window.c index a0a325f950..534805b766 100644 --- a/src/nvim/window.c +++ b/src/nvim/window.c @@ -2845,6 +2845,7 @@ void win_init_size(void) static tabpage_T *alloc_tabpage(void) { tabpage_T *tp = xcalloc(1, sizeof(tabpage_T)); + handle_register_tabpage(tp); /* init t: variables */ tp->tp_vars = dict_alloc(); @@ -2859,6 +2860,7 @@ void free_tabpage(tabpage_T *tp) { int idx; + handle_unregister_tabpage(tp); diff_clear(tp); for (idx = 0; idx < SNAP_COUNT; ++idx) clear_snapshot(tp, idx); From 92307201b51c399e8109c91cc131ff3602389db1 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:38 -0300 Subject: [PATCH 12/19] API: Refactor: Generalize buffer, window and tabpage types/functions - Extract remote types definitions into a macro - Extract msgpack_rpc helper functions for remote types into a macro --- src/nvim/api/private/defs.h | 14 +++++++++--- src/nvim/os/msgpack_rpc.c | 44 ++++++++++++------------------------- 2 files changed, 25 insertions(+), 33 deletions(-) diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h index 3ee50310fb..9b0639067d 100644 --- a/src/nvim/api/private/defs.h +++ b/src/nvim/api/private/defs.h @@ -5,6 +5,14 @@ #include #include +#define REMOTE_TYPE(type) typedef Integer type + +#define TYPED_ARRAY_OF(type) \ + typedef struct { \ + type *items; \ + size_t size; \ + } type##Array + // Basic types typedef struct { char msg[256]; @@ -20,9 +28,9 @@ typedef struct { size_t size; } String; -typedef Integer Buffer; -typedef Integer Window; -typedef Integer Tabpage; +REMOTE_TYPE(Buffer); +REMOTE_TYPE(Window); +REMOTE_TYPE(Tabpage); typedef struct object Object; diff --git a/src/nvim/os/msgpack_rpc.c b/src/nvim/os/msgpack_rpc.c index 45832070b1..c1e749a000 100644 --- a/src/nvim/os/msgpack_rpc.c +++ b/src/nvim/os/msgpack_rpc.c @@ -4,6 +4,16 @@ #include "nvim/vim.h" #include "nvim/memory.h" +#define REMOTE_FUNCS_IMPL(t, lt) \ + bool msgpack_rpc_to_##lt(msgpack_object *obj, t *arg) \ + { \ + return msgpack_rpc_to_integer(obj, arg); \ + } \ + \ + void msgpack_rpc_from_##lt(t result, msgpack_packer *res) \ + { \ + msgpack_rpc_from_integer(result, res); \ + } void msgpack_rpc_call(msgpack_object *req, msgpack_packer *res) { // The initial response structure is the same no matter what happens, @@ -104,21 +114,6 @@ bool msgpack_rpc_to_string(msgpack_object *obj, String *arg) return obj->type == MSGPACK_OBJECT_RAW; } -bool msgpack_rpc_to_buffer(msgpack_object *obj, Buffer *arg) -{ - return msgpack_rpc_to_integer(obj, arg); -} - -bool msgpack_rpc_to_window(msgpack_object *obj, Window *arg) -{ - return msgpack_rpc_to_integer(obj, arg); -} - -bool msgpack_rpc_to_tabpage(msgpack_object *obj, Tabpage *arg) -{ - return msgpack_rpc_to_integer(obj, arg); -} - bool msgpack_rpc_to_object(msgpack_object *obj, Object *arg) { switch (obj->type) { @@ -251,21 +246,6 @@ void msgpack_rpc_from_string(String result, msgpack_packer *res) msgpack_pack_raw_body(res, result.data, result.size); } -void msgpack_rpc_from_buffer(Buffer result, msgpack_packer *res) -{ - msgpack_rpc_from_integer(result, res); -} - -void msgpack_rpc_from_window(Window result, msgpack_packer *res) -{ - msgpack_rpc_from_integer(result, res); -} - -void msgpack_rpc_from_tabpage(Tabpage result, msgpack_packer *res) -{ - msgpack_rpc_from_integer(result, res); -} - void msgpack_rpc_from_object(Object result, msgpack_packer *res) { switch (result.type) { @@ -390,3 +370,7 @@ void msgpack_rpc_free_dictionary(Dictionary value) free(value.items); } +REMOTE_FUNCS_IMPL(Buffer, buffer) +REMOTE_FUNCS_IMPL(Window, window) +REMOTE_FUNCS_IMPL(Tabpage, tabpage) + From 1e67b13fdcb6ed7f2a951b9053f0a829b3a48906 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:40 -0300 Subject: [PATCH 13/19] API: Refactor: Add macro infrastructure for typed arrays - Add macros supporting typed arrays in the remote API - Refactor StringArray-related functions on top of the new macros --- src/nvim/api/private/defs.h | 5 +-- src/nvim/os/msgpack_rpc.c | 74 +++++++++++++++++++------------------ src/nvim/os/msgpack_rpc.h | 9 +++-- 3 files changed, 45 insertions(+), 43 deletions(-) diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h index 9b0639067d..a6c2eea8e5 100644 --- a/src/nvim/api/private/defs.h +++ b/src/nvim/api/private/defs.h @@ -34,10 +34,7 @@ REMOTE_TYPE(Tabpage); typedef struct object Object; -typedef struct { - String *items; - size_t size; -} StringArray; +TYPED_ARRAY_OF(String); typedef struct { Integer row, col; diff --git a/src/nvim/os/msgpack_rpc.c b/src/nvim/os/msgpack_rpc.c index c1e749a000..6c18c7310d 100644 --- a/src/nvim/os/msgpack_rpc.c +++ b/src/nvim/os/msgpack_rpc.c @@ -14,6 +14,43 @@ { \ msgpack_rpc_from_integer(result, res); \ } + +#define TYPED_ARRAY_IMPL(t, lt) \ + bool msgpack_rpc_to_##lt##array(msgpack_object *obj, t##Array *arg) \ + { \ + if (obj->type != MSGPACK_OBJECT_ARRAY) { \ + return false; \ + } \ + \ + arg->size = obj->via.array.size; \ + arg->items = xcalloc(obj->via.array.size, sizeof(t)); \ + \ + for (size_t i = 0; i < obj->via.array.size; i++) { \ + if (!msgpack_rpc_to_##lt(obj->via.array.ptr + i, &arg->items[i])) { \ + return false; \ + } \ + } \ + \ + return true; \ + } \ + \ + void msgpack_rpc_from_##lt##array(t##Array result, msgpack_packer *res) \ + { \ + msgpack_pack_array(res, result.size); \ + \ + for (size_t i = 0; i < result.size; i++) { \ + msgpack_rpc_from_##lt(result.items[i], res); \ + } \ + } \ + \ + void msgpack_rpc_free_##lt##array(t##Array value) { \ + for (size_t i = 0; i < value.size; i++) { \ + msgpack_rpc_free_##lt(value.items[i]); \ + } \ + \ + free(value.items); \ + } + void msgpack_rpc_call(msgpack_object *req, msgpack_packer *res) { // The initial response structure is the same no matter what happens, @@ -151,24 +188,6 @@ bool msgpack_rpc_to_object(msgpack_object *obj, Object *arg) } } -bool msgpack_rpc_to_stringarray(msgpack_object *obj, StringArray *arg) -{ - if (obj->type != MSGPACK_OBJECT_ARRAY) { - return false; - } - - arg->size = obj->via.array.size; - arg->items = xcalloc(obj->via.array.size, sizeof(String)); - - for (uint32_t i = 0; i < obj->via.array.size; i++) { - if (!msgpack_rpc_to_string(obj->via.array.ptr + i, &arg->items[i])) { - return false; - } - } - - return true; -} - bool msgpack_rpc_to_position(msgpack_object *obj, Position *arg) { return obj->type == MSGPACK_OBJECT_ARRAY @@ -282,15 +301,6 @@ void msgpack_rpc_from_object(Object result, msgpack_packer *res) } } -void msgpack_rpc_from_stringarray(StringArray result, msgpack_packer *res) -{ - msgpack_pack_array(res, result.size); - - for (size_t i = 0; i < result.size; i++) { - msgpack_rpc_from_string(result.items[i], res); - } -} - void msgpack_rpc_from_position(Position result, msgpack_packer *res) { msgpack_pack_array(res, 2);; @@ -343,14 +353,6 @@ void msgpack_rpc_free_object(Object value) } } -void msgpack_rpc_free_stringarray(StringArray value) { - for (uint32_t i = 0; i < value.size; i++) { - msgpack_rpc_free_string(value.items[i]); - } - - free(value.items); -} - void msgpack_rpc_free_array(Array value) { for (uint32_t i = 0; i < value.size; i++) { @@ -374,3 +376,5 @@ REMOTE_FUNCS_IMPL(Buffer, buffer) REMOTE_FUNCS_IMPL(Window, window) REMOTE_FUNCS_IMPL(Tabpage, tabpage) +TYPED_ARRAY_IMPL(String, string) + diff --git a/src/nvim/os/msgpack_rpc.h b/src/nvim/os/msgpack_rpc.h index 0f644273cd..45632c7389 100644 --- a/src/nvim/os/msgpack_rpc.h +++ b/src/nvim/os/msgpack_rpc.h @@ -8,6 +8,8 @@ #include "nvim/api/private/defs.h" +#define ARRAY_DICT_INIT {.size = 0, .items = NULL} + /// Validates the basic structure of the msgpack-rpc call and fills `res` /// with the basic response structure. /// @@ -80,9 +82,9 @@ void msgpack_rpc_from_dictionary(Dictionary result, msgpack_packer *res); #define msgpack_rpc_init_window #define msgpack_rpc_init_tabpage #define msgpack_rpc_init_object = {.type = kObjectTypeNil} -#define msgpack_rpc_init_stringarray = {.items = NULL, .size = 0} -#define msgpack_rpc_init_array = {.items = NULL, .size = 0} -#define msgpack_rpc_init_dictionary = {.items = NULL, .size = 0} +#define msgpack_rpc_init_stringarray = ARRAY_DICT_INIT +#define msgpack_rpc_init_array = ARRAY_DICT_INIT +#define msgpack_rpc_init_dictionary = ARRAY_DICT_INIT /// Helpers for freeing arguments/return value /// @@ -102,6 +104,5 @@ void msgpack_rpc_free_stringarray(StringArray value); void msgpack_rpc_free_array(Array value); void msgpack_rpc_free_dictionary(Dictionary value); - #endif // NVIM_OS_MSGPACK_RPC_H From f70f9bfac1ae62828d222bc6ccb528e6e93be523 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:42 -0300 Subject: [PATCH 14/19] API: Refactor: Change the integer type of remote objects to uint64_t --- src/nvim/api/private/defs.h | 2 +- src/nvim/api/private/helpers.c | 4 ++-- src/nvim/api/vim.c | 19 +++++++++++++++---- src/nvim/api/window.c | 3 ++- src/nvim/os/msgpack_rpc.c | 5 +++-- 5 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h index a6c2eea8e5..770f43b20a 100644 --- a/src/nvim/api/private/defs.h +++ b/src/nvim/api/private/defs.h @@ -5,7 +5,7 @@ #include #include -#define REMOTE_TYPE(type) typedef Integer type +#define REMOTE_TYPE(type) typedef uint64_t type #define TYPED_ARRAY_OF(type) \ typedef struct { \ diff --git a/src/nvim/api/private/helpers.c b/src/nvim/api/private/helpers.c index a7d155382c..64aa0a2013 100644 --- a/src/nvim/api/private/helpers.c +++ b/src/nvim/api/private/helpers.c @@ -285,7 +285,7 @@ Object vim_to_object(typval_T *obj) buf_T *find_buffer(Buffer buffer, Error *err) { - if (buffer > INT_MAX || buffer < INT_MIN) { + if (buffer > INT_MAX) { set_api_error("Invalid buffer id", err); return NULL; } @@ -316,7 +316,7 @@ win_T * find_window(Window window, Error *err) tabpage_T * find_tab(Tabpage tabpage, Error *err) { - if (tabpage > INT_MAX || tabpage < INT_MIN) { + if (tabpage > INT_MAX) { set_api_error("Invalid tabpage id", err); return NULL; } diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index cfde53b0a8..6e8840a003 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -142,17 +142,27 @@ void vim_change_directory(String dir, Error *err) String vim_get_current_line(Error *err) { - return buffer_get_line(curbuf->b_fnum, curwin->w_cursor.lnum - 1, err); + assert(curbuf->b_fnum >= 0); + return buffer_get_line((uint64_t)curbuf->b_fnum, + curwin->w_cursor.lnum - 1, + err); } void vim_set_current_line(String line, Error *err) { - buffer_set_line(curbuf->b_fnum, curwin->w_cursor.lnum - 1, line, err); + assert(curbuf->b_fnum >= 0); + buffer_set_line((uint64_t)curbuf->b_fnum, + curwin->w_cursor.lnum - 1, + line, + err); } void vim_del_current_line(Error *err) { - buffer_del_line(curbuf->b_fnum, curwin->w_cursor.lnum - 1, err); + assert(curbuf->b_fnum >= 0); + buffer_del_line((uint64_t)curbuf->b_fnum, + curwin->w_cursor.lnum - 1, + err); } Object vim_get_var(String name, Error *err) @@ -205,7 +215,8 @@ Integer vim_get_buffer_count(void) Buffer vim_get_current_buffer(void) { - return curbuf->b_fnum; + assert(curbuf->b_fnum >= 0); + return (uint64_t)curbuf->b_fnum; } void vim_set_current_buffer(Buffer buffer, Error *err) diff --git a/src/nvim/api/window.c b/src/nvim/api/window.c index 73487d9c49..8b31d8e9fc 100644 --- a/src/nvim/api/window.c +++ b/src/nvim/api/window.c @@ -19,7 +19,8 @@ Buffer window_get_buffer(Window window, Error *err) return 0; } - return win->w_buffer->b_fnum; + assert(win->w_buffer->b_fnum >= 0); + return (uint64_t)win->w_buffer->b_fnum; } Position window_get_cursor(Window window, Error *err) diff --git a/src/nvim/os/msgpack_rpc.c b/src/nvim/os/msgpack_rpc.c index 6c18c7310d..5840d25375 100644 --- a/src/nvim/os/msgpack_rpc.c +++ b/src/nvim/os/msgpack_rpc.c @@ -7,12 +7,13 @@ #define REMOTE_FUNCS_IMPL(t, lt) \ bool msgpack_rpc_to_##lt(msgpack_object *obj, t *arg) \ { \ - return msgpack_rpc_to_integer(obj, arg); \ + *arg = obj->via.u64; \ + return obj->type == MSGPACK_OBJECT_POSITIVE_INTEGER; \ } \ \ void msgpack_rpc_from_##lt(t result, msgpack_packer *res) \ { \ - msgpack_rpc_from_integer(result, res); \ + msgpack_pack_uint64(res, result); \ } #define TYPED_ARRAY_IMPL(t, lt) \ From a842fe4dc1e0624a6332ee0fef40517e7925dfb4 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:44 -0300 Subject: [PATCH 15/19] API: Refactor: Return handles instead of indexes - Define specialized arrays for each remote object type - Implement msgpack_rpc functions for dealing with the new types - Refactor all functions dealing with buffers, windows and tabpages to return/accept handles instead of list indexes. --- src/nvim/api/private/defs.h | 3 + src/nvim/api/private/helpers.c | 31 +++------- src/nvim/api/tabpage.c | 21 +++++-- src/nvim/api/tabpage.h | 2 +- src/nvim/api/vim.c | 104 ++++++++++++++++----------------- src/nvim/api/vim.h | 12 ++-- src/nvim/api/window.c | 13 +++-- src/nvim/os/msgpack_rpc.c | 3 + src/nvim/os/msgpack_rpc.h | 12 ++++ 9 files changed, 109 insertions(+), 92 deletions(-) diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h index 770f43b20a..6be786b15a 100644 --- a/src/nvim/api/private/defs.h +++ b/src/nvim/api/private/defs.h @@ -34,6 +34,9 @@ REMOTE_TYPE(Tabpage); typedef struct object Object; +TYPED_ARRAY_OF(Buffer); +TYPED_ARRAY_OF(Window); +TYPED_ARRAY_OF(Tabpage); TYPED_ARRAY_OF(String); typedef struct { diff --git a/src/nvim/api/private/helpers.c b/src/nvim/api/private/helpers.c index 64aa0a2013..c4340ddd89 100644 --- a/src/nvim/api/private/helpers.c +++ b/src/nvim/api/private/helpers.c @@ -4,6 +4,7 @@ #include "nvim/api/private/helpers.h" #include "nvim/api/private/defs.h" +#include "nvim/api/private/handle.h" #include "nvim/vim.h" #include "nvim/buffer.h" #include "nvim/window.h" @@ -285,43 +286,29 @@ Object vim_to_object(typval_T *obj) buf_T *find_buffer(Buffer buffer, Error *err) { - if (buffer > INT_MAX) { - set_api_error("Invalid buffer id", err); - return NULL; - } + buf_T *rv = handle_get_buffer(buffer); - buf_T *buf = buflist_findnr((int)buffer); - - if (buf == NULL) { + if (!rv) { set_api_error("Invalid buffer id", err); } - return buf; + return rv; } win_T * find_window(Window window, Error *err) { - tabpage_T *tp; - win_T *wp; + win_T *rv = handle_get_window(window); - FOR_ALL_TAB_WINDOWS(tp, wp) { - if (!--window) { - return wp; - } + if (!rv) { + set_api_error("Invalid window id", err); } - set_api_error("Invalid window id", err); - return NULL; + return rv; } tabpage_T * find_tab(Tabpage tabpage, Error *err) { - if (tabpage > INT_MAX) { - set_api_error("Invalid tabpage id", err); - return NULL; - } - - tabpage_T *rv = find_tabpage((int)tabpage); + tabpage_T *rv = handle_get_tabpage(tabpage); if (!rv) { set_api_error("Invalid tabpage id", err); diff --git a/src/nvim/api/tabpage.c b/src/nvim/api/tabpage.c index f4e5f2857a..58efc6a514 100644 --- a/src/nvim/api/tabpage.c +++ b/src/nvim/api/tabpage.c @@ -6,10 +6,11 @@ #include "nvim/api/vim.h" #include "nvim/api/private/defs.h" #include "nvim/api/private/helpers.h" +#include "nvim/memory.h" -Integer tabpage_get_window_count(Tabpage tabpage, Error *err) +WindowArray tabpage_get_windows(Tabpage tabpage, Error *err) { - Integer rv = 0; + WindowArray rv = {.size = 0}; tabpage_T *tab = find_tab(tabpage, err); if (!tab) { @@ -23,7 +24,17 @@ Integer tabpage_get_window_count(Tabpage tabpage, Error *err) if (tp != tab) { break; } - rv++; + rv.size++; + } + + rv.items = xmalloc(sizeof(Window) * rv.size); + size_t i = 0; + + FOR_ALL_TAB_WINDOWS(tp, wp) { + if (tp != tab) { + break; + } + rv.items[i++] = wp->handle; } return rv; @@ -67,13 +78,11 @@ Window tabpage_get_window(Tabpage tabpage, Error *err) } else { tabpage_T *tp; win_T *wp; - rv = 1; FOR_ALL_TAB_WINDOWS(tp, wp) { if (tp == tab && wp == tab->tp_curwin) { - return rv; + return wp->handle; } - rv++; } // There should always be a current window for a tabpage abort(); diff --git a/src/nvim/api/tabpage.h b/src/nvim/api/tabpage.h index abf4377ee4..dddcecbdbd 100644 --- a/src/nvim/api/tabpage.h +++ b/src/nvim/api/tabpage.h @@ -11,7 +11,7 @@ /// @param tabpage The tabpage /// @param[out] err Details of an error that may have occurred /// @return The number of windows in `tabpage` -Integer tabpage_get_window_count(Tabpage tabpage, Error *err); +WindowArray tabpage_get_windows(Tabpage tabpage, Error *err); /// Gets a tabpage variable /// diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 6e8840a003..d9a5ce1db5 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -142,27 +142,17 @@ void vim_change_directory(String dir, Error *err) String vim_get_current_line(Error *err) { - assert(curbuf->b_fnum >= 0); - return buffer_get_line((uint64_t)curbuf->b_fnum, - curwin->w_cursor.lnum - 1, - err); + return buffer_get_line(curbuf->handle, curwin->w_cursor.lnum - 1, err); } void vim_set_current_line(String line, Error *err) { - assert(curbuf->b_fnum >= 0); - buffer_set_line((uint64_t)curbuf->b_fnum, - curwin->w_cursor.lnum - 1, - line, - err); + buffer_set_line(curbuf->handle, curwin->w_cursor.lnum - 1, line, err); } void vim_del_current_line(Error *err) { - assert(curbuf->b_fnum >= 0); - buffer_del_line((uint64_t)curbuf->b_fnum, - curwin->w_cursor.lnum - 1, - err); + buffer_del_line(curbuf->handle, curwin->w_cursor.lnum - 1, err); } Object vim_get_var(String name, Error *err) @@ -200,33 +190,43 @@ void vim_err_write(String str) write_msg(str, true); } -Integer vim_get_buffer_count(void) +BufferArray vim_get_buffers(void) { + BufferArray rv = {.size = 0}; buf_T *b = firstbuf; - Integer n = 0; while (b) { - n++; + rv.size++; b = b->b_next; } - return n; + rv.items = xmalloc(sizeof(Buffer) * rv.size); + size_t i = 0; + b = firstbuf; + + while (b) { + rv.items[i++] = b->handle; + b = b->b_next; + } + + return rv; } Buffer vim_get_current_buffer(void) { - assert(curbuf->b_fnum >= 0); - return (uint64_t)curbuf->b_fnum; + return curbuf->handle; } void vim_set_current_buffer(Buffer buffer, Error *err) { - if (!find_buffer(buffer, err)) { + buf_T *buf = find_buffer(buffer, err); + + if (!buf) { return; } try_start(); - if (do_buffer(DOBUF_GOTO, DOBUF_FIRST, FORWARD, (int)buffer, 0) == FAIL) { + if (do_buffer(DOBUF_GOTO, DOBUF_FIRST, FORWARD, buf->b_fnum, 0) == FAIL) { if (try_end(err)) { return; } @@ -240,14 +240,21 @@ void vim_set_current_buffer(Buffer buffer, Error *err) try_end(err); } -Integer vim_get_window_count(void) +WindowArray vim_get_windows(void) { + WindowArray rv = {.size = 0}; tabpage_T *tp; win_T *wp; - Integer rv = 0; FOR_ALL_TAB_WINDOWS(tp, wp) { - rv++; + rv.size++; + } + + rv.items = xmalloc(sizeof(Window) * rv.size); + size_t i = 0; + + FOR_ALL_TAB_WINDOWS(tp, wp) { + rv.items[i++] = wp->handle; } return rv; @@ -255,20 +262,7 @@ Integer vim_get_window_count(void) Window vim_get_current_window(void) { - tabpage_T *tp; - win_T *wp; - Window rv = 1; - - FOR_ALL_TAB_WINDOWS(tp, wp) { - if (wp == curwin) { - return rv; - } - - rv++; - } - - // There should always be a current window - abort(); + return curwin->handle; } void vim_set_current_window(Window window, Error *err) @@ -280,7 +274,7 @@ void vim_set_current_window(Window window, Error *err) } try_start(); - win_goto(win); + goto_tabpage_win(win_find_tabpage(win), win); if (win != curwin) { if (try_end(err)) { @@ -293,14 +287,23 @@ void vim_set_current_window(Window window, Error *err) try_end(err); } -Integer vim_get_tabpage_count(void) +TabpageArray vim_get_tabpages(void) { + TabpageArray rv = {.size = 0}; tabpage_T *tp = first_tabpage; - Integer rv = 0; - while (tp != NULL) { + while (tp) { + rv.size++; + tp = tp->tp_next; + } + + rv.items = xmalloc(sizeof(Tabpage) * rv.size); + size_t i = 0; + tp = first_tabpage; + + while (tp) { + rv.items[i++] = tp->handle; tp = tp->tp_next; - rv++; } return rv; @@ -308,24 +311,19 @@ Integer vim_get_tabpage_count(void) Tabpage vim_get_current_tabpage(void) { - Tabpage rv = 1; - tabpage_T *t; - - for (t = first_tabpage; t != NULL && t != curtab; t = t->tp_next) { - rv++; - } - - return rv; + return curtab->handle; } void vim_set_current_tabpage(Tabpage tabpage, Error *err) { - if (!find_tab(tabpage, err)) { + tabpage_T *tp = find_tab(tabpage, err); + + if (!tp) { return; } try_start(); - goto_tabpage((int)tabpage); + goto_tabpage_tp(tp, true, true); try_end(err); } diff --git a/src/nvim/api/vim.h b/src/nvim/api/vim.h index 2a712c19a1..acfab11cf7 100644 --- a/src/nvim/api/vim.h +++ b/src/nvim/api/vim.h @@ -108,10 +108,10 @@ void vim_out_write(String str); /// @param str The message void vim_err_write(String str); -/// Gets the number of buffers +/// Gets the current list of buffer handles /// /// @return The number of buffers -Integer vim_get_buffer_count(void); +BufferArray vim_get_buffers(void); /// Return the current buffer /// @@ -124,10 +124,10 @@ Buffer vim_get_current_buffer(void); /// @param[out] err Details of an error that may have occurred void vim_set_current_buffer(Buffer buffer, Error *err); -/// Gets the number of windows +/// Gets the current list of window handles /// /// @return The number of windows -Integer vim_get_window_count(void); +WindowArray vim_get_windows(void); /// Return the current window /// @@ -139,10 +139,10 @@ Window vim_get_current_window(void); /// @param handle The window handle void vim_set_current_window(Window window, Error *err); -/// Gets the number of tab pages +/// Gets the current list of tabpage handles /// /// @return The number of tab pages -Integer vim_get_tabpage_count(void); +TabpageArray vim_get_tabpages(void); /// Return the current tab page /// diff --git a/src/nvim/api/window.c b/src/nvim/api/window.c index 8b31d8e9fc..8bd8316477 100644 --- a/src/nvim/api/window.c +++ b/src/nvim/api/window.c @@ -19,8 +19,7 @@ Buffer window_get_buffer(Window window, Error *err) return 0; } - assert(win->w_buffer->b_fnum >= 0); - return (uint64_t)win->w_buffer->b_fnum; + return win->w_buffer->handle; } Position window_get_cursor(Window window, Error *err) @@ -193,8 +192,14 @@ Position window_get_position(Window window, Error *err) Tabpage window_get_tabpage(Window window, Error *err) { - set_api_error("Not implemented", err); - return 0; + Tabpage rv = 0; + win_T *win = find_window(window, err); + + if (win) { + rv = win_find_tabpage(win)->handle; + } + + return rv; } Boolean window_is_valid(Window window) diff --git a/src/nvim/os/msgpack_rpc.c b/src/nvim/os/msgpack_rpc.c index 5840d25375..d7ffa6f559 100644 --- a/src/nvim/os/msgpack_rpc.c +++ b/src/nvim/os/msgpack_rpc.c @@ -377,5 +377,8 @@ REMOTE_FUNCS_IMPL(Buffer, buffer) REMOTE_FUNCS_IMPL(Window, window) REMOTE_FUNCS_IMPL(Tabpage, tabpage) +TYPED_ARRAY_IMPL(Buffer, buffer) +TYPED_ARRAY_IMPL(Window, window) +TYPED_ARRAY_IMPL(Tabpage, tabpage) TYPED_ARRAY_IMPL(String, string) diff --git a/src/nvim/os/msgpack_rpc.h b/src/nvim/os/msgpack_rpc.h index 45632c7389..80c5a6914f 100644 --- a/src/nvim/os/msgpack_rpc.h +++ b/src/nvim/os/msgpack_rpc.h @@ -50,6 +50,9 @@ bool msgpack_rpc_to_window(msgpack_object *obj, Window *arg); bool msgpack_rpc_to_tabpage(msgpack_object *obj, Tabpage *arg); bool msgpack_rpc_to_object(msgpack_object *obj, Object *arg); bool msgpack_rpc_to_stringarray(msgpack_object *obj, StringArray *arg); +bool msgpack_rpc_to_bufferarray(msgpack_object *obj, BufferArray *arg); +bool msgpack_rpc_to_windowarray(msgpack_object *obj, WindowArray *arg); +bool msgpack_rpc_to_tabpagearray(msgpack_object *obj, TabpageArray *arg); bool msgpack_rpc_to_array(msgpack_object *obj, Array *arg); bool msgpack_rpc_to_dictionary(msgpack_object *obj, Dictionary *arg); @@ -69,6 +72,9 @@ void msgpack_rpc_from_window(Window result, msgpack_packer *res); void msgpack_rpc_from_tabpage(Tabpage result, msgpack_packer *res); void msgpack_rpc_from_object(Object result, msgpack_packer *res); void msgpack_rpc_from_stringarray(StringArray result, msgpack_packer *res); +void msgpack_rpc_from_bufferarray(BufferArray result, msgpack_packer *res); +void msgpack_rpc_from_windowarray(WindowArray result, msgpack_packer *res); +void msgpack_rpc_from_tabpagearray(TabpageArray result, msgpack_packer *res); void msgpack_rpc_from_array(Array result, msgpack_packer *res); void msgpack_rpc_from_dictionary(Dictionary result, msgpack_packer *res); @@ -83,6 +89,9 @@ void msgpack_rpc_from_dictionary(Dictionary result, msgpack_packer *res); #define msgpack_rpc_init_tabpage #define msgpack_rpc_init_object = {.type = kObjectTypeNil} #define msgpack_rpc_init_stringarray = ARRAY_DICT_INIT +#define msgpack_rpc_init_bufferarray = ARRAY_DICT_INIT +#define msgpack_rpc_init_windowarray = ARRAY_DICT_INIT +#define msgpack_rpc_init_tabpagearray = ARRAY_DICT_INIT #define msgpack_rpc_init_array = ARRAY_DICT_INIT #define msgpack_rpc_init_dictionary = ARRAY_DICT_INIT @@ -101,6 +110,9 @@ void msgpack_rpc_from_dictionary(Dictionary result, msgpack_packer *res); #define msgpack_rpc_free_tabpage(value) void msgpack_rpc_free_object(Object value); void msgpack_rpc_free_stringarray(StringArray value); +void msgpack_rpc_free_bufferarray(BufferArray value); +void msgpack_rpc_free_windowarray(WindowArray value); +void msgpack_rpc_free_tabpagearray(TabpageArray value); void msgpack_rpc_free_array(Array value); void msgpack_rpc_free_dictionary(Dictionary value); From 1156360fe724fd3242186ededd8b3d4a42c990cd Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:46 -0300 Subject: [PATCH 16/19] API: Refactor: Implement buffer_get_number --- src/nvim/api/buffer.c | 12 ++++++++++++ src/nvim/api/buffer.h | 7 +++++++ 2 files changed, 19 insertions(+) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 9a4285d74c..0796f5a324 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -293,6 +293,18 @@ void buffer_set_option(Buffer buffer, String name, Object value, Error *err) set_option_to(buf, SREQ_BUF, name, value, err); } +Integer buffer_get_number(Buffer buffer, Error *err) +{ + Integer rv = 0; + buf_T *buf = find_buffer(buffer, err); + + if (!buf) { + return rv; + } + + return buf->b_fnum; +} + String buffer_get_name(Buffer buffer, Error *err) { String rv = {.size = 0, .data = ""}; diff --git a/src/nvim/api/buffer.h b/src/nvim/api/buffer.h index 2350f7f41d..52a3b7cdb3 100644 --- a/src/nvim/api/buffer.h +++ b/src/nvim/api/buffer.h @@ -104,6 +104,13 @@ Object buffer_get_option(Buffer buffer, String name, Error *err); /// @param[out] err Details of an error that may have occurred void buffer_set_option(Buffer buffer, String name, Object value, Error *err); +/// Gets the buffer number +/// +/// @param buffer The buffer handle +/// @param[out] err Details of an error that may have occurred +/// @return The buffer number +Integer buffer_get_number(Buffer buffer, Error *err); + /// Gets the full file name for the buffer /// /// @param buffer The buffer handle From 9815688fbdeb7bc1f1a28b9d827b31eea4fe8cfb Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:48 -0300 Subject: [PATCH 17/19] API: Refactor: Use macro for initializing all arrays --- src/nvim/api/buffer.c | 4 ++-- src/nvim/api/private/defs.h | 1 + src/nvim/api/tabpage.c | 2 +- src/nvim/api/vim.c | 8 ++++---- src/nvim/os/msgpack_rpc.h | 2 -- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 0796f5a324..929735a6b9 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -71,7 +71,7 @@ void buffer_set_line(Buffer buffer, Integer index, String line, Error *err) void buffer_del_line(Buffer buffer, Integer index, Error *err) { - StringArray array = {.size = 0}; + StringArray array = ARRAY_DICT_INIT; buffer_set_slice(buffer, index, index, true, true, array, err); } @@ -82,7 +82,7 @@ StringArray buffer_get_slice(Buffer buffer, Boolean include_end, Error *err) { - StringArray rv = {.size = 0}; + StringArray rv = ARRAY_DICT_INIT; buf_T *buf = find_buffer(buffer, err); if (!buf) { diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h index 6be786b15a..a91907f4f8 100644 --- a/src/nvim/api/private/defs.h +++ b/src/nvim/api/private/defs.h @@ -5,6 +5,7 @@ #include #include +#define ARRAY_DICT_INIT {.size = 0, .items = NULL} #define REMOTE_TYPE(type) typedef uint64_t type #define TYPED_ARRAY_OF(type) \ diff --git a/src/nvim/api/tabpage.c b/src/nvim/api/tabpage.c index 58efc6a514..b7243c68a8 100644 --- a/src/nvim/api/tabpage.c +++ b/src/nvim/api/tabpage.c @@ -10,7 +10,7 @@ WindowArray tabpage_get_windows(Tabpage tabpage, Error *err) { - WindowArray rv = {.size = 0}; + WindowArray rv = ARRAY_DICT_INIT; tabpage_T *tab = find_tab(tabpage, err); if (!tab) { diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index d9a5ce1db5..694781e0a3 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -81,7 +81,7 @@ Integer vim_strwidth(String str, Error *err) StringArray vim_list_runtime_paths(void) { - StringArray rv = {.size = 0}; + StringArray rv = ARRAY_DICT_INIT; uint8_t *rtp = p_rtp; if (*rtp == NUL) { @@ -192,7 +192,7 @@ void vim_err_write(String str) BufferArray vim_get_buffers(void) { - BufferArray rv = {.size = 0}; + BufferArray rv = ARRAY_DICT_INIT; buf_T *b = firstbuf; while (b) { @@ -242,7 +242,7 @@ void vim_set_current_buffer(Buffer buffer, Error *err) WindowArray vim_get_windows(void) { - WindowArray rv = {.size = 0}; + WindowArray rv = ARRAY_DICT_INIT; tabpage_T *tp; win_T *wp; @@ -289,7 +289,7 @@ void vim_set_current_window(Window window, Error *err) TabpageArray vim_get_tabpages(void) { - TabpageArray rv = {.size = 0}; + TabpageArray rv = ARRAY_DICT_INIT; tabpage_T *tp = first_tabpage; while (tp) { diff --git a/src/nvim/os/msgpack_rpc.h b/src/nvim/os/msgpack_rpc.h index 80c5a6914f..a6a909ac1f 100644 --- a/src/nvim/os/msgpack_rpc.h +++ b/src/nvim/os/msgpack_rpc.h @@ -8,8 +8,6 @@ #include "nvim/api/private/defs.h" -#define ARRAY_DICT_INIT {.size = 0, .items = NULL} - /// Validates the basic structure of the msgpack-rpc call and fills `res` /// with the basic response structure. /// From f03a7672e18fe57b1e4de17abf2a193f8b343562 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:49 -0300 Subject: [PATCH 18/19] API: Refactor: Fix buffer_get_mark --- src/nvim/api/buffer.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 929735a6b9..bf30ccf856 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -364,7 +364,7 @@ Position buffer_get_mark(Buffer buffer, String name, Error *err) return rv; } - if (name.size != 0) { + if (name.size != 1) { set_api_error("mark name must be a single character", err); return rv; } From 6c96e42e2c18bd6ae685b5a41c69b03954aa0375 Mon Sep 17 00:00:00 2001 From: Thiago de Arruda Date: Fri, 23 May 2014 15:49:51 -0300 Subject: [PATCH 19/19] API: Test: Setup basic test infrastructure - Add a 'expect' utility script that can run simple API tests using clients developed for any platform. - Extend travis build matrix to run API tests using the python client and valgrind. This script can be used to write API tests without having to manage nvim's lifetime: - It starts a single nvim instance listening on a known socket - Invokes the test runner, which should connect to NEOVIM_LISTEN_ADDRESS - The nvim instance started by the script provides a `BeforeEachTest` function, which should be called before each test to reset nvim to a clean state. - It takes care of shutting down nvim once the tests are finished. As explained [here](https://github.com/neovim/neovim/pull/737#issuecomment-43941520), it's not possible to fully reset nvim to it's initial state, but the `BeforeEachTest` function should be enough for most test cases. Tests requiring a fully clean nvim instance should take care of starting/stopping nvim. --- .travis.yml | 1 + scripts/run-api-tests.exp | 86 +++++++++++++++++++++++++++++++++++++++ scripts/travis.sh | 62 ++++++++++++++++++++++++---- 3 files changed, 142 insertions(+), 7 deletions(-) create mode 100755 scripts/run-api-tests.exp diff --git a/.travis.yml b/.travis.yml index 25ab961ec4..d883410123 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,5 +4,6 @@ env: - TRAVIS_BUILD_TYPE=gcc/ia32 - TRAVIS_BUILD_TYPE=gcc/unittest - TRAVIS_BUILD_TYPE=clint + - TRAVIS_BUILD_TYPE=api/python script: - ./scripts/travis.sh diff --git a/scripts/run-api-tests.exp b/scripts/run-api-tests.exp new file mode 100755 index 0000000000..6a568e17cb --- /dev/null +++ b/scripts/run-api-tests.exp @@ -0,0 +1,86 @@ +#!/usr/bin/env expect + +if {$argc < 2} { + puts "Need commands for running the tests and for starting nvim" + exit 1 +} + +set timeout 10 +set run_tests [split [lindex $argv 0] " "] +set run_nvim [split [lindex $argv 1] " "] + +# don't echo to stdout +log_user 0 +# set NEOVIM_LISTEN_ADDRESS, so nvim will listen on a known socket +set env(NEOVIM_LISTEN_ADDRESS) "/tmp/nvim-[exec date +%s%N].sock" +# start nvim +spawn {*}$run_nvim +# save the job descriptor +set nvim_id $spawn_id +# Reset function that can be invoked by test runners to put nvim in a cleaner +# state +send { +:function BeforeEachTest() + set all& + redir => groups + silent augroup + redir END + for group in split(groups) + exe 'augroup '.group + autocmd! + augroup NONE + exe 'augroup! '.group + endfor + tabnew + let curbufnum = eval(bufnr('%')) + redir => buflist + silent ls! + redir END + let bufnums = [] + for buf in split(buflist, '\n') + let bufnum = eval(split(buf, '[ u]')[0]) + if bufnum != curbufnum + call add(bufnums, bufnum) + endif + endfor + if len(bufnums) > 0 + exe 'silent bwipeout! '.join(bufnums, ' ') + endif + silent tabonly + for k in keys(g:) + exe 'unlet g:'.k + endfor + filetype plugin indent off + mapclear + mapclear! + abclear + comclear +endfunction +:echo "read"."y" +} +# wait until nvim is ready +expect "ready" +# run tests +spawn {*}$run_tests +set tests_id $spawn_id +set status 1 +# listen for test output in the background +expect_background { + * { + # show test output to the user + send_user -- $expect_out(buffer) + } + eof { + # collect the exit status code + set spawn_id $tests_id + catch wait result + set status [lindex $result 3] + set spawn_id $nvim_id + # quit nvim + send ":qa!\r" + } +} +# switch back nvim and wait until it exits +set spawn_id $nvim_id +expect eof +exit $status diff --git a/scripts/travis.sh b/scripts/travis.sh index 62c4fbe98e..3daa2652e5 100755 --- a/scripts/travis.sh +++ b/scripts/travis.sh @@ -1,8 +1,44 @@ #!/bin/sh -e -check_and_report() { +tmpdir="$(pwd)/tmp" +rm -rf "$tmpdir" +mkdir -p "$tmpdir" + +valgrind_check() { ( - cd $tmpdir + cd $1 + set -- valgrind-[*] valgrind-* + case $1$2 in + 'valgrind-[*]valgrind-*') + ;; + *) + shift + local err='' + for valgrind_log in "$@"; do + # Remove useless warning + sed -i "$valgrind_log" \ + -e '/Warning: noted but unhandled ioctl/d' \ + -e '/could cause spurious value errors to appear/d' \ + -e '/See README_MISSING_SYSCALL_OR_IOCTL for guidance/d' + if [ "$(stat -c %s $valgrind_log)" != "0" ]; then + # if after removing the warning, the log still has errors, show its + # contents and set the flag so we exit with non-zero status + cat "$valgrind_log" + err=1 + fi + done + if [ -n "$err" ]; then + echo "Runtime errors detected" + exit 1 + fi + ;; + esac + ) +} + +asan_check() { + ( + cd $1 set -- [*]san.[*] *san.* case $1$2 in '[*]san.[*]*san.*') @@ -68,9 +104,6 @@ if [ "$TRAVIS_BUILD_TYPE" = "clang/asan" ]; then install_dir="$(pwd)/dist" # temporary directory for writing sanitizer logs - tmpdir="$(pwd)/tmp" - rm -rf "$tmpdir" - mkdir -p "$tmpdir" # need the symbolizer path for stack traces with source information if [ -n "$USE_CLANG_34" ]; then @@ -91,10 +124,10 @@ if [ "$TRAVIS_BUILD_TYPE" = "clang/asan" ]; then $MAKE_CMD if ! $MAKE_CMD test; then reset - check_and_report + asan_check "$tmpdir" exit 1 fi - check_and_report + asan_check "$tmpdir" coveralls --encoding iso-8859-1 || echo 'coveralls upload failed.' $MAKE_CMD install elif [ "$TRAVIS_BUILD_TYPE" = "gcc/unittest" ]; then @@ -129,4 +162,19 @@ elif [ "$TRAVIS_BUILD_TYPE" = "gcc/ia32" ]; then $MAKE_CMD test elif [ "$TRAVIS_BUILD_TYPE" = "clint" ]; then ./scripts/clint.sh +elif [ "$TRAVIS_BUILD_TYPE" = "api/python" ]; then + set_environment /opt/neovim-deps + $MAKE_CMD + sudo apt-get install expect valgrind + git clone --depth=1 -b master git://github.com/neovim/python-client + cd python-client + sudo pip install . + sudo pip install nose + test_cmd="nosetests --verbosity=2" + nvim_cmd="valgrind -q --track-origins=yes --log-file=$tmpdir/valgrind-%p.log ../build/bin/nvim -u NONE" + if ! ../scripts/run-api-tests.exp "$test_cmd" "$nvim_cmd"; then + valgrind_check "$tmpdir" + exit 1 + fi + valgrind_check "$tmpdir" fi