@ 261105.2
current
---@diagnostic disable-next-line: deprecated
local uv = vim.uv or vim.loop
local utils = require "fzf-lua.utils"
local path = require "fzf-lua.path"
local libuv = require "fzf-lua.libuv"

-- path to current file
local _info = debug.getinfo(1, "S")
---@cast _info {source: string}
local __FILE__ = _info.source:gsub("^@", "")

---@class fzf-lua.lru
---@field max_size integer
---@field max_id integer
---@field last_id integer
---@field mru integer[]
---@field store any[]
---@field lookup table<integer, integer?>
local LRU = {}

function LRU:new(size)
  local obj = {
    max_size = size,
    -- Technically we can drop this var and let the IDs increment indefinitely
    -- but since the IDs are used in the shell command callback it makes it simpler
    -- to debug when it wraps around 1000 back to 1, size should be big enough to
    -- assert when accessing an evicted item and we wrapped around (if we set max
    -- ID to max size we will just rotate slots and return the wrong item)
    max_id = size * 20,
    last_id = 0,
    mru = {},
    store = {},
    lookup = {},
  }
  setmetatable(obj, self)
  self.__index = self
  return obj
end

---@param value any
---@return integer, integer? new element id and evicted id (if any)
function LRU:set(value)
  local store_idx, evicted_id
  local id = self.last_id + 1
  if id > self.max_id then id = 1 end
  if #self.store >= self.max_size then
    -- Evict the least recently used (last in MRU)
    evicted_id = table.remove(self.mru)
    store_idx = self.lookup[evicted_id]
    assert(store_idx)
    self.lookup[evicted_id] = nil
  else
    store_idx = #self.store + 1
  end
  -- New ID is inserted at the front of MRU
  table.insert(self.mru, 1, id)
  self.store[store_idx] = value
  self.lookup[id] = store_idx
  self.last_id = id
  return id, evicted_id
end

---@return integer
function LRU:len()
  return #self.store
end

---@param size integer
function LRU:set_size(size)
  assert(size >= self:len(), "new size cannot be smaller than current length")
  self.max_size = size
end

---@param id integer
---@return any
function LRU:get(id)
  local store_idx = self.lookup[id]
  assert(store_idx, string.format("attempt to get nonexistent id %d", id))
  -- Move id to the front of MRU
  for i = 1, #self.mru do
    if self.mru[i] == id then
      table.remove(self.mru, i)
      break
    end
  end
  table.insert(self.mru, 1, id)
  return self.store[store_idx]
end

-- Cache should be able to hold all function callbacks of a single picker
-- max cache size of 100 should be more than enough, we don't want it to be
-- too big as this will prevent clearing of referecnces to "opts" which
-- prevents garabage collection from freeing the resources
-- NOTE: with combine/global the no. of callbacks has increased significantly
-- so monitor the number of callbacks
local function new_cache(size) return LRU:new(size or 100) end
local _cache = new_cache()

local M = {}

-- Export LRU for testing
M.LRU = LRU

-- NOTE: CI ONLY - DO NOT USE
function M.cache_new(size) _cache = new_cache(size) end

function M.cache_set_size(size) _cache:set_size(size) end

function M.register_func(fn)
  return (_cache:set(fn))
end

function M.get_func(id)
  return _cache:get(id)
end

-- creates a new address to listen to messages from actions. This is important
-- if the user is using a custom fixed $NVIM_LISTEN_ADDRESS. Different neovim
-- instances will then use the same path as the address and it causes a mess,
-- i.e. actions stop working on the old instance. So we create our own (random
-- path) RPC server for this instance if it hasn't been started already.
-- NOT USED ANYMORE, we use `vim.g.fzf_lua_server` instead
-- local action_server_address = nil

---@param fn function
---@param fzf_field_index string
---@param debug? boolean|integer|"v"|"verbose"
---@return string, integer
function M.pipe_wrap_fn(fn, fzf_field_index, debug)
  fzf_field_index = fzf_field_index or "{+}"

  ---@param ctx fzf-lua.rpc.Ctx
  local receiving_function = function(ctx)
    local pipe = assert(uv.new_pipe(false))
    local pipe_path = ctx.pipe_path
    -- unescape double backslashes on windows
    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, ctx.selection)
    end
    -- 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, ctx.selection, preview_lines, preview_cols, ctx)
        end)
      end
    end)
  end

  local id = M.register_func(receiving_function)

  -- this is for windows WSL and AppImage users, their nvim path isn't just
  -- 'nvim', it can be something else
  local nvim_bin = os.getenv("FZF_LUA_NVIM_BIN") or vim.v.progpath

  -- all args after `-l` will be in `_G.args`
  local action_cmd = ("%s -u NONE -l %s %s %s %s"):format(
    libuv.shellescape(path.normalize(nvim_bin)),
    libuv.shellescape(path.normalize(path.join { vim.g.fzf_lua_directory, "rpc.lua" })),
    id,
    tostring(debug),
    fzf_field_index)

  return action_cmd, id
end

---@param v function
---@param varname string
---@return string
M.check_upvalue = function(v, varname)
  -- Attempt to convert function to its bytecode representation
  -- TODO: can be replaced with vim.base64 after neovim >= 0.10
  local str = string.format(
    [[return loadstring(require("fzf-lua.lib.base64").decode("%s"))]],
    require("fzf-lua.lib.base64").encode(string.dump(v, true)))
  -- Test the function once with nil value (imprefect?)
  -- to see if there's an issue with upvalue refs
  local f = assert(loadstring(str))()
  local ok, err = pcall(f) ---@cast err string
  assert(
    ok or (not err:match("attempt to index upvalue") and not err:match("attempt to call upvalue")),
    string.format("multiprocess '%s' cannot have upvalue references", varname))
  return str
end

-- stringify_mt: the wrapped multiprocess command is independent, most of it's
-- options are serialized as strings and the rest are read from the main instance
-- config over RPC, if the command doesn't require any processing it will be piped
-- directly to fzf using $FZF_DEFAULT_COMMAND
---@param contents fzf-lua.content|fzf-lua.shell.data2
---@param opts fzf-lua.config.Resolved
---@return string?
M.stringify_mt = function(contents, opts)
  if opts.multiprocess == false then return end
  ---@param o fzf-lua.config.Resolved
  ---@return table
  local filter_opts = function(o)
    local names = {
      "debug",
      "profiler",
      "process1",
      "silent",
      "cmd",
      "cwd",
      "cwd_only",
      "stdout",
      "stderr",
      "stderr_to_stdout",
      "formatter",
      "multiline",
      "git_dir",
      "git_worktree",
      "git_icons",
      "file_icons",
      "color_icons",
      "path_shorten",
      "absolute_path",
      "strip_cwd_prefix",
      "render_crlf",
      "exec_empty_query",
      "file_ignore_patterns",
      "rg_glob",
      "fn_transform",
      "fn_preprocess",
      "fn_postprocess",
      "is_live",
      "contents", -- different when opts.cmd is also used by e.g. get_grep_cmd
      utils.__IS_WINDOWS and "__FZF_VERSION" or nil,
    }
    -- caller requested rg with glob support
    if o.rg_glob then
      table.insert(names, "glob_flag")
      table.insert(names, "glob_separator")
    end
    local t = {}
    for _, name in ipairs(names) do
      if o[name] ~= nil then ---@diagnostic disable-next-line: assign-type-mismatch
        t[name] = o[name]
      end
    end
    t.g = {}
    for k, v in pairs({
      ["_fzf_lua_server"] = vim.g.fzf_lua_server,
      -- [NOTE] No longer needed, we use RPC for icons
      -- ["_devicons_path"] = devicons.plugin_path(),
      -- ["_devicons_setup"] = config._devicons_setup,
      ["_EOL"] = utils.map_get(o, "fzf_opts.--read0") and "\0" or "\n",
      ["_debug"] = o.debug,
    }) do
      t.g[k] = v
    end
    return t
  end

  -- `multiprocess=1` is "optional" if no opt which requires processing
  -- is present we return the command as is to be piped to fzf "natively"
  if opts.multiprocess ~= true and type(contents) == "string"
      and not opts.fn_transform
      and not opts.fn_preprocess
      and not opts.fn_postprocess
  then
    -- command does not require any processing
    return contents
    -- don't use mt for non-string contents unless multiprocess is explictly set to true
  elseif opts.multiprocess ~= true and type(contents) ~= "string" then
    return nil
  end
  opts.contents = contents
  return M.wrap_spawn_stdio(filter_opts(opts))
end

-- Contents sent to fzf can only be nil or a shell command (string)
-- the API accepts both tables and functions which we "stringify"
---@param contents table|string|fzf-lua.content|fzf-lua.shell.cmd|fzf-lua.shell.data|fzf-lua.shell.data2
---@param opts fzf-lua.config.Resolved|{}
---@param fzf_field_index string? Fzf field index expression, e.g. "{+}" (selected), "{q}" (query)
---@return string, integer?
M.stringify = function(contents, opts, fzf_field_index)
  ---@cast opts fzf-lua.config.Resolved
  -- TODO: should we let this assert?
  -- are there any conditions in which stringify is called subsequently?
  if opts.__stringified then ---@cast contents string
    return contents
  end

  -- Mark opts as already "stringified"
  assert(not opts.__stringified, "twice stringified")
  opts.__stringified = true

  -- Convert string callbacks to callback functions
  for _, k in ipairs({ "fn_transform", "fn_preprocess", "fn_postprocess" }) do
    opts[k] = libuv.load_fn(opts[k]) or opts[k]
  end

  local cmd, id = M.pipe_wrap_fn(function(pipe, ...)
    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()
      ---@diagnostic disable-next-line: param-type-mismatch
      local ret = (opts.is_live and type(contents) == "function" and contents(unpack(args), opts))
          ---@diagnostic disable-next-line: param-type-mismatch
          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
        ---@diagnostic disable-next-line: undefined-field
        return ret.cmd, (ret.env or opts.env)
      else
        return ret, opts.env
      end
    end)()
    local write_cb_count = 0
    local pipe_want_close = false
    local EOL = utils.map_get(opts, "fzf_opts.--read0") and "\0" or "\n"
    local fn_transform = opts.fn_transform
    local fn_preprocess = opts.fn_preprocess
    local fn_postprocess = opts.fn_postprocess
    local co = coroutine.running()
    ---@cast co thread

    -- Run the preprocess function
    if type(fn_preprocess) == "function" then fn_preprocess(opts) end

    -- local on_finish = function(code, sig, from, pid)
    -- print("finish", pipe, pipe_want_close, code, sig, from, pid)
    local on_finish = function(_, _, _, _)
      if not pipe then return end
      pipe_want_close = true
      if write_cb_count == 0 then
        -- only close if all our uv.write calls are completed
        uv.close(pipe)
        pipe = nil
        -- Run the postprocess function
        if type(fn_postprocess) == "function" then fn_postprocess(opts) end
      end
    end

    local on_write = function(data, cb)
      -- pipe can be nil when using a shell command with spawn
      -- and typing quickly, the process will terminate
      if not pipe then return end
      if not data then
        on_finish(nil, nil, 5)
        if cb then cb(nil) end
      else
        write_cb_count = write_cb_count + 1
        if type(data) == "table" then
          -- cb_write_lines was sent instead of cb_lines
          if fn_transform then
            -- safely remove items while iterating
            local i = 1
            while i <= #data do
              ---@diagnostic disable-next-line: call-non-callable
              local v = fn_transform(data[i], opts)
              if not v then
                table.remove(data, i)
              else
                data[i] = v
                i = i + 1
              end
            end
          end
          data = #data > 0 and (table.concat(data, EOL) .. EOL) or ""
        end
        uv.write(pipe, tostring(data), function(err)
          write_cb_count = write_cb_count - 1
          if cb then cb(err) end
          if err then
            -- force close on error
            write_cb_count = 0
            on_finish(nil, nil, 2)
          end
          if write_cb_count == 0 and pipe_want_close then
            on_finish(nil, nil, 3)
          end
          -- if opts.throttle then uv.sleep(1000) end
          if opts.throttle then coroutine.resume(co) end
        end)
        -- TODO: why does this freeze fzf's UI?
        -- shouldn't the yield free the UI to update?
        -- if opts.throttle then uv.sleep(1000) end
        if opts.throttle then coroutine.yield() end
      end
    end

    if type(contents) == "string" then
      -- Use queue in libuv.spawn by default
      opts.use_queue = opts.use_queue == nil and true or opts.use_queue

      -- Throttle pipe writes by default
      -- opts.throttle = opts.throttle == nil and true or opts.throttle

      -- Terminate previously running command
      if opts.PidObject then
        libuv.process_kill(opts.PidObject:get())
        opts.PidObject:set(nil)
      end

      if opts.debug then
        -- coroutinify or we err with "yield across a C-call boundary" with throttle
        coroutine.wrap(function() on_write("[DEBUG] [st] " .. contents .. EOL) end)()
      end

      libuv.async_spawn({
        cwd = opts.cwd,
        cmd = contents,
        env = env,
        cb_finish = on_finish,
        cb_write_lines = on_write,
        cb_pid = function(pid) if opts.PidObject then opts.PidObject:set(pid) end end,
        process1 = opts.process1,
        profiler = opts.profiler,
        use_queue = opts.use_queue,
        EOL = EOL,
        -- Must send value, 'coroutinify' adds callback as last argument
        -- which will conflict with the 'fn_transform' argument
        -- send true to force line processing without transformation
      }, true)
    else
      -- callback with newline
      local on_write_nl = function(data, cb)
        data = data and tostring(data) .. EOL or nil
        return on_write(data, cb)
      end

      local ok, err = xpcall(function()
        if type(contents) == "table" then
          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, 1, n))
        end
      end, debug.traceback)
      if not ok and err then
        on_finish()
        error(err)
      end
    end
  end, fzf_field_index or "", opts.debug)

  return cmd, id
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, 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
---@param fzf_field_index string?
---@return string, integer?
M.stringify_cmd = function(fn, opts, fzf_field_index)
  assert(type(fn) == "function", "fn must be of type function")
  return M.stringify(fn, {
    __stringify_cmd = true,
    PidObject = utils.pid_object("__stringify_cmd_pid", opts),
    debug = opts.debug,
  }, fzf_field_index)
end

---@param fn fzf-lua.shell.data
---@param opts fzf-lua.config.Resolved|{}
---@param fzf_field_index string?
---@return string, integer?
M.stringify_data = function(fn, opts, fzf_field_index)
  assert(type(fn) == "function", "fn must be of type function")
  return M.stringify(function(cb, _, ...)
    local ret = fn(...)
    if type(ret) == "table" then
      if not utils.tbl_isempty(ret) then
        vim.tbl_map(function(x) cb(x) end, ret)
      end
    else
      cb(tostring(ret))
    end
    cb(nil)
  end, { debug = opts.debug }, fzf_field_index)
end

-- Patched version of stringify_data
-- Use both {q} and {+} as field indexes so we can update last query when
-- executing the action, without this we lose the last query on "hide" as
-- the process never terminates and `--print-query` isn't being printed
-- When no entry selected (with {n} {+}), {+} will be forced expand to ''
-- Use {n} to know if we really select an empty string, or there's just no selected
---@param fn fzf-lua.shell.data2
---@param opts table
---@param field_index string
---@return string
M.stringify_data2 = function(fn, opts, field_index)
  local did_override = false
  if not field_index:match("{n} {q}$") then
    field_index = field_index .. " {n} {q}"
    did_override = true
  end
  -- replace the action with shell cmd proxy to the original action
  return (M.stringify_data(function(items, _, _)
    local idx, query = items[#items - 1], items[#items]
    FzfLua.config.resume_set("query", query, opts)
    if did_override then
      table.remove(items)
      table.remove(items)
    end
    -- fix side effect of "{n} {+}": {+} is forced expanded to ""
    -- only when field_index is empty (otherwise it can be complex/unpredictable)
    -- {n} used to determine if "zero-selected && zero-match", then patch: "" -> nil
    if field_index == "{+} {n} {q}" then
      -- When no item is matching (empty list or non-matching query)
      -- both {n} and {+} are expanded to "".
      -- NOTE1: older versions of fzf don't expand {n} to "" (without match)
      -- in such case the (empty) items table will be in `items[2]` (#1833)
      -- NOTE2: on Windows, no match {n} is expanded to '' (#1836)
      local zero_matched = not tonumber(idx)
      local zero_selected = #items == 0 or (#items == 1 and #items[1] == 0)
      items = (zero_matched and zero_selected) and {} or items
    end
    return fn(items, opts)
  end, opts, field_index))
end

---@param opts fzf-lua.SpawnStdioOpts
---@return string
M.wrap_spawn_stdio = function(opts)
  local is_win = utils.__IS_WINDOWS
  local nvim_bin = os.getenv("FZF_LUA_NVIM_BIN") or vim.v.progpath
  local nvim_runtime = (function()
    local rt = os.getenv("FZF_LUA_NVIM_RUNTIME")
    if not rt then return "" end
    return string.format(
      is_win and [[set VIMRUNTIME=%s& ]] or "VIMRUNTIME=%s ",
      is_win and vim.fs.normalize(rt) or libuv.shellescape(rt)
    )
  end)()
  -- TODO: should we check "cmd"?
  for _, k in ipairs({ "contents", "fn_transform", "fn_preprocess", "fn_postprocess" }) do
    local v = opts[k]
    if type(v) == "function" then ---@cast v function
      -- opts[k] = M.check_upvalue(opts[k], "opts." .. k)
      M.check_upvalue(v, "opts." .. k)
    end
  end
  local cmd_str = ("%s%s -u NONE -l %s %s"):format(
    nvim_runtime,
    libuv.shellescape(is_win and vim.fs.normalize(nvim_bin) or nvim_bin),
    libuv.shellescape(vim.fn.fnamemodify(is_win and vim.fs.normalize(__FILE__) or __FILE__, ":h") ..
      "/spawn.lua"),
    libuv.shellescape((libuv.serialize(opts, true))))
  return cmd_str
end

return M