telescope.nvim/lua/telescope/pickers/layout_strategies.lua

---@tag telescope.layout

---@brief [[
---
--- Layout strategies are different functions to position telescope.
---
--- All layout strategies are functions with the following signature:
---
--- <pre>
---   function(picker, columns, lines)
---     -- Do some calculations here...
---     return {
---       preview = preview_configuration
---       results = results_configuration,
---       prompt = prompt_configuration,
---     }
---   end
---
---   Parameters: ~
---     - picker  : A Picker object. (docs coming soon)
---     - columns : number Columns in the vim window
---     - lines   : number Lines in the vim window
---
--- </pre>
---
--- TODO: I would like to make these link to `telescope.layout_strategies.*`,
--- but it's not yet possible.
---
--- Available layout strategies include:
---   - horizontal:
---     - See |layout_strategies.horizontal|
---
---   - vertical:
---     - See |layout_strategies.vertical|
---
---   - flex:
---     - See |layout_strategies.flex|
---
--- Available tweaks to the settings in layout defaults include
--- (can be applied to horizontal and vertical layouts):
---   - mirror (default is `false`):
---     - Flip the view of the current layout:
---       - If using horizontal: if `true`, swaps the location of the
---         results/prompt window and preview window
---       - If using vertical: if `true`, swaps the location of the results and
---         prompt windows
---
---   - width_padding:
---     - How many cells to pad the width of Telescope's layout window
---
---   - height_padding:
---     - How many cells to pad the height of Telescope's layout window
---
---   - preview_width:
---     - Change the width of Telescope's preview window
---
---   - scroll_speed:
---     - Change the scrolling speed of the previewer
---@brief ]]

local config = require('telescope.config')
local resolve = require("telescope.config.resolve")

local p_window = require('telescope.pickers.window')


-- Check if there are any borders. Right now it's a little raw as
-- there are a few things that contribute to the border
local is_borderless = function(opts)
  return opts.window.border == false
end


local function validate_layout_config(options, values)
  for k, _ in pairs(options) do
    if not values[k] then
      error(string.format(
        "Unsupported layout_config key: %s\n%s",
        k,
        vim.inspect(values)
      ))
    end
  end

  return options
end

local layout_strategies = {}

--- Horizontal previewer
---
--- <pre>
---   +-------------+--------------+
---   |             |              |
---   |   Results   |              |
---   |             |    Preview   |
---   |             |              |
---   +-------------|              |
---   |   Prompt    |              |
---   +-------------+--------------+
--- </pre>
layout_strategies.horizontal = function(self, max_columns, max_lines)
  local layout_config = validate_layout_config(self.layout_config or {}, {
    width_padding = "How many cells to pad the width",
    height_padding = "How many cells to pad the height",
    preview_width = "(Resolvable): Determine preview width",
    mirror = "Flip the location of the results/prompt and preview windows",
    scroll_speed = "The speed when scrolling through the previewer",
  })

  local initial_options = p_window.get_initial_window_options(self)
  local preview = initial_options.preview
  local results = initial_options.results
  local prompt = initial_options.prompt

  -- TODO: Test with 120 width terminal
  -- TODO: Test with self.width
  local width_padding = resolve.resolve_width(layout_config.width_padding or function(_, cols)
    if cols < self.preview_cutoff then
      return 2
    elseif cols < 150 then
      return 5
    else
      return 10
    end
  end)(self, max_columns, max_lines)
  local picker_width = max_columns - 2 * width_padding

  local height_padding = resolve.resolve_height(layout_config.height_padding or function(_, _, lines)
    if lines < 40 then
      return 4
    else
      return math.floor(0.1 * lines)
    end
  end)(self, max_columns, max_lines)
  local picker_height = max_lines - 2 * height_padding

  if self.previewer then
    preview.width = resolve.resolve_width(layout_config.preview_width or function(_, cols)
      if not self.previewer or cols < self.preview_cutoff then
        return 0
      elseif cols < 150 then
        return math.floor(cols * 0.4)
      elseif cols < 200 then
        return 80
      else
        return 120
      end
    end)(self, picker_width, max_lines)
  else
    preview.width = 0
  end

  results.width = picker_width - preview.width
  prompt.width = picker_width - preview.width

  prompt.height = 1
  results.height = picker_height - prompt.height - 2

  if self.previewer then
    preview.height = picker_height
  else
    preview.height = 0
  end

  -- Default value is false, to use the normal horizontal layout
  if not layout_config.mirror then
    results.col = width_padding
    prompt.col = width_padding
    preview.col = results.col + results.width + 2
  else
    preview.col = width_padding
    prompt.col = preview.col + preview.width + 2
    results.col = preview.col + preview.width + 2
  end

  preview.line = height_padding
  if self.window.prompt_position == "top" then
    prompt.line = height_padding
    results.line = prompt.line + prompt.height + 2
  elseif self.window.prompt_position == "bottom" then
    results.line = height_padding
    prompt.line = results.line + results.height + 2
  else
    error("Unknown prompt_position: " .. self.window.prompt_position)
  end

  return {
    preview = self.previewer and preview.width > 0 and preview,
    results = results,
    prompt = prompt
}
end

--- Centered layout wih smaller default sizes (I think)
---
--- <pre>
---    +--------------+
---    |    Preview   |
---    +--------------+
---    |    Prompt    |
---    +--------------+
---    |    Result    |
---    |    Result    |
---    |    Result    |
---    +--------------+
--- </pre>
layout_strategies.center = function(self, columns, lines)
  local initial_options = p_window.get_initial_window_options(self)
  local preview = initial_options.preview
  local results = initial_options.results
  local prompt = initial_options.prompt

  -- This sets the height/width for the whole layout
  local height = resolve.resolve_height(self.window.results_height)(self, columns, lines)
  local width = resolve.resolve_width(self.window.width)(self, columns, lines)

  local max_results = (height > lines and lines or height)
  local max_width = (width > columns and columns or width)

  prompt.height = 1
  results.height = max_results

  prompt.width = max_width
  results.width = max_width
  preview.width = max_width

  -- border size
  local bs = 1
  if is_borderless(self) then
    bs = 0
  end

  prompt.line = (lines / 2) - ((max_results + (bs * 2)) / 2)
  results.line = prompt.line + 1 + (bs)

  preview.line = 1
  preview.height = math.floor(prompt.line - (2 + bs))

  if not self.previewer or columns < self.preview_cutoff then
    preview.height = 0
  end

  results.col = math.ceil((columns / 2) - (width / 2) - bs)
  prompt.col = results.col
  preview.col = results.col

  return {
    preview = self.previewer and preview.width > 0 and preview,
    results = results,
    prompt = prompt
  }
end

--- Vertical perviewer stacks the items on top of each other.
---
--- <pre>
---    +-----------------+
---    |    Previewer    |
---    |    Previewer    |
---    |    Previewer    |
---    +-----------------+
---    |     Result      |
---    |     Result      |
---    |     Result      |
---    +-----------------+
---    |     Prompt      |
---    +-----------------+
--- </pre>
layout_strategies.vertical = function(self, max_columns, max_lines)
  local layout_config = validate_layout_config(self.layout_config or {}, {
    width_padding = "How many cells to pad the width",
    height_padding = "How many cells to pad the height",
    preview_height = "(Resolvable): Determine preview height",
    mirror = "Flip the locations of the results and prompt windows",
    scroll_speed = "The speed when scrolling through the previewer",
  })

  local initial_options = p_window.get_initial_window_options(self)
  local preview = initial_options.preview
  local results = initial_options.results
  local prompt = initial_options.prompt

  local width_padding = resolve.resolve_width(
    layout_config.width_padding or math.ceil((1 - self.window.width) * 0.5 * max_columns)
  )(self, max_columns, max_lines)

  local width = max_columns - width_padding * 2
  if not self.previewer then
    preview.width = 0
  else
    preview.width = width
  end
  results.width = width
  prompt.width = width

  -- Height
  local height_padding = math.max(
    1,
    resolve.resolve_height(layout_config.height_padding or 3)(self, max_columns, max_lines)
  )
  local picker_height = max_lines - 2 * height_padding

  local preview_total = 0
  preview.height = 0
  if self.previewer then
    preview.height = resolve.resolve_height(
      layout_config.preview_height or (max_lines - 15)
    )(self, max_columns, picker_height)

    preview_total = preview.height + 2
  end

  prompt.height = 1
  results.height = picker_height - preview_total - prompt.height - 2

  results.col, preview.col, prompt.col = width_padding, width_padding, width_padding

  if self.previewer then
    if not layout_config.mirror then
      preview.line = height_padding
      results.line = preview.line + preview.height + 2
      prompt.line = results.line + results.height + 2
    else
      prompt.line = height_padding
      results.line = prompt.line + prompt.height + 2
      preview.line = results.line + results.height + 2
    end
  else
    results.line = height_padding
    prompt.line = results.line + results.height + 2
  end

  return {
    preview = self.previewer and preview.width > 0 and preview,
    results = results,
    prompt = prompt
  }
end

--- Swap between `horizontal` and `vertical` strategies based on the window width
---  -  Supports `vertical` or `horizontal` features
---
--- Uses:
---  - flip_columns
---  - flip_lines
layout_strategies.flex = function(self, max_columns, max_lines)
  local layout_config = self.layout_config or {}

  local flip_columns = layout_config.flip_columns or 100
  local flip_lines = layout_config.flip_lines or 20

  if max_columns < flip_columns and max_lines > flip_lines then
    -- TODO: This feels a bit like a hack.... cause you wouldn't be able to pass this to flex easily.
    self.layout_config = (config.values.layout_defaults or {})['vertical']
    return layout_strategies.vertical(self, max_columns, max_lines)
  else
    self.layout_config = (config.values.layout_defaults or {})['horizontal']
    return layout_strategies.horizontal(self, max_columns, max_lines)
  end
end

layout_strategies.current_buffer = function(self, _, _)
  local initial_options = self:_get_initial_window_options()

  local window_width = vim.api.nvim_win_get_width(0)
  local window_height = vim.api.nvim_win_get_height(0)

  local preview = initial_options.preview
  local results = initial_options.results
  local prompt = initial_options.prompt

  local width_padding = 2
  local width = window_width - width_padding * 2
  if not self.previewer then
    preview.width = 0
  else
    preview.width = width
  end
  results.width = width
  prompt.width = width

  -- Height
  local height_padding = 3

  results.height = 10
  prompt.height = 1

  -- The last 2 * 2 is for the extra borders
  if self.previewer then
    preview.height = window_height - results.height - prompt.height - 2 * 2 - height_padding * 2
  else
    results.height = window_height - prompt.height - 2 - height_padding * 2
  end


  local win_position = vim.api.nvim_win_get_position(0)

  local line = win_position[1]
  if self.previewer then
    preview.line = height_padding + line
    results.line = preview.line + preview.height + 2
    prompt.line = results.line + results.height + 2
  else
    results.line = height_padding + line
    prompt.line = results.line + results.height + 2
  end

  local col = win_position[2] + width_padding
  preview.col, results.col, prompt.col = col, col, col

  return {
    preview = preview.width > 0 and preview,
    results = results,
    prompt = prompt,
  }
end

layout_strategies.bottom_pane = function(self, max_columns, max_lines)
  local layout_config = validate_layout_config(self.layout_config or {}, {
    height = "The height of the layout",
  })

  local initial_options = p_window.get_initial_window_options(self)
  local results = initial_options.results
  local prompt = initial_options.prompt
  local preview = initial_options.preview

  local result_height = layout_config.height or 25

  local prompt_width = max_columns
  local col = 0

  local has_border = not not self.window.border
  if has_border then
    col = 1
    prompt_width = prompt_width - 2
  end

  local result_width
  if self.previewer then
    result_width = math.floor(prompt_width / 2)

    local base_col = result_width + 1
    if has_border then
      preview = vim.tbl_deep_extend("force", {
        col = base_col + 2,
        line = max_lines - result_height + 1,
        width = prompt_width - result_width - 2,
        height = result_height - 1,
      }, preview)
    else
      preview = vim.tbl_deep_extend("force", {
        col = base_col,
        line = max_lines - result_height,
        width = prompt_width - result_width,
        height = result_height,
      }, preview)
    end
  else
    preview = nil
    result_width = prompt_width
  end

  return {
    preview = preview,
    prompt = vim.tbl_deep_extend("force", prompt, {
      line = max_lines - result_height - 1,
      col = col,
      height = 1,
      width = prompt_width,
    }),
    results = vim.tbl_deep_extend("force", results, {
      line = max_lines - result_height,
      col = col,
      height = result_height,
      width = result_width,
    }),
  }
end

return layout_strategies