mod dock; mod invalid_panel; mod panel; mod stack_panel; mod tab_panel; use std::sync::Arc; pub use dock::*; use gpui::{ actions, canvas, div, prelude::FluentBuilder, AnyElement, AnyView, AppContext, Axis, Bounds, EventEmitter, InteractiveElement as _, IntoElement, ParentElement as _, Pixels, Render, SharedString, Styled, View, ViewContext, VisualContext, WeakView, WindowContext, }; pub use panel::*; pub use stack_panel::*; pub use tab_panel::*; pub fn init(cx: &mut AppContext) { cx.set_global(PanelRegistry::new()); } actions!(dock, [ToggleZoom, ClosePanel]); pub enum DockEvent { /// The layout of the dock has changed, subscribers this to save the layout. /// /// This event is emitted when every time the layout of the dock has changed, /// So it emits may be too frequently, you may want to debounce the event. LayoutChanged, } /// The main area of the dock. pub struct DockArea { id: SharedString, pub(crate) bounds: Bounds, /// The center view of the dockarea. items: DockItem, /// The left dock of the dockarea. left_dock: Option>, /// The bottom dock of the dockarea. bottom_dock: Option>, /// The right dock of the dockarea. right_dock: Option>, /// The top zoom view of the dockarea, if any. zoom_view: Option, } /// DockItem is a tree structure that represents the layout of the dock. #[derive(Clone)] pub enum DockItem { Split { axis: gpui::Axis, items: Vec, sizes: Vec>, view: View, }, Tabs { items: Vec>, active_ix: usize, view: View, }, } impl DockItem { /// Create DockItem with split layout, each item of panel have equal size. pub fn split( axis: Axis, items: Vec, dock_area: &WeakView, cx: &mut WindowContext, ) -> Self { let sizes = vec![None; items.len()]; Self::split_with_sizes(axis, items, sizes, dock_area, cx) } /// Create DockItem with split layout, each item of panel have specified size. /// /// Please note that the `items` and `sizes` must have the same length. /// Set `None` in `sizes` to make the index of panel have auto size. pub fn split_with_sizes( axis: Axis, items: Vec, sizes: Vec>, dock_area: &WeakView, cx: &mut WindowContext, ) -> Self { let mut items = items; let stack_panel = cx.new_view(|cx| { let mut stack_panel = StackPanel::new(axis, cx); for (i, item) in items.iter_mut().enumerate() { let view = item.view(); let size = sizes.get(i).copied().flatten(); stack_panel.add_panel(view.clone(), size, dock_area.clone(), cx) } for (i, item) in items.iter().enumerate() { let view = item.view(); let size = sizes.get(i).copied().flatten(); stack_panel.add_panel(view.clone(), size, dock_area.clone(), cx) } stack_panel }); Self::Split { axis, items, sizes, view: stack_panel, } } /// Create DockItem with tabs layout, items are displayed as tabs. /// /// The `active_ix` is the index of the active tab, if `None` the first tab is active. pub fn tabs( items: Vec>, active_ix: Option, dock_area: &WeakView, cx: &mut WindowContext, ) -> Self { let mut new_items: Vec> = vec![]; for item in items.into_iter() { new_items.push(item) } Self::new_tabs(new_items, active_ix, dock_area, cx) } pub fn tab( item: View

, dock_area: &WeakView, cx: &mut WindowContext, ) -> Self { Self::new_tabs(vec![Arc::new(item.clone())], None, dock_area, cx) } fn new_tabs( items: Vec>, active_ix: Option, dock_area: &WeakView, cx: &mut WindowContext, ) -> Self { let active_ix = active_ix.unwrap_or(0); let tab_panel = cx.new_view(|cx| { let mut tab_panel = TabPanel::new(None, dock_area.clone(), cx); for item in items.iter() { tab_panel.add_panel(item.clone(), cx) } tab_panel.active_ix = active_ix; tab_panel }); Self::Tabs { items, active_ix, view: tab_panel, } } /// Returns the views of the dock item. fn view(&self) -> Arc { match self { Self::Split { view, .. } => Arc::new(view.clone()), Self::Tabs { view, .. } => Arc::new(view.clone()), } } /// Find existing panel in the dock item. pub fn find_panel(&self, panel: Arc) -> Option> { match self { Self::Split { items, .. } => { items.iter().find_map(|item| item.find_panel(panel.clone())) } Self::Tabs { items, .. } => items.iter().find(|item| *item == &panel).cloned(), } } } impl DockArea { pub fn new(id: impl Into, cx: &mut ViewContext) -> Self { let stack_panel = cx.new_view(|cx| StackPanel::new(Axis::Horizontal, cx)); let dock_item = DockItem::Split { axis: Axis::Horizontal, items: vec![], sizes: vec![], view: stack_panel.clone(), }; Self { id: id.into(), bounds: Bounds::default(), items: dock_item, zoom_view: None, left_dock: None, right_dock: None, bottom_dock: None, } } /// The the DockItem as the root of the dock area. /// /// This is used to render at the Center of the DockArea. pub fn set_root(&mut self, item: DockItem, cx: &mut ViewContext) { self.subscribe_item(&item, cx); self.items = item; cx.notify(); } pub fn set_left_dock( &mut self, panels: Vec>, size: Option, cx: &mut ViewContext, ) { let weak_self = cx.view().downgrade(); self.left_dock = Some(cx.new_view(|cx| { let mut dock = Dock::left(weak_self.clone(), cx); if let Some(size) = size { dock.set_size(size, cx); } dock.set_panels(panels, cx); dock })) } pub fn set_bottom_dock( &mut self, panels: Vec>, size: Option, cx: &mut ViewContext, ) { let weak_self = cx.view().downgrade(); self.bottom_dock = Some(cx.new_view(|cx| { let mut dock = Dock::bottom(weak_self.clone(), cx); if let Some(size) = size { dock.set_size(size, cx); } dock.set_panels(panels, cx); dock })) } pub fn set_right_dock( &mut self, panels: Vec>, size: Option, cx: &mut ViewContext, ) { let weak_self = cx.view().downgrade(); self.right_dock = Some(cx.new_view(|cx| { let mut dock = Dock::right(weak_self.clone(), cx); if let Some(size) = size { dock.set_size(size, cx); } dock.set_panels(panels, cx); dock })) } pub fn is_dock_open(&self, placement: DockPlacement, cx: &AppContext) -> bool { match placement { DockPlacement::Left => self .left_dock .as_ref() .and_then(|dock| Some(dock.read(cx).is_open())) .unwrap_or(false), DockPlacement::Bottom => self .bottom_dock .as_ref() .and_then(|dock| Some(dock.read(cx).is_open())) .unwrap_or(false), DockPlacement::Right => self .right_dock .as_ref() .and_then(|dock| Some(dock.read(cx).is_open())) .unwrap_or(false), } } pub fn toggle_dock(&self, placement: DockPlacement, cx: &mut ViewContext) { let dock = match placement { DockPlacement::Left => &self.left_dock, DockPlacement::Bottom => &self.bottom_dock, DockPlacement::Right => &self.right_dock, }; if let Some(dock) = dock { dock.update(cx, |view, cx| { view.toggle_open(cx); }) } } /// Dump the dock panels layout to DockItemState. /// /// See also `DockItemState::to_item` for the load DockItem from DockItemState. pub fn dump(&self, cx: &AppContext) -> DockItemState { let root = self.items.view(); root.dump(cx) } /// Subscribe event on the panels #[allow(clippy::only_used_in_recursion)] fn subscribe_item(&self, item: &DockItem, cx: &mut ViewContext) { match item { DockItem::Split { items, view, .. } => { for item in items { self.subscribe_item(item, cx); } cx.subscribe(view, move |_, _, event, cx| match event { PanelEvent::LayoutChanged => cx.emit(DockEvent::LayoutChanged), _ => {} }) .detach(); } DockItem::Tabs { .. } => { // We subscribe the tab panel event is in StackPanel insert_panel } } } /// Subscribe zoom event on the panel pub(crate) fn subscribe_panel(view: &View

, cx: &mut ViewContext) { cx.subscribe(view, move |_, panel, event, cx| match event { PanelEvent::ZoomIn => { let dock_area = cx.view().clone(); let panel = panel.clone(); cx.spawn(|_, mut cx| async move { let _ = cx.update(|cx| { let _ = dock_area.update(cx, |dock, cx| { dock.set_zoomed_in(panel, cx); cx.notify(); }); }); }) .detach(); } PanelEvent::ZoomOut => { let dock_area = cx.view().clone(); cx.spawn(|_, mut cx| async move { let _ = cx.update(|cx| { let _ = dock_area.update(cx, |view, cx| view.set_zoomed_out(cx)); }); }) .detach() } PanelEvent::LayoutChanged => cx.emit(DockEvent::LayoutChanged), }) .detach(); } /// Returns the ID of the dock area. pub fn id(&self) -> SharedString { self.id.clone() } pub fn set_zoomed_in(&mut self, panel: View

, cx: &mut ViewContext) { self.zoom_view = Some(panel.into()); cx.notify(); } pub fn set_zoomed_out(&mut self, cx: &mut ViewContext) { self.zoom_view = None; cx.notify(); } fn render_items(&self, _cx: &mut ViewContext) -> AnyElement { match &self.items { DockItem::Split { view, .. } => view.clone().into_any_element(), DockItem::Tabs { view, .. } => view.clone().into_any_element(), } } } impl EventEmitter for DockArea {} impl Render for DockArea { fn render(&mut self, cx: &mut ViewContext) -> impl IntoElement { let view = cx.view().clone(); div() .id("dock-area") .relative() .size_full() .overflow_hidden() .child( canvas( move |bounds, cx| view.update(cx, |r, _| r.bounds = bounds), |_, _, _| {}, ) .absolute() .size_full(), ) .map(|this| { if let Some(zoom_view) = self.zoom_view.clone() { this.child(zoom_view) } else { this.child( div() .flex() .flex_row() .h_full() // Left dock .when_some(self.left_dock.clone(), |this, dock| { this.child(div().flex().flex_none().child(dock)) }) // Center .child( div() .flex() .flex_1() .flex_col() .overflow_hidden() // Top center .child( div() .flex_1() .overflow_hidden() .child(self.render_items(cx)), ) // Bottom Dock .when_some(self.bottom_dock.clone(), |this, dock| { this.child(dock) }), ) // Right Dock .when_some(self.right_dock.clone(), |this, dock| { this.child(div().flex().flex_none().child(dock)) }), ) } }) } }