feat: layout button (#24)

Co-authored-by: mosamadeeb <mosamaeldeeb@gmail.com>

Author: amrbashir

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Added 
+
+- Add button to show active workspace layout and click to cycle through available layouts.
+
 ### Changed
 
 - Active workspace indicator will no longer appear on top of the switcher button and will always be at the bottom of it.

src/komorebi/client.rs

@@ -27,13 +27,20 @@ impl<T> MaybeRingOrVec<T> {
     }
 }
 
+#[derive(Debug, Deserialize, Clone)]
+pub struct KLayout {
+    #[serde(rename = "Default")]
+    pub default: String,
+}
+
 #[derive(Debug, Deserialize, Clone)]
 pub struct KWorkspace {
     pub name: Option<String>,
     pub containers: Ring<serde_json::Value>,
     pub maximized_window: Option<serde_json::Value>,
     pub monocle_container: Option<serde_json::Value>,
     pub floating_windows: MaybeRingOrVec<serde_json::Value>,
+    pub layout: KLayout,
 }
 
 impl KWorkspace {
@@ -83,12 +90,32 @@ pub struct KState {
     pub monitors: Ring<KMonitor>,
 }
 
+#[derive(Debug, strum::Display, Serialize, Deserialize)]
+pub enum KStateQuery {
+    FocusedMonitorIndex,
+    FocusedWorkspaceIndex,
+    FocusedContainerIndex,
+    FocusedWindowIndex,
+    FocusedWorkspaceName,
+    FocusedWorkspaceLayout, // We can use this to get the layout
+    FocusedContainerKind,
+    Version,
+}
+
+#[derive(Debug, strum::Display, Serialize, Deserialize)]
+pub enum KCycleDirection {
+    Previous,
+    Next,
+}
+
 #[derive(Debug, strum::Display, Serialize, Deserialize)]
 #[serde(tag = "type", content = "content")]
 pub enum KSocketMessage {
     State,
     AddSubscriberSocket(String),
     FocusMonitorWorkspaceNumber(usize, usize),
+    CycleLayout(KCycleDirection),
+    Query(KStateQuery),
 }
 
 #[derive(Debug, strum::Display, Serialize, Deserialize)]
@@ -101,6 +128,7 @@ pub enum KSocketEvent {
     FocusWorkspaceNumbers,
     CycleFocusMonitor,
     CycleFocusWorkspace,
+    CycleLayout,
     ReloadConfiguration,
     ReplaceConfiguration,
     CompleteConfiguration,

src/komorebi/mod.rs

@@ -3,6 +3,8 @@ use std::time::Duration;
 
 use client::*;
 
+pub use crate::komorebi::client::KCycleDirection as CycleDirection;
+
 mod client;
 
 #[derive(Debug, Clone, Default, Copy)]
@@ -44,6 +46,7 @@ pub struct Workspace {
     pub index: usize,
     pub focused: bool,
     pub is_empty: bool,
+    pub layout: String,
 }
 
 #[derive(Debug, Clone, Default)]
@@ -57,6 +60,10 @@ pub struct Monitor {
 }
 
 impl Monitor {
+    pub fn focused_workspace(&self) -> Option<&Workspace> {
+        self.workspaces.iter().find(|ws| ws.focused)
+    }
+
     fn from(monitor: KMonitor, index: usize) -> Self {
         let workspaces = monitor
             .workspaces
@@ -71,6 +78,7 @@ impl Monitor {
                     .name
                     .clone()
                     .unwrap_or_else(|| (idx + 1).to_string()),
+                layout: workspace.layout.default.clone(),
             })
             .collect();
 
@@ -134,6 +142,15 @@ pub fn change_workspace(monitor_idx: usize, workspace_idx: usize) {
     }
 }
 
+pub fn cycle_layout(direction: CycleDirection) {
+    tracing::info!("Changing to {direction} komorebi layout");
+
+    let change_msg = KSocketMessage::CycleLayout(direction);
+    if let Err(e) = client::send_message(&change_msg) {
+        tracing::error!("Failed to change layout: {e}")
+    }
+}
+
 #[cfg(debug_assertions)]
 const SOCK_NAME: &str = "komorebi-switcher-debug.sock";
 #[cfg(not(debug_assertions))]

src/macos/layout_button.rs

@@ -0,0 +1,123 @@
+use std::cell::{Cell, RefCell};
+
+use objc2::rc::Retained;
+use objc2::{define_class, msg_send, sel, AnyThread, DefinedClass, MainThreadOnly};
+use objc2_app_kit::{NSButton, NSColor, NSEvent, NSTrackingArea, NSTrackingAreaOptions};
+use objc2_foundation::{MainThreadMarker, NSObjectProtocol, NSString};
+
+use crate::komorebi::CycleDirection;
+
+#[derive(Debug)]
+pub struct LayoutButtonIvars {
+    workspace: crate::komorebi::Workspace,
+    is_hovering: Cell<bool>,
+    tracking_area: RefCell<Option<Retained<NSTrackingArea>>>,
+}
+
+impl LayoutButtonIvars {
+    fn new(workspace: crate::komorebi::Workspace) -> Self {
+        Self {
+            workspace,
+            is_hovering: Cell::new(false),
+            tracking_area: RefCell::new(None),
+        }
+    }
+}
+
+define_class!(
+    /// A Custom button representing a workspace in the status bar.
+    /// Displays an indicator for focused and non-empty workspaces.
+    #[unsafe(super = NSButton)]
+    #[thread_kind = MainThreadOnly]
+    #[ivars = LayoutButtonIvars]
+    #[derive(Debug)]
+    pub struct LayoutButton;
+
+    unsafe impl NSObjectProtocol for LayoutButton {}
+
+    impl LayoutButton {
+        #[unsafe(method(buttonClicked:))]
+        fn button_clicked(&self, _sender: &NSButton) {
+            crate::komorebi::cycle_layout(CycleDirection::Next);
+        }
+
+        #[unsafe(method(mouseEntered:))]
+        fn mouse_entered(&self, _event: &NSEvent) {
+            self.ivars().is_hovering.set(true);
+            let layer = self.layer().unwrap();
+            let hover_color = NSColor::colorWithWhite_alpha(1.0, 0.1).CGColor();
+            let _: () = unsafe { msg_send![&layer, setBackgroundColor: &*hover_color] };
+        }
+
+        #[unsafe(method(mouseExited:))]
+        fn mouse_exited(&self, _event: &NSEvent) {
+            if self.ivars().workspace.focused {
+                return;
+            }
+
+            self.ivars().is_hovering.set(false);
+            let layer = self.layer().unwrap();
+            let clear_color = NSColor::clearColor().CGColor();
+            let _: () = unsafe { msg_send![&layer, setBackgroundColor: &*clear_color] };
+        }
+
+        #[unsafe(method(updateTrackingAreas))]
+        fn update_tracking_areas(&self) {
+            // Remove old tracking area if it exists
+            if let Some(old_tracking_area) = self.ivars().tracking_area.borrow().as_ref() {
+                self.removeTrackingArea(old_tracking_area);
+            }
+
+            // Create new tracking area
+            let options = NSTrackingAreaOptions::MouseEnteredAndExited
+                | NSTrackingAreaOptions::ActiveAlways;
+            let tracking_area = unsafe {
+                NSTrackingArea::initWithRect_options_owner_userInfo(
+                    NSTrackingArea::alloc(),
+                    self.bounds(),
+                    options,
+                    Some(self),
+                    None,
+                )
+            };
+            self.addTrackingArea(&tracking_area);
+
+            // Store tracking area
+            *self.ivars().tracking_area.borrow_mut() = Some(tracking_area);
+        }
+    }
+);
+
+impl LayoutButton {
+    pub fn new(mtm: MainThreadMarker, workspace: &crate::komorebi::Workspace) -> Retained<Self> {
+        // Create button
+        let this = Self::alloc(mtm).set_ivars(LayoutButtonIvars::new(workspace.clone()));
+        // SAFETY: The signature of `NSButton`'s `init` method is correct.
+        let this: Retained<Self> = unsafe { msg_send![super(this), init] };
+
+        // Configure button
+        this.setTitle(&NSString::from_str(&workspace.layout));
+
+        // Set up action handler
+        unsafe { this.setTarget(Some(&this)) };
+        unsafe { this.setAction(Some(sel!(buttonClicked:))) };
+
+        // Make button transparent
+        this.setBordered(false);
+        this.setWantsLayer(true);
+        let layer = this.layer().unwrap();
+        let _: () = unsafe { msg_send![&layer, setCornerRadius: 4.0] };
+
+        // Add size constraints for padding (since bezel is removed)
+        let height_constraint = this
+            .heightAnchor()
+            .constraintGreaterThanOrEqualToConstant(24.0);
+        height_constraint.setActive(true);
+
+        // Set background color based on focus state
+        let bg_color = NSColor::clearColor().CGColor();
+        let _: () = unsafe { msg_send![&layer, setBackgroundColor: &*bg_color] };
+
+        this
+    }
+}

src/macos/mod.rs

@@ -6,31 +6,35 @@ use objc2::runtime::ProtocolObject;
 use objc2::{define_class, msg_send, DefinedClass, MainThreadOnly};
 use objc2_app_kit::{
     NSApp, NSApplication, NSApplicationActivationPolicy, NSApplicationDelegate, NSStatusBar,
-    NSStatusItem, NSUserInterfaceLayoutOrientation, NSVariableStatusItemLength,
+    NSStatusItem, NSTextAlignment, NSTextField, NSUserInterfaceLayoutOrientation,
+    NSVariableStatusItemLength, NSView,
 };
 use objc2_foundation::{
-    MainThreadMarker, NSNotification, NSObject, NSObjectProtocol, NSPoint, NSRect, NSSize,
+    ns_string, MainThreadMarker, NSNotification, NSObject, NSObjectProtocol, NSPoint, NSRect,
+    NSSize,
 };
 
 use self::workspace_button::WorkspaceButton;
 use self::workspaces_stack_view::WorkspacesStackView;
+use crate::macos::layout_button::LayoutButton;
 
+mod layout_button;
 mod workspace_button;
 mod workspaces_stack_view;
 
 #[derive(Debug)]
 pub struct AppDelegateIvars {
     ns_status_item: OnceCell<Retained<NSStatusItem>>,
     ns_stack_view: OnceCell<Retained<WorkspacesStackView>>,
-    workspace_buttons: RefCell<Vec<Retained<WorkspaceButton>>>,
+    buttons: RefCell<Vec<Retained<NSView>>>,
 }
 
 impl Default for AppDelegateIvars {
     fn default() -> Self {
         Self {
             ns_status_item: OnceCell::new(),
             ns_stack_view: OnceCell::new(),
-            workspace_buttons: RefCell::new(Vec::new()),
+            buttons: RefCell::new(Vec::new()),
         }
     }
 }
@@ -126,17 +130,17 @@ impl AppDelegate {
         let mtm = self.mtm();
         // SAFETY: We have initialized these ivars in `did_finish_launching`.
         let stack_view = self.ivars().ns_stack_view.get().unwrap();
-        let mut workspace_buttons = self.ivars().workspace_buttons.borrow_mut();
+        let mut views = self.ivars().buttons.borrow_mut();
 
         // Remove all existing buttons from stack view
-        for button in workspace_buttons.iter() {
+        for button in views.iter() {
             button.removeFromSuperview();
         }
 
-        workspace_buttons.clear();
+        views.clear();
 
         // Get first monitor (we only support one for now)
-        let Some(monitor) = state.monitors.get(0) else {
+        let Some(monitor) = state.monitors.first() else {
             return;
         };
 
@@ -146,7 +150,23 @@ impl AppDelegate {
             stack_view.addArrangedSubview(&workspace_button);
 
             // Store button
-            workspace_buttons.push(workspace_button);
+            views.push(workspace_button.downcast().unwrap());
+        }
+
+        // show layout button for focused workspace
+        if let Some(focused_ws) = monitor.focused_workspace() {
+            let separator = NSTextField::labelWithString(ns_string!("|"), mtm);
+            separator.setAlignment(NSTextAlignment::Center);
+            stack_view.addArrangedSubview(&separator);
+
+            // Store separator
+            views.push(separator.downcast().unwrap());
+
+            let layout_button = LayoutButton::new(mtm, focused_ws);
+            stack_view.addArrangedSubview(&layout_button);
+
+            // Store button
+            views.push(layout_button.downcast().unwrap());
         }
 
         // SAFETY: We have initialized this ivar in `did_finish_launching`.
@@ -155,7 +175,7 @@ impl AppDelegate {
         // Update status item button frame to match new stack view size
         if let Some(btn) = ns_status_item.button(mtm) {
             let fitting_size = stack_view.fittingSize();
-            let size = NSSize::new(fitting_size.width, fitting_size.height);
+            let size = NSSize::new(fitting_size.width, WorkspaceButton::HEIGHT);
             let frame = NSRect::new(NSPoint::new(0.0, 0.0), size);
             stack_view.setFrame(frame);
             btn.setFrame(frame);

src/macos/workspace_button.rs

@@ -90,6 +90,7 @@ define_class!(
 
 impl WorkspaceButton {
     const INDICATOR_SIZE: f64 = 4.0;
+    pub const HEIGHT: f64 = 24.0;
 
     pub fn new(mtm: MainThreadMarker, workspace: &crate::komorebi::Workspace) -> Retained<Self> {
         // Create button
@@ -117,7 +118,7 @@ impl WorkspaceButton {
             .constraintGreaterThanOrEqualToConstant(32.0);
         let height_constraint = this
             .heightAnchor()
-            .constraintGreaterThanOrEqualToConstant(24.0);
+            .constraintGreaterThanOrEqualToConstant(Self::HEIGHT);
         width_constraint.setActive(true);
         height_constraint.setActive(true);
 

src/macos/workspaces_stack_view.rs

@@ -1,6 +1,6 @@
 use objc2::rc::Retained;
 use objc2::{define_class, msg_send, sel, MainThreadOnly};
-use objc2_app_kit::{NSEvent, NSMenu, NSMenuItem, NSStackView};
+use objc2_app_kit::{NSEvent, NSLayoutAttribute, NSMenu, NSMenuItem, NSStackView};
 use objc2_foundation::{MainThreadMarker, NSString};
 
 define_class!(
@@ -65,6 +65,10 @@ impl WorkspacesStackView {
     pub fn new(mtm: MainThreadMarker) -> Retained<Self> {
         let this = Self::alloc(mtm);
         // SAFETY: The signature of `NSStackView`'s `init` method is correct.
-        unsafe { msg_send![this, init] }
+        let this: Retained<Self> = unsafe { msg_send![this, init] };
+
+        this.setAlignment(NSLayoutAttribute::CenterY);
+
+        this
     }
 }