blob: c899f5db6fe3edfaf97a757f6c64a393e057930a [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 Kremenek95f33552010-08-26 01:42:22 +000017#include "CXType.h"
Ted Kremeneka297de22010-01-25 22:34:44 +000018#include "CXSourceLocation.h"
Douglas Gregor5352ac02010-01-28 00:27:43 +000019#include "CIndexDiagnostic.h"
Ted Kremenekab188932010-01-05 19:32:54 +000020
Ted Kremenek04bb7162010-01-22 22:44:15 +000021#include "clang/Basic/Version.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000022
Steve Naroff50398192009-08-28 15:28:48 +000023#include "clang/AST/DeclVisitor.h"
Steve Narofffb570422009-09-22 19:25:29 +000024#include "clang/AST/StmtVisitor.h"
Douglas Gregor7d0d40e2010-01-21 16:28:34 +000025#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000026#include "clang/Basic/Diagnostic.h"
27#include "clang/Frontend/ASTUnit.h"
28#include "clang/Frontend/CompilerInstance.h"
Douglas Gregor936ea3b2010-01-28 00:56:43 +000029#include "clang/Frontend/FrontendDiagnostic.h"
Ted Kremenekd8210652010-01-06 23:43:31 +000030#include "clang/Lex/Lexer.h"
Benjamin Kramerb846deb2010-04-12 19:45:50 +000031#include "clang/Lex/PreprocessingRecord.h"
Douglas Gregor33e9abd2010-01-22 19:49:59 +000032#include "clang/Lex/Preprocessor.h"
Douglas Gregora67e03f2010-09-09 21:42:20 +000033#include "llvm/ADT/STLExtras.h"
Daniel Dunbarc7df4f32010-08-18 18:43:14 +000034#include "llvm/Support/CrashRecoveryContext.h"
Douglas Gregor02465752009-10-16 21:24:31 +000035#include "llvm/Support/MemoryBuffer.h"
Douglas Gregor7a07fcb2010-08-09 21:00:09 +000036#include "llvm/Support/Timer.h"
Benjamin Kramer0829a832009-10-18 11:19:36 +000037#include "llvm/System/Program.h"
Douglas Gregor0a812cf2010-02-18 23:07:20 +000038#include "llvm/System/Signals.h"
Ted Kremenekfc062212009-10-19 21:44:57 +000039
Benjamin Kramerc2a98162010-03-13 21:22:49 +000040// Needed to define L_TMPNAM on some systems.
41#include <cstdio>
42
Steve Naroff50398192009-08-28 15:28:48 +000043using namespace clang;
Ted Kremenek16c440a2010-01-15 20:35:54 +000044using namespace clang::cxcursor;
Ted Kremenekee4db4f2010-02-17 00:41:08 +000045using namespace clang::cxstring;
Steve Naroff50398192009-08-28 15:28:48 +000046
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000047//===----------------------------------------------------------------------===//
48// Crash Reporting.
49//===----------------------------------------------------------------------===//
50
Ted Kremenekd7ffd082010-05-22 00:06:46 +000051#ifdef USE_CRASHTRACER
Ted Kremenek8a8da7d2010-01-06 03:42:32 +000052#include "clang/Analysis/Support/SaveAndRestore.h"
53// Integrate with crash reporter.
Daniel Dunbar439794e2010-05-20 23:50:23 +000054static const char *__crashreporter_info__ = 0;
55asm(".desc ___crashreporter_info__, 0x10");
Ted Kremenek6b569992010-02-17 21:12:23 +000056#define NUM_CRASH_STRINGS 32
Ted Kremenek29b72842010-01-07 22:49:05 +000057static unsigned crashtracer_counter = 0;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000058static unsigned crashtracer_counter_id[NUM_CRASH_STRINGS] = { 0 };
Ted Kremenek29b72842010-01-07 22:49:05 +000059static const char *crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
60static const char *agg_crashtracer_strings[NUM_CRASH_STRINGS] = { 0 };
61
62static unsigned SetCrashTracerInfo(const char *str,
63 llvm::SmallString<1024> &AggStr) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +000064
Ted Kremenek254ba7c2010-01-07 23:13:53 +000065 unsigned slot = 0;
Ted Kremenek29b72842010-01-07 22:49:05 +000066 while (crashtracer_strings[slot]) {
67 if (++slot == NUM_CRASH_STRINGS)
68 slot = 0;
69 }
70 crashtracer_strings[slot] = str;
Ted Kremenek254ba7c2010-01-07 23:13:53 +000071 crashtracer_counter_id[slot] = ++crashtracer_counter;
Ted Kremenek29b72842010-01-07 22:49:05 +000072
73 // We need to create an aggregate string because multiple threads
74 // may be in this method at one time. The crash reporter string
75 // will attempt to overapproximate the set of in-flight invocations
76 // of this function. Race conditions can still cause this goal
77 // to not be achieved.
78 {
Ted Kremenekf0e23e82010-02-17 00:41:40 +000079 llvm::raw_svector_ostream Out(AggStr);
Ted Kremenek29b72842010-01-07 22:49:05 +000080 for (unsigned i = 0; i < NUM_CRASH_STRINGS; ++i)
81 if (crashtracer_strings[i]) Out << crashtracer_strings[i] << '\n';
82 }
83 __crashreporter_info__ = agg_crashtracer_strings[slot] = AggStr.c_str();
84 return slot;
85}
86
87static void ResetCrashTracerInfo(unsigned slot) {
Ted Kremenek254ba7c2010-01-07 23:13:53 +000088 unsigned max_slot = 0;
89 unsigned max_value = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +000090
Ted Kremenek254ba7c2010-01-07 23:13:53 +000091 crashtracer_strings[slot] = agg_crashtracer_strings[slot] = 0;
92
93 for (unsigned i = 0 ; i < NUM_CRASH_STRINGS; ++i)
94 if (agg_crashtracer_strings[i] &&
95 crashtracer_counter_id[i] > max_value) {
96 max_slot = i;
97 max_value = crashtracer_counter_id[i];
Ted Kremenek29b72842010-01-07 22:49:05 +000098 }
Ted Kremenek254ba7c2010-01-07 23:13:53 +000099
100 __crashreporter_info__ = agg_crashtracer_strings[max_slot];
Ted Kremenek29b72842010-01-07 22:49:05 +0000101}
102
103namespace {
104class ArgsCrashTracerInfo {
105 llvm::SmallString<1024> CrashString;
106 llvm::SmallString<1024> AggregateString;
107 unsigned crashtracerSlot;
108public:
109 ArgsCrashTracerInfo(llvm::SmallVectorImpl<const char*> &Args)
110 : crashtracerSlot(0)
111 {
112 {
113 llvm::raw_svector_ostream Out(CrashString);
Ted Kremenek0baa9522010-03-05 22:43:25 +0000114 Out << "ClangCIndex [" << getClangFullVersion() << "]"
115 << "[createTranslationUnitFromSourceFile]: clang";
Ted Kremenek29b72842010-01-07 22:49:05 +0000116 for (llvm::SmallVectorImpl<const char*>::iterator I=Args.begin(),
117 E=Args.end(); I!=E; ++I)
118 Out << ' ' << *I;
119 }
120 crashtracerSlot = SetCrashTracerInfo(CrashString.c_str(),
121 AggregateString);
122 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000123
Ted Kremenek29b72842010-01-07 22:49:05 +0000124 ~ArgsCrashTracerInfo() {
125 ResetCrashTracerInfo(crashtracerSlot);
126 }
127};
128}
129#endif
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000130
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000131/// \brief The result of comparing two source ranges.
132enum RangeComparisonResult {
133 /// \brief Either the ranges overlap or one of the ranges is invalid.
134 RangeOverlap,
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000135
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000136 /// \brief The first range ends before the second range starts.
137 RangeBefore,
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000138
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000139 /// \brief The first range starts after the second range ends.
140 RangeAfter
141};
142
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000143/// \brief Compare two source ranges to determine their relative position in
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000144/// the translation unit.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000145static RangeComparisonResult RangeCompare(SourceManager &SM,
146 SourceRange R1,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000147 SourceRange R2) {
148 assert(R1.isValid() && "First range is invalid?");
149 assert(R2.isValid() && "Second range is invalid?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000150 if (R1.getEnd() != R2.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +0000151 SM.isBeforeInTranslationUnit(R1.getEnd(), R2.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000152 return RangeBefore;
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000153 if (R2.getEnd() != R1.getBegin() &&
Daniel Dunbard52864b2010-02-14 10:02:57 +0000154 SM.isBeforeInTranslationUnit(R2.getEnd(), R1.getBegin()))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000155 return RangeAfter;
156 return RangeOverlap;
157}
158
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000159/// \brief Determine if a source location falls within, before, or after a
160/// a given source range.
161static RangeComparisonResult LocationCompare(SourceManager &SM,
162 SourceLocation L, SourceRange R) {
163 assert(R.isValid() && "First range is invalid?");
164 assert(L.isValid() && "Second range is invalid?");
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000165 if (L == R.getBegin() || L == R.getEnd())
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000166 return RangeOverlap;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +0000167 if (SM.isBeforeInTranslationUnit(L, R.getBegin()))
168 return RangeBefore;
169 if (SM.isBeforeInTranslationUnit(R.getEnd(), L))
170 return RangeAfter;
171 return RangeOverlap;
172}
173
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000174/// \brief Translate a Clang source range into a CIndex source range.
175///
176/// Clang internally represents ranges where the end location points to the
177/// start of the token at the end. However, for external clients it is more
178/// useful to have a CXSourceRange be a proper half-open interval. This routine
179/// does the appropriate translation.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000180CXSourceRange cxloc::translateSourceRange(const SourceManager &SM,
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000181 const LangOptions &LangOpts,
Chris Lattner0a76aae2010-06-18 22:45:06 +0000182 const CharSourceRange &R) {
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000183 // We want the last character in this location, so we will adjust the
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000184 // location accordingly.
185 // FIXME: How do do this with a macro instantiation location?
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000186 SourceLocation EndLoc = R.getEnd();
Chris Lattner0a76aae2010-06-18 22:45:06 +0000187 if (R.isTokenRange() && !EndLoc.isInvalid() && EndLoc.isFileID()) {
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000188 unsigned Length = Lexer::MeasureTokenLength(EndLoc, SM, LangOpts);
Daniel Dunbar76dd3c22010-02-14 01:47:29 +0000189 EndLoc = EndLoc.getFileLocWithOffset(Length);
190 }
191
192 CXSourceRange Result = { { (void *)&SM, (void *)&LangOpts },
193 R.getBegin().getRawEncoding(),
194 EndLoc.getRawEncoding() };
195 return Result;
196}
Douglas Gregor1db19de2010-01-19 21:36:55 +0000197
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000198//===----------------------------------------------------------------------===//
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000199// Cursor visitor.
Ted Kremenek8a8da7d2010-01-06 03:42:32 +0000200//===----------------------------------------------------------------------===//
201
Steve Naroff89922f82009-08-31 00:59:03 +0000202namespace {
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000203
Douglas Gregorb1373d02010-01-20 20:59:29 +0000204// Cursor visitor.
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000205class CursorVisitor : public DeclVisitor<CursorVisitor, bool>,
Douglas Gregora59e3902010-01-21 23:27:09 +0000206 public TypeLocVisitor<CursorVisitor, bool>,
207 public StmtVisitor<CursorVisitor, bool>
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000208{
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000209 /// \brief The translation unit we are traversing.
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000210 ASTUnit *TU;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000211
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000212 /// \brief The parent cursor whose children we are traversing.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000213 CXCursor Parent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000214
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000215 /// \brief The declaration that serves at the parent of any statement or
216 /// expression nodes.
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000217 Decl *StmtParent;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000218
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000219 /// \brief The visitor function.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000220 CXCursorVisitor Visitor;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000221
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000222 /// \brief The opaque client data, to be passed along to the visitor.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000223 CXClientData ClientData;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000224
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000225 // MaxPCHLevel - the maximum PCH level of declarations that we will pass on
226 // to the visitor. Declarations with a PCH level greater than this value will
227 // be suppressed.
228 unsigned MaxPCHLevel;
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000229
230 /// \brief When valid, a source range to which the cursor should restrict
231 /// its search.
232 SourceRange RegionOfInterest;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000233
Douglas Gregorb1373d02010-01-20 20:59:29 +0000234 using DeclVisitor<CursorVisitor, bool>::Visit;
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000235 using TypeLocVisitor<CursorVisitor, bool>::Visit;
Douglas Gregora59e3902010-01-21 23:27:09 +0000236 using StmtVisitor<CursorVisitor, bool>::Visit;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000237
238 /// \brief Determine whether this particular source range comes before, comes
239 /// after, or overlaps the region of interest.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000240 ///
Daniel Dunbard52864b2010-02-14 10:02:57 +0000241 /// \param R a half-open source range retrieved from the abstract syntax tree.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000242 RangeComparisonResult CompareRegionOfInterest(SourceRange R);
243
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000244 class SetParentRAII {
245 CXCursor &Parent;
246 Decl *&StmtParent;
247 CXCursor OldParent;
248
249 public:
250 SetParentRAII(CXCursor &Parent, Decl *&StmtParent, CXCursor NewParent)
251 : Parent(Parent), StmtParent(StmtParent), OldParent(Parent)
252 {
253 Parent = NewParent;
254 if (clang_isDeclaration(Parent.kind))
255 StmtParent = getCursorDecl(Parent);
256 }
257
258 ~SetParentRAII() {
259 Parent = OldParent;
260 if (clang_isDeclaration(Parent.kind))
261 StmtParent = getCursorDecl(Parent);
262 }
263 };
264
Steve Naroff89922f82009-08-31 00:59:03 +0000265public:
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000266 CursorVisitor(ASTUnit *TU, CXCursorVisitor Visitor, CXClientData ClientData,
267 unsigned MaxPCHLevel,
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000268 SourceRange RegionOfInterest = SourceRange())
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000269 : TU(TU), Visitor(Visitor), ClientData(ClientData),
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000270 MaxPCHLevel(MaxPCHLevel), RegionOfInterest(RegionOfInterest)
Douglas Gregorb1373d02010-01-20 20:59:29 +0000271 {
272 Parent.kind = CXCursor_NoDeclFound;
273 Parent.data[0] = 0;
274 Parent.data[1] = 0;
275 Parent.data[2] = 0;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000276 StmtParent = 0;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000277 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000278
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000279 bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false);
Douglas Gregor788f5a12010-03-20 00:41:21 +0000280
281 std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
282 getPreprocessedEntities();
283
Douglas Gregorb1373d02010-01-20 20:59:29 +0000284 bool VisitChildren(CXCursor Parent);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000285
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000286 // Declaration visitors
Ted Kremenek09dfa372010-02-18 05:46:33 +0000287 bool VisitAttributes(Decl *D);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000288 bool VisitBlockDecl(BlockDecl *B);
Ted Kremenek3064ef92010-08-27 21:34:58 +0000289 bool VisitCXXRecordDecl(CXXRecordDecl *D);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000290 bool VisitDeclContext(DeclContext *DC);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000291 bool VisitTranslationUnitDecl(TranslationUnitDecl *D);
292 bool VisitTypedefDecl(TypedefDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000293 bool VisitTagDecl(TagDecl *D);
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000294 bool VisitClassTemplateSpecializationDecl(ClassTemplateSpecializationDecl *D);
Douglas Gregor74dbe642010-08-31 19:31:58 +0000295 bool VisitClassTemplatePartialSpecializationDecl(
296 ClassTemplatePartialSpecializationDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000297 bool VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000298 bool VisitEnumConstantDecl(EnumConstantDecl *D);
299 bool VisitDeclaratorDecl(DeclaratorDecl *DD);
300 bool VisitFunctionDecl(FunctionDecl *ND);
301 bool VisitFieldDecl(FieldDecl *D);
Ted Kremenek4540c9c2010-02-18 18:47:08 +0000302 bool VisitVarDecl(VarDecl *);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000303 bool VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000304 bool VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
Douglas Gregor39d6f072010-08-31 19:02:00 +0000305 bool VisitClassTemplateDecl(ClassTemplateDecl *D);
Douglas Gregor84b51d72010-09-01 20:16:53 +0000306 bool VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000307 bool VisitObjCMethodDecl(ObjCMethodDecl *ND);
308 bool VisitObjCContainerDecl(ObjCContainerDecl *D);
309 bool VisitObjCCategoryDecl(ObjCCategoryDecl *ND);
310 bool VisitObjCProtocolDecl(ObjCProtocolDecl *PID);
Ted Kremenek23173d72010-05-18 21:09:07 +0000311 bool VisitObjCPropertyDecl(ObjCPropertyDecl *PD);
Ted Kremenek79758f62010-02-18 22:36:18 +0000312 bool VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
313 bool VisitObjCImplDecl(ObjCImplDecl *D);
314 bool VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
315 bool VisitObjCImplementationDecl(ObjCImplementationDecl *D);
Ted Kremenek79758f62010-02-18 22:36:18 +0000316 // FIXME: ObjCCompatibleAliasDecl requires aliased-class locations.
317 bool VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
318 bool VisitObjCClassDecl(ObjCClassDecl *D);
Ted Kremeneka0536d82010-05-07 01:04:29 +0000319 bool VisitLinkageSpecDecl(LinkageSpecDecl *D);
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000320 bool VisitNamespaceDecl(NamespaceDecl *D);
Douglas Gregor69319002010-08-31 23:48:11 +0000321 bool VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000322 bool VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
Douglas Gregor7e242562010-09-01 19:52:22 +0000323 bool VisitUsingDecl(UsingDecl *D);
324 bool VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
325 bool VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
Douglas Gregor0a35bce2010-09-01 03:07:18 +0000326
Douglas Gregor01829d32010-08-31 14:41:23 +0000327 // Name visitor
328 bool VisitDeclarationNameInfo(DeclarationNameInfo Name);
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000329 bool VisitNestedNameSpecifier(NestedNameSpecifier *NNS, SourceRange Range);
Douglas Gregor01829d32010-08-31 14:41:23 +0000330
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000331 // Template visitors
332 bool VisitTemplateParameters(const TemplateParameterList *Params);
Douglas Gregor0b36e612010-08-31 20:37:03 +0000333 bool VisitTemplateName(TemplateName Name, SourceLocation Loc);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000334 bool VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL);
335
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000336 // Type visitors
Douglas Gregor01829d32010-08-31 14:41:23 +0000337 bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000338 bool VisitBuiltinTypeLoc(BuiltinTypeLoc TL);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000339 bool VisitTypedefTypeLoc(TypedefTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000340 bool VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL);
341 bool VisitTagTypeLoc(TagTypeLoc TL);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000342 bool VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000343 bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL);
John McCallc12c5bb2010-05-15 11:32:37 +0000344 bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000345 bool VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL);
346 bool VisitPointerTypeLoc(PointerTypeLoc TL);
347 bool VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL);
348 bool VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL);
349 bool VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL);
350 bool VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL);
Douglas Gregor01829d32010-08-31 14:41:23 +0000351 bool VisitFunctionTypeLoc(FunctionTypeLoc TL, bool SkipResultType = false);
Douglas Gregorf20dfbc2010-01-21 17:29:07 +0000352 bool VisitArrayTypeLoc(ArrayTypeLoc TL);
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000353 bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL);
Douglas Gregor2332c112010-01-21 20:48:56 +0000354 // FIXME: Implement visitors here when the unimplemented TypeLocs get
355 // implemented
356 bool VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL);
357 bool VisitTypeOfTypeLoc(TypeOfTypeLoc TL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000358
Douglas Gregora59e3902010-01-21 23:27:09 +0000359 // Statement visitors
360 bool VisitStmt(Stmt *S);
361 bool VisitDeclStmt(DeclStmt *S);
Douglas Gregorf5bab412010-01-22 01:00:11 +0000362 // FIXME: LabelStmt label?
363 bool VisitIfStmt(IfStmt *S);
364 bool VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000365 bool VisitCaseStmt(CaseStmt *S);
Douglas Gregor263b47b2010-01-25 16:12:32 +0000366 bool VisitWhileStmt(WhileStmt *S);
367 bool VisitForStmt(ForStmt *S);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000368
Douglas Gregor336fd812010-01-23 00:40:08 +0000369 // Expression visitors
Douglas Gregor8947a752010-09-02 20:35:02 +0000370 bool VisitDeclRefExpr(DeclRefExpr *E);
Douglas Gregor6cd24e22010-07-29 00:26:18 +0000371 bool VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000372 bool VisitBlockExpr(BlockExpr *B);
Douglas Gregor336fd812010-01-23 00:40:08 +0000373 bool VisitCompoundLiteralExpr(CompoundLiteralExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000374 bool VisitExplicitCastExpr(ExplicitCastExpr *E);
Douglas Gregorc2350e52010-03-08 16:40:19 +0000375 bool VisitObjCMessageExpr(ObjCMessageExpr *E);
Douglas Gregor81d34662010-04-20 15:39:42 +0000376 bool VisitObjCEncodeExpr(ObjCEncodeExpr *E);
Douglas Gregor8ecdb652010-04-28 22:16:22 +0000377 bool VisitOffsetOfExpr(OffsetOfExpr *E);
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000378 bool VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E);
Douglas Gregorfbb4c982010-09-02 21:07:44 +0000379 bool VisitMemberExpr(MemberExpr *E);
Douglas Gregor648220e2010-08-10 15:02:34 +0000380 // FIXME: AddrLabelExpr (once we have cursors for labels)
381 bool VisitTypesCompatibleExpr(TypesCompatibleExpr *E);
382 bool VisitVAArgExpr(VAArgExpr *E);
Douglas Gregorfa2e26f2010-09-09 23:28:23 +0000383 bool VisitInitListExpr(InitListExpr *E);
384 bool VisitDesignatedInitExpr(DesignatedInitExpr *E);
Douglas Gregor94802292010-09-02 21:20:16 +0000385 bool VisitCXXTypeidExpr(CXXTypeidExpr *E);
Douglas Gregor3d37c0a2010-09-09 16:14:44 +0000386 bool VisitCXXUuidofExpr(CXXUuidofExpr *E);
Douglas Gregorda135b12010-09-02 21:38:13 +0000387 bool VisitCXXDefaultArgExpr(CXXDefaultArgExpr *E) { return false; }
Douglas Gregorab6677e2010-09-08 00:15:04 +0000388 bool VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E);
389 bool VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E);
Douglas Gregor1bb2a932010-09-07 21:49:58 +0000390 bool VisitCXXNewExpr(CXXNewExpr *E);
Douglas Gregor6f7198f2010-09-02 22:09:03 +0000391 bool VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E);
Douglas Gregor3d37c0a2010-09-09 16:14:44 +0000392 bool VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E);
Douglas Gregor1f7b5902010-09-02 22:29:21 +0000393 bool VisitOverloadExpr(OverloadExpr *E);
Douglas Gregorbfebed22010-09-03 17:24:10 +0000394 bool VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E);
Douglas Gregorab6677e2010-09-08 00:15:04 +0000395 bool VisitCXXUnresolvedConstructExpr(CXXUnresolvedConstructExpr *E);
Douglas Gregor25d63622010-09-03 17:35:34 +0000396 bool VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E);
Douglas Gregoraaa80b22010-09-03 18:01:25 +0000397 bool VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E);
Steve Naroff89922f82009-08-31 00:59:03 +0000398};
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000399
Ted Kremenekab188932010-01-05 19:32:54 +0000400} // end anonymous namespace
Benjamin Kramer5e4bc592009-10-18 16:11:04 +0000401
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000402static SourceRange getRawCursorExtent(CXCursor C);
403
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000404RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000405 return RangeCompare(TU->getSourceManager(), R, RegionOfInterest);
406}
407
Douglas Gregorb1373d02010-01-20 20:59:29 +0000408/// \brief Visit the given cursor and, if requested by the visitor,
409/// its children.
410///
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000411/// \param Cursor the cursor to visit.
412///
413/// \param CheckRegionOfInterest if true, then the caller already checked that
414/// this cursor is within the region of interest.
415///
Douglas Gregorb1373d02010-01-20 20:59:29 +0000416/// \returns true if the visitation should be aborted, false if it
417/// should continue.
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000418bool CursorVisitor::Visit(CXCursor Cursor, bool CheckedRegionOfInterest) {
Douglas Gregorb1373d02010-01-20 20:59:29 +0000419 if (clang_isInvalid(Cursor.kind))
420 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000421
Douglas Gregorb1373d02010-01-20 20:59:29 +0000422 if (clang_isDeclaration(Cursor.kind)) {
423 Decl *D = getCursorDecl(Cursor);
424 assert(D && "Invalid declaration cursor");
425 if (D->getPCHLevel() > MaxPCHLevel)
426 return false;
427
428 if (D->isImplicit())
429 return false;
430 }
431
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000432 // If we have a range of interest, and this cursor doesn't intersect with it,
433 // we're done.
434 if (RegionOfInterest.isValid() && !CheckedRegionOfInterest) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000435 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbarf408f322010-02-14 08:32:05 +0000436 if (Range.isInvalid() || CompareRegionOfInterest(Range))
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000437 return false;
438 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000439
Douglas Gregorb1373d02010-01-20 20:59:29 +0000440 switch (Visitor(Cursor, Parent, ClientData)) {
441 case CXChildVisit_Break:
442 return true;
443
444 case CXChildVisit_Continue:
445 return false;
446
447 case CXChildVisit_Recurse:
448 return VisitChildren(Cursor);
449 }
450
Douglas Gregorfd643772010-01-25 16:45:46 +0000451 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000452}
453
Douglas Gregor788f5a12010-03-20 00:41:21 +0000454std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
455CursorVisitor::getPreprocessedEntities() {
456 PreprocessingRecord &PPRec
457 = *TU->getPreprocessor().getPreprocessingRecord();
458
459 bool OnlyLocalDecls
460 = !TU->isMainFileAST() && TU->getOnlyLocalDecls();
461
462 // There is no region of interest; we have to walk everything.
463 if (RegionOfInterest.isInvalid())
464 return std::make_pair(PPRec.begin(OnlyLocalDecls),
465 PPRec.end(OnlyLocalDecls));
466
467 // Find the file in which the region of interest lands.
468 SourceManager &SM = TU->getSourceManager();
469 std::pair<FileID, unsigned> Begin
470 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getBegin());
471 std::pair<FileID, unsigned> End
472 = SM.getDecomposedInstantiationLoc(RegionOfInterest.getEnd());
473
474 // The region of interest spans files; we have to walk everything.
475 if (Begin.first != End.first)
476 return std::make_pair(PPRec.begin(OnlyLocalDecls),
477 PPRec.end(OnlyLocalDecls));
478
479 ASTUnit::PreprocessedEntitiesByFileMap &ByFileMap
480 = TU->getPreprocessedEntitiesByFile();
481 if (ByFileMap.empty()) {
482 // Build the mapping from files to sets of preprocessed entities.
483 for (PreprocessingRecord::iterator E = PPRec.begin(OnlyLocalDecls),
484 EEnd = PPRec.end(OnlyLocalDecls);
485 E != EEnd; ++E) {
486 std::pair<FileID, unsigned> P
487 = SM.getDecomposedInstantiationLoc((*E)->getSourceRange().getBegin());
488 ByFileMap[P.first].push_back(*E);
489 }
490 }
491
492 return std::make_pair(ByFileMap[Begin.first].begin(),
493 ByFileMap[Begin.first].end());
494}
495
Douglas Gregorb1373d02010-01-20 20:59:29 +0000496/// \brief Visit the children of the given cursor.
497///
498/// \returns true if the visitation should be aborted, false if it
499/// should continue.
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000500bool CursorVisitor::VisitChildren(CXCursor Cursor) {
Douglas Gregora59e3902010-01-21 23:27:09 +0000501 if (clang_isReference(Cursor.kind)) {
502 // By definition, references have no children.
503 return false;
504 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000505
506 // Set the Parent field to Cursor, then back to its old value once we're
Douglas Gregorb1373d02010-01-20 20:59:29 +0000507 // done.
Ted Kremenek0f91f6a2010-05-13 00:25:00 +0000508 SetParentRAII SetParent(Parent, StmtParent, Cursor);
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000509
Douglas Gregorb1373d02010-01-20 20:59:29 +0000510 if (clang_isDeclaration(Cursor.kind)) {
511 Decl *D = getCursorDecl(Cursor);
512 assert(D && "Invalid declaration cursor");
Ted Kremenek539311e2010-02-18 18:47:01 +0000513 return VisitAttributes(D) || Visit(D);
Douglas Gregorb1373d02010-01-20 20:59:29 +0000514 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000515
Douglas Gregora59e3902010-01-21 23:27:09 +0000516 if (clang_isStatement(Cursor.kind))
517 return Visit(getCursorStmt(Cursor));
518 if (clang_isExpression(Cursor.kind))
519 return Visit(getCursorExpr(Cursor));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000520
Douglas Gregorb1373d02010-01-20 20:59:29 +0000521 if (clang_isTranslationUnit(Cursor.kind)) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000522 ASTUnit *CXXUnit = getCursorASTUnit(Cursor);
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000523 if (!CXXUnit->isMainFileAST() && CXXUnit->getOnlyLocalDecls() &&
524 RegionOfInterest.isInvalid()) {
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000525 for (ASTUnit::top_level_iterator TL = CXXUnit->top_level_begin(),
526 TLEnd = CXXUnit->top_level_end();
527 TL != TLEnd; ++TL) {
528 if (Visit(MakeCXCursor(*TL, CXXUnit), true))
Douglas Gregor7b691f332010-01-20 21:13:59 +0000529 return true;
530 }
Douglas Gregor0396f462010-03-19 05:22:59 +0000531 } else if (VisitDeclContext(
532 CXXUnit->getASTContext().getTranslationUnitDecl()))
533 return true;
Bob Wilson3178cb62010-03-19 03:57:57 +0000534
Douglas Gregor0396f462010-03-19 05:22:59 +0000535 // Walk the preprocessing record.
Daniel Dunbar8de30ff2010-03-20 01:11:56 +0000536 if (CXXUnit->getPreprocessor().getPreprocessingRecord()) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000537 // FIXME: Once we have the ability to deserialize a preprocessing record,
538 // do so.
Douglas Gregor788f5a12010-03-20 00:41:21 +0000539 PreprocessingRecord::iterator E, EEnd;
540 for (llvm::tie(E, EEnd) = getPreprocessedEntities(); E != EEnd; ++E) {
Douglas Gregor0396f462010-03-19 05:22:59 +0000541 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
542 if (Visit(MakeMacroInstantiationCursor(MI, CXXUnit)))
543 return true;
Douglas Gregor788f5a12010-03-20 00:41:21 +0000544
Douglas Gregor0396f462010-03-19 05:22:59 +0000545 continue;
546 }
547
548 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
549 if (Visit(MakeMacroDefinitionCursor(MD, CXXUnit)))
550 return true;
551
552 continue;
553 }
554 }
555 }
Douglas Gregor7b691f332010-01-20 21:13:59 +0000556 return false;
Douglas Gregorb1373d02010-01-20 20:59:29 +0000557 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000558
Douglas Gregorb1373d02010-01-20 20:59:29 +0000559 // Nothing to visit at the moment.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000560 return false;
561}
562
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000563bool CursorVisitor::VisitBlockDecl(BlockDecl *B) {
John McCallfc929202010-06-04 22:33:30 +0000564 if (Visit(B->getSignatureAsWritten()->getTypeLoc()))
565 return true;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000566
Ted Kremenek664cffd2010-07-22 11:30:19 +0000567 if (Stmt *Body = B->getBody())
568 return Visit(MakeCXCursor(Body, StmtParent, TU));
569
570 return false;
Ted Kremenek1ee6cad2010-04-11 21:47:37 +0000571}
572
Douglas Gregorb1373d02010-01-20 20:59:29 +0000573bool CursorVisitor::VisitDeclContext(DeclContext *DC) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000574 for (DeclContext::decl_iterator
Douglas Gregorb1373d02010-01-20 20:59:29 +0000575 I = DC->decls_begin(), E = DC->decls_end(); I != E; ++I) {
Ted Kremenek09dfa372010-02-18 05:46:33 +0000576
Ted Kremenek23173d72010-05-18 21:09:07 +0000577 Decl *D = *I;
578 if (D->getLexicalDeclContext() != DC)
579 continue;
580
581 CXCursor Cursor = MakeCXCursor(D, TU);
Daniel Dunbard52864b2010-02-14 10:02:57 +0000582
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000583 if (RegionOfInterest.isValid()) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +0000584 SourceRange Range = getRawCursorExtent(Cursor);
Daniel Dunbard52864b2010-02-14 10:02:57 +0000585 if (Range.isInvalid())
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000586 continue;
Daniel Dunbard52864b2010-02-14 10:02:57 +0000587
588 switch (CompareRegionOfInterest(Range)) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000589 case RangeBefore:
590 // This declaration comes before the region of interest; skip it.
591 continue;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000592
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000593 case RangeAfter:
594 // This declaration comes after the region of interest; we're done.
595 return false;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000596
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000597 case RangeOverlap:
598 // This declaration overlaps the region of interest; visit it.
599 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000600 }
Douglas Gregor33e9abd2010-01-22 19:49:59 +0000601 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000602
Daniel Dunbard52864b2010-02-14 10:02:57 +0000603 if (Visit(Cursor, true))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000604 return true;
605 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000606
Douglas Gregorb1373d02010-01-20 20:59:29 +0000607 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000608}
609
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000610bool CursorVisitor::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
611 llvm_unreachable("Translation units are visited directly by Visit()");
612 return false;
613}
614
615bool CursorVisitor::VisitTypedefDecl(TypedefDecl *D) {
616 if (TypeSourceInfo *TSInfo = D->getTypeSourceInfo())
617 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000618
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000619 return false;
620}
621
622bool CursorVisitor::VisitTagDecl(TagDecl *D) {
623 return VisitDeclContext(D);
624}
625
Douglas Gregor0ab1e9f2010-09-01 17:32:36 +0000626bool CursorVisitor::VisitClassTemplateSpecializationDecl(
627 ClassTemplateSpecializationDecl *D) {
628 bool ShouldVisitBody = false;
629 switch (D->getSpecializationKind()) {
630 case TSK_Undeclared:
631 case TSK_ImplicitInstantiation:
632 // Nothing to visit
633 return false;
634
635 case TSK_ExplicitInstantiationDeclaration:
636 case TSK_ExplicitInstantiationDefinition:
637 break;
638
639 case TSK_ExplicitSpecialization:
640 ShouldVisitBody = true;
641 break;
642 }
643
644 // Visit the template arguments used in the specialization.
645 if (TypeSourceInfo *SpecType = D->getTypeAsWritten()) {
646 TypeLoc TL = SpecType->getTypeLoc();
647 if (TemplateSpecializationTypeLoc *TSTLoc
648 = dyn_cast<TemplateSpecializationTypeLoc>(&TL)) {
649 for (unsigned I = 0, N = TSTLoc->getNumArgs(); I != N; ++I)
650 if (VisitTemplateArgumentLoc(TSTLoc->getArgLoc(I)))
651 return true;
652 }
653 }
654
655 if (ShouldVisitBody && VisitCXXRecordDecl(D))
656 return true;
657
658 return false;
659}
660
Douglas Gregor74dbe642010-08-31 19:31:58 +0000661bool CursorVisitor::VisitClassTemplatePartialSpecializationDecl(
662 ClassTemplatePartialSpecializationDecl *D) {
663 // FIXME: Visit the "outer" template parameter lists on the TagDecl
664 // before visiting these template parameters.
665 if (VisitTemplateParameters(D->getTemplateParameters()))
666 return true;
667
668 // Visit the partial specialization arguments.
669 const TemplateArgumentLoc *TemplateArgs = D->getTemplateArgsAsWritten();
670 for (unsigned I = 0, N = D->getNumTemplateArgsAsWritten(); I != N; ++I)
671 if (VisitTemplateArgumentLoc(TemplateArgs[I]))
672 return true;
673
674 return VisitCXXRecordDecl(D);
675}
676
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000677bool CursorVisitor::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
Douglas Gregor84b51d72010-09-01 20:16:53 +0000678 // Visit the default argument.
679 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
680 if (TypeSourceInfo *DefArg = D->getDefaultArgumentInfo())
681 if (Visit(DefArg->getTypeLoc()))
682 return true;
683
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000684 return false;
685}
686
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000687bool CursorVisitor::VisitEnumConstantDecl(EnumConstantDecl *D) {
688 if (Expr *Init = D->getInitExpr())
689 return Visit(MakeCXCursor(Init, StmtParent, TU));
690 return false;
691}
692
Douglas Gregor7d0d40e2010-01-21 16:28:34 +0000693bool CursorVisitor::VisitDeclaratorDecl(DeclaratorDecl *DD) {
694 if (TypeSourceInfo *TSInfo = DD->getTypeSourceInfo())
695 if (Visit(TSInfo->getTypeLoc()))
696 return true;
697
698 return false;
699}
700
Douglas Gregora67e03f2010-09-09 21:42:20 +0000701/// \brief Compare two base or member initializers based on their source order.
702static int CompareCXXBaseOrMemberInitializers(const void* Xp, const void *Yp) {
703 CXXBaseOrMemberInitializer const * const *X
704 = static_cast<CXXBaseOrMemberInitializer const * const *>(Xp);
705 CXXBaseOrMemberInitializer const * const *Y
706 = static_cast<CXXBaseOrMemberInitializer const * const *>(Yp);
707
708 if ((*X)->getSourceOrder() < (*Y)->getSourceOrder())
709 return -1;
710 else if ((*X)->getSourceOrder() > (*Y)->getSourceOrder())
711 return 1;
712 else
713 return 0;
714}
715
Douglas Gregorb1373d02010-01-20 20:59:29 +0000716bool CursorVisitor::VisitFunctionDecl(FunctionDecl *ND) {
Douglas Gregor01829d32010-08-31 14:41:23 +0000717 if (TypeSourceInfo *TSInfo = ND->getTypeSourceInfo()) {
718 // Visit the function declaration's syntactic components in the order
719 // written. This requires a bit of work.
720 TypeLoc TL = TSInfo->getTypeLoc();
721 FunctionTypeLoc *FTL = dyn_cast<FunctionTypeLoc>(&TL);
722
723 // If we have a function declared directly (without the use of a typedef),
724 // visit just the return type. Otherwise, just visit the function's type
725 // now.
726 if ((FTL && !isa<CXXConversionDecl>(ND) && Visit(FTL->getResultLoc())) ||
727 (!FTL && Visit(TL)))
728 return true;
729
Douglas Gregorc5ade2e2010-09-02 17:35:32 +0000730 // Visit the nested-name-specifier, if present.
731 if (NestedNameSpecifier *Qualifier = ND->getQualifier())
732 if (VisitNestedNameSpecifier(Qualifier, ND->getQualifierRange()))
733 return true;
Douglas Gregor01829d32010-08-31 14:41:23 +0000734
735 // Visit the declaration name.
736 if (VisitDeclarationNameInfo(ND->getNameInfo()))
737 return true;
738
739 // FIXME: Visit explicitly-specified template arguments!
740
741 // Visit the function parameters, if we have a function type.
742 if (FTL && VisitFunctionTypeLoc(*FTL, true))
743 return true;
744
745 // FIXME: Attributes?
746 }
747
Douglas Gregora67e03f2010-09-09 21:42:20 +0000748 if (ND->isThisDeclarationADefinition()) {
749 if (CXXConstructorDecl *Constructor = dyn_cast<CXXConstructorDecl>(ND)) {
750 // Find the initializers that were written in the source.
751 llvm::SmallVector<CXXBaseOrMemberInitializer *, 4> WrittenInits;
752 for (CXXConstructorDecl::init_iterator I = Constructor->init_begin(),
753 IEnd = Constructor->init_end();
754 I != IEnd; ++I) {
755 if (!(*I)->isWritten())
756 continue;
757
758 WrittenInits.push_back(*I);
759 }
760
761 // Sort the initializers in source order
762 llvm::array_pod_sort(WrittenInits.begin(), WrittenInits.end(),
763 &CompareCXXBaseOrMemberInitializers);
764
765 // Visit the initializers in source order
766 for (unsigned I = 0, N = WrittenInits.size(); I != N; ++I) {
767 CXXBaseOrMemberInitializer *Init = WrittenInits[I];
768 if (Init->isMemberInitializer()) {
769 if (Visit(MakeCursorMemberRef(Init->getMember(),
770 Init->getMemberLocation(), TU)))
771 return true;
772 } else if (TypeSourceInfo *BaseInfo = Init->getBaseClassInfo()) {
773 if (Visit(BaseInfo->getTypeLoc()))
774 return true;
775 }
776
777 // Visit the initializer value.
778 if (Expr *Initializer = Init->getInit())
779 if (Visit(MakeCXCursor(Initializer, ND, TU)))
780 return true;
781 }
782 }
783
784 if (Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
785 return true;
786 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000787
Douglas Gregorb1373d02010-01-20 20:59:29 +0000788 return false;
789}
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000790
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000791bool CursorVisitor::VisitFieldDecl(FieldDecl *D) {
792 if (VisitDeclaratorDecl(D))
793 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000794
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000795 if (Expr *BitWidth = D->getBitWidth())
796 return Visit(MakeCXCursor(BitWidth, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000797
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000798 return false;
799}
800
801bool CursorVisitor::VisitVarDecl(VarDecl *D) {
802 if (VisitDeclaratorDecl(D))
803 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000804
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000805 if (Expr *Init = D->getInit())
806 return Visit(MakeCXCursor(Init, StmtParent, TU));
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000807
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000808 return false;
809}
810
Douglas Gregor84b51d72010-09-01 20:16:53 +0000811bool CursorVisitor::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
812 if (VisitDeclaratorDecl(D))
813 return true;
814
815 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
816 if (Expr *DefArg = D->getDefaultArgument())
817 return Visit(MakeCXCursor(DefArg, StmtParent, TU));
818
819 return false;
820}
821
Douglas Gregorfe72e9c2010-08-31 17:01:39 +0000822bool CursorVisitor::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
823 // FIXME: Visit the "outer" template parameter lists on the FunctionDecl
824 // before visiting these template parameters.
825 if (VisitTemplateParameters(D->getTemplateParameters()))
826 return true;
827
828 return VisitFunctionDecl(D->getTemplatedDecl());
829}
830
Douglas Gregor39d6f072010-08-31 19:02:00 +0000831bool CursorVisitor::VisitClassTemplateDecl(ClassTemplateDecl *D) {
832 // FIXME: Visit the "outer" template parameter lists on the TagDecl
833 // before visiting these template parameters.
834 if (VisitTemplateParameters(D->getTemplateParameters()))
835 return true;
836
837 return VisitCXXRecordDecl(D->getTemplatedDecl());
838}
839
Douglas Gregor84b51d72010-09-01 20:16:53 +0000840bool CursorVisitor::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
841 if (VisitTemplateParameters(D->getTemplateParameters()))
842 return true;
843
844 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited() &&
845 VisitTemplateArgumentLoc(D->getDefaultArgument()))
846 return true;
847
848 return false;
849}
850
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000851bool CursorVisitor::VisitObjCMethodDecl(ObjCMethodDecl *ND) {
Douglas Gregor4bc1cb62010-03-08 14:59:44 +0000852 if (TypeSourceInfo *TSInfo = ND->getResultTypeSourceInfo())
853 if (Visit(TSInfo->getTypeLoc()))
854 return true;
855
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000856 for (ObjCMethodDecl::param_iterator P = ND->param_begin(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000857 PEnd = ND->param_end();
858 P != PEnd; ++P) {
859 if (Visit(MakeCXCursor(*P, TU)))
860 return true;
861 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000862
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000863 if (ND->isThisDeclarationADefinition() &&
864 Visit(MakeCXCursor(ND->getBody(), StmtParent, TU)))
865 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000866
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000867 return false;
868}
869
Douglas Gregora59e3902010-01-21 23:27:09 +0000870bool CursorVisitor::VisitObjCContainerDecl(ObjCContainerDecl *D) {
871 return VisitDeclContext(D);
872}
873
Douglas Gregorb1373d02010-01-20 20:59:29 +0000874bool CursorVisitor::VisitObjCCategoryDecl(ObjCCategoryDecl *ND) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000875 if (Visit(MakeCursorObjCClassRef(ND->getClassInterface(), ND->getLocation(),
876 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000877 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000878
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000879 ObjCCategoryDecl::protocol_loc_iterator PL = ND->protocol_loc_begin();
880 for (ObjCCategoryDecl::protocol_iterator I = ND->protocol_begin(),
881 E = ND->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000882 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000883 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000884
Douglas Gregora59e3902010-01-21 23:27:09 +0000885 return VisitObjCContainerDecl(ND);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000886}
887
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000888bool CursorVisitor::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
889 ObjCProtocolDecl::protocol_loc_iterator PL = PID->protocol_loc_begin();
890 for (ObjCProtocolDecl::protocol_iterator I = PID->protocol_begin(),
891 E = PID->protocol_end(); I != E; ++I, ++PL)
892 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
893 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000894
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000895 return VisitObjCContainerDecl(PID);
896}
897
Ted Kremenek23173d72010-05-18 21:09:07 +0000898bool CursorVisitor::VisitObjCPropertyDecl(ObjCPropertyDecl *PD) {
Douglas Gregor83cb9422010-09-09 17:09:21 +0000899 if (PD->getTypeSourceInfo() && Visit(PD->getTypeSourceInfo()->getTypeLoc()))
John McCallfc929202010-06-04 22:33:30 +0000900 return true;
901
Ted Kremenek23173d72010-05-18 21:09:07 +0000902 // FIXME: This implements a workaround with @property declarations also being
903 // installed in the DeclContext for the @interface. Eventually this code
904 // should be removed.
905 ObjCCategoryDecl *CDecl = dyn_cast<ObjCCategoryDecl>(PD->getDeclContext());
906 if (!CDecl || !CDecl->IsClassExtension())
907 return false;
908
909 ObjCInterfaceDecl *ID = CDecl->getClassInterface();
910 if (!ID)
911 return false;
912
913 IdentifierInfo *PropertyId = PD->getIdentifier();
914 ObjCPropertyDecl *prevDecl =
915 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(ID), PropertyId);
916
917 if (!prevDecl)
918 return false;
919
920 // Visit synthesized methods since they will be skipped when visiting
921 // the @interface.
922 if (ObjCMethodDecl *MD = prevDecl->getGetterMethodDecl())
923 if (MD->isSynthesized())
924 if (Visit(MakeCXCursor(MD, TU)))
925 return true;
926
927 if (ObjCMethodDecl *MD = prevDecl->getSetterMethodDecl())
928 if (MD->isSynthesized())
929 if (Visit(MakeCXCursor(MD, TU)))
930 return true;
931
932 return false;
933}
934
Douglas Gregorb1373d02010-01-20 20:59:29 +0000935bool CursorVisitor::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000936 // Issue callbacks for super class.
Douglas Gregorb1373d02010-01-20 20:59:29 +0000937 if (D->getSuperClass() &&
938 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000939 D->getSuperClassLoc(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000940 TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000941 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000942
Douglas Gregor78db0cd2010-01-16 15:44:18 +0000943 ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
944 for (ObjCInterfaceDecl::protocol_iterator I = D->protocol_begin(),
945 E = D->protocol_end(); I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000946 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000947 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000948
Douglas Gregora59e3902010-01-21 23:27:09 +0000949 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000950}
951
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000952bool CursorVisitor::VisitObjCImplDecl(ObjCImplDecl *D) {
953 return VisitObjCContainerDecl(D);
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000954}
955
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000956bool CursorVisitor::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
Ted Kremenekebfa3392010-03-19 20:39:03 +0000957 // 'ID' could be null when dealing with invalid code.
958 if (ObjCInterfaceDecl *ID = D->getClassInterface())
959 if (Visit(MakeCursorObjCClassRef(ID, D->getLocation(), TU)))
960 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000961
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000962 return VisitObjCImplDecl(D);
963}
964
965bool CursorVisitor::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
966#if 0
967 // Issue callbacks for super class.
968 // FIXME: No source location information!
969 if (D->getSuperClass() &&
970 Visit(MakeCursorObjCSuperClassRef(D->getSuperClass(),
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000971 D->getSuperClassLoc(),
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000972 TU)))
973 return true;
974#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000975
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000976 return VisitObjCImplDecl(D);
977}
978
979bool CursorVisitor::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
980 ObjCForwardProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin();
981 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
982 E = D->protocol_end();
983 I != E; ++I, ++PL)
Douglas Gregorb2cd4872010-01-20 23:57:43 +0000984 if (Visit(MakeCursorObjCProtocolRef(*I, *PL, TU)))
Douglas Gregorb1373d02010-01-20 20:59:29 +0000985 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000986
987 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000988}
989
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000990bool CursorVisitor::VisitObjCClassDecl(ObjCClassDecl *D) {
991 for (ObjCClassDecl::iterator C = D->begin(), CEnd = D->end(); C != CEnd; ++C)
992 if (Visit(MakeCursorObjCClassRef(C->getInterface(), C->getLocation(), TU)))
993 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +0000994
Douglas Gregor1ef2fc12010-01-22 00:50:27 +0000995 return false;
Ted Kremenekdd6bcc52010-01-13 00:22:49 +0000996}
997
Ted Kremenek8f06e0e2010-05-06 23:38:21 +0000998bool CursorVisitor::VisitNamespaceDecl(NamespaceDecl *D) {
999 return VisitDeclContext(D);
1000}
1001
Douglas Gregor69319002010-08-31 23:48:11 +00001002bool CursorVisitor::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001003 // Visit nested-name-specifier.
1004 if (NestedNameSpecifier *Qualifier = D->getQualifier())
1005 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1006 return true;
Douglas Gregor69319002010-08-31 23:48:11 +00001007
1008 return Visit(MakeCursorNamespaceRef(D->getAliasedNamespace(),
1009 D->getTargetNameLoc(), TU));
1010}
1011
Douglas Gregor7e242562010-09-01 19:52:22 +00001012bool CursorVisitor::VisitUsingDecl(UsingDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001013 // Visit nested-name-specifier.
1014 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameDecl())
1015 if (VisitNestedNameSpecifier(Qualifier, D->getNestedNameRange()))
1016 return true;
Douglas Gregor7e242562010-09-01 19:52:22 +00001017
1018 // FIXME: Provide a multi-reference of some kind for all of the declarations
1019 // that the using declaration refers to. We don't have this kind of cursor
1020 // yet.
1021
1022 return VisitDeclarationNameInfo(D->getNameInfo());
1023}
1024
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001025bool CursorVisitor::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001026 // Visit nested-name-specifier.
1027 if (NestedNameSpecifier *Qualifier = D->getQualifier())
1028 if (VisitNestedNameSpecifier(Qualifier, D->getQualifierRange()))
1029 return true;
Douglas Gregor0a35bce2010-09-01 03:07:18 +00001030
1031 return Visit(MakeCursorNamespaceRef(D->getNominatedNamespaceAsWritten(),
1032 D->getIdentLocation(), TU));
1033}
1034
Douglas Gregor7e242562010-09-01 19:52:22 +00001035bool CursorVisitor::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001036 // Visit nested-name-specifier.
1037 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1038 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1039 return true;
1040
Douglas Gregor7e242562010-09-01 19:52:22 +00001041 return VisitDeclarationNameInfo(D->getNameInfo());
1042}
1043
1044bool CursorVisitor::VisitUnresolvedUsingTypenameDecl(
1045 UnresolvedUsingTypenameDecl *D) {
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001046 // Visit nested-name-specifier.
1047 if (NestedNameSpecifier *Qualifier = D->getTargetNestedNameSpecifier())
1048 if (VisitNestedNameSpecifier(Qualifier, D->getTargetNestedNameRange()))
1049 return true;
1050
Douglas Gregor7e242562010-09-01 19:52:22 +00001051 return false;
1052}
1053
Douglas Gregor01829d32010-08-31 14:41:23 +00001054bool CursorVisitor::VisitDeclarationNameInfo(DeclarationNameInfo Name) {
1055 switch (Name.getName().getNameKind()) {
1056 case clang::DeclarationName::Identifier:
1057 case clang::DeclarationName::CXXLiteralOperatorName:
1058 case clang::DeclarationName::CXXOperatorName:
1059 case clang::DeclarationName::CXXUsingDirective:
1060 return false;
1061
1062 case clang::DeclarationName::CXXConstructorName:
1063 case clang::DeclarationName::CXXDestructorName:
1064 case clang::DeclarationName::CXXConversionFunctionName:
1065 if (TypeSourceInfo *TSInfo = Name.getNamedTypeInfo())
1066 return Visit(TSInfo->getTypeLoc());
1067 return false;
1068
1069 case clang::DeclarationName::ObjCZeroArgSelector:
1070 case clang::DeclarationName::ObjCOneArgSelector:
1071 case clang::DeclarationName::ObjCMultiArgSelector:
1072 // FIXME: Per-identifier location info?
1073 return false;
1074 }
1075
1076 return false;
1077}
1078
Douglas Gregorc5ade2e2010-09-02 17:35:32 +00001079bool CursorVisitor::VisitNestedNameSpecifier(NestedNameSpecifier *NNS,
1080 SourceRange Range) {
1081 // FIXME: This whole routine is a hack to work around the lack of proper
1082 // source information in nested-name-specifiers (PR5791). Since we do have
1083 // a beginning source location, we can visit the first component of the
1084 // nested-name-specifier, if it's a single-token component.
1085 if (!NNS)
1086 return false;
1087
1088 // Get the first component in the nested-name-specifier.
1089 while (NestedNameSpecifier *Prefix = NNS->getPrefix())
1090 NNS = Prefix;
1091
1092 switch (NNS->getKind()) {
1093 case NestedNameSpecifier::Namespace:
1094 // FIXME: The token at this source location might actually have been a
1095 // namespace alias, but we don't model that. Lame!
1096 return Visit(MakeCursorNamespaceRef(NNS->getAsNamespace(), Range.getBegin(),
1097 TU));
1098
1099 case NestedNameSpecifier::TypeSpec: {
1100 // If the type has a form where we know that the beginning of the source
1101 // range matches up with a reference cursor. Visit the appropriate reference
1102 // cursor.
1103 Type *T = NNS->getAsType();
1104 if (const TypedefType *Typedef = dyn_cast<TypedefType>(T))
1105 return Visit(MakeCursorTypeRef(Typedef->getDecl(), Range.getBegin(), TU));
1106 if (const TagType *Tag = dyn_cast<TagType>(T))
1107 return Visit(MakeCursorTypeRef(Tag->getDecl(), Range.getBegin(), TU));
1108 if (const TemplateSpecializationType *TST
1109 = dyn_cast<TemplateSpecializationType>(T))
1110 return VisitTemplateName(TST->getTemplateName(), Range.getBegin());
1111 break;
1112 }
1113
1114 case NestedNameSpecifier::TypeSpecWithTemplate:
1115 case NestedNameSpecifier::Global:
1116 case NestedNameSpecifier::Identifier:
1117 break;
1118 }
1119
1120 return false;
1121}
1122
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001123bool CursorVisitor::VisitTemplateParameters(
1124 const TemplateParameterList *Params) {
1125 if (!Params)
1126 return false;
1127
1128 for (TemplateParameterList::const_iterator P = Params->begin(),
1129 PEnd = Params->end();
1130 P != PEnd; ++P) {
1131 if (Visit(MakeCXCursor(*P, TU)))
1132 return true;
1133 }
1134
1135 return false;
1136}
1137
Douglas Gregor0b36e612010-08-31 20:37:03 +00001138bool CursorVisitor::VisitTemplateName(TemplateName Name, SourceLocation Loc) {
1139 switch (Name.getKind()) {
1140 case TemplateName::Template:
1141 return Visit(MakeCursorTemplateRef(Name.getAsTemplateDecl(), Loc, TU));
1142
1143 case TemplateName::OverloadedTemplate:
1144 // FIXME: We need a way to return multiple lookup results in a single
1145 // cursor.
1146 return false;
1147
1148 case TemplateName::DependentTemplate:
1149 // FIXME: Visit nested-name-specifier.
1150 return false;
1151
1152 case TemplateName::QualifiedTemplate:
1153 // FIXME: Visit nested-name-specifier.
1154 return Visit(MakeCursorTemplateRef(
1155 Name.getAsQualifiedTemplateName()->getDecl(),
1156 Loc, TU));
1157 }
1158
1159 return false;
1160}
1161
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001162bool CursorVisitor::VisitTemplateArgumentLoc(const TemplateArgumentLoc &TAL) {
1163 switch (TAL.getArgument().getKind()) {
1164 case TemplateArgument::Null:
1165 case TemplateArgument::Integral:
1166 return false;
1167
1168 case TemplateArgument::Pack:
1169 // FIXME: Implement when variadic templates come along.
1170 return false;
1171
1172 case TemplateArgument::Type:
1173 if (TypeSourceInfo *TSInfo = TAL.getTypeSourceInfo())
1174 return Visit(TSInfo->getTypeLoc());
1175 return false;
1176
1177 case TemplateArgument::Declaration:
1178 if (Expr *E = TAL.getSourceDeclExpression())
1179 return Visit(MakeCXCursor(E, StmtParent, TU));
1180 return false;
1181
1182 case TemplateArgument::Expression:
1183 if (Expr *E = TAL.getSourceExpression())
1184 return Visit(MakeCXCursor(E, StmtParent, TU));
1185 return false;
1186
1187 case TemplateArgument::Template:
Douglas Gregor0b36e612010-08-31 20:37:03 +00001188 return VisitTemplateName(TAL.getArgument().getAsTemplate(),
1189 TAL.getTemplateNameLoc());
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001190 }
1191
1192 return false;
1193}
1194
Ted Kremeneka0536d82010-05-07 01:04:29 +00001195bool CursorVisitor::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
1196 return VisitDeclContext(D);
1197}
1198
Douglas Gregor01829d32010-08-31 14:41:23 +00001199bool CursorVisitor::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
1200 return Visit(TL.getUnqualifiedLoc());
1201}
1202
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001203bool CursorVisitor::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
1204 ASTContext &Context = TU->getASTContext();
1205
1206 // Some builtin types (such as Objective-C's "id", "sel", and
1207 // "Class") have associated declarations. Create cursors for those.
1208 QualType VisitType;
1209 switch (TL.getType()->getAs<BuiltinType>()->getKind()) {
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001210 case BuiltinType::Void:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001211 case BuiltinType::Bool:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001212 case BuiltinType::Char_U:
1213 case BuiltinType::UChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001214 case BuiltinType::Char16:
1215 case BuiltinType::Char32:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001216 case BuiltinType::UShort:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001217 case BuiltinType::UInt:
1218 case BuiltinType::ULong:
1219 case BuiltinType::ULongLong:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001220 case BuiltinType::UInt128:
1221 case BuiltinType::Char_S:
1222 case BuiltinType::SChar:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001223 case BuiltinType::WChar:
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001224 case BuiltinType::Short:
1225 case BuiltinType::Int:
1226 case BuiltinType::Long:
1227 case BuiltinType::LongLong:
1228 case BuiltinType::Int128:
1229 case BuiltinType::Float:
1230 case BuiltinType::Double:
1231 case BuiltinType::LongDouble:
1232 case BuiltinType::NullPtr:
1233 case BuiltinType::Overload:
1234 case BuiltinType::Dependent:
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001235 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001236
1237 case BuiltinType::UndeducedAuto: // FIXME: Deserves a cursor?
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001238 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001239
Ted Kremenekc4174cc2010-02-18 18:52:18 +00001240 case BuiltinType::ObjCId:
1241 VisitType = Context.getObjCIdType();
1242 break;
Ted Kremenek6b3b5142010-02-18 22:32:43 +00001243
1244 case BuiltinType::ObjCClass:
1245 VisitType = Context.getObjCClassType();
1246 break;
1247
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001248 case BuiltinType::ObjCSel:
1249 VisitType = Context.getObjCSelType();
1250 break;
1251 }
1252
1253 if (!VisitType.isNull()) {
1254 if (const TypedefType *Typedef = VisitType->getAs<TypedefType>())
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001255 return Visit(MakeCursorTypeRef(Typedef->getDecl(), TL.getBuiltinLoc(),
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001256 TU));
1257 }
1258
1259 return false;
1260}
1261
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00001262bool CursorVisitor::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
1263 return Visit(MakeCursorTypeRef(TL.getTypedefDecl(), TL.getNameLoc(), TU));
1264}
1265
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001266bool CursorVisitor::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
1267 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1268}
1269
1270bool CursorVisitor::VisitTagTypeLoc(TagTypeLoc TL) {
1271 return Visit(MakeCursorTypeRef(TL.getDecl(), TL.getNameLoc(), TU));
1272}
1273
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001274bool CursorVisitor::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
1275 // FIXME: We can't visit the template template parameter, but there's
1276 // no context information with which we can match up the depth/index in the
1277 // type to the appropriate
1278 return false;
1279}
1280
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001281bool CursorVisitor::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
1282 if (Visit(MakeCursorObjCClassRef(TL.getIFaceDecl(), TL.getNameLoc(), TU)))
1283 return true;
1284
John McCallc12c5bb2010-05-15 11:32:37 +00001285 return false;
1286}
1287
1288bool CursorVisitor::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
1289 if (TL.hasBaseTypeAsWritten() && Visit(TL.getBaseLoc()))
1290 return true;
1291
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001292 for (unsigned I = 0, N = TL.getNumProtocols(); I != N; ++I) {
1293 if (Visit(MakeCursorObjCProtocolRef(TL.getProtocol(I), TL.getProtocolLoc(I),
1294 TU)))
1295 return true;
1296 }
1297
1298 return false;
1299}
1300
1301bool CursorVisitor::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
John McCallc12c5bb2010-05-15 11:32:37 +00001302 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001303}
1304
1305bool CursorVisitor::VisitPointerTypeLoc(PointerTypeLoc TL) {
1306 return Visit(TL.getPointeeLoc());
1307}
1308
1309bool CursorVisitor::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
1310 return Visit(TL.getPointeeLoc());
1311}
1312
1313bool CursorVisitor::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
1314 return Visit(TL.getPointeeLoc());
1315}
1316
1317bool CursorVisitor::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001318 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001319}
1320
1321bool CursorVisitor::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001322 return Visit(TL.getPointeeLoc());
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001323}
1324
Douglas Gregor01829d32010-08-31 14:41:23 +00001325bool CursorVisitor::VisitFunctionTypeLoc(FunctionTypeLoc TL,
1326 bool SkipResultType) {
1327 if (!SkipResultType && Visit(TL.getResultLoc()))
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001328 return true;
1329
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001330 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
Ted Kremenek5dbacb42010-04-07 00:27:13 +00001331 if (Decl *D = TL.getArg(I))
1332 if (Visit(MakeCXCursor(D, TU)))
1333 return true;
Douglas Gregorf20dfbc2010-01-21 17:29:07 +00001334
1335 return false;
1336}
1337
1338bool CursorVisitor::VisitArrayTypeLoc(ArrayTypeLoc TL) {
1339 if (Visit(TL.getElementLoc()))
1340 return true;
1341
1342 if (Expr *Size = TL.getSizeExpr())
1343 return Visit(MakeCXCursor(Size, StmtParent, TU));
1344
1345 return false;
1346}
1347
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001348bool CursorVisitor::VisitTemplateSpecializationTypeLoc(
1349 TemplateSpecializationTypeLoc TL) {
Douglas Gregor0b36e612010-08-31 20:37:03 +00001350 // Visit the template name.
1351 if (VisitTemplateName(TL.getTypePtr()->getTemplateName(),
1352 TL.getTemplateNameLoc()))
1353 return true;
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00001354
1355 // Visit the template arguments.
1356 for (unsigned I = 0, N = TL.getNumArgs(); I != N; ++I)
1357 if (VisitTemplateArgumentLoc(TL.getArgLoc(I)))
1358 return true;
1359
1360 return false;
1361}
1362
Douglas Gregor2332c112010-01-21 20:48:56 +00001363bool CursorVisitor::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
1364 return Visit(MakeCXCursor(TL.getUnderlyingExpr(), StmtParent, TU));
1365}
1366
1367bool CursorVisitor::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
1368 if (TypeSourceInfo *TSInfo = TL.getUnderlyingTInfo())
1369 return Visit(TSInfo->getTypeLoc());
1370
1371 return false;
1372}
1373
Douglas Gregora59e3902010-01-21 23:27:09 +00001374bool CursorVisitor::VisitStmt(Stmt *S) {
1375 for (Stmt::child_iterator Child = S->child_begin(), ChildEnd = S->child_end();
1376 Child != ChildEnd; ++Child) {
Ted Kremenek0f91f6a2010-05-13 00:25:00 +00001377 if (Stmt *C = *Child)
1378 if (Visit(MakeCXCursor(C, StmtParent, TU)))
1379 return true;
Douglas Gregora59e3902010-01-21 23:27:09 +00001380 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001381
Douglas Gregora59e3902010-01-21 23:27:09 +00001382 return false;
1383}
1384
Ted Kremenek0f91f6a2010-05-13 00:25:00 +00001385bool CursorVisitor::VisitCaseStmt(CaseStmt *S) {
1386 // Specially handle CaseStmts because they can be nested, e.g.:
1387 //
1388 // case 1:
1389 // case 2:
1390 //
1391 // In this case the second CaseStmt is the child of the first. Walking
1392 // these recursively can blow out the stack.
1393 CXCursor Cursor = MakeCXCursor(S, StmtParent, TU);
1394 while (true) {
1395 // Set the Parent field to Cursor, then back to its old value once we're
1396 // done.
1397 SetParentRAII SetParent(Parent, StmtParent, Cursor);
1398
1399 if (Stmt *LHS = S->getLHS())
1400 if (Visit(MakeCXCursor(LHS, StmtParent, TU)))
1401 return true;
1402 if (Stmt *RHS = S->getRHS())
1403 if (Visit(MakeCXCursor(RHS, StmtParent, TU)))
1404 return true;
1405 if (Stmt *SubStmt = S->getSubStmt()) {
1406 if (!isa<CaseStmt>(SubStmt))
1407 return Visit(MakeCXCursor(SubStmt, StmtParent, TU));
1408
1409 // Specially handle 'CaseStmt' so that we don't blow out the stack.
1410 CaseStmt *CS = cast<CaseStmt>(SubStmt);
1411 Cursor = MakeCXCursor(CS, StmtParent, TU);
1412 if (RegionOfInterest.isValid()) {
1413 SourceRange Range = CS->getSourceRange();
1414 if (Range.isInvalid() || CompareRegionOfInterest(Range))
1415 return false;
1416 }
1417
1418 switch (Visitor(Cursor, Parent, ClientData)) {
1419 case CXChildVisit_Break: return true;
1420 case CXChildVisit_Continue: return false;
1421 case CXChildVisit_Recurse:
1422 // Perform tail-recursion manually.
1423 S = CS;
1424 continue;
1425 }
1426 }
1427 return false;
1428 }
1429}
1430
Douglas Gregora59e3902010-01-21 23:27:09 +00001431bool CursorVisitor::VisitDeclStmt(DeclStmt *S) {
1432 for (DeclStmt::decl_iterator D = S->decl_begin(), DEnd = S->decl_end();
1433 D != DEnd; ++D) {
Douglas Gregor263b47b2010-01-25 16:12:32 +00001434 if (*D && Visit(MakeCXCursor(*D, TU)))
Douglas Gregora59e3902010-01-21 23:27:09 +00001435 return true;
1436 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001437
Douglas Gregora59e3902010-01-21 23:27:09 +00001438 return false;
1439}
1440
Douglas Gregorf5bab412010-01-22 01:00:11 +00001441bool CursorVisitor::VisitIfStmt(IfStmt *S) {
1442 if (VarDecl *Var = S->getConditionVariable()) {
1443 if (Visit(MakeCXCursor(Var, TU)))
1444 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001445 }
1446
Douglas Gregor263b47b2010-01-25 16:12:32 +00001447 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1448 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001449 if (S->getThen() && Visit(MakeCXCursor(S->getThen(), StmtParent, TU)))
1450 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001451 if (S->getElse() && Visit(MakeCXCursor(S->getElse(), StmtParent, TU)))
1452 return true;
1453
1454 return false;
1455}
1456
1457bool CursorVisitor::VisitSwitchStmt(SwitchStmt *S) {
1458 if (VarDecl *Var = S->getConditionVariable()) {
1459 if (Visit(MakeCXCursor(Var, TU)))
1460 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001461 }
1462
Douglas Gregor263b47b2010-01-25 16:12:32 +00001463 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1464 return true;
1465 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1466 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001467
Douglas Gregor263b47b2010-01-25 16:12:32 +00001468 return false;
1469}
1470
1471bool CursorVisitor::VisitWhileStmt(WhileStmt *S) {
1472 if (VarDecl *Var = S->getConditionVariable()) {
1473 if (Visit(MakeCXCursor(Var, TU)))
1474 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001475 }
1476
Douglas Gregor263b47b2010-01-25 16:12:32 +00001477 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1478 return true;
1479 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
Douglas Gregorf5bab412010-01-22 01:00:11 +00001480 return true;
1481
Douglas Gregor263b47b2010-01-25 16:12:32 +00001482 return false;
1483}
1484
1485bool CursorVisitor::VisitForStmt(ForStmt *S) {
1486 if (S->getInit() && Visit(MakeCXCursor(S->getInit(), StmtParent, TU)))
1487 return true;
1488 if (VarDecl *Var = S->getConditionVariable()) {
1489 if (Visit(MakeCXCursor(Var, TU)))
1490 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001491 }
1492
Douglas Gregor263b47b2010-01-25 16:12:32 +00001493 if (S->getCond() && Visit(MakeCXCursor(S->getCond(), StmtParent, TU)))
1494 return true;
1495 if (S->getInc() && Visit(MakeCXCursor(S->getInc(), StmtParent, TU)))
1496 return true;
Douglas Gregorf5bab412010-01-22 01:00:11 +00001497 if (S->getBody() && Visit(MakeCXCursor(S->getBody(), StmtParent, TU)))
1498 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001499
Douglas Gregorf5bab412010-01-22 01:00:11 +00001500 return false;
1501}
1502
Douglas Gregor8947a752010-09-02 20:35:02 +00001503bool CursorVisitor::VisitDeclRefExpr(DeclRefExpr *E) {
1504 // Visit nested-name-specifier, if present.
1505 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1506 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1507 return true;
1508
1509 // Visit declaration name.
1510 if (VisitDeclarationNameInfo(E->getNameInfo()))
1511 return true;
1512
1513 // Visit explicitly-specified template arguments.
1514 if (E->hasExplicitTemplateArgs()) {
1515 ExplicitTemplateArgumentList &Args = E->getExplicitTemplateArgs();
1516 for (TemplateArgumentLoc *Arg = Args.getTemplateArgs(),
1517 *ArgEnd = Arg + Args.NumTemplateArgs;
1518 Arg != ArgEnd; ++Arg)
1519 if (VisitTemplateArgumentLoc(*Arg))
1520 return true;
1521 }
1522
1523 return false;
1524}
1525
Douglas Gregor6cd24e22010-07-29 00:26:18 +00001526bool CursorVisitor::VisitCXXOperatorCallExpr(CXXOperatorCallExpr *E) {
1527 if (Visit(MakeCXCursor(E->getArg(0), StmtParent, TU)))
1528 return true;
1529
1530 if (Visit(MakeCXCursor(E->getCallee(), StmtParent, TU)))
1531 return true;
1532
1533 for (unsigned I = 1, N = E->getNumArgs(); I != N; ++I)
1534 if (Visit(MakeCXCursor(E->getArg(I), StmtParent, TU)))
1535 return true;
1536
1537 return false;
1538}
1539
Ted Kremenek3064ef92010-08-27 21:34:58 +00001540bool CursorVisitor::VisitCXXRecordDecl(CXXRecordDecl *D) {
1541 if (D->isDefinition()) {
1542 for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1543 E = D->bases_end(); I != E; ++I) {
1544 if (Visit(cxcursor::MakeCursorCXXBaseSpecifier(I, TU)))
1545 return true;
1546 }
1547 }
1548
1549 return VisitTagDecl(D);
1550}
1551
1552
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00001553bool CursorVisitor::VisitBlockExpr(BlockExpr *B) {
1554 return Visit(B->getBlockDecl());
1555}
1556
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001557bool CursorVisitor::VisitOffsetOfExpr(OffsetOfExpr *E) {
Douglas Gregor8ccef2d2010-09-09 23:10:46 +00001558 // Visit the type into which we're computing an offset.
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001559 if (Visit(E->getTypeSourceInfo()->getTypeLoc()))
1560 return true;
Douglas Gregor8ccef2d2010-09-09 23:10:46 +00001561
1562 // Visit the components of the offsetof expression.
1563 for (unsigned I = 0, N = E->getNumComponents(); I != N; ++I) {
1564 typedef OffsetOfExpr::OffsetOfNode OffsetOfNode;
1565 const OffsetOfNode &Node = E->getComponent(I);
1566 switch (Node.getKind()) {
1567 case OffsetOfNode::Array:
1568 if (Visit(MakeCXCursor(E->getIndexExpr(Node.getArrayExprIndex()),
1569 StmtParent, TU)))
1570 return true;
1571 break;
1572
1573 case OffsetOfNode::Field:
1574 if (Visit(MakeCursorMemberRef(Node.getField(), Node.getRange().getEnd(),
1575 TU)))
1576 return true;
1577 break;
1578
1579 case OffsetOfNode::Identifier:
1580 case OffsetOfNode::Base:
1581 continue;
1582 }
1583 }
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001584
Douglas Gregor8ccef2d2010-09-09 23:10:46 +00001585 return false;
Douglas Gregor8ecdb652010-04-28 22:16:22 +00001586}
1587
Douglas Gregor336fd812010-01-23 00:40:08 +00001588bool CursorVisitor::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E) {
1589 if (E->isArgumentType()) {
1590 if (TypeSourceInfo *TSInfo = E->getArgumentTypeInfo())
1591 return Visit(TSInfo->getTypeLoc());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001592
Douglas Gregor336fd812010-01-23 00:40:08 +00001593 return false;
1594 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001595
Douglas Gregor336fd812010-01-23 00:40:08 +00001596 return VisitExpr(E);
1597}
1598
Douglas Gregorfbb4c982010-09-02 21:07:44 +00001599bool CursorVisitor::VisitMemberExpr(MemberExpr *E) {
1600 // Visit the base expression.
1601 if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1602 return true;
1603
1604 // Visit the nested-name-specifier
1605 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1606 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1607 return true;
1608
1609 // Visit the declaration name.
1610 if (VisitDeclarationNameInfo(E->getMemberNameInfo()))
1611 return true;
1612
1613 // Visit the explicitly-specified template arguments, if any.
1614 if (E->hasExplicitTemplateArgs()) {
1615 for (const TemplateArgumentLoc *Arg = E->getTemplateArgs(),
1616 *ArgEnd = Arg + E->getNumTemplateArgs();
1617 Arg != ArgEnd;
1618 ++Arg) {
1619 if (VisitTemplateArgumentLoc(*Arg))
1620 return true;
1621 }
1622 }
1623
1624 return false;
1625}
1626
Douglas Gregor336fd812010-01-23 00:40:08 +00001627bool CursorVisitor::VisitExplicitCastExpr(ExplicitCastExpr *E) {
1628 if (TypeSourceInfo *TSInfo = E->getTypeInfoAsWritten())
1629 if (Visit(TSInfo->getTypeLoc()))
1630 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001631
Douglas Gregor336fd812010-01-23 00:40:08 +00001632 return VisitCastExpr(E);
1633}
1634
1635bool CursorVisitor::VisitCompoundLiteralExpr(CompoundLiteralExpr *E) {
1636 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1637 if (Visit(TSInfo->getTypeLoc()))
1638 return true;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001639
Douglas Gregor336fd812010-01-23 00:40:08 +00001640 return VisitExpr(E);
1641}
1642
Douglas Gregor648220e2010-08-10 15:02:34 +00001643bool CursorVisitor::VisitTypesCompatibleExpr(TypesCompatibleExpr *E) {
1644 return Visit(E->getArgTInfo1()->getTypeLoc()) ||
1645 Visit(E->getArgTInfo2()->getTypeLoc());
1646}
1647
1648bool CursorVisitor::VisitVAArgExpr(VAArgExpr *E) {
1649 if (Visit(E->getWrittenTypeInfo()->getTypeLoc()))
1650 return true;
1651
1652 return Visit(MakeCXCursor(E->getSubExpr(), StmtParent, TU));
1653}
1654
Douglas Gregorfa2e26f2010-09-09 23:28:23 +00001655bool CursorVisitor::VisitInitListExpr(InitListExpr *E) {
1656 // We care about the syntactic form of the initializer list, only.
1657 return VisitExpr(E->getSyntacticForm());
1658}
1659
1660bool CursorVisitor::VisitDesignatedInitExpr(DesignatedInitExpr *E) {
1661 // Visit the designators.
1662 typedef DesignatedInitExpr::Designator Designator;
1663 for (DesignatedInitExpr::designators_iterator D = E->designators_begin(),
1664 DEnd = E->designators_end();
1665 D != DEnd; ++D) {
1666 if (D->isFieldDesignator()) {
1667 if (FieldDecl *Field = D->getField())
1668 if (Visit(MakeCursorMemberRef(Field, D->getFieldLoc(), TU)))
1669 return true;
1670
1671 continue;
1672 }
1673
1674 if (D->isArrayDesignator()) {
1675 if (Visit(MakeCXCursor(E->getArrayIndex(*D), StmtParent, TU)))
1676 return true;
1677
1678 continue;
1679 }
1680
1681 assert(D->isArrayRangeDesignator() && "Unknown designator kind");
1682 if (Visit(MakeCXCursor(E->getArrayRangeStart(*D), StmtParent, TU)) ||
1683 Visit(MakeCXCursor(E->getArrayRangeEnd(*D), StmtParent, TU)))
1684 return true;
1685 }
1686
1687 // Visit the initializer value itself.
1688 return Visit(MakeCXCursor(E->getInit(), StmtParent, TU));
1689}
1690
Douglas Gregor94802292010-09-02 21:20:16 +00001691bool CursorVisitor::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
1692 if (E->isTypeOperand()) {
1693 if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo())
1694 return Visit(TSInfo->getTypeLoc());
1695
1696 return false;
1697 }
1698
1699 return VisitExpr(E);
1700}
1701
Douglas Gregor3d37c0a2010-09-09 16:14:44 +00001702bool CursorVisitor::VisitCXXUuidofExpr(CXXUuidofExpr *E) {
1703 if (E->isTypeOperand()) {
1704 if (TypeSourceInfo *TSInfo = E->getTypeOperandSourceInfo())
1705 return Visit(TSInfo->getTypeLoc());
1706
1707 return false;
1708 }
1709
1710 return VisitExpr(E);
1711}
1712
Douglas Gregorab6677e2010-09-08 00:15:04 +00001713bool CursorVisitor::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *E) {
1714 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1715 return Visit(TSInfo->getTypeLoc());
1716
1717 return VisitExpr(E);
1718}
1719
1720bool CursorVisitor::VisitCXXScalarValueInitExpr(CXXScalarValueInitExpr *E) {
1721 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1722 return Visit(TSInfo->getTypeLoc());
1723
1724 return false;
1725}
1726
Douglas Gregor1bb2a932010-09-07 21:49:58 +00001727bool CursorVisitor::VisitCXXNewExpr(CXXNewExpr *E) {
1728 // Visit placement arguments.
1729 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I)
1730 if (Visit(MakeCXCursor(E->getPlacementArg(I), StmtParent, TU)))
1731 return true;
1732
1733 // Visit the allocated type.
1734 if (TypeSourceInfo *TSInfo = E->getAllocatedTypeSourceInfo())
1735 if (Visit(TSInfo->getTypeLoc()))
1736 return true;
1737
1738 // Visit the array size, if any.
1739 if (E->isArray() && Visit(MakeCXCursor(E->getArraySize(), StmtParent, TU)))
1740 return true;
1741
1742 // Visit the initializer or constructor arguments.
1743 for (unsigned I = 0, N = E->getNumConstructorArgs(); I != N; ++I)
1744 if (Visit(MakeCXCursor(E->getConstructorArg(I), StmtParent, TU)))
1745 return true;
1746
1747 return false;
1748}
1749
Douglas Gregor6f7198f2010-09-02 22:09:03 +00001750bool CursorVisitor::VisitCXXPseudoDestructorExpr(CXXPseudoDestructorExpr *E) {
1751 // Visit base expression.
1752 if (Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1753 return true;
1754
1755 // Visit the nested-name-specifier.
1756 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1757 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1758 return true;
1759
1760 // Visit the scope type that looks disturbingly like the nested-name-specifier
1761 // but isn't.
1762 if (TypeSourceInfo *TSInfo = E->getScopeTypeInfo())
1763 if (Visit(TSInfo->getTypeLoc()))
1764 return true;
1765
1766 // Visit the name of the type being destroyed.
1767 if (TypeSourceInfo *TSInfo = E->getDestroyedTypeInfo())
1768 if (Visit(TSInfo->getTypeLoc()))
1769 return true;
1770
1771 return false;
1772}
1773
Douglas Gregor3d37c0a2010-09-09 16:14:44 +00001774bool CursorVisitor::VisitUnaryTypeTraitExpr(UnaryTypeTraitExpr *E) {
1775 return Visit(E->getQueriedTypeSourceInfo()->getTypeLoc());
1776}
1777
Douglas Gregor1f7b5902010-09-02 22:29:21 +00001778bool CursorVisitor::VisitOverloadExpr(OverloadExpr *E) {
Douglas Gregor8ab670e2010-09-02 22:19:24 +00001779 // Visit the nested-name-specifier.
1780 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1781 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1782 return true;
1783
1784 // Visit the declaration name.
1785 if (VisitDeclarationNameInfo(E->getNameInfo()))
1786 return true;
1787
Douglas Gregor1f7b5902010-09-02 22:29:21 +00001788 // Visit the explicitly-specified template arguments.
1789 if (const ExplicitTemplateArgumentList *ArgList
1790 = E->getOptionalExplicitTemplateArgs()) {
1791 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1792 *ArgEnd = Arg + ArgList->NumTemplateArgs;
1793 Arg != ArgEnd; ++Arg) {
1794 if (VisitTemplateArgumentLoc(*Arg))
1795 return true;
1796 }
1797 }
1798
Douglas Gregor8ab670e2010-09-02 22:19:24 +00001799 // FIXME: We don't have a way to visit all of the declarations referenced
1800 // here.
1801 return false;
1802}
1803
Douglas Gregorbfebed22010-09-03 17:24:10 +00001804bool CursorVisitor::VisitDependentScopeDeclRefExpr(
1805 DependentScopeDeclRefExpr *E) {
1806 // Visit the nested-name-specifier.
1807 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1808 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1809 return true;
1810
1811 // Visit the declaration name.
1812 if (VisitDeclarationNameInfo(E->getNameInfo()))
1813 return true;
1814
1815 // Visit the explicitly-specified template arguments.
1816 if (const ExplicitTemplateArgumentList *ArgList
1817 = E->getOptionalExplicitTemplateArgs()) {
1818 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1819 *ArgEnd = Arg + ArgList->NumTemplateArgs;
1820 Arg != ArgEnd; ++Arg) {
1821 if (VisitTemplateArgumentLoc(*Arg))
1822 return true;
1823 }
1824 }
1825
1826 return false;
1827}
1828
Douglas Gregorab6677e2010-09-08 00:15:04 +00001829bool CursorVisitor::VisitCXXUnresolvedConstructExpr(
1830 CXXUnresolvedConstructExpr *E) {
1831 if (TypeSourceInfo *TSInfo = E->getTypeSourceInfo())
1832 if (Visit(TSInfo->getTypeLoc()))
1833 return true;
1834
1835 return VisitExpr(E);
1836}
1837
Douglas Gregor25d63622010-09-03 17:35:34 +00001838bool CursorVisitor::VisitCXXDependentScopeMemberExpr(
1839 CXXDependentScopeMemberExpr *E) {
1840 // Visit the base expression, if there is one.
1841 if (!E->isImplicitAccess() &&
1842 Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1843 return true;
1844
1845 // Visit the nested-name-specifier.
1846 if (NestedNameSpecifier *Qualifier = E->getQualifier())
1847 if (VisitNestedNameSpecifier(Qualifier, E->getQualifierRange()))
1848 return true;
1849
1850 // Visit the declaration name.
1851 if (VisitDeclarationNameInfo(E->getMemberNameInfo()))
1852 return true;
1853
1854 // Visit the explicitly-specified template arguments.
1855 if (const ExplicitTemplateArgumentList *ArgList
1856 = E->getOptionalExplicitTemplateArgs()) {
1857 for (const TemplateArgumentLoc *Arg = ArgList->getTemplateArgs(),
1858 *ArgEnd = Arg + ArgList->NumTemplateArgs;
1859 Arg != ArgEnd; ++Arg) {
1860 if (VisitTemplateArgumentLoc(*Arg))
1861 return true;
1862 }
1863 }
1864
1865 return false;
1866}
1867
Douglas Gregoraaa80b22010-09-03 18:01:25 +00001868bool CursorVisitor::VisitUnresolvedMemberExpr(UnresolvedMemberExpr *E) {
1869 // Visit the base expression, if there is one.
1870 if (!E->isImplicitAccess() &&
1871 Visit(MakeCXCursor(E->getBase(), StmtParent, TU)))
1872 return true;
1873
1874 return VisitOverloadExpr(E);
1875}
Douglas Gregor25d63622010-09-03 17:35:34 +00001876
Douglas Gregorc2350e52010-03-08 16:40:19 +00001877bool CursorVisitor::VisitObjCMessageExpr(ObjCMessageExpr *E) {
Douglas Gregor04badcf2010-04-21 00:45:42 +00001878 if (TypeSourceInfo *TSInfo = E->getClassReceiverTypeInfo())
1879 if (Visit(TSInfo->getTypeLoc()))
1880 return true;
Douglas Gregorc2350e52010-03-08 16:40:19 +00001881
1882 return VisitExpr(E);
1883}
1884
Douglas Gregor81d34662010-04-20 15:39:42 +00001885bool CursorVisitor::VisitObjCEncodeExpr(ObjCEncodeExpr *E) {
1886 return Visit(E->getEncodedTypeSourceInfo()->getTypeLoc());
1887}
1888
1889
Ted Kremenek09dfa372010-02-18 05:46:33 +00001890bool CursorVisitor::VisitAttributes(Decl *D) {
Sean Huntcf807c42010-08-18 23:23:40 +00001891 for (AttrVec::const_iterator i = D->attr_begin(), e = D->attr_end();
1892 i != e; ++i)
1893 if (Visit(MakeCXCursor(*i, D, TU)))
Ted Kremenek09dfa372010-02-18 05:46:33 +00001894 return true;
1895
1896 return false;
1897}
1898
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00001899extern "C" {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001900CXIndex clang_createIndex(int excludeDeclarationsFromPCH,
1901 int displayDiagnostics) {
Daniel Dunbarc7df4f32010-08-18 18:43:14 +00001902 // We use crash recovery to make some of our APIs more reliable, implicitly
1903 // enable it.
1904 llvm::CrashRecoveryContext::Enable();
1905
Douglas Gregora030b7c2010-01-22 20:35:53 +00001906 CIndexer *CIdxr = new CIndexer();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001907 if (excludeDeclarationsFromPCH)
1908 CIdxr->setOnlyLocalDecls();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001909 if (displayDiagnostics)
1910 CIdxr->setDisplayDiagnostics();
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001911 return CIdxr;
Steve Naroff600866c2009-08-27 19:51:58 +00001912}
1913
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001914void clang_disposeIndex(CXIndex CIdx) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001915 if (CIdx)
1916 delete static_cast<CIndexer *>(CIdx);
Douglas Gregor7a07fcb2010-08-09 21:00:09 +00001917 if (getenv("LIBCLANG_TIMING"))
1918 llvm::TimerGroup::printAll(llvm::errs());
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00001919}
1920
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001921void clang_setUseExternalASTGeneration(CXIndex CIdx, int value) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001922 if (CIdx) {
1923 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1924 CXXIdx->setUseExternalASTGeneration(value);
1925 }
Daniel Dunbar8506dde2009-12-03 01:54:28 +00001926}
1927
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001928CXTranslationUnit clang_createTranslationUnit(CXIndex CIdx,
Douglas Gregora88084b2010-02-18 18:08:43 +00001929 const char *ast_filename) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001930 if (!CIdx)
1931 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001932
Douglas Gregor7d1d49d2009-10-16 20:01:17 +00001933 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00001934
Douglas Gregor28019772010-04-05 23:52:57 +00001935 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
Sebastian Redl3c7f4132010-08-18 23:57:06 +00001936 return ASTUnit::LoadFromASTFile(ast_filename, Diags,
Douglas Gregora88084b2010-02-18 18:08:43 +00001937 CXXIdx->getOnlyLocalDecls(),
1938 0, 0, true);
Steve Naroff600866c2009-08-27 19:51:58 +00001939}
1940
Douglas Gregorb1c031b2010-08-09 22:28:58 +00001941unsigned clang_defaultEditingTranslationUnitOptions() {
1942 return CXTranslationUnit_PrecompiledPreamble;
1943}
1944
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00001945CXTranslationUnit
1946clang_createTranslationUnitFromSourceFile(CXIndex CIdx,
1947 const char *source_filename,
1948 int num_command_line_args,
Douglas Gregor2ef69442010-09-01 16:43:19 +00001949 const char * const *command_line_args,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001950 unsigned num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001951 struct CXUnsavedFile *unsaved_files) {
Douglas Gregor5a430212010-07-21 18:52:53 +00001952 return clang_parseTranslationUnit(CIdx, source_filename,
1953 command_line_args, num_command_line_args,
1954 unsaved_files, num_unsaved_files,
1955 CXTranslationUnit_DetailedPreprocessingRecord);
1956}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00001957
1958struct ParseTranslationUnitInfo {
1959 CXIndex CIdx;
1960 const char *source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00001961 const char *const *command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00001962 int num_command_line_args;
1963 struct CXUnsavedFile *unsaved_files;
1964 unsigned num_unsaved_files;
1965 unsigned options;
1966 CXTranslationUnit result;
1967};
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00001968static void clang_parseTranslationUnit_Impl(void *UserData) {
Daniel Dunbar19ffd492010-08-18 18:43:17 +00001969 ParseTranslationUnitInfo *PTUI =
1970 static_cast<ParseTranslationUnitInfo*>(UserData);
1971 CXIndex CIdx = PTUI->CIdx;
1972 const char *source_filename = PTUI->source_filename;
Douglas Gregor2ef69442010-09-01 16:43:19 +00001973 const char * const *command_line_args = PTUI->command_line_args;
Daniel Dunbar19ffd492010-08-18 18:43:17 +00001974 int num_command_line_args = PTUI->num_command_line_args;
1975 struct CXUnsavedFile *unsaved_files = PTUI->unsaved_files;
1976 unsigned num_unsaved_files = PTUI->num_unsaved_files;
1977 unsigned options = PTUI->options;
1978 PTUI->result = 0;
Douglas Gregor5a430212010-07-21 18:52:53 +00001979
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00001980 if (!CIdx)
Daniel Dunbar19ffd492010-08-18 18:43:17 +00001981 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001982
Steve Naroffe56b4ba2009-10-20 14:46:24 +00001983 CIndexer *CXXIdx = static_cast<CIndexer *>(CIdx);
1984
Douglas Gregor44c181a2010-07-23 00:33:23 +00001985 bool PrecompilePreamble = options & CXTranslationUnit_PrecompiledPreamble;
Douglas Gregordf95a132010-08-09 20:45:32 +00001986 bool CompleteTranslationUnit
1987 = ((options & CXTranslationUnit_Incomplete) == 0);
Douglas Gregor87c08a52010-08-13 22:48:40 +00001988 bool CacheCodeCompetionResults
1989 = options & CXTranslationUnit_CacheCompletionResults;
1990
Douglas Gregor5352ac02010-01-28 00:27:43 +00001991 // Configure the diagnostics.
1992 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00001993 llvm::IntrusiveRefCntPtr<Diagnostic> Diags;
1994 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001995
Douglas Gregor4db64a42010-01-23 00:14:00 +00001996 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
1997 for (unsigned I = 0; I != num_unsaved_files; ++I) {
Chris Lattnera0a270c2010-04-05 22:42:27 +00001998 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00001999 const llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +00002000 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregor4db64a42010-01-23 00:14:00 +00002001 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2002 Buffer));
2003 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002004
Daniel Dunbar8506dde2009-12-03 01:54:28 +00002005 if (!CXXIdx->getUseExternalASTGeneration()) {
2006 llvm::SmallVector<const char *, 16> Args;
2007
2008 // The 'source_filename' argument is optional. If the caller does not
2009 // specify it then it is assumed that the source file is specified
2010 // in the actual argument list.
2011 if (source_filename)
2012 Args.push_back(source_filename);
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002013
2014 // Since the Clang C library is primarily used by batch tools dealing with
2015 // (often very broken) source code, where spell-checking can have a
2016 // significant negative impact on performance (particularly when
2017 // precompiled headers are involved), we disable it by default.
2018 // Note that we place this argument early in the list, so that it can be
2019 // overridden by the caller with "-fspell-checking".
Douglas Gregora0068fc2010-07-09 17:35:33 +00002020 Args.push_back("-fno-spell-checking");
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002021
Daniel Dunbar8506dde2009-12-03 01:54:28 +00002022 Args.insert(Args.end(), command_line_args,
2023 command_line_args + num_command_line_args);
Douglas Gregor5a430212010-07-21 18:52:53 +00002024
Douglas Gregor44c181a2010-07-23 00:33:23 +00002025 // Do we need the detailed preprocessing record?
Douglas Gregor5a430212010-07-21 18:52:53 +00002026 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
2027 Args.push_back("-Xclang");
2028 Args.push_back("-detailed-preprocessing-record");
2029 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00002030
Douglas Gregor5352ac02010-01-28 00:27:43 +00002031 unsigned NumErrors = Diags->getNumErrors();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002032
Ted Kremenek29b72842010-01-07 22:49:05 +00002033#ifdef USE_CRASHTRACER
2034 ArgsCrashTracerInfo ACTI(Args);
Ted Kremenek8a8da7d2010-01-06 03:42:32 +00002035#endif
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002036
Daniel Dunbar94220972009-12-05 02:17:18 +00002037 llvm::OwningPtr<ASTUnit> Unit(
2038 ASTUnit::LoadFromCommandLine(Args.data(), Args.data() + Args.size(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +00002039 Diags,
Daniel Dunbar869824e2009-12-13 03:46:13 +00002040 CXXIdx->getClangResourcesPath(),
Daniel Dunbar94220972009-12-05 02:17:18 +00002041 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00002042 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00002043 RemappedFiles.size(),
Douglas Gregor44c181a2010-07-23 00:33:23 +00002044 /*CaptureDiagnostics=*/true,
Douglas Gregordf95a132010-08-09 20:45:32 +00002045 PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00002046 CompleteTranslationUnit,
2047 CacheCodeCompetionResults));
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002048
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002049 if (NumErrors != Diags->getNumErrors()) {
Ted Kremenek34f6a322010-03-05 22:43:29 +00002050 // Make sure to check that 'Unit' is non-NULL.
2051 if (CXXIdx->getDisplayDiagnostics() && Unit.get()) {
Douglas Gregor405634b2010-04-05 18:10:21 +00002052 for (ASTUnit::stored_diag_iterator D = Unit->stored_diag_begin(),
2053 DEnd = Unit->stored_diag_end();
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002054 D != DEnd; ++D) {
2055 CXStoredDiagnostic Diag(*D, Unit->getASTContext().getLangOptions());
Douglas Gregor274f1902010-02-22 23:17:23 +00002056 CXString Msg = clang_formatDiagnostic(&Diag,
2057 clang_defaultDiagnosticDisplayOptions());
2058 fprintf(stderr, "%s\n", clang_getCString(Msg));
2059 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002060 }
Douglas Gregor274f1902010-02-22 23:17:23 +00002061#ifdef LLVM_ON_WIN32
2062 // On Windows, force a flush, since there may be multiple copies of
2063 // stderr and stdout in the file system, all with different buffers
2064 // but writing to the same device.
2065 fflush(stderr);
Ted Kremenek83c51842010-03-26 01:34:51 +00002066#endif
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002067 }
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002068 }
Daniel Dunbar94220972009-12-05 02:17:18 +00002069
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002070 PTUI->result = Unit.take();
2071 return;
Daniel Dunbar8506dde2009-12-03 01:54:28 +00002072 }
2073
Ted Kremenek139ba862009-10-22 00:03:57 +00002074 // Build up the arguments for invoking 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00002075 std::vector<const char *> argv;
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002076
Ted Kremenek139ba862009-10-22 00:03:57 +00002077 // First add the complete path to the 'clang' executable.
2078 llvm::sys::Path ClangPath = static_cast<CIndexer *>(CIdx)->getClangPath();
Benjamin Kramer5e4bc592009-10-18 16:11:04 +00002079 argv.push_back(ClangPath.c_str());
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002080
Ted Kremenek139ba862009-10-22 00:03:57 +00002081 // Add the '-emit-ast' option as our execution mode for 'clang'.
Ted Kremenek74cd0692009-10-15 23:21:22 +00002082 argv.push_back("-emit-ast");
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002083
Ted Kremenek139ba862009-10-22 00:03:57 +00002084 // The 'source_filename' argument is optional. If the caller does not
2085 // specify it then it is assumed that the source file is specified
2086 // in the actual argument list.
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002087 if (source_filename)
2088 argv.push_back(source_filename);
Ted Kremenek139ba862009-10-22 00:03:57 +00002089
Steve Naroff37b5ac22009-10-15 20:50:09 +00002090 // Generate a temporary name for the AST file.
Ted Kremenek139ba862009-10-22 00:03:57 +00002091 argv.push_back("-o");
Benjamin Kramerc2a98162010-03-13 21:22:49 +00002092 char astTmpFile[L_tmpnam];
2093 argv.push_back(tmpnam(astTmpFile));
Douglas Gregor52ddc5d2010-07-09 18:39:07 +00002094
2095 // Since the Clang C library is primarily used by batch tools dealing with
2096 // (often very broken) source code, where spell-checking can have a
2097 // significant negative impact on performance (particularly when
2098 // precompiled headers are involved), we disable it by default.
2099 // Note that we place this argument early in the list, so that it can be
2100 // overridden by the caller with "-fspell-checking".
Douglas Gregora0068fc2010-07-09 17:35:33 +00002101 argv.push_back("-fno-spell-checking");
Ted Kremenek139ba862009-10-22 00:03:57 +00002102
Douglas Gregor4db64a42010-01-23 00:14:00 +00002103 // Remap any unsaved files to temporary files.
2104 std::vector<llvm::sys::Path> TemporaryFiles;
2105 std::vector<std::string> RemapArgs;
2106 if (RemapFiles(num_unsaved_files, unsaved_files, RemapArgs, TemporaryFiles))
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002107 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002108
Douglas Gregor4db64a42010-01-23 00:14:00 +00002109 // The pointers into the elements of RemapArgs are stable because we
2110 // won't be adding anything to RemapArgs after this point.
2111 for (unsigned i = 0, e = RemapArgs.size(); i != e; ++i)
2112 argv.push_back(RemapArgs[i].c_str());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002113
Ted Kremenek139ba862009-10-22 00:03:57 +00002114 // Process the compiler options, stripping off '-o', '-c', '-fsyntax-only'.
2115 for (int i = 0; i < num_command_line_args; ++i)
2116 if (const char *arg = command_line_args[i]) {
2117 if (strcmp(arg, "-o") == 0) {
2118 ++i; // Also skip the matching argument.
2119 continue;
2120 }
2121 if (strcmp(arg, "-emit-ast") == 0 ||
2122 strcmp(arg, "-c") == 0 ||
2123 strcmp(arg, "-fsyntax-only") == 0) {
2124 continue;
2125 }
2126
2127 // Keep the argument.
2128 argv.push_back(arg);
Steve Naroffe56b4ba2009-10-20 14:46:24 +00002129 }
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002130
Douglas Gregord93256e2010-01-28 06:00:51 +00002131 // Generate a temporary name for the diagnostics file.
Benjamin Kramerc2a98162010-03-13 21:22:49 +00002132 char tmpFileResults[L_tmpnam];
2133 char *tmpResultsFileName = tmpnam(tmpFileResults);
2134 llvm::sys::Path DiagnosticsFile(tmpResultsFileName);
Douglas Gregord93256e2010-01-28 06:00:51 +00002135 TemporaryFiles.push_back(DiagnosticsFile);
2136 argv.push_back("-fdiagnostics-binary");
2137
Douglas Gregor44c181a2010-07-23 00:33:23 +00002138 // Do we need the detailed preprocessing record?
2139 if (options & CXTranslationUnit_DetailedPreprocessingRecord) {
2140 argv.push_back("-Xclang");
2141 argv.push_back("-detailed-preprocessing-record");
2142 }
2143
Ted Kremenek139ba862009-10-22 00:03:57 +00002144 // Add the null terminator.
Ted Kremenek74cd0692009-10-15 23:21:22 +00002145 argv.push_back(NULL);
2146
Ted Kremenekfeb15e32009-10-26 22:14:08 +00002147 // Invoke 'clang'.
2148 llvm::sys::Path DevNull; // leave empty, causes redirection to /dev/null
2149 // on Unix or NUL (Windows).
Ted Kremenek379afec2009-10-22 03:24:01 +00002150 std::string ErrMsg;
Douglas Gregord93256e2010-01-28 06:00:51 +00002151 const llvm::sys::Path *Redirects[] = { &DevNull, &DevNull, &DiagnosticsFile,
2152 NULL };
Ted Kremenek379afec2009-10-22 03:24:01 +00002153 llvm::sys::Program::ExecuteAndWait(ClangPath, &argv[0], /* env */ NULL,
Douglas Gregor936ea3b2010-01-28 00:56:43 +00002154 /* redirects */ &Redirects[0],
Ted Kremenek379afec2009-10-22 03:24:01 +00002155 /* secondsToWait */ 0, /* memoryLimits */ 0, &ErrMsg);
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002156
Douglas Gregor936ea3b2010-01-28 00:56:43 +00002157 if (!ErrMsg.empty()) {
2158 std::string AllArgs;
Ted Kremenek379afec2009-10-22 03:24:01 +00002159 for (std::vector<const char*>::iterator I = argv.begin(), E = argv.end();
Douglas Gregor936ea3b2010-01-28 00:56:43 +00002160 I != E; ++I) {
2161 AllArgs += ' ';
Ted Kremenek779e5f42009-10-26 22:08:39 +00002162 if (*I)
Douglas Gregor936ea3b2010-01-28 00:56:43 +00002163 AllArgs += *I;
Ted Kremenek779e5f42009-10-26 22:08:39 +00002164 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002165
Daniel Dunbar32141c82010-02-23 20:23:45 +00002166 Diags->Report(diag::err_fe_invoking) << AllArgs << ErrMsg;
Ted Kremenek379afec2009-10-22 03:24:01 +00002167 }
Benjamin Kramer0829a832009-10-18 11:19:36 +00002168
Sebastian Redl3c7f4132010-08-18 23:57:06 +00002169 ASTUnit *ATU = ASTUnit::LoadFromASTFile(astTmpFile, Diags,
Douglas Gregor4db64a42010-01-23 00:14:00 +00002170 CXXIdx->getOnlyLocalDecls(),
Douglas Gregor4db64a42010-01-23 00:14:00 +00002171 RemappedFiles.data(),
Douglas Gregora88084b2010-02-18 18:08:43 +00002172 RemappedFiles.size(),
2173 /*CaptureDiagnostics=*/true);
Douglas Gregora88084b2010-02-18 18:08:43 +00002174 if (ATU) {
2175 LoadSerializedDiagnostics(DiagnosticsFile,
2176 num_unsaved_files, unsaved_files,
2177 ATU->getFileManager(),
2178 ATU->getSourceManager(),
Douglas Gregor405634b2010-04-05 18:10:21 +00002179 ATU->getStoredDiagnostics());
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002180 } else if (CXXIdx->getDisplayDiagnostics()) {
2181 // We failed to load the ASTUnit, but we can still deserialize the
2182 // diagnostics and emit them.
2183 FileManager FileMgr;
Douglas Gregorf715ca12010-03-16 00:06:06 +00002184 Diagnostic Diag;
2185 SourceManager SourceMgr(Diag);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002186 // FIXME: Faked LangOpts!
2187 LangOptions LangOpts;
2188 llvm::SmallVector<StoredDiagnostic, 4> Diags;
2189 LoadSerializedDiagnostics(DiagnosticsFile,
2190 num_unsaved_files, unsaved_files,
2191 FileMgr, SourceMgr, Diags);
2192 for (llvm::SmallVector<StoredDiagnostic, 4>::iterator D = Diags.begin(),
2193 DEnd = Diags.end();
2194 D != DEnd; ++D) {
2195 CXStoredDiagnostic Diag(*D, LangOpts);
Douglas Gregor274f1902010-02-22 23:17:23 +00002196 CXString Msg = clang_formatDiagnostic(&Diag,
2197 clang_defaultDiagnosticDisplayOptions());
2198 fprintf(stderr, "%s\n", clang_getCString(Msg));
2199 clang_disposeString(Msg);
Douglas Gregor0a812cf2010-02-18 23:07:20 +00002200 }
Douglas Gregor274f1902010-02-22 23:17:23 +00002201
2202#ifdef LLVM_ON_WIN32
2203 // On Windows, force a flush, since there may be multiple copies of
2204 // stderr and stdout in the file system, all with different buffers
2205 // but writing to the same device.
2206 fflush(stderr);
2207#endif
Douglas Gregora88084b2010-02-18 18:08:43 +00002208 }
Douglas Gregord93256e2010-01-28 06:00:51 +00002209
Douglas Gregor313e26c2010-02-18 23:35:40 +00002210 if (ATU) {
2211 // Make the translation unit responsible for destroying all temporary files.
2212 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
2213 ATU->addTemporaryFile(TemporaryFiles[i]);
Sebastian Redl3c7f4132010-08-18 23:57:06 +00002214 ATU->addTemporaryFile(llvm::sys::Path(ATU->getASTFileName()));
Douglas Gregor313e26c2010-02-18 23:35:40 +00002215 } else {
2216 // Destroy all of the temporary files now; they can't be referenced any
2217 // longer.
2218 llvm::sys::Path(astTmpFile).eraseFromDisk();
2219 for (unsigned i = 0, e = TemporaryFiles.size(); i != e; ++i)
2220 TemporaryFiles[i].eraseFromDisk();
2221 }
2222
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002223 PTUI->result = ATU;
2224}
2225CXTranslationUnit clang_parseTranslationUnit(CXIndex CIdx,
2226 const char *source_filename,
Douglas Gregor2ef69442010-09-01 16:43:19 +00002227 const char * const *command_line_args,
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002228 int num_command_line_args,
2229 struct CXUnsavedFile *unsaved_files,
2230 unsigned num_unsaved_files,
2231 unsigned options) {
2232 ParseTranslationUnitInfo PTUI = { CIdx, source_filename, command_line_args,
2233 num_command_line_args, unsaved_files, num_unsaved_files,
2234 options, 0 };
2235 llvm::CrashRecoveryContext CRC;
2236
2237 if (!CRC.RunSafely(clang_parseTranslationUnit_Impl, &PTUI)) {
Daniel Dunbar60a45432010-08-23 22:35:34 +00002238 fprintf(stderr, "libclang: crash detected during parsing: {\n");
2239 fprintf(stderr, " 'source_filename' : '%s'\n", source_filename);
2240 fprintf(stderr, " 'command_line_args' : [");
2241 for (int i = 0; i != num_command_line_args; ++i) {
2242 if (i)
2243 fprintf(stderr, ", ");
2244 fprintf(stderr, "'%s'", command_line_args[i]);
2245 }
2246 fprintf(stderr, "],\n");
2247 fprintf(stderr, " 'unsaved_files' : [");
2248 for (unsigned i = 0; i != num_unsaved_files; ++i) {
2249 if (i)
2250 fprintf(stderr, ", ");
2251 fprintf(stderr, "('%s', '...', %ld)", unsaved_files[i].Filename,
2252 unsaved_files[i].Length);
2253 }
2254 fprintf(stderr, "],\n");
2255 fprintf(stderr, " 'options' : %d,\n", options);
2256 fprintf(stderr, "}\n");
2257
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002258 return 0;
2259 }
2260
2261 return PTUI.result;
Steve Naroff5b7d8e22009-10-15 20:04:39 +00002262}
2263
Douglas Gregor19998442010-08-13 15:35:05 +00002264unsigned clang_defaultSaveOptions(CXTranslationUnit TU) {
2265 return CXSaveTranslationUnit_None;
2266}
2267
2268int clang_saveTranslationUnit(CXTranslationUnit TU, const char *FileName,
2269 unsigned options) {
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002270 if (!TU)
2271 return 1;
2272
2273 return static_cast<ASTUnit *>(TU)->Save(FileName);
2274}
Daniel Dunbar19ffd492010-08-18 18:43:17 +00002275
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002276void clang_disposeTranslationUnit(CXTranslationUnit CTUnit) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002277 if (CTUnit) {
2278 // If the translation unit has been marked as unsafe to free, just discard
2279 // it.
2280 if (static_cast<ASTUnit *>(CTUnit)->isUnsafeToFree())
2281 return;
2282
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002283 delete static_cast<ASTUnit *>(CTUnit);
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002284 }
Steve Naroff2bd6b9f2009-09-17 18:33:27 +00002285}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002286
Douglas Gregore1e13bf2010-08-11 15:58:42 +00002287unsigned clang_defaultReparseOptions(CXTranslationUnit TU) {
2288 return CXReparse_None;
2289}
2290
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002291struct ReparseTranslationUnitInfo {
2292 CXTranslationUnit TU;
2293 unsigned num_unsaved_files;
2294 struct CXUnsavedFile *unsaved_files;
2295 unsigned options;
2296 int result;
2297};
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002298static void clang_reparseTranslationUnit_Impl(void *UserData) {
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002299 ReparseTranslationUnitInfo *RTUI =
2300 static_cast<ReparseTranslationUnitInfo*>(UserData);
2301 CXTranslationUnit TU = RTUI->TU;
2302 unsigned num_unsaved_files = RTUI->num_unsaved_files;
2303 struct CXUnsavedFile *unsaved_files = RTUI->unsaved_files;
2304 unsigned options = RTUI->options;
2305 (void) options;
2306 RTUI->result = 1;
2307
Douglas Gregorabc563f2010-07-19 21:46:24 +00002308 if (!TU)
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002309 return;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002310
2311 llvm::SmallVector<ASTUnit::RemappedFile, 4> RemappedFiles;
2312 for (unsigned I = 0; I != num_unsaved_files; ++I) {
2313 llvm::StringRef Data(unsaved_files[I].Contents, unsaved_files[I].Length);
2314 const llvm::MemoryBuffer *Buffer
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002315 = llvm::MemoryBuffer::getMemBufferCopy(Data, unsaved_files[I].Filename);
Douglas Gregorabc563f2010-07-19 21:46:24 +00002316 RemappedFiles.push_back(std::make_pair(unsaved_files[I].Filename,
2317 Buffer));
2318 }
2319
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002320 if (!static_cast<ASTUnit *>(TU)->Reparse(RemappedFiles.data(),
2321 RemappedFiles.size()))
2322 RTUI->result = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002323}
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002324int clang_reparseTranslationUnit(CXTranslationUnit TU,
2325 unsigned num_unsaved_files,
2326 struct CXUnsavedFile *unsaved_files,
2327 unsigned options) {
2328 ReparseTranslationUnitInfo RTUI = { TU, num_unsaved_files, unsaved_files,
2329 options, 0 };
2330 llvm::CrashRecoveryContext CRC;
2331
2332 if (!CRC.RunSafely(clang_reparseTranslationUnit_Impl, &RTUI)) {
Daniel Dunbarb1fd3452010-08-19 23:44:10 +00002333 fprintf(stderr, "libclang: crash detected during reparsing\n");
Daniel Dunbarea94bbc2010-08-18 23:09:31 +00002334 static_cast<ASTUnit *>(TU)->setUnsafeToFree(true);
2335 return 1;
2336 }
2337
2338 return RTUI.result;
2339}
2340
Douglas Gregordf95a132010-08-09 20:45:32 +00002341
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002342CXString clang_getTranslationUnitSpelling(CXTranslationUnit CTUnit) {
Douglas Gregor2b37c9e2010-01-29 00:47:48 +00002343 if (!CTUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002344 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002345
Steve Naroff77accc12009-09-03 18:19:54 +00002346 ASTUnit *CXXUnit = static_cast<ASTUnit *>(CTUnit);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002347 return createCXString(CXXUnit->getOriginalSourceFileName(), true);
Steve Naroffaf08ddc2009-09-03 15:49:00 +00002348}
Daniel Dunbar1eb79b52009-08-28 16:30:07 +00002349
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002350CXCursor clang_getTranslationUnitCursor(CXTranslationUnit TU) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002351 CXCursor Result = { CXCursor_TranslationUnit, { 0, 0, TU } };
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002352 return Result;
2353}
2354
Ted Kremenekfb480492010-01-13 21:46:36 +00002355} // end: extern "C"
Steve Naroff600866c2009-08-27 19:51:58 +00002356
Ted Kremenekfb480492010-01-13 21:46:36 +00002357//===----------------------------------------------------------------------===//
Douglas Gregor1db19de2010-01-19 21:36:55 +00002358// CXSourceLocation and CXSourceRange Operations.
2359//===----------------------------------------------------------------------===//
2360
Douglas Gregorb9790342010-01-22 21:44:22 +00002361extern "C" {
2362CXSourceLocation clang_getNullLocation() {
Douglas Gregor5352ac02010-01-28 00:27:43 +00002363 CXSourceLocation Result = { { 0, 0 }, 0 };
Douglas Gregorb9790342010-01-22 21:44:22 +00002364 return Result;
2365}
2366
2367unsigned clang_equalLocations(CXSourceLocation loc1, CXSourceLocation loc2) {
Daniel Dunbar90a6b9e2010-01-30 23:58:27 +00002368 return (loc1.ptr_data[0] == loc2.ptr_data[0] &&
2369 loc1.ptr_data[1] == loc2.ptr_data[1] &&
2370 loc1.int_data == loc2.int_data);
Douglas Gregorb9790342010-01-22 21:44:22 +00002371}
2372
2373CXSourceLocation clang_getLocation(CXTranslationUnit tu,
2374 CXFile file,
2375 unsigned line,
2376 unsigned column) {
Douglas Gregor42748ec2010-04-30 19:45:53 +00002377 if (!tu || !file)
Douglas Gregorb9790342010-01-22 21:44:22 +00002378 return clang_getNullLocation();
Douglas Gregor42748ec2010-04-30 19:45:53 +00002379
Douglas Gregorb9790342010-01-22 21:44:22 +00002380 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
2381 SourceLocation SLoc
2382 = CXXUnit->getSourceManager().getLocation(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002383 static_cast<const FileEntry *>(file),
Douglas Gregorb9790342010-01-22 21:44:22 +00002384 line, column);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002385
Ted Kremenek1a9a0bc2010-06-28 23:54:17 +00002386 return cxloc::translateSourceLocation(CXXUnit->getASTContext(), SLoc);
Douglas Gregorb9790342010-01-22 21:44:22 +00002387}
2388
Douglas Gregor5352ac02010-01-28 00:27:43 +00002389CXSourceRange clang_getNullRange() {
2390 CXSourceRange Result = { { 0, 0 }, 0, 0 };
2391 return Result;
2392}
Daniel Dunbard52864b2010-02-14 10:02:57 +00002393
Douglas Gregor5352ac02010-01-28 00:27:43 +00002394CXSourceRange clang_getRange(CXSourceLocation begin, CXSourceLocation end) {
2395 if (begin.ptr_data[0] != end.ptr_data[0] ||
2396 begin.ptr_data[1] != end.ptr_data[1])
2397 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002398
2399 CXSourceRange Result = { { begin.ptr_data[0], begin.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002400 begin.int_data, end.int_data };
Douglas Gregorb9790342010-01-22 21:44:22 +00002401 return Result;
2402}
2403
Douglas Gregor46766dc2010-01-26 19:19:08 +00002404void clang_getInstantiationLocation(CXSourceLocation location,
2405 CXFile *file,
2406 unsigned *line,
2407 unsigned *column,
2408 unsigned *offset) {
Douglas Gregor1db19de2010-01-19 21:36:55 +00002409 SourceLocation Loc = SourceLocation::getFromRawEncoding(location.int_data);
2410
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002411 if (!location.ptr_data[0] || Loc.isInvalid()) {
Douglas Gregor46766dc2010-01-26 19:19:08 +00002412 if (file)
2413 *file = 0;
2414 if (line)
2415 *line = 0;
2416 if (column)
2417 *column = 0;
2418 if (offset)
2419 *offset = 0;
2420 return;
2421 }
2422
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002423 const SourceManager &SM =
2424 *static_cast<const SourceManager*>(location.ptr_data[0]);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002425 SourceLocation InstLoc = SM.getInstantiationLoc(Loc);
Douglas Gregor1db19de2010-01-19 21:36:55 +00002426
2427 if (file)
2428 *file = (void *)SM.getFileEntryForID(SM.getFileID(InstLoc));
2429 if (line)
2430 *line = SM.getInstantiationLineNumber(InstLoc);
2431 if (column)
2432 *column = SM.getInstantiationColumnNumber(InstLoc);
Douglas Gregore69517c2010-01-26 03:07:15 +00002433 if (offset)
Douglas Gregor46766dc2010-01-26 19:19:08 +00002434 *offset = SM.getDecomposedLoc(InstLoc).second;
Douglas Gregore69517c2010-01-26 03:07:15 +00002435}
2436
Douglas Gregor1db19de2010-01-19 21:36:55 +00002437CXSourceLocation clang_getRangeStart(CXSourceRange range) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002438 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002439 range.begin_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002440 return Result;
2441}
2442
2443CXSourceLocation clang_getRangeEnd(CXSourceRange range) {
Daniel Dunbarbb4a61a2010-02-14 01:47:36 +00002444 CXSourceLocation Result = { { range.ptr_data[0], range.ptr_data[1] },
Douglas Gregor5352ac02010-01-28 00:27:43 +00002445 range.end_int_data };
Douglas Gregor1db19de2010-01-19 21:36:55 +00002446 return Result;
2447}
2448
Douglas Gregorb9790342010-01-22 21:44:22 +00002449} // end: extern "C"
2450
Douglas Gregor1db19de2010-01-19 21:36:55 +00002451//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00002452// CXFile Operations.
2453//===----------------------------------------------------------------------===//
2454
2455extern "C" {
Ted Kremenek74844072010-02-17 00:41:20 +00002456CXString clang_getFileName(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002457 if (!SFile)
Ted Kremenek74844072010-02-17 00:41:20 +00002458 return createCXString(NULL);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002459
Steve Naroff88145032009-10-27 14:35:18 +00002460 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
Ted Kremenek74844072010-02-17 00:41:20 +00002461 return createCXString(FEnt->getName());
Steve Naroff88145032009-10-27 14:35:18 +00002462}
2463
2464time_t clang_getFileTime(CXFile SFile) {
Douglas Gregor98258af2010-01-18 22:46:11 +00002465 if (!SFile)
2466 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002467
Steve Naroff88145032009-10-27 14:35:18 +00002468 FileEntry *FEnt = static_cast<FileEntry *>(SFile);
2469 return FEnt->getModificationTime();
Steve Naroffee9405e2009-09-25 21:45:39 +00002470}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002471
Douglas Gregorb9790342010-01-22 21:44:22 +00002472CXFile clang_getFile(CXTranslationUnit tu, const char *file_name) {
2473 if (!tu)
2474 return 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002475
Douglas Gregorb9790342010-01-22 21:44:22 +00002476 ASTUnit *CXXUnit = static_cast<ASTUnit *>(tu);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002477
Douglas Gregorb9790342010-01-22 21:44:22 +00002478 FileManager &FMgr = CXXUnit->getFileManager();
2479 const FileEntry *File = FMgr.getFile(file_name, file_name+strlen(file_name));
2480 return const_cast<FileEntry *>(File);
2481}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002482
Ted Kremenekfb480492010-01-13 21:46:36 +00002483} // end: extern "C"
Steve Naroffee9405e2009-09-25 21:45:39 +00002484
Ted Kremenekfb480492010-01-13 21:46:36 +00002485//===----------------------------------------------------------------------===//
2486// CXCursor Operations.
2487//===----------------------------------------------------------------------===//
2488
Ted Kremenekfb480492010-01-13 21:46:36 +00002489static Decl *getDeclFromExpr(Stmt *E) {
2490 if (DeclRefExpr *RefExpr = dyn_cast<DeclRefExpr>(E))
2491 return RefExpr->getDecl();
2492 if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
2493 return ME->getMemberDecl();
2494 if (ObjCIvarRefExpr *RE = dyn_cast<ObjCIvarRefExpr>(E))
2495 return RE->getDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002496
Ted Kremenekfb480492010-01-13 21:46:36 +00002497 if (CallExpr *CE = dyn_cast<CallExpr>(E))
2498 return getDeclFromExpr(CE->getCallee());
2499 if (CastExpr *CE = dyn_cast<CastExpr>(E))
2500 return getDeclFromExpr(CE->getSubExpr());
2501 if (ObjCMessageExpr *OME = dyn_cast<ObjCMessageExpr>(E))
2502 return OME->getMethodDecl();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002503
Ted Kremenekfb480492010-01-13 21:46:36 +00002504 return 0;
2505}
2506
Daniel Dunbarc29f4c32010-02-02 05:00:22 +00002507static SourceLocation getLocationFromExpr(Expr *E) {
2508 if (ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E))
2509 return /*FIXME:*/Msg->getLeftLoc();
2510 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
2511 return DRE->getLocation();
2512 if (MemberExpr *Member = dyn_cast<MemberExpr>(E))
2513 return Member->getMemberLoc();
2514 if (ObjCIvarRefExpr *Ivar = dyn_cast<ObjCIvarRefExpr>(E))
2515 return Ivar->getLocation();
2516 return E->getLocStart();
2517}
2518
Ted Kremenekfb480492010-01-13 21:46:36 +00002519extern "C" {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002520
2521unsigned clang_visitChildren(CXCursor parent,
Douglas Gregorb1373d02010-01-20 20:59:29 +00002522 CXCursorVisitor visitor,
2523 CXClientData client_data) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002524 ASTUnit *CXXUnit = getCursorASTUnit(parent);
Douglas Gregorb1373d02010-01-20 20:59:29 +00002525
Douglas Gregoreb8837b2010-08-03 19:06:41 +00002526 CursorVisitor CursorVis(CXXUnit, visitor, client_data,
2527 CXXUnit->getMaxPCHLevel());
Douglas Gregorb1373d02010-01-20 20:59:29 +00002528 return CursorVis.VisitChildren(parent);
2529}
2530
Douglas Gregor78205d42010-01-20 21:45:58 +00002531static CXString getDeclSpelling(Decl *D) {
2532 NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D);
2533 if (!ND)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002534 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002535
Douglas Gregor78205d42010-01-20 21:45:58 +00002536 if (ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(ND))
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002537 return createCXString(OMD->getSelector().getAsString());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002538
Douglas Gregor78205d42010-01-20 21:45:58 +00002539 if (ObjCCategoryImplDecl *CIMP = dyn_cast<ObjCCategoryImplDecl>(ND))
2540 // No, this isn't the same as the code below. getIdentifier() is non-virtual
2541 // and returns different names. NamedDecl returns the class name and
2542 // ObjCCategoryImplDecl returns the category name.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002543 return createCXString(CIMP->getIdentifier()->getNameStart());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002544
Douglas Gregor0a35bce2010-09-01 03:07:18 +00002545 if (isa<UsingDirectiveDecl>(D))
2546 return createCXString("");
2547
Ted Kremenek50aa6ac2010-05-19 21:51:10 +00002548 llvm::SmallString<1024> S;
2549 llvm::raw_svector_ostream os(S);
2550 ND->printName(os);
2551
2552 return createCXString(os.str());
Douglas Gregor78205d42010-01-20 21:45:58 +00002553}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002554
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002555CXString clang_getCursorSpelling(CXCursor C) {
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002556 if (clang_isTranslationUnit(C.kind))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00002557 return clang_getTranslationUnitSpelling(C.data[2]);
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002558
Steve Narofff334b4e2009-09-02 18:26:48 +00002559 if (clang_isReference(C.kind)) {
2560 switch (C.kind) {
Daniel Dunbaracca7252009-11-30 20:42:49 +00002561 case CXCursor_ObjCSuperClassRef: {
Douglas Gregor2e331b92010-01-16 14:00:32 +00002562 ObjCInterfaceDecl *Super = getCursorObjCSuperClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002563 return createCXString(Super->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002564 }
2565 case CXCursor_ObjCClassRef: {
Douglas Gregor1adb0822010-01-16 17:14:40 +00002566 ObjCInterfaceDecl *Class = getCursorObjCClassRef(C).first;
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002567 return createCXString(Class->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002568 }
2569 case CXCursor_ObjCProtocolRef: {
Douglas Gregor78db0cd2010-01-16 15:44:18 +00002570 ObjCProtocolDecl *OID = getCursorObjCProtocolRef(C).first;
Douglas Gregorf46034a2010-01-18 23:41:10 +00002571 assert(OID && "getCursorSpelling(): Missing protocol decl");
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002572 return createCXString(OID->getIdentifier()->getNameStart());
Daniel Dunbaracca7252009-11-30 20:42:49 +00002573 }
Ted Kremenek3064ef92010-08-27 21:34:58 +00002574 case CXCursor_CXXBaseSpecifier: {
2575 CXXBaseSpecifier *B = getCursorCXXBaseSpecifier(C);
2576 return createCXString(B->getType().getAsString());
2577 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002578 case CXCursor_TypeRef: {
2579 TypeDecl *Type = getCursorTypeRef(C).first;
2580 assert(Type && "Missing type decl");
2581
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002582 return createCXString(getCursorContext(C).getTypeDeclType(Type).
2583 getAsString());
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002584 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00002585 case CXCursor_TemplateRef: {
2586 TemplateDecl *Template = getCursorTemplateRef(C).first;
Douglas Gregor69319002010-08-31 23:48:11 +00002587 assert(Template && "Missing template decl");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002588
2589 return createCXString(Template->getNameAsString());
2590 }
Douglas Gregor69319002010-08-31 23:48:11 +00002591
2592 case CXCursor_NamespaceRef: {
2593 NamedDecl *NS = getCursorNamespaceRef(C).first;
2594 assert(NS && "Missing namespace decl");
2595
2596 return createCXString(NS->getNameAsString());
2597 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002598
Douglas Gregora67e03f2010-09-09 21:42:20 +00002599 case CXCursor_MemberRef: {
2600 FieldDecl *Field = getCursorMemberRef(C).first;
2601 assert(Field && "Missing member decl");
2602
2603 return createCXString(Field->getNameAsString());
2604 }
2605
Daniel Dunbaracca7252009-11-30 20:42:49 +00002606 default:
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002607 return createCXString("<not implemented>");
Steve Narofff334b4e2009-09-02 18:26:48 +00002608 }
2609 }
Douglas Gregor97b98722010-01-19 23:20:36 +00002610
2611 if (clang_isExpression(C.kind)) {
2612 Decl *D = getDeclFromExpr(getCursorExpr(C));
2613 if (D)
Douglas Gregor78205d42010-01-20 21:45:58 +00002614 return getDeclSpelling(D);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002615 return createCXString("");
Douglas Gregor97b98722010-01-19 23:20:36 +00002616 }
2617
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002618 if (C.kind == CXCursor_MacroInstantiation)
2619 return createCXString(getCursorMacroInstantiation(C)->getName()
2620 ->getNameStart());
2621
Douglas Gregor572feb22010-03-18 18:04:21 +00002622 if (C.kind == CXCursor_MacroDefinition)
2623 return createCXString(getCursorMacroDefinition(C)->getName()
2624 ->getNameStart());
2625
Douglas Gregor60cbfac2010-01-25 16:56:17 +00002626 if (clang_isDeclaration(C.kind))
2627 return getDeclSpelling(getCursorDecl(C));
Ted Kremeneke68fff62010-02-17 00:41:32 +00002628
Ted Kremenekee4db4f2010-02-17 00:41:08 +00002629 return createCXString("");
Steve Narofff334b4e2009-09-02 18:26:48 +00002630}
2631
Ted Kremeneke68fff62010-02-17 00:41:32 +00002632CXString clang_getCursorKindSpelling(enum CXCursorKind Kind) {
Steve Naroff89922f82009-08-31 00:59:03 +00002633 switch (Kind) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00002634 case CXCursor_FunctionDecl:
2635 return createCXString("FunctionDecl");
2636 case CXCursor_TypedefDecl:
2637 return createCXString("TypedefDecl");
2638 case CXCursor_EnumDecl:
2639 return createCXString("EnumDecl");
2640 case CXCursor_EnumConstantDecl:
2641 return createCXString("EnumConstantDecl");
2642 case CXCursor_StructDecl:
2643 return createCXString("StructDecl");
2644 case CXCursor_UnionDecl:
2645 return createCXString("UnionDecl");
2646 case CXCursor_ClassDecl:
2647 return createCXString("ClassDecl");
2648 case CXCursor_FieldDecl:
2649 return createCXString("FieldDecl");
2650 case CXCursor_VarDecl:
2651 return createCXString("VarDecl");
2652 case CXCursor_ParmDecl:
2653 return createCXString("ParmDecl");
2654 case CXCursor_ObjCInterfaceDecl:
2655 return createCXString("ObjCInterfaceDecl");
2656 case CXCursor_ObjCCategoryDecl:
2657 return createCXString("ObjCCategoryDecl");
2658 case CXCursor_ObjCProtocolDecl:
2659 return createCXString("ObjCProtocolDecl");
2660 case CXCursor_ObjCPropertyDecl:
2661 return createCXString("ObjCPropertyDecl");
2662 case CXCursor_ObjCIvarDecl:
2663 return createCXString("ObjCIvarDecl");
2664 case CXCursor_ObjCInstanceMethodDecl:
2665 return createCXString("ObjCInstanceMethodDecl");
2666 case CXCursor_ObjCClassMethodDecl:
2667 return createCXString("ObjCClassMethodDecl");
2668 case CXCursor_ObjCImplementationDecl:
2669 return createCXString("ObjCImplementationDecl");
2670 case CXCursor_ObjCCategoryImplDecl:
2671 return createCXString("ObjCCategoryImplDecl");
Ted Kremenek8bd5a692010-04-13 23:39:06 +00002672 case CXCursor_CXXMethod:
2673 return createCXString("CXXMethod");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002674 case CXCursor_UnexposedDecl:
2675 return createCXString("UnexposedDecl");
2676 case CXCursor_ObjCSuperClassRef:
2677 return createCXString("ObjCSuperClassRef");
2678 case CXCursor_ObjCProtocolRef:
2679 return createCXString("ObjCProtocolRef");
2680 case CXCursor_ObjCClassRef:
2681 return createCXString("ObjCClassRef");
2682 case CXCursor_TypeRef:
2683 return createCXString("TypeRef");
Douglas Gregor0b36e612010-08-31 20:37:03 +00002684 case CXCursor_TemplateRef:
2685 return createCXString("TemplateRef");
Douglas Gregor69319002010-08-31 23:48:11 +00002686 case CXCursor_NamespaceRef:
2687 return createCXString("NamespaceRef");
Douglas Gregora67e03f2010-09-09 21:42:20 +00002688 case CXCursor_MemberRef:
2689 return createCXString("MemberRef");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002690 case CXCursor_UnexposedExpr:
2691 return createCXString("UnexposedExpr");
Ted Kremenek1ee6cad2010-04-11 21:47:37 +00002692 case CXCursor_BlockExpr:
2693 return createCXString("BlockExpr");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002694 case CXCursor_DeclRefExpr:
2695 return createCXString("DeclRefExpr");
2696 case CXCursor_MemberRefExpr:
2697 return createCXString("MemberRefExpr");
2698 case CXCursor_CallExpr:
2699 return createCXString("CallExpr");
2700 case CXCursor_ObjCMessageExpr:
2701 return createCXString("ObjCMessageExpr");
2702 case CXCursor_UnexposedStmt:
2703 return createCXString("UnexposedStmt");
2704 case CXCursor_InvalidFile:
2705 return createCXString("InvalidFile");
Ted Kremenek292db642010-03-19 20:39:05 +00002706 case CXCursor_InvalidCode:
2707 return createCXString("InvalidCode");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002708 case CXCursor_NoDeclFound:
2709 return createCXString("NoDeclFound");
2710 case CXCursor_NotImplemented:
2711 return createCXString("NotImplemented");
2712 case CXCursor_TranslationUnit:
2713 return createCXString("TranslationUnit");
Ted Kremeneke77f4432010-02-18 03:09:07 +00002714 case CXCursor_UnexposedAttr:
2715 return createCXString("UnexposedAttr");
2716 case CXCursor_IBActionAttr:
2717 return createCXString("attribute(ibaction)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002718 case CXCursor_IBOutletAttr:
2719 return createCXString("attribute(iboutlet)");
Ted Kremenek857e9182010-05-19 17:38:06 +00002720 case CXCursor_IBOutletCollectionAttr:
2721 return createCXString("attribute(iboutletcollection)");
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002722 case CXCursor_PreprocessingDirective:
2723 return createCXString("preprocessing directive");
Douglas Gregor572feb22010-03-18 18:04:21 +00002724 case CXCursor_MacroDefinition:
2725 return createCXString("macro definition");
Douglas Gregor48072312010-03-18 15:23:44 +00002726 case CXCursor_MacroInstantiation:
2727 return createCXString("macro instantiation");
Ted Kremenek8f06e0e2010-05-06 23:38:21 +00002728 case CXCursor_Namespace:
2729 return createCXString("Namespace");
Ted Kremeneka0536d82010-05-07 01:04:29 +00002730 case CXCursor_LinkageSpec:
2731 return createCXString("LinkageSpec");
Ted Kremenek3064ef92010-08-27 21:34:58 +00002732 case CXCursor_CXXBaseSpecifier:
2733 return createCXString("C++ base class specifier");
Douglas Gregor01829d32010-08-31 14:41:23 +00002734 case CXCursor_Constructor:
2735 return createCXString("CXXConstructor");
2736 case CXCursor_Destructor:
2737 return createCXString("CXXDestructor");
2738 case CXCursor_ConversionFunction:
2739 return createCXString("CXXConversion");
Douglas Gregorfe72e9c2010-08-31 17:01:39 +00002740 case CXCursor_TemplateTypeParameter:
2741 return createCXString("TemplateTypeParameter");
2742 case CXCursor_NonTypeTemplateParameter:
2743 return createCXString("NonTypeTemplateParameter");
2744 case CXCursor_TemplateTemplateParameter:
2745 return createCXString("TemplateTemplateParameter");
2746 case CXCursor_FunctionTemplate:
2747 return createCXString("FunctionTemplate");
Douglas Gregor39d6f072010-08-31 19:02:00 +00002748 case CXCursor_ClassTemplate:
2749 return createCXString("ClassTemplate");
Douglas Gregor74dbe642010-08-31 19:31:58 +00002750 case CXCursor_ClassTemplatePartialSpecialization:
2751 return createCXString("ClassTemplatePartialSpecialization");
Douglas Gregor69319002010-08-31 23:48:11 +00002752 case CXCursor_NamespaceAlias:
2753 return createCXString("NamespaceAlias");
Douglas Gregor0a35bce2010-09-01 03:07:18 +00002754 case CXCursor_UsingDirective:
2755 return createCXString("UsingDirective");
Douglas Gregor7e242562010-09-01 19:52:22 +00002756 case CXCursor_UsingDeclaration:
2757 return createCXString("UsingDeclaration");
Steve Naroff89922f82009-08-31 00:59:03 +00002758 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00002759
Ted Kremenekdeb06bd2010-01-16 02:02:09 +00002760 llvm_unreachable("Unhandled CXCursorKind");
Ted Kremeneke68fff62010-02-17 00:41:32 +00002761 return createCXString(NULL);
Steve Naroff600866c2009-08-27 19:51:58 +00002762}
Steve Naroff89922f82009-08-31 00:59:03 +00002763
Ted Kremeneke68fff62010-02-17 00:41:32 +00002764enum CXChildVisitResult GetCursorVisitor(CXCursor cursor,
2765 CXCursor parent,
Douglas Gregor33e9abd2010-01-22 19:49:59 +00002766 CXClientData client_data) {
2767 CXCursor *BestCursor = static_cast<CXCursor *>(client_data);
2768 *BestCursor = cursor;
2769 return CXChildVisit_Recurse;
2770}
Ted Kremeneke68fff62010-02-17 00:41:32 +00002771
Douglas Gregorb9790342010-01-22 21:44:22 +00002772CXCursor clang_getCursor(CXTranslationUnit TU, CXSourceLocation Loc) {
2773 if (!TU)
Ted Kremenekf4629892010-01-14 01:51:23 +00002774 return clang_getNullCursor();
Ted Kremeneke68fff62010-02-17 00:41:32 +00002775
Douglas Gregorb9790342010-01-22 21:44:22 +00002776 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Douglas Gregorbdf60622010-03-05 21:16:25 +00002777 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
2778
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002779 // Translate the given source location to make it point at the beginning of
2780 // the token under the cursor.
Ted Kremeneka297de22010-01-25 22:34:44 +00002781 SourceLocation SLoc = cxloc::translateSourceLocation(Loc);
Ted Kremeneka629ea42010-07-29 00:52:07 +00002782
2783 // Guard against an invalid SourceLocation, or we may assert in one
2784 // of the following calls.
2785 if (SLoc.isInvalid())
2786 return clang_getNullCursor();
2787
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002788 SLoc = Lexer::GetBeginningOfToken(SLoc, CXXUnit->getSourceManager(),
2789 CXXUnit->getASTContext().getLangOptions());
2790
Douglas Gregor33e9abd2010-01-22 19:49:59 +00002791 CXCursor Result = MakeCXCursorInvalid(CXCursor_NoDeclFound);
2792 if (SLoc.isValid()) {
Douglas Gregor33e9abd2010-01-22 19:49:59 +00002793 // FIXME: Would be great to have a "hint" cursor, then walk from that
2794 // hint cursor upward until we find a cursor whose source range encloses
2795 // the region of interest, rather than starting from the translation unit.
2796 CXCursor Parent = clang_getTranslationUnitCursor(CXXUnit);
Ted Kremeneke68fff62010-02-17 00:41:32 +00002797 CursorVisitor CursorVis(CXXUnit, GetCursorVisitor, &Result,
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002798 Decl::MaxPCHLevel, SourceLocation(SLoc));
Douglas Gregor33e9abd2010-01-22 19:49:59 +00002799 CursorVis.VisitChildren(Parent);
Steve Naroff77128dd2009-09-15 20:25:34 +00002800 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00002801 return Result;
Steve Naroff600866c2009-08-27 19:51:58 +00002802}
2803
Ted Kremenek73885552009-11-17 19:28:59 +00002804CXCursor clang_getNullCursor(void) {
Douglas Gregor5bfb8c12010-01-20 23:34:41 +00002805 return MakeCXCursorInvalid(CXCursor_InvalidFile);
Ted Kremenek73885552009-11-17 19:28:59 +00002806}
2807
2808unsigned clang_equalCursors(CXCursor X, CXCursor Y) {
Douglas Gregor283cae32010-01-15 21:56:13 +00002809 return X == Y;
Ted Kremenek73885552009-11-17 19:28:59 +00002810}
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00002811
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002812unsigned clang_isInvalid(enum CXCursorKind K) {
Steve Naroff77128dd2009-09-15 20:25:34 +00002813 return K >= CXCursor_FirstInvalid && K <= CXCursor_LastInvalid;
2814}
2815
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002816unsigned clang_isDeclaration(enum CXCursorKind K) {
Steve Naroff89922f82009-08-31 00:59:03 +00002817 return K >= CXCursor_FirstDecl && K <= CXCursor_LastDecl;
2818}
Steve Naroff2d4d6292009-08-31 14:26:51 +00002819
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002820unsigned clang_isReference(enum CXCursorKind K) {
Steve Narofff334b4e2009-09-02 18:26:48 +00002821 return K >= CXCursor_FirstRef && K <= CXCursor_LastRef;
2822}
2823
Douglas Gregor97b98722010-01-19 23:20:36 +00002824unsigned clang_isExpression(enum CXCursorKind K) {
2825 return K >= CXCursor_FirstExpr && K <= CXCursor_LastExpr;
2826}
2827
2828unsigned clang_isStatement(enum CXCursorKind K) {
2829 return K >= CXCursor_FirstStmt && K <= CXCursor_LastStmt;
2830}
2831
Douglas Gregor7eaa8ae2010-01-20 00:23:15 +00002832unsigned clang_isTranslationUnit(enum CXCursorKind K) {
2833 return K == CXCursor_TranslationUnit;
2834}
2835
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002836unsigned clang_isPreprocessing(enum CXCursorKind K) {
2837 return K >= CXCursor_FirstPreprocessing && K <= CXCursor_LastPreprocessing;
2838}
2839
Ted Kremenekad6eff62010-03-08 21:17:29 +00002840unsigned clang_isUnexposed(enum CXCursorKind K) {
2841 switch (K) {
2842 case CXCursor_UnexposedDecl:
2843 case CXCursor_UnexposedExpr:
2844 case CXCursor_UnexposedStmt:
2845 case CXCursor_UnexposedAttr:
2846 return true;
2847 default:
2848 return false;
2849 }
2850}
2851
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00002852CXCursorKind clang_getCursorKind(CXCursor C) {
Steve Naroff9efa7672009-09-04 15:44:05 +00002853 return C.kind;
2854}
2855
Douglas Gregor98258af2010-01-18 22:46:11 +00002856CXSourceLocation clang_getCursorLocation(CXCursor C) {
2857 if (clang_isReference(C.kind)) {
Douglas Gregorf46034a2010-01-18 23:41:10 +00002858 switch (C.kind) {
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002859 case CXCursor_ObjCSuperClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00002860 std::pair<ObjCInterfaceDecl *, SourceLocation> P
2861 = getCursorObjCSuperClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00002862 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00002863 }
2864
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002865 case CXCursor_ObjCProtocolRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00002866 std::pair<ObjCProtocolDecl *, SourceLocation> P
2867 = getCursorObjCProtocolRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00002868 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00002869 }
2870
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002871 case CXCursor_ObjCClassRef: {
Douglas Gregorf46034a2010-01-18 23:41:10 +00002872 std::pair<ObjCInterfaceDecl *, SourceLocation> P
2873 = getCursorObjCClassRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00002874 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregorf46034a2010-01-18 23:41:10 +00002875 }
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002876
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002877 case CXCursor_TypeRef: {
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002878 std::pair<TypeDecl *, SourceLocation> P = getCursorTypeRef(C);
Ted Kremeneka297de22010-01-25 22:34:44 +00002879 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002880 }
Douglas Gregor0b36e612010-08-31 20:37:03 +00002881
2882 case CXCursor_TemplateRef: {
2883 std::pair<TemplateDecl *, SourceLocation> P = getCursorTemplateRef(C);
2884 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2885 }
2886
Douglas Gregor69319002010-08-31 23:48:11 +00002887 case CXCursor_NamespaceRef: {
2888 std::pair<NamedDecl *, SourceLocation> P = getCursorNamespaceRef(C);
2889 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2890 }
2891
Douglas Gregora67e03f2010-09-09 21:42:20 +00002892 case CXCursor_MemberRef: {
2893 std::pair<FieldDecl *, SourceLocation> P = getCursorMemberRef(C);
2894 return cxloc::translateSourceLocation(P.first->getASTContext(), P.second);
2895 }
2896
Ted Kremenek3064ef92010-08-27 21:34:58 +00002897 case CXCursor_CXXBaseSpecifier: {
2898 // FIXME: Figure out what location to return for a CXXBaseSpecifier.
2899 return clang_getNullLocation();
2900 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002901
Douglas Gregorf46034a2010-01-18 23:41:10 +00002902 default:
2903 // FIXME: Need a way to enumerate all non-reference cases.
2904 llvm_unreachable("Missed a reference kind");
2905 }
Douglas Gregor98258af2010-01-18 22:46:11 +00002906 }
Douglas Gregor97b98722010-01-19 23:20:36 +00002907
2908 if (clang_isExpression(C.kind))
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002909 return cxloc::translateSourceLocation(getCursorContext(C),
Douglas Gregor97b98722010-01-19 23:20:36 +00002910 getLocationFromExpr(getCursorExpr(C)));
2911
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002912 if (C.kind == CXCursor_PreprocessingDirective) {
2913 SourceLocation L = cxcursor::getCursorPreprocessingDirective(C).getBegin();
2914 return cxloc::translateSourceLocation(getCursorContext(C), L);
2915 }
Douglas Gregor48072312010-03-18 15:23:44 +00002916
2917 if (C.kind == CXCursor_MacroInstantiation) {
Douglas Gregor4ae8f292010-03-18 17:52:52 +00002918 SourceLocation L
2919 = cxcursor::getCursorMacroInstantiation(C)->getSourceRange().getBegin();
Douglas Gregor48072312010-03-18 15:23:44 +00002920 return cxloc::translateSourceLocation(getCursorContext(C), L);
2921 }
Douglas Gregor572feb22010-03-18 18:04:21 +00002922
2923 if (C.kind == CXCursor_MacroDefinition) {
2924 SourceLocation L = cxcursor::getCursorMacroDefinition(C)->getLocation();
2925 return cxloc::translateSourceLocation(getCursorContext(C), L);
2926 }
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002927
Ted Kremenek9a700d22010-05-12 06:16:13 +00002928 if (C.kind < CXCursor_FirstDecl || C.kind > CXCursor_LastDecl)
Douglas Gregor5352ac02010-01-28 00:27:43 +00002929 return clang_getNullLocation();
Douglas Gregor98258af2010-01-18 22:46:11 +00002930
Douglas Gregorf46034a2010-01-18 23:41:10 +00002931 Decl *D = getCursorDecl(C);
Douglas Gregorf46034a2010-01-18 23:41:10 +00002932 SourceLocation Loc = D->getLocation();
2933 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(D))
2934 Loc = Class->getClassLoc();
Douglas Gregor2ca54fe2010-03-22 15:53:50 +00002935 return cxloc::translateSourceLocation(getCursorContext(C), Loc);
Douglas Gregor98258af2010-01-18 22:46:11 +00002936}
Douglas Gregora7bde202010-01-19 00:34:46 +00002937
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002938} // end extern "C"
2939
2940static SourceRange getRawCursorExtent(CXCursor C) {
Douglas Gregora7bde202010-01-19 00:34:46 +00002941 if (clang_isReference(C.kind)) {
2942 switch (C.kind) {
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002943 case CXCursor_ObjCSuperClassRef:
2944 return getCursorObjCSuperClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002945
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002946 case CXCursor_ObjCProtocolRef:
2947 return getCursorObjCProtocolRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002948
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002949 case CXCursor_ObjCClassRef:
2950 return getCursorObjCClassRef(C).second;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002951
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002952 case CXCursor_TypeRef:
2953 return getCursorTypeRef(C).second;
Douglas Gregor0b36e612010-08-31 20:37:03 +00002954
2955 case CXCursor_TemplateRef:
2956 return getCursorTemplateRef(C).second;
2957
Douglas Gregor69319002010-08-31 23:48:11 +00002958 case CXCursor_NamespaceRef:
2959 return getCursorNamespaceRef(C).second;
Douglas Gregora67e03f2010-09-09 21:42:20 +00002960
2961 case CXCursor_MemberRef:
2962 return getCursorMemberRef(C).second;
2963
Ted Kremenek3064ef92010-08-27 21:34:58 +00002964 case CXCursor_CXXBaseSpecifier:
2965 // FIXME: Figure out what source range to use for a CXBaseSpecifier.
2966 return SourceRange();
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00002967
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002968 default:
2969 // FIXME: Need a way to enumerate all non-reference cases.
2970 llvm_unreachable("Missed a reference kind");
Douglas Gregora7bde202010-01-19 00:34:46 +00002971 }
2972 }
Douglas Gregor97b98722010-01-19 23:20:36 +00002973
2974 if (clang_isExpression(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002975 return getCursorExpr(C)->getSourceRange();
Douglas Gregor33e9abd2010-01-22 19:49:59 +00002976
2977 if (clang_isStatement(C.kind))
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002978 return getCursorStmt(C)->getSourceRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00002979
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002980 if (C.kind == CXCursor_PreprocessingDirective)
2981 return cxcursor::getCursorPreprocessingDirective(C);
Douglas Gregor48072312010-03-18 15:23:44 +00002982
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002983 if (C.kind == CXCursor_MacroInstantiation)
2984 return cxcursor::getCursorMacroInstantiation(C)->getSourceRange();
Douglas Gregor572feb22010-03-18 18:04:21 +00002985
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002986 if (C.kind == CXCursor_MacroDefinition)
2987 return cxcursor::getCursorMacroDefinition(C)->getSourceRange();
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00002988
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00002989 if (C.kind >= CXCursor_FirstDecl && C.kind <= CXCursor_LastDecl)
2990 return getCursorDecl(C)->getSourceRange();
2991
2992 return SourceRange();
2993}
2994
2995extern "C" {
2996
2997CXSourceRange clang_getCursorExtent(CXCursor C) {
2998 SourceRange R = getRawCursorExtent(C);
2999 if (R.isInvalid())
Douglas Gregor5352ac02010-01-28 00:27:43 +00003000 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003001
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003002 return cxloc::translateSourceRange(getCursorContext(C), R);
Douglas Gregora7bde202010-01-19 00:34:46 +00003003}
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003004
3005CXCursor clang_getCursorReferenced(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003006 if (clang_isInvalid(C.kind))
3007 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003008
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003009 ASTUnit *CXXUnit = getCursorASTUnit(C);
Douglas Gregorb6998662010-01-19 19:34:47 +00003010 if (clang_isDeclaration(C.kind))
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003011 return C;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003012
Douglas Gregor97b98722010-01-19 23:20:36 +00003013 if (clang_isExpression(C.kind)) {
3014 Decl *D = getDeclFromExpr(getCursorExpr(C));
3015 if (D)
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003016 return MakeCXCursor(D, CXXUnit);
Douglas Gregor97b98722010-01-19 23:20:36 +00003017 return clang_getNullCursor();
3018 }
3019
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003020 if (C.kind == CXCursor_MacroInstantiation) {
3021 if (MacroDefinition *Def = getCursorMacroInstantiation(C)->getDefinition())
3022 return MakeMacroDefinitionCursor(Def, CXXUnit);
3023 }
3024
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003025 if (!clang_isReference(C.kind))
3026 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003027
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003028 switch (C.kind) {
3029 case CXCursor_ObjCSuperClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003030 return MakeCXCursor(getCursorObjCSuperClassRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003031
3032 case CXCursor_ObjCProtocolRef: {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003033 return MakeCXCursor(getCursorObjCProtocolRef(C).first, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003034
3035 case CXCursor_ObjCClassRef:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003036 return MakeCXCursor(getCursorObjCClassRef(C).first, CXXUnit);
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003037
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003038 case CXCursor_TypeRef:
Douglas Gregor7d0d40e2010-01-21 16:28:34 +00003039 return MakeCXCursor(getCursorTypeRef(C).first, CXXUnit);
Douglas Gregor0b36e612010-08-31 20:37:03 +00003040
3041 case CXCursor_TemplateRef:
3042 return MakeCXCursor(getCursorTemplateRef(C).first, CXXUnit);
3043
Douglas Gregor69319002010-08-31 23:48:11 +00003044 case CXCursor_NamespaceRef:
3045 return MakeCXCursor(getCursorNamespaceRef(C).first, CXXUnit);
3046
Douglas Gregora67e03f2010-09-09 21:42:20 +00003047 case CXCursor_MemberRef:
3048 return MakeCXCursor(getCursorMemberRef(C).first, CXXUnit);
3049
Ted Kremenek3064ef92010-08-27 21:34:58 +00003050 case CXCursor_CXXBaseSpecifier: {
3051 CXXBaseSpecifier *B = cxcursor::getCursorCXXBaseSpecifier(C);
3052 return clang_getTypeDeclaration(cxtype::MakeCXType(B->getType(),
3053 CXXUnit));
3054 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003055
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003056 default:
3057 // We would prefer to enumerate all non-reference cursor kinds here.
3058 llvm_unreachable("Unhandled reference cursor kind");
3059 break;
3060 }
3061 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003062
Douglas Gregorc5d1e932010-01-19 01:20:04 +00003063 return clang_getNullCursor();
3064}
3065
Douglas Gregorb6998662010-01-19 19:34:47 +00003066CXCursor clang_getCursorDefinition(CXCursor C) {
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003067 if (clang_isInvalid(C.kind))
3068 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003069
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003070 ASTUnit *CXXUnit = getCursorASTUnit(C);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003071
Douglas Gregorb6998662010-01-19 19:34:47 +00003072 bool WasReference = false;
Douglas Gregor97b98722010-01-19 23:20:36 +00003073 if (clang_isReference(C.kind) || clang_isExpression(C.kind)) {
Douglas Gregorb6998662010-01-19 19:34:47 +00003074 C = clang_getCursorReferenced(C);
3075 WasReference = true;
3076 }
3077
Douglas Gregorbf7efa22010-03-18 18:23:03 +00003078 if (C.kind == CXCursor_MacroInstantiation)
3079 return clang_getCursorReferenced(C);
3080
Douglas Gregorb6998662010-01-19 19:34:47 +00003081 if (!clang_isDeclaration(C.kind))
3082 return clang_getNullCursor();
3083
3084 Decl *D = getCursorDecl(C);
3085 if (!D)
3086 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003087
Douglas Gregorb6998662010-01-19 19:34:47 +00003088 switch (D->getKind()) {
3089 // Declaration kinds that don't really separate the notions of
3090 // declaration and definition.
3091 case Decl::Namespace:
3092 case Decl::Typedef:
3093 case Decl::TemplateTypeParm:
3094 case Decl::EnumConstant:
3095 case Decl::Field:
3096 case Decl::ObjCIvar:
3097 case Decl::ObjCAtDefsField:
3098 case Decl::ImplicitParam:
3099 case Decl::ParmVar:
3100 case Decl::NonTypeTemplateParm:
3101 case Decl::TemplateTemplateParm:
3102 case Decl::ObjCCategoryImpl:
3103 case Decl::ObjCImplementation:
Abramo Bagnara6206d532010-06-05 05:09:32 +00003104 case Decl::AccessSpec:
Douglas Gregorb6998662010-01-19 19:34:47 +00003105 case Decl::LinkageSpec:
3106 case Decl::ObjCPropertyImpl:
3107 case Decl::FileScopeAsm:
3108 case Decl::StaticAssert:
3109 case Decl::Block:
3110 return C;
3111
3112 // Declaration kinds that don't make any sense here, but are
3113 // nonetheless harmless.
3114 case Decl::TranslationUnit:
Douglas Gregorb6998662010-01-19 19:34:47 +00003115 break;
3116
3117 // Declaration kinds for which the definition is not resolvable.
3118 case Decl::UnresolvedUsingTypename:
3119 case Decl::UnresolvedUsingValue:
3120 break;
3121
3122 case Decl::UsingDirective:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003123 return MakeCXCursor(cast<UsingDirectiveDecl>(D)->getNominatedNamespace(),
3124 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003125
3126 case Decl::NamespaceAlias:
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003127 return MakeCXCursor(cast<NamespaceAliasDecl>(D)->getNamespace(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003128
3129 case Decl::Enum:
3130 case Decl::Record:
3131 case Decl::CXXRecord:
3132 case Decl::ClassTemplateSpecialization:
3133 case Decl::ClassTemplatePartialSpecialization:
Douglas Gregor952b0172010-02-11 01:04:33 +00003134 if (TagDecl *Def = cast<TagDecl>(D)->getDefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003135 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003136 return clang_getNullCursor();
3137
3138 case Decl::Function:
3139 case Decl::CXXMethod:
3140 case Decl::CXXConstructor:
3141 case Decl::CXXDestructor:
3142 case Decl::CXXConversion: {
3143 const FunctionDecl *Def = 0;
3144 if (cast<FunctionDecl>(D)->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003145 return MakeCXCursor(const_cast<FunctionDecl *>(Def), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003146 return clang_getNullCursor();
3147 }
3148
3149 case Decl::Var: {
Sebastian Redl31310a22010-02-01 20:16:42 +00003150 // Ask the variable if it has a definition.
3151 if (VarDecl *Def = cast<VarDecl>(D)->getDefinition())
3152 return MakeCXCursor(Def, CXXUnit);
3153 return clang_getNullCursor();
Douglas Gregorb6998662010-01-19 19:34:47 +00003154 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003155
Douglas Gregorb6998662010-01-19 19:34:47 +00003156 case Decl::FunctionTemplate: {
3157 const FunctionDecl *Def = 0;
3158 if (cast<FunctionTemplateDecl>(D)->getTemplatedDecl()->getBody(Def))
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003159 return MakeCXCursor(Def->getDescribedFunctionTemplate(), CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003160 return clang_getNullCursor();
3161 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003162
Douglas Gregorb6998662010-01-19 19:34:47 +00003163 case Decl::ClassTemplate: {
3164 if (RecordDecl *Def = cast<ClassTemplateDecl>(D)->getTemplatedDecl()
Douglas Gregor952b0172010-02-11 01:04:33 +00003165 ->getDefinition())
Douglas Gregor0b36e612010-08-31 20:37:03 +00003166 return MakeCXCursor(cast<CXXRecordDecl>(Def)->getDescribedClassTemplate(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003167 CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003168 return clang_getNullCursor();
3169 }
3170
3171 case Decl::Using: {
3172 UsingDecl *Using = cast<UsingDecl>(D);
3173 CXCursor Def = clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003174 for (UsingDecl::shadow_iterator S = Using->shadow_begin(),
3175 SEnd = Using->shadow_end();
Douglas Gregorb6998662010-01-19 19:34:47 +00003176 S != SEnd; ++S) {
3177 if (Def != clang_getNullCursor()) {
3178 // FIXME: We have no way to return multiple results.
3179 return clang_getNullCursor();
3180 }
3181
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003182 Def = clang_getCursorDefinition(MakeCXCursor((*S)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003183 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00003184 }
3185
3186 return Def;
3187 }
3188
3189 case Decl::UsingShadow:
3190 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003191 MakeCXCursor(cast<UsingShadowDecl>(D)->getTargetDecl(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003192 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00003193
3194 case Decl::ObjCMethod: {
3195 ObjCMethodDecl *Method = cast<ObjCMethodDecl>(D);
3196 if (Method->isThisDeclarationADefinition())
3197 return C;
3198
3199 // Dig out the method definition in the associated
3200 // @implementation, if we have it.
3201 // FIXME: The ASTs should make finding the definition easier.
3202 if (ObjCInterfaceDecl *Class
3203 = dyn_cast<ObjCInterfaceDecl>(Method->getDeclContext()))
3204 if (ObjCImplementationDecl *ClassImpl = Class->getImplementation())
3205 if (ObjCMethodDecl *Def = ClassImpl->getMethod(Method->getSelector(),
3206 Method->isInstanceMethod()))
3207 if (Def->isThisDeclarationADefinition())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003208 return MakeCXCursor(Def, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003209
3210 return clang_getNullCursor();
3211 }
3212
3213 case Decl::ObjCCategory:
3214 if (ObjCCategoryImplDecl *Impl
3215 = cast<ObjCCategoryDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003216 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003217 return clang_getNullCursor();
3218
3219 case Decl::ObjCProtocol:
3220 if (!cast<ObjCProtocolDecl>(D)->isForwardDecl())
3221 return C;
3222 return clang_getNullCursor();
3223
3224 case Decl::ObjCInterface:
3225 // There are two notions of a "definition" for an Objective-C
3226 // class: the interface and its implementation. When we resolved a
3227 // reference to an Objective-C class, produce the @interface as
3228 // the definition; when we were provided with the interface,
3229 // produce the @implementation as the definition.
3230 if (WasReference) {
3231 if (!cast<ObjCInterfaceDecl>(D)->isForwardDecl())
3232 return C;
3233 } else if (ObjCImplementationDecl *Impl
3234 = cast<ObjCInterfaceDecl>(D)->getImplementation())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003235 return MakeCXCursor(Impl, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003236 return clang_getNullCursor();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003237
Douglas Gregorb6998662010-01-19 19:34:47 +00003238 case Decl::ObjCProperty:
3239 // FIXME: We don't really know where to find the
3240 // ObjCPropertyImplDecls that implement this property.
3241 return clang_getNullCursor();
3242
3243 case Decl::ObjCCompatibleAlias:
3244 if (ObjCInterfaceDecl *Class
3245 = cast<ObjCCompatibleAliasDecl>(D)->getClassInterface())
3246 if (!Class->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003247 return MakeCXCursor(Class, CXXUnit);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003248
Douglas Gregorb6998662010-01-19 19:34:47 +00003249 return clang_getNullCursor();
3250
3251 case Decl::ObjCForwardProtocol: {
3252 ObjCForwardProtocolDecl *Forward = cast<ObjCForwardProtocolDecl>(D);
3253 if (Forward->protocol_size() == 1)
3254 return clang_getCursorDefinition(
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003255 MakeCXCursor(*Forward->protocol_begin(),
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003256 CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00003257
3258 // FIXME: Cannot return multiple definitions.
3259 return clang_getNullCursor();
3260 }
3261
3262 case Decl::ObjCClass: {
3263 ObjCClassDecl *Class = cast<ObjCClassDecl>(D);
3264 if (Class->size() == 1) {
3265 ObjCInterfaceDecl *IFace = Class->begin()->getInterface();
3266 if (!IFace->isForwardDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003267 return MakeCXCursor(IFace, CXXUnit);
Douglas Gregorb6998662010-01-19 19:34:47 +00003268 return clang_getNullCursor();
3269 }
3270
3271 // FIXME: Cannot return multiple definitions.
3272 return clang_getNullCursor();
3273 }
3274
3275 case Decl::Friend:
3276 if (NamedDecl *Friend = cast<FriendDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003277 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00003278 return clang_getNullCursor();
3279
3280 case Decl::FriendTemplate:
3281 if (NamedDecl *Friend = cast<FriendTemplateDecl>(D)->getFriendDecl())
Douglas Gregorb2cd4872010-01-20 23:57:43 +00003282 return clang_getCursorDefinition(MakeCXCursor(Friend, CXXUnit));
Douglas Gregorb6998662010-01-19 19:34:47 +00003283 return clang_getNullCursor();
3284 }
3285
3286 return clang_getNullCursor();
3287}
3288
3289unsigned clang_isCursorDefinition(CXCursor C) {
3290 if (!clang_isDeclaration(C.kind))
3291 return 0;
3292
3293 return clang_getCursorDefinition(C) == C;
3294}
3295
Daniel Dunbar0d7dd222009-11-30 20:42:43 +00003296void clang_getDefinitionSpellingAndExtent(CXCursor C,
Steve Naroff4ade6d62009-09-23 17:52:52 +00003297 const char **startBuf,
3298 const char **endBuf,
3299 unsigned *startLine,
3300 unsigned *startColumn,
3301 unsigned *endLine,
Daniel Dunbar9ebfa312009-12-01 03:14:51 +00003302 unsigned *endColumn) {
Douglas Gregor283cae32010-01-15 21:56:13 +00003303 assert(getCursorDecl(C) && "CXCursor has null decl");
3304 NamedDecl *ND = static_cast<NamedDecl *>(getCursorDecl(C));
Steve Naroff4ade6d62009-09-23 17:52:52 +00003305 FunctionDecl *FD = dyn_cast<FunctionDecl>(ND);
3306 CompoundStmt *Body = dyn_cast<CompoundStmt>(FD->getBody());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003307
Steve Naroff4ade6d62009-09-23 17:52:52 +00003308 SourceManager &SM = FD->getASTContext().getSourceManager();
3309 *startBuf = SM.getCharacterData(Body->getLBracLoc());
3310 *endBuf = SM.getCharacterData(Body->getRBracLoc());
3311 *startLine = SM.getSpellingLineNumber(Body->getLBracLoc());
3312 *startColumn = SM.getSpellingColumnNumber(Body->getLBracLoc());
3313 *endLine = SM.getSpellingLineNumber(Body->getRBracLoc());
3314 *endColumn = SM.getSpellingColumnNumber(Body->getRBracLoc());
3315}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003316
Douglas Gregor0a812cf2010-02-18 23:07:20 +00003317void clang_enableStackTraces(void) {
3318 llvm::sys::PrintStackTraceOnErrorSignal();
3319}
3320
Ted Kremenekfb480492010-01-13 21:46:36 +00003321} // end: extern "C"
Steve Naroff4ade6d62009-09-23 17:52:52 +00003322
Ted Kremenekfb480492010-01-13 21:46:36 +00003323//===----------------------------------------------------------------------===//
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003324// Token-based Operations.
3325//===----------------------------------------------------------------------===//
3326
3327/* CXToken layout:
3328 * int_data[0]: a CXTokenKind
3329 * int_data[1]: starting token location
3330 * int_data[2]: token length
3331 * int_data[3]: reserved
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003332 * ptr_data: for identifiers and keywords, an IdentifierInfo*.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003333 * otherwise unused.
3334 */
3335extern "C" {
3336
3337CXTokenKind clang_getTokenKind(CXToken CXTok) {
3338 return static_cast<CXTokenKind>(CXTok.int_data[0]);
3339}
3340
3341CXString clang_getTokenSpelling(CXTranslationUnit TU, CXToken CXTok) {
3342 switch (clang_getTokenKind(CXTok)) {
3343 case CXToken_Identifier:
3344 case CXToken_Keyword:
3345 // We know we have an IdentifierInfo*, so use that.
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003346 return createCXString(static_cast<IdentifierInfo *>(CXTok.ptr_data)
3347 ->getNameStart());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003348
3349 case CXToken_Literal: {
3350 // We have stashed the starting pointer in the ptr_data field. Use it.
3351 const char *Text = static_cast<const char *>(CXTok.ptr_data);
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003352 return createCXString(llvm::StringRef(Text, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003353 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003354
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003355 case CXToken_Punctuation:
3356 case CXToken_Comment:
3357 break;
3358 }
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003359
3360 // We have to find the starting buffer pointer the hard way, by
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003361 // deconstructing the source location.
3362 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3363 if (!CXXUnit)
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003364 return createCXString("");
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003365
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003366 SourceLocation Loc = SourceLocation::getFromRawEncoding(CXTok.int_data[1]);
3367 std::pair<FileID, unsigned> LocInfo
3368 = CXXUnit->getSourceManager().getDecomposedLoc(Loc);
Douglas Gregorf715ca12010-03-16 00:06:06 +00003369 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003370 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003371 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3372 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00003373 return createCXString("");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003374
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003375 return createCXString(Buffer.substr(LocInfo.second, CXTok.int_data[2]));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003376}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003377
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003378CXSourceLocation clang_getTokenLocation(CXTranslationUnit TU, CXToken CXTok) {
3379 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3380 if (!CXXUnit)
3381 return clang_getNullLocation();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003382
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003383 return cxloc::translateSourceLocation(CXXUnit->getASTContext(),
3384 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3385}
3386
3387CXSourceRange clang_getTokenExtent(CXTranslationUnit TU, CXToken CXTok) {
3388 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Douglas Gregor5352ac02010-01-28 00:27:43 +00003389 if (!CXXUnit)
3390 return clang_getNullRange();
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003391
3392 return cxloc::translateSourceRange(CXXUnit->getASTContext(),
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003393 SourceLocation::getFromRawEncoding(CXTok.int_data[1]));
3394}
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003395
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003396void clang_tokenize(CXTranslationUnit TU, CXSourceRange Range,
3397 CXToken **Tokens, unsigned *NumTokens) {
3398 if (Tokens)
3399 *Tokens = 0;
3400 if (NumTokens)
3401 *NumTokens = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003402
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003403 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
3404 if (!CXXUnit || !Tokens || !NumTokens)
3405 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003406
Douglas Gregorbdf60622010-03-05 21:16:25 +00003407 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
3408
Daniel Dunbar85b988f2010-02-14 08:31:57 +00003409 SourceRange R = cxloc::translateCXSourceRange(Range);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003410 if (R.isInvalid())
3411 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003412
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003413 SourceManager &SourceMgr = CXXUnit->getSourceManager();
3414 std::pair<FileID, unsigned> BeginLocInfo
3415 = SourceMgr.getDecomposedLoc(R.getBegin());
3416 std::pair<FileID, unsigned> EndLocInfo
3417 = SourceMgr.getDecomposedLoc(R.getEnd());
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003418
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003419 // Cannot tokenize across files.
3420 if (BeginLocInfo.first != EndLocInfo.first)
3421 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003422
3423 // Create a lexer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003424 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003425 llvm::StringRef Buffer
Douglas Gregorf715ca12010-03-16 00:06:06 +00003426 = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid);
Douglas Gregor47a3fcd2010-03-16 20:26:15 +00003427 if (Invalid)
3428 return;
Douglas Gregoraea67db2010-03-15 22:54:52 +00003429
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003430 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3431 CXXUnit->getASTContext().getLangOptions(),
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003432 Buffer.begin(), Buffer.data() + BeginLocInfo.second, Buffer.end());
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003433 Lex.SetCommentRetentionState(true);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003434
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003435 // Lex tokens until we hit the end of the range.
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003436 const char *EffectiveBufferEnd = Buffer.data() + EndLocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003437 llvm::SmallVector<CXToken, 32> CXTokens;
3438 Token Tok;
3439 do {
3440 // Lex the next token
3441 Lex.LexFromRawLexer(Tok);
3442 if (Tok.is(tok::eof))
3443 break;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003444
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003445 // Initialize the CXToken.
3446 CXToken CXTok;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003447
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003448 // - Common fields
3449 CXTok.int_data[1] = Tok.getLocation().getRawEncoding();
3450 CXTok.int_data[2] = Tok.getLength();
3451 CXTok.int_data[3] = 0;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003452
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003453 // - Kind-specific fields
3454 if (Tok.isLiteral()) {
3455 CXTok.int_data[0] = CXToken_Literal;
3456 CXTok.ptr_data = (void *)Tok.getLiteralData();
3457 } else if (Tok.is(tok::identifier)) {
Douglas Gregoraea67db2010-03-15 22:54:52 +00003458 // Lookup the identifier to determine whether we have a keyword.
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003459 std::pair<FileID, unsigned> LocInfo
3460 = SourceMgr.getDecomposedLoc(Tok.getLocation());
Douglas Gregorf715ca12010-03-16 00:06:06 +00003461 bool Invalid = false;
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003462 llvm::StringRef Buf
Douglas Gregorf715ca12010-03-16 00:06:06 +00003463 = CXXUnit->getSourceManager().getBufferData(LocInfo.first, &Invalid);
3464 if (Invalid)
Douglas Gregoraea67db2010-03-15 22:54:52 +00003465 return;
3466
Benjamin Kramerf6ac97b2010-03-16 14:14:31 +00003467 const char *StartPos = Buf.data() + LocInfo.second;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003468 IdentifierInfo *II
3469 = CXXUnit->getPreprocessor().LookUpIdentifierInfo(Tok, StartPos);
Ted Kremenekaa8a66d2010-05-05 00:55:20 +00003470
3471 if (II->getObjCKeywordID() != tok::objc_not_keyword) {
3472 CXTok.int_data[0] = CXToken_Keyword;
3473 }
3474 else {
3475 CXTok.int_data[0] = II->getTokenID() == tok::identifier?
3476 CXToken_Identifier
3477 : CXToken_Keyword;
3478 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003479 CXTok.ptr_data = II;
3480 } else if (Tok.is(tok::comment)) {
3481 CXTok.int_data[0] = CXToken_Comment;
3482 CXTok.ptr_data = 0;
3483 } else {
3484 CXTok.int_data[0] = CXToken_Punctuation;
3485 CXTok.ptr_data = 0;
3486 }
3487 CXTokens.push_back(CXTok);
3488 } while (Lex.getBufferLocation() <= EffectiveBufferEnd);
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003489
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003490 if (CXTokens.empty())
3491 return;
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003492
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003493 *Tokens = (CXToken *)malloc(sizeof(CXToken) * CXTokens.size());
3494 memmove(*Tokens, CXTokens.data(), sizeof(CXToken) * CXTokens.size());
3495 *NumTokens = CXTokens.size();
3496}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003497
Ted Kremenek6db61092010-05-05 00:55:15 +00003498void clang_disposeTokens(CXTranslationUnit TU,
3499 CXToken *Tokens, unsigned NumTokens) {
3500 free(Tokens);
3501}
3502
3503} // end: extern "C"
3504
3505//===----------------------------------------------------------------------===//
3506// Token annotation APIs.
3507//===----------------------------------------------------------------------===//
3508
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003509typedef llvm::DenseMap<unsigned, CXCursor> AnnotateTokensData;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003510static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3511 CXCursor parent,
3512 CXClientData client_data);
Ted Kremenek6db61092010-05-05 00:55:15 +00003513namespace {
3514class AnnotateTokensWorker {
3515 AnnotateTokensData &Annotated;
Ted Kremenek11949cb2010-05-05 00:55:17 +00003516 CXToken *Tokens;
3517 CXCursor *Cursors;
3518 unsigned NumTokens;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003519 unsigned TokIdx;
3520 CursorVisitor AnnotateVis;
3521 SourceManager &SrcMgr;
3522
3523 bool MoreTokens() const { return TokIdx < NumTokens; }
3524 unsigned NextToken() const { return TokIdx; }
3525 void AdvanceToken() { ++TokIdx; }
3526 SourceLocation GetTokenLoc(unsigned tokI) {
3527 return SourceLocation::getFromRawEncoding(Tokens[tokI].int_data[1]);
3528 }
3529
Ted Kremenek6db61092010-05-05 00:55:15 +00003530public:
Ted Kremenek11949cb2010-05-05 00:55:17 +00003531 AnnotateTokensWorker(AnnotateTokensData &annotated,
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003532 CXToken *tokens, CXCursor *cursors, unsigned numTokens,
3533 ASTUnit *CXXUnit, SourceRange RegionOfInterest)
Ted Kremenek11949cb2010-05-05 00:55:17 +00003534 : Annotated(annotated), Tokens(tokens), Cursors(cursors),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003535 NumTokens(numTokens), TokIdx(0),
3536 AnnotateVis(CXXUnit, AnnotateTokensVisitor, this,
3537 Decl::MaxPCHLevel, RegionOfInterest),
3538 SrcMgr(CXXUnit->getSourceManager()) {}
Ted Kremenek11949cb2010-05-05 00:55:17 +00003539
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003540 void VisitChildren(CXCursor C) { AnnotateVis.VisitChildren(C); }
Ted Kremenek6db61092010-05-05 00:55:15 +00003541 enum CXChildVisitResult Visit(CXCursor cursor, CXCursor parent);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003542 void AnnotateTokens(CXCursor parent);
Ted Kremenek6db61092010-05-05 00:55:15 +00003543};
3544}
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003545
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003546void AnnotateTokensWorker::AnnotateTokens(CXCursor parent) {
3547 // Walk the AST within the region of interest, annotating tokens
3548 // along the way.
3549 VisitChildren(parent);
Ted Kremenek11949cb2010-05-05 00:55:17 +00003550
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003551 for (unsigned I = 0 ; I < TokIdx ; ++I) {
3552 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3553 if (Pos != Annotated.end())
3554 Cursors[I] = Pos->second;
3555 }
3556
3557 // Finish up annotating any tokens left.
3558 if (!MoreTokens())
3559 return;
3560
3561 const CXCursor &C = clang_getNullCursor();
3562 for (unsigned I = TokIdx ; I < NumTokens ; ++I) {
3563 AnnotateTokensData::iterator Pos = Annotated.find(Tokens[I].int_data[1]);
3564 Cursors[I] = (Pos == Annotated.end()) ? C : Pos->second;
Ted Kremenek11949cb2010-05-05 00:55:17 +00003565 }
3566}
3567
Ted Kremenek6db61092010-05-05 00:55:15 +00003568enum CXChildVisitResult
3569AnnotateTokensWorker::Visit(CXCursor cursor, CXCursor parent) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003570 CXSourceLocation Loc = clang_getCursorLocation(cursor);
3571 // We can always annotate a preprocessing directive/macro instantiation.
3572 if (clang_isPreprocessing(cursor.kind)) {
3573 Annotated[Loc.int_data] = cursor;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003574 return CXChildVisit_Recurse;
3575 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003576
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003577 SourceRange cursorRange = getRawCursorExtent(cursor);
Ted Kremeneka333c662010-05-12 05:29:33 +00003578
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003579 if (cursorRange.isInvalid())
3580 return CXChildVisit_Continue;
Ted Kremeneka333c662010-05-12 05:29:33 +00003581
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003582 SourceLocation L = SourceLocation::getFromRawEncoding(Loc.int_data);
3583
Ted Kremeneka333c662010-05-12 05:29:33 +00003584 // Adjust the annotated range based specific declarations.
3585 const enum CXCursorKind cursorK = clang_getCursorKind(cursor);
3586 if (cursorK >= CXCursor_FirstDecl && cursorK <= CXCursor_LastDecl) {
Ted Kremenek23173d72010-05-18 21:09:07 +00003587 Decl *D = cxcursor::getCursorDecl(cursor);
3588 // Don't visit synthesized ObjC methods, since they have no syntatic
3589 // representation in the source.
3590 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
3591 if (MD->isSynthesized())
3592 return CXChildVisit_Continue;
3593 }
3594 if (const DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)) {
Ted Kremeneka333c662010-05-12 05:29:33 +00003595 if (TypeSourceInfo *TI = DD->getTypeSourceInfo()) {
3596 TypeLoc TL = TI->getTypeLoc();
Abramo Bagnarabd054db2010-05-20 10:00:11 +00003597 SourceLocation TLoc = TL.getSourceRange().getBegin();
Ted Kremenek6bfd5332010-05-13 15:38:38 +00003598 if (TLoc.isValid() &&
3599 SrcMgr.isBeforeInTranslationUnit(TLoc, L))
Ted Kremeneka333c662010-05-12 05:29:33 +00003600 cursorRange.setBegin(TLoc);
Ted Kremeneka333c662010-05-12 05:29:33 +00003601 }
3602 }
3603 }
3604
Ted Kremenek3f404602010-08-14 01:14:06 +00003605 // If the location of the cursor occurs within a macro instantiation, record
3606 // the spelling location of the cursor in our annotation map. We can then
3607 // paper over the token labelings during a post-processing step to try and
3608 // get cursor mappings for tokens that are the *arguments* of a macro
3609 // instantiation.
3610 if (L.isMacroID()) {
3611 unsigned rawEncoding = SrcMgr.getSpellingLoc(L).getRawEncoding();
3612 // Only invalidate the old annotation if it isn't part of a preprocessing
3613 // directive. Here we assume that the default construction of CXCursor
3614 // results in CXCursor.kind being an initialized value (i.e., 0). If
3615 // this isn't the case, we can fix by doing lookup + insertion.
3616
3617 CXCursor &oldC = Annotated[rawEncoding];
3618 if (!clang_isPreprocessing(oldC.kind))
3619 oldC = cursor;
3620 }
3621
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003622 const enum CXCursorKind K = clang_getCursorKind(parent);
3623 const CXCursor updateC =
Ted Kremenekd8b0a842010-08-25 22:16:02 +00003624 (clang_isInvalid(K) || K == CXCursor_TranslationUnit)
3625 ? clang_getNullCursor() : parent;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003626
3627 while (MoreTokens()) {
3628 const unsigned I = NextToken();
3629 SourceLocation TokLoc = GetTokenLoc(I);
3630 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3631 case RangeBefore:
3632 Cursors[I] = updateC;
3633 AdvanceToken();
3634 continue;
3635 case RangeAfter:
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003636 case RangeOverlap:
3637 break;
3638 }
3639 break;
3640 }
3641
3642 // Visit children to get their cursor information.
3643 const unsigned BeforeChildren = NextToken();
3644 VisitChildren(cursor);
3645 const unsigned AfterChildren = NextToken();
3646
3647 // Adjust 'Last' to the last token within the extent of the cursor.
3648 while (MoreTokens()) {
3649 const unsigned I = NextToken();
3650 SourceLocation TokLoc = GetTokenLoc(I);
3651 switch (LocationCompare(SrcMgr, TokLoc, cursorRange)) {
3652 case RangeBefore:
3653 assert(0 && "Infeasible");
3654 case RangeAfter:
3655 break;
3656 case RangeOverlap:
3657 Cursors[I] = updateC;
3658 AdvanceToken();
3659 continue;
3660 }
3661 break;
3662 }
3663 const unsigned Last = NextToken();
Ted Kremenek6db61092010-05-05 00:55:15 +00003664
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003665 // Scan the tokens that are at the beginning of the cursor, but are not
3666 // capture by the child cursors.
3667
3668 // For AST elements within macros, rely on a post-annotate pass to
3669 // to correctly annotate the tokens with cursors. Otherwise we can
3670 // get confusing results of having tokens that map to cursors that really
3671 // are expanded by an instantiation.
3672 if (L.isMacroID())
3673 cursor = clang_getNullCursor();
3674
3675 for (unsigned I = BeforeChildren; I != AfterChildren; ++I) {
3676 if (!clang_isInvalid(clang_getCursorKind(Cursors[I])))
3677 break;
3678 Cursors[I] = cursor;
3679 }
3680 // Scan the tokens that are at the end of the cursor, but are not captured
3681 // but the child cursors.
3682 for (unsigned I = AfterChildren; I != Last; ++I)
3683 Cursors[I] = cursor;
3684
3685 TokIdx = Last;
3686 return CXChildVisit_Continue;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003687}
3688
Ted Kremenek6db61092010-05-05 00:55:15 +00003689static enum CXChildVisitResult AnnotateTokensVisitor(CXCursor cursor,
3690 CXCursor parent,
3691 CXClientData client_data) {
3692 return static_cast<AnnotateTokensWorker*>(client_data)->Visit(cursor, parent);
3693}
3694
3695extern "C" {
3696
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003697void clang_annotateTokens(CXTranslationUnit TU,
3698 CXToken *Tokens, unsigned NumTokens,
3699 CXCursor *Cursors) {
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003700
3701 if (NumTokens == 0 || !Tokens || !Cursors)
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003702 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003703
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003704 ASTUnit *CXXUnit = static_cast<ASTUnit *>(TU);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003705 if (!CXXUnit) {
3706 // Any token we don't specifically annotate will have a NULL cursor.
3707 const CXCursor &C = clang_getNullCursor();
3708 for (unsigned I = 0; I != NumTokens; ++I)
3709 Cursors[I] = C;
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003710 return;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003711 }
3712
Douglas Gregorbdf60622010-03-05 21:16:25 +00003713 ASTUnit::ConcurrencyCheck Check(*CXXUnit);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003714
Douglas Gregor0396f462010-03-19 05:22:59 +00003715 // Determine the region of interest, which contains all of the tokens.
Douglas Gregor0045e9f2010-01-26 18:31:56 +00003716 SourceRange RegionOfInterest;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003717 RegionOfInterest.setBegin(cxloc::translateSourceLocation(
3718 clang_getTokenLocation(TU, Tokens[0])));
Douglas Gregora8e5c5b2010-07-22 20:22:31 +00003719 RegionOfInterest.setEnd(cxloc::translateSourceLocation(
3720 clang_getTokenLocation(TU,
3721 Tokens[NumTokens - 1])));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003722
Douglas Gregor0396f462010-03-19 05:22:59 +00003723 // A mapping from the source locations found when re-lexing or traversing the
3724 // region of interest to the corresponding cursors.
3725 AnnotateTokensData Annotated;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003726
3727 // Relex the tokens within the source range to look for preprocessing
Douglas Gregor0396f462010-03-19 05:22:59 +00003728 // directives.
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003729 SourceManager &SourceMgr = CXXUnit->getSourceManager();
3730 std::pair<FileID, unsigned> BeginLocInfo
3731 = SourceMgr.getDecomposedLoc(RegionOfInterest.getBegin());
3732 std::pair<FileID, unsigned> EndLocInfo
3733 = SourceMgr.getDecomposedLoc(RegionOfInterest.getEnd());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003734
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003735 llvm::StringRef Buffer;
Douglas Gregor0396f462010-03-19 05:22:59 +00003736 bool Invalid = false;
3737 if (BeginLocInfo.first == EndLocInfo.first &&
3738 ((Buffer = SourceMgr.getBufferData(BeginLocInfo.first, &Invalid)),true) &&
3739 !Invalid) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003740 Lexer Lex(SourceMgr.getLocForStartOfFile(BeginLocInfo.first),
3741 CXXUnit->getASTContext().getLangOptions(),
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003742 Buffer.begin(), Buffer.data() + BeginLocInfo.second,
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003743 Buffer.end());
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003744 Lex.SetCommentRetentionState(true);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003745
3746 // Lex tokens in raw mode until we hit the end of the range, to avoid
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003747 // entering #includes or expanding macros.
Douglas Gregor48072312010-03-18 15:23:44 +00003748 while (true) {
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003749 Token Tok;
3750 Lex.LexFromRawLexer(Tok);
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003751
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003752 reprocess:
3753 if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) {
3754 // We have found a preprocessing directive. Gobble it up so that we
3755 // don't see it while preprocessing these tokens later, but keep track of
3756 // all of the token locations inside this preprocessing directive so that
3757 // we can annotate them appropriately.
3758 //
3759 // FIXME: Some simple tests here could identify macro definitions and
3760 // #undefs, to provide specific cursor kinds for those.
3761 std::vector<SourceLocation> Locations;
3762 do {
3763 Locations.push_back(Tok.getLocation());
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003764 Lex.LexFromRawLexer(Tok);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003765 } while (!Tok.isAtStartOfLine() && !Tok.is(tok::eof));
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003766
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003767 using namespace cxcursor;
3768 CXCursor Cursor
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003769 = MakePreprocessingDirectiveCursor(SourceRange(Locations.front(),
3770 Locations.back()),
Ted Kremenek6db61092010-05-05 00:55:15 +00003771 CXXUnit);
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003772 for (unsigned I = 0, N = Locations.size(); I != N; ++I) {
3773 Annotated[Locations[I].getRawEncoding()] = Cursor;
3774 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003775
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003776 if (Tok.isAtStartOfLine())
3777 goto reprocess;
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003778
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003779 continue;
3780 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003781
Douglas Gregor48072312010-03-18 15:23:44 +00003782 if (Tok.is(tok::eof))
Douglas Gregor9f1e3ff2010-03-18 00:42:48 +00003783 break;
3784 }
Douglas Gregor4ae8f292010-03-18 17:52:52 +00003785 }
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003786
Douglas Gregor0396f462010-03-19 05:22:59 +00003787 // Annotate all of the source locations in the region of interest that map to
Ted Kremenekfbd84ca2010-05-05 00:55:23 +00003788 // a specific cursor.
3789 AnnotateTokensWorker W(Annotated, Tokens, Cursors, NumTokens,
3790 CXXUnit, RegionOfInterest);
3791 W.AnnotateTokens(clang_getTranslationUnitCursor(CXXUnit));
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003792}
Douglas Gregorfc8ea232010-01-26 17:06:03 +00003793} // end: extern "C"
3794
3795//===----------------------------------------------------------------------===//
Ted Kremenek16b42592010-03-03 06:36:57 +00003796// Operations for querying linkage of a cursor.
3797//===----------------------------------------------------------------------===//
3798
3799extern "C" {
3800CXLinkageKind clang_getCursorLinkage(CXCursor cursor) {
Douglas Gregor0396f462010-03-19 05:22:59 +00003801 if (!clang_isDeclaration(cursor.kind))
3802 return CXLinkage_Invalid;
3803
Ted Kremenek16b42592010-03-03 06:36:57 +00003804 Decl *D = cxcursor::getCursorDecl(cursor);
3805 if (NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D))
3806 switch (ND->getLinkage()) {
3807 case NoLinkage: return CXLinkage_NoLinkage;
3808 case InternalLinkage: return CXLinkage_Internal;
3809 case UniqueExternalLinkage: return CXLinkage_UniqueExternal;
3810 case ExternalLinkage: return CXLinkage_External;
3811 };
3812
3813 return CXLinkage_Invalid;
3814}
3815} // end: extern "C"
3816
3817//===----------------------------------------------------------------------===//
Ted Kremenek45e1dae2010-04-12 21:22:16 +00003818// Operations for querying language of a cursor.
3819//===----------------------------------------------------------------------===//
3820
3821static CXLanguageKind getDeclLanguage(const Decl *D) {
3822 switch (D->getKind()) {
3823 default:
3824 break;
3825 case Decl::ImplicitParam:
3826 case Decl::ObjCAtDefsField:
3827 case Decl::ObjCCategory:
3828 case Decl::ObjCCategoryImpl:
3829 case Decl::ObjCClass:
3830 case Decl::ObjCCompatibleAlias:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00003831 case Decl::ObjCForwardProtocol:
3832 case Decl::ObjCImplementation:
3833 case Decl::ObjCInterface:
3834 case Decl::ObjCIvar:
3835 case Decl::ObjCMethod:
3836 case Decl::ObjCProperty:
3837 case Decl::ObjCPropertyImpl:
3838 case Decl::ObjCProtocol:
3839 return CXLanguage_ObjC;
3840 case Decl::CXXConstructor:
3841 case Decl::CXXConversion:
3842 case Decl::CXXDestructor:
3843 case Decl::CXXMethod:
3844 case Decl::CXXRecord:
3845 case Decl::ClassTemplate:
3846 case Decl::ClassTemplatePartialSpecialization:
3847 case Decl::ClassTemplateSpecialization:
3848 case Decl::Friend:
3849 case Decl::FriendTemplate:
3850 case Decl::FunctionTemplate:
3851 case Decl::LinkageSpec:
3852 case Decl::Namespace:
3853 case Decl::NamespaceAlias:
3854 case Decl::NonTypeTemplateParm:
3855 case Decl::StaticAssert:
Ted Kremenek45e1dae2010-04-12 21:22:16 +00003856 case Decl::TemplateTemplateParm:
3857 case Decl::TemplateTypeParm:
3858 case Decl::UnresolvedUsingTypename:
3859 case Decl::UnresolvedUsingValue:
3860 case Decl::Using:
3861 case Decl::UsingDirective:
3862 case Decl::UsingShadow:
3863 return CXLanguage_CPlusPlus;
3864 }
3865
3866 return CXLanguage_C;
3867}
3868
3869extern "C" {
Douglas Gregor58ddb602010-08-23 23:00:57 +00003870
3871enum CXAvailabilityKind clang_getCursorAvailability(CXCursor cursor) {
3872 if (clang_isDeclaration(cursor.kind))
3873 if (Decl *D = cxcursor::getCursorDecl(cursor)) {
3874 if (D->hasAttr<UnavailableAttr>() ||
3875 (isa<FunctionDecl>(D) && cast<FunctionDecl>(D)->isDeleted()))
3876 return CXAvailability_Available;
3877
3878 if (D->hasAttr<DeprecatedAttr>())
3879 return CXAvailability_Deprecated;
3880 }
3881
3882 return CXAvailability_Available;
3883}
3884
Ted Kremenek45e1dae2010-04-12 21:22:16 +00003885CXLanguageKind clang_getCursorLanguage(CXCursor cursor) {
3886 if (clang_isDeclaration(cursor.kind))
3887 return getDeclLanguage(cxcursor::getCursorDecl(cursor));
3888
3889 return CXLanguage_Invalid;
3890}
3891} // end: extern "C"
3892
Ted Kremenek9ada39a2010-05-17 20:06:56 +00003893
3894//===----------------------------------------------------------------------===//
3895// C++ AST instrospection.
3896//===----------------------------------------------------------------------===//
3897
3898extern "C" {
3899unsigned clang_CXXMethod_isStatic(CXCursor C) {
3900 if (!clang_isDeclaration(C.kind))
3901 return 0;
Douglas Gregor49f6f542010-08-31 22:12:17 +00003902
3903 CXXMethodDecl *Method = 0;
3904 Decl *D = cxcursor::getCursorDecl(C);
3905 if (FunctionTemplateDecl *FunTmpl = dyn_cast_or_null<FunctionTemplateDecl>(D))
3906 Method = dyn_cast<CXXMethodDecl>(FunTmpl->getTemplatedDecl());
3907 else
3908 Method = dyn_cast_or_null<CXXMethodDecl>(D);
3909 return (Method && Method->isStatic()) ? 1 : 0;
Ted Kremenek40b492a2010-05-17 20:12:45 +00003910}
Ted Kremenekb12903e2010-05-18 22:32:15 +00003911
Ted Kremenek9ada39a2010-05-17 20:06:56 +00003912} // end: extern "C"
3913
Ted Kremenek45e1dae2010-04-12 21:22:16 +00003914//===----------------------------------------------------------------------===//
Ted Kremenek95f33552010-08-26 01:42:22 +00003915// Attribute introspection.
3916//===----------------------------------------------------------------------===//
3917
3918extern "C" {
3919CXType clang_getIBOutletCollectionType(CXCursor C) {
3920 if (C.kind != CXCursor_IBOutletCollectionAttr)
3921 return cxtype::MakeCXType(QualType(), cxcursor::getCursorASTUnit(C));
3922
3923 IBOutletCollectionAttr *A =
3924 cast<IBOutletCollectionAttr>(cxcursor::getCursorAttr(C));
3925
3926 return cxtype::MakeCXType(A->getInterface(), cxcursor::getCursorASTUnit(C));
3927}
3928} // end: extern "C"
3929
3930//===----------------------------------------------------------------------===//
Ted Kremenekfb480492010-01-13 21:46:36 +00003931// CXString Operations.
3932//===----------------------------------------------------------------------===//
3933
3934extern "C" {
3935const char *clang_getCString(CXString string) {
3936 return string.Spelling;
3937}
3938
3939void clang_disposeString(CXString string) {
3940 if (string.MustFreeString && string.Spelling)
3941 free((void*)string.Spelling);
3942}
Ted Kremenek04bb7162010-01-22 22:44:15 +00003943
Ted Kremenekfb480492010-01-13 21:46:36 +00003944} // end: extern "C"
Ted Kremenek04bb7162010-01-22 22:44:15 +00003945
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003946namespace clang { namespace cxstring {
3947CXString createCXString(const char *String, bool DupString){
3948 CXString Str;
3949 if (DupString) {
3950 Str.Spelling = strdup(String);
3951 Str.MustFreeString = 1;
3952 } else {
3953 Str.Spelling = String;
3954 Str.MustFreeString = 0;
3955 }
3956 return Str;
3957}
3958
3959CXString createCXString(llvm::StringRef String, bool DupString) {
3960 CXString Result;
3961 if (DupString || (!String.empty() && String.data()[String.size()] != 0)) {
3962 char *Spelling = (char *)malloc(String.size() + 1);
3963 memmove(Spelling, String.data(), String.size());
3964 Spelling[String.size()] = 0;
3965 Result.Spelling = Spelling;
3966 Result.MustFreeString = 1;
3967 } else {
3968 Result.Spelling = String.data();
3969 Result.MustFreeString = 0;
3970 }
3971 return Result;
3972}
3973}}
3974
Ted Kremenek04bb7162010-01-22 22:44:15 +00003975//===----------------------------------------------------------------------===//
3976// Misc. utility functions.
3977//===----------------------------------------------------------------------===//
Ted Kremenekf0e23e82010-02-17 00:41:40 +00003978
Ted Kremenek04bb7162010-01-22 22:44:15 +00003979extern "C" {
3980
Ted Kremeneka2a9d6e2010-02-12 22:54:40 +00003981CXString clang_getClangVersion() {
Ted Kremenekee4db4f2010-02-17 00:41:08 +00003982 return createCXString(getClangFullVersion());
Ted Kremenek04bb7162010-01-22 22:44:15 +00003983}
3984
3985} // end: extern "C"