-
Notifications
You must be signed in to change notification settings - Fork 10.5k
/
Copy pathProtocolConformance.cpp
1624 lines (1353 loc) · 56.8 KB
/
ProtocolConformance.cpp
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
//===--- ProtocolConformance.cpp - AST Protocol Conformance ---------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file implements the ProtocolConformance class hierarchy.
//
//===----------------------------------------------------------------------===//
#include "swift/AST/ProtocolConformance.h"
#include "ConformanceLookupTable.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/Availability.h"
#include "swift/AST/ConformanceLookup.h"
#include "swift/AST/Decl.h"
#include "swift/AST/DistributedDecl.h"
#include "swift/AST/FileUnit.h"
#include "swift/AST/GenericEnvironment.h"
#include "swift/AST/InFlightSubstitution.h"
#include "swift/AST/LazyResolver.h"
#include "swift/AST/Module.h"
#include "swift/AST/NameLookup.h"
#include "swift/AST/PackConformance.h"
#include "swift/AST/TypeCheckRequests.h"
#include "swift/AST/Types.h"
#include "swift/Basic/Assertions.h"
#include "swift/Basic/Statistic.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Support/PrettyStackTrace.h"
#include "llvm/Support/SaveAndRestore.h"
#define DEBUG_TYPE "AST"
STATISTIC(NumConformanceLookupTables, "# of conformance lookup tables built");
using namespace swift;
Witness::Witness(ValueDecl *decl, SubstitutionMap substitutions,
GenericSignature witnessThunkSig,
SubstitutionMap reqToWitnessThunkSigSubs,
GenericSignature derivativeGenSig,
std::optional<ActorIsolation> enterIsolation) {
if (!witnessThunkSig && substitutions.empty() &&
reqToWitnessThunkSigSubs.empty() && !enterIsolation) {
storage = decl;
return;
}
auto &ctx = decl->getASTContext();
auto declRef = ConcreteDeclRef(decl, substitutions);
auto storedMem = ctx.Allocate(sizeof(StoredWitness), alignof(StoredWitness));
auto stored = new (storedMem) StoredWitness{declRef, witnessThunkSig,
reqToWitnessThunkSigSubs,
derivativeGenSig, enterIsolation};
storage = stored;
}
Witness Witness::withEnterIsolation(ActorIsolation enterIsolation) const {
return Witness(getDecl(), getSubstitutions(), getWitnessThunkSignature(),
getRequirementToWitnessThunkSubs(),
getDerivativeGenericSignature(), enterIsolation);
}
void Witness::dump() const { dump(llvm::errs()); }
void Witness::dump(llvm::raw_ostream &out) const {
out << "Witness: ";
if (auto decl = this->getDecl()) {
decl->dumpRef(out);
out << "\n";
} else {
out << "<no decl>\n";
}
}
#define CONFORMANCE_SUBCLASS_DISPATCH(Method, Args) \
switch (getKind()) { \
case ProtocolConformanceKind::Normal: \
return cast<NormalProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Self: \
return cast<SelfProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Specialized: \
return cast<SpecializedProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Inherited: \
return cast<InheritedProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Builtin: \
assert(&ProtocolConformance::Method != &BuiltinProtocolConformance::Method \
&& "Must override BuiltinProtocolConformance::" #Method); \
return cast<BuiltinProtocolConformance>(this)->Method Args; \
} \
llvm_unreachable("bad ProtocolConformanceKind");
#define ROOT_CONFORMANCE_SUBCLASS_DISPATCH(Method, Args) \
switch (getKind()) { \
case ProtocolConformanceKind::Normal: \
return cast<NormalProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Self: \
return cast<SelfProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Builtin: \
return cast<BuiltinProtocolConformance>(this)->Method Args; \
case ProtocolConformanceKind::Specialized: \
case ProtocolConformanceKind::Inherited: \
llvm_unreachable("not a root conformance"); \
} \
llvm_unreachable("bad ProtocolConformanceKind");
/// Get the protocol being conformed to.
ProtocolDecl *ProtocolConformance::getProtocol() const {
CONFORMANCE_SUBCLASS_DISPATCH(getProtocol, ())
}
DeclContext *ProtocolConformance::getDeclContext() const {
CONFORMANCE_SUBCLASS_DISPATCH(getDeclContext, ())
}
/// Retrieve the state of this conformance.
ProtocolConformanceState ProtocolConformance::getState() const {
CONFORMANCE_SUBCLASS_DISPATCH(getState, ())
}
ConformanceEntryKind ProtocolConformance::getSourceKind() const {
CONFORMANCE_SUBCLASS_DISPATCH(getSourceKind, ())
}
NormalProtocolConformance *ProtocolConformance::getImplyingConformance() const {
CONFORMANCE_SUBCLASS_DISPATCH(getImplyingConformance, ())
}
bool
ProtocolConformance::hasTypeWitness(AssociatedTypeDecl *assocType) const {
CONFORMANCE_SUBCLASS_DISPATCH(hasTypeWitness, (assocType));
}
TypeWitnessAndDecl
ProtocolConformance::getTypeWitnessAndDecl(AssociatedTypeDecl *assocType,
SubstOptions options) const {
CONFORMANCE_SUBCLASS_DISPATCH(getTypeWitnessAndDecl,
(assocType, options))
}
Type ProtocolConformance::getTypeWitness(AssociatedTypeDecl *assocType,
SubstOptions options) const {
auto witness = getTypeWitnessAndDecl(assocType, options);
auto witnessTy = witness.getWitnessType();
if (!witnessTy)
return witnessTy;
// This is a hacky feature allowing code completion to migrate to
// using Type::subst() without changing output.
//
// FIXME: Remove this hack and do whatever we need to do in the
// ASTPrinter instead.
if (options & SubstFlags::DesugarMemberTypes) {
if (auto *aliasType = dyn_cast<TypeAliasType>(witnessTy.getPointer()))
witnessTy = aliasType->getSinglyDesugaredType();
// Another hack. If the type witness is a opaque result type. They can
// only be referred using the name of the associated type.
if (witnessTy->is<OpaqueTypeArchetypeType>())
witnessTy = witness.getWitnessDecl()->getDeclaredInterfaceType();
}
return witnessTy;
}
ConcreteDeclRef
ProtocolConformance::getWitnessDeclRef(ValueDecl *requirement) const {
CONFORMANCE_SUBCLASS_DISPATCH(getWitnessDeclRef, (requirement))
}
ValueDecl *ProtocolConformance::getWitnessDecl(ValueDecl *requirement) const {
switch (getKind()) {
case ProtocolConformanceKind::Normal:
return cast<NormalProtocolConformance>(this)->getWitness(requirement)
.getDecl();
case ProtocolConformanceKind::Self:
return cast<SelfProtocolConformance>(this)->getWitness(requirement)
.getDecl();
case ProtocolConformanceKind::Inherited:
return cast<InheritedProtocolConformance>(this)
->getInheritedConformance()->getWitnessDecl(requirement);
case ProtocolConformanceKind::Specialized:
return cast<SpecializedProtocolConformance>(this)
->getGenericConformance()->getWitnessDecl(requirement);
case ProtocolConformanceKind::Builtin:
return requirement;
}
llvm_unreachable("unhandled kind");
}
/// Determine whether the witness for the given requirement
/// is either the default definition or was otherwise deduced.
bool ProtocolConformance::
usesDefaultDefinition(AssociatedTypeDecl *requirement) const {
CONFORMANCE_SUBCLASS_DISPATCH(usesDefaultDefinition, (requirement))
}
bool ProtocolConformance::isRetroactive() const {
auto extensionModule = getDeclContext()->getParentModule();
auto protocolModule = getProtocol()->getParentModule();
auto isSameRetroactiveContext =
[](ModuleDecl *moduleA, ModuleDecl *moduleB) -> bool {
return moduleA->isSameModuleLookingThroughOverlays(moduleB) ||
moduleA->inSamePackage(moduleB);
};
if (isSameRetroactiveContext(extensionModule, protocolModule)) {
return false;
}
auto conformingTypeDecl =
ConformingType->getNominalOrBoundGenericNominal();
if (conformingTypeDecl) {
auto conformingTypeModule = conformingTypeDecl->getParentModule();
if (isSameRetroactiveContext(extensionModule, conformingTypeModule)) {
return false;
}
}
return true;
}
GenericEnvironment *ProtocolConformance::getGenericEnvironment() const {
switch (getKind()) {
case ProtocolConformanceKind::Inherited:
case ProtocolConformanceKind::Normal:
case ProtocolConformanceKind::Self:
// If we have a normal or inherited protocol conformance, look for its
// generic parameters.
return getDeclContext()->getGenericEnvironmentOfContext();
case ProtocolConformanceKind::Specialized:
case ProtocolConformanceKind::Builtin:
// If we have a specialized protocol conformance, since we do not support
// currently partial specialization, we know that it cannot have any open
// type variables.
//
// FIXME: We could return a meaningful GenericEnvironment here
return nullptr;
}
llvm_unreachable("Unhandled ProtocolConformanceKind in switch.");
}
GenericSignature ProtocolConformance::getGenericSignature() const {
switch (getKind()) {
case ProtocolConformanceKind::Inherited:
case ProtocolConformanceKind::Normal:
case ProtocolConformanceKind::Self:
// If we have a normal or inherited protocol conformance, look for its
// generic signature.
// In -swift-version 5 mode, a conditional conformance to a protocol can imply
// a Sendable conformance. The implied conformance is unconditional so it uses
// the generic signature of the nominal type and not the generic signature of
// the extension that declared the (implying) conditional conformance.
if (getSourceKind() == ConformanceEntryKind::Implied &&
getProtocol()->isSpecificProtocol(KnownProtocolKind::Sendable)) {
return getDeclContext()->getSelfNominalTypeDecl()->getGenericSignature();
}
return getDeclContext()->getGenericSignatureOfContext();
case ProtocolConformanceKind::Builtin:
return cast<BuiltinProtocolConformance>(this)->getGenericSignature();
case ProtocolConformanceKind::Specialized:
// If we have a specialized protocol conformance, since we do not support
// currently partial specialization, we know that it cannot have any open
// type variables.
return nullptr;
}
llvm_unreachable("Unhandled ProtocolConformanceKind in switch.");
}
SubstitutionMap ProtocolConformance::getSubstitutionMap() const {
CONFORMANCE_SUBCLASS_DISPATCH(getSubstitutionMap, ())
}
SubstitutionMap RootProtocolConformance::getSubstitutionMap() const {
if (auto genericSig = getGenericSignature())
return genericSig->getIdentitySubstitutionMap();
return SubstitutionMap();
}
bool RootProtocolConformance::isInvalid() const {
ROOT_CONFORMANCE_SUBCLASS_DISPATCH(isInvalid, ())
}
SourceLoc RootProtocolConformance::getLoc() const {
ROOT_CONFORMANCE_SUBCLASS_DISPATCH(getLoc, ())
}
bool
RootProtocolConformance::isWeakImported(ModuleDecl *fromModule) const {
auto *dc = getDeclContext();
if (dc->getParentModule() == fromModule)
return false;
// If the protocol is weak imported, so are any conformances to it.
if (getProtocol()->isWeakImported(fromModule))
return true;
// If the conforming type is weak imported, so are any of its conformances.
if (auto *nominal = getType()->getAnyNominal())
if (nominal->isWeakImported(fromModule))
return true;
// If the conformance is declared in an extension with the @_weakLinked
// attribute, it is weak imported.
if (auto *ext = dyn_cast<ExtensionDecl>(dc))
if (ext->isWeakImported(fromModule))
return true;
return false;
}
bool RootProtocolConformance::hasWitness(ValueDecl *requirement) const {
ROOT_CONFORMANCE_SUBCLASS_DISPATCH(hasWitness, (requirement))
}
bool RootProtocolConformance::isSynthesized() const {
if (auto normal = dyn_cast<NormalProtocolConformance>(this))
return normal->isSynthesizedNonUnique() || normal->isConformanceOfProtocol();
return false;
}
bool NormalProtocolConformance::isRetroactive() const {
auto module = getDeclContext()->getParentModule();
// If the conformance occurs in the same module as the protocol definition,
// this is not a retroactive conformance.
auto protocolModule = getProtocol()->getDeclContext()->getParentModule();
if (module == protocolModule)
return false;
// If the conformance occurs in the same module as the conforming type
// definition, this is not a retroactive conformance.
if (auto nominal = getType()->getAnyNominal()) {
auto nominalModule = nominal->getParentModule();
// Consider the overlay module to be the "home" of a nominal type
// defined in a Clang module.
if (auto nominalLoadedModule =
dyn_cast<LoadedFile>(nominal->getModuleScopeContext())) {
if (auto overlayModule = nominalLoadedModule->getOverlayModule())
nominalModule = overlayModule;
}
if (module == nominalModule)
return false;
}
// Everything else is retroactive.
return true;
}
bool NormalProtocolConformance::isSynthesizedNonUnique() const {
// Check if the conformance was synthesized by the ClangImporter.
if (auto *file = dyn_cast<FileUnit>(getDeclContext()->getModuleScopeContext()))
return file->getKind() == FileUnitKind::ClangModule;
return false;
}
bool NormalProtocolConformance::isConformanceOfProtocol() const {
return getDeclContext()->getSelfProtocolDecl() != nullptr;
}
bool NormalProtocolConformance::isResilient() const {
// If the type is non-resilient or the module we're in is non-resilient, the
// conformance is non-resilient.
// FIXME: Looking at the type is not the right long-term solution. We need an
// explicit mechanism for declaring conformances as 'fragile', or even
// individual witnesses.
if (!getDeclContext()->getSelfNominalTypeDecl()->isResilient())
return false;
return getDeclContext()->getParentModule()->isResilient();
}
std::optional<ArrayRef<Requirement>>
ProtocolConformance::getConditionalRequirementsIfAvailable() const {
CONFORMANCE_SUBCLASS_DISPATCH(getConditionalRequirementsIfAvailable, ());
}
ArrayRef<Requirement> ProtocolConformance::getConditionalRequirements() const {
CONFORMANCE_SUBCLASS_DISPATCH(getConditionalRequirements, ());
}
std::optional<ArrayRef<Requirement>>
NormalProtocolConformance::getConditionalRequirementsIfAvailable() const {
const auto &eval = getDeclContext()->getASTContext().evaluator;
if (eval.hasActiveRequest(ConditionalRequirementsRequest{
const_cast<NormalProtocolConformance *>(this)})) {
return std::nullopt;
}
return getConditionalRequirements();
}
llvm::ArrayRef<Requirement>
NormalProtocolConformance::getConditionalRequirements() const {
const auto ext = dyn_cast<ExtensionDecl>(getDeclContext());
if (ext && ext->isComputingGenericSignature()) {
return {};
}
return evaluateOrDefault(getProtocol()->getASTContext().evaluator,
ConditionalRequirementsRequest{
const_cast<NormalProtocolConformance *>(this)},
{});
}
llvm::ArrayRef<Requirement>
ConditionalRequirementsRequest::evaluate(Evaluator &evaluator,
NormalProtocolConformance *NPC) const {
// A non-extension conformance won't have conditional requirements.
const auto ext = dyn_cast<ExtensionDecl>(NPC->getDeclContext());
if (!ext) {
return {};
}
// If the extension is invalid, it won't ever get a signature, so we
// "succeed" with an empty result instead.
if (ext->isInvalid()) {
return {};
}
// A non-generic type won't have conditional requirements.
const auto typeSig = ext->getExtendedNominal()->getGenericSignature();
if (!typeSig) {
return {};
}
// In -swift-version 5 mode, a conditional conformance to a protocol can imply
// a Sendable conformance. We ask the conformance for its generic signature,
// which will always be the generic signature of `ext` except in this case,
// where it's the generic signature of the extended nominal.
const auto extensionSig = NPC->getGenericSignature();
// The extension signature should be a superset of the type signature, meaning
// every thing in the type signature either is included too or is implied by
// something else. The most important bit is having the same type
// parameters. (NB. if/when Swift gets parameterized extensions, this needs to
// change.)
assert(typeSig.getCanonicalSignature().getGenericParams() ==
extensionSig.getCanonicalSignature().getGenericParams());
// Find the requirements in the extension that aren't proved by the original
// type, these are the ones that make the conformance conditional.
const auto unsatReqs = extensionSig.requirementsNotSatisfiedBy(typeSig);
if (unsatReqs.empty())
return {};
return NPC->getProtocol()->getASTContext().AllocateCopy(unsatReqs);
}
void NormalProtocolConformance::resolveLazyInfo() const {
assert(Loader);
auto *loader = Loader;
auto *mutableThis = const_cast<NormalProtocolConformance *>(this);
mutableThis->Loader = nullptr;
loader->finishNormalConformance(mutableThis, LoaderContextData);
}
void NormalProtocolConformance::setLazyLoader(LazyConformanceLoader *loader,
uint64_t contextData) {
assert(!Loader && "already has a loader");
Loader = loader;
LoaderContextData = contextData;
}
namespace {
class PrettyStackTraceRequirement : public llvm::PrettyStackTraceEntry {
const char *Action;
const ProtocolConformance *Conformance;
ValueDecl *Requirement;
public:
PrettyStackTraceRequirement(const char *action,
const ProtocolConformance *conformance,
ValueDecl *requirement)
: Action(action), Conformance(conformance), Requirement(requirement) { }
void print(llvm::raw_ostream &out) const override {
out << "While " << Action << " requirement ";
Requirement->dumpRef(out);
out << " in conformance ";
Conformance->printName(out);
out << "\n";
}
};
} // end anonymous namespace
bool NormalProtocolConformance::hasTypeWitness(
AssociatedTypeDecl *assocType) const {
if (Loader)
resolveLazyInfo();
auto found = TypeWitnesses.find(assocType);
if (found != TypeWitnesses.end()) {
return !found->getSecond().getWitnessType().isNull();
}
return false;
}
TypeWitnessAndDecl
NormalProtocolConformance::getTypeWitnessAndDecl(AssociatedTypeDecl *assocType,
SubstOptions options) const {
if (Loader)
resolveLazyInfo();
// Check whether we already have a type witness.
auto known = TypeWitnesses.find(assocType);
if (known != TypeWitnesses.end())
return known->second;
// If there is a tentative-type-witness function, use it.
if (options.getTentativeTypeWitness) {
if (Type witnessType =
Type(options.getTentativeTypeWitness(this, assocType)))
return { witnessType, nullptr };
}
// If this conformance is in a state where it is inferring type witnesses but
// we didn't find anything, fail.
//
// FIXME: This is unsound, because we may not have diagnosed anything but
// still end up with an ErrorType in the AST.
if (getDeclContext()->getASTContext().evaluator.hasActiveRequest(
ResolveTypeWitnessesRequest{
const_cast<NormalProtocolConformance *>(this)})) {
return { Type(), nullptr };
}
return evaluateOrDefault(
assocType->getASTContext().evaluator,
TypeWitnessRequest{const_cast<NormalProtocolConformance *>(this),
assocType},
TypeWitnessAndDecl());
}
TypeWitnessAndDecl NormalProtocolConformance::getTypeWitnessUncached(
AssociatedTypeDecl *requirement) const {
auto entry = TypeWitnesses.find(requirement);
if (entry == TypeWitnesses.end()) {
return TypeWitnessAndDecl();
}
return entry->second;
}
void NormalProtocolConformance::setTypeWitness(AssociatedTypeDecl *assocType,
Type type,
TypeDecl *typeDecl) const {
assert(getProtocol() == cast<ProtocolDecl>(assocType->getDeclContext()) &&
"associated type in wrong protocol");
assert((TypeWitnesses.count(assocType) == 0 ||
TypeWitnesses[assocType].getWitnessType().isNull()) &&
"Type witness already known");
assert((!isComplete() || isInvalid()) && "Conformance already complete?");
assert(!type->hasArchetype() && "type witnesses must be interface types");
TypeWitnesses[assocType] = {type, typeDecl};
}
Type ProtocolConformance::getAssociatedType(Type assocType) const {
assert(assocType->isTypeParameter() &&
"associated type must be a type parameter");
ProtocolConformanceRef ref(const_cast<ProtocolConformance*>(this));
return ref.getAssociatedType(getType(), assocType);
}
ProtocolConformanceRef
ProtocolConformance::getAssociatedConformance(Type assocType,
ProtocolDecl *protocol) const {
CONFORMANCE_SUBCLASS_DISPATCH(getAssociatedConformance,
(assocType, protocol))
}
ProtocolConformanceRef
NormalProtocolConformance::getAssociatedConformance(Type assocType,
ProtocolDecl *protocol) const {
if (Loader)
resolveLazyInfo();
assert(assocType->isTypeParameter() &&
"associated type must be a type parameter");
std::optional<ProtocolConformanceRef> result;
auto &ctx = getDeclContext()->getASTContext();
forEachAssociatedConformance(
[&](Type t, ProtocolDecl *p, unsigned index) {
if (t->isEqual(assocType) && p == protocol) {
// Not strictly necessary, but avoids a bit of request evaluator
// overhead in the happy case.
if (hasComputedAssociatedConformances()) {
result = AssociatedConformances[index];
if (result)
return true;
}
result = evaluateOrDefault(ctx.evaluator,
AssociatedConformanceRequest{
const_cast<NormalProtocolConformance *>(this),
t->getCanonicalType(), p, index
}, ProtocolConformanceRef::forInvalid());
return true;
}
return false;
});
assert(result && "Subject type must be exactly equal to left-hand side of a"
"conformance requirement in protocol requirement signature");
return *result;
}
/// Allocate the backing array if needed, computing its size from the
///protocol's requirement signature.
void NormalProtocolConformance::createAssociatedConformanceArray() {
if (hasComputedAssociatedConformances())
return;
setHasComputedAssociatedConformances();
auto *proto = getProtocol();
unsigned count = 0;
for (auto req : proto->getRequirementSignature().getRequirements()) {
if (req.getKind() == RequirementKind::Conformance)
++count;
}
auto &ctx = proto->getASTContext();
AssociatedConformances =
ctx.Allocate<std::optional<ProtocolConformanceRef>>(count);
}
std::optional<ProtocolConformanceRef>
NormalProtocolConformance::getAssociatedConformance(unsigned index) const {
if (!hasComputedAssociatedConformances())
return std::nullopt;
return AssociatedConformances[index];
}
void NormalProtocolConformance::setAssociatedConformance(
unsigned index, ProtocolConformanceRef assocConf) {
createAssociatedConformanceArray();
assert(!AssociatedConformances[index]);
AssociatedConformances[index] = assocConf;
}
Witness RootProtocolConformance::getWitness(ValueDecl *requirement) const {
ROOT_CONFORMANCE_SUBCLASS_DISPATCH(getWitness, (requirement))
}
/// Retrieve the value witness corresponding to the given requirement.
Witness NormalProtocolConformance::getWitness(ValueDecl *requirement) const {
assert(!isa<AssociatedTypeDecl>(requirement) && "Request type witness");
assert(requirement->isProtocolRequirement() && "Not a requirement");
if (Loader)
resolveLazyInfo();
return evaluateOrDefault(
requirement->getASTContext().evaluator,
ValueWitnessRequest{const_cast<NormalProtocolConformance *>(this),
requirement},
Witness());
}
Witness
NormalProtocolConformance::getWitnessUncached(ValueDecl *requirement) const {
auto entry = Mapping.find(requirement);
if (entry == Mapping.end()) {
return Witness();
}
return entry->second;
}
Witness SelfProtocolConformance::getWitness(ValueDecl *requirement) const {
return Witness(requirement, SubstitutionMap(), nullptr, SubstitutionMap(),
GenericSignature(), std::nullopt);
}
ConcreteDeclRef
RootProtocolConformance::getWitnessDeclRef(ValueDecl *requirement) const {
if (auto witness = getWitness(requirement)) {
auto *witnessDecl = witness.getDecl();
// If the witness is generic, you have to call getWitness() and build
// your own substitutions in terms of the witness thunk signature.
if (auto *witnessDC = dyn_cast<DeclContext>(witnessDecl))
assert(!witnessDC->isInnermostContextGeneric());
// If the witness is not generic, use type substitutions from the
// witness's parent. Don't use witness.getSubstitutions(), which
// are written in terms of the witness thunk signature.
auto subs =
getType()->getContextSubstitutionMap(witnessDecl->getDeclContext());
return ConcreteDeclRef(witness.getDecl(), subs);
}
return ConcreteDeclRef();
}
void NormalProtocolConformance::setWitness(ValueDecl *requirement,
Witness witness) const {
assert(!isa<AssociatedTypeDecl>(requirement) && "Request type witness");
assert(getProtocol() == cast<ProtocolDecl>(requirement->getDeclContext()) &&
"requirement in wrong protocol");
assert(Mapping.count(requirement) == 0 && "Witness already known");
assert((!isComplete() || isInvalid() ||
// TODO(distributed): properly handle isComplete() for distributed
// funcs; there seems to be a problem that we mark completed, but
// afterwards will record the thunk witness;
(dyn_cast<FuncDecl>(requirement)
? (dyn_cast<FuncDecl>(requirement)->isDistributed() ||
dyn_cast<FuncDecl>(requirement)->isDistributedThunk())
: false) ||
requirement->getAttrs().hasAttribute<OptionalAttr>() ||
requirement->isUnavailable()) &&
"Conformance already complete?");
Mapping[requirement] = witness;
}
void NormalProtocolConformance::overrideWitness(ValueDecl *requirement,
Witness witness) {
assert(Mapping.count(requirement) == 1 && "Witness not known");
Mapping[requirement] = witness;
}
void NormalProtocolConformance::resolveValueWitnesses() const {
auto mutableThis = const_cast<NormalProtocolConformance *>(this);
evaluateOrDefault(getProtocol()->getASTContext().evaluator,
ResolveValueWitnessesRequest{mutableThis},
evaluator::SideEffect());
}
SpecializedProtocolConformance::SpecializedProtocolConformance(
Type conformingType,
NormalProtocolConformance *genericConformance,
SubstitutionMap substitutions)
: ProtocolConformance(ProtocolConformanceKind::Specialized, conformingType),
GenericConformance(genericConformance),
GenericSubstitutions(substitutions) {}
void SpecializedProtocolConformance::computeConditionalRequirements() const {
// already computed?
if (ConditionalRequirements)
return;
auto parentCondReqs =
GenericConformance->getConditionalRequirementsIfAvailable();
if (!parentCondReqs)
return;
if (!parentCondReqs->empty()) {
// Substitute the conditional requirements so that they're phrased in
// terms of the specialized types, not the conformance-declaring decl's
// types.
SubstitutionMap subMap;
if (auto nominal = GenericConformance->getType()->getAnyNominal()) {
subMap = getType()->getContextSubstitutionMap(nominal);
} else {
subMap = getSubstitutionMap();
}
SmallVector<Requirement, 4> newReqs;
for (auto oldReq : *parentCondReqs) {
auto newReq = oldReq.subst(QuerySubstitutionMap{subMap},
LookUpConformanceInModule());
newReqs.push_back(newReq);
}
auto &ctxt = getProtocol()->getASTContext();
ConditionalRequirements = ctxt.AllocateCopy(newReqs);
} else {
ConditionalRequirements = ArrayRef<Requirement>();
}
}
bool SpecializedProtocolConformance::hasTypeWitness(
AssociatedTypeDecl *assocType) const {
return TypeWitnesses.find(assocType) != TypeWitnesses.end() ||
GenericConformance->hasTypeWitness(assocType);
}
TypeWitnessAndDecl
SpecializedProtocolConformance::getTypeWitnessAndDecl(
AssociatedTypeDecl *assocType,
SubstOptions options) const {
assert(getProtocol() == cast<ProtocolDecl>(assocType->getDeclContext()) &&
"associated type in wrong protocol");
// If we've already computed this type witness, return it.
auto known = TypeWitnesses.find(assocType);
if (known != TypeWitnesses.end()) {
return known->second;
}
// Otherwise, perform substitutions to compute this witness.
auto genericWitnessAndDecl
= GenericConformance->getTypeWitnessAndDecl(assocType, options);
auto genericWitness = genericWitnessAndDecl.getWitnessType();
if (!genericWitness)
return { Type(), nullptr };
auto *typeDecl = genericWitnessAndDecl.getWitnessDecl();
auto substitutionMap = getSubstitutionMap();
auto specializedType = genericWitness.subst(substitutionMap, options);
if (specializedType->hasError()) {
if (options.getTentativeTypeWitness)
return { Type(), nullptr };
specializedType = ErrorType::get(genericWitness);
}
// Cache the result.
auto specializedWitnessAndDecl = TypeWitnessAndDecl{specializedType, typeDecl};
if (!options.getTentativeTypeWitness && !specializedType->hasError())
TypeWitnesses[assocType] = specializedWitnessAndDecl;
return specializedWitnessAndDecl;
}
ProtocolConformanceRef
SpecializedProtocolConformance::getAssociatedConformance(Type assocType,
ProtocolDecl *protocol) const {
ProtocolConformanceRef conformance =
GenericConformance->getAssociatedConformance(assocType, protocol);
auto subMap = getSubstitutionMap();
Type origType =
(conformance.isConcrete()
? conformance.getConcrete()->getType()
: GenericConformance->getAssociatedType(assocType));
return conformance.subst(origType, subMap);
}
ConcreteDeclRef
SpecializedProtocolConformance::getWitnessDeclRef(
ValueDecl *requirement) const {
auto baseWitness = GenericConformance->getWitnessDeclRef(requirement);
if (!baseWitness || !baseWitness.isSpecialized())
return baseWitness;
auto specializationMap = getSubstitutionMap();
auto witnessDecl = baseWitness.getDecl();
auto witnessMap = baseWitness.getSubstitutions();
auto combinedMap = witnessMap.subst(specializationMap);
return ConcreteDeclRef(witnessDecl, combinedMap);
}
ProtocolConformanceRef
InheritedProtocolConformance::getAssociatedConformance(Type assocType,
ProtocolDecl *protocol) const {
auto underlying =
InheritedConformance->getAssociatedConformance(assocType, protocol);
// If the conformance is for Self, return an inherited conformance.
if (underlying.isConcrete() &&
assocType->isEqual(getProtocol()->getSelfInterfaceType())) {
auto subclassType = getType();
ASTContext &ctx = subclassType->getASTContext();
return ProtocolConformanceRef(
ctx.getInheritedConformance(subclassType,
underlying.getConcrete()));
}
return underlying;
}
ConcreteDeclRef
InheritedProtocolConformance::getWitnessDeclRef(ValueDecl *requirement) const {
// FIXME: substitutions?
return InheritedConformance->getWitnessDeclRef(requirement);
}
const NormalProtocolConformance *
ProtocolConformance::getRootNormalConformance() const {
// This is an unsafe cast; remove this entire method.
return cast<NormalProtocolConformance>(getRootConformance());
}
const RootProtocolConformance *
ProtocolConformance::getRootConformance() const {
const ProtocolConformance *C = this;
if (auto *inheritedC = dyn_cast<InheritedProtocolConformance>(C))
C = inheritedC->getInheritedConformance();
if (auto *specializedC = dyn_cast<SpecializedProtocolConformance>(C))
return specializedC->getGenericConformance();
return cast<RootProtocolConformance>(C);
}
bool ProtocolConformance::isVisibleFrom(const DeclContext *dc) const {
// FIXME: Implement me!
return true;
}
ProtocolConformanceRef
ProtocolConformance::subst(SubstitutionMap subMap,
SubstOptions options) const {
InFlightSubstitutionViaSubMap IFS(subMap, options);
return subst(IFS);
}
ProtocolConformanceRef
ProtocolConformance::subst(TypeSubstitutionFn subs,
LookupConformanceFn conformances,
SubstOptions options) const {
InFlightSubstitution IFS(subs, conformances, options);
return subst(IFS);
}
/// Check if the replacement is a one-element pack with a scalar type.
static bool isVanishingTupleConformance(
NormalProtocolConformance *generic,
SubstitutionMap substitutions) {
if (!isa<BuiltinTupleDecl>(generic->getDeclContext()->getSelfNominalTypeDecl()))
return false;
auto replacementTypes = substitutions.getReplacementTypes();
assert(replacementTypes.size() == 1);
auto packType = replacementTypes[0]->castTo<PackType>();
return (packType->getNumElements() == 1 &&
!packType->getElementTypes()[0]->is<PackExpansionType>());
}
/// Don't form a tuple conformance if the substituted type is unwrapped
/// from a one-element tuple.
///
/// That is, [(repeat each T): P] ⊗ {each T := Pack{U};
/// [each T: P]: Pack{ [U: P] }}
/// => [U: P]
static ProtocolConformanceRef unwrapVanishingTupleConformance(
SubstitutionMap substitutions) {
auto conformances = substitutions.getConformances();
assert(conformances.size() == 1);
assert(conformances[0].isPack());
auto packConformance = conformances[0].getPack();
assert(packConformance->getPatternConformances().size() == 1);
return packConformance->getPatternConformances()[0];
}
ProtocolConformanceRef
ProtocolConformance::subst(InFlightSubstitution &IFS) const {
auto *mutableThis = const_cast<ProtocolConformance *>(this);
switch (getKind()) {
case ProtocolConformanceKind::Normal: {
auto origType = getType();
if (IFS.isInvariant(origType))
return ProtocolConformanceRef(mutableThis);
auto substType = origType.subst(IFS);
if (substType->isEqual(origType))
return ProtocolConformanceRef(mutableThis);
auto *generic = cast<NormalProtocolConformance>(mutableThis);
auto subMap = SubstitutionMap::get(getGenericSignature(), IFS);
if (isVanishingTupleConformance(generic, subMap))
return unwrapVanishingTupleConformance(subMap);
auto &ctx = substType->getASTContext();
auto *concrete = ctx.getSpecializedConformance(substType, generic, subMap);
return ProtocolConformanceRef(concrete);
}
case ProtocolConformanceKind::Builtin: {
auto origType = getType();
if (IFS.isInvariant(origType))
return ProtocolConformanceRef(mutableThis);