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 |= (unsigned)SymbolProperty::IBAnnotated;
46   } else if (D->hasAttr<IBOutletCollectionAttr>()) {
47     PropSet |= (unsigned)SymbolProperty::IBAnnotated;
48     PropSet |= (unsigned)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 |= (unsigned)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 |= (unsigned)SymbolProperty::Generic;
122         }
123       }
124     }
125 
126     if (isa<ClassTemplatePartialSpecializationDecl>(D)) {
127       Info.Properties |= (unsigned)SymbolProperty::Generic;
128       Info.Properties |= (unsigned)SymbolProperty::TemplatePartialSpecialization;
129     } else if (isa<ClassTemplateSpecializationDecl>(D)) {
130       Info.Properties |= (unsigned)SymbolProperty::Generic;
131       Info.Properties |= (unsigned)SymbolProperty::TemplateSpecialization;
132     }
133 
134   } else if (auto *VD = dyn_cast<VarDecl>(D)) {
135     Info.Kind = SymbolKind::Variable;
136     if (isa<ParmVarDecl>(D)) {
137       Info.Kind = SymbolKind::Parameter;
138     } else if (isa<CXXRecordDecl>(D->getDeclContext())) {
139       Info.Kind = SymbolKind::StaticProperty;
140       Info.Lang = SymbolLanguage::CXX;
141     }
142 
143     if (isa<VarTemplatePartialSpecializationDecl>(D)) {
144       Info.Lang = SymbolLanguage::CXX;
145       Info.Properties |= (unsigned)SymbolProperty::Generic;
146       Info.Properties |= (unsigned)SymbolProperty::TemplatePartialSpecialization;
147     } else if (isa<VarTemplateSpecializationDecl>(D)) {
148       Info.Lang = SymbolLanguage::CXX;
149       Info.Properties |= (unsigned)SymbolProperty::Generic;
150       Info.Properties |= (unsigned)SymbolProperty::TemplateSpecialization;
151     } else if (VD->getDescribedVarTemplate()) {
152       Info.Lang = SymbolLanguage::CXX;
153       Info.Properties |= (unsigned)SymbolProperty::Generic;
154     }
155 
156   } else {
157     switch (D->getKind()) {
158     case Decl::Import:
159       Info.Kind = SymbolKind::Module;
160       break;
161     case Decl::Typedef:
162       Info.Kind = SymbolKind::TypeAlias; break; // Lang = C
163     case Decl::Function:
164       Info.Kind = SymbolKind::Function;
165       break;
166     case Decl::Field:
167       Info.Kind = SymbolKind::Field;
168       if (const CXXRecordDecl *
169             CXXRec = dyn_cast<CXXRecordDecl>(D->getDeclContext())) {
170         if (!CXXRec->isCLike())
171           Info.Lang = SymbolLanguage::CXX;
172       }
173       break;
174     case Decl::EnumConstant:
175       Info.Kind = SymbolKind::EnumConstant; break;
176     case Decl::ObjCInterface:
177     case Decl::ObjCImplementation: {
178       Info.Kind = SymbolKind::Class;
179       Info.Lang = SymbolLanguage::ObjC;
180       const ObjCInterfaceDecl *ClsD = dyn_cast<ObjCInterfaceDecl>(D);
181       if (!ClsD)
182         ClsD = cast<ObjCImplementationDecl>(D)->getClassInterface();
183       if (isUnitTestCase(ClsD))
184         Info.Properties |= (unsigned)SymbolProperty::UnitTest;
185       break;
186     }
187     case Decl::ObjCProtocol:
188       Info.Kind = SymbolKind::Protocol;
189       Info.Lang = SymbolLanguage::ObjC;
190       break;
191     case Decl::ObjCCategory:
192     case Decl::ObjCCategoryImpl: {
193       Info.Kind = SymbolKind::Extension;
194       Info.Lang = SymbolLanguage::ObjC;
195       const ObjCInterfaceDecl *ClsD = nullptr;
196       if (auto *CatD = dyn_cast<ObjCCategoryDecl>(D))
197         ClsD = CatD->getClassInterface();
198       else
199         ClsD = cast<ObjCCategoryImplDecl>(D)->getClassInterface();
200       if (isUnitTestCase(ClsD))
201         Info.Properties |= (unsigned)SymbolProperty::UnitTest;
202       break;
203     }
204     case Decl::ObjCMethod:
205       if (cast<ObjCMethodDecl>(D)->isInstanceMethod()) {
206         const ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D);
207         Info.Kind = SymbolKind::InstanceMethod;
208         if (MD->isPropertyAccessor()) {
209           if (MD->param_size())
210             Info.SubKind = SymbolSubKind::AccessorSetter;
211           else
212             Info.SubKind = SymbolSubKind::AccessorGetter;
213         }
214       } else {
215         Info.Kind = SymbolKind::ClassMethod;
216       }
217       Info.Lang = SymbolLanguage::ObjC;
218       if (isUnitTest(cast<ObjCMethodDecl>(D)))
219         Info.Properties |= (unsigned)SymbolProperty::UnitTest;
220       if (D->hasAttr<IBActionAttr>())
221         Info.Properties |= (unsigned)SymbolProperty::IBAnnotated;
222       break;
223     case Decl::ObjCProperty:
224       Info.Kind = SymbolKind::InstanceProperty;
225       Info.Lang = SymbolLanguage::ObjC;
226       checkForIBOutlets(D, Info.Properties);
227       if (auto *Annot = D->getAttr<AnnotateAttr>()) {
228         if (Annot->getAnnotation() == "gk_inspectable")
229           Info.Properties |= (unsigned)SymbolProperty::GKInspectable;
230       }
231       break;
232     case Decl::ObjCIvar:
233       Info.Kind = SymbolKind::Field;
234       Info.Lang = SymbolLanguage::ObjC;
235       checkForIBOutlets(D, Info.Properties);
236       break;
237     case Decl::Namespace:
238       Info.Kind = SymbolKind::Namespace;
239       Info.Lang = SymbolLanguage::CXX;
240       break;
241     case Decl::NamespaceAlias:
242       Info.Kind = SymbolKind::NamespaceAlias;
243       Info.Lang = SymbolLanguage::CXX;
244       break;
245     case Decl::CXXConstructor: {
246       Info.Kind = SymbolKind::Constructor;
247       Info.Lang = SymbolLanguage::CXX;
248       auto *CD = cast<CXXConstructorDecl>(D);
249       if (CD->isCopyConstructor())
250         Info.SubKind = SymbolSubKind::CXXCopyConstructor;
251       else if (CD->isMoveConstructor())
252         Info.SubKind = SymbolSubKind::CXXMoveConstructor;
253       break;
254     }
255     case Decl::CXXDestructor:
256       Info.Kind = SymbolKind::Destructor;
257       Info.Lang = SymbolLanguage::CXX;
258       break;
259     case Decl::CXXConversion:
260       Info.Kind = SymbolKind::ConversionFunction;
261       Info.Lang = SymbolLanguage::CXX;
262       break;
263     case Decl::CXXMethod: {
264       const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
265       if (MD->isStatic())
266         Info.Kind = SymbolKind::StaticMethod;
267       else
268         Info.Kind = SymbolKind::InstanceMethod;
269       Info.Lang = SymbolLanguage::CXX;
270       break;
271     }
272     case Decl::ClassTemplate:
273       Info.Kind = SymbolKind::Class;
274       Info.Properties |= (unsigned)SymbolProperty::Generic;
275       Info.Lang = SymbolLanguage::CXX;
276       break;
277     case Decl::FunctionTemplate:
278       Info.Kind = SymbolKind::Function;
279       Info.Properties |= (unsigned)SymbolProperty::Generic;
280       Info.Lang = SymbolLanguage::CXX;
281       if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(
282                            cast<FunctionTemplateDecl>(D)->getTemplatedDecl())) {
283         if (isa<CXXConstructorDecl>(MD))
284           Info.Kind = SymbolKind::Constructor;
285         else if (isa<CXXDestructorDecl>(MD))
286           Info.Kind = SymbolKind::Destructor;
287         else if (isa<CXXConversionDecl>(MD))
288           Info.Kind = SymbolKind::ConversionFunction;
289         else {
290           if (MD->isStatic())
291             Info.Kind = SymbolKind::StaticMethod;
292           else
293             Info.Kind = SymbolKind::InstanceMethod;
294         }
295       }
296       break;
297     case Decl::TypeAliasTemplate:
298       Info.Kind = SymbolKind::TypeAlias;
299       Info.Lang = SymbolLanguage::CXX;
300       Info.Properties |= (unsigned)SymbolProperty::Generic;
301       break;
302     case Decl::TypeAlias:
303       Info.Kind = SymbolKind::TypeAlias;
304       Info.Lang = SymbolLanguage::CXX;
305       break;
306     case Decl::Binding:
307       Info.Kind = SymbolKind::Variable;
308       Info.Lang = SymbolLanguage::CXX;
309       break;
310     default:
311       break;
312     }
313   }
314 
315   if (Info.Kind == SymbolKind::Unknown)
316     return Info;
317 
318   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
319     if (FD->getTemplatedKind() ==
320           FunctionDecl::TK_FunctionTemplateSpecialization) {
321       Info.Properties |= (unsigned)SymbolProperty::Generic;
322       Info.Properties |= (unsigned)SymbolProperty::TemplateSpecialization;
323     }
324   }
325 
326   if (Info.Properties & (unsigned)SymbolProperty::Generic)
327     Info.Lang = SymbolLanguage::CXX;
328 
329   if (auto *attr = D->getExternalSourceSymbolAttr()) {
330     if (attr->getLanguage() == "Swift")
331       Info.Lang = SymbolLanguage::Swift;
332   }
333 
334   return Info;
335 }
336 
337 bool index::applyForEachSymbolRoleInterruptible(SymbolRoleSet Roles,
338                                    llvm::function_ref<bool(SymbolRole)> Fn) {
339 #define APPLY_FOR_ROLE(Role) \
340   if (Roles & (unsigned)SymbolRole::Role) \
341     if (!Fn(SymbolRole::Role)) \
342       return false;
343 
344   APPLY_FOR_ROLE(Declaration);
345   APPLY_FOR_ROLE(Definition);
346   APPLY_FOR_ROLE(Reference);
347   APPLY_FOR_ROLE(Read);
348   APPLY_FOR_ROLE(Write);
349   APPLY_FOR_ROLE(Call);
350   APPLY_FOR_ROLE(Dynamic);
351   APPLY_FOR_ROLE(AddressOf);
352   APPLY_FOR_ROLE(Implicit);
353   APPLY_FOR_ROLE(RelationChildOf);
354   APPLY_FOR_ROLE(RelationBaseOf);
355   APPLY_FOR_ROLE(RelationOverrideOf);
356   APPLY_FOR_ROLE(RelationReceivedBy);
357   APPLY_FOR_ROLE(RelationCalledBy);
358   APPLY_FOR_ROLE(RelationExtendedBy);
359   APPLY_FOR_ROLE(RelationAccessorOf);
360   APPLY_FOR_ROLE(RelationContainedBy);
361   APPLY_FOR_ROLE(RelationIBTypeOf);
362   APPLY_FOR_ROLE(RelationSpecializationOf);
363 
364 #undef APPLY_FOR_ROLE
365 
366   return true;
367 }
368 
369 void index::applyForEachSymbolRole(SymbolRoleSet Roles,
370                                    llvm::function_ref<void(SymbolRole)> Fn) {
371   applyForEachSymbolRoleInterruptible(Roles, [&](SymbolRole r) -> bool {
372     Fn(r);
373     return true;
374   });
375 }
376 
377 void index::printSymbolRoles(SymbolRoleSet Roles, raw_ostream &OS) {
378   bool VisitedOnce = false;
379   applyForEachSymbolRole(Roles, [&](SymbolRole Role) {
380     if (VisitedOnce)
381       OS << ',';
382     else
383       VisitedOnce = true;
384     switch (Role) {
385     case SymbolRole::Declaration: OS << "Decl"; break;
386     case SymbolRole::Definition: OS << "Def"; break;
387     case SymbolRole::Reference: OS << "Ref"; break;
388     case SymbolRole::Read: OS << "Read"; break;
389     case SymbolRole::Write: OS << "Writ"; break;
390     case SymbolRole::Call: OS << "Call"; break;
391     case SymbolRole::Dynamic: OS << "Dyn"; break;
392     case SymbolRole::AddressOf: OS << "Addr"; break;
393     case SymbolRole::Implicit: OS << "Impl"; break;
394     case SymbolRole::RelationChildOf: OS << "RelChild"; break;
395     case SymbolRole::RelationBaseOf: OS << "RelBase"; break;
396     case SymbolRole::RelationOverrideOf: OS << "RelOver"; break;
397     case SymbolRole::RelationReceivedBy: OS << "RelRec"; break;
398     case SymbolRole::RelationCalledBy: OS << "RelCall"; break;
399     case SymbolRole::RelationExtendedBy: OS << "RelExt"; break;
400     case SymbolRole::RelationAccessorOf: OS << "RelAcc"; break;
401     case SymbolRole::RelationContainedBy: OS << "RelCont"; break;
402     case SymbolRole::RelationIBTypeOf: OS << "RelIBType"; break;
403     case SymbolRole::RelationSpecializationOf: OS << "RelSpecialization"; break;
404     }
405   });
406 }
407 
408 bool index::printSymbolName(const Decl *D, const LangOptions &LO,
409                             raw_ostream &OS) {
410   if (auto *ND = dyn_cast<NamedDecl>(D)) {
411     PrintingPolicy Policy(LO);
412     // Forward references can have different template argument names. Suppress
413     // the template argument names in constructors to make their name more
414     // stable.
415     Policy.SuppressTemplateArgsInCXXConstructors = true;
416     DeclarationName DeclName = ND->getDeclName();
417     if (DeclName.isEmpty())
418       return true;
419     DeclName.print(OS, Policy);
420     return false;
421   } else {
422     return true;
423   }
424 }
425 
426 StringRef index::getSymbolKindString(SymbolKind K) {
427   switch (K) {
428   case SymbolKind::Unknown: return "<unknown>";
429   case SymbolKind::Module: return "module";
430   case SymbolKind::Namespace: return "namespace";
431   case SymbolKind::NamespaceAlias: return "namespace-alias";
432   case SymbolKind::Macro: return "macro";
433   case SymbolKind::Enum: return "enum";
434   case SymbolKind::Struct: return "struct";
435   case SymbolKind::Class: return "class";
436   case SymbolKind::Protocol: return "protocol";
437   case SymbolKind::Extension: return "extension";
438   case SymbolKind::Union: return "union";
439   case SymbolKind::TypeAlias: return "type-alias";
440   case SymbolKind::Function: return "function";
441   case SymbolKind::Variable: return "variable";
442   case SymbolKind::Field: return "field";
443   case SymbolKind::EnumConstant: return "enumerator";
444   case SymbolKind::InstanceMethod: return "instance-method";
445   case SymbolKind::ClassMethod: return "class-method";
446   case SymbolKind::StaticMethod: return "static-method";
447   case SymbolKind::InstanceProperty: return "instance-property";
448   case SymbolKind::ClassProperty: return "class-property";
449   case SymbolKind::StaticProperty: return "static-property";
450   case SymbolKind::Constructor: return "constructor";
451   case SymbolKind::Destructor: return "destructor";
452   case SymbolKind::ConversionFunction: return "coversion-func";
453   case SymbolKind::Parameter: return "param";
454   }
455   llvm_unreachable("invalid symbol kind");
456 }
457 
458 StringRef index::getSymbolSubKindString(SymbolSubKind K) {
459   switch (K) {
460   case SymbolSubKind::None: return "<none>";
461   case SymbolSubKind::CXXCopyConstructor: return "cxx-copy-ctor";
462   case SymbolSubKind::CXXMoveConstructor: return "cxx-move-ctor";
463   case SymbolSubKind::AccessorGetter: return "acc-get";
464   case SymbolSubKind::AccessorSetter: return "acc-set";
465   }
466   llvm_unreachable("invalid symbol subkind");
467 }
468 
469 StringRef index::getSymbolLanguageString(SymbolLanguage K) {
470   switch (K) {
471   case SymbolLanguage::C: return "C";
472   case SymbolLanguage::ObjC: return "ObjC";
473   case SymbolLanguage::CXX: return "C++";
474   case SymbolLanguage::Swift: return "Swift";
475   }
476   llvm_unreachable("invalid symbol language kind");
477 }
478 
479 void index::applyForEachSymbolProperty(SymbolPropertySet Props,
480                                   llvm::function_ref<void(SymbolProperty)> Fn) {
481 #define APPLY_FOR_PROPERTY(K) \
482   if (Props & (unsigned)SymbolProperty::K) \
483     Fn(SymbolProperty::K)
484 
485   APPLY_FOR_PROPERTY(Generic);
486   APPLY_FOR_PROPERTY(TemplatePartialSpecialization);
487   APPLY_FOR_PROPERTY(TemplateSpecialization);
488   APPLY_FOR_PROPERTY(UnitTest);
489   APPLY_FOR_PROPERTY(IBAnnotated);
490   APPLY_FOR_PROPERTY(IBOutletCollection);
491   APPLY_FOR_PROPERTY(GKInspectable);
492   APPLY_FOR_PROPERTY(Local);
493 
494 #undef APPLY_FOR_PROPERTY
495 }
496 
497 void index::printSymbolProperties(SymbolPropertySet Props, raw_ostream &OS) {
498   bool VisitedOnce = false;
499   applyForEachSymbolProperty(Props, [&](SymbolProperty Prop) {
500     if (VisitedOnce)
501       OS << ',';
502     else
503       VisitedOnce = true;
504     switch (Prop) {
505     case SymbolProperty::Generic: OS << "Gen"; break;
506     case SymbolProperty::TemplatePartialSpecialization: OS << "TPS"; break;
507     case SymbolProperty::TemplateSpecialization: OS << "TS"; break;
508     case SymbolProperty::UnitTest: OS << "test"; break;
509     case SymbolProperty::IBAnnotated: OS << "IB"; break;
510     case SymbolProperty::IBOutletCollection: OS << "IBColl"; break;
511     case SymbolProperty::GKInspectable: OS << "GKI"; break;
512     case SymbolProperty::Local: OS << "local"; break;
513     }
514   });
515 }
516