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
|
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2020 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
//
//===----------------------------------------------------------------------===//
/// A wrapper that transparently includes a parsable type.
///
/// Use an option group to include a group of options, flags, or arguments
/// declared in a parsable type.
///
/// struct GlobalOptions: ParsableArguments {
/// @Flag(name: .shortAndLong)
/// var verbose: Bool
///
/// @Argument var values: [Int]
/// }
///
/// struct Options: ParsableArguments {
/// @Option var name: String
/// @OptionGroup var globals: GlobalOptions
/// }
///
/// The flag and positional arguments declared as part of `GlobalOptions` are
/// included when parsing `Options`.
@propertyWrapper
public struct OptionGroup<Value: ParsableArguments>: Decodable, ParsedWrapper {
internal var _parsedValue: Parsed<Value>
internal var _visibility: ArgumentVisibility
// FIXME: Adding this property works around the crasher described in
// https://github.com/apple/swift-argument-parser/issues/338
internal var _dummy: Bool = false
/// The title to use in the help screen for this option group.
public var title: String = ""
internal init(_parsedValue: Parsed<Value>) {
self._parsedValue = _parsedValue
self._visibility = .default
}
public init(from decoder: Decoder) throws {
if let d = decoder as? SingleValueDecoder,
let value = try? d.previousValue(Value.self)
{
self.init(_parsedValue: .value(value))
} else {
try self.init(_decoder: decoder)
if let d = decoder as? SingleValueDecoder {
d.saveValue(wrappedValue)
}
}
do {
try wrappedValue.validate()
} catch {
throw ParserError.userValidationError(error)
}
}
/// Creates a property that represents another parsable type, using the
/// specified title and visibility.
///
/// - Parameters:
/// - title: A title for grouping this option group's members in your
/// command's help screen. If `title` is empty, the members will be
/// displayed alongside the other arguments, flags, and options declared
/// by your command.
/// - visibility: The visibility to use for the entire option group.
public init(
title: String = "",
visibility: ArgumentVisibility = .default
) {
self.init(_parsedValue: .init { parentKey in
var args = ArgumentSet(Value.self, visibility: .private, parent: parentKey)
args.content.withEach {
$0.help.parentTitle = title
}
return args
})
self._visibility = visibility
self.title = title
}
/// The value presented by this property wrapper.
public var wrappedValue: Value {
get {
switch _parsedValue {
case .value(let v):
return v
case .definition:
fatalError(directlyInitializedError)
}
}
set {
_parsedValue = .value(newValue)
}
}
}
extension OptionGroup: CustomStringConvertible {
public var description: String {
switch _parsedValue {
case .value(let v):
return String(describing: v)
case .definition:
return "OptionGroup(*definition*)"
}
}
}
// Experimental use with caution
extension OptionGroup {
@available(*, deprecated, renamed: "init(visibility:)")
public init(_hiddenFromHelp: Bool) {
self.init(visibility: .hidden)
}
/// Creates a property that represents another parsable type.
@available(*, deprecated, renamed: "init(visibility:)")
@_disfavoredOverload
public init() {
self.init(visibility: .default)
}
}
// MARK: Deprecated
extension OptionGroup {
@_disfavoredOverload
@available(*, deprecated, renamed: "init(title:visibility:)")
public init(
visibility _visibility: ArgumentVisibility = .default
) {
self.init(title: "", visibility: _visibility)
}
}
|
