1#![allow(unused_variables)]
2//todo!(remove)
3
4mod persistence;
5pub mod terminal_element;
6pub mod terminal_panel;
7
8// todo!()
9// use crate::terminal_element::TerminalElement;
10use editor::{scroll::autoscroll::Autoscroll, Editor};
11use gpui::{
12 div, impl_actions, overlay, AnyElement, AppContext, DismissEvent, Div, EventEmitter,
13 FocusEvent, FocusHandle, Focusable, FocusableElement, FocusableView, KeyContext, KeyDownEvent,
14 Keystroke, Model, MouseButton, MouseDownEvent, Pixels, Render, Styled, Subscription, Task,
15 View, VisualContext, WeakView,
16};
17use language::Bias;
18use persistence::TERMINAL_DB;
19use project::{search::SearchQuery, LocalWorktree, Project};
20use terminal::{
21 alacritty_terminal::{
22 index::Point,
23 term::{search::RegexSearch, TermMode},
24 },
25 terminal_settings::{TerminalBlink, TerminalSettings, WorkingDirectory},
26 Clear, Copy, Event, MaybeNavigationTarget, Paste, ShowCharacterPalette, Terminal,
27};
28use terminal_element::TerminalElement;
29use ui::{h_stack, prelude::*, ContextMenu, Icon, IconElement, Label};
30use util::{paths::PathLikeWithPosition, ResultExt};
31use workspace::{
32 item::{BreadcrumbText, Item, ItemEvent},
33 notifications::NotifyResultExt,
34 register_deserializable_item,
35 searchable::{SearchEvent, SearchOptions, SearchableItem},
36 CloseActiveItem, NewCenterTerminal, Pane, ToolbarItemLocation, Workspace, WorkspaceId,
37};
38
39use anyhow::Context;
40use dirs::home_dir;
41use serde::Deserialize;
42use settings::Settings;
43use smol::Timer;
44
45use std::{
46 ops::RangeInclusive,
47 path::{Path, PathBuf},
48 sync::Arc,
49 time::Duration,
50};
51
52const CURSOR_BLINK_INTERVAL: Duration = Duration::from_millis(500);
53
54///Event to transmit the scroll from the element to the view
55#[derive(Clone, Debug, PartialEq)]
56pub struct ScrollTerminal(pub i32);
57
58#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
59pub struct SendText(String);
60
61#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
62pub struct SendKeystroke(String);
63
64impl_actions!(terminal_view, [SendText, SendKeystroke]);
65
66pub fn init(cx: &mut AppContext) {
67 terminal_panel::init(cx);
68 terminal::init(cx);
69
70 register_deserializable_item::<TerminalView>(cx);
71
72 cx.observe_new_views(
73 |workspace: &mut Workspace, cx: &mut ViewContext<Workspace>| {
74 workspace.register_action(TerminalView::deploy);
75 },
76 )
77 .detach();
78}
79
80///A terminal view, maintains the PTY's file handles and communicates with the terminal
81pub struct TerminalView {
82 terminal: Model<Terminal>,
83 focus_handle: FocusHandle,
84 has_new_content: bool,
85 //Currently using iTerm bell, show bell emoji in tab until input is received
86 has_bell: bool,
87 context_menu: Option<(View<ContextMenu>, gpui::Point<Pixels>, Subscription)>,
88 blink_state: bool,
89 blinking_on: bool,
90 blinking_paused: bool,
91 blink_epoch: usize,
92 can_navigate_to_selected_word: bool,
93 workspace_id: WorkspaceId,
94 _subscriptions: Vec<Subscription>,
95}
96
97impl EventEmitter<Event> for TerminalView {}
98impl EventEmitter<ItemEvent> for TerminalView {}
99impl EventEmitter<SearchEvent> for TerminalView {}
100
101impl FocusableView for TerminalView {
102 fn focus_handle(&self, _cx: &AppContext) -> FocusHandle {
103 self.focus_handle.clone()
104 }
105}
106
107impl TerminalView {
108 ///Create a new Terminal in the current working directory or the user's home directory
109 pub fn deploy(
110 workspace: &mut Workspace,
111 _: &NewCenterTerminal,
112 cx: &mut ViewContext<Workspace>,
113 ) {
114 let strategy = TerminalSettings::get_global(cx);
115 let working_directory =
116 get_working_directory(workspace, cx, strategy.working_directory.clone());
117
118 let window = cx.window_handle();
119 let terminal = workspace
120 .project()
121 .update(cx, |project, cx| {
122 project.create_terminal(working_directory, window, cx)
123 })
124 .notify_err(workspace, cx);
125
126 if let Some(terminal) = terminal {
127 let view = cx.build_view(|cx| {
128 TerminalView::new(
129 terminal,
130 workspace.weak_handle(),
131 workspace.database_id(),
132 cx,
133 )
134 });
135 workspace.add_item(Box::new(view), cx)
136 }
137 }
138
139 pub fn new(
140 terminal: Model<Terminal>,
141 workspace: WeakView<Workspace>,
142 workspace_id: WorkspaceId,
143 cx: &mut ViewContext<Self>,
144 ) -> Self {
145 let view_id = cx.entity_id();
146 cx.observe(&terminal, |_, _, cx| cx.notify()).detach();
147 cx.subscribe(&terminal, move |this, _, event, cx| match event {
148 Event::Wakeup => {
149 if !this.focus_handle.is_focused(cx) {
150 this.has_new_content = true;
151 }
152 cx.notify();
153 cx.emit(Event::Wakeup);
154 cx.emit(ItemEvent::UpdateTab);
155 cx.emit(SearchEvent::MatchesInvalidated);
156 }
157
158 Event::Bell => {
159 this.has_bell = true;
160 cx.emit(Event::Wakeup);
161 }
162
163 Event::BlinkChanged => this.blinking_on = !this.blinking_on,
164
165 Event::TitleChanged => {
166 cx.emit(ItemEvent::UpdateTab);
167 if let Some(foreground_info) = &this.terminal().read(cx).foreground_process_info {
168 let cwd = foreground_info.cwd.clone();
169
170 let item_id = cx.entity_id();
171 let workspace_id = this.workspace_id;
172 cx.background_executor()
173 .spawn(async move {
174 TERMINAL_DB
175 .save_working_directory(item_id.as_u64(), workspace_id, cwd)
176 .await
177 .log_err();
178 })
179 .detach();
180 }
181 }
182
183 Event::NewNavigationTarget(maybe_navigation_target) => {
184 this.can_navigate_to_selected_word = match maybe_navigation_target {
185 Some(MaybeNavigationTarget::Url(_)) => true,
186 Some(MaybeNavigationTarget::PathLike(maybe_path)) => {
187 !possible_open_targets(&workspace, maybe_path, cx).is_empty()
188 }
189 None => false,
190 }
191 }
192
193 Event::Open(maybe_navigation_target) => match maybe_navigation_target {
194 MaybeNavigationTarget::Url(url) => cx.open_url(url),
195
196 MaybeNavigationTarget::PathLike(maybe_path) => {
197 if !this.can_navigate_to_selected_word {
198 return;
199 }
200 let potential_abs_paths = possible_open_targets(&workspace, maybe_path, cx);
201 if let Some(path) = potential_abs_paths.into_iter().next() {
202 let is_dir = path.path_like.is_dir();
203 let task_workspace = workspace.clone();
204 cx.spawn(|_, mut cx| async move {
205 let opened_items = task_workspace
206 .update(&mut cx, |workspace, cx| {
207 workspace.open_paths(vec![path.path_like], is_dir, cx)
208 })
209 .context("workspace update")?
210 .await;
211 anyhow::ensure!(
212 opened_items.len() == 1,
213 "For a single path open, expected single opened item"
214 );
215 let opened_item = opened_items
216 .into_iter()
217 .next()
218 .unwrap()
219 .transpose()
220 .context("path open")?;
221 if is_dir {
222 task_workspace.update(&mut cx, |workspace, cx| {
223 workspace.project().update(cx, |_, cx| {
224 cx.emit(project::Event::ActivateProjectPanel);
225 })
226 })?;
227 } else {
228 if let Some(row) = path.row {
229 let col = path.column.unwrap_or(0);
230 if let Some(active_editor) =
231 opened_item.and_then(|item| item.downcast::<Editor>())
232 {
233 active_editor
234 .downgrade()
235 .update(&mut cx, |editor, cx| {
236 let snapshot = editor.snapshot(cx).display_snapshot;
237 let point = snapshot.buffer_snapshot.clip_point(
238 language::Point::new(
239 row.saturating_sub(1),
240 col.saturating_sub(1),
241 ),
242 Bias::Left,
243 );
244 editor.change_selections(
245 Some(Autoscroll::center()),
246 cx,
247 |s| s.select_ranges([point..point]),
248 );
249 })
250 .log_err();
251 }
252 }
253 }
254 anyhow::Ok(())
255 })
256 .detach_and_log_err(cx);
257 }
258 }
259 },
260 Event::BreadcrumbsChanged => cx.emit(ItemEvent::UpdateBreadcrumbs),
261 Event::CloseTerminal => cx.emit(ItemEvent::CloseItem),
262 Event::SelectionsChanged => cx.emit(SearchEvent::ActiveMatchChanged),
263 })
264 .detach();
265
266 let focus = cx.focus_handle();
267 // let focus_in = cx.on_focus_in(&focus, |this, cx| {
268 // this.has_new_content = false;
269 // this.terminal.read(cx).focus_in();
270 // this.blink_cursors(this.blink_epoch, cx);
271 // cx.notify();
272 // });
273 // let focus_out = cx.on_focus_out(&focus, |this, cx| {
274 // this.terminal.update(cx, |terminal, _| {
275 // terminal.focus_out();
276 // });
277 // cx.notify();
278 // });
279
280 Self {
281 terminal,
282 has_new_content: true,
283 has_bell: false,
284 focus_handle: cx.focus_handle(),
285 context_menu: None,
286 blink_state: true,
287 blinking_on: false,
288 blinking_paused: false,
289 blink_epoch: 0,
290 can_navigate_to_selected_word: false,
291 workspace_id,
292 _subscriptions: vec![/*focus_in, focus_out*/],
293 }
294 }
295
296 pub fn model(&self) -> &Model<Terminal> {
297 &self.terminal
298 }
299
300 pub fn has_new_content(&self) -> bool {
301 self.has_new_content
302 }
303
304 pub fn has_bell(&self) -> bool {
305 self.has_bell
306 }
307
308 pub fn clear_bel(&mut self, cx: &mut ViewContext<TerminalView>) {
309 self.has_bell = false;
310 cx.emit(Event::Wakeup);
311 }
312
313 pub fn deploy_context_menu(
314 &mut self,
315 position: gpui::Point<Pixels>,
316 cx: &mut ViewContext<Self>,
317 ) {
318 let context_menu = ContextMenu::build(cx, |menu, cx| {
319 menu.action("Clear", Box::new(Clear))
320 .action("Close", Box::new(CloseActiveItem { save_intent: None }))
321 });
322
323 cx.focus_view(&context_menu);
324 let subscription =
325 cx.subscribe(&context_menu, |this, _, _: &DismissEvent, cx| {
326 if this.context_menu.as_ref().is_some_and(|context_menu| {
327 context_menu.0.focus_handle(cx).contains_focused(cx)
328 }) {
329 cx.focus_self();
330 }
331 this.context_menu.take();
332 cx.notify();
333 });
334
335 self.context_menu = Some((context_menu, position, subscription));
336 }
337
338 fn show_character_palette(&mut self, _: &ShowCharacterPalette, cx: &mut ViewContext<Self>) {
339 if !self
340 .terminal
341 .read(cx)
342 .last_content
343 .mode
344 .contains(TermMode::ALT_SCREEN)
345 {
346 cx.show_character_palette();
347 } else {
348 self.terminal.update(cx, |term, cx| {
349 term.try_keystroke(
350 &Keystroke::parse("ctrl-cmd-space").unwrap(),
351 TerminalSettings::get_global(cx).option_as_meta,
352 )
353 });
354 }
355 }
356
357 fn select_all(&mut self, _: &editor::SelectAll, cx: &mut ViewContext<Self>) {
358 self.terminal.update(cx, |term, _| term.select_all());
359 cx.notify();
360 }
361
362 fn clear(&mut self, _: &Clear, cx: &mut ViewContext<Self>) {
363 self.terminal.update(cx, |term, _| term.clear());
364 cx.notify();
365 }
366
367 pub fn should_show_cursor(&self, focused: bool, cx: &mut gpui::ViewContext<Self>) -> bool {
368 //Don't blink the cursor when not focused, blinking is disabled, or paused
369 if !focused
370 || !self.blinking_on
371 || self.blinking_paused
372 || self
373 .terminal
374 .read(cx)
375 .last_content
376 .mode
377 .contains(TermMode::ALT_SCREEN)
378 {
379 return true;
380 }
381
382 match TerminalSettings::get_global(cx).blinking {
383 //If the user requested to never blink, don't blink it.
384 TerminalBlink::Off => true,
385 //If the terminal is controlling it, check terminal mode
386 TerminalBlink::TerminalControlled | TerminalBlink::On => self.blink_state,
387 }
388 }
389
390 fn blink_cursors(&mut self, epoch: usize, cx: &mut ViewContext<Self>) {
391 if epoch == self.blink_epoch && !self.blinking_paused {
392 self.blink_state = !self.blink_state;
393 cx.notify();
394
395 let epoch = self.next_blink_epoch();
396 cx.spawn(|this, mut cx| async move {
397 Timer::after(CURSOR_BLINK_INTERVAL).await;
398 this.update(&mut cx, |this, cx| this.blink_cursors(epoch, cx))
399 .log_err();
400 })
401 .detach();
402 }
403 }
404
405 pub fn pause_cursor_blinking(&mut self, cx: &mut ViewContext<Self>) {
406 self.blink_state = true;
407 cx.notify();
408
409 let epoch = self.next_blink_epoch();
410 cx.spawn(|this, mut cx| async move {
411 Timer::after(CURSOR_BLINK_INTERVAL).await;
412 this.update(&mut cx, |this, cx| this.resume_cursor_blinking(epoch, cx))
413 .ok();
414 })
415 .detach();
416 }
417
418 pub fn find_matches(
419 &mut self,
420 query: Arc<project::search::SearchQuery>,
421 cx: &mut ViewContext<Self>,
422 ) -> Task<Vec<RangeInclusive<Point>>> {
423 let searcher = regex_search_for_query(&query);
424
425 if let Some(searcher) = searcher {
426 self.terminal
427 .update(cx, |term, cx| term.find_matches(searcher, cx))
428 } else {
429 cx.background_executor().spawn(async { Vec::new() })
430 }
431 }
432
433 pub fn terminal(&self) -> &Model<Terminal> {
434 &self.terminal
435 }
436
437 fn next_blink_epoch(&mut self) -> usize {
438 self.blink_epoch += 1;
439 self.blink_epoch
440 }
441
442 fn resume_cursor_blinking(&mut self, epoch: usize, cx: &mut ViewContext<Self>) {
443 if epoch == self.blink_epoch {
444 self.blinking_paused = false;
445 self.blink_cursors(epoch, cx);
446 }
447 }
448
449 ///Attempt to paste the clipboard into the terminal
450 fn copy(&mut self, _: &Copy, cx: &mut ViewContext<Self>) {
451 self.terminal.update(cx, |term, _| term.copy())
452 }
453
454 ///Attempt to paste the clipboard into the terminal
455 fn paste(&mut self, _: &Paste, cx: &mut ViewContext<Self>) {
456 if let Some(item) = cx.read_from_clipboard() {
457 self.terminal
458 .update(cx, |terminal, _cx| terminal.paste(item.text()));
459 }
460 }
461
462 fn send_text(&mut self, text: &SendText, cx: &mut ViewContext<Self>) {
463 self.clear_bel(cx);
464 self.terminal.update(cx, |term, _| {
465 term.input(text.0.to_string());
466 });
467 }
468
469 fn send_keystroke(&mut self, text: &SendKeystroke, cx: &mut ViewContext<Self>) {
470 if let Some(keystroke) = Keystroke::parse(&text.0).log_err() {
471 self.clear_bel(cx);
472 self.terminal.update(cx, |term, cx| {
473 term.try_keystroke(&keystroke, TerminalSettings::get_global(cx).option_as_meta);
474 });
475 }
476 }
477
478 fn dispatch_context(&self, cx: &AppContext) -> KeyContext {
479 let mut dispatch_context = KeyContext::default();
480 dispatch_context.add("Terminal");
481
482 let mode = self.terminal.read(cx).last_content.mode;
483 dispatch_context.set(
484 "screen",
485 if mode.contains(TermMode::ALT_SCREEN) {
486 "alt"
487 } else {
488 "normal"
489 },
490 );
491
492 if mode.contains(TermMode::APP_CURSOR) {
493 dispatch_context.add("DECCKM");
494 }
495 if mode.contains(TermMode::APP_KEYPAD) {
496 dispatch_context.add("DECPAM");
497 } else {
498 dispatch_context.add("DECPNM");
499 }
500 if mode.contains(TermMode::SHOW_CURSOR) {
501 dispatch_context.add("DECTCEM");
502 }
503 if mode.contains(TermMode::LINE_WRAP) {
504 dispatch_context.add("DECAWM");
505 }
506 if mode.contains(TermMode::ORIGIN) {
507 dispatch_context.add("DECOM");
508 }
509 if mode.contains(TermMode::INSERT) {
510 dispatch_context.add("IRM");
511 }
512 //LNM is apparently the name for this. https://vt100.net/docs/vt510-rm/LNM.html
513 if mode.contains(TermMode::LINE_FEED_NEW_LINE) {
514 dispatch_context.add("LNM");
515 }
516 if mode.contains(TermMode::FOCUS_IN_OUT) {
517 dispatch_context.add("report_focus");
518 }
519 if mode.contains(TermMode::ALTERNATE_SCROLL) {
520 dispatch_context.add("alternate_scroll");
521 }
522 if mode.contains(TermMode::BRACKETED_PASTE) {
523 dispatch_context.add("bracketed_paste");
524 }
525 if mode.intersects(TermMode::MOUSE_MODE) {
526 dispatch_context.add("any_mouse_reporting");
527 }
528 {
529 let mouse_reporting = if mode.contains(TermMode::MOUSE_REPORT_CLICK) {
530 "click"
531 } else if mode.contains(TermMode::MOUSE_DRAG) {
532 "drag"
533 } else if mode.contains(TermMode::MOUSE_MOTION) {
534 "motion"
535 } else {
536 "off"
537 };
538 dispatch_context.set("mouse_reporting", mouse_reporting);
539 }
540 {
541 let format = if mode.contains(TermMode::SGR_MOUSE) {
542 "sgr"
543 } else if mode.contains(TermMode::UTF8_MOUSE) {
544 "utf8"
545 } else {
546 "normal"
547 };
548 dispatch_context.set("mouse_format", format);
549 };
550 dispatch_context
551 }
552}
553
554fn possible_open_targets(
555 workspace: &WeakView<Workspace>,
556 maybe_path: &String,
557 cx: &mut ViewContext<'_, TerminalView>,
558) -> Vec<PathLikeWithPosition<PathBuf>> {
559 let path_like = PathLikeWithPosition::parse_str(maybe_path.as_str(), |path_str| {
560 Ok::<_, std::convert::Infallible>(Path::new(path_str).to_path_buf())
561 })
562 .expect("infallible");
563 let maybe_path = path_like.path_like;
564 let potential_abs_paths = if maybe_path.is_absolute() {
565 vec![maybe_path]
566 } else if maybe_path.starts_with("~") {
567 if let Some(abs_path) = maybe_path
568 .strip_prefix("~")
569 .ok()
570 .and_then(|maybe_path| Some(dirs::home_dir()?.join(maybe_path)))
571 {
572 vec![abs_path]
573 } else {
574 Vec::new()
575 }
576 } else if let Some(workspace) = workspace.upgrade() {
577 workspace.update(cx, |workspace, cx| {
578 workspace
579 .worktrees(cx)
580 .map(|worktree| worktree.read(cx).abs_path().join(&maybe_path))
581 .collect()
582 })
583 } else {
584 Vec::new()
585 };
586
587 potential_abs_paths
588 .into_iter()
589 .filter(|path| path.exists())
590 .map(|path| PathLikeWithPosition {
591 path_like: path,
592 row: path_like.row,
593 column: path_like.column,
594 })
595 .collect()
596}
597
598pub fn regex_search_for_query(query: &project::search::SearchQuery) -> Option<RegexSearch> {
599 let query = query.as_str();
600 let searcher = RegexSearch::new(&query);
601 searcher.ok()
602}
603
604impl TerminalView {
605 fn key_down(&mut self, event: &KeyDownEvent, cx: &mut ViewContext<Self>) {
606 self.clear_bel(cx);
607 self.pause_cursor_blinking(cx);
608
609 self.terminal.update(cx, |term, cx| {
610 term.try_keystroke(
611 &event.keystroke,
612 TerminalSettings::get_global(cx).option_as_meta,
613 )
614 });
615 }
616
617 fn focus_in(&mut self, event: &FocusEvent, cx: &mut ViewContext<Self>) {
618 self.has_new_content = false;
619 self.terminal.read(cx).focus_in();
620 self.blink_cursors(self.blink_epoch, cx);
621 cx.notify();
622 }
623
624 fn focus_out(&mut self, event: &FocusEvent, cx: &mut ViewContext<Self>) {
625 self.terminal.update(cx, |terminal, _| {
626 terminal.focus_out();
627 });
628 cx.notify();
629 }
630}
631
632impl Render for TerminalView {
633 type Element = Focusable<Div>;
634
635 fn render(&mut self, cx: &mut ViewContext<Self>) -> Self::Element {
636 let terminal_handle = self.terminal.clone();
637
638 let self_id = cx.entity_id();
639 let focused = self.focus_handle.is_focused(cx);
640
641 div()
642 .size_full()
643 .relative()
644 .track_focus(&self.focus_handle)
645 .key_context(self.dispatch_context(cx))
646 .on_action(cx.listener(TerminalView::send_text))
647 .on_action(cx.listener(TerminalView::send_keystroke))
648 .on_action(cx.listener(TerminalView::copy))
649 .on_action(cx.listener(TerminalView::paste))
650 .on_action(cx.listener(TerminalView::clear))
651 .on_action(cx.listener(TerminalView::show_character_palette))
652 .on_action(cx.listener(TerminalView::select_all))
653 .on_focus_in(cx.listener(Self::focus_in))
654 .on_focus_out(cx.listener(Self::focus_out))
655 .on_key_down(cx.listener(Self::key_down))
656 .on_mouse_down(
657 MouseButton::Right,
658 cx.listener(|this, event: &MouseDownEvent, cx| {
659 this.deploy_context_menu(event.position, cx);
660 cx.notify();
661 }),
662 )
663 .child(
664 // TODO: Oddly this wrapper div is needed for TerminalElement to not steal events from the context menu
665 div().size_full().child(TerminalElement::new(
666 terminal_handle,
667 self.focus_handle.clone(),
668 focused,
669 self.should_show_cursor(focused, cx),
670 self.can_navigate_to_selected_word,
671 )),
672 )
673 .children(self.context_menu.as_ref().map(|(menu, positon, _)| {
674 overlay()
675 .position(*positon)
676 .anchor(gpui::AnchorCorner::TopLeft)
677 .child(menu.clone())
678 }))
679 }
680}
681
682impl Item for TerminalView {
683 type Event = ItemEvent;
684
685 fn tab_tooltip_text(&self, cx: &AppContext) -> Option<SharedString> {
686 Some(self.terminal().read(cx).title().into())
687 }
688
689 fn tab_content(&self, _detail: Option<usize>, cx: &WindowContext) -> AnyElement {
690 let title = self.terminal().read(cx).title();
691
692 h_stack()
693 .gap_2()
694 .child(IconElement::new(Icon::Terminal))
695 .child(Label::new(title))
696 .into_any()
697 }
698
699 fn clone_on_split(
700 &self,
701 _workspace_id: WorkspaceId,
702 _cx: &mut ViewContext<Self>,
703 ) -> Option<View<Self>> {
704 //From what I can tell, there's no way to tell the current working
705 //Directory of the terminal from outside the shell. There might be
706 //solutions to this, but they are non-trivial and require more IPC
707
708 // Some(TerminalContainer::new(
709 // Err(anyhow::anyhow!("failed to instantiate terminal")),
710 // workspace_id,
711 // cx,
712 // ))
713
714 // TODO
715 None
716 }
717
718 fn is_dirty(&self, _cx: &gpui::AppContext) -> bool {
719 self.has_bell()
720 }
721
722 fn has_conflict(&self, _cx: &AppContext) -> bool {
723 false
724 }
725
726 // todo!(search)
727 // fn as_searchable(&self, handle: &View<Self>) -> Option<Box<dyn SearchableItemHandle>> {
728 // Some(Box::new(handle.clone()))
729 // }
730
731 fn breadcrumb_location(&self) -> ToolbarItemLocation {
732 ToolbarItemLocation::PrimaryLeft
733 }
734
735 fn breadcrumbs(&self, _: &theme::Theme, cx: &AppContext) -> Option<Vec<BreadcrumbText>> {
736 Some(vec![BreadcrumbText {
737 text: self.terminal().read(cx).breadcrumb_text.clone(),
738 highlights: None,
739 }])
740 }
741
742 fn serialized_item_kind() -> Option<&'static str> {
743 Some("Terminal")
744 }
745
746 fn deserialize(
747 project: Model<Project>,
748 workspace: WeakView<Workspace>,
749 workspace_id: workspace::WorkspaceId,
750 item_id: workspace::ItemId,
751 cx: &mut ViewContext<Pane>,
752 ) -> Task<anyhow::Result<View<Self>>> {
753 let window = cx.window_handle();
754 cx.spawn(|pane, mut cx| async move {
755 let cwd = None;
756 TERMINAL_DB
757 .get_working_directory(item_id, workspace_id)
758 .log_err()
759 .flatten()
760 .or_else(|| {
761 cx.update(|_, cx| {
762 let strategy = TerminalSettings::get_global(cx).working_directory.clone();
763 workspace
764 .upgrade()
765 .map(|workspace| {
766 get_working_directory(workspace.read(cx), cx, strategy)
767 })
768 .flatten()
769 })
770 .ok()
771 .flatten()
772 });
773
774 let terminal = project.update(&mut cx, |project, cx| {
775 project.create_terminal(cwd, window, cx)
776 })??;
777 pane.update(&mut cx, |_, cx| {
778 cx.build_view(|cx| TerminalView::new(terminal, workspace, workspace_id, cx))
779 })
780 })
781 }
782
783 fn added_to_workspace(&mut self, workspace: &mut Workspace, cx: &mut ViewContext<Self>) {
784 cx.background_executor()
785 .spawn(TERMINAL_DB.update_workspace_id(
786 workspace.database_id(),
787 self.workspace_id,
788 cx.entity_id().as_u64(),
789 ))
790 .detach();
791 self.workspace_id = workspace.database_id();
792 }
793
794 fn to_item_events(event: &Self::Event, mut f: impl FnMut(ItemEvent)) {
795 f(*event)
796 }
797}
798
799impl SearchableItem for TerminalView {
800 type Match = RangeInclusive<Point>;
801
802 fn supported_options() -> SearchOptions {
803 SearchOptions {
804 case: false,
805 word: false,
806 regex: false,
807 replacement: false,
808 }
809 }
810
811 /// Clear stored matches
812 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
813 self.terminal().update(cx, |term, _| term.matches.clear())
814 }
815
816 /// Store matches returned from find_matches somewhere for rendering
817 fn update_matches(&mut self, matches: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
818 self.terminal().update(cx, |term, _| term.matches = matches)
819 }
820
821 /// Return the selection content to pre-load into this search
822 fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> String {
823 self.terminal()
824 .read(cx)
825 .last_content
826 .selection_text
827 .clone()
828 .unwrap_or_default()
829 }
830
831 /// Focus match at given index into the Vec of matches
832 fn activate_match(&mut self, index: usize, _: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
833 self.terminal()
834 .update(cx, |term, _| term.activate_match(index));
835 cx.notify();
836 }
837
838 /// Add selections for all matches given.
839 fn select_matches(&mut self, matches: Vec<Self::Match>, cx: &mut ViewContext<Self>) {
840 self.terminal()
841 .update(cx, |term, _| term.select_matches(matches));
842 cx.notify();
843 }
844
845 /// Get all of the matches for this query, should be done on the background
846 fn find_matches(
847 &mut self,
848 query: Arc<project::search::SearchQuery>,
849 cx: &mut ViewContext<Self>,
850 ) -> Task<Vec<Self::Match>> {
851 if let Some(searcher) = regex_search_for_query(&query) {
852 self.terminal()
853 .update(cx, |term, cx| term.find_matches(searcher, cx))
854 } else {
855 Task::ready(vec![])
856 }
857 }
858
859 /// Reports back to the search toolbar what the active match should be (the selection)
860 fn active_match_index(
861 &mut self,
862 matches: Vec<Self::Match>,
863 cx: &mut ViewContext<Self>,
864 ) -> Option<usize> {
865 // Selection head might have a value if there's a selection that isn't
866 // associated with a match. Therefore, if there are no matches, we should
867 // report None, no matter the state of the terminal
868 let res = if matches.len() > 0 {
869 if let Some(selection_head) = self.terminal().read(cx).selection_head {
870 // If selection head is contained in a match. Return that match
871 if let Some(ix) = matches
872 .iter()
873 .enumerate()
874 .find(|(_, search_match)| {
875 search_match.contains(&selection_head)
876 || search_match.start() > &selection_head
877 })
878 .map(|(ix, _)| ix)
879 {
880 Some(ix)
881 } else {
882 // If no selection after selection head, return the last match
883 Some(matches.len().saturating_sub(1))
884 }
885 } else {
886 // Matches found but no active selection, return the first last one (closest to cursor)
887 Some(matches.len().saturating_sub(1))
888 }
889 } else {
890 None
891 };
892
893 res
894 }
895 fn replace(&mut self, _: &Self::Match, _: &SearchQuery, _: &mut ViewContext<Self>) {
896 // Replacement is not supported in terminal view, so this is a no-op.
897 }
898}
899
900///Get's the working directory for the given workspace, respecting the user's settings.
901pub fn get_working_directory(
902 workspace: &Workspace,
903 cx: &AppContext,
904 strategy: WorkingDirectory,
905) -> Option<PathBuf> {
906 let res = match strategy {
907 WorkingDirectory::CurrentProjectDirectory => current_project_directory(workspace, cx)
908 .or_else(|| first_project_directory(workspace, cx)),
909 WorkingDirectory::FirstProjectDirectory => first_project_directory(workspace, cx),
910 WorkingDirectory::AlwaysHome => None,
911 WorkingDirectory::Always { directory } => {
912 shellexpand::full(&directory) //TODO handle this better
913 .ok()
914 .map(|dir| Path::new(&dir.to_string()).to_path_buf())
915 .filter(|dir| dir.is_dir())
916 }
917 };
918 res.or_else(home_dir)
919}
920
921///Get's the first project's home directory, or the home directory
922fn first_project_directory(workspace: &Workspace, cx: &AppContext) -> Option<PathBuf> {
923 workspace
924 .worktrees(cx)
925 .next()
926 .and_then(|worktree_handle| worktree_handle.read(cx).as_local())
927 .and_then(get_path_from_wt)
928}
929
930///Gets the intuitively correct working directory from the given workspace
931///If there is an active entry for this project, returns that entry's worktree root.
932///If there's no active entry but there is a worktree, returns that worktrees root.
933///If either of these roots are files, or if there are any other query failures,
934/// returns the user's home directory
935fn current_project_directory(workspace: &Workspace, cx: &AppContext) -> Option<PathBuf> {
936 let project = workspace.project().read(cx);
937
938 project
939 .active_entry()
940 .and_then(|entry_id| project.worktree_for_entry(entry_id, cx))
941 .or_else(|| workspace.worktrees(cx).next())
942 .and_then(|worktree_handle| worktree_handle.read(cx).as_local())
943 .and_then(get_path_from_wt)
944}
945
946fn get_path_from_wt(wt: &LocalWorktree) -> Option<PathBuf> {
947 wt.root_entry()
948 .filter(|re| re.is_dir())
949 .map(|_| wt.abs_path().to_path_buf())
950}
951
952#[cfg(test)]
953mod tests {
954 use super::*;
955 use gpui::TestAppContext;
956 use project::{Entry, Project, ProjectPath, Worktree};
957 use std::path::Path;
958 use workspace::AppState;
959
960 // Working directory calculation tests
961
962 // No Worktrees in project -> home_dir()
963 #[gpui::test]
964 async fn no_worktree(cx: &mut TestAppContext) {
965 let (project, workspace) = init_test(cx).await;
966 cx.read(|cx| {
967 let workspace = workspace.read(cx);
968 let active_entry = project.read(cx).active_entry();
969
970 //Make sure environment is as expected
971 assert!(active_entry.is_none());
972 assert!(workspace.worktrees(cx).next().is_none());
973
974 let res = current_project_directory(workspace, cx);
975 assert_eq!(res, None);
976 let res = first_project_directory(workspace, cx);
977 assert_eq!(res, None);
978 });
979 }
980
981 // No active entry, but a worktree, worktree is a file -> home_dir()
982 #[gpui::test]
983 async fn no_active_entry_worktree_is_file(cx: &mut TestAppContext) {
984 let (project, workspace) = init_test(cx).await;
985
986 create_file_wt(project.clone(), "/root.txt", cx).await;
987 cx.read(|cx| {
988 let workspace = workspace.read(cx);
989 let active_entry = project.read(cx).active_entry();
990
991 //Make sure environment is as expected
992 assert!(active_entry.is_none());
993 assert!(workspace.worktrees(cx).next().is_some());
994
995 let res = current_project_directory(workspace, cx);
996 assert_eq!(res, None);
997 let res = first_project_directory(workspace, cx);
998 assert_eq!(res, None);
999 });
1000 }
1001
1002 // No active entry, but a worktree, worktree is a folder -> worktree_folder
1003 #[gpui::test]
1004 async fn no_active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1005 let (project, workspace) = init_test(cx).await;
1006
1007 let (_wt, _entry) = create_folder_wt(project.clone(), "/root/", cx).await;
1008 cx.update(|cx| {
1009 let workspace = workspace.read(cx);
1010 let active_entry = project.read(cx).active_entry();
1011
1012 assert!(active_entry.is_none());
1013 assert!(workspace.worktrees(cx).next().is_some());
1014
1015 let res = current_project_directory(workspace, cx);
1016 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1017 let res = first_project_directory(workspace, cx);
1018 assert_eq!(res, Some((Path::new("/root/")).to_path_buf()));
1019 });
1020 }
1021
1022 // Active entry with a work tree, worktree is a file -> home_dir()
1023 #[gpui::test]
1024 async fn active_entry_worktree_is_file(cx: &mut TestAppContext) {
1025 let (project, workspace) = init_test(cx).await;
1026
1027 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1028 let (wt2, entry2) = create_file_wt(project.clone(), "/root2.txt", cx).await;
1029 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1030
1031 cx.update(|cx| {
1032 let workspace = workspace.read(cx);
1033 let active_entry = project.read(cx).active_entry();
1034
1035 assert!(active_entry.is_some());
1036
1037 let res = current_project_directory(workspace, cx);
1038 assert_eq!(res, None);
1039 let res = first_project_directory(workspace, cx);
1040 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1041 });
1042 }
1043
1044 // Active entry, with a worktree, worktree is a folder -> worktree_folder
1045 #[gpui::test]
1046 async fn active_entry_worktree_is_dir(cx: &mut TestAppContext) {
1047 let (project, workspace) = init_test(cx).await;
1048
1049 let (_wt, _entry) = create_folder_wt(project.clone(), "/root1/", cx).await;
1050 let (wt2, entry2) = create_folder_wt(project.clone(), "/root2/", cx).await;
1051 insert_active_entry_for(wt2, entry2, project.clone(), cx);
1052
1053 cx.update(|cx| {
1054 let workspace = workspace.read(cx);
1055 let active_entry = project.read(cx).active_entry();
1056
1057 assert!(active_entry.is_some());
1058
1059 let res = current_project_directory(workspace, cx);
1060 assert_eq!(res, Some((Path::new("/root2/")).to_path_buf()));
1061 let res = first_project_directory(workspace, cx);
1062 assert_eq!(res, Some((Path::new("/root1/")).to_path_buf()));
1063 });
1064 }
1065
1066 /// Creates a worktree with 1 file: /root.txt
1067 pub async fn init_test(cx: &mut TestAppContext) -> (Model<Project>, View<Workspace>) {
1068 let params = cx.update(AppState::test);
1069 cx.update(|cx| {
1070 theme::init(theme::LoadThemes::JustBase, cx);
1071 Project::init_settings(cx);
1072 language::init(cx);
1073 });
1074
1075 let project = Project::test(params.fs.clone(), [], cx).await;
1076 let workspace = cx
1077 .add_window(|cx| Workspace::test_new(project.clone(), cx))
1078 .root_view(cx)
1079 .unwrap();
1080
1081 (project, workspace)
1082 }
1083
1084 /// Creates a worktree with 1 folder: /root{suffix}/
1085 async fn create_folder_wt(
1086 project: Model<Project>,
1087 path: impl AsRef<Path>,
1088 cx: &mut TestAppContext,
1089 ) -> (Model<Worktree>, Entry) {
1090 create_wt(project, true, path, cx).await
1091 }
1092
1093 /// Creates a worktree with 1 file: /root{suffix}.txt
1094 async fn create_file_wt(
1095 project: Model<Project>,
1096 path: impl AsRef<Path>,
1097 cx: &mut TestAppContext,
1098 ) -> (Model<Worktree>, Entry) {
1099 create_wt(project, false, path, cx).await
1100 }
1101
1102 async fn create_wt(
1103 project: Model<Project>,
1104 is_dir: bool,
1105 path: impl AsRef<Path>,
1106 cx: &mut TestAppContext,
1107 ) -> (Model<Worktree>, Entry) {
1108 let (wt, _) = project
1109 .update(cx, |project, cx| {
1110 project.find_or_create_local_worktree(path, true, cx)
1111 })
1112 .await
1113 .unwrap();
1114
1115 let entry = cx
1116 .update(|cx| {
1117 wt.update(cx, |wt, cx| {
1118 wt.as_local()
1119 .unwrap()
1120 .create_entry(Path::new(""), is_dir, cx)
1121 })
1122 })
1123 .await
1124 .unwrap()
1125 .unwrap();
1126
1127 (wt, entry)
1128 }
1129
1130 pub fn insert_active_entry_for(
1131 wt: Model<Worktree>,
1132 entry: Entry,
1133 project: Model<Project>,
1134 cx: &mut TestAppContext,
1135 ) {
1136 cx.update(|cx| {
1137 let p = ProjectPath {
1138 worktree_id: wt.read(cx).id(),
1139 path: entry.path,
1140 };
1141 project.update(cx, |project, cx| project.set_active_path(Some(p), cx));
1142 });
1143 }
1144}