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