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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
// Plist Encoder
//===----------------------------------------------------------------------===//
/// `PropertyListEncoder` facilitates the encoding of `Encodable` values into property lists.
// NOTE: older overlays had Foundation.PropertyListEncoder as the ObjC
// name. The two must coexist, so it was renamed. The old name must not
// be used in the new runtime. _TtC10Foundation20_PropertyListEncoder
// is the mangled name for Foundation._PropertyListEncoder.
@_objcRuntimeName(_TtC10Foundation20_PropertyListEncoder)
@available(macOS 10.10, iOS 8.0, watchOS 2.0, tvOS 9.0, *)
open class PropertyListEncoder {
// MARK: - Options
/// The output format to write the property list data in. Defaults to `.binary`.
open var outputFormat: PropertyListDecoder.PropertyListFormat {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.outputFormat
}
_modify {
optionsLock.lock()
var value = options.outputFormat
defer {
options.outputFormat = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.outputFormat = newValue
}
}
/// Contextual user-provided information for use during encoding.
open var userInfo: [CodingUserInfoKey : Any] {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.userInfo
}
_modify {
optionsLock.lock()
var value = options.userInfo
defer {
options.userInfo = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.userInfo = newValue
}
}
/// Options set on the top-level encoder to pass down the encoding hierarchy.
internal struct _Options {
var outputFormat: PropertyListDecoder.PropertyListFormat = .binary
var userInfo: [CodingUserInfoKey : Any] = [:]
}
/// The options set on the top-level encoder.
fileprivate var options: _Options = _Options()
fileprivate let optionsLock = LockedState<Void>()
// MARK: - Constructing a Property List Encoder
/// Initializes `self` with default strategies.
public init() {}
// MARK: - Encoding Values
/// Encodes the given top-level value and returns its property list representation.
///
/// - parameter value: The value to encode.
/// - returns: A new `Data` value containing the encoded property list data.
/// - throws: `EncodingError.invalidValue` if a non-conforming floating-point value is encountered during encoding, and the encoding strategy is `.throw`.
/// - throws: An error if any value throws an error during encoding.
open func encode<Value : Encodable>(_ value: Value) throws -> Data {
do {
switch options.outputFormat {
case .binary:
return try _encodeBPlist(value)
case .xml:
return try _encodeXML(value)
case .openStep:
throw CocoaError(.propertyListWriteInvalid, userInfo: [NSDebugDescriptionErrorKey:"Property list format .openStep not supported for writing"])
#if FOUNDATION_FRAMEWORK
@unknown default:
throw CocoaError(.propertyListWriteInvalid, userInfo: [NSDebugDescriptionErrorKey:"Unknown property list format \(options.outputFormat)"])
#endif
}
} catch {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [], debugDescription: "Unable to encode the given top-level value as a property list", underlyingError: error))
}
}
fileprivate func _encodeBPlist<Value: Encodable>(_ value: Value) throws -> Data {
let topLevel = try encodeToTopLevelContainerBPlist(value)
if topLevel.isBool {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as boolean property list fragment."))
} else if topLevel.isNumber {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as number property list fragment."))
} else if topLevel.isString {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as string property list fragment."))
} else if topLevel.isDate {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as date property list fragment."))
}
var writer = _BPlistEncodingFormat.Writer()
return try writer.serializePlist(topLevel)
}
fileprivate func _encodeXML<Value: Encodable>(_ value: Value) throws -> Data {
let topLevel = try encodeToTopLevelContainerXML(value)
if topLevel.isBool {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as boolean property list fragment."))
} else if topLevel.isNumber {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as number property list fragment."))
} else if topLevel.isString {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as string property list fragment."))
} else if topLevel.isDate {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) encoded as date property list fragment."))
}
var writer = _XMLPlistEncodingFormat.Writer()
return try writer.serializePlist(topLevel)
}
@available(FoundationPreview 0.1, *)
open func encode<T : EncodableWithConfiguration>(_ value: T, configuration: T.EncodingConfiguration) throws -> Data {
do {
switch options.outputFormat {
case .binary:
return try _encodeBPlist(value, configuration: configuration)
case .xml:
return try _encodeXML(value, configuration: configuration)
case .openStep:
throw CocoaError(.propertyListWriteInvalid, userInfo: [NSDebugDescriptionErrorKey:"Property list format .openStep not supported for writing"])
#if FOUNDATION_FRAMEWORK
@unknown default:
throw CocoaError(.propertyListWriteInvalid, userInfo: [NSDebugDescriptionErrorKey:"Unknown property list format \(options.outputFormat)"])
#endif
}
} catch {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [], debugDescription: "Unable to encode the given top-level value as a property list", underlyingError: error))
}
}
fileprivate func _encodeBPlist<T: EncodableWithConfiguration>(_ value: T, configuration: T.EncodingConfiguration) throws -> Data {
let topLevel = try encodeToTopLevelContainerBPlist(value, configuration: configuration)
var writer = _BPlistEncodingFormat.Writer()
return try writer.serializePlist(topLevel)
}
fileprivate func _encodeXML<T: EncodableWithConfiguration>(_ value: T, configuration: T.EncodingConfiguration) throws -> Data {
let topLevel = try encodeToTopLevelContainerXML(value, configuration: configuration)
var writer = _XMLPlistEncodingFormat.Writer()
return try writer.serializePlist(topLevel)
}
@available(FoundationPreview 0.1, *)
open func encode<T, C>(_ value: T, configuration: C.Type) throws -> Data where T : EncodableWithConfiguration, C : EncodingConfigurationProviding, T.EncodingConfiguration == C.EncodingConfiguration {
try encode(value, configuration: C.encodingConfiguration)
}
/// Encodes the given top-level value and returns its plist-type representation.
///
/// - parameter value: The value to encode.
/// - returns: A new top-level array or dictionary representing the value.
/// - throws: `EncodingError.invalidValue` if a non-conforming floating-point value is encountered during encoding, and the encoding strategy is `.throw`.
/// - throws: An error if any value throws an error during encoding.
internal func encodeToTopLevelContainerBPlist<Value : Encodable>(_ value: Value) throws -> _BPlistEncodingFormat.Reference {
let encoder = __PlistEncoderBPlist(options: self.options)
guard let topLevel = try encoder.wrapGeneric(value, for: .root) else {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) did not encode any values."))
}
return topLevel
}
internal func encodeToTopLevelContainerXML<Value : Encodable>(_ value: Value) throws -> _XMLPlistEncodingFormat.Reference {
let encoder = __PlistEncoderXML(options: self.options)
guard let topLevel = try encoder.wrapGeneric(value, for: .root) else {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) did not encode any values."))
}
return topLevel
}
internal func encodeToTopLevelContainerBPlist<Value: EncodableWithConfiguration>(_ value: Value, configuration: Value.EncodingConfiguration) throws -> _BPlistEncodingFormat.Reference {
let encoder = __PlistEncoderBPlist(options: self.options)
guard let topLevel = try encoder.wrapGeneric(value, configuration: configuration, for: .root) else {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) did not encode any values."))
}
return topLevel
}
internal func encodeToTopLevelContainerXML<Value : EncodableWithConfiguration>(_ value: Value, configuration: Value.EncodingConfiguration) throws -> _XMLPlistEncodingFormat.Reference {
let encoder = __PlistEncoderXML(options: self.options)
guard let topLevel = try encoder.wrapGeneric(value, configuration: configuration, for: .root) else {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [],
debugDescription: "Top-level \(Value.self) did not encode any values."))
}
return topLevel
}
}
@available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *)
extension PropertyListEncoder : @unchecked Sendable {}
|
