blob: d527535a17c179897a4fb8c8c085b9eb1ece608c [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===- CIndex.cpp - Clang-C Source Indexing Library -----------------------===//
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// This file implements the main API hooks in the Clang-C Source Indexing
11// library.
12//
13//===----------------------------------------------------------------------===//
14
Guy Benyei11169dd2012-12-18 14:30:41 +000015#include "CIndexDiagnostic.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000016#include "CIndexer.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000017#include "CLog.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "CXCursor.h"
19#include "CXSourceLocation.h"
20#include "CXString.h"
21#include "CXTranslationUnit.h"
22#include "CXType.h"
23#include "CursorVisitor.h"
David Blaikie0a4e61f2013-09-13 18:32:52 +000024#include "clang/AST/Attr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000025#include "clang/AST/StmtVisitor.h"
26#include "clang/Basic/Diagnostic.h"
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000027#include "clang/Basic/DiagnosticCategories.h"
28#include "clang/Basic/DiagnosticIDs.h"
Emilio Cobos Alvarez485ad422017-04-28 15:56:39 +000029#include "clang/Basic/TargetInfo.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000030#include "clang/Basic/Version.h"
31#include "clang/Frontend/ASTUnit.h"
32#include "clang/Frontend/CompilerInstance.h"
33#include "clang/Frontend/FrontendDiagnostic.h"
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +000034#include "clang/Index/CodegenNameGenerator.h"
Dmitri Gribenko9e605112013-11-13 22:16:51 +000035#include "clang/Index/CommentToXML.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000036#include "clang/Lex/HeaderSearch.h"
37#include "clang/Lex/Lexer.h"
38#include "clang/Lex/PreprocessingRecord.h"
39#include "clang/Lex/Preprocessor.h"
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000040#include "clang/Serialization/SerializationDiagnostic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000041#include "llvm/ADT/Optional.h"
42#include "llvm/ADT/STLExtras.h"
43#include "llvm/ADT/StringSwitch.h"
Alp Toker1d257e12014-06-04 03:28:55 +000044#include "llvm/Config/llvm-config.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000045#include "llvm/Support/Compiler.h"
46#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000047#include "llvm/Support/Format.h"
Chandler Carruth37ad2582014-06-27 15:14:39 +000048#include "llvm/Support/ManagedStatic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000049#include "llvm/Support/MemoryBuffer.h"
50#include "llvm/Support/Mutex.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000051#include "llvm/Support/Program.h"
52#include "llvm/Support/SaveAndRestore.h"
53#include "llvm/Support/Signals.h"
Adrian Prantlbc068582015-07-08 01:00:30 +000054#include "llvm/Support/TargetSelect.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000055#include "llvm/Support/Threading.h"
56#include "llvm/Support/Timer.h"
57#include "llvm/Support/raw_ostream.h"
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000058
Alp Toker1a86ad22014-07-06 06:24:00 +000059#if LLVM_ENABLE_THREADS != 0 && defined(__APPLE__)
60#define USE_DARWIN_THREADS
61#endif
62
63#ifdef USE_DARWIN_THREADS
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000064#include <pthread.h>
65#endif
Guy Benyei11169dd2012-12-18 14:30:41 +000066
67using namespace clang;
68using namespace clang::cxcursor;
Guy Benyei11169dd2012-12-18 14:30:41 +000069using namespace clang::cxtu;
70using namespace clang::cxindex;
71
David Blaikieea4395e2017-01-06 19:49:01 +000072CXTranslationUnit cxtu::MakeCXTranslationUnit(CIndexer *CIdx,
73 std::unique_ptr<ASTUnit> AU) {
Dmitri Gribenkod36209e2013-01-26 21:32:42 +000074 if (!AU)
Craig Topper69186e72014-06-08 08:38:04 +000075 return nullptr;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000076 assert(CIdx);
Guy Benyei11169dd2012-12-18 14:30:41 +000077 CXTranslationUnit D = new CXTranslationUnitImpl();
78 D->CIdx = CIdx;
David Blaikieea4395e2017-01-06 19:49:01 +000079 D->TheASTUnit = AU.release();
Dmitri Gribenko74895212013-02-03 13:52:47 +000080 D->StringPool = new cxstring::CXStringPool();
Craig Topper69186e72014-06-08 08:38:04 +000081 D->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +000082 D->OverridenCursorsPool = createOverridenCXCursorsPool();
Craig Topper69186e72014-06-08 08:38:04 +000083 D->CommentToXML = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +000084 return D;
85}
86
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000087bool cxtu::isASTReadError(ASTUnit *AU) {
88 for (ASTUnit::stored_diag_iterator D = AU->stored_diag_begin(),
89 DEnd = AU->stored_diag_end();
90 D != DEnd; ++D) {
91 if (D->getLevel() >= DiagnosticsEngine::Error &&
92 DiagnosticIDs::getCategoryNumberForDiag(D->getID()) ==
93 diag::DiagCat_AST_Deserialization_Issue)
94 return true;
95 }
96 return false;
97}
98
Guy Benyei11169dd2012-12-18 14:30:41 +000099cxtu::CXTUOwner::~CXTUOwner() {
100 if (TU)
101 clang_disposeTranslationUnit(TU);
102}
103
104/// \brief Compare two source ranges to determine their relative position in
105/// the translation unit.
106static RangeComparisonResult RangeCompare(SourceManager &SM,
107 SourceRange R1,
108 SourceRange R2) {
109 assert(R1.isValid() && "First range is invalid?");
110 assert(R2.isValid() && "Second range is invalid?");
111 if (R1.getEnd() != R2.getBegin() &&
112 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
113 return RangeBefore;
114 if (R2.getEnd() != R1.getBegin() &&
115 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
116 return RangeAfter;
117 return RangeOverlap;
118}
119
120/// \brief Determine if a source location falls within, before, or after a
121/// a given source range.
122static RangeComparisonResult LocationCompare(SourceManager &SM,
123 SourceLocation L, SourceRange R) {
124 assert(R.isValid() && "First range is invalid?");
125 assert(L.isValid() && "Second range is invalid?");
126 if (L == R.getBegin() || L == R.getEnd())
127 return RangeOverlap;
128 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
129 return RangeBefore;
130 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
131 return RangeAfter;
132 return RangeOverlap;
133}
134
135/// \brief Translate a Clang source range into a CIndex source range.
136///
137/// Clang internally represents ranges where the end location points to the
138/// start of the token at the end. However, for external clients it is more
139/// useful to have a CXSourceRange be a proper half-open interval. This routine
140/// does the appropriate translation.
141CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
142 const LangOptions &LangOpts,
143 const CharSourceRange &R) {
144 // We want the last character in this location, so we will adjust the
145 // location accordingly.
146 SourceLocation EndLoc = R.getEnd();
147 if (EndLoc.isValid() && EndLoc.isMacroID() && !SM.isMacroArgExpansion(EndLoc))
148 EndLoc = SM.getExpansionRange(EndLoc).second;
Yaron Keren8b563662015-10-03 10:46:20 +0000149 if (R.isTokenRange() && EndLoc.isValid()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000150 unsigned Length = Lexer::MeasureTokenLength(SM.getSpellingLoc(EndLoc),
151 SM, LangOpts);
152 EndLoc = EndLoc.getLocWithOffset(Length);
153 }
154
Bill Wendlingeade3622013-01-23 08:25:41 +0000155 CXSourceRange Result = {
Dmitri Gribenkof9304482013-01-23 15:56:07 +0000156 { &SM, &LangOpts },
Bill Wendlingeade3622013-01-23 08:25:41 +0000157 R.getBegin().getRawEncoding(),
158 EndLoc.getRawEncoding()
159 };
Guy Benyei11169dd2012-12-18 14:30:41 +0000160 return Result;
161}
162
163//===----------------------------------------------------------------------===//
164// Cursor visitor.
165//===----------------------------------------------------------------------===//
166
167static SourceRange getRawCursorExtent(CXCursor C);
168static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
169
170
171RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
172 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
173}
174
175/// \brief Visit the given cursor and, if requested by the visitor,
176/// its children.
177///
178/// \param Cursor the cursor to visit.
179///
180/// \param CheckedRegionOfInterest if true, then the caller already checked
181/// that this cursor is within the region of interest.
182///
183/// \returns true if the visitation should be aborted, false if it
184/// should continue.
185bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
186 if (clang_isInvalid(Cursor.kind))
187 return false;
188
189 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000190 const Decl *D = getCursorDecl(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +0000191 if (!D) {
192 assert(0 && "Invalid declaration cursor");
193 return true; // abort.
194 }
195
196 // Ignore implicit declarations, unless it's an objc method because
197 // currently we should report implicit methods for properties when indexing.
198 if (D->isImplicit() && !isa<ObjCMethodDecl>(D))
199 return false;
200 }
201
202 // If we have a range of interest, and this cursor doesn't intersect with it,
203 // we're done.
204 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
205 SourceRange Range = getRawCursorExtent(Cursor);
206 if (Range.isInvalid() || CompareRegionOfInterest(Range))
207 return false;
208 }
209
210 switch (Visitor(Cursor, Parent, ClientData)) {
211 case CXChildVisit_Break:
212 return true;
213
214 case CXChildVisit_Continue:
215 return false;
216
217 case CXChildVisit_Recurse: {
218 bool ret = VisitChildren(Cursor);
219 if (PostChildrenVisitor)
220 if (PostChildrenVisitor(Cursor, ClientData))
221 return true;
222 return ret;
223 }
224 }
225
226 llvm_unreachable("Invalid CXChildVisitResult!");
227}
228
229static bool visitPreprocessedEntitiesInRange(SourceRange R,
230 PreprocessingRecord &PPRec,
231 CursorVisitor &Visitor) {
232 SourceManager &SM = Visitor.getASTUnit()->getSourceManager();
233 FileID FID;
234
235 if (!Visitor.shouldVisitIncludedEntities()) {
236 // If the begin/end of the range lie in the same FileID, do the optimization
237 // where we skip preprocessed entities that do not come from the same FileID.
238 FID = SM.getFileID(SM.getFileLoc(R.getBegin()));
239 if (FID != SM.getFileID(SM.getFileLoc(R.getEnd())))
240 FID = FileID();
241 }
242
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000243 const auto &Entities = PPRec.getPreprocessedEntitiesInRange(R);
244 return Visitor.visitPreprocessedEntities(Entities.begin(), Entities.end(),
Guy Benyei11169dd2012-12-18 14:30:41 +0000245 PPRec, FID);
246}
247
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000248bool CursorVisitor::visitFileRegion() {
Guy Benyei11169dd2012-12-18 14:30:41 +0000249 if (RegionOfInterest.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000250 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000251
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000252 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000253 SourceManager &SM = Unit->getSourceManager();
254
255 std::pair<FileID, unsigned>
256 Begin = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getBegin())),
257 End = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getEnd()));
258
259 if (End.first != Begin.first) {
260 // If the end does not reside in the same file, try to recover by
261 // picking the end of the file of begin location.
262 End.first = Begin.first;
263 End.second = SM.getFileIDSize(Begin.first);
264 }
265
266 assert(Begin.first == End.first);
267 if (Begin.second > End.second)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000268 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000269
270 FileID File = Begin.first;
271 unsigned Offset = Begin.second;
272 unsigned Length = End.second - Begin.second;
273
274 if (!VisitDeclsOnly && !VisitPreprocessorLast)
275 if (visitPreprocessedEntitiesInRegion())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000276 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000277
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000278 if (visitDeclsFromFileRegion(File, Offset, Length))
279 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000280
281 if (!VisitDeclsOnly && VisitPreprocessorLast)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000282 return visitPreprocessedEntitiesInRegion();
283
284 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000285}
286
287static bool isInLexicalContext(Decl *D, DeclContext *DC) {
288 if (!DC)
289 return false;
290
291 for (DeclContext *DeclDC = D->getLexicalDeclContext();
292 DeclDC; DeclDC = DeclDC->getLexicalParent()) {
293 if (DeclDC == DC)
294 return true;
295 }
296 return false;
297}
298
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000299bool CursorVisitor::visitDeclsFromFileRegion(FileID File,
Guy Benyei11169dd2012-12-18 14:30:41 +0000300 unsigned Offset, unsigned Length) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000301 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000302 SourceManager &SM = Unit->getSourceManager();
303 SourceRange Range = RegionOfInterest;
304
305 SmallVector<Decl *, 16> Decls;
306 Unit->findFileRegionDecls(File, Offset, Length, Decls);
307
308 // If we didn't find any file level decls for the file, try looking at the
309 // file that it was included from.
310 while (Decls.empty() || Decls.front()->isTopLevelDeclInObjCContainer()) {
311 bool Invalid = false;
312 const SrcMgr::SLocEntry &SLEntry = SM.getSLocEntry(File, &Invalid);
313 if (Invalid)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000314 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000315
316 SourceLocation Outer;
317 if (SLEntry.isFile())
318 Outer = SLEntry.getFile().getIncludeLoc();
319 else
320 Outer = SLEntry.getExpansion().getExpansionLocStart();
321 if (Outer.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000322 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000323
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000324 std::tie(File, Offset) = SM.getDecomposedExpansionLoc(Outer);
Guy Benyei11169dd2012-12-18 14:30:41 +0000325 Length = 0;
326 Unit->findFileRegionDecls(File, Offset, Length, Decls);
327 }
328
329 assert(!Decls.empty());
330
331 bool VisitedAtLeastOnce = false;
Craig Topper69186e72014-06-08 08:38:04 +0000332 DeclContext *CurDC = nullptr;
Craig Topper2341c0d2013-07-04 03:08:24 +0000333 SmallVectorImpl<Decl *>::iterator DIt = Decls.begin();
334 for (SmallVectorImpl<Decl *>::iterator DE = Decls.end(); DIt != DE; ++DIt) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000335 Decl *D = *DIt;
336 if (D->getSourceRange().isInvalid())
337 continue;
338
339 if (isInLexicalContext(D, CurDC))
340 continue;
341
342 CurDC = dyn_cast<DeclContext>(D);
343
344 if (TagDecl *TD = dyn_cast<TagDecl>(D))
345 if (!TD->isFreeStanding())
346 continue;
347
348 RangeComparisonResult CompRes = RangeCompare(SM, D->getSourceRange(),Range);
349 if (CompRes == RangeBefore)
350 continue;
351 if (CompRes == RangeAfter)
352 break;
353
354 assert(CompRes == RangeOverlap);
355 VisitedAtLeastOnce = true;
356
357 if (isa<ObjCContainerDecl>(D)) {
358 FileDI_current = &DIt;
359 FileDE_current = DE;
360 } else {
Craig Topper69186e72014-06-08 08:38:04 +0000361 FileDI_current = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000362 }
363
364 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000365 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000366 }
367
368 if (VisitedAtLeastOnce)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000369 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000370
371 // No Decls overlapped with the range. Move up the lexical context until there
372 // is a context that contains the range or we reach the translation unit
373 // level.
374 DeclContext *DC = DIt == Decls.begin() ? (*DIt)->getLexicalDeclContext()
375 : (*(DIt-1))->getLexicalDeclContext();
376
377 while (DC && !DC->isTranslationUnit()) {
378 Decl *D = cast<Decl>(DC);
379 SourceRange CurDeclRange = D->getSourceRange();
380 if (CurDeclRange.isInvalid())
381 break;
382
383 if (RangeCompare(SM, CurDeclRange, Range) == RangeOverlap) {
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000384 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
385 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000386 }
387
388 DC = D->getLexicalDeclContext();
389 }
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000390
391 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000392}
393
394bool CursorVisitor::visitPreprocessedEntitiesInRegion() {
395 if (!AU->getPreprocessor().getPreprocessingRecord())
396 return false;
397
398 PreprocessingRecord &PPRec
399 = *AU->getPreprocessor().getPreprocessingRecord();
400 SourceManager &SM = AU->getSourceManager();
401
402 if (RegionOfInterest.isValid()) {
403 SourceRange MappedRange = AU->mapRangeToPreamble(RegionOfInterest);
404 SourceLocation B = MappedRange.getBegin();
405 SourceLocation E = MappedRange.getEnd();
406
407 if (AU->isInPreambleFileID(B)) {
408 if (SM.isLoadedSourceLocation(E))
409 return visitPreprocessedEntitiesInRange(SourceRange(B, E),
410 PPRec, *this);
411
412 // Beginning of range lies in the preamble but it also extends beyond
413 // it into the main file. Split the range into 2 parts, one covering
414 // the preamble and another covering the main file. This allows subsequent
415 // calls to visitPreprocessedEntitiesInRange to accept a source range that
416 // lies in the same FileID, allowing it to skip preprocessed entities that
417 // do not come from the same FileID.
418 bool breaked =
419 visitPreprocessedEntitiesInRange(
420 SourceRange(B, AU->getEndOfPreambleFileID()),
421 PPRec, *this);
422 if (breaked) return true;
423 return visitPreprocessedEntitiesInRange(
424 SourceRange(AU->getStartOfMainFileID(), E),
425 PPRec, *this);
426 }
427
428 return visitPreprocessedEntitiesInRange(SourceRange(B, E), PPRec, *this);
429 }
430
431 bool OnlyLocalDecls
432 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
433
434 if (OnlyLocalDecls)
435 return visitPreprocessedEntities(PPRec.local_begin(), PPRec.local_end(),
436 PPRec);
437
438 return visitPreprocessedEntities(PPRec.begin(), PPRec.end(), PPRec);
439}
440
441template<typename InputIterator>
442bool CursorVisitor::visitPreprocessedEntities(InputIterator First,
443 InputIterator Last,
444 PreprocessingRecord &PPRec,
445 FileID FID) {
446 for (; First != Last; ++First) {
447 if (!FID.isInvalid() && !PPRec.isEntityInFileID(First, FID))
448 continue;
449
450 PreprocessedEntity *PPE = *First;
Argyrios Kyrtzidis1030f262013-05-07 20:37:17 +0000451 if (!PPE)
452 continue;
453
Guy Benyei11169dd2012-12-18 14:30:41 +0000454 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(PPE)) {
455 if (Visit(MakeMacroExpansionCursor(ME, TU)))
456 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000457
Guy Benyei11169dd2012-12-18 14:30:41 +0000458 continue;
459 }
Richard Smith66a81862015-05-04 02:25:31 +0000460
461 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(PPE)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000462 if (Visit(MakeMacroDefinitionCursor(MD, TU)))
463 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000464
Guy Benyei11169dd2012-12-18 14:30:41 +0000465 continue;
466 }
467
468 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
469 if (Visit(MakeInclusionDirectiveCursor(ID, TU)))
470 return true;
471
472 continue;
473 }
474 }
475
476 return false;
477}
478
479/// \brief Visit the children of the given cursor.
480///
481/// \returns true if the visitation should be aborted, false if it
482/// should continue.
483bool CursorVisitor::VisitChildren(CXCursor Cursor) {
484 if (clang_isReference(Cursor.kind) &&
485 Cursor.kind != CXCursor_CXXBaseSpecifier) {
486 // By definition, references have no children.
487 return false;
488 }
489
490 // Set the Parent field to Cursor, then back to its old value once we're
491 // done.
492 SetParentRAII SetParent(Parent, StmtParent, Cursor);
493
494 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000495 Decl *D = const_cast<Decl *>(getCursorDecl(Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +0000496 if (!D)
497 return false;
498
499 return VisitAttributes(D) || Visit(D);
500 }
501
502 if (clang_isStatement(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000503 if (const Stmt *S = getCursorStmt(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000504 return Visit(S);
505
506 return false;
507 }
508
509 if (clang_isExpression(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000510 if (const Expr *E = getCursorExpr(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000511 return Visit(E);
512
513 return false;
514 }
515
516 if (clang_isTranslationUnit(Cursor.kind)) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000517 CXTranslationUnit TU = getCursorTU(Cursor);
518 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000519
520 int VisitOrder[2] = { VisitPreprocessorLast, !VisitPreprocessorLast };
521 for (unsigned I = 0; I != 2; ++I) {
522 if (VisitOrder[I]) {
523 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
524 RegionOfInterest.isInvalid()) {
525 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
526 TLEnd = CXXUnit->top_level_end();
527 TL != TLEnd; ++TL) {
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000528 const Optional<bool> V = handleDeclForVisitation(*TL);
529 if (!V.hasValue())
530 continue;
531 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000532 }
533 } else if (VisitDeclContext(
534 CXXUnit->getASTContext().getTranslationUnitDecl()))
535 return true;
536 continue;
537 }
538
539 // Walk the preprocessing record.
540 if (CXXUnit->getPreprocessor().getPreprocessingRecord())
541 visitPreprocessedEntitiesInRegion();
542 }
543
544 return false;
545 }
546
547 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000548 if (const CXXBaseSpecifier *Base = getCursorCXXBaseSpecifier(Cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000549 if (TypeSourceInfo *BaseTSInfo = Base->getTypeSourceInfo()) {
550 return Visit(BaseTSInfo->getTypeLoc());
551 }
552 }
553 }
554
555 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +0000556 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +0000557 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(Cursor));
Richard Smithb1f9a282013-10-31 01:56:18 +0000558 if (const ObjCObjectType *ObjT = A->getInterface()->getAs<ObjCObjectType>())
Richard Smithb87c4652013-10-31 21:23:20 +0000559 return Visit(cxcursor::MakeCursorObjCClassRef(
560 ObjT->getInterface(),
561 A->getInterfaceLoc()->getTypeLoc().getLocStart(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +0000562 }
563
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000564 // If pointing inside a macro definition, check if the token is an identifier
565 // that was ever defined as a macro. In such a case, create a "pseudo" macro
566 // expansion cursor for that token.
567 SourceLocation BeginLoc = RegionOfInterest.getBegin();
568 if (Cursor.kind == CXCursor_MacroDefinition &&
569 BeginLoc == RegionOfInterest.getEnd()) {
570 SourceLocation Loc = AU->mapLocationToPreamble(BeginLoc);
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000571 const MacroInfo *MI =
572 getMacroInfo(cxcursor::getCursorMacroDefinition(Cursor), TU);
Richard Smith66a81862015-05-04 02:25:31 +0000573 if (MacroDefinitionRecord *MacroDef =
574 checkForMacroInMacroDefinition(MI, Loc, TU))
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000575 return Visit(cxcursor::MakeMacroExpansionCursor(MacroDef, BeginLoc, TU));
576 }
577
Guy Benyei11169dd2012-12-18 14:30:41 +0000578 // Nothing to visit at the moment.
579 return false;
580}
581
582bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
583 if (TypeSourceInfo *TSInfo = B->getSignatureAsWritten())
584 if (Visit(TSInfo->getTypeLoc()))
585 return true;
586
587 if (Stmt *Body = B->getBody())
588 return Visit(MakeCXCursor(Body, StmtParent, TU, RegionOfInterest));
589
590 return false;
591}
592
Ted Kremenek03325582013-02-21 01:29:01 +0000593Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000594 if (RegionOfInterest.isValid()) {
595 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
596 if (Range.isInvalid())
David Blaikie7a30dc52013-02-21 01:47:18 +0000597 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000598
599 switch (CompareRegionOfInterest(Range)) {
600 case RangeBefore:
601 // This declaration comes before the region of interest; skip it.
David Blaikie7a30dc52013-02-21 01:47:18 +0000602 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000603
604 case RangeAfter:
605 // This declaration comes after the region of interest; we're done.
606 return false;
607
608 case RangeOverlap:
609 // This declaration overlaps the region of interest; visit it.
610 break;
611 }
612 }
613 return true;
614}
615
616bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
617 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
618
619 // FIXME: Eventually remove. This part of a hack to support proper
620 // iteration over all Decls contained lexically within an ObjC container.
621 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
622 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
623
624 for ( ; I != E; ++I) {
625 Decl *D = *I;
626 if (D->getLexicalDeclContext() != DC)
627 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000628 const Optional<bool> V = handleDeclForVisitation(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000629 if (!V.hasValue())
630 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000631 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000632 }
633 return false;
634}
635
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000636Optional<bool> CursorVisitor::handleDeclForVisitation(const Decl *D) {
637 CXCursor Cursor = MakeCXCursor(D, TU, RegionOfInterest);
638
639 // Ignore synthesized ivars here, otherwise if we have something like:
640 // @synthesize prop = _prop;
641 // and '_prop' is not declared, we will encounter a '_prop' ivar before
642 // encountering the 'prop' synthesize declaration and we will think that
643 // we passed the region-of-interest.
644 if (auto *ivarD = dyn_cast<ObjCIvarDecl>(D)) {
645 if (ivarD->getSynthesize())
646 return None;
647 }
648
649 // FIXME: ObjCClassRef/ObjCProtocolRef for forward class/protocol
650 // declarations is a mismatch with the compiler semantics.
651 if (Cursor.kind == CXCursor_ObjCInterfaceDecl) {
652 auto *ID = cast<ObjCInterfaceDecl>(D);
653 if (!ID->isThisDeclarationADefinition())
654 Cursor = MakeCursorObjCClassRef(ID, ID->getLocation(), TU);
655
656 } else if (Cursor.kind == CXCursor_ObjCProtocolDecl) {
657 auto *PD = cast<ObjCProtocolDecl>(D);
658 if (!PD->isThisDeclarationADefinition())
659 Cursor = MakeCursorObjCProtocolRef(PD, PD->getLocation(), TU);
660 }
661
662 const Optional<bool> V = shouldVisitCursor(Cursor);
663 if (!V.hasValue())
664 return None;
665 if (!V.getValue())
666 return false;
667 if (Visit(Cursor, true))
668 return true;
669 return None;
670}
671
Guy Benyei11169dd2012-12-18 14:30:41 +0000672bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
673 llvm_unreachable("Translation units are visited directly by Visit()");
674}
675
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +0000676bool CursorVisitor::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
677 if (VisitTemplateParameters(D->getTemplateParameters()))
678 return true;
679
680 return Visit(MakeCXCursor(D->getTemplatedDecl(), TU, RegionOfInterest));
681}
682
Guy Benyei11169dd2012-12-18 14:30:41 +0000683bool CursorVisitor::VisitTypeAliasDecl(TypeAliasDecl *D) {
684 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
685 return Visit(TSInfo->getTypeLoc());
686
687 return false;
688}
689
690bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
691 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
692 return Visit(TSInfo->getTypeLoc());
693
694 return false;
695}
696
697bool CursorVisitor::VisitTagDecl(TagDecl *D) {
698 return VisitDeclContext(D);
699}
700
701bool CursorVisitor::VisitClassTemplateSpecializationDecl(
702 ClassTemplateSpecializationDecl *D) {
703 bool ShouldVisitBody = false;
704 switch (D->getSpecializationKind()) {
705 case TSK_Undeclared:
706 case TSK_ImplicitInstantiation:
707 // Nothing to visit
708 return false;
709
710 case TSK_ExplicitInstantiationDeclaration:
711 case TSK_ExplicitInstantiationDefinition:
712 break;
713
714 case TSK_ExplicitSpecialization:
715 ShouldVisitBody = true;
716 break;
717 }
718
719 // Visit the template arguments used in the specialization.
720 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
721 TypeLoc TL = SpecType->getTypeLoc();
David Blaikie6adc78e2013-02-18 22:06:02 +0000722 if (TemplateSpecializationTypeLoc TSTLoc =
723 TL.getAs<TemplateSpecializationTypeLoc>()) {
724 for (unsigned I = 0, N = TSTLoc.getNumArgs(); I != N; ++I)
725 if (VisitTemplateArgumentLoc(TSTLoc.getArgLoc(I)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000726 return true;
727 }
728 }
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000729
730 return ShouldVisitBody && VisitCXXRecordDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000731}
732
733bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
734 ClassTemplatePartialSpecializationDecl *D) {
735 // FIXME: Visit the "outer" template parameter lists on the TagDecl
736 // before visiting these template parameters.
737 if (VisitTemplateParameters(D->getTemplateParameters()))
738 return true;
739
740 // Visit the partial specialization arguments.
Enea Zaffanella6dbe1872013-08-10 07:24:53 +0000741 const ASTTemplateArgumentListInfo *Info = D->getTemplateArgsAsWritten();
742 const TemplateArgumentLoc *TemplateArgs = Info->getTemplateArgs();
743 for (unsigned I = 0, N = Info->NumTemplateArgs; I != N; ++I)
Guy Benyei11169dd2012-12-18 14:30:41 +0000744 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
745 return true;
746
747 return VisitCXXRecordDecl(D);
748}
749
750bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
751 // Visit the default argument.
752 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
753 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
754 if (Visit(DefArg->getTypeLoc()))
755 return true;
756
757 return false;
758}
759
760bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
761 if (Expr *Init = D->getInitExpr())
762 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
763 return false;
764}
765
766bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000767 unsigned NumParamList = DD->getNumTemplateParameterLists();
768 for (unsigned i = 0; i < NumParamList; i++) {
769 TemplateParameterList* Params = DD->getTemplateParameterList(i);
770 if (VisitTemplateParameters(Params))
771 return true;
772 }
773
Guy Benyei11169dd2012-12-18 14:30:41 +0000774 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
775 if (Visit(TSInfo->getTypeLoc()))
776 return true;
777
778 // Visit the nested-name-specifier, if present.
779 if (NestedNameSpecifierLoc QualifierLoc = DD->getQualifierLoc())
780 if (VisitNestedNameSpecifierLoc(QualifierLoc))
781 return true;
782
783 return false;
784}
785
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000786/// \brief Compare two base or member initializers based on their source order.
787static int CompareCXXCtorInitializers(CXXCtorInitializer *const *X,
788 CXXCtorInitializer *const *Y) {
789 return (*X)->getSourceOrder() - (*Y)->getSourceOrder();
790}
791
Guy Benyei11169dd2012-12-18 14:30:41 +0000792bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000793 unsigned NumParamList = ND->getNumTemplateParameterLists();
794 for (unsigned i = 0; i < NumParamList; i++) {
795 TemplateParameterList* Params = ND->getTemplateParameterList(i);
796 if (VisitTemplateParameters(Params))
797 return true;
798 }
799
Guy Benyei11169dd2012-12-18 14:30:41 +0000800 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
801 // Visit the function declaration's syntactic components in the order
802 // written. This requires a bit of work.
803 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
David Blaikie6adc78e2013-02-18 22:06:02 +0000804 FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000805
806 // If we have a function declared directly (without the use of a typedef),
807 // visit just the return type. Otherwise, just visit the function's type
808 // now.
Alp Toker42a16a62014-01-25 23:51:36 +0000809 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL.getReturnLoc())) ||
Guy Benyei11169dd2012-12-18 14:30:41 +0000810 (!FTL && Visit(TL)))
811 return true;
812
813 // Visit the nested-name-specifier, if present.
814 if (NestedNameSpecifierLoc QualifierLoc = ND->getQualifierLoc())
815 if (VisitNestedNameSpecifierLoc(QualifierLoc))
816 return true;
817
818 // Visit the declaration name.
Argyrios Kyrtzidis4a4d2b42014-02-09 08:13:47 +0000819 if (!isa<CXXDestructorDecl>(ND))
820 if (VisitDeclarationNameInfo(ND->getNameInfo()))
821 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +0000822
823 // FIXME: Visit explicitly-specified template arguments!
824
825 // Visit the function parameters, if we have a function type.
David Blaikie6adc78e2013-02-18 22:06:02 +0000826 if (FTL && VisitFunctionTypeLoc(FTL, true))
Guy Benyei11169dd2012-12-18 14:30:41 +0000827 return true;
828
Bill Wendling44426052012-12-20 19:22:21 +0000829 // FIXME: Attributes?
Guy Benyei11169dd2012-12-18 14:30:41 +0000830 }
831
832 if (ND->doesThisDeclarationHaveABody() && !ND->isLateTemplateParsed()) {
833 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
834 // Find the initializers that were written in the source.
835 SmallVector<CXXCtorInitializer *, 4> WrittenInits;
Aaron Ballman0ad78302014-03-13 17:34:31 +0000836 for (auto *I : Constructor->inits()) {
837 if (!I->isWritten())
Guy Benyei11169dd2012-12-18 14:30:41 +0000838 continue;
839
Aaron Ballman0ad78302014-03-13 17:34:31 +0000840 WrittenInits.push_back(I);
Guy Benyei11169dd2012-12-18 14:30:41 +0000841 }
842
843 // Sort the initializers in source order
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000844 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
845 &CompareCXXCtorInitializers);
846
Guy Benyei11169dd2012-12-18 14:30:41 +0000847 // Visit the initializers in source order
848 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
849 CXXCtorInitializer *Init = WrittenInits[I];
850 if (Init->isAnyMemberInitializer()) {
851 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
852 Init->getMemberLocation(), TU)))
853 return true;
854 } else if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo()) {
855 if (Visit(TInfo->getTypeLoc()))
856 return true;
857 }
858
859 // Visit the initializer value.
860 if (Expr *Initializer = Init->getInit())
861 if (Visit(MakeCXCursor(Initializer, ND, TU, RegionOfInterest)))
862 return true;
863 }
864 }
865
866 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
867 return true;
868 }
869
870 return false;
871}
872
873bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
874 if (VisitDeclaratorDecl(D))
875 return true;
876
877 if (Expr *BitWidth = D->getBitWidth())
878 return Visit(MakeCXCursor(BitWidth, StmtParent, TU, RegionOfInterest));
879
880 return false;
881}
882
883bool CursorVisitor::VisitVarDecl(VarDecl *D) {
884 if (VisitDeclaratorDecl(D))
885 return true;
886
887 if (Expr *Init = D->getInit())
888 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
889
890 return false;
891}
892
893bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
894 if (VisitDeclaratorDecl(D))
895 return true;
896
897 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
898 if (Expr *DefArg = D->getDefaultArgument())
899 return Visit(MakeCXCursor(DefArg, StmtParent, TU, RegionOfInterest));
900
901 return false;
902}
903
904bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
905 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
906 // before visiting these template parameters.
907 if (VisitTemplateParameters(D->getTemplateParameters()))
908 return true;
909
910 return VisitFunctionDecl(D->getTemplatedDecl());
911}
912
913bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
914 // FIXME: Visit the "outer" template parameter lists on the TagDecl
915 // before visiting these template parameters.
916 if (VisitTemplateParameters(D->getTemplateParameters()))
917 return true;
918
919 return VisitCXXRecordDecl(D->getTemplatedDecl());
920}
921
922bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
923 if (VisitTemplateParameters(D->getTemplateParameters()))
924 return true;
925
926 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
927 VisitTemplateArgumentLoc(D->getDefaultArgument()))
928 return true;
929
930 return false;
931}
932
Douglas Gregor9bda6cf2015-07-07 03:58:14 +0000933bool CursorVisitor::VisitObjCTypeParamDecl(ObjCTypeParamDecl *D) {
934 // Visit the bound, if it's explicit.
935 if (D->hasExplicitBound()) {
936 if (auto TInfo = D->getTypeSourceInfo()) {
937 if (Visit(TInfo->getTypeLoc()))
938 return true;
939 }
940 }
941
942 return false;
943}
944
Guy Benyei11169dd2012-12-18 14:30:41 +0000945bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Alp Toker314cc812014-01-25 16:55:45 +0000946 if (TypeSourceInfo *TSInfo = ND->getReturnTypeSourceInfo())
Guy Benyei11169dd2012-12-18 14:30:41 +0000947 if (Visit(TSInfo->getTypeLoc()))
948 return true;
949
David Majnemer59f77922016-06-24 04:05:48 +0000950 for (const auto *P : ND->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000951 if (Visit(MakeCXCursor(P, TU, RegionOfInterest)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000952 return true;
953 }
954
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000955 return ND->isThisDeclarationADefinition() &&
956 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest));
Guy Benyei11169dd2012-12-18 14:30:41 +0000957}
958
959template <typename DeclIt>
960static void addRangedDeclsInContainer(DeclIt *DI_current, DeclIt DE_current,
961 SourceManager &SM, SourceLocation EndLoc,
962 SmallVectorImpl<Decl *> &Decls) {
963 DeclIt next = *DI_current;
964 while (++next != DE_current) {
965 Decl *D_next = *next;
966 if (!D_next)
967 break;
968 SourceLocation L = D_next->getLocStart();
969 if (!L.isValid())
970 break;
971 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
972 *DI_current = next;
973 Decls.push_back(D_next);
974 continue;
975 }
976 break;
977 }
978}
979
Guy Benyei11169dd2012-12-18 14:30:41 +0000980bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
981 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
982 // an @implementation can lexically contain Decls that are not properly
983 // nested in the AST. When we identify such cases, we need to retrofit
984 // this nesting here.
985 if (!DI_current && !FileDI_current)
986 return VisitDeclContext(D);
987
988 // Scan the Decls that immediately come after the container
989 // in the current DeclContext. If any fall within the
990 // container's lexical region, stash them into a vector
991 // for later processing.
992 SmallVector<Decl *, 24> DeclsInContainer;
993 SourceLocation EndLoc = D->getSourceRange().getEnd();
994 SourceManager &SM = AU->getSourceManager();
995 if (EndLoc.isValid()) {
996 if (DI_current) {
997 addRangedDeclsInContainer(DI_current, DE_current, SM, EndLoc,
998 DeclsInContainer);
999 } else {
1000 addRangedDeclsInContainer(FileDI_current, FileDE_current, SM, EndLoc,
1001 DeclsInContainer);
1002 }
1003 }
1004
1005 // The common case.
1006 if (DeclsInContainer.empty())
1007 return VisitDeclContext(D);
1008
1009 // Get all the Decls in the DeclContext, and sort them with the
1010 // additional ones we've collected. Then visit them.
Aaron Ballman629afae2014-03-07 19:56:05 +00001011 for (auto *SubDecl : D->decls()) {
1012 if (!SubDecl || SubDecl->getLexicalDeclContext() != D ||
1013 SubDecl->getLocStart().isInvalid())
Guy Benyei11169dd2012-12-18 14:30:41 +00001014 continue;
Aaron Ballman629afae2014-03-07 19:56:05 +00001015 DeclsInContainer.push_back(SubDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001016 }
1017
1018 // Now sort the Decls so that they appear in lexical order.
1019 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001020 [&SM](Decl *A, Decl *B) {
1021 SourceLocation L_A = A->getLocStart();
1022 SourceLocation L_B = B->getLocStart();
1023 assert(L_A.isValid() && L_B.isValid());
1024 return SM.isBeforeInTranslationUnit(L_A, L_B);
1025 });
Guy Benyei11169dd2012-12-18 14:30:41 +00001026
1027 // Now visit the decls.
1028 for (SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
1029 E = DeclsInContainer.end(); I != E; ++I) {
1030 CXCursor Cursor = MakeCXCursor(*I, TU, RegionOfInterest);
Ted Kremenek03325582013-02-21 01:29:01 +00001031 const Optional<bool> &V = shouldVisitCursor(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00001032 if (!V.hasValue())
1033 continue;
1034 if (!V.getValue())
1035 return false;
1036 if (Visit(Cursor, true))
1037 return true;
1038 }
1039 return false;
1040}
1041
1042bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
1043 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
1044 TU)))
1045 return true;
1046
Douglas Gregore9d95f12015-07-07 03:57:35 +00001047 if (VisitObjCTypeParamList(ND->getTypeParamList()))
1048 return true;
1049
Guy Benyei11169dd2012-12-18 14:30:41 +00001050 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
1051 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
1052 E = ND->protocol_end(); I != E; ++I, ++PL)
1053 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1054 return true;
1055
1056 return VisitObjCContainerDecl(ND);
1057}
1058
1059bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1060 if (!PID->isThisDeclarationADefinition())
1061 return Visit(MakeCursorObjCProtocolRef(PID, PID->getLocation(), TU));
1062
1063 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
1064 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
1065 E = PID->protocol_end(); I != E; ++I, ++PL)
1066 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1067 return true;
1068
1069 return VisitObjCContainerDecl(PID);
1070}
1071
1072bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
1073 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
1074 return true;
1075
1076 // FIXME: This implements a workaround with @property declarations also being
1077 // installed in the DeclContext for the @interface. Eventually this code
1078 // should be removed.
1079 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
1080 if (!CDecl || !CDecl->IsClassExtension())
1081 return false;
1082
1083 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
1084 if (!ID)
1085 return false;
1086
1087 IdentifierInfo *PropertyId = PD->getIdentifier();
1088 ObjCPropertyDecl *prevDecl =
Manman Ren5b786402016-01-28 18:49:28 +00001089 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId,
1090 PD->getQueryKind());
Guy Benyei11169dd2012-12-18 14:30:41 +00001091
1092 if (!prevDecl)
1093 return false;
1094
1095 // Visit synthesized methods since they will be skipped when visiting
1096 // the @interface.
1097 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
1098 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1099 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1100 return true;
1101
1102 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
1103 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1104 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1105 return true;
1106
1107 return false;
1108}
1109
Douglas Gregore9d95f12015-07-07 03:57:35 +00001110bool CursorVisitor::VisitObjCTypeParamList(ObjCTypeParamList *typeParamList) {
1111 if (!typeParamList)
1112 return false;
1113
1114 for (auto *typeParam : *typeParamList) {
1115 // Visit the type parameter.
1116 if (Visit(MakeCXCursor(typeParam, TU, RegionOfInterest)))
1117 return true;
Douglas Gregore9d95f12015-07-07 03:57:35 +00001118 }
1119
1120 return false;
1121}
1122
Guy Benyei11169dd2012-12-18 14:30:41 +00001123bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
1124 if (!D->isThisDeclarationADefinition()) {
1125 // Forward declaration is treated like a reference.
1126 return Visit(MakeCursorObjCClassRef(D, D->getLocation(), TU));
1127 }
1128
Douglas Gregore9d95f12015-07-07 03:57:35 +00001129 // Objective-C type parameters.
1130 if (VisitObjCTypeParamList(D->getTypeParamListAsWritten()))
1131 return true;
1132
Guy Benyei11169dd2012-12-18 14:30:41 +00001133 // Issue callbacks for super class.
1134 if (D->getSuperClass() &&
1135 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1136 D->getSuperClassLoc(),
1137 TU)))
1138 return true;
1139
Douglas Gregore9d95f12015-07-07 03:57:35 +00001140 if (TypeSourceInfo *SuperClassTInfo = D->getSuperClassTInfo())
1141 if (Visit(SuperClassTInfo->getTypeLoc()))
1142 return true;
1143
Guy Benyei11169dd2012-12-18 14:30:41 +00001144 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1145 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1146 E = D->protocol_end(); I != E; ++I, ++PL)
1147 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1148 return true;
1149
1150 return VisitObjCContainerDecl(D);
1151}
1152
1153bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1154 return VisitObjCContainerDecl(D);
1155}
1156
1157bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
1158 // 'ID' could be null when dealing with invalid code.
1159 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1160 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1161 return true;
1162
1163 return VisitObjCImplDecl(D);
1164}
1165
1166bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1167#if 0
1168 // Issue callbacks for super class.
1169 // FIXME: No source location information!
1170 if (D->getSuperClass() &&
1171 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1172 D->getSuperClassLoc(),
1173 TU)))
1174 return true;
1175#endif
1176
1177 return VisitObjCImplDecl(D);
1178}
1179
1180bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1181 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1182 if (PD->isIvarNameSpecified())
1183 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1184
1185 return false;
1186}
1187
1188bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1189 return VisitDeclContext(D);
1190}
1191
1192bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1193 // Visit nested-name-specifier.
1194 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1195 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1196 return true;
1197
1198 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1199 D->getTargetNameLoc(), TU));
1200}
1201
1202bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1203 // Visit nested-name-specifier.
1204 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1205 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1206 return true;
1207 }
1208
1209 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1210 return true;
1211
1212 return VisitDeclarationNameInfo(D->getNameInfo());
1213}
1214
1215bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1216 // Visit nested-name-specifier.
1217 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1218 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1219 return true;
1220
1221 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1222 D->getIdentLocation(), TU));
1223}
1224
1225bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1226 // Visit nested-name-specifier.
1227 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1228 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1229 return true;
1230 }
1231
1232 return VisitDeclarationNameInfo(D->getNameInfo());
1233}
1234
1235bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1236 UnresolvedUsingTypenameDecl *D) {
1237 // Visit nested-name-specifier.
1238 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1239 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1240 return true;
1241
1242 return false;
1243}
1244
Olivier Goffart81978012016-06-09 16:15:55 +00001245bool CursorVisitor::VisitStaticAssertDecl(StaticAssertDecl *D) {
1246 if (Visit(MakeCXCursor(D->getAssertExpr(), StmtParent, TU, RegionOfInterest)))
1247 return true;
Richard Trieuf3b77662016-09-13 01:37:01 +00001248 if (StringLiteral *Message = D->getMessage())
1249 if (Visit(MakeCXCursor(Message, StmtParent, TU, RegionOfInterest)))
1250 return true;
Olivier Goffart81978012016-06-09 16:15:55 +00001251 return false;
1252}
1253
Olivier Goffartd211c642016-11-04 06:29:27 +00001254bool CursorVisitor::VisitFriendDecl(FriendDecl *D) {
1255 if (NamedDecl *FriendD = D->getFriendDecl()) {
1256 if (Visit(MakeCXCursor(FriendD, TU, RegionOfInterest)))
1257 return true;
1258 } else if (TypeSourceInfo *TI = D->getFriendType()) {
1259 if (Visit(TI->getTypeLoc()))
1260 return true;
1261 }
1262 return false;
1263}
1264
Guy Benyei11169dd2012-12-18 14:30:41 +00001265bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1266 switch (Name.getName().getNameKind()) {
1267 case clang::DeclarationName::Identifier:
1268 case clang::DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00001269 case clang::DeclarationName::CXXDeductionGuideName:
Guy Benyei11169dd2012-12-18 14:30:41 +00001270 case clang::DeclarationName::CXXOperatorName:
1271 case clang::DeclarationName::CXXUsingDirective:
1272 return false;
Richard Smith35845152017-02-07 01:37:30 +00001273
Guy Benyei11169dd2012-12-18 14:30:41 +00001274 case clang::DeclarationName::CXXConstructorName:
1275 case clang::DeclarationName::CXXDestructorName:
1276 case clang::DeclarationName::CXXConversionFunctionName:
1277 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1278 return Visit(TSInfo->getTypeLoc());
1279 return false;
1280
1281 case clang::DeclarationName::ObjCZeroArgSelector:
1282 case clang::DeclarationName::ObjCOneArgSelector:
1283 case clang::DeclarationName::ObjCMultiArgSelector:
1284 // FIXME: Per-identifier location info?
1285 return false;
1286 }
1287
1288 llvm_unreachable("Invalid DeclarationName::Kind!");
1289}
1290
1291bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1292 SourceRange Range) {
1293 // FIXME: This whole routine is a hack to work around the lack of proper
1294 // source information in nested-name-specifiers (PR5791). Since we do have
1295 // a beginning source location, we can visit the first component of the
1296 // nested-name-specifier, if it's a single-token component.
1297 if (!NNS)
1298 return false;
1299
1300 // Get the first component in the nested-name-specifier.
1301 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1302 NNS = Prefix;
1303
1304 switch (NNS->getKind()) {
1305 case NestedNameSpecifier::Namespace:
1306 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1307 TU));
1308
1309 case NestedNameSpecifier::NamespaceAlias:
1310 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1311 Range.getBegin(), TU));
1312
1313 case NestedNameSpecifier::TypeSpec: {
1314 // If the type has a form where we know that the beginning of the source
1315 // range matches up with a reference cursor. Visit the appropriate reference
1316 // cursor.
1317 const Type *T = NNS->getAsType();
1318 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1319 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1320 if (const TagType *Tag = dyn_cast<TagType>(T))
1321 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1322 if (const TemplateSpecializationType *TST
1323 = dyn_cast<TemplateSpecializationType>(T))
1324 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1325 break;
1326 }
1327
1328 case NestedNameSpecifier::TypeSpecWithTemplate:
1329 case NestedNameSpecifier::Global:
1330 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001331 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001332 break;
1333 }
1334
1335 return false;
1336}
1337
1338bool
1339CursorVisitor::VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1340 SmallVector<NestedNameSpecifierLoc, 4> Qualifiers;
1341 for (; Qualifier; Qualifier = Qualifier.getPrefix())
1342 Qualifiers.push_back(Qualifier);
1343
1344 while (!Qualifiers.empty()) {
1345 NestedNameSpecifierLoc Q = Qualifiers.pop_back_val();
1346 NestedNameSpecifier *NNS = Q.getNestedNameSpecifier();
1347 switch (NNS->getKind()) {
1348 case NestedNameSpecifier::Namespace:
1349 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(),
1350 Q.getLocalBeginLoc(),
1351 TU)))
1352 return true;
1353
1354 break;
1355
1356 case NestedNameSpecifier::NamespaceAlias:
1357 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1358 Q.getLocalBeginLoc(),
1359 TU)))
1360 return true;
1361
1362 break;
1363
1364 case NestedNameSpecifier::TypeSpec:
1365 case NestedNameSpecifier::TypeSpecWithTemplate:
1366 if (Visit(Q.getTypeLoc()))
1367 return true;
1368
1369 break;
1370
1371 case NestedNameSpecifier::Global:
1372 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001373 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001374 break;
1375 }
1376 }
1377
1378 return false;
1379}
1380
1381bool CursorVisitor::VisitTemplateParameters(
1382 const TemplateParameterList *Params) {
1383 if (!Params)
1384 return false;
1385
1386 for (TemplateParameterList::const_iterator P = Params->begin(),
1387 PEnd = Params->end();
1388 P != PEnd; ++P) {
1389 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
1390 return true;
1391 }
1392
1393 return false;
1394}
1395
1396bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1397 switch (Name.getKind()) {
1398 case TemplateName::Template:
1399 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1400
1401 case TemplateName::OverloadedTemplate:
1402 // Visit the overloaded template set.
1403 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1404 return true;
1405
1406 return false;
1407
1408 case TemplateName::DependentTemplate:
1409 // FIXME: Visit nested-name-specifier.
1410 return false;
1411
1412 case TemplateName::QualifiedTemplate:
1413 // FIXME: Visit nested-name-specifier.
1414 return Visit(MakeCursorTemplateRef(
1415 Name.getAsQualifiedTemplateName()->getDecl(),
1416 Loc, TU));
1417
1418 case TemplateName::SubstTemplateTemplateParm:
1419 return Visit(MakeCursorTemplateRef(
1420 Name.getAsSubstTemplateTemplateParm()->getParameter(),
1421 Loc, TU));
1422
1423 case TemplateName::SubstTemplateTemplateParmPack:
1424 return Visit(MakeCursorTemplateRef(
1425 Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1426 Loc, TU));
1427 }
1428
1429 llvm_unreachable("Invalid TemplateName::Kind!");
1430}
1431
1432bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1433 switch (TAL.getArgument().getKind()) {
1434 case TemplateArgument::Null:
1435 case TemplateArgument::Integral:
1436 case TemplateArgument::Pack:
1437 return false;
1438
1439 case TemplateArgument::Type:
1440 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1441 return Visit(TSInfo->getTypeLoc());
1442 return false;
1443
1444 case TemplateArgument::Declaration:
1445 if (Expr *E = TAL.getSourceDeclExpression())
1446 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1447 return false;
1448
1449 case TemplateArgument::NullPtr:
1450 if (Expr *E = TAL.getSourceNullPtrExpression())
1451 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1452 return false;
1453
1454 case TemplateArgument::Expression:
1455 if (Expr *E = TAL.getSourceExpression())
1456 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1457 return false;
1458
1459 case TemplateArgument::Template:
1460 case TemplateArgument::TemplateExpansion:
1461 if (VisitNestedNameSpecifierLoc(TAL.getTemplateQualifierLoc()))
1462 return true;
1463
1464 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
1465 TAL.getTemplateNameLoc());
1466 }
1467
1468 llvm_unreachable("Invalid TemplateArgument::Kind!");
1469}
1470
1471bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1472 return VisitDeclContext(D);
1473}
1474
1475bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1476 return Visit(TL.getUnqualifiedLoc());
1477}
1478
1479bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1480 ASTContext &Context = AU->getASTContext();
1481
1482 // Some builtin types (such as Objective-C's "id", "sel", and
1483 // "Class") have associated declarations. Create cursors for those.
1484 QualType VisitType;
1485 switch (TL.getTypePtr()->getKind()) {
1486
1487 case BuiltinType::Void:
1488 case BuiltinType::NullPtr:
1489 case BuiltinType::Dependent:
Alexey Bader954ba212016-04-08 13:40:33 +00001490#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1491 case BuiltinType::Id:
Alexey Baderb62f1442016-04-13 08:33:41 +00001492#include "clang/Basic/OpenCLImageTypes.def"
NAKAMURA Takumi288c42e2013-02-07 12:47:42 +00001493 case BuiltinType::OCLSampler:
Guy Benyei1b4fb3e2013-01-20 12:31:11 +00001494 case BuiltinType::OCLEvent:
Alexey Bader9c8453f2015-09-15 11:18:52 +00001495 case BuiltinType::OCLClkEvent:
1496 case BuiltinType::OCLQueue:
Alexey Bader9c8453f2015-09-15 11:18:52 +00001497 case BuiltinType::OCLReserveID:
Guy Benyei11169dd2012-12-18 14:30:41 +00001498#define BUILTIN_TYPE(Id, SingletonId)
1499#define SIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1500#define UNSIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1501#define FLOATING_TYPE(Id, SingletonId) case BuiltinType::Id:
1502#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
1503#include "clang/AST/BuiltinTypes.def"
1504 break;
1505
1506 case BuiltinType::ObjCId:
1507 VisitType = Context.getObjCIdType();
1508 break;
1509
1510 case BuiltinType::ObjCClass:
1511 VisitType = Context.getObjCClassType();
1512 break;
1513
1514 case BuiltinType::ObjCSel:
1515 VisitType = Context.getObjCSelType();
1516 break;
1517 }
1518
1519 if (!VisitType.isNull()) {
1520 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1521 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1522 TU));
1523 }
1524
1525 return false;
1526}
1527
1528bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1529 return Visit(MakeCursorTypeRef(TL.getTypedefNameDecl(), TL.getNameLoc(), TU));
1530}
1531
1532bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1533 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1534}
1535
1536bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1537 if (TL.isDefinition())
1538 return Visit(MakeCXCursor(TL.getDecl(), TU, RegionOfInterest));
1539
1540 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1541}
1542
1543bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1544 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1545}
1546
1547bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001548 return Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +00001549}
1550
Manman Rene6be26c2016-09-13 17:25:08 +00001551bool CursorVisitor::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
1552 if (Visit(MakeCursorTypeRef(TL.getDecl(), TL.getLocStart(), TU)))
1553 return true;
1554 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1555 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1556 TU)))
1557 return true;
1558 }
1559
1560 return false;
1561}
1562
Guy Benyei11169dd2012-12-18 14:30:41 +00001563bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1564 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1565 return true;
1566
Douglas Gregore9d95f12015-07-07 03:57:35 +00001567 for (unsigned I = 0, N = TL.getNumTypeArgs(); I != N; ++I) {
1568 if (Visit(TL.getTypeArgTInfo(I)->getTypeLoc()))
1569 return true;
1570 }
1571
Guy Benyei11169dd2012-12-18 14:30:41 +00001572 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1573 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1574 TU)))
1575 return true;
1576 }
1577
1578 return false;
1579}
1580
1581bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1582 return Visit(TL.getPointeeLoc());
1583}
1584
1585bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1586 return Visit(TL.getInnerLoc());
1587}
1588
1589bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1590 return Visit(TL.getPointeeLoc());
1591}
1592
1593bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1594 return Visit(TL.getPointeeLoc());
1595}
1596
1597bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1598 return Visit(TL.getPointeeLoc());
1599}
1600
1601bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1602 return Visit(TL.getPointeeLoc());
1603}
1604
1605bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1606 return Visit(TL.getPointeeLoc());
1607}
1608
1609bool CursorVisitor::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
1610 return Visit(TL.getModifiedLoc());
1611}
1612
1613bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1614 bool SkipResultType) {
Alp Toker42a16a62014-01-25 23:51:36 +00001615 if (!SkipResultType && Visit(TL.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001616 return true;
1617
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00001618 for (unsigned I = 0, N = TL.getNumParams(); I != N; ++I)
1619 if (Decl *D = TL.getParam(I))
Guy Benyei11169dd2012-12-18 14:30:41 +00001620 if (Visit(MakeCXCursor(D, TU, RegionOfInterest)))
1621 return true;
1622
1623 return false;
1624}
1625
1626bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1627 if (Visit(TL.getElementLoc()))
1628 return true;
1629
1630 if (Expr *Size = TL.getSizeExpr())
1631 return Visit(MakeCXCursor(Size, StmtParent, TU, RegionOfInterest));
1632
1633 return false;
1634}
1635
Reid Kleckner8a365022013-06-24 17:51:48 +00001636bool CursorVisitor::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
1637 return Visit(TL.getOriginalLoc());
1638}
1639
Reid Kleckner0503a872013-12-05 01:23:43 +00001640bool CursorVisitor::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
1641 return Visit(TL.getOriginalLoc());
1642}
1643
Richard Smith600b5262017-01-26 20:40:47 +00001644bool CursorVisitor::VisitDeducedTemplateSpecializationTypeLoc(
1645 DeducedTemplateSpecializationTypeLoc TL) {
1646 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1647 TL.getTemplateNameLoc()))
1648 return true;
1649
1650 return false;
1651}
1652
Guy Benyei11169dd2012-12-18 14:30:41 +00001653bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1654 TemplateSpecializationTypeLoc TL) {
1655 // Visit the template name.
1656 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1657 TL.getTemplateNameLoc()))
1658 return true;
1659
1660 // Visit the template arguments.
1661 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1662 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1663 return true;
1664
1665 return false;
1666}
1667
1668bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1669 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1670}
1671
1672bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1673 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1674 return Visit(TSInfo->getTypeLoc());
1675
1676 return false;
1677}
1678
1679bool CursorVisitor::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
1680 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1681 return Visit(TSInfo->getTypeLoc());
1682
1683 return false;
1684}
1685
1686bool CursorVisitor::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001687 return VisitNestedNameSpecifierLoc(TL.getQualifierLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00001688}
1689
1690bool CursorVisitor::VisitDependentTemplateSpecializationTypeLoc(
1691 DependentTemplateSpecializationTypeLoc TL) {
1692 // Visit the nested-name-specifier, if there is one.
1693 if (TL.getQualifierLoc() &&
1694 VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1695 return true;
1696
1697 // Visit the template arguments.
1698 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1699 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1700 return true;
1701
1702 return false;
1703}
1704
1705bool CursorVisitor::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
1706 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1707 return true;
1708
1709 return Visit(TL.getNamedTypeLoc());
1710}
1711
1712bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1713 return Visit(TL.getPatternLoc());
1714}
1715
1716bool CursorVisitor::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
1717 if (Expr *E = TL.getUnderlyingExpr())
1718 return Visit(MakeCXCursor(E, StmtParent, TU));
1719
1720 return false;
1721}
1722
1723bool CursorVisitor::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
1724 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1725}
1726
1727bool CursorVisitor::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
1728 return Visit(TL.getValueLoc());
1729}
1730
Xiuli Pan9c14e282016-01-09 12:53:17 +00001731bool CursorVisitor::VisitPipeTypeLoc(PipeTypeLoc TL) {
1732 return Visit(TL.getValueLoc());
1733}
1734
Guy Benyei11169dd2012-12-18 14:30:41 +00001735#define DEFAULT_TYPELOC_IMPL(CLASS, PARENT) \
1736bool CursorVisitor::Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
1737 return Visit##PARENT##Loc(TL); \
1738}
1739
1740DEFAULT_TYPELOC_IMPL(Complex, Type)
1741DEFAULT_TYPELOC_IMPL(ConstantArray, ArrayType)
1742DEFAULT_TYPELOC_IMPL(IncompleteArray, ArrayType)
1743DEFAULT_TYPELOC_IMPL(VariableArray, ArrayType)
1744DEFAULT_TYPELOC_IMPL(DependentSizedArray, ArrayType)
1745DEFAULT_TYPELOC_IMPL(DependentSizedExtVector, Type)
1746DEFAULT_TYPELOC_IMPL(Vector, Type)
1747DEFAULT_TYPELOC_IMPL(ExtVector, VectorType)
1748DEFAULT_TYPELOC_IMPL(FunctionProto, FunctionType)
1749DEFAULT_TYPELOC_IMPL(FunctionNoProto, FunctionType)
1750DEFAULT_TYPELOC_IMPL(Record, TagType)
1751DEFAULT_TYPELOC_IMPL(Enum, TagType)
1752DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParm, Type)
1753DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParmPack, Type)
1754DEFAULT_TYPELOC_IMPL(Auto, Type)
1755
1756bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1757 // Visit the nested-name-specifier, if present.
1758 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1759 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1760 return true;
1761
1762 if (D->isCompleteDefinition()) {
Aaron Ballman574705e2014-03-13 15:41:46 +00001763 for (const auto &I : D->bases()) {
1764 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(&I, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001765 return true;
1766 }
1767 }
1768
1769 return VisitTagDecl(D);
1770}
1771
1772bool CursorVisitor::VisitAttributes(Decl *D) {
Aaron Ballmanb97112e2014-03-08 22:19:01 +00001773 for (const auto *I : D->attrs())
1774 if (Visit(MakeCXCursor(I, D, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001775 return true;
1776
1777 return false;
1778}
1779
1780//===----------------------------------------------------------------------===//
1781// Data-recursive visitor methods.
1782//===----------------------------------------------------------------------===//
1783
1784namespace {
1785#define DEF_JOB(NAME, DATA, KIND)\
1786class NAME : public VisitorJob {\
1787public:\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001788 NAME(const DATA *d, CXCursor parent) : \
1789 VisitorJob(parent, VisitorJob::KIND, d) {} \
Guy Benyei11169dd2012-12-18 14:30:41 +00001790 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001791 const DATA *get() const { return static_cast<const DATA*>(data[0]); }\
Guy Benyei11169dd2012-12-18 14:30:41 +00001792};
1793
1794DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1795DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
1796DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
1797DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Guy Benyei11169dd2012-12-18 14:30:41 +00001798DEF_JOB(SizeOfPackExprParts, SizeOfPackExpr, SizeOfPackExprPartsKind)
1799DEF_JOB(LambdaExprParts, LambdaExpr, LambdaExprPartsKind)
1800DEF_JOB(PostChildrenVisit, void, PostChildrenVisitKind)
1801#undef DEF_JOB
1802
James Y Knight04ec5bf2015-12-24 02:59:37 +00001803class ExplicitTemplateArgsVisit : public VisitorJob {
1804public:
1805 ExplicitTemplateArgsVisit(const TemplateArgumentLoc *Begin,
1806 const TemplateArgumentLoc *End, CXCursor parent)
1807 : VisitorJob(parent, VisitorJob::ExplicitTemplateArgsVisitKind, Begin,
1808 End) {}
1809 static bool classof(const VisitorJob *VJ) {
1810 return VJ->getKind() == ExplicitTemplateArgsVisitKind;
1811 }
1812 const TemplateArgumentLoc *begin() const {
1813 return static_cast<const TemplateArgumentLoc *>(data[0]);
1814 }
1815 const TemplateArgumentLoc *end() {
1816 return static_cast<const TemplateArgumentLoc *>(data[1]);
1817 }
1818};
Guy Benyei11169dd2012-12-18 14:30:41 +00001819class DeclVisit : public VisitorJob {
1820public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001821 DeclVisit(const Decl *D, CXCursor parent, bool isFirst) :
Guy Benyei11169dd2012-12-18 14:30:41 +00001822 VisitorJob(parent, VisitorJob::DeclVisitKind,
Craig Topper69186e72014-06-08 08:38:04 +00001823 D, isFirst ? (void*) 1 : (void*) nullptr) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001824 static bool classof(const VisitorJob *VJ) {
1825 return VJ->getKind() == DeclVisitKind;
1826 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001827 const Decl *get() const { return static_cast<const Decl *>(data[0]); }
Dmitri Gribenkoe5423a72015-03-23 19:23:50 +00001828 bool isFirst() const { return data[1] != nullptr; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001829};
1830class TypeLocVisit : public VisitorJob {
1831public:
1832 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1833 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1834 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1835
1836 static bool classof(const VisitorJob *VJ) {
1837 return VJ->getKind() == TypeLocVisitKind;
1838 }
1839
1840 TypeLoc get() const {
1841 QualType T = QualType::getFromOpaquePtr(data[0]);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001842 return TypeLoc(T, const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001843 }
1844};
1845
1846class LabelRefVisit : public VisitorJob {
1847public:
1848 LabelRefVisit(LabelDecl *LD, SourceLocation labelLoc, CXCursor parent)
1849 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LD,
1850 labelLoc.getPtrEncoding()) {}
1851
1852 static bool classof(const VisitorJob *VJ) {
1853 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1854 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001855 const LabelDecl *get() const {
1856 return static_cast<const LabelDecl *>(data[0]);
1857 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001858 SourceLocation getLoc() const {
1859 return SourceLocation::getFromPtrEncoding(data[1]); }
1860};
1861
1862class NestedNameSpecifierLocVisit : public VisitorJob {
1863public:
1864 NestedNameSpecifierLocVisit(NestedNameSpecifierLoc Qualifier, CXCursor parent)
1865 : VisitorJob(parent, VisitorJob::NestedNameSpecifierLocVisitKind,
1866 Qualifier.getNestedNameSpecifier(),
1867 Qualifier.getOpaqueData()) { }
1868
1869 static bool classof(const VisitorJob *VJ) {
1870 return VJ->getKind() == VisitorJob::NestedNameSpecifierLocVisitKind;
1871 }
1872
1873 NestedNameSpecifierLoc get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001874 return NestedNameSpecifierLoc(
1875 const_cast<NestedNameSpecifier *>(
1876 static_cast<const NestedNameSpecifier *>(data[0])),
1877 const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001878 }
1879};
1880
1881class DeclarationNameInfoVisit : public VisitorJob {
1882public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001883 DeclarationNameInfoVisit(const Stmt *S, CXCursor parent)
Dmitri Gribenkodd7dacf2013-02-03 13:19:54 +00001884 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001885 static bool classof(const VisitorJob *VJ) {
1886 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1887 }
1888 DeclarationNameInfo get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001889 const Stmt *S = static_cast<const Stmt *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001890 switch (S->getStmtClass()) {
1891 default:
1892 llvm_unreachable("Unhandled Stmt");
1893 case clang::Stmt::MSDependentExistsStmtClass:
1894 return cast<MSDependentExistsStmt>(S)->getNameInfo();
1895 case Stmt::CXXDependentScopeMemberExprClass:
1896 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1897 case Stmt::DependentScopeDeclRefExprClass:
1898 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001899 case Stmt::OMPCriticalDirectiveClass:
1900 return cast<OMPCriticalDirective>(S)->getDirectiveName();
Guy Benyei11169dd2012-12-18 14:30:41 +00001901 }
1902 }
1903};
1904class MemberRefVisit : public VisitorJob {
1905public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001906 MemberRefVisit(const FieldDecl *D, SourceLocation L, CXCursor parent)
Guy Benyei11169dd2012-12-18 14:30:41 +00001907 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1908 L.getPtrEncoding()) {}
1909 static bool classof(const VisitorJob *VJ) {
1910 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1911 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001912 const FieldDecl *get() const {
1913 return static_cast<const FieldDecl *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001914 }
1915 SourceLocation getLoc() const {
1916 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1917 }
1918};
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001919class EnqueueVisitor : public ConstStmtVisitor<EnqueueVisitor, void> {
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001920 friend class OMPClauseEnqueue;
Guy Benyei11169dd2012-12-18 14:30:41 +00001921 VisitorWorkList &WL;
1922 CXCursor Parent;
1923public:
1924 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1925 : WL(wl), Parent(parent) {}
1926
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001927 void VisitAddrLabelExpr(const AddrLabelExpr *E);
1928 void VisitBlockExpr(const BlockExpr *B);
1929 void VisitCompoundLiteralExpr(const CompoundLiteralExpr *E);
1930 void VisitCompoundStmt(const CompoundStmt *S);
1931 void VisitCXXDefaultArgExpr(const CXXDefaultArgExpr *E) { /* Do nothing. */ }
1932 void VisitMSDependentExistsStmt(const MSDependentExistsStmt *S);
1933 void VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E);
1934 void VisitCXXNewExpr(const CXXNewExpr *E);
1935 void VisitCXXScalarValueInitExpr(const CXXScalarValueInitExpr *E);
1936 void VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *E);
1937 void VisitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
1938 void VisitCXXTemporaryObjectExpr(const CXXTemporaryObjectExpr *E);
1939 void VisitCXXTypeidExpr(const CXXTypeidExpr *E);
1940 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *E);
1941 void VisitCXXUuidofExpr(const CXXUuidofExpr *E);
1942 void VisitCXXCatchStmt(const CXXCatchStmt *S);
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00001943 void VisitCXXForRangeStmt(const CXXForRangeStmt *S);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001944 void VisitDeclRefExpr(const DeclRefExpr *D);
1945 void VisitDeclStmt(const DeclStmt *S);
1946 void VisitDependentScopeDeclRefExpr(const DependentScopeDeclRefExpr *E);
1947 void VisitDesignatedInitExpr(const DesignatedInitExpr *E);
1948 void VisitExplicitCastExpr(const ExplicitCastExpr *E);
1949 void VisitForStmt(const ForStmt *FS);
1950 void VisitGotoStmt(const GotoStmt *GS);
1951 void VisitIfStmt(const IfStmt *If);
1952 void VisitInitListExpr(const InitListExpr *IE);
1953 void VisitMemberExpr(const MemberExpr *M);
1954 void VisitOffsetOfExpr(const OffsetOfExpr *E);
1955 void VisitObjCEncodeExpr(const ObjCEncodeExpr *E);
1956 void VisitObjCMessageExpr(const ObjCMessageExpr *M);
1957 void VisitOverloadExpr(const OverloadExpr *E);
1958 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *E);
1959 void VisitStmt(const Stmt *S);
1960 void VisitSwitchStmt(const SwitchStmt *S);
1961 void VisitWhileStmt(const WhileStmt *W);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001962 void VisitTypeTraitExpr(const TypeTraitExpr *E);
1963 void VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E);
1964 void VisitExpressionTraitExpr(const ExpressionTraitExpr *E);
1965 void VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U);
1966 void VisitVAArgExpr(const VAArgExpr *E);
1967 void VisitSizeOfPackExpr(const SizeOfPackExpr *E);
1968 void VisitPseudoObjectExpr(const PseudoObjectExpr *E);
1969 void VisitOpaqueValueExpr(const OpaqueValueExpr *E);
1970 void VisitLambdaExpr(const LambdaExpr *E);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001971 void VisitOMPExecutableDirective(const OMPExecutableDirective *D);
Alexander Musman3aaab662014-08-19 11:27:13 +00001972 void VisitOMPLoopDirective(const OMPLoopDirective *D);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001973 void VisitOMPParallelDirective(const OMPParallelDirective *D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00001974 void VisitOMPSimdDirective(const OMPSimdDirective *D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00001975 void VisitOMPForDirective(const OMPForDirective *D);
Alexander Musmanf82886e2014-09-18 05:12:34 +00001976 void VisitOMPForSimdDirective(const OMPForSimdDirective *D);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00001977 void VisitOMPSectionsDirective(const OMPSectionsDirective *D);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00001978 void VisitOMPSectionDirective(const OMPSectionDirective *D);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00001979 void VisitOMPSingleDirective(const OMPSingleDirective *D);
Alexander Musman80c22892014-07-17 08:54:58 +00001980 void VisitOMPMasterDirective(const OMPMasterDirective *D);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001981 void VisitOMPCriticalDirective(const OMPCriticalDirective *D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00001982 void VisitOMPParallelForDirective(const OMPParallelForDirective *D);
Alexander Musmane4e893b2014-09-23 09:33:00 +00001983 void VisitOMPParallelForSimdDirective(const OMPParallelForSimdDirective *D);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00001984 void VisitOMPParallelSectionsDirective(const OMPParallelSectionsDirective *D);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00001985 void VisitOMPTaskDirective(const OMPTaskDirective *D);
Alexey Bataev68446b72014-07-18 07:47:19 +00001986 void VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00001987 void VisitOMPBarrierDirective(const OMPBarrierDirective *D);
Alexey Bataev2df347a2014-07-18 10:17:07 +00001988 void VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00001989 void VisitOMPTaskgroupDirective(const OMPTaskgroupDirective *D);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00001990 void
1991 VisitOMPCancellationPointDirective(const OMPCancellationPointDirective *D);
Alexey Bataev80909872015-07-02 11:25:17 +00001992 void VisitOMPCancelDirective(const OMPCancelDirective *D);
Alexey Bataev6125da92014-07-21 11:26:11 +00001993 void VisitOMPFlushDirective(const OMPFlushDirective *D);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00001994 void VisitOMPOrderedDirective(const OMPOrderedDirective *D);
Alexey Bataev0162e452014-07-22 10:10:35 +00001995 void VisitOMPAtomicDirective(const OMPAtomicDirective *D);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00001996 void VisitOMPTargetDirective(const OMPTargetDirective *D);
Michael Wong65f367f2015-07-21 13:44:28 +00001997 void VisitOMPTargetDataDirective(const OMPTargetDataDirective *D);
Samuel Antaodf67fc42016-01-19 19:15:56 +00001998 void VisitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective *D);
Samuel Antao72590762016-01-19 20:04:50 +00001999 void VisitOMPTargetExitDataDirective(const OMPTargetExitDataDirective *D);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002000 void VisitOMPTargetParallelDirective(const OMPTargetParallelDirective *D);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002001 void
2002 VisitOMPTargetParallelForDirective(const OMPTargetParallelForDirective *D);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002003 void VisitOMPTeamsDirective(const OMPTeamsDirective *D);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002004 void VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002005 void VisitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective *D);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002006 void VisitOMPDistributeDirective(const OMPDistributeDirective *D);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002007 void VisitOMPDistributeParallelForDirective(
2008 const OMPDistributeParallelForDirective *D);
Kelvin Li4a39add2016-07-05 05:00:15 +00002009 void VisitOMPDistributeParallelForSimdDirective(
2010 const OMPDistributeParallelForSimdDirective *D);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002011 void VisitOMPDistributeSimdDirective(const OMPDistributeSimdDirective *D);
Kelvin Lia579b912016-07-14 02:54:56 +00002012 void VisitOMPTargetParallelForSimdDirective(
2013 const OMPTargetParallelForSimdDirective *D);
Kelvin Li986330c2016-07-20 22:57:10 +00002014 void VisitOMPTargetSimdDirective(const OMPTargetSimdDirective *D);
Kelvin Li02532872016-08-05 14:37:37 +00002015 void VisitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective *D);
Kelvin Li4e325f72016-10-25 12:50:55 +00002016 void VisitOMPTeamsDistributeSimdDirective(
2017 const OMPTeamsDistributeSimdDirective *D);
Kelvin Li579e41c2016-11-30 23:51:03 +00002018 void VisitOMPTeamsDistributeParallelForSimdDirective(
2019 const OMPTeamsDistributeParallelForSimdDirective *D);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002020 void VisitOMPTeamsDistributeParallelForDirective(
2021 const OMPTeamsDistributeParallelForDirective *D);
Kelvin Libf594a52016-12-17 05:48:59 +00002022 void VisitOMPTargetTeamsDirective(const OMPTargetTeamsDirective *D);
Kelvin Li83c451e2016-12-25 04:52:54 +00002023 void VisitOMPTargetTeamsDistributeDirective(
2024 const OMPTargetTeamsDistributeDirective *D);
Kelvin Li80e8f562016-12-29 22:16:30 +00002025 void VisitOMPTargetTeamsDistributeParallelForDirective(
2026 const OMPTargetTeamsDistributeParallelForDirective *D);
Kelvin Li1851df52017-01-03 05:23:48 +00002027 void VisitOMPTargetTeamsDistributeParallelForSimdDirective(
2028 const OMPTargetTeamsDistributeParallelForSimdDirective *D);
Kelvin Lida681182017-01-10 18:08:18 +00002029 void VisitOMPTargetTeamsDistributeSimdDirective(
2030 const OMPTargetTeamsDistributeSimdDirective *D);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002031
Guy Benyei11169dd2012-12-18 14:30:41 +00002032private:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002033 void AddDeclarationNameInfo(const Stmt *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00002034 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
James Y Knight04ec5bf2015-12-24 02:59:37 +00002035 void AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2036 unsigned NumTemplateArgs);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002037 void AddMemberRef(const FieldDecl *D, SourceLocation L);
2038 void AddStmt(const Stmt *S);
2039 void AddDecl(const Decl *D, bool isFirst = true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002040 void AddTypeLoc(TypeSourceInfo *TI);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002041 void EnqueueChildren(const Stmt *S);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002042 void EnqueueChildren(const OMPClause *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00002043};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002044} // end anonyous namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00002045
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002046void EnqueueVisitor::AddDeclarationNameInfo(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002047 // 'S' should always be non-null, since it comes from the
2048 // statement we are visiting.
2049 WL.push_back(DeclarationNameInfoVisit(S, Parent));
2050}
2051
2052void
2053EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
2054 if (Qualifier)
2055 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
2056}
2057
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002058void EnqueueVisitor::AddStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002059 if (S)
2060 WL.push_back(StmtVisit(S, Parent));
2061}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002062void EnqueueVisitor::AddDecl(const Decl *D, bool isFirst) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002063 if (D)
2064 WL.push_back(DeclVisit(D, Parent, isFirst));
2065}
James Y Knight04ec5bf2015-12-24 02:59:37 +00002066void EnqueueVisitor::AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2067 unsigned NumTemplateArgs) {
2068 WL.push_back(ExplicitTemplateArgsVisit(A, A + NumTemplateArgs, Parent));
Guy Benyei11169dd2012-12-18 14:30:41 +00002069}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002070void EnqueueVisitor::AddMemberRef(const FieldDecl *D, SourceLocation L) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002071 if (D)
2072 WL.push_back(MemberRefVisit(D, L, Parent));
2073}
2074void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
2075 if (TI)
2076 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
2077 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002078void EnqueueVisitor::EnqueueChildren(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002079 unsigned size = WL.size();
Benjamin Kramer642f1732015-07-02 21:03:14 +00002080 for (const Stmt *SubStmt : S->children()) {
2081 AddStmt(SubStmt);
Guy Benyei11169dd2012-12-18 14:30:41 +00002082 }
2083 if (size == WL.size())
2084 return;
2085 // Now reverse the entries we just added. This will match the DFS
2086 // ordering performed by the worklist.
2087 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2088 std::reverse(I, E);
2089}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002090namespace {
2091class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> {
2092 EnqueueVisitor *Visitor;
Alexey Bataev756c1962013-09-24 03:17:45 +00002093 /// \brief Process clauses with list of variables.
2094 template <typename T>
2095 void VisitOMPClauseList(T *Node);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002096public:
2097 OMPClauseEnqueue(EnqueueVisitor *Visitor) : Visitor(Visitor) { }
2098#define OPENMP_CLAUSE(Name, Class) \
2099 void Visit##Class(const Class *C);
2100#include "clang/Basic/OpenMPKinds.def"
Alexey Bataev3392d762016-02-16 11:18:12 +00002101 void VisitOMPClauseWithPreInit(const OMPClauseWithPreInit *C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002102 void VisitOMPClauseWithPostUpdate(const OMPClauseWithPostUpdate *C);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002103};
2104
Alexey Bataev3392d762016-02-16 11:18:12 +00002105void OMPClauseEnqueue::VisitOMPClauseWithPreInit(
2106 const OMPClauseWithPreInit *C) {
2107 Visitor->AddStmt(C->getPreInitStmt());
2108}
2109
Alexey Bataev005248a2016-02-25 05:25:57 +00002110void OMPClauseEnqueue::VisitOMPClauseWithPostUpdate(
2111 const OMPClauseWithPostUpdate *C) {
Alexey Bataev37e594c2016-03-04 07:21:16 +00002112 VisitOMPClauseWithPreInit(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002113 Visitor->AddStmt(C->getPostUpdateExpr());
2114}
2115
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002116void OMPClauseEnqueue::VisitOMPIfClause(const OMPIfClause *C) {
Arpith Chacko Jacobfe4890a2017-01-18 20:40:48 +00002117 VisitOMPClauseWithPreInit(C);
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002118 Visitor->AddStmt(C->getCondition());
2119}
2120
Alexey Bataev3778b602014-07-17 07:32:53 +00002121void OMPClauseEnqueue::VisitOMPFinalClause(const OMPFinalClause *C) {
2122 Visitor->AddStmt(C->getCondition());
2123}
2124
Alexey Bataev568a8332014-03-06 06:15:19 +00002125void OMPClauseEnqueue::VisitOMPNumThreadsClause(const OMPNumThreadsClause *C) {
Arpith Chacko Jacob33c849a2017-01-25 00:57:16 +00002126 VisitOMPClauseWithPreInit(C);
Alexey Bataev568a8332014-03-06 06:15:19 +00002127 Visitor->AddStmt(C->getNumThreads());
2128}
2129
Alexey Bataev62c87d22014-03-21 04:51:18 +00002130void OMPClauseEnqueue::VisitOMPSafelenClause(const OMPSafelenClause *C) {
2131 Visitor->AddStmt(C->getSafelen());
2132}
2133
Alexey Bataev66b15b52015-08-21 11:14:16 +00002134void OMPClauseEnqueue::VisitOMPSimdlenClause(const OMPSimdlenClause *C) {
2135 Visitor->AddStmt(C->getSimdlen());
2136}
2137
Alexander Musman8bd31e62014-05-27 15:12:19 +00002138void OMPClauseEnqueue::VisitOMPCollapseClause(const OMPCollapseClause *C) {
2139 Visitor->AddStmt(C->getNumForLoops());
2140}
2141
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002142void OMPClauseEnqueue::VisitOMPDefaultClause(const OMPDefaultClause *C) { }
Alexey Bataev756c1962013-09-24 03:17:45 +00002143
Alexey Bataevbcbadb62014-05-06 06:04:14 +00002144void OMPClauseEnqueue::VisitOMPProcBindClause(const OMPProcBindClause *C) { }
2145
Alexey Bataev56dafe82014-06-20 07:16:17 +00002146void OMPClauseEnqueue::VisitOMPScheduleClause(const OMPScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002147 VisitOMPClauseWithPreInit(C);
Alexey Bataev56dafe82014-06-20 07:16:17 +00002148 Visitor->AddStmt(C->getChunkSize());
2149}
2150
Alexey Bataev10e775f2015-07-30 11:36:16 +00002151void OMPClauseEnqueue::VisitOMPOrderedClause(const OMPOrderedClause *C) {
2152 Visitor->AddStmt(C->getNumForLoops());
2153}
Alexey Bataev142e1fc2014-06-20 09:44:06 +00002154
Alexey Bataev236070f2014-06-20 11:19:47 +00002155void OMPClauseEnqueue::VisitOMPNowaitClause(const OMPNowaitClause *) {}
2156
Alexey Bataev7aea99a2014-07-17 12:19:31 +00002157void OMPClauseEnqueue::VisitOMPUntiedClause(const OMPUntiedClause *) {}
2158
Alexey Bataev74ba3a52014-07-17 12:47:03 +00002159void OMPClauseEnqueue::VisitOMPMergeableClause(const OMPMergeableClause *) {}
2160
Alexey Bataevf98b00c2014-07-23 02:27:21 +00002161void OMPClauseEnqueue::VisitOMPReadClause(const OMPReadClause *) {}
2162
Alexey Bataevdea47612014-07-23 07:46:59 +00002163void OMPClauseEnqueue::VisitOMPWriteClause(const OMPWriteClause *) {}
2164
Alexey Bataev67a4f222014-07-23 10:25:33 +00002165void OMPClauseEnqueue::VisitOMPUpdateClause(const OMPUpdateClause *) {}
2166
Alexey Bataev459dec02014-07-24 06:46:57 +00002167void OMPClauseEnqueue::VisitOMPCaptureClause(const OMPCaptureClause *) {}
2168
Alexey Bataev82bad8b2014-07-24 08:55:34 +00002169void OMPClauseEnqueue::VisitOMPSeqCstClause(const OMPSeqCstClause *) {}
2170
Alexey Bataev346265e2015-09-25 10:37:12 +00002171void OMPClauseEnqueue::VisitOMPThreadsClause(const OMPThreadsClause *) {}
2172
Alexey Bataevd14d1e62015-09-28 06:39:35 +00002173void OMPClauseEnqueue::VisitOMPSIMDClause(const OMPSIMDClause *) {}
2174
Alexey Bataevb825de12015-12-07 10:51:44 +00002175void OMPClauseEnqueue::VisitOMPNogroupClause(const OMPNogroupClause *) {}
2176
Michael Wonge710d542015-08-07 16:16:36 +00002177void OMPClauseEnqueue::VisitOMPDeviceClause(const OMPDeviceClause *C) {
2178 Visitor->AddStmt(C->getDevice());
2179}
2180
Kelvin Li099bb8c2015-11-24 20:50:12 +00002181void OMPClauseEnqueue::VisitOMPNumTeamsClause(const OMPNumTeamsClause *C) {
Arpith Chacko Jacobbc126342017-01-25 11:28:18 +00002182 VisitOMPClauseWithPreInit(C);
Kelvin Li099bb8c2015-11-24 20:50:12 +00002183 Visitor->AddStmt(C->getNumTeams());
2184}
2185
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002186void OMPClauseEnqueue::VisitOMPThreadLimitClause(const OMPThreadLimitClause *C) {
Arpith Chacko Jacob7ecc0b72017-01-25 11:44:35 +00002187 VisitOMPClauseWithPreInit(C);
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002188 Visitor->AddStmt(C->getThreadLimit());
2189}
2190
Alexey Bataeva0569352015-12-01 10:17:31 +00002191void OMPClauseEnqueue::VisitOMPPriorityClause(const OMPPriorityClause *C) {
2192 Visitor->AddStmt(C->getPriority());
2193}
2194
Alexey Bataev1fd4aed2015-12-07 12:52:51 +00002195void OMPClauseEnqueue::VisitOMPGrainsizeClause(const OMPGrainsizeClause *C) {
2196 Visitor->AddStmt(C->getGrainsize());
2197}
2198
Alexey Bataev382967a2015-12-08 12:06:20 +00002199void OMPClauseEnqueue::VisitOMPNumTasksClause(const OMPNumTasksClause *C) {
2200 Visitor->AddStmt(C->getNumTasks());
2201}
2202
Alexey Bataev28c75412015-12-15 08:19:24 +00002203void OMPClauseEnqueue::VisitOMPHintClause(const OMPHintClause *C) {
2204 Visitor->AddStmt(C->getHint());
2205}
2206
Alexey Bataev756c1962013-09-24 03:17:45 +00002207template<typename T>
2208void OMPClauseEnqueue::VisitOMPClauseList(T *Node) {
Alexey Bataev03b340a2014-10-21 03:16:40 +00002209 for (const auto *I : Node->varlists()) {
Aaron Ballman2205d2a2014-03-14 15:55:35 +00002210 Visitor->AddStmt(I);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002211 }
Alexey Bataev756c1962013-09-24 03:17:45 +00002212}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002213
2214void OMPClauseEnqueue::VisitOMPPrivateClause(const OMPPrivateClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002215 VisitOMPClauseList(C);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002216 for (const auto *E : C->private_copies()) {
2217 Visitor->AddStmt(E);
2218 }
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002219}
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002220void OMPClauseEnqueue::VisitOMPFirstprivateClause(
2221 const OMPFirstprivateClause *C) {
2222 VisitOMPClauseList(C);
Alexey Bataev417089f2016-02-17 13:19:37 +00002223 VisitOMPClauseWithPreInit(C);
2224 for (const auto *E : C->private_copies()) {
2225 Visitor->AddStmt(E);
2226 }
2227 for (const auto *E : C->inits()) {
2228 Visitor->AddStmt(E);
2229 }
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002230}
Alexander Musman1bb328c2014-06-04 13:06:39 +00002231void OMPClauseEnqueue::VisitOMPLastprivateClause(
2232 const OMPLastprivateClause *C) {
2233 VisitOMPClauseList(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002234 VisitOMPClauseWithPostUpdate(C);
Alexey Bataev38e89532015-04-16 04:54:05 +00002235 for (auto *E : C->private_copies()) {
2236 Visitor->AddStmt(E);
2237 }
2238 for (auto *E : C->source_exprs()) {
2239 Visitor->AddStmt(E);
2240 }
2241 for (auto *E : C->destination_exprs()) {
2242 Visitor->AddStmt(E);
2243 }
2244 for (auto *E : C->assignment_ops()) {
2245 Visitor->AddStmt(E);
2246 }
Alexander Musman1bb328c2014-06-04 13:06:39 +00002247}
Alexey Bataev758e55e2013-09-06 18:03:48 +00002248void OMPClauseEnqueue::VisitOMPSharedClause(const OMPSharedClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002249 VisitOMPClauseList(C);
Alexey Bataev758e55e2013-09-06 18:03:48 +00002250}
Alexey Bataevc5e02582014-06-16 07:08:35 +00002251void OMPClauseEnqueue::VisitOMPReductionClause(const OMPReductionClause *C) {
2252 VisitOMPClauseList(C);
Alexey Bataev61205072016-03-02 04:57:40 +00002253 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevf24e7b12015-10-08 09:10:53 +00002254 for (auto *E : C->privates()) {
2255 Visitor->AddStmt(E);
2256 }
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002257 for (auto *E : C->lhs_exprs()) {
2258 Visitor->AddStmt(E);
2259 }
2260 for (auto *E : C->rhs_exprs()) {
2261 Visitor->AddStmt(E);
2262 }
2263 for (auto *E : C->reduction_ops()) {
2264 Visitor->AddStmt(E);
2265 }
Alexey Bataevc5e02582014-06-16 07:08:35 +00002266}
Alexey Bataev169d96a2017-07-18 20:17:46 +00002267void OMPClauseEnqueue::VisitOMPTaskReductionClause(
2268 const OMPTaskReductionClause *C) {
2269 VisitOMPClauseList(C);
2270 VisitOMPClauseWithPostUpdate(C);
2271 for (auto *E : C->privates()) {
2272 Visitor->AddStmt(E);
2273 }
2274 for (auto *E : C->lhs_exprs()) {
2275 Visitor->AddStmt(E);
2276 }
2277 for (auto *E : C->rhs_exprs()) {
2278 Visitor->AddStmt(E);
2279 }
2280 for (auto *E : C->reduction_ops()) {
2281 Visitor->AddStmt(E);
2282 }
2283}
Alexander Musman8dba6642014-04-22 13:09:42 +00002284void OMPClauseEnqueue::VisitOMPLinearClause(const OMPLinearClause *C) {
2285 VisitOMPClauseList(C);
Alexey Bataev78849fb2016-03-09 09:49:00 +00002286 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevbd9fec12015-08-18 06:47:21 +00002287 for (const auto *E : C->privates()) {
2288 Visitor->AddStmt(E);
2289 }
Alexander Musman3276a272015-03-21 10:12:56 +00002290 for (const auto *E : C->inits()) {
2291 Visitor->AddStmt(E);
2292 }
2293 for (const auto *E : C->updates()) {
2294 Visitor->AddStmt(E);
2295 }
2296 for (const auto *E : C->finals()) {
2297 Visitor->AddStmt(E);
2298 }
Alexander Musman8dba6642014-04-22 13:09:42 +00002299 Visitor->AddStmt(C->getStep());
Alexander Musman3276a272015-03-21 10:12:56 +00002300 Visitor->AddStmt(C->getCalcStep());
Alexander Musman8dba6642014-04-22 13:09:42 +00002301}
Alexander Musmanf0d76e72014-05-29 14:36:25 +00002302void OMPClauseEnqueue::VisitOMPAlignedClause(const OMPAlignedClause *C) {
2303 VisitOMPClauseList(C);
2304 Visitor->AddStmt(C->getAlignment());
2305}
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002306void OMPClauseEnqueue::VisitOMPCopyinClause(const OMPCopyinClause *C) {
2307 VisitOMPClauseList(C);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002308 for (auto *E : C->source_exprs()) {
2309 Visitor->AddStmt(E);
2310 }
2311 for (auto *E : C->destination_exprs()) {
2312 Visitor->AddStmt(E);
2313 }
2314 for (auto *E : C->assignment_ops()) {
2315 Visitor->AddStmt(E);
2316 }
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002317}
Alexey Bataevbae9a792014-06-27 10:37:06 +00002318void
2319OMPClauseEnqueue::VisitOMPCopyprivateClause(const OMPCopyprivateClause *C) {
2320 VisitOMPClauseList(C);
Alexey Bataeva63048e2015-03-23 06:18:07 +00002321 for (auto *E : C->source_exprs()) {
2322 Visitor->AddStmt(E);
2323 }
2324 for (auto *E : C->destination_exprs()) {
2325 Visitor->AddStmt(E);
2326 }
2327 for (auto *E : C->assignment_ops()) {
2328 Visitor->AddStmt(E);
2329 }
Alexey Bataevbae9a792014-06-27 10:37:06 +00002330}
Alexey Bataev6125da92014-07-21 11:26:11 +00002331void OMPClauseEnqueue::VisitOMPFlushClause(const OMPFlushClause *C) {
2332 VisitOMPClauseList(C);
2333}
Alexey Bataev1c2cfbc2015-06-23 14:25:19 +00002334void OMPClauseEnqueue::VisitOMPDependClause(const OMPDependClause *C) {
2335 VisitOMPClauseList(C);
2336}
Kelvin Li0bff7af2015-11-23 05:32:03 +00002337void OMPClauseEnqueue::VisitOMPMapClause(const OMPMapClause *C) {
2338 VisitOMPClauseList(C);
2339}
Carlo Bertollib4adf552016-01-15 18:50:31 +00002340void OMPClauseEnqueue::VisitOMPDistScheduleClause(
2341 const OMPDistScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002342 VisitOMPClauseWithPreInit(C);
Carlo Bertollib4adf552016-01-15 18:50:31 +00002343 Visitor->AddStmt(C->getChunkSize());
Carlo Bertollib4adf552016-01-15 18:50:31 +00002344}
Alexey Bataev3392d762016-02-16 11:18:12 +00002345void OMPClauseEnqueue::VisitOMPDefaultmapClause(
2346 const OMPDefaultmapClause * /*C*/) {}
Samuel Antao661c0902016-05-26 17:39:58 +00002347void OMPClauseEnqueue::VisitOMPToClause(const OMPToClause *C) {
2348 VisitOMPClauseList(C);
2349}
Samuel Antaoec172c62016-05-26 17:49:04 +00002350void OMPClauseEnqueue::VisitOMPFromClause(const OMPFromClause *C) {
2351 VisitOMPClauseList(C);
2352}
Carlo Bertolli2404b172016-07-13 15:37:16 +00002353void OMPClauseEnqueue::VisitOMPUseDevicePtrClause(const OMPUseDevicePtrClause *C) {
2354 VisitOMPClauseList(C);
2355}
Carlo Bertolli70594e92016-07-13 17:16:49 +00002356void OMPClauseEnqueue::VisitOMPIsDevicePtrClause(const OMPIsDevicePtrClause *C) {
2357 VisitOMPClauseList(C);
2358}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002359}
Alexey Bataev756c1962013-09-24 03:17:45 +00002360
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002361void EnqueueVisitor::EnqueueChildren(const OMPClause *S) {
2362 unsigned size = WL.size();
2363 OMPClauseEnqueue Visitor(this);
2364 Visitor.Visit(S);
2365 if (size == WL.size())
2366 return;
2367 // Now reverse the entries we just added. This will match the DFS
2368 // ordering performed by the worklist.
2369 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2370 std::reverse(I, E);
2371}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002372void EnqueueVisitor::VisitAddrLabelExpr(const AddrLabelExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002373 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
2374}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002375void EnqueueVisitor::VisitBlockExpr(const BlockExpr *B) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002376 AddDecl(B->getBlockDecl());
2377}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002378void EnqueueVisitor::VisitCompoundLiteralExpr(const CompoundLiteralExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002379 EnqueueChildren(E);
2380 AddTypeLoc(E->getTypeSourceInfo());
2381}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002382void EnqueueVisitor::VisitCompoundStmt(const CompoundStmt *S) {
Pete Cooper57d3f142015-07-30 17:22:52 +00002383 for (auto &I : llvm::reverse(S->body()))
2384 AddStmt(I);
Guy Benyei11169dd2012-12-18 14:30:41 +00002385}
2386void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002387VisitMSDependentExistsStmt(const MSDependentExistsStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002388 AddStmt(S->getSubStmt());
2389 AddDeclarationNameInfo(S);
2390 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
2391 AddNestedNameSpecifierLoc(QualifierLoc);
2392}
2393
2394void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002395VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002396 if (E->hasExplicitTemplateArgs())
2397 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002398 AddDeclarationNameInfo(E);
2399 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2400 AddNestedNameSpecifierLoc(QualifierLoc);
2401 if (!E->isImplicitAccess())
2402 AddStmt(E->getBase());
2403}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002404void EnqueueVisitor::VisitCXXNewExpr(const CXXNewExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002405 // Enqueue the initializer , if any.
2406 AddStmt(E->getInitializer());
2407 // Enqueue the array size, if any.
2408 AddStmt(E->getArraySize());
2409 // Enqueue the allocated type.
2410 AddTypeLoc(E->getAllocatedTypeSourceInfo());
2411 // Enqueue the placement arguments.
2412 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
2413 AddStmt(E->getPlacementArg(I-1));
2414}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002415void EnqueueVisitor::VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *CE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002416 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
2417 AddStmt(CE->getArg(I-1));
2418 AddStmt(CE->getCallee());
2419 AddStmt(CE->getArg(0));
2420}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002421void EnqueueVisitor::VisitCXXPseudoDestructorExpr(
2422 const CXXPseudoDestructorExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002423 // Visit the name of the type being destroyed.
2424 AddTypeLoc(E->getDestroyedTypeInfo());
2425 // Visit the scope type that looks disturbingly like the nested-name-specifier
2426 // but isn't.
2427 AddTypeLoc(E->getScopeTypeInfo());
2428 // Visit the nested-name-specifier.
2429 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2430 AddNestedNameSpecifierLoc(QualifierLoc);
2431 // Visit base expression.
2432 AddStmt(E->getBase());
2433}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002434void EnqueueVisitor::VisitCXXScalarValueInitExpr(
2435 const CXXScalarValueInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002436 AddTypeLoc(E->getTypeSourceInfo());
2437}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002438void EnqueueVisitor::VisitCXXTemporaryObjectExpr(
2439 const CXXTemporaryObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002440 EnqueueChildren(E);
2441 AddTypeLoc(E->getTypeSourceInfo());
2442}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002443void EnqueueVisitor::VisitCXXTypeidExpr(const CXXTypeidExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002444 EnqueueChildren(E);
2445 if (E->isTypeOperand())
2446 AddTypeLoc(E->getTypeOperandSourceInfo());
2447}
2448
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002449void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(
2450 const CXXUnresolvedConstructExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002451 EnqueueChildren(E);
2452 AddTypeLoc(E->getTypeSourceInfo());
2453}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002454void EnqueueVisitor::VisitCXXUuidofExpr(const CXXUuidofExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002455 EnqueueChildren(E);
2456 if (E->isTypeOperand())
2457 AddTypeLoc(E->getTypeOperandSourceInfo());
2458}
2459
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002460void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002461 EnqueueChildren(S);
2462 AddDecl(S->getExceptionDecl());
2463}
2464
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002465void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002466 AddStmt(S->getBody());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002467 AddStmt(S->getRangeInit());
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002468 AddDecl(S->getLoopVariable());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002469}
2470
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002471void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002472 if (DR->hasExplicitTemplateArgs())
2473 AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002474 WL.push_back(DeclRefExprParts(DR, Parent));
2475}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002476void EnqueueVisitor::VisitDependentScopeDeclRefExpr(
2477 const DependentScopeDeclRefExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002478 if (E->hasExplicitTemplateArgs())
2479 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002480 AddDeclarationNameInfo(E);
2481 AddNestedNameSpecifierLoc(E->getQualifierLoc());
2482}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002483void EnqueueVisitor::VisitDeclStmt(const DeclStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002484 unsigned size = WL.size();
2485 bool isFirst = true;
Aaron Ballman535bbcc2014-03-14 17:01:24 +00002486 for (const auto *D : S->decls()) {
2487 AddDecl(D, isFirst);
Guy Benyei11169dd2012-12-18 14:30:41 +00002488 isFirst = false;
2489 }
2490 if (size == WL.size())
2491 return;
2492 // Now reverse the entries we just added. This will match the DFS
2493 // ordering performed by the worklist.
2494 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2495 std::reverse(I, E);
2496}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002497void EnqueueVisitor::VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002498 AddStmt(E->getInit());
David Majnemerf7e36092016-06-23 00:15:04 +00002499 for (const DesignatedInitExpr::Designator &D :
2500 llvm::reverse(E->designators())) {
2501 if (D.isFieldDesignator()) {
2502 if (FieldDecl *Field = D.getField())
2503 AddMemberRef(Field, D.getFieldLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00002504 continue;
2505 }
David Majnemerf7e36092016-06-23 00:15:04 +00002506 if (D.isArrayDesignator()) {
2507 AddStmt(E->getArrayIndex(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002508 continue;
2509 }
David Majnemerf7e36092016-06-23 00:15:04 +00002510 assert(D.isArrayRangeDesignator() && "Unknown designator kind");
2511 AddStmt(E->getArrayRangeEnd(D));
2512 AddStmt(E->getArrayRangeStart(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002513 }
2514}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002515void EnqueueVisitor::VisitExplicitCastExpr(const ExplicitCastExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002516 EnqueueChildren(E);
2517 AddTypeLoc(E->getTypeInfoAsWritten());
2518}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002519void EnqueueVisitor::VisitForStmt(const ForStmt *FS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002520 AddStmt(FS->getBody());
2521 AddStmt(FS->getInc());
2522 AddStmt(FS->getCond());
2523 AddDecl(FS->getConditionVariable());
2524 AddStmt(FS->getInit());
2525}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002526void EnqueueVisitor::VisitGotoStmt(const GotoStmt *GS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2528}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002529void EnqueueVisitor::VisitIfStmt(const IfStmt *If) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002530 AddStmt(If->getElse());
2531 AddStmt(If->getThen());
2532 AddStmt(If->getCond());
2533 AddDecl(If->getConditionVariable());
2534}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002535void EnqueueVisitor::VisitInitListExpr(const InitListExpr *IE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002536 // We care about the syntactic form of the initializer list, only.
2537 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2538 IE = Syntactic;
2539 EnqueueChildren(IE);
2540}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002541void EnqueueVisitor::VisitMemberExpr(const MemberExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002542 WL.push_back(MemberExprParts(M, Parent));
2543
2544 // If the base of the member access expression is an implicit 'this', don't
2545 // visit it.
2546 // FIXME: If we ever want to show these implicit accesses, this will be
2547 // unfortunate. However, clang_getCursor() relies on this behavior.
Argyrios Kyrtzidis58d0e7a2015-03-13 04:40:07 +00002548 if (M->isImplicitAccess())
2549 return;
2550
2551 // Ignore base anonymous struct/union fields, otherwise they will shadow the
2552 // real field that that we are interested in.
2553 if (auto *SubME = dyn_cast<MemberExpr>(M->getBase())) {
2554 if (auto *FD = dyn_cast_or_null<FieldDecl>(SubME->getMemberDecl())) {
2555 if (FD->isAnonymousStructOrUnion()) {
2556 AddStmt(SubME->getBase());
2557 return;
2558 }
2559 }
2560 }
2561
2562 AddStmt(M->getBase());
Guy Benyei11169dd2012-12-18 14:30:41 +00002563}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002564void EnqueueVisitor::VisitObjCEncodeExpr(const ObjCEncodeExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002565 AddTypeLoc(E->getEncodedTypeSourceInfo());
2566}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002567void EnqueueVisitor::VisitObjCMessageExpr(const ObjCMessageExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002568 EnqueueChildren(M);
2569 AddTypeLoc(M->getClassReceiverTypeInfo());
2570}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002571void EnqueueVisitor::VisitOffsetOfExpr(const OffsetOfExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002572 // Visit the components of the offsetof expression.
2573 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002574 const OffsetOfNode &Node = E->getComponent(I-1);
2575 switch (Node.getKind()) {
2576 case OffsetOfNode::Array:
2577 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2578 break;
2579 case OffsetOfNode::Field:
2580 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
2581 break;
2582 case OffsetOfNode::Identifier:
2583 case OffsetOfNode::Base:
2584 continue;
2585 }
2586 }
2587 // Visit the type into which we're computing the offset.
2588 AddTypeLoc(E->getTypeSourceInfo());
2589}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002590void EnqueueVisitor::VisitOverloadExpr(const OverloadExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002591 if (E->hasExplicitTemplateArgs())
2592 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002593 WL.push_back(OverloadExprParts(E, Parent));
2594}
2595void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002596 const UnaryExprOrTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002597 EnqueueChildren(E);
2598 if (E->isArgumentType())
2599 AddTypeLoc(E->getArgumentTypeInfo());
2600}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002601void EnqueueVisitor::VisitStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002602 EnqueueChildren(S);
2603}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002604void EnqueueVisitor::VisitSwitchStmt(const SwitchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002605 AddStmt(S->getBody());
2606 AddStmt(S->getCond());
2607 AddDecl(S->getConditionVariable());
2608}
2609
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002610void EnqueueVisitor::VisitWhileStmt(const WhileStmt *W) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002611 AddStmt(W->getBody());
2612 AddStmt(W->getCond());
2613 AddDecl(W->getConditionVariable());
2614}
2615
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002616void EnqueueVisitor::VisitTypeTraitExpr(const TypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 for (unsigned I = E->getNumArgs(); I > 0; --I)
2618 AddTypeLoc(E->getArg(I-1));
2619}
2620
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002621void EnqueueVisitor::VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002622 AddTypeLoc(E->getQueriedTypeSourceInfo());
2623}
2624
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002625void EnqueueVisitor::VisitExpressionTraitExpr(const ExpressionTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002626 EnqueueChildren(E);
2627}
2628
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002629void EnqueueVisitor::VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002630 VisitOverloadExpr(U);
2631 if (!U->isImplicitAccess())
2632 AddStmt(U->getBase());
2633}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002634void EnqueueVisitor::VisitVAArgExpr(const VAArgExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002635 AddStmt(E->getSubExpr());
2636 AddTypeLoc(E->getWrittenTypeInfo());
2637}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002638void EnqueueVisitor::VisitSizeOfPackExpr(const SizeOfPackExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002639 WL.push_back(SizeOfPackExprParts(E, Parent));
2640}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002641void EnqueueVisitor::VisitOpaqueValueExpr(const OpaqueValueExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002642 // If the opaque value has a source expression, just transparently
2643 // visit that. This is useful for (e.g.) pseudo-object expressions.
2644 if (Expr *SourceExpr = E->getSourceExpr())
2645 return Visit(SourceExpr);
2646}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002647void EnqueueVisitor::VisitLambdaExpr(const LambdaExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002648 AddStmt(E->getBody());
2649 WL.push_back(LambdaExprParts(E, Parent));
2650}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002651void EnqueueVisitor::VisitPseudoObjectExpr(const PseudoObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002652 // Treat the expression like its syntactic form.
2653 Visit(E->getSyntacticForm());
2654}
2655
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002656void EnqueueVisitor::VisitOMPExecutableDirective(
2657 const OMPExecutableDirective *D) {
2658 EnqueueChildren(D);
2659 for (ArrayRef<OMPClause *>::iterator I = D->clauses().begin(),
2660 E = D->clauses().end();
2661 I != E; ++I)
2662 EnqueueChildren(*I);
2663}
2664
Alexander Musman3aaab662014-08-19 11:27:13 +00002665void EnqueueVisitor::VisitOMPLoopDirective(const OMPLoopDirective *D) {
2666 VisitOMPExecutableDirective(D);
2667}
2668
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002669void EnqueueVisitor::VisitOMPParallelDirective(const OMPParallelDirective *D) {
2670 VisitOMPExecutableDirective(D);
2671}
2672
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002673void EnqueueVisitor::VisitOMPSimdDirective(const OMPSimdDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002674 VisitOMPLoopDirective(D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002675}
2676
Alexey Bataevf29276e2014-06-18 04:14:57 +00002677void EnqueueVisitor::VisitOMPForDirective(const OMPForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002678 VisitOMPLoopDirective(D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002679}
2680
Alexander Musmanf82886e2014-09-18 05:12:34 +00002681void EnqueueVisitor::VisitOMPForSimdDirective(const OMPForSimdDirective *D) {
2682 VisitOMPLoopDirective(D);
2683}
2684
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002685void EnqueueVisitor::VisitOMPSectionsDirective(const OMPSectionsDirective *D) {
2686 VisitOMPExecutableDirective(D);
2687}
2688
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002689void EnqueueVisitor::VisitOMPSectionDirective(const OMPSectionDirective *D) {
2690 VisitOMPExecutableDirective(D);
2691}
2692
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002693void EnqueueVisitor::VisitOMPSingleDirective(const OMPSingleDirective *D) {
2694 VisitOMPExecutableDirective(D);
2695}
2696
Alexander Musman80c22892014-07-17 08:54:58 +00002697void EnqueueVisitor::VisitOMPMasterDirective(const OMPMasterDirective *D) {
2698 VisitOMPExecutableDirective(D);
2699}
2700
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002701void EnqueueVisitor::VisitOMPCriticalDirective(const OMPCriticalDirective *D) {
2702 VisitOMPExecutableDirective(D);
2703 AddDeclarationNameInfo(D);
2704}
2705
Alexey Bataev4acb8592014-07-07 13:01:15 +00002706void
2707EnqueueVisitor::VisitOMPParallelForDirective(const OMPParallelForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002708 VisitOMPLoopDirective(D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002709}
2710
Alexander Musmane4e893b2014-09-23 09:33:00 +00002711void EnqueueVisitor::VisitOMPParallelForSimdDirective(
2712 const OMPParallelForSimdDirective *D) {
2713 VisitOMPLoopDirective(D);
2714}
2715
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002716void EnqueueVisitor::VisitOMPParallelSectionsDirective(
2717 const OMPParallelSectionsDirective *D) {
2718 VisitOMPExecutableDirective(D);
2719}
2720
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002721void EnqueueVisitor::VisitOMPTaskDirective(const OMPTaskDirective *D) {
2722 VisitOMPExecutableDirective(D);
2723}
2724
Alexey Bataev68446b72014-07-18 07:47:19 +00002725void
2726EnqueueVisitor::VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D) {
2727 VisitOMPExecutableDirective(D);
2728}
2729
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002730void EnqueueVisitor::VisitOMPBarrierDirective(const OMPBarrierDirective *D) {
2731 VisitOMPExecutableDirective(D);
2732}
2733
Alexey Bataev2df347a2014-07-18 10:17:07 +00002734void EnqueueVisitor::VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D) {
2735 VisitOMPExecutableDirective(D);
2736}
2737
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002738void EnqueueVisitor::VisitOMPTaskgroupDirective(
2739 const OMPTaskgroupDirective *D) {
2740 VisitOMPExecutableDirective(D);
2741}
2742
Alexey Bataev6125da92014-07-21 11:26:11 +00002743void EnqueueVisitor::VisitOMPFlushDirective(const OMPFlushDirective *D) {
2744 VisitOMPExecutableDirective(D);
2745}
2746
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002747void EnqueueVisitor::VisitOMPOrderedDirective(const OMPOrderedDirective *D) {
2748 VisitOMPExecutableDirective(D);
2749}
2750
Alexey Bataev0162e452014-07-22 10:10:35 +00002751void EnqueueVisitor::VisitOMPAtomicDirective(const OMPAtomicDirective *D) {
2752 VisitOMPExecutableDirective(D);
2753}
2754
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002755void EnqueueVisitor::VisitOMPTargetDirective(const OMPTargetDirective *D) {
2756 VisitOMPExecutableDirective(D);
2757}
2758
Michael Wong65f367f2015-07-21 13:44:28 +00002759void EnqueueVisitor::VisitOMPTargetDataDirective(const
2760 OMPTargetDataDirective *D) {
2761 VisitOMPExecutableDirective(D);
2762}
2763
Samuel Antaodf67fc42016-01-19 19:15:56 +00002764void EnqueueVisitor::VisitOMPTargetEnterDataDirective(
2765 const OMPTargetEnterDataDirective *D) {
2766 VisitOMPExecutableDirective(D);
2767}
2768
Samuel Antao72590762016-01-19 20:04:50 +00002769void EnqueueVisitor::VisitOMPTargetExitDataDirective(
2770 const OMPTargetExitDataDirective *D) {
2771 VisitOMPExecutableDirective(D);
2772}
2773
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002774void EnqueueVisitor::VisitOMPTargetParallelDirective(
2775 const OMPTargetParallelDirective *D) {
2776 VisitOMPExecutableDirective(D);
2777}
2778
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002779void EnqueueVisitor::VisitOMPTargetParallelForDirective(
2780 const OMPTargetParallelForDirective *D) {
2781 VisitOMPLoopDirective(D);
2782}
2783
Alexey Bataev13314bf2014-10-09 04:18:56 +00002784void EnqueueVisitor::VisitOMPTeamsDirective(const OMPTeamsDirective *D) {
2785 VisitOMPExecutableDirective(D);
2786}
2787
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002788void EnqueueVisitor::VisitOMPCancellationPointDirective(
2789 const OMPCancellationPointDirective *D) {
2790 VisitOMPExecutableDirective(D);
2791}
2792
Alexey Bataev80909872015-07-02 11:25:17 +00002793void EnqueueVisitor::VisitOMPCancelDirective(const OMPCancelDirective *D) {
2794 VisitOMPExecutableDirective(D);
2795}
2796
Alexey Bataev49f6e782015-12-01 04:18:41 +00002797void EnqueueVisitor::VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D) {
2798 VisitOMPLoopDirective(D);
2799}
2800
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002801void EnqueueVisitor::VisitOMPTaskLoopSimdDirective(
2802 const OMPTaskLoopSimdDirective *D) {
2803 VisitOMPLoopDirective(D);
2804}
2805
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002806void EnqueueVisitor::VisitOMPDistributeDirective(
2807 const OMPDistributeDirective *D) {
2808 VisitOMPLoopDirective(D);
2809}
2810
Carlo Bertolli9925f152016-06-27 14:55:37 +00002811void EnqueueVisitor::VisitOMPDistributeParallelForDirective(
2812 const OMPDistributeParallelForDirective *D) {
2813 VisitOMPLoopDirective(D);
2814}
2815
Kelvin Li4a39add2016-07-05 05:00:15 +00002816void EnqueueVisitor::VisitOMPDistributeParallelForSimdDirective(
2817 const OMPDistributeParallelForSimdDirective *D) {
2818 VisitOMPLoopDirective(D);
2819}
2820
Kelvin Li787f3fc2016-07-06 04:45:38 +00002821void EnqueueVisitor::VisitOMPDistributeSimdDirective(
2822 const OMPDistributeSimdDirective *D) {
2823 VisitOMPLoopDirective(D);
2824}
2825
Kelvin Lia579b912016-07-14 02:54:56 +00002826void EnqueueVisitor::VisitOMPTargetParallelForSimdDirective(
2827 const OMPTargetParallelForSimdDirective *D) {
2828 VisitOMPLoopDirective(D);
2829}
2830
Kelvin Li986330c2016-07-20 22:57:10 +00002831void EnqueueVisitor::VisitOMPTargetSimdDirective(
2832 const OMPTargetSimdDirective *D) {
2833 VisitOMPLoopDirective(D);
2834}
2835
Kelvin Li02532872016-08-05 14:37:37 +00002836void EnqueueVisitor::VisitOMPTeamsDistributeDirective(
2837 const OMPTeamsDistributeDirective *D) {
2838 VisitOMPLoopDirective(D);
2839}
2840
Kelvin Li4e325f72016-10-25 12:50:55 +00002841void EnqueueVisitor::VisitOMPTeamsDistributeSimdDirective(
2842 const OMPTeamsDistributeSimdDirective *D) {
2843 VisitOMPLoopDirective(D);
2844}
2845
Kelvin Li579e41c2016-11-30 23:51:03 +00002846void EnqueueVisitor::VisitOMPTeamsDistributeParallelForSimdDirective(
2847 const OMPTeamsDistributeParallelForSimdDirective *D) {
2848 VisitOMPLoopDirective(D);
2849}
2850
Kelvin Li7ade93f2016-12-09 03:24:30 +00002851void EnqueueVisitor::VisitOMPTeamsDistributeParallelForDirective(
2852 const OMPTeamsDistributeParallelForDirective *D) {
2853 VisitOMPLoopDirective(D);
2854}
2855
Kelvin Libf594a52016-12-17 05:48:59 +00002856void EnqueueVisitor::VisitOMPTargetTeamsDirective(
2857 const OMPTargetTeamsDirective *D) {
2858 VisitOMPExecutableDirective(D);
2859}
2860
Kelvin Li83c451e2016-12-25 04:52:54 +00002861void EnqueueVisitor::VisitOMPTargetTeamsDistributeDirective(
2862 const OMPTargetTeamsDistributeDirective *D) {
2863 VisitOMPLoopDirective(D);
2864}
2865
Kelvin Li80e8f562016-12-29 22:16:30 +00002866void EnqueueVisitor::VisitOMPTargetTeamsDistributeParallelForDirective(
2867 const OMPTargetTeamsDistributeParallelForDirective *D) {
2868 VisitOMPLoopDirective(D);
2869}
2870
Kelvin Li1851df52017-01-03 05:23:48 +00002871void EnqueueVisitor::VisitOMPTargetTeamsDistributeParallelForSimdDirective(
2872 const OMPTargetTeamsDistributeParallelForSimdDirective *D) {
2873 VisitOMPLoopDirective(D);
2874}
2875
Kelvin Lida681182017-01-10 18:08:18 +00002876void EnqueueVisitor::VisitOMPTargetTeamsDistributeSimdDirective(
2877 const OMPTargetTeamsDistributeSimdDirective *D) {
2878 VisitOMPLoopDirective(D);
2879}
2880
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002881void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002882 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
2883}
2884
2885bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2886 if (RegionOfInterest.isValid()) {
2887 SourceRange Range = getRawCursorExtent(C);
2888 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2889 return false;
2890 }
2891 return true;
2892}
2893
2894bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2895 while (!WL.empty()) {
2896 // Dequeue the worklist item.
Robert Wilhelm25284cc2013-08-23 16:11:15 +00002897 VisitorJob LI = WL.pop_back_val();
Guy Benyei11169dd2012-12-18 14:30:41 +00002898
2899 // Set the Parent field, then back to its old value once we're done.
2900 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2901
2902 switch (LI.getKind()) {
2903 case VisitorJob::DeclVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002904 const Decl *D = cast<DeclVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002905 if (!D)
2906 continue;
2907
2908 // For now, perform default visitation for Decls.
2909 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2910 cast<DeclVisit>(&LI)->isFirst())))
2911 return true;
2912
2913 continue;
2914 }
2915 case VisitorJob::ExplicitTemplateArgsVisitKind: {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002916 for (const TemplateArgumentLoc &Arg :
2917 *cast<ExplicitTemplateArgsVisit>(&LI)) {
2918 if (VisitTemplateArgumentLoc(Arg))
Guy Benyei11169dd2012-12-18 14:30:41 +00002919 return true;
2920 }
2921 continue;
2922 }
2923 case VisitorJob::TypeLocVisitKind: {
2924 // Perform default visitation for TypeLocs.
2925 if (Visit(cast<TypeLocVisit>(&LI)->get()))
2926 return true;
2927 continue;
2928 }
2929 case VisitorJob::LabelRefVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002930 const LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002931 if (LabelStmt *stmt = LS->getStmt()) {
2932 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2933 TU))) {
2934 return true;
2935 }
2936 }
2937 continue;
2938 }
2939
2940 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2941 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2942 if (VisitNestedNameSpecifierLoc(V->get()))
2943 return true;
2944 continue;
2945 }
2946
2947 case VisitorJob::DeclarationNameInfoVisitKind: {
2948 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2949 ->get()))
2950 return true;
2951 continue;
2952 }
2953 case VisitorJob::MemberRefVisitKind: {
2954 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2955 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2956 return true;
2957 continue;
2958 }
2959 case VisitorJob::StmtVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002960 const Stmt *S = cast<StmtVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002961 if (!S)
2962 continue;
2963
2964 // Update the current cursor.
2965 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
2966 if (!IsInRegionOfInterest(Cursor))
2967 continue;
2968 switch (Visitor(Cursor, Parent, ClientData)) {
2969 case CXChildVisit_Break: return true;
2970 case CXChildVisit_Continue: break;
2971 case CXChildVisit_Recurse:
2972 if (PostChildrenVisitor)
Craig Topper69186e72014-06-08 08:38:04 +00002973 WL.push_back(PostChildrenVisit(nullptr, Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +00002974 EnqueueWorkList(WL, S);
2975 break;
2976 }
2977 continue;
2978 }
2979 case VisitorJob::MemberExprPartsKind: {
2980 // Handle the other pieces in the MemberExpr besides the base.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002981 const MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002982
2983 // Visit the nested-name-specifier
2984 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
2985 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2986 return true;
2987
2988 // Visit the declaration name.
2989 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2990 return true;
2991
2992 // Visit the explicitly-specified template arguments, if any.
2993 if (M->hasExplicitTemplateArgs()) {
2994 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2995 *ArgEnd = Arg + M->getNumTemplateArgs();
2996 Arg != ArgEnd; ++Arg) {
2997 if (VisitTemplateArgumentLoc(*Arg))
2998 return true;
2999 }
3000 }
3001 continue;
3002 }
3003 case VisitorJob::DeclRefExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003004 const DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003005 // Visit nested-name-specifier, if present.
3006 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
3007 if (VisitNestedNameSpecifierLoc(QualifierLoc))
3008 return true;
3009 // Visit declaration name.
3010 if (VisitDeclarationNameInfo(DR->getNameInfo()))
3011 return true;
3012 continue;
3013 }
3014 case VisitorJob::OverloadExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003015 const OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003016 // Visit the nested-name-specifier.
3017 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
3018 if (VisitNestedNameSpecifierLoc(QualifierLoc))
3019 return true;
3020 // Visit the declaration name.
3021 if (VisitDeclarationNameInfo(O->getNameInfo()))
3022 return true;
3023 // Visit the overloaded declaration reference.
3024 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
3025 return true;
3026 continue;
3027 }
3028 case VisitorJob::SizeOfPackExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003029 const SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003030 NamedDecl *Pack = E->getPack();
3031 if (isa<TemplateTypeParmDecl>(Pack)) {
3032 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
3033 E->getPackLoc(), TU)))
3034 return true;
3035
3036 continue;
3037 }
3038
3039 if (isa<TemplateTemplateParmDecl>(Pack)) {
3040 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
3041 E->getPackLoc(), TU)))
3042 return true;
3043
3044 continue;
3045 }
3046
3047 // Non-type template parameter packs and function parameter packs are
3048 // treated like DeclRefExpr cursors.
3049 continue;
3050 }
3051
3052 case VisitorJob::LambdaExprPartsKind: {
3053 // Visit captures.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003054 const LambdaExpr *E = cast<LambdaExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003055 for (LambdaExpr::capture_iterator C = E->explicit_capture_begin(),
3056 CEnd = E->explicit_capture_end();
3057 C != CEnd; ++C) {
Richard Smithba71c082013-05-16 06:20:58 +00003058 // FIXME: Lambda init-captures.
3059 if (!C->capturesVariable())
Guy Benyei11169dd2012-12-18 14:30:41 +00003060 continue;
Richard Smithba71c082013-05-16 06:20:58 +00003061
Guy Benyei11169dd2012-12-18 14:30:41 +00003062 if (Visit(MakeCursorVariableRef(C->getCapturedVar(),
3063 C->getLocation(),
3064 TU)))
3065 return true;
3066 }
3067
3068 // Visit parameters and return type, if present.
3069 if (E->hasExplicitParameters() || E->hasExplicitResultType()) {
3070 TypeLoc TL = E->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
3071 if (E->hasExplicitParameters() && E->hasExplicitResultType()) {
3072 // Visit the whole type.
3073 if (Visit(TL))
3074 return true;
David Blaikie6adc78e2013-02-18 22:06:02 +00003075 } else if (FunctionProtoTypeLoc Proto =
3076 TL.getAs<FunctionProtoTypeLoc>()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 if (E->hasExplicitParameters()) {
3078 // Visit parameters.
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00003079 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I)
3080 if (Visit(MakeCXCursor(Proto.getParam(I), TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00003081 return true;
3082 } else {
3083 // Visit result type.
Alp Toker42a16a62014-01-25 23:51:36 +00003084 if (Visit(Proto.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00003085 return true;
3086 }
3087 }
3088 }
3089 break;
3090 }
3091
3092 case VisitorJob::PostChildrenVisitKind:
3093 if (PostChildrenVisitor(Parent, ClientData))
3094 return true;
3095 break;
3096 }
3097 }
3098 return false;
3099}
3100
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003101bool CursorVisitor::Visit(const Stmt *S) {
Craig Topper69186e72014-06-08 08:38:04 +00003102 VisitorWorkList *WL = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003103 if (!WorkListFreeList.empty()) {
3104 WL = WorkListFreeList.back();
3105 WL->clear();
3106 WorkListFreeList.pop_back();
3107 }
3108 else {
3109 WL = new VisitorWorkList();
3110 WorkListCache.push_back(WL);
3111 }
3112 EnqueueWorkList(*WL, S);
3113 bool result = RunVisitorWorkList(*WL);
3114 WorkListFreeList.push_back(WL);
3115 return result;
3116}
3117
3118namespace {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003119typedef SmallVector<SourceRange, 4> RefNamePieces;
James Y Knight04ec5bf2015-12-24 02:59:37 +00003120RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
3121 const DeclarationNameInfo &NI, SourceRange QLoc,
3122 const SourceRange *TemplateArgsLoc = nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003123 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
3124 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
3125 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
3126
3127 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
3128
3129 RefNamePieces Pieces;
3130
3131 if (WantQualifier && QLoc.isValid())
3132 Pieces.push_back(QLoc);
3133
3134 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
3135 Pieces.push_back(NI.getLoc());
James Y Knight04ec5bf2015-12-24 02:59:37 +00003136
3137 if (WantTemplateArgs && TemplateArgsLoc && TemplateArgsLoc->isValid())
3138 Pieces.push_back(*TemplateArgsLoc);
3139
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 if (Kind == DeclarationName::CXXOperatorName) {
3141 Pieces.push_back(SourceLocation::getFromRawEncoding(
3142 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
3143 Pieces.push_back(SourceLocation::getFromRawEncoding(
3144 NI.getInfo().CXXOperatorName.EndOpNameLoc));
3145 }
3146
3147 if (WantSinglePiece) {
3148 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
3149 Pieces.clear();
3150 Pieces.push_back(R);
3151 }
3152
3153 return Pieces;
3154}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003155}
Guy Benyei11169dd2012-12-18 14:30:41 +00003156
3157//===----------------------------------------------------------------------===//
3158// Misc. API hooks.
3159//===----------------------------------------------------------------------===//
3160
Chad Rosier05c71aa2013-03-27 18:28:23 +00003161static void fatal_error_handler(void *user_data, const std::string& reason,
3162 bool gen_crash_diag) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003163 // Write the result out to stderr avoiding errs() because raw_ostreams can
3164 // call report_fatal_error.
3165 fprintf(stderr, "LIBCLANG FATAL ERROR: %s\n", reason.c_str());
3166 ::abort();
3167}
3168
Chandler Carruth66660742014-06-27 16:37:27 +00003169namespace {
3170struct RegisterFatalErrorHandler {
3171 RegisterFatalErrorHandler() {
3172 llvm::install_fatal_error_handler(fatal_error_handler, nullptr);
3173 }
3174};
3175}
3176
3177static llvm::ManagedStatic<RegisterFatalErrorHandler> RegisterFatalErrorHandlerOnce;
3178
Guy Benyei11169dd2012-12-18 14:30:41 +00003179CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
3180 int displayDiagnostics) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003181 // We use crash recovery to make some of our APIs more reliable, implicitly
3182 // enable it.
Argyrios Kyrtzidis3701f542013-11-27 08:58:09 +00003183 if (!getenv("LIBCLANG_DISABLE_CRASH_RECOVERY"))
3184 llvm::CrashRecoveryContext::Enable();
Guy Benyei11169dd2012-12-18 14:30:41 +00003185
Chandler Carruth66660742014-06-27 16:37:27 +00003186 // Look through the managed static to trigger construction of the managed
3187 // static which registers our fatal error handler. This ensures it is only
3188 // registered once.
3189 (void)*RegisterFatalErrorHandlerOnce;
Guy Benyei11169dd2012-12-18 14:30:41 +00003190
Adrian Prantlbc068582015-07-08 01:00:30 +00003191 // Initialize targets for clang module support.
3192 llvm::InitializeAllTargets();
3193 llvm::InitializeAllTargetMCs();
3194 llvm::InitializeAllAsmPrinters();
3195 llvm::InitializeAllAsmParsers();
3196
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003197 CIndexer *CIdxr = new CIndexer();
3198
Guy Benyei11169dd2012-12-18 14:30:41 +00003199 if (excludeDeclarationsFromPCH)
3200 CIdxr->setOnlyLocalDecls();
3201 if (displayDiagnostics)
3202 CIdxr->setDisplayDiagnostics();
3203
3204 if (getenv("LIBCLANG_BGPRIO_INDEX"))
3205 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3206 CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
3207 if (getenv("LIBCLANG_BGPRIO_EDIT"))
3208 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3209 CXGlobalOpt_ThreadBackgroundPriorityForEditing);
3210
3211 return CIdxr;
3212}
3213
3214void clang_disposeIndex(CXIndex CIdx) {
3215 if (CIdx)
3216 delete static_cast<CIndexer *>(CIdx);
3217}
3218
3219void clang_CXIndex_setGlobalOptions(CXIndex CIdx, unsigned options) {
3220 if (CIdx)
3221 static_cast<CIndexer *>(CIdx)->setCXGlobalOptFlags(options);
3222}
3223
3224unsigned clang_CXIndex_getGlobalOptions(CXIndex CIdx) {
3225 if (CIdx)
3226 return static_cast<CIndexer *>(CIdx)->getCXGlobalOptFlags();
3227 return 0;
3228}
3229
3230void clang_toggleCrashRecovery(unsigned isEnabled) {
3231 if (isEnabled)
3232 llvm::CrashRecoveryContext::Enable();
3233 else
3234 llvm::CrashRecoveryContext::Disable();
3235}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003236
Guy Benyei11169dd2012-12-18 14:30:41 +00003237CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
3238 const char *ast_filename) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003239 CXTranslationUnit TU;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003240 enum CXErrorCode Result =
3241 clang_createTranslationUnit2(CIdx, ast_filename, &TU);
Reid Klecknerfd48fc62014-02-12 23:56:20 +00003242 (void)Result;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003243 assert((TU && Result == CXError_Success) ||
3244 (!TU && Result != CXError_Success));
3245 return TU;
3246}
3247
3248enum CXErrorCode clang_createTranslationUnit2(CXIndex CIdx,
3249 const char *ast_filename,
3250 CXTranslationUnit *out_TU) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003251 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003252 *out_TU = nullptr;
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003253
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003254 if (!CIdx || !ast_filename || !out_TU)
3255 return CXError_InvalidArguments;
Guy Benyei11169dd2012-12-18 14:30:41 +00003256
Argyrios Kyrtzidis27021012013-05-24 22:24:07 +00003257 LOG_FUNC_SECTION {
3258 *Log << ast_filename;
3259 }
3260
Guy Benyei11169dd2012-12-18 14:30:41 +00003261 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3262 FileSystemOptions FileSystemOpts;
3263
Justin Bognerd512c1e2014-10-15 00:33:06 +00003264 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
3265 CompilerInstance::createDiagnostics(new DiagnosticOptions());
David Blaikie6f7382d2014-08-10 19:08:04 +00003266 std::unique_ptr<ASTUnit> AU = ASTUnit::LoadFromASTFile(
Richard Smithdbafb6c2017-06-29 23:23:46 +00003267 ast_filename, CXXIdx->getPCHContainerOperations()->getRawReader(),
3268 ASTUnit::LoadEverything, Diags,
Adrian Prantl6b21ab22015-08-27 19:46:20 +00003269 FileSystemOpts, /*UseDebugInfo=*/false,
3270 CXXIdx->getOnlyLocalDecls(), None,
David Blaikie6f7382d2014-08-10 19:08:04 +00003271 /*CaptureDiagnostics=*/true,
3272 /*AllowPCHWithCompilerErrors=*/true,
3273 /*UserFilesAreVolatile=*/true);
David Blaikieea4395e2017-01-06 19:49:01 +00003274 *out_TU = MakeCXTranslationUnit(CXXIdx, std::move(AU));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003275 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003276}
3277
3278unsigned clang_defaultEditingTranslationUnitOptions() {
3279 return CXTranslationUnit_PrecompiledPreamble |
3280 CXTranslationUnit_CacheCompletionResults;
3281}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003282
Guy Benyei11169dd2012-12-18 14:30:41 +00003283CXTranslationUnit
3284clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
3285 const char *source_filename,
3286 int num_command_line_args,
3287 const char * const *command_line_args,
3288 unsigned num_unsaved_files,
3289 struct CXUnsavedFile *unsaved_files) {
3290 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord;
3291 return clang_parseTranslationUnit(CIdx, source_filename,
3292 command_line_args, num_command_line_args,
3293 unsaved_files, num_unsaved_files,
3294 Options);
3295}
3296
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003297static CXErrorCode
3298clang_parseTranslationUnit_Impl(CXIndex CIdx, const char *source_filename,
3299 const char *const *command_line_args,
3300 int num_command_line_args,
3301 ArrayRef<CXUnsavedFile> unsaved_files,
3302 unsigned options, CXTranslationUnit *out_TU) {
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003303 // Set up the initial return values.
3304 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003305 *out_TU = nullptr;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003306
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003307 // Check arguments.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003308 if (!CIdx || !out_TU)
3309 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003310
Guy Benyei11169dd2012-12-18 14:30:41 +00003311 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3312
3313 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3314 setThreadBackgroundPriority();
3315
3316 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003317 bool CreatePreambleOnFirstParse =
3318 options & CXTranslationUnit_CreatePreambleOnFirstParse;
Guy Benyei11169dd2012-12-18 14:30:41 +00003319 // FIXME: Add a flag for modules.
3320 TranslationUnitKind TUKind
Argyrios Kyrtzidis735e92c2017-06-09 01:20:48 +00003321 = (options & (CXTranslationUnit_Incomplete |
3322 CXTranslationUnit_SingleFileParse))? TU_Prefix : TU_Complete;
Alp Toker8c8a8752013-12-03 06:53:35 +00003323 bool CacheCodeCompletionResults
Guy Benyei11169dd2012-12-18 14:30:41 +00003324 = options & CXTranslationUnit_CacheCompletionResults;
3325 bool IncludeBriefCommentsInCodeCompletion
3326 = options & CXTranslationUnit_IncludeBriefCommentsInCodeCompletion;
3327 bool SkipFunctionBodies = options & CXTranslationUnit_SkipFunctionBodies;
Argyrios Kyrtzidis735e92c2017-06-09 01:20:48 +00003328 bool SingleFileParse = options & CXTranslationUnit_SingleFileParse;
Guy Benyei11169dd2012-12-18 14:30:41 +00003329 bool ForSerialization = options & CXTranslationUnit_ForSerialization;
3330
3331 // Configure the diagnostics.
3332 IntrusiveRefCntPtr<DiagnosticsEngine>
Sean Silvaf1b49e22013-01-20 01:58:28 +00003333 Diags(CompilerInstance::createDiagnostics(new DiagnosticOptions));
Guy Benyei11169dd2012-12-18 14:30:41 +00003334
Manuel Klimek016c0242016-03-01 10:56:19 +00003335 if (options & CXTranslationUnit_KeepGoing)
Richard Smithe37391c2017-05-03 00:28:49 +00003336 Diags->setSuppressAfterFatalError(false);
Manuel Klimek016c0242016-03-01 10:56:19 +00003337
Guy Benyei11169dd2012-12-18 14:30:41 +00003338 // Recover resources if we crash before exiting this function.
3339 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
3340 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Alp Tokerf994cef2014-07-05 03:08:06 +00003341 DiagCleanup(Diags.get());
Guy Benyei11169dd2012-12-18 14:30:41 +00003342
Ahmed Charlesb8984322014-03-07 20:03:18 +00003343 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3344 new std::vector<ASTUnit::RemappedFile>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003345
3346 // Recover resources if we crash before exiting this function.
3347 llvm::CrashRecoveryContextCleanupRegistrar<
3348 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3349
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003350 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003351 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003352 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003353 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003354 }
3355
Ahmed Charlesb8984322014-03-07 20:03:18 +00003356 std::unique_ptr<std::vector<const char *>> Args(
3357 new std::vector<const char *>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003358
3359 // Recover resources if we crash before exiting this method.
3360 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
3361 ArgsCleanup(Args.get());
3362
3363 // Since the Clang C library is primarily used by batch tools dealing with
3364 // (often very broken) source code, where spell-checking can have a
3365 // significant negative impact on performance (particularly when
3366 // precompiled headers are involved), we disable it by default.
3367 // Only do this if we haven't found a spell-checking-related argument.
3368 bool FoundSpellCheckingArgument = false;
3369 for (int I = 0; I != num_command_line_args; ++I) {
3370 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
3371 strcmp(command_line_args[I], "-fspell-checking") == 0) {
3372 FoundSpellCheckingArgument = true;
3373 break;
3374 }
3375 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003376 Args->insert(Args->end(), command_line_args,
3377 command_line_args + num_command_line_args);
3378
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003379 if (!FoundSpellCheckingArgument)
3380 Args->insert(Args->begin() + 1, "-fno-spell-checking");
3381
Guy Benyei11169dd2012-12-18 14:30:41 +00003382 // The 'source_filename' argument is optional. If the caller does not
3383 // specify it then it is assumed that the source file is specified
3384 // in the actual argument list.
3385 // Put the source file after command_line_args otherwise if '-x' flag is
3386 // present it will be unused.
3387 if (source_filename)
3388 Args->push_back(source_filename);
3389
3390 // Do we need the detailed preprocessing record?
3391 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
3392 Args->push_back("-Xclang");
3393 Args->push_back("-detailed-preprocessing-record");
3394 }
Alex Lorenzcb006402017-04-27 13:47:03 +00003395
3396 // Suppress any editor placeholder diagnostics.
3397 Args->push_back("-fallow-editor-placeholders");
3398
Guy Benyei11169dd2012-12-18 14:30:41 +00003399 unsigned NumErrors = Diags->getClient()->getNumErrors();
Ahmed Charlesb8984322014-03-07 20:03:18 +00003400 std::unique_ptr<ASTUnit> ErrUnit;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003401 // Unless the user specified that they want the preamble on the first parse
3402 // set it up to be created on the first reparse. This makes the first parse
3403 // faster, trading for a slower (first) reparse.
3404 unsigned PrecompilePreambleAfterNParses =
3405 !PrecompilePreamble ? 0 : 2 - CreatePreambleOnFirstParse;
Ahmed Charlesb8984322014-03-07 20:03:18 +00003406 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCommandLine(
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003407 Args->data(), Args->data() + Args->size(),
3408 CXXIdx->getPCHContainerOperations(), Diags,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003409 CXXIdx->getClangResourcesPath(), CXXIdx->getOnlyLocalDecls(),
3410 /*CaptureDiagnostics=*/true, *RemappedFiles.get(),
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003411 /*RemappedFilesKeepOriginalName=*/true, PrecompilePreambleAfterNParses,
3412 TUKind, CacheCodeCompletionResults, IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidis735e92c2017-06-09 01:20:48 +00003413 /*AllowPCHWithCompilerErrors=*/true, SkipFunctionBodies, SingleFileParse,
Argyrios Kyrtzidisa3e2ff12015-11-20 03:36:21 +00003414 /*UserFilesAreVolatile=*/true, ForSerialization,
3415 CXXIdx->getPCHContainerOperations()->getRawReader().getFormat(),
3416 &ErrUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003417
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003418 // Early failures in LoadFromCommandLine may return with ErrUnit unset.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003419 if (!Unit && !ErrUnit)
3420 return CXError_ASTReadError;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003421
Guy Benyei11169dd2012-12-18 14:30:41 +00003422 if (NumErrors != Diags->getClient()->getNumErrors()) {
3423 // Make sure to check that 'Unit' is non-NULL.
3424 if (CXXIdx->getDisplayDiagnostics())
3425 printDiagsToStderr(Unit ? Unit.get() : ErrUnit.get());
3426 }
3427
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003428 if (isASTReadError(Unit ? Unit.get() : ErrUnit.get()))
3429 return CXError_ASTReadError;
3430
David Blaikieea4395e2017-01-06 19:49:01 +00003431 *out_TU = MakeCXTranslationUnit(CXXIdx, std::move(Unit));
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003432 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003433}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003434
3435CXTranslationUnit
3436clang_parseTranslationUnit(CXIndex CIdx,
3437 const char *source_filename,
3438 const char *const *command_line_args,
3439 int num_command_line_args,
3440 struct CXUnsavedFile *unsaved_files,
3441 unsigned num_unsaved_files,
3442 unsigned options) {
3443 CXTranslationUnit TU;
3444 enum CXErrorCode Result = clang_parseTranslationUnit2(
3445 CIdx, source_filename, command_line_args, num_command_line_args,
3446 unsaved_files, num_unsaved_files, options, &TU);
Reid Kleckner6eaf05a2014-02-13 01:19:59 +00003447 (void)Result;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003448 assert((TU && Result == CXError_Success) ||
3449 (!TU && Result != CXError_Success));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003450 return TU;
3451}
3452
3453enum CXErrorCode clang_parseTranslationUnit2(
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003454 CXIndex CIdx, const char *source_filename,
3455 const char *const *command_line_args, int num_command_line_args,
3456 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3457 unsigned options, CXTranslationUnit *out_TU) {
3458 SmallVector<const char *, 4> Args;
3459 Args.push_back("clang");
3460 Args.append(command_line_args, command_line_args + num_command_line_args);
3461 return clang_parseTranslationUnit2FullArgv(
3462 CIdx, source_filename, Args.data(), Args.size(), unsaved_files,
3463 num_unsaved_files, options, out_TU);
3464}
3465
3466enum CXErrorCode clang_parseTranslationUnit2FullArgv(
3467 CXIndex CIdx, const char *source_filename,
3468 const char *const *command_line_args, int num_command_line_args,
3469 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3470 unsigned options, CXTranslationUnit *out_TU) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003471 LOG_FUNC_SECTION {
3472 *Log << source_filename << ": ";
3473 for (int i = 0; i != num_command_line_args; ++i)
3474 *Log << command_line_args[i] << " ";
3475 }
3476
Alp Toker9d85b182014-07-07 01:23:14 +00003477 if (num_unsaved_files && !unsaved_files)
3478 return CXError_InvalidArguments;
3479
Alp Toker5c532982014-07-07 22:42:03 +00003480 CXErrorCode result = CXError_Failure;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003481 auto ParseTranslationUnitImpl = [=, &result] {
3482 result = clang_parseTranslationUnit_Impl(
3483 CIdx, source_filename, command_line_args, num_command_line_args,
3484 llvm::makeArrayRef(unsaved_files, num_unsaved_files), options, out_TU);
3485 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003486 llvm::CrashRecoveryContext CRC;
3487
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003488 if (!RunSafely(CRC, ParseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003489 fprintf(stderr, "libclang: crash detected during parsing: {\n");
3490 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
3491 fprintf(stderr, " 'command_line_args' : [");
3492 for (int i = 0; i != num_command_line_args; ++i) {
3493 if (i)
3494 fprintf(stderr, ", ");
3495 fprintf(stderr, "'%s'", command_line_args[i]);
3496 }
3497 fprintf(stderr, "],\n");
3498 fprintf(stderr, " 'unsaved_files' : [");
3499 for (unsigned i = 0; i != num_unsaved_files; ++i) {
3500 if (i)
3501 fprintf(stderr, ", ");
3502 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
3503 unsaved_files[i].Length);
3504 }
3505 fprintf(stderr, "],\n");
3506 fprintf(stderr, " 'options' : %d,\n", options);
3507 fprintf(stderr, "}\n");
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003508
3509 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003510 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003511 if (CXTranslationUnit *TU = out_TU)
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003512 PrintLibclangResourceUsage(*TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003513 }
Alp Toker5c532982014-07-07 22:42:03 +00003514
3515 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003516}
3517
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003518CXString clang_Type_getObjCEncoding(CXType CT) {
3519 CXTranslationUnit tu = static_cast<CXTranslationUnit>(CT.data[1]);
3520 ASTContext &Ctx = getASTUnit(tu)->getASTContext();
3521 std::string encoding;
3522 Ctx.getObjCEncodingForType(QualType::getFromOpaquePtr(CT.data[0]),
3523 encoding);
3524
3525 return cxstring::createDup(encoding);
3526}
3527
3528static const IdentifierInfo *getMacroIdentifier(CXCursor C) {
3529 if (C.kind == CXCursor_MacroDefinition) {
3530 if (const MacroDefinitionRecord *MDR = getCursorMacroDefinition(C))
3531 return MDR->getName();
3532 } else if (C.kind == CXCursor_MacroExpansion) {
3533 MacroExpansionCursor ME = getCursorMacroExpansion(C);
3534 return ME.getName();
3535 }
3536 return nullptr;
3537}
3538
3539unsigned clang_Cursor_isMacroFunctionLike(CXCursor C) {
3540 const IdentifierInfo *II = getMacroIdentifier(C);
3541 if (!II) {
3542 return false;
3543 }
3544 ASTUnit *ASTU = getCursorASTUnit(C);
3545 Preprocessor &PP = ASTU->getPreprocessor();
3546 if (const MacroInfo *MI = PP.getMacroInfo(II))
3547 return MI->isFunctionLike();
3548 return false;
3549}
3550
3551unsigned clang_Cursor_isMacroBuiltin(CXCursor C) {
3552 const IdentifierInfo *II = getMacroIdentifier(C);
3553 if (!II) {
3554 return false;
3555 }
3556 ASTUnit *ASTU = getCursorASTUnit(C);
3557 Preprocessor &PP = ASTU->getPreprocessor();
3558 if (const MacroInfo *MI = PP.getMacroInfo(II))
3559 return MI->isBuiltinMacro();
3560 return false;
3561}
3562
3563unsigned clang_Cursor_isFunctionInlined(CXCursor C) {
3564 const Decl *D = getCursorDecl(C);
3565 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
3566 if (!FD) {
3567 return false;
3568 }
3569 return FD->isInlined();
3570}
3571
3572static StringLiteral* getCFSTR_value(CallExpr *callExpr) {
3573 if (callExpr->getNumArgs() != 1) {
3574 return nullptr;
3575 }
3576
3577 StringLiteral *S = nullptr;
3578 auto *arg = callExpr->getArg(0);
3579 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
3580 ImplicitCastExpr *I = static_cast<ImplicitCastExpr *>(arg);
3581 auto *subExpr = I->getSubExprAsWritten();
3582
3583 if(subExpr->getStmtClass() != Stmt::StringLiteralClass){
3584 return nullptr;
3585 }
3586
3587 S = static_cast<StringLiteral *>(I->getSubExprAsWritten());
3588 } else if (arg->getStmtClass() == Stmt::StringLiteralClass) {
3589 S = static_cast<StringLiteral *>(callExpr->getArg(0));
3590 } else {
3591 return nullptr;
3592 }
3593 return S;
3594}
3595
David Blaikie59272572016-04-13 18:23:33 +00003596struct ExprEvalResult {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003597 CXEvalResultKind EvalType;
3598 union {
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003599 unsigned long long unsignedVal;
3600 long long intVal;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003601 double floatVal;
3602 char *stringVal;
3603 } EvalData;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003604 bool IsUnsignedInt;
David Blaikie59272572016-04-13 18:23:33 +00003605 ~ExprEvalResult() {
3606 if (EvalType != CXEval_UnExposed && EvalType != CXEval_Float &&
3607 EvalType != CXEval_Int) {
3608 delete EvalData.stringVal;
3609 }
3610 }
3611};
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003612
3613void clang_EvalResult_dispose(CXEvalResult E) {
David Blaikie59272572016-04-13 18:23:33 +00003614 delete static_cast<ExprEvalResult *>(E);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003615}
3616
3617CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E) {
3618 if (!E) {
3619 return CXEval_UnExposed;
3620 }
3621 return ((ExprEvalResult *)E)->EvalType;
3622}
3623
3624int clang_EvalResult_getAsInt(CXEvalResult E) {
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003625 return clang_EvalResult_getAsLongLong(E);
3626}
3627
3628long long clang_EvalResult_getAsLongLong(CXEvalResult E) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003629 if (!E) {
3630 return 0;
3631 }
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003632 ExprEvalResult *Result = (ExprEvalResult*)E;
3633 if (Result->IsUnsignedInt)
3634 return Result->EvalData.unsignedVal;
3635 return Result->EvalData.intVal;
3636}
3637
3638unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E) {
3639 return ((ExprEvalResult *)E)->IsUnsignedInt;
3640}
3641
3642unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E) {
3643 if (!E) {
3644 return 0;
3645 }
3646
3647 ExprEvalResult *Result = (ExprEvalResult*)E;
3648 if (Result->IsUnsignedInt)
3649 return Result->EvalData.unsignedVal;
3650 return Result->EvalData.intVal;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003651}
3652
3653double clang_EvalResult_getAsDouble(CXEvalResult E) {
3654 if (!E) {
3655 return 0;
3656 }
3657 return ((ExprEvalResult *)E)->EvalData.floatVal;
3658}
3659
3660const char* clang_EvalResult_getAsStr(CXEvalResult E) {
3661 if (!E) {
3662 return nullptr;
3663 }
3664 return ((ExprEvalResult *)E)->EvalData.stringVal;
3665}
3666
3667static const ExprEvalResult* evaluateExpr(Expr *expr, CXCursor C) {
3668 Expr::EvalResult ER;
3669 ASTContext &ctx = getCursorContext(C);
David Blaikiebbc00882016-04-13 18:36:19 +00003670 if (!expr)
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003671 return nullptr;
David Blaikiebbc00882016-04-13 18:36:19 +00003672
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003673 expr = expr->IgnoreParens();
David Blaikiebbc00882016-04-13 18:36:19 +00003674 if (!expr->EvaluateAsRValue(ER, ctx))
3675 return nullptr;
3676
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003677 QualType rettype;
3678 CallExpr *callExpr;
David Blaikie59272572016-04-13 18:23:33 +00003679 auto result = llvm::make_unique<ExprEvalResult>();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003680 result->EvalType = CXEval_UnExposed;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003681 result->IsUnsignedInt = false;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003682
David Blaikiebbc00882016-04-13 18:36:19 +00003683 if (ER.Val.isInt()) {
3684 result->EvalType = CXEval_Int;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003685
3686 auto& val = ER.Val.getInt();
3687 if (val.isUnsigned()) {
3688 result->IsUnsignedInt = true;
3689 result->EvalData.unsignedVal = val.getZExtValue();
3690 } else {
3691 result->EvalData.intVal = val.getExtValue();
3692 }
3693
David Blaikiebbc00882016-04-13 18:36:19 +00003694 return result.release();
3695 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003696
David Blaikiebbc00882016-04-13 18:36:19 +00003697 if (ER.Val.isFloat()) {
3698 llvm::SmallVector<char, 100> Buffer;
3699 ER.Val.getFloat().toString(Buffer);
3700 std::string floatStr(Buffer.data(), Buffer.size());
3701 result->EvalType = CXEval_Float;
3702 bool ignored;
3703 llvm::APFloat apFloat = ER.Val.getFloat();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003704 apFloat.convert(llvm::APFloat::IEEEdouble(),
David Blaikiebbc00882016-04-13 18:36:19 +00003705 llvm::APFloat::rmNearestTiesToEven, &ignored);
3706 result->EvalData.floatVal = apFloat.convertToDouble();
3707 return result.release();
3708 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003709
David Blaikiebbc00882016-04-13 18:36:19 +00003710 if (expr->getStmtClass() == Stmt::ImplicitCastExprClass) {
3711 const ImplicitCastExpr *I = dyn_cast<ImplicitCastExpr>(expr);
3712 auto *subExpr = I->getSubExprAsWritten();
3713 if (subExpr->getStmtClass() == Stmt::StringLiteralClass ||
3714 subExpr->getStmtClass() == Stmt::ObjCStringLiteralClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003715 const StringLiteral *StrE = nullptr;
3716 const ObjCStringLiteral *ObjCExpr;
David Blaikiebbc00882016-04-13 18:36:19 +00003717 ObjCExpr = dyn_cast<ObjCStringLiteral>(subExpr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003718
3719 if (ObjCExpr) {
3720 StrE = ObjCExpr->getString();
3721 result->EvalType = CXEval_ObjCStrLiteral;
3722 } else {
David Blaikiebbc00882016-04-13 18:36:19 +00003723 StrE = cast<StringLiteral>(I->getSubExprAsWritten());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003724 result->EvalType = CXEval_StrLiteral;
3725 }
3726
3727 std::string strRef(StrE->getString().str());
David Blaikie59272572016-04-13 18:23:33 +00003728 result->EvalData.stringVal = new char[strRef.size() + 1];
David Blaikiebbc00882016-04-13 18:36:19 +00003729 strncpy((char *)result->EvalData.stringVal, strRef.c_str(),
3730 strRef.size());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003731 result->EvalData.stringVal[strRef.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003732 return result.release();
David Blaikiebbc00882016-04-13 18:36:19 +00003733 }
3734 } else if (expr->getStmtClass() == Stmt::ObjCStringLiteralClass ||
3735 expr->getStmtClass() == Stmt::StringLiteralClass) {
3736 const StringLiteral *StrE = nullptr;
3737 const ObjCStringLiteral *ObjCExpr;
3738 ObjCExpr = dyn_cast<ObjCStringLiteral>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003739
David Blaikiebbc00882016-04-13 18:36:19 +00003740 if (ObjCExpr) {
3741 StrE = ObjCExpr->getString();
3742 result->EvalType = CXEval_ObjCStrLiteral;
3743 } else {
3744 StrE = cast<StringLiteral>(expr);
3745 result->EvalType = CXEval_StrLiteral;
3746 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003747
David Blaikiebbc00882016-04-13 18:36:19 +00003748 std::string strRef(StrE->getString().str());
3749 result->EvalData.stringVal = new char[strRef.size() + 1];
3750 strncpy((char *)result->EvalData.stringVal, strRef.c_str(), strRef.size());
3751 result->EvalData.stringVal[strRef.size()] = '\0';
3752 return result.release();
3753 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003754
David Blaikiebbc00882016-04-13 18:36:19 +00003755 if (expr->getStmtClass() == Stmt::CStyleCastExprClass) {
3756 CStyleCastExpr *CC = static_cast<CStyleCastExpr *>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003757
David Blaikiebbc00882016-04-13 18:36:19 +00003758 rettype = CC->getType();
3759 if (rettype.getAsString() == "CFStringRef" &&
3760 CC->getSubExpr()->getStmtClass() == Stmt::CallExprClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003761
David Blaikiebbc00882016-04-13 18:36:19 +00003762 callExpr = static_cast<CallExpr *>(CC->getSubExpr());
3763 StringLiteral *S = getCFSTR_value(callExpr);
3764 if (S) {
3765 std::string strLiteral(S->getString().str());
3766 result->EvalType = CXEval_CFStr;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003767
David Blaikiebbc00882016-04-13 18:36:19 +00003768 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3769 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3770 strLiteral.size());
3771 result->EvalData.stringVal[strLiteral.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003772 return result.release();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003773 }
3774 }
3775
David Blaikiebbc00882016-04-13 18:36:19 +00003776 } else if (expr->getStmtClass() == Stmt::CallExprClass) {
3777 callExpr = static_cast<CallExpr *>(expr);
3778 rettype = callExpr->getCallReturnType(ctx);
3779
3780 if (rettype->isVectorType() || callExpr->getNumArgs() > 1)
3781 return nullptr;
3782
3783 if (rettype->isIntegralType(ctx) || rettype->isRealFloatingType()) {
3784 if (callExpr->getNumArgs() == 1 &&
3785 !callExpr->getArg(0)->getType()->isIntegralType(ctx))
3786 return nullptr;
3787 } else if (rettype.getAsString() == "CFStringRef") {
3788
3789 StringLiteral *S = getCFSTR_value(callExpr);
3790 if (S) {
3791 std::string strLiteral(S->getString().str());
3792 result->EvalType = CXEval_CFStr;
3793 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3794 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3795 strLiteral.size());
3796 result->EvalData.stringVal[strLiteral.size()] = '\0';
3797 return result.release();
3798 }
3799 }
3800 } else if (expr->getStmtClass() == Stmt::DeclRefExprClass) {
3801 DeclRefExpr *D = static_cast<DeclRefExpr *>(expr);
3802 ValueDecl *V = D->getDecl();
3803 if (V->getKind() == Decl::Function) {
3804 std::string strName = V->getNameAsString();
3805 result->EvalType = CXEval_Other;
3806 result->EvalData.stringVal = new char[strName.size() + 1];
3807 strncpy(result->EvalData.stringVal, strName.c_str(), strName.size());
3808 result->EvalData.stringVal[strName.size()] = '\0';
3809 return result.release();
3810 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003811 }
3812
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003813 return nullptr;
3814}
3815
3816CXEvalResult clang_Cursor_Evaluate(CXCursor C) {
3817 const Decl *D = getCursorDecl(C);
3818 if (D) {
3819 const Expr *expr = nullptr;
3820 if (auto *Var = dyn_cast<VarDecl>(D)) {
3821 expr = Var->getInit();
3822 } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3823 expr = Field->getInClassInitializer();
3824 }
3825 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003826 return const_cast<CXEvalResult>(reinterpret_cast<const void *>(
3827 evaluateExpr(const_cast<Expr *>(expr), C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003828 return nullptr;
3829 }
3830
3831 const CompoundStmt *compoundStmt = dyn_cast_or_null<CompoundStmt>(getCursorStmt(C));
3832 if (compoundStmt) {
3833 Expr *expr = nullptr;
3834 for (auto *bodyIterator : compoundStmt->body()) {
3835 if ((expr = dyn_cast<Expr>(bodyIterator))) {
3836 break;
3837 }
3838 }
3839 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003840 return const_cast<CXEvalResult>(
3841 reinterpret_cast<const void *>(evaluateExpr(expr, C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003842 }
3843 return nullptr;
3844}
3845
3846unsigned clang_Cursor_hasAttrs(CXCursor C) {
3847 const Decl *D = getCursorDecl(C);
3848 if (!D) {
3849 return 0;
3850 }
3851
3852 if (D->hasAttrs()) {
3853 return 1;
3854 }
3855
3856 return 0;
3857}
Guy Benyei11169dd2012-12-18 14:30:41 +00003858unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
3859 return CXSaveTranslationUnit_None;
3860}
3861
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003862static CXSaveError clang_saveTranslationUnit_Impl(CXTranslationUnit TU,
3863 const char *FileName,
3864 unsigned options) {
3865 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003866 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3867 setThreadBackgroundPriority();
3868
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003869 bool hadError = cxtu::getASTUnit(TU)->Save(FileName);
3870 return hadError ? CXSaveError_Unknown : CXSaveError_None;
Guy Benyei11169dd2012-12-18 14:30:41 +00003871}
3872
3873int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
3874 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003875 LOG_FUNC_SECTION {
3876 *Log << TU << ' ' << FileName;
3877 }
3878
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003879 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003880 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003881 return CXSaveError_InvalidTU;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003882 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003883
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003884 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003885 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3886 if (!CXXUnit->hasSema())
3887 return CXSaveError_InvalidTU;
3888
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003889 CXSaveError result;
3890 auto SaveTranslationUnitImpl = [=, &result]() {
3891 result = clang_saveTranslationUnit_Impl(TU, FileName, options);
3892 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003893
3894 if (!CXXUnit->getDiagnostics().hasUnrecoverableErrorOccurred() ||
3895 getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003896 SaveTranslationUnitImpl();
Guy Benyei11169dd2012-12-18 14:30:41 +00003897
3898 if (getenv("LIBCLANG_RESOURCE_USAGE"))
3899 PrintLibclangResourceUsage(TU);
3900
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003901 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003902 }
3903
3904 // We have an AST that has invalid nodes due to compiler errors.
3905 // Use a crash recovery thread for protection.
3906
3907 llvm::CrashRecoveryContext CRC;
3908
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003909 if (!RunSafely(CRC, SaveTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003910 fprintf(stderr, "libclang: crash detected during AST saving: {\n");
3911 fprintf(stderr, " 'filename' : '%s'\n", FileName);
3912 fprintf(stderr, " 'options' : %d,\n", options);
3913 fprintf(stderr, "}\n");
3914
3915 return CXSaveError_Unknown;
3916
3917 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3918 PrintLibclangResourceUsage(TU);
3919 }
3920
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003921 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003922}
3923
3924void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
3925 if (CTUnit) {
3926 // If the translation unit has been marked as unsafe to free, just discard
3927 // it.
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003928 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
3929 if (Unit && Unit->isUnsafeToFree())
Guy Benyei11169dd2012-12-18 14:30:41 +00003930 return;
3931
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003932 delete cxtu::getASTUnit(CTUnit);
Dmitri Gribenkob95b3f12013-01-26 22:44:19 +00003933 delete CTUnit->StringPool;
Guy Benyei11169dd2012-12-18 14:30:41 +00003934 delete static_cast<CXDiagnosticSetImpl *>(CTUnit->Diagnostics);
3935 disposeOverridenCXCursorsPool(CTUnit->OverridenCursorsPool);
Dmitri Gribenko9e605112013-11-13 22:16:51 +00003936 delete CTUnit->CommentToXML;
Guy Benyei11169dd2012-12-18 14:30:41 +00003937 delete CTUnit;
3938 }
3939}
3940
Erik Verbruggen346066b2017-05-30 14:25:54 +00003941unsigned clang_suspendTranslationUnit(CXTranslationUnit CTUnit) {
3942 if (CTUnit) {
3943 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
3944
3945 if (Unit && Unit->isUnsafeToFree())
3946 return false;
3947
3948 Unit->ResetForParse();
3949 return true;
3950 }
3951
3952 return false;
3953}
3954
Guy Benyei11169dd2012-12-18 14:30:41 +00003955unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
3956 return CXReparse_None;
3957}
3958
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003959static CXErrorCode
3960clang_reparseTranslationUnit_Impl(CXTranslationUnit TU,
3961 ArrayRef<CXUnsavedFile> unsaved_files,
3962 unsigned options) {
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003963 // Check arguments.
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003964 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003965 LOG_BAD_TU(TU);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003966 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003967 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003968
3969 // Reset the associated diagnostics.
3970 delete static_cast<CXDiagnosticSetImpl*>(TU->Diagnostics);
Craig Topper69186e72014-06-08 08:38:04 +00003971 TU->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003972
Dmitri Gribenko183436e2013-01-26 21:49:50 +00003973 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003974 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
3975 setThreadBackgroundPriority();
3976
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003977 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003978 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ahmed Charlesb8984322014-03-07 20:03:18 +00003979
3980 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3981 new std::vector<ASTUnit::RemappedFile>());
3982
Guy Benyei11169dd2012-12-18 14:30:41 +00003983 // Recover resources if we crash before exiting this function.
3984 llvm::CrashRecoveryContextCleanupRegistrar<
3985 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
Alp Toker9d85b182014-07-07 01:23:14 +00003986
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003987 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003988 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003989 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003990 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003991 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003992
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003993 if (!CXXUnit->Reparse(CXXIdx->getPCHContainerOperations(),
3994 *RemappedFiles.get()))
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003995 return CXError_Success;
3996 if (isASTReadError(CXXUnit))
3997 return CXError_ASTReadError;
3998 return CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003999}
4000
4001int clang_reparseTranslationUnit(CXTranslationUnit TU,
4002 unsigned num_unsaved_files,
4003 struct CXUnsavedFile *unsaved_files,
4004 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00004005 LOG_FUNC_SECTION {
4006 *Log << TU;
4007 }
4008
Alp Toker9d85b182014-07-07 01:23:14 +00004009 if (num_unsaved_files && !unsaved_files)
4010 return CXError_InvalidArguments;
4011
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004012 CXErrorCode result;
4013 auto ReparseTranslationUnitImpl = [=, &result]() {
4014 result = clang_reparseTranslationUnit_Impl(
4015 TU, llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
4016 };
Guy Benyei11169dd2012-12-18 14:30:41 +00004017
4018 if (getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004019 ReparseTranslationUnitImpl();
Alp Toker5c532982014-07-07 22:42:03 +00004020 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00004021 }
4022
4023 llvm::CrashRecoveryContext CRC;
4024
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004025 if (!RunSafely(CRC, ReparseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004026 fprintf(stderr, "libclang: crash detected during reparsing\n");
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004027 cxtu::getASTUnit(TU)->setUnsafeToFree(true);
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004028 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00004029 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
4030 PrintLibclangResourceUsage(TU);
4031
Alp Toker5c532982014-07-07 22:42:03 +00004032 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00004033}
4034
4035
4036CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004037 if (isNotUsableTU(CTUnit)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004038 LOG_BAD_TU(CTUnit);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004039 return cxstring::createEmpty();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004040 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004041
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004042 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004043 return cxstring::createDup(CXXUnit->getOriginalSourceFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004044}
4045
4046CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004047 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004048 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00004049 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004050 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00004051
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004052 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004053 return MakeCXCursor(CXXUnit->getASTContext().getTranslationUnitDecl(), TU);
4054}
4055
Emilio Cobos Alvarez485ad422017-04-28 15:56:39 +00004056CXTargetInfo clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit) {
4057 if (isNotUsableTU(CTUnit)) {
4058 LOG_BAD_TU(CTUnit);
4059 return nullptr;
4060 }
4061
4062 CXTargetInfoImpl* impl = new CXTargetInfoImpl();
4063 impl->TranslationUnit = CTUnit;
4064 return impl;
4065}
4066
4067CXString clang_TargetInfo_getTriple(CXTargetInfo TargetInfo) {
4068 if (!TargetInfo)
4069 return cxstring::createEmpty();
4070
4071 CXTranslationUnit CTUnit = TargetInfo->TranslationUnit;
4072 assert(!isNotUsableTU(CTUnit) &&
4073 "Unexpected unusable translation unit in TargetInfo");
4074
4075 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
4076 std::string Triple =
4077 CXXUnit->getASTContext().getTargetInfo().getTriple().normalize();
4078 return cxstring::createDup(Triple);
4079}
4080
4081int clang_TargetInfo_getPointerWidth(CXTargetInfo TargetInfo) {
4082 if (!TargetInfo)
4083 return -1;
4084
4085 CXTranslationUnit CTUnit = TargetInfo->TranslationUnit;
4086 assert(!isNotUsableTU(CTUnit) &&
4087 "Unexpected unusable translation unit in TargetInfo");
4088
4089 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
4090 return CXXUnit->getASTContext().getTargetInfo().getMaxPointerWidth();
4091}
4092
4093void clang_TargetInfo_dispose(CXTargetInfo TargetInfo) {
4094 if (!TargetInfo)
4095 return;
4096
4097 delete TargetInfo;
4098}
4099
Guy Benyei11169dd2012-12-18 14:30:41 +00004100//===----------------------------------------------------------------------===//
4101// CXFile Operations.
4102//===----------------------------------------------------------------------===//
4103
Guy Benyei11169dd2012-12-18 14:30:41 +00004104CXString clang_getFileName(CXFile SFile) {
4105 if (!SFile)
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00004106 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00004107
4108 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004109 return cxstring::createRef(FEnt->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004110}
4111
4112time_t clang_getFileTime(CXFile SFile) {
4113 if (!SFile)
4114 return 0;
4115
4116 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
4117 return FEnt->getModificationTime();
4118}
4119
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004120CXFile clang_getFile(CXTranslationUnit TU, const char *file_name) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004121 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004122 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00004123 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004124 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004125
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004126 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004127
4128 FileManager &FMgr = CXXUnit->getFileManager();
4129 return const_cast<FileEntry *>(FMgr.getFile(file_name));
4130}
4131
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004132unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit TU,
4133 CXFile file) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004134 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004135 LOG_BAD_TU(TU);
4136 return 0;
4137 }
4138
4139 if (!file)
Guy Benyei11169dd2012-12-18 14:30:41 +00004140 return 0;
4141
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004142 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004143 FileEntry *FEnt = static_cast<FileEntry *>(file);
4144 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
4145 .isFileMultipleIncludeGuarded(FEnt);
4146}
4147
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004148int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID) {
4149 if (!file || !outID)
4150 return 1;
4151
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004152 FileEntry *FEnt = static_cast<FileEntry *>(file);
Rafael Espindolaf8f91b82013-08-01 21:42:11 +00004153 const llvm::sys::fs::UniqueID &ID = FEnt->getUniqueID();
4154 outID->data[0] = ID.getDevice();
4155 outID->data[1] = ID.getFile();
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004156 outID->data[2] = FEnt->getModificationTime();
4157 return 0;
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004158}
4159
Argyrios Kyrtzidisac3997e2014-08-16 00:26:19 +00004160int clang_File_isEqual(CXFile file1, CXFile file2) {
4161 if (file1 == file2)
4162 return true;
4163
4164 if (!file1 || !file2)
4165 return false;
4166
4167 FileEntry *FEnt1 = static_cast<FileEntry *>(file1);
4168 FileEntry *FEnt2 = static_cast<FileEntry *>(file2);
4169 return FEnt1->getUniqueID() == FEnt2->getUniqueID();
4170}
4171
Guy Benyei11169dd2012-12-18 14:30:41 +00004172//===----------------------------------------------------------------------===//
4173// CXCursor Operations.
4174//===----------------------------------------------------------------------===//
4175
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004176static const Decl *getDeclFromExpr(const Stmt *E) {
4177 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004178 return getDeclFromExpr(CE->getSubExpr());
4179
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004180 if (const DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004181 return RefExpr->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004182 if (const MemberExpr *ME = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004183 return ME->getMemberDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004184 if (const ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004185 return RE->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004186 if (const ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004187 if (PRE->isExplicitProperty())
4188 return PRE->getExplicitProperty();
4189 // It could be messaging both getter and setter as in:
4190 // ++myobj.myprop;
4191 // in which case prefer to associate the setter since it is less obvious
4192 // from inspecting the source that the setter is going to get called.
4193 if (PRE->isMessagingSetter())
4194 return PRE->getImplicitPropertySetter();
4195 return PRE->getImplicitPropertyGetter();
4196 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004197 if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004198 return getDeclFromExpr(POE->getSyntacticForm());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004199 if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004200 if (Expr *Src = OVE->getSourceExpr())
4201 return getDeclFromExpr(Src);
4202
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004203 if (const CallExpr *CE = dyn_cast<CallExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004204 return getDeclFromExpr(CE->getCallee());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004205 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004206 if (!CE->isElidable())
4207 return CE->getConstructor();
Richard Smith5179eb72016-06-28 19:03:57 +00004208 if (const CXXInheritedCtorInitExpr *CE =
4209 dyn_cast<CXXInheritedCtorInitExpr>(E))
4210 return CE->getConstructor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004211 if (const ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004212 return OME->getMethodDecl();
4213
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004214 if (const ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004215 return PE->getProtocol();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004216 if (const SubstNonTypeTemplateParmPackExpr *NTTP
Guy Benyei11169dd2012-12-18 14:30:41 +00004217 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
4218 return NTTP->getParameterPack();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004219 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004220 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
4221 isa<ParmVarDecl>(SizeOfPack->getPack()))
4222 return SizeOfPack->getPack();
Craig Topper69186e72014-06-08 08:38:04 +00004223
4224 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004225}
4226
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004227static SourceLocation getLocationFromExpr(const Expr *E) {
4228 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004229 return getLocationFromExpr(CE->getSubExpr());
4230
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004231 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004232 return /*FIXME:*/Msg->getLeftLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004233 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004234 return DRE->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004235 if (const MemberExpr *Member = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004236 return Member->getMemberLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004237 if (const ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004238 return Ivar->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004239 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004240 return SizeOfPack->getPackLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004241 if (const ObjCPropertyRefExpr *PropRef = dyn_cast<ObjCPropertyRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004242 return PropRef->getLocation();
4243
4244 return E->getLocStart();
4245}
4246
NAKAMURA Takumia01f4c32016-12-19 16:50:43 +00004247extern "C" {
4248
Guy Benyei11169dd2012-12-18 14:30:41 +00004249unsigned clang_visitChildren(CXCursor parent,
4250 CXCursorVisitor visitor,
4251 CXClientData client_data) {
4252 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
4253 /*VisitPreprocessorLast=*/false);
4254 return CursorVis.VisitChildren(parent);
4255}
4256
4257#ifndef __has_feature
4258#define __has_feature(x) 0
4259#endif
4260#if __has_feature(blocks)
4261typedef enum CXChildVisitResult
4262 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
4263
4264static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4265 CXClientData client_data) {
4266 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4267 return block(cursor, parent);
4268}
4269#else
4270// If we are compiled with a compiler that doesn't have native blocks support,
4271// define and call the block manually, so the
4272typedef struct _CXChildVisitResult
4273{
4274 void *isa;
4275 int flags;
4276 int reserved;
4277 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
4278 CXCursor);
4279} *CXCursorVisitorBlock;
4280
4281static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4282 CXClientData client_data) {
4283 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4284 return block->invoke(block, cursor, parent);
4285}
4286#endif
4287
4288
4289unsigned clang_visitChildrenWithBlock(CXCursor parent,
4290 CXCursorVisitorBlock block) {
4291 return clang_visitChildren(parent, visitWithBlock, block);
4292}
4293
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004294static CXString getDeclSpelling(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004295 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004296 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004297
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004298 const NamedDecl *ND = dyn_cast<NamedDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004299 if (!ND) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004300 if (const ObjCPropertyImplDecl *PropImpl =
4301 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004302 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004303 return cxstring::createDup(Property->getIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004304
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004305 if (const ImportDecl *ImportD = dyn_cast<ImportDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004306 if (Module *Mod = ImportD->getImportedModule())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004307 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004308
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004309 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004310 }
4311
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004312 if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004313 return cxstring::createDup(OMD->getSelector().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004314
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004315 if (const ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Guy Benyei11169dd2012-12-18 14:30:41 +00004316 // No, this isn't the same as the code below. getIdentifier() is non-virtual
4317 // and returns different names. NamedDecl returns the class name and
4318 // ObjCCategoryImplDecl returns the category name.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004319 return cxstring::createRef(CIMP->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004320
4321 if (isa<UsingDirectiveDecl>(D))
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004322 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004323
4324 SmallString<1024> S;
4325 llvm::raw_svector_ostream os(S);
4326 ND->printName(os);
4327
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004328 return cxstring::createDup(os.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004329}
4330
4331CXString clang_getCursorSpelling(CXCursor C) {
4332 if (clang_isTranslationUnit(C.kind))
Dmitri Gribenko2c173b42013-01-11 19:28:44 +00004333 return clang_getTranslationUnitSpelling(getCursorTU(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004334
4335 if (clang_isReference(C.kind)) {
4336 switch (C.kind) {
4337 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004338 const ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004339 return cxstring::createRef(Super->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004340 }
4341 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004342 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004343 return cxstring::createRef(Class->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004344 }
4345 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004346 const ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004347 assert(OID && "getCursorSpelling(): Missing protocol decl");
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004348 return cxstring::createRef(OID->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004349 }
4350 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004351 const CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004352 return cxstring::createDup(B->getType().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004353 }
4354 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004355 const TypeDecl *Type = getCursorTypeRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004356 assert(Type && "Missing type decl");
4357
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004358 return cxstring::createDup(getCursorContext(C).getTypeDeclType(Type).
Guy Benyei11169dd2012-12-18 14:30:41 +00004359 getAsString());
4360 }
4361 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004362 const TemplateDecl *Template = getCursorTemplateRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004363 assert(Template && "Missing template decl");
4364
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004365 return cxstring::createDup(Template->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004366 }
4367
4368 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004369 const NamedDecl *NS = getCursorNamespaceRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004370 assert(NS && "Missing namespace decl");
4371
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004372 return cxstring::createDup(NS->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004373 }
4374
4375 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004376 const FieldDecl *Field = getCursorMemberRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004377 assert(Field && "Missing member decl");
4378
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004379 return cxstring::createDup(Field->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004380 }
4381
4382 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004383 const LabelStmt *Label = getCursorLabelRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004384 assert(Label && "Missing label");
4385
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004386 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004387 }
4388
4389 case CXCursor_OverloadedDeclRef: {
4390 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004391 if (const Decl *D = Storage.dyn_cast<const Decl *>()) {
4392 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004393 return cxstring::createDup(ND->getNameAsString());
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004394 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004395 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004396 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004397 return cxstring::createDup(E->getName().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004398 OverloadedTemplateStorage *Ovl
4399 = Storage.get<OverloadedTemplateStorage*>();
4400 if (Ovl->size() == 0)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004401 return cxstring::createEmpty();
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004402 return cxstring::createDup((*Ovl->begin())->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004403 }
4404
4405 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004406 const VarDecl *Var = getCursorVariableRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004407 assert(Var && "Missing variable decl");
4408
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004409 return cxstring::createDup(Var->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004410 }
4411
4412 default:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004413 return cxstring::createRef("<not implemented>");
Guy Benyei11169dd2012-12-18 14:30:41 +00004414 }
4415 }
4416
4417 if (clang_isExpression(C.kind)) {
Argyrios Kyrtzidis3227d862014-03-03 19:40:52 +00004418 const Expr *E = getCursorExpr(C);
4419
4420 if (C.kind == CXCursor_ObjCStringLiteral ||
4421 C.kind == CXCursor_StringLiteral) {
4422 const StringLiteral *SLit;
4423 if (const ObjCStringLiteral *OSL = dyn_cast<ObjCStringLiteral>(E)) {
4424 SLit = OSL->getString();
4425 } else {
4426 SLit = cast<StringLiteral>(E);
4427 }
4428 SmallString<256> Buf;
4429 llvm::raw_svector_ostream OS(Buf);
4430 SLit->outputString(OS);
4431 return cxstring::createDup(OS.str());
4432 }
4433
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004434 const Decl *D = getDeclFromExpr(getCursorExpr(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004435 if (D)
4436 return getDeclSpelling(D);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004437 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004438 }
4439
4440 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004441 const Stmt *S = getCursorStmt(C);
4442 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004443 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004444
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004445 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004446 }
4447
4448 if (C.kind == CXCursor_MacroExpansion)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004449 return cxstring::createRef(getCursorMacroExpansion(C).getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004450 ->getNameStart());
4451
4452 if (C.kind == CXCursor_MacroDefinition)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004453 return cxstring::createRef(getCursorMacroDefinition(C)->getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004454 ->getNameStart());
4455
4456 if (C.kind == CXCursor_InclusionDirective)
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004457 return cxstring::createDup(getCursorInclusionDirective(C)->getFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004458
4459 if (clang_isDeclaration(C.kind))
4460 return getDeclSpelling(getCursorDecl(C));
4461
4462 if (C.kind == CXCursor_AnnotateAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004463 const AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004464 return cxstring::createDup(AA->getAnnotation());
Guy Benyei11169dd2012-12-18 14:30:41 +00004465 }
4466
4467 if (C.kind == CXCursor_AsmLabelAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004468 const AsmLabelAttr *AA = cast<AsmLabelAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004469 return cxstring::createDup(AA->getLabel());
Guy Benyei11169dd2012-12-18 14:30:41 +00004470 }
4471
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004472 if (C.kind == CXCursor_PackedAttr) {
4473 return cxstring::createRef("packed");
4474 }
4475
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004476 if (C.kind == CXCursor_VisibilityAttr) {
4477 const VisibilityAttr *AA = cast<VisibilityAttr>(cxcursor::getCursorAttr(C));
4478 switch (AA->getVisibility()) {
4479 case VisibilityAttr::VisibilityType::Default:
4480 return cxstring::createRef("default");
4481 case VisibilityAttr::VisibilityType::Hidden:
4482 return cxstring::createRef("hidden");
4483 case VisibilityAttr::VisibilityType::Protected:
4484 return cxstring::createRef("protected");
4485 }
4486 llvm_unreachable("unknown visibility type");
4487 }
4488
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004489 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004490}
4491
4492CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor C,
4493 unsigned pieceIndex,
4494 unsigned options) {
4495 if (clang_Cursor_isNull(C))
4496 return clang_getNullRange();
4497
4498 ASTContext &Ctx = getCursorContext(C);
4499
4500 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004501 const Stmt *S = getCursorStmt(C);
4502 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004503 if (pieceIndex > 0)
4504 return clang_getNullRange();
4505 return cxloc::translateSourceRange(Ctx, Label->getIdentLoc());
4506 }
4507
4508 return clang_getNullRange();
4509 }
4510
4511 if (C.kind == CXCursor_ObjCMessageExpr) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004512 if (const ObjCMessageExpr *
Guy Benyei11169dd2012-12-18 14:30:41 +00004513 ME = dyn_cast_or_null<ObjCMessageExpr>(getCursorExpr(C))) {
4514 if (pieceIndex >= ME->getNumSelectorLocs())
4515 return clang_getNullRange();
4516 return cxloc::translateSourceRange(Ctx, ME->getSelectorLoc(pieceIndex));
4517 }
4518 }
4519
4520 if (C.kind == CXCursor_ObjCInstanceMethodDecl ||
4521 C.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004522 if (const ObjCMethodDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004523 MD = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(C))) {
4524 if (pieceIndex >= MD->getNumSelectorLocs())
4525 return clang_getNullRange();
4526 return cxloc::translateSourceRange(Ctx, MD->getSelectorLoc(pieceIndex));
4527 }
4528 }
4529
4530 if (C.kind == CXCursor_ObjCCategoryDecl ||
4531 C.kind == CXCursor_ObjCCategoryImplDecl) {
4532 if (pieceIndex > 0)
4533 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004534 if (const ObjCCategoryDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004535 CD = dyn_cast_or_null<ObjCCategoryDecl>(getCursorDecl(C)))
4536 return cxloc::translateSourceRange(Ctx, CD->getCategoryNameLoc());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004537 if (const ObjCCategoryImplDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004538 CID = dyn_cast_or_null<ObjCCategoryImplDecl>(getCursorDecl(C)))
4539 return cxloc::translateSourceRange(Ctx, CID->getCategoryNameLoc());
4540 }
4541
4542 if (C.kind == CXCursor_ModuleImportDecl) {
4543 if (pieceIndex > 0)
4544 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004545 if (const ImportDecl *ImportD =
4546 dyn_cast_or_null<ImportDecl>(getCursorDecl(C))) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004547 ArrayRef<SourceLocation> Locs = ImportD->getIdentifierLocs();
4548 if (!Locs.empty())
4549 return cxloc::translateSourceRange(Ctx,
4550 SourceRange(Locs.front(), Locs.back()));
4551 }
4552 return clang_getNullRange();
4553 }
4554
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004555 if (C.kind == CXCursor_CXXMethod || C.kind == CXCursor_Destructor ||
Kevin Funk4be5d672016-12-20 09:56:56 +00004556 C.kind == CXCursor_ConversionFunction ||
4557 C.kind == CXCursor_FunctionDecl) {
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004558 if (pieceIndex > 0)
4559 return clang_getNullRange();
4560 if (const FunctionDecl *FD =
4561 dyn_cast_or_null<FunctionDecl>(getCursorDecl(C))) {
4562 DeclarationNameInfo FunctionName = FD->getNameInfo();
4563 return cxloc::translateSourceRange(Ctx, FunctionName.getSourceRange());
4564 }
4565 return clang_getNullRange();
4566 }
4567
Guy Benyei11169dd2012-12-18 14:30:41 +00004568 // FIXME: A CXCursor_InclusionDirective should give the location of the
4569 // filename, but we don't keep track of this.
4570
4571 // FIXME: A CXCursor_AnnotateAttr should give the location of the annotation
4572 // but we don't keep track of this.
4573
4574 // FIXME: A CXCursor_AsmLabelAttr should give the location of the label
4575 // but we don't keep track of this.
4576
4577 // Default handling, give the location of the cursor.
4578
4579 if (pieceIndex > 0)
4580 return clang_getNullRange();
4581
4582 CXSourceLocation CXLoc = clang_getCursorLocation(C);
4583 SourceLocation Loc = cxloc::translateSourceLocation(CXLoc);
4584 return cxloc::translateSourceRange(Ctx, Loc);
4585}
4586
Eli Bendersky44a206f2014-07-31 18:04:56 +00004587CXString clang_Cursor_getMangling(CXCursor C) {
4588 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4589 return cxstring::createEmpty();
4590
Eli Bendersky44a206f2014-07-31 18:04:56 +00004591 // Mangling only works for functions and variables.
Eli Bendersky79759592014-08-01 15:01:10 +00004592 const Decl *D = getCursorDecl(C);
Eli Bendersky44a206f2014-07-31 18:04:56 +00004593 if (!D || !(isa<FunctionDecl>(D) || isa<VarDecl>(D)))
4594 return cxstring::createEmpty();
4595
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004596 ASTContext &Ctx = D->getASTContext();
4597 index::CodegenNameGenerator CGNameGen(Ctx);
4598 return cxstring::createDup(CGNameGen.getName(D));
Eli Bendersky44a206f2014-07-31 18:04:56 +00004599}
4600
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004601CXStringSet *clang_Cursor_getCXXManglings(CXCursor C) {
4602 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4603 return nullptr;
4604
4605 const Decl *D = getCursorDecl(C);
4606 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
4607 return nullptr;
4608
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004609 ASTContext &Ctx = D->getASTContext();
4610 index::CodegenNameGenerator CGNameGen(Ctx);
4611 std::vector<std::string> Manglings = CGNameGen.getAllManglings(D);
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004612 return cxstring::createSet(Manglings);
4613}
4614
Guy Benyei11169dd2012-12-18 14:30:41 +00004615CXString clang_getCursorDisplayName(CXCursor C) {
4616 if (!clang_isDeclaration(C.kind))
4617 return clang_getCursorSpelling(C);
4618
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004619 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00004620 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004621 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004622
4623 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004624 if (const FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004625 D = FunTmpl->getTemplatedDecl();
4626
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004627 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004628 SmallString<64> Str;
4629 llvm::raw_svector_ostream OS(Str);
4630 OS << *Function;
4631 if (Function->getPrimaryTemplate())
4632 OS << "<>";
4633 OS << "(";
4634 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
4635 if (I)
4636 OS << ", ";
4637 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
4638 }
4639
4640 if (Function->isVariadic()) {
4641 if (Function->getNumParams())
4642 OS << ", ";
4643 OS << "...";
4644 }
4645 OS << ")";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004646 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004647 }
4648
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004649 if (const ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004650 SmallString<64> Str;
4651 llvm::raw_svector_ostream OS(Str);
4652 OS << *ClassTemplate;
4653 OS << "<";
4654 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
4655 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
4656 if (I)
4657 OS << ", ";
4658
4659 NamedDecl *Param = Params->getParam(I);
4660 if (Param->getIdentifier()) {
4661 OS << Param->getIdentifier()->getName();
4662 continue;
4663 }
4664
4665 // There is no parameter name, which makes this tricky. Try to come up
4666 // with something useful that isn't too long.
4667 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
4668 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
4669 else if (NonTypeTemplateParmDecl *NTTP
4670 = dyn_cast<NonTypeTemplateParmDecl>(Param))
4671 OS << NTTP->getType().getAsString(Policy);
4672 else
4673 OS << "template<...> class";
4674 }
4675
4676 OS << ">";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004677 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004678 }
4679
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004680 if (const ClassTemplateSpecializationDecl *ClassSpec
Guy Benyei11169dd2012-12-18 14:30:41 +00004681 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
4682 // If the type was explicitly written, use that.
4683 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004684 return cxstring::createDup(TSInfo->getType().getAsString(Policy));
Guy Benyei11169dd2012-12-18 14:30:41 +00004685
Benjamin Kramer9170e912013-02-22 15:46:01 +00004686 SmallString<128> Str;
Guy Benyei11169dd2012-12-18 14:30:41 +00004687 llvm::raw_svector_ostream OS(Str);
4688 OS << *ClassSpec;
David Majnemer6fbeee32016-07-07 04:43:07 +00004689 TemplateSpecializationType::PrintTemplateArgumentList(
4690 OS, ClassSpec->getTemplateArgs().asArray(), Policy);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004691 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004692 }
4693
4694 return clang_getCursorSpelling(C);
4695}
4696
4697CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
4698 switch (Kind) {
4699 case CXCursor_FunctionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004700 return cxstring::createRef("FunctionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004701 case CXCursor_TypedefDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004702 return cxstring::createRef("TypedefDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004703 case CXCursor_EnumDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004704 return cxstring::createRef("EnumDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004705 case CXCursor_EnumConstantDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004706 return cxstring::createRef("EnumConstantDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004707 case CXCursor_StructDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004708 return cxstring::createRef("StructDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004709 case CXCursor_UnionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004710 return cxstring::createRef("UnionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004711 case CXCursor_ClassDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004712 return cxstring::createRef("ClassDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004713 case CXCursor_FieldDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004714 return cxstring::createRef("FieldDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004715 case CXCursor_VarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004716 return cxstring::createRef("VarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004717 case CXCursor_ParmDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004718 return cxstring::createRef("ParmDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004719 case CXCursor_ObjCInterfaceDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004720 return cxstring::createRef("ObjCInterfaceDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004721 case CXCursor_ObjCCategoryDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004722 return cxstring::createRef("ObjCCategoryDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004723 case CXCursor_ObjCProtocolDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004724 return cxstring::createRef("ObjCProtocolDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004725 case CXCursor_ObjCPropertyDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004726 return cxstring::createRef("ObjCPropertyDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004727 case CXCursor_ObjCIvarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004728 return cxstring::createRef("ObjCIvarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004729 case CXCursor_ObjCInstanceMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004730 return cxstring::createRef("ObjCInstanceMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004731 case CXCursor_ObjCClassMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004732 return cxstring::createRef("ObjCClassMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004733 case CXCursor_ObjCImplementationDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004734 return cxstring::createRef("ObjCImplementationDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004735 case CXCursor_ObjCCategoryImplDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004736 return cxstring::createRef("ObjCCategoryImplDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004737 case CXCursor_CXXMethod:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004738 return cxstring::createRef("CXXMethod");
Guy Benyei11169dd2012-12-18 14:30:41 +00004739 case CXCursor_UnexposedDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004740 return cxstring::createRef("UnexposedDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004741 case CXCursor_ObjCSuperClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004742 return cxstring::createRef("ObjCSuperClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004743 case CXCursor_ObjCProtocolRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004744 return cxstring::createRef("ObjCProtocolRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004745 case CXCursor_ObjCClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004746 return cxstring::createRef("ObjCClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004747 case CXCursor_TypeRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004748 return cxstring::createRef("TypeRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004749 case CXCursor_TemplateRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004750 return cxstring::createRef("TemplateRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004751 case CXCursor_NamespaceRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004752 return cxstring::createRef("NamespaceRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004753 case CXCursor_MemberRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004754 return cxstring::createRef("MemberRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004755 case CXCursor_LabelRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004756 return cxstring::createRef("LabelRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004757 case CXCursor_OverloadedDeclRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004758 return cxstring::createRef("OverloadedDeclRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004759 case CXCursor_VariableRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004760 return cxstring::createRef("VariableRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004761 case CXCursor_IntegerLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004762 return cxstring::createRef("IntegerLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004763 case CXCursor_FloatingLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004764 return cxstring::createRef("FloatingLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004765 case CXCursor_ImaginaryLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004766 return cxstring::createRef("ImaginaryLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004767 case CXCursor_StringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004768 return cxstring::createRef("StringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004769 case CXCursor_CharacterLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004770 return cxstring::createRef("CharacterLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004771 case CXCursor_ParenExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004772 return cxstring::createRef("ParenExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004773 case CXCursor_UnaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004774 return cxstring::createRef("UnaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004775 case CXCursor_ArraySubscriptExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004776 return cxstring::createRef("ArraySubscriptExpr");
Alexey Bataev1a3320e2015-08-25 14:24:04 +00004777 case CXCursor_OMPArraySectionExpr:
4778 return cxstring::createRef("OMPArraySectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004779 case CXCursor_BinaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004780 return cxstring::createRef("BinaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004781 case CXCursor_CompoundAssignOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004782 return cxstring::createRef("CompoundAssignOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004783 case CXCursor_ConditionalOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004784 return cxstring::createRef("ConditionalOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004785 case CXCursor_CStyleCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004786 return cxstring::createRef("CStyleCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004787 case CXCursor_CompoundLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004788 return cxstring::createRef("CompoundLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004789 case CXCursor_InitListExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004790 return cxstring::createRef("InitListExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004791 case CXCursor_AddrLabelExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004792 return cxstring::createRef("AddrLabelExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004793 case CXCursor_StmtExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004794 return cxstring::createRef("StmtExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004795 case CXCursor_GenericSelectionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004796 return cxstring::createRef("GenericSelectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004797 case CXCursor_GNUNullExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004798 return cxstring::createRef("GNUNullExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004799 case CXCursor_CXXStaticCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004800 return cxstring::createRef("CXXStaticCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004801 case CXCursor_CXXDynamicCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004802 return cxstring::createRef("CXXDynamicCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004803 case CXCursor_CXXReinterpretCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004804 return cxstring::createRef("CXXReinterpretCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004805 case CXCursor_CXXConstCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004806 return cxstring::createRef("CXXConstCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004807 case CXCursor_CXXFunctionalCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004808 return cxstring::createRef("CXXFunctionalCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004809 case CXCursor_CXXTypeidExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004810 return cxstring::createRef("CXXTypeidExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004811 case CXCursor_CXXBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004812 return cxstring::createRef("CXXBoolLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004813 case CXCursor_CXXNullPtrLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004814 return cxstring::createRef("CXXNullPtrLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004815 case CXCursor_CXXThisExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004816 return cxstring::createRef("CXXThisExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004817 case CXCursor_CXXThrowExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004818 return cxstring::createRef("CXXThrowExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004819 case CXCursor_CXXNewExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004820 return cxstring::createRef("CXXNewExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004821 case CXCursor_CXXDeleteExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004822 return cxstring::createRef("CXXDeleteExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004823 case CXCursor_UnaryExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004824 return cxstring::createRef("UnaryExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004825 case CXCursor_ObjCStringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004826 return cxstring::createRef("ObjCStringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004827 case CXCursor_ObjCBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004828 return cxstring::createRef("ObjCBoolLiteralExpr");
Erik Pilkington29099de2016-07-16 00:35:23 +00004829 case CXCursor_ObjCAvailabilityCheckExpr:
4830 return cxstring::createRef("ObjCAvailabilityCheckExpr");
Argyrios Kyrtzidisc2233be2013-04-23 17:57:17 +00004831 case CXCursor_ObjCSelfExpr:
4832 return cxstring::createRef("ObjCSelfExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004833 case CXCursor_ObjCEncodeExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004834 return cxstring::createRef("ObjCEncodeExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004835 case CXCursor_ObjCSelectorExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004836 return cxstring::createRef("ObjCSelectorExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004837 case CXCursor_ObjCProtocolExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004838 return cxstring::createRef("ObjCProtocolExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004839 case CXCursor_ObjCBridgedCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004840 return cxstring::createRef("ObjCBridgedCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004841 case CXCursor_BlockExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004842 return cxstring::createRef("BlockExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004843 case CXCursor_PackExpansionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004844 return cxstring::createRef("PackExpansionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004845 case CXCursor_SizeOfPackExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004846 return cxstring::createRef("SizeOfPackExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004847 case CXCursor_LambdaExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004848 return cxstring::createRef("LambdaExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004849 case CXCursor_UnexposedExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004850 return cxstring::createRef("UnexposedExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004851 case CXCursor_DeclRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004852 return cxstring::createRef("DeclRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004853 case CXCursor_MemberRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004854 return cxstring::createRef("MemberRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004855 case CXCursor_CallExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004856 return cxstring::createRef("CallExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004857 case CXCursor_ObjCMessageExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004858 return cxstring::createRef("ObjCMessageExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004859 case CXCursor_UnexposedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004860 return cxstring::createRef("UnexposedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004861 case CXCursor_DeclStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004862 return cxstring::createRef("DeclStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004863 case CXCursor_LabelStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004864 return cxstring::createRef("LabelStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004865 case CXCursor_CompoundStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004866 return cxstring::createRef("CompoundStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004867 case CXCursor_CaseStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004868 return cxstring::createRef("CaseStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004869 case CXCursor_DefaultStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004870 return cxstring::createRef("DefaultStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004871 case CXCursor_IfStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004872 return cxstring::createRef("IfStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004873 case CXCursor_SwitchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004874 return cxstring::createRef("SwitchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004875 case CXCursor_WhileStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004876 return cxstring::createRef("WhileStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004877 case CXCursor_DoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004878 return cxstring::createRef("DoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004879 case CXCursor_ForStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004880 return cxstring::createRef("ForStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004881 case CXCursor_GotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004882 return cxstring::createRef("GotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004883 case CXCursor_IndirectGotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004884 return cxstring::createRef("IndirectGotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004885 case CXCursor_ContinueStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004886 return cxstring::createRef("ContinueStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004887 case CXCursor_BreakStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004888 return cxstring::createRef("BreakStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004889 case CXCursor_ReturnStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004890 return cxstring::createRef("ReturnStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004891 case CXCursor_GCCAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004892 return cxstring::createRef("GCCAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004893 case CXCursor_MSAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004894 return cxstring::createRef("MSAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004895 case CXCursor_ObjCAtTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004896 return cxstring::createRef("ObjCAtTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004897 case CXCursor_ObjCAtCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004898 return cxstring::createRef("ObjCAtCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004899 case CXCursor_ObjCAtFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004900 return cxstring::createRef("ObjCAtFinallyStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004901 case CXCursor_ObjCAtThrowStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004902 return cxstring::createRef("ObjCAtThrowStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004903 case CXCursor_ObjCAtSynchronizedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004904 return cxstring::createRef("ObjCAtSynchronizedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004905 case CXCursor_ObjCAutoreleasePoolStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004906 return cxstring::createRef("ObjCAutoreleasePoolStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004907 case CXCursor_ObjCForCollectionStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004908 return cxstring::createRef("ObjCForCollectionStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004909 case CXCursor_CXXCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004910 return cxstring::createRef("CXXCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004911 case CXCursor_CXXTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004912 return cxstring::createRef("CXXTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004913 case CXCursor_CXXForRangeStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004914 return cxstring::createRef("CXXForRangeStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004915 case CXCursor_SEHTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004916 return cxstring::createRef("SEHTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004917 case CXCursor_SEHExceptStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004918 return cxstring::createRef("SEHExceptStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004919 case CXCursor_SEHFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004920 return cxstring::createRef("SEHFinallyStmt");
Nico Weber9b982072014-07-07 00:12:30 +00004921 case CXCursor_SEHLeaveStmt:
4922 return cxstring::createRef("SEHLeaveStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004923 case CXCursor_NullStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004924 return cxstring::createRef("NullStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004925 case CXCursor_InvalidFile:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004926 return cxstring::createRef("InvalidFile");
Guy Benyei11169dd2012-12-18 14:30:41 +00004927 case CXCursor_InvalidCode:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004928 return cxstring::createRef("InvalidCode");
Guy Benyei11169dd2012-12-18 14:30:41 +00004929 case CXCursor_NoDeclFound:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004930 return cxstring::createRef("NoDeclFound");
Guy Benyei11169dd2012-12-18 14:30:41 +00004931 case CXCursor_NotImplemented:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004932 return cxstring::createRef("NotImplemented");
Guy Benyei11169dd2012-12-18 14:30:41 +00004933 case CXCursor_TranslationUnit:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004934 return cxstring::createRef("TranslationUnit");
Guy Benyei11169dd2012-12-18 14:30:41 +00004935 case CXCursor_UnexposedAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004936 return cxstring::createRef("UnexposedAttr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004937 case CXCursor_IBActionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004938 return cxstring::createRef("attribute(ibaction)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004939 case CXCursor_IBOutletAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004940 return cxstring::createRef("attribute(iboutlet)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004941 case CXCursor_IBOutletCollectionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004942 return cxstring::createRef("attribute(iboutletcollection)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004943 case CXCursor_CXXFinalAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004944 return cxstring::createRef("attribute(final)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004945 case CXCursor_CXXOverrideAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004946 return cxstring::createRef("attribute(override)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004947 case CXCursor_AnnotateAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004948 return cxstring::createRef("attribute(annotate)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004949 case CXCursor_AsmLabelAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004950 return cxstring::createRef("asm label");
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004951 case CXCursor_PackedAttr:
4952 return cxstring::createRef("attribute(packed)");
Joey Gouly81228382014-05-01 15:41:58 +00004953 case CXCursor_PureAttr:
4954 return cxstring::createRef("attribute(pure)");
4955 case CXCursor_ConstAttr:
4956 return cxstring::createRef("attribute(const)");
4957 case CXCursor_NoDuplicateAttr:
4958 return cxstring::createRef("attribute(noduplicate)");
Eli Bendersky2581e662014-05-28 19:29:58 +00004959 case CXCursor_CUDAConstantAttr:
4960 return cxstring::createRef("attribute(constant)");
4961 case CXCursor_CUDADeviceAttr:
4962 return cxstring::createRef("attribute(device)");
4963 case CXCursor_CUDAGlobalAttr:
4964 return cxstring::createRef("attribute(global)");
4965 case CXCursor_CUDAHostAttr:
4966 return cxstring::createRef("attribute(host)");
Eli Bendersky9b071472014-08-08 14:59:00 +00004967 case CXCursor_CUDASharedAttr:
4968 return cxstring::createRef("attribute(shared)");
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004969 case CXCursor_VisibilityAttr:
4970 return cxstring::createRef("attribute(visibility)");
Saleem Abdulrasool8aa0b802015-12-10 18:45:18 +00004971 case CXCursor_DLLExport:
4972 return cxstring::createRef("attribute(dllexport)");
4973 case CXCursor_DLLImport:
4974 return cxstring::createRef("attribute(dllimport)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004975 case CXCursor_PreprocessingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004976 return cxstring::createRef("preprocessing directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004977 case CXCursor_MacroDefinition:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004978 return cxstring::createRef("macro definition");
Guy Benyei11169dd2012-12-18 14:30:41 +00004979 case CXCursor_MacroExpansion:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004980 return cxstring::createRef("macro expansion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004981 case CXCursor_InclusionDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004982 return cxstring::createRef("inclusion directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004983 case CXCursor_Namespace:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004984 return cxstring::createRef("Namespace");
Guy Benyei11169dd2012-12-18 14:30:41 +00004985 case CXCursor_LinkageSpec:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004986 return cxstring::createRef("LinkageSpec");
Guy Benyei11169dd2012-12-18 14:30:41 +00004987 case CXCursor_CXXBaseSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004988 return cxstring::createRef("C++ base class specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00004989 case CXCursor_Constructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004990 return cxstring::createRef("CXXConstructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004991 case CXCursor_Destructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004992 return cxstring::createRef("CXXDestructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004993 case CXCursor_ConversionFunction:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004994 return cxstring::createRef("CXXConversion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004995 case CXCursor_TemplateTypeParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004996 return cxstring::createRef("TemplateTypeParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004997 case CXCursor_NonTypeTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004998 return cxstring::createRef("NonTypeTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004999 case CXCursor_TemplateTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005000 return cxstring::createRef("TemplateTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00005001 case CXCursor_FunctionTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005002 return cxstring::createRef("FunctionTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00005003 case CXCursor_ClassTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005004 return cxstring::createRef("ClassTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00005005 case CXCursor_ClassTemplatePartialSpecialization:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005006 return cxstring::createRef("ClassTemplatePartialSpecialization");
Guy Benyei11169dd2012-12-18 14:30:41 +00005007 case CXCursor_NamespaceAlias:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005008 return cxstring::createRef("NamespaceAlias");
Guy Benyei11169dd2012-12-18 14:30:41 +00005009 case CXCursor_UsingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005010 return cxstring::createRef("UsingDirective");
Guy Benyei11169dd2012-12-18 14:30:41 +00005011 case CXCursor_UsingDeclaration:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005012 return cxstring::createRef("UsingDeclaration");
Guy Benyei11169dd2012-12-18 14:30:41 +00005013 case CXCursor_TypeAliasDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005014 return cxstring::createRef("TypeAliasDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005015 case CXCursor_ObjCSynthesizeDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005016 return cxstring::createRef("ObjCSynthesizeDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005017 case CXCursor_ObjCDynamicDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005018 return cxstring::createRef("ObjCDynamicDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005019 case CXCursor_CXXAccessSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005020 return cxstring::createRef("CXXAccessSpecifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00005021 case CXCursor_ModuleImportDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005022 return cxstring::createRef("ModuleImport");
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00005023 case CXCursor_OMPParallelDirective:
Alexey Bataev1b59ab52014-02-27 08:29:12 +00005024 return cxstring::createRef("OMPParallelDirective");
5025 case CXCursor_OMPSimdDirective:
5026 return cxstring::createRef("OMPSimdDirective");
Alexey Bataevf29276e2014-06-18 04:14:57 +00005027 case CXCursor_OMPForDirective:
5028 return cxstring::createRef("OMPForDirective");
Alexander Musmanf82886e2014-09-18 05:12:34 +00005029 case CXCursor_OMPForSimdDirective:
5030 return cxstring::createRef("OMPForSimdDirective");
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00005031 case CXCursor_OMPSectionsDirective:
5032 return cxstring::createRef("OMPSectionsDirective");
Alexey Bataev1e0498a2014-06-26 08:21:58 +00005033 case CXCursor_OMPSectionDirective:
5034 return cxstring::createRef("OMPSectionDirective");
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00005035 case CXCursor_OMPSingleDirective:
5036 return cxstring::createRef("OMPSingleDirective");
Alexander Musman80c22892014-07-17 08:54:58 +00005037 case CXCursor_OMPMasterDirective:
5038 return cxstring::createRef("OMPMasterDirective");
Alexander Musmand9ed09f2014-07-21 09:42:05 +00005039 case CXCursor_OMPCriticalDirective:
5040 return cxstring::createRef("OMPCriticalDirective");
Alexey Bataev4acb8592014-07-07 13:01:15 +00005041 case CXCursor_OMPParallelForDirective:
5042 return cxstring::createRef("OMPParallelForDirective");
Alexander Musmane4e893b2014-09-23 09:33:00 +00005043 case CXCursor_OMPParallelForSimdDirective:
5044 return cxstring::createRef("OMPParallelForSimdDirective");
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00005045 case CXCursor_OMPParallelSectionsDirective:
5046 return cxstring::createRef("OMPParallelSectionsDirective");
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00005047 case CXCursor_OMPTaskDirective:
5048 return cxstring::createRef("OMPTaskDirective");
Alexey Bataev68446b72014-07-18 07:47:19 +00005049 case CXCursor_OMPTaskyieldDirective:
5050 return cxstring::createRef("OMPTaskyieldDirective");
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00005051 case CXCursor_OMPBarrierDirective:
5052 return cxstring::createRef("OMPBarrierDirective");
Alexey Bataev2df347a2014-07-18 10:17:07 +00005053 case CXCursor_OMPTaskwaitDirective:
5054 return cxstring::createRef("OMPTaskwaitDirective");
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00005055 case CXCursor_OMPTaskgroupDirective:
5056 return cxstring::createRef("OMPTaskgroupDirective");
Alexey Bataev6125da92014-07-21 11:26:11 +00005057 case CXCursor_OMPFlushDirective:
5058 return cxstring::createRef("OMPFlushDirective");
Alexey Bataev9fb6e642014-07-22 06:45:04 +00005059 case CXCursor_OMPOrderedDirective:
5060 return cxstring::createRef("OMPOrderedDirective");
Alexey Bataev0162e452014-07-22 10:10:35 +00005061 case CXCursor_OMPAtomicDirective:
5062 return cxstring::createRef("OMPAtomicDirective");
Alexey Bataev0bd520b2014-09-19 08:19:49 +00005063 case CXCursor_OMPTargetDirective:
5064 return cxstring::createRef("OMPTargetDirective");
Michael Wong65f367f2015-07-21 13:44:28 +00005065 case CXCursor_OMPTargetDataDirective:
5066 return cxstring::createRef("OMPTargetDataDirective");
Samuel Antaodf67fc42016-01-19 19:15:56 +00005067 case CXCursor_OMPTargetEnterDataDirective:
5068 return cxstring::createRef("OMPTargetEnterDataDirective");
Samuel Antao72590762016-01-19 20:04:50 +00005069 case CXCursor_OMPTargetExitDataDirective:
5070 return cxstring::createRef("OMPTargetExitDataDirective");
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00005071 case CXCursor_OMPTargetParallelDirective:
5072 return cxstring::createRef("OMPTargetParallelDirective");
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00005073 case CXCursor_OMPTargetParallelForDirective:
5074 return cxstring::createRef("OMPTargetParallelForDirective");
Samuel Antao686c70c2016-05-26 17:30:50 +00005075 case CXCursor_OMPTargetUpdateDirective:
5076 return cxstring::createRef("OMPTargetUpdateDirective");
Alexey Bataev13314bf2014-10-09 04:18:56 +00005077 case CXCursor_OMPTeamsDirective:
5078 return cxstring::createRef("OMPTeamsDirective");
Alexey Bataev6d4ed052015-07-01 06:57:41 +00005079 case CXCursor_OMPCancellationPointDirective:
5080 return cxstring::createRef("OMPCancellationPointDirective");
Alexey Bataev80909872015-07-02 11:25:17 +00005081 case CXCursor_OMPCancelDirective:
5082 return cxstring::createRef("OMPCancelDirective");
Alexey Bataev49f6e782015-12-01 04:18:41 +00005083 case CXCursor_OMPTaskLoopDirective:
5084 return cxstring::createRef("OMPTaskLoopDirective");
Alexey Bataev0a6ed842015-12-03 09:40:15 +00005085 case CXCursor_OMPTaskLoopSimdDirective:
5086 return cxstring::createRef("OMPTaskLoopSimdDirective");
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00005087 case CXCursor_OMPDistributeDirective:
5088 return cxstring::createRef("OMPDistributeDirective");
Carlo Bertolli9925f152016-06-27 14:55:37 +00005089 case CXCursor_OMPDistributeParallelForDirective:
5090 return cxstring::createRef("OMPDistributeParallelForDirective");
Kelvin Li4a39add2016-07-05 05:00:15 +00005091 case CXCursor_OMPDistributeParallelForSimdDirective:
5092 return cxstring::createRef("OMPDistributeParallelForSimdDirective");
Kelvin Li787f3fc2016-07-06 04:45:38 +00005093 case CXCursor_OMPDistributeSimdDirective:
5094 return cxstring::createRef("OMPDistributeSimdDirective");
Kelvin Lia579b912016-07-14 02:54:56 +00005095 case CXCursor_OMPTargetParallelForSimdDirective:
5096 return cxstring::createRef("OMPTargetParallelForSimdDirective");
Kelvin Li986330c2016-07-20 22:57:10 +00005097 case CXCursor_OMPTargetSimdDirective:
5098 return cxstring::createRef("OMPTargetSimdDirective");
Kelvin Li02532872016-08-05 14:37:37 +00005099 case CXCursor_OMPTeamsDistributeDirective:
5100 return cxstring::createRef("OMPTeamsDistributeDirective");
Kelvin Li4e325f72016-10-25 12:50:55 +00005101 case CXCursor_OMPTeamsDistributeSimdDirective:
5102 return cxstring::createRef("OMPTeamsDistributeSimdDirective");
Kelvin Li579e41c2016-11-30 23:51:03 +00005103 case CXCursor_OMPTeamsDistributeParallelForSimdDirective:
5104 return cxstring::createRef("OMPTeamsDistributeParallelForSimdDirective");
Kelvin Li7ade93f2016-12-09 03:24:30 +00005105 case CXCursor_OMPTeamsDistributeParallelForDirective:
5106 return cxstring::createRef("OMPTeamsDistributeParallelForDirective");
Kelvin Libf594a52016-12-17 05:48:59 +00005107 case CXCursor_OMPTargetTeamsDirective:
5108 return cxstring::createRef("OMPTargetTeamsDirective");
Kelvin Li83c451e2016-12-25 04:52:54 +00005109 case CXCursor_OMPTargetTeamsDistributeDirective:
5110 return cxstring::createRef("OMPTargetTeamsDistributeDirective");
Kelvin Li80e8f562016-12-29 22:16:30 +00005111 case CXCursor_OMPTargetTeamsDistributeParallelForDirective:
5112 return cxstring::createRef("OMPTargetTeamsDistributeParallelForDirective");
Kelvin Li1851df52017-01-03 05:23:48 +00005113 case CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective:
5114 return cxstring::createRef(
5115 "OMPTargetTeamsDistributeParallelForSimdDirective");
Kelvin Lida681182017-01-10 18:08:18 +00005116 case CXCursor_OMPTargetTeamsDistributeSimdDirective:
5117 return cxstring::createRef("OMPTargetTeamsDistributeSimdDirective");
Francisco Lopes da Silva975a9f62015-01-21 16:24:11 +00005118 case CXCursor_OverloadCandidate:
5119 return cxstring::createRef("OverloadCandidate");
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +00005120 case CXCursor_TypeAliasTemplateDecl:
5121 return cxstring::createRef("TypeAliasTemplateDecl");
Olivier Goffart81978012016-06-09 16:15:55 +00005122 case CXCursor_StaticAssert:
5123 return cxstring::createRef("StaticAssert");
Olivier Goffartd211c642016-11-04 06:29:27 +00005124 case CXCursor_FriendDecl:
5125 return cxstring::createRef("FriendDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005126 }
5127
5128 llvm_unreachable("Unhandled CXCursorKind");
5129}
5130
5131struct GetCursorData {
5132 SourceLocation TokenBeginLoc;
5133 bool PointsAtMacroArgExpansion;
5134 bool VisitedObjCPropertyImplDecl;
5135 SourceLocation VisitedDeclaratorDeclStartLoc;
5136 CXCursor &BestCursor;
5137
5138 GetCursorData(SourceManager &SM,
5139 SourceLocation tokenBegin, CXCursor &outputCursor)
5140 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
5141 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
5142 VisitedObjCPropertyImplDecl = false;
5143 }
5144};
5145
5146static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
5147 CXCursor parent,
5148 CXClientData client_data) {
5149 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
5150 CXCursor *BestCursor = &Data->BestCursor;
5151
5152 // If we point inside a macro argument we should provide info of what the
5153 // token is so use the actual cursor, don't replace it with a macro expansion
5154 // cursor.
5155 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
5156 return CXChildVisit_Recurse;
5157
5158 if (clang_isDeclaration(cursor.kind)) {
5159 // Avoid having the implicit methods override the property decls.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005160 if (const ObjCMethodDecl *MD
Guy Benyei11169dd2012-12-18 14:30:41 +00005161 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
5162 if (MD->isImplicit())
5163 return CXChildVisit_Break;
5164
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005165 } else if (const ObjCInterfaceDecl *ID
Guy Benyei11169dd2012-12-18 14:30:41 +00005166 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(cursor))) {
5167 // Check that when we have multiple @class references in the same line,
5168 // that later ones do not override the previous ones.
5169 // If we have:
5170 // @class Foo, Bar;
5171 // source ranges for both start at '@', so 'Bar' will end up overriding
5172 // 'Foo' even though the cursor location was at 'Foo'.
5173 if (BestCursor->kind == CXCursor_ObjCInterfaceDecl ||
5174 BestCursor->kind == CXCursor_ObjCClassRef)
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005175 if (const ObjCInterfaceDecl *PrevID
Guy Benyei11169dd2012-12-18 14:30:41 +00005176 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(*BestCursor))){
5177 if (PrevID != ID &&
5178 !PrevID->isThisDeclarationADefinition() &&
5179 !ID->isThisDeclarationADefinition())
5180 return CXChildVisit_Break;
5181 }
5182
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005183 } else if (const DeclaratorDecl *DD
Guy Benyei11169dd2012-12-18 14:30:41 +00005184 = dyn_cast_or_null<DeclaratorDecl>(getCursorDecl(cursor))) {
5185 SourceLocation StartLoc = DD->getSourceRange().getBegin();
5186 // Check that when we have multiple declarators in the same line,
5187 // that later ones do not override the previous ones.
5188 // If we have:
5189 // int Foo, Bar;
5190 // source ranges for both start at 'int', so 'Bar' will end up overriding
5191 // 'Foo' even though the cursor location was at 'Foo'.
5192 if (Data->VisitedDeclaratorDeclStartLoc == StartLoc)
5193 return CXChildVisit_Break;
5194 Data->VisitedDeclaratorDeclStartLoc = StartLoc;
5195
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005196 } else if (const ObjCPropertyImplDecl *PropImp
Guy Benyei11169dd2012-12-18 14:30:41 +00005197 = dyn_cast_or_null<ObjCPropertyImplDecl>(getCursorDecl(cursor))) {
5198 (void)PropImp;
5199 // Check that when we have multiple @synthesize in the same line,
5200 // that later ones do not override the previous ones.
5201 // If we have:
5202 // @synthesize Foo, Bar;
5203 // source ranges for both start at '@', so 'Bar' will end up overriding
5204 // 'Foo' even though the cursor location was at 'Foo'.
5205 if (Data->VisitedObjCPropertyImplDecl)
5206 return CXChildVisit_Break;
5207 Data->VisitedObjCPropertyImplDecl = true;
5208 }
5209 }
5210
5211 if (clang_isExpression(cursor.kind) &&
5212 clang_isDeclaration(BestCursor->kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005213 if (const Decl *D = getCursorDecl(*BestCursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005214 // Avoid having the cursor of an expression replace the declaration cursor
5215 // when the expression source range overlaps the declaration range.
5216 // This can happen for C++ constructor expressions whose range generally
5217 // include the variable declaration, e.g.:
5218 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
5219 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
5220 D->getLocation() == Data->TokenBeginLoc)
5221 return CXChildVisit_Break;
5222 }
5223 }
5224
5225 // If our current best cursor is the construction of a temporary object,
5226 // don't replace that cursor with a type reference, because we want
5227 // clang_getCursor() to point at the constructor.
5228 if (clang_isExpression(BestCursor->kind) &&
5229 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
5230 cursor.kind == CXCursor_TypeRef) {
5231 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
5232 // as having the actual point on the type reference.
5233 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
5234 return CXChildVisit_Recurse;
5235 }
Douglas Gregore9d95f12015-07-07 03:57:35 +00005236
5237 // If we already have an Objective-C superclass reference, don't
5238 // update it further.
5239 if (BestCursor->kind == CXCursor_ObjCSuperClassRef)
5240 return CXChildVisit_Break;
5241
Guy Benyei11169dd2012-12-18 14:30:41 +00005242 *BestCursor = cursor;
5243 return CXChildVisit_Recurse;
5244}
5245
5246CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005247 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005248 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005249 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005250 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005251
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005252 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005253 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
5254
5255 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
5256 CXCursor Result = cxcursor::getCursor(TU, SLoc);
5257
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005258 LOG_FUNC_SECTION {
Guy Benyei11169dd2012-12-18 14:30:41 +00005259 CXFile SearchFile;
5260 unsigned SearchLine, SearchColumn;
5261 CXFile ResultFile;
5262 unsigned ResultLine, ResultColumn;
5263 CXString SearchFileName, ResultFileName, KindSpelling, USR;
5264 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
5265 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
Craig Topper69186e72014-06-08 08:38:04 +00005266
5267 clang_getFileLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
5268 nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005269 clang_getFileLocation(ResultLoc, &ResultFile, &ResultLine,
Craig Topper69186e72014-06-08 08:38:04 +00005270 &ResultColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005271 SearchFileName = clang_getFileName(SearchFile);
5272 ResultFileName = clang_getFileName(ResultFile);
5273 KindSpelling = clang_getCursorKindSpelling(Result.kind);
5274 USR = clang_getCursorUSR(Result);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005275 *Log << llvm::format("(%s:%d:%d) = %s",
5276 clang_getCString(SearchFileName), SearchLine, SearchColumn,
5277 clang_getCString(KindSpelling))
5278 << llvm::format("(%s:%d:%d):%s%s",
5279 clang_getCString(ResultFileName), ResultLine, ResultColumn,
5280 clang_getCString(USR), IsDef);
Guy Benyei11169dd2012-12-18 14:30:41 +00005281 clang_disposeString(SearchFileName);
5282 clang_disposeString(ResultFileName);
5283 clang_disposeString(KindSpelling);
5284 clang_disposeString(USR);
5285
5286 CXCursor Definition = clang_getCursorDefinition(Result);
5287 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
5288 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
5289 CXString DefinitionKindSpelling
5290 = clang_getCursorKindSpelling(Definition.kind);
5291 CXFile DefinitionFile;
5292 unsigned DefinitionLine, DefinitionColumn;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005293 clang_getFileLocation(DefinitionLoc, &DefinitionFile,
Craig Topper69186e72014-06-08 08:38:04 +00005294 &DefinitionLine, &DefinitionColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005295 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005296 *Log << llvm::format(" -> %s(%s:%d:%d)",
5297 clang_getCString(DefinitionKindSpelling),
5298 clang_getCString(DefinitionFileName),
5299 DefinitionLine, DefinitionColumn);
Guy Benyei11169dd2012-12-18 14:30:41 +00005300 clang_disposeString(DefinitionFileName);
5301 clang_disposeString(DefinitionKindSpelling);
5302 }
5303 }
5304
5305 return Result;
5306}
5307
5308CXCursor clang_getNullCursor(void) {
5309 return MakeCXCursorInvalid(CXCursor_InvalidFile);
5310}
5311
5312unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005313 // Clear out the "FirstInDeclGroup" part in a declaration cursor, since we
5314 // can't set consistently. For example, when visiting a DeclStmt we will set
5315 // it but we don't set it on the result of clang_getCursorDefinition for
5316 // a reference of the same declaration.
5317 // FIXME: Setting "FirstInDeclGroup" in CXCursors is a hack that only works
5318 // when visiting a DeclStmt currently, the AST should be enhanced to be able
5319 // to provide that kind of info.
5320 if (clang_isDeclaration(X.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005321 X.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005322 if (clang_isDeclaration(Y.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005323 Y.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005324
Guy Benyei11169dd2012-12-18 14:30:41 +00005325 return X == Y;
5326}
5327
5328unsigned clang_hashCursor(CXCursor C) {
5329 unsigned Index = 0;
5330 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
5331 Index = 1;
5332
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005333 return llvm::DenseMapInfo<std::pair<unsigned, const void*> >::getHashValue(
Guy Benyei11169dd2012-12-18 14:30:41 +00005334 std::make_pair(C.kind, C.data[Index]));
5335}
5336
5337unsigned clang_isInvalid(enum CXCursorKind K) {
5338 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
5339}
5340
5341unsigned clang_isDeclaration(enum CXCursorKind K) {
5342 return (K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl) ||
5343 (K >= CXCursor_FirstExtraDecl && K <= CXCursor_LastExtraDecl);
5344}
5345
5346unsigned clang_isReference(enum CXCursorKind K) {
5347 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
5348}
5349
5350unsigned clang_isExpression(enum CXCursorKind K) {
5351 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
5352}
5353
5354unsigned clang_isStatement(enum CXCursorKind K) {
5355 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
5356}
5357
5358unsigned clang_isAttribute(enum CXCursorKind K) {
5359 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
5360}
5361
5362unsigned clang_isTranslationUnit(enum CXCursorKind K) {
5363 return K == CXCursor_TranslationUnit;
5364}
5365
5366unsigned clang_isPreprocessing(enum CXCursorKind K) {
5367 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
5368}
5369
5370unsigned clang_isUnexposed(enum CXCursorKind K) {
5371 switch (K) {
5372 case CXCursor_UnexposedDecl:
5373 case CXCursor_UnexposedExpr:
5374 case CXCursor_UnexposedStmt:
5375 case CXCursor_UnexposedAttr:
5376 return true;
5377 default:
5378 return false;
5379 }
5380}
5381
5382CXCursorKind clang_getCursorKind(CXCursor C) {
5383 return C.kind;
5384}
5385
5386CXSourceLocation clang_getCursorLocation(CXCursor C) {
5387 if (clang_isReference(C.kind)) {
5388 switch (C.kind) {
5389 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005390 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005391 = getCursorObjCSuperClassRef(C);
5392 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5393 }
5394
5395 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005396 std::pair<const ObjCProtocolDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005397 = getCursorObjCProtocolRef(C);
5398 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5399 }
5400
5401 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005402 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005403 = getCursorObjCClassRef(C);
5404 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5405 }
5406
5407 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005408 std::pair<const TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005409 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5410 }
5411
5412 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005413 std::pair<const TemplateDecl *, SourceLocation> P =
5414 getCursorTemplateRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005415 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5416 }
5417
5418 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005419 std::pair<const NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005420 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5421 }
5422
5423 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005424 std::pair<const FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005425 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5426 }
5427
5428 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005429 std::pair<const VarDecl *, SourceLocation> P = getCursorVariableRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005430 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5431 }
5432
5433 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005434 const CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005435 if (!BaseSpec)
5436 return clang_getNullLocation();
5437
5438 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
5439 return cxloc::translateSourceLocation(getCursorContext(C),
5440 TSInfo->getTypeLoc().getBeginLoc());
5441
5442 return cxloc::translateSourceLocation(getCursorContext(C),
5443 BaseSpec->getLocStart());
5444 }
5445
5446 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005447 std::pair<const LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005448 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
5449 }
5450
5451 case CXCursor_OverloadedDeclRef:
5452 return cxloc::translateSourceLocation(getCursorContext(C),
5453 getCursorOverloadedDeclRef(C).second);
5454
5455 default:
5456 // FIXME: Need a way to enumerate all non-reference cases.
5457 llvm_unreachable("Missed a reference kind");
5458 }
5459 }
5460
5461 if (clang_isExpression(C.kind))
5462 return cxloc::translateSourceLocation(getCursorContext(C),
5463 getLocationFromExpr(getCursorExpr(C)));
5464
5465 if (clang_isStatement(C.kind))
5466 return cxloc::translateSourceLocation(getCursorContext(C),
5467 getCursorStmt(C)->getLocStart());
5468
5469 if (C.kind == CXCursor_PreprocessingDirective) {
5470 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
5471 return cxloc::translateSourceLocation(getCursorContext(C), L);
5472 }
5473
5474 if (C.kind == CXCursor_MacroExpansion) {
5475 SourceLocation L
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005476 = cxcursor::getCursorMacroExpansion(C).getSourceRange().getBegin();
Guy Benyei11169dd2012-12-18 14:30:41 +00005477 return cxloc::translateSourceLocation(getCursorContext(C), L);
5478 }
5479
5480 if (C.kind == CXCursor_MacroDefinition) {
5481 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
5482 return cxloc::translateSourceLocation(getCursorContext(C), L);
5483 }
5484
5485 if (C.kind == CXCursor_InclusionDirective) {
5486 SourceLocation L
5487 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
5488 return cxloc::translateSourceLocation(getCursorContext(C), L);
5489 }
5490
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00005491 if (clang_isAttribute(C.kind)) {
5492 SourceLocation L
5493 = cxcursor::getCursorAttr(C)->getLocation();
5494 return cxloc::translateSourceLocation(getCursorContext(C), L);
5495 }
5496
Guy Benyei11169dd2012-12-18 14:30:41 +00005497 if (!clang_isDeclaration(C.kind))
5498 return clang_getNullLocation();
5499
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005500 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005501 if (!D)
5502 return clang_getNullLocation();
5503
5504 SourceLocation Loc = D->getLocation();
5505 // FIXME: Multiple variables declared in a single declaration
5506 // currently lack the information needed to correctly determine their
5507 // ranges when accounting for the type-specifier. We use context
5508 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5509 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005510 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005511 if (!cxcursor::isFirstInDeclGroup(C))
5512 Loc = VD->getLocation();
5513 }
5514
5515 // For ObjC methods, give the start location of the method name.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005516 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005517 Loc = MD->getSelectorStartLoc();
5518
5519 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
5520}
5521
NAKAMURA Takumia01f4c32016-12-19 16:50:43 +00005522} // end extern "C"
5523
Guy Benyei11169dd2012-12-18 14:30:41 +00005524CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
5525 assert(TU);
5526
5527 // Guard against an invalid SourceLocation, or we may assert in one
5528 // of the following calls.
5529 if (SLoc.isInvalid())
5530 return clang_getNullCursor();
5531
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005532 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005533
5534 // Translate the given source location to make it point at the beginning of
5535 // the token under the cursor.
5536 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
5537 CXXUnit->getASTContext().getLangOpts());
5538
5539 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
5540 if (SLoc.isValid()) {
5541 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
5542 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
5543 /*VisitPreprocessorLast=*/true,
5544 /*VisitIncludedEntities=*/false,
5545 SourceLocation(SLoc));
5546 CursorVis.visitFileRegion();
5547 }
5548
5549 return Result;
5550}
5551
5552static SourceRange getRawCursorExtent(CXCursor C) {
5553 if (clang_isReference(C.kind)) {
5554 switch (C.kind) {
5555 case CXCursor_ObjCSuperClassRef:
5556 return getCursorObjCSuperClassRef(C).second;
5557
5558 case CXCursor_ObjCProtocolRef:
5559 return getCursorObjCProtocolRef(C).second;
5560
5561 case CXCursor_ObjCClassRef:
5562 return getCursorObjCClassRef(C).second;
5563
5564 case CXCursor_TypeRef:
5565 return getCursorTypeRef(C).second;
5566
5567 case CXCursor_TemplateRef:
5568 return getCursorTemplateRef(C).second;
5569
5570 case CXCursor_NamespaceRef:
5571 return getCursorNamespaceRef(C).second;
5572
5573 case CXCursor_MemberRef:
5574 return getCursorMemberRef(C).second;
5575
5576 case CXCursor_CXXBaseSpecifier:
5577 return getCursorCXXBaseSpecifier(C)->getSourceRange();
5578
5579 case CXCursor_LabelRef:
5580 return getCursorLabelRef(C).second;
5581
5582 case CXCursor_OverloadedDeclRef:
5583 return getCursorOverloadedDeclRef(C).second;
5584
5585 case CXCursor_VariableRef:
5586 return getCursorVariableRef(C).second;
5587
5588 default:
5589 // FIXME: Need a way to enumerate all non-reference cases.
5590 llvm_unreachable("Missed a reference kind");
5591 }
5592 }
5593
5594 if (clang_isExpression(C.kind))
5595 return getCursorExpr(C)->getSourceRange();
5596
5597 if (clang_isStatement(C.kind))
5598 return getCursorStmt(C)->getSourceRange();
5599
5600 if (clang_isAttribute(C.kind))
5601 return getCursorAttr(C)->getRange();
5602
5603 if (C.kind == CXCursor_PreprocessingDirective)
5604 return cxcursor::getCursorPreprocessingDirective(C);
5605
5606 if (C.kind == CXCursor_MacroExpansion) {
5607 ASTUnit *TU = getCursorASTUnit(C);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005608 SourceRange Range = cxcursor::getCursorMacroExpansion(C).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00005609 return TU->mapRangeFromPreamble(Range);
5610 }
5611
5612 if (C.kind == CXCursor_MacroDefinition) {
5613 ASTUnit *TU = getCursorASTUnit(C);
5614 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
5615 return TU->mapRangeFromPreamble(Range);
5616 }
5617
5618 if (C.kind == CXCursor_InclusionDirective) {
5619 ASTUnit *TU = getCursorASTUnit(C);
5620 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
5621 return TU->mapRangeFromPreamble(Range);
5622 }
5623
5624 if (C.kind == CXCursor_TranslationUnit) {
5625 ASTUnit *TU = getCursorASTUnit(C);
5626 FileID MainID = TU->getSourceManager().getMainFileID();
5627 SourceLocation Start = TU->getSourceManager().getLocForStartOfFile(MainID);
5628 SourceLocation End = TU->getSourceManager().getLocForEndOfFile(MainID);
5629 return SourceRange(Start, End);
5630 }
5631
5632 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005633 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005634 if (!D)
5635 return SourceRange();
5636
5637 SourceRange R = D->getSourceRange();
5638 // FIXME: Multiple variables declared in a single declaration
5639 // currently lack the information needed to correctly determine their
5640 // ranges when accounting for the type-specifier. We use context
5641 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5642 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005643 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005644 if (!cxcursor::isFirstInDeclGroup(C))
5645 R.setBegin(VD->getLocation());
5646 }
5647 return R;
5648 }
5649 return SourceRange();
5650}
5651
5652/// \brief Retrieves the "raw" cursor extent, which is then extended to include
5653/// the decl-specifier-seq for declarations.
5654static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
5655 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005656 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005657 if (!D)
5658 return SourceRange();
5659
5660 SourceRange R = D->getSourceRange();
5661
5662 // Adjust the start of the location for declarations preceded by
5663 // declaration specifiers.
5664 SourceLocation StartLoc;
5665 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
5666 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
5667 StartLoc = TI->getTypeLoc().getLocStart();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005668 } else if (const TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005669 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
5670 StartLoc = TI->getTypeLoc().getLocStart();
5671 }
5672
5673 if (StartLoc.isValid() && R.getBegin().isValid() &&
5674 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
5675 R.setBegin(StartLoc);
5676
5677 // FIXME: Multiple variables declared in a single declaration
5678 // currently lack the information needed to correctly determine their
5679 // ranges when accounting for the type-specifier. We use context
5680 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5681 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005682 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005683 if (!cxcursor::isFirstInDeclGroup(C))
5684 R.setBegin(VD->getLocation());
5685 }
5686
5687 return R;
5688 }
5689
5690 return getRawCursorExtent(C);
5691}
5692
Guy Benyei11169dd2012-12-18 14:30:41 +00005693CXSourceRange clang_getCursorExtent(CXCursor C) {
5694 SourceRange R = getRawCursorExtent(C);
5695 if (R.isInvalid())
5696 return clang_getNullRange();
5697
5698 return cxloc::translateSourceRange(getCursorContext(C), R);
5699}
5700
5701CXCursor clang_getCursorReferenced(CXCursor C) {
5702 if (clang_isInvalid(C.kind))
5703 return clang_getNullCursor();
5704
5705 CXTranslationUnit tu = getCursorTU(C);
5706 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005707 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005708 if (!D)
5709 return clang_getNullCursor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005710 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005711 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005712 if (const ObjCPropertyImplDecl *PropImpl =
5713 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005714 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
5715 return MakeCXCursor(Property, tu);
5716
5717 return C;
5718 }
5719
5720 if (clang_isExpression(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005721 const Expr *E = getCursorExpr(C);
5722 const Decl *D = getDeclFromExpr(E);
Guy Benyei11169dd2012-12-18 14:30:41 +00005723 if (D) {
5724 CXCursor declCursor = MakeCXCursor(D, tu);
5725 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
5726 declCursor);
5727 return declCursor;
5728 }
5729
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005730 if (const OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00005731 return MakeCursorOverloadedDeclRef(Ovl, tu);
5732
5733 return clang_getNullCursor();
5734 }
5735
5736 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005737 const Stmt *S = getCursorStmt(C);
5738 if (const GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Guy Benyei11169dd2012-12-18 14:30:41 +00005739 if (LabelDecl *label = Goto->getLabel())
5740 if (LabelStmt *labelS = label->getStmt())
5741 return MakeCXCursor(labelS, getCursorDecl(C), tu);
5742
5743 return clang_getNullCursor();
5744 }
Richard Smith66a81862015-05-04 02:25:31 +00005745
Guy Benyei11169dd2012-12-18 14:30:41 +00005746 if (C.kind == CXCursor_MacroExpansion) {
Richard Smith66a81862015-05-04 02:25:31 +00005747 if (const MacroDefinitionRecord *Def =
5748 getCursorMacroExpansion(C).getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005749 return MakeMacroDefinitionCursor(Def, tu);
5750 }
5751
5752 if (!clang_isReference(C.kind))
5753 return clang_getNullCursor();
5754
5755 switch (C.kind) {
5756 case CXCursor_ObjCSuperClassRef:
5757 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
5758
5759 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005760 const ObjCProtocolDecl *Prot = getCursorObjCProtocolRef(C).first;
5761 if (const ObjCProtocolDecl *Def = Prot->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005762 return MakeCXCursor(Def, tu);
5763
5764 return MakeCXCursor(Prot, tu);
5765 }
5766
5767 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005768 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
5769 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005770 return MakeCXCursor(Def, tu);
5771
5772 return MakeCXCursor(Class, tu);
5773 }
5774
5775 case CXCursor_TypeRef:
5776 return MakeCXCursor(getCursorTypeRef(C).first, tu );
5777
5778 case CXCursor_TemplateRef:
5779 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
5780
5781 case CXCursor_NamespaceRef:
5782 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
5783
5784 case CXCursor_MemberRef:
5785 return MakeCXCursor(getCursorMemberRef(C).first, tu );
5786
5787 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005788 const CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005789 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
5790 tu ));
5791 }
5792
5793 case CXCursor_LabelRef:
5794 // FIXME: We end up faking the "parent" declaration here because we
5795 // don't want to make CXCursor larger.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005796 return MakeCXCursor(getCursorLabelRef(C).first,
5797 cxtu::getASTUnit(tu)->getASTContext()
5798 .getTranslationUnitDecl(),
Guy Benyei11169dd2012-12-18 14:30:41 +00005799 tu);
5800
5801 case CXCursor_OverloadedDeclRef:
5802 return C;
5803
5804 case CXCursor_VariableRef:
5805 return MakeCXCursor(getCursorVariableRef(C).first, tu);
5806
5807 default:
5808 // We would prefer to enumerate all non-reference cursor kinds here.
5809 llvm_unreachable("Unhandled reference cursor kind");
5810 }
5811}
5812
5813CXCursor clang_getCursorDefinition(CXCursor C) {
5814 if (clang_isInvalid(C.kind))
5815 return clang_getNullCursor();
5816
5817 CXTranslationUnit TU = getCursorTU(C);
5818
5819 bool WasReference = false;
5820 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
5821 C = clang_getCursorReferenced(C);
5822 WasReference = true;
5823 }
5824
5825 if (C.kind == CXCursor_MacroExpansion)
5826 return clang_getCursorReferenced(C);
5827
5828 if (!clang_isDeclaration(C.kind))
5829 return clang_getNullCursor();
5830
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005831 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005832 if (!D)
5833 return clang_getNullCursor();
5834
5835 switch (D->getKind()) {
5836 // Declaration kinds that don't really separate the notions of
5837 // declaration and definition.
5838 case Decl::Namespace:
5839 case Decl::Typedef:
5840 case Decl::TypeAlias:
5841 case Decl::TypeAliasTemplate:
5842 case Decl::TemplateTypeParm:
5843 case Decl::EnumConstant:
5844 case Decl::Field:
Richard Smithbdb84f32016-07-22 23:36:59 +00005845 case Decl::Binding:
John McCall5e77d762013-04-16 07:28:30 +00005846 case Decl::MSProperty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005847 case Decl::IndirectField:
5848 case Decl::ObjCIvar:
5849 case Decl::ObjCAtDefsField:
5850 case Decl::ImplicitParam:
5851 case Decl::ParmVar:
5852 case Decl::NonTypeTemplateParm:
5853 case Decl::TemplateTemplateParm:
5854 case Decl::ObjCCategoryImpl:
5855 case Decl::ObjCImplementation:
5856 case Decl::AccessSpec:
5857 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +00005858 case Decl::Export:
Guy Benyei11169dd2012-12-18 14:30:41 +00005859 case Decl::ObjCPropertyImpl:
5860 case Decl::FileScopeAsm:
5861 case Decl::StaticAssert:
5862 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +00005863 case Decl::Captured:
Alexey Bataev4244be22016-02-11 05:35:55 +00005864 case Decl::OMPCapturedExpr:
Guy Benyei11169dd2012-12-18 14:30:41 +00005865 case Decl::Label: // FIXME: Is this right??
5866 case Decl::ClassScopeFunctionSpecialization:
Richard Smithbc491202017-02-17 20:05:37 +00005867 case Decl::CXXDeductionGuide:
Guy Benyei11169dd2012-12-18 14:30:41 +00005868 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +00005869 case Decl::OMPThreadPrivate:
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00005870 case Decl::OMPDeclareReduction:
Douglas Gregor85f3f952015-07-07 03:57:15 +00005871 case Decl::ObjCTypeParam:
David Majnemerd9b1a4f2015-11-04 03:40:30 +00005872 case Decl::BuiltinTemplate:
Nico Weber66220292016-03-02 17:28:48 +00005873 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +00005874 case Decl::PragmaDetectMismatch:
Richard Smith151c4562016-12-20 21:35:28 +00005875 case Decl::UsingPack:
Guy Benyei11169dd2012-12-18 14:30:41 +00005876 return C;
5877
5878 // Declaration kinds that don't make any sense here, but are
5879 // nonetheless harmless.
David Blaikief005d3c2013-02-22 17:44:58 +00005880 case Decl::Empty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005881 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +00005882 case Decl::ExternCContext:
Guy Benyei11169dd2012-12-18 14:30:41 +00005883 break;
5884
5885 // Declaration kinds for which the definition is not resolvable.
5886 case Decl::UnresolvedUsingTypename:
5887 case Decl::UnresolvedUsingValue:
5888 break;
5889
5890 case Decl::UsingDirective:
5891 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
5892 TU);
5893
5894 case Decl::NamespaceAlias:
5895 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
5896
5897 case Decl::Enum:
5898 case Decl::Record:
5899 case Decl::CXXRecord:
5900 case Decl::ClassTemplateSpecialization:
5901 case Decl::ClassTemplatePartialSpecialization:
5902 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
5903 return MakeCXCursor(Def, TU);
5904 return clang_getNullCursor();
5905
5906 case Decl::Function:
5907 case Decl::CXXMethod:
5908 case Decl::CXXConstructor:
5909 case Decl::CXXDestructor:
5910 case Decl::CXXConversion: {
Craig Topper69186e72014-06-08 08:38:04 +00005911 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005912 if (cast<FunctionDecl>(D)->getBody(Def))
Dmitri Gribenko9c256e32013-01-14 00:46:27 +00005913 return MakeCXCursor(Def, TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005914 return clang_getNullCursor();
5915 }
5916
Larisse Voufo39a1e502013-08-06 01:03:05 +00005917 case Decl::Var:
5918 case Decl::VarTemplateSpecialization:
Richard Smithbdb84f32016-07-22 23:36:59 +00005919 case Decl::VarTemplatePartialSpecialization:
5920 case Decl::Decomposition: {
Guy Benyei11169dd2012-12-18 14:30:41 +00005921 // Ask the variable if it has a definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005922 if (const VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005923 return MakeCXCursor(Def, TU);
5924 return clang_getNullCursor();
5925 }
5926
5927 case Decl::FunctionTemplate: {
Craig Topper69186e72014-06-08 08:38:04 +00005928 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005929 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
5930 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
5931 return clang_getNullCursor();
5932 }
5933
5934 case Decl::ClassTemplate: {
5935 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
5936 ->getDefinition())
5937 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
5938 TU);
5939 return clang_getNullCursor();
5940 }
5941
Larisse Voufo39a1e502013-08-06 01:03:05 +00005942 case Decl::VarTemplate: {
5943 if (VarDecl *Def =
5944 cast<VarTemplateDecl>(D)->getTemplatedDecl()->getDefinition())
5945 return MakeCXCursor(cast<VarDecl>(Def)->getDescribedVarTemplate(), TU);
5946 return clang_getNullCursor();
5947 }
5948
Guy Benyei11169dd2012-12-18 14:30:41 +00005949 case Decl::Using:
5950 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
5951 D->getLocation(), TU);
5952
5953 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +00005954 case Decl::ConstructorUsingShadow:
Guy Benyei11169dd2012-12-18 14:30:41 +00005955 return clang_getCursorDefinition(
5956 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
5957 TU));
5958
5959 case Decl::ObjCMethod: {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005960 const ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005961 if (Method->isThisDeclarationADefinition())
5962 return C;
5963
5964 // Dig out the method definition in the associated
5965 // @implementation, if we have it.
5966 // FIXME: The ASTs should make finding the definition easier.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005967 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00005968 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
5969 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
5970 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
5971 Method->isInstanceMethod()))
5972 if (Def->isThisDeclarationADefinition())
5973 return MakeCXCursor(Def, TU);
5974
5975 return clang_getNullCursor();
5976 }
5977
5978 case Decl::ObjCCategory:
5979 if (ObjCCategoryImplDecl *Impl
5980 = cast<ObjCCategoryDecl>(D)->getImplementation())
5981 return MakeCXCursor(Impl, TU);
5982 return clang_getNullCursor();
5983
5984 case Decl::ObjCProtocol:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005985 if (const ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005986 return MakeCXCursor(Def, TU);
5987 return clang_getNullCursor();
5988
5989 case Decl::ObjCInterface: {
5990 // There are two notions of a "definition" for an Objective-C
5991 // class: the interface and its implementation. When we resolved a
5992 // reference to an Objective-C class, produce the @interface as
5993 // the definition; when we were provided with the interface,
5994 // produce the @implementation as the definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005995 const ObjCInterfaceDecl *IFace = cast<ObjCInterfaceDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005996 if (WasReference) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005997 if (const ObjCInterfaceDecl *Def = IFace->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005998 return MakeCXCursor(Def, TU);
5999 } else if (ObjCImplementationDecl *Impl = IFace->getImplementation())
6000 return MakeCXCursor(Impl, TU);
6001 return clang_getNullCursor();
6002 }
6003
6004 case Decl::ObjCProperty:
6005 // FIXME: We don't really know where to find the
6006 // ObjCPropertyImplDecls that implement this property.
6007 return clang_getNullCursor();
6008
6009 case Decl::ObjCCompatibleAlias:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006010 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00006011 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006012 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006013 return MakeCXCursor(Def, TU);
6014
6015 return clang_getNullCursor();
6016
6017 case Decl::Friend:
6018 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
6019 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
6020 return clang_getNullCursor();
6021
6022 case Decl::FriendTemplate:
6023 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
6024 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
6025 return clang_getNullCursor();
6026 }
6027
6028 return clang_getNullCursor();
6029}
6030
6031unsigned clang_isCursorDefinition(CXCursor C) {
6032 if (!clang_isDeclaration(C.kind))
6033 return 0;
6034
6035 return clang_getCursorDefinition(C) == C;
6036}
6037
6038CXCursor clang_getCanonicalCursor(CXCursor C) {
6039 if (!clang_isDeclaration(C.kind))
6040 return C;
6041
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006042 if (const Decl *D = getCursorDecl(C)) {
6043 if (const ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006044 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
6045 return MakeCXCursor(CatD, getCursorTU(C));
6046
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006047 if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
6048 if (const ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
Guy Benyei11169dd2012-12-18 14:30:41 +00006049 return MakeCXCursor(IFD, getCursorTU(C));
6050
6051 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
6052 }
6053
6054 return C;
6055}
6056
6057int clang_Cursor_getObjCSelectorIndex(CXCursor cursor) {
6058 return cxcursor::getSelectorIdentifierIndexAndLoc(cursor).first;
6059}
6060
6061unsigned clang_getNumOverloadedDecls(CXCursor C) {
6062 if (C.kind != CXCursor_OverloadedDeclRef)
6063 return 0;
6064
6065 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006066 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00006067 return E->getNumDecls();
6068
6069 if (OverloadedTemplateStorage *S
6070 = Storage.dyn_cast<OverloadedTemplateStorage*>())
6071 return S->size();
6072
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006073 const Decl *D = Storage.get<const Decl *>();
6074 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006075 return Using->shadow_size();
6076
6077 return 0;
6078}
6079
6080CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
6081 if (cursor.kind != CXCursor_OverloadedDeclRef)
6082 return clang_getNullCursor();
6083
6084 if (index >= clang_getNumOverloadedDecls(cursor))
6085 return clang_getNullCursor();
6086
6087 CXTranslationUnit TU = getCursorTU(cursor);
6088 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006089 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00006090 return MakeCXCursor(E->decls_begin()[index], TU);
6091
6092 if (OverloadedTemplateStorage *S
6093 = Storage.dyn_cast<OverloadedTemplateStorage*>())
6094 return MakeCXCursor(S->begin()[index], TU);
6095
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006096 const Decl *D = Storage.get<const Decl *>();
6097 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006098 // FIXME: This is, unfortunately, linear time.
6099 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
6100 std::advance(Pos, index);
6101 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
6102 }
6103
6104 return clang_getNullCursor();
6105}
6106
6107void clang_getDefinitionSpellingAndExtent(CXCursor C,
6108 const char **startBuf,
6109 const char **endBuf,
6110 unsigned *startLine,
6111 unsigned *startColumn,
6112 unsigned *endLine,
6113 unsigned *endColumn) {
6114 assert(getCursorDecl(C) && "CXCursor has null decl");
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006115 const FunctionDecl *FD = dyn_cast<FunctionDecl>(getCursorDecl(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00006116 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
6117
6118 SourceManager &SM = FD->getASTContext().getSourceManager();
6119 *startBuf = SM.getCharacterData(Body->getLBracLoc());
6120 *endBuf = SM.getCharacterData(Body->getRBracLoc());
6121 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
6122 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
6123 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
6124 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
6125}
6126
6127
6128CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
6129 unsigned PieceIndex) {
6130 RefNamePieces Pieces;
6131
6132 switch (C.kind) {
6133 case CXCursor_MemberRefExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006134 if (const MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00006135 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
6136 E->getQualifierLoc().getSourceRange());
6137 break;
6138
6139 case CXCursor_DeclRefExpr:
James Y Knight04ec5bf2015-12-24 02:59:37 +00006140 if (const DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C))) {
6141 SourceRange TemplateArgLoc(E->getLAngleLoc(), E->getRAngleLoc());
6142 Pieces =
6143 buildPieces(NameFlags, false, E->getNameInfo(),
6144 E->getQualifierLoc().getSourceRange(), &TemplateArgLoc);
6145 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006146 break;
6147
6148 case CXCursor_CallExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006149 if (const CXXOperatorCallExpr *OCE =
Guy Benyei11169dd2012-12-18 14:30:41 +00006150 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006151 const Expr *Callee = OCE->getCallee();
6152 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00006153 Callee = ICE->getSubExpr();
6154
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006155 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00006156 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
6157 DRE->getQualifierLoc().getSourceRange());
6158 }
6159 break;
6160
6161 default:
6162 break;
6163 }
6164
6165 if (Pieces.empty()) {
6166 if (PieceIndex == 0)
6167 return clang_getCursorExtent(C);
6168 } else if (PieceIndex < Pieces.size()) {
6169 SourceRange R = Pieces[PieceIndex];
6170 if (R.isValid())
6171 return cxloc::translateSourceRange(getCursorContext(C), R);
6172 }
6173
6174 return clang_getNullRange();
6175}
6176
6177void clang_enableStackTraces(void) {
Richard Smithdfed58a2016-06-09 00:53:41 +00006178 // FIXME: Provide an argv0 here so we can find llvm-symbolizer.
6179 llvm::sys::PrintStackTraceOnErrorSignal(StringRef());
Guy Benyei11169dd2012-12-18 14:30:41 +00006180}
6181
6182void clang_executeOnThread(void (*fn)(void*), void *user_data,
6183 unsigned stack_size) {
6184 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
6185}
6186
Guy Benyei11169dd2012-12-18 14:30:41 +00006187//===----------------------------------------------------------------------===//
6188// Token-based Operations.
6189//===----------------------------------------------------------------------===//
6190
6191/* CXToken layout:
6192 * int_data[0]: a CXTokenKind
6193 * int_data[1]: starting token location
6194 * int_data[2]: token length
6195 * int_data[3]: reserved
6196 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
6197 * otherwise unused.
6198 */
Guy Benyei11169dd2012-12-18 14:30:41 +00006199CXTokenKind clang_getTokenKind(CXToken CXTok) {
6200 return static_cast<CXTokenKind>(CXTok.int_data[0]);
6201}
6202
6203CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
6204 switch (clang_getTokenKind(CXTok)) {
6205 case CXToken_Identifier:
6206 case CXToken_Keyword:
6207 // We know we have an IdentifierInfo*, so use that.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00006208 return cxstring::createRef(static_cast<IdentifierInfo *>(CXTok.ptr_data)
Guy Benyei11169dd2012-12-18 14:30:41 +00006209 ->getNameStart());
6210
6211 case CXToken_Literal: {
6212 // We have stashed the starting pointer in the ptr_data field. Use it.
6213 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00006214 return cxstring::createDup(StringRef(Text, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006215 }
6216
6217 case CXToken_Punctuation:
6218 case CXToken_Comment:
6219 break;
6220 }
6221
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006222 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006223 LOG_BAD_TU(TU);
6224 return cxstring::createEmpty();
6225 }
6226
Guy Benyei11169dd2012-12-18 14:30:41 +00006227 // We have to find the starting buffer pointer the hard way, by
6228 // deconstructing the source location.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006229 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006230 if (!CXXUnit)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00006231 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006232
6233 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
6234 std::pair<FileID, unsigned> LocInfo
6235 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
6236 bool Invalid = false;
6237 StringRef Buffer
6238 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
6239 if (Invalid)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00006240 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006241
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00006242 return cxstring::createDup(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006243}
6244
6245CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006246 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006247 LOG_BAD_TU(TU);
6248 return clang_getNullLocation();
6249 }
6250
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006251 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006252 if (!CXXUnit)
6253 return clang_getNullLocation();
6254
6255 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
6256 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6257}
6258
6259CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006260 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006261 LOG_BAD_TU(TU);
6262 return clang_getNullRange();
6263 }
6264
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006265 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006266 if (!CXXUnit)
6267 return clang_getNullRange();
6268
6269 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
6270 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6271}
6272
6273static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
6274 SmallVectorImpl<CXToken> &CXTokens) {
6275 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6276 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006277 = SourceMgr.getDecomposedSpellingLoc(Range.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006278 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006279 = SourceMgr.getDecomposedSpellingLoc(Range.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006280
6281 // Cannot tokenize across files.
6282 if (BeginLocInfo.first != EndLocInfo.first)
6283 return;
6284
6285 // Create a lexer
6286 bool Invalid = false;
6287 StringRef Buffer
6288 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6289 if (Invalid)
6290 return;
6291
6292 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6293 CXXUnit->getASTContext().getLangOpts(),
6294 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
6295 Lex.SetCommentRetentionState(true);
6296
6297 // Lex tokens until we hit the end of the range.
6298 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
6299 Token Tok;
6300 bool previousWasAt = false;
6301 do {
6302 // Lex the next token
6303 Lex.LexFromRawLexer(Tok);
6304 if (Tok.is(tok::eof))
6305 break;
6306
6307 // Initialize the CXToken.
6308 CXToken CXTok;
6309
6310 // - Common fields
6311 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
6312 CXTok.int_data[2] = Tok.getLength();
6313 CXTok.int_data[3] = 0;
6314
6315 // - Kind-specific fields
6316 if (Tok.isLiteral()) {
6317 CXTok.int_data[0] = CXToken_Literal;
Dmitri Gribenkof9304482013-01-23 15:56:07 +00006318 CXTok.ptr_data = const_cast<char *>(Tok.getLiteralData());
Guy Benyei11169dd2012-12-18 14:30:41 +00006319 } else if (Tok.is(tok::raw_identifier)) {
6320 // Lookup the identifier to determine whether we have a keyword.
6321 IdentifierInfo *II
6322 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
6323
6324 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
6325 CXTok.int_data[0] = CXToken_Keyword;
6326 }
6327 else {
6328 CXTok.int_data[0] = Tok.is(tok::identifier)
6329 ? CXToken_Identifier
6330 : CXToken_Keyword;
6331 }
6332 CXTok.ptr_data = II;
6333 } else if (Tok.is(tok::comment)) {
6334 CXTok.int_data[0] = CXToken_Comment;
Craig Topper69186e72014-06-08 08:38:04 +00006335 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006336 } else {
6337 CXTok.int_data[0] = CXToken_Punctuation;
Craig Topper69186e72014-06-08 08:38:04 +00006338 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006339 }
6340 CXTokens.push_back(CXTok);
6341 previousWasAt = Tok.is(tok::at);
Argyrios Kyrtzidisc7c6a072016-11-09 23:58:39 +00006342 } while (Lex.getBufferLocation() < EffectiveBufferEnd);
Guy Benyei11169dd2012-12-18 14:30:41 +00006343}
6344
6345void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
6346 CXToken **Tokens, unsigned *NumTokens) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006347 LOG_FUNC_SECTION {
6348 *Log << TU << ' ' << Range;
6349 }
6350
Guy Benyei11169dd2012-12-18 14:30:41 +00006351 if (Tokens)
Craig Topper69186e72014-06-08 08:38:04 +00006352 *Tokens = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006353 if (NumTokens)
6354 *NumTokens = 0;
6355
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006356 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006357 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006358 return;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006359 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006360
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006361 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006362 if (!CXXUnit || !Tokens || !NumTokens)
6363 return;
6364
6365 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6366
6367 SourceRange R = cxloc::translateCXSourceRange(Range);
6368 if (R.isInvalid())
6369 return;
6370
6371 SmallVector<CXToken, 32> CXTokens;
6372 getTokens(CXXUnit, R, CXTokens);
6373
6374 if (CXTokens.empty())
6375 return;
6376
6377 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
6378 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
6379 *NumTokens = CXTokens.size();
6380}
6381
6382void clang_disposeTokens(CXTranslationUnit TU,
6383 CXToken *Tokens, unsigned NumTokens) {
6384 free(Tokens);
6385}
6386
Guy Benyei11169dd2012-12-18 14:30:41 +00006387//===----------------------------------------------------------------------===//
6388// Token annotation APIs.
6389//===----------------------------------------------------------------------===//
6390
Guy Benyei11169dd2012-12-18 14:30:41 +00006391static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6392 CXCursor parent,
6393 CXClientData client_data);
6394static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6395 CXClientData client_data);
6396
6397namespace {
6398class AnnotateTokensWorker {
Guy Benyei11169dd2012-12-18 14:30:41 +00006399 CXToken *Tokens;
6400 CXCursor *Cursors;
6401 unsigned NumTokens;
6402 unsigned TokIdx;
6403 unsigned PreprocessingTokIdx;
6404 CursorVisitor AnnotateVis;
6405 SourceManager &SrcMgr;
6406 bool HasContextSensitiveKeywords;
6407
6408 struct PostChildrenInfo {
6409 CXCursor Cursor;
6410 SourceRange CursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006411 unsigned BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006412 unsigned BeforeChildrenTokenIdx;
6413 };
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006414 SmallVector<PostChildrenInfo, 8> PostChildrenInfos;
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006415
6416 CXToken &getTok(unsigned Idx) {
6417 assert(Idx < NumTokens);
6418 return Tokens[Idx];
6419 }
6420 const CXToken &getTok(unsigned Idx) const {
6421 assert(Idx < NumTokens);
6422 return Tokens[Idx];
6423 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006424 bool MoreTokens() const { return TokIdx < NumTokens; }
6425 unsigned NextToken() const { return TokIdx; }
6426 void AdvanceToken() { ++TokIdx; }
6427 SourceLocation GetTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006428 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006429 }
6430 bool isFunctionMacroToken(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006431 return getTok(tokI).int_data[3] != 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006432 }
6433 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006434 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[3]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006435 }
6436
6437 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006438 bool annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
Guy Benyei11169dd2012-12-18 14:30:41 +00006439 SourceRange);
6440
6441public:
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006442 AnnotateTokensWorker(CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006443 CXTranslationUnit TU, SourceRange RegionOfInterest)
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006444 : Tokens(tokens), Cursors(cursors),
Guy Benyei11169dd2012-12-18 14:30:41 +00006445 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006446 AnnotateVis(TU,
Guy Benyei11169dd2012-12-18 14:30:41 +00006447 AnnotateTokensVisitor, this,
6448 /*VisitPreprocessorLast=*/true,
6449 /*VisitIncludedEntities=*/false,
6450 RegionOfInterest,
6451 /*VisitDeclsOnly=*/false,
6452 AnnotateTokensPostChildrenVisitor),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006453 SrcMgr(cxtu::getASTUnit(TU)->getSourceManager()),
Guy Benyei11169dd2012-12-18 14:30:41 +00006454 HasContextSensitiveKeywords(false) { }
6455
6456 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
6457 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
6458 bool postVisitChildren(CXCursor cursor);
6459 void AnnotateTokens();
6460
6461 /// \brief Determine whether the annotator saw any cursors that have
6462 /// context-sensitive keywords.
6463 bool hasContextSensitiveKeywords() const {
6464 return HasContextSensitiveKeywords;
6465 }
6466
6467 ~AnnotateTokensWorker() {
6468 assert(PostChildrenInfos.empty());
6469 }
6470};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00006471}
Guy Benyei11169dd2012-12-18 14:30:41 +00006472
6473void AnnotateTokensWorker::AnnotateTokens() {
6474 // Walk the AST within the region of interest, annotating tokens
6475 // along the way.
6476 AnnotateVis.visitFileRegion();
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006477}
Guy Benyei11169dd2012-12-18 14:30:41 +00006478
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006479static inline void updateCursorAnnotation(CXCursor &Cursor,
6480 const CXCursor &updateC) {
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006481 if (clang_isInvalid(updateC.kind) || !clang_isInvalid(Cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006482 return;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006483 Cursor = updateC;
Guy Benyei11169dd2012-12-18 14:30:41 +00006484}
6485
6486/// \brief It annotates and advances tokens with a cursor until the comparison
6487//// between the cursor location and the source range is the same as
6488/// \arg compResult.
6489///
6490/// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
6491/// Pass RangeOverlap to annotate tokens inside a range.
6492void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
6493 RangeComparisonResult compResult,
6494 SourceRange range) {
6495 while (MoreTokens()) {
6496 const unsigned I = NextToken();
6497 if (isFunctionMacroToken(I))
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006498 if (!annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range))
6499 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00006500
6501 SourceLocation TokLoc = GetTokenLoc(I);
6502 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006503 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006504 AdvanceToken();
6505 continue;
6506 }
6507 break;
6508 }
6509}
6510
6511/// \brief Special annotation handling for macro argument tokens.
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006512/// \returns true if it advanced beyond all macro tokens, false otherwise.
6513bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
Guy Benyei11169dd2012-12-18 14:30:41 +00006514 CXCursor updateC,
6515 RangeComparisonResult compResult,
6516 SourceRange range) {
6517 assert(MoreTokens());
6518 assert(isFunctionMacroToken(NextToken()) &&
6519 "Should be called only for macro arg tokens");
6520
6521 // This works differently than annotateAndAdvanceTokens; because expanded
6522 // macro arguments can have arbitrary translation-unit source order, we do not
6523 // advance the token index one by one until a token fails the range test.
6524 // We only advance once past all of the macro arg tokens if all of them
6525 // pass the range test. If one of them fails we keep the token index pointing
6526 // at the start of the macro arg tokens so that the failing token will be
6527 // annotated by a subsequent annotation try.
6528
6529 bool atLeastOneCompFail = false;
6530
6531 unsigned I = NextToken();
6532 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
6533 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
6534 if (TokLoc.isFileID())
6535 continue; // not macro arg token, it's parens or comma.
6536 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6537 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
6538 Cursors[I] = updateC;
6539 } else
6540 atLeastOneCompFail = true;
6541 }
6542
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006543 if (atLeastOneCompFail)
6544 return false;
6545
6546 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
6547 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00006548}
6549
6550enum CXChildVisitResult
6551AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006552 SourceRange cursorRange = getRawCursorExtent(cursor);
6553 if (cursorRange.isInvalid())
6554 return CXChildVisit_Recurse;
6555
6556 if (!HasContextSensitiveKeywords) {
6557 // Objective-C properties can have context-sensitive keywords.
6558 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006559 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006560 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
6561 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
6562 }
6563 // Objective-C methods can have context-sensitive keywords.
6564 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
6565 cursor.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006566 if (const ObjCMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006567 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
6568 if (Method->getObjCDeclQualifier())
6569 HasContextSensitiveKeywords = true;
6570 else {
David Majnemer59f77922016-06-24 04:05:48 +00006571 for (const auto *P : Method->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00006572 if (P->getObjCDeclQualifier()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006573 HasContextSensitiveKeywords = true;
6574 break;
6575 }
6576 }
6577 }
6578 }
6579 }
6580 // C++ methods can have context-sensitive keywords.
6581 else if (cursor.kind == CXCursor_CXXMethod) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006582 if (const CXXMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006583 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
6584 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
6585 HasContextSensitiveKeywords = true;
6586 }
6587 }
6588 // C++ classes can have context-sensitive keywords.
6589 else if (cursor.kind == CXCursor_StructDecl ||
6590 cursor.kind == CXCursor_ClassDecl ||
6591 cursor.kind == CXCursor_ClassTemplate ||
6592 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006593 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00006594 if (D->hasAttr<FinalAttr>())
6595 HasContextSensitiveKeywords = true;
6596 }
6597 }
Argyrios Kyrtzidis990b3862013-06-04 18:24:30 +00006598
6599 // Don't override a property annotation with its getter/setter method.
6600 if (cursor.kind == CXCursor_ObjCInstanceMethodDecl &&
6601 parent.kind == CXCursor_ObjCPropertyDecl)
6602 return CXChildVisit_Continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00006603
6604 if (clang_isPreprocessing(cursor.kind)) {
6605 // Items in the preprocessing record are kept separate from items in
6606 // declarations, so we keep a separate token index.
6607 unsigned SavedTokIdx = TokIdx;
6608 TokIdx = PreprocessingTokIdx;
6609
6610 // Skip tokens up until we catch up to the beginning of the preprocessing
6611 // entry.
6612 while (MoreTokens()) {
6613 const unsigned I = NextToken();
6614 SourceLocation TokLoc = GetTokenLoc(I);
6615 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6616 case RangeBefore:
6617 AdvanceToken();
6618 continue;
6619 case RangeAfter:
6620 case RangeOverlap:
6621 break;
6622 }
6623 break;
6624 }
6625
6626 // Look at all of the tokens within this range.
6627 while (MoreTokens()) {
6628 const unsigned I = NextToken();
6629 SourceLocation TokLoc = GetTokenLoc(I);
6630 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6631 case RangeBefore:
6632 llvm_unreachable("Infeasible");
6633 case RangeAfter:
6634 break;
6635 case RangeOverlap:
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006636 // For macro expansions, just note where the beginning of the macro
6637 // expansion occurs.
6638 if (cursor.kind == CXCursor_MacroExpansion) {
6639 if (TokLoc == cursorRange.getBegin())
6640 Cursors[I] = cursor;
6641 AdvanceToken();
6642 break;
6643 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006644 // We may have already annotated macro names inside macro definitions.
6645 if (Cursors[I].kind != CXCursor_MacroExpansion)
6646 Cursors[I] = cursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00006647 AdvanceToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006648 continue;
6649 }
6650 break;
6651 }
6652
6653 // Save the preprocessing token index; restore the non-preprocessing
6654 // token index.
6655 PreprocessingTokIdx = TokIdx;
6656 TokIdx = SavedTokIdx;
6657 return CXChildVisit_Recurse;
6658 }
6659
6660 if (cursorRange.isInvalid())
6661 return CXChildVisit_Continue;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006662
6663 unsigned BeforeReachingCursorIdx = NextToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006664 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006665 const enum CXCursorKind K = clang_getCursorKind(parent);
6666 const CXCursor updateC =
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006667 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
6668 // Attributes are annotated out-of-order, skip tokens until we reach it.
6669 clang_isAttribute(cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006670 ? clang_getNullCursor() : parent;
6671
6672 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
6673
6674 // Avoid having the cursor of an expression "overwrite" the annotation of the
6675 // variable declaration that it belongs to.
6676 // This can happen for C++ constructor expressions whose range generally
6677 // include the variable declaration, e.g.:
6678 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006679 if (clang_isExpression(cursorK) && MoreTokens()) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006680 const Expr *E = getCursorExpr(cursor);
Dmitri Gribenkoa1691182013-01-26 18:12:08 +00006681 if (const Decl *D = getCursorParentDecl(cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006682 const unsigned I = NextToken();
6683 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
6684 E->getLocStart() == D->getLocation() &&
6685 E->getLocStart() == GetTokenLoc(I)) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006686 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006687 AdvanceToken();
6688 }
6689 }
6690 }
6691
6692 // Before recursing into the children keep some state that we are going
6693 // to use in the AnnotateTokensWorker::postVisitChildren callback to do some
6694 // extra work after the child nodes are visited.
6695 // Note that we don't call VisitChildren here to avoid traversing statements
6696 // code-recursively which can blow the stack.
6697
6698 PostChildrenInfo Info;
6699 Info.Cursor = cursor;
6700 Info.CursorRange = cursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006701 Info.BeforeReachingCursorIdx = BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006702 Info.BeforeChildrenTokenIdx = NextToken();
6703 PostChildrenInfos.push_back(Info);
6704
6705 return CXChildVisit_Recurse;
6706}
6707
6708bool AnnotateTokensWorker::postVisitChildren(CXCursor cursor) {
6709 if (PostChildrenInfos.empty())
6710 return false;
6711 const PostChildrenInfo &Info = PostChildrenInfos.back();
6712 if (!clang_equalCursors(Info.Cursor, cursor))
6713 return false;
6714
6715 const unsigned BeforeChildren = Info.BeforeChildrenTokenIdx;
6716 const unsigned AfterChildren = NextToken();
6717 SourceRange cursorRange = Info.CursorRange;
6718
6719 // Scan the tokens that are at the end of the cursor, but are not captured
6720 // but the child cursors.
6721 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
6722
6723 // Scan the tokens that are at the beginning of the cursor, but are not
6724 // capture by the child cursors.
6725 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
6726 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
6727 break;
6728
6729 Cursors[I] = cursor;
6730 }
6731
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006732 // Attributes are annotated out-of-order, rewind TokIdx to when we first
6733 // encountered the attribute cursor.
6734 if (clang_isAttribute(cursor.kind))
6735 TokIdx = Info.BeforeReachingCursorIdx;
6736
Guy Benyei11169dd2012-12-18 14:30:41 +00006737 PostChildrenInfos.pop_back();
6738 return false;
6739}
6740
6741static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6742 CXCursor parent,
6743 CXClientData client_data) {
6744 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
6745}
6746
6747static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6748 CXClientData client_data) {
6749 return static_cast<AnnotateTokensWorker*>(client_data)->
6750 postVisitChildren(cursor);
6751}
6752
6753namespace {
6754
6755/// \brief Uses the macro expansions in the preprocessing record to find
6756/// and mark tokens that are macro arguments. This info is used by the
6757/// AnnotateTokensWorker.
6758class MarkMacroArgTokensVisitor {
6759 SourceManager &SM;
6760 CXToken *Tokens;
6761 unsigned NumTokens;
6762 unsigned CurIdx;
6763
6764public:
6765 MarkMacroArgTokensVisitor(SourceManager &SM,
6766 CXToken *tokens, unsigned numTokens)
6767 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
6768
6769 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
6770 if (cursor.kind != CXCursor_MacroExpansion)
6771 return CXChildVisit_Continue;
6772
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00006773 SourceRange macroRange = getCursorMacroExpansion(cursor).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00006774 if (macroRange.getBegin() == macroRange.getEnd())
6775 return CXChildVisit_Continue; // it's not a function macro.
6776
6777 for (; CurIdx < NumTokens; ++CurIdx) {
6778 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
6779 macroRange.getBegin()))
6780 break;
6781 }
6782
6783 if (CurIdx == NumTokens)
6784 return CXChildVisit_Break;
6785
6786 for (; CurIdx < NumTokens; ++CurIdx) {
6787 SourceLocation tokLoc = getTokenLoc(CurIdx);
6788 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
6789 break;
6790
6791 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
6792 }
6793
6794 if (CurIdx == NumTokens)
6795 return CXChildVisit_Break;
6796
6797 return CXChildVisit_Continue;
6798 }
6799
6800private:
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006801 CXToken &getTok(unsigned Idx) {
6802 assert(Idx < NumTokens);
6803 return Tokens[Idx];
6804 }
6805 const CXToken &getTok(unsigned Idx) const {
6806 assert(Idx < NumTokens);
6807 return Tokens[Idx];
6808 }
6809
Guy Benyei11169dd2012-12-18 14:30:41 +00006810 SourceLocation getTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006811 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006812 }
6813
6814 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
6815 // The third field is reserved and currently not used. Use it here
6816 // to mark macro arg expanded tokens with their expanded locations.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006817 getTok(tokI).int_data[3] = loc.getRawEncoding();
Guy Benyei11169dd2012-12-18 14:30:41 +00006818 }
6819};
6820
6821} // end anonymous namespace
6822
6823static CXChildVisitResult
6824MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
6825 CXClientData client_data) {
6826 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
6827 parent);
6828}
6829
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006830/// \brief Used by \c annotatePreprocessorTokens.
6831/// \returns true if lexing was finished, false otherwise.
6832static bool lexNext(Lexer &Lex, Token &Tok,
6833 unsigned &NextIdx, unsigned NumTokens) {
6834 if (NextIdx >= NumTokens)
6835 return true;
6836
6837 ++NextIdx;
6838 Lex.LexFromRawLexer(Tok);
Alexander Kornienko1a9f1842015-12-28 15:24:08 +00006839 return Tok.is(tok::eof);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006840}
6841
Guy Benyei11169dd2012-12-18 14:30:41 +00006842static void annotatePreprocessorTokens(CXTranslationUnit TU,
6843 SourceRange RegionOfInterest,
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006844 CXCursor *Cursors,
6845 CXToken *Tokens,
6846 unsigned NumTokens) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006847 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006848
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006849 Preprocessor &PP = CXXUnit->getPreprocessor();
Guy Benyei11169dd2012-12-18 14:30:41 +00006850 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6851 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006852 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006853 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006854 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006855
6856 if (BeginLocInfo.first != EndLocInfo.first)
6857 return;
6858
6859 StringRef Buffer;
6860 bool Invalid = false;
6861 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6862 if (Buffer.empty() || Invalid)
6863 return;
6864
6865 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6866 CXXUnit->getASTContext().getLangOpts(),
6867 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
6868 Buffer.end());
6869 Lex.SetCommentRetentionState(true);
6870
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006871 unsigned NextIdx = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006872 // Lex tokens in raw mode until we hit the end of the range, to avoid
6873 // entering #includes or expanding macros.
6874 while (true) {
6875 Token Tok;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006876 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6877 break;
6878 unsigned TokIdx = NextIdx-1;
6879 assert(Tok.getLocation() ==
6880 SourceLocation::getFromRawEncoding(Tokens[TokIdx].int_data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006881
6882 reprocess:
6883 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006884 // We have found a preprocessing directive. Annotate the tokens
6885 // appropriately.
Guy Benyei11169dd2012-12-18 14:30:41 +00006886 //
6887 // FIXME: Some simple tests here could identify macro definitions and
6888 // #undefs, to provide specific cursor kinds for those.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006889
6890 SourceLocation BeginLoc = Tok.getLocation();
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006891 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6892 break;
6893
Craig Topper69186e72014-06-08 08:38:04 +00006894 MacroInfo *MI = nullptr;
Alp Toker2d57cea2014-05-17 04:53:25 +00006895 if (Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "define") {
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006896 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6897 break;
6898
6899 if (Tok.is(tok::raw_identifier)) {
Alp Toker2d57cea2014-05-17 04:53:25 +00006900 IdentifierInfo &II =
6901 PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006902 SourceLocation MappedTokLoc =
6903 CXXUnit->mapLocationToPreamble(Tok.getLocation());
6904 MI = getMacroInfo(II, MappedTokLoc, TU);
6905 }
6906 }
6907
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006908 bool finished = false;
Guy Benyei11169dd2012-12-18 14:30:41 +00006909 do {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006910 if (lexNext(Lex, Tok, NextIdx, NumTokens)) {
6911 finished = true;
6912 break;
6913 }
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006914 // If we are in a macro definition, check if the token was ever a
6915 // macro name and annotate it if that's the case.
6916 if (MI) {
6917 SourceLocation SaveLoc = Tok.getLocation();
6918 Tok.setLocation(CXXUnit->mapLocationToPreamble(SaveLoc));
Richard Smith66a81862015-05-04 02:25:31 +00006919 MacroDefinitionRecord *MacroDef =
6920 checkForMacroInMacroDefinition(MI, Tok, TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006921 Tok.setLocation(SaveLoc);
6922 if (MacroDef)
Richard Smith66a81862015-05-04 02:25:31 +00006923 Cursors[NextIdx - 1] =
6924 MakeMacroExpansionCursor(MacroDef, Tok.getLocation(), TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006925 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006926 } while (!Tok.isAtStartOfLine());
6927
6928 unsigned LastIdx = finished ? NextIdx-1 : NextIdx-2;
6929 assert(TokIdx <= LastIdx);
6930 SourceLocation EndLoc =
6931 SourceLocation::getFromRawEncoding(Tokens[LastIdx].int_data[1]);
6932 CXCursor Cursor =
6933 MakePreprocessingDirectiveCursor(SourceRange(BeginLoc, EndLoc), TU);
6934
6935 for (; TokIdx <= LastIdx; ++TokIdx)
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006936 updateCursorAnnotation(Cursors[TokIdx], Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006937
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006938 if (finished)
6939 break;
6940 goto reprocess;
Guy Benyei11169dd2012-12-18 14:30:41 +00006941 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006942 }
6943}
6944
6945// This gets run a separate thread to avoid stack blowout.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006946static void clang_annotateTokensImpl(CXTranslationUnit TU, ASTUnit *CXXUnit,
6947 CXToken *Tokens, unsigned NumTokens,
6948 CXCursor *Cursors) {
Dmitri Gribenko183436e2013-01-26 21:49:50 +00006949 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006950 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
6951 setThreadBackgroundPriority();
6952
6953 // Determine the region of interest, which contains all of the tokens.
6954 SourceRange RegionOfInterest;
6955 RegionOfInterest.setBegin(
6956 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
6957 RegionOfInterest.setEnd(
6958 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
6959 Tokens[NumTokens-1])));
6960
Guy Benyei11169dd2012-12-18 14:30:41 +00006961 // Relex the tokens within the source range to look for preprocessing
6962 // directives.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006963 annotatePreprocessorTokens(TU, RegionOfInterest, Cursors, Tokens, NumTokens);
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006964
6965 // If begin location points inside a macro argument, set it to the expansion
6966 // location so we can have the full context when annotating semantically.
6967 {
6968 SourceManager &SM = CXXUnit->getSourceManager();
6969 SourceLocation Loc =
6970 SM.getMacroArgExpandedLocation(RegionOfInterest.getBegin());
6971 if (Loc.isMacroID())
6972 RegionOfInterest.setBegin(SM.getExpansionLoc(Loc));
6973 }
6974
Guy Benyei11169dd2012-12-18 14:30:41 +00006975 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
6976 // Search and mark tokens that are macro argument expansions.
6977 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
6978 Tokens, NumTokens);
6979 CursorVisitor MacroArgMarker(TU,
6980 MarkMacroArgTokensVisitorDelegate, &Visitor,
6981 /*VisitPreprocessorLast=*/true,
6982 /*VisitIncludedEntities=*/false,
6983 RegionOfInterest);
6984 MacroArgMarker.visitPreprocessedEntitiesInRegion();
6985 }
6986
6987 // Annotate all of the source locations in the region of interest that map to
6988 // a specific cursor.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006989 AnnotateTokensWorker W(Tokens, Cursors, NumTokens, TU, RegionOfInterest);
Guy Benyei11169dd2012-12-18 14:30:41 +00006990
6991 // FIXME: We use a ridiculous stack size here because the data-recursion
6992 // algorithm uses a large stack frame than the non-data recursive version,
6993 // and AnnotationTokensWorker currently transforms the data-recursion
6994 // algorithm back into a traditional recursion by explicitly calling
6995 // VisitChildren(). We will need to remove this explicit recursive call.
6996 W.AnnotateTokens();
6997
6998 // If we ran into any entities that involve context-sensitive keywords,
6999 // take another pass through the tokens to mark them as such.
7000 if (W.hasContextSensitiveKeywords()) {
7001 for (unsigned I = 0; I != NumTokens; ++I) {
7002 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
7003 continue;
7004
7005 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
7006 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007007 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00007008 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
7009 if (Property->getPropertyAttributesAsWritten() != 0 &&
7010 llvm::StringSwitch<bool>(II->getName())
7011 .Case("readonly", true)
7012 .Case("assign", true)
7013 .Case("unsafe_unretained", true)
7014 .Case("readwrite", true)
7015 .Case("retain", true)
7016 .Case("copy", true)
7017 .Case("nonatomic", true)
7018 .Case("atomic", true)
7019 .Case("getter", true)
7020 .Case("setter", true)
7021 .Case("strong", true)
7022 .Case("weak", true)
Manman Ren04fd4d82016-05-31 23:22:04 +00007023 .Case("class", true)
Guy Benyei11169dd2012-12-18 14:30:41 +00007024 .Default(false))
7025 Tokens[I].int_data[0] = CXToken_Keyword;
7026 }
7027 continue;
7028 }
7029
7030 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
7031 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
7032 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
7033 if (llvm::StringSwitch<bool>(II->getName())
7034 .Case("in", true)
7035 .Case("out", true)
7036 .Case("inout", true)
7037 .Case("oneway", true)
7038 .Case("bycopy", true)
7039 .Case("byref", true)
7040 .Default(false))
7041 Tokens[I].int_data[0] = CXToken_Keyword;
7042 continue;
7043 }
7044
7045 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
7046 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
7047 Tokens[I].int_data[0] = CXToken_Keyword;
7048 continue;
7049 }
7050 }
7051 }
7052}
7053
Guy Benyei11169dd2012-12-18 14:30:41 +00007054void clang_annotateTokens(CXTranslationUnit TU,
7055 CXToken *Tokens, unsigned NumTokens,
7056 CXCursor *Cursors) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007057 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007058 LOG_BAD_TU(TU);
7059 return;
7060 }
7061 if (NumTokens == 0 || !Tokens || !Cursors) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007062 LOG_FUNC_SECTION { *Log << "<null input>"; }
Guy Benyei11169dd2012-12-18 14:30:41 +00007063 return;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007064 }
7065
7066 LOG_FUNC_SECTION {
7067 *Log << TU << ' ';
7068 CXSourceLocation bloc = clang_getTokenLocation(TU, Tokens[0]);
7069 CXSourceLocation eloc = clang_getTokenLocation(TU, Tokens[NumTokens-1]);
7070 *Log << clang_getRange(bloc, eloc);
7071 }
Guy Benyei11169dd2012-12-18 14:30:41 +00007072
7073 // Any token we don't specifically annotate will have a NULL cursor.
7074 CXCursor C = clang_getNullCursor();
7075 for (unsigned I = 0; I != NumTokens; ++I)
7076 Cursors[I] = C;
7077
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007078 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00007079 if (!CXXUnit)
7080 return;
7081
7082 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007083
7084 auto AnnotateTokensImpl = [=]() {
7085 clang_annotateTokensImpl(TU, CXXUnit, Tokens, NumTokens, Cursors);
7086 };
Guy Benyei11169dd2012-12-18 14:30:41 +00007087 llvm::CrashRecoveryContext CRC;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007088 if (!RunSafely(CRC, AnnotateTokensImpl, GetSafetyThreadStackSize() * 2)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007089 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
7090 }
7091}
7092
Guy Benyei11169dd2012-12-18 14:30:41 +00007093//===----------------------------------------------------------------------===//
7094// Operations for querying linkage of a cursor.
7095//===----------------------------------------------------------------------===//
7096
Guy Benyei11169dd2012-12-18 14:30:41 +00007097CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
7098 if (!clang_isDeclaration(cursor.kind))
7099 return CXLinkage_Invalid;
7100
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007101 const Decl *D = cxcursor::getCursorDecl(cursor);
7102 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
Rafael Espindola3ae00052013-05-13 00:12:11 +00007103 switch (ND->getLinkageInternal()) {
Rafael Espindola50df3a02013-05-25 17:16:20 +00007104 case NoLinkage:
7105 case VisibleNoLinkage: return CXLinkage_NoLinkage;
Richard Smithaf10ea22017-07-08 00:37:59 +00007106 case ModuleInternalLinkage:
Guy Benyei11169dd2012-12-18 14:30:41 +00007107 case InternalLinkage: return CXLinkage_Internal;
7108 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
Richard Smithaf10ea22017-07-08 00:37:59 +00007109 case ModuleLinkage:
Guy Benyei11169dd2012-12-18 14:30:41 +00007110 case ExternalLinkage: return CXLinkage_External;
7111 };
7112
7113 return CXLinkage_Invalid;
7114}
Guy Benyei11169dd2012-12-18 14:30:41 +00007115
7116//===----------------------------------------------------------------------===//
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007117// Operations for querying visibility of a cursor.
7118//===----------------------------------------------------------------------===//
7119
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007120CXVisibilityKind clang_getCursorVisibility(CXCursor cursor) {
7121 if (!clang_isDeclaration(cursor.kind))
7122 return CXVisibility_Invalid;
7123
7124 const Decl *D = cxcursor::getCursorDecl(cursor);
7125 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
7126 switch (ND->getVisibility()) {
7127 case HiddenVisibility: return CXVisibility_Hidden;
7128 case ProtectedVisibility: return CXVisibility_Protected;
7129 case DefaultVisibility: return CXVisibility_Default;
7130 };
7131
7132 return CXVisibility_Invalid;
7133}
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007134
7135//===----------------------------------------------------------------------===//
Guy Benyei11169dd2012-12-18 14:30:41 +00007136// Operations for querying language of a cursor.
7137//===----------------------------------------------------------------------===//
7138
7139static CXLanguageKind getDeclLanguage(const Decl *D) {
7140 if (!D)
7141 return CXLanguage_C;
7142
7143 switch (D->getKind()) {
7144 default:
7145 break;
7146 case Decl::ImplicitParam:
7147 case Decl::ObjCAtDefsField:
7148 case Decl::ObjCCategory:
7149 case Decl::ObjCCategoryImpl:
7150 case Decl::ObjCCompatibleAlias:
7151 case Decl::ObjCImplementation:
7152 case Decl::ObjCInterface:
7153 case Decl::ObjCIvar:
7154 case Decl::ObjCMethod:
7155 case Decl::ObjCProperty:
7156 case Decl::ObjCPropertyImpl:
7157 case Decl::ObjCProtocol:
Douglas Gregor85f3f952015-07-07 03:57:15 +00007158 case Decl::ObjCTypeParam:
Guy Benyei11169dd2012-12-18 14:30:41 +00007159 return CXLanguage_ObjC;
7160 case Decl::CXXConstructor:
7161 case Decl::CXXConversion:
7162 case Decl::CXXDestructor:
7163 case Decl::CXXMethod:
7164 case Decl::CXXRecord:
7165 case Decl::ClassTemplate:
7166 case Decl::ClassTemplatePartialSpecialization:
7167 case Decl::ClassTemplateSpecialization:
7168 case Decl::Friend:
7169 case Decl::FriendTemplate:
7170 case Decl::FunctionTemplate:
7171 case Decl::LinkageSpec:
7172 case Decl::Namespace:
7173 case Decl::NamespaceAlias:
7174 case Decl::NonTypeTemplateParm:
7175 case Decl::StaticAssert:
7176 case Decl::TemplateTemplateParm:
7177 case Decl::TemplateTypeParm:
7178 case Decl::UnresolvedUsingTypename:
7179 case Decl::UnresolvedUsingValue:
7180 case Decl::Using:
7181 case Decl::UsingDirective:
7182 case Decl::UsingShadow:
7183 return CXLanguage_CPlusPlus;
7184 }
7185
7186 return CXLanguage_C;
7187}
7188
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007189static CXAvailabilityKind getCursorAvailabilityForDecl(const Decl *D) {
7190 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
Manuel Klimek8e3a7ed2015-09-25 17:53:16 +00007191 return CXAvailability_NotAvailable;
Guy Benyei11169dd2012-12-18 14:30:41 +00007192
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007193 switch (D->getAvailability()) {
7194 case AR_Available:
7195 case AR_NotYetIntroduced:
7196 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
Benjamin Kramer656363d2013-10-15 18:53:18 +00007197 return getCursorAvailabilityForDecl(
7198 cast<Decl>(EnumConst->getDeclContext()));
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007199 return CXAvailability_Available;
7200
7201 case AR_Deprecated:
7202 return CXAvailability_Deprecated;
7203
7204 case AR_Unavailable:
7205 return CXAvailability_NotAvailable;
7206 }
Benjamin Kramer656363d2013-10-15 18:53:18 +00007207
7208 llvm_unreachable("Unknown availability kind!");
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007209}
7210
Guy Benyei11169dd2012-12-18 14:30:41 +00007211enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
7212 if (clang_isDeclaration(cursor.kind))
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007213 if (const Decl *D = cxcursor::getCursorDecl(cursor))
7214 return getCursorAvailabilityForDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00007215
7216 return CXAvailability_Available;
7217}
7218
7219static CXVersion convertVersion(VersionTuple In) {
7220 CXVersion Out = { -1, -1, -1 };
7221 if (In.empty())
7222 return Out;
7223
7224 Out.Major = In.getMajor();
7225
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00007226 Optional<unsigned> Minor = In.getMinor();
7227 if (Minor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00007228 Out.Minor = *Minor;
7229 else
7230 return Out;
7231
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00007232 Optional<unsigned> Subminor = In.getSubminor();
7233 if (Subminor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00007234 Out.Subminor = *Subminor;
7235
7236 return Out;
7237}
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007238
Alex Lorenz1345ea22017-06-12 19:06:30 +00007239static void getCursorPlatformAvailabilityForDecl(
7240 const Decl *D, int *always_deprecated, CXString *deprecated_message,
7241 int *always_unavailable, CXString *unavailable_message,
7242 SmallVectorImpl<AvailabilityAttr *> &AvailabilityAttrs) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007243 bool HadAvailAttr = false;
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007244 for (auto A : D->attrs()) {
7245 if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007246 HadAvailAttr = true;
7247 if (always_deprecated)
7248 *always_deprecated = 1;
Nico Weberaacf0312014-04-24 05:16:45 +00007249 if (deprecated_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007250 clang_disposeString(*deprecated_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007251 *deprecated_message = cxstring::createDup(Deprecated->getMessage());
Nico Weberaacf0312014-04-24 05:16:45 +00007252 }
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007253 continue;
7254 }
Alex Lorenz1345ea22017-06-12 19:06:30 +00007255
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007256 if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007257 HadAvailAttr = true;
7258 if (always_unavailable)
7259 *always_unavailable = 1;
7260 if (unavailable_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007261 clang_disposeString(*unavailable_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007262 *unavailable_message = cxstring::createDup(Unavailable->getMessage());
7263 }
7264 continue;
7265 }
Alex Lorenz1345ea22017-06-12 19:06:30 +00007266
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007267 if (AvailabilityAttr *Avail = dyn_cast<AvailabilityAttr>(A)) {
Alex Lorenz1345ea22017-06-12 19:06:30 +00007268 AvailabilityAttrs.push_back(Avail);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007269 HadAvailAttr = true;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007270 }
7271 }
7272
7273 if (!HadAvailAttr)
7274 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
7275 return getCursorPlatformAvailabilityForDecl(
Alex Lorenz1345ea22017-06-12 19:06:30 +00007276 cast<Decl>(EnumConst->getDeclContext()), always_deprecated,
7277 deprecated_message, always_unavailable, unavailable_message,
7278 AvailabilityAttrs);
7279
7280 if (AvailabilityAttrs.empty())
7281 return;
7282
7283 std::sort(AvailabilityAttrs.begin(), AvailabilityAttrs.end(),
7284 [](AvailabilityAttr *LHS, AvailabilityAttr *RHS) {
7285 return LHS->getPlatform() > RHS->getPlatform();
7286 });
7287 ASTContext &Ctx = D->getASTContext();
7288 auto It = std::unique(
7289 AvailabilityAttrs.begin(), AvailabilityAttrs.end(),
7290 [&Ctx](AvailabilityAttr *LHS, AvailabilityAttr *RHS) {
7291 if (LHS->getPlatform() != RHS->getPlatform())
7292 return false;
7293
7294 if (LHS->getIntroduced() == RHS->getIntroduced() &&
7295 LHS->getDeprecated() == RHS->getDeprecated() &&
7296 LHS->getObsoleted() == RHS->getObsoleted() &&
7297 LHS->getMessage() == RHS->getMessage() &&
7298 LHS->getReplacement() == RHS->getReplacement())
7299 return true;
7300
7301 if ((!LHS->getIntroduced().empty() && !RHS->getIntroduced().empty()) ||
7302 (!LHS->getDeprecated().empty() && !RHS->getDeprecated().empty()) ||
7303 (!LHS->getObsoleted().empty() && !RHS->getObsoleted().empty()))
7304 return false;
7305
7306 if (LHS->getIntroduced().empty() && !RHS->getIntroduced().empty())
7307 LHS->setIntroduced(Ctx, RHS->getIntroduced());
7308
7309 if (LHS->getDeprecated().empty() && !RHS->getDeprecated().empty()) {
7310 LHS->setDeprecated(Ctx, RHS->getDeprecated());
7311 if (LHS->getMessage().empty())
7312 LHS->setMessage(Ctx, RHS->getMessage());
7313 if (LHS->getReplacement().empty())
7314 LHS->setReplacement(Ctx, RHS->getReplacement());
7315 }
7316
7317 if (LHS->getObsoleted().empty() && !RHS->getObsoleted().empty()) {
7318 LHS->setObsoleted(Ctx, RHS->getObsoleted());
7319 if (LHS->getMessage().empty())
7320 LHS->setMessage(Ctx, RHS->getMessage());
7321 if (LHS->getReplacement().empty())
7322 LHS->setReplacement(Ctx, RHS->getReplacement());
7323 }
7324
7325 return true;
7326 });
7327 AvailabilityAttrs.erase(It, AvailabilityAttrs.end());
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007328}
7329
Alex Lorenz1345ea22017-06-12 19:06:30 +00007330int clang_getCursorPlatformAvailability(CXCursor cursor, int *always_deprecated,
Guy Benyei11169dd2012-12-18 14:30:41 +00007331 CXString *deprecated_message,
7332 int *always_unavailable,
7333 CXString *unavailable_message,
7334 CXPlatformAvailability *availability,
7335 int availability_size) {
7336 if (always_deprecated)
7337 *always_deprecated = 0;
7338 if (deprecated_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007339 *deprecated_message = cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007340 if (always_unavailable)
7341 *always_unavailable = 0;
7342 if (unavailable_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007343 *unavailable_message = cxstring::createEmpty();
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007344
Guy Benyei11169dd2012-12-18 14:30:41 +00007345 if (!clang_isDeclaration(cursor.kind))
7346 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007347
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007348 const Decl *D = cxcursor::getCursorDecl(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007349 if (!D)
7350 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007351
Alex Lorenz1345ea22017-06-12 19:06:30 +00007352 SmallVector<AvailabilityAttr *, 8> AvailabilityAttrs;
7353 getCursorPlatformAvailabilityForDecl(D, always_deprecated, deprecated_message,
7354 always_unavailable, unavailable_message,
7355 AvailabilityAttrs);
7356 for (const auto &Avail :
7357 llvm::enumerate(llvm::makeArrayRef(AvailabilityAttrs)
7358 .take_front(availability_size))) {
7359 availability[Avail.index()].Platform =
7360 cxstring::createDup(Avail.value()->getPlatform()->getName());
7361 availability[Avail.index()].Introduced =
7362 convertVersion(Avail.value()->getIntroduced());
7363 availability[Avail.index()].Deprecated =
7364 convertVersion(Avail.value()->getDeprecated());
7365 availability[Avail.index()].Obsoleted =
7366 convertVersion(Avail.value()->getObsoleted());
7367 availability[Avail.index()].Unavailable = Avail.value()->getUnavailable();
7368 availability[Avail.index()].Message =
7369 cxstring::createDup(Avail.value()->getMessage());
7370 }
7371
7372 return AvailabilityAttrs.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00007373}
Alex Lorenz1345ea22017-06-12 19:06:30 +00007374
Guy Benyei11169dd2012-12-18 14:30:41 +00007375void clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability) {
7376 clang_disposeString(availability->Platform);
7377 clang_disposeString(availability->Message);
7378}
7379
7380CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
7381 if (clang_isDeclaration(cursor.kind))
7382 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
7383
7384 return CXLanguage_Invalid;
7385}
7386
7387 /// \brief If the given cursor is the "templated" declaration
7388 /// descibing a class or function template, return the class or
7389 /// function template.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007390static const Decl *maybeGetTemplateCursor(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007391 if (!D)
Craig Topper69186e72014-06-08 08:38:04 +00007392 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007393
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007394 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007395 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
7396 return FunTmpl;
7397
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007398 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007399 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
7400 return ClassTmpl;
7401
7402 return D;
7403}
7404
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007405
7406enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor C) {
7407 StorageClass sc = SC_None;
7408 const Decl *D = getCursorDecl(C);
7409 if (D) {
7410 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7411 sc = FD->getStorageClass();
7412 } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7413 sc = VD->getStorageClass();
7414 } else {
7415 return CX_SC_Invalid;
7416 }
7417 } else {
7418 return CX_SC_Invalid;
7419 }
7420 switch (sc) {
7421 case SC_None:
7422 return CX_SC_None;
7423 case SC_Extern:
7424 return CX_SC_Extern;
7425 case SC_Static:
7426 return CX_SC_Static;
7427 case SC_PrivateExtern:
7428 return CX_SC_PrivateExtern;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007429 case SC_Auto:
7430 return CX_SC_Auto;
7431 case SC_Register:
7432 return CX_SC_Register;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007433 }
Kaelyn Takataab61e702014-10-15 18:03:26 +00007434 llvm_unreachable("Unhandled storage class!");
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007435}
7436
Guy Benyei11169dd2012-12-18 14:30:41 +00007437CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
7438 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007439 if (const Decl *D = getCursorDecl(cursor)) {
7440 const DeclContext *DC = D->getDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007441 if (!DC)
7442 return clang_getNullCursor();
7443
7444 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7445 getCursorTU(cursor));
7446 }
7447 }
7448
7449 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007450 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00007451 return MakeCXCursor(D, getCursorTU(cursor));
7452 }
7453
7454 return clang_getNullCursor();
7455}
7456
7457CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
7458 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007459 if (const Decl *D = getCursorDecl(cursor)) {
7460 const DeclContext *DC = D->getLexicalDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007461 if (!DC)
7462 return clang_getNullCursor();
7463
7464 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7465 getCursorTU(cursor));
7466 }
7467 }
7468
7469 // FIXME: Note that we can't easily compute the lexical context of a
7470 // statement or expression, so we return nothing.
7471 return clang_getNullCursor();
7472}
7473
7474CXFile clang_getIncludedFile(CXCursor cursor) {
7475 if (cursor.kind != CXCursor_InclusionDirective)
Craig Topper69186e72014-06-08 08:38:04 +00007476 return nullptr;
7477
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007478 const InclusionDirective *ID = getCursorInclusionDirective(cursor);
Dmitri Gribenkof9304482013-01-23 15:56:07 +00007479 return const_cast<FileEntry *>(ID->getFile());
Guy Benyei11169dd2012-12-18 14:30:41 +00007480}
7481
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007482unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved) {
7483 if (C.kind != CXCursor_ObjCPropertyDecl)
7484 return CXObjCPropertyAttr_noattr;
7485
7486 unsigned Result = CXObjCPropertyAttr_noattr;
7487 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7488 ObjCPropertyDecl::PropertyAttributeKind Attr =
7489 PD->getPropertyAttributesAsWritten();
7490
7491#define SET_CXOBJCPROP_ATTR(A) \
7492 if (Attr & ObjCPropertyDecl::OBJC_PR_##A) \
7493 Result |= CXObjCPropertyAttr_##A
7494 SET_CXOBJCPROP_ATTR(readonly);
7495 SET_CXOBJCPROP_ATTR(getter);
7496 SET_CXOBJCPROP_ATTR(assign);
7497 SET_CXOBJCPROP_ATTR(readwrite);
7498 SET_CXOBJCPROP_ATTR(retain);
7499 SET_CXOBJCPROP_ATTR(copy);
7500 SET_CXOBJCPROP_ATTR(nonatomic);
7501 SET_CXOBJCPROP_ATTR(setter);
7502 SET_CXOBJCPROP_ATTR(atomic);
7503 SET_CXOBJCPROP_ATTR(weak);
7504 SET_CXOBJCPROP_ATTR(strong);
7505 SET_CXOBJCPROP_ATTR(unsafe_unretained);
Manman Ren04fd4d82016-05-31 23:22:04 +00007506 SET_CXOBJCPROP_ATTR(class);
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007507#undef SET_CXOBJCPROP_ATTR
7508
7509 return Result;
7510}
7511
Argyrios Kyrtzidis9d9bc012013-04-18 23:29:12 +00007512unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C) {
7513 if (!clang_isDeclaration(C.kind))
7514 return CXObjCDeclQualifier_None;
7515
7516 Decl::ObjCDeclQualifier QT = Decl::OBJC_TQ_None;
7517 const Decl *D = getCursorDecl(C);
7518 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7519 QT = MD->getObjCDeclQualifier();
7520 else if (const ParmVarDecl *PD = dyn_cast<ParmVarDecl>(D))
7521 QT = PD->getObjCDeclQualifier();
7522 if (QT == Decl::OBJC_TQ_None)
7523 return CXObjCDeclQualifier_None;
7524
7525 unsigned Result = CXObjCDeclQualifier_None;
7526 if (QT & Decl::OBJC_TQ_In) Result |= CXObjCDeclQualifier_In;
7527 if (QT & Decl::OBJC_TQ_Inout) Result |= CXObjCDeclQualifier_Inout;
7528 if (QT & Decl::OBJC_TQ_Out) Result |= CXObjCDeclQualifier_Out;
7529 if (QT & Decl::OBJC_TQ_Bycopy) Result |= CXObjCDeclQualifier_Bycopy;
7530 if (QT & Decl::OBJC_TQ_Byref) Result |= CXObjCDeclQualifier_Byref;
7531 if (QT & Decl::OBJC_TQ_Oneway) Result |= CXObjCDeclQualifier_Oneway;
7532
7533 return Result;
7534}
7535
Argyrios Kyrtzidis7b50fc52013-07-05 20:44:37 +00007536unsigned clang_Cursor_isObjCOptional(CXCursor C) {
7537 if (!clang_isDeclaration(C.kind))
7538 return 0;
7539
7540 const Decl *D = getCursorDecl(C);
7541 if (const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(D))
7542 return PD->getPropertyImplementation() == ObjCPropertyDecl::Optional;
7543 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7544 return MD->getImplementationControl() == ObjCMethodDecl::Optional;
7545
7546 return 0;
7547}
7548
Argyrios Kyrtzidis23814e42013-04-18 23:53:05 +00007549unsigned clang_Cursor_isVariadic(CXCursor C) {
7550 if (!clang_isDeclaration(C.kind))
7551 return 0;
7552
7553 const Decl *D = getCursorDecl(C);
7554 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7555 return FD->isVariadic();
7556 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7557 return MD->isVariadic();
7558
7559 return 0;
7560}
7561
Argyrios Kyrtzidis0381cc72017-05-10 15:10:36 +00007562unsigned clang_Cursor_isExternalSymbol(CXCursor C,
7563 CXString *language, CXString *definedIn,
7564 unsigned *isGenerated) {
7565 if (!clang_isDeclaration(C.kind))
7566 return 0;
7567
7568 const Decl *D = getCursorDecl(C);
7569
Argyrios Kyrtzidis11d70482017-05-20 04:11:33 +00007570 if (auto *attr = D->getExternalSourceSymbolAttr()) {
Argyrios Kyrtzidis0381cc72017-05-10 15:10:36 +00007571 if (language)
7572 *language = cxstring::createDup(attr->getLanguage());
7573 if (definedIn)
7574 *definedIn = cxstring::createDup(attr->getDefinedIn());
7575 if (isGenerated)
7576 *isGenerated = attr->getGeneratedDeclaration();
7577 return 1;
7578 }
7579 return 0;
7580}
7581
Guy Benyei11169dd2012-12-18 14:30:41 +00007582CXSourceRange clang_Cursor_getCommentRange(CXCursor C) {
7583 if (!clang_isDeclaration(C.kind))
7584 return clang_getNullRange();
7585
7586 const Decl *D = getCursorDecl(C);
7587 ASTContext &Context = getCursorContext(C);
7588 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7589 if (!RC)
7590 return clang_getNullRange();
7591
7592 return cxloc::translateSourceRange(Context, RC->getSourceRange());
7593}
7594
7595CXString clang_Cursor_getRawCommentText(CXCursor C) {
7596 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007597 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007598
7599 const Decl *D = getCursorDecl(C);
7600 ASTContext &Context = getCursorContext(C);
7601 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7602 StringRef RawText = RC ? RC->getRawText(Context.getSourceManager()) :
7603 StringRef();
7604
7605 // Don't duplicate the string because RawText points directly into source
7606 // code.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007607 return cxstring::createRef(RawText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007608}
7609
7610CXString clang_Cursor_getBriefCommentText(CXCursor C) {
7611 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007612 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007613
7614 const Decl *D = getCursorDecl(C);
7615 const ASTContext &Context = getCursorContext(C);
7616 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7617
7618 if (RC) {
7619 StringRef BriefText = RC->getBriefText(Context);
7620
7621 // Don't duplicate the string because RawComment ensures that this memory
7622 // will not go away.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007623 return cxstring::createRef(BriefText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007624 }
7625
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007626 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007627}
7628
Guy Benyei11169dd2012-12-18 14:30:41 +00007629CXModule clang_Cursor_getModule(CXCursor C) {
7630 if (C.kind == CXCursor_ModuleImportDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007631 if (const ImportDecl *ImportD =
7632 dyn_cast_or_null<ImportDecl>(getCursorDecl(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00007633 return ImportD->getImportedModule();
7634 }
7635
Craig Topper69186e72014-06-08 08:38:04 +00007636 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007637}
7638
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007639CXModule clang_getModuleForFile(CXTranslationUnit TU, CXFile File) {
7640 if (isNotUsableTU(TU)) {
7641 LOG_BAD_TU(TU);
7642 return nullptr;
7643 }
7644 if (!File)
7645 return nullptr;
7646 FileEntry *FE = static_cast<FileEntry *>(File);
7647
7648 ASTUnit &Unit = *cxtu::getASTUnit(TU);
7649 HeaderSearch &HS = Unit.getPreprocessor().getHeaderSearchInfo();
7650 ModuleMap::KnownHeader Header = HS.findModuleForHeader(FE);
7651
Richard Smithfeb54b62014-10-23 02:01:19 +00007652 return Header.getModule();
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007653}
7654
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007655CXFile clang_Module_getASTFile(CXModule CXMod) {
7656 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007657 return nullptr;
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007658 Module *Mod = static_cast<Module*>(CXMod);
7659 return const_cast<FileEntry *>(Mod->getASTFile());
7660}
7661
Guy Benyei11169dd2012-12-18 14:30:41 +00007662CXModule clang_Module_getParent(CXModule CXMod) {
7663 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007664 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007665 Module *Mod = static_cast<Module*>(CXMod);
7666 return Mod->Parent;
7667}
7668
7669CXString clang_Module_getName(CXModule CXMod) {
7670 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007671 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007672 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007673 return cxstring::createDup(Mod->Name);
Guy Benyei11169dd2012-12-18 14:30:41 +00007674}
7675
7676CXString clang_Module_getFullName(CXModule CXMod) {
7677 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007678 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007679 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007680 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00007681}
7682
Argyrios Kyrtzidis884337f2014-05-15 04:44:25 +00007683int clang_Module_isSystem(CXModule CXMod) {
7684 if (!CXMod)
7685 return 0;
7686 Module *Mod = static_cast<Module*>(CXMod);
7687 return Mod->IsSystem;
7688}
7689
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007690unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit TU,
7691 CXModule CXMod) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007692 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007693 LOG_BAD_TU(TU);
7694 return 0;
7695 }
7696 if (!CXMod)
Guy Benyei11169dd2012-12-18 14:30:41 +00007697 return 0;
7698 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007699 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
7700 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7701 return TopHeaders.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00007702}
7703
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007704CXFile clang_Module_getTopLevelHeader(CXTranslationUnit TU,
7705 CXModule CXMod, unsigned Index) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007706 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007707 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007708 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007709 }
7710 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007711 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007712 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007713 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
Guy Benyei11169dd2012-12-18 14:30:41 +00007714
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007715 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7716 if (Index < TopHeaders.size())
7717 return const_cast<FileEntry *>(TopHeaders[Index]);
Guy Benyei11169dd2012-12-18 14:30:41 +00007718
Craig Topper69186e72014-06-08 08:38:04 +00007719 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007720}
7721
Guy Benyei11169dd2012-12-18 14:30:41 +00007722//===----------------------------------------------------------------------===//
7723// C++ AST instrospection.
7724//===----------------------------------------------------------------------===//
7725
Jonathan Coe29565352016-04-27 12:48:25 +00007726unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C) {
7727 if (!clang_isDeclaration(C.kind))
7728 return 0;
7729
7730 const Decl *D = cxcursor::getCursorDecl(C);
7731 const CXXConstructorDecl *Constructor =
7732 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7733 return (Constructor && Constructor->isDefaultConstructor()) ? 1 : 0;
7734}
7735
7736unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C) {
7737 if (!clang_isDeclaration(C.kind))
7738 return 0;
7739
7740 const Decl *D = cxcursor::getCursorDecl(C);
7741 const CXXConstructorDecl *Constructor =
7742 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7743 return (Constructor && Constructor->isCopyConstructor()) ? 1 : 0;
7744}
7745
7746unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C) {
7747 if (!clang_isDeclaration(C.kind))
7748 return 0;
7749
7750 const Decl *D = cxcursor::getCursorDecl(C);
7751 const CXXConstructorDecl *Constructor =
7752 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7753 return (Constructor && Constructor->isMoveConstructor()) ? 1 : 0;
7754}
7755
7756unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C) {
7757 if (!clang_isDeclaration(C.kind))
7758 return 0;
7759
7760 const Decl *D = cxcursor::getCursorDecl(C);
7761 const CXXConstructorDecl *Constructor =
7762 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7763 // Passing 'false' excludes constructors marked 'explicit'.
7764 return (Constructor && Constructor->isConvertingConstructor(false)) ? 1 : 0;
7765}
7766
Saleem Abdulrasool6ea75db2015-10-27 15:50:22 +00007767unsigned clang_CXXField_isMutable(CXCursor C) {
7768 if (!clang_isDeclaration(C.kind))
7769 return 0;
7770
7771 if (const auto D = cxcursor::getCursorDecl(C))
7772 if (const auto FD = dyn_cast_or_null<FieldDecl>(D))
7773 return FD->isMutable() ? 1 : 0;
7774 return 0;
7775}
7776
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007777unsigned clang_CXXMethod_isPureVirtual(CXCursor C) {
7778 if (!clang_isDeclaration(C.kind))
7779 return 0;
7780
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007781 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007782 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007783 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007784 return (Method && Method->isVirtual() && Method->isPure()) ? 1 : 0;
7785}
7786
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007787unsigned clang_CXXMethod_isConst(CXCursor C) {
7788 if (!clang_isDeclaration(C.kind))
7789 return 0;
7790
7791 const Decl *D = cxcursor::getCursorDecl(C);
7792 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007793 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007794 return (Method && (Method->getTypeQualifiers() & Qualifiers::Const)) ? 1 : 0;
7795}
7796
Jonathan Coe29565352016-04-27 12:48:25 +00007797unsigned clang_CXXMethod_isDefaulted(CXCursor C) {
7798 if (!clang_isDeclaration(C.kind))
7799 return 0;
7800
7801 const Decl *D = cxcursor::getCursorDecl(C);
7802 const CXXMethodDecl *Method =
7803 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7804 return (Method && Method->isDefaulted()) ? 1 : 0;
7805}
7806
Guy Benyei11169dd2012-12-18 14:30:41 +00007807unsigned clang_CXXMethod_isStatic(CXCursor C) {
7808 if (!clang_isDeclaration(C.kind))
7809 return 0;
7810
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007811 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007812 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007813 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007814 return (Method && Method->isStatic()) ? 1 : 0;
7815}
7816
7817unsigned clang_CXXMethod_isVirtual(CXCursor C) {
7818 if (!clang_isDeclaration(C.kind))
7819 return 0;
7820
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007821 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007822 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007823 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007824 return (Method && Method->isVirtual()) ? 1 : 0;
7825}
Guy Benyei11169dd2012-12-18 14:30:41 +00007826
Alex Lorenzff7f42e2017-07-12 11:35:11 +00007827unsigned clang_EnumDecl_isScoped(CXCursor C) {
7828 if (!clang_isDeclaration(C.kind))
7829 return 0;
7830
7831 const Decl *D = cxcursor::getCursorDecl(C);
7832 auto *Enum = dyn_cast_or_null<EnumDecl>(D);
7833 return (Enum && Enum->isScoped()) ? 1 : 0;
7834}
7835
Guy Benyei11169dd2012-12-18 14:30:41 +00007836//===----------------------------------------------------------------------===//
7837// Attribute introspection.
7838//===----------------------------------------------------------------------===//
7839
Guy Benyei11169dd2012-12-18 14:30:41 +00007840CXType clang_getIBOutletCollectionType(CXCursor C) {
7841 if (C.kind != CXCursor_IBOutletCollectionAttr)
7842 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
7843
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00007844 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +00007845 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
7846
7847 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
7848}
Guy Benyei11169dd2012-12-18 14:30:41 +00007849
7850//===----------------------------------------------------------------------===//
7851// Inspecting memory usage.
7852//===----------------------------------------------------------------------===//
7853
7854typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
7855
7856static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
7857 enum CXTUResourceUsageKind k,
7858 unsigned long amount) {
7859 CXTUResourceUsageEntry entry = { k, amount };
7860 entries.push_back(entry);
7861}
7862
Guy Benyei11169dd2012-12-18 14:30:41 +00007863const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
7864 const char *str = "";
7865 switch (kind) {
7866 case CXTUResourceUsage_AST:
7867 str = "ASTContext: expressions, declarations, and types";
7868 break;
7869 case CXTUResourceUsage_Identifiers:
7870 str = "ASTContext: identifiers";
7871 break;
7872 case CXTUResourceUsage_Selectors:
7873 str = "ASTContext: selectors";
7874 break;
7875 case CXTUResourceUsage_GlobalCompletionResults:
7876 str = "Code completion: cached global results";
7877 break;
7878 case CXTUResourceUsage_SourceManagerContentCache:
7879 str = "SourceManager: content cache allocator";
7880 break;
7881 case CXTUResourceUsage_AST_SideTables:
7882 str = "ASTContext: side tables";
7883 break;
7884 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
7885 str = "SourceManager: malloc'ed memory buffers";
7886 break;
7887 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
7888 str = "SourceManager: mmap'ed memory buffers";
7889 break;
7890 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
7891 str = "ExternalASTSource: malloc'ed memory buffers";
7892 break;
7893 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
7894 str = "ExternalASTSource: mmap'ed memory buffers";
7895 break;
7896 case CXTUResourceUsage_Preprocessor:
7897 str = "Preprocessor: malloc'ed memory";
7898 break;
7899 case CXTUResourceUsage_PreprocessingRecord:
7900 str = "Preprocessor: PreprocessingRecord";
7901 break;
7902 case CXTUResourceUsage_SourceManager_DataStructures:
7903 str = "SourceManager: data structures and tables";
7904 break;
7905 case CXTUResourceUsage_Preprocessor_HeaderSearch:
7906 str = "Preprocessor: header search tables";
7907 break;
7908 }
7909 return str;
7910}
7911
7912CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007913 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007914 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007915 CXTUResourceUsage usage = { (void*) nullptr, 0, nullptr };
Guy Benyei11169dd2012-12-18 14:30:41 +00007916 return usage;
7917 }
7918
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007919 ASTUnit *astUnit = cxtu::getASTUnit(TU);
Ahmed Charlesb8984322014-03-07 20:03:18 +00007920 std::unique_ptr<MemUsageEntries> entries(new MemUsageEntries());
Guy Benyei11169dd2012-12-18 14:30:41 +00007921 ASTContext &astContext = astUnit->getASTContext();
7922
7923 // How much memory is used by AST nodes and types?
7924 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
7925 (unsigned long) astContext.getASTAllocatedMemory());
7926
7927 // How much memory is used by identifiers?
7928 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
7929 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
7930
7931 // How much memory is used for selectors?
7932 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
7933 (unsigned long) astContext.Selectors.getTotalMemory());
7934
7935 // How much memory is used by ASTContext's side tables?
7936 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
7937 (unsigned long) astContext.getSideTableAllocatedMemory());
7938
7939 // How much memory is used for caching global code completion results?
7940 unsigned long completionBytes = 0;
7941 if (GlobalCodeCompletionAllocator *completionAllocator =
Alp Tokerf994cef2014-07-05 03:08:06 +00007942 astUnit->getCachedCompletionAllocator().get()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007943 completionBytes = completionAllocator->getTotalMemory();
7944 }
7945 createCXTUResourceUsageEntry(*entries,
7946 CXTUResourceUsage_GlobalCompletionResults,
7947 completionBytes);
7948
7949 // How much memory is being used by SourceManager's content cache?
7950 createCXTUResourceUsageEntry(*entries,
7951 CXTUResourceUsage_SourceManagerContentCache,
7952 (unsigned long) astContext.getSourceManager().getContentCacheSize());
7953
7954 // How much memory is being used by the MemoryBuffer's in SourceManager?
7955 const SourceManager::MemoryBufferSizes &srcBufs =
7956 astUnit->getSourceManager().getMemoryBufferSizes();
7957
7958 createCXTUResourceUsageEntry(*entries,
7959 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
7960 (unsigned long) srcBufs.malloc_bytes);
7961 createCXTUResourceUsageEntry(*entries,
7962 CXTUResourceUsage_SourceManager_Membuffer_MMap,
7963 (unsigned long) srcBufs.mmap_bytes);
7964 createCXTUResourceUsageEntry(*entries,
7965 CXTUResourceUsage_SourceManager_DataStructures,
7966 (unsigned long) astContext.getSourceManager()
7967 .getDataStructureSizes());
7968
7969 // How much memory is being used by the ExternalASTSource?
7970 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
7971 const ExternalASTSource::MemoryBufferSizes &sizes =
7972 esrc->getMemoryBufferSizes();
7973
7974 createCXTUResourceUsageEntry(*entries,
7975 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
7976 (unsigned long) sizes.malloc_bytes);
7977 createCXTUResourceUsageEntry(*entries,
7978 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
7979 (unsigned long) sizes.mmap_bytes);
7980 }
7981
7982 // How much memory is being used by the Preprocessor?
7983 Preprocessor &pp = astUnit->getPreprocessor();
7984 createCXTUResourceUsageEntry(*entries,
7985 CXTUResourceUsage_Preprocessor,
7986 pp.getTotalMemory());
7987
7988 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
7989 createCXTUResourceUsageEntry(*entries,
7990 CXTUResourceUsage_PreprocessingRecord,
7991 pRec->getTotalMemory());
7992 }
7993
7994 createCXTUResourceUsageEntry(*entries,
7995 CXTUResourceUsage_Preprocessor_HeaderSearch,
7996 pp.getHeaderSearchInfo().getTotalMemory());
Craig Topper69186e72014-06-08 08:38:04 +00007997
Guy Benyei11169dd2012-12-18 14:30:41 +00007998 CXTUResourceUsage usage = { (void*) entries.get(),
7999 (unsigned) entries->size(),
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00008000 !entries->empty() ? &(*entries)[0] : nullptr };
Eric Fiseliere95fc442016-11-14 07:03:50 +00008001 (void)entries.release();
Guy Benyei11169dd2012-12-18 14:30:41 +00008002 return usage;
8003}
8004
8005void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
8006 if (usage.data)
8007 delete (MemUsageEntries*) usage.data;
8008}
8009
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00008010CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit TU, CXFile file) {
8011 CXSourceRangeList *skipped = new CXSourceRangeList;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008012 skipped->count = 0;
Craig Topper69186e72014-06-08 08:38:04 +00008013 skipped->ranges = nullptr;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008014
Dmitri Gribenko852d6222014-02-11 15:02:48 +00008015 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008016 LOG_BAD_TU(TU);
8017 return skipped;
8018 }
8019
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008020 if (!file)
8021 return skipped;
8022
8023 ASTUnit *astUnit = cxtu::getASTUnit(TU);
8024 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
8025 if (!ppRec)
8026 return skipped;
8027
8028 ASTContext &Ctx = astUnit->getASTContext();
8029 SourceManager &sm = Ctx.getSourceManager();
8030 FileEntry *fileEntry = static_cast<FileEntry *>(file);
8031 FileID wantedFileID = sm.translateFile(fileEntry);
8032
8033 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
8034 std::vector<SourceRange> wantedRanges;
8035 for (std::vector<SourceRange>::const_iterator i = SkippedRanges.begin(), ei = SkippedRanges.end();
8036 i != ei; ++i) {
8037 if (sm.getFileID(i->getBegin()) == wantedFileID || sm.getFileID(i->getEnd()) == wantedFileID)
8038 wantedRanges.push_back(*i);
8039 }
8040
8041 skipped->count = wantedRanges.size();
8042 skipped->ranges = new CXSourceRange[skipped->count];
8043 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
8044 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, wantedRanges[i]);
8045
8046 return skipped;
8047}
8048
Cameron Desrochersd8091282016-08-18 15:43:55 +00008049CXSourceRangeList *clang_getAllSkippedRanges(CXTranslationUnit TU) {
8050 CXSourceRangeList *skipped = new CXSourceRangeList;
8051 skipped->count = 0;
8052 skipped->ranges = nullptr;
8053
8054 if (isNotUsableTU(TU)) {
8055 LOG_BAD_TU(TU);
8056 return skipped;
8057 }
8058
8059 ASTUnit *astUnit = cxtu::getASTUnit(TU);
8060 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
8061 if (!ppRec)
8062 return skipped;
8063
8064 ASTContext &Ctx = astUnit->getASTContext();
8065
8066 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
8067
8068 skipped->count = SkippedRanges.size();
8069 skipped->ranges = new CXSourceRange[skipped->count];
8070 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
8071 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, SkippedRanges[i]);
8072
8073 return skipped;
8074}
8075
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00008076void clang_disposeSourceRangeList(CXSourceRangeList *ranges) {
8077 if (ranges) {
8078 delete[] ranges->ranges;
8079 delete ranges;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008080 }
8081}
8082
Guy Benyei11169dd2012-12-18 14:30:41 +00008083void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
8084 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
8085 for (unsigned I = 0; I != Usage.numEntries; ++I)
8086 fprintf(stderr, " %s: %lu\n",
8087 clang_getTUResourceUsageName(Usage.entries[I].kind),
8088 Usage.entries[I].amount);
8089
8090 clang_disposeCXTUResourceUsage(Usage);
8091}
8092
8093//===----------------------------------------------------------------------===//
8094// Misc. utility functions.
8095//===----------------------------------------------------------------------===//
8096
8097/// Default to using an 8 MB stack size on "safety" threads.
8098static unsigned SafetyStackThreadSize = 8 << 20;
8099
8100namespace clang {
8101
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00008102bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn,
Guy Benyei11169dd2012-12-18 14:30:41 +00008103 unsigned Size) {
8104 if (!Size)
8105 Size = GetSafetyThreadStackSize();
8106 if (Size)
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00008107 return CRC.RunSafelyOnThread(Fn, Size);
8108 return CRC.RunSafely(Fn);
Guy Benyei11169dd2012-12-18 14:30:41 +00008109}
8110
8111unsigned GetSafetyThreadStackSize() {
8112 return SafetyStackThreadSize;
8113}
8114
8115void SetSafetyThreadStackSize(unsigned Value) {
8116 SafetyStackThreadSize = Value;
8117}
8118
Alexander Kornienkoab9db512015-06-22 23:07:51 +00008119}
Guy Benyei11169dd2012-12-18 14:30:41 +00008120
8121void clang::setThreadBackgroundPriority() {
8122 if (getenv("LIBCLANG_BGPRIO_DISABLE"))
8123 return;
8124
Alp Toker1a86ad22014-07-06 06:24:00 +00008125#ifdef USE_DARWIN_THREADS
Guy Benyei11169dd2012-12-18 14:30:41 +00008126 setpriority(PRIO_DARWIN_THREAD, 0, PRIO_DARWIN_BG);
8127#endif
8128}
8129
8130void cxindex::printDiagsToStderr(ASTUnit *Unit) {
8131 if (!Unit)
8132 return;
8133
8134 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
8135 DEnd = Unit->stored_diag_end();
8136 D != DEnd; ++D) {
Ben Langmuir749323f2014-04-22 17:40:12 +00008137 CXStoredDiagnostic Diag(*D, Unit->getLangOpts());
Guy Benyei11169dd2012-12-18 14:30:41 +00008138 CXString Msg = clang_formatDiagnostic(&Diag,
8139 clang_defaultDiagnosticDisplayOptions());
8140 fprintf(stderr, "%s\n", clang_getCString(Msg));
8141 clang_disposeString(Msg);
8142 }
8143#ifdef LLVM_ON_WIN32
8144 // On Windows, force a flush, since there may be multiple copies of
8145 // stderr and stdout in the file system, all with different buffers
8146 // but writing to the same device.
8147 fflush(stderr);
8148#endif
8149}
8150
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008151MacroInfo *cxindex::getMacroInfo(const IdentifierInfo &II,
8152 SourceLocation MacroDefLoc,
8153 CXTranslationUnit TU){
8154 if (MacroDefLoc.isInvalid() || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008155 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008156 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00008157 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008158
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008159 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00008160 Preprocessor &PP = Unit->getPreprocessor();
Richard Smith20e883e2015-04-29 23:20:19 +00008161 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00008162 if (MD) {
8163 for (MacroDirective::DefInfo
8164 Def = MD->getDefinition(); Def; Def = Def.getPreviousDefinition()) {
8165 if (MacroDefLoc == Def.getMacroInfo()->getDefinitionLoc())
8166 return Def.getMacroInfo();
8167 }
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008168 }
8169
Craig Topper69186e72014-06-08 08:38:04 +00008170 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008171}
8172
Richard Smith66a81862015-05-04 02:25:31 +00008173const MacroInfo *cxindex::getMacroInfo(const MacroDefinitionRecord *MacroDef,
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00008174 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008175 if (!MacroDef || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008176 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008177 const IdentifierInfo *II = MacroDef->getName();
8178 if (!II)
Craig Topper69186e72014-06-08 08:38:04 +00008179 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008180
8181 return getMacroInfo(*II, MacroDef->getLocation(), TU);
8182}
8183
Richard Smith66a81862015-05-04 02:25:31 +00008184MacroDefinitionRecord *
8185cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, const Token &Tok,
8186 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008187 if (!MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008188 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008189 if (Tok.isNot(tok::raw_identifier))
Craig Topper69186e72014-06-08 08:38:04 +00008190 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008191
8192 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00008193 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008194 SourceRange DefRange(MI->getReplacementToken(0).getLocation(),
8195 MI->getDefinitionEndLoc());
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008196 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008197
8198 // Check that the token is inside the definition and not its argument list.
8199 SourceManager &SM = Unit->getSourceManager();
8200 if (SM.isBeforeInTranslationUnit(Tok.getLocation(), DefRange.getBegin()))
Craig Topper69186e72014-06-08 08:38:04 +00008201 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008202 if (SM.isBeforeInTranslationUnit(DefRange.getEnd(), Tok.getLocation()))
Craig Topper69186e72014-06-08 08:38:04 +00008203 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008204
8205 Preprocessor &PP = Unit->getPreprocessor();
8206 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
8207 if (!PPRec)
Craig Topper69186e72014-06-08 08:38:04 +00008208 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008209
Alp Toker2d57cea2014-05-17 04:53:25 +00008210 IdentifierInfo &II = PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008211 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00008212 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008213
8214 // Check that the identifier is not one of the macro arguments.
Faisal Valiac506d72017-07-17 17:18:43 +00008215 if (std::find(MI->param_begin(), MI->param_end(), &II) != MI->param_end())
Craig Topper69186e72014-06-08 08:38:04 +00008216 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008217
Richard Smith20e883e2015-04-29 23:20:19 +00008218 MacroDirective *InnerMD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00008219 if (!InnerMD)
Craig Topper69186e72014-06-08 08:38:04 +00008220 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008221
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00008222 return PPRec->findMacroDefinition(InnerMD->getMacroInfo());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008223}
8224
Richard Smith66a81862015-05-04 02:25:31 +00008225MacroDefinitionRecord *
8226cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc,
8227 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008228 if (Loc.isInvalid() || !MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008229 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008230
8231 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00008232 return nullptr;
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008233 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008234 Preprocessor &PP = Unit->getPreprocessor();
8235 if (!PP.getPreprocessingRecord())
Craig Topper69186e72014-06-08 08:38:04 +00008236 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008237 Loc = Unit->getSourceManager().getSpellingLoc(Loc);
8238 Token Tok;
8239 if (PP.getRawToken(Loc, Tok))
Craig Topper69186e72014-06-08 08:38:04 +00008240 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008241
8242 return checkForMacroInMacroDefinition(MI, Tok, TU);
8243}
8244
Guy Benyei11169dd2012-12-18 14:30:41 +00008245CXString clang_getClangVersion() {
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008246 return cxstring::createDup(getClangFullVersion());
Guy Benyei11169dd2012-12-18 14:30:41 +00008247}
8248
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008249Logger &cxindex::Logger::operator<<(CXTranslationUnit TU) {
8250 if (TU) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008251 if (ASTUnit *Unit = cxtu::getASTUnit(TU)) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008252 LogOS << '<' << Unit->getMainFileName() << '>';
Argyrios Kyrtzidis37f2ab42013-03-05 20:21:14 +00008253 if (Unit->isMainFileAST())
8254 LogOS << " (" << Unit->getASTFileName() << ')';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008255 return *this;
8256 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00008257 } else {
8258 LogOS << "<NULL TU>";
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008259 }
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008260 return *this;
8261}
8262
Argyrios Kyrtzidisba4b5f82013-03-08 02:32:26 +00008263Logger &cxindex::Logger::operator<<(const FileEntry *FE) {
8264 *this << FE->getName();
8265 return *this;
8266}
8267
8268Logger &cxindex::Logger::operator<<(CXCursor cursor) {
8269 CXString cursorName = clang_getCursorDisplayName(cursor);
8270 *this << cursorName << "@" << clang_getCursorLocation(cursor);
8271 clang_disposeString(cursorName);
8272 return *this;
8273}
8274
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008275Logger &cxindex::Logger::operator<<(CXSourceLocation Loc) {
8276 CXFile File;
8277 unsigned Line, Column;
Craig Topper69186e72014-06-08 08:38:04 +00008278 clang_getFileLocation(Loc, &File, &Line, &Column, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008279 CXString FileName = clang_getFileName(File);
8280 *this << llvm::format("(%s:%d:%d)", clang_getCString(FileName), Line, Column);
8281 clang_disposeString(FileName);
8282 return *this;
8283}
8284
8285Logger &cxindex::Logger::operator<<(CXSourceRange range) {
8286 CXSourceLocation BLoc = clang_getRangeStart(range);
8287 CXSourceLocation ELoc = clang_getRangeEnd(range);
8288
8289 CXFile BFile;
8290 unsigned BLine, BColumn;
Craig Topper69186e72014-06-08 08:38:04 +00008291 clang_getFileLocation(BLoc, &BFile, &BLine, &BColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008292
8293 CXFile EFile;
8294 unsigned ELine, EColumn;
Craig Topper69186e72014-06-08 08:38:04 +00008295 clang_getFileLocation(ELoc, &EFile, &ELine, &EColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008296
8297 CXString BFileName = clang_getFileName(BFile);
8298 if (BFile == EFile) {
8299 *this << llvm::format("[%s %d:%d-%d:%d]", clang_getCString(BFileName),
8300 BLine, BColumn, ELine, EColumn);
8301 } else {
8302 CXString EFileName = clang_getFileName(EFile);
8303 *this << llvm::format("[%s:%d:%d - ", clang_getCString(BFileName),
8304 BLine, BColumn)
8305 << llvm::format("%s:%d:%d]", clang_getCString(EFileName),
8306 ELine, EColumn);
8307 clang_disposeString(EFileName);
8308 }
8309 clang_disposeString(BFileName);
8310 return *this;
8311}
8312
8313Logger &cxindex::Logger::operator<<(CXString Str) {
8314 *this << clang_getCString(Str);
8315 return *this;
8316}
8317
8318Logger &cxindex::Logger::operator<<(const llvm::format_object_base &Fmt) {
8319 LogOS << Fmt;
8320 return *this;
8321}
8322
Chandler Carruth37ad2582014-06-27 15:14:39 +00008323static llvm::ManagedStatic<llvm::sys::Mutex> LoggingMutex;
8324
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008325cxindex::Logger::~Logger() {
Chandler Carruth37ad2582014-06-27 15:14:39 +00008326 llvm::sys::ScopedLock L(*LoggingMutex);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008327
8328 static llvm::TimeRecord sBeginTR = llvm::TimeRecord::getCurrentTime();
8329
Dmitri Gribenkof8579502013-01-12 19:30:44 +00008330 raw_ostream &OS = llvm::errs();
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008331 OS << "[libclang:" << Name << ':';
8332
Alp Toker1a86ad22014-07-06 06:24:00 +00008333#ifdef USE_DARWIN_THREADS
8334 // TODO: Portability.
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008335 mach_port_t tid = pthread_mach_thread_np(pthread_self());
8336 OS << tid << ':';
8337#endif
8338
8339 llvm::TimeRecord TR = llvm::TimeRecord::getCurrentTime();
8340 OS << llvm::format("%7.4f] ", TR.getWallTime() - sBeginTR.getWallTime());
Yaron Keren09fb7c62015-03-10 07:33:23 +00008341 OS << Msg << '\n';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008342
8343 if (Trace) {
Zachary Turner1fe2a8d2015-03-05 19:15:09 +00008344 llvm::sys::PrintStackTrace(OS);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008345 OS << "--------------------------------------------------\n";
8346 }
8347}
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008348
8349#ifdef CLANG_TOOL_EXTRA_BUILD
8350// This anchor is used to force the linker to link the clang-tidy plugin.
8351extern volatile int ClangTidyPluginAnchorSource;
8352static int LLVM_ATTRIBUTE_UNUSED ClangTidyPluginAnchorDestination =
8353 ClangTidyPluginAnchorSource;
Benjamin Kramer9eba7352016-11-17 15:22:36 +00008354
8355// This anchor is used to force the linker to link the clang-include-fixer
8356// plugin.
8357extern volatile int ClangIncludeFixerPluginAnchorSource;
8358static int LLVM_ATTRIBUTE_UNUSED ClangIncludeFixerPluginAnchorDestination =
8359 ClangIncludeFixerPluginAnchorSource;
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008360#endif