blob: 001c8da2643cb2fcccffc93b5917280877a6744b [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===- CIndex.cpp - Clang-C Source Indexing Library -----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the main API hooks in the Clang-C Source Indexing
11// library.
12//
13//===----------------------------------------------------------------------===//
14
Guy Benyei11169dd2012-12-18 14:30:41 +000015#include "CIndexDiagnostic.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000016#include "CIndexer.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000017#include "CLog.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "CXCursor.h"
19#include "CXSourceLocation.h"
20#include "CXString.h"
21#include "CXTranslationUnit.h"
22#include "CXType.h"
23#include "CursorVisitor.h"
David Blaikie0a4e61f2013-09-13 18:32:52 +000024#include "clang/AST/Attr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000025#include "clang/AST/StmtVisitor.h"
26#include "clang/Basic/Diagnostic.h"
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000027#include "clang/Basic/DiagnosticCategories.h"
28#include "clang/Basic/DiagnosticIDs.h"
Richard Smith0a7b2972018-07-03 21:34:13 +000029#include "clang/Basic/Stack.h"
Emilio Cobos Alvarez485ad422017-04-28 15:56:39 +000030#include "clang/Basic/TargetInfo.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000031#include "clang/Basic/Version.h"
32#include "clang/Frontend/ASTUnit.h"
33#include "clang/Frontend/CompilerInstance.h"
34#include "clang/Frontend/FrontendDiagnostic.h"
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +000035#include "clang/Index/CodegenNameGenerator.h"
Dmitri Gribenko9e605112013-11-13 22:16:51 +000036#include "clang/Index/CommentToXML.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000037#include "clang/Lex/HeaderSearch.h"
38#include "clang/Lex/Lexer.h"
39#include "clang/Lex/PreprocessingRecord.h"
40#include "clang/Lex/Preprocessor.h"
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000041#include "clang/Serialization/SerializationDiagnostic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000042#include "llvm/ADT/Optional.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/StringSwitch.h"
Alp Toker1d257e12014-06-04 03:28:55 +000045#include "llvm/Config/llvm-config.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000046#include "llvm/Support/Compiler.h"
47#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth4b417452013-01-19 08:09:44 +000048#include "llvm/Support/Format.h"
Chandler Carruth37ad2582014-06-27 15:14:39 +000049#include "llvm/Support/ManagedStatic.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000050#include "llvm/Support/MemoryBuffer.h"
51#include "llvm/Support/Mutex.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000052#include "llvm/Support/Program.h"
53#include "llvm/Support/SaveAndRestore.h"
54#include "llvm/Support/Signals.h"
Adrian Prantlbc068582015-07-08 01:00:30 +000055#include "llvm/Support/TargetSelect.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000056#include "llvm/Support/Threading.h"
57#include "llvm/Support/Timer.h"
58#include "llvm/Support/raw_ostream.h"
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000059
Alp Toker1a86ad22014-07-06 06:24:00 +000060#if LLVM_ENABLE_THREADS != 0 && defined(__APPLE__)
61#define USE_DARWIN_THREADS
62#endif
63
64#ifdef USE_DARWIN_THREADS
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +000065#include <pthread.h>
66#endif
Guy Benyei11169dd2012-12-18 14:30:41 +000067
68using namespace clang;
69using namespace clang::cxcursor;
Guy Benyei11169dd2012-12-18 14:30:41 +000070using namespace clang::cxtu;
71using namespace clang::cxindex;
72
David Blaikieea4395e2017-01-06 19:49:01 +000073CXTranslationUnit cxtu::MakeCXTranslationUnit(CIndexer *CIdx,
74 std::unique_ptr<ASTUnit> AU) {
Dmitri Gribenkod36209e2013-01-26 21:32:42 +000075 if (!AU)
Craig Topper69186e72014-06-08 08:38:04 +000076 return nullptr;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000077 assert(CIdx);
Guy Benyei11169dd2012-12-18 14:30:41 +000078 CXTranslationUnit D = new CXTranslationUnitImpl();
79 D->CIdx = CIdx;
David Blaikieea4395e2017-01-06 19:49:01 +000080 D->TheASTUnit = AU.release();
Dmitri Gribenko74895212013-02-03 13:52:47 +000081 D->StringPool = new cxstring::CXStringPool();
Craig Topper69186e72014-06-08 08:38:04 +000082 D->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +000083 D->OverridenCursorsPool = createOverridenCXCursorsPool();
Craig Topper69186e72014-06-08 08:38:04 +000084 D->CommentToXML = nullptr;
Alex Lorenz690f0e22017-12-07 20:37:50 +000085 D->ParsingOptions = 0;
86 D->Arguments = {};
Guy Benyei11169dd2012-12-18 14:30:41 +000087 return D;
88}
89
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +000090bool cxtu::isASTReadError(ASTUnit *AU) {
91 for (ASTUnit::stored_diag_iterator D = AU->stored_diag_begin(),
92 DEnd = AU->stored_diag_end();
93 D != DEnd; ++D) {
94 if (D->getLevel() >= DiagnosticsEngine::Error &&
95 DiagnosticIDs::getCategoryNumberForDiag(D->getID()) ==
96 diag::DiagCat_AST_Deserialization_Issue)
97 return true;
98 }
99 return false;
100}
101
Guy Benyei11169dd2012-12-18 14:30:41 +0000102cxtu::CXTUOwner::~CXTUOwner() {
103 if (TU)
104 clang_disposeTranslationUnit(TU);
105}
106
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000107/// Compare two source ranges to determine their relative position in
Guy Benyei11169dd2012-12-18 14:30:41 +0000108/// the translation unit.
109static RangeComparisonResult RangeCompare(SourceManager &SM,
110 SourceRange R1,
111 SourceRange R2) {
112 assert(R1.isValid() && "First range is invalid?");
113 assert(R2.isValid() && "Second range is invalid?");
114 if (R1.getEnd() != R2.getBegin() &&
115 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
116 return RangeBefore;
117 if (R2.getEnd() != R1.getBegin() &&
118 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
119 return RangeAfter;
120 return RangeOverlap;
121}
122
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000123/// Determine if a source location falls within, before, or after a
Guy Benyei11169dd2012-12-18 14:30:41 +0000124/// a given source range.
125static RangeComparisonResult LocationCompare(SourceManager &SM,
126 SourceLocation L, SourceRange R) {
127 assert(R.isValid() && "First range is invalid?");
128 assert(L.isValid() && "Second range is invalid?");
129 if (L == R.getBegin() || L == R.getEnd())
130 return RangeOverlap;
131 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
132 return RangeBefore;
133 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
134 return RangeAfter;
135 return RangeOverlap;
136}
137
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000138/// Translate a Clang source range into a CIndex source range.
Guy Benyei11169dd2012-12-18 14:30:41 +0000139///
140/// Clang internally represents ranges where the end location points to the
141/// start of the token at the end. However, for external clients it is more
142/// useful to have a CXSourceRange be a proper half-open interval. This routine
143/// does the appropriate translation.
144CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
145 const LangOptions &LangOpts,
146 const CharSourceRange &R) {
147 // We want the last character in this location, so we will adjust the
148 // location accordingly.
149 SourceLocation EndLoc = R.getEnd();
Richard Smithb5f81712018-04-30 05:25:48 +0000150 bool IsTokenRange = R.isTokenRange();
151 if (EndLoc.isValid() && EndLoc.isMacroID() && !SM.isMacroArgExpansion(EndLoc)) {
152 CharSourceRange Expansion = SM.getExpansionRange(EndLoc);
153 EndLoc = Expansion.getEnd();
154 IsTokenRange = Expansion.isTokenRange();
155 }
156 if (IsTokenRange && EndLoc.isValid()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000157 unsigned Length = Lexer::MeasureTokenLength(SM.getSpellingLoc(EndLoc),
158 SM, LangOpts);
159 EndLoc = EndLoc.getLocWithOffset(Length);
160 }
161
Bill Wendlingeade3622013-01-23 08:25:41 +0000162 CXSourceRange Result = {
Dmitri Gribenkof9304482013-01-23 15:56:07 +0000163 { &SM, &LangOpts },
Bill Wendlingeade3622013-01-23 08:25:41 +0000164 R.getBegin().getRawEncoding(),
165 EndLoc.getRawEncoding()
166 };
Guy Benyei11169dd2012-12-18 14:30:41 +0000167 return Result;
168}
169
170//===----------------------------------------------------------------------===//
171// Cursor visitor.
172//===----------------------------------------------------------------------===//
173
174static SourceRange getRawCursorExtent(CXCursor C);
175static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
176
177
178RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
179 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
180}
181
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000182/// Visit the given cursor and, if requested by the visitor,
Guy Benyei11169dd2012-12-18 14:30:41 +0000183/// its children.
184///
185/// \param Cursor the cursor to visit.
186///
187/// \param CheckedRegionOfInterest if true, then the caller already checked
188/// that this cursor is within the region of interest.
189///
190/// \returns true if the visitation should be aborted, false if it
191/// should continue.
192bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
193 if (clang_isInvalid(Cursor.kind))
194 return false;
195
196 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000197 const Decl *D = getCursorDecl(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +0000198 if (!D) {
199 assert(0 && "Invalid declaration cursor");
200 return true; // abort.
201 }
202
203 // Ignore implicit declarations, unless it's an objc method because
204 // currently we should report implicit methods for properties when indexing.
205 if (D->isImplicit() && !isa<ObjCMethodDecl>(D))
206 return false;
207 }
208
209 // If we have a range of interest, and this cursor doesn't intersect with it,
210 // we're done.
211 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
212 SourceRange Range = getRawCursorExtent(Cursor);
213 if (Range.isInvalid() || CompareRegionOfInterest(Range))
214 return false;
215 }
216
217 switch (Visitor(Cursor, Parent, ClientData)) {
218 case CXChildVisit_Break:
219 return true;
220
221 case CXChildVisit_Continue:
222 return false;
223
224 case CXChildVisit_Recurse: {
225 bool ret = VisitChildren(Cursor);
226 if (PostChildrenVisitor)
227 if (PostChildrenVisitor(Cursor, ClientData))
228 return true;
229 return ret;
230 }
231 }
232
233 llvm_unreachable("Invalid CXChildVisitResult!");
234}
235
236static bool visitPreprocessedEntitiesInRange(SourceRange R,
237 PreprocessingRecord &PPRec,
238 CursorVisitor &Visitor) {
239 SourceManager &SM = Visitor.getASTUnit()->getSourceManager();
240 FileID FID;
241
242 if (!Visitor.shouldVisitIncludedEntities()) {
243 // If the begin/end of the range lie in the same FileID, do the optimization
244 // where we skip preprocessed entities that do not come from the same FileID.
245 FID = SM.getFileID(SM.getFileLoc(R.getBegin()));
246 if (FID != SM.getFileID(SM.getFileLoc(R.getEnd())))
247 FID = FileID();
248 }
249
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000250 const auto &Entities = PPRec.getPreprocessedEntitiesInRange(R);
251 return Visitor.visitPreprocessedEntities(Entities.begin(), Entities.end(),
Guy Benyei11169dd2012-12-18 14:30:41 +0000252 PPRec, FID);
253}
254
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000255bool CursorVisitor::visitFileRegion() {
Guy Benyei11169dd2012-12-18 14:30:41 +0000256 if (RegionOfInterest.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000257 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000258
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000259 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000260 SourceManager &SM = Unit->getSourceManager();
261
262 std::pair<FileID, unsigned>
263 Begin = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getBegin())),
264 End = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getEnd()));
265
266 if (End.first != Begin.first) {
267 // If the end does not reside in the same file, try to recover by
268 // picking the end of the file of begin location.
269 End.first = Begin.first;
270 End.second = SM.getFileIDSize(Begin.first);
271 }
272
273 assert(Begin.first == End.first);
274 if (Begin.second > End.second)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000275 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000276
277 FileID File = Begin.first;
278 unsigned Offset = Begin.second;
279 unsigned Length = End.second - Begin.second;
280
281 if (!VisitDeclsOnly && !VisitPreprocessorLast)
282 if (visitPreprocessedEntitiesInRegion())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000283 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000284
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000285 if (visitDeclsFromFileRegion(File, Offset, Length))
286 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000287
288 if (!VisitDeclsOnly && VisitPreprocessorLast)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000289 return visitPreprocessedEntitiesInRegion();
290
291 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000292}
293
294static bool isInLexicalContext(Decl *D, DeclContext *DC) {
295 if (!DC)
296 return false;
297
298 for (DeclContext *DeclDC = D->getLexicalDeclContext();
299 DeclDC; DeclDC = DeclDC->getLexicalParent()) {
300 if (DeclDC == DC)
301 return true;
302 }
303 return false;
304}
305
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000306bool CursorVisitor::visitDeclsFromFileRegion(FileID File,
Guy Benyei11169dd2012-12-18 14:30:41 +0000307 unsigned Offset, unsigned Length) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000308 ASTUnit *Unit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000309 SourceManager &SM = Unit->getSourceManager();
310 SourceRange Range = RegionOfInterest;
311
312 SmallVector<Decl *, 16> Decls;
313 Unit->findFileRegionDecls(File, Offset, Length, Decls);
314
315 // If we didn't find any file level decls for the file, try looking at the
316 // file that it was included from.
317 while (Decls.empty() || Decls.front()->isTopLevelDeclInObjCContainer()) {
318 bool Invalid = false;
319 const SrcMgr::SLocEntry &SLEntry = SM.getSLocEntry(File, &Invalid);
320 if (Invalid)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000321 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000322
323 SourceLocation Outer;
324 if (SLEntry.isFile())
325 Outer = SLEntry.getFile().getIncludeLoc();
326 else
327 Outer = SLEntry.getExpansion().getExpansionLocStart();
328 if (Outer.isInvalid())
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000329 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000330
Benjamin Kramer867ea1d2014-03-02 13:01:17 +0000331 std::tie(File, Offset) = SM.getDecomposedExpansionLoc(Outer);
Guy Benyei11169dd2012-12-18 14:30:41 +0000332 Length = 0;
333 Unit->findFileRegionDecls(File, Offset, Length, Decls);
334 }
335
336 assert(!Decls.empty());
337
338 bool VisitedAtLeastOnce = false;
Craig Topper69186e72014-06-08 08:38:04 +0000339 DeclContext *CurDC = nullptr;
Craig Topper2341c0d2013-07-04 03:08:24 +0000340 SmallVectorImpl<Decl *>::iterator DIt = Decls.begin();
341 for (SmallVectorImpl<Decl *>::iterator DE = Decls.end(); DIt != DE; ++DIt) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000342 Decl *D = *DIt;
343 if (D->getSourceRange().isInvalid())
344 continue;
345
346 if (isInLexicalContext(D, CurDC))
347 continue;
348
349 CurDC = dyn_cast<DeclContext>(D);
350
351 if (TagDecl *TD = dyn_cast<TagDecl>(D))
352 if (!TD->isFreeStanding())
353 continue;
354
355 RangeComparisonResult CompRes = RangeCompare(SM, D->getSourceRange(),Range);
356 if (CompRes == RangeBefore)
357 continue;
358 if (CompRes == RangeAfter)
359 break;
360
361 assert(CompRes == RangeOverlap);
362 VisitedAtLeastOnce = true;
363
364 if (isa<ObjCContainerDecl>(D)) {
365 FileDI_current = &DIt;
366 FileDE_current = DE;
367 } else {
Craig Topper69186e72014-06-08 08:38:04 +0000368 FileDI_current = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000369 }
370
371 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000372 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000373 }
374
375 if (VisitedAtLeastOnce)
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000376 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000377
378 // No Decls overlapped with the range. Move up the lexical context until there
379 // is a context that contains the range or we reach the translation unit
380 // level.
381 DeclContext *DC = DIt == Decls.begin() ? (*DIt)->getLexicalDeclContext()
382 : (*(DIt-1))->getLexicalDeclContext();
383
384 while (DC && !DC->isTranslationUnit()) {
385 Decl *D = cast<Decl>(DC);
386 SourceRange CurDeclRange = D->getSourceRange();
387 if (CurDeclRange.isInvalid())
388 break;
389
390 if (RangeCompare(SM, CurDeclRange, Range) == RangeOverlap) {
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000391 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
392 return true; // visitation break.
Guy Benyei11169dd2012-12-18 14:30:41 +0000393 }
394
395 DC = D->getLexicalDeclContext();
396 }
Argyrios Kyrtzidis951f61f2013-03-08 20:42:33 +0000397
398 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000399}
400
401bool CursorVisitor::visitPreprocessedEntitiesInRegion() {
402 if (!AU->getPreprocessor().getPreprocessingRecord())
403 return false;
404
405 PreprocessingRecord &PPRec
406 = *AU->getPreprocessor().getPreprocessingRecord();
407 SourceManager &SM = AU->getSourceManager();
408
409 if (RegionOfInterest.isValid()) {
410 SourceRange MappedRange = AU->mapRangeToPreamble(RegionOfInterest);
411 SourceLocation B = MappedRange.getBegin();
412 SourceLocation E = MappedRange.getEnd();
413
414 if (AU->isInPreambleFileID(B)) {
415 if (SM.isLoadedSourceLocation(E))
416 return visitPreprocessedEntitiesInRange(SourceRange(B, E),
417 PPRec, *this);
418
419 // Beginning of range lies in the preamble but it also extends beyond
420 // it into the main file. Split the range into 2 parts, one covering
421 // the preamble and another covering the main file. This allows subsequent
422 // calls to visitPreprocessedEntitiesInRange to accept a source range that
423 // lies in the same FileID, allowing it to skip preprocessed entities that
424 // do not come from the same FileID.
425 bool breaked =
426 visitPreprocessedEntitiesInRange(
427 SourceRange(B, AU->getEndOfPreambleFileID()),
428 PPRec, *this);
429 if (breaked) return true;
430 return visitPreprocessedEntitiesInRange(
431 SourceRange(AU->getStartOfMainFileID(), E),
432 PPRec, *this);
433 }
434
435 return visitPreprocessedEntitiesInRange(SourceRange(B, E), PPRec, *this);
436 }
437
438 bool OnlyLocalDecls
439 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
440
441 if (OnlyLocalDecls)
442 return visitPreprocessedEntities(PPRec.local_begin(), PPRec.local_end(),
443 PPRec);
444
445 return visitPreprocessedEntities(PPRec.begin(), PPRec.end(), PPRec);
446}
447
448template<typename InputIterator>
449bool CursorVisitor::visitPreprocessedEntities(InputIterator First,
450 InputIterator Last,
451 PreprocessingRecord &PPRec,
452 FileID FID) {
453 for (; First != Last; ++First) {
454 if (!FID.isInvalid() && !PPRec.isEntityInFileID(First, FID))
455 continue;
456
457 PreprocessedEntity *PPE = *First;
Argyrios Kyrtzidis1030f262013-05-07 20:37:17 +0000458 if (!PPE)
459 continue;
460
Guy Benyei11169dd2012-12-18 14:30:41 +0000461 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(PPE)) {
462 if (Visit(MakeMacroExpansionCursor(ME, TU)))
463 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000464
Guy Benyei11169dd2012-12-18 14:30:41 +0000465 continue;
466 }
Richard Smith66a81862015-05-04 02:25:31 +0000467
468 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(PPE)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000469 if (Visit(MakeMacroDefinitionCursor(MD, TU)))
470 return true;
Richard Smith66a81862015-05-04 02:25:31 +0000471
Guy Benyei11169dd2012-12-18 14:30:41 +0000472 continue;
473 }
474
475 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
476 if (Visit(MakeInclusionDirectiveCursor(ID, TU)))
477 return true;
478
479 continue;
480 }
481 }
482
483 return false;
484}
485
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000486/// Visit the children of the given cursor.
Guy Benyei11169dd2012-12-18 14:30:41 +0000487///
488/// \returns true if the visitation should be aborted, false if it
489/// should continue.
490bool CursorVisitor::VisitChildren(CXCursor Cursor) {
491 if (clang_isReference(Cursor.kind) &&
492 Cursor.kind != CXCursor_CXXBaseSpecifier) {
493 // By definition, references have no children.
494 return false;
495 }
496
497 // Set the Parent field to Cursor, then back to its old value once we're
498 // done.
499 SetParentRAII SetParent(Parent, StmtParent, Cursor);
500
501 if (clang_isDeclaration(Cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +0000502 Decl *D = const_cast<Decl *>(getCursorDecl(Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +0000503 if (!D)
504 return false;
505
506 return VisitAttributes(D) || Visit(D);
507 }
508
509 if (clang_isStatement(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000510 if (const Stmt *S = getCursorStmt(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000511 return Visit(S);
512
513 return false;
514 }
515
516 if (clang_isExpression(Cursor.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +0000517 if (const Expr *E = getCursorExpr(Cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +0000518 return Visit(E);
519
520 return false;
521 }
522
523 if (clang_isTranslationUnit(Cursor.kind)) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +0000524 CXTranslationUnit TU = getCursorTU(Cursor);
525 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +0000526
527 int VisitOrder[2] = { VisitPreprocessorLast, !VisitPreprocessorLast };
528 for (unsigned I = 0; I != 2; ++I) {
529 if (VisitOrder[I]) {
530 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
531 RegionOfInterest.isInvalid()) {
532 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
533 TLEnd = CXXUnit->top_level_end();
534 TL != TLEnd; ++TL) {
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000535 const Optional<bool> V = handleDeclForVisitation(*TL);
536 if (!V.hasValue())
537 continue;
538 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000539 }
540 } else if (VisitDeclContext(
541 CXXUnit->getASTContext().getTranslationUnitDecl()))
542 return true;
543 continue;
544 }
545
546 // Walk the preprocessing record.
547 if (CXXUnit->getPreprocessor().getPreprocessingRecord())
548 visitPreprocessedEntitiesInRegion();
549 }
550
551 return false;
552 }
553
554 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000555 if (const CXXBaseSpecifier *Base = getCursorCXXBaseSpecifier(Cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000556 if (TypeSourceInfo *BaseTSInfo = Base->getTypeSourceInfo()) {
557 return Visit(BaseTSInfo->getTypeLoc());
558 }
559 }
560 }
561
562 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +0000563 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +0000564 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(Cursor));
Richard Smithb1f9a282013-10-31 01:56:18 +0000565 if (const ObjCObjectType *ObjT = A->getInterface()->getAs<ObjCObjectType>())
Richard Smithb87c4652013-10-31 21:23:20 +0000566 return Visit(cxcursor::MakeCursorObjCClassRef(
567 ObjT->getInterface(),
568 A->getInterfaceLoc()->getTypeLoc().getLocStart(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +0000569 }
570
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000571 // If pointing inside a macro definition, check if the token is an identifier
572 // that was ever defined as a macro. In such a case, create a "pseudo" macro
573 // expansion cursor for that token.
574 SourceLocation BeginLoc = RegionOfInterest.getBegin();
575 if (Cursor.kind == CXCursor_MacroDefinition &&
576 BeginLoc == RegionOfInterest.getEnd()) {
577 SourceLocation Loc = AU->mapLocationToPreamble(BeginLoc);
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +0000578 const MacroInfo *MI =
579 getMacroInfo(cxcursor::getCursorMacroDefinition(Cursor), TU);
Richard Smith66a81862015-05-04 02:25:31 +0000580 if (MacroDefinitionRecord *MacroDef =
581 checkForMacroInMacroDefinition(MI, Loc, TU))
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +0000582 return Visit(cxcursor::MakeMacroExpansionCursor(MacroDef, BeginLoc, TU));
583 }
584
Guy Benyei11169dd2012-12-18 14:30:41 +0000585 // Nothing to visit at the moment.
586 return false;
587}
588
589bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
590 if (TypeSourceInfo *TSInfo = B->getSignatureAsWritten())
591 if (Visit(TSInfo->getTypeLoc()))
592 return true;
593
594 if (Stmt *Body = B->getBody())
595 return Visit(MakeCXCursor(Body, StmtParent, TU, RegionOfInterest));
596
597 return false;
598}
599
Ted Kremenek03325582013-02-21 01:29:01 +0000600Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000601 if (RegionOfInterest.isValid()) {
602 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
603 if (Range.isInvalid())
David Blaikie7a30dc52013-02-21 01:47:18 +0000604 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000605
606 switch (CompareRegionOfInterest(Range)) {
607 case RangeBefore:
608 // This declaration comes before the region of interest; skip it.
David Blaikie7a30dc52013-02-21 01:47:18 +0000609 return None;
Guy Benyei11169dd2012-12-18 14:30:41 +0000610
611 case RangeAfter:
612 // This declaration comes after the region of interest; we're done.
613 return false;
614
615 case RangeOverlap:
616 // This declaration overlaps the region of interest; visit it.
617 break;
618 }
619 }
620 return true;
621}
622
623bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
624 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
625
626 // FIXME: Eventually remove. This part of a hack to support proper
627 // iteration over all Decls contained lexically within an ObjC container.
628 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
629 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
630
631 for ( ; I != E; ++I) {
632 Decl *D = *I;
633 if (D->getLexicalDeclContext() != DC)
634 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000635 const Optional<bool> V = handleDeclForVisitation(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000636 if (!V.hasValue())
637 continue;
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000638 return V.getValue();
Guy Benyei11169dd2012-12-18 14:30:41 +0000639 }
640 return false;
641}
642
Argyrios Kyrtzidise7c91042016-07-01 19:10:54 +0000643Optional<bool> CursorVisitor::handleDeclForVisitation(const Decl *D) {
644 CXCursor Cursor = MakeCXCursor(D, TU, RegionOfInterest);
645
646 // Ignore synthesized ivars here, otherwise if we have something like:
647 // @synthesize prop = _prop;
648 // and '_prop' is not declared, we will encounter a '_prop' ivar before
649 // encountering the 'prop' synthesize declaration and we will think that
650 // we passed the region-of-interest.
651 if (auto *ivarD = dyn_cast<ObjCIvarDecl>(D)) {
652 if (ivarD->getSynthesize())
653 return None;
654 }
655
656 // FIXME: ObjCClassRef/ObjCProtocolRef for forward class/protocol
657 // declarations is a mismatch with the compiler semantics.
658 if (Cursor.kind == CXCursor_ObjCInterfaceDecl) {
659 auto *ID = cast<ObjCInterfaceDecl>(D);
660 if (!ID->isThisDeclarationADefinition())
661 Cursor = MakeCursorObjCClassRef(ID, ID->getLocation(), TU);
662
663 } else if (Cursor.kind == CXCursor_ObjCProtocolDecl) {
664 auto *PD = cast<ObjCProtocolDecl>(D);
665 if (!PD->isThisDeclarationADefinition())
666 Cursor = MakeCursorObjCProtocolRef(PD, PD->getLocation(), TU);
667 }
668
669 const Optional<bool> V = shouldVisitCursor(Cursor);
670 if (!V.hasValue())
671 return None;
672 if (!V.getValue())
673 return false;
674 if (Visit(Cursor, true))
675 return true;
676 return None;
677}
678
Guy Benyei11169dd2012-12-18 14:30:41 +0000679bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
680 llvm_unreachable("Translation units are visited directly by Visit()");
681}
682
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +0000683bool CursorVisitor::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
684 if (VisitTemplateParameters(D->getTemplateParameters()))
685 return true;
686
687 return Visit(MakeCXCursor(D->getTemplatedDecl(), TU, RegionOfInterest));
688}
689
Guy Benyei11169dd2012-12-18 14:30:41 +0000690bool CursorVisitor::VisitTypeAliasDecl(TypeAliasDecl *D) {
691 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
692 return Visit(TSInfo->getTypeLoc());
693
694 return false;
695}
696
697bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
698 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
699 return Visit(TSInfo->getTypeLoc());
700
701 return false;
702}
703
704bool CursorVisitor::VisitTagDecl(TagDecl *D) {
705 return VisitDeclContext(D);
706}
707
708bool CursorVisitor::VisitClassTemplateSpecializationDecl(
709 ClassTemplateSpecializationDecl *D) {
710 bool ShouldVisitBody = false;
711 switch (D->getSpecializationKind()) {
712 case TSK_Undeclared:
713 case TSK_ImplicitInstantiation:
714 // Nothing to visit
715 return false;
716
717 case TSK_ExplicitInstantiationDeclaration:
718 case TSK_ExplicitInstantiationDefinition:
719 break;
720
721 case TSK_ExplicitSpecialization:
722 ShouldVisitBody = true;
723 break;
724 }
725
726 // Visit the template arguments used in the specialization.
727 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
728 TypeLoc TL = SpecType->getTypeLoc();
David Blaikie6adc78e2013-02-18 22:06:02 +0000729 if (TemplateSpecializationTypeLoc TSTLoc =
730 TL.getAs<TemplateSpecializationTypeLoc>()) {
731 for (unsigned I = 0, N = TSTLoc.getNumArgs(); I != N; ++I)
732 if (VisitTemplateArgumentLoc(TSTLoc.getArgLoc(I)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000733 return true;
734 }
735 }
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000736
737 return ShouldVisitBody && VisitCXXRecordDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000738}
739
740bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
741 ClassTemplatePartialSpecializationDecl *D) {
742 // FIXME: Visit the "outer" template parameter lists on the TagDecl
743 // before visiting these template parameters.
744 if (VisitTemplateParameters(D->getTemplateParameters()))
745 return true;
746
747 // Visit the partial specialization arguments.
Enea Zaffanella6dbe1872013-08-10 07:24:53 +0000748 const ASTTemplateArgumentListInfo *Info = D->getTemplateArgsAsWritten();
749 const TemplateArgumentLoc *TemplateArgs = Info->getTemplateArgs();
750 for (unsigned I = 0, N = Info->NumTemplateArgs; I != N; ++I)
Guy Benyei11169dd2012-12-18 14:30:41 +0000751 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
752 return true;
753
754 return VisitCXXRecordDecl(D);
755}
756
757bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
758 // Visit the default argument.
759 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
760 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
761 if (Visit(DefArg->getTypeLoc()))
762 return true;
763
764 return false;
765}
766
767bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
768 if (Expr *Init = D->getInitExpr())
769 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
770 return false;
771}
772
773bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000774 unsigned NumParamList = DD->getNumTemplateParameterLists();
775 for (unsigned i = 0; i < NumParamList; i++) {
776 TemplateParameterList* Params = DD->getTemplateParameterList(i);
777 if (VisitTemplateParameters(Params))
778 return true;
779 }
780
Guy Benyei11169dd2012-12-18 14:30:41 +0000781 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
782 if (Visit(TSInfo->getTypeLoc()))
783 return true;
784
785 // Visit the nested-name-specifier, if present.
786 if (NestedNameSpecifierLoc QualifierLoc = DD->getQualifierLoc())
787 if (VisitNestedNameSpecifierLoc(QualifierLoc))
788 return true;
789
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000790 return false;
791}
792
Ivan Donchevskii1d187132018-01-03 14:35:48 +0000793static bool HasTrailingReturnType(FunctionDecl *ND) {
794 const QualType Ty = ND->getType();
795 if (const FunctionType *AFT = Ty->getAs<FunctionType>()) {
796 if (const FunctionProtoType *FT = dyn_cast<FunctionProtoType>(AFT))
797 return FT->hasTrailingReturn();
798 }
799
800 return false;
801}
802
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000803/// Compare two base or member initializers based on their source order.
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000804static int CompareCXXCtorInitializers(CXXCtorInitializer *const *X,
805 CXXCtorInitializer *const *Y) {
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000806 return (*X)->getSourceOrder() - (*Y)->getSourceOrder();
807}
808
Guy Benyei11169dd2012-12-18 14:30:41 +0000809bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Argyrios Kyrtzidis2ec76742013-04-05 21:04:10 +0000810 unsigned NumParamList = ND->getNumTemplateParameterLists();
811 for (unsigned i = 0; i < NumParamList; i++) {
812 TemplateParameterList* Params = ND->getTemplateParameterList(i);
813 if (VisitTemplateParameters(Params))
814 return true;
815 }
816
Guy Benyei11169dd2012-12-18 14:30:41 +0000817 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
818 // Visit the function declaration's syntactic components in the order
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000819 // written. This requires a bit of work.
820 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
821 FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>();
Ivan Donchevskii1d187132018-01-03 14:35:48 +0000822 const bool HasTrailingRT = HasTrailingReturnType(ND);
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000823
824 // If we have a function declared directly (without the use of a typedef),
825 // visit just the return type. Otherwise, just visit the function's type
826 // now.
Ivan Donchevskii1d187132018-01-03 14:35:48 +0000827 if ((FTL && !isa<CXXConversionDecl>(ND) && !HasTrailingRT &&
828 Visit(FTL.getReturnLoc())) ||
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000829 (!FTL && Visit(TL)))
830 return true;
Ivan Donchevskii1d187132018-01-03 14:35:48 +0000831
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000832 // Visit the nested-name-specifier, if present.
833 if (NestedNameSpecifierLoc QualifierLoc = ND->getQualifierLoc())
834 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Guy Benyei11169dd2012-12-18 14:30:41 +0000835 return true;
836
837 // Visit the declaration name.
Argyrios Kyrtzidis4a4d2b42014-02-09 08:13:47 +0000838 if (!isa<CXXDestructorDecl>(ND))
839 if (VisitDeclarationNameInfo(ND->getNameInfo()))
840 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +0000841
842 // FIXME: Visit explicitly-specified template arguments!
843
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000844 // Visit the function parameters, if we have a function type.
845 if (FTL && VisitFunctionTypeLoc(FTL, true))
846 return true;
Ivan Donchevskii1d187132018-01-03 14:35:48 +0000847
848 // Visit the function's trailing return type.
849 if (FTL && HasTrailingRT && Visit(FTL.getReturnLoc()))
850 return true;
851
Ivan Donchevskii1c27b152018-01-03 10:33:21 +0000852 // FIXME: Attributes?
853 }
854
Guy Benyei11169dd2012-12-18 14:30:41 +0000855 if (ND->doesThisDeclarationHaveABody() && !ND->isLateTemplateParsed()) {
856 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
857 // Find the initializers that were written in the source.
858 SmallVector<CXXCtorInitializer *, 4> WrittenInits;
Aaron Ballman0ad78302014-03-13 17:34:31 +0000859 for (auto *I : Constructor->inits()) {
860 if (!I->isWritten())
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 continue;
862
Aaron Ballman0ad78302014-03-13 17:34:31 +0000863 WrittenInits.push_back(I);
Guy Benyei11169dd2012-12-18 14:30:41 +0000864 }
865
866 // Sort the initializers in source order
Benjamin Kramer4cadf292014-03-07 21:51:58 +0000867 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
868 &CompareCXXCtorInitializers);
869
Guy Benyei11169dd2012-12-18 14:30:41 +0000870 // Visit the initializers in source order
871 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
872 CXXCtorInitializer *Init = WrittenInits[I];
873 if (Init->isAnyMemberInitializer()) {
874 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
875 Init->getMemberLocation(), TU)))
876 return true;
877 } else if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo()) {
878 if (Visit(TInfo->getTypeLoc()))
879 return true;
880 }
881
882 // Visit the initializer value.
883 if (Expr *Initializer = Init->getInit())
884 if (Visit(MakeCXCursor(Initializer, ND, TU, RegionOfInterest)))
885 return true;
886 }
887 }
888
889 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
890 return true;
891 }
892
893 return false;
894}
895
896bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
897 if (VisitDeclaratorDecl(D))
898 return true;
899
900 if (Expr *BitWidth = D->getBitWidth())
901 return Visit(MakeCXCursor(BitWidth, StmtParent, TU, RegionOfInterest));
902
Benjamin Kramer99f97592017-11-15 12:20:41 +0000903 if (Expr *Init = D->getInClassInitializer())
904 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
905
Guy Benyei11169dd2012-12-18 14:30:41 +0000906 return false;
907}
908
909bool CursorVisitor::VisitVarDecl(VarDecl *D) {
910 if (VisitDeclaratorDecl(D))
911 return true;
912
913 if (Expr *Init = D->getInit())
914 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
915
916 return false;
917}
918
919bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
920 if (VisitDeclaratorDecl(D))
921 return true;
922
923 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
924 if (Expr *DefArg = D->getDefaultArgument())
925 return Visit(MakeCXCursor(DefArg, StmtParent, TU, RegionOfInterest));
926
927 return false;
928}
929
930bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
931 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
932 // before visiting these template parameters.
933 if (VisitTemplateParameters(D->getTemplateParameters()))
934 return true;
935
Jonathan Coe578ac7a2017-10-16 23:43:02 +0000936 auto* FD = D->getTemplatedDecl();
937 return VisitAttributes(FD) || VisitFunctionDecl(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000938}
939
940bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
941 // FIXME: Visit the "outer" template parameter lists on the TagDecl
942 // before visiting these template parameters.
943 if (VisitTemplateParameters(D->getTemplateParameters()))
944 return true;
945
Jonathan Coe578ac7a2017-10-16 23:43:02 +0000946 auto* CD = D->getTemplatedDecl();
947 return VisitAttributes(CD) || VisitCXXRecordDecl(CD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000948}
949
950bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
951 if (VisitTemplateParameters(D->getTemplateParameters()))
952 return true;
953
954 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
955 VisitTemplateArgumentLoc(D->getDefaultArgument()))
956 return true;
957
958 return false;
959}
960
Douglas Gregor9bda6cf2015-07-07 03:58:14 +0000961bool CursorVisitor::VisitObjCTypeParamDecl(ObjCTypeParamDecl *D) {
962 // Visit the bound, if it's explicit.
963 if (D->hasExplicitBound()) {
964 if (auto TInfo = D->getTypeSourceInfo()) {
965 if (Visit(TInfo->getTypeLoc()))
966 return true;
967 }
968 }
969
970 return false;
971}
972
Guy Benyei11169dd2012-12-18 14:30:41 +0000973bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Alp Toker314cc812014-01-25 16:55:45 +0000974 if (TypeSourceInfo *TSInfo = ND->getReturnTypeSourceInfo())
Guy Benyei11169dd2012-12-18 14:30:41 +0000975 if (Visit(TSInfo->getTypeLoc()))
976 return true;
977
David Majnemer59f77922016-06-24 04:05:48 +0000978 for (const auto *P : ND->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +0000979 if (Visit(MakeCXCursor(P, TU, RegionOfInterest)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000980 return true;
981 }
982
Alexander Kornienko1a9f1842015-12-28 15:24:08 +0000983 return ND->isThisDeclarationADefinition() &&
984 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest));
Guy Benyei11169dd2012-12-18 14:30:41 +0000985}
986
987template <typename DeclIt>
988static void addRangedDeclsInContainer(DeclIt *DI_current, DeclIt DE_current,
989 SourceManager &SM, SourceLocation EndLoc,
990 SmallVectorImpl<Decl *> &Decls) {
991 DeclIt next = *DI_current;
992 while (++next != DE_current) {
993 Decl *D_next = *next;
994 if (!D_next)
995 break;
996 SourceLocation L = D_next->getLocStart();
997 if (!L.isValid())
998 break;
999 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
1000 *DI_current = next;
1001 Decls.push_back(D_next);
1002 continue;
1003 }
1004 break;
1005 }
1006}
1007
Guy Benyei11169dd2012-12-18 14:30:41 +00001008bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
1009 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
1010 // an @implementation can lexically contain Decls that are not properly
1011 // nested in the AST. When we identify such cases, we need to retrofit
1012 // this nesting here.
1013 if (!DI_current && !FileDI_current)
1014 return VisitDeclContext(D);
1015
1016 // Scan the Decls that immediately come after the container
1017 // in the current DeclContext. If any fall within the
1018 // container's lexical region, stash them into a vector
1019 // for later processing.
1020 SmallVector<Decl *, 24> DeclsInContainer;
1021 SourceLocation EndLoc = D->getSourceRange().getEnd();
1022 SourceManager &SM = AU->getSourceManager();
1023 if (EndLoc.isValid()) {
1024 if (DI_current) {
1025 addRangedDeclsInContainer(DI_current, DE_current, SM, EndLoc,
1026 DeclsInContainer);
1027 } else {
1028 addRangedDeclsInContainer(FileDI_current, FileDE_current, SM, EndLoc,
1029 DeclsInContainer);
1030 }
1031 }
1032
1033 // The common case.
1034 if (DeclsInContainer.empty())
1035 return VisitDeclContext(D);
1036
1037 // Get all the Decls in the DeclContext, and sort them with the
1038 // additional ones we've collected. Then visit them.
Aaron Ballman629afae2014-03-07 19:56:05 +00001039 for (auto *SubDecl : D->decls()) {
1040 if (!SubDecl || SubDecl->getLexicalDeclContext() != D ||
1041 SubDecl->getLocStart().isInvalid())
Guy Benyei11169dd2012-12-18 14:30:41 +00001042 continue;
Aaron Ballman629afae2014-03-07 19:56:05 +00001043 DeclsInContainer.push_back(SubDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +00001044 }
1045
1046 // Now sort the Decls so that they appear in lexical order.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00001047 llvm::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
1048 [&SM](Decl *A, Decl *B) {
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001049 SourceLocation L_A = A->getLocStart();
1050 SourceLocation L_B = B->getLocStart();
Mandeep Singh Grangfa51e1d2017-11-29 20:55:13 +00001051 return L_A != L_B ?
1052 SM.isBeforeInTranslationUnit(L_A, L_B) :
1053 SM.isBeforeInTranslationUnit(A->getLocEnd(), B->getLocEnd());
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001054 });
Guy Benyei11169dd2012-12-18 14:30:41 +00001055
1056 // Now visit the decls.
1057 for (SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
1058 E = DeclsInContainer.end(); I != E; ++I) {
1059 CXCursor Cursor = MakeCXCursor(*I, TU, RegionOfInterest);
Ted Kremenek03325582013-02-21 01:29:01 +00001060 const Optional<bool> &V = shouldVisitCursor(Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00001061 if (!V.hasValue())
1062 continue;
1063 if (!V.getValue())
1064 return false;
1065 if (Visit(Cursor, true))
1066 return true;
1067 }
1068 return false;
1069}
1070
1071bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
1072 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
1073 TU)))
1074 return true;
1075
Douglas Gregore9d95f12015-07-07 03:57:35 +00001076 if (VisitObjCTypeParamList(ND->getTypeParamList()))
1077 return true;
1078
Guy Benyei11169dd2012-12-18 14:30:41 +00001079 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
1080 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
1081 E = ND->protocol_end(); I != E; ++I, ++PL)
1082 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1083 return true;
1084
1085 return VisitObjCContainerDecl(ND);
1086}
1087
1088bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1089 if (!PID->isThisDeclarationADefinition())
1090 return Visit(MakeCursorObjCProtocolRef(PID, PID->getLocation(), TU));
1091
1092 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
1093 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
1094 E = PID->protocol_end(); I != E; ++I, ++PL)
1095 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1096 return true;
1097
1098 return VisitObjCContainerDecl(PID);
1099}
1100
1101bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
1102 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
1103 return true;
1104
1105 // FIXME: This implements a workaround with @property declarations also being
1106 // installed in the DeclContext for the @interface. Eventually this code
1107 // should be removed.
1108 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
1109 if (!CDecl || !CDecl->IsClassExtension())
1110 return false;
1111
1112 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
1113 if (!ID)
1114 return false;
1115
1116 IdentifierInfo *PropertyId = PD->getIdentifier();
1117 ObjCPropertyDecl *prevDecl =
Manman Ren5b786402016-01-28 18:49:28 +00001118 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId,
1119 PD->getQueryKind());
Guy Benyei11169dd2012-12-18 14:30:41 +00001120
1121 if (!prevDecl)
1122 return false;
1123
1124 // Visit synthesized methods since they will be skipped when visiting
1125 // the @interface.
1126 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
1127 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1128 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1129 return true;
1130
1131 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
1132 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1133 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1134 return true;
1135
1136 return false;
1137}
1138
Douglas Gregore9d95f12015-07-07 03:57:35 +00001139bool CursorVisitor::VisitObjCTypeParamList(ObjCTypeParamList *typeParamList) {
1140 if (!typeParamList)
1141 return false;
1142
1143 for (auto *typeParam : *typeParamList) {
1144 // Visit the type parameter.
1145 if (Visit(MakeCXCursor(typeParam, TU, RegionOfInterest)))
1146 return true;
Douglas Gregore9d95f12015-07-07 03:57:35 +00001147 }
1148
1149 return false;
1150}
1151
Guy Benyei11169dd2012-12-18 14:30:41 +00001152bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
1153 if (!D->isThisDeclarationADefinition()) {
1154 // Forward declaration is treated like a reference.
1155 return Visit(MakeCursorObjCClassRef(D, D->getLocation(), TU));
1156 }
1157
Douglas Gregore9d95f12015-07-07 03:57:35 +00001158 // Objective-C type parameters.
1159 if (VisitObjCTypeParamList(D->getTypeParamListAsWritten()))
1160 return true;
1161
Guy Benyei11169dd2012-12-18 14:30:41 +00001162 // Issue callbacks for super class.
1163 if (D->getSuperClass() &&
1164 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1165 D->getSuperClassLoc(),
1166 TU)))
1167 return true;
1168
Douglas Gregore9d95f12015-07-07 03:57:35 +00001169 if (TypeSourceInfo *SuperClassTInfo = D->getSuperClassTInfo())
1170 if (Visit(SuperClassTInfo->getTypeLoc()))
1171 return true;
1172
Guy Benyei11169dd2012-12-18 14:30:41 +00001173 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1174 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1175 E = D->protocol_end(); I != E; ++I, ++PL)
1176 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1177 return true;
1178
1179 return VisitObjCContainerDecl(D);
1180}
1181
1182bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1183 return VisitObjCContainerDecl(D);
1184}
1185
1186bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
1187 // 'ID' could be null when dealing with invalid code.
1188 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1189 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1190 return true;
1191
1192 return VisitObjCImplDecl(D);
1193}
1194
1195bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1196#if 0
1197 // Issue callbacks for super class.
1198 // FIXME: No source location information!
1199 if (D->getSuperClass() &&
1200 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1201 D->getSuperClassLoc(),
1202 TU)))
1203 return true;
1204#endif
1205
1206 return VisitObjCImplDecl(D);
1207}
1208
1209bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1210 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1211 if (PD->isIvarNameSpecified())
1212 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1213
1214 return false;
1215}
1216
1217bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1218 return VisitDeclContext(D);
1219}
1220
1221bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1222 // Visit nested-name-specifier.
1223 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1224 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1225 return true;
1226
1227 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1228 D->getTargetNameLoc(), TU));
1229}
1230
1231bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1232 // Visit nested-name-specifier.
1233 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1234 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1235 return true;
1236 }
1237
1238 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1239 return true;
1240
1241 return VisitDeclarationNameInfo(D->getNameInfo());
1242}
1243
1244bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1245 // Visit nested-name-specifier.
1246 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1247 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1248 return true;
1249
1250 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1251 D->getIdentLocation(), TU));
1252}
1253
1254bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1255 // Visit nested-name-specifier.
1256 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1257 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1258 return true;
1259 }
1260
1261 return VisitDeclarationNameInfo(D->getNameInfo());
1262}
1263
1264bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1265 UnresolvedUsingTypenameDecl *D) {
1266 // Visit nested-name-specifier.
1267 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1268 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1269 return true;
1270
1271 return false;
1272}
1273
Olivier Goffart81978012016-06-09 16:15:55 +00001274bool CursorVisitor::VisitStaticAssertDecl(StaticAssertDecl *D) {
1275 if (Visit(MakeCXCursor(D->getAssertExpr(), StmtParent, TU, RegionOfInterest)))
1276 return true;
Richard Trieuf3b77662016-09-13 01:37:01 +00001277 if (StringLiteral *Message = D->getMessage())
1278 if (Visit(MakeCXCursor(Message, StmtParent, TU, RegionOfInterest)))
1279 return true;
Olivier Goffart81978012016-06-09 16:15:55 +00001280 return false;
1281}
1282
Olivier Goffartd211c642016-11-04 06:29:27 +00001283bool CursorVisitor::VisitFriendDecl(FriendDecl *D) {
1284 if (NamedDecl *FriendD = D->getFriendDecl()) {
1285 if (Visit(MakeCXCursor(FriendD, TU, RegionOfInterest)))
1286 return true;
1287 } else if (TypeSourceInfo *TI = D->getFriendType()) {
1288 if (Visit(TI->getTypeLoc()))
1289 return true;
1290 }
1291 return false;
1292}
1293
Guy Benyei11169dd2012-12-18 14:30:41 +00001294bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1295 switch (Name.getName().getNameKind()) {
1296 case clang::DeclarationName::Identifier:
1297 case clang::DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00001298 case clang::DeclarationName::CXXDeductionGuideName:
Guy Benyei11169dd2012-12-18 14:30:41 +00001299 case clang::DeclarationName::CXXOperatorName:
1300 case clang::DeclarationName::CXXUsingDirective:
1301 return false;
Richard Smith35845152017-02-07 01:37:30 +00001302
Guy Benyei11169dd2012-12-18 14:30:41 +00001303 case clang::DeclarationName::CXXConstructorName:
1304 case clang::DeclarationName::CXXDestructorName:
1305 case clang::DeclarationName::CXXConversionFunctionName:
1306 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1307 return Visit(TSInfo->getTypeLoc());
1308 return false;
1309
1310 case clang::DeclarationName::ObjCZeroArgSelector:
1311 case clang::DeclarationName::ObjCOneArgSelector:
1312 case clang::DeclarationName::ObjCMultiArgSelector:
1313 // FIXME: Per-identifier location info?
1314 return false;
1315 }
1316
1317 llvm_unreachable("Invalid DeclarationName::Kind!");
1318}
1319
1320bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1321 SourceRange Range) {
1322 // FIXME: This whole routine is a hack to work around the lack of proper
1323 // source information in nested-name-specifiers (PR5791). Since we do have
1324 // a beginning source location, we can visit the first component of the
1325 // nested-name-specifier, if it's a single-token component.
1326 if (!NNS)
1327 return false;
1328
1329 // Get the first component in the nested-name-specifier.
1330 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1331 NNS = Prefix;
1332
1333 switch (NNS->getKind()) {
1334 case NestedNameSpecifier::Namespace:
1335 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1336 TU));
1337
1338 case NestedNameSpecifier::NamespaceAlias:
1339 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1340 Range.getBegin(), TU));
1341
1342 case NestedNameSpecifier::TypeSpec: {
1343 // If the type has a form where we know that the beginning of the source
1344 // range matches up with a reference cursor. Visit the appropriate reference
1345 // cursor.
1346 const Type *T = NNS->getAsType();
1347 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1348 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1349 if (const TagType *Tag = dyn_cast<TagType>(T))
1350 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1351 if (const TemplateSpecializationType *TST
1352 = dyn_cast<TemplateSpecializationType>(T))
1353 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1354 break;
1355 }
1356
1357 case NestedNameSpecifier::TypeSpecWithTemplate:
1358 case NestedNameSpecifier::Global:
1359 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001360 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001361 break;
1362 }
1363
1364 return false;
1365}
1366
1367bool
1368CursorVisitor::VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1369 SmallVector<NestedNameSpecifierLoc, 4> Qualifiers;
1370 for (; Qualifier; Qualifier = Qualifier.getPrefix())
1371 Qualifiers.push_back(Qualifier);
1372
1373 while (!Qualifiers.empty()) {
1374 NestedNameSpecifierLoc Q = Qualifiers.pop_back_val();
1375 NestedNameSpecifier *NNS = Q.getNestedNameSpecifier();
1376 switch (NNS->getKind()) {
1377 case NestedNameSpecifier::Namespace:
1378 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(),
1379 Q.getLocalBeginLoc(),
1380 TU)))
1381 return true;
1382
1383 break;
1384
1385 case NestedNameSpecifier::NamespaceAlias:
1386 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1387 Q.getLocalBeginLoc(),
1388 TU)))
1389 return true;
1390
1391 break;
1392
1393 case NestedNameSpecifier::TypeSpec:
1394 case NestedNameSpecifier::TypeSpecWithTemplate:
1395 if (Visit(Q.getTypeLoc()))
1396 return true;
1397
1398 break;
1399
1400 case NestedNameSpecifier::Global:
1401 case NestedNameSpecifier::Identifier:
Nikola Smiljanic67860242014-09-26 00:28:20 +00001402 case NestedNameSpecifier::Super:
Guy Benyei11169dd2012-12-18 14:30:41 +00001403 break;
1404 }
1405 }
1406
1407 return false;
1408}
1409
1410bool CursorVisitor::VisitTemplateParameters(
1411 const TemplateParameterList *Params) {
1412 if (!Params)
1413 return false;
1414
1415 for (TemplateParameterList::const_iterator P = Params->begin(),
1416 PEnd = Params->end();
1417 P != PEnd; ++P) {
1418 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
1419 return true;
1420 }
1421
1422 return false;
1423}
1424
1425bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1426 switch (Name.getKind()) {
1427 case TemplateName::Template:
1428 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1429
1430 case TemplateName::OverloadedTemplate:
1431 // Visit the overloaded template set.
1432 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1433 return true;
1434
1435 return false;
1436
1437 case TemplateName::DependentTemplate:
1438 // FIXME: Visit nested-name-specifier.
1439 return false;
1440
1441 case TemplateName::QualifiedTemplate:
1442 // FIXME: Visit nested-name-specifier.
1443 return Visit(MakeCursorTemplateRef(
1444 Name.getAsQualifiedTemplateName()->getDecl(),
1445 Loc, TU));
1446
1447 case TemplateName::SubstTemplateTemplateParm:
1448 return Visit(MakeCursorTemplateRef(
1449 Name.getAsSubstTemplateTemplateParm()->getParameter(),
1450 Loc, TU));
1451
1452 case TemplateName::SubstTemplateTemplateParmPack:
1453 return Visit(MakeCursorTemplateRef(
1454 Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1455 Loc, TU));
1456 }
1457
1458 llvm_unreachable("Invalid TemplateName::Kind!");
1459}
1460
1461bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1462 switch (TAL.getArgument().getKind()) {
1463 case TemplateArgument::Null:
1464 case TemplateArgument::Integral:
1465 case TemplateArgument::Pack:
1466 return false;
1467
1468 case TemplateArgument::Type:
1469 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1470 return Visit(TSInfo->getTypeLoc());
1471 return false;
1472
1473 case TemplateArgument::Declaration:
1474 if (Expr *E = TAL.getSourceDeclExpression())
1475 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1476 return false;
1477
1478 case TemplateArgument::NullPtr:
1479 if (Expr *E = TAL.getSourceNullPtrExpression())
1480 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1481 return false;
1482
1483 case TemplateArgument::Expression:
1484 if (Expr *E = TAL.getSourceExpression())
1485 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1486 return false;
1487
1488 case TemplateArgument::Template:
1489 case TemplateArgument::TemplateExpansion:
1490 if (VisitNestedNameSpecifierLoc(TAL.getTemplateQualifierLoc()))
1491 return true;
1492
1493 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
1494 TAL.getTemplateNameLoc());
1495 }
1496
1497 llvm_unreachable("Invalid TemplateArgument::Kind!");
1498}
1499
1500bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1501 return VisitDeclContext(D);
1502}
1503
1504bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1505 return Visit(TL.getUnqualifiedLoc());
1506}
1507
1508bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1509 ASTContext &Context = AU->getASTContext();
1510
1511 // Some builtin types (such as Objective-C's "id", "sel", and
1512 // "Class") have associated declarations. Create cursors for those.
1513 QualType VisitType;
1514 switch (TL.getTypePtr()->getKind()) {
1515
1516 case BuiltinType::Void:
1517 case BuiltinType::NullPtr:
1518 case BuiltinType::Dependent:
Alexey Bader954ba212016-04-08 13:40:33 +00001519#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1520 case BuiltinType::Id:
Alexey Baderb62f1442016-04-13 08:33:41 +00001521#include "clang/Basic/OpenCLImageTypes.def"
NAKAMURA Takumi288c42e2013-02-07 12:47:42 +00001522 case BuiltinType::OCLSampler:
Guy Benyei1b4fb3e2013-01-20 12:31:11 +00001523 case BuiltinType::OCLEvent:
Alexey Bader9c8453f2015-09-15 11:18:52 +00001524 case BuiltinType::OCLClkEvent:
1525 case BuiltinType::OCLQueue:
Alexey Bader9c8453f2015-09-15 11:18:52 +00001526 case BuiltinType::OCLReserveID:
Guy Benyei11169dd2012-12-18 14:30:41 +00001527#define BUILTIN_TYPE(Id, SingletonId)
1528#define SIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1529#define UNSIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1530#define FLOATING_TYPE(Id, SingletonId) case BuiltinType::Id:
1531#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
1532#include "clang/AST/BuiltinTypes.def"
1533 break;
1534
1535 case BuiltinType::ObjCId:
1536 VisitType = Context.getObjCIdType();
1537 break;
1538
1539 case BuiltinType::ObjCClass:
1540 VisitType = Context.getObjCClassType();
1541 break;
1542
1543 case BuiltinType::ObjCSel:
1544 VisitType = Context.getObjCSelType();
1545 break;
1546 }
1547
1548 if (!VisitType.isNull()) {
1549 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1550 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1551 TU));
1552 }
1553
1554 return false;
1555}
1556
1557bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1558 return Visit(MakeCursorTypeRef(TL.getTypedefNameDecl(), TL.getNameLoc(), TU));
1559}
1560
1561bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1562 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1563}
1564
1565bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1566 if (TL.isDefinition())
1567 return Visit(MakeCXCursor(TL.getDecl(), TU, RegionOfInterest));
1568
1569 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1570}
1571
1572bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1573 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1574}
1575
1576bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001577 return Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU));
Guy Benyei11169dd2012-12-18 14:30:41 +00001578}
1579
Manman Rene6be26c2016-09-13 17:25:08 +00001580bool CursorVisitor::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
1581 if (Visit(MakeCursorTypeRef(TL.getDecl(), TL.getLocStart(), TU)))
1582 return true;
1583 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1584 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1585 TU)))
1586 return true;
1587 }
1588
1589 return false;
1590}
1591
Guy Benyei11169dd2012-12-18 14:30:41 +00001592bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1593 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1594 return true;
1595
Douglas Gregore9d95f12015-07-07 03:57:35 +00001596 for (unsigned I = 0, N = TL.getNumTypeArgs(); I != N; ++I) {
1597 if (Visit(TL.getTypeArgTInfo(I)->getTypeLoc()))
1598 return true;
1599 }
1600
Guy Benyei11169dd2012-12-18 14:30:41 +00001601 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1602 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1603 TU)))
1604 return true;
1605 }
1606
1607 return false;
1608}
1609
1610bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1611 return Visit(TL.getPointeeLoc());
1612}
1613
1614bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1615 return Visit(TL.getInnerLoc());
1616}
1617
1618bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1619 return Visit(TL.getPointeeLoc());
1620}
1621
1622bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1623 return Visit(TL.getPointeeLoc());
1624}
1625
1626bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1627 return Visit(TL.getPointeeLoc());
1628}
1629
1630bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1631 return Visit(TL.getPointeeLoc());
1632}
1633
1634bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1635 return Visit(TL.getPointeeLoc());
1636}
1637
1638bool CursorVisitor::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
1639 return Visit(TL.getModifiedLoc());
1640}
1641
1642bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1643 bool SkipResultType) {
Alp Toker42a16a62014-01-25 23:51:36 +00001644 if (!SkipResultType && Visit(TL.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00001645 return true;
1646
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00001647 for (unsigned I = 0, N = TL.getNumParams(); I != N; ++I)
1648 if (Decl *D = TL.getParam(I))
Guy Benyei11169dd2012-12-18 14:30:41 +00001649 if (Visit(MakeCXCursor(D, TU, RegionOfInterest)))
1650 return true;
1651
1652 return false;
1653}
1654
1655bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1656 if (Visit(TL.getElementLoc()))
1657 return true;
1658
1659 if (Expr *Size = TL.getSizeExpr())
1660 return Visit(MakeCXCursor(Size, StmtParent, TU, RegionOfInterest));
1661
1662 return false;
1663}
1664
Reid Kleckner8a365022013-06-24 17:51:48 +00001665bool CursorVisitor::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
1666 return Visit(TL.getOriginalLoc());
1667}
1668
Reid Kleckner0503a872013-12-05 01:23:43 +00001669bool CursorVisitor::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
1670 return Visit(TL.getOriginalLoc());
1671}
1672
Richard Smith600b5262017-01-26 20:40:47 +00001673bool CursorVisitor::VisitDeducedTemplateSpecializationTypeLoc(
1674 DeducedTemplateSpecializationTypeLoc TL) {
1675 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1676 TL.getTemplateNameLoc()))
1677 return true;
1678
1679 return false;
1680}
1681
Guy Benyei11169dd2012-12-18 14:30:41 +00001682bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1683 TemplateSpecializationTypeLoc TL) {
1684 // Visit the template name.
1685 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1686 TL.getTemplateNameLoc()))
1687 return true;
1688
1689 // Visit the template arguments.
1690 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1691 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1692 return true;
1693
1694 return false;
1695}
1696
1697bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1698 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1699}
1700
1701bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1702 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1703 return Visit(TSInfo->getTypeLoc());
1704
1705 return false;
1706}
1707
1708bool CursorVisitor::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
1709 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1710 return Visit(TSInfo->getTypeLoc());
1711
1712 return false;
1713}
1714
1715bool CursorVisitor::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00001716 return VisitNestedNameSpecifierLoc(TL.getQualifierLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00001717}
1718
1719bool CursorVisitor::VisitDependentTemplateSpecializationTypeLoc(
1720 DependentTemplateSpecializationTypeLoc TL) {
1721 // Visit the nested-name-specifier, if there is one.
1722 if (TL.getQualifierLoc() &&
1723 VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1724 return true;
1725
1726 // Visit the template arguments.
1727 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1728 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1729 return true;
1730
1731 return false;
1732}
1733
1734bool CursorVisitor::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
1735 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1736 return true;
1737
1738 return Visit(TL.getNamedTypeLoc());
1739}
1740
1741bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1742 return Visit(TL.getPatternLoc());
1743}
1744
1745bool CursorVisitor::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
1746 if (Expr *E = TL.getUnderlyingExpr())
1747 return Visit(MakeCXCursor(E, StmtParent, TU));
1748
1749 return false;
1750}
1751
1752bool CursorVisitor::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
1753 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1754}
1755
1756bool CursorVisitor::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
1757 return Visit(TL.getValueLoc());
1758}
1759
Xiuli Pan9c14e282016-01-09 12:53:17 +00001760bool CursorVisitor::VisitPipeTypeLoc(PipeTypeLoc TL) {
1761 return Visit(TL.getValueLoc());
1762}
1763
Guy Benyei11169dd2012-12-18 14:30:41 +00001764#define DEFAULT_TYPELOC_IMPL(CLASS, PARENT) \
1765bool CursorVisitor::Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
1766 return Visit##PARENT##Loc(TL); \
1767}
1768
1769DEFAULT_TYPELOC_IMPL(Complex, Type)
1770DEFAULT_TYPELOC_IMPL(ConstantArray, ArrayType)
1771DEFAULT_TYPELOC_IMPL(IncompleteArray, ArrayType)
1772DEFAULT_TYPELOC_IMPL(VariableArray, ArrayType)
1773DEFAULT_TYPELOC_IMPL(DependentSizedArray, ArrayType)
Andrew Gozillon572bbb02017-10-02 06:25:51 +00001774DEFAULT_TYPELOC_IMPL(DependentAddressSpace, Type)
Erich Keanef702b022018-07-13 19:46:04 +00001775DEFAULT_TYPELOC_IMPL(DependentVector, Type)
Guy Benyei11169dd2012-12-18 14:30:41 +00001776DEFAULT_TYPELOC_IMPL(DependentSizedExtVector, Type)
1777DEFAULT_TYPELOC_IMPL(Vector, Type)
1778DEFAULT_TYPELOC_IMPL(ExtVector, VectorType)
1779DEFAULT_TYPELOC_IMPL(FunctionProto, FunctionType)
1780DEFAULT_TYPELOC_IMPL(FunctionNoProto, FunctionType)
1781DEFAULT_TYPELOC_IMPL(Record, TagType)
1782DEFAULT_TYPELOC_IMPL(Enum, TagType)
1783DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParm, Type)
1784DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParmPack, Type)
1785DEFAULT_TYPELOC_IMPL(Auto, Type)
1786
1787bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1788 // Visit the nested-name-specifier, if present.
1789 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1790 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1791 return true;
1792
1793 if (D->isCompleteDefinition()) {
Aaron Ballman574705e2014-03-13 15:41:46 +00001794 for (const auto &I : D->bases()) {
1795 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(&I, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001796 return true;
1797 }
1798 }
1799
1800 return VisitTagDecl(D);
1801}
1802
1803bool CursorVisitor::VisitAttributes(Decl *D) {
Aaron Ballmanb97112e2014-03-08 22:19:01 +00001804 for (const auto *I : D->attrs())
Michael Wu40ff1052018-08-03 05:20:23 +00001805 if ((TU->ParsingOptions & CXTranslationUnit_VisitImplicitAttributes ||
1806 !I->isImplicit()) &&
1807 Visit(MakeCXCursor(I, D, TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00001808 return true;
1809
1810 return false;
1811}
1812
1813//===----------------------------------------------------------------------===//
1814// Data-recursive visitor methods.
1815//===----------------------------------------------------------------------===//
1816
1817namespace {
1818#define DEF_JOB(NAME, DATA, KIND)\
1819class NAME : public VisitorJob {\
1820public:\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001821 NAME(const DATA *d, CXCursor parent) : \
1822 VisitorJob(parent, VisitorJob::KIND, d) {} \
Guy Benyei11169dd2012-12-18 14:30:41 +00001823 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001824 const DATA *get() const { return static_cast<const DATA*>(data[0]); }\
Guy Benyei11169dd2012-12-18 14:30:41 +00001825};
1826
1827DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1828DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
1829DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
1830DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Guy Benyei11169dd2012-12-18 14:30:41 +00001831DEF_JOB(SizeOfPackExprParts, SizeOfPackExpr, SizeOfPackExprPartsKind)
1832DEF_JOB(LambdaExprParts, LambdaExpr, LambdaExprPartsKind)
1833DEF_JOB(PostChildrenVisit, void, PostChildrenVisitKind)
1834#undef DEF_JOB
1835
James Y Knight04ec5bf2015-12-24 02:59:37 +00001836class ExplicitTemplateArgsVisit : public VisitorJob {
1837public:
1838 ExplicitTemplateArgsVisit(const TemplateArgumentLoc *Begin,
1839 const TemplateArgumentLoc *End, CXCursor parent)
1840 : VisitorJob(parent, VisitorJob::ExplicitTemplateArgsVisitKind, Begin,
1841 End) {}
1842 static bool classof(const VisitorJob *VJ) {
1843 return VJ->getKind() == ExplicitTemplateArgsVisitKind;
1844 }
1845 const TemplateArgumentLoc *begin() const {
1846 return static_cast<const TemplateArgumentLoc *>(data[0]);
1847 }
1848 const TemplateArgumentLoc *end() {
1849 return static_cast<const TemplateArgumentLoc *>(data[1]);
1850 }
1851};
Guy Benyei11169dd2012-12-18 14:30:41 +00001852class DeclVisit : public VisitorJob {
1853public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001854 DeclVisit(const Decl *D, CXCursor parent, bool isFirst) :
Guy Benyei11169dd2012-12-18 14:30:41 +00001855 VisitorJob(parent, VisitorJob::DeclVisitKind,
Craig Topper69186e72014-06-08 08:38:04 +00001856 D, isFirst ? (void*) 1 : (void*) nullptr) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001857 static bool classof(const VisitorJob *VJ) {
1858 return VJ->getKind() == DeclVisitKind;
1859 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001860 const Decl *get() const { return static_cast<const Decl *>(data[0]); }
Dmitri Gribenkoe5423a72015-03-23 19:23:50 +00001861 bool isFirst() const { return data[1] != nullptr; }
Guy Benyei11169dd2012-12-18 14:30:41 +00001862};
1863class TypeLocVisit : public VisitorJob {
1864public:
1865 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1866 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1867 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1868
1869 static bool classof(const VisitorJob *VJ) {
1870 return VJ->getKind() == TypeLocVisitKind;
1871 }
1872
1873 TypeLoc get() const {
1874 QualType T = QualType::getFromOpaquePtr(data[0]);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001875 return TypeLoc(T, const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001876 }
1877};
1878
1879class LabelRefVisit : public VisitorJob {
1880public:
1881 LabelRefVisit(LabelDecl *LD, SourceLocation labelLoc, CXCursor parent)
1882 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LD,
1883 labelLoc.getPtrEncoding()) {}
1884
1885 static bool classof(const VisitorJob *VJ) {
1886 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1887 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001888 const LabelDecl *get() const {
1889 return static_cast<const LabelDecl *>(data[0]);
1890 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001891 SourceLocation getLoc() const {
1892 return SourceLocation::getFromPtrEncoding(data[1]); }
1893};
1894
1895class NestedNameSpecifierLocVisit : public VisitorJob {
1896public:
1897 NestedNameSpecifierLocVisit(NestedNameSpecifierLoc Qualifier, CXCursor parent)
1898 : VisitorJob(parent, VisitorJob::NestedNameSpecifierLocVisitKind,
1899 Qualifier.getNestedNameSpecifier(),
1900 Qualifier.getOpaqueData()) { }
1901
1902 static bool classof(const VisitorJob *VJ) {
1903 return VJ->getKind() == VisitorJob::NestedNameSpecifierLocVisitKind;
1904 }
1905
1906 NestedNameSpecifierLoc get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001907 return NestedNameSpecifierLoc(
1908 const_cast<NestedNameSpecifier *>(
1909 static_cast<const NestedNameSpecifier *>(data[0])),
1910 const_cast<void *>(data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00001911 }
1912};
1913
1914class DeclarationNameInfoVisit : public VisitorJob {
1915public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001916 DeclarationNameInfoVisit(const Stmt *S, CXCursor parent)
Dmitri Gribenkodd7dacf2013-02-03 13:19:54 +00001917 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
Guy Benyei11169dd2012-12-18 14:30:41 +00001918 static bool classof(const VisitorJob *VJ) {
1919 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1920 }
1921 DeclarationNameInfo get() const {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001922 const Stmt *S = static_cast<const Stmt *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001923 switch (S->getStmtClass()) {
1924 default:
1925 llvm_unreachable("Unhandled Stmt");
1926 case clang::Stmt::MSDependentExistsStmtClass:
1927 return cast<MSDependentExistsStmt>(S)->getNameInfo();
1928 case Stmt::CXXDependentScopeMemberExprClass:
1929 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1930 case Stmt::DependentScopeDeclRefExprClass:
1931 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
Alexander Musmand9ed09f2014-07-21 09:42:05 +00001932 case Stmt::OMPCriticalDirectiveClass:
1933 return cast<OMPCriticalDirective>(S)->getDirectiveName();
Guy Benyei11169dd2012-12-18 14:30:41 +00001934 }
1935 }
1936};
1937class MemberRefVisit : public VisitorJob {
1938public:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001939 MemberRefVisit(const FieldDecl *D, SourceLocation L, CXCursor parent)
Guy Benyei11169dd2012-12-18 14:30:41 +00001940 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1941 L.getPtrEncoding()) {}
1942 static bool classof(const VisitorJob *VJ) {
1943 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1944 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001945 const FieldDecl *get() const {
1946 return static_cast<const FieldDecl *>(data[0]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001947 }
1948 SourceLocation getLoc() const {
1949 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1950 }
1951};
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001952class EnqueueVisitor : public ConstStmtVisitor<EnqueueVisitor, void> {
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00001953 friend class OMPClauseEnqueue;
Guy Benyei11169dd2012-12-18 14:30:41 +00001954 VisitorWorkList &WL;
1955 CXCursor Parent;
1956public:
1957 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1958 : WL(wl), Parent(parent) {}
1959
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001960 void VisitAddrLabelExpr(const AddrLabelExpr *E);
1961 void VisitBlockExpr(const BlockExpr *B);
1962 void VisitCompoundLiteralExpr(const CompoundLiteralExpr *E);
1963 void VisitCompoundStmt(const CompoundStmt *S);
1964 void VisitCXXDefaultArgExpr(const CXXDefaultArgExpr *E) { /* Do nothing. */ }
1965 void VisitMSDependentExistsStmt(const MSDependentExistsStmt *S);
1966 void VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E);
1967 void VisitCXXNewExpr(const CXXNewExpr *E);
1968 void VisitCXXScalarValueInitExpr(const CXXScalarValueInitExpr *E);
1969 void VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *E);
1970 void VisitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
1971 void VisitCXXTemporaryObjectExpr(const CXXTemporaryObjectExpr *E);
1972 void VisitCXXTypeidExpr(const CXXTypeidExpr *E);
1973 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *E);
1974 void VisitCXXUuidofExpr(const CXXUuidofExpr *E);
1975 void VisitCXXCatchStmt(const CXXCatchStmt *S);
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00001976 void VisitCXXForRangeStmt(const CXXForRangeStmt *S);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001977 void VisitDeclRefExpr(const DeclRefExpr *D);
1978 void VisitDeclStmt(const DeclStmt *S);
1979 void VisitDependentScopeDeclRefExpr(const DependentScopeDeclRefExpr *E);
1980 void VisitDesignatedInitExpr(const DesignatedInitExpr *E);
1981 void VisitExplicitCastExpr(const ExplicitCastExpr *E);
1982 void VisitForStmt(const ForStmt *FS);
1983 void VisitGotoStmt(const GotoStmt *GS);
1984 void VisitIfStmt(const IfStmt *If);
1985 void VisitInitListExpr(const InitListExpr *IE);
1986 void VisitMemberExpr(const MemberExpr *M);
1987 void VisitOffsetOfExpr(const OffsetOfExpr *E);
1988 void VisitObjCEncodeExpr(const ObjCEncodeExpr *E);
1989 void VisitObjCMessageExpr(const ObjCMessageExpr *M);
1990 void VisitOverloadExpr(const OverloadExpr *E);
1991 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *E);
1992 void VisitStmt(const Stmt *S);
1993 void VisitSwitchStmt(const SwitchStmt *S);
1994 void VisitWhileStmt(const WhileStmt *W);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00001995 void VisitTypeTraitExpr(const TypeTraitExpr *E);
1996 void VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E);
1997 void VisitExpressionTraitExpr(const ExpressionTraitExpr *E);
1998 void VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U);
1999 void VisitVAArgExpr(const VAArgExpr *E);
2000 void VisitSizeOfPackExpr(const SizeOfPackExpr *E);
2001 void VisitPseudoObjectExpr(const PseudoObjectExpr *E);
2002 void VisitOpaqueValueExpr(const OpaqueValueExpr *E);
2003 void VisitLambdaExpr(const LambdaExpr *E);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002004 void VisitOMPExecutableDirective(const OMPExecutableDirective *D);
Alexander Musman3aaab662014-08-19 11:27:13 +00002005 void VisitOMPLoopDirective(const OMPLoopDirective *D);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002006 void VisitOMPParallelDirective(const OMPParallelDirective *D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002007 void VisitOMPSimdDirective(const OMPSimdDirective *D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002008 void VisitOMPForDirective(const OMPForDirective *D);
Alexander Musmanf82886e2014-09-18 05:12:34 +00002009 void VisitOMPForSimdDirective(const OMPForSimdDirective *D);
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002010 void VisitOMPSectionsDirective(const OMPSectionsDirective *D);
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002011 void VisitOMPSectionDirective(const OMPSectionDirective *D);
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002012 void VisitOMPSingleDirective(const OMPSingleDirective *D);
Alexander Musman80c22892014-07-17 08:54:58 +00002013 void VisitOMPMasterDirective(const OMPMasterDirective *D);
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002014 void VisitOMPCriticalDirective(const OMPCriticalDirective *D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002015 void VisitOMPParallelForDirective(const OMPParallelForDirective *D);
Alexander Musmane4e893b2014-09-23 09:33:00 +00002016 void VisitOMPParallelForSimdDirective(const OMPParallelForSimdDirective *D);
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002017 void VisitOMPParallelSectionsDirective(const OMPParallelSectionsDirective *D);
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002018 void VisitOMPTaskDirective(const OMPTaskDirective *D);
Alexey Bataev68446b72014-07-18 07:47:19 +00002019 void VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D);
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002020 void VisitOMPBarrierDirective(const OMPBarrierDirective *D);
Alexey Bataev2df347a2014-07-18 10:17:07 +00002021 void VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002022 void VisitOMPTaskgroupDirective(const OMPTaskgroupDirective *D);
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002023 void
2024 VisitOMPCancellationPointDirective(const OMPCancellationPointDirective *D);
Alexey Bataev80909872015-07-02 11:25:17 +00002025 void VisitOMPCancelDirective(const OMPCancelDirective *D);
Alexey Bataev6125da92014-07-21 11:26:11 +00002026 void VisitOMPFlushDirective(const OMPFlushDirective *D);
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002027 void VisitOMPOrderedDirective(const OMPOrderedDirective *D);
Alexey Bataev0162e452014-07-22 10:10:35 +00002028 void VisitOMPAtomicDirective(const OMPAtomicDirective *D);
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002029 void VisitOMPTargetDirective(const OMPTargetDirective *D);
Michael Wong65f367f2015-07-21 13:44:28 +00002030 void VisitOMPTargetDataDirective(const OMPTargetDataDirective *D);
Samuel Antaodf67fc42016-01-19 19:15:56 +00002031 void VisitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective *D);
Samuel Antao72590762016-01-19 20:04:50 +00002032 void VisitOMPTargetExitDataDirective(const OMPTargetExitDataDirective *D);
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002033 void VisitOMPTargetParallelDirective(const OMPTargetParallelDirective *D);
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002034 void
2035 VisitOMPTargetParallelForDirective(const OMPTargetParallelForDirective *D);
Alexey Bataev13314bf2014-10-09 04:18:56 +00002036 void VisitOMPTeamsDirective(const OMPTeamsDirective *D);
Alexey Bataev49f6e782015-12-01 04:18:41 +00002037 void VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D);
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002038 void VisitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective *D);
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002039 void VisitOMPDistributeDirective(const OMPDistributeDirective *D);
Carlo Bertolli9925f152016-06-27 14:55:37 +00002040 void VisitOMPDistributeParallelForDirective(
2041 const OMPDistributeParallelForDirective *D);
Kelvin Li4a39add2016-07-05 05:00:15 +00002042 void VisitOMPDistributeParallelForSimdDirective(
2043 const OMPDistributeParallelForSimdDirective *D);
Kelvin Li787f3fc2016-07-06 04:45:38 +00002044 void VisitOMPDistributeSimdDirective(const OMPDistributeSimdDirective *D);
Kelvin Lia579b912016-07-14 02:54:56 +00002045 void VisitOMPTargetParallelForSimdDirective(
2046 const OMPTargetParallelForSimdDirective *D);
Kelvin Li986330c2016-07-20 22:57:10 +00002047 void VisitOMPTargetSimdDirective(const OMPTargetSimdDirective *D);
Kelvin Li02532872016-08-05 14:37:37 +00002048 void VisitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective *D);
Kelvin Li4e325f72016-10-25 12:50:55 +00002049 void VisitOMPTeamsDistributeSimdDirective(
2050 const OMPTeamsDistributeSimdDirective *D);
Kelvin Li579e41c2016-11-30 23:51:03 +00002051 void VisitOMPTeamsDistributeParallelForSimdDirective(
2052 const OMPTeamsDistributeParallelForSimdDirective *D);
Kelvin Li7ade93f2016-12-09 03:24:30 +00002053 void VisitOMPTeamsDistributeParallelForDirective(
2054 const OMPTeamsDistributeParallelForDirective *D);
Kelvin Libf594a52016-12-17 05:48:59 +00002055 void VisitOMPTargetTeamsDirective(const OMPTargetTeamsDirective *D);
Kelvin Li83c451e2016-12-25 04:52:54 +00002056 void VisitOMPTargetTeamsDistributeDirective(
2057 const OMPTargetTeamsDistributeDirective *D);
Kelvin Li80e8f562016-12-29 22:16:30 +00002058 void VisitOMPTargetTeamsDistributeParallelForDirective(
2059 const OMPTargetTeamsDistributeParallelForDirective *D);
Kelvin Li1851df52017-01-03 05:23:48 +00002060 void VisitOMPTargetTeamsDistributeParallelForSimdDirective(
2061 const OMPTargetTeamsDistributeParallelForSimdDirective *D);
Kelvin Lida681182017-01-10 18:08:18 +00002062 void VisitOMPTargetTeamsDistributeSimdDirective(
2063 const OMPTargetTeamsDistributeSimdDirective *D);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002064
Guy Benyei11169dd2012-12-18 14:30:41 +00002065private:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002066 void AddDeclarationNameInfo(const Stmt *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00002067 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
James Y Knight04ec5bf2015-12-24 02:59:37 +00002068 void AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2069 unsigned NumTemplateArgs);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002070 void AddMemberRef(const FieldDecl *D, SourceLocation L);
2071 void AddStmt(const Stmt *S);
2072 void AddDecl(const Decl *D, bool isFirst = true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002073 void AddTypeLoc(TypeSourceInfo *TI);
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002074 void EnqueueChildren(const Stmt *S);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002075 void EnqueueChildren(const OMPClause *S);
Guy Benyei11169dd2012-12-18 14:30:41 +00002076};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002077} // end anonyous namespace
Guy Benyei11169dd2012-12-18 14:30:41 +00002078
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002079void EnqueueVisitor::AddDeclarationNameInfo(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002080 // 'S' should always be non-null, since it comes from the
2081 // statement we are visiting.
2082 WL.push_back(DeclarationNameInfoVisit(S, Parent));
2083}
2084
2085void
2086EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
2087 if (Qualifier)
2088 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
2089}
2090
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002091void EnqueueVisitor::AddStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002092 if (S)
2093 WL.push_back(StmtVisit(S, Parent));
2094}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002095void EnqueueVisitor::AddDecl(const Decl *D, bool isFirst) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002096 if (D)
2097 WL.push_back(DeclVisit(D, Parent, isFirst));
2098}
James Y Knight04ec5bf2015-12-24 02:59:37 +00002099void EnqueueVisitor::AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2100 unsigned NumTemplateArgs) {
2101 WL.push_back(ExplicitTemplateArgsVisit(A, A + NumTemplateArgs, Parent));
Guy Benyei11169dd2012-12-18 14:30:41 +00002102}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002103void EnqueueVisitor::AddMemberRef(const FieldDecl *D, SourceLocation L) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002104 if (D)
2105 WL.push_back(MemberRefVisit(D, L, Parent));
2106}
2107void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
2108 if (TI)
2109 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
2110 }
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002111void EnqueueVisitor::EnqueueChildren(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002112 unsigned size = WL.size();
Benjamin Kramer642f1732015-07-02 21:03:14 +00002113 for (const Stmt *SubStmt : S->children()) {
2114 AddStmt(SubStmt);
Guy Benyei11169dd2012-12-18 14:30:41 +00002115 }
2116 if (size == WL.size())
2117 return;
2118 // Now reverse the entries we just added. This will match the DFS
2119 // ordering performed by the worklist.
2120 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2121 std::reverse(I, E);
2122}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002123namespace {
2124class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> {
2125 EnqueueVisitor *Visitor;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002126 /// Process clauses with list of variables.
Alexey Bataev756c1962013-09-24 03:17:45 +00002127 template <typename T>
2128 void VisitOMPClauseList(T *Node);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002129public:
2130 OMPClauseEnqueue(EnqueueVisitor *Visitor) : Visitor(Visitor) { }
2131#define OPENMP_CLAUSE(Name, Class) \
2132 void Visit##Class(const Class *C);
2133#include "clang/Basic/OpenMPKinds.def"
Alexey Bataev3392d762016-02-16 11:18:12 +00002134 void VisitOMPClauseWithPreInit(const OMPClauseWithPreInit *C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002135 void VisitOMPClauseWithPostUpdate(const OMPClauseWithPostUpdate *C);
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002136};
2137
Alexey Bataev3392d762016-02-16 11:18:12 +00002138void OMPClauseEnqueue::VisitOMPClauseWithPreInit(
2139 const OMPClauseWithPreInit *C) {
2140 Visitor->AddStmt(C->getPreInitStmt());
2141}
2142
Alexey Bataev005248a2016-02-25 05:25:57 +00002143void OMPClauseEnqueue::VisitOMPClauseWithPostUpdate(
2144 const OMPClauseWithPostUpdate *C) {
Alexey Bataev37e594c2016-03-04 07:21:16 +00002145 VisitOMPClauseWithPreInit(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002146 Visitor->AddStmt(C->getPostUpdateExpr());
2147}
2148
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002149void OMPClauseEnqueue::VisitOMPIfClause(const OMPIfClause *C) {
Arpith Chacko Jacobfe4890a2017-01-18 20:40:48 +00002150 VisitOMPClauseWithPreInit(C);
Alexey Bataevaadd52e2014-02-13 05:29:23 +00002151 Visitor->AddStmt(C->getCondition());
2152}
2153
Alexey Bataev3778b602014-07-17 07:32:53 +00002154void OMPClauseEnqueue::VisitOMPFinalClause(const OMPFinalClause *C) {
2155 Visitor->AddStmt(C->getCondition());
2156}
2157
Alexey Bataev568a8332014-03-06 06:15:19 +00002158void OMPClauseEnqueue::VisitOMPNumThreadsClause(const OMPNumThreadsClause *C) {
Arpith Chacko Jacob33c849a2017-01-25 00:57:16 +00002159 VisitOMPClauseWithPreInit(C);
Alexey Bataev568a8332014-03-06 06:15:19 +00002160 Visitor->AddStmt(C->getNumThreads());
2161}
2162
Alexey Bataev62c87d22014-03-21 04:51:18 +00002163void OMPClauseEnqueue::VisitOMPSafelenClause(const OMPSafelenClause *C) {
2164 Visitor->AddStmt(C->getSafelen());
2165}
2166
Alexey Bataev66b15b52015-08-21 11:14:16 +00002167void OMPClauseEnqueue::VisitOMPSimdlenClause(const OMPSimdlenClause *C) {
2168 Visitor->AddStmt(C->getSimdlen());
2169}
2170
Alexander Musman8bd31e62014-05-27 15:12:19 +00002171void OMPClauseEnqueue::VisitOMPCollapseClause(const OMPCollapseClause *C) {
2172 Visitor->AddStmt(C->getNumForLoops());
2173}
2174
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002175void OMPClauseEnqueue::VisitOMPDefaultClause(const OMPDefaultClause *C) { }
Alexey Bataev756c1962013-09-24 03:17:45 +00002176
Alexey Bataevbcbadb62014-05-06 06:04:14 +00002177void OMPClauseEnqueue::VisitOMPProcBindClause(const OMPProcBindClause *C) { }
2178
Alexey Bataev56dafe82014-06-20 07:16:17 +00002179void OMPClauseEnqueue::VisitOMPScheduleClause(const OMPScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002180 VisitOMPClauseWithPreInit(C);
Alexey Bataev56dafe82014-06-20 07:16:17 +00002181 Visitor->AddStmt(C->getChunkSize());
2182}
2183
Alexey Bataev10e775f2015-07-30 11:36:16 +00002184void OMPClauseEnqueue::VisitOMPOrderedClause(const OMPOrderedClause *C) {
2185 Visitor->AddStmt(C->getNumForLoops());
2186}
Alexey Bataev142e1fc2014-06-20 09:44:06 +00002187
Alexey Bataev236070f2014-06-20 11:19:47 +00002188void OMPClauseEnqueue::VisitOMPNowaitClause(const OMPNowaitClause *) {}
2189
Alexey Bataev7aea99a2014-07-17 12:19:31 +00002190void OMPClauseEnqueue::VisitOMPUntiedClause(const OMPUntiedClause *) {}
2191
Alexey Bataev74ba3a52014-07-17 12:47:03 +00002192void OMPClauseEnqueue::VisitOMPMergeableClause(const OMPMergeableClause *) {}
2193
Alexey Bataevf98b00c2014-07-23 02:27:21 +00002194void OMPClauseEnqueue::VisitOMPReadClause(const OMPReadClause *) {}
2195
Alexey Bataevdea47612014-07-23 07:46:59 +00002196void OMPClauseEnqueue::VisitOMPWriteClause(const OMPWriteClause *) {}
2197
Alexey Bataev67a4f222014-07-23 10:25:33 +00002198void OMPClauseEnqueue::VisitOMPUpdateClause(const OMPUpdateClause *) {}
2199
Alexey Bataev459dec02014-07-24 06:46:57 +00002200void OMPClauseEnqueue::VisitOMPCaptureClause(const OMPCaptureClause *) {}
2201
Alexey Bataev82bad8b2014-07-24 08:55:34 +00002202void OMPClauseEnqueue::VisitOMPSeqCstClause(const OMPSeqCstClause *) {}
2203
Alexey Bataev346265e2015-09-25 10:37:12 +00002204void OMPClauseEnqueue::VisitOMPThreadsClause(const OMPThreadsClause *) {}
2205
Alexey Bataevd14d1e62015-09-28 06:39:35 +00002206void OMPClauseEnqueue::VisitOMPSIMDClause(const OMPSIMDClause *) {}
2207
Alexey Bataevb825de12015-12-07 10:51:44 +00002208void OMPClauseEnqueue::VisitOMPNogroupClause(const OMPNogroupClause *) {}
2209
Michael Wonge710d542015-08-07 16:16:36 +00002210void OMPClauseEnqueue::VisitOMPDeviceClause(const OMPDeviceClause *C) {
2211 Visitor->AddStmt(C->getDevice());
2212}
2213
Kelvin Li099bb8c2015-11-24 20:50:12 +00002214void OMPClauseEnqueue::VisitOMPNumTeamsClause(const OMPNumTeamsClause *C) {
Arpith Chacko Jacobbc126342017-01-25 11:28:18 +00002215 VisitOMPClauseWithPreInit(C);
Kelvin Li099bb8c2015-11-24 20:50:12 +00002216 Visitor->AddStmt(C->getNumTeams());
2217}
2218
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002219void OMPClauseEnqueue::VisitOMPThreadLimitClause(const OMPThreadLimitClause *C) {
Arpith Chacko Jacob7ecc0b72017-01-25 11:44:35 +00002220 VisitOMPClauseWithPreInit(C);
Kelvin Lia15fb1a2015-11-27 18:47:36 +00002221 Visitor->AddStmt(C->getThreadLimit());
2222}
2223
Alexey Bataeva0569352015-12-01 10:17:31 +00002224void OMPClauseEnqueue::VisitOMPPriorityClause(const OMPPriorityClause *C) {
2225 Visitor->AddStmt(C->getPriority());
2226}
2227
Alexey Bataev1fd4aed2015-12-07 12:52:51 +00002228void OMPClauseEnqueue::VisitOMPGrainsizeClause(const OMPGrainsizeClause *C) {
2229 Visitor->AddStmt(C->getGrainsize());
2230}
2231
Alexey Bataev382967a2015-12-08 12:06:20 +00002232void OMPClauseEnqueue::VisitOMPNumTasksClause(const OMPNumTasksClause *C) {
2233 Visitor->AddStmt(C->getNumTasks());
2234}
2235
Alexey Bataev28c75412015-12-15 08:19:24 +00002236void OMPClauseEnqueue::VisitOMPHintClause(const OMPHintClause *C) {
2237 Visitor->AddStmt(C->getHint());
2238}
2239
Alexey Bataev756c1962013-09-24 03:17:45 +00002240template<typename T>
2241void OMPClauseEnqueue::VisitOMPClauseList(T *Node) {
Alexey Bataev03b340a2014-10-21 03:16:40 +00002242 for (const auto *I : Node->varlists()) {
Aaron Ballman2205d2a2014-03-14 15:55:35 +00002243 Visitor->AddStmt(I);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002244 }
Alexey Bataev756c1962013-09-24 03:17:45 +00002245}
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002246
2247void OMPClauseEnqueue::VisitOMPPrivateClause(const OMPPrivateClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002248 VisitOMPClauseList(C);
Alexey Bataev03b340a2014-10-21 03:16:40 +00002249 for (const auto *E : C->private_copies()) {
2250 Visitor->AddStmt(E);
2251 }
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002252}
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002253void OMPClauseEnqueue::VisitOMPFirstprivateClause(
2254 const OMPFirstprivateClause *C) {
2255 VisitOMPClauseList(C);
Alexey Bataev417089f2016-02-17 13:19:37 +00002256 VisitOMPClauseWithPreInit(C);
2257 for (const auto *E : C->private_copies()) {
2258 Visitor->AddStmt(E);
2259 }
2260 for (const auto *E : C->inits()) {
2261 Visitor->AddStmt(E);
2262 }
Alexey Bataevd5af8e42013-10-01 05:32:34 +00002263}
Alexander Musman1bb328c2014-06-04 13:06:39 +00002264void OMPClauseEnqueue::VisitOMPLastprivateClause(
2265 const OMPLastprivateClause *C) {
2266 VisitOMPClauseList(C);
Alexey Bataev005248a2016-02-25 05:25:57 +00002267 VisitOMPClauseWithPostUpdate(C);
Alexey Bataev38e89532015-04-16 04:54:05 +00002268 for (auto *E : C->private_copies()) {
2269 Visitor->AddStmt(E);
2270 }
2271 for (auto *E : C->source_exprs()) {
2272 Visitor->AddStmt(E);
2273 }
2274 for (auto *E : C->destination_exprs()) {
2275 Visitor->AddStmt(E);
2276 }
2277 for (auto *E : C->assignment_ops()) {
2278 Visitor->AddStmt(E);
2279 }
Alexander Musman1bb328c2014-06-04 13:06:39 +00002280}
Alexey Bataev758e55e2013-09-06 18:03:48 +00002281void OMPClauseEnqueue::VisitOMPSharedClause(const OMPSharedClause *C) {
Alexey Bataev756c1962013-09-24 03:17:45 +00002282 VisitOMPClauseList(C);
Alexey Bataev758e55e2013-09-06 18:03:48 +00002283}
Alexey Bataevc5e02582014-06-16 07:08:35 +00002284void OMPClauseEnqueue::VisitOMPReductionClause(const OMPReductionClause *C) {
2285 VisitOMPClauseList(C);
Alexey Bataev61205072016-03-02 04:57:40 +00002286 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevf24e7b12015-10-08 09:10:53 +00002287 for (auto *E : C->privates()) {
2288 Visitor->AddStmt(E);
2289 }
Alexey Bataev794ba0d2015-04-10 10:43:45 +00002290 for (auto *E : C->lhs_exprs()) {
2291 Visitor->AddStmt(E);
2292 }
2293 for (auto *E : C->rhs_exprs()) {
2294 Visitor->AddStmt(E);
2295 }
2296 for (auto *E : C->reduction_ops()) {
2297 Visitor->AddStmt(E);
2298 }
Alexey Bataevc5e02582014-06-16 07:08:35 +00002299}
Alexey Bataev169d96a2017-07-18 20:17:46 +00002300void OMPClauseEnqueue::VisitOMPTaskReductionClause(
2301 const OMPTaskReductionClause *C) {
2302 VisitOMPClauseList(C);
2303 VisitOMPClauseWithPostUpdate(C);
2304 for (auto *E : C->privates()) {
2305 Visitor->AddStmt(E);
2306 }
2307 for (auto *E : C->lhs_exprs()) {
2308 Visitor->AddStmt(E);
2309 }
2310 for (auto *E : C->rhs_exprs()) {
2311 Visitor->AddStmt(E);
2312 }
2313 for (auto *E : C->reduction_ops()) {
2314 Visitor->AddStmt(E);
2315 }
2316}
Alexey Bataevfa312f32017-07-21 18:48:21 +00002317void OMPClauseEnqueue::VisitOMPInReductionClause(
2318 const OMPInReductionClause *C) {
2319 VisitOMPClauseList(C);
2320 VisitOMPClauseWithPostUpdate(C);
2321 for (auto *E : C->privates()) {
2322 Visitor->AddStmt(E);
2323 }
2324 for (auto *E : C->lhs_exprs()) {
2325 Visitor->AddStmt(E);
2326 }
2327 for (auto *E : C->rhs_exprs()) {
2328 Visitor->AddStmt(E);
2329 }
2330 for (auto *E : C->reduction_ops()) {
2331 Visitor->AddStmt(E);
2332 }
Alexey Bataev88202be2017-07-27 13:20:36 +00002333 for (auto *E : C->taskgroup_descriptors())
2334 Visitor->AddStmt(E);
Alexey Bataevfa312f32017-07-21 18:48:21 +00002335}
Alexander Musman8dba6642014-04-22 13:09:42 +00002336void OMPClauseEnqueue::VisitOMPLinearClause(const OMPLinearClause *C) {
2337 VisitOMPClauseList(C);
Alexey Bataev78849fb2016-03-09 09:49:00 +00002338 VisitOMPClauseWithPostUpdate(C);
Alexey Bataevbd9fec12015-08-18 06:47:21 +00002339 for (const auto *E : C->privates()) {
2340 Visitor->AddStmt(E);
2341 }
Alexander Musman3276a272015-03-21 10:12:56 +00002342 for (const auto *E : C->inits()) {
2343 Visitor->AddStmt(E);
2344 }
2345 for (const auto *E : C->updates()) {
2346 Visitor->AddStmt(E);
2347 }
2348 for (const auto *E : C->finals()) {
2349 Visitor->AddStmt(E);
2350 }
Alexander Musman8dba6642014-04-22 13:09:42 +00002351 Visitor->AddStmt(C->getStep());
Alexander Musman3276a272015-03-21 10:12:56 +00002352 Visitor->AddStmt(C->getCalcStep());
Alexander Musman8dba6642014-04-22 13:09:42 +00002353}
Alexander Musmanf0d76e72014-05-29 14:36:25 +00002354void OMPClauseEnqueue::VisitOMPAlignedClause(const OMPAlignedClause *C) {
2355 VisitOMPClauseList(C);
2356 Visitor->AddStmt(C->getAlignment());
2357}
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002358void OMPClauseEnqueue::VisitOMPCopyinClause(const OMPCopyinClause *C) {
2359 VisitOMPClauseList(C);
Alexey Bataevf56f98c2015-04-16 05:39:01 +00002360 for (auto *E : C->source_exprs()) {
2361 Visitor->AddStmt(E);
2362 }
2363 for (auto *E : C->destination_exprs()) {
2364 Visitor->AddStmt(E);
2365 }
2366 for (auto *E : C->assignment_ops()) {
2367 Visitor->AddStmt(E);
2368 }
Alexey Bataevd48bcd82014-03-31 03:36:38 +00002369}
Alexey Bataevbae9a792014-06-27 10:37:06 +00002370void
2371OMPClauseEnqueue::VisitOMPCopyprivateClause(const OMPCopyprivateClause *C) {
2372 VisitOMPClauseList(C);
Alexey Bataeva63048e2015-03-23 06:18:07 +00002373 for (auto *E : C->source_exprs()) {
2374 Visitor->AddStmt(E);
2375 }
2376 for (auto *E : C->destination_exprs()) {
2377 Visitor->AddStmt(E);
2378 }
2379 for (auto *E : C->assignment_ops()) {
2380 Visitor->AddStmt(E);
2381 }
Alexey Bataevbae9a792014-06-27 10:37:06 +00002382}
Alexey Bataev6125da92014-07-21 11:26:11 +00002383void OMPClauseEnqueue::VisitOMPFlushClause(const OMPFlushClause *C) {
2384 VisitOMPClauseList(C);
2385}
Alexey Bataev1c2cfbc2015-06-23 14:25:19 +00002386void OMPClauseEnqueue::VisitOMPDependClause(const OMPDependClause *C) {
2387 VisitOMPClauseList(C);
2388}
Kelvin Li0bff7af2015-11-23 05:32:03 +00002389void OMPClauseEnqueue::VisitOMPMapClause(const OMPMapClause *C) {
2390 VisitOMPClauseList(C);
2391}
Carlo Bertollib4adf552016-01-15 18:50:31 +00002392void OMPClauseEnqueue::VisitOMPDistScheduleClause(
2393 const OMPDistScheduleClause *C) {
Alexey Bataev3392d762016-02-16 11:18:12 +00002394 VisitOMPClauseWithPreInit(C);
Carlo Bertollib4adf552016-01-15 18:50:31 +00002395 Visitor->AddStmt(C->getChunkSize());
Carlo Bertollib4adf552016-01-15 18:50:31 +00002396}
Alexey Bataev3392d762016-02-16 11:18:12 +00002397void OMPClauseEnqueue::VisitOMPDefaultmapClause(
2398 const OMPDefaultmapClause * /*C*/) {}
Samuel Antao661c0902016-05-26 17:39:58 +00002399void OMPClauseEnqueue::VisitOMPToClause(const OMPToClause *C) {
2400 VisitOMPClauseList(C);
2401}
Samuel Antaoec172c62016-05-26 17:49:04 +00002402void OMPClauseEnqueue::VisitOMPFromClause(const OMPFromClause *C) {
2403 VisitOMPClauseList(C);
2404}
Carlo Bertolli2404b172016-07-13 15:37:16 +00002405void OMPClauseEnqueue::VisitOMPUseDevicePtrClause(const OMPUseDevicePtrClause *C) {
2406 VisitOMPClauseList(C);
2407}
Carlo Bertolli70594e92016-07-13 17:16:49 +00002408void OMPClauseEnqueue::VisitOMPIsDevicePtrClause(const OMPIsDevicePtrClause *C) {
2409 VisitOMPClauseList(C);
2410}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002411}
Alexey Bataev756c1962013-09-24 03:17:45 +00002412
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002413void EnqueueVisitor::EnqueueChildren(const OMPClause *S) {
2414 unsigned size = WL.size();
2415 OMPClauseEnqueue Visitor(this);
2416 Visitor.Visit(S);
2417 if (size == WL.size())
2418 return;
2419 // Now reverse the entries we just added. This will match the DFS
2420 // ordering performed by the worklist.
2421 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2422 std::reverse(I, E);
2423}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002424void EnqueueVisitor::VisitAddrLabelExpr(const AddrLabelExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002425 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
2426}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002427void EnqueueVisitor::VisitBlockExpr(const BlockExpr *B) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002428 AddDecl(B->getBlockDecl());
2429}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002430void EnqueueVisitor::VisitCompoundLiteralExpr(const CompoundLiteralExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002431 EnqueueChildren(E);
2432 AddTypeLoc(E->getTypeSourceInfo());
2433}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002434void EnqueueVisitor::VisitCompoundStmt(const CompoundStmt *S) {
Pete Cooper57d3f142015-07-30 17:22:52 +00002435 for (auto &I : llvm::reverse(S->body()))
2436 AddStmt(I);
Guy Benyei11169dd2012-12-18 14:30:41 +00002437}
2438void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002439VisitMSDependentExistsStmt(const MSDependentExistsStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002440 AddStmt(S->getSubStmt());
2441 AddDeclarationNameInfo(S);
2442 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
2443 AddNestedNameSpecifierLoc(QualifierLoc);
2444}
2445
2446void EnqueueVisitor::
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002447VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002448 if (E->hasExplicitTemplateArgs())
2449 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002450 AddDeclarationNameInfo(E);
2451 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2452 AddNestedNameSpecifierLoc(QualifierLoc);
2453 if (!E->isImplicitAccess())
2454 AddStmt(E->getBase());
2455}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002456void EnqueueVisitor::VisitCXXNewExpr(const CXXNewExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002457 // Enqueue the initializer , if any.
2458 AddStmt(E->getInitializer());
2459 // Enqueue the array size, if any.
2460 AddStmt(E->getArraySize());
2461 // Enqueue the allocated type.
2462 AddTypeLoc(E->getAllocatedTypeSourceInfo());
2463 // Enqueue the placement arguments.
2464 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
2465 AddStmt(E->getPlacementArg(I-1));
2466}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002467void EnqueueVisitor::VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *CE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002468 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
2469 AddStmt(CE->getArg(I-1));
2470 AddStmt(CE->getCallee());
2471 AddStmt(CE->getArg(0));
2472}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002473void EnqueueVisitor::VisitCXXPseudoDestructorExpr(
2474 const CXXPseudoDestructorExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002475 // Visit the name of the type being destroyed.
2476 AddTypeLoc(E->getDestroyedTypeInfo());
2477 // Visit the scope type that looks disturbingly like the nested-name-specifier
2478 // but isn't.
2479 AddTypeLoc(E->getScopeTypeInfo());
2480 // Visit the nested-name-specifier.
2481 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2482 AddNestedNameSpecifierLoc(QualifierLoc);
2483 // Visit base expression.
2484 AddStmt(E->getBase());
2485}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002486void EnqueueVisitor::VisitCXXScalarValueInitExpr(
2487 const CXXScalarValueInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002488 AddTypeLoc(E->getTypeSourceInfo());
2489}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002490void EnqueueVisitor::VisitCXXTemporaryObjectExpr(
2491 const CXXTemporaryObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002492 EnqueueChildren(E);
2493 AddTypeLoc(E->getTypeSourceInfo());
2494}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002495void EnqueueVisitor::VisitCXXTypeidExpr(const CXXTypeidExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002496 EnqueueChildren(E);
2497 if (E->isTypeOperand())
2498 AddTypeLoc(E->getTypeOperandSourceInfo());
2499}
2500
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002501void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(
2502 const CXXUnresolvedConstructExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002503 EnqueueChildren(E);
2504 AddTypeLoc(E->getTypeSourceInfo());
2505}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002506void EnqueueVisitor::VisitCXXUuidofExpr(const CXXUuidofExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002507 EnqueueChildren(E);
2508 if (E->isTypeOperand())
2509 AddTypeLoc(E->getTypeOperandSourceInfo());
2510}
2511
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002512void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002513 EnqueueChildren(S);
2514 AddDecl(S->getExceptionDecl());
2515}
2516
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002517void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002518 AddStmt(S->getBody());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002519 AddStmt(S->getRangeInit());
Argyrios Kyrtzidiscde70692014-11-13 09:50:19 +00002520 AddDecl(S->getLoopVariable());
Argyrios Kyrtzidis99891242014-11-13 09:03:21 +00002521}
2522
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002523void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002524 if (DR->hasExplicitTemplateArgs())
2525 AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002526 WL.push_back(DeclRefExprParts(DR, Parent));
2527}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002528void EnqueueVisitor::VisitDependentScopeDeclRefExpr(
2529 const DependentScopeDeclRefExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002530 if (E->hasExplicitTemplateArgs())
2531 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002532 AddDeclarationNameInfo(E);
2533 AddNestedNameSpecifierLoc(E->getQualifierLoc());
2534}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002535void EnqueueVisitor::VisitDeclStmt(const DeclStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002536 unsigned size = WL.size();
2537 bool isFirst = true;
Aaron Ballman535bbcc2014-03-14 17:01:24 +00002538 for (const auto *D : S->decls()) {
2539 AddDecl(D, isFirst);
Guy Benyei11169dd2012-12-18 14:30:41 +00002540 isFirst = false;
2541 }
2542 if (size == WL.size())
2543 return;
2544 // Now reverse the entries we just added. This will match the DFS
2545 // ordering performed by the worklist.
2546 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2547 std::reverse(I, E);
2548}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002549void EnqueueVisitor::VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002550 AddStmt(E->getInit());
David Majnemerf7e36092016-06-23 00:15:04 +00002551 for (const DesignatedInitExpr::Designator &D :
2552 llvm::reverse(E->designators())) {
2553 if (D.isFieldDesignator()) {
2554 if (FieldDecl *Field = D.getField())
2555 AddMemberRef(Field, D.getFieldLoc());
Guy Benyei11169dd2012-12-18 14:30:41 +00002556 continue;
2557 }
David Majnemerf7e36092016-06-23 00:15:04 +00002558 if (D.isArrayDesignator()) {
2559 AddStmt(E->getArrayIndex(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002560 continue;
2561 }
David Majnemerf7e36092016-06-23 00:15:04 +00002562 assert(D.isArrayRangeDesignator() && "Unknown designator kind");
2563 AddStmt(E->getArrayRangeEnd(D));
2564 AddStmt(E->getArrayRangeStart(D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002565 }
2566}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002567void EnqueueVisitor::VisitExplicitCastExpr(const ExplicitCastExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002568 EnqueueChildren(E);
2569 AddTypeLoc(E->getTypeInfoAsWritten());
2570}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002571void EnqueueVisitor::VisitForStmt(const ForStmt *FS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002572 AddStmt(FS->getBody());
2573 AddStmt(FS->getInc());
2574 AddStmt(FS->getCond());
2575 AddDecl(FS->getConditionVariable());
2576 AddStmt(FS->getInit());
2577}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002578void EnqueueVisitor::VisitGotoStmt(const GotoStmt *GS) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002579 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2580}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002581void EnqueueVisitor::VisitIfStmt(const IfStmt *If) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002582 AddStmt(If->getElse());
2583 AddStmt(If->getThen());
2584 AddStmt(If->getCond());
2585 AddDecl(If->getConditionVariable());
2586}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002587void EnqueueVisitor::VisitInitListExpr(const InitListExpr *IE) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002588 // We care about the syntactic form of the initializer list, only.
2589 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2590 IE = Syntactic;
2591 EnqueueChildren(IE);
2592}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002593void EnqueueVisitor::VisitMemberExpr(const MemberExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002594 WL.push_back(MemberExprParts(M, Parent));
2595
2596 // If the base of the member access expression is an implicit 'this', don't
2597 // visit it.
2598 // FIXME: If we ever want to show these implicit accesses, this will be
2599 // unfortunate. However, clang_getCursor() relies on this behavior.
Argyrios Kyrtzidis58d0e7a2015-03-13 04:40:07 +00002600 if (M->isImplicitAccess())
2601 return;
2602
2603 // Ignore base anonymous struct/union fields, otherwise they will shadow the
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002604 // real field that we are interested in.
Argyrios Kyrtzidis58d0e7a2015-03-13 04:40:07 +00002605 if (auto *SubME = dyn_cast<MemberExpr>(M->getBase())) {
2606 if (auto *FD = dyn_cast_or_null<FieldDecl>(SubME->getMemberDecl())) {
2607 if (FD->isAnonymousStructOrUnion()) {
2608 AddStmt(SubME->getBase());
2609 return;
2610 }
2611 }
2612 }
2613
2614 AddStmt(M->getBase());
Guy Benyei11169dd2012-12-18 14:30:41 +00002615}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002616void EnqueueVisitor::VisitObjCEncodeExpr(const ObjCEncodeExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 AddTypeLoc(E->getEncodedTypeSourceInfo());
2618}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002619void EnqueueVisitor::VisitObjCMessageExpr(const ObjCMessageExpr *M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002620 EnqueueChildren(M);
2621 AddTypeLoc(M->getClassReceiverTypeInfo());
2622}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002623void EnqueueVisitor::VisitOffsetOfExpr(const OffsetOfExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002624 // Visit the components of the offsetof expression.
2625 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002626 const OffsetOfNode &Node = E->getComponent(I-1);
2627 switch (Node.getKind()) {
2628 case OffsetOfNode::Array:
2629 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2630 break;
2631 case OffsetOfNode::Field:
2632 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
2633 break;
2634 case OffsetOfNode::Identifier:
2635 case OffsetOfNode::Base:
2636 continue;
2637 }
2638 }
2639 // Visit the type into which we're computing the offset.
2640 AddTypeLoc(E->getTypeSourceInfo());
2641}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002642void EnqueueVisitor::VisitOverloadExpr(const OverloadExpr *E) {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002643 if (E->hasExplicitTemplateArgs())
2644 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00002645 WL.push_back(OverloadExprParts(E, Parent));
2646}
2647void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002648 const UnaryExprOrTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002649 EnqueueChildren(E);
2650 if (E->isArgumentType())
2651 AddTypeLoc(E->getArgumentTypeInfo());
2652}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002653void EnqueueVisitor::VisitStmt(const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002654 EnqueueChildren(S);
2655}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002656void EnqueueVisitor::VisitSwitchStmt(const SwitchStmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002657 AddStmt(S->getBody());
2658 AddStmt(S->getCond());
2659 AddDecl(S->getConditionVariable());
2660}
2661
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002662void EnqueueVisitor::VisitWhileStmt(const WhileStmt *W) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002663 AddStmt(W->getBody());
2664 AddStmt(W->getCond());
2665 AddDecl(W->getConditionVariable());
2666}
2667
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002668void EnqueueVisitor::VisitTypeTraitExpr(const TypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002669 for (unsigned I = E->getNumArgs(); I > 0; --I)
2670 AddTypeLoc(E->getArg(I-1));
2671}
2672
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002673void EnqueueVisitor::VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002674 AddTypeLoc(E->getQueriedTypeSourceInfo());
2675}
2676
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002677void EnqueueVisitor::VisitExpressionTraitExpr(const ExpressionTraitExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002678 EnqueueChildren(E);
2679}
2680
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002681void EnqueueVisitor::VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002682 VisitOverloadExpr(U);
2683 if (!U->isImplicitAccess())
2684 AddStmt(U->getBase());
2685}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002686void EnqueueVisitor::VisitVAArgExpr(const VAArgExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002687 AddStmt(E->getSubExpr());
2688 AddTypeLoc(E->getWrittenTypeInfo());
2689}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002690void EnqueueVisitor::VisitSizeOfPackExpr(const SizeOfPackExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002691 WL.push_back(SizeOfPackExprParts(E, Parent));
2692}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002693void EnqueueVisitor::VisitOpaqueValueExpr(const OpaqueValueExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002694 // If the opaque value has a source expression, just transparently
2695 // visit that. This is useful for (e.g.) pseudo-object expressions.
2696 if (Expr *SourceExpr = E->getSourceExpr())
2697 return Visit(SourceExpr);
2698}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002699void EnqueueVisitor::VisitLambdaExpr(const LambdaExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002700 AddStmt(E->getBody());
2701 WL.push_back(LambdaExprParts(E, Parent));
2702}
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002703void EnqueueVisitor::VisitPseudoObjectExpr(const PseudoObjectExpr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002704 // Treat the expression like its syntactic form.
2705 Visit(E->getSyntacticForm());
2706}
2707
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002708void EnqueueVisitor::VisitOMPExecutableDirective(
2709 const OMPExecutableDirective *D) {
2710 EnqueueChildren(D);
2711 for (ArrayRef<OMPClause *>::iterator I = D->clauses().begin(),
2712 E = D->clauses().end();
2713 I != E; ++I)
2714 EnqueueChildren(*I);
2715}
2716
Alexander Musman3aaab662014-08-19 11:27:13 +00002717void EnqueueVisitor::VisitOMPLoopDirective(const OMPLoopDirective *D) {
2718 VisitOMPExecutableDirective(D);
2719}
2720
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00002721void EnqueueVisitor::VisitOMPParallelDirective(const OMPParallelDirective *D) {
2722 VisitOMPExecutableDirective(D);
2723}
2724
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002725void EnqueueVisitor::VisitOMPSimdDirective(const OMPSimdDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002726 VisitOMPLoopDirective(D);
Alexey Bataev1b59ab52014-02-27 08:29:12 +00002727}
2728
Alexey Bataevf29276e2014-06-18 04:14:57 +00002729void EnqueueVisitor::VisitOMPForDirective(const OMPForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002730 VisitOMPLoopDirective(D);
Alexey Bataevf29276e2014-06-18 04:14:57 +00002731}
2732
Alexander Musmanf82886e2014-09-18 05:12:34 +00002733void EnqueueVisitor::VisitOMPForSimdDirective(const OMPForSimdDirective *D) {
2734 VisitOMPLoopDirective(D);
2735}
2736
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00002737void EnqueueVisitor::VisitOMPSectionsDirective(const OMPSectionsDirective *D) {
2738 VisitOMPExecutableDirective(D);
2739}
2740
Alexey Bataev1e0498a2014-06-26 08:21:58 +00002741void EnqueueVisitor::VisitOMPSectionDirective(const OMPSectionDirective *D) {
2742 VisitOMPExecutableDirective(D);
2743}
2744
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00002745void EnqueueVisitor::VisitOMPSingleDirective(const OMPSingleDirective *D) {
2746 VisitOMPExecutableDirective(D);
2747}
2748
Alexander Musman80c22892014-07-17 08:54:58 +00002749void EnqueueVisitor::VisitOMPMasterDirective(const OMPMasterDirective *D) {
2750 VisitOMPExecutableDirective(D);
2751}
2752
Alexander Musmand9ed09f2014-07-21 09:42:05 +00002753void EnqueueVisitor::VisitOMPCriticalDirective(const OMPCriticalDirective *D) {
2754 VisitOMPExecutableDirective(D);
2755 AddDeclarationNameInfo(D);
2756}
2757
Alexey Bataev4acb8592014-07-07 13:01:15 +00002758void
2759EnqueueVisitor::VisitOMPParallelForDirective(const OMPParallelForDirective *D) {
Alexander Musman3aaab662014-08-19 11:27:13 +00002760 VisitOMPLoopDirective(D);
Alexey Bataev4acb8592014-07-07 13:01:15 +00002761}
2762
Alexander Musmane4e893b2014-09-23 09:33:00 +00002763void EnqueueVisitor::VisitOMPParallelForSimdDirective(
2764 const OMPParallelForSimdDirective *D) {
2765 VisitOMPLoopDirective(D);
2766}
2767
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00002768void EnqueueVisitor::VisitOMPParallelSectionsDirective(
2769 const OMPParallelSectionsDirective *D) {
2770 VisitOMPExecutableDirective(D);
2771}
2772
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00002773void EnqueueVisitor::VisitOMPTaskDirective(const OMPTaskDirective *D) {
2774 VisitOMPExecutableDirective(D);
2775}
2776
Alexey Bataev68446b72014-07-18 07:47:19 +00002777void
2778EnqueueVisitor::VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D) {
2779 VisitOMPExecutableDirective(D);
2780}
2781
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00002782void EnqueueVisitor::VisitOMPBarrierDirective(const OMPBarrierDirective *D) {
2783 VisitOMPExecutableDirective(D);
2784}
2785
Alexey Bataev2df347a2014-07-18 10:17:07 +00002786void EnqueueVisitor::VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D) {
2787 VisitOMPExecutableDirective(D);
2788}
2789
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002790void EnqueueVisitor::VisitOMPTaskgroupDirective(
2791 const OMPTaskgroupDirective *D) {
2792 VisitOMPExecutableDirective(D);
Alexey Bataev3b1b8952017-07-25 15:53:26 +00002793 if (const Expr *E = D->getReductionRef())
2794 VisitStmt(E);
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00002795}
2796
Alexey Bataev6125da92014-07-21 11:26:11 +00002797void EnqueueVisitor::VisitOMPFlushDirective(const OMPFlushDirective *D) {
2798 VisitOMPExecutableDirective(D);
2799}
2800
Alexey Bataev9fb6e642014-07-22 06:45:04 +00002801void EnqueueVisitor::VisitOMPOrderedDirective(const OMPOrderedDirective *D) {
2802 VisitOMPExecutableDirective(D);
2803}
2804
Alexey Bataev0162e452014-07-22 10:10:35 +00002805void EnqueueVisitor::VisitOMPAtomicDirective(const OMPAtomicDirective *D) {
2806 VisitOMPExecutableDirective(D);
2807}
2808
Alexey Bataev0bd520b2014-09-19 08:19:49 +00002809void EnqueueVisitor::VisitOMPTargetDirective(const OMPTargetDirective *D) {
2810 VisitOMPExecutableDirective(D);
2811}
2812
Michael Wong65f367f2015-07-21 13:44:28 +00002813void EnqueueVisitor::VisitOMPTargetDataDirective(const
2814 OMPTargetDataDirective *D) {
2815 VisitOMPExecutableDirective(D);
2816}
2817
Samuel Antaodf67fc42016-01-19 19:15:56 +00002818void EnqueueVisitor::VisitOMPTargetEnterDataDirective(
2819 const OMPTargetEnterDataDirective *D) {
2820 VisitOMPExecutableDirective(D);
2821}
2822
Samuel Antao72590762016-01-19 20:04:50 +00002823void EnqueueVisitor::VisitOMPTargetExitDataDirective(
2824 const OMPTargetExitDataDirective *D) {
2825 VisitOMPExecutableDirective(D);
2826}
2827
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00002828void EnqueueVisitor::VisitOMPTargetParallelDirective(
2829 const OMPTargetParallelDirective *D) {
2830 VisitOMPExecutableDirective(D);
2831}
2832
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00002833void EnqueueVisitor::VisitOMPTargetParallelForDirective(
2834 const OMPTargetParallelForDirective *D) {
2835 VisitOMPLoopDirective(D);
2836}
2837
Alexey Bataev13314bf2014-10-09 04:18:56 +00002838void EnqueueVisitor::VisitOMPTeamsDirective(const OMPTeamsDirective *D) {
2839 VisitOMPExecutableDirective(D);
2840}
2841
Alexey Bataev6d4ed052015-07-01 06:57:41 +00002842void EnqueueVisitor::VisitOMPCancellationPointDirective(
2843 const OMPCancellationPointDirective *D) {
2844 VisitOMPExecutableDirective(D);
2845}
2846
Alexey Bataev80909872015-07-02 11:25:17 +00002847void EnqueueVisitor::VisitOMPCancelDirective(const OMPCancelDirective *D) {
2848 VisitOMPExecutableDirective(D);
2849}
2850
Alexey Bataev49f6e782015-12-01 04:18:41 +00002851void EnqueueVisitor::VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D) {
2852 VisitOMPLoopDirective(D);
2853}
2854
Alexey Bataev0a6ed842015-12-03 09:40:15 +00002855void EnqueueVisitor::VisitOMPTaskLoopSimdDirective(
2856 const OMPTaskLoopSimdDirective *D) {
2857 VisitOMPLoopDirective(D);
2858}
2859
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00002860void EnqueueVisitor::VisitOMPDistributeDirective(
2861 const OMPDistributeDirective *D) {
2862 VisitOMPLoopDirective(D);
2863}
2864
Carlo Bertolli9925f152016-06-27 14:55:37 +00002865void EnqueueVisitor::VisitOMPDistributeParallelForDirective(
2866 const OMPDistributeParallelForDirective *D) {
2867 VisitOMPLoopDirective(D);
2868}
2869
Kelvin Li4a39add2016-07-05 05:00:15 +00002870void EnqueueVisitor::VisitOMPDistributeParallelForSimdDirective(
2871 const OMPDistributeParallelForSimdDirective *D) {
2872 VisitOMPLoopDirective(D);
2873}
2874
Kelvin Li787f3fc2016-07-06 04:45:38 +00002875void EnqueueVisitor::VisitOMPDistributeSimdDirective(
2876 const OMPDistributeSimdDirective *D) {
2877 VisitOMPLoopDirective(D);
2878}
2879
Kelvin Lia579b912016-07-14 02:54:56 +00002880void EnqueueVisitor::VisitOMPTargetParallelForSimdDirective(
2881 const OMPTargetParallelForSimdDirective *D) {
2882 VisitOMPLoopDirective(D);
2883}
2884
Kelvin Li986330c2016-07-20 22:57:10 +00002885void EnqueueVisitor::VisitOMPTargetSimdDirective(
2886 const OMPTargetSimdDirective *D) {
2887 VisitOMPLoopDirective(D);
2888}
2889
Kelvin Li02532872016-08-05 14:37:37 +00002890void EnqueueVisitor::VisitOMPTeamsDistributeDirective(
2891 const OMPTeamsDistributeDirective *D) {
2892 VisitOMPLoopDirective(D);
2893}
2894
Kelvin Li4e325f72016-10-25 12:50:55 +00002895void EnqueueVisitor::VisitOMPTeamsDistributeSimdDirective(
2896 const OMPTeamsDistributeSimdDirective *D) {
2897 VisitOMPLoopDirective(D);
2898}
2899
Kelvin Li579e41c2016-11-30 23:51:03 +00002900void EnqueueVisitor::VisitOMPTeamsDistributeParallelForSimdDirective(
2901 const OMPTeamsDistributeParallelForSimdDirective *D) {
2902 VisitOMPLoopDirective(D);
2903}
2904
Kelvin Li7ade93f2016-12-09 03:24:30 +00002905void EnqueueVisitor::VisitOMPTeamsDistributeParallelForDirective(
2906 const OMPTeamsDistributeParallelForDirective *D) {
2907 VisitOMPLoopDirective(D);
2908}
2909
Kelvin Libf594a52016-12-17 05:48:59 +00002910void EnqueueVisitor::VisitOMPTargetTeamsDirective(
2911 const OMPTargetTeamsDirective *D) {
2912 VisitOMPExecutableDirective(D);
2913}
2914
Kelvin Li83c451e2016-12-25 04:52:54 +00002915void EnqueueVisitor::VisitOMPTargetTeamsDistributeDirective(
2916 const OMPTargetTeamsDistributeDirective *D) {
2917 VisitOMPLoopDirective(D);
2918}
2919
Kelvin Li80e8f562016-12-29 22:16:30 +00002920void EnqueueVisitor::VisitOMPTargetTeamsDistributeParallelForDirective(
2921 const OMPTargetTeamsDistributeParallelForDirective *D) {
2922 VisitOMPLoopDirective(D);
2923}
2924
Kelvin Li1851df52017-01-03 05:23:48 +00002925void EnqueueVisitor::VisitOMPTargetTeamsDistributeParallelForSimdDirective(
2926 const OMPTargetTeamsDistributeParallelForSimdDirective *D) {
2927 VisitOMPLoopDirective(D);
2928}
2929
Kelvin Lida681182017-01-10 18:08:18 +00002930void EnqueueVisitor::VisitOMPTargetTeamsDistributeSimdDirective(
2931 const OMPTargetTeamsDistributeSimdDirective *D) {
2932 VisitOMPLoopDirective(D);
2933}
2934
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002935void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, const Stmt *S) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002936 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
2937}
2938
2939bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2940 if (RegionOfInterest.isValid()) {
2941 SourceRange Range = getRawCursorExtent(C);
2942 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2943 return false;
2944 }
2945 return true;
2946}
2947
2948bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2949 while (!WL.empty()) {
2950 // Dequeue the worklist item.
Robert Wilhelm25284cc2013-08-23 16:11:15 +00002951 VisitorJob LI = WL.pop_back_val();
Guy Benyei11169dd2012-12-18 14:30:41 +00002952
2953 // Set the Parent field, then back to its old value once we're done.
2954 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2955
2956 switch (LI.getKind()) {
2957 case VisitorJob::DeclVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002958 const Decl *D = cast<DeclVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002959 if (!D)
2960 continue;
2961
2962 // For now, perform default visitation for Decls.
2963 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2964 cast<DeclVisit>(&LI)->isFirst())))
2965 return true;
2966
2967 continue;
2968 }
2969 case VisitorJob::ExplicitTemplateArgsVisitKind: {
James Y Knight04ec5bf2015-12-24 02:59:37 +00002970 for (const TemplateArgumentLoc &Arg :
2971 *cast<ExplicitTemplateArgsVisit>(&LI)) {
2972 if (VisitTemplateArgumentLoc(Arg))
Guy Benyei11169dd2012-12-18 14:30:41 +00002973 return true;
2974 }
2975 continue;
2976 }
2977 case VisitorJob::TypeLocVisitKind: {
2978 // Perform default visitation for TypeLocs.
2979 if (Visit(cast<TypeLocVisit>(&LI)->get()))
2980 return true;
2981 continue;
2982 }
2983 case VisitorJob::LabelRefVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00002984 const LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00002985 if (LabelStmt *stmt = LS->getStmt()) {
2986 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2987 TU))) {
2988 return true;
2989 }
2990 }
2991 continue;
2992 }
2993
2994 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2995 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2996 if (VisitNestedNameSpecifierLoc(V->get()))
2997 return true;
2998 continue;
2999 }
3000
3001 case VisitorJob::DeclarationNameInfoVisitKind: {
3002 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
3003 ->get()))
3004 return true;
3005 continue;
3006 }
3007 case VisitorJob::MemberRefVisitKind: {
3008 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
3009 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
3010 return true;
3011 continue;
3012 }
3013 case VisitorJob::StmtVisitKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003014 const Stmt *S = cast<StmtVisit>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003015 if (!S)
3016 continue;
3017
3018 // Update the current cursor.
3019 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
3020 if (!IsInRegionOfInterest(Cursor))
3021 continue;
3022 switch (Visitor(Cursor, Parent, ClientData)) {
3023 case CXChildVisit_Break: return true;
3024 case CXChildVisit_Continue: break;
3025 case CXChildVisit_Recurse:
3026 if (PostChildrenVisitor)
Craig Topper69186e72014-06-08 08:38:04 +00003027 WL.push_back(PostChildrenVisit(nullptr, Cursor));
Guy Benyei11169dd2012-12-18 14:30:41 +00003028 EnqueueWorkList(WL, S);
3029 break;
3030 }
3031 continue;
3032 }
3033 case VisitorJob::MemberExprPartsKind: {
3034 // Handle the other pieces in the MemberExpr besides the base.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003035 const MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003036
3037 // Visit the nested-name-specifier
3038 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
3039 if (VisitNestedNameSpecifierLoc(QualifierLoc))
3040 return true;
3041
3042 // Visit the declaration name.
3043 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
3044 return true;
3045
3046 // Visit the explicitly-specified template arguments, if any.
3047 if (M->hasExplicitTemplateArgs()) {
3048 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
3049 *ArgEnd = Arg + M->getNumTemplateArgs();
3050 Arg != ArgEnd; ++Arg) {
3051 if (VisitTemplateArgumentLoc(*Arg))
3052 return true;
3053 }
3054 }
3055 continue;
3056 }
3057 case VisitorJob::DeclRefExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003058 const DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003059 // Visit nested-name-specifier, if present.
3060 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
3061 if (VisitNestedNameSpecifierLoc(QualifierLoc))
3062 return true;
3063 // Visit declaration name.
3064 if (VisitDeclarationNameInfo(DR->getNameInfo()))
3065 return true;
3066 continue;
3067 }
3068 case VisitorJob::OverloadExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003069 const OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003070 // Visit the nested-name-specifier.
3071 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
3072 if (VisitNestedNameSpecifierLoc(QualifierLoc))
3073 return true;
3074 // Visit the declaration name.
3075 if (VisitDeclarationNameInfo(O->getNameInfo()))
3076 return true;
3077 // Visit the overloaded declaration reference.
3078 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
3079 return true;
3080 continue;
3081 }
3082 case VisitorJob::SizeOfPackExprPartsKind: {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003083 const SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003084 NamedDecl *Pack = E->getPack();
3085 if (isa<TemplateTypeParmDecl>(Pack)) {
3086 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
3087 E->getPackLoc(), TU)))
3088 return true;
3089
3090 continue;
3091 }
3092
3093 if (isa<TemplateTemplateParmDecl>(Pack)) {
3094 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
3095 E->getPackLoc(), TU)))
3096 return true;
3097
3098 continue;
3099 }
3100
3101 // Non-type template parameter packs and function parameter packs are
3102 // treated like DeclRefExpr cursors.
3103 continue;
3104 }
3105
3106 case VisitorJob::LambdaExprPartsKind: {
3107 // Visit captures.
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003108 const LambdaExpr *E = cast<LambdaExprParts>(&LI)->get();
Guy Benyei11169dd2012-12-18 14:30:41 +00003109 for (LambdaExpr::capture_iterator C = E->explicit_capture_begin(),
3110 CEnd = E->explicit_capture_end();
3111 C != CEnd; ++C) {
Richard Smithba71c082013-05-16 06:20:58 +00003112 // FIXME: Lambda init-captures.
3113 if (!C->capturesVariable())
Guy Benyei11169dd2012-12-18 14:30:41 +00003114 continue;
Richard Smithba71c082013-05-16 06:20:58 +00003115
Guy Benyei11169dd2012-12-18 14:30:41 +00003116 if (Visit(MakeCursorVariableRef(C->getCapturedVar(),
3117 C->getLocation(),
3118 TU)))
3119 return true;
3120 }
3121
3122 // Visit parameters and return type, if present.
3123 if (E->hasExplicitParameters() || E->hasExplicitResultType()) {
3124 TypeLoc TL = E->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
3125 if (E->hasExplicitParameters() && E->hasExplicitResultType()) {
3126 // Visit the whole type.
3127 if (Visit(TL))
3128 return true;
David Blaikie6adc78e2013-02-18 22:06:02 +00003129 } else if (FunctionProtoTypeLoc Proto =
3130 TL.getAs<FunctionProtoTypeLoc>()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003131 if (E->hasExplicitParameters()) {
3132 // Visit parameters.
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00003133 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I)
3134 if (Visit(MakeCXCursor(Proto.getParam(I), TU)))
Guy Benyei11169dd2012-12-18 14:30:41 +00003135 return true;
3136 } else {
3137 // Visit result type.
Alp Toker42a16a62014-01-25 23:51:36 +00003138 if (Visit(Proto.getReturnLoc()))
Guy Benyei11169dd2012-12-18 14:30:41 +00003139 return true;
3140 }
3141 }
3142 }
3143 break;
3144 }
3145
3146 case VisitorJob::PostChildrenVisitKind:
3147 if (PostChildrenVisitor(Parent, ClientData))
3148 return true;
3149 break;
3150 }
3151 }
3152 return false;
3153}
3154
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00003155bool CursorVisitor::Visit(const Stmt *S) {
Craig Topper69186e72014-06-08 08:38:04 +00003156 VisitorWorkList *WL = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003157 if (!WorkListFreeList.empty()) {
3158 WL = WorkListFreeList.back();
3159 WL->clear();
3160 WorkListFreeList.pop_back();
3161 }
3162 else {
3163 WL = new VisitorWorkList();
3164 WorkListCache.push_back(WL);
3165 }
3166 EnqueueWorkList(*WL, S);
3167 bool result = RunVisitorWorkList(*WL);
3168 WorkListFreeList.push_back(WL);
3169 return result;
3170}
3171
3172namespace {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003173typedef SmallVector<SourceRange, 4> RefNamePieces;
James Y Knight04ec5bf2015-12-24 02:59:37 +00003174RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
3175 const DeclarationNameInfo &NI, SourceRange QLoc,
3176 const SourceRange *TemplateArgsLoc = nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003177 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
3178 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
3179 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
3180
3181 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
3182
3183 RefNamePieces Pieces;
3184
3185 if (WantQualifier && QLoc.isValid())
3186 Pieces.push_back(QLoc);
3187
3188 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
3189 Pieces.push_back(NI.getLoc());
James Y Knight04ec5bf2015-12-24 02:59:37 +00003190
3191 if (WantTemplateArgs && TemplateArgsLoc && TemplateArgsLoc->isValid())
3192 Pieces.push_back(*TemplateArgsLoc);
3193
Guy Benyei11169dd2012-12-18 14:30:41 +00003194 if (Kind == DeclarationName::CXXOperatorName) {
3195 Pieces.push_back(SourceLocation::getFromRawEncoding(
3196 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
3197 Pieces.push_back(SourceLocation::getFromRawEncoding(
3198 NI.getInfo().CXXOperatorName.EndOpNameLoc));
3199 }
3200
3201 if (WantSinglePiece) {
3202 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
3203 Pieces.clear();
3204 Pieces.push_back(R);
3205 }
3206
3207 return Pieces;
3208}
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003209}
Guy Benyei11169dd2012-12-18 14:30:41 +00003210
3211//===----------------------------------------------------------------------===//
3212// Misc. API hooks.
3213//===----------------------------------------------------------------------===//
3214
Chad Rosier05c71aa2013-03-27 18:28:23 +00003215static void fatal_error_handler(void *user_data, const std::string& reason,
3216 bool gen_crash_diag) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003217 // Write the result out to stderr avoiding errs() because raw_ostreams can
3218 // call report_fatal_error.
3219 fprintf(stderr, "LIBCLANG FATAL ERROR: %s\n", reason.c_str());
3220 ::abort();
3221}
3222
Chandler Carruth66660742014-06-27 16:37:27 +00003223namespace {
3224struct RegisterFatalErrorHandler {
3225 RegisterFatalErrorHandler() {
3226 llvm::install_fatal_error_handler(fatal_error_handler, nullptr);
3227 }
3228};
3229}
3230
3231static llvm::ManagedStatic<RegisterFatalErrorHandler> RegisterFatalErrorHandlerOnce;
3232
Guy Benyei11169dd2012-12-18 14:30:41 +00003233CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
3234 int displayDiagnostics) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003235 // We use crash recovery to make some of our APIs more reliable, implicitly
3236 // enable it.
Argyrios Kyrtzidis3701f542013-11-27 08:58:09 +00003237 if (!getenv("LIBCLANG_DISABLE_CRASH_RECOVERY"))
3238 llvm::CrashRecoveryContext::Enable();
Guy Benyei11169dd2012-12-18 14:30:41 +00003239
Chandler Carruth66660742014-06-27 16:37:27 +00003240 // Look through the managed static to trigger construction of the managed
3241 // static which registers our fatal error handler. This ensures it is only
3242 // registered once.
3243 (void)*RegisterFatalErrorHandlerOnce;
Guy Benyei11169dd2012-12-18 14:30:41 +00003244
Adrian Prantlbc068582015-07-08 01:00:30 +00003245 // Initialize targets for clang module support.
3246 llvm::InitializeAllTargets();
3247 llvm::InitializeAllTargetMCs();
3248 llvm::InitializeAllAsmPrinters();
3249 llvm::InitializeAllAsmParsers();
3250
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003251 CIndexer *CIdxr = new CIndexer();
3252
Guy Benyei11169dd2012-12-18 14:30:41 +00003253 if (excludeDeclarationsFromPCH)
3254 CIdxr->setOnlyLocalDecls();
3255 if (displayDiagnostics)
3256 CIdxr->setDisplayDiagnostics();
3257
3258 if (getenv("LIBCLANG_BGPRIO_INDEX"))
3259 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3260 CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
3261 if (getenv("LIBCLANG_BGPRIO_EDIT"))
3262 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3263 CXGlobalOpt_ThreadBackgroundPriorityForEditing);
3264
3265 return CIdxr;
3266}
3267
3268void clang_disposeIndex(CXIndex CIdx) {
3269 if (CIdx)
3270 delete static_cast<CIndexer *>(CIdx);
3271}
3272
3273void clang_CXIndex_setGlobalOptions(CXIndex CIdx, unsigned options) {
3274 if (CIdx)
3275 static_cast<CIndexer *>(CIdx)->setCXGlobalOptFlags(options);
3276}
3277
3278unsigned clang_CXIndex_getGlobalOptions(CXIndex CIdx) {
3279 if (CIdx)
3280 return static_cast<CIndexer *>(CIdx)->getCXGlobalOptFlags();
3281 return 0;
3282}
3283
Alex Lorenz08615792017-12-04 21:56:36 +00003284void clang_CXIndex_setInvocationEmissionPathOption(CXIndex CIdx,
3285 const char *Path) {
3286 if (CIdx)
3287 static_cast<CIndexer *>(CIdx)->setInvocationEmissionPath(Path ? Path : "");
3288}
3289
Guy Benyei11169dd2012-12-18 14:30:41 +00003290void clang_toggleCrashRecovery(unsigned isEnabled) {
3291 if (isEnabled)
3292 llvm::CrashRecoveryContext::Enable();
3293 else
3294 llvm::CrashRecoveryContext::Disable();
3295}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003296
Guy Benyei11169dd2012-12-18 14:30:41 +00003297CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
3298 const char *ast_filename) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003299 CXTranslationUnit TU;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003300 enum CXErrorCode Result =
3301 clang_createTranslationUnit2(CIdx, ast_filename, &TU);
Reid Klecknerfd48fc62014-02-12 23:56:20 +00003302 (void)Result;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003303 assert((TU && Result == CXError_Success) ||
3304 (!TU && Result != CXError_Success));
3305 return TU;
3306}
3307
3308enum CXErrorCode clang_createTranslationUnit2(CXIndex CIdx,
3309 const char *ast_filename,
3310 CXTranslationUnit *out_TU) {
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003311 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003312 *out_TU = nullptr;
Dmitri Gribenko8850cda2014-02-19 10:24:00 +00003313
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003314 if (!CIdx || !ast_filename || !out_TU)
3315 return CXError_InvalidArguments;
Guy Benyei11169dd2012-12-18 14:30:41 +00003316
Argyrios Kyrtzidis27021012013-05-24 22:24:07 +00003317 LOG_FUNC_SECTION {
3318 *Log << ast_filename;
3319 }
3320
Guy Benyei11169dd2012-12-18 14:30:41 +00003321 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3322 FileSystemOptions FileSystemOpts;
3323
Justin Bognerd512c1e2014-10-15 00:33:06 +00003324 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
3325 CompilerInstance::createDiagnostics(new DiagnosticOptions());
David Blaikie6f7382d2014-08-10 19:08:04 +00003326 std::unique_ptr<ASTUnit> AU = ASTUnit::LoadFromASTFile(
Richard Smithdbafb6c2017-06-29 23:23:46 +00003327 ast_filename, CXXIdx->getPCHContainerOperations()->getRawReader(),
3328 ASTUnit::LoadEverything, Diags,
Adrian Prantl6b21ab22015-08-27 19:46:20 +00003329 FileSystemOpts, /*UseDebugInfo=*/false,
3330 CXXIdx->getOnlyLocalDecls(), None,
David Blaikie6f7382d2014-08-10 19:08:04 +00003331 /*CaptureDiagnostics=*/true,
3332 /*AllowPCHWithCompilerErrors=*/true,
3333 /*UserFilesAreVolatile=*/true);
David Blaikieea4395e2017-01-06 19:49:01 +00003334 *out_TU = MakeCXTranslationUnit(CXXIdx, std::move(AU));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003335 return *out_TU ? CXError_Success : CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003336}
3337
3338unsigned clang_defaultEditingTranslationUnitOptions() {
3339 return CXTranslationUnit_PrecompiledPreamble |
3340 CXTranslationUnit_CacheCompletionResults;
3341}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003342
Guy Benyei11169dd2012-12-18 14:30:41 +00003343CXTranslationUnit
3344clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
3345 const char *source_filename,
3346 int num_command_line_args,
3347 const char * const *command_line_args,
3348 unsigned num_unsaved_files,
3349 struct CXUnsavedFile *unsaved_files) {
3350 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord;
3351 return clang_parseTranslationUnit(CIdx, source_filename,
3352 command_line_args, num_command_line_args,
3353 unsaved_files, num_unsaved_files,
3354 Options);
3355}
3356
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003357static CXErrorCode
3358clang_parseTranslationUnit_Impl(CXIndex CIdx, const char *source_filename,
3359 const char *const *command_line_args,
3360 int num_command_line_args,
3361 ArrayRef<CXUnsavedFile> unsaved_files,
3362 unsigned options, CXTranslationUnit *out_TU) {
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003363 // Set up the initial return values.
3364 if (out_TU)
Craig Topper69186e72014-06-08 08:38:04 +00003365 *out_TU = nullptr;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003366
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003367 // Check arguments.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003368 if (!CIdx || !out_TU)
3369 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003370
Guy Benyei11169dd2012-12-18 14:30:41 +00003371 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3372
3373 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3374 setThreadBackgroundPriority();
3375
3376 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003377 bool CreatePreambleOnFirstParse =
3378 options & CXTranslationUnit_CreatePreambleOnFirstParse;
Guy Benyei11169dd2012-12-18 14:30:41 +00003379 // FIXME: Add a flag for modules.
3380 TranslationUnitKind TUKind
Argyrios Kyrtzidis735e92c2017-06-09 01:20:48 +00003381 = (options & (CXTranslationUnit_Incomplete |
3382 CXTranslationUnit_SingleFileParse))? TU_Prefix : TU_Complete;
Alp Toker8c8a8752013-12-03 06:53:35 +00003383 bool CacheCodeCompletionResults
Ivan Donchevskiif70d28b2018-05-17 09:15:22 +00003384 = options & CXTranslationUnit_CacheCompletionResults;
3385 bool IncludeBriefCommentsInCodeCompletion
3386 = options & CXTranslationUnit_IncludeBriefCommentsInCodeCompletion;
Ivan Donchevskiif70d28b2018-05-17 09:15:22 +00003387 bool SingleFileParse = options & CXTranslationUnit_SingleFileParse;
3388 bool ForSerialization = options & CXTranslationUnit_ForSerialization;
Ivan Donchevskii6e895282018-05-17 09:24:37 +00003389 SkipFunctionBodiesScope SkipFunctionBodies = SkipFunctionBodiesScope::None;
3390 if (options & CXTranslationUnit_SkipFunctionBodies) {
3391 SkipFunctionBodies =
3392 (options & CXTranslationUnit_LimitSkipFunctionBodiesToPreamble)
3393 ? SkipFunctionBodiesScope::Preamble
3394 : SkipFunctionBodiesScope::PreambleAndMainFile;
3395 }
Ivan Donchevskiif70d28b2018-05-17 09:15:22 +00003396
3397 // Configure the diagnostics.
3398 IntrusiveRefCntPtr<DiagnosticsEngine>
Sean Silvaf1b49e22013-01-20 01:58:28 +00003399 Diags(CompilerInstance::createDiagnostics(new DiagnosticOptions));
Guy Benyei11169dd2012-12-18 14:30:41 +00003400
Manuel Klimek016c0242016-03-01 10:56:19 +00003401 if (options & CXTranslationUnit_KeepGoing)
Richard Smithe37391c2017-05-03 00:28:49 +00003402 Diags->setSuppressAfterFatalError(false);
Manuel Klimek016c0242016-03-01 10:56:19 +00003403
Guy Benyei11169dd2012-12-18 14:30:41 +00003404 // Recover resources if we crash before exiting this function.
3405 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
3406 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Alp Tokerf994cef2014-07-05 03:08:06 +00003407 DiagCleanup(Diags.get());
Guy Benyei11169dd2012-12-18 14:30:41 +00003408
Ahmed Charlesb8984322014-03-07 20:03:18 +00003409 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3410 new std::vector<ASTUnit::RemappedFile>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003411
3412 // Recover resources if we crash before exiting this function.
3413 llvm::CrashRecoveryContextCleanupRegistrar<
3414 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3415
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003416 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003417 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00003418 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00003419 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003420 }
3421
Ahmed Charlesb8984322014-03-07 20:03:18 +00003422 std::unique_ptr<std::vector<const char *>> Args(
3423 new std::vector<const char *>());
Guy Benyei11169dd2012-12-18 14:30:41 +00003424
3425 // Recover resources if we crash before exiting this method.
3426 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
3427 ArgsCleanup(Args.get());
3428
3429 // Since the Clang C library is primarily used by batch tools dealing with
3430 // (often very broken) source code, where spell-checking can have a
3431 // significant negative impact on performance (particularly when
3432 // precompiled headers are involved), we disable it by default.
3433 // Only do this if we haven't found a spell-checking-related argument.
3434 bool FoundSpellCheckingArgument = false;
3435 for (int I = 0; I != num_command_line_args; ++I) {
3436 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
3437 strcmp(command_line_args[I], "-fspell-checking") == 0) {
3438 FoundSpellCheckingArgument = true;
3439 break;
3440 }
3441 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003442 Args->insert(Args->end(), command_line_args,
3443 command_line_args + num_command_line_args);
3444
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003445 if (!FoundSpellCheckingArgument)
3446 Args->insert(Args->begin() + 1, "-fno-spell-checking");
3447
Guy Benyei11169dd2012-12-18 14:30:41 +00003448 // The 'source_filename' argument is optional. If the caller does not
3449 // specify it then it is assumed that the source file is specified
3450 // in the actual argument list.
3451 // Put the source file after command_line_args otherwise if '-x' flag is
3452 // present it will be unused.
3453 if (source_filename)
3454 Args->push_back(source_filename);
3455
3456 // Do we need the detailed preprocessing record?
3457 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
3458 Args->push_back("-Xclang");
3459 Args->push_back("-detailed-preprocessing-record");
3460 }
Alex Lorenzcb006402017-04-27 13:47:03 +00003461
3462 // Suppress any editor placeholder diagnostics.
3463 Args->push_back("-fallow-editor-placeholders");
3464
Guy Benyei11169dd2012-12-18 14:30:41 +00003465 unsigned NumErrors = Diags->getClient()->getNumErrors();
Ahmed Charlesb8984322014-03-07 20:03:18 +00003466 std::unique_ptr<ASTUnit> ErrUnit;
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003467 // Unless the user specified that they want the preamble on the first parse
3468 // set it up to be created on the first reparse. This makes the first parse
3469 // faster, trading for a slower (first) reparse.
3470 unsigned PrecompilePreambleAfterNParses =
3471 !PrecompilePreamble ? 0 : 2 - CreatePreambleOnFirstParse;
Alex Lorenz08615792017-12-04 21:56:36 +00003472
Alex Lorenz08615792017-12-04 21:56:36 +00003473 LibclangInvocationReporter InvocationReporter(
3474 *CXXIdx, LibclangInvocationReporter::OperationKind::ParseOperation,
Alex Lorenz690f0e22017-12-07 20:37:50 +00003475 options, llvm::makeArrayRef(*Args), /*InvocationArgs=*/None,
3476 unsaved_files);
Ahmed Charlesb8984322014-03-07 20:03:18 +00003477 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCommandLine(
Adrian Prantlbb165fb2015-06-20 18:53:08 +00003478 Args->data(), Args->data() + Args->size(),
3479 CXXIdx->getPCHContainerOperations(), Diags,
Ahmed Charlesb8984322014-03-07 20:03:18 +00003480 CXXIdx->getClangResourcesPath(), CXXIdx->getOnlyLocalDecls(),
3481 /*CaptureDiagnostics=*/true, *RemappedFiles.get(),
Benjamin Kramer5c248d82015-12-15 09:30:31 +00003482 /*RemappedFilesKeepOriginalName=*/true, PrecompilePreambleAfterNParses,
3483 TUKind, CacheCodeCompletionResults, IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidis735e92c2017-06-09 01:20:48 +00003484 /*AllowPCHWithCompilerErrors=*/true, SkipFunctionBodies, SingleFileParse,
Argyrios Kyrtzidisa3e2ff12015-11-20 03:36:21 +00003485 /*UserFilesAreVolatile=*/true, ForSerialization,
3486 CXXIdx->getPCHContainerOperations()->getRawReader().getFormat(),
3487 &ErrUnit));
Guy Benyei11169dd2012-12-18 14:30:41 +00003488
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003489 // Early failures in LoadFromCommandLine may return with ErrUnit unset.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003490 if (!Unit && !ErrUnit)
3491 return CXError_ASTReadError;
Artem Belevich0ff05cd2015-07-13 23:27:56 +00003492
Guy Benyei11169dd2012-12-18 14:30:41 +00003493 if (NumErrors != Diags->getClient()->getNumErrors()) {
3494 // Make sure to check that 'Unit' is non-NULL.
3495 if (CXXIdx->getDisplayDiagnostics())
3496 printDiagsToStderr(Unit ? Unit.get() : ErrUnit.get());
3497 }
3498
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003499 if (isASTReadError(Unit ? Unit.get() : ErrUnit.get()))
3500 return CXError_ASTReadError;
3501
David Blaikieea4395e2017-01-06 19:49:01 +00003502 *out_TU = MakeCXTranslationUnit(CXXIdx, std::move(Unit));
Alex Lorenz690f0e22017-12-07 20:37:50 +00003503 if (CXTranslationUnitImpl *TU = *out_TU) {
3504 TU->ParsingOptions = options;
3505 TU->Arguments.reserve(Args->size());
3506 for (const char *Arg : *Args)
3507 TU->Arguments.push_back(Arg);
3508 return CXError_Success;
3509 }
3510 return CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003511}
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003512
3513CXTranslationUnit
3514clang_parseTranslationUnit(CXIndex CIdx,
3515 const char *source_filename,
3516 const char *const *command_line_args,
3517 int num_command_line_args,
3518 struct CXUnsavedFile *unsaved_files,
3519 unsigned num_unsaved_files,
3520 unsigned options) {
3521 CXTranslationUnit TU;
3522 enum CXErrorCode Result = clang_parseTranslationUnit2(
3523 CIdx, source_filename, command_line_args, num_command_line_args,
3524 unsaved_files, num_unsaved_files, options, &TU);
Reid Kleckner6eaf05a2014-02-13 01:19:59 +00003525 (void)Result;
Dmitri Gribenko1bf8d912014-02-18 15:20:02 +00003526 assert((TU && Result == CXError_Success) ||
3527 (!TU && Result != CXError_Success));
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003528 return TU;
3529}
3530
3531enum CXErrorCode clang_parseTranslationUnit2(
Benjamin Kramerc02670e2015-11-18 16:14:27 +00003532 CXIndex CIdx, const char *source_filename,
3533 const char *const *command_line_args, int num_command_line_args,
3534 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3535 unsigned options, CXTranslationUnit *out_TU) {
3536 SmallVector<const char *, 4> Args;
3537 Args.push_back("clang");
3538 Args.append(command_line_args, command_line_args + num_command_line_args);
3539 return clang_parseTranslationUnit2FullArgv(
3540 CIdx, source_filename, Args.data(), Args.size(), unsaved_files,
3541 num_unsaved_files, options, out_TU);
3542}
3543
3544enum CXErrorCode clang_parseTranslationUnit2FullArgv(
3545 CXIndex CIdx, const char *source_filename,
3546 const char *const *command_line_args, int num_command_line_args,
3547 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3548 unsigned options, CXTranslationUnit *out_TU) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003549 LOG_FUNC_SECTION {
3550 *Log << source_filename << ": ";
3551 for (int i = 0; i != num_command_line_args; ++i)
3552 *Log << command_line_args[i] << " ";
3553 }
3554
Alp Toker9d85b182014-07-07 01:23:14 +00003555 if (num_unsaved_files && !unsaved_files)
3556 return CXError_InvalidArguments;
3557
Alp Toker5c532982014-07-07 22:42:03 +00003558 CXErrorCode result = CXError_Failure;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003559 auto ParseTranslationUnitImpl = [=, &result] {
3560 result = clang_parseTranslationUnit_Impl(
3561 CIdx, source_filename, command_line_args, num_command_line_args,
3562 llvm::makeArrayRef(unsaved_files, num_unsaved_files), options, out_TU);
3563 };
Erik Verbruggen284848d2017-08-29 09:08:02 +00003564
Guy Benyei11169dd2012-12-18 14:30:41 +00003565 llvm::CrashRecoveryContext CRC;
3566
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003567 if (!RunSafely(CRC, ParseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003568 fprintf(stderr, "libclang: crash detected during parsing: {\n");
3569 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
3570 fprintf(stderr, " 'command_line_args' : [");
3571 for (int i = 0; i != num_command_line_args; ++i) {
3572 if (i)
3573 fprintf(stderr, ", ");
3574 fprintf(stderr, "'%s'", command_line_args[i]);
3575 }
3576 fprintf(stderr, "],\n");
3577 fprintf(stderr, " 'unsaved_files' : [");
3578 for (unsigned i = 0; i != num_unsaved_files; ++i) {
3579 if (i)
3580 fprintf(stderr, ", ");
3581 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
3582 unsaved_files[i].Length);
3583 }
3584 fprintf(stderr, "],\n");
3585 fprintf(stderr, " 'options' : %d,\n", options);
3586 fprintf(stderr, "}\n");
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003587
3588 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00003589 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003590 if (CXTranslationUnit *TU = out_TU)
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00003591 PrintLibclangResourceUsage(*TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003592 }
Alp Toker5c532982014-07-07 22:42:03 +00003593
3594 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003595}
3596
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003597CXString clang_Type_getObjCEncoding(CXType CT) {
3598 CXTranslationUnit tu = static_cast<CXTranslationUnit>(CT.data[1]);
3599 ASTContext &Ctx = getASTUnit(tu)->getASTContext();
3600 std::string encoding;
3601 Ctx.getObjCEncodingForType(QualType::getFromOpaquePtr(CT.data[0]),
3602 encoding);
3603
3604 return cxstring::createDup(encoding);
3605}
3606
3607static const IdentifierInfo *getMacroIdentifier(CXCursor C) {
3608 if (C.kind == CXCursor_MacroDefinition) {
3609 if (const MacroDefinitionRecord *MDR = getCursorMacroDefinition(C))
3610 return MDR->getName();
3611 } else if (C.kind == CXCursor_MacroExpansion) {
3612 MacroExpansionCursor ME = getCursorMacroExpansion(C);
3613 return ME.getName();
3614 }
3615 return nullptr;
3616}
3617
3618unsigned clang_Cursor_isMacroFunctionLike(CXCursor C) {
3619 const IdentifierInfo *II = getMacroIdentifier(C);
3620 if (!II) {
3621 return false;
3622 }
3623 ASTUnit *ASTU = getCursorASTUnit(C);
3624 Preprocessor &PP = ASTU->getPreprocessor();
3625 if (const MacroInfo *MI = PP.getMacroInfo(II))
3626 return MI->isFunctionLike();
3627 return false;
3628}
3629
3630unsigned clang_Cursor_isMacroBuiltin(CXCursor C) {
3631 const IdentifierInfo *II = getMacroIdentifier(C);
3632 if (!II) {
3633 return false;
3634 }
3635 ASTUnit *ASTU = getCursorASTUnit(C);
3636 Preprocessor &PP = ASTU->getPreprocessor();
3637 if (const MacroInfo *MI = PP.getMacroInfo(II))
3638 return MI->isBuiltinMacro();
3639 return false;
3640}
3641
3642unsigned clang_Cursor_isFunctionInlined(CXCursor C) {
3643 const Decl *D = getCursorDecl(C);
3644 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
3645 if (!FD) {
3646 return false;
3647 }
3648 return FD->isInlined();
3649}
3650
3651static StringLiteral* getCFSTR_value(CallExpr *callExpr) {
3652 if (callExpr->getNumArgs() != 1) {
3653 return nullptr;
3654 }
3655
3656 StringLiteral *S = nullptr;
3657 auto *arg = callExpr->getArg(0);
3658 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
3659 ImplicitCastExpr *I = static_cast<ImplicitCastExpr *>(arg);
3660 auto *subExpr = I->getSubExprAsWritten();
3661
3662 if(subExpr->getStmtClass() != Stmt::StringLiteralClass){
3663 return nullptr;
3664 }
3665
3666 S = static_cast<StringLiteral *>(I->getSubExprAsWritten());
3667 } else if (arg->getStmtClass() == Stmt::StringLiteralClass) {
3668 S = static_cast<StringLiteral *>(callExpr->getArg(0));
3669 } else {
3670 return nullptr;
3671 }
3672 return S;
3673}
3674
David Blaikie59272572016-04-13 18:23:33 +00003675struct ExprEvalResult {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003676 CXEvalResultKind EvalType;
3677 union {
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003678 unsigned long long unsignedVal;
3679 long long intVal;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003680 double floatVal;
3681 char *stringVal;
3682 } EvalData;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003683 bool IsUnsignedInt;
David Blaikie59272572016-04-13 18:23:33 +00003684 ~ExprEvalResult() {
3685 if (EvalType != CXEval_UnExposed && EvalType != CXEval_Float &&
3686 EvalType != CXEval_Int) {
3687 delete EvalData.stringVal;
3688 }
3689 }
3690};
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003691
3692void clang_EvalResult_dispose(CXEvalResult E) {
David Blaikie59272572016-04-13 18:23:33 +00003693 delete static_cast<ExprEvalResult *>(E);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003694}
3695
3696CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E) {
3697 if (!E) {
3698 return CXEval_UnExposed;
3699 }
3700 return ((ExprEvalResult *)E)->EvalType;
3701}
3702
3703int clang_EvalResult_getAsInt(CXEvalResult E) {
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003704 return clang_EvalResult_getAsLongLong(E);
3705}
3706
3707long long clang_EvalResult_getAsLongLong(CXEvalResult E) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003708 if (!E) {
3709 return 0;
3710 }
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003711 ExprEvalResult *Result = (ExprEvalResult*)E;
3712 if (Result->IsUnsignedInt)
3713 return Result->EvalData.unsignedVal;
3714 return Result->EvalData.intVal;
3715}
3716
3717unsigned clang_EvalResult_isUnsignedInt(CXEvalResult E) {
3718 return ((ExprEvalResult *)E)->IsUnsignedInt;
3719}
3720
3721unsigned long long clang_EvalResult_getAsUnsigned(CXEvalResult E) {
3722 if (!E) {
3723 return 0;
3724 }
3725
3726 ExprEvalResult *Result = (ExprEvalResult*)E;
3727 if (Result->IsUnsignedInt)
3728 return Result->EvalData.unsignedVal;
3729 return Result->EvalData.intVal;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003730}
3731
3732double clang_EvalResult_getAsDouble(CXEvalResult E) {
3733 if (!E) {
3734 return 0;
3735 }
3736 return ((ExprEvalResult *)E)->EvalData.floatVal;
3737}
3738
3739const char* clang_EvalResult_getAsStr(CXEvalResult E) {
3740 if (!E) {
3741 return nullptr;
3742 }
3743 return ((ExprEvalResult *)E)->EvalData.stringVal;
3744}
3745
3746static const ExprEvalResult* evaluateExpr(Expr *expr, CXCursor C) {
3747 Expr::EvalResult ER;
3748 ASTContext &ctx = getCursorContext(C);
David Blaikiebbc00882016-04-13 18:36:19 +00003749 if (!expr)
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003750 return nullptr;
David Blaikiebbc00882016-04-13 18:36:19 +00003751
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003752 expr = expr->IgnoreParens();
David Blaikiebbc00882016-04-13 18:36:19 +00003753 if (!expr->EvaluateAsRValue(ER, ctx))
3754 return nullptr;
3755
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003756 QualType rettype;
3757 CallExpr *callExpr;
David Blaikie59272572016-04-13 18:23:33 +00003758 auto result = llvm::make_unique<ExprEvalResult>();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003759 result->EvalType = CXEval_UnExposed;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003760 result->IsUnsignedInt = false;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003761
David Blaikiebbc00882016-04-13 18:36:19 +00003762 if (ER.Val.isInt()) {
3763 result->EvalType = CXEval_Int;
Argyrios Kyrtzidis5dda1122016-12-01 23:41:27 +00003764
3765 auto& val = ER.Val.getInt();
3766 if (val.isUnsigned()) {
3767 result->IsUnsignedInt = true;
3768 result->EvalData.unsignedVal = val.getZExtValue();
3769 } else {
3770 result->EvalData.intVal = val.getExtValue();
3771 }
3772
David Blaikiebbc00882016-04-13 18:36:19 +00003773 return result.release();
3774 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003775
David Blaikiebbc00882016-04-13 18:36:19 +00003776 if (ER.Val.isFloat()) {
3777 llvm::SmallVector<char, 100> Buffer;
3778 ER.Val.getFloat().toString(Buffer);
3779 std::string floatStr(Buffer.data(), Buffer.size());
3780 result->EvalType = CXEval_Float;
3781 bool ignored;
3782 llvm::APFloat apFloat = ER.Val.getFloat();
Stephan Bergmann17c7f702016-12-14 11:57:17 +00003783 apFloat.convert(llvm::APFloat::IEEEdouble(),
David Blaikiebbc00882016-04-13 18:36:19 +00003784 llvm::APFloat::rmNearestTiesToEven, &ignored);
3785 result->EvalData.floatVal = apFloat.convertToDouble();
3786 return result.release();
3787 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003788
David Blaikiebbc00882016-04-13 18:36:19 +00003789 if (expr->getStmtClass() == Stmt::ImplicitCastExprClass) {
3790 const ImplicitCastExpr *I = dyn_cast<ImplicitCastExpr>(expr);
3791 auto *subExpr = I->getSubExprAsWritten();
3792 if (subExpr->getStmtClass() == Stmt::StringLiteralClass ||
3793 subExpr->getStmtClass() == Stmt::ObjCStringLiteralClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003794 const StringLiteral *StrE = nullptr;
3795 const ObjCStringLiteral *ObjCExpr;
David Blaikiebbc00882016-04-13 18:36:19 +00003796 ObjCExpr = dyn_cast<ObjCStringLiteral>(subExpr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003797
3798 if (ObjCExpr) {
3799 StrE = ObjCExpr->getString();
3800 result->EvalType = CXEval_ObjCStrLiteral;
3801 } else {
David Blaikiebbc00882016-04-13 18:36:19 +00003802 StrE = cast<StringLiteral>(I->getSubExprAsWritten());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003803 result->EvalType = CXEval_StrLiteral;
3804 }
3805
3806 std::string strRef(StrE->getString().str());
David Blaikie59272572016-04-13 18:23:33 +00003807 result->EvalData.stringVal = new char[strRef.size() + 1];
David Blaikiebbc00882016-04-13 18:36:19 +00003808 strncpy((char *)result->EvalData.stringVal, strRef.c_str(),
3809 strRef.size());
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003810 result->EvalData.stringVal[strRef.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003811 return result.release();
David Blaikiebbc00882016-04-13 18:36:19 +00003812 }
3813 } else if (expr->getStmtClass() == Stmt::ObjCStringLiteralClass ||
3814 expr->getStmtClass() == Stmt::StringLiteralClass) {
3815 const StringLiteral *StrE = nullptr;
3816 const ObjCStringLiteral *ObjCExpr;
3817 ObjCExpr = dyn_cast<ObjCStringLiteral>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003818
David Blaikiebbc00882016-04-13 18:36:19 +00003819 if (ObjCExpr) {
3820 StrE = ObjCExpr->getString();
3821 result->EvalType = CXEval_ObjCStrLiteral;
3822 } else {
3823 StrE = cast<StringLiteral>(expr);
3824 result->EvalType = CXEval_StrLiteral;
3825 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003826
David Blaikiebbc00882016-04-13 18:36:19 +00003827 std::string strRef(StrE->getString().str());
3828 result->EvalData.stringVal = new char[strRef.size() + 1];
3829 strncpy((char *)result->EvalData.stringVal, strRef.c_str(), strRef.size());
3830 result->EvalData.stringVal[strRef.size()] = '\0';
3831 return result.release();
3832 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003833
David Blaikiebbc00882016-04-13 18:36:19 +00003834 if (expr->getStmtClass() == Stmt::CStyleCastExprClass) {
3835 CStyleCastExpr *CC = static_cast<CStyleCastExpr *>(expr);
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003836
David Blaikiebbc00882016-04-13 18:36:19 +00003837 rettype = CC->getType();
3838 if (rettype.getAsString() == "CFStringRef" &&
3839 CC->getSubExpr()->getStmtClass() == Stmt::CallExprClass) {
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003840
David Blaikiebbc00882016-04-13 18:36:19 +00003841 callExpr = static_cast<CallExpr *>(CC->getSubExpr());
3842 StringLiteral *S = getCFSTR_value(callExpr);
3843 if (S) {
3844 std::string strLiteral(S->getString().str());
3845 result->EvalType = CXEval_CFStr;
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003846
David Blaikiebbc00882016-04-13 18:36:19 +00003847 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3848 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3849 strLiteral.size());
3850 result->EvalData.stringVal[strLiteral.size()] = '\0';
David Blaikie59272572016-04-13 18:23:33 +00003851 return result.release();
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003852 }
3853 }
3854
David Blaikiebbc00882016-04-13 18:36:19 +00003855 } else if (expr->getStmtClass() == Stmt::CallExprClass) {
3856 callExpr = static_cast<CallExpr *>(expr);
3857 rettype = callExpr->getCallReturnType(ctx);
3858
3859 if (rettype->isVectorType() || callExpr->getNumArgs() > 1)
3860 return nullptr;
3861
3862 if (rettype->isIntegralType(ctx) || rettype->isRealFloatingType()) {
3863 if (callExpr->getNumArgs() == 1 &&
3864 !callExpr->getArg(0)->getType()->isIntegralType(ctx))
3865 return nullptr;
3866 } else if (rettype.getAsString() == "CFStringRef") {
3867
3868 StringLiteral *S = getCFSTR_value(callExpr);
3869 if (S) {
3870 std::string strLiteral(S->getString().str());
3871 result->EvalType = CXEval_CFStr;
3872 result->EvalData.stringVal = new char[strLiteral.size() + 1];
3873 strncpy((char *)result->EvalData.stringVal, strLiteral.c_str(),
3874 strLiteral.size());
3875 result->EvalData.stringVal[strLiteral.size()] = '\0';
3876 return result.release();
3877 }
3878 }
3879 } else if (expr->getStmtClass() == Stmt::DeclRefExprClass) {
3880 DeclRefExpr *D = static_cast<DeclRefExpr *>(expr);
3881 ValueDecl *V = D->getDecl();
3882 if (V->getKind() == Decl::Function) {
3883 std::string strName = V->getNameAsString();
3884 result->EvalType = CXEval_Other;
3885 result->EvalData.stringVal = new char[strName.size() + 1];
3886 strncpy(result->EvalData.stringVal, strName.c_str(), strName.size());
3887 result->EvalData.stringVal[strName.size()] = '\0';
3888 return result.release();
3889 }
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003890 }
3891
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003892 return nullptr;
3893}
3894
Alex Lorenzc4cf96e2018-07-09 19:56:45 +00003895CXEvalResult clang_Cursor_Evaluate(CXCursor C) {
Evgeniy Stepanov9b871492018-07-10 19:48:53 +00003896 const Decl *D = getCursorDecl(C);
3897 if (D) {
3898 const Expr *expr = nullptr;
3899 if (auto *Var = dyn_cast<VarDecl>(D)) {
3900 expr = Var->getInit();
3901 } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3902 expr = Field->getInClassInitializer();
3903 }
3904 if (expr)
3905 return const_cast<CXEvalResult>(reinterpret_cast<const void *>(
3906 evaluateExpr(const_cast<Expr *>(expr), C)));
3907 return nullptr;
3908 }
Evgeniy Stepanov6df47ce2018-07-10 19:49:07 +00003909
3910 const CompoundStmt *compoundStmt = dyn_cast_or_null<CompoundStmt>(getCursorStmt(C));
3911 if (compoundStmt) {
3912 Expr *expr = nullptr;
3913 for (auto *bodyIterator : compoundStmt->body()) {
3914 if ((expr = dyn_cast<Expr>(bodyIterator))) {
3915 break;
3916 }
3917 }
3918 if (expr)
3919 return const_cast<CXEvalResult>(
3920 reinterpret_cast<const void *>(evaluateExpr(expr, C)));
3921 }
Alex Lorenzc4cf96e2018-07-09 19:56:45 +00003922 return nullptr;
3923}
3924
Argyrios Kyrtzidis785705b2016-01-16 00:20:02 +00003925unsigned clang_Cursor_hasAttrs(CXCursor C) {
3926 const Decl *D = getCursorDecl(C);
3927 if (!D) {
3928 return 0;
3929 }
3930
3931 if (D->hasAttrs()) {
3932 return 1;
3933 }
3934
3935 return 0;
3936}
Guy Benyei11169dd2012-12-18 14:30:41 +00003937unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
3938 return CXSaveTranslationUnit_None;
3939}
3940
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003941static CXSaveError clang_saveTranslationUnit_Impl(CXTranslationUnit TU,
3942 const char *FileName,
3943 unsigned options) {
3944 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00003945 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3946 setThreadBackgroundPriority();
3947
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003948 bool hadError = cxtu::getASTUnit(TU)->Save(FileName);
3949 return hadError ? CXSaveError_Unknown : CXSaveError_None;
Guy Benyei11169dd2012-12-18 14:30:41 +00003950}
3951
3952int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
3953 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00003954 LOG_FUNC_SECTION {
3955 *Log << TU << ' ' << FileName;
3956 }
3957
Dmitri Gribenko852d6222014-02-11 15:02:48 +00003958 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003959 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003960 return CXSaveError_InvalidTU;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00003961 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003962
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00003963 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00003964 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3965 if (!CXXUnit->hasSema())
3966 return CXSaveError_InvalidTU;
3967
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003968 CXSaveError result;
3969 auto SaveTranslationUnitImpl = [=, &result]() {
3970 result = clang_saveTranslationUnit_Impl(TU, FileName, options);
3971 };
Guy Benyei11169dd2012-12-18 14:30:41 +00003972
Erik Verbruggen3cc39112017-11-14 09:34:39 +00003973 if (!CXXUnit->getDiagnostics().hasUnrecoverableErrorOccurred()) {
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003974 SaveTranslationUnitImpl();
Guy Benyei11169dd2012-12-18 14:30:41 +00003975
3976 if (getenv("LIBCLANG_RESOURCE_USAGE"))
3977 PrintLibclangResourceUsage(TU);
3978
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003979 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003980 }
3981
3982 // We have an AST that has invalid nodes due to compiler errors.
3983 // Use a crash recovery thread for protection.
3984
3985 llvm::CrashRecoveryContext CRC;
3986
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003987 if (!RunSafely(CRC, SaveTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003988 fprintf(stderr, "libclang: crash detected during AST saving: {\n");
3989 fprintf(stderr, " 'filename' : '%s'\n", FileName);
3990 fprintf(stderr, " 'options' : %d,\n", options);
3991 fprintf(stderr, "}\n");
3992
3993 return CXSaveError_Unknown;
3994
3995 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3996 PrintLibclangResourceUsage(TU);
3997 }
3998
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00003999 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00004000}
4001
4002void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
4003 if (CTUnit) {
4004 // If the translation unit has been marked as unsafe to free, just discard
4005 // it.
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004006 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
4007 if (Unit && Unit->isUnsafeToFree())
Guy Benyei11169dd2012-12-18 14:30:41 +00004008 return;
4009
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004010 delete cxtu::getASTUnit(CTUnit);
Dmitri Gribenkob95b3f12013-01-26 22:44:19 +00004011 delete CTUnit->StringPool;
Guy Benyei11169dd2012-12-18 14:30:41 +00004012 delete static_cast<CXDiagnosticSetImpl *>(CTUnit->Diagnostics);
4013 disposeOverridenCXCursorsPool(CTUnit->OverridenCursorsPool);
Dmitri Gribenko9e605112013-11-13 22:16:51 +00004014 delete CTUnit->CommentToXML;
Guy Benyei11169dd2012-12-18 14:30:41 +00004015 delete CTUnit;
4016 }
4017}
4018
Erik Verbruggen346066b2017-05-30 14:25:54 +00004019unsigned clang_suspendTranslationUnit(CXTranslationUnit CTUnit) {
4020 if (CTUnit) {
4021 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
4022
4023 if (Unit && Unit->isUnsafeToFree())
4024 return false;
4025
4026 Unit->ResetForParse();
4027 return true;
4028 }
4029
4030 return false;
4031}
4032
Guy Benyei11169dd2012-12-18 14:30:41 +00004033unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
4034 return CXReparse_None;
4035}
4036
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004037static CXErrorCode
4038clang_reparseTranslationUnit_Impl(CXTranslationUnit TU,
4039 ArrayRef<CXUnsavedFile> unsaved_files,
4040 unsigned options) {
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004041 // Check arguments.
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004042 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004043 LOG_BAD_TU(TU);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004044 return CXError_InvalidArguments;
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004045 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004046
4047 // Reset the associated diagnostics.
4048 delete static_cast<CXDiagnosticSetImpl*>(TU->Diagnostics);
Craig Topper69186e72014-06-08 08:38:04 +00004049 TU->Diagnostics = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004050
Dmitri Gribenko183436e2013-01-26 21:49:50 +00004051 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00004052 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
4053 setThreadBackgroundPriority();
4054
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004055 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004056 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ahmed Charlesb8984322014-03-07 20:03:18 +00004057
4058 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
4059 new std::vector<ASTUnit::RemappedFile>());
4060
Guy Benyei11169dd2012-12-18 14:30:41 +00004061 // Recover resources if we crash before exiting this function.
4062 llvm::CrashRecoveryContextCleanupRegistrar<
4063 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
Alp Toker9d85b182014-07-07 01:23:14 +00004064
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004065 for (auto &UF : unsaved_files) {
Rafael Espindolad87f8d72014-08-27 20:03:29 +00004066 std::unique_ptr<llvm::MemoryBuffer> MB =
Alp Toker9d85b182014-07-07 01:23:14 +00004067 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
Rafael Espindolad87f8d72014-08-27 20:03:29 +00004068 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
Guy Benyei11169dd2012-12-18 14:30:41 +00004069 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004070
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004071 if (!CXXUnit->Reparse(CXXIdx->getPCHContainerOperations(),
4072 *RemappedFiles.get()))
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004073 return CXError_Success;
4074 if (isASTReadError(CXXUnit))
4075 return CXError_ASTReadError;
4076 return CXError_Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00004077}
4078
4079int clang_reparseTranslationUnit(CXTranslationUnit TU,
4080 unsigned num_unsaved_files,
4081 struct CXUnsavedFile *unsaved_files,
4082 unsigned options) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00004083 LOG_FUNC_SECTION {
4084 *Log << TU;
4085 }
4086
Alp Toker9d85b182014-07-07 01:23:14 +00004087 if (num_unsaved_files && !unsaved_files)
4088 return CXError_InvalidArguments;
4089
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004090 CXErrorCode result;
4091 auto ReparseTranslationUnitImpl = [=, &result]() {
4092 result = clang_reparseTranslationUnit_Impl(
4093 TU, llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
4094 };
Guy Benyei11169dd2012-12-18 14:30:41 +00004095
Guy Benyei11169dd2012-12-18 14:30:41 +00004096 llvm::CrashRecoveryContext CRC;
4097
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00004098 if (!RunSafely(CRC, ReparseTranslationUnitImpl)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004099 fprintf(stderr, "libclang: crash detected during reparsing\n");
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004100 cxtu::getASTUnit(TU)->setUnsafeToFree(true);
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00004101 return CXError_Crashed;
Guy Benyei11169dd2012-12-18 14:30:41 +00004102 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
4103 PrintLibclangResourceUsage(TU);
4104
Alp Toker5c532982014-07-07 22:42:03 +00004105 return result;
Guy Benyei11169dd2012-12-18 14:30:41 +00004106}
4107
4108
4109CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004110 if (isNotUsableTU(CTUnit)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004111 LOG_BAD_TU(CTUnit);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004112 return cxstring::createEmpty();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004113 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004114
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004115 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004116 return cxstring::createDup(CXXUnit->getOriginalSourceFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004117}
4118
4119CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004120 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004121 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00004122 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004123 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00004124
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004125 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004126 return MakeCXCursor(CXXUnit->getASTContext().getTranslationUnitDecl(), TU);
4127}
4128
Emilio Cobos Alvarez485ad422017-04-28 15:56:39 +00004129CXTargetInfo clang_getTranslationUnitTargetInfo(CXTranslationUnit CTUnit) {
4130 if (isNotUsableTU(CTUnit)) {
4131 LOG_BAD_TU(CTUnit);
4132 return nullptr;
4133 }
4134
4135 CXTargetInfoImpl* impl = new CXTargetInfoImpl();
4136 impl->TranslationUnit = CTUnit;
4137 return impl;
4138}
4139
4140CXString clang_TargetInfo_getTriple(CXTargetInfo TargetInfo) {
4141 if (!TargetInfo)
4142 return cxstring::createEmpty();
4143
4144 CXTranslationUnit CTUnit = TargetInfo->TranslationUnit;
4145 assert(!isNotUsableTU(CTUnit) &&
4146 "Unexpected unusable translation unit in TargetInfo");
4147
4148 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
4149 std::string Triple =
4150 CXXUnit->getASTContext().getTargetInfo().getTriple().normalize();
4151 return cxstring::createDup(Triple);
4152}
4153
4154int clang_TargetInfo_getPointerWidth(CXTargetInfo TargetInfo) {
4155 if (!TargetInfo)
4156 return -1;
4157
4158 CXTranslationUnit CTUnit = TargetInfo->TranslationUnit;
4159 assert(!isNotUsableTU(CTUnit) &&
4160 "Unexpected unusable translation unit in TargetInfo");
4161
4162 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
4163 return CXXUnit->getASTContext().getTargetInfo().getMaxPointerWidth();
4164}
4165
4166void clang_TargetInfo_dispose(CXTargetInfo TargetInfo) {
4167 if (!TargetInfo)
4168 return;
4169
4170 delete TargetInfo;
4171}
4172
Guy Benyei11169dd2012-12-18 14:30:41 +00004173//===----------------------------------------------------------------------===//
4174// CXFile Operations.
4175//===----------------------------------------------------------------------===//
4176
Guy Benyei11169dd2012-12-18 14:30:41 +00004177CXString clang_getFileName(CXFile SFile) {
4178 if (!SFile)
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00004179 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00004180
4181 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004182 return cxstring::createRef(FEnt->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004183}
4184
4185time_t clang_getFileTime(CXFile SFile) {
4186 if (!SFile)
4187 return 0;
4188
4189 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
4190 return FEnt->getModificationTime();
4191}
4192
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004193CXFile clang_getFile(CXTranslationUnit TU, const char *file_name) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004194 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004195 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00004196 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004197 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004198
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004199 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004200
4201 FileManager &FMgr = CXXUnit->getFileManager();
4202 return const_cast<FileEntry *>(FMgr.getFile(file_name));
4203}
4204
Erik Verbruggen3afa3ce2017-12-06 09:02:52 +00004205const char *clang_getFileContents(CXTranslationUnit TU, CXFile file,
4206 size_t *size) {
4207 if (isNotUsableTU(TU)) {
4208 LOG_BAD_TU(TU);
4209 return nullptr;
4210 }
4211
4212 const SourceManager &SM = cxtu::getASTUnit(TU)->getSourceManager();
4213 FileID fid = SM.translateFile(static_cast<FileEntry *>(file));
4214 bool Invalid = true;
4215 llvm::MemoryBuffer *buf = SM.getBuffer(fid, &Invalid);
4216 if (Invalid) {
4217 if (size)
4218 *size = 0;
4219 return nullptr;
4220 }
4221 if (size)
4222 *size = buf->getBufferSize();
4223 return buf->getBufferStart();
4224}
4225
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004226unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit TU,
4227 CXFile file) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00004228 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00004229 LOG_BAD_TU(TU);
4230 return 0;
4231 }
4232
4233 if (!file)
Guy Benyei11169dd2012-12-18 14:30:41 +00004234 return 0;
4235
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00004236 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00004237 FileEntry *FEnt = static_cast<FileEntry *>(file);
4238 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
4239 .isFileMultipleIncludeGuarded(FEnt);
4240}
4241
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004242int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID) {
4243 if (!file || !outID)
4244 return 1;
4245
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004246 FileEntry *FEnt = static_cast<FileEntry *>(file);
Rafael Espindolaf8f91b82013-08-01 21:42:11 +00004247 const llvm::sys::fs::UniqueID &ID = FEnt->getUniqueID();
4248 outID->data[0] = ID.getDevice();
4249 outID->data[1] = ID.getFile();
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004250 outID->data[2] = FEnt->getModificationTime();
4251 return 0;
Argyrios Kyrtzidisac08b262013-01-26 04:52:52 +00004252}
4253
Argyrios Kyrtzidisac3997e2014-08-16 00:26:19 +00004254int clang_File_isEqual(CXFile file1, CXFile file2) {
4255 if (file1 == file2)
4256 return true;
4257
4258 if (!file1 || !file2)
4259 return false;
4260
4261 FileEntry *FEnt1 = static_cast<FileEntry *>(file1);
4262 FileEntry *FEnt2 = static_cast<FileEntry *>(file2);
4263 return FEnt1->getUniqueID() == FEnt2->getUniqueID();
4264}
4265
Fangrui Songe46ac5f2018-04-07 20:50:35 +00004266CXString clang_File_tryGetRealPathName(CXFile SFile) {
4267 if (!SFile)
4268 return cxstring::createNull();
4269
4270 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
4271 return cxstring::createRef(FEnt->tryGetRealPathName());
4272}
4273
Guy Benyei11169dd2012-12-18 14:30:41 +00004274//===----------------------------------------------------------------------===//
4275// CXCursor Operations.
4276//===----------------------------------------------------------------------===//
4277
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004278static const Decl *getDeclFromExpr(const Stmt *E) {
4279 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004280 return getDeclFromExpr(CE->getSubExpr());
4281
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004282 if (const DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004283 return RefExpr->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004284 if (const MemberExpr *ME = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004285 return ME->getMemberDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004286 if (const ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004287 return RE->getDecl();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004288 if (const ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004289 if (PRE->isExplicitProperty())
4290 return PRE->getExplicitProperty();
4291 // It could be messaging both getter and setter as in:
4292 // ++myobj.myprop;
4293 // in which case prefer to associate the setter since it is less obvious
4294 // from inspecting the source that the setter is going to get called.
4295 if (PRE->isMessagingSetter())
4296 return PRE->getImplicitPropertySetter();
4297 return PRE->getImplicitPropertyGetter();
4298 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004299 if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004300 return getDeclFromExpr(POE->getSyntacticForm());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004301 if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004302 if (Expr *Src = OVE->getSourceExpr())
4303 return getDeclFromExpr(Src);
4304
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004305 if (const CallExpr *CE = dyn_cast<CallExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004306 return getDeclFromExpr(CE->getCallee());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004307 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004308 if (!CE->isElidable())
4309 return CE->getConstructor();
Richard Smith5179eb72016-06-28 19:03:57 +00004310 if (const CXXInheritedCtorInitExpr *CE =
4311 dyn_cast<CXXInheritedCtorInitExpr>(E))
4312 return CE->getConstructor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004313 if (const ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004314 return OME->getMethodDecl();
4315
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004316 if (const ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004317 return PE->getProtocol();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004318 if (const SubstNonTypeTemplateParmPackExpr *NTTP
Guy Benyei11169dd2012-12-18 14:30:41 +00004319 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
4320 return NTTP->getParameterPack();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004321 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004322 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
4323 isa<ParmVarDecl>(SizeOfPack->getPack()))
4324 return SizeOfPack->getPack();
Craig Topper69186e72014-06-08 08:38:04 +00004325
4326 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004327}
4328
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004329static SourceLocation getLocationFromExpr(const Expr *E) {
4330 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004331 return getLocationFromExpr(CE->getSubExpr());
4332
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004333 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004334 return /*FIXME:*/Msg->getLeftLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004335 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004336 return DRE->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004337 if (const MemberExpr *Member = dyn_cast<MemberExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004338 return Member->getMemberLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004339 if (const ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004340 return Ivar->getLocation();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004341 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004342 return SizeOfPack->getPackLoc();
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004343 if (const ObjCPropertyRefExpr *PropRef = dyn_cast<ObjCPropertyRefExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00004344 return PropRef->getLocation();
4345
4346 return E->getLocStart();
4347}
4348
NAKAMURA Takumia01f4c32016-12-19 16:50:43 +00004349extern "C" {
4350
Guy Benyei11169dd2012-12-18 14:30:41 +00004351unsigned clang_visitChildren(CXCursor parent,
4352 CXCursorVisitor visitor,
4353 CXClientData client_data) {
4354 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
4355 /*VisitPreprocessorLast=*/false);
4356 return CursorVis.VisitChildren(parent);
4357}
4358
4359#ifndef __has_feature
4360#define __has_feature(x) 0
4361#endif
4362#if __has_feature(blocks)
4363typedef enum CXChildVisitResult
4364 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
4365
4366static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4367 CXClientData client_data) {
4368 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4369 return block(cursor, parent);
4370}
4371#else
4372// If we are compiled with a compiler that doesn't have native blocks support,
4373// define and call the block manually, so the
4374typedef struct _CXChildVisitResult
4375{
4376 void *isa;
4377 int flags;
4378 int reserved;
4379 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
4380 CXCursor);
4381} *CXCursorVisitorBlock;
4382
4383static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4384 CXClientData client_data) {
4385 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4386 return block->invoke(block, cursor, parent);
4387}
4388#endif
4389
4390
4391unsigned clang_visitChildrenWithBlock(CXCursor parent,
4392 CXCursorVisitorBlock block) {
4393 return clang_visitChildren(parent, visitWithBlock, block);
4394}
4395
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004396static CXString getDeclSpelling(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004397 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004398 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004399
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004400 const NamedDecl *ND = dyn_cast<NamedDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004401 if (!ND) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004402 if (const ObjCPropertyImplDecl *PropImpl =
4403 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004404 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004405 return cxstring::createDup(Property->getIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004406
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004407 if (const ImportDecl *ImportD = dyn_cast<ImportDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004408 if (Module *Mod = ImportD->getImportedModule())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004409 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004410
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004411 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004412 }
4413
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004414 if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004415 return cxstring::createDup(OMD->getSelector().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004416
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004417 if (const ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
Guy Benyei11169dd2012-12-18 14:30:41 +00004418 // No, this isn't the same as the code below. getIdentifier() is non-virtual
4419 // and returns different names. NamedDecl returns the class name and
4420 // ObjCCategoryImplDecl returns the category name.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004421 return cxstring::createRef(CIMP->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004422
4423 if (isa<UsingDirectiveDecl>(D))
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004424 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004425
4426 SmallString<1024> S;
4427 llvm::raw_svector_ostream os(S);
4428 ND->printName(os);
4429
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004430 return cxstring::createDup(os.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004431}
4432
4433CXString clang_getCursorSpelling(CXCursor C) {
4434 if (clang_isTranslationUnit(C.kind))
Dmitri Gribenko2c173b42013-01-11 19:28:44 +00004435 return clang_getTranslationUnitSpelling(getCursorTU(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004436
4437 if (clang_isReference(C.kind)) {
4438 switch (C.kind) {
4439 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004440 const ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004441 return cxstring::createRef(Super->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004442 }
4443 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004444 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004445 return cxstring::createRef(Class->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004446 }
4447 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004448 const ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004449 assert(OID && "getCursorSpelling(): Missing protocol decl");
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004450 return cxstring::createRef(OID->getIdentifier()->getNameStart());
Guy Benyei11169dd2012-12-18 14:30:41 +00004451 }
4452 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004453 const CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004454 return cxstring::createDup(B->getType().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004455 }
4456 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004457 const TypeDecl *Type = getCursorTypeRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004458 assert(Type && "Missing type decl");
4459
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004460 return cxstring::createDup(getCursorContext(C).getTypeDeclType(Type).
Guy Benyei11169dd2012-12-18 14:30:41 +00004461 getAsString());
4462 }
4463 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004464 const TemplateDecl *Template = getCursorTemplateRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004465 assert(Template && "Missing template decl");
4466
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004467 return cxstring::createDup(Template->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004468 }
4469
4470 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004471 const NamedDecl *NS = getCursorNamespaceRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004472 assert(NS && "Missing namespace decl");
4473
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004474 return cxstring::createDup(NS->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004475 }
4476
4477 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004478 const FieldDecl *Field = getCursorMemberRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004479 assert(Field && "Missing member decl");
4480
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004481 return cxstring::createDup(Field->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004482 }
4483
4484 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004485 const LabelStmt *Label = getCursorLabelRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004486 assert(Label && "Missing label");
4487
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004488 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004489 }
4490
4491 case CXCursor_OverloadedDeclRef: {
4492 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004493 if (const Decl *D = Storage.dyn_cast<const Decl *>()) {
4494 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004495 return cxstring::createDup(ND->getNameAsString());
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004496 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004497 }
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004498 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004499 return cxstring::createDup(E->getName().getAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004500 OverloadedTemplateStorage *Ovl
4501 = Storage.get<OverloadedTemplateStorage*>();
4502 if (Ovl->size() == 0)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004503 return cxstring::createEmpty();
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004504 return cxstring::createDup((*Ovl->begin())->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004505 }
4506
4507 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00004508 const VarDecl *Var = getCursorVariableRef(C).first;
Guy Benyei11169dd2012-12-18 14:30:41 +00004509 assert(Var && "Missing variable decl");
4510
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004511 return cxstring::createDup(Var->getNameAsString());
Guy Benyei11169dd2012-12-18 14:30:41 +00004512 }
4513
4514 default:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004515 return cxstring::createRef("<not implemented>");
Guy Benyei11169dd2012-12-18 14:30:41 +00004516 }
4517 }
4518
4519 if (clang_isExpression(C.kind)) {
Argyrios Kyrtzidis3227d862014-03-03 19:40:52 +00004520 const Expr *E = getCursorExpr(C);
4521
4522 if (C.kind == CXCursor_ObjCStringLiteral ||
4523 C.kind == CXCursor_StringLiteral) {
4524 const StringLiteral *SLit;
4525 if (const ObjCStringLiteral *OSL = dyn_cast<ObjCStringLiteral>(E)) {
4526 SLit = OSL->getString();
4527 } else {
4528 SLit = cast<StringLiteral>(E);
4529 }
4530 SmallString<256> Buf;
4531 llvm::raw_svector_ostream OS(Buf);
4532 SLit->outputString(OS);
4533 return cxstring::createDup(OS.str());
4534 }
4535
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004536 const Decl *D = getDeclFromExpr(getCursorExpr(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00004537 if (D)
4538 return getDeclSpelling(D);
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004539 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004540 }
4541
4542 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004543 const Stmt *S = getCursorStmt(C);
4544 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004545 return cxstring::createRef(Label->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004546
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004547 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004548 }
4549
4550 if (C.kind == CXCursor_MacroExpansion)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004551 return cxstring::createRef(getCursorMacroExpansion(C).getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004552 ->getNameStart());
4553
4554 if (C.kind == CXCursor_MacroDefinition)
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00004555 return cxstring::createRef(getCursorMacroDefinition(C)->getName()
Guy Benyei11169dd2012-12-18 14:30:41 +00004556 ->getNameStart());
4557
4558 if (C.kind == CXCursor_InclusionDirective)
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004559 return cxstring::createDup(getCursorInclusionDirective(C)->getFileName());
Guy Benyei11169dd2012-12-18 14:30:41 +00004560
4561 if (clang_isDeclaration(C.kind))
4562 return getDeclSpelling(getCursorDecl(C));
4563
4564 if (C.kind == CXCursor_AnnotateAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004565 const AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004566 return cxstring::createDup(AA->getAnnotation());
Guy Benyei11169dd2012-12-18 14:30:41 +00004567 }
4568
4569 if (C.kind == CXCursor_AsmLabelAttr) {
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00004570 const AsmLabelAttr *AA = cast<AsmLabelAttr>(cxcursor::getCursorAttr(C));
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004571 return cxstring::createDup(AA->getLabel());
Guy Benyei11169dd2012-12-18 14:30:41 +00004572 }
4573
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00004574 if (C.kind == CXCursor_PackedAttr) {
4575 return cxstring::createRef("packed");
4576 }
4577
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00004578 if (C.kind == CXCursor_VisibilityAttr) {
4579 const VisibilityAttr *AA = cast<VisibilityAttr>(cxcursor::getCursorAttr(C));
4580 switch (AA->getVisibility()) {
4581 case VisibilityAttr::VisibilityType::Default:
4582 return cxstring::createRef("default");
4583 case VisibilityAttr::VisibilityType::Hidden:
4584 return cxstring::createRef("hidden");
4585 case VisibilityAttr::VisibilityType::Protected:
4586 return cxstring::createRef("protected");
4587 }
4588 llvm_unreachable("unknown visibility type");
4589 }
4590
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004591 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004592}
4593
4594CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor C,
4595 unsigned pieceIndex,
4596 unsigned options) {
4597 if (clang_Cursor_isNull(C))
4598 return clang_getNullRange();
4599
4600 ASTContext &Ctx = getCursorContext(C);
4601
4602 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004603 const Stmt *S = getCursorStmt(C);
4604 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004605 if (pieceIndex > 0)
4606 return clang_getNullRange();
4607 return cxloc::translateSourceRange(Ctx, Label->getIdentLoc());
4608 }
4609
4610 return clang_getNullRange();
4611 }
4612
4613 if (C.kind == CXCursor_ObjCMessageExpr) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00004614 if (const ObjCMessageExpr *
Guy Benyei11169dd2012-12-18 14:30:41 +00004615 ME = dyn_cast_or_null<ObjCMessageExpr>(getCursorExpr(C))) {
4616 if (pieceIndex >= ME->getNumSelectorLocs())
4617 return clang_getNullRange();
4618 return cxloc::translateSourceRange(Ctx, ME->getSelectorLoc(pieceIndex));
4619 }
4620 }
4621
4622 if (C.kind == CXCursor_ObjCInstanceMethodDecl ||
4623 C.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004624 if (const ObjCMethodDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004625 MD = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(C))) {
4626 if (pieceIndex >= MD->getNumSelectorLocs())
4627 return clang_getNullRange();
4628 return cxloc::translateSourceRange(Ctx, MD->getSelectorLoc(pieceIndex));
4629 }
4630 }
4631
4632 if (C.kind == CXCursor_ObjCCategoryDecl ||
4633 C.kind == CXCursor_ObjCCategoryImplDecl) {
4634 if (pieceIndex > 0)
4635 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004636 if (const ObjCCategoryDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004637 CD = dyn_cast_or_null<ObjCCategoryDecl>(getCursorDecl(C)))
4638 return cxloc::translateSourceRange(Ctx, CD->getCategoryNameLoc());
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004639 if (const ObjCCategoryImplDecl *
Guy Benyei11169dd2012-12-18 14:30:41 +00004640 CID = dyn_cast_or_null<ObjCCategoryImplDecl>(getCursorDecl(C)))
4641 return cxloc::translateSourceRange(Ctx, CID->getCategoryNameLoc());
4642 }
4643
4644 if (C.kind == CXCursor_ModuleImportDecl) {
4645 if (pieceIndex > 0)
4646 return clang_getNullRange();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004647 if (const ImportDecl *ImportD =
4648 dyn_cast_or_null<ImportDecl>(getCursorDecl(C))) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004649 ArrayRef<SourceLocation> Locs = ImportD->getIdentifierLocs();
4650 if (!Locs.empty())
4651 return cxloc::translateSourceRange(Ctx,
4652 SourceRange(Locs.front(), Locs.back()));
4653 }
4654 return clang_getNullRange();
4655 }
4656
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004657 if (C.kind == CXCursor_CXXMethod || C.kind == CXCursor_Destructor ||
Kevin Funk4be5d672016-12-20 09:56:56 +00004658 C.kind == CXCursor_ConversionFunction ||
4659 C.kind == CXCursor_FunctionDecl) {
Argyrios Kyrtzidisa2a1e532014-08-26 20:23:26 +00004660 if (pieceIndex > 0)
4661 return clang_getNullRange();
4662 if (const FunctionDecl *FD =
4663 dyn_cast_or_null<FunctionDecl>(getCursorDecl(C))) {
4664 DeclarationNameInfo FunctionName = FD->getNameInfo();
4665 return cxloc::translateSourceRange(Ctx, FunctionName.getSourceRange());
4666 }
4667 return clang_getNullRange();
4668 }
4669
Guy Benyei11169dd2012-12-18 14:30:41 +00004670 // FIXME: A CXCursor_InclusionDirective should give the location of the
4671 // filename, but we don't keep track of this.
4672
4673 // FIXME: A CXCursor_AnnotateAttr should give the location of the annotation
4674 // but we don't keep track of this.
4675
4676 // FIXME: A CXCursor_AsmLabelAttr should give the location of the label
4677 // but we don't keep track of this.
4678
4679 // Default handling, give the location of the cursor.
4680
4681 if (pieceIndex > 0)
4682 return clang_getNullRange();
4683
4684 CXSourceLocation CXLoc = clang_getCursorLocation(C);
4685 SourceLocation Loc = cxloc::translateSourceLocation(CXLoc);
4686 return cxloc::translateSourceRange(Ctx, Loc);
4687}
4688
Eli Bendersky44a206f2014-07-31 18:04:56 +00004689CXString clang_Cursor_getMangling(CXCursor C) {
4690 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4691 return cxstring::createEmpty();
4692
Eli Bendersky44a206f2014-07-31 18:04:56 +00004693 // Mangling only works for functions and variables.
Eli Bendersky79759592014-08-01 15:01:10 +00004694 const Decl *D = getCursorDecl(C);
Eli Bendersky44a206f2014-07-31 18:04:56 +00004695 if (!D || !(isa<FunctionDecl>(D) || isa<VarDecl>(D)))
4696 return cxstring::createEmpty();
4697
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004698 ASTContext &Ctx = D->getASTContext();
4699 index::CodegenNameGenerator CGNameGen(Ctx);
4700 return cxstring::createDup(CGNameGen.getName(D));
Eli Bendersky44a206f2014-07-31 18:04:56 +00004701}
4702
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004703CXStringSet *clang_Cursor_getCXXManglings(CXCursor C) {
4704 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4705 return nullptr;
4706
4707 const Decl *D = getCursorDecl(C);
4708 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
4709 return nullptr;
4710
Argyrios Kyrtzidisca741ce2016-02-14 22:30:14 +00004711 ASTContext &Ctx = D->getASTContext();
4712 index::CodegenNameGenerator CGNameGen(Ctx);
4713 std::vector<std::string> Manglings = CGNameGen.getAllManglings(D);
Saleem Abdulrasool60034432015-11-12 03:57:22 +00004714 return cxstring::createSet(Manglings);
4715}
4716
Dave Lee1a532c92017-09-22 16:58:57 +00004717CXStringSet *clang_Cursor_getObjCManglings(CXCursor C) {
4718 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4719 return nullptr;
4720
4721 const Decl *D = getCursorDecl(C);
4722 if (!(isa<ObjCInterfaceDecl>(D) || isa<ObjCImplementationDecl>(D)))
4723 return nullptr;
4724
4725 ASTContext &Ctx = D->getASTContext();
4726 index::CodegenNameGenerator CGNameGen(Ctx);
4727 std::vector<std::string> Manglings = CGNameGen.getAllManglings(D);
4728 return cxstring::createSet(Manglings);
4729}
4730
Jonathan Coe45ef5032018-01-16 10:19:56 +00004731CXPrintingPolicy clang_getCursorPrintingPolicy(CXCursor C) {
4732 if (clang_Cursor_isNull(C))
4733 return 0;
4734 return new PrintingPolicy(getCursorContext(C).getPrintingPolicy());
4735}
4736
4737void clang_PrintingPolicy_dispose(CXPrintingPolicy Policy) {
4738 if (Policy)
4739 delete static_cast<PrintingPolicy *>(Policy);
4740}
4741
4742unsigned
4743clang_PrintingPolicy_getProperty(CXPrintingPolicy Policy,
4744 enum CXPrintingPolicyProperty Property) {
4745 if (!Policy)
4746 return 0;
4747
4748 PrintingPolicy *P = static_cast<PrintingPolicy *>(Policy);
4749 switch (Property) {
4750 case CXPrintingPolicy_Indentation:
4751 return P->Indentation;
4752 case CXPrintingPolicy_SuppressSpecifiers:
4753 return P->SuppressSpecifiers;
4754 case CXPrintingPolicy_SuppressTagKeyword:
4755 return P->SuppressTagKeyword;
4756 case CXPrintingPolicy_IncludeTagDefinition:
4757 return P->IncludeTagDefinition;
4758 case CXPrintingPolicy_SuppressScope:
4759 return P->SuppressScope;
4760 case CXPrintingPolicy_SuppressUnwrittenScope:
4761 return P->SuppressUnwrittenScope;
4762 case CXPrintingPolicy_SuppressInitializers:
4763 return P->SuppressInitializers;
4764 case CXPrintingPolicy_ConstantArraySizeAsWritten:
4765 return P->ConstantArraySizeAsWritten;
4766 case CXPrintingPolicy_AnonymousTagLocations:
4767 return P->AnonymousTagLocations;
4768 case CXPrintingPolicy_SuppressStrongLifetime:
4769 return P->SuppressStrongLifetime;
4770 case CXPrintingPolicy_SuppressLifetimeQualifiers:
4771 return P->SuppressLifetimeQualifiers;
4772 case CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors:
4773 return P->SuppressTemplateArgsInCXXConstructors;
4774 case CXPrintingPolicy_Bool:
4775 return P->Bool;
4776 case CXPrintingPolicy_Restrict:
4777 return P->Restrict;
4778 case CXPrintingPolicy_Alignof:
4779 return P->Alignof;
4780 case CXPrintingPolicy_UnderscoreAlignof:
4781 return P->UnderscoreAlignof;
4782 case CXPrintingPolicy_UseVoidForZeroParams:
4783 return P->UseVoidForZeroParams;
4784 case CXPrintingPolicy_TerseOutput:
4785 return P->TerseOutput;
4786 case CXPrintingPolicy_PolishForDeclaration:
4787 return P->PolishForDeclaration;
4788 case CXPrintingPolicy_Half:
4789 return P->Half;
4790 case CXPrintingPolicy_MSWChar:
4791 return P->MSWChar;
4792 case CXPrintingPolicy_IncludeNewlines:
4793 return P->IncludeNewlines;
4794 case CXPrintingPolicy_MSVCFormatting:
4795 return P->MSVCFormatting;
4796 case CXPrintingPolicy_ConstantsAsWritten:
4797 return P->ConstantsAsWritten;
4798 case CXPrintingPolicy_SuppressImplicitBase:
4799 return P->SuppressImplicitBase;
4800 case CXPrintingPolicy_FullyQualifiedName:
4801 return P->FullyQualifiedName;
4802 }
4803
4804 assert(false && "Invalid CXPrintingPolicyProperty");
4805 return 0;
4806}
4807
4808void clang_PrintingPolicy_setProperty(CXPrintingPolicy Policy,
4809 enum CXPrintingPolicyProperty Property,
4810 unsigned Value) {
4811 if (!Policy)
4812 return;
4813
4814 PrintingPolicy *P = static_cast<PrintingPolicy *>(Policy);
4815 switch (Property) {
4816 case CXPrintingPolicy_Indentation:
4817 P->Indentation = Value;
4818 return;
4819 case CXPrintingPolicy_SuppressSpecifiers:
4820 P->SuppressSpecifiers = Value;
4821 return;
4822 case CXPrintingPolicy_SuppressTagKeyword:
4823 P->SuppressTagKeyword = Value;
4824 return;
4825 case CXPrintingPolicy_IncludeTagDefinition:
4826 P->IncludeTagDefinition = Value;
4827 return;
4828 case CXPrintingPolicy_SuppressScope:
4829 P->SuppressScope = Value;
4830 return;
4831 case CXPrintingPolicy_SuppressUnwrittenScope:
4832 P->SuppressUnwrittenScope = Value;
4833 return;
4834 case CXPrintingPolicy_SuppressInitializers:
4835 P->SuppressInitializers = Value;
4836 return;
4837 case CXPrintingPolicy_ConstantArraySizeAsWritten:
4838 P->ConstantArraySizeAsWritten = Value;
4839 return;
4840 case CXPrintingPolicy_AnonymousTagLocations:
4841 P->AnonymousTagLocations = Value;
4842 return;
4843 case CXPrintingPolicy_SuppressStrongLifetime:
4844 P->SuppressStrongLifetime = Value;
4845 return;
4846 case CXPrintingPolicy_SuppressLifetimeQualifiers:
4847 P->SuppressLifetimeQualifiers = Value;
4848 return;
4849 case CXPrintingPolicy_SuppressTemplateArgsInCXXConstructors:
4850 P->SuppressTemplateArgsInCXXConstructors = Value;
4851 return;
4852 case CXPrintingPolicy_Bool:
4853 P->Bool = Value;
4854 return;
4855 case CXPrintingPolicy_Restrict:
4856 P->Restrict = Value;
4857 return;
4858 case CXPrintingPolicy_Alignof:
4859 P->Alignof = Value;
4860 return;
4861 case CXPrintingPolicy_UnderscoreAlignof:
4862 P->UnderscoreAlignof = Value;
4863 return;
4864 case CXPrintingPolicy_UseVoidForZeroParams:
4865 P->UseVoidForZeroParams = Value;
4866 return;
4867 case CXPrintingPolicy_TerseOutput:
4868 P->TerseOutput = Value;
4869 return;
4870 case CXPrintingPolicy_PolishForDeclaration:
4871 P->PolishForDeclaration = Value;
4872 return;
4873 case CXPrintingPolicy_Half:
4874 P->Half = Value;
4875 return;
4876 case CXPrintingPolicy_MSWChar:
4877 P->MSWChar = Value;
4878 return;
4879 case CXPrintingPolicy_IncludeNewlines:
4880 P->IncludeNewlines = Value;
4881 return;
4882 case CXPrintingPolicy_MSVCFormatting:
4883 P->MSVCFormatting = Value;
4884 return;
4885 case CXPrintingPolicy_ConstantsAsWritten:
4886 P->ConstantsAsWritten = Value;
4887 return;
4888 case CXPrintingPolicy_SuppressImplicitBase:
4889 P->SuppressImplicitBase = Value;
4890 return;
4891 case CXPrintingPolicy_FullyQualifiedName:
4892 P->FullyQualifiedName = Value;
4893 return;
4894 }
4895
4896 assert(false && "Invalid CXPrintingPolicyProperty");
4897}
4898
4899CXString clang_getCursorPrettyPrinted(CXCursor C, CXPrintingPolicy cxPolicy) {
4900 if (clang_Cursor_isNull(C))
4901 return cxstring::createEmpty();
4902
4903 if (clang_isDeclaration(C.kind)) {
4904 const Decl *D = getCursorDecl(C);
4905 if (!D)
4906 return cxstring::createEmpty();
4907
4908 SmallString<128> Str;
4909 llvm::raw_svector_ostream OS(Str);
4910 PrintingPolicy *UserPolicy = static_cast<PrintingPolicy *>(cxPolicy);
4911 D->print(OS, UserPolicy ? *UserPolicy
4912 : getCursorContext(C).getPrintingPolicy());
4913
4914 return cxstring::createDup(OS.str());
4915 }
4916
4917 return cxstring::createEmpty();
4918}
4919
Guy Benyei11169dd2012-12-18 14:30:41 +00004920CXString clang_getCursorDisplayName(CXCursor C) {
4921 if (!clang_isDeclaration(C.kind))
4922 return clang_getCursorSpelling(C);
4923
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004924 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00004925 if (!D)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00004926 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00004927
4928 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004929 if (const FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00004930 D = FunTmpl->getTemplatedDecl();
4931
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004932 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004933 SmallString<64> Str;
4934 llvm::raw_svector_ostream OS(Str);
4935 OS << *Function;
4936 if (Function->getPrimaryTemplate())
4937 OS << "<>";
4938 OS << "(";
4939 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
4940 if (I)
4941 OS << ", ";
4942 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
4943 }
4944
4945 if (Function->isVariadic()) {
4946 if (Function->getNumParams())
4947 OS << ", ";
4948 OS << "...";
4949 }
4950 OS << ")";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004951 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004952 }
4953
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004954 if (const ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004955 SmallString<64> Str;
4956 llvm::raw_svector_ostream OS(Str);
4957 OS << *ClassTemplate;
4958 OS << "<";
4959 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
4960 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
4961 if (I)
4962 OS << ", ";
4963
4964 NamedDecl *Param = Params->getParam(I);
4965 if (Param->getIdentifier()) {
4966 OS << Param->getIdentifier()->getName();
4967 continue;
4968 }
4969
4970 // There is no parameter name, which makes this tricky. Try to come up
4971 // with something useful that isn't too long.
4972 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
4973 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
4974 else if (NonTypeTemplateParmDecl *NTTP
4975 = dyn_cast<NonTypeTemplateParmDecl>(Param))
4976 OS << NTTP->getType().getAsString(Policy);
4977 else
4978 OS << "template<...> class";
4979 }
4980
4981 OS << ">";
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004982 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004983 }
4984
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00004985 if (const ClassTemplateSpecializationDecl *ClassSpec
Guy Benyei11169dd2012-12-18 14:30:41 +00004986 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
4987 // If the type was explicitly written, use that.
4988 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004989 return cxstring::createDup(TSInfo->getType().getAsString(Policy));
Serge Pavlov03e672c2017-11-28 16:14:14 +00004990
Benjamin Kramer9170e912013-02-22 15:46:01 +00004991 SmallString<128> Str;
Guy Benyei11169dd2012-12-18 14:30:41 +00004992 llvm::raw_svector_ostream OS(Str);
4993 OS << *ClassSpec;
Serge Pavlov03e672c2017-11-28 16:14:14 +00004994 printTemplateArgumentList(OS, ClassSpec->getTemplateArgs().asArray(),
4995 Policy);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00004996 return cxstring::createDup(OS.str());
Guy Benyei11169dd2012-12-18 14:30:41 +00004997 }
4998
4999 return clang_getCursorSpelling(C);
5000}
5001
5002CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
5003 switch (Kind) {
5004 case CXCursor_FunctionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005005 return cxstring::createRef("FunctionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005006 case CXCursor_TypedefDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005007 return cxstring::createRef("TypedefDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005008 case CXCursor_EnumDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005009 return cxstring::createRef("EnumDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005010 case CXCursor_EnumConstantDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005011 return cxstring::createRef("EnumConstantDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005012 case CXCursor_StructDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005013 return cxstring::createRef("StructDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005014 case CXCursor_UnionDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005015 return cxstring::createRef("UnionDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005016 case CXCursor_ClassDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005017 return cxstring::createRef("ClassDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005018 case CXCursor_FieldDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005019 return cxstring::createRef("FieldDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005020 case CXCursor_VarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005021 return cxstring::createRef("VarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005022 case CXCursor_ParmDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005023 return cxstring::createRef("ParmDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005024 case CXCursor_ObjCInterfaceDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005025 return cxstring::createRef("ObjCInterfaceDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005026 case CXCursor_ObjCCategoryDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005027 return cxstring::createRef("ObjCCategoryDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005028 case CXCursor_ObjCProtocolDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005029 return cxstring::createRef("ObjCProtocolDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005030 case CXCursor_ObjCPropertyDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005031 return cxstring::createRef("ObjCPropertyDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005032 case CXCursor_ObjCIvarDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005033 return cxstring::createRef("ObjCIvarDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005034 case CXCursor_ObjCInstanceMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005035 return cxstring::createRef("ObjCInstanceMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005036 case CXCursor_ObjCClassMethodDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005037 return cxstring::createRef("ObjCClassMethodDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005038 case CXCursor_ObjCImplementationDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005039 return cxstring::createRef("ObjCImplementationDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005040 case CXCursor_ObjCCategoryImplDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005041 return cxstring::createRef("ObjCCategoryImplDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005042 case CXCursor_CXXMethod:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005043 return cxstring::createRef("CXXMethod");
Guy Benyei11169dd2012-12-18 14:30:41 +00005044 case CXCursor_UnexposedDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005045 return cxstring::createRef("UnexposedDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005046 case CXCursor_ObjCSuperClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005047 return cxstring::createRef("ObjCSuperClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005048 case CXCursor_ObjCProtocolRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005049 return cxstring::createRef("ObjCProtocolRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005050 case CXCursor_ObjCClassRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005051 return cxstring::createRef("ObjCClassRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005052 case CXCursor_TypeRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005053 return cxstring::createRef("TypeRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005054 case CXCursor_TemplateRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005055 return cxstring::createRef("TemplateRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005056 case CXCursor_NamespaceRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005057 return cxstring::createRef("NamespaceRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005058 case CXCursor_MemberRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005059 return cxstring::createRef("MemberRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005060 case CXCursor_LabelRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005061 return cxstring::createRef("LabelRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005062 case CXCursor_OverloadedDeclRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005063 return cxstring::createRef("OverloadedDeclRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005064 case CXCursor_VariableRef:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005065 return cxstring::createRef("VariableRef");
Guy Benyei11169dd2012-12-18 14:30:41 +00005066 case CXCursor_IntegerLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005067 return cxstring::createRef("IntegerLiteral");
Leonard Chandb01c3a2018-06-20 17:19:40 +00005068 case CXCursor_FixedPointLiteral:
5069 return cxstring::createRef("FixedPointLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005070 case CXCursor_FloatingLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005071 return cxstring::createRef("FloatingLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005072 case CXCursor_ImaginaryLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005073 return cxstring::createRef("ImaginaryLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005074 case CXCursor_StringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005075 return cxstring::createRef("StringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005076 case CXCursor_CharacterLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005077 return cxstring::createRef("CharacterLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005078 case CXCursor_ParenExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005079 return cxstring::createRef("ParenExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005080 case CXCursor_UnaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005081 return cxstring::createRef("UnaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00005082 case CXCursor_ArraySubscriptExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005083 return cxstring::createRef("ArraySubscriptExpr");
Alexey Bataev1a3320e2015-08-25 14:24:04 +00005084 case CXCursor_OMPArraySectionExpr:
5085 return cxstring::createRef("OMPArraySectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005086 case CXCursor_BinaryOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005087 return cxstring::createRef("BinaryOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00005088 case CXCursor_CompoundAssignOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005089 return cxstring::createRef("CompoundAssignOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00005090 case CXCursor_ConditionalOperator:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005091 return cxstring::createRef("ConditionalOperator");
Guy Benyei11169dd2012-12-18 14:30:41 +00005092 case CXCursor_CStyleCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005093 return cxstring::createRef("CStyleCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005094 case CXCursor_CompoundLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005095 return cxstring::createRef("CompoundLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005096 case CXCursor_InitListExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005097 return cxstring::createRef("InitListExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005098 case CXCursor_AddrLabelExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005099 return cxstring::createRef("AddrLabelExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005100 case CXCursor_StmtExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005101 return cxstring::createRef("StmtExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005102 case CXCursor_GenericSelectionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005103 return cxstring::createRef("GenericSelectionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005104 case CXCursor_GNUNullExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005105 return cxstring::createRef("GNUNullExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005106 case CXCursor_CXXStaticCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005107 return cxstring::createRef("CXXStaticCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005108 case CXCursor_CXXDynamicCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005109 return cxstring::createRef("CXXDynamicCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005110 case CXCursor_CXXReinterpretCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005111 return cxstring::createRef("CXXReinterpretCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005112 case CXCursor_CXXConstCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005113 return cxstring::createRef("CXXConstCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005114 case CXCursor_CXXFunctionalCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005115 return cxstring::createRef("CXXFunctionalCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005116 case CXCursor_CXXTypeidExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005117 return cxstring::createRef("CXXTypeidExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005118 case CXCursor_CXXBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005119 return cxstring::createRef("CXXBoolLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005120 case CXCursor_CXXNullPtrLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005121 return cxstring::createRef("CXXNullPtrLiteralExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005122 case CXCursor_CXXThisExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005123 return cxstring::createRef("CXXThisExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005124 case CXCursor_CXXThrowExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005125 return cxstring::createRef("CXXThrowExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005126 case CXCursor_CXXNewExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005127 return cxstring::createRef("CXXNewExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005128 case CXCursor_CXXDeleteExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005129 return cxstring::createRef("CXXDeleteExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005130 case CXCursor_UnaryExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005131 return cxstring::createRef("UnaryExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005132 case CXCursor_ObjCStringLiteral:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005133 return cxstring::createRef("ObjCStringLiteral");
Guy Benyei11169dd2012-12-18 14:30:41 +00005134 case CXCursor_ObjCBoolLiteralExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005135 return cxstring::createRef("ObjCBoolLiteralExpr");
Erik Pilkington29099de2016-07-16 00:35:23 +00005136 case CXCursor_ObjCAvailabilityCheckExpr:
5137 return cxstring::createRef("ObjCAvailabilityCheckExpr");
Argyrios Kyrtzidisc2233be2013-04-23 17:57:17 +00005138 case CXCursor_ObjCSelfExpr:
5139 return cxstring::createRef("ObjCSelfExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005140 case CXCursor_ObjCEncodeExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005141 return cxstring::createRef("ObjCEncodeExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005142 case CXCursor_ObjCSelectorExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005143 return cxstring::createRef("ObjCSelectorExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005144 case CXCursor_ObjCProtocolExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005145 return cxstring::createRef("ObjCProtocolExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005146 case CXCursor_ObjCBridgedCastExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005147 return cxstring::createRef("ObjCBridgedCastExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005148 case CXCursor_BlockExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005149 return cxstring::createRef("BlockExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005150 case CXCursor_PackExpansionExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005151 return cxstring::createRef("PackExpansionExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005152 case CXCursor_SizeOfPackExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005153 return cxstring::createRef("SizeOfPackExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005154 case CXCursor_LambdaExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005155 return cxstring::createRef("LambdaExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005156 case CXCursor_UnexposedExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005157 return cxstring::createRef("UnexposedExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005158 case CXCursor_DeclRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005159 return cxstring::createRef("DeclRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005160 case CXCursor_MemberRefExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005161 return cxstring::createRef("MemberRefExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005162 case CXCursor_CallExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005163 return cxstring::createRef("CallExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005164 case CXCursor_ObjCMessageExpr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005165 return cxstring::createRef("ObjCMessageExpr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005166 case CXCursor_UnexposedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005167 return cxstring::createRef("UnexposedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005168 case CXCursor_DeclStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005169 return cxstring::createRef("DeclStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005170 case CXCursor_LabelStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005171 return cxstring::createRef("LabelStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005172 case CXCursor_CompoundStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005173 return cxstring::createRef("CompoundStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005174 case CXCursor_CaseStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005175 return cxstring::createRef("CaseStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005176 case CXCursor_DefaultStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005177 return cxstring::createRef("DefaultStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005178 case CXCursor_IfStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005179 return cxstring::createRef("IfStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005180 case CXCursor_SwitchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005181 return cxstring::createRef("SwitchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005182 case CXCursor_WhileStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005183 return cxstring::createRef("WhileStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005184 case CXCursor_DoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005185 return cxstring::createRef("DoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005186 case CXCursor_ForStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005187 return cxstring::createRef("ForStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005188 case CXCursor_GotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005189 return cxstring::createRef("GotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005190 case CXCursor_IndirectGotoStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005191 return cxstring::createRef("IndirectGotoStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005192 case CXCursor_ContinueStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005193 return cxstring::createRef("ContinueStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005194 case CXCursor_BreakStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005195 return cxstring::createRef("BreakStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005196 case CXCursor_ReturnStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005197 return cxstring::createRef("ReturnStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005198 case CXCursor_GCCAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005199 return cxstring::createRef("GCCAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005200 case CXCursor_MSAsmStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005201 return cxstring::createRef("MSAsmStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005202 case CXCursor_ObjCAtTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005203 return cxstring::createRef("ObjCAtTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005204 case CXCursor_ObjCAtCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005205 return cxstring::createRef("ObjCAtCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005206 case CXCursor_ObjCAtFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005207 return cxstring::createRef("ObjCAtFinallyStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005208 case CXCursor_ObjCAtThrowStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005209 return cxstring::createRef("ObjCAtThrowStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005210 case CXCursor_ObjCAtSynchronizedStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005211 return cxstring::createRef("ObjCAtSynchronizedStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005212 case CXCursor_ObjCAutoreleasePoolStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005213 return cxstring::createRef("ObjCAutoreleasePoolStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005214 case CXCursor_ObjCForCollectionStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005215 return cxstring::createRef("ObjCForCollectionStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005216 case CXCursor_CXXCatchStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005217 return cxstring::createRef("CXXCatchStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005218 case CXCursor_CXXTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005219 return cxstring::createRef("CXXTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005220 case CXCursor_CXXForRangeStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005221 return cxstring::createRef("CXXForRangeStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005222 case CXCursor_SEHTryStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005223 return cxstring::createRef("SEHTryStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005224 case CXCursor_SEHExceptStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005225 return cxstring::createRef("SEHExceptStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005226 case CXCursor_SEHFinallyStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005227 return cxstring::createRef("SEHFinallyStmt");
Nico Weber9b982072014-07-07 00:12:30 +00005228 case CXCursor_SEHLeaveStmt:
5229 return cxstring::createRef("SEHLeaveStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005230 case CXCursor_NullStmt:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005231 return cxstring::createRef("NullStmt");
Guy Benyei11169dd2012-12-18 14:30:41 +00005232 case CXCursor_InvalidFile:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005233 return cxstring::createRef("InvalidFile");
Guy Benyei11169dd2012-12-18 14:30:41 +00005234 case CXCursor_InvalidCode:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005235 return cxstring::createRef("InvalidCode");
Guy Benyei11169dd2012-12-18 14:30:41 +00005236 case CXCursor_NoDeclFound:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005237 return cxstring::createRef("NoDeclFound");
Guy Benyei11169dd2012-12-18 14:30:41 +00005238 case CXCursor_NotImplemented:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005239 return cxstring::createRef("NotImplemented");
Guy Benyei11169dd2012-12-18 14:30:41 +00005240 case CXCursor_TranslationUnit:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005241 return cxstring::createRef("TranslationUnit");
Guy Benyei11169dd2012-12-18 14:30:41 +00005242 case CXCursor_UnexposedAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005243 return cxstring::createRef("UnexposedAttr");
Guy Benyei11169dd2012-12-18 14:30:41 +00005244 case CXCursor_IBActionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005245 return cxstring::createRef("attribute(ibaction)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005246 case CXCursor_IBOutletAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005247 return cxstring::createRef("attribute(iboutlet)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005248 case CXCursor_IBOutletCollectionAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005249 return cxstring::createRef("attribute(iboutletcollection)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005250 case CXCursor_CXXFinalAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005251 return cxstring::createRef("attribute(final)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005252 case CXCursor_CXXOverrideAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005253 return cxstring::createRef("attribute(override)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005254 case CXCursor_AnnotateAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005255 return cxstring::createRef("attribute(annotate)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005256 case CXCursor_AsmLabelAttr:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005257 return cxstring::createRef("asm label");
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00005258 case CXCursor_PackedAttr:
5259 return cxstring::createRef("attribute(packed)");
Joey Gouly81228382014-05-01 15:41:58 +00005260 case CXCursor_PureAttr:
5261 return cxstring::createRef("attribute(pure)");
5262 case CXCursor_ConstAttr:
5263 return cxstring::createRef("attribute(const)");
5264 case CXCursor_NoDuplicateAttr:
5265 return cxstring::createRef("attribute(noduplicate)");
Eli Bendersky2581e662014-05-28 19:29:58 +00005266 case CXCursor_CUDAConstantAttr:
5267 return cxstring::createRef("attribute(constant)");
5268 case CXCursor_CUDADeviceAttr:
5269 return cxstring::createRef("attribute(device)");
5270 case CXCursor_CUDAGlobalAttr:
5271 return cxstring::createRef("attribute(global)");
5272 case CXCursor_CUDAHostAttr:
5273 return cxstring::createRef("attribute(host)");
Eli Bendersky9b071472014-08-08 14:59:00 +00005274 case CXCursor_CUDASharedAttr:
5275 return cxstring::createRef("attribute(shared)");
Saleem Abdulrasool79c69712015-09-05 18:53:43 +00005276 case CXCursor_VisibilityAttr:
5277 return cxstring::createRef("attribute(visibility)");
Saleem Abdulrasool8aa0b802015-12-10 18:45:18 +00005278 case CXCursor_DLLExport:
5279 return cxstring::createRef("attribute(dllexport)");
5280 case CXCursor_DLLImport:
5281 return cxstring::createRef("attribute(dllimport)");
Michael Wud092d0b2018-08-03 05:03:22 +00005282 case CXCursor_NSReturnsRetained:
5283 return cxstring::createRef("attribute(ns_returns_retained)");
5284 case CXCursor_NSReturnsNotRetained:
5285 return cxstring::createRef("attribute(ns_returns_not_retained)");
5286 case CXCursor_NSReturnsAutoreleased:
5287 return cxstring::createRef("attribute(ns_returns_autoreleased)");
5288 case CXCursor_NSConsumesSelf:
5289 return cxstring::createRef("attribute(ns_consumes_self)");
5290 case CXCursor_NSConsumed:
5291 return cxstring::createRef("attribute(ns_consumed)");
5292 case CXCursor_ObjCException:
5293 return cxstring::createRef("attribute(objc_exception)");
5294 case CXCursor_ObjCNSObject:
5295 return cxstring::createRef("attribute(NSObject)");
5296 case CXCursor_ObjCIndependentClass:
5297 return cxstring::createRef("attribute(objc_independent_class)");
5298 case CXCursor_ObjCPreciseLifetime:
5299 return cxstring::createRef("attribute(objc_precise_lifetime)");
5300 case CXCursor_ObjCReturnsInnerPointer:
5301 return cxstring::createRef("attribute(objc_returns_inner_pointer)");
5302 case CXCursor_ObjCRequiresSuper:
5303 return cxstring::createRef("attribute(objc_requires_super)");
5304 case CXCursor_ObjCRootClass:
5305 return cxstring::createRef("attribute(objc_root_class)");
5306 case CXCursor_ObjCSubclassingRestricted:
5307 return cxstring::createRef("attribute(objc_subclassing_restricted)");
5308 case CXCursor_ObjCExplicitProtocolImpl:
5309 return cxstring::createRef("attribute(objc_protocol_requires_explicit_implementation)");
5310 case CXCursor_ObjCDesignatedInitializer:
5311 return cxstring::createRef("attribute(objc_designated_initializer)");
5312 case CXCursor_ObjCRuntimeVisible:
5313 return cxstring::createRef("attribute(objc_runtime_visible)");
5314 case CXCursor_ObjCBoxable:
5315 return cxstring::createRef("attribute(objc_boxable)");
Michael Wu58d837d2018-08-03 05:55:40 +00005316 case CXCursor_FlagEnum:
5317 return cxstring::createRef("attribute(flag_enum)");
Guy Benyei11169dd2012-12-18 14:30:41 +00005318 case CXCursor_PreprocessingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005319 return cxstring::createRef("preprocessing directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00005320 case CXCursor_MacroDefinition:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005321 return cxstring::createRef("macro definition");
Guy Benyei11169dd2012-12-18 14:30:41 +00005322 case CXCursor_MacroExpansion:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005323 return cxstring::createRef("macro expansion");
Guy Benyei11169dd2012-12-18 14:30:41 +00005324 case CXCursor_InclusionDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005325 return cxstring::createRef("inclusion directive");
Guy Benyei11169dd2012-12-18 14:30:41 +00005326 case CXCursor_Namespace:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005327 return cxstring::createRef("Namespace");
Guy Benyei11169dd2012-12-18 14:30:41 +00005328 case CXCursor_LinkageSpec:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005329 return cxstring::createRef("LinkageSpec");
Guy Benyei11169dd2012-12-18 14:30:41 +00005330 case CXCursor_CXXBaseSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005331 return cxstring::createRef("C++ base class specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00005332 case CXCursor_Constructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005333 return cxstring::createRef("CXXConstructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00005334 case CXCursor_Destructor:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005335 return cxstring::createRef("CXXDestructor");
Guy Benyei11169dd2012-12-18 14:30:41 +00005336 case CXCursor_ConversionFunction:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005337 return cxstring::createRef("CXXConversion");
Guy Benyei11169dd2012-12-18 14:30:41 +00005338 case CXCursor_TemplateTypeParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005339 return cxstring::createRef("TemplateTypeParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00005340 case CXCursor_NonTypeTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005341 return cxstring::createRef("NonTypeTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00005342 case CXCursor_TemplateTemplateParameter:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005343 return cxstring::createRef("TemplateTemplateParameter");
Guy Benyei11169dd2012-12-18 14:30:41 +00005344 case CXCursor_FunctionTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005345 return cxstring::createRef("FunctionTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00005346 case CXCursor_ClassTemplate:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005347 return cxstring::createRef("ClassTemplate");
Guy Benyei11169dd2012-12-18 14:30:41 +00005348 case CXCursor_ClassTemplatePartialSpecialization:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005349 return cxstring::createRef("ClassTemplatePartialSpecialization");
Guy Benyei11169dd2012-12-18 14:30:41 +00005350 case CXCursor_NamespaceAlias:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005351 return cxstring::createRef("NamespaceAlias");
Guy Benyei11169dd2012-12-18 14:30:41 +00005352 case CXCursor_UsingDirective:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005353 return cxstring::createRef("UsingDirective");
Guy Benyei11169dd2012-12-18 14:30:41 +00005354 case CXCursor_UsingDeclaration:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005355 return cxstring::createRef("UsingDeclaration");
Guy Benyei11169dd2012-12-18 14:30:41 +00005356 case CXCursor_TypeAliasDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005357 return cxstring::createRef("TypeAliasDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005358 case CXCursor_ObjCSynthesizeDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005359 return cxstring::createRef("ObjCSynthesizeDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005360 case CXCursor_ObjCDynamicDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005361 return cxstring::createRef("ObjCDynamicDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005362 case CXCursor_CXXAccessSpecifier:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005363 return cxstring::createRef("CXXAccessSpecifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00005364 case CXCursor_ModuleImportDecl:
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00005365 return cxstring::createRef("ModuleImport");
Alexey Bataev5ec3eb12013-07-19 03:13:43 +00005366 case CXCursor_OMPParallelDirective:
Alexey Bataev1b59ab52014-02-27 08:29:12 +00005367 return cxstring::createRef("OMPParallelDirective");
5368 case CXCursor_OMPSimdDirective:
5369 return cxstring::createRef("OMPSimdDirective");
Alexey Bataevf29276e2014-06-18 04:14:57 +00005370 case CXCursor_OMPForDirective:
5371 return cxstring::createRef("OMPForDirective");
Alexander Musmanf82886e2014-09-18 05:12:34 +00005372 case CXCursor_OMPForSimdDirective:
5373 return cxstring::createRef("OMPForSimdDirective");
Alexey Bataevd3f8dd22014-06-25 11:44:49 +00005374 case CXCursor_OMPSectionsDirective:
5375 return cxstring::createRef("OMPSectionsDirective");
Alexey Bataev1e0498a2014-06-26 08:21:58 +00005376 case CXCursor_OMPSectionDirective:
5377 return cxstring::createRef("OMPSectionDirective");
Alexey Bataevd1e40fb2014-06-26 12:05:45 +00005378 case CXCursor_OMPSingleDirective:
5379 return cxstring::createRef("OMPSingleDirective");
Alexander Musman80c22892014-07-17 08:54:58 +00005380 case CXCursor_OMPMasterDirective:
5381 return cxstring::createRef("OMPMasterDirective");
Alexander Musmand9ed09f2014-07-21 09:42:05 +00005382 case CXCursor_OMPCriticalDirective:
5383 return cxstring::createRef("OMPCriticalDirective");
Alexey Bataev4acb8592014-07-07 13:01:15 +00005384 case CXCursor_OMPParallelForDirective:
5385 return cxstring::createRef("OMPParallelForDirective");
Alexander Musmane4e893b2014-09-23 09:33:00 +00005386 case CXCursor_OMPParallelForSimdDirective:
5387 return cxstring::createRef("OMPParallelForSimdDirective");
Alexey Bataev84d0b3e2014-07-08 08:12:03 +00005388 case CXCursor_OMPParallelSectionsDirective:
5389 return cxstring::createRef("OMPParallelSectionsDirective");
Alexey Bataev9c2e8ee2014-07-11 11:25:16 +00005390 case CXCursor_OMPTaskDirective:
5391 return cxstring::createRef("OMPTaskDirective");
Alexey Bataev68446b72014-07-18 07:47:19 +00005392 case CXCursor_OMPTaskyieldDirective:
5393 return cxstring::createRef("OMPTaskyieldDirective");
Alexey Bataev4d1dfea2014-07-18 09:11:51 +00005394 case CXCursor_OMPBarrierDirective:
5395 return cxstring::createRef("OMPBarrierDirective");
Alexey Bataev2df347a2014-07-18 10:17:07 +00005396 case CXCursor_OMPTaskwaitDirective:
5397 return cxstring::createRef("OMPTaskwaitDirective");
Alexey Bataevc30dd2d2015-06-18 12:14:09 +00005398 case CXCursor_OMPTaskgroupDirective:
5399 return cxstring::createRef("OMPTaskgroupDirective");
Alexey Bataev6125da92014-07-21 11:26:11 +00005400 case CXCursor_OMPFlushDirective:
5401 return cxstring::createRef("OMPFlushDirective");
Alexey Bataev9fb6e642014-07-22 06:45:04 +00005402 case CXCursor_OMPOrderedDirective:
5403 return cxstring::createRef("OMPOrderedDirective");
Alexey Bataev0162e452014-07-22 10:10:35 +00005404 case CXCursor_OMPAtomicDirective:
5405 return cxstring::createRef("OMPAtomicDirective");
Alexey Bataev0bd520b2014-09-19 08:19:49 +00005406 case CXCursor_OMPTargetDirective:
5407 return cxstring::createRef("OMPTargetDirective");
Michael Wong65f367f2015-07-21 13:44:28 +00005408 case CXCursor_OMPTargetDataDirective:
5409 return cxstring::createRef("OMPTargetDataDirective");
Samuel Antaodf67fc42016-01-19 19:15:56 +00005410 case CXCursor_OMPTargetEnterDataDirective:
5411 return cxstring::createRef("OMPTargetEnterDataDirective");
Samuel Antao72590762016-01-19 20:04:50 +00005412 case CXCursor_OMPTargetExitDataDirective:
5413 return cxstring::createRef("OMPTargetExitDataDirective");
Arpith Chacko Jacobe955b3d2016-01-26 18:48:41 +00005414 case CXCursor_OMPTargetParallelDirective:
5415 return cxstring::createRef("OMPTargetParallelDirective");
Arpith Chacko Jacob05bebb52016-02-03 15:46:42 +00005416 case CXCursor_OMPTargetParallelForDirective:
5417 return cxstring::createRef("OMPTargetParallelForDirective");
Samuel Antao686c70c2016-05-26 17:30:50 +00005418 case CXCursor_OMPTargetUpdateDirective:
5419 return cxstring::createRef("OMPTargetUpdateDirective");
Alexey Bataev13314bf2014-10-09 04:18:56 +00005420 case CXCursor_OMPTeamsDirective:
5421 return cxstring::createRef("OMPTeamsDirective");
Alexey Bataev6d4ed052015-07-01 06:57:41 +00005422 case CXCursor_OMPCancellationPointDirective:
5423 return cxstring::createRef("OMPCancellationPointDirective");
Alexey Bataev80909872015-07-02 11:25:17 +00005424 case CXCursor_OMPCancelDirective:
5425 return cxstring::createRef("OMPCancelDirective");
Alexey Bataev49f6e782015-12-01 04:18:41 +00005426 case CXCursor_OMPTaskLoopDirective:
5427 return cxstring::createRef("OMPTaskLoopDirective");
Alexey Bataev0a6ed842015-12-03 09:40:15 +00005428 case CXCursor_OMPTaskLoopSimdDirective:
5429 return cxstring::createRef("OMPTaskLoopSimdDirective");
Carlo Bertolli6200a3d2015-12-14 14:51:25 +00005430 case CXCursor_OMPDistributeDirective:
5431 return cxstring::createRef("OMPDistributeDirective");
Carlo Bertolli9925f152016-06-27 14:55:37 +00005432 case CXCursor_OMPDistributeParallelForDirective:
5433 return cxstring::createRef("OMPDistributeParallelForDirective");
Kelvin Li4a39add2016-07-05 05:00:15 +00005434 case CXCursor_OMPDistributeParallelForSimdDirective:
5435 return cxstring::createRef("OMPDistributeParallelForSimdDirective");
Kelvin Li787f3fc2016-07-06 04:45:38 +00005436 case CXCursor_OMPDistributeSimdDirective:
5437 return cxstring::createRef("OMPDistributeSimdDirective");
Kelvin Lia579b912016-07-14 02:54:56 +00005438 case CXCursor_OMPTargetParallelForSimdDirective:
5439 return cxstring::createRef("OMPTargetParallelForSimdDirective");
Kelvin Li986330c2016-07-20 22:57:10 +00005440 case CXCursor_OMPTargetSimdDirective:
5441 return cxstring::createRef("OMPTargetSimdDirective");
Kelvin Li02532872016-08-05 14:37:37 +00005442 case CXCursor_OMPTeamsDistributeDirective:
5443 return cxstring::createRef("OMPTeamsDistributeDirective");
Kelvin Li4e325f72016-10-25 12:50:55 +00005444 case CXCursor_OMPTeamsDistributeSimdDirective:
5445 return cxstring::createRef("OMPTeamsDistributeSimdDirective");
Kelvin Li579e41c2016-11-30 23:51:03 +00005446 case CXCursor_OMPTeamsDistributeParallelForSimdDirective:
5447 return cxstring::createRef("OMPTeamsDistributeParallelForSimdDirective");
Kelvin Li7ade93f2016-12-09 03:24:30 +00005448 case CXCursor_OMPTeamsDistributeParallelForDirective:
5449 return cxstring::createRef("OMPTeamsDistributeParallelForDirective");
Kelvin Libf594a52016-12-17 05:48:59 +00005450 case CXCursor_OMPTargetTeamsDirective:
5451 return cxstring::createRef("OMPTargetTeamsDirective");
Kelvin Li83c451e2016-12-25 04:52:54 +00005452 case CXCursor_OMPTargetTeamsDistributeDirective:
5453 return cxstring::createRef("OMPTargetTeamsDistributeDirective");
Kelvin Li80e8f562016-12-29 22:16:30 +00005454 case CXCursor_OMPTargetTeamsDistributeParallelForDirective:
5455 return cxstring::createRef("OMPTargetTeamsDistributeParallelForDirective");
Kelvin Li1851df52017-01-03 05:23:48 +00005456 case CXCursor_OMPTargetTeamsDistributeParallelForSimdDirective:
5457 return cxstring::createRef(
5458 "OMPTargetTeamsDistributeParallelForSimdDirective");
Kelvin Lida681182017-01-10 18:08:18 +00005459 case CXCursor_OMPTargetTeamsDistributeSimdDirective:
5460 return cxstring::createRef("OMPTargetTeamsDistributeSimdDirective");
Francisco Lopes da Silva975a9f62015-01-21 16:24:11 +00005461 case CXCursor_OverloadCandidate:
5462 return cxstring::createRef("OverloadCandidate");
Sergey Kalinichev8f3b1872015-11-15 13:48:32 +00005463 case CXCursor_TypeAliasTemplateDecl:
5464 return cxstring::createRef("TypeAliasTemplateDecl");
Olivier Goffart81978012016-06-09 16:15:55 +00005465 case CXCursor_StaticAssert:
5466 return cxstring::createRef("StaticAssert");
Olivier Goffartd211c642016-11-04 06:29:27 +00005467 case CXCursor_FriendDecl:
5468 return cxstring::createRef("FriendDecl");
Guy Benyei11169dd2012-12-18 14:30:41 +00005469 }
5470
5471 llvm_unreachable("Unhandled CXCursorKind");
5472}
5473
5474struct GetCursorData {
5475 SourceLocation TokenBeginLoc;
5476 bool PointsAtMacroArgExpansion;
5477 bool VisitedObjCPropertyImplDecl;
5478 SourceLocation VisitedDeclaratorDeclStartLoc;
5479 CXCursor &BestCursor;
5480
5481 GetCursorData(SourceManager &SM,
5482 SourceLocation tokenBegin, CXCursor &outputCursor)
5483 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
5484 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
5485 VisitedObjCPropertyImplDecl = false;
5486 }
5487};
5488
5489static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
5490 CXCursor parent,
5491 CXClientData client_data) {
5492 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
5493 CXCursor *BestCursor = &Data->BestCursor;
5494
5495 // If we point inside a macro argument we should provide info of what the
5496 // token is so use the actual cursor, don't replace it with a macro expansion
5497 // cursor.
5498 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
5499 return CXChildVisit_Recurse;
5500
5501 if (clang_isDeclaration(cursor.kind)) {
5502 // Avoid having the implicit methods override the property decls.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005503 if (const ObjCMethodDecl *MD
Guy Benyei11169dd2012-12-18 14:30:41 +00005504 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
5505 if (MD->isImplicit())
5506 return CXChildVisit_Break;
5507
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005508 } else if (const ObjCInterfaceDecl *ID
Guy Benyei11169dd2012-12-18 14:30:41 +00005509 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(cursor))) {
5510 // Check that when we have multiple @class references in the same line,
5511 // that later ones do not override the previous ones.
5512 // If we have:
5513 // @class Foo, Bar;
5514 // source ranges for both start at '@', so 'Bar' will end up overriding
5515 // 'Foo' even though the cursor location was at 'Foo'.
5516 if (BestCursor->kind == CXCursor_ObjCInterfaceDecl ||
5517 BestCursor->kind == CXCursor_ObjCClassRef)
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005518 if (const ObjCInterfaceDecl *PrevID
Guy Benyei11169dd2012-12-18 14:30:41 +00005519 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(*BestCursor))){
5520 if (PrevID != ID &&
5521 !PrevID->isThisDeclarationADefinition() &&
5522 !ID->isThisDeclarationADefinition())
5523 return CXChildVisit_Break;
5524 }
5525
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005526 } else if (const DeclaratorDecl *DD
Guy Benyei11169dd2012-12-18 14:30:41 +00005527 = dyn_cast_or_null<DeclaratorDecl>(getCursorDecl(cursor))) {
5528 SourceLocation StartLoc = DD->getSourceRange().getBegin();
5529 // Check that when we have multiple declarators in the same line,
5530 // that later ones do not override the previous ones.
5531 // If we have:
5532 // int Foo, Bar;
5533 // source ranges for both start at 'int', so 'Bar' will end up overriding
5534 // 'Foo' even though the cursor location was at 'Foo'.
5535 if (Data->VisitedDeclaratorDeclStartLoc == StartLoc)
5536 return CXChildVisit_Break;
5537 Data->VisitedDeclaratorDeclStartLoc = StartLoc;
5538
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005539 } else if (const ObjCPropertyImplDecl *PropImp
Guy Benyei11169dd2012-12-18 14:30:41 +00005540 = dyn_cast_or_null<ObjCPropertyImplDecl>(getCursorDecl(cursor))) {
5541 (void)PropImp;
5542 // Check that when we have multiple @synthesize in the same line,
5543 // that later ones do not override the previous ones.
5544 // If we have:
5545 // @synthesize Foo, Bar;
5546 // source ranges for both start at '@', so 'Bar' will end up overriding
5547 // 'Foo' even though the cursor location was at 'Foo'.
5548 if (Data->VisitedObjCPropertyImplDecl)
5549 return CXChildVisit_Break;
5550 Data->VisitedObjCPropertyImplDecl = true;
5551 }
5552 }
5553
5554 if (clang_isExpression(cursor.kind) &&
5555 clang_isDeclaration(BestCursor->kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005556 if (const Decl *D = getCursorDecl(*BestCursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005557 // Avoid having the cursor of an expression replace the declaration cursor
5558 // when the expression source range overlaps the declaration range.
5559 // This can happen for C++ constructor expressions whose range generally
5560 // include the variable declaration, e.g.:
5561 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
5562 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
5563 D->getLocation() == Data->TokenBeginLoc)
5564 return CXChildVisit_Break;
5565 }
5566 }
5567
5568 // If our current best cursor is the construction of a temporary object,
5569 // don't replace that cursor with a type reference, because we want
5570 // clang_getCursor() to point at the constructor.
5571 if (clang_isExpression(BestCursor->kind) &&
5572 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
5573 cursor.kind == CXCursor_TypeRef) {
5574 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
5575 // as having the actual point on the type reference.
5576 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
5577 return CXChildVisit_Recurse;
5578 }
Douglas Gregore9d95f12015-07-07 03:57:35 +00005579
5580 // If we already have an Objective-C superclass reference, don't
5581 // update it further.
5582 if (BestCursor->kind == CXCursor_ObjCSuperClassRef)
5583 return CXChildVisit_Break;
5584
Guy Benyei11169dd2012-12-18 14:30:41 +00005585 *BestCursor = cursor;
5586 return CXChildVisit_Recurse;
5587}
5588
5589CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00005590 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005591 LOG_BAD_TU(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005592 return clang_getNullCursor();
Dmitri Gribenko256454f2014-02-11 14:34:14 +00005593 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005594
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005595 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005596 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
5597
5598 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
5599 CXCursor Result = cxcursor::getCursor(TU, SLoc);
5600
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005601 LOG_FUNC_SECTION {
Guy Benyei11169dd2012-12-18 14:30:41 +00005602 CXFile SearchFile;
5603 unsigned SearchLine, SearchColumn;
5604 CXFile ResultFile;
5605 unsigned ResultLine, ResultColumn;
5606 CXString SearchFileName, ResultFileName, KindSpelling, USR;
5607 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
5608 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
Craig Topper69186e72014-06-08 08:38:04 +00005609
5610 clang_getFileLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
5611 nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005612 clang_getFileLocation(ResultLoc, &ResultFile, &ResultLine,
Craig Topper69186e72014-06-08 08:38:04 +00005613 &ResultColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005614 SearchFileName = clang_getFileName(SearchFile);
5615 ResultFileName = clang_getFileName(ResultFile);
5616 KindSpelling = clang_getCursorKindSpelling(Result.kind);
5617 USR = clang_getCursorUSR(Result);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005618 *Log << llvm::format("(%s:%d:%d) = %s",
5619 clang_getCString(SearchFileName), SearchLine, SearchColumn,
5620 clang_getCString(KindSpelling))
5621 << llvm::format("(%s:%d:%d):%s%s",
5622 clang_getCString(ResultFileName), ResultLine, ResultColumn,
5623 clang_getCString(USR), IsDef);
Guy Benyei11169dd2012-12-18 14:30:41 +00005624 clang_disposeString(SearchFileName);
5625 clang_disposeString(ResultFileName);
5626 clang_disposeString(KindSpelling);
5627 clang_disposeString(USR);
5628
5629 CXCursor Definition = clang_getCursorDefinition(Result);
5630 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
5631 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
5632 CXString DefinitionKindSpelling
5633 = clang_getCursorKindSpelling(Definition.kind);
5634 CXFile DefinitionFile;
5635 unsigned DefinitionLine, DefinitionColumn;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005636 clang_getFileLocation(DefinitionLoc, &DefinitionFile,
Craig Topper69186e72014-06-08 08:38:04 +00005637 &DefinitionLine, &DefinitionColumn, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005638 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00005639 *Log << llvm::format(" -> %s(%s:%d:%d)",
5640 clang_getCString(DefinitionKindSpelling),
5641 clang_getCString(DefinitionFileName),
5642 DefinitionLine, DefinitionColumn);
Guy Benyei11169dd2012-12-18 14:30:41 +00005643 clang_disposeString(DefinitionFileName);
5644 clang_disposeString(DefinitionKindSpelling);
5645 }
5646 }
5647
5648 return Result;
5649}
5650
5651CXCursor clang_getNullCursor(void) {
5652 return MakeCXCursorInvalid(CXCursor_InvalidFile);
5653}
5654
5655unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005656 // Clear out the "FirstInDeclGroup" part in a declaration cursor, since we
5657 // can't set consistently. For example, when visiting a DeclStmt we will set
5658 // it but we don't set it on the result of clang_getCursorDefinition for
5659 // a reference of the same declaration.
5660 // FIXME: Setting "FirstInDeclGroup" in CXCursors is a hack that only works
5661 // when visiting a DeclStmt currently, the AST should be enhanced to be able
5662 // to provide that kind of info.
5663 if (clang_isDeclaration(X.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005664 X.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005665 if (clang_isDeclaration(Y.kind))
Craig Topper69186e72014-06-08 08:38:04 +00005666 Y.data[1] = nullptr;
Argyrios Kyrtzidisbf1be592013-01-08 18:23:28 +00005667
Guy Benyei11169dd2012-12-18 14:30:41 +00005668 return X == Y;
5669}
5670
5671unsigned clang_hashCursor(CXCursor C) {
5672 unsigned Index = 0;
5673 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
5674 Index = 1;
5675
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005676 return llvm::DenseMapInfo<std::pair<unsigned, const void*> >::getHashValue(
Guy Benyei11169dd2012-12-18 14:30:41 +00005677 std::make_pair(C.kind, C.data[Index]));
5678}
5679
5680unsigned clang_isInvalid(enum CXCursorKind K) {
5681 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
5682}
5683
5684unsigned clang_isDeclaration(enum CXCursorKind K) {
5685 return (K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl) ||
Ivan Donchevskii1c27b152018-01-03 10:33:21 +00005686 (K >= CXCursor_FirstExtraDecl && K <= CXCursor_LastExtraDecl);
5687}
5688
Ivan Donchevskii08ff9102018-01-04 10:59:50 +00005689unsigned clang_isInvalidDeclaration(CXCursor C) {
5690 if (clang_isDeclaration(C.kind)) {
5691 if (const Decl *D = getCursorDecl(C))
5692 return D->isInvalidDecl();
5693 }
5694
5695 return 0;
5696}
5697
Ivan Donchevskii1c27b152018-01-03 10:33:21 +00005698unsigned clang_isReference(enum CXCursorKind K) {
5699 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
5700}
Guy Benyei11169dd2012-12-18 14:30:41 +00005701
5702unsigned clang_isExpression(enum CXCursorKind K) {
5703 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
5704}
5705
5706unsigned clang_isStatement(enum CXCursorKind K) {
5707 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
5708}
5709
5710unsigned clang_isAttribute(enum CXCursorKind K) {
5711 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
5712}
5713
5714unsigned clang_isTranslationUnit(enum CXCursorKind K) {
5715 return K == CXCursor_TranslationUnit;
5716}
5717
5718unsigned clang_isPreprocessing(enum CXCursorKind K) {
5719 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
5720}
5721
5722unsigned clang_isUnexposed(enum CXCursorKind K) {
5723 switch (K) {
5724 case CXCursor_UnexposedDecl:
5725 case CXCursor_UnexposedExpr:
5726 case CXCursor_UnexposedStmt:
5727 case CXCursor_UnexposedAttr:
5728 return true;
5729 default:
5730 return false;
5731 }
5732}
5733
5734CXCursorKind clang_getCursorKind(CXCursor C) {
5735 return C.kind;
5736}
5737
5738CXSourceLocation clang_getCursorLocation(CXCursor C) {
5739 if (clang_isReference(C.kind)) {
5740 switch (C.kind) {
5741 case CXCursor_ObjCSuperClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005742 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005743 = getCursorObjCSuperClassRef(C);
5744 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5745 }
5746
5747 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005748 std::pair<const ObjCProtocolDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005749 = getCursorObjCProtocolRef(C);
5750 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5751 }
5752
5753 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005754 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
Guy Benyei11169dd2012-12-18 14:30:41 +00005755 = getCursorObjCClassRef(C);
5756 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5757 }
5758
5759 case CXCursor_TypeRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005760 std::pair<const TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005761 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5762 }
5763
5764 case CXCursor_TemplateRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005765 std::pair<const TemplateDecl *, SourceLocation> P =
5766 getCursorTemplateRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005767 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5768 }
5769
5770 case CXCursor_NamespaceRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005771 std::pair<const NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005772 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5773 }
5774
5775 case CXCursor_MemberRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005776 std::pair<const FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005777 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5778 }
5779
5780 case CXCursor_VariableRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005781 std::pair<const VarDecl *, SourceLocation> P = getCursorVariableRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005782 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5783 }
5784
5785 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005786 const CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005787 if (!BaseSpec)
5788 return clang_getNullLocation();
5789
5790 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
5791 return cxloc::translateSourceLocation(getCursorContext(C),
5792 TSInfo->getTypeLoc().getBeginLoc());
5793
5794 return cxloc::translateSourceLocation(getCursorContext(C),
5795 BaseSpec->getLocStart());
5796 }
5797
5798 case CXCursor_LabelRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00005799 std::pair<const LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005800 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
5801 }
5802
5803 case CXCursor_OverloadedDeclRef:
5804 return cxloc::translateSourceLocation(getCursorContext(C),
5805 getCursorOverloadedDeclRef(C).second);
5806
5807 default:
5808 // FIXME: Need a way to enumerate all non-reference cases.
5809 llvm_unreachable("Missed a reference kind");
5810 }
5811 }
5812
5813 if (clang_isExpression(C.kind))
5814 return cxloc::translateSourceLocation(getCursorContext(C),
5815 getLocationFromExpr(getCursorExpr(C)));
5816
5817 if (clang_isStatement(C.kind))
5818 return cxloc::translateSourceLocation(getCursorContext(C),
5819 getCursorStmt(C)->getLocStart());
5820
5821 if (C.kind == CXCursor_PreprocessingDirective) {
5822 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
5823 return cxloc::translateSourceLocation(getCursorContext(C), L);
5824 }
5825
5826 if (C.kind == CXCursor_MacroExpansion) {
5827 SourceLocation L
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005828 = cxcursor::getCursorMacroExpansion(C).getSourceRange().getBegin();
Guy Benyei11169dd2012-12-18 14:30:41 +00005829 return cxloc::translateSourceLocation(getCursorContext(C), L);
5830 }
5831
5832 if (C.kind == CXCursor_MacroDefinition) {
5833 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
5834 return cxloc::translateSourceLocation(getCursorContext(C), L);
5835 }
5836
5837 if (C.kind == CXCursor_InclusionDirective) {
5838 SourceLocation L
5839 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
5840 return cxloc::translateSourceLocation(getCursorContext(C), L);
5841 }
5842
Argyrios Kyrtzidis16834f12013-09-25 00:14:38 +00005843 if (clang_isAttribute(C.kind)) {
5844 SourceLocation L
5845 = cxcursor::getCursorAttr(C)->getLocation();
5846 return cxloc::translateSourceLocation(getCursorContext(C), L);
5847 }
5848
Guy Benyei11169dd2012-12-18 14:30:41 +00005849 if (!clang_isDeclaration(C.kind))
5850 return clang_getNullLocation();
5851
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005852 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005853 if (!D)
5854 return clang_getNullLocation();
5855
5856 SourceLocation Loc = D->getLocation();
5857 // FIXME: Multiple variables declared in a single declaration
5858 // currently lack the information needed to correctly determine their
5859 // ranges when accounting for the type-specifier. We use context
5860 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5861 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005862 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005863 if (!cxcursor::isFirstInDeclGroup(C))
5864 Loc = VD->getLocation();
5865 }
5866
5867 // For ObjC methods, give the start location of the method name.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005868 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00005869 Loc = MD->getSelectorStartLoc();
5870
5871 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
5872}
5873
NAKAMURA Takumia01f4c32016-12-19 16:50:43 +00005874} // end extern "C"
5875
Guy Benyei11169dd2012-12-18 14:30:41 +00005876CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
5877 assert(TU);
5878
5879 // Guard against an invalid SourceLocation, or we may assert in one
5880 // of the following calls.
5881 if (SLoc.isInvalid())
5882 return clang_getNullCursor();
5883
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00005884 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00005885
5886 // Translate the given source location to make it point at the beginning of
5887 // the token under the cursor.
5888 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
5889 CXXUnit->getASTContext().getLangOpts());
5890
5891 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
5892 if (SLoc.isValid()) {
5893 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
5894 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
5895 /*VisitPreprocessorLast=*/true,
5896 /*VisitIncludedEntities=*/false,
5897 SourceLocation(SLoc));
5898 CursorVis.visitFileRegion();
5899 }
5900
5901 return Result;
5902}
5903
5904static SourceRange getRawCursorExtent(CXCursor C) {
5905 if (clang_isReference(C.kind)) {
5906 switch (C.kind) {
5907 case CXCursor_ObjCSuperClassRef:
5908 return getCursorObjCSuperClassRef(C).second;
5909
5910 case CXCursor_ObjCProtocolRef:
5911 return getCursorObjCProtocolRef(C).second;
5912
5913 case CXCursor_ObjCClassRef:
5914 return getCursorObjCClassRef(C).second;
5915
5916 case CXCursor_TypeRef:
5917 return getCursorTypeRef(C).second;
5918
5919 case CXCursor_TemplateRef:
5920 return getCursorTemplateRef(C).second;
5921
5922 case CXCursor_NamespaceRef:
5923 return getCursorNamespaceRef(C).second;
5924
5925 case CXCursor_MemberRef:
5926 return getCursorMemberRef(C).second;
5927
5928 case CXCursor_CXXBaseSpecifier:
5929 return getCursorCXXBaseSpecifier(C)->getSourceRange();
5930
5931 case CXCursor_LabelRef:
5932 return getCursorLabelRef(C).second;
5933
5934 case CXCursor_OverloadedDeclRef:
5935 return getCursorOverloadedDeclRef(C).second;
5936
5937 case CXCursor_VariableRef:
5938 return getCursorVariableRef(C).second;
5939
5940 default:
5941 // FIXME: Need a way to enumerate all non-reference cases.
5942 llvm_unreachable("Missed a reference kind");
5943 }
5944 }
5945
5946 if (clang_isExpression(C.kind))
5947 return getCursorExpr(C)->getSourceRange();
5948
5949 if (clang_isStatement(C.kind))
5950 return getCursorStmt(C)->getSourceRange();
5951
5952 if (clang_isAttribute(C.kind))
5953 return getCursorAttr(C)->getRange();
5954
5955 if (C.kind == CXCursor_PreprocessingDirective)
5956 return cxcursor::getCursorPreprocessingDirective(C);
5957
5958 if (C.kind == CXCursor_MacroExpansion) {
5959 ASTUnit *TU = getCursorASTUnit(C);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00005960 SourceRange Range = cxcursor::getCursorMacroExpansion(C).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00005961 return TU->mapRangeFromPreamble(Range);
5962 }
5963
5964 if (C.kind == CXCursor_MacroDefinition) {
5965 ASTUnit *TU = getCursorASTUnit(C);
5966 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
5967 return TU->mapRangeFromPreamble(Range);
5968 }
5969
5970 if (C.kind == CXCursor_InclusionDirective) {
5971 ASTUnit *TU = getCursorASTUnit(C);
5972 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
5973 return TU->mapRangeFromPreamble(Range);
5974 }
5975
5976 if (C.kind == CXCursor_TranslationUnit) {
5977 ASTUnit *TU = getCursorASTUnit(C);
5978 FileID MainID = TU->getSourceManager().getMainFileID();
5979 SourceLocation Start = TU->getSourceManager().getLocForStartOfFile(MainID);
5980 SourceLocation End = TU->getSourceManager().getLocForEndOfFile(MainID);
5981 return SourceRange(Start, End);
5982 }
5983
5984 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005985 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00005986 if (!D)
5987 return SourceRange();
5988
5989 SourceRange R = D->getSourceRange();
5990 // FIXME: Multiple variables declared in a single declaration
5991 // currently lack the information needed to correctly determine their
5992 // ranges when accounting for the type-specifier. We use context
5993 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5994 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00005995 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005996 if (!cxcursor::isFirstInDeclGroup(C))
5997 R.setBegin(VD->getLocation());
5998 }
5999 return R;
6000 }
6001 return SourceRange();
6002}
6003
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006004/// Retrieves the "raw" cursor extent, which is then extended to include
Guy Benyei11169dd2012-12-18 14:30:41 +00006005/// the decl-specifier-seq for declarations.
6006static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
6007 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006008 const Decl *D = cxcursor::getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00006009 if (!D)
6010 return SourceRange();
6011
6012 SourceRange R = D->getSourceRange();
6013
6014 // Adjust the start of the location for declarations preceded by
6015 // declaration specifiers.
6016 SourceLocation StartLoc;
6017 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
6018 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
6019 StartLoc = TI->getTypeLoc().getLocStart();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006020 } else if (const TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006021 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
6022 StartLoc = TI->getTypeLoc().getLocStart();
6023 }
6024
6025 if (StartLoc.isValid() && R.getBegin().isValid() &&
6026 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
6027 R.setBegin(StartLoc);
6028
6029 // FIXME: Multiple variables declared in a single declaration
6030 // currently lack the information needed to correctly determine their
6031 // ranges when accounting for the type-specifier. We use context
6032 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
6033 // and if so, whether it is the first decl.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006034 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006035 if (!cxcursor::isFirstInDeclGroup(C))
6036 R.setBegin(VD->getLocation());
6037 }
6038
6039 return R;
6040 }
6041
6042 return getRawCursorExtent(C);
6043}
6044
Guy Benyei11169dd2012-12-18 14:30:41 +00006045CXSourceRange clang_getCursorExtent(CXCursor C) {
6046 SourceRange R = getRawCursorExtent(C);
6047 if (R.isInvalid())
6048 return clang_getNullRange();
6049
6050 return cxloc::translateSourceRange(getCursorContext(C), R);
6051}
6052
6053CXCursor clang_getCursorReferenced(CXCursor C) {
6054 if (clang_isInvalid(C.kind))
6055 return clang_getNullCursor();
6056
6057 CXTranslationUnit tu = getCursorTU(C);
6058 if (clang_isDeclaration(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006059 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00006060 if (!D)
6061 return clang_getNullCursor();
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006062 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006063 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006064 if (const ObjCPropertyImplDecl *PropImpl =
6065 dyn_cast<ObjCPropertyImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006066 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
6067 return MakeCXCursor(Property, tu);
6068
6069 return C;
6070 }
6071
6072 if (clang_isExpression(C.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006073 const Expr *E = getCursorExpr(C);
6074 const Decl *D = getDeclFromExpr(E);
Guy Benyei11169dd2012-12-18 14:30:41 +00006075 if (D) {
6076 CXCursor declCursor = MakeCXCursor(D, tu);
6077 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
6078 declCursor);
6079 return declCursor;
6080 }
6081
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006082 if (const OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Guy Benyei11169dd2012-12-18 14:30:41 +00006083 return MakeCursorOverloadedDeclRef(Ovl, tu);
6084
6085 return clang_getNullCursor();
6086 }
6087
6088 if (clang_isStatement(C.kind)) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006089 const Stmt *S = getCursorStmt(C);
6090 if (const GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Guy Benyei11169dd2012-12-18 14:30:41 +00006091 if (LabelDecl *label = Goto->getLabel())
6092 if (LabelStmt *labelS = label->getStmt())
6093 return MakeCXCursor(labelS, getCursorDecl(C), tu);
6094
6095 return clang_getNullCursor();
6096 }
Richard Smith66a81862015-05-04 02:25:31 +00006097
Guy Benyei11169dd2012-12-18 14:30:41 +00006098 if (C.kind == CXCursor_MacroExpansion) {
Richard Smith66a81862015-05-04 02:25:31 +00006099 if (const MacroDefinitionRecord *Def =
6100 getCursorMacroExpansion(C).getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006101 return MakeMacroDefinitionCursor(Def, tu);
6102 }
6103
6104 if (!clang_isReference(C.kind))
6105 return clang_getNullCursor();
6106
6107 switch (C.kind) {
6108 case CXCursor_ObjCSuperClassRef:
6109 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
6110
6111 case CXCursor_ObjCProtocolRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00006112 const ObjCProtocolDecl *Prot = getCursorObjCProtocolRef(C).first;
6113 if (const ObjCProtocolDecl *Def = Prot->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006114 return MakeCXCursor(Def, tu);
6115
6116 return MakeCXCursor(Prot, tu);
6117 }
6118
6119 case CXCursor_ObjCClassRef: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00006120 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
6121 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006122 return MakeCXCursor(Def, tu);
6123
6124 return MakeCXCursor(Class, tu);
6125 }
6126
6127 case CXCursor_TypeRef:
6128 return MakeCXCursor(getCursorTypeRef(C).first, tu );
6129
6130 case CXCursor_TemplateRef:
6131 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
6132
6133 case CXCursor_NamespaceRef:
6134 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
6135
6136 case CXCursor_MemberRef:
6137 return MakeCXCursor(getCursorMemberRef(C).first, tu );
6138
6139 case CXCursor_CXXBaseSpecifier: {
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00006140 const CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00006141 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
6142 tu ));
6143 }
6144
6145 case CXCursor_LabelRef:
6146 // FIXME: We end up faking the "parent" declaration here because we
6147 // don't want to make CXCursor larger.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006148 return MakeCXCursor(getCursorLabelRef(C).first,
6149 cxtu::getASTUnit(tu)->getASTContext()
6150 .getTranslationUnitDecl(),
Guy Benyei11169dd2012-12-18 14:30:41 +00006151 tu);
6152
6153 case CXCursor_OverloadedDeclRef:
6154 return C;
6155
6156 case CXCursor_VariableRef:
6157 return MakeCXCursor(getCursorVariableRef(C).first, tu);
6158
6159 default:
6160 // We would prefer to enumerate all non-reference cursor kinds here.
6161 llvm_unreachable("Unhandled reference cursor kind");
6162 }
6163}
6164
6165CXCursor clang_getCursorDefinition(CXCursor C) {
6166 if (clang_isInvalid(C.kind))
6167 return clang_getNullCursor();
6168
6169 CXTranslationUnit TU = getCursorTU(C);
6170
6171 bool WasReference = false;
6172 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
6173 C = clang_getCursorReferenced(C);
6174 WasReference = true;
6175 }
6176
6177 if (C.kind == CXCursor_MacroExpansion)
6178 return clang_getCursorReferenced(C);
6179
6180 if (!clang_isDeclaration(C.kind))
6181 return clang_getNullCursor();
6182
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006183 const Decl *D = getCursorDecl(C);
Guy Benyei11169dd2012-12-18 14:30:41 +00006184 if (!D)
6185 return clang_getNullCursor();
6186
6187 switch (D->getKind()) {
6188 // Declaration kinds that don't really separate the notions of
6189 // declaration and definition.
6190 case Decl::Namespace:
6191 case Decl::Typedef:
6192 case Decl::TypeAlias:
6193 case Decl::TypeAliasTemplate:
6194 case Decl::TemplateTypeParm:
6195 case Decl::EnumConstant:
6196 case Decl::Field:
Richard Smithbdb84f32016-07-22 23:36:59 +00006197 case Decl::Binding:
John McCall5e77d762013-04-16 07:28:30 +00006198 case Decl::MSProperty:
Guy Benyei11169dd2012-12-18 14:30:41 +00006199 case Decl::IndirectField:
6200 case Decl::ObjCIvar:
6201 case Decl::ObjCAtDefsField:
6202 case Decl::ImplicitParam:
6203 case Decl::ParmVar:
6204 case Decl::NonTypeTemplateParm:
6205 case Decl::TemplateTemplateParm:
6206 case Decl::ObjCCategoryImpl:
6207 case Decl::ObjCImplementation:
6208 case Decl::AccessSpec:
6209 case Decl::LinkageSpec:
Richard Smith8df390f2016-09-08 23:14:54 +00006210 case Decl::Export:
Guy Benyei11169dd2012-12-18 14:30:41 +00006211 case Decl::ObjCPropertyImpl:
6212 case Decl::FileScopeAsm:
6213 case Decl::StaticAssert:
6214 case Decl::Block:
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +00006215 case Decl::Captured:
Alexey Bataev4244be22016-02-11 05:35:55 +00006216 case Decl::OMPCapturedExpr:
Guy Benyei11169dd2012-12-18 14:30:41 +00006217 case Decl::Label: // FIXME: Is this right??
6218 case Decl::ClassScopeFunctionSpecialization:
Richard Smithbc491202017-02-17 20:05:37 +00006219 case Decl::CXXDeductionGuide:
Guy Benyei11169dd2012-12-18 14:30:41 +00006220 case Decl::Import:
Alexey Bataeva769e072013-03-22 06:34:35 +00006221 case Decl::OMPThreadPrivate:
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00006222 case Decl::OMPDeclareReduction:
Douglas Gregor85f3f952015-07-07 03:57:15 +00006223 case Decl::ObjCTypeParam:
David Majnemerd9b1a4f2015-11-04 03:40:30 +00006224 case Decl::BuiltinTemplate:
Nico Weber66220292016-03-02 17:28:48 +00006225 case Decl::PragmaComment:
Nico Webercbbaeb12016-03-02 19:28:54 +00006226 case Decl::PragmaDetectMismatch:
Richard Smith151c4562016-12-20 21:35:28 +00006227 case Decl::UsingPack:
Guy Benyei11169dd2012-12-18 14:30:41 +00006228 return C;
6229
6230 // Declaration kinds that don't make any sense here, but are
6231 // nonetheless harmless.
David Blaikief005d3c2013-02-22 17:44:58 +00006232 case Decl::Empty:
Guy Benyei11169dd2012-12-18 14:30:41 +00006233 case Decl::TranslationUnit:
Richard Smithf19e1272015-03-07 00:04:49 +00006234 case Decl::ExternCContext:
Guy Benyei11169dd2012-12-18 14:30:41 +00006235 break;
6236
6237 // Declaration kinds for which the definition is not resolvable.
6238 case Decl::UnresolvedUsingTypename:
6239 case Decl::UnresolvedUsingValue:
6240 break;
6241
6242 case Decl::UsingDirective:
6243 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
6244 TU);
6245
6246 case Decl::NamespaceAlias:
6247 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
6248
6249 case Decl::Enum:
6250 case Decl::Record:
6251 case Decl::CXXRecord:
6252 case Decl::ClassTemplateSpecialization:
6253 case Decl::ClassTemplatePartialSpecialization:
6254 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
6255 return MakeCXCursor(Def, TU);
6256 return clang_getNullCursor();
6257
6258 case Decl::Function:
6259 case Decl::CXXMethod:
6260 case Decl::CXXConstructor:
6261 case Decl::CXXDestructor:
6262 case Decl::CXXConversion: {
Craig Topper69186e72014-06-08 08:38:04 +00006263 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006264 if (cast<FunctionDecl>(D)->getBody(Def))
Dmitri Gribenko9c256e32013-01-14 00:46:27 +00006265 return MakeCXCursor(Def, TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006266 return clang_getNullCursor();
6267 }
6268
Larisse Voufo39a1e502013-08-06 01:03:05 +00006269 case Decl::Var:
6270 case Decl::VarTemplateSpecialization:
Richard Smithbdb84f32016-07-22 23:36:59 +00006271 case Decl::VarTemplatePartialSpecialization:
6272 case Decl::Decomposition: {
Guy Benyei11169dd2012-12-18 14:30:41 +00006273 // Ask the variable if it has a definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006274 if (const VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006275 return MakeCXCursor(Def, TU);
6276 return clang_getNullCursor();
6277 }
6278
6279 case Decl::FunctionTemplate: {
Craig Topper69186e72014-06-08 08:38:04 +00006280 const FunctionDecl *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006281 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
6282 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
6283 return clang_getNullCursor();
6284 }
6285
6286 case Decl::ClassTemplate: {
6287 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
6288 ->getDefinition())
6289 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
6290 TU);
6291 return clang_getNullCursor();
6292 }
6293
Larisse Voufo39a1e502013-08-06 01:03:05 +00006294 case Decl::VarTemplate: {
6295 if (VarDecl *Def =
6296 cast<VarTemplateDecl>(D)->getTemplatedDecl()->getDefinition())
6297 return MakeCXCursor(cast<VarDecl>(Def)->getDescribedVarTemplate(), TU);
6298 return clang_getNullCursor();
6299 }
6300
Guy Benyei11169dd2012-12-18 14:30:41 +00006301 case Decl::Using:
6302 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
6303 D->getLocation(), TU);
6304
6305 case Decl::UsingShadow:
Richard Smith5179eb72016-06-28 19:03:57 +00006306 case Decl::ConstructorUsingShadow:
Guy Benyei11169dd2012-12-18 14:30:41 +00006307 return clang_getCursorDefinition(
6308 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
6309 TU));
6310
6311 case Decl::ObjCMethod: {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006312 const ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00006313 if (Method->isThisDeclarationADefinition())
6314 return C;
6315
6316 // Dig out the method definition in the associated
6317 // @implementation, if we have it.
6318 // FIXME: The ASTs should make finding the definition easier.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006319 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00006320 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
6321 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
6322 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
6323 Method->isInstanceMethod()))
6324 if (Def->isThisDeclarationADefinition())
6325 return MakeCXCursor(Def, TU);
6326
6327 return clang_getNullCursor();
6328 }
6329
6330 case Decl::ObjCCategory:
6331 if (ObjCCategoryImplDecl *Impl
6332 = cast<ObjCCategoryDecl>(D)->getImplementation())
6333 return MakeCXCursor(Impl, TU);
6334 return clang_getNullCursor();
6335
6336 case Decl::ObjCProtocol:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006337 if (const ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(D)->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006338 return MakeCXCursor(Def, TU);
6339 return clang_getNullCursor();
6340
6341 case Decl::ObjCInterface: {
6342 // There are two notions of a "definition" for an Objective-C
6343 // class: the interface and its implementation. When we resolved a
6344 // reference to an Objective-C class, produce the @interface as
6345 // the definition; when we were provided with the interface,
6346 // produce the @implementation as the definition.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006347 const ObjCInterfaceDecl *IFace = cast<ObjCInterfaceDecl>(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00006348 if (WasReference) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006349 if (const ObjCInterfaceDecl *Def = IFace->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006350 return MakeCXCursor(Def, TU);
6351 } else if (ObjCImplementationDecl *Impl = IFace->getImplementation())
6352 return MakeCXCursor(Impl, TU);
6353 return clang_getNullCursor();
6354 }
6355
6356 case Decl::ObjCProperty:
6357 // FIXME: We don't really know where to find the
6358 // ObjCPropertyImplDecls that implement this property.
6359 return clang_getNullCursor();
6360
6361 case Decl::ObjCCompatibleAlias:
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006362 if (const ObjCInterfaceDecl *Class
Guy Benyei11169dd2012-12-18 14:30:41 +00006363 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006364 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
Guy Benyei11169dd2012-12-18 14:30:41 +00006365 return MakeCXCursor(Def, TU);
6366
6367 return clang_getNullCursor();
6368
6369 case Decl::Friend:
6370 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
6371 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
6372 return clang_getNullCursor();
6373
6374 case Decl::FriendTemplate:
6375 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
6376 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
6377 return clang_getNullCursor();
6378 }
6379
6380 return clang_getNullCursor();
6381}
6382
6383unsigned clang_isCursorDefinition(CXCursor C) {
6384 if (!clang_isDeclaration(C.kind))
6385 return 0;
6386
6387 return clang_getCursorDefinition(C) == C;
6388}
6389
6390CXCursor clang_getCanonicalCursor(CXCursor C) {
6391 if (!clang_isDeclaration(C.kind))
6392 return C;
6393
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006394 if (const Decl *D = getCursorDecl(C)) {
6395 if (const ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006396 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
6397 return MakeCXCursor(CatD, getCursorTU(C));
6398
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006399 if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
6400 if (const ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
Guy Benyei11169dd2012-12-18 14:30:41 +00006401 return MakeCXCursor(IFD, getCursorTU(C));
6402
6403 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
6404 }
6405
6406 return C;
6407}
6408
6409int clang_Cursor_getObjCSelectorIndex(CXCursor cursor) {
6410 return cxcursor::getSelectorIdentifierIndexAndLoc(cursor).first;
6411}
6412
6413unsigned clang_getNumOverloadedDecls(CXCursor C) {
6414 if (C.kind != CXCursor_OverloadedDeclRef)
6415 return 0;
6416
6417 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006418 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00006419 return E->getNumDecls();
6420
6421 if (OverloadedTemplateStorage *S
6422 = Storage.dyn_cast<OverloadedTemplateStorage*>())
6423 return S->size();
6424
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006425 const Decl *D = Storage.get<const Decl *>();
6426 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00006427 return Using->shadow_size();
6428
6429 return 0;
6430}
6431
6432CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
6433 if (cursor.kind != CXCursor_OverloadedDeclRef)
6434 return clang_getNullCursor();
6435
6436 if (index >= clang_getNumOverloadedDecls(cursor))
6437 return clang_getNullCursor();
6438
6439 CXTranslationUnit TU = getCursorTU(cursor);
6440 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006441 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
Guy Benyei11169dd2012-12-18 14:30:41 +00006442 return MakeCXCursor(E->decls_begin()[index], TU);
6443
6444 if (OverloadedTemplateStorage *S
6445 = Storage.dyn_cast<OverloadedTemplateStorage*>())
6446 return MakeCXCursor(S->begin()[index], TU);
6447
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006448 const Decl *D = Storage.get<const Decl *>();
6449 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006450 // FIXME: This is, unfortunately, linear time.
6451 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
6452 std::advance(Pos, index);
6453 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
6454 }
6455
6456 return clang_getNullCursor();
6457}
6458
6459void clang_getDefinitionSpellingAndExtent(CXCursor C,
6460 const char **startBuf,
6461 const char **endBuf,
6462 unsigned *startLine,
6463 unsigned *startColumn,
6464 unsigned *endLine,
6465 unsigned *endColumn) {
6466 assert(getCursorDecl(C) && "CXCursor has null decl");
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006467 const FunctionDecl *FD = dyn_cast<FunctionDecl>(getCursorDecl(C));
Guy Benyei11169dd2012-12-18 14:30:41 +00006468 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
6469
6470 SourceManager &SM = FD->getASTContext().getSourceManager();
6471 *startBuf = SM.getCharacterData(Body->getLBracLoc());
6472 *endBuf = SM.getCharacterData(Body->getRBracLoc());
6473 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
6474 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
6475 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
6476 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
6477}
6478
6479
6480CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
6481 unsigned PieceIndex) {
6482 RefNamePieces Pieces;
6483
6484 switch (C.kind) {
6485 case CXCursor_MemberRefExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006486 if (const MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00006487 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
6488 E->getQualifierLoc().getSourceRange());
6489 break;
6490
6491 case CXCursor_DeclRefExpr:
James Y Knight04ec5bf2015-12-24 02:59:37 +00006492 if (const DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C))) {
6493 SourceRange TemplateArgLoc(E->getLAngleLoc(), E->getRAngleLoc());
6494 Pieces =
6495 buildPieces(NameFlags, false, E->getNameInfo(),
6496 E->getQualifierLoc().getSourceRange(), &TemplateArgLoc);
6497 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006498 break;
6499
6500 case CXCursor_CallExpr:
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006501 if (const CXXOperatorCallExpr *OCE =
Guy Benyei11169dd2012-12-18 14:30:41 +00006502 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006503 const Expr *Callee = OCE->getCallee();
6504 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00006505 Callee = ICE->getSubExpr();
6506
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00006507 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
Guy Benyei11169dd2012-12-18 14:30:41 +00006508 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
6509 DRE->getQualifierLoc().getSourceRange());
6510 }
6511 break;
6512
6513 default:
6514 break;
6515 }
6516
6517 if (Pieces.empty()) {
6518 if (PieceIndex == 0)
6519 return clang_getCursorExtent(C);
6520 } else if (PieceIndex < Pieces.size()) {
6521 SourceRange R = Pieces[PieceIndex];
6522 if (R.isValid())
6523 return cxloc::translateSourceRange(getCursorContext(C), R);
6524 }
6525
6526 return clang_getNullRange();
6527}
6528
6529void clang_enableStackTraces(void) {
Richard Smithdfed58a2016-06-09 00:53:41 +00006530 // FIXME: Provide an argv0 here so we can find llvm-symbolizer.
6531 llvm::sys::PrintStackTraceOnErrorSignal(StringRef());
Guy Benyei11169dd2012-12-18 14:30:41 +00006532}
6533
6534void clang_executeOnThread(void (*fn)(void*), void *user_data,
6535 unsigned stack_size) {
6536 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
6537}
6538
Guy Benyei11169dd2012-12-18 14:30:41 +00006539//===----------------------------------------------------------------------===//
6540// Token-based Operations.
6541//===----------------------------------------------------------------------===//
6542
6543/* CXToken layout:
6544 * int_data[0]: a CXTokenKind
6545 * int_data[1]: starting token location
6546 * int_data[2]: token length
6547 * int_data[3]: reserved
6548 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
6549 * otherwise unused.
6550 */
Guy Benyei11169dd2012-12-18 14:30:41 +00006551CXTokenKind clang_getTokenKind(CXToken CXTok) {
6552 return static_cast<CXTokenKind>(CXTok.int_data[0]);
6553}
6554
6555CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
6556 switch (clang_getTokenKind(CXTok)) {
6557 case CXToken_Identifier:
6558 case CXToken_Keyword:
6559 // We know we have an IdentifierInfo*, so use that.
Dmitri Gribenko3c66b0b2013-02-02 00:02:12 +00006560 return cxstring::createRef(static_cast<IdentifierInfo *>(CXTok.ptr_data)
Guy Benyei11169dd2012-12-18 14:30:41 +00006561 ->getNameStart());
6562
6563 case CXToken_Literal: {
6564 // We have stashed the starting pointer in the ptr_data field. Use it.
6565 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00006566 return cxstring::createDup(StringRef(Text, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006567 }
6568
6569 case CXToken_Punctuation:
6570 case CXToken_Comment:
6571 break;
6572 }
6573
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006574 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006575 LOG_BAD_TU(TU);
6576 return cxstring::createEmpty();
6577 }
6578
Guy Benyei11169dd2012-12-18 14:30:41 +00006579 // We have to find the starting buffer pointer the hard way, by
6580 // deconstructing the source location.
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006581 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006582 if (!CXXUnit)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00006583 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006584
6585 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
6586 std::pair<FileID, unsigned> LocInfo
6587 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
6588 bool Invalid = false;
6589 StringRef Buffer
6590 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
6591 if (Invalid)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00006592 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006593
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00006594 return cxstring::createDup(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00006595}
6596
6597CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006598 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006599 LOG_BAD_TU(TU);
6600 return clang_getNullLocation();
6601 }
6602
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006603 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006604 if (!CXXUnit)
6605 return clang_getNullLocation();
6606
6607 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
6608 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6609}
6610
6611CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006612 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006613 LOG_BAD_TU(TU);
6614 return clang_getNullRange();
6615 }
6616
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006617 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006618 if (!CXXUnit)
6619 return clang_getNullRange();
6620
6621 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
6622 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6623}
6624
6625static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
6626 SmallVectorImpl<CXToken> &CXTokens) {
6627 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6628 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006629 = SourceMgr.getDecomposedSpellingLoc(Range.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00006630 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00006631 = SourceMgr.getDecomposedSpellingLoc(Range.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00006632
6633 // Cannot tokenize across files.
6634 if (BeginLocInfo.first != EndLocInfo.first)
6635 return;
6636
6637 // Create a lexer
6638 bool Invalid = false;
6639 StringRef Buffer
6640 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6641 if (Invalid)
6642 return;
6643
6644 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6645 CXXUnit->getASTContext().getLangOpts(),
6646 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
6647 Lex.SetCommentRetentionState(true);
6648
6649 // Lex tokens until we hit the end of the range.
6650 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
6651 Token Tok;
6652 bool previousWasAt = false;
6653 do {
6654 // Lex the next token
6655 Lex.LexFromRawLexer(Tok);
6656 if (Tok.is(tok::eof))
6657 break;
6658
6659 // Initialize the CXToken.
6660 CXToken CXTok;
6661
6662 // - Common fields
6663 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
6664 CXTok.int_data[2] = Tok.getLength();
6665 CXTok.int_data[3] = 0;
6666
6667 // - Kind-specific fields
6668 if (Tok.isLiteral()) {
6669 CXTok.int_data[0] = CXToken_Literal;
Dmitri Gribenkof9304482013-01-23 15:56:07 +00006670 CXTok.ptr_data = const_cast<char *>(Tok.getLiteralData());
Guy Benyei11169dd2012-12-18 14:30:41 +00006671 } else if (Tok.is(tok::raw_identifier)) {
6672 // Lookup the identifier to determine whether we have a keyword.
6673 IdentifierInfo *II
6674 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
6675
6676 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
6677 CXTok.int_data[0] = CXToken_Keyword;
6678 }
6679 else {
6680 CXTok.int_data[0] = Tok.is(tok::identifier)
6681 ? CXToken_Identifier
6682 : CXToken_Keyword;
6683 }
6684 CXTok.ptr_data = II;
6685 } else if (Tok.is(tok::comment)) {
6686 CXTok.int_data[0] = CXToken_Comment;
Craig Topper69186e72014-06-08 08:38:04 +00006687 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006688 } else {
6689 CXTok.int_data[0] = CXToken_Punctuation;
Craig Topper69186e72014-06-08 08:38:04 +00006690 CXTok.ptr_data = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006691 }
6692 CXTokens.push_back(CXTok);
6693 previousWasAt = Tok.is(tok::at);
Argyrios Kyrtzidisc7c6a072016-11-09 23:58:39 +00006694 } while (Lex.getBufferLocation() < EffectiveBufferEnd);
Guy Benyei11169dd2012-12-18 14:30:41 +00006695}
6696
Ivan Donchevskii3957e482018-06-13 12:37:08 +00006697CXToken *clang_getToken(CXTranslationUnit TU, CXSourceLocation Location) {
6698 LOG_FUNC_SECTION {
6699 *Log << TU << ' ' << Location;
6700 }
6701
6702 if (isNotUsableTU(TU)) {
6703 LOG_BAD_TU(TU);
6704 return NULL;
6705 }
6706
6707 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6708 if (!CXXUnit)
6709 return NULL;
6710
6711 SourceLocation Begin = cxloc::translateSourceLocation(Location);
6712 if (Begin.isInvalid())
6713 return NULL;
6714 SourceManager &SM = CXXUnit->getSourceManager();
6715 std::pair<FileID, unsigned> DecomposedEnd = SM.getDecomposedLoc(Begin);
6716 DecomposedEnd.second += Lexer::MeasureTokenLength(Begin, SM, CXXUnit->getLangOpts());
6717
6718 SourceLocation End = SM.getComposedLoc(DecomposedEnd.first, DecomposedEnd.second);
6719
6720 SmallVector<CXToken, 32> CXTokens;
6721 getTokens(CXXUnit, SourceRange(Begin, End), CXTokens);
6722
6723 if (CXTokens.empty())
6724 return NULL;
6725
6726 CXTokens.resize(1);
6727 CXToken *Token = static_cast<CXToken *>(llvm::safe_malloc(sizeof(CXToken)));
6728
6729 memmove(Token, CXTokens.data(), sizeof(CXToken));
6730 return Token;
6731}
6732
Guy Benyei11169dd2012-12-18 14:30:41 +00006733void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
6734 CXToken **Tokens, unsigned *NumTokens) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00006735 LOG_FUNC_SECTION {
6736 *Log << TU << ' ' << Range;
6737 }
6738
Guy Benyei11169dd2012-12-18 14:30:41 +00006739 if (Tokens)
Craig Topper69186e72014-06-08 08:38:04 +00006740 *Tokens = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006741 if (NumTokens)
6742 *NumTokens = 0;
6743
Dmitri Gribenko852d6222014-02-11 15:02:48 +00006744 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006745 LOG_BAD_TU(TU);
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006746 return;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00006747 }
Argyrios Kyrtzidis0e95fca2013-04-04 22:40:59 +00006748
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006749 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00006750 if (!CXXUnit || !Tokens || !NumTokens)
6751 return;
6752
6753 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6754
6755 SourceRange R = cxloc::translateCXSourceRange(Range);
6756 if (R.isInvalid())
6757 return;
6758
6759 SmallVector<CXToken, 32> CXTokens;
6760 getTokens(CXXUnit, R, CXTokens);
6761
6762 if (CXTokens.empty())
6763 return;
6764
Serge Pavlov52525732018-02-21 02:02:39 +00006765 *Tokens = static_cast<CXToken *>(
6766 llvm::safe_malloc(sizeof(CXToken) * CXTokens.size()));
Guy Benyei11169dd2012-12-18 14:30:41 +00006767 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
6768 *NumTokens = CXTokens.size();
6769}
6770
6771void clang_disposeTokens(CXTranslationUnit TU,
6772 CXToken *Tokens, unsigned NumTokens) {
6773 free(Tokens);
6774}
6775
Guy Benyei11169dd2012-12-18 14:30:41 +00006776//===----------------------------------------------------------------------===//
6777// Token annotation APIs.
6778//===----------------------------------------------------------------------===//
6779
Guy Benyei11169dd2012-12-18 14:30:41 +00006780static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6781 CXCursor parent,
6782 CXClientData client_data);
6783static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6784 CXClientData client_data);
6785
6786namespace {
6787class AnnotateTokensWorker {
Guy Benyei11169dd2012-12-18 14:30:41 +00006788 CXToken *Tokens;
6789 CXCursor *Cursors;
6790 unsigned NumTokens;
6791 unsigned TokIdx;
6792 unsigned PreprocessingTokIdx;
6793 CursorVisitor AnnotateVis;
6794 SourceManager &SrcMgr;
6795 bool HasContextSensitiveKeywords;
6796
6797 struct PostChildrenInfo {
6798 CXCursor Cursor;
6799 SourceRange CursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006800 unsigned BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00006801 unsigned BeforeChildrenTokenIdx;
6802 };
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006803 SmallVector<PostChildrenInfo, 8> PostChildrenInfos;
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006804
6805 CXToken &getTok(unsigned Idx) {
6806 assert(Idx < NumTokens);
6807 return Tokens[Idx];
6808 }
6809 const CXToken &getTok(unsigned Idx) const {
6810 assert(Idx < NumTokens);
6811 return Tokens[Idx];
6812 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006813 bool MoreTokens() const { return TokIdx < NumTokens; }
6814 unsigned NextToken() const { return TokIdx; }
6815 void AdvanceToken() { ++TokIdx; }
6816 SourceLocation GetTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006817 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006818 }
6819 bool isFunctionMacroToken(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006820 return getTok(tokI).int_data[3] != 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00006821 }
6822 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00006823 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[3]);
Guy Benyei11169dd2012-12-18 14:30:41 +00006824 }
6825
6826 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006827 bool annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
Guy Benyei11169dd2012-12-18 14:30:41 +00006828 SourceRange);
6829
6830public:
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006831 AnnotateTokensWorker(CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006832 CXTranslationUnit TU, SourceRange RegionOfInterest)
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006833 : Tokens(tokens), Cursors(cursors),
Guy Benyei11169dd2012-12-18 14:30:41 +00006834 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006835 AnnotateVis(TU,
Guy Benyei11169dd2012-12-18 14:30:41 +00006836 AnnotateTokensVisitor, this,
6837 /*VisitPreprocessorLast=*/true,
6838 /*VisitIncludedEntities=*/false,
6839 RegionOfInterest,
6840 /*VisitDeclsOnly=*/false,
6841 AnnotateTokensPostChildrenVisitor),
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00006842 SrcMgr(cxtu::getASTUnit(TU)->getSourceManager()),
Guy Benyei11169dd2012-12-18 14:30:41 +00006843 HasContextSensitiveKeywords(false) { }
6844
6845 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
6846 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
6847 bool postVisitChildren(CXCursor cursor);
6848 void AnnotateTokens();
6849
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006850 /// Determine whether the annotator saw any cursors that have
Guy Benyei11169dd2012-12-18 14:30:41 +00006851 /// context-sensitive keywords.
6852 bool hasContextSensitiveKeywords() const {
6853 return HasContextSensitiveKeywords;
6854 }
6855
6856 ~AnnotateTokensWorker() {
6857 assert(PostChildrenInfos.empty());
6858 }
6859};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00006860}
Guy Benyei11169dd2012-12-18 14:30:41 +00006861
6862void AnnotateTokensWorker::AnnotateTokens() {
6863 // Walk the AST within the region of interest, annotating tokens
6864 // along the way.
6865 AnnotateVis.visitFileRegion();
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006866}
Guy Benyei11169dd2012-12-18 14:30:41 +00006867
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006868static inline void updateCursorAnnotation(CXCursor &Cursor,
6869 const CXCursor &updateC) {
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006870 if (clang_isInvalid(updateC.kind) || !clang_isInvalid(Cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00006871 return;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006872 Cursor = updateC;
Guy Benyei11169dd2012-12-18 14:30:41 +00006873}
6874
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006875/// It annotates and advances tokens with a cursor until the comparison
Guy Benyei11169dd2012-12-18 14:30:41 +00006876//// between the cursor location and the source range is the same as
6877/// \arg compResult.
6878///
6879/// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
6880/// Pass RangeOverlap to annotate tokens inside a range.
6881void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
6882 RangeComparisonResult compResult,
6883 SourceRange range) {
6884 while (MoreTokens()) {
6885 const unsigned I = NextToken();
6886 if (isFunctionMacroToken(I))
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006887 if (!annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range))
6888 return;
Guy Benyei11169dd2012-12-18 14:30:41 +00006889
6890 SourceLocation TokLoc = GetTokenLoc(I);
6891 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00006892 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00006893 AdvanceToken();
6894 continue;
6895 }
6896 break;
6897 }
6898}
6899
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006900/// Special annotation handling for macro argument tokens.
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006901/// \returns true if it advanced beyond all macro tokens, false otherwise.
6902bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
Guy Benyei11169dd2012-12-18 14:30:41 +00006903 CXCursor updateC,
6904 RangeComparisonResult compResult,
6905 SourceRange range) {
6906 assert(MoreTokens());
6907 assert(isFunctionMacroToken(NextToken()) &&
6908 "Should be called only for macro arg tokens");
6909
6910 // This works differently than annotateAndAdvanceTokens; because expanded
6911 // macro arguments can have arbitrary translation-unit source order, we do not
6912 // advance the token index one by one until a token fails the range test.
6913 // We only advance once past all of the macro arg tokens if all of them
6914 // pass the range test. If one of them fails we keep the token index pointing
6915 // at the start of the macro arg tokens so that the failing token will be
6916 // annotated by a subsequent annotation try.
6917
6918 bool atLeastOneCompFail = false;
6919
6920 unsigned I = NextToken();
6921 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
6922 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
6923 if (TokLoc.isFileID())
6924 continue; // not macro arg token, it's parens or comma.
6925 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6926 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
6927 Cursors[I] = updateC;
6928 } else
6929 atLeastOneCompFail = true;
6930 }
6931
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00006932 if (atLeastOneCompFail)
6933 return false;
6934
6935 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
6936 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00006937}
6938
6939enum CXChildVisitResult
6940AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006941 SourceRange cursorRange = getRawCursorExtent(cursor);
6942 if (cursorRange.isInvalid())
6943 return CXChildVisit_Recurse;
6944
6945 if (!HasContextSensitiveKeywords) {
6946 // Objective-C properties can have context-sensitive keywords.
6947 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006948 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00006949 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
6950 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
6951 }
6952 // Objective-C methods can have context-sensitive keywords.
6953 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
6954 cursor.kind == CXCursor_ObjCClassMethodDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006955 if (const ObjCMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006956 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
6957 if (Method->getObjCDeclQualifier())
6958 HasContextSensitiveKeywords = true;
6959 else {
David Majnemer59f77922016-06-24 04:05:48 +00006960 for (const auto *P : Method->parameters()) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00006961 if (P->getObjCDeclQualifier()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006962 HasContextSensitiveKeywords = true;
6963 break;
6964 }
6965 }
6966 }
6967 }
6968 }
6969 // C++ methods can have context-sensitive keywords.
6970 else if (cursor.kind == CXCursor_CXXMethod) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006971 if (const CXXMethodDecl *Method
Guy Benyei11169dd2012-12-18 14:30:41 +00006972 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
6973 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
6974 HasContextSensitiveKeywords = true;
6975 }
6976 }
6977 // C++ classes can have context-sensitive keywords.
6978 else if (cursor.kind == CXCursor_StructDecl ||
6979 cursor.kind == CXCursor_ClassDecl ||
6980 cursor.kind == CXCursor_ClassTemplate ||
6981 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00006982 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00006983 if (D->hasAttr<FinalAttr>())
6984 HasContextSensitiveKeywords = true;
6985 }
6986 }
Argyrios Kyrtzidis990b3862013-06-04 18:24:30 +00006987
6988 // Don't override a property annotation with its getter/setter method.
6989 if (cursor.kind == CXCursor_ObjCInstanceMethodDecl &&
6990 parent.kind == CXCursor_ObjCPropertyDecl)
6991 return CXChildVisit_Continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00006992
6993 if (clang_isPreprocessing(cursor.kind)) {
6994 // Items in the preprocessing record are kept separate from items in
6995 // declarations, so we keep a separate token index.
6996 unsigned SavedTokIdx = TokIdx;
6997 TokIdx = PreprocessingTokIdx;
6998
6999 // Skip tokens up until we catch up to the beginning of the preprocessing
7000 // entry.
7001 while (MoreTokens()) {
7002 const unsigned I = NextToken();
7003 SourceLocation TokLoc = GetTokenLoc(I);
7004 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
7005 case RangeBefore:
7006 AdvanceToken();
7007 continue;
7008 case RangeAfter:
7009 case RangeOverlap:
7010 break;
7011 }
7012 break;
7013 }
7014
7015 // Look at all of the tokens within this range.
7016 while (MoreTokens()) {
7017 const unsigned I = NextToken();
7018 SourceLocation TokLoc = GetTokenLoc(I);
7019 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
7020 case RangeBefore:
7021 llvm_unreachable("Infeasible");
7022 case RangeAfter:
7023 break;
7024 case RangeOverlap:
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00007025 // For macro expansions, just note where the beginning of the macro
7026 // expansion occurs.
7027 if (cursor.kind == CXCursor_MacroExpansion) {
7028 if (TokLoc == cursorRange.getBegin())
7029 Cursors[I] = cursor;
7030 AdvanceToken();
7031 break;
7032 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007033 // We may have already annotated macro names inside macro definitions.
7034 if (Cursors[I].kind != CXCursor_MacroExpansion)
7035 Cursors[I] = cursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00007036 AdvanceToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00007037 continue;
7038 }
7039 break;
7040 }
7041
7042 // Save the preprocessing token index; restore the non-preprocessing
7043 // token index.
7044 PreprocessingTokIdx = TokIdx;
7045 TokIdx = SavedTokIdx;
7046 return CXChildVisit_Recurse;
7047 }
7048
7049 if (cursorRange.isInvalid())
7050 return CXChildVisit_Continue;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00007051
7052 unsigned BeforeReachingCursorIdx = NextToken();
Guy Benyei11169dd2012-12-18 14:30:41 +00007053 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007054 const enum CXCursorKind K = clang_getCursorKind(parent);
7055 const CXCursor updateC =
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00007056 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
7057 // Attributes are annotated out-of-order, skip tokens until we reach it.
7058 clang_isAttribute(cursor.kind))
Guy Benyei11169dd2012-12-18 14:30:41 +00007059 ? clang_getNullCursor() : parent;
7060
7061 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
7062
7063 // Avoid having the cursor of an expression "overwrite" the annotation of the
7064 // variable declaration that it belongs to.
7065 // This can happen for C++ constructor expressions whose range generally
7066 // include the variable declaration, e.g.:
7067 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00007068 if (clang_isExpression(cursorK) && MoreTokens()) {
Dmitri Gribenkoe8354062013-01-26 15:29:08 +00007069 const Expr *E = getCursorExpr(cursor);
Dmitri Gribenkoa1691182013-01-26 18:12:08 +00007070 if (const Decl *D = getCursorParentDecl(cursor)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007071 const unsigned I = NextToken();
7072 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
7073 E->getLocStart() == D->getLocation() &&
7074 E->getLocStart() == GetTokenLoc(I)) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007075 updateCursorAnnotation(Cursors[I], updateC);
Guy Benyei11169dd2012-12-18 14:30:41 +00007076 AdvanceToken();
7077 }
7078 }
7079 }
7080
7081 // Before recursing into the children keep some state that we are going
7082 // to use in the AnnotateTokensWorker::postVisitChildren callback to do some
7083 // extra work after the child nodes are visited.
7084 // Note that we don't call VisitChildren here to avoid traversing statements
7085 // code-recursively which can blow the stack.
7086
7087 PostChildrenInfo Info;
7088 Info.Cursor = cursor;
7089 Info.CursorRange = cursorRange;
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00007090 Info.BeforeReachingCursorIdx = BeforeReachingCursorIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00007091 Info.BeforeChildrenTokenIdx = NextToken();
7092 PostChildrenInfos.push_back(Info);
7093
7094 return CXChildVisit_Recurse;
7095}
7096
7097bool AnnotateTokensWorker::postVisitChildren(CXCursor cursor) {
7098 if (PostChildrenInfos.empty())
7099 return false;
7100 const PostChildrenInfo &Info = PostChildrenInfos.back();
7101 if (!clang_equalCursors(Info.Cursor, cursor))
7102 return false;
7103
7104 const unsigned BeforeChildren = Info.BeforeChildrenTokenIdx;
7105 const unsigned AfterChildren = NextToken();
7106 SourceRange cursorRange = Info.CursorRange;
7107
7108 // Scan the tokens that are at the end of the cursor, but are not captured
7109 // but the child cursors.
7110 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
7111
7112 // Scan the tokens that are at the beginning of the cursor, but are not
7113 // capture by the child cursors.
7114 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
7115 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
7116 break;
7117
7118 Cursors[I] = cursor;
7119 }
7120
Argyrios Kyrtzidisa2ed8132013-02-08 01:12:25 +00007121 // Attributes are annotated out-of-order, rewind TokIdx to when we first
7122 // encountered the attribute cursor.
7123 if (clang_isAttribute(cursor.kind))
7124 TokIdx = Info.BeforeReachingCursorIdx;
7125
Guy Benyei11169dd2012-12-18 14:30:41 +00007126 PostChildrenInfos.pop_back();
7127 return false;
7128}
7129
7130static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
7131 CXCursor parent,
7132 CXClientData client_data) {
7133 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
7134}
7135
7136static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
7137 CXClientData client_data) {
7138 return static_cast<AnnotateTokensWorker*>(client_data)->
7139 postVisitChildren(cursor);
7140}
7141
7142namespace {
7143
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00007144/// Uses the macro expansions in the preprocessing record to find
Guy Benyei11169dd2012-12-18 14:30:41 +00007145/// and mark tokens that are macro arguments. This info is used by the
7146/// AnnotateTokensWorker.
7147class MarkMacroArgTokensVisitor {
7148 SourceManager &SM;
7149 CXToken *Tokens;
7150 unsigned NumTokens;
7151 unsigned CurIdx;
7152
7153public:
7154 MarkMacroArgTokensVisitor(SourceManager &SM,
7155 CXToken *tokens, unsigned numTokens)
7156 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
7157
7158 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
7159 if (cursor.kind != CXCursor_MacroExpansion)
7160 return CXChildVisit_Continue;
7161
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00007162 SourceRange macroRange = getCursorMacroExpansion(cursor).getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00007163 if (macroRange.getBegin() == macroRange.getEnd())
7164 return CXChildVisit_Continue; // it's not a function macro.
7165
7166 for (; CurIdx < NumTokens; ++CurIdx) {
7167 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
7168 macroRange.getBegin()))
7169 break;
7170 }
7171
7172 if (CurIdx == NumTokens)
7173 return CXChildVisit_Break;
7174
7175 for (; CurIdx < NumTokens; ++CurIdx) {
7176 SourceLocation tokLoc = getTokenLoc(CurIdx);
7177 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
7178 break;
7179
7180 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
7181 }
7182
7183 if (CurIdx == NumTokens)
7184 return CXChildVisit_Break;
7185
7186 return CXChildVisit_Continue;
7187 }
7188
7189private:
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00007190 CXToken &getTok(unsigned Idx) {
7191 assert(Idx < NumTokens);
7192 return Tokens[Idx];
7193 }
7194 const CXToken &getTok(unsigned Idx) const {
7195 assert(Idx < NumTokens);
7196 return Tokens[Idx];
7197 }
7198
Guy Benyei11169dd2012-12-18 14:30:41 +00007199 SourceLocation getTokenLoc(unsigned tokI) {
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00007200 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
Guy Benyei11169dd2012-12-18 14:30:41 +00007201 }
7202
7203 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
7204 // The third field is reserved and currently not used. Use it here
7205 // to mark macro arg expanded tokens with their expanded locations.
Argyrios Kyrtzidis50126f12013-11-27 05:50:55 +00007206 getTok(tokI).int_data[3] = loc.getRawEncoding();
Guy Benyei11169dd2012-12-18 14:30:41 +00007207 }
7208};
7209
7210} // end anonymous namespace
7211
7212static CXChildVisitResult
7213MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
7214 CXClientData client_data) {
7215 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
7216 parent);
7217}
7218
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00007219/// Used by \c annotatePreprocessorTokens.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007220/// \returns true if lexing was finished, false otherwise.
7221static bool lexNext(Lexer &Lex, Token &Tok,
7222 unsigned &NextIdx, unsigned NumTokens) {
7223 if (NextIdx >= NumTokens)
7224 return true;
7225
7226 ++NextIdx;
7227 Lex.LexFromRawLexer(Tok);
Alexander Kornienko1a9f1842015-12-28 15:24:08 +00007228 return Tok.is(tok::eof);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007229}
7230
Guy Benyei11169dd2012-12-18 14:30:41 +00007231static void annotatePreprocessorTokens(CXTranslationUnit TU,
7232 SourceRange RegionOfInterest,
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007233 CXCursor *Cursors,
7234 CXToken *Tokens,
7235 unsigned NumTokens) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007236 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00007237
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007238 Preprocessor &PP = CXXUnit->getPreprocessor();
Guy Benyei11169dd2012-12-18 14:30:41 +00007239 SourceManager &SourceMgr = CXXUnit->getSourceManager();
7240 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00007241 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00007242 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00007243 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getEnd());
Guy Benyei11169dd2012-12-18 14:30:41 +00007244
7245 if (BeginLocInfo.first != EndLocInfo.first)
7246 return;
7247
7248 StringRef Buffer;
7249 bool Invalid = false;
7250 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
7251 if (Buffer.empty() || Invalid)
7252 return;
7253
7254 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
7255 CXXUnit->getASTContext().getLangOpts(),
7256 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
7257 Buffer.end());
7258 Lex.SetCommentRetentionState(true);
7259
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007260 unsigned NextIdx = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +00007261 // Lex tokens in raw mode until we hit the end of the range, to avoid
7262 // entering #includes or expanding macros.
7263 while (true) {
7264 Token Tok;
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007265 if (lexNext(Lex, Tok, NextIdx, NumTokens))
7266 break;
7267 unsigned TokIdx = NextIdx-1;
7268 assert(Tok.getLocation() ==
7269 SourceLocation::getFromRawEncoding(Tokens[TokIdx].int_data[1]));
Guy Benyei11169dd2012-12-18 14:30:41 +00007270
7271 reprocess:
7272 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007273 // We have found a preprocessing directive. Annotate the tokens
7274 // appropriately.
Guy Benyei11169dd2012-12-18 14:30:41 +00007275 //
7276 // FIXME: Some simple tests here could identify macro definitions and
7277 // #undefs, to provide specific cursor kinds for those.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007278
7279 SourceLocation BeginLoc = Tok.getLocation();
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007280 if (lexNext(Lex, Tok, NextIdx, NumTokens))
7281 break;
7282
Craig Topper69186e72014-06-08 08:38:04 +00007283 MacroInfo *MI = nullptr;
Alp Toker2d57cea2014-05-17 04:53:25 +00007284 if (Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "define") {
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007285 if (lexNext(Lex, Tok, NextIdx, NumTokens))
7286 break;
7287
7288 if (Tok.is(tok::raw_identifier)) {
Alp Toker2d57cea2014-05-17 04:53:25 +00007289 IdentifierInfo &II =
7290 PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007291 SourceLocation MappedTokLoc =
7292 CXXUnit->mapLocationToPreamble(Tok.getLocation());
7293 MI = getMacroInfo(II, MappedTokLoc, TU);
7294 }
7295 }
7296
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007297 bool finished = false;
Guy Benyei11169dd2012-12-18 14:30:41 +00007298 do {
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007299 if (lexNext(Lex, Tok, NextIdx, NumTokens)) {
7300 finished = true;
7301 break;
7302 }
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007303 // If we are in a macro definition, check if the token was ever a
7304 // macro name and annotate it if that's the case.
7305 if (MI) {
7306 SourceLocation SaveLoc = Tok.getLocation();
7307 Tok.setLocation(CXXUnit->mapLocationToPreamble(SaveLoc));
Richard Smith66a81862015-05-04 02:25:31 +00007308 MacroDefinitionRecord *MacroDef =
7309 checkForMacroInMacroDefinition(MI, Tok, TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007310 Tok.setLocation(SaveLoc);
7311 if (MacroDef)
Richard Smith66a81862015-05-04 02:25:31 +00007312 Cursors[NextIdx - 1] =
7313 MakeMacroExpansionCursor(MacroDef, Tok.getLocation(), TU);
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007314 }
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007315 } while (!Tok.isAtStartOfLine());
7316
7317 unsigned LastIdx = finished ? NextIdx-1 : NextIdx-2;
7318 assert(TokIdx <= LastIdx);
7319 SourceLocation EndLoc =
7320 SourceLocation::getFromRawEncoding(Tokens[LastIdx].int_data[1]);
7321 CXCursor Cursor =
7322 MakePreprocessingDirectiveCursor(SourceRange(BeginLoc, EndLoc), TU);
7323
7324 for (; TokIdx <= LastIdx; ++TokIdx)
Argyrios Kyrtzidis68d31ce2013-01-07 19:16:32 +00007325 updateCursorAnnotation(Cursors[TokIdx], Cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007326
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007327 if (finished)
7328 break;
7329 goto reprocess;
Guy Benyei11169dd2012-12-18 14:30:41 +00007330 }
Guy Benyei11169dd2012-12-18 14:30:41 +00007331 }
7332}
7333
7334// This gets run a separate thread to avoid stack blowout.
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007335static void clang_annotateTokensImpl(CXTranslationUnit TU, ASTUnit *CXXUnit,
7336 CXToken *Tokens, unsigned NumTokens,
7337 CXCursor *Cursors) {
Dmitri Gribenko183436e2013-01-26 21:49:50 +00007338 CIndexer *CXXIdx = TU->CIdx;
Guy Benyei11169dd2012-12-18 14:30:41 +00007339 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
7340 setThreadBackgroundPriority();
7341
7342 // Determine the region of interest, which contains all of the tokens.
7343 SourceRange RegionOfInterest;
7344 RegionOfInterest.setBegin(
7345 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
7346 RegionOfInterest.setEnd(
7347 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
7348 Tokens[NumTokens-1])));
7349
Guy Benyei11169dd2012-12-18 14:30:41 +00007350 // Relex the tokens within the source range to look for preprocessing
7351 // directives.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007352 annotatePreprocessorTokens(TU, RegionOfInterest, Cursors, Tokens, NumTokens);
Argyrios Kyrtzidis5d47a9b2013-02-13 18:33:28 +00007353
7354 // If begin location points inside a macro argument, set it to the expansion
7355 // location so we can have the full context when annotating semantically.
7356 {
7357 SourceManager &SM = CXXUnit->getSourceManager();
7358 SourceLocation Loc =
7359 SM.getMacroArgExpandedLocation(RegionOfInterest.getBegin());
7360 if (Loc.isMacroID())
7361 RegionOfInterest.setBegin(SM.getExpansionLoc(Loc));
7362 }
7363
Guy Benyei11169dd2012-12-18 14:30:41 +00007364 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
7365 // Search and mark tokens that are macro argument expansions.
7366 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
7367 Tokens, NumTokens);
7368 CursorVisitor MacroArgMarker(TU,
7369 MarkMacroArgTokensVisitorDelegate, &Visitor,
7370 /*VisitPreprocessorLast=*/true,
7371 /*VisitIncludedEntities=*/false,
7372 RegionOfInterest);
7373 MacroArgMarker.visitPreprocessedEntitiesInRegion();
7374 }
7375
7376 // Annotate all of the source locations in the region of interest that map to
7377 // a specific cursor.
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00007378 AnnotateTokensWorker W(Tokens, Cursors, NumTokens, TU, RegionOfInterest);
Guy Benyei11169dd2012-12-18 14:30:41 +00007379
7380 // FIXME: We use a ridiculous stack size here because the data-recursion
7381 // algorithm uses a large stack frame than the non-data recursive version,
7382 // and AnnotationTokensWorker currently transforms the data-recursion
7383 // algorithm back into a traditional recursion by explicitly calling
7384 // VisitChildren(). We will need to remove this explicit recursive call.
7385 W.AnnotateTokens();
7386
7387 // If we ran into any entities that involve context-sensitive keywords,
7388 // take another pass through the tokens to mark them as such.
7389 if (W.hasContextSensitiveKeywords()) {
7390 for (unsigned I = 0; I != NumTokens; ++I) {
7391 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
7392 continue;
7393
7394 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
7395 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007396 if (const ObjCPropertyDecl *Property
Guy Benyei11169dd2012-12-18 14:30:41 +00007397 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
7398 if (Property->getPropertyAttributesAsWritten() != 0 &&
7399 llvm::StringSwitch<bool>(II->getName())
7400 .Case("readonly", true)
7401 .Case("assign", true)
7402 .Case("unsafe_unretained", true)
7403 .Case("readwrite", true)
7404 .Case("retain", true)
7405 .Case("copy", true)
7406 .Case("nonatomic", true)
7407 .Case("atomic", true)
7408 .Case("getter", true)
7409 .Case("setter", true)
7410 .Case("strong", true)
7411 .Case("weak", true)
Manman Ren04fd4d82016-05-31 23:22:04 +00007412 .Case("class", true)
Guy Benyei11169dd2012-12-18 14:30:41 +00007413 .Default(false))
7414 Tokens[I].int_data[0] = CXToken_Keyword;
7415 }
7416 continue;
7417 }
7418
7419 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
7420 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
7421 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
7422 if (llvm::StringSwitch<bool>(II->getName())
7423 .Case("in", true)
7424 .Case("out", true)
7425 .Case("inout", true)
7426 .Case("oneway", true)
7427 .Case("bycopy", true)
7428 .Case("byref", true)
7429 .Default(false))
7430 Tokens[I].int_data[0] = CXToken_Keyword;
7431 continue;
7432 }
7433
7434 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
7435 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
7436 Tokens[I].int_data[0] = CXToken_Keyword;
7437 continue;
7438 }
7439 }
7440 }
7441}
7442
Guy Benyei11169dd2012-12-18 14:30:41 +00007443void clang_annotateTokens(CXTranslationUnit TU,
7444 CXToken *Tokens, unsigned NumTokens,
7445 CXCursor *Cursors) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00007446 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00007447 LOG_BAD_TU(TU);
7448 return;
7449 }
7450 if (NumTokens == 0 || !Tokens || !Cursors) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007451 LOG_FUNC_SECTION { *Log << "<null input>"; }
Guy Benyei11169dd2012-12-18 14:30:41 +00007452 return;
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00007453 }
7454
7455 LOG_FUNC_SECTION {
7456 *Log << TU << ' ';
7457 CXSourceLocation bloc = clang_getTokenLocation(TU, Tokens[0]);
7458 CXSourceLocation eloc = clang_getTokenLocation(TU, Tokens[NumTokens-1]);
7459 *Log << clang_getRange(bloc, eloc);
7460 }
Guy Benyei11169dd2012-12-18 14:30:41 +00007461
7462 // Any token we don't specifically annotate will have a NULL cursor.
7463 CXCursor C = clang_getNullCursor();
7464 for (unsigned I = 0; I != NumTokens; ++I)
7465 Cursors[I] = C;
7466
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00007467 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
Guy Benyei11169dd2012-12-18 14:30:41 +00007468 if (!CXXUnit)
7469 return;
7470
7471 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007472
7473 auto AnnotateTokensImpl = [=]() {
7474 clang_annotateTokensImpl(TU, CXXUnit, Tokens, NumTokens, Cursors);
7475 };
Guy Benyei11169dd2012-12-18 14:30:41 +00007476 llvm::CrashRecoveryContext CRC;
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00007477 if (!RunSafely(CRC, AnnotateTokensImpl, GetSafetyThreadStackSize() * 2)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007478 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
7479 }
7480}
7481
Guy Benyei11169dd2012-12-18 14:30:41 +00007482//===----------------------------------------------------------------------===//
7483// Operations for querying linkage of a cursor.
7484//===----------------------------------------------------------------------===//
7485
Guy Benyei11169dd2012-12-18 14:30:41 +00007486CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
7487 if (!clang_isDeclaration(cursor.kind))
7488 return CXLinkage_Invalid;
7489
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007490 const Decl *D = cxcursor::getCursorDecl(cursor);
7491 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
Rafael Espindola3ae00052013-05-13 00:12:11 +00007492 switch (ND->getLinkageInternal()) {
Rafael Espindola50df3a02013-05-25 17:16:20 +00007493 case NoLinkage:
7494 case VisibleNoLinkage: return CXLinkage_NoLinkage;
Richard Smithaf10ea22017-07-08 00:37:59 +00007495 case ModuleInternalLinkage:
Guy Benyei11169dd2012-12-18 14:30:41 +00007496 case InternalLinkage: return CXLinkage_Internal;
7497 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
Richard Smithaf10ea22017-07-08 00:37:59 +00007498 case ModuleLinkage:
Guy Benyei11169dd2012-12-18 14:30:41 +00007499 case ExternalLinkage: return CXLinkage_External;
7500 };
7501
7502 return CXLinkage_Invalid;
7503}
Guy Benyei11169dd2012-12-18 14:30:41 +00007504
7505//===----------------------------------------------------------------------===//
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007506// Operations for querying visibility of a cursor.
7507//===----------------------------------------------------------------------===//
7508
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007509CXVisibilityKind clang_getCursorVisibility(CXCursor cursor) {
7510 if (!clang_isDeclaration(cursor.kind))
7511 return CXVisibility_Invalid;
7512
7513 const Decl *D = cxcursor::getCursorDecl(cursor);
7514 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
7515 switch (ND->getVisibility()) {
7516 case HiddenVisibility: return CXVisibility_Hidden;
7517 case ProtectedVisibility: return CXVisibility_Protected;
7518 case DefaultVisibility: return CXVisibility_Default;
7519 };
7520
7521 return CXVisibility_Invalid;
7522}
Ehsan Akhgarib743de72016-05-31 15:55:51 +00007523
7524//===----------------------------------------------------------------------===//
Guy Benyei11169dd2012-12-18 14:30:41 +00007525// Operations for querying language of a cursor.
7526//===----------------------------------------------------------------------===//
7527
7528static CXLanguageKind getDeclLanguage(const Decl *D) {
7529 if (!D)
7530 return CXLanguage_C;
7531
7532 switch (D->getKind()) {
7533 default:
7534 break;
7535 case Decl::ImplicitParam:
7536 case Decl::ObjCAtDefsField:
7537 case Decl::ObjCCategory:
7538 case Decl::ObjCCategoryImpl:
7539 case Decl::ObjCCompatibleAlias:
7540 case Decl::ObjCImplementation:
7541 case Decl::ObjCInterface:
7542 case Decl::ObjCIvar:
7543 case Decl::ObjCMethod:
7544 case Decl::ObjCProperty:
7545 case Decl::ObjCPropertyImpl:
7546 case Decl::ObjCProtocol:
Douglas Gregor85f3f952015-07-07 03:57:15 +00007547 case Decl::ObjCTypeParam:
Guy Benyei11169dd2012-12-18 14:30:41 +00007548 return CXLanguage_ObjC;
7549 case Decl::CXXConstructor:
7550 case Decl::CXXConversion:
7551 case Decl::CXXDestructor:
7552 case Decl::CXXMethod:
7553 case Decl::CXXRecord:
7554 case Decl::ClassTemplate:
7555 case Decl::ClassTemplatePartialSpecialization:
7556 case Decl::ClassTemplateSpecialization:
7557 case Decl::Friend:
7558 case Decl::FriendTemplate:
7559 case Decl::FunctionTemplate:
7560 case Decl::LinkageSpec:
7561 case Decl::Namespace:
7562 case Decl::NamespaceAlias:
7563 case Decl::NonTypeTemplateParm:
7564 case Decl::StaticAssert:
7565 case Decl::TemplateTemplateParm:
7566 case Decl::TemplateTypeParm:
7567 case Decl::UnresolvedUsingTypename:
7568 case Decl::UnresolvedUsingValue:
7569 case Decl::Using:
7570 case Decl::UsingDirective:
7571 case Decl::UsingShadow:
7572 return CXLanguage_CPlusPlus;
7573 }
7574
7575 return CXLanguage_C;
7576}
7577
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007578static CXAvailabilityKind getCursorAvailabilityForDecl(const Decl *D) {
7579 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
Manuel Klimek8e3a7ed2015-09-25 17:53:16 +00007580 return CXAvailability_NotAvailable;
Guy Benyei11169dd2012-12-18 14:30:41 +00007581
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007582 switch (D->getAvailability()) {
7583 case AR_Available:
7584 case AR_NotYetIntroduced:
7585 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
Benjamin Kramer656363d2013-10-15 18:53:18 +00007586 return getCursorAvailabilityForDecl(
7587 cast<Decl>(EnumConst->getDeclContext()));
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007588 return CXAvailability_Available;
7589
7590 case AR_Deprecated:
7591 return CXAvailability_Deprecated;
7592
7593 case AR_Unavailable:
7594 return CXAvailability_NotAvailable;
7595 }
Benjamin Kramer656363d2013-10-15 18:53:18 +00007596
7597 llvm_unreachable("Unknown availability kind!");
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007598}
7599
Guy Benyei11169dd2012-12-18 14:30:41 +00007600enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
7601 if (clang_isDeclaration(cursor.kind))
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007602 if (const Decl *D = cxcursor::getCursorDecl(cursor))
7603 return getCursorAvailabilityForDecl(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00007604
7605 return CXAvailability_Available;
7606}
7607
7608static CXVersion convertVersion(VersionTuple In) {
7609 CXVersion Out = { -1, -1, -1 };
7610 if (In.empty())
7611 return Out;
7612
7613 Out.Major = In.getMajor();
7614
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00007615 Optional<unsigned> Minor = In.getMinor();
7616 if (Minor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00007617 Out.Minor = *Minor;
7618 else
7619 return Out;
7620
NAKAMURA Takumic2b5d1f2013-02-21 02:32:34 +00007621 Optional<unsigned> Subminor = In.getSubminor();
7622 if (Subminor.hasValue())
Guy Benyei11169dd2012-12-18 14:30:41 +00007623 Out.Subminor = *Subminor;
7624
7625 return Out;
7626}
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007627
Alex Lorenz1345ea22017-06-12 19:06:30 +00007628static void getCursorPlatformAvailabilityForDecl(
7629 const Decl *D, int *always_deprecated, CXString *deprecated_message,
7630 int *always_unavailable, CXString *unavailable_message,
7631 SmallVectorImpl<AvailabilityAttr *> &AvailabilityAttrs) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007632 bool HadAvailAttr = false;
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007633 for (auto A : D->attrs()) {
7634 if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007635 HadAvailAttr = true;
7636 if (always_deprecated)
7637 *always_deprecated = 1;
Nico Weberaacf0312014-04-24 05:16:45 +00007638 if (deprecated_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007639 clang_disposeString(*deprecated_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007640 *deprecated_message = cxstring::createDup(Deprecated->getMessage());
Nico Weberaacf0312014-04-24 05:16:45 +00007641 }
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007642 continue;
7643 }
Alex Lorenz1345ea22017-06-12 19:06:30 +00007644
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007645 if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(A)) {
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007646 HadAvailAttr = true;
7647 if (always_unavailable)
7648 *always_unavailable = 1;
7649 if (unavailable_message) {
Argyrios Kyrtzidisedfe07f2014-04-24 06:05:40 +00007650 clang_disposeString(*unavailable_message);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007651 *unavailable_message = cxstring::createDup(Unavailable->getMessage());
7652 }
7653 continue;
7654 }
Alex Lorenz1345ea22017-06-12 19:06:30 +00007655
Aaron Ballmanb97112e2014-03-08 22:19:01 +00007656 if (AvailabilityAttr *Avail = dyn_cast<AvailabilityAttr>(A)) {
Alex Lorenz1345ea22017-06-12 19:06:30 +00007657 AvailabilityAttrs.push_back(Avail);
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007658 HadAvailAttr = true;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007659 }
7660 }
7661
7662 if (!HadAvailAttr)
7663 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
7664 return getCursorPlatformAvailabilityForDecl(
Alex Lorenz1345ea22017-06-12 19:06:30 +00007665 cast<Decl>(EnumConst->getDeclContext()), always_deprecated,
7666 deprecated_message, always_unavailable, unavailable_message,
7667 AvailabilityAttrs);
7668
7669 if (AvailabilityAttrs.empty())
7670 return;
7671
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00007672 llvm::sort(AvailabilityAttrs.begin(), AvailabilityAttrs.end(),
7673 [](AvailabilityAttr *LHS, AvailabilityAttr *RHS) {
7674 return LHS->getPlatform()->getName() <
7675 RHS->getPlatform()->getName();
Alex Lorenz1345ea22017-06-12 19:06:30 +00007676 });
7677 ASTContext &Ctx = D->getASTContext();
7678 auto It = std::unique(
7679 AvailabilityAttrs.begin(), AvailabilityAttrs.end(),
7680 [&Ctx](AvailabilityAttr *LHS, AvailabilityAttr *RHS) {
7681 if (LHS->getPlatform() != RHS->getPlatform())
7682 return false;
7683
7684 if (LHS->getIntroduced() == RHS->getIntroduced() &&
7685 LHS->getDeprecated() == RHS->getDeprecated() &&
7686 LHS->getObsoleted() == RHS->getObsoleted() &&
7687 LHS->getMessage() == RHS->getMessage() &&
7688 LHS->getReplacement() == RHS->getReplacement())
7689 return true;
7690
7691 if ((!LHS->getIntroduced().empty() && !RHS->getIntroduced().empty()) ||
7692 (!LHS->getDeprecated().empty() && !RHS->getDeprecated().empty()) ||
7693 (!LHS->getObsoleted().empty() && !RHS->getObsoleted().empty()))
7694 return false;
7695
7696 if (LHS->getIntroduced().empty() && !RHS->getIntroduced().empty())
7697 LHS->setIntroduced(Ctx, RHS->getIntroduced());
7698
7699 if (LHS->getDeprecated().empty() && !RHS->getDeprecated().empty()) {
7700 LHS->setDeprecated(Ctx, RHS->getDeprecated());
7701 if (LHS->getMessage().empty())
7702 LHS->setMessage(Ctx, RHS->getMessage());
7703 if (LHS->getReplacement().empty())
7704 LHS->setReplacement(Ctx, RHS->getReplacement());
7705 }
7706
7707 if (LHS->getObsoleted().empty() && !RHS->getObsoleted().empty()) {
7708 LHS->setObsoleted(Ctx, RHS->getObsoleted());
7709 if (LHS->getMessage().empty())
7710 LHS->setMessage(Ctx, RHS->getMessage());
7711 if (LHS->getReplacement().empty())
7712 LHS->setReplacement(Ctx, RHS->getReplacement());
7713 }
7714
7715 return true;
7716 });
7717 AvailabilityAttrs.erase(It, AvailabilityAttrs.end());
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007718}
7719
Alex Lorenz1345ea22017-06-12 19:06:30 +00007720int clang_getCursorPlatformAvailability(CXCursor cursor, int *always_deprecated,
Guy Benyei11169dd2012-12-18 14:30:41 +00007721 CXString *deprecated_message,
7722 int *always_unavailable,
7723 CXString *unavailable_message,
7724 CXPlatformAvailability *availability,
7725 int availability_size) {
7726 if (always_deprecated)
7727 *always_deprecated = 0;
7728 if (deprecated_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007729 *deprecated_message = cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00007730 if (always_unavailable)
7731 *always_unavailable = 0;
7732 if (unavailable_message)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00007733 *unavailable_message = cxstring::createEmpty();
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007734
Guy Benyei11169dd2012-12-18 14:30:41 +00007735 if (!clang_isDeclaration(cursor.kind))
7736 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007737
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007738 const Decl *D = cxcursor::getCursorDecl(cursor);
Guy Benyei11169dd2012-12-18 14:30:41 +00007739 if (!D)
7740 return 0;
Argyrios Kyrtzidisdc2973f2013-10-15 17:00:53 +00007741
Alex Lorenz1345ea22017-06-12 19:06:30 +00007742 SmallVector<AvailabilityAttr *, 8> AvailabilityAttrs;
7743 getCursorPlatformAvailabilityForDecl(D, always_deprecated, deprecated_message,
7744 always_unavailable, unavailable_message,
7745 AvailabilityAttrs);
7746 for (const auto &Avail :
7747 llvm::enumerate(llvm::makeArrayRef(AvailabilityAttrs)
7748 .take_front(availability_size))) {
7749 availability[Avail.index()].Platform =
7750 cxstring::createDup(Avail.value()->getPlatform()->getName());
7751 availability[Avail.index()].Introduced =
7752 convertVersion(Avail.value()->getIntroduced());
7753 availability[Avail.index()].Deprecated =
7754 convertVersion(Avail.value()->getDeprecated());
7755 availability[Avail.index()].Obsoleted =
7756 convertVersion(Avail.value()->getObsoleted());
7757 availability[Avail.index()].Unavailable = Avail.value()->getUnavailable();
7758 availability[Avail.index()].Message =
7759 cxstring::createDup(Avail.value()->getMessage());
7760 }
7761
7762 return AvailabilityAttrs.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00007763}
Alex Lorenz1345ea22017-06-12 19:06:30 +00007764
Guy Benyei11169dd2012-12-18 14:30:41 +00007765void clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability) {
7766 clang_disposeString(availability->Platform);
7767 clang_disposeString(availability->Message);
7768}
7769
7770CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
7771 if (clang_isDeclaration(cursor.kind))
7772 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
7773
7774 return CXLanguage_Invalid;
7775}
7776
Saleem Abdulrasool50bc5652017-09-13 02:15:09 +00007777CXTLSKind clang_getCursorTLSKind(CXCursor cursor) {
7778 const Decl *D = cxcursor::getCursorDecl(cursor);
7779 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7780 switch (VD->getTLSKind()) {
7781 case VarDecl::TLS_None:
7782 return CXTLS_None;
7783 case VarDecl::TLS_Dynamic:
7784 return CXTLS_Dynamic;
7785 case VarDecl::TLS_Static:
7786 return CXTLS_Static;
7787 }
7788 }
7789
7790 return CXTLS_None;
7791}
7792
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00007793 /// If the given cursor is the "templated" declaration
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00007794 /// describing a class or function template, return the class or
Guy Benyei11169dd2012-12-18 14:30:41 +00007795 /// function template.
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007796static const Decl *maybeGetTemplateCursor(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007797 if (!D)
Craig Topper69186e72014-06-08 08:38:04 +00007798 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007799
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007800 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007801 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
7802 return FunTmpl;
7803
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007804 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +00007805 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
7806 return ClassTmpl;
7807
7808 return D;
7809}
7810
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007811
7812enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor C) {
7813 StorageClass sc = SC_None;
7814 const Decl *D = getCursorDecl(C);
7815 if (D) {
7816 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7817 sc = FD->getStorageClass();
7818 } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7819 sc = VD->getStorageClass();
7820 } else {
7821 return CX_SC_Invalid;
7822 }
7823 } else {
7824 return CX_SC_Invalid;
7825 }
7826 switch (sc) {
7827 case SC_None:
7828 return CX_SC_None;
7829 case SC_Extern:
7830 return CX_SC_Extern;
7831 case SC_Static:
7832 return CX_SC_Static;
7833 case SC_PrivateExtern:
7834 return CX_SC_PrivateExtern;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007835 case SC_Auto:
7836 return CX_SC_Auto;
7837 case SC_Register:
7838 return CX_SC_Register;
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007839 }
Kaelyn Takataab61e702014-10-15 18:03:26 +00007840 llvm_unreachable("Unhandled storage class!");
Argyrios Kyrtzidis4e0854f2014-10-15 17:05:31 +00007841}
7842
Guy Benyei11169dd2012-12-18 14:30:41 +00007843CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
7844 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007845 if (const Decl *D = getCursorDecl(cursor)) {
7846 const DeclContext *DC = D->getDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007847 if (!DC)
7848 return clang_getNullCursor();
7849
7850 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7851 getCursorTU(cursor));
7852 }
7853 }
7854
7855 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007856 if (const Decl *D = getCursorDecl(cursor))
Guy Benyei11169dd2012-12-18 14:30:41 +00007857 return MakeCXCursor(D, getCursorTU(cursor));
7858 }
7859
7860 return clang_getNullCursor();
7861}
7862
7863CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
7864 if (clang_isDeclaration(cursor.kind)) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00007865 if (const Decl *D = getCursorDecl(cursor)) {
7866 const DeclContext *DC = D->getLexicalDeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +00007867 if (!DC)
7868 return clang_getNullCursor();
7869
7870 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7871 getCursorTU(cursor));
7872 }
7873 }
7874
7875 // FIXME: Note that we can't easily compute the lexical context of a
7876 // statement or expression, so we return nothing.
7877 return clang_getNullCursor();
7878}
7879
7880CXFile clang_getIncludedFile(CXCursor cursor) {
7881 if (cursor.kind != CXCursor_InclusionDirective)
Craig Topper69186e72014-06-08 08:38:04 +00007882 return nullptr;
7883
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00007884 const InclusionDirective *ID = getCursorInclusionDirective(cursor);
Dmitri Gribenkof9304482013-01-23 15:56:07 +00007885 return const_cast<FileEntry *>(ID->getFile());
Guy Benyei11169dd2012-12-18 14:30:41 +00007886}
7887
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007888unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved) {
7889 if (C.kind != CXCursor_ObjCPropertyDecl)
7890 return CXObjCPropertyAttr_noattr;
7891
7892 unsigned Result = CXObjCPropertyAttr_noattr;
7893 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7894 ObjCPropertyDecl::PropertyAttributeKind Attr =
7895 PD->getPropertyAttributesAsWritten();
7896
7897#define SET_CXOBJCPROP_ATTR(A) \
7898 if (Attr & ObjCPropertyDecl::OBJC_PR_##A) \
7899 Result |= CXObjCPropertyAttr_##A
7900 SET_CXOBJCPROP_ATTR(readonly);
7901 SET_CXOBJCPROP_ATTR(getter);
7902 SET_CXOBJCPROP_ATTR(assign);
7903 SET_CXOBJCPROP_ATTR(readwrite);
7904 SET_CXOBJCPROP_ATTR(retain);
7905 SET_CXOBJCPROP_ATTR(copy);
7906 SET_CXOBJCPROP_ATTR(nonatomic);
7907 SET_CXOBJCPROP_ATTR(setter);
7908 SET_CXOBJCPROP_ATTR(atomic);
7909 SET_CXOBJCPROP_ATTR(weak);
7910 SET_CXOBJCPROP_ATTR(strong);
7911 SET_CXOBJCPROP_ATTR(unsafe_unretained);
Manman Ren04fd4d82016-05-31 23:22:04 +00007912 SET_CXOBJCPROP_ATTR(class);
Argyrios Kyrtzidis9adfd8a2013-04-18 22:15:49 +00007913#undef SET_CXOBJCPROP_ATTR
7914
7915 return Result;
7916}
7917
Michael Wu6e88f532018-08-03 05:38:29 +00007918CXString clang_Cursor_getObjCPropertyGetterName(CXCursor C) {
7919 if (C.kind != CXCursor_ObjCPropertyDecl)
7920 return cxstring::createNull();
7921
7922 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7923 Selector sel = PD->getGetterName();
7924 if (sel.isNull())
7925 return cxstring::createNull();
7926
7927 return cxstring::createDup(sel.getAsString());
7928}
7929
7930CXString clang_Cursor_getObjCPropertySetterName(CXCursor C) {
7931 if (C.kind != CXCursor_ObjCPropertyDecl)
7932 return cxstring::createNull();
7933
7934 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7935 Selector sel = PD->getSetterName();
7936 if (sel.isNull())
7937 return cxstring::createNull();
7938
7939 return cxstring::createDup(sel.getAsString());
7940}
7941
Argyrios Kyrtzidis9d9bc012013-04-18 23:29:12 +00007942unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C) {
7943 if (!clang_isDeclaration(C.kind))
7944 return CXObjCDeclQualifier_None;
7945
7946 Decl::ObjCDeclQualifier QT = Decl::OBJC_TQ_None;
7947 const Decl *D = getCursorDecl(C);
7948 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7949 QT = MD->getObjCDeclQualifier();
7950 else if (const ParmVarDecl *PD = dyn_cast<ParmVarDecl>(D))
7951 QT = PD->getObjCDeclQualifier();
7952 if (QT == Decl::OBJC_TQ_None)
7953 return CXObjCDeclQualifier_None;
7954
7955 unsigned Result = CXObjCDeclQualifier_None;
7956 if (QT & Decl::OBJC_TQ_In) Result |= CXObjCDeclQualifier_In;
7957 if (QT & Decl::OBJC_TQ_Inout) Result |= CXObjCDeclQualifier_Inout;
7958 if (QT & Decl::OBJC_TQ_Out) Result |= CXObjCDeclQualifier_Out;
7959 if (QT & Decl::OBJC_TQ_Bycopy) Result |= CXObjCDeclQualifier_Bycopy;
7960 if (QT & Decl::OBJC_TQ_Byref) Result |= CXObjCDeclQualifier_Byref;
7961 if (QT & Decl::OBJC_TQ_Oneway) Result |= CXObjCDeclQualifier_Oneway;
7962
7963 return Result;
7964}
7965
Argyrios Kyrtzidis7b50fc52013-07-05 20:44:37 +00007966unsigned clang_Cursor_isObjCOptional(CXCursor C) {
7967 if (!clang_isDeclaration(C.kind))
7968 return 0;
7969
7970 const Decl *D = getCursorDecl(C);
7971 if (const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(D))
7972 return PD->getPropertyImplementation() == ObjCPropertyDecl::Optional;
7973 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7974 return MD->getImplementationControl() == ObjCMethodDecl::Optional;
7975
7976 return 0;
7977}
7978
Argyrios Kyrtzidis23814e42013-04-18 23:53:05 +00007979unsigned clang_Cursor_isVariadic(CXCursor C) {
7980 if (!clang_isDeclaration(C.kind))
7981 return 0;
7982
7983 const Decl *D = getCursorDecl(C);
7984 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7985 return FD->isVariadic();
7986 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7987 return MD->isVariadic();
7988
7989 return 0;
7990}
7991
Argyrios Kyrtzidis0381cc72017-05-10 15:10:36 +00007992unsigned clang_Cursor_isExternalSymbol(CXCursor C,
7993 CXString *language, CXString *definedIn,
7994 unsigned *isGenerated) {
7995 if (!clang_isDeclaration(C.kind))
7996 return 0;
7997
7998 const Decl *D = getCursorDecl(C);
7999
Argyrios Kyrtzidis11d70482017-05-20 04:11:33 +00008000 if (auto *attr = D->getExternalSourceSymbolAttr()) {
Argyrios Kyrtzidis0381cc72017-05-10 15:10:36 +00008001 if (language)
8002 *language = cxstring::createDup(attr->getLanguage());
8003 if (definedIn)
8004 *definedIn = cxstring::createDup(attr->getDefinedIn());
8005 if (isGenerated)
8006 *isGenerated = attr->getGeneratedDeclaration();
8007 return 1;
8008 }
8009 return 0;
8010}
8011
Guy Benyei11169dd2012-12-18 14:30:41 +00008012CXSourceRange clang_Cursor_getCommentRange(CXCursor C) {
8013 if (!clang_isDeclaration(C.kind))
8014 return clang_getNullRange();
8015
8016 const Decl *D = getCursorDecl(C);
8017 ASTContext &Context = getCursorContext(C);
8018 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
8019 if (!RC)
8020 return clang_getNullRange();
8021
8022 return cxloc::translateSourceRange(Context, RC->getSourceRange());
8023}
8024
8025CXString clang_Cursor_getRawCommentText(CXCursor C) {
8026 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00008027 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00008028
8029 const Decl *D = getCursorDecl(C);
8030 ASTContext &Context = getCursorContext(C);
8031 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
8032 StringRef RawText = RC ? RC->getRawText(Context.getSourceManager()) :
8033 StringRef();
8034
8035 // Don't duplicate the string because RawText points directly into source
8036 // code.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008037 return cxstring::createRef(RawText);
Guy Benyei11169dd2012-12-18 14:30:41 +00008038}
8039
8040CXString clang_Cursor_getBriefCommentText(CXCursor C) {
8041 if (!clang_isDeclaration(C.kind))
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00008042 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00008043
8044 const Decl *D = getCursorDecl(C);
8045 const ASTContext &Context = getCursorContext(C);
8046 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
8047
8048 if (RC) {
8049 StringRef BriefText = RC->getBriefText(Context);
8050
8051 // Don't duplicate the string because RawComment ensures that this memory
8052 // will not go away.
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008053 return cxstring::createRef(BriefText);
Guy Benyei11169dd2012-12-18 14:30:41 +00008054 }
8055
Dmitri Gribenkof98dfba2013-02-01 14:13:32 +00008056 return cxstring::createNull();
Guy Benyei11169dd2012-12-18 14:30:41 +00008057}
8058
Guy Benyei11169dd2012-12-18 14:30:41 +00008059CXModule clang_Cursor_getModule(CXCursor C) {
8060 if (C.kind == CXCursor_ModuleImportDecl) {
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00008061 if (const ImportDecl *ImportD =
8062 dyn_cast_or_null<ImportDecl>(getCursorDecl(C)))
Guy Benyei11169dd2012-12-18 14:30:41 +00008063 return ImportD->getImportedModule();
8064 }
8065
Craig Topper69186e72014-06-08 08:38:04 +00008066 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008067}
8068
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00008069CXModule clang_getModuleForFile(CXTranslationUnit TU, CXFile File) {
8070 if (isNotUsableTU(TU)) {
8071 LOG_BAD_TU(TU);
8072 return nullptr;
8073 }
8074 if (!File)
8075 return nullptr;
8076 FileEntry *FE = static_cast<FileEntry *>(File);
8077
8078 ASTUnit &Unit = *cxtu::getASTUnit(TU);
8079 HeaderSearch &HS = Unit.getPreprocessor().getHeaderSearchInfo();
8080 ModuleMap::KnownHeader Header = HS.findModuleForHeader(FE);
8081
Richard Smithfeb54b62014-10-23 02:01:19 +00008082 return Header.getModule();
Argyrios Kyrtzidisf6d49c32014-05-14 23:14:37 +00008083}
8084
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00008085CXFile clang_Module_getASTFile(CXModule CXMod) {
8086 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00008087 return nullptr;
Argyrios Kyrtzidis12fdb9e2013-04-26 22:47:49 +00008088 Module *Mod = static_cast<Module*>(CXMod);
8089 return const_cast<FileEntry *>(Mod->getASTFile());
8090}
8091
Guy Benyei11169dd2012-12-18 14:30:41 +00008092CXModule clang_Module_getParent(CXModule CXMod) {
8093 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00008094 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008095 Module *Mod = static_cast<Module*>(CXMod);
8096 return Mod->Parent;
8097}
8098
8099CXString clang_Module_getName(CXModule CXMod) {
8100 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00008101 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00008102 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008103 return cxstring::createDup(Mod->Name);
Guy Benyei11169dd2012-12-18 14:30:41 +00008104}
8105
8106CXString clang_Module_getFullName(CXModule CXMod) {
8107 if (!CXMod)
Dmitri Gribenko36a6dd02013-02-01 14:21:22 +00008108 return cxstring::createEmpty();
Guy Benyei11169dd2012-12-18 14:30:41 +00008109 Module *Mod = static_cast<Module*>(CXMod);
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008110 return cxstring::createDup(Mod->getFullModuleName());
Guy Benyei11169dd2012-12-18 14:30:41 +00008111}
8112
Argyrios Kyrtzidis884337f2014-05-15 04:44:25 +00008113int clang_Module_isSystem(CXModule CXMod) {
8114 if (!CXMod)
8115 return 0;
8116 Module *Mod = static_cast<Module*>(CXMod);
8117 return Mod->IsSystem;
8118}
8119
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00008120unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit TU,
8121 CXModule CXMod) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00008122 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008123 LOG_BAD_TU(TU);
8124 return 0;
8125 }
8126 if (!CXMod)
Guy Benyei11169dd2012-12-18 14:30:41 +00008127 return 0;
8128 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00008129 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
8130 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
8131 return TopHeaders.size();
Guy Benyei11169dd2012-12-18 14:30:41 +00008132}
8133
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00008134CXFile clang_Module_getTopLevelHeader(CXTranslationUnit TU,
8135 CXModule CXMod, unsigned Index) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00008136 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008137 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00008138 return nullptr;
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008139 }
8140 if (!CXMod)
Craig Topper69186e72014-06-08 08:38:04 +00008141 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008142 Module *Mod = static_cast<Module*>(CXMod);
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00008143 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
Guy Benyei11169dd2012-12-18 14:30:41 +00008144
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00008145 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
8146 if (Index < TopHeaders.size())
8147 return const_cast<FileEntry *>(TopHeaders[Index]);
Guy Benyei11169dd2012-12-18 14:30:41 +00008148
Craig Topper69186e72014-06-08 08:38:04 +00008149 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008150}
8151
Guy Benyei11169dd2012-12-18 14:30:41 +00008152//===----------------------------------------------------------------------===//
8153// C++ AST instrospection.
8154//===----------------------------------------------------------------------===//
8155
Jonathan Coe29565352016-04-27 12:48:25 +00008156unsigned clang_CXXConstructor_isDefaultConstructor(CXCursor C) {
8157 if (!clang_isDeclaration(C.kind))
8158 return 0;
8159
8160 const Decl *D = cxcursor::getCursorDecl(C);
8161 const CXXConstructorDecl *Constructor =
8162 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
8163 return (Constructor && Constructor->isDefaultConstructor()) ? 1 : 0;
8164}
8165
8166unsigned clang_CXXConstructor_isCopyConstructor(CXCursor C) {
8167 if (!clang_isDeclaration(C.kind))
8168 return 0;
8169
8170 const Decl *D = cxcursor::getCursorDecl(C);
8171 const CXXConstructorDecl *Constructor =
8172 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
8173 return (Constructor && Constructor->isCopyConstructor()) ? 1 : 0;
8174}
8175
8176unsigned clang_CXXConstructor_isMoveConstructor(CXCursor C) {
8177 if (!clang_isDeclaration(C.kind))
8178 return 0;
8179
8180 const Decl *D = cxcursor::getCursorDecl(C);
8181 const CXXConstructorDecl *Constructor =
8182 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
8183 return (Constructor && Constructor->isMoveConstructor()) ? 1 : 0;
8184}
8185
8186unsigned clang_CXXConstructor_isConvertingConstructor(CXCursor C) {
8187 if (!clang_isDeclaration(C.kind))
8188 return 0;
8189
8190 const Decl *D = cxcursor::getCursorDecl(C);
8191 const CXXConstructorDecl *Constructor =
8192 D ? dyn_cast_or_null<CXXConstructorDecl>(D->getAsFunction()) : nullptr;
8193 // Passing 'false' excludes constructors marked 'explicit'.
8194 return (Constructor && Constructor->isConvertingConstructor(false)) ? 1 : 0;
8195}
8196
Saleem Abdulrasool6ea75db2015-10-27 15:50:22 +00008197unsigned clang_CXXField_isMutable(CXCursor C) {
8198 if (!clang_isDeclaration(C.kind))
8199 return 0;
8200
8201 if (const auto D = cxcursor::getCursorDecl(C))
8202 if (const auto FD = dyn_cast_or_null<FieldDecl>(D))
8203 return FD->isMutable() ? 1 : 0;
8204 return 0;
8205}
8206
Dmitri Gribenko62770be2013-05-17 18:38:35 +00008207unsigned clang_CXXMethod_isPureVirtual(CXCursor C) {
8208 if (!clang_isDeclaration(C.kind))
8209 return 0;
8210
Dmitri Gribenko62770be2013-05-17 18:38:35 +00008211 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00008212 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00008213 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenko62770be2013-05-17 18:38:35 +00008214 return (Method && Method->isVirtual() && Method->isPure()) ? 1 : 0;
8215}
8216
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00008217unsigned clang_CXXMethod_isConst(CXCursor C) {
8218 if (!clang_isDeclaration(C.kind))
8219 return 0;
8220
8221 const Decl *D = cxcursor::getCursorDecl(C);
8222 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00008223 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Dmitri Gribenkoe570ede2014-04-07 14:59:13 +00008224 return (Method && (Method->getTypeQualifiers() & Qualifiers::Const)) ? 1 : 0;
8225}
8226
Jonathan Coe29565352016-04-27 12:48:25 +00008227unsigned clang_CXXMethod_isDefaulted(CXCursor C) {
8228 if (!clang_isDeclaration(C.kind))
8229 return 0;
8230
8231 const Decl *D = cxcursor::getCursorDecl(C);
8232 const CXXMethodDecl *Method =
8233 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
8234 return (Method && Method->isDefaulted()) ? 1 : 0;
8235}
8236
Guy Benyei11169dd2012-12-18 14:30:41 +00008237unsigned clang_CXXMethod_isStatic(CXCursor C) {
8238 if (!clang_isDeclaration(C.kind))
8239 return 0;
8240
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00008241 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00008242 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00008243 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008244 return (Method && Method->isStatic()) ? 1 : 0;
8245}
8246
8247unsigned clang_CXXMethod_isVirtual(CXCursor C) {
8248 if (!clang_isDeclaration(C.kind))
8249 return 0;
8250
Dmitri Gribenkod15bb302013-01-23 17:25:27 +00008251 const Decl *D = cxcursor::getCursorDecl(C);
Alp Tokera2794f92014-01-22 07:29:52 +00008252 const CXXMethodDecl *Method =
Craig Topper69186e72014-06-08 08:38:04 +00008253 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00008254 return (Method && Method->isVirtual()) ? 1 : 0;
8255}
Guy Benyei11169dd2012-12-18 14:30:41 +00008256
Alex Lorenz34ccadc2017-12-14 22:01:50 +00008257unsigned clang_CXXRecord_isAbstract(CXCursor C) {
8258 if (!clang_isDeclaration(C.kind))
8259 return 0;
8260
8261 const auto *D = cxcursor::getCursorDecl(C);
8262 const auto *RD = dyn_cast_or_null<CXXRecordDecl>(D);
8263 if (RD)
8264 RD = RD->getDefinition();
8265 return (RD && RD->isAbstract()) ? 1 : 0;
8266}
8267
Alex Lorenzff7f42e2017-07-12 11:35:11 +00008268unsigned clang_EnumDecl_isScoped(CXCursor C) {
8269 if (!clang_isDeclaration(C.kind))
8270 return 0;
8271
8272 const Decl *D = cxcursor::getCursorDecl(C);
8273 auto *Enum = dyn_cast_or_null<EnumDecl>(D);
8274 return (Enum && Enum->isScoped()) ? 1 : 0;
8275}
8276
Guy Benyei11169dd2012-12-18 14:30:41 +00008277//===----------------------------------------------------------------------===//
8278// Attribute introspection.
8279//===----------------------------------------------------------------------===//
8280
Guy Benyei11169dd2012-12-18 14:30:41 +00008281CXType clang_getIBOutletCollectionType(CXCursor C) {
8282 if (C.kind != CXCursor_IBOutletCollectionAttr)
8283 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
8284
Dmitri Gribenkoe4baea62013-01-26 18:08:08 +00008285 const IBOutletCollectionAttr *A =
Guy Benyei11169dd2012-12-18 14:30:41 +00008286 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
8287
8288 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
8289}
Guy Benyei11169dd2012-12-18 14:30:41 +00008290
8291//===----------------------------------------------------------------------===//
8292// Inspecting memory usage.
8293//===----------------------------------------------------------------------===//
8294
8295typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
8296
8297static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
8298 enum CXTUResourceUsageKind k,
8299 unsigned long amount) {
8300 CXTUResourceUsageEntry entry = { k, amount };
8301 entries.push_back(entry);
8302}
8303
Guy Benyei11169dd2012-12-18 14:30:41 +00008304const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
8305 const char *str = "";
8306 switch (kind) {
8307 case CXTUResourceUsage_AST:
8308 str = "ASTContext: expressions, declarations, and types";
8309 break;
8310 case CXTUResourceUsage_Identifiers:
8311 str = "ASTContext: identifiers";
8312 break;
8313 case CXTUResourceUsage_Selectors:
8314 str = "ASTContext: selectors";
8315 break;
8316 case CXTUResourceUsage_GlobalCompletionResults:
8317 str = "Code completion: cached global results";
8318 break;
8319 case CXTUResourceUsage_SourceManagerContentCache:
8320 str = "SourceManager: content cache allocator";
8321 break;
8322 case CXTUResourceUsage_AST_SideTables:
8323 str = "ASTContext: side tables";
8324 break;
8325 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
8326 str = "SourceManager: malloc'ed memory buffers";
8327 break;
8328 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
8329 str = "SourceManager: mmap'ed memory buffers";
8330 break;
8331 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
8332 str = "ExternalASTSource: malloc'ed memory buffers";
8333 break;
8334 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
8335 str = "ExternalASTSource: mmap'ed memory buffers";
8336 break;
8337 case CXTUResourceUsage_Preprocessor:
8338 str = "Preprocessor: malloc'ed memory";
8339 break;
8340 case CXTUResourceUsage_PreprocessingRecord:
8341 str = "Preprocessor: PreprocessingRecord";
8342 break;
8343 case CXTUResourceUsage_SourceManager_DataStructures:
8344 str = "SourceManager: data structures and tables";
8345 break;
8346 case CXTUResourceUsage_Preprocessor_HeaderSearch:
8347 str = "Preprocessor: header search tables";
8348 break;
8349 }
8350 return str;
8351}
8352
8353CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
Dmitri Gribenko852d6222014-02-11 15:02:48 +00008354 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008355 LOG_BAD_TU(TU);
Craig Topper69186e72014-06-08 08:38:04 +00008356 CXTUResourceUsage usage = { (void*) nullptr, 0, nullptr };
Guy Benyei11169dd2012-12-18 14:30:41 +00008357 return usage;
8358 }
8359
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008360 ASTUnit *astUnit = cxtu::getASTUnit(TU);
Ahmed Charlesb8984322014-03-07 20:03:18 +00008361 std::unique_ptr<MemUsageEntries> entries(new MemUsageEntries());
Guy Benyei11169dd2012-12-18 14:30:41 +00008362 ASTContext &astContext = astUnit->getASTContext();
8363
8364 // How much memory is used by AST nodes and types?
8365 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
8366 (unsigned long) astContext.getASTAllocatedMemory());
8367
8368 // How much memory is used by identifiers?
8369 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
8370 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
8371
8372 // How much memory is used for selectors?
8373 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
8374 (unsigned long) astContext.Selectors.getTotalMemory());
8375
8376 // How much memory is used by ASTContext's side tables?
8377 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
8378 (unsigned long) astContext.getSideTableAllocatedMemory());
8379
8380 // How much memory is used for caching global code completion results?
8381 unsigned long completionBytes = 0;
8382 if (GlobalCodeCompletionAllocator *completionAllocator =
Alp Tokerf994cef2014-07-05 03:08:06 +00008383 astUnit->getCachedCompletionAllocator().get()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008384 completionBytes = completionAllocator->getTotalMemory();
8385 }
8386 createCXTUResourceUsageEntry(*entries,
8387 CXTUResourceUsage_GlobalCompletionResults,
8388 completionBytes);
8389
8390 // How much memory is being used by SourceManager's content cache?
8391 createCXTUResourceUsageEntry(*entries,
8392 CXTUResourceUsage_SourceManagerContentCache,
8393 (unsigned long) astContext.getSourceManager().getContentCacheSize());
8394
8395 // How much memory is being used by the MemoryBuffer's in SourceManager?
8396 const SourceManager::MemoryBufferSizes &srcBufs =
8397 astUnit->getSourceManager().getMemoryBufferSizes();
8398
8399 createCXTUResourceUsageEntry(*entries,
8400 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
8401 (unsigned long) srcBufs.malloc_bytes);
8402 createCXTUResourceUsageEntry(*entries,
8403 CXTUResourceUsage_SourceManager_Membuffer_MMap,
8404 (unsigned long) srcBufs.mmap_bytes);
8405 createCXTUResourceUsageEntry(*entries,
8406 CXTUResourceUsage_SourceManager_DataStructures,
8407 (unsigned long) astContext.getSourceManager()
8408 .getDataStructureSizes());
8409
8410 // How much memory is being used by the ExternalASTSource?
8411 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
8412 const ExternalASTSource::MemoryBufferSizes &sizes =
8413 esrc->getMemoryBufferSizes();
8414
8415 createCXTUResourceUsageEntry(*entries,
8416 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
8417 (unsigned long) sizes.malloc_bytes);
8418 createCXTUResourceUsageEntry(*entries,
8419 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
8420 (unsigned long) sizes.mmap_bytes);
8421 }
8422
8423 // How much memory is being used by the Preprocessor?
8424 Preprocessor &pp = astUnit->getPreprocessor();
8425 createCXTUResourceUsageEntry(*entries,
8426 CXTUResourceUsage_Preprocessor,
8427 pp.getTotalMemory());
8428
8429 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
8430 createCXTUResourceUsageEntry(*entries,
8431 CXTUResourceUsage_PreprocessingRecord,
8432 pRec->getTotalMemory());
8433 }
8434
8435 createCXTUResourceUsageEntry(*entries,
8436 CXTUResourceUsage_Preprocessor_HeaderSearch,
8437 pp.getHeaderSearchInfo().getTotalMemory());
Craig Topper69186e72014-06-08 08:38:04 +00008438
Guy Benyei11169dd2012-12-18 14:30:41 +00008439 CXTUResourceUsage usage = { (void*) entries.get(),
8440 (unsigned) entries->size(),
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00008441 !entries->empty() ? &(*entries)[0] : nullptr };
Eric Fiseliere95fc442016-11-14 07:03:50 +00008442 (void)entries.release();
Guy Benyei11169dd2012-12-18 14:30:41 +00008443 return usage;
8444}
8445
8446void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
8447 if (usage.data)
8448 delete (MemUsageEntries*) usage.data;
8449}
8450
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00008451CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit TU, CXFile file) {
8452 CXSourceRangeList *skipped = new CXSourceRangeList;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008453 skipped->count = 0;
Craig Topper69186e72014-06-08 08:38:04 +00008454 skipped->ranges = nullptr;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008455
Dmitri Gribenko852d6222014-02-11 15:02:48 +00008456 if (isNotUsableTU(TU)) {
Dmitri Gribenko256454f2014-02-11 14:34:14 +00008457 LOG_BAD_TU(TU);
8458 return skipped;
8459 }
8460
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008461 if (!file)
8462 return skipped;
8463
8464 ASTUnit *astUnit = cxtu::getASTUnit(TU);
8465 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
8466 if (!ppRec)
8467 return skipped;
8468
8469 ASTContext &Ctx = astUnit->getASTContext();
8470 SourceManager &sm = Ctx.getSourceManager();
8471 FileEntry *fileEntry = static_cast<FileEntry *>(file);
8472 FileID wantedFileID = sm.translateFile(fileEntry);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00008473 bool isMainFile = wantedFileID == sm.getMainFileID();
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008474
8475 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
8476 std::vector<SourceRange> wantedRanges;
8477 for (std::vector<SourceRange>::const_iterator i = SkippedRanges.begin(), ei = SkippedRanges.end();
8478 i != ei; ++i) {
8479 if (sm.getFileID(i->getBegin()) == wantedFileID || sm.getFileID(i->getEnd()) == wantedFileID)
8480 wantedRanges.push_back(*i);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00008481 else if (isMainFile && (astUnit->isInPreambleFileID(i->getBegin()) || astUnit->isInPreambleFileID(i->getEnd())))
8482 wantedRanges.push_back(*i);
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008483 }
8484
8485 skipped->count = wantedRanges.size();
8486 skipped->ranges = new CXSourceRange[skipped->count];
8487 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
8488 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, wantedRanges[i]);
8489
8490 return skipped;
8491}
8492
Cameron Desrochersd8091282016-08-18 15:43:55 +00008493CXSourceRangeList *clang_getAllSkippedRanges(CXTranslationUnit TU) {
8494 CXSourceRangeList *skipped = new CXSourceRangeList;
8495 skipped->count = 0;
8496 skipped->ranges = nullptr;
8497
8498 if (isNotUsableTU(TU)) {
8499 LOG_BAD_TU(TU);
8500 return skipped;
8501 }
8502
8503 ASTUnit *astUnit = cxtu::getASTUnit(TU);
8504 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
8505 if (!ppRec)
8506 return skipped;
8507
8508 ASTContext &Ctx = astUnit->getASTContext();
8509
8510 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
8511
8512 skipped->count = SkippedRanges.size();
8513 skipped->ranges = new CXSourceRange[skipped->count];
8514 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
8515 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, SkippedRanges[i]);
8516
8517 return skipped;
8518}
8519
Argyrios Kyrtzidis0e282ef2013-12-06 18:55:45 +00008520void clang_disposeSourceRangeList(CXSourceRangeList *ranges) {
8521 if (ranges) {
8522 delete[] ranges->ranges;
8523 delete ranges;
Argyrios Kyrtzidis9ef57752013-12-05 08:19:32 +00008524 }
8525}
8526
Guy Benyei11169dd2012-12-18 14:30:41 +00008527void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
8528 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
8529 for (unsigned I = 0; I != Usage.numEntries; ++I)
8530 fprintf(stderr, " %s: %lu\n",
8531 clang_getTUResourceUsageName(Usage.entries[I].kind),
8532 Usage.entries[I].amount);
8533
8534 clang_disposeCXTUResourceUsage(Usage);
8535}
8536
8537//===----------------------------------------------------------------------===//
8538// Misc. utility functions.
8539//===----------------------------------------------------------------------===//
8540
Richard Smith0a7b2972018-07-03 21:34:13 +00008541/// Default to using our desired 8 MB stack size on "safety" threads.
8542static unsigned SafetyStackThreadSize = DesiredStackSize;
Guy Benyei11169dd2012-12-18 14:30:41 +00008543
8544namespace clang {
8545
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00008546bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn,
Guy Benyei11169dd2012-12-18 14:30:41 +00008547 unsigned Size) {
8548 if (!Size)
8549 Size = GetSafetyThreadStackSize();
Erik Verbruggen3cc39112017-11-14 09:34:39 +00008550 if (Size && !getenv("LIBCLANG_NOTHREADS"))
Benjamin Kramer11a9cd92015-07-25 20:55:44 +00008551 return CRC.RunSafelyOnThread(Fn, Size);
8552 return CRC.RunSafely(Fn);
Guy Benyei11169dd2012-12-18 14:30:41 +00008553}
8554
8555unsigned GetSafetyThreadStackSize() {
8556 return SafetyStackThreadSize;
8557}
8558
8559void SetSafetyThreadStackSize(unsigned Value) {
8560 SafetyStackThreadSize = Value;
8561}
8562
Alexander Kornienkoab9db512015-06-22 23:07:51 +00008563}
Guy Benyei11169dd2012-12-18 14:30:41 +00008564
8565void clang::setThreadBackgroundPriority() {
8566 if (getenv("LIBCLANG_BGPRIO_DISABLE"))
8567 return;
8568
Alp Toker1a86ad22014-07-06 06:24:00 +00008569#ifdef USE_DARWIN_THREADS
Guy Benyei11169dd2012-12-18 14:30:41 +00008570 setpriority(PRIO_DARWIN_THREAD, 0, PRIO_DARWIN_BG);
8571#endif
8572}
8573
8574void cxindex::printDiagsToStderr(ASTUnit *Unit) {
8575 if (!Unit)
8576 return;
8577
8578 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
8579 DEnd = Unit->stored_diag_end();
8580 D != DEnd; ++D) {
Ben Langmuir749323f2014-04-22 17:40:12 +00008581 CXStoredDiagnostic Diag(*D, Unit->getLangOpts());
Guy Benyei11169dd2012-12-18 14:30:41 +00008582 CXString Msg = clang_formatDiagnostic(&Diag,
8583 clang_defaultDiagnosticDisplayOptions());
8584 fprintf(stderr, "%s\n", clang_getCString(Msg));
8585 clang_disposeString(Msg);
8586 }
Nico Weber1865df42018-04-27 19:11:14 +00008587#ifdef _WIN32
Guy Benyei11169dd2012-12-18 14:30:41 +00008588 // On Windows, force a flush, since there may be multiple copies of
8589 // stderr and stdout in the file system, all with different buffers
8590 // but writing to the same device.
8591 fflush(stderr);
8592#endif
8593}
8594
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008595MacroInfo *cxindex::getMacroInfo(const IdentifierInfo &II,
8596 SourceLocation MacroDefLoc,
8597 CXTranslationUnit TU){
8598 if (MacroDefLoc.isInvalid() || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008599 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008600 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00008601 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008602
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008603 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis2d77aeb2013-01-07 19:16:30 +00008604 Preprocessor &PP = Unit->getPreprocessor();
Richard Smith20e883e2015-04-29 23:20:19 +00008605 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00008606 if (MD) {
8607 for (MacroDirective::DefInfo
8608 Def = MD->getDefinition(); Def; Def = Def.getPreviousDefinition()) {
8609 if (MacroDefLoc == Def.getMacroInfo()->getDefinitionLoc())
8610 return Def.getMacroInfo();
8611 }
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008612 }
8613
Craig Topper69186e72014-06-08 08:38:04 +00008614 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008615}
8616
Richard Smith66a81862015-05-04 02:25:31 +00008617const MacroInfo *cxindex::getMacroInfo(const MacroDefinitionRecord *MacroDef,
Dmitri Gribenkoba2f7462013-01-11 21:01:49 +00008618 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008619 if (!MacroDef || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008620 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008621 const IdentifierInfo *II = MacroDef->getName();
8622 if (!II)
Craig Topper69186e72014-06-08 08:38:04 +00008623 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008624
8625 return getMacroInfo(*II, MacroDef->getLocation(), TU);
8626}
8627
Richard Smith66a81862015-05-04 02:25:31 +00008628MacroDefinitionRecord *
8629cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, const Token &Tok,
8630 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008631 if (!MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008632 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008633 if (Tok.isNot(tok::raw_identifier))
Craig Topper69186e72014-06-08 08:38:04 +00008634 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008635
8636 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00008637 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008638 SourceRange DefRange(MI->getReplacementToken(0).getLocation(),
8639 MI->getDefinitionEndLoc());
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008640 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008641
8642 // Check that the token is inside the definition and not its argument list.
8643 SourceManager &SM = Unit->getSourceManager();
8644 if (SM.isBeforeInTranslationUnit(Tok.getLocation(), DefRange.getBegin()))
Craig Topper69186e72014-06-08 08:38:04 +00008645 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008646 if (SM.isBeforeInTranslationUnit(DefRange.getEnd(), Tok.getLocation()))
Craig Topper69186e72014-06-08 08:38:04 +00008647 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008648
8649 Preprocessor &PP = Unit->getPreprocessor();
8650 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
8651 if (!PPRec)
Craig Topper69186e72014-06-08 08:38:04 +00008652 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008653
Alp Toker2d57cea2014-05-17 04:53:25 +00008654 IdentifierInfo &II = PP.getIdentifierTable().get(Tok.getRawIdentifier());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008655 if (!II.hadMacroDefinition())
Craig Topper69186e72014-06-08 08:38:04 +00008656 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008657
8658 // Check that the identifier is not one of the macro arguments.
Faisal Valiac506d72017-07-17 17:18:43 +00008659 if (std::find(MI->param_begin(), MI->param_end(), &II) != MI->param_end())
Craig Topper69186e72014-06-08 08:38:04 +00008660 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008661
Richard Smith20e883e2015-04-29 23:20:19 +00008662 MacroDirective *InnerMD = PP.getLocalMacroDirectiveHistory(&II);
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00008663 if (!InnerMD)
Craig Topper69186e72014-06-08 08:38:04 +00008664 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008665
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00008666 return PPRec->findMacroDefinition(InnerMD->getMacroInfo());
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008667}
8668
Richard Smith66a81862015-05-04 02:25:31 +00008669MacroDefinitionRecord *
8670cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc,
8671 CXTranslationUnit TU) {
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008672 if (Loc.isInvalid() || !MI || !TU)
Craig Topper69186e72014-06-08 08:38:04 +00008673 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008674
8675 if (MI->getNumTokens() == 0)
Craig Topper69186e72014-06-08 08:38:04 +00008676 return nullptr;
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008677 ASTUnit *Unit = cxtu::getASTUnit(TU);
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008678 Preprocessor &PP = Unit->getPreprocessor();
8679 if (!PP.getPreprocessingRecord())
Craig Topper69186e72014-06-08 08:38:04 +00008680 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008681 Loc = Unit->getSourceManager().getSpellingLoc(Loc);
8682 Token Tok;
8683 if (PP.getRawToken(Loc, Tok))
Craig Topper69186e72014-06-08 08:38:04 +00008684 return nullptr;
Argyrios Kyrtzidis579825a2013-01-07 19:16:25 +00008685
8686 return checkForMacroInMacroDefinition(MI, Tok, TU);
8687}
8688
Guy Benyei11169dd2012-12-18 14:30:41 +00008689CXString clang_getClangVersion() {
Dmitri Gribenko2f23e9c2013-02-02 02:19:29 +00008690 return cxstring::createDup(getClangFullVersion());
Guy Benyei11169dd2012-12-18 14:30:41 +00008691}
8692
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008693Logger &cxindex::Logger::operator<<(CXTranslationUnit TU) {
8694 if (TU) {
Dmitri Gribenkoc22ea1c2013-01-26 18:53:38 +00008695 if (ASTUnit *Unit = cxtu::getASTUnit(TU)) {
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008696 LogOS << '<' << Unit->getMainFileName() << '>';
Argyrios Kyrtzidis37f2ab42013-03-05 20:21:14 +00008697 if (Unit->isMainFileAST())
8698 LogOS << " (" << Unit->getASTFileName() << ')';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008699 return *this;
8700 }
Dmitri Gribenkoea4d1c32014-02-12 19:12:37 +00008701 } else {
8702 LogOS << "<NULL TU>";
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008703 }
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008704 return *this;
8705}
8706
Argyrios Kyrtzidisba4b5f82013-03-08 02:32:26 +00008707Logger &cxindex::Logger::operator<<(const FileEntry *FE) {
8708 *this << FE->getName();
8709 return *this;
8710}
8711
8712Logger &cxindex::Logger::operator<<(CXCursor cursor) {
8713 CXString cursorName = clang_getCursorDisplayName(cursor);
8714 *this << cursorName << "@" << clang_getCursorLocation(cursor);
8715 clang_disposeString(cursorName);
8716 return *this;
8717}
8718
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008719Logger &cxindex::Logger::operator<<(CXSourceLocation Loc) {
8720 CXFile File;
8721 unsigned Line, Column;
Craig Topper69186e72014-06-08 08:38:04 +00008722 clang_getFileLocation(Loc, &File, &Line, &Column, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008723 CXString FileName = clang_getFileName(File);
8724 *this << llvm::format("(%s:%d:%d)", clang_getCString(FileName), Line, Column);
8725 clang_disposeString(FileName);
8726 return *this;
8727}
8728
8729Logger &cxindex::Logger::operator<<(CXSourceRange range) {
8730 CXSourceLocation BLoc = clang_getRangeStart(range);
8731 CXSourceLocation ELoc = clang_getRangeEnd(range);
8732
8733 CXFile BFile;
8734 unsigned BLine, BColumn;
Craig Topper69186e72014-06-08 08:38:04 +00008735 clang_getFileLocation(BLoc, &BFile, &BLine, &BColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008736
8737 CXFile EFile;
8738 unsigned ELine, EColumn;
Craig Topper69186e72014-06-08 08:38:04 +00008739 clang_getFileLocation(ELoc, &EFile, &ELine, &EColumn, nullptr);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008740
8741 CXString BFileName = clang_getFileName(BFile);
8742 if (BFile == EFile) {
8743 *this << llvm::format("[%s %d:%d-%d:%d]", clang_getCString(BFileName),
8744 BLine, BColumn, ELine, EColumn);
8745 } else {
8746 CXString EFileName = clang_getFileName(EFile);
8747 *this << llvm::format("[%s:%d:%d - ", clang_getCString(BFileName),
8748 BLine, BColumn)
8749 << llvm::format("%s:%d:%d]", clang_getCString(EFileName),
8750 ELine, EColumn);
8751 clang_disposeString(EFileName);
8752 }
8753 clang_disposeString(BFileName);
8754 return *this;
8755}
8756
8757Logger &cxindex::Logger::operator<<(CXString Str) {
8758 *this << clang_getCString(Str);
8759 return *this;
8760}
8761
8762Logger &cxindex::Logger::operator<<(const llvm::format_object_base &Fmt) {
8763 LogOS << Fmt;
8764 return *this;
8765}
8766
Chandler Carruth37ad2582014-06-27 15:14:39 +00008767static llvm::ManagedStatic<llvm::sys::Mutex> LoggingMutex;
8768
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008769cxindex::Logger::~Logger() {
Chandler Carruth37ad2582014-06-27 15:14:39 +00008770 llvm::sys::ScopedLock L(*LoggingMutex);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008771
8772 static llvm::TimeRecord sBeginTR = llvm::TimeRecord::getCurrentTime();
8773
Dmitri Gribenkof8579502013-01-12 19:30:44 +00008774 raw_ostream &OS = llvm::errs();
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008775 OS << "[libclang:" << Name << ':';
8776
Alp Toker1a86ad22014-07-06 06:24:00 +00008777#ifdef USE_DARWIN_THREADS
8778 // TODO: Portability.
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008779 mach_port_t tid = pthread_mach_thread_np(pthread_self());
8780 OS << tid << ':';
8781#endif
8782
8783 llvm::TimeRecord TR = llvm::TimeRecord::getCurrentTime();
8784 OS << llvm::format("%7.4f] ", TR.getWallTime() - sBeginTR.getWallTime());
Yaron Keren09fb7c62015-03-10 07:33:23 +00008785 OS << Msg << '\n';
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008786
8787 if (Trace) {
Zachary Turner1fe2a8d2015-03-05 19:15:09 +00008788 llvm::sys::PrintStackTrace(OS);
Argyrios Kyrtzidisea474352013-01-10 18:54:52 +00008789 OS << "--------------------------------------------------\n";
8790 }
8791}
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008792
8793#ifdef CLANG_TOOL_EXTRA_BUILD
8794// This anchor is used to force the linker to link the clang-tidy plugin.
8795extern volatile int ClangTidyPluginAnchorSource;
8796static int LLVM_ATTRIBUTE_UNUSED ClangTidyPluginAnchorDestination =
8797 ClangTidyPluginAnchorSource;
Benjamin Kramer9eba7352016-11-17 15:22:36 +00008798
8799// This anchor is used to force the linker to link the clang-include-fixer
8800// plugin.
8801extern volatile int ClangIncludeFixerPluginAnchorSource;
8802static int LLVM_ATTRIBUTE_UNUSED ClangIncludeFixerPluginAnchorDestination =
8803 ClangIncludeFixerPluginAnchorSource;
Benjamin Kramerc1ffdab2016-03-03 08:58:18 +00008804#endif