blob: f4f9c16225d4f367af510d83f58d0e39bcb31794 [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
15#include "CIndexer.h"
16#include "CIndexDiagnostic.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"
Guy Benyei11169dd2012-12-18 14:30:41 +000029#include "clang/Basic/Version.h"
30#include "clang/Frontend/ASTUnit.h"
31#include "clang/Frontend/CompilerInstance.h"
32#include "clang/Frontend/FrontendDiagnostic.h"
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +000033#include "clang/Index/CodegenNameGenerator.h"
Dmitri Gribenko9e605112013-11-13 22:16:51 +000034#include "clang/Index/CommentToXML.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000035#include "clang/Lex/HeaderSearch.h"
36#include "clang/Lex/Lexer.h"
37#include "clang/Lex/PreprocessingRecord.h"
38#include "clang/Lex/Preprocessor.h"
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000039#include "clang/Serialization/SerializationDiagnostic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000040#include "llvm/ADT/Optional.h"
41#include "llvm/ADT/STLExtras.h"
42#include "llvm/ADT/StringSwitch.h"
Alp Toker1d257e12014-06-04 03:28:55 +000043#include "llvm/Config/llvm-config.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000044#include "llvm/Support/Compiler.h"
45#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000046#include "llvm/Support/Format.h"
Chandler Carruth37ad2582014-06-27 15:14:39 +000047#include "llvm/Support/ManagedStatic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000048#include "llvm/Support/MemoryBuffer.h"
49#include "llvm/Support/Mutex.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000050#include "llvm/Support/Program.h"
51#include "llvm/Support/SaveAndRestore.h"
52#include "llvm/Support/Signals.h"
Adrian Prantlbc068582015-07-08 01:00:30 +000053#include "llvm/Support/TargetSelect.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000054#include "llvm/Support/Threading.h"
55#include "llvm/Support/Timer.h"
56#include "llvm/Support/raw_ostream.h"
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000057
Alp Toker1a86ad22014-07-06 06:24:00 +000058#if LLVM_ENABLE_THREADS != 0 && defined(__APPLE__)
59#define USE_DARWIN_THREADS
60#endif
61
62#ifdef USE_DARWIN_THREADS
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000063#include <pthread.h>
64#endif
Guy Benyei11169dd2012-12-18 14:30:41 +000065
66using namespace clang;
67using namespace clang::cxcursor;
Guy Benyei11169dd2012-12-18 14:30:41 +000068using namespace clang::cxtu;
69using namespace clang::cxindex;
70
Dmitri Gribenkod36209e2013-01-26 21:32:42 +000071CXTranslationUnit cxtu::MakeCXTranslationUnit(CIndexer *CIdx, ASTUnit *AU) {
72 if (!AU)
Craig Topper69186e72014-06-08 08:38:04 +000073 return nullptr;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000074 assert(CIdx);
Guy Benyei11169dd2012-12-18 14:30:41 +000075 CXTranslationUnit D = new CXTranslationUnitImpl();
76 D->CIdx = CIdx;
Dmitri Gribenkod36209e2013-01-26 21:32:42 +000077 D->TheASTUnit = AU;
Dmitri Gribenko74895212013-02-03 13:52:47 +000078 D->StringPool = new cxstring::CXStringPool();
Craig Topper69186e72014-06-08 08:38:04 +000079 D->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +000080 D->OverridenCursorsPool = createOverridenCXCursorsPool();
Craig Topper69186e72014-06-08 08:38:04 +000081 D->CommentToXML = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +000082 return D;
83}
84
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000085bool cxtu::isASTReadError(ASTUnit *AU) {
86 for (ASTUnit::stored_diag_iterator D = AU->stored_diag_begin(),
87 DEnd = AU->stored_diag_end();
88 D != DEnd; ++D) {
89 if (D->getLevel() >= DiagnosticsEngine::Error &&
90 DiagnosticIDs::getCategoryNumberForDiag(D->getID()) ==
91 diag::DiagCat_AST_Deserialization_Issue)
92 return true;
93 }
94 return false;
95}
96
Guy Benyei11169dd2012-12-18 14:30:41 +000097cxtu::CXTUOwner::~CXTUOwner() {
98 if (TU)
99 clang_disposeTranslationUnit(TU);
100}
101
102/// \brief Compare two source ranges to determine their relative position in
103/// the translation unit.
104static RangeComparisonResult RangeCompare(SourceManager &SM,
105 SourceRange R1,
106 SourceRange R2) {
107 assert(R1.isValid() && "First range is invalid?");
108 assert(R2.isValid() && "Second range is invalid?");
109 if (R1.getEnd() != R2.getBegin() &&
110 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
111 return RangeBefore;
112 if (R2.getEnd() != R1.getBegin() &&
113 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
114 return RangeAfter;
115 return RangeOverlap;
116}
117
118/// \brief Determine if a source location falls within, before, or after a
119/// a given source range.
120static RangeComparisonResult LocationCompare(SourceManager &SM,
121 SourceLocation L, SourceRange R) {
122 assert(R.isValid() && "First range is invalid?");
123 assert(L.isValid() && "Second range is invalid?");
124 if (L == R.getBegin() || L == R.getEnd())
125 return RangeOverlap;
126 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
127 return RangeBefore;
128 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
129 return RangeAfter;
130 return RangeOverlap;
131}
132
133/// \brief Translate a Clang source range into a CIndex source range.
134///
135/// Clang internally represents ranges where the end location points to the
136/// start of the token at the end. However, for external clients it is more
137/// useful to have a CXSourceRange be a proper half-open interval. This routine
138/// does the appropriate translation.
139CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
140 const LangOptions &LangOpts,
141 const CharSourceRange &R) {
142 // We want the last character in this location, so we will adjust the
143 // location accordingly.
144 SourceLocation EndLoc = R.getEnd();
145 if (EndLoc.isValid() && EndLoc.isMacroID() && !SM.isMacroArgExpansion(EndLoc))
146 EndLoc = SM.getExpansionRange(EndLoc).second;
Yaron Keren8b563662015-10-03 10:46:20 +0000147 if (R.isTokenRange() && EndLoc.isValid()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000148 unsigned Length = Lexer::MeasureTokenLength(SM.getSpellingLoc(EndLoc),
149 SM, LangOpts);
150 EndLoc = EndLoc.getLocWithOffset(Length);
151 }
152
Bill Wendlingeade3622013-01-23 08:25:41 +0000153 CXSourceRange Result = {
Dmitri Gribenkof9304482013-01-23 15:56:07 +0000154 { &SM, &LangOpts },
Bill Wendlingeade3622013-01-23 08:25:41 +0000155 R.getBegin().getRawEncoding(),
156 EndLoc.getRawEncoding()
157 };
Guy Benyei11169dd2012-12-18 14:30:41 +0000158 return Result;
159}
160
161//===----------------------------------------------------------------------===//
162// Cursor visitor.
163//===----------------------------------------------------------------------===//
164
165static SourceRange getRawCursorExtent(CXCursor C);
166static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
167
168
169RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
170 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
171}
172
173/// \brief Visit the given cursor and, if requested by the visitor,
174/// its children.
175///
176/// \param Cursor the cursor to visit.
177///
178/// \param CheckedRegionOfInterest if true, then the caller already checked
179/// that this cursor is within the region of interest.
180///
181/// \returns true if the visitation should be aborted, false if it
182/// should continue.
183bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
184 if (clang_isInvalid(Cursor.kind))
185 return false;
186
187 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000188 const Decl *D = getCursorDecl(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +0000189 if (!D) {
190 assert(0 && "Invalid declaration cursor");
191 return true; // abort.
192 }
193
194 // Ignore implicit declarations, unless it's an objc method because
195 // currently we should report implicit methods for properties when indexing.
196 if (D->isImplicit() && !isa<ObjCMethodDecl>(D))
197 return false;
198 }
199
200 // If we have a range of interest, and this cursor doesn't intersect with it,
201 // we're done.
202 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
203 SourceRange Range = getRawCursorExtent(Cursor);
204 if (Range.isInvalid() || CompareRegionOfInterest(Range))
205 return false;
206 }
207
208 switch (Visitor(Cursor, Parent, ClientData)) {
209 case CXChildVisit_Break:
210 return true;
211
212 case CXChildVisit_Continue:
213 return false;
214
215 case CXChildVisit_Recurse: {
216 bool ret = VisitChildren(Cursor);
217 if (PostChildrenVisitor)
218 if (PostChildrenVisitor(Cursor, ClientData))
219 return true;
220 return ret;
221 }
222 }
223
224 llvm_unreachable("Invalid CXChildVisitResult!");
225}
226
227static bool visitPreprocessedEntitiesInRange(SourceRange R,
228 PreprocessingRecord &PPRec,
229 CursorVisitor &Visitor) {
230 SourceManager &SM = Visitor.getASTUnit()->getSourceManager();
231 FileID FID;
232
233 if (!Visitor.shouldVisitIncludedEntities()) {
234 // If the begin/end of the range lie in the same FileID, do the optimization
235 // where we skip preprocessed entities that do not come from the same FileID.
236 FID = SM.getFileID(SM.getFileLoc(R.getBegin()));
237 if (FID != SM.getFileID(SM.getFileLoc(R.getEnd())))
238 FID = FileID();
239 }
240
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000241 const auto &Entities = PPRec.getPreprocessedEntitiesInRange(R);
242 return Visitor.visitPreprocessedEntities(Entities.begin(), Entities.end(),
Guy Benyei11169dd2012-12-18 14:30:41 +0000243 PPRec, FID);
244}
245
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000246bool CursorVisitor::visitFileRegion() {
Guy Benyei11169dd2012-12-18 14:30:41 +0000247 if (RegionOfInterest.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000248 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000249
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000250 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000251 SourceManager &SM = Unit->getSourceManager();
252
253 std::pair<FileID, unsigned>
254 Begin = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getBegin())),
255 End = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getEnd()));
256
257 if (End.first != Begin.first) {
258 // If the end does not reside in the same file, try to recover by
259 // picking the end of the file of begin location.
260 End.first = Begin.first;
261 End.second = SM.getFileIDSize(Begin.first);
262 }
263
264 assert(Begin.first == End.first);
265 if (Begin.second > End.second)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000266 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000267
268 FileID File = Begin.first;
269 unsigned Offset = Begin.second;
270 unsigned Length = End.second - Begin.second;
271
272 if (!VisitDeclsOnly && !VisitPreprocessorLast)
273 if (visitPreprocessedEntitiesInRegion())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000274 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000275
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000276 if (visitDeclsFromFileRegion(File, Offset, Length))
277 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000278
279 if (!VisitDeclsOnly && VisitPreprocessorLast)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000280 return visitPreprocessedEntitiesInRegion();
281
282 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000283}
284
285static bool isInLexicalContext(Decl *D, DeclContext *DC) {
286 if (!DC)
287 return false;
288
289 for (DeclContext *DeclDC = D->getLexicalDeclContext();
290 DeclDC; DeclDC = DeclDC->getLexicalParent()) {
291 if (DeclDC == DC)
292 return true;
293 }
294 return false;
295}
296
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000297bool CursorVisitor::visitDeclsFromFileRegion(FileID File,
Guy Benyei11169dd2012-12-18 14:30:41 +0000298 unsigned Offset, unsigned Length) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000299 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000300 SourceManager &SM = Unit->getSourceManager();
301 SourceRange Range = RegionOfInterest;
302
303 SmallVector<Decl *, 16> Decls;
304 Unit->findFileRegionDecls(File, Offset, Length, Decls);
305
306 // If we didn't find any file level decls for the file, try looking at the
307 // file that it was included from.
308 while (Decls.empty() || Decls.front()->isTopLevelDeclInObjCContainer()) {
309 bool Invalid = false;
310 const SrcMgr::SLocEntry &SLEntry = SM.getSLocEntry(File, &Invalid);
311 if (Invalid)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000312 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000313
314 SourceLocation Outer;
315 if (SLEntry.isFile())
316 Outer = SLEntry.getFile().getIncludeLoc();
317 else
318 Outer = SLEntry.getExpansion().getExpansionLocStart();
319 if (Outer.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000320 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000321
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000322 std::tie(File, Offset) = SM.getDecomposedExpansionLoc(Outer);
Guy Benyei11169dd2012-12-18 14:30:41 +0000323 Length = 0;
324 Unit->findFileRegionDecls(File, Offset, Length, Decls);
325 }
326
327 assert(!Decls.empty());
328
329 bool VisitedAtLeastOnce = false;
Craig Topper69186e72014-06-08 08:38:04 +0000330 DeclContext *CurDC = nullptr;
Craig Topper2341c0d2013-07-04 03:08:24 +0000331 SmallVectorImpl<Decl *>::iterator DIt = Decls.begin();
332 for (SmallVectorImpl<Decl *>::iterator DE = Decls.end(); DIt != DE; ++DIt) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000333 Decl *D = *DIt;
334 if (D->getSourceRange().isInvalid())
335 continue;
336
337 if (isInLexicalContext(D, CurDC))
338 continue;
339
340 CurDC = dyn_cast<DeclContext>(D);
341
342 if (TagDecl *TD = dyn_cast<TagDecl>(D))
343 if (!TD->isFreeStanding())
344 continue;
345
346 RangeComparisonResult CompRes = RangeCompare(SM, D->getSourceRange(),Range);
347 if (CompRes == RangeBefore)
348 continue;
349 if (CompRes == RangeAfter)
350 break;
351
352 assert(CompRes == RangeOverlap);
353 VisitedAtLeastOnce = true;
354
355 if (isa<ObjCContainerDecl>(D)) {
356 FileDI_current = &DIt;
357 FileDE_current = DE;
358 } else {
Craig Topper69186e72014-06-08 08:38:04 +0000359 FileDI_current = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000360 }
361
362 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000363 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000364 }
365
366 if (VisitedAtLeastOnce)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000367 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000368
369 // No Decls overlapped with the range. Move up the lexical context until there
370 // is a context that contains the range or we reach the translation unit
371 // level.
372 DeclContext *DC = DIt == Decls.begin() ? (*DIt)->getLexicalDeclContext()
373 : (*(DIt-1))->getLexicalDeclContext();
374
375 while (DC && !DC->isTranslationUnit()) {
376 Decl *D = cast<Decl>(DC);
377 SourceRange CurDeclRange = D->getSourceRange();
378 if (CurDeclRange.isInvalid())
379 break;
380
381 if (RangeCompare(SM, CurDeclRange, Range) == RangeOverlap) {
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000382 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
383 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000384 }
385
386 DC = D->getLexicalDeclContext();
387 }
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000388
389 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000390}
391
392bool CursorVisitor::visitPreprocessedEntitiesInRegion() {
393 if (!AU->getPreprocessor().getPreprocessingRecord())
394 return false;
395
396 PreprocessingRecord &PPRec
397 = *AU->getPreprocessor().getPreprocessingRecord();
398 SourceManager &SM = AU->getSourceManager();
399
400 if (RegionOfInterest.isValid()) {
401 SourceRange MappedRange = AU->mapRangeToPreamble(RegionOfInterest);
402 SourceLocation B = MappedRange.getBegin();
403 SourceLocation E = MappedRange.getEnd();
404
405 if (AU->isInPreambleFileID(B)) {
406 if (SM.isLoadedSourceLocation(E))
407 return visitPreprocessedEntitiesInRange(SourceRange(B, E),
408 PPRec, *this);
409
410 // Beginning of range lies in the preamble but it also extends beyond
411 // it into the main file. Split the range into 2 parts, one covering
412 // the preamble and another covering the main file. This allows subsequent
413 // calls to visitPreprocessedEntitiesInRange to accept a source range that
414 // lies in the same FileID, allowing it to skip preprocessed entities that
415 // do not come from the same FileID.
416 bool breaked =
417 visitPreprocessedEntitiesInRange(
418 SourceRange(B, AU->getEndOfPreambleFileID()),
419 PPRec, *this);
420 if (breaked) return true;
421 return visitPreprocessedEntitiesInRange(
422 SourceRange(AU->getStartOfMainFileID(), E),
423 PPRec, *this);
424 }
425
426 return visitPreprocessedEntitiesInRange(SourceRange(B, E), PPRec, *this);
427 }
428
429 bool OnlyLocalDecls
430 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
431
432 if (OnlyLocalDecls)
433 return visitPreprocessedEntities(PPRec.local_begin(), PPRec.local_end(),
434 PPRec);
435
436 return visitPreprocessedEntities(PPRec.begin(), PPRec.end(), PPRec);
437}
438
439template<typename InputIterator>
440bool CursorVisitor::visitPreprocessedEntities(InputIterator First,
441 InputIterator Last,
442 PreprocessingRecord &PPRec,
443 FileID FID) {
444 for (; First != Last; ++First) {
445 if (!FID.isInvalid() && !PPRec.isEntityInFileID(First, FID))
446 continue;
447
448 PreprocessedEntity *PPE = *First;
Argyrios Kyrtzidis1030f262013-05-07 20:37:17 +0000449 if (!PPE)
450 continue;
451
Guy Benyei11169dd2012-12-18 14:30:41 +0000452 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(PPE)) {
453 if (Visit(MakeMacroExpansionCursor(ME, TU)))
454 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000455
Guy Benyei11169dd2012-12-18 14:30:41 +0000456 continue;
457 }
Richard Smith66a81862015-05-04 02:25:31 +0000458
459 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(PPE)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000460 if (Visit(MakeMacroDefinitionCursor(MD, TU)))
461 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000462
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 continue;
464 }
465
466 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
467 if (Visit(MakeInclusionDirectiveCursor(ID, TU)))
468 return true;
469
470 continue;
471 }
472 }
473
474 return false;
475}
476
477/// \brief Visit the children of the given cursor.
478///
479/// \returns true if the visitation should be aborted, false if it
480/// should continue.
481bool CursorVisitor::VisitChildren(CXCursor Cursor) {
482 if (clang_isReference(Cursor.kind) &&
483 Cursor.kind != CXCursor_CXXBaseSpecifier) {
484 // By definition, references have no children.
485 return false;
486 }
487
488 // Set the Parent field to Cursor, then back to its old value once we're
489 // done.
490 SetParentRAII SetParent(Parent, StmtParent, Cursor);
491
492 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000493 Decl *D = const_cast<Decl *>(getCursorDecl(Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +0000494 if (!D)
495 return false;
496
497 return VisitAttributes(D) || Visit(D);
498 }
499
500 if (clang_isStatement(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000501 if (const Stmt *S = getCursorStmt(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000502 return Visit(S);
503
504 return false;
505 }
506
507 if (clang_isExpression(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000508 if (const Expr *E = getCursorExpr(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000509 return Visit(E);
510
511 return false;
512 }
513
514 if (clang_isTranslationUnit(Cursor.kind)) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000515 CXTranslationUnit TU = getCursorTU(Cursor);
516 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000517
518 int VisitOrder[2] = { VisitPreprocessorLast, !VisitPreprocessorLast };
519 for (unsigned I = 0; I != 2; ++I) {
520 if (VisitOrder[I]) {
521 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
522 RegionOfInterest.isInvalid()) {
523 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
524 TLEnd = CXXUnit->top_level_end();
525 TL != TLEnd; ++TL) {
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000526 const Optional<bool> V = handleDeclForVisitation(*TL);
527 if (!V.hasValue())
528 continue;
529 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000530 }
531 } else if (VisitDeclContext(
532 CXXUnit->getASTContext().getTranslationUnitDecl()))
533 return true;
534 continue;
535 }
536
537 // Walk the preprocessing record.
538 if (CXXUnit->getPreprocessor().getPreprocessingRecord())
539 visitPreprocessedEntitiesInRegion();
540 }
541
542 return false;
543 }
544
545 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000546 if (const CXXBaseSpecifier *Base = getCursorCXXBaseSpecifier(Cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000547 if (TypeSourceInfo *BaseTSInfo = Base->getTypeSourceInfo()) {
548 return Visit(BaseTSInfo->getTypeLoc());
549 }
550 }
551 }
552
553 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +0000554 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +0000555 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(Cursor));
Richard Smithb1f9a282013-10-31 01:56:18 +0000556 if (const ObjCObjectType *ObjT = A->getInterface()->getAs<ObjCObjectType>())
Richard Smithb87c4652013-10-31 21:23:20 +0000557 return Visit(cxcursor::MakeCursorObjCClassRef(
558 ObjT->getInterface(),
559 A->getInterfaceLoc()->getTypeLoc().getLocStart(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +0000560 }
561
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000562 // If pointing inside a macro definition, check if the token is an identifier
563 // that was ever defined as a macro. In such a case, create a "pseudo" macro
564 // expansion cursor for that token.
565 SourceLocation BeginLoc = RegionOfInterest.getBegin();
566 if (Cursor.kind == CXCursor_MacroDefinition &&
567 BeginLoc == RegionOfInterest.getEnd()) {
568 SourceLocation Loc = AU->mapLocationToPreamble(BeginLoc);
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000569 const MacroInfo *MI =
570 getMacroInfo(cxcursor::getCursorMacroDefinition(Cursor), TU);
Richard Smith66a81862015-05-04 02:25:31 +0000571 if (MacroDefinitionRecord *MacroDef =
572 checkForMacroInMacroDefinition(MI, Loc, TU))
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000573 return Visit(cxcursor::MakeMacroExpansionCursor(MacroDef, BeginLoc, TU));
574 }
575
Guy Benyei11169dd2012-12-18 14:30:41 +0000576 // Nothing to visit at the moment.
577 return false;
578}
579
580bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
581 if (TypeSourceInfo *TSInfo = B->getSignatureAsWritten())
582 if (Visit(TSInfo->getTypeLoc()))
583 return true;
584
585 if (Stmt *Body = B->getBody())
586 return Visit(MakeCXCursor(Body, StmtParent, TU, RegionOfInterest));
587
588 return false;
589}
590
Ted Kremenek03325582013-02-21 01:29:01 +0000591Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000592 if (RegionOfInterest.isValid()) {
593 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
594 if (Range.isInvalid())
David Blaikie7a30dc52013-02-21 01:47:18 +0000595 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000596
597 switch (CompareRegionOfInterest(Range)) {
598 case RangeBefore:
599 // This declaration comes before the region of interest; skip it.
David Blaikie7a30dc52013-02-21 01:47:18 +0000600 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000601
602 case RangeAfter:
603 // This declaration comes after the region of interest; we're done.
604 return false;
605
606 case RangeOverlap:
607 // This declaration overlaps the region of interest; visit it.
608 break;
609 }
610 }
611 return true;
612}
613
614bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
615 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
616
617 // FIXME: Eventually remove. This part of a hack to support proper
618 // iteration over all Decls contained lexically within an ObjC container.
619 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
620 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
621
622 for ( ; I != E; ++I) {
623 Decl *D = *I;
624 if (D->getLexicalDeclContext() != DC)
625 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000626 const Optional<bool> V = handleDeclForVisitation(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000627 if (!V.hasValue())
628 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000629 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000630 }
631 return false;
632}
633
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000634Optional<bool> CursorVisitor::handleDeclForVisitation(const Decl *D) {
635 CXCursor Cursor = MakeCXCursor(D, TU, RegionOfInterest);
636
637 // Ignore synthesized ivars here, otherwise if we have something like:
638 // @synthesize prop = _prop;
639 // and '_prop' is not declared, we will encounter a '_prop' ivar before
640 // encountering the 'prop' synthesize declaration and we will think that
641 // we passed the region-of-interest.
642 if (auto *ivarD = dyn_cast<ObjCIvarDecl>(D)) {
643 if (ivarD->getSynthesize())
644 return None;
645 }
646
647 // FIXME: ObjCClassRef/ObjCProtocolRef for forward class/protocol
648 // declarations is a mismatch with the compiler semantics.
649 if (Cursor.kind == CXCursor_ObjCInterfaceDecl) {
650 auto *ID = cast<ObjCInterfaceDecl>(D);
651 if (!ID->isThisDeclarationADefinition())
652 Cursor = MakeCursorObjCClassRef(ID, ID->getLocation(), TU);
653
654 } else if (Cursor.kind == CXCursor_ObjCProtocolDecl) {
655 auto *PD = cast<ObjCProtocolDecl>(D);
656 if (!PD->isThisDeclarationADefinition())
657 Cursor = MakeCursorObjCProtocolRef(PD, PD->getLocation(), TU);
658 }
659
660 const Optional<bool> V = shouldVisitCursor(Cursor);
661 if (!V.hasValue())
662 return None;
663 if (!V.getValue())
664 return false;
665 if (Visit(Cursor, true))
666 return true;
667 return None;
668}
669
Guy Benyei11169dd2012-12-18 14:30:41 +0000670bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
671 llvm_unreachable("Translation units are visited directly by Visit()");
672}
673
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +0000674bool CursorVisitor::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
675 if (VisitTemplateParameters(D->getTemplateParameters()))
676 return true;
677
678 return Visit(MakeCXCursor(D->getTemplatedDecl(), TU, RegionOfInterest));
679}
680
Guy Benyei11169dd2012-12-18 14:30:41 +0000681bool CursorVisitor::VisitTypeAliasDecl(TypeAliasDecl *D) {
682 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
683 return Visit(TSInfo->getTypeLoc());
684
685 return false;
686}
687
688bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
689 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
690 return Visit(TSInfo->getTypeLoc());
691
692 return false;
693}
694
695bool CursorVisitor::VisitTagDecl(TagDecl *D) {
696 return VisitDeclContext(D);
697}
698
699bool CursorVisitor::VisitClassTemplateSpecializationDecl(
700 ClassTemplateSpecializationDecl *D) {
701 bool ShouldVisitBody = false;
702 switch (D->getSpecializationKind()) {
703 case TSK_Undeclared:
704 case TSK_ImplicitInstantiation:
705 // Nothing to visit
706 return false;
707
708 case TSK_ExplicitInstantiationDeclaration:
709 case TSK_ExplicitInstantiationDefinition:
710 break;
711
712 case TSK_ExplicitSpecialization:
713 ShouldVisitBody = true;
714 break;
715 }
716
717 // Visit the template arguments used in the specialization.
718 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
719 TypeLoc TL = SpecType->getTypeLoc();
David Blaikie6adc78e2013-02-18 22:06:02 +0000720 if (TemplateSpecializationTypeLoc TSTLoc =
721 TL.getAs<TemplateSpecializationTypeLoc>()) {
722 for (unsigned I = 0, N = TSTLoc.getNumArgs(); I != N; ++I)
723 if (VisitTemplateArgumentLoc(TSTLoc.getArgLoc(I)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000724 return true;
725 }
726 }
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000727
728 return ShouldVisitBody && VisitCXXRecordDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000729}
730
731bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
732 ClassTemplatePartialSpecializationDecl *D) {
733 // FIXME: Visit the "outer" template parameter lists on the TagDecl
734 // before visiting these template parameters.
735 if (VisitTemplateParameters(D->getTemplateParameters()))
736 return true;
737
738 // Visit the partial specialization arguments.
Enea Zaffanella6dbe1872013-08-10 07:24:53 +0000739 const ASTTemplateArgumentListInfo *Info = D->getTemplateArgsAsWritten();
740 const TemplateArgumentLoc *TemplateArgs = Info->getTemplateArgs();
741 for (unsigned I = 0, N = Info->NumTemplateArgs; I != N; ++I)
Guy Benyei11169dd2012-12-18 14:30:41 +0000742 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
743 return true;
744
745 return VisitCXXRecordDecl(D);
746}
747
748bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
749 // Visit the default argument.
750 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
751 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
752 if (Visit(DefArg->getTypeLoc()))
753 return true;
754
755 return false;
756}
757
758bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
759 if (Expr *Init = D->getInitExpr())
760 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
761 return false;
762}
763
764bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000765 unsigned NumParamList = DD->getNumTemplateParameterLists();
766 for (unsigned i = 0; i < NumParamList; i++) {
767 TemplateParameterList* Params = DD->getTemplateParameterList(i);
768 if (VisitTemplateParameters(Params))
769 return true;
770 }
771
Guy Benyei11169dd2012-12-18 14:30:41 +0000772 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
773 if (Visit(TSInfo->getTypeLoc()))
774 return true;
775
776 // Visit the nested-name-specifier, if present.
777 if (NestedNameSpecifierLoc QualifierLoc = DD->getQualifierLoc())
778 if (VisitNestedNameSpecifierLoc(QualifierLoc))
779 return true;
780
781 return false;
782}
783
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000784/// \brief Compare two base or member initializers based on their source order.
785static int CompareCXXCtorInitializers(CXXCtorInitializer *const *X,
786 CXXCtorInitializer *const *Y) {
787 return (*X)->getSourceOrder() - (*Y)->getSourceOrder();
788}
789
Guy Benyei11169dd2012-12-18 14:30:41 +0000790bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000791 unsigned NumParamList = ND->getNumTemplateParameterLists();
792 for (unsigned i = 0; i < NumParamList; i++) {
793 TemplateParameterList* Params = ND->getTemplateParameterList(i);
794 if (VisitTemplateParameters(Params))
795 return true;
796 }
797
Guy Benyei11169dd2012-12-18 14:30:41 +0000798 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
799 // Visit the function declaration's syntactic components in the order
800 // written. This requires a bit of work.
801 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
David Blaikie6adc78e2013-02-18 22:06:02 +0000802 FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000803
804 // If we have a function declared directly (without the use of a typedef),
805 // visit just the return type. Otherwise, just visit the function's type
806 // now.
Alp Toker42a16a62014-01-25 23:51:36 +0000807 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL.getReturnLoc())) ||
Guy Benyei11169dd2012-12-18 14:30:41 +0000808 (!FTL && Visit(TL)))
809 return true;
810
811 // Visit the nested-name-specifier, if present.
812 if (NestedNameSpecifierLoc QualifierLoc = ND->getQualifierLoc())
813 if (VisitNestedNameSpecifierLoc(QualifierLoc))
814 return true;
815
816 // Visit the declaration name.
Argyrios Kyrtzidis4a4d2b42014-02-09 08:13:47 +0000817 if (!isa<CXXDestructorDecl>(ND))
818 if (VisitDeclarationNameInfo(ND->getNameInfo()))
819 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +0000820
821 // FIXME: Visit explicitly-specified template arguments!
822
823 // Visit the function parameters, if we have a function type.
David Blaikie6adc78e2013-02-18 22:06:02 +0000824 if (FTL && VisitFunctionTypeLoc(FTL, true))
Guy Benyei11169dd2012-12-18 14:30:41 +0000825 return true;
826
Bill Wendling44426052012-12-20 19:22:21 +0000827 // FIXME: Attributes?
Guy Benyei11169dd2012-12-18 14:30:41 +0000828 }
829
830 if (ND->doesThisDeclarationHaveABody() && !ND->isLateTemplateParsed()) {
831 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
832 // Find the initializers that were written in the source.
833 SmallVector<CXXCtorInitializer *, 4> WrittenInits;
Aaron Ballman0ad78302014-03-13 17:34:31 +0000834 for (auto *I : Constructor->inits()) {
835 if (!I->isWritten())
Guy Benyei11169dd2012-12-18 14:30:41 +0000836 continue;
837
Aaron Ballman0ad78302014-03-13 17:34:31 +0000838 WrittenInits.push_back(I);
Guy Benyei11169dd2012-12-18 14:30:41 +0000839 }
840
841 // Sort the initializers in source order
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000842 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
843 &CompareCXXCtorInitializers);
844
Guy Benyei11169dd2012-12-18 14:30:41 +0000845 // Visit the initializers in source order
846 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
847 CXXCtorInitializer *Init = WrittenInits[I];
848 if (Init->isAnyMemberInitializer()) {
849 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
850 Init->getMemberLocation(), TU)))
851 return true;
852 } else if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo()) {
853 if (Visit(TInfo->getTypeLoc()))
854 return true;
855 }
856
857 // Visit the initializer value.
858 if (Expr *Initializer = Init->getInit())
859 if (Visit(MakeCXCursor(Initializer, ND, TU, RegionOfInterest)))
860 return true;
861 }
862 }
863
864 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
865 return true;
866 }
867
868 return false;
869}
870
871bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
872 if (VisitDeclaratorDecl(D))
873 return true;
874
875 if (Expr *BitWidth = D->getBitWidth())
876 return Visit(MakeCXCursor(BitWidth, StmtParent, TU, RegionOfInterest));
877
878 return false;
879}
880
881bool CursorVisitor::VisitVarDecl(VarDecl *D) {
882 if (VisitDeclaratorDecl(D))
883 return true;
884
885 if (Expr *Init = D->getInit())
886 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
887
888 return false;
889}
890
891bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
892 if (VisitDeclaratorDecl(D))
893 return true;
894
895 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
896 if (Expr *DefArg = D->getDefaultArgument())
897 return Visit(MakeCXCursor(DefArg, StmtParent, TU, RegionOfInterest));
898
899 return false;
900}
901
902bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
903 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
904 // before visiting these template parameters.
905 if (VisitTemplateParameters(D->getTemplateParameters()))
906 return true;
907
908 return VisitFunctionDecl(D->getTemplatedDecl());
909}
910
911bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
912 // FIXME: Visit the "outer" template parameter lists on the TagDecl
913 // before visiting these template parameters.
914 if (VisitTemplateParameters(D->getTemplateParameters()))
915 return true;
916
917 return VisitCXXRecordDecl(D->getTemplatedDecl());
918}
919
920bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
921 if (VisitTemplateParameters(D->getTemplateParameters()))
922 return true;
923
924 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
925 VisitTemplateArgumentLoc(D->getDefaultArgument()))
926 return true;
927
928 return false;
929}
930
Douglas Gregor9bda6cf2015-07-07 03:58:14 +0000931bool CursorVisitor::VisitObjCTypeParamDecl(ObjCTypeParamDecl *D) {
932 // Visit the bound, if it's explicit.
933 if (D->hasExplicitBound()) {
934 if (auto TInfo = D->getTypeSourceInfo()) {
935 if (Visit(TInfo->getTypeLoc()))
936 return true;
937 }
938 }
939
940 return false;
941}
942
Guy Benyei11169dd2012-12-18 14:30:41 +0000943bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Alp Toker314cc812014-01-25 16:55:45 +0000944 if (TypeSourceInfo *TSInfo = ND->getReturnTypeSourceInfo())
Guy Benyei11169dd2012-12-18 14:30:41 +0000945 if (Visit(TSInfo->getTypeLoc()))
946 return true;
947
David Majnemer59f77922016-06-24 04:05:48 +0000948 for (const auto *P : ND->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000949 if (Visit(MakeCXCursor(P, TU, RegionOfInterest)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000950 return true;
951 }
952
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000953 return ND->isThisDeclarationADefinition() &&
954 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest));
Guy Benyei11169dd2012-12-18 14:30:41 +0000955}
956
957template <typename DeclIt>
958static void addRangedDeclsInContainer(DeclIt *DI_current, DeclIt DE_current,
959 SourceManager &SM, SourceLocation EndLoc,
960 SmallVectorImpl<Decl *> &Decls) {
961 DeclIt next = *DI_current;
962 while (++next != DE_current) {
963 Decl *D_next = *next;
964 if (!D_next)
965 break;
966 SourceLocation L = D_next->getLocStart();
967 if (!L.isValid())
968 break;
969 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
970 *DI_current = next;
971 Decls.push_back(D_next);
972 continue;
973 }
974 break;
975 }
976}
977
Guy Benyei11169dd2012-12-18 14:30:41 +0000978bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
979 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
980 // an @implementation can lexically contain Decls that are not properly
981 // nested in the AST. When we identify such cases, we need to retrofit
982 // this nesting here.
983 if (!DI_current && !FileDI_current)
984 return VisitDeclContext(D);
985
986 // Scan the Decls that immediately come after the container
987 // in the current DeclContext. If any fall within the
988 // container's lexical region, stash them into a vector
989 // for later processing.
990 SmallVector<Decl *, 24> DeclsInContainer;
991 SourceLocation EndLoc = D->getSourceRange().getEnd();
992 SourceManager &SM = AU->getSourceManager();
993 if (EndLoc.isValid()) {
994 if (DI_current) {
995 addRangedDeclsInContainer(DI_current, DE_current, SM, EndLoc,
996 DeclsInContainer);
997 } else {
998 addRangedDeclsInContainer(FileDI_current, FileDE_current, SM, EndLoc,
999 DeclsInContainer);
1000 }
1001 }
1002
1003 // The common case.
1004 if (DeclsInContainer.empty())
1005 return VisitDeclContext(D);
1006
1007 // Get all the Decls in the DeclContext, and sort them with the
1008 // additional ones we've collected. Then visit them.
Aaron Ballman629afae2014-03-07 19:56:05 +00001009 for (auto *SubDecl : D->decls()) {
1010 if (!SubDecl || SubDecl->getLexicalDeclContext() != D ||
1011 SubDecl->getLocStart().isInvalid())
Guy Benyei11169dd2012-12-18 14:30:41 +00001012 continue;
Aaron Ballman629afae2014-03-07 19:56:05 +00001013 DeclsInContainer.push_back(SubDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001014 }
1015
1016 // Now sort the Decls so that they appear in lexical order.
1017 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001018 [&SM](Decl *A, Decl *B) {
1019 SourceLocation L_A = A->getLocStart();
1020 SourceLocation L_B = B->getLocStart();
1021 assert(L_A.isValid() && L_B.isValid());
1022 return SM.isBeforeInTranslationUnit(L_A, L_B);
1023 });
Guy Benyei11169dd2012-12-18 14:30:41 +00001024
1025 // Now visit the decls.
1026 for (SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
1027 E = DeclsInContainer.end(); I != E; ++I) {
1028 CXCursor Cursor = MakeCXCursor(*I, TU, RegionOfInterest);
Ted Kremenek03325582013-02-21 01:29:01 +00001029 const Optional<bool> &V = shouldVisitCursor(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00001030 if (!V.hasValue())
1031 continue;
1032 if (!V.getValue())
1033 return false;
1034 if (Visit(Cursor, true))
1035 return true;
1036 }
1037 return false;
1038}
1039
1040bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
1041 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
1042 TU)))
1043 return true;
1044
Douglas Gregore9d95f12015-07-07 03:57:35 +00001045 if (VisitObjCTypeParamList(ND->getTypeParamList()))
1046 return true;
1047
Guy Benyei11169dd2012-12-18 14:30:41 +00001048 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
1049 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
1050 E = ND->protocol_end(); I != E; ++I, ++PL)
1051 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1052 return true;
1053
1054 return VisitObjCContainerDecl(ND);
1055}
1056
1057bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1058 if (!PID->isThisDeclarationADefinition())
1059 return Visit(MakeCursorObjCProtocolRef(PID, PID->getLocation(), TU));
1060
1061 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
1062 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
1063 E = PID->protocol_end(); I != E; ++I, ++PL)
1064 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1065 return true;
1066
1067 return VisitObjCContainerDecl(PID);
1068}
1069
1070bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
1071 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
1072 return true;
1073
1074 // FIXME: This implements a workaround with @property declarations also being
1075 // installed in the DeclContext for the @interface. Eventually this code
1076 // should be removed.
1077 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
1078 if (!CDecl || !CDecl->IsClassExtension())
1079 return false;
1080
1081 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
1082 if (!ID)
1083 return false;
1084
1085 IdentifierInfo *PropertyId = PD->getIdentifier();
1086 ObjCPropertyDecl *prevDecl =
Manman Ren5b786402016-01-28 18:49:28 +00001087 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId,
1088 PD->getQueryKind());
Guy Benyei11169dd2012-12-18 14:30:41 +00001089
1090 if (!prevDecl)
1091 return false;
1092
1093 // Visit synthesized methods since they will be skipped when visiting
1094 // the @interface.
1095 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
1096 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1097 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1098 return true;
1099
1100 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
1101 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1102 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1103 return true;
1104
1105 return false;
1106}
1107
Douglas Gregore9d95f12015-07-07 03:57:35 +00001108bool CursorVisitor::VisitObjCTypeParamList(ObjCTypeParamList *typeParamList) {
1109 if (!typeParamList)
1110 return false;
1111
1112 for (auto *typeParam : *typeParamList) {
1113 // Visit the type parameter.
1114 if (Visit(MakeCXCursor(typeParam, TU, RegionOfInterest)))
1115 return true;
Douglas Gregore9d95f12015-07-07 03:57:35 +00001116 }
1117
1118 return false;
1119}
1120
Guy Benyei11169dd2012-12-18 14:30:41 +00001121bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
1122 if (!D->isThisDeclarationADefinition()) {
1123 // Forward declaration is treated like a reference.
1124 return Visit(MakeCursorObjCClassRef(D, D->getLocation(), TU));
1125 }
1126
Douglas Gregore9d95f12015-07-07 03:57:35 +00001127 // Objective-C type parameters.
1128 if (VisitObjCTypeParamList(D->getTypeParamListAsWritten()))
1129 return true;
1130
Guy Benyei11169dd2012-12-18 14:30:41 +00001131 // Issue callbacks for super class.
1132 if (D->getSuperClass() &&
1133 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1134 D->getSuperClassLoc(),
1135 TU)))
1136 return true;
1137
Douglas Gregore9d95f12015-07-07 03:57:35 +00001138 if (TypeSourceInfo *SuperClassTInfo = D->getSuperClassTInfo())
1139 if (Visit(SuperClassTInfo->getTypeLoc()))
1140 return true;
1141
Guy Benyei11169dd2012-12-18 14:30:41 +00001142 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1143 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1144 E = D->protocol_end(); I != E; ++I, ++PL)
1145 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1146 return true;
1147
1148 return VisitObjCContainerDecl(D);
1149}
1150
1151bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1152 return VisitObjCContainerDecl(D);
1153}
1154
1155bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
1156 // 'ID' could be null when dealing with invalid code.
1157 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1158 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1159 return true;
1160
1161 return VisitObjCImplDecl(D);
1162}
1163
1164bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1165#if 0
1166 // Issue callbacks for super class.
1167 // FIXME: No source location information!
1168 if (D->getSuperClass() &&
1169 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1170 D->getSuperClassLoc(),
1171 TU)))
1172 return true;
1173#endif
1174
1175 return VisitObjCImplDecl(D);
1176}
1177
1178bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1179 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1180 if (PD->isIvarNameSpecified())
1181 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1182
1183 return false;
1184}
1185
1186bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1187 return VisitDeclContext(D);
1188}
1189
1190bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1191 // Visit nested-name-specifier.
1192 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1193 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1194 return true;
1195
1196 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1197 D->getTargetNameLoc(), TU));
1198}
1199
1200bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1201 // Visit nested-name-specifier.
1202 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1203 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1204 return true;
1205 }
1206
1207 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1208 return true;
1209
1210 return VisitDeclarationNameInfo(D->getNameInfo());
1211}
1212
1213bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1214 // Visit nested-name-specifier.
1215 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1216 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1217 return true;
1218
1219 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1220 D->getIdentLocation(), TU));
1221}
1222
1223bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1224 // Visit nested-name-specifier.
1225 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1226 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1227 return true;
1228 }
1229
1230 return VisitDeclarationNameInfo(D->getNameInfo());
1231}
1232
1233bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1234 UnresolvedUsingTypenameDecl *D) {
1235 // Visit nested-name-specifier.
1236 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1237 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1238 return true;
1239
1240 return false;
1241}
1242
Olivier Goffart81978012016-06-09 16:15:55 +00001243bool CursorVisitor::VisitStaticAssertDecl(StaticAssertDecl *D) {
1244 if (Visit(MakeCXCursor(D->getAssertExpr(), StmtParent, TU, RegionOfInterest)))
1245 return true;
1246 if (Visit(MakeCXCursor(D->getMessage(), StmtParent, TU, RegionOfInterest)))
1247 return true;
1248 return false;
1249}
1250
Guy Benyei11169dd2012-12-18 14:30:41 +00001251bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1252 switch (Name.getName().getNameKind()) {
1253 case clang::DeclarationName::Identifier:
1254 case clang::DeclarationName::CXXLiteralOperatorName:
1255 case clang::DeclarationName::CXXOperatorName:
1256 case clang::DeclarationName::CXXUsingDirective:
1257 return false;
1258
1259 case clang::DeclarationName::CXXConstructorName:
1260 case clang::DeclarationName::CXXDestructorName:
1261 case clang::DeclarationName::CXXConversionFunctionName:
1262 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1263 return Visit(TSInfo->getTypeLoc());
1264 return false;
1265
1266 case clang::DeclarationName::ObjCZeroArgSelector:
1267 case clang::DeclarationName::ObjCOneArgSelector:
1268 case clang::DeclarationName::ObjCMultiArgSelector:
1269 // FIXME: Per-identifier location info?
1270 return false;
1271 }
1272
1273 llvm_unreachable("Invalid DeclarationName::Kind!");
1274}
1275
1276bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1277 SourceRange Range) {
1278 // FIXME: This whole routine is a hack to work around the lack of proper
1279 // source information in nested-name-specifiers (PR5791). Since we do have
1280 // a beginning source location, we can visit the first component of the
1281 // nested-name-specifier, if it's a single-token component.
1282 if (!NNS)
1283 return false;
1284
1285 // Get the first component in the nested-name-specifier.
1286 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1287 NNS = Prefix;
1288
1289 switch (NNS->getKind()) {
1290 case NestedNameSpecifier::Namespace:
1291 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1292 TU));
1293
1294 case NestedNameSpecifier::NamespaceAlias:
1295 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1296 Range.getBegin(), TU));
1297
1298 case NestedNameSpecifier::TypeSpec: {
1299 // If the type has a form where we know that the beginning of the source
1300 // range matches up with a reference cursor. Visit the appropriate reference
1301 // cursor.
1302 const Type *T = NNS->getAsType();
1303 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1304 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1305 if (const TagType *Tag = dyn_cast<TagType>(T))
1306 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1307 if (const TemplateSpecializationType *TST
1308 = dyn_cast<TemplateSpecializationType>(T))
1309 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1310 break;
1311 }
1312
1313 case NestedNameSpecifier::TypeSpecWithTemplate:
1314 case NestedNameSpecifier::Global:
1315 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001316 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001317 break;
1318 }
1319
1320 return false;
1321}
1322
1323bool
1324CursorVisitor::VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1325 SmallVector<NestedNameSpecifierLoc, 4> Qualifiers;
1326 for (; Qualifier; Qualifier = Qualifier.getPrefix())
1327 Qualifiers.push_back(Qualifier);
1328
1329 while (!Qualifiers.empty()) {
1330 NestedNameSpecifierLoc Q = Qualifiers.pop_back_val();
1331 NestedNameSpecifier *NNS = Q.getNestedNameSpecifier();
1332 switch (NNS->getKind()) {
1333 case NestedNameSpecifier::Namespace:
1334 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(),
1335 Q.getLocalBeginLoc(),
1336 TU)))
1337 return true;
1338
1339 break;
1340
1341 case NestedNameSpecifier::NamespaceAlias:
1342 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1343 Q.getLocalBeginLoc(),
1344 TU)))
1345 return true;
1346
1347 break;
1348
1349 case NestedNameSpecifier::TypeSpec:
1350 case NestedNameSpecifier::TypeSpecWithTemplate:
1351 if (Visit(Q.getTypeLoc()))
1352 return true;
1353
1354 break;
1355
1356 case NestedNameSpecifier::Global:
1357 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001358 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001359 break;
1360 }
1361 }
1362
1363 return false;
1364}
1365
1366bool CursorVisitor::VisitTemplateParameters(
1367 const TemplateParameterList *Params) {
1368 if (!Params)
1369 return false;
1370
1371 for (TemplateParameterList::const_iterator P = Params->begin(),
1372 PEnd = Params->end();
1373 P != PEnd; ++P) {
1374 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
1375 return true;
1376 }
1377
1378 return false;
1379}
1380
1381bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1382 switch (Name.getKind()) {
1383 case TemplateName::Template:
1384 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1385
1386 case TemplateName::OverloadedTemplate:
1387 // Visit the overloaded template set.
1388 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1389 return true;
1390
1391 return false;
1392
1393 case TemplateName::DependentTemplate:
1394 // FIXME: Visit nested-name-specifier.
1395 return false;
1396
1397 case TemplateName::QualifiedTemplate:
1398 // FIXME: Visit nested-name-specifier.
1399 return Visit(MakeCursorTemplateRef(
1400 Name.getAsQualifiedTemplateName()->getDecl(),
1401 Loc, TU));
1402
1403 case TemplateName::SubstTemplateTemplateParm:
1404 return Visit(MakeCursorTemplateRef(
1405 Name.getAsSubstTemplateTemplateParm()->getParameter(),
1406 Loc, TU));
1407
1408 case TemplateName::SubstTemplateTemplateParmPack:
1409 return Visit(MakeCursorTemplateRef(
1410 Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1411 Loc, TU));
1412 }
1413
1414 llvm_unreachable("Invalid TemplateName::Kind!");
1415}
1416
1417bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1418 switch (TAL.getArgument().getKind()) {
1419 case TemplateArgument::Null:
1420 case TemplateArgument::Integral:
1421 case TemplateArgument::Pack:
1422 return false;
1423
1424 case TemplateArgument::Type:
1425 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1426 return Visit(TSInfo->getTypeLoc());
1427 return false;
1428
1429 case TemplateArgument::Declaration:
1430 if (Expr *E = TAL.getSourceDeclExpression())
1431 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1432 return false;
1433
1434 case TemplateArgument::NullPtr:
1435 if (Expr *E = TAL.getSourceNullPtrExpression())
1436 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1437 return false;
1438
1439 case TemplateArgument::Expression:
1440 if (Expr *E = TAL.getSourceExpression())
1441 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1442 return false;
1443
1444 case TemplateArgument::Template:
1445 case TemplateArgument::TemplateExpansion:
1446 if (VisitNestedNameSpecifierLoc(TAL.getTemplateQualifierLoc()))
1447 return true;
1448
1449 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
1450 TAL.getTemplateNameLoc());
1451 }
1452
1453 llvm_unreachable("Invalid TemplateArgument::Kind!");
1454}
1455
1456bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1457 return VisitDeclContext(D);
1458}
1459
1460bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1461 return Visit(TL.getUnqualifiedLoc());
1462}
1463
1464bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1465 ASTContext &Context = AU->getASTContext();
1466
1467 // Some builtin types (such as Objective-C's "id", "sel", and
1468 // "Class") have associated declarations. Create cursors for those.
1469 QualType VisitType;
1470 switch (TL.getTypePtr()->getKind()) {
1471
1472 case BuiltinType::Void:
1473 case BuiltinType::NullPtr:
1474 case BuiltinType::Dependent:
Alexey Bader954ba212016-04-08 13:40:33 +00001475#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1476 case BuiltinType::Id:
Alexey Baderb62f1442016-04-13 08:33:41 +00001477#include "clang/Basic/OpenCLImageTypes.def"
NAKAMURA Takumi288c42e2013-02-07 12:47:42 +00001478 case BuiltinType::OCLSampler:
Guy Benyei1b4fb3e2013-01-20 12:31:11 +00001479 case BuiltinType::OCLEvent:
Alexey Bader9c8453f2015-09-15 11:18:52 +00001480 case BuiltinType::OCLClkEvent:
1481 case BuiltinType::OCLQueue:
1482 case BuiltinType::OCLNDRange:
1483 case BuiltinType::OCLReserveID:
Guy Benyei11169dd2012-12-18 14:30:41 +00001484#define BUILTIN_TYPE(Id, SingletonId)
1485#define SIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1486#define UNSIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1487#define FLOATING_TYPE(Id, SingletonId) case BuiltinType::Id:
1488#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
1489#include "clang/AST/BuiltinTypes.def"
1490 break;
1491
1492 case BuiltinType::ObjCId:
1493 VisitType = Context.getObjCIdType();
1494 break;
1495
1496 case BuiltinType::ObjCClass:
1497 VisitType = Context.getObjCClassType();
1498 break;
1499
1500 case BuiltinType::ObjCSel:
1501 VisitType = Context.getObjCSelType();
1502 break;
1503 }
1504
1505 if (!VisitType.isNull()) {
1506 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1507 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1508 TU));
1509 }
1510
1511 return false;
1512}
1513
1514bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1515 return Visit(MakeCursorTypeRef(TL.getTypedefNameDecl(), TL.getNameLoc(), TU));
1516}
1517
1518bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1519 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1520}
1521
1522bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1523 if (TL.isDefinition())
1524 return Visit(MakeCXCursor(TL.getDecl(), TU, RegionOfInterest));
1525
1526 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1527}
1528
1529bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1530 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1531}
1532
1533bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001534 return Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +00001535}
1536
1537bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1538 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1539 return true;
1540
Douglas Gregore9d95f12015-07-07 03:57:35 +00001541 for (unsigned I = 0, N = TL.getNumTypeArgs(); I != N; ++I) {
1542 if (Visit(TL.getTypeArgTInfo(I)->getTypeLoc()))
1543 return true;
1544 }
1545
Guy Benyei11169dd2012-12-18 14:30:41 +00001546 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1547 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1548 TU)))
1549 return true;
1550 }
1551
1552 return false;
1553}
1554
1555bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1556 return Visit(TL.getPointeeLoc());
1557}
1558
1559bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1560 return Visit(TL.getInnerLoc());
1561}
1562
1563bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1564 return Visit(TL.getPointeeLoc());
1565}
1566
1567bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1568 return Visit(TL.getPointeeLoc());
1569}
1570
1571bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1572 return Visit(TL.getPointeeLoc());
1573}
1574
1575bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1576 return Visit(TL.getPointeeLoc());
1577}
1578
1579bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1580 return Visit(TL.getPointeeLoc());
1581}
1582
1583bool CursorVisitor::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
1584 return Visit(TL.getModifiedLoc());
1585}
1586
1587bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1588 bool SkipResultType) {
Alp Toker42a16a62014-01-25 23:51:36 +00001589 if (!SkipResultType && Visit(TL.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001590 return true;
1591
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00001592 for (unsigned I = 0, N = TL.getNumParams(); I != N; ++I)
1593 if (Decl *D = TL.getParam(I))
Guy Benyei11169dd2012-12-18 14:30:41 +00001594 if (Visit(MakeCXCursor(D, TU, RegionOfInterest)))
1595 return true;
1596
1597 return false;
1598}
1599
1600bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1601 if (Visit(TL.getElementLoc()))
1602 return true;
1603
1604 if (Expr *Size = TL.getSizeExpr())
1605 return Visit(MakeCXCursor(Size, StmtParent, TU, RegionOfInterest));
1606
1607 return false;
1608}
1609
Reid Kleckner8a365022013-06-24 17:51:48 +00001610bool CursorVisitor::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
1611 return Visit(TL.getOriginalLoc());
1612}
1613
Reid Kleckner0503a872013-12-05 01:23:43 +00001614bool CursorVisitor::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
1615 return Visit(TL.getOriginalLoc());
1616}
1617
Guy Benyei11169dd2012-12-18 14:30:41 +00001618bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1619 TemplateSpecializationTypeLoc TL) {
1620 // Visit the template name.
1621 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1622 TL.getTemplateNameLoc()))
1623 return true;
1624
1625 // Visit the template arguments.
1626 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1627 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1628 return true;
1629
1630 return false;
1631}
1632
1633bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1634 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1635}
1636
1637bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1638 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1639 return Visit(TSInfo->getTypeLoc());
1640
1641 return false;
1642}
1643
1644bool CursorVisitor::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
1645 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1646 return Visit(TSInfo->getTypeLoc());
1647
1648 return false;
1649}
1650
1651bool CursorVisitor::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001652 return VisitNestedNameSpecifierLoc(TL.getQualifierLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00001653}
1654
1655bool CursorVisitor::VisitDependentTemplateSpecializationTypeLoc(
1656 DependentTemplateSpecializationTypeLoc TL) {
1657 // Visit the nested-name-specifier, if there is one.
1658 if (TL.getQualifierLoc() &&
1659 VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1660 return true;
1661
1662 // Visit the template arguments.
1663 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1664 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1665 return true;
1666
1667 return false;
1668}
1669
1670bool CursorVisitor::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
1671 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1672 return true;
1673
1674 return Visit(TL.getNamedTypeLoc());
1675}
1676
1677bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1678 return Visit(TL.getPatternLoc());
1679}
1680
1681bool CursorVisitor::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
1682 if (Expr *E = TL.getUnderlyingExpr())
1683 return Visit(MakeCXCursor(E, StmtParent, TU));
1684
1685 return false;
1686}
1687
1688bool CursorVisitor::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
1689 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1690}
1691
1692bool CursorVisitor::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
1693 return Visit(TL.getValueLoc());
1694}
1695
Xiuli Pan9c14e282016-01-09 12:53:17 +00001696bool CursorVisitor::VisitPipeTypeLoc(PipeTypeLoc TL) {
1697 return Visit(TL.getValueLoc());
1698}
1699
Guy Benyei11169dd2012-12-18 14:30:41 +00001700#define DEFAULT_TYPELOC_IMPL(CLASS, PARENT) \
1701bool CursorVisitor::Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
1702 return Visit##PARENT##Loc(TL); \
1703}
1704
1705DEFAULT_TYPELOC_IMPL(Complex, Type)
1706DEFAULT_TYPELOC_IMPL(ConstantArray, ArrayType)
1707DEFAULT_TYPELOC_IMPL(IncompleteArray, ArrayType)
1708DEFAULT_TYPELOC_IMPL(VariableArray, ArrayType)
1709DEFAULT_TYPELOC_IMPL(DependentSizedArray, ArrayType)
1710DEFAULT_TYPELOC_IMPL(DependentSizedExtVector, Type)
1711DEFAULT_TYPELOC_IMPL(Vector, Type)
1712DEFAULT_TYPELOC_IMPL(ExtVector, VectorType)
1713DEFAULT_TYPELOC_IMPL(FunctionProto, FunctionType)
1714DEFAULT_TYPELOC_IMPL(FunctionNoProto, FunctionType)
1715DEFAULT_TYPELOC_IMPL(Record, TagType)
1716DEFAULT_TYPELOC_IMPL(Enum, TagType)
1717DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParm, Type)
1718DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParmPack, Type)
1719DEFAULT_TYPELOC_IMPL(Auto, Type)
1720
1721bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1722 // Visit the nested-name-specifier, if present.
1723 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1724 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1725 return true;
1726
1727 if (D->isCompleteDefinition()) {
Aaron Ballman574705e2014-03-13 15:41:46 +00001728 for (const auto &I : D->bases()) {
1729 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(&I, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001730 return true;
1731 }
1732 }
1733
1734 return VisitTagDecl(D);
1735}
1736
1737bool CursorVisitor::VisitAttributes(Decl *D) {
Aaron Ballmanb97112e2014-03-08 22:19:01 +00001738 for (const auto *I : D->attrs())
1739 if (Visit(MakeCXCursor(I, D, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001740 return true;
1741
1742 return false;
1743}
1744
1745//===----------------------------------------------------------------------===//
1746// Data-recursive visitor methods.
1747//===----------------------------------------------------------------------===//
1748
1749namespace {
1750#define DEF_JOB(NAME, DATA, KIND)\
1751class NAME : public VisitorJob {\
1752public:\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001753 NAME(const DATA *d, CXCursor parent) : \
1754 VisitorJob(parent, VisitorJob::KIND, d) {} \
Guy Benyei11169dd2012-12-18 14:30:41 +00001755 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001756 const DATA *get() const { return static_cast<const DATA*>(data[0]); }\
Guy Benyei11169dd2012-12-18 14:30:41 +00001757};
1758
1759DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1760DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
1761DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
1762DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Guy Benyei11169dd2012-12-18 14:30:41 +00001763DEF_JOB(SizeOfPackExprParts, SizeOfPackExpr, SizeOfPackExprPartsKind)
1764DEF_JOB(LambdaExprParts, LambdaExpr, LambdaExprPartsKind)
1765DEF_JOB(PostChildrenVisit, void, PostChildrenVisitKind)
1766#undef DEF_JOB
1767
James Y Knight04ec5bf2015-12-24 02:59:37 +00001768class ExplicitTemplateArgsVisit : public VisitorJob {
1769public:
1770 ExplicitTemplateArgsVisit(const TemplateArgumentLoc *Begin,
1771 const TemplateArgumentLoc *End, CXCursor parent)
1772 : VisitorJob(parent, VisitorJob::ExplicitTemplateArgsVisitKind, Begin,
1773 End) {}
1774 static bool classof(const VisitorJob *VJ) {
1775 return VJ->getKind() == ExplicitTemplateArgsVisitKind;
1776 }
1777 const TemplateArgumentLoc *begin() const {
1778 return static_cast<const TemplateArgumentLoc *>(data[0]);
1779 }
1780 const TemplateArgumentLoc *end() {
1781 return static_cast<const TemplateArgumentLoc *>(data[1]);
1782 }
1783};
Guy Benyei11169dd2012-12-18 14:30:41 +00001784class DeclVisit : public VisitorJob {
1785public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001786 DeclVisit(const Decl *D, CXCursor parent, bool isFirst) :
Guy Benyei11169dd2012-12-18 14:30:41 +00001787 VisitorJob(parent, VisitorJob::DeclVisitKind,
Craig Topper69186e72014-06-08 08:38:04 +00001788 D, isFirst ? (void*) 1 : (void*) nullptr) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001789 static bool classof(const VisitorJob *VJ) {
1790 return VJ->getKind() == DeclVisitKind;
1791 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001792 const Decl *get() const { return static_cast<const Decl *>(data[0]); }
Dmitri Gribenkoe5423a72015-03-23 19:23:50 +00001793 bool isFirst() const { return data[1] != nullptr; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001794};
1795class TypeLocVisit : public VisitorJob {
1796public:
1797 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1798 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1799 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1800
1801 static bool classof(const VisitorJob *VJ) {
1802 return VJ->getKind() == TypeLocVisitKind;
1803 }
1804
1805 TypeLoc get() const {
1806 QualType T = QualType::getFromOpaquePtr(data[0]);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001807 return TypeLoc(T, const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001808 }
1809};
1810
1811class LabelRefVisit : public VisitorJob {
1812public:
1813 LabelRefVisit(LabelDecl *LD, SourceLocation labelLoc, CXCursor parent)
1814 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LD,
1815 labelLoc.getPtrEncoding()) {}
1816
1817 static bool classof(const VisitorJob *VJ) {
1818 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1819 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001820 const LabelDecl *get() const {
1821 return static_cast<const LabelDecl *>(data[0]);
1822 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001823 SourceLocation getLoc() const {
1824 return SourceLocation::getFromPtrEncoding(data[1]); }
1825};
1826
1827class NestedNameSpecifierLocVisit : public VisitorJob {
1828public:
1829 NestedNameSpecifierLocVisit(NestedNameSpecifierLoc Qualifier, CXCursor parent)
1830 : VisitorJob(parent, VisitorJob::NestedNameSpecifierLocVisitKind,
1831 Qualifier.getNestedNameSpecifier(),
1832 Qualifier.getOpaqueData()) { }
1833
1834 static bool classof(const VisitorJob *VJ) {
1835 return VJ->getKind() == VisitorJob::NestedNameSpecifierLocVisitKind;
1836 }
1837
1838 NestedNameSpecifierLoc get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001839 return NestedNameSpecifierLoc(
1840 const_cast<NestedNameSpecifier *>(
1841 static_cast<const NestedNameSpecifier *>(data[0])),
1842 const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001843 }
1844};
1845
1846class DeclarationNameInfoVisit : public VisitorJob {
1847public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001848 DeclarationNameInfoVisit(const Stmt *S, CXCursor parent)
Dmitri Gribenkodd7dacf2013-02-03 13:19:54 +00001849 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001850 static bool classof(const VisitorJob *VJ) {
1851 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1852 }
1853 DeclarationNameInfo get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001854 const Stmt *S = static_cast<const Stmt *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001855 switch (S->getStmtClass()) {
1856 default:
1857 llvm_unreachable("Unhandled Stmt");
1858 case clang::Stmt::MSDependentExistsStmtClass:
1859 return cast<MSDependentExistsStmt>(S)->getNameInfo();
1860 case Stmt::CXXDependentScopeMemberExprClass:
1861 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1862 case Stmt::DependentScopeDeclRefExprClass:
1863 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001864 case Stmt::OMPCriticalDirectiveClass:
1865 return cast<OMPCriticalDirective>(S)->getDirectiveName();
Guy Benyei11169dd2012-12-18 14:30:41 +00001866 }
1867 }
1868};
1869class MemberRefVisit : public VisitorJob {
1870public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001871 MemberRefVisit(const FieldDecl *D, SourceLocation L, CXCursor parent)
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1873 L.getPtrEncoding()) {}
1874 static bool classof(const VisitorJob *VJ) {
1875 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1876 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001877 const FieldDecl *get() const {
1878 return static_cast<const FieldDecl *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001879 }
1880 SourceLocation getLoc() const {
1881 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1882 }
1883};
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001884class EnqueueVisitor : public ConstStmtVisitor<EnqueueVisitor, void> {
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001885 friend class OMPClauseEnqueue;
Guy Benyei11169dd2012-12-18 14:30:41 +00001886 VisitorWorkList &WL;
1887 CXCursor Parent;
1888public:
1889 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1890 : WL(wl), Parent(parent) {}
1891
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001892 void VisitAddrLabelExpr(const AddrLabelExpr *E);
1893 void VisitBlockExpr(const BlockExpr *B);
1894 void VisitCompoundLiteralExpr(const CompoundLiteralExpr *E);
1895 void VisitCompoundStmt(const CompoundStmt *S);
1896 void VisitCXXDefaultArgExpr(const CXXDefaultArgExpr *E) { /* Do nothing. */ }
1897 void VisitMSDependentExistsStmt(const MSDependentExistsStmt *S);
1898 void VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E);
1899 void VisitCXXNewExpr(const CXXNewExpr *E);
1900 void VisitCXXScalarValueInitExpr(const CXXScalarValueInitExpr *E);
1901 void VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *E);
1902 void VisitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
1903 void VisitCXXTemporaryObjectExpr(const CXXTemporaryObjectExpr *E);
1904 void VisitCXXTypeidExpr(const CXXTypeidExpr *E);
1905 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *E);
1906 void VisitCXXUuidofExpr(const CXXUuidofExpr *E);
1907 void VisitCXXCatchStmt(const CXXCatchStmt *S);
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00001908 void VisitCXXForRangeStmt(const CXXForRangeStmt *S);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001909 void VisitDeclRefExpr(const DeclRefExpr *D);
1910 void VisitDeclStmt(const DeclStmt *S);
1911 void VisitDependentScopeDeclRefExpr(const DependentScopeDeclRefExpr *E);
1912 void VisitDesignatedInitExpr(const DesignatedInitExpr *E);
1913 void VisitExplicitCastExpr(const ExplicitCastExpr *E);
1914 void VisitForStmt(const ForStmt *FS);
1915 void VisitGotoStmt(const GotoStmt *GS);
1916 void VisitIfStmt(const IfStmt *If);
1917 void VisitInitListExpr(const InitListExpr *IE);
1918 void VisitMemberExpr(const MemberExpr *M);
1919 void VisitOffsetOfExpr(const OffsetOfExpr *E);
1920 void VisitObjCEncodeExpr(const ObjCEncodeExpr *E);
1921 void VisitObjCMessageExpr(const ObjCMessageExpr *M);
1922 void VisitOverloadExpr(const OverloadExpr *E);
1923 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *E);
1924 void VisitStmt(const Stmt *S);
1925 void VisitSwitchStmt(const SwitchStmt *S);
1926 void VisitWhileStmt(const WhileStmt *W);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001927 void VisitTypeTraitExpr(const TypeTraitExpr *E);
1928 void VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E);
1929 void VisitExpressionTraitExpr(const ExpressionTraitExpr *E);
1930 void VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U);
1931 void VisitVAArgExpr(const VAArgExpr *E);
1932 void VisitSizeOfPackExpr(const SizeOfPackExpr *E);
1933 void VisitPseudoObjectExpr(const PseudoObjectExpr *E);
1934 void VisitOpaqueValueExpr(const OpaqueValueExpr *E);
1935 void VisitLambdaExpr(const LambdaExpr *E);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001936 void VisitOMPExecutableDirective(const OMPExecutableDirective *D);
Alexander Musman3aaab662014-08-19 11:27:13 +00001937 void VisitOMPLoopDirective(const OMPLoopDirective *D);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001938 void VisitOMPParallelDirective(const OMPParallelDirective *D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00001939 void VisitOMPSimdDirective(const OMPSimdDirective *D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00001940 void VisitOMPForDirective(const OMPForDirective *D);
Alexander Musmanf82886e2014-09-18 05:12:34 +00001941 void VisitOMPForSimdDirective(const OMPForSimdDirective *D);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00001942 void VisitOMPSectionsDirective(const OMPSectionsDirective *D);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00001943 void VisitOMPSectionDirective(const OMPSectionDirective *D);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00001944 void VisitOMPSingleDirective(const OMPSingleDirective *D);
Alexander Musman80c22892014-07-17 08:54:58 +00001945 void VisitOMPMasterDirective(const OMPMasterDirective *D);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001946 void VisitOMPCriticalDirective(const OMPCriticalDirective *D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00001947 void VisitOMPParallelForDirective(const OMPParallelForDirective *D);
Alexander Musmane4e893b2014-09-23 09:33:00 +00001948 void VisitOMPParallelForSimdDirective(const OMPParallelForSimdDirective *D);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00001949 void VisitOMPParallelSectionsDirective(const OMPParallelSectionsDirective *D);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00001950 void VisitOMPTaskDirective(const OMPTaskDirective *D);
Alexey Bataev68446b72014-07-18 07:47:19 +00001951 void VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00001952 void VisitOMPBarrierDirective(const OMPBarrierDirective *D);
Alexey Bataev2df347a2014-07-18 10:17:07 +00001953 void VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00001954 void VisitOMPTaskgroupDirective(const OMPTaskgroupDirective *D);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00001955 void
1956 VisitOMPCancellationPointDirective(const OMPCancellationPointDirective *D);
Alexey Bataev80909872015-07-02 11:25:17 +00001957 void VisitOMPCancelDirective(const OMPCancelDirective *D);
Alexey Bataev6125da92014-07-21 11:26:11 +00001958 void VisitOMPFlushDirective(const OMPFlushDirective *D);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00001959 void VisitOMPOrderedDirective(const OMPOrderedDirective *D);
Alexey Bataev0162e452014-07-22 10:10:35 +00001960 void VisitOMPAtomicDirective(const OMPAtomicDirective *D);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00001961 void VisitOMPTargetDirective(const OMPTargetDirective *D);
Michael Wong65f367f2015-07-21 13:44:28 +00001962 void VisitOMPTargetDataDirective(const OMPTargetDataDirective *D);
Samuel Antaodf67fc42016-01-19 19:15:56 +00001963 void VisitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective *D);
Samuel Antao72590762016-01-19 20:04:50 +00001964 void VisitOMPTargetExitDataDirective(const OMPTargetExitDataDirective *D);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00001965 void VisitOMPTargetParallelDirective(const OMPTargetParallelDirective *D);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00001966 void
1967 VisitOMPTargetParallelForDirective(const OMPTargetParallelForDirective *D);
Alexey Bataev13314bf2014-10-09 04:18:56 +00001968 void VisitOMPTeamsDirective(const OMPTeamsDirective *D);
Alexey Bataev49f6e782015-12-01 04:18:41 +00001969 void VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00001970 void VisitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective *D);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00001971 void VisitOMPDistributeDirective(const OMPDistributeDirective *D);
Carlo Bertolli9925f152016-06-27 14:55:37 +00001972 void VisitOMPDistributeParallelForDirective(
1973 const OMPDistributeParallelForDirective *D);
Kelvin Li4a39add2016-07-05 05:00:15 +00001974 void VisitOMPDistributeParallelForSimdDirective(
1975 const OMPDistributeParallelForSimdDirective *D);
Kelvin Li787f3fc2016-07-06 04:45:38 +00001976 void VisitOMPDistributeSimdDirective(const OMPDistributeSimdDirective *D);
Kelvin Lia579b912016-07-14 02:54:56 +00001977 void VisitOMPTargetParallelForSimdDirective(
1978 const OMPTargetParallelForSimdDirective *D);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001979
Guy Benyei11169dd2012-12-18 14:30:41 +00001980private:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001981 void AddDeclarationNameInfo(const Stmt *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00001982 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
James Y Knight04ec5bf2015-12-24 02:59:37 +00001983 void AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
1984 unsigned NumTemplateArgs);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001985 void AddMemberRef(const FieldDecl *D, SourceLocation L);
1986 void AddStmt(const Stmt *S);
1987 void AddDecl(const Decl *D, bool isFirst = true);
Guy Benyei11169dd2012-12-18 14:30:41 +00001988 void AddTypeLoc(TypeSourceInfo *TI);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001989 void EnqueueChildren(const Stmt *S);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001990 void EnqueueChildren(const OMPClause *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00001991};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001992} // end anonyous namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00001993
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001994void EnqueueVisitor::AddDeclarationNameInfo(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001995 // 'S' should always be non-null, since it comes from the
1996 // statement we are visiting.
1997 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1998}
1999
2000void
2001EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
2002 if (Qualifier)
2003 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
2004}
2005
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002006void EnqueueVisitor::AddStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002007 if (S)
2008 WL.push_back(StmtVisit(S, Parent));
2009}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002010void EnqueueVisitor::AddDecl(const Decl *D, bool isFirst) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002011 if (D)
2012 WL.push_back(DeclVisit(D, Parent, isFirst));
2013}
James Y Knight04ec5bf2015-12-24 02:59:37 +00002014void EnqueueVisitor::AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2015 unsigned NumTemplateArgs) {
2016 WL.push_back(ExplicitTemplateArgsVisit(A, A + NumTemplateArgs, Parent));
Guy Benyei11169dd2012-12-18 14:30:41 +00002017}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002018void EnqueueVisitor::AddMemberRef(const FieldDecl *D, SourceLocation L) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002019 if (D)
2020 WL.push_back(MemberRefVisit(D, L, Parent));
2021}
2022void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
2023 if (TI)
2024 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
2025 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002026void EnqueueVisitor::EnqueueChildren(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002027 unsigned size = WL.size();
Benjamin Kramer642f1732015-07-02 21:03:14 +00002028 for (const Stmt *SubStmt : S->children()) {
2029 AddStmt(SubStmt);
Guy Benyei11169dd2012-12-18 14:30:41 +00002030 }
2031 if (size == WL.size())
2032 return;
2033 // Now reverse the entries we just added. This will match the DFS
2034 // ordering performed by the worklist.
2035 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2036 std::reverse(I, E);
2037}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002038namespace {
2039class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> {
2040 EnqueueVisitor *Visitor;
Alexey Bataev756c1962013-09-24 03:17:45 +00002041 /// \brief Process clauses with list of variables.
2042 template <typename T>
2043 void VisitOMPClauseList(T *Node);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002044public:
2045 OMPClauseEnqueue(EnqueueVisitor *Visitor) : Visitor(Visitor) { }
2046#define OPENMP_CLAUSE(Name, Class) \
2047 void Visit##Class(const Class *C);
2048#include "clang/Basic/OpenMPKinds.def"
Alexey Bataev3392d762016-02-16 11:18:12 +00002049 void VisitOMPClauseWithPreInit(const OMPClauseWithPreInit *C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002050 void VisitOMPClauseWithPostUpdate(const OMPClauseWithPostUpdate *C);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002051};
2052
Alexey Bataev3392d762016-02-16 11:18:12 +00002053void OMPClauseEnqueue::VisitOMPClauseWithPreInit(
2054 const OMPClauseWithPreInit *C) {
2055 Visitor->AddStmt(C->getPreInitStmt());
2056}
2057
Alexey Bataev005248a2016-02-25 05:25:57 +00002058void OMPClauseEnqueue::VisitOMPClauseWithPostUpdate(
2059 const OMPClauseWithPostUpdate *C) {
Alexey Bataev37e594c2016-03-04 07:21:16 +00002060 VisitOMPClauseWithPreInit(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002061 Visitor->AddStmt(C->getPostUpdateExpr());
2062}
2063
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002064void OMPClauseEnqueue::VisitOMPIfClause(const OMPIfClause *C) {
2065 Visitor->AddStmt(C->getCondition());
2066}
2067
Alexey Bataev3778b602014-07-17 07:32:53 +00002068void OMPClauseEnqueue::VisitOMPFinalClause(const OMPFinalClause *C) {
2069 Visitor->AddStmt(C->getCondition());
2070}
2071
Alexey Bataev568a8332014-03-06 06:15:19 +00002072void OMPClauseEnqueue::VisitOMPNumThreadsClause(const OMPNumThreadsClause *C) {
2073 Visitor->AddStmt(C->getNumThreads());
2074}
2075
Alexey Bataev62c87d22014-03-21 04:51:18 +00002076void OMPClauseEnqueue::VisitOMPSafelenClause(const OMPSafelenClause *C) {
2077 Visitor->AddStmt(C->getSafelen());
2078}
2079
Alexey Bataev66b15b52015-08-21 11:14:16 +00002080void OMPClauseEnqueue::VisitOMPSimdlenClause(const OMPSimdlenClause *C) {
2081 Visitor->AddStmt(C->getSimdlen());
2082}
2083
Alexander Musman8bd31e62014-05-27 15:12:19 +00002084void OMPClauseEnqueue::VisitOMPCollapseClause(const OMPCollapseClause *C) {
2085 Visitor->AddStmt(C->getNumForLoops());
2086}
2087
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002088void OMPClauseEnqueue::VisitOMPDefaultClause(const OMPDefaultClause *C) { }
Alexey Bataev756c1962013-09-24 03:17:45 +00002089
Alexey Bataevbcbadb62014-05-06 06:04:14 +00002090void OMPClauseEnqueue::VisitOMPProcBindClause(const OMPProcBindClause *C) { }
2091
Alexey Bataev56dafe82014-06-20 07:16:17 +00002092void OMPClauseEnqueue::VisitOMPScheduleClause(const OMPScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002093 VisitOMPClauseWithPreInit(C);
Alexey Bataev56dafe82014-06-20 07:16:17 +00002094 Visitor->AddStmt(C->getChunkSize());
2095}
2096
Alexey Bataev10e775f2015-07-30 11:36:16 +00002097void OMPClauseEnqueue::VisitOMPOrderedClause(const OMPOrderedClause *C) {
2098 Visitor->AddStmt(C->getNumForLoops());
2099}
Alexey Bataev142e1fc2014-06-20 09:44:06 +00002100
Alexey Bataev236070f2014-06-20 11:19:47 +00002101void OMPClauseEnqueue::VisitOMPNowaitClause(const OMPNowaitClause *) {}
2102
Alexey Bataev7aea99a2014-07-17 12:19:31 +00002103void OMPClauseEnqueue::VisitOMPUntiedClause(const OMPUntiedClause *) {}
2104
Alexey Bataev74ba3a52014-07-17 12:47:03 +00002105void OMPClauseEnqueue::VisitOMPMergeableClause(const OMPMergeableClause *) {}
2106
Alexey Bataevf98b00c2014-07-23 02:27:21 +00002107void OMPClauseEnqueue::VisitOMPReadClause(const OMPReadClause *) {}
2108
Alexey Bataevdea47612014-07-23 07:46:59 +00002109void OMPClauseEnqueue::VisitOMPWriteClause(const OMPWriteClause *) {}
2110
Alexey Bataev67a4f222014-07-23 10:25:33 +00002111void OMPClauseEnqueue::VisitOMPUpdateClause(const OMPUpdateClause *) {}
2112
Alexey Bataev459dec02014-07-24 06:46:57 +00002113void OMPClauseEnqueue::VisitOMPCaptureClause(const OMPCaptureClause *) {}
2114
Alexey Bataev82bad8b2014-07-24 08:55:34 +00002115void OMPClauseEnqueue::VisitOMPSeqCstClause(const OMPSeqCstClause *) {}
2116
Alexey Bataev346265e2015-09-25 10:37:12 +00002117void OMPClauseEnqueue::VisitOMPThreadsClause(const OMPThreadsClause *) {}
2118
Alexey Bataevd14d1e62015-09-28 06:39:35 +00002119void OMPClauseEnqueue::VisitOMPSIMDClause(const OMPSIMDClause *) {}
2120
Alexey Bataevb825de12015-12-07 10:51:44 +00002121void OMPClauseEnqueue::VisitOMPNogroupClause(const OMPNogroupClause *) {}
2122
Michael Wonge710d542015-08-07 16:16:36 +00002123void OMPClauseEnqueue::VisitOMPDeviceClause(const OMPDeviceClause *C) {
2124 Visitor->AddStmt(C->getDevice());
2125}
2126
Kelvin Li099bb8c2015-11-24 20:50:12 +00002127void OMPClauseEnqueue::VisitOMPNumTeamsClause(const OMPNumTeamsClause *C) {
2128 Visitor->AddStmt(C->getNumTeams());
2129}
2130
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002131void OMPClauseEnqueue::VisitOMPThreadLimitClause(const OMPThreadLimitClause *C) {
2132 Visitor->AddStmt(C->getThreadLimit());
2133}
2134
Alexey Bataeva0569352015-12-01 10:17:31 +00002135void OMPClauseEnqueue::VisitOMPPriorityClause(const OMPPriorityClause *C) {
2136 Visitor->AddStmt(C->getPriority());
2137}
2138
Alexey Bataev1fd4aed2015-12-07 12:52:51 +00002139void OMPClauseEnqueue::VisitOMPGrainsizeClause(const OMPGrainsizeClause *C) {
2140 Visitor->AddStmt(C->getGrainsize());
2141}
2142
Alexey Bataev382967a2015-12-08 12:06:20 +00002143void OMPClauseEnqueue::VisitOMPNumTasksClause(const OMPNumTasksClause *C) {
2144 Visitor->AddStmt(C->getNumTasks());
2145}
2146
Alexey Bataev28c75412015-12-15 08:19:24 +00002147void OMPClauseEnqueue::VisitOMPHintClause(const OMPHintClause *C) {
2148 Visitor->AddStmt(C->getHint());
2149}
2150
Alexey Bataev756c1962013-09-24 03:17:45 +00002151template<typename T>
2152void OMPClauseEnqueue::VisitOMPClauseList(T *Node) {
Alexey Bataev03b340a2014-10-21 03:16:40 +00002153 for (const auto *I : Node->varlists()) {
Aaron Ballman2205d2a2014-03-14 15:55:35 +00002154 Visitor->AddStmt(I);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002155 }
Alexey Bataev756c1962013-09-24 03:17:45 +00002156}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002157
2158void OMPClauseEnqueue::VisitOMPPrivateClause(const OMPPrivateClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002159 VisitOMPClauseList(C);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002160 for (const auto *E : C->private_copies()) {
2161 Visitor->AddStmt(E);
2162 }
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002163}
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002164void OMPClauseEnqueue::VisitOMPFirstprivateClause(
2165 const OMPFirstprivateClause *C) {
2166 VisitOMPClauseList(C);
Alexey Bataev417089f2016-02-17 13:19:37 +00002167 VisitOMPClauseWithPreInit(C);
2168 for (const auto *E : C->private_copies()) {
2169 Visitor->AddStmt(E);
2170 }
2171 for (const auto *E : C->inits()) {
2172 Visitor->AddStmt(E);
2173 }
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002174}
Alexander Musman1bb328c2014-06-04 13:06:39 +00002175void OMPClauseEnqueue::VisitOMPLastprivateClause(
2176 const OMPLastprivateClause *C) {
2177 VisitOMPClauseList(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002178 VisitOMPClauseWithPostUpdate(C);
Alexey Bataev38e89532015-04-16 04:54:05 +00002179 for (auto *E : C->private_copies()) {
2180 Visitor->AddStmt(E);
2181 }
2182 for (auto *E : C->source_exprs()) {
2183 Visitor->AddStmt(E);
2184 }
2185 for (auto *E : C->destination_exprs()) {
2186 Visitor->AddStmt(E);
2187 }
2188 for (auto *E : C->assignment_ops()) {
2189 Visitor->AddStmt(E);
2190 }
Alexander Musman1bb328c2014-06-04 13:06:39 +00002191}
Alexey Bataev758e55e2013-09-06 18:03:48 +00002192void OMPClauseEnqueue::VisitOMPSharedClause(const OMPSharedClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002193 VisitOMPClauseList(C);
Alexey Bataev758e55e2013-09-06 18:03:48 +00002194}
Alexey Bataevc5e02582014-06-16 07:08:35 +00002195void OMPClauseEnqueue::VisitOMPReductionClause(const OMPReductionClause *C) {
2196 VisitOMPClauseList(C);
Alexey Bataev61205072016-03-02 04:57:40 +00002197 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevf24e7b12015-10-08 09:10:53 +00002198 for (auto *E : C->privates()) {
2199 Visitor->AddStmt(E);
2200 }
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002201 for (auto *E : C->lhs_exprs()) {
2202 Visitor->AddStmt(E);
2203 }
2204 for (auto *E : C->rhs_exprs()) {
2205 Visitor->AddStmt(E);
2206 }
2207 for (auto *E : C->reduction_ops()) {
2208 Visitor->AddStmt(E);
2209 }
Alexey Bataevc5e02582014-06-16 07:08:35 +00002210}
Alexander Musman8dba6642014-04-22 13:09:42 +00002211void OMPClauseEnqueue::VisitOMPLinearClause(const OMPLinearClause *C) {
2212 VisitOMPClauseList(C);
Alexey Bataev78849fb2016-03-09 09:49:00 +00002213 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevbd9fec12015-08-18 06:47:21 +00002214 for (const auto *E : C->privates()) {
2215 Visitor->AddStmt(E);
2216 }
Alexander Musman3276a272015-03-21 10:12:56 +00002217 for (const auto *E : C->inits()) {
2218 Visitor->AddStmt(E);
2219 }
2220 for (const auto *E : C->updates()) {
2221 Visitor->AddStmt(E);
2222 }
2223 for (const auto *E : C->finals()) {
2224 Visitor->AddStmt(E);
2225 }
Alexander Musman8dba6642014-04-22 13:09:42 +00002226 Visitor->AddStmt(C->getStep());
Alexander Musman3276a272015-03-21 10:12:56 +00002227 Visitor->AddStmt(C->getCalcStep());
Alexander Musman8dba6642014-04-22 13:09:42 +00002228}
Alexander Musmanf0d76e72014-05-29 14:36:25 +00002229void OMPClauseEnqueue::VisitOMPAlignedClause(const OMPAlignedClause *C) {
2230 VisitOMPClauseList(C);
2231 Visitor->AddStmt(C->getAlignment());
2232}
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002233void OMPClauseEnqueue::VisitOMPCopyinClause(const OMPCopyinClause *C) {
2234 VisitOMPClauseList(C);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002235 for (auto *E : C->source_exprs()) {
2236 Visitor->AddStmt(E);
2237 }
2238 for (auto *E : C->destination_exprs()) {
2239 Visitor->AddStmt(E);
2240 }
2241 for (auto *E : C->assignment_ops()) {
2242 Visitor->AddStmt(E);
2243 }
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002244}
Alexey Bataevbae9a792014-06-27 10:37:06 +00002245void
2246OMPClauseEnqueue::VisitOMPCopyprivateClause(const OMPCopyprivateClause *C) {
2247 VisitOMPClauseList(C);
Alexey Bataeva63048e2015-03-23 06:18:07 +00002248 for (auto *E : C->source_exprs()) {
2249 Visitor->AddStmt(E);
2250 }
2251 for (auto *E : C->destination_exprs()) {
2252 Visitor->AddStmt(E);
2253 }
2254 for (auto *E : C->assignment_ops()) {
2255 Visitor->AddStmt(E);
2256 }
Alexey Bataevbae9a792014-06-27 10:37:06 +00002257}
Alexey Bataev6125da92014-07-21 11:26:11 +00002258void OMPClauseEnqueue::VisitOMPFlushClause(const OMPFlushClause *C) {
2259 VisitOMPClauseList(C);
2260}
Alexey Bataev1c2cfbc2015-06-23 14:25:19 +00002261void OMPClauseEnqueue::VisitOMPDependClause(const OMPDependClause *C) {
2262 VisitOMPClauseList(C);
2263}
Kelvin Li0bff7af2015-11-23 05:32:03 +00002264void OMPClauseEnqueue::VisitOMPMapClause(const OMPMapClause *C) {
2265 VisitOMPClauseList(C);
2266}
Carlo Bertollib4adf552016-01-15 18:50:31 +00002267void OMPClauseEnqueue::VisitOMPDistScheduleClause(
2268 const OMPDistScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002269 VisitOMPClauseWithPreInit(C);
Carlo Bertollib4adf552016-01-15 18:50:31 +00002270 Visitor->AddStmt(C->getChunkSize());
Carlo Bertollib4adf552016-01-15 18:50:31 +00002271}
Alexey Bataev3392d762016-02-16 11:18:12 +00002272void OMPClauseEnqueue::VisitOMPDefaultmapClause(
2273 const OMPDefaultmapClause * /*C*/) {}
Samuel Antao661c0902016-05-26 17:39:58 +00002274void OMPClauseEnqueue::VisitOMPToClause(const OMPToClause *C) {
2275 VisitOMPClauseList(C);
2276}
Samuel Antaoec172c62016-05-26 17:49:04 +00002277void OMPClauseEnqueue::VisitOMPFromClause(const OMPFromClause *C) {
2278 VisitOMPClauseList(C);
2279}
Carlo Bertolli2404b172016-07-13 15:37:16 +00002280void OMPClauseEnqueue::VisitOMPUseDevicePtrClause(const OMPUseDevicePtrClause *C) {
2281 VisitOMPClauseList(C);
2282}
Carlo Bertolli70594e92016-07-13 17:16:49 +00002283void OMPClauseEnqueue::VisitOMPIsDevicePtrClause(const OMPIsDevicePtrClause *C) {
2284 VisitOMPClauseList(C);
2285}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002286}
Alexey Bataev756c1962013-09-24 03:17:45 +00002287
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002288void EnqueueVisitor::EnqueueChildren(const OMPClause *S) {
2289 unsigned size = WL.size();
2290 OMPClauseEnqueue Visitor(this);
2291 Visitor.Visit(S);
2292 if (size == WL.size())
2293 return;
2294 // Now reverse the entries we just added. This will match the DFS
2295 // ordering performed by the worklist.
2296 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2297 std::reverse(I, E);
2298}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002299void EnqueueVisitor::VisitAddrLabelExpr(const AddrLabelExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002300 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
2301}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002302void EnqueueVisitor::VisitBlockExpr(const BlockExpr *B) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002303 AddDecl(B->getBlockDecl());
2304}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002305void EnqueueVisitor::VisitCompoundLiteralExpr(const CompoundLiteralExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002306 EnqueueChildren(E);
2307 AddTypeLoc(E->getTypeSourceInfo());
2308}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002309void EnqueueVisitor::VisitCompoundStmt(const CompoundStmt *S) {
Pete Cooper57d3f142015-07-30 17:22:52 +00002310 for (auto &I : llvm::reverse(S->body()))
2311 AddStmt(I);
Guy Benyei11169dd2012-12-18 14:30:41 +00002312}
2313void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002314VisitMSDependentExistsStmt(const MSDependentExistsStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002315 AddStmt(S->getSubStmt());
2316 AddDeclarationNameInfo(S);
2317 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
2318 AddNestedNameSpecifierLoc(QualifierLoc);
2319}
2320
2321void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002322VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002323 if (E->hasExplicitTemplateArgs())
2324 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002325 AddDeclarationNameInfo(E);
2326 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2327 AddNestedNameSpecifierLoc(QualifierLoc);
2328 if (!E->isImplicitAccess())
2329 AddStmt(E->getBase());
2330}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002331void EnqueueVisitor::VisitCXXNewExpr(const CXXNewExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002332 // Enqueue the initializer , if any.
2333 AddStmt(E->getInitializer());
2334 // Enqueue the array size, if any.
2335 AddStmt(E->getArraySize());
2336 // Enqueue the allocated type.
2337 AddTypeLoc(E->getAllocatedTypeSourceInfo());
2338 // Enqueue the placement arguments.
2339 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
2340 AddStmt(E->getPlacementArg(I-1));
2341}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002342void EnqueueVisitor::VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *CE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002343 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
2344 AddStmt(CE->getArg(I-1));
2345 AddStmt(CE->getCallee());
2346 AddStmt(CE->getArg(0));
2347}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002348void EnqueueVisitor::VisitCXXPseudoDestructorExpr(
2349 const CXXPseudoDestructorExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002350 // Visit the name of the type being destroyed.
2351 AddTypeLoc(E->getDestroyedTypeInfo());
2352 // Visit the scope type that looks disturbingly like the nested-name-specifier
2353 // but isn't.
2354 AddTypeLoc(E->getScopeTypeInfo());
2355 // Visit the nested-name-specifier.
2356 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2357 AddNestedNameSpecifierLoc(QualifierLoc);
2358 // Visit base expression.
2359 AddStmt(E->getBase());
2360}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002361void EnqueueVisitor::VisitCXXScalarValueInitExpr(
2362 const CXXScalarValueInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002363 AddTypeLoc(E->getTypeSourceInfo());
2364}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002365void EnqueueVisitor::VisitCXXTemporaryObjectExpr(
2366 const CXXTemporaryObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002367 EnqueueChildren(E);
2368 AddTypeLoc(E->getTypeSourceInfo());
2369}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002370void EnqueueVisitor::VisitCXXTypeidExpr(const CXXTypeidExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002371 EnqueueChildren(E);
2372 if (E->isTypeOperand())
2373 AddTypeLoc(E->getTypeOperandSourceInfo());
2374}
2375
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002376void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(
2377 const CXXUnresolvedConstructExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002378 EnqueueChildren(E);
2379 AddTypeLoc(E->getTypeSourceInfo());
2380}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002381void EnqueueVisitor::VisitCXXUuidofExpr(const CXXUuidofExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002382 EnqueueChildren(E);
2383 if (E->isTypeOperand())
2384 AddTypeLoc(E->getTypeOperandSourceInfo());
2385}
2386
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002387void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002388 EnqueueChildren(S);
2389 AddDecl(S->getExceptionDecl());
2390}
2391
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002392void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002393 AddStmt(S->getBody());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002394 AddStmt(S->getRangeInit());
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002395 AddDecl(S->getLoopVariable());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002396}
2397
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002398void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002399 if (DR->hasExplicitTemplateArgs())
2400 AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002401 WL.push_back(DeclRefExprParts(DR, Parent));
2402}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002403void EnqueueVisitor::VisitDependentScopeDeclRefExpr(
2404 const DependentScopeDeclRefExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002405 if (E->hasExplicitTemplateArgs())
2406 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002407 AddDeclarationNameInfo(E);
2408 AddNestedNameSpecifierLoc(E->getQualifierLoc());
2409}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002410void EnqueueVisitor::VisitDeclStmt(const DeclStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002411 unsigned size = WL.size();
2412 bool isFirst = true;
Aaron Ballman535bbcc2014-03-14 17:01:24 +00002413 for (const auto *D : S->decls()) {
2414 AddDecl(D, isFirst);
Guy Benyei11169dd2012-12-18 14:30:41 +00002415 isFirst = false;
2416 }
2417 if (size == WL.size())
2418 return;
2419 // Now reverse the entries we just added. This will match the DFS
2420 // ordering performed by the worklist.
2421 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2422 std::reverse(I, E);
2423}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002424void EnqueueVisitor::VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002425 AddStmt(E->getInit());
David Majnemerf7e36092016-06-23 00:15:04 +00002426 for (const DesignatedInitExpr::Designator &D :
2427 llvm::reverse(E->designators())) {
2428 if (D.isFieldDesignator()) {
2429 if (FieldDecl *Field = D.getField())
2430 AddMemberRef(Field, D.getFieldLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00002431 continue;
2432 }
David Majnemerf7e36092016-06-23 00:15:04 +00002433 if (D.isArrayDesignator()) {
2434 AddStmt(E->getArrayIndex(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 continue;
2436 }
David Majnemerf7e36092016-06-23 00:15:04 +00002437 assert(D.isArrayRangeDesignator() && "Unknown designator kind");
2438 AddStmt(E->getArrayRangeEnd(D));
2439 AddStmt(E->getArrayRangeStart(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002440 }
2441}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002442void EnqueueVisitor::VisitExplicitCastExpr(const ExplicitCastExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002443 EnqueueChildren(E);
2444 AddTypeLoc(E->getTypeInfoAsWritten());
2445}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002446void EnqueueVisitor::VisitForStmt(const ForStmt *FS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002447 AddStmt(FS->getBody());
2448 AddStmt(FS->getInc());
2449 AddStmt(FS->getCond());
2450 AddDecl(FS->getConditionVariable());
2451 AddStmt(FS->getInit());
2452}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002453void EnqueueVisitor::VisitGotoStmt(const GotoStmt *GS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2455}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002456void EnqueueVisitor::VisitIfStmt(const IfStmt *If) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002457 AddStmt(If->getElse());
2458 AddStmt(If->getThen());
2459 AddStmt(If->getCond());
2460 AddDecl(If->getConditionVariable());
2461}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002462void EnqueueVisitor::VisitInitListExpr(const InitListExpr *IE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002463 // We care about the syntactic form of the initializer list, only.
2464 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2465 IE = Syntactic;
2466 EnqueueChildren(IE);
2467}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002468void EnqueueVisitor::VisitMemberExpr(const MemberExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002469 WL.push_back(MemberExprParts(M, Parent));
2470
2471 // If the base of the member access expression is an implicit 'this', don't
2472 // visit it.
2473 // FIXME: If we ever want to show these implicit accesses, this will be
2474 // unfortunate. However, clang_getCursor() relies on this behavior.
Argyrios Kyrtzidis58d0e7a2015-03-13 04:40:07 +00002475 if (M->isImplicitAccess())
2476 return;
2477
2478 // Ignore base anonymous struct/union fields, otherwise they will shadow the
2479 // real field that that we are interested in.
2480 if (auto *SubME = dyn_cast<MemberExpr>(M->getBase())) {
2481 if (auto *FD = dyn_cast_or_null<FieldDecl>(SubME->getMemberDecl())) {
2482 if (FD->isAnonymousStructOrUnion()) {
2483 AddStmt(SubME->getBase());
2484 return;
2485 }
2486 }
2487 }
2488
2489 AddStmt(M->getBase());
Guy Benyei11169dd2012-12-18 14:30:41 +00002490}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002491void EnqueueVisitor::VisitObjCEncodeExpr(const ObjCEncodeExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002492 AddTypeLoc(E->getEncodedTypeSourceInfo());
2493}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002494void EnqueueVisitor::VisitObjCMessageExpr(const ObjCMessageExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002495 EnqueueChildren(M);
2496 AddTypeLoc(M->getClassReceiverTypeInfo());
2497}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002498void EnqueueVisitor::VisitOffsetOfExpr(const OffsetOfExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002499 // Visit the components of the offsetof expression.
2500 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002501 const OffsetOfNode &Node = E->getComponent(I-1);
2502 switch (Node.getKind()) {
2503 case OffsetOfNode::Array:
2504 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2505 break;
2506 case OffsetOfNode::Field:
2507 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
2508 break;
2509 case OffsetOfNode::Identifier:
2510 case OffsetOfNode::Base:
2511 continue;
2512 }
2513 }
2514 // Visit the type into which we're computing the offset.
2515 AddTypeLoc(E->getTypeSourceInfo());
2516}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002517void EnqueueVisitor::VisitOverloadExpr(const OverloadExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002518 if (E->hasExplicitTemplateArgs())
2519 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002520 WL.push_back(OverloadExprParts(E, Parent));
2521}
2522void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002523 const UnaryExprOrTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002524 EnqueueChildren(E);
2525 if (E->isArgumentType())
2526 AddTypeLoc(E->getArgumentTypeInfo());
2527}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002528void EnqueueVisitor::VisitStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002529 EnqueueChildren(S);
2530}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002531void EnqueueVisitor::VisitSwitchStmt(const SwitchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002532 AddStmt(S->getBody());
2533 AddStmt(S->getCond());
2534 AddDecl(S->getConditionVariable());
2535}
2536
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002537void EnqueueVisitor::VisitWhileStmt(const WhileStmt *W) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 AddStmt(W->getBody());
2539 AddStmt(W->getCond());
2540 AddDecl(W->getConditionVariable());
2541}
2542
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002543void EnqueueVisitor::VisitTypeTraitExpr(const TypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002544 for (unsigned I = E->getNumArgs(); I > 0; --I)
2545 AddTypeLoc(E->getArg(I-1));
2546}
2547
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002548void EnqueueVisitor::VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002549 AddTypeLoc(E->getQueriedTypeSourceInfo());
2550}
2551
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002552void EnqueueVisitor::VisitExpressionTraitExpr(const ExpressionTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002553 EnqueueChildren(E);
2554}
2555
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002556void EnqueueVisitor::VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002557 VisitOverloadExpr(U);
2558 if (!U->isImplicitAccess())
2559 AddStmt(U->getBase());
2560}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002561void EnqueueVisitor::VisitVAArgExpr(const VAArgExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002562 AddStmt(E->getSubExpr());
2563 AddTypeLoc(E->getWrittenTypeInfo());
2564}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002565void EnqueueVisitor::VisitSizeOfPackExpr(const SizeOfPackExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002566 WL.push_back(SizeOfPackExprParts(E, Parent));
2567}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002568void EnqueueVisitor::VisitOpaqueValueExpr(const OpaqueValueExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002569 // If the opaque value has a source expression, just transparently
2570 // visit that. This is useful for (e.g.) pseudo-object expressions.
2571 if (Expr *SourceExpr = E->getSourceExpr())
2572 return Visit(SourceExpr);
2573}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002574void EnqueueVisitor::VisitLambdaExpr(const LambdaExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002575 AddStmt(E->getBody());
2576 WL.push_back(LambdaExprParts(E, Parent));
2577}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002578void EnqueueVisitor::VisitPseudoObjectExpr(const PseudoObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002579 // Treat the expression like its syntactic form.
2580 Visit(E->getSyntacticForm());
2581}
2582
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002583void EnqueueVisitor::VisitOMPExecutableDirective(
2584 const OMPExecutableDirective *D) {
2585 EnqueueChildren(D);
2586 for (ArrayRef<OMPClause *>::iterator I = D->clauses().begin(),
2587 E = D->clauses().end();
2588 I != E; ++I)
2589 EnqueueChildren(*I);
2590}
2591
Alexander Musman3aaab662014-08-19 11:27:13 +00002592void EnqueueVisitor::VisitOMPLoopDirective(const OMPLoopDirective *D) {
2593 VisitOMPExecutableDirective(D);
2594}
2595
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002596void EnqueueVisitor::VisitOMPParallelDirective(const OMPParallelDirective *D) {
2597 VisitOMPExecutableDirective(D);
2598}
2599
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002600void EnqueueVisitor::VisitOMPSimdDirective(const OMPSimdDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002601 VisitOMPLoopDirective(D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002602}
2603
Alexey Bataevf29276e2014-06-18 04:14:57 +00002604void EnqueueVisitor::VisitOMPForDirective(const OMPForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002605 VisitOMPLoopDirective(D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002606}
2607
Alexander Musmanf82886e2014-09-18 05:12:34 +00002608void EnqueueVisitor::VisitOMPForSimdDirective(const OMPForSimdDirective *D) {
2609 VisitOMPLoopDirective(D);
2610}
2611
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002612void EnqueueVisitor::VisitOMPSectionsDirective(const OMPSectionsDirective *D) {
2613 VisitOMPExecutableDirective(D);
2614}
2615
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002616void EnqueueVisitor::VisitOMPSectionDirective(const OMPSectionDirective *D) {
2617 VisitOMPExecutableDirective(D);
2618}
2619
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002620void EnqueueVisitor::VisitOMPSingleDirective(const OMPSingleDirective *D) {
2621 VisitOMPExecutableDirective(D);
2622}
2623
Alexander Musman80c22892014-07-17 08:54:58 +00002624void EnqueueVisitor::VisitOMPMasterDirective(const OMPMasterDirective *D) {
2625 VisitOMPExecutableDirective(D);
2626}
2627
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002628void EnqueueVisitor::VisitOMPCriticalDirective(const OMPCriticalDirective *D) {
2629 VisitOMPExecutableDirective(D);
2630 AddDeclarationNameInfo(D);
2631}
2632
Alexey Bataev4acb8592014-07-07 13:01:15 +00002633void
2634EnqueueVisitor::VisitOMPParallelForDirective(const OMPParallelForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002635 VisitOMPLoopDirective(D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002636}
2637
Alexander Musmane4e893b2014-09-23 09:33:00 +00002638void EnqueueVisitor::VisitOMPParallelForSimdDirective(
2639 const OMPParallelForSimdDirective *D) {
2640 VisitOMPLoopDirective(D);
2641}
2642
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002643void EnqueueVisitor::VisitOMPParallelSectionsDirective(
2644 const OMPParallelSectionsDirective *D) {
2645 VisitOMPExecutableDirective(D);
2646}
2647
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002648void EnqueueVisitor::VisitOMPTaskDirective(const OMPTaskDirective *D) {
2649 VisitOMPExecutableDirective(D);
2650}
2651
Alexey Bataev68446b72014-07-18 07:47:19 +00002652void
2653EnqueueVisitor::VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D) {
2654 VisitOMPExecutableDirective(D);
2655}
2656
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002657void EnqueueVisitor::VisitOMPBarrierDirective(const OMPBarrierDirective *D) {
2658 VisitOMPExecutableDirective(D);
2659}
2660
Alexey Bataev2df347a2014-07-18 10:17:07 +00002661void EnqueueVisitor::VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D) {
2662 VisitOMPExecutableDirective(D);
2663}
2664
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002665void EnqueueVisitor::VisitOMPTaskgroupDirective(
2666 const OMPTaskgroupDirective *D) {
2667 VisitOMPExecutableDirective(D);
2668}
2669
Alexey Bataev6125da92014-07-21 11:26:11 +00002670void EnqueueVisitor::VisitOMPFlushDirective(const OMPFlushDirective *D) {
2671 VisitOMPExecutableDirective(D);
2672}
2673
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002674void EnqueueVisitor::VisitOMPOrderedDirective(const OMPOrderedDirective *D) {
2675 VisitOMPExecutableDirective(D);
2676}
2677
Alexey Bataev0162e452014-07-22 10:10:35 +00002678void EnqueueVisitor::VisitOMPAtomicDirective(const OMPAtomicDirective *D) {
2679 VisitOMPExecutableDirective(D);
2680}
2681
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002682void EnqueueVisitor::VisitOMPTargetDirective(const OMPTargetDirective *D) {
2683 VisitOMPExecutableDirective(D);
2684}
2685
Michael Wong65f367f2015-07-21 13:44:28 +00002686void EnqueueVisitor::VisitOMPTargetDataDirective(const
2687 OMPTargetDataDirective *D) {
2688 VisitOMPExecutableDirective(D);
2689}
2690
Samuel Antaodf67fc42016-01-19 19:15:56 +00002691void EnqueueVisitor::VisitOMPTargetEnterDataDirective(
2692 const OMPTargetEnterDataDirective *D) {
2693 VisitOMPExecutableDirective(D);
2694}
2695
Samuel Antao72590762016-01-19 20:04:50 +00002696void EnqueueVisitor::VisitOMPTargetExitDataDirective(
2697 const OMPTargetExitDataDirective *D) {
2698 VisitOMPExecutableDirective(D);
2699}
2700
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002701void EnqueueVisitor::VisitOMPTargetParallelDirective(
2702 const OMPTargetParallelDirective *D) {
2703 VisitOMPExecutableDirective(D);
2704}
2705
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002706void EnqueueVisitor::VisitOMPTargetParallelForDirective(
2707 const OMPTargetParallelForDirective *D) {
2708 VisitOMPLoopDirective(D);
2709}
2710
Alexey Bataev13314bf2014-10-09 04:18:56 +00002711void EnqueueVisitor::VisitOMPTeamsDirective(const OMPTeamsDirective *D) {
2712 VisitOMPExecutableDirective(D);
2713}
2714
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002715void EnqueueVisitor::VisitOMPCancellationPointDirective(
2716 const OMPCancellationPointDirective *D) {
2717 VisitOMPExecutableDirective(D);
2718}
2719
Alexey Bataev80909872015-07-02 11:25:17 +00002720void EnqueueVisitor::VisitOMPCancelDirective(const OMPCancelDirective *D) {
2721 VisitOMPExecutableDirective(D);
2722}
2723
Alexey Bataev49f6e782015-12-01 04:18:41 +00002724void EnqueueVisitor::VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D) {
2725 VisitOMPLoopDirective(D);
2726}
2727
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002728void EnqueueVisitor::VisitOMPTaskLoopSimdDirective(
2729 const OMPTaskLoopSimdDirective *D) {
2730 VisitOMPLoopDirective(D);
2731}
2732
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002733void EnqueueVisitor::VisitOMPDistributeDirective(
2734 const OMPDistributeDirective *D) {
2735 VisitOMPLoopDirective(D);
2736}
2737
Carlo Bertolli9925f152016-06-27 14:55:37 +00002738void EnqueueVisitor::VisitOMPDistributeParallelForDirective(
2739 const OMPDistributeParallelForDirective *D) {
2740 VisitOMPLoopDirective(D);
2741}
2742
Kelvin Li4a39add2016-07-05 05:00:15 +00002743void EnqueueVisitor::VisitOMPDistributeParallelForSimdDirective(
2744 const OMPDistributeParallelForSimdDirective *D) {
2745 VisitOMPLoopDirective(D);
2746}
2747
Kelvin Li787f3fc2016-07-06 04:45:38 +00002748void EnqueueVisitor::VisitOMPDistributeSimdDirective(
2749 const OMPDistributeSimdDirective *D) {
2750 VisitOMPLoopDirective(D);
2751}
2752
Kelvin Lia579b912016-07-14 02:54:56 +00002753void EnqueueVisitor::VisitOMPTargetParallelForSimdDirective(
2754 const OMPTargetParallelForSimdDirective *D) {
2755 VisitOMPLoopDirective(D);
2756}
2757
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002758void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002759 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
2760}
2761
2762bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2763 if (RegionOfInterest.isValid()) {
2764 SourceRange Range = getRawCursorExtent(C);
2765 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2766 return false;
2767 }
2768 return true;
2769}
2770
2771bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2772 while (!WL.empty()) {
2773 // Dequeue the worklist item.
Robert Wilhelm25284cc2013-08-23 16:11:15 +00002774 VisitorJob LI = WL.pop_back_val();
Guy Benyei11169dd2012-12-18 14:30:41 +00002775
2776 // Set the Parent field, then back to its old value once we're done.
2777 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2778
2779 switch (LI.getKind()) {
2780 case VisitorJob::DeclVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002781 const Decl *D = cast<DeclVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002782 if (!D)
2783 continue;
2784
2785 // For now, perform default visitation for Decls.
2786 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2787 cast<DeclVisit>(&LI)->isFirst())))
2788 return true;
2789
2790 continue;
2791 }
2792 case VisitorJob::ExplicitTemplateArgsVisitKind: {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002793 for (const TemplateArgumentLoc &Arg :
2794 *cast<ExplicitTemplateArgsVisit>(&LI)) {
2795 if (VisitTemplateArgumentLoc(Arg))
Guy Benyei11169dd2012-12-18 14:30:41 +00002796 return true;
2797 }
2798 continue;
2799 }
2800 case VisitorJob::TypeLocVisitKind: {
2801 // Perform default visitation for TypeLocs.
2802 if (Visit(cast<TypeLocVisit>(&LI)->get()))
2803 return true;
2804 continue;
2805 }
2806 case VisitorJob::LabelRefVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002807 const LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002808 if (LabelStmt *stmt = LS->getStmt()) {
2809 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2810 TU))) {
2811 return true;
2812 }
2813 }
2814 continue;
2815 }
2816
2817 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2818 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2819 if (VisitNestedNameSpecifierLoc(V->get()))
2820 return true;
2821 continue;
2822 }
2823
2824 case VisitorJob::DeclarationNameInfoVisitKind: {
2825 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2826 ->get()))
2827 return true;
2828 continue;
2829 }
2830 case VisitorJob::MemberRefVisitKind: {
2831 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2832 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2833 return true;
2834 continue;
2835 }
2836 case VisitorJob::StmtVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002837 const Stmt *S = cast<StmtVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002838 if (!S)
2839 continue;
2840
2841 // Update the current cursor.
2842 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
2843 if (!IsInRegionOfInterest(Cursor))
2844 continue;
2845 switch (Visitor(Cursor, Parent, ClientData)) {
2846 case CXChildVisit_Break: return true;
2847 case CXChildVisit_Continue: break;
2848 case CXChildVisit_Recurse:
2849 if (PostChildrenVisitor)
Craig Topper69186e72014-06-08 08:38:04 +00002850 WL.push_back(PostChildrenVisit(nullptr, Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +00002851 EnqueueWorkList(WL, S);
2852 break;
2853 }
2854 continue;
2855 }
2856 case VisitorJob::MemberExprPartsKind: {
2857 // Handle the other pieces in the MemberExpr besides the base.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002858 const MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002859
2860 // Visit the nested-name-specifier
2861 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
2862 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2863 return true;
2864
2865 // Visit the declaration name.
2866 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2867 return true;
2868
2869 // Visit the explicitly-specified template arguments, if any.
2870 if (M->hasExplicitTemplateArgs()) {
2871 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2872 *ArgEnd = Arg + M->getNumTemplateArgs();
2873 Arg != ArgEnd; ++Arg) {
2874 if (VisitTemplateArgumentLoc(*Arg))
2875 return true;
2876 }
2877 }
2878 continue;
2879 }
2880 case VisitorJob::DeclRefExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002881 const DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002882 // Visit nested-name-specifier, if present.
2883 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
2884 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2885 return true;
2886 // Visit declaration name.
2887 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2888 return true;
2889 continue;
2890 }
2891 case VisitorJob::OverloadExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002892 const OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002893 // Visit the nested-name-specifier.
2894 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
2895 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2896 return true;
2897 // Visit the declaration name.
2898 if (VisitDeclarationNameInfo(O->getNameInfo()))
2899 return true;
2900 // Visit the overloaded declaration reference.
2901 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2902 return true;
2903 continue;
2904 }
2905 case VisitorJob::SizeOfPackExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002906 const SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002907 NamedDecl *Pack = E->getPack();
2908 if (isa<TemplateTypeParmDecl>(Pack)) {
2909 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
2910 E->getPackLoc(), TU)))
2911 return true;
2912
2913 continue;
2914 }
2915
2916 if (isa<TemplateTemplateParmDecl>(Pack)) {
2917 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
2918 E->getPackLoc(), TU)))
2919 return true;
2920
2921 continue;
2922 }
2923
2924 // Non-type template parameter packs and function parameter packs are
2925 // treated like DeclRefExpr cursors.
2926 continue;
2927 }
2928
2929 case VisitorJob::LambdaExprPartsKind: {
2930 // Visit captures.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002931 const LambdaExpr *E = cast<LambdaExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002932 for (LambdaExpr::capture_iterator C = E->explicit_capture_begin(),
2933 CEnd = E->explicit_capture_end();
2934 C != CEnd; ++C) {
Richard Smithba71c082013-05-16 06:20:58 +00002935 // FIXME: Lambda init-captures.
2936 if (!C->capturesVariable())
Guy Benyei11169dd2012-12-18 14:30:41 +00002937 continue;
Richard Smithba71c082013-05-16 06:20:58 +00002938
Guy Benyei11169dd2012-12-18 14:30:41 +00002939 if (Visit(MakeCursorVariableRef(C->getCapturedVar(),
2940 C->getLocation(),
2941 TU)))
2942 return true;
2943 }
2944
2945 // Visit parameters and return type, if present.
2946 if (E->hasExplicitParameters() || E->hasExplicitResultType()) {
2947 TypeLoc TL = E->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
2948 if (E->hasExplicitParameters() && E->hasExplicitResultType()) {
2949 // Visit the whole type.
2950 if (Visit(TL))
2951 return true;
David Blaikie6adc78e2013-02-18 22:06:02 +00002952 } else if (FunctionProtoTypeLoc Proto =
2953 TL.getAs<FunctionProtoTypeLoc>()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002954 if (E->hasExplicitParameters()) {
2955 // Visit parameters.
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00002956 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I)
2957 if (Visit(MakeCXCursor(Proto.getParam(I), TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00002958 return true;
2959 } else {
2960 // Visit result type.
Alp Toker42a16a62014-01-25 23:51:36 +00002961 if (Visit(Proto.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00002962 return true;
2963 }
2964 }
2965 }
2966 break;
2967 }
2968
2969 case VisitorJob::PostChildrenVisitKind:
2970 if (PostChildrenVisitor(Parent, ClientData))
2971 return true;
2972 break;
2973 }
2974 }
2975 return false;
2976}
2977
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002978bool CursorVisitor::Visit(const Stmt *S) {
Craig Topper69186e72014-06-08 08:38:04 +00002979 VisitorWorkList *WL = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002980 if (!WorkListFreeList.empty()) {
2981 WL = WorkListFreeList.back();
2982 WL->clear();
2983 WorkListFreeList.pop_back();
2984 }
2985 else {
2986 WL = new VisitorWorkList();
2987 WorkListCache.push_back(WL);
2988 }
2989 EnqueueWorkList(*WL, S);
2990 bool result = RunVisitorWorkList(*WL);
2991 WorkListFreeList.push_back(WL);
2992 return result;
2993}
2994
2995namespace {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002996typedef SmallVector<SourceRange, 4> RefNamePieces;
James Y Knight04ec5bf2015-12-24 02:59:37 +00002997RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
2998 const DeclarationNameInfo &NI, SourceRange QLoc,
2999 const SourceRange *TemplateArgsLoc = nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003000 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
3001 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
3002 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
3003
3004 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
3005
3006 RefNamePieces Pieces;
3007
3008 if (WantQualifier && QLoc.isValid())
3009 Pieces.push_back(QLoc);
3010
3011 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
3012 Pieces.push_back(NI.getLoc());
James Y Knight04ec5bf2015-12-24 02:59:37 +00003013
3014 if (WantTemplateArgs && TemplateArgsLoc && TemplateArgsLoc->isValid())
3015 Pieces.push_back(*TemplateArgsLoc);
3016
Guy Benyei11169dd2012-12-18 14:30:41 +00003017 if (Kind == DeclarationName::CXXOperatorName) {
3018 Pieces.push_back(SourceLocation::getFromRawEncoding(
3019 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
3020 Pieces.push_back(SourceLocation::getFromRawEncoding(
3021 NI.getInfo().CXXOperatorName.EndOpNameLoc));
3022 }
3023
3024 if (WantSinglePiece) {
3025 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
3026 Pieces.clear();
3027 Pieces.push_back(R);
3028 }
3029
3030 return Pieces;
3031}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003032}
Guy Benyei11169dd2012-12-18 14:30:41 +00003033
3034//===----------------------------------------------------------------------===//
3035// Misc. API hooks.
3036//===----------------------------------------------------------------------===//
3037
Chad Rosier05c71aa2013-03-27 18:28:23 +00003038static void fatal_error_handler(void *user_data, const std::string& reason,
3039 bool gen_crash_diag) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003040 // Write the result out to stderr avoiding errs() because raw_ostreams can
3041 // call report_fatal_error.
3042 fprintf(stderr, "LIBCLANG FATAL ERROR: %s\n", reason.c_str());
3043 ::abort();
3044}
3045
Chandler Carruth66660742014-06-27 16:37:27 +00003046namespace {
3047struct RegisterFatalErrorHandler {
3048 RegisterFatalErrorHandler() {
3049 llvm::install_fatal_error_handler(fatal_error_handler, nullptr);
3050 }
3051};
3052}
3053
3054static llvm::ManagedStatic<RegisterFatalErrorHandler> RegisterFatalErrorHandlerOnce;
3055
Guy Benyei11169dd2012-12-18 14:30:41 +00003056extern "C" {
3057CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
3058 int displayDiagnostics) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003059 // We use crash recovery to make some of our APIs more reliable, implicitly
3060 // enable it.
Argyrios Kyrtzidis3701f542013-11-27 08:58:09 +00003061 if (!getenv("LIBCLANG_DISABLE_CRASH_RECOVERY"))
3062 llvm::CrashRecoveryContext::Enable();
Guy Benyei11169dd2012-12-18 14:30:41 +00003063
Chandler Carruth66660742014-06-27 16:37:27 +00003064 // Look through the managed static to trigger construction of the managed
3065 // static which registers our fatal error handler. This ensures it is only
3066 // registered once.
3067 (void)*RegisterFatalErrorHandlerOnce;
Guy Benyei11169dd2012-12-18 14:30:41 +00003068
Adrian Prantlbc068582015-07-08 01:00:30 +00003069 // Initialize targets for clang module support.
3070 llvm::InitializeAllTargets();
3071 llvm::InitializeAllTargetMCs();
3072 llvm::InitializeAllAsmPrinters();
3073 llvm::InitializeAllAsmParsers();
3074
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003075 CIndexer *CIdxr = new CIndexer();
3076
Guy Benyei11169dd2012-12-18 14:30:41 +00003077 if (excludeDeclarationsFromPCH)
3078 CIdxr->setOnlyLocalDecls();
3079 if (displayDiagnostics)
3080 CIdxr->setDisplayDiagnostics();
3081
3082 if (getenv("LIBCLANG_BGPRIO_INDEX"))
3083 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3084 CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
3085 if (getenv("LIBCLANG_BGPRIO_EDIT"))
3086 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3087 CXGlobalOpt_ThreadBackgroundPriorityForEditing);
3088
3089 return CIdxr;
3090}
3091
3092void clang_disposeIndex(CXIndex CIdx) {
3093 if (CIdx)
3094 delete static_cast<CIndexer *>(CIdx);
3095}
3096
3097void clang_CXIndex_setGlobalOptions(CXIndex CIdx, unsigned options) {
3098 if (CIdx)
3099 static_cast<CIndexer *>(CIdx)->setCXGlobalOptFlags(options);
3100}
3101
3102unsigned clang_CXIndex_getGlobalOptions(CXIndex CIdx) {
3103 if (CIdx)
3104 return static_cast<CIndexer *>(CIdx)->getCXGlobalOptFlags();
3105 return 0;
3106}
3107
3108void clang_toggleCrashRecovery(unsigned isEnabled) {
3109 if (isEnabled)
3110 llvm::CrashRecoveryContext::Enable();
3111 else
3112 llvm::CrashRecoveryContext::Disable();
3113}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003114
Guy Benyei11169dd2012-12-18 14:30:41 +00003115CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
3116 const char *ast_filename) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003117 CXTranslationUnit TU;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003118 enum CXErrorCode Result =
3119 clang_createTranslationUnit2(CIdx, ast_filename, &TU);
Reid Klecknerfd48fc62014-02-12 23:56:20 +00003120 (void)Result;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003121 assert((TU && Result == CXError_Success) ||
3122 (!TU && Result != CXError_Success));
3123 return TU;
3124}
3125
3126enum CXErrorCode clang_createTranslationUnit2(CXIndex CIdx,
3127 const char *ast_filename,
3128 CXTranslationUnit *out_TU) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003129 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003130 *out_TU = nullptr;
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003131
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003132 if (!CIdx || !ast_filename || !out_TU)
3133 return CXError_InvalidArguments;
Guy Benyei11169dd2012-12-18 14:30:41 +00003134
Argyrios Kyrtzidis27021012013-05-24 22:24:07 +00003135 LOG_FUNC_SECTION {
3136 *Log << ast_filename;
3137 }
3138
Guy Benyei11169dd2012-12-18 14:30:41 +00003139 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3140 FileSystemOptions FileSystemOpts;
3141
Justin Bognerd512c1e2014-10-15 00:33:06 +00003142 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
3143 CompilerInstance::createDiagnostics(new DiagnosticOptions());
David Blaikie6f7382d2014-08-10 19:08:04 +00003144 std::unique_ptr<ASTUnit> AU = ASTUnit::LoadFromASTFile(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003145 ast_filename, CXXIdx->getPCHContainerOperations()->getRawReader(), Diags,
Adrian Prantl6b21ab22015-08-27 19:46:20 +00003146 FileSystemOpts, /*UseDebugInfo=*/false,
3147 CXXIdx->getOnlyLocalDecls(), None,
David Blaikie6f7382d2014-08-10 19:08:04 +00003148 /*CaptureDiagnostics=*/true,
3149 /*AllowPCHWithCompilerErrors=*/true,
3150 /*UserFilesAreVolatile=*/true);
3151 *out_TU = MakeCXTranslationUnit(CXXIdx, AU.release());
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003152 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003153}
3154
3155unsigned clang_defaultEditingTranslationUnitOptions() {
3156 return CXTranslationUnit_PrecompiledPreamble |
3157 CXTranslationUnit_CacheCompletionResults;
3158}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003159
Guy Benyei11169dd2012-12-18 14:30:41 +00003160CXTranslationUnit
3161clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
3162 const char *source_filename,
3163 int num_command_line_args,
3164 const char * const *command_line_args,
3165 unsigned num_unsaved_files,
3166 struct CXUnsavedFile *unsaved_files) {
3167 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord;
3168 return clang_parseTranslationUnit(CIdx, source_filename,
3169 command_line_args, num_command_line_args,
3170 unsaved_files, num_unsaved_files,
3171 Options);
3172}
3173
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003174static CXErrorCode
3175clang_parseTranslationUnit_Impl(CXIndex CIdx, const char *source_filename,
3176 const char *const *command_line_args,
3177 int num_command_line_args,
3178 ArrayRef<CXUnsavedFile> unsaved_files,
3179 unsigned options, CXTranslationUnit *out_TU) {
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003180 // Set up the initial return values.
3181 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003182 *out_TU = nullptr;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003183
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003184 // Check arguments.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003185 if (!CIdx || !out_TU)
3186 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003187
Guy Benyei11169dd2012-12-18 14:30:41 +00003188 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3189
3190 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3191 setThreadBackgroundPriority();
3192
3193 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003194 bool CreatePreambleOnFirstParse =
3195 options & CXTranslationUnit_CreatePreambleOnFirstParse;
Guy Benyei11169dd2012-12-18 14:30:41 +00003196 // FIXME: Add a flag for modules.
3197 TranslationUnitKind TUKind
3198 = (options & CXTranslationUnit_Incomplete)? TU_Prefix : TU_Complete;
Alp Toker8c8a8752013-12-03 06:53:35 +00003199 bool CacheCodeCompletionResults
Guy Benyei11169dd2012-12-18 14:30:41 +00003200 = options & CXTranslationUnit_CacheCompletionResults;
3201 bool IncludeBriefCommentsInCodeCompletion
3202 = options & CXTranslationUnit_IncludeBriefCommentsInCodeCompletion;
3203 bool SkipFunctionBodies = options & CXTranslationUnit_SkipFunctionBodies;
3204 bool ForSerialization = options & CXTranslationUnit_ForSerialization;
3205
3206 // Configure the diagnostics.
3207 IntrusiveRefCntPtr<DiagnosticsEngine>
Sean Silvaf1b49e22013-01-20 01:58:28 +00003208 Diags(CompilerInstance::createDiagnostics(new DiagnosticOptions));
Guy Benyei11169dd2012-12-18 14:30:41 +00003209
Manuel Klimek016c0242016-03-01 10:56:19 +00003210 if (options & CXTranslationUnit_KeepGoing)
3211 Diags->setFatalsAsError(true);
3212
Guy Benyei11169dd2012-12-18 14:30:41 +00003213 // Recover resources if we crash before exiting this function.
3214 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
3215 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Alp Tokerf994cef2014-07-05 03:08:06 +00003216 DiagCleanup(Diags.get());
Guy Benyei11169dd2012-12-18 14:30:41 +00003217
Ahmed Charlesb8984322014-03-07 20:03:18 +00003218 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3219 new std::vector<ASTUnit::RemappedFile>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003220
3221 // Recover resources if we crash before exiting this function.
3222 llvm::CrashRecoveryContextCleanupRegistrar<
3223 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3224
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003225 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003226 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003227 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003228 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003229 }
3230
Ahmed Charlesb8984322014-03-07 20:03:18 +00003231 std::unique_ptr<std::vector<const char *>> Args(
3232 new std::vector<const char *>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003233
3234 // Recover resources if we crash before exiting this method.
3235 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
3236 ArgsCleanup(Args.get());
3237
3238 // Since the Clang C library is primarily used by batch tools dealing with
3239 // (often very broken) source code, where spell-checking can have a
3240 // significant negative impact on performance (particularly when
3241 // precompiled headers are involved), we disable it by default.
3242 // Only do this if we haven't found a spell-checking-related argument.
3243 bool FoundSpellCheckingArgument = false;
3244 for (int I = 0; I != num_command_line_args; ++I) {
3245 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
3246 strcmp(command_line_args[I], "-fspell-checking") == 0) {
3247 FoundSpellCheckingArgument = true;
3248 break;
3249 }
3250 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003251 Args->insert(Args->end(), command_line_args,
3252 command_line_args + num_command_line_args);
3253
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003254 if (!FoundSpellCheckingArgument)
3255 Args->insert(Args->begin() + 1, "-fno-spell-checking");
3256
Guy Benyei11169dd2012-12-18 14:30:41 +00003257 // The 'source_filename' argument is optional. If the caller does not
3258 // specify it then it is assumed that the source file is specified
3259 // in the actual argument list.
3260 // Put the source file after command_line_args otherwise if '-x' flag is
3261 // present it will be unused.
3262 if (source_filename)
3263 Args->push_back(source_filename);
3264
3265 // Do we need the detailed preprocessing record?
3266 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
3267 Args->push_back("-Xclang");
3268 Args->push_back("-detailed-preprocessing-record");
3269 }
3270
3271 unsigned NumErrors = Diags->getClient()->getNumErrors();
Ahmed Charlesb8984322014-03-07 20:03:18 +00003272 std::unique_ptr<ASTUnit> ErrUnit;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003273 // Unless the user specified that they want the preamble on the first parse
3274 // set it up to be created on the first reparse. This makes the first parse
3275 // faster, trading for a slower (first) reparse.
3276 unsigned PrecompilePreambleAfterNParses =
3277 !PrecompilePreamble ? 0 : 2 - CreatePreambleOnFirstParse;
Ahmed Charlesb8984322014-03-07 20:03:18 +00003278 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCommandLine(
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003279 Args->data(), Args->data() + Args->size(),
3280 CXXIdx->getPCHContainerOperations(), Diags,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003281 CXXIdx->getClangResourcesPath(), CXXIdx->getOnlyLocalDecls(),
3282 /*CaptureDiagnostics=*/true, *RemappedFiles.get(),
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003283 /*RemappedFilesKeepOriginalName=*/true, PrecompilePreambleAfterNParses,
3284 TUKind, CacheCodeCompletionResults, IncludeBriefCommentsInCodeCompletion,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003285 /*AllowPCHWithCompilerErrors=*/true, SkipFunctionBodies,
Argyrios Kyrtzidisa3e2ff12015-11-20 03:36:21 +00003286 /*UserFilesAreVolatile=*/true, ForSerialization,
3287 CXXIdx->getPCHContainerOperations()->getRawReader().getFormat(),
3288 &ErrUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003289
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003290 // Early failures in LoadFromCommandLine may return with ErrUnit unset.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003291 if (!Unit && !ErrUnit)
3292 return CXError_ASTReadError;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003293
Guy Benyei11169dd2012-12-18 14:30:41 +00003294 if (NumErrors != Diags->getClient()->getNumErrors()) {
3295 // Make sure to check that 'Unit' is non-NULL.
3296 if (CXXIdx->getDisplayDiagnostics())
3297 printDiagsToStderr(Unit ? Unit.get() : ErrUnit.get());
3298 }
3299
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003300 if (isASTReadError(Unit ? Unit.get() : ErrUnit.get()))
3301 return CXError_ASTReadError;
3302
3303 *out_TU = MakeCXTranslationUnit(CXXIdx, Unit.release());
3304 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003305}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003306
3307CXTranslationUnit
3308clang_parseTranslationUnit(CXIndex CIdx,
3309 const char *source_filename,
3310 const char *const *command_line_args,
3311 int num_command_line_args,
3312 struct CXUnsavedFile *unsaved_files,
3313 unsigned num_unsaved_files,
3314 unsigned options) {
3315 CXTranslationUnit TU;
3316 enum CXErrorCode Result = clang_parseTranslationUnit2(
3317 CIdx, source_filename, command_line_args, num_command_line_args,
3318 unsaved_files, num_unsaved_files, options, &TU);
Reid Kleckner6eaf05a2014-02-13 01:19:59 +00003319 (void)Result;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003320 assert((TU && Result == CXError_Success) ||
3321 (!TU && Result != CXError_Success));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003322 return TU;
3323}
3324
3325enum CXErrorCode clang_parseTranslationUnit2(
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003326 CXIndex CIdx, const char *source_filename,
3327 const char *const *command_line_args, int num_command_line_args,
3328 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3329 unsigned options, CXTranslationUnit *out_TU) {
3330 SmallVector<const char *, 4> Args;
3331 Args.push_back("clang");
3332 Args.append(command_line_args, command_line_args + num_command_line_args);
3333 return clang_parseTranslationUnit2FullArgv(
3334 CIdx, source_filename, Args.data(), Args.size(), unsaved_files,
3335 num_unsaved_files, options, out_TU);
3336}
3337
3338enum CXErrorCode clang_parseTranslationUnit2FullArgv(
3339 CXIndex CIdx, const char *source_filename,
3340 const char *const *command_line_args, int num_command_line_args,
3341 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3342 unsigned options, CXTranslationUnit *out_TU) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003343 LOG_FUNC_SECTION {
3344 *Log << source_filename << ": ";
3345 for (int i = 0; i != num_command_line_args; ++i)
3346 *Log << command_line_args[i] << " ";
3347 }
3348
Alp Toker9d85b182014-07-07 01:23:14 +00003349 if (num_unsaved_files && !unsaved_files)
3350 return CXError_InvalidArguments;
3351
Alp Toker5c532982014-07-07 22:42:03 +00003352 CXErrorCode result = CXError_Failure;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003353 auto ParseTranslationUnitImpl = [=, &result] {
3354 result = clang_parseTranslationUnit_Impl(
3355 CIdx, source_filename, command_line_args, num_command_line_args,
3356 llvm::makeArrayRef(unsaved_files, num_unsaved_files), options, out_TU);
3357 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003358 llvm::CrashRecoveryContext CRC;
3359
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003360 if (!RunSafely(CRC, ParseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003361 fprintf(stderr, "libclang: crash detected during parsing: {\n");
3362 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
3363 fprintf(stderr, " 'command_line_args' : [");
3364 for (int i = 0; i != num_command_line_args; ++i) {
3365 if (i)
3366 fprintf(stderr, ", ");
3367 fprintf(stderr, "'%s'", command_line_args[i]);
3368 }
3369 fprintf(stderr, "],\n");
3370 fprintf(stderr, " 'unsaved_files' : [");
3371 for (unsigned i = 0; i != num_unsaved_files; ++i) {
3372 if (i)
3373 fprintf(stderr, ", ");
3374 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
3375 unsaved_files[i].Length);
3376 }
3377 fprintf(stderr, "],\n");
3378 fprintf(stderr, " 'options' : %d,\n", options);
3379 fprintf(stderr, "}\n");
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003380
3381 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003382 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003383 if (CXTranslationUnit *TU = out_TU)
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003384 PrintLibclangResourceUsage(*TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003385 }
Alp Toker5c532982014-07-07 22:42:03 +00003386
3387 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003388}
3389
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003390CXString clang_Type_getObjCEncoding(CXType CT) {
3391 CXTranslationUnit tu = static_cast<CXTranslationUnit>(CT.data[1]);
3392 ASTContext &Ctx = getASTUnit(tu)->getASTContext();
3393 std::string encoding;
3394 Ctx.getObjCEncodingForType(QualType::getFromOpaquePtr(CT.data[0]),
3395 encoding);
3396
3397 return cxstring::createDup(encoding);
3398}
3399
3400static const IdentifierInfo *getMacroIdentifier(CXCursor C) {
3401 if (C.kind == CXCursor_MacroDefinition) {
3402 if (const MacroDefinitionRecord *MDR = getCursorMacroDefinition(C))
3403 return MDR->getName();
3404 } else if (C.kind == CXCursor_MacroExpansion) {
3405 MacroExpansionCursor ME = getCursorMacroExpansion(C);
3406 return ME.getName();
3407 }
3408 return nullptr;
3409}
3410
3411unsigned clang_Cursor_isMacroFunctionLike(CXCursor C) {
3412 const IdentifierInfo *II = getMacroIdentifier(C);
3413 if (!II) {
3414 return false;
3415 }
3416 ASTUnit *ASTU = getCursorASTUnit(C);
3417 Preprocessor &PP = ASTU->getPreprocessor();
3418 if (const MacroInfo *MI = PP.getMacroInfo(II))
3419 return MI->isFunctionLike();
3420 return false;
3421}
3422
3423unsigned clang_Cursor_isMacroBuiltin(CXCursor C) {
3424 const IdentifierInfo *II = getMacroIdentifier(C);
3425 if (!II) {
3426 return false;
3427 }
3428 ASTUnit *ASTU = getCursorASTUnit(C);
3429 Preprocessor &PP = ASTU->getPreprocessor();
3430 if (const MacroInfo *MI = PP.getMacroInfo(II))
3431 return MI->isBuiltinMacro();
3432 return false;
3433}
3434
3435unsigned clang_Cursor_isFunctionInlined(CXCursor C) {
3436 const Decl *D = getCursorDecl(C);
3437 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
3438 if (!FD) {
3439 return false;
3440 }
3441 return FD->isInlined();
3442}
3443
3444static StringLiteral* getCFSTR_value(CallExpr *callExpr) {
3445 if (callExpr->getNumArgs() != 1) {
3446 return nullptr;
3447 }
3448
3449 StringLiteral *S = nullptr;
3450 auto *arg = callExpr->getArg(0);
3451 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
3452 ImplicitCastExpr *I = static_cast<ImplicitCastExpr *>(arg);
3453 auto *subExpr = I->getSubExprAsWritten();
3454
3455 if(subExpr->getStmtClass() != Stmt::StringLiteralClass){
3456 return nullptr;
3457 }
3458
3459 S = static_cast<StringLiteral *>(I->getSubExprAsWritten());
3460 } else if (arg->getStmtClass() == Stmt::StringLiteralClass) {
3461 S = static_cast<StringLiteral *>(callExpr->getArg(0));
3462 } else {
3463 return nullptr;
3464 }
3465 return S;
3466}
3467
David Blaikie59272572016-04-13 18:23:33 +00003468struct ExprEvalResult {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003469 CXEvalResultKind EvalType;
3470 union {
3471 int intVal;
3472 double floatVal;
3473 char *stringVal;
3474 } EvalData;
David Blaikie59272572016-04-13 18:23:33 +00003475 ~ExprEvalResult() {
3476 if (EvalType != CXEval_UnExposed && EvalType != CXEval_Float &&
3477 EvalType != CXEval_Int) {
3478 delete EvalData.stringVal;
3479 }
3480 }
3481};
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003482
3483void clang_EvalResult_dispose(CXEvalResult E) {
David Blaikie59272572016-04-13 18:23:33 +00003484 delete static_cast<ExprEvalResult *>(E);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003485}
3486
3487CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E) {
3488 if (!E) {
3489 return CXEval_UnExposed;
3490 }
3491 return ((ExprEvalResult *)E)->EvalType;
3492}
3493
3494int clang_EvalResult_getAsInt(CXEvalResult E) {
3495 if (!E) {
3496 return 0;
3497 }
3498 return ((ExprEvalResult *)E)->EvalData.intVal;
3499}
3500
3501double clang_EvalResult_getAsDouble(CXEvalResult E) {
3502 if (!E) {
3503 return 0;
3504 }
3505 return ((ExprEvalResult *)E)->EvalData.floatVal;
3506}
3507
3508const char* clang_EvalResult_getAsStr(CXEvalResult E) {
3509 if (!E) {
3510 return nullptr;
3511 }
3512 return ((ExprEvalResult *)E)->EvalData.stringVal;
3513}
3514
3515static const ExprEvalResult* evaluateExpr(Expr *expr, CXCursor C) {
3516 Expr::EvalResult ER;
3517 ASTContext &ctx = getCursorContext(C);
David Blaikiebbc00882016-04-13 18:36:19 +00003518 if (!expr)
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003519 return nullptr;
David Blaikiebbc00882016-04-13 18:36:19 +00003520
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003521 expr = expr->IgnoreParens();
David Blaikiebbc00882016-04-13 18:36:19 +00003522 if (!expr->EvaluateAsRValue(ER, ctx))
3523 return nullptr;
3524
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003525 QualType rettype;
3526 CallExpr *callExpr;
David Blaikie59272572016-04-13 18:23:33 +00003527 auto result = llvm::make_unique<ExprEvalResult>();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003528 result->EvalType = CXEval_UnExposed;
3529
David Blaikiebbc00882016-04-13 18:36:19 +00003530 if (ER.Val.isInt()) {
3531 result->EvalType = CXEval_Int;
3532 result->EvalData.intVal = ER.Val.getInt().getExtValue();
3533 return result.release();
3534 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003535
David Blaikiebbc00882016-04-13 18:36:19 +00003536 if (ER.Val.isFloat()) {
3537 llvm::SmallVector<char, 100> Buffer;
3538 ER.Val.getFloat().toString(Buffer);
3539 std::string floatStr(Buffer.data(), Buffer.size());
3540 result->EvalType = CXEval_Float;
3541 bool ignored;
3542 llvm::APFloat apFloat = ER.Val.getFloat();
3543 apFloat.convert(llvm::APFloat::IEEEdouble,
3544 llvm::APFloat::rmNearestTiesToEven, &ignored);
3545 result->EvalData.floatVal = apFloat.convertToDouble();
3546 return result.release();
3547 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003548
David Blaikiebbc00882016-04-13 18:36:19 +00003549 if (expr->getStmtClass() == Stmt::ImplicitCastExprClass) {
3550 const ImplicitCastExpr *I = dyn_cast<ImplicitCastExpr>(expr);
3551 auto *subExpr = I->getSubExprAsWritten();
3552 if (subExpr->getStmtClass() == Stmt::StringLiteralClass ||
3553 subExpr->getStmtClass() == Stmt::ObjCStringLiteralClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003554 const StringLiteral *StrE = nullptr;
3555 const ObjCStringLiteral *ObjCExpr;
David Blaikiebbc00882016-04-13 18:36:19 +00003556 ObjCExpr = dyn_cast<ObjCStringLiteral>(subExpr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003557
3558 if (ObjCExpr) {
3559 StrE = ObjCExpr->getString();
3560 result->EvalType = CXEval_ObjCStrLiteral;
3561 } else {
David Blaikiebbc00882016-04-13 18:36:19 +00003562 StrE = cast<StringLiteral>(I->getSubExprAsWritten());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003563 result->EvalType = CXEval_StrLiteral;
3564 }
3565
3566 std::string strRef(StrE->getString().str());
David Blaikie59272572016-04-13 18:23:33 +00003567 result->EvalData.stringVal = new char[strRef.size() + 1];
David Blaikiebbc00882016-04-13 18:36:19 +00003568 strncpy((char *)result->EvalData.stringVal, strRef.c_str(),
3569 strRef.size());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003570 result->EvalData.stringVal[strRef.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003571 return result.release();
David Blaikiebbc00882016-04-13 18:36:19 +00003572 }
3573 } else if (expr->getStmtClass() == Stmt::ObjCStringLiteralClass ||
3574 expr->getStmtClass() == Stmt::StringLiteralClass) {
3575 const StringLiteral *StrE = nullptr;
3576 const ObjCStringLiteral *ObjCExpr;
3577 ObjCExpr = dyn_cast<ObjCStringLiteral>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003578
David Blaikiebbc00882016-04-13 18:36:19 +00003579 if (ObjCExpr) {
3580 StrE = ObjCExpr->getString();
3581 result->EvalType = CXEval_ObjCStrLiteral;
3582 } else {
3583 StrE = cast<StringLiteral>(expr);
3584 result->EvalType = CXEval_StrLiteral;
3585 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003586
David Blaikiebbc00882016-04-13 18:36:19 +00003587 std::string strRef(StrE->getString().str());
3588 result->EvalData.stringVal = new char[strRef.size() + 1];
3589 strncpy((char *)result->EvalData.stringVal, strRef.c_str(), strRef.size());
3590 result->EvalData.stringVal[strRef.size()] = '\0';
3591 return result.release();
3592 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003593
David Blaikiebbc00882016-04-13 18:36:19 +00003594 if (expr->getStmtClass() == Stmt::CStyleCastExprClass) {
3595 CStyleCastExpr *CC = static_cast<CStyleCastExpr *>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003596
David Blaikiebbc00882016-04-13 18:36:19 +00003597 rettype = CC->getType();
3598 if (rettype.getAsString() == "CFStringRef" &&
3599 CC->getSubExpr()->getStmtClass() == Stmt::CallExprClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003600
David Blaikiebbc00882016-04-13 18:36:19 +00003601 callExpr = static_cast<CallExpr *>(CC->getSubExpr());
3602 StringLiteral *S = getCFSTR_value(callExpr);
3603 if (S) {
3604 std::string strLiteral(S->getString().str());
3605 result->EvalType = CXEval_CFStr;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003606
David Blaikiebbc00882016-04-13 18:36:19 +00003607 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3608 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3609 strLiteral.size());
3610 result->EvalData.stringVal[strLiteral.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003611 return result.release();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003612 }
3613 }
3614
David Blaikiebbc00882016-04-13 18:36:19 +00003615 } else if (expr->getStmtClass() == Stmt::CallExprClass) {
3616 callExpr = static_cast<CallExpr *>(expr);
3617 rettype = callExpr->getCallReturnType(ctx);
3618
3619 if (rettype->isVectorType() || callExpr->getNumArgs() > 1)
3620 return nullptr;
3621
3622 if (rettype->isIntegralType(ctx) || rettype->isRealFloatingType()) {
3623 if (callExpr->getNumArgs() == 1 &&
3624 !callExpr->getArg(0)->getType()->isIntegralType(ctx))
3625 return nullptr;
3626 } else if (rettype.getAsString() == "CFStringRef") {
3627
3628 StringLiteral *S = getCFSTR_value(callExpr);
3629 if (S) {
3630 std::string strLiteral(S->getString().str());
3631 result->EvalType = CXEval_CFStr;
3632 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3633 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3634 strLiteral.size());
3635 result->EvalData.stringVal[strLiteral.size()] = '\0';
3636 return result.release();
3637 }
3638 }
3639 } else if (expr->getStmtClass() == Stmt::DeclRefExprClass) {
3640 DeclRefExpr *D = static_cast<DeclRefExpr *>(expr);
3641 ValueDecl *V = D->getDecl();
3642 if (V->getKind() == Decl::Function) {
3643 std::string strName = V->getNameAsString();
3644 result->EvalType = CXEval_Other;
3645 result->EvalData.stringVal = new char[strName.size() + 1];
3646 strncpy(result->EvalData.stringVal, strName.c_str(), strName.size());
3647 result->EvalData.stringVal[strName.size()] = '\0';
3648 return result.release();
3649 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003650 }
3651
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003652 return nullptr;
3653}
3654
3655CXEvalResult clang_Cursor_Evaluate(CXCursor C) {
3656 const Decl *D = getCursorDecl(C);
3657 if (D) {
3658 const Expr *expr = nullptr;
3659 if (auto *Var = dyn_cast<VarDecl>(D)) {
3660 expr = Var->getInit();
3661 } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3662 expr = Field->getInClassInitializer();
3663 }
3664 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003665 return const_cast<CXEvalResult>(reinterpret_cast<const void *>(
3666 evaluateExpr(const_cast<Expr *>(expr), C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003667 return nullptr;
3668 }
3669
3670 const CompoundStmt *compoundStmt = dyn_cast_or_null<CompoundStmt>(getCursorStmt(C));
3671 if (compoundStmt) {
3672 Expr *expr = nullptr;
3673 for (auto *bodyIterator : compoundStmt->body()) {
3674 if ((expr = dyn_cast<Expr>(bodyIterator))) {
3675 break;
3676 }
3677 }
3678 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003679 return const_cast<CXEvalResult>(
3680 reinterpret_cast<const void *>(evaluateExpr(expr, C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003681 }
3682 return nullptr;
3683}
3684
3685unsigned clang_Cursor_hasAttrs(CXCursor C) {
3686 const Decl *D = getCursorDecl(C);
3687 if (!D) {
3688 return 0;
3689 }
3690
3691 if (D->hasAttrs()) {
3692 return 1;
3693 }
3694
3695 return 0;
3696}
Guy Benyei11169dd2012-12-18 14:30:41 +00003697unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
3698 return CXSaveTranslationUnit_None;
3699}
3700
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003701static CXSaveError clang_saveTranslationUnit_Impl(CXTranslationUnit TU,
3702 const char *FileName,
3703 unsigned options) {
3704 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003705 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3706 setThreadBackgroundPriority();
3707
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003708 bool hadError = cxtu::getASTUnit(TU)->Save(FileName);
3709 return hadError ? CXSaveError_Unknown : CXSaveError_None;
Guy Benyei11169dd2012-12-18 14:30:41 +00003710}
3711
3712int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
3713 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003714 LOG_FUNC_SECTION {
3715 *Log << TU << ' ' << FileName;
3716 }
3717
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003718 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003719 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003720 return CXSaveError_InvalidTU;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003721 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003722
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003723 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003724 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3725 if (!CXXUnit->hasSema())
3726 return CXSaveError_InvalidTU;
3727
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003728 CXSaveError result;
3729 auto SaveTranslationUnitImpl = [=, &result]() {
3730 result = clang_saveTranslationUnit_Impl(TU, FileName, options);
3731 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003732
3733 if (!CXXUnit->getDiagnostics().hasUnrecoverableErrorOccurred() ||
3734 getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003735 SaveTranslationUnitImpl();
Guy Benyei11169dd2012-12-18 14:30:41 +00003736
3737 if (getenv("LIBCLANG_RESOURCE_USAGE"))
3738 PrintLibclangResourceUsage(TU);
3739
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003740 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003741 }
3742
3743 // We have an AST that has invalid nodes due to compiler errors.
3744 // Use a crash recovery thread for protection.
3745
3746 llvm::CrashRecoveryContext CRC;
3747
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003748 if (!RunSafely(CRC, SaveTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003749 fprintf(stderr, "libclang: crash detected during AST saving: {\n");
3750 fprintf(stderr, " 'filename' : '%s'\n", FileName);
3751 fprintf(stderr, " 'options' : %d,\n", options);
3752 fprintf(stderr, "}\n");
3753
3754 return CXSaveError_Unknown;
3755
3756 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3757 PrintLibclangResourceUsage(TU);
3758 }
3759
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003760 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003761}
3762
3763void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
3764 if (CTUnit) {
3765 // If the translation unit has been marked as unsafe to free, just discard
3766 // it.
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003767 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
3768 if (Unit && Unit->isUnsafeToFree())
Guy Benyei11169dd2012-12-18 14:30:41 +00003769 return;
3770
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003771 delete cxtu::getASTUnit(CTUnit);
Dmitri Gribenkob95b3f12013-01-26 22:44:19 +00003772 delete CTUnit->StringPool;
Guy Benyei11169dd2012-12-18 14:30:41 +00003773 delete static_cast<CXDiagnosticSetImpl *>(CTUnit->Diagnostics);
3774 disposeOverridenCXCursorsPool(CTUnit->OverridenCursorsPool);
Dmitri Gribenko9e605112013-11-13 22:16:51 +00003775 delete CTUnit->CommentToXML;
Guy Benyei11169dd2012-12-18 14:30:41 +00003776 delete CTUnit;
3777 }
3778}
3779
3780unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
3781 return CXReparse_None;
3782}
3783
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003784static CXErrorCode
3785clang_reparseTranslationUnit_Impl(CXTranslationUnit TU,
3786 ArrayRef<CXUnsavedFile> unsaved_files,
3787 unsigned options) {
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003788 // Check arguments.
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003789 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003790 LOG_BAD_TU(TU);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003791 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003792 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003793
3794 // Reset the associated diagnostics.
3795 delete static_cast<CXDiagnosticSetImpl*>(TU->Diagnostics);
Craig Topper69186e72014-06-08 08:38:04 +00003796 TU->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003797
Dmitri Gribenko183436e2013-01-26 21:49:50 +00003798 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003799 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
3800 setThreadBackgroundPriority();
3801
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003802 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003803 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ahmed Charlesb8984322014-03-07 20:03:18 +00003804
3805 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3806 new std::vector<ASTUnit::RemappedFile>());
3807
Guy Benyei11169dd2012-12-18 14:30:41 +00003808 // Recover resources if we crash before exiting this function.
3809 llvm::CrashRecoveryContextCleanupRegistrar<
3810 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
Alp Toker9d85b182014-07-07 01:23:14 +00003811
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003812 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003813 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003814 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003815 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003816 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003817
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003818 if (!CXXUnit->Reparse(CXXIdx->getPCHContainerOperations(),
3819 *RemappedFiles.get()))
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003820 return CXError_Success;
3821 if (isASTReadError(CXXUnit))
3822 return CXError_ASTReadError;
3823 return CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003824}
3825
3826int clang_reparseTranslationUnit(CXTranslationUnit TU,
3827 unsigned num_unsaved_files,
3828 struct CXUnsavedFile *unsaved_files,
3829 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003830 LOG_FUNC_SECTION {
3831 *Log << TU;
3832 }
3833
Alp Toker9d85b182014-07-07 01:23:14 +00003834 if (num_unsaved_files && !unsaved_files)
3835 return CXError_InvalidArguments;
3836
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003837 CXErrorCode result;
3838 auto ReparseTranslationUnitImpl = [=, &result]() {
3839 result = clang_reparseTranslationUnit_Impl(
3840 TU, llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
3841 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003842
3843 if (getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003844 ReparseTranslationUnitImpl();
Alp Toker5c532982014-07-07 22:42:03 +00003845 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003846 }
3847
3848 llvm::CrashRecoveryContext CRC;
3849
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003850 if (!RunSafely(CRC, ReparseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003851 fprintf(stderr, "libclang: crash detected during reparsing\n");
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003852 cxtu::getASTUnit(TU)->setUnsafeToFree(true);
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003853 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003854 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
3855 PrintLibclangResourceUsage(TU);
3856
Alp Toker5c532982014-07-07 22:42:03 +00003857 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003858}
3859
3860
3861CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003862 if (isNotUsableTU(CTUnit)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003863 LOG_BAD_TU(CTUnit);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00003864 return cxstring::createEmpty();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003865 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003866
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003867 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00003868 return cxstring::createDup(CXXUnit->getOriginalSourceFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00003869}
3870
3871CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003872 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003873 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00003874 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003875 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00003876
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003877 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003878 return MakeCXCursor(CXXUnit->getASTContext().getTranslationUnitDecl(), TU);
3879}
3880
3881} // end: extern "C"
3882
3883//===----------------------------------------------------------------------===//
3884// CXFile Operations.
3885//===----------------------------------------------------------------------===//
3886
3887extern "C" {
3888CXString clang_getFileName(CXFile SFile) {
3889 if (!SFile)
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00003890 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00003891
3892 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00003893 return cxstring::createRef(FEnt->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00003894}
3895
3896time_t clang_getFileTime(CXFile SFile) {
3897 if (!SFile)
3898 return 0;
3899
3900 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
3901 return FEnt->getModificationTime();
3902}
3903
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003904CXFile clang_getFile(CXTranslationUnit TU, const char *file_name) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003905 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003906 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00003907 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003908 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003909
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003910 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003911
3912 FileManager &FMgr = CXXUnit->getFileManager();
3913 return const_cast<FileEntry *>(FMgr.getFile(file_name));
3914}
3915
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003916unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit TU,
3917 CXFile file) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003918 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003919 LOG_BAD_TU(TU);
3920 return 0;
3921 }
3922
3923 if (!file)
Guy Benyei11169dd2012-12-18 14:30:41 +00003924 return 0;
3925
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003926 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003927 FileEntry *FEnt = static_cast<FileEntry *>(file);
3928 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
3929 .isFileMultipleIncludeGuarded(FEnt);
3930}
3931
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003932int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID) {
3933 if (!file || !outID)
3934 return 1;
3935
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003936 FileEntry *FEnt = static_cast<FileEntry *>(file);
Rafael Espindolaf8f91b82013-08-01 21:42:11 +00003937 const llvm::sys::fs::UniqueID &ID = FEnt->getUniqueID();
3938 outID->data[0] = ID.getDevice();
3939 outID->data[1] = ID.getFile();
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003940 outID->data[2] = FEnt->getModificationTime();
3941 return 0;
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003942}
3943
Argyrios Kyrtzidisac3997e2014-08-16 00:26:19 +00003944int clang_File_isEqual(CXFile file1, CXFile file2) {
3945 if (file1 == file2)
3946 return true;
3947
3948 if (!file1 || !file2)
3949 return false;
3950
3951 FileEntry *FEnt1 = static_cast<FileEntry *>(file1);
3952 FileEntry *FEnt2 = static_cast<FileEntry *>(file2);
3953 return FEnt1->getUniqueID() == FEnt2->getUniqueID();
3954}
3955
Guy Benyei11169dd2012-12-18 14:30:41 +00003956} // end: extern "C"
3957
3958//===----------------------------------------------------------------------===//
3959// CXCursor Operations.
3960//===----------------------------------------------------------------------===//
3961
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003962static const Decl *getDeclFromExpr(const Stmt *E) {
3963 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003964 return getDeclFromExpr(CE->getSubExpr());
3965
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003966 if (const DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003967 return RefExpr->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003968 if (const MemberExpr *ME = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003969 return ME->getMemberDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003970 if (const ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003971 return RE->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003972 if (const ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003973 if (PRE->isExplicitProperty())
3974 return PRE->getExplicitProperty();
3975 // It could be messaging both getter and setter as in:
3976 // ++myobj.myprop;
3977 // in which case prefer to associate the setter since it is less obvious
3978 // from inspecting the source that the setter is going to get called.
3979 if (PRE->isMessagingSetter())
3980 return PRE->getImplicitPropertySetter();
3981 return PRE->getImplicitPropertyGetter();
3982 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003983 if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003984 return getDeclFromExpr(POE->getSyntacticForm());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003985 if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003986 if (Expr *Src = OVE->getSourceExpr())
3987 return getDeclFromExpr(Src);
3988
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003989 if (const CallExpr *CE = dyn_cast<CallExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003990 return getDeclFromExpr(CE->getCallee());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003991 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003992 if (!CE->isElidable())
3993 return CE->getConstructor();
Richard Smith5179eb72016-06-28 19:03:57 +00003994 if (const CXXInheritedCtorInitExpr *CE =
3995 dyn_cast<CXXInheritedCtorInitExpr>(E))
3996 return CE->getConstructor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003997 if (const ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003998 return OME->getMethodDecl();
3999
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004000 if (const ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004001 return PE->getProtocol();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004002 if (const SubstNonTypeTemplateParmPackExpr *NTTP
Guy Benyei11169dd2012-12-18 14:30:41 +00004003 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
4004 return NTTP->getParameterPack();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004005 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004006 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
4007 isa<ParmVarDecl>(SizeOfPack->getPack()))
4008 return SizeOfPack->getPack();
Craig Topper69186e72014-06-08 08:38:04 +00004009
4010 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004011}
4012
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004013static SourceLocation getLocationFromExpr(const Expr *E) {
4014 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004015 return getLocationFromExpr(CE->getSubExpr());
4016
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004017 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004018 return /*FIXME:*/Msg->getLeftLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004019 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004020 return DRE->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004021 if (const MemberExpr *Member = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004022 return Member->getMemberLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004023 if (const ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004024 return Ivar->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004025 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004026 return SizeOfPack->getPackLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004027 if (const ObjCPropertyRefExpr *PropRef = dyn_cast<ObjCPropertyRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004028 return PropRef->getLocation();
4029
4030 return E->getLocStart();
4031}
4032
4033extern "C" {
4034
4035unsigned clang_visitChildren(CXCursor parent,
4036 CXCursorVisitor visitor,
4037 CXClientData client_data) {
4038 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
4039 /*VisitPreprocessorLast=*/false);
4040 return CursorVis.VisitChildren(parent);
4041}
4042
4043#ifndef __has_feature
4044#define __has_feature(x) 0
4045#endif
4046#if __has_feature(blocks)
4047typedef enum CXChildVisitResult
4048 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
4049
4050static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4051 CXClientData client_data) {
4052 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4053 return block(cursor, parent);
4054}
4055#else
4056// If we are compiled with a compiler that doesn't have native blocks support,
4057// define and call the block manually, so the
4058typedef struct _CXChildVisitResult
4059{
4060 void *isa;
4061 int flags;
4062 int reserved;
4063 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
4064 CXCursor);
4065} *CXCursorVisitorBlock;
4066
4067static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4068 CXClientData client_data) {
4069 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4070 return block->invoke(block, cursor, parent);
4071}
4072#endif
4073
4074
4075unsigned clang_visitChildrenWithBlock(CXCursor parent,
4076 CXCursorVisitorBlock block) {
4077 return clang_visitChildren(parent, visitWithBlock, block);
4078}
4079
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004080static CXString getDeclSpelling(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004081 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004082 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004083
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004084 const NamedDecl *ND = dyn_cast<NamedDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004085 if (!ND) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004086 if (const ObjCPropertyImplDecl *PropImpl =
4087 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004088 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004089 return cxstring::createDup(Property->getIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004090
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004091 if (const ImportDecl *ImportD = dyn_cast<ImportDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004092 if (Module *Mod = ImportD->getImportedModule())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004093 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004094
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004095 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004096 }
4097
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004098 if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004099 return cxstring::createDup(OMD->getSelector().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004100
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004101 if (const ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Guy Benyei11169dd2012-12-18 14:30:41 +00004102 // No, this isn't the same as the code below. getIdentifier() is non-virtual
4103 // and returns different names. NamedDecl returns the class name and
4104 // ObjCCategoryImplDecl returns the category name.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004105 return cxstring::createRef(CIMP->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004106
4107 if (isa<UsingDirectiveDecl>(D))
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004108 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004109
4110 SmallString<1024> S;
4111 llvm::raw_svector_ostream os(S);
4112 ND->printName(os);
4113
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004114 return cxstring::createDup(os.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004115}
4116
4117CXString clang_getCursorSpelling(CXCursor C) {
4118 if (clang_isTranslationUnit(C.kind))
Dmitri Gribenko2c173b42013-01-11 19:28:44 +00004119 return clang_getTranslationUnitSpelling(getCursorTU(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004120
4121 if (clang_isReference(C.kind)) {
4122 switch (C.kind) {
4123 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004124 const ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004125 return cxstring::createRef(Super->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004126 }
4127 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004128 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004129 return cxstring::createRef(Class->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004130 }
4131 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004132 const ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004133 assert(OID && "getCursorSpelling(): Missing protocol decl");
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004134 return cxstring::createRef(OID->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004135 }
4136 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004137 const CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004138 return cxstring::createDup(B->getType().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004139 }
4140 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004141 const TypeDecl *Type = getCursorTypeRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004142 assert(Type && "Missing type decl");
4143
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004144 return cxstring::createDup(getCursorContext(C).getTypeDeclType(Type).
Guy Benyei11169dd2012-12-18 14:30:41 +00004145 getAsString());
4146 }
4147 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004148 const TemplateDecl *Template = getCursorTemplateRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004149 assert(Template && "Missing template decl");
4150
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004151 return cxstring::createDup(Template->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004152 }
4153
4154 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004155 const NamedDecl *NS = getCursorNamespaceRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004156 assert(NS && "Missing namespace decl");
4157
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004158 return cxstring::createDup(NS->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004159 }
4160
4161 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004162 const FieldDecl *Field = getCursorMemberRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004163 assert(Field && "Missing member decl");
4164
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004165 return cxstring::createDup(Field->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004166 }
4167
4168 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004169 const LabelStmt *Label = getCursorLabelRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004170 assert(Label && "Missing label");
4171
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004172 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004173 }
4174
4175 case CXCursor_OverloadedDeclRef: {
4176 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004177 if (const Decl *D = Storage.dyn_cast<const Decl *>()) {
4178 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004179 return cxstring::createDup(ND->getNameAsString());
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004180 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004181 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004182 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004183 return cxstring::createDup(E->getName().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004184 OverloadedTemplateStorage *Ovl
4185 = Storage.get<OverloadedTemplateStorage*>();
4186 if (Ovl->size() == 0)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004187 return cxstring::createEmpty();
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004188 return cxstring::createDup((*Ovl->begin())->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004189 }
4190
4191 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004192 const VarDecl *Var = getCursorVariableRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004193 assert(Var && "Missing variable decl");
4194
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004195 return cxstring::createDup(Var->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004196 }
4197
4198 default:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004199 return cxstring::createRef("<not implemented>");
Guy Benyei11169dd2012-12-18 14:30:41 +00004200 }
4201 }
4202
4203 if (clang_isExpression(C.kind)) {
Argyrios Kyrtzidis3227d862014-03-03 19:40:52 +00004204 const Expr *E = getCursorExpr(C);
4205
4206 if (C.kind == CXCursor_ObjCStringLiteral ||
4207 C.kind == CXCursor_StringLiteral) {
4208 const StringLiteral *SLit;
4209 if (const ObjCStringLiteral *OSL = dyn_cast<ObjCStringLiteral>(E)) {
4210 SLit = OSL->getString();
4211 } else {
4212 SLit = cast<StringLiteral>(E);
4213 }
4214 SmallString<256> Buf;
4215 llvm::raw_svector_ostream OS(Buf);
4216 SLit->outputString(OS);
4217 return cxstring::createDup(OS.str());
4218 }
4219
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004220 const Decl *D = getDeclFromExpr(getCursorExpr(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004221 if (D)
4222 return getDeclSpelling(D);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004223 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004224 }
4225
4226 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004227 const Stmt *S = getCursorStmt(C);
4228 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004229 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004230
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004231 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004232 }
4233
4234 if (C.kind == CXCursor_MacroExpansion)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004235 return cxstring::createRef(getCursorMacroExpansion(C).getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004236 ->getNameStart());
4237
4238 if (C.kind == CXCursor_MacroDefinition)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004239 return cxstring::createRef(getCursorMacroDefinition(C)->getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004240 ->getNameStart());
4241
4242 if (C.kind == CXCursor_InclusionDirective)
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004243 return cxstring::createDup(getCursorInclusionDirective(C)->getFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004244
4245 if (clang_isDeclaration(C.kind))
4246 return getDeclSpelling(getCursorDecl(C));
4247
4248 if (C.kind == CXCursor_AnnotateAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004249 const AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004250 return cxstring::createDup(AA->getAnnotation());
Guy Benyei11169dd2012-12-18 14:30:41 +00004251 }
4252
4253 if (C.kind == CXCursor_AsmLabelAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004254 const AsmLabelAttr *AA = cast<AsmLabelAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004255 return cxstring::createDup(AA->getLabel());
Guy Benyei11169dd2012-12-18 14:30:41 +00004256 }
4257
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004258 if (C.kind == CXCursor_PackedAttr) {
4259 return cxstring::createRef("packed");
4260 }
4261
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004262 if (C.kind == CXCursor_VisibilityAttr) {
4263 const VisibilityAttr *AA = cast<VisibilityAttr>(cxcursor::getCursorAttr(C));
4264 switch (AA->getVisibility()) {
4265 case VisibilityAttr::VisibilityType::Default:
4266 return cxstring::createRef("default");
4267 case VisibilityAttr::VisibilityType::Hidden:
4268 return cxstring::createRef("hidden");
4269 case VisibilityAttr::VisibilityType::Protected:
4270 return cxstring::createRef("protected");
4271 }
4272 llvm_unreachable("unknown visibility type");
4273 }
4274
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004275 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004276}
4277
4278CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor C,
4279 unsigned pieceIndex,
4280 unsigned options) {
4281 if (clang_Cursor_isNull(C))
4282 return clang_getNullRange();
4283
4284 ASTContext &Ctx = getCursorContext(C);
4285
4286 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004287 const Stmt *S = getCursorStmt(C);
4288 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004289 if (pieceIndex > 0)
4290 return clang_getNullRange();
4291 return cxloc::translateSourceRange(Ctx, Label->getIdentLoc());
4292 }
4293
4294 return clang_getNullRange();
4295 }
4296
4297 if (C.kind == CXCursor_ObjCMessageExpr) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004298 if (const ObjCMessageExpr *
Guy Benyei11169dd2012-12-18 14:30:41 +00004299 ME = dyn_cast_or_null<ObjCMessageExpr>(getCursorExpr(C))) {
4300 if (pieceIndex >= ME->getNumSelectorLocs())
4301 return clang_getNullRange();
4302 return cxloc::translateSourceRange(Ctx, ME->getSelectorLoc(pieceIndex));
4303 }
4304 }
4305
4306 if (C.kind == CXCursor_ObjCInstanceMethodDecl ||
4307 C.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004308 if (const ObjCMethodDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004309 MD = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(C))) {
4310 if (pieceIndex >= MD->getNumSelectorLocs())
4311 return clang_getNullRange();
4312 return cxloc::translateSourceRange(Ctx, MD->getSelectorLoc(pieceIndex));
4313 }
4314 }
4315
4316 if (C.kind == CXCursor_ObjCCategoryDecl ||
4317 C.kind == CXCursor_ObjCCategoryImplDecl) {
4318 if (pieceIndex > 0)
4319 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004320 if (const ObjCCategoryDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004321 CD = dyn_cast_or_null<ObjCCategoryDecl>(getCursorDecl(C)))
4322 return cxloc::translateSourceRange(Ctx, CD->getCategoryNameLoc());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004323 if (const ObjCCategoryImplDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004324 CID = dyn_cast_or_null<ObjCCategoryImplDecl>(getCursorDecl(C)))
4325 return cxloc::translateSourceRange(Ctx, CID->getCategoryNameLoc());
4326 }
4327
4328 if (C.kind == CXCursor_ModuleImportDecl) {
4329 if (pieceIndex > 0)
4330 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004331 if (const ImportDecl *ImportD =
4332 dyn_cast_or_null<ImportDecl>(getCursorDecl(C))) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004333 ArrayRef<SourceLocation> Locs = ImportD->getIdentifierLocs();
4334 if (!Locs.empty())
4335 return cxloc::translateSourceRange(Ctx,
4336 SourceRange(Locs.front(), Locs.back()));
4337 }
4338 return clang_getNullRange();
4339 }
4340
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004341 if (C.kind == CXCursor_CXXMethod || C.kind == CXCursor_Destructor ||
4342 C.kind == CXCursor_ConversionFunction) {
4343 if (pieceIndex > 0)
4344 return clang_getNullRange();
4345 if (const FunctionDecl *FD =
4346 dyn_cast_or_null<FunctionDecl>(getCursorDecl(C))) {
4347 DeclarationNameInfo FunctionName = FD->getNameInfo();
4348 return cxloc::translateSourceRange(Ctx, FunctionName.getSourceRange());
4349 }
4350 return clang_getNullRange();
4351 }
4352
Guy Benyei11169dd2012-12-18 14:30:41 +00004353 // FIXME: A CXCursor_InclusionDirective should give the location of the
4354 // filename, but we don't keep track of this.
4355
4356 // FIXME: A CXCursor_AnnotateAttr should give the location of the annotation
4357 // but we don't keep track of this.
4358
4359 // FIXME: A CXCursor_AsmLabelAttr should give the location of the label
4360 // but we don't keep track of this.
4361
4362 // Default handling, give the location of the cursor.
4363
4364 if (pieceIndex > 0)
4365 return clang_getNullRange();
4366
4367 CXSourceLocation CXLoc = clang_getCursorLocation(C);
4368 SourceLocation Loc = cxloc::translateSourceLocation(CXLoc);
4369 return cxloc::translateSourceRange(Ctx, Loc);
4370}
4371
Eli Bendersky44a206f2014-07-31 18:04:56 +00004372CXString clang_Cursor_getMangling(CXCursor C) {
4373 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4374 return cxstring::createEmpty();
4375
Eli Bendersky44a206f2014-07-31 18:04:56 +00004376 // Mangling only works for functions and variables.
Eli Bendersky79759592014-08-01 15:01:10 +00004377 const Decl *D = getCursorDecl(C);
Eli Bendersky44a206f2014-07-31 18:04:56 +00004378 if (!D || !(isa<FunctionDecl>(D) || isa<VarDecl>(D)))
4379 return cxstring::createEmpty();
4380
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004381 ASTContext &Ctx = D->getASTContext();
4382 index::CodegenNameGenerator CGNameGen(Ctx);
4383 return cxstring::createDup(CGNameGen.getName(D));
Eli Bendersky44a206f2014-07-31 18:04:56 +00004384}
4385
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004386CXStringSet *clang_Cursor_getCXXManglings(CXCursor C) {
4387 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4388 return nullptr;
4389
4390 const Decl *D = getCursorDecl(C);
4391 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
4392 return nullptr;
4393
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004394 ASTContext &Ctx = D->getASTContext();
4395 index::CodegenNameGenerator CGNameGen(Ctx);
4396 std::vector<std::string> Manglings = CGNameGen.getAllManglings(D);
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004397 return cxstring::createSet(Manglings);
4398}
4399
Guy Benyei11169dd2012-12-18 14:30:41 +00004400CXString clang_getCursorDisplayName(CXCursor C) {
4401 if (!clang_isDeclaration(C.kind))
4402 return clang_getCursorSpelling(C);
4403
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004404 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00004405 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004406 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004407
4408 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004409 if (const FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004410 D = FunTmpl->getTemplatedDecl();
4411
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004412 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004413 SmallString<64> Str;
4414 llvm::raw_svector_ostream OS(Str);
4415 OS << *Function;
4416 if (Function->getPrimaryTemplate())
4417 OS << "<>";
4418 OS << "(";
4419 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
4420 if (I)
4421 OS << ", ";
4422 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
4423 }
4424
4425 if (Function->isVariadic()) {
4426 if (Function->getNumParams())
4427 OS << ", ";
4428 OS << "...";
4429 }
4430 OS << ")";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004431 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004432 }
4433
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004434 if (const ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004435 SmallString<64> Str;
4436 llvm::raw_svector_ostream OS(Str);
4437 OS << *ClassTemplate;
4438 OS << "<";
4439 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
4440 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
4441 if (I)
4442 OS << ", ";
4443
4444 NamedDecl *Param = Params->getParam(I);
4445 if (Param->getIdentifier()) {
4446 OS << Param->getIdentifier()->getName();
4447 continue;
4448 }
4449
4450 // There is no parameter name, which makes this tricky. Try to come up
4451 // with something useful that isn't too long.
4452 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
4453 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
4454 else if (NonTypeTemplateParmDecl *NTTP
4455 = dyn_cast<NonTypeTemplateParmDecl>(Param))
4456 OS << NTTP->getType().getAsString(Policy);
4457 else
4458 OS << "template<...> class";
4459 }
4460
4461 OS << ">";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004462 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004463 }
4464
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004465 if (const ClassTemplateSpecializationDecl *ClassSpec
Guy Benyei11169dd2012-12-18 14:30:41 +00004466 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
4467 // If the type was explicitly written, use that.
4468 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004469 return cxstring::createDup(TSInfo->getType().getAsString(Policy));
Guy Benyei11169dd2012-12-18 14:30:41 +00004470
Benjamin Kramer9170e912013-02-22 15:46:01 +00004471 SmallString<128> Str;
Guy Benyei11169dd2012-12-18 14:30:41 +00004472 llvm::raw_svector_ostream OS(Str);
4473 OS << *ClassSpec;
David Majnemer6fbeee32016-07-07 04:43:07 +00004474 TemplateSpecializationType::PrintTemplateArgumentList(
4475 OS, ClassSpec->getTemplateArgs().asArray(), Policy);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004476 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004477 }
4478
4479 return clang_getCursorSpelling(C);
4480}
4481
4482CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
4483 switch (Kind) {
4484 case CXCursor_FunctionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004485 return cxstring::createRef("FunctionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004486 case CXCursor_TypedefDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004487 return cxstring::createRef("TypedefDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004488 case CXCursor_EnumDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004489 return cxstring::createRef("EnumDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004490 case CXCursor_EnumConstantDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004491 return cxstring::createRef("EnumConstantDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004492 case CXCursor_StructDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004493 return cxstring::createRef("StructDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004494 case CXCursor_UnionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004495 return cxstring::createRef("UnionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004496 case CXCursor_ClassDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004497 return cxstring::createRef("ClassDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004498 case CXCursor_FieldDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004499 return cxstring::createRef("FieldDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004500 case CXCursor_VarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004501 return cxstring::createRef("VarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004502 case CXCursor_ParmDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004503 return cxstring::createRef("ParmDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004504 case CXCursor_ObjCInterfaceDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004505 return cxstring::createRef("ObjCInterfaceDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004506 case CXCursor_ObjCCategoryDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004507 return cxstring::createRef("ObjCCategoryDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004508 case CXCursor_ObjCProtocolDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004509 return cxstring::createRef("ObjCProtocolDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004510 case CXCursor_ObjCPropertyDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004511 return cxstring::createRef("ObjCPropertyDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004512 case CXCursor_ObjCIvarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004513 return cxstring::createRef("ObjCIvarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004514 case CXCursor_ObjCInstanceMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004515 return cxstring::createRef("ObjCInstanceMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004516 case CXCursor_ObjCClassMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004517 return cxstring::createRef("ObjCClassMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004518 case CXCursor_ObjCImplementationDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004519 return cxstring::createRef("ObjCImplementationDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004520 case CXCursor_ObjCCategoryImplDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004521 return cxstring::createRef("ObjCCategoryImplDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004522 case CXCursor_CXXMethod:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004523 return cxstring::createRef("CXXMethod");
Guy Benyei11169dd2012-12-18 14:30:41 +00004524 case CXCursor_UnexposedDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004525 return cxstring::createRef("UnexposedDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004526 case CXCursor_ObjCSuperClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004527 return cxstring::createRef("ObjCSuperClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004528 case CXCursor_ObjCProtocolRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004529 return cxstring::createRef("ObjCProtocolRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004530 case CXCursor_ObjCClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004531 return cxstring::createRef("ObjCClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004532 case CXCursor_TypeRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004533 return cxstring::createRef("TypeRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004534 case CXCursor_TemplateRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004535 return cxstring::createRef("TemplateRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004536 case CXCursor_NamespaceRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004537 return cxstring::createRef("NamespaceRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004538 case CXCursor_MemberRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004539 return cxstring::createRef("MemberRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004540 case CXCursor_LabelRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004541 return cxstring::createRef("LabelRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004542 case CXCursor_OverloadedDeclRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004543 return cxstring::createRef("OverloadedDeclRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004544 case CXCursor_VariableRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004545 return cxstring::createRef("VariableRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004546 case CXCursor_IntegerLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004547 return cxstring::createRef("IntegerLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004548 case CXCursor_FloatingLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004549 return cxstring::createRef("FloatingLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004550 case CXCursor_ImaginaryLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004551 return cxstring::createRef("ImaginaryLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004552 case CXCursor_StringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004553 return cxstring::createRef("StringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004554 case CXCursor_CharacterLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004555 return cxstring::createRef("CharacterLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004556 case CXCursor_ParenExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004557 return cxstring::createRef("ParenExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004558 case CXCursor_UnaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004559 return cxstring::createRef("UnaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004560 case CXCursor_ArraySubscriptExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004561 return cxstring::createRef("ArraySubscriptExpr");
Alexey Bataev1a3320e2015-08-25 14:24:04 +00004562 case CXCursor_OMPArraySectionExpr:
4563 return cxstring::createRef("OMPArraySectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004564 case CXCursor_BinaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004565 return cxstring::createRef("BinaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004566 case CXCursor_CompoundAssignOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004567 return cxstring::createRef("CompoundAssignOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004568 case CXCursor_ConditionalOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004569 return cxstring::createRef("ConditionalOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004570 case CXCursor_CStyleCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004571 return cxstring::createRef("CStyleCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004572 case CXCursor_CompoundLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004573 return cxstring::createRef("CompoundLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004574 case CXCursor_InitListExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004575 return cxstring::createRef("InitListExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004576 case CXCursor_AddrLabelExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004577 return cxstring::createRef("AddrLabelExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004578 case CXCursor_StmtExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004579 return cxstring::createRef("StmtExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004580 case CXCursor_GenericSelectionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004581 return cxstring::createRef("GenericSelectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004582 case CXCursor_GNUNullExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004583 return cxstring::createRef("GNUNullExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004584 case CXCursor_CXXStaticCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004585 return cxstring::createRef("CXXStaticCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004586 case CXCursor_CXXDynamicCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004587 return cxstring::createRef("CXXDynamicCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004588 case CXCursor_CXXReinterpretCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004589 return cxstring::createRef("CXXReinterpretCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004590 case CXCursor_CXXConstCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004591 return cxstring::createRef("CXXConstCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004592 case CXCursor_CXXFunctionalCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004593 return cxstring::createRef("CXXFunctionalCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004594 case CXCursor_CXXTypeidExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004595 return cxstring::createRef("CXXTypeidExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004596 case CXCursor_CXXBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004597 return cxstring::createRef("CXXBoolLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004598 case CXCursor_CXXNullPtrLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004599 return cxstring::createRef("CXXNullPtrLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004600 case CXCursor_CXXThisExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004601 return cxstring::createRef("CXXThisExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004602 case CXCursor_CXXThrowExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004603 return cxstring::createRef("CXXThrowExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004604 case CXCursor_CXXNewExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004605 return cxstring::createRef("CXXNewExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004606 case CXCursor_CXXDeleteExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004607 return cxstring::createRef("CXXDeleteExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004608 case CXCursor_UnaryExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004609 return cxstring::createRef("UnaryExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004610 case CXCursor_ObjCStringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004611 return cxstring::createRef("ObjCStringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004612 case CXCursor_ObjCBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004613 return cxstring::createRef("ObjCBoolLiteralExpr");
Argyrios Kyrtzidisc2233be2013-04-23 17:57:17 +00004614 case CXCursor_ObjCSelfExpr:
4615 return cxstring::createRef("ObjCSelfExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004616 case CXCursor_ObjCEncodeExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004617 return cxstring::createRef("ObjCEncodeExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004618 case CXCursor_ObjCSelectorExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004619 return cxstring::createRef("ObjCSelectorExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004620 case CXCursor_ObjCProtocolExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004621 return cxstring::createRef("ObjCProtocolExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004622 case CXCursor_ObjCBridgedCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004623 return cxstring::createRef("ObjCBridgedCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004624 case CXCursor_BlockExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004625 return cxstring::createRef("BlockExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004626 case CXCursor_PackExpansionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004627 return cxstring::createRef("PackExpansionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004628 case CXCursor_SizeOfPackExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004629 return cxstring::createRef("SizeOfPackExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004630 case CXCursor_LambdaExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004631 return cxstring::createRef("LambdaExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004632 case CXCursor_UnexposedExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004633 return cxstring::createRef("UnexposedExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004634 case CXCursor_DeclRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004635 return cxstring::createRef("DeclRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004636 case CXCursor_MemberRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004637 return cxstring::createRef("MemberRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004638 case CXCursor_CallExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004639 return cxstring::createRef("CallExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004640 case CXCursor_ObjCMessageExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004641 return cxstring::createRef("ObjCMessageExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004642 case CXCursor_UnexposedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004643 return cxstring::createRef("UnexposedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004644 case CXCursor_DeclStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004645 return cxstring::createRef("DeclStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004646 case CXCursor_LabelStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004647 return cxstring::createRef("LabelStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004648 case CXCursor_CompoundStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004649 return cxstring::createRef("CompoundStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004650 case CXCursor_CaseStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004651 return cxstring::createRef("CaseStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004652 case CXCursor_DefaultStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004653 return cxstring::createRef("DefaultStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004654 case CXCursor_IfStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004655 return cxstring::createRef("IfStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004656 case CXCursor_SwitchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004657 return cxstring::createRef("SwitchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004658 case CXCursor_WhileStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004659 return cxstring::createRef("WhileStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004660 case CXCursor_DoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004661 return cxstring::createRef("DoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004662 case CXCursor_ForStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004663 return cxstring::createRef("ForStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004664 case CXCursor_GotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004665 return cxstring::createRef("GotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004666 case CXCursor_IndirectGotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004667 return cxstring::createRef("IndirectGotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004668 case CXCursor_ContinueStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004669 return cxstring::createRef("ContinueStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004670 case CXCursor_BreakStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004671 return cxstring::createRef("BreakStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004672 case CXCursor_ReturnStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004673 return cxstring::createRef("ReturnStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004674 case CXCursor_GCCAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004675 return cxstring::createRef("GCCAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004676 case CXCursor_MSAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004677 return cxstring::createRef("MSAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004678 case CXCursor_ObjCAtTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004679 return cxstring::createRef("ObjCAtTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004680 case CXCursor_ObjCAtCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004681 return cxstring::createRef("ObjCAtCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004682 case CXCursor_ObjCAtFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004683 return cxstring::createRef("ObjCAtFinallyStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004684 case CXCursor_ObjCAtThrowStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004685 return cxstring::createRef("ObjCAtThrowStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004686 case CXCursor_ObjCAtSynchronizedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004687 return cxstring::createRef("ObjCAtSynchronizedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004688 case CXCursor_ObjCAutoreleasePoolStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004689 return cxstring::createRef("ObjCAutoreleasePoolStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004690 case CXCursor_ObjCForCollectionStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004691 return cxstring::createRef("ObjCForCollectionStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004692 case CXCursor_CXXCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004693 return cxstring::createRef("CXXCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004694 case CXCursor_CXXTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004695 return cxstring::createRef("CXXTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004696 case CXCursor_CXXForRangeStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004697 return cxstring::createRef("CXXForRangeStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004698 case CXCursor_SEHTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004699 return cxstring::createRef("SEHTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004700 case CXCursor_SEHExceptStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004701 return cxstring::createRef("SEHExceptStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004702 case CXCursor_SEHFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004703 return cxstring::createRef("SEHFinallyStmt");
Nico Weber9b982072014-07-07 00:12:30 +00004704 case CXCursor_SEHLeaveStmt:
4705 return cxstring::createRef("SEHLeaveStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004706 case CXCursor_NullStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004707 return cxstring::createRef("NullStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004708 case CXCursor_InvalidFile:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004709 return cxstring::createRef("InvalidFile");
Guy Benyei11169dd2012-12-18 14:30:41 +00004710 case CXCursor_InvalidCode:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004711 return cxstring::createRef("InvalidCode");
Guy Benyei11169dd2012-12-18 14:30:41 +00004712 case CXCursor_NoDeclFound:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004713 return cxstring::createRef("NoDeclFound");
Guy Benyei11169dd2012-12-18 14:30:41 +00004714 case CXCursor_NotImplemented:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004715 return cxstring::createRef("NotImplemented");
Guy Benyei11169dd2012-12-18 14:30:41 +00004716 case CXCursor_TranslationUnit:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004717 return cxstring::createRef("TranslationUnit");
Guy Benyei11169dd2012-12-18 14:30:41 +00004718 case CXCursor_UnexposedAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004719 return cxstring::createRef("UnexposedAttr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004720 case CXCursor_IBActionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004721 return cxstring::createRef("attribute(ibaction)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004722 case CXCursor_IBOutletAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004723 return cxstring::createRef("attribute(iboutlet)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004724 case CXCursor_IBOutletCollectionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004725 return cxstring::createRef("attribute(iboutletcollection)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004726 case CXCursor_CXXFinalAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004727 return cxstring::createRef("attribute(final)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004728 case CXCursor_CXXOverrideAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004729 return cxstring::createRef("attribute(override)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004730 case CXCursor_AnnotateAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004731 return cxstring::createRef("attribute(annotate)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004732 case CXCursor_AsmLabelAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004733 return cxstring::createRef("asm label");
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004734 case CXCursor_PackedAttr:
4735 return cxstring::createRef("attribute(packed)");
Joey Gouly81228382014-05-01 15:41:58 +00004736 case CXCursor_PureAttr:
4737 return cxstring::createRef("attribute(pure)");
4738 case CXCursor_ConstAttr:
4739 return cxstring::createRef("attribute(const)");
4740 case CXCursor_NoDuplicateAttr:
4741 return cxstring::createRef("attribute(noduplicate)");
Eli Bendersky2581e662014-05-28 19:29:58 +00004742 case CXCursor_CUDAConstantAttr:
4743 return cxstring::createRef("attribute(constant)");
4744 case CXCursor_CUDADeviceAttr:
4745 return cxstring::createRef("attribute(device)");
4746 case CXCursor_CUDAGlobalAttr:
4747 return cxstring::createRef("attribute(global)");
4748 case CXCursor_CUDAHostAttr:
4749 return cxstring::createRef("attribute(host)");
Eli Bendersky9b071472014-08-08 14:59:00 +00004750 case CXCursor_CUDASharedAttr:
4751 return cxstring::createRef("attribute(shared)");
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004752 case CXCursor_VisibilityAttr:
4753 return cxstring::createRef("attribute(visibility)");
Saleem Abdulrasool8aa0b802015-12-10 18:45:18 +00004754 case CXCursor_DLLExport:
4755 return cxstring::createRef("attribute(dllexport)");
4756 case CXCursor_DLLImport:
4757 return cxstring::createRef("attribute(dllimport)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004758 case CXCursor_PreprocessingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004759 return cxstring::createRef("preprocessing directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004760 case CXCursor_MacroDefinition:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004761 return cxstring::createRef("macro definition");
Guy Benyei11169dd2012-12-18 14:30:41 +00004762 case CXCursor_MacroExpansion:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004763 return cxstring::createRef("macro expansion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004764 case CXCursor_InclusionDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004765 return cxstring::createRef("inclusion directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004766 case CXCursor_Namespace:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004767 return cxstring::createRef("Namespace");
Guy Benyei11169dd2012-12-18 14:30:41 +00004768 case CXCursor_LinkageSpec:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004769 return cxstring::createRef("LinkageSpec");
Guy Benyei11169dd2012-12-18 14:30:41 +00004770 case CXCursor_CXXBaseSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004771 return cxstring::createRef("C++ base class specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00004772 case CXCursor_Constructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004773 return cxstring::createRef("CXXConstructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004774 case CXCursor_Destructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004775 return cxstring::createRef("CXXDestructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004776 case CXCursor_ConversionFunction:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004777 return cxstring::createRef("CXXConversion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004778 case CXCursor_TemplateTypeParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004779 return cxstring::createRef("TemplateTypeParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004780 case CXCursor_NonTypeTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004781 return cxstring::createRef("NonTypeTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004782 case CXCursor_TemplateTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004783 return cxstring::createRef("TemplateTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004784 case CXCursor_FunctionTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004785 return cxstring::createRef("FunctionTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00004786 case CXCursor_ClassTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004787 return cxstring::createRef("ClassTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00004788 case CXCursor_ClassTemplatePartialSpecialization:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004789 return cxstring::createRef("ClassTemplatePartialSpecialization");
Guy Benyei11169dd2012-12-18 14:30:41 +00004790 case CXCursor_NamespaceAlias:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004791 return cxstring::createRef("NamespaceAlias");
Guy Benyei11169dd2012-12-18 14:30:41 +00004792 case CXCursor_UsingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004793 return cxstring::createRef("UsingDirective");
Guy Benyei11169dd2012-12-18 14:30:41 +00004794 case CXCursor_UsingDeclaration:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004795 return cxstring::createRef("UsingDeclaration");
Guy Benyei11169dd2012-12-18 14:30:41 +00004796 case CXCursor_TypeAliasDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004797 return cxstring::createRef("TypeAliasDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004798 case CXCursor_ObjCSynthesizeDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004799 return cxstring::createRef("ObjCSynthesizeDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004800 case CXCursor_ObjCDynamicDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004801 return cxstring::createRef("ObjCDynamicDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004802 case CXCursor_CXXAccessSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004803 return cxstring::createRef("CXXAccessSpecifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00004804 case CXCursor_ModuleImportDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004805 return cxstring::createRef("ModuleImport");
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00004806 case CXCursor_OMPParallelDirective:
Alexey Bataev1b59ab52014-02-27 08:29:12 +00004807 return cxstring::createRef("OMPParallelDirective");
4808 case CXCursor_OMPSimdDirective:
4809 return cxstring::createRef("OMPSimdDirective");
Alexey Bataevf29276e2014-06-18 04:14:57 +00004810 case CXCursor_OMPForDirective:
4811 return cxstring::createRef("OMPForDirective");
Alexander Musmanf82886e2014-09-18 05:12:34 +00004812 case CXCursor_OMPForSimdDirective:
4813 return cxstring::createRef("OMPForSimdDirective");
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00004814 case CXCursor_OMPSectionsDirective:
4815 return cxstring::createRef("OMPSectionsDirective");
Alexey Bataev1e0498a2014-06-26 08:21:58 +00004816 case CXCursor_OMPSectionDirective:
4817 return cxstring::createRef("OMPSectionDirective");
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00004818 case CXCursor_OMPSingleDirective:
4819 return cxstring::createRef("OMPSingleDirective");
Alexander Musman80c22892014-07-17 08:54:58 +00004820 case CXCursor_OMPMasterDirective:
4821 return cxstring::createRef("OMPMasterDirective");
Alexander Musmand9ed09f2014-07-21 09:42:05 +00004822 case CXCursor_OMPCriticalDirective:
4823 return cxstring::createRef("OMPCriticalDirective");
Alexey Bataev4acb8592014-07-07 13:01:15 +00004824 case CXCursor_OMPParallelForDirective:
4825 return cxstring::createRef("OMPParallelForDirective");
Alexander Musmane4e893b2014-09-23 09:33:00 +00004826 case CXCursor_OMPParallelForSimdDirective:
4827 return cxstring::createRef("OMPParallelForSimdDirective");
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00004828 case CXCursor_OMPParallelSectionsDirective:
4829 return cxstring::createRef("OMPParallelSectionsDirective");
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00004830 case CXCursor_OMPTaskDirective:
4831 return cxstring::createRef("OMPTaskDirective");
Alexey Bataev68446b72014-07-18 07:47:19 +00004832 case CXCursor_OMPTaskyieldDirective:
4833 return cxstring::createRef("OMPTaskyieldDirective");
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00004834 case CXCursor_OMPBarrierDirective:
4835 return cxstring::createRef("OMPBarrierDirective");
Alexey Bataev2df347a2014-07-18 10:17:07 +00004836 case CXCursor_OMPTaskwaitDirective:
4837 return cxstring::createRef("OMPTaskwaitDirective");
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00004838 case CXCursor_OMPTaskgroupDirective:
4839 return cxstring::createRef("OMPTaskgroupDirective");
Alexey Bataev6125da92014-07-21 11:26:11 +00004840 case CXCursor_OMPFlushDirective:
4841 return cxstring::createRef("OMPFlushDirective");
Alexey Bataev9fb6e642014-07-22 06:45:04 +00004842 case CXCursor_OMPOrderedDirective:
4843 return cxstring::createRef("OMPOrderedDirective");
Alexey Bataev0162e452014-07-22 10:10:35 +00004844 case CXCursor_OMPAtomicDirective:
4845 return cxstring::createRef("OMPAtomicDirective");
Alexey Bataev0bd520b2014-09-19 08:19:49 +00004846 case CXCursor_OMPTargetDirective:
4847 return cxstring::createRef("OMPTargetDirective");
Michael Wong65f367f2015-07-21 13:44:28 +00004848 case CXCursor_OMPTargetDataDirective:
4849 return cxstring::createRef("OMPTargetDataDirective");
Samuel Antaodf67fc42016-01-19 19:15:56 +00004850 case CXCursor_OMPTargetEnterDataDirective:
4851 return cxstring::createRef("OMPTargetEnterDataDirective");
Samuel Antao72590762016-01-19 20:04:50 +00004852 case CXCursor_OMPTargetExitDataDirective:
4853 return cxstring::createRef("OMPTargetExitDataDirective");
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00004854 case CXCursor_OMPTargetParallelDirective:
4855 return cxstring::createRef("OMPTargetParallelDirective");
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00004856 case CXCursor_OMPTargetParallelForDirective:
4857 return cxstring::createRef("OMPTargetParallelForDirective");
Samuel Antao686c70c2016-05-26 17:30:50 +00004858 case CXCursor_OMPTargetUpdateDirective:
4859 return cxstring::createRef("OMPTargetUpdateDirective");
Alexey Bataev13314bf2014-10-09 04:18:56 +00004860 case CXCursor_OMPTeamsDirective:
4861 return cxstring::createRef("OMPTeamsDirective");
Alexey Bataev6d4ed052015-07-01 06:57:41 +00004862 case CXCursor_OMPCancellationPointDirective:
4863 return cxstring::createRef("OMPCancellationPointDirective");
Alexey Bataev80909872015-07-02 11:25:17 +00004864 case CXCursor_OMPCancelDirective:
4865 return cxstring::createRef("OMPCancelDirective");
Alexey Bataev49f6e782015-12-01 04:18:41 +00004866 case CXCursor_OMPTaskLoopDirective:
4867 return cxstring::createRef("OMPTaskLoopDirective");
Alexey Bataev0a6ed842015-12-03 09:40:15 +00004868 case CXCursor_OMPTaskLoopSimdDirective:
4869 return cxstring::createRef("OMPTaskLoopSimdDirective");
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00004870 case CXCursor_OMPDistributeDirective:
4871 return cxstring::createRef("OMPDistributeDirective");
Carlo Bertolli9925f152016-06-27 14:55:37 +00004872 case CXCursor_OMPDistributeParallelForDirective:
4873 return cxstring::createRef("OMPDistributeParallelForDirective");
Kelvin Li4a39add2016-07-05 05:00:15 +00004874 case CXCursor_OMPDistributeParallelForSimdDirective:
4875 return cxstring::createRef("OMPDistributeParallelForSimdDirective");
Kelvin Li787f3fc2016-07-06 04:45:38 +00004876 case CXCursor_OMPDistributeSimdDirective:
4877 return cxstring::createRef("OMPDistributeSimdDirective");
Kelvin Lia579b912016-07-14 02:54:56 +00004878 case CXCursor_OMPTargetParallelForSimdDirective:
4879 return cxstring::createRef("OMPTargetParallelForSimdDirective");
Francisco Lopes da Silva975a9f62015-01-21 16:24:11 +00004880 case CXCursor_OverloadCandidate:
4881 return cxstring::createRef("OverloadCandidate");
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +00004882 case CXCursor_TypeAliasTemplateDecl:
4883 return cxstring::createRef("TypeAliasTemplateDecl");
Olivier Goffart81978012016-06-09 16:15:55 +00004884 case CXCursor_StaticAssert:
4885 return cxstring::createRef("StaticAssert");
Guy Benyei11169dd2012-12-18 14:30:41 +00004886 }
4887
4888 llvm_unreachable("Unhandled CXCursorKind");
4889}
4890
4891struct GetCursorData {
4892 SourceLocation TokenBeginLoc;
4893 bool PointsAtMacroArgExpansion;
4894 bool VisitedObjCPropertyImplDecl;
4895 SourceLocation VisitedDeclaratorDeclStartLoc;
4896 CXCursor &BestCursor;
4897
4898 GetCursorData(SourceManager &SM,
4899 SourceLocation tokenBegin, CXCursor &outputCursor)
4900 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
4901 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
4902 VisitedObjCPropertyImplDecl = false;
4903 }
4904};
4905
4906static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
4907 CXCursor parent,
4908 CXClientData client_data) {
4909 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
4910 CXCursor *BestCursor = &Data->BestCursor;
4911
4912 // If we point inside a macro argument we should provide info of what the
4913 // token is so use the actual cursor, don't replace it with a macro expansion
4914 // cursor.
4915 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
4916 return CXChildVisit_Recurse;
4917
4918 if (clang_isDeclaration(cursor.kind)) {
4919 // Avoid having the implicit methods override the property decls.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004920 if (const ObjCMethodDecl *MD
Guy Benyei11169dd2012-12-18 14:30:41 +00004921 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
4922 if (MD->isImplicit())
4923 return CXChildVisit_Break;
4924
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004925 } else if (const ObjCInterfaceDecl *ID
Guy Benyei11169dd2012-12-18 14:30:41 +00004926 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(cursor))) {
4927 // Check that when we have multiple @class references in the same line,
4928 // that later ones do not override the previous ones.
4929 // If we have:
4930 // @class Foo, Bar;
4931 // source ranges for both start at '@', so 'Bar' will end up overriding
4932 // 'Foo' even though the cursor location was at 'Foo'.
4933 if (BestCursor->kind == CXCursor_ObjCInterfaceDecl ||
4934 BestCursor->kind == CXCursor_ObjCClassRef)
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004935 if (const ObjCInterfaceDecl *PrevID
Guy Benyei11169dd2012-12-18 14:30:41 +00004936 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(*BestCursor))){
4937 if (PrevID != ID &&
4938 !PrevID->isThisDeclarationADefinition() &&
4939 !ID->isThisDeclarationADefinition())
4940 return CXChildVisit_Break;
4941 }
4942
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004943 } else if (const DeclaratorDecl *DD
Guy Benyei11169dd2012-12-18 14:30:41 +00004944 = dyn_cast_or_null<DeclaratorDecl>(getCursorDecl(cursor))) {
4945 SourceLocation StartLoc = DD->getSourceRange().getBegin();
4946 // Check that when we have multiple declarators in the same line,
4947 // that later ones do not override the previous ones.
4948 // If we have:
4949 // int Foo, Bar;
4950 // source ranges for both start at 'int', so 'Bar' will end up overriding
4951 // 'Foo' even though the cursor location was at 'Foo'.
4952 if (Data->VisitedDeclaratorDeclStartLoc == StartLoc)
4953 return CXChildVisit_Break;
4954 Data->VisitedDeclaratorDeclStartLoc = StartLoc;
4955
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004956 } else if (const ObjCPropertyImplDecl *PropImp
Guy Benyei11169dd2012-12-18 14:30:41 +00004957 = dyn_cast_or_null<ObjCPropertyImplDecl>(getCursorDecl(cursor))) {
4958 (void)PropImp;
4959 // Check that when we have multiple @synthesize in the same line,
4960 // that later ones do not override the previous ones.
4961 // If we have:
4962 // @synthesize Foo, Bar;
4963 // source ranges for both start at '@', so 'Bar' will end up overriding
4964 // 'Foo' even though the cursor location was at 'Foo'.
4965 if (Data->VisitedObjCPropertyImplDecl)
4966 return CXChildVisit_Break;
4967 Data->VisitedObjCPropertyImplDecl = true;
4968 }
4969 }
4970
4971 if (clang_isExpression(cursor.kind) &&
4972 clang_isDeclaration(BestCursor->kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004973 if (const Decl *D = getCursorDecl(*BestCursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004974 // Avoid having the cursor of an expression replace the declaration cursor
4975 // when the expression source range overlaps the declaration range.
4976 // This can happen for C++ constructor expressions whose range generally
4977 // include the variable declaration, e.g.:
4978 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
4979 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
4980 D->getLocation() == Data->TokenBeginLoc)
4981 return CXChildVisit_Break;
4982 }
4983 }
4984
4985 // If our current best cursor is the construction of a temporary object,
4986 // don't replace that cursor with a type reference, because we want
4987 // clang_getCursor() to point at the constructor.
4988 if (clang_isExpression(BestCursor->kind) &&
4989 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
4990 cursor.kind == CXCursor_TypeRef) {
4991 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
4992 // as having the actual point on the type reference.
4993 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
4994 return CXChildVisit_Recurse;
4995 }
Douglas Gregore9d95f12015-07-07 03:57:35 +00004996
4997 // If we already have an Objective-C superclass reference, don't
4998 // update it further.
4999 if (BestCursor->kind == CXCursor_ObjCSuperClassRef)
5000 return CXChildVisit_Break;
5001
Guy Benyei11169dd2012-12-18 14:30:41 +00005002 *BestCursor = cursor;
5003 return CXChildVisit_Recurse;
5004}
5005
5006CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005007 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005008 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005009 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005010 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005011
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005012 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005013 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
5014
5015 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
5016 CXCursor Result = cxcursor::getCursor(TU, SLoc);
5017
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005018 LOG_FUNC_SECTION {
Guy Benyei11169dd2012-12-18 14:30:41 +00005019 CXFile SearchFile;
5020 unsigned SearchLine, SearchColumn;
5021 CXFile ResultFile;
5022 unsigned ResultLine, ResultColumn;
5023 CXString SearchFileName, ResultFileName, KindSpelling, USR;
5024 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
5025 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
Craig Topper69186e72014-06-08 08:38:04 +00005026
5027 clang_getFileLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
5028 nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005029 clang_getFileLocation(ResultLoc, &ResultFile, &ResultLine,
Craig Topper69186e72014-06-08 08:38:04 +00005030 &ResultColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005031 SearchFileName = clang_getFileName(SearchFile);
5032 ResultFileName = clang_getFileName(ResultFile);
5033 KindSpelling = clang_getCursorKindSpelling(Result.kind);
5034 USR = clang_getCursorUSR(Result);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005035 *Log << llvm::format("(%s:%d:%d) = %s",
5036 clang_getCString(SearchFileName), SearchLine, SearchColumn,
5037 clang_getCString(KindSpelling))
5038 << llvm::format("(%s:%d:%d):%s%s",
5039 clang_getCString(ResultFileName), ResultLine, ResultColumn,
5040 clang_getCString(USR), IsDef);
Guy Benyei11169dd2012-12-18 14:30:41 +00005041 clang_disposeString(SearchFileName);
5042 clang_disposeString(ResultFileName);
5043 clang_disposeString(KindSpelling);
5044 clang_disposeString(USR);
5045
5046 CXCursor Definition = clang_getCursorDefinition(Result);
5047 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
5048 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
5049 CXString DefinitionKindSpelling
5050 = clang_getCursorKindSpelling(Definition.kind);
5051 CXFile DefinitionFile;
5052 unsigned DefinitionLine, DefinitionColumn;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005053 clang_getFileLocation(DefinitionLoc, &DefinitionFile,
Craig Topper69186e72014-06-08 08:38:04 +00005054 &DefinitionLine, &DefinitionColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005055 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005056 *Log << llvm::format(" -> %s(%s:%d:%d)",
5057 clang_getCString(DefinitionKindSpelling),
5058 clang_getCString(DefinitionFileName),
5059 DefinitionLine, DefinitionColumn);
Guy Benyei11169dd2012-12-18 14:30:41 +00005060 clang_disposeString(DefinitionFileName);
5061 clang_disposeString(DefinitionKindSpelling);
5062 }
5063 }
5064
5065 return Result;
5066}
5067
5068CXCursor clang_getNullCursor(void) {
5069 return MakeCXCursorInvalid(CXCursor_InvalidFile);
5070}
5071
5072unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005073 // Clear out the "FirstInDeclGroup" part in a declaration cursor, since we
5074 // can't set consistently. For example, when visiting a DeclStmt we will set
5075 // it but we don't set it on the result of clang_getCursorDefinition for
5076 // a reference of the same declaration.
5077 // FIXME: Setting "FirstInDeclGroup" in CXCursors is a hack that only works
5078 // when visiting a DeclStmt currently, the AST should be enhanced to be able
5079 // to provide that kind of info.
5080 if (clang_isDeclaration(X.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005081 X.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005082 if (clang_isDeclaration(Y.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005083 Y.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005084
Guy Benyei11169dd2012-12-18 14:30:41 +00005085 return X == Y;
5086}
5087
5088unsigned clang_hashCursor(CXCursor C) {
5089 unsigned Index = 0;
5090 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
5091 Index = 1;
5092
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005093 return llvm::DenseMapInfo<std::pair<unsigned, const void*> >::getHashValue(
Guy Benyei11169dd2012-12-18 14:30:41 +00005094 std::make_pair(C.kind, C.data[Index]));
5095}
5096
5097unsigned clang_isInvalid(enum CXCursorKind K) {
5098 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
5099}
5100
5101unsigned clang_isDeclaration(enum CXCursorKind K) {
5102 return (K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl) ||
5103 (K >= CXCursor_FirstExtraDecl && K <= CXCursor_LastExtraDecl);
5104}
5105
5106unsigned clang_isReference(enum CXCursorKind K) {
5107 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
5108}
5109
5110unsigned clang_isExpression(enum CXCursorKind K) {
5111 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
5112}
5113
5114unsigned clang_isStatement(enum CXCursorKind K) {
5115 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
5116}
5117
5118unsigned clang_isAttribute(enum CXCursorKind K) {
5119 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
5120}
5121
5122unsigned clang_isTranslationUnit(enum CXCursorKind K) {
5123 return K == CXCursor_TranslationUnit;
5124}
5125
5126unsigned clang_isPreprocessing(enum CXCursorKind K) {
5127 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
5128}
5129
5130unsigned clang_isUnexposed(enum CXCursorKind K) {
5131 switch (K) {
5132 case CXCursor_UnexposedDecl:
5133 case CXCursor_UnexposedExpr:
5134 case CXCursor_UnexposedStmt:
5135 case CXCursor_UnexposedAttr:
5136 return true;
5137 default:
5138 return false;
5139 }
5140}
5141
5142CXCursorKind clang_getCursorKind(CXCursor C) {
5143 return C.kind;
5144}
5145
5146CXSourceLocation clang_getCursorLocation(CXCursor C) {
5147 if (clang_isReference(C.kind)) {
5148 switch (C.kind) {
5149 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005150 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005151 = getCursorObjCSuperClassRef(C);
5152 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5153 }
5154
5155 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005156 std::pair<const ObjCProtocolDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005157 = getCursorObjCProtocolRef(C);
5158 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5159 }
5160
5161 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005162 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005163 = getCursorObjCClassRef(C);
5164 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5165 }
5166
5167 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005168 std::pair<const TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005169 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5170 }
5171
5172 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005173 std::pair<const TemplateDecl *, SourceLocation> P =
5174 getCursorTemplateRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005175 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5176 }
5177
5178 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005179 std::pair<const NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005180 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5181 }
5182
5183 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005184 std::pair<const FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005185 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5186 }
5187
5188 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005189 std::pair<const VarDecl *, SourceLocation> P = getCursorVariableRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005190 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5191 }
5192
5193 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005194 const CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005195 if (!BaseSpec)
5196 return clang_getNullLocation();
5197
5198 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
5199 return cxloc::translateSourceLocation(getCursorContext(C),
5200 TSInfo->getTypeLoc().getBeginLoc());
5201
5202 return cxloc::translateSourceLocation(getCursorContext(C),
5203 BaseSpec->getLocStart());
5204 }
5205
5206 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005207 std::pair<const LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005208 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
5209 }
5210
5211 case CXCursor_OverloadedDeclRef:
5212 return cxloc::translateSourceLocation(getCursorContext(C),
5213 getCursorOverloadedDeclRef(C).second);
5214
5215 default:
5216 // FIXME: Need a way to enumerate all non-reference cases.
5217 llvm_unreachable("Missed a reference kind");
5218 }
5219 }
5220
5221 if (clang_isExpression(C.kind))
5222 return cxloc::translateSourceLocation(getCursorContext(C),
5223 getLocationFromExpr(getCursorExpr(C)));
5224
5225 if (clang_isStatement(C.kind))
5226 return cxloc::translateSourceLocation(getCursorContext(C),
5227 getCursorStmt(C)->getLocStart());
5228
5229 if (C.kind == CXCursor_PreprocessingDirective) {
5230 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
5231 return cxloc::translateSourceLocation(getCursorContext(C), L);
5232 }
5233
5234 if (C.kind == CXCursor_MacroExpansion) {
5235 SourceLocation L
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005236 = cxcursor::getCursorMacroExpansion(C).getSourceRange().getBegin();
Guy Benyei11169dd2012-12-18 14:30:41 +00005237 return cxloc::translateSourceLocation(getCursorContext(C), L);
5238 }
5239
5240 if (C.kind == CXCursor_MacroDefinition) {
5241 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
5242 return cxloc::translateSourceLocation(getCursorContext(C), L);
5243 }
5244
5245 if (C.kind == CXCursor_InclusionDirective) {
5246 SourceLocation L
5247 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
5248 return cxloc::translateSourceLocation(getCursorContext(C), L);
5249 }
5250
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00005251 if (clang_isAttribute(C.kind)) {
5252 SourceLocation L
5253 = cxcursor::getCursorAttr(C)->getLocation();
5254 return cxloc::translateSourceLocation(getCursorContext(C), L);
5255 }
5256
Guy Benyei11169dd2012-12-18 14:30:41 +00005257 if (!clang_isDeclaration(C.kind))
5258 return clang_getNullLocation();
5259
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005260 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005261 if (!D)
5262 return clang_getNullLocation();
5263
5264 SourceLocation Loc = D->getLocation();
5265 // FIXME: Multiple variables declared in a single declaration
5266 // currently lack the information needed to correctly determine their
5267 // ranges when accounting for the type-specifier. We use context
5268 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5269 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005270 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005271 if (!cxcursor::isFirstInDeclGroup(C))
5272 Loc = VD->getLocation();
5273 }
5274
5275 // For ObjC methods, give the start location of the method name.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005276 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005277 Loc = MD->getSelectorStartLoc();
5278
5279 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
5280}
5281
5282} // end extern "C"
5283
5284CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
5285 assert(TU);
5286
5287 // Guard against an invalid SourceLocation, or we may assert in one
5288 // of the following calls.
5289 if (SLoc.isInvalid())
5290 return clang_getNullCursor();
5291
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005292 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005293
5294 // Translate the given source location to make it point at the beginning of
5295 // the token under the cursor.
5296 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
5297 CXXUnit->getASTContext().getLangOpts());
5298
5299 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
5300 if (SLoc.isValid()) {
5301 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
5302 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
5303 /*VisitPreprocessorLast=*/true,
5304 /*VisitIncludedEntities=*/false,
5305 SourceLocation(SLoc));
5306 CursorVis.visitFileRegion();
5307 }
5308
5309 return Result;
5310}
5311
5312static SourceRange getRawCursorExtent(CXCursor C) {
5313 if (clang_isReference(C.kind)) {
5314 switch (C.kind) {
5315 case CXCursor_ObjCSuperClassRef:
5316 return getCursorObjCSuperClassRef(C).second;
5317
5318 case CXCursor_ObjCProtocolRef:
5319 return getCursorObjCProtocolRef(C).second;
5320
5321 case CXCursor_ObjCClassRef:
5322 return getCursorObjCClassRef(C).second;
5323
5324 case CXCursor_TypeRef:
5325 return getCursorTypeRef(C).second;
5326
5327 case CXCursor_TemplateRef:
5328 return getCursorTemplateRef(C).second;
5329
5330 case CXCursor_NamespaceRef:
5331 return getCursorNamespaceRef(C).second;
5332
5333 case CXCursor_MemberRef:
5334 return getCursorMemberRef(C).second;
5335
5336 case CXCursor_CXXBaseSpecifier:
5337 return getCursorCXXBaseSpecifier(C)->getSourceRange();
5338
5339 case CXCursor_LabelRef:
5340 return getCursorLabelRef(C).second;
5341
5342 case CXCursor_OverloadedDeclRef:
5343 return getCursorOverloadedDeclRef(C).second;
5344
5345 case CXCursor_VariableRef:
5346 return getCursorVariableRef(C).second;
5347
5348 default:
5349 // FIXME: Need a way to enumerate all non-reference cases.
5350 llvm_unreachable("Missed a reference kind");
5351 }
5352 }
5353
5354 if (clang_isExpression(C.kind))
5355 return getCursorExpr(C)->getSourceRange();
5356
5357 if (clang_isStatement(C.kind))
5358 return getCursorStmt(C)->getSourceRange();
5359
5360 if (clang_isAttribute(C.kind))
5361 return getCursorAttr(C)->getRange();
5362
5363 if (C.kind == CXCursor_PreprocessingDirective)
5364 return cxcursor::getCursorPreprocessingDirective(C);
5365
5366 if (C.kind == CXCursor_MacroExpansion) {
5367 ASTUnit *TU = getCursorASTUnit(C);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005368 SourceRange Range = cxcursor::getCursorMacroExpansion(C).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00005369 return TU->mapRangeFromPreamble(Range);
5370 }
5371
5372 if (C.kind == CXCursor_MacroDefinition) {
5373 ASTUnit *TU = getCursorASTUnit(C);
5374 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
5375 return TU->mapRangeFromPreamble(Range);
5376 }
5377
5378 if (C.kind == CXCursor_InclusionDirective) {
5379 ASTUnit *TU = getCursorASTUnit(C);
5380 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
5381 return TU->mapRangeFromPreamble(Range);
5382 }
5383
5384 if (C.kind == CXCursor_TranslationUnit) {
5385 ASTUnit *TU = getCursorASTUnit(C);
5386 FileID MainID = TU->getSourceManager().getMainFileID();
5387 SourceLocation Start = TU->getSourceManager().getLocForStartOfFile(MainID);
5388 SourceLocation End = TU->getSourceManager().getLocForEndOfFile(MainID);
5389 return SourceRange(Start, End);
5390 }
5391
5392 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005393 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005394 if (!D)
5395 return SourceRange();
5396
5397 SourceRange R = D->getSourceRange();
5398 // FIXME: Multiple variables declared in a single declaration
5399 // currently lack the information needed to correctly determine their
5400 // ranges when accounting for the type-specifier. We use context
5401 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5402 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005403 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005404 if (!cxcursor::isFirstInDeclGroup(C))
5405 R.setBegin(VD->getLocation());
5406 }
5407 return R;
5408 }
5409 return SourceRange();
5410}
5411
5412/// \brief Retrieves the "raw" cursor extent, which is then extended to include
5413/// the decl-specifier-seq for declarations.
5414static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
5415 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005416 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005417 if (!D)
5418 return SourceRange();
5419
5420 SourceRange R = D->getSourceRange();
5421
5422 // Adjust the start of the location for declarations preceded by
5423 // declaration specifiers.
5424 SourceLocation StartLoc;
5425 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
5426 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
5427 StartLoc = TI->getTypeLoc().getLocStart();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005428 } else if (const TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005429 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
5430 StartLoc = TI->getTypeLoc().getLocStart();
5431 }
5432
5433 if (StartLoc.isValid() && R.getBegin().isValid() &&
5434 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
5435 R.setBegin(StartLoc);
5436
5437 // FIXME: Multiple variables declared in a single declaration
5438 // currently lack the information needed to correctly determine their
5439 // ranges when accounting for the type-specifier. We use context
5440 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5441 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005442 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005443 if (!cxcursor::isFirstInDeclGroup(C))
5444 R.setBegin(VD->getLocation());
5445 }
5446
5447 return R;
5448 }
5449
5450 return getRawCursorExtent(C);
5451}
5452
5453extern "C" {
5454
5455CXSourceRange clang_getCursorExtent(CXCursor C) {
5456 SourceRange R = getRawCursorExtent(C);
5457 if (R.isInvalid())
5458 return clang_getNullRange();
5459
5460 return cxloc::translateSourceRange(getCursorContext(C), R);
5461}
5462
5463CXCursor clang_getCursorReferenced(CXCursor C) {
5464 if (clang_isInvalid(C.kind))
5465 return clang_getNullCursor();
5466
5467 CXTranslationUnit tu = getCursorTU(C);
5468 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005469 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005470 if (!D)
5471 return clang_getNullCursor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005472 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005473 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005474 if (const ObjCPropertyImplDecl *PropImpl =
5475 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005476 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
5477 return MakeCXCursor(Property, tu);
5478
5479 return C;
5480 }
5481
5482 if (clang_isExpression(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005483 const Expr *E = getCursorExpr(C);
5484 const Decl *D = getDeclFromExpr(E);
Guy Benyei11169dd2012-12-18 14:30:41 +00005485 if (D) {
5486 CXCursor declCursor = MakeCXCursor(D, tu);
5487 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
5488 declCursor);
5489 return declCursor;
5490 }
5491
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005492 if (const OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00005493 return MakeCursorOverloadedDeclRef(Ovl, tu);
5494
5495 return clang_getNullCursor();
5496 }
5497
5498 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005499 const Stmt *S = getCursorStmt(C);
5500 if (const GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Guy Benyei11169dd2012-12-18 14:30:41 +00005501 if (LabelDecl *label = Goto->getLabel())
5502 if (LabelStmt *labelS = label->getStmt())
5503 return MakeCXCursor(labelS, getCursorDecl(C), tu);
5504
5505 return clang_getNullCursor();
5506 }
Richard Smith66a81862015-05-04 02:25:31 +00005507
Guy Benyei11169dd2012-12-18 14:30:41 +00005508 if (C.kind == CXCursor_MacroExpansion) {
Richard Smith66a81862015-05-04 02:25:31 +00005509 if (const MacroDefinitionRecord *Def =
5510 getCursorMacroExpansion(C).getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005511 return MakeMacroDefinitionCursor(Def, tu);
5512 }
5513
5514 if (!clang_isReference(C.kind))
5515 return clang_getNullCursor();
5516
5517 switch (C.kind) {
5518 case CXCursor_ObjCSuperClassRef:
5519 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
5520
5521 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005522 const ObjCProtocolDecl *Prot = getCursorObjCProtocolRef(C).first;
5523 if (const ObjCProtocolDecl *Def = Prot->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005524 return MakeCXCursor(Def, tu);
5525
5526 return MakeCXCursor(Prot, tu);
5527 }
5528
5529 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005530 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
5531 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005532 return MakeCXCursor(Def, tu);
5533
5534 return MakeCXCursor(Class, tu);
5535 }
5536
5537 case CXCursor_TypeRef:
5538 return MakeCXCursor(getCursorTypeRef(C).first, tu );
5539
5540 case CXCursor_TemplateRef:
5541 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
5542
5543 case CXCursor_NamespaceRef:
5544 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
5545
5546 case CXCursor_MemberRef:
5547 return MakeCXCursor(getCursorMemberRef(C).first, tu );
5548
5549 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005550 const CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005551 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
5552 tu ));
5553 }
5554
5555 case CXCursor_LabelRef:
5556 // FIXME: We end up faking the "parent" declaration here because we
5557 // don't want to make CXCursor larger.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005558 return MakeCXCursor(getCursorLabelRef(C).first,
5559 cxtu::getASTUnit(tu)->getASTContext()
5560 .getTranslationUnitDecl(),
Guy Benyei11169dd2012-12-18 14:30:41 +00005561 tu);
5562
5563 case CXCursor_OverloadedDeclRef:
5564 return C;
5565
5566 case CXCursor_VariableRef:
5567 return MakeCXCursor(getCursorVariableRef(C).first, tu);
5568
5569 default:
5570 // We would prefer to enumerate all non-reference cursor kinds here.
5571 llvm_unreachable("Unhandled reference cursor kind");
5572 }
5573}
5574
5575CXCursor clang_getCursorDefinition(CXCursor C) {
5576 if (clang_isInvalid(C.kind))
5577 return clang_getNullCursor();
5578
5579 CXTranslationUnit TU = getCursorTU(C);
5580
5581 bool WasReference = false;
5582 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
5583 C = clang_getCursorReferenced(C);
5584 WasReference = true;
5585 }
5586
5587 if (C.kind == CXCursor_MacroExpansion)
5588 return clang_getCursorReferenced(C);
5589
5590 if (!clang_isDeclaration(C.kind))
5591 return clang_getNullCursor();
5592
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005593 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005594 if (!D)
5595 return clang_getNullCursor();
5596
5597 switch (D->getKind()) {
5598 // Declaration kinds that don't really separate the notions of
5599 // declaration and definition.
5600 case Decl::Namespace:
5601 case Decl::Typedef:
5602 case Decl::TypeAlias:
5603 case Decl::TypeAliasTemplate:
5604 case Decl::TemplateTypeParm:
5605 case Decl::EnumConstant:
5606 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +00005607 case Decl::MSProperty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005608 case Decl::IndirectField:
5609 case Decl::ObjCIvar:
5610 case Decl::ObjCAtDefsField:
5611 case Decl::ImplicitParam:
5612 case Decl::ParmVar:
5613 case Decl::NonTypeTemplateParm:
5614 case Decl::TemplateTemplateParm:
5615 case Decl::ObjCCategoryImpl:
5616 case Decl::ObjCImplementation:
5617 case Decl::AccessSpec:
5618 case Decl::LinkageSpec:
5619 case Decl::ObjCPropertyImpl:
5620 case Decl::FileScopeAsm:
5621 case Decl::StaticAssert:
5622 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +00005623 case Decl::Captured:
Alexey Bataev4244be22016-02-11 05:35:55 +00005624 case Decl::OMPCapturedExpr:
Guy Benyei11169dd2012-12-18 14:30:41 +00005625 case Decl::Label: // FIXME: Is this right??
5626 case Decl::ClassScopeFunctionSpecialization:
5627 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +00005628 case Decl::OMPThreadPrivate:
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00005629 case Decl::OMPDeclareReduction:
Douglas Gregor85f3f952015-07-07 03:57:15 +00005630 case Decl::ObjCTypeParam:
David Majnemerd9b1a4f2015-11-04 03:40:30 +00005631 case Decl::BuiltinTemplate:
Nico Weber66220292016-03-02 17:28:48 +00005632 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +00005633 case Decl::PragmaDetectMismatch:
Guy Benyei11169dd2012-12-18 14:30:41 +00005634 return C;
5635
5636 // Declaration kinds that don't make any sense here, but are
5637 // nonetheless harmless.
David Blaikief005d3c2013-02-22 17:44:58 +00005638 case Decl::Empty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005639 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +00005640 case Decl::ExternCContext:
Guy Benyei11169dd2012-12-18 14:30:41 +00005641 break;
5642
5643 // Declaration kinds for which the definition is not resolvable.
5644 case Decl::UnresolvedUsingTypename:
5645 case Decl::UnresolvedUsingValue:
5646 break;
5647
5648 case Decl::UsingDirective:
5649 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
5650 TU);
5651
5652 case Decl::NamespaceAlias:
5653 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
5654
5655 case Decl::Enum:
5656 case Decl::Record:
5657 case Decl::CXXRecord:
5658 case Decl::ClassTemplateSpecialization:
5659 case Decl::ClassTemplatePartialSpecialization:
5660 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
5661 return MakeCXCursor(Def, TU);
5662 return clang_getNullCursor();
5663
5664 case Decl::Function:
5665 case Decl::CXXMethod:
5666 case Decl::CXXConstructor:
5667 case Decl::CXXDestructor:
5668 case Decl::CXXConversion: {
Craig Topper69186e72014-06-08 08:38:04 +00005669 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005670 if (cast<FunctionDecl>(D)->getBody(Def))
Dmitri Gribenko9c256e32013-01-14 00:46:27 +00005671 return MakeCXCursor(Def, TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005672 return clang_getNullCursor();
5673 }
5674
Larisse Voufo39a1e502013-08-06 01:03:05 +00005675 case Decl::Var:
5676 case Decl::VarTemplateSpecialization:
5677 case Decl::VarTemplatePartialSpecialization: {
Guy Benyei11169dd2012-12-18 14:30:41 +00005678 // Ask the variable if it has a definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005679 if (const VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005680 return MakeCXCursor(Def, TU);
5681 return clang_getNullCursor();
5682 }
5683
5684 case Decl::FunctionTemplate: {
Craig Topper69186e72014-06-08 08:38:04 +00005685 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005686 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
5687 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
5688 return clang_getNullCursor();
5689 }
5690
5691 case Decl::ClassTemplate: {
5692 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
5693 ->getDefinition())
5694 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
5695 TU);
5696 return clang_getNullCursor();
5697 }
5698
Larisse Voufo39a1e502013-08-06 01:03:05 +00005699 case Decl::VarTemplate: {
5700 if (VarDecl *Def =
5701 cast<VarTemplateDecl>(D)->getTemplatedDecl()->getDefinition())
5702 return MakeCXCursor(cast<VarDecl>(Def)->getDescribedVarTemplate(), TU);
5703 return clang_getNullCursor();
5704 }
5705
Guy Benyei11169dd2012-12-18 14:30:41 +00005706 case Decl::Using:
5707 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
5708 D->getLocation(), TU);
5709
5710 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +00005711 case Decl::ConstructorUsingShadow:
Guy Benyei11169dd2012-12-18 14:30:41 +00005712 return clang_getCursorDefinition(
5713 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
5714 TU));
5715
5716 case Decl::ObjCMethod: {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005717 const ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005718 if (Method->isThisDeclarationADefinition())
5719 return C;
5720
5721 // Dig out the method definition in the associated
5722 // @implementation, if we have it.
5723 // FIXME: The ASTs should make finding the definition easier.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005724 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00005725 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
5726 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
5727 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
5728 Method->isInstanceMethod()))
5729 if (Def->isThisDeclarationADefinition())
5730 return MakeCXCursor(Def, TU);
5731
5732 return clang_getNullCursor();
5733 }
5734
5735 case Decl::ObjCCategory:
5736 if (ObjCCategoryImplDecl *Impl
5737 = cast<ObjCCategoryDecl>(D)->getImplementation())
5738 return MakeCXCursor(Impl, TU);
5739 return clang_getNullCursor();
5740
5741 case Decl::ObjCProtocol:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005742 if (const ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005743 return MakeCXCursor(Def, TU);
5744 return clang_getNullCursor();
5745
5746 case Decl::ObjCInterface: {
5747 // There are two notions of a "definition" for an Objective-C
5748 // class: the interface and its implementation. When we resolved a
5749 // reference to an Objective-C class, produce the @interface as
5750 // the definition; when we were provided with the interface,
5751 // produce the @implementation as the definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005752 const ObjCInterfaceDecl *IFace = cast<ObjCInterfaceDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005753 if (WasReference) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005754 if (const ObjCInterfaceDecl *Def = IFace->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005755 return MakeCXCursor(Def, TU);
5756 } else if (ObjCImplementationDecl *Impl = IFace->getImplementation())
5757 return MakeCXCursor(Impl, TU);
5758 return clang_getNullCursor();
5759 }
5760
5761 case Decl::ObjCProperty:
5762 // FIXME: We don't really know where to find the
5763 // ObjCPropertyImplDecls that implement this property.
5764 return clang_getNullCursor();
5765
5766 case Decl::ObjCCompatibleAlias:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005767 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00005768 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005769 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005770 return MakeCXCursor(Def, TU);
5771
5772 return clang_getNullCursor();
5773
5774 case Decl::Friend:
5775 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
5776 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5777 return clang_getNullCursor();
5778
5779 case Decl::FriendTemplate:
5780 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
5781 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5782 return clang_getNullCursor();
5783 }
5784
5785 return clang_getNullCursor();
5786}
5787
5788unsigned clang_isCursorDefinition(CXCursor C) {
5789 if (!clang_isDeclaration(C.kind))
5790 return 0;
5791
5792 return clang_getCursorDefinition(C) == C;
5793}
5794
5795CXCursor clang_getCanonicalCursor(CXCursor C) {
5796 if (!clang_isDeclaration(C.kind))
5797 return C;
5798
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005799 if (const Decl *D = getCursorDecl(C)) {
5800 if (const ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005801 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
5802 return MakeCXCursor(CatD, getCursorTU(C));
5803
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005804 if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
5805 if (const ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
Guy Benyei11169dd2012-12-18 14:30:41 +00005806 return MakeCXCursor(IFD, getCursorTU(C));
5807
5808 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
5809 }
5810
5811 return C;
5812}
5813
5814int clang_Cursor_getObjCSelectorIndex(CXCursor cursor) {
5815 return cxcursor::getSelectorIdentifierIndexAndLoc(cursor).first;
5816}
5817
5818unsigned clang_getNumOverloadedDecls(CXCursor C) {
5819 if (C.kind != CXCursor_OverloadedDeclRef)
5820 return 0;
5821
5822 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005823 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00005824 return E->getNumDecls();
5825
5826 if (OverloadedTemplateStorage *S
5827 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5828 return S->size();
5829
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005830 const Decl *D = Storage.get<const Decl *>();
5831 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005832 return Using->shadow_size();
5833
5834 return 0;
5835}
5836
5837CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
5838 if (cursor.kind != CXCursor_OverloadedDeclRef)
5839 return clang_getNullCursor();
5840
5841 if (index >= clang_getNumOverloadedDecls(cursor))
5842 return clang_getNullCursor();
5843
5844 CXTranslationUnit TU = getCursorTU(cursor);
5845 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005846 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00005847 return MakeCXCursor(E->decls_begin()[index], TU);
5848
5849 if (OverloadedTemplateStorage *S
5850 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5851 return MakeCXCursor(S->begin()[index], TU);
5852
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005853 const Decl *D = Storage.get<const Decl *>();
5854 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005855 // FIXME: This is, unfortunately, linear time.
5856 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
5857 std::advance(Pos, index);
5858 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
5859 }
5860
5861 return clang_getNullCursor();
5862}
5863
5864void clang_getDefinitionSpellingAndExtent(CXCursor C,
5865 const char **startBuf,
5866 const char **endBuf,
5867 unsigned *startLine,
5868 unsigned *startColumn,
5869 unsigned *endLine,
5870 unsigned *endColumn) {
5871 assert(getCursorDecl(C) && "CXCursor has null decl");
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005872 const FunctionDecl *FD = dyn_cast<FunctionDecl>(getCursorDecl(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00005873 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
5874
5875 SourceManager &SM = FD->getASTContext().getSourceManager();
5876 *startBuf = SM.getCharacterData(Body->getLBracLoc());
5877 *endBuf = SM.getCharacterData(Body->getRBracLoc());
5878 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
5879 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
5880 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
5881 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
5882}
5883
5884
5885CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
5886 unsigned PieceIndex) {
5887 RefNamePieces Pieces;
5888
5889 switch (C.kind) {
5890 case CXCursor_MemberRefExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005891 if (const MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00005892 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
5893 E->getQualifierLoc().getSourceRange());
5894 break;
5895
5896 case CXCursor_DeclRefExpr:
James Y Knight04ec5bf2015-12-24 02:59:37 +00005897 if (const DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C))) {
5898 SourceRange TemplateArgLoc(E->getLAngleLoc(), E->getRAngleLoc());
5899 Pieces =
5900 buildPieces(NameFlags, false, E->getNameInfo(),
5901 E->getQualifierLoc().getSourceRange(), &TemplateArgLoc);
5902 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005903 break;
5904
5905 case CXCursor_CallExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005906 if (const CXXOperatorCallExpr *OCE =
Guy Benyei11169dd2012-12-18 14:30:41 +00005907 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005908 const Expr *Callee = OCE->getCallee();
5909 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00005910 Callee = ICE->getSubExpr();
5911
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005912 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00005913 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
5914 DRE->getQualifierLoc().getSourceRange());
5915 }
5916 break;
5917
5918 default:
5919 break;
5920 }
5921
5922 if (Pieces.empty()) {
5923 if (PieceIndex == 0)
5924 return clang_getCursorExtent(C);
5925 } else if (PieceIndex < Pieces.size()) {
5926 SourceRange R = Pieces[PieceIndex];
5927 if (R.isValid())
5928 return cxloc::translateSourceRange(getCursorContext(C), R);
5929 }
5930
5931 return clang_getNullRange();
5932}
5933
5934void clang_enableStackTraces(void) {
Richard Smithdfed58a2016-06-09 00:53:41 +00005935 // FIXME: Provide an argv0 here so we can find llvm-symbolizer.
5936 llvm::sys::PrintStackTraceOnErrorSignal(StringRef());
Guy Benyei11169dd2012-12-18 14:30:41 +00005937}
5938
5939void clang_executeOnThread(void (*fn)(void*), void *user_data,
5940 unsigned stack_size) {
5941 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
5942}
5943
5944} // end: extern "C"
5945
5946//===----------------------------------------------------------------------===//
5947// Token-based Operations.
5948//===----------------------------------------------------------------------===//
5949
5950/* CXToken layout:
5951 * int_data[0]: a CXTokenKind
5952 * int_data[1]: starting token location
5953 * int_data[2]: token length
5954 * int_data[3]: reserved
5955 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
5956 * otherwise unused.
5957 */
5958extern "C" {
5959
5960CXTokenKind clang_getTokenKind(CXToken CXTok) {
5961 return static_cast<CXTokenKind>(CXTok.int_data[0]);
5962}
5963
5964CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
5965 switch (clang_getTokenKind(CXTok)) {
5966 case CXToken_Identifier:
5967 case CXToken_Keyword:
5968 // We know we have an IdentifierInfo*, so use that.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005969 return cxstring::createRef(static_cast<IdentifierInfo *>(CXTok.ptr_data)
Guy Benyei11169dd2012-12-18 14:30:41 +00005970 ->getNameStart());
5971
5972 case CXToken_Literal: {
5973 // We have stashed the starting pointer in the ptr_data field. Use it.
5974 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00005975 return cxstring::createDup(StringRef(Text, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00005976 }
5977
5978 case CXToken_Punctuation:
5979 case CXToken_Comment:
5980 break;
5981 }
5982
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005983 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005984 LOG_BAD_TU(TU);
5985 return cxstring::createEmpty();
5986 }
5987
Guy Benyei11169dd2012-12-18 14:30:41 +00005988 // We have to find the starting buffer pointer the hard way, by
5989 // deconstructing the source location.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005990 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005991 if (!CXXUnit)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00005992 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00005993
5994 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
5995 std::pair<FileID, unsigned> LocInfo
5996 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
5997 bool Invalid = false;
5998 StringRef Buffer
5999 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
6000 if (Invalid)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00006001 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006002
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00006003 return cxstring::createDup(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006004}
6005
6006CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006007 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006008 LOG_BAD_TU(TU);
6009 return clang_getNullLocation();
6010 }
6011
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006012 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006013 if (!CXXUnit)
6014 return clang_getNullLocation();
6015
6016 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
6017 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6018}
6019
6020CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006021 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006022 LOG_BAD_TU(TU);
6023 return clang_getNullRange();
6024 }
6025
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006026 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006027 if (!CXXUnit)
6028 return clang_getNullRange();
6029
6030 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
6031 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6032}
6033
6034static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
6035 SmallVectorImpl<CXToken> &CXTokens) {
6036 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6037 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006038 = SourceMgr.getDecomposedSpellingLoc(Range.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006039 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006040 = SourceMgr.getDecomposedSpellingLoc(Range.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006041
6042 // Cannot tokenize across files.
6043 if (BeginLocInfo.first != EndLocInfo.first)
6044 return;
6045
6046 // Create a lexer
6047 bool Invalid = false;
6048 StringRef Buffer
6049 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6050 if (Invalid)
6051 return;
6052
6053 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6054 CXXUnit->getASTContext().getLangOpts(),
6055 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
6056 Lex.SetCommentRetentionState(true);
6057
6058 // Lex tokens until we hit the end of the range.
6059 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
6060 Token Tok;
6061 bool previousWasAt = false;
6062 do {
6063 // Lex the next token
6064 Lex.LexFromRawLexer(Tok);
6065 if (Tok.is(tok::eof))
6066 break;
6067
6068 // Initialize the CXToken.
6069 CXToken CXTok;
6070
6071 // - Common fields
6072 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
6073 CXTok.int_data[2] = Tok.getLength();
6074 CXTok.int_data[3] = 0;
6075
6076 // - Kind-specific fields
6077 if (Tok.isLiteral()) {
6078 CXTok.int_data[0] = CXToken_Literal;
Dmitri Gribenkof9304482013-01-23 15:56:07 +00006079 CXTok.ptr_data = const_cast<char *>(Tok.getLiteralData());
Guy Benyei11169dd2012-12-18 14:30:41 +00006080 } else if (Tok.is(tok::raw_identifier)) {
6081 // Lookup the identifier to determine whether we have a keyword.
6082 IdentifierInfo *II
6083 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
6084
6085 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
6086 CXTok.int_data[0] = CXToken_Keyword;
6087 }
6088 else {
6089 CXTok.int_data[0] = Tok.is(tok::identifier)
6090 ? CXToken_Identifier
6091 : CXToken_Keyword;
6092 }
6093 CXTok.ptr_data = II;
6094 } else if (Tok.is(tok::comment)) {
6095 CXTok.int_data[0] = CXToken_Comment;
Craig Topper69186e72014-06-08 08:38:04 +00006096 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006097 } else {
6098 CXTok.int_data[0] = CXToken_Punctuation;
Craig Topper69186e72014-06-08 08:38:04 +00006099 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006100 }
6101 CXTokens.push_back(CXTok);
6102 previousWasAt = Tok.is(tok::at);
6103 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
6104}
6105
6106void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
6107 CXToken **Tokens, unsigned *NumTokens) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006108 LOG_FUNC_SECTION {
6109 *Log << TU << ' ' << Range;
6110 }
6111
Guy Benyei11169dd2012-12-18 14:30:41 +00006112 if (Tokens)
Craig Topper69186e72014-06-08 08:38:04 +00006113 *Tokens = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006114 if (NumTokens)
6115 *NumTokens = 0;
6116
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006117 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006118 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006119 return;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006120 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006121
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006122 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006123 if (!CXXUnit || !Tokens || !NumTokens)
6124 return;
6125
6126 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6127
6128 SourceRange R = cxloc::translateCXSourceRange(Range);
6129 if (R.isInvalid())
6130 return;
6131
6132 SmallVector<CXToken, 32> CXTokens;
6133 getTokens(CXXUnit, R, CXTokens);
6134
6135 if (CXTokens.empty())
6136 return;
6137
6138 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
6139 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
6140 *NumTokens = CXTokens.size();
6141}
6142
6143void clang_disposeTokens(CXTranslationUnit TU,
6144 CXToken *Tokens, unsigned NumTokens) {
6145 free(Tokens);
6146}
6147
6148} // end: extern "C"
6149
6150//===----------------------------------------------------------------------===//
6151// Token annotation APIs.
6152//===----------------------------------------------------------------------===//
6153
Guy Benyei11169dd2012-12-18 14:30:41 +00006154static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6155 CXCursor parent,
6156 CXClientData client_data);
6157static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6158 CXClientData client_data);
6159
6160namespace {
6161class AnnotateTokensWorker {
Guy Benyei11169dd2012-12-18 14:30:41 +00006162 CXToken *Tokens;
6163 CXCursor *Cursors;
6164 unsigned NumTokens;
6165 unsigned TokIdx;
6166 unsigned PreprocessingTokIdx;
6167 CursorVisitor AnnotateVis;
6168 SourceManager &SrcMgr;
6169 bool HasContextSensitiveKeywords;
6170
6171 struct PostChildrenInfo {
6172 CXCursor Cursor;
6173 SourceRange CursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006174 unsigned BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006175 unsigned BeforeChildrenTokenIdx;
6176 };
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006177 SmallVector<PostChildrenInfo, 8> PostChildrenInfos;
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006178
6179 CXToken &getTok(unsigned Idx) {
6180 assert(Idx < NumTokens);
6181 return Tokens[Idx];
6182 }
6183 const CXToken &getTok(unsigned Idx) const {
6184 assert(Idx < NumTokens);
6185 return Tokens[Idx];
6186 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006187 bool MoreTokens() const { return TokIdx < NumTokens; }
6188 unsigned NextToken() const { return TokIdx; }
6189 void AdvanceToken() { ++TokIdx; }
6190 SourceLocation GetTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006191 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006192 }
6193 bool isFunctionMacroToken(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006194 return getTok(tokI).int_data[3] != 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006195 }
6196 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006197 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[3]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006198 }
6199
6200 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006201 bool annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
Guy Benyei11169dd2012-12-18 14:30:41 +00006202 SourceRange);
6203
6204public:
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006205 AnnotateTokensWorker(CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006206 CXTranslationUnit TU, SourceRange RegionOfInterest)
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006207 : Tokens(tokens), Cursors(cursors),
Guy Benyei11169dd2012-12-18 14:30:41 +00006208 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006209 AnnotateVis(TU,
Guy Benyei11169dd2012-12-18 14:30:41 +00006210 AnnotateTokensVisitor, this,
6211 /*VisitPreprocessorLast=*/true,
6212 /*VisitIncludedEntities=*/false,
6213 RegionOfInterest,
6214 /*VisitDeclsOnly=*/false,
6215 AnnotateTokensPostChildrenVisitor),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006216 SrcMgr(cxtu::getASTUnit(TU)->getSourceManager()),
Guy Benyei11169dd2012-12-18 14:30:41 +00006217 HasContextSensitiveKeywords(false) { }
6218
6219 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
6220 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
6221 bool postVisitChildren(CXCursor cursor);
6222 void AnnotateTokens();
6223
6224 /// \brief Determine whether the annotator saw any cursors that have
6225 /// context-sensitive keywords.
6226 bool hasContextSensitiveKeywords() const {
6227 return HasContextSensitiveKeywords;
6228 }
6229
6230 ~AnnotateTokensWorker() {
6231 assert(PostChildrenInfos.empty());
6232 }
6233};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00006234}
Guy Benyei11169dd2012-12-18 14:30:41 +00006235
6236void AnnotateTokensWorker::AnnotateTokens() {
6237 // Walk the AST within the region of interest, annotating tokens
6238 // along the way.
6239 AnnotateVis.visitFileRegion();
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006240}
Guy Benyei11169dd2012-12-18 14:30:41 +00006241
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006242static inline void updateCursorAnnotation(CXCursor &Cursor,
6243 const CXCursor &updateC) {
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006244 if (clang_isInvalid(updateC.kind) || !clang_isInvalid(Cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006245 return;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006246 Cursor = updateC;
Guy Benyei11169dd2012-12-18 14:30:41 +00006247}
6248
6249/// \brief It annotates and advances tokens with a cursor until the comparison
6250//// between the cursor location and the source range is the same as
6251/// \arg compResult.
6252///
6253/// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
6254/// Pass RangeOverlap to annotate tokens inside a range.
6255void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
6256 RangeComparisonResult compResult,
6257 SourceRange range) {
6258 while (MoreTokens()) {
6259 const unsigned I = NextToken();
6260 if (isFunctionMacroToken(I))
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006261 if (!annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range))
6262 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00006263
6264 SourceLocation TokLoc = GetTokenLoc(I);
6265 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006266 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006267 AdvanceToken();
6268 continue;
6269 }
6270 break;
6271 }
6272}
6273
6274/// \brief Special annotation handling for macro argument tokens.
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006275/// \returns true if it advanced beyond all macro tokens, false otherwise.
6276bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
Guy Benyei11169dd2012-12-18 14:30:41 +00006277 CXCursor updateC,
6278 RangeComparisonResult compResult,
6279 SourceRange range) {
6280 assert(MoreTokens());
6281 assert(isFunctionMacroToken(NextToken()) &&
6282 "Should be called only for macro arg tokens");
6283
6284 // This works differently than annotateAndAdvanceTokens; because expanded
6285 // macro arguments can have arbitrary translation-unit source order, we do not
6286 // advance the token index one by one until a token fails the range test.
6287 // We only advance once past all of the macro arg tokens if all of them
6288 // pass the range test. If one of them fails we keep the token index pointing
6289 // at the start of the macro arg tokens so that the failing token will be
6290 // annotated by a subsequent annotation try.
6291
6292 bool atLeastOneCompFail = false;
6293
6294 unsigned I = NextToken();
6295 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
6296 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
6297 if (TokLoc.isFileID())
6298 continue; // not macro arg token, it's parens or comma.
6299 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6300 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
6301 Cursors[I] = updateC;
6302 } else
6303 atLeastOneCompFail = true;
6304 }
6305
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006306 if (atLeastOneCompFail)
6307 return false;
6308
6309 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
6310 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00006311}
6312
6313enum CXChildVisitResult
6314AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006315 SourceRange cursorRange = getRawCursorExtent(cursor);
6316 if (cursorRange.isInvalid())
6317 return CXChildVisit_Recurse;
6318
6319 if (!HasContextSensitiveKeywords) {
6320 // Objective-C properties can have context-sensitive keywords.
6321 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006322 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006323 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
6324 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
6325 }
6326 // Objective-C methods can have context-sensitive keywords.
6327 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
6328 cursor.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006329 if (const ObjCMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006330 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
6331 if (Method->getObjCDeclQualifier())
6332 HasContextSensitiveKeywords = true;
6333 else {
David Majnemer59f77922016-06-24 04:05:48 +00006334 for (const auto *P : Method->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00006335 if (P->getObjCDeclQualifier()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006336 HasContextSensitiveKeywords = true;
6337 break;
6338 }
6339 }
6340 }
6341 }
6342 }
6343 // C++ methods can have context-sensitive keywords.
6344 else if (cursor.kind == CXCursor_CXXMethod) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006345 if (const CXXMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006346 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
6347 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
6348 HasContextSensitiveKeywords = true;
6349 }
6350 }
6351 // C++ classes can have context-sensitive keywords.
6352 else if (cursor.kind == CXCursor_StructDecl ||
6353 cursor.kind == CXCursor_ClassDecl ||
6354 cursor.kind == CXCursor_ClassTemplate ||
6355 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006356 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00006357 if (D->hasAttr<FinalAttr>())
6358 HasContextSensitiveKeywords = true;
6359 }
6360 }
Argyrios Kyrtzidis990b3862013-06-04 18:24:30 +00006361
6362 // Don't override a property annotation with its getter/setter method.
6363 if (cursor.kind == CXCursor_ObjCInstanceMethodDecl &&
6364 parent.kind == CXCursor_ObjCPropertyDecl)
6365 return CXChildVisit_Continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00006366
6367 if (clang_isPreprocessing(cursor.kind)) {
6368 // Items in the preprocessing record are kept separate from items in
6369 // declarations, so we keep a separate token index.
6370 unsigned SavedTokIdx = TokIdx;
6371 TokIdx = PreprocessingTokIdx;
6372
6373 // Skip tokens up until we catch up to the beginning of the preprocessing
6374 // entry.
6375 while (MoreTokens()) {
6376 const unsigned I = NextToken();
6377 SourceLocation TokLoc = GetTokenLoc(I);
6378 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6379 case RangeBefore:
6380 AdvanceToken();
6381 continue;
6382 case RangeAfter:
6383 case RangeOverlap:
6384 break;
6385 }
6386 break;
6387 }
6388
6389 // Look at all of the tokens within this range.
6390 while (MoreTokens()) {
6391 const unsigned I = NextToken();
6392 SourceLocation TokLoc = GetTokenLoc(I);
6393 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6394 case RangeBefore:
6395 llvm_unreachable("Infeasible");
6396 case RangeAfter:
6397 break;
6398 case RangeOverlap:
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006399 // For macro expansions, just note where the beginning of the macro
6400 // expansion occurs.
6401 if (cursor.kind == CXCursor_MacroExpansion) {
6402 if (TokLoc == cursorRange.getBegin())
6403 Cursors[I] = cursor;
6404 AdvanceToken();
6405 break;
6406 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006407 // We may have already annotated macro names inside macro definitions.
6408 if (Cursors[I].kind != CXCursor_MacroExpansion)
6409 Cursors[I] = cursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00006410 AdvanceToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006411 continue;
6412 }
6413 break;
6414 }
6415
6416 // Save the preprocessing token index; restore the non-preprocessing
6417 // token index.
6418 PreprocessingTokIdx = TokIdx;
6419 TokIdx = SavedTokIdx;
6420 return CXChildVisit_Recurse;
6421 }
6422
6423 if (cursorRange.isInvalid())
6424 return CXChildVisit_Continue;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006425
6426 unsigned BeforeReachingCursorIdx = NextToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006427 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006428 const enum CXCursorKind K = clang_getCursorKind(parent);
6429 const CXCursor updateC =
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006430 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
6431 // Attributes are annotated out-of-order, skip tokens until we reach it.
6432 clang_isAttribute(cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006433 ? clang_getNullCursor() : parent;
6434
6435 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
6436
6437 // Avoid having the cursor of an expression "overwrite" the annotation of the
6438 // variable declaration that it belongs to.
6439 // This can happen for C++ constructor expressions whose range generally
6440 // include the variable declaration, e.g.:
6441 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006442 if (clang_isExpression(cursorK) && MoreTokens()) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006443 const Expr *E = getCursorExpr(cursor);
Dmitri Gribenkoa1691182013-01-26 18:12:08 +00006444 if (const Decl *D = getCursorParentDecl(cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006445 const unsigned I = NextToken();
6446 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
6447 E->getLocStart() == D->getLocation() &&
6448 E->getLocStart() == GetTokenLoc(I)) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006449 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006450 AdvanceToken();
6451 }
6452 }
6453 }
6454
6455 // Before recursing into the children keep some state that we are going
6456 // to use in the AnnotateTokensWorker::postVisitChildren callback to do some
6457 // extra work after the child nodes are visited.
6458 // Note that we don't call VisitChildren here to avoid traversing statements
6459 // code-recursively which can blow the stack.
6460
6461 PostChildrenInfo Info;
6462 Info.Cursor = cursor;
6463 Info.CursorRange = cursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006464 Info.BeforeReachingCursorIdx = BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006465 Info.BeforeChildrenTokenIdx = NextToken();
6466 PostChildrenInfos.push_back(Info);
6467
6468 return CXChildVisit_Recurse;
6469}
6470
6471bool AnnotateTokensWorker::postVisitChildren(CXCursor cursor) {
6472 if (PostChildrenInfos.empty())
6473 return false;
6474 const PostChildrenInfo &Info = PostChildrenInfos.back();
6475 if (!clang_equalCursors(Info.Cursor, cursor))
6476 return false;
6477
6478 const unsigned BeforeChildren = Info.BeforeChildrenTokenIdx;
6479 const unsigned AfterChildren = NextToken();
6480 SourceRange cursorRange = Info.CursorRange;
6481
6482 // Scan the tokens that are at the end of the cursor, but are not captured
6483 // but the child cursors.
6484 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
6485
6486 // Scan the tokens that are at the beginning of the cursor, but are not
6487 // capture by the child cursors.
6488 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
6489 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
6490 break;
6491
6492 Cursors[I] = cursor;
6493 }
6494
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006495 // Attributes are annotated out-of-order, rewind TokIdx to when we first
6496 // encountered the attribute cursor.
6497 if (clang_isAttribute(cursor.kind))
6498 TokIdx = Info.BeforeReachingCursorIdx;
6499
Guy Benyei11169dd2012-12-18 14:30:41 +00006500 PostChildrenInfos.pop_back();
6501 return false;
6502}
6503
6504static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6505 CXCursor parent,
6506 CXClientData client_data) {
6507 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
6508}
6509
6510static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6511 CXClientData client_data) {
6512 return static_cast<AnnotateTokensWorker*>(client_data)->
6513 postVisitChildren(cursor);
6514}
6515
6516namespace {
6517
6518/// \brief Uses the macro expansions in the preprocessing record to find
6519/// and mark tokens that are macro arguments. This info is used by the
6520/// AnnotateTokensWorker.
6521class MarkMacroArgTokensVisitor {
6522 SourceManager &SM;
6523 CXToken *Tokens;
6524 unsigned NumTokens;
6525 unsigned CurIdx;
6526
6527public:
6528 MarkMacroArgTokensVisitor(SourceManager &SM,
6529 CXToken *tokens, unsigned numTokens)
6530 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
6531
6532 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
6533 if (cursor.kind != CXCursor_MacroExpansion)
6534 return CXChildVisit_Continue;
6535
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00006536 SourceRange macroRange = getCursorMacroExpansion(cursor).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00006537 if (macroRange.getBegin() == macroRange.getEnd())
6538 return CXChildVisit_Continue; // it's not a function macro.
6539
6540 for (; CurIdx < NumTokens; ++CurIdx) {
6541 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
6542 macroRange.getBegin()))
6543 break;
6544 }
6545
6546 if (CurIdx == NumTokens)
6547 return CXChildVisit_Break;
6548
6549 for (; CurIdx < NumTokens; ++CurIdx) {
6550 SourceLocation tokLoc = getTokenLoc(CurIdx);
6551 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
6552 break;
6553
6554 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
6555 }
6556
6557 if (CurIdx == NumTokens)
6558 return CXChildVisit_Break;
6559
6560 return CXChildVisit_Continue;
6561 }
6562
6563private:
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006564 CXToken &getTok(unsigned Idx) {
6565 assert(Idx < NumTokens);
6566 return Tokens[Idx];
6567 }
6568 const CXToken &getTok(unsigned Idx) const {
6569 assert(Idx < NumTokens);
6570 return Tokens[Idx];
6571 }
6572
Guy Benyei11169dd2012-12-18 14:30:41 +00006573 SourceLocation getTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006574 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006575 }
6576
6577 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
6578 // The third field is reserved and currently not used. Use it here
6579 // to mark macro arg expanded tokens with their expanded locations.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006580 getTok(tokI).int_data[3] = loc.getRawEncoding();
Guy Benyei11169dd2012-12-18 14:30:41 +00006581 }
6582};
6583
6584} // end anonymous namespace
6585
6586static CXChildVisitResult
6587MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
6588 CXClientData client_data) {
6589 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
6590 parent);
6591}
6592
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006593/// \brief Used by \c annotatePreprocessorTokens.
6594/// \returns true if lexing was finished, false otherwise.
6595static bool lexNext(Lexer &Lex, Token &Tok,
6596 unsigned &NextIdx, unsigned NumTokens) {
6597 if (NextIdx >= NumTokens)
6598 return true;
6599
6600 ++NextIdx;
6601 Lex.LexFromRawLexer(Tok);
Alexander Kornienko1a9f1842015-12-28 15:24:08 +00006602 return Tok.is(tok::eof);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006603}
6604
Guy Benyei11169dd2012-12-18 14:30:41 +00006605static void annotatePreprocessorTokens(CXTranslationUnit TU,
6606 SourceRange RegionOfInterest,
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006607 CXCursor *Cursors,
6608 CXToken *Tokens,
6609 unsigned NumTokens) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006610 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006611
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006612 Preprocessor &PP = CXXUnit->getPreprocessor();
Guy Benyei11169dd2012-12-18 14:30:41 +00006613 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6614 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006615 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006616 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006617 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006618
6619 if (BeginLocInfo.first != EndLocInfo.first)
6620 return;
6621
6622 StringRef Buffer;
6623 bool Invalid = false;
6624 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6625 if (Buffer.empty() || Invalid)
6626 return;
6627
6628 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6629 CXXUnit->getASTContext().getLangOpts(),
6630 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
6631 Buffer.end());
6632 Lex.SetCommentRetentionState(true);
6633
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006634 unsigned NextIdx = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006635 // Lex tokens in raw mode until we hit the end of the range, to avoid
6636 // entering #includes or expanding macros.
6637 while (true) {
6638 Token Tok;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006639 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6640 break;
6641 unsigned TokIdx = NextIdx-1;
6642 assert(Tok.getLocation() ==
6643 SourceLocation::getFromRawEncoding(Tokens[TokIdx].int_data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006644
6645 reprocess:
6646 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006647 // We have found a preprocessing directive. Annotate the tokens
6648 // appropriately.
Guy Benyei11169dd2012-12-18 14:30:41 +00006649 //
6650 // FIXME: Some simple tests here could identify macro definitions and
6651 // #undefs, to provide specific cursor kinds for those.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006652
6653 SourceLocation BeginLoc = Tok.getLocation();
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006654 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6655 break;
6656
Craig Topper69186e72014-06-08 08:38:04 +00006657 MacroInfo *MI = nullptr;
Alp Toker2d57cea2014-05-17 04:53:25 +00006658 if (Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "define") {
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006659 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6660 break;
6661
6662 if (Tok.is(tok::raw_identifier)) {
Alp Toker2d57cea2014-05-17 04:53:25 +00006663 IdentifierInfo &II =
6664 PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006665 SourceLocation MappedTokLoc =
6666 CXXUnit->mapLocationToPreamble(Tok.getLocation());
6667 MI = getMacroInfo(II, MappedTokLoc, TU);
6668 }
6669 }
6670
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006671 bool finished = false;
Guy Benyei11169dd2012-12-18 14:30:41 +00006672 do {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006673 if (lexNext(Lex, Tok, NextIdx, NumTokens)) {
6674 finished = true;
6675 break;
6676 }
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006677 // If we are in a macro definition, check if the token was ever a
6678 // macro name and annotate it if that's the case.
6679 if (MI) {
6680 SourceLocation SaveLoc = Tok.getLocation();
6681 Tok.setLocation(CXXUnit->mapLocationToPreamble(SaveLoc));
Richard Smith66a81862015-05-04 02:25:31 +00006682 MacroDefinitionRecord *MacroDef =
6683 checkForMacroInMacroDefinition(MI, Tok, TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006684 Tok.setLocation(SaveLoc);
6685 if (MacroDef)
Richard Smith66a81862015-05-04 02:25:31 +00006686 Cursors[NextIdx - 1] =
6687 MakeMacroExpansionCursor(MacroDef, Tok.getLocation(), TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006688 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006689 } while (!Tok.isAtStartOfLine());
6690
6691 unsigned LastIdx = finished ? NextIdx-1 : NextIdx-2;
6692 assert(TokIdx <= LastIdx);
6693 SourceLocation EndLoc =
6694 SourceLocation::getFromRawEncoding(Tokens[LastIdx].int_data[1]);
6695 CXCursor Cursor =
6696 MakePreprocessingDirectiveCursor(SourceRange(BeginLoc, EndLoc), TU);
6697
6698 for (; TokIdx <= LastIdx; ++TokIdx)
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006699 updateCursorAnnotation(Cursors[TokIdx], Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006700
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006701 if (finished)
6702 break;
6703 goto reprocess;
Guy Benyei11169dd2012-12-18 14:30:41 +00006704 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006705 }
6706}
6707
6708// This gets run a separate thread to avoid stack blowout.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006709static void clang_annotateTokensImpl(CXTranslationUnit TU, ASTUnit *CXXUnit,
6710 CXToken *Tokens, unsigned NumTokens,
6711 CXCursor *Cursors) {
Dmitri Gribenko183436e2013-01-26 21:49:50 +00006712 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006713 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
6714 setThreadBackgroundPriority();
6715
6716 // Determine the region of interest, which contains all of the tokens.
6717 SourceRange RegionOfInterest;
6718 RegionOfInterest.setBegin(
6719 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
6720 RegionOfInterest.setEnd(
6721 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
6722 Tokens[NumTokens-1])));
6723
Guy Benyei11169dd2012-12-18 14:30:41 +00006724 // Relex the tokens within the source range to look for preprocessing
6725 // directives.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006726 annotatePreprocessorTokens(TU, RegionOfInterest, Cursors, Tokens, NumTokens);
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006727
6728 // If begin location points inside a macro argument, set it to the expansion
6729 // location so we can have the full context when annotating semantically.
6730 {
6731 SourceManager &SM = CXXUnit->getSourceManager();
6732 SourceLocation Loc =
6733 SM.getMacroArgExpandedLocation(RegionOfInterest.getBegin());
6734 if (Loc.isMacroID())
6735 RegionOfInterest.setBegin(SM.getExpansionLoc(Loc));
6736 }
6737
Guy Benyei11169dd2012-12-18 14:30:41 +00006738 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
6739 // Search and mark tokens that are macro argument expansions.
6740 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
6741 Tokens, NumTokens);
6742 CursorVisitor MacroArgMarker(TU,
6743 MarkMacroArgTokensVisitorDelegate, &Visitor,
6744 /*VisitPreprocessorLast=*/true,
6745 /*VisitIncludedEntities=*/false,
6746 RegionOfInterest);
6747 MacroArgMarker.visitPreprocessedEntitiesInRegion();
6748 }
6749
6750 // Annotate all of the source locations in the region of interest that map to
6751 // a specific cursor.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006752 AnnotateTokensWorker W(Tokens, Cursors, NumTokens, TU, RegionOfInterest);
Guy Benyei11169dd2012-12-18 14:30:41 +00006753
6754 // FIXME: We use a ridiculous stack size here because the data-recursion
6755 // algorithm uses a large stack frame than the non-data recursive version,
6756 // and AnnotationTokensWorker currently transforms the data-recursion
6757 // algorithm back into a traditional recursion by explicitly calling
6758 // VisitChildren(). We will need to remove this explicit recursive call.
6759 W.AnnotateTokens();
6760
6761 // If we ran into any entities that involve context-sensitive keywords,
6762 // take another pass through the tokens to mark them as such.
6763 if (W.hasContextSensitiveKeywords()) {
6764 for (unsigned I = 0; I != NumTokens; ++I) {
6765 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
6766 continue;
6767
6768 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
6769 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006770 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006771 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
6772 if (Property->getPropertyAttributesAsWritten() != 0 &&
6773 llvm::StringSwitch<bool>(II->getName())
6774 .Case("readonly", true)
6775 .Case("assign", true)
6776 .Case("unsafe_unretained", true)
6777 .Case("readwrite", true)
6778 .Case("retain", true)
6779 .Case("copy", true)
6780 .Case("nonatomic", true)
6781 .Case("atomic", true)
6782 .Case("getter", true)
6783 .Case("setter", true)
6784 .Case("strong", true)
6785 .Case("weak", true)
Manman Ren04fd4d82016-05-31 23:22:04 +00006786 .Case("class", true)
Guy Benyei11169dd2012-12-18 14:30:41 +00006787 .Default(false))
6788 Tokens[I].int_data[0] = CXToken_Keyword;
6789 }
6790 continue;
6791 }
6792
6793 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
6794 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
6795 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
6796 if (llvm::StringSwitch<bool>(II->getName())
6797 .Case("in", true)
6798 .Case("out", true)
6799 .Case("inout", true)
6800 .Case("oneway", true)
6801 .Case("bycopy", true)
6802 .Case("byref", true)
6803 .Default(false))
6804 Tokens[I].int_data[0] = CXToken_Keyword;
6805 continue;
6806 }
6807
6808 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
6809 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
6810 Tokens[I].int_data[0] = CXToken_Keyword;
6811 continue;
6812 }
6813 }
6814 }
6815}
6816
6817extern "C" {
6818
6819void clang_annotateTokens(CXTranslationUnit TU,
6820 CXToken *Tokens, unsigned NumTokens,
6821 CXCursor *Cursors) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006822 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006823 LOG_BAD_TU(TU);
6824 return;
6825 }
6826 if (NumTokens == 0 || !Tokens || !Cursors) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006827 LOG_FUNC_SECTION { *Log << "<null input>"; }
Guy Benyei11169dd2012-12-18 14:30:41 +00006828 return;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006829 }
6830
6831 LOG_FUNC_SECTION {
6832 *Log << TU << ' ';
6833 CXSourceLocation bloc = clang_getTokenLocation(TU, Tokens[0]);
6834 CXSourceLocation eloc = clang_getTokenLocation(TU, Tokens[NumTokens-1]);
6835 *Log << clang_getRange(bloc, eloc);
6836 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006837
6838 // Any token we don't specifically annotate will have a NULL cursor.
6839 CXCursor C = clang_getNullCursor();
6840 for (unsigned I = 0; I != NumTokens; ++I)
6841 Cursors[I] = C;
6842
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006843 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006844 if (!CXXUnit)
6845 return;
6846
6847 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006848
6849 auto AnnotateTokensImpl = [=]() {
6850 clang_annotateTokensImpl(TU, CXXUnit, Tokens, NumTokens, Cursors);
6851 };
Guy Benyei11169dd2012-12-18 14:30:41 +00006852 llvm::CrashRecoveryContext CRC;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006853 if (!RunSafely(CRC, AnnotateTokensImpl, GetSafetyThreadStackSize() * 2)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006854 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
6855 }
6856}
6857
6858} // end: extern "C"
6859
6860//===----------------------------------------------------------------------===//
6861// Operations for querying linkage of a cursor.
6862//===----------------------------------------------------------------------===//
6863
6864extern "C" {
6865CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
6866 if (!clang_isDeclaration(cursor.kind))
6867 return CXLinkage_Invalid;
6868
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006869 const Decl *D = cxcursor::getCursorDecl(cursor);
6870 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
Rafael Espindola3ae00052013-05-13 00:12:11 +00006871 switch (ND->getLinkageInternal()) {
Rafael Espindola50df3a02013-05-25 17:16:20 +00006872 case NoLinkage:
6873 case VisibleNoLinkage: return CXLinkage_NoLinkage;
Guy Benyei11169dd2012-12-18 14:30:41 +00006874 case InternalLinkage: return CXLinkage_Internal;
6875 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
6876 case ExternalLinkage: return CXLinkage_External;
6877 };
6878
6879 return CXLinkage_Invalid;
6880}
6881} // end: extern "C"
6882
6883//===----------------------------------------------------------------------===//
Ehsan Akhgarib743de72016-05-31 15:55:51 +00006884// Operations for querying visibility of a cursor.
6885//===----------------------------------------------------------------------===//
6886
6887extern "C" {
6888CXVisibilityKind clang_getCursorVisibility(CXCursor cursor) {
6889 if (!clang_isDeclaration(cursor.kind))
6890 return CXVisibility_Invalid;
6891
6892 const Decl *D = cxcursor::getCursorDecl(cursor);
6893 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
6894 switch (ND->getVisibility()) {
6895 case HiddenVisibility: return CXVisibility_Hidden;
6896 case ProtectedVisibility: return CXVisibility_Protected;
6897 case DefaultVisibility: return CXVisibility_Default;
6898 };
6899
6900 return CXVisibility_Invalid;
6901}
6902} // end: extern "C"
6903
6904//===----------------------------------------------------------------------===//
Guy Benyei11169dd2012-12-18 14:30:41 +00006905// Operations for querying language of a cursor.
6906//===----------------------------------------------------------------------===//
6907
6908static CXLanguageKind getDeclLanguage(const Decl *D) {
6909 if (!D)
6910 return CXLanguage_C;
6911
6912 switch (D->getKind()) {
6913 default:
6914 break;
6915 case Decl::ImplicitParam:
6916 case Decl::ObjCAtDefsField:
6917 case Decl::ObjCCategory:
6918 case Decl::ObjCCategoryImpl:
6919 case Decl::ObjCCompatibleAlias:
6920 case Decl::ObjCImplementation:
6921 case Decl::ObjCInterface:
6922 case Decl::ObjCIvar:
6923 case Decl::ObjCMethod:
6924 case Decl::ObjCProperty:
6925 case Decl::ObjCPropertyImpl:
6926 case Decl::ObjCProtocol:
Douglas Gregor85f3f952015-07-07 03:57:15 +00006927 case Decl::ObjCTypeParam:
Guy Benyei11169dd2012-12-18 14:30:41 +00006928 return CXLanguage_ObjC;
6929 case Decl::CXXConstructor:
6930 case Decl::CXXConversion:
6931 case Decl::CXXDestructor:
6932 case Decl::CXXMethod:
6933 case Decl::CXXRecord:
6934 case Decl::ClassTemplate:
6935 case Decl::ClassTemplatePartialSpecialization:
6936 case Decl::ClassTemplateSpecialization:
6937 case Decl::Friend:
6938 case Decl::FriendTemplate:
6939 case Decl::FunctionTemplate:
6940 case Decl::LinkageSpec:
6941 case Decl::Namespace:
6942 case Decl::NamespaceAlias:
6943 case Decl::NonTypeTemplateParm:
6944 case Decl::StaticAssert:
6945 case Decl::TemplateTemplateParm:
6946 case Decl::TemplateTypeParm:
6947 case Decl::UnresolvedUsingTypename:
6948 case Decl::UnresolvedUsingValue:
6949 case Decl::Using:
6950 case Decl::UsingDirective:
6951 case Decl::UsingShadow:
6952 return CXLanguage_CPlusPlus;
6953 }
6954
6955 return CXLanguage_C;
6956}
6957
6958extern "C" {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006959
6960static CXAvailabilityKind getCursorAvailabilityForDecl(const Decl *D) {
6961 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
Manuel Klimek8e3a7ed2015-09-25 17:53:16 +00006962 return CXAvailability_NotAvailable;
Guy Benyei11169dd2012-12-18 14:30:41 +00006963
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006964 switch (D->getAvailability()) {
6965 case AR_Available:
6966 case AR_NotYetIntroduced:
6967 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
Benjamin Kramer656363d2013-10-15 18:53:18 +00006968 return getCursorAvailabilityForDecl(
6969 cast<Decl>(EnumConst->getDeclContext()));
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006970 return CXAvailability_Available;
6971
6972 case AR_Deprecated:
6973 return CXAvailability_Deprecated;
6974
6975 case AR_Unavailable:
6976 return CXAvailability_NotAvailable;
6977 }
Benjamin Kramer656363d2013-10-15 18:53:18 +00006978
6979 llvm_unreachable("Unknown availability kind!");
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006980}
6981
Guy Benyei11169dd2012-12-18 14:30:41 +00006982enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
6983 if (clang_isDeclaration(cursor.kind))
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006984 if (const Decl *D = cxcursor::getCursorDecl(cursor))
6985 return getCursorAvailabilityForDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00006986
6987 return CXAvailability_Available;
6988}
6989
6990static CXVersion convertVersion(VersionTuple In) {
6991 CXVersion Out = { -1, -1, -1 };
6992 if (In.empty())
6993 return Out;
6994
6995 Out.Major = In.getMajor();
6996
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00006997 Optional<unsigned> Minor = In.getMinor();
6998 if (Minor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00006999 Out.Minor = *Minor;
7000 else
7001 return Out;
7002
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00007003 Optional<unsigned> Subminor = In.getSubminor();
7004 if (Subminor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00007005 Out.Subminor = *Subminor;
7006
7007 return Out;
7008}
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007009
7010static int getCursorPlatformAvailabilityForDecl(const Decl *D,
7011 int *always_deprecated,
7012 CXString *deprecated_message,
7013 int *always_unavailable,
7014 CXString *unavailable_message,
7015 CXPlatformAvailability *availability,
7016 int availability_size) {
7017 bool HadAvailAttr = false;
7018 int N = 0;
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007019 for (auto A : D->attrs()) {
7020 if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007021 HadAvailAttr = true;
7022 if (always_deprecated)
7023 *always_deprecated = 1;
Nico Weberaacf0312014-04-24 05:16:45 +00007024 if (deprecated_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007025 clang_disposeString(*deprecated_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007026 *deprecated_message = cxstring::createDup(Deprecated->getMessage());
Nico Weberaacf0312014-04-24 05:16:45 +00007027 }
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007028 continue;
7029 }
7030
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007031 if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007032 HadAvailAttr = true;
7033 if (always_unavailable)
7034 *always_unavailable = 1;
7035 if (unavailable_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007036 clang_disposeString(*unavailable_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007037 *unavailable_message = cxstring::createDup(Unavailable->getMessage());
7038 }
7039 continue;
7040 }
7041
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007042 if (AvailabilityAttr *Avail = dyn_cast<AvailabilityAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007043 HadAvailAttr = true;
7044 if (N < availability_size) {
7045 availability[N].Platform
7046 = cxstring::createDup(Avail->getPlatform()->getName());
7047 availability[N].Introduced = convertVersion(Avail->getIntroduced());
7048 availability[N].Deprecated = convertVersion(Avail->getDeprecated());
7049 availability[N].Obsoleted = convertVersion(Avail->getObsoleted());
7050 availability[N].Unavailable = Avail->getUnavailable();
7051 availability[N].Message = cxstring::createDup(Avail->getMessage());
7052 }
7053 ++N;
7054 }
7055 }
7056
7057 if (!HadAvailAttr)
7058 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
7059 return getCursorPlatformAvailabilityForDecl(
7060 cast<Decl>(EnumConst->getDeclContext()),
7061 always_deprecated,
7062 deprecated_message,
7063 always_unavailable,
7064 unavailable_message,
7065 availability,
7066 availability_size);
Guy Benyei11169dd2012-12-18 14:30:41 +00007067
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007068 return N;
7069}
7070
Guy Benyei11169dd2012-12-18 14:30:41 +00007071int clang_getCursorPlatformAvailability(CXCursor cursor,
7072 int *always_deprecated,
7073 CXString *deprecated_message,
7074 int *always_unavailable,
7075 CXString *unavailable_message,
7076 CXPlatformAvailability *availability,
7077 int availability_size) {
7078 if (always_deprecated)
7079 *always_deprecated = 0;
7080 if (deprecated_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007081 *deprecated_message = cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007082 if (always_unavailable)
7083 *always_unavailable = 0;
7084 if (unavailable_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007085 *unavailable_message = cxstring::createEmpty();
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007086
Guy Benyei11169dd2012-12-18 14:30:41 +00007087 if (!clang_isDeclaration(cursor.kind))
7088 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007089
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007090 const Decl *D = cxcursor::getCursorDecl(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007091 if (!D)
7092 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007093
7094 return getCursorPlatformAvailabilityForDecl(D, always_deprecated,
7095 deprecated_message,
7096 always_unavailable,
7097 unavailable_message,
7098 availability,
7099 availability_size);
Guy Benyei11169dd2012-12-18 14:30:41 +00007100}
7101
7102void clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability) {
7103 clang_disposeString(availability->Platform);
7104 clang_disposeString(availability->Message);
7105}
7106
7107CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
7108 if (clang_isDeclaration(cursor.kind))
7109 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
7110
7111 return CXLanguage_Invalid;
7112}
7113
7114 /// \brief If the given cursor is the "templated" declaration
7115 /// descibing a class or function template, return the class or
7116 /// function template.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007117static const Decl *maybeGetTemplateCursor(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007118 if (!D)
Craig Topper69186e72014-06-08 08:38:04 +00007119 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007120
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007121 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007122 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
7123 return FunTmpl;
7124
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007125 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007126 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
7127 return ClassTmpl;
7128
7129 return D;
7130}
7131
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007132
7133enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor C) {
7134 StorageClass sc = SC_None;
7135 const Decl *D = getCursorDecl(C);
7136 if (D) {
7137 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7138 sc = FD->getStorageClass();
7139 } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7140 sc = VD->getStorageClass();
7141 } else {
7142 return CX_SC_Invalid;
7143 }
7144 } else {
7145 return CX_SC_Invalid;
7146 }
7147 switch (sc) {
7148 case SC_None:
7149 return CX_SC_None;
7150 case SC_Extern:
7151 return CX_SC_Extern;
7152 case SC_Static:
7153 return CX_SC_Static;
7154 case SC_PrivateExtern:
7155 return CX_SC_PrivateExtern;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007156 case SC_Auto:
7157 return CX_SC_Auto;
7158 case SC_Register:
7159 return CX_SC_Register;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007160 }
Kaelyn Takataab61e702014-10-15 18:03:26 +00007161 llvm_unreachable("Unhandled storage class!");
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007162}
7163
Guy Benyei11169dd2012-12-18 14:30:41 +00007164CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
7165 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007166 if (const Decl *D = getCursorDecl(cursor)) {
7167 const DeclContext *DC = D->getDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007168 if (!DC)
7169 return clang_getNullCursor();
7170
7171 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7172 getCursorTU(cursor));
7173 }
7174 }
7175
7176 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007177 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00007178 return MakeCXCursor(D, getCursorTU(cursor));
7179 }
7180
7181 return clang_getNullCursor();
7182}
7183
7184CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
7185 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007186 if (const Decl *D = getCursorDecl(cursor)) {
7187 const DeclContext *DC = D->getLexicalDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007188 if (!DC)
7189 return clang_getNullCursor();
7190
7191 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7192 getCursorTU(cursor));
7193 }
7194 }
7195
7196 // FIXME: Note that we can't easily compute the lexical context of a
7197 // statement or expression, so we return nothing.
7198 return clang_getNullCursor();
7199}
7200
7201CXFile clang_getIncludedFile(CXCursor cursor) {
7202 if (cursor.kind != CXCursor_InclusionDirective)
Craig Topper69186e72014-06-08 08:38:04 +00007203 return nullptr;
7204
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007205 const InclusionDirective *ID = getCursorInclusionDirective(cursor);
Dmitri Gribenkof9304482013-01-23 15:56:07 +00007206 return const_cast<FileEntry *>(ID->getFile());
Guy Benyei11169dd2012-12-18 14:30:41 +00007207}
7208
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007209unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved) {
7210 if (C.kind != CXCursor_ObjCPropertyDecl)
7211 return CXObjCPropertyAttr_noattr;
7212
7213 unsigned Result = CXObjCPropertyAttr_noattr;
7214 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7215 ObjCPropertyDecl::PropertyAttributeKind Attr =
7216 PD->getPropertyAttributesAsWritten();
7217
7218#define SET_CXOBJCPROP_ATTR(A) \
7219 if (Attr & ObjCPropertyDecl::OBJC_PR_##A) \
7220 Result |= CXObjCPropertyAttr_##A
7221 SET_CXOBJCPROP_ATTR(readonly);
7222 SET_CXOBJCPROP_ATTR(getter);
7223 SET_CXOBJCPROP_ATTR(assign);
7224 SET_CXOBJCPROP_ATTR(readwrite);
7225 SET_CXOBJCPROP_ATTR(retain);
7226 SET_CXOBJCPROP_ATTR(copy);
7227 SET_CXOBJCPROP_ATTR(nonatomic);
7228 SET_CXOBJCPROP_ATTR(setter);
7229 SET_CXOBJCPROP_ATTR(atomic);
7230 SET_CXOBJCPROP_ATTR(weak);
7231 SET_CXOBJCPROP_ATTR(strong);
7232 SET_CXOBJCPROP_ATTR(unsafe_unretained);
Manman Ren04fd4d82016-05-31 23:22:04 +00007233 SET_CXOBJCPROP_ATTR(class);
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007234#undef SET_CXOBJCPROP_ATTR
7235
7236 return Result;
7237}
7238
Argyrios Kyrtzidis9d9bc012013-04-18 23:29:12 +00007239unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C) {
7240 if (!clang_isDeclaration(C.kind))
7241 return CXObjCDeclQualifier_None;
7242
7243 Decl::ObjCDeclQualifier QT = Decl::OBJC_TQ_None;
7244 const Decl *D = getCursorDecl(C);
7245 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7246 QT = MD->getObjCDeclQualifier();
7247 else if (const ParmVarDecl *PD = dyn_cast<ParmVarDecl>(D))
7248 QT = PD->getObjCDeclQualifier();
7249 if (QT == Decl::OBJC_TQ_None)
7250 return CXObjCDeclQualifier_None;
7251
7252 unsigned Result = CXObjCDeclQualifier_None;
7253 if (QT & Decl::OBJC_TQ_In) Result |= CXObjCDeclQualifier_In;
7254 if (QT & Decl::OBJC_TQ_Inout) Result |= CXObjCDeclQualifier_Inout;
7255 if (QT & Decl::OBJC_TQ_Out) Result |= CXObjCDeclQualifier_Out;
7256 if (QT & Decl::OBJC_TQ_Bycopy) Result |= CXObjCDeclQualifier_Bycopy;
7257 if (QT & Decl::OBJC_TQ_Byref) Result |= CXObjCDeclQualifier_Byref;
7258 if (QT & Decl::OBJC_TQ_Oneway) Result |= CXObjCDeclQualifier_Oneway;
7259
7260 return Result;
7261}
7262
Argyrios Kyrtzidis7b50fc52013-07-05 20:44:37 +00007263unsigned clang_Cursor_isObjCOptional(CXCursor C) {
7264 if (!clang_isDeclaration(C.kind))
7265 return 0;
7266
7267 const Decl *D = getCursorDecl(C);
7268 if (const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(D))
7269 return PD->getPropertyImplementation() == ObjCPropertyDecl::Optional;
7270 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7271 return MD->getImplementationControl() == ObjCMethodDecl::Optional;
7272
7273 return 0;
7274}
7275
Argyrios Kyrtzidis23814e42013-04-18 23:53:05 +00007276unsigned clang_Cursor_isVariadic(CXCursor C) {
7277 if (!clang_isDeclaration(C.kind))
7278 return 0;
7279
7280 const Decl *D = getCursorDecl(C);
7281 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7282 return FD->isVariadic();
7283 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7284 return MD->isVariadic();
7285
7286 return 0;
7287}
7288
Guy Benyei11169dd2012-12-18 14:30:41 +00007289CXSourceRange clang_Cursor_getCommentRange(CXCursor C) {
7290 if (!clang_isDeclaration(C.kind))
7291 return clang_getNullRange();
7292
7293 const Decl *D = getCursorDecl(C);
7294 ASTContext &Context = getCursorContext(C);
7295 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7296 if (!RC)
7297 return clang_getNullRange();
7298
7299 return cxloc::translateSourceRange(Context, RC->getSourceRange());
7300}
7301
7302CXString clang_Cursor_getRawCommentText(CXCursor C) {
7303 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007304 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007305
7306 const Decl *D = getCursorDecl(C);
7307 ASTContext &Context = getCursorContext(C);
7308 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7309 StringRef RawText = RC ? RC->getRawText(Context.getSourceManager()) :
7310 StringRef();
7311
7312 // Don't duplicate the string because RawText points directly into source
7313 // code.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007314 return cxstring::createRef(RawText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007315}
7316
7317CXString clang_Cursor_getBriefCommentText(CXCursor C) {
7318 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007319 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007320
7321 const Decl *D = getCursorDecl(C);
7322 const ASTContext &Context = getCursorContext(C);
7323 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7324
7325 if (RC) {
7326 StringRef BriefText = RC->getBriefText(Context);
7327
7328 // Don't duplicate the string because RawComment ensures that this memory
7329 // will not go away.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007330 return cxstring::createRef(BriefText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007331 }
7332
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007333 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007334}
7335
Guy Benyei11169dd2012-12-18 14:30:41 +00007336CXModule clang_Cursor_getModule(CXCursor C) {
7337 if (C.kind == CXCursor_ModuleImportDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007338 if (const ImportDecl *ImportD =
7339 dyn_cast_or_null<ImportDecl>(getCursorDecl(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00007340 return ImportD->getImportedModule();
7341 }
7342
Craig Topper69186e72014-06-08 08:38:04 +00007343 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007344}
7345
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007346CXModule clang_getModuleForFile(CXTranslationUnit TU, CXFile File) {
7347 if (isNotUsableTU(TU)) {
7348 LOG_BAD_TU(TU);
7349 return nullptr;
7350 }
7351 if (!File)
7352 return nullptr;
7353 FileEntry *FE = static_cast<FileEntry *>(File);
7354
7355 ASTUnit &Unit = *cxtu::getASTUnit(TU);
7356 HeaderSearch &HS = Unit.getPreprocessor().getHeaderSearchInfo();
7357 ModuleMap::KnownHeader Header = HS.findModuleForHeader(FE);
7358
Richard Smithfeb54b62014-10-23 02:01:19 +00007359 return Header.getModule();
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007360}
7361
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007362CXFile clang_Module_getASTFile(CXModule CXMod) {
7363 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007364 return nullptr;
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007365 Module *Mod = static_cast<Module*>(CXMod);
7366 return const_cast<FileEntry *>(Mod->getASTFile());
7367}
7368
Guy Benyei11169dd2012-12-18 14:30:41 +00007369CXModule clang_Module_getParent(CXModule CXMod) {
7370 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007371 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007372 Module *Mod = static_cast<Module*>(CXMod);
7373 return Mod->Parent;
7374}
7375
7376CXString clang_Module_getName(CXModule CXMod) {
7377 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007378 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007379 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007380 return cxstring::createDup(Mod->Name);
Guy Benyei11169dd2012-12-18 14:30:41 +00007381}
7382
7383CXString clang_Module_getFullName(CXModule CXMod) {
7384 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007385 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007386 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007387 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00007388}
7389
Argyrios Kyrtzidis884337f2014-05-15 04:44:25 +00007390int clang_Module_isSystem(CXModule CXMod) {
7391 if (!CXMod)
7392 return 0;
7393 Module *Mod = static_cast<Module*>(CXMod);
7394 return Mod->IsSystem;
7395}
7396
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007397unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit TU,
7398 CXModule CXMod) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007399 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007400 LOG_BAD_TU(TU);
7401 return 0;
7402 }
7403 if (!CXMod)
Guy Benyei11169dd2012-12-18 14:30:41 +00007404 return 0;
7405 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007406 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
7407 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7408 return TopHeaders.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00007409}
7410
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007411CXFile clang_Module_getTopLevelHeader(CXTranslationUnit TU,
7412 CXModule CXMod, unsigned Index) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007413 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007414 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007415 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007416 }
7417 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007418 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007419 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007420 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
Guy Benyei11169dd2012-12-18 14:30:41 +00007421
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007422 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7423 if (Index < TopHeaders.size())
7424 return const_cast<FileEntry *>(TopHeaders[Index]);
Guy Benyei11169dd2012-12-18 14:30:41 +00007425
Craig Topper69186e72014-06-08 08:38:04 +00007426 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007427}
7428
7429} // end: extern "C"
7430
7431//===----------------------------------------------------------------------===//
7432// C++ AST instrospection.
7433//===----------------------------------------------------------------------===//
7434
7435extern "C" {
Jonathan Coe29565352016-04-27 12:48:25 +00007436
7437unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C) {
7438 if (!clang_isDeclaration(C.kind))
7439 return 0;
7440
7441 const Decl *D = cxcursor::getCursorDecl(C);
7442 const CXXConstructorDecl *Constructor =
7443 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7444 return (Constructor && Constructor->isDefaultConstructor()) ? 1 : 0;
7445}
7446
7447unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C) {
7448 if (!clang_isDeclaration(C.kind))
7449 return 0;
7450
7451 const Decl *D = cxcursor::getCursorDecl(C);
7452 const CXXConstructorDecl *Constructor =
7453 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7454 return (Constructor && Constructor->isCopyConstructor()) ? 1 : 0;
7455}
7456
7457unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C) {
7458 if (!clang_isDeclaration(C.kind))
7459 return 0;
7460
7461 const Decl *D = cxcursor::getCursorDecl(C);
7462 const CXXConstructorDecl *Constructor =
7463 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7464 return (Constructor && Constructor->isMoveConstructor()) ? 1 : 0;
7465}
7466
7467unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C) {
7468 if (!clang_isDeclaration(C.kind))
7469 return 0;
7470
7471 const Decl *D = cxcursor::getCursorDecl(C);
7472 const CXXConstructorDecl *Constructor =
7473 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7474 // Passing 'false' excludes constructors marked 'explicit'.
7475 return (Constructor && Constructor->isConvertingConstructor(false)) ? 1 : 0;
7476}
7477
Saleem Abdulrasool6ea75db2015-10-27 15:50:22 +00007478unsigned clang_CXXField_isMutable(CXCursor C) {
7479 if (!clang_isDeclaration(C.kind))
7480 return 0;
7481
7482 if (const auto D = cxcursor::getCursorDecl(C))
7483 if (const auto FD = dyn_cast_or_null<FieldDecl>(D))
7484 return FD->isMutable() ? 1 : 0;
7485 return 0;
7486}
7487
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007488unsigned clang_CXXMethod_isPureVirtual(CXCursor C) {
7489 if (!clang_isDeclaration(C.kind))
7490 return 0;
7491
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007492 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007493 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007494 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007495 return (Method && Method->isVirtual() && Method->isPure()) ? 1 : 0;
7496}
7497
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007498unsigned clang_CXXMethod_isConst(CXCursor C) {
7499 if (!clang_isDeclaration(C.kind))
7500 return 0;
7501
7502 const Decl *D = cxcursor::getCursorDecl(C);
7503 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007504 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007505 return (Method && (Method->getTypeQualifiers() & Qualifiers::Const)) ? 1 : 0;
7506}
7507
Jonathan Coe29565352016-04-27 12:48:25 +00007508unsigned clang_CXXMethod_isDefaulted(CXCursor C) {
7509 if (!clang_isDeclaration(C.kind))
7510 return 0;
7511
7512 const Decl *D = cxcursor::getCursorDecl(C);
7513 const CXXMethodDecl *Method =
7514 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7515 return (Method && Method->isDefaulted()) ? 1 : 0;
7516}
7517
Guy Benyei11169dd2012-12-18 14:30:41 +00007518unsigned clang_CXXMethod_isStatic(CXCursor C) {
7519 if (!clang_isDeclaration(C.kind))
7520 return 0;
7521
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007522 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007523 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007524 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007525 return (Method && Method->isStatic()) ? 1 : 0;
7526}
7527
7528unsigned clang_CXXMethod_isVirtual(CXCursor C) {
7529 if (!clang_isDeclaration(C.kind))
7530 return 0;
7531
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007532 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007533 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007534 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007535 return (Method && Method->isVirtual()) ? 1 : 0;
7536}
7537} // end: extern "C"
7538
7539//===----------------------------------------------------------------------===//
7540// Attribute introspection.
7541//===----------------------------------------------------------------------===//
7542
7543extern "C" {
7544CXType clang_getIBOutletCollectionType(CXCursor C) {
7545 if (C.kind != CXCursor_IBOutletCollectionAttr)
7546 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
7547
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00007548 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +00007549 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
7550
7551 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
7552}
7553} // end: extern "C"
7554
7555//===----------------------------------------------------------------------===//
7556// Inspecting memory usage.
7557//===----------------------------------------------------------------------===//
7558
7559typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
7560
7561static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
7562 enum CXTUResourceUsageKind k,
7563 unsigned long amount) {
7564 CXTUResourceUsageEntry entry = { k, amount };
7565 entries.push_back(entry);
7566}
7567
7568extern "C" {
7569
7570const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
7571 const char *str = "";
7572 switch (kind) {
7573 case CXTUResourceUsage_AST:
7574 str = "ASTContext: expressions, declarations, and types";
7575 break;
7576 case CXTUResourceUsage_Identifiers:
7577 str = "ASTContext: identifiers";
7578 break;
7579 case CXTUResourceUsage_Selectors:
7580 str = "ASTContext: selectors";
7581 break;
7582 case CXTUResourceUsage_GlobalCompletionResults:
7583 str = "Code completion: cached global results";
7584 break;
7585 case CXTUResourceUsage_SourceManagerContentCache:
7586 str = "SourceManager: content cache allocator";
7587 break;
7588 case CXTUResourceUsage_AST_SideTables:
7589 str = "ASTContext: side tables";
7590 break;
7591 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
7592 str = "SourceManager: malloc'ed memory buffers";
7593 break;
7594 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
7595 str = "SourceManager: mmap'ed memory buffers";
7596 break;
7597 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
7598 str = "ExternalASTSource: malloc'ed memory buffers";
7599 break;
7600 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
7601 str = "ExternalASTSource: mmap'ed memory buffers";
7602 break;
7603 case CXTUResourceUsage_Preprocessor:
7604 str = "Preprocessor: malloc'ed memory";
7605 break;
7606 case CXTUResourceUsage_PreprocessingRecord:
7607 str = "Preprocessor: PreprocessingRecord";
7608 break;
7609 case CXTUResourceUsage_SourceManager_DataStructures:
7610 str = "SourceManager: data structures and tables";
7611 break;
7612 case CXTUResourceUsage_Preprocessor_HeaderSearch:
7613 str = "Preprocessor: header search tables";
7614 break;
7615 }
7616 return str;
7617}
7618
7619CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007620 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007621 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007622 CXTUResourceUsage usage = { (void*) nullptr, 0, nullptr };
Guy Benyei11169dd2012-12-18 14:30:41 +00007623 return usage;
7624 }
7625
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007626 ASTUnit *astUnit = cxtu::getASTUnit(TU);
Ahmed Charlesb8984322014-03-07 20:03:18 +00007627 std::unique_ptr<MemUsageEntries> entries(new MemUsageEntries());
Guy Benyei11169dd2012-12-18 14:30:41 +00007628 ASTContext &astContext = astUnit->getASTContext();
7629
7630 // How much memory is used by AST nodes and types?
7631 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
7632 (unsigned long) astContext.getASTAllocatedMemory());
7633
7634 // How much memory is used by identifiers?
7635 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
7636 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
7637
7638 // How much memory is used for selectors?
7639 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
7640 (unsigned long) astContext.Selectors.getTotalMemory());
7641
7642 // How much memory is used by ASTContext's side tables?
7643 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
7644 (unsigned long) astContext.getSideTableAllocatedMemory());
7645
7646 // How much memory is used for caching global code completion results?
7647 unsigned long completionBytes = 0;
7648 if (GlobalCodeCompletionAllocator *completionAllocator =
Alp Tokerf994cef2014-07-05 03:08:06 +00007649 astUnit->getCachedCompletionAllocator().get()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007650 completionBytes = completionAllocator->getTotalMemory();
7651 }
7652 createCXTUResourceUsageEntry(*entries,
7653 CXTUResourceUsage_GlobalCompletionResults,
7654 completionBytes);
7655
7656 // How much memory is being used by SourceManager's content cache?
7657 createCXTUResourceUsageEntry(*entries,
7658 CXTUResourceUsage_SourceManagerContentCache,
7659 (unsigned long) astContext.getSourceManager().getContentCacheSize());
7660
7661 // How much memory is being used by the MemoryBuffer's in SourceManager?
7662 const SourceManager::MemoryBufferSizes &srcBufs =
7663 astUnit->getSourceManager().getMemoryBufferSizes();
7664
7665 createCXTUResourceUsageEntry(*entries,
7666 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
7667 (unsigned long) srcBufs.malloc_bytes);
7668 createCXTUResourceUsageEntry(*entries,
7669 CXTUResourceUsage_SourceManager_Membuffer_MMap,
7670 (unsigned long) srcBufs.mmap_bytes);
7671 createCXTUResourceUsageEntry(*entries,
7672 CXTUResourceUsage_SourceManager_DataStructures,
7673 (unsigned long) astContext.getSourceManager()
7674 .getDataStructureSizes());
7675
7676 // How much memory is being used by the ExternalASTSource?
7677 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
7678 const ExternalASTSource::MemoryBufferSizes &sizes =
7679 esrc->getMemoryBufferSizes();
7680
7681 createCXTUResourceUsageEntry(*entries,
7682 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
7683 (unsigned long) sizes.malloc_bytes);
7684 createCXTUResourceUsageEntry(*entries,
7685 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
7686 (unsigned long) sizes.mmap_bytes);
7687 }
7688
7689 // How much memory is being used by the Preprocessor?
7690 Preprocessor &pp = astUnit->getPreprocessor();
7691 createCXTUResourceUsageEntry(*entries,
7692 CXTUResourceUsage_Preprocessor,
7693 pp.getTotalMemory());
7694
7695 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
7696 createCXTUResourceUsageEntry(*entries,
7697 CXTUResourceUsage_PreprocessingRecord,
7698 pRec->getTotalMemory());
7699 }
7700
7701 createCXTUResourceUsageEntry(*entries,
7702 CXTUResourceUsage_Preprocessor_HeaderSearch,
7703 pp.getHeaderSearchInfo().getTotalMemory());
Craig Topper69186e72014-06-08 08:38:04 +00007704
Guy Benyei11169dd2012-12-18 14:30:41 +00007705 CXTUResourceUsage usage = { (void*) entries.get(),
7706 (unsigned) entries->size(),
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00007707 !entries->empty() ? &(*entries)[0] : nullptr };
Ahmed Charles9a16beb2014-03-07 19:33:25 +00007708 entries.release();
Guy Benyei11169dd2012-12-18 14:30:41 +00007709 return usage;
7710}
7711
7712void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
7713 if (usage.data)
7714 delete (MemUsageEntries*) usage.data;
7715}
7716
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00007717CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit TU, CXFile file) {
7718 CXSourceRangeList *skipped = new CXSourceRangeList;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007719 skipped->count = 0;
Craig Topper69186e72014-06-08 08:38:04 +00007720 skipped->ranges = nullptr;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007721
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007722 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007723 LOG_BAD_TU(TU);
7724 return skipped;
7725 }
7726
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007727 if (!file)
7728 return skipped;
7729
7730 ASTUnit *astUnit = cxtu::getASTUnit(TU);
7731 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
7732 if (!ppRec)
7733 return skipped;
7734
7735 ASTContext &Ctx = astUnit->getASTContext();
7736 SourceManager &sm = Ctx.getSourceManager();
7737 FileEntry *fileEntry = static_cast<FileEntry *>(file);
7738 FileID wantedFileID = sm.translateFile(fileEntry);
7739
7740 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
7741 std::vector<SourceRange> wantedRanges;
7742 for (std::vector<SourceRange>::const_iterator i = SkippedRanges.begin(), ei = SkippedRanges.end();
7743 i != ei; ++i) {
7744 if (sm.getFileID(i->getBegin()) == wantedFileID || sm.getFileID(i->getEnd()) == wantedFileID)
7745 wantedRanges.push_back(*i);
7746 }
7747
7748 skipped->count = wantedRanges.size();
7749 skipped->ranges = new CXSourceRange[skipped->count];
7750 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
7751 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, wantedRanges[i]);
7752
7753 return skipped;
7754}
7755
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00007756void clang_disposeSourceRangeList(CXSourceRangeList *ranges) {
7757 if (ranges) {
7758 delete[] ranges->ranges;
7759 delete ranges;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007760 }
7761}
7762
Guy Benyei11169dd2012-12-18 14:30:41 +00007763} // end extern "C"
7764
7765void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
7766 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
7767 for (unsigned I = 0; I != Usage.numEntries; ++I)
7768 fprintf(stderr, " %s: %lu\n",
7769 clang_getTUResourceUsageName(Usage.entries[I].kind),
7770 Usage.entries[I].amount);
7771
7772 clang_disposeCXTUResourceUsage(Usage);
7773}
7774
7775//===----------------------------------------------------------------------===//
7776// Misc. utility functions.
7777//===----------------------------------------------------------------------===//
7778
7779/// Default to using an 8 MB stack size on "safety" threads.
7780static unsigned SafetyStackThreadSize = 8 << 20;
7781
7782namespace clang {
7783
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007784bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn,
Guy Benyei11169dd2012-12-18 14:30:41 +00007785 unsigned Size) {
7786 if (!Size)
7787 Size = GetSafetyThreadStackSize();
7788 if (Size)
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007789 return CRC.RunSafelyOnThread(Fn, Size);
7790 return CRC.RunSafely(Fn);
Guy Benyei11169dd2012-12-18 14:30:41 +00007791}
7792
7793unsigned GetSafetyThreadStackSize() {
7794 return SafetyStackThreadSize;
7795}
7796
7797void SetSafetyThreadStackSize(unsigned Value) {
7798 SafetyStackThreadSize = Value;
7799}
7800
Alexander Kornienkoab9db512015-06-22 23:07:51 +00007801}
Guy Benyei11169dd2012-12-18 14:30:41 +00007802
7803void clang::setThreadBackgroundPriority() {
7804 if (getenv("LIBCLANG_BGPRIO_DISABLE"))
7805 return;
7806
Alp Toker1a86ad22014-07-06 06:24:00 +00007807#ifdef USE_DARWIN_THREADS
Guy Benyei11169dd2012-12-18 14:30:41 +00007808 setpriority(PRIO_DARWIN_THREAD, 0, PRIO_DARWIN_BG);
7809#endif
7810}
7811
7812void cxindex::printDiagsToStderr(ASTUnit *Unit) {
7813 if (!Unit)
7814 return;
7815
7816 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
7817 DEnd = Unit->stored_diag_end();
7818 D != DEnd; ++D) {
Ben Langmuir749323f2014-04-22 17:40:12 +00007819 CXStoredDiagnostic Diag(*D, Unit->getLangOpts());
Guy Benyei11169dd2012-12-18 14:30:41 +00007820 CXString Msg = clang_formatDiagnostic(&Diag,
7821 clang_defaultDiagnosticDisplayOptions());
7822 fprintf(stderr, "%s\n", clang_getCString(Msg));
7823 clang_disposeString(Msg);
7824 }
7825#ifdef LLVM_ON_WIN32
7826 // On Windows, force a flush, since there may be multiple copies of
7827 // stderr and stdout in the file system, all with different buffers
7828 // but writing to the same device.
7829 fflush(stderr);
7830#endif
7831}
7832
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007833MacroInfo *cxindex::getMacroInfo(const IdentifierInfo &II,
7834 SourceLocation MacroDefLoc,
7835 CXTranslationUnit TU){
7836 if (MacroDefLoc.isInvalid() || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007837 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007838 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00007839 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007840
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007841 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007842 Preprocessor &PP = Unit->getPreprocessor();
Richard Smith20e883e2015-04-29 23:20:19 +00007843 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00007844 if (MD) {
7845 for (MacroDirective::DefInfo
7846 Def = MD->getDefinition(); Def; Def = Def.getPreviousDefinition()) {
7847 if (MacroDefLoc == Def.getMacroInfo()->getDefinitionLoc())
7848 return Def.getMacroInfo();
7849 }
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007850 }
7851
Craig Topper69186e72014-06-08 08:38:04 +00007852 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007853}
7854
Richard Smith66a81862015-05-04 02:25:31 +00007855const MacroInfo *cxindex::getMacroInfo(const MacroDefinitionRecord *MacroDef,
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007856 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007857 if (!MacroDef || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007858 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007859 const IdentifierInfo *II = MacroDef->getName();
7860 if (!II)
Craig Topper69186e72014-06-08 08:38:04 +00007861 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007862
7863 return getMacroInfo(*II, MacroDef->getLocation(), TU);
7864}
7865
Richard Smith66a81862015-05-04 02:25:31 +00007866MacroDefinitionRecord *
7867cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, const Token &Tok,
7868 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007869 if (!MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007870 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007871 if (Tok.isNot(tok::raw_identifier))
Craig Topper69186e72014-06-08 08:38:04 +00007872 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007873
7874 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00007875 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007876 SourceRange DefRange(MI->getReplacementToken(0).getLocation(),
7877 MI->getDefinitionEndLoc());
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007878 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007879
7880 // Check that the token is inside the definition and not its argument list.
7881 SourceManager &SM = Unit->getSourceManager();
7882 if (SM.isBeforeInTranslationUnit(Tok.getLocation(), DefRange.getBegin()))
Craig Topper69186e72014-06-08 08:38:04 +00007883 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007884 if (SM.isBeforeInTranslationUnit(DefRange.getEnd(), Tok.getLocation()))
Craig Topper69186e72014-06-08 08:38:04 +00007885 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007886
7887 Preprocessor &PP = Unit->getPreprocessor();
7888 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
7889 if (!PPRec)
Craig Topper69186e72014-06-08 08:38:04 +00007890 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007891
Alp Toker2d57cea2014-05-17 04:53:25 +00007892 IdentifierInfo &II = PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007893 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00007894 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007895
7896 // Check that the identifier is not one of the macro arguments.
7897 if (std::find(MI->arg_begin(), MI->arg_end(), &II) != MI->arg_end())
Craig Topper69186e72014-06-08 08:38:04 +00007898 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007899
Richard Smith20e883e2015-04-29 23:20:19 +00007900 MacroDirective *InnerMD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00007901 if (!InnerMD)
Craig Topper69186e72014-06-08 08:38:04 +00007902 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007903
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00007904 return PPRec->findMacroDefinition(InnerMD->getMacroInfo());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007905}
7906
Richard Smith66a81862015-05-04 02:25:31 +00007907MacroDefinitionRecord *
7908cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc,
7909 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007910 if (Loc.isInvalid() || !MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007911 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007912
7913 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00007914 return nullptr;
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007915 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007916 Preprocessor &PP = Unit->getPreprocessor();
7917 if (!PP.getPreprocessingRecord())
Craig Topper69186e72014-06-08 08:38:04 +00007918 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007919 Loc = Unit->getSourceManager().getSpellingLoc(Loc);
7920 Token Tok;
7921 if (PP.getRawToken(Loc, Tok))
Craig Topper69186e72014-06-08 08:38:04 +00007922 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007923
7924 return checkForMacroInMacroDefinition(MI, Tok, TU);
7925}
7926
Guy Benyei11169dd2012-12-18 14:30:41 +00007927extern "C" {
7928
7929CXString clang_getClangVersion() {
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007930 return cxstring::createDup(getClangFullVersion());
Guy Benyei11169dd2012-12-18 14:30:41 +00007931}
7932
7933} // end: extern "C"
7934
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007935Logger &cxindex::Logger::operator<<(CXTranslationUnit TU) {
7936 if (TU) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007937 if (ASTUnit *Unit = cxtu::getASTUnit(TU)) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007938 LogOS << '<' << Unit->getMainFileName() << '>';
Argyrios Kyrtzidis37f2ab42013-03-05 20:21:14 +00007939 if (Unit->isMainFileAST())
7940 LogOS << " (" << Unit->getASTFileName() << ')';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007941 return *this;
7942 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00007943 } else {
7944 LogOS << "<NULL TU>";
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007945 }
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007946 return *this;
7947}
7948
Argyrios Kyrtzidisba4b5f82013-03-08 02:32:26 +00007949Logger &cxindex::Logger::operator<<(const FileEntry *FE) {
7950 *this << FE->getName();
7951 return *this;
7952}
7953
7954Logger &cxindex::Logger::operator<<(CXCursor cursor) {
7955 CXString cursorName = clang_getCursorDisplayName(cursor);
7956 *this << cursorName << "@" << clang_getCursorLocation(cursor);
7957 clang_disposeString(cursorName);
7958 return *this;
7959}
7960
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007961Logger &cxindex::Logger::operator<<(CXSourceLocation Loc) {
7962 CXFile File;
7963 unsigned Line, Column;
Craig Topper69186e72014-06-08 08:38:04 +00007964 clang_getFileLocation(Loc, &File, &Line, &Column, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007965 CXString FileName = clang_getFileName(File);
7966 *this << llvm::format("(%s:%d:%d)", clang_getCString(FileName), Line, Column);
7967 clang_disposeString(FileName);
7968 return *this;
7969}
7970
7971Logger &cxindex::Logger::operator<<(CXSourceRange range) {
7972 CXSourceLocation BLoc = clang_getRangeStart(range);
7973 CXSourceLocation ELoc = clang_getRangeEnd(range);
7974
7975 CXFile BFile;
7976 unsigned BLine, BColumn;
Craig Topper69186e72014-06-08 08:38:04 +00007977 clang_getFileLocation(BLoc, &BFile, &BLine, &BColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007978
7979 CXFile EFile;
7980 unsigned ELine, EColumn;
Craig Topper69186e72014-06-08 08:38:04 +00007981 clang_getFileLocation(ELoc, &EFile, &ELine, &EColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007982
7983 CXString BFileName = clang_getFileName(BFile);
7984 if (BFile == EFile) {
7985 *this << llvm::format("[%s %d:%d-%d:%d]", clang_getCString(BFileName),
7986 BLine, BColumn, ELine, EColumn);
7987 } else {
7988 CXString EFileName = clang_getFileName(EFile);
7989 *this << llvm::format("[%s:%d:%d - ", clang_getCString(BFileName),
7990 BLine, BColumn)
7991 << llvm::format("%s:%d:%d]", clang_getCString(EFileName),
7992 ELine, EColumn);
7993 clang_disposeString(EFileName);
7994 }
7995 clang_disposeString(BFileName);
7996 return *this;
7997}
7998
7999Logger &cxindex::Logger::operator<<(CXString Str) {
8000 *this << clang_getCString(Str);
8001 return *this;
8002}
8003
8004Logger &cxindex::Logger::operator<<(const llvm::format_object_base &Fmt) {
8005 LogOS << Fmt;
8006 return *this;
8007}
8008
Chandler Carruth37ad2582014-06-27 15:14:39 +00008009static llvm::ManagedStatic<llvm::sys::Mutex> LoggingMutex;
8010
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008011cxindex::Logger::~Logger() {
Chandler Carruth37ad2582014-06-27 15:14:39 +00008012 llvm::sys::ScopedLock L(*LoggingMutex);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008013
8014 static llvm::TimeRecord sBeginTR = llvm::TimeRecord::getCurrentTime();
8015
Dmitri Gribenkof8579502013-01-12 19:30:44 +00008016 raw_ostream &OS = llvm::errs();
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008017 OS << "[libclang:" << Name << ':';
8018
Alp Toker1a86ad22014-07-06 06:24:00 +00008019#ifdef USE_DARWIN_THREADS
8020 // TODO: Portability.
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008021 mach_port_t tid = pthread_mach_thread_np(pthread_self());
8022 OS << tid << ':';
8023#endif
8024
8025 llvm::TimeRecord TR = llvm::TimeRecord::getCurrentTime();
8026 OS << llvm::format("%7.4f] ", TR.getWallTime() - sBeginTR.getWallTime());
Yaron Keren09fb7c62015-03-10 07:33:23 +00008027 OS << Msg << '\n';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008028
8029 if (Trace) {
Zachary Turner1fe2a8d2015-03-05 19:15:09 +00008030 llvm::sys::PrintStackTrace(OS);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008031 OS << "--------------------------------------------------\n";
8032 }
8033}
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008034
8035#ifdef CLANG_TOOL_EXTRA_BUILD
8036// This anchor is used to force the linker to link the clang-tidy plugin.
8037extern volatile int ClangTidyPluginAnchorSource;
8038static int LLVM_ATTRIBUTE_UNUSED ClangTidyPluginAnchorDestination =
8039 ClangTidyPluginAnchorSource;
8040#endif