use crate::focus_follows_mouse::FocusFollowsMouse as _; use crate::persistence::model::DockData; use crate::status_bar::HideStatusItem; use crate::{DraggedDock, Event, FocusFollowsMouse, ModalLayer, Pane, WorkspaceSettings}; use crate::{Workspace, status_bar::StatusItemView}; use anyhow::Context as _; use client::proto; use db::kvp::KeyValueStore; use gpui::{ Action, Anchor, AnyView, App, Axis, Context, Entity, EntityId, EventEmitter, FocusHandle, Focusable, IntoElement, KeyContext, MouseButton, MouseDownEvent, MouseUpEvent, ParentElement, Render, SharedString, StyleRefinement, Styled, Subscription, WeakEntity, Window, deferred, div, px, }; use serde::{Deserialize, Serialize}; use settings::{Settings, SettingsStore, TerminalDockPosition}; use std::sync::Arc; use ui::{ ContextMenu, CountBadge, Divider, DividerColor, IconButton, Tooltip, prelude::*, right_click_menu, }; use util::ResultExt as _; pub(crate) const RESIZE_HANDLE_SIZE: Pixels = px(6.); pub enum PanelEvent { ZoomIn, ZoomOut, Activate, Close, } pub use proto::PanelId; pub trait Panel: Focusable + EventEmitter + Render + Sized { fn persistent_name() -> &'static str; fn panel_key() -> &'static str; fn position(&self, window: &Window, cx: &App) -> DockPosition; fn position_is_valid(&self, position: DockPosition) -> bool; fn set_position(&mut self, position: DockPosition, window: &mut Window, cx: &mut Context); fn default_size(&self, window: &Window, cx: &App) -> Pixels; fn min_size(&self, _window: &Window, _cx: &App) -> Option { None } fn initial_size_state(&self, _window: &Window, _cx: &App) -> PanelSizeState { PanelSizeState::default() } fn size_state_changed(&mut self, _window: &mut Window, _cx: &mut Context) {} fn supports_flexible_size(&self) -> bool { false } fn has_flexible_size(&self, _window: &Window, _cx: &App) -> bool { false } fn set_flexible_size( &mut self, _flexible: bool, _window: &mut Window, _cx: &mut Context, ) { } fn icon(&self, window: &Window, cx: &App) -> Option; fn icon_tooltip(&self, window: &Window, cx: &App) -> Option<&'static str>; fn toggle_action(&self) -> Box; fn icon_label(&self, _window: &Window, _: &App) -> Option { None } fn is_zoomed(&self, _window: &Window, _cx: &App) -> bool { false } fn starts_open(&self, _window: &Window, _cx: &App) -> bool { false } fn set_zoomed(&mut self, _zoomed: bool, _window: &mut Window, _cx: &mut Context) {} fn set_active(&mut self, _active: bool, _window: &mut Window, _cx: &mut Context) {} fn pane(&self) -> Option> { None } fn remote_id() -> Option { None } fn activation_priority(&self) -> u32; fn enabled(&self, _cx: &App) -> bool { true } fn is_agent_panel(&self) -> bool { false } /// Returns metadata describing how to hide this panel's button from the /// status bar by writing to user settings. Implementors should return /// `None` if the panel button cannot be hidden through settings. fn hide_button_setting(&self, _: &App) -> Option { None } } pub trait PanelHandle: Send + Sync { fn panel_id(&self) -> EntityId; fn persistent_name(&self) -> &'static str; fn panel_key(&self) -> &'static str; fn position(&self, window: &Window, cx: &App) -> DockPosition; fn position_is_valid(&self, position: DockPosition, cx: &App) -> bool; fn set_position(&self, position: DockPosition, window: &mut Window, cx: &mut App); fn is_zoomed(&self, window: &Window, cx: &App) -> bool; fn set_zoomed(&self, zoomed: bool, window: &mut Window, cx: &mut App); fn set_active(&self, active: bool, window: &mut Window, cx: &mut App); fn remote_id(&self) -> Option; fn pane(&self, cx: &App) -> Option>; fn default_size(&self, window: &Window, cx: &App) -> Pixels; fn min_size(&self, window: &Window, cx: &App) -> Option; fn initial_size_state(&self, window: &Window, cx: &App) -> PanelSizeState; fn size_state_changed(&self, window: &mut Window, cx: &mut App); fn supports_flexible_size(&self, cx: &App) -> bool; fn has_flexible_size(&self, window: &Window, cx: &App) -> bool; fn set_flexible_size(&self, flexible: bool, window: &mut Window, cx: &mut App); fn icon(&self, window: &Window, cx: &App) -> Option; fn icon_tooltip(&self, window: &Window, cx: &App) -> Option<&'static str>; fn toggle_action(&self, window: &Window, cx: &App) -> Box; fn icon_label(&self, window: &Window, cx: &App) -> Option; fn panel_focus_handle(&self, cx: &App) -> FocusHandle; fn to_any(&self) -> AnyView; fn activation_priority(&self, cx: &App) -> u32; fn enabled(&self, cx: &App) -> bool; fn is_agent_panel(&self, cx: &App) -> bool; fn hide_button_setting(&self, cx: &App) -> Option; fn move_to_next_position(&self, window: &mut Window, cx: &mut App) { let current_position = self.position(window, cx); let next_position = [ DockPosition::Left, DockPosition::Bottom, DockPosition::Right, ] .into_iter() .filter(|position| self.position_is_valid(*position, cx)) .skip_while(|valid_position| *valid_position != current_position) .nth(1) .unwrap_or(DockPosition::Left); self.set_position(next_position, window, cx); } } impl PanelHandle for Entity where T: Panel, { fn panel_id(&self) -> EntityId { Entity::entity_id(self) } fn persistent_name(&self) -> &'static str { T::persistent_name() } fn panel_key(&self) -> &'static str { T::panel_key() } fn position(&self, window: &Window, cx: &App) -> DockPosition { self.read(cx).position(window, cx) } fn position_is_valid(&self, position: DockPosition, cx: &App) -> bool { self.read(cx).position_is_valid(position) } fn set_position(&self, position: DockPosition, window: &mut Window, cx: &mut App) { self.update(cx, |this, cx| this.set_position(position, window, cx)) } fn is_zoomed(&self, window: &Window, cx: &App) -> bool { self.read(cx).is_zoomed(window, cx) } fn set_zoomed(&self, zoomed: bool, window: &mut Window, cx: &mut App) { self.update(cx, |this, cx| this.set_zoomed(zoomed, window, cx)) } fn set_active(&self, active: bool, window: &mut Window, cx: &mut App) { self.update(cx, |this, cx| this.set_active(active, window, cx)) } fn pane(&self, cx: &App) -> Option> { self.read(cx).pane() } fn remote_id(&self) -> Option { T::remote_id() } fn default_size(&self, window: &Window, cx: &App) -> Pixels { self.read(cx).default_size(window, cx) } fn min_size(&self, window: &Window, cx: &App) -> Option { self.read(cx).min_size(window, cx) } fn initial_size_state(&self, window: &Window, cx: &App) -> PanelSizeState { self.read(cx).initial_size_state(window, cx) } fn size_state_changed(&self, window: &mut Window, cx: &mut App) { self.update(cx, |this, cx| this.size_state_changed(window, cx)) } fn supports_flexible_size(&self, cx: &App) -> bool { self.read(cx).supports_flexible_size() } fn has_flexible_size(&self, window: &Window, cx: &App) -> bool { self.read(cx).has_flexible_size(window, cx) } fn set_flexible_size(&self, flexible: bool, window: &mut Window, cx: &mut App) { self.update(cx, |this, cx| this.set_flexible_size(flexible, window, cx)) } fn icon(&self, window: &Window, cx: &App) -> Option { self.read(cx).icon(window, cx) } fn icon_tooltip(&self, window: &Window, cx: &App) -> Option<&'static str> { self.read(cx).icon_tooltip(window, cx) } fn toggle_action(&self, _: &Window, cx: &App) -> Box { self.read(cx).toggle_action() } fn icon_label(&self, window: &Window, cx: &App) -> Option { self.read(cx).icon_label(window, cx) } fn to_any(&self) -> AnyView { self.clone().into() } fn panel_focus_handle(&self, cx: &App) -> FocusHandle { self.read(cx).focus_handle(cx) } fn activation_priority(&self, cx: &App) -> u32 { self.read(cx).activation_priority() } fn enabled(&self, cx: &App) -> bool { self.read(cx).enabled(cx) } fn is_agent_panel(&self, cx: &App) -> bool { self.read(cx).is_agent_panel() } fn hide_button_setting(&self, cx: &App) -> Option { self.read(cx).hide_button_setting(cx) } } impl From<&dyn PanelHandle> for AnyView { fn from(val: &dyn PanelHandle) -> Self { val.to_any() } } /// A container with a fixed [`DockPosition`] adjacent to a certain widown edge. /// Can contain multiple panels and show/hide itself with all contents. pub struct Dock { position: DockPosition, panel_entries: Vec, workspace: WeakEntity, is_open: bool, active_panel_index: Option, focus_handle: FocusHandle, focus_follows_mouse: FocusFollowsMouse, pub(crate) serialized_dock: Option, zoom_layer_open: bool, modal_layer: Entity, _subscriptions: [Subscription; 2], } impl Focusable for Dock { fn focus_handle(&self, _: &App) -> FocusHandle { self.focus_handle.clone() } } #[derive(Copy, Clone, Debug, PartialEq, Eq)] pub enum DockPosition { Left, Bottom, Right, } impl From for DockPosition { fn from(value: settings::DockPosition) -> Self { match value { settings::DockPosition::Left => Self::Left, settings::DockPosition::Bottom => Self::Bottom, settings::DockPosition::Right => Self::Right, } } } impl Into for DockPosition { fn into(self) -> settings::DockPosition { match self { Self::Left => settings::DockPosition::Left, Self::Bottom => settings::DockPosition::Bottom, Self::Right => settings::DockPosition::Right, } } } impl From for DockPosition { fn from(value: TerminalDockPosition) -> Self { match value { TerminalDockPosition::Left => DockPosition::Left, TerminalDockPosition::Bottom => DockPosition::Bottom, TerminalDockPosition::Right => DockPosition::Right, } } } impl DockPosition { fn label(&self) -> &'static str { match self { Self::Left => "Left", Self::Bottom => "Bottom", Self::Right => "Right", } } pub fn axis(&self) -> Axis { match self { Self::Left | Self::Right => Axis::Horizontal, Self::Bottom => Axis::Vertical, } } } #[derive(Clone, Copy, Debug, Default, PartialEq, Serialize, Deserialize)] pub struct PanelSizeState { pub size: Option, #[serde(default)] pub flex: Option, } struct PanelEntry { panel: Arc, size_state: PanelSizeState, _subscriptions: [Subscription; 3], } pub struct PanelButtons { dock: Entity, _settings_subscription: Subscription, } pub(crate) const PANEL_SIZE_STATE_KEY: &str = "dock_panel_size"; fn panel_uses_flexible_width( position: DockPosition, panel: &dyn PanelHandle, window: &Window, cx: &App, ) -> bool { position.axis() == Axis::Horizontal && panel.has_flexible_size(window, cx) } fn resize_panel_entry( position: DockPosition, entry: &mut PanelEntry, size: Option, flex: Option, window: &mut Window, cx: &mut App, ) -> (&'static str, PanelSizeState) { let size = size.map(|size| size.max(RESIZE_HANDLE_SIZE).round()); let uses_flexible_width = panel_uses_flexible_width(position, entry.panel.as_ref(), window, cx); if uses_flexible_width { entry.size_state.flex = flex; } else { entry.size_state.size = size; } entry.panel.size_state_changed(window, cx); (entry.panel.panel_key(), entry.size_state) } impl Dock { pub fn new( position: DockPosition, modal_layer: Entity, window: &mut Window, cx: &mut Context, ) -> Entity { let focus_handle = cx.focus_handle(); let workspace = cx.entity(); let dock = cx.new(|cx| { let focus_subscription = cx.on_focus(&focus_handle, window, |dock: &mut Dock, window, cx| { if let Some(active_entry) = dock.active_panel_entry() { active_entry.panel.panel_focus_handle(cx).focus(window, cx) } }); let zoom_subscription = cx.subscribe(&workspace, |dock, workspace, e: &Event, cx| { if matches!(e, Event::ZoomChanged) { let is_zoomed = workspace.read(cx).zoomed.is_some(); dock.zoom_layer_open = is_zoomed; } }); Self { position, workspace: workspace.downgrade(), panel_entries: Default::default(), active_panel_index: None, is_open: false, focus_handle: focus_handle.clone(), focus_follows_mouse: WorkspaceSettings::get_global(cx).focus_follows_mouse, _subscriptions: [focus_subscription, zoom_subscription], serialized_dock: None, zoom_layer_open: false, modal_layer, } }); cx.on_focus_in(&focus_handle, window, { let dock = dock.downgrade(); move |workspace, window, cx| { let Some(dock) = dock.upgrade() else { return; }; let Some(panel) = dock.read(cx).active_panel() else { return; }; if panel.is_zoomed(window, cx) { workspace.zoomed = Some(panel.to_any().downgrade()); workspace.zoomed_position = Some(position); } else { workspace.zoomed = None; workspace.zoomed_position = None; } cx.emit(Event::ZoomChanged); workspace.dismiss_zoomed_items_to_reveal(Some(position), window, cx); workspace.update_active_view_for_followers(window, cx) } }) .detach(); cx.observe_in(&dock, window, move |workspace, dock, window, cx| { if dock.read(cx).is_open() && let Some(panel) = dock.read(cx).active_panel() && panel.is_zoomed(window, cx) { workspace.zoomed = Some(panel.to_any().downgrade()); workspace.zoomed_position = Some(position); cx.emit(Event::ZoomChanged); return; } if workspace.zoomed_position == Some(position) { workspace.zoomed = None; workspace.zoomed_position = None; cx.emit(Event::ZoomChanged); } }) .detach(); dock } pub fn position(&self) -> DockPosition { self.position } pub fn is_open(&self) -> bool { self.is_open } fn resizable(&self, cx: &App) -> bool { !(self.zoom_layer_open || self.modal_layer.read(cx).has_active_modal()) } pub fn panel(&self) -> Option> { self.panel_entries .iter() .find_map(|entry| entry.panel.to_any().downcast().ok()) } pub fn panel_index_for_type(&self) -> Option { self.panel_entries .iter() .position(|entry| entry.panel.to_any().downcast::().is_ok()) } pub fn panel_index_for_persistent_name(&self, ui_name: &str, _cx: &App) -> Option { self.panel_entries .iter() .position(|entry| entry.panel.persistent_name() == ui_name) } pub fn panel_index_for_proto_id(&self, panel_id: PanelId) -> Option { self.panel_entries .iter() .position(|entry| entry.panel.remote_id() == Some(panel_id)) } pub fn panel_for_id(&self, panel_id: EntityId) -> Option<&Arc> { self.panel_entries .iter() .find(|entry| entry.panel.panel_id() == panel_id) .map(|entry| &entry.panel) } pub fn first_enabled_panel_idx(&mut self, cx: &mut Context) -> anyhow::Result { self.panel_entries .iter() .position(|entry| entry.panel.enabled(cx)) .with_context(|| { format!( "Couldn't find any enabled panel for the {} dock.", self.position.label() ) }) } fn active_panel_entry(&self) -> Option<&PanelEntry> { self.active_panel_index .and_then(|index| self.panel_entries.get(index)) } pub fn active_panel_index(&self) -> Option { self.active_panel_index } pub fn set_open(&mut self, open: bool, window: &mut Window, cx: &mut Context) { if open != self.is_open { self.is_open = open; if let Some(active_panel) = self.active_panel_entry() { active_panel.panel.set_active(open, window, cx); } cx.notify(); } } pub fn set_panel_zoomed( &mut self, panel: &AnyView, zoomed: bool, window: &mut Window, cx: &mut Context, ) { for entry in &mut self.panel_entries { if entry.panel.panel_id() == panel.entity_id() { if zoomed != entry.panel.is_zoomed(window, cx) { entry.panel.set_zoomed(zoomed, window, cx); } } else if entry.panel.is_zoomed(window, cx) { entry.panel.set_zoomed(false, window, cx); } } self.workspace .update(cx, |workspace, cx| { workspace.serialize_workspace(window, cx); }) .ok(); cx.notify(); } pub fn zoom_out(&mut self, window: &mut Window, cx: &mut Context) { for entry in &mut self.panel_entries { if entry.panel.is_zoomed(window, cx) { entry.panel.set_zoomed(false, window, cx); } } } pub(crate) fn add_panel( &mut self, panel: Entity, workspace: WeakEntity, window: &mut Window, cx: &mut Context, ) -> usize { let subscriptions = [ cx.observe(&panel, |_, _, cx| cx.notify()), cx.observe_global_in::(window, { let workspace = workspace.clone(); let panel = panel.clone(); move |this, window, cx| { let new_position = panel.read(cx).position(window, cx); if new_position == this.position { return; } let Ok(new_dock) = workspace.update(cx, |workspace, cx| { if panel.is_zoomed(window, cx) { workspace.zoomed_position = Some(new_position); } match new_position { DockPosition::Left => &workspace.left_dock, DockPosition::Bottom => &workspace.bottom_dock, DockPosition::Right => &workspace.right_dock, } .clone() }) else { return; }; let panel_id = Entity::entity_id(&panel); let was_visible = this.is_open() && this .visible_panel() .is_some_and(|active_panel| active_panel.panel_id() == panel_id); let size_state = this .panel_entries .iter() .find(|entry| entry.panel.panel_id() == panel_id) .map(|entry| entry.size_state) .unwrap_or_default(); let previous_axis = this.position.axis(); let next_axis = new_position.axis(); let size_state = if previous_axis == next_axis { size_state } else { PanelSizeState::default() }; if !this.remove_panel(&panel, window, cx) { // Panel was already moved from this dock return; } new_dock.update(cx, |new_dock, cx| { let index = new_dock.add_panel(panel.clone(), workspace.clone(), window, cx); if let Some(added_panel) = new_dock.panel_for_id(panel_id).cloned() { new_dock.set_panel_size_state(added_panel.as_ref(), size_state, cx); } if was_visible { new_dock.set_open(true, window, cx); new_dock.activate_panel(index, window, cx); } }); workspace .update(cx, |workspace, cx| { workspace.serialize_workspace(window, cx); }) .ok(); } }), cx.subscribe_in( &panel, window, move |this, panel, event, window, cx| match event { PanelEvent::ZoomIn => { this.set_panel_zoomed(&panel.to_any(), true, window, cx); if !PanelHandle::panel_focus_handle(panel, cx).contains_focused(window, cx) { window.focus(&panel.focus_handle(cx), cx); } workspace .update(cx, |workspace, cx| { workspace.zoomed = Some(panel.downgrade().into()); workspace.zoomed_position = Some(panel.read(cx).position(window, cx)); cx.emit(Event::ZoomChanged); }) .ok(); } PanelEvent::ZoomOut => { this.set_panel_zoomed(&panel.to_any(), false, window, cx); workspace .update(cx, |workspace, cx| { if workspace.zoomed_position == Some(this.position) { workspace.zoomed = None; workspace.zoomed_position = None; cx.emit(Event::ZoomChanged); } cx.notify(); }) .ok(); } PanelEvent::Activate => { if let Some(ix) = this .panel_entries .iter() .position(|entry| entry.panel.panel_id() == Entity::entity_id(panel)) { this.set_open(true, window, cx); this.activate_panel(ix, window, cx); window.focus(&panel.read(cx).focus_handle(cx), cx); } } PanelEvent::Close => { if this .visible_panel() .is_some_and(|p| p.panel_id() == Entity::entity_id(panel)) { this.set_open(false, window, cx); } } }, ), ]; let index = match self .panel_entries .binary_search_by_key(&panel.read(cx).activation_priority(), |entry| { entry.panel.activation_priority(cx) }) { Ok(ix) => { if cfg!(debug_assertions) { panic!( "Panels `{}` and `{}` have the same activation priority. Each panel must have a unique priority so the status bar order is deterministic.", T::panel_key(), self.panel_entries[ix].panel.panel_key() ); } ix } Err(ix) => ix, }; if let Some(active_index) = self.active_panel_index.as_mut() && *active_index >= index { *active_index += 1; } let size_state = panel.read(cx).initial_size_state(window, cx); self.panel_entries.insert( index, PanelEntry { panel: Arc::new(panel.clone()), size_state, _subscriptions: subscriptions, }, ); self.restore_state(window, cx); if panel.read(cx).starts_open(window, cx) { self.activate_panel(index, window, cx); self.set_open(true, window, cx); } cx.notify(); index } pub fn restore_state(&mut self, window: &mut Window, cx: &mut Context) -> bool { if let Some(serialized) = self.serialized_dock.clone() { if let Some(active_panel) = serialized.active_panel.filter(|_| serialized.visible) && let Some(idx) = self.panel_index_for_persistent_name(active_panel.as_str(), cx) { self.activate_panel(idx, window, cx); } if serialized.zoom && let Some(panel) = self.active_panel() { panel.set_zoomed(true, window, cx) } self.set_open(serialized.visible, window, cx); return true; } false } pub fn remove_panel( &mut self, panel: &Entity, window: &mut Window, cx: &mut Context, ) -> bool { if let Some(panel_ix) = self .panel_entries .iter() .position(|entry| entry.panel.panel_id() == Entity::entity_id(panel)) { if let Some(active_panel_index) = self.active_panel_index.as_mut() { match panel_ix.cmp(active_panel_index) { std::cmp::Ordering::Less => { *active_panel_index -= 1; } std::cmp::Ordering::Equal => { self.active_panel_index = None; self.set_open(false, window, cx); } std::cmp::Ordering::Greater => {} } } self.panel_entries.remove(panel_ix); cx.notify(); true } else { false } } pub fn panels_len(&self) -> usize { self.panel_entries.len() } pub fn has_agent_panel(&self, cx: &App) -> bool { self.panel_entries .iter() .any(|entry| entry.panel.is_agent_panel(cx)) } pub fn activate_panel(&mut self, panel_ix: usize, window: &mut Window, cx: &mut Context) { if Some(panel_ix) != self.active_panel_index { if let Some(active_panel) = self.active_panel_entry() { active_panel.panel.set_active(false, window, cx); } self.active_panel_index = Some(panel_ix); if let Some(active_panel) = self.active_panel_entry() { active_panel.panel.set_active(true, window, cx); } cx.notify(); } } pub fn visible_panel(&self) -> Option<&Arc> { let entry = self.visible_entry()?; Some(&entry.panel) } pub fn active_panel(&self) -> Option<&Arc> { let panel_entry = self.active_panel_entry()?; Some(&panel_entry.panel) } fn visible_entry(&self) -> Option<&PanelEntry> { if self.is_open { self.active_panel_entry() } else { None } } pub fn zoomed_panel(&self, window: &Window, cx: &App) -> Option> { let entry = self.visible_entry()?; if entry.panel.is_zoomed(window, cx) { Some(entry.panel.clone()) } else { None } } pub fn active_panel_size(&self) -> Option { if self.is_open { self.active_panel_entry().map(|entry| entry.size_state) } else { None } } pub fn stored_panel_size( &self, panel: &dyn PanelHandle, window: &Window, cx: &App, ) -> Option { self.panel_entries .iter() .find(|entry| entry.panel.panel_id() == panel.panel_id()) .map(|entry| { entry .size_state .size .unwrap_or_else(|| entry.panel.default_size(window, cx)) }) } pub fn stored_panel_size_state(&self, panel: &dyn PanelHandle) -> Option { self.panel_entries .iter() .find(|entry| entry.panel.panel_id() == panel.panel_id()) .map(|entry| entry.size_state) } pub fn stored_active_panel_size(&self, window: &Window, cx: &App) -> Option { if self.is_open { self.active_panel_entry().map(|entry| { entry .size_state .size .unwrap_or_else(|| entry.panel.default_size(window, cx)) }) } else { None } } pub fn set_panel_size_state( &mut self, panel: &dyn PanelHandle, size_state: PanelSizeState, cx: &mut Context, ) -> bool { if let Some(entry) = self .panel_entries .iter_mut() .find(|entry| entry.panel.panel_id() == panel.panel_id()) { entry.size_state = size_state; cx.notify(); true } else { false } } pub fn toggle_panel_flexible_size( &mut self, panel: &dyn PanelHandle, current_size: Option, current_flex: Option, window: &mut Window, cx: &mut Context, ) { let Some(entry) = self .panel_entries .iter_mut() .find(|entry| entry.panel.panel_id() == panel.panel_id()) else { return; }; let currently_flexible = entry.panel.has_flexible_size(window, cx); if currently_flexible { entry.size_state.size = current_size; } else { entry.size_state.flex = current_flex; } let panel_key = entry.panel.panel_key(); let size_state = entry.size_state; let workspace = self.workspace.clone(); entry .panel .set_flexible_size(!currently_flexible, window, cx); entry.panel.size_state_changed(window, cx); cx.defer(move |cx| { if let Some(workspace) = workspace.upgrade() { workspace.update(cx, |workspace, cx| { workspace.persist_panel_size_state(panel_key, size_state, cx); }); } }); cx.notify(); } pub fn resize_active_panel( &mut self, size: Option, flex: Option, window: &mut Window, cx: &mut Context, ) { if let Some(index) = self.active_panel_index && let Some(entry) = self.panel_entries.get_mut(index) { let (panel_key, size_state) = resize_panel_entry(self.position, entry, size, flex, window, cx); let workspace = self.workspace.clone(); cx.defer(move |cx| { if let Some(workspace) = workspace.upgrade() { workspace.update(cx, |workspace, cx| { workspace.persist_panel_size_state(panel_key, size_state, cx); }); } }); cx.notify(); } } pub fn resize_all_panels( &mut self, size: Option, flex: Option, window: &mut Window, cx: &mut Context, ) { let Some(active_panel_index) = self.active_panel_index else { return; }; let active_panel_uses_flexible_width = { let Some(active_entry) = self.panel_entries.get(active_panel_index) else { return; }; panel_uses_flexible_width(self.position, active_entry.panel.as_ref(), window, cx) }; let mut size_states_to_persist = Vec::new(); for entry in &mut self.panel_entries { if panel_uses_flexible_width(self.position, entry.panel.as_ref(), window, cx) == active_panel_uses_flexible_width { size_states_to_persist.push(resize_panel_entry( self.position, entry, size, flex, window, cx, )); } } let workspace = self.workspace.clone(); cx.defer(move |cx| { if let Some(workspace) = workspace.upgrade() { workspace.update(cx, |workspace, cx| { for (panel_key, size_state) in size_states_to_persist { workspace.persist_panel_size_state(panel_key, size_state, cx); } }); } }); cx.notify(); } pub fn toggle_action(&self) -> Box { match self.position { DockPosition::Left => crate::ToggleLeftDock.boxed_clone(), DockPosition::Bottom => crate::ToggleBottomDock.boxed_clone(), DockPosition::Right => crate::ToggleRightDock.boxed_clone(), } } fn dispatch_context() -> KeyContext { let mut dispatch_context = KeyContext::new_with_defaults(); dispatch_context.add("Dock"); dispatch_context } pub fn clamp_panel_size(&mut self, max_size: Pixels, window: &Window, cx: &mut Context) { let max_size = (max_size - RESIZE_HANDLE_SIZE).abs(); let mut clamped = false; for entry in &mut self.panel_entries { let uses_flexible_width = panel_uses_flexible_width(self.position, entry.panel.as_ref(), window, cx); if uses_flexible_width { continue; } let size = entry .size_state .size .unwrap_or_else(|| entry.panel.default_size(window, cx)); if size > max_size { entry.size_state.size = Some(max_size.max(RESIZE_HANDLE_SIZE)); clamped = true; } } if clamped { cx.notify(); } } pub(crate) fn load_persisted_size_state( workspace: &Workspace, panel_key: &'static str, cx: &App, ) -> Option { let workspace_id = workspace .database_id() .map(|id| i64::from(id).to_string()) .or(workspace.session_id())?; let kvp = KeyValueStore::global(cx); let scope = kvp.scoped(PANEL_SIZE_STATE_KEY); scope .read(&format!("{workspace_id}:{panel_key}")) .log_err() .flatten() .and_then(|json| serde_json::from_str::(&json).log_err()) } } impl Render for Dock { fn render(&mut self, _window: &mut Window, cx: &mut Context) -> impl IntoElement { let dispatch_context = Self::dispatch_context(); if let Some(entry) = self.visible_entry() { let position = self.position; let create_resize_handle = || { let handle = div() .id("resize-handle") .on_drag(DraggedDock(position), |dock, _, _, cx| { cx.stop_propagation(); cx.new(|_| dock.clone()) }) .on_mouse_down( MouseButton::Left, cx.listener(|_, _: &MouseDownEvent, _, cx| { cx.stop_propagation(); }), ) .on_mouse_up( MouseButton::Left, cx.listener(|dock, e: &MouseUpEvent, window, cx| { if e.click_count == 2 { dock.resize_active_panel(None, None, window, cx); dock.workspace .update(cx, |workspace, cx| { workspace.serialize_workspace(window, cx); }) .ok(); cx.stop_propagation(); } }), ) .occlude(); match self.position() { DockPosition::Left => deferred( handle .absolute() .right(-RESIZE_HANDLE_SIZE / 2.) .top(px(0.)) .h_full() .w(RESIZE_HANDLE_SIZE) .cursor_col_resize(), ), DockPosition::Bottom => deferred( handle .absolute() .top(-RESIZE_HANDLE_SIZE / 2.) .left(px(0.)) .w_full() .h(RESIZE_HANDLE_SIZE) .cursor_row_resize(), ), DockPosition::Right => deferred( handle .absolute() .top(px(0.)) .left(-RESIZE_HANDLE_SIZE / 2.) .h_full() .w(RESIZE_HANDLE_SIZE) .cursor_col_resize(), ), } }; div() .id("dock-panel") .key_context(dispatch_context) .track_focus(&self.focus_handle(cx)) .focus_follows_mouse(self.focus_follows_mouse, cx) .flex() .bg(cx.theme().colors().panel_background) .border_color(cx.theme().colors().border) .overflow_hidden() .map(|this| match self.position().axis() { // Width and height are always set on the workspace wrapper in // render_dock, so fill whatever space the wrapper provides. Axis::Horizontal => this.w_full().h_full().flex_row(), Axis::Vertical => this.h_full().w_full().flex_col(), }) .map(|this| match self.position() { DockPosition::Left => this.border_r_1(), DockPosition::Right => this.border_l_1(), DockPosition::Bottom => this.border_t_1(), }) .child( div() .map(|this| match self.position().axis() { Axis::Horizontal => this.w_full().h_full(), Axis::Vertical => this.h_full().w_full(), }) .child( entry .panel .to_any() .cached(StyleRefinement::default().v_flex().size_full()), ), ) .when(self.resizable(cx), |this| { this.child(create_resize_handle()) }) } else { div() .id("dock-panel") .key_context(dispatch_context) .track_focus(&self.focus_handle(cx)) } } } impl PanelButtons { pub fn new(dock: Entity, cx: &mut Context) -> Self { cx.observe(&dock, |_, _, cx| cx.notify()).detach(); let settings_subscription = cx.observe_global::(|_, cx| cx.notify()); Self { dock, _settings_subscription: settings_subscription, } } } impl Render for PanelButtons { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let dock = self.dock.read(cx); let active_index = dock.active_panel_index; let is_open = dock.is_open; let dock_position = dock.position; let (menu_anchor, menu_attach) = match dock.position { DockPosition::Left => (Anchor::BottomLeft, Anchor::TopLeft), DockPosition::Bottom | DockPosition::Right => (Anchor::BottomRight, Anchor::TopRight), }; let dock_entity = self.dock.clone(); let workspace = dock.workspace.clone(); let mut buttons: Vec<_> = dock .panel_entries .iter() .enumerate() .filter_map(|(i, entry)| { let icon = entry.panel.icon(window, cx)?; let icon_tooltip = entry .panel .icon_tooltip(window, cx) .ok_or_else(|| { anyhow::anyhow!("can't render a panel button without an icon tooltip") }) .log_err()?; let name = entry.panel.persistent_name(); let panel = entry.panel.clone(); let supports_flexible = panel.supports_flexible_size(cx); let currently_flexible = panel.has_flexible_size(window, cx); let dock_for_menu = dock_entity.clone(); let workspace_for_menu = workspace.clone(); let is_active_button = Some(i) == active_index && is_open; let (action, tooltip) = if is_active_button { let action = dock.toggle_action(); let tooltip: SharedString = format!("Close {} Dock", dock.position.label()).into(); (action, tooltip) } else { let action = entry.panel.toggle_action(window, cx); (action, icon_tooltip.into()) }; let focus_handle = dock.focus_handle(cx); let icon_label = entry.panel.icon_label(window, cx); Some( right_click_menu(name) .menu(move |window, cx| { const POSITIONS: [DockPosition; 3] = [ DockPosition::Left, DockPosition::Right, DockPosition::Bottom, ]; let panel_hide = panel.hide_button_setting(cx); ContextMenu::build(window, cx, |mut menu, _, cx| { let mut has_position_entries = false; for position in POSITIONS { if panel.position_is_valid(position, cx) { let is_current = position == dock_position; let panel = panel.clone(); menu = menu.toggleable_entry( format!("Dock {}", position.label()), is_current, IconPosition::Start, None, move |window, cx| { if !is_current { panel.set_position(position, window, cx); } }, ); has_position_entries = true; } } if supports_flexible { if has_position_entries { menu = menu.separator(); } let panel_for_flex = panel.clone(); let dock_for_flex = dock_for_menu.clone(); let workspace_for_flex = workspace_for_menu.clone(); menu = menu.toggleable_entry( "Flex Width", currently_flexible, IconPosition::Start, None, move |window, cx| { if !currently_flexible { if let Some(ws) = workspace_for_flex.upgrade() { ws.update(cx, |workspace, cx| { workspace.toggle_dock_panel_flexible_size( &dock_for_flex, panel_for_flex.as_ref(), window, cx, ); }); } } }, ); let panel_for_fixed = panel.clone(); let dock_for_fixed = dock_for_menu.clone(); let workspace_for_fixed = workspace_for_menu.clone(); menu = menu.toggleable_entry( "Fixed Width", !currently_flexible, IconPosition::Start, None, move |window, cx| { if currently_flexible { if let Some(ws) = workspace_for_fixed.upgrade() { ws.update(cx, |workspace, cx| { workspace.toggle_dock_panel_flexible_size( &dock_for_fixed, panel_for_fixed.as_ref(), window, cx, ); }); } } }, ); } if let Some(hide) = panel_hide { menu = crate::status_bar::add_hide_button_entry( menu.separator(), hide, ); } menu }) }) .anchor(menu_anchor) .attach(menu_attach) .trigger(move |is_active, _window, _cx| { // Include active state in element ID to invalidate the cached // tooltip when panel state changes (e.g., via keyboard shortcut) let button = IconButton::new((name, is_active_button as u64), icon) .icon_size(IconSize::Small) .toggle_state(is_active_button) .tab_index(0isize) .aria_label(icon_tooltip) .on_click({ let action = action.boxed_clone(); move |_, window, cx| { window.focus(&focus_handle, cx); window.dispatch_action(action.boxed_clone(), cx) } }) .when(!is_active, |this| { this.tooltip(move |_window, cx| { Tooltip::for_action(tooltip.clone(), &*action, cx) }) }); div().relative().child(button).when_some( icon_label .clone() .filter(|_| !is_active_button) .and_then(|label| label.parse::().ok()), |this, count| this.child(CountBadge::new(count)), ) }), ) }) .collect(); if dock_position == DockPosition::Right { buttons.reverse(); } let has_buttons = !buttons.is_empty(); h_flex() .gap_1() .when( has_buttons && (dock.position == DockPosition::Bottom || dock.position == DockPosition::Right), |this| this.child(Divider::vertical().color(DividerColor::Border)), ) .children(buttons) .when(has_buttons && dock.position == DockPosition::Left, |this| { this.child(Divider::vertical().color(DividerColor::Border)) }) } } impl StatusItemView for PanelButtons { fn set_active_pane_item( &mut self, _active_pane_item: Option<&dyn crate::ItemHandle>, _window: &mut Window, _cx: &mut Context, ) { // Nothing to do, panel buttons don't depend on the active center item } fn hide_setting(&self, _: &App) -> Option { // Panel buttons are hidden on a per-panel basis through each panel // button's own context menu. None } } #[cfg(any(test, feature = "test-support"))] pub mod test { use super::*; use gpui::{App, Context, Window, actions, div}; pub struct TestPanel { pub position: DockPosition, pub zoomed: bool, pub active: bool, pub focus_handle: FocusHandle, pub default_size: Pixels, pub flexible: bool, pub activation_priority: u32, } actions!(test_only, [ToggleTestPanel]); impl EventEmitter for TestPanel {} impl TestPanel { pub fn new(position: DockPosition, activation_priority: u32, cx: &mut App) -> Self { Self { position, zoomed: false, active: false, focus_handle: cx.focus_handle(), default_size: px(300.), flexible: false, activation_priority, } } pub fn new_flexible( position: DockPosition, activation_priority: u32, cx: &mut App, ) -> Self { Self { flexible: true, ..Self::new(position, activation_priority, cx) } } } impl Render for TestPanel { fn render(&mut self, _window: &mut Window, cx: &mut Context) -> impl IntoElement { div().id("test").track_focus(&self.focus_handle(cx)) } } impl Panel for TestPanel { fn persistent_name() -> &'static str { "TestPanel" } fn panel_key() -> &'static str { "TestPanel" } fn position(&self, _window: &Window, _: &App) -> super::DockPosition { self.position } fn position_is_valid(&self, _: super::DockPosition) -> bool { true } fn set_position(&mut self, position: DockPosition, _: &mut Window, cx: &mut Context) { self.position = position; cx.update_global::(|_, _| {}); } fn default_size(&self, _window: &Window, _: &App) -> Pixels { self.default_size } fn initial_size_state(&self, _window: &Window, _: &App) -> PanelSizeState { PanelSizeState { size: None, flex: None, } } fn supports_flexible_size(&self) -> bool { self.flexible } fn has_flexible_size(&self, _window: &Window, _: &App) -> bool { self.flexible } fn set_flexible_size( &mut self, flexible: bool, _window: &mut Window, _cx: &mut Context, ) { self.flexible = flexible; } fn icon(&self, _window: &Window, _: &App) -> Option { None } fn icon_tooltip(&self, _window: &Window, _cx: &App) -> Option<&'static str> { None } fn toggle_action(&self) -> Box { ToggleTestPanel.boxed_clone() } fn is_zoomed(&self, _window: &Window, _: &App) -> bool { self.zoomed } fn set_zoomed(&mut self, zoomed: bool, _window: &mut Window, _cx: &mut Context) { self.zoomed = zoomed; } fn set_active(&mut self, active: bool, _window: &mut Window, _cx: &mut Context) { self.active = active; } fn activation_priority(&self) -> u32 { self.activation_priority } } impl Focusable for TestPanel { fn focus_handle(&self, _cx: &App) -> FocusHandle { self.focus_handle.clone() } } }