init.lua

---------------------------------------------------------------------------//
-- HELPERS
---------------------------------------------------------------------------//
local lazy = require("bufferline.lazy")
local constants = lazy.require("bufferline.constants") ---@module "bufferline.constants"
local config = lazy.require("bufferline.config") ---@module "bufferline.config"

local M = {}

local fn, api = vim.fn, vim.api
local strwidth = api.nvim_strwidth

local is_version_11 = fn.has("nvim-0.11") == 1

function M.is_test()
  ---@diagnostic disable-next-line: undefined-global
  return __TEST
end

---Takes a list of items and runs the callback
---on each updating the initial value
---@generic T, S
---@param callback fun(accum:S, item: T, key: integer|string): S
---@param list table<integer|string, T>
---@param accum S
---@return S
---@overload fun(callback: fun(accum: any, item: any, key: (integer|string)): any, list: any[]): any
function M.fold(callback, list, accum)
  assert(callback, "a callback must be passed to fold")
  if type(accum) == "function" and type(callback) == "table" then
    list, callback, accum = callback, accum, {}
  end
  accum = accum or {}
  for i, v in pairs(list) do
    accum = callback(accum, v, i)
  end
  return accum
end

---Variant of some that sums up the display size of characters
---@vararg string
---@return integer
function M.measure(...)
  return M.fold(function(accum, item) return accum + strwidth(tostring(item)) end, { ... }, 0)
end

---Concatenate a series of strings together
---@vararg string
---@return string
function M.join(...)
  return M.fold(function(accum, item) return accum .. item end, { ... }, "")
end

---@generic T
---@param callback fun(item: T, index: integer): T
---@param list T[]
---@return T[]
function M.map(callback, list)
  local accum = {}
  for index, item in ipairs(list) do
    accum[index] = callback(item, index)
  end
  return accum
end

--- Search for an item in a list like table returning the item and its index
--- if the predicate returns true for the item
---@generic T
---@param list T[]
---@param callback fun(item: T, index: number): boolean
---@return T?, number?
function M.find(callback, list)
  for i, v in ipairs(list) do
    if callback(v, i) then return v, i end
  end
end

-- return a new array containing the concatenation of all of its
-- parameters. Scalar parameters are included in place, and array
-- parameters have their values shallow-copied to the final array.
-- Note that userdata and function values are treated as scalar.
-- https://stackoverflow.com/questions/1410862/concatenation-of-tables-in-lua
--- @generic T
--- @vararg T
--- @return T[]
function M.merge_lists(...)
  local t = {}
  for n = 1, select("#", ...) do
    local arg = select(n, ...)
    if type(arg) == "table" then
      for _, v in pairs(arg) do
        t[#t + 1] = v
      end
    else
      t[#t + 1] = arg
    end
  end
  return t
end

---Execute a callback for each item or only those that match if a matcher is passed
---@generic T
---@param list T[]
---@param callback fun(item: T)
---@param matcher (fun(item: T):boolean)?
function M.for_each(callback, list, matcher)
  for _, item in ipairs(list) do
    if not matcher or matcher(item) then callback(item) end
  end
end

--- creates a table whose keys are tbl's values and the value of these keys
--- is their key in tbl (similar to vim.tbl_add_reverse_lookup)
--- this assumes that the values in tbl are unique and hashable (no nil/NaN)
--- @generic K,V
--- @param tbl table<K,V>
--- @return table<V,K>
function M.tbl_reverse_lookup(tbl)
  local ret = {}
  for k, v in pairs(tbl) do
    ret[v] = k
  end
  return ret
end

--- creates a table containing the forward and reversed mapping from the provided
--- table.
--- similar to the now deprecated vim.tbl_add_reverse_lookup
--- @generic K,V
--- @param tbl table<K,V>
--- @return table<V,K>
function M.tbl_add_reverse_lookup(tbl)
  local ret = {}
  for k, v in pairs(tbl) do
    ret[k] = v
    ret[v] = k
  end

  return ret
end

M.path_sep = fn.has("win32") == 1 and "\\" or "/"

-- The provided api nvim_is_buf_valid filters out all invalid or unlisted buffers
--- @param buf table
function M.is_valid(buf)
  if not buf.bufnr or buf.bufnr < 1 then return false end
  local valid = vim.api.nvim_buf_is_valid(buf.bufnr)
  if not valid then return false end
  return buf.listed == 1
end

---@return integer
function M.get_buf_count() return #fn.getbufinfo({ buflisted = 1 }) end

---@return integer[]
function M.get_valid_buffers()
  local bufs = vim.fn.getbufinfo()
  local valid_bufs = {}
  for _, buf in ipairs(bufs) do
    if M.is_valid(buf) then table.insert(valid_bufs, buf.bufnr) end
  end
  return valid_bufs
end

---@return integer
function M.get_tab_count() return #fn.gettabinfo() end

function M.close_tab(tabhandle) vim.cmd("tabclose " .. api.nvim_tabpage_get_number(tabhandle)) end

--- Wrapper around `vim.notify` that adds message metadata
---@param msg string | string[]
---@param level "error" | "warn" | "info" | "debug" | "trace"
function M.notify(msg, level, opts)
  opts = opts or {}
  level = vim.log.levels[level:upper()]
  if type(msg) == "table" then msg = table.concat(msg, "\n") end
  local nopts = { title = "Bufferline" }
  if opts.once then
    return vim.schedule(function() vim.notify_once(msg, level, nopts) end)
  end
  vim.schedule(function() vim.notify(msg, level, nopts) end)
end

---@return number[]?
function M.restore_positions()
  local str = vim.g[constants.positions_key]
  local ok, paths = pcall(vim.json.decode, str)
  if not ok or type(paths) ~= "table" or #paths == 0 then return nil end
  local ids = vim.tbl_map(function(path)
    local escaped = fn.fnameescape(path)
    return fn.bufnr("^" .. escaped .. "$" --[[@as integer]])
  end, paths)
  return vim.tbl_filter(function(id) return id ~= -1 end, ids)
end

---@param ids number[]
function M.save_positions(ids)
  local paths = vim.tbl_map(function(id) return vim.api.nvim_buf_get_name(id) end, ids)
  vim.g[constants.positions_key] = vim.json.encode(paths)
end

--- @param elements bufferline.TabElement[]
--- @return number[]
function M.get_ids(elements)
  return vim.tbl_map(function(item) return item.id end, elements)
end

---Get an icon for a filetype using either nvim-web-devicons or vim-devicons
---if using the lua plugin this also returns the icon's highlights
---@param opts bufferline.IconFetcherOpts
---@return string, string?
function M.get_icon(opts)
  local user_func = config.options.get_element_icon
  if user_func and vim.is_callable(user_func) then
    local icon, hl = user_func(opts)
    if icon then return icon, hl end
  end

  local loaded, webdev_icons = pcall(require, "nvim-web-devicons")
  if opts.directory then
    local hl = loaded and "DevIconDefault" or nil
    return constants.FOLDER_ICON, hl
  end

  if not loaded then
    -- TODO: deprecate this in favour of nvim-web-devicons
    if fn.exists("*WebDevIconsGetFileTypeSymbol") > 0 then return fn.WebDevIconsGetFileTypeSymbol(opts.path), "" end
    return "", ""
  end
  if type == "terminal" then return webdev_icons.get_icon(type) end

  local icon, hl = webdev_icons.get_icon(fn.fnamemodify(opts.path, ":t"), nil, {
    default = true,
  })

  if not icon then return "", "" end
  return icon, hl
end

-- truncate a string based on number of display columns/cells it occupies
-- so that multibyte characters are not broken up mid character
---@param str string
---@param col_limit integer
---@return string
local function truncate_by_cell(str, col_limit)
  if str and str:len() == strwidth(str) then return fn.strcharpart(str, 0, col_limit) end
  local short = fn.strcharpart(str, 0, col_limit)
  local width = strwidth(short)
  while width > 1 and width > col_limit do
    short = fn.strcharpart(short, 0, fn.strchars(short) - 1)
    width = strwidth(short)
  end
  return short
end

--- Truncate a name being mindful of multibyte characters and append an ellipsis
---@param name string
---@param word_limit integer
---@return string
function M.truncate_name(name, word_limit)
  if strwidth(name) <= word_limit then return name end
  -- truncate nicely by seeing if we can drop the extension first
  -- to make things fit if not then truncate abruptly
  local ext = fn.fnamemodify(name, ":e")
  if ext ~= "" and ext:match("^%w+$") then
    local truncated = name:gsub("%." .. ext, "", 1)
    if strwidth(truncated) < word_limit then return truncated .. constants.ELLIPSIS end
  end
  return truncate_by_cell(name, word_limit - 1) .. constants.ELLIPSIS
end

---@diagnostic disable: deprecated
-- TODO: deprecate this in nvim-0.11 or use strict lists. Determine which list-check function to use
M.is_list = vim.isarray or vim.islist or vim.tbl_isarray or vim.tbl_islist

---@diagnostic disable: deprecated
function M.tbl_flatten(t) return is_version_11 and vim.iter(t):flatten(math.huge):totable() or vim.tbl_flatten(t) end

return M