feat: toggle_floating_state and is_floating (#306)

src/builtin/actions/floating.rs

@@ -52,7 +52,7 @@ pub fn reposition<X: XConn>(dx: i32, dy: i32) -> Box<dyn KeyEventHandler<X>> {
     })
 }
 
-/// Move the currently focused windo to the floating layer in its current on screen position
+/// Move the currently focused window to the floating layer in its current on screen position
 pub fn float_focused<X: XConn>() -> Box<dyn KeyEventHandler<X>> {
     key_handler(|state, x: &X| {
         let id = match state.client_set.current_client() {
@@ -82,6 +82,24 @@ pub fn sink_focused<X: XConn>() -> Box<dyn KeyEventHandler<X>> {
     })
 }
 
+/// Sink the current window if it was floating, float it if it was tiled.
+pub fn toggle_floating_focused<X: XConn>() -> Box<dyn KeyEventHandler<X>> {
+    key_handler(|state, x: &X| {
+        let id = match state.client_set.current_client() {
+            Some(&id) => id,
+            None => return Ok(()),
+        };
+
+        let r = x.client_geometry(id)?;
+
+        x.modify_and_refresh(state, |cs| {
+            if let Err(err) = cs.toggle_floating_state(id, r) {
+                error!(%err, %id, "unable to float requested client window");
+            }
+        })
+    })
+}
+
 /// Float all windows in their current tiled position
 pub fn float_all<X: XConn>() -> Box<dyn KeyEventHandler<X>> {
     key_handler(|state, x: &X| {

src/pure/stack_set.rs

@@ -270,6 +270,11 @@ where
             .map(|rr| rr.applied_to(&self.screens.focus.r))
     }
 
+    /// Check whether a given client is currently floating.
+    pub fn is_floating(&mut self, client: &C) -> bool {
+        self.floating.contains_key(client)
+    }
+
     /// Check whether a given tag currently has any floating windows present.
     ///
     /// Returns false if the tag given is unknown to this StackSet.
@@ -799,6 +804,26 @@ impl StackSet<Xid> {
         Ok(())
     }
 
+    /// If a known client is floating, sink it.
+    /// Otherwise, record it as floating with its preferred screen position.
+    ///
+    /// # Errors
+    /// This method with return [Error::UnknownClient] if the given client is
+    /// not already managed in this stack_set.
+    ///
+    /// This method with return [Error::ClientIsNotVisible] if the given client is
+    /// not currently mapped to a screen. This is required to determine the correct
+    /// relative positioning for the floating client as is it is moved between
+    /// screens.
+    pub fn toggle_floating_state(&mut self, client: Xid, r: Rect) -> Result<Option<Rect>> {
+        Ok(if self.is_floating(&client) {
+            self.sink(&client)
+        } else {
+            self.float(client, r)?;
+            None
+        })
+    }
+
     pub(crate) fn update_screens(&mut self, rects: Vec<Rect>) -> Result<()> {
         let n_old = self.screens.len();
         let n_new = rects.len();