1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
//===--- Command.swift ----------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
struct Command: Hashable {
var executable: AnyPath
var args: [Argument]
init(executable: AnyPath, args: [Argument]) {
self.executable = executable
self.args = args
}
}
extension Command: Decodable {
init(from decoder: Decoder) throws {
let command = try decoder.singleValueContainer().decode(String.self)
self = try CommandParser.parseCommand(command)
}
}
extension Command {
var printedArgs: [String] {
[executable.rawPath.escaped] + args.flatMap(\.printedArgs)
}
var printed: String {
printedArgs.joined(separator: " ")
}
}
// MARK: Argument
extension Command {
enum Argument: Hashable {
case option(Option)
case flag(Flag)
case value(String)
}
}
extension Command.Argument {
static func option(
_ flag: Command.Flag, spacing: Command.OptionSpacing, value: String
) -> Self {
.option(.init(flag, spacing: spacing, value: value))
}
var flag: Command.Flag? {
switch self {
case .option(let opt):
opt.flag
case .flag(let flag):
flag
case .value:
nil
}
}
var value: String? {
switch self {
case .option(let opt):
opt.value
case .value(let value):
value
case .flag:
nil
}
}
var printedArgs: [String] {
switch self {
case .option(let opt):
opt.printedArgs
case .value(let value):
[value.escaped]
case .flag(let f):
[f.printed]
}
}
var printed: String {
printedArgs.joined(separator: " ")
}
func option(for flag: Command.Flag) -> Command.Option? {
switch self {
case .option(let opt) where opt.flag == flag:
opt
default:
nil
}
}
/// If there is a value, apply a transform to it.
func mapValue(_ fn: (String) throws -> String) rethrows -> Self {
switch self {
case .option(let opt):
.option(try opt.mapValue(fn))
case .value(let value):
.value(try fn(value))
case .flag:
// Nothing to map.
self
}
}
}
// MARK: Flag
extension Command {
struct Flag: Hashable {
var dash: Dash
var name: Name
}
}
extension Command.Flag {
static func dash(_ name: Name) -> Self {
.init(dash: .single, name: name)
}
static func doubleDash(_ name: Name) -> Self {
.init(dash: .double, name: name)
}
var printed: String {
"\(dash.printed)\(name.rawValue)"
}
}
extension Command.Flag {
enum Dash: Int, CaseIterable, Comparable {
case single = 1, double
static func < (lhs: Self, rhs: Self) -> Bool { lhs.rawValue < rhs.rawValue }
}
}
extension Command.Flag.Dash {
init?(numDashes: Int) {
self.init(rawValue: numDashes)
}
var printed: String {
switch self {
case .single:
return "-"
case .double:
return "--"
}
}
}
extension DefaultStringInterpolation {
mutating func appendInterpolation(_ flag: Command.Flag) {
appendInterpolation(flag.printed)
}
}
// MARK: Option
extension Command {
struct Option: Hashable {
var flag: Flag
var spacing: OptionSpacing
var value: String
init(_ flag: Flag, spacing: OptionSpacing, value: String) {
self.flag = flag
self.spacing = spacing
self.value = value
}
}
}
extension Command.Option {
func withValue(_ newValue: String) -> Self {
var result = self
result.value = newValue
return result
}
func mapValue(_ fn: (String) throws -> String) rethrows -> Self {
withValue(try fn(value))
}
var printedArgs: [String] {
switch spacing {
case .equals, .unspaced:
["\(flag)\(spacing)\(value.escaped)"]
case .spaced:
["\(flag)", value.escaped]
}
}
var printed: String {
printedArgs.joined(separator: " ")
}
}
// MARK: OptionSpacing
extension Command {
enum OptionSpacing: Comparable {
case equals, unspaced, spaced
}
}
extension Command.OptionSpacing {
var printed: String {
switch self {
case .equals: "="
case .unspaced: ""
case .spaced: " "
}
}
}
// MARK: CustomStringConvertible
extension Command.Argument: CustomStringConvertible {
var description: String { printed }
}
extension Command.OptionSpacing: CustomStringConvertible {
var description: String { printed }
}
extension Command.Flag: CustomStringConvertible {
var description: String { printed }
}
extension Command.Option: CustomStringConvertible {
var description: String { printed }
}
// MARK: Comparable
// We sort the resulting command-line arguments to ensure deterministic
// ordering.
extension Command.Flag: Comparable {
static func < (lhs: Self, rhs: Self) -> Bool {
guard lhs.dash == rhs.dash else {
return lhs.dash < rhs.dash
}
return lhs.name.rawValue < rhs.name.rawValue
}
}
extension Command.Option: Comparable {
static func < (lhs: Self, rhs: Self) -> Bool {
guard lhs.flag == rhs.flag else {
return lhs.flag < rhs.flag
}
guard lhs.spacing == rhs.spacing else {
return lhs.spacing < rhs.spacing
}
return lhs.value < rhs.value
}
}
extension Command.Argument: Comparable {
static func < (lhs: Self, rhs: Self) -> Bool {
switch (lhs, rhs) {
// Sort flags < options < values
case (.flag, .option): true
case (.flag, .value): true
case (.option, .value): true
case (.option, .flag): false
case (.value, .flag): false
case (.value, .option): false
case (.flag(let lhs), .flag(let rhs)): lhs < rhs
case (.option(let lhs), .option(let rhs)): lhs < rhs
case (.value(let lhs), .value(let rhs)): lhs < rhs
}
}
}
|