refactor(rpc): pass more ctx ($FZF_* envs)

chore: types

Author: phanen

lua/fzf-lua/previewer/init.lua

@@ -99,16 +99,13 @@ Previewer.normalize_spec = function(preview, opts)
   if type(preview) == "function" then
     return (FzfLua.shell.stringify_data(preview, opts, "{}"))
   elseif type(preview) == "table" then
-    preview = vim.tbl_extend("keep", preview, {
-      fn = preview.fn or preview[1],
-      -- by default we use current item only "{}"
-      -- using "{+}" will send multiple selected items
-      field_index = "{}",
-    })
-    if preview.type == "cmd" then
-      return (FzfLua.shell.stringify_cmd(preview.fn, opts, preview.field_index))
-    end
-    return (FzfLua.shell.stringify_data(preview.fn, opts, preview.field_index))
+    local func = assert(preview.fn or preview[1])
+    -- by default we use current item only "{}"
+    -- using "{+}" will send multiple selected items
+    local field_index = preview.field_index or "{}"
+    local stringify = preview.type == "cmd" and FzfLua.shell.stringify_cmd
+        or FzfLua.shell.stringify_data
+    return (stringify(func, opts, field_index))
   else
     return preview
   end

lua/fzf-lua/rpc.lua

@@ -58,28 +58,25 @@ server_listen(server_socket, server_socket_path)
 -- local thread = uv.new_thread(server_listen, server_socket, server_socket_path)
 -- io.stdout:write(string.format("thread %s\n", tostring(thread)))
 
+---@class fzf-lua.rpc.Ctx
+---@field function_id string An identifier for the RPC function to be executed.
+---@field pipe_path string The path to the Unix domain socket for RPC communication.
+---@field selection? string[] The selected item(s) (expanded from field expression).
+---@field env table<string, string> Environment variables inherited by the RPC process.
+
+---@param opts table
 local rpc_nvim_exec_lua = function(opts)
+  ---@type fzf-lua.rpc.Ctx
+  local ctx = {
+    function_id = opts.fnc_id,
+    pipe_path = server_socket_path,
+    selection = opts.selection,
+    env = vim.uv.os_environ(),
+  }
   local success, errmsg = pcall(function()
-    -- for skim compatibility
-    local preview_lines = vim.env.FZF_PREVIEW_LINES or vim.env.LINES
-    local preview_cols = vim.env.FZF_PREVIEW_COLUMNS or vim.env.COLUMNS
     local chan_id = vim.fn.sockconnect("pipe", opts.fzf_lua_server, { rpc = true })
-    vim.rpcrequest(chan_id, "nvim_exec_lua", [[
-      local luaargs = {...}
-      local function_id = luaargs[1]
-      local server_socket_path = luaargs[2]
-      local fzf_selection = luaargs[3]
-      local fzf_lines = luaargs[4]
-      local fzf_columns = luaargs[5]
-      local usr_func = require"fzf-lua.shell".get_func(function_id)
-      return usr_func(server_socket_path, fzf_selection, fzf_lines, fzf_columns)
-    ]], {
-      opts.fnc_id,
-      server_socket_path,
-      opts.fzf_selection,
-      tonumber(preview_lines),
-      tonumber(preview_cols),
-    })
+    vim.rpcrequest(chan_id, "nvim_exec_lua",
+      [[return require"fzf-lua.shell".get_func((...).function_id)(...)]], { ctx })
     vim.fn.chanclose(chan_id)
   end)
 
@@ -106,7 +103,7 @@ end
 
 local args = vim.deepcopy(_G.arg)
 args[0] = nil -- remove filename
-local opts = {
+rpc_nvim_exec_lua({
   fnc_id = tonumber(table.remove(args, 1)),
   debug = (function()
     local ret = table.remove(args, 1)
@@ -120,7 +117,6 @@ local opts = {
       return tonumber(ret) or tostring(ret)
     end
   end)(),
-  fzf_selection = args,
+  selection = args,
   fzf_lua_server = vim.env.FZF_LUA_SERVER or vim.env.SKIM_FZF_LUA_SERVER or vim.env.NVIM,
-}
-rpc_nvim_exec_lua(opts)
+})

lua/fzf-lua/shell.lua

@@ -127,24 +127,28 @@ end
 function M.pipe_wrap_fn(fn, fzf_field_index, debug)
   fzf_field_index = fzf_field_index or "{+}"
 
-  local receiving_function = function(pipe_path, ...)
+  ---@param ctx fzf-lua.rpc.Ctx
+  local receiving_function = function(ctx)
     local pipe = assert(uv.new_pipe(false))
-    local args = { ... }
+    local pipe_path = ctx.pipe_path
     -- unescape double backslashes on windows
-    if utils.__IS_WINDOWS and type(args[1]) == "table" then
-      args[1] = vim.tbl_map(function(x)
+    if utils.__IS_WINDOWS and type(ctx.selection) == "table" then
+      ctx.selection = vim.tbl_map(function(x)
         return libuv.unescape_fzf(x, vim.g.fzf_lua_fzf_version)
-      end, args[1])
+      end, ctx.selection)
     end
-    utils.get_info().selected = args[1] and args[1][1] or nil
+    -- for skim compatibility
+    local preview_lines = tonumber(ctx.env.FZF_PREVIEW_LINES or ctx.env.LINES)
+    local preview_cols = tonumber(ctx.env.FZF_PREVIEW_COLUMNS or ctx.env.COLUMNS)
+    utils.get_info().selected = (ctx.selection or {})[1]
     uv.pipe_connect(pipe, pipe_path, function(err)
       if err then
         ---@diagnostic disable-next-line: undefined-field
         err = uv.translate_sys_error(uv.errno[err])
         utils.warn(string.format("pipe_connect(%s) failed with error: %s", pipe_path, err))
       else
         vim.schedule(function()
-          fn(pipe, unpack(args))
+          fn(pipe, ctx.selection, preview_lines, preview_cols, ctx)
         end)
       end
     end)
@@ -295,15 +299,15 @@ M.stringify = function(contents, opts, fzf_field_index)
   end
 
   local cmd, id = M.pipe_wrap_fn(function(pipe, ...)
-    local args = { ... }
+    local args, n = { ... }, select("#", ...)
     -- Contents could be dependent or args, e.g. live_grep which
     -- generates a different command based on the typed query
     -- redefine local contents to prevent override on function call
     ---@type fzf-lua.content, table?
     ---@diagnostic disable-next-line: redefined-local, assign-type-mismatch
     local contents, env = (function()
-      local ret = opts.is_live and type(contents) == "function" and contents(unpack(args), opts)
-          or opts.__stringify_cmd and contents(unpack(args))
+      local ret = (opts.is_live and type(contents) == "function" and contents(unpack(args), opts))
+          or (opts.__stringify_cmd and type(contents) == "function" and contents(unpack(args, 1, n)))
           or contents
       if opts.__stringify_cmd and type(ret) == "table" then
         return ret.cmd, (ret.env or opts.env)
@@ -428,7 +432,7 @@ M.stringify = function(contents, opts, fzf_field_index)
           vim.tbl_map(function(x) on_write_nl(x) end, contents)
           on_finish()
         elseif type(contents) == "function" then
-          contents(on_write_nl, on_write, unpack(args))
+          contents(on_write_nl, on_write, unpack(args, 1, n))
         end
       end, debug.traceback)
       if not ok and err then
@@ -442,9 +446,9 @@ M.stringify = function(contents, opts, fzf_field_index)
 end
 
 ---@alias fzf-lua.shell.cmdSpec string|{ cmd: string|string[], env: table? }?
----@alias fzf-lua.shell.cmd fun(items: string[], fzf_lines: integer, fzf_columns: integer): fzf-lua.shell.cmdSpec
----@alias fzf-lua.shell.data fun(items: string[], fzf_lines: integer, fzf_columns: integer): fzf-lua.content?
----@alias fzf-lua.shell.data2 fun(items: string[], opts: fzf-lua.config.Resolved|{}): fzf-lua.content?
+---@alias fzf-lua.shell.cmd fun(items: string[], fzf_lines: integer, fzf_columns: integer, ctx?: fzf-lua.rpc.Ctx): fzf-lua.shell.cmdSpec
+---@alias fzf-lua.shell.data fun(items: string[], fzf_lines: integer, fzf_columns: integer, ctx?: fzf-lua.rpc.Ctx): fzf-lua.content?
+---@alias fzf-lua.shell.data2 fun(items: string[], opts: fzf-lua.config.Resolved|{}, ctx?: fzf-lua.rpc.Ctx): fzf-lua.content?
 
 ---@param fn fzf-lua.shell.cmd
 ---@param opts table

lua/fzf-lua/types.lua

@@ -21,7 +21,7 @@ local FzfLua = require("fzf-lua")
 ---@field extmarks? table
 
 ---@class fzf-lua.cmd.Entry
----@field cmd string[] cmd used to generated content
+---@field cmd? string[] cmd used to generated content
 ---@field cmd_stream? boolean stream process cmd content
 ---@field cmd_opts? vim.SystemOpts vim.system opts for cmd
 
@@ -112,6 +112,11 @@ local FzfLua = require("fzf-lua")
 ---@field _EOL? string
 ---@field _debug? boolean
 
+---@class fzf-lua.PidObject
+---@field new fun(self: fzf-lua.PidObject, _, _): fzf-lua.PidObject
+---@field get fun(self: fzf-lua.PidObject): integer
+---@field set fun(self: fzf-lua.PidObject, pid: integer?)
+
 ---a basic config can be used by fzf_exec?
 ---generated from the result of `:=FzfLua.config.normalize_opts({}, {})`
 ---@class fzf-lua.config.Base
@@ -213,7 +218,7 @@ local FzfLua = require("fzf-lua")
 ---@field _headers? boolean
 
 ---@class fzf-lua.config.Resolved: fzf-lua.config.Base
----@field PidObject? table
+---@field PidObject? fzf-lua.PidObject
 ---@field _headers? string[]
 ---@field _fmt? table
 ---@field pipe_cmd? string

lua/fzf-lua/utils.lua

@@ -1621,6 +1621,9 @@ function M.lsp_get_clients(opts)
   end, clients)
 end
 
+---@param key string
+---@param opts table
+---@return fzf-lua.PidObject
 function M.pid_object(key, opts)
   local Pid = {}