Float Pane

codec/src/lib.rs

@@ -14,9 +14,9 @@
 use anyhow::{bail, Context as _, Error};
 use config::keyassignment::{PaneDirection, ScrollbackEraseMode};
 use mux::client::{ClientId, ClientInfo};
-use mux::pane::PaneId;
+use mux::pane::{PaneId};
 use mux::renderable::{RenderableDimensions, StableCursorPosition};
-use mux::tab::{PaneNode, SerdeUrl, SplitRequest, TabId};
+use mux::tab::{SerdeUrl, SplitDirection, SplitRequest, TabEntry, TabId};
 use mux::window::WindowId;
 use portable_pty::CommandBuilder;
 use rangeset::*;
@@ -441,7 +441,7 @@ macro_rules! pdu {
 /// The overall version of the codec.
 /// This must be bumped when backwards incompatible changes
 /// are made to the types and protocol.
-pub const CODEC_VERSION: usize = 43;
+pub const CODEC_VERSION: usize = 45;
 
 // Defines the Pdu enum.
 // Each struct has an explicit identifying number.
@@ -502,6 +502,11 @@ pdu! {
     GetPaneDirection: 60,
     GetPaneDirectionResponse: 61,
     AdjustPaneSize: 62,
+    SpawnFloatingPane: 63,
+    FloatingPaneVisibilityChanged: 64,
+    MoveFloatingPaneToSplit: 65,
+    MovePaneToFloatingPane: 66,
+    ActiveFloatingPaneChanged: 67,
 }
 
 impl Pdu {
@@ -644,11 +649,31 @@ pub struct ListPanes {}
 
 #[derive(Deserialize, Serialize, PartialEq, Debug)]
 pub struct ListPanesResponse {
-    pub tabs: Vec<PaneNode>,
+    pub tabs: Vec<TabEntry>,
     pub tab_titles: Vec<String>,
     pub window_titles: HashMap<WindowId, String>,
 }
 
+#[derive(Deserialize, Serialize, PartialEq, Debug)]
+pub struct SpawnFloatingPane {
+    pub pane_id: PaneId,
+    pub command: Option<CommandBuilder>,
+    pub command_dir: Option<String>,
+    pub domain: config::keyassignment::SpawnTabDomain,
+}
+
+#[derive(Deserialize, Serialize, PartialEq, Debug)]
+pub struct FloatingPaneVisibilityChanged {
+    pub tab_id: TabId,
+    pub visible: bool
+}
+
+#[derive(Deserialize, Serialize, PartialEq, Debug)]
+pub struct ActiveFloatingPaneChanged {
+    pub index: usize,
+    pub tab_id: TabId,
+}
+
 #[derive(Deserialize, Serialize, PartialEq, Debug)]
 pub struct SplitPane {
     pub pane_id: PaneId,
@@ -661,6 +686,17 @@ pub struct SplitPane {
     pub move_pane_id: Option<PaneId>,
 }
 
+#[derive(Deserialize, Serialize, PartialEq, Debug)]
+pub struct MovePaneToFloatingPane {
+    pub pane_id: PaneId,
+}
+
+#[derive(Deserialize, Serialize, PartialEq, Debug)]
+pub struct MoveFloatingPaneToSplit {
+    pub pane_id: PaneId,
+    pub split_direction: SplitDirection,
+}
+
 #[derive(Deserialize, Serialize, PartialEq, Debug)]
 pub struct MovePaneToNewTab {
     pub pane_id: PaneId,

config/src/color.rs

@@ -598,6 +598,23 @@ pub struct WindowFrameConfig {
     pub border_bottom_color: Option<RgbaColor>,
 }
 
+#[derive(Debug, Clone, FromDynamic, ToDynamic)]
+pub struct FloatingPaneBorderConfig {
+    #[dynamic(try_from = "crate::units::PixelUnit", default = "default_zero_pixel")]
+    pub left_width: Dimension,
+    #[dynamic(try_from = "crate::units::PixelUnit", default = "default_zero_pixel")]
+    pub right_width: Dimension,
+    #[dynamic(try_from = "crate::units::PixelUnit", default = "default_zero_pixel")]
+    pub top_height: Dimension,
+    #[dynamic(try_from = "crate::units::PixelUnit", default = "default_zero_pixel")]
+    pub bottom_height: Dimension,
+
+    pub left_color: Option<RgbaColor>,
+    pub right_color: Option<RgbaColor>,
+    pub top_color: Option<RgbaColor>,
+    pub bottom_color: Option<RgbaColor>,
+}
+
 const fn default_zero_pixel() -> Dimension {
     Dimension::Pixels(0.)
 }
@@ -629,6 +646,21 @@ impl Default for WindowFrameConfig {
     }
 }
 
+impl Default for FloatingPaneBorderConfig {
+    fn default() -> Self {
+        Self {
+            left_width: Dimension::Pixels(3.),
+            right_width: Dimension::Pixels(3.),
+            top_height: Dimension::Pixels(3.),
+            bottom_height: Dimension::Pixels(3.),
+            left_color: Some(default_active_titlebar_bg()),
+            right_color: Some(default_active_titlebar_bg()),
+            top_color: Some(default_active_titlebar_bg()),
+            bottom_color: Some(default_active_titlebar_bg()),
+        }
+    }
+}
+
 fn default_inactive_titlebar_bg() -> RgbaColor {
     RgbColor::new_8bpc(0x33, 0x33, 0x33).into()
 }

config/src/config.rs

@@ -25,7 +25,7 @@ use crate::{
     default_true, default_win32_acrylic_accent_color, GpuInfo, IntegratedTitleButtonColor,
     KeyMapPreference, LoadedConfig, MouseEventTriggerMods, RgbaColor, SerialDomain, SystemBackdrop,
     WebGpuPowerPreference, CONFIG_DIRS, CONFIG_FILE_OVERRIDE, CONFIG_OVERRIDES, CONFIG_SKIP,
-    HOME_DIR,
+    HOME_DIR, FloatingPaneBorderConfig
 };
 use anyhow::Context;
 use luahelper::impl_lua_conversion_dynamic;
@@ -142,6 +142,9 @@ pub struct Config {
     #[dynamic(default)]
     pub window_frame: WindowFrameConfig,
 
+    #[dynamic(default)]
+    pub floating_pane_border: FloatingPaneBorderConfig,
+
     #[dynamic(default = "default_char_select_font_size")]
     pub char_select_font_size: f64,
 
@@ -521,6 +524,9 @@ pub struct Config {
     #[dynamic(default)]
     pub window_padding: WindowPadding,
 
+    #[dynamic(default = "default_floating_pane_padding")]
+    pub floating_pane_padding: WindowPadding,
+
     /// Specifies the path to a background image attachment file.
     /// The file can be any image format that the rust `image`
     /// crate is able to identify and load.
@@ -1579,6 +1585,15 @@ fn default_integrated_title_buttons() -> Vec<IntegratedTitleButton> {
     vec![Hide, Maximize, Close]
 }
 
+fn default_floating_pane_padding() -> WindowPadding {
+    WindowPadding{
+        left: Dimension::Percent(0.20),
+        top: Dimension::Percent(0.20),
+        right: Dimension::Percent(0.20),
+        bottom: Dimension::Percent(0.20),
+    }
+}
+
 fn default_char_select_font_size() -> f64 {
     18.0
 }

config/src/keyassignment.rs

@@ -337,6 +337,7 @@ pub enum PaneSelectMode {
     SwapWithActiveKeepFocus,
     MoveToNewTab,
     MoveToNewWindow,
+    MoveToFloatingPane
 }
 
 impl Default for PaneSelectMode {
@@ -557,8 +558,10 @@ pub enum KeyAssignment {
     QuitApplication,
     SpawnCommandInNewTab(SpawnCommand),
     SpawnCommandInNewWindow(SpawnCommand),
+    SpawnCommandInNewFloatingPane(SpawnCommand),
     SplitHorizontal(SpawnCommand),
     SplitVertical(SpawnCommand),
+    ToggleFloatingPane,
     ShowLauncher,
     ShowLauncherArgs(LauncherActionArgs),
     ClearScrollback(ScrollbackEraseMode),
@@ -625,6 +628,8 @@ pub enum KeyAssignment {
     ActivateWindowRelativeNoWrap(isize),
     PromptInputLine(PromptInputLine),
     InputSelector(InputSelector),
+    MoveFloatingPaneToHorizontalSplit,
+    MoveFloatingPaneToVerticalSplit,
 }
 impl_lua_conversion_dynamic!(KeyAssignment);
 

docs/config/lua/MuxTab/panes_with_info.md

@@ -10,6 +10,7 @@ Each element is a lua table with the following fields:
 * `index` - the topological pane index
 * `is_active` - a boolean indicating whether this is the active pane within the tab
 * `is_zoomed` - a boolean indicating whether this pane is zoomed
+* `is_floating` - a boolean indicating whether this pane is floating
 * `left` - The offset from the top left corner of the containing tab to the top left corner of this pane, in cells.
 * `top` - The offset from the top left corner of the containing tab to the top left corner of this pane, in cells.
 * `width` - The width of this pane in cells

docs/config/lua/PaneInformation.md

@@ -11,6 +11,7 @@ The `PaneInformation` struct contains the following fields:
 * `pane_index` - the logical position of the pane within its containing layout
 * `is_active` - is true if the pane is the active pane within its containing tab
 * `is_zoomed` - is true if the pane is in the zoomed state
+* `is_floating` - is true if the pane is in the floating state
 * `left` - the cell x coordinate of the left edge of the pane
 * `top` - the cell y coordinate of the top edge of the pane
 * `width` - the width of the pane in cells

mux/src/domain.rs

@@ -7,7 +7,7 @@
 
 use crate::localpane::LocalPane;
 use crate::pane::{alloc_pane_id, Pane, PaneId};
-use crate::tab::{SplitRequest, Tab, TabId};
+use crate::tab::{SplitDirection, SplitRequest, Tab, TabId};
 use crate::window::WindowId;
 use crate::Mux;
 use anyhow::{bail, Context, Error};
@@ -71,6 +71,33 @@ pub trait Domain: Downcast + Send + Sync {
         Ok(tab)
     }
 
+    async fn add_floating_pane(
+        &self,
+        tab: TabId,
+        _pane_id: PaneId,
+        command_builder: Option<CommandBuilder>,
+        command_dir: Option<String>
+    ) -> anyhow::Result<Arc<dyn Pane>> {
+        let mux = Mux::get();
+        let tab = match mux.get_tab(tab) {
+            Some(t) => t,
+            None => anyhow::bail!("Invalid tab id {}", tab),
+        };
+
+        let size = tab.compute_floating_pane_size();
+        let pane = self.spawn_pane(size, command_builder, command_dir).await?;
+        tab.add_floating_pane(size, Arc::clone(&pane))?;
+        Ok(pane)
+    }
+
+    async fn move_floating_pane_to_split(
+        &self,
+        _tab: TabId,
+        _direction: SplitDirection,
+    ) -> anyhow::Result<bool> {
+        Ok(false)
+    }
+
     async fn split_pane(
         &self,
         source: SplitSource,
@@ -151,6 +178,13 @@ pub trait Domain: Downcast + Send + Sync {
         Ok(None)
     }
 
+    async fn move_pane_to_floating_pane(
+        &self,
+        _pane_id: PaneId,
+    ) -> anyhow::Result<bool> {
+        Ok(false)
+    }
+
     /// Returns false if the `spawn` method will never succeed.
     /// There are some internal placeholder domains that are
     /// pre-created with local UI that we do not want to allow