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