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
|
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2022 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
//
//===----------------------------------------------------------------------===//
/// Represents the path to a parsed field, annotated with ``Flag``, ``Option``
/// or ``Argument``. Fields that are directly declared on a ``ParsableComand``
/// have a path of length 1, while fields that are declared indirectly (and
/// included via an option group) have longer paths.
struct InputKey: Hashable {
/// The name of the input key.
var name: String
/// The path through the field's parents, if any.
var path: [String]
/// The full path of the field.
var fullPath: [String] { path + [name] }
/// Constructs a new input key, cleaning the name, with the specified parent.
///
/// - Parameter name: The name of the key.
/// - Parameter parent: The input key of the parent.
init(name: String, parent: InputKey?) {
// Property wrappers have underscore-prefixed names, so we remove the
// leading `_`, if present.
self.name = name.first == "_"
? String(name.dropFirst(1))
: name
self.path = parent?.fullPath ?? []
}
/// Constructs a new input key from the given coding key and parent path.
///
/// - Parameter codingKey: The base ``CodingKey``. Leading underscores in
/// `codingKey` is preserved.
/// - Parameter path: The list of ``CodingKey`` values that lead to this one.
/// `path` may be empty.
@inlinable
init(codingKey: CodingKey, path: [CodingKey]) {
self.name = codingKey.stringValue
self.path = path.map { $0.stringValue }
}
}
extension InputKey: CustomStringConvertible {
var description: String {
fullPath.joined(separator: ".")
}
}
|
