From 4482c2b551a36b4a1d27a59e0d4d53a3fdb7ccbd Mon Sep 17 00:00:00 2001
From: Simon Hauser <Simon-Hauser@outlook.de>
Date: Sun, 22 May 2022 10:33:01 +0200
Subject: chore: cleanup vim options (#1946)

---
 lua/telescope/make_entry.lua | 93 ++++++++------------------------------------
 1 file changed, 17 insertions(+), 76 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index 703a00a..3280f2a 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -811,67 +811,6 @@ function make_entry.gen_from_buffer_lines(opts)
 end
 
 function make_entry.gen_from_vimoptions()
-  local process_one_opt = function(o)
-    local ok, value_origin
-
-    local option = {
-      name = "",
-      description = "",
-      current_value = "",
-      default_value = "",
-      value_type = "",
-      set_by_user = false,
-      last_set_from = "",
-    }
-
-    local is_global = false
-    for _, v in ipairs(o.scope) do
-      if v == "global" then
-        is_global = true
-      end
-    end
-
-    if not is_global then
-      return
-    end
-
-    if is_global then
-      option.name = o.full_name
-
-      ok, option.current_value = pcall(vim.api.nvim_get_option, o.full_name)
-      if not ok then
-        return
-      end
-
-      local str_funcname = o.short_desc()
-      option.description = assert(loadstring(str_funcname))()
-      -- if #option.description > opts.desc_col_length then
-      --   opts.desc_col_length = #option.description
-      -- end
-
-      if o.defaults ~= nil then
-        option.default_value = o.defaults.if_true.vim or o.defaults.if_true.vi
-      end
-
-      if type(option.default_value) == "function" then
-        option.default_value = "Macro: " .. option.default_value()
-      end
-
-      option.value_type = (type(option.current_value) == "boolean" and "bool" or type(option.current_value))
-
-      if option.current_value ~= option.default_value then
-        option.set_by_user = true
-        value_origin = vim.fn.execute("verbose set " .. o.full_name .. "?")
-        if string.match(value_origin, "Last set from") then
-          -- TODO: parse file and line number as separate items
-          option.last_set_from = value_origin:gsub("^.*Last set from ", "")
-        end
-      end
-
-      return option
-    end
-  end
-
   local displayer = entry_display.create {
     separator = "",
     hl_chars = { ["["] = "TelescopeBorder", ["]"] = "TelescopeBorder" },
@@ -884,25 +823,27 @@ function make_entry.gen_from_vimoptions()
 
   local make_display = function(entry)
     return displayer {
-      { entry.name, "Keyword" },
-      { "[" .. entry.value_type .. "]", "Type" },
-      utils.display_termcodes(tostring(entry.current_value)),
-      entry.description,
+      { entry.value.name, "Keyword" },
+      { "[" .. entry.value.type .. "]", "Type" },
+      utils.display_termcodes(tostring(entry.value.value)),
     }
   end
 
-  return function(line)
-    local entry = process_one_opt(line)
-    if not entry then
-      return
-    end
+  return function(o)
+    local entry = {
+      display = make_display,
+      value = {
+        name = o.name,
+        value = o.default,
+        type = o.type,
+      },
+      ordinal = o.name,
+    }
 
-    entry.valid = true
-    entry.display = make_display
-    entry.value = line
-    entry.ordinal = line.full_name
-    -- entry.raw_value = d.raw_value
-    -- entry.last_set_from = d.last_set_from
+    local ok, value = pcall(vim.api.nvim_get_option, o.name)
+    if ok then
+      entry.value.value = value
+    end
 
     return entry
   end
-- 
cgit v1.2.3


From 5510587ff488e9d6dfae66ba7e19bce090633329 Mon Sep 17 00:00:00 2001
From: Simon Hauser <Simon-Hauser@outlook.de>
Date: Sun, 22 May 2022 11:50:00 +0200
Subject: feat(vim_options): show scope information in display (#1956)

Also make type, scope and value searchable
---
 lua/telescope/make_entry.lua | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index 3280f2a..c71849d 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -817,6 +817,7 @@ function make_entry.gen_from_vimoptions()
     items = {
       { width = 25 },
       { width = 12 },
+      { width = 11 },
       { remaining = true },
     },
   }
@@ -825,6 +826,7 @@ function make_entry.gen_from_vimoptions()
     return displayer {
       { entry.value.name, "Keyword" },
       { "[" .. entry.value.type .. "]", "Type" },
+      { "[" .. entry.value.scope .. "]", "Identifier" },
       utils.display_termcodes(tostring(entry.value.value)),
     }
   end
@@ -836,13 +838,17 @@ function make_entry.gen_from_vimoptions()
         name = o.name,
         value = o.default,
         type = o.type,
+        scope = o.scope,
       },
-      ordinal = o.name,
+      ordinal = string.format("%s %s %s", o.name, o.type, o.scope),
     }
 
     local ok, value = pcall(vim.api.nvim_get_option, o.name)
     if ok then
       entry.value.value = value
+      entry.ordinal = entry.ordinal .. " " .. utils.display_termcodes(tostring(value))
+    else
+      entry.ordinal = entry.ordinal .. " " .. utils.display_termcodes(tostring(o.default))
     end
 
     return entry
-- 
cgit v1.2.3


From 83b6cadb2c61b6eee6a8f0ec8bb4599c89b6ab57 Mon Sep 17 00:00:00 2001
From: Simon Hauser <Simon-Hauser@outlook.de>
Date: Sun, 22 May 2022 12:53:37 +0200
Subject: break: deprecate utils.get_default utils.if_nil (#1545)

---
 lua/telescope/make_entry.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index c71849d..f4f0010 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -754,7 +754,7 @@ function make_entry.gen_from_picker(opts)
     return {
       value = entry,
       text = entry.prompt_title,
-      ordinal = string.format("%s %s", entry.prompt_title, utils.get_default(entry.default_text, "")),
+      ordinal = string.format("%s %s", entry.prompt_title, vim.F.if_nil(entry.default_text, "")),
       display = make_display,
     }
   end
@@ -978,7 +978,7 @@ function make_entry.gen_from_diagnostics(opts)
   end)()
 
   local display_items = {
-    { width = utils.if_nil(signs, 8, 10) },
+    { width = signs ~= nil and 10 or 8 },
     { remaining = true },
   }
   local line_width = vim.F.if_nil(opts.line_width, 0.5)
-- 
cgit v1.2.3


From 838c32d6a86c8a4b8f3333f66e797f7cad2e3c1b Mon Sep 17 00:00:00 2001
From: Yorick Peterse <git@yorickpeterse.com>
Date: Sun, 12 Jun 2022 20:29:10 +0800
Subject: refactor: make_entry more consistent (#1410)

drops `ignore_filename`, use `path_display= { "hidden" }`

Co-authored-by: Simon Hauser <Simon-Hauser@outlook.de>
---
 lua/telescope/make_entry.lua | 151 ++++++++++++++++++++++++-------------------
 1 file changed, 83 insertions(+), 68 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index f4f0010..940973b 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -26,6 +26,21 @@ local lsp_type_highlight = {
   ["Variable"] = "TelescopeResultsVariable",
 }
 
+local get_filename_fn = function()
+  local bufnr_name_cache = {}
+  return function(bufnr)
+    bufnr = vim.F.if_nil(bufnr, 0)
+    local c = bufnr_name_cache[bufnr]
+    if c then
+      return c
+    end
+
+    local n = vim.api.nvim_buf_get_name(bufnr)
+    bufnr_name_cache[bufnr] = n
+    return n
+  end
+end
+
 local make_entry = {}
 
 do
@@ -309,40 +324,49 @@ end
 
 function make_entry.gen_from_quickfix(opts)
   opts = opts or {}
+  local show_line = vim.F.if_nil(opts.show_line, true)
 
-  local displayer = entry_display.create {
-    separator = "▏",
-    items = {
-      { width = 8 },
-      { width = 0.45 },
-      { remaining = true },
-    },
+  local hidden = utils.is_path_hidden(opts)
+  local items = {
+    { width = vim.F.if_nil(opts.fname_width, 30) },
+    { remaining = true },
   }
+  if hidden then
+    items[1] = 8
+  end
+  if not show_line then
+    table.remove(items, 1)
+  end
 
-  local make_display = function(entry)
-    local filename = utils.transform_path(opts, entry.filename)
+  local displayer = entry_display.create { separator = "▏", items = items }
 
-    local line_info = { table.concat({ entry.lnum, entry.col }, ":"), "TelescopeResultsLineNr" }
+  local make_display = function(entry)
+    local input = {}
+    if not hidden then
+      table.insert(input, string.format("%s:%d:%d", utils.transform_path(opts, entry.filename), entry.lnum, entry.col))
+    else
+      table.insert(input, string.format("%4d:%2d", entry.lnum, entry.col))
+    end
 
-    if opts.trim_text then
-      entry.text = entry.text:gsub("^%s*(.-)%s*$", "%1")
+    if show_line then
+      local text = entry.text
+      if opts.trim_text then
+        text = text:gsub("^%s*(.-)%s*$", "%1")
+      end
+      text = text:gsub(".* | ", "")
+      table.insert(input, text)
     end
 
-    return displayer {
-      line_info,
-      entry.text:gsub(".* | ", ""),
-      filename,
-    }
+    return displayer(input)
   end
 
+  local get_filename = get_filename_fn()
   return function(entry)
-    local filename = entry.filename or vim.api.nvim_buf_get_name(entry.bufnr)
+    local filename = vim.F.if_nil(entry.filename, get_filename(entry.bufnr))
 
     return {
-      valid = true,
-
       value = entry,
-      ordinal = (not opts.ignore_filename and filename or "") .. " " .. entry.text,
+      ordinal = (not hidden and filename or "") .. " " .. entry.text,
       display = make_display,
 
       bufnr = entry.bufnr,
@@ -361,14 +385,22 @@ function make_entry.gen_from_lsp_symbols(opts)
 
   local bufnr = opts.bufnr or vim.api.nvim_get_current_buf()
 
+  -- Default we have two columns, symbol and type(unbound)
+  -- If path is not hidden then its, filepath, symbol and type(still unbound)
+  -- If show_line is also set, type is bound to len 8
   local display_items = {
-    { width = opts.symbol_width or 25 }, -- symbol
-    { width = opts.symbol_type_width or 8 }, -- symbol type
-    { remaining = true }, -- filename{:optional_lnum+col} OR content preview
+    { width = opts.symbol_width or 25 },
+    { remaining = true },
   }
 
-  if opts.ignore_filename and opts.show_line then
-    table.insert(display_items, 2, { width = 6 })
+  local hidden = utils.is_path_hidden(opts)
+  if not hidden then
+    table.insert(display_items, 1, { width = vim.F.if_nil(opts.fname_width, 30) })
+  end
+
+  if opts.show_line then
+    -- bound type to len 8 or custom
+    table.insert(display_items, #display_items, { width = opts.symbol_type_width or 8 })
   end
 
   local displayer = entry_display.create {
@@ -376,51 +408,43 @@ function make_entry.gen_from_lsp_symbols(opts)
     hl_chars = { ["["] = "TelescopeBorder", ["]"] = "TelescopeBorder" },
     items = display_items,
   }
+  local type_highlight = vim.F.if_nil(opts.symbol_highlights or lsp_type_highlight)
 
   local make_display = function(entry)
     local msg
 
-    -- what to show in the last column: filename or symbol information
-    if opts.ignore_filename then -- ignore the filename and show line preview instead
-      -- TODO: fixme - if ignore_filename is set for workspace, bufnr will be incorrect
-      msg = vim.api.nvim_buf_get_lines(bufnr, entry.lnum - 1, entry.lnum, false)[1] or ""
-      msg = vim.trim(msg)
-    else
-      local filename = utils.transform_path(opts, entry.filename)
-
-      if opts.show_line then -- show inline line info
-        filename = filename .. " [" .. entry.lnum .. ":" .. entry.col .. "]"
-      end
-      msg = filename
+    if opts.show_line then
+      msg = vim.trim(vim.F.if_nil(vim.api.nvim_buf_get_lines(bufnr, entry.lnum - 1, entry.lnum, false)[1], ""))
     end
 
-    local type_highlight = opts.symbol_highlights or lsp_type_highlight
-    local display_columns = {
-      entry.symbol_name,
-      { entry.symbol_type:lower(), type_highlight[entry.symbol_type], type_highlight[entry.symbol_type] },
-      msg,
-    }
-
-    if opts.ignore_filename and opts.show_line then
-      table.insert(display_columns, 2, { entry.lnum .. ":" .. entry.col, "TelescopeResultsLineNr" })
+    if hidden then
+      return displayer {
+        entry.symbol_name,
+        { entry.symbol_type:lower(), type_highlight[entry.symbol_type] },
+        msg,
+      }
+    else
+      return displayer {
+        utils.transform_path(opts, entry.filename),
+        entry.symbol_name,
+        { entry.symbol_type:lower(), type_highlight[entry.symbol_type] },
+        msg,
+      }
     end
-
-    return displayer(display_columns)
   end
 
+  local get_filename = get_filename_fn()
   return function(entry)
-    local filename = entry.filename or vim.api.nvim_buf_get_name(entry.bufnr)
+    local filename = vim.F.if_nil(entry.filename, get_filename(entry.bufnr))
     local symbol_msg = entry.text
     local symbol_type, symbol_name = symbol_msg:match "%[(.+)%]%s+(.*)"
-
     local ordinal = ""
-    if not opts.ignore_filename and filename then
+    if not hidden and filename then
       ordinal = filename .. " "
     end
     ordinal = ordinal .. symbol_name .. " " .. (symbol_type or "unknown")
-    return {
-      valid = true,
 
+    return {
       value = entry,
       ordinal = ordinal,
       display = make_display,
@@ -484,8 +508,6 @@ function make_entry.gen_from_buffer(opts)
     local line_count = vim.api.nvim_buf_line_count(entry.bufnr)
 
     return {
-      valid = true,
-
       value = bufname,
       ordinal = entry.bufnr .. " : " .. bufname,
       display = make_display,
@@ -537,13 +559,12 @@ function make_entry.gen_from_treesitter(opts)
     return displayer(display_columns)
   end
 
+  local get_filename = get_filename_fn()
   return function(entry)
     local ts_utils = require "nvim-treesitter.ts_utils"
     local start_row, start_col, end_row, _ = ts_utils.get_node_range(entry.node)
     local node_text = vim.treesitter.get_node_text(entry.node, bufnr)
     return {
-      valid = true,
-
       value = entry.node,
       kind = entry.kind,
       ordinal = node_text .. " " .. (entry.kind or "unknown"),
@@ -551,7 +572,7 @@ function make_entry.gen_from_treesitter(opts)
 
       node_text = node_text,
 
-      filename = vim.api.nvim_buf_get_name(bufnr),
+      filename = get_filename(bufnr),
       -- need to add one since the previewer substacts one
       lnum = start_row + 1,
       col = start_col,
@@ -668,7 +689,6 @@ function make_entry.gen_from_registers(_)
 
   return function(entry)
     return {
-      valid = true,
       value = entry,
       ordinal = entry,
       content = vim.fn.getreg(entry),
@@ -800,7 +820,6 @@ function make_entry.gen_from_buffer_lines(opts)
     end
 
     return {
-      valid = true,
       ordinal = entry.text,
       display = make_display,
       filename = entry.filename,
@@ -982,7 +1001,8 @@ function make_entry.gen_from_diagnostics(opts)
     { remaining = true },
   }
   local line_width = vim.F.if_nil(opts.line_width, 0.5)
-  if not utils.is_path_hidden(opts) then
+  local hidden = utils.is_path_hidden(opts)
+  if not hidden then
     table.insert(display_items, 2, { width = line_width })
   end
   local displayer = entry_display.create {
@@ -1000,10 +1020,6 @@ function make_entry.gen_from_diagnostics(opts)
       "Diagnostic" .. entry.type,
     }
 
-    --TODO(conni2461): I dont like that this is symbol lnum:col | msg | filename
-    --                 i want: symbol filename:lnum:col | msg
-    --                 or    : symbol lnum:col | msg
-    --                 I think this is more natural
     return displayer {
       line_info,
       entry.text,
@@ -1014,7 +1030,7 @@ function make_entry.gen_from_diagnostics(opts)
   return function(entry)
     return {
       value = entry,
-      ordinal = ("%s %s"):format(not opts.ignore_filename and entry.filename or "", entry.text),
+      ordinal = ("%s %s"):format(not hidden and entry.filename or "", entry.text),
       display = make_display,
       filename = entry.filename,
       type = entry.type,
@@ -1104,7 +1120,6 @@ function make_entry.gen_from_commands(_)
       definition = entry.definition,
       --
       value = entry,
-      valid = true,
       ordinal = entry.name,
       display = make_display,
     }
-- 
cgit v1.2.3


From 77e2b8ceea048b42773fc454658c17448caa2a93 Mon Sep 17 00:00:00 2001
From: Simon Hauser <Simon-Hauser@outlook.de>
Date: Sun, 12 Jun 2022 15:09:41 +0200
Subject: chore: cleanup autocmd builtin (#1947)

---
 lua/telescope/make_entry.lua | 26 ++++++++++++--------------
 1 file changed, 12 insertions(+), 14 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index 940973b..e206fd5 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -1054,26 +1054,24 @@ function make_entry.gen_from_autocommands(_)
 
   local make_display = function(entry)
     return displayer {
-      { entry.event, "vimAutoEvent" },
-      { entry.group, "vimAugroup" },
-      { entry.ft_pattern, "vimAutoCmdSfxList" },
-      entry.command,
+      { entry.value.event, "vimAutoEvent" },
+      { entry.value.group_name, "vimAugroup" },
+      { entry.value.pattern, "vimAutoCmdSfxList" },
+      entry.value.command,
     }
   end
 
-  -- TODO: <action> dump current filtered items to buffer
   return function(entry)
+    local group_name = vim.F.if_nil(entry.group_name, "<anonymous>")
     return {
-      event = entry.event,
-      group = entry.group,
-      ft_pattern = entry.ft_pattern,
-      command = entry.command,
-      value = string.format("+%d %s", entry.source_lnum, entry.source_file),
-      source_file = entry.source_file,
-      source_lnum = entry.source_lnum,
+      value = {
+        event = entry.event,
+        group_name = group_name,
+        pattern = entry.pattern,
+        command = entry.command,
+      },
       --
-      valid = true,
-      ordinal = entry.event .. " " .. entry.group .. " " .. entry.ft_pattern .. " " .. entry.command,
+      ordinal = entry.event .. " " .. group_name .. " " .. entry.pattern .. " " .. entry.command,
       display = make_display,
     }
   end
-- 
cgit v1.2.3


From db4635bddf4a4f48c9edce80ce5157275e6bba34 Mon Sep 17 00:00:00 2001
From: Dane Summers <dsummersl@yahoo.com>
Date: Mon, 13 Jun 2022 12:42:00 -0400
Subject: fix(current_buffer_tags): tag-relative=never (#1970)

---
 lua/telescope/make_entry.lua | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index e206fd5..efeb750 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -935,6 +935,7 @@ function make_entry.gen_from_ctags(opts)
     end
   end
 
+  local current_file_cache = {}
   return function(line)
     if line == "" or line:sub(1, 1) == "!" then
       return nil
@@ -952,8 +953,14 @@ function make_entry.gen_from_ctags(opts)
       file = string.gsub(file, "/", "\\")
     end
 
-    if opts.only_current_file and file ~= current_file then
-      return nil
+    if opts.only_current_file then
+      if current_file_cache[file] == nil then
+        current_file_cache[file] = Path:new(file):normalize(cwd) == current_file
+      end
+
+      if current_file_cache[file] == false then
+        return nil
+      end
     end
 
     local tag_entry = {}
-- 
cgit v1.2.3


From 1ba967f84e8416de9a3423bd693ec77744df8bff Mon Sep 17 00:00:00 2001
From: Simon Hauser <simon.hauser@helsinki-systems.de>
Date: Thu, 30 Jun 2022 14:29:46 +0200
Subject: fix: truncate for builtin.buffers

fix #2022
---
 lua/telescope/make_entry.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index efeb750..8e9f84a 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -484,8 +484,9 @@ function make_entry.gen_from_buffer(opts)
   local cwd = vim.fn.expand(opts.cwd or vim.loop.cwd())
 
   local make_display = function(entry)
+    -- bufnr_width + modes + icon + 3 spaces + : + lnum
+    opts.__prefix = opts.bufnr_width + 4 + icon_width + 3 + 1 + #tostring(entry.lnum)
     local display_bufname = utils.transform_path(opts, entry.filename)
-
     local icon, hl_group = utils.get_devicons(entry.filename, disable_devicons)
 
     return displayer {
-- 
cgit v1.2.3


From 8f56fede21f6bb2a2e5e600d78d75509dff821ca Mon Sep 17 00:00:00 2001
From: TJ DeVries <devries.timothyj@gmail.com>
Date: Fri, 19 Nov 2021 12:30:58 -0500
Subject: feat: Add entry_index for entry_makers

cleanup
---
 lua/telescope/make_entry.lua | 155 ++++++++++++++++++++++++++++---------------
 1 file changed, 102 insertions(+), 53 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index 8e9f84a..e8f2509 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -41,8 +41,40 @@ local get_filename_fn = function()
   end
 end
 
+local handle_entry_index = function(opts, t, k)
+  local override = ((opts or {}).entry_index or {})[k]
+  if not override then
+    return
+  end
+
+  local val, save = override(t, opts)
+  if save then
+    rawset(t, k, val)
+  end
+  return val
+end
+
 local make_entry = {}
 
+make_entry.set_default_entry_mt = function(tbl, opts)
+  return setmetatable({}, {
+    __index = function(t, k)
+      local override = handle_entry_index(opts, t, k)
+      if override then
+        return override
+      end
+
+      -- Only hit tbl once
+      local val = tbl[k]
+      if val then
+        rawset(t, k, val)
+      end
+
+      return val
+    end,
+  })
+end
+
 do
   local lookup_keys = {
     display = 1,
@@ -50,13 +82,18 @@ do
     value = 1,
   }
 
-  local mt_string_entry = {
-    __index = function(t, k)
-      return rawget(t, rawget(lookup_keys, k))
-    end,
-  }
+  function make_entry.gen_from_string(opts)
+    local mt_string_entry = {
+      __index = function(t, k)
+        local override = handle_entry_index(opts, t, k)
+        if override then
+          return override
+        end
+
+        return rawget(t, rawget(lookup_keys, k))
+      end,
+    }
 
-  function make_entry.gen_from_string()
     return function(line)
       return setmetatable({
         line,
@@ -97,6 +134,11 @@ do
     end
 
     mt_file_entry.__index = function(t, k)
+      local override = handle_entry_index(opts, t, k)
+      if override then
+        return override
+      end
+
       local raw = rawget(mt_file_entry, k)
       if raw then
         return raw
@@ -220,6 +262,11 @@ do
       end,
 
       __index = function(t, k)
+        local override = handle_entry_index(opts, t, k)
+        if override then
+          return override
+        end
+
         local raw = rawget(mt_vimgrep_entry, k)
         if raw then
           return raw
@@ -272,13 +319,13 @@ function make_entry.gen_from_git_stash(opts)
     local _, branch_name = string.match(splitted[2], "^([WIP on|On]+) (.+)")
     local commit_info = splitted[3]
 
-    return {
+    return make_entry.set_default_entry_mt({
       value = stash_idx,
       ordinal = commit_info,
       branch_name = branch_name,
       commit_info = commit_info,
       display = make_display,
-    }
+    }, opts)
   end
 end
 
@@ -312,13 +359,13 @@ function make_entry.gen_from_git_commits(opts)
       msg = "<empty commit message>"
     end
 
-    return {
+    return make_entry.set_default_entry_mt({
       value = sha,
       ordinal = sha .. " " .. msg,
       msg = msg,
       display = make_display,
       current_file = opts.current_file,
-    }
+    }, opts)
   end
 end
 
@@ -364,7 +411,7 @@ function make_entry.gen_from_quickfix(opts)
   return function(entry)
     local filename = vim.F.if_nil(entry.filename, get_filename(entry.bufnr))
 
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       ordinal = (not hidden and filename or "") .. " " .. entry.text,
       display = make_display,
@@ -376,7 +423,7 @@ function make_entry.gen_from_quickfix(opts)
       text = entry.text,
       start = entry.start,
       finish = entry.finish,
-    }
+    }, opts)
   end
 end
 
@@ -443,8 +490,7 @@ function make_entry.gen_from_lsp_symbols(opts)
       ordinal = filename .. " "
     end
     ordinal = ordinal .. symbol_name .. " " .. (symbol_type or "unknown")
-
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       ordinal = ordinal,
       display = make_display,
@@ -456,7 +502,7 @@ function make_entry.gen_from_lsp_symbols(opts)
       symbol_type = symbol_type,
       start = entry.start,
       finish = entry.finish,
-    }
+    }, opts)
   end
 end
 
@@ -508,7 +554,7 @@ function make_entry.gen_from_buffer(opts)
     local indicator = entry.flag .. hidden .. readonly .. changed
     local line_count = vim.api.nvim_buf_line_count(entry.bufnr)
 
-    return {
+    return make_entry.set_default_entry_mt({
       value = bufname,
       ordinal = entry.bufnr .. " : " .. bufname,
       display = make_display,
@@ -518,7 +564,7 @@ function make_entry.gen_from_buffer(opts)
       -- account for potentially stale lnum as getbufinfo might not be updated or from resuming buffers picker
       lnum = entry.info.lnum ~= 0 and math.max(math.min(entry.info.lnum, line_count), 1) or 1,
       indicator = indicator,
-    }
+    }, opts)
   end
 end
 
@@ -565,7 +611,7 @@ function make_entry.gen_from_treesitter(opts)
     local ts_utils = require "nvim-treesitter.ts_utils"
     local start_row, start_col, end_row, _ = ts_utils.get_node_range(entry.node)
     local node_text = vim.treesitter.get_node_text(entry.node, bufnr)
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry.node,
       kind = entry.kind,
       ordinal = node_text .. " " .. (entry.kind or "unknown"),
@@ -580,7 +626,7 @@ function make_entry.gen_from_treesitter(opts)
       text = node_text,
       start = start_row,
       finish = end_row,
-    }
+    }, opts)
   end
 end
 
@@ -595,14 +641,12 @@ function make_entry.gen_from_packages(opts)
   end
 
   return function(module_name)
-    local entry = {
+    return make_entry.set_default_entry_mt({
       valid = module_name ~= "",
       value = module_name,
       ordinal = module_name,
-    }
-    entry.display = make_display(module_name)
-
-    return entry
+      display = make_display(module_name),
+    }, opts)
   end
 end
 
@@ -644,21 +688,21 @@ function make_entry.gen_from_apropos(opts)
     cmd = vim.split(cmd, ",")[1]
     return keyword
         and sections[section]
-        and {
+        and make_entry.set_default_entry_mt({
           value = cmd,
           description = desc,
           ordinal = cmd,
           display = make_display,
           section = section,
           keyword = keyword,
-        }
+        }, opts)
       or nil
   end
 end
 
-function make_entry.gen_from_marks(_)
+function make_entry.gen_from_marks(opts)
   return function(item)
-    return {
+    return make_entry.set_default_entry_mt({
       value = item.line,
       ordinal = item.line,
       display = item.line,
@@ -666,11 +710,11 @@ function make_entry.gen_from_marks(_)
       col = item.col,
       start = item.lnum,
       filename = item.filename,
-    }
+    }, opts)
   end
 end
 
-function make_entry.gen_from_registers(_)
+function make_entry.gen_from_registers(opts)
   local displayer = entry_display.create {
     separator = " ",
     hl_chars = { ["["] = "TelescopeBorder", ["]"] = "TelescopeBorder" },
@@ -689,12 +733,12 @@ function make_entry.gen_from_registers(_)
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       ordinal = entry,
       content = vim.fn.getreg(entry),
       display = make_display,
-    }
+    }, opts)
   end
 end
 
@@ -727,7 +771,7 @@ function make_entry.gen_from_keymaps(opts)
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       mode = entry.mode,
       lhs = get_lhs(entry),
       desc = get_desc(entry),
@@ -736,22 +780,22 @@ function make_entry.gen_from_keymaps(opts)
       value = entry,
       ordinal = entry.mode .. " " .. get_lhs(entry) .. " " .. get_desc(entry),
       display = make_display,
-    }
+    }, opts)
   end
 end
 
-function make_entry.gen_from_highlights()
+function make_entry.gen_from_highlights(opts)
   local make_display = function(entry)
     local display = entry.value
     return display, { { { 0, #display }, display } }
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       display = make_display,
       ordinal = entry,
-    }
+    }, opts)
   end
 end
 
@@ -772,12 +816,12 @@ function make_entry.gen_from_picker(opts)
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       text = entry.prompt_title,
       ordinal = string.format("%s %s", entry.prompt_title, vim.F.if_nil(entry.default_text, "")),
       display = make_display,
-    }
+    }, opts)
   end
 end
 
@@ -820,17 +864,17 @@ function make_entry.gen_from_buffer_lines(opts)
       return
     end
 
-    return {
+    return make_entry.set_default_entry_mt({
       ordinal = entry.text,
       display = make_display,
       filename = entry.filename,
       lnum = entry.lnum,
       text = entry.text,
-    }
+    }, opts)
   end
 end
 
-function make_entry.gen_from_vimoptions()
+function make_entry.gen_from_vimoptions(opts)
   local displayer = entry_display.create {
     separator = "",
     hl_chars = { ["["] = "TelescopeBorder", ["]"] = "TelescopeBorder" },
@@ -871,7 +915,7 @@ function make_entry.gen_from_vimoptions()
       entry.ordinal = entry.ordinal .. " " .. utils.display_termcodes(tostring(o.default))
     end
 
-    return entry
+    return make_entry.set_default_entry_mt(entry, opts)
   end
 end
 
@@ -927,6 +971,11 @@ function make_entry.gen_from_ctags(opts)
 
   local mt = {}
   mt.__index = function(t, k)
+    local override = handle_entry_index(opts, t, k)
+    if override then
+      return override
+    end
+
     if k == "path" then
       local retpath = Path:new({ t.filename }):absolute()
       if not vim.loop.fs_access(retpath, "R", nil) then
@@ -1036,7 +1085,7 @@ function make_entry.gen_from_diagnostics(opts)
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       value = entry,
       ordinal = ("%s %s"):format(not hidden and entry.filename or "", entry.text),
       display = make_display,
@@ -1045,11 +1094,11 @@ function make_entry.gen_from_diagnostics(opts)
       lnum = entry.lnum,
       col = entry.col,
       text = entry.text,
-    }
+    }, opts)
   end
 end
 
-function make_entry.gen_from_autocommands(_)
+function make_entry.gen_from_autocommands(opts)
   local displayer = entry_display.create {
     separator = "▏",
     items = {
@@ -1071,7 +1120,7 @@ function make_entry.gen_from_autocommands(_)
 
   return function(entry)
     local group_name = vim.F.if_nil(entry.group_name, "<anonymous>")
-    return {
+    return make_entry.set_default_entry_mt({
       value = {
         event = entry.event,
         group_name = group_name,
@@ -1081,11 +1130,11 @@ function make_entry.gen_from_autocommands(_)
       --
       ordinal = entry.event .. " " .. group_name .. " " .. entry.pattern .. " " .. entry.command,
       display = make_display,
-    }
+    }, opts)
   end
 end
 
-function make_entry.gen_from_commands(_)
+function make_entry.gen_from_commands(opts)
   local displayer = entry_display.create {
     separator = "▏",
     items = {
@@ -1118,7 +1167,7 @@ function make_entry.gen_from_commands(_)
   end
 
   return function(entry)
-    return {
+    return make_entry.set_default_entry_mt({
       name = entry.name,
       bang = entry.bang,
       nargs = entry.nargs,
@@ -1128,7 +1177,7 @@ function make_entry.gen_from_commands(_)
       value = entry,
       ordinal = entry.name,
       display = make_display,
-    }
+    }, opts)
   end
 end
 
@@ -1187,13 +1236,13 @@ function make_entry.gen_from_git_status(opts)
     end
     local mod, file = string.match(entry, "(..).*%s[->%s]?(.+)")
 
-    return {
+    return setmetatable({
       value = file,
       status = mod,
       ordinal = entry,
       display = make_display,
       path = Path:new({ opts.cwd, file }):absolute(),
-    }
+    }, opts)
   end
 end
 
-- 
cgit v1.2.3


From a0a038170dbb5e4b69a50f648a8cf5cae6a910a3 Mon Sep 17 00:00:00 2001
From: julianf <julianf@digitalbakery.net>
Date: Thu, 30 Jun 2022 16:03:55 +0200
Subject: docs: `make_entry` and `entry_display`

---
 lua/telescope/make_entry.lua | 42 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)

(limited to 'lua/telescope/make_entry.lua')

diff --git a/lua/telescope/make_entry.lua b/lua/telescope/make_entry.lua
index e8f2509..64993df 100644
--- a/lua/telescope/make_entry.lua
+++ b/lua/telescope/make_entry.lua
@@ -1,3 +1,40 @@
+---@tag telescope.make_entry
+
+---@brief [[
+---
+--- Each picker has a finder made up of two parts, the results which are the
+--- data to be displayed, and the entry_maker. These entry_makers are functions
+--- returned from make_entry functions. These will be referrd to as
+--- entry_makers in the following documentation.
+---
+--- Every entry maker returns a function which accepts the data to be used for
+--- an entry. This function will return an entry table (or nil, meaning skip
+--- this entry) which contains of the - following important keys:
+--- - value any: value key can be anything but still required
+--- - valid bool: is an optional key because it defaults to true but if the key
+---   is set to false it will not be displayed by the picker. (optional)
+--- - ordinal string: is the text that is used for filtering (required)
+--- - display string|function: is either a string of the text that is being
+---   displayed or a function receiving the entry at a later stage, when the entry
+---   is actually being displayed. A function can be useful here if complex
+---   calculation have to be done. `make_entry` can also return a second value
+---   a highlight array which will then apply to the line. Highlight entry in
+---   this array has the following signature `{ { start_col, end_col }, hl_group }`
+---   (required).
+--- - filename string: will be interpreted by the default `<cr>` action as
+---   open this file (optional)
+--- - bufnr number: will be interpreted by the default `<cr>` action as open
+---   this buffer (optional)
+--- - lnum number: lnum value which will be interpreted by the default `<cr>`
+---   action as a jump to this line (optional)
+--- - col number: col value which will be interpreted by the default `<cr>`
+---   action as a jump to this column (optional)
+---
+--- More information on easier displaying, see |telescope.pickers.entry_display|
+---
+--- TODO: Document something we call `entry_index`
+---@brief ]]
+
 local entry_display = require "telescope.pickers.entry_display"
 local utils = require "telescope.utils"
 local strings = require "plenary.strings"
@@ -190,9 +227,6 @@ do
     return { filename, lnum, col, text }
   end
 
-  --- Special options:
-  ---  - disable_coordinates: Don't show the line & row numbers
-  ---  - only_sort_text: Only sort via the text. Ignore filename and other items
   function make_entry.gen_from_vimgrep(opts)
     local mt_vimgrep_entry
 
@@ -919,8 +953,6 @@ function make_entry.gen_from_vimoptions(opts)
   end
 end
 
---- Special options:
----  - only_sort_tags: Only sort via tag name. Ignore filename and other items
 function make_entry.gen_from_ctags(opts)
   opts = opts or {}
 
-- 
cgit v1.2.3