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, OpenOptions, OpenVisible, ToolbarItemLocation,
42 Workspace, 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 hover_target_tooltip: Option<String>,
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 hover_target_tooltip: None,
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.hover_target_tooltip =
873 maybe_navigation_target
874 .as_ref()
875 .and_then(|navigation_target| match navigation_target {
876 MaybeNavigationTarget::Url(url) => Some(url.clone()),
877 MaybeNavigationTarget::PathLike(path_like_target) => {
878 let valid_files_to_open_task = possible_open_target(
879 &workspace,
880 &path_like_target.terminal_dir,
881 &path_like_target.maybe_path,
882 cx,
883 );
884 Some(match smol::block_on(valid_files_to_open_task)? {
885 OpenTarget::File(path, _) | OpenTarget::Worktree(path, _) => {
886 path.to_string(|path| path.to_string_lossy().to_string())
887 }
888 })
889 }
890 });
891 cx.notify()
892 }
893
894 Event::Open(maybe_navigation_target) => match maybe_navigation_target {
895 MaybeNavigationTarget::Url(url) => cx.open_url(url),
896
897 MaybeNavigationTarget::PathLike(path_like_target) => {
898 if this.hover_target_tooltip.is_none() {
899 return;
900 }
901 let task_workspace = workspace.clone();
902 let path_like_target = path_like_target.clone();
903 cx.spawn_in(window, |terminal_view, mut cx| async move {
904 let open_target = terminal_view
905 .update(&mut cx, |_, cx| {
906 possible_open_target(
907 &task_workspace,
908 &path_like_target.terminal_dir,
909 &path_like_target.maybe_path,
910 cx,
911 )
912 })?
913 .await;
914 if let Some(open_target) = open_target {
915 let path_to_open = open_target.path();
916 let opened_items = task_workspace
917 .update_in(&mut cx, |workspace, window, cx| {
918 workspace.open_paths(
919 vec![path_to_open.path.clone()],
920 OpenOptions {
921 visible: Some(OpenVisible::OnlyDirectories),
922 ..Default::default()
923 },
924 None,
925 window,
926 cx,
927 )
928 })
929 .context("workspace update")?
930 .await;
931 if opened_items.len() != 1 {
932 debug_panic!(
933 "Received {} items for one path {path_to_open:?}",
934 opened_items.len(),
935 );
936 }
937
938 if let Some(opened_item) = opened_items.first() {
939 if open_target.is_file() {
940 if let Some(Ok(opened_item)) = opened_item {
941 if let Some(row) = path_to_open.row {
942 let col = path_to_open.column.unwrap_or(0);
943 if let Some(active_editor) =
944 opened_item.downcast::<Editor>()
945 {
946 active_editor
947 .downgrade()
948 .update_in(&mut cx, |editor, window, cx| {
949 editor.go_to_singleton_buffer_point(
950 language::Point::new(
951 row.saturating_sub(1),
952 col.saturating_sub(1),
953 ),
954 window,
955 cx,
956 )
957 })
958 .log_err();
959 }
960 }
961 }
962 } else if open_target.is_dir() {
963 task_workspace.update(&mut cx, |workspace, cx| {
964 workspace.project().update(cx, |_, cx| {
965 cx.emit(project::Event::ActivateProjectPanel);
966 })
967 })?;
968 }
969 }
970 }
971
972 anyhow::Ok(())
973 })
974 .detach_and_log_err(cx)
975 }
976 },
977 Event::BreadcrumbsChanged => cx.emit(ItemEvent::UpdateBreadcrumbs),
978 Event::CloseTerminal => cx.emit(ItemEvent::CloseItem),
979 Event::SelectionsChanged => {
980 window.invalidate_character_coordinates();
981 cx.emit(SearchEvent::ActiveMatchChanged)
982 }
983 },
984 );
985 vec![terminal_subscription, terminal_events_subscription]
986}
987
988#[derive(Debug, Clone)]
989enum OpenTarget {
990 Worktree(PathWithPosition, Entry),
991 File(PathWithPosition, Metadata),
992}
993
994impl OpenTarget {
995 fn is_file(&self) -> bool {
996 match self {
997 OpenTarget::Worktree(_, entry) => entry.is_file(),
998 OpenTarget::File(_, metadata) => !metadata.is_dir,
999 }
1000 }
1001
1002 fn is_dir(&self) -> bool {
1003 match self {
1004 OpenTarget::Worktree(_, entry) => entry.is_dir(),
1005 OpenTarget::File(_, metadata) => metadata.is_dir,
1006 }
1007 }
1008
1009 fn path(&self) -> &PathWithPosition {
1010 match self {
1011 OpenTarget::Worktree(path, _) => path,
1012 OpenTarget::File(path, _) => path,
1013 }
1014 }
1015}
1016
1017fn possible_open_target(
1018 workspace: &WeakEntity<Workspace>,
1019 cwd: &Option<PathBuf>,
1020 maybe_path: &str,
1021 cx: &mut Context<TerminalView>,
1022) -> Task<Option<OpenTarget>> {
1023 let Some(workspace) = workspace.upgrade() else {
1024 return Task::ready(None);
1025 };
1026 // We have to check for both paths, as on Unix, certain paths with positions are valid file paths too.
1027 // We can be on FS remote part, without real FS, so cannot canonicalize or check for existence the path right away.
1028 let mut potential_paths = Vec::new();
1029 let original_path = PathWithPosition::from_path(PathBuf::from(maybe_path));
1030 let path_with_position = PathWithPosition::parse_str(maybe_path);
1031 let worktree_candidates = workspace
1032 .read(cx)
1033 .worktrees(cx)
1034 .sorted_by_key(|worktree| {
1035 let worktree_root = worktree.read(cx).abs_path();
1036 match cwd
1037 .as_ref()
1038 .and_then(|cwd| worktree_root.strip_prefix(cwd).ok())
1039 {
1040 Some(cwd_child) => cwd_child.components().count(),
1041 None => usize::MAX,
1042 }
1043 })
1044 .collect::<Vec<_>>();
1045 // Since we do not check paths via FS and joining, we need to strip off potential `./`, `a/`, `b/` prefixes out of it.
1046 for prefix_str in GIT_DIFF_PATH_PREFIXES.iter().chain(std::iter::once(&".")) {
1047 if let Some(stripped) = original_path.path.strip_prefix(prefix_str).ok() {
1048 potential_paths.push(PathWithPosition {
1049 path: stripped.to_owned(),
1050 row: original_path.row,
1051 column: original_path.column,
1052 });
1053 }
1054 if let Some(stripped) = path_with_position.path.strip_prefix(prefix_str).ok() {
1055 potential_paths.push(PathWithPosition {
1056 path: stripped.to_owned(),
1057 row: path_with_position.row,
1058 column: path_with_position.column,
1059 });
1060 }
1061 }
1062 potential_paths.insert(0, original_path);
1063 potential_paths.insert(1, path_with_position);
1064
1065 for worktree in &worktree_candidates {
1066 let worktree_root = worktree.read(cx).abs_path();
1067 let mut paths_to_check = Vec::with_capacity(potential_paths.len());
1068
1069 for path_with_position in &potential_paths {
1070 if worktree_root.ends_with(&path_with_position.path) {
1071 let root_path_with_posiition = PathWithPosition {
1072 path: worktree_root.to_path_buf(),
1073 row: path_with_position.row,
1074 column: path_with_position.column,
1075 };
1076 match worktree.read(cx).root_entry() {
1077 Some(root_entry) => {
1078 return Task::ready(Some(OpenTarget::Worktree(
1079 root_path_with_posiition,
1080 root_entry.clone(),
1081 )))
1082 }
1083 None => paths_to_check.push(root_path_with_posiition),
1084 }
1085 } else {
1086 paths_to_check.push(PathWithPosition {
1087 path: path_with_position
1088 .path
1089 .strip_prefix(&worktree_root)
1090 .unwrap_or(&path_with_position.path)
1091 .to_owned(),
1092 row: path_with_position.row,
1093 column: path_with_position.column,
1094 });
1095 };
1096 }
1097
1098 let mut traversal = worktree
1099 .read(cx)
1100 .traverse_from_path(true, true, false, "".as_ref());
1101 while let Some(entry) = traversal.next() {
1102 if let Some(path_in_worktree) = paths_to_check
1103 .iter()
1104 .find(|path_to_check| entry.path.ends_with(&path_to_check.path))
1105 {
1106 return Task::ready(Some(OpenTarget::Worktree(
1107 PathWithPosition {
1108 path: worktree_root.join(&entry.path),
1109 row: path_in_worktree.row,
1110 column: path_in_worktree.column,
1111 },
1112 entry.clone(),
1113 )));
1114 }
1115 }
1116 }
1117
1118 if !workspace.read(cx).project().read(cx).is_local() {
1119 return Task::ready(None);
1120 }
1121 let fs = workspace.read(cx).project().read(cx).fs().clone();
1122
1123 let paths_to_check = potential_paths
1124 .into_iter()
1125 .flat_map(|path_to_check| {
1126 let mut paths_to_check = Vec::new();
1127 let maybe_path = &path_to_check.path;
1128 if maybe_path.starts_with("~") {
1129 if let Some(home_path) =
1130 maybe_path
1131 .strip_prefix("~")
1132 .ok()
1133 .and_then(|stripped_maybe_path| {
1134 Some(dirs::home_dir()?.join(stripped_maybe_path))
1135 })
1136 {
1137 paths_to_check.push(PathWithPosition {
1138 path: home_path,
1139 row: path_to_check.row,
1140 column: path_to_check.column,
1141 });
1142 }
1143 } else {
1144 paths_to_check.push(PathWithPosition {
1145 path: maybe_path.clone(),
1146 row: path_to_check.row,
1147 column: path_to_check.column,
1148 });
1149 if maybe_path.is_relative() {
1150 if let Some(cwd) = &cwd {
1151 paths_to_check.push(PathWithPosition {
1152 path: cwd.join(maybe_path),
1153 row: path_to_check.row,
1154 column: path_to_check.column,
1155 });
1156 }
1157 for worktree in &worktree_candidates {
1158 paths_to_check.push(PathWithPosition {
1159 path: worktree.read(cx).abs_path().join(maybe_path),
1160 row: path_to_check.row,
1161 column: path_to_check.column,
1162 });
1163 }
1164 }
1165 }
1166 paths_to_check
1167 })
1168 .collect::<Vec<_>>();
1169
1170 cx.background_spawn(async move {
1171 for path_to_check in paths_to_check {
1172 if let Some(metadata) = fs.metadata(&path_to_check.path).await.ok().flatten() {
1173 return Some(OpenTarget::File(path_to_check, metadata));
1174 }
1175 }
1176 None
1177 })
1178}
1179
1180fn regex_to_literal(regex: &str) -> String {
1181 regex
1182 .chars()
1183 .flat_map(|c| {
1184 if REGEX_SPECIAL_CHARS.contains(&c) {
1185 vec!['\\', c]
1186 } else {
1187 vec![c]
1188 }
1189 })
1190 .collect()
1191}
1192
1193pub fn regex_search_for_query(query: &project::search::SearchQuery) -> Option<RegexSearch> {
1194 let query = query.as_str();
1195 if query == "." {
1196 return None;
1197 }
1198 let searcher = RegexSearch::new(query);
1199 searcher.ok()
1200}
1201
1202impl TerminalView {
1203 fn key_down(&mut self, event: &KeyDownEvent, window: &mut Window, cx: &mut Context<Self>) {
1204 self.clear_bell(cx);
1205 self.pause_cursor_blinking(window, cx);
1206
1207 self.terminal.update(cx, |term, cx| {
1208 let handled = term.try_keystroke(
1209 &event.keystroke,
1210 TerminalSettings::get_global(cx).option_as_meta,
1211 );
1212 if handled {
1213 cx.stop_propagation();
1214 }
1215 });
1216 }
1217
1218 fn focus_in(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1219 self.terminal.update(cx, |terminal, _| {
1220 terminal.set_cursor_shape(self.cursor_shape);
1221 terminal.focus_in();
1222 });
1223 self.blink_cursors(self.blink_epoch, window, cx);
1224 window.invalidate_character_coordinates();
1225 cx.notify();
1226 }
1227
1228 fn focus_out(&mut self, _: &mut Window, cx: &mut Context<Self>) {
1229 self.terminal.update(cx, |terminal, _| {
1230 terminal.focus_out();
1231 terminal.set_cursor_shape(CursorShape::Hollow);
1232 });
1233 self.hide_scrollbar(cx);
1234 cx.notify();
1235 }
1236}
1237
1238impl Render for TerminalView {
1239 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1240 let terminal_handle = self.terminal.clone();
1241 let terminal_view_handle = cx.entity().clone();
1242
1243 let focused = self.focus_handle.is_focused(window);
1244
1245 div()
1246 .id("terminal-view")
1247 .size_full()
1248 .relative()
1249 .track_focus(&self.focus_handle(cx))
1250 .key_context(self.dispatch_context(cx))
1251 .on_action(cx.listener(TerminalView::send_text))
1252 .on_action(cx.listener(TerminalView::send_keystroke))
1253 .on_action(cx.listener(TerminalView::copy))
1254 .on_action(cx.listener(TerminalView::paste))
1255 .on_action(cx.listener(TerminalView::clear))
1256 .on_action(cx.listener(TerminalView::scroll_line_up))
1257 .on_action(cx.listener(TerminalView::scroll_line_down))
1258 .on_action(cx.listener(TerminalView::scroll_page_up))
1259 .on_action(cx.listener(TerminalView::scroll_page_down))
1260 .on_action(cx.listener(TerminalView::scroll_to_top))
1261 .on_action(cx.listener(TerminalView::scroll_to_bottom))
1262 .on_action(cx.listener(TerminalView::toggle_vi_mode))
1263 .on_action(cx.listener(TerminalView::show_character_palette))
1264 .on_action(cx.listener(TerminalView::select_all))
1265 .on_key_down(cx.listener(Self::key_down))
1266 .on_mouse_down(
1267 MouseButton::Right,
1268 cx.listener(|this, event: &MouseDownEvent, window, cx| {
1269 if !this.terminal.read(cx).mouse_mode(event.modifiers.shift) {
1270 this.deploy_context_menu(event.position, window, cx);
1271 cx.notify();
1272 }
1273 }),
1274 )
1275 .on_hover(cx.listener(|this, hovered, window, cx| {
1276 if *hovered {
1277 this.show_scrollbar = true;
1278 this.hide_scrollbar_task.take();
1279 cx.notify();
1280 } else if !this.focus_handle.contains_focused(window, cx) {
1281 this.hide_scrollbar(cx);
1282 }
1283 }))
1284 .child(
1285 // TODO: Oddly this wrapper div is needed for TerminalElement to not steal events from the context menu
1286 div()
1287 .size_full()
1288 .child(TerminalElement::new(
1289 terminal_handle,
1290 terminal_view_handle,
1291 self.workspace.clone(),
1292 self.focus_handle.clone(),
1293 focused,
1294 self.should_show_cursor(focused, cx),
1295 self.block_below_cursor.clone(),
1296 ))
1297 .when_some(self.render_scrollbar(cx), |div, scrollbar| {
1298 div.child(scrollbar)
1299 }),
1300 )
1301 .children(self.context_menu.as_ref().map(|(menu, position, _)| {
1302 deferred(
1303 anchored()
1304 .position(*position)
1305 .anchor(gpui::Corner::TopLeft)
1306 .child(menu.clone()),
1307 )
1308 .with_priority(1)
1309 }))
1310 }
1311}
1312
1313impl Item for TerminalView {
1314 type Event = ItemEvent;
1315
1316 fn tab_tooltip_content(&self, cx: &App) -> Option<TabTooltipContent> {
1317 let terminal = self.terminal().read(cx);
1318 let title = terminal.title(false);
1319 let pid = terminal.pty_info.pid_getter().fallback_pid();
1320
1321 Some(TabTooltipContent::Custom(Box::new(move |_window, cx| {
1322 cx.new(|_| TerminalTooltip::new(title.clone(), pid)).into()
1323 })))
1324 }
1325
1326 fn tab_content(&self, params: TabContentParams, _window: &Window, cx: &App) -> AnyElement {
1327 let terminal = self.terminal().read(cx);
1328 let title = terminal.title(true);
1329
1330 let (icon, icon_color, rerun_button) = match terminal.task() {
1331 Some(terminal_task) => match &terminal_task.status {
1332 TaskStatus::Running => (
1333 IconName::Play,
1334 Color::Disabled,
1335 TerminalView::rerun_button(&terminal_task),
1336 ),
1337 TaskStatus::Unknown => (
1338 IconName::Warning,
1339 Color::Warning,
1340 TerminalView::rerun_button(&terminal_task),
1341 ),
1342 TaskStatus::Completed { success } => {
1343 let rerun_button = TerminalView::rerun_button(&terminal_task);
1344
1345 if *success {
1346 (IconName::Check, Color::Success, rerun_button)
1347 } else {
1348 (IconName::XCircle, Color::Error, rerun_button)
1349 }
1350 }
1351 },
1352 None if self.terminal.read(cx).debug_terminal() => {
1353 (IconName::Debug, Color::Muted, None)
1354 }
1355 None => (IconName::Terminal, Color::Muted, None),
1356 };
1357
1358 h_flex()
1359 .gap_1()
1360 .group("term-tab-icon")
1361 .child(
1362 h_flex()
1363 .group("term-tab-icon")
1364 .child(
1365 div()
1366 .when(rerun_button.is_some(), |this| {
1367 this.hover(|style| style.invisible().w_0())
1368 })
1369 .child(Icon::new(icon).color(icon_color)),
1370 )
1371 .when_some(rerun_button, |this, rerun_button| {
1372 this.child(
1373 div()
1374 .absolute()
1375 .visible_on_hover("term-tab-icon")
1376 .child(rerun_button),
1377 )
1378 }),
1379 )
1380 .child(Label::new(title).color(params.text_color()))
1381 .into_any()
1382 }
1383
1384 fn telemetry_event_text(&self) -> Option<&'static str> {
1385 None
1386 }
1387
1388 fn clone_on_split(
1389 &self,
1390 workspace_id: Option<WorkspaceId>,
1391 window: &mut Window,
1392 cx: &mut Context<Self>,
1393 ) -> Option<Entity<Self>> {
1394 let window_handle = window.window_handle();
1395 let terminal = self
1396 .project
1397 .update(cx, |project, cx| {
1398 let terminal = self.terminal().read(cx);
1399 let working_directory = terminal
1400 .working_directory()
1401 .or_else(|| Some(project.active_project_directory(cx)?.to_path_buf()));
1402 let python_venv_directory = terminal.python_venv_directory.clone();
1403 project.create_terminal_with_venv(
1404 TerminalKind::Shell(working_directory),
1405 python_venv_directory,
1406 window_handle,
1407 cx,
1408 )
1409 })
1410 .ok()?
1411 .log_err()?;
1412
1413 Some(cx.new(|cx| {
1414 TerminalView::new(
1415 terminal,
1416 self.workspace.clone(),
1417 workspace_id,
1418 self.project.clone(),
1419 window,
1420 cx,
1421 )
1422 }))
1423 }
1424
1425 fn is_dirty(&self, cx: &gpui::App) -> bool {
1426 match self.terminal.read(cx).task() {
1427 Some(task) => task.status == TaskStatus::Running,
1428 None => self.has_bell(),
1429 }
1430 }
1431
1432 fn has_conflict(&self, _cx: &App) -> bool {
1433 false
1434 }
1435
1436 fn can_save_as(&self, _cx: &App) -> bool {
1437 false
1438 }
1439
1440 fn is_singleton(&self, _cx: &App) -> bool {
1441 true
1442 }
1443
1444 fn as_searchable(&self, handle: &Entity<Self>) -> Option<Box<dyn SearchableItemHandle>> {
1445 Some(Box::new(handle.clone()))
1446 }
1447
1448 fn breadcrumb_location(&self, cx: &App) -> ToolbarItemLocation {
1449 if self.show_breadcrumbs && !self.terminal().read(cx).breadcrumb_text.trim().is_empty() {
1450 ToolbarItemLocation::PrimaryLeft
1451 } else {
1452 ToolbarItemLocation::Hidden
1453 }
1454 }
1455
1456 fn breadcrumbs(&self, _: &theme::Theme, cx: &App) -> Option<Vec<BreadcrumbText>> {
1457 Some(vec![BreadcrumbText {
1458 text: self.terminal().read(cx).breadcrumb_text.clone(),
1459 highlights: None,
1460 font: None,
1461 }])
1462 }
1463
1464 fn added_to_workspace(
1465 &mut self,
1466 workspace: &mut Workspace,
1467 _: &mut Window,
1468 cx: &mut Context<Self>,
1469 ) {
1470 if self.terminal().read(cx).task().is_none() {
1471 if let Some((new_id, old_id)) = workspace.database_id().zip(self.workspace_id) {
1472 cx.background_spawn(TERMINAL_DB.update_workspace_id(
1473 new_id,
1474 old_id,
1475 cx.entity_id().as_u64(),
1476 ))
1477 .detach();
1478 }
1479 self.workspace_id = workspace.database_id();
1480 }
1481 }
1482
1483 fn to_item_events(event: &Self::Event, mut f: impl FnMut(ItemEvent)) {
1484 f(*event)
1485 }
1486}
1487
1488impl SerializableItem for TerminalView {
1489 fn serialized_item_kind() -> &'static str {
1490 "Terminal"
1491 }
1492
1493 fn cleanup(
1494 workspace_id: WorkspaceId,
1495 alive_items: Vec<workspace::ItemId>,
1496 window: &mut Window,
1497 cx: &mut App,
1498 ) -> Task<gpui::Result<()>> {
1499 window.spawn(cx, |_| {
1500 TERMINAL_DB.delete_unloaded_items(workspace_id, alive_items)
1501 })
1502 }
1503
1504 fn serialize(
1505 &mut self,
1506 _workspace: &mut Workspace,
1507 item_id: workspace::ItemId,
1508 _closing: bool,
1509 _: &mut Window,
1510 cx: &mut Context<Self>,
1511 ) -> Option<Task<gpui::Result<()>>> {
1512 let terminal = self.terminal().read(cx);
1513 if terminal.task().is_some() || terminal.debug_terminal() {
1514 return None;
1515 }
1516
1517 if let Some((cwd, workspace_id)) = terminal.working_directory().zip(self.workspace_id) {
1518 Some(cx.background_spawn(async move {
1519 TERMINAL_DB
1520 .save_working_directory(item_id, workspace_id, cwd)
1521 .await
1522 }))
1523 } else {
1524 None
1525 }
1526 }
1527
1528 fn should_serialize(&self, event: &Self::Event) -> bool {
1529 matches!(event, ItemEvent::UpdateTab)
1530 }
1531
1532 fn deserialize(
1533 project: Entity<Project>,
1534 workspace: WeakEntity<Workspace>,
1535 workspace_id: workspace::WorkspaceId,
1536 item_id: workspace::ItemId,
1537 window: &mut Window,
1538 cx: &mut App,
1539 ) -> Task<anyhow::Result<Entity<Self>>> {
1540 let window_handle = window.window_handle();
1541 window.spawn(cx, |mut cx| async move {
1542 let cwd = cx
1543 .update(|_window, cx| {
1544 let from_db = TERMINAL_DB
1545 .get_working_directory(item_id, workspace_id)
1546 .log_err()
1547 .flatten();
1548 if from_db
1549 .as_ref()
1550 .is_some_and(|from_db| !from_db.as_os_str().is_empty())
1551 {
1552 from_db
1553 } else {
1554 workspace
1555 .upgrade()
1556 .and_then(|workspace| default_working_directory(workspace.read(cx), cx))
1557 }
1558 })
1559 .ok()
1560 .flatten();
1561
1562 let terminal = project
1563 .update(&mut cx, |project, cx| {
1564 project.create_terminal(TerminalKind::Shell(cwd), window_handle, cx)
1565 })?
1566 .await?;
1567 cx.update(|window, cx| {
1568 cx.new(|cx| {
1569 TerminalView::new(
1570 terminal,
1571 workspace,
1572 Some(workspace_id),
1573 project.downgrade(),
1574 window,
1575 cx,
1576 )
1577 })
1578 })
1579 })
1580 }
1581}
1582
1583impl SearchableItem for TerminalView {
1584 type Match = RangeInclusive<Point>;
1585
1586 fn supported_options(&self) -> SearchOptions {
1587 SearchOptions {
1588 case: false,
1589 word: false,
1590 regex: true,
1591 replacement: false,
1592 selection: false,
1593 find_in_results: false,
1594 }
1595 }
1596
1597 /// Clear stored matches
1598 fn clear_matches(&mut self, _window: &mut Window, cx: &mut Context<Self>) {
1599 self.terminal().update(cx, |term, _| term.matches.clear())
1600 }
1601
1602 /// Store matches returned from find_matches somewhere for rendering
1603 fn update_matches(
1604 &mut self,
1605 matches: &[Self::Match],
1606 _window: &mut Window,
1607 cx: &mut Context<Self>,
1608 ) {
1609 self.terminal()
1610 .update(cx, |term, _| term.matches = matches.to_vec())
1611 }
1612
1613 /// Returns the selection content to pre-load into this search
1614 fn query_suggestion(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> String {
1615 self.terminal()
1616 .read(cx)
1617 .last_content
1618 .selection_text
1619 .clone()
1620 .unwrap_or_default()
1621 }
1622
1623 /// Focus match at given index into the Vec of matches
1624 fn activate_match(
1625 &mut self,
1626 index: usize,
1627 _: &[Self::Match],
1628 _window: &mut Window,
1629 cx: &mut Context<Self>,
1630 ) {
1631 self.terminal()
1632 .update(cx, |term, _| term.activate_match(index));
1633 cx.notify();
1634 }
1635
1636 /// Add selections for all matches given.
1637 fn select_matches(&mut self, matches: &[Self::Match], _: &mut Window, cx: &mut Context<Self>) {
1638 self.terminal()
1639 .update(cx, |term, _| term.select_matches(matches));
1640 cx.notify();
1641 }
1642
1643 /// Get all of the matches for this query, should be done on the background
1644 fn find_matches(
1645 &mut self,
1646 query: Arc<SearchQuery>,
1647 _: &mut Window,
1648 cx: &mut Context<Self>,
1649 ) -> Task<Vec<Self::Match>> {
1650 let searcher = match &*query {
1651 SearchQuery::Text { .. } => regex_search_for_query(
1652 &(SearchQuery::text(
1653 regex_to_literal(query.as_str()),
1654 query.whole_word(),
1655 query.case_sensitive(),
1656 query.include_ignored(),
1657 query.files_to_include().clone(),
1658 query.files_to_exclude().clone(),
1659 None,
1660 )
1661 .unwrap()),
1662 ),
1663 SearchQuery::Regex { .. } => regex_search_for_query(&query),
1664 };
1665
1666 if let Some(s) = searcher {
1667 self.terminal()
1668 .update(cx, |term, cx| term.find_matches(s, cx))
1669 } else {
1670 Task::ready(vec![])
1671 }
1672 }
1673
1674 /// Reports back to the search toolbar what the active match should be (the selection)
1675 fn active_match_index(
1676 &mut self,
1677 direction: Direction,
1678 matches: &[Self::Match],
1679 _: &mut Window,
1680 cx: &mut Context<Self>,
1681 ) -> Option<usize> {
1682 // Selection head might have a value if there's a selection that isn't
1683 // associated with a match. Therefore, if there are no matches, we should
1684 // report None, no matter the state of the terminal
1685 let res = if !matches.is_empty() {
1686 if let Some(selection_head) = self.terminal().read(cx).selection_head {
1687 // If selection head is contained in a match. Return that match
1688 match direction {
1689 Direction::Prev => {
1690 // If no selection before selection head, return the first match
1691 Some(
1692 matches
1693 .iter()
1694 .enumerate()
1695 .rev()
1696 .find(|(_, search_match)| {
1697 search_match.contains(&selection_head)
1698 || search_match.start() < &selection_head
1699 })
1700 .map(|(ix, _)| ix)
1701 .unwrap_or(0),
1702 )
1703 }
1704 Direction::Next => {
1705 // If no selection after selection head, return the last match
1706 Some(
1707 matches
1708 .iter()
1709 .enumerate()
1710 .find(|(_, search_match)| {
1711 search_match.contains(&selection_head)
1712 || search_match.start() > &selection_head
1713 })
1714 .map(|(ix, _)| ix)
1715 .unwrap_or(matches.len().saturating_sub(1)),
1716 )
1717 }
1718 }
1719 } else {
1720 // Matches found but no active selection, return the first last one (closest to cursor)
1721 Some(matches.len().saturating_sub(1))
1722 }
1723 } else {
1724 None
1725 };
1726
1727 res
1728 }
1729 fn replace(
1730 &mut self,
1731 _: &Self::Match,
1732 _: &SearchQuery,
1733 _window: &mut Window,
1734 _: &mut Context<Self>,
1735 ) {
1736 // Replacement is not supported in terminal view, so this is a no-op.
1737 }
1738}
1739
1740///Gets the working directory for the given workspace, respecting the user's settings.
1741/// None implies "~" on whichever machine we end up on.
1742pub(crate) fn default_working_directory(workspace: &Workspace, cx: &App) -> Option<PathBuf> {
1743 match &TerminalSettings::get_global(cx).working_directory {
1744 WorkingDirectory::CurrentProjectDirectory => workspace
1745 .project()
1746 .read(cx)
1747 .active_project_directory(cx)
1748 .as_deref()
1749 .map(Path::to_path_buf),
1750 WorkingDirectory::FirstProjectDirectory => first_project_directory(workspace, cx),
1751 WorkingDirectory::AlwaysHome => None,
1752 WorkingDirectory::Always { directory } => {
1753 shellexpand::full(&directory) //TODO handle this better
1754 .ok()
1755 .map(|dir| Path::new(&dir.to_string()).to_path_buf())
1756 .filter(|dir| dir.is_dir())
1757 }
1758 }
1759}
1760///Gets the first project's home directory, or the home directory
1761fn first_project_directory(workspace: &Workspace, cx: &App) -> Option<PathBuf> {
1762 let worktree = workspace.worktrees(cx).next()?.read(cx);
1763 if !worktree.root_entry()?.is_dir() {
1764 return None;
1765 }
1766 Some(worktree.abs_path().to_path_buf())
1767}
1768
1769#[cfg(test)]
1770mod tests {
1771 use super::*;
1772 use gpui::TestAppContext;
1773 use project::{Entry, Project, ProjectPath, Worktree};
1774 use std::path::Path;
1775 use workspace::AppState;
1776
1777 // Working directory calculation tests
1778
1779 // No Worktrees in project -> home_dir()
1780 #[gpui::test]
1781 async fn no_worktree(cx: &mut TestAppContext) {
1782 let (project, workspace) = init_test(cx).await;
1783 cx.read(|cx| {
1784 let workspace = workspace.read(cx);
1785 let active_entry = project.read(cx).active_entry();
1786
1787 //Make sure environment is as expected
1788 assert!(active_entry.is_none());
1789 assert!(workspace.worktrees(cx).next().is_none());
1790
1791 let res = default_working_directory(workspace, cx);
1792 assert_eq!(res, None);
1793 let res = first_project_directory(workspace, cx);
1794 assert_eq!(res, None);
1795 });
1796 }
1797
1798 // No active entry, but a worktree, worktree is a file -> home_dir()
1799 #[gpui::test]
1800 async fn no_active_entry_worktree_is_file(cx: &mut TestAppContext) {
1801 let (project, workspace) = init_test(cx).await;
1802
1803 create_file_wt(project.clone(), "/root.txt", cx).await;
1804 cx.read(|cx| {
1805 let workspace = workspace.read(cx);
1806 let active_entry = project.read(cx).active_entry();
1807
1808 //Make sure environment is as expected
1809 assert!(active_entry.is_none());
1810 assert!(workspace.worktrees(cx).next().is_some());
1811
1812 let res = default_working_directory(workspace, cx);
1813 assert_eq!(res, None);
1814 let res = first_project_directory(workspace, cx);
1815 assert_eq!(res, None);
1816 });
1817 }
1818
1819 // No active entry, but a worktree, worktree is a folder -> worktree_folder
1820 #[gpui::test]
1821 async fn no_active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1822 let (project, workspace) = init_test(cx).await;
1823
1824 let (_wt, _entry) = create_folder_wt(project.clone(), "/root/", cx).await;
1825 cx.update(|cx| {
1826 let workspace = workspace.read(cx);
1827 let active_entry = project.read(cx).active_entry();
1828
1829 assert!(active_entry.is_none());
1830 assert!(workspace.worktrees(cx).next().is_some());
1831
1832 let res = default_working_directory(workspace, cx);
1833 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1834 let res = first_project_directory(workspace, cx);
1835 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1836 });
1837 }
1838
1839 // Active entry with a work tree, worktree is a file -> worktree_folder()
1840 #[gpui::test]
1841 async fn active_entry_worktree_is_file(cx: &mut TestAppContext) {
1842 let (project, workspace) = init_test(cx).await;
1843
1844 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1845 let (wt2, entry2) = create_file_wt(project.clone(), "/root2.txt", cx).await;
1846 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1847
1848 cx.update(|cx| {
1849 let workspace = workspace.read(cx);
1850 let active_entry = project.read(cx).active_entry();
1851
1852 assert!(active_entry.is_some());
1853
1854 let res = default_working_directory(workspace, cx);
1855 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1856 let res = first_project_directory(workspace, cx);
1857 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1858 });
1859 }
1860
1861 // Active entry, with a worktree, worktree is a folder -> worktree_folder
1862 #[gpui::test]
1863 async fn active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1864 let (project, workspace) = init_test(cx).await;
1865
1866 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1867 let (wt2, entry2) = create_folder_wt(project.clone(), "/root2/", cx).await;
1868 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1869
1870 cx.update(|cx| {
1871 let workspace = workspace.read(cx);
1872 let active_entry = project.read(cx).active_entry();
1873
1874 assert!(active_entry.is_some());
1875
1876 let res = default_working_directory(workspace, cx);
1877 assert_eq!(res, Some((Path::new("/root2/")).to_path_buf()));
1878 let res = first_project_directory(workspace, cx);
1879 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1880 });
1881 }
1882
1883 /// Creates a worktree with 1 file: /root.txt
1884 pub async fn init_test(cx: &mut TestAppContext) -> (Entity<Project>, Entity<Workspace>) {
1885 let params = cx.update(AppState::test);
1886 cx.update(|cx| {
1887 terminal::init(cx);
1888 theme::init(theme::LoadThemes::JustBase, cx);
1889 Project::init_settings(cx);
1890 language::init(cx);
1891 });
1892
1893 let project = Project::test(params.fs.clone(), [], cx).await;
1894 let workspace = cx
1895 .add_window(|window, cx| Workspace::test_new(project.clone(), window, cx))
1896 .root(cx)
1897 .unwrap();
1898
1899 (project, workspace)
1900 }
1901
1902 /// Creates a worktree with 1 folder: /root{suffix}/
1903 async fn create_folder_wt(
1904 project: Entity<Project>,
1905 path: impl AsRef<Path>,
1906 cx: &mut TestAppContext,
1907 ) -> (Entity<Worktree>, Entry) {
1908 create_wt(project, true, path, cx).await
1909 }
1910
1911 /// Creates a worktree with 1 file: /root{suffix}.txt
1912 async fn create_file_wt(
1913 project: Entity<Project>,
1914 path: impl AsRef<Path>,
1915 cx: &mut TestAppContext,
1916 ) -> (Entity<Worktree>, Entry) {
1917 create_wt(project, false, path, cx).await
1918 }
1919
1920 async fn create_wt(
1921 project: Entity<Project>,
1922 is_dir: bool,
1923 path: impl AsRef<Path>,
1924 cx: &mut TestAppContext,
1925 ) -> (Entity<Worktree>, Entry) {
1926 let (wt, _) = project
1927 .update(cx, |project, cx| {
1928 project.find_or_create_worktree(path, true, cx)
1929 })
1930 .await
1931 .unwrap();
1932
1933 let entry = cx
1934 .update(|cx| wt.update(cx, |wt, cx| wt.create_entry(Path::new(""), is_dir, cx)))
1935 .await
1936 .unwrap()
1937 .to_included()
1938 .unwrap();
1939
1940 (wt, entry)
1941 }
1942
1943 pub fn insert_active_entry_for(
1944 wt: Entity<Worktree>,
1945 entry: Entry,
1946 project: Entity<Project>,
1947 cx: &mut TestAppContext,
1948 ) {
1949 cx.update(|cx| {
1950 let p = ProjectPath {
1951 worktree_id: wt.read(cx).id(),
1952 path: entry.path,
1953 };
1954 project.update(cx, |project, cx| project.set_active_path(Some(p), cx));
1955 });
1956 }
1957
1958 #[test]
1959 fn escapes_only_special_characters() {
1960 assert_eq!(regex_to_literal(r"test(\w)"), r"test\(\\w\)".to_string());
1961 }
1962
1963 #[test]
1964 fn empty_string_stays_empty() {
1965 assert_eq!(regex_to_literal(""), "".to_string());
1966 }
1967}