api: nvim_ex_call_luaref

src/nvim/api/vim.c

@@ -634,6 +634,62 @@ Object nvim_call_function(String fn, Array args, Error *err)
   return _call_function(fn, args, NULL, err);
 }
 
+/// nvim_ex_call_function({noautocmd = true}, my_lua_cb, x, y, z)
+///
+/// local callable = vim.ex_wrap({autocmd = false}, my_lua_cb)
+/// callable(x, y, z)
+/// local wrapped = vim.
+//
+// nvim_ex_call_function({bufdo = {1, 3, 7, 8}}, my_lua_cb, ...)
+Object nvim_ex_call_luaref(Dictionary opts, LuaRef cb, Array args, Error *err)
+  FUNC_API_SINCE(7) FUNC_API_LUA_ONLY
+{
+  bool do_autocmds = true;
+  bool silent = false;
+
+  // TODO(tjdevries): Use the cool macro I made in the other PR
+  for (size_t i = 0; i < opts.size; i++) {
+    String k = opts.items[i].key;
+    Object v = opts.items[i].value;
+
+    if (strequal("autocmd", k.data)) {
+      do_autocmds = api_object_to_bool(v, "autocmd", true, err);
+    } else if (strequal("silent", k.data)) {
+      silent = api_object_to_bool(v, "silent", false, err);
+    } else {
+      api_set_error(err, kErrorTypeValidation, "Invalid key: %s", k.data);
+    }
+  }
+
+  char_u *save_eventignore;
+  if (!do_autocmds) {
+    save_eventignore = vim_strsave(p_ei);
+    set_string_option_direct(
+        (char_u *)"eventignore", -1, (char_u *)"all", OPT_FREE, SID_NONE);
+  }
+
+  bool save_silent;
+  if (silent) {
+    save_silent = emsg_silent;
+    emsg_silent = true;
+  }
+
+  // Undefined behavior if you call vim.wait inside of here?...
+  Object rv = nlua_call_ref(cb, NULL, args, true, err);
+
+  if (!do_autocmds) {
+    set_string_option_direct(
+        (char_u *)"eventignore", -1, save_eventignore, OPT_FREE, SID_NONE);
+    free_string_option(save_eventignore);
+  }
+
+  if (silent) {
+    emsg_silent = save_silent;
+  }
+
+  return rv;
+}
+
 /// Calls a VimL |Dictionary-function| with the given arguments.
 ///
 /// On execution error: fails with VimL error, does not update v:errmsg.

test/functional/api/vim_spec.lua

@@ -168,7 +168,7 @@ describe('API', function()
       os.remove(fname)
     end)
 
-    it('traceback', function()
+    pending('traceback', function()
       local fname = tmpname()
       write_file(fname, 'echo "hello"\n')
       local sourcing_fname = tmpname()
@@ -1906,4 +1906,35 @@ describe('API', function()
          or endswith(val[1], p("autoload/remote/host.vim")))
     end)
   end)
+
+  describe('nvim_ex_call_luaref', function()
+    it('should return values when no configuration is passed', function()
+      eq(true, meths.exec_lua("return vim.api.nvim_ex_call_luaref({}, function() return true end, {})", {}))
+    end)
+
+    it('should disable autocmds when passed', function()
+      eq(true, meths.exec_lua("return vim.api.nvim_ex_call_luaref({autocmd = false}, function() return true end, {})", {}))
+
+      eq(1, meths.exec_lua([[
+        vim.g.autocmd_count = 0
+        vim.cmd [=[autocmd FileType * let g:autocmd_count = g:autocmd_count + 1]=]
+
+        local autocmd_incrementer = function() vim.cmd [=[doautocmd FileType]=] end
+
+        vim.api.nvim_ex_call_luaref({autocmd = true}, autocmd_incrementer, {})
+        vim.api.nvim_ex_call_luaref({autocmd = false}, autocmd_incrementer, {})
+
+        return vim.g.autocmd_count
+      ]], {}))
+    end)
+
+    it('should ignore errors when silent is passed', function()
+      eq({'Begin', nil}, meths.exec_lua([[
+        return {
+          vim.api.nvim_ex_call_luaref({silent = true}, function() return 'Begin' end, {}),
+          vim.api.nvim_ex_call_luaref({silent = true}, function() error("HELLO?") end, {})
+        }
+      ]], {}))
+    end)
+  end)
 end)