-
Notifications
You must be signed in to change notification settings - Fork 10.4k
/
Copy pathIndex.cpp
2089 lines (1779 loc) · 66.1 KB
/
Index.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
//===--- Index.cpp --------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "swift/Index/Index.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/Comment.h"
#include "swift/AST/Decl.h"
#include "swift/AST/Expr.h"
#include "swift/AST/GenericParamList.h"
#include "swift/AST/Module.h"
#include "swift/AST/ParameterList.h"
#include "swift/AST/Pattern.h"
#include "swift/AST/ProtocolConformance.h"
#include "swift/AST/SourceFile.h"
#include "swift/AST/Stmt.h"
#include "swift/AST/TypeRepr.h"
#include "swift/AST/Types.h"
#include "swift/AST/USRGeneration.h"
#include "swift/Basic/SourceManager.h"
#include "swift/Basic/StringExtras.h"
#include "swift/IDE/SourceEntityWalker.h"
#include "swift/IDE/Utils.h"
#include "swift/Markup/Markup.h"
#include "swift/Sema/IDETypeChecking.h"
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/FileSystem.h"
#include <tuple>
using namespace swift;
using namespace swift::index;
static bool
printArtificialName(const swift::AbstractStorageDecl *ASD, AccessorKind AK, llvm::raw_ostream &OS) {
switch (AK) {
case AccessorKind::Get:
OS << "getter:" << ASD->getName();
return false;
case AccessorKind::DistributedGet:
OS << "_distributed_getter:" << ASD->getName();
return false;
case AccessorKind::Set:
OS << "setter:" << ASD->getName();
return false;
case AccessorKind::DidSet:
OS << "didSet:" << ASD->getName();
return false;
case AccessorKind::WillSet:
OS << "willSet:" << ASD->getName() ;
return false;
case AccessorKind::Init:
OS << "init:" << ASD->getName();
return false;
case AccessorKind::Address:
case AccessorKind::MutableAddress:
case AccessorKind::Read:
case AccessorKind::Modify:
return true;
}
llvm_unreachable("Unhandled AccessorKind in switch.");
}
static bool printDisplayName(const swift::ValueDecl *D, llvm::raw_ostream &OS) {
if (!D->hasName() && !isa<ParamDecl>(D)) {
auto *FD = dyn_cast<AccessorDecl>(D);
if (!FD)
return true;
return printArtificialName(FD->getStorage(), FD->getAccessorKind(), OS);
}
OS << D->getName();
return false;
}
static bool isMemberwiseInit(swift::ValueDecl *D) {
if (auto AFD = dyn_cast<AbstractFunctionDecl>(D))
return AFD->isMemberwiseInitializer();
return false;
}
static SourceLoc getLocForExtension(ExtensionDecl *D) {
// Use the 'End' token of the range, in case it is a compound name, e.g.
// extension A.B {}
// we want the location of 'B' token.
if (auto *repr = D->getExtendedTypeRepr()) {
return repr->getSourceRange().End;
}
return SourceLoc();
}
namespace {
// Adapter providing a common interface for a SourceFile/Module.
class SourceFileOrModule {
llvm::PointerUnion<SourceFile *, ModuleDecl *> SFOrMod;
public:
SourceFileOrModule(SourceFile &SF) : SFOrMod(&SF) {}
SourceFileOrModule(ModuleDecl &Mod) : SFOrMod(&Mod) {}
SourceFile *getAsSourceFile() const {
return SFOrMod.dyn_cast<SourceFile *>();
}
ModuleDecl *getAsModule() const { return SFOrMod.dyn_cast<ModuleDecl *>(); }
ModuleDecl &getModule() const {
if (auto SF = SFOrMod.dyn_cast<SourceFile *>())
return *SF->getParentModule();
return *SFOrMod.get<ModuleDecl *>();
}
ArrayRef<FileUnit *> getFiles() const {
return SFOrMod.is<SourceFile *>() ? *SFOrMod.getAddrOfPtr1()
: SFOrMod.get<ModuleDecl *>()->getFiles();
}
StringRef getFilename() const {
if (auto *SF = SFOrMod.dyn_cast<SourceFile *>())
return SF->getFilename();
return SFOrMod.get<ModuleDecl *>()->getModuleFilename();
}
void
getImportedModules(SmallVectorImpl<ImportedModule> &Modules) const {
constexpr ModuleDecl::ImportFilter ImportFilter =
ModuleDecl::getImportFilterLocal();
if (auto *SF = SFOrMod.dyn_cast<SourceFile *>()) {
SF->getImportedModules(Modules, ImportFilter);
} else {
SFOrMod.get<ModuleDecl *>()->getImportedModules(Modules, ImportFilter);
}
}
};
struct IndexedWitness {
ValueDecl *Member;
ValueDecl *Requirement;
};
/// Identifies containers along with the types and expressions to which they
/// correspond.
///
/// The simplest form of a container is an function, it becomes the active
/// container immediately when it's visited. Pattern bindings however are more
/// complex, as their lexical structure does not translate directly into
/// container semantics.
///
/// Given the tuple binding 'let (a, b): (Int, String) = (intValue,
/// stringValue)' we can see that 'a' corresponds to 'Int' and 'intValue',
/// while 'b' corresponds to 'String' and 'stringValue'. By identifying these
/// relationships, we can pinpoint locations within the PatternBindingDecl
/// that the corresponding VarDecl should be marked as the current active
/// container. For example, when we walk to the TypeRepr for 'Int', we can
/// make 'a' the current active container, and likewise for 'String', 'b'. And
/// thus, when the walk reaches the point of creating the reference for 'Int'
/// it will be contained by 'a'.
///
/// These locations are also identified for single named pattern bindings; in
/// which case, the VarDecl is activated for all types and expressions with
/// the pattern.
///
/// Pattern bindings containing an AnyPattern (i.e let _) are a special case,
/// as they have no VarDecl. Their types and expressions are associated with
/// the current active container, if any. Therefore, given such a pattern
/// declared within a function, the type and expression references will be
/// contained by the function. If there is no active container, the references
/// are not contained.
class ContainerTracker {
typedef llvm::PointerUnion<const VarDecl *, const TuplePattern *>
PatternElement;
typedef llvm::PointerUnion<const Decl *, const Pattern *> Container;
typedef const void *ActivationKey;
struct StackEntry {
const Decl *TrackedDecl = nullptr;
ActivationKey ActiveKey = nullptr;
llvm::DenseMap<ActivationKey, Container> Containers{};
};
SmallVector<StackEntry, 4> Stack;
public:
void beginTracking(Decl *D) {
if (auto PBD = dyn_cast<PatternBindingDecl>(D)) {
StackEntry Entry = identifyContainers(PBD);
Stack.push_back(std::move(Entry));
} else if (isa<AbstractFunctionDecl>(D)) {
StackEntry Entry;
Entry.TrackedDecl = D;
Entry.ActiveKey = D;
Entry.Containers[D] = D;
Stack.push_back(std::move(Entry));
}
}
void endTracking(Decl *D) {
if (Stack.empty())
return;
if (Stack.back().TrackedDecl == D)
Stack.pop_back();
}
bool empty() const { return Stack.empty(); }
void forEachActiveContainer(llvm::function_ref<bool(const Decl *)> allowDecl,
llvm::function_ref<void(const Decl *)> f) const {
for (const auto &Entry : llvm::reverse(Stack)) {
// No active container, we're done.
if (!Entry.ActiveKey)
return;
auto MapEntry = Entry.Containers.find(Entry.ActiveKey);
if (MapEntry == Entry.Containers.end())
return;
bool hadViableContainer = false;
auto tryContainer = [&](const Decl *D) {
if (!allowDecl(D))
return;
f(D);
hadViableContainer = true;
};
if (auto C = MapEntry->second) {
if (auto *D = C.dyn_cast<const Decl *>()) {
tryContainer(D);
} else {
auto *P = C.get<const Pattern *>();
P->forEachVariable([&](VarDecl *VD) {
tryContainer(VD);
});
}
}
// If we had a viable containers, we're done. Otherwise continue walking
// up the stack.
if (hadViableContainer)
return;
}
}
void activateContainersFor(ActivationKey K) {
if (Stack.empty())
return;
StackEntry &Entry = Stack.back();
// Only activate the ActivationKey if there's an entry in the Containers.
if (Entry.Containers.count(K))
Entry.ActiveKey = K;
}
private:
StackEntry identifyContainers(const PatternBindingDecl *PBD) const {
StackEntry Entry;
Entry.TrackedDecl = PBD;
if (auto *VD = PBD->getSingleVar()) {
// This is a single var binding; therefore, it may also have custom
// attributes. Immediately activate the VarDecl so that it can be the
// container for the attribute references.
Entry.ActiveKey = PBD;
Entry.Containers[PBD] = VD;
}
for (auto Index : range(PBD->getNumPatternEntries())) {
Pattern *P = PBD->getPattern(Index);
if (!P)
continue;
TypeRepr *PatternTypeRepr = nullptr;
Expr *PatternInitExpr = nullptr;
if (auto *TP = dyn_cast<TypedPattern>(P)) {
if (auto *TR = TP->getTypeRepr()) {
if (auto *TTR = dyn_cast<TupleTypeRepr>(TR)) {
PatternTypeRepr = TTR;
} else {
// Non-tuple type, associate all elements in this pattern with the
// type.
associateAllPatternElements(P, TR, Entry);
}
}
}
if (auto *InitExpr = PBD->getInit(Index)) {
if (auto *TE = dyn_cast<TupleExpr>(InitExpr)) {
PatternInitExpr = TE;
} else {
// Non-tuple initializer, associate all elements in this pattern with
// the initializer.
associateAllPatternElements(P, InitExpr, Entry);
}
}
if (PatternTypeRepr || PatternInitExpr) {
forEachPatternElementPreservingIndex(
P, [&](PatternElement Element, size_t Index) {
associatePatternElement(Element, Index, PatternTypeRepr,
PatternInitExpr, Entry);
});
}
}
return Entry;
}
void associatePatternElement(PatternElement Element, size_t Index,
TypeRepr *TR, Expr *E, StackEntry &Entry) const {
if (auto *TTR = dyn_cast_or_null<TupleTypeRepr>(TR)) {
if (Index < TTR->getNumElements())
TR = TTR->getElementType(Index);
}
if (auto *TE = dyn_cast_or_null<TupleExpr>(E)) {
if (Index < TE->getNumElements())
E = TE->getElement(Index);
}
if (!Element) {
// This element is represents an AnyPattern (i.e let _).
if (TR)
associateAnyPattern(TR, Entry);
if (E)
associateAnyPattern(E, Entry);
return;
}
if (auto *VD = Element.dyn_cast<const VarDecl *>()) {
if (TR)
Entry.Containers[TR] = VD;
if (E)
Entry.Containers[E] = VD;
} else if (auto *TP = Element.dyn_cast<const TuplePattern *>()) {
forEachPatternElementPreservingIndex(
TP, [&](PatternElement Element, size_t Index) {
associatePatternElement(Element, Index, TR, E, Entry);
});
}
}
// AnyPatterns behave differently to other patterns as they've no associated
// VarDecl. We store null here, and will walk up to the parent container in
// forEachActiveContainer.
void associateAnyPattern(ActivationKey K, StackEntry &Entry) const {
Entry.Containers[K] = nullptr;
}
void associateAllPatternElements(const Pattern *P, ActivationKey K,
StackEntry &Entry) const {
if (isAnyPattern(P)) {
// This pattern consists of a single AnyPattern (i.e let _).
associateAnyPattern(K, Entry);
} else {
Entry.Containers[K] = P;
}
}
/// Enumerates elements within a Pattern while preserving their source
/// location. Given the pattern binding 'let (a, _, (b, c)) = ...' the given
/// function is called with the following values:
///
/// VarDecl(a), 0
/// nullptr, 1
/// TuplePattern(b, c), 2
///
/// Here nullptr represents the location of an AnyPattern, for which there
/// is no associated VarDecl.
void forEachPatternElementPreservingIndex(
const Pattern *P,
llvm::function_ref<void(PatternElement, size_t)> f) const {
auto *SP = P->getSemanticsProvidingPattern();
if (auto *TP = dyn_cast<TuplePattern>(SP)) {
for (size_t Index = 0; Index < TP->getNumElements(); ++Index) {
f(getPatternElement(TP->getElement(Index).getPattern()), Index);
}
} else {
f(getPatternElement(SP), 0);
}
}
PatternElement getPatternElement(const Pattern *P) const {
auto *SP = P->getSemanticsProvidingPattern();
if (auto *NP = dyn_cast<NamedPattern>(SP)) {
return NP->getDecl();
} else if (auto *TP = dyn_cast<TuplePattern>(SP)) {
return TP;
}
return nullptr;
}
bool isAnyPattern(const Pattern *P) const {
auto *SP = P->getSemanticsProvidingPattern();
if (isa<NamedPattern>(SP) || isa<TuplePattern>(SP)) {
return false;
}
return true;
}
};
struct MappedLoc {
unsigned Line;
unsigned Column;
bool IsGenerated;
};
class IndexSwiftASTWalker : public SourceEntityWalker {
IndexDataConsumer &IdxConsumer;
SourceManager &SrcMgr;
unsigned BufferID;
bool enableWarnings;
ModuleDecl *CurrentModule = nullptr;
bool IsModuleFile = false;
bool isSystemModule = false;
struct Entity {
Decl *D;
SymbolInfo SymInfo;
SymbolRoleSet Roles;
SmallVector<IndexedWitness, 6> ExplicitWitnesses;
};
SmallVector<Entity, 6> EntitiesStack;
SmallVector<Expr *, 8> ExprStack;
SmallVector<const AccessorDecl *, 4> ManuallyVisitedAccessorStack;
bool Cancelled = false;
struct NameAndUSR {
StringRef USR;
StringRef name;
};
typedef llvm::PointerIntPair<Decl *, 3> DeclAccessorPair;
llvm::DenseMap<void *, NameAndUSR> nameAndUSRCache;
llvm::DenseMap<DeclAccessorPair, NameAndUSR> accessorNameAndUSRCache;
StringScratchSpace stringStorage;
ContainerTracker Containers;
// Already handled references that should be suppressed if found later.
llvm::DenseSet<SourceLoc> RefsToSuppress;
// Contains a mapping for captures of the form [x], from the declared "x"
// to the captured "x" in the enclosing scope. Also includes shorthand if
// let bindings.
llvm::DenseMap<ValueDecl *, ValueDecl *> sameNamedCaptures;
bool getNameAndUSR(ValueDecl *D, ExtensionDecl *ExtD,
StringRef &name, StringRef &USR) {
auto &result = nameAndUSRCache[ExtD ? (Decl*)ExtD : D];
if (result.USR.empty()) {
SmallString<128> storage;
{
llvm::raw_svector_ostream OS(storage);
if (ExtD) {
if (ide::printExtensionUSR(ExtD, OS))
return true;
} else {
if (ide::printValueDeclUSR(D, OS))
return true;
}
result.USR = stringStorage.copyString(OS.str());
}
storage.clear();
{
llvm::raw_svector_ostream OS(storage);
printDisplayName(D, OS);
result.name = stringStorage.copyString(OS.str());
}
}
name = result.name;
USR = result.USR;
return false;
}
bool getModuleNameAndUSR(ModuleEntity Mod, StringRef &name, StringRef &USR) {
auto &result = nameAndUSRCache[Mod.getOpaqueValue()];
if (result.USR.empty()) {
SmallString<128> storage;
{
llvm::raw_svector_ostream OS(storage);
if (ide::printModuleUSR(Mod, OS))
return true;
result.USR = stringStorage.copyString(OS.str());
}
storage.clear();
{
llvm::raw_svector_ostream OS(storage);
OS << Mod.getFullName(/*useRealNameIfAliased=*/true);
result.name = stringStorage.copyString(OS.str());
}
}
name = result.name;
USR = result.USR;
return false;
}
bool getPseudoAccessorNameAndUSR(AbstractStorageDecl *D, AccessorKind AK, StringRef &Name, StringRef &USR) {
assert(static_cast<int>(AK) < 0x111 && "AccessorKind too big for pair");
DeclAccessorPair key(D, static_cast<int>(AK));
auto &result = accessorNameAndUSRCache[key];
if (result.USR.empty()) {
SmallString<128> storage;
{
llvm::raw_svector_ostream OS(storage);
if (ide::printAccessorUSR(D, AK, OS))
return true;
result.USR = stringStorage.copyString(OS.str());
}
storage.clear();
{
llvm::raw_svector_ostream OS(storage);
printArtificialName(D, AK, OS);
result.name = stringStorage.copyString(OS.str());
}
}
Name = result.name;
USR = result.USR;
return false;
}
bool addRelation(IndexSymbol &Info, SymbolRoleSet RelationRoles, Decl *D) {
assert(D);
if (auto *VD = dyn_cast<ValueDecl>(D)) {
if (!shouldIndex(VD, /*IsRef*/ true))
return true;
}
auto Match = std::find_if(Info.Relations.begin(), Info.Relations.end(),
[D](IndexRelation R) { return R.decl == D; });
if (Match != Info.Relations.end()) {
Match->roles |= RelationRoles;
Info.roles |= RelationRoles;
return false;
}
StringRef Name, USR;
SymbolInfo SymInfo = getSymbolInfoForDecl(D);
if (SymInfo.Kind == SymbolKind::Unknown)
return true;
if (auto *ExtD = dyn_cast<ExtensionDecl>(D)) {
NominalTypeDecl *NTD = ExtD->getExtendedNominal();
if (getNameAndUSR(NTD, ExtD, Name, USR))
return true;
} else {
if (getNameAndUSR(cast<ValueDecl>(D), /*ExtD=*/nullptr, Name, USR))
return true;
}
Info.Relations.push_back(IndexRelation(RelationRoles, D, SymInfo, Name, USR));
Info.roles |= RelationRoles;
return false;
}
ValueDecl *firstDecl(ValueDecl *D) {
while (true) {
auto captured = sameNamedCaptures.find(D);
if (captured == sameNamedCaptures.end())
break;
D = captured->second;
}
return D;
}
public:
IndexSwiftASTWalker(IndexDataConsumer &IdxConsumer, ASTContext &Ctx,
SourceFile *SF = nullptr)
: IdxConsumer(IdxConsumer), SrcMgr(Ctx.SourceMgr),
BufferID(SF ? SF->getBufferID().value_or(-1) : -1),
enableWarnings(IdxConsumer.enableWarnings()) {}
~IndexSwiftASTWalker() override {
assert(Cancelled || EntitiesStack.empty());
assert(Cancelled || ManuallyVisitedAccessorStack.empty());
assert(Cancelled || Containers.empty());
}
/// Walk both the arguments and expansion of the macro, so we index both.
MacroWalking getMacroWalkingBehavior() const override {
return MacroWalking::ArgumentsAndExpansion;
}
void visitModule(ModuleDecl &Mod);
void visitDeclContext(DeclContext *DC);
private:
bool visitImports(SourceFileOrModule Mod,
llvm::SmallPtrSetImpl<ModuleDecl *> &Visited);
bool handleSourceOrModuleFile(SourceFileOrModule SFOrMod);
bool walkToDeclPre(Decl *D, CharSourceRange Range) override {
// Do not handle unavailable decls from other modules.
if (IsModuleFile && AvailableAttr::isUnavailable(D))
return false;
if (!handleCustomAttrInitRefs(D))
return false;
if (auto *AD = dyn_cast<AccessorDecl>(D)) {
if (ManuallyVisitedAccessorStack.empty() ||
ManuallyVisitedAccessorStack.back() != AD)
return false; // already handled as part of the var decl.
}
if (auto *VD = dyn_cast<ValueDecl>(D)) {
if (!report(VD))
return false;
}
if (auto *ED = dyn_cast<ExtensionDecl>(D))
return reportExtension(ED);
return true;
}
bool walkToDeclPost(Decl *D) override {
if (Cancelled)
return false;
if (getParentDecl() == D)
return finishCurrentEntity();
return true;
}
/// Report calls to the initializers of property wrapper types on wrapped
/// properties.
///
/// These may be either explicit:
/// `\@Wrapper(initialValue: 42) var x: Int`
/// or implicit:
/// `\@Wrapper var x = 10`
bool handleCustomAttrInitRefs(Decl * D) {
for (auto *customAttr : D->getAttrs().getAttributes<CustomAttr, true>()) {
if (customAttr->isImplicit())
continue;
if (auto *semanticInit = dyn_cast_or_null<CallExpr>(customAttr->getSemanticInit())) {
if (auto *CD = semanticInit->getCalledValue()) {
if (!shouldIndex(CD, /*IsRef*/true))
continue;
IndexSymbol Info;
const auto reprLoc = customAttr->getTypeRepr()->getLoc();
if (initIndexSymbol(CD, reprLoc, /*IsRef=*/true, Info))
continue;
Info.roles |= (unsigned)SymbolRole::Call;
if (semanticInit->isImplicit())
Info.roles |= (unsigned)SymbolRole::Implicit;
if (!startEntity(CD, Info, /*IsRef=*/true) || !finishCurrentEntity())
return false;
}
}
}
return true;
}
void handleMemberwiseInitRefs(Expr *E) {
if (!isa<ApplyExpr>(E))
return;
auto *DeclRef = dyn_cast<DeclRefExpr>(cast<ApplyExpr>(E)->getFn());
if (!DeclRef || !isMemberwiseInit(DeclRef->getDecl()))
return;
auto *MemberwiseInit = DeclRef->getDecl();
auto NameLoc = DeclRef->getNameLoc();
auto ArgNames = MemberwiseInit->getName().getArgumentNames();
// Get label locations.
llvm::SmallVector<Argument, 4> Args;
if (NameLoc.isCompound()) {
size_t LabelIndex = 0;
while (auto ArgLoc = NameLoc.getArgumentLabelLoc(LabelIndex)) {
Args.emplace_back(ArgLoc, ArgNames[LabelIndex], /*expr*/ nullptr);
LabelIndex++;
}
} else if (auto *CallParent = dyn_cast_or_null<CallExpr>(getParentExpr())) {
auto *args = CallParent->getArgs()->getOriginalArgs();
Args.append(args->begin(), args->end());
}
if (Args.empty())
return;
// match labels to properties
auto *TypeContext =
MemberwiseInit->getDeclContext()->getSelfNominalTypeDecl();
if (!TypeContext || !shouldIndex(TypeContext, false))
return;
unsigned CurLabel = 0;
for (auto Prop : TypeContext->getMemberwiseInitProperties()) {
if (CurLabel == Args.size())
break;
if (Args[CurLabel].getLabel() != Prop->getName())
continue;
IndexSymbol Info;
auto LabelLoc = Args[CurLabel++].getLabelLoc();
if (initIndexSymbol(Prop, LabelLoc, /*IsRef=*/true, Info))
continue;
if (startEntity(Prop, Info, /*IsRef=*/true))
finishCurrentEntity();
}
}
bool walkToExprPre(Expr *E) override {
if (Cancelled)
return false;
// Record any same named captures/shorthand if let bindings so we can
// treat their references as references to the original decl.
if (auto *captureList = dyn_cast<CaptureListExpr>(E)) {
for (auto shadows : getShorthandShadows(captureList)) {
sameNamedCaptures[shadows.first] = shadows.second;
}
}
ExprStack.push_back(E);
Containers.activateContainersFor(E);
handleMemberwiseInitRefs(E);
return true;
}
bool walkToExprPost(Expr *E) override {
if (Cancelled)
return false;
assert(ExprStack.back() == E);
ExprStack.pop_back();
return true;
}
bool walkToStmtPre(Stmt *stmt) override {
if (Cancelled)
return false;
// Record any same named captures/shorthand if let bindings so we can
// treat their references as references to the original decl.
if (auto *condition = dyn_cast<LabeledConditionalStmt>(stmt)) {
for (auto shadows : getShorthandShadows(condition)) {
sameNamedCaptures[shadows.first] = shadows.second;
}
}
return true;
}
bool walkToTypeReprPre(TypeRepr *T) override {
if (Cancelled)
return false;
Containers.activateContainersFor(T);
return true;
}
bool walkToPatternPre(Pattern *P) override {
if (Cancelled)
return false;
Containers.activateContainersFor(P);
return true;
}
void beginBalancedASTOrderDeclVisit(Decl *D) override {
Containers.beginTracking(D);
}
void endBalancedASTOrderDeclVisit(Decl *D) override {
Containers.endTracking(D);
}
/// Extensions redeclare all generic parameters of their extended type to add
/// their additional restrictions. There are two issues with this model for
/// indexing:
/// - The generic parameter declarations of the extension are implicit so we
/// wouldn't report them in the index. Any usage of the generic param in
/// the extension references this implicit declaration so we don't include
/// it in the index either.
/// - The implicit re-declarations have their own USRs so any usage of a
/// generic parameter inside an extension would use a different USR than
/// declaration of the param in the extended type.
///
/// To fix these issues, we replace the reference to the implicit generic
/// parameter defined in the extension by a reference to the generic parameter
/// defined in the extended type.
///
/// \returns the canonicalized replaced generic param decl if it can be found
/// or \p GenParam otherwise.
ValueDecl *
canonicalizeGenericTypeParamDeclForIndex(GenericTypeParamDecl *GenParam) {
auto Extension = dyn_cast_or_null<ExtensionDecl>(
GenParam->getDeclContext()->getAsDecl());
if (!Extension) {
// We are not referencing a generic parameter defined in an extension.
// Nothing to do.
return GenParam;
}
assert(GenParam->isImplicit() &&
"Generic param decls in extension should always be implicit and "
"shadow a generic param in the extended type.");
assert(Extension->getExtendedNominal() &&
"The implicit generic types on the extension should only be created "
"if the extended type was found");
auto ExtendedTypeGenSig =
Extension->getExtendedNominal()->getGenericSignature();
assert(ExtendedTypeGenSig && "Extension is generic but extended type not?");
// The generic parameter in the extension has the same depths and index
// as the one in the extended type.
for (auto ExtendedTypeGenParam : ExtendedTypeGenSig.getGenericParams()) {
if (ExtendedTypeGenParam->getIndex() == GenParam->getIndex() &&
ExtendedTypeGenParam->getDepth() == GenParam->getDepth()) {
assert(ExtendedTypeGenParam->getDecl() &&
"The generic parameter defined on the extended type cannot be "
"implicit.");
return ExtendedTypeGenParam->getDecl();
}
}
llvm_unreachable("Can't find the generic parameter in the extended type");
}
bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
ReferenceMetaData Data) override {
SourceLoc Loc = Range.getStart();
if (Loc.isInvalid() || isSuppressed(Loc))
return true;
// Dig back to the original captured variable
if (auto *VD = dyn_cast<VarDecl>(D)) {
D = firstDecl(D);
}
IndexSymbol Info;
if (Data.isImplicit)
Info.roles |= (unsigned)SymbolRole::Implicit;
if (CtorTyRef) {
IndexSymbol CtorInfo(Info);
if (Data.isImplicitCtorType)
CtorInfo.roles |= (unsigned)SymbolRole::Implicit;
if (!reportRef(CtorTyRef, Loc, CtorInfo, Data.AccKind))
return false;
}
if (auto *GenParam = dyn_cast<GenericTypeParamDecl>(D)) {
D = canonicalizeGenericTypeParamDeclForIndex(GenParam);
}
if (!reportRef(D, Loc, Info, Data.AccKind))
return false;
// If this is a reference to a property wrapper backing property or
// projected value, report a reference to the wrapped property too (i.e.
// report an occurrence of `foo` in `_foo` and '$foo').
if (auto *VD = dyn_cast<VarDecl>(D)) {
if (auto *Wrapped = VD->getOriginalWrappedProperty()) {
assert(Range.getByteLength() > 1 &&
(Range.str().front() == '_' || Range.str().front() == '$'));
auto AfterDollar = Loc.getAdvancedLoc(1);
reportRef(Wrapped, AfterDollar, Info, std::nullopt);
}
}
return true;
}
bool visitModuleReference(ModuleEntity Mod, CharSourceRange Range) override {
auto MappedLoc = getMappedLocation(Range.getStart());
if (!MappedLoc)
return true;
IndexSymbol Info;
Info.line = MappedLoc->Line;
Info.column = MappedLoc->Column;
Info.roles |= (unsigned)SymbolRole::Reference;
if (MappedLoc->IsGenerated) {
Info.roles |= (unsigned)SymbolRole::Implicit;
}
Info.symInfo = getSymbolInfoForModule(Mod);
getModuleNameAndUSR(Mod, Info.name, Info.USR);
addContainedByRelationIfContained(Info);
if (!IdxConsumer.startSourceEntity(Info)) {
Cancelled = true;
return true;
}
return finishSourceEntity(Info.symInfo, Info.roles);
}
bool visitCallAsFunctionReference(ValueDecl *D, CharSourceRange Range,
ReferenceMetaData Data) override {
// Index implicit callAsFunction reference.
return visitDeclReference(D, Range, /*CtorTyRef*/ nullptr,
/*ExtTyRef*/ nullptr, Type(), Data);
}
Decl *getParentDecl() const {
if (!EntitiesStack.empty())
return EntitiesStack.back().D;
return nullptr;
}
void addContainedByRelationIfContained(IndexSymbol &Info) {
// Only consider the innermost container that we are allowed to index.
auto allowDecl = [&](const Decl *D) {
if (auto *VD = dyn_cast<ValueDecl>(D)) {
return shouldIndex(VD, /*IsRef*/ true);
}
return true;
};
Containers.forEachActiveContainer(allowDecl, [&](const Decl *D) {
addRelation(Info, (unsigned)SymbolRole::RelationContainedBy,
const_cast<Decl *>(D));
});
}
void suppressRefAtLoc(SourceLoc Loc) {
if (Loc.isInvalid()) return;
RefsToSuppress.insert(Loc);
}
bool isSuppressed(SourceLoc Loc) const {
return Loc.isValid() && RefsToSuppress.contains(Loc);
}
Expr *getContainingExpr(size_t index) const {
if (ExprStack.size() > index)
return ExprStack.end()[-std::ptrdiff_t(index + 1)];
return nullptr;
}
Expr *getCurrentExpr() const {
return ExprStack.empty() ? nullptr : ExprStack.back();
}
Expr *getParentExpr() const {
return getContainingExpr(1);
}
bool report(ValueDecl *D);
bool reportExtension(ExtensionDecl *D);
bool reportRef(ValueDecl *D, SourceLoc Loc, IndexSymbol &Info,
std::optional<AccessKind> AccKind);
bool reportImplicitConformance(ValueDecl *witness, ValueDecl *requirement,
Decl *container);
bool startEntity(Decl *D, IndexSymbol &Info, bool IsRef);
bool startEntityDecl(ValueDecl *D);
bool reportRelatedRef(ValueDecl *D, SourceLoc Loc, bool isImplicit, SymbolRoleSet Relations, Decl *Related);
/// Report references for dependent types
///
/// NOTE: If the dependent type is a typealias, report the underlying types as well.
///
/// \param Ty The type being referenced.
/// \param Relations The relationship between the referenced type and the passed Decl.
/// \param Related The Decl that is referencing the type.
/// \param isImplicit Whether the reference is implicit, such as for a typealias' underlying type.
/// \param Loc The location of the reference, otherwise the location of the TypeLoc is used.
bool reportRelatedTypeRef(const TypeLoc &Ty, SymbolRoleSet Relations, Decl *Related,
bool isImplicit=false, SourceLoc Loc={});
bool reportInheritedTypeRefs(InheritedTypes Inherited, Decl *Inheritee);
bool reportPseudoGetterDecl(VarDecl *D) {
return reportPseudoAccessor(D, AccessorKind::Get, /*IsRef=*/false,
D->getLoc(/*SerializedOK=*/false));
}
bool reportPseudoSetterDecl(VarDecl *D) {
return reportPseudoAccessor(D, AccessorKind::Set, /*IsRef=*/false,
D->getLoc(/*SerializedOK=*/false));
}
bool reportPseudoAccessor(AbstractStorageDecl *D, AccessorKind AccKind,
bool IsRef, SourceLoc Loc);
bool reportIsDynamicRef(ValueDecl *D, IndexSymbol &Info);