local context_manager = require('plenary.context_manager') local config = require('telescope.config') local debounce = require('telescope.debounce') local from_entry = require('telescope.from_entry') local log = require('telescope.log') local utils = require('telescope.utils') local flatten = vim.tbl_flatten local buf_delete = utils.buf_delete local job_is_running = utils.job_is_running local defaulter = utils.make_default_callable local previewers = {} local Previewer = {} Previewer.__index = Previewer -- TODO: Should play with these some more, ty @clason local bat_options = {"--style=plain", "--color=always", "--paging=always"} local has_less = (vim.fn.executable('less') == 1) and config.values.use_less local termopen_env = vim.tbl_extend("force", { ['GIT_PAGER'] = (has_less and 'less' or '') }, config.values.set_env) -- TODO(conni2461): Workaround for neovim/neovim#11751. Add only quotes when using else branch. local valuate_shell = function() local shell = vim.o.shell if string.find(shell, 'powershell.exe') or string.find(shell, 'cmd.exe') then return '' else return "'" end end local add_quotes = valuate_shell() local get_file_stat = function(filename) return vim.loop.fs_stat(vim.fn.expand(filename)) or {} end local bat_maker = function(filename, lnum, start, finish) if get_file_stat(filename).type == 'directory' then return { 'ls', '-la', vim.fn.expand(filename) } end local command = {"bat"} local theme = os.getenv("BAT_THEME") if lnum then table.insert(command, { "--highlight-line", lnum}) end if has_less then if start then table.insert(command, {"--pager", string.format("%sless -RS +%s%s", add_quotes, start, add_quotes)}) else table.insert(command, {"--pager", string.format("%sless -RS%s", add_quotes, add_quotes)}) end else if start and finish then table.insert(command, { "-r", string.format("%s:%s", start, finish) }) end end if theme ~= nil then table.insert(command, { "--theme", string.format("%s", theme) }) end return flatten { command, bat_options, "--", add_quotes .. vim.fn.expand(filename) .. add_quotes } end -- TODO: Add other options for cat to do this better local cat_maker = function(filename, _, start, _) if get_file_stat(filename).type == 'directory' then return { 'ls', '-la', add_quotes .. vim.fn.expand(filename) .. add_quotes } end if 1 == vim.fn.executable('file') then local output = utils.get_os_command_output('file --mime-type -b ' .. filename) local mime_type = vim.split(output, '/')[1] if mime_type ~= "text" then return { "echo", "Binary file found. These files cannot be displayed!" } end end if has_less then if start then return { 'less', '-RS', string.format('+%s', start), add_quotes .. vim.fn.expand(filename) .. add_quotes } else return { 'less', '-RS', add_quotes .. vim.fn.expand(filename) .. add_quotes } end else return { "cat", "--", add_quotes .. vim.fn.expand(filename) .. add_quotes } end end local get_maker = function(opts) local maker = opts.maker if not maker and 1 == vim.fn.executable("bat") then maker = bat_maker elseif not maker and 1 == vim.fn.executable("cat") then maker = cat_maker end if not maker then error("Needs maker") end return maker end local previewer_ns = vim.api.nvim_create_namespace('telescope.previewers') local with_preview_window = function(status, bufnr, callable) if bufnr and vim.api.nvim_buf_call and false then vim.api.nvim_buf_call(bufnr, callable) else return context_manager.with(function() vim.cmd(string.format("noautocmd call nvim_set_current_win(%s)", status.preview_win)) coroutine.yield() vim.cmd(string.format("noautocmd call nvim_set_current_win(%s)", status.prompt_win)) end, callable) end end -- --terminal-width=%s -- TODO: We shoudl make sure that all our terminals close all the way. -- Otherwise it could be bad if they're just sitting around, waiting to be closed. -- I don't think that's the problem, but it could be? function Previewer:new(opts) opts = opts or {} return setmetatable({ state = nil, _setup_func = opts.setup, _teardown_func = opts.teardown, _send_input = opts.send_input, _scroll_fn = opts.scroll_fn, preview_fn = opts.preview_fn, }, Previewer) end function Previewer:preview(entry, status) if not entry then return end if not self.state then if self._setup_func then self.state = self:_setup_func() else self.state = {} end end return self:preview_fn(entry, status) end function Previewer:teardown() if self._teardown_func then self:_teardown_func() end end function Previewer:send_input(input) if self._send_input then self:_send_input(input) else vim.api.nvim_err_writeln("send_input is not defined for this previewer") end end function Previewer:scroll_fn(direction) if self._scroll_fn then self:_scroll_fn(direction) else vim.api.nvim_err_writeln("scroll_fn is not defined for this previewer") end end previewers.new = function(...) return Previewer:new(...) end previewers.new_buffer_previewer = function(opts) opts = opts or {} assert(opts.preview_fn, "preview_fn is required function") if not opts.scroll_fn then function opts.scroll_fn(self, direction) local input = direction > 0 and "d" or "u" local count = math.abs(direction) self:send_input({ count = count, input = input }) end end if not opts.send_input then function opts.send_input(self, input) if not self.state then return end local bufnr = vim.api.nvim_win_get_buf(self.state.hl_win) local max_line = vim.fn.getbufinfo(bufnr)[1].linecount local line = vim.api.nvim_win_get_cursor(self.state.hl_win)[1] if input.input == 'u' then line = (line - input.count) > 0 and (line - input.count) or 1 else line = (line + input.count) <= max_line and (line + input.count) or max_line end vim.api.nvim_win_set_cursor(self.state.hl_win, { line, 1 }) end end return Previewer:new(opts) end previewers.new_termopen_previewer = function(opts) opts = opts or {} assert(opts.get_command, "get_command is a required function") assert(not opts.preview_fn, "preview_fn not allowed") local opt_setup = opts.setup local opt_teardown = opts.teardown local old_bufs = {} local function get_term_id(self) if not self.state then return nil end return self.state.termopen_id end local function get_bufnr(self) if not self.state then return nil end return self.state.termopen_bufnr end local function set_term_id(self, value) if job_is_running(get_term_id(self)) then vim.fn.jobstop(get_term_id(self)) end if self.state then self.state.termopen_id = value end end local function set_bufnr(self, value) if get_bufnr(self) then table.insert(old_bufs, get_bufnr(self)) end if self.state then self.state.termopen_bufnr = value end end function opts.setup(self) local state = {} if opt_setup then vim.tbl_deep_extend("force", state, opt_setup(self)) end return state end function opts.teardown(self) if opt_teardown then opt_teardown(self) end local term_id = get_term_id(self) if term_id and utils.job_is_running(term_id) then vim.fn.jobclose(term_id) end set_term_id(self, nil) set_bufnr(self, nil) for _, bufnr in ipairs(old_bufs) do buf_delete(bufnr) end end function opts.preview_fn(self, entry, status) if get_bufnr(self) == nil then set_bufnr(self, vim.api.nvim_win_get_buf(status.preview_win)) end set_bufnr(self, vim.api.nvim_create_buf(false, true)) local bufnr = get_bufnr(self) vim.api.nvim_win_set_buf(status.preview_win, bufnr) local term_opts = { cwd = opts.cwd or vim.fn.getcwd(), env = termopen_env } -- TODO(conni2461): Workaround for neovim/neovim#11751. local get_cmd = function(status) local shell = vim.o.shell if string.find(shell, 'powershell.exe') or string.find(shell, 'cmd.exe') then return opts.get_command(entry, status) else local env = {} for k, v in pairs(termopen_env) do table.insert(env, k .. '=' .. v) end return table.concat(env, ' ') .. ' ' .. table.concat(opts.get_command(entry, status), ' ') end end with_preview_window(status, bufnr, function() set_term_id(self, vim.fn.termopen(get_cmd(status), term_opts)) end) vim.api.nvim_buf_set_name(bufnr, tostring(bufnr)) end if not opts.send_input then function opts.send_input(self, input) local termcode = vim.api.nvim_replace_termcodes(input, true, false, true) local term_id = get_term_id(self) if term_id then vim.fn.chansend(term_id, termcode) end end end if not opts.scroll_fn then function opts.scroll_fn(self, direction) if not self.state then return end local input = direction > 0 and "d" or "u" local count = math.abs(direction) self:send_input(count..input) end end return Previewer:new(opts) end previewers.vim_buffer = defaulter(function(_) return previewers.new_buffer_previewer { setup = function() return { last_set_bufnr = nil } end, teardown = function(self) if self.state and self.state.last_set_bufnr then vim.api.nvim_buf_clear_namespace(self.state.last_set_bufnr, previewer_ns, 0, -1) end end, preview_fn = function(self, entry, status) local bufnr = tonumber(entry.bufnr) if not vim.api.nvim_buf_is_loaded(bufnr) then vim.fn.bufload(bufnr) end self.state.last_set_bufnr = bufnr vim.api.nvim_win_set_buf(status.preview_win, bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') vim.api.nvim_win_set_option(status.preview_win, 'signcolumn', 'no') vim.api.nvim_win_set_option(status.preview_win, 'foldlevel', 100) if entry.lnum then vim.api.nvim_buf_add_highlight(bufnr, previewer_ns, "Visual", entry.lnum - 1, 0, -1) vim.api.nvim_win_set_option(status.preview_win, 'scrolloff', 999) vim.api.nvim_win_set_cursor(status.preview_win, {entry.lnum, 0}) -- print("LNUM:", entry.lnum) end self.state.hl_win = status.preview_win end, } end, {}) previewers.git_commit_diff = defaulter(function(_) return previewers.new_termopen_previewer { get_command = function(entry) local sha = entry.value return { 'git', '-p', 'diff', sha .. '^!' } end } end, {}) previewers.git_branch_log = defaulter(function(_) return previewers.new_termopen_previewer { get_command = function(entry) return { 'git', '-p', 'log', '--graph', "--pretty=format:" .. add_quotes .. "%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr)%Creset" .. add_quotes, '--abbrev-commit', '--date=relative', entry.value } end } end, {}) previewers.git_file_diff = defaulter(function(_) return previewers.new_termopen_previewer { get_command = function(entry) return { 'git', '-p', 'diff', entry.value } end } end, {}) previewers.cat = defaulter(function(opts) local maker = get_maker(opts) return previewers.new_termopen_previewer { get_command = function(entry) local path = from_entry.path(entry, true) if path == nil then return end return maker(path) end } end, {}) previewers.vimgrep = defaulter(function(opts) local maker = get_maker(opts) return previewers.new_termopen_previewer { get_command = function(entry, status) local win_id = status.preview_win local height = vim.api.nvim_win_get_height(win_id) local filename = entry.filename local lnum = entry.lnum or 0 local context = math.floor(height / 2) local start = math.max(0, lnum - context) local finish = lnum + context return maker(filename, lnum, start, finish) end, } end, {}) previewers.ctags = defaulter(function(_) return previewers.new_buffer_previewer { setup = function() return {} end, teardown = function(self) if self.state and self.state.hl_id then pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) self.state.hl_id = nil end end, preview_fn = function(self, entry, status) with_preview_window(status, nil, function() local scode = string.gsub(entry.scode, '[$]$', '') scode = string.gsub(scode, [[\\]], [[\]]) scode = string.gsub(scode, [[\/]], [[/]]) scode = string.gsub(scode, '[*]', [[\*]]) local new_bufnr = vim.fn.bufnr(entry.filename, true) vim.fn.bufload(new_bufnr) vim.api.nvim_win_set_buf(status.preview_win, new_bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') vim.api.nvim_win_set_option(status.preview_win, 'signcolumn', 'no') vim.api.nvim_win_set_option(status.preview_win, 'foldlevel', 100) vim.api.nvim_win_set_option(status.preview_win, 'scrolloff', 999) pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) vim.cmd "norm! gg" vim.fn.search(scode) self.state.hl_win = status.preview_win self.state.hl_id = vim.fn.matchadd('Search', scode) end) end } end, {}) previewers.builtin = defaulter(function(_) return previewers.new_buffer_previewer { setup = function() return {} end, teardown = function(self) if self.state and self.state.hl_id then pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) self.state.hl_id = nil end end, preview_fn = function(self, entry, status) with_preview_window(status, nil, function() local module_name = vim.fn.fnamemodify(entry.filename, ':t:r') local text if entry.text:sub(1, #module_name) ~= module_name then text = module_name .. '.' .. entry.text else text = entry.text:gsub('_', '.', 1) end local new_bufnr = vim.fn.bufnr(entry.filename, true) vim.fn.bufload(new_bufnr) vim.api.nvim_win_set_buf(status.preview_win, new_bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') vim.api.nvim_win_set_option(status.preview_win, 'signcolumn', 'no') vim.api.nvim_win_set_option(status.preview_win, 'foldlevel', 100) vim.api.nvim_win_set_option(status.preview_win, 'scrolloff', 999) pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) vim.cmd "norm! gg" vim.fn.search(text) self.state.hl_win = status.preview_win self.state.hl_id = vim.fn.matchadd('Search', text) end) end } end, {}) previewers.qflist = defaulter(function(opts) opts = opts or {} local maker = get_maker(opts) return previewers.new_termopen_previewer { get_command = function(entry, status) local win_id = status.preview_win local height = vim.api.nvim_win_get_height(win_id) local filename = entry.filename local lnum = entry.lnum local start, finish if entry.start and entry.finish then start = entry.start finish = entry.finish else local context = math.floor(height / 2) start = math.max(0, lnum - context) finish = lnum + context end return maker(filename, lnum, start, finish) end } end, {}) previewers.help = defaulter(function(_) return previewers.new_buffer_previewer { setup = function() return {} end, teardown = function(self) if self.state and self.state.hl_id then pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) self.state.hl_id = nil end end, preview_fn = function(self, entry, status) with_preview_window(status, nil, function() local special_chars = ":~^.?/%[%]%*" local delim = string.char(9) local escaped = vim.fn.escape(entry.value, special_chars) local tags = {} local find_rtp_file = function(path, count) return vim.fn.findfile(path, vim.o.runtimepath, count) end local matches = {} for _,file in pairs(find_rtp_file('doc/tags', -1)) do local f = assert(io.open(file, "rb")) for line in f:lines() do matches = {} for match in (line..delim):gmatch("(.-)" .. delim) do table.insert(matches, match) end table.insert(tags, { name = matches[1], filename = matches[2], cmd = matches[3] }) end f:close() end local search_tags = function(pattern) local results = {} for _, tag in pairs(tags) do if vim.fn.match(tag.name, pattern) ~= -1 then table.insert(results, tag) end end return results end local taglist = search_tags('^' .. escaped .. '$') if taglist == {} then taglist = search_tags(escaped) end local best_entry = taglist[1] local new_bufnr = vim.fn.bufnr(find_rtp_file('doc/' .. best_entry.filename), true) vim.api.nvim_buf_set_option(new_bufnr, 'filetype', 'help') vim.api.nvim_win_set_buf(status.preview_win, new_bufnr) local search_query = best_entry.cmd -- remove leading '/' search_query = search_query:sub(2) -- Set the query to "very nomagic". -- This should make it work quite nicely given tags. search_query = [[\V]] .. search_query log.trace([[lua vim.fn.search("]], search_query, [[")]]) -- Clear previous search pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) vim.cmd "norm! gg" vim.fn.search(search_query, "W") vim.api.nvim_win_set_option(status.preview_win, 'scrolloff', 999) self.state.hl_win = status.preview_win self.state.hl_id = vim.fn.matchadd('Search', search_query) end) end } end, {}) -- WIP -- TODO: This needs a big rewrite. previewers.vim_buffer_or_bat = defaulter(function(_) return previewers.new { preview_fn = function(_, entry, status) local value = entry.value if value == nil then return end local file_name = vim.split(value, ":")[1] log.trace("Previewing File: '%s'", file_name) -- vim.fn.termopen( -- string.format("bat --color=always --style=grid '%s'"), -- vim.fn.fnamemodify(file_name, ":p") local bufnr = vim.fn.bufadd(file_name) if vim.api.nvim_buf_is_loaded(bufnr) then vim.fn.bufload(bufnr) -- TODO: We should probably call something like this because we're not always getting highlight and all that stuff. -- api.nvim_command('doautocmd filetypedetect BufRead ' .. vim.fn.fnameescape(filename)) vim.api.nvim_win_set_buf(status.preview_win, bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') -- vim.api.nvim_win_set_option(preview_win, 'winblend', 20) vim.api.nvim_win_set_option(status.preview_win, 'signcolumn', 'no') vim.api.nvim_win_set_option(status.preview_win, 'foldlevel', 100) else vim.api.nvim_buf_set_lines(status.preview_bufnr, 0, -1, false, vim.fn.systemlist(string.format('bat "%s"', file_name))) end end, } end, {}) previewers.nvim_file = defaulter(function(_) return previewers.new { preview_fn = function(_, entry, status) local filename = entry.filename if filename == nil then filename = entry.path end -- if filename == nil then -- local value = entry.value -- filename = vim.split(value, ":")[1] -- end if filename == nil then log.info("Could not find file from entry", entry) return end local win_id = status.preview_win local bufnr = vim.fn.bufnr(filename) if bufnr == -1 then bufnr = vim.api.nvim_create_buf(false, true) -- vim.api.nvim_buf_set_name(bufnr, filename) vim.api.nvim_win_set_buf(win_id, bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) if false then vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, vim.fn.readfile(filename)) vim.api.nvim_buf_set_option(bufnr, 'filetype', 'lua') else vim.api.nvim_buf_call(bufnr, function() vim.cmd(":noauto view " .. filename) vim.api.nvim_command("doautocmd filetypedetect BufRead " .. vim.fn.fnameescape(filename)) end) end vim.api.nvim_command("doautocmd filetypedetect BufRead " .. vim.fn.fnameescape(filename)) -- print("FT:", vim.api.nvim_buf_get_option(bufnr, 'filetype')) else vim.api.nvim_win_set_buf(win_id, bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', false) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') end -- vim.api.nvim_buf_set_option(bufnr, 'filetype', 'lua') -- vim.cmd([[doautocmd filetypedetect BufRead ]] .. vim.fn.fnameescape(filename)) end, } end) previewers.man = defaulter(function(_) return previewers.new { preview_fn = debounce.throttle_leading(function(_, entry, status) local cmd = entry.value local st = {} st.prompt_win = status.prompt_win st.preview_win = status.preview_win with_preview_window(st, nil, function() if not vim.api.nvim_win_is_valid(st.preview_win) then return end local man_value = vim.fn['man#goto_tag'](cmd, '', '') if #man_value == 0 then print("No value for:", cmd) return end local filename = man_value[1].filename if vim.api.nvim_buf_get_name(0) == filename then return end local bufnr = vim.api.nvim_create_buf(false, true) vim.api.nvim_win_set_buf(st.preview_win, bufnr) vim.api.nvim_command('view ' .. filename) vim.api.nvim_buf_set_option(bufnr, 'buftype', 'nofile') vim.api.nvim_buf_set_option(bufnr, 'bufhidden', 'hide') vim.api.nvim_buf_set_option(bufnr, 'swapfile', false) vim.api.nvim_buf_set_option(bufnr, 'buflisted', false) end) end, 5) } end) previewers.autocommands = defaulter(function(_) return previewers.new_buffer_previewer { setup = function() return {} end, teardown = function(self) if self.state and self.state.hl_id then pcall(vim.fn.matchdelete, self.state.hl_id, self.state.hl_win) self.state.hl_id = nil end end, preview_fn = function(self, entry, status) local results = vim.tbl_filter( function (x) return x.group == entry.group end, status.picker.finder.results ) local display = {} table.insert(display, string.format(" augroup: %s - [ %d entries ]", entry.group, #results)) -- TODO: calculate banner width/string in setup() -- TODO: get column characters to be the same HL group as border table.insert(display, string.rep("─", vim.fn.getwininfo(status.preview_win)[1].width)) local selected_row for idx, item in ipairs(results) do if item == entry then selected_row = idx end table.insert(display, string.format(" %-14sā–%-08s %s", item.event, item.ft_pattern, item.command) ) end with_preview_window(status, nil, function() -- TODO: set filetype in setup() vim.api.nvim_buf_set_option(status.preview_bufnr, "filetype", "vim") vim.api.nvim_buf_set_lines(status.preview_bufnr, 0, -1, false, display) vim.api.nvim_buf_add_highlight(status.preview_bufnr, 0, "TelescopeBorder", 1, 0, -1) vim.api.nvim_buf_add_highlight(status.preview_bufnr, 0, "TelescopeSelection", selected_row + 1, 0, -1) end) end, } end, {}) previewers.display_content = defaulter(function(_) return previewers.new_buffer_previewer { preview_fn = function(self, entry, status) with_preview_window(status, nil, function() local bufnr = vim.fn.bufadd("Preview command") vim.api.nvim_win_set_buf(status.preview_win, bufnr) vim.api.nvim_win_set_option(status.preview_win, 'wrap', true) vim.api.nvim_win_set_option(status.preview_win, 'winhl', 'Normal:Normal') vim.api.nvim_win_set_option(status.preview_win, 'signcolumn', 'no') vim.api.nvim_win_set_option(status.preview_win, 'foldlevel', 100) if type(entry.preview_command) ~= 'function' then print('entry must provide a preview_command function which will put the content into the buffer') return end entry.preview_command(entry, bufnr) self.state.hl_win = status.preview_win end) end } end, {}) previewers.Previewer = Previewer return previewers