Allow toggling pane frames for specific panes (#4615)

* initial implementation

* add borderless to edit and plugin cli commands

* allow changing existing pane to borderless

* allow setting in layouts and keybindings

* get to work through the existing plugin api commands

* fix when applying (swap) layouts

* fix tests

* allow setting pane as bordered (borderful?) when changing its coordinates (eg. through the cli)

* allow explicitly setting a pane as bordered or borderless without toggling

* rustfmt

* adjust snapshots

* docs(changelog): add PR

3 files changed, 71 insertions, 8 deletions

diff --git a/zellij-utils/assets/prost/api.action.rs b/zellij-utils/assets/prost/api.action.rs
index 52ab0ab0..b7ccb156 100644
--- a/zellij-utils/assets/prost/api.action.rs
+++ b/zellij-utils/assets/prost/api.action.rs
@@ -183,6 +183,8 @@ pub struct FloatingPaneLayout {
     pub pane_initial_contents: ::core::option::Option<::prost::alloc::string::String>,
     #[prost(uint32, optional, tag="11")]
     pub logical_position: ::core::option::Option<u32>,
+    #[prost(bool, optional, tag="12")]
+    pub borderless: ::core::option::Option<bool>,
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
@@ -288,7 +290,7 @@ pub struct OverrideLayoutPayload {
 pub struct Action {
     #[prost(enumeration="ActionName", tag="1")]
     pub name: i32,
-    #[prost(oneof="action::OptionalPayload", tags="2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53")]
+    #[prost(oneof="action::OptionalPayload", tags="2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54")]
     pub optional_payload: ::core::option::Option<action::OptionalPayload>,
 }
 /// Nested message and enum types in `Action`.
@@ -394,6 +396,8 @@ pub mod action {
         NewInPlacePanePayload(super::NewInPlacePanePayload),
         #[prost(message, tag="53")]
         OverrideLayoutPayload(super::OverrideLayoutPayload),
+        #[prost(message, tag="54")]
+        SetPaneBorderlessPayload(super::SetPaneBorderlessPayload),
     }
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -632,6 +636,17 @@ pub struct FloatingPaneCoordinates {
     pub height: ::core::option::Option<SplitSize>,
     #[prost(bool, optional, tag="5")]
     pub pinned: ::core::option::Option<bool>,
+    #[prost(bool, optional, tag="6")]
+    pub borderless: ::core::option::Option<bool>,
+}
+/// SetPaneBorderlessPayload specifies the pane and borderless state
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct SetPaneBorderlessPayload {
+    #[prost(message, optional, tag="1")]
+    pub pane_id: ::core::option::Option<PaneId>,
+    #[prost(bool, tag="2")]
+    pub borderless: bool,
 }
 /// NewPanePlacement specifies where a new pane should be placed
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -1025,6 +1040,7 @@ pub enum ActionName {
     NewBlockingPane = 91,
     NewInPlacePane = 92,
     OverrideLayout = 93,
+    SetPaneBorderless = 94,
 }
 impl ActionName {
     /// String value of the enum field names used in the ProtoBuf definition.
@@ -1124,6 +1140,7 @@ impl ActionName {
             ActionName::NewBlockingPane => "NewBlockingPane",
             ActionName::NewInPlacePane => "NewInPlacePane",
             ActionName::OverrideLayout => "OverrideLayout",
+            ActionName::SetPaneBorderless => "SetPaneBorderless",
         }
     }
     /// Creates an enum from field names used in the ProtoBuf definition.
@@ -1220,6 +1237,7 @@ impl ActionName {
             "NewBlockingPane" => Some(Self::NewBlockingPane),
             "NewInPlacePane" => Some(Self::NewInPlacePane),
             "OverrideLayout" => Some(Self::OverrideLayout),
+            "SetPaneBorderless" => Some(Self::SetPaneBorderless),
             _ => None,
         }
     }
diff --git a/zellij-utils/assets/prost/api.plugin_command.rs b/zellij-utils/assets/prost/api.plugin_command.rs
index 7caeb247..d11cc9e0 100644
--- a/zellij-utils/assets/prost/api.plugin_command.rs
+++ b/zellij-utils/assets/prost/api.plugin_command.rs
@@ -3,7 +3,7 @@
 pub struct PluginCommand {
     #[prost(enumeration="CommandName", tag="1")]
     pub name: i32,
-    #[prost(oneof="plugin_command::Payload", tags="2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134")]
+    #[prost(oneof="plugin_command::Payload", tags="2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136")]
     pub payload: ::core::option::Option<plugin_command::Payload>,
 }
 /// Nested message and enum types in `PluginCommand`.
@@ -251,6 +251,10 @@ pub mod plugin_command {
         DumpSessionLayoutPayload(super::DumpSessionLayoutPayload),
         #[prost(message, tag="134")]
         GetFocusedPaneInfoPayload(super::GetFocusedPaneInfoPayload),
+        #[prost(message, tag="135")]
+        TogglePaneBorderlessPayload(super::TogglePaneBorderlessPayload),
+        #[prost(message, tag="136")]
+        SetPaneBorderlessPayload(super::SetPaneBorderlessPayload),
     }
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
@@ -461,6 +465,20 @@ pub struct SetFloatingPanePinnedPayload {
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
+pub struct TogglePaneBorderlessPayload {
+    #[prost(message, optional, tag="1")]
+    pub pane_id: ::core::option::Option<PaneId>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct SetPaneBorderlessPayload {
+    #[prost(message, optional, tag="1")]
+    pub pane_id: ::core::option::Option<PaneId>,
+    #[prost(bool, tag="2")]
+    pub borderless: bool,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
 pub struct ChangeHostFolderPayload {
     #[prost(string, tag="1")]
     pub new_host_folder: ::prost::alloc::string::String,
@@ -891,6 +909,8 @@ pub struct FloatingPaneCoordinates {
     pub height: ::core::option::Option<FixedOrPercentValue>,
     #[prost(bool, optional, tag="5")]
     pub pinned: ::core::option::Option<bool>,
+    #[prost(bool, optional, tag="6")]
+    pub borderless: ::core::option::Option<bool>,
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
@@ -1392,6 +1412,8 @@ pub enum CommandName {
     RenameLayout = 181,
     GetLayoutDir = 182,
     GetFocusedPaneInfo = 183,
+    TogglePaneBorderless = 184,
+    SetPaneBorderless = 185,
 }
 impl CommandName {
     /// String value of the enum field names used in the ProtoBuf definition.
@@ -1563,6 +1585,8 @@ impl CommandName {
             CommandName::RenameLayout => "RenameLayout",
             CommandName::GetLayoutDir => "GetLayoutDir",
             CommandName::GetFocusedPaneInfo => "GetFocusedPaneInfo",
+            CommandName::TogglePaneBorderless => "TogglePaneBorderless",
+            CommandName::SetPaneBorderless => "SetPaneBorderless",
         }
     }
     /// Creates an enum from field names used in the ProtoBuf definition.
@@ -1731,6 +1755,8 @@ impl CommandName {
             "RenameLayout" => Some(Self::RenameLayout),
             "GetLayoutDir" => Some(Self::GetLayoutDir),
             "GetFocusedPaneInfo" => Some(Self::GetFocusedPaneInfo),
+            "TogglePaneBorderless" => Some(Self::TogglePaneBorderless),
+            "SetPaneBorderless" => Some(Self::SetPaneBorderless),
             _ => None,
         }
     }
diff --git a/zellij-utils/assets/prost_ipc/client_server_contract.rs b/zellij-utils/assets/prost_ipc/client_server_contract.rs
index 8d3680c2..51f8aca3 100644
--- a/zellij-utils/assets/prost_ipc/client_server_contract.rs
+++ b/zellij-utils/assets/prost_ipc/client_server_contract.rs
@@ -119,7 +119,7 @@ pub struct RgbColor {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Action {
-    #[prost(oneof="action::ActionType", tags="1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94")]
+    #[prost(oneof="action::ActionType", tags="1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 95, 96, 90, 91, 92, 93, 94")]
     pub action_type: ::core::option::Option<action::ActionType>,
 }
 /// Nested message and enum types in `Action`.
@@ -305,6 +305,10 @@ pub mod action {
         StackPanes(super::StackPanesAction),
         #[prost(message, tag="89")]
         ChangeFloatingPaneCoordinates(super::ChangeFloatingPaneCoordinatesAction),
+        #[prost(message, tag="95")]
+        TogglePaneBorderless(super::TogglePaneBorderlessAction),
+        #[prost(message, tag="96")]
+        SetPaneBorderless(super::SetPaneBorderlessAction),
         #[prost(message, tag="90")]
         TogglePaneInGroup(super::TogglePaneInGroupAction),
         #[prost(message, tag="91")]
@@ -987,6 +991,20 @@ pub struct ChangeFloatingPaneCoordinatesAction {
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
+pub struct TogglePaneBorderlessAction {
+    #[prost(message, optional, tag="1")]
+    pub pane_id: ::core::option::Option<PaneId>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct SetPaneBorderlessAction {
+    #[prost(message, optional, tag="1")]
+    pub pane_id: ::core::option::Option<PaneId>,
+    #[prost(bool, tag="2")]
+    pub borderless: bool,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Position {
     /// Changed from uint32 to int32 to support negative line numbers
     #[prost(int32, tag="1")]
@@ -1148,10 +1166,8 @@ pub struct OpenFilePayload {
     pub file_to_open: ::prost::alloc::string::String,
     #[prost(uint32, optional, tag="2")]
     pub line_number: ::core::option::Option<u32>,
-    /// Renumbered after removing column_number
     #[prost(string, optional, tag="3")]
     pub cwd: ::core::option::Option<::prost::alloc::string::String>,
-    /// Added missing originating_plugin field
     #[prost(message, optional, tag="4")]
     pub originating_plugin: ::core::option::Option<OriginatingPlugin>,
 }
@@ -1166,9 +1182,10 @@ pub struct FloatingPaneCoordinates {
     pub width: ::core::option::Option<FloatingCoordinate>,
     #[prost(message, optional, tag="4")]
     pub height: ::core::option::Option<FloatingCoordinate>,
-    /// Added missing pinned field
     #[prost(bool, optional, tag="5")]
     pub pinned: ::core::option::Option<bool>,
+    #[prost(bool, optional, tag="6")]
+    pub borderless: ::core::option::Option<bool>,
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
@@ -1225,8 +1242,8 @@ pub struct TiledPaneLayout {
     pub split_size: ::core::option::Option<SplitSize>,
     #[prost(message, optional, tag="5")]
     pub run: ::core::option::Option<Run>,
-    #[prost(bool, tag="6")]
-    pub borderless: bool,
+    #[prost(bool, optional, tag="6")]
+    pub borderless: ::core::option::Option<bool>,
     #[prost(string, optional, tag="7")]
     pub focus: ::core::option::Option<::prost::alloc::string::String>,
     #[prost(bool, optional, tag="8")]
@@ -1268,6 +1285,8 @@ pub struct FloatingPaneLayout {
     pub pane_initial_contents: ::core::option::Option<::prost::alloc::string::String>,
     #[prost(uint32, optional, tag="11")]
     pub logical_position: ::core::option::Option<u32>,
+    #[prost(bool, optional, tag="12")]
+    pub borderless: ::core::option::Option<bool>,
 }
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]