-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathDebugSnapshotMacro.swift
More file actions
1436 lines (1330 loc) · 47.1 KB
/
Copy pathDebugSnapshotMacro.swift
File metadata and controls
1436 lines (1330 loc) · 47.1 KB
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
import SwiftDiagnostics
public import SwiftSyntax
import SwiftSyntaxBuilder
public import SwiftSyntaxMacros
public enum DebugSnapshotAttribute {
case convertible, ignored, tracked
}
public enum DebugSnapshotMacro {}
extension DebugSnapshotMacro: ExtensionMacro {
public static func expansion(
of node: AttributeSyntax,
attachedTo declaration: some DeclGroupSyntax,
providingExtensionsOf type: some TypeSyntaxProtocol,
conformingTo protocols: [TypeSyntax],
in context: some MacroExpansionContext
) throws -> [ExtensionDeclSyntax] {
guard !hasDebugSnapshotConvertibleConformance(declaration) else {
return []
}
let conformanceIsolation: String
#if compiler(>=6.2)
conformanceIsolation = hasMainActorAnnotation(declaration) ? "@MainActor " : ""
#else
conformanceIsolation = ""
#endif
return [
DeclSyntax(
"""
extension \(type.trimmed): \
\(raw: conformanceIsolation)\(raw: moduleName).DebugSnapshotConvertible {}
"""
)
.cast(ExtensionDeclSyntax.self)
]
}
}
extension DebugSnapshotMacro: MemberAttributeMacro {
public static func expansion(
of node: AttributeSyntax,
attachedTo declaration: some DeclGroupSyntax,
providingAttributesFor member: some DeclSyntaxProtocol,
in context: some MacroExpansionContext
) throws -> [AttributeSyntax] {
return try expansion(
of: node,
attachedTo: declaration,
providingAttributesFor: member,
in: context,
debugSnapshotAttribute: { _ in nil }
)
}
public static func expansion(
of node: AttributeSyntax,
attachedTo declaration: some DeclGroupSyntax,
providingAttributesFor member: some DeclSyntaxProtocol,
in context: some MacroExpansionContext,
debugSnapshotAttribute: (DeclSyntax) -> DebugSnapshotAttribute?
) throws -> [AttributeSyntax] {
let logChanges = hasLogChangesOption(node)
if logChanges,
let funcDecl = member.as(FunctionDeclSyntax.self),
!funcDecl.modifiers.contains(where: {
$0.name.tokenKind == .keyword(.static) || $0.name.tokenKind == .keyword(.class)
}),
!funcDecl.hasAttribute(in: \.attributes, equivalentTo: "@LogChanges"),
!funcDecl.hasAttribute(in: \.attributes, equivalentTo: "@LogChangesIgnored")
{
if hasMainActorAnnotation(declaration) && funcDecl.isNonisolated {
return ["@LogChangesIgnored"]
}
return ["@LogChanges"]
}
let requiredAccess = effectiveAccessLevel(for: declaration, in: context)
if let variable = member.as(VariableDeclSyntax.self),
variable.bindings.count == 1,
!variable.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotIgnored"),
!variable.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotTracked"),
!variable.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotConvertible")
{
let attribute: DebugSnapshotAttribute
if let override = debugSnapshotAttribute(DeclSyntax(variable)) {
attribute = override
} else if let binding = variable.bindings.first,
isTrackedByDefault(variable, binding: binding, requiredAccess: requiredAccess)
{
attribute = .tracked
} else {
attribute = .ignored
}
var attributes: [AttributeSyntax] = []
switch attribute {
case .convertible:
variable.addIfNeeded("@DebugSnapshotConvertible", in: \.attributes, to: &attributes)
case .tracked:
variable.addIfNeeded("@DebugSnapshotTracked", in: \.attributes, to: &attributes)
case .ignored:
variable.addIfNeeded("@DebugSnapshotIgnored", in: \.attributes, to: &attributes)
}
return attributes
}
if let enumCase = member.as(EnumCaseDeclSyntax.self),
!enumCase.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotIgnored"),
!enumCase.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotTracked"),
!enumCase.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotConvertible")
{
let attribute: DebugSnapshotAttribute
if let override = debugSnapshotAttribute(DeclSyntax(enumCase)) {
attribute = override
} else if enumCase.elements.allSatisfy(isEnumElementTrackedByDefault) {
attribute = .tracked
} else {
attribute = .ignored
}
var attributes: [AttributeSyntax] = []
switch attribute {
case .convertible:
enumCase.addIfNeeded("@DebugSnapshotConvertible", in: \.attributes, to: &attributes)
case .tracked:
enumCase.addIfNeeded("@DebugSnapshotTracked", in: \.attributes, to: &attributes)
case .ignored:
enumCase.addIfNeeded("@DebugSnapshotIgnored", in: \.attributes, to: &attributes)
}
return attributes
}
return []
}
}
extension DebugSnapshotMacro: MemberMacro {
public static func expansion(
of node: AttributeSyntax,
providingMembersOf declaration: some DeclGroupSyntax,
conformingTo protocols: [TypeSyntax],
in context: some MacroExpansionContext
) throws -> [DeclSyntax] {
try expansion(
of: node,
providingMembersOf: declaration,
conformingTo: protocols,
in: context,
attributeConformanceMapping: [:],
filterPropagatedAttributes: { _ in [] },
debugSnapshotAttribute: { _ in nil }
)
}
public static func expansion(
of node: AttributeSyntax,
providingMembersOf declaration: some DeclGroupSyntax,
conformingTo protocols: [TypeSyntax],
in context: some MacroExpansionContext,
attributeConformanceMapping: [String: [String]] = [:],
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
debugSnapshotAttribute: (DeclSyntax) -> DebugSnapshotAttribute?
) throws -> [DeclSyntax] {
guard
let modelDecl = ModelDecl(
declaration: declaration,
context: context,
debugSnapshotAttribute: debugSnapshotAttribute
)
else {
return []
}
return memberDeclarations(
for: modelDecl,
declaration: declaration,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
}
}
private func memberDeclarations(
for modelDecl: ModelDecl,
declaration: some DeclGroupSyntax,
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
attributeConformanceMapping: [String: [String]]
) -> [DeclSyntax] {
switch modelDecl.kind {
case .classOrStruct(let properties, let isClass):
return classOrStructMemberDeclarations(
for: modelDecl,
declaration: declaration,
properties: properties,
isClass: isClass,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
case .enumeration(let enumCases):
return enumMemberDeclarations(
name: modelDecl.name,
declaration: declaration,
enumCases: enumCases,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
}
}
private func classOrStructMemberDeclarations(
for modelDecl: ModelDecl,
declaration: some DeclGroupSyntax,
properties: [ModelDecl.Property],
isClass: Bool,
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
attributeConformanceMapping: [String: [String]]
) -> [DeclSyntax] {
if isClass {
return classMemberDeclarations(
for: modelDecl,
declaration: declaration,
properties: properties,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
} else {
return structMemberDeclarations(
for: modelDecl,
declaration: declaration,
properties: properties,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
}
}
private func structMemberDeclarations(
for modelDecl: ModelDecl,
declaration: some DeclGroupSyntax,
properties: [ModelDecl.Property],
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
attributeConformanceMapping: [String: [String]]
) -> [DeclSyntax] {
let propagatedAttributes = propagatedAttributesOutput(
from: declaration,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
let debugSnapshotConformances = deduplicatedConformances(
debugSnapshotConformances(
for: declaration,
properties: properties
) + propagatedAttributes.conformances
)
let propertyLines = snapshotPropertyLines(for: properties, modelName: modelDecl.name)
let hasIndirectProperties = properties.contains(where: \.isDebugSnapshotConvertible)
var allConformances = debugSnapshotConformances
if hasIndirectProperties {
allConformances.append("CustomReflectable")
}
allConformances.append("\(moduleName).DebugSnapshotConvertible")
let conformancesDescription =
snapshotConformanceDescription(allConformances)
let customMirrorDecl: String
if hasIndirectProperties {
let mirrorChildren =
properties
.map { "\"\($0.name)\": \($0.name) as Any" }
.joined(separator: ", ")
customMirrorDecl = """
\npublic var customMirror: Mirror {
Mirror(self, children: [\(mirrorChildren)], displayStyle: .struct)
}
"""
} else {
customMirrorDecl = ""
}
let convertibleSnapshotAssignments =
properties
.filter { $0.isDebugSnapshotConvertible }
.map {
"snapshot.\($0.name) = \(moduleName)._debugSnapshot(value.\($0.name), visitor: &visitor)"
}
let snapshotBody =
convertibleSnapshotAssignments.isEmpty
? "value"
: "var snapshot = value\n\(convertibleSnapshotAssignments.joined(separator: "\n"))\nreturn snapshot"
let representation =
DeclSyntax(
"""
\(raw: propagatedAttributes.description)\
public struct DebugSnapshot\(raw: conformancesDescription) {
\(raw: propertyLines.joined(separator: "\n"))\(raw: customMirrorDecl)
public static func _debugSnapshot(\
_ value: DebugSnapshot, \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
\(raw: snapshotBody)
}
}
"""
)
let visitorInitArguments =
properties
.map {
"\($0.name): \($0.isDebugSnapshotConvertible ? "\(moduleName)._debugSnapshot(value.\($0.name), visitor: &visitor)" : "value.\($0.name)")"
}
.joined(separator: ", ")
let _debugSnapshot =
DeclSyntax(
"""
public static func _debugSnapshot(\
_ value: \(raw: modelDecl.name), \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
DebugSnapshot(\(raw: visitorInitArguments))
}
"""
)
return [representation, _debugSnapshot]
}
private func classMemberDeclarations(
for modelDecl: ModelDecl,
declaration: some DeclGroupSyntax,
properties: [ModelDecl.Property],
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
attributeConformanceMapping: [String: [String]]
) -> [DeclSyntax] {
let propagatedAttributes = propagatedAttributesOutput(
from: declaration,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
let snapshotConformances = deduplicatedConformances(
debugSnapshotConformances(
for: declaration,
properties: properties
) + propagatedAttributes.conformances
)
let snapshotConformancesDescription =
snapshotConformances.isEmpty
? ""
: ": \(snapshotConformances.joined(separator: ", "))"
let propertyLines = snapshotPropertyLines(
for: properties,
modelName: modelDecl.name,
snapshotTypeName: "DebugSnapshot",
applyIndirection: false
)
let snapshotStruct =
DeclSyntax(
"""
\(raw: propagatedAttributes.description)\
public struct DebugSnapshotValue\(raw: snapshotConformancesDescription) {
\(raw: propertyLines.joined(separator: "\n"))
}
"""
)
let initParams = classInitParams(for: properties, modelName: modelDecl.name)
let snapshotInitArguments = properties.map { "\($0.name): \($0.name)" }.joined(separator: ", ")
let convertibleSnapshotAssignments =
properties
.filter { $0.isDebugSnapshotConvertible }
.map {
"snapshot.\($0.name) = \(moduleName)._debugSnapshot(value.\($0.name), visitor: &visitor)"
}
let convertibleSnapshotAssignmentsCode =
convertibleSnapshotAssignments.isEmpty
? ""
: "\n" + convertibleSnapshotAssignments.joined(separator: "\n")
let nonConvertibleInitArguments =
properties
.filter { !$0.isDebugSnapshotConvertible }
.map { "\($0.name): value.\($0.name)" }
.joined(separator: ", ")
let debugSnapshotClass =
DeclSyntax(
"""
public final class DebugSnapshot: \
\(raw: moduleName)._DebugSnapshotObject, \(raw: moduleName).DebugSnapshotConvertible {
public var _snapshot: DebugSnapshotValue
public var _originIdentifier: ObjectIdentifier?
public var _diffSnapshot: (any \(raw: moduleName)._DebugSnapshotObject)?
public init(\(raw: initParams)) {
self._snapshot = DebugSnapshotValue(\(raw: snapshotInitArguments))
}
public static func _debugSnapshot(\
_ value: DebugSnapshot, \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
if let existing: DebugSnapshot = visitor.lookup(value) { return existing }
let snapshot = DebugSnapshot(\(raw: nonConvertibleInitArguments))
snapshot._originIdentifier = value._originIdentifier
visitor.register(value, snapshot: snapshot)\(raw: convertibleSnapshotAssignmentsCode)
return snapshot
}
}
"""
)
let convertibleAssignments =
properties
.filter { $0.isDebugSnapshotConvertible }
.map {
"snapshot.\($0.name) = \(moduleName)._debugSnapshot(value.\($0.name), visitor: &visitor)"
}
let convertibleAssignmentsCode =
convertibleAssignments.isEmpty
? ""
: "\n" + convertibleAssignments.joined(separator: "\n")
let _debugSnapshotMethod =
DeclSyntax(
"""
public static func _debugSnapshot(\
_ value: \(raw: modelDecl.name), \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
if let existing: DebugSnapshot = visitor.lookup(value) { return existing }
let snapshot = DebugSnapshot(\(raw: nonConvertibleInitArguments))
snapshot._originIdentifier = ObjectIdentifier(value)
visitor.register(value, snapshot: snapshot)\(raw: convertibleAssignmentsCode)
return snapshot
}
"""
)
return [snapshotStruct, debugSnapshotClass, _debugSnapshotMethod]
}
private func snapshotPropertyLines(
for properties: [ModelDecl.Property],
modelName: String,
snapshotTypeName: String = "DebugSnapshot",
applyIndirection: Bool = true
) -> [String] {
properties.map { property in
let indirectPrefix =
applyIndirection && property.isDebugSnapshotConvertible
? "@\(moduleName)._Indirect "
: ""
switch property.kind {
case .type(let type):
let typeDescription = type.trimmedDescription
let snapshotType =
property.isDebugSnapshotConvertible
? snapshotTypeDescription(for: typeDescription, snapshotTypeName: snapshotTypeName)
: typeDescription
return "\(indirectPrefix)public var \(property.name): \(snapshotType)"
case .initializer(let defaultValue):
let defaultValue = rewriteDefaultValue(defaultValue, modelTypeName: modelName)
.trimmedDescription
if property.isDebugSnapshotConvertible {
return "\(indirectPrefix)public var \(property.name) = \(moduleName).snap(\(defaultValue))"
} else {
return "public var \(property.name) = \(defaultValue)"
}
case .pair(let type, initializer: let defaultValue):
let typeDescription = type.trimmedDescription
let snapshotType =
property.isDebugSnapshotConvertible
? snapshotTypeDescription(for: typeDescription, snapshotTypeName: snapshotTypeName)
: typeDescription
let rewrittenDefault = rewriteDefaultValue(defaultValue, modelTypeName: modelName)
if property.isDebugSnapshotConvertible {
let snapshotDefault = convertibleSnapshotDefault(for: type, defaultValue: rewrittenDefault)
return "\(indirectPrefix)public var \(property.name): \(snapshotType) = \(snapshotDefault)"
} else {
return """
public var \(property.name): \(typeDescription) = \(rewrittenDefault.trimmedDescription)
"""
}
}
}
}
private func classInitParams(
for properties: [ModelDecl.Property],
modelName: String
) -> String {
properties.map { property in
let (type, defaultValue) = classInitParamTypeAndDefault(for: property, modelName: modelName)
let defaultSuffix = defaultValue.map { " = \($0)" } ?? ""
return "\(property.name): \(type)\(defaultSuffix)"
}
.joined(separator: ", ")
}
private func classInitParamTypeAndDefault(
for property: ModelDecl.Property,
modelName: String
) -> (type: String, default: String?) {
switch property.kind {
case .type(let type):
let typeDescription = type.trimmedDescription
let snapshotType =
property.isDebugSnapshotConvertible
? snapshotTypeDescription(for: typeDescription, snapshotTypeName: "DebugSnapshot")
: typeDescription
let defaultValue: String? = isOptionalType(type) ? "nil" : nil
return (snapshotType, defaultValue)
case .initializer(let defaultValue):
let rewrittenDefault = rewriteDefaultValue(defaultValue, modelTypeName: modelName)
.trimmedDescription
return (inferredLiteralType(of: defaultValue) ?? "_", rewrittenDefault)
case .pair(let type, initializer: let defaultValue):
let typeDescription = type.trimmedDescription
let snapshotType =
property.isDebugSnapshotConvertible
? snapshotTypeDescription(for: typeDescription, snapshotTypeName: "DebugSnapshot")
: typeDescription
let rewrittenDefault = rewriteDefaultValue(defaultValue, modelTypeName: modelName)
if property.isDebugSnapshotConvertible {
return (snapshotType, convertibleSnapshotDefault(for: type, defaultValue: rewrittenDefault))
} else {
return (snapshotType, rewrittenDefault.trimmedDescription)
}
}
}
private func isOptionalType(_ type: TypeSyntax) -> Bool {
type.is(OptionalTypeSyntax.self) || type.is(ImplicitlyUnwrappedOptionalTypeSyntax.self)
}
private func diagnoseMissingTypeAnnotation(
on binding: PatternBindingSyntax,
in context: some MacroExpansionContext
) {
var fixed = binding
fixed.pattern = binding.pattern.with(\.trailingTrivia, [])
fixed.typeAnnotation = TypeAnnotationSyntax(
colon: .colonToken(trailingTrivia: .space),
type: TypeSyntax(IdentifierTypeSyntax(name: .identifier("<#Type#>")))
)
if let initializer = binding.initializer {
fixed.initializer = initializer.with(\.equal, initializer.equal.with(\.leadingTrivia, .space))
}
context.diagnose(
Diagnostic(
node: Syntax(binding),
message: MacroExpansionErrorMessage("Missing required type annotation"),
fixIt: FixIt(
message: MacroExpansionFixItMessage("Insert ': <#Type#>'"),
changes: [.replace(oldNode: Syntax(binding), newNode: Syntax(fixed))]
)
)
)
}
private func inferredLiteralType(of expression: ExprSyntax) -> String? {
if let prefix = expression.as(PrefixOperatorExprSyntax.self),
prefix.operator.text == "-" || prefix.operator.text == "+"
{
return inferredLiteralType(of: prefix.expression)
}
if expression.is(IntegerLiteralExprSyntax.self) { return "Int" }
if expression.is(FloatLiteralExprSyntax.self) { return "Double" }
if expression.is(StringLiteralExprSyntax.self) { return "String" }
if expression.is(BooleanLiteralExprSyntax.self) { return "Bool" }
return nil
}
private func convertibleSnapshotDefault(
for type: TypeSyntax,
defaultValue: ExprSyntax
) -> String {
if isOptionalType(type), defaultValue.is(NilLiteralExprSyntax.self) {
return "nil"
}
return "\(moduleName).snap(\(defaultValue.trimmedDescription) as \(type.trimmedDescription))"
}
private func enumMemberDeclarations(
name: String,
declaration: some DeclGroupSyntax,
enumCases: [ModelDecl.EnumCase],
filterPropagatedAttributes: (AttributeListSyntax) -> AttributeListSyntax,
attributeConformanceMapping: [String: [String]]
) -> [DeclSyntax] {
let propagatedAttributes = propagatedAttributesOutput(
from: declaration,
filterPropagatedAttributes: filterPropagatedAttributes,
attributeConformanceMapping: attributeConformanceMapping
)
let isIndirect =
modifiers(of: declaration).contains { $0.name.tokenKind == .keyword(.indirect) }
let debugSnapshotConformances = deduplicatedConformances(
debugSnapshotConformances(
for: declaration,
properties: []
) + propagatedAttributes.conformances + ["\(moduleName).DebugSnapshotConvertible"]
)
let conformanceDescription =
snapshotConformanceDescription(debugSnapshotConformances)
let snapshotCaseLines = enumCases.map { debugSnapshotCaseDeclaration($0, modelName: name) }
let snapshotSwitchCases = enumCases.map(snapshotSwitchCase)
let representation =
DeclSyntax(
"""
\(raw: propagatedAttributes.description)\
public \(raw: isIndirect ? "indirect " : "")enum DebugSnapshot\(raw: conformanceDescription) {
\(raw: snapshotCaseLines.joined(separator: "\n"))
public static func _debugSnapshot(\
_ value: DebugSnapshot, \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
switch value {
\(raw: snapshotSwitchCases.joined(separator: "\n"))
}
}
}
"""
)
let switchCases = enumCases.map(debugSnapshotSwitchCase)
let _debugSnapshot =
DeclSyntax(
"""
public static func _debugSnapshot(\
_ value: \(raw: name), \
visitor: inout \(raw: moduleName)._DebugSnapshotVisitor\
) -> DebugSnapshot {
switch value {
\(raw: switchCases.joined(separator: "\n"))
}
}
"""
)
return [representation, _debugSnapshot]
}
private func debugSnapshotCaseDeclaration(
_ enumCase: ModelDecl.EnumCase,
modelName: String
) -> String {
let name = enumCase.element.name.text
let indirectPrefix = enumCase.isIndirect ? "indirect " : ""
guard !enumCase.isIgnored else {
return "\(indirectPrefix)case \(name)"
}
guard var parameterClause = enumCase.element.parameterClause else {
return "\(indirectPrefix)case \(name)"
}
for index in parameterClause.parameters.indices {
let originalType = parameterClause.parameters[index].type
if enumCase.isDebugSnapshotConvertible {
parameterClause.parameters[index].type = debugSnapshotType(originalType)
}
if let defaultValue = parameterClause.parameters[index].defaultValue {
let selfRewritten = rewriteDefaultValue(defaultValue.value, modelTypeName: modelName)
let snapshotValue =
enumCase.isDebugSnapshotConvertible
? ExprSyntax(
"\(raw: convertibleSnapshotDefault(for: originalType, defaultValue: selfRewritten))"
)
: selfRewritten
parameterClause.parameters[index].defaultValue = defaultValue.with(\.value, snapshotValue)
}
}
return "\(indirectPrefix)case \(name)\(parameterClause.trimmedDescription)"
}
private func debugSnapshotSwitchCase(_ enumCase: ModelDecl.EnumCase) -> String {
let name = enumCase.element.name.text
let parameters = Array(enumCase.element.parameterClause?.parameters ?? [])
let bindings = parameters.indices.map { "v\($0 + 1)" }
let pattern =
if bindings.isEmpty {
".\(name)"
} else {
".\(name)(\(bindings.map { "let \($0)" }.joined(separator: ", ")))"
}
if enumCase.isIgnored {
return """
case .\(name):
return .\(name)
"""
}
if bindings.isEmpty {
return """
case \(pattern):
return .\(name)
"""
}
let valueArguments = zip(parameters, bindings)
.map { parameter, binding in
let mappedValue =
enumCase.isDebugSnapshotConvertible
? "\(moduleName)._debugSnapshot(\(binding), visitor: &visitor)"
: binding
return "\(caseParameterLabelPrefix(parameter))\(mappedValue)"
}
.joined(separator: ", ")
return """
case \(pattern):
return .\(name)(\(valueArguments))
"""
}
private func snapshotSwitchCase(_ enumCase: ModelDecl.EnumCase) -> String {
let name = enumCase.element.name.text
let parameters = Array(enumCase.element.parameterClause?.parameters ?? [])
let bindings = parameters.indices.map { "v\($0 + 1)" }
if enumCase.isIgnored || bindings.isEmpty {
return """
case .\(name):
return .\(name)
"""
}
let pattern = ".\(name)(\(bindings.map { "let \($0)" }.joined(separator: ", ")))"
let valueArguments = zip(parameters, bindings)
.map { parameter, binding in
let mappedValue =
enumCase.isDebugSnapshotConvertible
? "\(moduleName)._debugSnapshot(\(binding), visitor: &visitor)"
: binding
return "\(caseParameterLabelPrefix(parameter))\(mappedValue)"
}
.joined(separator: ", ")
return """
case \(pattern):
return .\(name)(\(valueArguments))
"""
}
private func debugSnapshotType(_ type: TypeSyntax) -> TypeSyntax {
if let optionalType = type.trimmed.as(OptionalTypeSyntax.self) {
return TypeSyntax(
OptionalTypeSyntax(
wrappedType: debugSnapshotType(optionalType.wrappedType),
questionMark: optionalType.questionMark
)
)
}
if let implicitlyUnwrappedOptionalType = type.trimmed.as(
ImplicitlyUnwrappedOptionalTypeSyntax.self
) {
return TypeSyntax(
ImplicitlyUnwrappedOptionalTypeSyntax(
wrappedType: debugSnapshotType(implicitlyUnwrappedOptionalType.wrappedType),
exclamationMark: implicitlyUnwrappedOptionalType.exclamationMark
)
)
}
if let arrayType = type.trimmed.as(ArrayTypeSyntax.self) {
return TypeSyntax(arrayType.with(\.element, debugSnapshotType(arrayType.element)))
}
if let dictionaryType = type.trimmed.as(DictionaryTypeSyntax.self) {
return TypeSyntax(dictionaryType.with(\.value, debugSnapshotType(dictionaryType.value)))
}
return TypeSyntax(MemberTypeSyntax(baseType: type.trimmed, name: .identifier("DebugSnapshot")))
}
private func snapshotTypeDescription(
for type: String,
snapshotTypeName: String = "DebugSnapshot"
) -> String {
var base = type
var optionalSuffix = ""
while let last = base.last, last == "?" || last == "!" {
optionalSuffix.insert(last, at: optionalSuffix.startIndex)
base.removeLast()
}
if base.hasPrefix("["), base.hasSuffix("]") {
let element = String(base.dropFirst().dropLast())
return "[\(element).\(snapshotTypeName)]\(optionalSuffix)"
}
return "\(base).\(snapshotTypeName)\(optionalSuffix)"
}
private func caseParameterLabelPrefix(_ parameter: EnumCaseParameterSyntax) -> String {
guard
let label = parameter.firstName,
label.tokenKind != .wildcard
else { return "" }
return "\(label.text): "
}
private struct ModelDecl {
struct Property {
var name: String
var kind: Kind
var isDebugSnapshotConvertible: Bool
enum Kind {
case type(TypeSyntax)
case initializer(ExprSyntax)
case pair(type: TypeSyntax, initializer: ExprSyntax)
}
}
struct EnumCase {
var element: EnumCaseElementSyntax
var isDebugSnapshotConvertible: Bool
var isIgnored: Bool
var isIndirect: Bool
}
enum Kind {
case classOrStruct([Property], isClass: Bool)
case enumeration([EnumCase])
}
var name: String
var kind: Kind
init?(
declaration: some DeclGroupSyntax,
context: some MacroExpansionContext,
debugSnapshotAttribute: (DeclSyntax) -> DebugSnapshotAttribute?
) {
if let classDecl = declaration.as(ClassDeclSyntax.self) {
let requiredAccess = effectiveAccessLevel(for: declaration, in: context)
self.name = classDecl.name.text
self.kind = .classOrStruct(
Self.storedProperties(
from: declaration,
context: context,
requiredAccess: requiredAccess,
isClass: true,
debugSnapshotAttribute: debugSnapshotAttribute
),
isClass: true
)
return
} else if let structDecl = declaration.as(StructDeclSyntax.self) {
let requiredAccess = effectiveAccessLevel(for: declaration, in: context)
self.name = structDecl.name.text
self.kind = .classOrStruct(
Self.storedProperties(
from: declaration,
context: context,
requiredAccess: requiredAccess,
isClass: false,
debugSnapshotAttribute: debugSnapshotAttribute
),
isClass: false
)
return
} else if let name = declaration.as(EnumDeclSyntax.self)?.name {
self.name = name.text
self.kind = .enumeration(
Self.enumCases(
from: declaration,
context: context,
debugSnapshotAttribute: debugSnapshotAttribute
)
)
return
} else {
context.diagnose(
Diagnostic(
node: Syntax(declaration),
message: MacroExpansionErrorMessage(
"'@DebugSnapshot' can only be applied to classes, structs, and enums"
)
)
)
return nil
}
}
static func storedProperties(
from declaration: some DeclGroupSyntax,
context: some MacroExpansionContext,
requiredAccess: AccessLevel,
isClass: Bool,
debugSnapshotAttribute: (DeclSyntax) -> DebugSnapshotAttribute?
) -> [ModelDecl.Property] {
declaration.memberBlock.members.compactMap { member -> [ModelDecl.Property]? in
guard
let variable = member.decl.as(VariableDeclSyntax.self),
modifiers(of: variable).contains(where: {
$0.name.tokenKind == .keyword(.static) || $0.name.tokenKind == .keyword(.class)
}) != true,
!variable.hasAttribute(in: \.attributes, equivalentTo: "@DebugSnapshotIgnored")
else { return nil }
let isDebugSnapshotTracked = variable.hasAttribute(
in: \.attributes,
equivalentTo: "@DebugSnapshotTracked"
)
let hasDebugSnapshotConvertibleAttribute = variable.hasAttribute(
in: \.attributes,
equivalentTo: "@DebugSnapshotConvertible"
)
guard
accessControl(for: variable).effectiveAccessLevel >= requiredAccess
|| isDebugSnapshotTracked
|| hasDebugSnapshotConvertibleAttribute
else { return nil }
if variable.attributes.hasIgnoredPropertyWrapper,
!isDebugSnapshotTracked,
!hasDebugSnapshotConvertibleAttribute
{
return nil
}
return variable.bindings.compactMap { binding in
guard
let identifier = binding.pattern.as(IdentifierPatternSyntax.self)?.identifier.text,
!identifier.hasPrefix("_")
else { return nil }
guard
isStoredProperty(binding)
|| isDebugSnapshotTracked
|| hasDebugSnapshotConvertibleAttribute
else {
return nil
}
let typeAnnotation = binding.typeAnnotation?.type
let defaultValue = binding.initializer?.value
let attribute = debugSnapshotAttribute(DeclSyntax(variable))
guard attribute != .ignored else { return nil }
let isDebugSnapshotConvertible =
hasDebugSnapshotConvertibleAttribute
|| attribute == .convertible
switch (typeAnnotation, defaultValue) {
case (nil, nil):
diagnoseMissingTypeAnnotation(on: binding, in: context)
return nil
case (nil, let defaultValue?):
guard !isClosureInitializer(defaultValue)
else { return nil }
var canInferInitParameterType: Bool {
!isDebugSnapshotConvertible && inferredLiteralType(of: defaultValue) != nil
}
if isClass, !canInferInitParameterType {
diagnoseMissingTypeAnnotation(on: binding, in: context)
return nil
}
return ModelDecl.Property(
name: identifier,
kind: .initializer(defaultValue),
isDebugSnapshotConvertible: isDebugSnapshotConvertible
)
case (let typeAnnotation?, nil):
guard !isClosureType(typeAnnotation)
else { return nil }
return ModelDecl.Property(
name: identifier,
kind: .type(typeAnnotation),
isDebugSnapshotConvertible: isDebugSnapshotConvertible
)
case (let typeAnnotation?, let defaultValue?):
guard
!isClosureType(typeAnnotation),
!isClosureInitializer(defaultValue) || isDebugSnapshotConvertible
else { return nil }
return ModelDecl.Property(
name: identifier,
kind: .pair(
type: typeAnnotation,
initializer: defaultValue
),
isDebugSnapshotConvertible: isDebugSnapshotConvertible
)
}
}
}
.flatMap(\.self)
}
static func enumCases(
from declaration: some DeclGroupSyntax,
context: some MacroExpansionContext,
debugSnapshotAttribute: (DeclSyntax) -> DebugSnapshotAttribute?
) -> [ModelDecl.EnumCase] {
declaration.memberBlock.members.compactMap { member -> [ModelDecl.EnumCase]? in
guard let enumCase = member.decl.as(EnumCaseDeclSyntax.self)
else { return nil }
let isExplicitlyIgnored = enumCase.hasAttribute(
in: \.attributes,
equivalentTo: "@DebugSnapshotIgnored"
)
let isExplicitlyTracked = enumCase.hasAttribute(
in: \.attributes,
equivalentTo: "@DebugSnapshotTracked"
)
let hasDebugSnapshotConvertibleAttribute = enumCase.hasAttribute(