1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
|
local api = vim.api
local fn = vim.fn
local lazy = require("toggleterm.lazy")
---@module "toggleterm.utils"
local utils = lazy.require("toggleterm.utils")
---@module "toggleterm.constants"
local constants = require("toggleterm.constants")
---@module "toggleterm.config"
local config = lazy.require("toggleterm.config")
---@module "toggleterm.ui"
local ui = lazy.require("toggleterm.ui")
---@module "toggleterm.commandline"
local commandline = lazy.require("toggleterm.commandline")
local terms = require("toggleterm.terminal")
local AUGROUP = "ToggleTermCommands"
-----------------------------------------------------------
-- Export
-----------------------------------------------------------
local M = {}
--- only shade explicitly specified filetypes
local function apply_colors()
local ft = vim.bo.filetype
ft = (not ft or ft == "") and "none" or ft
local allow_list = config.shade_filetypes or {}
local is_enabled_ft = vim.tbl_contains(allow_list, ft)
if vim.bo.buftype == "terminal" and is_enabled_ft then
local _, term = terms.identify()
ui.hl_term(term)
end
end
local function setup_global_mappings()
local mapping = config.open_mapping
-- v:count defaults the count to 0 but if a count is passed in uses that instead
if mapping then
utils.key_map("n", mapping, '<Cmd>execute v:count . "ToggleTerm"<CR>', {
desc = "Toggle Terminal",
silent = true,
})
if config.insert_mappings then
utils.key_map("i", mapping, "<Esc><Cmd>ToggleTerm<CR>", {
desc = "Toggle Terminal",
silent = true,
})
end
end
end
-- Creates a new terminal if none are present or closes terminals that are
-- currently opened, or opens terminals that were previously closed.
---@param size number?
---@param dir string?
---@param direction string?
---@param name string?
local function smart_toggle(size, dir, direction, name)
local has_open, windows = ui.find_open_windows()
if not has_open then
if not ui.open_terminal_view(size, direction) then
local term_id = terms.get_toggled_id()
terms.get_or_create_term(term_id, dir, direction, name):open(size, direction)
end
else
ui.close_and_save_terminal_view(windows)
end
end
--- @param num number
--- @param size number?
--- @param dir string?
--- @param direction string?
--- @param name string?
local function toggle_nth_term(num, size, dir, direction, name)
local term = terms.get_or_create_term(num, dir, direction, name)
ui.update_origin_window(term.window)
term:toggle(size, direction)
-- Save the terminal in view if it was last closed terminal.
if not ui.find_open_windows() then ui.save_terminal_view({ term.id }, term.id) end
end
---Close the last window if only a terminal *split* is open
---@param term Terminal
---@return boolean
local function close_last_window(term)
local only_one_window = fn.winnr("$") == 1
if only_one_window and vim.bo[term.bufnr].filetype == constants.FILETYPE then
if term:is_split() then
local has_next = pcall(vim.cmd, "keepalt bnext")
return has_next
end
end
return false
end
local function handle_term_enter()
local _, term = terms.identify()
if term then
--- FIXME: we have to reset the filetype here because it is reset by other plugins
--- i.e. telescope.nvim
if vim.bo[term.bufnr] ~= constants.FILETYPE then term:__set_ft_options() end
local closed = close_last_window(term)
if closed then return end
if config.persist_mode then
term:__restore_mode()
elseif config.start_in_insert then
term:set_mode(terms.mode.INSERT)
end
end
end
local function handle_term_leave()
local _, term = terms.identify()
if not term then return end
if config.persist_mode then term:persist_mode() end
if term:is_float() then term:close() end
end
local function on_term_open()
local id, term = terms.identify()
if not term then
local buf = api.nvim_get_current_buf()
terms.Terminal
:new({
id = id,
bufnr = buf,
window = api.nvim_get_current_win(),
highlights = config.highlights,
job_id = vim.b[buf].terminal_job_id,
direction = ui.guess_direction(),
})
:__resurrect()
end
ui.set_winbar(term)
end
function M.exec_command(args, count)
vim.validate({ args = { args, "string" } })
if not args:match("cmd") then
return utils.notify(
"TermExec requires a cmd specified using the syntax cmd='ls -l' e.g. TermExec cmd='ls -l'",
"error"
)
end
local parsed = require("toggleterm.commandline").parse(args)
vim.validate({
cmd = { parsed.cmd, "string" },
size = { parsed.size, "number", true },
dir = { parsed.dir, "string", true },
direction = { parsed.direction, "string", true },
name = { parsed.name, "string", true },
go_back = { parsed.go_back, "boolean", true },
open = { parsed.open, "boolean", true },
})
M.exec(
parsed.cmd,
count,
parsed.size,
parsed.dir,
parsed.direction,
parsed.name,
parsed.go_back,
parsed.open
)
end
--- @param cmd string
--- @param num number?
--- @param size number?
--- @param dir string?
--- @param direction string?
--- @param name string?
--- @param go_back boolean? whether or not to return to original window
--- @param open boolean? whether or not to open terminal window
function M.exec(cmd, num, size, dir, direction, name, go_back, open)
vim.validate({
cmd = { cmd, "string" },
num = { num, "number", true },
size = { size, "number", true },
dir = { dir, "string", true },
direction = { direction, "string", true },
name = { name, "string", true },
go_back = { go_back, "boolean", true },
open = { open, "boolean", true },
})
num = (num and num >= 1) and num or terms.get_toggled_id()
open = open == nil or open
local term = terms.get_or_create_term(num, dir, direction, name)
if not term:is_open() then term:open(size, direction) end
-- going back from floating window closes it
if term:is_float() then go_back = false end
if go_back == nil then go_back = true end
if not open then
term:close()
go_back = false
end
term:send(cmd, go_back)
end
--- @param selection_type string
--- @param trim_spaces boolean
--- @param cmd_data table<string, any>
function M.send_lines_to_terminal(selection_type, trim_spaces, cmd_data)
local id = tonumber(cmd_data.args) or 1
trim_spaces = trim_spaces == nil or trim_spaces
vim.validate({
selection_type = { selection_type, "string", true },
trim_spaces = { trim_spaces, "boolean", true },
terminal_id = { id, "number", true },
})
local current_window = api.nvim_get_current_win() -- save current window
local lines = {}
-- Beginning of the selection: line number, column number
local start_line, start_col
if selection_type == "single_line" then
start_line, start_col = unpack(api.nvim_win_get_cursor(0))
-- nvim_win_get_cursor uses 0-based indexing for columns, while we use 1-based indexing
start_col = start_col + 1
table.insert(lines, fn.getline(start_line))
else
local res = nil
if string.match(selection_type, "visual") then
-- This calls vim.fn.getpos, which uses 1-based indexing for columns
res = utils.get_line_selection("visual")
else
-- This calls vim.fn.getpos, which uses 1-based indexing for columns
res = utils.get_line_selection("motion")
end
start_line, start_col = unpack(res.start_pos)
-- char, line and block are used for motion/operatorfunc. 'block' is ignored
if selection_type == "visual_lines" or selection_type == "line" then
lines = res.selected_lines
elseif selection_type == "visual_selection" or selection_type == "char" then
lines = utils.get_visual_selection(res, true)
end
end
if not lines or not next(lines) then return end
if not trim_spaces then
M.exec(table.concat(lines, "\n"), id)
else
for _, line in ipairs(lines) do
local l = trim_spaces and line:gsub("^%s+", ""):gsub("%s+$", "") or line
M.exec(l, id)
end
end
-- Jump back with the cursor where we were at the beginning of the selection
api.nvim_set_current_win(current_window)
-- nvim_win_set_cursor() uses 0-based indexing for columns, while we use 1-based indexing
api.nvim_win_set_cursor(current_window, { start_line, start_col - 1 })
end
function M.toggle_command(args, count)
local parsed = commandline.parse(args)
vim.validate({
size = { parsed.size, "number", true },
dir = { parsed.dir, "string", true },
direction = { parsed.direction, "string", true },
name = { parsed.name, "string", true },
})
if parsed.size then parsed.size = tonumber(parsed.size) end
M.toggle(count, parsed.size, parsed.dir, parsed.direction, parsed.name)
end
function _G.___toggleterm_winbar_click(id)
if id then
local term = terms.get_or_create_term(id)
if not term then return end
term:toggle()
end
end
--- If a count is provided we operate on the specific terminal buffer
--- i.e. 2ToggleTerm => open or close Term 2
--- if the count is 1 we use a heuristic which is as follows
--- if there is no open terminal window we toggle the first one i.e. assumed
--- to be the primary. However if several are open we close them.
--- this can be used with the count commands to allow specific operations
--- per term or mass actions
--- @param count number?
--- @param size number?
--- @param dir string?
--- @param direction string?
--- @param name string?
function M.toggle(count, size, dir, direction, name)
if count and count >= 1 then
toggle_nth_term(count, size, dir, direction, name)
else
smart_toggle(size, dir, direction, name)
end
end
-- Toggle all terminals
-- If any terminal is open it will be closed
-- If no terminal exists it will do nothing
-- If any terminal exists but is not open it will be open
function M.toggle_all(force)
local terminals = terms.get_all()
if force and ui.find_open_windows() then
for _, term in pairs(terminals) do
term:close()
end
else
if not ui.find_open_windows() then
for _, term in pairs(terminals) do
term:open()
end
else
for _, term in pairs(terminals) do
term:close()
end
end
end
end
---@param _ ToggleTermConfig
local function setup_autocommands(_)
api.nvim_create_augroup(AUGROUP, { clear = true })
local toggleterm_pattern = { "term://*#toggleterm#*", "term://*::toggleterm::*" }
api.nvim_create_autocmd("BufEnter", {
pattern = toggleterm_pattern,
group = AUGROUP,
nested = true, -- this is necessary in case the buffer is the last
callback = handle_term_enter,
})
api.nvim_create_autocmd("WinLeave", {
pattern = toggleterm_pattern,
group = AUGROUP,
callback = handle_term_leave,
})
api.nvim_create_autocmd("TermOpen", {
pattern = toggleterm_pattern,
group = AUGROUP,
callback = on_term_open,
})
api.nvim_create_autocmd("ColorScheme", {
group = AUGROUP,
callback = function()
config.reset_highlights()
for _, term in pairs(terms.get_all()) do
if term.window and api.nvim_win_is_valid(term.window) then
api.nvim_win_call(term.window, function() ui.hl_term(term) end)
end
end
end,
})
api.nvim_create_autocmd("TermOpen", {
group = AUGROUP,
pattern = "term://*",
callback = apply_colors,
})
end
---------------------------------------------------------------------------------
-- Commands
---------------------------------------------------------------------------------
---@param callback fun(t: Terminal?)
local function get_subject_terminal(callback)
local items = terms.get_all(true)
if #items == 0 then return utils.notify("No toggleterms are open yet") end
vim.ui.select(items, {
prompt = "Please select a terminal to name: ",
format_item = function(term) return term.id .. ": " .. term:_display_name() end,
}, function(term)
if not term then return end
callback(term)
end)
end
---@param name string
---@param term Terminal
local function set_term_name(name, term) term.display_name = name end
local function request_term_name(term)
vim.ui.input({ prompt = "Please set a name for the terminal" }, function(name)
if name and #name > 0 then set_term_name(name, term) end
end)
end
local function select_terminal(opts)
local terminals = terms.get_all(opts.bang)
if #terminals == 0 then return utils.notify("No toggleterms are open yet", "info") end
vim.ui.select(terminals, {
prompt = "Please select a terminal to open (or focus): ",
format_item = function(term) return term.id .. ": " .. term:_display_name() end,
}, function(_, idx)
local term = terminals[idx]
if not term then return end
if term:is_open() then
term:focus()
else
term:open()
end
end)
end
local function setup_commands()
local command = api.nvim_create_user_command
command("TermSelect", select_terminal, { bang = true })
-- Count is 0 by default
command(
"TermExec",
function(opts) M.exec_command(opts.args, opts.count) end,
{ count = true, complete = commandline.term_exec_complete, nargs = "*" }
)
command(
"ToggleTerm",
function(opts) M.toggle_command(opts.args, opts.count) end,
{ count = true, complete = commandline.toggle_term_complete, nargs = "*" }
)
command("ToggleTermToggleAll", function(opts) M.toggle_all(opts.bang) end, { bang = true })
command(
"ToggleTermSendVisualLines",
function(args) M.send_lines_to_terminal("visual_lines", true, args) end,
{ range = true, nargs = "?" }
)
command(
"ToggleTermSendVisualSelection",
function(args) M.send_lines_to_terminal("visual_selection", true, args) end,
{ range = true, nargs = "?" }
)
command(
"ToggleTermSendCurrentLine",
function(args) M.send_lines_to_terminal("single_line", true, args) end,
{ nargs = "?" }
)
command("ToggleTermSetName", function(opts)
local no_count = not opts.count or opts.count < 1
local no_name = opts.args == ""
if no_count and no_name then
get_subject_terminal(request_term_name)
elseif no_name then
local term = terms.get(opts.count)
if not term then return end
request_term_name(term)
elseif no_count then
get_subject_terminal(function(t) set_term_name(opts.args, t) end)
else
local term = terms.get(opts.count)
if not term then return end
set_term_name(opts.args, term)
end
end, { nargs = "?", count = true })
end
function M.setup(user_prefs)
local conf = config.set(user_prefs)
setup_global_mappings()
setup_autocommands(conf)
setup_commands()
end
return M
|