blob: a9fd9e57d1b7a3a17a43ef2514260584bfdc2d5f [file] [log] [blame]
Ted Kremenekd2fa5662009-08-26 22:36:44 +00001//===- CIndex.cpp - Clang-C Source Indexing Library -----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00007//
Ted Kremenekd2fa5662009-08-26 22:36:44 +00008//===----------------------------------------------------------------------===//
9//
Ted Kremenekab188932010-01-05 19:32:54 +000010// This file implements the main API hooks in the Clang-C Source Indexing
11// library.
Ted Kremenekd2fa5662009-08-26 22:36:44 +000012//
13//===----------------------------------------------------------------------===//
14
Ted Kremenekab188932010-01-05 19:32:54 +000015#include "CIndexer.h"
Ted Kremenek16c440a2010-01-15 20:35:54 +000016#include "CXCursor.h"
Ted Kremenek0a90d322010-11-17 23:24:11 +000017#include "CXTranslationUnit.h"
Ted Kremeneked122732010-11-16 01:56:27 +000018#include "CXString.h"
Ted Kremenek95f33552010-08-26 01:42:22 +000019#include "CXType.h"
Ted Kremeneka297de22010-01-25 22:34:44 +000020#include "CXSourceLocation.h"
Douglas Gregor5352ac02010-01-28 00:27:43 +000021#include "CIndexDiagnostic.h"
Ted Kremenekab188932010-01-05 19:32:54 +000022
Ted Kremenek04bb7162010-01-22 22:44:15 +000023#include "clang/Basic/Version.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000024
Steve Naroff50398192009-08-28 15:28:48 +000025#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000026#include "clang/AST/StmtVisitor.h"
Douglas Gregor7d0d40e2010-01-21 16:28:34 +000027#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000028#include "clang/Basic/Diagnostic.h"
29#include "clang/Frontend/ASTUnit.h"
30#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000031#include "clang/Frontend/FrontendDiagnostic.h"
Ted Kremenekd8210652010-01-06 23:43:31 +000032#include "clang/Lex/Lexer.h"
Douglas Gregordd3e5542011-05-04 00:14:37 +000033#include "clang/Lex/HeaderSearch.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000034#include "clang/Lex/PreprocessingRecord.h"
Douglas Gregor33e9abd2010-01-22 19:49:59 +000035#include "clang/Lex/Preprocessor.h"
Douglas Gregora67e03f2010-09-09 21:42:20 +000036#include "llvm/ADT/STLExtras.h"
Ted Kremenekd8c370c2010-11-02 23:10:24 +000037#include "llvm/ADT/Optional.h"
Douglas Gregorf5251602011-03-08 17:10:18 +000038#include "llvm/ADT/StringSwitch.h"
Ted Kremenekd8c370c2010-11-02 23:10:24 +000039#include "clang/Analysis/Support/SaveAndRestore.h"
Daniel Dunbarc7df4f32010-08-18 18:43:14 +000040#include "llvm/Support/CrashRecoveryContext.h"
Daniel Dunbar48615ff2010-10-08 19:30:33 +000041#include "llvm/Support/PrettyStackTrace.h"
Douglas Gregor02465752009-10-16 21:24:31 +000042#include "llvm/Support/MemoryBuffer.h"
Douglas Gregor358559d2010-10-02 22:49:11 +000043#include "llvm/Support/raw_ostream.h"
Douglas Gregor7a07fcb2010-08-09 21:00:09 +000044#include "llvm/Support/Timer.h"
Michael J. Spencer03013fa2010-11-29 18:12:39 +000045#include "llvm/Support/Mutex.h"
46#include "llvm/Support/Program.h"
47#include "llvm/Support/Signals.h"
48#include "llvm/Support/Threading.h"
Ted Kremenek37f1ea02010-11-15 23:11:54 +000049#include "llvm/Support/Compiler.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000050
Steve Naroff50398192009-08-28 15:28:48 +000051using namespace clang;
Ted Kremenek16c440a2010-01-15 20:35:54 +000052using namespace clang::cxcursor;
Ted Kremenekee4db4f2010-02-17 00:41:08 +000053using namespace clang::cxstring;
Argyrios Kyrtzidis9049cf62011-10-12 07:07:33 +000054using namespace clang::cxtu;
Steve Naroff50398192009-08-28 15:28:48 +000055
Argyrios Kyrtzidis9049cf62011-10-12 07:07:33 +000056CXTranslationUnit cxtu::MakeCXTranslationUnit(ASTUnit *TU) {
Ted Kremeneka60ed472010-11-16 08:15:36 +000057 if (!TU)
58 return 0;
59 CXTranslationUnit D = new CXTranslationUnitImpl();
60 D->TUData = TU;
61 D->StringPool = createCXStringPool();
62 return D;
63}
64
Argyrios Kyrtzidis4e7064f2011-10-17 19:48:19 +000065cxtu::CXTUOwner::~CXTUOwner() {
66 if (TU)
67 clang_disposeTranslationUnit(TU);
68}
69
Douglas Gregor33e9abd2010-01-22 19:49:59 +000070/// \brief The result of comparing two source ranges.
71enum RangeComparisonResult {
72 /// \brief Either the ranges overlap or one of the ranges is invalid.
73 RangeOverlap,
Ted Kremenekf0e23e82010-02-17 00:41:40 +000074
Douglas Gregor33e9abd2010-01-22 19:49:59 +000075 /// \brief The first range ends before the second range starts.
76 RangeBefore,
Ted Kremenekf0e23e82010-02-17 00:41:40 +000077
Douglas Gregor33e9abd2010-01-22 19:49:59 +000078 /// \brief The first range starts after the second range ends.
79 RangeAfter
80};
81
Ted Kremenekf0e23e82010-02-17 00:41:40 +000082/// \brief Compare two source ranges to determine their relative position in
Douglas Gregor33e9abd2010-01-22 19:49:59 +000083/// the translation unit.
Ted Kremenekf0e23e82010-02-17 00:41:40 +000084static RangeComparisonResult RangeCompare(SourceManager &SM,
85 SourceRange R1,
Douglas Gregor33e9abd2010-01-22 19:49:59 +000086 SourceRange R2) {
87 assert(R1.isValid() && "First range is invalid?");
88 assert(R2.isValid() && "Second range is invalid?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +000089 if (R1.getEnd() != R2.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +000090 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +000091 return RangeBefore;
Douglas Gregora8e5c5b2010-07-22 20:22:31 +000092 if (R2.getEnd() != R1.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +000093 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +000094 return RangeAfter;
95 return RangeOverlap;
96}
97
Ted Kremenekfbd84ca2010-05-05 00:55:23 +000098/// \brief Determine if a source location falls within, before, or after a
99/// a given source range.
100static RangeComparisonResult LocationCompare(SourceManager &SM,
101 SourceLocation L, SourceRange R) {
102 assert(R.isValid() && "First range is invalid?");
103 assert(L.isValid() && "Second range is invalid?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000104 if (L == R.getBegin() || L == R.getEnd())
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000105 return RangeOverlap;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000106 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
107 return RangeBefore;
108 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
109 return RangeAfter;
110 return RangeOverlap;
111}
112
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000113/// \brief Translate a Clang source range into a CIndex source range.
114///
115/// Clang internally represents ranges where the end location points to the
116/// start of the token at the end. However, for external clients it is more
117/// useful to have a CXSourceRange be a proper half-open interval. This routine
118/// does the appropriate translation.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000119CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000120 const LangOptions &LangOpts,
Chris Lattner0a76aae2010-06-18 22:45:06 +0000121 const CharSourceRange &R) {
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000122 // We want the last character in this location, so we will adjust the
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000123 // location accordingly.
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000124 SourceLocation EndLoc = R.getEnd();
Douglas Gregora9b06d42010-11-09 06:24:54 +0000125 if (EndLoc.isValid() && EndLoc.isMacroID())
Chandler Carruthedc3dcc2011-07-25 16:56:02 +0000126 EndLoc = SM.getExpansionRange(EndLoc).second;
Chris Lattner0a76aae2010-06-18 22:45:06 +0000127 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000128 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
Argyrios Kyrtzidisa64ccef2011-09-19 20:40:19 +0000129 EndLoc = EndLoc.getLocWithOffset(Length);
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000130 }
131
132 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
133 R.getBegin().getRawEncoding(),
134 EndLoc.getRawEncoding() };
135 return Result;
136}
Douglas Gregor1db19de2010-01-19 21:36:55 +0000137
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000138//===----------------------------------------------------------------------===//
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000139// Cursor visitor.
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000140//===----------------------------------------------------------------------===//
141
Steve Naroff89922f82009-08-31 00:59:03 +0000142namespace {
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000143
144class VisitorJob {
145public:
Ted Kremenekcdb4caf2010-11-12 21:34:12 +0000146 enum Kind { DeclVisitKind, StmtVisitKind, MemberExprPartsKind,
Ted Kremeneke4979cc2010-11-13 00:58:18 +0000147 TypeLocVisitKind, OverloadExprPartsKind,
Ted Kremenek60608ec2010-11-17 00:50:47 +0000148 DeclRefExprPartsKind, LabelRefVisitKind,
Ted Kremenekf64d8032010-11-18 00:02:32 +0000149 ExplicitTemplateArgsVisitKind,
Douglas Gregorf3db29f2011-02-25 18:19:59 +0000150 NestedNameSpecifierLocVisitKind,
Ted Kremenekcdba6592010-11-18 00:42:18 +0000151 DeclarationNameInfoVisitKind,
Douglas Gregor94d96292011-01-19 20:34:17 +0000152 MemberRefVisitKind, SizeOfPackExprPartsKind };
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000153protected:
Ted Kremenekf64d8032010-11-18 00:02:32 +0000154 void *data[3];
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000155 CXCursor parent;
156 Kind K;
Ted Kremenekf64d8032010-11-18 00:02:32 +0000157 VisitorJob(CXCursor C, Kind k, void *d1, void *d2 = 0, void *d3 = 0)
158 : parent(C), K(k) {
159 data[0] = d1;
160 data[1] = d2;
161 data[2] = d3;
162 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000163public:
164 Kind getKind() const { return K; }
165 const CXCursor &getParent() const { return parent; }
166 static bool classof(VisitorJob *VJ) { return true; }
167};
168
Chris Lattner5f9e2722011-07-23 10:55:15 +0000169typedef SmallVector<VisitorJob, 10> VisitorWorkList;
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000170
Douglas Gregorb1373d02010-01-20 20:59:29 +0000171// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000172class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
Ted Kremenekcdba6592010-11-18 00:42:18 +0000173 public TypeLocVisitor<CursorVisitor, bool>
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000174{
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000175 /// \brief The translation unit we are traversing.
Ted Kremeneka60ed472010-11-16 08:15:36 +0000176 CXTranslationUnit TU;
177 ASTUnit *AU;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000178
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000179 /// \brief The parent cursor whose children we are traversing.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000180 CXCursor Parent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000181
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000182 /// \brief The declaration that serves at the parent of any statement or
183 /// expression nodes.
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000184 Decl *StmtParent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000185
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000186 /// \brief The visitor function.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000187 CXCursorVisitor Visitor;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000188
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000189 /// \brief The opaque client data, to be passed along to the visitor.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000190 CXClientData ClientData;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000191
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000192 /// \brief Whether we should visit the preprocessing record entries last,
193 /// after visiting other declarations.
194 bool VisitPreprocessorLast;
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000195
196 /// \brief Whether we should visit the preprocessing record entries that are
197 /// #included inside the \arg RegionOfInterest.
198 bool VisitIncludedPreprocessingEntries;
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000199
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000200 /// \brief When valid, a source range to which the cursor should restrict
201 /// its search.
202 SourceRange RegionOfInterest;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000203
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000204 // FIXME: Eventually remove. This part of a hack to support proper
205 // iteration over all Decls contained lexically within an ObjC container.
206 DeclContext::decl_iterator *DI_current;
207 DeclContext::decl_iterator DE_current;
208
Ted Kremenekd1ded662010-11-15 23:31:32 +0000209 // Cache of pre-allocated worklists for data-recursion walk of Stmts.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000210 SmallVector<VisitorWorkList*, 5> WorkListFreeList;
211 SmallVector<VisitorWorkList*, 5> WorkListCache;
Ted Kremenekd1ded662010-11-15 23:31:32 +0000212
Douglas Gregorb1373d02010-01-20 20:59:29 +0000213 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000214 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000215
216 /// \brief Determine whether this particular source range comes before, comes
217 /// after, or overlaps the region of interest.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000218 ///
Daniel Dunbard52864b2010-02-14 10:02:57 +0000219 /// \param R a half-open source range retrieved from the abstract syntax tree.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000220 RangeComparisonResult CompareRegionOfInterest(SourceRange R);
221
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000222 class SetParentRAII {
223 CXCursor &Parent;
224 Decl *&StmtParent;
225 CXCursor OldParent;
226
227 public:
228 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
229 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
230 {
231 Parent = NewParent;
232 if (clang_isDeclaration(Parent.kind))
233 StmtParent = getCursorDecl(Parent);
234 }
235
236 ~SetParentRAII() {
237 Parent = OldParent;
238 if (clang_isDeclaration(Parent.kind))
239 StmtParent = getCursorDecl(Parent);
240 }
241 };
242
Steve Naroff89922f82009-08-31 00:59:03 +0000243public:
Ted Kremeneka60ed472010-11-16 08:15:36 +0000244 CursorVisitor(CXTranslationUnit TU, CXCursorVisitor Visitor,
245 CXClientData ClientData,
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000246 bool VisitPreprocessorLast,
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000247 bool VisitIncludedPreprocessingEntries = false,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000248 SourceRange RegionOfInterest = SourceRange())
Ted Kremeneka60ed472010-11-16 08:15:36 +0000249 : TU(TU), AU(static_cast<ASTUnit*>(TU->TUData)),
250 Visitor(Visitor), ClientData(ClientData),
Douglas Gregor08e0bc12011-09-10 00:09:20 +0000251 VisitPreprocessorLast(VisitPreprocessorLast),
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000252 VisitIncludedPreprocessingEntries(VisitIncludedPreprocessingEntries),
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000253 RegionOfInterest(RegionOfInterest), DI_current(0)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000254 {
255 Parent.kind = CXCursor_NoDeclFound;
256 Parent.data[0] = 0;
257 Parent.data[1] = 0;
258 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000259 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000260 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000261
Ted Kremenekd1ded662010-11-15 23:31:32 +0000262 ~CursorVisitor() {
263 // Free the pre-allocated worklists for data-recursion.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000264 for (SmallVectorImpl<VisitorWorkList*>::iterator
Ted Kremenekd1ded662010-11-15 23:31:32 +0000265 I = WorkListCache.begin(), E = WorkListCache.end(); I != E; ++I) {
266 delete *I;
267 }
268 }
269
Ted Kremeneka60ed472010-11-16 08:15:36 +0000270 ASTUnit *getASTUnit() const { return static_cast<ASTUnit*>(TU->TUData); }
271 CXTranslationUnit getTU() const { return TU; }
Ted Kremenekab979612010-11-11 08:05:23 +0000272
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000273 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000274
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000275 bool visitPreprocessedEntitiesInRegion();
276
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000277 bool shouldVisitIncludedPreprocessingEntries() const {
278 return VisitIncludedPreprocessingEntries;
279 }
280
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000281 template<typename InputIterator>
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000282 bool visitPreprocessedEntities(InputIterator First, InputIterator Last,
283 PreprocessingRecord &PPRec,
284 FileID FID = FileID());
Douglas Gregor788f5a12010-03-20 00:41:21 +0000285
Douglas Gregorb1373d02010-01-20 20:59:29 +0000286 bool VisitChildren(CXCursor Parent);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000287
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000288 // Declaration visitors
Richard Smith162e1c12011-04-15 14:24:37 +0000289 bool VisitTypeAliasDecl(TypeAliasDecl *D);
Ted Kremenek09dfa372010-02-18 05:46:33 +0000290 bool VisitAttributes(Decl *D);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000291 bool VisitBlockDecl(BlockDecl *B);
Ted Kremenek3064ef92010-08-27 21:34:58 +0000292 bool VisitCXXRecordDecl(CXXRecordDecl *D);
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000293 llvm::Optional<bool> shouldVisitCursor(CXCursor C);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000294 bool VisitDeclContext(DeclContext *DC);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000295 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
296 bool VisitTypedefDecl(TypedefDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000297 bool VisitTagDecl(TagDecl *D);
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000298 bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D);
Douglas Gregor74dbe642010-08-31 19:31:58 +0000299 bool VisitClassTemplatePartialSpecializationDecl(
300 ClassTemplatePartialSpecializationDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000301 bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000302 bool VisitEnumConstantDecl(EnumConstantDecl *D);
303 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
304 bool VisitFunctionDecl(FunctionDecl *ND);
305 bool VisitFieldDecl(FieldDecl *D);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000306 bool VisitVarDecl(VarDecl *);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000307 bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000308 bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
Douglas Gregor39d6f072010-08-31 19:02:00 +0000309 bool VisitClassTemplateDecl(ClassTemplateDecl *D);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000310 bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000311 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
312 bool VisitObjCContainerDecl(ObjCContainerDecl *D);
313 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
314 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
Ted Kremenek23173d72010-05-18 21:09:07 +0000315 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
Ted Kremenek79758f62010-02-18 22:36:18 +0000316 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
317 bool VisitObjCImplDecl(ObjCImplDecl *D);
318 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
319 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000320 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
321 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
322 bool VisitObjCClassDecl(ObjCClassDecl *D);
Douglas Gregora4ffd852010-11-17 01:03:52 +0000323 bool VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD);
Ted Kremeneka0536d82010-05-07 01:04:29 +0000324 bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000325 bool VisitNamespaceDecl(NamespaceDecl *D);
Douglas Gregor69319002010-08-31 23:48:11 +0000326 bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000327 bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
Douglas Gregor7e242562010-09-01 19:52:22 +0000328 bool VisitUsingDecl(UsingDecl *D);
329 bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
330 bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000331
Douglas Gregor01829d32010-08-31 14:41:23 +0000332 // Name visitor
333 bool VisitDeclarationNameInfo(DeclarationNameInfo Name);
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000334 bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range);
Douglas Gregordc355712011-02-25 00:36:19 +0000335 bool VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS);
Douglas Gregor01829d32010-08-31 14:41:23 +0000336
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000337 // Template visitors
338 bool VisitTemplateParameters(const TemplateParameterList *Params);
Douglas Gregor0b36e612010-08-31 20:37:03 +0000339 bool VisitTemplateName(TemplateName Name, SourceLocation Loc);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000340 bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL);
341
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000342 // Type visitors
Argyrios Kyrtzidis427964e2011-08-15 22:40:24 +0000343#define ABSTRACT_TYPELOC(CLASS, PARENT)
344#define TYPELOC(CLASS, PARENT) \
345 bool Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
346#include "clang/AST/TypeLocNodes.def"
347
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000348 bool VisitTagTypeLoc(TagTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000349 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Argyrios Kyrtzidis427964e2011-08-15 22:40:24 +0000350 bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false);
351
Ted Kremenekc0e1d922010-11-11 08:05:18 +0000352 // Data-recursive visitor functions.
353 bool IsInRegionOfInterest(CXCursor C);
354 bool RunVisitorWorkList(VisitorWorkList &WL);
355 void EnqueueWorkList(VisitorWorkList &WL, Stmt *S);
Ted Kremenekcdba6592010-11-18 00:42:18 +0000356 LLVM_ATTRIBUTE_NOINLINE bool Visit(Stmt *S);
Steve Naroff89922f82009-08-31 00:59:03 +0000357};
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000358
Ted Kremenekab188932010-01-05 19:32:54 +0000359} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000360
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000361static SourceRange getRawCursorExtent(CXCursor C);
Douglas Gregor66537982010-11-17 17:14:07 +0000362static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr);
363
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000364
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000365RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000366 return RangeCompare(AU->getSourceManager(), R, RegionOfInterest);
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000367}
368
Douglas Gregorb1373d02010-01-20 20:59:29 +0000369/// \brief Visit the given cursor and, if requested by the visitor,
370/// its children.
371///
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000372/// \param Cursor the cursor to visit.
373///
374/// \param CheckRegionOfInterest if true, then the caller already checked that
375/// this cursor is within the region of interest.
376///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000377/// \returns true if the visitation should be aborted, false if it
378/// should continue.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000379bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000380 if (clang_isInvalid(Cursor.kind))
381 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000382
Douglas Gregorb1373d02010-01-20 20:59:29 +0000383 if (clang_isDeclaration(Cursor.kind)) {
384 Decl *D = getCursorDecl(Cursor);
385 assert(D && "Invalid declaration cursor");
Argyrios Kyrtzidis65ab9072011-09-26 19:05:37 +0000386 // Ignore implicit declarations, unless it's an objc method because
387 // currently we should report implicit methods for properties when indexing.
388 if (D->isImplicit() && !isa<ObjCMethodDecl>(D))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000389 return false;
390 }
391
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000392 // If we have a range of interest, and this cursor doesn't intersect with it,
393 // we're done.
394 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000395 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbarf408f322010-02-14 08:32:05 +0000396 if (Range.isInvalid() || CompareRegionOfInterest(Range))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000397 return false;
398 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000399
Douglas Gregorb1373d02010-01-20 20:59:29 +0000400 switch (Visitor(Cursor, Parent, ClientData)) {
401 case CXChildVisit_Break:
402 return true;
403
404 case CXChildVisit_Continue:
405 return false;
406
407 case CXChildVisit_Recurse:
408 return VisitChildren(Cursor);
409 }
410
Douglas Gregorfd643772010-01-25 16:45:46 +0000411 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000412}
413
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000414static bool visitPreprocessedEntitiesInRange(SourceRange R,
415 PreprocessingRecord &PPRec,
416 CursorVisitor &Visitor) {
417 SourceManager &SM = Visitor.getASTUnit()->getSourceManager();
418 FileID FID;
419
420 if (!Visitor.shouldVisitIncludedPreprocessingEntries()) {
421 // If the begin/end of the range lie in the same FileID, do the optimization
422 // where we skip preprocessed entities that do not come from the same FileID.
423 FID = SM.getFileID(R.getBegin());
424 if (FID != SM.getFileID(R.getEnd()))
425 FID = FileID();
426 }
427
428 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
429 Entities = PPRec.getPreprocessedEntitiesInRange(R);
430 return Visitor.visitPreprocessedEntities(Entities.first, Entities.second,
431 PPRec, FID);
432}
433
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000434bool CursorVisitor::visitPreprocessedEntitiesInRegion() {
Douglas Gregor788f5a12010-03-20 00:41:21 +0000435 PreprocessingRecord &PPRec
Ted Kremeneka60ed472010-11-16 08:15:36 +0000436 = *AU->getPreprocessor().getPreprocessingRecord();
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000437 SourceManager &SM = AU->getSourceManager();
Douglas Gregor788f5a12010-03-20 00:41:21 +0000438
Argyrios Kyrtzidis92ddef12011-09-19 20:40:48 +0000439 if (RegionOfInterest.isValid()) {
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +0000440 SourceRange MappedRange = AU->mapRangeToPreamble(RegionOfInterest);
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000441 SourceLocation B = MappedRange.getBegin();
442 SourceLocation E = MappedRange.getEnd();
443
444 if (AU->isInPreambleFileID(B)) {
445 if (SM.isLoadedSourceLocation(E))
446 return visitPreprocessedEntitiesInRange(SourceRange(B, E),
447 PPRec, *this);
448
449 // Beginning of range lies in the preamble but it also extends beyond
450 // it into the main file. Split the range into 2 parts, one covering
451 // the preamble and another covering the main file. This allows subsequent
452 // calls to visitPreprocessedEntitiesInRange to accept a source range that
453 // lies in the same FileID, allowing it to skip preprocessed entities that
454 // do not come from the same FileID.
455 bool breaked =
456 visitPreprocessedEntitiesInRange(
457 SourceRange(B, AU->getEndOfPreambleFileID()),
458 PPRec, *this);
459 if (breaked) return true;
460 return visitPreprocessedEntitiesInRange(
461 SourceRange(AU->getStartOfMainFileID(), E),
462 PPRec, *this);
463 }
464
465 return visitPreprocessedEntitiesInRange(SourceRange(B, E), PPRec, *this);
Argyrios Kyrtzidis92ddef12011-09-19 20:40:48 +0000466 }
467
Douglas Gregor788f5a12010-03-20 00:41:21 +0000468 bool OnlyLocalDecls
Douglas Gregor32038bb2010-12-21 19:07:48 +0000469 = !AU->isMainFileAST() && AU->getOnlyLocalDecls();
470
Argyrios Kyrtzidis92ddef12011-09-19 20:40:48 +0000471 if (OnlyLocalDecls)
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000472 return visitPreprocessedEntities(PPRec.local_begin(), PPRec.local_end(),
473 PPRec);
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000474
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000475 return visitPreprocessedEntities(PPRec.begin(), PPRec.end(), PPRec);
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000476}
477
478template<typename InputIterator>
479bool CursorVisitor::visitPreprocessedEntities(InputIterator First,
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000480 InputIterator Last,
481 PreprocessingRecord &PPRec,
482 FileID FID) {
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000483 for (; First != Last; ++First) {
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000484 if (!FID.isInvalid() && !PPRec.isEntityInFileID(First, FID))
485 continue;
486
487 PreprocessedEntity *PPE = *First;
488 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(PPE)) {
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000489 if (Visit(MakeMacroExpansionCursor(ME, TU)))
490 return true;
491
492 continue;
493 }
494
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000495 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(PPE)) {
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000496 if (Visit(MakeMacroDefinitionCursor(MD, TU)))
497 return true;
498
499 continue;
500 }
501
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +0000502 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(PPE)) {
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000503 if (Visit(MakeInclusionDirectiveCursor(ID, TU)))
504 return true;
505
506 continue;
Douglas Gregor788f5a12010-03-20 00:41:21 +0000507 }
508 }
509
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000510 return false;
Douglas Gregor788f5a12010-03-20 00:41:21 +0000511}
512
Douglas Gregorb1373d02010-01-20 20:59:29 +0000513/// \brief Visit the children of the given cursor.
Ted Kremeneka60ed472010-11-16 08:15:36 +0000514///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000515/// \returns true if the visitation should be aborted, false if it
516/// should continue.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000517bool CursorVisitor::VisitChildren(CXCursor Cursor) {
Douglas Gregorc314aa42011-03-02 19:17:03 +0000518 if (clang_isReference(Cursor.kind) &&
519 Cursor.kind != CXCursor_CXXBaseSpecifier) {
Douglas Gregora59e3902010-01-21 23:27:09 +0000520 // By definition, references have no children.
521 return false;
522 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000523
524 // Set the Parent field to Cursor, then back to its old value once we're
Douglas Gregorb1373d02010-01-20 20:59:29 +0000525 // done.
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000526 SetParentRAII SetParent(Parent, StmtParent, Cursor);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000527
Douglas Gregorb1373d02010-01-20 20:59:29 +0000528 if (clang_isDeclaration(Cursor.kind)) {
529 Decl *D = getCursorDecl(Cursor);
Douglas Gregor06d9b1a2011-04-14 21:41:34 +0000530 if (!D)
531 return false;
532
Ted Kremenek539311e2010-02-18 18:47:01 +0000533 return VisitAttributes(D) || Visit(D);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000534 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000535
Douglas Gregor06d9b1a2011-04-14 21:41:34 +0000536 if (clang_isStatement(Cursor.kind)) {
537 if (Stmt *S = getCursorStmt(Cursor))
538 return Visit(S);
539
540 return false;
541 }
542
543 if (clang_isExpression(Cursor.kind)) {
544 if (Expr *E = getCursorExpr(Cursor))
545 return Visit(E);
546
547 return false;
548 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000549
Douglas Gregorb1373d02010-01-20 20:59:29 +0000550 if (clang_isTranslationUnit(Cursor.kind)) {
Ted Kremeneka60ed472010-11-16 08:15:36 +0000551 CXTranslationUnit tu = getCursorTU(Cursor);
552 ASTUnit *CXXUnit = static_cast<ASTUnit*>(tu->TUData);
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000553
554 int VisitOrder[2] = { VisitPreprocessorLast, !VisitPreprocessorLast };
555 for (unsigned I = 0; I != 2; ++I) {
556 if (VisitOrder[I]) {
557 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
558 RegionOfInterest.isInvalid()) {
559 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
560 TLEnd = CXXUnit->top_level_end();
561 TL != TLEnd; ++TL) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000562 if (Visit(MakeCXCursor(*TL, tu, RegionOfInterest), true))
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000563 return true;
564 }
565 } else if (VisitDeclContext(
566 CXXUnit->getASTContext().getTranslationUnitDecl()))
Douglas Gregor7b691f332010-01-20 21:13:59 +0000567 return true;
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000568 continue;
Douglas Gregor7b691f332010-01-20 21:13:59 +0000569 }
Bob Wilson3178cb62010-03-19 03:57:57 +0000570
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000571 // Walk the preprocessing record.
Douglas Gregor4c30bb12011-07-21 00:47:40 +0000572 if (CXXUnit->getPreprocessor().getPreprocessingRecord())
573 visitPreprocessedEntitiesInRegion();
Douglas Gregor0396f462010-03-19 05:22:59 +0000574 }
Douglas Gregor04a9eb32011-03-16 23:23:30 +0000575
Douglas Gregor7b691f332010-01-20 21:13:59 +0000576 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000577 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000578
Douglas Gregorc314aa42011-03-02 19:17:03 +0000579 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
580 if (CXXBaseSpecifier *Base = getCursorCXXBaseSpecifier(Cursor)) {
581 if (TypeSourceInfo *BaseTSInfo = Base->getTypeSourceInfo()) {
582 return Visit(BaseTSInfo->getTypeLoc());
583 }
584 }
585 }
Argyrios Kyrtzidis221d5a52011-09-13 18:49:56 +0000586
587 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
588 IBOutletCollectionAttr *A =
589 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(Cursor));
590 if (const ObjCInterfaceType *InterT = A->getInterface()->getAs<ObjCInterfaceType>())
591 return Visit(cxcursor::MakeCursorObjCClassRef(InterT->getInterface(),
592 A->getInterfaceLoc(), TU));
593 }
594
Douglas Gregorb1373d02010-01-20 20:59:29 +0000595 // Nothing to visit at the moment.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000596 return false;
597}
598
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000599bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
Douglas Gregor13c8ccb2011-04-22 23:49:24 +0000600 if (TypeSourceInfo *TSInfo = B->getSignatureAsWritten())
601 if (Visit(TSInfo->getTypeLoc()))
602 return true;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000603
Ted Kremenek664cffd2010-07-22 11:30:19 +0000604 if (Stmt *Body = B->getBody())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000605 return Visit(MakeCXCursor(Body, StmtParent, TU, RegionOfInterest));
Ted Kremenek664cffd2010-07-22 11:30:19 +0000606
607 return false;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000608}
609
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000610llvm::Optional<bool> CursorVisitor::shouldVisitCursor(CXCursor Cursor) {
611 if (RegionOfInterest.isValid()) {
Douglas Gregor66537982010-11-17 17:14:07 +0000612 SourceRange Range = getFullCursorExtent(Cursor, AU->getSourceManager());
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000613 if (Range.isInvalid())
614 return llvm::Optional<bool>();
Douglas Gregor66537982010-11-17 17:14:07 +0000615
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000616 switch (CompareRegionOfInterest(Range)) {
617 case RangeBefore:
618 // This declaration comes before the region of interest; skip it.
619 return llvm::Optional<bool>();
620
621 case RangeAfter:
622 // This declaration comes after the region of interest; we're done.
623 return false;
624
625 case RangeOverlap:
626 // This declaration overlaps the region of interest; visit it.
627 break;
628 }
629 }
630 return true;
631}
632
633bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
634 DeclContext::decl_iterator I = DC->decls_begin(), E = DC->decls_end();
635
636 // FIXME: Eventually remove. This part of a hack to support proper
637 // iteration over all Decls contained lexically within an ObjC container.
638 SaveAndRestore<DeclContext::decl_iterator*> DI_saved(DI_current, &I);
639 SaveAndRestore<DeclContext::decl_iterator> DE_saved(DE_current, E);
640
641 for ( ; I != E; ++I) {
Ted Kremenek23173d72010-05-18 21:09:07 +0000642 Decl *D = *I;
643 if (D->getLexicalDeclContext() != DC)
644 continue;
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000645 CXCursor Cursor = MakeCXCursor(D, TU, RegionOfInterest);
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000646 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
647 if (!V.hasValue())
648 continue;
649 if (!V.getValue())
650 return false;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000651 if (Visit(Cursor, true))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000652 return true;
653 }
Douglas Gregorb1373d02010-01-20 20:59:29 +0000654 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000655}
656
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000657bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
658 llvm_unreachable("Translation units are visited directly by Visit()");
659 return false;
660}
661
Richard Smith162e1c12011-04-15 14:24:37 +0000662bool CursorVisitor::VisitTypeAliasDecl(TypeAliasDecl *D) {
663 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
664 return Visit(TSInfo->getTypeLoc());
665
666 return false;
667}
668
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000669bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
670 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
671 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000672
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000673 return false;
674}
675
676bool CursorVisitor::VisitTagDecl(TagDecl *D) {
677 return VisitDeclContext(D);
678}
679
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000680bool CursorVisitor::VisitClassTemplateSpecializationDecl(
681 ClassTemplateSpecializationDecl *D) {
682 bool ShouldVisitBody = false;
683 switch (D->getSpecializationKind()) {
684 case TSK_Undeclared:
685 case TSK_ImplicitInstantiation:
686 // Nothing to visit
687 return false;
688
689 case TSK_ExplicitInstantiationDeclaration:
690 case TSK_ExplicitInstantiationDefinition:
691 break;
692
693 case TSK_ExplicitSpecialization:
694 ShouldVisitBody = true;
695 break;
696 }
697
698 // Visit the template arguments used in the specialization.
699 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
700 TypeLoc TL = SpecType->getTypeLoc();
701 if (TemplateSpecializationTypeLoc *TSTLoc
702 = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) {
703 for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I)
704 if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I)))
705 return true;
706 }
707 }
708
709 if (ShouldVisitBody && VisitCXXRecordDecl(D))
710 return true;
711
712 return false;
713}
714
Douglas Gregor74dbe642010-08-31 19:31:58 +0000715bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
716 ClassTemplatePartialSpecializationDecl *D) {
717 // FIXME: Visit the "outer" template parameter lists on the TagDecl
718 // before visiting these template parameters.
719 if (VisitTemplateParameters(D->getTemplateParameters()))
720 return true;
721
722 // Visit the partial specialization arguments.
723 const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten();
724 for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I)
725 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
726 return true;
727
728 return VisitCXXRecordDecl(D);
729}
730
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000731bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
Douglas Gregor84b51d72010-09-01 20:16:53 +0000732 // Visit the default argument.
733 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
734 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
735 if (Visit(DefArg->getTypeLoc()))
736 return true;
737
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000738 return false;
739}
740
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000741bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
742 if (Expr *Init = D->getInitExpr())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000743 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000744 return false;
745}
746
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000747bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
748 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
749 if (Visit(TSInfo->getTypeLoc()))
750 return true;
751
Douglas Gregorc22b5ff2011-02-25 02:25:35 +0000752 // Visit the nested-name-specifier, if present.
753 if (NestedNameSpecifierLoc QualifierLoc = DD->getQualifierLoc())
754 if (VisitNestedNameSpecifierLoc(QualifierLoc))
755 return true;
756
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000757 return false;
758}
759
Douglas Gregora67e03f2010-09-09 21:42:20 +0000760/// \brief Compare two base or member initializers based on their source order.
Sean Huntcbb67482011-01-08 20:30:50 +0000761static int CompareCXXCtorInitializers(const void* Xp, const void *Yp) {
762 CXXCtorInitializer const * const *X
763 = static_cast<CXXCtorInitializer const * const *>(Xp);
764 CXXCtorInitializer const * const *Y
765 = static_cast<CXXCtorInitializer const * const *>(Yp);
Douglas Gregora67e03f2010-09-09 21:42:20 +0000766
767 if ((*X)->getSourceOrder() < (*Y)->getSourceOrder())
768 return -1;
769 else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder())
770 return 1;
771 else
772 return 0;
773}
774
Douglas Gregorb1373d02010-01-20 20:59:29 +0000775bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregor01829d32010-08-31 14:41:23 +0000776 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
777 // Visit the function declaration's syntactic components in the order
778 // written. This requires a bit of work.
Abramo Bagnara723df242010-12-14 22:11:44 +0000779 TypeLoc TL = TSInfo->getTypeLoc().IgnoreParens();
Douglas Gregor01829d32010-08-31 14:41:23 +0000780 FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL);
781
782 // If we have a function declared directly (without the use of a typedef),
783 // visit just the return type. Otherwise, just visit the function's type
784 // now.
785 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) ||
786 (!FTL && Visit(TL)))
787 return true;
788
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000789 // Visit the nested-name-specifier, if present.
Douglas Gregorc22b5ff2011-02-25 02:25:35 +0000790 if (NestedNameSpecifierLoc QualifierLoc = ND->getQualifierLoc())
791 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000792 return true;
Douglas Gregor01829d32010-08-31 14:41:23 +0000793
794 // Visit the declaration name.
795 if (VisitDeclarationNameInfo(ND->getNameInfo()))
796 return true;
797
798 // FIXME: Visit explicitly-specified template arguments!
799
800 // Visit the function parameters, if we have a function type.
801 if (FTL && VisitFunctionTypeLoc(*FTL, true))
802 return true;
803
804 // FIXME: Attributes?
805 }
806
Sean Hunt10620eb2011-05-06 20:44:56 +0000807 if (ND->doesThisDeclarationHaveABody() && !ND->isLateTemplateParsed()) {
Douglas Gregora67e03f2010-09-09 21:42:20 +0000808 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
809 // Find the initializers that were written in the source.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000810 SmallVector<CXXCtorInitializer *, 4> WrittenInits;
Douglas Gregora67e03f2010-09-09 21:42:20 +0000811 for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(),
812 IEnd = Constructor->init_end();
813 I != IEnd; ++I) {
814 if (!(*I)->isWritten())
815 continue;
816
817 WrittenInits.push_back(*I);
818 }
819
820 // Sort the initializers in source order
821 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
Sean Huntcbb67482011-01-08 20:30:50 +0000822 &CompareCXXCtorInitializers);
Douglas Gregora67e03f2010-09-09 21:42:20 +0000823
824 // Visit the initializers in source order
825 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
Sean Huntcbb67482011-01-08 20:30:50 +0000826 CXXCtorInitializer *Init = WrittenInits[I];
Francois Pichet00eb3f92010-12-04 09:14:42 +0000827 if (Init->isAnyMemberInitializer()) {
828 if (Visit(MakeCursorMemberRef(Init->getAnyMember(),
Douglas Gregora67e03f2010-09-09 21:42:20 +0000829 Init->getMemberLocation(), TU)))
830 return true;
831 } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) {
832 if (Visit(BaseInfo->getTypeLoc()))
833 return true;
834 }
835
836 // Visit the initializer value.
837 if (Expr *Initializer = Init->getInit())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000838 if (Visit(MakeCXCursor(Initializer, ND, TU, RegionOfInterest)))
Douglas Gregora67e03f2010-09-09 21:42:20 +0000839 return true;
840 }
841 }
842
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000843 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
Douglas Gregora67e03f2010-09-09 21:42:20 +0000844 return true;
845 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000846
Douglas Gregorb1373d02010-01-20 20:59:29 +0000847 return false;
848}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000849
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000850bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
851 if (VisitDeclaratorDecl(D))
852 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000853
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000854 if (Expr *BitWidth = D->getBitWidth())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000855 return Visit(MakeCXCursor(BitWidth, StmtParent, TU, RegionOfInterest));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000856
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000857 return false;
858}
859
860bool CursorVisitor::VisitVarDecl(VarDecl *D) {
861 if (VisitDeclaratorDecl(D))
862 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000863
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000864 if (Expr *Init = D->getInit())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000865 return Visit(MakeCXCursor(Init, StmtParent, TU, RegionOfInterest));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000866
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000867 return false;
868}
869
Douglas Gregor84b51d72010-09-01 20:16:53 +0000870bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
871 if (VisitDeclaratorDecl(D))
872 return true;
873
874 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
875 if (Expr *DefArg = D->getDefaultArgument())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000876 return Visit(MakeCXCursor(DefArg, StmtParent, TU, RegionOfInterest));
Douglas Gregor84b51d72010-09-01 20:16:53 +0000877
878 return false;
879}
880
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000881bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
882 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
883 // before visiting these template parameters.
884 if (VisitTemplateParameters(D->getTemplateParameters()))
885 return true;
886
887 return VisitFunctionDecl(D->getTemplatedDecl());
888}
889
Douglas Gregor39d6f072010-08-31 19:02:00 +0000890bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
891 // FIXME: Visit the "outer" template parameter lists on the TagDecl
892 // before visiting these template parameters.
893 if (VisitTemplateParameters(D->getTemplateParameters()))
894 return true;
895
896 return VisitCXXRecordDecl(D->getTemplatedDecl());
897}
898
Douglas Gregor84b51d72010-09-01 20:16:53 +0000899bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
900 if (VisitTemplateParameters(D->getTemplateParameters()))
901 return true;
902
903 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
904 VisitTemplateArgumentLoc(D->getDefaultArgument()))
905 return true;
906
907 return false;
908}
909
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000910bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Douglas Gregor4bc1cb62010-03-08 14:59:44 +0000911 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
912 if (Visit(TSInfo->getTypeLoc()))
913 return true;
914
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000915 for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000916 PEnd = ND->param_end();
917 P != PEnd; ++P) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000918 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000919 return true;
920 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000921
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000922 if (ND->isThisDeclarationADefinition() &&
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000923 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU, RegionOfInterest)))
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000924 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000925
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000926 return false;
927}
928
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000929namespace {
930 struct ContainerDeclsSort {
931 SourceManager &SM;
932 ContainerDeclsSort(SourceManager &sm) : SM(sm) {}
933 bool operator()(Decl *A, Decl *B) {
934 SourceLocation L_A = A->getLocStart();
935 SourceLocation L_B = B->getLocStart();
936 assert(L_A.isValid() && L_B.isValid());
937 return SM.isBeforeInTranslationUnit(L_A, L_B);
938 }
939 };
940}
941
Douglas Gregora59e3902010-01-21 23:27:09 +0000942bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000943 // FIXME: Eventually convert back to just 'VisitDeclContext()'. Essentially
944 // an @implementation can lexically contain Decls that are not properly
945 // nested in the AST. When we identify such cases, we need to retrofit
946 // this nesting here.
947 if (!DI_current)
948 return VisitDeclContext(D);
949
950 // Scan the Decls that immediately come after the container
951 // in the current DeclContext. If any fall within the
952 // container's lexical region, stash them into a vector
953 // for later processing.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000954 SmallVector<Decl *, 24> DeclsInContainer;
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000955 SourceLocation EndLoc = D->getSourceRange().getEnd();
Ted Kremeneka60ed472010-11-16 08:15:36 +0000956 SourceManager &SM = AU->getSourceManager();
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000957 if (EndLoc.isValid()) {
958 DeclContext::decl_iterator next = *DI_current;
959 while (++next != DE_current) {
960 Decl *D_next = *next;
961 if (!D_next)
962 break;
963 SourceLocation L = D_next->getLocStart();
964 if (!L.isValid())
965 break;
966 if (SM.isBeforeInTranslationUnit(L, EndLoc)) {
967 *DI_current = next;
968 DeclsInContainer.push_back(D_next);
969 continue;
970 }
971 break;
972 }
973 }
974
975 // The common case.
976 if (DeclsInContainer.empty())
977 return VisitDeclContext(D);
978
979 // Get all the Decls in the DeclContext, and sort them with the
980 // additional ones we've collected. Then visit them.
981 for (DeclContext::decl_iterator I = D->decls_begin(), E = D->decls_end();
982 I!=E; ++I) {
983 Decl *subDecl = *I;
Ted Kremenek0582c892010-11-02 23:17:51 +0000984 if (!subDecl || subDecl->getLexicalDeclContext() != D ||
985 subDecl->getLocStart().isInvalid())
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000986 continue;
987 DeclsInContainer.push_back(subDecl);
988 }
989
990 // Now sort the Decls so that they appear in lexical order.
991 std::sort(DeclsInContainer.begin(), DeclsInContainer.end(),
992 ContainerDeclsSort(SM));
993
994 // Now visit the decls.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000995 for (SmallVectorImpl<Decl*>::iterator I = DeclsInContainer.begin(),
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000996 E = DeclsInContainer.end(); I != E; ++I) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +0000997 CXCursor Cursor = MakeCXCursor(*I, TU, RegionOfInterest);
Ted Kremenekd8c370c2010-11-02 23:10:24 +0000998 const llvm::Optional<bool> &V = shouldVisitCursor(Cursor);
999 if (!V.hasValue())
1000 continue;
1001 if (!V.getValue())
1002 return false;
1003 if (Visit(Cursor, true))
1004 return true;
1005 }
1006 return false;
Douglas Gregora59e3902010-01-21 23:27:09 +00001007}
1008
Douglas Gregorb1373d02010-01-20 20:59:29 +00001009bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001010 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
1011 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001012 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001013
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001014 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
1015 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
1016 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001017 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001018 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001019
Douglas Gregora59e3902010-01-21 23:27:09 +00001020 return VisitObjCContainerDecl(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001021}
1022
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001023bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1024 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
1025 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
1026 E = PID->protocol_end(); I != E; ++I, ++PL)
1027 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
1028 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001029
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001030 return VisitObjCContainerDecl(PID);
1031}
1032
Ted Kremenek23173d72010-05-18 21:09:07 +00001033bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
Douglas Gregor83cb9422010-09-09 17:09:21 +00001034 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
John McCallfc929202010-06-04 22:33:30 +00001035 return true;
1036
Ted Kremenek23173d72010-05-18 21:09:07 +00001037 // FIXME: This implements a workaround with @property declarations also being
1038 // installed in the DeclContext for the @interface. Eventually this code
1039 // should be removed.
1040 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
1041 if (!CDecl || !CDecl->IsClassExtension())
1042 return false;
1043
1044 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
1045 if (!ID)
1046 return false;
1047
1048 IdentifierInfo *PropertyId = PD->getIdentifier();
1049 ObjCPropertyDecl *prevDecl =
1050 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
1051
1052 if (!prevDecl)
1053 return false;
1054
1055 // Visit synthesized methods since they will be skipped when visiting
1056 // the @interface.
1057 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
Ted Kremeneka054fb42010-09-21 20:52:59 +00001058 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001059 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
Ted Kremenek23173d72010-05-18 21:09:07 +00001060 return true;
1061
1062 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
Ted Kremeneka054fb42010-09-21 20:52:59 +00001063 if (MD->isSynthesized() && MD->getLexicalDeclContext() == CDecl)
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001064 if (Visit(MakeCXCursor(MD, TU, RegionOfInterest)))
Ted Kremenek23173d72010-05-18 21:09:07 +00001065 return true;
1066
1067 return false;
1068}
1069
Douglas Gregorb1373d02010-01-20 20:59:29 +00001070bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001071 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +00001072 if (D->getSuperClass() &&
1073 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001074 D->getSuperClassLoc(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001075 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001076 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001077
Douglas Gregor78db0cd2010-01-16 15:44:18 +00001078 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1079 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
1080 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001081 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001082 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001083
Douglas Gregora59e3902010-01-21 23:27:09 +00001084 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001085}
1086
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001087bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
1088 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001089}
1090
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001091bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
Ted Kremenekebfa3392010-03-19 20:39:03 +00001092 // 'ID' could be null when dealing with invalid code.
1093 if (ObjCInterfaceDecl *ID = D->getClassInterface())
1094 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
1095 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001096
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001097 return VisitObjCImplDecl(D);
1098}
1099
1100bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
1101#if 0
1102 // Issue callbacks for super class.
1103 // FIXME: No source location information!
1104 if (D->getSuperClass() &&
1105 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001106 D->getSuperClassLoc(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001107 TU)))
1108 return true;
1109#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001110
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001111 return VisitObjCImplDecl(D);
1112}
1113
1114bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
1115 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
1116 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
1117 E = D->protocol_end();
1118 I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00001119 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +00001120 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001121
1122 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001123}
1124
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001125bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
Fariborz Jahanian95ed7782011-08-27 20:50:59 +00001126 if (Visit(MakeCursorObjCClassRef(D->getForwardInterfaceDecl(),
1127 D->getForwardDecl()->getLocation(), TU)))
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001128 return true;
Douglas Gregor1ef2fc12010-01-22 00:50:27 +00001129 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +00001130}
1131
Douglas Gregora4ffd852010-11-17 01:03:52 +00001132bool CursorVisitor::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PD) {
1133 if (ObjCIvarDecl *Ivar = PD->getPropertyIvarDecl())
1134 return Visit(MakeCursorMemberRef(Ivar, PD->getPropertyIvarDeclLoc(), TU));
1135
1136 return false;
1137}
1138
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00001139bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
1140 return VisitDeclContext(D);
1141}
1142
Douglas Gregor69319002010-08-31 23:48:11 +00001143bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001144 // Visit nested-name-specifier.
Douglas Gregor0cfaf6a2011-02-25 17:08:07 +00001145 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1146 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001147 return true;
Douglas Gregor69319002010-08-31 23:48:11 +00001148
1149 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1150 D->getTargetNameLoc(), TU));
1151}
1152
Douglas Gregor7e242562010-09-01 19:52:22 +00001153bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001154 // Visit nested-name-specifier.
Douglas Gregordc355712011-02-25 00:36:19 +00001155 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1156 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001157 return true;
Douglas Gregordc355712011-02-25 00:36:19 +00001158 }
Douglas Gregor7e242562010-09-01 19:52:22 +00001159
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001160 if (Visit(MakeCursorOverloadedDeclRef(D, D->getLocation(), TU)))
1161 return true;
1162
Douglas Gregor7e242562010-09-01 19:52:22 +00001163 return VisitDeclarationNameInfo(D->getNameInfo());
1164}
1165
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001166bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001167 // Visit nested-name-specifier.
Douglas Gregordb992412011-02-25 16:33:46 +00001168 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1169 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001170 return true;
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001171
1172 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1173 D->getIdentLocation(), TU));
1174}
1175
Douglas Gregor7e242562010-09-01 19:52:22 +00001176bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001177 // Visit nested-name-specifier.
Douglas Gregordc355712011-02-25 00:36:19 +00001178 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc()) {
1179 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001180 return true;
Douglas Gregordc355712011-02-25 00:36:19 +00001181 }
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001182
Douglas Gregor7e242562010-09-01 19:52:22 +00001183 return VisitDeclarationNameInfo(D->getNameInfo());
1184}
1185
1186bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1187 UnresolvedUsingTypenameDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001188 // Visit nested-name-specifier.
Douglas Gregordc355712011-02-25 00:36:19 +00001189 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1190 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001191 return true;
1192
Douglas Gregor7e242562010-09-01 19:52:22 +00001193 return false;
1194}
1195
Douglas Gregor01829d32010-08-31 14:41:23 +00001196bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1197 switch (Name.getName().getNameKind()) {
1198 case clang::DeclarationName::Identifier:
1199 case clang::DeclarationName::CXXLiteralOperatorName:
1200 case clang::DeclarationName::CXXOperatorName:
1201 case clang::DeclarationName::CXXUsingDirective:
1202 return false;
1203
1204 case clang::DeclarationName::CXXConstructorName:
1205 case clang::DeclarationName::CXXDestructorName:
1206 case clang::DeclarationName::CXXConversionFunctionName:
1207 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1208 return Visit(TSInfo->getTypeLoc());
1209 return false;
1210
1211 case clang::DeclarationName::ObjCZeroArgSelector:
1212 case clang::DeclarationName::ObjCOneArgSelector:
1213 case clang::DeclarationName::ObjCMultiArgSelector:
1214 // FIXME: Per-identifier location info?
1215 return false;
1216 }
1217
1218 return false;
1219}
1220
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001221bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1222 SourceRange Range) {
1223 // FIXME: This whole routine is a hack to work around the lack of proper
1224 // source information in nested-name-specifiers (PR5791). Since we do have
1225 // a beginning source location, we can visit the first component of the
1226 // nested-name-specifier, if it's a single-token component.
1227 if (!NNS)
1228 return false;
1229
1230 // Get the first component in the nested-name-specifier.
1231 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1232 NNS = Prefix;
1233
1234 switch (NNS->getKind()) {
1235 case NestedNameSpecifier::Namespace:
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001236 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1237 TU));
1238
Douglas Gregor14aba762011-02-24 02:36:08 +00001239 case NestedNameSpecifier::NamespaceAlias:
1240 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
1241 Range.getBegin(), TU));
1242
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001243 case NestedNameSpecifier::TypeSpec: {
1244 // If the type has a form where we know that the beginning of the source
1245 // range matches up with a reference cursor. Visit the appropriate reference
1246 // cursor.
John McCallf4c73712011-01-19 06:33:43 +00001247 const Type *T = NNS->getAsType();
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001248 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1249 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1250 if (const TagType *Tag = dyn_cast<TagType>(T))
1251 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1252 if (const TemplateSpecializationType *TST
1253 = dyn_cast<TemplateSpecializationType>(T))
1254 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1255 break;
1256 }
1257
1258 case NestedNameSpecifier::TypeSpecWithTemplate:
1259 case NestedNameSpecifier::Global:
1260 case NestedNameSpecifier::Identifier:
1261 break;
1262 }
1263
1264 return false;
1265}
1266
Douglas Gregordc355712011-02-25 00:36:19 +00001267bool
1268CursorVisitor::VisitNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00001269 SmallVector<NestedNameSpecifierLoc, 4> Qualifiers;
Douglas Gregordc355712011-02-25 00:36:19 +00001270 for (; Qualifier; Qualifier = Qualifier.getPrefix())
1271 Qualifiers.push_back(Qualifier);
1272
1273 while (!Qualifiers.empty()) {
1274 NestedNameSpecifierLoc Q = Qualifiers.pop_back_val();
1275 NestedNameSpecifier *NNS = Q.getNestedNameSpecifier();
1276 switch (NNS->getKind()) {
1277 case NestedNameSpecifier::Namespace:
1278 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(),
Douglas Gregorc22b5ff2011-02-25 02:25:35 +00001279 Q.getLocalBeginLoc(),
Douglas Gregordc355712011-02-25 00:36:19 +00001280 TU)))
1281 return true;
1282
1283 break;
1284
1285 case NestedNameSpecifier::NamespaceAlias:
1286 if (Visit(MakeCursorNamespaceRef(NNS->getAsNamespaceAlias(),
Douglas Gregorc22b5ff2011-02-25 02:25:35 +00001287 Q.getLocalBeginLoc(),
Douglas Gregordc355712011-02-25 00:36:19 +00001288 TU)))
1289 return true;
1290
1291 break;
1292
1293 case NestedNameSpecifier::TypeSpec:
1294 case NestedNameSpecifier::TypeSpecWithTemplate:
1295 if (Visit(Q.getTypeLoc()))
1296 return true;
1297
1298 break;
1299
1300 case NestedNameSpecifier::Global:
1301 case NestedNameSpecifier::Identifier:
1302 break;
1303 }
1304 }
1305
1306 return false;
1307}
1308
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001309bool CursorVisitor::VisitTemplateParameters(
1310 const TemplateParameterList *Params) {
1311 if (!Params)
1312 return false;
1313
1314 for (TemplateParameterList::const_iterator P = Params->begin(),
1315 PEnd = Params->end();
1316 P != PEnd; ++P) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001317 if (Visit(MakeCXCursor(*P, TU, RegionOfInterest)))
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001318 return true;
1319 }
1320
1321 return false;
1322}
1323
Douglas Gregor0b36e612010-08-31 20:37:03 +00001324bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1325 switch (Name.getKind()) {
1326 case TemplateName::Template:
1327 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1328
1329 case TemplateName::OverloadedTemplate:
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00001330 // Visit the overloaded template set.
1331 if (Visit(MakeCursorOverloadedDeclRef(Name, Loc, TU)))
1332 return true;
1333
Douglas Gregor0b36e612010-08-31 20:37:03 +00001334 return false;
1335
1336 case TemplateName::DependentTemplate:
1337 // FIXME: Visit nested-name-specifier.
1338 return false;
1339
1340 case TemplateName::QualifiedTemplate:
1341 // FIXME: Visit nested-name-specifier.
1342 return Visit(MakeCursorTemplateRef(
1343 Name.getAsQualifiedTemplateName()->getDecl(),
1344 Loc, TU));
John McCall14606042011-06-30 08:33:18 +00001345
1346 case TemplateName::SubstTemplateTemplateParm:
1347 return Visit(MakeCursorTemplateRef(
1348 Name.getAsSubstTemplateTemplateParm()->getParameter(),
1349 Loc, TU));
Douglas Gregor1aee05d2011-01-15 06:45:20 +00001350
1351 case TemplateName::SubstTemplateTemplateParmPack:
1352 return Visit(MakeCursorTemplateRef(
1353 Name.getAsSubstTemplateTemplateParmPack()->getParameterPack(),
1354 Loc, TU));
Douglas Gregor0b36e612010-08-31 20:37:03 +00001355 }
1356
1357 return false;
1358}
1359
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001360bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1361 switch (TAL.getArgument().getKind()) {
1362 case TemplateArgument::Null:
1363 case TemplateArgument::Integral:
Douglas Gregor87dd6972010-12-20 16:52:59 +00001364 case TemplateArgument::Pack:
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001365 return false;
1366
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001367 case TemplateArgument::Type:
1368 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1369 return Visit(TSInfo->getTypeLoc());
1370 return false;
1371
1372 case TemplateArgument::Declaration:
1373 if (Expr *E = TAL.getSourceDeclExpression())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001374 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001375 return false;
1376
1377 case TemplateArgument::Expression:
1378 if (Expr *E = TAL.getSourceExpression())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001379 return Visit(MakeCXCursor(E, StmtParent, TU, RegionOfInterest));
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001380 return false;
1381
1382 case TemplateArgument::Template:
Douglas Gregora7fc9012011-01-05 18:58:31 +00001383 case TemplateArgument::TemplateExpansion:
Douglas Gregorb6744ef2011-03-02 17:09:35 +00001384 if (VisitNestedNameSpecifierLoc(TAL.getTemplateQualifierLoc()))
1385 return true;
1386
Douglas Gregora7fc9012011-01-05 18:58:31 +00001387 return VisitTemplateName(TAL.getArgument().getAsTemplateOrTemplatePattern(),
Douglas Gregor0b36e612010-08-31 20:37:03 +00001388 TAL.getTemplateNameLoc());
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001389 }
1390
1391 return false;
1392}
1393
Ted Kremeneka0536d82010-05-07 01:04:29 +00001394bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1395 return VisitDeclContext(D);
1396}
1397
Douglas Gregor01829d32010-08-31 14:41:23 +00001398bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1399 return Visit(TL.getUnqualifiedLoc());
1400}
1401
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001402bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00001403 ASTContext &Context = AU->getASTContext();
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001404
1405 // Some builtin types (such as Objective-C's "id", "sel", and
1406 // "Class") have associated declarations. Create cursors for those.
1407 QualType VisitType;
John McCalle0a22d02011-10-18 21:02:43 +00001408 switch (TL.getTypePtr()->getKind()) {
John McCall2dde35b2011-10-18 22:28:37 +00001409
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001410 case BuiltinType::Void:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001411 case BuiltinType::NullPtr:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001412 case BuiltinType::Dependent:
John McCall2dde35b2011-10-18 22:28:37 +00001413#define BUILTIN_TYPE(Id, SingletonId)
1414#define SIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1415#define UNSIGNED_TYPE(Id, SingletonId) case BuiltinType::Id:
1416#define FLOATING_TYPE(Id, SingletonId) case BuiltinType::Id:
1417#define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
1418#include "clang/AST/BuiltinTypes.def"
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001419 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001420
Ted Kremenekc4174cc2010-02-18 18:52:18 +00001421 case BuiltinType::ObjCId:
1422 VisitType = Context.getObjCIdType();
1423 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001424
1425 case BuiltinType::ObjCClass:
1426 VisitType = Context.getObjCClassType();
1427 break;
1428
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001429 case BuiltinType::ObjCSel:
1430 VisitType = Context.getObjCSelType();
1431 break;
1432 }
1433
1434 if (!VisitType.isNull()) {
1435 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001436 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001437 TU));
1438 }
1439
1440 return false;
1441}
1442
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001443bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith162e1c12011-04-15 14:24:37 +00001444 return Visit(MakeCursorTypeRef(TL.getTypedefNameDecl(), TL.getNameLoc(), TU));
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001445}
1446
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001447bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1448 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1449}
1450
1451bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
Argyrios Kyrtzidis6f155de2011-08-25 22:24:47 +00001452 if (TL.isDefinition())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001453 return Visit(MakeCXCursor(TL.getDecl(), TU, RegionOfInterest));
Argyrios Kyrtzidis6f155de2011-08-25 22:24:47 +00001454
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001455 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1456}
1457
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001458bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Chandler Carruth960d13d2011-05-01 09:53:37 +00001459 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001460}
1461
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001462bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1463 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1464 return true;
1465
John McCallc12c5bb2010-05-15 11:32:37 +00001466 return false;
1467}
1468
1469bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1470 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1471 return true;
1472
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001473 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1474 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1475 TU)))
1476 return true;
1477 }
1478
1479 return false;
1480}
1481
1482bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +00001483 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001484}
1485
Abramo Bagnara075f8f12010-12-10 16:29:40 +00001486bool CursorVisitor::VisitParenTypeLoc(ParenTypeLoc TL) {
1487 return Visit(TL.getInnerLoc());
1488}
1489
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001490bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1491 return Visit(TL.getPointeeLoc());
1492}
1493
1494bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1495 return Visit(TL.getPointeeLoc());
1496}
1497
1498bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1499 return Visit(TL.getPointeeLoc());
1500}
1501
1502bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001503 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001504}
1505
1506bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001507 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001508}
1509
Argyrios Kyrtzidis3422fbc2011-08-15 18:44:43 +00001510bool CursorVisitor::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
1511 return Visit(TL.getModifiedLoc());
1512}
1513
Douglas Gregor01829d32010-08-31 14:41:23 +00001514bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1515 bool SkipResultType) {
1516 if (!SkipResultType && Visit(TL.getResultLoc()))
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001517 return true;
1518
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001519 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +00001520 if (Decl *D = TL.getArg(I))
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001521 if (Visit(MakeCXCursor(D, TU, RegionOfInterest)))
Ted Kremenek5dbacb42010-04-07 00:27:13 +00001522 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001523
1524 return false;
1525}
1526
1527bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1528 if (Visit(TL.getElementLoc()))
1529 return true;
1530
1531 if (Expr *Size = TL.getSizeExpr())
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00001532 return Visit(MakeCXCursor(Size, StmtParent, TU, RegionOfInterest));
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001533
1534 return false;
1535}
1536
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001537bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1538 TemplateSpecializationTypeLoc TL) {
Douglas Gregor0b36e612010-08-31 20:37:03 +00001539 // Visit the template name.
1540 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1541 TL.getTemplateNameLoc()))
1542 return true;
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001543
1544 // Visit the template arguments.
1545 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1546 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1547 return true;
1548
1549 return false;
1550}
1551
Douglas Gregor2332c112010-01-21 20:48:56 +00001552bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1553 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1554}
1555
1556bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1557 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1558 return Visit(TSInfo->getTypeLoc());
1559
1560 return false;
1561}
1562
Sean Huntca63c202011-05-24 22:41:36 +00001563bool CursorVisitor::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
1564 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1565 return Visit(TSInfo->getTypeLoc());
1566
1567 return false;
1568}
1569
Douglas Gregor2494dd02011-03-01 01:34:45 +00001570bool CursorVisitor::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
1571 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1572 return true;
1573
1574 return false;
1575}
1576
Douglas Gregor94fdffa2011-03-01 20:11:18 +00001577bool CursorVisitor::VisitDependentTemplateSpecializationTypeLoc(
1578 DependentTemplateSpecializationTypeLoc TL) {
1579 // Visit the nested-name-specifier, if there is one.
1580 if (TL.getQualifierLoc() &&
1581 VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1582 return true;
1583
1584 // Visit the template arguments.
1585 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1586 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1587 return true;
1588
1589 return false;
1590}
1591
Douglas Gregor9e876872011-03-01 18:12:44 +00001592bool CursorVisitor::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
1593 if (VisitNestedNameSpecifierLoc(TL.getQualifierLoc()))
1594 return true;
1595
1596 return Visit(TL.getNamedTypeLoc());
1597}
1598
Douglas Gregor7536dd52010-12-20 02:24:11 +00001599bool CursorVisitor::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
1600 return Visit(TL.getPatternLoc());
1601}
1602
Argyrios Kyrtzidis427964e2011-08-15 22:40:24 +00001603bool CursorVisitor::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
1604 if (Expr *E = TL.getUnderlyingExpr())
1605 return Visit(MakeCXCursor(E, StmtParent, TU));
1606
1607 return false;
1608}
1609
1610bool CursorVisitor::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
1611 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1612}
1613
Eli Friedmanb001de72011-10-06 23:00:33 +00001614bool CursorVisitor::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
1615 return Visit(TL.getValueLoc());
1616}
1617
Argyrios Kyrtzidis427964e2011-08-15 22:40:24 +00001618#define DEFAULT_TYPELOC_IMPL(CLASS, PARENT) \
1619bool CursorVisitor::Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
1620 return Visit##PARENT##Loc(TL); \
1621}
1622
1623DEFAULT_TYPELOC_IMPL(Complex, Type)
1624DEFAULT_TYPELOC_IMPL(ConstantArray, ArrayType)
1625DEFAULT_TYPELOC_IMPL(IncompleteArray, ArrayType)
1626DEFAULT_TYPELOC_IMPL(VariableArray, ArrayType)
1627DEFAULT_TYPELOC_IMPL(DependentSizedArray, ArrayType)
1628DEFAULT_TYPELOC_IMPL(DependentSizedExtVector, Type)
1629DEFAULT_TYPELOC_IMPL(Vector, Type)
1630DEFAULT_TYPELOC_IMPL(ExtVector, VectorType)
1631DEFAULT_TYPELOC_IMPL(FunctionProto, FunctionType)
1632DEFAULT_TYPELOC_IMPL(FunctionNoProto, FunctionType)
1633DEFAULT_TYPELOC_IMPL(Record, TagType)
1634DEFAULT_TYPELOC_IMPL(Enum, TagType)
1635DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParm, Type)
1636DEFAULT_TYPELOC_IMPL(SubstTemplateTypeParmPack, Type)
1637DEFAULT_TYPELOC_IMPL(Auto, Type)
1638
Ted Kremenek3064ef92010-08-27 21:34:58 +00001639bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
Douglas Gregorc22b5ff2011-02-25 02:25:35 +00001640 // Visit the nested-name-specifier, if present.
1641 if (NestedNameSpecifierLoc QualifierLoc = D->getQualifierLoc())
1642 if (VisitNestedNameSpecifierLoc(QualifierLoc))
1643 return true;
1644
John McCall5e1cdac2011-10-07 06:10:15 +00001645 if (D->isCompleteDefinition()) {
Ted Kremenek3064ef92010-08-27 21:34:58 +00001646 for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1647 E = D->bases_end(); I != E; ++I) {
1648 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1649 return true;
1650 }
1651 }
1652
1653 return VisitTagDecl(D);
1654}
1655
Ted Kremenek09dfa372010-02-18 05:46:33 +00001656bool CursorVisitor::VisitAttributes(Decl *D) {
Sean Huntcf807c42010-08-18 23:23:40 +00001657 for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1658 i != e; ++i)
1659 if (Visit(MakeCXCursor(*i, D, TU)))
Ted Kremenek09dfa372010-02-18 05:46:33 +00001660 return true;
1661
1662 return false;
1663}
1664
Ted Kremenekc0e1d922010-11-11 08:05:18 +00001665//===----------------------------------------------------------------------===//
1666// Data-recursive visitor methods.
1667//===----------------------------------------------------------------------===//
1668
Ted Kremenek28a71942010-11-13 00:36:47 +00001669namespace {
Ted Kremenek035dc412010-11-13 00:36:50 +00001670#define DEF_JOB(NAME, DATA, KIND)\
1671class NAME : public VisitorJob {\
1672public:\
1673 NAME(DATA *d, CXCursor parent) : VisitorJob(parent, VisitorJob::KIND, d) {} \
1674 static bool classof(const VisitorJob *VJ) { return VJ->getKind() == KIND; }\
Ted Kremenekf64d8032010-11-18 00:02:32 +00001675 DATA *get() const { return static_cast<DATA*>(data[0]); }\
Ted Kremenek035dc412010-11-13 00:36:50 +00001676};
1677
1678DEF_JOB(StmtVisit, Stmt, StmtVisitKind)
1679DEF_JOB(MemberExprParts, MemberExpr, MemberExprPartsKind)
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001680DEF_JOB(DeclRefExprParts, DeclRefExpr, DeclRefExprPartsKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001681DEF_JOB(OverloadExprParts, OverloadExpr, OverloadExprPartsKind)
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00001682DEF_JOB(ExplicitTemplateArgsVisit, ASTTemplateArgumentListInfo,
Ted Kremenek60608ec2010-11-17 00:50:47 +00001683 ExplicitTemplateArgsVisitKind)
Douglas Gregor94d96292011-01-19 20:34:17 +00001684DEF_JOB(SizeOfPackExprParts, SizeOfPackExpr, SizeOfPackExprPartsKind)
Ted Kremenek035dc412010-11-13 00:36:50 +00001685#undef DEF_JOB
1686
1687class DeclVisit : public VisitorJob {
1688public:
1689 DeclVisit(Decl *d, CXCursor parent, bool isFirst) :
1690 VisitorJob(parent, VisitorJob::DeclVisitKind,
1691 d, isFirst ? (void*) 1 : (void*) 0) {}
1692 static bool classof(const VisitorJob *VJ) {
Ted Kremenek82f3c502010-11-15 22:23:26 +00001693 return VJ->getKind() == DeclVisitKind;
Ted Kremenek035dc412010-11-13 00:36:50 +00001694 }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001695 Decl *get() const { return static_cast<Decl*>(data[0]); }
1696 bool isFirst() const { return data[1] ? true : false; }
Ted Kremenek035dc412010-11-13 00:36:50 +00001697};
Ted Kremenek035dc412010-11-13 00:36:50 +00001698class TypeLocVisit : public VisitorJob {
1699public:
1700 TypeLocVisit(TypeLoc tl, CXCursor parent) :
1701 VisitorJob(parent, VisitorJob::TypeLocVisitKind,
1702 tl.getType().getAsOpaquePtr(), tl.getOpaqueData()) {}
1703
1704 static bool classof(const VisitorJob *VJ) {
1705 return VJ->getKind() == TypeLocVisitKind;
1706 }
1707
Ted Kremenek82f3c502010-11-15 22:23:26 +00001708 TypeLoc get() const {
Ted Kremenekf64d8032010-11-18 00:02:32 +00001709 QualType T = QualType::getFromOpaquePtr(data[0]);
1710 return TypeLoc(T, data[1]);
Ted Kremenek035dc412010-11-13 00:36:50 +00001711 }
1712};
1713
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001714class LabelRefVisit : public VisitorJob {
1715public:
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001716 LabelRefVisit(LabelDecl *LD, SourceLocation labelLoc, CXCursor parent)
1717 : VisitorJob(parent, VisitorJob::LabelRefVisitKind, LD,
Jeffrey Yasskindec09842011-01-18 02:00:16 +00001718 labelLoc.getPtrEncoding()) {}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001719
1720 static bool classof(const VisitorJob *VJ) {
1721 return VJ->getKind() == VisitorJob::LabelRefVisitKind;
1722 }
Chris Lattnerad8dcf42011-02-17 07:39:24 +00001723 LabelDecl *get() const { return static_cast<LabelDecl*>(data[0]); }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001724 SourceLocation getLoc() const {
Jeffrey Yasskindec09842011-01-18 02:00:16 +00001725 return SourceLocation::getFromPtrEncoding(data[1]); }
Ted Kremenekf64d8032010-11-18 00:02:32 +00001726};
Douglas Gregorf3db29f2011-02-25 18:19:59 +00001727
1728class NestedNameSpecifierLocVisit : public VisitorJob {
1729public:
1730 NestedNameSpecifierLocVisit(NestedNameSpecifierLoc Qualifier, CXCursor parent)
1731 : VisitorJob(parent, VisitorJob::NestedNameSpecifierLocVisitKind,
1732 Qualifier.getNestedNameSpecifier(),
1733 Qualifier.getOpaqueData()) { }
1734
1735 static bool classof(const VisitorJob *VJ) {
1736 return VJ->getKind() == VisitorJob::NestedNameSpecifierLocVisitKind;
1737 }
1738
1739 NestedNameSpecifierLoc get() const {
1740 return NestedNameSpecifierLoc(static_cast<NestedNameSpecifier*>(data[0]),
1741 data[1]);
1742 }
1743};
1744
Ted Kremenekf64d8032010-11-18 00:02:32 +00001745class DeclarationNameInfoVisit : public VisitorJob {
1746public:
1747 DeclarationNameInfoVisit(Stmt *S, CXCursor parent)
1748 : VisitorJob(parent, VisitorJob::DeclarationNameInfoVisitKind, S) {}
1749 static bool classof(const VisitorJob *VJ) {
1750 return VJ->getKind() == VisitorJob::DeclarationNameInfoVisitKind;
1751 }
1752 DeclarationNameInfo get() const {
1753 Stmt *S = static_cast<Stmt*>(data[0]);
1754 switch (S->getStmtClass()) {
1755 default:
1756 llvm_unreachable("Unhandled Stmt");
Douglas Gregorba0513d2011-10-25 01:33:02 +00001757 case clang::Stmt::MSDependentExistsStmtClass:
1758 return cast<MSDependentExistsStmt>(S)->getNameInfo();
Ted Kremenekf64d8032010-11-18 00:02:32 +00001759 case Stmt::CXXDependentScopeMemberExprClass:
1760 return cast<CXXDependentScopeMemberExpr>(S)->getMemberNameInfo();
1761 case Stmt::DependentScopeDeclRefExprClass:
1762 return cast<DependentScopeDeclRefExpr>(S)->getNameInfo();
1763 }
1764 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001765};
Ted Kremenekcdba6592010-11-18 00:42:18 +00001766class MemberRefVisit : public VisitorJob {
1767public:
1768 MemberRefVisit(FieldDecl *D, SourceLocation L, CXCursor parent)
1769 : VisitorJob(parent, VisitorJob::MemberRefVisitKind, D,
Jeffrey Yasskindec09842011-01-18 02:00:16 +00001770 L.getPtrEncoding()) {}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001771 static bool classof(const VisitorJob *VJ) {
1772 return VJ->getKind() == VisitorJob::MemberRefVisitKind;
1773 }
1774 FieldDecl *get() const {
1775 return static_cast<FieldDecl*>(data[0]);
1776 }
1777 SourceLocation getLoc() const {
1778 return SourceLocation::getFromRawEncoding((unsigned)(uintptr_t) data[1]);
1779 }
1780};
Ted Kremenek28a71942010-11-13 00:36:47 +00001781class EnqueueVisitor : public StmtVisitor<EnqueueVisitor, void> {
1782 VisitorWorkList &WL;
1783 CXCursor Parent;
1784public:
1785 EnqueueVisitor(VisitorWorkList &wl, CXCursor parent)
1786 : WL(wl), Parent(parent) {}
1787
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001788 void VisitAddrLabelExpr(AddrLabelExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001789 void VisitBlockExpr(BlockExpr *B);
Ted Kremenek28a71942010-11-13 00:36:47 +00001790 void VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek083c7e22010-11-13 05:38:03 +00001791 void VisitCompoundStmt(CompoundStmt *S);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001792 void VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { /* Do nothing. */ }
Douglas Gregorba0513d2011-10-25 01:33:02 +00001793 void VisitMSDependentExistsStmt(MSDependentExistsStmt *S);
Ted Kremenekf64d8032010-11-18 00:02:32 +00001794 void VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001795 void VisitCXXNewExpr(CXXNewExpr *E);
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001796 void VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001797 void VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001798 void VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001799 void VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001800 void VisitCXXTypeidExpr(CXXTypeidExpr *E);
Ted Kremenek55b933a2010-11-17 00:50:36 +00001801 void VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001802 void VisitCXXUuidofExpr(CXXUuidofExpr *E);
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001803 void VisitDeclRefExpr(DeclRefExpr *D);
Ted Kremenek035dc412010-11-13 00:36:50 +00001804 void VisitDeclStmt(DeclStmt *S);
Ted Kremenekf64d8032010-11-18 00:02:32 +00001805 void VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001806 void VisitDesignatedInitExpr(DesignatedInitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001807 void VisitExplicitCastExpr(ExplicitCastExpr *E);
1808 void VisitForStmt(ForStmt *FS);
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001809 void VisitGotoStmt(GotoStmt *GS);
Ted Kremenek28a71942010-11-13 00:36:47 +00001810 void VisitIfStmt(IfStmt *If);
1811 void VisitInitListExpr(InitListExpr *IE);
1812 void VisitMemberExpr(MemberExpr *M);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001813 void VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek73d15c42010-11-13 01:09:29 +00001814 void VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001815 void VisitObjCMessageExpr(ObjCMessageExpr *M);
1816 void VisitOverloadExpr(OverloadExpr *E);
Peter Collingbournef4e3cfb2011-03-11 19:24:49 +00001817 void VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001818 void VisitStmt(Stmt *S);
1819 void VisitSwitchStmt(SwitchStmt *S);
1820 void VisitWhileStmt(WhileStmt *W);
Ted Kremenek2939b6f2010-11-17 00:50:50 +00001821 void VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
Francois Pichet6ad6f282010-12-07 00:08:36 +00001822 void VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E);
John Wiegley21ff2e52011-04-28 00:16:57 +00001823 void VisitArrayTypeTraitExpr(ArrayTypeTraitExpr *E);
John Wiegley55262202011-04-25 06:54:41 +00001824 void VisitExpressionTraitExpr(ExpressionTraitExpr *E);
Ted Kremenek28a71942010-11-13 00:36:47 +00001825 void VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U);
Ted Kremenek9d3bf792010-11-17 00:50:43 +00001826 void VisitVAArgExpr(VAArgExpr *E);
Douglas Gregor94d96292011-01-19 20:34:17 +00001827 void VisitSizeOfPackExpr(SizeOfPackExpr *E);
Douglas Gregoree8aff02011-01-04 17:33:58 +00001828
Ted Kremenek28a71942010-11-13 00:36:47 +00001829private:
Ted Kremenekf64d8032010-11-18 00:02:32 +00001830 void AddDeclarationNameInfo(Stmt *S);
Douglas Gregorf3db29f2011-02-25 18:19:59 +00001831 void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier);
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00001832 void AddExplicitTemplateArgs(const ASTTemplateArgumentListInfo *A);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001833 void AddMemberRef(FieldDecl *D, SourceLocation L);
Ted Kremenek28a71942010-11-13 00:36:47 +00001834 void AddStmt(Stmt *S);
Ted Kremenek035dc412010-11-13 00:36:50 +00001835 void AddDecl(Decl *D, bool isFirst = true);
Ted Kremenek28a71942010-11-13 00:36:47 +00001836 void AddTypeLoc(TypeSourceInfo *TI);
1837 void EnqueueChildren(Stmt *S);
1838};
1839} // end anonyous namespace
1840
Ted Kremenekf64d8032010-11-18 00:02:32 +00001841void EnqueueVisitor::AddDeclarationNameInfo(Stmt *S) {
1842 // 'S' should always be non-null, since it comes from the
1843 // statement we are visiting.
1844 WL.push_back(DeclarationNameInfoVisit(S, Parent));
1845}
Douglas Gregorf3db29f2011-02-25 18:19:59 +00001846
1847void
1848EnqueueVisitor::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc Qualifier) {
1849 if (Qualifier)
1850 WL.push_back(NestedNameSpecifierLocVisit(Qualifier, Parent));
1851}
1852
Ted Kremenek28a71942010-11-13 00:36:47 +00001853void EnqueueVisitor::AddStmt(Stmt *S) {
1854 if (S)
1855 WL.push_back(StmtVisit(S, Parent));
1856}
Ted Kremenek035dc412010-11-13 00:36:50 +00001857void EnqueueVisitor::AddDecl(Decl *D, bool isFirst) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001858 if (D)
Ted Kremenek035dc412010-11-13 00:36:50 +00001859 WL.push_back(DeclVisit(D, Parent, isFirst));
Ted Kremenek28a71942010-11-13 00:36:47 +00001860}
Ted Kremenek60608ec2010-11-17 00:50:47 +00001861void EnqueueVisitor::
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00001862 AddExplicitTemplateArgs(const ASTTemplateArgumentListInfo *A) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001863 if (A)
1864 WL.push_back(ExplicitTemplateArgsVisit(
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00001865 const_cast<ASTTemplateArgumentListInfo*>(A), Parent));
Ted Kremenek60608ec2010-11-17 00:50:47 +00001866}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001867void EnqueueVisitor::AddMemberRef(FieldDecl *D, SourceLocation L) {
1868 if (D)
1869 WL.push_back(MemberRefVisit(D, L, Parent));
1870}
Ted Kremenek28a71942010-11-13 00:36:47 +00001871void EnqueueVisitor::AddTypeLoc(TypeSourceInfo *TI) {
1872 if (TI)
1873 WL.push_back(TypeLocVisit(TI->getTypeLoc(), Parent));
1874 }
1875void EnqueueVisitor::EnqueueChildren(Stmt *S) {
Ted Kremeneka6b70432010-11-12 21:34:09 +00001876 unsigned size = WL.size();
John McCall7502c1d2011-02-13 04:07:26 +00001877 for (Stmt::child_range Child = S->children(); Child; ++Child) {
Ted Kremenek28a71942010-11-13 00:36:47 +00001878 AddStmt(*Child);
Ted Kremeneka6b70432010-11-12 21:34:09 +00001879 }
1880 if (size == WL.size())
1881 return;
1882 // Now reverse the entries we just added. This will match the DFS
1883 // ordering performed by the worklist.
1884 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1885 std::reverse(I, E);
1886}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00001887void EnqueueVisitor::VisitAddrLabelExpr(AddrLabelExpr *E) {
1888 WL.push_back(LabelRefVisit(E->getLabel(), E->getLabelLoc(), Parent));
1889}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001890void EnqueueVisitor::VisitBlockExpr(BlockExpr *B) {
1891 AddDecl(B->getBlockDecl());
1892}
Ted Kremenek28a71942010-11-13 00:36:47 +00001893void EnqueueVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1894 EnqueueChildren(E);
1895 AddTypeLoc(E->getTypeSourceInfo());
1896}
Ted Kremenek083c7e22010-11-13 05:38:03 +00001897void EnqueueVisitor::VisitCompoundStmt(CompoundStmt *S) {
1898 for (CompoundStmt::reverse_body_iterator I = S->body_rbegin(),
1899 E = S->body_rend(); I != E; ++I) {
1900 AddStmt(*I);
1901 }
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001902}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001903void EnqueueVisitor::
Douglas Gregorba0513d2011-10-25 01:33:02 +00001904VisitMSDependentExistsStmt(MSDependentExistsStmt *S) {
1905 AddStmt(S->getSubStmt());
1906 AddDeclarationNameInfo(S);
1907 if (NestedNameSpecifierLoc QualifierLoc = S->getQualifierLoc())
1908 AddNestedNameSpecifierLoc(QualifierLoc);
1909}
1910
1911void EnqueueVisitor::
Ted Kremenekf64d8032010-11-18 00:02:32 +00001912VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E) {
1913 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1914 AddDeclarationNameInfo(E);
Douglas Gregor7c3179c2011-02-28 18:50:33 +00001915 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
1916 AddNestedNameSpecifierLoc(QualifierLoc);
Ted Kremenekf64d8032010-11-18 00:02:32 +00001917 if (!E->isImplicitAccess())
1918 AddStmt(E->getBase());
1919}
Ted Kremenek11b8e3e2010-11-13 05:55:53 +00001920void EnqueueVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1921 // Enqueue the initializer or constructor arguments.
1922 for (unsigned I = E->getNumConstructorArgs(); I > 0; --I)
1923 AddStmt(E->getConstructorArg(I-1));
1924 // Enqueue the array size, if any.
1925 AddStmt(E->getArraySize());
1926 // Enqueue the allocated type.
1927 AddTypeLoc(E->getAllocatedTypeSourceInfo());
1928 // Enqueue the placement arguments.
1929 for (unsigned I = E->getNumPlacementArgs(); I > 0; --I)
1930 AddStmt(E->getPlacementArg(I-1));
1931}
Ted Kremenek28a71942010-11-13 00:36:47 +00001932void EnqueueVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *CE) {
Ted Kremenek8b8d8c92010-11-13 05:55:56 +00001933 for (unsigned I = CE->getNumArgs(); I > 1 /* Yes, this is 1 */; --I)
1934 AddStmt(CE->getArg(I-1));
Ted Kremenek28a71942010-11-13 00:36:47 +00001935 AddStmt(CE->getCallee());
1936 AddStmt(CE->getArg(0));
1937}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001938void EnqueueVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1939 // Visit the name of the type being destroyed.
1940 AddTypeLoc(E->getDestroyedTypeInfo());
1941 // Visit the scope type that looks disturbingly like the nested-name-specifier
1942 // but isn't.
1943 AddTypeLoc(E->getScopeTypeInfo());
1944 // Visit the nested-name-specifier.
Douglas Gregorf3db29f2011-02-25 18:19:59 +00001945 if (NestedNameSpecifierLoc QualifierLoc = E->getQualifierLoc())
1946 AddNestedNameSpecifierLoc(QualifierLoc);
Ted Kremenekcdba6592010-11-18 00:42:18 +00001947 // Visit base expression.
1948 AddStmt(E->getBase());
1949}
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00001950void EnqueueVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1951 AddTypeLoc(E->getTypeSourceInfo());
1952}
Ted Kremenek73d15c42010-11-13 01:09:29 +00001953void EnqueueVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1954 EnqueueChildren(E);
1955 AddTypeLoc(E->getTypeSourceInfo());
1956}
Ted Kremenekb8dd1ca2010-11-17 00:50:41 +00001957void EnqueueVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1958 EnqueueChildren(E);
1959 if (E->isTypeOperand())
1960 AddTypeLoc(E->getTypeOperandSourceInfo());
1961}
Ted Kremenek55b933a2010-11-17 00:50:36 +00001962
1963void EnqueueVisitor::VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr
1964 *E) {
1965 EnqueueChildren(E);
1966 AddTypeLoc(E->getTypeSourceInfo());
1967}
Ted Kremenek1e7e8772010-11-17 00:50:52 +00001968void EnqueueVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1969 EnqueueChildren(E);
1970 if (E->isTypeOperand())
1971 AddTypeLoc(E->getTypeOperandSourceInfo());
1972}
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001973void EnqueueVisitor::VisitDeclRefExpr(DeclRefExpr *DR) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00001974 if (DR->hasExplicitTemplateArgs()) {
1975 AddExplicitTemplateArgs(&DR->getExplicitTemplateArgs());
1976 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00001977 WL.push_back(DeclRefExprParts(DR, Parent));
1978}
Ted Kremenekf64d8032010-11-18 00:02:32 +00001979void EnqueueVisitor::VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E) {
1980 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
1981 AddDeclarationNameInfo(E);
Douglas Gregor00cf3cc2011-02-25 20:49:16 +00001982 AddNestedNameSpecifierLoc(E->getQualifierLoc());
Ted Kremenekf64d8032010-11-18 00:02:32 +00001983}
Ted Kremenek035dc412010-11-13 00:36:50 +00001984void EnqueueVisitor::VisitDeclStmt(DeclStmt *S) {
1985 unsigned size = WL.size();
1986 bool isFirst = true;
1987 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1988 D != DEnd; ++D) {
1989 AddDecl(*D, isFirst);
1990 isFirst = false;
1991 }
1992 if (size == WL.size())
1993 return;
1994 // Now reverse the entries we just added. This will match the DFS
1995 // ordering performed by the worklist.
1996 VisitorWorkList::iterator I = WL.begin() + size, E = WL.end();
1997 std::reverse(I, E);
1998}
Ted Kremenekcdba6592010-11-18 00:42:18 +00001999void EnqueueVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
2000 AddStmt(E->getInit());
2001 typedef DesignatedInitExpr::Designator Designator;
2002 for (DesignatedInitExpr::reverse_designators_iterator
2003 D = E->designators_rbegin(), DEnd = E->designators_rend();
2004 D != DEnd; ++D) {
2005 if (D->isFieldDesignator()) {
2006 if (FieldDecl *Field = D->getField())
2007 AddMemberRef(Field, D->getFieldLoc());
2008 continue;
2009 }
2010 if (D->isArrayDesignator()) {
2011 AddStmt(E->getArrayIndex(*D));
2012 continue;
2013 }
2014 assert(D->isArrayRangeDesignator() && "Unknown designator kind");
2015 AddStmt(E->getArrayRangeEnd(*D));
2016 AddStmt(E->getArrayRangeStart(*D));
2017 }
2018}
Ted Kremenek28a71942010-11-13 00:36:47 +00002019void EnqueueVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
2020 EnqueueChildren(E);
2021 AddTypeLoc(E->getTypeInfoAsWritten());
2022}
2023void EnqueueVisitor::VisitForStmt(ForStmt *FS) {
2024 AddStmt(FS->getBody());
2025 AddStmt(FS->getInc());
2026 AddStmt(FS->getCond());
2027 AddDecl(FS->getConditionVariable());
2028 AddStmt(FS->getInit());
2029}
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00002030void EnqueueVisitor::VisitGotoStmt(GotoStmt *GS) {
2031 WL.push_back(LabelRefVisit(GS->getLabel(), GS->getLabelLoc(), Parent));
2032}
Ted Kremenek28a71942010-11-13 00:36:47 +00002033void EnqueueVisitor::VisitIfStmt(IfStmt *If) {
2034 AddStmt(If->getElse());
2035 AddStmt(If->getThen());
2036 AddStmt(If->getCond());
2037 AddDecl(If->getConditionVariable());
2038}
2039void EnqueueVisitor::VisitInitListExpr(InitListExpr *IE) {
2040 // We care about the syntactic form of the initializer list, only.
2041 if (InitListExpr *Syntactic = IE->getSyntacticForm())
2042 IE = Syntactic;
2043 EnqueueChildren(IE);
2044}
2045void EnqueueVisitor::VisitMemberExpr(MemberExpr *M) {
Douglas Gregor89629a72010-11-17 17:15:08 +00002046 WL.push_back(MemberExprParts(M, Parent));
2047
2048 // If the base of the member access expression is an implicit 'this', don't
2049 // visit it.
2050 // FIXME: If we ever want to show these implicit accesses, this will be
2051 // unfortunate. However, clang_getCursor() relies on this behavior.
Douglas Gregor75e85042011-03-02 21:06:53 +00002052 if (!M->isImplicitAccess())
2053 AddStmt(M->getBase());
Ted Kremenek28a71942010-11-13 00:36:47 +00002054}
Ted Kremenek73d15c42010-11-13 01:09:29 +00002055void EnqueueVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
2056 AddTypeLoc(E->getEncodedTypeSourceInfo());
2057}
Ted Kremenek28a71942010-11-13 00:36:47 +00002058void EnqueueVisitor::VisitObjCMessageExpr(ObjCMessageExpr *M) {
2059 EnqueueChildren(M);
2060 AddTypeLoc(M->getClassReceiverTypeInfo());
2061}
Ted Kremenekcdba6592010-11-18 00:42:18 +00002062void EnqueueVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
2063 // Visit the components of the offsetof expression.
2064 for (unsigned N = E->getNumComponents(), I = N; I > 0; --I) {
2065 typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
2066 const OffsetOfNode &Node = E->getComponent(I-1);
2067 switch (Node.getKind()) {
2068 case OffsetOfNode::Array:
2069 AddStmt(E->getIndexExpr(Node.getArrayExprIndex()));
2070 break;
2071 case OffsetOfNode::Field:
Abramo Bagnara06dec892011-03-12 09:45:03 +00002072 AddMemberRef(Node.getField(), Node.getSourceRange().getEnd());
Ted Kremenekcdba6592010-11-18 00:42:18 +00002073 break;
2074 case OffsetOfNode::Identifier:
2075 case OffsetOfNode::Base:
2076 continue;
2077 }
2078 }
2079 // Visit the type into which we're computing the offset.
2080 AddTypeLoc(E->getTypeSourceInfo());
2081}
Ted Kremenek28a71942010-11-13 00:36:47 +00002082void EnqueueVisitor::VisitOverloadExpr(OverloadExpr *E) {
Ted Kremenek60608ec2010-11-17 00:50:47 +00002083 AddExplicitTemplateArgs(E->getOptionalExplicitTemplateArgs());
Ted Kremenek60458782010-11-12 21:34:16 +00002084 WL.push_back(OverloadExprParts(E, Parent));
2085}
Peter Collingbournef4e3cfb2011-03-11 19:24:49 +00002086void EnqueueVisitor::VisitUnaryExprOrTypeTraitExpr(
2087 UnaryExprOrTypeTraitExpr *E) {
Ted Kremenek6d0a00d2010-11-17 02:18:35 +00002088 EnqueueChildren(E);
2089 if (E->isArgumentType())
2090 AddTypeLoc(E->getArgumentTypeInfo());
2091}
Ted Kremenek28a71942010-11-13 00:36:47 +00002092void EnqueueVisitor::VisitStmt(Stmt *S) {
2093 EnqueueChildren(S);
2094}
2095void EnqueueVisitor::VisitSwitchStmt(SwitchStmt *S) {
2096 AddStmt(S->getBody());
2097 AddStmt(S->getCond());
2098 AddDecl(S->getConditionVariable());
2099}
Ted Kremenekfafa75a2010-11-17 00:50:39 +00002100
Ted Kremenek28a71942010-11-13 00:36:47 +00002101void EnqueueVisitor::VisitWhileStmt(WhileStmt *W) {
2102 AddStmt(W->getBody());
2103 AddStmt(W->getCond());
2104 AddDecl(W->getConditionVariable());
2105}
John Wiegley21ff2e52011-04-28 00:16:57 +00002106
Ted Kremenek2939b6f2010-11-17 00:50:50 +00002107void EnqueueVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
2108 AddTypeLoc(E->getQueriedTypeSourceInfo());
2109}
Francois Pichet6ad6f282010-12-07 00:08:36 +00002110
2111void EnqueueVisitor::VisitBinaryTypeTraitExpr(BinaryTypeTraitExpr *E) {
Francois Pichet6ad6f282010-12-07 00:08:36 +00002112 AddTypeLoc(E->getRhsTypeSourceInfo());
Francois Pichet0a03a3f2010-12-08 09:11:05 +00002113 AddTypeLoc(E->getLhsTypeSourceInfo());
Francois Pichet6ad6f282010-12-07 00:08:36 +00002114}
2115
John Wiegley21ff2e52011-04-28 00:16:57 +00002116void EnqueueVisitor::VisitArrayTypeTraitExpr(ArrayTypeTraitExpr *E) {
2117 AddTypeLoc(E->getQueriedTypeSourceInfo());
2118}
2119
John Wiegley55262202011-04-25 06:54:41 +00002120void EnqueueVisitor::VisitExpressionTraitExpr(ExpressionTraitExpr *E) {
2121 EnqueueChildren(E);
2122}
2123
Ted Kremenek28a71942010-11-13 00:36:47 +00002124void EnqueueVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *U) {
2125 VisitOverloadExpr(U);
2126 if (!U->isImplicitAccess())
2127 AddStmt(U->getBase());
2128}
Ted Kremenek9d3bf792010-11-17 00:50:43 +00002129void EnqueueVisitor::VisitVAArgExpr(VAArgExpr *E) {
2130 AddStmt(E->getSubExpr());
2131 AddTypeLoc(E->getWrittenTypeInfo());
2132}
Douglas Gregor94d96292011-01-19 20:34:17 +00002133void EnqueueVisitor::VisitSizeOfPackExpr(SizeOfPackExpr *E) {
2134 WL.push_back(SizeOfPackExprParts(E, Parent));
2135}
Ted Kremenek60458782010-11-12 21:34:16 +00002136
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002137void CursorVisitor::EnqueueWorkList(VisitorWorkList &WL, Stmt *S) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00002138 EnqueueVisitor(WL, MakeCXCursor(S, StmtParent, TU,RegionOfInterest)).Visit(S);
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002139}
2140
2141bool CursorVisitor::IsInRegionOfInterest(CXCursor C) {
2142 if (RegionOfInterest.isValid()) {
2143 SourceRange Range = getRawCursorExtent(C);
2144 if (Range.isInvalid() || CompareRegionOfInterest(Range))
2145 return false;
2146 }
2147 return true;
2148}
2149
2150bool CursorVisitor::RunVisitorWorkList(VisitorWorkList &WL) {
2151 while (!WL.empty()) {
2152 // Dequeue the worklist item.
Ted Kremenek82f3c502010-11-15 22:23:26 +00002153 VisitorJob LI = WL.back();
2154 WL.pop_back();
2155
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002156 // Set the Parent field, then back to its old value once we're done.
2157 SetParentRAII SetParent(Parent, StmtParent, LI.getParent());
2158
2159 switch (LI.getKind()) {
Ted Kremenekf1107452010-11-12 18:26:56 +00002160 case VisitorJob::DeclVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002161 Decl *D = cast<DeclVisit>(&LI)->get();
Ted Kremenekf1107452010-11-12 18:26:56 +00002162 if (!D)
2163 continue;
2164
2165 // For now, perform default visitation for Decls.
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00002166 if (Visit(MakeCXCursor(D, TU, RegionOfInterest,
2167 cast<DeclVisit>(&LI)->isFirst())))
Ted Kremenekf1107452010-11-12 18:26:56 +00002168 return true;
2169
2170 continue;
2171 }
Ted Kremenek60608ec2010-11-17 00:50:47 +00002172 case VisitorJob::ExplicitTemplateArgsVisitKind: {
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00002173 const ASTTemplateArgumentListInfo *ArgList =
Ted Kremenek60608ec2010-11-17 00:50:47 +00002174 cast<ExplicitTemplateArgsVisit>(&LI)->get();
2175 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
2176 *ArgEnd = Arg + ArgList->NumTemplateArgs;
2177 Arg != ArgEnd; ++Arg) {
2178 if (VisitTemplateArgumentLoc(*Arg))
2179 return true;
2180 }
2181 continue;
2182 }
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00002183 case VisitorJob::TypeLocVisitKind: {
2184 // Perform default visitation for TypeLocs.
Ted Kremenek82f3c502010-11-15 22:23:26 +00002185 if (Visit(cast<TypeLocVisit>(&LI)->get()))
Ted Kremenekcdb4caf2010-11-12 21:34:12 +00002186 return true;
2187 continue;
2188 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00002189 case VisitorJob::LabelRefVisitKind: {
Chris Lattnerad8dcf42011-02-17 07:39:24 +00002190 LabelDecl *LS = cast<LabelRefVisit>(&LI)->get();
Ted Kremeneke7455012011-02-23 04:54:51 +00002191 if (LabelStmt *stmt = LS->getStmt()) {
2192 if (Visit(MakeCursorLabelRef(stmt, cast<LabelRefVisit>(&LI)->getLoc(),
2193 TU))) {
2194 return true;
2195 }
2196 }
Ted Kremenekae1fd6f2010-11-17 00:50:45 +00002197 continue;
2198 }
Ted Kremenek47695c82011-08-18 22:25:21 +00002199
Douglas Gregorf3db29f2011-02-25 18:19:59 +00002200 case VisitorJob::NestedNameSpecifierLocVisitKind: {
2201 NestedNameSpecifierLocVisit *V = cast<NestedNameSpecifierLocVisit>(&LI);
2202 if (VisitNestedNameSpecifierLoc(V->get()))
2203 return true;
2204 continue;
2205 }
2206
Ted Kremenekf64d8032010-11-18 00:02:32 +00002207 case VisitorJob::DeclarationNameInfoVisitKind: {
2208 if (VisitDeclarationNameInfo(cast<DeclarationNameInfoVisit>(&LI)
2209 ->get()))
2210 return true;
2211 continue;
2212 }
Ted Kremenekcdba6592010-11-18 00:42:18 +00002213 case VisitorJob::MemberRefVisitKind: {
2214 MemberRefVisit *V = cast<MemberRefVisit>(&LI);
2215 if (Visit(MakeCursorMemberRef(V->get(), V->getLoc(), TU)))
2216 return true;
2217 continue;
2218 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002219 case VisitorJob::StmtVisitKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002220 Stmt *S = cast<StmtVisit>(&LI)->get();
Ted Kremenek8c269ac2010-11-11 23:11:43 +00002221 if (!S)
2222 continue;
2223
Ted Kremenekf1107452010-11-12 18:26:56 +00002224 // Update the current cursor.
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00002225 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU, RegionOfInterest);
Ted Kremenekcdba6592010-11-18 00:42:18 +00002226 if (!IsInRegionOfInterest(Cursor))
2227 continue;
2228 switch (Visitor(Cursor, Parent, ClientData)) {
2229 case CXChildVisit_Break: return true;
2230 case CXChildVisit_Continue: break;
2231 case CXChildVisit_Recurse:
2232 EnqueueWorkList(WL, S);
Ted Kremenek82f3c502010-11-15 22:23:26 +00002233 break;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002234 }
Ted Kremenek82f3c502010-11-15 22:23:26 +00002235 continue;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002236 }
2237 case VisitorJob::MemberExprPartsKind: {
2238 // Handle the other pieces in the MemberExpr besides the base.
Ted Kremenek82f3c502010-11-15 22:23:26 +00002239 MemberExpr *M = cast<MemberExprParts>(&LI)->get();
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002240
2241 // Visit the nested-name-specifier
Douglas Gregor40d96a62011-02-28 21:54:11 +00002242 if (NestedNameSpecifierLoc QualifierLoc = M->getQualifierLoc())
2243 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002244 return true;
2245
2246 // Visit the declaration name.
2247 if (VisitDeclarationNameInfo(M->getMemberNameInfo()))
2248 return true;
2249
2250 // Visit the explicitly-specified template arguments, if any.
2251 if (M->hasExplicitTemplateArgs()) {
2252 for (const TemplateArgumentLoc *Arg = M->getTemplateArgs(),
2253 *ArgEnd = Arg + M->getNumTemplateArgs();
2254 Arg != ArgEnd; ++Arg) {
2255 if (VisitTemplateArgumentLoc(*Arg))
2256 return true;
2257 }
2258 }
2259 continue;
2260 }
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002261 case VisitorJob::DeclRefExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002262 DeclRefExpr *DR = cast<DeclRefExprParts>(&LI)->get();
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002263 // Visit nested-name-specifier, if present.
Douglas Gregor40d96a62011-02-28 21:54:11 +00002264 if (NestedNameSpecifierLoc QualifierLoc = DR->getQualifierLoc())
2265 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002266 return true;
2267 // Visit declaration name.
2268 if (VisitDeclarationNameInfo(DR->getNameInfo()))
2269 return true;
Ted Kremeneke4979cc2010-11-13 00:58:18 +00002270 continue;
2271 }
Ted Kremenek60458782010-11-12 21:34:16 +00002272 case VisitorJob::OverloadExprPartsKind: {
Ted Kremenek82f3c502010-11-15 22:23:26 +00002273 OverloadExpr *O = cast<OverloadExprParts>(&LI)->get();
Ted Kremenek60458782010-11-12 21:34:16 +00002274 // Visit the nested-name-specifier.
Douglas Gregor4c9be892011-02-28 20:01:57 +00002275 if (NestedNameSpecifierLoc QualifierLoc = O->getQualifierLoc())
2276 if (VisitNestedNameSpecifierLoc(QualifierLoc))
Ted Kremenek60458782010-11-12 21:34:16 +00002277 return true;
2278 // Visit the declaration name.
2279 if (VisitDeclarationNameInfo(O->getNameInfo()))
2280 return true;
2281 // Visit the overloaded declaration reference.
2282 if (Visit(MakeCursorOverloadedDeclRef(O, TU)))
2283 return true;
Ted Kremenek60458782010-11-12 21:34:16 +00002284 continue;
2285 }
Douglas Gregor94d96292011-01-19 20:34:17 +00002286 case VisitorJob::SizeOfPackExprPartsKind: {
2287 SizeOfPackExpr *E = cast<SizeOfPackExprParts>(&LI)->get();
2288 NamedDecl *Pack = E->getPack();
2289 if (isa<TemplateTypeParmDecl>(Pack)) {
2290 if (Visit(MakeCursorTypeRef(cast<TemplateTypeParmDecl>(Pack),
2291 E->getPackLoc(), TU)))
2292 return true;
2293
2294 continue;
2295 }
2296
2297 if (isa<TemplateTemplateParmDecl>(Pack)) {
2298 if (Visit(MakeCursorTemplateRef(cast<TemplateTemplateParmDecl>(Pack),
2299 E->getPackLoc(), TU)))
2300 return true;
2301
2302 continue;
2303 }
2304
2305 // Non-type template parameter packs and function parameter packs are
2306 // treated like DeclRefExpr cursors.
2307 continue;
2308 }
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002309 }
2310 }
2311 return false;
2312}
2313
Ted Kremenekcdba6592010-11-18 00:42:18 +00002314bool CursorVisitor::Visit(Stmt *S) {
Ted Kremenekd1ded662010-11-15 23:31:32 +00002315 VisitorWorkList *WL = 0;
2316 if (!WorkListFreeList.empty()) {
2317 WL = WorkListFreeList.back();
2318 WL->clear();
2319 WorkListFreeList.pop_back();
2320 }
2321 else {
2322 WL = new VisitorWorkList();
2323 WorkListCache.push_back(WL);
2324 }
2325 EnqueueWorkList(*WL, S);
2326 bool result = RunVisitorWorkList(*WL);
2327 WorkListFreeList.push_back(WL);
2328 return result;
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002329}
2330
Francois Pichet48a8d142011-07-25 22:00:44 +00002331namespace {
2332typedef llvm::SmallVector<SourceRange, 4> RefNamePieces;
2333RefNamePieces buildPieces(unsigned NameFlags, bool IsMemberRefExpr,
2334 const DeclarationNameInfo &NI,
2335 const SourceRange &QLoc,
Argyrios Kyrtzidisb0c3e092011-09-22 20:07:03 +00002336 const ASTTemplateArgumentListInfo *TemplateArgs = 0){
Francois Pichet48a8d142011-07-25 22:00:44 +00002337 const bool WantQualifier = NameFlags & CXNameRange_WantQualifier;
2338 const bool WantTemplateArgs = NameFlags & CXNameRange_WantTemplateArgs;
2339 const bool WantSinglePiece = NameFlags & CXNameRange_WantSinglePiece;
2340
2341 const DeclarationName::NameKind Kind = NI.getName().getNameKind();
2342
2343 RefNamePieces Pieces;
2344
2345 if (WantQualifier && QLoc.isValid())
2346 Pieces.push_back(QLoc);
2347
2348 if (Kind != DeclarationName::CXXOperatorName || IsMemberRefExpr)
2349 Pieces.push_back(NI.getLoc());
2350
2351 if (WantTemplateArgs && TemplateArgs)
2352 Pieces.push_back(SourceRange(TemplateArgs->LAngleLoc,
2353 TemplateArgs->RAngleLoc));
2354
2355 if (Kind == DeclarationName::CXXOperatorName) {
2356 Pieces.push_back(SourceLocation::getFromRawEncoding(
2357 NI.getInfo().CXXOperatorName.BeginOpNameLoc));
2358 Pieces.push_back(SourceLocation::getFromRawEncoding(
2359 NI.getInfo().CXXOperatorName.EndOpNameLoc));
2360 }
2361
2362 if (WantSinglePiece) {
2363 SourceRange R(Pieces.front().getBegin(), Pieces.back().getEnd());
2364 Pieces.clear();
2365 Pieces.push_back(R);
2366 }
2367
2368 return Pieces;
2369}
2370}
2371
Ted Kremenekc0e1d922010-11-11 08:05:18 +00002372//===----------------------------------------------------------------------===//
2373// Misc. API hooks.
2374//===----------------------------------------------------------------------===//
2375
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002376static llvm::sys::Mutex EnableMultithreadingMutex;
2377static bool EnabledMultithreading;
2378
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00002379extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002380CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
2381 int displayDiagnostics) {
Daniel Dunbar48615ff2010-10-08 19:30:33 +00002382 // Disable pretty stack trace functionality, which will otherwise be a very
2383 // poor citizen of the world and set up all sorts of signal handlers.
2384 llvm::DisablePrettyStackTrace = true;
2385
Daniel Dunbarc7df4f32010-08-18 18:43:14 +00002386 // We use crash recovery to make some of our APIs more reliable, implicitly
2387 // enable it.
2388 llvm::CrashRecoveryContext::Enable();
2389
Douglas Gregor8c8d5412010-09-24 21:18:36 +00002390 // Enable support for multithreading in LLVM.
2391 {
2392 llvm::sys::ScopedLock L(EnableMultithreadingMutex);
2393 if (!EnabledMultithreading) {
2394 llvm::llvm_start_multithreaded();
2395 EnabledMultithreading = true;
2396 }
2397 }
2398
Douglas Gregora030b7c2010-01-22 20:35:53 +00002399 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002400 if (excludeDeclarationsFromPCH)
2401 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002402 if (displayDiagnostics)
2403 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002404 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00002405}
2406
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002407void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002408 if (CIdx)
2409 delete static_cast<CIndexer *>(CIdx);
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002410}
2411
Ted Kremenekd2427dd2011-03-18 23:05:39 +00002412void clang_toggleCrashRecovery(unsigned isEnabled) {
2413 if (isEnabled)
2414 llvm::CrashRecoveryContext::Enable();
2415 else
2416 llvm::CrashRecoveryContext::Disable();
2417}
2418
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002419CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00002420 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002421 if (!CIdx)
2422 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002423
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00002424 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00002425 FileSystemOptions FileSystemOpts;
2426 FileSystemOpts.WorkingDir = CXXIdx->getWorkingDirectory();
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002427
David Blaikied6471f72011-09-25 23:23:43 +00002428 llvm::IntrusiveRefCntPtr<DiagnosticsEngine> Diags;
Ted Kremeneka60ed472010-11-16 08:15:36 +00002429 ASTUnit *TU = ASTUnit::LoadFromASTFile(ast_filename, Diags, FileSystemOpts,
Douglas Gregora88084b2010-02-18 18:08:43 +00002430 CXXIdx->getOnlyLocalDecls(),
2431 0, 0, true);
Ted Kremeneka60ed472010-11-16 08:15:36 +00002432 return MakeCXTranslationUnit(TU);
Steve Naroff600866c2009-08-27 19:51:58 +00002433}
2434
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002435unsigned clang_defaultEditingTranslationUnitOptions() {
Douglas Gregor2a2c50b2010-09-27 05:49:58 +00002436 return CXTranslationUnit_PrecompiledPreamble |
Douglas Gregorb5af8432011-08-25 22:54:01 +00002437 CXTranslationUnit_CacheCompletionResults;
Douglas Gregorb1c031b2010-08-09 22:28:58 +00002438}
2439
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002440CXTranslationUnit
2441clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
2442 const char *source_filename,
2443 int num_command_line_args,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002444 const char * const *command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00002445 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00002446 struct CXUnsavedFile *unsaved_files) {
Douglas Gregordca8ee82011-05-06 16:33:08 +00002447 unsigned Options = CXTranslationUnit_DetailedPreprocessingRecord |
Chandler Carruthba7537f2011-07-14 09:02:10 +00002448 CXTranslationUnit_NestedMacroExpansions;
Douglas Gregor5a430212010-07-21 18:52:53 +00002449 return clang_parseTranslationUnit(CIdx, source_filename,
2450 command_line_args, num_command_line_args,
2451 unsaved_files, num_unsaved_files,
Douglas Gregordca8ee82011-05-06 16:33:08 +00002452 Options);
Douglas Gregor5a430212010-07-21 18:52:53 +00002453}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002454
2455struct ParseTranslationUnitInfo {
2456 CXIndex CIdx;
2457 const char *source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002458 const char *const *command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002459 int num_command_line_args;
2460 struct CXUnsavedFile *unsaved_files;
2461 unsigned num_unsaved_files;
2462 unsigned options;
2463 CXTranslationUnit result;
2464};
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002465static void clang_parseTranslationUnit_Impl(void *UserData) {
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002466 ParseTranslationUnitInfo *PTUI =
2467 static_cast<ParseTranslationUnitInfo*>(UserData);
2468 CXIndex CIdx = PTUI->CIdx;
2469 const char *source_filename = PTUI->source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00002470 const char * const *command_line_args = PTUI->command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002471 int num_command_line_args = PTUI->num_command_line_args;
2472 struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
2473 unsigned num_unsaved_files = PTUI->num_unsaved_files;
2474 unsigned options = PTUI->options;
2475 PTUI->result = 0;
Douglas Gregor5a430212010-07-21 18:52:53 +00002476
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002477 if (!CIdx)
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002478 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002479
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002480 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
2481
Douglas Gregor44c181a2010-07-23 00:33:23 +00002482 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Douglas Gregor467dc882011-08-25 22:30:56 +00002483 // FIXME: Add a flag for modules.
2484 TranslationUnitKind TUKind
2485 = (options & CXTranslationUnit_Incomplete)? TU_Prefix : TU_Complete;
Douglas Gregor87c08a52010-08-13 22:48:40 +00002486 bool CacheCodeCompetionResults
2487 = options & CXTranslationUnit_CacheCompletionResults;
2488
Douglas Gregor5352ac02010-01-28 00:27:43 +00002489 // Configure the diagnostics.
2490 DiagnosticOptions DiagOpts;
David Blaikied6471f72011-09-25 23:23:43 +00002491 llvm::IntrusiveRefCntPtr<DiagnosticsEngine>
Ted Kremenek25a11e12011-03-22 01:15:24 +00002492 Diags(CompilerInstance::createDiagnostics(DiagOpts, num_command_line_args,
2493 command_line_args));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002494
Ted Kremenek25a11e12011-03-22 01:15:24 +00002495 // Recover resources if we crash before exiting this function.
David Blaikied6471f72011-09-25 23:23:43 +00002496 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
2497 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Ted Kremenek25a11e12011-03-22 01:15:24 +00002498 DiagCleanup(Diags.getPtr());
2499
2500 llvm::OwningPtr<std::vector<ASTUnit::RemappedFile> >
2501 RemappedFiles(new std::vector<ASTUnit::RemappedFile>());
2502
2503 // Recover resources if we crash before exiting this function.
2504 llvm::CrashRecoveryContextCleanupRegistrar<
2505 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
2506
Douglas Gregor4db64a42010-01-23 00:14:00 +00002507 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00002508 StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002509 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00002510 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Ted Kremenek25a11e12011-03-22 01:15:24 +00002511 RemappedFiles->push_back(std::make_pair(unsaved_files[I].Filename,
2512 Buffer));
Douglas Gregor4db64a42010-01-23 00:14:00 +00002513 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002514
Ted Kremenek25a11e12011-03-22 01:15:24 +00002515 llvm::OwningPtr<std::vector<const char *> >
2516 Args(new std::vector<const char*>());
2517
2518 // Recover resources if we crash before exiting this method.
2519 llvm::CrashRecoveryContextCleanupRegistrar<std::vector<const char*> >
2520 ArgsCleanup(Args.get());
2521
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002522 // Since the Clang C library is primarily used by batch tools dealing with
2523 // (often very broken) source code, where spell-checking can have a
2524 // significant negative impact on performance (particularly when
2525 // precompiled headers are involved), we disable it by default.
Douglas Gregorb10daed2010-10-11 16:52:23 +00002526 // Only do this if we haven't found a spell-checking-related argument.
2527 bool FoundSpellCheckingArgument = false;
2528 for (int I = 0; I != num_command_line_args; ++I) {
2529 if (strcmp(command_line_args[I], "-fno-spell-checking") == 0 ||
2530 strcmp(command_line_args[I], "-fspell-checking") == 0) {
2531 FoundSpellCheckingArgument = true;
2532 break;
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002533 }
Douglas Gregorb10daed2010-10-11 16:52:23 +00002534 }
2535 if (!FoundSpellCheckingArgument)
Ted Kremenek25a11e12011-03-22 01:15:24 +00002536 Args->push_back("-fno-spell-checking");
Douglas Gregorb10daed2010-10-11 16:52:23 +00002537
Ted Kremenek25a11e12011-03-22 01:15:24 +00002538 Args->insert(Args->end(), command_line_args,
2539 command_line_args + num_command_line_args);
Douglas Gregord93256e2010-01-28 06:00:51 +00002540
Argyrios Kyrtzidisc8429552011-03-20 18:17:52 +00002541 // The 'source_filename' argument is optional. If the caller does not
2542 // specify it then it is assumed that the source file is specified
2543 // in the actual argument list.
2544 // Put the source file after command_line_args otherwise if '-x' flag is
2545 // present it will be unused.
2546 if (source_filename)
Ted Kremenek25a11e12011-03-22 01:15:24 +00002547 Args->push_back(source_filename);
Argyrios Kyrtzidisc8429552011-03-20 18:17:52 +00002548
Douglas Gregor44c181a2010-07-23 00:33:23 +00002549 // Do we need the detailed preprocessing record?
Chandler Carruthba7537f2011-07-14 09:02:10 +00002550 bool NestedMacroExpansions = false;
Douglas Gregor44c181a2010-07-23 00:33:23 +00002551 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
Ted Kremenek25a11e12011-03-22 01:15:24 +00002552 Args->push_back("-Xclang");
2553 Args->push_back("-detailed-preprocessing-record");
Chandler Carruthba7537f2011-07-14 09:02:10 +00002554 NestedMacroExpansions
2555 = (options & CXTranslationUnit_NestedMacroExpansions);
Douglas Gregor44c181a2010-07-23 00:33:23 +00002556 }
2557
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002558 unsigned NumErrors = Diags->getClient()->getNumErrors();
Douglas Gregorb10daed2010-10-11 16:52:23 +00002559 llvm::OwningPtr<ASTUnit> Unit(
Ted Kremenek4ee99262011-03-22 20:16:19 +00002560 ASTUnit::LoadFromCommandLine(Args->size() ? &(*Args)[0] : 0
2561 /* vector::data() not portable */,
2562 Args->size() ? (&(*Args)[0] + Args->size()) :0,
Douglas Gregorb10daed2010-10-11 16:52:23 +00002563 Diags,
2564 CXXIdx->getClangResourcesPath(),
2565 CXXIdx->getOnlyLocalDecls(),
Douglas Gregore47be3e2010-11-11 00:39:14 +00002566 /*CaptureDiagnostics=*/true,
Ted Kremenek4ee99262011-03-22 20:16:19 +00002567 RemappedFiles->size() ? &(*RemappedFiles)[0]:0,
Ted Kremenek25a11e12011-03-22 01:15:24 +00002568 RemappedFiles->size(),
Argyrios Kyrtzidis299a4a92011-03-08 23:35:24 +00002569 /*RemappedFilesKeepOriginalName=*/true,
Douglas Gregorb10daed2010-10-11 16:52:23 +00002570 PrecompilePreamble,
Douglas Gregor467dc882011-08-25 22:30:56 +00002571 TUKind,
Douglas Gregor99ba2022010-10-27 17:24:53 +00002572 CacheCodeCompetionResults,
Chandler Carruthba7537f2011-07-14 09:02:10 +00002573 NestedMacroExpansions));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002574
Argyrios Kyrtzidis026f6912010-11-18 21:47:04 +00002575 if (NumErrors != Diags->getClient()->getNumErrors()) {
Douglas Gregorb10daed2010-10-11 16:52:23 +00002576 // Make sure to check that 'Unit' is non-NULL.
2577 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
2578 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2579 DEnd = Unit->stored_diag_end();
2580 D != DEnd; ++D) {
2581 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
2582 CXString Msg = clang_formatDiagnostic(&Diag,
2583 clang_defaultDiagnosticDisplayOptions());
2584 fprintf(stderr, "%s\n", clang_getCString(Msg));
2585 clang_disposeString(Msg);
2586 }
Douglas Gregor274f1902010-02-22 23:17:23 +00002587#ifdef LLVM_ON_WIN32
Douglas Gregorb10daed2010-10-11 16:52:23 +00002588 // On Windows, force a flush, since there may be multiple copies of
2589 // stderr and stdout in the file system, all with different buffers
2590 // but writing to the same device.
2591 fflush(stderr);
2592#endif
2593 }
Douglas Gregora88084b2010-02-18 18:08:43 +00002594 }
Douglas Gregord93256e2010-01-28 06:00:51 +00002595
Ted Kremeneka60ed472010-11-16 08:15:36 +00002596 PTUI->result = MakeCXTranslationUnit(Unit.take());
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002597}
2598CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2599 const char *source_filename,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002600 const char * const *command_line_args,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002601 int num_command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002602 struct CXUnsavedFile *unsaved_files,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002603 unsigned num_unsaved_files,
2604 unsigned options) {
2605 ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00002606 num_command_line_args, unsaved_files,
2607 num_unsaved_files, options, 0 };
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002608 llvm::CrashRecoveryContext CRC;
2609
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002610 if (!RunSafely(CRC, clang_parseTranslationUnit_Impl, &PTUI)) {
Daniel Dunbar60a45432010-08-23 22:35:34 +00002611 fprintf(stderr, "libclang: crash detected during parsing: {\n");
2612 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
2613 fprintf(stderr, " 'command_line_args' : [");
2614 for (int i = 0; i != num_command_line_args; ++i) {
2615 if (i)
2616 fprintf(stderr, ", ");
2617 fprintf(stderr, "'%s'", command_line_args[i]);
2618 }
2619 fprintf(stderr, "],\n");
2620 fprintf(stderr, " 'unsaved_files' : [");
2621 for (unsigned i = 0; i != num_unsaved_files; ++i) {
2622 if (i)
2623 fprintf(stderr, ", ");
2624 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2625 unsaved_files[i].Length);
2626 }
2627 fprintf(stderr, "],\n");
2628 fprintf(stderr, " 'options' : %d,\n", options);
2629 fprintf(stderr, "}\n");
2630
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002631 return 0;
Douglas Gregor6df78732011-05-05 20:27:22 +00002632 } else if (getenv("LIBCLANG_RESOURCE_USAGE")) {
2633 PrintLibclangResourceUsage(PTUI.result);
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002634 }
Douglas Gregor6df78732011-05-05 20:27:22 +00002635
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002636 return PTUI.result;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00002637}
2638
Douglas Gregor19998442010-08-13 15:35:05 +00002639unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2640 return CXSaveTranslationUnit_None;
2641}
2642
2643int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2644 unsigned options) {
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002645 if (!TU)
Douglas Gregor39c411f2011-07-06 16:43:36 +00002646 return CXSaveError_InvalidTU;
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002647
Douglas Gregor39c411f2011-07-06 16:43:36 +00002648 CXSaveError result = static_cast<ASTUnit *>(TU->TUData)->Save(FileName);
Douglas Gregor6df78732011-05-05 20:27:22 +00002649 if (getenv("LIBCLANG_RESOURCE_USAGE"))
2650 PrintLibclangResourceUsage(TU);
2651 return result;
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002652}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002653
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002654void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002655 if (CTUnit) {
2656 // If the translation unit has been marked as unsafe to free, just discard
2657 // it.
Ted Kremeneka60ed472010-11-16 08:15:36 +00002658 if (static_cast<ASTUnit *>(CTUnit->TUData)->isUnsafeToFree())
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002659 return;
2660
Ted Kremeneka60ed472010-11-16 08:15:36 +00002661 delete static_cast<ASTUnit *>(CTUnit->TUData);
2662 disposeCXStringPool(CTUnit->StringPool);
2663 delete CTUnit;
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002664 }
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002665}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002666
Douglas Gregore1e13bf2010-08-11 15:58:42 +00002667unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2668 return CXReparse_None;
2669}
2670
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002671struct ReparseTranslationUnitInfo {
2672 CXTranslationUnit TU;
2673 unsigned num_unsaved_files;
2674 struct CXUnsavedFile *unsaved_files;
2675 unsigned options;
2676 int result;
2677};
Douglas Gregor593b0c12010-09-23 18:47:53 +00002678
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002679static void clang_reparseTranslationUnit_Impl(void *UserData) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002680 ReparseTranslationUnitInfo *RTUI =
2681 static_cast<ReparseTranslationUnitInfo*>(UserData);
2682 CXTranslationUnit TU = RTUI->TU;
2683 unsigned num_unsaved_files = RTUI->num_unsaved_files;
2684 struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2685 unsigned options = RTUI->options;
2686 (void) options;
2687 RTUI->result = 1;
2688
Douglas Gregorabc563f2010-07-19 21:46:24 +00002689 if (!TU)
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002690 return;
Douglas Gregor593b0c12010-09-23 18:47:53 +00002691
Ted Kremeneka60ed472010-11-16 08:15:36 +00002692 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor593b0c12010-09-23 18:47:53 +00002693 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002694
Ted Kremenek25a11e12011-03-22 01:15:24 +00002695 llvm::OwningPtr<std::vector<ASTUnit::RemappedFile> >
2696 RemappedFiles(new std::vector<ASTUnit::RemappedFile>());
2697
2698 // Recover resources if we crash before exiting this function.
2699 llvm::CrashRecoveryContextCleanupRegistrar<
2700 std::vector<ASTUnit::RemappedFile> > RemappedCleanup(RemappedFiles.get());
2701
Douglas Gregorabc563f2010-07-19 21:46:24 +00002702 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00002703 StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002704 const llvm::MemoryBuffer *Buffer
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002705 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Ted Kremenek25a11e12011-03-22 01:15:24 +00002706 RemappedFiles->push_back(std::make_pair(unsaved_files[I].Filename,
2707 Buffer));
Douglas Gregorabc563f2010-07-19 21:46:24 +00002708 }
2709
Ted Kremenek4ee99262011-03-22 20:16:19 +00002710 if (!CXXUnit->Reparse(RemappedFiles->size() ? &(*RemappedFiles)[0] : 0,
2711 RemappedFiles->size()))
Douglas Gregor593b0c12010-09-23 18:47:53 +00002712 RTUI->result = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002713}
Douglas Gregor593b0c12010-09-23 18:47:53 +00002714
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002715int clang_reparseTranslationUnit(CXTranslationUnit TU,
2716 unsigned num_unsaved_files,
2717 struct CXUnsavedFile *unsaved_files,
2718 unsigned options) {
2719 ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2720 options, 0 };
2721 llvm::CrashRecoveryContext CRC;
2722
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00002723 if (!RunSafely(CRC, clang_reparseTranslationUnit_Impl, &RTUI)) {
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002724 fprintf(stderr, "libclang: crash detected during reparsing\n");
Ted Kremeneka60ed472010-11-16 08:15:36 +00002725 static_cast<ASTUnit *>(TU->TUData)->setUnsafeToFree(true);
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002726 return 1;
Douglas Gregor6df78732011-05-05 20:27:22 +00002727 } else if (getenv("LIBCLANG_RESOURCE_USAGE"))
2728 PrintLibclangResourceUsage(TU);
Ted Kremenek1dfb26a2010-10-29 01:06:50 +00002729
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002730 return RTUI.result;
2731}
2732
Douglas Gregordf95a132010-08-09 20:45:32 +00002733
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002734CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002735 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002736 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002737
Ted Kremeneka60ed472010-11-16 08:15:36 +00002738 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit->TUData);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002739 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00002740}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00002741
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002742CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00002743 CXCursor Result = { CXCursor_TranslationUnit, 0, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002744 return Result;
2745}
2746
Ted Kremenekfb480492010-01-13 21:46:36 +00002747} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00002748
Ted Kremenekfb480492010-01-13 21:46:36 +00002749//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00002750// CXSourceLocation and CXSourceRange Operations.
2751//===----------------------------------------------------------------------===//
2752
Douglas Gregorb9790342010-01-22 21:44:22 +00002753extern "C" {
2754CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00002755 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00002756 return Result;
2757}
2758
2759unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00002760 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2761 loc1.ptr_data[1] == loc2.ptr_data[1] &&
2762 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00002763}
2764
2765CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2766 CXFile file,
2767 unsigned line,
2768 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00002769 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00002770 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00002771
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00002772 bool Logging = ::getenv("LIBCLANG_LOGGING");
Ted Kremeneka60ed472010-11-16 08:15:36 +00002773 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Argyrios Kyrtzidis57165be2011-10-10 21:57:15 +00002774 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00002775 const FileEntry *File = static_cast<const FileEntry *>(file);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002776 SourceLocation SLoc = CXXUnit->getLocation(File, line, column);
Douglas Gregor86a4d0d2011-02-03 17:17:35 +00002777 if (SLoc.isInvalid()) {
2778 if (Logging)
2779 llvm::errs() << "clang_getLocation(\"" << File->getName()
2780 << "\", " << line << ", " << column << ") = invalid\n";
2781 return clang_getNullLocation();
2782 }
2783
2784 if (Logging)
2785 llvm::errs() << "clang_getLocation(\"" << File->getName()
2786 << "\", " << line << ", " << column << ") = "
2787 << SLoc.getRawEncoding() << "\n";
David Chisnall83889a72010-10-15 17:07:39 +00002788
2789 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
2790}
2791
2792CXSourceLocation clang_getLocationForOffset(CXTranslationUnit tu,
2793 CXFile file,
2794 unsigned offset) {
2795 if (!tu || !file)
2796 return clang_getNullLocation();
2797
Ted Kremeneka60ed472010-11-16 08:15:36 +00002798 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002799 SourceLocation SLoc
2800 = CXXUnit->getLocation(static_cast<const FileEntry *>(file), offset);
David Chisnall83889a72010-10-15 17:07:39 +00002801 if (SLoc.isInvalid()) return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002802
Ted Kremenek1a9a0bc2010-06-28 23:54:17 +00002803 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00002804}
2805
Douglas Gregor5352ac02010-01-28 00:27:43 +00002806CXSourceRange clang_getNullRange() {
2807 CXSourceRange Result = { { 0, 0 }, 0, 0 };
2808 return Result;
2809}
Daniel Dunbard52864b2010-02-14 10:02:57 +00002810
Douglas Gregor5352ac02010-01-28 00:27:43 +00002811CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2812 if (begin.ptr_data[0] != end.ptr_data[0] ||
2813 begin.ptr_data[1] != end.ptr_data[1])
2814 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002815
2816 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002817 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00002818 return Result;
2819}
Douglas Gregorab4e83b2011-07-23 19:35:14 +00002820
2821unsigned clang_equalRanges(CXSourceRange range1, CXSourceRange range2)
2822{
2823 return range1.ptr_data[0] == range2.ptr_data[0]
2824 && range1.ptr_data[1] == range2.ptr_data[1]
2825 && range1.begin_int_data == range2.begin_int_data
2826 && range1.end_int_data == range2.end_int_data;
2827}
Argyrios Kyrtzidisde5db642011-09-28 18:14:21 +00002828
2829int clang_Range_isNull(CXSourceRange range) {
2830 return clang_equalRanges(range, clang_getNullRange());
2831}
2832
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002833} // end: extern "C"
Douglas Gregorb9790342010-01-22 21:44:22 +00002834
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002835static void createNullLocation(CXFile *file, unsigned *line,
2836 unsigned *column, unsigned *offset) {
2837 if (file)
2838 *file = 0;
2839 if (line)
2840 *line = 0;
2841 if (column)
2842 *column = 0;
2843 if (offset)
2844 *offset = 0;
2845 return;
2846}
2847
2848extern "C" {
Chandler Carruth20174222011-08-31 16:53:37 +00002849void clang_getExpansionLocation(CXSourceLocation location,
2850 CXFile *file,
2851 unsigned *line,
2852 unsigned *column,
2853 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00002854 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2855
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002856 if (!location.ptr_data[0] || Loc.isInvalid()) {
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002857 createNullLocation(file, line, column, offset);
Douglas Gregor46766dc2010-01-26 19:19:08 +00002858 return;
2859 }
2860
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002861 const SourceManager &SM =
2862 *static_cast<const SourceManager*>(location.ptr_data[0]);
Chandler Carruth20174222011-08-31 16:53:37 +00002863 SourceLocation ExpansionLoc = SM.getExpansionLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002864
Chandler Carruthcea731a2011-07-14 16:07:57 +00002865 // Check that the FileID is invalid on the expansion location.
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002866 // This can manifest in invalid code.
Chandler Carruth20174222011-08-31 16:53:37 +00002867 FileID fileID = SM.getFileID(ExpansionLoc);
Douglas Gregore23ac652011-04-20 00:21:03 +00002868 bool Invalid = false;
2869 const SrcMgr::SLocEntry &sloc = SM.getSLocEntry(fileID, &Invalid);
Argyrios Kyrtzidisc705d252011-10-18 21:59:54 +00002870 if (Invalid || !sloc.isFile()) {
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002871 createNullLocation(file, line, column, offset);
2872 return;
2873 }
2874
Douglas Gregor1db19de2010-01-19 21:36:55 +00002875 if (file)
Ted Kremenek9d5a1652011-03-23 02:16:44 +00002876 *file = (void *)SM.getFileEntryForSLocEntry(sloc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002877 if (line)
Chandler Carruth20174222011-08-31 16:53:37 +00002878 *line = SM.getExpansionLineNumber(ExpansionLoc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002879 if (column)
Chandler Carruth20174222011-08-31 16:53:37 +00002880 *column = SM.getExpansionColumnNumber(ExpansionLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00002881 if (offset)
Chandler Carruth20174222011-08-31 16:53:37 +00002882 *offset = SM.getDecomposedLoc(ExpansionLoc).second;
2883}
2884
Argyrios Kyrtzidise6be34d2011-09-13 21:49:08 +00002885void clang_getPresumedLocation(CXSourceLocation location,
2886 CXString *filename,
2887 unsigned *line,
2888 unsigned *column) {
2889 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2890
2891 if (!location.ptr_data[0] || Loc.isInvalid()) {
2892 if (filename)
2893 *filename = createCXString("");
2894 if (line)
2895 *line = 0;
2896 if (column)
2897 *column = 0;
2898 }
2899 else {
2900 const SourceManager &SM =
2901 *static_cast<const SourceManager*>(location.ptr_data[0]);
2902 PresumedLoc PreLoc = SM.getPresumedLoc(Loc);
2903
2904 if (filename)
2905 *filename = createCXString(PreLoc.getFilename());
2906 if (line)
2907 *line = PreLoc.getLine();
2908 if (column)
2909 *column = PreLoc.getColumn();
2910 }
2911}
2912
Chandler Carruth20174222011-08-31 16:53:37 +00002913void clang_getInstantiationLocation(CXSourceLocation location,
2914 CXFile *file,
2915 unsigned *line,
2916 unsigned *column,
2917 unsigned *offset) {
2918 // Redirect to new API.
2919 clang_getExpansionLocation(location, file, line, column, offset);
Douglas Gregore69517c2010-01-26 03:07:15 +00002920}
2921
Douglas Gregora9b06d42010-11-09 06:24:54 +00002922void clang_getSpellingLocation(CXSourceLocation location,
2923 CXFile *file,
2924 unsigned *line,
2925 unsigned *column,
2926 unsigned *offset) {
2927 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2928
Argyrios Kyrtzidis5adc0512011-05-17 22:09:53 +00002929 if (!location.ptr_data[0] || Loc.isInvalid())
2930 return createNullLocation(file, line, column, offset);
Douglas Gregora9b06d42010-11-09 06:24:54 +00002931
2932 const SourceManager &SM =
2933 *static_cast<const SourceManager*>(location.ptr_data[0]);
2934 SourceLocation SpellLoc = Loc;
2935 if (SpellLoc.isMacroID()) {
2936 SourceLocation SimpleSpellingLoc = SM.getImmediateSpellingLoc(SpellLoc);
2937 if (SimpleSpellingLoc.isFileID() &&
2938 SM.getFileEntryForID(SM.getDecomposedLoc(SimpleSpellingLoc).first))
2939 SpellLoc = SimpleSpellingLoc;
2940 else
Chandler Carruth40278532011-07-25 16:49:02 +00002941 SpellLoc = SM.getExpansionLoc(SpellLoc);
Douglas Gregora9b06d42010-11-09 06:24:54 +00002942 }
2943
2944 std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(SpellLoc);
2945 FileID FID = LocInfo.first;
2946 unsigned FileOffset = LocInfo.second;
2947
Argyrios Kyrtzidis5adc0512011-05-17 22:09:53 +00002948 if (FID.isInvalid())
2949 return createNullLocation(file, line, column, offset);
2950
Douglas Gregora9b06d42010-11-09 06:24:54 +00002951 if (file)
2952 *file = (void *)SM.getFileEntryForID(FID);
2953 if (line)
2954 *line = SM.getLineNumber(FID, FileOffset);
2955 if (column)
2956 *column = SM.getColumnNumber(FID, FileOffset);
2957 if (offset)
2958 *offset = FileOffset;
2959}
2960
Douglas Gregor1db19de2010-01-19 21:36:55 +00002961CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002962 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002963 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002964 return Result;
2965}
2966
2967CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002968 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002969 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002970 return Result;
2971}
2972
Douglas Gregorb9790342010-01-22 21:44:22 +00002973} // end: extern "C"
2974
Douglas Gregor1db19de2010-01-19 21:36:55 +00002975//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002976// CXFile Operations.
2977//===----------------------------------------------------------------------===//
2978
2979extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00002980CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002981 if (!SFile)
Ted Kremeneka60ed472010-11-16 08:15:36 +00002982 return createCXString((const char*)NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002983
Steve Naroff88145032009-10-27 14:35:18 +00002984 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00002985 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00002986}
2987
2988time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002989 if (!SFile)
2990 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002991
Steve Naroff88145032009-10-27 14:35:18 +00002992 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2993 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00002994}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002995
Douglas Gregorb9790342010-01-22 21:44:22 +00002996CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2997 if (!tu)
2998 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002999
Ted Kremeneka60ed472010-11-16 08:15:36 +00003000 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003001
Douglas Gregorb9790342010-01-22 21:44:22 +00003002 FileManager &FMgr = CXXUnit->getFileManager();
Chris Lattner39b49bc2010-11-23 08:35:12 +00003003 return const_cast<FileEntry *>(FMgr.getFile(file_name));
Douglas Gregorb9790342010-01-22 21:44:22 +00003004}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003005
Douglas Gregordd3e5542011-05-04 00:14:37 +00003006unsigned clang_isFileMultipleIncludeGuarded(CXTranslationUnit tu, CXFile file) {
3007 if (!tu || !file)
3008 return 0;
3009
3010 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu->TUData);
3011 FileEntry *FEnt = static_cast<FileEntry *>(file);
3012 return CXXUnit->getPreprocessor().getHeaderSearchInfo()
3013 .isFileMultipleIncludeGuarded(FEnt);
3014}
3015
Ted Kremenekfb480492010-01-13 21:46:36 +00003016} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00003017
Ted Kremenekfb480492010-01-13 21:46:36 +00003018//===----------------------------------------------------------------------===//
3019// CXCursor Operations.
3020//===----------------------------------------------------------------------===//
3021
Ted Kremenekfb480492010-01-13 21:46:36 +00003022static Decl *getDeclFromExpr(Stmt *E) {
Argyrios Kyrtzidisc2954612011-09-12 22:17:26 +00003023 if (ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
Douglas Gregordb1314e2010-10-01 21:11:22 +00003024 return getDeclFromExpr(CE->getSubExpr());
3025
Ted Kremenekfb480492010-01-13 21:46:36 +00003026 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
3027 return RefExpr->getDecl();
Douglas Gregor38f28c12010-10-22 22:24:08 +00003028 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
3029 return RefExpr->getDecl();
Ted Kremenekfb480492010-01-13 21:46:36 +00003030 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
3031 return ME->getMemberDecl();
3032 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
3033 return RE->getDecl();
Douglas Gregordb1314e2010-10-01 21:11:22 +00003034 if (ObjCPropertyRefExpr *PRE = dyn_cast<ObjCPropertyRefExpr>(E))
John McCall12f78a62010-12-02 01:19:52 +00003035 return PRE->isExplicitProperty() ? PRE->getExplicitProperty() : 0;
Douglas Gregordb1314e2010-10-01 21:11:22 +00003036
Ted Kremenekfb480492010-01-13 21:46:36 +00003037 if (CallExpr *CE = dyn_cast<CallExpr>(E))
3038 return getDeclFromExpr(CE->getCallee());
Chris Lattner5f9e2722011-07-23 10:55:15 +00003039 if (CXXConstructExpr *CE = dyn_cast<CXXConstructExpr>(E))
Douglas Gregor93798e22010-11-05 21:11:19 +00003040 if (!CE->isElidable())
3041 return CE->getConstructor();
Ted Kremenekfb480492010-01-13 21:46:36 +00003042 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
3043 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003044
Douglas Gregordb1314e2010-10-01 21:11:22 +00003045 if (ObjCProtocolExpr *PE = dyn_cast<ObjCProtocolExpr>(E))
3046 return PE->getProtocol();
Douglas Gregorc7793c72011-01-15 01:15:58 +00003047 if (SubstNonTypeTemplateParmPackExpr *NTTP
3048 = dyn_cast<SubstNonTypeTemplateParmPackExpr>(E))
3049 return NTTP->getParameterPack();
Douglas Gregor94d96292011-01-19 20:34:17 +00003050 if (SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
3051 if (isa<NonTypeTemplateParmDecl>(SizeOfPack->getPack()) ||
3052 isa<ParmVarDecl>(SizeOfPack->getPack()))
3053 return SizeOfPack->getPack();
Douglas Gregordb1314e2010-10-01 21:11:22 +00003054
Ted Kremenekfb480492010-01-13 21:46:36 +00003055 return 0;
3056}
3057
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00003058static SourceLocation getLocationFromExpr(Expr *E) {
Argyrios Kyrtzidisc2954612011-09-12 22:17:26 +00003059 if (ImplicitCastExpr *CE = dyn_cast<ImplicitCastExpr>(E))
3060 return getLocationFromExpr(CE->getSubExpr());
3061
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00003062 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
3063 return /*FIXME:*/Msg->getLeftLoc();
3064 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
3065 return DRE->getLocation();
Douglas Gregor38f28c12010-10-22 22:24:08 +00003066 if (BlockDeclRefExpr *RefExpr = dyn_cast<BlockDeclRefExpr>(E))
3067 return RefExpr->getLocation();
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00003068 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
3069 return Member->getMemberLoc();
3070 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
3071 return Ivar->getLocation();
Douglas Gregor94d96292011-01-19 20:34:17 +00003072 if (SizeOfPackExpr *SizeOfPack = dyn_cast<SizeOfPackExpr>(E))
3073 return SizeOfPack->getPackLoc();
3074
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00003075 return E->getLocStart();
3076}
3077
Ted Kremenekfb480492010-01-13 21:46:36 +00003078extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003079
3080unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00003081 CXCursorVisitor visitor,
3082 CXClientData client_data) {
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00003083 CursorVisitor CursorVis(getCursorTU(parent), visitor, client_data,
3084 /*VisitPreprocessorLast=*/false);
Douglas Gregorb1373d02010-01-20 20:59:29 +00003085 return CursorVis.VisitChildren(parent);
3086}
3087
David Chisnall3387c652010-11-03 14:12:26 +00003088#ifndef __has_feature
3089#define __has_feature(x) 0
3090#endif
3091#if __has_feature(blocks)
3092typedef enum CXChildVisitResult
3093 (^CXCursorVisitorBlock)(CXCursor cursor, CXCursor parent);
3094
3095static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
3096 CXClientData client_data) {
3097 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
3098 return block(cursor, parent);
3099}
3100#else
3101// If we are compiled with a compiler that doesn't have native blocks support,
3102// define and call the block manually, so the
3103typedef struct _CXChildVisitResult
3104{
3105 void *isa;
3106 int flags;
3107 int reserved;
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00003108 enum CXChildVisitResult(*invoke)(struct _CXChildVisitResult*, CXCursor,
3109 CXCursor);
David Chisnall3387c652010-11-03 14:12:26 +00003110} *CXCursorVisitorBlock;
3111
3112static enum CXChildVisitResult visitWithBlock(CXCursor cursor, CXCursor parent,
3113 CXClientData client_data) {
3114 CXCursorVisitorBlock block = (CXCursorVisitorBlock)client_data;
3115 return block->invoke(block, cursor, parent);
3116}
3117#endif
3118
3119
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00003120unsigned clang_visitChildrenWithBlock(CXCursor parent,
3121 CXCursorVisitorBlock block) {
David Chisnall3387c652010-11-03 14:12:26 +00003122 return clang_visitChildren(parent, visitWithBlock, block);
3123}
3124
Douglas Gregor78205d42010-01-20 21:45:58 +00003125static CXString getDeclSpelling(Decl *D) {
3126 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
Douglas Gregore3c60a72010-11-17 00:13:31 +00003127 if (!ND) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00003128 if (ObjCPropertyImplDecl *PropImpl =dyn_cast<ObjCPropertyImplDecl>(D))
Douglas Gregore3c60a72010-11-17 00:13:31 +00003129 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
3130 return createCXString(Property->getIdentifier()->getName());
3131
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003132 return createCXString("");
Douglas Gregore3c60a72010-11-17 00:13:31 +00003133 }
3134
Douglas Gregor78205d42010-01-20 21:45:58 +00003135 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003136 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003137
Douglas Gregor78205d42010-01-20 21:45:58 +00003138 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
3139 // No, this isn't the same as the code below. getIdentifier() is non-virtual
3140 // and returns different names. NamedDecl returns the class name and
3141 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003142 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003143
Douglas Gregor0a35bce2010-09-01 03:07:18 +00003144 if (isa<UsingDirectiveDecl>(D))
3145 return createCXString("");
3146
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00003147 llvm::SmallString<1024> S;
3148 llvm::raw_svector_ostream os(S);
3149 ND->printName(os);
3150
3151 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00003152}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003153
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003154CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00003155 if (clang_isTranslationUnit(C.kind))
Ted Kremeneka60ed472010-11-16 08:15:36 +00003156 return clang_getTranslationUnitSpelling(
3157 static_cast<CXTranslationUnit>(C.data[2]));
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00003158
Steve Narofff334b4e2009-09-02 18:26:48 +00003159 if (clang_isReference(C.kind)) {
3160 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00003161 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00003162 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003163 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00003164 }
3165 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00003166 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003167 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00003168 }
3169 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00003170 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00003171 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003172 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00003173 }
Ted Kremenek3064ef92010-08-27 21:34:58 +00003174 case CXCursor_CXXBaseSpecifier: {
3175 CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
3176 return createCXString(B->getType().getAsString());
3177 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003178 case CXCursor_TypeRef: {
3179 TypeDecl *Type = getCursorTypeRef(C).first;
3180 assert(Type && "Missing type decl");
3181
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003182 return createCXString(getCursorContext(C).getTypeDeclType(Type).
3183 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003184 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00003185 case CXCursor_TemplateRef: {
3186 TemplateDecl *Template = getCursorTemplateRef(C).first;
Douglas Gregor69319002010-08-31 23:48:11 +00003187 assert(Template && "Missing template decl");
Douglas Gregor0b36e612010-08-31 20:37:03 +00003188
3189 return createCXString(Template->getNameAsString());
3190 }
Douglas Gregor69319002010-08-31 23:48:11 +00003191
3192 case CXCursor_NamespaceRef: {
3193 NamedDecl *NS = getCursorNamespaceRef(C).first;
3194 assert(NS && "Missing namespace decl");
3195
3196 return createCXString(NS->getNameAsString());
3197 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003198
Douglas Gregora67e03f2010-09-09 21:42:20 +00003199 case CXCursor_MemberRef: {
3200 FieldDecl *Field = getCursorMemberRef(C).first;
3201 assert(Field && "Missing member decl");
3202
3203 return createCXString(Field->getNameAsString());
3204 }
3205
Douglas Gregor36897b02010-09-10 00:22:18 +00003206 case CXCursor_LabelRef: {
3207 LabelStmt *Label = getCursorLabelRef(C).first;
3208 assert(Label && "Missing label");
3209
Chris Lattnerad8dcf42011-02-17 07:39:24 +00003210 return createCXString(Label->getName());
Douglas Gregor36897b02010-09-10 00:22:18 +00003211 }
3212
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003213 case CXCursor_OverloadedDeclRef: {
3214 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
3215 if (Decl *D = Storage.dyn_cast<Decl *>()) {
3216 if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
3217 return createCXString(ND->getNameAsString());
3218 return createCXString("");
3219 }
3220 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
3221 return createCXString(E->getName().getAsString());
3222 OverloadedTemplateStorage *Ovl
3223 = Storage.get<OverloadedTemplateStorage*>();
3224 if (Ovl->size() == 0)
3225 return createCXString("");
3226 return createCXString((*Ovl->begin())->getNameAsString());
3227 }
3228
Daniel Dunbaracca7252009-11-30 20:42:49 +00003229 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003230 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00003231 }
3232 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003233
3234 if (clang_isExpression(C.kind)) {
3235 Decl *D = getDeclFromExpr(getCursorExpr(C));
3236 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00003237 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003238 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00003239 }
3240
Douglas Gregor36897b02010-09-10 00:22:18 +00003241 if (clang_isStatement(C.kind)) {
3242 Stmt *S = getCursorStmt(C);
3243 if (LabelStmt *Label = dyn_cast_or_null<LabelStmt>(S))
Chris Lattnerad8dcf42011-02-17 07:39:24 +00003244 return createCXString(Label->getName());
Douglas Gregor36897b02010-09-10 00:22:18 +00003245
3246 return createCXString("");
3247 }
3248
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00003249 if (C.kind == CXCursor_MacroExpansion)
Chandler Carruth9e5bb852011-07-14 08:20:46 +00003250 return createCXString(getCursorMacroExpansion(C)->getName()
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003251 ->getNameStart());
3252
Douglas Gregor572feb22010-03-18 18:04:21 +00003253 if (C.kind == CXCursor_MacroDefinition)
3254 return createCXString(getCursorMacroDefinition(C)->getName()
3255 ->getNameStart());
3256
Douglas Gregorecdcb882010-10-20 22:00:55 +00003257 if (C.kind == CXCursor_InclusionDirective)
3258 return createCXString(getCursorInclusionDirective(C)->getFileName());
3259
Douglas Gregor60cbfac2010-01-25 16:56:17 +00003260 if (clang_isDeclaration(C.kind))
3261 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00003262
Erik Verbruggen5f1c8222011-10-13 09:41:32 +00003263 if (C.kind == CXCursor_AnnotateAttr) {
3264 AnnotateAttr *AA = cast<AnnotateAttr>(cxcursor::getCursorAttr(C));
3265 return createCXString(AA->getAnnotation());
3266 }
3267
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003268 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00003269}
3270
Douglas Gregor358559d2010-10-02 22:49:11 +00003271CXString clang_getCursorDisplayName(CXCursor C) {
3272 if (!clang_isDeclaration(C.kind))
3273 return clang_getCursorSpelling(C);
3274
3275 Decl *D = getCursorDecl(C);
3276 if (!D)
3277 return createCXString("");
3278
Douglas Gregor30c42402011-09-27 22:38:19 +00003279 PrintingPolicy Policy = getCursorContext(C).getPrintingPolicy();
Douglas Gregor358559d2010-10-02 22:49:11 +00003280 if (FunctionTemplateDecl *FunTmpl = dyn_cast<FunctionTemplateDecl>(D))
3281 D = FunTmpl->getTemplatedDecl();
3282
3283 if (FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
3284 llvm::SmallString<64> Str;
3285 llvm::raw_svector_ostream OS(Str);
3286 OS << Function->getNameAsString();
3287 if (Function->getPrimaryTemplate())
3288 OS << "<>";
3289 OS << "(";
3290 for (unsigned I = 0, N = Function->getNumParams(); I != N; ++I) {
3291 if (I)
3292 OS << ", ";
3293 OS << Function->getParamDecl(I)->getType().getAsString(Policy);
3294 }
3295
3296 if (Function->isVariadic()) {
3297 if (Function->getNumParams())
3298 OS << ", ";
3299 OS << "...";
3300 }
3301 OS << ")";
3302 return createCXString(OS.str());
3303 }
3304
3305 if (ClassTemplateDecl *ClassTemplate = dyn_cast<ClassTemplateDecl>(D)) {
3306 llvm::SmallString<64> Str;
3307 llvm::raw_svector_ostream OS(Str);
3308 OS << ClassTemplate->getNameAsString();
3309 OS << "<";
3310 TemplateParameterList *Params = ClassTemplate->getTemplateParameters();
3311 for (unsigned I = 0, N = Params->size(); I != N; ++I) {
3312 if (I)
3313 OS << ", ";
3314
3315 NamedDecl *Param = Params->getParam(I);
3316 if (Param->getIdentifier()) {
3317 OS << Param->getIdentifier()->getName();
3318 continue;
3319 }
3320
3321 // There is no parameter name, which makes this tricky. Try to come up
3322 // with something useful that isn't too long.
3323 if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Param))
3324 OS << (TTP->wasDeclaredWithTypename()? "typename" : "class");
3325 else if (NonTypeTemplateParmDecl *NTTP
3326 = dyn_cast<NonTypeTemplateParmDecl>(Param))
3327 OS << NTTP->getType().getAsString(Policy);
3328 else
3329 OS << "template<...> class";
3330 }
3331
3332 OS << ">";
3333 return createCXString(OS.str());
3334 }
3335
3336 if (ClassTemplateSpecializationDecl *ClassSpec
3337 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
3338 // If the type was explicitly written, use that.
3339 if (TypeSourceInfo *TSInfo = ClassSpec->getTypeAsWritten())
3340 return createCXString(TSInfo->getType().getAsString(Policy));
3341
3342 llvm::SmallString<64> Str;
3343 llvm::raw_svector_ostream OS(Str);
3344 OS << ClassSpec->getNameAsString();
3345 OS << TemplateSpecializationType::PrintTemplateArgumentList(
Douglas Gregor910f8002010-11-07 23:05:16 +00003346 ClassSpec->getTemplateArgs().data(),
3347 ClassSpec->getTemplateArgs().size(),
Douglas Gregor358559d2010-10-02 22:49:11 +00003348 Policy);
3349 return createCXString(OS.str());
3350 }
3351
3352 return clang_getCursorSpelling(C);
3353}
3354
Ted Kremeneke68fff62010-02-17 00:41:32 +00003355CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00003356 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00003357 case CXCursor_FunctionDecl:
3358 return createCXString("FunctionDecl");
3359 case CXCursor_TypedefDecl:
3360 return createCXString("TypedefDecl");
3361 case CXCursor_EnumDecl:
3362 return createCXString("EnumDecl");
3363 case CXCursor_EnumConstantDecl:
3364 return createCXString("EnumConstantDecl");
3365 case CXCursor_StructDecl:
3366 return createCXString("StructDecl");
3367 case CXCursor_UnionDecl:
3368 return createCXString("UnionDecl");
3369 case CXCursor_ClassDecl:
3370 return createCXString("ClassDecl");
3371 case CXCursor_FieldDecl:
3372 return createCXString("FieldDecl");
3373 case CXCursor_VarDecl:
3374 return createCXString("VarDecl");
3375 case CXCursor_ParmDecl:
3376 return createCXString("ParmDecl");
3377 case CXCursor_ObjCInterfaceDecl:
3378 return createCXString("ObjCInterfaceDecl");
3379 case CXCursor_ObjCCategoryDecl:
3380 return createCXString("ObjCCategoryDecl");
3381 case CXCursor_ObjCProtocolDecl:
3382 return createCXString("ObjCProtocolDecl");
3383 case CXCursor_ObjCPropertyDecl:
3384 return createCXString("ObjCPropertyDecl");
3385 case CXCursor_ObjCIvarDecl:
3386 return createCXString("ObjCIvarDecl");
3387 case CXCursor_ObjCInstanceMethodDecl:
3388 return createCXString("ObjCInstanceMethodDecl");
3389 case CXCursor_ObjCClassMethodDecl:
3390 return createCXString("ObjCClassMethodDecl");
3391 case CXCursor_ObjCImplementationDecl:
3392 return createCXString("ObjCImplementationDecl");
3393 case CXCursor_ObjCCategoryImplDecl:
3394 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00003395 case CXCursor_CXXMethod:
3396 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003397 case CXCursor_UnexposedDecl:
3398 return createCXString("UnexposedDecl");
3399 case CXCursor_ObjCSuperClassRef:
3400 return createCXString("ObjCSuperClassRef");
3401 case CXCursor_ObjCProtocolRef:
3402 return createCXString("ObjCProtocolRef");
3403 case CXCursor_ObjCClassRef:
3404 return createCXString("ObjCClassRef");
3405 case CXCursor_TypeRef:
3406 return createCXString("TypeRef");
Douglas Gregor0b36e612010-08-31 20:37:03 +00003407 case CXCursor_TemplateRef:
3408 return createCXString("TemplateRef");
Douglas Gregor69319002010-08-31 23:48:11 +00003409 case CXCursor_NamespaceRef:
3410 return createCXString("NamespaceRef");
Douglas Gregora67e03f2010-09-09 21:42:20 +00003411 case CXCursor_MemberRef:
3412 return createCXString("MemberRef");
Douglas Gregor36897b02010-09-10 00:22:18 +00003413 case CXCursor_LabelRef:
3414 return createCXString("LabelRef");
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003415 case CXCursor_OverloadedDeclRef:
3416 return createCXString("OverloadedDeclRef");
Douglas Gregor42b29842011-10-05 19:00:14 +00003417 case CXCursor_IntegerLiteral:
3418 return createCXString("IntegerLiteral");
3419 case CXCursor_FloatingLiteral:
3420 return createCXString("FloatingLiteral");
3421 case CXCursor_ImaginaryLiteral:
3422 return createCXString("ImaginaryLiteral");
3423 case CXCursor_StringLiteral:
3424 return createCXString("StringLiteral");
3425 case CXCursor_CharacterLiteral:
3426 return createCXString("CharacterLiteral");
3427 case CXCursor_ParenExpr:
3428 return createCXString("ParenExpr");
3429 case CXCursor_UnaryOperator:
3430 return createCXString("UnaryOperator");
3431 case CXCursor_ArraySubscriptExpr:
3432 return createCXString("ArraySubscriptExpr");
3433 case CXCursor_BinaryOperator:
3434 return createCXString("BinaryOperator");
3435 case CXCursor_CompoundAssignOperator:
3436 return createCXString("CompoundAssignOperator");
3437 case CXCursor_ConditionalOperator:
3438 return createCXString("ConditionalOperator");
3439 case CXCursor_CStyleCastExpr:
3440 return createCXString("CStyleCastExpr");
3441 case CXCursor_CompoundLiteralExpr:
3442 return createCXString("CompoundLiteralExpr");
3443 case CXCursor_InitListExpr:
3444 return createCXString("InitListExpr");
3445 case CXCursor_AddrLabelExpr:
3446 return createCXString("AddrLabelExpr");
3447 case CXCursor_StmtExpr:
3448 return createCXString("StmtExpr");
3449 case CXCursor_GenericSelectionExpr:
3450 return createCXString("GenericSelectionExpr");
3451 case CXCursor_GNUNullExpr:
3452 return createCXString("GNUNullExpr");
3453 case CXCursor_CXXStaticCastExpr:
3454 return createCXString("CXXStaticCastExpr");
3455 case CXCursor_CXXDynamicCastExpr:
3456 return createCXString("CXXDynamicCastExpr");
3457 case CXCursor_CXXReinterpretCastExpr:
3458 return createCXString("CXXReinterpretCastExpr");
3459 case CXCursor_CXXConstCastExpr:
3460 return createCXString("CXXConstCastExpr");
3461 case CXCursor_CXXFunctionalCastExpr:
3462 return createCXString("CXXFunctionalCastExpr");
3463 case CXCursor_CXXTypeidExpr:
3464 return createCXString("CXXTypeidExpr");
3465 case CXCursor_CXXBoolLiteralExpr:
3466 return createCXString("CXXBoolLiteralExpr");
3467 case CXCursor_CXXNullPtrLiteralExpr:
3468 return createCXString("CXXNullPtrLiteralExpr");
3469 case CXCursor_CXXThisExpr:
3470 return createCXString("CXXThisExpr");
3471 case CXCursor_CXXThrowExpr:
3472 return createCXString("CXXThrowExpr");
3473 case CXCursor_CXXNewExpr:
3474 return createCXString("CXXNewExpr");
3475 case CXCursor_CXXDeleteExpr:
3476 return createCXString("CXXDeleteExpr");
3477 case CXCursor_UnaryExpr:
3478 return createCXString("UnaryExpr");
3479 case CXCursor_ObjCStringLiteral:
3480 return createCXString("ObjCStringLiteral");
3481 case CXCursor_ObjCEncodeExpr:
3482 return createCXString("ObjCEncodeExpr");
3483 case CXCursor_ObjCSelectorExpr:
3484 return createCXString("ObjCSelectorExpr");
3485 case CXCursor_ObjCProtocolExpr:
3486 return createCXString("ObjCProtocolExpr");
3487 case CXCursor_ObjCBridgedCastExpr:
3488 return createCXString("ObjCBridgedCastExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00003489 case CXCursor_BlockExpr:
3490 return createCXString("BlockExpr");
Douglas Gregor42b29842011-10-05 19:00:14 +00003491 case CXCursor_PackExpansionExpr:
3492 return createCXString("PackExpansionExpr");
3493 case CXCursor_SizeOfPackExpr:
3494 return createCXString("SizeOfPackExpr");
3495 case CXCursor_UnexposedExpr:
3496 return createCXString("UnexposedExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003497 case CXCursor_DeclRefExpr:
3498 return createCXString("DeclRefExpr");
3499 case CXCursor_MemberRefExpr:
3500 return createCXString("MemberRefExpr");
3501 case CXCursor_CallExpr:
3502 return createCXString("CallExpr");
3503 case CXCursor_ObjCMessageExpr:
3504 return createCXString("ObjCMessageExpr");
3505 case CXCursor_UnexposedStmt:
3506 return createCXString("UnexposedStmt");
Douglas Gregor42b29842011-10-05 19:00:14 +00003507 case CXCursor_DeclStmt:
3508 return createCXString("DeclStmt");
Douglas Gregor36897b02010-09-10 00:22:18 +00003509 case CXCursor_LabelStmt:
3510 return createCXString("LabelStmt");
Douglas Gregor42b29842011-10-05 19:00:14 +00003511 case CXCursor_CompoundStmt:
3512 return createCXString("CompoundStmt");
3513 case CXCursor_CaseStmt:
3514 return createCXString("CaseStmt");
3515 case CXCursor_DefaultStmt:
3516 return createCXString("DefaultStmt");
3517 case CXCursor_IfStmt:
3518 return createCXString("IfStmt");
3519 case CXCursor_SwitchStmt:
3520 return createCXString("SwitchStmt");
3521 case CXCursor_WhileStmt:
3522 return createCXString("WhileStmt");
3523 case CXCursor_DoStmt:
3524 return createCXString("DoStmt");
3525 case CXCursor_ForStmt:
3526 return createCXString("ForStmt");
3527 case CXCursor_GotoStmt:
3528 return createCXString("GotoStmt");
3529 case CXCursor_IndirectGotoStmt:
3530 return createCXString("IndirectGotoStmt");
3531 case CXCursor_ContinueStmt:
3532 return createCXString("ContinueStmt");
3533 case CXCursor_BreakStmt:
3534 return createCXString("BreakStmt");
3535 case CXCursor_ReturnStmt:
3536 return createCXString("ReturnStmt");
3537 case CXCursor_AsmStmt:
3538 return createCXString("AsmStmt");
3539 case CXCursor_ObjCAtTryStmt:
3540 return createCXString("ObjCAtTryStmt");
3541 case CXCursor_ObjCAtCatchStmt:
3542 return createCXString("ObjCAtCatchStmt");
3543 case CXCursor_ObjCAtFinallyStmt:
3544 return createCXString("ObjCAtFinallyStmt");
3545 case CXCursor_ObjCAtThrowStmt:
3546 return createCXString("ObjCAtThrowStmt");
3547 case CXCursor_ObjCAtSynchronizedStmt:
3548 return createCXString("ObjCAtSynchronizedStmt");
3549 case CXCursor_ObjCAutoreleasePoolStmt:
3550 return createCXString("ObjCAutoreleasePoolStmt");
3551 case CXCursor_ObjCForCollectionStmt:
3552 return createCXString("ObjCForCollectionStmt");
3553 case CXCursor_CXXCatchStmt:
3554 return createCXString("CXXCatchStmt");
3555 case CXCursor_CXXTryStmt:
3556 return createCXString("CXXTryStmt");
3557 case CXCursor_CXXForRangeStmt:
3558 return createCXString("CXXForRangeStmt");
3559 case CXCursor_SEHTryStmt:
3560 return createCXString("SEHTryStmt");
3561 case CXCursor_SEHExceptStmt:
3562 return createCXString("SEHExceptStmt");
3563 case CXCursor_SEHFinallyStmt:
3564 return createCXString("SEHFinallyStmt");
3565 case CXCursor_NullStmt:
3566 return createCXString("NullStmt");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003567 case CXCursor_InvalidFile:
3568 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00003569 case CXCursor_InvalidCode:
3570 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00003571 case CXCursor_NoDeclFound:
3572 return createCXString("NoDeclFound");
3573 case CXCursor_NotImplemented:
3574 return createCXString("NotImplemented");
3575 case CXCursor_TranslationUnit:
3576 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00003577 case CXCursor_UnexposedAttr:
3578 return createCXString("UnexposedAttr");
3579 case CXCursor_IBActionAttr:
3580 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003581 case CXCursor_IBOutletAttr:
3582 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00003583 case CXCursor_IBOutletCollectionAttr:
3584 return createCXString("attribute(iboutletcollection)");
Argyrios Kyrtzidis6639e922011-09-13 17:39:31 +00003585 case CXCursor_CXXFinalAttr:
3586 return createCXString("attribute(final)");
3587 case CXCursor_CXXOverrideAttr:
3588 return createCXString("attribute(override)");
Erik Verbruggen5f1c8222011-10-13 09:41:32 +00003589 case CXCursor_AnnotateAttr:
3590 return createCXString("attribute(annotate)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003591 case CXCursor_PreprocessingDirective:
3592 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00003593 case CXCursor_MacroDefinition:
3594 return createCXString("macro definition");
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00003595 case CXCursor_MacroExpansion:
3596 return createCXString("macro expansion");
Douglas Gregorecdcb882010-10-20 22:00:55 +00003597 case CXCursor_InclusionDirective:
3598 return createCXString("inclusion directive");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00003599 case CXCursor_Namespace:
3600 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00003601 case CXCursor_LinkageSpec:
3602 return createCXString("LinkageSpec");
Ted Kremenek3064ef92010-08-27 21:34:58 +00003603 case CXCursor_CXXBaseSpecifier:
3604 return createCXString("C++ base class specifier");
Douglas Gregor01829d32010-08-31 14:41:23 +00003605 case CXCursor_Constructor:
3606 return createCXString("CXXConstructor");
3607 case CXCursor_Destructor:
3608 return createCXString("CXXDestructor");
3609 case CXCursor_ConversionFunction:
3610 return createCXString("CXXConversion");
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00003611 case CXCursor_TemplateTypeParameter:
3612 return createCXString("TemplateTypeParameter");
3613 case CXCursor_NonTypeTemplateParameter:
3614 return createCXString("NonTypeTemplateParameter");
3615 case CXCursor_TemplateTemplateParameter:
3616 return createCXString("TemplateTemplateParameter");
3617 case CXCursor_FunctionTemplate:
3618 return createCXString("FunctionTemplate");
Douglas Gregor39d6f072010-08-31 19:02:00 +00003619 case CXCursor_ClassTemplate:
3620 return createCXString("ClassTemplate");
Douglas Gregor74dbe642010-08-31 19:31:58 +00003621 case CXCursor_ClassTemplatePartialSpecialization:
3622 return createCXString("ClassTemplatePartialSpecialization");
Douglas Gregor69319002010-08-31 23:48:11 +00003623 case CXCursor_NamespaceAlias:
3624 return createCXString("NamespaceAlias");
Douglas Gregor0a35bce2010-09-01 03:07:18 +00003625 case CXCursor_UsingDirective:
3626 return createCXString("UsingDirective");
Douglas Gregor7e242562010-09-01 19:52:22 +00003627 case CXCursor_UsingDeclaration:
3628 return createCXString("UsingDeclaration");
Richard Smith162e1c12011-04-15 14:24:37 +00003629 case CXCursor_TypeAliasDecl:
Douglas Gregor352697a2011-06-03 23:08:58 +00003630 return createCXString("TypeAliasDecl");
3631 case CXCursor_ObjCSynthesizeDecl:
3632 return createCXString("ObjCSynthesizeDecl");
3633 case CXCursor_ObjCDynamicDecl:
3634 return createCXString("ObjCDynamicDecl");
Argyrios Kyrtzidis2dfdb942011-09-30 17:58:23 +00003635 case CXCursor_CXXAccessSpecifier:
3636 return createCXString("CXXAccessSpecifier");
Steve Naroff89922f82009-08-31 00:59:03 +00003637 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00003638
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00003639 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneka60ed472010-11-16 08:15:36 +00003640 return createCXString((const char*) 0);
Steve Naroff600866c2009-08-27 19:51:58 +00003641}
Steve Naroff89922f82009-08-31 00:59:03 +00003642
Argyrios Kyrtzidis064c44b2011-06-27 19:42:23 +00003643struct GetCursorData {
3644 SourceLocation TokenBeginLoc;
Argyrios Kyrtzidis4b43b302011-08-17 00:31:25 +00003645 bool PointsAtMacroArgExpansion;
Argyrios Kyrtzidis064c44b2011-06-27 19:42:23 +00003646 CXCursor &BestCursor;
3647
Argyrios Kyrtzidis4b43b302011-08-17 00:31:25 +00003648 GetCursorData(SourceManager &SM,
3649 SourceLocation tokenBegin, CXCursor &outputCursor)
3650 : TokenBeginLoc(tokenBegin), BestCursor(outputCursor) {
3651 PointsAtMacroArgExpansion = SM.isMacroArgExpansion(tokenBegin);
3652 }
Argyrios Kyrtzidis064c44b2011-06-27 19:42:23 +00003653};
3654
Argyrios Kyrtzidis4b43b302011-08-17 00:31:25 +00003655static enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
3656 CXCursor parent,
3657 CXClientData client_data) {
Argyrios Kyrtzidis064c44b2011-06-27 19:42:23 +00003658 GetCursorData *Data = static_cast<GetCursorData *>(client_data);
3659 CXCursor *BestCursor = &Data->BestCursor;
Argyrios Kyrtzidis4b43b302011-08-17 00:31:25 +00003660
3661 // If we point inside a macro argument we should provide info of what the
3662 // token is so use the actual cursor, don't replace it with a macro expansion
3663 // cursor.
3664 if (cursor.kind == CXCursor_MacroExpansion && Data->PointsAtMacroArgExpansion)
3665 return CXChildVisit_Recurse;
Argyrios Kyrtzidis65ab9072011-09-26 19:05:37 +00003666
3667 if (clang_isDeclaration(cursor.kind)) {
3668 // Avoid having the implicit methods override the property decls.
3669 if (ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(getCursorDecl(cursor)))
3670 if (MD->isImplicit())
3671 return CXChildVisit_Break;
3672 }
Argyrios Kyrtzidis064c44b2011-06-27 19:42:23 +00003673
3674 if (clang_isExpression(cursor.kind) &&
3675 clang_isDeclaration(BestCursor->kind)) {
3676 Decl *D = getCursorDecl(*BestCursor);
3677
3678 // Avoid having the cursor of an expression replace the declaration cursor
3679 // when the expression source range overlaps the declaration range.
3680 // This can happen for C++ constructor expressions whose range generally
3681 // include the variable declaration, e.g.:
3682 // MyCXXClass foo; // Make sure pointing at 'foo' returns a VarDecl cursor.
3683 if (D->getLocation().isValid() && Data->TokenBeginLoc.isValid() &&
3684 D->getLocation() == Data->TokenBeginLoc)
3685 return CXChildVisit_Break;
3686 }
3687
Douglas Gregor93798e22010-11-05 21:11:19 +00003688 // If our current best cursor is the construction of a temporary object,
3689 // don't replace that cursor with a type reference, because we want
3690 // clang_getCursor() to point at the constructor.
3691 if (clang_isExpression(BestCursor->kind) &&
3692 isa<CXXTemporaryObjectExpr>(getCursorExpr(*BestCursor)) &&
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00003693 cursor.kind == CXCursor_TypeRef) {
3694 // Keep the cursor pointing at CXXTemporaryObjectExpr but also mark it
3695 // as having the actual point on the type reference.
3696 *BestCursor = getTypeRefedCallExprCursor(*BestCursor);
Douglas Gregor93798e22010-11-05 21:11:19 +00003697 return CXChildVisit_Recurse;
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00003698 }
Douglas Gregor93798e22010-11-05 21:11:19 +00003699
Douglas Gregor33e9abd2010-01-22 19:49:59 +00003700 *BestCursor = cursor;
3701 return CXChildVisit_Recurse;
3702}
Ted Kremeneke68fff62010-02-17 00:41:32 +00003703
Douglas Gregorb9790342010-01-22 21:44:22 +00003704CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
3705 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00003706 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00003707
Ted Kremeneka60ed472010-11-16 08:15:36 +00003708 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorbdf60622010-03-05 21:16:25 +00003709 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3710
Ted Kremeneka297de22010-01-25 22:34:44 +00003711 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Argyrios Kyrtzidis671436e2011-09-27 00:30:33 +00003712 CXCursor Result = cxcursor::getCursor(TU, SLoc);
Ted Kremeneka629ea42010-07-29 00:52:07 +00003713
Douglas Gregor40749ee2010-11-03 00:35:38 +00003714 bool Logging = getenv("LIBCLANG_LOGGING");
Douglas Gregor40749ee2010-11-03 00:35:38 +00003715 if (Logging) {
3716 CXFile SearchFile;
3717 unsigned SearchLine, SearchColumn;
3718 CXFile ResultFile;
3719 unsigned ResultLine, ResultColumn;
Douglas Gregor66537982010-11-17 17:14:07 +00003720 CXString SearchFileName, ResultFileName, KindSpelling, USR;
3721 const char *IsDef = clang_isCursorDefinition(Result)? " (Definition)" : "";
Douglas Gregor40749ee2010-11-03 00:35:38 +00003722 CXSourceLocation ResultLoc = clang_getCursorLocation(Result);
3723
Chandler Carruth20174222011-08-31 16:53:37 +00003724 clang_getExpansionLocation(Loc, &SearchFile, &SearchLine, &SearchColumn, 0);
3725 clang_getExpansionLocation(ResultLoc, &ResultFile, &ResultLine,
3726 &ResultColumn, 0);
Douglas Gregor40749ee2010-11-03 00:35:38 +00003727 SearchFileName = clang_getFileName(SearchFile);
3728 ResultFileName = clang_getFileName(ResultFile);
3729 KindSpelling = clang_getCursorKindSpelling(Result.kind);
Douglas Gregor66537982010-11-17 17:14:07 +00003730 USR = clang_getCursorUSR(Result);
3731 fprintf(stderr, "clang_getCursor(%s:%d:%d) = %s(%s:%d:%d):%s%s\n",
Douglas Gregor40749ee2010-11-03 00:35:38 +00003732 clang_getCString(SearchFileName), SearchLine, SearchColumn,
3733 clang_getCString(KindSpelling),
Douglas Gregor66537982010-11-17 17:14:07 +00003734 clang_getCString(ResultFileName), ResultLine, ResultColumn,
3735 clang_getCString(USR), IsDef);
Douglas Gregor40749ee2010-11-03 00:35:38 +00003736 clang_disposeString(SearchFileName);
3737 clang_disposeString(ResultFileName);
3738 clang_disposeString(KindSpelling);
Douglas Gregor66537982010-11-17 17:14:07 +00003739 clang_disposeString(USR);
Douglas Gregor0aefbd82010-12-10 01:45:00 +00003740
3741 CXCursor Definition = clang_getCursorDefinition(Result);
3742 if (!clang_equalCursors(Definition, clang_getNullCursor())) {
3743 CXSourceLocation DefinitionLoc = clang_getCursorLocation(Definition);
3744 CXString DefinitionKindSpelling
3745 = clang_getCursorKindSpelling(Definition.kind);
3746 CXFile DefinitionFile;
3747 unsigned DefinitionLine, DefinitionColumn;
Chandler Carruth20174222011-08-31 16:53:37 +00003748 clang_getExpansionLocation(DefinitionLoc, &DefinitionFile,
3749 &DefinitionLine, &DefinitionColumn, 0);
Douglas Gregor0aefbd82010-12-10 01:45:00 +00003750 CXString DefinitionFileName = clang_getFileName(DefinitionFile);
3751 fprintf(stderr, " -> %s(%s:%d:%d)\n",
3752 clang_getCString(DefinitionKindSpelling),
3753 clang_getCString(DefinitionFileName),
3754 DefinitionLine, DefinitionColumn);
3755 clang_disposeString(DefinitionFileName);
3756 clang_disposeString(DefinitionKindSpelling);
3757 }
Douglas Gregor40749ee2010-11-03 00:35:38 +00003758 }
3759
Ted Kremeneke68fff62010-02-17 00:41:32 +00003760 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00003761}
3762
Ted Kremenek73885552009-11-17 19:28:59 +00003763CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00003764 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00003765}
3766
3767unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003768 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00003769}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003770
Douglas Gregor9ce55842010-11-20 00:09:34 +00003771unsigned clang_hashCursor(CXCursor C) {
3772 unsigned Index = 0;
3773 if (clang_isExpression(C.kind) || clang_isStatement(C.kind))
3774 Index = 1;
3775
3776 return llvm::DenseMapInfo<std::pair<unsigned, void*> >::getHashValue(
3777 std::make_pair(C.kind, C.data[Index]));
3778}
3779
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003780unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00003781 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
3782}
3783
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003784unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00003785 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
3786}
Steve Naroff2d4d6292009-08-31 14:26:51 +00003787
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003788unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00003789 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
3790}
3791
Douglas Gregor97b98722010-01-19 23:20:36 +00003792unsigned clang_isExpression(enum CXCursorKind K) {
3793 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
3794}
3795
3796unsigned clang_isStatement(enum CXCursorKind K) {
3797 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
3798}
3799
Douglas Gregor8be80e12011-07-06 03:00:34 +00003800unsigned clang_isAttribute(enum CXCursorKind K) {
3801 return K >= CXCursor_FirstAttr && K <= CXCursor_LastAttr;
3802}
3803
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00003804unsigned clang_isTranslationUnit(enum CXCursorKind K) {
3805 return K == CXCursor_TranslationUnit;
3806}
3807
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003808unsigned clang_isPreprocessing(enum CXCursorKind K) {
3809 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
3810}
3811
Ted Kremenekad6eff62010-03-08 21:17:29 +00003812unsigned clang_isUnexposed(enum CXCursorKind K) {
3813 switch (K) {
3814 case CXCursor_UnexposedDecl:
3815 case CXCursor_UnexposedExpr:
3816 case CXCursor_UnexposedStmt:
3817 case CXCursor_UnexposedAttr:
3818 return true;
3819 default:
3820 return false;
3821 }
3822}
3823
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003824CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00003825 return C.kind;
3826}
3827
Douglas Gregor98258af2010-01-18 22:46:11 +00003828CXSourceLocation clang_getCursorLocation(CXCursor C) {
3829 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003830 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003831 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003832 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3833 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003834 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003835 }
3836
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003837 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003838 std::pair<ObjCProtocolDecl *, SourceLocation> P
3839 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003840 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003841 }
3842
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003843 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00003844 std::pair<ObjCInterfaceDecl *, SourceLocation> P
3845 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003846 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003847 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003848
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003849 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003850 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00003851 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003852 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00003853
3854 case CXCursor_TemplateRef: {
3855 std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
3856 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3857 }
3858
Douglas Gregor69319002010-08-31 23:48:11 +00003859 case CXCursor_NamespaceRef: {
3860 std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
3861 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3862 }
3863
Douglas Gregora67e03f2010-09-09 21:42:20 +00003864 case CXCursor_MemberRef: {
3865 std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
3866 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
3867 }
3868
Ted Kremenek3064ef92010-08-27 21:34:58 +00003869 case CXCursor_CXXBaseSpecifier: {
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00003870 CXXBaseSpecifier *BaseSpec = getCursorCXXBaseSpecifier(C);
3871 if (!BaseSpec)
3872 return clang_getNullLocation();
3873
3874 if (TypeSourceInfo *TSInfo = BaseSpec->getTypeSourceInfo())
3875 return cxloc::translateSourceLocation(getCursorContext(C),
3876 TSInfo->getTypeLoc().getBeginLoc());
3877
3878 return cxloc::translateSourceLocation(getCursorContext(C),
3879 BaseSpec->getSourceRange().getBegin());
Ted Kremenek3064ef92010-08-27 21:34:58 +00003880 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003881
Douglas Gregor36897b02010-09-10 00:22:18 +00003882 case CXCursor_LabelRef: {
3883 std::pair<LabelStmt *, SourceLocation> P = getCursorLabelRef(C);
3884 return cxloc::translateSourceLocation(getCursorContext(C), P.second);
3885 }
3886
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00003887 case CXCursor_OverloadedDeclRef:
3888 return cxloc::translateSourceLocation(getCursorContext(C),
3889 getCursorOverloadedDeclRef(C).second);
3890
Douglas Gregorf46034a2010-01-18 23:41:10 +00003891 default:
3892 // FIXME: Need a way to enumerate all non-reference cases.
3893 llvm_unreachable("Missed a reference kind");
3894 }
Douglas Gregor98258af2010-01-18 22:46:11 +00003895 }
Douglas Gregor97b98722010-01-19 23:20:36 +00003896
3897 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003898 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00003899 getLocationFromExpr(getCursorExpr(C)));
3900
Douglas Gregor36897b02010-09-10 00:22:18 +00003901 if (clang_isStatement(C.kind))
3902 return cxloc::translateSourceLocation(getCursorContext(C),
3903 getCursorStmt(C)->getLocStart());
3904
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003905 if (C.kind == CXCursor_PreprocessingDirective) {
3906 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
3907 return cxloc::translateSourceLocation(getCursorContext(C), L);
3908 }
Douglas Gregor48072312010-03-18 15:23:44 +00003909
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00003910 if (C.kind == CXCursor_MacroExpansion) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003911 SourceLocation L
Chandler Carruth9e5bb852011-07-14 08:20:46 +00003912 = cxcursor::getCursorMacroExpansion(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00003913 return cxloc::translateSourceLocation(getCursorContext(C), L);
3914 }
Douglas Gregor572feb22010-03-18 18:04:21 +00003915
3916 if (C.kind == CXCursor_MacroDefinition) {
3917 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
3918 return cxloc::translateSourceLocation(getCursorContext(C), L);
3919 }
Douglas Gregorecdcb882010-10-20 22:00:55 +00003920
3921 if (C.kind == CXCursor_InclusionDirective) {
3922 SourceLocation L
3923 = cxcursor::getCursorInclusionDirective(C)->getSourceRange().getBegin();
3924 return cxloc::translateSourceLocation(getCursorContext(C), L);
3925 }
3926
Ted Kremenek9a700d22010-05-12 06:16:13 +00003927 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00003928 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00003929
Douglas Gregorf46034a2010-01-18 23:41:10 +00003930 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00003931 SourceLocation Loc = D->getLocation();
Ted Kremenek007a7c92010-11-01 23:26:51 +00003932 // FIXME: Multiple variables declared in a single declaration
3933 // currently lack the information needed to correctly determine their
3934 // ranges when accounting for the type-specifier. We use context
3935 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
3936 // and if so, whether it is the first decl.
3937 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
3938 if (!cxcursor::isFirstInDeclGroup(C))
3939 Loc = VD->getLocation();
3940 }
3941
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00003942 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00003943}
Douglas Gregora7bde202010-01-19 00:34:46 +00003944
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003945} // end extern "C"
3946
Argyrios Kyrtzidis671436e2011-09-27 00:30:33 +00003947CXCursor cxcursor::getCursor(CXTranslationUnit TU, SourceLocation SLoc) {
3948 assert(TU);
3949
3950 // Guard against an invalid SourceLocation, or we may assert in one
3951 // of the following calls.
3952 if (SLoc.isInvalid())
3953 return clang_getNullCursor();
3954
3955 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
3956
3957 // Translate the given source location to make it point at the beginning of
3958 // the token under the cursor.
3959 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
3960 CXXUnit->getASTContext().getLangOptions());
3961
3962 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
3963 if (SLoc.isValid()) {
3964 // FIXME: Would be great to have a "hint" cursor, then walk from that
3965 // hint cursor upward until we find a cursor whose source range encloses
3966 // the region of interest, rather than starting from the translation unit.
3967 GetCursorData ResultData(CXXUnit->getSourceManager(), SLoc, Result);
3968 CXCursor Parent = clang_getTranslationUnitCursor(TU);
3969 CursorVisitor CursorVis(TU, GetCursorVisitor, &ResultData,
3970 /*VisitPreprocessorLast=*/true,
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00003971 /*VisitIncludedPreprocessingEntries=*/false,
Argyrios Kyrtzidis671436e2011-09-27 00:30:33 +00003972 SourceLocation(SLoc));
3973 CursorVis.VisitChildren(Parent);
3974 }
3975
3976 return Result;
3977}
3978
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003979static SourceRange getRawCursorExtent(CXCursor C) {
Douglas Gregora7bde202010-01-19 00:34:46 +00003980 if (clang_isReference(C.kind)) {
3981 switch (C.kind) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003982 case CXCursor_ObjCSuperClassRef:
3983 return getCursorObjCSuperClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003984
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003985 case CXCursor_ObjCProtocolRef:
3986 return getCursorObjCProtocolRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003987
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003988 case CXCursor_ObjCClassRef:
3989 return getCursorObjCClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003990
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003991 case CXCursor_TypeRef:
3992 return getCursorTypeRef(C).second;
Douglas Gregor0b36e612010-08-31 20:37:03 +00003993
3994 case CXCursor_TemplateRef:
3995 return getCursorTemplateRef(C).second;
3996
Douglas Gregor69319002010-08-31 23:48:11 +00003997 case CXCursor_NamespaceRef:
3998 return getCursorNamespaceRef(C).second;
Douglas Gregora67e03f2010-09-09 21:42:20 +00003999
4000 case CXCursor_MemberRef:
4001 return getCursorMemberRef(C).second;
4002
Ted Kremenek3064ef92010-08-27 21:34:58 +00004003 case CXCursor_CXXBaseSpecifier:
Douglas Gregor1b0f7af2010-10-02 19:51:13 +00004004 return getCursorCXXBaseSpecifier(C)->getSourceRange();
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00004005
Douglas Gregor36897b02010-09-10 00:22:18 +00004006 case CXCursor_LabelRef:
4007 return getCursorLabelRef(C).second;
4008
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004009 case CXCursor_OverloadedDeclRef:
4010 return getCursorOverloadedDeclRef(C).second;
4011
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004012 default:
4013 // FIXME: Need a way to enumerate all non-reference cases.
4014 llvm_unreachable("Missed a reference kind");
Douglas Gregora7bde202010-01-19 00:34:46 +00004015 }
4016 }
Douglas Gregor97b98722010-01-19 23:20:36 +00004017
4018 if (clang_isExpression(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004019 return getCursorExpr(C)->getSourceRange();
Douglas Gregor33e9abd2010-01-22 19:49:59 +00004020
4021 if (clang_isStatement(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004022 return getCursorStmt(C)->getSourceRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004023
Argyrios Kyrtzidis6639e922011-09-13 17:39:31 +00004024 if (clang_isAttribute(C.kind))
4025 return getCursorAttr(C)->getRange();
4026
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004027 if (C.kind == CXCursor_PreprocessingDirective)
4028 return cxcursor::getCursorPreprocessingDirective(C);
Douglas Gregor48072312010-03-18 15:23:44 +00004029
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004030 if (C.kind == CXCursor_MacroExpansion) {
4031 ASTUnit *TU = getCursorASTUnit(C);
4032 SourceRange Range = cxcursor::getCursorMacroExpansion(C)->getSourceRange();
4033 return TU->mapRangeFromPreamble(Range);
4034 }
Douglas Gregor572feb22010-03-18 18:04:21 +00004035
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004036 if (C.kind == CXCursor_MacroDefinition) {
4037 ASTUnit *TU = getCursorASTUnit(C);
4038 SourceRange Range = cxcursor::getCursorMacroDefinition(C)->getSourceRange();
4039 return TU->mapRangeFromPreamble(Range);
4040 }
Douglas Gregorecdcb882010-10-20 22:00:55 +00004041
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004042 if (C.kind == CXCursor_InclusionDirective) {
4043 ASTUnit *TU = getCursorASTUnit(C);
4044 SourceRange Range = cxcursor::getCursorInclusionDirective(C)->getSourceRange();
4045 return TU->mapRangeFromPreamble(Range);
4046 }
Douglas Gregorecdcb882010-10-20 22:00:55 +00004047
Ted Kremenek007a7c92010-11-01 23:26:51 +00004048 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
4049 Decl *D = cxcursor::getCursorDecl(C);
4050 SourceRange R = D->getSourceRange();
4051 // FIXME: Multiple variables declared in a single declaration
4052 // currently lack the information needed to correctly determine their
4053 // ranges when accounting for the type-specifier. We use context
4054 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
4055 // and if so, whether it is the first decl.
4056 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
4057 if (!cxcursor::isFirstInDeclGroup(C))
4058 R.setBegin(VD->getLocation());
4059 }
4060 return R;
4061 }
Douglas Gregor66537982010-11-17 17:14:07 +00004062 return SourceRange();
4063}
4064
4065/// \brief Retrieves the "raw" cursor extent, which is then extended to include
4066/// the decl-specifier-seq for declarations.
4067static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) {
4068 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl) {
4069 Decl *D = cxcursor::getCursorDecl(C);
4070 SourceRange R = D->getSourceRange();
Douglas Gregor66537982010-11-17 17:14:07 +00004071
Douglas Gregor2494dd02011-03-01 01:34:45 +00004072 // Adjust the start of the location for declarations preceded by
4073 // declaration specifiers.
4074 SourceLocation StartLoc;
4075 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
4076 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
4077 StartLoc = TI->getTypeLoc().getSourceRange().getBegin();
4078 } else if (TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
4079 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
4080 StartLoc = TI->getTypeLoc().getSourceRange().getBegin();
4081 }
4082
4083 if (StartLoc.isValid() && R.getBegin().isValid() &&
4084 SrcMgr.isBeforeInTranslationUnit(StartLoc, R.getBegin()))
4085 R.setBegin(StartLoc);
4086
4087 // FIXME: Multiple variables declared in a single declaration
4088 // currently lack the information needed to correctly determine their
4089 // ranges when accounting for the type-specifier. We use context
4090 // stored in the CXCursor to determine if the VarDecl is in a DeclGroup,
4091 // and if so, whether it is the first decl.
4092 if (VarDecl *VD = dyn_cast<VarDecl>(D)) {
4093 if (!cxcursor::isFirstInDeclGroup(C))
4094 R.setBegin(VD->getLocation());
Douglas Gregor66537982010-11-17 17:14:07 +00004095 }
4096
4097 return R;
4098 }
4099
4100 return getRawCursorExtent(C);
4101}
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004102
4103extern "C" {
4104
4105CXSourceRange clang_getCursorExtent(CXCursor C) {
4106 SourceRange R = getRawCursorExtent(C);
4107 if (R.isInvalid())
Douglas Gregor5352ac02010-01-28 00:27:43 +00004108 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004109
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00004110 return cxloc::translateSourceRange(getCursorContext(C), R);
Douglas Gregora7bde202010-01-19 00:34:46 +00004111}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004112
4113CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00004114 if (clang_isInvalid(C.kind))
4115 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004116
Ted Kremeneka60ed472010-11-16 08:15:36 +00004117 CXTranslationUnit tu = getCursorTU(C);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004118 if (clang_isDeclaration(C.kind)) {
4119 Decl *D = getCursorDecl(C);
4120 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004121 return MakeCursorOverloadedDeclRef(Using, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004122 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004123 return MakeCursorOverloadedDeclRef(Classes, D->getLocation(), tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004124 if (ObjCForwardProtocolDecl *Protocols
4125 = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004126 return MakeCursorOverloadedDeclRef(Protocols, D->getLocation(), tu);
Chris Lattner5f9e2722011-07-23 10:55:15 +00004127 if (ObjCPropertyImplDecl *PropImpl =dyn_cast<ObjCPropertyImplDecl>(D))
Douglas Gregore3c60a72010-11-17 00:13:31 +00004128 if (ObjCPropertyDecl *Property = PropImpl->getPropertyDecl())
4129 return MakeCXCursor(Property, tu);
4130
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004131 return C;
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004132 }
4133
Douglas Gregor97b98722010-01-19 23:20:36 +00004134 if (clang_isExpression(C.kind)) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004135 Expr *E = getCursorExpr(C);
4136 Decl *D = getDeclFromExpr(E);
Argyrios Kyrtzidisaed123e2011-10-06 07:00:54 +00004137 if (D) {
4138 CXCursor declCursor = MakeCXCursor(D, tu);
4139 declCursor = getSelectorIdentifierCursor(getSelectorIdentifierIndex(C),
4140 declCursor);
4141 return declCursor;
4142 }
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004143
4144 if (OverloadExpr *Ovl = dyn_cast_or_null<OverloadExpr>(E))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004145 return MakeCursorOverloadedDeclRef(Ovl, tu);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004146
Douglas Gregor97b98722010-01-19 23:20:36 +00004147 return clang_getNullCursor();
4148 }
4149
Douglas Gregor36897b02010-09-10 00:22:18 +00004150 if (clang_isStatement(C.kind)) {
4151 Stmt *S = getCursorStmt(C);
4152 if (GotoStmt *Goto = dyn_cast_or_null<GotoStmt>(S))
Ted Kremenek37c2e962011-03-15 23:47:49 +00004153 if (LabelDecl *label = Goto->getLabel())
4154 if (LabelStmt *labelS = label->getStmt())
4155 return MakeCXCursor(labelS, getCursorDecl(C), tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00004156
4157 return clang_getNullCursor();
4158 }
4159
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00004160 if (C.kind == CXCursor_MacroExpansion) {
Chandler Carruth9e5bb852011-07-14 08:20:46 +00004161 if (MacroDefinition *Def = getCursorMacroExpansion(C)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004162 return MakeMacroDefinitionCursor(Def, tu);
Douglas Gregorbf7efa22010-03-18 18:23:03 +00004163 }
4164
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004165 if (!clang_isReference(C.kind))
4166 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004167
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004168 switch (C.kind) {
4169 case CXCursor_ObjCSuperClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004170 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004171
4172 case CXCursor_ObjCProtocolRef: {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004173 return MakeCXCursor(getCursorObjCProtocolRef(C).first, tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004174
4175 case CXCursor_ObjCClassRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004176 return MakeCXCursor(getCursorObjCClassRef(C).first, tu );
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00004177
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004178 case CXCursor_TypeRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004179 return MakeCXCursor(getCursorTypeRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00004180
4181 case CXCursor_TemplateRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004182 return MakeCXCursor(getCursorTemplateRef(C).first, tu );
Douglas Gregor0b36e612010-08-31 20:37:03 +00004183
Douglas Gregor69319002010-08-31 23:48:11 +00004184 case CXCursor_NamespaceRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004185 return MakeCXCursor(getCursorNamespaceRef(C).first, tu );
Douglas Gregor69319002010-08-31 23:48:11 +00004186
Douglas Gregora67e03f2010-09-09 21:42:20 +00004187 case CXCursor_MemberRef:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004188 return MakeCXCursor(getCursorMemberRef(C).first, tu );
Douglas Gregora67e03f2010-09-09 21:42:20 +00004189
Ted Kremenek3064ef92010-08-27 21:34:58 +00004190 case CXCursor_CXXBaseSpecifier: {
4191 CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
4192 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004193 tu ));
Ted Kremenek3064ef92010-08-27 21:34:58 +00004194 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004195
Douglas Gregor36897b02010-09-10 00:22:18 +00004196 case CXCursor_LabelRef:
4197 // FIXME: We end up faking the "parent" declaration here because we
4198 // don't want to make CXCursor larger.
4199 return MakeCXCursor(getCursorLabelRef(C).first,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004200 static_cast<ASTUnit*>(tu->TUData)->getASTContext()
4201 .getTranslationUnitDecl(),
4202 tu);
Douglas Gregor36897b02010-09-10 00:22:18 +00004203
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004204 case CXCursor_OverloadedDeclRef:
4205 return C;
4206
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004207 default:
4208 // We would prefer to enumerate all non-reference cursor kinds here.
4209 llvm_unreachable("Unhandled reference cursor kind");
4210 break;
4211 }
4212 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004213
Douglas Gregorc5d1e932010-01-19 01:20:04 +00004214 return clang_getNullCursor();
4215}
4216
Douglas Gregorb6998662010-01-19 19:34:47 +00004217CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00004218 if (clang_isInvalid(C.kind))
4219 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004220
Ted Kremeneka60ed472010-11-16 08:15:36 +00004221 CXTranslationUnit TU = getCursorTU(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004222
Douglas Gregorb6998662010-01-19 19:34:47 +00004223 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00004224 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00004225 C = clang_getCursorReferenced(C);
4226 WasReference = true;
4227 }
4228
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00004229 if (C.kind == CXCursor_MacroExpansion)
Douglas Gregorbf7efa22010-03-18 18:23:03 +00004230 return clang_getCursorReferenced(C);
4231
Douglas Gregorb6998662010-01-19 19:34:47 +00004232 if (!clang_isDeclaration(C.kind))
4233 return clang_getNullCursor();
4234
4235 Decl *D = getCursorDecl(C);
4236 if (!D)
4237 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004238
Douglas Gregorb6998662010-01-19 19:34:47 +00004239 switch (D->getKind()) {
4240 // Declaration kinds that don't really separate the notions of
4241 // declaration and definition.
4242 case Decl::Namespace:
4243 case Decl::Typedef:
Richard Smith162e1c12011-04-15 14:24:37 +00004244 case Decl::TypeAlias:
Richard Smith3e4c6c42011-05-05 21:57:07 +00004245 case Decl::TypeAliasTemplate:
Douglas Gregorb6998662010-01-19 19:34:47 +00004246 case Decl::TemplateTypeParm:
4247 case Decl::EnumConstant:
4248 case Decl::Field:
Benjamin Kramerd9811462010-11-21 14:11:41 +00004249 case Decl::IndirectField:
Douglas Gregorb6998662010-01-19 19:34:47 +00004250 case Decl::ObjCIvar:
4251 case Decl::ObjCAtDefsField:
4252 case Decl::ImplicitParam:
4253 case Decl::ParmVar:
4254 case Decl::NonTypeTemplateParm:
4255 case Decl::TemplateTemplateParm:
4256 case Decl::ObjCCategoryImpl:
4257 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00004258 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00004259 case Decl::LinkageSpec:
4260 case Decl::ObjCPropertyImpl:
4261 case Decl::FileScopeAsm:
4262 case Decl::StaticAssert:
4263 case Decl::Block:
Chris Lattnerad8dcf42011-02-17 07:39:24 +00004264 case Decl::Label: // FIXME: Is this right??
Francois Pichetaf0f4d02011-08-14 03:52:19 +00004265 case Decl::ClassScopeFunctionSpecialization:
Douglas Gregorb6998662010-01-19 19:34:47 +00004266 return C;
4267
4268 // Declaration kinds that don't make any sense here, but are
4269 // nonetheless harmless.
4270 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00004271 break;
4272
4273 // Declaration kinds for which the definition is not resolvable.
4274 case Decl::UnresolvedUsingTypename:
4275 case Decl::UnresolvedUsingValue:
4276 break;
4277
4278 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00004279 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004280 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004281
4282 case Decl::NamespaceAlias:
Ted Kremeneka60ed472010-11-16 08:15:36 +00004283 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004284
4285 case Decl::Enum:
4286 case Decl::Record:
4287 case Decl::CXXRecord:
4288 case Decl::ClassTemplateSpecialization:
4289 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00004290 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004291 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004292 return clang_getNullCursor();
4293
4294 case Decl::Function:
4295 case Decl::CXXMethod:
4296 case Decl::CXXConstructor:
4297 case Decl::CXXDestructor:
4298 case Decl::CXXConversion: {
4299 const FunctionDecl *Def = 0;
4300 if (cast<FunctionDecl>(D)->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004301 return MakeCXCursor(const_cast<FunctionDecl *>(Def), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004302 return clang_getNullCursor();
4303 }
4304
4305 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00004306 // Ask the variable if it has a definition.
4307 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004308 return MakeCXCursor(Def, TU);
Sebastian Redl31310a22010-02-01 20:16:42 +00004309 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00004310 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004311
Douglas Gregorb6998662010-01-19 19:34:47 +00004312 case Decl::FunctionTemplate: {
4313 const FunctionDecl *Def = 0;
4314 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004315 return MakeCXCursor(Def->getDescribedFunctionTemplate(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004316 return clang_getNullCursor();
4317 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004318
Douglas Gregorb6998662010-01-19 19:34:47 +00004319 case Decl::ClassTemplate: {
4320 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00004321 ->getDefinition())
Douglas Gregor0b36e612010-08-31 20:37:03 +00004322 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004323 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004324 return clang_getNullCursor();
4325 }
4326
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004327 case Decl::Using:
4328 return MakeCursorOverloadedDeclRef(cast<UsingDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004329 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004330
4331 case Decl::UsingShadow:
4332 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004333 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004334 TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00004335
4336 case Decl::ObjCMethod: {
4337 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
4338 if (Method->isThisDeclarationADefinition())
4339 return C;
4340
4341 // Dig out the method definition in the associated
4342 // @implementation, if we have it.
4343 // FIXME: The ASTs should make finding the definition easier.
4344 if (ObjCInterfaceDecl *Class
4345 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
4346 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
4347 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
4348 Method->isInstanceMethod()))
4349 if (Def->isThisDeclarationADefinition())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004350 return MakeCXCursor(Def, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004351
4352 return clang_getNullCursor();
4353 }
4354
4355 case Decl::ObjCCategory:
4356 if (ObjCCategoryImplDecl *Impl
4357 = cast<ObjCCategoryDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004358 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004359 return clang_getNullCursor();
4360
4361 case Decl::ObjCProtocol:
4362 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
4363 return C;
4364 return clang_getNullCursor();
4365
4366 case Decl::ObjCInterface:
4367 // There are two notions of a "definition" for an Objective-C
4368 // class: the interface and its implementation. When we resolved a
4369 // reference to an Objective-C class, produce the @interface as
4370 // the definition; when we were provided with the interface,
4371 // produce the @implementation as the definition.
4372 if (WasReference) {
4373 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
4374 return C;
4375 } else if (ObjCImplementationDecl *Impl
4376 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004377 return MakeCXCursor(Impl, TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004378 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004379
Douglas Gregorb6998662010-01-19 19:34:47 +00004380 case Decl::ObjCProperty:
4381 // FIXME: We don't really know where to find the
4382 // ObjCPropertyImplDecls that implement this property.
4383 return clang_getNullCursor();
4384
4385 case Decl::ObjCCompatibleAlias:
4386 if (ObjCInterfaceDecl *Class
4387 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
4388 if (!Class->isForwardDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004389 return MakeCXCursor(Class, TU);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004390
Douglas Gregorb6998662010-01-19 19:34:47 +00004391 return clang_getNullCursor();
4392
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004393 case Decl::ObjCForwardProtocol:
4394 return MakeCursorOverloadedDeclRef(cast<ObjCForwardProtocolDecl>(D),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004395 D->getLocation(), TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004396
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004397 case Decl::ObjCClass:
Daniel Dunbar9e1ebdd2010-11-05 07:19:21 +00004398 return MakeCursorOverloadedDeclRef(cast<ObjCClassDecl>(D), D->getLocation(),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004399 TU);
Douglas Gregorb6998662010-01-19 19:34:47 +00004400
4401 case Decl::Friend:
4402 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004403 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00004404 return clang_getNullCursor();
4405
4406 case Decl::FriendTemplate:
4407 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004408 return clang_getCursorDefinition(MakeCXCursor(Friend, TU));
Douglas Gregorb6998662010-01-19 19:34:47 +00004409 return clang_getNullCursor();
4410 }
4411
4412 return clang_getNullCursor();
4413}
4414
4415unsigned clang_isCursorDefinition(CXCursor C) {
4416 if (!clang_isDeclaration(C.kind))
4417 return 0;
4418
4419 return clang_getCursorDefinition(C) == C;
4420}
4421
Douglas Gregor1a9d0502010-11-19 23:44:15 +00004422CXCursor clang_getCanonicalCursor(CXCursor C) {
4423 if (!clang_isDeclaration(C.kind))
4424 return C;
4425
Argyrios Kyrtzidise2f854d2011-07-15 22:27:18 +00004426 if (Decl *D = getCursorDecl(C)) {
Argyrios Kyrtzidisdebb00f2011-07-15 22:37:58 +00004427 if (ObjCCategoryImplDecl *CatImplD = dyn_cast<ObjCCategoryImplDecl>(D))
4428 if (ObjCCategoryDecl *CatD = CatImplD->getCategoryDecl())
4429 return MakeCXCursor(CatD, getCursorTU(C));
4430
Argyrios Kyrtzidise2f854d2011-07-15 22:27:18 +00004431 if (ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
4432 if (ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
4433 return MakeCXCursor(IFD, getCursorTU(C));
4434
Douglas Gregor1a9d0502010-11-19 23:44:15 +00004435 return MakeCXCursor(D->getCanonicalDecl(), getCursorTU(C));
Argyrios Kyrtzidise2f854d2011-07-15 22:27:18 +00004436 }
Douglas Gregor1a9d0502010-11-19 23:44:15 +00004437
4438 return C;
4439}
4440
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004441unsigned clang_getNumOverloadedDecls(CXCursor C) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00004442 if (C.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004443 return 0;
4444
4445 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(C).first;
4446 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
4447 return E->getNumDecls();
4448
4449 if (OverloadedTemplateStorage *S
4450 = Storage.dyn_cast<OverloadedTemplateStorage*>())
4451 return S->size();
4452
4453 Decl *D = Storage.get<Decl*>();
4454 if (UsingDecl *Using = dyn_cast<UsingDecl>(D))
Argyrios Kyrtzidis826faa22010-11-10 05:40:41 +00004455 return Using->shadow_size();
Fariborz Jahanian95ed7782011-08-27 20:50:59 +00004456 if (isa<ObjCClassDecl>(D))
4457 return 1;
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004458 if (ObjCForwardProtocolDecl *Protocols =dyn_cast<ObjCForwardProtocolDecl>(D))
4459 return Protocols->protocol_size();
4460
4461 return 0;
4462}
4463
4464CXCursor clang_getOverloadedDecl(CXCursor cursor, unsigned index) {
Douglas Gregor7c432dd2010-09-16 13:54:00 +00004465 if (cursor.kind != CXCursor_OverloadedDeclRef)
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004466 return clang_getNullCursor();
4467
4468 if (index >= clang_getNumOverloadedDecls(cursor))
4469 return clang_getNullCursor();
4470
Ted Kremeneka60ed472010-11-16 08:15:36 +00004471 CXTranslationUnit TU = getCursorTU(cursor);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004472 OverloadedDeclRefStorage Storage = getCursorOverloadedDeclRef(cursor).first;
4473 if (OverloadExpr *E = Storage.dyn_cast<OverloadExpr *>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004474 return MakeCXCursor(E->decls_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004475
4476 if (OverloadedTemplateStorage *S
4477 = Storage.dyn_cast<OverloadedTemplateStorage*>())
Ted Kremeneka60ed472010-11-16 08:15:36 +00004478 return MakeCXCursor(S->begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004479
4480 Decl *D = Storage.get<Decl*>();
4481 if (UsingDecl *Using = dyn_cast<UsingDecl>(D)) {
4482 // FIXME: This is, unfortunately, linear time.
4483 UsingDecl::shadow_iterator Pos = Using->shadow_begin();
4484 std::advance(Pos, index);
Ted Kremeneka60ed472010-11-16 08:15:36 +00004485 return MakeCXCursor(cast<UsingShadowDecl>(*Pos)->getTargetDecl(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004486 }
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004487 if (ObjCClassDecl *Classes = dyn_cast<ObjCClassDecl>(D))
Fariborz Jahanian95ed7782011-08-27 20:50:59 +00004488 return MakeCXCursor(Classes->getForwardInterfaceDecl(), TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004489 if (ObjCForwardProtocolDecl *Protocols = dyn_cast<ObjCForwardProtocolDecl>(D))
Ted Kremeneka60ed472010-11-16 08:15:36 +00004490 return MakeCXCursor(Protocols->protocol_begin()[index], TU);
Douglas Gregor1f60d9e2010-09-13 22:52:57 +00004491
4492 return clang_getNullCursor();
4493}
4494
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00004495void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00004496 const char **startBuf,
4497 const char **endBuf,
4498 unsigned *startLine,
4499 unsigned *startColumn,
4500 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00004501 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00004502 assert(getCursorDecl(C) && "CXCursor has null decl");
4503 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00004504 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
4505 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004506
Steve Naroff4ade6d62009-09-23 17:52:52 +00004507 SourceManager &SM = FD->getASTContext().getSourceManager();
4508 *startBuf = SM.getCharacterData(Body->getLBracLoc());
4509 *endBuf = SM.getCharacterData(Body->getRBracLoc());
4510 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
4511 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
4512 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
4513 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
4514}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004515
Douglas Gregor430d7a12011-07-25 17:48:11 +00004516
4517CXSourceRange clang_getCursorReferenceNameRange(CXCursor C, unsigned NameFlags,
4518 unsigned PieceIndex) {
4519 RefNamePieces Pieces;
4520
4521 switch (C.kind) {
4522 case CXCursor_MemberRefExpr:
4523 if (MemberExpr *E = dyn_cast<MemberExpr>(getCursorExpr(C)))
4524 Pieces = buildPieces(NameFlags, true, E->getMemberNameInfo(),
4525 E->getQualifierLoc().getSourceRange());
4526 break;
4527
4528 case CXCursor_DeclRefExpr:
4529 if (DeclRefExpr *E = dyn_cast<DeclRefExpr>(getCursorExpr(C)))
4530 Pieces = buildPieces(NameFlags, false, E->getNameInfo(),
4531 E->getQualifierLoc().getSourceRange(),
4532 E->getExplicitTemplateArgsOpt());
4533 break;
4534
4535 case CXCursor_CallExpr:
4536 if (CXXOperatorCallExpr *OCE =
4537 dyn_cast<CXXOperatorCallExpr>(getCursorExpr(C))) {
4538 Expr *Callee = OCE->getCallee();
4539 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(Callee))
4540 Callee = ICE->getSubExpr();
4541
4542 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Callee))
4543 Pieces = buildPieces(NameFlags, false, DRE->getNameInfo(),
4544 DRE->getQualifierLoc().getSourceRange());
4545 }
4546 break;
4547
4548 default:
4549 break;
4550 }
4551
4552 if (Pieces.empty()) {
4553 if (PieceIndex == 0)
4554 return clang_getCursorExtent(C);
4555 } else if (PieceIndex < Pieces.size()) {
4556 SourceRange R = Pieces[PieceIndex];
4557 if (R.isValid())
4558 return cxloc::translateSourceRange(getCursorContext(C), R);
4559 }
4560
4561 return clang_getNullRange();
4562}
4563
Douglas Gregor0a812cf2010-02-18 23:07:20 +00004564void clang_enableStackTraces(void) {
4565 llvm::sys::PrintStackTraceOnErrorSignal();
4566}
4567
Daniel Dunbar995aaf92010-11-04 01:26:29 +00004568void clang_executeOnThread(void (*fn)(void*), void *user_data,
4569 unsigned stack_size) {
4570 llvm::llvm_execute_on_thread(fn, user_data, stack_size);
4571}
4572
Ted Kremenekfb480492010-01-13 21:46:36 +00004573} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00004574
Ted Kremenekfb480492010-01-13 21:46:36 +00004575//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004576// Token-based Operations.
4577//===----------------------------------------------------------------------===//
4578
4579/* CXToken layout:
4580 * int_data[0]: a CXTokenKind
4581 * int_data[1]: starting token location
4582 * int_data[2]: token length
4583 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004584 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004585 * otherwise unused.
4586 */
4587extern "C" {
4588
4589CXTokenKind clang_getTokenKind(CXToken CXTok) {
4590 return static_cast<CXTokenKind>(CXTok.int_data[0]);
4591}
4592
4593CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
4594 switch (clang_getTokenKind(CXTok)) {
4595 case CXToken_Identifier:
4596 case CXToken_Keyword:
4597 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00004598 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
4599 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004600
4601 case CXToken_Literal: {
4602 // We have stashed the starting pointer in the ptr_data field. Use it.
4603 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Chris Lattner5f9e2722011-07-23 10:55:15 +00004604 return createCXString(StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004605 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004606
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004607 case CXToken_Punctuation:
4608 case CXToken_Comment:
4609 break;
4610 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004611
4612 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004613 // deconstructing the source location.
Ted Kremeneka60ed472010-11-16 08:15:36 +00004614 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004615 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00004616 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004617
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004618 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
4619 std::pair<FileID, unsigned> LocInfo
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004620 = CXXUnit->getSourceManager().getDecomposedSpellingLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00004621 bool Invalid = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +00004622 StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00004623 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
4624 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00004625 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004626
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00004627 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004628}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004629
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004630CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004631 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004632 if (!CXXUnit)
4633 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004634
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004635 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
4636 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
4637}
4638
4639CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004640 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor5352ac02010-01-28 00:27:43 +00004641 if (!CXXUnit)
4642 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004643
4644 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004645 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
4646}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004647
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004648static void getTokens(ASTUnit *CXXUnit, SourceRange Range,
4649 SmallVectorImpl<CXToken> &CXTokens) {
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004650 SourceManager &SourceMgr = CXXUnit->getSourceManager();
4651 std::pair<FileID, unsigned> BeginLocInfo
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004652 = SourceMgr.getDecomposedLoc(Range.getBegin());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004653 std::pair<FileID, unsigned> EndLocInfo
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004654 = SourceMgr.getDecomposedLoc(Range.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004655
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004656 // Cannot tokenize across files.
4657 if (BeginLocInfo.first != EndLocInfo.first)
4658 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004659
4660 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00004661 bool Invalid = false;
Chris Lattner5f9e2722011-07-23 10:55:15 +00004662 StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00004663 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00004664 if (Invalid)
4665 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00004666
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004667 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
4668 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00004669 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004670 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004671
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004672 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00004673 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004674 Token Tok;
David Chisnall096428b2010-10-13 21:44:48 +00004675 bool previousWasAt = false;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004676 do {
4677 // Lex the next token
4678 Lex.LexFromRawLexer(Tok);
4679 if (Tok.is(tok::eof))
4680 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004681
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004682 // Initialize the CXToken.
4683 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004684
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004685 // - Common fields
4686 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
4687 CXTok.int_data[2] = Tok.getLength();
4688 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004689
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004690 // - Kind-specific fields
4691 if (Tok.isLiteral()) {
4692 CXTok.int_data[0] = CXToken_Literal;
4693 CXTok.ptr_data = (void *)Tok.getLiteralData();
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004694 } else if (Tok.is(tok::raw_identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00004695 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004696 IdentifierInfo *II
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004697 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004698
David Chisnall096428b2010-10-13 21:44:48 +00004699 if ((II->getObjCKeywordID() != tok::objc_not_keyword) && previousWasAt) {
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004700 CXTok.int_data[0] = CXToken_Keyword;
4701 }
4702 else {
Abramo Bagnarac4bf2b92010-12-22 08:23:18 +00004703 CXTok.int_data[0] = Tok.is(tok::identifier)
4704 ? CXToken_Identifier
4705 : CXToken_Keyword;
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00004706 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004707 CXTok.ptr_data = II;
4708 } else if (Tok.is(tok::comment)) {
4709 CXTok.int_data[0] = CXToken_Comment;
4710 CXTok.ptr_data = 0;
4711 } else {
4712 CXTok.int_data[0] = CXToken_Punctuation;
4713 CXTok.ptr_data = 0;
4714 }
4715 CXTokens.push_back(CXTok);
David Chisnall096428b2010-10-13 21:44:48 +00004716 previousWasAt = Tok.is(tok::at);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004717 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00004718}
4719
4720void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
4721 CXToken **Tokens, unsigned *NumTokens) {
4722 if (Tokens)
4723 *Tokens = 0;
4724 if (NumTokens)
4725 *NumTokens = 0;
4726
4727 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
4728 if (!CXXUnit || !Tokens || !NumTokens)
4729 return;
4730
4731 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
4732
4733 SourceRange R = cxloc::translateCXSourceRange(Range);
4734 if (R.isInvalid())
4735 return;
4736
4737 SmallVector<CXToken, 32> CXTokens;
4738 getTokens(CXXUnit, R, CXTokens);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004739
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004740 if (CXTokens.empty())
4741 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00004742
Douglas Gregorfc8ea232010-01-26 17:06:03 +00004743 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
4744 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
4745 *NumTokens = CXTokens.size();
4746}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004747
Ted Kremenek6db61092010-05-05 00:55:15 +00004748void clang_disposeTokens(CXTranslationUnit TU,
4749 CXToken *Tokens, unsigned NumTokens) {
4750 free(Tokens);
4751}
4752
4753} // end: extern "C"
4754
4755//===----------------------------------------------------------------------===//
4756// Token annotation APIs.
4757//===----------------------------------------------------------------------===//
4758
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004759typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004760static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
4761 CXCursor parent,
4762 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00004763namespace {
4764class AnnotateTokensWorker {
4765 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004766 CXToken *Tokens;
4767 CXCursor *Cursors;
4768 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004769 unsigned TokIdx;
Douglas Gregor4419b672010-10-21 06:10:04 +00004770 unsigned PreprocessingTokIdx;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004771 CursorVisitor AnnotateVis;
4772 SourceManager &SrcMgr;
Douglas Gregorf5251602011-03-08 17:10:18 +00004773 bool HasContextSensitiveKeywords;
4774
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004775 bool MoreTokens() const { return TokIdx < NumTokens; }
4776 unsigned NextToken() const { return TokIdx; }
4777 void AdvanceToken() { ++TokIdx; }
4778 SourceLocation GetTokenLoc(unsigned tokI) {
4779 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
4780 }
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004781 bool isFunctionMacroToken(unsigned tokI) const {
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004782 return Tokens[tokI].int_data[3] != 0;
4783 }
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004784 SourceLocation getFunctionMacroTokenLoc(unsigned tokI) const {
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004785 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[3]);
4786 }
4787
4788 void annotateAndAdvanceTokens(CXCursor, RangeComparisonResult, SourceRange);
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004789 void annotateAndAdvanceFunctionMacroTokens(CXCursor, RangeComparisonResult,
4790 SourceRange);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004791
Ted Kremenek6db61092010-05-05 00:55:15 +00004792public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00004793 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004794 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
Ted Kremeneka60ed472010-11-16 08:15:36 +00004795 CXTranslationUnit tu, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00004796 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Douglas Gregor4419b672010-10-21 06:10:04 +00004797 NumTokens(numTokens), TokIdx(0), PreprocessingTokIdx(0),
Ted Kremeneka60ed472010-11-16 08:15:36 +00004798 AnnotateVis(tu,
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00004799 AnnotateTokensVisitor, this,
4800 /*VisitPreprocessorLast=*/true,
4801 /*VisitIncludedPreprocessingEntries=*/false,
4802 RegionOfInterest),
Douglas Gregorf5251602011-03-08 17:10:18 +00004803 SrcMgr(static_cast<ASTUnit*>(tu->TUData)->getSourceManager()),
4804 HasContextSensitiveKeywords(false) { }
Ted Kremenek11949cb2010-05-05 00:55:17 +00004805
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004806 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00004807 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004808 void AnnotateTokens(CXCursor parent);
Ted Kremenekab979612010-11-11 08:05:23 +00004809 void AnnotateTokens() {
Ted Kremeneka60ed472010-11-16 08:15:36 +00004810 AnnotateTokens(clang_getTranslationUnitCursor(AnnotateVis.getTU()));
Ted Kremenekab979612010-11-11 08:05:23 +00004811 }
Douglas Gregorf5251602011-03-08 17:10:18 +00004812
4813 /// \brief Determine whether the annotator saw any cursors that have
4814 /// context-sensitive keywords.
4815 bool hasContextSensitiveKeywords() const {
4816 return HasContextSensitiveKeywords;
4817 }
Ted Kremenek6db61092010-05-05 00:55:15 +00004818};
4819}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00004820
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004821void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
4822 // Walk the AST within the region of interest, annotating tokens
4823 // along the way.
4824 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00004825
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004826 for (unsigned I = 0 ; I < TokIdx ; ++I) {
4827 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
Douglas Gregor4419b672010-10-21 06:10:04 +00004828 if (Pos != Annotated.end() &&
4829 (clang_isInvalid(Cursors[I].kind) ||
4830 Pos->second.kind != CXCursor_PreprocessingDirective))
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004831 Cursors[I] = Pos->second;
4832 }
4833
4834 // Finish up annotating any tokens left.
4835 if (!MoreTokens())
4836 return;
4837
4838 const CXCursor &C = clang_getNullCursor();
4839 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
4840 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
4841 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00004842 }
4843}
4844
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004845/// \brief It annotates and advances tokens with a cursor until the comparison
4846//// between the cursor location and the source range is the same as
4847/// \arg compResult.
4848///
4849/// Pass RangeBefore to annotate tokens with a cursor until a range is reached.
4850/// Pass RangeOverlap to annotate tokens inside a range.
4851void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC,
4852 RangeComparisonResult compResult,
4853 SourceRange range) {
4854 while (MoreTokens()) {
4855 const unsigned I = NextToken();
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004856 if (isFunctionMacroToken(I))
4857 return annotateAndAdvanceFunctionMacroTokens(updateC, compResult, range);
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004858
4859 SourceLocation TokLoc = GetTokenLoc(I);
4860 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
4861 Cursors[I] = updateC;
4862 AdvanceToken();
4863 continue;
4864 }
4865 break;
4866 }
4867}
4868
4869/// \brief Special annotation handling for macro argument tokens.
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004870void AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens(
4871 CXCursor updateC,
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004872 RangeComparisonResult compResult,
4873 SourceRange range) {
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004874 assert(MoreTokens());
4875 assert(isFunctionMacroToken(NextToken()) &&
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004876 "Should be called only for macro arg tokens");
4877
4878 // This works differently than annotateAndAdvanceTokens; because expanded
4879 // macro arguments can have arbitrary translation-unit source order, we do not
4880 // advance the token index one by one until a token fails the range test.
4881 // We only advance once past all of the macro arg tokens if all of them
4882 // pass the range test. If one of them fails we keep the token index pointing
4883 // at the start of the macro arg tokens so that the failing token will be
4884 // annotated by a subsequent annotation try.
4885
4886 bool atLeastOneCompFail = false;
4887
4888 unsigned I = NextToken();
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00004889 for (; I < NumTokens && isFunctionMacroToken(I); ++I) {
4890 SourceLocation TokLoc = getFunctionMacroTokenLoc(I);
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00004891 if (TokLoc.isFileID())
4892 continue; // not macro arg token, it's parens or comma.
4893 if (LocationCompare(SrcMgr, TokLoc, range) == compResult) {
4894 if (clang_isInvalid(clang_getCursorKind(Cursors[I])))
4895 Cursors[I] = updateC;
4896 } else
4897 atLeastOneCompFail = true;
4898 }
4899
4900 if (!atLeastOneCompFail)
4901 TokIdx = I; // All of the tokens were handled, advance beyond all of them.
4902}
4903
Ted Kremenek6db61092010-05-05 00:55:15 +00004904enum CXChildVisitResult
Douglas Gregor4419b672010-10-21 06:10:04 +00004905AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00004906 CXSourceLocation Loc = clang_getCursorLocation(cursor);
Douglas Gregor4419b672010-10-21 06:10:04 +00004907 SourceRange cursorRange = getRawCursorExtent(cursor);
Douglas Gregor81d3c042010-11-01 20:13:04 +00004908 if (cursorRange.isInvalid())
4909 return CXChildVisit_Recurse;
Douglas Gregorf5251602011-03-08 17:10:18 +00004910
4911 if (!HasContextSensitiveKeywords) {
4912 // Objective-C properties can have context-sensitive keywords.
4913 if (cursor.kind == CXCursor_ObjCPropertyDecl) {
4914 if (ObjCPropertyDecl *Property
4915 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(cursor)))
4916 HasContextSensitiveKeywords = Property->getPropertyAttributesAsWritten() != 0;
4917 }
4918 // Objective-C methods can have context-sensitive keywords.
4919 else if (cursor.kind == CXCursor_ObjCInstanceMethodDecl ||
4920 cursor.kind == CXCursor_ObjCClassMethodDecl) {
4921 if (ObjCMethodDecl *Method
4922 = dyn_cast_or_null<ObjCMethodDecl>(getCursorDecl(cursor))) {
4923 if (Method->getObjCDeclQualifier())
4924 HasContextSensitiveKeywords = true;
4925 else {
4926 for (ObjCMethodDecl::param_iterator P = Method->param_begin(),
4927 PEnd = Method->param_end();
4928 P != PEnd; ++P) {
4929 if ((*P)->getObjCDeclQualifier()) {
4930 HasContextSensitiveKeywords = true;
4931 break;
4932 }
4933 }
4934 }
4935 }
4936 }
4937 // C++ methods can have context-sensitive keywords.
4938 else if (cursor.kind == CXCursor_CXXMethod) {
4939 if (CXXMethodDecl *Method
4940 = dyn_cast_or_null<CXXMethodDecl>(getCursorDecl(cursor))) {
4941 if (Method->hasAttr<FinalAttr>() || Method->hasAttr<OverrideAttr>())
4942 HasContextSensitiveKeywords = true;
4943 }
4944 }
4945 // C++ classes can have context-sensitive keywords.
4946 else if (cursor.kind == CXCursor_StructDecl ||
4947 cursor.kind == CXCursor_ClassDecl ||
4948 cursor.kind == CXCursor_ClassTemplate ||
4949 cursor.kind == CXCursor_ClassTemplatePartialSpecialization) {
4950 if (Decl *D = getCursorDecl(cursor))
4951 if (D->hasAttr<FinalAttr>())
4952 HasContextSensitiveKeywords = true;
4953 }
4954 }
4955
Douglas Gregor4419b672010-10-21 06:10:04 +00004956 if (clang_isPreprocessing(cursor.kind)) {
Chandler Carruthcea731a2011-07-14 16:07:57 +00004957 // For macro expansions, just note where the beginning of the macro
4958 // expansion occurs.
Chandler Carruth9b2a0ac2011-07-14 08:41:15 +00004959 if (cursor.kind == CXCursor_MacroExpansion) {
Douglas Gregor4419b672010-10-21 06:10:04 +00004960 Annotated[Loc.int_data] = cursor;
4961 return CXChildVisit_Recurse;
4962 }
4963
Douglas Gregor4419b672010-10-21 06:10:04 +00004964 // Items in the preprocessing record are kept separate from items in
4965 // declarations, so we keep a separate token index.
4966 unsigned SavedTokIdx = TokIdx;
4967 TokIdx = PreprocessingTokIdx;
4968
4969 // Skip tokens up until we catch up to the beginning of the preprocessing
4970 // entry.
4971 while (MoreTokens()) {
4972 const unsigned I = NextToken();
4973 SourceLocation TokLoc = GetTokenLoc(I);
4974 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4975 case RangeBefore:
4976 AdvanceToken();
4977 continue;
4978 case RangeAfter:
4979 case RangeOverlap:
4980 break;
4981 }
4982 break;
4983 }
4984
4985 // Look at all of the tokens within this range.
4986 while (MoreTokens()) {
4987 const unsigned I = NextToken();
4988 SourceLocation TokLoc = GetTokenLoc(I);
4989 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
4990 case RangeBefore:
David Blaikieb219cfc2011-09-23 05:06:16 +00004991 llvm_unreachable("Infeasible");
Douglas Gregor4419b672010-10-21 06:10:04 +00004992 case RangeAfter:
4993 break;
4994 case RangeOverlap:
4995 Cursors[I] = cursor;
4996 AdvanceToken();
4997 continue;
4998 }
4999 break;
5000 }
5001
5002 // Save the preprocessing token index; restore the non-preprocessing
5003 // token index.
5004 PreprocessingTokIdx = TokIdx;
5005 TokIdx = SavedTokIdx;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00005006 return CXChildVisit_Recurse;
5007 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005008
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005009 if (cursorRange.isInvalid())
5010 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00005011
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005012 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
5013
Ted Kremeneka333c662010-05-12 05:29:33 +00005014 // Adjust the annotated range based specific declarations.
5015 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
5016 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00005017 Decl *D = cxcursor::getCursorDecl(cursor);
Douglas Gregor2494dd02011-03-01 01:34:45 +00005018
5019 SourceLocation StartLoc;
Ted Kremenek23173d72010-05-18 21:09:07 +00005020 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Douglas Gregor2494dd02011-03-01 01:34:45 +00005021 if (TypeSourceInfo *TI = DD->getTypeSourceInfo())
5022 StartLoc = TI->getTypeLoc().getSourceRange().getBegin();
5023 } else if (TypedefDecl *Typedef = dyn_cast<TypedefDecl>(D)) {
5024 if (TypeSourceInfo *TI = Typedef->getTypeSourceInfo())
5025 StartLoc = TI->getTypeLoc().getSourceRange().getBegin();
Ted Kremeneka333c662010-05-12 05:29:33 +00005026 }
Douglas Gregor2494dd02011-03-01 01:34:45 +00005027
5028 if (StartLoc.isValid() && L.isValid() &&
5029 SrcMgr.isBeforeInTranslationUnit(StartLoc, L))
5030 cursorRange.setBegin(StartLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00005031 }
Douglas Gregor81d3c042010-11-01 20:13:04 +00005032
Ted Kremenek3f404602010-08-14 01:14:06 +00005033 // If the location of the cursor occurs within a macro instantiation, record
5034 // the spelling location of the cursor in our annotation map. We can then
5035 // paper over the token labelings during a post-processing step to try and
5036 // get cursor mappings for tokens that are the *arguments* of a macro
5037 // instantiation.
5038 if (L.isMacroID()) {
5039 unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
5040 // Only invalidate the old annotation if it isn't part of a preprocessing
5041 // directive. Here we assume that the default construction of CXCursor
5042 // results in CXCursor.kind being an initialized value (i.e., 0). If
5043 // this isn't the case, we can fix by doing lookup + insertion.
Douglas Gregor4419b672010-10-21 06:10:04 +00005044
Ted Kremenek3f404602010-08-14 01:14:06 +00005045 CXCursor &oldC = Annotated[rawEncoding];
5046 if (!clang_isPreprocessing(oldC.kind))
5047 oldC = cursor;
5048 }
5049
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005050 const enum CXCursorKind K = clang_getCursorKind(parent);
5051 const CXCursor updateC =
Ted Kremenekd8b0a842010-08-25 22:16:02 +00005052 (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
5053 ? clang_getNullCursor() : parent;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005054
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005055 annotateAndAdvanceTokens(updateC, RangeBefore, cursorRange);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005056
Argyrios Kyrtzidis5517b892011-06-27 19:42:20 +00005057 // Avoid having the cursor of an expression "overwrite" the annotation of the
5058 // variable declaration that it belongs to.
5059 // This can happen for C++ constructor expressions whose range generally
5060 // include the variable declaration, e.g.:
5061 // MyCXXClass foo; // Make sure we don't annotate 'foo' as a CallExpr cursor.
5062 if (clang_isExpression(cursorK)) {
5063 Expr *E = getCursorExpr(cursor);
Argyrios Kyrtzidis8ccac3d2011-06-29 22:20:07 +00005064 if (Decl *D = getCursorParentDecl(cursor)) {
Argyrios Kyrtzidis5517b892011-06-27 19:42:20 +00005065 const unsigned I = NextToken();
5066 if (E->getLocStart().isValid() && D->getLocation().isValid() &&
5067 E->getLocStart() == D->getLocation() &&
5068 E->getLocStart() == GetTokenLoc(I)) {
5069 Cursors[I] = updateC;
5070 AdvanceToken();
5071 }
5072 }
5073 }
5074
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005075 // Visit children to get their cursor information.
5076 const unsigned BeforeChildren = NextToken();
5077 VisitChildren(cursor);
5078 const unsigned AfterChildren = NextToken();
5079
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005080 // Scan the tokens that are at the end of the cursor, but are not captured
5081 // but the child cursors.
5082 annotateAndAdvanceTokens(cursor, RangeOverlap, cursorRange);
Ted Kremenek6db61092010-05-05 00:55:15 +00005083
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005084 // Scan the tokens that are at the beginning of the cursor, but are not
5085 // capture by the child cursors.
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005086 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
5087 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
5088 break;
Douglas Gregor4419b672010-10-21 06:10:04 +00005089
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005090 Cursors[I] = cursor;
5091 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005092
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005093 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00005094}
5095
Ted Kremenek6db61092010-05-05 00:55:15 +00005096static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
5097 CXCursor parent,
5098 CXClientData client_data) {
5099 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
5100}
5101
Ted Kremenek6628a612011-03-18 22:51:30 +00005102namespace {
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005103
5104/// \brief Uses the macro expansions in the preprocessing record to find
5105/// and mark tokens that are macro arguments. This info is used by the
5106/// AnnotateTokensWorker.
5107class MarkMacroArgTokensVisitor {
5108 SourceManager &SM;
5109 CXToken *Tokens;
5110 unsigned NumTokens;
5111 unsigned CurIdx;
5112
5113public:
5114 MarkMacroArgTokensVisitor(SourceManager &SM,
5115 CXToken *tokens, unsigned numTokens)
5116 : SM(SM), Tokens(tokens), NumTokens(numTokens), CurIdx(0) { }
5117
5118 CXChildVisitResult visit(CXCursor cursor, CXCursor parent) {
5119 if (cursor.kind != CXCursor_MacroExpansion)
5120 return CXChildVisit_Continue;
5121
5122 SourceRange macroRange = getCursorMacroExpansion(cursor)->getSourceRange();
5123 if (macroRange.getBegin() == macroRange.getEnd())
5124 return CXChildVisit_Continue; // it's not a function macro.
5125
5126 for (; CurIdx < NumTokens; ++CurIdx) {
5127 if (!SM.isBeforeInTranslationUnit(getTokenLoc(CurIdx),
5128 macroRange.getBegin()))
5129 break;
5130 }
5131
5132 if (CurIdx == NumTokens)
5133 return CXChildVisit_Break;
5134
5135 for (; CurIdx < NumTokens; ++CurIdx) {
5136 SourceLocation tokLoc = getTokenLoc(CurIdx);
5137 if (!SM.isBeforeInTranslationUnit(tokLoc, macroRange.getEnd()))
5138 break;
5139
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00005140 setFunctionMacroTokenLoc(CurIdx, SM.getMacroArgExpandedLocation(tokLoc));
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005141 }
5142
5143 if (CurIdx == NumTokens)
5144 return CXChildVisit_Break;
5145
5146 return CXChildVisit_Continue;
5147 }
5148
5149private:
5150 SourceLocation getTokenLoc(unsigned tokI) {
5151 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
5152 }
5153
Argyrios Kyrtzidis5f616b72011-08-30 19:43:19 +00005154 void setFunctionMacroTokenLoc(unsigned tokI, SourceLocation loc) {
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005155 // The third field is reserved and currently not used. Use it here
5156 // to mark macro arg expanded tokens with their expanded locations.
5157 Tokens[tokI].int_data[3] = loc.getRawEncoding();
5158 }
5159};
5160
5161} // end anonymous namespace
5162
5163static CXChildVisitResult
5164MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent,
5165 CXClientData client_data) {
5166 return static_cast<MarkMacroArgTokensVisitor*>(client_data)->visit(cursor,
5167 parent);
5168}
5169
5170namespace {
Ted Kremenek6628a612011-03-18 22:51:30 +00005171 struct clang_annotateTokens_Data {
5172 CXTranslationUnit TU;
5173 ASTUnit *CXXUnit;
5174 CXToken *Tokens;
5175 unsigned NumTokens;
5176 CXCursor *Cursors;
5177 };
5178}
5179
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00005180static void annotatePreprocessorTokens(CXTranslationUnit TU,
5181 SourceRange RegionOfInterest,
5182 AnnotateTokensData &Annotated) {
5183 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
5184
5185 SourceManager &SourceMgr = CXXUnit->getSourceManager();
5186 std::pair<FileID, unsigned> BeginLocInfo
5187 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
5188 std::pair<FileID, unsigned> EndLocInfo
5189 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
5190
5191 if (BeginLocInfo.first != EndLocInfo.first)
5192 return;
5193
5194 StringRef Buffer;
5195 bool Invalid = false;
5196 Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
5197 if (Buffer.empty() || Invalid)
5198 return;
5199
5200 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
5201 CXXUnit->getASTContext().getLangOptions(),
5202 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
5203 Buffer.end());
5204 Lex.SetCommentRetentionState(true);
5205
5206 // Lex tokens in raw mode until we hit the end of the range, to avoid
5207 // entering #includes or expanding macros.
5208 while (true) {
5209 Token Tok;
5210 Lex.LexFromRawLexer(Tok);
5211
5212 reprocess:
5213 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
5214 // We have found a preprocessing directive. Gobble it up so that we
5215 // don't see it while preprocessing these tokens later, but keep track
5216 // of all of the token locations inside this preprocessing directive so
5217 // that we can annotate them appropriately.
5218 //
5219 // FIXME: Some simple tests here could identify macro definitions and
5220 // #undefs, to provide specific cursor kinds for those.
5221 SmallVector<SourceLocation, 32> Locations;
5222 do {
5223 Locations.push_back(Tok.getLocation());
5224 Lex.LexFromRawLexer(Tok);
5225 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
5226
5227 using namespace cxcursor;
5228 CXCursor Cursor
5229 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
5230 Locations.back()),
5231 TU);
5232 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
5233 Annotated[Locations[I].getRawEncoding()] = Cursor;
5234 }
5235
5236 if (Tok.isAtStartOfLine())
5237 goto reprocess;
5238
5239 continue;
5240 }
5241
5242 if (Tok.is(tok::eof))
5243 break;
5244 }
5245}
5246
Ted Kremenekab979612010-11-11 08:05:23 +00005247// This gets run a separate thread to avoid stack blowout.
Ted Kremenek6628a612011-03-18 22:51:30 +00005248static void clang_annotateTokensImpl(void *UserData) {
5249 CXTranslationUnit TU = ((clang_annotateTokens_Data*)UserData)->TU;
5250 ASTUnit *CXXUnit = ((clang_annotateTokens_Data*)UserData)->CXXUnit;
5251 CXToken *Tokens = ((clang_annotateTokens_Data*)UserData)->Tokens;
5252 const unsigned NumTokens = ((clang_annotateTokens_Data*)UserData)->NumTokens;
5253 CXCursor *Cursors = ((clang_annotateTokens_Data*)UserData)->Cursors;
5254
5255 // Determine the region of interest, which contains all of the tokens.
5256 SourceRange RegionOfInterest;
5257 RegionOfInterest.setBegin(
5258 cxloc::translateSourceLocation(clang_getTokenLocation(TU, Tokens[0])));
5259 RegionOfInterest.setEnd(
5260 cxloc::translateSourceLocation(clang_getTokenLocation(TU,
5261 Tokens[NumTokens-1])));
5262
5263 // A mapping from the source locations found when re-lexing or traversing the
5264 // region of interest to the corresponding cursors.
5265 AnnotateTokensData Annotated;
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00005266
Ted Kremenek6628a612011-03-18 22:51:30 +00005267 // Relex the tokens within the source range to look for preprocessing
5268 // directives.
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00005269 annotatePreprocessorTokens(TU, RegionOfInterest, Annotated);
Ted Kremenek6628a612011-03-18 22:51:30 +00005270
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005271 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
5272 // Search and mark tokens that are macro argument expansions.
5273 MarkMacroArgTokensVisitor Visitor(CXXUnit->getSourceManager(),
5274 Tokens, NumTokens);
5275 CursorVisitor MacroArgMarker(TU,
5276 MarkMacroArgTokensVisitorDelegate, &Visitor,
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00005277 /*VisitPreprocessorLast=*/true,
5278 /*VisitIncludedPreprocessingEntries=*/false,
5279 RegionOfInterest);
Argyrios Kyrtzidisa6763792011-08-18 18:03:34 +00005280 MacroArgMarker.visitPreprocessedEntitiesInRegion();
5281 }
5282
Ted Kremenek6628a612011-03-18 22:51:30 +00005283 // Annotate all of the source locations in the region of interest that map to
5284 // a specific cursor.
5285 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
5286 TU, RegionOfInterest);
5287
5288 // FIXME: We use a ridiculous stack size here because the data-recursion
5289 // algorithm uses a large stack frame than the non-data recursive version,
5290 // and AnnotationTokensWorker currently transforms the data-recursion
5291 // algorithm back into a traditional recursion by explicitly calling
5292 // VisitChildren(). We will need to remove this explicit recursive call.
5293 W.AnnotateTokens();
5294
5295 // If we ran into any entities that involve context-sensitive keywords,
5296 // take another pass through the tokens to mark them as such.
5297 if (W.hasContextSensitiveKeywords()) {
5298 for (unsigned I = 0; I != NumTokens; ++I) {
5299 if (clang_getTokenKind(Tokens[I]) != CXToken_Identifier)
5300 continue;
5301
5302 if (Cursors[I].kind == CXCursor_ObjCPropertyDecl) {
5303 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
5304 if (ObjCPropertyDecl *Property
5305 = dyn_cast_or_null<ObjCPropertyDecl>(getCursorDecl(Cursors[I]))) {
5306 if (Property->getPropertyAttributesAsWritten() != 0 &&
5307 llvm::StringSwitch<bool>(II->getName())
5308 .Case("readonly", true)
5309 .Case("assign", true)
John McCallf85e1932011-06-15 23:02:42 +00005310 .Case("unsafe_unretained", true)
Ted Kremenek6628a612011-03-18 22:51:30 +00005311 .Case("readwrite", true)
5312 .Case("retain", true)
5313 .Case("copy", true)
5314 .Case("nonatomic", true)
5315 .Case("atomic", true)
5316 .Case("getter", true)
5317 .Case("setter", true)
John McCallf85e1932011-06-15 23:02:42 +00005318 .Case("strong", true)
5319 .Case("weak", true)
Ted Kremenek6628a612011-03-18 22:51:30 +00005320 .Default(false))
5321 Tokens[I].int_data[0] = CXToken_Keyword;
5322 }
5323 continue;
5324 }
5325
5326 if (Cursors[I].kind == CXCursor_ObjCInstanceMethodDecl ||
5327 Cursors[I].kind == CXCursor_ObjCClassMethodDecl) {
5328 IdentifierInfo *II = static_cast<IdentifierInfo *>(Tokens[I].ptr_data);
5329 if (llvm::StringSwitch<bool>(II->getName())
5330 .Case("in", true)
5331 .Case("out", true)
5332 .Case("inout", true)
5333 .Case("oneway", true)
5334 .Case("bycopy", true)
5335 .Case("byref", true)
5336 .Default(false))
5337 Tokens[I].int_data[0] = CXToken_Keyword;
5338 continue;
5339 }
Argyrios Kyrtzidis6639e922011-09-13 17:39:31 +00005340
5341 if (Cursors[I].kind == CXCursor_CXXFinalAttr ||
5342 Cursors[I].kind == CXCursor_CXXOverrideAttr) {
5343 Tokens[I].int_data[0] = CXToken_Keyword;
Ted Kremenek6628a612011-03-18 22:51:30 +00005344 continue;
5345 }
5346 }
5347 }
Ted Kremenekab979612010-11-11 08:05:23 +00005348}
5349
Ted Kremenek6db61092010-05-05 00:55:15 +00005350extern "C" {
5351
Douglas Gregorfc8ea232010-01-26 17:06:03 +00005352void clang_annotateTokens(CXTranslationUnit TU,
5353 CXToken *Tokens, unsigned NumTokens,
5354 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005355
5356 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00005357 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005358
Douglas Gregor4419b672010-10-21 06:10:04 +00005359 // Any token we don't specifically annotate will have a NULL cursor.
5360 CXCursor C = clang_getNullCursor();
5361 for (unsigned I = 0; I != NumTokens; ++I)
5362 Cursors[I] = C;
5363
Ted Kremeneka60ed472010-11-16 08:15:36 +00005364 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU->TUData);
Douglas Gregor4419b672010-10-21 06:10:04 +00005365 if (!CXXUnit)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00005366 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00005367
Douglas Gregorbdf60622010-03-05 21:16:25 +00005368 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenek6628a612011-03-18 22:51:30 +00005369
5370 clang_annotateTokens_Data data = { TU, CXXUnit, Tokens, NumTokens, Cursors };
Ted Kremenekab979612010-11-11 08:05:23 +00005371 llvm::CrashRecoveryContext CRC;
Ted Kremenek6628a612011-03-18 22:51:30 +00005372 if (!RunSafely(CRC, clang_annotateTokensImpl, &data,
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00005373 GetSafetyThreadStackSize() * 2)) {
Ted Kremenekab979612010-11-11 08:05:23 +00005374 fprintf(stderr, "libclang: crash detected while annotating tokens\n");
5375 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00005376}
Ted Kremenek6628a612011-03-18 22:51:30 +00005377
Douglas Gregorfc8ea232010-01-26 17:06:03 +00005378} // end: extern "C"
5379
5380//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00005381// Operations for querying linkage of a cursor.
5382//===----------------------------------------------------------------------===//
5383
5384extern "C" {
5385CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00005386 if (!clang_isDeclaration(cursor.kind))
5387 return CXLinkage_Invalid;
5388
Ted Kremenek16b42592010-03-03 06:36:57 +00005389 Decl *D = cxcursor::getCursorDecl(cursor);
5390 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
5391 switch (ND->getLinkage()) {
5392 case NoLinkage: return CXLinkage_NoLinkage;
5393 case InternalLinkage: return CXLinkage_Internal;
5394 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
5395 case ExternalLinkage: return CXLinkage_External;
5396 };
5397
5398 return CXLinkage_Invalid;
5399}
5400} // end: extern "C"
5401
5402//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005403// Operations for querying language of a cursor.
5404//===----------------------------------------------------------------------===//
5405
5406static CXLanguageKind getDeclLanguage(const Decl *D) {
5407 switch (D->getKind()) {
5408 default:
5409 break;
5410 case Decl::ImplicitParam:
5411 case Decl::ObjCAtDefsField:
5412 case Decl::ObjCCategory:
5413 case Decl::ObjCCategoryImpl:
5414 case Decl::ObjCClass:
5415 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005416 case Decl::ObjCForwardProtocol:
5417 case Decl::ObjCImplementation:
5418 case Decl::ObjCInterface:
5419 case Decl::ObjCIvar:
5420 case Decl::ObjCMethod:
5421 case Decl::ObjCProperty:
5422 case Decl::ObjCPropertyImpl:
5423 case Decl::ObjCProtocol:
5424 return CXLanguage_ObjC;
5425 case Decl::CXXConstructor:
5426 case Decl::CXXConversion:
5427 case Decl::CXXDestructor:
5428 case Decl::CXXMethod:
5429 case Decl::CXXRecord:
5430 case Decl::ClassTemplate:
5431 case Decl::ClassTemplatePartialSpecialization:
5432 case Decl::ClassTemplateSpecialization:
5433 case Decl::Friend:
5434 case Decl::FriendTemplate:
5435 case Decl::FunctionTemplate:
5436 case Decl::LinkageSpec:
5437 case Decl::Namespace:
5438 case Decl::NamespaceAlias:
5439 case Decl::NonTypeTemplateParm:
5440 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005441 case Decl::TemplateTemplateParm:
5442 case Decl::TemplateTypeParm:
5443 case Decl::UnresolvedUsingTypename:
5444 case Decl::UnresolvedUsingValue:
5445 case Decl::Using:
5446 case Decl::UsingDirective:
5447 case Decl::UsingShadow:
5448 return CXLanguage_CPlusPlus;
5449 }
5450
5451 return CXLanguage_C;
5452}
5453
5454extern "C" {
Douglas Gregor58ddb602010-08-23 23:00:57 +00005455
5456enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
5457 if (clang_isDeclaration(cursor.kind))
5458 if (Decl *D = cxcursor::getCursorDecl(cursor)) {
Douglas Gregor0a0d2b12011-03-23 00:50:03 +00005459 if (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted())
Douglas Gregor58ddb602010-08-23 23:00:57 +00005460 return CXAvailability_Available;
5461
Douglas Gregor0a0d2b12011-03-23 00:50:03 +00005462 switch (D->getAvailability()) {
5463 case AR_Available:
5464 case AR_NotYetIntroduced:
5465 return CXAvailability_Available;
5466
5467 case AR_Deprecated:
Douglas Gregor58ddb602010-08-23 23:00:57 +00005468 return CXAvailability_Deprecated;
Douglas Gregor0a0d2b12011-03-23 00:50:03 +00005469
5470 case AR_Unavailable:
5471 return CXAvailability_NotAvailable;
5472 }
Douglas Gregor58ddb602010-08-23 23:00:57 +00005473 }
Douglas Gregor0a0d2b12011-03-23 00:50:03 +00005474
Douglas Gregor58ddb602010-08-23 23:00:57 +00005475 return CXAvailability_Available;
5476}
5477
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005478CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
5479 if (clang_isDeclaration(cursor.kind))
5480 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
5481
5482 return CXLanguage_Invalid;
5483}
Douglas Gregor3910cfd2010-12-21 07:55:45 +00005484
5485 /// \brief If the given cursor is the "templated" declaration
5486 /// descibing a class or function template, return the class or
5487 /// function template.
5488static Decl *maybeGetTemplateCursor(Decl *D) {
5489 if (!D)
5490 return 0;
5491
5492 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
5493 if (FunctionTemplateDecl *FunTmpl = FD->getDescribedFunctionTemplate())
5494 return FunTmpl;
5495
5496 if (CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D))
5497 if (ClassTemplateDecl *ClassTmpl = RD->getDescribedClassTemplate())
5498 return ClassTmpl;
5499
5500 return D;
5501}
5502
Douglas Gregor2be5bc92010-09-22 21:22:29 +00005503CXCursor clang_getCursorSemanticParent(CXCursor cursor) {
5504 if (clang_isDeclaration(cursor.kind)) {
5505 if (Decl *D = getCursorDecl(cursor)) {
5506 DeclContext *DC = D->getDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00005507 if (!DC)
5508 return clang_getNullCursor();
5509
5510 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
5511 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00005512 }
5513 }
5514
5515 if (clang_isStatement(cursor.kind) || clang_isExpression(cursor.kind)) {
5516 if (Decl *D = getCursorDecl(cursor))
Ted Kremeneka60ed472010-11-16 08:15:36 +00005517 return MakeCXCursor(D, getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00005518 }
5519
5520 return clang_getNullCursor();
5521}
5522
5523CXCursor clang_getCursorLexicalParent(CXCursor cursor) {
5524 if (clang_isDeclaration(cursor.kind)) {
5525 if (Decl *D = getCursorDecl(cursor)) {
5526 DeclContext *DC = D->getLexicalDeclContext();
Douglas Gregor3910cfd2010-12-21 07:55:45 +00005527 if (!DC)
5528 return clang_getNullCursor();
5529
5530 return MakeCXCursor(maybeGetTemplateCursor(cast<Decl>(DC)),
5531 getCursorTU(cursor));
Douglas Gregor2be5bc92010-09-22 21:22:29 +00005532 }
5533 }
5534
5535 // FIXME: Note that we can't easily compute the lexical context of a
5536 // statement or expression, so we return nothing.
5537 return clang_getNullCursor();
5538}
5539
Douglas Gregor9f592342010-10-01 20:25:15 +00005540void clang_getOverriddenCursors(CXCursor cursor,
5541 CXCursor **overridden,
5542 unsigned *num_overridden) {
5543 if (overridden)
5544 *overridden = 0;
5545 if (num_overridden)
5546 *num_overridden = 0;
5547 if (!overridden || !num_overridden)
5548 return;
5549
Argyrios Kyrtzidisb11be042011-10-06 07:00:46 +00005550 SmallVector<CXCursor, 8> Overridden;
5551 cxcursor::getOverriddenCursors(cursor, Overridden);
Douglas Gregor9f592342010-10-01 20:25:15 +00005552
Argyrios Kyrtzidisb11be042011-10-06 07:00:46 +00005553 *num_overridden = Overridden.size();
5554 *overridden = new CXCursor [Overridden.size()];
5555 std::copy(Overridden.begin(), Overridden.end(), *overridden);
Douglas Gregor9f592342010-10-01 20:25:15 +00005556}
5557
5558void clang_disposeOverriddenCursors(CXCursor *overridden) {
5559 delete [] overridden;
5560}
5561
Douglas Gregorecdcb882010-10-20 22:00:55 +00005562CXFile clang_getIncludedFile(CXCursor cursor) {
5563 if (cursor.kind != CXCursor_InclusionDirective)
5564 return 0;
5565
5566 InclusionDirective *ID = getCursorInclusionDirective(cursor);
5567 return (void *)ID->getFile();
5568}
5569
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005570} // end: extern "C"
5571
Ted Kremenek9ada39a2010-05-17 20:06:56 +00005572
5573//===----------------------------------------------------------------------===//
5574// C++ AST instrospection.
5575//===----------------------------------------------------------------------===//
5576
5577extern "C" {
5578unsigned clang_CXXMethod_isStatic(CXCursor C) {
5579 if (!clang_isDeclaration(C.kind))
5580 return 0;
Douglas Gregor49f6f542010-08-31 22:12:17 +00005581
5582 CXXMethodDecl *Method = 0;
5583 Decl *D = cxcursor::getCursorDecl(C);
5584 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
5585 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
5586 else
5587 Method = dyn_cast_or_null<CXXMethodDecl>(D);
5588 return (Method && Method->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00005589}
Ted Kremenekb12903e2010-05-18 22:32:15 +00005590
Douglas Gregor211924b2011-05-12 15:17:24 +00005591unsigned clang_CXXMethod_isVirtual(CXCursor C) {
5592 if (!clang_isDeclaration(C.kind))
5593 return 0;
5594
5595 CXXMethodDecl *Method = 0;
5596 Decl *D = cxcursor::getCursorDecl(C);
5597 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
5598 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
5599 else
5600 Method = dyn_cast_or_null<CXXMethodDecl>(D);
5601 return (Method && Method->isVirtual()) ? 1 : 0;
5602}
Ted Kremenek9ada39a2010-05-17 20:06:56 +00005603} // end: extern "C"
5604
Ted Kremenek45e1dae2010-04-12 21:22:16 +00005605//===----------------------------------------------------------------------===//
Ted Kremenek95f33552010-08-26 01:42:22 +00005606// Attribute introspection.
5607//===----------------------------------------------------------------------===//
5608
5609extern "C" {
5610CXType clang_getIBOutletCollectionType(CXCursor C) {
5611 if (C.kind != CXCursor_IBOutletCollectionAttr)
Ted Kremeneka60ed472010-11-16 08:15:36 +00005612 return cxtype::MakeCXType(QualType(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00005613
5614 IBOutletCollectionAttr *A =
5615 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
5616
Argyrios Kyrtzidis18aa2ff2011-09-13 18:49:52 +00005617 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorTU(C));
Ted Kremenek95f33552010-08-26 01:42:22 +00005618}
5619} // end: extern "C"
5620
5621//===----------------------------------------------------------------------===//
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005622// Inspecting memory usage.
5623//===----------------------------------------------------------------------===//
5624
Ted Kremenekf7870022011-04-20 16:41:07 +00005625typedef std::vector<CXTUResourceUsageEntry> MemUsageEntries;
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005626
Ted Kremenekf7870022011-04-20 16:41:07 +00005627static inline void createCXTUResourceUsageEntry(MemUsageEntries &entries,
5628 enum CXTUResourceUsageKind k,
Ted Kremenekba29bd22011-04-28 04:53:38 +00005629 unsigned long amount) {
Ted Kremenekf7870022011-04-20 16:41:07 +00005630 CXTUResourceUsageEntry entry = { k, amount };
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005631 entries.push_back(entry);
5632}
5633
5634extern "C" {
5635
Ted Kremenekf7870022011-04-20 16:41:07 +00005636const char *clang_getTUResourceUsageName(CXTUResourceUsageKind kind) {
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005637 const char *str = "";
5638 switch (kind) {
Ted Kremenekf7870022011-04-20 16:41:07 +00005639 case CXTUResourceUsage_AST:
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005640 str = "ASTContext: expressions, declarations, and types";
5641 break;
Ted Kremenekf7870022011-04-20 16:41:07 +00005642 case CXTUResourceUsage_Identifiers:
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005643 str = "ASTContext: identifiers";
5644 break;
Ted Kremenekf7870022011-04-20 16:41:07 +00005645 case CXTUResourceUsage_Selectors:
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005646 str = "ASTContext: selectors";
Ted Kremeneke294ab72011-04-19 04:36:17 +00005647 break;
Ted Kremenekf7870022011-04-20 16:41:07 +00005648 case CXTUResourceUsage_GlobalCompletionResults:
Ted Kremenek4e6a3f72011-04-18 23:42:53 +00005649 str = "Code completion: cached global results";
Ted Kremeneke294ab72011-04-19 04:36:17 +00005650 break;
Ted Kremenek457aaf02011-04-28 04:10:31 +00005651 case CXTUResourceUsage_SourceManagerContentCache:
5652 str = "SourceManager: content cache allocator";
5653 break;
Ted Kremenekba29bd22011-04-28 04:53:38 +00005654 case CXTUResourceUsage_AST_SideTables:
5655 str = "ASTContext: side tables";
5656 break;
Ted Kremenekf61b8312011-04-28 20:36:42 +00005657 case CXTUResourceUsage_SourceManager_Membuffer_Malloc:
5658 str = "SourceManager: malloc'ed memory buffers";
5659 break;
5660 case CXTUResourceUsage_SourceManager_Membuffer_MMap:
5661 str = "SourceManager: mmap'ed memory buffers";
5662 break;
Ted Kremeneke9b5f3d2011-04-28 23:46:20 +00005663 case CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc:
5664 str = "ExternalASTSource: malloc'ed memory buffers";
5665 break;
5666 case CXTUResourceUsage_ExternalASTSource_Membuffer_MMap:
5667 str = "ExternalASTSource: mmap'ed memory buffers";
5668 break;
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005669 case CXTUResourceUsage_Preprocessor:
5670 str = "Preprocessor: malloc'ed memory";
5671 break;
5672 case CXTUResourceUsage_PreprocessingRecord:
5673 str = "Preprocessor: PreprocessingRecord";
5674 break;
Ted Kremenekca7dc2b2011-07-26 23:46:06 +00005675 case CXTUResourceUsage_SourceManager_DataStructures:
5676 str = "SourceManager: data structures and tables";
5677 break;
Ted Kremenekd1194fb2011-07-26 23:46:11 +00005678 case CXTUResourceUsage_Preprocessor_HeaderSearch:
5679 str = "Preprocessor: header search tables";
5680 break;
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005681 }
5682 return str;
5683}
5684
Ted Kremenekf7870022011-04-20 16:41:07 +00005685CXTUResourceUsage clang_getCXTUResourceUsage(CXTranslationUnit TU) {
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005686 if (!TU) {
Ted Kremenekf7870022011-04-20 16:41:07 +00005687 CXTUResourceUsage usage = { (void*) 0, 0, 0 };
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005688 return usage;
5689 }
5690
5691 ASTUnit *astUnit = static_cast<ASTUnit*>(TU->TUData);
5692 llvm::OwningPtr<MemUsageEntries> entries(new MemUsageEntries());
5693 ASTContext &astContext = astUnit->getASTContext();
5694
5695 // How much memory is used by AST nodes and types?
Ted Kremenekf7870022011-04-20 16:41:07 +00005696 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST,
Ted Kremenekba29bd22011-04-28 04:53:38 +00005697 (unsigned long) astContext.getASTAllocatedMemory());
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005698
5699 // How much memory is used by identifiers?
Ted Kremenekf7870022011-04-20 16:41:07 +00005700 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Identifiers,
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005701 (unsigned long) astContext.Idents.getAllocator().getTotalMemory());
5702
5703 // How much memory is used for selectors?
Ted Kremenekf7870022011-04-20 16:41:07 +00005704 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_Selectors,
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005705 (unsigned long) astContext.Selectors.getTotalMemory());
5706
Ted Kremenekba29bd22011-04-28 04:53:38 +00005707 // How much memory is used by ASTContext's side tables?
5708 createCXTUResourceUsageEntry(*entries, CXTUResourceUsage_AST_SideTables,
5709 (unsigned long) astContext.getSideTableAllocatedMemory());
5710
Ted Kremenek4e6a3f72011-04-18 23:42:53 +00005711 // How much memory is used for caching global code completion results?
5712 unsigned long completionBytes = 0;
5713 if (GlobalCodeCompletionAllocator *completionAllocator =
5714 astUnit->getCachedCompletionAllocator().getPtr()) {
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005715 completionBytes = completionAllocator->getTotalMemory();
Ted Kremenek4e6a3f72011-04-18 23:42:53 +00005716 }
Ted Kremenek457aaf02011-04-28 04:10:31 +00005717 createCXTUResourceUsageEntry(*entries,
5718 CXTUResourceUsage_GlobalCompletionResults,
5719 completionBytes);
5720
5721 // How much memory is being used by SourceManager's content cache?
5722 createCXTUResourceUsageEntry(*entries,
5723 CXTUResourceUsage_SourceManagerContentCache,
5724 (unsigned long) astContext.getSourceManager().getContentCacheSize());
Ted Kremenekf61b8312011-04-28 20:36:42 +00005725
5726 // How much memory is being used by the MemoryBuffer's in SourceManager?
5727 const SourceManager::MemoryBufferSizes &srcBufs =
5728 astUnit->getSourceManager().getMemoryBufferSizes();
5729
5730 createCXTUResourceUsageEntry(*entries,
5731 CXTUResourceUsage_SourceManager_Membuffer_Malloc,
5732 (unsigned long) srcBufs.malloc_bytes);
Ted Kremenekca7dc2b2011-07-26 23:46:06 +00005733 createCXTUResourceUsageEntry(*entries,
Ted Kremenekf61b8312011-04-28 20:36:42 +00005734 CXTUResourceUsage_SourceManager_Membuffer_MMap,
5735 (unsigned long) srcBufs.mmap_bytes);
Ted Kremenekca7dc2b2011-07-26 23:46:06 +00005736 createCXTUResourceUsageEntry(*entries,
5737 CXTUResourceUsage_SourceManager_DataStructures,
5738 (unsigned long) astContext.getSourceManager()
5739 .getDataStructureSizes());
Ted Kremeneke9b5f3d2011-04-28 23:46:20 +00005740
5741 // How much memory is being used by the ExternalASTSource?
5742 if (ExternalASTSource *esrc = astContext.getExternalSource()) {
5743 const ExternalASTSource::MemoryBufferSizes &sizes =
5744 esrc->getMemoryBufferSizes();
5745
5746 createCXTUResourceUsageEntry(*entries,
5747 CXTUResourceUsage_ExternalASTSource_Membuffer_Malloc,
5748 (unsigned long) sizes.malloc_bytes);
5749 createCXTUResourceUsageEntry(*entries,
5750 CXTUResourceUsage_ExternalASTSource_Membuffer_MMap,
5751 (unsigned long) sizes.mmap_bytes);
5752 }
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005753
5754 // How much memory is being used by the Preprocessor?
5755 Preprocessor &pp = astUnit->getPreprocessor();
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005756 createCXTUResourceUsageEntry(*entries,
5757 CXTUResourceUsage_Preprocessor,
Argyrios Kyrtzidisc5c5e922011-06-29 22:20:04 +00005758 pp.getTotalMemory());
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005759
5760 if (PreprocessingRecord *pRec = pp.getPreprocessingRecord()) {
5761 createCXTUResourceUsageEntry(*entries,
5762 CXTUResourceUsage_PreprocessingRecord,
5763 pRec->getTotalMemory());
5764 }
5765
Ted Kremenekd1194fb2011-07-26 23:46:11 +00005766 createCXTUResourceUsageEntry(*entries,
5767 CXTUResourceUsage_Preprocessor_HeaderSearch,
5768 pp.getHeaderSearchInfo().getTotalMemory());
Ted Kremenek5e1db6a2011-05-04 01:38:46 +00005769
Ted Kremenekf7870022011-04-20 16:41:07 +00005770 CXTUResourceUsage usage = { (void*) entries.get(),
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005771 (unsigned) entries->size(),
5772 entries->size() ? &(*entries)[0] : 0 };
5773 entries.take();
5774 return usage;
5775}
5776
Ted Kremenekf7870022011-04-20 16:41:07 +00005777void clang_disposeCXTUResourceUsage(CXTUResourceUsage usage) {
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005778 if (usage.data)
5779 delete (MemUsageEntries*) usage.data;
5780}
5781
5782} // end extern "C"
5783
Douglas Gregor6df78732011-05-05 20:27:22 +00005784void clang::PrintLibclangResourceUsage(CXTranslationUnit TU) {
5785 CXTUResourceUsage Usage = clang_getCXTUResourceUsage(TU);
5786 for (unsigned I = 0; I != Usage.numEntries; ++I)
5787 fprintf(stderr, " %s: %lu\n",
5788 clang_getTUResourceUsageName(Usage.entries[I].kind),
5789 Usage.entries[I].amount);
5790
5791 clang_disposeCXTUResourceUsage(Usage);
5792}
5793
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005794//===----------------------------------------------------------------------===//
Ted Kremenek04bb7162010-01-22 22:44:15 +00005795// Misc. utility functions.
5796//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00005797
Daniel Dunbarabdce7a2010-11-05 17:21:46 +00005798/// Default to using an 8 MB stack size on "safety" threads.
5799static unsigned SafetyStackThreadSize = 8 << 20;
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00005800
5801namespace clang {
5802
5803bool RunSafely(llvm::CrashRecoveryContext &CRC,
Ted Kremenek6c53fdd2010-11-14 17:47:35 +00005804 void (*Fn)(void*), void *UserData,
5805 unsigned Size) {
5806 if (!Size)
5807 Size = GetSafetyThreadStackSize();
5808 if (Size)
Daniel Dunbarbf44c3b2010-11-05 07:19:31 +00005809 return CRC.RunSafelyOnThread(Fn, UserData, Size);
5810 return CRC.RunSafely(Fn, UserData);
5811}
5812
5813unsigned GetSafetyThreadStackSize() {
5814 return SafetyStackThreadSize;
5815}
5816
5817void SetSafetyThreadStackSize(unsigned Value) {
5818 SafetyStackThreadSize = Value;
5819}
5820
5821}
5822
Ted Kremenek04bb7162010-01-22 22:44:15 +00005823extern "C" {
5824
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00005825CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00005826 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00005827}
5828
5829} // end: extern "C"
Ted Kremenek59fc1e52011-04-18 22:47:10 +00005830