1 //===--- IndexSymbol.cpp - Types and functions for indexing symbols -------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "clang/Index/IndexSymbol.h"
11 #include "clang/AST/DeclCXX.h"
12 #include "clang/AST/DeclObjC.h"
13 #include "clang/AST/DeclTemplate.h"
14 #include "clang/AST/PrettyPrinter.h"
15 
16 using namespace clang;
17 using namespace clang::index;
18 
19 /// \returns true if \c D is a subclass of 'XCTestCase'.
20 static bool isUnitTestCase(const ObjCInterfaceDecl *D) {
21   if (!D)
22     return false;
23   while (const ObjCInterfaceDecl *SuperD = D->getSuperClass()) {
24     if (SuperD->getName() == "XCTestCase")
25       return true;
26     D = SuperD;
27   }
28   return false;
29 }
30 
31 /// \returns true if \c D is in a subclass of 'XCTestCase', returns void, has
32 /// no parameters, and its name starts with 'test'.
33 static bool isUnitTest(const ObjCMethodDecl *D) {
34   if (!D->parameters().empty())
35     return false;
36   if (!D->getReturnType()->isVoidType())
37     return false;
38   if (!D->getSelector().getNameForSlot(0).startswith("test"))
39     return false;
40   return isUnitTestCase(D->getClassInterface());
41 }
42 
43 static void checkForIBOutlets(const Decl *D, SymbolPropertySet &PropSet) {
44   if (D->hasAttr<IBOutletAttr>()) {
45     PropSet |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
46   } else if (D->hasAttr<IBOutletCollectionAttr>()) {
47     PropSet |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
48     PropSet |= (SymbolPropertySet)SymbolProperty::IBOutletCollection;
49   }
50 }
51 
52 bool index::isFunctionLocalSymbol(const Decl *D) {
53   assert(D);
54 
55   if (isa<ParmVarDecl>(D))
56     return true;
57 
58   if (isa<TemplateTemplateParmDecl>(D))
59     return true;
60 
61   if (isa<ObjCTypeParamDecl>(D))
62     return true;
63 
64   if (isa<UsingDirectiveDecl>(D))
65     return false;
66   if (!D->getParentFunctionOrMethod())
67     return false;
68 
69   if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
70     switch (ND->getFormalLinkage()) {
71       case NoLinkage:
72       case InternalLinkage:
73         return true;
74       case VisibleNoLinkage:
75       case UniqueExternalLinkage:
76       case ModuleInternalLinkage:
77         llvm_unreachable("Not a sema linkage");
78       case ModuleLinkage:
79       case ExternalLinkage:
80         return false;
81     }
82   }
83 
84   return true;
85 }
86 
87 SymbolInfo index::getSymbolInfo(const Decl *D) {
88   assert(D);
89   SymbolInfo Info;
90   Info.Kind = SymbolKind::Unknown;
91   Info.SubKind = SymbolSubKind::None;
92   Info.Properties = SymbolPropertySet();
93   Info.Lang = SymbolLanguage::C;
94 
95   if (isFunctionLocalSymbol(D)) {
96     Info.Properties |= (SymbolPropertySet)SymbolProperty::Local;
97   }
98 
99   if (const TagDecl *TD = dyn_cast<TagDecl>(D)) {
100     switch (TD->getTagKind()) {
101     case TTK_Struct:
102       Info.Kind = SymbolKind::Struct; break;
103     case TTK_Union:
104       Info.Kind = SymbolKind::Union; break;
105     case TTK_Class:
106       Info.Kind = SymbolKind::Class;
107       Info.Lang = SymbolLanguage::CXX;
108       break;
109     case TTK_Interface:
110       Info.Kind = SymbolKind::Protocol;
111       Info.Lang = SymbolLanguage::CXX;
112       break;
113     case TTK_Enum:
114       Info.Kind = SymbolKind::Enum; break;
115     }
116 
117     if (const CXXRecordDecl *CXXRec = dyn_cast<CXXRecordDecl>(D)) {
118       if (!CXXRec->isCLike()) {
119         Info.Lang = SymbolLanguage::CXX;
120         if (CXXRec->getDescribedClassTemplate()) {
121           Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
122         }
123       }
124     }
125 
126     if (isa<ClassTemplatePartialSpecializationDecl>(D)) {
127       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
128       Info.Properties |=
129           (SymbolPropertySet)SymbolProperty::TemplatePartialSpecialization;
130     } else if (isa<ClassTemplateSpecializationDecl>(D)) {
131       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
132       Info.Properties |=
133           (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
134     }
135 
136   } else if (auto *VD = dyn_cast<VarDecl>(D)) {
137     Info.Kind = SymbolKind::Variable;
138     if (isa<ParmVarDecl>(D)) {
139       Info.Kind = SymbolKind::Parameter;
140     } else if (isa<CXXRecordDecl>(D->getDeclContext())) {
141       Info.Kind = SymbolKind::StaticProperty;
142       Info.Lang = SymbolLanguage::CXX;
143     }
144 
145     if (isa<VarTemplatePartialSpecializationDecl>(D)) {
146       Info.Lang = SymbolLanguage::CXX;
147       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
148       Info.Properties |=
149           (SymbolPropertySet)SymbolProperty::TemplatePartialSpecialization;
150     } else if (isa<VarTemplateSpecializationDecl>(D)) {
151       Info.Lang = SymbolLanguage::CXX;
152       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
153       Info.Properties |=
154           (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
155     } else if (VD->getDescribedVarTemplate()) {
156       Info.Lang = SymbolLanguage::CXX;
157       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
158     }
159 
160   } else {
161     switch (D->getKind()) {
162     case Decl::Import:
163       Info.Kind = SymbolKind::Module;
164       break;
165     case Decl::Typedef:
166       Info.Kind = SymbolKind::TypeAlias; break; // Lang = C
167     case Decl::Function:
168       Info.Kind = SymbolKind::Function;
169       break;
170     case Decl::Field:
171       Info.Kind = SymbolKind::Field;
172       if (const CXXRecordDecl *
173             CXXRec = dyn_cast<CXXRecordDecl>(D->getDeclContext())) {
174         if (!CXXRec->isCLike())
175           Info.Lang = SymbolLanguage::CXX;
176       }
177       break;
178     case Decl::EnumConstant:
179       Info.Kind = SymbolKind::EnumConstant; break;
180     case Decl::ObjCInterface:
181     case Decl::ObjCImplementation: {
182       Info.Kind = SymbolKind::Class;
183       Info.Lang = SymbolLanguage::ObjC;
184       const ObjCInterfaceDecl *ClsD = dyn_cast<ObjCInterfaceDecl>(D);
185       if (!ClsD)
186         ClsD = cast<ObjCImplementationDecl>(D)->getClassInterface();
187       if (isUnitTestCase(ClsD))
188         Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
189       break;
190     }
191     case Decl::ObjCProtocol:
192       Info.Kind = SymbolKind::Protocol;
193       Info.Lang = SymbolLanguage::ObjC;
194       break;
195     case Decl::ObjCCategory:
196     case Decl::ObjCCategoryImpl: {
197       Info.Kind = SymbolKind::Extension;
198       Info.Lang = SymbolLanguage::ObjC;
199       const ObjCInterfaceDecl *ClsD = nullptr;
200       if (auto *CatD = dyn_cast<ObjCCategoryDecl>(D))
201         ClsD = CatD->getClassInterface();
202       else
203         ClsD = cast<ObjCCategoryImplDecl>(D)->getClassInterface();
204       if (isUnitTestCase(ClsD))
205         Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
206       break;
207     }
208     case Decl::ObjCMethod: {
209       const ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D);
210       Info.Kind = MD->isInstanceMethod() ? SymbolKind::InstanceMethod : SymbolKind::ClassMethod;
211       if (MD->isPropertyAccessor()) {
212         if (MD->param_size())
213           Info.SubKind = SymbolSubKind::AccessorSetter;
214         else
215           Info.SubKind = SymbolSubKind::AccessorGetter;
216       }
217       Info.Lang = SymbolLanguage::ObjC;
218       if (isUnitTest(MD))
219         Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
220       if (D->hasAttr<IBActionAttr>())
221         Info.Properties |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
222       break;
223     }
224     case Decl::ObjCProperty:
225       Info.Kind = SymbolKind::InstanceProperty;
226       Info.Lang = SymbolLanguage::ObjC;
227       checkForIBOutlets(D, Info.Properties);
228       if (auto *Annot = D->getAttr<AnnotateAttr>()) {
229         if (Annot->getAnnotation() == "gk_inspectable")
230           Info.Properties |= (SymbolPropertySet)SymbolProperty::GKInspectable;
231       }
232       break;
233     case Decl::ObjCIvar:
234       Info.Kind = SymbolKind::Field;
235       Info.Lang = SymbolLanguage::ObjC;
236       checkForIBOutlets(D, Info.Properties);
237       break;
238     case Decl::Namespace:
239       Info.Kind = SymbolKind::Namespace;
240       Info.Lang = SymbolLanguage::CXX;
241       break;
242     case Decl::NamespaceAlias:
243       Info.Kind = SymbolKind::NamespaceAlias;
244       Info.Lang = SymbolLanguage::CXX;
245       break;
246     case Decl::CXXConstructor: {
247       Info.Kind = SymbolKind::Constructor;
248       Info.Lang = SymbolLanguage::CXX;
249       auto *CD = cast<CXXConstructorDecl>(D);
250       if (CD->isCopyConstructor())
251         Info.SubKind = SymbolSubKind::CXXCopyConstructor;
252       else if (CD->isMoveConstructor())
253         Info.SubKind = SymbolSubKind::CXXMoveConstructor;
254       break;
255     }
256     case Decl::CXXDestructor:
257       Info.Kind = SymbolKind::Destructor;
258       Info.Lang = SymbolLanguage::CXX;
259       break;
260     case Decl::CXXConversion:
261       Info.Kind = SymbolKind::ConversionFunction;
262       Info.Lang = SymbolLanguage::CXX;
263       break;
264     case Decl::CXXMethod: {
265       const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
266       if (MD->isStatic())
267         Info.Kind = SymbolKind::StaticMethod;
268       else
269         Info.Kind = SymbolKind::InstanceMethod;
270       Info.Lang = SymbolLanguage::CXX;
271       break;
272     }
273     case Decl::ClassTemplate:
274       Info.Kind = SymbolKind::Class;
275       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
276       Info.Lang = SymbolLanguage::CXX;
277       break;
278     case Decl::FunctionTemplate:
279       Info.Kind = SymbolKind::Function;
280       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
281       Info.Lang = SymbolLanguage::CXX;
282       if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(
283                            cast<FunctionTemplateDecl>(D)->getTemplatedDecl())) {
284         if (isa<CXXConstructorDecl>(MD))
285           Info.Kind = SymbolKind::Constructor;
286         else if (isa<CXXDestructorDecl>(MD))
287           Info.Kind = SymbolKind::Destructor;
288         else if (isa<CXXConversionDecl>(MD))
289           Info.Kind = SymbolKind::ConversionFunction;
290         else {
291           if (MD->isStatic())
292             Info.Kind = SymbolKind::StaticMethod;
293           else
294             Info.Kind = SymbolKind::InstanceMethod;
295         }
296       }
297       break;
298     case Decl::TypeAliasTemplate:
299       Info.Kind = SymbolKind::TypeAlias;
300       Info.Lang = SymbolLanguage::CXX;
301       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
302       break;
303     case Decl::TypeAlias:
304       Info.Kind = SymbolKind::TypeAlias;
305       Info.Lang = SymbolLanguage::CXX;
306       break;
307     case Decl::UnresolvedUsingTypename:
308       Info.Kind = SymbolKind::Using;
309       Info.SubKind = SymbolSubKind::UsingTypename;
310       Info.Lang = SymbolLanguage::CXX;
311       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
312       break;
313     case Decl::UnresolvedUsingValue:
314       Info.Kind = SymbolKind::Using;
315       Info.SubKind = SymbolSubKind::UsingValue;
316       Info.Lang = SymbolLanguage::CXX;
317       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
318       break;
319     case Decl::Binding:
320       Info.Kind = SymbolKind::Variable;
321       Info.Lang = SymbolLanguage::CXX;
322       break;
323     default:
324       break;
325     }
326   }
327 
328   if (Info.Kind == SymbolKind::Unknown)
329     return Info;
330 
331   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
332     if (FD->getTemplatedKind() ==
333           FunctionDecl::TK_FunctionTemplateSpecialization) {
334       Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
335       Info.Properties |=
336           (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
337     }
338   }
339 
340   if (Info.Properties & (SymbolPropertySet)SymbolProperty::Generic)
341     Info.Lang = SymbolLanguage::CXX;
342 
343   if (auto *attr = D->getExternalSourceSymbolAttr()) {
344     if (attr->getLanguage() == "Swift")
345       Info.Lang = SymbolLanguage::Swift;
346   }
347 
348   return Info;
349 }
350 
351 bool index::applyForEachSymbolRoleInterruptible(SymbolRoleSet Roles,
352                                    llvm::function_ref<bool(SymbolRole)> Fn) {
353 #define APPLY_FOR_ROLE(Role) \
354   if (Roles & (unsigned)SymbolRole::Role) \
355     if (!Fn(SymbolRole::Role)) \
356       return false;
357 
358   APPLY_FOR_ROLE(Declaration);
359   APPLY_FOR_ROLE(Definition);
360   APPLY_FOR_ROLE(Reference);
361   APPLY_FOR_ROLE(Read);
362   APPLY_FOR_ROLE(Write);
363   APPLY_FOR_ROLE(Call);
364   APPLY_FOR_ROLE(Dynamic);
365   APPLY_FOR_ROLE(AddressOf);
366   APPLY_FOR_ROLE(Implicit);
367   APPLY_FOR_ROLE(RelationChildOf);
368   APPLY_FOR_ROLE(RelationBaseOf);
369   APPLY_FOR_ROLE(RelationOverrideOf);
370   APPLY_FOR_ROLE(RelationReceivedBy);
371   APPLY_FOR_ROLE(RelationCalledBy);
372   APPLY_FOR_ROLE(RelationExtendedBy);
373   APPLY_FOR_ROLE(RelationAccessorOf);
374   APPLY_FOR_ROLE(RelationContainedBy);
375   APPLY_FOR_ROLE(RelationIBTypeOf);
376   APPLY_FOR_ROLE(RelationSpecializationOf);
377 
378 #undef APPLY_FOR_ROLE
379 
380   return true;
381 }
382 
383 void index::applyForEachSymbolRole(SymbolRoleSet Roles,
384                                    llvm::function_ref<void(SymbolRole)> Fn) {
385   applyForEachSymbolRoleInterruptible(Roles, [&](SymbolRole r) -> bool {
386     Fn(r);
387     return true;
388   });
389 }
390 
391 void index::printSymbolRoles(SymbolRoleSet Roles, raw_ostream &OS) {
392   bool VisitedOnce = false;
393   applyForEachSymbolRole(Roles, [&](SymbolRole Role) {
394     if (VisitedOnce)
395       OS << ',';
396     else
397       VisitedOnce = true;
398     switch (Role) {
399     case SymbolRole::Declaration: OS << "Decl"; break;
400     case SymbolRole::Definition: OS << "Def"; break;
401     case SymbolRole::Reference: OS << "Ref"; break;
402     case SymbolRole::Read: OS << "Read"; break;
403     case SymbolRole::Write: OS << "Writ"; break;
404     case SymbolRole::Call: OS << "Call"; break;
405     case SymbolRole::Dynamic: OS << "Dyn"; break;
406     case SymbolRole::AddressOf: OS << "Addr"; break;
407     case SymbolRole::Implicit: OS << "Impl"; break;
408     case SymbolRole::RelationChildOf: OS << "RelChild"; break;
409     case SymbolRole::RelationBaseOf: OS << "RelBase"; break;
410     case SymbolRole::RelationOverrideOf: OS << "RelOver"; break;
411     case SymbolRole::RelationReceivedBy: OS << "RelRec"; break;
412     case SymbolRole::RelationCalledBy: OS << "RelCall"; break;
413     case SymbolRole::RelationExtendedBy: OS << "RelExt"; break;
414     case SymbolRole::RelationAccessorOf: OS << "RelAcc"; break;
415     case SymbolRole::RelationContainedBy: OS << "RelCont"; break;
416     case SymbolRole::RelationIBTypeOf: OS << "RelIBType"; break;
417     case SymbolRole::RelationSpecializationOf: OS << "RelSpecialization"; break;
418     }
419   });
420 }
421 
422 bool index::printSymbolName(const Decl *D, const LangOptions &LO,
423                             raw_ostream &OS) {
424   if (auto *ND = dyn_cast<NamedDecl>(D)) {
425     PrintingPolicy Policy(LO);
426     // Forward references can have different template argument names. Suppress
427     // the template argument names in constructors to make their name more
428     // stable.
429     Policy.SuppressTemplateArgsInCXXConstructors = true;
430     DeclarationName DeclName = ND->getDeclName();
431     if (DeclName.isEmpty())
432       return true;
433     DeclName.print(OS, Policy);
434     return false;
435   } else {
436     return true;
437   }
438 }
439 
440 StringRef index::getSymbolKindString(SymbolKind K) {
441   switch (K) {
442   case SymbolKind::Unknown: return "<unknown>";
443   case SymbolKind::Module: return "module";
444   case SymbolKind::Namespace: return "namespace";
445   case SymbolKind::NamespaceAlias: return "namespace-alias";
446   case SymbolKind::Macro: return "macro";
447   case SymbolKind::Enum: return "enum";
448   case SymbolKind::Struct: return "struct";
449   case SymbolKind::Class: return "class";
450   case SymbolKind::Protocol: return "protocol";
451   case SymbolKind::Extension: return "extension";
452   case SymbolKind::Union: return "union";
453   case SymbolKind::TypeAlias: return "type-alias";
454   case SymbolKind::Function: return "function";
455   case SymbolKind::Variable: return "variable";
456   case SymbolKind::Field: return "field";
457   case SymbolKind::EnumConstant: return "enumerator";
458   case SymbolKind::InstanceMethod: return "instance-method";
459   case SymbolKind::ClassMethod: return "class-method";
460   case SymbolKind::StaticMethod: return "static-method";
461   case SymbolKind::InstanceProperty: return "instance-property";
462   case SymbolKind::ClassProperty: return "class-property";
463   case SymbolKind::StaticProperty: return "static-property";
464   case SymbolKind::Constructor: return "constructor";
465   case SymbolKind::Destructor: return "destructor";
466   case SymbolKind::ConversionFunction: return "coversion-func";
467   case SymbolKind::Parameter: return "param";
468   case SymbolKind::Using: return "using";
469   }
470   llvm_unreachable("invalid symbol kind");
471 }
472 
473 StringRef index::getSymbolSubKindString(SymbolSubKind K) {
474   switch (K) {
475   case SymbolSubKind::None: return "<none>";
476   case SymbolSubKind::CXXCopyConstructor: return "cxx-copy-ctor";
477   case SymbolSubKind::CXXMoveConstructor: return "cxx-move-ctor";
478   case SymbolSubKind::AccessorGetter: return "acc-get";
479   case SymbolSubKind::AccessorSetter: return "acc-set";
480   case SymbolSubKind::UsingTypename: return "using-typename";
481   case SymbolSubKind::UsingValue: return "using-value";
482   }
483   llvm_unreachable("invalid symbol subkind");
484 }
485 
486 StringRef index::getSymbolLanguageString(SymbolLanguage K) {
487   switch (K) {
488   case SymbolLanguage::C: return "C";
489   case SymbolLanguage::ObjC: return "ObjC";
490   case SymbolLanguage::CXX: return "C++";
491   case SymbolLanguage::Swift: return "Swift";
492   }
493   llvm_unreachable("invalid symbol language kind");
494 }
495 
496 void index::applyForEachSymbolProperty(SymbolPropertySet Props,
497                                   llvm::function_ref<void(SymbolProperty)> Fn) {
498 #define APPLY_FOR_PROPERTY(K)                                                  \
499   if (Props & (SymbolPropertySet)SymbolProperty::K)                            \
500   Fn(SymbolProperty::K)
501 
502   APPLY_FOR_PROPERTY(Generic);
503   APPLY_FOR_PROPERTY(TemplatePartialSpecialization);
504   APPLY_FOR_PROPERTY(TemplateSpecialization);
505   APPLY_FOR_PROPERTY(UnitTest);
506   APPLY_FOR_PROPERTY(IBAnnotated);
507   APPLY_FOR_PROPERTY(IBOutletCollection);
508   APPLY_FOR_PROPERTY(GKInspectable);
509   APPLY_FOR_PROPERTY(Local);
510 
511 #undef APPLY_FOR_PROPERTY
512 }
513 
514 void index::printSymbolProperties(SymbolPropertySet Props, raw_ostream &OS) {
515   bool VisitedOnce = false;
516   applyForEachSymbolProperty(Props, [&](SymbolProperty Prop) {
517     if (VisitedOnce)
518       OS << ',';
519     else
520       VisitedOnce = true;
521     switch (Prop) {
522     case SymbolProperty::Generic: OS << "Gen"; break;
523     case SymbolProperty::TemplatePartialSpecialization: OS << "TPS"; break;
524     case SymbolProperty::TemplateSpecialization: OS << "TS"; break;
525     case SymbolProperty::UnitTest: OS << "test"; break;
526     case SymbolProperty::IBAnnotated: OS << "IB"; break;
527     case SymbolProperty::IBOutletCollection: OS << "IBColl"; break;
528     case SymbolProperty::GKInspectable: OS << "GKI"; break;
529     case SymbolProperty::Local: OS << "local"; break;
530     }
531   });
532 }
533