aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/provider
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim/provider')
-rw-r--r--runtime/lua/vim/provider/perl.lua66
-rw-r--r--runtime/lua/vim/provider/python.lua150
-rw-r--r--runtime/lua/vim/provider/ruby.lua61
3 files changed, 277 insertions, 0 deletions
diff --git a/runtime/lua/vim/provider/perl.lua b/runtime/lua/vim/provider/perl.lua
new file mode 100644
index 0000000000..da4af0a2a7
--- /dev/null
+++ b/runtime/lua/vim/provider/perl.lua
@@ -0,0 +1,66 @@
+local M = {}
+local s_err ---@type string?
+local s_host ---@type string?
+
+function M.require(host, prog)
+ local args = { prog, '-e', 'use Neovim::Ext; start_host();' }
+
+ -- Collect registered perl plugins into args
+ local perl_plugins = vim.fn['remote#host#PluginsForHost'](host.name) ---@type any
+ ---@param plugin any
+ for _, plugin in ipairs(perl_plugins) do
+ table.insert(args, plugin.path)
+ end
+
+ return vim.fn['provider#Poll'](args, host.orig_name, '$NVIM_PERL_LOG_FILE')
+end
+
+--- @return string? path to detected perl, if any; nil if not found
+--- @return string? error message if perl can't be detected; nil if success
+function M.detect()
+ -- use g:perl_host_prog if set or check if perl is on the path
+ local prog = vim.fn.exepath(vim.g.perl_host_prog or 'perl')
+ if prog == '' then
+ return nil, 'No perl executable found'
+ end
+
+ -- if perl is available, make sure we have 5.22+
+ vim.fn.system({ prog, '-e', 'use v5.22' })
+ if vim.v.shell_error ~= 0 then
+ return nil, 'Perl version is too old, 5.22+ required'
+ end
+
+ -- if perl is available, make sure the required module is available
+ vim.fn.system({ prog, '-W', '-MNeovim::Ext', '-e', '' })
+ if vim.v.shell_error ~= 0 then
+ return nil, '"Neovim::Ext" cpan module is not installed'
+ end
+ return prog, nil
+end
+
+function M.call(method, args)
+ if s_err then
+ return
+ end
+
+ if not s_host then
+ -- Ensure that we can load the Perl host before bootstrapping
+ local ok, result = pcall(vim.fn['remote#host#Require'], 'legacy-perl-provider') ---@type any, any
+ if not ok then
+ s_err = result
+ vim.api.nvim_echo({ { result, 'WarningMsg' } }, true, {})
+ return
+ end
+ s_host = result
+ end
+
+ return vim.fn.rpcrequest(s_host, 'perl_' .. method, unpack(args))
+end
+
+function M.start()
+ -- The perl provider plugin will run in a separate instance of the perl host.
+ vim.fn['remote#host#RegisterClone']('legacy-perl-provider', 'perl')
+ vim.fn['remote#host#RegisterPlugin']('legacy-perl-provider', 'ScriptHost.pm', {})
+end
+
+return M
diff --git a/runtime/lua/vim/provider/python.lua b/runtime/lua/vim/provider/python.lua
new file mode 100644
index 0000000000..8322131238
--- /dev/null
+++ b/runtime/lua/vim/provider/python.lua
@@ -0,0 +1,150 @@
+local M = {}
+local min_version = '3.7'
+local s_err ---@type string?
+local s_host ---@type string?
+
+local python_candidates = {
+ 'python3',
+ 'python3.12',
+ 'python3.11',
+ 'python3.10',
+ 'python3.9',
+ 'python3.8',
+ 'python3.7',
+ 'python',
+}
+
+--- @param prog string
+--- @param module string
+--- @return integer, string
+local function import_module(prog, module)
+ local program = [[
+import sys, importlib.util;
+sys.path = [p for p in sys.path if p != ""];
+sys.stdout.write(str(sys.version_info[0]) + "." + str(sys.version_info[1]));]]
+
+ program = program
+ .. string.format('sys.exit(2 * int(importlib.util.find_spec("%s") is None))', module)
+
+ local out = vim.system({ prog, '-W', 'ignore', '-c', program }):wait()
+ return out.code, assert(out.stdout)
+end
+
+--- @param prog string
+--- @param module string
+--- @return string?
+local function check_for_module(prog, module)
+ local prog_path = vim.fn.exepath(prog)
+ if prog_path == '' then
+ return prog .. ' not found in search path or not executable.'
+ end
+
+ -- Try to load module, and output Python version.
+ -- Exit codes:
+ -- 0 module can be loaded.
+ -- 2 module cannot be loaded.
+ -- Otherwise something else went wrong (e.g. 1 or 127).
+ local prog_exitcode, prog_version = import_module(prog, module)
+ if prog_exitcode == 2 or prog_exitcode == 0 then
+ -- Check version only for expected return codes.
+ if vim.version.lt(prog_version, min_version) then
+ return string.format(
+ '%s is Python %s and cannot provide Python >= %s.',
+ prog_path,
+ prog_version,
+ min_version
+ )
+ end
+ end
+
+ if prog_exitcode == 2 then
+ return string.format('%s does not have the "%s" module.', prog_path, module)
+ elseif prog_exitcode == 127 then
+ -- This can happen with pyenv's shims.
+ return string.format('%s does not exist: %s', prog_path, prog_version)
+ elseif prog_exitcode ~= 0 then
+ return string.format(
+ 'Checking %s caused an unknown error. (%s, output: %s) Report this at https://github.com/neovim/neovim',
+ prog_path,
+ prog_exitcode,
+ prog_version
+ )
+ end
+
+ return nil
+end
+
+--- @param module string
+--- @return string? path to detected python, if any; nil if not found
+--- @return string? error message if python can't be detected by {module}; nil if success
+function M.detect_by_module(module)
+ local python_exe = vim.fn.expand(vim.g.python3_host_prog or '', true)
+
+ if python_exe ~= '' then
+ return vim.fn.exepath(vim.fn.expand(python_exe, true)), nil
+ end
+
+ local errors = {}
+ for _, exe in ipairs(python_candidates) do
+ local error = check_for_module(exe, module)
+ if not error then
+ return exe, error
+ end
+ -- Accumulate errors in case we don't find any suitable Python executable.
+ table.insert(errors, error)
+ end
+
+ -- No suitable Python executable found.
+ return nil, 'Could not load Python :\n' .. table.concat(errors, '\n')
+end
+
+function M.require(host)
+ -- Python host arguments
+ local prog = M.detect_by_module('neovim')
+ local args = {
+ prog,
+ '-c',
+ 'import sys; sys.path = [p for p in sys.path if p != ""]; import neovim; neovim.start_host()',
+ }
+
+ -- Collect registered Python plugins into args
+ local python_plugins = vim.fn['remote#host#PluginsForHost'](host.name) ---@type any
+ ---@param plugin any
+ for _, plugin in ipairs(python_plugins) do
+ table.insert(args, plugin.path)
+ end
+
+ return vim.fn['provider#Poll'](
+ args,
+ host.orig_name,
+ '$NVIM_PYTHON_LOG_FILE',
+ { ['overlapped'] = true }
+ )
+end
+
+function M.call(method, args)
+ if s_err then
+ return
+ end
+
+ if not s_host then
+ -- Ensure that we can load the Python3 host before bootstrapping
+ local ok, result = pcall(vim.fn['remote#host#Require'], 'legacy-python3-provider') ---@type any, any
+ if not ok then
+ s_err = result
+ vim.api.nvim_echo({ { result, 'WarningMsg' } }, true, {})
+ return
+ end
+ s_host = result
+ end
+
+ return vim.fn.rpcrequest(s_host, 'python_' .. method, unpack(args))
+end
+
+function M.start()
+ -- The Python3 provider plugin will run in a separate instance of the Python3 host.
+ vim.fn['remote#host#RegisterClone']('legacy-python3-provider', 'python3')
+ vim.fn['remote#host#RegisterPlugin']('legacy-python3-provider', 'script_host.py', {})
+end
+
+return M
diff --git a/runtime/lua/vim/provider/ruby.lua b/runtime/lua/vim/provider/ruby.lua
new file mode 100644
index 0000000000..3ad86001f3
--- /dev/null
+++ b/runtime/lua/vim/provider/ruby.lua
@@ -0,0 +1,61 @@
+local M = {}
+local s_err ---@type string?
+local s_host ---@type string?
+
+function M.require(host)
+ local prog = M.detect()
+ local args = { prog }
+ local ruby_plugins = vim.fn['remote#host#PluginsForHost'](host.name) ---@type any
+
+ ---@param plugin any
+ for _, plugin in ipairs(ruby_plugins) do
+ table.insert(args, plugin.path)
+ end
+
+ return vim.fn['provider#Poll'](args, host.orig_name, '$NVIM_RUBY_LOG_FILE')
+end
+
+function M.call(method, args)
+ if s_err then
+ return
+ end
+
+ if not s_host then
+ local ok, result = pcall(vim.fn['remote#host#Require'], 'legacy-ruby-provider') ---@type any, any
+ if not ok then
+ s_err = result
+ vim.api.nvim_echo({ { result, 'WarningMsg' } }, true, {})
+ return
+ end
+ s_host = result
+ end
+
+ return vim.fn.rpcrequest(s_host, 'ruby_' .. method, unpack(args))
+end
+
+function M.detect()
+ local prog ---@type string
+ if vim.g.ruby_host_prog then
+ prog = vim.fn.expand(vim.g.ruby_host_prog, true)
+ elseif vim.fn.has('win32') == 1 then
+ prog = vim.fn.exepath('neovim-ruby-host.bat')
+ else
+ local p = vim.fn.exepath('neovim-ruby-host')
+ if p == '' then
+ prog = ''
+ else
+ -- neovim-ruby-host could be an rbenv shim for another Ruby version.
+ vim.fn.system(p)
+ prog = vim.v.shell_error ~= 0 and '' or p
+ end
+ end
+ local err = prog == '' and 'missing ruby or ruby-host' or ''
+ return prog, err
+end
+
+function M.start(plugin_path)
+ vim.fn['remote#host#RegisterClone']('legacy-ruby-provider', 'ruby')
+ vim.fn['remote#host#RegisterPlugin']('legacy-ruby-provider', plugin_path, {})
+end
+
+return M
generated by cgit (git 2.34.1) at 2025-04-28 19:06:28 +0000