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