Add --when-visible (focus|swap) option to the summon-workspace command.

What should happen when the summoned workspace is visible on another monitor?

This option introduces a choice to either:

- `focus` the monitor on which the target workspace is already visible (the current behavior)
- `swap` the workspaces between the monitors, so that the summoned workspace appears on the focused monitor.

The default is `focus`, for backwards compatibility.

Ref: #603

Author: lynaghk

Sources/AppBundle/command/impl/SummonWorkspaceCommand.swift

@@ -7,17 +7,36 @@ struct SummonWorkspaceCommand: Command {
 
     func run(_ env: CmdEnv, _ io: CmdIo) -> Bool {
         let workspace = Workspace.get(byName: args.target.val.raw)
-        let monitor = focus.workspace.workspaceMonitor
-        if monitor.activeWorkspace == workspace {
+        let focusedMonitor = focus.workspace.workspaceMonitor
+
+        if focusedMonitor.activeWorkspace == workspace {
             if !args.failIfNoop {
                 io.err("Workspace '\(workspace.name)' is already visible on the focused monitor. Tip: use --fail-if-noop to exit with non-zero code")
             }
             return !args.failIfNoop
         }
-        if monitor.setActiveWorkspace(workspace) {
-            return workspace.focusWorkspace()
+
+        if !workspace.isVisible {
+            // then we just need to summon the workspace to the focused monitor
+            if focusedMonitor.setActiveWorkspace(workspace) {
+                return workspace.focusWorkspace()
+            } else {
+                return io.err("Can't move workspace '\(workspace.name)' to monitor '\(focusedMonitor.name)'. workspace-to-monitor-force-assignment doesn't allow it")
+            }
         } else {
-            return io.err("Can't move workspace '\(workspace.name)' to monitor '\(monitor.name)'. workspace-to-monitor-force-assignment doesn't allow it")
+            let otherMonitor = workspace.workspaceMonitor
+            let currentWorkspace = focusedMonitor.activeWorkspace
+
+            switch args.whenVisible {
+                case .swap:
+                    if otherMonitor.setActiveWorkspace(currentWorkspace) && focusedMonitor.setActiveWorkspace(workspace) {
+                        return workspace.focusWorkspace()
+                    } else {
+                        return io.err("Can't swap workspaces due to monitor force assignment restrictions")
+                    }
+                case .focus:
+                    return workspace.focusWorkspace()
+            }
         }
     }
 }

Sources/AppBundle/layout/refresh.swift

@@ -7,7 +7,7 @@ private var activeRefreshTask: Task<(), any Error>? = nil
 @MainActor
 func scheduleRefreshSession(
     _ event: RefreshSessionEvent,
-    optimisticallyPreLayoutWorkspaces: Bool = false,
+    optimisticallyPreLayoutWorkspaces: Bool = false
 ) {
     activeRefreshTask?.cancel()
     activeRefreshTask = Task { @MainActor in
@@ -20,7 +20,7 @@ func scheduleRefreshSession(
 func runRefreshSessionBlocking(
     _ event: RefreshSessionEvent,
     layoutWorkspaces shouldLayoutWorkspaces: Bool = true,
-    optimisticallyPreLayoutWorkspaces: Bool = false,
+    optimisticallyPreLayoutWorkspaces: Bool = false
 ) async throws {
     let state = signposter.beginInterval(#function, "event: \(event) axTaskLocalAppThreadToken: \(axTaskLocalAppThreadToken?.idForDebug)")
     defer { signposter.endInterval(#function, state) }

Sources/Common/cmdArgs/impl/SummonWorkspaceCmdArgs.swift

@@ -1,3 +1,5 @@
+private let actio = "<action>"
+
 public struct SummonWorkspaceCmdArgs: CmdArgs {
     /*conforms*/ public var commonState: CmdArgsCommonState
     public init(rawArgs: StrArrSlice) { self.commonState = .init(rawArgs) }
@@ -7,14 +9,33 @@ public struct SummonWorkspaceCmdArgs: CmdArgs {
         help: summon_workspace_help_generated,
         flags: [
             "--fail-if-noop": trueBoolFlag(\.failIfNoop),
+            "--when-visible": SubArgParser(\.rawWhenVisibleAction, upcastSubArgParserFun(parseWhenVisibleAction)),
         ],
         posArgs: [newArgParser(\.target, parseWorkspaceName, mandatoryArgPlaceholder: "<workspace>")],
     )
 
     public var target: Lateinit<WorkspaceName> = .uninitialized
     public var failIfNoop: Bool = false
+    public var rawWhenVisibleAction: WhenVisible? = nil
+
+    public enum WhenVisible: String, CaseIterable, Equatable, Sendable {
+        case focus = "focus"
+        case swap = "swap"
+    }
+}
+
+public extension SummonWorkspaceCmdArgs {
+    var whenVisible: WhenVisible { rawWhenVisibleAction ?? .focus }
 }
 
 private func parseWorkspaceName(i: ArgParserInput) -> ParsedCliArgs<WorkspaceName> {
     .init(WorkspaceName.parse(i.arg), advanceBy: 1)
 }
+
+private func parseWhenVisibleAction(i: SubArgParserInput) -> ParsedCliArgs<SummonWorkspaceCmdArgs.WhenVisible> {
+    if let arg = i.nonFlagArgOrNil() {
+        return .init(parseEnum(arg, SummonWorkspaceCmdArgs.WhenVisible.self), advanceBy: 1)
+    } else {
+        return .fail("\(actio) is mandatory", advanceBy: 0)
+    }
+}

Sources/Common/cmdHelpGenerated.swift

@@ -130,7 +130,7 @@ let split_help_generated = """
     USAGE: split [-h|--help] [--window-id <window-id>] (horizontal|vertical|opposite)
     """
 let summon_workspace_help_generated = """
-    USAGE: summon-workspace [-h|--help] [--fail-if-noop] <workspace>
+    USAGE: summon-workspace [-h|--help] [--fail-if-noop] [--when-visible (focus|swap)] <workspace>
     """
 let swap_help_generated = """
     USAGE: swap [-h|--help] [--window-id <window-id>] [--swap-focus]

docs/aerospace-summon-workspace.adoc

@@ -9,7 +9,7 @@ include::util/man-attributes.adoc[]
 == Synopsis
 [verse]
 // tag::synopsis[]
-aerospace summon-workspace [-h|--help] [--fail-if-noop] <workspace>
+aerospace summon-workspace [-h|--help] [--fail-if-noop] [--when-visible (focus|swap)] <workspace>
 
 // end::synopsis[]
 
@@ -30,6 +30,11 @@ include::./util/conditional-options-header.adoc[]
 -h, --help:: Print help
 --fail-if-noop:: Exit with non-zero exit code if the workspace is already visible on the focused monitor.
 
+--when-visible <action>::
+Defines the behavior if the workspace is already visible on another monitor.
+`<action>` possible values: `(focus|swap)`. +
+The default is: `focus`
+
 // =========================================================== Arguments
 include::./util/conditional-arguments-header.adoc[]