321 lines
10 KiB
Lua
321 lines
10 KiB
Lua
local vim = vim
|
|
|
|
local parser = require('symbols-outline.parser')
|
|
local ui = require('symbols-outline.ui')
|
|
local writer = require('symbols-outline.writer')
|
|
local config = require('symbols-outline.config')
|
|
local utils = require('symbols-outline.utils.lsp_utils')
|
|
local markdown = require('symbols-outline.markdown')
|
|
|
|
local M = {}
|
|
|
|
local function setup_commands()
|
|
vim.cmd("command! " .. "SymbolsOutline " ..
|
|
":lua require'symbols-outline'.toggle_outline()")
|
|
vim.cmd("command! " .. "SymbolsOutlineOpen " ..
|
|
":lua require'symbols-outline'.open_outline()")
|
|
vim.cmd("command! " .. "SymbolsOutlineClose " ..
|
|
":lua require'symbols-outline'.close_outline()")
|
|
end
|
|
|
|
local function setup_global_autocmd()
|
|
vim.cmd(
|
|
"au InsertLeave,WinEnter,BufEnter,BufWinEnter,TabEnter,BufWritePost * :lua require('symbols-outline')._refresh()")
|
|
vim.cmd "au BufLeave * lua require'symbols-outline'._prevent_buffer_override()"
|
|
vim.cmd("au WinEnter * lua require'symbols-outline.preview'.close()")
|
|
if config.options.highlight_hovered_item then
|
|
vim.cmd(
|
|
"autocmd CursorHold * :lua require('symbols-outline')._highlight_current_item()")
|
|
end
|
|
end
|
|
|
|
local function setup_buffer_autocmd()
|
|
if config.options.auto_preview then
|
|
vim.cmd(
|
|
"au CursorHold <buffer> lua require'symbols-outline.preview'.show(true)")
|
|
else
|
|
vim.cmd(
|
|
"au CursorMoved <buffer> lua require'symbols-outline.preview'.close()")
|
|
end
|
|
|
|
end
|
|
|
|
local function getParams()
|
|
return {textDocument = vim.lsp.util.make_text_document_params()}
|
|
end
|
|
|
|
--- @param f function
|
|
--- @param delay number
|
|
--- @return function
|
|
local function debounce(f, delay)
|
|
local timer = vim.loop.new_timer()
|
|
|
|
return function (...)
|
|
local args = { ... }
|
|
|
|
timer:start(delay, 0, vim.schedule_wrap(function ()
|
|
timer:stop()
|
|
f(unpack(args))
|
|
end))
|
|
end
|
|
end
|
|
|
|
|
|
-------------------------
|
|
-- STATE
|
|
-------------------------
|
|
M.state = {
|
|
outline_items = {},
|
|
flattened_outline_items = {},
|
|
outline_win = nil,
|
|
outline_buf = nil,
|
|
code_win = nil
|
|
}
|
|
|
|
local function wipe_state()
|
|
M.state = {outline_items = {}, flattened_outline_items = {}}
|
|
end
|
|
|
|
local function __refresh ()
|
|
if M.state.outline_buf ~= nil then
|
|
local function refresh_handler(response)
|
|
if response == nil or type(response) ~= 'table' then
|
|
return
|
|
end
|
|
|
|
local current_buf = vim.api.nvim_get_current_buf()
|
|
if (not utils.is_buf_markdown(current_buf)) and
|
|
(not utils.is_buf_attached_to_lsp(current_buf)) then
|
|
return
|
|
end
|
|
|
|
local items = parser.parse(response)
|
|
|
|
M.state.code_win = vim.api.nvim_get_current_win()
|
|
M.state.outline_items = items
|
|
M.state.flattened_outline_items = parser.flatten(items)
|
|
|
|
writer.parse_and_write(M.state.outline_buf,
|
|
M.state.flattened_outline_items)
|
|
end
|
|
|
|
if vim.api.nvim_buf_get_option(0, 'ft') == 'markdown' then
|
|
refresh_handler(markdown.handle_markdown())
|
|
end
|
|
vim.lsp.buf_request_all(0, "textDocument/documentSymbol", getParams(),
|
|
refresh_handler)
|
|
end
|
|
end
|
|
|
|
M._refresh = debounce(__refresh, 100)
|
|
|
|
function M._goto_location(change_focus)
|
|
local current_line = vim.api.nvim_win_get_cursor(M.state.outline_win)[1]
|
|
local node = M.state.flattened_outline_items[current_line]
|
|
vim.api.nvim_win_set_cursor(M.state.code_win,
|
|
{node.line + 1, node.character})
|
|
if change_focus then vim.fn.win_gotoid(M.state.code_win) end
|
|
end
|
|
|
|
function M._highlight_current_item(winnr)
|
|
local doesnt_have_lsp = not utils.is_buf_attached_to_lsp(
|
|
vim.api.nvim_win_get_buf(winnr or 0))
|
|
|
|
local is_current_buffer_the_outline =
|
|
M.state.outline_buf == vim.api.nvim_get_current_buf()
|
|
|
|
local doesnt_have_outline_buf = not M.state.outline_buf
|
|
|
|
local is_not_markdown = not utils.is_buf_markdown(0)
|
|
|
|
local should_exit = (doesnt_have_lsp and is_not_markdown) or
|
|
doesnt_have_outline_buf or
|
|
is_current_buffer_the_outline
|
|
|
|
-- Make a special case if we have a window number
|
|
-- Because we might use this to manually focus so we dont want to quit this
|
|
-- function
|
|
if winnr then should_exit = false end
|
|
|
|
if should_exit then return end
|
|
|
|
local win = winnr or vim.api.nvim_get_current_win()
|
|
|
|
local hovered_line = vim.api.nvim_win_get_cursor(win)[1] - 1
|
|
|
|
local nodes = {}
|
|
for index, value in ipairs(M.state.flattened_outline_items) do
|
|
if value.line == hovered_line or
|
|
(hovered_line > value.range_start and hovered_line < value.range_end) then
|
|
value.line_in_outline = index
|
|
table.insert(nodes, value)
|
|
end
|
|
end
|
|
|
|
-- clear old highlight
|
|
ui.clear_hover_highlight(M.state.outline_buf)
|
|
for _, value in ipairs(nodes) do
|
|
ui.add_hover_highlight(M.state.outline_buf, value.line_in_outline - 1,
|
|
value.depth * 2)
|
|
vim.api.nvim_win_set_cursor(M.state.outline_win,
|
|
{value.line_in_outline, 1})
|
|
end
|
|
end
|
|
|
|
-- credits: https://github.com/kyazdani42/nvim-tree.lua
|
|
function M._prevent_buffer_override()
|
|
vim.schedule(function()
|
|
local curwin = vim.api.nvim_get_current_win()
|
|
local curbuf = vim.api.nvim_win_get_buf(curwin)
|
|
local wins = vim.api.nvim_list_wins()
|
|
|
|
if curwin ~= M.state.outline_win or curbuf ~= M.state.outline_buf then
|
|
return
|
|
end
|
|
|
|
-- if this is the only window left, return early. Else we won't be able to close the last buffer. #22
|
|
if #wins == 1 and curbuf == M.state.outline_buf then return end
|
|
|
|
vim.cmd("buffer " .. M.state.outline_buf)
|
|
|
|
local current_win_width = vim.api.nvim_win_get_width(curwin)
|
|
if #wins < 2 then
|
|
vim.cmd(config.get_split_command())
|
|
vim.cmd("vertical resize " .. math.ceil(current_win_width * 0.75))
|
|
else
|
|
vim.cmd("wincmd " .. config.get_position_navigation_direction())
|
|
end
|
|
|
|
vim.cmd("buffer " .. curbuf)
|
|
if #wins < 2 then
|
|
vim.cmd("wincmd r")
|
|
vim.cmd("bprev")
|
|
end
|
|
end)
|
|
end
|
|
|
|
local function setup_keymaps(bufnr)
|
|
---maps the table of keys to the action
|
|
---@param keys table
|
|
---@param action string
|
|
local function nmap(keys, action)
|
|
if type(keys) == 'string' then keys = {keys} end
|
|
|
|
for _, value in ipairs(keys) do
|
|
vim.api.nvim_buf_set_keymap(bufnr, "n", value, action,
|
|
{silent = true, noremap = true})
|
|
end
|
|
end
|
|
|
|
-- goto_location of symbol and focus that window
|
|
nmap(config.options.keymaps.goto_location,
|
|
":lua require('symbols-outline')._goto_location(true)<Cr>")
|
|
-- goto_location of symbol but stay in outline
|
|
nmap(config.options.keymaps.focus_location,
|
|
":lua require('symbols-outline')._goto_location(false)<Cr>")
|
|
-- hover symbol
|
|
nmap(config.options.keymaps.hover_symbol,
|
|
":lua require('symbols-outline.hover').show_hover()<Cr>")
|
|
-- preview symbol
|
|
nmap(config.options.keymaps.preview_symbol,
|
|
":lua require('symbols-outline.preview').toggle()<Cr>")
|
|
-- rename symbol
|
|
nmap(config.options.keymaps.rename_symbol,
|
|
":lua require('symbols-outline.rename').rename()<Cr>")
|
|
-- code actions
|
|
nmap(config.options.keymaps.code_actions,
|
|
":lua require('symbols-outline.code_action').show_code_actions()<Cr>")
|
|
-- show help
|
|
nmap(config.options.keymaps.show_help,
|
|
":lua require('symbols-outline.config').show_help()<Cr>")
|
|
-- close outline
|
|
nmap(config.options.keymaps.close, ":bw!<Cr>")
|
|
end
|
|
|
|
----------------------------
|
|
-- WINDOW AND BUFFER STUFF
|
|
----------------------------
|
|
local function setup_buffer()
|
|
M.state.outline_buf = vim.api.nvim_create_buf(false, true)
|
|
vim.api.nvim_buf_attach(M.state.outline_buf, false,
|
|
{on_detach = function(_, _) wipe_state() end})
|
|
vim.api.nvim_buf_set_option(M.state.outline_buf, "bufhidden", "delete")
|
|
|
|
local current_win = vim.api.nvim_get_current_win()
|
|
local current_win_width = vim.api.nvim_win_get_width(current_win)
|
|
|
|
vim.cmd(config.get_split_command())
|
|
vim.cmd("vertical resize " ..
|
|
math.ceil(current_win_width * config.get_width_percentage()))
|
|
M.state.outline_win = vim.api.nvim_get_current_win()
|
|
vim.api.nvim_win_set_buf(M.state.outline_win, M.state.outline_buf)
|
|
|
|
setup_keymaps(M.state.outline_buf)
|
|
|
|
vim.api.nvim_win_set_option(M.state.outline_win, "number", false)
|
|
vim.api.nvim_win_set_option(M.state.outline_win, "relativenumber", false)
|
|
vim.api.nvim_win_set_option(M.state.outline_win, "winfixwidth", true)
|
|
vim.api.nvim_buf_set_name(M.state.outline_buf, "OUTLINE")
|
|
vim.api.nvim_buf_set_option(M.state.outline_buf, "filetype", "Outline")
|
|
vim.api.nvim_buf_set_option(M.state.outline_buf, "modifiable", false)
|
|
|
|
if config.options.show_numbers or config.options.show_relative_numbers then
|
|
vim.api.nvim_win_set_option(M.state.outline_win, "nu", true)
|
|
end
|
|
|
|
if config.options.show_relative_numbers then
|
|
vim.api.nvim_win_set_option(M.state.outline_win, "rnu", true)
|
|
end
|
|
end
|
|
|
|
local function handler(response)
|
|
if response == nil or type(response) ~= 'table' then return end
|
|
|
|
M.state.code_win = vim.api.nvim_get_current_win()
|
|
|
|
setup_buffer()
|
|
setup_buffer_autocmd()
|
|
|
|
local items = parser.parse(response)
|
|
|
|
M.state.outline_items = items
|
|
M.state.flattened_outline_items = parser.flatten(items)
|
|
|
|
writer.parse_and_write(M.state.outline_buf, M.state.flattened_outline_items)
|
|
ui.setup_highlights()
|
|
|
|
M._highlight_current_item(M.state.code_win)
|
|
end
|
|
|
|
function M.toggle_outline()
|
|
if M.state.outline_buf == nil then
|
|
M.open_outline()
|
|
else
|
|
M.close_outline()
|
|
end
|
|
end
|
|
|
|
function M.open_outline()
|
|
if M.state.outline_buf == nil then
|
|
if vim.api.nvim_buf_get_option(0, 'ft') == 'markdown' then
|
|
handler(markdown.handle_markdown())
|
|
end
|
|
vim.lsp.buf_request_all(0, "textDocument/documentSymbol", getParams(),
|
|
handler)
|
|
end
|
|
end
|
|
|
|
function M.close_outline()
|
|
if M.state.outline_buf ~= nil then
|
|
vim.api.nvim_win_close(M.state.outline_win, true)
|
|
end
|
|
end
|
|
|
|
function M.setup(opts)
|
|
config.setup(opts)
|
|
setup_commands()
|
|
setup_global_autocmd()
|
|
end
|
|
|
|
return M
|