feat(cli): add session float rule cmds

This commit introduces three new commands, session-float-rule,
session-float-rules, and clear-session-float-rules, which add a
composite float rule for the currently focused window for the duration
of the komorebi session, print the float rules scoped to the current
komorebi session, and clear any float rules scoped to the current
komorebi session respectively.

The composite rule created is fairly strict, using
MatchingStrategy::Equals on the Exe, Class and Title.

Users can run session-float-rule as they are working to avoid having to
break their workflow and edit their configuration file, and when they
are ready, they can run session-float-rules to print out the composite
rules which have been generated and added to the current session to
further refine before adding them to their configuration files.

re #1402

docs/cli/clear-session-float-rules.md

@@ -0,0 +1,12 @@
+# clear-session-float-rules
+
+```
+Clear all session float rules
+
+Usage: komorebic.exe clear-session-float-rules
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/session-float-rule.md

@@ -0,0 +1,12 @@
+# session-float-rule
+
+```
+Add a rule to float the foreground window for the rest of this session
+
+Usage: komorebic.exe session-float-rule
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/session-float-rules.md

@@ -0,0 +1,12 @@
+# session-float-rules
+
+```
+Show all session float rules
+
+Usage: komorebic.exe session-float-rules
+
+Options:
+  -h, --help
+          Print help
+
+```

komorebi/src/core/mod.rs

@@ -202,6 +202,9 @@ pub enum SocketMessage {
     ClearNamedWorkspaceRules(String),
     ClearAllWorkspaceRules,
     EnforceWorkspaceRules,
+    SessionFloatRule,
+    SessionFloatRules,
+    ClearSessionFloatRules,
     #[serde(alias = "FloatRule")]
     IgnoreRule(ApplicationIdentifier, String),
     ManageRule(ApplicationIdentifier, String),

komorebi/src/lib.rs

@@ -158,6 +158,7 @@ lazy_static! {
             matching_strategy: Option::from(MatchingStrategy::Equals),
         })
     ]));
+    static ref SESSION_FLOATING_APPLICATIONS: Arc<Mutex<Vec<MatchingRule>>> = Arc::new(Mutex::new(Vec::new()));
     static ref FLOATING_APPLICATIONS: Arc<Mutex<Vec<MatchingRule>>> = Arc::new(Mutex::new(Vec::new()));
     static ref PERMAIGNORE_CLASSES: Arc<Mutex<Vec<String>>> = Arc::new(Mutex::new(vec![
         "Chrome_RenderWidgetHostHWND".to_string(),

komorebi/src/process_command.rs

@@ -72,6 +72,7 @@ use crate::State;
 use crate::CUSTOM_FFM;
 use crate::DATA_DIR;
 use crate::DISPLAY_INDEX_PREFERENCES;
+use crate::FLOATING_APPLICATIONS;
 use crate::HIDING_BEHAVIOUR;
 use crate::IGNORE_IDENTIFIERS;
 use crate::INITIAL_CONFIGURATION_LOADED;
@@ -81,6 +82,7 @@ use crate::MONITOR_INDEX_PREFERENCES;
 use crate::NO_TITLEBAR;
 use crate::OBJECT_NAME_CHANGE_ON_LAUNCH;
 use crate::REMOVE_TITLEBARS;
+use crate::SESSION_FLOATING_APPLICATIONS;
 use crate::SUBSCRIPTION_PIPES;
 use crate::SUBSCRIPTION_SOCKETS;
 use crate::SUBSCRIPTION_SOCKET_OPTIONS;
@@ -396,7 +398,7 @@ impl WindowManager {
                 workspace.locked_containers.remove(&container_idx);
             }
             SocketMessage::ToggleLock => self.toggle_lock()?,
-            SocketMessage::ToggleFloat => self.toggle_float()?,
+            SocketMessage::ToggleFloat => self.toggle_float(false)?,
             SocketMessage::ToggleMonocle => self.toggle_monocle()?,
             SocketMessage::ToggleMaximize => self.toggle_maximize()?,
             SocketMessage::ContainerPadding(monitor_idx, workspace_idx, size) => {
@@ -543,6 +545,53 @@ impl WindowManager {
                     }));
                 }
             }
+            SocketMessage::SessionFloatRule => {
+                let foreground_window = WindowsApi::foreground_window()?;
+                let window = Window::from(foreground_window);
+                if let (Ok(exe), Ok(title), Ok(class)) =
+                    (window.exe(), window.title(), window.class())
+                {
+                    let rule = MatchingRule::Composite(vec![
+                        IdWithIdentifier {
+                            kind: ApplicationIdentifier::Exe,
+                            id: exe,
+                            matching_strategy: Option::from(MatchingStrategy::Equals),
+                        },
+                        IdWithIdentifier {
+                            kind: ApplicationIdentifier::Title,
+                            id: title,
+                            matching_strategy: Option::from(MatchingStrategy::Equals),
+                        },
+                        IdWithIdentifier {
+                            kind: ApplicationIdentifier::Class,
+                            id: class,
+                            matching_strategy: Option::from(MatchingStrategy::Equals),
+                        },
+                    ]);
+
+                    let mut floating_applications = FLOATING_APPLICATIONS.lock();
+                    floating_applications.push(rule.clone());
+                    let mut session_floating_applications = SESSION_FLOATING_APPLICATIONS.lock();
+                    session_floating_applications.push(rule.clone());
+
+                    self.toggle_float(true)?;
+                }
+            }
+            SocketMessage::SessionFloatRules => {
+                let session_floating_applications = SESSION_FLOATING_APPLICATIONS.lock();
+                let rules = match serde_json::to_string_pretty(&*session_floating_applications) {
+                    Ok(rules) => rules,
+                    Err(error) => error.to_string(),
+                };
+
+                reply.write_all(rules.as_bytes())?;
+            }
+            SocketMessage::ClearSessionFloatRules => {
+                let mut floating_applications = FLOATING_APPLICATIONS.lock();
+                let mut session_floating_applications = SESSION_FLOATING_APPLICATIONS.lock();
+                floating_applications.retain(|r| !session_floating_applications.contains(r));
+                session_floating_applications.clear()
+            }
             SocketMessage::IgnoreRule(identifier, ref id) => {
                 let mut ignore_identifiers = IGNORE_IDENTIFIERS.lock();
 

komorebi/src/window_manager.rs

@@ -3094,7 +3094,7 @@ impl WindowManager {
     }
 
     #[tracing::instrument(skip(self))]
-    pub fn toggle_float(&mut self) -> Result<()> {
+    pub fn toggle_float(&mut self, force_float: bool) -> Result<()> {
         let hwnd = WindowsApi::foreground_window()?;
         let workspace = self.focused_workspace_mut()?;
 
@@ -3106,7 +3106,7 @@ impl WindowManager {
             }
         }
 
-        if is_floating_window {
+        if is_floating_window && !force_float {
             workspace.set_layer(WorkspaceLayer::Tiling);
             self.unfloat_window()?;
         } else {

komorebic/src/main.rs

@@ -1323,6 +1323,12 @@ enum SubCommand {
     /// Set the operation behaviour when the focused window is not managed
     #[clap(arg_required_else_help = true)]
     UnmanagedWindowOperationBehaviour(UnmanagedWindowOperationBehaviour),
+    /// Add a rule to float the foreground window for the rest of this session
+    SessionFloatRule,
+    /// Show all session float rules
+    SessionFloatRules,
+    /// Clear all session float rules
+    ClearSessionFloatRules,
     /// Add a rule to ignore the specified application
     #[clap(arg_required_else_help = true)]
     #[clap(alias = "float-rule")]
@@ -2535,6 +2541,15 @@ if (Get-Command Get-CimInstance -ErrorAction SilentlyContinue) {
                 }
             }
         }
+        SubCommand::SessionFloatRule => {
+            send_message(&SocketMessage::SessionFloatRule)?;
+        }
+        SubCommand::SessionFloatRules => {
+            print_query(&SocketMessage::SessionFloatRules);
+        }
+        SubCommand::ClearSessionFloatRules => {
+            send_message(&SocketMessage::ClearSessionFloatRules)?;
+        }
         SubCommand::IgnoreRule(arg) => {
             send_message(&SocketMessage::IgnoreRule(arg.identifier, arg.id))?;
         }

mkdocs.yml

@@ -206,6 +206,9 @@ nav:
       - cli/cross-monitor-move-behaviour.md
       - cli/toggle-cross-monitor-move-behaviour.md
       - cli/unmanaged-window-operation-behaviour.md
+      - cli/session-float-rule.md
+      - cli/session-float-rules.md
+      - cli/clear-session-float-rules.md
       - cli/ignore-rule.md
       - cli/manage-rule.md
       - cli/initial-workspace-rule.md
@@ -247,4 +250,4 @@ nav:
       - cli/static-config-schema.md
       - cli/generate-static-config.md
       - cli/enable-autostart.md
-      - cli/disable-autostart.md
+      - cli/disable-autostart.md