From 0ec305a3bcc44381ad4f8564ea75c01aea672e70 Mon Sep 17 00:00:00 2001 From: Nikita Bobko Date: Sat, 25 May 2024 19:40:20 +0200 Subject: [PATCH] Implement --format option for list-windows command Related to: https://github.com/nikitabobko/AeroSpace/issues/16 --- .../command/query/ListWindowsCommand.swift | 58 +++++++++++++-- .../config/parseExecEnvVariables.swift | 7 +- Sources/AppBundle/model/MonitorEx.swift | 6 ++ .../command/ListWindowsTest.swift | 4 +- .../config/ParseEnvVariablesTest.swift | 12 +-- .../cmdArgs/query/ListWindowsCmdArgs.swift | 50 +++++++++---- Sources/Common/util/SequenceEx.swift | 12 +++ Sources/Common/util/StringEx.swift | 74 +++++++++++++------ docs/aerospace-list-windows.adoc | 49 ++++++------ docs/commands.adoc | 2 + 10 files changed, 196 insertions(+), 78 deletions(-) diff --git a/Sources/AppBundle/command/query/ListWindowsCommand.swift b/Sources/AppBundle/command/query/ListWindowsCommand.swift index 51c16a53..5df21fed 100644 --- a/Sources/AppBundle/command/query/ListWindowsCommand.swift +++ b/Sources/AppBundle/command/query/ListWindowsCommand.swift @@ -16,9 +16,9 @@ struct ListWindowsCommand: Command { } else { var workspaces: Set = args.workspaces.isEmpty ? Workspace.all.toSet() : args.workspaces .flatMap { filter in - return switch filter { + switch filter { case .focused: [Workspace.focused] - case .visible: Workspace.all.filter { $0.isVisible } + case .visible: Workspace.all.filter(\.isVisible) case .name(let name): [Workspace.get(byName: name.raw)] } } @@ -36,11 +36,57 @@ struct ListWindowsCommand: Command { windows = windows.filter { $0.app.id == appId } } } - state.stdout += windows - .map { window in - [String(window.windowId), window.app.name ?? "NULL-APP-NAME", window.title] + windows = windows.sorted(using: [SelectorComparator { $0.app.name ?? "" }, SelectorComparator(selector: \.title)]) + var table: [[String]] = [] + var padLastColumn = false // hack. right-padding should be properly expanded + for window in windows { + var errors: [String] = [] + var line: [String] = [] + var current: String = "" + for (index, token) in args.format.enumerated() { + switch token { + case .value("right-padding"): + line.append(current) + current = "" + if index == args.format.count - 1 { + padLastColumn = true + } + case .literal(let literal): current.append(literal) + case .value(let value): + switch value.expandTreeNodeVar(window: window) { + case .success(let prop): current.append(prop) + case .failure(let msg): errors.append(msg) + } + } + } + if !current.isEmpty { + line.append(current) } - .toPaddingTable() + if errors.isEmpty { + table.append(line) + } else { + return state.failCmd(msg: errors.joinErrors()) + } + } + state.stdout += table.toPaddingTable(columnSeparator: "", padLastColumn: padLastColumn) return true } } + +private extension String { + func expandTreeNodeVar(window: Window) -> Result { + switch self { + case "newline": .success("\n") + case "tab": .success("\t") + case "window-id": .success(window.windowId.description) + case "window-title": .success(window.title) + case "app-name": .success(window.app.name ?? "NULL-APP-NAME") + case "app-pid": .success(window.app.pid.description) + case "app-id": .success(window.app.id ?? "NULL-APP-ID") + case "workspace": .success(window.workspace?.name ?? "NULL-WOKRSPACE") + case "monitor-id": .success(window.nodeMonitor?.monitorId?.description ?? "NULL-MONITOR-ID") + case "monitor-name": .success(window.nodeMonitor?.name ?? "NULL-MONITOR-NAME") + default: .failure("Unknown interpolation variable '\(self)'") + } + } +} diff --git a/Sources/AppBundle/config/parseExecEnvVariables.swift b/Sources/AppBundle/config/parseExecEnvVariables.swift index 52be20e6..f91d0b5a 100644 --- a/Sources/AppBundle/config/parseExecEnvVariables.swift +++ b/Sources/AppBundle/config/parseExecEnvVariables.swift @@ -49,9 +49,10 @@ private func parseEnvVariables(_ raw: TOMLValueConvertible, _ backtrace: TomlBac if let add: String = fullEnv[key] { env[key] = add } - let (interpolated, interpolationErrors) = rawStr.interpolate(with: env) - errors += interpolationErrors.map { .semantic(backtrace, $0) } - result[key] = interpolated + switch rawStr.interpolate(with: env) { + case .success(let interpolated): result[key] = interpolated + case .failure(let _errros): errors += _errros.map { .semantic(backtrace, $0) } + } } return result } diff --git a/Sources/AppBundle/model/MonitorEx.swift b/Sources/AppBundle/model/MonitorEx.swift index 0b2fa4d9..49a93ccd 100644 --- a/Sources/AppBundle/model/MonitorEx.swift +++ b/Sources/AppBundle/model/MonitorEx.swift @@ -9,4 +9,10 @@ extension Monitor { height: visibleRect.height - gaps.outer.top.toDouble() - gaps.outer.bottom.toDouble() ) } + + var monitorId: Int? { + let sorted = sortedMonitors + let origin = self.rect.topLeftCorner + return sorted.firstIndex { $0.rect.topLeftCorner == origin } + } } diff --git a/Sources/AppBundleTests/command/ListWindowsTest.swift b/Sources/AppBundleTests/command/ListWindowsTest.swift index f7c3ad4d..5aaf1d5b 100644 --- a/Sources/AppBundleTests/command/ListWindowsTest.swift +++ b/Sources/AppBundleTests/command/ListWindowsTest.swift @@ -7,8 +7,8 @@ final class ListWindowsTest: XCTestCase { func testParse() { expect(parseCommand("list-windows --pid 1").errorOrNil) == "Mandatory option is not specified (--focused|--all|--monitor|--workspace)" expect(parseCommand("list-windows --workspace M --pid 1").errorOrNil) == nil - expect(parseCommand("list-windows --pid 1 --focused").errorOrNil) == "--focused conflicts with all other flags" - expect(parseCommand("list-windows --pid 1 --all").errorOrNil) == "--all conflicts with all other flags" + expect(parseCommand("list-windows --pid 1 --focused").errorOrNil) == "--focused conflicts with \"filtering\" flags" + expect(parseCommand("list-windows --pid 1 --all").errorOrNil) == "--all conflicts with \"filtering\" flags" expect(parseCommand("list-windows --all").errorOrNil) == nil expect(parseCommand("list-windows --all --workspace M").errorOrNil) == "Conflicting options: --workspace, --all" expect(parseCommand("list-windows --all --focused").errorOrNil) == "Conflicting options: --focused, --all" diff --git a/Sources/AppBundleTests/config/ParseEnvVariablesTest.swift b/Sources/AppBundleTests/config/ParseEnvVariablesTest.swift index 44c13c5a..b2baff51 100644 --- a/Sources/AppBundleTests/config/ParseEnvVariablesTest.swift +++ b/Sources/AppBundleTests/config/ParseEnvVariablesTest.swift @@ -47,19 +47,19 @@ final class ParseEnvVariablesTest: XCTestCase { """ ) expect(errors.descriptions) == [ - "exec.env-vars.BAR: Env variable 'FOO' isn't presented in AeroSpace.app Env vars, or not available for interpolation (because it's mutated)", - "exec.env-vars.FOO: Env variable 'BAR' isn't presented in AeroSpace.app Env vars, or not available for interpolation (because it's mutated)" + "exec.env-vars.BAR: Env variable 'FOO' isn't presented in AeroSpace.app env vars, or not available for interpolation (because it's mutated)", + "exec.env-vars.FOO: Env variable 'BAR' isn't presented in AeroSpace.app env vars, or not available for interpolation (because it's mutated)" ] } } private func testSucInterpolation(_ str: String, _ vars: [String: String] = [:], expected: String) { - let (result, errors) = str.interpolate(with: vars) + let (result, errors) = str.interpolate(with: vars).getOrNils() XCTAssertEqual(result, expected) - XCTAssertEqual(errors, []) + XCTAssertEqual(errors ?? [], []) } private func testFailInterpolation(_ str: String, _ vars: [String: String] = [:]) { - let (_, errors) = str.interpolate(with: vars) - XCTAssertNotEqual(errors, []) + let (_, errors) = str.interpolate(with: vars).getOrNils() + XCTAssertNotEqual(errors ?? [], []) } diff --git a/Sources/Common/cmdArgs/query/ListWindowsCmdArgs.swift b/Sources/Common/cmdArgs/query/ListWindowsCmdArgs.swift index 798d03dd..c56d5f24 100644 --- a/Sources/Common/cmdArgs/query/ListWindowsCmdArgs.swift +++ b/Sources/Common/cmdArgs/query/ListWindowsCmdArgs.swift @@ -11,18 +11,19 @@ public struct ListWindowsCmdArgs: RawCmdArgs, CmdArgs, Equatable { help: """ USAGE: list-windows [-h|--help] (--workspace \(_workspaces)|--monitor \(_monitors)) [--monitor \(_monitors)] [--workspace \(_workspaces)] - [--pid ] [--app-id ] - OR: list-windows [-h|--help] --all - OR: list-windows [-h|--help] --focused + [--pid ] [--app-id ] [--format ] + OR: list-windows [-h|--help] --all [--format ] + OR: list-windows [-h|--help] --focused [--format ] OPTIONS: - -h, --help Print help - --all Alias for "--monitor all" - --focused Print the focused window - --workspace \(_workspaces) Filter results to only print windows that belong to specified workspaces - --monitor \(_monitors) Filter results to only print the windows that are attached to specified monitors - --pid Filter results to only print windows that belong to the Application with specified - --app-id Filter results to only print windows that belong to the Application with specified Bundle ID + -h, --help Print help + --all Alias for "--monitor all" + --focused Print the focused window + --workspace \(_workspaces) Filter results to only print windows that belong to specified workspaces + --monitor \(_monitors) Filter results to only print the windows that are attached to specified monitors + --pid Filter results to only print windows that belong to the Application with specified + --app-id Filter results to only print windows that belong to the Application with specified Bundle ID + --format Specify output format """, options: [ "--focused": trueBoolFlag(\.focused), @@ -31,7 +32,8 @@ public struct ListWindowsCmdArgs: RawCmdArgs, CmdArgs, Equatable { "--monitor": ArgParser(\.monitors, parseMonitorIds), "--workspace": ArgParser(\.workspaces, parseWorkspaces), "--pid": singleValueOption(\.pidFilter, "", Int32.init), - "--app-id": singleValueOption(\.appIdFilter, "", { $0 }) + "--app-id": singleValueOption(\.appIdFilter, "", { $0 }), + "--format": ArgParser(\.format, parseFormat), ], arguments: [] ) @@ -43,6 +45,11 @@ public struct ListWindowsCmdArgs: RawCmdArgs, CmdArgs, Equatable { public var workspaces: [WorkspaceFilter] = [] public var pidFilter: Int32? public var appIdFilter: String? + public var format: [StringInterToken] = [ + .value("window-id"), .value("right-padding"), .literal(" | "), + .value("app-name"), .value("right-padding"), .literal(" | "), + .value("window-title"), + ] } public func parseRawListWindowsCmdArgs(_ args: [String]) -> ParsedCmd { @@ -59,18 +66,29 @@ public func parseRawListWindowsCmdArgs(_ args: [String]) -> ParsedCmd Parsed<[StringInterToken]> { + return if let nextArg = nextArgs.nextNonFlagOrNil() { + switch nextArg.interpolationTokens(interpolationChar: "%") { + case .success(let tokens): .success(tokens) + case .failure(let err): .failure("Failed to parse . \(err)") + } + } else { + .failure(" is mandatory") + } +} + private func parseWorkspaces(arg: String, nextArgs: inout [String]) -> Parsed<[WorkspaceFilter]> { let args = nextArgs.allNextNonFlagArgs() let possibleValues = "\(orkspace) possible values: (|focused|visible)" diff --git a/Sources/Common/util/SequenceEx.swift b/Sources/Common/util/SequenceEx.swift index bfe87675..eab6de67 100644 --- a/Sources/Common/util/SequenceEx.swift +++ b/Sources/Common/util/SequenceEx.swift @@ -33,6 +33,18 @@ public extension Sequence { return .success(result) } + func mapAllOrFailures(_ transform: (Self.Element) -> Result) -> Result<[T], [E]> { + var result: [T] = [] + var errors: [E] = [] + for element in self { + switch transform(element) { + case .success(let element): result.append(element) + case .failure(let error): errors.append(error) + } + } + return errors.isEmpty ? .success(result) : .failure(errors) + } + @inlinable func minByOrThrow(_ selector: (Self.Element) -> S) -> Self.Element { minBy(selector) ?? errorT("Empty sequence") } diff --git a/Sources/Common/util/StringEx.swift b/Sources/Common/util/StringEx.swift index 6abaa0e7..7bb5fb89 100644 --- a/Sources/Common/util/StringEx.swift +++ b/Sources/Common/util/StringEx.swift @@ -1,5 +1,6 @@ public typealias Parsed = Result extension String: Error {} // Make it possible to use String in Result +extension [String]: Error {} // Make it possible to use [String] in Result public extension String { func trim() -> String { @@ -12,12 +13,14 @@ public extension String { } public extension [[String]] { - func toPaddingTable(columnSeparator: String = " | ") -> [String] { + func toPaddingTable(columnSeparator: String = " | ", padLastColumn: Bool = false) -> [String] { let pads: [Int] = transposed.map { column in column.map { $0.count }.max()! } return self.map { (row: [String]) in - zip(row, pads) - .map { (elem: String, pad: Int) in - elem.padding(toLength: pad, withPad: " ", startingAt: 0) + zip(row.enumerated(), pads) + .map { (elem: (Int, String), pad: Int) in + padLastColumn || elem.0 != row.count - 1 + ? elem.1.padding(toLength: pad, withPad: " ", startingAt: 0) + : elem.1 } .joined(separator: columnSeparator) } @@ -43,51 +46,74 @@ private extension [[String]] { } public extension String { - func interpolate(with variables: [String: String]) -> (result: String, errors: [String]) { + func interpolate(with variables: [String: String], interpolationChar: Character = "$") -> Result { + interpolationTokens() + .mapError { [$0] } + .flatMap { tokens in + tokens.mapAllOrFailures { token in + switch token { + case .literal(let literal): .success(literal) + case .value(let value): variables[value].flatMap(Result.success) + ?? .failure("Env variable '\(value)' isn't presented in AeroSpace.app env vars, " + + "or not available for interpolation (because it's mutated)") + } + } + } + .map { $0.joined(separator: "") } + } + + func interpolationTokens(interpolationChar: Character = "$") -> Result<[StringInterToken], String> { var mode: InterpolationParserState = .stringLiteral - var result = "" - var errors: [String] = [] + var result: [StringInterToken] = [] + var literal: String = "" for char: Character? in (Array(self) + [nil]) { switch (mode, char) { // State machine - case (.stringLiteral, "$"): + case (.stringLiteral, interpolationChar): mode = .dollarEncountered case (.stringLiteral, _): if let char { - result.append(char) + literal.append(char) + } else { + result.append(.literal(literal)) } case (.dollarEncountered, "{"): mode = .interpolatedValue("") - case (.dollarEncountered, "$"): - result.append("$") + result.append(.literal(literal)) + literal = "" + case (.dollarEncountered, interpolationChar): + literal.append(interpolationChar) case (.dollarEncountered, _): - result.append("$") + literal.append(interpolationChar) if let char { - result.append(char) + literal.append(char) + } else { + result.append(.literal(literal)) } mode = .stringLiteral case (.interpolatedValue(let value), "}"): - if let expanded = variables[value] { - result.append(expanded) - } else { - errors.append("Env variable '\(value)' isn't presented in AeroSpace.app Env vars, or not available for interpolation (because it's mutated)") - } + result.append(.value(value)) mode = .stringLiteral case (.interpolatedValue(let value), "{"): - return ("", ["Can't parse '\(value + "{")' environment variable (Open curly brace is invalid character)"]) - case (.interpolatedValue(let value), "$"): - return ("", ["Can't parse '\(value + "$")' environment variable (Dollar is invalid character)"]) + return .failure("Can't parse '\(value + "{")' inside interpolation (Open curly brace is invalid character)") + case (.interpolatedValue(let value), interpolationChar): + return .failure("Can't parse '\(value + .init(interpolationChar))' inside interpolation ('\(interpolationChar)' is disallowed character)") case (.interpolatedValue(let value), _): if let char { - mode = .interpolatedValue(value + String(char)) + mode = .interpolatedValue(value + .init(char)) } else { - return ("", ["Unbalanced curly braces"]) + return .failure("Unbalanced curly braces") } } } - return (result, errors) + return .success(result.filter { $0 != .literal("") }) } } +public enum StringInterToken: Equatable { + case literal(String) + case value(String) +} + private enum InterpolationParserState { case stringLiteral, dollarEncountered case interpolatedValue(String) diff --git a/docs/aerospace-list-windows.adoc b/docs/aerospace-list-windows.adoc index 048e7899..37a00f7f 100644 --- a/docs/aerospace-list-windows.adoc +++ b/docs/aerospace-list-windows.adoc @@ -10,9 +10,9 @@ include::util/man-attributes.adoc[] // tag::synopsis[] aerospace list-windows [-h|--help] (--workspace ...|--monitor ...) [--monitor ...] [--workspace ...] - [--pid ] [--app-id ] -aerospace list-windows [-h|--help] --all -aerospace list-windows [-h|--help] --focused + [--pid ] [--app-id ] [--format ] +aerospace list-windows [-h|--help] --all [--format ] +aerospace list-windows [-h|--help] --focused [--format ] // end::synopsis[] @@ -21,23 +21,6 @@ aerospace list-windows [-h|--help] --focused // tag::body[] {manpurpose} -include::util/conditional-output-format-header.adoc[] - -Output format is table with three columns: - -. Window ID -. App name -. Window title - -Output Example: - ----- -5010 | AppCode | AeroSpace – aerospace-list-windows.adoc -5360 | AppCode | Git - AeroSpace -2412 | Alacritty | /Users/bobko $ ta -5046 | Xcode | AeroSpace — ListWorkspacesCommand.swift ----- - include::util/conditional-options-header.adoc[] -h, --help:: Print help @@ -62,7 +45,31 @@ Possible values: + include::util/monitor-option.adoc[] --pid :: Filter results to only print windows that belong to the Application with specified `` ---app-id :: Filter results to only print windows that belong to the Application with specified Bundle ID +--app-id :: Filter results to only print windows that belong to the Application with specified https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids[Bundle ID] +--format :: +Specify output format. See "Output Format" section for more details + +include::util/conditional-output-format-header.adoc[] + +Output format can be configured with optional `[--format ]` option. +`` supports https://en.wikipedia.org/wiki/String_interpolation[string interpolation]. + +If not specified, the default `` is: + +`%{window-id}%{right-padding} | %{app-name}%{right-padding} | %{window-title}` + +The following variables can be used inside ``: + +%{window-id}:: Number. Window unique ID +%{window-title}:: String. Window title +%{app-name}:: String. Application name +%{app-pid}:: Number. https://en.wikipedia.org/wiki/Process_identifier[UNIX process identifier] +%{app-id}:: String. Application unique identifier. https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids[Bundle ID] +%{workspace}:: String. Name of the belonging workspace +%{monitor-id}:: Number. Sequential number of the belonging monitor +%{monitor-name}:: String. Name of the belonging monitor +%{right-padding}:: A special variable which expands with a minimum number of spaces required to form a right padding in the appropriate column +%{newline}:: Unicode U+000A newline symbol `\n` +%{tab}:: Unicode U+0009 tab symbol `\t` // end::body[] diff --git a/docs/commands.adoc b/docs/commands.adoc index 63a8e53f..b16d747f 100644 --- a/docs/commands.adoc +++ b/docs/commands.adoc @@ -3,6 +3,8 @@ include::util/site-attributes.adoc[] include::util/header.adoc[] +Commands documentation is also available in the form of manpages. + == close ---- include::aerospace-close.adoc[tags=synopsis] -- knotmirror 0.0.1