fix(global): different previewer class for tags (#2184)

Author: ibhagwan

lua/fzf-lua/core.lua

@@ -350,23 +350,10 @@ M.fzf = function(contents, opts)
   -- setup the fzf window and preview layout
   local fzf_win = win:new(opts)
   -- instantiate the previewer
-  local previewer, preview_opts = nil, nil
-  if opts.previewer and type(opts.previewer) == "string" then
-    preview_opts = config.globals.previewers[opts.previewer]
-    if not preview_opts then
-      utils.warn(("invalid previewer '%s'"):format(opts.previewer))
-    end
-  elseif opts.previewer and type(opts.previewer) == "table" then
-    preview_opts = opts.previewer
-  end
-  if preview_opts and type(preview_opts.new) == "function" then
-    previewer = preview_opts:new(preview_opts, opts, fzf_win)
-  elseif preview_opts and type(preview_opts._new) == "function" then
-    previewer = preview_opts._new()(preview_opts, opts, fzf_win)
-  elseif preview_opts and type(preview_opts._ctor) == "function" then
-    previewer = preview_opts._ctor()(preview_opts, opts, fzf_win)
-  end
+  local previewer = require("fzf-lua.previewer").new(opts.previewer, opts)
   if previewer then
+    -- Attach the previewer to the windows
+    fzf_win:attach_previewer(previewer)
     -- Set the preview command line
     opts.preview = previewer:cmdline()
     -- fzf 0.40 added 'zero' event for when there's no match
@@ -398,7 +385,6 @@ M.fzf = function(contents, opts)
     opts.fzf_opts["--preview-window"] = "hidden:right:0"
   end
 
-  fzf_win:attach_previewer(previewer)
   local fzf_bufnr = fzf_win:create()
   local selected, exit_code = fzf.raw_fzf(contents, M.build_fzf_cli(opts, fzf_win),
     {

lua/fzf-lua/defaults.lua

@@ -367,10 +367,10 @@ M.defaults.global               = vim.tbl_deep_extend("force", M.defaults.files,
   pickers           = function()
     local clients = utils.lsp_get_clients({ bufnr = FzfLua.core.CTX().bufnr })
     local doc_sym_supported = vim.iter(clients):any(function(client)
-      return client.supports_method("textDocument/documentSymbol")
+      return client:supports_method("textDocument/documentSymbol")
     end)
     local wks_sym_supported = vim.iter(clients):any(function(client)
-      return client.supports_method("workspace/symbol")
+      return client:supports_method("workspace/symbol")
     end)
     return {
       { "files",   desc = "Files" },
@@ -380,6 +380,7 @@ M.defaults.global               = vim.tbl_deep_extend("force", M.defaults.files,
         desc = "Tags (buf)",
         prefix = "@",
         opts = {
+          previewer    = { _ctor = previewers.builtin.tags },
           fn_transform = [[return require("fzf-lua.make_entry").tag]],
         }
       },
@@ -389,6 +390,7 @@ M.defaults.global               = vim.tbl_deep_extend("force", M.defaults.files,
         desc = "Tags (project)",
         prefix = "#",
         opts = {
+          previewer    = { _ctor = previewers.builtin.tags },
           fn_transform = [[return require("fzf-lua.make_entry").tag]],
           rg_opts      = "--no-heading --color=always --smart-case",
           grep_opts    = "--color=auto --perl-regexp",

lua/fzf-lua/previewer/builtin.lua

@@ -145,9 +145,8 @@ Previewer.base = Object:extend()
 
 ---@param o table
 ---@param opts table
----@param fzf_win fzf-lua.Win
 ---@return fzf-lua.previewer.Builtin
-function Previewer.base:new(o, opts, fzf_win)
+function Previewer.base:new(o, opts)
   local function default(var, def)
     if var ~= nil then
       return var
@@ -159,16 +158,11 @@ function Previewer.base:new(o, opts, fzf_win)
   o = o or {}
   self.type = "builtin"
   self.opts = opts;
-  self.win = fzf_win
-  self.delay = self.win.winopts.preview.delay or 100
-  self.title = self.win.winopts.preview.title
-  self.title_pos = self.win.winopts.preview.title_pos
   self.title_fnamemodify = o.title_fnamemodify
   self.render_markdown = type(o.render_markdown) == "table" and o.render_markdown or {}
   self.render_markdown.filetypes =
       type(self.render_markdown.filetypes) == "table" and self.render_markdown.filetypes or {}
   self.snacks_image = type(o.snacks_image) == "table" and o.snacks_image or {}
-  self.winopts = self.win.winopts.preview.winopts
   self.syntax = default(o.syntax, true)
   self.syntax_delay = tonumber(default(o.syntax_delay, 0))
   self.syntax_limit_b = tonumber(default(o.syntax_limit_b, 1024 * 1024))
@@ -178,7 +172,6 @@ function Previewer.base:new(o, opts, fzf_win)
   self.treesitter = type(o.treesitter) == "table" and o.treesitter or {}
   self.toggle_behavior = o.toggle_behavior
   self.winopts_orig = {}
-  self.winblend = self.winblend or self.winopts.winblend or vim.o.winblend
   -- convert extension map to lower case
   if o.extensions then
     self.extensions = {}
@@ -454,6 +447,8 @@ function Previewer.base:cmdline(_)
     -- NOTE: see comment regarding {n} in `core.convert_exec_silent_actions`
     -- convert empty string to nil
     if not tonumber(idx) then entry = nil end
+    -- upvalue incase previewer was detached/re-attached (global picker)
+    self = self.win._previewer or self
     -- on windows, query may not be expanded to a string: #1887
     self.opts._last_query = query or ""
     self:display_entry(entry)
@@ -594,8 +589,8 @@ end
 ---@field super fzf-lua.previewer.Builtin
 Previewer.buffer_or_file = Previewer.base:extend()
 
-function Previewer.buffer_or_file:new(o, opts, fzf_win)
-  Previewer.buffer_or_file.super.new(self, o, opts, fzf_win)
+function Previewer.buffer_or_file:new(o, opts)
+  Previewer.buffer_or_file.super.new(self, o, opts)
   return self
 end
 
@@ -1350,8 +1345,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile
 Previewer.help_tags = Previewer.buffer_or_file:extend()
 
-function Previewer.help_tags:new(o, opts, fzf_win)
-  Previewer.help_tags.super.new(self, o, opts, fzf_win)
+function Previewer.help_tags:new(o, opts)
+  Previewer.help_tags.super.new(self, o, opts)
   return self
 end
 
@@ -1422,8 +1417,8 @@ function Previewer.man_pages:gen_winopts()
   return vim.tbl_extend("keep", winopts, self.winopts)
 end
 
-function Previewer.man_pages:new(o, opts, fzf_win)
-  Previewer.man_pages.super.new(self, o, opts, fzf_win)
+function Previewer.man_pages:new(o, opts)
+  Previewer.man_pages.super.new(self, o, opts)
   self.filetype = "man"
   self.cmd = o.cmd or "man -c %s | col -bx"
   self.cmd = type(self.cmd) == "function" and self.cmd() or self.cmd
@@ -1452,8 +1447,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile,{}
 Previewer.marks = Previewer.buffer_or_file:extend()
 
-function Previewer.marks:new(o, opts, fzf_win)
-  Previewer.marks.super.new(self, o, opts, fzf_win)
+function Previewer.marks:new(o, opts)
+  Previewer.marks.super.new(self, o, opts)
   return self
 end
 
@@ -1495,8 +1490,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile,{}
 Previewer.jumps = Previewer.buffer_or_file:extend()
 
-function Previewer.jumps:new(o, opts, fzf_win)
-  Previewer.jumps.super.new(self, o, opts, fzf_win)
+function Previewer.jumps:new(o, opts)
+  Previewer.jumps.super.new(self, o, opts)
   return self
 end
 
@@ -1527,8 +1522,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile,{}
 Previewer.tags = Previewer.buffer_or_file:extend()
 
-function Previewer.tags:new(o, opts, fzf_win)
-  Previewer.tags.super.new(self, o, opts, fzf_win)
+function Previewer.tags:new(o, opts)
+  Previewer.tags.super.new(self, o, opts)
   return self
 end
 
@@ -1568,8 +1563,8 @@ function Previewer.highlights:gen_winopts()
   return vim.tbl_extend("keep", winopts, self.winopts)
 end
 
-function Previewer.highlights:new(o, opts, fzf_win)
-  Previewer.highlights.super.new(self, o, opts, fzf_win)
+function Previewer.highlights:new(o, opts)
+  Previewer.highlights.super.new(self, o, opts)
   self.ns_previewer = vim.api.nvim_create_namespace("fzf-lua.previewer.hl")
   return self
 end
@@ -1654,8 +1649,8 @@ function Previewer.quickfix:gen_winopts()
   return vim.tbl_extend("keep", winopts, self.winopts)
 end
 
-function Previewer.quickfix:new(o, opts, fzf_win)
-  Previewer.quickfix.super.new(self, o, opts, fzf_win)
+function Previewer.quickfix:new(o, opts)
+  Previewer.quickfix.super.new(self, o, opts)
   return self
 end
 
@@ -1695,8 +1690,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile,{}
 Previewer.autocmds = Previewer.buffer_or_file:extend()
 
-function Previewer.autocmds:new(o, opts, fzf_win)
-  Previewer.autocmds.super.new(self, o, opts, fzf_win)
+function Previewer.autocmds:new(o, opts)
+  Previewer.autocmds.super.new(self, o, opts)
   return self
 end
 
@@ -1737,8 +1732,8 @@ end
 ---@field super fzf-lua.previewer.BufferOrFile,{}
 Previewer.keymaps = Previewer.buffer_or_file:extend()
 
-function Previewer.autocmds:keymaps(o, opts, fzf_win)
-  Previewer.autocmds.super.new(self, o, opts, fzf_win)
+function Previewer.autocmds:keymaps(o, opts)
+  Previewer.autocmds.super.new(self, o, opts)
   return self
 end
 
@@ -1773,8 +1768,8 @@ end
 ---@field super fzf-lua.previewer.Builtin,{}
 Previewer.nvim_options = Previewer.base:extend()
 
-function Previewer.nvim_options:new(o, opts, fzf_win)
-  Previewer.nvim_options.super.new(self, o, opts, fzf_win)
+function Previewer.nvim_options:new(o, opts)
+  Previewer.nvim_options.super.new(self, o, opts)
   local paths = vim.fn.globpath(vim.o.rtp, "doc/options.txt", false, true)
   self.lines = vim.fn.readfile(paths[1])
   return self

lua/fzf-lua/previewer/init.lua

@@ -27,4 +27,31 @@ Previewer.builtin.keymaps = function() return require "fzf-lua.previewer.builtin
 Previewer.builtin.nvim_options = function() return require "fzf-lua.previewer.builtin".nvim_options end
 Previewer.builtin.codeaction = function() return require "fzf-lua.previewer.codeaction".builtin end
 
+
+---Instantiate previewer from spec
+---@param spec table
+---@param opts table
+---@return fzf-lua.previewer?
+Previewer.new = function(spec, opts)
+  if not spec then return end
+  local previewer, preview_opts = nil, nil
+  if type(spec) == "string" then
+    preview_opts = FzfLua.config.globals.previewers[spec]
+    if not preview_opts then
+      FzfLua.utils.warn(("invalid previewer '%s'"):format(spec))
+    end
+  elseif type(spec) == "table" then
+    preview_opts = spec
+  end
+  -- Backward compat: can instantiate with `_ctor|new|_new`
+  if preview_opts and type(preview_opts.new) == "function" then
+    previewer = preview_opts:new(preview_opts, opts)
+  elseif preview_opts and type(preview_opts._new) == "function" then
+    previewer = preview_opts._new()(preview_opts, opts)
+  elseif preview_opts and type(preview_opts._ctor) == "function" then
+    previewer = preview_opts._ctor()(preview_opts, opts)
+  end
+  return previewer
+end
+
 return Previewer

lua/fzf-lua/providers/meta.lua

@@ -168,21 +168,38 @@ M.global = function(opts)
   for _, t in ipairs(opts.pickers) do
     local name = t[1]
     if FzfLua[name] then
+      local def
+      local function gen_def(n, o)
+        local wrapped = { FzfLua[n](o) }
+        return {
+          name = n,
+          opts = wrapped[3],
+          contents = wrapped[2],
+        }
+      end
       if not t.prefix 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[name] = { FzfLua[name](opts) }
+        def = gen_def(name, opts)
+        pickers[name] = def
         -- 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[name][3]
+        opts = def.opts
         opts._start = nil -- remove the start suppression
-        pickers[name][3] = vim.deepcopy(opts)
+        def.opts = vim.deepcopy(opts)
       else
         -- Each subsequent picker gets a fresh copy of the original opts
         -- (unmodified by the default picker)
-        pickers[name] = { FzfLua[name](t.opts and
-          vim.tbl_deep_extend("force", {}, opts_copy, t.opts) or opts_copy) }
+        def = gen_def(name, t.opts
+          and vim.tbl_deep_extend("force", {}, opts_copy, t.opts)
+          or opts_copy)
+        pickers[name] = def
+      end
+      -- Instantiate the previewer, opts isn't guaranteed if the picker
+      -- isn't avilable, e.g. `tags` when not tags file exists
+      if def.opts and def.opts.previewer then
+        def.previewer = require("fzf-lua.previewer").new(def.opts.previewer, def.opts)
       end
     else
       utils.warn(string.format("invalid picker '%s', ignoring.", name))
@@ -222,13 +239,24 @@ M.global = function(opts)
       if start or 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
+        cur_picker = cur_picker or new_picker
         -- TODO: is there a better way to override the callback opts ref?
-        opts.__alt_opts = new_picker[3]
-        reload = string.format("reload(%s)+", new_picker[2])
+        opts.__alt_opts = new_picker.opts
+        -- Attach a new previewer if exists
+        local win = FzfLua.utils.fzf_winobj()
+        if win
+            and new_picker.previewer
+            and new_picker.previewer ~= cur_picker.previewer
+        then
+          win:close_preview()
+          win:attach_previewer(new_picker.previewer)
+          win:redraw_preview()
+        end
+        reload = string.format("reload(%s)+", new_picker.contents)
+        cur_sub = new_sub
+        cur_picker = new_picker
       end
       return reload .. string.format("search(%s)", q:sub(cur_sub))
     end, opts, "{q}")

lua/fzf-lua/types.lua

@@ -6,6 +6,14 @@ _G.FzfLua = require("fzf-lua")
 ---@class fzf-lua.Config
 ---@field [string] any
 
+---@class fzf-lua.previewer
+---@field new function
+---@field zero function?
+---@field cmdline function?
+---@field fzf_delimiter function?
+---@field preview_window function?
+---@field _preview_offset function?
+
 ---@class fzf-lua.previewer.Builtin
 ---@field type "builtin"
 ---@field opts table

lua/fzf-lua/win.lua

@@ -726,6 +726,12 @@ end
 
 ---@param previewer fzf-lua.previewer.Builtin
 function FzfWin:attach_previewer(previewer)
+  previewer.win = self
+  previewer.delay = self.winopts.preview.delay or 100
+  previewer.title = self.winopts.preview.title
+  previewer.title_pos = self.winopts.preview.title_pos
+  previewer.winopts = self.winopts.preview.winopts
+  previewer.winblend = previewer.winblend or previewer.winopts.winblend or vim.o.winblend
   -- clear the previous previewer if existed
   if self._previewer and self._previewer.close then
     -- if we press ctrl-g too quickly 'previewer.preview_bufnr' will be nil