1use super::{ItemHandle, SplitDirection};
2use crate::{toolbar::Toolbar, Item, WeakItemHandle, Workspace};
3use anyhow::Result;
4use collections::{HashMap, VecDeque};
5use futures::StreamExt;
6use gpui::{
7 action,
8 elements::*,
9 geometry::{rect::RectF, vector::vec2f},
10 keymap::Binding,
11 platform::{CursorStyle, NavigationDirection},
12 AppContext, Entity, MutableAppContext, PromptLevel, Quad, RenderContext, Task, View,
13 ViewContext, ViewHandle, WeakViewHandle,
14};
15use project::{ProjectEntryId, ProjectPath};
16use settings::Settings;
17use std::{any::Any, cell::RefCell, cmp, mem, path::Path, rc::Rc};
18use util::ResultExt;
19
20action!(Split, SplitDirection);
21action!(ActivateItem, usize);
22action!(ActivatePrevItem);
23action!(ActivateNextItem);
24action!(CloseActiveItem);
25action!(CloseInactiveItems);
26action!(CloseItem, CloseItemParams);
27action!(GoBack, Option<WeakViewHandle<Pane>>);
28action!(GoForward, Option<WeakViewHandle<Pane>>);
29
30#[derive(Clone)]
31pub struct CloseItemParams {
32 pub item_id: usize,
33 pub pane: WeakViewHandle<Pane>,
34}
35
36const MAX_NAVIGATION_HISTORY_LEN: usize = 1024;
37
38pub fn init(cx: &mut MutableAppContext) {
39 cx.add_action(|pane: &mut Pane, action: &ActivateItem, cx| {
40 pane.activate_item(action.0, true, cx);
41 });
42 cx.add_action(|pane: &mut Pane, _: &ActivatePrevItem, cx| {
43 pane.activate_prev_item(cx);
44 });
45 cx.add_action(|pane: &mut Pane, _: &ActivateNextItem, cx| {
46 pane.activate_next_item(cx);
47 });
48 cx.add_async_action(Pane::close_active_item);
49 cx.add_async_action(Pane::close_inactive_items);
50 cx.add_async_action(|workspace: &mut Workspace, action: &CloseItem, cx| {
51 let pane = action.0.pane.upgrade(cx)?;
52 Some(Pane::close_item(workspace, pane, action.0.item_id, cx))
53 });
54 cx.add_action(|pane: &mut Pane, action: &Split, cx| {
55 pane.split(action.0, cx);
56 });
57 cx.add_action(|workspace: &mut Workspace, action: &GoBack, cx| {
58 Pane::go_back(
59 workspace,
60 action
61 .0
62 .as_ref()
63 .and_then(|weak_handle| weak_handle.upgrade(cx)),
64 cx,
65 )
66 .detach();
67 });
68 cx.add_action(|workspace: &mut Workspace, action: &GoForward, cx| {
69 Pane::go_forward(
70 workspace,
71 action
72 .0
73 .as_ref()
74 .and_then(|weak_handle| weak_handle.upgrade(cx)),
75 cx,
76 )
77 .detach();
78 });
79
80 cx.add_bindings(vec![
81 Binding::new("shift-cmd-{", ActivatePrevItem, Some("Pane")),
82 Binding::new("shift-cmd-}", ActivateNextItem, Some("Pane")),
83 Binding::new("cmd-w", CloseActiveItem, Some("Pane")),
84 Binding::new("alt-cmd-w", CloseInactiveItems, Some("Pane")),
85 Binding::new("cmd-k up", Split(SplitDirection::Up), Some("Pane")),
86 Binding::new("cmd-k down", Split(SplitDirection::Down), Some("Pane")),
87 Binding::new("cmd-k left", Split(SplitDirection::Left), Some("Pane")),
88 Binding::new("cmd-k right", Split(SplitDirection::Right), Some("Pane")),
89 Binding::new("ctrl--", GoBack(None), Some("Pane")),
90 Binding::new("shift-ctrl-_", GoForward(None), Some("Pane")),
91 ]);
92}
93
94pub enum Event {
95 Activate,
96 ActivateItem { local: bool },
97 Remove,
98 Split(SplitDirection),
99}
100
101pub struct Pane {
102 items: Vec<Box<dyn ItemHandle>>,
103 active_item_index: usize,
104 autoscroll: bool,
105 nav_history: Rc<RefCell<NavHistory>>,
106 toolbar: ViewHandle<Toolbar>,
107}
108
109pub struct ItemNavHistory {
110 history: Rc<RefCell<NavHistory>>,
111 item: Rc<dyn WeakItemHandle>,
112}
113
114#[derive(Default)]
115pub struct NavHistory {
116 mode: NavigationMode,
117 backward_stack: VecDeque<NavigationEntry>,
118 forward_stack: VecDeque<NavigationEntry>,
119 paths_by_item: HashMap<usize, ProjectPath>,
120}
121
122#[derive(Copy, Clone)]
123enum NavigationMode {
124 Normal,
125 GoingBack,
126 GoingForward,
127 Disabled,
128}
129
130impl Default for NavigationMode {
131 fn default() -> Self {
132 Self::Normal
133 }
134}
135
136pub struct NavigationEntry {
137 pub item: Rc<dyn WeakItemHandle>,
138 pub data: Option<Box<dyn Any>>,
139}
140
141impl Pane {
142 pub fn new(cx: &mut ViewContext<Self>) -> Self {
143 Self {
144 items: Vec::new(),
145 active_item_index: 0,
146 autoscroll: false,
147 nav_history: Default::default(),
148 toolbar: cx.add_view(|_| Toolbar::new()),
149 }
150 }
151
152 pub fn nav_history(&self) -> &Rc<RefCell<NavHistory>> {
153 &self.nav_history
154 }
155
156 pub fn activate(&self, cx: &mut ViewContext<Self>) {
157 cx.emit(Event::Activate);
158 }
159
160 pub fn go_back(
161 workspace: &mut Workspace,
162 pane: Option<ViewHandle<Pane>>,
163 cx: &mut ViewContext<Workspace>,
164 ) -> Task<()> {
165 Self::navigate_history(
166 workspace,
167 pane.unwrap_or_else(|| workspace.active_pane().clone()),
168 NavigationMode::GoingBack,
169 cx,
170 )
171 }
172
173 pub fn go_forward(
174 workspace: &mut Workspace,
175 pane: Option<ViewHandle<Pane>>,
176 cx: &mut ViewContext<Workspace>,
177 ) -> Task<()> {
178 Self::navigate_history(
179 workspace,
180 pane.unwrap_or_else(|| workspace.active_pane().clone()),
181 NavigationMode::GoingForward,
182 cx,
183 )
184 }
185
186 fn navigate_history(
187 workspace: &mut Workspace,
188 pane: ViewHandle<Pane>,
189 mode: NavigationMode,
190 cx: &mut ViewContext<Workspace>,
191 ) -> Task<()> {
192 workspace.activate_pane(pane.clone(), cx);
193
194 let to_load = pane.update(cx, |pane, cx| {
195 loop {
196 // Retrieve the weak item handle from the history.
197 let entry = pane.nav_history.borrow_mut().pop(mode)?;
198
199 // If the item is still present in this pane, then activate it.
200 if let Some(index) = entry
201 .item
202 .upgrade(cx)
203 .and_then(|v| pane.index_for_item(v.as_ref()))
204 {
205 let prev_active_item_index = pane.active_item_index;
206 pane.nav_history.borrow_mut().set_mode(mode);
207 pane.activate_item(index, true, cx);
208 pane.nav_history
209 .borrow_mut()
210 .set_mode(NavigationMode::Normal);
211
212 let mut navigated = prev_active_item_index != pane.active_item_index;
213 if let Some(data) = entry.data {
214 navigated |= pane.active_item()?.navigate(data, cx);
215 }
216
217 if navigated {
218 break None;
219 }
220 }
221 // If the item is no longer present in this pane, then retrieve its
222 // project path in order to reopen it.
223 else {
224 break pane
225 .nav_history
226 .borrow_mut()
227 .paths_by_item
228 .get(&entry.item.id())
229 .cloned()
230 .map(|project_path| (project_path, entry));
231 }
232 }
233 });
234
235 if let Some((project_path, entry)) = to_load {
236 // If the item was no longer present, then load it again from its previous path.
237 let pane = pane.downgrade();
238 let task = workspace.load_path(project_path, cx);
239 cx.spawn(|workspace, mut cx| async move {
240 let task = task.await;
241 if let Some(pane) = pane.upgrade(&cx) {
242 if let Some((project_entry_id, build_item)) = task.log_err() {
243 pane.update(&mut cx, |pane, _| {
244 pane.nav_history.borrow_mut().set_mode(mode);
245 });
246 let item = workspace.update(&mut cx, |workspace, cx| {
247 Self::open_item(
248 workspace,
249 pane.clone(),
250 project_entry_id,
251 cx,
252 build_item,
253 )
254 });
255 pane.update(&mut cx, |pane, cx| {
256 pane.nav_history
257 .borrow_mut()
258 .set_mode(NavigationMode::Normal);
259 if let Some(data) = entry.data {
260 item.navigate(data, cx);
261 }
262 });
263 } else {
264 workspace
265 .update(&mut cx, |workspace, cx| {
266 Self::navigate_history(workspace, pane, mode, cx)
267 })
268 .await;
269 }
270 }
271 })
272 } else {
273 Task::ready(())
274 }
275 }
276
277 pub(crate) fn open_item(
278 workspace: &mut Workspace,
279 pane: ViewHandle<Pane>,
280 project_entry_id: ProjectEntryId,
281 cx: &mut ViewContext<Workspace>,
282 build_item: impl FnOnce(&mut MutableAppContext) -> Box<dyn ItemHandle>,
283 ) -> Box<dyn ItemHandle> {
284 let existing_item = pane.update(cx, |pane, cx| {
285 for (ix, item) in pane.items.iter().enumerate() {
286 if item.project_entry_id(cx) == Some(project_entry_id) {
287 let item = item.boxed_clone();
288 pane.activate_item(ix, true, cx);
289 return Some(item);
290 }
291 }
292 None
293 });
294 if let Some(existing_item) = existing_item {
295 existing_item
296 } else {
297 let item = build_item(cx);
298 Self::add_item(workspace, pane, item.boxed_clone(), true, cx);
299 item
300 }
301 }
302
303 pub(crate) fn add_item(
304 workspace: &mut Workspace,
305 pane: ViewHandle<Pane>,
306 item: Box<dyn ItemHandle>,
307 local: bool,
308 cx: &mut ViewContext<Workspace>,
309 ) {
310 // Prevent adding the same item to the pane more than once.
311 if let Some(item_ix) = pane.read(cx).items.iter().position(|i| i.id() == item.id()) {
312 pane.update(cx, |pane, cx| pane.activate_item(item_ix, local, cx));
313 return;
314 }
315
316 item.set_nav_history(pane.read(cx).nav_history.clone(), cx);
317 item.added_to_pane(workspace, pane.clone(), cx);
318 pane.update(cx, |pane, cx| {
319 let item_idx = cmp::min(pane.active_item_index + 1, pane.items.len());
320 pane.items.insert(item_idx, item);
321 pane.activate_item(item_idx, local, cx);
322 cx.notify();
323 });
324 }
325
326 pub fn items(&self) -> impl Iterator<Item = &Box<dyn ItemHandle>> {
327 self.items.iter()
328 }
329
330 pub fn items_of_type<'a, T: View>(&'a self) -> impl 'a + Iterator<Item = ViewHandle<T>> {
331 self.items
332 .iter()
333 .filter_map(|item| item.to_any().downcast())
334 }
335
336 pub fn active_item(&self) -> Option<Box<dyn ItemHandle>> {
337 self.items.get(self.active_item_index).cloned()
338 }
339
340 pub fn project_entry_id_for_item(
341 &self,
342 item: &dyn ItemHandle,
343 cx: &AppContext,
344 ) -> Option<ProjectEntryId> {
345 self.items.iter().find_map(|existing| {
346 if existing.id() == item.id() {
347 existing.project_entry_id(cx)
348 } else {
349 None
350 }
351 })
352 }
353
354 pub fn item_for_entry(
355 &self,
356 entry_id: ProjectEntryId,
357 cx: &AppContext,
358 ) -> Option<Box<dyn ItemHandle>> {
359 self.items.iter().find_map(|item| {
360 if item.project_entry_id(cx) == Some(entry_id) {
361 Some(item.boxed_clone())
362 } else {
363 None
364 }
365 })
366 }
367
368 pub fn index_for_item(&self, item: &dyn ItemHandle) -> Option<usize> {
369 self.items.iter().position(|i| i.id() == item.id())
370 }
371
372 pub fn activate_item(&mut self, index: usize, local: bool, cx: &mut ViewContext<Self>) {
373 use NavigationMode::{GoingBack, GoingForward};
374 if index < self.items.len() {
375 let prev_active_item_ix = mem::replace(&mut self.active_item_index, index);
376 if matches!(self.nav_history.borrow().mode, GoingBack | GoingForward)
377 || (prev_active_item_ix != self.active_item_index
378 && prev_active_item_ix < self.items.len())
379 {
380 self.items[prev_active_item_ix].deactivated(cx);
381 cx.emit(Event::ActivateItem { local });
382 }
383 self.update_toolbar(cx);
384 if local {
385 self.focus_active_item(cx);
386 self.activate(cx);
387 }
388 self.autoscroll = true;
389 cx.notify();
390 }
391 }
392
393 pub fn activate_prev_item(&mut self, cx: &mut ViewContext<Self>) {
394 let mut index = self.active_item_index;
395 if index > 0 {
396 index -= 1;
397 } else if self.items.len() > 0 {
398 index = self.items.len() - 1;
399 }
400 self.activate_item(index, true, cx);
401 }
402
403 pub fn activate_next_item(&mut self, cx: &mut ViewContext<Self>) {
404 let mut index = self.active_item_index;
405 if index + 1 < self.items.len() {
406 index += 1;
407 } else {
408 index = 0;
409 }
410 self.activate_item(index, true, cx);
411 }
412
413 fn close_active_item(
414 workspace: &mut Workspace,
415 _: &CloseActiveItem,
416 cx: &mut ViewContext<Workspace>,
417 ) -> Option<Task<Result<()>>> {
418 let pane_handle = workspace.active_pane().clone();
419 let pane = pane_handle.read(cx);
420 if pane.items.is_empty() {
421 None
422 } else {
423 let item_id_to_close = pane.items[pane.active_item_index].id();
424 Some(Self::close_items(
425 workspace,
426 pane_handle,
427 cx,
428 move |item_id| item_id == item_id_to_close,
429 ))
430 }
431 }
432
433 pub fn close_inactive_items(
434 workspace: &mut Workspace,
435 _: &CloseInactiveItems,
436 cx: &mut ViewContext<Workspace>,
437 ) -> Option<Task<Result<()>>> {
438 let pane_handle = workspace.active_pane().clone();
439 let pane = pane_handle.read(cx);
440 if pane.items.is_empty() {
441 None
442 } else {
443 let active_item_id = pane.items[pane.active_item_index].id();
444 Some(Self::close_items(workspace, pane_handle, cx, move |id| {
445 id != active_item_id
446 }))
447 }
448 }
449
450 pub fn close_item(
451 workspace: &mut Workspace,
452 pane: ViewHandle<Pane>,
453 item_id_to_close: usize,
454 cx: &mut ViewContext<Workspace>,
455 ) -> Task<Result<()>> {
456 Self::close_items(workspace, pane, cx, move |view_id| {
457 view_id == item_id_to_close
458 })
459 }
460
461 pub fn close_items(
462 workspace: &mut Workspace,
463 pane: ViewHandle<Pane>,
464 cx: &mut ViewContext<Workspace>,
465 should_close: impl 'static + Fn(usize) -> bool,
466 ) -> Task<Result<()>> {
467 const CONFLICT_MESSAGE: &'static str = "This file has changed on disk since you started editing it. Do you want to overwrite it?";
468 const DIRTY_MESSAGE: &'static str =
469 "This file contains unsaved edits. Do you want to save it?";
470
471 let project = workspace.project().clone();
472 cx.spawn(|workspace, mut cx| async move {
473 while let Some(item_to_close_ix) = pane.read_with(&cx, |pane, _| {
474 pane.items.iter().position(|item| should_close(item.id()))
475 }) {
476 let item =
477 pane.read_with(&cx, |pane, _| pane.items[item_to_close_ix].boxed_clone());
478
479 let is_last_item_for_entry = workspace.read_with(&cx, |workspace, cx| {
480 let project_entry_id = item.project_entry_id(cx);
481 project_entry_id.is_none()
482 || workspace
483 .items(cx)
484 .filter(|item| item.project_entry_id(cx) == project_entry_id)
485 .count()
486 == 1
487 });
488
489 if is_last_item_for_entry {
490 if cx.read(|cx| item.has_conflict(cx) && item.can_save(cx)) {
491 let mut answer = pane.update(&mut cx, |pane, cx| {
492 pane.activate_item(item_to_close_ix, true, cx);
493 cx.prompt(
494 PromptLevel::Warning,
495 CONFLICT_MESSAGE,
496 &["Overwrite", "Discard", "Cancel"],
497 )
498 });
499
500 match answer.next().await {
501 Some(0) => {
502 cx.update(|cx| item.save(project.clone(), cx)).await?;
503 }
504 Some(1) => {
505 cx.update(|cx| item.reload(project.clone(), cx)).await?;
506 }
507 _ => break,
508 }
509 } else if cx.read(|cx| item.is_dirty(cx)) {
510 if cx.read(|cx| item.can_save(cx)) {
511 let mut answer = pane.update(&mut cx, |pane, cx| {
512 pane.activate_item(item_to_close_ix, true, cx);
513 cx.prompt(
514 PromptLevel::Warning,
515 DIRTY_MESSAGE,
516 &["Save", "Don't Save", "Cancel"],
517 )
518 });
519
520 match answer.next().await {
521 Some(0) => {
522 cx.update(|cx| item.save(project.clone(), cx)).await?;
523 }
524 Some(1) => {}
525 _ => break,
526 }
527 } else if cx.read(|cx| item.can_save_as(cx)) {
528 let mut answer = pane.update(&mut cx, |pane, cx| {
529 pane.activate_item(item_to_close_ix, true, cx);
530 cx.prompt(
531 PromptLevel::Warning,
532 DIRTY_MESSAGE,
533 &["Save", "Don't Save", "Cancel"],
534 )
535 });
536
537 match answer.next().await {
538 Some(0) => {
539 let start_abs_path = project
540 .read_with(&cx, |project, cx| {
541 let worktree = project.visible_worktrees(cx).next()?;
542 Some(
543 worktree
544 .read(cx)
545 .as_local()?
546 .abs_path()
547 .to_path_buf(),
548 )
549 })
550 .unwrap_or(Path::new("").into());
551
552 let mut abs_path =
553 cx.update(|cx| cx.prompt_for_new_path(&start_abs_path));
554 if let Some(abs_path) = abs_path.next().await.flatten() {
555 cx.update(|cx| item.save_as(project.clone(), abs_path, cx))
556 .await?;
557 } else {
558 break;
559 }
560 }
561 Some(1) => {}
562 _ => break,
563 }
564 }
565 }
566 }
567
568 pane.update(&mut cx, |pane, cx| {
569 if let Some(item_ix) = pane.items.iter().position(|i| i.id() == item.id()) {
570 if item_ix == pane.active_item_index {
571 if item_ix + 1 < pane.items.len() {
572 pane.activate_next_item(cx);
573 } else if item_ix > 0 {
574 pane.activate_prev_item(cx);
575 }
576 }
577
578 let item = pane.items.remove(item_ix);
579 if pane.items.is_empty() {
580 item.deactivated(cx);
581 pane.update_toolbar(cx);
582 cx.emit(Event::Remove);
583 }
584
585 if item_ix < pane.active_item_index {
586 pane.active_item_index -= 1;
587 }
588
589 let mut nav_history = pane.nav_history.borrow_mut();
590 if let Some(path) = item.project_path(cx) {
591 nav_history.paths_by_item.insert(item.id(), path);
592 } else {
593 nav_history.paths_by_item.remove(&item.id());
594 }
595 }
596 });
597 }
598
599 pane.update(&mut cx, |_, cx| cx.notify());
600 Ok(())
601 })
602 }
603
604 pub fn focus_active_item(&mut self, cx: &mut ViewContext<Self>) {
605 if let Some(active_item) = self.active_item() {
606 cx.focus(active_item);
607 }
608 }
609
610 pub fn split(&mut self, direction: SplitDirection, cx: &mut ViewContext<Self>) {
611 cx.emit(Event::Split(direction));
612 }
613
614 pub fn toolbar(&self) -> &ViewHandle<Toolbar> {
615 &self.toolbar
616 }
617
618 fn update_toolbar(&mut self, cx: &mut ViewContext<Self>) {
619 let active_item = self
620 .items
621 .get(self.active_item_index)
622 .map(|item| item.as_ref());
623 self.toolbar.update(cx, |toolbar, cx| {
624 toolbar.set_active_pane_item(active_item, cx);
625 });
626 }
627
628 fn render_tabs(&mut self, cx: &mut RenderContext<Self>) -> ElementBox {
629 let theme = cx.global::<Settings>().theme.clone();
630
631 enum Tabs {}
632 let pane = cx.handle();
633 let tabs = MouseEventHandler::new::<Tabs, _, _>(0, cx, |mouse_state, cx| {
634 let autoscroll = if mem::take(&mut self.autoscroll) {
635 Some(self.active_item_index)
636 } else {
637 None
638 };
639 let mut row = Flex::row().scrollable::<Tabs, _>(1, autoscroll, cx);
640 for (ix, item) in self.items.iter().enumerate() {
641 let is_active = ix == self.active_item_index;
642
643 row.add_child({
644 let tab_style = if is_active {
645 theme.workspace.active_tab.clone()
646 } else {
647 theme.workspace.tab.clone()
648 };
649 let title = item.tab_content(&tab_style, cx);
650
651 let mut style = if is_active {
652 theme.workspace.active_tab.clone()
653 } else {
654 theme.workspace.tab.clone()
655 };
656 if ix == 0 {
657 style.container.border.left = false;
658 }
659
660 EventHandler::new(
661 Container::new(
662 Flex::row()
663 .with_child(
664 Align::new({
665 let diameter = 7.0;
666 let icon_color = if item.has_conflict(cx) {
667 Some(style.icon_conflict)
668 } else if item.is_dirty(cx) {
669 Some(style.icon_dirty)
670 } else {
671 None
672 };
673
674 ConstrainedBox::new(
675 Canvas::new(move |bounds, _, cx| {
676 if let Some(color) = icon_color {
677 let square = RectF::new(
678 bounds.origin(),
679 vec2f(diameter, diameter),
680 );
681 cx.scene.push_quad(Quad {
682 bounds: square,
683 background: Some(color),
684 border: Default::default(),
685 corner_radius: diameter / 2.,
686 });
687 }
688 })
689 .boxed(),
690 )
691 .with_width(diameter)
692 .with_height(diameter)
693 .boxed()
694 })
695 .boxed(),
696 )
697 .with_child(
698 Container::new(Align::new(title).boxed())
699 .with_style(ContainerStyle {
700 margin: Margin {
701 left: style.spacing,
702 right: style.spacing,
703 ..Default::default()
704 },
705 ..Default::default()
706 })
707 .boxed(),
708 )
709 .with_child(
710 Align::new(
711 ConstrainedBox::new(if mouse_state.hovered {
712 let item_id = item.id();
713 enum TabCloseButton {}
714 let icon = Svg::new("icons/x.svg");
715 MouseEventHandler::new::<TabCloseButton, _, _>(
716 item_id,
717 cx,
718 |mouse_state, _| {
719 if mouse_state.hovered {
720 icon.with_color(style.icon_close_active)
721 .boxed()
722 } else {
723 icon.with_color(style.icon_close).boxed()
724 }
725 },
726 )
727 .with_padding(Padding::uniform(4.))
728 .with_cursor_style(CursorStyle::PointingHand)
729 .on_click({
730 let pane = pane.clone();
731 move |cx| {
732 cx.dispatch_action(CloseItem(CloseItemParams {
733 item_id,
734 pane: pane.clone(),
735 }))
736 }
737 })
738 .named("close-tab-icon")
739 } else {
740 Empty::new().boxed()
741 })
742 .with_width(style.icon_width)
743 .boxed(),
744 )
745 .boxed(),
746 )
747 .boxed(),
748 )
749 .with_style(style.container)
750 .boxed(),
751 )
752 .on_mouse_down(move |cx| {
753 cx.dispatch_action(ActivateItem(ix));
754 true
755 })
756 .boxed()
757 })
758 }
759
760 row.add_child(
761 Empty::new()
762 .contained()
763 .with_border(theme.workspace.tab.container.border)
764 .flex(0., true)
765 .named("filler"),
766 );
767
768 row.boxed()
769 });
770
771 ConstrainedBox::new(tabs.boxed())
772 .with_height(theme.workspace.tab.height)
773 .named("tabs")
774 }
775}
776
777impl Entity for Pane {
778 type Event = Event;
779}
780
781impl View for Pane {
782 fn ui_name() -> &'static str {
783 "Pane"
784 }
785
786 fn render(&mut self, cx: &mut RenderContext<Self>) -> ElementBox {
787 let this = cx.handle();
788
789 EventHandler::new(if let Some(active_item) = self.active_item() {
790 Flex::column()
791 .with_child(self.render_tabs(cx))
792 .with_child(ChildView::new(&self.toolbar).boxed())
793 .with_child(ChildView::new(active_item).flex(1., true).boxed())
794 .boxed()
795 } else {
796 Empty::new().boxed()
797 })
798 .on_navigate_mouse_down(move |direction, cx| {
799 let this = this.clone();
800 match direction {
801 NavigationDirection::Back => cx.dispatch_action(GoBack(Some(this))),
802 NavigationDirection::Forward => cx.dispatch_action(GoForward(Some(this))),
803 }
804
805 true
806 })
807 .named("pane")
808 }
809
810 fn on_focus(&mut self, cx: &mut ViewContext<Self>) {
811 self.focus_active_item(cx);
812 }
813}
814
815impl ItemNavHistory {
816 pub fn new<T: Item>(history: Rc<RefCell<NavHistory>>, item: &ViewHandle<T>) -> Self {
817 Self {
818 history,
819 item: Rc::new(item.downgrade()),
820 }
821 }
822
823 pub fn history(&self) -> Rc<RefCell<NavHistory>> {
824 self.history.clone()
825 }
826
827 pub fn push<D: 'static + Any>(&self, data: Option<D>) {
828 self.history.borrow_mut().push(data, self.item.clone());
829 }
830}
831
832impl NavHistory {
833 pub fn disable(&mut self) {
834 self.mode = NavigationMode::Disabled;
835 }
836
837 pub fn enable(&mut self) {
838 self.mode = NavigationMode::Normal;
839 }
840
841 pub fn pop_backward(&mut self) -> Option<NavigationEntry> {
842 self.backward_stack.pop_back()
843 }
844
845 pub fn pop_forward(&mut self) -> Option<NavigationEntry> {
846 self.forward_stack.pop_back()
847 }
848
849 fn pop(&mut self, mode: NavigationMode) -> Option<NavigationEntry> {
850 match mode {
851 NavigationMode::Normal | NavigationMode::Disabled => None,
852 NavigationMode::GoingBack => self.pop_backward(),
853 NavigationMode::GoingForward => self.pop_forward(),
854 }
855 }
856
857 fn set_mode(&mut self, mode: NavigationMode) {
858 self.mode = mode;
859 }
860
861 pub fn push<D: 'static + Any>(&mut self, data: Option<D>, item: Rc<dyn WeakItemHandle>) {
862 match self.mode {
863 NavigationMode::Disabled => {}
864 NavigationMode::Normal => {
865 if self.backward_stack.len() >= MAX_NAVIGATION_HISTORY_LEN {
866 self.backward_stack.pop_front();
867 }
868 self.backward_stack.push_back(NavigationEntry {
869 item,
870 data: data.map(|data| Box::new(data) as Box<dyn Any>),
871 });
872 self.forward_stack.clear();
873 }
874 NavigationMode::GoingBack => {
875 if self.forward_stack.len() >= MAX_NAVIGATION_HISTORY_LEN {
876 self.forward_stack.pop_front();
877 }
878 self.forward_stack.push_back(NavigationEntry {
879 item,
880 data: data.map(|data| Box::new(data) as Box<dyn Any>),
881 });
882 }
883 NavigationMode::GoingForward => {
884 if self.backward_stack.len() >= MAX_NAVIGATION_HISTORY_LEN {
885 self.backward_stack.pop_front();
886 }
887 self.backward_stack.push_back(NavigationEntry {
888 item,
889 data: data.map(|data| Box::new(data) as Box<dyn Any>),
890 });
891 }
892 }
893 }
894}
895
896#[cfg(test)]
897mod tests {
898 use super::*;
899 use crate::WorkspaceParams;
900 use gpui::{ModelHandle, TestAppContext, ViewContext};
901 use project::Project;
902 use std::sync::atomic::AtomicUsize;
903
904 #[gpui::test]
905 async fn test_close_items(cx: &mut TestAppContext) {
906 cx.foreground().forbid_parking();
907
908 let params = cx.update(WorkspaceParams::test);
909 let (window_id, workspace) = cx.add_window(|cx| Workspace::new(¶ms, cx));
910 let item1 = cx.add_view(window_id, |_| {
911 let mut item = TestItem::new();
912 item.is_dirty = true;
913 item
914 });
915 let item2 = cx.add_view(window_id, |_| {
916 let mut item = TestItem::new();
917 item.is_dirty = true;
918 item.has_conflict = true;
919 item
920 });
921 let item3 = cx.add_view(window_id, |_| {
922 let mut item = TestItem::new();
923 item.is_dirty = true;
924 item.has_conflict = true;
925 item
926 });
927 let item4 = cx.add_view(window_id, |_| {
928 let mut item = TestItem::new();
929 item.is_dirty = true;
930 item.can_save = false;
931 item
932 });
933 let pane = workspace.update(cx, |workspace, cx| {
934 workspace.add_item(Box::new(item1.clone()), cx);
935 workspace.add_item(Box::new(item2.clone()), cx);
936 workspace.add_item(Box::new(item3.clone()), cx);
937 workspace.add_item(Box::new(item4.clone()), cx);
938 workspace.active_pane().clone()
939 });
940
941 let close_items = workspace.update(cx, |workspace, cx| {
942 pane.update(cx, |pane, cx| {
943 pane.activate_item(1, true, cx);
944 assert_eq!(pane.active_item().unwrap().id(), item2.id());
945 });
946
947 let item1_id = item1.id();
948 let item3_id = item3.id();
949 let item4_id = item4.id();
950 Pane::close_items(workspace, pane.clone(), cx, move |id| {
951 [item1_id, item3_id, item4_id].contains(&id)
952 })
953 });
954
955 cx.foreground().run_until_parked();
956 pane.read_with(cx, |pane, _| {
957 assert_eq!(pane.items.len(), 4);
958 assert_eq!(pane.active_item().unwrap().id(), item1.id());
959 });
960
961 cx.simulate_prompt_answer(window_id, 0);
962 cx.foreground().run_until_parked();
963 pane.read_with(cx, |pane, cx| {
964 assert_eq!(item1.read(cx).save_count, 1);
965 assert_eq!(item1.read(cx).save_as_count, 0);
966 assert_eq!(item1.read(cx).reload_count, 0);
967 assert_eq!(pane.items.len(), 3);
968 assert_eq!(pane.active_item().unwrap().id(), item3.id());
969 });
970
971 cx.simulate_prompt_answer(window_id, 1);
972 cx.foreground().run_until_parked();
973 pane.read_with(cx, |pane, cx| {
974 assert_eq!(item3.read(cx).save_count, 0);
975 assert_eq!(item3.read(cx).save_as_count, 0);
976 assert_eq!(item3.read(cx).reload_count, 1);
977 assert_eq!(pane.items.len(), 2);
978 assert_eq!(pane.active_item().unwrap().id(), item4.id());
979 });
980
981 cx.simulate_prompt_answer(window_id, 0);
982 cx.foreground().run_until_parked();
983 cx.simulate_new_path_selection(|_| Some(Default::default()));
984 close_items.await.unwrap();
985 pane.read_with(cx, |pane, cx| {
986 assert_eq!(item4.read(cx).save_count, 0);
987 assert_eq!(item4.read(cx).save_as_count, 1);
988 assert_eq!(item4.read(cx).reload_count, 0);
989 assert_eq!(pane.items.len(), 1);
990 assert_eq!(pane.active_item().unwrap().id(), item2.id());
991 });
992 }
993
994 #[gpui::test]
995 async fn test_prompting_only_on_last_item_for_entry(cx: &mut TestAppContext) {
996 cx.foreground().forbid_parking();
997
998 let params = cx.update(WorkspaceParams::test);
999 let (window_id, workspace) = cx.add_window(|cx| Workspace::new(¶ms, cx));
1000 let item = cx.add_view(window_id, |_| {
1001 let mut item = TestItem::new();
1002 item.is_dirty = true;
1003 item.project_entry_id = Some(ProjectEntryId::new(&AtomicUsize::new(1)));
1004 item
1005 });
1006
1007 let (left_pane, right_pane) = workspace.update(cx, |workspace, cx| {
1008 workspace.add_item(Box::new(item.clone()), cx);
1009 let left_pane = workspace.active_pane().clone();
1010 let right_pane = workspace.split_pane(left_pane.clone(), SplitDirection::Right, cx);
1011 (left_pane, right_pane)
1012 });
1013
1014 workspace
1015 .update(cx, |workspace, cx| {
1016 let item = right_pane.read(cx).active_item().unwrap();
1017 Pane::close_item(workspace, right_pane.clone(), item.id(), cx)
1018 })
1019 .await
1020 .unwrap();
1021 workspace.read_with(cx, |workspace, _| {
1022 assert_eq!(workspace.panes(), [left_pane.clone()]);
1023 });
1024
1025 let close_item = workspace.update(cx, |workspace, cx| {
1026 let item = left_pane.read(cx).active_item().unwrap();
1027 Pane::close_item(workspace, left_pane.clone(), item.id(), cx)
1028 });
1029 cx.foreground().run_until_parked();
1030 cx.simulate_prompt_answer(window_id, 0);
1031 close_item.await.unwrap();
1032 left_pane.read_with(cx, |pane, _| {
1033 assert_eq!(pane.items.len(), 0);
1034 });
1035 }
1036
1037 #[derive(Clone)]
1038 struct TestItem {
1039 save_count: usize,
1040 save_as_count: usize,
1041 reload_count: usize,
1042 is_dirty: bool,
1043 has_conflict: bool,
1044 can_save: bool,
1045 project_entry_id: Option<ProjectEntryId>,
1046 }
1047
1048 impl TestItem {
1049 fn new() -> Self {
1050 Self {
1051 save_count: 0,
1052 save_as_count: 0,
1053 reload_count: 0,
1054 is_dirty: false,
1055 has_conflict: false,
1056 can_save: true,
1057 project_entry_id: None,
1058 }
1059 }
1060 }
1061
1062 impl Entity for TestItem {
1063 type Event = ();
1064 }
1065
1066 impl View for TestItem {
1067 fn ui_name() -> &'static str {
1068 "TestItem"
1069 }
1070
1071 fn render(&mut self, _: &mut RenderContext<Self>) -> ElementBox {
1072 Empty::new().boxed()
1073 }
1074 }
1075
1076 impl Item for TestItem {
1077 fn tab_content(&self, _: &theme::Tab, _: &AppContext) -> ElementBox {
1078 Empty::new().boxed()
1079 }
1080
1081 fn project_path(&self, _: &AppContext) -> Option<ProjectPath> {
1082 None
1083 }
1084
1085 fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
1086 self.project_entry_id
1087 }
1088
1089 fn set_nav_history(&mut self, _: ItemNavHistory, _: &mut ViewContext<Self>) {}
1090
1091 fn clone_on_split(&self, _: &mut ViewContext<Self>) -> Option<Self>
1092 where
1093 Self: Sized,
1094 {
1095 Some(self.clone())
1096 }
1097
1098 fn is_dirty(&self, _: &AppContext) -> bool {
1099 self.is_dirty
1100 }
1101
1102 fn has_conflict(&self, _: &AppContext) -> bool {
1103 self.has_conflict
1104 }
1105
1106 fn can_save(&self, _: &AppContext) -> bool {
1107 self.can_save
1108 }
1109
1110 fn save(
1111 &mut self,
1112 _: ModelHandle<Project>,
1113 _: &mut ViewContext<Self>,
1114 ) -> Task<anyhow::Result<()>> {
1115 self.save_count += 1;
1116 Task::ready(Ok(()))
1117 }
1118
1119 fn can_save_as(&self, _: &AppContext) -> bool {
1120 true
1121 }
1122
1123 fn save_as(
1124 &mut self,
1125 _: ModelHandle<Project>,
1126 _: std::path::PathBuf,
1127 _: &mut ViewContext<Self>,
1128 ) -> Task<anyhow::Result<()>> {
1129 self.save_as_count += 1;
1130 Task::ready(Ok(()))
1131 }
1132
1133 fn reload(
1134 &mut self,
1135 _: ModelHandle<Project>,
1136 _: &mut ViewContext<Self>,
1137 ) -> Task<anyhow::Result<()>> {
1138 self.reload_count += 1;
1139 Task::ready(Ok(()))
1140 }
1141 }
1142}