aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.ci/gcc.sh1
-rw-r--r--cmake/GenerateHelptags.cmake8
-rw-r--r--runtime/autoload/remote/host.vim12
-rw-r--r--runtime/doc/msgpack_rpc.txt12
-rw-r--r--scripts/msgpack-gen.lua15
-rw-r--r--src/nvim/api/private/defs.h9
-rw-r--r--src/nvim/api/private/helpers.c3
-rw-r--r--src/nvim/msgpack_rpc/channel.c50
-rw-r--r--src/nvim/msgpack_rpc/helpers.c69
-rw-r--r--test/functional/api/server_requests_spec.lua44
-rw-r--r--third-party/cmake/BuildLuarocks.cmake6
11 files changed, 186 insertions, 43 deletions
diff --git a/.ci/gcc.sh b/.ci/gcc.sh
index 3e4ed505da..5879fe4b20 100644
--- a/.ci/gcc.sh
+++ b/.ci/gcc.sh
@@ -11,6 +11,7 @@ fi
setup_deps x64
CMAKE_EXTRA_FLAGS="-DTRAVIS_CI_BUILD=ON \
+ -DUSE_JEMALLOC=OFF \
-DUSE_GCOV=ON \
-DBUSTED_OUTPUT_TYPE=plainTerminal"
diff --git a/cmake/GenerateHelptags.cmake b/cmake/GenerateHelptags.cmake
index 658f4ab9cc..d4f4518b9b 100644
--- a/cmake/GenerateHelptags.cmake
+++ b/cmake/GenerateHelptags.cmake
@@ -9,6 +9,12 @@ else()
endif()
message(STATUS "Generating helptags in ${HELPTAGS_WORKING_DIRECTORY}.")
+if(EXISTS "${HELPTAGS_WORKING_DIRECTORY}/")
+ message(STATUS "${HELPTAGS_WORKING_DIRECTORY} already exists")
+ # if the doc directory already exists, helptags could fail due to duplicate
+ # tags. Tell the user to remove the directory and try again.
+ set(TROUBLESHOOTING "\nRemove \"${HELPTAGS_WORKING_DIRECTORY}\" and try again")
+endif()
execute_process(
COMMAND "${CMAKE_CURRENT_BINARY_DIR}/bin/nvim"
@@ -22,5 +28,5 @@ execute_process(
RESULT_VARIABLE res)
if(NOT res EQUAL 0)
- message(FATAL_ERROR "Generating helptags failed: ${err} - ${res}")
+ message(FATAL_ERROR "Generating helptags failed: ${err} - ${res}${TROUBLESHOOTING}")
endif()
diff --git a/runtime/autoload/remote/host.vim b/runtime/autoload/remote/host.vim
index b07593f39b..ebbd85b6e6 100644
--- a/runtime/autoload/remote/host.vim
+++ b/runtime/autoload/remote/host.vim
@@ -133,6 +133,11 @@ function! s:RegistrationCommands(host)
let lines = []
for path in paths
let specs = rpcrequest(channel, 'specs', path)
+ if type(specs) != type([])
+ " host didn't return a spec list, indicates a failure while loading a
+ " plugin
+ continue
+ endif
call add(lines, "call remote#host#RegisterPlugin('".a:host
\ ."', '".path."', [")
for spec in specs
@@ -244,9 +249,10 @@ function! s:RequirePythonHost(name)
endif
catch
endtry
- throw 'Failed to load python host.' .
- \ " Try upgrading the Neovim python module with 'pip install --upgrade neovim'" .
- \ " or see ':help nvim-python'."
+ throw 'Failed to load python host. You can try to see what happened ' .
+ \ 'by starting Neovim with $NVIM_PYTHON_PYTHON_LOG and opening '.
+ \ 'the generated log file. Also, the host stderr will be available '.
+ \ 'in Neovim log, so it may contain useful information.'
endfunction
call remote#host#Register('python', function('s:RequirePythonHost'))
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt
index f3fcd069c4..b6142e2234 100644
--- a/runtime/doc/msgpack_rpc.txt
+++ b/runtime/doc/msgpack_rpc.txt
@@ -116,6 +116,12 @@ functions can be called interactively:
>>> nvim = attach('socket', path='[address]')
>>> nvim.command('echo "hello world!"')
<
+One can also spawn and connect to an embedded nvim instance via |rpcstart()|
+>
+ let vim = rpcstart('nvim', ['--embed'])
+ echo rpcrequest(vim, 'vim_eval', '"Hello " . "world!"')
+ call rpcstop(vim)
+<
==============================================================================
4. Implementing new clients *msgpack-rpc-clients*
@@ -177,6 +183,10 @@ Buffer -> enum value kObjectTypeBuffer
Window -> enum value kObjectTypeWindow
Tabpage -> enum value kObjectTypeTabpage
+An API method expecting one of these types may be passed an integer instead,
+although they are not interchangeable. For example, a Buffer may be passed as
+an integer, but not a Window or Tabpage.
+
The most reliable way of determining the type codes for the special nvim types
is at runtime by inspecting the `types` key of metadata dictionary returned by
`vim_get_api_info` method. Here's an example json representation of the
@@ -216,7 +226,7 @@ that makes this task easier:
- Methods that operate instances of Nvim's types are prefixed with the type
name in lower case, e.g. `buffer_get_line` represents the `get_line` method
of a Buffer instance.
-- Global methods are prefixed with `vim`, e.g. `vim_list_buffers`.
+- Global methods are prefixed with `vim`, e.g. `vim_get_buffers`.
So, for an object-oriented language, a client library would have the classes
that represent Nvim's types, and the methods of each class could be defined
diff --git a/scripts/msgpack-gen.lua b/scripts/msgpack-gen.lua
index 9ff9b4cf6f..bb37ae94da 100644
--- a/scripts/msgpack-gen.lua
+++ b/scripts/msgpack-gen.lua
@@ -183,13 +183,20 @@ for i = 1, #functions do
local converted, convert_arg, param, arg
param = fn.parameters[j]
converted = 'arg_'..j
- if real_type(param[1]) ~= 'Object' then
- output:write('\n if (args.items['..(j - 1)..'].type != kObjectType'..real_type(param[1])..') {')
+ local rt = real_type(param[1])
+ if rt ~= 'Object' then
+ output:write('\n if (args.items['..(j - 1)..'].type == kObjectType'..rt..') {')
+ output:write('\n '..converted..' = args.items['..(j - 1)..'].data.'..rt:lower()..';')
+ if rt:match('^Buffer$') or rt:match('^Window$') or rt:match('^Tabpage$') or rt:match('^Boolean$') then
+ -- accept positive integers for Buffers, Windows and Tabpages
+ output:write('\n } else if (args.items['..(j - 1)..'].type == kObjectTypeInteger && args.items['..(j - 1)..'].data.integer > 0) {')
+ output:write('\n '..converted..' = (unsigned)args.items['..(j - 1)..'].data.integer;')
+ end
+ output:write('\n } else {')
output:write('\n snprintf(error->msg, sizeof(error->msg), "Wrong type for argument '..j..', expecting '..param[1]..'");')
output:write('\n error->set = true;')
output:write('\n goto cleanup;')
- output:write('\n }')
- output:write('\n '..converted..' = args.items['..(j - 1)..'].data.'..real_type(param[1]):lower()..';\n')
+ output:write('\n }\n')
else
output:write('\n '..converted..' = args.items['..(j - 1)..'];\n')
end
diff --git a/src/nvim/api/private/defs.h b/src/nvim/api/private/defs.h
index 76ac23a521..6c8e324649 100644
--- a/src/nvim/api/private/defs.h
+++ b/src/nvim/api/private/defs.h
@@ -22,6 +22,15 @@ typedef enum {
kErrorTypeValidation
} ErrorType;
+typedef enum {
+ kMessageTypeRequest,
+ kMessageTypeResponse,
+ kMessageTypeNotification
+} MessageType;
+
+/// Used as the message ID of notifications.
+#define NO_RESPONSE UINT64_MAX
+
typedef struct {
ErrorType type;
char msg[1024];
diff --git a/src/nvim/api/private/helpers.c b/src/nvim/api/private/helpers.c
index 492da25a82..67ff77ebac 100644
--- a/src/nvim/api/private/helpers.c
+++ b/src/nvim/api/private/helpers.c
@@ -405,6 +405,9 @@ bool object_to_vim(Object obj, typval_T *tv, Error *err)
tv->vval.v_number = obj.data.boolean;
break;
+ case kObjectTypeBuffer:
+ case kObjectTypeWindow:
+ case kObjectTypeTabpage:
case kObjectTypeInteger:
if (obj.data.integer > INT_MAX || obj.data.integer < INT_MIN) {
api_set_error(err, Validation, _("Integer value outside range"));
diff --git a/src/nvim/msgpack_rpc/channel.c b/src/nvim/msgpack_rpc/channel.c
index fc0409e137..b671b8b545 100644
--- a/src/nvim/msgpack_rpc/channel.c
+++ b/src/nvim/msgpack_rpc/channel.c
@@ -225,7 +225,25 @@ Object channel_send_call(uint64_t id,
channel->pending_requests--;
if (frame.errored) {
- api_set_error(err, Exception, "%s", frame.result.data.string.data);
+ if (frame.result.type == kObjectTypeString) {
+ api_set_error(err, Exception, "%s", frame.result.data.string.data);
+ } else if (frame.result.type == kObjectTypeArray) {
+ // Should be an error in the form [type, message]
+ Array array = frame.result.data.array;
+ if (array.size == 2 && array.items[0].type == kObjectTypeInteger
+ && (array.items[0].data.integer == kErrorTypeException
+ || array.items[0].data.integer == kErrorTypeValidation)
+ && array.items[1].type == kObjectTypeString) {
+ err->type = (ErrorType) array.items[0].data.integer;
+ xstrlcpy(err->msg, array.items[1].data.string.data, sizeof(err->msg));
+ err->set = true;
+ } else {
+ api_set_error(err, Exception, "%s", "unknown error");
+ }
+ } else {
+ api_set_error(err, Exception, "%s", "unknown error");
+ }
+
api_free_object(frame.result);
}
@@ -435,18 +453,18 @@ static void handle_request(Channel *channel, msgpack_object *request)
// Retrieve the request handler
MsgpackRpcRequestHandler handler;
- msgpack_object method = request->via.array.ptr[2];
+ msgpack_object *method = msgpack_rpc_method(request);
- if (method.type == MSGPACK_OBJECT_BIN || method.type == MSGPACK_OBJECT_STR) {
- handler = msgpack_rpc_get_handler_for(method.via.bin.ptr,
- method.via.bin.size);
+ if (method) {
+ handler = msgpack_rpc_get_handler_for(method->via.bin.ptr,
+ method->via.bin.size);
} else {
handler.fn = msgpack_rpc_handle_missing_method;
handler.defer = false;
}
Array args = ARRAY_DICT_INIT;
- msgpack_rpc_to_array(request->via.array.ptr + 3, &args);
+ msgpack_rpc_to_array(msgpack_rpc_args(request), &args);
bool defer = (!kv_size(channel->call_stack) && handler.defer);
RequestEvent *event_data = xmalloc(sizeof(RequestEvent));
event_data->channel = channel;
@@ -469,14 +487,18 @@ static void on_request_event(Event event)
uint64_t request_id = e->request_id;
Error error = ERROR_INIT;
Object result = handler.fn(channel->id, request_id, args, &error);
- // send the response
- msgpack_packer response;
- msgpack_packer_init(&response, &out_buffer, msgpack_sbuffer_write);
- channel_write(channel, serialize_response(channel->id,
- request_id,
- &error,
- result,
- &out_buffer));
+ if (request_id != NO_RESPONSE) {
+ // send the response
+ msgpack_packer response;
+ msgpack_packer_init(&response, &out_buffer, msgpack_sbuffer_write);
+ channel_write(channel, serialize_response(channel->id,
+ request_id,
+ &error,
+ result,
+ &out_buffer));
+ } else {
+ api_free_object(result);
+ }
// All arguments were freed already, but we still need to free the array
xfree(args.items);
decref(channel);
diff --git a/src/nvim/msgpack_rpc/helpers.c b/src/nvim/msgpack_rpc/helpers.c
index 355176aa5f..7d0db9a9b8 100644
--- a/src/nvim/msgpack_rpc/helpers.c
+++ b/src/nvim/msgpack_rpc/helpers.c
@@ -351,49 +351,86 @@ void msgpack_rpc_serialize_response(uint64_t response_id,
}
}
+static bool msgpack_rpc_is_notification(msgpack_object *req)
+{
+ return req->via.array.ptr[0].via.u64 == 2;
+}
+
+msgpack_object *msgpack_rpc_method(msgpack_object *req)
+{
+ msgpack_object *obj = req->via.array.ptr
+ + (msgpack_rpc_is_notification(req) ? 1 : 2);
+ return obj->type == MSGPACK_OBJECT_STR || obj->type == MSGPACK_OBJECT_BIN ?
+ obj : NULL;
+}
+
+msgpack_object *msgpack_rpc_args(msgpack_object *req)
+{
+ msgpack_object *obj = req->via.array.ptr
+ + (msgpack_rpc_is_notification(req) ? 2 : 3);
+ return obj->type == MSGPACK_OBJECT_ARRAY ? obj : NULL;
+}
+
+static msgpack_object *msgpack_rpc_msg_id(msgpack_object *req)
+{
+ if (msgpack_rpc_is_notification(req)) {
+ return NULL;
+ }
+ msgpack_object *obj = &req->via.array.ptr[1];
+ return obj->type == MSGPACK_OBJECT_POSITIVE_INTEGER ? obj : NULL;
+}
+
void msgpack_rpc_validate(uint64_t *response_id,
msgpack_object *req,
Error *err)
{
// response id not known yet
- *response_id = 0;
+ *response_id = NO_RESPONSE;
// Validate the basic structure of the msgpack-rpc payload
if (req->type != MSGPACK_OBJECT_ARRAY) {
- api_set_error(err, Validation, _("Request is not an array"));
+ api_set_error(err, Validation, _("Message is not an array"));
return;
}
- if (req->via.array.size != 4) {
- api_set_error(err, Validation, _("Request array size should be 4"));
+ if (req->via.array.size == 0) {
+ api_set_error(err, Validation, _("Message is empty"));
return;
}
- if (req->via.array.ptr[1].type != MSGPACK_OBJECT_POSITIVE_INTEGER) {
- api_set_error(err, Validation, _("Id must be a positive integer"));
+ if (req->via.array.ptr[0].type != MSGPACK_OBJECT_POSITIVE_INTEGER) {
+ api_set_error(err, Validation, _("Message type must be an integer"));
return;
}
- // Set the response id, which is the same as the request
- *response_id = req->via.array.ptr[1].via.u64;
-
- if (req->via.array.ptr[0].type != MSGPACK_OBJECT_POSITIVE_INTEGER) {
- api_set_error(err, Validation, _("Message type must be an integer"));
+ uint64_t type = req->via.array.ptr[0].via.u64;
+ if (type != kMessageTypeRequest && type != kMessageTypeNotification) {
+ api_set_error(err, Validation, _("Unknown message type"));
return;
}
- if (req->via.array.ptr[0].via.u64 != 0) {
- api_set_error(err, Validation, _("Message type must be 0"));
+ if ((type == kMessageTypeRequest && req->via.array.size != 4) ||
+ (type == kMessageTypeNotification && req->via.array.size != 3)) {
+ api_set_error(err, Validation, _("Request array size should be 4 (request) "
+ "or 3 (notification)"));
return;
}
- if (req->via.array.ptr[2].type != MSGPACK_OBJECT_BIN
- && req->via.array.ptr[2].type != MSGPACK_OBJECT_STR) {
+ if (type == kMessageTypeRequest) {
+ msgpack_object *id_obj = msgpack_rpc_msg_id(req);
+ if (!id_obj) {
+ api_set_error(err, Validation, _("ID must be a positive integer"));
+ return;
+ }
+ *response_id = id_obj->via.u64;
+ }
+
+ if (!msgpack_rpc_method(req)) {
api_set_error(err, Validation, _("Method must be a string"));
return;
}
- if (req->via.array.ptr[3].type != MSGPACK_OBJECT_ARRAY) {
+ if (!msgpack_rpc_args(req)) {
api_set_error(err, Validation, _("Parameters must be an array"));
return;
}
diff --git a/test/functional/api/server_requests_spec.lua b/test/functional/api/server_requests_spec.lua
index a37c41294b..34669c5f29 100644
--- a/test/functional/api/server_requests_spec.lua
+++ b/test/functional/api/server_requests_spec.lua
@@ -3,8 +3,8 @@
-- be running.
local helpers = require('test.functional.helpers')
local clear, nvim, eval = helpers.clear, helpers.nvim, helpers.eval
-local eq, run, stop = helpers.eq, helpers.run, helpers.stop
-
+local eq, neq, run, stop = helpers.eq, helpers.neq, helpers.run, helpers.stop
+local nvim_prog = helpers.nvim_prog
describe('server -> client', function()
@@ -115,4 +115,44 @@ describe('server -> client', function()
eq(expected, notified)
end)
end)
+
+ describe('when the client is a recursive vim instance', function()
+ before_each(function()
+ nvim('command', "let vim = rpcstart('"..nvim_prog.."', ['--embed'])")
+ neq(0, eval('vim'))
+ end)
+
+ after_each(function() nvim('command', 'call rpcstop(vim)') end)
+
+ it('can send/recieve notifications and make requests', function()
+ nvim('command', "call rpcnotify(vim, 'vim_set_current_line', 'SOME TEXT')")
+
+ -- Wait for the notification to complete.
+ nvim('command', "call rpcrequest(vim, 'vim_eval', '0')")
+
+ eq('SOME TEXT', eval("rpcrequest(vim, 'vim_get_current_line')"))
+ end)
+
+ it('can communicate buffers, tabpages, and windows', function()
+ eq({3}, eval("rpcrequest(vim, 'vim_get_tabpages')"))
+ eq({1}, eval("rpcrequest(vim, 'vim_get_windows')"))
+
+ local buf = eval("rpcrequest(vim, 'vim_get_buffers')")[1]
+ eq(2, buf)
+
+ eval("rpcnotify(vim, 'buffer_set_line', "..buf..", 0, 'SOME TEXT')")
+ nvim('command', "call rpcrequest(vim, 'vim_eval', '0')") -- wait
+
+ eq('SOME TEXT', eval("rpcrequest(vim, 'buffer_get_line', "..buf..", 0)"))
+
+ -- Call get_line_slice(buf, range [0,0], includes start, includes end)
+ eq({'SOME TEXT'}, eval("rpcrequest(vim, 'buffer_get_line_slice', "..buf..", 0, 0, 1, 1)"))
+ end)
+
+ it('returns an error if the request failed', function()
+ local status, err = pcall(eval, "rpcrequest(vim, 'does-not-exist')")
+ eq(false, status)
+ eq(true, string.match(err, ': (.*)') == 'Failed to evaluate expression')
+ end)
+ end)
end)
diff --git a/third-party/cmake/BuildLuarocks.cmake b/third-party/cmake/BuildLuarocks.cmake
index d02b1939b5..fabceac3d8 100644
--- a/third-party/cmake/BuildLuarocks.cmake
+++ b/third-party/cmake/BuildLuarocks.cmake
@@ -56,8 +56,10 @@ add_custom_target(stable-busted-deps
add_custom_command(OUTPUT ${DEPS_BIN_DIR}/busted
COMMAND ${DEPS_BIN_DIR}/luarocks
- ARGS build https://raw.githubusercontent.com/Olivine-Labs/busted/master/busted-scm-0.rockspec CC=${DEPS_C_COMPILER} LD=${DEPS_C_COMPILER}
- ${DEPS_INSTALL_DIR}/share/lua/5.1/busted/outputHandlers
+ ## Drop back to:
+ ## https://raw.githubusercontent.com/Olivine-Labs/busted/master/busted-scm-0.rockspec
+ ## once the spec file is fixed in busted.
+ ARGS build https://raw.githubusercontent.com/Olivine-Labs/busted/f803173cc136f7370f7416254eaf3bada01b04a9/busted-scm-0.rockspec CC=${DEPS_C_COMPILER} LD=${DEPS_C_COMPILER}
DEPENDS stable-busted-deps)
add_custom_target(busted
DEPENDS ${DEPS_BIN_DIR}/busted)
generated by cgit (git 2.34.1) at 2025-06-05 19:13:55 +0000