blob: 5ebc2ee9439f62a10d1eda562b7ab99ef1cdd941 [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);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001977
Guy Benyei11169dd2012-12-18 14:30:41 +00001978private:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001979 void AddDeclarationNameInfo(const Stmt *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00001980 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
James Y Knight04ec5bf2015-12-24 02:59:37 +00001981 void AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
1982 unsigned NumTemplateArgs);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001983 void AddMemberRef(const FieldDecl *D, SourceLocation L);
1984 void AddStmt(const Stmt *S);
1985 void AddDecl(const Decl *D, bool isFirst = true);
Guy Benyei11169dd2012-12-18 14:30:41 +00001986 void AddTypeLoc(TypeSourceInfo *TI);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001987 void EnqueueChildren(const Stmt *S);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001988 void EnqueueChildren(const OMPClause *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00001989};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001990} // end anonyous namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00001991
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001992void EnqueueVisitor::AddDeclarationNameInfo(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001993 // 'S' should always be non-null, since it comes from the
1994 // statement we are visiting.
1995 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1996}
1997
1998void
1999EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
2000 if (Qualifier)
2001 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
2002}
2003
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002004void EnqueueVisitor::AddStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002005 if (S)
2006 WL.push_back(StmtVisit(S, Parent));
2007}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002008void EnqueueVisitor::AddDecl(const Decl *D, bool isFirst) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002009 if (D)
2010 WL.push_back(DeclVisit(D, Parent, isFirst));
2011}
James Y Knight04ec5bf2015-12-24 02:59:37 +00002012void EnqueueVisitor::AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2013 unsigned NumTemplateArgs) {
2014 WL.push_back(ExplicitTemplateArgsVisit(A, A + NumTemplateArgs, Parent));
Guy Benyei11169dd2012-12-18 14:30:41 +00002015}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002016void EnqueueVisitor::AddMemberRef(const FieldDecl *D, SourceLocation L) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002017 if (D)
2018 WL.push_back(MemberRefVisit(D, L, Parent));
2019}
2020void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
2021 if (TI)
2022 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
2023 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002024void EnqueueVisitor::EnqueueChildren(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002025 unsigned size = WL.size();
Benjamin Kramer642f1732015-07-02 21:03:14 +00002026 for (const Stmt *SubStmt : S->children()) {
2027 AddStmt(SubStmt);
Guy Benyei11169dd2012-12-18 14:30:41 +00002028 }
2029 if (size == WL.size())
2030 return;
2031 // Now reverse the entries we just added. This will match the DFS
2032 // ordering performed by the worklist.
2033 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2034 std::reverse(I, E);
2035}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002036namespace {
2037class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> {
2038 EnqueueVisitor *Visitor;
Alexey Bataev756c1962013-09-24 03:17:45 +00002039 /// \brief Process clauses with list of variables.
2040 template <typename T>
2041 void VisitOMPClauseList(T *Node);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002042public:
2043 OMPClauseEnqueue(EnqueueVisitor *Visitor) : Visitor(Visitor) { }
2044#define OPENMP_CLAUSE(Name, Class) \
2045 void Visit##Class(const Class *C);
2046#include "clang/Basic/OpenMPKinds.def"
Alexey Bataev3392d762016-02-16 11:18:12 +00002047 void VisitOMPClauseWithPreInit(const OMPClauseWithPreInit *C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002048 void VisitOMPClauseWithPostUpdate(const OMPClauseWithPostUpdate *C);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002049};
2050
Alexey Bataev3392d762016-02-16 11:18:12 +00002051void OMPClauseEnqueue::VisitOMPClauseWithPreInit(
2052 const OMPClauseWithPreInit *C) {
2053 Visitor->AddStmt(C->getPreInitStmt());
2054}
2055
Alexey Bataev005248a2016-02-25 05:25:57 +00002056void OMPClauseEnqueue::VisitOMPClauseWithPostUpdate(
2057 const OMPClauseWithPostUpdate *C) {
Alexey Bataev37e594c2016-03-04 07:21:16 +00002058 VisitOMPClauseWithPreInit(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002059 Visitor->AddStmt(C->getPostUpdateExpr());
2060}
2061
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002062void OMPClauseEnqueue::VisitOMPIfClause(const OMPIfClause *C) {
2063 Visitor->AddStmt(C->getCondition());
2064}
2065
Alexey Bataev3778b602014-07-17 07:32:53 +00002066void OMPClauseEnqueue::VisitOMPFinalClause(const OMPFinalClause *C) {
2067 Visitor->AddStmt(C->getCondition());
2068}
2069
Alexey Bataev568a8332014-03-06 06:15:19 +00002070void OMPClauseEnqueue::VisitOMPNumThreadsClause(const OMPNumThreadsClause *C) {
2071 Visitor->AddStmt(C->getNumThreads());
2072}
2073
Alexey Bataev62c87d22014-03-21 04:51:18 +00002074void OMPClauseEnqueue::VisitOMPSafelenClause(const OMPSafelenClause *C) {
2075 Visitor->AddStmt(C->getSafelen());
2076}
2077
Alexey Bataev66b15b52015-08-21 11:14:16 +00002078void OMPClauseEnqueue::VisitOMPSimdlenClause(const OMPSimdlenClause *C) {
2079 Visitor->AddStmt(C->getSimdlen());
2080}
2081
Alexander Musman8bd31e62014-05-27 15:12:19 +00002082void OMPClauseEnqueue::VisitOMPCollapseClause(const OMPCollapseClause *C) {
2083 Visitor->AddStmt(C->getNumForLoops());
2084}
2085
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002086void OMPClauseEnqueue::VisitOMPDefaultClause(const OMPDefaultClause *C) { }
Alexey Bataev756c1962013-09-24 03:17:45 +00002087
Alexey Bataevbcbadb62014-05-06 06:04:14 +00002088void OMPClauseEnqueue::VisitOMPProcBindClause(const OMPProcBindClause *C) { }
2089
Alexey Bataev56dafe82014-06-20 07:16:17 +00002090void OMPClauseEnqueue::VisitOMPScheduleClause(const OMPScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002091 VisitOMPClauseWithPreInit(C);
Alexey Bataev56dafe82014-06-20 07:16:17 +00002092 Visitor->AddStmt(C->getChunkSize());
2093}
2094
Alexey Bataev10e775f2015-07-30 11:36:16 +00002095void OMPClauseEnqueue::VisitOMPOrderedClause(const OMPOrderedClause *C) {
2096 Visitor->AddStmt(C->getNumForLoops());
2097}
Alexey Bataev142e1fc2014-06-20 09:44:06 +00002098
Alexey Bataev236070f2014-06-20 11:19:47 +00002099void OMPClauseEnqueue::VisitOMPNowaitClause(const OMPNowaitClause *) {}
2100
Alexey Bataev7aea99a2014-07-17 12:19:31 +00002101void OMPClauseEnqueue::VisitOMPUntiedClause(const OMPUntiedClause *) {}
2102
Alexey Bataev74ba3a52014-07-17 12:47:03 +00002103void OMPClauseEnqueue::VisitOMPMergeableClause(const OMPMergeableClause *) {}
2104
Alexey Bataevf98b00c2014-07-23 02:27:21 +00002105void OMPClauseEnqueue::VisitOMPReadClause(const OMPReadClause *) {}
2106
Alexey Bataevdea47612014-07-23 07:46:59 +00002107void OMPClauseEnqueue::VisitOMPWriteClause(const OMPWriteClause *) {}
2108
Alexey Bataev67a4f222014-07-23 10:25:33 +00002109void OMPClauseEnqueue::VisitOMPUpdateClause(const OMPUpdateClause *) {}
2110
Alexey Bataev459dec02014-07-24 06:46:57 +00002111void OMPClauseEnqueue::VisitOMPCaptureClause(const OMPCaptureClause *) {}
2112
Alexey Bataev82bad8b2014-07-24 08:55:34 +00002113void OMPClauseEnqueue::VisitOMPSeqCstClause(const OMPSeqCstClause *) {}
2114
Alexey Bataev346265e2015-09-25 10:37:12 +00002115void OMPClauseEnqueue::VisitOMPThreadsClause(const OMPThreadsClause *) {}
2116
Alexey Bataevd14d1e62015-09-28 06:39:35 +00002117void OMPClauseEnqueue::VisitOMPSIMDClause(const OMPSIMDClause *) {}
2118
Alexey Bataevb825de12015-12-07 10:51:44 +00002119void OMPClauseEnqueue::VisitOMPNogroupClause(const OMPNogroupClause *) {}
2120
Michael Wonge710d542015-08-07 16:16:36 +00002121void OMPClauseEnqueue::VisitOMPDeviceClause(const OMPDeviceClause *C) {
2122 Visitor->AddStmt(C->getDevice());
2123}
2124
Kelvin Li099bb8c2015-11-24 20:50:12 +00002125void OMPClauseEnqueue::VisitOMPNumTeamsClause(const OMPNumTeamsClause *C) {
2126 Visitor->AddStmt(C->getNumTeams());
2127}
2128
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002129void OMPClauseEnqueue::VisitOMPThreadLimitClause(const OMPThreadLimitClause *C) {
2130 Visitor->AddStmt(C->getThreadLimit());
2131}
2132
Alexey Bataeva0569352015-12-01 10:17:31 +00002133void OMPClauseEnqueue::VisitOMPPriorityClause(const OMPPriorityClause *C) {
2134 Visitor->AddStmt(C->getPriority());
2135}
2136
Alexey Bataev1fd4aed2015-12-07 12:52:51 +00002137void OMPClauseEnqueue::VisitOMPGrainsizeClause(const OMPGrainsizeClause *C) {
2138 Visitor->AddStmt(C->getGrainsize());
2139}
2140
Alexey Bataev382967a2015-12-08 12:06:20 +00002141void OMPClauseEnqueue::VisitOMPNumTasksClause(const OMPNumTasksClause *C) {
2142 Visitor->AddStmt(C->getNumTasks());
2143}
2144
Alexey Bataev28c75412015-12-15 08:19:24 +00002145void OMPClauseEnqueue::VisitOMPHintClause(const OMPHintClause *C) {
2146 Visitor->AddStmt(C->getHint());
2147}
2148
Alexey Bataev756c1962013-09-24 03:17:45 +00002149template<typename T>
2150void OMPClauseEnqueue::VisitOMPClauseList(T *Node) {
Alexey Bataev03b340a2014-10-21 03:16:40 +00002151 for (const auto *I : Node->varlists()) {
Aaron Ballman2205d2a2014-03-14 15:55:35 +00002152 Visitor->AddStmt(I);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002153 }
Alexey Bataev756c1962013-09-24 03:17:45 +00002154}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002155
2156void OMPClauseEnqueue::VisitOMPPrivateClause(const OMPPrivateClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002157 VisitOMPClauseList(C);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002158 for (const auto *E : C->private_copies()) {
2159 Visitor->AddStmt(E);
2160 }
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002161}
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002162void OMPClauseEnqueue::VisitOMPFirstprivateClause(
2163 const OMPFirstprivateClause *C) {
2164 VisitOMPClauseList(C);
Alexey Bataev417089f2016-02-17 13:19:37 +00002165 VisitOMPClauseWithPreInit(C);
2166 for (const auto *E : C->private_copies()) {
2167 Visitor->AddStmt(E);
2168 }
2169 for (const auto *E : C->inits()) {
2170 Visitor->AddStmt(E);
2171 }
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002172}
Alexander Musman1bb328c2014-06-04 13:06:39 +00002173void OMPClauseEnqueue::VisitOMPLastprivateClause(
2174 const OMPLastprivateClause *C) {
2175 VisitOMPClauseList(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002176 VisitOMPClauseWithPostUpdate(C);
Alexey Bataev38e89532015-04-16 04:54:05 +00002177 for (auto *E : C->private_copies()) {
2178 Visitor->AddStmt(E);
2179 }
2180 for (auto *E : C->source_exprs()) {
2181 Visitor->AddStmt(E);
2182 }
2183 for (auto *E : C->destination_exprs()) {
2184 Visitor->AddStmt(E);
2185 }
2186 for (auto *E : C->assignment_ops()) {
2187 Visitor->AddStmt(E);
2188 }
Alexander Musman1bb328c2014-06-04 13:06:39 +00002189}
Alexey Bataev758e55e2013-09-06 18:03:48 +00002190void OMPClauseEnqueue::VisitOMPSharedClause(const OMPSharedClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002191 VisitOMPClauseList(C);
Alexey Bataev758e55e2013-09-06 18:03:48 +00002192}
Alexey Bataevc5e02582014-06-16 07:08:35 +00002193void OMPClauseEnqueue::VisitOMPReductionClause(const OMPReductionClause *C) {
2194 VisitOMPClauseList(C);
Alexey Bataev61205072016-03-02 04:57:40 +00002195 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevf24e7b12015-10-08 09:10:53 +00002196 for (auto *E : C->privates()) {
2197 Visitor->AddStmt(E);
2198 }
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002199 for (auto *E : C->lhs_exprs()) {
2200 Visitor->AddStmt(E);
2201 }
2202 for (auto *E : C->rhs_exprs()) {
2203 Visitor->AddStmt(E);
2204 }
2205 for (auto *E : C->reduction_ops()) {
2206 Visitor->AddStmt(E);
2207 }
Alexey Bataevc5e02582014-06-16 07:08:35 +00002208}
Alexander Musman8dba6642014-04-22 13:09:42 +00002209void OMPClauseEnqueue::VisitOMPLinearClause(const OMPLinearClause *C) {
2210 VisitOMPClauseList(C);
Alexey Bataev78849fb2016-03-09 09:49:00 +00002211 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevbd9fec12015-08-18 06:47:21 +00002212 for (const auto *E : C->privates()) {
2213 Visitor->AddStmt(E);
2214 }
Alexander Musman3276a272015-03-21 10:12:56 +00002215 for (const auto *E : C->inits()) {
2216 Visitor->AddStmt(E);
2217 }
2218 for (const auto *E : C->updates()) {
2219 Visitor->AddStmt(E);
2220 }
2221 for (const auto *E : C->finals()) {
2222 Visitor->AddStmt(E);
2223 }
Alexander Musman8dba6642014-04-22 13:09:42 +00002224 Visitor->AddStmt(C->getStep());
Alexander Musman3276a272015-03-21 10:12:56 +00002225 Visitor->AddStmt(C->getCalcStep());
Alexander Musman8dba6642014-04-22 13:09:42 +00002226}
Alexander Musmanf0d76e72014-05-29 14:36:25 +00002227void OMPClauseEnqueue::VisitOMPAlignedClause(const OMPAlignedClause *C) {
2228 VisitOMPClauseList(C);
2229 Visitor->AddStmt(C->getAlignment());
2230}
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002231void OMPClauseEnqueue::VisitOMPCopyinClause(const OMPCopyinClause *C) {
2232 VisitOMPClauseList(C);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002233 for (auto *E : C->source_exprs()) {
2234 Visitor->AddStmt(E);
2235 }
2236 for (auto *E : C->destination_exprs()) {
2237 Visitor->AddStmt(E);
2238 }
2239 for (auto *E : C->assignment_ops()) {
2240 Visitor->AddStmt(E);
2241 }
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002242}
Alexey Bataevbae9a792014-06-27 10:37:06 +00002243void
2244OMPClauseEnqueue::VisitOMPCopyprivateClause(const OMPCopyprivateClause *C) {
2245 VisitOMPClauseList(C);
Alexey Bataeva63048e2015-03-23 06:18:07 +00002246 for (auto *E : C->source_exprs()) {
2247 Visitor->AddStmt(E);
2248 }
2249 for (auto *E : C->destination_exprs()) {
2250 Visitor->AddStmt(E);
2251 }
2252 for (auto *E : C->assignment_ops()) {
2253 Visitor->AddStmt(E);
2254 }
Alexey Bataevbae9a792014-06-27 10:37:06 +00002255}
Alexey Bataev6125da92014-07-21 11:26:11 +00002256void OMPClauseEnqueue::VisitOMPFlushClause(const OMPFlushClause *C) {
2257 VisitOMPClauseList(C);
2258}
Alexey Bataev1c2cfbc2015-06-23 14:25:19 +00002259void OMPClauseEnqueue::VisitOMPDependClause(const OMPDependClause *C) {
2260 VisitOMPClauseList(C);
2261}
Kelvin Li0bff7af2015-11-23 05:32:03 +00002262void OMPClauseEnqueue::VisitOMPMapClause(const OMPMapClause *C) {
2263 VisitOMPClauseList(C);
2264}
Carlo Bertollib4adf552016-01-15 18:50:31 +00002265void OMPClauseEnqueue::VisitOMPDistScheduleClause(
2266 const OMPDistScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002267 VisitOMPClauseWithPreInit(C);
Carlo Bertollib4adf552016-01-15 18:50:31 +00002268 Visitor->AddStmt(C->getChunkSize());
Carlo Bertollib4adf552016-01-15 18:50:31 +00002269}
Alexey Bataev3392d762016-02-16 11:18:12 +00002270void OMPClauseEnqueue::VisitOMPDefaultmapClause(
2271 const OMPDefaultmapClause * /*C*/) {}
Samuel Antao661c0902016-05-26 17:39:58 +00002272void OMPClauseEnqueue::VisitOMPToClause(const OMPToClause *C) {
2273 VisitOMPClauseList(C);
2274}
Samuel Antaoec172c62016-05-26 17:49:04 +00002275void OMPClauseEnqueue::VisitOMPFromClause(const OMPFromClause *C) {
2276 VisitOMPClauseList(C);
2277}
Carlo Bertolli2404b172016-07-13 15:37:16 +00002278void OMPClauseEnqueue::VisitOMPUseDevicePtrClause(const OMPUseDevicePtrClause *C) {
2279 VisitOMPClauseList(C);
2280}
Carlo Bertolli70594e92016-07-13 17:16:49 +00002281void OMPClauseEnqueue::VisitOMPIsDevicePtrClause(const OMPIsDevicePtrClause *C) {
2282 VisitOMPClauseList(C);
2283}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002284}
Alexey Bataev756c1962013-09-24 03:17:45 +00002285
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002286void EnqueueVisitor::EnqueueChildren(const OMPClause *S) {
2287 unsigned size = WL.size();
2288 OMPClauseEnqueue Visitor(this);
2289 Visitor.Visit(S);
2290 if (size == WL.size())
2291 return;
2292 // Now reverse the entries we just added. This will match the DFS
2293 // ordering performed by the worklist.
2294 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2295 std::reverse(I, E);
2296}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002297void EnqueueVisitor::VisitAddrLabelExpr(const AddrLabelExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002298 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
2299}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002300void EnqueueVisitor::VisitBlockExpr(const BlockExpr *B) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002301 AddDecl(B->getBlockDecl());
2302}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002303void EnqueueVisitor::VisitCompoundLiteralExpr(const CompoundLiteralExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002304 EnqueueChildren(E);
2305 AddTypeLoc(E->getTypeSourceInfo());
2306}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002307void EnqueueVisitor::VisitCompoundStmt(const CompoundStmt *S) {
Pete Cooper57d3f142015-07-30 17:22:52 +00002308 for (auto &I : llvm::reverse(S->body()))
2309 AddStmt(I);
Guy Benyei11169dd2012-12-18 14:30:41 +00002310}
2311void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002312VisitMSDependentExistsStmt(const MSDependentExistsStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002313 AddStmt(S->getSubStmt());
2314 AddDeclarationNameInfo(S);
2315 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
2316 AddNestedNameSpecifierLoc(QualifierLoc);
2317}
2318
2319void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002320VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002321 if (E->hasExplicitTemplateArgs())
2322 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002323 AddDeclarationNameInfo(E);
2324 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2325 AddNestedNameSpecifierLoc(QualifierLoc);
2326 if (!E->isImplicitAccess())
2327 AddStmt(E->getBase());
2328}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002329void EnqueueVisitor::VisitCXXNewExpr(const CXXNewExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002330 // Enqueue the initializer , if any.
2331 AddStmt(E->getInitializer());
2332 // Enqueue the array size, if any.
2333 AddStmt(E->getArraySize());
2334 // Enqueue the allocated type.
2335 AddTypeLoc(E->getAllocatedTypeSourceInfo());
2336 // Enqueue the placement arguments.
2337 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
2338 AddStmt(E->getPlacementArg(I-1));
2339}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002340void EnqueueVisitor::VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *CE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002341 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
2342 AddStmt(CE->getArg(I-1));
2343 AddStmt(CE->getCallee());
2344 AddStmt(CE->getArg(0));
2345}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002346void EnqueueVisitor::VisitCXXPseudoDestructorExpr(
2347 const CXXPseudoDestructorExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002348 // Visit the name of the type being destroyed.
2349 AddTypeLoc(E->getDestroyedTypeInfo());
2350 // Visit the scope type that looks disturbingly like the nested-name-specifier
2351 // but isn't.
2352 AddTypeLoc(E->getScopeTypeInfo());
2353 // Visit the nested-name-specifier.
2354 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2355 AddNestedNameSpecifierLoc(QualifierLoc);
2356 // Visit base expression.
2357 AddStmt(E->getBase());
2358}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002359void EnqueueVisitor::VisitCXXScalarValueInitExpr(
2360 const CXXScalarValueInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002361 AddTypeLoc(E->getTypeSourceInfo());
2362}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002363void EnqueueVisitor::VisitCXXTemporaryObjectExpr(
2364 const CXXTemporaryObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002365 EnqueueChildren(E);
2366 AddTypeLoc(E->getTypeSourceInfo());
2367}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002368void EnqueueVisitor::VisitCXXTypeidExpr(const CXXTypeidExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002369 EnqueueChildren(E);
2370 if (E->isTypeOperand())
2371 AddTypeLoc(E->getTypeOperandSourceInfo());
2372}
2373
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002374void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(
2375 const CXXUnresolvedConstructExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002376 EnqueueChildren(E);
2377 AddTypeLoc(E->getTypeSourceInfo());
2378}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002379void EnqueueVisitor::VisitCXXUuidofExpr(const CXXUuidofExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002380 EnqueueChildren(E);
2381 if (E->isTypeOperand())
2382 AddTypeLoc(E->getTypeOperandSourceInfo());
2383}
2384
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002385void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002386 EnqueueChildren(S);
2387 AddDecl(S->getExceptionDecl());
2388}
2389
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002390void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002391 AddStmt(S->getBody());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002392 AddStmt(S->getRangeInit());
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002393 AddDecl(S->getLoopVariable());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002394}
2395
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002396void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002397 if (DR->hasExplicitTemplateArgs())
2398 AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002399 WL.push_back(DeclRefExprParts(DR, Parent));
2400}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002401void EnqueueVisitor::VisitDependentScopeDeclRefExpr(
2402 const DependentScopeDeclRefExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002403 if (E->hasExplicitTemplateArgs())
2404 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002405 AddDeclarationNameInfo(E);
2406 AddNestedNameSpecifierLoc(E->getQualifierLoc());
2407}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002408void EnqueueVisitor::VisitDeclStmt(const DeclStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002409 unsigned size = WL.size();
2410 bool isFirst = true;
Aaron Ballman535bbcc2014-03-14 17:01:24 +00002411 for (const auto *D : S->decls()) {
2412 AddDecl(D, isFirst);
Guy Benyei11169dd2012-12-18 14:30:41 +00002413 isFirst = false;
2414 }
2415 if (size == WL.size())
2416 return;
2417 // Now reverse the entries we just added. This will match the DFS
2418 // ordering performed by the worklist.
2419 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2420 std::reverse(I, E);
2421}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002422void EnqueueVisitor::VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002423 AddStmt(E->getInit());
David Majnemerf7e36092016-06-23 00:15:04 +00002424 for (const DesignatedInitExpr::Designator &D :
2425 llvm::reverse(E->designators())) {
2426 if (D.isFieldDesignator()) {
2427 if (FieldDecl *Field = D.getField())
2428 AddMemberRef(Field, D.getFieldLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00002429 continue;
2430 }
David Majnemerf7e36092016-06-23 00:15:04 +00002431 if (D.isArrayDesignator()) {
2432 AddStmt(E->getArrayIndex(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002433 continue;
2434 }
David Majnemerf7e36092016-06-23 00:15:04 +00002435 assert(D.isArrayRangeDesignator() && "Unknown designator kind");
2436 AddStmt(E->getArrayRangeEnd(D));
2437 AddStmt(E->getArrayRangeStart(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002438 }
2439}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002440void EnqueueVisitor::VisitExplicitCastExpr(const ExplicitCastExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002441 EnqueueChildren(E);
2442 AddTypeLoc(E->getTypeInfoAsWritten());
2443}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002444void EnqueueVisitor::VisitForStmt(const ForStmt *FS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002445 AddStmt(FS->getBody());
2446 AddStmt(FS->getInc());
2447 AddStmt(FS->getCond());
2448 AddDecl(FS->getConditionVariable());
2449 AddStmt(FS->getInit());
2450}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002451void EnqueueVisitor::VisitGotoStmt(const GotoStmt *GS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002452 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2453}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002454void EnqueueVisitor::VisitIfStmt(const IfStmt *If) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002455 AddStmt(If->getElse());
2456 AddStmt(If->getThen());
2457 AddStmt(If->getCond());
2458 AddDecl(If->getConditionVariable());
2459}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002460void EnqueueVisitor::VisitInitListExpr(const InitListExpr *IE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002461 // We care about the syntactic form of the initializer list, only.
2462 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2463 IE = Syntactic;
2464 EnqueueChildren(IE);
2465}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002466void EnqueueVisitor::VisitMemberExpr(const MemberExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002467 WL.push_back(MemberExprParts(M, Parent));
2468
2469 // If the base of the member access expression is an implicit 'this', don't
2470 // visit it.
2471 // FIXME: If we ever want to show these implicit accesses, this will be
2472 // unfortunate. However, clang_getCursor() relies on this behavior.
Argyrios Kyrtzidis58d0e7a2015-03-13 04:40:07 +00002473 if (M->isImplicitAccess())
2474 return;
2475
2476 // Ignore base anonymous struct/union fields, otherwise they will shadow the
2477 // real field that that we are interested in.
2478 if (auto *SubME = dyn_cast<MemberExpr>(M->getBase())) {
2479 if (auto *FD = dyn_cast_or_null<FieldDecl>(SubME->getMemberDecl())) {
2480 if (FD->isAnonymousStructOrUnion()) {
2481 AddStmt(SubME->getBase());
2482 return;
2483 }
2484 }
2485 }
2486
2487 AddStmt(M->getBase());
Guy Benyei11169dd2012-12-18 14:30:41 +00002488}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002489void EnqueueVisitor::VisitObjCEncodeExpr(const ObjCEncodeExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002490 AddTypeLoc(E->getEncodedTypeSourceInfo());
2491}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002492void EnqueueVisitor::VisitObjCMessageExpr(const ObjCMessageExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002493 EnqueueChildren(M);
2494 AddTypeLoc(M->getClassReceiverTypeInfo());
2495}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002496void EnqueueVisitor::VisitOffsetOfExpr(const OffsetOfExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002497 // Visit the components of the offsetof expression.
2498 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002499 const OffsetOfNode &Node = E->getComponent(I-1);
2500 switch (Node.getKind()) {
2501 case OffsetOfNode::Array:
2502 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2503 break;
2504 case OffsetOfNode::Field:
2505 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
2506 break;
2507 case OffsetOfNode::Identifier:
2508 case OffsetOfNode::Base:
2509 continue;
2510 }
2511 }
2512 // Visit the type into which we're computing the offset.
2513 AddTypeLoc(E->getTypeSourceInfo());
2514}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002515void EnqueueVisitor::VisitOverloadExpr(const OverloadExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002516 if (E->hasExplicitTemplateArgs())
2517 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002518 WL.push_back(OverloadExprParts(E, Parent));
2519}
2520void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002521 const UnaryExprOrTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002522 EnqueueChildren(E);
2523 if (E->isArgumentType())
2524 AddTypeLoc(E->getArgumentTypeInfo());
2525}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002526void EnqueueVisitor::VisitStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 EnqueueChildren(S);
2528}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002529void EnqueueVisitor::VisitSwitchStmt(const SwitchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002530 AddStmt(S->getBody());
2531 AddStmt(S->getCond());
2532 AddDecl(S->getConditionVariable());
2533}
2534
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002535void EnqueueVisitor::VisitWhileStmt(const WhileStmt *W) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002536 AddStmt(W->getBody());
2537 AddStmt(W->getCond());
2538 AddDecl(W->getConditionVariable());
2539}
2540
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002541void EnqueueVisitor::VisitTypeTraitExpr(const TypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002542 for (unsigned I = E->getNumArgs(); I > 0; --I)
2543 AddTypeLoc(E->getArg(I-1));
2544}
2545
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002546void EnqueueVisitor::VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002547 AddTypeLoc(E->getQueriedTypeSourceInfo());
2548}
2549
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002550void EnqueueVisitor::VisitExpressionTraitExpr(const ExpressionTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002551 EnqueueChildren(E);
2552}
2553
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002554void EnqueueVisitor::VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002555 VisitOverloadExpr(U);
2556 if (!U->isImplicitAccess())
2557 AddStmt(U->getBase());
2558}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002559void EnqueueVisitor::VisitVAArgExpr(const VAArgExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002560 AddStmt(E->getSubExpr());
2561 AddTypeLoc(E->getWrittenTypeInfo());
2562}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002563void EnqueueVisitor::VisitSizeOfPackExpr(const SizeOfPackExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002564 WL.push_back(SizeOfPackExprParts(E, Parent));
2565}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002566void EnqueueVisitor::VisitOpaqueValueExpr(const OpaqueValueExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002567 // If the opaque value has a source expression, just transparently
2568 // visit that. This is useful for (e.g.) pseudo-object expressions.
2569 if (Expr *SourceExpr = E->getSourceExpr())
2570 return Visit(SourceExpr);
2571}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002572void EnqueueVisitor::VisitLambdaExpr(const LambdaExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002573 AddStmt(E->getBody());
2574 WL.push_back(LambdaExprParts(E, Parent));
2575}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002576void EnqueueVisitor::VisitPseudoObjectExpr(const PseudoObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002577 // Treat the expression like its syntactic form.
2578 Visit(E->getSyntacticForm());
2579}
2580
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002581void EnqueueVisitor::VisitOMPExecutableDirective(
2582 const OMPExecutableDirective *D) {
2583 EnqueueChildren(D);
2584 for (ArrayRef<OMPClause *>::iterator I = D->clauses().begin(),
2585 E = D->clauses().end();
2586 I != E; ++I)
2587 EnqueueChildren(*I);
2588}
2589
Alexander Musman3aaab662014-08-19 11:27:13 +00002590void EnqueueVisitor::VisitOMPLoopDirective(const OMPLoopDirective *D) {
2591 VisitOMPExecutableDirective(D);
2592}
2593
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002594void EnqueueVisitor::VisitOMPParallelDirective(const OMPParallelDirective *D) {
2595 VisitOMPExecutableDirective(D);
2596}
2597
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002598void EnqueueVisitor::VisitOMPSimdDirective(const OMPSimdDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002599 VisitOMPLoopDirective(D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002600}
2601
Alexey Bataevf29276e2014-06-18 04:14:57 +00002602void EnqueueVisitor::VisitOMPForDirective(const OMPForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002603 VisitOMPLoopDirective(D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002604}
2605
Alexander Musmanf82886e2014-09-18 05:12:34 +00002606void EnqueueVisitor::VisitOMPForSimdDirective(const OMPForSimdDirective *D) {
2607 VisitOMPLoopDirective(D);
2608}
2609
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002610void EnqueueVisitor::VisitOMPSectionsDirective(const OMPSectionsDirective *D) {
2611 VisitOMPExecutableDirective(D);
2612}
2613
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002614void EnqueueVisitor::VisitOMPSectionDirective(const OMPSectionDirective *D) {
2615 VisitOMPExecutableDirective(D);
2616}
2617
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002618void EnqueueVisitor::VisitOMPSingleDirective(const OMPSingleDirective *D) {
2619 VisitOMPExecutableDirective(D);
2620}
2621
Alexander Musman80c22892014-07-17 08:54:58 +00002622void EnqueueVisitor::VisitOMPMasterDirective(const OMPMasterDirective *D) {
2623 VisitOMPExecutableDirective(D);
2624}
2625
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002626void EnqueueVisitor::VisitOMPCriticalDirective(const OMPCriticalDirective *D) {
2627 VisitOMPExecutableDirective(D);
2628 AddDeclarationNameInfo(D);
2629}
2630
Alexey Bataev4acb8592014-07-07 13:01:15 +00002631void
2632EnqueueVisitor::VisitOMPParallelForDirective(const OMPParallelForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002633 VisitOMPLoopDirective(D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002634}
2635
Alexander Musmane4e893b2014-09-23 09:33:00 +00002636void EnqueueVisitor::VisitOMPParallelForSimdDirective(
2637 const OMPParallelForSimdDirective *D) {
2638 VisitOMPLoopDirective(D);
2639}
2640
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002641void EnqueueVisitor::VisitOMPParallelSectionsDirective(
2642 const OMPParallelSectionsDirective *D) {
2643 VisitOMPExecutableDirective(D);
2644}
2645
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002646void EnqueueVisitor::VisitOMPTaskDirective(const OMPTaskDirective *D) {
2647 VisitOMPExecutableDirective(D);
2648}
2649
Alexey Bataev68446b72014-07-18 07:47:19 +00002650void
2651EnqueueVisitor::VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D) {
2652 VisitOMPExecutableDirective(D);
2653}
2654
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002655void EnqueueVisitor::VisitOMPBarrierDirective(const OMPBarrierDirective *D) {
2656 VisitOMPExecutableDirective(D);
2657}
2658
Alexey Bataev2df347a2014-07-18 10:17:07 +00002659void EnqueueVisitor::VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D) {
2660 VisitOMPExecutableDirective(D);
2661}
2662
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002663void EnqueueVisitor::VisitOMPTaskgroupDirective(
2664 const OMPTaskgroupDirective *D) {
2665 VisitOMPExecutableDirective(D);
2666}
2667
Alexey Bataev6125da92014-07-21 11:26:11 +00002668void EnqueueVisitor::VisitOMPFlushDirective(const OMPFlushDirective *D) {
2669 VisitOMPExecutableDirective(D);
2670}
2671
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002672void EnqueueVisitor::VisitOMPOrderedDirective(const OMPOrderedDirective *D) {
2673 VisitOMPExecutableDirective(D);
2674}
2675
Alexey Bataev0162e452014-07-22 10:10:35 +00002676void EnqueueVisitor::VisitOMPAtomicDirective(const OMPAtomicDirective *D) {
2677 VisitOMPExecutableDirective(D);
2678}
2679
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002680void EnqueueVisitor::VisitOMPTargetDirective(const OMPTargetDirective *D) {
2681 VisitOMPExecutableDirective(D);
2682}
2683
Michael Wong65f367f2015-07-21 13:44:28 +00002684void EnqueueVisitor::VisitOMPTargetDataDirective(const
2685 OMPTargetDataDirective *D) {
2686 VisitOMPExecutableDirective(D);
2687}
2688
Samuel Antaodf67fc42016-01-19 19:15:56 +00002689void EnqueueVisitor::VisitOMPTargetEnterDataDirective(
2690 const OMPTargetEnterDataDirective *D) {
2691 VisitOMPExecutableDirective(D);
2692}
2693
Samuel Antao72590762016-01-19 20:04:50 +00002694void EnqueueVisitor::VisitOMPTargetExitDataDirective(
2695 const OMPTargetExitDataDirective *D) {
2696 VisitOMPExecutableDirective(D);
2697}
2698
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002699void EnqueueVisitor::VisitOMPTargetParallelDirective(
2700 const OMPTargetParallelDirective *D) {
2701 VisitOMPExecutableDirective(D);
2702}
2703
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002704void EnqueueVisitor::VisitOMPTargetParallelForDirective(
2705 const OMPTargetParallelForDirective *D) {
2706 VisitOMPLoopDirective(D);
2707}
2708
Alexey Bataev13314bf2014-10-09 04:18:56 +00002709void EnqueueVisitor::VisitOMPTeamsDirective(const OMPTeamsDirective *D) {
2710 VisitOMPExecutableDirective(D);
2711}
2712
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002713void EnqueueVisitor::VisitOMPCancellationPointDirective(
2714 const OMPCancellationPointDirective *D) {
2715 VisitOMPExecutableDirective(D);
2716}
2717
Alexey Bataev80909872015-07-02 11:25:17 +00002718void EnqueueVisitor::VisitOMPCancelDirective(const OMPCancelDirective *D) {
2719 VisitOMPExecutableDirective(D);
2720}
2721
Alexey Bataev49f6e782015-12-01 04:18:41 +00002722void EnqueueVisitor::VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D) {
2723 VisitOMPLoopDirective(D);
2724}
2725
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002726void EnqueueVisitor::VisitOMPTaskLoopSimdDirective(
2727 const OMPTaskLoopSimdDirective *D) {
2728 VisitOMPLoopDirective(D);
2729}
2730
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002731void EnqueueVisitor::VisitOMPDistributeDirective(
2732 const OMPDistributeDirective *D) {
2733 VisitOMPLoopDirective(D);
2734}
2735
Carlo Bertolli9925f152016-06-27 14:55:37 +00002736void EnqueueVisitor::VisitOMPDistributeParallelForDirective(
2737 const OMPDistributeParallelForDirective *D) {
2738 VisitOMPLoopDirective(D);
2739}
2740
Kelvin Li4a39add2016-07-05 05:00:15 +00002741void EnqueueVisitor::VisitOMPDistributeParallelForSimdDirective(
2742 const OMPDistributeParallelForSimdDirective *D) {
2743 VisitOMPLoopDirective(D);
2744}
2745
Kelvin Li787f3fc2016-07-06 04:45:38 +00002746void EnqueueVisitor::VisitOMPDistributeSimdDirective(
2747 const OMPDistributeSimdDirective *D) {
2748 VisitOMPLoopDirective(D);
2749}
2750
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002751void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002752 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
2753}
2754
2755bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2756 if (RegionOfInterest.isValid()) {
2757 SourceRange Range = getRawCursorExtent(C);
2758 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2759 return false;
2760 }
2761 return true;
2762}
2763
2764bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2765 while (!WL.empty()) {
2766 // Dequeue the worklist item.
Robert Wilhelm25284cc2013-08-23 16:11:15 +00002767 VisitorJob LI = WL.pop_back_val();
Guy Benyei11169dd2012-12-18 14:30:41 +00002768
2769 // Set the Parent field, then back to its old value once we're done.
2770 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2771
2772 switch (LI.getKind()) {
2773 case VisitorJob::DeclVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002774 const Decl *D = cast<DeclVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002775 if (!D)
2776 continue;
2777
2778 // For now, perform default visitation for Decls.
2779 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2780 cast<DeclVisit>(&LI)->isFirst())))
2781 return true;
2782
2783 continue;
2784 }
2785 case VisitorJob::ExplicitTemplateArgsVisitKind: {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002786 for (const TemplateArgumentLoc &Arg :
2787 *cast<ExplicitTemplateArgsVisit>(&LI)) {
2788 if (VisitTemplateArgumentLoc(Arg))
Guy Benyei11169dd2012-12-18 14:30:41 +00002789 return true;
2790 }
2791 continue;
2792 }
2793 case VisitorJob::TypeLocVisitKind: {
2794 // Perform default visitation for TypeLocs.
2795 if (Visit(cast<TypeLocVisit>(&LI)->get()))
2796 return true;
2797 continue;
2798 }
2799 case VisitorJob::LabelRefVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002800 const LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002801 if (LabelStmt *stmt = LS->getStmt()) {
2802 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2803 TU))) {
2804 return true;
2805 }
2806 }
2807 continue;
2808 }
2809
2810 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2811 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2812 if (VisitNestedNameSpecifierLoc(V->get()))
2813 return true;
2814 continue;
2815 }
2816
2817 case VisitorJob::DeclarationNameInfoVisitKind: {
2818 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2819 ->get()))
2820 return true;
2821 continue;
2822 }
2823 case VisitorJob::MemberRefVisitKind: {
2824 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2825 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2826 return true;
2827 continue;
2828 }
2829 case VisitorJob::StmtVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002830 const Stmt *S = cast<StmtVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002831 if (!S)
2832 continue;
2833
2834 // Update the current cursor.
2835 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
2836 if (!IsInRegionOfInterest(Cursor))
2837 continue;
2838 switch (Visitor(Cursor, Parent, ClientData)) {
2839 case CXChildVisit_Break: return true;
2840 case CXChildVisit_Continue: break;
2841 case CXChildVisit_Recurse:
2842 if (PostChildrenVisitor)
Craig Topper69186e72014-06-08 08:38:04 +00002843 WL.push_back(PostChildrenVisit(nullptr, Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +00002844 EnqueueWorkList(WL, S);
2845 break;
2846 }
2847 continue;
2848 }
2849 case VisitorJob::MemberExprPartsKind: {
2850 // Handle the other pieces in the MemberExpr besides the base.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002851 const MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002852
2853 // Visit the nested-name-specifier
2854 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
2855 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2856 return true;
2857
2858 // Visit the declaration name.
2859 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2860 return true;
2861
2862 // Visit the explicitly-specified template arguments, if any.
2863 if (M->hasExplicitTemplateArgs()) {
2864 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2865 *ArgEnd = Arg + M->getNumTemplateArgs();
2866 Arg != ArgEnd; ++Arg) {
2867 if (VisitTemplateArgumentLoc(*Arg))
2868 return true;
2869 }
2870 }
2871 continue;
2872 }
2873 case VisitorJob::DeclRefExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002874 const DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002875 // Visit nested-name-specifier, if present.
2876 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
2877 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2878 return true;
2879 // Visit declaration name.
2880 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2881 return true;
2882 continue;
2883 }
2884 case VisitorJob::OverloadExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002885 const OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002886 // Visit the nested-name-specifier.
2887 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
2888 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2889 return true;
2890 // Visit the declaration name.
2891 if (VisitDeclarationNameInfo(O->getNameInfo()))
2892 return true;
2893 // Visit the overloaded declaration reference.
2894 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2895 return true;
2896 continue;
2897 }
2898 case VisitorJob::SizeOfPackExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002899 const SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002900 NamedDecl *Pack = E->getPack();
2901 if (isa<TemplateTypeParmDecl>(Pack)) {
2902 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
2903 E->getPackLoc(), TU)))
2904 return true;
2905
2906 continue;
2907 }
2908
2909 if (isa<TemplateTemplateParmDecl>(Pack)) {
2910 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
2911 E->getPackLoc(), TU)))
2912 return true;
2913
2914 continue;
2915 }
2916
2917 // Non-type template parameter packs and function parameter packs are
2918 // treated like DeclRefExpr cursors.
2919 continue;
2920 }
2921
2922 case VisitorJob::LambdaExprPartsKind: {
2923 // Visit captures.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002924 const LambdaExpr *E = cast<LambdaExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002925 for (LambdaExpr::capture_iterator C = E->explicit_capture_begin(),
2926 CEnd = E->explicit_capture_end();
2927 C != CEnd; ++C) {
Richard Smithba71c082013-05-16 06:20:58 +00002928 // FIXME: Lambda init-captures.
2929 if (!C->capturesVariable())
Guy Benyei11169dd2012-12-18 14:30:41 +00002930 continue;
Richard Smithba71c082013-05-16 06:20:58 +00002931
Guy Benyei11169dd2012-12-18 14:30:41 +00002932 if (Visit(MakeCursorVariableRef(C->getCapturedVar(),
2933 C->getLocation(),
2934 TU)))
2935 return true;
2936 }
2937
2938 // Visit parameters and return type, if present.
2939 if (E->hasExplicitParameters() || E->hasExplicitResultType()) {
2940 TypeLoc TL = E->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
2941 if (E->hasExplicitParameters() && E->hasExplicitResultType()) {
2942 // Visit the whole type.
2943 if (Visit(TL))
2944 return true;
David Blaikie6adc78e2013-02-18 22:06:02 +00002945 } else if (FunctionProtoTypeLoc Proto =
2946 TL.getAs<FunctionProtoTypeLoc>()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002947 if (E->hasExplicitParameters()) {
2948 // Visit parameters.
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00002949 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I)
2950 if (Visit(MakeCXCursor(Proto.getParam(I), TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00002951 return true;
2952 } else {
2953 // Visit result type.
Alp Toker42a16a62014-01-25 23:51:36 +00002954 if (Visit(Proto.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00002955 return true;
2956 }
2957 }
2958 }
2959 break;
2960 }
2961
2962 case VisitorJob::PostChildrenVisitKind:
2963 if (PostChildrenVisitor(Parent, ClientData))
2964 return true;
2965 break;
2966 }
2967 }
2968 return false;
2969}
2970
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002971bool CursorVisitor::Visit(const Stmt *S) {
Craig Topper69186e72014-06-08 08:38:04 +00002972 VisitorWorkList *WL = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002973 if (!WorkListFreeList.empty()) {
2974 WL = WorkListFreeList.back();
2975 WL->clear();
2976 WorkListFreeList.pop_back();
2977 }
2978 else {
2979 WL = new VisitorWorkList();
2980 WorkListCache.push_back(WL);
2981 }
2982 EnqueueWorkList(*WL, S);
2983 bool result = RunVisitorWorkList(*WL);
2984 WorkListFreeList.push_back(WL);
2985 return result;
2986}
2987
2988namespace {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002989typedef SmallVector<SourceRange, 4> RefNamePieces;
James Y Knight04ec5bf2015-12-24 02:59:37 +00002990RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
2991 const DeclarationNameInfo &NI, SourceRange QLoc,
2992 const SourceRange *TemplateArgsLoc = nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002993 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
2994 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
2995 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
2996
2997 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
2998
2999 RefNamePieces Pieces;
3000
3001 if (WantQualifier && QLoc.isValid())
3002 Pieces.push_back(QLoc);
3003
3004 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
3005 Pieces.push_back(NI.getLoc());
James Y Knight04ec5bf2015-12-24 02:59:37 +00003006
3007 if (WantTemplateArgs && TemplateArgsLoc && TemplateArgsLoc->isValid())
3008 Pieces.push_back(*TemplateArgsLoc);
3009
Guy Benyei11169dd2012-12-18 14:30:41 +00003010 if (Kind == DeclarationName::CXXOperatorName) {
3011 Pieces.push_back(SourceLocation::getFromRawEncoding(
3012 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
3013 Pieces.push_back(SourceLocation::getFromRawEncoding(
3014 NI.getInfo().CXXOperatorName.EndOpNameLoc));
3015 }
3016
3017 if (WantSinglePiece) {
3018 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
3019 Pieces.clear();
3020 Pieces.push_back(R);
3021 }
3022
3023 return Pieces;
3024}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003025}
Guy Benyei11169dd2012-12-18 14:30:41 +00003026
3027//===----------------------------------------------------------------------===//
3028// Misc. API hooks.
3029//===----------------------------------------------------------------------===//
3030
Chad Rosier05c71aa2013-03-27 18:28:23 +00003031static void fatal_error_handler(void *user_data, const std::string& reason,
3032 bool gen_crash_diag) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003033 // Write the result out to stderr avoiding errs() because raw_ostreams can
3034 // call report_fatal_error.
3035 fprintf(stderr, "LIBCLANG FATAL ERROR: %s\n", reason.c_str());
3036 ::abort();
3037}
3038
Chandler Carruth66660742014-06-27 16:37:27 +00003039namespace {
3040struct RegisterFatalErrorHandler {
3041 RegisterFatalErrorHandler() {
3042 llvm::install_fatal_error_handler(fatal_error_handler, nullptr);
3043 }
3044};
3045}
3046
3047static llvm::ManagedStatic<RegisterFatalErrorHandler> RegisterFatalErrorHandlerOnce;
3048
Guy Benyei11169dd2012-12-18 14:30:41 +00003049extern "C" {
3050CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
3051 int displayDiagnostics) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003052 // We use crash recovery to make some of our APIs more reliable, implicitly
3053 // enable it.
Argyrios Kyrtzidis3701f542013-11-27 08:58:09 +00003054 if (!getenv("LIBCLANG_DISABLE_CRASH_RECOVERY"))
3055 llvm::CrashRecoveryContext::Enable();
Guy Benyei11169dd2012-12-18 14:30:41 +00003056
Chandler Carruth66660742014-06-27 16:37:27 +00003057 // Look through the managed static to trigger construction of the managed
3058 // static which registers our fatal error handler. This ensures it is only
3059 // registered once.
3060 (void)*RegisterFatalErrorHandlerOnce;
Guy Benyei11169dd2012-12-18 14:30:41 +00003061
Adrian Prantlbc068582015-07-08 01:00:30 +00003062 // Initialize targets for clang module support.
3063 llvm::InitializeAllTargets();
3064 llvm::InitializeAllTargetMCs();
3065 llvm::InitializeAllAsmPrinters();
3066 llvm::InitializeAllAsmParsers();
3067
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003068 CIndexer *CIdxr = new CIndexer();
3069
Guy Benyei11169dd2012-12-18 14:30:41 +00003070 if (excludeDeclarationsFromPCH)
3071 CIdxr->setOnlyLocalDecls();
3072 if (displayDiagnostics)
3073 CIdxr->setDisplayDiagnostics();
3074
3075 if (getenv("LIBCLANG_BGPRIO_INDEX"))
3076 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3077 CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
3078 if (getenv("LIBCLANG_BGPRIO_EDIT"))
3079 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3080 CXGlobalOpt_ThreadBackgroundPriorityForEditing);
3081
3082 return CIdxr;
3083}
3084
3085void clang_disposeIndex(CXIndex CIdx) {
3086 if (CIdx)
3087 delete static_cast<CIndexer *>(CIdx);
3088}
3089
3090void clang_CXIndex_setGlobalOptions(CXIndex CIdx, unsigned options) {
3091 if (CIdx)
3092 static_cast<CIndexer *>(CIdx)->setCXGlobalOptFlags(options);
3093}
3094
3095unsigned clang_CXIndex_getGlobalOptions(CXIndex CIdx) {
3096 if (CIdx)
3097 return static_cast<CIndexer *>(CIdx)->getCXGlobalOptFlags();
3098 return 0;
3099}
3100
3101void clang_toggleCrashRecovery(unsigned isEnabled) {
3102 if (isEnabled)
3103 llvm::CrashRecoveryContext::Enable();
3104 else
3105 llvm::CrashRecoveryContext::Disable();
3106}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003107
Guy Benyei11169dd2012-12-18 14:30:41 +00003108CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
3109 const char *ast_filename) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003110 CXTranslationUnit TU;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003111 enum CXErrorCode Result =
3112 clang_createTranslationUnit2(CIdx, ast_filename, &TU);
Reid Klecknerfd48fc62014-02-12 23:56:20 +00003113 (void)Result;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003114 assert((TU && Result == CXError_Success) ||
3115 (!TU && Result != CXError_Success));
3116 return TU;
3117}
3118
3119enum CXErrorCode clang_createTranslationUnit2(CXIndex CIdx,
3120 const char *ast_filename,
3121 CXTranslationUnit *out_TU) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003122 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003123 *out_TU = nullptr;
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003124
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003125 if (!CIdx || !ast_filename || !out_TU)
3126 return CXError_InvalidArguments;
Guy Benyei11169dd2012-12-18 14:30:41 +00003127
Argyrios Kyrtzidis27021012013-05-24 22:24:07 +00003128 LOG_FUNC_SECTION {
3129 *Log << ast_filename;
3130 }
3131
Guy Benyei11169dd2012-12-18 14:30:41 +00003132 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3133 FileSystemOptions FileSystemOpts;
3134
Justin Bognerd512c1e2014-10-15 00:33:06 +00003135 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
3136 CompilerInstance::createDiagnostics(new DiagnosticOptions());
David Blaikie6f7382d2014-08-10 19:08:04 +00003137 std::unique_ptr<ASTUnit> AU = ASTUnit::LoadFromASTFile(
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003138 ast_filename, CXXIdx->getPCHContainerOperations()->getRawReader(), Diags,
Adrian Prantl6b21ab22015-08-27 19:46:20 +00003139 FileSystemOpts, /*UseDebugInfo=*/false,
3140 CXXIdx->getOnlyLocalDecls(), None,
David Blaikie6f7382d2014-08-10 19:08:04 +00003141 /*CaptureDiagnostics=*/true,
3142 /*AllowPCHWithCompilerErrors=*/true,
3143 /*UserFilesAreVolatile=*/true);
3144 *out_TU = MakeCXTranslationUnit(CXXIdx, AU.release());
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003145 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003146}
3147
3148unsigned clang_defaultEditingTranslationUnitOptions() {
3149 return CXTranslationUnit_PrecompiledPreamble |
3150 CXTranslationUnit_CacheCompletionResults;
3151}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003152
Guy Benyei11169dd2012-12-18 14:30:41 +00003153CXTranslationUnit
3154clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
3155 const char *source_filename,
3156 int num_command_line_args,
3157 const char * const *command_line_args,
3158 unsigned num_unsaved_files,
3159 struct CXUnsavedFile *unsaved_files) {
3160 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord;
3161 return clang_parseTranslationUnit(CIdx, source_filename,
3162 command_line_args, num_command_line_args,
3163 unsaved_files, num_unsaved_files,
3164 Options);
3165}
3166
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003167static CXErrorCode
3168clang_parseTranslationUnit_Impl(CXIndex CIdx, const char *source_filename,
3169 const char *const *command_line_args,
3170 int num_command_line_args,
3171 ArrayRef<CXUnsavedFile> unsaved_files,
3172 unsigned options, CXTranslationUnit *out_TU) {
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003173 // Set up the initial return values.
3174 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003175 *out_TU = nullptr;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003176
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003177 // Check arguments.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003178 if (!CIdx || !out_TU)
3179 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003180
Guy Benyei11169dd2012-12-18 14:30:41 +00003181 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3182
3183 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3184 setThreadBackgroundPriority();
3185
3186 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003187 bool CreatePreambleOnFirstParse =
3188 options & CXTranslationUnit_CreatePreambleOnFirstParse;
Guy Benyei11169dd2012-12-18 14:30:41 +00003189 // FIXME: Add a flag for modules.
3190 TranslationUnitKind TUKind
3191 = (options & CXTranslationUnit_Incomplete)? TU_Prefix : TU_Complete;
Alp Toker8c8a8752013-12-03 06:53:35 +00003192 bool CacheCodeCompletionResults
Guy Benyei11169dd2012-12-18 14:30:41 +00003193 = options & CXTranslationUnit_CacheCompletionResults;
3194 bool IncludeBriefCommentsInCodeCompletion
3195 = options & CXTranslationUnit_IncludeBriefCommentsInCodeCompletion;
3196 bool SkipFunctionBodies = options & CXTranslationUnit_SkipFunctionBodies;
3197 bool ForSerialization = options & CXTranslationUnit_ForSerialization;
3198
3199 // Configure the diagnostics.
3200 IntrusiveRefCntPtr<DiagnosticsEngine>
Sean Silvaf1b49e22013-01-20 01:58:28 +00003201 Diags(CompilerInstance::createDiagnostics(new DiagnosticOptions));
Guy Benyei11169dd2012-12-18 14:30:41 +00003202
Manuel Klimek016c0242016-03-01 10:56:19 +00003203 if (options & CXTranslationUnit_KeepGoing)
3204 Diags->setFatalsAsError(true);
3205
Guy Benyei11169dd2012-12-18 14:30:41 +00003206 // Recover resources if we crash before exiting this function.
3207 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
3208 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Alp Tokerf994cef2014-07-05 03:08:06 +00003209 DiagCleanup(Diags.get());
Guy Benyei11169dd2012-12-18 14:30:41 +00003210
Ahmed Charlesb8984322014-03-07 20:03:18 +00003211 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3212 new std::vector<ASTUnit::RemappedFile>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003213
3214 // Recover resources if we crash before exiting this function.
3215 llvm::CrashRecoveryContextCleanupRegistrar<
3216 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3217
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003218 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003219 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003220 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003221 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003222 }
3223
Ahmed Charlesb8984322014-03-07 20:03:18 +00003224 std::unique_ptr<std::vector<const char *>> Args(
3225 new std::vector<const char *>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003226
3227 // Recover resources if we crash before exiting this method.
3228 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
3229 ArgsCleanup(Args.get());
3230
3231 // Since the Clang C library is primarily used by batch tools dealing with
3232 // (often very broken) source code, where spell-checking can have a
3233 // significant negative impact on performance (particularly when
3234 // precompiled headers are involved), we disable it by default.
3235 // Only do this if we haven't found a spell-checking-related argument.
3236 bool FoundSpellCheckingArgument = false;
3237 for (int I = 0; I != num_command_line_args; ++I) {
3238 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
3239 strcmp(command_line_args[I], "-fspell-checking") == 0) {
3240 FoundSpellCheckingArgument = true;
3241 break;
3242 }
3243 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003244 Args->insert(Args->end(), command_line_args,
3245 command_line_args + num_command_line_args);
3246
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003247 if (!FoundSpellCheckingArgument)
3248 Args->insert(Args->begin() + 1, "-fno-spell-checking");
3249
Guy Benyei11169dd2012-12-18 14:30:41 +00003250 // The 'source_filename' argument is optional. If the caller does not
3251 // specify it then it is assumed that the source file is specified
3252 // in the actual argument list.
3253 // Put the source file after command_line_args otherwise if '-x' flag is
3254 // present it will be unused.
3255 if (source_filename)
3256 Args->push_back(source_filename);
3257
3258 // Do we need the detailed preprocessing record?
3259 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
3260 Args->push_back("-Xclang");
3261 Args->push_back("-detailed-preprocessing-record");
3262 }
3263
3264 unsigned NumErrors = Diags->getClient()->getNumErrors();
Ahmed Charlesb8984322014-03-07 20:03:18 +00003265 std::unique_ptr<ASTUnit> ErrUnit;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003266 // Unless the user specified that they want the preamble on the first parse
3267 // set it up to be created on the first reparse. This makes the first parse
3268 // faster, trading for a slower (first) reparse.
3269 unsigned PrecompilePreambleAfterNParses =
3270 !PrecompilePreamble ? 0 : 2 - CreatePreambleOnFirstParse;
Ahmed Charlesb8984322014-03-07 20:03:18 +00003271 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCommandLine(
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003272 Args->data(), Args->data() + Args->size(),
3273 CXXIdx->getPCHContainerOperations(), Diags,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003274 CXXIdx->getClangResourcesPath(), CXXIdx->getOnlyLocalDecls(),
3275 /*CaptureDiagnostics=*/true, *RemappedFiles.get(),
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003276 /*RemappedFilesKeepOriginalName=*/true, PrecompilePreambleAfterNParses,
3277 TUKind, CacheCodeCompletionResults, IncludeBriefCommentsInCodeCompletion,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003278 /*AllowPCHWithCompilerErrors=*/true, SkipFunctionBodies,
Argyrios Kyrtzidisa3e2ff12015-11-20 03:36:21 +00003279 /*UserFilesAreVolatile=*/true, ForSerialization,
3280 CXXIdx->getPCHContainerOperations()->getRawReader().getFormat(),
3281 &ErrUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003282
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003283 // Early failures in LoadFromCommandLine may return with ErrUnit unset.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003284 if (!Unit && !ErrUnit)
3285 return CXError_ASTReadError;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003286
Guy Benyei11169dd2012-12-18 14:30:41 +00003287 if (NumErrors != Diags->getClient()->getNumErrors()) {
3288 // Make sure to check that 'Unit' is non-NULL.
3289 if (CXXIdx->getDisplayDiagnostics())
3290 printDiagsToStderr(Unit ? Unit.get() : ErrUnit.get());
3291 }
3292
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003293 if (isASTReadError(Unit ? Unit.get() : ErrUnit.get()))
3294 return CXError_ASTReadError;
3295
3296 *out_TU = MakeCXTranslationUnit(CXXIdx, Unit.release());
3297 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003298}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003299
3300CXTranslationUnit
3301clang_parseTranslationUnit(CXIndex CIdx,
3302 const char *source_filename,
3303 const char *const *command_line_args,
3304 int num_command_line_args,
3305 struct CXUnsavedFile *unsaved_files,
3306 unsigned num_unsaved_files,
3307 unsigned options) {
3308 CXTranslationUnit TU;
3309 enum CXErrorCode Result = clang_parseTranslationUnit2(
3310 CIdx, source_filename, command_line_args, num_command_line_args,
3311 unsaved_files, num_unsaved_files, options, &TU);
Reid Kleckner6eaf05a2014-02-13 01:19:59 +00003312 (void)Result;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003313 assert((TU && Result == CXError_Success) ||
3314 (!TU && Result != CXError_Success));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003315 return TU;
3316}
3317
3318enum CXErrorCode clang_parseTranslationUnit2(
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003319 CXIndex CIdx, const char *source_filename,
3320 const char *const *command_line_args, int num_command_line_args,
3321 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3322 unsigned options, CXTranslationUnit *out_TU) {
3323 SmallVector<const char *, 4> Args;
3324 Args.push_back("clang");
3325 Args.append(command_line_args, command_line_args + num_command_line_args);
3326 return clang_parseTranslationUnit2FullArgv(
3327 CIdx, source_filename, Args.data(), Args.size(), unsaved_files,
3328 num_unsaved_files, options, out_TU);
3329}
3330
3331enum CXErrorCode clang_parseTranslationUnit2FullArgv(
3332 CXIndex CIdx, const char *source_filename,
3333 const char *const *command_line_args, int num_command_line_args,
3334 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3335 unsigned options, CXTranslationUnit *out_TU) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003336 LOG_FUNC_SECTION {
3337 *Log << source_filename << ": ";
3338 for (int i = 0; i != num_command_line_args; ++i)
3339 *Log << command_line_args[i] << " ";
3340 }
3341
Alp Toker9d85b182014-07-07 01:23:14 +00003342 if (num_unsaved_files && !unsaved_files)
3343 return CXError_InvalidArguments;
3344
Alp Toker5c532982014-07-07 22:42:03 +00003345 CXErrorCode result = CXError_Failure;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003346 auto ParseTranslationUnitImpl = [=, &result] {
3347 result = clang_parseTranslationUnit_Impl(
3348 CIdx, source_filename, command_line_args, num_command_line_args,
3349 llvm::makeArrayRef(unsaved_files, num_unsaved_files), options, out_TU);
3350 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003351 llvm::CrashRecoveryContext CRC;
3352
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003353 if (!RunSafely(CRC, ParseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003354 fprintf(stderr, "libclang: crash detected during parsing: {\n");
3355 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
3356 fprintf(stderr, " 'command_line_args' : [");
3357 for (int i = 0; i != num_command_line_args; ++i) {
3358 if (i)
3359 fprintf(stderr, ", ");
3360 fprintf(stderr, "'%s'", command_line_args[i]);
3361 }
3362 fprintf(stderr, "],\n");
3363 fprintf(stderr, " 'unsaved_files' : [");
3364 for (unsigned i = 0; i != num_unsaved_files; ++i) {
3365 if (i)
3366 fprintf(stderr, ", ");
3367 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
3368 unsaved_files[i].Length);
3369 }
3370 fprintf(stderr, "],\n");
3371 fprintf(stderr, " 'options' : %d,\n", options);
3372 fprintf(stderr, "}\n");
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003373
3374 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003375 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003376 if (CXTranslationUnit *TU = out_TU)
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003377 PrintLibclangResourceUsage(*TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003378 }
Alp Toker5c532982014-07-07 22:42:03 +00003379
3380 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003381}
3382
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003383CXString clang_Type_getObjCEncoding(CXType CT) {
3384 CXTranslationUnit tu = static_cast<CXTranslationUnit>(CT.data[1]);
3385 ASTContext &Ctx = getASTUnit(tu)->getASTContext();
3386 std::string encoding;
3387 Ctx.getObjCEncodingForType(QualType::getFromOpaquePtr(CT.data[0]),
3388 encoding);
3389
3390 return cxstring::createDup(encoding);
3391}
3392
3393static const IdentifierInfo *getMacroIdentifier(CXCursor C) {
3394 if (C.kind == CXCursor_MacroDefinition) {
3395 if (const MacroDefinitionRecord *MDR = getCursorMacroDefinition(C))
3396 return MDR->getName();
3397 } else if (C.kind == CXCursor_MacroExpansion) {
3398 MacroExpansionCursor ME = getCursorMacroExpansion(C);
3399 return ME.getName();
3400 }
3401 return nullptr;
3402}
3403
3404unsigned clang_Cursor_isMacroFunctionLike(CXCursor C) {
3405 const IdentifierInfo *II = getMacroIdentifier(C);
3406 if (!II) {
3407 return false;
3408 }
3409 ASTUnit *ASTU = getCursorASTUnit(C);
3410 Preprocessor &PP = ASTU->getPreprocessor();
3411 if (const MacroInfo *MI = PP.getMacroInfo(II))
3412 return MI->isFunctionLike();
3413 return false;
3414}
3415
3416unsigned clang_Cursor_isMacroBuiltin(CXCursor C) {
3417 const IdentifierInfo *II = getMacroIdentifier(C);
3418 if (!II) {
3419 return false;
3420 }
3421 ASTUnit *ASTU = getCursorASTUnit(C);
3422 Preprocessor &PP = ASTU->getPreprocessor();
3423 if (const MacroInfo *MI = PP.getMacroInfo(II))
3424 return MI->isBuiltinMacro();
3425 return false;
3426}
3427
3428unsigned clang_Cursor_isFunctionInlined(CXCursor C) {
3429 const Decl *D = getCursorDecl(C);
3430 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
3431 if (!FD) {
3432 return false;
3433 }
3434 return FD->isInlined();
3435}
3436
3437static StringLiteral* getCFSTR_value(CallExpr *callExpr) {
3438 if (callExpr->getNumArgs() != 1) {
3439 return nullptr;
3440 }
3441
3442 StringLiteral *S = nullptr;
3443 auto *arg = callExpr->getArg(0);
3444 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
3445 ImplicitCastExpr *I = static_cast<ImplicitCastExpr *>(arg);
3446 auto *subExpr = I->getSubExprAsWritten();
3447
3448 if(subExpr->getStmtClass() != Stmt::StringLiteralClass){
3449 return nullptr;
3450 }
3451
3452 S = static_cast<StringLiteral *>(I->getSubExprAsWritten());
3453 } else if (arg->getStmtClass() == Stmt::StringLiteralClass) {
3454 S = static_cast<StringLiteral *>(callExpr->getArg(0));
3455 } else {
3456 return nullptr;
3457 }
3458 return S;
3459}
3460
David Blaikie59272572016-04-13 18:23:33 +00003461struct ExprEvalResult {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003462 CXEvalResultKind EvalType;
3463 union {
3464 int intVal;
3465 double floatVal;
3466 char *stringVal;
3467 } EvalData;
David Blaikie59272572016-04-13 18:23:33 +00003468 ~ExprEvalResult() {
3469 if (EvalType != CXEval_UnExposed && EvalType != CXEval_Float &&
3470 EvalType != CXEval_Int) {
3471 delete EvalData.stringVal;
3472 }
3473 }
3474};
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003475
3476void clang_EvalResult_dispose(CXEvalResult E) {
David Blaikie59272572016-04-13 18:23:33 +00003477 delete static_cast<ExprEvalResult *>(E);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003478}
3479
3480CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E) {
3481 if (!E) {
3482 return CXEval_UnExposed;
3483 }
3484 return ((ExprEvalResult *)E)->EvalType;
3485}
3486
3487int clang_EvalResult_getAsInt(CXEvalResult E) {
3488 if (!E) {
3489 return 0;
3490 }
3491 return ((ExprEvalResult *)E)->EvalData.intVal;
3492}
3493
3494double clang_EvalResult_getAsDouble(CXEvalResult E) {
3495 if (!E) {
3496 return 0;
3497 }
3498 return ((ExprEvalResult *)E)->EvalData.floatVal;
3499}
3500
3501const char* clang_EvalResult_getAsStr(CXEvalResult E) {
3502 if (!E) {
3503 return nullptr;
3504 }
3505 return ((ExprEvalResult *)E)->EvalData.stringVal;
3506}
3507
3508static const ExprEvalResult* evaluateExpr(Expr *expr, CXCursor C) {
3509 Expr::EvalResult ER;
3510 ASTContext &ctx = getCursorContext(C);
David Blaikiebbc00882016-04-13 18:36:19 +00003511 if (!expr)
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003512 return nullptr;
David Blaikiebbc00882016-04-13 18:36:19 +00003513
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003514 expr = expr->IgnoreParens();
David Blaikiebbc00882016-04-13 18:36:19 +00003515 if (!expr->EvaluateAsRValue(ER, ctx))
3516 return nullptr;
3517
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003518 QualType rettype;
3519 CallExpr *callExpr;
David Blaikie59272572016-04-13 18:23:33 +00003520 auto result = llvm::make_unique<ExprEvalResult>();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003521 result->EvalType = CXEval_UnExposed;
3522
David Blaikiebbc00882016-04-13 18:36:19 +00003523 if (ER.Val.isInt()) {
3524 result->EvalType = CXEval_Int;
3525 result->EvalData.intVal = ER.Val.getInt().getExtValue();
3526 return result.release();
3527 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003528
David Blaikiebbc00882016-04-13 18:36:19 +00003529 if (ER.Val.isFloat()) {
3530 llvm::SmallVector<char, 100> Buffer;
3531 ER.Val.getFloat().toString(Buffer);
3532 std::string floatStr(Buffer.data(), Buffer.size());
3533 result->EvalType = CXEval_Float;
3534 bool ignored;
3535 llvm::APFloat apFloat = ER.Val.getFloat();
3536 apFloat.convert(llvm::APFloat::IEEEdouble,
3537 llvm::APFloat::rmNearestTiesToEven, &ignored);
3538 result->EvalData.floatVal = apFloat.convertToDouble();
3539 return result.release();
3540 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003541
David Blaikiebbc00882016-04-13 18:36:19 +00003542 if (expr->getStmtClass() == Stmt::ImplicitCastExprClass) {
3543 const ImplicitCastExpr *I = dyn_cast<ImplicitCastExpr>(expr);
3544 auto *subExpr = I->getSubExprAsWritten();
3545 if (subExpr->getStmtClass() == Stmt::StringLiteralClass ||
3546 subExpr->getStmtClass() == Stmt::ObjCStringLiteralClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003547 const StringLiteral *StrE = nullptr;
3548 const ObjCStringLiteral *ObjCExpr;
David Blaikiebbc00882016-04-13 18:36:19 +00003549 ObjCExpr = dyn_cast<ObjCStringLiteral>(subExpr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003550
3551 if (ObjCExpr) {
3552 StrE = ObjCExpr->getString();
3553 result->EvalType = CXEval_ObjCStrLiteral;
3554 } else {
David Blaikiebbc00882016-04-13 18:36:19 +00003555 StrE = cast<StringLiteral>(I->getSubExprAsWritten());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003556 result->EvalType = CXEval_StrLiteral;
3557 }
3558
3559 std::string strRef(StrE->getString().str());
David Blaikie59272572016-04-13 18:23:33 +00003560 result->EvalData.stringVal = new char[strRef.size() + 1];
David Blaikiebbc00882016-04-13 18:36:19 +00003561 strncpy((char *)result->EvalData.stringVal, strRef.c_str(),
3562 strRef.size());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003563 result->EvalData.stringVal[strRef.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003564 return result.release();
David Blaikiebbc00882016-04-13 18:36:19 +00003565 }
3566 } else if (expr->getStmtClass() == Stmt::ObjCStringLiteralClass ||
3567 expr->getStmtClass() == Stmt::StringLiteralClass) {
3568 const StringLiteral *StrE = nullptr;
3569 const ObjCStringLiteral *ObjCExpr;
3570 ObjCExpr = dyn_cast<ObjCStringLiteral>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003571
David Blaikiebbc00882016-04-13 18:36:19 +00003572 if (ObjCExpr) {
3573 StrE = ObjCExpr->getString();
3574 result->EvalType = CXEval_ObjCStrLiteral;
3575 } else {
3576 StrE = cast<StringLiteral>(expr);
3577 result->EvalType = CXEval_StrLiteral;
3578 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003579
David Blaikiebbc00882016-04-13 18:36:19 +00003580 std::string strRef(StrE->getString().str());
3581 result->EvalData.stringVal = new char[strRef.size() + 1];
3582 strncpy((char *)result->EvalData.stringVal, strRef.c_str(), strRef.size());
3583 result->EvalData.stringVal[strRef.size()] = '\0';
3584 return result.release();
3585 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003586
David Blaikiebbc00882016-04-13 18:36:19 +00003587 if (expr->getStmtClass() == Stmt::CStyleCastExprClass) {
3588 CStyleCastExpr *CC = static_cast<CStyleCastExpr *>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003589
David Blaikiebbc00882016-04-13 18:36:19 +00003590 rettype = CC->getType();
3591 if (rettype.getAsString() == "CFStringRef" &&
3592 CC->getSubExpr()->getStmtClass() == Stmt::CallExprClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003593
David Blaikiebbc00882016-04-13 18:36:19 +00003594 callExpr = static_cast<CallExpr *>(CC->getSubExpr());
3595 StringLiteral *S = getCFSTR_value(callExpr);
3596 if (S) {
3597 std::string strLiteral(S->getString().str());
3598 result->EvalType = CXEval_CFStr;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003599
David Blaikiebbc00882016-04-13 18:36:19 +00003600 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3601 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3602 strLiteral.size());
3603 result->EvalData.stringVal[strLiteral.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003604 return result.release();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003605 }
3606 }
3607
David Blaikiebbc00882016-04-13 18:36:19 +00003608 } else if (expr->getStmtClass() == Stmt::CallExprClass) {
3609 callExpr = static_cast<CallExpr *>(expr);
3610 rettype = callExpr->getCallReturnType(ctx);
3611
3612 if (rettype->isVectorType() || callExpr->getNumArgs() > 1)
3613 return nullptr;
3614
3615 if (rettype->isIntegralType(ctx) || rettype->isRealFloatingType()) {
3616 if (callExpr->getNumArgs() == 1 &&
3617 !callExpr->getArg(0)->getType()->isIntegralType(ctx))
3618 return nullptr;
3619 } else if (rettype.getAsString() == "CFStringRef") {
3620
3621 StringLiteral *S = getCFSTR_value(callExpr);
3622 if (S) {
3623 std::string strLiteral(S->getString().str());
3624 result->EvalType = CXEval_CFStr;
3625 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3626 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3627 strLiteral.size());
3628 result->EvalData.stringVal[strLiteral.size()] = '\0';
3629 return result.release();
3630 }
3631 }
3632 } else if (expr->getStmtClass() == Stmt::DeclRefExprClass) {
3633 DeclRefExpr *D = static_cast<DeclRefExpr *>(expr);
3634 ValueDecl *V = D->getDecl();
3635 if (V->getKind() == Decl::Function) {
3636 std::string strName = V->getNameAsString();
3637 result->EvalType = CXEval_Other;
3638 result->EvalData.stringVal = new char[strName.size() + 1];
3639 strncpy(result->EvalData.stringVal, strName.c_str(), strName.size());
3640 result->EvalData.stringVal[strName.size()] = '\0';
3641 return result.release();
3642 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003643 }
3644
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003645 return nullptr;
3646}
3647
3648CXEvalResult clang_Cursor_Evaluate(CXCursor C) {
3649 const Decl *D = getCursorDecl(C);
3650 if (D) {
3651 const Expr *expr = nullptr;
3652 if (auto *Var = dyn_cast<VarDecl>(D)) {
3653 expr = Var->getInit();
3654 } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3655 expr = Field->getInClassInitializer();
3656 }
3657 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003658 return const_cast<CXEvalResult>(reinterpret_cast<const void *>(
3659 evaluateExpr(const_cast<Expr *>(expr), C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003660 return nullptr;
3661 }
3662
3663 const CompoundStmt *compoundStmt = dyn_cast_or_null<CompoundStmt>(getCursorStmt(C));
3664 if (compoundStmt) {
3665 Expr *expr = nullptr;
3666 for (auto *bodyIterator : compoundStmt->body()) {
3667 if ((expr = dyn_cast<Expr>(bodyIterator))) {
3668 break;
3669 }
3670 }
3671 if (expr)
Aaron Ballman01dc1572016-01-20 15:25:30 +00003672 return const_cast<CXEvalResult>(
3673 reinterpret_cast<const void *>(evaluateExpr(expr, C)));
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003674 }
3675 return nullptr;
3676}
3677
3678unsigned clang_Cursor_hasAttrs(CXCursor C) {
3679 const Decl *D = getCursorDecl(C);
3680 if (!D) {
3681 return 0;
3682 }
3683
3684 if (D->hasAttrs()) {
3685 return 1;
3686 }
3687
3688 return 0;
3689}
Guy Benyei11169dd2012-12-18 14:30:41 +00003690unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
3691 return CXSaveTranslationUnit_None;
3692}
3693
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003694static CXSaveError clang_saveTranslationUnit_Impl(CXTranslationUnit TU,
3695 const char *FileName,
3696 unsigned options) {
3697 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003698 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3699 setThreadBackgroundPriority();
3700
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003701 bool hadError = cxtu::getASTUnit(TU)->Save(FileName);
3702 return hadError ? CXSaveError_Unknown : CXSaveError_None;
Guy Benyei11169dd2012-12-18 14:30:41 +00003703}
3704
3705int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
3706 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003707 LOG_FUNC_SECTION {
3708 *Log << TU << ' ' << FileName;
3709 }
3710
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003711 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003712 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003713 return CXSaveError_InvalidTU;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003714 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003715
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003716 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003717 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3718 if (!CXXUnit->hasSema())
3719 return CXSaveError_InvalidTU;
3720
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003721 CXSaveError result;
3722 auto SaveTranslationUnitImpl = [=, &result]() {
3723 result = clang_saveTranslationUnit_Impl(TU, FileName, options);
3724 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003725
3726 if (!CXXUnit->getDiagnostics().hasUnrecoverableErrorOccurred() ||
3727 getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003728 SaveTranslationUnitImpl();
Guy Benyei11169dd2012-12-18 14:30:41 +00003729
3730 if (getenv("LIBCLANG_RESOURCE_USAGE"))
3731 PrintLibclangResourceUsage(TU);
3732
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003733 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003734 }
3735
3736 // We have an AST that has invalid nodes due to compiler errors.
3737 // Use a crash recovery thread for protection.
3738
3739 llvm::CrashRecoveryContext CRC;
3740
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003741 if (!RunSafely(CRC, SaveTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003742 fprintf(stderr, "libclang: crash detected during AST saving: {\n");
3743 fprintf(stderr, " 'filename' : '%s'\n", FileName);
3744 fprintf(stderr, " 'options' : %d,\n", options);
3745 fprintf(stderr, "}\n");
3746
3747 return CXSaveError_Unknown;
3748
3749 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3750 PrintLibclangResourceUsage(TU);
3751 }
3752
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003753 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003754}
3755
3756void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
3757 if (CTUnit) {
3758 // If the translation unit has been marked as unsafe to free, just discard
3759 // it.
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003760 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
3761 if (Unit && Unit->isUnsafeToFree())
Guy Benyei11169dd2012-12-18 14:30:41 +00003762 return;
3763
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003764 delete cxtu::getASTUnit(CTUnit);
Dmitri Gribenkob95b3f12013-01-26 22:44:19 +00003765 delete CTUnit->StringPool;
Guy Benyei11169dd2012-12-18 14:30:41 +00003766 delete static_cast<CXDiagnosticSetImpl *>(CTUnit->Diagnostics);
3767 disposeOverridenCXCursorsPool(CTUnit->OverridenCursorsPool);
Dmitri Gribenko9e605112013-11-13 22:16:51 +00003768 delete CTUnit->CommentToXML;
Guy Benyei11169dd2012-12-18 14:30:41 +00003769 delete CTUnit;
3770 }
3771}
3772
3773unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
3774 return CXReparse_None;
3775}
3776
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003777static CXErrorCode
3778clang_reparseTranslationUnit_Impl(CXTranslationUnit TU,
3779 ArrayRef<CXUnsavedFile> unsaved_files,
3780 unsigned options) {
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003781 // Check arguments.
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003782 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003783 LOG_BAD_TU(TU);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003784 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003785 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003786
3787 // Reset the associated diagnostics.
3788 delete static_cast<CXDiagnosticSetImpl*>(TU->Diagnostics);
Craig Topper69186e72014-06-08 08:38:04 +00003789 TU->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003790
Dmitri Gribenko183436e2013-01-26 21:49:50 +00003791 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003792 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
3793 setThreadBackgroundPriority();
3794
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003795 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003796 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ahmed Charlesb8984322014-03-07 20:03:18 +00003797
3798 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3799 new std::vector<ASTUnit::RemappedFile>());
3800
Guy Benyei11169dd2012-12-18 14:30:41 +00003801 // Recover resources if we crash before exiting this function.
3802 llvm::CrashRecoveryContextCleanupRegistrar<
3803 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
Alp Toker9d85b182014-07-07 01:23:14 +00003804
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003805 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003806 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003807 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003808 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003809 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003810
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003811 if (!CXXUnit->Reparse(CXXIdx->getPCHContainerOperations(),
3812 *RemappedFiles.get()))
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003813 return CXError_Success;
3814 if (isASTReadError(CXXUnit))
3815 return CXError_ASTReadError;
3816 return CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003817}
3818
3819int clang_reparseTranslationUnit(CXTranslationUnit TU,
3820 unsigned num_unsaved_files,
3821 struct CXUnsavedFile *unsaved_files,
3822 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003823 LOG_FUNC_SECTION {
3824 *Log << TU;
3825 }
3826
Alp Toker9d85b182014-07-07 01:23:14 +00003827 if (num_unsaved_files && !unsaved_files)
3828 return CXError_InvalidArguments;
3829
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003830 CXErrorCode result;
3831 auto ReparseTranslationUnitImpl = [=, &result]() {
3832 result = clang_reparseTranslationUnit_Impl(
3833 TU, llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
3834 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003835
3836 if (getenv("LIBCLANG_NOTHREADS")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003837 ReparseTranslationUnitImpl();
Alp Toker5c532982014-07-07 22:42:03 +00003838 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003839 }
3840
3841 llvm::CrashRecoveryContext CRC;
3842
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003843 if (!RunSafely(CRC, ReparseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003844 fprintf(stderr, "libclang: crash detected during reparsing\n");
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003845 cxtu::getASTUnit(TU)->setUnsafeToFree(true);
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003846 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003847 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
3848 PrintLibclangResourceUsage(TU);
3849
Alp Toker5c532982014-07-07 22:42:03 +00003850 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003851}
3852
3853
3854CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003855 if (isNotUsableTU(CTUnit)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003856 LOG_BAD_TU(CTUnit);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00003857 return cxstring::createEmpty();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003858 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003859
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003860 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00003861 return cxstring::createDup(CXXUnit->getOriginalSourceFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00003862}
3863
3864CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003865 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003866 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00003867 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003868 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00003869
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003870 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003871 return MakeCXCursor(CXXUnit->getASTContext().getTranslationUnitDecl(), TU);
3872}
3873
3874} // end: extern "C"
3875
3876//===----------------------------------------------------------------------===//
3877// CXFile Operations.
3878//===----------------------------------------------------------------------===//
3879
3880extern "C" {
3881CXString clang_getFileName(CXFile SFile) {
3882 if (!SFile)
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00003883 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00003884
3885 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00003886 return cxstring::createRef(FEnt->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00003887}
3888
3889time_t clang_getFileTime(CXFile SFile) {
3890 if (!SFile)
3891 return 0;
3892
3893 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
3894 return FEnt->getModificationTime();
3895}
3896
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003897CXFile clang_getFile(CXTranslationUnit TU, const char *file_name) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003898 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003899 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00003900 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003901 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003902
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003903 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003904
3905 FileManager &FMgr = CXXUnit->getFileManager();
3906 return const_cast<FileEntry *>(FMgr.getFile(file_name));
3907}
3908
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003909unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit TU,
3910 CXFile file) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003911 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003912 LOG_BAD_TU(TU);
3913 return 0;
3914 }
3915
3916 if (!file)
Guy Benyei11169dd2012-12-18 14:30:41 +00003917 return 0;
3918
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003919 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003920 FileEntry *FEnt = static_cast<FileEntry *>(file);
3921 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
3922 .isFileMultipleIncludeGuarded(FEnt);
3923}
3924
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003925int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID) {
3926 if (!file || !outID)
3927 return 1;
3928
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003929 FileEntry *FEnt = static_cast<FileEntry *>(file);
Rafael Espindolaf8f91b82013-08-01 21:42:11 +00003930 const llvm::sys::fs::UniqueID &ID = FEnt->getUniqueID();
3931 outID->data[0] = ID.getDevice();
3932 outID->data[1] = ID.getFile();
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003933 outID->data[2] = FEnt->getModificationTime();
3934 return 0;
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00003935}
3936
Argyrios Kyrtzidisac3997e2014-08-16 00:26:19 +00003937int clang_File_isEqual(CXFile file1, CXFile file2) {
3938 if (file1 == file2)
3939 return true;
3940
3941 if (!file1 || !file2)
3942 return false;
3943
3944 FileEntry *FEnt1 = static_cast<FileEntry *>(file1);
3945 FileEntry *FEnt2 = static_cast<FileEntry *>(file2);
3946 return FEnt1->getUniqueID() == FEnt2->getUniqueID();
3947}
3948
Guy Benyei11169dd2012-12-18 14:30:41 +00003949} // end: extern "C"
3950
3951//===----------------------------------------------------------------------===//
3952// CXCursor Operations.
3953//===----------------------------------------------------------------------===//
3954
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003955static const Decl *getDeclFromExpr(const Stmt *E) {
3956 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003957 return getDeclFromExpr(CE->getSubExpr());
3958
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003959 if (const DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003960 return RefExpr->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003961 if (const MemberExpr *ME = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003962 return ME->getMemberDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003963 if (const ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003964 return RE->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003965 if (const ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003966 if (PRE->isExplicitProperty())
3967 return PRE->getExplicitProperty();
3968 // It could be messaging both getter and setter as in:
3969 // ++myobj.myprop;
3970 // in which case prefer to associate the setter since it is less obvious
3971 // from inspecting the source that the setter is going to get called.
3972 if (PRE->isMessagingSetter())
3973 return PRE->getImplicitPropertySetter();
3974 return PRE->getImplicitPropertyGetter();
3975 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003976 if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003977 return getDeclFromExpr(POE->getSyntacticForm());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003978 if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003979 if (Expr *Src = OVE->getSourceExpr())
3980 return getDeclFromExpr(Src);
3981
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003982 if (const CallExpr *CE = dyn_cast<CallExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003983 return getDeclFromExpr(CE->getCallee());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003984 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003985 if (!CE->isElidable())
3986 return CE->getConstructor();
Richard Smith5179eb72016-06-28 19:03:57 +00003987 if (const CXXInheritedCtorInitExpr *CE =
3988 dyn_cast<CXXInheritedCtorInitExpr>(E))
3989 return CE->getConstructor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003990 if (const ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003991 return OME->getMethodDecl();
3992
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003993 if (const ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003994 return PE->getProtocol();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003995 if (const SubstNonTypeTemplateParmPackExpr *NTTP
Guy Benyei11169dd2012-12-18 14:30:41 +00003996 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
3997 return NTTP->getParameterPack();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00003998 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00003999 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
4000 isa<ParmVarDecl>(SizeOfPack->getPack()))
4001 return SizeOfPack->getPack();
Craig Topper69186e72014-06-08 08:38:04 +00004002
4003 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004004}
4005
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004006static SourceLocation getLocationFromExpr(const Expr *E) {
4007 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004008 return getLocationFromExpr(CE->getSubExpr());
4009
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004010 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004011 return /*FIXME:*/Msg->getLeftLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004012 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004013 return DRE->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004014 if (const MemberExpr *Member = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004015 return Member->getMemberLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004016 if (const ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004017 return Ivar->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004018 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004019 return SizeOfPack->getPackLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004020 if (const ObjCPropertyRefExpr *PropRef = dyn_cast<ObjCPropertyRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004021 return PropRef->getLocation();
4022
4023 return E->getLocStart();
4024}
4025
4026extern "C" {
4027
4028unsigned clang_visitChildren(CXCursor parent,
4029 CXCursorVisitor visitor,
4030 CXClientData client_data) {
4031 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
4032 /*VisitPreprocessorLast=*/false);
4033 return CursorVis.VisitChildren(parent);
4034}
4035
4036#ifndef __has_feature
4037#define __has_feature(x) 0
4038#endif
4039#if __has_feature(blocks)
4040typedef enum CXChildVisitResult
4041 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
4042
4043static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4044 CXClientData client_data) {
4045 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4046 return block(cursor, parent);
4047}
4048#else
4049// If we are compiled with a compiler that doesn't have native blocks support,
4050// define and call the block manually, so the
4051typedef struct _CXChildVisitResult
4052{
4053 void *isa;
4054 int flags;
4055 int reserved;
4056 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
4057 CXCursor);
4058} *CXCursorVisitorBlock;
4059
4060static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4061 CXClientData client_data) {
4062 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4063 return block->invoke(block, cursor, parent);
4064}
4065#endif
4066
4067
4068unsigned clang_visitChildrenWithBlock(CXCursor parent,
4069 CXCursorVisitorBlock block) {
4070 return clang_visitChildren(parent, visitWithBlock, block);
4071}
4072
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004073static CXString getDeclSpelling(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004074 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004075 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004076
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004077 const NamedDecl *ND = dyn_cast<NamedDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004078 if (!ND) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004079 if (const ObjCPropertyImplDecl *PropImpl =
4080 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004081 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004082 return cxstring::createDup(Property->getIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004083
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004084 if (const ImportDecl *ImportD = dyn_cast<ImportDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004085 if (Module *Mod = ImportD->getImportedModule())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004086 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004087
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004088 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004089 }
4090
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004091 if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004092 return cxstring::createDup(OMD->getSelector().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004093
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004094 if (const ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Guy Benyei11169dd2012-12-18 14:30:41 +00004095 // No, this isn't the same as the code below. getIdentifier() is non-virtual
4096 // and returns different names. NamedDecl returns the class name and
4097 // ObjCCategoryImplDecl returns the category name.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004098 return cxstring::createRef(CIMP->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004099
4100 if (isa<UsingDirectiveDecl>(D))
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004101 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004102
4103 SmallString<1024> S;
4104 llvm::raw_svector_ostream os(S);
4105 ND->printName(os);
4106
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004107 return cxstring::createDup(os.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004108}
4109
4110CXString clang_getCursorSpelling(CXCursor C) {
4111 if (clang_isTranslationUnit(C.kind))
Dmitri Gribenko2c173b42013-01-11 19:28:44 +00004112 return clang_getTranslationUnitSpelling(getCursorTU(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004113
4114 if (clang_isReference(C.kind)) {
4115 switch (C.kind) {
4116 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004117 const ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004118 return cxstring::createRef(Super->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004119 }
4120 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004121 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004122 return cxstring::createRef(Class->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004123 }
4124 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004125 const ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004126 assert(OID && "getCursorSpelling(): Missing protocol decl");
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004127 return cxstring::createRef(OID->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004128 }
4129 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004130 const CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004131 return cxstring::createDup(B->getType().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004132 }
4133 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004134 const TypeDecl *Type = getCursorTypeRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004135 assert(Type && "Missing type decl");
4136
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004137 return cxstring::createDup(getCursorContext(C).getTypeDeclType(Type).
Guy Benyei11169dd2012-12-18 14:30:41 +00004138 getAsString());
4139 }
4140 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004141 const TemplateDecl *Template = getCursorTemplateRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004142 assert(Template && "Missing template decl");
4143
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004144 return cxstring::createDup(Template->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004145 }
4146
4147 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004148 const NamedDecl *NS = getCursorNamespaceRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004149 assert(NS && "Missing namespace decl");
4150
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004151 return cxstring::createDup(NS->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004152 }
4153
4154 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004155 const FieldDecl *Field = getCursorMemberRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004156 assert(Field && "Missing member decl");
4157
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004158 return cxstring::createDup(Field->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004159 }
4160
4161 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004162 const LabelStmt *Label = getCursorLabelRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004163 assert(Label && "Missing label");
4164
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004165 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004166 }
4167
4168 case CXCursor_OverloadedDeclRef: {
4169 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004170 if (const Decl *D = Storage.dyn_cast<const Decl *>()) {
4171 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004172 return cxstring::createDup(ND->getNameAsString());
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004173 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004174 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004175 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004176 return cxstring::createDup(E->getName().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004177 OverloadedTemplateStorage *Ovl
4178 = Storage.get<OverloadedTemplateStorage*>();
4179 if (Ovl->size() == 0)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004180 return cxstring::createEmpty();
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004181 return cxstring::createDup((*Ovl->begin())->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004182 }
4183
4184 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004185 const VarDecl *Var = getCursorVariableRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004186 assert(Var && "Missing variable decl");
4187
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004188 return cxstring::createDup(Var->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004189 }
4190
4191 default:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004192 return cxstring::createRef("<not implemented>");
Guy Benyei11169dd2012-12-18 14:30:41 +00004193 }
4194 }
4195
4196 if (clang_isExpression(C.kind)) {
Argyrios Kyrtzidis3227d862014-03-03 19:40:52 +00004197 const Expr *E = getCursorExpr(C);
4198
4199 if (C.kind == CXCursor_ObjCStringLiteral ||
4200 C.kind == CXCursor_StringLiteral) {
4201 const StringLiteral *SLit;
4202 if (const ObjCStringLiteral *OSL = dyn_cast<ObjCStringLiteral>(E)) {
4203 SLit = OSL->getString();
4204 } else {
4205 SLit = cast<StringLiteral>(E);
4206 }
4207 SmallString<256> Buf;
4208 llvm::raw_svector_ostream OS(Buf);
4209 SLit->outputString(OS);
4210 return cxstring::createDup(OS.str());
4211 }
4212
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004213 const Decl *D = getDeclFromExpr(getCursorExpr(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004214 if (D)
4215 return getDeclSpelling(D);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004216 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004217 }
4218
4219 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004220 const Stmt *S = getCursorStmt(C);
4221 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004222 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004223
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004224 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004225 }
4226
4227 if (C.kind == CXCursor_MacroExpansion)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004228 return cxstring::createRef(getCursorMacroExpansion(C).getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004229 ->getNameStart());
4230
4231 if (C.kind == CXCursor_MacroDefinition)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004232 return cxstring::createRef(getCursorMacroDefinition(C)->getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004233 ->getNameStart());
4234
4235 if (C.kind == CXCursor_InclusionDirective)
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004236 return cxstring::createDup(getCursorInclusionDirective(C)->getFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004237
4238 if (clang_isDeclaration(C.kind))
4239 return getDeclSpelling(getCursorDecl(C));
4240
4241 if (C.kind == CXCursor_AnnotateAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004242 const AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004243 return cxstring::createDup(AA->getAnnotation());
Guy Benyei11169dd2012-12-18 14:30:41 +00004244 }
4245
4246 if (C.kind == CXCursor_AsmLabelAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004247 const AsmLabelAttr *AA = cast<AsmLabelAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004248 return cxstring::createDup(AA->getLabel());
Guy Benyei11169dd2012-12-18 14:30:41 +00004249 }
4250
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004251 if (C.kind == CXCursor_PackedAttr) {
4252 return cxstring::createRef("packed");
4253 }
4254
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004255 if (C.kind == CXCursor_VisibilityAttr) {
4256 const VisibilityAttr *AA = cast<VisibilityAttr>(cxcursor::getCursorAttr(C));
4257 switch (AA->getVisibility()) {
4258 case VisibilityAttr::VisibilityType::Default:
4259 return cxstring::createRef("default");
4260 case VisibilityAttr::VisibilityType::Hidden:
4261 return cxstring::createRef("hidden");
4262 case VisibilityAttr::VisibilityType::Protected:
4263 return cxstring::createRef("protected");
4264 }
4265 llvm_unreachable("unknown visibility type");
4266 }
4267
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004268 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004269}
4270
4271CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor C,
4272 unsigned pieceIndex,
4273 unsigned options) {
4274 if (clang_Cursor_isNull(C))
4275 return clang_getNullRange();
4276
4277 ASTContext &Ctx = getCursorContext(C);
4278
4279 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004280 const Stmt *S = getCursorStmt(C);
4281 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004282 if (pieceIndex > 0)
4283 return clang_getNullRange();
4284 return cxloc::translateSourceRange(Ctx, Label->getIdentLoc());
4285 }
4286
4287 return clang_getNullRange();
4288 }
4289
4290 if (C.kind == CXCursor_ObjCMessageExpr) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004291 if (const ObjCMessageExpr *
Guy Benyei11169dd2012-12-18 14:30:41 +00004292 ME = dyn_cast_or_null<ObjCMessageExpr>(getCursorExpr(C))) {
4293 if (pieceIndex >= ME->getNumSelectorLocs())
4294 return clang_getNullRange();
4295 return cxloc::translateSourceRange(Ctx, ME->getSelectorLoc(pieceIndex));
4296 }
4297 }
4298
4299 if (C.kind == CXCursor_ObjCInstanceMethodDecl ||
4300 C.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004301 if (const ObjCMethodDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004302 MD = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(C))) {
4303 if (pieceIndex >= MD->getNumSelectorLocs())
4304 return clang_getNullRange();
4305 return cxloc::translateSourceRange(Ctx, MD->getSelectorLoc(pieceIndex));
4306 }
4307 }
4308
4309 if (C.kind == CXCursor_ObjCCategoryDecl ||
4310 C.kind == CXCursor_ObjCCategoryImplDecl) {
4311 if (pieceIndex > 0)
4312 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004313 if (const ObjCCategoryDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004314 CD = dyn_cast_or_null<ObjCCategoryDecl>(getCursorDecl(C)))
4315 return cxloc::translateSourceRange(Ctx, CD->getCategoryNameLoc());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004316 if (const ObjCCategoryImplDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004317 CID = dyn_cast_or_null<ObjCCategoryImplDecl>(getCursorDecl(C)))
4318 return cxloc::translateSourceRange(Ctx, CID->getCategoryNameLoc());
4319 }
4320
4321 if (C.kind == CXCursor_ModuleImportDecl) {
4322 if (pieceIndex > 0)
4323 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004324 if (const ImportDecl *ImportD =
4325 dyn_cast_or_null<ImportDecl>(getCursorDecl(C))) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004326 ArrayRef<SourceLocation> Locs = ImportD->getIdentifierLocs();
4327 if (!Locs.empty())
4328 return cxloc::translateSourceRange(Ctx,
4329 SourceRange(Locs.front(), Locs.back()));
4330 }
4331 return clang_getNullRange();
4332 }
4333
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004334 if (C.kind == CXCursor_CXXMethod || C.kind == CXCursor_Destructor ||
4335 C.kind == CXCursor_ConversionFunction) {
4336 if (pieceIndex > 0)
4337 return clang_getNullRange();
4338 if (const FunctionDecl *FD =
4339 dyn_cast_or_null<FunctionDecl>(getCursorDecl(C))) {
4340 DeclarationNameInfo FunctionName = FD->getNameInfo();
4341 return cxloc::translateSourceRange(Ctx, FunctionName.getSourceRange());
4342 }
4343 return clang_getNullRange();
4344 }
4345
Guy Benyei11169dd2012-12-18 14:30:41 +00004346 // FIXME: A CXCursor_InclusionDirective should give the location of the
4347 // filename, but we don't keep track of this.
4348
4349 // FIXME: A CXCursor_AnnotateAttr should give the location of the annotation
4350 // but we don't keep track of this.
4351
4352 // FIXME: A CXCursor_AsmLabelAttr should give the location of the label
4353 // but we don't keep track of this.
4354
4355 // Default handling, give the location of the cursor.
4356
4357 if (pieceIndex > 0)
4358 return clang_getNullRange();
4359
4360 CXSourceLocation CXLoc = clang_getCursorLocation(C);
4361 SourceLocation Loc = cxloc::translateSourceLocation(CXLoc);
4362 return cxloc::translateSourceRange(Ctx, Loc);
4363}
4364
Eli Bendersky44a206f2014-07-31 18:04:56 +00004365CXString clang_Cursor_getMangling(CXCursor C) {
4366 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4367 return cxstring::createEmpty();
4368
Eli Bendersky44a206f2014-07-31 18:04:56 +00004369 // Mangling only works for functions and variables.
Eli Bendersky79759592014-08-01 15:01:10 +00004370 const Decl *D = getCursorDecl(C);
Eli Bendersky44a206f2014-07-31 18:04:56 +00004371 if (!D || !(isa<FunctionDecl>(D) || isa<VarDecl>(D)))
4372 return cxstring::createEmpty();
4373
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004374 ASTContext &Ctx = D->getASTContext();
4375 index::CodegenNameGenerator CGNameGen(Ctx);
4376 return cxstring::createDup(CGNameGen.getName(D));
Eli Bendersky44a206f2014-07-31 18:04:56 +00004377}
4378
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004379CXStringSet *clang_Cursor_getCXXManglings(CXCursor C) {
4380 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4381 return nullptr;
4382
4383 const Decl *D = getCursorDecl(C);
4384 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
4385 return nullptr;
4386
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004387 ASTContext &Ctx = D->getASTContext();
4388 index::CodegenNameGenerator CGNameGen(Ctx);
4389 std::vector<std::string> Manglings = CGNameGen.getAllManglings(D);
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004390 return cxstring::createSet(Manglings);
4391}
4392
Guy Benyei11169dd2012-12-18 14:30:41 +00004393CXString clang_getCursorDisplayName(CXCursor C) {
4394 if (!clang_isDeclaration(C.kind))
4395 return clang_getCursorSpelling(C);
4396
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004397 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00004398 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004399 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004400
4401 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004402 if (const FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004403 D = FunTmpl->getTemplatedDecl();
4404
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004405 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004406 SmallString<64> Str;
4407 llvm::raw_svector_ostream OS(Str);
4408 OS << *Function;
4409 if (Function->getPrimaryTemplate())
4410 OS << "<>";
4411 OS << "(";
4412 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
4413 if (I)
4414 OS << ", ";
4415 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
4416 }
4417
4418 if (Function->isVariadic()) {
4419 if (Function->getNumParams())
4420 OS << ", ";
4421 OS << "...";
4422 }
4423 OS << ")";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004424 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004425 }
4426
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004427 if (const ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004428 SmallString<64> Str;
4429 llvm::raw_svector_ostream OS(Str);
4430 OS << *ClassTemplate;
4431 OS << "<";
4432 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
4433 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
4434 if (I)
4435 OS << ", ";
4436
4437 NamedDecl *Param = Params->getParam(I);
4438 if (Param->getIdentifier()) {
4439 OS << Param->getIdentifier()->getName();
4440 continue;
4441 }
4442
4443 // There is no parameter name, which makes this tricky. Try to come up
4444 // with something useful that isn't too long.
4445 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
4446 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
4447 else if (NonTypeTemplateParmDecl *NTTP
4448 = dyn_cast<NonTypeTemplateParmDecl>(Param))
4449 OS << NTTP->getType().getAsString(Policy);
4450 else
4451 OS << "template<...> class";
4452 }
4453
4454 OS << ">";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004455 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004456 }
4457
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004458 if (const ClassTemplateSpecializationDecl *ClassSpec
Guy Benyei11169dd2012-12-18 14:30:41 +00004459 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
4460 // If the type was explicitly written, use that.
4461 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004462 return cxstring::createDup(TSInfo->getType().getAsString(Policy));
Guy Benyei11169dd2012-12-18 14:30:41 +00004463
Benjamin Kramer9170e912013-02-22 15:46:01 +00004464 SmallString<128> Str;
Guy Benyei11169dd2012-12-18 14:30:41 +00004465 llvm::raw_svector_ostream OS(Str);
4466 OS << *ClassSpec;
David Majnemer6fbeee32016-07-07 04:43:07 +00004467 TemplateSpecializationType::PrintTemplateArgumentList(
4468 OS, ClassSpec->getTemplateArgs().asArray(), Policy);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004469 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004470 }
4471
4472 return clang_getCursorSpelling(C);
4473}
4474
4475CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
4476 switch (Kind) {
4477 case CXCursor_FunctionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004478 return cxstring::createRef("FunctionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004479 case CXCursor_TypedefDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004480 return cxstring::createRef("TypedefDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004481 case CXCursor_EnumDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004482 return cxstring::createRef("EnumDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004483 case CXCursor_EnumConstantDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004484 return cxstring::createRef("EnumConstantDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004485 case CXCursor_StructDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004486 return cxstring::createRef("StructDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004487 case CXCursor_UnionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004488 return cxstring::createRef("UnionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004489 case CXCursor_ClassDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004490 return cxstring::createRef("ClassDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004491 case CXCursor_FieldDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004492 return cxstring::createRef("FieldDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004493 case CXCursor_VarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004494 return cxstring::createRef("VarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004495 case CXCursor_ParmDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004496 return cxstring::createRef("ParmDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004497 case CXCursor_ObjCInterfaceDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004498 return cxstring::createRef("ObjCInterfaceDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004499 case CXCursor_ObjCCategoryDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004500 return cxstring::createRef("ObjCCategoryDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004501 case CXCursor_ObjCProtocolDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004502 return cxstring::createRef("ObjCProtocolDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004503 case CXCursor_ObjCPropertyDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004504 return cxstring::createRef("ObjCPropertyDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004505 case CXCursor_ObjCIvarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004506 return cxstring::createRef("ObjCIvarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004507 case CXCursor_ObjCInstanceMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004508 return cxstring::createRef("ObjCInstanceMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004509 case CXCursor_ObjCClassMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004510 return cxstring::createRef("ObjCClassMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004511 case CXCursor_ObjCImplementationDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004512 return cxstring::createRef("ObjCImplementationDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004513 case CXCursor_ObjCCategoryImplDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004514 return cxstring::createRef("ObjCCategoryImplDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004515 case CXCursor_CXXMethod:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004516 return cxstring::createRef("CXXMethod");
Guy Benyei11169dd2012-12-18 14:30:41 +00004517 case CXCursor_UnexposedDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004518 return cxstring::createRef("UnexposedDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004519 case CXCursor_ObjCSuperClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004520 return cxstring::createRef("ObjCSuperClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004521 case CXCursor_ObjCProtocolRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004522 return cxstring::createRef("ObjCProtocolRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004523 case CXCursor_ObjCClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004524 return cxstring::createRef("ObjCClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004525 case CXCursor_TypeRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004526 return cxstring::createRef("TypeRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004527 case CXCursor_TemplateRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004528 return cxstring::createRef("TemplateRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004529 case CXCursor_NamespaceRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004530 return cxstring::createRef("NamespaceRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004531 case CXCursor_MemberRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004532 return cxstring::createRef("MemberRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004533 case CXCursor_LabelRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004534 return cxstring::createRef("LabelRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004535 case CXCursor_OverloadedDeclRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004536 return cxstring::createRef("OverloadedDeclRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004537 case CXCursor_VariableRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004538 return cxstring::createRef("VariableRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00004539 case CXCursor_IntegerLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004540 return cxstring::createRef("IntegerLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004541 case CXCursor_FloatingLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004542 return cxstring::createRef("FloatingLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004543 case CXCursor_ImaginaryLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004544 return cxstring::createRef("ImaginaryLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004545 case CXCursor_StringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004546 return cxstring::createRef("StringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004547 case CXCursor_CharacterLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004548 return cxstring::createRef("CharacterLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004549 case CXCursor_ParenExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004550 return cxstring::createRef("ParenExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004551 case CXCursor_UnaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004552 return cxstring::createRef("UnaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004553 case CXCursor_ArraySubscriptExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004554 return cxstring::createRef("ArraySubscriptExpr");
Alexey Bataev1a3320e2015-08-25 14:24:04 +00004555 case CXCursor_OMPArraySectionExpr:
4556 return cxstring::createRef("OMPArraySectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004557 case CXCursor_BinaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004558 return cxstring::createRef("BinaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004559 case CXCursor_CompoundAssignOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004560 return cxstring::createRef("CompoundAssignOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004561 case CXCursor_ConditionalOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004562 return cxstring::createRef("ConditionalOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00004563 case CXCursor_CStyleCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004564 return cxstring::createRef("CStyleCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004565 case CXCursor_CompoundLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004566 return cxstring::createRef("CompoundLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004567 case CXCursor_InitListExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004568 return cxstring::createRef("InitListExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004569 case CXCursor_AddrLabelExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004570 return cxstring::createRef("AddrLabelExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004571 case CXCursor_StmtExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004572 return cxstring::createRef("StmtExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004573 case CXCursor_GenericSelectionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004574 return cxstring::createRef("GenericSelectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004575 case CXCursor_GNUNullExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004576 return cxstring::createRef("GNUNullExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004577 case CXCursor_CXXStaticCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004578 return cxstring::createRef("CXXStaticCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004579 case CXCursor_CXXDynamicCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004580 return cxstring::createRef("CXXDynamicCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004581 case CXCursor_CXXReinterpretCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004582 return cxstring::createRef("CXXReinterpretCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004583 case CXCursor_CXXConstCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004584 return cxstring::createRef("CXXConstCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004585 case CXCursor_CXXFunctionalCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004586 return cxstring::createRef("CXXFunctionalCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004587 case CXCursor_CXXTypeidExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004588 return cxstring::createRef("CXXTypeidExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004589 case CXCursor_CXXBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004590 return cxstring::createRef("CXXBoolLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004591 case CXCursor_CXXNullPtrLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004592 return cxstring::createRef("CXXNullPtrLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004593 case CXCursor_CXXThisExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004594 return cxstring::createRef("CXXThisExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004595 case CXCursor_CXXThrowExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004596 return cxstring::createRef("CXXThrowExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004597 case CXCursor_CXXNewExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004598 return cxstring::createRef("CXXNewExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004599 case CXCursor_CXXDeleteExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004600 return cxstring::createRef("CXXDeleteExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004601 case CXCursor_UnaryExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004602 return cxstring::createRef("UnaryExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004603 case CXCursor_ObjCStringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004604 return cxstring::createRef("ObjCStringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00004605 case CXCursor_ObjCBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004606 return cxstring::createRef("ObjCBoolLiteralExpr");
Argyrios Kyrtzidisc2233be2013-04-23 17:57:17 +00004607 case CXCursor_ObjCSelfExpr:
4608 return cxstring::createRef("ObjCSelfExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004609 case CXCursor_ObjCEncodeExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004610 return cxstring::createRef("ObjCEncodeExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004611 case CXCursor_ObjCSelectorExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004612 return cxstring::createRef("ObjCSelectorExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004613 case CXCursor_ObjCProtocolExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004614 return cxstring::createRef("ObjCProtocolExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004615 case CXCursor_ObjCBridgedCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004616 return cxstring::createRef("ObjCBridgedCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004617 case CXCursor_BlockExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004618 return cxstring::createRef("BlockExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004619 case CXCursor_PackExpansionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004620 return cxstring::createRef("PackExpansionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004621 case CXCursor_SizeOfPackExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004622 return cxstring::createRef("SizeOfPackExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004623 case CXCursor_LambdaExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004624 return cxstring::createRef("LambdaExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004625 case CXCursor_UnexposedExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004626 return cxstring::createRef("UnexposedExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004627 case CXCursor_DeclRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004628 return cxstring::createRef("DeclRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004629 case CXCursor_MemberRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004630 return cxstring::createRef("MemberRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004631 case CXCursor_CallExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004632 return cxstring::createRef("CallExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004633 case CXCursor_ObjCMessageExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004634 return cxstring::createRef("ObjCMessageExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004635 case CXCursor_UnexposedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004636 return cxstring::createRef("UnexposedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004637 case CXCursor_DeclStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004638 return cxstring::createRef("DeclStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004639 case CXCursor_LabelStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004640 return cxstring::createRef("LabelStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004641 case CXCursor_CompoundStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004642 return cxstring::createRef("CompoundStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004643 case CXCursor_CaseStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004644 return cxstring::createRef("CaseStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004645 case CXCursor_DefaultStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004646 return cxstring::createRef("DefaultStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004647 case CXCursor_IfStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004648 return cxstring::createRef("IfStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004649 case CXCursor_SwitchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004650 return cxstring::createRef("SwitchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004651 case CXCursor_WhileStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004652 return cxstring::createRef("WhileStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004653 case CXCursor_DoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004654 return cxstring::createRef("DoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004655 case CXCursor_ForStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004656 return cxstring::createRef("ForStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004657 case CXCursor_GotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004658 return cxstring::createRef("GotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004659 case CXCursor_IndirectGotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004660 return cxstring::createRef("IndirectGotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004661 case CXCursor_ContinueStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004662 return cxstring::createRef("ContinueStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004663 case CXCursor_BreakStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004664 return cxstring::createRef("BreakStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004665 case CXCursor_ReturnStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004666 return cxstring::createRef("ReturnStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004667 case CXCursor_GCCAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004668 return cxstring::createRef("GCCAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004669 case CXCursor_MSAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004670 return cxstring::createRef("MSAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004671 case CXCursor_ObjCAtTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004672 return cxstring::createRef("ObjCAtTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004673 case CXCursor_ObjCAtCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004674 return cxstring::createRef("ObjCAtCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004675 case CXCursor_ObjCAtFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004676 return cxstring::createRef("ObjCAtFinallyStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004677 case CXCursor_ObjCAtThrowStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004678 return cxstring::createRef("ObjCAtThrowStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004679 case CXCursor_ObjCAtSynchronizedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004680 return cxstring::createRef("ObjCAtSynchronizedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004681 case CXCursor_ObjCAutoreleasePoolStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004682 return cxstring::createRef("ObjCAutoreleasePoolStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004683 case CXCursor_ObjCForCollectionStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004684 return cxstring::createRef("ObjCForCollectionStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004685 case CXCursor_CXXCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004686 return cxstring::createRef("CXXCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004687 case CXCursor_CXXTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004688 return cxstring::createRef("CXXTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004689 case CXCursor_CXXForRangeStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004690 return cxstring::createRef("CXXForRangeStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004691 case CXCursor_SEHTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004692 return cxstring::createRef("SEHTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004693 case CXCursor_SEHExceptStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004694 return cxstring::createRef("SEHExceptStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004695 case CXCursor_SEHFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004696 return cxstring::createRef("SEHFinallyStmt");
Nico Weber9b982072014-07-07 00:12:30 +00004697 case CXCursor_SEHLeaveStmt:
4698 return cxstring::createRef("SEHLeaveStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004699 case CXCursor_NullStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004700 return cxstring::createRef("NullStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00004701 case CXCursor_InvalidFile:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004702 return cxstring::createRef("InvalidFile");
Guy Benyei11169dd2012-12-18 14:30:41 +00004703 case CXCursor_InvalidCode:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004704 return cxstring::createRef("InvalidCode");
Guy Benyei11169dd2012-12-18 14:30:41 +00004705 case CXCursor_NoDeclFound:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004706 return cxstring::createRef("NoDeclFound");
Guy Benyei11169dd2012-12-18 14:30:41 +00004707 case CXCursor_NotImplemented:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004708 return cxstring::createRef("NotImplemented");
Guy Benyei11169dd2012-12-18 14:30:41 +00004709 case CXCursor_TranslationUnit:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004710 return cxstring::createRef("TranslationUnit");
Guy Benyei11169dd2012-12-18 14:30:41 +00004711 case CXCursor_UnexposedAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004712 return cxstring::createRef("UnexposedAttr");
Guy Benyei11169dd2012-12-18 14:30:41 +00004713 case CXCursor_IBActionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004714 return cxstring::createRef("attribute(ibaction)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004715 case CXCursor_IBOutletAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004716 return cxstring::createRef("attribute(iboutlet)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004717 case CXCursor_IBOutletCollectionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004718 return cxstring::createRef("attribute(iboutletcollection)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004719 case CXCursor_CXXFinalAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004720 return cxstring::createRef("attribute(final)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004721 case CXCursor_CXXOverrideAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004722 return cxstring::createRef("attribute(override)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004723 case CXCursor_AnnotateAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004724 return cxstring::createRef("attribute(annotate)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004725 case CXCursor_AsmLabelAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004726 return cxstring::createRef("asm label");
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004727 case CXCursor_PackedAttr:
4728 return cxstring::createRef("attribute(packed)");
Joey Gouly81228382014-05-01 15:41:58 +00004729 case CXCursor_PureAttr:
4730 return cxstring::createRef("attribute(pure)");
4731 case CXCursor_ConstAttr:
4732 return cxstring::createRef("attribute(const)");
4733 case CXCursor_NoDuplicateAttr:
4734 return cxstring::createRef("attribute(noduplicate)");
Eli Bendersky2581e662014-05-28 19:29:58 +00004735 case CXCursor_CUDAConstantAttr:
4736 return cxstring::createRef("attribute(constant)");
4737 case CXCursor_CUDADeviceAttr:
4738 return cxstring::createRef("attribute(device)");
4739 case CXCursor_CUDAGlobalAttr:
4740 return cxstring::createRef("attribute(global)");
4741 case CXCursor_CUDAHostAttr:
4742 return cxstring::createRef("attribute(host)");
Eli Bendersky9b071472014-08-08 14:59:00 +00004743 case CXCursor_CUDASharedAttr:
4744 return cxstring::createRef("attribute(shared)");
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004745 case CXCursor_VisibilityAttr:
4746 return cxstring::createRef("attribute(visibility)");
Saleem Abdulrasool8aa0b802015-12-10 18:45:18 +00004747 case CXCursor_DLLExport:
4748 return cxstring::createRef("attribute(dllexport)");
4749 case CXCursor_DLLImport:
4750 return cxstring::createRef("attribute(dllimport)");
Guy Benyei11169dd2012-12-18 14:30:41 +00004751 case CXCursor_PreprocessingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004752 return cxstring::createRef("preprocessing directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004753 case CXCursor_MacroDefinition:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004754 return cxstring::createRef("macro definition");
Guy Benyei11169dd2012-12-18 14:30:41 +00004755 case CXCursor_MacroExpansion:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004756 return cxstring::createRef("macro expansion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004757 case CXCursor_InclusionDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004758 return cxstring::createRef("inclusion directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00004759 case CXCursor_Namespace:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004760 return cxstring::createRef("Namespace");
Guy Benyei11169dd2012-12-18 14:30:41 +00004761 case CXCursor_LinkageSpec:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004762 return cxstring::createRef("LinkageSpec");
Guy Benyei11169dd2012-12-18 14:30:41 +00004763 case CXCursor_CXXBaseSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004764 return cxstring::createRef("C++ base class specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00004765 case CXCursor_Constructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004766 return cxstring::createRef("CXXConstructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004767 case CXCursor_Destructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004768 return cxstring::createRef("CXXDestructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00004769 case CXCursor_ConversionFunction:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004770 return cxstring::createRef("CXXConversion");
Guy Benyei11169dd2012-12-18 14:30:41 +00004771 case CXCursor_TemplateTypeParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004772 return cxstring::createRef("TemplateTypeParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004773 case CXCursor_NonTypeTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004774 return cxstring::createRef("NonTypeTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004775 case CXCursor_TemplateTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004776 return cxstring::createRef("TemplateTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00004777 case CXCursor_FunctionTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004778 return cxstring::createRef("FunctionTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00004779 case CXCursor_ClassTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004780 return cxstring::createRef("ClassTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00004781 case CXCursor_ClassTemplatePartialSpecialization:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004782 return cxstring::createRef("ClassTemplatePartialSpecialization");
Guy Benyei11169dd2012-12-18 14:30:41 +00004783 case CXCursor_NamespaceAlias:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004784 return cxstring::createRef("NamespaceAlias");
Guy Benyei11169dd2012-12-18 14:30:41 +00004785 case CXCursor_UsingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004786 return cxstring::createRef("UsingDirective");
Guy Benyei11169dd2012-12-18 14:30:41 +00004787 case CXCursor_UsingDeclaration:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004788 return cxstring::createRef("UsingDeclaration");
Guy Benyei11169dd2012-12-18 14:30:41 +00004789 case CXCursor_TypeAliasDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004790 return cxstring::createRef("TypeAliasDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004791 case CXCursor_ObjCSynthesizeDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004792 return cxstring::createRef("ObjCSynthesizeDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004793 case CXCursor_ObjCDynamicDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004794 return cxstring::createRef("ObjCDynamicDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00004795 case CXCursor_CXXAccessSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004796 return cxstring::createRef("CXXAccessSpecifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00004797 case CXCursor_ModuleImportDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004798 return cxstring::createRef("ModuleImport");
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00004799 case CXCursor_OMPParallelDirective:
Alexey Bataev1b59ab52014-02-27 08:29:12 +00004800 return cxstring::createRef("OMPParallelDirective");
4801 case CXCursor_OMPSimdDirective:
4802 return cxstring::createRef("OMPSimdDirective");
Alexey Bataevf29276e2014-06-18 04:14:57 +00004803 case CXCursor_OMPForDirective:
4804 return cxstring::createRef("OMPForDirective");
Alexander Musmanf82886e2014-09-18 05:12:34 +00004805 case CXCursor_OMPForSimdDirective:
4806 return cxstring::createRef("OMPForSimdDirective");
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00004807 case CXCursor_OMPSectionsDirective:
4808 return cxstring::createRef("OMPSectionsDirective");
Alexey Bataev1e0498a2014-06-26 08:21:58 +00004809 case CXCursor_OMPSectionDirective:
4810 return cxstring::createRef("OMPSectionDirective");
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00004811 case CXCursor_OMPSingleDirective:
4812 return cxstring::createRef("OMPSingleDirective");
Alexander Musman80c22892014-07-17 08:54:58 +00004813 case CXCursor_OMPMasterDirective:
4814 return cxstring::createRef("OMPMasterDirective");
Alexander Musmand9ed09f2014-07-21 09:42:05 +00004815 case CXCursor_OMPCriticalDirective:
4816 return cxstring::createRef("OMPCriticalDirective");
Alexey Bataev4acb8592014-07-07 13:01:15 +00004817 case CXCursor_OMPParallelForDirective:
4818 return cxstring::createRef("OMPParallelForDirective");
Alexander Musmane4e893b2014-09-23 09:33:00 +00004819 case CXCursor_OMPParallelForSimdDirective:
4820 return cxstring::createRef("OMPParallelForSimdDirective");
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00004821 case CXCursor_OMPParallelSectionsDirective:
4822 return cxstring::createRef("OMPParallelSectionsDirective");
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00004823 case CXCursor_OMPTaskDirective:
4824 return cxstring::createRef("OMPTaskDirective");
Alexey Bataev68446b72014-07-18 07:47:19 +00004825 case CXCursor_OMPTaskyieldDirective:
4826 return cxstring::createRef("OMPTaskyieldDirective");
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00004827 case CXCursor_OMPBarrierDirective:
4828 return cxstring::createRef("OMPBarrierDirective");
Alexey Bataev2df347a2014-07-18 10:17:07 +00004829 case CXCursor_OMPTaskwaitDirective:
4830 return cxstring::createRef("OMPTaskwaitDirective");
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00004831 case CXCursor_OMPTaskgroupDirective:
4832 return cxstring::createRef("OMPTaskgroupDirective");
Alexey Bataev6125da92014-07-21 11:26:11 +00004833 case CXCursor_OMPFlushDirective:
4834 return cxstring::createRef("OMPFlushDirective");
Alexey Bataev9fb6e642014-07-22 06:45:04 +00004835 case CXCursor_OMPOrderedDirective:
4836 return cxstring::createRef("OMPOrderedDirective");
Alexey Bataev0162e452014-07-22 10:10:35 +00004837 case CXCursor_OMPAtomicDirective:
4838 return cxstring::createRef("OMPAtomicDirective");
Alexey Bataev0bd520b2014-09-19 08:19:49 +00004839 case CXCursor_OMPTargetDirective:
4840 return cxstring::createRef("OMPTargetDirective");
Michael Wong65f367f2015-07-21 13:44:28 +00004841 case CXCursor_OMPTargetDataDirective:
4842 return cxstring::createRef("OMPTargetDataDirective");
Samuel Antaodf67fc42016-01-19 19:15:56 +00004843 case CXCursor_OMPTargetEnterDataDirective:
4844 return cxstring::createRef("OMPTargetEnterDataDirective");
Samuel Antao72590762016-01-19 20:04:50 +00004845 case CXCursor_OMPTargetExitDataDirective:
4846 return cxstring::createRef("OMPTargetExitDataDirective");
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00004847 case CXCursor_OMPTargetParallelDirective:
4848 return cxstring::createRef("OMPTargetParallelDirective");
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00004849 case CXCursor_OMPTargetParallelForDirective:
4850 return cxstring::createRef("OMPTargetParallelForDirective");
Samuel Antao686c70c2016-05-26 17:30:50 +00004851 case CXCursor_OMPTargetUpdateDirective:
4852 return cxstring::createRef("OMPTargetUpdateDirective");
Alexey Bataev13314bf2014-10-09 04:18:56 +00004853 case CXCursor_OMPTeamsDirective:
4854 return cxstring::createRef("OMPTeamsDirective");
Alexey Bataev6d4ed052015-07-01 06:57:41 +00004855 case CXCursor_OMPCancellationPointDirective:
4856 return cxstring::createRef("OMPCancellationPointDirective");
Alexey Bataev80909872015-07-02 11:25:17 +00004857 case CXCursor_OMPCancelDirective:
4858 return cxstring::createRef("OMPCancelDirective");
Alexey Bataev49f6e782015-12-01 04:18:41 +00004859 case CXCursor_OMPTaskLoopDirective:
4860 return cxstring::createRef("OMPTaskLoopDirective");
Alexey Bataev0a6ed842015-12-03 09:40:15 +00004861 case CXCursor_OMPTaskLoopSimdDirective:
4862 return cxstring::createRef("OMPTaskLoopSimdDirective");
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00004863 case CXCursor_OMPDistributeDirective:
4864 return cxstring::createRef("OMPDistributeDirective");
Carlo Bertolli9925f152016-06-27 14:55:37 +00004865 case CXCursor_OMPDistributeParallelForDirective:
4866 return cxstring::createRef("OMPDistributeParallelForDirective");
Kelvin Li4a39add2016-07-05 05:00:15 +00004867 case CXCursor_OMPDistributeParallelForSimdDirective:
4868 return cxstring::createRef("OMPDistributeParallelForSimdDirective");
Kelvin Li787f3fc2016-07-06 04:45:38 +00004869 case CXCursor_OMPDistributeSimdDirective:
4870 return cxstring::createRef("OMPDistributeSimdDirective");
Francisco Lopes da Silva975a9f62015-01-21 16:24:11 +00004871 case CXCursor_OverloadCandidate:
4872 return cxstring::createRef("OverloadCandidate");
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +00004873 case CXCursor_TypeAliasTemplateDecl:
4874 return cxstring::createRef("TypeAliasTemplateDecl");
Olivier Goffart81978012016-06-09 16:15:55 +00004875 case CXCursor_StaticAssert:
4876 return cxstring::createRef("StaticAssert");
Guy Benyei11169dd2012-12-18 14:30:41 +00004877 }
4878
4879 llvm_unreachable("Unhandled CXCursorKind");
4880}
4881
4882struct GetCursorData {
4883 SourceLocation TokenBeginLoc;
4884 bool PointsAtMacroArgExpansion;
4885 bool VisitedObjCPropertyImplDecl;
4886 SourceLocation VisitedDeclaratorDeclStartLoc;
4887 CXCursor &BestCursor;
4888
4889 GetCursorData(SourceManager &SM,
4890 SourceLocation tokenBegin, CXCursor &outputCursor)
4891 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
4892 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
4893 VisitedObjCPropertyImplDecl = false;
4894 }
4895};
4896
4897static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
4898 CXCursor parent,
4899 CXClientData client_data) {
4900 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
4901 CXCursor *BestCursor = &Data->BestCursor;
4902
4903 // If we point inside a macro argument we should provide info of what the
4904 // token is so use the actual cursor, don't replace it with a macro expansion
4905 // cursor.
4906 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
4907 return CXChildVisit_Recurse;
4908
4909 if (clang_isDeclaration(cursor.kind)) {
4910 // Avoid having the implicit methods override the property decls.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004911 if (const ObjCMethodDecl *MD
Guy Benyei11169dd2012-12-18 14:30:41 +00004912 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
4913 if (MD->isImplicit())
4914 return CXChildVisit_Break;
4915
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004916 } else if (const ObjCInterfaceDecl *ID
Guy Benyei11169dd2012-12-18 14:30:41 +00004917 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(cursor))) {
4918 // Check that when we have multiple @class references in the same line,
4919 // that later ones do not override the previous ones.
4920 // If we have:
4921 // @class Foo, Bar;
4922 // source ranges for both start at '@', so 'Bar' will end up overriding
4923 // 'Foo' even though the cursor location was at 'Foo'.
4924 if (BestCursor->kind == CXCursor_ObjCInterfaceDecl ||
4925 BestCursor->kind == CXCursor_ObjCClassRef)
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004926 if (const ObjCInterfaceDecl *PrevID
Guy Benyei11169dd2012-12-18 14:30:41 +00004927 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(*BestCursor))){
4928 if (PrevID != ID &&
4929 !PrevID->isThisDeclarationADefinition() &&
4930 !ID->isThisDeclarationADefinition())
4931 return CXChildVisit_Break;
4932 }
4933
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004934 } else if (const DeclaratorDecl *DD
Guy Benyei11169dd2012-12-18 14:30:41 +00004935 = dyn_cast_or_null<DeclaratorDecl>(getCursorDecl(cursor))) {
4936 SourceLocation StartLoc = DD->getSourceRange().getBegin();
4937 // Check that when we have multiple declarators in the same line,
4938 // that later ones do not override the previous ones.
4939 // If we have:
4940 // int Foo, Bar;
4941 // source ranges for both start at 'int', so 'Bar' will end up overriding
4942 // 'Foo' even though the cursor location was at 'Foo'.
4943 if (Data->VisitedDeclaratorDeclStartLoc == StartLoc)
4944 return CXChildVisit_Break;
4945 Data->VisitedDeclaratorDeclStartLoc = StartLoc;
4946
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004947 } else if (const ObjCPropertyImplDecl *PropImp
Guy Benyei11169dd2012-12-18 14:30:41 +00004948 = dyn_cast_or_null<ObjCPropertyImplDecl>(getCursorDecl(cursor))) {
4949 (void)PropImp;
4950 // Check that when we have multiple @synthesize in the same line,
4951 // that later ones do not override the previous ones.
4952 // If we have:
4953 // @synthesize Foo, Bar;
4954 // source ranges for both start at '@', so 'Bar' will end up overriding
4955 // 'Foo' even though the cursor location was at 'Foo'.
4956 if (Data->VisitedObjCPropertyImplDecl)
4957 return CXChildVisit_Break;
4958 Data->VisitedObjCPropertyImplDecl = true;
4959 }
4960 }
4961
4962 if (clang_isExpression(cursor.kind) &&
4963 clang_isDeclaration(BestCursor->kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004964 if (const Decl *D = getCursorDecl(*BestCursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004965 // Avoid having the cursor of an expression replace the declaration cursor
4966 // when the expression source range overlaps the declaration range.
4967 // This can happen for C++ constructor expressions whose range generally
4968 // include the variable declaration, e.g.:
4969 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
4970 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
4971 D->getLocation() == Data->TokenBeginLoc)
4972 return CXChildVisit_Break;
4973 }
4974 }
4975
4976 // If our current best cursor is the construction of a temporary object,
4977 // don't replace that cursor with a type reference, because we want
4978 // clang_getCursor() to point at the constructor.
4979 if (clang_isExpression(BestCursor->kind) &&
4980 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
4981 cursor.kind == CXCursor_TypeRef) {
4982 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
4983 // as having the actual point on the type reference.
4984 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
4985 return CXChildVisit_Recurse;
4986 }
Douglas Gregore9d95f12015-07-07 03:57:35 +00004987
4988 // If we already have an Objective-C superclass reference, don't
4989 // update it further.
4990 if (BestCursor->kind == CXCursor_ObjCSuperClassRef)
4991 return CXChildVisit_Break;
4992
Guy Benyei11169dd2012-12-18 14:30:41 +00004993 *BestCursor = cursor;
4994 return CXChildVisit_Recurse;
4995}
4996
4997CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004998 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004999 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005000 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005001 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005002
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005003 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005004 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
5005
5006 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
5007 CXCursor Result = cxcursor::getCursor(TU, SLoc);
5008
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005009 LOG_FUNC_SECTION {
Guy Benyei11169dd2012-12-18 14:30:41 +00005010 CXFile SearchFile;
5011 unsigned SearchLine, SearchColumn;
5012 CXFile ResultFile;
5013 unsigned ResultLine, ResultColumn;
5014 CXString SearchFileName, ResultFileName, KindSpelling, USR;
5015 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
5016 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
Craig Topper69186e72014-06-08 08:38:04 +00005017
5018 clang_getFileLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
5019 nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005020 clang_getFileLocation(ResultLoc, &ResultFile, &ResultLine,
Craig Topper69186e72014-06-08 08:38:04 +00005021 &ResultColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005022 SearchFileName = clang_getFileName(SearchFile);
5023 ResultFileName = clang_getFileName(ResultFile);
5024 KindSpelling = clang_getCursorKindSpelling(Result.kind);
5025 USR = clang_getCursorUSR(Result);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005026 *Log << llvm::format("(%s:%d:%d) = %s",
5027 clang_getCString(SearchFileName), SearchLine, SearchColumn,
5028 clang_getCString(KindSpelling))
5029 << llvm::format("(%s:%d:%d):%s%s",
5030 clang_getCString(ResultFileName), ResultLine, ResultColumn,
5031 clang_getCString(USR), IsDef);
Guy Benyei11169dd2012-12-18 14:30:41 +00005032 clang_disposeString(SearchFileName);
5033 clang_disposeString(ResultFileName);
5034 clang_disposeString(KindSpelling);
5035 clang_disposeString(USR);
5036
5037 CXCursor Definition = clang_getCursorDefinition(Result);
5038 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
5039 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
5040 CXString DefinitionKindSpelling
5041 = clang_getCursorKindSpelling(Definition.kind);
5042 CXFile DefinitionFile;
5043 unsigned DefinitionLine, DefinitionColumn;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005044 clang_getFileLocation(DefinitionLoc, &DefinitionFile,
Craig Topper69186e72014-06-08 08:38:04 +00005045 &DefinitionLine, &DefinitionColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005046 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005047 *Log << llvm::format(" -> %s(%s:%d:%d)",
5048 clang_getCString(DefinitionKindSpelling),
5049 clang_getCString(DefinitionFileName),
5050 DefinitionLine, DefinitionColumn);
Guy Benyei11169dd2012-12-18 14:30:41 +00005051 clang_disposeString(DefinitionFileName);
5052 clang_disposeString(DefinitionKindSpelling);
5053 }
5054 }
5055
5056 return Result;
5057}
5058
5059CXCursor clang_getNullCursor(void) {
5060 return MakeCXCursorInvalid(CXCursor_InvalidFile);
5061}
5062
5063unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005064 // Clear out the "FirstInDeclGroup" part in a declaration cursor, since we
5065 // can't set consistently. For example, when visiting a DeclStmt we will set
5066 // it but we don't set it on the result of clang_getCursorDefinition for
5067 // a reference of the same declaration.
5068 // FIXME: Setting "FirstInDeclGroup" in CXCursors is a hack that only works
5069 // when visiting a DeclStmt currently, the AST should be enhanced to be able
5070 // to provide that kind of info.
5071 if (clang_isDeclaration(X.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005072 X.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005073 if (clang_isDeclaration(Y.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005074 Y.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005075
Guy Benyei11169dd2012-12-18 14:30:41 +00005076 return X == Y;
5077}
5078
5079unsigned clang_hashCursor(CXCursor C) {
5080 unsigned Index = 0;
5081 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
5082 Index = 1;
5083
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005084 return llvm::DenseMapInfo<std::pair<unsigned, const void*> >::getHashValue(
Guy Benyei11169dd2012-12-18 14:30:41 +00005085 std::make_pair(C.kind, C.data[Index]));
5086}
5087
5088unsigned clang_isInvalid(enum CXCursorKind K) {
5089 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
5090}
5091
5092unsigned clang_isDeclaration(enum CXCursorKind K) {
5093 return (K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl) ||
5094 (K >= CXCursor_FirstExtraDecl && K <= CXCursor_LastExtraDecl);
5095}
5096
5097unsigned clang_isReference(enum CXCursorKind K) {
5098 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
5099}
5100
5101unsigned clang_isExpression(enum CXCursorKind K) {
5102 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
5103}
5104
5105unsigned clang_isStatement(enum CXCursorKind K) {
5106 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
5107}
5108
5109unsigned clang_isAttribute(enum CXCursorKind K) {
5110 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
5111}
5112
5113unsigned clang_isTranslationUnit(enum CXCursorKind K) {
5114 return K == CXCursor_TranslationUnit;
5115}
5116
5117unsigned clang_isPreprocessing(enum CXCursorKind K) {
5118 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
5119}
5120
5121unsigned clang_isUnexposed(enum CXCursorKind K) {
5122 switch (K) {
5123 case CXCursor_UnexposedDecl:
5124 case CXCursor_UnexposedExpr:
5125 case CXCursor_UnexposedStmt:
5126 case CXCursor_UnexposedAttr:
5127 return true;
5128 default:
5129 return false;
5130 }
5131}
5132
5133CXCursorKind clang_getCursorKind(CXCursor C) {
5134 return C.kind;
5135}
5136
5137CXSourceLocation clang_getCursorLocation(CXCursor C) {
5138 if (clang_isReference(C.kind)) {
5139 switch (C.kind) {
5140 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005141 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005142 = getCursorObjCSuperClassRef(C);
5143 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5144 }
5145
5146 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005147 std::pair<const ObjCProtocolDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005148 = getCursorObjCProtocolRef(C);
5149 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5150 }
5151
5152 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005153 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005154 = getCursorObjCClassRef(C);
5155 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5156 }
5157
5158 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005159 std::pair<const TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005160 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5161 }
5162
5163 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005164 std::pair<const TemplateDecl *, SourceLocation> P =
5165 getCursorTemplateRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005166 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5167 }
5168
5169 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005170 std::pair<const NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005171 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5172 }
5173
5174 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005175 std::pair<const FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005176 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5177 }
5178
5179 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005180 std::pair<const VarDecl *, SourceLocation> P = getCursorVariableRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005181 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5182 }
5183
5184 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005185 const CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005186 if (!BaseSpec)
5187 return clang_getNullLocation();
5188
5189 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
5190 return cxloc::translateSourceLocation(getCursorContext(C),
5191 TSInfo->getTypeLoc().getBeginLoc());
5192
5193 return cxloc::translateSourceLocation(getCursorContext(C),
5194 BaseSpec->getLocStart());
5195 }
5196
5197 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005198 std::pair<const LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005199 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
5200 }
5201
5202 case CXCursor_OverloadedDeclRef:
5203 return cxloc::translateSourceLocation(getCursorContext(C),
5204 getCursorOverloadedDeclRef(C).second);
5205
5206 default:
5207 // FIXME: Need a way to enumerate all non-reference cases.
5208 llvm_unreachable("Missed a reference kind");
5209 }
5210 }
5211
5212 if (clang_isExpression(C.kind))
5213 return cxloc::translateSourceLocation(getCursorContext(C),
5214 getLocationFromExpr(getCursorExpr(C)));
5215
5216 if (clang_isStatement(C.kind))
5217 return cxloc::translateSourceLocation(getCursorContext(C),
5218 getCursorStmt(C)->getLocStart());
5219
5220 if (C.kind == CXCursor_PreprocessingDirective) {
5221 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
5222 return cxloc::translateSourceLocation(getCursorContext(C), L);
5223 }
5224
5225 if (C.kind == CXCursor_MacroExpansion) {
5226 SourceLocation L
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005227 = cxcursor::getCursorMacroExpansion(C).getSourceRange().getBegin();
Guy Benyei11169dd2012-12-18 14:30:41 +00005228 return cxloc::translateSourceLocation(getCursorContext(C), L);
5229 }
5230
5231 if (C.kind == CXCursor_MacroDefinition) {
5232 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
5233 return cxloc::translateSourceLocation(getCursorContext(C), L);
5234 }
5235
5236 if (C.kind == CXCursor_InclusionDirective) {
5237 SourceLocation L
5238 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
5239 return cxloc::translateSourceLocation(getCursorContext(C), L);
5240 }
5241
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00005242 if (clang_isAttribute(C.kind)) {
5243 SourceLocation L
5244 = cxcursor::getCursorAttr(C)->getLocation();
5245 return cxloc::translateSourceLocation(getCursorContext(C), L);
5246 }
5247
Guy Benyei11169dd2012-12-18 14:30:41 +00005248 if (!clang_isDeclaration(C.kind))
5249 return clang_getNullLocation();
5250
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005251 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005252 if (!D)
5253 return clang_getNullLocation();
5254
5255 SourceLocation Loc = D->getLocation();
5256 // FIXME: Multiple variables declared in a single declaration
5257 // currently lack the information needed to correctly determine their
5258 // ranges when accounting for the type-specifier. We use context
5259 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5260 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005261 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005262 if (!cxcursor::isFirstInDeclGroup(C))
5263 Loc = VD->getLocation();
5264 }
5265
5266 // For ObjC methods, give the start location of the method name.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005267 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005268 Loc = MD->getSelectorStartLoc();
5269
5270 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
5271}
5272
5273} // end extern "C"
5274
5275CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
5276 assert(TU);
5277
5278 // Guard against an invalid SourceLocation, or we may assert in one
5279 // of the following calls.
5280 if (SLoc.isInvalid())
5281 return clang_getNullCursor();
5282
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005283 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005284
5285 // Translate the given source location to make it point at the beginning of
5286 // the token under the cursor.
5287 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
5288 CXXUnit->getASTContext().getLangOpts());
5289
5290 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
5291 if (SLoc.isValid()) {
5292 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
5293 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
5294 /*VisitPreprocessorLast=*/true,
5295 /*VisitIncludedEntities=*/false,
5296 SourceLocation(SLoc));
5297 CursorVis.visitFileRegion();
5298 }
5299
5300 return Result;
5301}
5302
5303static SourceRange getRawCursorExtent(CXCursor C) {
5304 if (clang_isReference(C.kind)) {
5305 switch (C.kind) {
5306 case CXCursor_ObjCSuperClassRef:
5307 return getCursorObjCSuperClassRef(C).second;
5308
5309 case CXCursor_ObjCProtocolRef:
5310 return getCursorObjCProtocolRef(C).second;
5311
5312 case CXCursor_ObjCClassRef:
5313 return getCursorObjCClassRef(C).second;
5314
5315 case CXCursor_TypeRef:
5316 return getCursorTypeRef(C).second;
5317
5318 case CXCursor_TemplateRef:
5319 return getCursorTemplateRef(C).second;
5320
5321 case CXCursor_NamespaceRef:
5322 return getCursorNamespaceRef(C).second;
5323
5324 case CXCursor_MemberRef:
5325 return getCursorMemberRef(C).second;
5326
5327 case CXCursor_CXXBaseSpecifier:
5328 return getCursorCXXBaseSpecifier(C)->getSourceRange();
5329
5330 case CXCursor_LabelRef:
5331 return getCursorLabelRef(C).second;
5332
5333 case CXCursor_OverloadedDeclRef:
5334 return getCursorOverloadedDeclRef(C).second;
5335
5336 case CXCursor_VariableRef:
5337 return getCursorVariableRef(C).second;
5338
5339 default:
5340 // FIXME: Need a way to enumerate all non-reference cases.
5341 llvm_unreachable("Missed a reference kind");
5342 }
5343 }
5344
5345 if (clang_isExpression(C.kind))
5346 return getCursorExpr(C)->getSourceRange();
5347
5348 if (clang_isStatement(C.kind))
5349 return getCursorStmt(C)->getSourceRange();
5350
5351 if (clang_isAttribute(C.kind))
5352 return getCursorAttr(C)->getRange();
5353
5354 if (C.kind == CXCursor_PreprocessingDirective)
5355 return cxcursor::getCursorPreprocessingDirective(C);
5356
5357 if (C.kind == CXCursor_MacroExpansion) {
5358 ASTUnit *TU = getCursorASTUnit(C);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005359 SourceRange Range = cxcursor::getCursorMacroExpansion(C).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00005360 return TU->mapRangeFromPreamble(Range);
5361 }
5362
5363 if (C.kind == CXCursor_MacroDefinition) {
5364 ASTUnit *TU = getCursorASTUnit(C);
5365 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
5366 return TU->mapRangeFromPreamble(Range);
5367 }
5368
5369 if (C.kind == CXCursor_InclusionDirective) {
5370 ASTUnit *TU = getCursorASTUnit(C);
5371 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
5372 return TU->mapRangeFromPreamble(Range);
5373 }
5374
5375 if (C.kind == CXCursor_TranslationUnit) {
5376 ASTUnit *TU = getCursorASTUnit(C);
5377 FileID MainID = TU->getSourceManager().getMainFileID();
5378 SourceLocation Start = TU->getSourceManager().getLocForStartOfFile(MainID);
5379 SourceLocation End = TU->getSourceManager().getLocForEndOfFile(MainID);
5380 return SourceRange(Start, End);
5381 }
5382
5383 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005384 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005385 if (!D)
5386 return SourceRange();
5387
5388 SourceRange R = D->getSourceRange();
5389 // FIXME: Multiple variables declared in a single declaration
5390 // currently lack the information needed to correctly determine their
5391 // ranges when accounting for the type-specifier. We use context
5392 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5393 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005394 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005395 if (!cxcursor::isFirstInDeclGroup(C))
5396 R.setBegin(VD->getLocation());
5397 }
5398 return R;
5399 }
5400 return SourceRange();
5401}
5402
5403/// \brief Retrieves the "raw" cursor extent, which is then extended to include
5404/// the decl-specifier-seq for declarations.
5405static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
5406 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005407 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005408 if (!D)
5409 return SourceRange();
5410
5411 SourceRange R = D->getSourceRange();
5412
5413 // Adjust the start of the location for declarations preceded by
5414 // declaration specifiers.
5415 SourceLocation StartLoc;
5416 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
5417 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
5418 StartLoc = TI->getTypeLoc().getLocStart();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005419 } else if (const TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005420 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
5421 StartLoc = TI->getTypeLoc().getLocStart();
5422 }
5423
5424 if (StartLoc.isValid() && R.getBegin().isValid() &&
5425 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
5426 R.setBegin(StartLoc);
5427
5428 // FIXME: Multiple variables declared in a single declaration
5429 // currently lack the information needed to correctly determine their
5430 // ranges when accounting for the type-specifier. We use context
5431 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5432 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005433 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005434 if (!cxcursor::isFirstInDeclGroup(C))
5435 R.setBegin(VD->getLocation());
5436 }
5437
5438 return R;
5439 }
5440
5441 return getRawCursorExtent(C);
5442}
5443
5444extern "C" {
5445
5446CXSourceRange clang_getCursorExtent(CXCursor C) {
5447 SourceRange R = getRawCursorExtent(C);
5448 if (R.isInvalid())
5449 return clang_getNullRange();
5450
5451 return cxloc::translateSourceRange(getCursorContext(C), R);
5452}
5453
5454CXCursor clang_getCursorReferenced(CXCursor C) {
5455 if (clang_isInvalid(C.kind))
5456 return clang_getNullCursor();
5457
5458 CXTranslationUnit tu = getCursorTU(C);
5459 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005460 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005461 if (!D)
5462 return clang_getNullCursor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005463 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005464 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005465 if (const ObjCPropertyImplDecl *PropImpl =
5466 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005467 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
5468 return MakeCXCursor(Property, tu);
5469
5470 return C;
5471 }
5472
5473 if (clang_isExpression(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005474 const Expr *E = getCursorExpr(C);
5475 const Decl *D = getDeclFromExpr(E);
Guy Benyei11169dd2012-12-18 14:30:41 +00005476 if (D) {
5477 CXCursor declCursor = MakeCXCursor(D, tu);
5478 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
5479 declCursor);
5480 return declCursor;
5481 }
5482
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005483 if (const OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00005484 return MakeCursorOverloadedDeclRef(Ovl, tu);
5485
5486 return clang_getNullCursor();
5487 }
5488
5489 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005490 const Stmt *S = getCursorStmt(C);
5491 if (const GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Guy Benyei11169dd2012-12-18 14:30:41 +00005492 if (LabelDecl *label = Goto->getLabel())
5493 if (LabelStmt *labelS = label->getStmt())
5494 return MakeCXCursor(labelS, getCursorDecl(C), tu);
5495
5496 return clang_getNullCursor();
5497 }
Richard Smith66a81862015-05-04 02:25:31 +00005498
Guy Benyei11169dd2012-12-18 14:30:41 +00005499 if (C.kind == CXCursor_MacroExpansion) {
Richard Smith66a81862015-05-04 02:25:31 +00005500 if (const MacroDefinitionRecord *Def =
5501 getCursorMacroExpansion(C).getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005502 return MakeMacroDefinitionCursor(Def, tu);
5503 }
5504
5505 if (!clang_isReference(C.kind))
5506 return clang_getNullCursor();
5507
5508 switch (C.kind) {
5509 case CXCursor_ObjCSuperClassRef:
5510 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
5511
5512 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005513 const ObjCProtocolDecl *Prot = getCursorObjCProtocolRef(C).first;
5514 if (const ObjCProtocolDecl *Def = Prot->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005515 return MakeCXCursor(Def, tu);
5516
5517 return MakeCXCursor(Prot, tu);
5518 }
5519
5520 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005521 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
5522 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005523 return MakeCXCursor(Def, tu);
5524
5525 return MakeCXCursor(Class, tu);
5526 }
5527
5528 case CXCursor_TypeRef:
5529 return MakeCXCursor(getCursorTypeRef(C).first, tu );
5530
5531 case CXCursor_TemplateRef:
5532 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
5533
5534 case CXCursor_NamespaceRef:
5535 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
5536
5537 case CXCursor_MemberRef:
5538 return MakeCXCursor(getCursorMemberRef(C).first, tu );
5539
5540 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005541 const CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005542 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
5543 tu ));
5544 }
5545
5546 case CXCursor_LabelRef:
5547 // FIXME: We end up faking the "parent" declaration here because we
5548 // don't want to make CXCursor larger.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005549 return MakeCXCursor(getCursorLabelRef(C).first,
5550 cxtu::getASTUnit(tu)->getASTContext()
5551 .getTranslationUnitDecl(),
Guy Benyei11169dd2012-12-18 14:30:41 +00005552 tu);
5553
5554 case CXCursor_OverloadedDeclRef:
5555 return C;
5556
5557 case CXCursor_VariableRef:
5558 return MakeCXCursor(getCursorVariableRef(C).first, tu);
5559
5560 default:
5561 // We would prefer to enumerate all non-reference cursor kinds here.
5562 llvm_unreachable("Unhandled reference cursor kind");
5563 }
5564}
5565
5566CXCursor clang_getCursorDefinition(CXCursor C) {
5567 if (clang_isInvalid(C.kind))
5568 return clang_getNullCursor();
5569
5570 CXTranslationUnit TU = getCursorTU(C);
5571
5572 bool WasReference = false;
5573 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
5574 C = clang_getCursorReferenced(C);
5575 WasReference = true;
5576 }
5577
5578 if (C.kind == CXCursor_MacroExpansion)
5579 return clang_getCursorReferenced(C);
5580
5581 if (!clang_isDeclaration(C.kind))
5582 return clang_getNullCursor();
5583
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005584 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005585 if (!D)
5586 return clang_getNullCursor();
5587
5588 switch (D->getKind()) {
5589 // Declaration kinds that don't really separate the notions of
5590 // declaration and definition.
5591 case Decl::Namespace:
5592 case Decl::Typedef:
5593 case Decl::TypeAlias:
5594 case Decl::TypeAliasTemplate:
5595 case Decl::TemplateTypeParm:
5596 case Decl::EnumConstant:
5597 case Decl::Field:
John McCall5e77d762013-04-16 07:28:30 +00005598 case Decl::MSProperty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005599 case Decl::IndirectField:
5600 case Decl::ObjCIvar:
5601 case Decl::ObjCAtDefsField:
5602 case Decl::ImplicitParam:
5603 case Decl::ParmVar:
5604 case Decl::NonTypeTemplateParm:
5605 case Decl::TemplateTemplateParm:
5606 case Decl::ObjCCategoryImpl:
5607 case Decl::ObjCImplementation:
5608 case Decl::AccessSpec:
5609 case Decl::LinkageSpec:
5610 case Decl::ObjCPropertyImpl:
5611 case Decl::FileScopeAsm:
5612 case Decl::StaticAssert:
5613 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +00005614 case Decl::Captured:
Alexey Bataev4244be22016-02-11 05:35:55 +00005615 case Decl::OMPCapturedExpr:
Guy Benyei11169dd2012-12-18 14:30:41 +00005616 case Decl::Label: // FIXME: Is this right??
5617 case Decl::ClassScopeFunctionSpecialization:
5618 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +00005619 case Decl::OMPThreadPrivate:
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00005620 case Decl::OMPDeclareReduction:
Douglas Gregor85f3f952015-07-07 03:57:15 +00005621 case Decl::ObjCTypeParam:
David Majnemerd9b1a4f2015-11-04 03:40:30 +00005622 case Decl::BuiltinTemplate:
Nico Weber66220292016-03-02 17:28:48 +00005623 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +00005624 case Decl::PragmaDetectMismatch:
Guy Benyei11169dd2012-12-18 14:30:41 +00005625 return C;
5626
5627 // Declaration kinds that don't make any sense here, but are
5628 // nonetheless harmless.
David Blaikief005d3c2013-02-22 17:44:58 +00005629 case Decl::Empty:
Guy Benyei11169dd2012-12-18 14:30:41 +00005630 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +00005631 case Decl::ExternCContext:
Guy Benyei11169dd2012-12-18 14:30:41 +00005632 break;
5633
5634 // Declaration kinds for which the definition is not resolvable.
5635 case Decl::UnresolvedUsingTypename:
5636 case Decl::UnresolvedUsingValue:
5637 break;
5638
5639 case Decl::UsingDirective:
5640 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
5641 TU);
5642
5643 case Decl::NamespaceAlias:
5644 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
5645
5646 case Decl::Enum:
5647 case Decl::Record:
5648 case Decl::CXXRecord:
5649 case Decl::ClassTemplateSpecialization:
5650 case Decl::ClassTemplatePartialSpecialization:
5651 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
5652 return MakeCXCursor(Def, TU);
5653 return clang_getNullCursor();
5654
5655 case Decl::Function:
5656 case Decl::CXXMethod:
5657 case Decl::CXXConstructor:
5658 case Decl::CXXDestructor:
5659 case Decl::CXXConversion: {
Craig Topper69186e72014-06-08 08:38:04 +00005660 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005661 if (cast<FunctionDecl>(D)->getBody(Def))
Dmitri Gribenko9c256e32013-01-14 00:46:27 +00005662 return MakeCXCursor(Def, TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005663 return clang_getNullCursor();
5664 }
5665
Larisse Voufo39a1e502013-08-06 01:03:05 +00005666 case Decl::Var:
5667 case Decl::VarTemplateSpecialization:
5668 case Decl::VarTemplatePartialSpecialization: {
Guy Benyei11169dd2012-12-18 14:30:41 +00005669 // Ask the variable if it has a definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005670 if (const VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005671 return MakeCXCursor(Def, TU);
5672 return clang_getNullCursor();
5673 }
5674
5675 case Decl::FunctionTemplate: {
Craig Topper69186e72014-06-08 08:38:04 +00005676 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005677 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
5678 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
5679 return clang_getNullCursor();
5680 }
5681
5682 case Decl::ClassTemplate: {
5683 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
5684 ->getDefinition())
5685 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
5686 TU);
5687 return clang_getNullCursor();
5688 }
5689
Larisse Voufo39a1e502013-08-06 01:03:05 +00005690 case Decl::VarTemplate: {
5691 if (VarDecl *Def =
5692 cast<VarTemplateDecl>(D)->getTemplatedDecl()->getDefinition())
5693 return MakeCXCursor(cast<VarDecl>(Def)->getDescribedVarTemplate(), TU);
5694 return clang_getNullCursor();
5695 }
5696
Guy Benyei11169dd2012-12-18 14:30:41 +00005697 case Decl::Using:
5698 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
5699 D->getLocation(), TU);
5700
5701 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +00005702 case Decl::ConstructorUsingShadow:
Guy Benyei11169dd2012-12-18 14:30:41 +00005703 return clang_getCursorDefinition(
5704 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
5705 TU));
5706
5707 case Decl::ObjCMethod: {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005708 const ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005709 if (Method->isThisDeclarationADefinition())
5710 return C;
5711
5712 // Dig out the method definition in the associated
5713 // @implementation, if we have it.
5714 // FIXME: The ASTs should make finding the definition easier.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005715 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00005716 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
5717 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
5718 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
5719 Method->isInstanceMethod()))
5720 if (Def->isThisDeclarationADefinition())
5721 return MakeCXCursor(Def, TU);
5722
5723 return clang_getNullCursor();
5724 }
5725
5726 case Decl::ObjCCategory:
5727 if (ObjCCategoryImplDecl *Impl
5728 = cast<ObjCCategoryDecl>(D)->getImplementation())
5729 return MakeCXCursor(Impl, TU);
5730 return clang_getNullCursor();
5731
5732 case Decl::ObjCProtocol:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005733 if (const ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005734 return MakeCXCursor(Def, TU);
5735 return clang_getNullCursor();
5736
5737 case Decl::ObjCInterface: {
5738 // There are two notions of a "definition" for an Objective-C
5739 // class: the interface and its implementation. When we resolved a
5740 // reference to an Objective-C class, produce the @interface as
5741 // the definition; when we were provided with the interface,
5742 // produce the @implementation as the definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005743 const ObjCInterfaceDecl *IFace = cast<ObjCInterfaceDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00005744 if (WasReference) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005745 if (const ObjCInterfaceDecl *Def = IFace->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005746 return MakeCXCursor(Def, TU);
5747 } else if (ObjCImplementationDecl *Impl = IFace->getImplementation())
5748 return MakeCXCursor(Impl, TU);
5749 return clang_getNullCursor();
5750 }
5751
5752 case Decl::ObjCProperty:
5753 // FIXME: We don't really know where to find the
5754 // ObjCPropertyImplDecls that implement this property.
5755 return clang_getNullCursor();
5756
5757 case Decl::ObjCCompatibleAlias:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005758 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00005759 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005760 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00005761 return MakeCXCursor(Def, TU);
5762
5763 return clang_getNullCursor();
5764
5765 case Decl::Friend:
5766 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
5767 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5768 return clang_getNullCursor();
5769
5770 case Decl::FriendTemplate:
5771 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
5772 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5773 return clang_getNullCursor();
5774 }
5775
5776 return clang_getNullCursor();
5777}
5778
5779unsigned clang_isCursorDefinition(CXCursor C) {
5780 if (!clang_isDeclaration(C.kind))
5781 return 0;
5782
5783 return clang_getCursorDefinition(C) == C;
5784}
5785
5786CXCursor clang_getCanonicalCursor(CXCursor C) {
5787 if (!clang_isDeclaration(C.kind))
5788 return C;
5789
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005790 if (const Decl *D = getCursorDecl(C)) {
5791 if (const ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005792 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
5793 return MakeCXCursor(CatD, getCursorTU(C));
5794
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005795 if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
5796 if (const ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
Guy Benyei11169dd2012-12-18 14:30:41 +00005797 return MakeCXCursor(IFD, getCursorTU(C));
5798
5799 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
5800 }
5801
5802 return C;
5803}
5804
5805int clang_Cursor_getObjCSelectorIndex(CXCursor cursor) {
5806 return cxcursor::getSelectorIdentifierIndexAndLoc(cursor).first;
5807}
5808
5809unsigned clang_getNumOverloadedDecls(CXCursor C) {
5810 if (C.kind != CXCursor_OverloadedDeclRef)
5811 return 0;
5812
5813 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005814 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00005815 return E->getNumDecls();
5816
5817 if (OverloadedTemplateStorage *S
5818 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5819 return S->size();
5820
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005821 const Decl *D = Storage.get<const Decl *>();
5822 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005823 return Using->shadow_size();
5824
5825 return 0;
5826}
5827
5828CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
5829 if (cursor.kind != CXCursor_OverloadedDeclRef)
5830 return clang_getNullCursor();
5831
5832 if (index >= clang_getNumOverloadedDecls(cursor))
5833 return clang_getNullCursor();
5834
5835 CXTranslationUnit TU = getCursorTU(cursor);
5836 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005837 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00005838 return MakeCXCursor(E->decls_begin()[index], TU);
5839
5840 if (OverloadedTemplateStorage *S
5841 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5842 return MakeCXCursor(S->begin()[index], TU);
5843
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005844 const Decl *D = Storage.get<const Decl *>();
5845 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005846 // FIXME: This is, unfortunately, linear time.
5847 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
5848 std::advance(Pos, index);
5849 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
5850 }
5851
5852 return clang_getNullCursor();
5853}
5854
5855void clang_getDefinitionSpellingAndExtent(CXCursor C,
5856 const char **startBuf,
5857 const char **endBuf,
5858 unsigned *startLine,
5859 unsigned *startColumn,
5860 unsigned *endLine,
5861 unsigned *endColumn) {
5862 assert(getCursorDecl(C) && "CXCursor has null decl");
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005863 const FunctionDecl *FD = dyn_cast<FunctionDecl>(getCursorDecl(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00005864 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
5865
5866 SourceManager &SM = FD->getASTContext().getSourceManager();
5867 *startBuf = SM.getCharacterData(Body->getLBracLoc());
5868 *endBuf = SM.getCharacterData(Body->getRBracLoc());
5869 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
5870 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
5871 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
5872 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
5873}
5874
5875
5876CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
5877 unsigned PieceIndex) {
5878 RefNamePieces Pieces;
5879
5880 switch (C.kind) {
5881 case CXCursor_MemberRefExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005882 if (const MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00005883 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
5884 E->getQualifierLoc().getSourceRange());
5885 break;
5886
5887 case CXCursor_DeclRefExpr:
James Y Knight04ec5bf2015-12-24 02:59:37 +00005888 if (const DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C))) {
5889 SourceRange TemplateArgLoc(E->getLAngleLoc(), E->getRAngleLoc());
5890 Pieces =
5891 buildPieces(NameFlags, false, E->getNameInfo(),
5892 E->getQualifierLoc().getSourceRange(), &TemplateArgLoc);
5893 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005894 break;
5895
5896 case CXCursor_CallExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005897 if (const CXXOperatorCallExpr *OCE =
Guy Benyei11169dd2012-12-18 14:30:41 +00005898 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005899 const Expr *Callee = OCE->getCallee();
5900 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00005901 Callee = ICE->getSubExpr();
5902
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00005903 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00005904 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
5905 DRE->getQualifierLoc().getSourceRange());
5906 }
5907 break;
5908
5909 default:
5910 break;
5911 }
5912
5913 if (Pieces.empty()) {
5914 if (PieceIndex == 0)
5915 return clang_getCursorExtent(C);
5916 } else if (PieceIndex < Pieces.size()) {
5917 SourceRange R = Pieces[PieceIndex];
5918 if (R.isValid())
5919 return cxloc::translateSourceRange(getCursorContext(C), R);
5920 }
5921
5922 return clang_getNullRange();
5923}
5924
5925void clang_enableStackTraces(void) {
Richard Smithdfed58a2016-06-09 00:53:41 +00005926 // FIXME: Provide an argv0 here so we can find llvm-symbolizer.
5927 llvm::sys::PrintStackTraceOnErrorSignal(StringRef());
Guy Benyei11169dd2012-12-18 14:30:41 +00005928}
5929
5930void clang_executeOnThread(void (*fn)(void*), void *user_data,
5931 unsigned stack_size) {
5932 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
5933}
5934
5935} // end: extern "C"
5936
5937//===----------------------------------------------------------------------===//
5938// Token-based Operations.
5939//===----------------------------------------------------------------------===//
5940
5941/* CXToken layout:
5942 * int_data[0]: a CXTokenKind
5943 * int_data[1]: starting token location
5944 * int_data[2]: token length
5945 * int_data[3]: reserved
5946 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
5947 * otherwise unused.
5948 */
5949extern "C" {
5950
5951CXTokenKind clang_getTokenKind(CXToken CXTok) {
5952 return static_cast<CXTokenKind>(CXTok.int_data[0]);
5953}
5954
5955CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
5956 switch (clang_getTokenKind(CXTok)) {
5957 case CXToken_Identifier:
5958 case CXToken_Keyword:
5959 // We know we have an IdentifierInfo*, so use that.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005960 return cxstring::createRef(static_cast<IdentifierInfo *>(CXTok.ptr_data)
Guy Benyei11169dd2012-12-18 14:30:41 +00005961 ->getNameStart());
5962
5963 case CXToken_Literal: {
5964 // We have stashed the starting pointer in the ptr_data field. Use it.
5965 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00005966 return cxstring::createDup(StringRef(Text, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00005967 }
5968
5969 case CXToken_Punctuation:
5970 case CXToken_Comment:
5971 break;
5972 }
5973
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005974 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005975 LOG_BAD_TU(TU);
5976 return cxstring::createEmpty();
5977 }
5978
Guy Benyei11169dd2012-12-18 14:30:41 +00005979 // We have to find the starting buffer pointer the hard way, by
5980 // deconstructing the source location.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005981 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005982 if (!CXXUnit)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00005983 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00005984
5985 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
5986 std::pair<FileID, unsigned> LocInfo
5987 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
5988 bool Invalid = false;
5989 StringRef Buffer
5990 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
5991 if (Invalid)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00005992 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00005993
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00005994 return cxstring::createDup(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00005995}
5996
5997CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005998 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005999 LOG_BAD_TU(TU);
6000 return clang_getNullLocation();
6001 }
6002
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006003 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006004 if (!CXXUnit)
6005 return clang_getNullLocation();
6006
6007 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
6008 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6009}
6010
6011CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006012 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006013 LOG_BAD_TU(TU);
6014 return clang_getNullRange();
6015 }
6016
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006017 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006018 if (!CXXUnit)
6019 return clang_getNullRange();
6020
6021 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
6022 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6023}
6024
6025static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
6026 SmallVectorImpl<CXToken> &CXTokens) {
6027 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6028 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006029 = SourceMgr.getDecomposedSpellingLoc(Range.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006030 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006031 = SourceMgr.getDecomposedSpellingLoc(Range.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006032
6033 // Cannot tokenize across files.
6034 if (BeginLocInfo.first != EndLocInfo.first)
6035 return;
6036
6037 // Create a lexer
6038 bool Invalid = false;
6039 StringRef Buffer
6040 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6041 if (Invalid)
6042 return;
6043
6044 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6045 CXXUnit->getASTContext().getLangOpts(),
6046 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
6047 Lex.SetCommentRetentionState(true);
6048
6049 // Lex tokens until we hit the end of the range.
6050 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
6051 Token Tok;
6052 bool previousWasAt = false;
6053 do {
6054 // Lex the next token
6055 Lex.LexFromRawLexer(Tok);
6056 if (Tok.is(tok::eof))
6057 break;
6058
6059 // Initialize the CXToken.
6060 CXToken CXTok;
6061
6062 // - Common fields
6063 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
6064 CXTok.int_data[2] = Tok.getLength();
6065 CXTok.int_data[3] = 0;
6066
6067 // - Kind-specific fields
6068 if (Tok.isLiteral()) {
6069 CXTok.int_data[0] = CXToken_Literal;
Dmitri Gribenkof9304482013-01-23 15:56:07 +00006070 CXTok.ptr_data = const_cast<char *>(Tok.getLiteralData());
Guy Benyei11169dd2012-12-18 14:30:41 +00006071 } else if (Tok.is(tok::raw_identifier)) {
6072 // Lookup the identifier to determine whether we have a keyword.
6073 IdentifierInfo *II
6074 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
6075
6076 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
6077 CXTok.int_data[0] = CXToken_Keyword;
6078 }
6079 else {
6080 CXTok.int_data[0] = Tok.is(tok::identifier)
6081 ? CXToken_Identifier
6082 : CXToken_Keyword;
6083 }
6084 CXTok.ptr_data = II;
6085 } else if (Tok.is(tok::comment)) {
6086 CXTok.int_data[0] = CXToken_Comment;
Craig Topper69186e72014-06-08 08:38:04 +00006087 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006088 } else {
6089 CXTok.int_data[0] = CXToken_Punctuation;
Craig Topper69186e72014-06-08 08:38:04 +00006090 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006091 }
6092 CXTokens.push_back(CXTok);
6093 previousWasAt = Tok.is(tok::at);
6094 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
6095}
6096
6097void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
6098 CXToken **Tokens, unsigned *NumTokens) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006099 LOG_FUNC_SECTION {
6100 *Log << TU << ' ' << Range;
6101 }
6102
Guy Benyei11169dd2012-12-18 14:30:41 +00006103 if (Tokens)
Craig Topper69186e72014-06-08 08:38:04 +00006104 *Tokens = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006105 if (NumTokens)
6106 *NumTokens = 0;
6107
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006108 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006109 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006110 return;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006111 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006112
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006113 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006114 if (!CXXUnit || !Tokens || !NumTokens)
6115 return;
6116
6117 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6118
6119 SourceRange R = cxloc::translateCXSourceRange(Range);
6120 if (R.isInvalid())
6121 return;
6122
6123 SmallVector<CXToken, 32> CXTokens;
6124 getTokens(CXXUnit, R, CXTokens);
6125
6126 if (CXTokens.empty())
6127 return;
6128
6129 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
6130 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
6131 *NumTokens = CXTokens.size();
6132}
6133
6134void clang_disposeTokens(CXTranslationUnit TU,
6135 CXToken *Tokens, unsigned NumTokens) {
6136 free(Tokens);
6137}
6138
6139} // end: extern "C"
6140
6141//===----------------------------------------------------------------------===//
6142// Token annotation APIs.
6143//===----------------------------------------------------------------------===//
6144
Guy Benyei11169dd2012-12-18 14:30:41 +00006145static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6146 CXCursor parent,
6147 CXClientData client_data);
6148static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6149 CXClientData client_data);
6150
6151namespace {
6152class AnnotateTokensWorker {
Guy Benyei11169dd2012-12-18 14:30:41 +00006153 CXToken *Tokens;
6154 CXCursor *Cursors;
6155 unsigned NumTokens;
6156 unsigned TokIdx;
6157 unsigned PreprocessingTokIdx;
6158 CursorVisitor AnnotateVis;
6159 SourceManager &SrcMgr;
6160 bool HasContextSensitiveKeywords;
6161
6162 struct PostChildrenInfo {
6163 CXCursor Cursor;
6164 SourceRange CursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006165 unsigned BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006166 unsigned BeforeChildrenTokenIdx;
6167 };
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006168 SmallVector<PostChildrenInfo, 8> PostChildrenInfos;
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006169
6170 CXToken &getTok(unsigned Idx) {
6171 assert(Idx < NumTokens);
6172 return Tokens[Idx];
6173 }
6174 const CXToken &getTok(unsigned Idx) const {
6175 assert(Idx < NumTokens);
6176 return Tokens[Idx];
6177 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006178 bool MoreTokens() const { return TokIdx < NumTokens; }
6179 unsigned NextToken() const { return TokIdx; }
6180 void AdvanceToken() { ++TokIdx; }
6181 SourceLocation GetTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006182 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006183 }
6184 bool isFunctionMacroToken(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006185 return getTok(tokI).int_data[3] != 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006186 }
6187 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006188 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[3]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006189 }
6190
6191 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006192 bool annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
Guy Benyei11169dd2012-12-18 14:30:41 +00006193 SourceRange);
6194
6195public:
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006196 AnnotateTokensWorker(CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006197 CXTranslationUnit TU, SourceRange RegionOfInterest)
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006198 : Tokens(tokens), Cursors(cursors),
Guy Benyei11169dd2012-12-18 14:30:41 +00006199 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006200 AnnotateVis(TU,
Guy Benyei11169dd2012-12-18 14:30:41 +00006201 AnnotateTokensVisitor, this,
6202 /*VisitPreprocessorLast=*/true,
6203 /*VisitIncludedEntities=*/false,
6204 RegionOfInterest,
6205 /*VisitDeclsOnly=*/false,
6206 AnnotateTokensPostChildrenVisitor),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006207 SrcMgr(cxtu::getASTUnit(TU)->getSourceManager()),
Guy Benyei11169dd2012-12-18 14:30:41 +00006208 HasContextSensitiveKeywords(false) { }
6209
6210 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
6211 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
6212 bool postVisitChildren(CXCursor cursor);
6213 void AnnotateTokens();
6214
6215 /// \brief Determine whether the annotator saw any cursors that have
6216 /// context-sensitive keywords.
6217 bool hasContextSensitiveKeywords() const {
6218 return HasContextSensitiveKeywords;
6219 }
6220
6221 ~AnnotateTokensWorker() {
6222 assert(PostChildrenInfos.empty());
6223 }
6224};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00006225}
Guy Benyei11169dd2012-12-18 14:30:41 +00006226
6227void AnnotateTokensWorker::AnnotateTokens() {
6228 // Walk the AST within the region of interest, annotating tokens
6229 // along the way.
6230 AnnotateVis.visitFileRegion();
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006231}
Guy Benyei11169dd2012-12-18 14:30:41 +00006232
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006233static inline void updateCursorAnnotation(CXCursor &Cursor,
6234 const CXCursor &updateC) {
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006235 if (clang_isInvalid(updateC.kind) || !clang_isInvalid(Cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006236 return;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006237 Cursor = updateC;
Guy Benyei11169dd2012-12-18 14:30:41 +00006238}
6239
6240/// \brief It annotates and advances tokens with a cursor until the comparison
6241//// between the cursor location and the source range is the same as
6242/// \arg compResult.
6243///
6244/// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
6245/// Pass RangeOverlap to annotate tokens inside a range.
6246void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
6247 RangeComparisonResult compResult,
6248 SourceRange range) {
6249 while (MoreTokens()) {
6250 const unsigned I = NextToken();
6251 if (isFunctionMacroToken(I))
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006252 if (!annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range))
6253 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00006254
6255 SourceLocation TokLoc = GetTokenLoc(I);
6256 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006257 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006258 AdvanceToken();
6259 continue;
6260 }
6261 break;
6262 }
6263}
6264
6265/// \brief Special annotation handling for macro argument tokens.
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006266/// \returns true if it advanced beyond all macro tokens, false otherwise.
6267bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
Guy Benyei11169dd2012-12-18 14:30:41 +00006268 CXCursor updateC,
6269 RangeComparisonResult compResult,
6270 SourceRange range) {
6271 assert(MoreTokens());
6272 assert(isFunctionMacroToken(NextToken()) &&
6273 "Should be called only for macro arg tokens");
6274
6275 // This works differently than annotateAndAdvanceTokens; because expanded
6276 // macro arguments can have arbitrary translation-unit source order, we do not
6277 // advance the token index one by one until a token fails the range test.
6278 // We only advance once past all of the macro arg tokens if all of them
6279 // pass the range test. If one of them fails we keep the token index pointing
6280 // at the start of the macro arg tokens so that the failing token will be
6281 // annotated by a subsequent annotation try.
6282
6283 bool atLeastOneCompFail = false;
6284
6285 unsigned I = NextToken();
6286 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
6287 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
6288 if (TokLoc.isFileID())
6289 continue; // not macro arg token, it's parens or comma.
6290 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6291 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
6292 Cursors[I] = updateC;
6293 } else
6294 atLeastOneCompFail = true;
6295 }
6296
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006297 if (atLeastOneCompFail)
6298 return false;
6299
6300 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
6301 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00006302}
6303
6304enum CXChildVisitResult
6305AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006306 SourceRange cursorRange = getRawCursorExtent(cursor);
6307 if (cursorRange.isInvalid())
6308 return CXChildVisit_Recurse;
6309
6310 if (!HasContextSensitiveKeywords) {
6311 // Objective-C properties can have context-sensitive keywords.
6312 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006313 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006314 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
6315 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
6316 }
6317 // Objective-C methods can have context-sensitive keywords.
6318 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
6319 cursor.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006320 if (const ObjCMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006321 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
6322 if (Method->getObjCDeclQualifier())
6323 HasContextSensitiveKeywords = true;
6324 else {
David Majnemer59f77922016-06-24 04:05:48 +00006325 for (const auto *P : Method->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00006326 if (P->getObjCDeclQualifier()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006327 HasContextSensitiveKeywords = true;
6328 break;
6329 }
6330 }
6331 }
6332 }
6333 }
6334 // C++ methods can have context-sensitive keywords.
6335 else if (cursor.kind == CXCursor_CXXMethod) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006336 if (const CXXMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006337 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
6338 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
6339 HasContextSensitiveKeywords = true;
6340 }
6341 }
6342 // C++ classes can have context-sensitive keywords.
6343 else if (cursor.kind == CXCursor_StructDecl ||
6344 cursor.kind == CXCursor_ClassDecl ||
6345 cursor.kind == CXCursor_ClassTemplate ||
6346 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006347 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00006348 if (D->hasAttr<FinalAttr>())
6349 HasContextSensitiveKeywords = true;
6350 }
6351 }
Argyrios Kyrtzidis990b3862013-06-04 18:24:30 +00006352
6353 // Don't override a property annotation with its getter/setter method.
6354 if (cursor.kind == CXCursor_ObjCInstanceMethodDecl &&
6355 parent.kind == CXCursor_ObjCPropertyDecl)
6356 return CXChildVisit_Continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00006357
6358 if (clang_isPreprocessing(cursor.kind)) {
6359 // Items in the preprocessing record are kept separate from items in
6360 // declarations, so we keep a separate token index.
6361 unsigned SavedTokIdx = TokIdx;
6362 TokIdx = PreprocessingTokIdx;
6363
6364 // Skip tokens up until we catch up to the beginning of the preprocessing
6365 // entry.
6366 while (MoreTokens()) {
6367 const unsigned I = NextToken();
6368 SourceLocation TokLoc = GetTokenLoc(I);
6369 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6370 case RangeBefore:
6371 AdvanceToken();
6372 continue;
6373 case RangeAfter:
6374 case RangeOverlap:
6375 break;
6376 }
6377 break;
6378 }
6379
6380 // Look at all of the tokens within this range.
6381 while (MoreTokens()) {
6382 const unsigned I = NextToken();
6383 SourceLocation TokLoc = GetTokenLoc(I);
6384 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6385 case RangeBefore:
6386 llvm_unreachable("Infeasible");
6387 case RangeAfter:
6388 break;
6389 case RangeOverlap:
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006390 // For macro expansions, just note where the beginning of the macro
6391 // expansion occurs.
6392 if (cursor.kind == CXCursor_MacroExpansion) {
6393 if (TokLoc == cursorRange.getBegin())
6394 Cursors[I] = cursor;
6395 AdvanceToken();
6396 break;
6397 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006398 // We may have already annotated macro names inside macro definitions.
6399 if (Cursors[I].kind != CXCursor_MacroExpansion)
6400 Cursors[I] = cursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00006401 AdvanceToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006402 continue;
6403 }
6404 break;
6405 }
6406
6407 // Save the preprocessing token index; restore the non-preprocessing
6408 // token index.
6409 PreprocessingTokIdx = TokIdx;
6410 TokIdx = SavedTokIdx;
6411 return CXChildVisit_Recurse;
6412 }
6413
6414 if (cursorRange.isInvalid())
6415 return CXChildVisit_Continue;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006416
6417 unsigned BeforeReachingCursorIdx = NextToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00006418 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006419 const enum CXCursorKind K = clang_getCursorKind(parent);
6420 const CXCursor updateC =
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006421 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
6422 // Attributes are annotated out-of-order, skip tokens until we reach it.
6423 clang_isAttribute(cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006424 ? clang_getNullCursor() : parent;
6425
6426 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
6427
6428 // Avoid having the cursor of an expression "overwrite" the annotation of the
6429 // variable declaration that it belongs to.
6430 // This can happen for C++ constructor expressions whose range generally
6431 // include the variable declaration, e.g.:
6432 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006433 if (clang_isExpression(cursorK) && MoreTokens()) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006434 const Expr *E = getCursorExpr(cursor);
Dmitri Gribenkoa1691182013-01-26 18:12:08 +00006435 if (const Decl *D = getCursorParentDecl(cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006436 const unsigned I = NextToken();
6437 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
6438 E->getLocStart() == D->getLocation() &&
6439 E->getLocStart() == GetTokenLoc(I)) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006440 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006441 AdvanceToken();
6442 }
6443 }
6444 }
6445
6446 // Before recursing into the children keep some state that we are going
6447 // to use in the AnnotateTokensWorker::postVisitChildren callback to do some
6448 // extra work after the child nodes are visited.
6449 // Note that we don't call VisitChildren here to avoid traversing statements
6450 // code-recursively which can blow the stack.
6451
6452 PostChildrenInfo Info;
6453 Info.Cursor = cursor;
6454 Info.CursorRange = cursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006455 Info.BeforeReachingCursorIdx = BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006456 Info.BeforeChildrenTokenIdx = NextToken();
6457 PostChildrenInfos.push_back(Info);
6458
6459 return CXChildVisit_Recurse;
6460}
6461
6462bool AnnotateTokensWorker::postVisitChildren(CXCursor cursor) {
6463 if (PostChildrenInfos.empty())
6464 return false;
6465 const PostChildrenInfo &Info = PostChildrenInfos.back();
6466 if (!clang_equalCursors(Info.Cursor, cursor))
6467 return false;
6468
6469 const unsigned BeforeChildren = Info.BeforeChildrenTokenIdx;
6470 const unsigned AfterChildren = NextToken();
6471 SourceRange cursorRange = Info.CursorRange;
6472
6473 // Scan the tokens that are at the end of the cursor, but are not captured
6474 // but the child cursors.
6475 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
6476
6477 // Scan the tokens that are at the beginning of the cursor, but are not
6478 // capture by the child cursors.
6479 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
6480 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
6481 break;
6482
6483 Cursors[I] = cursor;
6484 }
6485
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006486 // Attributes are annotated out-of-order, rewind TokIdx to when we first
6487 // encountered the attribute cursor.
6488 if (clang_isAttribute(cursor.kind))
6489 TokIdx = Info.BeforeReachingCursorIdx;
6490
Guy Benyei11169dd2012-12-18 14:30:41 +00006491 PostChildrenInfos.pop_back();
6492 return false;
6493}
6494
6495static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6496 CXCursor parent,
6497 CXClientData client_data) {
6498 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
6499}
6500
6501static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6502 CXClientData client_data) {
6503 return static_cast<AnnotateTokensWorker*>(client_data)->
6504 postVisitChildren(cursor);
6505}
6506
6507namespace {
6508
6509/// \brief Uses the macro expansions in the preprocessing record to find
6510/// and mark tokens that are macro arguments. This info is used by the
6511/// AnnotateTokensWorker.
6512class MarkMacroArgTokensVisitor {
6513 SourceManager &SM;
6514 CXToken *Tokens;
6515 unsigned NumTokens;
6516 unsigned CurIdx;
6517
6518public:
6519 MarkMacroArgTokensVisitor(SourceManager &SM,
6520 CXToken *tokens, unsigned numTokens)
6521 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
6522
6523 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
6524 if (cursor.kind != CXCursor_MacroExpansion)
6525 return CXChildVisit_Continue;
6526
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00006527 SourceRange macroRange = getCursorMacroExpansion(cursor).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00006528 if (macroRange.getBegin() == macroRange.getEnd())
6529 return CXChildVisit_Continue; // it's not a function macro.
6530
6531 for (; CurIdx < NumTokens; ++CurIdx) {
6532 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
6533 macroRange.getBegin()))
6534 break;
6535 }
6536
6537 if (CurIdx == NumTokens)
6538 return CXChildVisit_Break;
6539
6540 for (; CurIdx < NumTokens; ++CurIdx) {
6541 SourceLocation tokLoc = getTokenLoc(CurIdx);
6542 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
6543 break;
6544
6545 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
6546 }
6547
6548 if (CurIdx == NumTokens)
6549 return CXChildVisit_Break;
6550
6551 return CXChildVisit_Continue;
6552 }
6553
6554private:
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006555 CXToken &getTok(unsigned Idx) {
6556 assert(Idx < NumTokens);
6557 return Tokens[Idx];
6558 }
6559 const CXToken &getTok(unsigned Idx) const {
6560 assert(Idx < NumTokens);
6561 return Tokens[Idx];
6562 }
6563
Guy Benyei11169dd2012-12-18 14:30:41 +00006564 SourceLocation getTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006565 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006566 }
6567
6568 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
6569 // The third field is reserved and currently not used. Use it here
6570 // to mark macro arg expanded tokens with their expanded locations.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006571 getTok(tokI).int_data[3] = loc.getRawEncoding();
Guy Benyei11169dd2012-12-18 14:30:41 +00006572 }
6573};
6574
6575} // end anonymous namespace
6576
6577static CXChildVisitResult
6578MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
6579 CXClientData client_data) {
6580 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
6581 parent);
6582}
6583
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006584/// \brief Used by \c annotatePreprocessorTokens.
6585/// \returns true if lexing was finished, false otherwise.
6586static bool lexNext(Lexer &Lex, Token &Tok,
6587 unsigned &NextIdx, unsigned NumTokens) {
6588 if (NextIdx >= NumTokens)
6589 return true;
6590
6591 ++NextIdx;
6592 Lex.LexFromRawLexer(Tok);
Alexander Kornienko1a9f1842015-12-28 15:24:08 +00006593 return Tok.is(tok::eof);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006594}
6595
Guy Benyei11169dd2012-12-18 14:30:41 +00006596static void annotatePreprocessorTokens(CXTranslationUnit TU,
6597 SourceRange RegionOfInterest,
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006598 CXCursor *Cursors,
6599 CXToken *Tokens,
6600 unsigned NumTokens) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006601 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006602
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006603 Preprocessor &PP = CXXUnit->getPreprocessor();
Guy Benyei11169dd2012-12-18 14:30:41 +00006604 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6605 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006606 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006607 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006608 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006609
6610 if (BeginLocInfo.first != EndLocInfo.first)
6611 return;
6612
6613 StringRef Buffer;
6614 bool Invalid = false;
6615 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6616 if (Buffer.empty() || Invalid)
6617 return;
6618
6619 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6620 CXXUnit->getASTContext().getLangOpts(),
6621 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
6622 Buffer.end());
6623 Lex.SetCommentRetentionState(true);
6624
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006625 unsigned NextIdx = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006626 // Lex tokens in raw mode until we hit the end of the range, to avoid
6627 // entering #includes or expanding macros.
6628 while (true) {
6629 Token Tok;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006630 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6631 break;
6632 unsigned TokIdx = NextIdx-1;
6633 assert(Tok.getLocation() ==
6634 SourceLocation::getFromRawEncoding(Tokens[TokIdx].int_data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006635
6636 reprocess:
6637 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006638 // We have found a preprocessing directive. Annotate the tokens
6639 // appropriately.
Guy Benyei11169dd2012-12-18 14:30:41 +00006640 //
6641 // FIXME: Some simple tests here could identify macro definitions and
6642 // #undefs, to provide specific cursor kinds for those.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006643
6644 SourceLocation BeginLoc = Tok.getLocation();
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006645 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6646 break;
6647
Craig Topper69186e72014-06-08 08:38:04 +00006648 MacroInfo *MI = nullptr;
Alp Toker2d57cea2014-05-17 04:53:25 +00006649 if (Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "define") {
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006650 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6651 break;
6652
6653 if (Tok.is(tok::raw_identifier)) {
Alp Toker2d57cea2014-05-17 04:53:25 +00006654 IdentifierInfo &II =
6655 PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006656 SourceLocation MappedTokLoc =
6657 CXXUnit->mapLocationToPreamble(Tok.getLocation());
6658 MI = getMacroInfo(II, MappedTokLoc, TU);
6659 }
6660 }
6661
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006662 bool finished = false;
Guy Benyei11169dd2012-12-18 14:30:41 +00006663 do {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006664 if (lexNext(Lex, Tok, NextIdx, NumTokens)) {
6665 finished = true;
6666 break;
6667 }
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006668 // If we are in a macro definition, check if the token was ever a
6669 // macro name and annotate it if that's the case.
6670 if (MI) {
6671 SourceLocation SaveLoc = Tok.getLocation();
6672 Tok.setLocation(CXXUnit->mapLocationToPreamble(SaveLoc));
Richard Smith66a81862015-05-04 02:25:31 +00006673 MacroDefinitionRecord *MacroDef =
6674 checkForMacroInMacroDefinition(MI, Tok, TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006675 Tok.setLocation(SaveLoc);
6676 if (MacroDef)
Richard Smith66a81862015-05-04 02:25:31 +00006677 Cursors[NextIdx - 1] =
6678 MakeMacroExpansionCursor(MacroDef, Tok.getLocation(), TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006679 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006680 } while (!Tok.isAtStartOfLine());
6681
6682 unsigned LastIdx = finished ? NextIdx-1 : NextIdx-2;
6683 assert(TokIdx <= LastIdx);
6684 SourceLocation EndLoc =
6685 SourceLocation::getFromRawEncoding(Tokens[LastIdx].int_data[1]);
6686 CXCursor Cursor =
6687 MakePreprocessingDirectiveCursor(SourceRange(BeginLoc, EndLoc), TU);
6688
6689 for (; TokIdx <= LastIdx; ++TokIdx)
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00006690 updateCursorAnnotation(Cursors[TokIdx], Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00006691
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006692 if (finished)
6693 break;
6694 goto reprocess;
Guy Benyei11169dd2012-12-18 14:30:41 +00006695 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006696 }
6697}
6698
6699// This gets run a separate thread to avoid stack blowout.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006700static void clang_annotateTokensImpl(CXTranslationUnit TU, ASTUnit *CXXUnit,
6701 CXToken *Tokens, unsigned NumTokens,
6702 CXCursor *Cursors) {
Dmitri Gribenko183436e2013-01-26 21:49:50 +00006703 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006704 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
6705 setThreadBackgroundPriority();
6706
6707 // Determine the region of interest, which contains all of the tokens.
6708 SourceRange RegionOfInterest;
6709 RegionOfInterest.setBegin(
6710 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
6711 RegionOfInterest.setEnd(
6712 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
6713 Tokens[NumTokens-1])));
6714
Guy Benyei11169dd2012-12-18 14:30:41 +00006715 // Relex the tokens within the source range to look for preprocessing
6716 // directives.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006717 annotatePreprocessorTokens(TU, RegionOfInterest, Cursors, Tokens, NumTokens);
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006718
6719 // If begin location points inside a macro argument, set it to the expansion
6720 // location so we can have the full context when annotating semantically.
6721 {
6722 SourceManager &SM = CXXUnit->getSourceManager();
6723 SourceLocation Loc =
6724 SM.getMacroArgExpandedLocation(RegionOfInterest.getBegin());
6725 if (Loc.isMacroID())
6726 RegionOfInterest.setBegin(SM.getExpansionLoc(Loc));
6727 }
6728
Guy Benyei11169dd2012-12-18 14:30:41 +00006729 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
6730 // Search and mark tokens that are macro argument expansions.
6731 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
6732 Tokens, NumTokens);
6733 CursorVisitor MacroArgMarker(TU,
6734 MarkMacroArgTokensVisitorDelegate, &Visitor,
6735 /*VisitPreprocessorLast=*/true,
6736 /*VisitIncludedEntities=*/false,
6737 RegionOfInterest);
6738 MacroArgMarker.visitPreprocessedEntitiesInRegion();
6739 }
6740
6741 // Annotate all of the source locations in the region of interest that map to
6742 // a specific cursor.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006743 AnnotateTokensWorker W(Tokens, Cursors, NumTokens, TU, RegionOfInterest);
Guy Benyei11169dd2012-12-18 14:30:41 +00006744
6745 // FIXME: We use a ridiculous stack size here because the data-recursion
6746 // algorithm uses a large stack frame than the non-data recursive version,
6747 // and AnnotationTokensWorker currently transforms the data-recursion
6748 // algorithm back into a traditional recursion by explicitly calling
6749 // VisitChildren(). We will need to remove this explicit recursive call.
6750 W.AnnotateTokens();
6751
6752 // If we ran into any entities that involve context-sensitive keywords,
6753 // take another pass through the tokens to mark them as such.
6754 if (W.hasContextSensitiveKeywords()) {
6755 for (unsigned I = 0; I != NumTokens; ++I) {
6756 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
6757 continue;
6758
6759 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
6760 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006761 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006762 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
6763 if (Property->getPropertyAttributesAsWritten() != 0 &&
6764 llvm::StringSwitch<bool>(II->getName())
6765 .Case("readonly", true)
6766 .Case("assign", true)
6767 .Case("unsafe_unretained", true)
6768 .Case("readwrite", true)
6769 .Case("retain", true)
6770 .Case("copy", true)
6771 .Case("nonatomic", true)
6772 .Case("atomic", true)
6773 .Case("getter", true)
6774 .Case("setter", true)
6775 .Case("strong", true)
6776 .Case("weak", true)
Manman Ren04fd4d82016-05-31 23:22:04 +00006777 .Case("class", true)
Guy Benyei11169dd2012-12-18 14:30:41 +00006778 .Default(false))
6779 Tokens[I].int_data[0] = CXToken_Keyword;
6780 }
6781 continue;
6782 }
6783
6784 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
6785 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
6786 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
6787 if (llvm::StringSwitch<bool>(II->getName())
6788 .Case("in", true)
6789 .Case("out", true)
6790 .Case("inout", true)
6791 .Case("oneway", true)
6792 .Case("bycopy", true)
6793 .Case("byref", true)
6794 .Default(false))
6795 Tokens[I].int_data[0] = CXToken_Keyword;
6796 continue;
6797 }
6798
6799 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
6800 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
6801 Tokens[I].int_data[0] = CXToken_Keyword;
6802 continue;
6803 }
6804 }
6805 }
6806}
6807
6808extern "C" {
6809
6810void clang_annotateTokens(CXTranslationUnit TU,
6811 CXToken *Tokens, unsigned NumTokens,
6812 CXCursor *Cursors) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006813 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006814 LOG_BAD_TU(TU);
6815 return;
6816 }
6817 if (NumTokens == 0 || !Tokens || !Cursors) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006818 LOG_FUNC_SECTION { *Log << "<null input>"; }
Guy Benyei11169dd2012-12-18 14:30:41 +00006819 return;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006820 }
6821
6822 LOG_FUNC_SECTION {
6823 *Log << TU << ' ';
6824 CXSourceLocation bloc = clang_getTokenLocation(TU, Tokens[0]);
6825 CXSourceLocation eloc = clang_getTokenLocation(TU, Tokens[NumTokens-1]);
6826 *Log << clang_getRange(bloc, eloc);
6827 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006828
6829 // Any token we don't specifically annotate will have a NULL cursor.
6830 CXCursor C = clang_getNullCursor();
6831 for (unsigned I = 0; I != NumTokens; ++I)
6832 Cursors[I] = C;
6833
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006834 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006835 if (!CXXUnit)
6836 return;
6837
6838 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006839
6840 auto AnnotateTokensImpl = [=]() {
6841 clang_annotateTokensImpl(TU, CXXUnit, Tokens, NumTokens, Cursors);
6842 };
Guy Benyei11169dd2012-12-18 14:30:41 +00006843 llvm::CrashRecoveryContext CRC;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00006844 if (!RunSafely(CRC, AnnotateTokensImpl, GetSafetyThreadStackSize() * 2)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006845 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
6846 }
6847}
6848
6849} // end: extern "C"
6850
6851//===----------------------------------------------------------------------===//
6852// Operations for querying linkage of a cursor.
6853//===----------------------------------------------------------------------===//
6854
6855extern "C" {
6856CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
6857 if (!clang_isDeclaration(cursor.kind))
6858 return CXLinkage_Invalid;
6859
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006860 const Decl *D = cxcursor::getCursorDecl(cursor);
6861 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
Rafael Espindola3ae00052013-05-13 00:12:11 +00006862 switch (ND->getLinkageInternal()) {
Rafael Espindola50df3a02013-05-25 17:16:20 +00006863 case NoLinkage:
6864 case VisibleNoLinkage: return CXLinkage_NoLinkage;
Guy Benyei11169dd2012-12-18 14:30:41 +00006865 case InternalLinkage: return CXLinkage_Internal;
6866 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
6867 case ExternalLinkage: return CXLinkage_External;
6868 };
6869
6870 return CXLinkage_Invalid;
6871}
6872} // end: extern "C"
6873
6874//===----------------------------------------------------------------------===//
Ehsan Akhgarib743de72016-05-31 15:55:51 +00006875// Operations for querying visibility of a cursor.
6876//===----------------------------------------------------------------------===//
6877
6878extern "C" {
6879CXVisibilityKind clang_getCursorVisibility(CXCursor cursor) {
6880 if (!clang_isDeclaration(cursor.kind))
6881 return CXVisibility_Invalid;
6882
6883 const Decl *D = cxcursor::getCursorDecl(cursor);
6884 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
6885 switch (ND->getVisibility()) {
6886 case HiddenVisibility: return CXVisibility_Hidden;
6887 case ProtectedVisibility: return CXVisibility_Protected;
6888 case DefaultVisibility: return CXVisibility_Default;
6889 };
6890
6891 return CXVisibility_Invalid;
6892}
6893} // end: extern "C"
6894
6895//===----------------------------------------------------------------------===//
Guy Benyei11169dd2012-12-18 14:30:41 +00006896// Operations for querying language of a cursor.
6897//===----------------------------------------------------------------------===//
6898
6899static CXLanguageKind getDeclLanguage(const Decl *D) {
6900 if (!D)
6901 return CXLanguage_C;
6902
6903 switch (D->getKind()) {
6904 default:
6905 break;
6906 case Decl::ImplicitParam:
6907 case Decl::ObjCAtDefsField:
6908 case Decl::ObjCCategory:
6909 case Decl::ObjCCategoryImpl:
6910 case Decl::ObjCCompatibleAlias:
6911 case Decl::ObjCImplementation:
6912 case Decl::ObjCInterface:
6913 case Decl::ObjCIvar:
6914 case Decl::ObjCMethod:
6915 case Decl::ObjCProperty:
6916 case Decl::ObjCPropertyImpl:
6917 case Decl::ObjCProtocol:
Douglas Gregor85f3f952015-07-07 03:57:15 +00006918 case Decl::ObjCTypeParam:
Guy Benyei11169dd2012-12-18 14:30:41 +00006919 return CXLanguage_ObjC;
6920 case Decl::CXXConstructor:
6921 case Decl::CXXConversion:
6922 case Decl::CXXDestructor:
6923 case Decl::CXXMethod:
6924 case Decl::CXXRecord:
6925 case Decl::ClassTemplate:
6926 case Decl::ClassTemplatePartialSpecialization:
6927 case Decl::ClassTemplateSpecialization:
6928 case Decl::Friend:
6929 case Decl::FriendTemplate:
6930 case Decl::FunctionTemplate:
6931 case Decl::LinkageSpec:
6932 case Decl::Namespace:
6933 case Decl::NamespaceAlias:
6934 case Decl::NonTypeTemplateParm:
6935 case Decl::StaticAssert:
6936 case Decl::TemplateTemplateParm:
6937 case Decl::TemplateTypeParm:
6938 case Decl::UnresolvedUsingTypename:
6939 case Decl::UnresolvedUsingValue:
6940 case Decl::Using:
6941 case Decl::UsingDirective:
6942 case Decl::UsingShadow:
6943 return CXLanguage_CPlusPlus;
6944 }
6945
6946 return CXLanguage_C;
6947}
6948
6949extern "C" {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006950
6951static CXAvailabilityKind getCursorAvailabilityForDecl(const Decl *D) {
6952 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
Manuel Klimek8e3a7ed2015-09-25 17:53:16 +00006953 return CXAvailability_NotAvailable;
Guy Benyei11169dd2012-12-18 14:30:41 +00006954
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006955 switch (D->getAvailability()) {
6956 case AR_Available:
6957 case AR_NotYetIntroduced:
6958 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
Benjamin Kramer656363d2013-10-15 18:53:18 +00006959 return getCursorAvailabilityForDecl(
6960 cast<Decl>(EnumConst->getDeclContext()));
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006961 return CXAvailability_Available;
6962
6963 case AR_Deprecated:
6964 return CXAvailability_Deprecated;
6965
6966 case AR_Unavailable:
6967 return CXAvailability_NotAvailable;
6968 }
Benjamin Kramer656363d2013-10-15 18:53:18 +00006969
6970 llvm_unreachable("Unknown availability kind!");
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006971}
6972
Guy Benyei11169dd2012-12-18 14:30:41 +00006973enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
6974 if (clang_isDeclaration(cursor.kind))
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00006975 if (const Decl *D = cxcursor::getCursorDecl(cursor))
6976 return getCursorAvailabilityForDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00006977
6978 return CXAvailability_Available;
6979}
6980
6981static CXVersion convertVersion(VersionTuple In) {
6982 CXVersion Out = { -1, -1, -1 };
6983 if (In.empty())
6984 return Out;
6985
6986 Out.Major = In.getMajor();
6987
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00006988 Optional<unsigned> Minor = In.getMinor();
6989 if (Minor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00006990 Out.Minor = *Minor;
6991 else
6992 return Out;
6993
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00006994 Optional<unsigned> Subminor = In.getSubminor();
6995 if (Subminor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00006996 Out.Subminor = *Subminor;
6997
6998 return Out;
6999}
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007000
7001static int getCursorPlatformAvailabilityForDecl(const Decl *D,
7002 int *always_deprecated,
7003 CXString *deprecated_message,
7004 int *always_unavailable,
7005 CXString *unavailable_message,
7006 CXPlatformAvailability *availability,
7007 int availability_size) {
7008 bool HadAvailAttr = false;
7009 int N = 0;
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007010 for (auto A : D->attrs()) {
7011 if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007012 HadAvailAttr = true;
7013 if (always_deprecated)
7014 *always_deprecated = 1;
Nico Weberaacf0312014-04-24 05:16:45 +00007015 if (deprecated_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007016 clang_disposeString(*deprecated_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007017 *deprecated_message = cxstring::createDup(Deprecated->getMessage());
Nico Weberaacf0312014-04-24 05:16:45 +00007018 }
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007019 continue;
7020 }
7021
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007022 if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007023 HadAvailAttr = true;
7024 if (always_unavailable)
7025 *always_unavailable = 1;
7026 if (unavailable_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007027 clang_disposeString(*unavailable_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007028 *unavailable_message = cxstring::createDup(Unavailable->getMessage());
7029 }
7030 continue;
7031 }
7032
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007033 if (AvailabilityAttr *Avail = dyn_cast<AvailabilityAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007034 HadAvailAttr = true;
7035 if (N < availability_size) {
7036 availability[N].Platform
7037 = cxstring::createDup(Avail->getPlatform()->getName());
7038 availability[N].Introduced = convertVersion(Avail->getIntroduced());
7039 availability[N].Deprecated = convertVersion(Avail->getDeprecated());
7040 availability[N].Obsoleted = convertVersion(Avail->getObsoleted());
7041 availability[N].Unavailable = Avail->getUnavailable();
7042 availability[N].Message = cxstring::createDup(Avail->getMessage());
7043 }
7044 ++N;
7045 }
7046 }
7047
7048 if (!HadAvailAttr)
7049 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
7050 return getCursorPlatformAvailabilityForDecl(
7051 cast<Decl>(EnumConst->getDeclContext()),
7052 always_deprecated,
7053 deprecated_message,
7054 always_unavailable,
7055 unavailable_message,
7056 availability,
7057 availability_size);
Guy Benyei11169dd2012-12-18 14:30:41 +00007058
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007059 return N;
7060}
7061
Guy Benyei11169dd2012-12-18 14:30:41 +00007062int clang_getCursorPlatformAvailability(CXCursor cursor,
7063 int *always_deprecated,
7064 CXString *deprecated_message,
7065 int *always_unavailable,
7066 CXString *unavailable_message,
7067 CXPlatformAvailability *availability,
7068 int availability_size) {
7069 if (always_deprecated)
7070 *always_deprecated = 0;
7071 if (deprecated_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007072 *deprecated_message = cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007073 if (always_unavailable)
7074 *always_unavailable = 0;
7075 if (unavailable_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007076 *unavailable_message = cxstring::createEmpty();
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007077
Guy Benyei11169dd2012-12-18 14:30:41 +00007078 if (!clang_isDeclaration(cursor.kind))
7079 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007080
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007081 const Decl *D = cxcursor::getCursorDecl(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007082 if (!D)
7083 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007084
7085 return getCursorPlatformAvailabilityForDecl(D, always_deprecated,
7086 deprecated_message,
7087 always_unavailable,
7088 unavailable_message,
7089 availability,
7090 availability_size);
Guy Benyei11169dd2012-12-18 14:30:41 +00007091}
7092
7093void clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability) {
7094 clang_disposeString(availability->Platform);
7095 clang_disposeString(availability->Message);
7096}
7097
7098CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
7099 if (clang_isDeclaration(cursor.kind))
7100 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
7101
7102 return CXLanguage_Invalid;
7103}
7104
7105 /// \brief If the given cursor is the "templated" declaration
7106 /// descibing a class or function template, return the class or
7107 /// function template.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007108static const Decl *maybeGetTemplateCursor(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007109 if (!D)
Craig Topper69186e72014-06-08 08:38:04 +00007110 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007111
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007112 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007113 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
7114 return FunTmpl;
7115
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007116 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007117 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
7118 return ClassTmpl;
7119
7120 return D;
7121}
7122
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007123
7124enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor C) {
7125 StorageClass sc = SC_None;
7126 const Decl *D = getCursorDecl(C);
7127 if (D) {
7128 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7129 sc = FD->getStorageClass();
7130 } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7131 sc = VD->getStorageClass();
7132 } else {
7133 return CX_SC_Invalid;
7134 }
7135 } else {
7136 return CX_SC_Invalid;
7137 }
7138 switch (sc) {
7139 case SC_None:
7140 return CX_SC_None;
7141 case SC_Extern:
7142 return CX_SC_Extern;
7143 case SC_Static:
7144 return CX_SC_Static;
7145 case SC_PrivateExtern:
7146 return CX_SC_PrivateExtern;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007147 case SC_Auto:
7148 return CX_SC_Auto;
7149 case SC_Register:
7150 return CX_SC_Register;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007151 }
Kaelyn Takataab61e702014-10-15 18:03:26 +00007152 llvm_unreachable("Unhandled storage class!");
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007153}
7154
Guy Benyei11169dd2012-12-18 14:30:41 +00007155CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
7156 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007157 if (const Decl *D = getCursorDecl(cursor)) {
7158 const DeclContext *DC = D->getDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007159 if (!DC)
7160 return clang_getNullCursor();
7161
7162 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7163 getCursorTU(cursor));
7164 }
7165 }
7166
7167 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007168 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00007169 return MakeCXCursor(D, getCursorTU(cursor));
7170 }
7171
7172 return clang_getNullCursor();
7173}
7174
7175CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
7176 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007177 if (const Decl *D = getCursorDecl(cursor)) {
7178 const DeclContext *DC = D->getLexicalDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007179 if (!DC)
7180 return clang_getNullCursor();
7181
7182 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7183 getCursorTU(cursor));
7184 }
7185 }
7186
7187 // FIXME: Note that we can't easily compute the lexical context of a
7188 // statement or expression, so we return nothing.
7189 return clang_getNullCursor();
7190}
7191
7192CXFile clang_getIncludedFile(CXCursor cursor) {
7193 if (cursor.kind != CXCursor_InclusionDirective)
Craig Topper69186e72014-06-08 08:38:04 +00007194 return nullptr;
7195
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007196 const InclusionDirective *ID = getCursorInclusionDirective(cursor);
Dmitri Gribenkof9304482013-01-23 15:56:07 +00007197 return const_cast<FileEntry *>(ID->getFile());
Guy Benyei11169dd2012-12-18 14:30:41 +00007198}
7199
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007200unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved) {
7201 if (C.kind != CXCursor_ObjCPropertyDecl)
7202 return CXObjCPropertyAttr_noattr;
7203
7204 unsigned Result = CXObjCPropertyAttr_noattr;
7205 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7206 ObjCPropertyDecl::PropertyAttributeKind Attr =
7207 PD->getPropertyAttributesAsWritten();
7208
7209#define SET_CXOBJCPROP_ATTR(A) \
7210 if (Attr & ObjCPropertyDecl::OBJC_PR_##A) \
7211 Result |= CXObjCPropertyAttr_##A
7212 SET_CXOBJCPROP_ATTR(readonly);
7213 SET_CXOBJCPROP_ATTR(getter);
7214 SET_CXOBJCPROP_ATTR(assign);
7215 SET_CXOBJCPROP_ATTR(readwrite);
7216 SET_CXOBJCPROP_ATTR(retain);
7217 SET_CXOBJCPROP_ATTR(copy);
7218 SET_CXOBJCPROP_ATTR(nonatomic);
7219 SET_CXOBJCPROP_ATTR(setter);
7220 SET_CXOBJCPROP_ATTR(atomic);
7221 SET_CXOBJCPROP_ATTR(weak);
7222 SET_CXOBJCPROP_ATTR(strong);
7223 SET_CXOBJCPROP_ATTR(unsafe_unretained);
Manman Ren04fd4d82016-05-31 23:22:04 +00007224 SET_CXOBJCPROP_ATTR(class);
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007225#undef SET_CXOBJCPROP_ATTR
7226
7227 return Result;
7228}
7229
Argyrios Kyrtzidis9d9bc012013-04-18 23:29:12 +00007230unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C) {
7231 if (!clang_isDeclaration(C.kind))
7232 return CXObjCDeclQualifier_None;
7233
7234 Decl::ObjCDeclQualifier QT = Decl::OBJC_TQ_None;
7235 const Decl *D = getCursorDecl(C);
7236 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7237 QT = MD->getObjCDeclQualifier();
7238 else if (const ParmVarDecl *PD = dyn_cast<ParmVarDecl>(D))
7239 QT = PD->getObjCDeclQualifier();
7240 if (QT == Decl::OBJC_TQ_None)
7241 return CXObjCDeclQualifier_None;
7242
7243 unsigned Result = CXObjCDeclQualifier_None;
7244 if (QT & Decl::OBJC_TQ_In) Result |= CXObjCDeclQualifier_In;
7245 if (QT & Decl::OBJC_TQ_Inout) Result |= CXObjCDeclQualifier_Inout;
7246 if (QT & Decl::OBJC_TQ_Out) Result |= CXObjCDeclQualifier_Out;
7247 if (QT & Decl::OBJC_TQ_Bycopy) Result |= CXObjCDeclQualifier_Bycopy;
7248 if (QT & Decl::OBJC_TQ_Byref) Result |= CXObjCDeclQualifier_Byref;
7249 if (QT & Decl::OBJC_TQ_Oneway) Result |= CXObjCDeclQualifier_Oneway;
7250
7251 return Result;
7252}
7253
Argyrios Kyrtzidis7b50fc52013-07-05 20:44:37 +00007254unsigned clang_Cursor_isObjCOptional(CXCursor C) {
7255 if (!clang_isDeclaration(C.kind))
7256 return 0;
7257
7258 const Decl *D = getCursorDecl(C);
7259 if (const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(D))
7260 return PD->getPropertyImplementation() == ObjCPropertyDecl::Optional;
7261 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7262 return MD->getImplementationControl() == ObjCMethodDecl::Optional;
7263
7264 return 0;
7265}
7266
Argyrios Kyrtzidis23814e42013-04-18 23:53:05 +00007267unsigned clang_Cursor_isVariadic(CXCursor C) {
7268 if (!clang_isDeclaration(C.kind))
7269 return 0;
7270
7271 const Decl *D = getCursorDecl(C);
7272 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7273 return FD->isVariadic();
7274 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7275 return MD->isVariadic();
7276
7277 return 0;
7278}
7279
Guy Benyei11169dd2012-12-18 14:30:41 +00007280CXSourceRange clang_Cursor_getCommentRange(CXCursor C) {
7281 if (!clang_isDeclaration(C.kind))
7282 return clang_getNullRange();
7283
7284 const Decl *D = getCursorDecl(C);
7285 ASTContext &Context = getCursorContext(C);
7286 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7287 if (!RC)
7288 return clang_getNullRange();
7289
7290 return cxloc::translateSourceRange(Context, RC->getSourceRange());
7291}
7292
7293CXString clang_Cursor_getRawCommentText(CXCursor C) {
7294 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007295 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007296
7297 const Decl *D = getCursorDecl(C);
7298 ASTContext &Context = getCursorContext(C);
7299 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7300 StringRef RawText = RC ? RC->getRawText(Context.getSourceManager()) :
7301 StringRef();
7302
7303 // Don't duplicate the string because RawText points directly into source
7304 // code.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007305 return cxstring::createRef(RawText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007306}
7307
7308CXString clang_Cursor_getBriefCommentText(CXCursor C) {
7309 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007310 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007311
7312 const Decl *D = getCursorDecl(C);
7313 const ASTContext &Context = getCursorContext(C);
7314 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7315
7316 if (RC) {
7317 StringRef BriefText = RC->getBriefText(Context);
7318
7319 // Don't duplicate the string because RawComment ensures that this memory
7320 // will not go away.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007321 return cxstring::createRef(BriefText);
Guy Benyei11169dd2012-12-18 14:30:41 +00007322 }
7323
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00007324 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00007325}
7326
Guy Benyei11169dd2012-12-18 14:30:41 +00007327CXModule clang_Cursor_getModule(CXCursor C) {
7328 if (C.kind == CXCursor_ModuleImportDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007329 if (const ImportDecl *ImportD =
7330 dyn_cast_or_null<ImportDecl>(getCursorDecl(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00007331 return ImportD->getImportedModule();
7332 }
7333
Craig Topper69186e72014-06-08 08:38:04 +00007334 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007335}
7336
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007337CXModule clang_getModuleForFile(CXTranslationUnit TU, CXFile File) {
7338 if (isNotUsableTU(TU)) {
7339 LOG_BAD_TU(TU);
7340 return nullptr;
7341 }
7342 if (!File)
7343 return nullptr;
7344 FileEntry *FE = static_cast<FileEntry *>(File);
7345
7346 ASTUnit &Unit = *cxtu::getASTUnit(TU);
7347 HeaderSearch &HS = Unit.getPreprocessor().getHeaderSearchInfo();
7348 ModuleMap::KnownHeader Header = HS.findModuleForHeader(FE);
7349
Richard Smithfeb54b62014-10-23 02:01:19 +00007350 return Header.getModule();
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00007351}
7352
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007353CXFile clang_Module_getASTFile(CXModule CXMod) {
7354 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007355 return nullptr;
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00007356 Module *Mod = static_cast<Module*>(CXMod);
7357 return const_cast<FileEntry *>(Mod->getASTFile());
7358}
7359
Guy Benyei11169dd2012-12-18 14:30:41 +00007360CXModule clang_Module_getParent(CXModule CXMod) {
7361 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007362 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007363 Module *Mod = static_cast<Module*>(CXMod);
7364 return Mod->Parent;
7365}
7366
7367CXString clang_Module_getName(CXModule CXMod) {
7368 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007369 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007370 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007371 return cxstring::createDup(Mod->Name);
Guy Benyei11169dd2012-12-18 14:30:41 +00007372}
7373
7374CXString clang_Module_getFullName(CXModule CXMod) {
7375 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007376 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007377 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007378 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00007379}
7380
Argyrios Kyrtzidis884337f2014-05-15 04:44:25 +00007381int clang_Module_isSystem(CXModule CXMod) {
7382 if (!CXMod)
7383 return 0;
7384 Module *Mod = static_cast<Module*>(CXMod);
7385 return Mod->IsSystem;
7386}
7387
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007388unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit TU,
7389 CXModule CXMod) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007390 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007391 LOG_BAD_TU(TU);
7392 return 0;
7393 }
7394 if (!CXMod)
Guy Benyei11169dd2012-12-18 14:30:41 +00007395 return 0;
7396 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007397 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
7398 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7399 return TopHeaders.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00007400}
7401
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007402CXFile clang_Module_getTopLevelHeader(CXTranslationUnit TU,
7403 CXModule CXMod, unsigned Index) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007404 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007405 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007406 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007407 }
7408 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00007409 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007410 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007411 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
Guy Benyei11169dd2012-12-18 14:30:41 +00007412
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00007413 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7414 if (Index < TopHeaders.size())
7415 return const_cast<FileEntry *>(TopHeaders[Index]);
Guy Benyei11169dd2012-12-18 14:30:41 +00007416
Craig Topper69186e72014-06-08 08:38:04 +00007417 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007418}
7419
7420} // end: extern "C"
7421
7422//===----------------------------------------------------------------------===//
7423// C++ AST instrospection.
7424//===----------------------------------------------------------------------===//
7425
7426extern "C" {
Jonathan Coe29565352016-04-27 12:48:25 +00007427
7428unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C) {
7429 if (!clang_isDeclaration(C.kind))
7430 return 0;
7431
7432 const Decl *D = cxcursor::getCursorDecl(C);
7433 const CXXConstructorDecl *Constructor =
7434 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7435 return (Constructor && Constructor->isDefaultConstructor()) ? 1 : 0;
7436}
7437
7438unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C) {
7439 if (!clang_isDeclaration(C.kind))
7440 return 0;
7441
7442 const Decl *D = cxcursor::getCursorDecl(C);
7443 const CXXConstructorDecl *Constructor =
7444 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7445 return (Constructor && Constructor->isCopyConstructor()) ? 1 : 0;
7446}
7447
7448unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C) {
7449 if (!clang_isDeclaration(C.kind))
7450 return 0;
7451
7452 const Decl *D = cxcursor::getCursorDecl(C);
7453 const CXXConstructorDecl *Constructor =
7454 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7455 return (Constructor && Constructor->isMoveConstructor()) ? 1 : 0;
7456}
7457
7458unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C) {
7459 if (!clang_isDeclaration(C.kind))
7460 return 0;
7461
7462 const Decl *D = cxcursor::getCursorDecl(C);
7463 const CXXConstructorDecl *Constructor =
7464 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
7465 // Passing 'false' excludes constructors marked 'explicit'.
7466 return (Constructor && Constructor->isConvertingConstructor(false)) ? 1 : 0;
7467}
7468
Saleem Abdulrasool6ea75db2015-10-27 15:50:22 +00007469unsigned clang_CXXField_isMutable(CXCursor C) {
7470 if (!clang_isDeclaration(C.kind))
7471 return 0;
7472
7473 if (const auto D = cxcursor::getCursorDecl(C))
7474 if (const auto FD = dyn_cast_or_null<FieldDecl>(D))
7475 return FD->isMutable() ? 1 : 0;
7476 return 0;
7477}
7478
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007479unsigned clang_CXXMethod_isPureVirtual(CXCursor C) {
7480 if (!clang_isDeclaration(C.kind))
7481 return 0;
7482
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007483 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007484 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007485 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenko62770be2013-05-17 18:38:35 +00007486 return (Method && Method->isVirtual() && Method->isPure()) ? 1 : 0;
7487}
7488
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007489unsigned clang_CXXMethod_isConst(CXCursor C) {
7490 if (!clang_isDeclaration(C.kind))
7491 return 0;
7492
7493 const Decl *D = cxcursor::getCursorDecl(C);
7494 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007495 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00007496 return (Method && (Method->getTypeQualifiers() & Qualifiers::Const)) ? 1 : 0;
7497}
7498
Jonathan Coe29565352016-04-27 12:48:25 +00007499unsigned clang_CXXMethod_isDefaulted(CXCursor C) {
7500 if (!clang_isDeclaration(C.kind))
7501 return 0;
7502
7503 const Decl *D = cxcursor::getCursorDecl(C);
7504 const CXXMethodDecl *Method =
7505 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7506 return (Method && Method->isDefaulted()) ? 1 : 0;
7507}
7508
Guy Benyei11169dd2012-12-18 14:30:41 +00007509unsigned clang_CXXMethod_isStatic(CXCursor C) {
7510 if (!clang_isDeclaration(C.kind))
7511 return 0;
7512
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007513 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007514 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007515 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007516 return (Method && Method->isStatic()) ? 1 : 0;
7517}
7518
7519unsigned clang_CXXMethod_isVirtual(CXCursor C) {
7520 if (!clang_isDeclaration(C.kind))
7521 return 0;
7522
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007523 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00007524 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00007525 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007526 return (Method && Method->isVirtual()) ? 1 : 0;
7527}
7528} // end: extern "C"
7529
7530//===----------------------------------------------------------------------===//
7531// Attribute introspection.
7532//===----------------------------------------------------------------------===//
7533
7534extern "C" {
7535CXType clang_getIBOutletCollectionType(CXCursor C) {
7536 if (C.kind != CXCursor_IBOutletCollectionAttr)
7537 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
7538
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00007539 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +00007540 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
7541
7542 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
7543}
7544} // end: extern "C"
7545
7546//===----------------------------------------------------------------------===//
7547// Inspecting memory usage.
7548//===----------------------------------------------------------------------===//
7549
7550typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
7551
7552static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
7553 enum CXTUResourceUsageKind k,
7554 unsigned long amount) {
7555 CXTUResourceUsageEntry entry = { k, amount };
7556 entries.push_back(entry);
7557}
7558
7559extern "C" {
7560
7561const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
7562 const char *str = "";
7563 switch (kind) {
7564 case CXTUResourceUsage_AST:
7565 str = "ASTContext: expressions, declarations, and types";
7566 break;
7567 case CXTUResourceUsage_Identifiers:
7568 str = "ASTContext: identifiers";
7569 break;
7570 case CXTUResourceUsage_Selectors:
7571 str = "ASTContext: selectors";
7572 break;
7573 case CXTUResourceUsage_GlobalCompletionResults:
7574 str = "Code completion: cached global results";
7575 break;
7576 case CXTUResourceUsage_SourceManagerContentCache:
7577 str = "SourceManager: content cache allocator";
7578 break;
7579 case CXTUResourceUsage_AST_SideTables:
7580 str = "ASTContext: side tables";
7581 break;
7582 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
7583 str = "SourceManager: malloc'ed memory buffers";
7584 break;
7585 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
7586 str = "SourceManager: mmap'ed memory buffers";
7587 break;
7588 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
7589 str = "ExternalASTSource: malloc'ed memory buffers";
7590 break;
7591 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
7592 str = "ExternalASTSource: mmap'ed memory buffers";
7593 break;
7594 case CXTUResourceUsage_Preprocessor:
7595 str = "Preprocessor: malloc'ed memory";
7596 break;
7597 case CXTUResourceUsage_PreprocessingRecord:
7598 str = "Preprocessor: PreprocessingRecord";
7599 break;
7600 case CXTUResourceUsage_SourceManager_DataStructures:
7601 str = "SourceManager: data structures and tables";
7602 break;
7603 case CXTUResourceUsage_Preprocessor_HeaderSearch:
7604 str = "Preprocessor: header search tables";
7605 break;
7606 }
7607 return str;
7608}
7609
7610CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007611 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007612 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00007613 CXTUResourceUsage usage = { (void*) nullptr, 0, nullptr };
Guy Benyei11169dd2012-12-18 14:30:41 +00007614 return usage;
7615 }
7616
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007617 ASTUnit *astUnit = cxtu::getASTUnit(TU);
Ahmed Charlesb8984322014-03-07 20:03:18 +00007618 std::unique_ptr<MemUsageEntries> entries(new MemUsageEntries());
Guy Benyei11169dd2012-12-18 14:30:41 +00007619 ASTContext &astContext = astUnit->getASTContext();
7620
7621 // How much memory is used by AST nodes and types?
7622 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
7623 (unsigned long) astContext.getASTAllocatedMemory());
7624
7625 // How much memory is used by identifiers?
7626 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
7627 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
7628
7629 // How much memory is used for selectors?
7630 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
7631 (unsigned long) astContext.Selectors.getTotalMemory());
7632
7633 // How much memory is used by ASTContext's side tables?
7634 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
7635 (unsigned long) astContext.getSideTableAllocatedMemory());
7636
7637 // How much memory is used for caching global code completion results?
7638 unsigned long completionBytes = 0;
7639 if (GlobalCodeCompletionAllocator *completionAllocator =
Alp Tokerf994cef2014-07-05 03:08:06 +00007640 astUnit->getCachedCompletionAllocator().get()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007641 completionBytes = completionAllocator->getTotalMemory();
7642 }
7643 createCXTUResourceUsageEntry(*entries,
7644 CXTUResourceUsage_GlobalCompletionResults,
7645 completionBytes);
7646
7647 // How much memory is being used by SourceManager's content cache?
7648 createCXTUResourceUsageEntry(*entries,
7649 CXTUResourceUsage_SourceManagerContentCache,
7650 (unsigned long) astContext.getSourceManager().getContentCacheSize());
7651
7652 // How much memory is being used by the MemoryBuffer's in SourceManager?
7653 const SourceManager::MemoryBufferSizes &srcBufs =
7654 astUnit->getSourceManager().getMemoryBufferSizes();
7655
7656 createCXTUResourceUsageEntry(*entries,
7657 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
7658 (unsigned long) srcBufs.malloc_bytes);
7659 createCXTUResourceUsageEntry(*entries,
7660 CXTUResourceUsage_SourceManager_Membuffer_MMap,
7661 (unsigned long) srcBufs.mmap_bytes);
7662 createCXTUResourceUsageEntry(*entries,
7663 CXTUResourceUsage_SourceManager_DataStructures,
7664 (unsigned long) astContext.getSourceManager()
7665 .getDataStructureSizes());
7666
7667 // How much memory is being used by the ExternalASTSource?
7668 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
7669 const ExternalASTSource::MemoryBufferSizes &sizes =
7670 esrc->getMemoryBufferSizes();
7671
7672 createCXTUResourceUsageEntry(*entries,
7673 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
7674 (unsigned long) sizes.malloc_bytes);
7675 createCXTUResourceUsageEntry(*entries,
7676 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
7677 (unsigned long) sizes.mmap_bytes);
7678 }
7679
7680 // How much memory is being used by the Preprocessor?
7681 Preprocessor &pp = astUnit->getPreprocessor();
7682 createCXTUResourceUsageEntry(*entries,
7683 CXTUResourceUsage_Preprocessor,
7684 pp.getTotalMemory());
7685
7686 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
7687 createCXTUResourceUsageEntry(*entries,
7688 CXTUResourceUsage_PreprocessingRecord,
7689 pRec->getTotalMemory());
7690 }
7691
7692 createCXTUResourceUsageEntry(*entries,
7693 CXTUResourceUsage_Preprocessor_HeaderSearch,
7694 pp.getHeaderSearchInfo().getTotalMemory());
Craig Topper69186e72014-06-08 08:38:04 +00007695
Guy Benyei11169dd2012-12-18 14:30:41 +00007696 CXTUResourceUsage usage = { (void*) entries.get(),
7697 (unsigned) entries->size(),
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00007698 !entries->empty() ? &(*entries)[0] : nullptr };
Ahmed Charles9a16beb2014-03-07 19:33:25 +00007699 entries.release();
Guy Benyei11169dd2012-12-18 14:30:41 +00007700 return usage;
7701}
7702
7703void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
7704 if (usage.data)
7705 delete (MemUsageEntries*) usage.data;
7706}
7707
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00007708CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit TU, CXFile file) {
7709 CXSourceRangeList *skipped = new CXSourceRangeList;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007710 skipped->count = 0;
Craig Topper69186e72014-06-08 08:38:04 +00007711 skipped->ranges = nullptr;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007712
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007713 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007714 LOG_BAD_TU(TU);
7715 return skipped;
7716 }
7717
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007718 if (!file)
7719 return skipped;
7720
7721 ASTUnit *astUnit = cxtu::getASTUnit(TU);
7722 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
7723 if (!ppRec)
7724 return skipped;
7725
7726 ASTContext &Ctx = astUnit->getASTContext();
7727 SourceManager &sm = Ctx.getSourceManager();
7728 FileEntry *fileEntry = static_cast<FileEntry *>(file);
7729 FileID wantedFileID = sm.translateFile(fileEntry);
7730
7731 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
7732 std::vector<SourceRange> wantedRanges;
7733 for (std::vector<SourceRange>::const_iterator i = SkippedRanges.begin(), ei = SkippedRanges.end();
7734 i != ei; ++i) {
7735 if (sm.getFileID(i->getBegin()) == wantedFileID || sm.getFileID(i->getEnd()) == wantedFileID)
7736 wantedRanges.push_back(*i);
7737 }
7738
7739 skipped->count = wantedRanges.size();
7740 skipped->ranges = new CXSourceRange[skipped->count];
7741 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
7742 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, wantedRanges[i]);
7743
7744 return skipped;
7745}
7746
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00007747void clang_disposeSourceRangeList(CXSourceRangeList *ranges) {
7748 if (ranges) {
7749 delete[] ranges->ranges;
7750 delete ranges;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00007751 }
7752}
7753
Guy Benyei11169dd2012-12-18 14:30:41 +00007754} // end extern "C"
7755
7756void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
7757 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
7758 for (unsigned I = 0; I != Usage.numEntries; ++I)
7759 fprintf(stderr, " %s: %lu\n",
7760 clang_getTUResourceUsageName(Usage.entries[I].kind),
7761 Usage.entries[I].amount);
7762
7763 clang_disposeCXTUResourceUsage(Usage);
7764}
7765
7766//===----------------------------------------------------------------------===//
7767// Misc. utility functions.
7768//===----------------------------------------------------------------------===//
7769
7770/// Default to using an 8 MB stack size on "safety" threads.
7771static unsigned SafetyStackThreadSize = 8 << 20;
7772
7773namespace clang {
7774
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007775bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn,
Guy Benyei11169dd2012-12-18 14:30:41 +00007776 unsigned Size) {
7777 if (!Size)
7778 Size = GetSafetyThreadStackSize();
7779 if (Size)
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007780 return CRC.RunSafelyOnThread(Fn, Size);
7781 return CRC.RunSafely(Fn);
Guy Benyei11169dd2012-12-18 14:30:41 +00007782}
7783
7784unsigned GetSafetyThreadStackSize() {
7785 return SafetyStackThreadSize;
7786}
7787
7788void SetSafetyThreadStackSize(unsigned Value) {
7789 SafetyStackThreadSize = Value;
7790}
7791
Alexander Kornienkoab9db512015-06-22 23:07:51 +00007792}
Guy Benyei11169dd2012-12-18 14:30:41 +00007793
7794void clang::setThreadBackgroundPriority() {
7795 if (getenv("LIBCLANG_BGPRIO_DISABLE"))
7796 return;
7797
Alp Toker1a86ad22014-07-06 06:24:00 +00007798#ifdef USE_DARWIN_THREADS
Guy Benyei11169dd2012-12-18 14:30:41 +00007799 setpriority(PRIO_DARWIN_THREAD, 0, PRIO_DARWIN_BG);
7800#endif
7801}
7802
7803void cxindex::printDiagsToStderr(ASTUnit *Unit) {
7804 if (!Unit)
7805 return;
7806
7807 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
7808 DEnd = Unit->stored_diag_end();
7809 D != DEnd; ++D) {
Ben Langmuir749323f2014-04-22 17:40:12 +00007810 CXStoredDiagnostic Diag(*D, Unit->getLangOpts());
Guy Benyei11169dd2012-12-18 14:30:41 +00007811 CXString Msg = clang_formatDiagnostic(&Diag,
7812 clang_defaultDiagnosticDisplayOptions());
7813 fprintf(stderr, "%s\n", clang_getCString(Msg));
7814 clang_disposeString(Msg);
7815 }
7816#ifdef LLVM_ON_WIN32
7817 // On Windows, force a flush, since there may be multiple copies of
7818 // stderr and stdout in the file system, all with different buffers
7819 // but writing to the same device.
7820 fflush(stderr);
7821#endif
7822}
7823
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007824MacroInfo *cxindex::getMacroInfo(const IdentifierInfo &II,
7825 SourceLocation MacroDefLoc,
7826 CXTranslationUnit TU){
7827 if (MacroDefLoc.isInvalid() || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007828 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007829 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00007830 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007831
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007832 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007833 Preprocessor &PP = Unit->getPreprocessor();
Richard Smith20e883e2015-04-29 23:20:19 +00007834 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00007835 if (MD) {
7836 for (MacroDirective::DefInfo
7837 Def = MD->getDefinition(); Def; Def = Def.getPreviousDefinition()) {
7838 if (MacroDefLoc == Def.getMacroInfo()->getDefinitionLoc())
7839 return Def.getMacroInfo();
7840 }
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007841 }
7842
Craig Topper69186e72014-06-08 08:38:04 +00007843 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007844}
7845
Richard Smith66a81862015-05-04 02:25:31 +00007846const MacroInfo *cxindex::getMacroInfo(const MacroDefinitionRecord *MacroDef,
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007847 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007848 if (!MacroDef || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007849 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007850 const IdentifierInfo *II = MacroDef->getName();
7851 if (!II)
Craig Topper69186e72014-06-08 08:38:04 +00007852 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007853
7854 return getMacroInfo(*II, MacroDef->getLocation(), TU);
7855}
7856
Richard Smith66a81862015-05-04 02:25:31 +00007857MacroDefinitionRecord *
7858cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, const Token &Tok,
7859 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007860 if (!MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007861 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007862 if (Tok.isNot(tok::raw_identifier))
Craig Topper69186e72014-06-08 08:38:04 +00007863 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007864
7865 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00007866 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007867 SourceRange DefRange(MI->getReplacementToken(0).getLocation(),
7868 MI->getDefinitionEndLoc());
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007869 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007870
7871 // Check that the token is inside the definition and not its argument list.
7872 SourceManager &SM = Unit->getSourceManager();
7873 if (SM.isBeforeInTranslationUnit(Tok.getLocation(), DefRange.getBegin()))
Craig Topper69186e72014-06-08 08:38:04 +00007874 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007875 if (SM.isBeforeInTranslationUnit(DefRange.getEnd(), Tok.getLocation()))
Craig Topper69186e72014-06-08 08:38:04 +00007876 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007877
7878 Preprocessor &PP = Unit->getPreprocessor();
7879 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
7880 if (!PPRec)
Craig Topper69186e72014-06-08 08:38:04 +00007881 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007882
Alp Toker2d57cea2014-05-17 04:53:25 +00007883 IdentifierInfo &II = PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007884 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00007885 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007886
7887 // Check that the identifier is not one of the macro arguments.
7888 if (std::find(MI->arg_begin(), MI->arg_end(), &II) != MI->arg_end())
Craig Topper69186e72014-06-08 08:38:04 +00007889 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007890
Richard Smith20e883e2015-04-29 23:20:19 +00007891 MacroDirective *InnerMD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00007892 if (!InnerMD)
Craig Topper69186e72014-06-08 08:38:04 +00007893 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007894
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00007895 return PPRec->findMacroDefinition(InnerMD->getMacroInfo());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007896}
7897
Richard Smith66a81862015-05-04 02:25:31 +00007898MacroDefinitionRecord *
7899cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc,
7900 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007901 if (Loc.isInvalid() || !MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00007902 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007903
7904 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00007905 return nullptr;
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007906 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007907 Preprocessor &PP = Unit->getPreprocessor();
7908 if (!PP.getPreprocessingRecord())
Craig Topper69186e72014-06-08 08:38:04 +00007909 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007910 Loc = Unit->getSourceManager().getSpellingLoc(Loc);
7911 Token Tok;
7912 if (PP.getRawToken(Loc, Tok))
Craig Topper69186e72014-06-08 08:38:04 +00007913 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007914
7915 return checkForMacroInMacroDefinition(MI, Tok, TU);
7916}
7917
Guy Benyei11169dd2012-12-18 14:30:41 +00007918extern "C" {
7919
7920CXString clang_getClangVersion() {
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00007921 return cxstring::createDup(getClangFullVersion());
Guy Benyei11169dd2012-12-18 14:30:41 +00007922}
7923
7924} // end: extern "C"
7925
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007926Logger &cxindex::Logger::operator<<(CXTranslationUnit TU) {
7927 if (TU) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007928 if (ASTUnit *Unit = cxtu::getASTUnit(TU)) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007929 LogOS << '<' << Unit->getMainFileName() << '>';
Argyrios Kyrtzidis37f2ab42013-03-05 20:21:14 +00007930 if (Unit->isMainFileAST())
7931 LogOS << " (" << Unit->getASTFileName() << ')';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007932 return *this;
7933 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00007934 } else {
7935 LogOS << "<NULL TU>";
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007936 }
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007937 return *this;
7938}
7939
Argyrios Kyrtzidisba4b5f82013-03-08 02:32:26 +00007940Logger &cxindex::Logger::operator<<(const FileEntry *FE) {
7941 *this << FE->getName();
7942 return *this;
7943}
7944
7945Logger &cxindex::Logger::operator<<(CXCursor cursor) {
7946 CXString cursorName = clang_getCursorDisplayName(cursor);
7947 *this << cursorName << "@" << clang_getCursorLocation(cursor);
7948 clang_disposeString(cursorName);
7949 return *this;
7950}
7951
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007952Logger &cxindex::Logger::operator<<(CXSourceLocation Loc) {
7953 CXFile File;
7954 unsigned Line, Column;
Craig Topper69186e72014-06-08 08:38:04 +00007955 clang_getFileLocation(Loc, &File, &Line, &Column, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007956 CXString FileName = clang_getFileName(File);
7957 *this << llvm::format("(%s:%d:%d)", clang_getCString(FileName), Line, Column);
7958 clang_disposeString(FileName);
7959 return *this;
7960}
7961
7962Logger &cxindex::Logger::operator<<(CXSourceRange range) {
7963 CXSourceLocation BLoc = clang_getRangeStart(range);
7964 CXSourceLocation ELoc = clang_getRangeEnd(range);
7965
7966 CXFile BFile;
7967 unsigned BLine, BColumn;
Craig Topper69186e72014-06-08 08:38:04 +00007968 clang_getFileLocation(BLoc, &BFile, &BLine, &BColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007969
7970 CXFile EFile;
7971 unsigned ELine, EColumn;
Craig Topper69186e72014-06-08 08:38:04 +00007972 clang_getFileLocation(ELoc, &EFile, &ELine, &EColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007973
7974 CXString BFileName = clang_getFileName(BFile);
7975 if (BFile == EFile) {
7976 *this << llvm::format("[%s %d:%d-%d:%d]", clang_getCString(BFileName),
7977 BLine, BColumn, ELine, EColumn);
7978 } else {
7979 CXString EFileName = clang_getFileName(EFile);
7980 *this << llvm::format("[%s:%d:%d - ", clang_getCString(BFileName),
7981 BLine, BColumn)
7982 << llvm::format("%s:%d:%d]", clang_getCString(EFileName),
7983 ELine, EColumn);
7984 clang_disposeString(EFileName);
7985 }
7986 clang_disposeString(BFileName);
7987 return *this;
7988}
7989
7990Logger &cxindex::Logger::operator<<(CXString Str) {
7991 *this << clang_getCString(Str);
7992 return *this;
7993}
7994
7995Logger &cxindex::Logger::operator<<(const llvm::format_object_base &Fmt) {
7996 LogOS << Fmt;
7997 return *this;
7998}
7999
Chandler Carruth37ad2582014-06-27 15:14:39 +00008000static llvm::ManagedStatic<llvm::sys::Mutex> LoggingMutex;
8001
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008002cxindex::Logger::~Logger() {
Chandler Carruth37ad2582014-06-27 15:14:39 +00008003 llvm::sys::ScopedLock L(*LoggingMutex);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008004
8005 static llvm::TimeRecord sBeginTR = llvm::TimeRecord::getCurrentTime();
8006
Dmitri Gribenkof8579502013-01-12 19:30:44 +00008007 raw_ostream &OS = llvm::errs();
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008008 OS << "[libclang:" << Name << ':';
8009
Alp Toker1a86ad22014-07-06 06:24:00 +00008010#ifdef USE_DARWIN_THREADS
8011 // TODO: Portability.
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008012 mach_port_t tid = pthread_mach_thread_np(pthread_self());
8013 OS << tid << ':';
8014#endif
8015
8016 llvm::TimeRecord TR = llvm::TimeRecord::getCurrentTime();
8017 OS << llvm::format("%7.4f] ", TR.getWallTime() - sBeginTR.getWallTime());
Yaron Keren09fb7c62015-03-10 07:33:23 +00008018 OS << Msg << '\n';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008019
8020 if (Trace) {
Zachary Turner1fe2a8d2015-03-05 19:15:09 +00008021 llvm::sys::PrintStackTrace(OS);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008022 OS << "--------------------------------------------------\n";
8023 }
8024}
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008025
8026#ifdef CLANG_TOOL_EXTRA_BUILD
8027// This anchor is used to force the linker to link the clang-tidy plugin.
8028extern volatile int ClangTidyPluginAnchorSource;
8029static int LLVM_ATTRIBUTE_UNUSED ClangTidyPluginAnchorDestination =
8030 ClangTidyPluginAnchorSource;
8031#endif