Skip to content

Commit fbd71b8

Browse files
rickyzrickyz
committed
Implement focus dfs-next/dfs-prev.
This allows switching to the next/prev window from the current one in the depth-first order of the windows in the current workspace tree. This is convenient, as it allows users to shift focus through a workspace's windows in a more predictable way than the directional movement commands, where the move target can depend on invisible most-recently-used state. _fixes #248
1 parent ae0e577 commit fbd71b8

File tree

9 files changed

+183
-19
lines changed

9 files changed

+183
-19
lines changed

‎Sources/AppBundle/command/impl/FocusCommand.swift‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ struct FocusCommand: Command {
3636
} else {
3737
return io.err("Can't find window with DFS index \(dfsIndex)")
3838
}
39+
case .dfsRelative(let nextPrev):
40+
let windows = target.workspace.rootTilingContainer.allLeafWindowsRecursive
41+
guard let currentIndex = windows.firstIndex(where: { $0 == target.windowOrNil }) else {
42+
return false
43+
}
44+
var targetIndex = switch nextPrev {
45+
case .dfsNext: currentIndex + 1
46+
case .dfsPrev: currentIndex - 1
47+
}
48+
if targetIndex < 0 || targetIndex >= windows.count {
49+
switch args.boundariesAction {
50+
case .stop: return true
51+
case .fail: return false
52+
case .wrapAroundTheWorkspace: targetIndex = (targetIndex + windows.count) % windows.count
53+
case .wrapAroundAllMonitors: return errorT("Must be discarded by args parser")
54+
}
55+
}
56+
return windows[targetIndex].focusWindow()
3957
}
4058
}
4159
}

‎Sources/AppBundleTests/command/FocusCommandTest.swift‎

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ final class FocusCommandTest: XCTestCase {
2525

2626
func testParse() {
2727
XCTAssertTrue(parseCommand("focus --boundaries left").errorOrNil?.contains("Possible values") == true)
28-
var expected = FocusCmdArgs(rawArgs: [], direction: .left)
28+
var expected = FocusCmdArgs(rawArgs: [], cardinalOrDfsDirection: .direction(.left))
2929
expected.rawBoundaries = .workspace
3030
testParseCommandSucc("focus --boundaries workspace left", expected)
3131

@@ -37,6 +37,10 @@ final class FocusCommandTest: XCTestCase {
3737
parseCommand("focus --window-id 42 --ignore-floating").errorOrNil,
3838
"--window-id is incompatible with other options"
3939
)
40+
assertEquals(
41+
parseCommand("focus --boundaries all-monitors-outer-frame dfs-next").errorOrNil,
42+
"(dfs-next|dfs-prev) only supports --boundaries workspace"
43+
)
4044
}
4145

4246
func testFocus() {
@@ -92,7 +96,7 @@ final class FocusCommandTest: XCTestCase {
9296
}
9397

9498
assertEquals(focus.windowOrNil?.windowId, 1)
95-
var args = FocusCmdArgs(rawArgs: [], direction: .left)
99+
var args = FocusCmdArgs(rawArgs: [], cardinalOrDfsDirection: .direction(.left))
96100
args.rawBoundaries = .workspace
97101
args.rawBoundariesAction = .wrapAroundTheWorkspace
98102
FocusCommand(args: args).run(.defaultEnv, .emptyStdin)
@@ -156,10 +160,79 @@ final class FocusCommandTest: XCTestCase {
156160
FocusCommand.new(direction: .left).run(.defaultEnv, .emptyStdin)
157161
assertEquals(focus.windowOrNil?.windowId, 1)
158162
}
163+
164+
func testFocusDfsRelative() {
165+
Workspace.get(byName: name).rootTilingContainer.apply {
166+
TilingContainer.newVTiles(parent: $0, adaptiveWeight: 1).apply {
167+
assertEquals(TestWindow.new(id: 1, parent: $0).focusWindow(), true)
168+
TilingContainer.newHTiles(parent: $0, adaptiveWeight: 1).apply {
169+
TestWindow.new(id: 2, parent: $0)
170+
TestWindow.new(id: 3, parent: $0)
171+
}
172+
}
173+
TestWindow.new(id: 4, parent: $0)
174+
}
175+
176+
assertEquals(focus.windowOrNil?.windowId, 1)
177+
178+
FocusCommand.new(dfsRelative: .dfsNext).run(.defaultEnv, .emptyStdin)
179+
assertEquals(focus.windowOrNil?.windowId, 2)
180+
FocusCommand.new(dfsRelative: .dfsNext).run(.defaultEnv, .emptyStdin)
181+
assertEquals(focus.windowOrNil?.windowId, 3)
182+
FocusCommand.new(dfsRelative: .dfsNext).run(.defaultEnv, .emptyStdin)
183+
assertEquals(focus.windowOrNil?.windowId, 4)
184+
185+
FocusCommand.new(dfsRelative: .dfsPrev).run(.defaultEnv, .emptyStdin)
186+
assertEquals(focus.windowOrNil?.windowId, 3)
187+
FocusCommand.new(dfsRelative: .dfsPrev).run(.defaultEnv, .emptyStdin)
188+
assertEquals(focus.windowOrNil?.windowId, 2)
189+
FocusCommand.new(dfsRelative: .dfsPrev).run(.defaultEnv, .emptyStdin)
190+
assertEquals(focus.windowOrNil?.windowId, 1)
191+
}
192+
193+
func testFocusDfsRelativeWrapping() {
194+
Workspace.get(byName: name).rootTilingContainer.apply {
195+
assertEquals(TestWindow.new(id: 1, parent: $0).focusWindow(), true)
196+
TestWindow.new(id: 2, parent: $0)
197+
}
198+
199+
assertEquals(focus.windowOrNil?.windowId, 1)
200+
201+
var args = FocusCmdArgs(rawArgs: [], cardinalOrDfsDirection: .dfsRelative(.dfsPrev))
202+
203+
args.rawBoundariesAction = .stop
204+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 0)
205+
assertEquals(focus.windowOrNil?.windowId, 1)
206+
207+
args.rawBoundariesAction = .fail
208+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 1)
209+
assertEquals(focus.windowOrNil?.windowId, 1)
210+
211+
args.rawBoundariesAction = .wrapAroundTheWorkspace
212+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 0)
213+
assertEquals(focus.windowOrNil?.windowId, 2)
214+
215+
args.cardinalOrDfsDirection = .dfsRelative(.dfsNext)
216+
217+
args.rawBoundariesAction = .stop
218+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 0)
219+
assertEquals(focus.windowOrNil?.windowId, 2)
220+
221+
args.rawBoundariesAction = .fail
222+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 1)
223+
assertEquals(focus.windowOrNil?.windowId, 2)
224+
225+
args.rawBoundariesAction = .wrapAroundTheWorkspace
226+
assertEquals(FocusCommand(args: args).run(.defaultEnv, .emptyStdin).exitCode, 0)
227+
assertEquals(focus.windowOrNil?.windowId, 1)
228+
}
159229
}
160230

161231
extension FocusCommand {
162232
static func new(direction: CardinalDirection) -> FocusCommand {
163-
FocusCommand(args: FocusCmdArgs(rawArgs: [], direction: direction))
233+
FocusCommand(args: FocusCmdArgs(rawArgs: [], cardinalOrDfsDirection: .direction(direction)))
234+
}
235+
static func new(dfsRelative: DfsNextPrev) -> FocusCommand {
236+
FocusCommand(args: FocusCmdArgs(rawArgs: [], cardinalOrDfsDirection: .dfsRelative(dfsRelative)))
164237
}
165238
}

‎Sources/Cli/subcommandDescriptionsGenerated.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ let subcommandDescriptions = [
1111
[" flatten-workspace-tree", "Flatten the tree of the focused workspace"],
1212
[" focus-back-and-forth", "Switch between the current and previously focused elements back and forth"],
1313
[" focus-monitor", "Focus monitor by relative direction, by order, or by pattern"],
14-
[" focus", "Set focus to the nearest window in the given direction."],
14+
[" focus", "Set focus to another window."],
1515
[" fullscreen", "Toggle the fullscreen mode for the focused window"],
1616
[" join-with", "Put the focused window and the nearest node in the specified direction under a common parent container"],
1717
[" layout", "Change layout of the focused window to the given layout"],

‎Sources/Common/cmdArgs/impl/FocusCmdArgs.swift‎

Lines changed: 64 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ public struct FocusCmdArgs: CmdArgs {
1515
"--window-id": ArgParser(\.windowId, upcastArgParserFun(parseArgWithUInt32)),
1616
"--dfs-index": ArgParser(\.dfsIndex, upcastArgParserFun(parseArgWithUInt32)),
1717
],
18-
arguments: [ArgParser(\.direction, upcastArgParserFun(parseCardinalDirectionArg))]
18+
arguments: [ArgParser(\.cardinalOrDfsDirection, upcastArgParserFun(parseCardinalOrDfsDirection))]
1919
)
2020

2121
public var rawBoundaries: Boundaries? = nil // todo cover boundaries wrapping with tests
2222
public var rawBoundariesAction: WhenBoundariesCrossed? = nil
2323
public var dfsIndex: UInt32? = nil
24-
public var direction: CardinalDirection? = nil
24+
public var cardinalOrDfsDirection: CardinalOrDfsDirection? = nil
2525
public var floatingAsTiling: Bool = true
2626
public var windowId: UInt32?
2727
public var workspaceName: WorkspaceName?
2828

29-
public init(rawArgs: [String], direction: CardinalDirection) {
29+
public init(rawArgs: [String], cardinalOrDfsDirection: CardinalOrDfsDirection) {
3030
self.rawArgs = .init(rawArgs)
31-
self.direction = direction
31+
self.cardinalOrDfsDirection = cardinalOrDfsDirection
3232
}
3333

3434
public init(rawArgs: [String], windowId: UInt32) {
@@ -53,16 +53,69 @@ public struct FocusCmdArgs: CmdArgs {
5353
}
5454
}
5555

56+
public enum DfsNextPrev: String, CaseIterable, Equatable, Sendable {
57+
case dfsNext = "dfs-next"
58+
case dfsPrev = "dfs-prev"
59+
}
60+
61+
public enum CardinalOrDfsDirection: Equatable, Sendable {
62+
case direction(CardinalDirection)
63+
case dfsRelative(DfsNextPrev)
64+
}
65+
66+
extension CardinalOrDfsDirection: CaseIterable {
67+
public static var allCases: [CardinalOrDfsDirection] {
68+
CardinalDirection.allCases.map { .direction($0) } + DfsNextPrev.allCases.map { .dfsRelative($0) }
69+
}
70+
}
71+
72+
extension CardinalOrDfsDirection: RawRepresentable {
73+
public typealias RawValue = String
74+
75+
public init?(rawValue: RawValue) {
76+
if let d = CardinalDirection(rawValue: rawValue) {
77+
self = .direction(d)
78+
} else if let np = DfsNextPrev(rawValue: rawValue) {
79+
self = .dfsRelative(np)
80+
} else {
81+
return nil
82+
}
83+
}
84+
85+
public var rawValue: RawValue {
86+
return switch self {
87+
case .direction(let d): d.rawValue
88+
case .dfsRelative(let np): np.rawValue
89+
}
90+
}
91+
}
92+
93+
func parseCardinalOrDfsDirection(_ arg: String, _ nextArgs: inout [String]) -> Parsed<CardinalOrDfsDirection> {
94+
parseEnum(arg, CardinalOrDfsDirection.self)
95+
}
96+
5697
public enum FocusCmdTarget {
5798
case direction(CardinalDirection)
5899
case windowId(UInt32)
59100
case dfsIndex(UInt32)
101+
case dfsRelative(DfsNextPrev)
102+
103+
var isDfsRelative: Bool {
104+
if case .dfsRelative = self {
105+
return true
106+
} else {
107+
return false
108+
}
109+
}
60110
}
61111

62112
public extension FocusCmdArgs {
63113
var target: FocusCmdTarget {
64-
if let direction {
65-
return .direction(direction)
114+
if let cardinalOrDfsDirection {
115+
return switch cardinalOrDfsDirection {
116+
case .direction(let dir): .direction(dir)
117+
case .dfsRelative(let nextPrev): .dfsRelative(nextPrev)
118+
}
66119
}
67120
if let windowId {
68121
return .windowId(windowId)
@@ -84,15 +137,18 @@ public func parseFocusCmdArgs(_ args: [String]) -> ParsedCmd<FocusCmdArgs> {
84137
? .failure("\(raw.boundaries.rawValue) and \(raw.boundariesAction.rawValue) is an invalid combination of values")
85138
: .cmd(raw)
86139
}
87-
.filter("Mandatory argument is missing. '\(CardinalDirection.unionLiteral)', --window-id or --dfs-index is required") {
88-
$0.direction != nil || $0.windowId != nil || $0.dfsIndex != nil
140+
.filter("Mandatory argument is missing. \(CardinalOrDfsDirection.unionLiteral), --window-id or --dfs-index is required") {
141+
$0.cardinalOrDfsDirection != nil || $0.windowId != nil || $0.dfsIndex != nil
89142
}
90143
.filter("--window-id is incompatible with other options") {
91144
$0.windowId == nil || $0 == FocusCmdArgs(rawArgs: args, windowId: $0.windowId!)
92145
}
93146
.filter("--dfs-index is incompatible with other options") {
94147
$0.dfsIndex == nil || $0 == FocusCmdArgs(rawArgs: args, dfsIndex: $0.dfsIndex!)
95148
}
149+
.filter("(dfs-next|dfs-prev) only supports --boundaries workspace") {
150+
!$0.target.isDfsRelative || $0.boundaries == .workspace
151+
}
96152
}
97153

98154
private func parseBoundariesAction(arg: String, nextArgs: inout [String]) -> Parsed<FocusCmdArgs.WhenBoundariesCrossed> {

‎Sources/Common/cmdArgs/impl/FocusMonitorCmdArgs.swift‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ func parseTarget(_ arg: String, _ nextArgs: inout [String]) -> Parsed<MonitorTar
4242
}
4343
}
4444

45-
public enum NextPrev: Equatable, Sendable {
46-
case next, prev
47-
}
48-
4945
public enum MonitorTarget: Equatable, Sendable {
5046
case directional(CardinalDirection)
5147
case relative(NextPrev)

‎Sources/Common/cmdHelpGenerated.swift‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ let focus_help_generated = """
4242
USAGE: focus [-h|--help] [--ignore-floating]
4343
[--boundaries <boundary>] [--boundaries-action <action>]
4444
(left|down|up|right)
45+
OR: focus [-h|--help] [--ignore-floating]
46+
[--boundaries <boundary>] [--boundaries-action <action>]
47+
(dfs-next|dfs-prev)
4548
OR: focus [-h|--help] --window-id <window-id>
4649
OR: focus [-h|--help] --dfs-index <dfs-index>
4750
"""

‎Sources/Common/model/NextPrev.swift‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
public enum NextPrev: String, CaseIterable, Equatable, Sendable {
2+
case next, prev
3+
}

‎docs/aerospace-focus.adoc‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
include::util/man-attributes.adoc[]
33
:manname: aerospace-focus
44
// tag::purpose[]
5-
:manpurpose: Set focus to the nearest window in the given direction.
5+
:manpurpose: Set focus to another window.
66
// end::purpose[]
77

88
// =========================================================== Synopsis
@@ -12,6 +12,9 @@ include::util/man-attributes.adoc[]
1212
aerospace focus [-h|--help] [--ignore-floating]
1313
[--boundaries <boundary>] [--boundaries-action <action>]
1414
(left|down|up|right)
15+
aerospace focus [-h|--help] [--ignore-floating]
16+
[--boundaries <boundary>] [--boundaries-action <action>]
17+
(dfs-next|dfs-prev)
1518
aerospace focus [-h|--help] --window-id <window-id>
1619
aerospace focus [-h|--help] --dfs-index <dfs-index>
1720

@@ -58,6 +61,16 @@ Index is 0-based.
5861
Don't perceive floating windows as part of the tree.
5962
It may be useful for more reliable scripting.
6063

64+
// =========================================================== Arguments
65+
include::./util/conditional-arguments-header.adoc[]
66+
67+
(left|down|up|right)::
68+
Set focus to the nearest window in the given direction.
69+
70+
(dfs-next|dfs-prev)::
71+
Set focus to the window before or after the current window in the depth-first order (top-to-bottom and left-to-right) of windows in the current workspace tree.
72+
In this mode, `--boundaries` must be `workspace` (the default) and `--boundaries-action` can be set to one of `(stop|fail|wrap-around-the-workspace)`.
73+
6174
// end::body[]
6275

6376
// =========================================================== Footer

‎grammar/commands-bnf-grammar.txt‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ aerospace -h;
2020

2121
| flatten-workspace-tree [--workspace <workspace>]
2222

23-
| focus [<focus_flag>]... (left|down|up|right) [<focus_flag>]...
23+
| focus [<focus_direction_flag>]... (left|down|up|right) [<focus_direction_flag>]...
2424
| focus --window-id <window_id>
2525
| focus --dfs-index <number>
26+
| focus [<focus_dfs_relative_flag>]... (dfs-next|dfs-prev) [<focus_dfs_relative_flag>]...
2627

2728
| focus-back-and-forth
2829

@@ -111,7 +112,8 @@ aerospace -h;
111112
<move_node_to_monitor1_flag> ::= --window-id <window_id>|--focus-follows-window|--fail-if-noop|--wrap-around;
112113
<move_node_to_monitor2_flag> ::= --window-id <window_id>|--focus-follows-window|--fail-if-noop;
113114

114-
<focus_flag> ::= --boundaries <boundary>|--boundaries-action <boundaries_action>|--ignore-floating;
115+
<focus_direction_flag> ::= --boundaries <boundary>|--boundaries-action <boundaries_action>|--ignore-floating;
116+
<focus_dfs_relative_flag> ::= --boundaries-action <boundaries_action>|--ignore-floating;
115117
<boundaries_action> ::= stop|fail|wrap-around-the-workspace|wrap-around-all-monitors;
116118
<boundary> ::= workspace|all-monitors-outer-frame;
117119

0 commit comments

Comments
 (0)