blob: 5165567ff75eb9cdff04e762f96cd31c3aae017f [file] [log] [blame]
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +00001//===--- IndexSymbol.cpp - Types and functions for indexing symbols -------===//
2//
Chandler Carruth324f9182019-01-19 08:50:56 +00003// 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
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +00006//
7//===----------------------------------------------------------------------===//
8
9#include "clang/Index/IndexSymbol.h"
10#include "clang/AST/DeclCXX.h"
11#include "clang/AST/DeclObjC.h"
12#include "clang/AST/DeclTemplate.h"
Argyrios Kyrtzidis1c8c4712016-02-15 01:32:36 +000013#include "clang/AST/PrettyPrinter.h"
Eric Liu8576df52018-07-09 08:44:05 +000014#include "clang/Lex/MacroInfo.h"
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +000015
16using namespace clang;
17using namespace clang::index;
18
Argyrios Kyrtzidis17e80202016-04-22 07:21:10 +000019/// \returns true if \c D is a subclass of 'XCTestCase'.
20static 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'.
33static 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
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +000043static void checkForIBOutlets(const Decl *D, SymbolPropertySet &PropSet) {
Argyrios Kyrtzidis9a54e812016-04-22 07:21:16 +000044 if (D->hasAttr<IBOutletAttr>()) {
Sam McCall48fa9ac2017-12-23 19:31:24 +000045 PropSet |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
Argyrios Kyrtzidis9a54e812016-04-22 07:21:16 +000046 } else if (D->hasAttr<IBOutletCollectionAttr>()) {
Sam McCall48fa9ac2017-12-23 19:31:24 +000047 PropSet |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
48 PropSet |= (SymbolPropertySet)SymbolProperty::IBOutletCollection;
Argyrios Kyrtzidis9a54e812016-04-22 07:21:16 +000049 }
50}
51
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000052bool index::isFunctionLocalSymbol(const Decl *D) {
53 assert(D);
54
55 if (isa<ParmVarDecl>(D))
56 return true;
57
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000058 if (isa<ObjCTypeParamDecl>(D))
59 return true;
60
Alex Lorenzd22768f2017-05-22 14:39:39 +000061 if (isa<UsingDirectiveDecl>(D))
62 return false;
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000063 if (!D->getParentFunctionOrMethod())
64 return false;
65
66 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
67 switch (ND->getFormalLinkage()) {
68 case NoLinkage:
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000069 case InternalLinkage:
70 return true;
Richard Smithaffbdbb2017-07-07 20:04:28 +000071 case VisibleNoLinkage:
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000072 case UniqueExternalLinkage:
Richard Smithaffbdbb2017-07-07 20:04:28 +000073 case ModuleInternalLinkage:
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000074 llvm_unreachable("Not a sema linkage");
Richard Smithaffbdbb2017-07-07 20:04:28 +000075 case ModuleLinkage:
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000076 case ExternalLinkage:
77 return false;
78 }
79 }
80
81 return true;
82}
83
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +000084SymbolInfo index::getSymbolInfo(const Decl *D) {
85 assert(D);
86 SymbolInfo Info;
87 Info.Kind = SymbolKind::Unknown;
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +000088 Info.SubKind = SymbolSubKind::None;
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +000089 Info.Properties = SymbolPropertySet();
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +000090 Info.Lang = SymbolLanguage::C;
91
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000092 if (isFunctionLocalSymbol(D)) {
Sam McCall48fa9ac2017-12-23 19:31:24 +000093 Info.Properties |= (SymbolPropertySet)SymbolProperty::Local;
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000094 }
Argyrios Kyrtzidis1e8f9cd2018-08-26 06:27:23 +000095 if (isa<ObjCProtocolDecl>(D->getDeclContext())) {
96 Info.Properties |= (SymbolPropertySet)SymbolProperty::ProtocolInterface;
97 }
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +000098
Ilya Biryukov93cc0ae2019-05-29 17:49:30 +000099 if (auto *VT = dyn_cast<VarTemplateDecl>(D)) {
100 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
101 Info.Lang = SymbolLanguage::CXX;
102 // All other fields are filled from the templated decl.
103 D = VT->getTemplatedDecl();
104 }
105
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000106 if (const TagDecl *TD = dyn_cast<TagDecl>(D)) {
107 switch (TD->getTagKind()) {
108 case TTK_Struct:
109 Info.Kind = SymbolKind::Struct; break;
110 case TTK_Union:
111 Info.Kind = SymbolKind::Union; break;
112 case TTK_Class:
Ben Langmuireacdb142016-03-25 17:01:59 +0000113 Info.Kind = SymbolKind::Class;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000114 Info.Lang = SymbolLanguage::CXX;
115 break;
116 case TTK_Interface:
Ben Langmuireacdb142016-03-25 17:01:59 +0000117 Info.Kind = SymbolKind::Protocol;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000118 Info.Lang = SymbolLanguage::CXX;
119 break;
120 case TTK_Enum:
121 Info.Kind = SymbolKind::Enum; break;
122 }
123
Argyrios Kyrtzidiscf55f262016-11-07 21:20:08 +0000124 if (const CXXRecordDecl *CXXRec = dyn_cast<CXXRecordDecl>(D)) {
125 if (!CXXRec->isCLike()) {
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000126 Info.Lang = SymbolLanguage::CXX;
Argyrios Kyrtzidiscf55f262016-11-07 21:20:08 +0000127 if (CXXRec->getDescribedClassTemplate()) {
Sam McCall48fa9ac2017-12-23 19:31:24 +0000128 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Argyrios Kyrtzidiscf55f262016-11-07 21:20:08 +0000129 }
130 }
131 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000132
133 if (isa<ClassTemplatePartialSpecializationDecl>(D)) {
Sam McCall48fa9ac2017-12-23 19:31:24 +0000134 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
135 Info.Properties |=
136 (SymbolPropertySet)SymbolProperty::TemplatePartialSpecialization;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000137 } else if (isa<ClassTemplateSpecializationDecl>(D)) {
Sam McCall48fa9ac2017-12-23 19:31:24 +0000138 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
139 Info.Properties |=
140 (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000141 }
142
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000143 } else if (auto *VD = dyn_cast<VarDecl>(D)) {
144 Info.Kind = SymbolKind::Variable;
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +0000145 if (isa<ParmVarDecl>(D)) {
146 Info.Kind = SymbolKind::Parameter;
147 } else if (isa<CXXRecordDecl>(D->getDeclContext())) {
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000148 Info.Kind = SymbolKind::StaticProperty;
149 Info.Lang = SymbolLanguage::CXX;
150 }
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +0000151
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000152 if (isa<VarTemplatePartialSpecializationDecl>(D)) {
153 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000154 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
155 Info.Properties |=
156 (SymbolPropertySet)SymbolProperty::TemplatePartialSpecialization;
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000157 } else if (isa<VarTemplateSpecializationDecl>(D)) {
158 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000159 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
160 Info.Properties |=
161 (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000162 } else if (VD->getDescribedVarTemplate()) {
163 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000164 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Argyrios Kyrtzidis0e2326e2016-11-07 21:20:15 +0000165 }
166
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000167 } else {
168 switch (D->getKind()) {
Argyrios Kyrtzidiscf6bc2f2016-02-29 07:56:07 +0000169 case Decl::Import:
170 Info.Kind = SymbolKind::Module;
171 break;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000172 case Decl::Typedef:
Ben Langmuireacdb142016-03-25 17:01:59 +0000173 Info.Kind = SymbolKind::TypeAlias; break; // Lang = C
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000174 case Decl::Function:
175 Info.Kind = SymbolKind::Function;
176 break;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000177 case Decl::Field:
Ilya Biryukova77a1652019-05-29 10:11:14 +0000178 case Decl::IndirectField:
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000179 Info.Kind = SymbolKind::Field;
180 if (const CXXRecordDecl *
181 CXXRec = dyn_cast<CXXRecordDecl>(D->getDeclContext())) {
182 if (!CXXRec->isCLike())
183 Info.Lang = SymbolLanguage::CXX;
184 }
185 break;
186 case Decl::EnumConstant:
187 Info.Kind = SymbolKind::EnumConstant; break;
188 case Decl::ObjCInterface:
Argyrios Kyrtzidis17e80202016-04-22 07:21:10 +0000189 case Decl::ObjCImplementation: {
Ben Langmuireacdb142016-03-25 17:01:59 +0000190 Info.Kind = SymbolKind::Class;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000191 Info.Lang = SymbolLanguage::ObjC;
Argyrios Kyrtzidis17e80202016-04-22 07:21:10 +0000192 const ObjCInterfaceDecl *ClsD = dyn_cast<ObjCInterfaceDecl>(D);
193 if (!ClsD)
194 ClsD = cast<ObjCImplementationDecl>(D)->getClassInterface();
195 if (isUnitTestCase(ClsD))
Sam McCall48fa9ac2017-12-23 19:31:24 +0000196 Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000197 break;
Argyrios Kyrtzidis17e80202016-04-22 07:21:10 +0000198 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000199 case Decl::ObjCProtocol:
Ben Langmuireacdb142016-03-25 17:01:59 +0000200 Info.Kind = SymbolKind::Protocol;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000201 Info.Lang = SymbolLanguage::ObjC;
202 break;
203 case Decl::ObjCCategory:
Argyrios Kyrtzidis0bfb9a52017-03-07 09:38:08 +0000204 case Decl::ObjCCategoryImpl: {
Ben Langmuireacdb142016-03-25 17:01:59 +0000205 Info.Kind = SymbolKind::Extension;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000206 Info.Lang = SymbolLanguage::ObjC;
Argyrios Kyrtzidis0bfb9a52017-03-07 09:38:08 +0000207 const ObjCInterfaceDecl *ClsD = nullptr;
208 if (auto *CatD = dyn_cast<ObjCCategoryDecl>(D))
209 ClsD = CatD->getClassInterface();
210 else
211 ClsD = cast<ObjCCategoryImplDecl>(D)->getClassInterface();
212 if (isUnitTestCase(ClsD))
Sam McCall48fa9ac2017-12-23 19:31:24 +0000213 Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000214 break;
Argyrios Kyrtzidis0bfb9a52017-03-07 09:38:08 +0000215 }
Ben Langmuira50011f2017-07-21 23:04:27 +0000216 case Decl::ObjCMethod: {
217 const ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D);
218 Info.Kind = MD->isInstanceMethod() ? SymbolKind::InstanceMethod : SymbolKind::ClassMethod;
219 if (MD->isPropertyAccessor()) {
220 if (MD->param_size())
221 Info.SubKind = SymbolSubKind::AccessorSetter;
222 else
223 Info.SubKind = SymbolSubKind::AccessorGetter;
Argyrios Kyrtzidis4a19ab52017-01-11 21:42:48 +0000224 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000225 Info.Lang = SymbolLanguage::ObjC;
Ben Langmuira50011f2017-07-21 23:04:27 +0000226 if (isUnitTest(MD))
Sam McCall48fa9ac2017-12-23 19:31:24 +0000227 Info.Properties |= (SymbolPropertySet)SymbolProperty::UnitTest;
Argyrios Kyrtzidis9a54e812016-04-22 07:21:16 +0000228 if (D->hasAttr<IBActionAttr>())
Sam McCall48fa9ac2017-12-23 19:31:24 +0000229 Info.Properties |= (SymbolPropertySet)SymbolProperty::IBAnnotated;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000230 break;
Ben Langmuira50011f2017-07-21 23:04:27 +0000231 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000232 case Decl::ObjCProperty:
Ben Langmuireacdb142016-03-25 17:01:59 +0000233 Info.Kind = SymbolKind::InstanceProperty;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000234 Info.Lang = SymbolLanguage::ObjC;
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000235 checkForIBOutlets(D, Info.Properties);
Argyrios Kyrtzidisb5e3c672016-11-10 23:27:11 +0000236 if (auto *Annot = D->getAttr<AnnotateAttr>()) {
237 if (Annot->getAnnotation() == "gk_inspectable")
Sam McCall48fa9ac2017-12-23 19:31:24 +0000238 Info.Properties |= (SymbolPropertySet)SymbolProperty::GKInspectable;
Argyrios Kyrtzidisb5e3c672016-11-10 23:27:11 +0000239 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000240 break;
241 case Decl::ObjCIvar:
Ben Langmuireacdb142016-03-25 17:01:59 +0000242 Info.Kind = SymbolKind::Field;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000243 Info.Lang = SymbolLanguage::ObjC;
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000244 checkForIBOutlets(D, Info.Properties);
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000245 break;
246 case Decl::Namespace:
Ben Langmuireacdb142016-03-25 17:01:59 +0000247 Info.Kind = SymbolKind::Namespace;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000248 Info.Lang = SymbolLanguage::CXX;
249 break;
250 case Decl::NamespaceAlias:
Ben Langmuireacdb142016-03-25 17:01:59 +0000251 Info.Kind = SymbolKind::NamespaceAlias;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000252 Info.Lang = SymbolLanguage::CXX;
253 break;
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +0000254 case Decl::CXXConstructor: {
Ben Langmuireacdb142016-03-25 17:01:59 +0000255 Info.Kind = SymbolKind::Constructor;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000256 Info.Lang = SymbolLanguage::CXX;
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +0000257 auto *CD = cast<CXXConstructorDecl>(D);
258 if (CD->isCopyConstructor())
259 Info.SubKind = SymbolSubKind::CXXCopyConstructor;
260 else if (CD->isMoveConstructor())
261 Info.SubKind = SymbolSubKind::CXXMoveConstructor;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000262 break;
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +0000263 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000264 case Decl::CXXDestructor:
Ben Langmuireacdb142016-03-25 17:01:59 +0000265 Info.Kind = SymbolKind::Destructor;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000266 Info.Lang = SymbolLanguage::CXX;
267 break;
268 case Decl::CXXConversion:
Ben Langmuireacdb142016-03-25 17:01:59 +0000269 Info.Kind = SymbolKind::ConversionFunction;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000270 Info.Lang = SymbolLanguage::CXX;
271 break;
272 case Decl::CXXMethod: {
273 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
274 if (MD->isStatic())
Ben Langmuireacdb142016-03-25 17:01:59 +0000275 Info.Kind = SymbolKind::StaticMethod;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000276 else
Ben Langmuireacdb142016-03-25 17:01:59 +0000277 Info.Kind = SymbolKind::InstanceMethod;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000278 Info.Lang = SymbolLanguage::CXX;
279 break;
280 }
281 case Decl::ClassTemplate:
Ben Langmuireacdb142016-03-25 17:01:59 +0000282 Info.Kind = SymbolKind::Class;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000283 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Ben Langmuireacdb142016-03-25 17:01:59 +0000284 Info.Lang = SymbolLanguage::CXX;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000285 break;
286 case Decl::FunctionTemplate:
287 Info.Kind = SymbolKind::Function;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000288 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Ben Langmuireacdb142016-03-25 17:01:59 +0000289 Info.Lang = SymbolLanguage::CXX;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000290 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(
291 cast<FunctionTemplateDecl>(D)->getTemplatedDecl())) {
292 if (isa<CXXConstructorDecl>(MD))
Ben Langmuireacdb142016-03-25 17:01:59 +0000293 Info.Kind = SymbolKind::Constructor;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000294 else if (isa<CXXDestructorDecl>(MD))
Ben Langmuireacdb142016-03-25 17:01:59 +0000295 Info.Kind = SymbolKind::Destructor;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000296 else if (isa<CXXConversionDecl>(MD))
Ben Langmuireacdb142016-03-25 17:01:59 +0000297 Info.Kind = SymbolKind::ConversionFunction;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000298 else {
299 if (MD->isStatic())
Ben Langmuireacdb142016-03-25 17:01:59 +0000300 Info.Kind = SymbolKind::StaticMethod;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000301 else
Ben Langmuireacdb142016-03-25 17:01:59 +0000302 Info.Kind = SymbolKind::InstanceMethod;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000303 }
304 }
305 break;
306 case Decl::TypeAliasTemplate:
Ben Langmuireacdb142016-03-25 17:01:59 +0000307 Info.Kind = SymbolKind::TypeAlias;
308 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000309 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000310 break;
311 case Decl::TypeAlias:
Ben Langmuireacdb142016-03-25 17:01:59 +0000312 Info.Kind = SymbolKind::TypeAlias;
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000313 Info.Lang = SymbolLanguage::CXX;
314 break;
Ben Langmuir1cfec5f2017-08-16 23:12:21 +0000315 case Decl::UnresolvedUsingTypename:
316 Info.Kind = SymbolKind::Using;
317 Info.SubKind = SymbolSubKind::UsingTypename;
318 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000319 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Ben Langmuir1cfec5f2017-08-16 23:12:21 +0000320 break;
321 case Decl::UnresolvedUsingValue:
322 Info.Kind = SymbolKind::Using;
323 Info.SubKind = SymbolSubKind::UsingValue;
324 Info.Lang = SymbolLanguage::CXX;
Sam McCall48fa9ac2017-12-23 19:31:24 +0000325 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
Ben Langmuir1cfec5f2017-08-16 23:12:21 +0000326 break;
Kadir Cetinkaya1540b2e2019-02-26 14:23:12 +0000327 case Decl::Using:
328 Info.Kind = SymbolKind::Using;
329 Info.Lang = SymbolLanguage::CXX;
330 break;
Alex Lorenz4d2e73a2017-06-15 21:19:01 +0000331 case Decl::Binding:
332 Info.Kind = SymbolKind::Variable;
333 Info.Lang = SymbolLanguage::CXX;
334 break;
Volodymyr Sapsai33184f72019-02-27 01:04:53 +0000335 case Decl::MSProperty:
336 Info.Kind = SymbolKind::InstanceProperty;
337 if (const CXXRecordDecl *CXXRec =
338 dyn_cast<CXXRecordDecl>(D->getDeclContext())) {
339 if (!CXXRec->isCLike())
340 Info.Lang = SymbolLanguage::CXX;
341 }
342 break;
Ilya Biryukov93cc0ae2019-05-29 17:49:30 +0000343 case Decl::ClassTemplatePartialSpecialization:
344 case Decl::ClassScopeFunctionSpecialization:
345 case Decl::ClassTemplateSpecialization:
346 case Decl::CXXRecord:
347 case Decl::Enum:
348 case Decl::Record:
349 llvm_unreachable("records handled before");
350 break;
351 case Decl::VarTemplateSpecialization:
352 case Decl::VarTemplatePartialSpecialization:
353 case Decl::ImplicitParam:
354 case Decl::ParmVar:
355 case Decl::Var:
356 case Decl::VarTemplate:
357 llvm_unreachable("variables handled before");
358 break;
359 // Other decls get the 'unknown' kind.
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000360 default:
361 break;
362 }
363 }
364
365 if (Info.Kind == SymbolKind::Unknown)
366 return Info;
367
368 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
369 if (FD->getTemplatedKind() ==
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000370 FunctionDecl::TK_FunctionTemplateSpecialization) {
Sam McCall48fa9ac2017-12-23 19:31:24 +0000371 Info.Properties |= (SymbolPropertySet)SymbolProperty::Generic;
372 Info.Properties |=
373 (SymbolPropertySet)SymbolProperty::TemplateSpecialization;
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000374 }
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000375 }
376
Sam McCall48fa9ac2017-12-23 19:31:24 +0000377 if (Info.Properties & (SymbolPropertySet)SymbolProperty::Generic)
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000378 Info.Lang = SymbolLanguage::CXX;
379
Argyrios Kyrtzidis088eaf52017-05-20 04:11:33 +0000380 if (auto *attr = D->getExternalSourceSymbolAttr()) {
Argyrios Kyrtzidis8f2ae422017-04-24 14:52:00 +0000381 if (attr->getLanguage() == "Swift")
382 Info.Lang = SymbolLanguage::Swift;
383 }
384
Argyrios Kyrtzidis754b7212016-02-12 23:10:59 +0000385 return Info;
386}
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000387
Eric Liu8576df52018-07-09 08:44:05 +0000388SymbolInfo index::getSymbolInfoForMacro(const MacroInfo &) {
389 SymbolInfo Info;
390 Info.Kind = SymbolKind::Macro;
391 Info.SubKind = SymbolSubKind::None;
392 Info.Properties = SymbolPropertySet();
393 Info.Lang = SymbolLanguage::C;
394 return Info;
395}
396
Argyrios Kyrtzidis53160ec2017-03-23 16:34:47 +0000397bool index::applyForEachSymbolRoleInterruptible(SymbolRoleSet Roles,
398 llvm::function_ref<bool(SymbolRole)> Fn) {
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000399#define APPLY_FOR_ROLE(Role) \
400 if (Roles & (unsigned)SymbolRole::Role) \
Argyrios Kyrtzidis53160ec2017-03-23 16:34:47 +0000401 if (!Fn(SymbolRole::Role)) \
402 return false;
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000403
404 APPLY_FOR_ROLE(Declaration);
405 APPLY_FOR_ROLE(Definition);
406 APPLY_FOR_ROLE(Reference);
407 APPLY_FOR_ROLE(Read);
408 APPLY_FOR_ROLE(Write);
409 APPLY_FOR_ROLE(Call);
410 APPLY_FOR_ROLE(Dynamic);
411 APPLY_FOR_ROLE(AddressOf);
412 APPLY_FOR_ROLE(Implicit);
Eric Liu8576df52018-07-09 08:44:05 +0000413 APPLY_FOR_ROLE(Undefinition);
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000414 APPLY_FOR_ROLE(RelationChildOf);
415 APPLY_FOR_ROLE(RelationBaseOf);
416 APPLY_FOR_ROLE(RelationOverrideOf);
417 APPLY_FOR_ROLE(RelationReceivedBy);
Argyrios Kyrtzidis46f43fd2016-02-29 07:56:00 +0000418 APPLY_FOR_ROLE(RelationCalledBy);
Argyrios Kyrtzidis56922302016-10-25 21:11:22 +0000419 APPLY_FOR_ROLE(RelationExtendedBy);
420 APPLY_FOR_ROLE(RelationAccessorOf);
Argyrios Kyrtzidis231cda62017-01-11 20:51:10 +0000421 APPLY_FOR_ROLE(RelationContainedBy);
Argyrios Kyrtzidis82932482017-01-11 21:01:07 +0000422 APPLY_FOR_ROLE(RelationIBTypeOf);
Alex Lorenz59a0c5e2017-04-20 10:43:22 +0000423 APPLY_FOR_ROLE(RelationSpecializationOf);
Kadir Cetinkaya87becae2019-03-08 08:30:20 +0000424 APPLY_FOR_ROLE(NameReference);
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000425
426#undef APPLY_FOR_ROLE
Argyrios Kyrtzidis53160ec2017-03-23 16:34:47 +0000427
428 return true;
429}
430
431void index::applyForEachSymbolRole(SymbolRoleSet Roles,
432 llvm::function_ref<void(SymbolRole)> Fn) {
433 applyForEachSymbolRoleInterruptible(Roles, [&](SymbolRole r) -> bool {
434 Fn(r);
435 return true;
436 });
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000437}
438
439void index::printSymbolRoles(SymbolRoleSet Roles, raw_ostream &OS) {
440 bool VisitedOnce = false;
441 applyForEachSymbolRole(Roles, [&](SymbolRole Role) {
442 if (VisitedOnce)
Argyrios Kyrtzidis340ce982016-02-29 07:55:51 +0000443 OS << ',';
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000444 else
445 VisitedOnce = true;
446 switch (Role) {
447 case SymbolRole::Declaration: OS << "Decl"; break;
448 case SymbolRole::Definition: OS << "Def"; break;
449 case SymbolRole::Reference: OS << "Ref"; break;
450 case SymbolRole::Read: OS << "Read"; break;
451 case SymbolRole::Write: OS << "Writ"; break;
452 case SymbolRole::Call: OS << "Call"; break;
453 case SymbolRole::Dynamic: OS << "Dyn"; break;
454 case SymbolRole::AddressOf: OS << "Addr"; break;
455 case SymbolRole::Implicit: OS << "Impl"; break;
Eric Liu8576df52018-07-09 08:44:05 +0000456 case SymbolRole::Undefinition: OS << "Undef"; break;
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000457 case SymbolRole::RelationChildOf: OS << "RelChild"; break;
458 case SymbolRole::RelationBaseOf: OS << "RelBase"; break;
459 case SymbolRole::RelationOverrideOf: OS << "RelOver"; break;
460 case SymbolRole::RelationReceivedBy: OS << "RelRec"; break;
Argyrios Kyrtzidis46f43fd2016-02-29 07:56:00 +0000461 case SymbolRole::RelationCalledBy: OS << "RelCall"; break;
Argyrios Kyrtzidis56922302016-10-25 21:11:22 +0000462 case SymbolRole::RelationExtendedBy: OS << "RelExt"; break;
463 case SymbolRole::RelationAccessorOf: OS << "RelAcc"; break;
Argyrios Kyrtzidis231cda62017-01-11 20:51:10 +0000464 case SymbolRole::RelationContainedBy: OS << "RelCont"; break;
Argyrios Kyrtzidis82932482017-01-11 21:01:07 +0000465 case SymbolRole::RelationIBTypeOf: OS << "RelIBType"; break;
Alex Lorenz59a0c5e2017-04-20 10:43:22 +0000466 case SymbolRole::RelationSpecializationOf: OS << "RelSpecialization"; break;
Kadir Cetinkaya87becae2019-03-08 08:30:20 +0000467 case SymbolRole::NameReference: OS << "NameReference"; break;
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000468 }
469 });
470}
471
Argyrios Kyrtzidis1c8c4712016-02-15 01:32:36 +0000472bool index::printSymbolName(const Decl *D, const LangOptions &LO,
473 raw_ostream &OS) {
474 if (auto *ND = dyn_cast<NamedDecl>(D)) {
475 PrintingPolicy Policy(LO);
476 // Forward references can have different template argument names. Suppress
477 // the template argument names in constructors to make their name more
478 // stable.
479 Policy.SuppressTemplateArgsInCXXConstructors = true;
480 DeclarationName DeclName = ND->getDeclName();
481 if (DeclName.isEmpty())
482 return true;
483 DeclName.print(OS, Policy);
484 return false;
485 } else {
486 return true;
487 }
488}
489
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000490StringRef index::getSymbolKindString(SymbolKind K) {
491 switch (K) {
492 case SymbolKind::Unknown: return "<unknown>";
493 case SymbolKind::Module: return "module";
Ben Langmuireacdb142016-03-25 17:01:59 +0000494 case SymbolKind::Namespace: return "namespace";
495 case SymbolKind::NamespaceAlias: return "namespace-alias";
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000496 case SymbolKind::Macro: return "macro";
497 case SymbolKind::Enum: return "enum";
498 case SymbolKind::Struct: return "struct";
Ben Langmuireacdb142016-03-25 17:01:59 +0000499 case SymbolKind::Class: return "class";
500 case SymbolKind::Protocol: return "protocol";
501 case SymbolKind::Extension: return "extension";
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000502 case SymbolKind::Union: return "union";
Ben Langmuireacdb142016-03-25 17:01:59 +0000503 case SymbolKind::TypeAlias: return "type-alias";
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000504 case SymbolKind::Function: return "function";
505 case SymbolKind::Variable: return "variable";
506 case SymbolKind::Field: return "field";
507 case SymbolKind::EnumConstant: return "enumerator";
Ben Langmuireacdb142016-03-25 17:01:59 +0000508 case SymbolKind::InstanceMethod: return "instance-method";
509 case SymbolKind::ClassMethod: return "class-method";
510 case SymbolKind::StaticMethod: return "static-method";
511 case SymbolKind::InstanceProperty: return "instance-property";
512 case SymbolKind::ClassProperty: return "class-property";
513 case SymbolKind::StaticProperty: return "static-property";
514 case SymbolKind::Constructor: return "constructor";
515 case SymbolKind::Destructor: return "destructor";
Jan Korous84cc1b72019-07-23 16:54:11 +0000516 case SymbolKind::ConversionFunction: return "conversion-func";
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +0000517 case SymbolKind::Parameter: return "param";
Ben Langmuir1cfec5f2017-08-16 23:12:21 +0000518 case SymbolKind::Using: return "using";
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000519 }
Saleem Abdulrasool73a26032016-02-15 00:36:52 +0000520 llvm_unreachable("invalid symbol kind");
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000521}
522
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +0000523StringRef index::getSymbolSubKindString(SymbolSubKind K) {
524 switch (K) {
525 case SymbolSubKind::None: return "<none>";
526 case SymbolSubKind::CXXCopyConstructor: return "cxx-copy-ctor";
527 case SymbolSubKind::CXXMoveConstructor: return "cxx-move-ctor";
Argyrios Kyrtzidis4a19ab52017-01-11 21:42:48 +0000528 case SymbolSubKind::AccessorGetter: return "acc-get";
529 case SymbolSubKind::AccessorSetter: return "acc-set";
Ben Langmuir1cfec5f2017-08-16 23:12:21 +0000530 case SymbolSubKind::UsingTypename: return "using-typename";
531 case SymbolSubKind::UsingValue: return "using-value";
Argyrios Kyrtzidisc900a4b2017-01-08 23:21:35 +0000532 }
533 llvm_unreachable("invalid symbol subkind");
534}
535
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000536StringRef index::getSymbolLanguageString(SymbolLanguage K) {
537 switch (K) {
538 case SymbolLanguage::C: return "C";
539 case SymbolLanguage::ObjC: return "ObjC";
540 case SymbolLanguage::CXX: return "C++";
Argyrios Kyrtzidis8f2ae422017-04-24 14:52:00 +0000541 case SymbolLanguage::Swift: return "Swift";
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000542 }
Saleem Abdulrasool73a26032016-02-15 00:36:52 +0000543 llvm_unreachable("invalid symbol language kind");
Argyrios Kyrtzidis4d8332a2016-02-14 06:39:11 +0000544}
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000545
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000546void index::applyForEachSymbolProperty(SymbolPropertySet Props,
547 llvm::function_ref<void(SymbolProperty)> Fn) {
Sam McCall48fa9ac2017-12-23 19:31:24 +0000548#define APPLY_FOR_PROPERTY(K) \
549 if (Props & (SymbolPropertySet)SymbolProperty::K) \
550 Fn(SymbolProperty::K)
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000551
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000552 APPLY_FOR_PROPERTY(Generic);
553 APPLY_FOR_PROPERTY(TemplatePartialSpecialization);
554 APPLY_FOR_PROPERTY(TemplateSpecialization);
555 APPLY_FOR_PROPERTY(UnitTest);
556 APPLY_FOR_PROPERTY(IBAnnotated);
557 APPLY_FOR_PROPERTY(IBOutletCollection);
558 APPLY_FOR_PROPERTY(GKInspectable);
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +0000559 APPLY_FOR_PROPERTY(Local);
Argyrios Kyrtzidis1e8f9cd2018-08-26 06:27:23 +0000560 APPLY_FOR_PROPERTY(ProtocolInterface);
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000561
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000562#undef APPLY_FOR_PROPERTY
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000563}
564
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000565void index::printSymbolProperties(SymbolPropertySet Props, raw_ostream &OS) {
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000566 bool VisitedOnce = false;
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000567 applyForEachSymbolProperty(Props, [&](SymbolProperty Prop) {
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000568 if (VisitedOnce)
569 OS << ',';
570 else
571 VisitedOnce = true;
Argyrios Kyrtzidis0e0e98c2016-11-11 23:49:55 +0000572 switch (Prop) {
573 case SymbolProperty::Generic: OS << "Gen"; break;
574 case SymbolProperty::TemplatePartialSpecialization: OS << "TPS"; break;
575 case SymbolProperty::TemplateSpecialization: OS << "TS"; break;
576 case SymbolProperty::UnitTest: OS << "test"; break;
577 case SymbolProperty::IBAnnotated: OS << "IB"; break;
578 case SymbolProperty::IBOutletCollection: OS << "IBColl"; break;
579 case SymbolProperty::GKInspectable: OS << "GKI"; break;
Argyrios Kyrtzidis1d680d22017-02-26 05:37:56 +0000580 case SymbolProperty::Local: OS << "local"; break;
Argyrios Kyrtzidis1e8f9cd2018-08-26 06:27:23 +0000581 case SymbolProperty::ProtocolInterface: OS << "protocol"; break;
Argyrios Kyrtzidisa0cb91f2016-04-22 07:21:04 +0000582 }
583 });
584}