leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(auto_preview): Experimental auto preview and auto hover support

Browse Source 
#10
This commit is contained in:
simrat39
2021-05-02 17:49:18 -07:00
parent a3634eadbd
commit e9adda47f3
4 changed files with 244 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
lua/symbols-outline.lua
View File

@@ -17,16 +17,25 @@ local function setup_commands()
":lua require'symbols-outline'.close_outline()")
end
local function setup_autocmd()
local function setup_global_autocmd()
vim.cmd(
"au InsertLeave,BufEnter,BufWinEnter,TabEnter,BufWritePost * :lua require('symbols-outline')._refresh()")
vim.cmd "au BufDelete * lua require'symbols-outline'._prevent_buffer_override()"
vim.cmd "au BufLeave * lua require'symbols-outline'._prevent_buffer_override()"
if config.options.auto_preview then
vim.cmd "au WinEnter * lua require'symbols-outline.preview'.close_if_not_in_outline()"
end
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()")
end
end
local function getParams()
return {textDocument = vim.lsp.util.make_text_document_params()}
end
@@ -190,6 +199,7 @@ local function handler(_, _, result, client_id)
M.state.code_win = vim.api.nvim_get_current_win()
setup_buffer()
setup_buffer_autocmd()
M.state.outline_items = parser.parse(result)
M.state.flattened_outline_items = parser.flatten(parser.parse(result))
@@ -224,7 +234,7 @@ end
function M.setup(opts)
config.setup(opts)
setup_commands()
setup_autocmd()
setup_global_autocmd()
end
return M

1
lua/symbols-outline/config.lua
View File

@@ -6,6 +6,7 @@ local defaults = {
highlight_hovered_item = true,
show_guides = true,
position = 'right',
auto_preview = false, -- experimental
keymaps = {
close = "<Esc>",
goto_location = "<Cr>",

226
lua/symbols-outline/preview.lua Normal file
View File

@@ -0,0 +1,226 @@
local vim = vim
local main = require('symbols-outline')
local config = require('symbols-outline.config')
local M = {}
local state = {
preview_buf = nil,
preview_win = nil,
hover_buf = nil,
hover_win = nil
}
local function is_current_win_outline()
local curwin = vim.api.nvim_get_current_win()
return curwin == main.state.outline_win
end
local function has_code_win()
local isWinValid = vim.api.nvim_win_is_valid(main.state.code_win)
if not isWinValid then return false end
local bufnr = vim.api.nvim_win_get_buf(main.state.code_win)
local isBufValid = vim.api.nvim_buf_is_valid(bufnr)
return isBufValid
end
local function get_offset()
local outline_winnr = main.state.outline_win
local width = 53
local height = 0
if config.options.position == 'right' then
width = 0 - width
else
width = vim.api.nvim_win_get_width(outline_winnr) + 1
end
return {height, width}
end
local function get_height()
local uis = vim.api.nvim_list_uis()
return math.ceil(uis[1].height / 3)
end
local function get_hovered_node()
local hovered_line = vim.api.nvim_win_get_cursor(main.state.outline_win)[1]
local node = main.state.flattened_outline_items[hovered_line]
return node
end
local function update_preview(code_buf)
code_buf = code_buf or vim.api.nvim_win_get_buf(main.state.code_win)
local node = get_hovered_node()
if not node then return end
local lines = vim.api.nvim_buf_get_lines(code_buf, 0, -1, false)
if state.preview_buf ~= nil then
vim.api.nvim_buf_set_lines(state.preview_buf, 0, -1, 0, lines)
vim.api.nvim_win_set_cursor(state.preview_win,
{node.line + 1, node.character})
end
end
local function setup_preview_buf()
local code_buf = vim.api.nvim_win_get_buf(main.state.code_win)
local ft = vim.api.nvim_buf_get_option(code_buf, "filetype")
vim.api.nvim_buf_set_option(state.preview_buf, "syntax", ft)
vim.api.nvim_buf_set_option(state.preview_buf, "bufhidden", "delete")
vim.api.nvim_win_set_option(state.preview_win, "cursorline", true)
update_preview(code_buf)
end
local function get_hover_params(node, winnr)
local bufnr = vim.api.nvim_win_get_buf(winnr)
local uri = vim.uri_from_bufnr(bufnr)
return {
textDocument = {uri = uri},
position = {line = node.line, character = node.character},
bufnr = bufnr
}
end
local function update_hover()
if not has_code_win() then return end
local node = get_hovered_node()
if not node then return end
local params = get_hover_params(node, main.state.code_win)
vim.lsp.buf_request(params.bufnr, "textDocument/hover", params,
function(err, _, result)
if err then print(vim.inspect(err)) end
local markdown_lines = {}
if result ~= nil then
markdown_lines = vim.lsp.util.convert_input_to_markdown_lines(
result.contents)
end
markdown_lines = vim.lsp.util.trim_empty_lines(markdown_lines)
if vim.tbl_isempty(markdown_lines) then
markdown_lines = {"No info available!"}
end
local stripped = {}
local highlights = {}
do
local i = 1
while i <= #markdown_lines do
local line = markdown_lines[i]
-- TODO(ashkan): use a more strict regex for filetype?
local ft = line:match("^```([a-zA-Z0-9_]*)$")
-- local ft = line:match("^```(.*)$")
-- TODO(ashkan): validate the filetype here.
if ft then
local start = #stripped
i = i + 1
while i <= #markdown_lines do
line = markdown_lines[i]
if line == "```" then
i = i + 1
break
end
table.insert(stripped, line)
i = i + 1
end
table.insert(highlights, {
ft = ft,
start = start + 1,
finish = #stripped + 1 - 1
})
else
table.insert(stripped, line)
i = i + 1
end
end
end
if state.hover_buf ~= nil then
vim.api.nvim_buf_set_lines(state.hover_buf, 0, -1, 0, stripped)
end
end)
end
local function setup_hover_buf()
if not has_code_win() then return end
local code_buf = vim.api.nvim_win_get_buf(main.state.code_win)
local ft = vim.api.nvim_buf_get_option(code_buf, "filetype")
vim.api.nvim_buf_set_option(state.hover_buf, "syntax", ft)
vim.api.nvim_buf_set_option(state.hover_buf, "bufhidden", "delete")
vim.api.nvim_win_set_option(state.hover_win, "wrap", true)
update_hover()
end
function M.close_if_not_in_outline()
if not is_current_win_outline() and has_code_win() then
if state.preview_win ~= nil and
vim.api.nvim_win_is_valid(state.preview_win) then
vim.api.nvim_win_close(state.preview_win, true)
end
if state.hover_win ~= nil and vim.api.nvim_win_is_valid(state.hover_win) then
vim.api.nvim_win_close(state.hover_win, true)
end
end
end
local function show_preview()
if state.preview_win == nil and state.preview_buf == nil then
state.preview_buf = vim.api.nvim_create_buf(false, true)
vim.api.nvim_buf_attach(state.preview_buf, false, {
on_detach = function()
state.preview_buf = nil
state.preview_win = nil
end
})
local offsets = get_offset()
state.preview_win = vim.api.nvim_open_win(state.preview_buf, false, {
relative = 'win',
width = 50,
height = get_height(),
bufpos = {0, 0},
row = offsets[1],
col = offsets[2],
border = 'single'
})
setup_preview_buf()
else
update_preview()
end
end
local function show_hover()
if state.hover_win == nil and state.hover_buf == nil then
state.hover_buf = vim.api.nvim_create_buf(false, true)
vim.api.nvim_buf_attach(state.hover_buf, false, {
on_detach = function()
state.hover_buf = nil
state.hover_win = nil
end
})
local offsets = get_offset()
local height = get_height()
state.hover_win = vim.api.nvim_open_win(state.hover_buf, false, {
relative = 'win',
width = 50,
height = height,
bufpos = {0, 0},
row = offsets[1] + height + 2,
col = offsets[2],
border = 'single'
})
setup_hover_buf()
else
update_hover()
end
end
function M.show()
if not is_current_win_outline() or #vim.api.nvim_list_wins() < 2 then
return
end
show_preview()
show_hover()
end
return M