feat: new "global" picker (closes #2058)

Author: ibhagwan

lua/fzf-lua/config.lua

@@ -382,7 +382,7 @@ function M.normalize_opts(opts, globals, __resume_key)
   end
 
   -- `fzf_cli_args` is string, `_fzf_cli_args` is a table used internally
-  opts._fzf_cli_args = {}
+  opts._fzf_cli_args = type(opts._fzf_cli_args) == "table" and opts._fzf_cli_args or {}
 
   -- backward compatibility, rhs overrides lhs
   -- (rhs being the "old" option)

lua/fzf-lua/defaults.lua

@@ -360,6 +360,21 @@ M.defaults.files                = {
   winopts                = { preview = { winopts = { cursorline = false } } },
 }
 
+M.defaults.global               = vim.tbl_deep_extend("force", M.defaults.files, {
+  cwd_prompt        = true,
+  line_query        = true,
+  pickers           = {
+    [""]  = "files",
+    ["$"] = "buffers",
+    ["@"] = "lsp_document_symbols",
+    ["#"] = "lsp_workspace_symbols",
+  },
+  fzf_opts          = { ["--nth"] = false, ["--with-nth"] = false },
+  winopts           = { preview = { winopts = { cursorline = true } } },
+  _ctx              = { includeBuflist = true }, -- we include a buffer picker
+  _fzf_nth_devicons = false,
+})
+
 -- Must construct our opts table in stages
 -- so we can reference 'M.globals.files'
 M.defaults.git                  = {

lua/fzf-lua/init.lua

@@ -289,6 +289,7 @@ do
     tmux_buffers = { "fzf-lua.providers.tmux", "buffers" },
     profiles = { "fzf-lua.providers.meta", "profiles" },
     combine = { "fzf-lua.providers.meta", "combine" },
+    global = { "fzf-lua.providers.meta", "global" },
     complete_path = { "fzf-lua.complete", "path" },
     complete_file = { "fzf-lua.complete", "file" },
     complete_line = { "fzf-lua.complete", "line" },

lua/fzf-lua/profiles/default-prompt.lua

@@ -6,6 +6,7 @@ return {
   winopts              = { title_pos = "center", preview = { title_pos = "center" } },
   -- Uses `cwd_prompt` by default
   -- files                = prompt("Files"),
+  global               = prompt("Global"),
   buffers              = prompt("Buffers"),
   tabs                 = prompt("Tabs"),
   lines                = prompt("Lines"),

lua/fzf-lua/profiles/default-title.lua

@@ -9,6 +9,7 @@ end
 return {
   desc                 = "defaults using title for picker info",
   winopts              = { title_pos = "center", preview = { title_pos = "center" } },
+  global               = title("Global"),
   files                = title("Files"),
   buffers              = title("Buffers"),
   tabs                 = title("Tabs"),

lua/fzf-lua/providers/meta.lua

@@ -2,6 +2,7 @@ local uv = vim.uv or vim.loop
 local core = require "fzf-lua.core"
 local path = require "fzf-lua.path"
 local utils = require "fzf-lua.utils"
+local libuv = require "fzf-lua.libuv"
 local config = require "fzf-lua.config"
 
 local M = {}
@@ -121,7 +122,7 @@ M.combine = function(t)
 
   local cmds, opts = (function()
     local ret, opts = {}, nil
-    for i, p in ipairs(t.pickers) do
+    for _, p in ipairs(t.pickers) do
       -- local ok, msg, cmd, o = pcall(FzfLua[p], opts1)
       -- if not ok or not cmd then
       local _, cmd, o = FzfLua[p](opts1)
@@ -148,4 +149,100 @@ M.combine = function(t)
   return core.fzf_wrap(contents, opts)
 end
 
+M.global = function(opts)
+  opts = config.normalize_opts(opts, "global")
+  if not opts then return end
+
+  if opts.line_query and not utils.has(opts, "fzf", { 0, 59 }) then
+    utils.warn("'global' requires fzf >= 0.59, reverting to files.")
+    return FzfLua.files(opts)
+  end
+
+  -- Tells fzf_wrap to not start the fzf process
+  opts._start = false
+  local pickers = {}
+  local opts_copy = vim.deepcopy(opts)
+  for c, p in pairs(opts.pickers) do
+    if FzfLua[p] then
+      if #c == 0 then
+        -- Default picker opts set the tone for this picker options
+        -- this way convert reload / exec_silent actions will use a consistent
+        -- opts ref in the callbacks so we can later modify internal values
+        pickers[p] = { FzfLua[p](opts) }
+        -- Override opts with the return opts and store a copy of `pickers[]`
+        -- as we patch the opts when switching a picker in the change event
+        opts = pickers[p][3]
+        opts._start = nil -- remove the start suppression
+        pickers[p][3] = vim.deepcopy(opts)
+      else
+        -- Each subsequent picker gets a fresh copy of the original opts
+        -- (unmodified by the default picker)
+        pickers[p] = { FzfLua[p](opts_copy) }
+      end
+    else
+      utils.warn(string.format("invalid picker '%s', ignoring.", p))
+    end
+  end
+
+  ---@param q string
+  ---@return table?, integer?
+  local get_picker = function(q)
+    q = type(q) == "string" and q or ""
+    if #q == 0 then
+      return pickers[opts.pickers[""]], 1
+    end
+    for c, p in pairs(opts.pickers) do
+      if #c > 0 and q:match("^" .. utils.lua_regex_escape(c)) then
+        return pickers[p], #c + 1
+      end
+    end
+  end
+
+  -- Copy all keys without destroying the parent opts ref
+  -- or we will mess up the actions (especially hide)
+  local patch_opts = function(t1, t2)
+    for k, _ in pairs(t1) do
+      if k ~= "actions" then t1[k] = nil end
+    end
+    for k, v in pairs(t2) do
+      (function()
+        if k == "actions" then return end
+        if type(v) == "table" then
+          t1[k] = vim.tbl_deep_extend("force", t1[k] or {}, v)
+        else
+          t1[k] = v
+        end
+      end)()
+    end
+    return t1
+  end
+
+  -- Get starting picker
+  local cur_picker, cur_sub = get_picker()
+  if not cur_picker then
+    utils.warn("default picker not found, aborting.")
+    return
+  end
+
+  table.insert(opts._fzf_cli_args, "--bind=" .. libuv.shellescape("change:+transform:"
+    .. FzfLua.shell.stringify_data(function(args, _, _)
+      local q = args[1]
+      local new_picker, new_sub = get_picker(q)
+      local reload = ""
+      if new_picker and new_picker ~= cur_picker then
+        -- New picker requested, reload the contents and transform
+        -- the search string to exclude the picker prefix
+        cur_sub = new_sub
+        cur_picker = new_picker
+        -- Patch the opts refs with important values for path parsing
+        -- e.g. formatter, path_shorten, etc
+        opts = patch_opts(opts, cur_picker[3])
+        reload = string.format("reload(%s)+", new_picker[2])
+      end
+      return reload .. string.format("search(%s)", q:sub(cur_sub))
+    end, opts, "{q}")))
+
+  return core.fzf_wrap(cur_picker[2], opts)
+end
+
 return M

lua/fzf-lua/shell.lua

@@ -83,10 +83,12 @@ function LRU:get(id)
 end
 
 -- Cache should be able to hold all function callbacks of a single picker
--- max cache size of 50 should be more than enough, we don't want it to be
+-- 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
-local function new_cache(size) return LRU:new(size or 50) end
+-- 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 = {}