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