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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
// JSON Encoder
//===----------------------------------------------------------------------===//
/// `JSONEncoder` facilitates the encoding of `Encodable` values into JSON.
// NOTE: older overlays had Foundation.JSONEncoder as the ObjC name.
// The two must coexist, so it was renamed. The old name must not be
// used in the new runtime. _TtC10Foundation13__JSONEncoder is the
// mangled name for Foundation.__JSONEncoder.
#if FOUNDATION_FRAMEWORK
@_objcRuntimeName(_TtC10Foundation13__JSONEncoder)
#endif
@available(macOS 10.10, iOS 8.0, watchOS 2.0, tvOS 9.0, *)
open class JSONEncoder {
// MARK: Options
/// The formatting of the output JSON data.
public struct OutputFormatting : OptionSet, Sendable {
/// The format's default value.
public let rawValue: UInt
/// Creates an OutputFormatting value with the given raw value.
public init(rawValue: UInt) {
self.rawValue = rawValue
}
/// Produce human-readable JSON with indented output.
public static let prettyPrinted = OutputFormatting(rawValue: 1 << 0)
/// Produce JSON with dictionary keys sorted in lexicographic order.
@available(macOS 10.13, iOS 11.0, watchOS 4.0, tvOS 11.0, *)
public static let sortedKeys = OutputFormatting(rawValue: 1 << 1)
/// By default slashes get escaped ("/" → "\/", "http://apple.com/" → "http:\/\/apple.com\/")
/// for security reasons, allowing outputted JSON to be safely embedded within HTML/XML.
/// In contexts where this escaping is unnecessary, the JSON is known to not be embedded,
/// or is intended only for display, this option avoids this escaping.
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public static let withoutEscapingSlashes = OutputFormatting(rawValue: 1 << 3)
}
/// The strategy to use for encoding `Date` values.
public enum DateEncodingStrategy : Sendable {
/// Defer to `Date` for choosing an encoding. This is the default strategy.
case deferredToDate
/// Encode the `Date` as a UNIX timestamp (as a JSON number).
case secondsSince1970
/// Encode the `Date` as UNIX millisecond timestamp (as a JSON number).
case millisecondsSince1970
/// Encode the `Date` as an ISO-8601-formatted string (in RFC 3339 format).
@available(macOS 10.12, iOS 10.0, watchOS 3.0, tvOS 10.0, *)
case iso8601
#if FOUNDATION_FRAMEWORK && !NO_FORMATTERS
/// Encode the `Date` as a string formatted by the given formatter.
case formatted(DateFormatter)
#endif // FOUNDATION_FRAMEWORK
/// Encode the `Date` as a custom value encoded by the given closure.
///
/// If the closure fails to encode a value into the given encoder, the encoder will encode an empty automatic container in its place.
@preconcurrency
case custom(@Sendable (Date, Encoder) throws -> Void)
}
/// The strategy to use for encoding `Data` values.
public enum DataEncodingStrategy : Sendable {
/// Defer to `Data` for choosing an encoding.
case deferredToData
/// Encoded the `Data` as a Base64-encoded string. This is the default strategy.
case base64
/// Encode the `Data` as a custom value encoded by the given closure.
///
/// If the closure fails to encode a value into the given encoder, the encoder will encode an empty automatic container in its place.
@preconcurrency
case custom(@Sendable (Data, Encoder) throws -> Void)
}
/// The strategy to use for non-JSON-conforming floating-point values (IEEE 754 infinity and NaN).
public enum NonConformingFloatEncodingStrategy : Sendable {
/// Throw upon encountering non-conforming values. This is the default strategy.
case `throw`
/// Encode the values using the given representation strings.
case convertToString(positiveInfinity: String, negativeInfinity: String, nan: String)
}
/// The strategy to use for automatically changing the value of keys before encoding.
public enum KeyEncodingStrategy : Sendable {
/// Use the keys specified by each type. This is the default strategy.
case useDefaultKeys
/// Convert from "camelCaseKeys" to "snake_case_keys" before writing a key to JSON payload.
///
/// Capital characters are determined by testing membership in Unicode General Categories Lu and Lt.
/// The conversion to lower case uses `Locale.system`, also known as the ICU "root" locale. This means the result is consistent regardless of the current user's locale and language preferences.
///
/// Converting from camel case to snake case:
/// 1. Splits words at the boundary of lower-case to upper-case
/// 2. Inserts `_` between words
/// 3. Lowercases the entire string
/// 4. Preserves starting and ending `_`.
///
/// For example, `oneTwoThree` becomes `one_two_three`. `_oneTwoThree_` becomes `_one_two_three_`.
///
/// - Note: Using a key encoding strategy has a nominal performance cost, as each string key has to be converted.
case convertToSnakeCase
/// Provide a custom conversion to the key in the encoded JSON from the keys specified by the encoded types.
/// The full path to the current encoding position is provided for context (in case you need to locate this key within the payload). The returned key is used in place of the last component in the coding path before encoding.
/// If the result of the conversion is a duplicate key, then only one value will be present in the result.
@preconcurrency
case custom(@Sendable (_ codingPath: [CodingKey]) -> CodingKey)
fileprivate static func _convertToSnakeCase(_ stringKey: String) -> String {
guard !stringKey.isEmpty else { return stringKey }
var words : [Range<String.Index>] = []
// The general idea of this algorithm is to split words on transition from lower to upper case, then on transition of >1 upper case characters to lowercase
//
// myProperty -> my_property
// myURLProperty -> my_url_property
//
// We assume, per Swift naming conventions, that the first character of the key is lowercase.
var wordStart = stringKey.startIndex
var searchRange = stringKey.index(after: wordStart)..<stringKey.endIndex
// Find next uppercase character
while let upperCaseRange = stringKey[searchRange]._rangeOfCharacter(from: BuiltInUnicodeScalarSet.uppercaseLetters, options: []) {
let untilUpperCase = wordStart..<upperCaseRange.lowerBound
words.append(untilUpperCase)
// Find next lowercase character
searchRange = upperCaseRange.lowerBound..<searchRange.upperBound
guard let lowerCaseRange = stringKey[searchRange]._rangeOfCharacter(from: BuiltInUnicodeScalarSet.lowercaseLetters, options: []) else {
// There are no more lower case letters. Just end here.
wordStart = searchRange.lowerBound
break
}
// Is the next lowercase letter more than 1 after the uppercase? If so, we encountered a group of uppercase letters that we should treat as its own word
let nextCharacterAfterCapital = stringKey.index(after: upperCaseRange.lowerBound)
if lowerCaseRange.lowerBound == nextCharacterAfterCapital {
// The next character after capital is a lower case character and therefore not a word boundary.
// Continue searching for the next upper case for the boundary.
wordStart = upperCaseRange.lowerBound
} else {
// There was a range of >1 capital letters. Turn those into a word, stopping at the capital before the lower case character.
let beforeLowerIndex = stringKey.index(before: lowerCaseRange.lowerBound)
words.append(upperCaseRange.lowerBound..<beforeLowerIndex)
// Next word starts at the capital before the lowercase we just found
wordStart = beforeLowerIndex
}
searchRange = lowerCaseRange.upperBound..<searchRange.upperBound
}
words.append(wordStart..<searchRange.upperBound)
let result = words.map({ (range) in
return stringKey[range].lowercased()
}).joined(separator: "_")
return result
}
}
/// The output format to produce. Defaults to `[]`.
open var outputFormatting: OutputFormatting {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.outputFormatting
}
_modify {
optionsLock.lock()
var value = options.outputFormatting
defer {
options.outputFormatting = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.outputFormatting = newValue
}
}
/// The strategy to use in encoding dates. Defaults to `.deferredToDate`.
open var dateEncodingStrategy: DateEncodingStrategy {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.dateEncodingStrategy
}
_modify {
optionsLock.lock()
var value = options.dateEncodingStrategy
defer {
options.dateEncodingStrategy = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.dateEncodingStrategy = newValue
}
}
/// The strategy to use in encoding binary data. Defaults to `.base64`.
open var dataEncodingStrategy: DataEncodingStrategy {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.dataEncodingStrategy
}
_modify {
optionsLock.lock()
var value = options.dataEncodingStrategy
defer {
options.dataEncodingStrategy = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.dataEncodingStrategy = newValue
}
}
/// The strategy to use in encoding non-conforming numbers. Defaults to `.throw`.
open var nonConformingFloatEncodingStrategy: NonConformingFloatEncodingStrategy {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.nonConformingFloatEncodingStrategy
}
_modify {
optionsLock.lock()
var value = options.nonConformingFloatEncodingStrategy
defer {
options.nonConformingFloatEncodingStrategy = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.nonConformingFloatEncodingStrategy = newValue
}
}
/// The strategy to use for encoding keys. Defaults to `.useDefaultKeys`.
open var keyEncodingStrategy: KeyEncodingStrategy {
get {
optionsLock.lock()
defer { optionsLock.unlock() }
return options.keyEncodingStrategy
}
_modify {
optionsLock.lock()
var value = options.keyEncodingStrategy
defer {
options.keyEncodingStrategy = value
optionsLock.unlock()
}
yield &value
}
set {
optionsLock.lock()
defer { optionsLock.unlock() }
options.keyEncodingStrategy = 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.
fileprivate struct _Options {
var outputFormatting: OutputFormatting = []
var dateEncodingStrategy: DateEncodingStrategy = .deferredToDate
var dataEncodingStrategy: DataEncodingStrategy = .base64
var nonConformingFloatEncodingStrategy: NonConformingFloatEncodingStrategy = .throw
var keyEncodingStrategy: KeyEncodingStrategy = .useDefaultKeys
var userInfo: [CodingUserInfoKey : Any] = [:]
}
/// The options set on the top-level encoder.
fileprivate var options = _Options()
fileprivate let optionsLock = LockedState<Void>()
// MARK: - Constructing a JSON Encoder
/// Initializes `self` with default strategies.
public init() {}
// MARK: - Encoding Values
/// Encodes the given top-level value and returns its JSON representation.
///
/// - parameter value: The value to encode.
/// - returns: A new `Data` value containing the encoded JSON 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<T : Encodable>(_ value: T) throws -> Data {
try _encode({
try $0.wrapGeneric(value, for: .root)
}, value: value)
}
@available(FoundationPreview 0.1, *)
open func encode<T : EncodableWithConfiguration>(_ value: T, configuration: T.EncodingConfiguration) throws -> Data {
try _encode({
try $0.wrapGeneric(value, configuration: configuration, for: .root)
}, value: value)
}
@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)
}
private func _encode<T>(_ wrap: (__JSONEncoder) throws -> JSONReference?, value: T) throws -> Data {
let encoder = __JSONEncoder(options: self.options, initialDepth: 0)
guard let topLevel = try wrap(encoder) else {
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [], debugDescription: "Top-level \(T.self) did not encode any values."))
}
let writingOptions = JSONWriter.WritingOptions(rawValue: self.outputFormatting.rawValue).union(.fragmentsAllowed)
do {
var writer = JSONWriter(options: writingOptions)
try writer.serializeJSON(topLevel)
return writer.data
} catch let error as JSONError {
#if FOUNDATION_FRAMEWORK
let underlyingError: Error? = error.nsError
#else
let underlyingError: Error? = nil
#endif // FOUNDATION_FRAMEWORK
throw EncodingError.invalidValue(value,
EncodingError.Context(codingPath: [], debugDescription: "Unable to encode the given top-level value to JSON.", underlyingError: underlyingError))
}
}
}
// MARK: - __JSONEncoder
// NOTE: older overlays called this class _JSONEncoder.
// The two must coexist without a conflicting ObjC class name, so it
// was renamed. The old name must not be used in the new runtime.
private class __JSONEncoder : Encoder {
// MARK: Properties
/// The encoder's storage.
var storage: _JSONEncodingStorage
/// Options set on the top-level encoder.
let options: JSONEncoder._Options
var encoderCodingPathNode: _CodingPathNode
var codingPathDepth: Int
/// Contextual user-provided information for use during encoding.
public var userInfo: [CodingUserInfoKey : Any] {
return self.options.userInfo
}
/// The path to the current point in encoding.
public var codingPath: [CodingKey] {
encoderCodingPathNode.path
}
// MARK: - Initialization
/// Initializes `self` with the given top-level encoder options.
init(options: JSONEncoder._Options, codingPathNode: _CodingPathNode = .root, initialDepth: Int) {
self.options = options
self.storage = _JSONEncodingStorage()
self.encoderCodingPathNode = codingPathNode
self.codingPathDepth = initialDepth
}
/// Returns whether a new element can be encoded at this coding path.
///
/// `true` if an element has not yet been encoded at this coding path; `false` otherwise.
var canEncodeNewValue: Bool {
// Every time a new value gets encoded, the key it's encoded for is pushed onto the coding path (even if it's a nil key from an unkeyed container).
// At the same time, every time a container is requested, a new value gets pushed onto the storage stack.
// If there are more values on the storage stack than on the coding path, it means the value is requesting more than one container, which violates the precondition.
//
// This means that anytime something that can request a new container goes onto the stack, we MUST push a key onto the coding path.
// Things which will not request containers do not need to have the coding path extended for them (but it doesn't matter if it is, because they will not reach here).
return self.storage.count == self.codingPathDepth
}
// MARK: - Encoder Methods
public func container<Key>(keyedBy: Key.Type) -> KeyedEncodingContainer<Key> {
// If an existing keyed container was already requested, return that one.
let topRef: JSONReference
if self.canEncodeNewValue {
// We haven't yet pushed a container at this level; do so here.
topRef = self.storage.pushKeyedContainer()
} else {
guard let ref = self.storage.refs.last, ref.isObject else {
preconditionFailure("Attempt to push new keyed encoding container when already previously encoded at this path.")
}
topRef = ref
}
let container = _JSONKeyedEncodingContainer<Key>(referencing: self, codingPathNode: self.encoderCodingPathNode, wrapping: topRef)
return KeyedEncodingContainer(container)
}
public func unkeyedContainer() -> UnkeyedEncodingContainer {
// If an existing unkeyed container was already requested, return that one.
let topRef: JSONReference
if self.canEncodeNewValue {
// We haven't yet pushed a container at this level; do so here.
topRef = self.storage.pushUnkeyedContainer()
} else {
guard let ref = self.storage.refs.last, ref.isArray else {
preconditionFailure("Attempt to push new unkeyed encoding container when already previously encoded at this path.")
}
topRef = ref
}
return _JSONUnkeyedEncodingContainer(referencing: self, codingPathNode: self.encoderCodingPathNode, wrapping: topRef)
}
public func singleValueContainer() -> SingleValueEncodingContainer {
return self
}
// Instead of creating a new __JSONEncoder for passing to methods that take Encoder arguments, wrap the access in this method, which temporarily mutates this __JSONEncoder instance with the additional nesting depth and its coding path.
@inline(__always)
func with<T>(path: _CodingPathNode?, perform closure: () throws -> T) rethrows -> T {
let oldPath = self.encoderCodingPathNode
let oldDepth = self.codingPathDepth
if let path {
self.encoderCodingPathNode = path
self.codingPathDepth = path.depth
}
defer {
if path != nil {
self.encoderCodingPathNode = oldPath
self.codingPathDepth = oldDepth
}
}
return try closure()
}
}
// MARK: - Encoding Storage and Containers
class JSONReference {
enum Backing {
case string(String)
case number(String)
case bool(Bool)
case null
case array([JSONReference])
case object([String:JSONReference])
case nonPrettyDirectArray(String)
case directArray([String])
}
private(set) var backing: Backing
@inline(__always)
func insert(_ ref: JSONReference, for key: String) {
guard case .object(var object) = backing else {
preconditionFailure("Wrong underlying JSON reference type")
}
backing = .null
object[key] = ref
backing = .object(object)
}
@inline(__always)
func insert(_ ref: JSONReference, at index: Int) {
guard case .array(var array) = backing else {
preconditionFailure("Wrong underlying JSON reference type")
}
backing = .null
array.insert(ref, at: index)
backing = .array(array)
}
@inline(__always)
func insert(_ ref: JSONReference) {
guard case .array(var array) = backing else {
preconditionFailure("Wrong underlying JSON reference type")
}
backing = .null
array.append(ref)
backing = .array(array)
}
@inline(__always)
var count: Int {
switch backing {
case .array(let array): return array.count
case .object(let dict): return dict.count
default: preconditionFailure("Count does not apply to count")
}
}
@inline(__always)
init(_ backing: Backing) {
self.backing = backing
}
@inline(__always)
subscript (_ key: String) -> JSONReference? {
switch backing {
case .object(let backingDict):
return backingDict[key]
default:
preconditionFailure("Wrong underlying JSON reference type")
}
}
@inline(__always)
subscript (_ index: Int) -> JSONReference {
switch backing {
case .array(let array):
return array[index]
default:
preconditionFailure("Wrong underlying JSON reference type")
}
}
@inline(__always)
var isObject: Bool {
guard case .object = backing else {
return false
}
return true
}
@inline(__always)
var isArray: Bool {
guard case .array = backing else {
return false
}
return true
}
// Sendable note: this is an immutable singleton
static nonisolated(unsafe) let null : JSONReference = .init(.null)
static func string(_ str: String) -> JSONReference { .init(.string(str)) }
static func number(_ str: String) -> JSONReference { .init(.number(str)) }
// Sendable note: this is an immutable singleton
static nonisolated(unsafe) let `true` : JSONReference = .init(.bool(true))
// Sendable note: this is an immutable singleton
static nonisolated(unsafe) let `false` : JSONReference = .init(.bool(false))
static func bool(_ b: Bool) -> JSONReference { b ? .true : .false }
static var emptyArray : JSONReference { .init(.array([])) }
static var emptyObject : JSONReference { .init(.object([:])) }
}
private struct _JSONEncodingStorage {
// MARK: Properties
var refs = [JSONReference]()
// MARK: - Initialization
/// Initializes `self` with no containers.
init() {}
// MARK: - Modifying the Stack
var count: Int {
return self.refs.count
}
mutating func pushKeyedContainer() -> JSONReference {
let object = JSONReference.emptyObject
self.refs.append(object)
return object
}
mutating func pushUnkeyedContainer() -> JSONReference {
let object = JSONReference.emptyArray
self.refs.append(object)
return object
}
mutating func push(ref: __owned JSONReference) {
self.refs.append(ref)
}
mutating func popReference() -> JSONReference {
precondition(!self.refs.isEmpty, "Empty reference stack.")
return self.refs.popLast().unsafelyUnwrapped
}
}
// MARK: - Encoding Containers
private struct _JSONKeyedEncodingContainer<K : CodingKey> : KeyedEncodingContainerProtocol {
typealias Key = K
// MARK: Properties
/// A reference to the encoder we're writing to.
private let encoder: __JSONEncoder
private let reference: JSONReference
private let codingPathNode: _CodingPathNode
/// The path of coding keys taken to get to this point in encoding.
public var codingPath: [CodingKey] {
codingPathNode.path
}
// MARK: - Initialization
/// Initializes `self` with the given references.
init(referencing encoder: __JSONEncoder, codingPathNode: _CodingPathNode, wrapping ref: JSONReference) {
self.encoder = encoder
self.codingPathNode = codingPathNode
self.reference = ref
}
// MARK: - Coding Path Operations
private func _converted(_ key: CodingKey) -> String {
switch encoder.options.keyEncodingStrategy {
case .useDefaultKeys:
return key.stringValue
case .convertToSnakeCase:
let newKeyString = JSONEncoder.KeyEncodingStrategy._convertToSnakeCase(key.stringValue)
return newKeyString
case .custom(let converter):
return converter(codingPathNode.path(byAppending: key)).stringValue
}
}
// MARK: - KeyedEncodingContainerProtocol Methods
public mutating func encodeNil(forKey key: Key) throws {
reference.insert(.null, for: _converted(key))
}
public mutating func encode(_ value: Bool, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Int, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Int8, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Int16, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Int32, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Int64, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: Int128, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt8, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt16, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt32, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: UInt64, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: UInt128, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: String, forKey key: Key) throws {
reference.insert(self.encoder.wrap(value), for: _converted(key))
}
public mutating func encode(_ value: Float, forKey key: Key) throws {
let wrapped = try self.encoder.wrap(value, for: self.encoder.encoderCodingPathNode, key)
reference.insert(wrapped, for: _converted(key))
}
public mutating func encode(_ value: Double, forKey key: Key) throws {
let wrapped = try self.encoder.wrap(value, for: self.encoder.encoderCodingPathNode, key)
reference.insert(wrapped, for: _converted(key))
}
public mutating func encode<T : Encodable>(_ value: T, forKey key: Key) throws {
let wrapped = try self.encoder.wrap(value, for: self.encoder.encoderCodingPathNode, key)
reference.insert(wrapped, for: _converted(key))
}
public mutating func nestedContainer<NestedKey>(keyedBy keyType: NestedKey.Type, forKey key: Key) -> KeyedEncodingContainer<NestedKey> {
let containerKey = _converted(key)
let nestedRef: JSONReference
if let existingRef = self.reference[containerKey] {
precondition(
existingRef.isObject,
"Attempt to re-encode into nested KeyedEncodingContainer<\(Key.self)> for key \"\(containerKey)\" is invalid: non-keyed container already encoded for this key"
)
nestedRef = existingRef
} else {
nestedRef = .emptyObject
self.reference.insert(nestedRef, for: containerKey)
}
let container = _JSONKeyedEncodingContainer<NestedKey>(referencing: self.encoder, codingPathNode: self.codingPathNode.appending(key), wrapping: nestedRef)
return KeyedEncodingContainer(container)
}
public mutating func nestedUnkeyedContainer(forKey key: Key) -> UnkeyedEncodingContainer {
let containerKey = _converted(key)
let nestedRef: JSONReference
if let existingRef = self.reference[containerKey] {
precondition(
existingRef.isArray,
"Attempt to re-encode into nested UnkeyedEncodingContainer for key \"\(containerKey)\" is invalid: keyed container/single value already encoded for this key"
)
nestedRef = existingRef
} else {
nestedRef = .emptyArray
self.reference.insert(nestedRef, for: containerKey)
}
return _JSONUnkeyedEncodingContainer(referencing: self.encoder, codingPathNode: self.codingPathNode.appending(key), wrapping: nestedRef)
}
public mutating func superEncoder() -> Encoder {
return __JSONReferencingEncoder(referencing: self.encoder, key: _CodingKey.super, convertedKey: _converted(_CodingKey.super), codingPathNode: self.encoder.encoderCodingPathNode, wrapping: self.reference)
}
public mutating func superEncoder(forKey key: Key) -> Encoder {
return __JSONReferencingEncoder(referencing: self.encoder, key: key, convertedKey: _converted(key), codingPathNode: self.encoder.encoderCodingPathNode, wrapping: self.reference)
}
}
private struct _JSONUnkeyedEncodingContainer : UnkeyedEncodingContainer {
// MARK: Properties
/// A reference to the encoder we're writing to.
private let encoder: __JSONEncoder
private let reference: JSONReference
private let codingPathNode: _CodingPathNode
/// The path of coding keys taken to get to this point in encoding.
public var codingPath: [CodingKey] {
codingPathNode.path
}
/// The number of elements encoded into the container.
public var count: Int {
self.reference.count
}
// MARK: - Initialization
/// Initializes `self` with the given references.
init(referencing encoder: __JSONEncoder, codingPathNode: _CodingPathNode, wrapping ref: JSONReference) {
self.encoder = encoder
self.codingPathNode = codingPathNode
self.reference = ref
}
// MARK: - UnkeyedEncodingContainer Methods
public mutating func encodeNil() throws { self.reference.insert(.null) }
public mutating func encode(_ value: Bool) throws { self.reference.insert(.bool(value)) }
public mutating func encode(_ value: Int) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int8) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int16) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int32) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Int64) throws { self.reference.insert(self.encoder.wrap(value)) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: Int128) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt8) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt16) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt32) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: UInt64) throws { self.reference.insert(self.encoder.wrap(value)) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public mutating func encode(_ value: UInt128) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: String) throws { self.reference.insert(self.encoder.wrap(value)) }
public mutating func encode(_ value: Float) throws {
self.reference.insert(try .number(from: value, with: encoder.options.nonConformingFloatEncodingStrategy, for: self.encoder.encoderCodingPathNode, _CodingKey(index: self.count)))
}
public mutating func encode(_ value: Double) throws {
self.reference.insert(try .number(from: value, with: encoder.options.nonConformingFloatEncodingStrategy, for: self.encoder.encoderCodingPathNode, _CodingKey(index: self.count)))
}
public mutating func encode<T : Encodable>(_ value: T) throws {
let wrapped = try self.encoder.wrap(value, for: self.encoder.encoderCodingPathNode, _CodingKey(index: self.count))
self.reference.insert(wrapped)
}
public mutating func nestedContainer<NestedKey>(keyedBy keyType: NestedKey.Type) -> KeyedEncodingContainer<NestedKey> {
let key = _CodingKey(index: self.count)
let nestedRef = JSONReference.emptyObject
self.reference.insert(nestedRef)
let container = _JSONKeyedEncodingContainer<NestedKey>(referencing: self.encoder, codingPathNode: self.codingPathNode.appending(key), wrapping: nestedRef)
return KeyedEncodingContainer(container)
}
public mutating func nestedUnkeyedContainer() -> UnkeyedEncodingContainer {
let key = _CodingKey(index: self.count)
let nestedRef = JSONReference.emptyArray
self.reference.insert(nestedRef)
return _JSONUnkeyedEncodingContainer(referencing: self.encoder, codingPathNode: self.codingPathNode.appending(key), wrapping: nestedRef)
}
public mutating func superEncoder() -> Encoder {
return __JSONReferencingEncoder(referencing: self.encoder, at: self.reference.count, codingPathNode: self.encoder.encoderCodingPathNode, wrapping: self.reference)
}
}
extension __JSONEncoder : SingleValueEncodingContainer {
// MARK: - SingleValueEncodingContainer Methods
private func assertCanEncodeNewValue() {
precondition(self.canEncodeNewValue, "Attempt to encode value through single value container when previously value already encoded.")
}
public func encodeNil() throws {
assertCanEncodeNewValue()
self.storage.push(ref: .null)
}
public func encode(_ value: Bool) throws {
assertCanEncodeNewValue()
self.storage.push(ref: .bool(value))
}
public func encode(_ value: Int) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: Int8) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: Int16) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: Int32) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: Int64) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public func encode(_ value: Int128) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: UInt) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: UInt8) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: UInt16) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: UInt32) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: UInt64) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
public func encode(_ value: UInt128) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: String) throws {
assertCanEncodeNewValue()
self.storage.push(ref: wrap(value))
}
public func encode(_ value: Float) throws {
assertCanEncodeNewValue()
let wrapped = try self.wrap(value, for: self.encoderCodingPathNode)
self.storage.push(ref: wrapped)
}
public func encode(_ value: Double) throws {
assertCanEncodeNewValue()
let wrapped = try self.wrap(value, for: self.encoderCodingPathNode)
self.storage.push(ref: wrapped)
}
public func encode<T : Encodable>(_ value: T) throws {
assertCanEncodeNewValue()
try self.storage.push(ref: self.wrap(value, for: self.encoderCodingPathNode))
}
}
// MARK: - Concrete Value Representations
private extension __JSONEncoder {
/// Returns the given value boxed in a container appropriate for pushing onto the container stack.
@inline(__always) func wrap(_ value: Bool) -> JSONReference { .bool(value) }
@inline(__always) func wrap(_ value: Int) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int8) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int16) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int32) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: Int64) -> JSONReference { .number(from: value) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
@inline(__always) func wrap(_ value: Int128) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt8) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt16) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt32) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: UInt64) -> JSONReference { .number(from: value) }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
@inline(__always) func wrap(_ value: UInt128) -> JSONReference { .number(from: value) }
@inline(__always) func wrap(_ value: String) -> JSONReference { .string(value) }
@inline(__always)
func wrap(_ float: Float, for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference {
try .number(from: float, with: self.options.nonConformingFloatEncodingStrategy, for: codingPathNode, additionalKey)
}
@inline(__always)
func wrap(_ double: Double, for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference {
try .number(from: double, with: self.options.nonConformingFloatEncodingStrategy, for: codingPathNode, additionalKey)
}
func wrap(_ date: Date, for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference {
switch self.options.dateEncodingStrategy {
case .deferredToDate:
// Dates encode as single-value objects; this can't both throw and push a container, so no need to catch the error.
try self.with(path: codingPathNode.appending(additionalKey)) {
try date.encode(to: self)
}
return self.storage.popReference()
case .secondsSince1970:
return try .number(from: date.timeIntervalSince1970, with: .throw, for: codingPathNode, additionalKey)
case .millisecondsSince1970:
return try .number(from: 1000.0 * date.timeIntervalSince1970, with: .throw, for: codingPathNode, additionalKey)
case .iso8601:
return self.wrap(date.formatted(.iso8601))
#if FOUNDATION_FRAMEWORK && !NO_FORMATTERS
case .formatted(let formatter):
return self.wrap(formatter.string(from: date))
#endif
case .custom(let closure):
let depth = self.storage.count
do {
try self.with(path: codingPathNode.appending(additionalKey)) {
try closure(date, self)
}
} catch {
// If the value pushed a container before throwing, pop it back off to restore state.
if self.storage.count > depth {
let _ = self.storage.popReference()
}
throw error
}
guard self.storage.count > depth else {
// The closure didn't encode anything. Return the default keyed container.
return .emptyObject
}
// We can pop because the closure encoded something.
return self.storage.popReference()
}
}
func wrap(_ data: Data, for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference {
switch self.options.dataEncodingStrategy {
case .deferredToData:
let depth = self.storage.count
do {
try self.with(path: codingPathNode.appending(additionalKey)) {
try data.encode(to: self)
}
} catch {
// If the value pushed a container before throwing, pop it back off to restore state.
// This shouldn't be possible for Data (which encodes as an array of bytes), but it can't hurt to catch a failure.
if self.storage.count > depth {
let _ = self.storage.popReference()
}
throw error
}
return self.storage.popReference()
case .base64:
return self.wrap(data.base64EncodedString())
case .custom(let closure):
let depth = self.storage.count
do {
try self.with(path: codingPathNode.appending(additionalKey)) {
try closure(data, self)
}
} catch {
// If the value pushed a container before throwing, pop it back off to restore state.
if self.storage.count > depth {
let _ = self.storage.popReference()
}
throw error
}
guard self.storage.count > depth else {
// The closure didn't encode anything. Return the default keyed container.
return .emptyObject
}
// We can pop because the closure encoded something.
return self.storage.popReference()
}
}
func wrap(_ dict: [String : Encodable], for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference? {
let depth = self.storage.count
let result = self.storage.pushKeyedContainer()
let rootPath = codingPathNode.appending(additionalKey)
do {
for (key, value) in dict {
result.insert(try wrap(value, for: rootPath, _CodingKey(stringValue: key)), for: key)
}
} catch {
// If the value pushed a container before throwing, pop it back off to restore state.
if self.storage.count > depth {
let _ = self.storage.popReference()
}
throw error
}
// The top container should be a new container.
guard self.storage.count > depth else {
return nil
}
return self.storage.popReference()
}
func wrap(_ value: Encodable, for codingPathNode: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference {
return try self.wrapGeneric(value, for: codingPathNode, additionalKey) ?? .emptyObject
}
func wrapGeneric<T: Encodable>(_ value: T, for node: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference? {
switch T.self {
case is Date.Type:
// Respect Date encoding strategy
return try self.wrap(value as! Date, for: node, additionalKey)
case is Data.Type:
// Respect Data encoding strategy
return try self.wrap(value as! Data, for: node, additionalKey)
case is URL.Type:
// Encode URLs as single strings.
let url = value as! URL
return self.wrap(url.absoluteString)
case is Decimal.Type:
let decimal = value as! Decimal
return .number(decimal.description)
case is _JSONStringDictionaryEncodableMarker.Type:
return try self.wrap(value as! [String : Encodable], for: node, additionalKey)
case is _JSONDirectArrayEncodable.Type:
let array = value as! _JSONDirectArrayEncodable
if options.outputFormatting.contains(.prettyPrinted) {
return .init(.directArray(array.individualElementRepresentation(options: options)))
} else {
return .init(.nonPrettyDirectArray(array.nonPrettyJSONRepresentation(options: options)))
}
default:
break
}
return try _wrapGeneric({
try value.encode(to: $0)
}, for: node, additionalKey)
}
func wrapGeneric<T: EncodableWithConfiguration>(_ value: T, configuration: T.EncodingConfiguration, for node: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference? {
try _wrapGeneric({
try value.encode(to: $0, configuration: configuration)
}, for: node, additionalKey)
}
func _wrapGeneric(_ encode: (__JSONEncoder) throws -> (), for node: _CodingPathNode, _ additionalKey: (some CodingKey)? = _CodingKey?.none) throws -> JSONReference? {
// The value should request a container from the __JSONEncoder.
let depth = self.storage.count
do {
try self.with(path: node.appending(additionalKey)) {
try encode(self)
}
} catch {
// If the value pushed a container before throwing, pop it back off to restore state.
if self.storage.count > depth {
let _ = self.storage.popReference()
}
throw error
}
// The top container should be a new container.
guard self.storage.count > depth else {
return nil
}
return self.storage.popReference()
}
}
// MARK: - __JSONReferencingEncoder
/// __JSONReferencingEncoder is a special subclass of __JSONEncoder which has its own storage, but references the contents of a different encoder.
/// It's used in superEncoder(), which returns a new encoder for encoding a superclass -- the lifetime of the encoder should not escape the scope it's created in, but it doesn't necessarily know when it's done being used (to write to the original container).
// NOTE: older overlays called this class _JSONReferencingEncoder.
// The two must coexist without a conflicting ObjC class name, so it
// was renamed. The old name must not be used in the new runtime.
private class __JSONReferencingEncoder : __JSONEncoder {
// MARK: Reference types.
/// The type of container we're referencing.
private enum Reference {
/// Referencing a specific index in an array container.
case array(JSONReference, Int)
/// Referencing a specific key in a dictionary container.
case dictionary(JSONReference, String)
}
// MARK: - Properties
/// The encoder we're referencing.
let encoder: __JSONEncoder
/// The container reference itself.
private let reference: Reference
// MARK: - Initialization
/// Initializes `self` by referencing the given array container in the given encoder.
init(referencing encoder: __JSONEncoder, at index: Int, codingPathNode: _CodingPathNode, wrapping ref: JSONReference) {
self.encoder = encoder
self.reference = .array(ref, index)
super.init(options: encoder.options, codingPathNode: codingPathNode.appending(_CodingKey(index: index)), initialDepth: codingPathNode.depth)
}
/// Initializes `self` by referencing the given dictionary container in the given encoder.
init(referencing encoder: __JSONEncoder, key: CodingKey, convertedKey: String, codingPathNode: _CodingPathNode, wrapping dictionary: JSONReference) {
self.encoder = encoder
self.reference = .dictionary(dictionary, convertedKey)
super.init(options: encoder.options, codingPathNode: codingPathNode.appending(key), initialDepth: codingPathNode.depth)
}
// MARK: - Coding Path Operations
override var canEncodeNewValue: Bool {
// With a regular encoder, the storage and coding path grow together.
// A referencing encoder, however, inherits its parents coding path, as well as the key it was created for.
// We have to take this into account.
return self.storage.count == self.codingPath.count - self.encoder.codingPath.count - 1
}
// MARK: - Deinitialization
// Finalizes `self` by writing the contents of our storage to the referenced encoder's storage.
deinit {
let ref: JSONReference
switch self.storage.count {
case 0: ref = .emptyObject
case 1: ref = self.storage.popReference()
default: fatalError("Referencing encoder deallocated with multiple containers on stack.")
}
switch self.reference {
case .array(let arrayRef, let index):
arrayRef.insert(ref, at: index)
case .dictionary(let dictionaryRef, let key):
dictionaryRef.insert(ref, for: key)
}
}
}
//===----------------------------------------------------------------------===//
// Error Utilities
//===----------------------------------------------------------------------===//
extension EncodingError {
/// Returns a `.invalidValue` error describing the given invalid floating-point value.
///
///
/// - parameter value: The value that was invalid to encode.
/// - parameter path: The path of `CodingKey`s taken to encode this value.
/// - returns: An `EncodingError` with the appropriate path and debug description.
fileprivate static func _invalidFloatingPointValue<T : FloatingPoint>(_ value: T, at codingPath: [CodingKey]) -> EncodingError {
let valueDescription: String
if value == T.infinity {
valueDescription = "\(T.self).infinity"
} else if value == -T.infinity {
valueDescription = "-\(T.self).infinity"
} else {
valueDescription = "\(T.self).nan"
}
let debugDescription = "Unable to encode \(valueDescription) directly in JSON. Use JSONEncoder.NonConformingFloatEncodingStrategy.convertToString to specify how the value should be encoded."
return .invalidValue(value, EncodingError.Context(codingPath: codingPath, debugDescription: debugDescription))
}
}
@available(macOS 13.0, iOS 16.0, tvOS 16.0, watchOS 9.0, *)
extension JSONEncoder : @unchecked Sendable {}
//===----------------------------------------------------------------------===//
// Special-casing Support
//===----------------------------------------------------------------------===//
/// A marker protocol used to determine whether a value is a `String`-keyed `Dictionary`
/// containing `Encodable` values (in which case it should be exempt from key conversion strategies).
private protocol _JSONStringDictionaryEncodableMarker { }
extension Dictionary : _JSONStringDictionaryEncodableMarker where Key == String, Value: Encodable { }
/// A protocol used to determine whether a value is an `Array` containing values that allow
/// us to bypass UnkeyedEncodingContainer overhead by directly encoding the contents as
/// strings as passing that down to the JSONWriter.
fileprivate protocol _JSONDirectArrayEncodable {
func nonPrettyJSONRepresentation(options: JSONEncoder._Options) -> String
func individualElementRepresentation(options: JSONEncoder._Options) -> [String]
}
fileprivate protocol _JSONSimpleValueArrayElement: CustomStringConvertible {
func jsonRepresentation(options: JSONEncoder._Options) -> String
}
extension _JSONSimpleValueArrayElement where Self: FixedWidthInteger {
fileprivate func jsonRepresentation(options: JSONEncoder._Options) -> String { description }
}
extension Int : _JSONSimpleValueArrayElement { }
extension Int8 : _JSONSimpleValueArrayElement { }
extension Int16 : _JSONSimpleValueArrayElement { }
extension Int32 : _JSONSimpleValueArrayElement { }
extension Int64 : _JSONSimpleValueArrayElement { }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension Int128 : _JSONSimpleValueArrayElement { }
extension UInt : _JSONSimpleValueArrayElement { }
extension UInt8 : _JSONSimpleValueArrayElement { }
extension UInt16 : _JSONSimpleValueArrayElement { }
extension UInt32 : _JSONSimpleValueArrayElement { }
extension UInt64 : _JSONSimpleValueArrayElement { }
@available(macOS 15.0, iOS 18.0, tvOS 18.0, watchOS 11.0, visionOS 2.0, *)
extension UInt128 : _JSONSimpleValueArrayElement { }
extension String: _JSONSimpleValueArrayElement {
fileprivate func jsonRepresentation(options: JSONEncoder._Options) -> String {
self.serializedForJSON(withoutEscapingSlashes: options.outputFormatting.contains(.withoutEscapingSlashes))
}
}
// This is not yet extended to Double & Float. That case is more complicated, given the possibility of Infinity or NaN values, which require nonConformingFloatEncodingStrategy and the ability to throw errors.
extension Array : _JSONDirectArrayEncodable where Element: _JSONSimpleValueArrayElement {
func nonPrettyJSONRepresentation(options: JSONEncoder._Options) -> String {
var result = "["
result.reserveCapacity(self.count * 2 + 1) // Reserve enough for a minimum of one character per number, each comma required, and the braces
for element in self {
result += element.jsonRepresentation(options: options) + ","
}
if !self.isEmpty {
// Replace the last ,
let _ = result.popLast()
}
result += "]"
return result
}
func individualElementRepresentation(options: JSONEncoder._Options) -> [String] {
var result = [String]()
result.reserveCapacity(self.count)
for element in self {
result.append(element.jsonRepresentation(options: options))
}
return result
}
}
|