1 //===- CIndex.cpp - Clang-C Source Indexing Library -----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the main API hooks in the Clang-C Source Indexing
13 //===----------------------------------------------------------------------===//
16 #include "CIndexDiagnostic.h"
19 #include "CXSourceLocation.h"
21 #include "CXTranslationUnit.h"
23 #include "CursorVisitor.h"
24 #include "clang/AST/Attr.h"
25 #include "clang/AST/Mangle.h"
26 #include "clang/AST/StmtVisitor.h"
27 #include "clang/Basic/Diagnostic.h"
28 #include "clang/Basic/DiagnosticCategories.h"
29 #include "clang/Basic/DiagnosticIDs.h"
30 #include "clang/Basic/TargetInfo.h"
31 #include "clang/Basic/Version.h"
32 #include "clang/Frontend/ASTUnit.h"
33 #include "clang/Frontend/CompilerInstance.h"
34 #include "clang/Frontend/FrontendDiagnostic.h"
35 #include "clang/Index/CommentToXML.h"
36 #include "clang/Lex/HeaderSearch.h"
37 #include "clang/Lex/Lexer.h"
38 #include "clang/Lex/PreprocessingRecord.h"
39 #include "clang/Lex/Preprocessor.h"
40 #include "clang/Serialization/SerializationDiagnostic.h"
41 #include "llvm/ADT/Optional.h"
42 #include "llvm/ADT/STLExtras.h"
43 #include "llvm/ADT/StringSwitch.h"
44 #include "llvm/Config/llvm-config.h"
45 #include "llvm/IR/DataLayout.h"
46 #include "llvm/IR/Mangler.h"
47 #include "llvm/Support/Compiler.h"
48 #include "llvm/Support/CrashRecoveryContext.h"
49 #include "llvm/Support/Format.h"
50 #include "llvm/Support/ManagedStatic.h"
51 #include "llvm/Support/MemoryBuffer.h"
52 #include "llvm/Support/Mutex.h"
53 #include "llvm/Support/Program.h"
54 #include "llvm/Support/SaveAndRestore.h"
55 #include "llvm/Support/Signals.h"
56 #include "llvm/Support/TargetSelect.h"
57 #include "llvm/Support/Threading.h"
58 #include "llvm/Support/Timer.h"
59 #include "llvm/Support/raw_ostream.h"
61 #if LLVM_ENABLE_THREADS != 0 && defined(__APPLE__)
62 #define USE_DARWIN_THREADS
65 #ifdef USE_DARWIN_THREADS
69 using namespace clang;
70 using namespace clang::cxcursor;
71 using namespace clang::cxtu;
72 using namespace clang::cxindex;
74 CXTranslationUnit cxtu::MakeCXTranslationUnit(CIndexer *CIdx, ASTUnit *AU) {
78 CXTranslationUnit D = new CXTranslationUnitImpl();
81 D->StringPool = new cxstring::CXStringPool();
82 D->Diagnostics = nullptr;
83 D->OverridenCursorsPool = createOverridenCXCursorsPool();
84 D->CommentToXML = nullptr;
88 bool cxtu::isASTReadError(ASTUnit *AU) {
89 for (ASTUnit::stored_diag_iterator D = AU->stored_diag_begin(),
90 DEnd = AU->stored_diag_end();
92 if (D->getLevel() >= DiagnosticsEngine::Error &&
93 DiagnosticIDs::getCategoryNumberForDiag(D->getID()) ==
94 diag::DiagCat_AST_Deserialization_Issue)
100 cxtu::CXTUOwner::~CXTUOwner() {
102 clang_disposeTranslationUnit(TU);
105 /// \brief Compare two source ranges to determine their relative position in
106 /// the translation unit.
107 static RangeComparisonResult RangeCompare(SourceManager &SM,
110 assert(R1.isValid() && "First range is invalid?");
111 assert(R2.isValid() && "Second range is invalid?");
112 if (R1.getEnd() != R2.getBegin() &&
113 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
115 if (R2.getEnd() != R1.getBegin() &&
116 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
121 /// \brief Determine if a source location falls within, before, or after a
122 /// a given source range.
123 static RangeComparisonResult LocationCompare(SourceManager &SM,
124 SourceLocation L, SourceRange R) {
125 assert(R.isValid() && "First range is invalid?");
126 assert(L.isValid() && "Second range is invalid?");
127 if (L == R.getBegin() || L == R.getEnd())
129 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
131 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
136 /// \brief Translate a Clang source range into a CIndex source range.
138 /// Clang internally represents ranges where the end location points to the
139 /// start of the token at the end. However, for external clients it is more
140 /// useful to have a CXSourceRange be a proper half-open interval. This routine
141 /// does the appropriate translation.
142 CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
143 const LangOptions &LangOpts,
144 const CharSourceRange &R) {
145 // We want the last character in this location, so we will adjust the
146 // location accordingly.
147 SourceLocation EndLoc = R.getEnd();
148 if (EndLoc.isValid() && EndLoc.isMacroID() && !SM.isMacroArgExpansion(EndLoc))
149 EndLoc = SM.getExpansionRange(EndLoc).second;
150 if (R.isTokenRange() && EndLoc.isValid()) {
151 unsigned Length = Lexer::MeasureTokenLength(SM.getSpellingLoc(EndLoc),
153 EndLoc = EndLoc.getLocWithOffset(Length);
156 CXSourceRange Result = {
158 R.getBegin().getRawEncoding(),
159 EndLoc.getRawEncoding()
164 //===----------------------------------------------------------------------===//
166 //===----------------------------------------------------------------------===//
168 static SourceRange getRawCursorExtent(CXCursor C);
169 static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
172 RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
173 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
176 /// \brief Visit the given cursor and, if requested by the visitor,
179 /// \param Cursor the cursor to visit.
181 /// \param CheckedRegionOfInterest if true, then the caller already checked
182 /// that this cursor is within the region of interest.
184 /// \returns true if the visitation should be aborted, false if it
186 bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
187 if (clang_isInvalid(Cursor.kind))
190 if (clang_isDeclaration(Cursor.kind)) {
191 const Decl *D = getCursorDecl(Cursor);
193 assert(0 && "Invalid declaration cursor");
194 return true; // abort.
197 // Ignore implicit declarations, unless it's an objc method because
198 // currently we should report implicit methods for properties when indexing.
199 if (D->isImplicit() && !isa<ObjCMethodDecl>(D))
203 // If we have a range of interest, and this cursor doesn't intersect with it,
205 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
206 SourceRange Range = getRawCursorExtent(Cursor);
207 if (Range.isInvalid() || CompareRegionOfInterest(Range))
211 switch (Visitor(Cursor, Parent, ClientData)) {
212 case CXChildVisit_Break:
215 case CXChildVisit_Continue:
218 case CXChildVisit_Recurse: {
219 bool ret = VisitChildren(Cursor);
220 if (PostChildrenVisitor)
221 if (PostChildrenVisitor(Cursor, ClientData))
227 llvm_unreachable("Invalid CXChildVisitResult!");
230 static bool visitPreprocessedEntitiesInRange(SourceRange R,
231 PreprocessingRecord &PPRec,
232 CursorVisitor &Visitor) {
233 SourceManager &SM = Visitor.getASTUnit()->getSourceManager();
236 if (!Visitor.shouldVisitIncludedEntities()) {
237 // If the begin/end of the range lie in the same FileID, do the optimization
238 // where we skip preprocessed entities that do not come from the same FileID.
239 FID = SM.getFileID(SM.getFileLoc(R.getBegin()));
240 if (FID != SM.getFileID(SM.getFileLoc(R.getEnd())))
244 const auto &Entities = PPRec.getPreprocessedEntitiesInRange(R);
245 return Visitor.visitPreprocessedEntities(Entities.begin(), Entities.end(),
249 bool CursorVisitor::visitFileRegion() {
250 if (RegionOfInterest.isInvalid())
253 ASTUnit *Unit = cxtu::getASTUnit(TU);
254 SourceManager &SM = Unit->getSourceManager();
256 std::pair<FileID, unsigned>
257 Begin = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getBegin())),
258 End = SM.getDecomposedLoc(SM.getFileLoc(RegionOfInterest.getEnd()));
260 if (End.first != Begin.first) {
261 // If the end does not reside in the same file, try to recover by
262 // picking the end of the file of begin location.
263 End.first = Begin.first;
264 End.second = SM.getFileIDSize(Begin.first);
267 assert(Begin.first == End.first);
268 if (Begin.second > End.second)
271 FileID File = Begin.first;
272 unsigned Offset = Begin.second;
273 unsigned Length = End.second - Begin.second;
275 if (!VisitDeclsOnly && !VisitPreprocessorLast)
276 if (visitPreprocessedEntitiesInRegion())
277 return true; // visitation break.
279 if (visitDeclsFromFileRegion(File, Offset, Length))
280 return true; // visitation break.
282 if (!VisitDeclsOnly && VisitPreprocessorLast)
283 return visitPreprocessedEntitiesInRegion();
288 static bool isInLexicalContext(Decl *D, DeclContext *DC) {
292 for (DeclContext *DeclDC = D->getLexicalDeclContext();
293 DeclDC; DeclDC = DeclDC->getLexicalParent()) {
300 bool CursorVisitor::visitDeclsFromFileRegion(FileID File,
301 unsigned Offset, unsigned Length) {
302 ASTUnit *Unit = cxtu::getASTUnit(TU);
303 SourceManager &SM = Unit->getSourceManager();
304 SourceRange Range = RegionOfInterest;
306 SmallVector<Decl *, 16> Decls;
307 Unit->findFileRegionDecls(File, Offset, Length, Decls);
309 // If we didn't find any file level decls for the file, try looking at the
310 // file that it was included from.
311 while (Decls.empty() || Decls.front()->isTopLevelDeclInObjCContainer()) {
312 bool Invalid = false;
313 const SrcMgr::SLocEntry &SLEntry = SM.getSLocEntry(File, &Invalid);
317 SourceLocation Outer;
318 if (SLEntry.isFile())
319 Outer = SLEntry.getFile().getIncludeLoc();
321 Outer = SLEntry.getExpansion().getExpansionLocStart();
322 if (Outer.isInvalid())
325 std::tie(File, Offset) = SM.getDecomposedExpansionLoc(Outer);
327 Unit->findFileRegionDecls(File, Offset, Length, Decls);
330 assert(!Decls.empty());
332 bool VisitedAtLeastOnce = false;
333 DeclContext *CurDC = nullptr;
334 SmallVectorImpl<Decl *>::iterator DIt = Decls.begin();
335 for (SmallVectorImpl<Decl *>::iterator DE = Decls.end(); DIt != DE; ++DIt) {
337 if (D->getSourceRange().isInvalid())
340 if (isInLexicalContext(D, CurDC))
343 CurDC = dyn_cast<DeclContext>(D);
345 if (TagDecl *TD = dyn_cast<TagDecl>(D))
346 if (!TD->isFreeStanding())
349 RangeComparisonResult CompRes = RangeCompare(SM, D->getSourceRange(),Range);
350 if (CompRes == RangeBefore)
352 if (CompRes == RangeAfter)
355 assert(CompRes == RangeOverlap);
356 VisitedAtLeastOnce = true;
358 if (isa<ObjCContainerDecl>(D)) {
359 FileDI_current = &DIt;
362 FileDI_current = nullptr;
365 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
366 return true; // visitation break.
369 if (VisitedAtLeastOnce)
372 // No Decls overlapped with the range. Move up the lexical context until there
373 // is a context that contains the range or we reach the translation unit
375 DeclContext *DC = DIt == Decls.begin() ? (*DIt)->getLexicalDeclContext()
376 : (*(DIt-1))->getLexicalDeclContext();
378 while (DC && !DC->isTranslationUnit()) {
379 Decl *D = cast<Decl>(DC);
380 SourceRange CurDeclRange = D->getSourceRange();
381 if (CurDeclRange.isInvalid())
384 if (RangeCompare(SM, CurDeclRange, Range) == RangeOverlap) {
385 if (Visit(MakeCXCursor(D, TU, Range), /*CheckedRegionOfInterest=*/true))
386 return true; // visitation break.
389 DC = D->getLexicalDeclContext();
395 bool CursorVisitor::visitPreprocessedEntitiesInRegion() {
396 if (!AU->getPreprocessor().getPreprocessingRecord())
399 PreprocessingRecord &PPRec
400 = *AU->getPreprocessor().getPreprocessingRecord();
401 SourceManager &SM = AU->getSourceManager();
403 if (RegionOfInterest.isValid()) {
404 SourceRange MappedRange = AU->mapRangeToPreamble(RegionOfInterest);
405 SourceLocation B = MappedRange.getBegin();
406 SourceLocation E = MappedRange.getEnd();
408 if (AU->isInPreambleFileID(B)) {
409 if (SM.isLoadedSourceLocation(E))
410 return visitPreprocessedEntitiesInRange(SourceRange(B, E),
413 // Beginning of range lies in the preamble but it also extends beyond
414 // it into the main file. Split the range into 2 parts, one covering
415 // the preamble and another covering the main file. This allows subsequent
416 // calls to visitPreprocessedEntitiesInRange to accept a source range that
417 // lies in the same FileID, allowing it to skip preprocessed entities that
418 // do not come from the same FileID.
420 visitPreprocessedEntitiesInRange(
421 SourceRange(B, AU->getEndOfPreambleFileID()),
423 if (breaked) return true;
424 return visitPreprocessedEntitiesInRange(
425 SourceRange(AU->getStartOfMainFileID(), E),
429 return visitPreprocessedEntitiesInRange(SourceRange(B, E), PPRec, *this);
433 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
436 return visitPreprocessedEntities(PPRec.local_begin(), PPRec.local_end(),
439 return visitPreprocessedEntities(PPRec.begin(), PPRec.end(), PPRec);
442 template<typename InputIterator>
443 bool CursorVisitor::visitPreprocessedEntities(InputIterator First,
445 PreprocessingRecord &PPRec,
447 for (; First != Last; ++First) {
448 if (!FID.isInvalid() && !PPRec.isEntityInFileID(First, FID))
451 PreprocessedEntity *PPE = *First;
455 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(PPE)) {
456 if (Visit(MakeMacroExpansionCursor(ME, TU)))
462 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(PPE)) {
463 if (Visit(MakeMacroDefinitionCursor(MD, TU)))
469 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
470 if (Visit(MakeInclusionDirectiveCursor(ID, TU)))
480 /// \brief Visit the children of the given cursor.
482 /// \returns true if the visitation should be aborted, false if it
484 bool CursorVisitor::VisitChildren(CXCursor Cursor) {
485 if (clang_isReference(Cursor.kind) &&
486 Cursor.kind != CXCursor_CXXBaseSpecifier) {
487 // By definition, references have no children.
491 // Set the Parent field to Cursor, then back to its old value once we're
493 SetParentRAII SetParent(Parent, StmtParent, Cursor);
495 if (clang_isDeclaration(Cursor.kind)) {
496 Decl *D = const_cast<Decl *>(getCursorDecl(Cursor));
500 return VisitAttributes(D) || Visit(D);
503 if (clang_isStatement(Cursor.kind)) {
504 if (const Stmt *S = getCursorStmt(Cursor))
510 if (clang_isExpression(Cursor.kind)) {
511 if (const Expr *E = getCursorExpr(Cursor))
517 if (clang_isTranslationUnit(Cursor.kind)) {
518 CXTranslationUnit TU = getCursorTU(Cursor);
519 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
521 int VisitOrder[2] = { VisitPreprocessorLast, !VisitPreprocessorLast };
522 for (unsigned I = 0; I != 2; ++I) {
524 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
525 RegionOfInterest.isInvalid()) {
526 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
527 TLEnd = CXXUnit->top_level_end();
529 if (Visit(MakeCXCursor(*TL, TU, RegionOfInterest), true))
532 } else if (VisitDeclContext(
533 CXXUnit->getASTContext().getTranslationUnitDecl()))
538 // Walk the preprocessing record.
539 if (CXXUnit->getPreprocessor().getPreprocessingRecord())
540 visitPreprocessedEntitiesInRegion();
546 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
547 if (const CXXBaseSpecifier *Base = getCursorCXXBaseSpecifier(Cursor)) {
548 if (TypeSourceInfo *BaseTSInfo = Base->getTypeSourceInfo()) {
549 return Visit(BaseTSInfo->getTypeLoc());
554 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
555 const IBOutletCollectionAttr *A =
556 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(Cursor));
557 if (const ObjCObjectType *ObjT = A->getInterface()->getAs<ObjCObjectType>())
558 return Visit(cxcursor::MakeCursorObjCClassRef(
559 ObjT->getInterface(),
560 A->getInterfaceLoc()->getTypeLoc().getLocStart(), TU));
563 // If pointing inside a macro definition, check if the token is an identifier
564 // that was ever defined as a macro. In such a case, create a "pseudo" macro
565 // expansion cursor for that token.
566 SourceLocation BeginLoc = RegionOfInterest.getBegin();
567 if (Cursor.kind == CXCursor_MacroDefinition &&
568 BeginLoc == RegionOfInterest.getEnd()) {
569 SourceLocation Loc = AU->mapLocationToPreamble(BeginLoc);
570 const MacroInfo *MI =
571 getMacroInfo(cxcursor::getCursorMacroDefinition(Cursor), TU);
572 if (MacroDefinitionRecord *MacroDef =
573 checkForMacroInMacroDefinition(MI, Loc, TU))
574 return Visit(cxcursor::MakeMacroExpansionCursor(MacroDef, BeginLoc, TU));
577 // Nothing to visit at the moment.
581 bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
582 if (TypeSourceInfo *TSInfo = B->getSignatureAsWritten())
583 if (Visit(TSInfo->getTypeLoc()))
586 if (Stmt *Body = B->getBody())
587 return Visit(MakeCXCursor(Body, StmtParent, TU, RegionOfInterest));
592 Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
593 if (RegionOfInterest.isValid()) {
594 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
595 if (Range.isInvalid())
598 switch (CompareRegionOfInterest(Range)) {
600 // This declaration comes before the region of interest; skip it.
604 // This declaration comes after the region of interest; we're done.
608 // This declaration overlaps the region of interest; visit it.
615 bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
616 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
618 // FIXME: Eventually remove. This part of a hack to support proper
619 // iteration over all Decls contained lexically within an ObjC container.
620 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
621 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
623 for ( ; I != E; ++I) {
625 if (D->getLexicalDeclContext() != DC)
627 CXCursor Cursor = MakeCXCursor(D, TU, RegionOfInterest);
629 // Ignore synthesized ivars here, otherwise if we have something like:
630 // @synthesize prop = _prop;
631 // and '_prop' is not declared, we will encounter a '_prop' ivar before
632 // encountering the 'prop' synthesize declaration and we will think that
633 // we passed the region-of-interest.
634 if (ObjCIvarDecl *ivarD = dyn_cast<ObjCIvarDecl>(D)) {
635 if (ivarD->getSynthesize())
639 // FIXME: ObjCClassRef/ObjCProtocolRef for forward class/protocol
640 // declarations is a mismatch with the compiler semantics.
641 if (Cursor.kind == CXCursor_ObjCInterfaceDecl) {
642 ObjCInterfaceDecl *ID = cast<ObjCInterfaceDecl>(D);
643 if (!ID->isThisDeclarationADefinition())
644 Cursor = MakeCursorObjCClassRef(ID, ID->getLocation(), TU);
646 } else if (Cursor.kind == CXCursor_ObjCProtocolDecl) {
647 ObjCProtocolDecl *PD = cast<ObjCProtocolDecl>(D);
648 if (!PD->isThisDeclarationADefinition())
649 Cursor = MakeCursorObjCProtocolRef(PD, PD->getLocation(), TU);
652 const Optional<bool> &V = shouldVisitCursor(Cursor);
657 if (Visit(Cursor, true))
663 bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
664 llvm_unreachable("Translation units are visited directly by Visit()");
667 bool CursorVisitor::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
668 if (VisitTemplateParameters(D->getTemplateParameters()))
671 return Visit(MakeCXCursor(D->getTemplatedDecl(), TU, RegionOfInterest));
674 bool CursorVisitor::VisitTypeAliasDecl(TypeAliasDecl *D) {
675 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
676 return Visit(TSInfo->getTypeLoc());
681 bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
682 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
683 return Visit(TSInfo->getTypeLoc());
688 bool CursorVisitor::VisitTagDecl(TagDecl *D) {
689 return VisitDeclContext(D);
692 bool CursorVisitor::VisitClassTemplateSpecializationDecl(
693 ClassTemplateSpecializationDecl *D) {
694 bool ShouldVisitBody = false;
695 switch (D->getSpecializationKind()) {
697 case TSK_ImplicitInstantiation:
701 case TSK_ExplicitInstantiationDeclaration:
702 case TSK_ExplicitInstantiationDefinition:
705 case TSK_ExplicitSpecialization:
706 ShouldVisitBody = true;
710 // Visit the template arguments used in the specialization.
711 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
712 TypeLoc TL = SpecType->getTypeLoc();
713 if (TemplateSpecializationTypeLoc TSTLoc =
714 TL.getAs<TemplateSpecializationTypeLoc>()) {
715 for (unsigned I = 0, N = TSTLoc.getNumArgs(); I != N; ++I)
716 if (VisitTemplateArgumentLoc(TSTLoc.getArgLoc(I)))
721 return ShouldVisitBody && VisitCXXRecordDecl(D);
724 bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
725 ClassTemplatePartialSpecializationDecl *D) {
726 // FIXME: Visit the "outer" template parameter lists on the TagDecl
727 // before visiting these template parameters.
728 if (VisitTemplateParameters(D->getTemplateParameters()))
731 // Visit the partial specialization arguments.
732 const ASTTemplateArgumentListInfo *Info = D->getTemplateArgsAsWritten();
733 const TemplateArgumentLoc *TemplateArgs = Info->getTemplateArgs();
734 for (unsigned I = 0, N = Info->NumTemplateArgs; I != N; ++I)
735 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
738 return VisitCXXRecordDecl(D);
741 bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
742 // Visit the default argument.
743 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
744 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
745 if (Visit(DefArg->getTypeLoc()))
751 bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
752 if (Expr *Init = D->getInitExpr())
753 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
757 bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
758 unsigned NumParamList = DD->getNumTemplateParameterLists();
759 for (unsigned i = 0; i < NumParamList; i++) {
760 TemplateParameterList* Params = DD->getTemplateParameterList(i);
761 if (VisitTemplateParameters(Params))
765 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
766 if (Visit(TSInfo->getTypeLoc()))
769 // Visit the nested-name-specifier, if present.
770 if (NestedNameSpecifierLoc QualifierLoc = DD->getQualifierLoc())
771 if (VisitNestedNameSpecifierLoc(QualifierLoc))
777 /// \brief Compare two base or member initializers based on their source order.
778 static int CompareCXXCtorInitializers(CXXCtorInitializer *const *X,
779 CXXCtorInitializer *const *Y) {
780 return (*X)->getSourceOrder() - (*Y)->getSourceOrder();
783 bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
784 unsigned NumParamList = ND->getNumTemplateParameterLists();
785 for (unsigned i = 0; i < NumParamList; i++) {
786 TemplateParameterList* Params = ND->getTemplateParameterList(i);
787 if (VisitTemplateParameters(Params))
791 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
792 // Visit the function declaration's syntactic components in the order
793 // written. This requires a bit of work.
794 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
795 FunctionTypeLoc FTL = TL.getAs<FunctionTypeLoc>();
797 // If we have a function declared directly (without the use of a typedef),
798 // visit just the return type. Otherwise, just visit the function's type
800 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL.getReturnLoc())) ||
804 // Visit the nested-name-specifier, if present.
805 if (NestedNameSpecifierLoc QualifierLoc = ND->getQualifierLoc())
806 if (VisitNestedNameSpecifierLoc(QualifierLoc))
809 // Visit the declaration name.
810 if (!isa<CXXDestructorDecl>(ND))
811 if (VisitDeclarationNameInfo(ND->getNameInfo()))
814 // FIXME: Visit explicitly-specified template arguments!
816 // Visit the function parameters, if we have a function type.
817 if (FTL && VisitFunctionTypeLoc(FTL, true))
820 // FIXME: Attributes?
823 if (ND->doesThisDeclarationHaveABody() && !ND->isLateTemplateParsed()) {
824 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
825 // Find the initializers that were written in the source.
826 SmallVector<CXXCtorInitializer *, 4> WrittenInits;
827 for (auto *I : Constructor->inits()) {
831 WrittenInits.push_back(I);
834 // Sort the initializers in source order
835 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
836 &CompareCXXCtorInitializers);
838 // Visit the initializers in source order
839 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
840 CXXCtorInitializer *Init = WrittenInits[I];
841 if (Init->isAnyMemberInitializer()) {
842 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
843 Init->getMemberLocation(), TU)))
845 } else if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo()) {
846 if (Visit(TInfo->getTypeLoc()))
850 // Visit the initializer value.
851 if (Expr *Initializer = Init->getInit())
852 if (Visit(MakeCXCursor(Initializer, ND, TU, RegionOfInterest)))
857 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
864 bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
865 if (VisitDeclaratorDecl(D))
868 if (Expr *BitWidth = D->getBitWidth())
869 return Visit(MakeCXCursor(BitWidth, StmtParent, TU, RegionOfInterest));
874 bool CursorVisitor::VisitVarDecl(VarDecl *D) {
875 if (VisitDeclaratorDecl(D))
878 if (Expr *Init = D->getInit())
879 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
884 bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
885 if (VisitDeclaratorDecl(D))
888 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
889 if (Expr *DefArg = D->getDefaultArgument())
890 return Visit(MakeCXCursor(DefArg, StmtParent, TU, RegionOfInterest));
895 bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
896 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
897 // before visiting these template parameters.
898 if (VisitTemplateParameters(D->getTemplateParameters()))
901 return VisitFunctionDecl(D->getTemplatedDecl());
904 bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
905 // FIXME: Visit the "outer" template parameter lists on the TagDecl
906 // before visiting these template parameters.
907 if (VisitTemplateParameters(D->getTemplateParameters()))
910 return VisitCXXRecordDecl(D->getTemplatedDecl());
913 bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
914 if (VisitTemplateParameters(D->getTemplateParameters()))
917 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
918 VisitTemplateArgumentLoc(D->getDefaultArgument()))
924 bool CursorVisitor::VisitObjCTypeParamDecl(ObjCTypeParamDecl *D) {
925 // Visit the bound, if it's explicit.
926 if (D->hasExplicitBound()) {
927 if (auto TInfo = D->getTypeSourceInfo()) {
928 if (Visit(TInfo->getTypeLoc()))
936 bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
937 if (TypeSourceInfo *TSInfo = ND->getReturnTypeSourceInfo())
938 if (Visit(TSInfo->getTypeLoc()))
941 for (const auto *P : ND->params()) {
942 if (Visit(MakeCXCursor(P, TU, RegionOfInterest)))
946 return ND->isThisDeclarationADefinition() &&
947 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest));
950 template <typename DeclIt>
951 static void addRangedDeclsInContainer(DeclIt *DI_current, DeclIt DE_current,
952 SourceManager &SM, SourceLocation EndLoc,
953 SmallVectorImpl<Decl *> &Decls) {
954 DeclIt next = *DI_current;
955 while (++next != DE_current) {
956 Decl *D_next = *next;
959 SourceLocation L = D_next->getLocStart();
962 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
964 Decls.push_back(D_next);
971 bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
972 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
973 // an @implementation can lexically contain Decls that are not properly
974 // nested in the AST. When we identify such cases, we need to retrofit
975 // this nesting here.
976 if (!DI_current && !FileDI_current)
977 return VisitDeclContext(D);
979 // Scan the Decls that immediately come after the container
980 // in the current DeclContext. If any fall within the
981 // container's lexical region, stash them into a vector
982 // for later processing.
983 SmallVector<Decl *, 24> DeclsInContainer;
984 SourceLocation EndLoc = D->getSourceRange().getEnd();
985 SourceManager &SM = AU->getSourceManager();
986 if (EndLoc.isValid()) {
988 addRangedDeclsInContainer(DI_current, DE_current, SM, EndLoc,
991 addRangedDeclsInContainer(FileDI_current, FileDE_current, SM, EndLoc,
997 if (DeclsInContainer.empty())
998 return VisitDeclContext(D);
1000 // Get all the Decls in the DeclContext, and sort them with the
1001 // additional ones we've collected. Then visit them.
1002 for (auto *SubDecl : D->decls()) {
1003 if (!SubDecl || SubDecl->getLexicalDeclContext() != D ||
1004 SubDecl->getLocStart().isInvalid())
1006 DeclsInContainer.push_back(SubDecl);
1009 // Now sort the Decls so that they appear in lexical order.
1010 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
1011 [&SM](Decl *A, Decl *B) {
1012 SourceLocation L_A = A->getLocStart();
1013 SourceLocation L_B = B->getLocStart();
1014 assert(L_A.isValid() && L_B.isValid());
1015 return SM.isBeforeInTranslationUnit(L_A, L_B);
1018 // Now visit the decls.
1019 for (SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
1020 E = DeclsInContainer.end(); I != E; ++I) {
1021 CXCursor Cursor = MakeCXCursor(*I, TU, RegionOfInterest);
1022 const Optional<bool> &V = shouldVisitCursor(Cursor);
1027 if (Visit(Cursor, true))
1033 bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
1034 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
1038 if (VisitObjCTypeParamList(ND->getTypeParamList()))
1041 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
1042 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
1043 E = ND->protocol_end(); I != E; ++I, ++PL)
1044 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1047 return VisitObjCContainerDecl(ND);
1050 bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1051 if (!PID->isThisDeclarationADefinition())
1052 return Visit(MakeCursorObjCProtocolRef(PID, PID->getLocation(), TU));
1054 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
1055 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
1056 E = PID->protocol_end(); I != E; ++I, ++PL)
1057 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1060 return VisitObjCContainerDecl(PID);
1063 bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
1064 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
1067 // FIXME: This implements a workaround with @property declarations also being
1068 // installed in the DeclContext for the @interface. Eventually this code
1069 // should be removed.
1070 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
1071 if (!CDecl || !CDecl->IsClassExtension())
1074 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
1078 IdentifierInfo *PropertyId = PD->getIdentifier();
1079 ObjCPropertyDecl *prevDecl =
1080 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId,
1081 PD->getQueryKind());
1086 // Visit synthesized methods since they will be skipped when visiting
1088 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
1089 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1090 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1093 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
1094 if (MD->isPropertyAccessor() && MD->getLexicalDeclContext() == CDecl)
1095 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
1101 bool CursorVisitor::VisitObjCTypeParamList(ObjCTypeParamList *typeParamList) {
1105 for (auto *typeParam : *typeParamList) {
1106 // Visit the type parameter.
1107 if (Visit(MakeCXCursor(typeParam, TU, RegionOfInterest)))
1114 bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
1115 if (!D->isThisDeclarationADefinition()) {
1116 // Forward declaration is treated like a reference.
1117 return Visit(MakeCursorObjCClassRef(D, D->getLocation(), TU));
1120 // Objective-C type parameters.
1121 if (VisitObjCTypeParamList(D->getTypeParamListAsWritten()))
1124 // Issue callbacks for super class.
1125 if (D->getSuperClass() &&
1126 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1127 D->getSuperClassLoc(),
1131 if (TypeSourceInfo *SuperClassTInfo = D->getSuperClassTInfo())
1132 if (Visit(SuperClassTInfo->getTypeLoc()))
1135 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1136 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1137 E = D->protocol_end(); I != E; ++I, ++PL)
1138 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1141 return VisitObjCContainerDecl(D);
1144 bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1145 return VisitObjCContainerDecl(D);
1148 bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
1149 // 'ID' could be null when dealing with invalid code.
1150 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1151 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1154 return VisitObjCImplDecl(D);
1157 bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1159 // Issue callbacks for super class.
1160 // FIXME: No source location information!
1161 if (D->getSuperClass() &&
1162 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
1163 D->getSuperClassLoc(),
1168 return VisitObjCImplDecl(D);
1171 bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1172 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1173 if (PD->isIvarNameSpecified())
1174 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1179 bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1180 return VisitDeclContext(D);
1183 bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
1184 // Visit nested-name-specifier.
1185 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1186 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1189 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1190 D->getTargetNameLoc(), TU));
1193 bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
1194 // Visit nested-name-specifier.
1195 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1196 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1200 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1203 return VisitDeclarationNameInfo(D->getNameInfo());
1206 bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
1207 // Visit nested-name-specifier.
1208 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1209 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1212 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1213 D->getIdentLocation(), TU));
1216 bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1217 // Visit nested-name-specifier.
1218 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1219 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1223 return VisitDeclarationNameInfo(D->getNameInfo());
1226 bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1227 UnresolvedUsingTypenameDecl *D) {
1228 // Visit nested-name-specifier.
1229 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1230 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1236 bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1237 switch (Name.getName().getNameKind()) {
1238 case clang::DeclarationName::Identifier:
1239 case clang::DeclarationName::CXXLiteralOperatorName:
1240 case clang::DeclarationName::CXXOperatorName:
1241 case clang::DeclarationName::CXXUsingDirective:
1244 case clang::DeclarationName::CXXConstructorName:
1245 case clang::DeclarationName::CXXDestructorName:
1246 case clang::DeclarationName::CXXConversionFunctionName:
1247 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1248 return Visit(TSInfo->getTypeLoc());
1251 case clang::DeclarationName::ObjCZeroArgSelector:
1252 case clang::DeclarationName::ObjCOneArgSelector:
1253 case clang::DeclarationName::ObjCMultiArgSelector:
1254 // FIXME: Per-identifier location info?
1258 llvm_unreachable("Invalid DeclarationName::Kind!");
1261 bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1262 SourceRange Range) {
1263 // FIXME: This whole routine is a hack to work around the lack of proper
1264 // source information in nested-name-specifiers (PR5791). Since we do have
1265 // a beginning source location, we can visit the first component of the
1266 // nested-name-specifier, if it's a single-token component.
1270 // Get the first component in the nested-name-specifier.
1271 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1274 switch (NNS->getKind()) {
1275 case NestedNameSpecifier::Namespace:
1276 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1279 case NestedNameSpecifier::NamespaceAlias:
1280 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1281 Range.getBegin(), TU));
1283 case NestedNameSpecifier::TypeSpec: {
1284 // If the type has a form where we know that the beginning of the source
1285 // range matches up with a reference cursor. Visit the appropriate reference
1287 const Type *T = NNS->getAsType();
1288 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1289 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1290 if (const TagType *Tag = dyn_cast<TagType>(T))
1291 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1292 if (const TemplateSpecializationType *TST
1293 = dyn_cast<TemplateSpecializationType>(T))
1294 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1298 case NestedNameSpecifier::TypeSpecWithTemplate:
1299 case NestedNameSpecifier::Global:
1300 case NestedNameSpecifier::Identifier:
1301 case NestedNameSpecifier::Super:
1309 CursorVisitor::VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1310 SmallVector<NestedNameSpecifierLoc, 4> Qualifiers;
1311 for (; Qualifier; Qualifier = Qualifier.getPrefix())
1312 Qualifiers.push_back(Qualifier);
1314 while (!Qualifiers.empty()) {
1315 NestedNameSpecifierLoc Q = Qualifiers.pop_back_val();
1316 NestedNameSpecifier *NNS = Q.getNestedNameSpecifier();
1317 switch (NNS->getKind()) {
1318 case NestedNameSpecifier::Namespace:
1319 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(),
1320 Q.getLocalBeginLoc(),
1326 case NestedNameSpecifier::NamespaceAlias:
1327 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1328 Q.getLocalBeginLoc(),
1334 case NestedNameSpecifier::TypeSpec:
1335 case NestedNameSpecifier::TypeSpecWithTemplate:
1336 if (Visit(Q.getTypeLoc()))
1341 case NestedNameSpecifier::Global:
1342 case NestedNameSpecifier::Identifier:
1343 case NestedNameSpecifier::Super:
1351 bool CursorVisitor::VisitTemplateParameters(
1352 const TemplateParameterList *Params) {
1356 for (TemplateParameterList::const_iterator P = Params->begin(),
1357 PEnd = Params->end();
1359 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
1366 bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1367 switch (Name.getKind()) {
1368 case TemplateName::Template:
1369 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1371 case TemplateName::OverloadedTemplate:
1372 // Visit the overloaded template set.
1373 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1378 case TemplateName::DependentTemplate:
1379 // FIXME: Visit nested-name-specifier.
1382 case TemplateName::QualifiedTemplate:
1383 // FIXME: Visit nested-name-specifier.
1384 return Visit(MakeCursorTemplateRef(
1385 Name.getAsQualifiedTemplateName()->getDecl(),
1388 case TemplateName::SubstTemplateTemplateParm:
1389 return Visit(MakeCursorTemplateRef(
1390 Name.getAsSubstTemplateTemplateParm()->getParameter(),
1393 case TemplateName::SubstTemplateTemplateParmPack:
1394 return Visit(MakeCursorTemplateRef(
1395 Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1399 llvm_unreachable("Invalid TemplateName::Kind!");
1402 bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1403 switch (TAL.getArgument().getKind()) {
1404 case TemplateArgument::Null:
1405 case TemplateArgument::Integral:
1406 case TemplateArgument::Pack:
1409 case TemplateArgument::Type:
1410 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1411 return Visit(TSInfo->getTypeLoc());
1414 case TemplateArgument::Declaration:
1415 if (Expr *E = TAL.getSourceDeclExpression())
1416 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1419 case TemplateArgument::NullPtr:
1420 if (Expr *E = TAL.getSourceNullPtrExpression())
1421 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1424 case TemplateArgument::Expression:
1425 if (Expr *E = TAL.getSourceExpression())
1426 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
1429 case TemplateArgument::Template:
1430 case TemplateArgument::TemplateExpansion:
1431 if (VisitNestedNameSpecifierLoc(TAL.getTemplateQualifierLoc()))
1434 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
1435 TAL.getTemplateNameLoc());
1438 llvm_unreachable("Invalid TemplateArgument::Kind!");
1441 bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1442 return VisitDeclContext(D);
1445 bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1446 return Visit(TL.getUnqualifiedLoc());
1449 bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1450 ASTContext &Context = AU->getASTContext();
1452 // Some builtin types (such as Objective-C's "id", "sel", and
1453 // "Class") have associated declarations. Create cursors for those.
1455 switch (TL.getTypePtr()->getKind()) {
1457 case BuiltinType::Void:
1458 case BuiltinType::NullPtr:
1459 case BuiltinType::Dependent:
1460 case BuiltinType::OCLImage1d:
1461 case BuiltinType::OCLImage1dArray:
1462 case BuiltinType::OCLImage1dBuffer:
1463 case BuiltinType::OCLImage2d:
1464 case BuiltinType::OCLImage2dArray:
1465 case BuiltinType::OCLImage2dDepth:
1466 case BuiltinType::OCLImage2dArrayDepth:
1467 case BuiltinType::OCLImage2dMSAA:
1468 case BuiltinType::OCLImage2dArrayMSAA:
1469 case BuiltinType::OCLImage2dMSAADepth:
1470 case BuiltinType::OCLImage2dArrayMSAADepth:
1471 case BuiltinType::OCLImage3d:
1472 case BuiltinType::OCLSampler:
1473 case BuiltinType::OCLEvent:
1474 case BuiltinType::OCLClkEvent:
1475 case BuiltinType::OCLQueue:
1476 case BuiltinType::OCLNDRange:
1477 case BuiltinType::OCLReserveID:
1478 #define BUILTIN_TYPE(Id, SingletonId)
1479 #define SIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1480 #define UNSIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1481 #define FLOATING_TYPE(Id, SingletonId) case BuiltinType::Id:
1482 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
1483 #include "clang/AST/BuiltinTypes.def"
1486 case BuiltinType::ObjCId:
1487 VisitType = Context.getObjCIdType();
1490 case BuiltinType::ObjCClass:
1491 VisitType = Context.getObjCClassType();
1494 case BuiltinType::ObjCSel:
1495 VisitType = Context.getObjCSelType();
1499 if (!VisitType.isNull()) {
1500 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
1501 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
1508 bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1509 return Visit(MakeCursorTypeRef(TL.getTypedefNameDecl(), TL.getNameLoc(), TU));
1512 bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1513 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1516 bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1517 if (TL.isDefinition())
1518 return Visit(MakeCXCursor(TL.getDecl(), TU, RegionOfInterest));
1520 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1523 bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1524 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1527 bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1528 return Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU));
1531 bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1532 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1535 for (unsigned I = 0, N = TL.getNumTypeArgs(); I != N; ++I) {
1536 if (Visit(TL.getTypeArgTInfo(I)->getTypeLoc()))
1540 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1541 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1549 bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
1550 return Visit(TL.getPointeeLoc());
1553 bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1554 return Visit(TL.getInnerLoc());
1557 bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1558 return Visit(TL.getPointeeLoc());
1561 bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1562 return Visit(TL.getPointeeLoc());
1565 bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1566 return Visit(TL.getPointeeLoc());
1569 bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
1570 return Visit(TL.getPointeeLoc());
1573 bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
1574 return Visit(TL.getPointeeLoc());
1577 bool CursorVisitor::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
1578 return Visit(TL.getModifiedLoc());
1581 bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1582 bool SkipResultType) {
1583 if (!SkipResultType && Visit(TL.getReturnLoc()))
1586 for (unsigned I = 0, N = TL.getNumParams(); I != N; ++I)
1587 if (Decl *D = TL.getParam(I))
1588 if (Visit(MakeCXCursor(D, TU, RegionOfInterest)))
1594 bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1595 if (Visit(TL.getElementLoc()))
1598 if (Expr *Size = TL.getSizeExpr())
1599 return Visit(MakeCXCursor(Size, StmtParent, TU, RegionOfInterest));
1604 bool CursorVisitor::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
1605 return Visit(TL.getOriginalLoc());
1608 bool CursorVisitor::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
1609 return Visit(TL.getOriginalLoc());
1612 bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1613 TemplateSpecializationTypeLoc TL) {
1614 // Visit the template name.
1615 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1616 TL.getTemplateNameLoc()))
1619 // Visit the template arguments.
1620 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1621 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1627 bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1628 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1631 bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1632 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1633 return Visit(TSInfo->getTypeLoc());
1638 bool CursorVisitor::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
1639 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1640 return Visit(TSInfo->getTypeLoc());
1645 bool CursorVisitor::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
1646 return VisitNestedNameSpecifierLoc(TL.getQualifierLoc());
1649 bool CursorVisitor::VisitDependentTemplateSpecializationTypeLoc(
1650 DependentTemplateSpecializationTypeLoc TL) {
1651 // Visit the nested-name-specifier, if there is one.
1652 if (TL.getQualifierLoc() &&
1653 VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1656 // Visit the template arguments.
1657 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1658 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1664 bool CursorVisitor::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
1665 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1668 return Visit(TL.getNamedTypeLoc());
1671 bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1672 return Visit(TL.getPatternLoc());
1675 bool CursorVisitor::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
1676 if (Expr *E = TL.getUnderlyingExpr())
1677 return Visit(MakeCXCursor(E, StmtParent, TU));
1682 bool CursorVisitor::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
1683 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1686 bool CursorVisitor::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
1687 return Visit(TL.getValueLoc());
1690 bool CursorVisitor::VisitPipeTypeLoc(PipeTypeLoc TL) {
1691 return Visit(TL.getValueLoc());
1694 #define DEFAULT_TYPELOC_IMPL(CLASS, PARENT) \
1695 bool CursorVisitor::Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
1696 return Visit##PARENT##Loc(TL); \
1699 DEFAULT_TYPELOC_IMPL(Complex, Type)
1700 DEFAULT_TYPELOC_IMPL(ConstantArray, ArrayType)
1701 DEFAULT_TYPELOC_IMPL(IncompleteArray, ArrayType)
1702 DEFAULT_TYPELOC_IMPL(VariableArray, ArrayType)
1703 DEFAULT_TYPELOC_IMPL(DependentSizedArray, ArrayType)
1704 DEFAULT_TYPELOC_IMPL(DependentSizedExtVector, Type)
1705 DEFAULT_TYPELOC_IMPL(Vector, Type)
1706 DEFAULT_TYPELOC_IMPL(ExtVector, VectorType)
1707 DEFAULT_TYPELOC_IMPL(FunctionProto, FunctionType)
1708 DEFAULT_TYPELOC_IMPL(FunctionNoProto, FunctionType)
1709 DEFAULT_TYPELOC_IMPL(Record, TagType)
1710 DEFAULT_TYPELOC_IMPL(Enum, TagType)
1711 DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParm, Type)
1712 DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParmPack, Type)
1713 DEFAULT_TYPELOC_IMPL(Auto, Type)
1715 bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1716 // Visit the nested-name-specifier, if present.
1717 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1718 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1721 if (D->isCompleteDefinition()) {
1722 for (const auto &I : D->bases()) {
1723 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(&I, TU)))
1728 return VisitTagDecl(D);
1731 bool CursorVisitor::VisitAttributes(Decl *D) {
1732 for (const auto *I : D->attrs())
1733 if (Visit(MakeCXCursor(I, D, TU)))
1739 //===----------------------------------------------------------------------===//
1740 // Data-recursive visitor methods.
1741 //===----------------------------------------------------------------------===//
1744 #define DEF_JOB(NAME, DATA, KIND)\
1745 class NAME : public VisitorJob {\
1747 NAME(const DATA *d, CXCursor parent) : \
1748 VisitorJob(parent, VisitorJob::KIND, d) {} \
1749 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
1750 const DATA *get() const { return static_cast<const DATA*>(data[0]); }\
1753 DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1754 DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
1755 DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
1756 DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
1757 DEF_JOB(SizeOfPackExprParts, SizeOfPackExpr, SizeOfPackExprPartsKind)
1758 DEF_JOB(LambdaExprParts, LambdaExpr, LambdaExprPartsKind)
1759 DEF_JOB(PostChildrenVisit, void, PostChildrenVisitKind)
1762 class ExplicitTemplateArgsVisit : public VisitorJob {
1764 ExplicitTemplateArgsVisit(const TemplateArgumentLoc *Begin,
1765 const TemplateArgumentLoc *End, CXCursor parent)
1766 : VisitorJob(parent, VisitorJob::ExplicitTemplateArgsVisitKind, Begin,
1768 static bool classof(const VisitorJob *VJ) {
1769 return VJ->getKind() == ExplicitTemplateArgsVisitKind;
1771 const TemplateArgumentLoc *begin() const {
1772 return static_cast<const TemplateArgumentLoc *>(data[0]);
1774 const TemplateArgumentLoc *end() {
1775 return static_cast<const TemplateArgumentLoc *>(data[1]);
1778 class DeclVisit : public VisitorJob {
1780 DeclVisit(const Decl *D, CXCursor parent, bool isFirst) :
1781 VisitorJob(parent, VisitorJob::DeclVisitKind,
1782 D, isFirst ? (void*) 1 : (void*) nullptr) {}
1783 static bool classof(const VisitorJob *VJ) {
1784 return VJ->getKind() == DeclVisitKind;
1786 const Decl *get() const { return static_cast<const Decl *>(data[0]); }
1787 bool isFirst() const { return data[1] != nullptr; }
1789 class TypeLocVisit : public VisitorJob {
1791 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1792 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1793 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1795 static bool classof(const VisitorJob *VJ) {
1796 return VJ->getKind() == TypeLocVisitKind;
1799 TypeLoc get() const {
1800 QualType T = QualType::getFromOpaquePtr(data[0]);
1801 return TypeLoc(T, const_cast<void *>(data[1]));
1805 class LabelRefVisit : public VisitorJob {
1807 LabelRefVisit(LabelDecl *LD, SourceLocation labelLoc, CXCursor parent)
1808 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LD,
1809 labelLoc.getPtrEncoding()) {}
1811 static bool classof(const VisitorJob *VJ) {
1812 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1814 const LabelDecl *get() const {
1815 return static_cast<const LabelDecl *>(data[0]);
1817 SourceLocation getLoc() const {
1818 return SourceLocation::getFromPtrEncoding(data[1]); }
1821 class NestedNameSpecifierLocVisit : public VisitorJob {
1823 NestedNameSpecifierLocVisit(NestedNameSpecifierLoc Qualifier, CXCursor parent)
1824 : VisitorJob(parent, VisitorJob::NestedNameSpecifierLocVisitKind,
1825 Qualifier.getNestedNameSpecifier(),
1826 Qualifier.getOpaqueData()) { }
1828 static bool classof(const VisitorJob *VJ) {
1829 return VJ->getKind() == VisitorJob::NestedNameSpecifierLocVisitKind;
1832 NestedNameSpecifierLoc get() const {
1833 return NestedNameSpecifierLoc(
1834 const_cast<NestedNameSpecifier *>(
1835 static_cast<const NestedNameSpecifier *>(data[0])),
1836 const_cast<void *>(data[1]));
1840 class DeclarationNameInfoVisit : public VisitorJob {
1842 DeclarationNameInfoVisit(const Stmt *S, CXCursor parent)
1843 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
1844 static bool classof(const VisitorJob *VJ) {
1845 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1847 DeclarationNameInfo get() const {
1848 const Stmt *S = static_cast<const Stmt *>(data[0]);
1849 switch (S->getStmtClass()) {
1851 llvm_unreachable("Unhandled Stmt");
1852 case clang::Stmt::MSDependentExistsStmtClass:
1853 return cast<MSDependentExistsStmt>(S)->getNameInfo();
1854 case Stmt::CXXDependentScopeMemberExprClass:
1855 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1856 case Stmt::DependentScopeDeclRefExprClass:
1857 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
1858 case Stmt::OMPCriticalDirectiveClass:
1859 return cast<OMPCriticalDirective>(S)->getDirectiveName();
1863 class MemberRefVisit : public VisitorJob {
1865 MemberRefVisit(const FieldDecl *D, SourceLocation L, CXCursor parent)
1866 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
1867 L.getPtrEncoding()) {}
1868 static bool classof(const VisitorJob *VJ) {
1869 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1871 const FieldDecl *get() const {
1872 return static_cast<const FieldDecl *>(data[0]);
1874 SourceLocation getLoc() const {
1875 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1878 class EnqueueVisitor : public ConstStmtVisitor<EnqueueVisitor, void> {
1879 friend class OMPClauseEnqueue;
1880 VisitorWorkList &WL;
1883 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1884 : WL(wl), Parent(parent) {}
1886 void VisitAddrLabelExpr(const AddrLabelExpr *E);
1887 void VisitBlockExpr(const BlockExpr *B);
1888 void VisitCompoundLiteralExpr(const CompoundLiteralExpr *E);
1889 void VisitCompoundStmt(const CompoundStmt *S);
1890 void VisitCXXDefaultArgExpr(const CXXDefaultArgExpr *E) { /* Do nothing. */ }
1891 void VisitMSDependentExistsStmt(const MSDependentExistsStmt *S);
1892 void VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E);
1893 void VisitCXXNewExpr(const CXXNewExpr *E);
1894 void VisitCXXScalarValueInitExpr(const CXXScalarValueInitExpr *E);
1895 void VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *E);
1896 void VisitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
1897 void VisitCXXTemporaryObjectExpr(const CXXTemporaryObjectExpr *E);
1898 void VisitCXXTypeidExpr(const CXXTypeidExpr *E);
1899 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *E);
1900 void VisitCXXUuidofExpr(const CXXUuidofExpr *E);
1901 void VisitCXXCatchStmt(const CXXCatchStmt *S);
1902 void VisitCXXForRangeStmt(const CXXForRangeStmt *S);
1903 void VisitDeclRefExpr(const DeclRefExpr *D);
1904 void VisitDeclStmt(const DeclStmt *S);
1905 void VisitDependentScopeDeclRefExpr(const DependentScopeDeclRefExpr *E);
1906 void VisitDesignatedInitExpr(const DesignatedInitExpr *E);
1907 void VisitExplicitCastExpr(const ExplicitCastExpr *E);
1908 void VisitForStmt(const ForStmt *FS);
1909 void VisitGotoStmt(const GotoStmt *GS);
1910 void VisitIfStmt(const IfStmt *If);
1911 void VisitInitListExpr(const InitListExpr *IE);
1912 void VisitMemberExpr(const MemberExpr *M);
1913 void VisitOffsetOfExpr(const OffsetOfExpr *E);
1914 void VisitObjCEncodeExpr(const ObjCEncodeExpr *E);
1915 void VisitObjCMessageExpr(const ObjCMessageExpr *M);
1916 void VisitOverloadExpr(const OverloadExpr *E);
1917 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *E);
1918 void VisitStmt(const Stmt *S);
1919 void VisitSwitchStmt(const SwitchStmt *S);
1920 void VisitWhileStmt(const WhileStmt *W);
1921 void VisitTypeTraitExpr(const TypeTraitExpr *E);
1922 void VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E);
1923 void VisitExpressionTraitExpr(const ExpressionTraitExpr *E);
1924 void VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U);
1925 void VisitVAArgExpr(const VAArgExpr *E);
1926 void VisitSizeOfPackExpr(const SizeOfPackExpr *E);
1927 void VisitPseudoObjectExpr(const PseudoObjectExpr *E);
1928 void VisitOpaqueValueExpr(const OpaqueValueExpr *E);
1929 void VisitLambdaExpr(const LambdaExpr *E);
1930 void VisitOMPExecutableDirective(const OMPExecutableDirective *D);
1931 void VisitOMPLoopDirective(const OMPLoopDirective *D);
1932 void VisitOMPParallelDirective(const OMPParallelDirective *D);
1933 void VisitOMPSimdDirective(const OMPSimdDirective *D);
1934 void VisitOMPForDirective(const OMPForDirective *D);
1935 void VisitOMPForSimdDirective(const OMPForSimdDirective *D);
1936 void VisitOMPSectionsDirective(const OMPSectionsDirective *D);
1937 void VisitOMPSectionDirective(const OMPSectionDirective *D);
1938 void VisitOMPSingleDirective(const OMPSingleDirective *D);
1939 void VisitOMPMasterDirective(const OMPMasterDirective *D);
1940 void VisitOMPCriticalDirective(const OMPCriticalDirective *D);
1941 void VisitOMPParallelForDirective(const OMPParallelForDirective *D);
1942 void VisitOMPParallelForSimdDirective(const OMPParallelForSimdDirective *D);
1943 void VisitOMPParallelSectionsDirective(const OMPParallelSectionsDirective *D);
1944 void VisitOMPTaskDirective(const OMPTaskDirective *D);
1945 void VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D);
1946 void VisitOMPBarrierDirective(const OMPBarrierDirective *D);
1947 void VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D);
1948 void VisitOMPTaskgroupDirective(const OMPTaskgroupDirective *D);
1950 VisitOMPCancellationPointDirective(const OMPCancellationPointDirective *D);
1951 void VisitOMPCancelDirective(const OMPCancelDirective *D);
1952 void VisitOMPFlushDirective(const OMPFlushDirective *D);
1953 void VisitOMPOrderedDirective(const OMPOrderedDirective *D);
1954 void VisitOMPAtomicDirective(const OMPAtomicDirective *D);
1955 void VisitOMPTargetDirective(const OMPTargetDirective *D);
1956 void VisitOMPTargetDataDirective(const OMPTargetDataDirective *D);
1957 void VisitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective *D);
1958 void VisitOMPTargetExitDataDirective(const OMPTargetExitDataDirective *D);
1959 void VisitOMPTargetParallelDirective(const OMPTargetParallelDirective *D);
1960 void VisitOMPTeamsDirective(const OMPTeamsDirective *D);
1961 void VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D);
1962 void VisitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective *D);
1963 void VisitOMPDistributeDirective(const OMPDistributeDirective *D);
1966 void AddDeclarationNameInfo(const Stmt *S);
1967 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
1968 void AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
1969 unsigned NumTemplateArgs);
1970 void AddMemberRef(const FieldDecl *D, SourceLocation L);
1971 void AddStmt(const Stmt *S);
1972 void AddDecl(const Decl *D, bool isFirst = true);
1973 void AddTypeLoc(TypeSourceInfo *TI);
1974 void EnqueueChildren(const Stmt *S);
1975 void EnqueueChildren(const OMPClause *S);
1977 } // end anonyous namespace
1979 void EnqueueVisitor::AddDeclarationNameInfo(const Stmt *S) {
1980 // 'S' should always be non-null, since it comes from the
1981 // statement we are visiting.
1982 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1986 EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1988 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
1991 void EnqueueVisitor::AddStmt(const Stmt *S) {
1993 WL.push_back(StmtVisit(S, Parent));
1995 void EnqueueVisitor::AddDecl(const Decl *D, bool isFirst) {
1997 WL.push_back(DeclVisit(D, Parent, isFirst));
1999 void EnqueueVisitor::AddExplicitTemplateArgs(const TemplateArgumentLoc *A,
2000 unsigned NumTemplateArgs) {
2001 WL.push_back(ExplicitTemplateArgsVisit(A, A + NumTemplateArgs, Parent));
2003 void EnqueueVisitor::AddMemberRef(const FieldDecl *D, SourceLocation L) {
2005 WL.push_back(MemberRefVisit(D, L, Parent));
2007 void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
2009 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
2011 void EnqueueVisitor::EnqueueChildren(const Stmt *S) {
2012 unsigned size = WL.size();
2013 for (const Stmt *SubStmt : S->children()) {
2016 if (size == WL.size())
2018 // Now reverse the entries we just added. This will match the DFS
2019 // ordering performed by the worklist.
2020 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2024 class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> {
2025 EnqueueVisitor *Visitor;
2026 /// \brief Process clauses with list of variables.
2027 template <typename T>
2028 void VisitOMPClauseList(T *Node);
2030 OMPClauseEnqueue(EnqueueVisitor *Visitor) : Visitor(Visitor) { }
2031 #define OPENMP_CLAUSE(Name, Class) \
2032 void Visit##Class(const Class *C);
2033 #include "clang/Basic/OpenMPKinds.def"
2036 void OMPClauseEnqueue::VisitOMPIfClause(const OMPIfClause *C) {
2037 Visitor->AddStmt(C->getCondition());
2040 void OMPClauseEnqueue::VisitOMPFinalClause(const OMPFinalClause *C) {
2041 Visitor->AddStmt(C->getCondition());
2044 void OMPClauseEnqueue::VisitOMPNumThreadsClause(const OMPNumThreadsClause *C) {
2045 Visitor->AddStmt(C->getNumThreads());
2048 void OMPClauseEnqueue::VisitOMPSafelenClause(const OMPSafelenClause *C) {
2049 Visitor->AddStmt(C->getSafelen());
2052 void OMPClauseEnqueue::VisitOMPSimdlenClause(const OMPSimdlenClause *C) {
2053 Visitor->AddStmt(C->getSimdlen());
2056 void OMPClauseEnqueue::VisitOMPCollapseClause(const OMPCollapseClause *C) {
2057 Visitor->AddStmt(C->getNumForLoops());
2060 void OMPClauseEnqueue::VisitOMPDefaultClause(const OMPDefaultClause *C) { }
2062 void OMPClauseEnqueue::VisitOMPProcBindClause(const OMPProcBindClause *C) { }
2064 void OMPClauseEnqueue::VisitOMPScheduleClause(const OMPScheduleClause *C) {
2065 Visitor->AddStmt(C->getChunkSize());
2066 Visitor->AddStmt(C->getHelperChunkSize());
2069 void OMPClauseEnqueue::VisitOMPOrderedClause(const OMPOrderedClause *C) {
2070 Visitor->AddStmt(C->getNumForLoops());
2073 void OMPClauseEnqueue::VisitOMPNowaitClause(const OMPNowaitClause *) {}
2075 void OMPClauseEnqueue::VisitOMPUntiedClause(const OMPUntiedClause *) {}
2077 void OMPClauseEnqueue::VisitOMPMergeableClause(const OMPMergeableClause *) {}
2079 void OMPClauseEnqueue::VisitOMPReadClause(const OMPReadClause *) {}
2081 void OMPClauseEnqueue::VisitOMPWriteClause(const OMPWriteClause *) {}
2083 void OMPClauseEnqueue::VisitOMPUpdateClause(const OMPUpdateClause *) {}
2085 void OMPClauseEnqueue::VisitOMPCaptureClause(const OMPCaptureClause *) {}
2087 void OMPClauseEnqueue::VisitOMPSeqCstClause(const OMPSeqCstClause *) {}
2089 void OMPClauseEnqueue::VisitOMPThreadsClause(const OMPThreadsClause *) {}
2091 void OMPClauseEnqueue::VisitOMPSIMDClause(const OMPSIMDClause *) {}
2093 void OMPClauseEnqueue::VisitOMPNogroupClause(const OMPNogroupClause *) {}
2095 void OMPClauseEnqueue::VisitOMPDeviceClause(const OMPDeviceClause *C) {
2096 Visitor->AddStmt(C->getDevice());
2099 void OMPClauseEnqueue::VisitOMPNumTeamsClause(const OMPNumTeamsClause *C) {
2100 Visitor->AddStmt(C->getNumTeams());
2103 void OMPClauseEnqueue::VisitOMPThreadLimitClause(const OMPThreadLimitClause *C) {
2104 Visitor->AddStmt(C->getThreadLimit());
2107 void OMPClauseEnqueue::VisitOMPPriorityClause(const OMPPriorityClause *C) {
2108 Visitor->AddStmt(C->getPriority());
2111 void OMPClauseEnqueue::VisitOMPGrainsizeClause(const OMPGrainsizeClause *C) {
2112 Visitor->AddStmt(C->getGrainsize());
2115 void OMPClauseEnqueue::VisitOMPNumTasksClause(const OMPNumTasksClause *C) {
2116 Visitor->AddStmt(C->getNumTasks());
2119 void OMPClauseEnqueue::VisitOMPHintClause(const OMPHintClause *C) {
2120 Visitor->AddStmt(C->getHint());
2123 template<typename T>
2124 void OMPClauseEnqueue::VisitOMPClauseList(T *Node) {
2125 for (const auto *I : Node->varlists()) {
2126 Visitor->AddStmt(I);
2130 void OMPClauseEnqueue::VisitOMPPrivateClause(const OMPPrivateClause *C) {
2131 VisitOMPClauseList(C);
2132 for (const auto *E : C->private_copies()) {
2133 Visitor->AddStmt(E);
2136 void OMPClauseEnqueue::VisitOMPFirstprivateClause(
2137 const OMPFirstprivateClause *C) {
2138 VisitOMPClauseList(C);
2140 void OMPClauseEnqueue::VisitOMPLastprivateClause(
2141 const OMPLastprivateClause *C) {
2142 VisitOMPClauseList(C);
2143 for (auto *E : C->private_copies()) {
2144 Visitor->AddStmt(E);
2146 for (auto *E : C->source_exprs()) {
2147 Visitor->AddStmt(E);
2149 for (auto *E : C->destination_exprs()) {
2150 Visitor->AddStmt(E);
2152 for (auto *E : C->assignment_ops()) {
2153 Visitor->AddStmt(E);
2156 void OMPClauseEnqueue::VisitOMPSharedClause(const OMPSharedClause *C) {
2157 VisitOMPClauseList(C);
2159 void OMPClauseEnqueue::VisitOMPReductionClause(const OMPReductionClause *C) {
2160 VisitOMPClauseList(C);
2161 for (auto *E : C->privates()) {
2162 Visitor->AddStmt(E);
2164 for (auto *E : C->lhs_exprs()) {
2165 Visitor->AddStmt(E);
2167 for (auto *E : C->rhs_exprs()) {
2168 Visitor->AddStmt(E);
2170 for (auto *E : C->reduction_ops()) {
2171 Visitor->AddStmt(E);
2174 void OMPClauseEnqueue::VisitOMPLinearClause(const OMPLinearClause *C) {
2175 VisitOMPClauseList(C);
2176 for (const auto *E : C->privates()) {
2177 Visitor->AddStmt(E);
2179 for (const auto *E : C->inits()) {
2180 Visitor->AddStmt(E);
2182 for (const auto *E : C->updates()) {
2183 Visitor->AddStmt(E);
2185 for (const auto *E : C->finals()) {
2186 Visitor->AddStmt(E);
2188 Visitor->AddStmt(C->getStep());
2189 Visitor->AddStmt(C->getCalcStep());
2191 void OMPClauseEnqueue::VisitOMPAlignedClause(const OMPAlignedClause *C) {
2192 VisitOMPClauseList(C);
2193 Visitor->AddStmt(C->getAlignment());
2195 void OMPClauseEnqueue::VisitOMPCopyinClause(const OMPCopyinClause *C) {
2196 VisitOMPClauseList(C);
2197 for (auto *E : C->source_exprs()) {
2198 Visitor->AddStmt(E);
2200 for (auto *E : C->destination_exprs()) {
2201 Visitor->AddStmt(E);
2203 for (auto *E : C->assignment_ops()) {
2204 Visitor->AddStmt(E);
2208 OMPClauseEnqueue::VisitOMPCopyprivateClause(const OMPCopyprivateClause *C) {
2209 VisitOMPClauseList(C);
2210 for (auto *E : C->source_exprs()) {
2211 Visitor->AddStmt(E);
2213 for (auto *E : C->destination_exprs()) {
2214 Visitor->AddStmt(E);
2216 for (auto *E : C->assignment_ops()) {
2217 Visitor->AddStmt(E);
2220 void OMPClauseEnqueue::VisitOMPFlushClause(const OMPFlushClause *C) {
2221 VisitOMPClauseList(C);
2223 void OMPClauseEnqueue::VisitOMPDependClause(const OMPDependClause *C) {
2224 VisitOMPClauseList(C);
2226 void OMPClauseEnqueue::VisitOMPMapClause(const OMPMapClause *C) {
2227 VisitOMPClauseList(C);
2229 void OMPClauseEnqueue::VisitOMPDistScheduleClause(
2230 const OMPDistScheduleClause *C) {
2231 Visitor->AddStmt(C->getChunkSize());
2232 Visitor->AddStmt(C->getHelperChunkSize());
2234 void OMPClauseEnqueue::VisitOMPDefaultmapClause(const OMPDefaultmapClause *C) {
2238 void EnqueueVisitor::EnqueueChildren(const OMPClause *S) {
2239 unsigned size = WL.size();
2240 OMPClauseEnqueue Visitor(this);
2242 if (size == WL.size())
2244 // Now reverse the entries we just added. This will match the DFS
2245 // ordering performed by the worklist.
2246 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2249 void EnqueueVisitor::VisitAddrLabelExpr(const AddrLabelExpr *E) {
2250 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
2252 void EnqueueVisitor::VisitBlockExpr(const BlockExpr *B) {
2253 AddDecl(B->getBlockDecl());
2255 void EnqueueVisitor::VisitCompoundLiteralExpr(const CompoundLiteralExpr *E) {
2257 AddTypeLoc(E->getTypeSourceInfo());
2259 void EnqueueVisitor::VisitCompoundStmt(const CompoundStmt *S) {
2260 for (auto &I : llvm::reverse(S->body()))
2263 void EnqueueVisitor::
2264 VisitMSDependentExistsStmt(const MSDependentExistsStmt *S) {
2265 AddStmt(S->getSubStmt());
2266 AddDeclarationNameInfo(S);
2267 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
2268 AddNestedNameSpecifierLoc(QualifierLoc);
2271 void EnqueueVisitor::
2272 VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *E) {
2273 if (E->hasExplicitTemplateArgs())
2274 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
2275 AddDeclarationNameInfo(E);
2276 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2277 AddNestedNameSpecifierLoc(QualifierLoc);
2278 if (!E->isImplicitAccess())
2279 AddStmt(E->getBase());
2281 void EnqueueVisitor::VisitCXXNewExpr(const CXXNewExpr *E) {
2282 // Enqueue the initializer , if any.
2283 AddStmt(E->getInitializer());
2284 // Enqueue the array size, if any.
2285 AddStmt(E->getArraySize());
2286 // Enqueue the allocated type.
2287 AddTypeLoc(E->getAllocatedTypeSourceInfo());
2288 // Enqueue the placement arguments.
2289 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
2290 AddStmt(E->getPlacementArg(I-1));
2292 void EnqueueVisitor::VisitCXXOperatorCallExpr(const CXXOperatorCallExpr *CE) {
2293 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
2294 AddStmt(CE->getArg(I-1));
2295 AddStmt(CE->getCallee());
2296 AddStmt(CE->getArg(0));
2298 void EnqueueVisitor::VisitCXXPseudoDestructorExpr(
2299 const CXXPseudoDestructorExpr *E) {
2300 // Visit the name of the type being destroyed.
2301 AddTypeLoc(E->getDestroyedTypeInfo());
2302 // Visit the scope type that looks disturbingly like the nested-name-specifier
2304 AddTypeLoc(E->getScopeTypeInfo());
2305 // Visit the nested-name-specifier.
2306 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
2307 AddNestedNameSpecifierLoc(QualifierLoc);
2308 // Visit base expression.
2309 AddStmt(E->getBase());
2311 void EnqueueVisitor::VisitCXXScalarValueInitExpr(
2312 const CXXScalarValueInitExpr *E) {
2313 AddTypeLoc(E->getTypeSourceInfo());
2315 void EnqueueVisitor::VisitCXXTemporaryObjectExpr(
2316 const CXXTemporaryObjectExpr *E) {
2318 AddTypeLoc(E->getTypeSourceInfo());
2320 void EnqueueVisitor::VisitCXXTypeidExpr(const CXXTypeidExpr *E) {
2322 if (E->isTypeOperand())
2323 AddTypeLoc(E->getTypeOperandSourceInfo());
2326 void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(
2327 const CXXUnresolvedConstructExpr *E) {
2329 AddTypeLoc(E->getTypeSourceInfo());
2331 void EnqueueVisitor::VisitCXXUuidofExpr(const CXXUuidofExpr *E) {
2333 if (E->isTypeOperand())
2334 AddTypeLoc(E->getTypeOperandSourceInfo());
2337 void EnqueueVisitor::VisitCXXCatchStmt(const CXXCatchStmt *S) {
2339 AddDecl(S->getExceptionDecl());
2342 void EnqueueVisitor::VisitCXXForRangeStmt(const CXXForRangeStmt *S) {
2343 AddStmt(S->getBody());
2344 AddStmt(S->getRangeInit());
2345 AddDecl(S->getLoopVariable());
2348 void EnqueueVisitor::VisitDeclRefExpr(const DeclRefExpr *DR) {
2349 if (DR->hasExplicitTemplateArgs())
2350 AddExplicitTemplateArgs(DR->getTemplateArgs(), DR->getNumTemplateArgs());
2351 WL.push_back(DeclRefExprParts(DR, Parent));
2353 void EnqueueVisitor::VisitDependentScopeDeclRefExpr(
2354 const DependentScopeDeclRefExpr *E) {
2355 if (E->hasExplicitTemplateArgs())
2356 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
2357 AddDeclarationNameInfo(E);
2358 AddNestedNameSpecifierLoc(E->getQualifierLoc());
2360 void EnqueueVisitor::VisitDeclStmt(const DeclStmt *S) {
2361 unsigned size = WL.size();
2362 bool isFirst = true;
2363 for (const auto *D : S->decls()) {
2364 AddDecl(D, isFirst);
2367 if (size == WL.size())
2369 // Now reverse the entries we just added. This will match the DFS
2370 // ordering performed by the worklist.
2371 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
2374 void EnqueueVisitor::VisitDesignatedInitExpr(const DesignatedInitExpr *E) {
2375 AddStmt(E->getInit());
2376 for (DesignatedInitExpr::const_reverse_designators_iterator
2377 D = E->designators_rbegin(), DEnd = E->designators_rend();
2379 if (D->isFieldDesignator()) {
2380 if (FieldDecl *Field = D->getField())
2381 AddMemberRef(Field, D->getFieldLoc());
2384 if (D->isArrayDesignator()) {
2385 AddStmt(E->getArrayIndex(*D));
2388 assert(D->isArrayRangeDesignator() && "Unknown designator kind");
2389 AddStmt(E->getArrayRangeEnd(*D));
2390 AddStmt(E->getArrayRangeStart(*D));
2393 void EnqueueVisitor::VisitExplicitCastExpr(const ExplicitCastExpr *E) {
2395 AddTypeLoc(E->getTypeInfoAsWritten());
2397 void EnqueueVisitor::VisitForStmt(const ForStmt *FS) {
2398 AddStmt(FS->getBody());
2399 AddStmt(FS->getInc());
2400 AddStmt(FS->getCond());
2401 AddDecl(FS->getConditionVariable());
2402 AddStmt(FS->getInit());
2404 void EnqueueVisitor::VisitGotoStmt(const GotoStmt *GS) {
2405 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2407 void EnqueueVisitor::VisitIfStmt(const IfStmt *If) {
2408 AddStmt(If->getElse());
2409 AddStmt(If->getThen());
2410 AddStmt(If->getCond());
2411 AddDecl(If->getConditionVariable());
2413 void EnqueueVisitor::VisitInitListExpr(const InitListExpr *IE) {
2414 // We care about the syntactic form of the initializer list, only.
2415 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2417 EnqueueChildren(IE);
2419 void EnqueueVisitor::VisitMemberExpr(const MemberExpr *M) {
2420 WL.push_back(MemberExprParts(M, Parent));
2422 // If the base of the member access expression is an implicit 'this', don't
2424 // FIXME: If we ever want to show these implicit accesses, this will be
2425 // unfortunate. However, clang_getCursor() relies on this behavior.
2426 if (M->isImplicitAccess())
2429 // Ignore base anonymous struct/union fields, otherwise they will shadow the
2430 // real field that that we are interested in.
2431 if (auto *SubME = dyn_cast<MemberExpr>(M->getBase())) {
2432 if (auto *FD = dyn_cast_or_null<FieldDecl>(SubME->getMemberDecl())) {
2433 if (FD->isAnonymousStructOrUnion()) {
2434 AddStmt(SubME->getBase());
2440 AddStmt(M->getBase());
2442 void EnqueueVisitor::VisitObjCEncodeExpr(const ObjCEncodeExpr *E) {
2443 AddTypeLoc(E->getEncodedTypeSourceInfo());
2445 void EnqueueVisitor::VisitObjCMessageExpr(const ObjCMessageExpr *M) {
2447 AddTypeLoc(M->getClassReceiverTypeInfo());
2449 void EnqueueVisitor::VisitOffsetOfExpr(const OffsetOfExpr *E) {
2450 // Visit the components of the offsetof expression.
2451 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
2452 const OffsetOfNode &Node = E->getComponent(I-1);
2453 switch (Node.getKind()) {
2454 case OffsetOfNode::Array:
2455 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2457 case OffsetOfNode::Field:
2458 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
2460 case OffsetOfNode::Identifier:
2461 case OffsetOfNode::Base:
2465 // Visit the type into which we're computing the offset.
2466 AddTypeLoc(E->getTypeSourceInfo());
2468 void EnqueueVisitor::VisitOverloadExpr(const OverloadExpr *E) {
2469 if (E->hasExplicitTemplateArgs())
2470 AddExplicitTemplateArgs(E->getTemplateArgs(), E->getNumTemplateArgs());
2471 WL.push_back(OverloadExprParts(E, Parent));
2473 void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
2474 const UnaryExprOrTypeTraitExpr *E) {
2476 if (E->isArgumentType())
2477 AddTypeLoc(E->getArgumentTypeInfo());
2479 void EnqueueVisitor::VisitStmt(const Stmt *S) {
2482 void EnqueueVisitor::VisitSwitchStmt(const SwitchStmt *S) {
2483 AddStmt(S->getBody());
2484 AddStmt(S->getCond());
2485 AddDecl(S->getConditionVariable());
2488 void EnqueueVisitor::VisitWhileStmt(const WhileStmt *W) {
2489 AddStmt(W->getBody());
2490 AddStmt(W->getCond());
2491 AddDecl(W->getConditionVariable());
2494 void EnqueueVisitor::VisitTypeTraitExpr(const TypeTraitExpr *E) {
2495 for (unsigned I = E->getNumArgs(); I > 0; --I)
2496 AddTypeLoc(E->getArg(I-1));
2499 void EnqueueVisitor::VisitArrayTypeTraitExpr(const ArrayTypeTraitExpr *E) {
2500 AddTypeLoc(E->getQueriedTypeSourceInfo());
2503 void EnqueueVisitor::VisitExpressionTraitExpr(const ExpressionTraitExpr *E) {
2507 void EnqueueVisitor::VisitUnresolvedMemberExpr(const UnresolvedMemberExpr *U) {
2508 VisitOverloadExpr(U);
2509 if (!U->isImplicitAccess())
2510 AddStmt(U->getBase());
2512 void EnqueueVisitor::VisitVAArgExpr(const VAArgExpr *E) {
2513 AddStmt(E->getSubExpr());
2514 AddTypeLoc(E->getWrittenTypeInfo());
2516 void EnqueueVisitor::VisitSizeOfPackExpr(const SizeOfPackExpr *E) {
2517 WL.push_back(SizeOfPackExprParts(E, Parent));
2519 void EnqueueVisitor::VisitOpaqueValueExpr(const OpaqueValueExpr *E) {
2520 // If the opaque value has a source expression, just transparently
2521 // visit that. This is useful for (e.g.) pseudo-object expressions.
2522 if (Expr *SourceExpr = E->getSourceExpr())
2523 return Visit(SourceExpr);
2525 void EnqueueVisitor::VisitLambdaExpr(const LambdaExpr *E) {
2526 AddStmt(E->getBody());
2527 WL.push_back(LambdaExprParts(E, Parent));
2529 void EnqueueVisitor::VisitPseudoObjectExpr(const PseudoObjectExpr *E) {
2530 // Treat the expression like its syntactic form.
2531 Visit(E->getSyntacticForm());
2534 void EnqueueVisitor::VisitOMPExecutableDirective(
2535 const OMPExecutableDirective *D) {
2537 for (ArrayRef<OMPClause *>::iterator I = D->clauses().begin(),
2538 E = D->clauses().end();
2540 EnqueueChildren(*I);
2543 void EnqueueVisitor::VisitOMPLoopDirective(const OMPLoopDirective *D) {
2544 VisitOMPExecutableDirective(D);
2547 void EnqueueVisitor::VisitOMPParallelDirective(const OMPParallelDirective *D) {
2548 VisitOMPExecutableDirective(D);
2551 void EnqueueVisitor::VisitOMPSimdDirective(const OMPSimdDirective *D) {
2552 VisitOMPLoopDirective(D);
2555 void EnqueueVisitor::VisitOMPForDirective(const OMPForDirective *D) {
2556 VisitOMPLoopDirective(D);
2559 void EnqueueVisitor::VisitOMPForSimdDirective(const OMPForSimdDirective *D) {
2560 VisitOMPLoopDirective(D);
2563 void EnqueueVisitor::VisitOMPSectionsDirective(const OMPSectionsDirective *D) {
2564 VisitOMPExecutableDirective(D);
2567 void EnqueueVisitor::VisitOMPSectionDirective(const OMPSectionDirective *D) {
2568 VisitOMPExecutableDirective(D);
2571 void EnqueueVisitor::VisitOMPSingleDirective(const OMPSingleDirective *D) {
2572 VisitOMPExecutableDirective(D);
2575 void EnqueueVisitor::VisitOMPMasterDirective(const OMPMasterDirective *D) {
2576 VisitOMPExecutableDirective(D);
2579 void EnqueueVisitor::VisitOMPCriticalDirective(const OMPCriticalDirective *D) {
2580 VisitOMPExecutableDirective(D);
2581 AddDeclarationNameInfo(D);
2585 EnqueueVisitor::VisitOMPParallelForDirective(const OMPParallelForDirective *D) {
2586 VisitOMPLoopDirective(D);
2589 void EnqueueVisitor::VisitOMPParallelForSimdDirective(
2590 const OMPParallelForSimdDirective *D) {
2591 VisitOMPLoopDirective(D);
2594 void EnqueueVisitor::VisitOMPParallelSectionsDirective(
2595 const OMPParallelSectionsDirective *D) {
2596 VisitOMPExecutableDirective(D);
2599 void EnqueueVisitor::VisitOMPTaskDirective(const OMPTaskDirective *D) {
2600 VisitOMPExecutableDirective(D);
2604 EnqueueVisitor::VisitOMPTaskyieldDirective(const OMPTaskyieldDirective *D) {
2605 VisitOMPExecutableDirective(D);
2608 void EnqueueVisitor::VisitOMPBarrierDirective(const OMPBarrierDirective *D) {
2609 VisitOMPExecutableDirective(D);
2612 void EnqueueVisitor::VisitOMPTaskwaitDirective(const OMPTaskwaitDirective *D) {
2613 VisitOMPExecutableDirective(D);
2616 void EnqueueVisitor::VisitOMPTaskgroupDirective(
2617 const OMPTaskgroupDirective *D) {
2618 VisitOMPExecutableDirective(D);
2621 void EnqueueVisitor::VisitOMPFlushDirective(const OMPFlushDirective *D) {
2622 VisitOMPExecutableDirective(D);
2625 void EnqueueVisitor::VisitOMPOrderedDirective(const OMPOrderedDirective *D) {
2626 VisitOMPExecutableDirective(D);
2629 void EnqueueVisitor::VisitOMPAtomicDirective(const OMPAtomicDirective *D) {
2630 VisitOMPExecutableDirective(D);
2633 void EnqueueVisitor::VisitOMPTargetDirective(const OMPTargetDirective *D) {
2634 VisitOMPExecutableDirective(D);
2637 void EnqueueVisitor::VisitOMPTargetDataDirective(const
2638 OMPTargetDataDirective *D) {
2639 VisitOMPExecutableDirective(D);
2642 void EnqueueVisitor::VisitOMPTargetEnterDataDirective(
2643 const OMPTargetEnterDataDirective *D) {
2644 VisitOMPExecutableDirective(D);
2647 void EnqueueVisitor::VisitOMPTargetExitDataDirective(
2648 const OMPTargetExitDataDirective *D) {
2649 VisitOMPExecutableDirective(D);
2652 void EnqueueVisitor::VisitOMPTargetParallelDirective(
2653 const OMPTargetParallelDirective *D) {
2654 VisitOMPExecutableDirective(D);
2657 void EnqueueVisitor::VisitOMPTeamsDirective(const OMPTeamsDirective *D) {
2658 VisitOMPExecutableDirective(D);
2661 void EnqueueVisitor::VisitOMPCancellationPointDirective(
2662 const OMPCancellationPointDirective *D) {
2663 VisitOMPExecutableDirective(D);
2666 void EnqueueVisitor::VisitOMPCancelDirective(const OMPCancelDirective *D) {
2667 VisitOMPExecutableDirective(D);
2670 void EnqueueVisitor::VisitOMPTaskLoopDirective(const OMPTaskLoopDirective *D) {
2671 VisitOMPLoopDirective(D);
2674 void EnqueueVisitor::VisitOMPTaskLoopSimdDirective(
2675 const OMPTaskLoopSimdDirective *D) {
2676 VisitOMPLoopDirective(D);
2679 void EnqueueVisitor::VisitOMPDistributeDirective(
2680 const OMPDistributeDirective *D) {
2681 VisitOMPLoopDirective(D);
2684 void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, const Stmt *S) {
2685 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
2688 bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2689 if (RegionOfInterest.isValid()) {
2690 SourceRange Range = getRawCursorExtent(C);
2691 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2697 bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2698 while (!WL.empty()) {
2699 // Dequeue the worklist item.
2700 VisitorJob LI = WL.pop_back_val();
2702 // Set the Parent field, then back to its old value once we're done.
2703 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2705 switch (LI.getKind()) {
2706 case VisitorJob::DeclVisitKind: {
2707 const Decl *D = cast<DeclVisit>(&LI)->get();
2711 // For now, perform default visitation for Decls.
2712 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2713 cast<DeclVisit>(&LI)->isFirst())))
2718 case VisitorJob::ExplicitTemplateArgsVisitKind: {
2719 for (const TemplateArgumentLoc &Arg :
2720 *cast<ExplicitTemplateArgsVisit>(&LI)) {
2721 if (VisitTemplateArgumentLoc(Arg))
2726 case VisitorJob::TypeLocVisitKind: {
2727 // Perform default visitation for TypeLocs.
2728 if (Visit(cast<TypeLocVisit>(&LI)->get()))
2732 case VisitorJob::LabelRefVisitKind: {
2733 const LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
2734 if (LabelStmt *stmt = LS->getStmt()) {
2735 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2743 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2744 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2745 if (VisitNestedNameSpecifierLoc(V->get()))
2750 case VisitorJob::DeclarationNameInfoVisitKind: {
2751 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2756 case VisitorJob::MemberRefVisitKind: {
2757 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2758 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2762 case VisitorJob::StmtVisitKind: {
2763 const Stmt *S = cast<StmtVisit>(&LI)->get();
2767 // Update the current cursor.
2768 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
2769 if (!IsInRegionOfInterest(Cursor))
2771 switch (Visitor(Cursor, Parent, ClientData)) {
2772 case CXChildVisit_Break: return true;
2773 case CXChildVisit_Continue: break;
2774 case CXChildVisit_Recurse:
2775 if (PostChildrenVisitor)
2776 WL.push_back(PostChildrenVisit(nullptr, Cursor));
2777 EnqueueWorkList(WL, S);
2782 case VisitorJob::MemberExprPartsKind: {
2783 // Handle the other pieces in the MemberExpr besides the base.
2784 const MemberExpr *M = cast<MemberExprParts>(&LI)->get();
2786 // Visit the nested-name-specifier
2787 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
2788 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2791 // Visit the declaration name.
2792 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2795 // Visit the explicitly-specified template arguments, if any.
2796 if (M->hasExplicitTemplateArgs()) {
2797 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2798 *ArgEnd = Arg + M->getNumTemplateArgs();
2799 Arg != ArgEnd; ++Arg) {
2800 if (VisitTemplateArgumentLoc(*Arg))
2806 case VisitorJob::DeclRefExprPartsKind: {
2807 const DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
2808 // Visit nested-name-specifier, if present.
2809 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
2810 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2812 // Visit declaration name.
2813 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2817 case VisitorJob::OverloadExprPartsKind: {
2818 const OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
2819 // Visit the nested-name-specifier.
2820 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
2821 if (VisitNestedNameSpecifierLoc(QualifierLoc))
2823 // Visit the declaration name.
2824 if (VisitDeclarationNameInfo(O->getNameInfo()))
2826 // Visit the overloaded declaration reference.
2827 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2831 case VisitorJob::SizeOfPackExprPartsKind: {
2832 const SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
2833 NamedDecl *Pack = E->getPack();
2834 if (isa<TemplateTypeParmDecl>(Pack)) {
2835 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
2836 E->getPackLoc(), TU)))
2842 if (isa<TemplateTemplateParmDecl>(Pack)) {
2843 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
2844 E->getPackLoc(), TU)))
2850 // Non-type template parameter packs and function parameter packs are
2851 // treated like DeclRefExpr cursors.
2855 case VisitorJob::LambdaExprPartsKind: {
2857 const LambdaExpr *E = cast<LambdaExprParts>(&LI)->get();
2858 for (LambdaExpr::capture_iterator C = E->explicit_capture_begin(),
2859 CEnd = E->explicit_capture_end();
2861 // FIXME: Lambda init-captures.
2862 if (!C->capturesVariable())
2865 if (Visit(MakeCursorVariableRef(C->getCapturedVar(),
2871 // Visit parameters and return type, if present.
2872 if (E->hasExplicitParameters() || E->hasExplicitResultType()) {
2873 TypeLoc TL = E->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
2874 if (E->hasExplicitParameters() && E->hasExplicitResultType()) {
2875 // Visit the whole type.
2878 } else if (FunctionProtoTypeLoc Proto =
2879 TL.getAs<FunctionProtoTypeLoc>()) {
2880 if (E->hasExplicitParameters()) {
2881 // Visit parameters.
2882 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I)
2883 if (Visit(MakeCXCursor(Proto.getParam(I), TU)))
2886 // Visit result type.
2887 if (Visit(Proto.getReturnLoc()))
2895 case VisitorJob::PostChildrenVisitKind:
2896 if (PostChildrenVisitor(Parent, ClientData))
2904 bool CursorVisitor::Visit(const Stmt *S) {
2905 VisitorWorkList *WL = nullptr;
2906 if (!WorkListFreeList.empty()) {
2907 WL = WorkListFreeList.back();
2909 WorkListFreeList.pop_back();
2912 WL = new VisitorWorkList();
2913 WorkListCache.push_back(WL);
2915 EnqueueWorkList(*WL, S);
2916 bool result = RunVisitorWorkList(*WL);
2917 WorkListFreeList.push_back(WL);
2922 typedef SmallVector<SourceRange, 4> RefNamePieces;
2923 RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
2924 const DeclarationNameInfo &NI, SourceRange QLoc,
2925 const SourceRange *TemplateArgsLoc = nullptr) {
2926 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
2927 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
2928 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
2930 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
2932 RefNamePieces Pieces;
2934 if (WantQualifier && QLoc.isValid())
2935 Pieces.push_back(QLoc);
2937 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
2938 Pieces.push_back(NI.getLoc());
2940 if (WantTemplateArgs && TemplateArgsLoc && TemplateArgsLoc->isValid())
2941 Pieces.push_back(*TemplateArgsLoc);
2943 if (Kind == DeclarationName::CXXOperatorName) {
2944 Pieces.push_back(SourceLocation::getFromRawEncoding(
2945 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
2946 Pieces.push_back(SourceLocation::getFromRawEncoding(
2947 NI.getInfo().CXXOperatorName.EndOpNameLoc));
2950 if (WantSinglePiece) {
2951 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
2953 Pieces.push_back(R);
2960 //===----------------------------------------------------------------------===//
2962 //===----------------------------------------------------------------------===//
2964 static void fatal_error_handler(void *user_data, const std::string& reason,
2965 bool gen_crash_diag) {
2966 // Write the result out to stderr avoiding errs() because raw_ostreams can
2967 // call report_fatal_error.
2968 fprintf(stderr, "LIBCLANG FATAL ERROR: %s\n", reason.c_str());
2973 struct RegisterFatalErrorHandler {
2974 RegisterFatalErrorHandler() {
2975 llvm::install_fatal_error_handler(fatal_error_handler, nullptr);
2980 static llvm::ManagedStatic<RegisterFatalErrorHandler> RegisterFatalErrorHandlerOnce;
2983 CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
2984 int displayDiagnostics) {
2985 // We use crash recovery to make some of our APIs more reliable, implicitly
2987 if (!getenv("LIBCLANG_DISABLE_CRASH_RECOVERY"))
2988 llvm::CrashRecoveryContext::Enable();
2990 // Look through the managed static to trigger construction of the managed
2991 // static which registers our fatal error handler. This ensures it is only
2993 (void)*RegisterFatalErrorHandlerOnce;
2995 // Initialize targets for clang module support.
2996 llvm::InitializeAllTargets();
2997 llvm::InitializeAllTargetMCs();
2998 llvm::InitializeAllAsmPrinters();
2999 llvm::InitializeAllAsmParsers();
3001 CIndexer *CIdxr = new CIndexer();
3003 if (excludeDeclarationsFromPCH)
3004 CIdxr->setOnlyLocalDecls();
3005 if (displayDiagnostics)
3006 CIdxr->setDisplayDiagnostics();
3008 if (getenv("LIBCLANG_BGPRIO_INDEX"))
3009 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3010 CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
3011 if (getenv("LIBCLANG_BGPRIO_EDIT"))
3012 CIdxr->setCXGlobalOptFlags(CIdxr->getCXGlobalOptFlags() |
3013 CXGlobalOpt_ThreadBackgroundPriorityForEditing);
3018 void clang_disposeIndex(CXIndex CIdx) {
3020 delete static_cast<CIndexer *>(CIdx);
3023 void clang_CXIndex_setGlobalOptions(CXIndex CIdx, unsigned options) {
3025 static_cast<CIndexer *>(CIdx)->setCXGlobalOptFlags(options);
3028 unsigned clang_CXIndex_getGlobalOptions(CXIndex CIdx) {
3030 return static_cast<CIndexer *>(CIdx)->getCXGlobalOptFlags();
3034 void clang_toggleCrashRecovery(unsigned isEnabled) {
3036 llvm::CrashRecoveryContext::Enable();
3038 llvm::CrashRecoveryContext::Disable();
3041 CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
3042 const char *ast_filename) {
3043 CXTranslationUnit TU;
3044 enum CXErrorCode Result =
3045 clang_createTranslationUnit2(CIdx, ast_filename, &TU);
3047 assert((TU && Result == CXError_Success) ||
3048 (!TU && Result != CXError_Success));
3052 enum CXErrorCode clang_createTranslationUnit2(CXIndex CIdx,
3053 const char *ast_filename,
3054 CXTranslationUnit *out_TU) {
3058 if (!CIdx || !ast_filename || !out_TU)
3059 return CXError_InvalidArguments;
3062 *Log << ast_filename;
3065 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3066 FileSystemOptions FileSystemOpts;
3068 IntrusiveRefCntPtr<DiagnosticsEngine> Diags =
3069 CompilerInstance::createDiagnostics(new DiagnosticOptions());
3070 std::unique_ptr<ASTUnit> AU = ASTUnit::LoadFromASTFile(
3071 ast_filename, CXXIdx->getPCHContainerOperations()->getRawReader(), Diags,
3072 FileSystemOpts, /*UseDebugInfo=*/false,
3073 CXXIdx->getOnlyLocalDecls(), None,
3074 /*CaptureDiagnostics=*/true,
3075 /*AllowPCHWithCompilerErrors=*/true,
3076 /*UserFilesAreVolatile=*/true);
3077 *out_TU = MakeCXTranslationUnit(CXXIdx, AU.release());
3078 return *out_TU ? CXError_Success : CXError_Failure;
3081 unsigned clang_defaultEditingTranslationUnitOptions() {
3082 return CXTranslationUnit_PrecompiledPreamble |
3083 CXTranslationUnit_CacheCompletionResults;
3087 clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
3088 const char *source_filename,
3089 int num_command_line_args,
3090 const char * const *command_line_args,
3091 unsigned num_unsaved_files,
3092 struct CXUnsavedFile *unsaved_files) {
3093 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord;
3094 return clang_parseTranslationUnit(CIdx, source_filename,
3095 command_line_args, num_command_line_args,
3096 unsaved_files, num_unsaved_files,
3101 clang_parseTranslationUnit_Impl(CXIndex CIdx, const char *source_filename,
3102 const char *const *command_line_args,
3103 int num_command_line_args,
3104 ArrayRef<CXUnsavedFile> unsaved_files,
3105 unsigned options, CXTranslationUnit *out_TU) {
3106 // Set up the initial return values.
3111 if (!CIdx || !out_TU)
3112 return CXError_InvalidArguments;
3114 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
3116 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3117 setThreadBackgroundPriority();
3119 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
3120 bool CreatePreambleOnFirstParse =
3121 options & CXTranslationUnit_CreatePreambleOnFirstParse;
3122 // FIXME: Add a flag for modules.
3123 TranslationUnitKind TUKind
3124 = (options & CXTranslationUnit_Incomplete)? TU_Prefix : TU_Complete;
3125 bool CacheCodeCompletionResults
3126 = options & CXTranslationUnit_CacheCompletionResults;
3127 bool IncludeBriefCommentsInCodeCompletion
3128 = options & CXTranslationUnit_IncludeBriefCommentsInCodeCompletion;
3129 bool SkipFunctionBodies = options & CXTranslationUnit_SkipFunctionBodies;
3130 bool ForSerialization = options & CXTranslationUnit_ForSerialization;
3132 // Configure the diagnostics.
3133 IntrusiveRefCntPtr<DiagnosticsEngine>
3134 Diags(CompilerInstance::createDiagnostics(new DiagnosticOptions));
3136 // Recover resources if we crash before exiting this function.
3137 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
3138 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
3139 DiagCleanup(Diags.get());
3141 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3142 new std::vector<ASTUnit::RemappedFile>());
3144 // Recover resources if we crash before exiting this function.
3145 llvm::CrashRecoveryContextCleanupRegistrar<
3146 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3148 for (auto &UF : unsaved_files) {
3149 std::unique_ptr<llvm::MemoryBuffer> MB =
3150 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
3151 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
3154 std::unique_ptr<std::vector<const char *>> Args(
3155 new std::vector<const char *>());
3157 // Recover resources if we crash before exiting this method.
3158 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
3159 ArgsCleanup(Args.get());
3161 // Since the Clang C library is primarily used by batch tools dealing with
3162 // (often very broken) source code, where spell-checking can have a
3163 // significant negative impact on performance (particularly when
3164 // precompiled headers are involved), we disable it by default.
3165 // Only do this if we haven't found a spell-checking-related argument.
3166 bool FoundSpellCheckingArgument = false;
3167 for (int I = 0; I != num_command_line_args; ++I) {
3168 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
3169 strcmp(command_line_args[I], "-fspell-checking") == 0) {
3170 FoundSpellCheckingArgument = true;
3174 Args->insert(Args->end(), command_line_args,
3175 command_line_args + num_command_line_args);
3177 if (!FoundSpellCheckingArgument)
3178 Args->insert(Args->begin() + 1, "-fno-spell-checking");
3180 // The 'source_filename' argument is optional. If the caller does not
3181 // specify it then it is assumed that the source file is specified
3182 // in the actual argument list.
3183 // Put the source file after command_line_args otherwise if '-x' flag is
3184 // present it will be unused.
3185 if (source_filename)
3186 Args->push_back(source_filename);
3188 // Do we need the detailed preprocessing record?
3189 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
3190 Args->push_back("-Xclang");
3191 Args->push_back("-detailed-preprocessing-record");
3194 unsigned NumErrors = Diags->getClient()->getNumErrors();
3195 std::unique_ptr<ASTUnit> ErrUnit;
3196 // Unless the user specified that they want the preamble on the first parse
3197 // set it up to be created on the first reparse. This makes the first parse
3198 // faster, trading for a slower (first) reparse.
3199 unsigned PrecompilePreambleAfterNParses =
3200 !PrecompilePreamble ? 0 : 2 - CreatePreambleOnFirstParse;
3201 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCommandLine(
3202 Args->data(), Args->data() + Args->size(),
3203 CXXIdx->getPCHContainerOperations(), Diags,
3204 CXXIdx->getClangResourcesPath(), CXXIdx->getOnlyLocalDecls(),
3205 /*CaptureDiagnostics=*/true, *RemappedFiles.get(),
3206 /*RemappedFilesKeepOriginalName=*/true, PrecompilePreambleAfterNParses,
3207 TUKind, CacheCodeCompletionResults, IncludeBriefCommentsInCodeCompletion,
3208 /*AllowPCHWithCompilerErrors=*/true, SkipFunctionBodies,
3209 /*UserFilesAreVolatile=*/true, ForSerialization,
3210 CXXIdx->getPCHContainerOperations()->getRawReader().getFormat(),
3213 // Early failures in LoadFromCommandLine may return with ErrUnit unset.
3214 if (!Unit && !ErrUnit)
3215 return CXError_ASTReadError;
3217 if (NumErrors != Diags->getClient()->getNumErrors()) {
3218 // Make sure to check that 'Unit' is non-NULL.
3219 if (CXXIdx->getDisplayDiagnostics())
3220 printDiagsToStderr(Unit ? Unit.get() : ErrUnit.get());
3223 if (isASTReadError(Unit ? Unit.get() : ErrUnit.get()))
3224 return CXError_ASTReadError;
3226 *out_TU = MakeCXTranslationUnit(CXXIdx, Unit.release());
3227 return *out_TU ? CXError_Success : CXError_Failure;
3231 clang_parseTranslationUnit(CXIndex CIdx,
3232 const char *source_filename,
3233 const char *const *command_line_args,
3234 int num_command_line_args,
3235 struct CXUnsavedFile *unsaved_files,
3236 unsigned num_unsaved_files,
3238 CXTranslationUnit TU;
3239 enum CXErrorCode Result = clang_parseTranslationUnit2(
3240 CIdx, source_filename, command_line_args, num_command_line_args,
3241 unsaved_files, num_unsaved_files, options, &TU);
3243 assert((TU && Result == CXError_Success) ||
3244 (!TU && Result != CXError_Success));
3248 enum CXErrorCode clang_parseTranslationUnit2(
3249 CXIndex CIdx, const char *source_filename,
3250 const char *const *command_line_args, int num_command_line_args,
3251 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3252 unsigned options, CXTranslationUnit *out_TU) {
3253 SmallVector<const char *, 4> Args;
3254 Args.push_back("clang");
3255 Args.append(command_line_args, command_line_args + num_command_line_args);
3256 return clang_parseTranslationUnit2FullArgv(
3257 CIdx, source_filename, Args.data(), Args.size(), unsaved_files,
3258 num_unsaved_files, options, out_TU);
3261 enum CXErrorCode clang_parseTranslationUnit2FullArgv(
3262 CXIndex CIdx, const char *source_filename,
3263 const char *const *command_line_args, int num_command_line_args,
3264 struct CXUnsavedFile *unsaved_files, unsigned num_unsaved_files,
3265 unsigned options, CXTranslationUnit *out_TU) {
3267 *Log << source_filename << ": ";
3268 for (int i = 0; i != num_command_line_args; ++i)
3269 *Log << command_line_args[i] << " ";
3272 if (num_unsaved_files && !unsaved_files)
3273 return CXError_InvalidArguments;
3275 CXErrorCode result = CXError_Failure;
3276 auto ParseTranslationUnitImpl = [=, &result] {
3277 result = clang_parseTranslationUnit_Impl(
3278 CIdx, source_filename, command_line_args, num_command_line_args,
3279 llvm::makeArrayRef(unsaved_files, num_unsaved_files), options, out_TU);
3281 llvm::CrashRecoveryContext CRC;
3283 if (!RunSafely(CRC, ParseTranslationUnitImpl)) {
3284 fprintf(stderr, "libclang: crash detected during parsing: {\n");
3285 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
3286 fprintf(stderr, " 'command_line_args' : [");
3287 for (int i = 0; i != num_command_line_args; ++i) {
3289 fprintf(stderr, ", ");
3290 fprintf(stderr, "'%s'", command_line_args[i]);
3292 fprintf(stderr, "],\n");
3293 fprintf(stderr, " 'unsaved_files' : [");
3294 for (unsigned i = 0; i != num_unsaved_files; ++i) {
3296 fprintf(stderr, ", ");
3297 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
3298 unsaved_files[i].Length);
3300 fprintf(stderr, "],\n");
3301 fprintf(stderr, " 'options' : %d,\n", options);
3302 fprintf(stderr, "}\n");
3304 return CXError_Crashed;
3305 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3306 if (CXTranslationUnit *TU = out_TU)
3307 PrintLibclangResourceUsage(*TU);
3313 CXString clang_Type_getObjCEncoding(CXType CT) {
3314 CXTranslationUnit tu = static_cast<CXTranslationUnit>(CT.data[1]);
3315 ASTContext &Ctx = getASTUnit(tu)->getASTContext();
3316 std::string encoding;
3317 Ctx.getObjCEncodingForType(QualType::getFromOpaquePtr(CT.data[0]),
3320 return cxstring::createDup(encoding);
3323 static const IdentifierInfo *getMacroIdentifier(CXCursor C) {
3324 if (C.kind == CXCursor_MacroDefinition) {
3325 if (const MacroDefinitionRecord *MDR = getCursorMacroDefinition(C))
3326 return MDR->getName();
3327 } else if (C.kind == CXCursor_MacroExpansion) {
3328 MacroExpansionCursor ME = getCursorMacroExpansion(C);
3329 return ME.getName();
3334 unsigned clang_Cursor_isMacroFunctionLike(CXCursor C) {
3335 const IdentifierInfo *II = getMacroIdentifier(C);
3339 ASTUnit *ASTU = getCursorASTUnit(C);
3340 Preprocessor &PP = ASTU->getPreprocessor();
3341 if (const MacroInfo *MI = PP.getMacroInfo(II))
3342 return MI->isFunctionLike();
3346 unsigned clang_Cursor_isMacroBuiltin(CXCursor C) {
3347 const IdentifierInfo *II = getMacroIdentifier(C);
3351 ASTUnit *ASTU = getCursorASTUnit(C);
3352 Preprocessor &PP = ASTU->getPreprocessor();
3353 if (const MacroInfo *MI = PP.getMacroInfo(II))
3354 return MI->isBuiltinMacro();
3358 unsigned clang_Cursor_isFunctionInlined(CXCursor C) {
3359 const Decl *D = getCursorDecl(C);
3360 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D);
3364 return FD->isInlined();
3367 static StringLiteral* getCFSTR_value(CallExpr *callExpr) {
3368 if (callExpr->getNumArgs() != 1) {
3372 StringLiteral *S = nullptr;
3373 auto *arg = callExpr->getArg(0);
3374 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
3375 ImplicitCastExpr *I = static_cast<ImplicitCastExpr *>(arg);
3376 auto *subExpr = I->getSubExprAsWritten();
3378 if(subExpr->getStmtClass() != Stmt::StringLiteralClass){
3382 S = static_cast<StringLiteral *>(I->getSubExprAsWritten());
3383 } else if (arg->getStmtClass() == Stmt::StringLiteralClass) {
3384 S = static_cast<StringLiteral *>(callExpr->getArg(0));
3392 CXEvalResultKind EvalType;
3400 void clang_EvalResult_dispose(CXEvalResult E) {
3401 ExprEvalResult *ER = (ExprEvalResult *)E;
3403 CXEvalResultKind evalType = ER->EvalType;
3405 if (evalType != CXEval_UnExposed && evalType != CXEval_Float &&
3406 evalType != CXEval_Int && ER->EvalData.stringVal) {
3407 free((void *) ER->EvalData.stringVal);
3413 CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E) {
3415 return CXEval_UnExposed;
3417 return ((ExprEvalResult *)E)->EvalType;
3420 int clang_EvalResult_getAsInt(CXEvalResult E) {
3424 return ((ExprEvalResult *)E)->EvalData.intVal;
3427 double clang_EvalResult_getAsDouble(CXEvalResult E) {
3431 return ((ExprEvalResult *)E)->EvalData.floatVal;
3434 const char* clang_EvalResult_getAsStr(CXEvalResult E) {
3438 return ((ExprEvalResult *)E)->EvalData.stringVal;
3441 static const ExprEvalResult* evaluateExpr(Expr *expr, CXCursor C) {
3442 Expr::EvalResult ER;
3443 ASTContext &ctx = getCursorContext(C);
3447 expr = expr->IgnoreParens();
3448 bool res = expr->EvaluateAsRValue(ER, ctx);
3451 ExprEvalResult *result = (ExprEvalResult *) malloc(sizeof(ExprEvalResult));
3455 result->EvalType = CXEval_UnExposed;
3459 if (ER.Val.isInt()) {
3460 result->EvalType = CXEval_Int;
3461 result->EvalData.intVal = ER.Val.getInt().getExtValue();
3463 } else if (ER.Val.isFloat()) {
3465 llvm::SmallVector<char, 100> Buffer;
3466 ER.Val.getFloat().toString(Buffer);
3467 std::string floatStr(Buffer.data(), Buffer.size());
3468 result->EvalType = CXEval_Float;
3470 llvm::APFloat apFloat = ER.Val.getFloat();
3471 apFloat.convert(llvm::APFloat::IEEEdouble,
3472 llvm::APFloat::rmNearestTiesToEven, &ignored);
3473 result->EvalData.floatVal = apFloat.convertToDouble();
3476 } else if (expr->getStmtClass() == Stmt::ImplicitCastExprClass) {
3478 const ImplicitCastExpr *I = dyn_cast<ImplicitCastExpr>(expr);
3479 auto *subExpr = I->getSubExprAsWritten();
3480 if (subExpr->getStmtClass() == Stmt::StringLiteralClass ||
3481 subExpr->getStmtClass() == Stmt::ObjCStringLiteralClass) {
3483 const StringLiteral *StrE = nullptr;
3484 const ObjCStringLiteral *ObjCExpr;
3485 ObjCExpr = dyn_cast<ObjCStringLiteral>(subExpr);
3488 StrE = ObjCExpr->getString();
3489 result->EvalType = CXEval_ObjCStrLiteral;
3491 StrE = cast<StringLiteral>(I->getSubExprAsWritten());
3492 result->EvalType = CXEval_StrLiteral;
3495 std::string strRef(StrE->getString().str());
3496 result->EvalData.stringVal = (char *)malloc(strRef.size()+1);
3497 strncpy((char*)result->EvalData.stringVal, strRef.c_str(),
3499 result->EvalData.stringVal[strRef.size()] = '\0';
3503 } else if (expr->getStmtClass() == Stmt::ObjCStringLiteralClass ||
3504 expr->getStmtClass() == Stmt::StringLiteralClass) {
3506 const StringLiteral *StrE = nullptr;
3507 const ObjCStringLiteral *ObjCExpr;
3508 ObjCExpr = dyn_cast<ObjCStringLiteral>(expr);
3511 StrE = ObjCExpr->getString();
3512 result->EvalType = CXEval_ObjCStrLiteral;
3514 StrE = cast<StringLiteral>(expr);
3515 result->EvalType = CXEval_StrLiteral;
3518 std::string strRef(StrE->getString().str());
3519 result->EvalData.stringVal = (char *)malloc(strRef.size()+1);
3520 strncpy((char*)result->EvalData.stringVal, strRef.c_str(),
3522 result->EvalData.stringVal[strRef.size()] = '\0';
3525 } else if (expr->getStmtClass() == Stmt::CStyleCastExprClass) {
3527 CStyleCastExpr *CC = static_cast<CStyleCastExpr *>(expr);
3529 rettype = CC->getType();
3530 if (rettype.getAsString() == "CFStringRef" &&
3531 CC->getSubExpr()->getStmtClass() == Stmt::CallExprClass) {
3533 callExpr = static_cast<CallExpr *>(CC->getSubExpr());
3534 StringLiteral* S = getCFSTR_value(callExpr);
3536 std::string strLiteral(S->getString().str());
3537 result->EvalType = CXEval_CFStr;
3539 result->EvalData.stringVal = (char *)malloc(strLiteral.size()+1);
3540 strncpy((char*)result->EvalData.stringVal, strLiteral.c_str(),
3542 result->EvalData.stringVal[strLiteral.size()] = '\0';
3547 } else if (expr->getStmtClass() == Stmt::CallExprClass) {
3549 callExpr = static_cast<CallExpr *>(expr);
3550 rettype = callExpr->getCallReturnType(ctx);
3552 if (rettype->isVectorType() || callExpr->getNumArgs() > 1) {
3555 if (rettype->isIntegralType(ctx) || rettype->isRealFloatingType()) {
3556 if(callExpr->getNumArgs() == 1 &&
3557 !callExpr->getArg(0)->getType()->isIntegralType(ctx)){
3561 } else if(rettype.getAsString() == "CFStringRef") {
3563 StringLiteral* S = getCFSTR_value(callExpr);
3565 std::string strLiteral(S->getString().str());
3566 result->EvalType = CXEval_CFStr;
3567 result->EvalData.stringVal = (char *)malloc(strLiteral.size()+1);
3568 strncpy((char*)result->EvalData.stringVal, strLiteral.c_str(),
3570 result->EvalData.stringVal[strLiteral.size()] = '\0';
3575 } else if (expr->getStmtClass() == Stmt::DeclRefExprClass) {
3577 DeclRefExpr *D = static_cast<DeclRefExpr *>(expr);
3578 ValueDecl *V = D->getDecl();
3579 if (V->getKind() == Decl::Function) {
3580 std::string strName(V->getNameAsString());
3581 result->EvalType = CXEval_Other;
3582 result->EvalData.stringVal = (char *)malloc(strName.size()+1);
3583 strncpy((char*)result->EvalData.stringVal, strName.c_str(),
3585 result->EvalData.stringVal[strName.size()] = '\0';
3592 clang_EvalResult_dispose((CXEvalResult *)result);
3596 CXEvalResult clang_Cursor_Evaluate(CXCursor C) {
3597 const Decl *D = getCursorDecl(C);
3599 const Expr *expr = nullptr;
3600 if (auto *Var = dyn_cast<VarDecl>(D)) {
3601 expr = Var->getInit();
3602 } else if (auto *Field = dyn_cast<FieldDecl>(D)) {
3603 expr = Field->getInClassInitializer();
3606 return const_cast<CXEvalResult>(reinterpret_cast<const void *>(
3607 evaluateExpr(const_cast<Expr *>(expr), C)));
3611 const CompoundStmt *compoundStmt = dyn_cast_or_null<CompoundStmt>(getCursorStmt(C));
3613 Expr *expr = nullptr;
3614 for (auto *bodyIterator : compoundStmt->body()) {
3615 if ((expr = dyn_cast<Expr>(bodyIterator))) {
3620 return const_cast<CXEvalResult>(
3621 reinterpret_cast<const void *>(evaluateExpr(expr, C)));
3626 unsigned clang_Cursor_hasAttrs(CXCursor C) {
3627 const Decl *D = getCursorDecl(C);
3632 if (D->hasAttrs()) {
3638 unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
3639 return CXSaveTranslationUnit_None;
3642 static CXSaveError clang_saveTranslationUnit_Impl(CXTranslationUnit TU,
3643 const char *FileName,
3645 CIndexer *CXXIdx = TU->CIdx;
3646 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForIndexing))
3647 setThreadBackgroundPriority();
3649 bool hadError = cxtu::getASTUnit(TU)->Save(FileName);
3650 return hadError ? CXSaveError_Unknown : CXSaveError_None;
3653 int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
3656 *Log << TU << ' ' << FileName;
3659 if (isNotUsableTU(TU)) {
3661 return CXSaveError_InvalidTU;
3664 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
3665 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3666 if (!CXXUnit->hasSema())
3667 return CXSaveError_InvalidTU;
3670 auto SaveTranslationUnitImpl = [=, &result]() {
3671 result = clang_saveTranslationUnit_Impl(TU, FileName, options);
3674 if (!CXXUnit->getDiagnostics().hasUnrecoverableErrorOccurred() ||
3675 getenv("LIBCLANG_NOTHREADS")) {
3676 SaveTranslationUnitImpl();
3678 if (getenv("LIBCLANG_RESOURCE_USAGE"))
3679 PrintLibclangResourceUsage(TU);
3684 // We have an AST that has invalid nodes due to compiler errors.
3685 // Use a crash recovery thread for protection.
3687 llvm::CrashRecoveryContext CRC;
3689 if (!RunSafely(CRC, SaveTranslationUnitImpl)) {
3690 fprintf(stderr, "libclang: crash detected during AST saving: {\n");
3691 fprintf(stderr, " 'filename' : '%s'\n", FileName);
3692 fprintf(stderr, " 'options' : %d,\n", options);
3693 fprintf(stderr, "}\n");
3695 return CXSaveError_Unknown;
3697 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
3698 PrintLibclangResourceUsage(TU);
3704 void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
3706 // If the translation unit has been marked as unsafe to free, just discard
3708 ASTUnit *Unit = cxtu::getASTUnit(CTUnit);
3709 if (Unit && Unit->isUnsafeToFree())
3712 delete cxtu::getASTUnit(CTUnit);
3713 delete CTUnit->StringPool;
3714 delete static_cast<CXDiagnosticSetImpl *>(CTUnit->Diagnostics);
3715 disposeOverridenCXCursorsPool(CTUnit->OverridenCursorsPool);
3716 delete CTUnit->CommentToXML;
3721 unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
3722 return CXReparse_None;
3726 clang_reparseTranslationUnit_Impl(CXTranslationUnit TU,
3727 ArrayRef<CXUnsavedFile> unsaved_files,
3730 if (isNotUsableTU(TU)) {
3732 return CXError_InvalidArguments;
3735 // Reset the associated diagnostics.
3736 delete static_cast<CXDiagnosticSetImpl*>(TU->Diagnostics);
3737 TU->Diagnostics = nullptr;
3739 CIndexer *CXXIdx = TU->CIdx;
3740 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
3741 setThreadBackgroundPriority();
3743 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
3744 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3746 std::unique_ptr<std::vector<ASTUnit::RemappedFile>> RemappedFiles(
3747 new std::vector<ASTUnit::RemappedFile>());
3749 // Recover resources if we crash before exiting this function.
3750 llvm::CrashRecoveryContextCleanupRegistrar<
3751 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
3753 for (auto &UF : unsaved_files) {
3754 std::unique_ptr<llvm::MemoryBuffer> MB =
3755 llvm::MemoryBuffer::getMemBufferCopy(getContents(UF), UF.Filename);
3756 RemappedFiles->push_back(std::make_pair(UF.Filename, MB.release()));
3759 if (!CXXUnit->Reparse(CXXIdx->getPCHContainerOperations(),
3760 *RemappedFiles.get()))
3761 return CXError_Success;
3762 if (isASTReadError(CXXUnit))
3763 return CXError_ASTReadError;
3764 return CXError_Failure;
3767 int clang_reparseTranslationUnit(CXTranslationUnit TU,
3768 unsigned num_unsaved_files,
3769 struct CXUnsavedFile *unsaved_files,
3775 if (num_unsaved_files && !unsaved_files)
3776 return CXError_InvalidArguments;
3779 auto ReparseTranslationUnitImpl = [=, &result]() {
3780 result = clang_reparseTranslationUnit_Impl(
3781 TU, llvm::makeArrayRef(unsaved_files, num_unsaved_files), options);
3784 if (getenv("LIBCLANG_NOTHREADS")) {
3785 ReparseTranslationUnitImpl();
3789 llvm::CrashRecoveryContext CRC;
3791 if (!RunSafely(CRC, ReparseTranslationUnitImpl)) {
3792 fprintf(stderr, "libclang: crash detected during reparsing\n");
3793 cxtu::getASTUnit(TU)->setUnsafeToFree(true);
3794 return CXError_Crashed;
3795 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
3796 PrintLibclangResourceUsage(TU);
3802 CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
3803 if (isNotUsableTU(CTUnit)) {
3805 return cxstring::createEmpty();
3808 ASTUnit *CXXUnit = cxtu::getASTUnit(CTUnit);
3809 return cxstring::createDup(CXXUnit->getOriginalSourceFileName());
3812 CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
3813 if (isNotUsableTU(TU)) {
3815 return clang_getNullCursor();
3818 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
3819 return MakeCXCursor(CXXUnit->getASTContext().getTranslationUnitDecl(), TU);
3822 } // end: extern "C"
3824 //===----------------------------------------------------------------------===//
3825 // CXFile Operations.
3826 //===----------------------------------------------------------------------===//
3829 CXString clang_getFileName(CXFile SFile) {
3831 return cxstring::createNull();
3833 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
3834 return cxstring::createRef(FEnt->getName());
3837 time_t clang_getFileTime(CXFile SFile) {
3841 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
3842 return FEnt->getModificationTime();
3845 CXFile clang_getFile(CXTranslationUnit TU, const char *file_name) {
3846 if (isNotUsableTU(TU)) {
3851 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
3853 FileManager &FMgr = CXXUnit->getFileManager();
3854 return const_cast<FileEntry *>(FMgr.getFile(file_name));
3857 unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit TU,
3859 if (isNotUsableTU(TU)) {
3867 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
3868 FileEntry *FEnt = static_cast<FileEntry *>(file);
3869 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
3870 .isFileMultipleIncludeGuarded(FEnt);
3873 int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID) {
3874 if (!file || !outID)
3877 FileEntry *FEnt = static_cast<FileEntry *>(file);
3878 const llvm::sys::fs::UniqueID &ID = FEnt->getUniqueID();
3879 outID->data[0] = ID.getDevice();
3880 outID->data[1] = ID.getFile();
3881 outID->data[2] = FEnt->getModificationTime();
3885 int clang_File_isEqual(CXFile file1, CXFile file2) {
3889 if (!file1 || !file2)
3892 FileEntry *FEnt1 = static_cast<FileEntry *>(file1);
3893 FileEntry *FEnt2 = static_cast<FileEntry *>(file2);
3894 return FEnt1->getUniqueID() == FEnt2->getUniqueID();
3897 } // end: extern "C"
3899 //===----------------------------------------------------------------------===//
3900 // CXCursor Operations.
3901 //===----------------------------------------------------------------------===//
3903 static const Decl *getDeclFromExpr(const Stmt *E) {
3904 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
3905 return getDeclFromExpr(CE->getSubExpr());
3907 if (const DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
3908 return RefExpr->getDecl();
3909 if (const MemberExpr *ME = dyn_cast<MemberExpr>(E))
3910 return ME->getMemberDecl();
3911 if (const ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
3912 return RE->getDecl();
3913 if (const ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E)) {
3914 if (PRE->isExplicitProperty())
3915 return PRE->getExplicitProperty();
3916 // It could be messaging both getter and setter as in:
3918 // in which case prefer to associate the setter since it is less obvious
3919 // from inspecting the source that the setter is going to get called.
3920 if (PRE->isMessagingSetter())
3921 return PRE->getImplicitPropertySetter();
3922 return PRE->getImplicitPropertyGetter();
3924 if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E))
3925 return getDeclFromExpr(POE->getSyntacticForm());
3926 if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(E))
3927 if (Expr *Src = OVE->getSourceExpr())
3928 return getDeclFromExpr(Src);
3930 if (const CallExpr *CE = dyn_cast<CallExpr>(E))
3931 return getDeclFromExpr(CE->getCallee());
3932 if (const CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
3933 if (!CE->isElidable())
3934 return CE->getConstructor();
3935 if (const ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
3936 return OME->getMethodDecl();
3938 if (const ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
3939 return PE->getProtocol();
3940 if (const SubstNonTypeTemplateParmPackExpr *NTTP
3941 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
3942 return NTTP->getParameterPack();
3943 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
3944 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
3945 isa<ParmVarDecl>(SizeOfPack->getPack()))
3946 return SizeOfPack->getPack();
3951 static SourceLocation getLocationFromExpr(const Expr *E) {
3952 if (const ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
3953 return getLocationFromExpr(CE->getSubExpr());
3955 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
3956 return /*FIXME:*/Msg->getLeftLoc();
3957 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
3958 return DRE->getLocation();
3959 if (const MemberExpr *Member = dyn_cast<MemberExpr>(E))
3960 return Member->getMemberLoc();
3961 if (const ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
3962 return Ivar->getLocation();
3963 if (const SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
3964 return SizeOfPack->getPackLoc();
3965 if (const ObjCPropertyRefExpr *PropRef = dyn_cast<ObjCPropertyRefExpr>(E))
3966 return PropRef->getLocation();
3968 return E->getLocStart();
3971 static std::string getMangledStructor(std::unique_ptr<MangleContext> &M,
3972 std::unique_ptr<llvm::DataLayout> &DL,
3973 const NamedDecl *ND,
3974 unsigned StructorType) {
3975 std::string FrontendBuf;
3976 llvm::raw_string_ostream FOS(FrontendBuf);
3978 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(ND))
3979 M->mangleCXXCtor(CD, static_cast<CXXCtorType>(StructorType), FOS);
3980 else if (const auto *DD = dyn_cast_or_null<CXXDestructorDecl>(ND))
3981 M->mangleCXXDtor(DD, static_cast<CXXDtorType>(StructorType), FOS);
3983 std::string BackendBuf;
3984 llvm::raw_string_ostream BOS(BackendBuf);
3986 llvm::Mangler::getNameWithPrefix(BOS, llvm::Twine(FOS.str()), *DL);
3993 unsigned clang_visitChildren(CXCursor parent,
3994 CXCursorVisitor visitor,
3995 CXClientData client_data) {
3996 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
3997 /*VisitPreprocessorLast=*/false);
3998 return CursorVis.VisitChildren(parent);
4001 #ifndef __has_feature
4002 #define __has_feature(x) 0
4004 #if __has_feature(blocks)
4005 typedef enum CXChildVisitResult
4006 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
4008 static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4009 CXClientData client_data) {
4010 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4011 return block(cursor, parent);
4014 // If we are compiled with a compiler that doesn't have native blocks support,
4015 // define and call the block manually, so the
4016 typedef struct _CXChildVisitResult
4021 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
4023 } *CXCursorVisitorBlock;
4025 static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
4026 CXClientData client_data) {
4027 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
4028 return block->invoke(block, cursor, parent);
4033 unsigned clang_visitChildrenWithBlock(CXCursor parent,
4034 CXCursorVisitorBlock block) {
4035 return clang_visitChildren(parent, visitWithBlock, block);
4038 static CXString getDeclSpelling(const Decl *D) {
4040 return cxstring::createEmpty();
4042 const NamedDecl *ND = dyn_cast<NamedDecl>(D);
4044 if (const ObjCPropertyImplDecl *PropImpl =
4045 dyn_cast<ObjCPropertyImplDecl>(D))
4046 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
4047 return cxstring::createDup(Property->getIdentifier()->getName());
4049 if (const ImportDecl *ImportD = dyn_cast<ImportDecl>(D))
4050 if (Module *Mod = ImportD->getImportedModule())
4051 return cxstring::createDup(Mod->getFullModuleName());
4053 return cxstring::createEmpty();
4056 if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
4057 return cxstring::createDup(OMD->getSelector().getAsString());
4059 if (const ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
4060 // No, this isn't the same as the code below. getIdentifier() is non-virtual
4061 // and returns different names. NamedDecl returns the class name and
4062 // ObjCCategoryImplDecl returns the category name.
4063 return cxstring::createRef(CIMP->getIdentifier()->getNameStart());
4065 if (isa<UsingDirectiveDecl>(D))
4066 return cxstring::createEmpty();
4068 SmallString<1024> S;
4069 llvm::raw_svector_ostream os(S);
4072 return cxstring::createDup(os.str());
4075 CXString clang_getCursorSpelling(CXCursor C) {
4076 if (clang_isTranslationUnit(C.kind))
4077 return clang_getTranslationUnitSpelling(getCursorTU(C));
4079 if (clang_isReference(C.kind)) {
4081 case CXCursor_ObjCSuperClassRef: {
4082 const ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
4083 return cxstring::createRef(Super->getIdentifier()->getNameStart());
4085 case CXCursor_ObjCClassRef: {
4086 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
4087 return cxstring::createRef(Class->getIdentifier()->getNameStart());
4089 case CXCursor_ObjCProtocolRef: {
4090 const ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
4091 assert(OID && "getCursorSpelling(): Missing protocol decl");
4092 return cxstring::createRef(OID->getIdentifier()->getNameStart());
4094 case CXCursor_CXXBaseSpecifier: {
4095 const CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
4096 return cxstring::createDup(B->getType().getAsString());
4098 case CXCursor_TypeRef: {
4099 const TypeDecl *Type = getCursorTypeRef(C).first;
4100 assert(Type && "Missing type decl");
4102 return cxstring::createDup(getCursorContext(C).getTypeDeclType(Type).
4105 case CXCursor_TemplateRef: {
4106 const TemplateDecl *Template = getCursorTemplateRef(C).first;
4107 assert(Template && "Missing template decl");
4109 return cxstring::createDup(Template->getNameAsString());
4112 case CXCursor_NamespaceRef: {
4113 const NamedDecl *NS = getCursorNamespaceRef(C).first;
4114 assert(NS && "Missing namespace decl");
4116 return cxstring::createDup(NS->getNameAsString());
4119 case CXCursor_MemberRef: {
4120 const FieldDecl *Field = getCursorMemberRef(C).first;
4121 assert(Field && "Missing member decl");
4123 return cxstring::createDup(Field->getNameAsString());
4126 case CXCursor_LabelRef: {
4127 const LabelStmt *Label = getCursorLabelRef(C).first;
4128 assert(Label && "Missing label");
4130 return cxstring::createRef(Label->getName());
4133 case CXCursor_OverloadedDeclRef: {
4134 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
4135 if (const Decl *D = Storage.dyn_cast<const Decl *>()) {
4136 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
4137 return cxstring::createDup(ND->getNameAsString());
4138 return cxstring::createEmpty();
4140 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
4141 return cxstring::createDup(E->getName().getAsString());
4142 OverloadedTemplateStorage *Ovl
4143 = Storage.get<OverloadedTemplateStorage*>();
4144 if (Ovl->size() == 0)
4145 return cxstring::createEmpty();
4146 return cxstring::createDup((*Ovl->begin())->getNameAsString());
4149 case CXCursor_VariableRef: {
4150 const VarDecl *Var = getCursorVariableRef(C).first;
4151 assert(Var && "Missing variable decl");
4153 return cxstring::createDup(Var->getNameAsString());
4157 return cxstring::createRef("<not implemented>");
4161 if (clang_isExpression(C.kind)) {
4162 const Expr *E = getCursorExpr(C);
4164 if (C.kind == CXCursor_ObjCStringLiteral ||
4165 C.kind == CXCursor_StringLiteral) {
4166 const StringLiteral *SLit;
4167 if (const ObjCStringLiteral *OSL = dyn_cast<ObjCStringLiteral>(E)) {
4168 SLit = OSL->getString();
4170 SLit = cast<StringLiteral>(E);
4172 SmallString<256> Buf;
4173 llvm::raw_svector_ostream OS(Buf);
4174 SLit->outputString(OS);
4175 return cxstring::createDup(OS.str());
4178 const Decl *D = getDeclFromExpr(getCursorExpr(C));
4180 return getDeclSpelling(D);
4181 return cxstring::createEmpty();
4184 if (clang_isStatement(C.kind)) {
4185 const Stmt *S = getCursorStmt(C);
4186 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
4187 return cxstring::createRef(Label->getName());
4189 return cxstring::createEmpty();
4192 if (C.kind == CXCursor_MacroExpansion)
4193 return cxstring::createRef(getCursorMacroExpansion(C).getName()
4196 if (C.kind == CXCursor_MacroDefinition)
4197 return cxstring::createRef(getCursorMacroDefinition(C)->getName()
4200 if (C.kind == CXCursor_InclusionDirective)
4201 return cxstring::createDup(getCursorInclusionDirective(C)->getFileName());
4203 if (clang_isDeclaration(C.kind))
4204 return getDeclSpelling(getCursorDecl(C));
4206 if (C.kind == CXCursor_AnnotateAttr) {
4207 const AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
4208 return cxstring::createDup(AA->getAnnotation());
4211 if (C.kind == CXCursor_AsmLabelAttr) {
4212 const AsmLabelAttr *AA = cast<AsmLabelAttr>(cxcursor::getCursorAttr(C));
4213 return cxstring::createDup(AA->getLabel());
4216 if (C.kind == CXCursor_PackedAttr) {
4217 return cxstring::createRef("packed");
4220 if (C.kind == CXCursor_VisibilityAttr) {
4221 const VisibilityAttr *AA = cast<VisibilityAttr>(cxcursor::getCursorAttr(C));
4222 switch (AA->getVisibility()) {
4223 case VisibilityAttr::VisibilityType::Default:
4224 return cxstring::createRef("default");
4225 case VisibilityAttr::VisibilityType::Hidden:
4226 return cxstring::createRef("hidden");
4227 case VisibilityAttr::VisibilityType::Protected:
4228 return cxstring::createRef("protected");
4230 llvm_unreachable("unknown visibility type");
4233 return cxstring::createEmpty();
4236 CXSourceRange clang_Cursor_getSpellingNameRange(CXCursor C,
4237 unsigned pieceIndex,
4239 if (clang_Cursor_isNull(C))
4240 return clang_getNullRange();
4242 ASTContext &Ctx = getCursorContext(C);
4244 if (clang_isStatement(C.kind)) {
4245 const Stmt *S = getCursorStmt(C);
4246 if (const LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S)) {
4248 return clang_getNullRange();
4249 return cxloc::translateSourceRange(Ctx, Label->getIdentLoc());
4252 return clang_getNullRange();
4255 if (C.kind == CXCursor_ObjCMessageExpr) {
4256 if (const ObjCMessageExpr *
4257 ME = dyn_cast_or_null<ObjCMessageExpr>(getCursorExpr(C))) {
4258 if (pieceIndex >= ME->getNumSelectorLocs())
4259 return clang_getNullRange();
4260 return cxloc::translateSourceRange(Ctx, ME->getSelectorLoc(pieceIndex));
4264 if (C.kind == CXCursor_ObjCInstanceMethodDecl ||
4265 C.kind == CXCursor_ObjCClassMethodDecl) {
4266 if (const ObjCMethodDecl *
4267 MD = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(C))) {
4268 if (pieceIndex >= MD->getNumSelectorLocs())
4269 return clang_getNullRange();
4270 return cxloc::translateSourceRange(Ctx, MD->getSelectorLoc(pieceIndex));
4274 if (C.kind == CXCursor_ObjCCategoryDecl ||
4275 C.kind == CXCursor_ObjCCategoryImplDecl) {
4277 return clang_getNullRange();
4278 if (const ObjCCategoryDecl *
4279 CD = dyn_cast_or_null<ObjCCategoryDecl>(getCursorDecl(C)))
4280 return cxloc::translateSourceRange(Ctx, CD->getCategoryNameLoc());
4281 if (const ObjCCategoryImplDecl *
4282 CID = dyn_cast_or_null<ObjCCategoryImplDecl>(getCursorDecl(C)))
4283 return cxloc::translateSourceRange(Ctx, CID->getCategoryNameLoc());
4286 if (C.kind == CXCursor_ModuleImportDecl) {
4288 return clang_getNullRange();
4289 if (const ImportDecl *ImportD =
4290 dyn_cast_or_null<ImportDecl>(getCursorDecl(C))) {
4291 ArrayRef<SourceLocation> Locs = ImportD->getIdentifierLocs();
4293 return cxloc::translateSourceRange(Ctx,
4294 SourceRange(Locs.front(), Locs.back()));
4296 return clang_getNullRange();
4299 if (C.kind == CXCursor_CXXMethod || C.kind == CXCursor_Destructor ||
4300 C.kind == CXCursor_ConversionFunction) {
4302 return clang_getNullRange();
4303 if (const FunctionDecl *FD =
4304 dyn_cast_or_null<FunctionDecl>(getCursorDecl(C))) {
4305 DeclarationNameInfo FunctionName = FD->getNameInfo();
4306 return cxloc::translateSourceRange(Ctx, FunctionName.getSourceRange());
4308 return clang_getNullRange();
4311 // FIXME: A CXCursor_InclusionDirective should give the location of the
4312 // filename, but we don't keep track of this.
4314 // FIXME: A CXCursor_AnnotateAttr should give the location of the annotation
4315 // but we don't keep track of this.
4317 // FIXME: A CXCursor_AsmLabelAttr should give the location of the label
4318 // but we don't keep track of this.
4320 // Default handling, give the location of the cursor.
4323 return clang_getNullRange();
4325 CXSourceLocation CXLoc = clang_getCursorLocation(C);
4326 SourceLocation Loc = cxloc::translateSourceLocation(CXLoc);
4327 return cxloc::translateSourceRange(Ctx, Loc);
4330 CXString clang_Cursor_getMangling(CXCursor C) {
4331 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4332 return cxstring::createEmpty();
4334 // Mangling only works for functions and variables.
4335 const Decl *D = getCursorDecl(C);
4336 if (!D || !(isa<FunctionDecl>(D) || isa<VarDecl>(D)))
4337 return cxstring::createEmpty();
4339 // First apply frontend mangling.
4340 const NamedDecl *ND = cast<NamedDecl>(D);
4341 ASTContext &Ctx = ND->getASTContext();
4342 std::unique_ptr<MangleContext> MC(Ctx.createMangleContext());
4344 std::string FrontendBuf;
4345 llvm::raw_string_ostream FrontendBufOS(FrontendBuf);
4346 if (MC->shouldMangleDeclName(ND)) {
4347 MC->mangleName(ND, FrontendBufOS);
4349 ND->printName(FrontendBufOS);
4352 // Now apply backend mangling.
4353 std::unique_ptr<llvm::DataLayout> DL(
4354 new llvm::DataLayout(Ctx.getTargetInfo().getDataLayoutString()));
4356 std::string FinalBuf;
4357 llvm::raw_string_ostream FinalBufOS(FinalBuf);
4358 llvm::Mangler::getNameWithPrefix(FinalBufOS, llvm::Twine(FrontendBufOS.str()),
4361 return cxstring::createDup(FinalBufOS.str());
4364 CXStringSet *clang_Cursor_getCXXManglings(CXCursor C) {
4365 if (clang_isInvalid(C.kind) || !clang_isDeclaration(C.kind))
4368 const Decl *D = getCursorDecl(C);
4369 if (!(isa<CXXRecordDecl>(D) || isa<CXXMethodDecl>(D)))
4372 const NamedDecl *ND = cast<NamedDecl>(D);
4374 ASTContext &Ctx = ND->getASTContext();
4375 std::unique_ptr<MangleContext> M(Ctx.createMangleContext());
4376 std::unique_ptr<llvm::DataLayout> DL(
4377 new llvm::DataLayout(Ctx.getTargetInfo().getDataLayoutString()));
4379 std::vector<std::string> Manglings;
4381 auto hasDefaultCXXMethodCC = [](ASTContext &C, const CXXMethodDecl *MD) {
4382 auto DefaultCC = C.getDefaultCallingConvention(/*IsVariadic=*/false,
4383 /*IsCSSMethod=*/true);
4384 auto CC = MD->getType()->getAs<FunctionProtoType>()->getCallConv();
4385 return CC == DefaultCC;
4388 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(ND)) {
4389 Manglings.emplace_back(getMangledStructor(M, DL, CD, Ctor_Base));
4391 if (Ctx.getTargetInfo().getCXXABI().isItaniumFamily())
4392 if (!CD->getParent()->isAbstract())
4393 Manglings.emplace_back(getMangledStructor(M, DL, CD, Ctor_Complete));
4395 if (Ctx.getTargetInfo().getCXXABI().isMicrosoft())
4396 if (CD->hasAttr<DLLExportAttr>() && CD->isDefaultConstructor())
4397 if (!(hasDefaultCXXMethodCC(Ctx, CD) && CD->getNumParams() == 0))
4398 Manglings.emplace_back(getMangledStructor(M, DL, CD,
4399 Ctor_DefaultClosure));
4400 } else if (const auto *DD = dyn_cast_or_null<CXXDestructorDecl>(ND)) {
4401 Manglings.emplace_back(getMangledStructor(M, DL, DD, Dtor_Base));
4402 if (Ctx.getTargetInfo().getCXXABI().isItaniumFamily()) {
4403 Manglings.emplace_back(getMangledStructor(M, DL, DD, Dtor_Complete));
4404 if (DD->isVirtual())
4405 Manglings.emplace_back(getMangledStructor(M, DL, DD, Dtor_Deleting));
4409 return cxstring::createSet(Manglings);
4412 CXString clang_getCursorDisplayName(CXCursor C) {
4413 if (!clang_isDeclaration(C.kind))
4414 return clang_getCursorSpelling(C);
4416 const Decl *D = getCursorDecl(C);
4418 return cxstring::createEmpty();
4420 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
4421 if (const FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
4422 D = FunTmpl->getTemplatedDecl();
4424 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
4425 SmallString<64> Str;
4426 llvm::raw_svector_ostream OS(Str);
4428 if (Function->getPrimaryTemplate())
4431 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
4434 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
4437 if (Function->isVariadic()) {
4438 if (Function->getNumParams())
4443 return cxstring::createDup(OS.str());
4446 if (const ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
4447 SmallString<64> Str;
4448 llvm::raw_svector_ostream OS(Str);
4449 OS << *ClassTemplate;
4451 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
4452 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
4456 NamedDecl *Param = Params->getParam(I);
4457 if (Param->getIdentifier()) {
4458 OS << Param->getIdentifier()->getName();
4462 // There is no parameter name, which makes this tricky. Try to come up
4463 // with something useful that isn't too long.
4464 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
4465 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
4466 else if (NonTypeTemplateParmDecl *NTTP
4467 = dyn_cast<NonTypeTemplateParmDecl>(Param))
4468 OS << NTTP->getType().getAsString(Policy);
4470 OS << "template<...> class";
4474 return cxstring::createDup(OS.str());
4477 if (const ClassTemplateSpecializationDecl *ClassSpec
4478 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
4479 // If the type was explicitly written, use that.
4480 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
4481 return cxstring::createDup(TSInfo->getType().getAsString(Policy));
4483 SmallString<128> Str;
4484 llvm::raw_svector_ostream OS(Str);
4486 TemplateSpecializationType::PrintTemplateArgumentList(OS,
4487 ClassSpec->getTemplateArgs().data(),
4488 ClassSpec->getTemplateArgs().size(),
4490 return cxstring::createDup(OS.str());
4493 return clang_getCursorSpelling(C);
4496 CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
4498 case CXCursor_FunctionDecl:
4499 return cxstring::createRef("FunctionDecl");
4500 case CXCursor_TypedefDecl:
4501 return cxstring::createRef("TypedefDecl");
4502 case CXCursor_EnumDecl:
4503 return cxstring::createRef("EnumDecl");
4504 case CXCursor_EnumConstantDecl:
4505 return cxstring::createRef("EnumConstantDecl");
4506 case CXCursor_StructDecl:
4507 return cxstring::createRef("StructDecl");
4508 case CXCursor_UnionDecl:
4509 return cxstring::createRef("UnionDecl");
4510 case CXCursor_ClassDecl:
4511 return cxstring::createRef("ClassDecl");
4512 case CXCursor_FieldDecl:
4513 return cxstring::createRef("FieldDecl");
4514 case CXCursor_VarDecl:
4515 return cxstring::createRef("VarDecl");
4516 case CXCursor_ParmDecl:
4517 return cxstring::createRef("ParmDecl");
4518 case CXCursor_ObjCInterfaceDecl:
4519 return cxstring::createRef("ObjCInterfaceDecl");
4520 case CXCursor_ObjCCategoryDecl:
4521 return cxstring::createRef("ObjCCategoryDecl");
4522 case CXCursor_ObjCProtocolDecl:
4523 return cxstring::createRef("ObjCProtocolDecl");
4524 case CXCursor_ObjCPropertyDecl:
4525 return cxstring::createRef("ObjCPropertyDecl");
4526 case CXCursor_ObjCIvarDecl:
4527 return cxstring::createRef("ObjCIvarDecl");
4528 case CXCursor_ObjCInstanceMethodDecl:
4529 return cxstring::createRef("ObjCInstanceMethodDecl");
4530 case CXCursor_ObjCClassMethodDecl:
4531 return cxstring::createRef("ObjCClassMethodDecl");
4532 case CXCursor_ObjCImplementationDecl:
4533 return cxstring::createRef("ObjCImplementationDecl");
4534 case CXCursor_ObjCCategoryImplDecl:
4535 return cxstring::createRef("ObjCCategoryImplDecl");
4536 case CXCursor_CXXMethod:
4537 return cxstring::createRef("CXXMethod");
4538 case CXCursor_UnexposedDecl:
4539 return cxstring::createRef("UnexposedDecl");
4540 case CXCursor_ObjCSuperClassRef:
4541 return cxstring::createRef("ObjCSuperClassRef");
4542 case CXCursor_ObjCProtocolRef:
4543 return cxstring::createRef("ObjCProtocolRef");
4544 case CXCursor_ObjCClassRef:
4545 return cxstring::createRef("ObjCClassRef");
4546 case CXCursor_TypeRef:
4547 return cxstring::createRef("TypeRef");
4548 case CXCursor_TemplateRef:
4549 return cxstring::createRef("TemplateRef");
4550 case CXCursor_NamespaceRef:
4551 return cxstring::createRef("NamespaceRef");
4552 case CXCursor_MemberRef:
4553 return cxstring::createRef("MemberRef");
4554 case CXCursor_LabelRef:
4555 return cxstring::createRef("LabelRef");
4556 case CXCursor_OverloadedDeclRef:
4557 return cxstring::createRef("OverloadedDeclRef");
4558 case CXCursor_VariableRef:
4559 return cxstring::createRef("VariableRef");
4560 case CXCursor_IntegerLiteral:
4561 return cxstring::createRef("IntegerLiteral");
4562 case CXCursor_FloatingLiteral:
4563 return cxstring::createRef("FloatingLiteral");
4564 case CXCursor_ImaginaryLiteral:
4565 return cxstring::createRef("ImaginaryLiteral");
4566 case CXCursor_StringLiteral:
4567 return cxstring::createRef("StringLiteral");
4568 case CXCursor_CharacterLiteral:
4569 return cxstring::createRef("CharacterLiteral");
4570 case CXCursor_ParenExpr:
4571 return cxstring::createRef("ParenExpr");
4572 case CXCursor_UnaryOperator:
4573 return cxstring::createRef("UnaryOperator");
4574 case CXCursor_ArraySubscriptExpr:
4575 return cxstring::createRef("ArraySubscriptExpr");
4576 case CXCursor_OMPArraySectionExpr:
4577 return cxstring::createRef("OMPArraySectionExpr");
4578 case CXCursor_BinaryOperator:
4579 return cxstring::createRef("BinaryOperator");
4580 case CXCursor_CompoundAssignOperator:
4581 return cxstring::createRef("CompoundAssignOperator");
4582 case CXCursor_ConditionalOperator:
4583 return cxstring::createRef("ConditionalOperator");
4584 case CXCursor_CStyleCastExpr:
4585 return cxstring::createRef("CStyleCastExpr");
4586 case CXCursor_CompoundLiteralExpr:
4587 return cxstring::createRef("CompoundLiteralExpr");
4588 case CXCursor_InitListExpr:
4589 return cxstring::createRef("InitListExpr");
4590 case CXCursor_AddrLabelExpr:
4591 return cxstring::createRef("AddrLabelExpr");
4592 case CXCursor_StmtExpr:
4593 return cxstring::createRef("StmtExpr");
4594 case CXCursor_GenericSelectionExpr:
4595 return cxstring::createRef("GenericSelectionExpr");
4596 case CXCursor_GNUNullExpr:
4597 return cxstring::createRef("GNUNullExpr");
4598 case CXCursor_CXXStaticCastExpr:
4599 return cxstring::createRef("CXXStaticCastExpr");
4600 case CXCursor_CXXDynamicCastExpr:
4601 return cxstring::createRef("CXXDynamicCastExpr");
4602 case CXCursor_CXXReinterpretCastExpr:
4603 return cxstring::createRef("CXXReinterpretCastExpr");
4604 case CXCursor_CXXConstCastExpr:
4605 return cxstring::createRef("CXXConstCastExpr");
4606 case CXCursor_CXXFunctionalCastExpr:
4607 return cxstring::createRef("CXXFunctionalCastExpr");
4608 case CXCursor_CXXTypeidExpr:
4609 return cxstring::createRef("CXXTypeidExpr");
4610 case CXCursor_CXXBoolLiteralExpr:
4611 return cxstring::createRef("CXXBoolLiteralExpr");
4612 case CXCursor_CXXNullPtrLiteralExpr:
4613 return cxstring::createRef("CXXNullPtrLiteralExpr");
4614 case CXCursor_CXXThisExpr:
4615 return cxstring::createRef("CXXThisExpr");
4616 case CXCursor_CXXThrowExpr:
4617 return cxstring::createRef("CXXThrowExpr");
4618 case CXCursor_CXXNewExpr:
4619 return cxstring::createRef("CXXNewExpr");
4620 case CXCursor_CXXDeleteExpr:
4621 return cxstring::createRef("CXXDeleteExpr");
4622 case CXCursor_UnaryExpr:
4623 return cxstring::createRef("UnaryExpr");
4624 case CXCursor_ObjCStringLiteral:
4625 return cxstring::createRef("ObjCStringLiteral");
4626 case CXCursor_ObjCBoolLiteralExpr:
4627 return cxstring::createRef("ObjCBoolLiteralExpr");
4628 case CXCursor_ObjCSelfExpr:
4629 return cxstring::createRef("ObjCSelfExpr");
4630 case CXCursor_ObjCEncodeExpr:
4631 return cxstring::createRef("ObjCEncodeExpr");
4632 case CXCursor_ObjCSelectorExpr:
4633 return cxstring::createRef("ObjCSelectorExpr");
4634 case CXCursor_ObjCProtocolExpr:
4635 return cxstring::createRef("ObjCProtocolExpr");
4636 case CXCursor_ObjCBridgedCastExpr:
4637 return cxstring::createRef("ObjCBridgedCastExpr");
4638 case CXCursor_BlockExpr:
4639 return cxstring::createRef("BlockExpr");
4640 case CXCursor_PackExpansionExpr:
4641 return cxstring::createRef("PackExpansionExpr");
4642 case CXCursor_SizeOfPackExpr:
4643 return cxstring::createRef("SizeOfPackExpr");
4644 case CXCursor_LambdaExpr:
4645 return cxstring::createRef("LambdaExpr");
4646 case CXCursor_UnexposedExpr:
4647 return cxstring::createRef("UnexposedExpr");
4648 case CXCursor_DeclRefExpr:
4649 return cxstring::createRef("DeclRefExpr");
4650 case CXCursor_MemberRefExpr:
4651 return cxstring::createRef("MemberRefExpr");
4652 case CXCursor_CallExpr:
4653 return cxstring::createRef("CallExpr");
4654 case CXCursor_ObjCMessageExpr:
4655 return cxstring::createRef("ObjCMessageExpr");
4656 case CXCursor_UnexposedStmt:
4657 return cxstring::createRef("UnexposedStmt");
4658 case CXCursor_DeclStmt:
4659 return cxstring::createRef("DeclStmt");
4660 case CXCursor_LabelStmt:
4661 return cxstring::createRef("LabelStmt");
4662 case CXCursor_CompoundStmt:
4663 return cxstring::createRef("CompoundStmt");
4664 case CXCursor_CaseStmt:
4665 return cxstring::createRef("CaseStmt");
4666 case CXCursor_DefaultStmt:
4667 return cxstring::createRef("DefaultStmt");
4668 case CXCursor_IfStmt:
4669 return cxstring::createRef("IfStmt");
4670 case CXCursor_SwitchStmt:
4671 return cxstring::createRef("SwitchStmt");
4672 case CXCursor_WhileStmt:
4673 return cxstring::createRef("WhileStmt");
4674 case CXCursor_DoStmt:
4675 return cxstring::createRef("DoStmt");
4676 case CXCursor_ForStmt:
4677 return cxstring::createRef("ForStmt");
4678 case CXCursor_GotoStmt:
4679 return cxstring::createRef("GotoStmt");
4680 case CXCursor_IndirectGotoStmt:
4681 return cxstring::createRef("IndirectGotoStmt");
4682 case CXCursor_ContinueStmt:
4683 return cxstring::createRef("ContinueStmt");
4684 case CXCursor_BreakStmt:
4685 return cxstring::createRef("BreakStmt");
4686 case CXCursor_ReturnStmt:
4687 return cxstring::createRef("ReturnStmt");
4688 case CXCursor_GCCAsmStmt:
4689 return cxstring::createRef("GCCAsmStmt");
4690 case CXCursor_MSAsmStmt:
4691 return cxstring::createRef("MSAsmStmt");
4692 case CXCursor_ObjCAtTryStmt:
4693 return cxstring::createRef("ObjCAtTryStmt");
4694 case CXCursor_ObjCAtCatchStmt:
4695 return cxstring::createRef("ObjCAtCatchStmt");
4696 case CXCursor_ObjCAtFinallyStmt:
4697 return cxstring::createRef("ObjCAtFinallyStmt");
4698 case CXCursor_ObjCAtThrowStmt:
4699 return cxstring::createRef("ObjCAtThrowStmt");
4700 case CXCursor_ObjCAtSynchronizedStmt:
4701 return cxstring::createRef("ObjCAtSynchronizedStmt");
4702 case CXCursor_ObjCAutoreleasePoolStmt:
4703 return cxstring::createRef("ObjCAutoreleasePoolStmt");
4704 case CXCursor_ObjCForCollectionStmt:
4705 return cxstring::createRef("ObjCForCollectionStmt");
4706 case CXCursor_CXXCatchStmt:
4707 return cxstring::createRef("CXXCatchStmt");
4708 case CXCursor_CXXTryStmt:
4709 return cxstring::createRef("CXXTryStmt");
4710 case CXCursor_CXXForRangeStmt:
4711 return cxstring::createRef("CXXForRangeStmt");
4712 case CXCursor_SEHTryStmt:
4713 return cxstring::createRef("SEHTryStmt");
4714 case CXCursor_SEHExceptStmt:
4715 return cxstring::createRef("SEHExceptStmt");
4716 case CXCursor_SEHFinallyStmt:
4717 return cxstring::createRef("SEHFinallyStmt");
4718 case CXCursor_SEHLeaveStmt:
4719 return cxstring::createRef("SEHLeaveStmt");
4720 case CXCursor_NullStmt:
4721 return cxstring::createRef("NullStmt");
4722 case CXCursor_InvalidFile:
4723 return cxstring::createRef("InvalidFile");
4724 case CXCursor_InvalidCode:
4725 return cxstring::createRef("InvalidCode");
4726 case CXCursor_NoDeclFound:
4727 return cxstring::createRef("NoDeclFound");
4728 case CXCursor_NotImplemented:
4729 return cxstring::createRef("NotImplemented");
4730 case CXCursor_TranslationUnit:
4731 return cxstring::createRef("TranslationUnit");
4732 case CXCursor_UnexposedAttr:
4733 return cxstring::createRef("UnexposedAttr");
4734 case CXCursor_IBActionAttr:
4735 return cxstring::createRef("attribute(ibaction)");
4736 case CXCursor_IBOutletAttr:
4737 return cxstring::createRef("attribute(iboutlet)");
4738 case CXCursor_IBOutletCollectionAttr:
4739 return cxstring::createRef("attribute(iboutletcollection)");
4740 case CXCursor_CXXFinalAttr:
4741 return cxstring::createRef("attribute(final)");
4742 case CXCursor_CXXOverrideAttr:
4743 return cxstring::createRef("attribute(override)");
4744 case CXCursor_AnnotateAttr:
4745 return cxstring::createRef("attribute(annotate)");
4746 case CXCursor_AsmLabelAttr:
4747 return cxstring::createRef("asm label");
4748 case CXCursor_PackedAttr:
4749 return cxstring::createRef("attribute(packed)");
4750 case CXCursor_PureAttr:
4751 return cxstring::createRef("attribute(pure)");
4752 case CXCursor_ConstAttr:
4753 return cxstring::createRef("attribute(const)");
4754 case CXCursor_NoDuplicateAttr:
4755 return cxstring::createRef("attribute(noduplicate)");
4756 case CXCursor_CUDAConstantAttr:
4757 return cxstring::createRef("attribute(constant)");
4758 case CXCursor_CUDADeviceAttr:
4759 return cxstring::createRef("attribute(device)");
4760 case CXCursor_CUDAGlobalAttr:
4761 return cxstring::createRef("attribute(global)");
4762 case CXCursor_CUDAHostAttr:
4763 return cxstring::createRef("attribute(host)");
4764 case CXCursor_CUDASharedAttr:
4765 return cxstring::createRef("attribute(shared)");
4766 case CXCursor_VisibilityAttr:
4767 return cxstring::createRef("attribute(visibility)");
4768 case CXCursor_DLLExport:
4769 return cxstring::createRef("attribute(dllexport)");
4770 case CXCursor_DLLImport:
4771 return cxstring::createRef("attribute(dllimport)");
4772 case CXCursor_PreprocessingDirective:
4773 return cxstring::createRef("preprocessing directive");
4774 case CXCursor_MacroDefinition:
4775 return cxstring::createRef("macro definition");
4776 case CXCursor_MacroExpansion:
4777 return cxstring::createRef("macro expansion");
4778 case CXCursor_InclusionDirective:
4779 return cxstring::createRef("inclusion directive");
4780 case CXCursor_Namespace:
4781 return cxstring::createRef("Namespace");
4782 case CXCursor_LinkageSpec:
4783 return cxstring::createRef("LinkageSpec");
4784 case CXCursor_CXXBaseSpecifier:
4785 return cxstring::createRef("C++ base class specifier");
4786 case CXCursor_Constructor:
4787 return cxstring::createRef("CXXConstructor");
4788 case CXCursor_Destructor:
4789 return cxstring::createRef("CXXDestructor");
4790 case CXCursor_ConversionFunction:
4791 return cxstring::createRef("CXXConversion");
4792 case CXCursor_TemplateTypeParameter:
4793 return cxstring::createRef("TemplateTypeParameter");
4794 case CXCursor_NonTypeTemplateParameter:
4795 return cxstring::createRef("NonTypeTemplateParameter");
4796 case CXCursor_TemplateTemplateParameter:
4797 return cxstring::createRef("TemplateTemplateParameter");
4798 case CXCursor_FunctionTemplate:
4799 return cxstring::createRef("FunctionTemplate");
4800 case CXCursor_ClassTemplate:
4801 return cxstring::createRef("ClassTemplate");
4802 case CXCursor_ClassTemplatePartialSpecialization:
4803 return cxstring::createRef("ClassTemplatePartialSpecialization");
4804 case CXCursor_NamespaceAlias:
4805 return cxstring::createRef("NamespaceAlias");
4806 case CXCursor_UsingDirective:
4807 return cxstring::createRef("UsingDirective");
4808 case CXCursor_UsingDeclaration:
4809 return cxstring::createRef("UsingDeclaration");
4810 case CXCursor_TypeAliasDecl:
4811 return cxstring::createRef("TypeAliasDecl");
4812 case CXCursor_ObjCSynthesizeDecl:
4813 return cxstring::createRef("ObjCSynthesizeDecl");
4814 case CXCursor_ObjCDynamicDecl:
4815 return cxstring::createRef("ObjCDynamicDecl");
4816 case CXCursor_CXXAccessSpecifier:
4817 return cxstring::createRef("CXXAccessSpecifier");
4818 case CXCursor_ModuleImportDecl:
4819 return cxstring::createRef("ModuleImport");
4820 case CXCursor_OMPParallelDirective:
4821 return cxstring::createRef("OMPParallelDirective");
4822 case CXCursor_OMPSimdDirective:
4823 return cxstring::createRef("OMPSimdDirective");
4824 case CXCursor_OMPForDirective:
4825 return cxstring::createRef("OMPForDirective");
4826 case CXCursor_OMPForSimdDirective:
4827 return cxstring::createRef("OMPForSimdDirective");
4828 case CXCursor_OMPSectionsDirective:
4829 return cxstring::createRef("OMPSectionsDirective");
4830 case CXCursor_OMPSectionDirective:
4831 return cxstring::createRef("OMPSectionDirective");
4832 case CXCursor_OMPSingleDirective:
4833 return cxstring::createRef("OMPSingleDirective");
4834 case CXCursor_OMPMasterDirective:
4835 return cxstring::createRef("OMPMasterDirective");
4836 case CXCursor_OMPCriticalDirective:
4837 return cxstring::createRef("OMPCriticalDirective");
4838 case CXCursor_OMPParallelForDirective:
4839 return cxstring::createRef("OMPParallelForDirective");
4840 case CXCursor_OMPParallelForSimdDirective:
4841 return cxstring::createRef("OMPParallelForSimdDirective");
4842 case CXCursor_OMPParallelSectionsDirective:
4843 return cxstring::createRef("OMPParallelSectionsDirective");
4844 case CXCursor_OMPTaskDirective:
4845 return cxstring::createRef("OMPTaskDirective");
4846 case CXCursor_OMPTaskyieldDirective:
4847 return cxstring::createRef("OMPTaskyieldDirective");
4848 case CXCursor_OMPBarrierDirective:
4849 return cxstring::createRef("OMPBarrierDirective");
4850 case CXCursor_OMPTaskwaitDirective:
4851 return cxstring::createRef("OMPTaskwaitDirective");
4852 case CXCursor_OMPTaskgroupDirective:
4853 return cxstring::createRef("OMPTaskgroupDirective");
4854 case CXCursor_OMPFlushDirective:
4855 return cxstring::createRef("OMPFlushDirective");
4856 case CXCursor_OMPOrderedDirective:
4857 return cxstring::createRef("OMPOrderedDirective");
4858 case CXCursor_OMPAtomicDirective:
4859 return cxstring::createRef("OMPAtomicDirective");
4860 case CXCursor_OMPTargetDirective:
4861 return cxstring::createRef("OMPTargetDirective");
4862 case CXCursor_OMPTargetDataDirective:
4863 return cxstring::createRef("OMPTargetDataDirective");
4864 case CXCursor_OMPTargetEnterDataDirective:
4865 return cxstring::createRef("OMPTargetEnterDataDirective");
4866 case CXCursor_OMPTargetExitDataDirective:
4867 return cxstring::createRef("OMPTargetExitDataDirective");
4868 case CXCursor_OMPTargetParallelDirective:
4869 return cxstring::createRef("OMPTargetParallelDirective");
4870 case CXCursor_OMPTeamsDirective:
4871 return cxstring::createRef("OMPTeamsDirective");
4872 case CXCursor_OMPCancellationPointDirective:
4873 return cxstring::createRef("OMPCancellationPointDirective");
4874 case CXCursor_OMPCancelDirective:
4875 return cxstring::createRef("OMPCancelDirective");
4876 case CXCursor_OMPTaskLoopDirective:
4877 return cxstring::createRef("OMPTaskLoopDirective");
4878 case CXCursor_OMPTaskLoopSimdDirective:
4879 return cxstring::createRef("OMPTaskLoopSimdDirective");
4880 case CXCursor_OMPDistributeDirective:
4881 return cxstring::createRef("OMPDistributeDirective");
4882 case CXCursor_OverloadCandidate:
4883 return cxstring::createRef("OverloadCandidate");
4884 case CXCursor_TypeAliasTemplateDecl:
4885 return cxstring::createRef("TypeAliasTemplateDecl");
4888 llvm_unreachable("Unhandled CXCursorKind");
4891 struct GetCursorData {
4892 SourceLocation TokenBeginLoc;
4893 bool PointsAtMacroArgExpansion;
4894 bool VisitedObjCPropertyImplDecl;
4895 SourceLocation VisitedDeclaratorDeclStartLoc;
4896 CXCursor &BestCursor;
4898 GetCursorData(SourceManager &SM,
4899 SourceLocation tokenBegin, CXCursor &outputCursor)
4900 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
4901 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
4902 VisitedObjCPropertyImplDecl = false;
4906 static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
4908 CXClientData client_data) {
4909 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
4910 CXCursor *BestCursor = &Data->BestCursor;
4912 // If we point inside a macro argument we should provide info of what the
4913 // token is so use the actual cursor, don't replace it with a macro expansion
4915 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
4916 return CXChildVisit_Recurse;
4918 if (clang_isDeclaration(cursor.kind)) {
4919 // Avoid having the implicit methods override the property decls.
4920 if (const ObjCMethodDecl *MD
4921 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
4922 if (MD->isImplicit())
4923 return CXChildVisit_Break;
4925 } else if (const ObjCInterfaceDecl *ID
4926 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(cursor))) {
4927 // Check that when we have multiple @class references in the same line,
4928 // that later ones do not override the previous ones.
4931 // source ranges for both start at '@', so 'Bar' will end up overriding
4932 // 'Foo' even though the cursor location was at 'Foo'.
4933 if (BestCursor->kind == CXCursor_ObjCInterfaceDecl ||
4934 BestCursor->kind == CXCursor_ObjCClassRef)
4935 if (const ObjCInterfaceDecl *PrevID
4936 = dyn_cast_or_null<ObjCInterfaceDecl>(getCursorDecl(*BestCursor))){
4938 !PrevID->isThisDeclarationADefinition() &&
4939 !ID->isThisDeclarationADefinition())
4940 return CXChildVisit_Break;
4943 } else if (const DeclaratorDecl *DD
4944 = dyn_cast_or_null<DeclaratorDecl>(getCursorDecl(cursor))) {
4945 SourceLocation StartLoc = DD->getSourceRange().getBegin();
4946 // Check that when we have multiple declarators in the same line,
4947 // that later ones do not override the previous ones.
4950 // source ranges for both start at 'int', so 'Bar' will end up overriding
4951 // 'Foo' even though the cursor location was at 'Foo'.
4952 if (Data->VisitedDeclaratorDeclStartLoc == StartLoc)
4953 return CXChildVisit_Break;
4954 Data->VisitedDeclaratorDeclStartLoc = StartLoc;
4956 } else if (const ObjCPropertyImplDecl *PropImp
4957 = dyn_cast_or_null<ObjCPropertyImplDecl>(getCursorDecl(cursor))) {
4959 // Check that when we have multiple @synthesize in the same line,
4960 // that later ones do not override the previous ones.
4962 // @synthesize Foo, Bar;
4963 // source ranges for both start at '@', so 'Bar' will end up overriding
4964 // 'Foo' even though the cursor location was at 'Foo'.
4965 if (Data->VisitedObjCPropertyImplDecl)
4966 return CXChildVisit_Break;
4967 Data->VisitedObjCPropertyImplDecl = true;
4971 if (clang_isExpression(cursor.kind) &&
4972 clang_isDeclaration(BestCursor->kind)) {
4973 if (const Decl *D = getCursorDecl(*BestCursor)) {
4974 // Avoid having the cursor of an expression replace the declaration cursor
4975 // when the expression source range overlaps the declaration range.
4976 // This can happen for C++ constructor expressions whose range generally
4977 // include the variable declaration, e.g.:
4978 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
4979 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
4980 D->getLocation() == Data->TokenBeginLoc)
4981 return CXChildVisit_Break;
4985 // If our current best cursor is the construction of a temporary object,
4986 // don't replace that cursor with a type reference, because we want
4987 // clang_getCursor() to point at the constructor.
4988 if (clang_isExpression(BestCursor->kind) &&
4989 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
4990 cursor.kind == CXCursor_TypeRef) {
4991 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
4992 // as having the actual point on the type reference.
4993 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
4994 return CXChildVisit_Recurse;
4997 // If we already have an Objective-C superclass reference, don't
4998 // update it further.
4999 if (BestCursor->kind == CXCursor_ObjCSuperClassRef)
5000 return CXChildVisit_Break;
5002 *BestCursor = cursor;
5003 return CXChildVisit_Recurse;
5006 CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
5007 if (isNotUsableTU(TU)) {
5009 return clang_getNullCursor();
5012 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
5013 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
5015 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
5016 CXCursor Result = cxcursor::getCursor(TU, SLoc);
5020 unsigned SearchLine, SearchColumn;
5022 unsigned ResultLine, ResultColumn;
5023 CXString SearchFileName, ResultFileName, KindSpelling, USR;
5024 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
5025 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
5027 clang_getFileLocation(Loc, &SearchFile, &SearchLine, &SearchColumn,
5029 clang_getFileLocation(ResultLoc, &ResultFile, &ResultLine,
5030 &ResultColumn, nullptr);
5031 SearchFileName = clang_getFileName(SearchFile);
5032 ResultFileName = clang_getFileName(ResultFile);
5033 KindSpelling = clang_getCursorKindSpelling(Result.kind);
5034 USR = clang_getCursorUSR(Result);
5035 *Log << llvm::format("(%s:%d:%d) = %s",
5036 clang_getCString(SearchFileName), SearchLine, SearchColumn,
5037 clang_getCString(KindSpelling))
5038 << llvm::format("(%s:%d:%d):%s%s",
5039 clang_getCString(ResultFileName), ResultLine, ResultColumn,
5040 clang_getCString(USR), IsDef);
5041 clang_disposeString(SearchFileName);
5042 clang_disposeString(ResultFileName);
5043 clang_disposeString(KindSpelling);
5044 clang_disposeString(USR);
5046 CXCursor Definition = clang_getCursorDefinition(Result);
5047 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
5048 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
5049 CXString DefinitionKindSpelling
5050 = clang_getCursorKindSpelling(Definition.kind);
5051 CXFile DefinitionFile;
5052 unsigned DefinitionLine, DefinitionColumn;
5053 clang_getFileLocation(DefinitionLoc, &DefinitionFile,
5054 &DefinitionLine, &DefinitionColumn, nullptr);
5055 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
5056 *Log << llvm::format(" -> %s(%s:%d:%d)",
5057 clang_getCString(DefinitionKindSpelling),
5058 clang_getCString(DefinitionFileName),
5059 DefinitionLine, DefinitionColumn);
5060 clang_disposeString(DefinitionFileName);
5061 clang_disposeString(DefinitionKindSpelling);
5068 CXCursor clang_getNullCursor(void) {
5069 return MakeCXCursorInvalid(CXCursor_InvalidFile);
5072 unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
5073 // Clear out the "FirstInDeclGroup" part in a declaration cursor, since we
5074 // can't set consistently. For example, when visiting a DeclStmt we will set
5075 // it but we don't set it on the result of clang_getCursorDefinition for
5076 // a reference of the same declaration.
5077 // FIXME: Setting "FirstInDeclGroup" in CXCursors is a hack that only works
5078 // when visiting a DeclStmt currently, the AST should be enhanced to be able
5079 // to provide that kind of info.
5080 if (clang_isDeclaration(X.kind))
5081 X.data[1] = nullptr;
5082 if (clang_isDeclaration(Y.kind))
5083 Y.data[1] = nullptr;
5088 unsigned clang_hashCursor(CXCursor C) {
5090 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
5093 return llvm::DenseMapInfo<std::pair<unsigned, const void*> >::getHashValue(
5094 std::make_pair(C.kind, C.data[Index]));
5097 unsigned clang_isInvalid(enum CXCursorKind K) {
5098 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
5101 unsigned clang_isDeclaration(enum CXCursorKind K) {
5102 return (K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl) ||
5103 (K >= CXCursor_FirstExtraDecl && K <= CXCursor_LastExtraDecl);
5106 unsigned clang_isReference(enum CXCursorKind K) {
5107 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
5110 unsigned clang_isExpression(enum CXCursorKind K) {
5111 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
5114 unsigned clang_isStatement(enum CXCursorKind K) {
5115 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
5118 unsigned clang_isAttribute(enum CXCursorKind K) {
5119 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
5122 unsigned clang_isTranslationUnit(enum CXCursorKind K) {
5123 return K == CXCursor_TranslationUnit;
5126 unsigned clang_isPreprocessing(enum CXCursorKind K) {
5127 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
5130 unsigned clang_isUnexposed(enum CXCursorKind K) {
5132 case CXCursor_UnexposedDecl:
5133 case CXCursor_UnexposedExpr:
5134 case CXCursor_UnexposedStmt:
5135 case CXCursor_UnexposedAttr:
5142 CXCursorKind clang_getCursorKind(CXCursor C) {
5146 CXSourceLocation clang_getCursorLocation(CXCursor C) {
5147 if (clang_isReference(C.kind)) {
5149 case CXCursor_ObjCSuperClassRef: {
5150 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
5151 = getCursorObjCSuperClassRef(C);
5152 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5155 case CXCursor_ObjCProtocolRef: {
5156 std::pair<const ObjCProtocolDecl *, SourceLocation> P
5157 = getCursorObjCProtocolRef(C);
5158 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5161 case CXCursor_ObjCClassRef: {
5162 std::pair<const ObjCInterfaceDecl *, SourceLocation> P
5163 = getCursorObjCClassRef(C);
5164 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5167 case CXCursor_TypeRef: {
5168 std::pair<const TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
5169 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5172 case CXCursor_TemplateRef: {
5173 std::pair<const TemplateDecl *, SourceLocation> P =
5174 getCursorTemplateRef(C);
5175 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5178 case CXCursor_NamespaceRef: {
5179 std::pair<const NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
5180 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5183 case CXCursor_MemberRef: {
5184 std::pair<const FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
5185 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5188 case CXCursor_VariableRef: {
5189 std::pair<const VarDecl *, SourceLocation> P = getCursorVariableRef(C);
5190 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
5193 case CXCursor_CXXBaseSpecifier: {
5194 const CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
5196 return clang_getNullLocation();
5198 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
5199 return cxloc::translateSourceLocation(getCursorContext(C),
5200 TSInfo->getTypeLoc().getBeginLoc());
5202 return cxloc::translateSourceLocation(getCursorContext(C),
5203 BaseSpec->getLocStart());
5206 case CXCursor_LabelRef: {
5207 std::pair<const LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
5208 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
5211 case CXCursor_OverloadedDeclRef:
5212 return cxloc::translateSourceLocation(getCursorContext(C),
5213 getCursorOverloadedDeclRef(C).second);
5216 // FIXME: Need a way to enumerate all non-reference cases.
5217 llvm_unreachable("Missed a reference kind");
5221 if (clang_isExpression(C.kind))
5222 return cxloc::translateSourceLocation(getCursorContext(C),
5223 getLocationFromExpr(getCursorExpr(C)));
5225 if (clang_isStatement(C.kind))
5226 return cxloc::translateSourceLocation(getCursorContext(C),
5227 getCursorStmt(C)->getLocStart());
5229 if (C.kind == CXCursor_PreprocessingDirective) {
5230 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
5231 return cxloc::translateSourceLocation(getCursorContext(C), L);
5234 if (C.kind == CXCursor_MacroExpansion) {
5236 = cxcursor::getCursorMacroExpansion(C).getSourceRange().getBegin();
5237 return cxloc::translateSourceLocation(getCursorContext(C), L);
5240 if (C.kind == CXCursor_MacroDefinition) {
5241 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
5242 return cxloc::translateSourceLocation(getCursorContext(C), L);
5245 if (C.kind == CXCursor_InclusionDirective) {
5247 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
5248 return cxloc::translateSourceLocation(getCursorContext(C), L);
5251 if (clang_isAttribute(C.kind)) {
5253 = cxcursor::getCursorAttr(C)->getLocation();
5254 return cxloc::translateSourceLocation(getCursorContext(C), L);
5257 if (!clang_isDeclaration(C.kind))
5258 return clang_getNullLocation();
5260 const Decl *D = getCursorDecl(C);
5262 return clang_getNullLocation();
5264 SourceLocation Loc = D->getLocation();
5265 // FIXME: Multiple variables declared in a single declaration
5266 // currently lack the information needed to correctly determine their
5267 // ranges when accounting for the type-specifier. We use context
5268 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5269 // and if so, whether it is the first decl.
5270 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
5271 if (!cxcursor::isFirstInDeclGroup(C))
5272 Loc = VD->getLocation();
5275 // For ObjC methods, give the start location of the method name.
5276 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
5277 Loc = MD->getSelectorStartLoc();
5279 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
5284 CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
5287 // Guard against an invalid SourceLocation, or we may assert in one
5288 // of the following calls.
5289 if (SLoc.isInvalid())
5290 return clang_getNullCursor();
5292 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
5294 // Translate the given source location to make it point at the beginning of
5295 // the token under the cursor.
5296 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
5297 CXXUnit->getASTContext().getLangOpts());
5299 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
5300 if (SLoc.isValid()) {
5301 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
5302 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
5303 /*VisitPreprocessorLast=*/true,
5304 /*VisitIncludedEntities=*/false,
5305 SourceLocation(SLoc));
5306 CursorVis.visitFileRegion();
5312 static SourceRange getRawCursorExtent(CXCursor C) {
5313 if (clang_isReference(C.kind)) {
5315 case CXCursor_ObjCSuperClassRef:
5316 return getCursorObjCSuperClassRef(C).second;
5318 case CXCursor_ObjCProtocolRef:
5319 return getCursorObjCProtocolRef(C).second;
5321 case CXCursor_ObjCClassRef:
5322 return getCursorObjCClassRef(C).second;
5324 case CXCursor_TypeRef:
5325 return getCursorTypeRef(C).second;
5327 case CXCursor_TemplateRef:
5328 return getCursorTemplateRef(C).second;
5330 case CXCursor_NamespaceRef:
5331 return getCursorNamespaceRef(C).second;
5333 case CXCursor_MemberRef:
5334 return getCursorMemberRef(C).second;
5336 case CXCursor_CXXBaseSpecifier:
5337 return getCursorCXXBaseSpecifier(C)->getSourceRange();
5339 case CXCursor_LabelRef:
5340 return getCursorLabelRef(C).second;
5342 case CXCursor_OverloadedDeclRef:
5343 return getCursorOverloadedDeclRef(C).second;
5345 case CXCursor_VariableRef:
5346 return getCursorVariableRef(C).second;
5349 // FIXME: Need a way to enumerate all non-reference cases.
5350 llvm_unreachable("Missed a reference kind");
5354 if (clang_isExpression(C.kind))
5355 return getCursorExpr(C)->getSourceRange();
5357 if (clang_isStatement(C.kind))
5358 return getCursorStmt(C)->getSourceRange();
5360 if (clang_isAttribute(C.kind))
5361 return getCursorAttr(C)->getRange();
5363 if (C.kind == CXCursor_PreprocessingDirective)
5364 return cxcursor::getCursorPreprocessingDirective(C);
5366 if (C.kind == CXCursor_MacroExpansion) {
5367 ASTUnit *TU = getCursorASTUnit(C);
5368 SourceRange Range = cxcursor::getCursorMacroExpansion(C).getSourceRange();
5369 return TU->mapRangeFromPreamble(Range);
5372 if (C.kind == CXCursor_MacroDefinition) {
5373 ASTUnit *TU = getCursorASTUnit(C);
5374 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
5375 return TU->mapRangeFromPreamble(Range);
5378 if (C.kind == CXCursor_InclusionDirective) {
5379 ASTUnit *TU = getCursorASTUnit(C);
5380 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
5381 return TU->mapRangeFromPreamble(Range);
5384 if (C.kind == CXCursor_TranslationUnit) {
5385 ASTUnit *TU = getCursorASTUnit(C);
5386 FileID MainID = TU->getSourceManager().getMainFileID();
5387 SourceLocation Start = TU->getSourceManager().getLocForStartOfFile(MainID);
5388 SourceLocation End = TU->getSourceManager().getLocForEndOfFile(MainID);
5389 return SourceRange(Start, End);
5392 if (clang_isDeclaration(C.kind)) {
5393 const Decl *D = cxcursor::getCursorDecl(C);
5395 return SourceRange();
5397 SourceRange R = D->getSourceRange();
5398 // FIXME: Multiple variables declared in a single declaration
5399 // currently lack the information needed to correctly determine their
5400 // ranges when accounting for the type-specifier. We use context
5401 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5402 // and if so, whether it is the first decl.
5403 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
5404 if (!cxcursor::isFirstInDeclGroup(C))
5405 R.setBegin(VD->getLocation());
5409 return SourceRange();
5412 /// \brief Retrieves the "raw" cursor extent, which is then extended to include
5413 /// the decl-specifier-seq for declarations.
5414 static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
5415 if (clang_isDeclaration(C.kind)) {
5416 const Decl *D = cxcursor::getCursorDecl(C);
5418 return SourceRange();
5420 SourceRange R = D->getSourceRange();
5422 // Adjust the start of the location for declarations preceded by
5423 // declaration specifiers.
5424 SourceLocation StartLoc;
5425 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
5426 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
5427 StartLoc = TI->getTypeLoc().getLocStart();
5428 } else if (const TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
5429 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
5430 StartLoc = TI->getTypeLoc().getLocStart();
5433 if (StartLoc.isValid() && R.getBegin().isValid() &&
5434 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
5435 R.setBegin(StartLoc);
5437 // FIXME: Multiple variables declared in a single declaration
5438 // currently lack the information needed to correctly determine their
5439 // ranges when accounting for the type-specifier. We use context
5440 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
5441 // and if so, whether it is the first decl.
5442 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
5443 if (!cxcursor::isFirstInDeclGroup(C))
5444 R.setBegin(VD->getLocation());
5450 return getRawCursorExtent(C);
5455 CXSourceRange clang_getCursorExtent(CXCursor C) {
5456 SourceRange R = getRawCursorExtent(C);
5458 return clang_getNullRange();
5460 return cxloc::translateSourceRange(getCursorContext(C), R);
5463 CXCursor clang_getCursorReferenced(CXCursor C) {
5464 if (clang_isInvalid(C.kind))
5465 return clang_getNullCursor();
5467 CXTranslationUnit tu = getCursorTU(C);
5468 if (clang_isDeclaration(C.kind)) {
5469 const Decl *D = getCursorDecl(C);
5471 return clang_getNullCursor();
5472 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
5473 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
5474 if (const ObjCPropertyImplDecl *PropImpl =
5475 dyn_cast<ObjCPropertyImplDecl>(D))
5476 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
5477 return MakeCXCursor(Property, tu);
5482 if (clang_isExpression(C.kind)) {
5483 const Expr *E = getCursorExpr(C);
5484 const Decl *D = getDeclFromExpr(E);
5486 CXCursor declCursor = MakeCXCursor(D, tu);
5487 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
5492 if (const OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
5493 return MakeCursorOverloadedDeclRef(Ovl, tu);
5495 return clang_getNullCursor();
5498 if (clang_isStatement(C.kind)) {
5499 const Stmt *S = getCursorStmt(C);
5500 if (const GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
5501 if (LabelDecl *label = Goto->getLabel())
5502 if (LabelStmt *labelS = label->getStmt())
5503 return MakeCXCursor(labelS, getCursorDecl(C), tu);
5505 return clang_getNullCursor();
5508 if (C.kind == CXCursor_MacroExpansion) {
5509 if (const MacroDefinitionRecord *Def =
5510 getCursorMacroExpansion(C).getDefinition())
5511 return MakeMacroDefinitionCursor(Def, tu);
5514 if (!clang_isReference(C.kind))
5515 return clang_getNullCursor();
5518 case CXCursor_ObjCSuperClassRef:
5519 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
5521 case CXCursor_ObjCProtocolRef: {
5522 const ObjCProtocolDecl *Prot = getCursorObjCProtocolRef(C).first;
5523 if (const ObjCProtocolDecl *Def = Prot->getDefinition())
5524 return MakeCXCursor(Def, tu);
5526 return MakeCXCursor(Prot, tu);
5529 case CXCursor_ObjCClassRef: {
5530 const ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
5531 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
5532 return MakeCXCursor(Def, tu);
5534 return MakeCXCursor(Class, tu);
5537 case CXCursor_TypeRef:
5538 return MakeCXCursor(getCursorTypeRef(C).first, tu );
5540 case CXCursor_TemplateRef:
5541 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
5543 case CXCursor_NamespaceRef:
5544 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
5546 case CXCursor_MemberRef:
5547 return MakeCXCursor(getCursorMemberRef(C).first, tu );
5549 case CXCursor_CXXBaseSpecifier: {
5550 const CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
5551 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
5555 case CXCursor_LabelRef:
5556 // FIXME: We end up faking the "parent" declaration here because we
5557 // don't want to make CXCursor larger.
5558 return MakeCXCursor(getCursorLabelRef(C).first,
5559 cxtu::getASTUnit(tu)->getASTContext()
5560 .getTranslationUnitDecl(),
5563 case CXCursor_OverloadedDeclRef:
5566 case CXCursor_VariableRef:
5567 return MakeCXCursor(getCursorVariableRef(C).first, tu);
5570 // We would prefer to enumerate all non-reference cursor kinds here.
5571 llvm_unreachable("Unhandled reference cursor kind");
5575 CXCursor clang_getCursorDefinition(CXCursor C) {
5576 if (clang_isInvalid(C.kind))
5577 return clang_getNullCursor();
5579 CXTranslationUnit TU = getCursorTU(C);
5581 bool WasReference = false;
5582 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
5583 C = clang_getCursorReferenced(C);
5584 WasReference = true;
5587 if (C.kind == CXCursor_MacroExpansion)
5588 return clang_getCursorReferenced(C);
5590 if (!clang_isDeclaration(C.kind))
5591 return clang_getNullCursor();
5593 const Decl *D = getCursorDecl(C);
5595 return clang_getNullCursor();
5597 switch (D->getKind()) {
5598 // Declaration kinds that don't really separate the notions of
5599 // declaration and definition.
5600 case Decl::Namespace:
5602 case Decl::TypeAlias:
5603 case Decl::TypeAliasTemplate:
5604 case Decl::TemplateTypeParm:
5605 case Decl::EnumConstant:
5607 case Decl::MSProperty:
5608 case Decl::IndirectField:
5609 case Decl::ObjCIvar:
5610 case Decl::ObjCAtDefsField:
5611 case Decl::ImplicitParam:
5613 case Decl::NonTypeTemplateParm:
5614 case Decl::TemplateTemplateParm:
5615 case Decl::ObjCCategoryImpl:
5616 case Decl::ObjCImplementation:
5617 case Decl::AccessSpec:
5618 case Decl::LinkageSpec:
5619 case Decl::ObjCPropertyImpl:
5620 case Decl::FileScopeAsm:
5621 case Decl::StaticAssert:
5623 case Decl::Captured:
5624 case Decl::Label: // FIXME: Is this right??
5625 case Decl::ClassScopeFunctionSpecialization:
5627 case Decl::OMPThreadPrivate:
5628 case Decl::ObjCTypeParam:
5629 case Decl::BuiltinTemplate:
5632 // Declaration kinds that don't make any sense here, but are
5633 // nonetheless harmless.
5635 case Decl::TranslationUnit:
5636 case Decl::ExternCContext:
5639 // Declaration kinds for which the definition is not resolvable.
5640 case Decl::UnresolvedUsingTypename:
5641 case Decl::UnresolvedUsingValue:
5644 case Decl::UsingDirective:
5645 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
5648 case Decl::NamespaceAlias:
5649 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
5653 case Decl::CXXRecord:
5654 case Decl::ClassTemplateSpecialization:
5655 case Decl::ClassTemplatePartialSpecialization:
5656 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
5657 return MakeCXCursor(Def, TU);
5658 return clang_getNullCursor();
5660 case Decl::Function:
5661 case Decl::CXXMethod:
5662 case Decl::CXXConstructor:
5663 case Decl::CXXDestructor:
5664 case Decl::CXXConversion: {
5665 const FunctionDecl *Def = nullptr;
5666 if (cast<FunctionDecl>(D)->getBody(Def))
5667 return MakeCXCursor(Def, TU);
5668 return clang_getNullCursor();
5672 case Decl::VarTemplateSpecialization:
5673 case Decl::VarTemplatePartialSpecialization: {
5674 // Ask the variable if it has a definition.
5675 if (const VarDecl *Def = cast<VarDecl>(D)->getDefinition())
5676 return MakeCXCursor(Def, TU);
5677 return clang_getNullCursor();
5680 case Decl::FunctionTemplate: {
5681 const FunctionDecl *Def = nullptr;
5682 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
5683 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
5684 return clang_getNullCursor();
5687 case Decl::ClassTemplate: {
5688 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
5690 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
5692 return clang_getNullCursor();
5695 case Decl::VarTemplate: {
5697 cast<VarTemplateDecl>(D)->getTemplatedDecl()->getDefinition())
5698 return MakeCXCursor(cast<VarDecl>(Def)->getDescribedVarTemplate(), TU);
5699 return clang_getNullCursor();
5703 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
5704 D->getLocation(), TU);
5706 case Decl::UsingShadow:
5707 return clang_getCursorDefinition(
5708 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
5711 case Decl::ObjCMethod: {
5712 const ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
5713 if (Method->isThisDeclarationADefinition())
5716 // Dig out the method definition in the associated
5717 // @implementation, if we have it.
5718 // FIXME: The ASTs should make finding the definition easier.
5719 if (const ObjCInterfaceDecl *Class
5720 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
5721 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
5722 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
5723 Method->isInstanceMethod()))
5724 if (Def->isThisDeclarationADefinition())
5725 return MakeCXCursor(Def, TU);
5727 return clang_getNullCursor();
5730 case Decl::ObjCCategory:
5731 if (ObjCCategoryImplDecl *Impl
5732 = cast<ObjCCategoryDecl>(D)->getImplementation())
5733 return MakeCXCursor(Impl, TU);
5734 return clang_getNullCursor();
5736 case Decl::ObjCProtocol:
5737 if (const ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(D)->getDefinition())
5738 return MakeCXCursor(Def, TU);
5739 return clang_getNullCursor();
5741 case Decl::ObjCInterface: {
5742 // There are two notions of a "definition" for an Objective-C
5743 // class: the interface and its implementation. When we resolved a
5744 // reference to an Objective-C class, produce the @interface as
5745 // the definition; when we were provided with the interface,
5746 // produce the @implementation as the definition.
5747 const ObjCInterfaceDecl *IFace = cast<ObjCInterfaceDecl>(D);
5749 if (const ObjCInterfaceDecl *Def = IFace->getDefinition())
5750 return MakeCXCursor(Def, TU);
5751 } else if (ObjCImplementationDecl *Impl = IFace->getImplementation())
5752 return MakeCXCursor(Impl, TU);
5753 return clang_getNullCursor();
5756 case Decl::ObjCProperty:
5757 // FIXME: We don't really know where to find the
5758 // ObjCPropertyImplDecls that implement this property.
5759 return clang_getNullCursor();
5761 case Decl::ObjCCompatibleAlias:
5762 if (const ObjCInterfaceDecl *Class
5763 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
5764 if (const ObjCInterfaceDecl *Def = Class->getDefinition())
5765 return MakeCXCursor(Def, TU);
5767 return clang_getNullCursor();
5770 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
5771 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5772 return clang_getNullCursor();
5774 case Decl::FriendTemplate:
5775 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
5776 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
5777 return clang_getNullCursor();
5780 return clang_getNullCursor();
5783 unsigned clang_isCursorDefinition(CXCursor C) {
5784 if (!clang_isDeclaration(C.kind))
5787 return clang_getCursorDefinition(C) == C;
5790 CXCursor clang_getCanonicalCursor(CXCursor C) {
5791 if (!clang_isDeclaration(C.kind))
5794 if (const Decl *D = getCursorDecl(C)) {
5795 if (const ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
5796 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
5797 return MakeCXCursor(CatD, getCursorTU(C));
5799 if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
5800 if (const ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
5801 return MakeCXCursor(IFD, getCursorTU(C));
5803 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
5809 int clang_Cursor_getObjCSelectorIndex(CXCursor cursor) {
5810 return cxcursor::getSelectorIdentifierIndexAndLoc(cursor).first;
5813 unsigned clang_getNumOverloadedDecls(CXCursor C) {
5814 if (C.kind != CXCursor_OverloadedDeclRef)
5817 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
5818 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
5819 return E->getNumDecls();
5821 if (OverloadedTemplateStorage *S
5822 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5825 const Decl *D = Storage.get<const Decl *>();
5826 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D))
5827 return Using->shadow_size();
5832 CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
5833 if (cursor.kind != CXCursor_OverloadedDeclRef)
5834 return clang_getNullCursor();
5836 if (index >= clang_getNumOverloadedDecls(cursor))
5837 return clang_getNullCursor();
5839 CXTranslationUnit TU = getCursorTU(cursor);
5840 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
5841 if (const OverloadExpr *E = Storage.dyn_cast<const OverloadExpr *>())
5842 return MakeCXCursor(E->decls_begin()[index], TU);
5844 if (OverloadedTemplateStorage *S
5845 = Storage.dyn_cast<OverloadedTemplateStorage*>())
5846 return MakeCXCursor(S->begin()[index], TU);
5848 const Decl *D = Storage.get<const Decl *>();
5849 if (const UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
5850 // FIXME: This is, unfortunately, linear time.
5851 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
5852 std::advance(Pos, index);
5853 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
5856 return clang_getNullCursor();
5859 void clang_getDefinitionSpellingAndExtent(CXCursor C,
5860 const char **startBuf,
5861 const char **endBuf,
5862 unsigned *startLine,
5863 unsigned *startColumn,
5865 unsigned *endColumn) {
5866 assert(getCursorDecl(C) && "CXCursor has null decl");
5867 const FunctionDecl *FD = dyn_cast<FunctionDecl>(getCursorDecl(C));
5868 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
5870 SourceManager &SM = FD->getASTContext().getSourceManager();
5871 *startBuf = SM.getCharacterData(Body->getLBracLoc());
5872 *endBuf = SM.getCharacterData(Body->getRBracLoc());
5873 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
5874 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
5875 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
5876 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
5880 CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
5881 unsigned PieceIndex) {
5882 RefNamePieces Pieces;
5885 case CXCursor_MemberRefExpr:
5886 if (const MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
5887 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
5888 E->getQualifierLoc().getSourceRange());
5891 case CXCursor_DeclRefExpr:
5892 if (const DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C))) {
5893 SourceRange TemplateArgLoc(E->getLAngleLoc(), E->getRAngleLoc());
5895 buildPieces(NameFlags, false, E->getNameInfo(),
5896 E->getQualifierLoc().getSourceRange(), &TemplateArgLoc);
5900 case CXCursor_CallExpr:
5901 if (const CXXOperatorCallExpr *OCE =
5902 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
5903 const Expr *Callee = OCE->getCallee();
5904 if (const ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
5905 Callee = ICE->getSubExpr();
5907 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
5908 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
5909 DRE->getQualifierLoc().getSourceRange());
5917 if (Pieces.empty()) {
5918 if (PieceIndex == 0)
5919 return clang_getCursorExtent(C);
5920 } else if (PieceIndex < Pieces.size()) {
5921 SourceRange R = Pieces[PieceIndex];
5923 return cxloc::translateSourceRange(getCursorContext(C), R);
5926 return clang_getNullRange();
5929 void clang_enableStackTraces(void) {
5930 llvm::sys::PrintStackTraceOnErrorSignal();
5933 void clang_executeOnThread(void (*fn)(void*), void *user_data,
5934 unsigned stack_size) {
5935 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
5938 } // end: extern "C"
5940 //===----------------------------------------------------------------------===//
5941 // Token-based Operations.
5942 //===----------------------------------------------------------------------===//
5945 * int_data[0]: a CXTokenKind
5946 * int_data[1]: starting token location
5947 * int_data[2]: token length
5948 * int_data[3]: reserved
5949 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
5954 CXTokenKind clang_getTokenKind(CXToken CXTok) {
5955 return static_cast<CXTokenKind>(CXTok.int_data[0]);
5958 CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
5959 switch (clang_getTokenKind(CXTok)) {
5960 case CXToken_Identifier:
5961 case CXToken_Keyword:
5962 // We know we have an IdentifierInfo*, so use that.
5963 return cxstring::createRef(static_cast<IdentifierInfo *>(CXTok.ptr_data)
5966 case CXToken_Literal: {
5967 // We have stashed the starting pointer in the ptr_data field. Use it.
5968 const char *Text = static_cast<const char *>(CXTok.ptr_data);
5969 return cxstring::createDup(StringRef(Text, CXTok.int_data[2]));
5972 case CXToken_Punctuation:
5973 case CXToken_Comment:
5977 if (isNotUsableTU(TU)) {
5979 return cxstring::createEmpty();
5982 // We have to find the starting buffer pointer the hard way, by
5983 // deconstructing the source location.
5984 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
5986 return cxstring::createEmpty();
5988 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
5989 std::pair<FileID, unsigned> LocInfo
5990 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
5991 bool Invalid = false;
5993 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
5995 return cxstring::createEmpty();
5997 return cxstring::createDup(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
6000 CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
6001 if (isNotUsableTU(TU)) {
6003 return clang_getNullLocation();
6006 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6008 return clang_getNullLocation();
6010 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
6011 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6014 CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
6015 if (isNotUsableTU(TU)) {
6017 return clang_getNullRange();
6020 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6022 return clang_getNullRange();
6024 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
6025 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
6028 static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
6029 SmallVectorImpl<CXToken> &CXTokens) {
6030 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6031 std::pair<FileID, unsigned> BeginLocInfo
6032 = SourceMgr.getDecomposedSpellingLoc(Range.getBegin());
6033 std::pair<FileID, unsigned> EndLocInfo
6034 = SourceMgr.getDecomposedSpellingLoc(Range.getEnd());
6036 // Cannot tokenize across files.
6037 if (BeginLocInfo.first != EndLocInfo.first)
6041 bool Invalid = false;
6043 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6047 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6048 CXXUnit->getASTContext().getLangOpts(),
6049 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
6050 Lex.SetCommentRetentionState(true);
6052 // Lex tokens until we hit the end of the range.
6053 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
6055 bool previousWasAt = false;
6057 // Lex the next token
6058 Lex.LexFromRawLexer(Tok);
6059 if (Tok.is(tok::eof))
6062 // Initialize the CXToken.
6066 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
6067 CXTok.int_data[2] = Tok.getLength();
6068 CXTok.int_data[3] = 0;
6070 // - Kind-specific fields
6071 if (Tok.isLiteral()) {
6072 CXTok.int_data[0] = CXToken_Literal;
6073 CXTok.ptr_data = const_cast<char *>(Tok.getLiteralData());
6074 } else if (Tok.is(tok::raw_identifier)) {
6075 // Lookup the identifier to determine whether we have a keyword.
6077 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
6079 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
6080 CXTok.int_data[0] = CXToken_Keyword;
6083 CXTok.int_data[0] = Tok.is(tok::identifier)
6084 ? CXToken_Identifier
6087 CXTok.ptr_data = II;
6088 } else if (Tok.is(tok::comment)) {
6089 CXTok.int_data[0] = CXToken_Comment;
6090 CXTok.ptr_data = nullptr;
6092 CXTok.int_data[0] = CXToken_Punctuation;
6093 CXTok.ptr_data = nullptr;
6095 CXTokens.push_back(CXTok);
6096 previousWasAt = Tok.is(tok::at);
6097 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
6100 void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
6101 CXToken **Tokens, unsigned *NumTokens) {
6103 *Log << TU << ' ' << Range;
6111 if (isNotUsableTU(TU)) {
6116 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6117 if (!CXXUnit || !Tokens || !NumTokens)
6120 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6122 SourceRange R = cxloc::translateCXSourceRange(Range);
6126 SmallVector<CXToken, 32> CXTokens;
6127 getTokens(CXXUnit, R, CXTokens);
6129 if (CXTokens.empty())
6132 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
6133 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
6134 *NumTokens = CXTokens.size();
6137 void clang_disposeTokens(CXTranslationUnit TU,
6138 CXToken *Tokens, unsigned NumTokens) {
6142 } // end: extern "C"
6144 //===----------------------------------------------------------------------===//
6145 // Token annotation APIs.
6146 //===----------------------------------------------------------------------===//
6148 static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6150 CXClientData client_data);
6151 static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6152 CXClientData client_data);
6155 class AnnotateTokensWorker {
6160 unsigned PreprocessingTokIdx;
6161 CursorVisitor AnnotateVis;
6162 SourceManager &SrcMgr;
6163 bool HasContextSensitiveKeywords;
6165 struct PostChildrenInfo {
6167 SourceRange CursorRange;
6168 unsigned BeforeReachingCursorIdx;
6169 unsigned BeforeChildrenTokenIdx;
6171 SmallVector<PostChildrenInfo, 8> PostChildrenInfos;
6173 CXToken &getTok(unsigned Idx) {
6174 assert(Idx < NumTokens);
6177 const CXToken &getTok(unsigned Idx) const {
6178 assert(Idx < NumTokens);
6181 bool MoreTokens() const { return TokIdx < NumTokens; }
6182 unsigned NextToken() const { return TokIdx; }
6183 void AdvanceToken() { ++TokIdx; }
6184 SourceLocation GetTokenLoc(unsigned tokI) {
6185 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
6187 bool isFunctionMacroToken(unsigned tokI) const {
6188 return getTok(tokI).int_data[3] != 0;
6190 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
6191 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[3]);
6194 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
6195 bool annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
6199 AnnotateTokensWorker(CXToken *tokens, CXCursor *cursors, unsigned numTokens,
6200 CXTranslationUnit TU, SourceRange RegionOfInterest)
6201 : Tokens(tokens), Cursors(cursors),
6202 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
6204 AnnotateTokensVisitor, this,
6205 /*VisitPreprocessorLast=*/true,
6206 /*VisitIncludedEntities=*/false,
6208 /*VisitDeclsOnly=*/false,
6209 AnnotateTokensPostChildrenVisitor),
6210 SrcMgr(cxtu::getASTUnit(TU)->getSourceManager()),
6211 HasContextSensitiveKeywords(false) { }
6213 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
6214 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
6215 bool postVisitChildren(CXCursor cursor);
6216 void AnnotateTokens();
6218 /// \brief Determine whether the annotator saw any cursors that have
6219 /// context-sensitive keywords.
6220 bool hasContextSensitiveKeywords() const {
6221 return HasContextSensitiveKeywords;
6224 ~AnnotateTokensWorker() {
6225 assert(PostChildrenInfos.empty());
6230 void AnnotateTokensWorker::AnnotateTokens() {
6231 // Walk the AST within the region of interest, annotating tokens
6233 AnnotateVis.visitFileRegion();
6236 static inline void updateCursorAnnotation(CXCursor &Cursor,
6237 const CXCursor &updateC) {
6238 if (clang_isInvalid(updateC.kind) || !clang_isInvalid(Cursor.kind))
6243 /// \brief It annotates and advances tokens with a cursor until the comparison
6244 //// between the cursor location and the source range is the same as
6245 /// \arg compResult.
6247 /// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
6248 /// Pass RangeOverlap to annotate tokens inside a range.
6249 void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
6250 RangeComparisonResult compResult,
6251 SourceRange range) {
6252 while (MoreTokens()) {
6253 const unsigned I = NextToken();
6254 if (isFunctionMacroToken(I))
6255 if (!annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range))
6258 SourceLocation TokLoc = GetTokenLoc(I);
6259 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6260 updateCursorAnnotation(Cursors[I], updateC);
6268 /// \brief Special annotation handling for macro argument tokens.
6269 /// \returns true if it advanced beyond all macro tokens, false otherwise.
6270 bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
6272 RangeComparisonResult compResult,
6273 SourceRange range) {
6274 assert(MoreTokens());
6275 assert(isFunctionMacroToken(NextToken()) &&
6276 "Should be called only for macro arg tokens");
6278 // This works differently than annotateAndAdvanceTokens; because expanded
6279 // macro arguments can have arbitrary translation-unit source order, we do not
6280 // advance the token index one by one until a token fails the range test.
6281 // We only advance once past all of the macro arg tokens if all of them
6282 // pass the range test. If one of them fails we keep the token index pointing
6283 // at the start of the macro arg tokens so that the failing token will be
6284 // annotated by a subsequent annotation try.
6286 bool atLeastOneCompFail = false;
6288 unsigned I = NextToken();
6289 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
6290 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
6291 if (TokLoc.isFileID())
6292 continue; // not macro arg token, it's parens or comma.
6293 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
6294 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
6295 Cursors[I] = updateC;
6297 atLeastOneCompFail = true;
6300 if (atLeastOneCompFail)
6303 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
6307 enum CXChildVisitResult
6308 AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
6309 SourceRange cursorRange = getRawCursorExtent(cursor);
6310 if (cursorRange.isInvalid())
6311 return CXChildVisit_Recurse;
6313 if (!HasContextSensitiveKeywords) {
6314 // Objective-C properties can have context-sensitive keywords.
6315 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
6316 if (const ObjCPropertyDecl *Property
6317 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
6318 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
6320 // Objective-C methods can have context-sensitive keywords.
6321 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
6322 cursor.kind == CXCursor_ObjCClassMethodDecl) {
6323 if (const ObjCMethodDecl *Method
6324 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
6325 if (Method->getObjCDeclQualifier())
6326 HasContextSensitiveKeywords = true;
6328 for (const auto *P : Method->params()) {
6329 if (P->getObjCDeclQualifier()) {
6330 HasContextSensitiveKeywords = true;
6337 // C++ methods can have context-sensitive keywords.
6338 else if (cursor.kind == CXCursor_CXXMethod) {
6339 if (const CXXMethodDecl *Method
6340 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
6341 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
6342 HasContextSensitiveKeywords = true;
6345 // C++ classes can have context-sensitive keywords.
6346 else if (cursor.kind == CXCursor_StructDecl ||
6347 cursor.kind == CXCursor_ClassDecl ||
6348 cursor.kind == CXCursor_ClassTemplate ||
6349 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
6350 if (const Decl *D = getCursorDecl(cursor))
6351 if (D->hasAttr<FinalAttr>())
6352 HasContextSensitiveKeywords = true;
6356 // Don't override a property annotation with its getter/setter method.
6357 if (cursor.kind == CXCursor_ObjCInstanceMethodDecl &&
6358 parent.kind == CXCursor_ObjCPropertyDecl)
6359 return CXChildVisit_Continue;
6361 if (clang_isPreprocessing(cursor.kind)) {
6362 // Items in the preprocessing record are kept separate from items in
6363 // declarations, so we keep a separate token index.
6364 unsigned SavedTokIdx = TokIdx;
6365 TokIdx = PreprocessingTokIdx;
6367 // Skip tokens up until we catch up to the beginning of the preprocessing
6369 while (MoreTokens()) {
6370 const unsigned I = NextToken();
6371 SourceLocation TokLoc = GetTokenLoc(I);
6372 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6383 // Look at all of the tokens within this range.
6384 while (MoreTokens()) {
6385 const unsigned I = NextToken();
6386 SourceLocation TokLoc = GetTokenLoc(I);
6387 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
6389 llvm_unreachable("Infeasible");
6393 // For macro expansions, just note where the beginning of the macro
6394 // expansion occurs.
6395 if (cursor.kind == CXCursor_MacroExpansion) {
6396 if (TokLoc == cursorRange.getBegin())
6397 Cursors[I] = cursor;
6401 // We may have already annotated macro names inside macro definitions.
6402 if (Cursors[I].kind != CXCursor_MacroExpansion)
6403 Cursors[I] = cursor;
6410 // Save the preprocessing token index; restore the non-preprocessing
6412 PreprocessingTokIdx = TokIdx;
6413 TokIdx = SavedTokIdx;
6414 return CXChildVisit_Recurse;
6417 if (cursorRange.isInvalid())
6418 return CXChildVisit_Continue;
6420 unsigned BeforeReachingCursorIdx = NextToken();
6421 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
6422 const enum CXCursorKind K = clang_getCursorKind(parent);
6423 const CXCursor updateC =
6424 (clang_isInvalid(K) || K == CXCursor_TranslationUnit ||
6425 // Attributes are annotated out-of-order, skip tokens until we reach it.
6426 clang_isAttribute(cursor.kind))
6427 ? clang_getNullCursor() : parent;
6429 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
6431 // Avoid having the cursor of an expression "overwrite" the annotation of the
6432 // variable declaration that it belongs to.
6433 // This can happen for C++ constructor expressions whose range generally
6434 // include the variable declaration, e.g.:
6435 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
6436 if (clang_isExpression(cursorK) && MoreTokens()) {
6437 const Expr *E = getCursorExpr(cursor);
6438 if (const Decl *D = getCursorParentDecl(cursor)) {
6439 const unsigned I = NextToken();
6440 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
6441 E->getLocStart() == D->getLocation() &&
6442 E->getLocStart() == GetTokenLoc(I)) {
6443 updateCursorAnnotation(Cursors[I], updateC);
6449 // Before recursing into the children keep some state that we are going
6450 // to use in the AnnotateTokensWorker::postVisitChildren callback to do some
6451 // extra work after the child nodes are visited.
6452 // Note that we don't call VisitChildren here to avoid traversing statements
6453 // code-recursively which can blow the stack.
6455 PostChildrenInfo Info;
6456 Info.Cursor = cursor;
6457 Info.CursorRange = cursorRange;
6458 Info.BeforeReachingCursorIdx = BeforeReachingCursorIdx;
6459 Info.BeforeChildrenTokenIdx = NextToken();
6460 PostChildrenInfos.push_back(Info);
6462 return CXChildVisit_Recurse;
6465 bool AnnotateTokensWorker::postVisitChildren(CXCursor cursor) {
6466 if (PostChildrenInfos.empty())
6468 const PostChildrenInfo &Info = PostChildrenInfos.back();
6469 if (!clang_equalCursors(Info.Cursor, cursor))
6472 const unsigned BeforeChildren = Info.BeforeChildrenTokenIdx;
6473 const unsigned AfterChildren = NextToken();
6474 SourceRange cursorRange = Info.CursorRange;
6476 // Scan the tokens that are at the end of the cursor, but are not captured
6477 // but the child cursors.
6478 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
6480 // Scan the tokens that are at the beginning of the cursor, but are not
6481 // capture by the child cursors.
6482 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
6483 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
6486 Cursors[I] = cursor;
6489 // Attributes are annotated out-of-order, rewind TokIdx to when we first
6490 // encountered the attribute cursor.
6491 if (clang_isAttribute(cursor.kind))
6492 TokIdx = Info.BeforeReachingCursorIdx;
6494 PostChildrenInfos.pop_back();
6498 static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
6500 CXClientData client_data) {
6501 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
6504 static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor,
6505 CXClientData client_data) {
6506 return static_cast<AnnotateTokensWorker*>(client_data)->
6507 postVisitChildren(cursor);
6512 /// \brief Uses the macro expansions in the preprocessing record to find
6513 /// and mark tokens that are macro arguments. This info is used by the
6514 /// AnnotateTokensWorker.
6515 class MarkMacroArgTokensVisitor {
6522 MarkMacroArgTokensVisitor(SourceManager &SM,
6523 CXToken *tokens, unsigned numTokens)
6524 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
6526 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
6527 if (cursor.kind != CXCursor_MacroExpansion)
6528 return CXChildVisit_Continue;
6530 SourceRange macroRange = getCursorMacroExpansion(cursor).getSourceRange();
6531 if (macroRange.getBegin() == macroRange.getEnd())
6532 return CXChildVisit_Continue; // it's not a function macro.
6534 for (; CurIdx < NumTokens; ++CurIdx) {
6535 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
6536 macroRange.getBegin()))
6540 if (CurIdx == NumTokens)
6541 return CXChildVisit_Break;
6543 for (; CurIdx < NumTokens; ++CurIdx) {
6544 SourceLocation tokLoc = getTokenLoc(CurIdx);
6545 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
6548 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
6551 if (CurIdx == NumTokens)
6552 return CXChildVisit_Break;
6554 return CXChildVisit_Continue;
6558 CXToken &getTok(unsigned Idx) {
6559 assert(Idx < NumTokens);
6562 const CXToken &getTok(unsigned Idx) const {
6563 assert(Idx < NumTokens);
6567 SourceLocation getTokenLoc(unsigned tokI) {
6568 return SourceLocation::getFromRawEncoding(getTok(tokI).int_data[1]);
6571 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
6572 // The third field is reserved and currently not used. Use it here
6573 // to mark macro arg expanded tokens with their expanded locations.
6574 getTok(tokI).int_data[3] = loc.getRawEncoding();
6578 } // end anonymous namespace
6580 static CXChildVisitResult
6581 MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
6582 CXClientData client_data) {
6583 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
6587 /// \brief Used by \c annotatePreprocessorTokens.
6588 /// \returns true if lexing was finished, false otherwise.
6589 static bool lexNext(Lexer &Lex, Token &Tok,
6590 unsigned &NextIdx, unsigned NumTokens) {
6591 if (NextIdx >= NumTokens)
6595 Lex.LexFromRawLexer(Tok);
6596 return Tok.is(tok::eof);
6599 static void annotatePreprocessorTokens(CXTranslationUnit TU,
6600 SourceRange RegionOfInterest,
6603 unsigned NumTokens) {
6604 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6606 Preprocessor &PP = CXXUnit->getPreprocessor();
6607 SourceManager &SourceMgr = CXXUnit->getSourceManager();
6608 std::pair<FileID, unsigned> BeginLocInfo
6609 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getBegin());
6610 std::pair<FileID, unsigned> EndLocInfo
6611 = SourceMgr.getDecomposedSpellingLoc(RegionOfInterest.getEnd());
6613 if (BeginLocInfo.first != EndLocInfo.first)
6617 bool Invalid = false;
6618 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
6619 if (Buffer.empty() || Invalid)
6622 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
6623 CXXUnit->getASTContext().getLangOpts(),
6624 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
6626 Lex.SetCommentRetentionState(true);
6628 unsigned NextIdx = 0;
6629 // Lex tokens in raw mode until we hit the end of the range, to avoid
6630 // entering #includes or expanding macros.
6633 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6635 unsigned TokIdx = NextIdx-1;
6636 assert(Tok.getLocation() ==
6637 SourceLocation::getFromRawEncoding(Tokens[TokIdx].int_data[1]));
6640 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
6641 // We have found a preprocessing directive. Annotate the tokens
6644 // FIXME: Some simple tests here could identify macro definitions and
6645 // #undefs, to provide specific cursor kinds for those.
6647 SourceLocation BeginLoc = Tok.getLocation();
6648 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6651 MacroInfo *MI = nullptr;
6652 if (Tok.is(tok::raw_identifier) && Tok.getRawIdentifier() == "define") {
6653 if (lexNext(Lex, Tok, NextIdx, NumTokens))
6656 if (Tok.is(tok::raw_identifier)) {
6657 IdentifierInfo &II =
6658 PP.getIdentifierTable().get(Tok.getRawIdentifier());
6659 SourceLocation MappedTokLoc =
6660 CXXUnit->mapLocationToPreamble(Tok.getLocation());
6661 MI = getMacroInfo(II, MappedTokLoc, TU);
6665 bool finished = false;
6667 if (lexNext(Lex, Tok, NextIdx, NumTokens)) {
6671 // If we are in a macro definition, check if the token was ever a
6672 // macro name and annotate it if that's the case.
6674 SourceLocation SaveLoc = Tok.getLocation();
6675 Tok.setLocation(CXXUnit->mapLocationToPreamble(SaveLoc));
6676 MacroDefinitionRecord *MacroDef =
6677 checkForMacroInMacroDefinition(MI, Tok, TU);
6678 Tok.setLocation(SaveLoc);
6680 Cursors[NextIdx - 1] =
6681 MakeMacroExpansionCursor(MacroDef, Tok.getLocation(), TU);
6683 } while (!Tok.isAtStartOfLine());
6685 unsigned LastIdx = finished ? NextIdx-1 : NextIdx-2;
6686 assert(TokIdx <= LastIdx);
6687 SourceLocation EndLoc =
6688 SourceLocation::getFromRawEncoding(Tokens[LastIdx].int_data[1]);
6690 MakePreprocessingDirectiveCursor(SourceRange(BeginLoc, EndLoc), TU);
6692 for (; TokIdx <= LastIdx; ++TokIdx)
6693 updateCursorAnnotation(Cursors[TokIdx], Cursor);
6702 // This gets run a separate thread to avoid stack blowout.
6703 static void clang_annotateTokensImpl(CXTranslationUnit TU, ASTUnit *CXXUnit,
6704 CXToken *Tokens, unsigned NumTokens,
6705 CXCursor *Cursors) {
6706 CIndexer *CXXIdx = TU->CIdx;
6707 if (CXXIdx->isOptEnabled(CXGlobalOpt_ThreadBackgroundPriorityForEditing))
6708 setThreadBackgroundPriority();
6710 // Determine the region of interest, which contains all of the tokens.
6711 SourceRange RegionOfInterest;
6712 RegionOfInterest.setBegin(
6713 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
6714 RegionOfInterest.setEnd(
6715 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
6716 Tokens[NumTokens-1])));
6718 // Relex the tokens within the source range to look for preprocessing
6720 annotatePreprocessorTokens(TU, RegionOfInterest, Cursors, Tokens, NumTokens);
6722 // If begin location points inside a macro argument, set it to the expansion
6723 // location so we can have the full context when annotating semantically.
6725 SourceManager &SM = CXXUnit->getSourceManager();
6726 SourceLocation Loc =
6727 SM.getMacroArgExpandedLocation(RegionOfInterest.getBegin());
6728 if (Loc.isMacroID())
6729 RegionOfInterest.setBegin(SM.getExpansionLoc(Loc));
6732 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
6733 // Search and mark tokens that are macro argument expansions.
6734 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
6736 CursorVisitor MacroArgMarker(TU,
6737 MarkMacroArgTokensVisitorDelegate, &Visitor,
6738 /*VisitPreprocessorLast=*/true,
6739 /*VisitIncludedEntities=*/false,
6741 MacroArgMarker.visitPreprocessedEntitiesInRegion();
6744 // Annotate all of the source locations in the region of interest that map to
6745 // a specific cursor.
6746 AnnotateTokensWorker W(Tokens, Cursors, NumTokens, TU, RegionOfInterest);
6748 // FIXME: We use a ridiculous stack size here because the data-recursion
6749 // algorithm uses a large stack frame than the non-data recursive version,
6750 // and AnnotationTokensWorker currently transforms the data-recursion
6751 // algorithm back into a traditional recursion by explicitly calling
6752 // VisitChildren(). We will need to remove this explicit recursive call.
6755 // If we ran into any entities that involve context-sensitive keywords,
6756 // take another pass through the tokens to mark them as such.
6757 if (W.hasContextSensitiveKeywords()) {
6758 for (unsigned I = 0; I != NumTokens; ++I) {
6759 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
6762 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
6763 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
6764 if (const ObjCPropertyDecl *Property
6765 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
6766 if (Property->getPropertyAttributesAsWritten() != 0 &&
6767 llvm::StringSwitch<bool>(II->getName())
6768 .Case("readonly", true)
6769 .Case("assign", true)
6770 .Case("unsafe_unretained", true)
6771 .Case("readwrite", true)
6772 .Case("retain", true)
6774 .Case("nonatomic", true)
6775 .Case("atomic", true)
6776 .Case("getter", true)
6777 .Case("setter", true)
6778 .Case("strong", true)
6781 Tokens[I].int_data[0] = CXToken_Keyword;
6786 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
6787 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
6788 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
6789 if (llvm::StringSwitch<bool>(II->getName())
6792 .Case("inout", true)
6793 .Case("oneway", true)
6794 .Case("bycopy", true)
6795 .Case("byref", true)
6797 Tokens[I].int_data[0] = CXToken_Keyword;
6801 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
6802 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
6803 Tokens[I].int_data[0] = CXToken_Keyword;
6812 void clang_annotateTokens(CXTranslationUnit TU,
6813 CXToken *Tokens, unsigned NumTokens,
6814 CXCursor *Cursors) {
6815 if (isNotUsableTU(TU)) {
6819 if (NumTokens == 0 || !Tokens || !Cursors) {
6820 LOG_FUNC_SECTION { *Log << "<null input>"; }
6826 CXSourceLocation bloc = clang_getTokenLocation(TU, Tokens[0]);
6827 CXSourceLocation eloc = clang_getTokenLocation(TU, Tokens[NumTokens-1]);
6828 *Log << clang_getRange(bloc, eloc);
6831 // Any token we don't specifically annotate will have a NULL cursor.
6832 CXCursor C = clang_getNullCursor();
6833 for (unsigned I = 0; I != NumTokens; ++I)
6836 ASTUnit *CXXUnit = cxtu::getASTUnit(TU);
6840 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
6842 auto AnnotateTokensImpl = [=]() {
6843 clang_annotateTokensImpl(TU, CXXUnit, Tokens, NumTokens, Cursors);
6845 llvm::CrashRecoveryContext CRC;
6846 if (!RunSafely(CRC, AnnotateTokensImpl, GetSafetyThreadStackSize() * 2)) {
6847 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
6851 } // end: extern "C"
6853 //===----------------------------------------------------------------------===//
6854 // Operations for querying linkage of a cursor.
6855 //===----------------------------------------------------------------------===//
6858 CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
6859 if (!clang_isDeclaration(cursor.kind))
6860 return CXLinkage_Invalid;
6862 const Decl *D = cxcursor::getCursorDecl(cursor);
6863 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
6864 switch (ND->getLinkageInternal()) {
6866 case VisibleNoLinkage: return CXLinkage_NoLinkage;
6867 case InternalLinkage: return CXLinkage_Internal;
6868 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
6869 case ExternalLinkage: return CXLinkage_External;
6872 return CXLinkage_Invalid;
6874 } // end: extern "C"
6876 //===----------------------------------------------------------------------===//
6877 // Operations for querying visibility of a cursor.
6878 //===----------------------------------------------------------------------===//
6881 CXVisibilityKind clang_getCursorVisibility(CXCursor cursor) {
6882 if (!clang_isDeclaration(cursor.kind))
6883 return CXVisibility_Invalid;
6885 const Decl *D = cxcursor::getCursorDecl(cursor);
6886 if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
6887 switch (ND->getVisibility()) {
6888 case HiddenVisibility: return CXVisibility_Hidden;
6889 case ProtectedVisibility: return CXVisibility_Protected;
6890 case DefaultVisibility: return CXVisibility_Default;
6893 return CXVisibility_Invalid;
6895 } // end: extern "C"
6897 //===----------------------------------------------------------------------===//
6898 // Operations for querying language of a cursor.
6899 //===----------------------------------------------------------------------===//
6901 static CXLanguageKind getDeclLanguage(const Decl *D) {
6903 return CXLanguage_C;
6905 switch (D->getKind()) {
6908 case Decl::ImplicitParam:
6909 case Decl::ObjCAtDefsField:
6910 case Decl::ObjCCategory:
6911 case Decl::ObjCCategoryImpl:
6912 case Decl::ObjCCompatibleAlias:
6913 case Decl::ObjCImplementation:
6914 case Decl::ObjCInterface:
6915 case Decl::ObjCIvar:
6916 case Decl::ObjCMethod:
6917 case Decl::ObjCProperty:
6918 case Decl::ObjCPropertyImpl:
6919 case Decl::ObjCProtocol:
6920 case Decl::ObjCTypeParam:
6921 return CXLanguage_ObjC;
6922 case Decl::CXXConstructor:
6923 case Decl::CXXConversion:
6924 case Decl::CXXDestructor:
6925 case Decl::CXXMethod:
6926 case Decl::CXXRecord:
6927 case Decl::ClassTemplate:
6928 case Decl::ClassTemplatePartialSpecialization:
6929 case Decl::ClassTemplateSpecialization:
6931 case Decl::FriendTemplate:
6932 case Decl::FunctionTemplate:
6933 case Decl::LinkageSpec:
6934 case Decl::Namespace:
6935 case Decl::NamespaceAlias:
6936 case Decl::NonTypeTemplateParm:
6937 case Decl::StaticAssert:
6938 case Decl::TemplateTemplateParm:
6939 case Decl::TemplateTypeParm:
6940 case Decl::UnresolvedUsingTypename:
6941 case Decl::UnresolvedUsingValue:
6943 case Decl::UsingDirective:
6944 case Decl::UsingShadow:
6945 return CXLanguage_CPlusPlus;
6948 return CXLanguage_C;
6953 static CXAvailabilityKind getCursorAvailabilityForDecl(const Decl *D) {
6954 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
6955 return CXAvailability_NotAvailable;
6957 switch (D->getAvailability()) {
6959 case AR_NotYetIntroduced:
6960 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
6961 return getCursorAvailabilityForDecl(
6962 cast<Decl>(EnumConst->getDeclContext()));
6963 return CXAvailability_Available;
6966 return CXAvailability_Deprecated;
6968 case AR_Unavailable:
6969 return CXAvailability_NotAvailable;
6972 llvm_unreachable("Unknown availability kind!");
6975 enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
6976 if (clang_isDeclaration(cursor.kind))
6977 if (const Decl *D = cxcursor::getCursorDecl(cursor))
6978 return getCursorAvailabilityForDecl(D);
6980 return CXAvailability_Available;
6983 static CXVersion convertVersion(VersionTuple In) {
6984 CXVersion Out = { -1, -1, -1 };
6988 Out.Major = In.getMajor();
6990 Optional<unsigned> Minor = In.getMinor();
6991 if (Minor.hasValue())
6996 Optional<unsigned> Subminor = In.getSubminor();
6997 if (Subminor.hasValue())
6998 Out.Subminor = *Subminor;
7003 static int getCursorPlatformAvailabilityForDecl(const Decl *D,
7004 int *always_deprecated,
7005 CXString *deprecated_message,
7006 int *always_unavailable,
7007 CXString *unavailable_message,
7008 CXPlatformAvailability *availability,
7009 int availability_size) {
7010 bool HadAvailAttr = false;
7012 for (auto A : D->attrs()) {
7013 if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
7014 HadAvailAttr = true;
7015 if (always_deprecated)
7016 *always_deprecated = 1;
7017 if (deprecated_message) {
7018 clang_disposeString(*deprecated_message);
7019 *deprecated_message = cxstring::createDup(Deprecated->getMessage());
7024 if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(A)) {
7025 HadAvailAttr = true;
7026 if (always_unavailable)
7027 *always_unavailable = 1;
7028 if (unavailable_message) {
7029 clang_disposeString(*unavailable_message);
7030 *unavailable_message = cxstring::createDup(Unavailable->getMessage());
7035 if (AvailabilityAttr *Avail = dyn_cast<AvailabilityAttr>(A)) {
7036 HadAvailAttr = true;
7037 if (N < availability_size) {
7038 availability[N].Platform
7039 = cxstring::createDup(Avail->getPlatform()->getName());
7040 availability[N].Introduced = convertVersion(Avail->getIntroduced());
7041 availability[N].Deprecated = convertVersion(Avail->getDeprecated());
7042 availability[N].Obsoleted = convertVersion(Avail->getObsoleted());
7043 availability[N].Unavailable = Avail->getUnavailable();
7044 availability[N].Message = cxstring::createDup(Avail->getMessage());
7051 if (const EnumConstantDecl *EnumConst = dyn_cast<EnumConstantDecl>(D))
7052 return getCursorPlatformAvailabilityForDecl(
7053 cast<Decl>(EnumConst->getDeclContext()),
7057 unavailable_message,
7064 int clang_getCursorPlatformAvailability(CXCursor cursor,
7065 int *always_deprecated,
7066 CXString *deprecated_message,
7067 int *always_unavailable,
7068 CXString *unavailable_message,
7069 CXPlatformAvailability *availability,
7070 int availability_size) {
7071 if (always_deprecated)
7072 *always_deprecated = 0;
7073 if (deprecated_message)
7074 *deprecated_message = cxstring::createEmpty();
7075 if (always_unavailable)
7076 *always_unavailable = 0;
7077 if (unavailable_message)
7078 *unavailable_message = cxstring::createEmpty();
7080 if (!clang_isDeclaration(cursor.kind))
7083 const Decl *D = cxcursor::getCursorDecl(cursor);
7087 return getCursorPlatformAvailabilityForDecl(D, always_deprecated,
7090 unavailable_message,
7095 void clang_disposeCXPlatformAvailability(CXPlatformAvailability *availability) {
7096 clang_disposeString(availability->Platform);
7097 clang_disposeString(availability->Message);
7100 CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
7101 if (clang_isDeclaration(cursor.kind))
7102 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
7104 return CXLanguage_Invalid;
7107 /// \brief If the given cursor is the "templated" declaration
7108 /// descibing a class or function template, return the class or
7109 /// function template.
7110 static const Decl *maybeGetTemplateCursor(const Decl *D) {
7114 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7115 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
7118 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
7119 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
7126 enum CX_StorageClass clang_Cursor_getStorageClass(CXCursor C) {
7127 StorageClass sc = SC_None;
7128 const Decl *D = getCursorDecl(C);
7130 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7131 sc = FD->getStorageClass();
7132 } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7133 sc = VD->getStorageClass();
7135 return CX_SC_Invalid;
7138 return CX_SC_Invalid;
7144 return CX_SC_Extern;
7146 return CX_SC_Static;
7147 case SC_PrivateExtern:
7148 return CX_SC_PrivateExtern;
7152 return CX_SC_Register;
7154 llvm_unreachable("Unhandled storage class!");
7157 CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
7158 if (clang_isDeclaration(cursor.kind)) {
7159 if (const Decl *D = getCursorDecl(cursor)) {
7160 const DeclContext *DC = D->getDeclContext();
7162 return clang_getNullCursor();
7164 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7165 getCursorTU(cursor));
7169 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
7170 if (const Decl *D = getCursorDecl(cursor))
7171 return MakeCXCursor(D, getCursorTU(cursor));
7174 return clang_getNullCursor();
7177 CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
7178 if (clang_isDeclaration(cursor.kind)) {
7179 if (const Decl *D = getCursorDecl(cursor)) {
7180 const DeclContext *DC = D->getLexicalDeclContext();
7182 return clang_getNullCursor();
7184 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
7185 getCursorTU(cursor));
7189 // FIXME: Note that we can't easily compute the lexical context of a
7190 // statement or expression, so we return nothing.
7191 return clang_getNullCursor();
7194 CXFile clang_getIncludedFile(CXCursor cursor) {
7195 if (cursor.kind != CXCursor_InclusionDirective)
7198 const InclusionDirective *ID = getCursorInclusionDirective(cursor);
7199 return const_cast<FileEntry *>(ID->getFile());
7202 unsigned clang_Cursor_getObjCPropertyAttributes(CXCursor C, unsigned reserved) {
7203 if (C.kind != CXCursor_ObjCPropertyDecl)
7204 return CXObjCPropertyAttr_noattr;
7206 unsigned Result = CXObjCPropertyAttr_noattr;
7207 const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(getCursorDecl(C));
7208 ObjCPropertyDecl::PropertyAttributeKind Attr =
7209 PD->getPropertyAttributesAsWritten();
7211 #define SET_CXOBJCPROP_ATTR(A) \
7212 if (Attr & ObjCPropertyDecl::OBJC_PR_##A) \
7213 Result |= CXObjCPropertyAttr_##A
7214 SET_CXOBJCPROP_ATTR(readonly);
7215 SET_CXOBJCPROP_ATTR(getter);
7216 SET_CXOBJCPROP_ATTR(assign);
7217 SET_CXOBJCPROP_ATTR(readwrite);
7218 SET_CXOBJCPROP_ATTR(retain);
7219 SET_CXOBJCPROP_ATTR(copy);
7220 SET_CXOBJCPROP_ATTR(nonatomic);
7221 SET_CXOBJCPROP_ATTR(setter);
7222 SET_CXOBJCPROP_ATTR(atomic);
7223 SET_CXOBJCPROP_ATTR(weak);
7224 SET_CXOBJCPROP_ATTR(strong);
7225 SET_CXOBJCPROP_ATTR(unsafe_unretained);
7226 #undef SET_CXOBJCPROP_ATTR
7231 unsigned clang_Cursor_getObjCDeclQualifiers(CXCursor C) {
7232 if (!clang_isDeclaration(C.kind))
7233 return CXObjCDeclQualifier_None;
7235 Decl::ObjCDeclQualifier QT = Decl::OBJC_TQ_None;
7236 const Decl *D = getCursorDecl(C);
7237 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7238 QT = MD->getObjCDeclQualifier();
7239 else if (const ParmVarDecl *PD = dyn_cast<ParmVarDecl>(D))
7240 QT = PD->getObjCDeclQualifier();
7241 if (QT == Decl::OBJC_TQ_None)
7242 return CXObjCDeclQualifier_None;
7244 unsigned Result = CXObjCDeclQualifier_None;
7245 if (QT & Decl::OBJC_TQ_In) Result |= CXObjCDeclQualifier_In;
7246 if (QT & Decl::OBJC_TQ_Inout) Result |= CXObjCDeclQualifier_Inout;
7247 if (QT & Decl::OBJC_TQ_Out) Result |= CXObjCDeclQualifier_Out;
7248 if (QT & Decl::OBJC_TQ_Bycopy) Result |= CXObjCDeclQualifier_Bycopy;
7249 if (QT & Decl::OBJC_TQ_Byref) Result |= CXObjCDeclQualifier_Byref;
7250 if (QT & Decl::OBJC_TQ_Oneway) Result |= CXObjCDeclQualifier_Oneway;
7255 unsigned clang_Cursor_isObjCOptional(CXCursor C) {
7256 if (!clang_isDeclaration(C.kind))
7259 const Decl *D = getCursorDecl(C);
7260 if (const ObjCPropertyDecl *PD = dyn_cast<ObjCPropertyDecl>(D))
7261 return PD->getPropertyImplementation() == ObjCPropertyDecl::Optional;
7262 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7263 return MD->getImplementationControl() == ObjCMethodDecl::Optional;
7268 unsigned clang_Cursor_isVariadic(CXCursor C) {
7269 if (!clang_isDeclaration(C.kind))
7272 const Decl *D = getCursorDecl(C);
7273 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
7274 return FD->isVariadic();
7275 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
7276 return MD->isVariadic();
7281 CXSourceRange clang_Cursor_getCommentRange(CXCursor C) {
7282 if (!clang_isDeclaration(C.kind))
7283 return clang_getNullRange();
7285 const Decl *D = getCursorDecl(C);
7286 ASTContext &Context = getCursorContext(C);
7287 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7289 return clang_getNullRange();
7291 return cxloc::translateSourceRange(Context, RC->getSourceRange());
7294 CXString clang_Cursor_getRawCommentText(CXCursor C) {
7295 if (!clang_isDeclaration(C.kind))
7296 return cxstring::createNull();
7298 const Decl *D = getCursorDecl(C);
7299 ASTContext &Context = getCursorContext(C);
7300 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7301 StringRef RawText = RC ? RC->getRawText(Context.getSourceManager()) :
7304 // Don't duplicate the string because RawText points directly into source
7306 return cxstring::createRef(RawText);
7309 CXString clang_Cursor_getBriefCommentText(CXCursor C) {
7310 if (!clang_isDeclaration(C.kind))
7311 return cxstring::createNull();
7313 const Decl *D = getCursorDecl(C);
7314 const ASTContext &Context = getCursorContext(C);
7315 const RawComment *RC = Context.getRawCommentForAnyRedecl(D);
7318 StringRef BriefText = RC->getBriefText(Context);
7320 // Don't duplicate the string because RawComment ensures that this memory
7321 // will not go away.
7322 return cxstring::createRef(BriefText);
7325 return cxstring::createNull();
7328 CXModule clang_Cursor_getModule(CXCursor C) {
7329 if (C.kind == CXCursor_ModuleImportDecl) {
7330 if (const ImportDecl *ImportD =
7331 dyn_cast_or_null<ImportDecl>(getCursorDecl(C)))
7332 return ImportD->getImportedModule();
7338 CXModule clang_getModuleForFile(CXTranslationUnit TU, CXFile File) {
7339 if (isNotUsableTU(TU)) {
7345 FileEntry *FE = static_cast<FileEntry *>(File);
7347 ASTUnit &Unit = *cxtu::getASTUnit(TU);
7348 HeaderSearch &HS = Unit.getPreprocessor().getHeaderSearchInfo();
7349 ModuleMap::KnownHeader Header = HS.findModuleForHeader(FE);
7351 return Header.getModule();
7354 CXFile clang_Module_getASTFile(CXModule CXMod) {
7357 Module *Mod = static_cast<Module*>(CXMod);
7358 return const_cast<FileEntry *>(Mod->getASTFile());
7361 CXModule clang_Module_getParent(CXModule CXMod) {
7364 Module *Mod = static_cast<Module*>(CXMod);
7368 CXString clang_Module_getName(CXModule CXMod) {
7370 return cxstring::createEmpty();
7371 Module *Mod = static_cast<Module*>(CXMod);
7372 return cxstring::createDup(Mod->Name);
7375 CXString clang_Module_getFullName(CXModule CXMod) {
7377 return cxstring::createEmpty();
7378 Module *Mod = static_cast<Module*>(CXMod);
7379 return cxstring::createDup(Mod->getFullModuleName());
7382 int clang_Module_isSystem(CXModule CXMod) {
7385 Module *Mod = static_cast<Module*>(CXMod);
7386 return Mod->IsSystem;
7389 unsigned clang_Module_getNumTopLevelHeaders(CXTranslationUnit TU,
7391 if (isNotUsableTU(TU)) {
7397 Module *Mod = static_cast<Module*>(CXMod);
7398 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
7399 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7400 return TopHeaders.size();
7403 CXFile clang_Module_getTopLevelHeader(CXTranslationUnit TU,
7404 CXModule CXMod, unsigned Index) {
7405 if (isNotUsableTU(TU)) {
7411 Module *Mod = static_cast<Module*>(CXMod);
7412 FileManager &FileMgr = cxtu::getASTUnit(TU)->getFileManager();
7414 ArrayRef<const FileEntry *> TopHeaders = Mod->getTopHeaders(FileMgr);
7415 if (Index < TopHeaders.size())
7416 return const_cast<FileEntry *>(TopHeaders[Index]);
7421 } // end: extern "C"
7423 //===----------------------------------------------------------------------===//
7424 // C++ AST instrospection.
7425 //===----------------------------------------------------------------------===//
7428 unsigned clang_CXXField_isMutable(CXCursor C) {
7429 if (!clang_isDeclaration(C.kind))
7432 if (const auto D = cxcursor::getCursorDecl(C))
7433 if (const auto FD = dyn_cast_or_null<FieldDecl>(D))
7434 return FD->isMutable() ? 1 : 0;
7438 unsigned clang_CXXMethod_isPureVirtual(CXCursor C) {
7439 if (!clang_isDeclaration(C.kind))
7442 const Decl *D = cxcursor::getCursorDecl(C);
7443 const CXXMethodDecl *Method =
7444 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7445 return (Method && Method->isVirtual() && Method->isPure()) ? 1 : 0;
7448 unsigned clang_CXXMethod_isConst(CXCursor C) {
7449 if (!clang_isDeclaration(C.kind))
7452 const Decl *D = cxcursor::getCursorDecl(C);
7453 const CXXMethodDecl *Method =
7454 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7455 return (Method && (Method->getTypeQualifiers() & Qualifiers::Const)) ? 1 : 0;
7458 unsigned clang_CXXMethod_isStatic(CXCursor C) {
7459 if (!clang_isDeclaration(C.kind))
7462 const Decl *D = cxcursor::getCursorDecl(C);
7463 const CXXMethodDecl *Method =
7464 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7465 return (Method && Method->isStatic()) ? 1 : 0;
7468 unsigned clang_CXXMethod_isVirtual(CXCursor C) {
7469 if (!clang_isDeclaration(C.kind))
7472 const Decl *D = cxcursor::getCursorDecl(C);
7473 const CXXMethodDecl *Method =
7474 D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
7475 return (Method && Method->isVirtual()) ? 1 : 0;
7477 } // end: extern "C"
7479 //===----------------------------------------------------------------------===//
7480 // Attribute introspection.
7481 //===----------------------------------------------------------------------===//
7484 CXType clang_getIBOutletCollectionType(CXCursor C) {
7485 if (C.kind != CXCursor_IBOutletCollectionAttr)
7486 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
7488 const IBOutletCollectionAttr *A =
7489 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
7491 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
7493 } // end: extern "C"
7495 //===----------------------------------------------------------------------===//
7496 // Inspecting memory usage.
7497 //===----------------------------------------------------------------------===//
7499 typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
7501 static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
7502 enum CXTUResourceUsageKind k,
7503 unsigned long amount) {
7504 CXTUResourceUsageEntry entry = { k, amount };
7505 entries.push_back(entry);
7510 const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
7511 const char *str = "";
7513 case CXTUResourceUsage_AST:
7514 str = "ASTContext: expressions, declarations, and types";
7516 case CXTUResourceUsage_Identifiers:
7517 str = "ASTContext: identifiers";
7519 case CXTUResourceUsage_Selectors:
7520 str = "ASTContext: selectors";
7522 case CXTUResourceUsage_GlobalCompletionResults:
7523 str = "Code completion: cached global results";
7525 case CXTUResourceUsage_SourceManagerContentCache:
7526 str = "SourceManager: content cache allocator";
7528 case CXTUResourceUsage_AST_SideTables:
7529 str = "ASTContext: side tables";
7531 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
7532 str = "SourceManager: malloc'ed memory buffers";
7534 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
7535 str = "SourceManager: mmap'ed memory buffers";
7537 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
7538 str = "ExternalASTSource: malloc'ed memory buffers";
7540 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
7541 str = "ExternalASTSource: mmap'ed memory buffers";
7543 case CXTUResourceUsage_Preprocessor:
7544 str = "Preprocessor: malloc'ed memory";
7546 case CXTUResourceUsage_PreprocessingRecord:
7547 str = "Preprocessor: PreprocessingRecord";
7549 case CXTUResourceUsage_SourceManager_DataStructures:
7550 str = "SourceManager: data structures and tables";
7552 case CXTUResourceUsage_Preprocessor_HeaderSearch:
7553 str = "Preprocessor: header search tables";
7559 CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
7560 if (isNotUsableTU(TU)) {
7562 CXTUResourceUsage usage = { (void*) nullptr, 0, nullptr };
7566 ASTUnit *astUnit = cxtu::getASTUnit(TU);
7567 std::unique_ptr<MemUsageEntries> entries(new MemUsageEntries());
7568 ASTContext &astContext = astUnit->getASTContext();
7570 // How much memory is used by AST nodes and types?
7571 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
7572 (unsigned long) astContext.getASTAllocatedMemory());
7574 // How much memory is used by identifiers?
7575 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
7576 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
7578 // How much memory is used for selectors?
7579 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
7580 (unsigned long) astContext.Selectors.getTotalMemory());
7582 // How much memory is used by ASTContext's side tables?
7583 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
7584 (unsigned long) astContext.getSideTableAllocatedMemory());
7586 // How much memory is used for caching global code completion results?
7587 unsigned long completionBytes = 0;
7588 if (GlobalCodeCompletionAllocator *completionAllocator =
7589 astUnit->getCachedCompletionAllocator().get()) {
7590 completionBytes = completionAllocator->getTotalMemory();
7592 createCXTUResourceUsageEntry(*entries,
7593 CXTUResourceUsage_GlobalCompletionResults,
7596 // How much memory is being used by SourceManager's content cache?
7597 createCXTUResourceUsageEntry(*entries,
7598 CXTUResourceUsage_SourceManagerContentCache,
7599 (unsigned long) astContext.getSourceManager().getContentCacheSize());
7601 // How much memory is being used by the MemoryBuffer's in SourceManager?
7602 const SourceManager::MemoryBufferSizes &srcBufs =
7603 astUnit->getSourceManager().getMemoryBufferSizes();
7605 createCXTUResourceUsageEntry(*entries,
7606 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
7607 (unsigned long) srcBufs.malloc_bytes);
7608 createCXTUResourceUsageEntry(*entries,
7609 CXTUResourceUsage_SourceManager_Membuffer_MMap,
7610 (unsigned long) srcBufs.mmap_bytes);
7611 createCXTUResourceUsageEntry(*entries,
7612 CXTUResourceUsage_SourceManager_DataStructures,
7613 (unsigned long) astContext.getSourceManager()
7614 .getDataStructureSizes());
7616 // How much memory is being used by the ExternalASTSource?
7617 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
7618 const ExternalASTSource::MemoryBufferSizes &sizes =
7619 esrc->getMemoryBufferSizes();
7621 createCXTUResourceUsageEntry(*entries,
7622 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
7623 (unsigned long) sizes.malloc_bytes);
7624 createCXTUResourceUsageEntry(*entries,
7625 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
7626 (unsigned long) sizes.mmap_bytes);
7629 // How much memory is being used by the Preprocessor?
7630 Preprocessor &pp = astUnit->getPreprocessor();
7631 createCXTUResourceUsageEntry(*entries,
7632 CXTUResourceUsage_Preprocessor,
7633 pp.getTotalMemory());
7635 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
7636 createCXTUResourceUsageEntry(*entries,
7637 CXTUResourceUsage_PreprocessingRecord,
7638 pRec->getTotalMemory());
7641 createCXTUResourceUsageEntry(*entries,
7642 CXTUResourceUsage_Preprocessor_HeaderSearch,
7643 pp.getHeaderSearchInfo().getTotalMemory());
7645 CXTUResourceUsage usage = { (void*) entries.get(),
7646 (unsigned) entries->size(),
7647 !entries->empty() ? &(*entries)[0] : nullptr };
7652 void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
7654 delete (MemUsageEntries*) usage.data;
7657 CXSourceRangeList *clang_getSkippedRanges(CXTranslationUnit TU, CXFile file) {
7658 CXSourceRangeList *skipped = new CXSourceRangeList;
7660 skipped->ranges = nullptr;
7662 if (isNotUsableTU(TU)) {
7670 ASTUnit *astUnit = cxtu::getASTUnit(TU);
7671 PreprocessingRecord *ppRec = astUnit->getPreprocessor().getPreprocessingRecord();
7675 ASTContext &Ctx = astUnit->getASTContext();
7676 SourceManager &sm = Ctx.getSourceManager();
7677 FileEntry *fileEntry = static_cast<FileEntry *>(file);
7678 FileID wantedFileID = sm.translateFile(fileEntry);
7680 const std::vector<SourceRange> &SkippedRanges = ppRec->getSkippedRanges();
7681 std::vector<SourceRange> wantedRanges;
7682 for (std::vector<SourceRange>::const_iterator i = SkippedRanges.begin(), ei = SkippedRanges.end();
7684 if (sm.getFileID(i->getBegin()) == wantedFileID || sm.getFileID(i->getEnd()) == wantedFileID)
7685 wantedRanges.push_back(*i);
7688 skipped->count = wantedRanges.size();
7689 skipped->ranges = new CXSourceRange[skipped->count];
7690 for (unsigned i = 0, ei = skipped->count; i != ei; ++i)
7691 skipped->ranges[i] = cxloc::translateSourceRange(Ctx, wantedRanges[i]);
7696 void clang_disposeSourceRangeList(CXSourceRangeList *ranges) {
7698 delete[] ranges->ranges;
7705 void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
7706 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
7707 for (unsigned I = 0; I != Usage.numEntries; ++I)
7708 fprintf(stderr, " %s: %lu\n",
7709 clang_getTUResourceUsageName(Usage.entries[I].kind),
7710 Usage.entries[I].amount);
7712 clang_disposeCXTUResourceUsage(Usage);
7715 //===----------------------------------------------------------------------===//
7716 // Misc. utility functions.
7717 //===----------------------------------------------------------------------===//
7719 /// Default to using an 8 MB stack size on "safety" threads.
7720 static unsigned SafetyStackThreadSize = 8 << 20;
7724 bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn,
7727 Size = GetSafetyThreadStackSize();
7729 return CRC.RunSafelyOnThread(Fn, Size);
7730 return CRC.RunSafely(Fn);
7733 unsigned GetSafetyThreadStackSize() {
7734 return SafetyStackThreadSize;
7737 void SetSafetyThreadStackSize(unsigned Value) {
7738 SafetyStackThreadSize = Value;
7743 void clang::setThreadBackgroundPriority() {
7744 if (getenv("LIBCLANG_BGPRIO_DISABLE"))
7747 #ifdef USE_DARWIN_THREADS
7748 setpriority(PRIO_DARWIN_THREAD, 0, PRIO_DARWIN_BG);
7752 void cxindex::printDiagsToStderr(ASTUnit *Unit) {
7756 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
7757 DEnd = Unit->stored_diag_end();
7759 CXStoredDiagnostic Diag(*D, Unit->getLangOpts());
7760 CXString Msg = clang_formatDiagnostic(&Diag,
7761 clang_defaultDiagnosticDisplayOptions());
7762 fprintf(stderr, "%s\n", clang_getCString(Msg));
7763 clang_disposeString(Msg);
7765 #ifdef LLVM_ON_WIN32
7766 // On Windows, force a flush, since there may be multiple copies of
7767 // stderr and stdout in the file system, all with different buffers
7768 // but writing to the same device.
7773 MacroInfo *cxindex::getMacroInfo(const IdentifierInfo &II,
7774 SourceLocation MacroDefLoc,
7775 CXTranslationUnit TU){
7776 if (MacroDefLoc.isInvalid() || !TU)
7778 if (!II.hadMacroDefinition())
7781 ASTUnit *Unit = cxtu::getASTUnit(TU);
7782 Preprocessor &PP = Unit->getPreprocessor();
7783 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(&II);
7785 for (MacroDirective::DefInfo
7786 Def = MD->getDefinition(); Def; Def = Def.getPreviousDefinition()) {
7787 if (MacroDefLoc == Def.getMacroInfo()->getDefinitionLoc())
7788 return Def.getMacroInfo();
7795 const MacroInfo *cxindex::getMacroInfo(const MacroDefinitionRecord *MacroDef,
7796 CXTranslationUnit TU) {
7797 if (!MacroDef || !TU)
7799 const IdentifierInfo *II = MacroDef->getName();
7803 return getMacroInfo(*II, MacroDef->getLocation(), TU);
7806 MacroDefinitionRecord *
7807 cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, const Token &Tok,
7808 CXTranslationUnit TU) {
7811 if (Tok.isNot(tok::raw_identifier))
7814 if (MI->getNumTokens() == 0)
7816 SourceRange DefRange(MI->getReplacementToken(0).getLocation(),
7817 MI->getDefinitionEndLoc());
7818 ASTUnit *Unit = cxtu::getASTUnit(TU);
7820 // Check that the token is inside the definition and not its argument list.
7821 SourceManager &SM = Unit->getSourceManager();
7822 if (SM.isBeforeInTranslationUnit(Tok.getLocation(), DefRange.getBegin()))
7824 if (SM.isBeforeInTranslationUnit(DefRange.getEnd(), Tok.getLocation()))
7827 Preprocessor &PP = Unit->getPreprocessor();
7828 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
7832 IdentifierInfo &II = PP.getIdentifierTable().get(Tok.getRawIdentifier());
7833 if (!II.hadMacroDefinition())
7836 // Check that the identifier is not one of the macro arguments.
7837 if (std::find(MI->arg_begin(), MI->arg_end(), &II) != MI->arg_end())
7840 MacroDirective *InnerMD = PP.getLocalMacroDirectiveHistory(&II);
7844 return PPRec->findMacroDefinition(InnerMD->getMacroInfo());
7847 MacroDefinitionRecord *
7848 cxindex::checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc,
7849 CXTranslationUnit TU) {
7850 if (Loc.isInvalid() || !MI || !TU)
7853 if (MI->getNumTokens() == 0)
7855 ASTUnit *Unit = cxtu::getASTUnit(TU);
7856 Preprocessor &PP = Unit->getPreprocessor();
7857 if (!PP.getPreprocessingRecord())
7859 Loc = Unit->getSourceManager().getSpellingLoc(Loc);
7861 if (PP.getRawToken(Loc, Tok))
7864 return checkForMacroInMacroDefinition(MI, Tok, TU);
7869 CXString clang_getClangVersion() {
7870 return cxstring::createDup(getClangFullVersion());
7873 } // end: extern "C"
7875 Logger &cxindex::Logger::operator<<(CXTranslationUnit TU) {
7877 if (ASTUnit *Unit = cxtu::getASTUnit(TU)) {
7878 LogOS << '<' << Unit->getMainFileName() << '>';
7879 if (Unit->isMainFileAST())
7880 LogOS << " (" << Unit->getASTFileName() << ')';
7884 LogOS << "<NULL TU>";
7889 Logger &cxindex::Logger::operator<<(const FileEntry *FE) {
7890 *this << FE->getName();
7894 Logger &cxindex::Logger::operator<<(CXCursor cursor) {
7895 CXString cursorName = clang_getCursorDisplayName(cursor);
7896 *this << cursorName << "@" << clang_getCursorLocation(cursor);
7897 clang_disposeString(cursorName);
7901 Logger &cxindex::Logger::operator<<(CXSourceLocation Loc) {
7903 unsigned Line, Column;
7904 clang_getFileLocation(Loc, &File, &Line, &Column, nullptr);
7905 CXString FileName = clang_getFileName(File);
7906 *this << llvm::format("(%s:%d:%d)", clang_getCString(FileName), Line, Column);
7907 clang_disposeString(FileName);
7911 Logger &cxindex::Logger::operator<<(CXSourceRange range) {
7912 CXSourceLocation BLoc = clang_getRangeStart(range);
7913 CXSourceLocation ELoc = clang_getRangeEnd(range);
7916 unsigned BLine, BColumn;
7917 clang_getFileLocation(BLoc, &BFile, &BLine, &BColumn, nullptr);
7920 unsigned ELine, EColumn;
7921 clang_getFileLocation(ELoc, &EFile, &ELine, &EColumn, nullptr);
7923 CXString BFileName = clang_getFileName(BFile);
7924 if (BFile == EFile) {
7925 *this << llvm::format("[%s %d:%d-%d:%d]", clang_getCString(BFileName),
7926 BLine, BColumn, ELine, EColumn);
7928 CXString EFileName = clang_getFileName(EFile);
7929 *this << llvm::format("[%s:%d:%d - ", clang_getCString(BFileName),
7931 << llvm::format("%s:%d:%d]", clang_getCString(EFileName),
7933 clang_disposeString(EFileName);
7935 clang_disposeString(BFileName);
7939 Logger &cxindex::Logger::operator<<(CXString Str) {
7940 *this << clang_getCString(Str);
7944 Logger &cxindex::Logger::operator<<(const llvm::format_object_base &Fmt) {
7949 static llvm::ManagedStatic<llvm::sys::Mutex> LoggingMutex;
7951 cxindex::Logger::~Logger() {
7952 llvm::sys::ScopedLock L(*LoggingMutex);
7954 static llvm::TimeRecord sBeginTR = llvm::TimeRecord::getCurrentTime();
7956 raw_ostream &OS = llvm::errs();
7957 OS << "[libclang:" << Name << ':';
7959 #ifdef USE_DARWIN_THREADS
7960 // TODO: Portability.
7961 mach_port_t tid = pthread_mach_thread_np(pthread_self());
7965 llvm::TimeRecord TR = llvm::TimeRecord::getCurrentTime();
7966 OS << llvm::format("%7.4f] ", TR.getWallTime() - sBeginTR.getWallTime());
7970 llvm::sys::PrintStackTrace(OS);
7971 OS << "--------------------------------------------------\n";