1mod persistence;
2pub mod terminal_element;
3pub mod terminal_panel;
4pub mod terminal_scrollbar;
5pub mod terminal_tab_tooltip;
6
7use editor::{actions::SelectAll, scroll::ScrollbarAutoHide, Editor, EditorSettings};
8use gpui::{
9 anchored, deferred, div, impl_actions, AnyElement, App, DismissEvent, Entity, EventEmitter,
10 FocusHandle, Focusable, KeyContext, KeyDownEvent, Keystroke, MouseButton, MouseDownEvent,
11 Pixels, Render, ScrollWheelEvent, Stateful, Styled, Subscription, Task, WeakEntity,
12};
13use itertools::Itertools;
14use persistence::TERMINAL_DB;
15use project::{search::SearchQuery, terminals::TerminalKind, Entry, Metadata, Project};
16use schemars::JsonSchema;
17use terminal::{
18 alacritty_terminal::{
19 index::Point,
20 term::{search::RegexSearch, TermMode},
21 },
22 terminal_settings::{self, CursorShape, TerminalBlink, TerminalSettings, WorkingDirectory},
23 Clear, Copy, Event, MaybeNavigationTarget, Paste, ScrollLineDown, ScrollLineUp, ScrollPageDown,
24 ScrollPageUp, ScrollToBottom, ScrollToTop, ShowCharacterPalette, TaskState, TaskStatus,
25 Terminal, TerminalBounds, ToggleViMode,
26};
27use terminal_element::{is_blank, TerminalElement};
28use terminal_panel::TerminalPanel;
29use terminal_scrollbar::TerminalScrollHandle;
30use terminal_tab_tooltip::TerminalTooltip;
31use ui::{
32 h_flex, prelude::*, ContextMenu, Icon, IconName, Label, Scrollbar, ScrollbarState, Tooltip,
33};
34use util::{debug_panic, paths::PathWithPosition, ResultExt};
35use workspace::{
36 item::{
37 BreadcrumbText, Item, ItemEvent, SerializableItem, TabContentParams, TabTooltipContent,
38 },
39 register_serializable_item,
40 searchable::{Direction, SearchEvent, SearchOptions, SearchableItem, SearchableItemHandle},
41 CloseActiveItem, NewCenterTerminal, NewTerminal, OpenVisible, ToolbarItemLocation, Workspace,
42 WorkspaceId,
43};
44
45use anyhow::Context as _;
46use serde::Deserialize;
47use settings::{Settings, SettingsStore};
48use smol::Timer;
49use zed_actions::assistant::InlineAssist;
50
51use std::{
52 cmp,
53 ops::RangeInclusive,
54 path::{Path, PathBuf},
55 rc::Rc,
56 sync::Arc,
57 time::Duration,
58};
59
60const REGEX_SPECIAL_CHARS: &[char] = &[
61 '\\', '.', '*', '+', '?', '|', '(', ')', '[', ']', '{', '}', '^', '$',
62];
63
64const CURSOR_BLINK_INTERVAL: Duration = Duration::from_millis(500);
65
66const GIT_DIFF_PATH_PREFIXES: &[&str] = &["a", "b"];
67
68/// Event to transmit the scroll from the element to the view
69#[derive(Clone, Debug, PartialEq)]
70pub struct ScrollTerminal(pub i32);
71
72#[derive(Clone, Debug, Default, Deserialize, JsonSchema, PartialEq)]
73pub struct SendText(String);
74
75#[derive(Clone, Debug, Default, Deserialize, JsonSchema, PartialEq)]
76pub struct SendKeystroke(String);
77
78impl_actions!(terminal, [SendText, SendKeystroke]);
79
80pub fn init(cx: &mut App) {
81 terminal_panel::init(cx);
82 terminal::init(cx);
83
84 register_serializable_item::<TerminalView>(cx);
85
86 cx.observe_new(|workspace: &mut Workspace, _window, _cx| {
87 workspace.register_action(TerminalView::deploy);
88 })
89 .detach();
90}
91
92pub struct BlockProperties {
93 pub height: u8,
94 pub render: Box<dyn Send + Fn(&mut BlockContext) -> AnyElement>,
95}
96
97pub struct BlockContext<'a, 'b> {
98 pub window: &'a mut Window,
99 pub context: &'b mut App,
100 pub dimensions: TerminalBounds,
101}
102
103///A terminal view, maintains the PTY's file handles and communicates with the terminal
104pub struct TerminalView {
105 terminal: Entity<Terminal>,
106 workspace: WeakEntity<Workspace>,
107 project: WeakEntity<Project>,
108 focus_handle: FocusHandle,
109 //Currently using iTerm bell, show bell emoji in tab until input is received
110 has_bell: bool,
111 context_menu: Option<(Entity<ContextMenu>, gpui::Point<Pixels>, Subscription)>,
112 cursor_shape: CursorShape,
113 blink_state: bool,
114 blinking_terminal_enabled: bool,
115 blinking_paused: bool,
116 blink_epoch: usize,
117 can_navigate_to_selected_word: bool,
118 workspace_id: Option<WorkspaceId>,
119 show_breadcrumbs: bool,
120 block_below_cursor: Option<Rc<BlockProperties>>,
121 scroll_top: Pixels,
122 scrollbar_state: ScrollbarState,
123 scroll_handle: TerminalScrollHandle,
124 show_scrollbar: bool,
125 hide_scrollbar_task: Option<Task<()>>,
126 _subscriptions: Vec<Subscription>,
127 _terminal_subscriptions: Vec<Subscription>,
128}
129
130impl EventEmitter<Event> for TerminalView {}
131impl EventEmitter<ItemEvent> for TerminalView {}
132impl EventEmitter<SearchEvent> for TerminalView {}
133
134impl Focusable for TerminalView {
135 fn focus_handle(&self, _cx: &App) -> FocusHandle {
136 self.focus_handle.clone()
137 }
138}
139
140impl TerminalView {
141 ///Create a new Terminal in the current working directory or the user's home directory
142 pub fn deploy(
143 workspace: &mut Workspace,
144 _: &NewCenterTerminal,
145 window: &mut Window,
146 cx: &mut Context<Workspace>,
147 ) {
148 let working_directory = default_working_directory(workspace, cx);
149 TerminalPanel::add_center_terminal(
150 workspace,
151 TerminalKind::Shell(working_directory),
152 window,
153 cx,
154 )
155 .detach_and_log_err(cx);
156 }
157
158 pub fn new(
159 terminal: Entity<Terminal>,
160 workspace: WeakEntity<Workspace>,
161 workspace_id: Option<WorkspaceId>,
162 project: WeakEntity<Project>,
163 window: &mut Window,
164 cx: &mut Context<Self>,
165 ) -> Self {
166 let workspace_handle = workspace.clone();
167 let terminal_subscriptions =
168 subscribe_for_terminal_events(&terminal, workspace, window, cx);
169
170 let focus_handle = cx.focus_handle();
171 let focus_in = cx.on_focus_in(&focus_handle, window, |terminal_view, window, cx| {
172 terminal_view.focus_in(window, cx);
173 });
174 let focus_out = cx.on_focus_out(
175 &focus_handle,
176 window,
177 |terminal_view, _event, window, cx| {
178 terminal_view.focus_out(window, cx);
179 },
180 );
181 let cursor_shape = TerminalSettings::get_global(cx)
182 .cursor_shape
183 .unwrap_or_default();
184
185 let scroll_handle = TerminalScrollHandle::new(terminal.read(cx));
186
187 Self {
188 terminal,
189 workspace: workspace_handle,
190 project,
191 has_bell: false,
192 focus_handle,
193 context_menu: None,
194 cursor_shape,
195 blink_state: true,
196 blinking_terminal_enabled: false,
197 blinking_paused: false,
198 blink_epoch: 0,
199 can_navigate_to_selected_word: false,
200 workspace_id,
201 show_breadcrumbs: TerminalSettings::get_global(cx).toolbar.breadcrumbs,
202 block_below_cursor: None,
203 scroll_top: Pixels::ZERO,
204 scrollbar_state: ScrollbarState::new(scroll_handle.clone()),
205 scroll_handle,
206 show_scrollbar: !Self::should_autohide_scrollbar(cx),
207 hide_scrollbar_task: None,
208 _subscriptions: vec![
209 focus_in,
210 focus_out,
211 cx.observe_global::<SettingsStore>(Self::settings_changed),
212 ],
213 _terminal_subscriptions: terminal_subscriptions,
214 }
215 }
216
217 pub fn entity(&self) -> &Entity<Terminal> {
218 &self.terminal
219 }
220
221 pub fn has_bell(&self) -> bool {
222 self.has_bell
223 }
224
225 pub fn clear_bell(&mut self, cx: &mut Context<TerminalView>) {
226 self.has_bell = false;
227 cx.emit(Event::Wakeup);
228 }
229
230 pub fn deploy_context_menu(
231 &mut self,
232 position: gpui::Point<Pixels>,
233 window: &mut Window,
234 cx: &mut Context<Self>,
235 ) {
236 let assistant_enabled = self
237 .workspace
238 .upgrade()
239 .and_then(|workspace| workspace.read(cx).panel::<TerminalPanel>(cx))
240 .map_or(false, |terminal_panel| {
241 terminal_panel.read(cx).assistant_enabled()
242 });
243 let context_menu = ContextMenu::build(window, cx, |menu, _, _| {
244 menu.context(self.focus_handle.clone())
245 .action("New Terminal", Box::new(NewTerminal))
246 .separator()
247 .action("Copy", Box::new(Copy))
248 .action("Paste", Box::new(Paste))
249 .action("Select All", Box::new(SelectAll))
250 .action("Clear", Box::new(Clear))
251 .when(assistant_enabled, |menu| {
252 menu.separator()
253 .action("Inline Assist", Box::new(InlineAssist::default()))
254 })
255 .separator()
256 .action(
257 "Close Terminal Tab",
258 Box::new(CloseActiveItem {
259 save_intent: None,
260 close_pinned: true,
261 }),
262 )
263 });
264
265 window.focus(&context_menu.focus_handle(cx));
266 let subscription = cx.subscribe_in(
267 &context_menu,
268 window,
269 |this, _, _: &DismissEvent, window, cx| {
270 if this.context_menu.as_ref().is_some_and(|context_menu| {
271 context_menu.0.focus_handle(cx).contains_focused(window, cx)
272 }) {
273 cx.focus_self(window);
274 }
275 this.context_menu.take();
276 cx.notify();
277 },
278 );
279
280 self.context_menu = Some((context_menu, position, subscription));
281 }
282
283 fn settings_changed(&mut self, cx: &mut Context<Self>) {
284 let settings = TerminalSettings::get_global(cx);
285 self.show_breadcrumbs = settings.toolbar.breadcrumbs;
286
287 let new_cursor_shape = settings.cursor_shape.unwrap_or_default();
288 let old_cursor_shape = self.cursor_shape;
289 if old_cursor_shape != new_cursor_shape {
290 self.cursor_shape = new_cursor_shape;
291 self.terminal.update(cx, |term, _| {
292 term.set_cursor_shape(self.cursor_shape);
293 });
294 }
295
296 cx.notify();
297 }
298
299 fn show_character_palette(
300 &mut self,
301 _: &ShowCharacterPalette,
302 window: &mut Window,
303 cx: &mut Context<Self>,
304 ) {
305 if self
306 .terminal
307 .read(cx)
308 .last_content
309 .mode
310 .contains(TermMode::ALT_SCREEN)
311 {
312 self.terminal.update(cx, |term, cx| {
313 term.try_keystroke(
314 &Keystroke::parse("ctrl-cmd-space").unwrap(),
315 TerminalSettings::get_global(cx).option_as_meta,
316 )
317 });
318 } else {
319 window.show_character_palette();
320 }
321 }
322
323 fn select_all(&mut self, _: &SelectAll, _: &mut Window, cx: &mut Context<Self>) {
324 self.terminal.update(cx, |term, _| term.select_all());
325 cx.notify();
326 }
327
328 fn clear(&mut self, _: &Clear, _: &mut Window, cx: &mut Context<Self>) {
329 self.scroll_top = px(0.);
330 self.terminal.update(cx, |term, _| term.clear());
331 cx.notify();
332 }
333
334 fn max_scroll_top(&self, cx: &App) -> Pixels {
335 let terminal = self.terminal.read(cx);
336
337 let Some(block) = self.block_below_cursor.as_ref() else {
338 return Pixels::ZERO;
339 };
340
341 let line_height = terminal.last_content().terminal_bounds.line_height;
342 let mut terminal_lines = terminal.total_lines();
343 let viewport_lines = terminal.viewport_lines();
344 if terminal.total_lines() == terminal.viewport_lines() {
345 let mut last_line = None;
346 for cell in terminal.last_content.cells.iter().rev() {
347 if !is_blank(cell) {
348 break;
349 }
350
351 let last_line = last_line.get_or_insert(cell.point.line);
352 if *last_line != cell.point.line {
353 terminal_lines -= 1;
354 }
355 *last_line = cell.point.line;
356 }
357 }
358
359 let max_scroll_top_in_lines =
360 (block.height as usize).saturating_sub(viewport_lines.saturating_sub(terminal_lines));
361
362 max_scroll_top_in_lines as f32 * line_height
363 }
364
365 fn scroll_wheel(&mut self, event: &ScrollWheelEvent, cx: &mut Context<Self>) {
366 let terminal_content = self.terminal.read(cx).last_content();
367
368 if self.block_below_cursor.is_some() && terminal_content.display_offset == 0 {
369 let line_height = terminal_content.terminal_bounds.line_height;
370 let y_delta = event.delta.pixel_delta(line_height).y;
371 if y_delta < Pixels::ZERO || self.scroll_top > Pixels::ZERO {
372 self.scroll_top = cmp::max(
373 Pixels::ZERO,
374 cmp::min(self.scroll_top - y_delta, self.max_scroll_top(cx)),
375 );
376 cx.notify();
377 return;
378 }
379 }
380
381 self.terminal.update(cx, |term, _| term.scroll_wheel(event));
382 }
383
384 fn scroll_line_up(&mut self, _: &ScrollLineUp, _: &mut Window, cx: &mut Context<Self>) {
385 let terminal_content = self.terminal.read(cx).last_content();
386 if self.block_below_cursor.is_some()
387 && terminal_content.display_offset == 0
388 && self.scroll_top > Pixels::ZERO
389 {
390 let line_height = terminal_content.terminal_bounds.line_height;
391 self.scroll_top = cmp::max(self.scroll_top - line_height, Pixels::ZERO);
392 return;
393 }
394
395 self.terminal.update(cx, |term, _| term.scroll_line_up());
396 cx.notify();
397 }
398
399 fn scroll_line_down(&mut self, _: &ScrollLineDown, _: &mut Window, cx: &mut Context<Self>) {
400 let terminal_content = self.terminal.read(cx).last_content();
401 if self.block_below_cursor.is_some() && terminal_content.display_offset == 0 {
402 let max_scroll_top = self.max_scroll_top(cx);
403 if self.scroll_top < max_scroll_top {
404 let line_height = terminal_content.terminal_bounds.line_height;
405 self.scroll_top = cmp::min(self.scroll_top + line_height, max_scroll_top);
406 }
407 return;
408 }
409
410 self.terminal.update(cx, |term, _| term.scroll_line_down());
411 cx.notify();
412 }
413
414 fn scroll_page_up(&mut self, _: &ScrollPageUp, _: &mut Window, cx: &mut Context<Self>) {
415 if self.scroll_top == Pixels::ZERO {
416 self.terminal.update(cx, |term, _| term.scroll_page_up());
417 } else {
418 let line_height = self
419 .terminal
420 .read(cx)
421 .last_content
422 .terminal_bounds
423 .line_height();
424 let visible_block_lines = (self.scroll_top / line_height) as usize;
425 let viewport_lines = self.terminal.read(cx).viewport_lines();
426 let visible_content_lines = viewport_lines - visible_block_lines;
427
428 if visible_block_lines >= viewport_lines {
429 self.scroll_top = ((visible_block_lines - viewport_lines) as f32) * line_height;
430 } else {
431 self.scroll_top = px(0.);
432 self.terminal
433 .update(cx, |term, _| term.scroll_up_by(visible_content_lines));
434 }
435 }
436 cx.notify();
437 }
438
439 fn scroll_page_down(&mut self, _: &ScrollPageDown, _: &mut Window, cx: &mut Context<Self>) {
440 self.terminal.update(cx, |term, _| term.scroll_page_down());
441 let terminal = self.terminal.read(cx);
442 if terminal.last_content().display_offset < terminal.viewport_lines() {
443 self.scroll_top = self.max_scroll_top(cx);
444 }
445 cx.notify();
446 }
447
448 fn scroll_to_top(&mut self, _: &ScrollToTop, _: &mut Window, cx: &mut Context<Self>) {
449 self.terminal.update(cx, |term, _| term.scroll_to_top());
450 cx.notify();
451 }
452
453 fn scroll_to_bottom(&mut self, _: &ScrollToBottom, _: &mut Window, cx: &mut Context<Self>) {
454 self.terminal.update(cx, |term, _| term.scroll_to_bottom());
455 if self.block_below_cursor.is_some() {
456 self.scroll_top = self.max_scroll_top(cx);
457 }
458 cx.notify();
459 }
460
461 fn toggle_vi_mode(&mut self, _: &ToggleViMode, _: &mut Window, cx: &mut Context<Self>) {
462 self.terminal.update(cx, |term, _| term.toggle_vi_mode());
463 cx.notify();
464 }
465
466 pub fn should_show_cursor(&self, focused: bool, cx: &mut Context<Self>) -> bool {
467 //Don't blink the cursor when not focused, blinking is disabled, or paused
468 if !focused
469 || self.blinking_paused
470 || self
471 .terminal
472 .read(cx)
473 .last_content
474 .mode
475 .contains(TermMode::ALT_SCREEN)
476 {
477 return true;
478 }
479
480 match TerminalSettings::get_global(cx).blinking {
481 //If the user requested to never blink, don't blink it.
482 TerminalBlink::Off => true,
483 //If the terminal is controlling it, check terminal mode
484 TerminalBlink::TerminalControlled => {
485 !self.blinking_terminal_enabled || self.blink_state
486 }
487 TerminalBlink::On => self.blink_state,
488 }
489 }
490
491 fn blink_cursors(&mut self, epoch: usize, window: &mut Window, cx: &mut Context<Self>) {
492 if epoch == self.blink_epoch && !self.blinking_paused {
493 self.blink_state = !self.blink_state;
494 cx.notify();
495
496 let epoch = self.next_blink_epoch();
497 cx.spawn_in(window, |this, mut cx| async move {
498 Timer::after(CURSOR_BLINK_INTERVAL).await;
499 this.update_in(&mut cx, |this, window, cx| {
500 this.blink_cursors(epoch, window, cx)
501 })
502 .ok();
503 })
504 .detach();
505 }
506 }
507
508 pub fn pause_cursor_blinking(&mut self, window: &mut Window, cx: &mut Context<Self>) {
509 self.blink_state = true;
510 cx.notify();
511
512 let epoch = self.next_blink_epoch();
513 cx.spawn_in(window, |this, mut cx| async move {
514 Timer::after(CURSOR_BLINK_INTERVAL).await;
515 this.update_in(&mut cx, |this, window, cx| {
516 this.resume_cursor_blinking(epoch, window, cx)
517 })
518 .ok();
519 })
520 .detach();
521 }
522
523 pub fn terminal(&self) -> &Entity<Terminal> {
524 &self.terminal
525 }
526
527 pub fn set_block_below_cursor(
528 &mut self,
529 block: BlockProperties,
530 window: &mut Window,
531 cx: &mut Context<Self>,
532 ) {
533 self.block_below_cursor = Some(Rc::new(block));
534 self.scroll_to_bottom(&ScrollToBottom, window, cx);
535 cx.notify();
536 }
537
538 pub fn clear_block_below_cursor(&mut self, cx: &mut Context<Self>) {
539 self.block_below_cursor = None;
540 self.scroll_top = Pixels::ZERO;
541 cx.notify();
542 }
543
544 fn next_blink_epoch(&mut self) -> usize {
545 self.blink_epoch += 1;
546 self.blink_epoch
547 }
548
549 fn resume_cursor_blinking(
550 &mut self,
551 epoch: usize,
552 window: &mut Window,
553 cx: &mut Context<Self>,
554 ) {
555 if epoch == self.blink_epoch {
556 self.blinking_paused = false;
557 self.blink_cursors(epoch, window, cx);
558 }
559 }
560
561 ///Attempt to paste the clipboard into the terminal
562 fn copy(&mut self, _: &Copy, _: &mut Window, cx: &mut Context<Self>) {
563 self.terminal.update(cx, |term, _| term.copy());
564 cx.notify();
565 }
566
567 ///Attempt to paste the clipboard into the terminal
568 fn paste(&mut self, _: &Paste, _: &mut Window, cx: &mut Context<Self>) {
569 if let Some(clipboard_string) = cx.read_from_clipboard().and_then(|item| item.text()) {
570 self.terminal
571 .update(cx, |terminal, _cx| terminal.paste(&clipboard_string));
572 }
573 }
574
575 fn send_text(&mut self, text: &SendText, _: &mut Window, cx: &mut Context<Self>) {
576 self.clear_bell(cx);
577 self.terminal.update(cx, |term, _| {
578 term.input(text.0.to_string());
579 });
580 }
581
582 fn send_keystroke(&mut self, text: &SendKeystroke, _: &mut Window, cx: &mut Context<Self>) {
583 if let Some(keystroke) = Keystroke::parse(&text.0).log_err() {
584 self.clear_bell(cx);
585 self.terminal.update(cx, |term, cx| {
586 term.try_keystroke(&keystroke, TerminalSettings::get_global(cx).option_as_meta);
587 });
588 }
589 }
590
591 fn dispatch_context(&self, cx: &App) -> KeyContext {
592 let mut dispatch_context = KeyContext::new_with_defaults();
593 dispatch_context.add("Terminal");
594
595 let mode = self.terminal.read(cx).last_content.mode;
596 dispatch_context.set(
597 "screen",
598 if mode.contains(TermMode::ALT_SCREEN) {
599 "alt"
600 } else {
601 "normal"
602 },
603 );
604
605 if mode.contains(TermMode::APP_CURSOR) {
606 dispatch_context.add("DECCKM");
607 }
608 if mode.contains(TermMode::APP_KEYPAD) {
609 dispatch_context.add("DECPAM");
610 } else {
611 dispatch_context.add("DECPNM");
612 }
613 if mode.contains(TermMode::SHOW_CURSOR) {
614 dispatch_context.add("DECTCEM");
615 }
616 if mode.contains(TermMode::LINE_WRAP) {
617 dispatch_context.add("DECAWM");
618 }
619 if mode.contains(TermMode::ORIGIN) {
620 dispatch_context.add("DECOM");
621 }
622 if mode.contains(TermMode::INSERT) {
623 dispatch_context.add("IRM");
624 }
625 //LNM is apparently the name for this. https://vt100.net/docs/vt510-rm/LNM.html
626 if mode.contains(TermMode::LINE_FEED_NEW_LINE) {
627 dispatch_context.add("LNM");
628 }
629 if mode.contains(TermMode::FOCUS_IN_OUT) {
630 dispatch_context.add("report_focus");
631 }
632 if mode.contains(TermMode::ALTERNATE_SCROLL) {
633 dispatch_context.add("alternate_scroll");
634 }
635 if mode.contains(TermMode::BRACKETED_PASTE) {
636 dispatch_context.add("bracketed_paste");
637 }
638 if mode.intersects(TermMode::MOUSE_MODE) {
639 dispatch_context.add("any_mouse_reporting");
640 }
641 {
642 let mouse_reporting = if mode.contains(TermMode::MOUSE_REPORT_CLICK) {
643 "click"
644 } else if mode.contains(TermMode::MOUSE_DRAG) {
645 "drag"
646 } else if mode.contains(TermMode::MOUSE_MOTION) {
647 "motion"
648 } else {
649 "off"
650 };
651 dispatch_context.set("mouse_reporting", mouse_reporting);
652 }
653 {
654 let format = if mode.contains(TermMode::SGR_MOUSE) {
655 "sgr"
656 } else if mode.contains(TermMode::UTF8_MOUSE) {
657 "utf8"
658 } else {
659 "normal"
660 };
661 dispatch_context.set("mouse_format", format);
662 };
663 dispatch_context
664 }
665
666 fn set_terminal(
667 &mut self,
668 terminal: Entity<Terminal>,
669 window: &mut Window,
670 cx: &mut Context<TerminalView>,
671 ) {
672 self._terminal_subscriptions =
673 subscribe_for_terminal_events(&terminal, self.workspace.clone(), window, cx);
674 self.terminal = terminal;
675 }
676
677 // Hack: Using editor in terminal causes cyclic dependency i.e. editor -> terminal -> project -> editor.
678 fn map_show_scrollbar_from_editor_to_terminal(
679 show_scrollbar: editor::ShowScrollbar,
680 ) -> terminal_settings::ShowScrollbar {
681 match show_scrollbar {
682 editor::ShowScrollbar::Auto => terminal_settings::ShowScrollbar::Auto,
683 editor::ShowScrollbar::System => terminal_settings::ShowScrollbar::System,
684 editor::ShowScrollbar::Always => terminal_settings::ShowScrollbar::Always,
685 editor::ShowScrollbar::Never => terminal_settings::ShowScrollbar::Never,
686 }
687 }
688
689 fn should_show_scrollbar(cx: &App) -> bool {
690 let show = TerminalSettings::get_global(cx)
691 .scrollbar
692 .show
693 .unwrap_or_else(|| {
694 Self::map_show_scrollbar_from_editor_to_terminal(
695 EditorSettings::get_global(cx).scrollbar.show,
696 )
697 });
698 match show {
699 terminal_settings::ShowScrollbar::Auto => true,
700 terminal_settings::ShowScrollbar::System => true,
701 terminal_settings::ShowScrollbar::Always => true,
702 terminal_settings::ShowScrollbar::Never => false,
703 }
704 }
705
706 fn should_autohide_scrollbar(cx: &App) -> bool {
707 let show = TerminalSettings::get_global(cx)
708 .scrollbar
709 .show
710 .unwrap_or_else(|| {
711 Self::map_show_scrollbar_from_editor_to_terminal(
712 EditorSettings::get_global(cx).scrollbar.show,
713 )
714 });
715 match show {
716 terminal_settings::ShowScrollbar::Auto => true,
717 terminal_settings::ShowScrollbar::System => cx
718 .try_global::<ScrollbarAutoHide>()
719 .map_or_else(|| cx.should_auto_hide_scrollbars(), |autohide| autohide.0),
720 terminal_settings::ShowScrollbar::Always => false,
721 terminal_settings::ShowScrollbar::Never => true,
722 }
723 }
724
725 fn hide_scrollbar(&mut self, cx: &mut Context<Self>) {
726 const SCROLLBAR_SHOW_INTERVAL: Duration = Duration::from_secs(1);
727 if !Self::should_autohide_scrollbar(cx) {
728 return;
729 }
730 self.hide_scrollbar_task = Some(cx.spawn(|panel, mut cx| async move {
731 cx.background_executor()
732 .timer(SCROLLBAR_SHOW_INTERVAL)
733 .await;
734 panel
735 .update(&mut cx, |panel, cx| {
736 panel.show_scrollbar = false;
737 cx.notify();
738 })
739 .log_err();
740 }))
741 }
742
743 fn render_scrollbar(&self, cx: &mut Context<Self>) -> Option<Stateful<Div>> {
744 if !Self::should_show_scrollbar(cx)
745 || !(self.show_scrollbar || self.scrollbar_state.is_dragging())
746 {
747 return None;
748 }
749
750 if self.terminal.read(cx).total_lines() == self.terminal.read(cx).viewport_lines() {
751 return None;
752 }
753
754 self.scroll_handle.update(self.terminal.read(cx));
755
756 if let Some(new_display_offset) = self.scroll_handle.future_display_offset.take() {
757 self.terminal.update(cx, |term, _| {
758 let delta = new_display_offset as i32 - term.last_content.display_offset as i32;
759 match delta.cmp(&0) {
760 std::cmp::Ordering::Greater => term.scroll_up_by(delta as usize),
761 std::cmp::Ordering::Less => term.scroll_down_by(-delta as usize),
762 std::cmp::Ordering::Equal => {}
763 }
764 });
765 }
766
767 Some(
768 div()
769 .occlude()
770 .id("terminal-view-scroll")
771 .on_mouse_move(cx.listener(|_, _, _window, cx| {
772 cx.notify();
773 cx.stop_propagation()
774 }))
775 .on_hover(|_, _window, cx| {
776 cx.stop_propagation();
777 })
778 .on_any_mouse_down(|_, _window, cx| {
779 cx.stop_propagation();
780 })
781 .on_mouse_up(
782 MouseButton::Left,
783 cx.listener(|terminal_view, _, window, cx| {
784 if !terminal_view.scrollbar_state.is_dragging()
785 && !terminal_view.focus_handle.contains_focused(window, cx)
786 {
787 terminal_view.hide_scrollbar(cx);
788 cx.notify();
789 }
790 cx.stop_propagation();
791 }),
792 )
793 .on_scroll_wheel(cx.listener(|_, _, _window, cx| {
794 cx.notify();
795 }))
796 .h_full()
797 .absolute()
798 .right_1()
799 .top_1()
800 .bottom_0()
801 .w(px(12.))
802 .cursor_default()
803 .children(Scrollbar::vertical(self.scrollbar_state.clone())),
804 )
805 }
806
807 fn rerun_button(task: &TaskState) -> Option<IconButton> {
808 if !task.show_rerun {
809 return None;
810 }
811
812 let task_id = task.id.clone();
813 Some(
814 IconButton::new("rerun-icon", IconName::Rerun)
815 .icon_size(IconSize::Small)
816 .size(ButtonSize::Compact)
817 .icon_color(Color::Default)
818 .shape(ui::IconButtonShape::Square)
819 .tooltip(Tooltip::text("Rerun task"))
820 .on_click(move |_, window, cx| {
821 window.dispatch_action(
822 Box::new(zed_actions::Rerun {
823 task_id: Some(task_id.0.clone()),
824 allow_concurrent_runs: Some(true),
825 use_new_terminal: Some(false),
826 reevaluate_context: false,
827 }),
828 cx,
829 );
830 }),
831 )
832 }
833}
834
835fn subscribe_for_terminal_events(
836 terminal: &Entity<Terminal>,
837 workspace: WeakEntity<Workspace>,
838 window: &mut Window,
839 cx: &mut Context<TerminalView>,
840) -> Vec<Subscription> {
841 let terminal_subscription = cx.observe(terminal, |_, _, cx| cx.notify());
842 let terminal_events_subscription = cx.subscribe_in(
843 terminal,
844 window,
845 move |this, _, event, window, cx| match event {
846 Event::Wakeup => {
847 cx.notify();
848 cx.emit(Event::Wakeup);
849 cx.emit(ItemEvent::UpdateTab);
850 cx.emit(SearchEvent::MatchesInvalidated);
851 }
852
853 Event::Bell => {
854 this.has_bell = true;
855 cx.emit(Event::Wakeup);
856 }
857
858 Event::BlinkChanged(blinking) => {
859 if matches!(
860 TerminalSettings::get_global(cx).blinking,
861 TerminalBlink::TerminalControlled
862 ) {
863 this.blinking_terminal_enabled = *blinking;
864 }
865 }
866
867 Event::TitleChanged => {
868 cx.emit(ItemEvent::UpdateTab);
869 }
870
871 Event::NewNavigationTarget(maybe_navigation_target) => {
872 this.can_navigate_to_selected_word = match maybe_navigation_target {
873 Some(MaybeNavigationTarget::Url(_)) => true,
874 Some(MaybeNavigationTarget::PathLike(path_like_target)) => {
875 let valid_files_to_open_task = possible_open_target(
876 &workspace,
877 &path_like_target.terminal_dir,
878 &path_like_target.maybe_path,
879 cx,
880 );
881 smol::block_on(valid_files_to_open_task).is_some()
882 }
883 None => false,
884 };
885 cx.notify()
886 }
887
888 Event::Open(maybe_navigation_target) => match maybe_navigation_target {
889 MaybeNavigationTarget::Url(url) => cx.open_url(url),
890
891 MaybeNavigationTarget::PathLike(path_like_target) => {
892 if !this.can_navigate_to_selected_word {
893 return;
894 }
895 let task_workspace = workspace.clone();
896 let path_like_target = path_like_target.clone();
897 cx.spawn_in(window, |terminal_view, mut cx| async move {
898 let open_target = terminal_view
899 .update(&mut cx, |_, cx| {
900 possible_open_target(
901 &task_workspace,
902 &path_like_target.terminal_dir,
903 &path_like_target.maybe_path,
904 cx,
905 )
906 })?
907 .await;
908 if let Some((path_to_open, open_target)) = open_target {
909 let opened_items = task_workspace
910 .update_in(&mut cx, |workspace, window, cx| {
911 workspace.open_paths(
912 vec![path_to_open.path.clone()],
913 OpenVisible::OnlyDirectories,
914 None,
915 window,
916 cx,
917 )
918 })
919 .context("workspace update")?
920 .await;
921 if opened_items.len() != 1 {
922 debug_panic!(
923 "Received {} items for one path {path_to_open:?}",
924 opened_items.len(),
925 );
926 }
927
928 if let Some(opened_item) = opened_items.first() {
929 if open_target.is_file() {
930 if let Some(Ok(opened_item)) = opened_item {
931 if let Some(row) = path_to_open.row {
932 let col = path_to_open.column.unwrap_or(0);
933 if let Some(active_editor) =
934 opened_item.downcast::<Editor>()
935 {
936 active_editor
937 .downgrade()
938 .update_in(&mut cx, |editor, window, cx| {
939 editor.go_to_singleton_buffer_point(
940 language::Point::new(
941 row.saturating_sub(1),
942 col.saturating_sub(1),
943 ),
944 window,
945 cx,
946 )
947 })
948 .log_err();
949 }
950 }
951 }
952 } else if open_target.is_dir() {
953 task_workspace.update(&mut cx, |workspace, cx| {
954 workspace.project().update(cx, |_, cx| {
955 cx.emit(project::Event::ActivateProjectPanel);
956 })
957 })?;
958 }
959 }
960 }
961
962 anyhow::Ok(())
963 })
964 .detach_and_log_err(cx)
965 }
966 },
967 Event::BreadcrumbsChanged => cx.emit(ItemEvent::UpdateBreadcrumbs),
968 Event::CloseTerminal => cx.emit(ItemEvent::CloseItem),
969 Event::SelectionsChanged => {
970 window.invalidate_character_coordinates();
971 cx.emit(SearchEvent::ActiveMatchChanged)
972 }
973 },
974 );
975 vec![terminal_subscription, terminal_events_subscription]
976}
977
978#[derive(Debug, Clone)]
979enum OpenTarget {
980 Worktree(Entry),
981 File(Metadata),
982}
983
984impl OpenTarget {
985 fn is_file(&self) -> bool {
986 match self {
987 OpenTarget::Worktree(entry) => entry.is_file(),
988 OpenTarget::File(metadata) => !metadata.is_dir,
989 }
990 }
991
992 fn is_dir(&self) -> bool {
993 match self {
994 OpenTarget::Worktree(entry) => entry.is_dir(),
995 OpenTarget::File(metadata) => metadata.is_dir,
996 }
997 }
998}
999
1000fn possible_open_target(
1001 workspace: &WeakEntity<Workspace>,
1002 cwd: &Option<PathBuf>,
1003 maybe_path: &str,
1004 cx: &mut Context<TerminalView>,
1005) -> Task<Option<(PathWithPosition, OpenTarget)>> {
1006 let Some(workspace) = workspace.upgrade() else {
1007 return Task::ready(None);
1008 };
1009 // We have to check for both paths, as on Unix, certain paths with positions are valid file paths too.
1010 // We can be on FS remote part, without real FS, so cannot canonicalize or check for existence the path right away.
1011 let mut potential_paths = Vec::new();
1012 let original_path = PathWithPosition::from_path(PathBuf::from(maybe_path));
1013 let path_with_position = PathWithPosition::parse_str(maybe_path);
1014 for prefix_str in GIT_DIFF_PATH_PREFIXES {
1015 if let Some(stripped) = original_path.path.strip_prefix(prefix_str).ok() {
1016 potential_paths.push(PathWithPosition {
1017 path: stripped.to_owned(),
1018 row: original_path.row,
1019 column: original_path.column,
1020 });
1021 }
1022 if let Some(stripped) = path_with_position.path.strip_prefix(prefix_str).ok() {
1023 potential_paths.push(PathWithPosition {
1024 path: stripped.to_owned(),
1025 row: path_with_position.row,
1026 column: path_with_position.column,
1027 });
1028 }
1029 }
1030 potential_paths.insert(0, original_path);
1031 potential_paths.insert(1, path_with_position);
1032
1033 for worktree in workspace.read(cx).worktrees(cx).sorted_by_key(|worktree| {
1034 let worktree_root = worktree.read(cx).abs_path();
1035 match cwd
1036 .as_ref()
1037 .and_then(|cwd| worktree_root.strip_prefix(cwd).ok())
1038 {
1039 Some(cwd_child) => cwd_child.components().count(),
1040 None => usize::MAX,
1041 }
1042 }) {
1043 let worktree_root = worktree.read(cx).abs_path();
1044 let paths_to_check = potential_paths
1045 .iter()
1046 .map(|path_with_position| PathWithPosition {
1047 path: path_with_position
1048 .path
1049 .strip_prefix(&worktree_root)
1050 .unwrap_or(&path_with_position.path)
1051 .to_owned(),
1052 row: path_with_position.row,
1053 column: path_with_position.column,
1054 })
1055 .collect::<Vec<_>>();
1056
1057 let mut traversal = worktree
1058 .read(cx)
1059 .traverse_from_path(true, true, false, "".as_ref());
1060 while let Some(entry) = traversal.next() {
1061 if let Some(path_in_worktree) = paths_to_check
1062 .iter()
1063 .find(|path_to_check| entry.path.ends_with(&path_to_check.path))
1064 {
1065 return Task::ready(Some((
1066 PathWithPosition {
1067 path: worktree_root.join(&entry.path),
1068 row: path_in_worktree.row,
1069 column: path_in_worktree.column,
1070 },
1071 OpenTarget::Worktree(entry.clone()),
1072 )));
1073 }
1074 }
1075 }
1076
1077 if !workspace.read(cx).project().read(cx).is_local() {
1078 return Task::ready(None);
1079 }
1080 let fs = workspace.read(cx).project().read(cx).fs().clone();
1081
1082 let paths_to_check = potential_paths
1083 .into_iter()
1084 .flat_map(|path_to_check| {
1085 let mut paths_to_check = Vec::new();
1086 let maybe_path = &path_to_check.path;
1087 if maybe_path.starts_with("~") {
1088 if let Some(home_path) =
1089 maybe_path
1090 .strip_prefix("~")
1091 .ok()
1092 .and_then(|stripped_maybe_path| {
1093 Some(dirs::home_dir()?.join(stripped_maybe_path))
1094 })
1095 {
1096 paths_to_check.push(PathWithPosition {
1097 path: home_path,
1098 row: path_to_check.row,
1099 column: path_to_check.column,
1100 });
1101 }
1102 } else {
1103 paths_to_check.push(PathWithPosition {
1104 path: maybe_path.clone(),
1105 row: path_to_check.row,
1106 column: path_to_check.column,
1107 });
1108 if maybe_path.is_relative() {
1109 if let Some(cwd) = &cwd {
1110 paths_to_check.push(PathWithPosition {
1111 path: cwd.join(maybe_path),
1112 row: path_to_check.row,
1113 column: path_to_check.column,
1114 });
1115 }
1116 }
1117 }
1118 paths_to_check
1119 })
1120 .collect::<Vec<_>>();
1121
1122 cx.background_spawn(async move {
1123 for path_to_check in paths_to_check {
1124 if let Some(metadata) = fs.metadata(&path_to_check.path).await.ok().flatten() {
1125 return Some((path_to_check, OpenTarget::File(metadata)));
1126 }
1127 }
1128 None
1129 })
1130}
1131
1132fn regex_to_literal(regex: &str) -> String {
1133 regex
1134 .chars()
1135 .flat_map(|c| {
1136 if REGEX_SPECIAL_CHARS.contains(&c) {
1137 vec!['\\', c]
1138 } else {
1139 vec![c]
1140 }
1141 })
1142 .collect()
1143}
1144
1145pub fn regex_search_for_query(query: &project::search::SearchQuery) -> Option<RegexSearch> {
1146 let query = query.as_str();
1147 if query == "." {
1148 return None;
1149 }
1150 let searcher = RegexSearch::new(query);
1151 searcher.ok()
1152}
1153
1154impl TerminalView {
1155 fn key_down(&mut self, event: &KeyDownEvent, window: &mut Window, cx: &mut Context<Self>) {
1156 self.clear_bell(cx);
1157 self.pause_cursor_blinking(window, cx);
1158
1159 self.terminal.update(cx, |term, cx| {
1160 let handled = term.try_keystroke(
1161 &event.keystroke,
1162 TerminalSettings::get_global(cx).option_as_meta,
1163 );
1164 if handled {
1165 cx.stop_propagation();
1166 }
1167 });
1168 }
1169
1170 fn focus_in(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1171 self.terminal.update(cx, |terminal, _| {
1172 terminal.set_cursor_shape(self.cursor_shape);
1173 terminal.focus_in();
1174 });
1175 self.blink_cursors(self.blink_epoch, window, cx);
1176 window.invalidate_character_coordinates();
1177 cx.notify();
1178 }
1179
1180 fn focus_out(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1181 self.terminal.update(cx, |terminal, _| {
1182 terminal.focus_out();
1183 terminal.set_cursor_shape(CursorShape::Hollow);
1184 });
1185 self.hide_scrollbar(cx);
1186 cx.notify();
1187 }
1188}
1189
1190impl Render for TerminalView {
1191 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1192 let terminal_handle = self.terminal.clone();
1193 let terminal_view_handle = cx.entity().clone();
1194
1195 let focused = self.focus_handle.is_focused(window);
1196
1197 div()
1198 .id("terminal-view")
1199 .size_full()
1200 .relative()
1201 .track_focus(&self.focus_handle(cx))
1202 .key_context(self.dispatch_context(cx))
1203 .on_action(cx.listener(TerminalView::send_text))
1204 .on_action(cx.listener(TerminalView::send_keystroke))
1205 .on_action(cx.listener(TerminalView::copy))
1206 .on_action(cx.listener(TerminalView::paste))
1207 .on_action(cx.listener(TerminalView::clear))
1208 .on_action(cx.listener(TerminalView::scroll_line_up))
1209 .on_action(cx.listener(TerminalView::scroll_line_down))
1210 .on_action(cx.listener(TerminalView::scroll_page_up))
1211 .on_action(cx.listener(TerminalView::scroll_page_down))
1212 .on_action(cx.listener(TerminalView::scroll_to_top))
1213 .on_action(cx.listener(TerminalView::scroll_to_bottom))
1214 .on_action(cx.listener(TerminalView::toggle_vi_mode))
1215 .on_action(cx.listener(TerminalView::show_character_palette))
1216 .on_action(cx.listener(TerminalView::select_all))
1217 .on_key_down(cx.listener(Self::key_down))
1218 .on_mouse_down(
1219 MouseButton::Right,
1220 cx.listener(|this, event: &MouseDownEvent, window, cx| {
1221 if !this.terminal.read(cx).mouse_mode(event.modifiers.shift) {
1222 this.deploy_context_menu(event.position, window, cx);
1223 cx.notify();
1224 }
1225 }),
1226 )
1227 .on_hover(cx.listener(|this, hovered, window, cx| {
1228 if *hovered {
1229 this.show_scrollbar = true;
1230 this.hide_scrollbar_task.take();
1231 cx.notify();
1232 } else if !this.focus_handle.contains_focused(window, cx) {
1233 this.hide_scrollbar(cx);
1234 }
1235 }))
1236 .child(
1237 // TODO: Oddly this wrapper div is needed for TerminalElement to not steal events from the context menu
1238 div()
1239 .size_full()
1240 .child(TerminalElement::new(
1241 terminal_handle,
1242 terminal_view_handle,
1243 self.workspace.clone(),
1244 self.focus_handle.clone(),
1245 focused,
1246 self.should_show_cursor(focused, cx),
1247 self.can_navigate_to_selected_word,
1248 self.block_below_cursor.clone(),
1249 ))
1250 .when_some(self.render_scrollbar(cx), |div, scrollbar| {
1251 div.child(scrollbar)
1252 }),
1253 )
1254 .children(self.context_menu.as_ref().map(|(menu, position, _)| {
1255 deferred(
1256 anchored()
1257 .position(*position)
1258 .anchor(gpui::Corner::TopLeft)
1259 .child(menu.clone()),
1260 )
1261 .with_priority(1)
1262 }))
1263 }
1264}
1265
1266impl Item for TerminalView {
1267 type Event = ItemEvent;
1268
1269 fn tab_tooltip_content(&self, cx: &App) -> Option<TabTooltipContent> {
1270 let terminal = self.terminal().read(cx);
1271 let title = terminal.title(false);
1272 let pid = terminal.pty_info.pid_getter().fallback_pid();
1273
1274 Some(TabTooltipContent::Custom(Box::new(move |_window, cx| {
1275 cx.new(|_| TerminalTooltip::new(title.clone(), pid)).into()
1276 })))
1277 }
1278
1279 fn tab_content(&self, params: TabContentParams, _window: &Window, cx: &App) -> AnyElement {
1280 let terminal = self.terminal().read(cx);
1281 let title = terminal.title(true);
1282
1283 let (icon, icon_color, rerun_button) = match terminal.task() {
1284 Some(terminal_task) => match &terminal_task.status {
1285 TaskStatus::Running => (
1286 IconName::Play,
1287 Color::Disabled,
1288 TerminalView::rerun_button(&terminal_task),
1289 ),
1290 TaskStatus::Unknown => (
1291 IconName::Warning,
1292 Color::Warning,
1293 TerminalView::rerun_button(&terminal_task),
1294 ),
1295 TaskStatus::Completed { success } => {
1296 let rerun_button = TerminalView::rerun_button(&terminal_task);
1297
1298 if *success {
1299 (IconName::Check, Color::Success, rerun_button)
1300 } else {
1301 (IconName::XCircle, Color::Error, rerun_button)
1302 }
1303 }
1304 },
1305 None => (IconName::Terminal, Color::Muted, None),
1306 };
1307
1308 h_flex()
1309 .gap_1()
1310 .group("term-tab-icon")
1311 .child(
1312 h_flex()
1313 .group("term-tab-icon")
1314 .child(
1315 div()
1316 .when(rerun_button.is_some(), |this| {
1317 this.hover(|style| style.invisible().w_0())
1318 })
1319 .child(Icon::new(icon).color(icon_color)),
1320 )
1321 .when_some(rerun_button, |this, rerun_button| {
1322 this.child(
1323 div()
1324 .absolute()
1325 .visible_on_hover("term-tab-icon")
1326 .child(rerun_button),
1327 )
1328 }),
1329 )
1330 .child(Label::new(title).color(params.text_color()))
1331 .into_any()
1332 }
1333
1334 fn telemetry_event_text(&self) -> Option<&'static str> {
1335 None
1336 }
1337
1338 fn clone_on_split(
1339 &self,
1340 workspace_id: Option<WorkspaceId>,
1341 window: &mut Window,
1342 cx: &mut Context<Self>,
1343 ) -> Option<Entity<Self>> {
1344 let window_handle = window.window_handle();
1345 let terminal = self
1346 .project
1347 .update(cx, |project, cx| {
1348 let terminal = self.terminal().read(cx);
1349 let working_directory = terminal
1350 .working_directory()
1351 .or_else(|| Some(project.active_project_directory(cx)?.to_path_buf()));
1352 let python_venv_directory = terminal.python_venv_directory.clone();
1353 project.create_terminal_with_venv(
1354 TerminalKind::Shell(working_directory),
1355 python_venv_directory,
1356 window_handle,
1357 cx,
1358 )
1359 })
1360 .ok()?
1361 .log_err()?;
1362
1363 Some(cx.new(|cx| {
1364 TerminalView::new(
1365 terminal,
1366 self.workspace.clone(),
1367 workspace_id,
1368 self.project.clone(),
1369 window,
1370 cx,
1371 )
1372 }))
1373 }
1374
1375 fn is_dirty(&self, cx: &gpui::App) -> bool {
1376 match self.terminal.read(cx).task() {
1377 Some(task) => task.status == TaskStatus::Running,
1378 None => self.has_bell(),
1379 }
1380 }
1381
1382 fn has_conflict(&self, _cx: &App) -> bool {
1383 false
1384 }
1385
1386 fn can_save_as(&self, _cx: &App) -> bool {
1387 false
1388 }
1389
1390 fn is_singleton(&self, _cx: &App) -> bool {
1391 true
1392 }
1393
1394 fn as_searchable(&self, handle: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
1395 Some(Box::new(handle.clone()))
1396 }
1397
1398 fn breadcrumb_location(&self, cx: &App) -> ToolbarItemLocation {
1399 if self.show_breadcrumbs && !self.terminal().read(cx).breadcrumb_text.trim().is_empty() {
1400 ToolbarItemLocation::PrimaryLeft
1401 } else {
1402 ToolbarItemLocation::Hidden
1403 }
1404 }
1405
1406 fn breadcrumbs(&self, _: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
1407 Some(vec![BreadcrumbText {
1408 text: self.terminal().read(cx).breadcrumb_text.clone(),
1409 highlights: None,
1410 font: None,
1411 }])
1412 }
1413
1414 fn added_to_workspace(
1415 &mut self,
1416 workspace: &mut Workspace,
1417 _: &mut Window,
1418 cx: &mut Context<Self>,
1419 ) {
1420 if self.terminal().read(cx).task().is_none() {
1421 if let Some((new_id, old_id)) = workspace.database_id().zip(self.workspace_id) {
1422 cx.background_spawn(TERMINAL_DB.update_workspace_id(
1423 new_id,
1424 old_id,
1425 cx.entity_id().as_u64(),
1426 ))
1427 .detach();
1428 }
1429 self.workspace_id = workspace.database_id();
1430 }
1431 }
1432
1433 fn to_item_events(event: &Self::Event, mut f: impl FnMut(ItemEvent)) {
1434 f(*event)
1435 }
1436}
1437
1438impl SerializableItem for TerminalView {
1439 fn serialized_item_kind() -> &'static str {
1440 "Terminal"
1441 }
1442
1443 fn cleanup(
1444 workspace_id: WorkspaceId,
1445 alive_items: Vec<workspace::ItemId>,
1446 window: &mut Window,
1447 cx: &mut App,
1448 ) -> Task<gpui::Result<()>> {
1449 window.spawn(cx, |_| {
1450 TERMINAL_DB.delete_unloaded_items(workspace_id, alive_items)
1451 })
1452 }
1453
1454 fn serialize(
1455 &mut self,
1456 _workspace: &mut Workspace,
1457 item_id: workspace::ItemId,
1458 _closing: bool,
1459 _: &mut Window,
1460 cx: &mut Context<Self>,
1461 ) -> Option<Task<gpui::Result<()>>> {
1462 let terminal = self.terminal().read(cx);
1463 if terminal.task().is_some() {
1464 return None;
1465 }
1466
1467 if let Some((cwd, workspace_id)) = terminal.working_directory().zip(self.workspace_id) {
1468 Some(cx.background_spawn(async move {
1469 TERMINAL_DB
1470 .save_working_directory(item_id, workspace_id, cwd)
1471 .await
1472 }))
1473 } else {
1474 None
1475 }
1476 }
1477
1478 fn should_serialize(&self, event: &Self::Event) -> bool {
1479 matches!(event, ItemEvent::UpdateTab)
1480 }
1481
1482 fn deserialize(
1483 project: Entity<Project>,
1484 workspace: WeakEntity<Workspace>,
1485 workspace_id: workspace::WorkspaceId,
1486 item_id: workspace::ItemId,
1487 window: &mut Window,
1488 cx: &mut App,
1489 ) -> Task<anyhow::Result<Entity<Self>>> {
1490 let window_handle = window.window_handle();
1491 window.spawn(cx, |mut cx| async move {
1492 let cwd = cx
1493 .update(|_window, cx| {
1494 let from_db = TERMINAL_DB
1495 .get_working_directory(item_id, workspace_id)
1496 .log_err()
1497 .flatten();
1498 if from_db
1499 .as_ref()
1500 .is_some_and(|from_db| !from_db.as_os_str().is_empty())
1501 {
1502 from_db
1503 } else {
1504 workspace
1505 .upgrade()
1506 .and_then(|workspace| default_working_directory(workspace.read(cx), cx))
1507 }
1508 })
1509 .ok()
1510 .flatten();
1511
1512 let terminal = project
1513 .update(&mut cx, |project, cx| {
1514 project.create_terminal(TerminalKind::Shell(cwd), window_handle, cx)
1515 })?
1516 .await?;
1517 cx.update(|window, cx| {
1518 cx.new(|cx| {
1519 TerminalView::new(
1520 terminal,
1521 workspace,
1522 Some(workspace_id),
1523 project.downgrade(),
1524 window,
1525 cx,
1526 )
1527 })
1528 })
1529 })
1530 }
1531}
1532
1533impl SearchableItem for TerminalView {
1534 type Match = RangeInclusive<Point>;
1535
1536 fn supported_options(&self) -> SearchOptions {
1537 SearchOptions {
1538 case: false,
1539 word: false,
1540 regex: true,
1541 replacement: false,
1542 selection: false,
1543 find_in_results: false,
1544 }
1545 }
1546
1547 /// Clear stored matches
1548 fn clear_matches(&mut self, _window: &mut Window, cx: &mut Context<Self>) {
1549 self.terminal().update(cx, |term, _| term.matches.clear())
1550 }
1551
1552 /// Store matches returned from find_matches somewhere for rendering
1553 fn update_matches(
1554 &mut self,
1555 matches: &[Self::Match],
1556 _window: &mut Window,
1557 cx: &mut Context<Self>,
1558 ) {
1559 self.terminal()
1560 .update(cx, |term, _| term.matches = matches.to_vec())
1561 }
1562
1563 /// Returns the selection content to pre-load into this search
1564 fn query_suggestion(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> String {
1565 self.terminal()
1566 .read(cx)
1567 .last_content
1568 .selection_text
1569 .clone()
1570 .unwrap_or_default()
1571 }
1572
1573 /// Focus match at given index into the Vec of matches
1574 fn activate_match(
1575 &mut self,
1576 index: usize,
1577 _: &[Self::Match],
1578 _window: &mut Window,
1579 cx: &mut Context<Self>,
1580 ) {
1581 self.terminal()
1582 .update(cx, |term, _| term.activate_match(index));
1583 cx.notify();
1584 }
1585
1586 /// Add selections for all matches given.
1587 fn select_matches(&mut self, matches: &[Self::Match], _: &mut Window, cx: &mut Context<Self>) {
1588 self.terminal()
1589 .update(cx, |term, _| term.select_matches(matches));
1590 cx.notify();
1591 }
1592
1593 /// Get all of the matches for this query, should be done on the background
1594 fn find_matches(
1595 &mut self,
1596 query: Arc<SearchQuery>,
1597 _: &mut Window,
1598 cx: &mut Context<Self>,
1599 ) -> Task<Vec<Self::Match>> {
1600 let searcher = match &*query {
1601 SearchQuery::Text { .. } => regex_search_for_query(
1602 &(SearchQuery::text(
1603 regex_to_literal(query.as_str()),
1604 query.whole_word(),
1605 query.case_sensitive(),
1606 query.include_ignored(),
1607 query.files_to_include().clone(),
1608 query.files_to_exclude().clone(),
1609 None,
1610 )
1611 .unwrap()),
1612 ),
1613 SearchQuery::Regex { .. } => regex_search_for_query(&query),
1614 };
1615
1616 if let Some(s) = searcher {
1617 self.terminal()
1618 .update(cx, |term, cx| term.find_matches(s, cx))
1619 } else {
1620 Task::ready(vec![])
1621 }
1622 }
1623
1624 /// Reports back to the search toolbar what the active match should be (the selection)
1625 fn active_match_index(
1626 &mut self,
1627 direction: Direction,
1628 matches: &[Self::Match],
1629 _: &mut Window,
1630 cx: &mut Context<Self>,
1631 ) -> Option<usize> {
1632 // Selection head might have a value if there's a selection that isn't
1633 // associated with a match. Therefore, if there are no matches, we should
1634 // report None, no matter the state of the terminal
1635 let res = if !matches.is_empty() {
1636 if let Some(selection_head) = self.terminal().read(cx).selection_head {
1637 // If selection head is contained in a match. Return that match
1638 match direction {
1639 Direction::Prev => {
1640 // If no selection before selection head, return the first match
1641 Some(
1642 matches
1643 .iter()
1644 .enumerate()
1645 .rev()
1646 .find(|(_, search_match)| {
1647 search_match.contains(&selection_head)
1648 || search_match.start() < &selection_head
1649 })
1650 .map(|(ix, _)| ix)
1651 .unwrap_or(0),
1652 )
1653 }
1654 Direction::Next => {
1655 // If no selection after selection head, return the last match
1656 Some(
1657 matches
1658 .iter()
1659 .enumerate()
1660 .find(|(_, search_match)| {
1661 search_match.contains(&selection_head)
1662 || search_match.start() > &selection_head
1663 })
1664 .map(|(ix, _)| ix)
1665 .unwrap_or(matches.len().saturating_sub(1)),
1666 )
1667 }
1668 }
1669 } else {
1670 // Matches found but no active selection, return the first last one (closest to cursor)
1671 Some(matches.len().saturating_sub(1))
1672 }
1673 } else {
1674 None
1675 };
1676
1677 res
1678 }
1679 fn replace(
1680 &mut self,
1681 _: &Self::Match,
1682 _: &SearchQuery,
1683 _window: &mut Window,
1684 _: &mut Context<Self>,
1685 ) {
1686 // Replacement is not supported in terminal view, so this is a no-op.
1687 }
1688}
1689
1690///Gets the working directory for the given workspace, respecting the user's settings.
1691/// None implies "~" on whichever machine we end up on.
1692pub(crate) fn default_working_directory(workspace: &Workspace, cx: &App) -> Option<PathBuf> {
1693 match &TerminalSettings::get_global(cx).working_directory {
1694 WorkingDirectory::CurrentProjectDirectory => workspace
1695 .project()
1696 .read(cx)
1697 .active_project_directory(cx)
1698 .as_deref()
1699 .map(Path::to_path_buf),
1700 WorkingDirectory::FirstProjectDirectory => first_project_directory(workspace, cx),
1701 WorkingDirectory::AlwaysHome => None,
1702 WorkingDirectory::Always { directory } => {
1703 shellexpand::full(&directory) //TODO handle this better
1704 .ok()
1705 .map(|dir| Path::new(&dir.to_string()).to_path_buf())
1706 .filter(|dir| dir.is_dir())
1707 }
1708 }
1709}
1710///Gets the first project's home directory, or the home directory
1711fn first_project_directory(workspace: &Workspace, cx: &App) -> Option<PathBuf> {
1712 let worktree = workspace.worktrees(cx).next()?.read(cx);
1713 if !worktree.root_entry()?.is_dir() {
1714 return None;
1715 }
1716 Some(worktree.abs_path().to_path_buf())
1717}
1718
1719#[cfg(test)]
1720mod tests {
1721 use super::*;
1722 use gpui::TestAppContext;
1723 use project::{Entry, Project, ProjectPath, Worktree};
1724 use std::path::Path;
1725 use workspace::AppState;
1726
1727 // Working directory calculation tests
1728
1729 // No Worktrees in project -> home_dir()
1730 #[gpui::test]
1731 async fn no_worktree(cx: &mut TestAppContext) {
1732 let (project, workspace) = init_test(cx).await;
1733 cx.read(|cx| {
1734 let workspace = workspace.read(cx);
1735 let active_entry = project.read(cx).active_entry();
1736
1737 //Make sure environment is as expected
1738 assert!(active_entry.is_none());
1739 assert!(workspace.worktrees(cx).next().is_none());
1740
1741 let res = default_working_directory(workspace, cx);
1742 assert_eq!(res, None);
1743 let res = first_project_directory(workspace, cx);
1744 assert_eq!(res, None);
1745 });
1746 }
1747
1748 // No active entry, but a worktree, worktree is a file -> home_dir()
1749 #[gpui::test]
1750 async fn no_active_entry_worktree_is_file(cx: &mut TestAppContext) {
1751 let (project, workspace) = init_test(cx).await;
1752
1753 create_file_wt(project.clone(), "/root.txt", cx).await;
1754 cx.read(|cx| {
1755 let workspace = workspace.read(cx);
1756 let active_entry = project.read(cx).active_entry();
1757
1758 //Make sure environment is as expected
1759 assert!(active_entry.is_none());
1760 assert!(workspace.worktrees(cx).next().is_some());
1761
1762 let res = default_working_directory(workspace, cx);
1763 assert_eq!(res, None);
1764 let res = first_project_directory(workspace, cx);
1765 assert_eq!(res, None);
1766 });
1767 }
1768
1769 // No active entry, but a worktree, worktree is a folder -> worktree_folder
1770 #[gpui::test]
1771 async fn no_active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1772 let (project, workspace) = init_test(cx).await;
1773
1774 let (_wt, _entry) = create_folder_wt(project.clone(), "/root/", cx).await;
1775 cx.update(|cx| {
1776 let workspace = workspace.read(cx);
1777 let active_entry = project.read(cx).active_entry();
1778
1779 assert!(active_entry.is_none());
1780 assert!(workspace.worktrees(cx).next().is_some());
1781
1782 let res = default_working_directory(workspace, cx);
1783 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1784 let res = first_project_directory(workspace, cx);
1785 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1786 });
1787 }
1788
1789 // Active entry with a work tree, worktree is a file -> worktree_folder()
1790 #[gpui::test]
1791 async fn active_entry_worktree_is_file(cx: &mut TestAppContext) {
1792 let (project, workspace) = init_test(cx).await;
1793
1794 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1795 let (wt2, entry2) = create_file_wt(project.clone(), "/root2.txt", cx).await;
1796 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1797
1798 cx.update(|cx| {
1799 let workspace = workspace.read(cx);
1800 let active_entry = project.read(cx).active_entry();
1801
1802 assert!(active_entry.is_some());
1803
1804 let res = default_working_directory(workspace, cx);
1805 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1806 let res = first_project_directory(workspace, cx);
1807 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1808 });
1809 }
1810
1811 // Active entry, with a worktree, worktree is a folder -> worktree_folder
1812 #[gpui::test]
1813 async fn active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1814 let (project, workspace) = init_test(cx).await;
1815
1816 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1817 let (wt2, entry2) = create_folder_wt(project.clone(), "/root2/", cx).await;
1818 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1819
1820 cx.update(|cx| {
1821 let workspace = workspace.read(cx);
1822 let active_entry = project.read(cx).active_entry();
1823
1824 assert!(active_entry.is_some());
1825
1826 let res = default_working_directory(workspace, cx);
1827 assert_eq!(res, Some((Path::new("/root2/")).to_path_buf()));
1828 let res = first_project_directory(workspace, cx);
1829 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1830 });
1831 }
1832
1833 /// Creates a worktree with 1 file: /root.txt
1834 pub async fn init_test(cx: &mut TestAppContext) -> (Entity<Project>, Entity<Workspace>) {
1835 let params = cx.update(AppState::test);
1836 cx.update(|cx| {
1837 terminal::init(cx);
1838 theme::init(theme::LoadThemes::JustBase, cx);
1839 Project::init_settings(cx);
1840 language::init(cx);
1841 });
1842
1843 let project = Project::test(params.fs.clone(), [], cx).await;
1844 let workspace = cx
1845 .add_window(|window, cx| Workspace::test_new(project.clone(), window, cx))
1846 .root(cx)
1847 .unwrap();
1848
1849 (project, workspace)
1850 }
1851
1852 /// Creates a worktree with 1 folder: /root{suffix}/
1853 async fn create_folder_wt(
1854 project: Entity<Project>,
1855 path: impl AsRef<Path>,
1856 cx: &mut TestAppContext,
1857 ) -> (Entity<Worktree>, Entry) {
1858 create_wt(project, true, path, cx).await
1859 }
1860
1861 /// Creates a worktree with 1 file: /root{suffix}.txt
1862 async fn create_file_wt(
1863 project: Entity<Project>,
1864 path: impl AsRef<Path>,
1865 cx: &mut TestAppContext,
1866 ) -> (Entity<Worktree>, Entry) {
1867 create_wt(project, false, path, cx).await
1868 }
1869
1870 async fn create_wt(
1871 project: Entity<Project>,
1872 is_dir: bool,
1873 path: impl AsRef<Path>,
1874 cx: &mut TestAppContext,
1875 ) -> (Entity<Worktree>, Entry) {
1876 let (wt, _) = project
1877 .update(cx, |project, cx| {
1878 project.find_or_create_worktree(path, true, cx)
1879 })
1880 .await
1881 .unwrap();
1882
1883 let entry = cx
1884 .update(|cx| wt.update(cx, |wt, cx| wt.create_entry(Path::new(""), is_dir, cx)))
1885 .await
1886 .unwrap()
1887 .to_included()
1888 .unwrap();
1889
1890 (wt, entry)
1891 }
1892
1893 pub fn insert_active_entry_for(
1894 wt: Entity<Worktree>,
1895 entry: Entry,
1896 project: Entity<Project>,
1897 cx: &mut TestAppContext,
1898 ) {
1899 cx.update(|cx| {
1900 let p = ProjectPath {
1901 worktree_id: wt.read(cx).id(),
1902 path: entry.path,
1903 };
1904 project.update(cx, |project, cx| project.set_active_path(Some(p), cx));
1905 });
1906 }
1907
1908 #[test]
1909 fn escapes_only_special_characters() {
1910 assert_eq!(regex_to_literal(r"test(\w)"), r"test\(\\w\)".to_string());
1911 }
1912
1913 #[test]
1914 fn empty_string_stays_empty() {
1915 assert_eq!(regex_to_literal(""), "".to_string());
1916 }
1917}