blob: 3956cc23e350cccdf7d31fda392681a530a121bd [file] [log] [blame]
Argyrios Kyrtzidis4b562cf2009-06-20 08:27:14 +00001//===--- ASTUnit.cpp - ASTUnit utility ------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// ASTUnit Implementation.
11//
12//===----------------------------------------------------------------------===//
13
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000014#include "clang/Frontend/ASTUnit.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000015#include "clang/AST/ASTContext.h"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000016#include "clang/AST/ASTConsumer.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000017#include "clang/AST/DeclVisitor.h"
Douglas Gregorf5586f62010-08-16 18:08:11 +000018#include "clang/AST/TypeOrdering.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000019#include "clang/AST/StmtVisitor.h"
Daniel Dunbar7b556682009-12-02 03:23:45 +000020#include "clang/Driver/Compilation.h"
21#include "clang/Driver/Driver.h"
22#include "clang/Driver/Job.h"
23#include "clang/Driver/Tool.h"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000024#include "clang/Frontend/CompilerInstance.h"
25#include "clang/Frontend/FrontendActions.h"
Daniel Dunbar7b556682009-12-02 03:23:45 +000026#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000027#include "clang/Frontend/FrontendOptions.h"
Douglas Gregor32be4a52010-10-11 21:37:58 +000028#include "clang/Frontend/Utils.h"
Sebastian Redl6ab7cd82010-08-18 23:57:17 +000029#include "clang/Serialization/ASTReader.h"
Sebastian Redl7faa2ec2010-08-18 23:56:37 +000030#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000031#include "clang/Lex/HeaderSearch.h"
32#include "clang/Lex/Preprocessor.h"
Daniel Dunbard58c03f2009-11-15 06:48:46 +000033#include "clang/Basic/TargetOptions.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000034#include "clang/Basic/TargetInfo.h"
35#include "clang/Basic/Diagnostic.h"
Douglas Gregor349d38c2010-08-16 23:08:34 +000036#include "llvm/ADT/StringSet.h"
Douglas Gregor4db64a42010-01-23 00:14:00 +000037#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbar7b556682009-12-02 03:23:45 +000038#include "llvm/System/Host.h"
Benjamin Kramer4a630d32009-10-18 11:34:14 +000039#include "llvm/System/Path.h"
Douglas Gregordf95a132010-08-09 20:45:32 +000040#include "llvm/Support/raw_ostream.h"
Douglas Gregor385103b2010-07-30 20:58:08 +000041#include "llvm/Support/Timer.h"
Douglas Gregor44c181a2010-07-23 00:33:23 +000042#include <cstdlib>
Zhongxing Xuad23ebe2010-07-23 02:15:08 +000043#include <cstdio>
Douglas Gregorcc5888d2010-07-31 00:40:00 +000044#include <sys/stat.h>
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000045using namespace clang;
46
Douglas Gregor213f18b2010-10-28 15:44:59 +000047using llvm::TimeRecord;
48
49namespace {
50 class SimpleTimer {
51 bool WantTiming;
52 TimeRecord Start;
53 std::string Output;
54
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000055 public:
Douglas Gregor9dba61a2010-11-01 13:48:43 +000056 explicit SimpleTimer(bool WantTiming) : WantTiming(WantTiming) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000057 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000058 Start = TimeRecord::getCurrentTime();
Douglas Gregor213f18b2010-10-28 15:44:59 +000059 }
60
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000061 void setOutput(const llvm::Twine &Output) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000062 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000063 this->Output = Output.str();
Douglas Gregor213f18b2010-10-28 15:44:59 +000064 }
65
Douglas Gregor213f18b2010-10-28 15:44:59 +000066 ~SimpleTimer() {
67 if (WantTiming) {
68 TimeRecord Elapsed = TimeRecord::getCurrentTime();
69 Elapsed -= Start;
70 llvm::errs() << Output << ':';
71 Elapsed.print(Elapsed, llvm::errs());
72 llvm::errs() << '\n';
73 }
74 }
75 };
76}
77
Douglas Gregoreababfb2010-08-04 05:53:38 +000078/// \brief After failing to build a precompiled preamble (due to
79/// errors in the source that occurs in the preamble), the number of
80/// reparses during which we'll skip even trying to precompile the
81/// preamble.
82const unsigned DefaultPreambleRebuildInterval = 5;
83
Douglas Gregore3c60a72010-11-17 00:13:31 +000084/// \brief Tracks the number of ASTUnit objects that are currently active.
85///
86/// Used for debugging purposes only.
87static unsigned ActiveASTUnitObjects;
88
Douglas Gregor3687e9d2010-04-05 21:10:19 +000089ASTUnit::ASTUnit(bool _MainFileIsAST)
Douglas Gregorabc563f2010-07-19 21:46:24 +000090 : CaptureDiagnostics(false), MainFileIsAST(_MainFileIsAST),
Douglas Gregor213f18b2010-10-28 15:44:59 +000091 CompleteTranslationUnit(true), WantTiming(getenv("LIBCLANG_TIMING")),
92 NumStoredDiagnosticsFromDriver(0),
Douglas Gregor4cd912a2010-10-12 00:50:20 +000093 ConcurrencyCheckValue(CheckUnlocked),
Douglas Gregor671947b2010-08-19 01:33:06 +000094 PreambleRebuildCounter(0), SavedMainFileBuffer(0), PreambleBuffer(0),
Douglas Gregor727d93e2010-08-17 00:40:40 +000095 ShouldCacheCodeCompletionResults(false),
96 NumTopLevelDeclsAtLastCompletionCache(0),
Douglas Gregor8b1540c2010-08-19 00:45:44 +000097 CacheCodeCompletionCoolDown(0),
98 UnsafeToFree(false) {
Douglas Gregore3c60a72010-11-17 00:13:31 +000099 if (getenv("LIBCLANG_OBJTRACKING")) {
100 ++ActiveASTUnitObjects;
101 fprintf(stderr, "+++ %d translation units\n", ActiveASTUnitObjects);
102 }
Douglas Gregor385103b2010-07-30 20:58:08 +0000103}
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000104
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000105ASTUnit::~ASTUnit() {
Douglas Gregorbdf60622010-03-05 21:16:25 +0000106 ConcurrencyCheckValue = CheckLocked;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000107 CleanTemporaryFiles();
Douglas Gregor175c4a92010-07-23 23:58:40 +0000108 if (!PreambleFile.empty())
Douglas Gregor385103b2010-07-30 20:58:08 +0000109 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000110
111 // Free the buffers associated with remapped files. We are required to
112 // perform this operation here because we explicitly request that the
113 // compiler instance *not* free these buffers for each invocation of the
114 // parser.
115 if (Invocation.get()) {
116 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
117 for (PreprocessorOptions::remapped_file_buffer_iterator
118 FB = PPOpts.remapped_file_buffer_begin(),
119 FBEnd = PPOpts.remapped_file_buffer_end();
120 FB != FBEnd;
121 ++FB)
122 delete FB->second;
123 }
Douglas Gregor28233422010-07-27 14:52:07 +0000124
125 delete SavedMainFileBuffer;
Douglas Gregor671947b2010-08-19 01:33:06 +0000126 delete PreambleBuffer;
127
Douglas Gregor213f18b2010-10-28 15:44:59 +0000128 ClearCachedCompletionResults();
Douglas Gregore3c60a72010-11-17 00:13:31 +0000129
130 if (getenv("LIBCLANG_OBJTRACKING")) {
131 --ActiveASTUnitObjects;
132 fprintf(stderr, "--- %d translation units\n", ActiveASTUnitObjects);
133 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000134}
135
136void ASTUnit::CleanTemporaryFiles() {
Douglas Gregor313e26c2010-02-18 23:35:40 +0000137 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
138 TemporaryFiles[I].eraseFromDisk();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000139 TemporaryFiles.clear();
Steve Naroffe19944c2009-10-15 22:23:48 +0000140}
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000141
Douglas Gregor8071e422010-08-15 06:18:01 +0000142/// \brief Determine the set of code-completion contexts in which this
143/// declaration should be shown.
144static unsigned getDeclShowContexts(NamedDecl *ND,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000145 const LangOptions &LangOpts,
146 bool &IsNestedNameSpecifier) {
147 IsNestedNameSpecifier = false;
148
Douglas Gregor8071e422010-08-15 06:18:01 +0000149 if (isa<UsingShadowDecl>(ND))
150 ND = dyn_cast<NamedDecl>(ND->getUnderlyingDecl());
151 if (!ND)
152 return 0;
153
154 unsigned Contexts = 0;
155 if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
156 isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND)) {
157 // Types can appear in these contexts.
158 if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
159 Contexts |= (1 << (CodeCompletionContext::CCC_TopLevel - 1))
160 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
161 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
162 | (1 << (CodeCompletionContext::CCC_Statement - 1))
Douglas Gregor02688102010-09-14 23:59:36 +0000163 | (1 << (CodeCompletionContext::CCC_Type - 1))
164 | (1 << (CodeCompletionContext::CCC_ParenthesizedExpression - 1));
Douglas Gregor8071e422010-08-15 06:18:01 +0000165
166 // In C++, types can appear in expressions contexts (for functional casts).
167 if (LangOpts.CPlusPlus)
168 Contexts |= (1 << (CodeCompletionContext::CCC_Expression - 1));
169
170 // In Objective-C, message sends can send interfaces. In Objective-C++,
171 // all types are available due to functional casts.
172 if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
173 Contexts |= (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1));
174
175 // Deal with tag names.
176 if (isa<EnumDecl>(ND)) {
177 Contexts |= (1 << (CodeCompletionContext::CCC_EnumTag - 1));
178
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000179 // Part of the nested-name-specifier in C++0x.
Douglas Gregor8071e422010-08-15 06:18:01 +0000180 if (LangOpts.CPlusPlus0x)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000181 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000182 } else if (RecordDecl *Record = dyn_cast<RecordDecl>(ND)) {
183 if (Record->isUnion())
184 Contexts |= (1 << (CodeCompletionContext::CCC_UnionTag - 1));
185 else
186 Contexts |= (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1));
187
Douglas Gregor8071e422010-08-15 06:18:01 +0000188 if (LangOpts.CPlusPlus)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000189 IsNestedNameSpecifier = true;
Douglas Gregor52779fb2010-09-23 23:01:17 +0000190 } else if (isa<ClassTemplateDecl>(ND))
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000191 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000192 } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
193 // Values can appear in these contexts.
194 Contexts = (1 << (CodeCompletionContext::CCC_Statement - 1))
195 | (1 << (CodeCompletionContext::CCC_Expression - 1))
Douglas Gregor02688102010-09-14 23:59:36 +0000196 | (1 << (CodeCompletionContext::CCC_ParenthesizedExpression - 1))
Douglas Gregor8071e422010-08-15 06:18:01 +0000197 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1));
198 } else if (isa<ObjCProtocolDecl>(ND)) {
199 Contexts = (1 << (CodeCompletionContext::CCC_ObjCProtocolName - 1));
200 } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000201 Contexts = (1 << (CodeCompletionContext::CCC_Namespace - 1));
Douglas Gregor8071e422010-08-15 06:18:01 +0000202
203 // Part of the nested-name-specifier.
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000204 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000205 }
206
207 return Contexts;
208}
209
Douglas Gregor87c08a52010-08-13 22:48:40 +0000210void ASTUnit::CacheCodeCompletionResults() {
211 if (!TheSema)
212 return;
213
Douglas Gregor213f18b2010-10-28 15:44:59 +0000214 SimpleTimer Timer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +0000215 Timer.setOutput("Cache global code completions for " + getMainFileName());
Douglas Gregor87c08a52010-08-13 22:48:40 +0000216
217 // Clear out the previous results.
218 ClearCachedCompletionResults();
219
220 // Gather the set of global code completions.
John McCall0a2c5e22010-08-25 06:19:51 +0000221 typedef CodeCompletionResult Result;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000222 llvm::SmallVector<Result, 8> Results;
223 TheSema->GatherGlobalCodeCompletions(Results);
224
225 // Translate global code completions into cached completions.
Douglas Gregorf5586f62010-08-16 18:08:11 +0000226 llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
227
Douglas Gregor87c08a52010-08-13 22:48:40 +0000228 for (unsigned I = 0, N = Results.size(); I != N; ++I) {
229 switch (Results[I].Kind) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000230 case Result::RK_Declaration: {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000231 bool IsNestedNameSpecifier = false;
Douglas Gregor8071e422010-08-15 06:18:01 +0000232 CachedCodeCompletionResult CachedResult;
233 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
234 CachedResult.ShowInContexts = getDeclShowContexts(Results[I].Declaration,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000235 Ctx->getLangOptions(),
236 IsNestedNameSpecifier);
Douglas Gregor8071e422010-08-15 06:18:01 +0000237 CachedResult.Priority = Results[I].Priority;
238 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000239 CachedResult.Availability = Results[I].Availability;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000240
Douglas Gregorf5586f62010-08-16 18:08:11 +0000241 // Keep track of the type of this completion in an ASTContext-agnostic
242 // way.
Douglas Gregorc4421e92010-08-16 16:46:30 +0000243 QualType UsageType = getDeclUsageType(*Ctx, Results[I].Declaration);
Douglas Gregorf5586f62010-08-16 18:08:11 +0000244 if (UsageType.isNull()) {
Douglas Gregorc4421e92010-08-16 16:46:30 +0000245 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000246 CachedResult.Type = 0;
247 } else {
248 CanQualType CanUsageType
249 = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
250 CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
251
252 // Determine whether we have already seen this type. If so, we save
253 // ourselves the work of formatting the type string by using the
254 // temporary, CanQualType-based hash table to find the associated value.
255 unsigned &TypeValue = CompletionTypes[CanUsageType];
256 if (TypeValue == 0) {
257 TypeValue = CompletionTypes.size();
258 CachedCompletionTypes[QualType(CanUsageType).getAsString()]
259 = TypeValue;
260 }
261
262 CachedResult.Type = TypeValue;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000263 }
Douglas Gregorf5586f62010-08-16 18:08:11 +0000264
Douglas Gregor8071e422010-08-15 06:18:01 +0000265 CachedCompletionResults.push_back(CachedResult);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000266
267 /// Handle nested-name-specifiers in C++.
268 if (TheSema->Context.getLangOptions().CPlusPlus &&
269 IsNestedNameSpecifier && !Results[I].StartsNestedNameSpecifier) {
270 // The contexts in which a nested-name-specifier can appear in C++.
271 unsigned NNSContexts
272 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
273 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
274 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
275 | (1 << (CodeCompletionContext::CCC_Statement - 1))
276 | (1 << (CodeCompletionContext::CCC_Expression - 1))
277 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1))
278 | (1 << (CodeCompletionContext::CCC_EnumTag - 1))
279 | (1 << (CodeCompletionContext::CCC_UnionTag - 1))
280 | (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1))
Douglas Gregor2ccccb32010-08-23 18:23:48 +0000281 | (1 << (CodeCompletionContext::CCC_Type - 1))
Douglas Gregor02688102010-09-14 23:59:36 +0000282 | (1 << (CodeCompletionContext::CCC_PotentiallyQualifiedName - 1))
283 | (1 << (CodeCompletionContext::CCC_ParenthesizedExpression - 1));
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000284
285 if (isa<NamespaceDecl>(Results[I].Declaration) ||
286 isa<NamespaceAliasDecl>(Results[I].Declaration))
287 NNSContexts |= (1 << (CodeCompletionContext::CCC_Namespace - 1));
288
289 if (unsigned RemainingContexts
290 = NNSContexts & ~CachedResult.ShowInContexts) {
291 // If there any contexts where this completion can be a
292 // nested-name-specifier but isn't already an option, create a
293 // nested-name-specifier completion.
294 Results[I].StartsNestedNameSpecifier = true;
295 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
296 CachedResult.ShowInContexts = RemainingContexts;
297 CachedResult.Priority = CCP_NestedNameSpecifier;
298 CachedResult.TypeClass = STC_Void;
299 CachedResult.Type = 0;
300 CachedCompletionResults.push_back(CachedResult);
301 }
302 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000303 break;
Douglas Gregor8071e422010-08-15 06:18:01 +0000304 }
305
Douglas Gregor87c08a52010-08-13 22:48:40 +0000306 case Result::RK_Keyword:
307 case Result::RK_Pattern:
308 // Ignore keywords and patterns; we don't care, since they are so
309 // easily regenerated.
310 break;
311
312 case Result::RK_Macro: {
313 CachedCodeCompletionResult CachedResult;
314 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
315 CachedResult.ShowInContexts
316 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
317 | (1 << (CodeCompletionContext::CCC_ObjCInterface - 1))
318 | (1 << (CodeCompletionContext::CCC_ObjCImplementation - 1))
319 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
320 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
321 | (1 << (CodeCompletionContext::CCC_Statement - 1))
322 | (1 << (CodeCompletionContext::CCC_Expression - 1))
Douglas Gregor1fbb4472010-08-24 20:21:13 +0000323 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1))
Douglas Gregorf29c5232010-08-24 22:20:20 +0000324 | (1 << (CodeCompletionContext::CCC_MacroNameUse - 1))
Douglas Gregor02688102010-09-14 23:59:36 +0000325 | (1 << (CodeCompletionContext::CCC_PreprocessorExpression - 1))
326 | (1 << (CodeCompletionContext::CCC_ParenthesizedExpression - 1));
327
Douglas Gregor2ccccb32010-08-23 18:23:48 +0000328
Douglas Gregor87c08a52010-08-13 22:48:40 +0000329 CachedResult.Priority = Results[I].Priority;
330 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000331 CachedResult.Availability = Results[I].Availability;
Douglas Gregor1827e102010-08-16 16:18:59 +0000332 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000333 CachedResult.Type = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000334 CachedCompletionResults.push_back(CachedResult);
335 break;
336 }
337 }
338 Results[I].Destroy();
339 }
340
Douglas Gregor727d93e2010-08-17 00:40:40 +0000341 // Make a note of the state when we performed this caching.
342 NumTopLevelDeclsAtLastCompletionCache = top_level_size();
Douglas Gregor87c08a52010-08-13 22:48:40 +0000343}
344
345void ASTUnit::ClearCachedCompletionResults() {
346 for (unsigned I = 0, N = CachedCompletionResults.size(); I != N; ++I)
347 delete CachedCompletionResults[I].Completion;
348 CachedCompletionResults.clear();
Douglas Gregorf5586f62010-08-16 18:08:11 +0000349 CachedCompletionTypes.clear();
Douglas Gregor87c08a52010-08-13 22:48:40 +0000350}
351
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000352namespace {
353
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000354/// \brief Gathers information from ASTReader that will be used to initialize
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000355/// a Preprocessor.
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000356class ASTInfoCollector : public ASTReaderListener {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000357 LangOptions &LangOpt;
358 HeaderSearch &HSI;
359 std::string &TargetTriple;
360 std::string &Predefines;
361 unsigned &Counter;
Mike Stump1eb44332009-09-09 15:08:12 +0000362
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000363 unsigned NumHeaderInfos;
Mike Stump1eb44332009-09-09 15:08:12 +0000364
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000365public:
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000366 ASTInfoCollector(LangOptions &LangOpt, HeaderSearch &HSI,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000367 std::string &TargetTriple, std::string &Predefines,
368 unsigned &Counter)
369 : LangOpt(LangOpt), HSI(HSI), TargetTriple(TargetTriple),
370 Predefines(Predefines), Counter(Counter), NumHeaderInfos(0) {}
Mike Stump1eb44332009-09-09 15:08:12 +0000371
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000372 virtual bool ReadLanguageOptions(const LangOptions &LangOpts) {
373 LangOpt = LangOpts;
374 return false;
375 }
Mike Stump1eb44332009-09-09 15:08:12 +0000376
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000377 virtual bool ReadTargetTriple(llvm::StringRef Triple) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000378 TargetTriple = Triple;
379 return false;
380 }
Mike Stump1eb44332009-09-09 15:08:12 +0000381
Sebastian Redlcb481aa2010-07-14 23:29:55 +0000382 virtual bool ReadPredefinesBuffer(const PCHPredefinesBlocks &Buffers,
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000383 llvm::StringRef OriginalFileName,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000384 std::string &SuggestedPredefines) {
Sebastian Redlcb481aa2010-07-14 23:29:55 +0000385 Predefines = Buffers[0].Data;
386 for (unsigned I = 1, N = Buffers.size(); I != N; ++I) {
387 Predefines += Buffers[I].Data;
388 }
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000389 return false;
390 }
Mike Stump1eb44332009-09-09 15:08:12 +0000391
Douglas Gregorec1afbf2010-03-16 19:09:18 +0000392 virtual void ReadHeaderFileInfo(const HeaderFileInfo &HFI, unsigned ID) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000393 HSI.setHeaderFileInfoForUID(HFI, NumHeaderInfos++);
394 }
Mike Stump1eb44332009-09-09 15:08:12 +0000395
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000396 virtual void ReadCounter(unsigned Value) {
397 Counter = Value;
398 }
399};
400
Douglas Gregora88084b2010-02-18 18:08:43 +0000401class StoredDiagnosticClient : public DiagnosticClient {
402 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags;
403
404public:
405 explicit StoredDiagnosticClient(
406 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags)
407 : StoredDiags(StoredDiags) { }
408
409 virtual void HandleDiagnostic(Diagnostic::Level Level,
410 const DiagnosticInfo &Info);
411};
412
413/// \brief RAII object that optionally captures diagnostics, if
414/// there is no diagnostic client to capture them already.
415class CaptureDroppedDiagnostics {
416 Diagnostic &Diags;
417 StoredDiagnosticClient Client;
418 DiagnosticClient *PreviousClient;
419
420public:
421 CaptureDroppedDiagnostics(bool RequestCapture, Diagnostic &Diags,
Douglas Gregore47be3e2010-11-11 00:39:14 +0000422 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000423 : Diags(Diags), Client(StoredDiags), PreviousClient(0)
Douglas Gregora88084b2010-02-18 18:08:43 +0000424 {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000425 if (RequestCapture || Diags.getClient() == 0) {
426 PreviousClient = Diags.takeClient();
Douglas Gregora88084b2010-02-18 18:08:43 +0000427 Diags.setClient(&Client);
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000428 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000429 }
430
431 ~CaptureDroppedDiagnostics() {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000432 if (Diags.getClient() == &Client) {
433 Diags.takeClient();
434 Diags.setClient(PreviousClient);
435 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000436 }
437};
438
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000439} // anonymous namespace
440
Douglas Gregora88084b2010-02-18 18:08:43 +0000441void StoredDiagnosticClient::HandleDiagnostic(Diagnostic::Level Level,
442 const DiagnosticInfo &Info) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000443 // Default implementation (Warnings/errors count).
444 DiagnosticClient::HandleDiagnostic(Level, Info);
445
Douglas Gregora88084b2010-02-18 18:08:43 +0000446 StoredDiags.push_back(StoredDiagnostic(Level, Info));
447}
448
Steve Naroff77accc12009-09-03 18:19:54 +0000449const std::string &ASTUnit::getOriginalSourceFileName() {
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000450 return OriginalSourceFile;
Steve Naroff77accc12009-09-03 18:19:54 +0000451}
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000452
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000453const std::string &ASTUnit::getASTFileName() {
454 assert(isMainFileAST() && "Not an ASTUnit from an AST file!");
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000455 return static_cast<ASTReader *>(Ctx->getExternalSource())->getFileName();
Steve Naroffe19944c2009-10-15 22:23:48 +0000456}
457
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000458llvm::MemoryBuffer *ASTUnit::getBufferForFile(llvm::StringRef Filename,
459 std::string *ErrorStr,
460 int64_t FileSize,
461 struct stat *FileInfo) {
462 return FileMgr->getBufferForFile(Filename, FileSystemOpts,
463 ErrorStr, FileSize, FileInfo);
464}
465
Douglas Gregore47be3e2010-11-11 00:39:14 +0000466/// \brief Configure the diagnostics object for use with ASTUnit.
467void ASTUnit::ConfigureDiags(llvm::IntrusiveRefCntPtr<Diagnostic> &Diags,
468 ASTUnit &AST, bool CaptureDiagnostics) {
469 if (!Diags.getPtr()) {
470 // No diagnostics engine was provided, so create our own diagnostics object
471 // with the default options.
472 DiagnosticOptions DiagOpts;
473 DiagnosticClient *Client = 0;
474 if (CaptureDiagnostics)
475 Client = new StoredDiagnosticClient(AST.StoredDiagnostics);
476 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0, Client);
477 } else if (CaptureDiagnostics) {
478 Diags->setClient(new StoredDiagnosticClient(AST.StoredDiagnostics));
479 }
480}
481
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000482ASTUnit *ASTUnit::LoadFromASTFile(const std::string &Filename,
Douglas Gregor28019772010-04-05 23:52:57 +0000483 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000484 const FileSystemOptions &FileSystemOpts,
Ted Kremenek5cf48762009-10-17 00:34:24 +0000485 bool OnlyLocalDecls,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000486 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +0000487 unsigned NumRemappedFiles,
488 bool CaptureDiagnostics) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000489 llvm::OwningPtr<ASTUnit> AST(new ASTUnit(true));
Douglas Gregore47be3e2010-11-11 00:39:14 +0000490 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +0000491
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000492 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +0000493 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor28019772010-04-05 23:52:57 +0000494 AST->Diagnostics = Diags;
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000495 AST->FileSystemOpts = FileSystemOpts;
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000496 AST->FileMgr.reset(new FileManager);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000497 AST->SourceMgr.reset(new SourceManager(AST->getDiagnostics(),
498 AST->getFileManager(),
499 AST->getFileSystemOpts()));
500 AST->HeaderInfo.reset(new HeaderSearch(AST->getFileManager(),
501 AST->getFileSystemOpts()));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000502
Douglas Gregor4db64a42010-01-23 00:14:00 +0000503 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
504 // Create the file entry for the file that we're mapping from.
505 const FileEntry *FromFile
506 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
507 RemappedFiles[I].second->getBufferSize(),
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000508 0,
509 AST->getFileSystemOpts());
Douglas Gregor4db64a42010-01-23 00:14:00 +0000510 if (!FromFile) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000511 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
Douglas Gregor4db64a42010-01-23 00:14:00 +0000512 << RemappedFiles[I].first;
Douglas Gregorc8dfe5e2010-02-27 01:32:48 +0000513 delete RemappedFiles[I].second;
Douglas Gregor4db64a42010-01-23 00:14:00 +0000514 continue;
515 }
516
517 // Override the contents of the "from" file with the contents of
518 // the "to" file.
519 AST->getSourceManager().overrideFileContents(FromFile,
520 RemappedFiles[I].second);
521 }
522
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000523 // Gather Info for preprocessor construction later on.
Mike Stump1eb44332009-09-09 15:08:12 +0000524
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000525 LangOptions LangInfo;
526 HeaderSearch &HeaderInfo = *AST->HeaderInfo.get();
527 std::string TargetTriple;
528 std::string Predefines;
529 unsigned Counter;
530
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000531 llvm::OwningPtr<ASTReader> Reader;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000532
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000533 Reader.reset(new ASTReader(AST->getSourceManager(), AST->getFileManager(),
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000534 AST->getFileSystemOpts(), AST->getDiagnostics()));
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000535 Reader->setListener(new ASTInfoCollector(LangInfo, HeaderInfo, TargetTriple,
Daniel Dunbarcc318932009-09-03 05:59:35 +0000536 Predefines, Counter));
537
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +0000538 switch (Reader->ReadAST(Filename, ASTReader::MainFile)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000539 case ASTReader::Success:
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000540 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000541
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000542 case ASTReader::Failure:
543 case ASTReader::IgnorePCH:
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000544 AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000545 return NULL;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000546 }
Mike Stump1eb44332009-09-09 15:08:12 +0000547
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000548 AST->OriginalSourceFile = Reader->getOriginalSourceFile();
549
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000550 // AST file loaded successfully. Now create the preprocessor.
Mike Stump1eb44332009-09-09 15:08:12 +0000551
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000552 // Get information about the target being compiled for.
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000553 //
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000554 // FIXME: This is broken, we should store the TargetOptions in the AST file.
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000555 TargetOptions TargetOpts;
556 TargetOpts.ABI = "";
John McCall875ab102010-08-22 06:43:33 +0000557 TargetOpts.CXXABI = "";
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000558 TargetOpts.CPU = "";
559 TargetOpts.Features.clear();
560 TargetOpts.Triple = TargetTriple;
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000561 AST->Target.reset(TargetInfo::CreateTargetInfo(AST->getDiagnostics(),
562 TargetOpts));
563 AST->PP.reset(new Preprocessor(AST->getDiagnostics(), LangInfo,
564 *AST->Target.get(),
Daniel Dunbar31b87d82009-09-21 03:03:39 +0000565 AST->getSourceManager(), HeaderInfo));
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000566 Preprocessor &PP = *AST->PP.get();
567
Daniel Dunbard5b61262009-09-21 03:03:47 +0000568 PP.setPredefines(Reader->getSuggestedPredefines());
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000569 PP.setCounterValue(Counter);
Daniel Dunbarcc318932009-09-03 05:59:35 +0000570 Reader->setPreprocessor(PP);
Mike Stump1eb44332009-09-09 15:08:12 +0000571
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000572 // Create and initialize the ASTContext.
573
574 AST->Ctx.reset(new ASTContext(LangInfo,
Daniel Dunbar31b87d82009-09-21 03:03:39 +0000575 AST->getSourceManager(),
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000576 *AST->Target.get(),
577 PP.getIdentifierTable(),
578 PP.getSelectorTable(),
579 PP.getBuiltinInfo(),
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000580 /* size_reserve = */0));
581 ASTContext &Context = *AST->Ctx.get();
Mike Stump1eb44332009-09-09 15:08:12 +0000582
Daniel Dunbarcc318932009-09-03 05:59:35 +0000583 Reader->InitializeContext(Context);
Mike Stump1eb44332009-09-09 15:08:12 +0000584
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000585 // Attach the AST reader to the AST context as an external AST
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000586 // source, so that declarations will be deserialized from the
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000587 // AST file as needed.
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000588 ASTReader *ReaderPtr = Reader.get();
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000589 llvm::OwningPtr<ExternalASTSource> Source(Reader.take());
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000590 Context.setExternalSource(Source);
591
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000592 // Create an AST consumer, even though it isn't used.
593 AST->Consumer.reset(new ASTConsumer);
594
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000595 // Create a semantic analysis object and tell the AST reader about it.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000596 AST->TheSema.reset(new Sema(PP, Context, *AST->Consumer));
597 AST->TheSema->Initialize();
598 ReaderPtr->InitializeSema(*AST->TheSema);
599
Mike Stump1eb44332009-09-09 15:08:12 +0000600 return AST.take();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000601}
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000602
603namespace {
604
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000605class TopLevelDeclTrackerConsumer : public ASTConsumer {
606 ASTUnit &Unit;
607
608public:
609 TopLevelDeclTrackerConsumer(ASTUnit &_Unit) : Unit(_Unit) {}
610
611 void HandleTopLevelDecl(DeclGroupRef D) {
Ted Kremenekda5a4282010-05-03 20:16:35 +0000612 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
613 Decl *D = *it;
614 // FIXME: Currently ObjC method declarations are incorrectly being
615 // reported as top-level declarations, even though their DeclContext
616 // is the containing ObjC @interface/@implementation. This is a
617 // fundamental problem in the parser right now.
618 if (isa<ObjCMethodDecl>(D))
619 continue;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000620 Unit.addTopLevelDecl(D);
Ted Kremenekda5a4282010-05-03 20:16:35 +0000621 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000622 }
Sebastian Redl27372b42010-08-11 18:52:41 +0000623
624 // We're not interested in "interesting" decls.
625 void HandleInterestingDecl(DeclGroupRef) {}
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000626};
627
628class TopLevelDeclTrackerAction : public ASTFrontendAction {
629public:
630 ASTUnit &Unit;
631
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000632 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
633 llvm::StringRef InFile) {
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000634 return new TopLevelDeclTrackerConsumer(Unit);
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000635 }
636
637public:
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000638 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
639
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000640 virtual bool hasCodeCompletionSupport() const { return false; }
Douglas Gregordf95a132010-08-09 20:45:32 +0000641 virtual bool usesCompleteTranslationUnit() {
642 return Unit.isCompleteTranslationUnit();
643 }
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000644};
645
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000646class PrecompilePreambleConsumer : public PCHGenerator {
647 ASTUnit &Unit;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000648 std::vector<Decl *> TopLevelDecls;
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000649
650public:
651 PrecompilePreambleConsumer(ASTUnit &Unit,
652 const Preprocessor &PP, bool Chaining,
653 const char *isysroot, llvm::raw_ostream *Out)
654 : PCHGenerator(PP, Chaining, isysroot, Out), Unit(Unit) { }
655
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000656 virtual void HandleTopLevelDecl(DeclGroupRef D) {
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000657 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
658 Decl *D = *it;
659 // FIXME: Currently ObjC method declarations are incorrectly being
660 // reported as top-level declarations, even though their DeclContext
661 // is the containing ObjC @interface/@implementation. This is a
662 // fundamental problem in the parser right now.
663 if (isa<ObjCMethodDecl>(D))
664 continue;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000665 TopLevelDecls.push_back(D);
666 }
667 }
668
669 virtual void HandleTranslationUnit(ASTContext &Ctx) {
670 PCHGenerator::HandleTranslationUnit(Ctx);
671 if (!Unit.getDiagnostics().hasErrorOccurred()) {
672 // Translate the top-level declarations we captured during
673 // parsing into declaration IDs in the precompiled
674 // preamble. This will allow us to deserialize those top-level
675 // declarations when requested.
676 for (unsigned I = 0, N = TopLevelDecls.size(); I != N; ++I)
677 Unit.addTopLevelDeclFromPreamble(
678 getWriter().getDeclID(TopLevelDecls[I]));
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000679 }
680 }
681};
682
683class PrecompilePreambleAction : public ASTFrontendAction {
684 ASTUnit &Unit;
685
686public:
687 explicit PrecompilePreambleAction(ASTUnit &Unit) : Unit(Unit) {}
688
689 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
690 llvm::StringRef InFile) {
691 std::string Sysroot;
692 llvm::raw_ostream *OS = 0;
693 bool Chaining;
694 if (GeneratePCHAction::ComputeASTConsumerArguments(CI, InFile, Sysroot,
695 OS, Chaining))
696 return 0;
697
698 const char *isysroot = CI.getFrontendOpts().RelocatablePCH ?
699 Sysroot.c_str() : 0;
700 return new PrecompilePreambleConsumer(Unit, CI.getPreprocessor(), Chaining,
701 isysroot, OS);
702 }
703
704 virtual bool hasCodeCompletionSupport() const { return false; }
705 virtual bool hasASTFileSupport() const { return false; }
Douglas Gregordf95a132010-08-09 20:45:32 +0000706 virtual bool usesCompleteTranslationUnit() { return false; }
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000707};
708
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000709}
710
Douglas Gregorabc563f2010-07-19 21:46:24 +0000711/// Parse the source file into a translation unit using the given compiler
712/// invocation, replacing the current translation unit.
713///
714/// \returns True if a failure occurred that causes the ASTUnit not to
715/// contain any translation-unit information, false otherwise.
Douglas Gregor754f3492010-07-24 00:38:13 +0000716bool ASTUnit::Parse(llvm::MemoryBuffer *OverrideMainBuffer) {
Douglas Gregor28233422010-07-27 14:52:07 +0000717 delete SavedMainFileBuffer;
718 SavedMainFileBuffer = 0;
719
Douglas Gregor671947b2010-08-19 01:33:06 +0000720 if (!Invocation.get()) {
721 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000722 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +0000723 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000724
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000725 // Create the compiler instance to use for building the AST.
Daniel Dunbarcb6dda12009-12-02 08:43:56 +0000726 CompilerInstance Clang;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000727 Clang.setInvocation(Invocation.take());
728 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
729
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000730 // Set up diagnostics, capturing any diagnostics that would
731 // otherwise be dropped.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000732 Clang.setDiagnostics(&getDiagnostics());
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000733
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000734 // Create the target instance.
735 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
736 Clang.getTargetOpts()));
Douglas Gregor671947b2010-08-19 01:33:06 +0000737 if (!Clang.hasTarget()) {
738 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000739 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +0000740 }
741
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000742 // Inform the target of the language options.
743 //
744 // FIXME: We shouldn't need to do this, the target should be immutable once
745 // created. This complexity should be lifted elsewhere.
746 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000747
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000748 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
749 "Invocation must have exactly one source file!");
Daniel Dunbarc34ce3f2010-06-07 23:22:09 +0000750 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000751 "FIXME: AST inputs not yet supported here!");
Daniel Dunbarfaddc3e2010-06-07 23:26:47 +0000752 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
753 "IR inputs not support here!");
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000754
Douglas Gregorabc563f2010-07-19 21:46:24 +0000755 // Configure the various subsystems.
756 // FIXME: Should we retain the previous file manager?
757 FileMgr.reset(new FileManager);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000758 FileSystemOpts = Clang.getFileSystemOpts();
759 SourceMgr.reset(new SourceManager(getDiagnostics(), *FileMgr, FileSystemOpts));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000760 TheSema.reset();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000761 Ctx.reset();
762 PP.reset();
763
764 // Clear out old caches and data.
765 TopLevelDecls.clear();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000766 CleanTemporaryFiles();
767 PreprocessedEntitiesByFile.clear();
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000768
Douglas Gregorf128fed2010-08-20 00:02:33 +0000769 if (!OverrideMainBuffer) {
Douglas Gregor4cd912a2010-10-12 00:50:20 +0000770 StoredDiagnostics.erase(
771 StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver,
772 StoredDiagnostics.end());
Douglas Gregorf128fed2010-08-20 00:02:33 +0000773 TopLevelDeclsInPreamble.clear();
774 }
775
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000776 // Create a file manager object to provide access to and cache the filesystem.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000777 Clang.setFileManager(&getFileManager());
778
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000779 // Create the source manager.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000780 Clang.setSourceManager(&getSourceManager());
781
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000782 // If the main file has been overridden due to the use of a preamble,
783 // make that override happen and introduce the preamble.
784 PreprocessorOptions &PreprocessorOpts = Clang.getPreprocessorOpts();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000785 std::string PriorImplicitPCHInclude;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000786 if (OverrideMainBuffer) {
787 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
788 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
789 PreprocessorOpts.PrecompiledPreambleBytes.second
790 = PreambleEndsAtStartOfLine;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000791 PriorImplicitPCHInclude = PreprocessorOpts.ImplicitPCHInclude;
Douglas Gregor385103b2010-07-30 20:58:08 +0000792 PreprocessorOpts.ImplicitPCHInclude = PreambleFile;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000793 PreprocessorOpts.DisablePCHValidation = true;
Douglas Gregor28233422010-07-27 14:52:07 +0000794
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000795 // The stored diagnostic has the old source manager in it; update
796 // the locations to refer into the new source manager. Since we've
797 // been careful to make sure that the source manager's state
798 // before and after are identical, so that we can reuse the source
799 // location itself.
Douglas Gregor4cd912a2010-10-12 00:50:20 +0000800 for (unsigned I = NumStoredDiagnosticsFromDriver,
801 N = StoredDiagnostics.size();
802 I < N; ++I) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000803 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(),
804 getSourceManager());
805 StoredDiagnostics[I].setLocation(Loc);
806 }
Douglas Gregor4cd912a2010-10-12 00:50:20 +0000807
808 // Keep track of the override buffer;
809 SavedMainFileBuffer = OverrideMainBuffer;
Douglas Gregorf128fed2010-08-20 00:02:33 +0000810 } else {
811 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
812 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000813 }
814
Douglas Gregorabc563f2010-07-19 21:46:24 +0000815 llvm::OwningPtr<TopLevelDeclTrackerAction> Act;
816 Act.reset(new TopLevelDeclTrackerAction(*this));
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000817 if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
Daniel Dunbard3598a62010-06-07 23:23:06 +0000818 Clang.getFrontendOpts().Inputs[0].first))
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000819 goto error;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000820
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000821 Act->Execute();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000822
Daniel Dunbar64a32ba2009-12-01 21:57:33 +0000823 // Steal the created target, context, and preprocessor, and take back the
824 // source and file managers.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000825 TheSema.reset(Clang.takeSema());
826 Consumer.reset(Clang.takeASTConsumer());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000827 Ctx.reset(Clang.takeASTContext());
828 PP.reset(Clang.takePreprocessor());
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000829 Clang.takeSourceManager();
830 Clang.takeFileManager();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000831 Target.reset(Clang.takeTarget());
832
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000833 Act->EndSourceFile();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000834
835 // Remove the overridden buffer we used for the preamble.
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000836 if (OverrideMainBuffer) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000837 PreprocessorOpts.eraseRemappedFile(
838 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000839 PreprocessorOpts.ImplicitPCHInclude = PriorImplicitPCHInclude;
840 }
841
Douglas Gregorabc563f2010-07-19 21:46:24 +0000842 Invocation.reset(Clang.takeInvocation());
843 return false;
844
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000845error:
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000846 // Remove the overridden buffer we used for the preamble.
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000847 if (OverrideMainBuffer) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000848 PreprocessorOpts.eraseRemappedFile(
849 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000850 PreprocessorOpts.ImplicitPCHInclude = PriorImplicitPCHInclude;
Douglas Gregor671947b2010-08-19 01:33:06 +0000851 delete OverrideMainBuffer;
Douglas Gregor37cf6632010-10-06 21:11:08 +0000852 SavedMainFileBuffer = 0;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000853 }
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000854
Douglas Gregord54eb442010-10-12 16:25:54 +0000855 StoredDiagnostics.clear();
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000856 Clang.takeSourceManager();
857 Clang.takeFileManager();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000858 Invocation.reset(Clang.takeInvocation());
859 return true;
860}
861
Douglas Gregor44c181a2010-07-23 00:33:23 +0000862/// \brief Simple function to retrieve a path for a preamble precompiled header.
863static std::string GetPreamblePCHPath() {
864 // FIXME: This is lame; sys::Path should provide this function (in particular,
865 // it should know how to find the temporary files dir).
866 // FIXME: This is really lame. I copied this code from the Driver!
Douglas Gregor424668c2010-09-11 18:05:19 +0000867 // FIXME: This is a hack so that we can override the preamble file during
868 // crash-recovery testing, which is the only case where the preamble files
869 // are not necessarily cleaned up.
870 const char *TmpFile = ::getenv("CINDEXTEST_PREAMBLE_FILE");
871 if (TmpFile)
872 return TmpFile;
873
Douglas Gregor44c181a2010-07-23 00:33:23 +0000874 std::string Error;
875 const char *TmpDir = ::getenv("TMPDIR");
876 if (!TmpDir)
877 TmpDir = ::getenv("TEMP");
878 if (!TmpDir)
879 TmpDir = ::getenv("TMP");
Douglas Gregorc6cb2b02010-09-11 17:51:16 +0000880#ifdef LLVM_ON_WIN32
881 if (!TmpDir)
882 TmpDir = ::getenv("USERPROFILE");
883#endif
Douglas Gregor44c181a2010-07-23 00:33:23 +0000884 if (!TmpDir)
885 TmpDir = "/tmp";
886 llvm::sys::Path P(TmpDir);
Douglas Gregorc6cb2b02010-09-11 17:51:16 +0000887 P.createDirectoryOnDisk(true);
Douglas Gregor44c181a2010-07-23 00:33:23 +0000888 P.appendComponent("preamble");
Douglas Gregor6bf18302010-08-11 13:06:56 +0000889 P.appendSuffix("pch");
Douglas Gregor44c181a2010-07-23 00:33:23 +0000890 if (P.createTemporaryFileOnDisk())
891 return std::string();
892
Douglas Gregor44c181a2010-07-23 00:33:23 +0000893 return P.str();
894}
895
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000896/// \brief Compute the preamble for the main file, providing the source buffer
897/// that corresponds to the main file along with a pair (bytes, start-of-line)
898/// that describes the preamble.
899std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
Douglas Gregordf95a132010-08-09 20:45:32 +0000900ASTUnit::ComputePreamble(CompilerInvocation &Invocation,
901 unsigned MaxLines, bool &CreatedBuffer) {
Douglas Gregor175c4a92010-07-23 23:58:40 +0000902 FrontendOptions &FrontendOpts = Invocation.getFrontendOpts();
Douglas Gregor44c181a2010-07-23 00:33:23 +0000903 PreprocessorOptions &PreprocessorOpts
Douglas Gregor175c4a92010-07-23 23:58:40 +0000904 = Invocation.getPreprocessorOpts();
905 CreatedBuffer = false;
906
Douglas Gregor44c181a2010-07-23 00:33:23 +0000907 // Try to determine if the main file has been remapped, either from the
908 // command line (to another file) or directly through the compiler invocation
909 // (to a memory buffer).
Douglas Gregor175c4a92010-07-23 23:58:40 +0000910 llvm::MemoryBuffer *Buffer = 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000911 llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].second);
912 if (const llvm::sys::FileStatus *MainFileStatus = MainFilePath.getFileStatus()) {
913 // Check whether there is a file-file remapping of the main file
914 for (PreprocessorOptions::remapped_file_iterator
Douglas Gregor175c4a92010-07-23 23:58:40 +0000915 M = PreprocessorOpts.remapped_file_begin(),
916 E = PreprocessorOpts.remapped_file_end();
Douglas Gregor44c181a2010-07-23 00:33:23 +0000917 M != E;
918 ++M) {
919 llvm::sys::PathWithStatus MPath(M->first);
920 if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) {
921 if (MainFileStatus->uniqueID == MStatus->uniqueID) {
922 // We found a remapping. Try to load the resulting, remapped source.
Douglas Gregor175c4a92010-07-23 23:58:40 +0000923 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +0000924 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +0000925 CreatedBuffer = false;
926 }
927
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000928 Buffer = getBufferForFile(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +0000929 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000930 return std::make_pair((llvm::MemoryBuffer*)0,
931 std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000932 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000933 }
934 }
935 }
936
937 // Check whether there is a file-buffer remapping. It supercedes the
938 // file-file remapping.
939 for (PreprocessorOptions::remapped_file_buffer_iterator
940 M = PreprocessorOpts.remapped_file_buffer_begin(),
941 E = PreprocessorOpts.remapped_file_buffer_end();
942 M != E;
943 ++M) {
944 llvm::sys::PathWithStatus MPath(M->first);
945 if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) {
946 if (MainFileStatus->uniqueID == MStatus->uniqueID) {
947 // We found a remapping.
Douglas Gregor175c4a92010-07-23 23:58:40 +0000948 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +0000949 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +0000950 CreatedBuffer = false;
951 }
Douglas Gregor44c181a2010-07-23 00:33:23 +0000952
Douglas Gregor175c4a92010-07-23 23:58:40 +0000953 Buffer = const_cast<llvm::MemoryBuffer *>(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +0000954 }
955 }
Douglas Gregor175c4a92010-07-23 23:58:40 +0000956 }
Douglas Gregor44c181a2010-07-23 00:33:23 +0000957 }
958
959 // If the main source file was not remapped, load it now.
960 if (!Buffer) {
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000961 Buffer = getBufferForFile(FrontendOpts.Inputs[0].second);
Douglas Gregor44c181a2010-07-23 00:33:23 +0000962 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000963 return std::make_pair((llvm::MemoryBuffer*)0, std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000964
965 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000966 }
967
Douglas Gregordf95a132010-08-09 20:45:32 +0000968 return std::make_pair(Buffer, Lexer::ComputePreamble(Buffer, MaxLines));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000969}
970
Douglas Gregor754f3492010-07-24 00:38:13 +0000971static llvm::MemoryBuffer *CreatePaddedMainFileBuffer(llvm::MemoryBuffer *Old,
Douglas Gregor754f3492010-07-24 00:38:13 +0000972 unsigned NewSize,
973 llvm::StringRef NewName) {
974 llvm::MemoryBuffer *Result
975 = llvm::MemoryBuffer::getNewUninitMemBuffer(NewSize, NewName);
976 memcpy(const_cast<char*>(Result->getBufferStart()),
977 Old->getBufferStart(), Old->getBufferSize());
978 memset(const_cast<char*>(Result->getBufferStart()) + Old->getBufferSize(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000979 ' ', NewSize - Old->getBufferSize() - 1);
980 const_cast<char*>(Result->getBufferEnd())[-1] = '\n';
Douglas Gregor754f3492010-07-24 00:38:13 +0000981
Douglas Gregor754f3492010-07-24 00:38:13 +0000982 return Result;
983}
984
Douglas Gregor175c4a92010-07-23 23:58:40 +0000985/// \brief Attempt to build or re-use a precompiled preamble when (re-)parsing
986/// the source file.
987///
988/// This routine will compute the preamble of the main source file. If a
989/// non-trivial preamble is found, it will precompile that preamble into a
990/// precompiled header so that the precompiled preamble can be used to reduce
991/// reparsing time. If a precompiled preamble has already been constructed,
992/// this routine will determine if it is still valid and, if so, avoid
993/// rebuilding the precompiled preamble.
994///
Douglas Gregordf95a132010-08-09 20:45:32 +0000995/// \param AllowRebuild When true (the default), this routine is
996/// allowed to rebuild the precompiled preamble if it is found to be
997/// out-of-date.
998///
999/// \param MaxLines When non-zero, the maximum number of lines that
1000/// can occur within the preamble.
1001///
Douglas Gregor754f3492010-07-24 00:38:13 +00001002/// \returns If the precompiled preamble can be used, returns a newly-allocated
1003/// buffer that should be used in place of the main file when doing so.
1004/// Otherwise, returns a NULL pointer.
Douglas Gregordf95a132010-08-09 20:45:32 +00001005llvm::MemoryBuffer *ASTUnit::getMainBufferWithPrecompiledPreamble(
Douglas Gregor2283d792010-08-20 00:59:43 +00001006 CompilerInvocation PreambleInvocation,
Douglas Gregordf95a132010-08-09 20:45:32 +00001007 bool AllowRebuild,
1008 unsigned MaxLines) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001009 FrontendOptions &FrontendOpts = PreambleInvocation.getFrontendOpts();
1010 PreprocessorOptions &PreprocessorOpts
1011 = PreambleInvocation.getPreprocessorOpts();
1012
1013 bool CreatedPreambleBuffer = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001014 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > NewPreamble
Douglas Gregordf95a132010-08-09 20:45:32 +00001015 = ComputePreamble(PreambleInvocation, MaxLines, CreatedPreambleBuffer);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001016
Douglas Gregor73fc9122010-11-16 20:45:51 +00001017 // If ComputePreamble() Take ownership of the
1018 llvm::OwningPtr<llvm::MemoryBuffer> OwnedPreambleBuffer;
1019 if (CreatedPreambleBuffer)
1020 OwnedPreambleBuffer.reset(NewPreamble.first);
1021
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001022 if (!NewPreamble.second.first) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001023 // We couldn't find a preamble in the main source. Clear out the current
1024 // preamble, if we have one. It's obviously no good any more.
1025 Preamble.clear();
1026 if (!PreambleFile.empty()) {
Douglas Gregor385103b2010-07-30 20:58:08 +00001027 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001028 PreambleFile.clear();
1029 }
Douglas Gregoreababfb2010-08-04 05:53:38 +00001030
1031 // The next time we actually see a preamble, precompile it.
1032 PreambleRebuildCounter = 1;
Douglas Gregor754f3492010-07-24 00:38:13 +00001033 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001034 }
1035
1036 if (!Preamble.empty()) {
1037 // We've previously computed a preamble. Check whether we have the same
1038 // preamble now that we did before, and that there's enough space in
1039 // the main-file buffer within the precompiled preamble to fit the
1040 // new main file.
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001041 if (Preamble.size() == NewPreamble.second.first &&
1042 PreambleEndsAtStartOfLine == NewPreamble.second.second &&
Douglas Gregor592508e2010-07-24 00:42:07 +00001043 NewPreamble.first->getBufferSize() < PreambleReservedSize-2 &&
Douglas Gregor175c4a92010-07-23 23:58:40 +00001044 memcmp(&Preamble[0], NewPreamble.first->getBufferStart(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001045 NewPreamble.second.first) == 0) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001046 // The preamble has not changed. We may be able to re-use the precompiled
1047 // preamble.
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001048
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001049 // Check that none of the files used by the preamble have changed.
1050 bool AnyFileChanged = false;
1051
1052 // First, make a record of those files that have been overridden via
1053 // remapping or unsaved_files.
1054 llvm::StringMap<std::pair<off_t, time_t> > OverriddenFiles;
1055 for (PreprocessorOptions::remapped_file_iterator
1056 R = PreprocessorOpts.remapped_file_begin(),
1057 REnd = PreprocessorOpts.remapped_file_end();
1058 !AnyFileChanged && R != REnd;
1059 ++R) {
1060 struct stat StatBuf;
1061 if (stat(R->second.c_str(), &StatBuf)) {
1062 // If we can't stat the file we're remapping to, assume that something
1063 // horrible happened.
1064 AnyFileChanged = true;
1065 break;
1066 }
Douglas Gregor754f3492010-07-24 00:38:13 +00001067
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001068 OverriddenFiles[R->first] = std::make_pair(StatBuf.st_size,
1069 StatBuf.st_mtime);
1070 }
1071 for (PreprocessorOptions::remapped_file_buffer_iterator
1072 R = PreprocessorOpts.remapped_file_buffer_begin(),
1073 REnd = PreprocessorOpts.remapped_file_buffer_end();
1074 !AnyFileChanged && R != REnd;
1075 ++R) {
1076 // FIXME: Should we actually compare the contents of file->buffer
1077 // remappings?
1078 OverriddenFiles[R->first] = std::make_pair(R->second->getBufferSize(),
1079 0);
1080 }
1081
1082 // Check whether anything has changed.
1083 for (llvm::StringMap<std::pair<off_t, time_t> >::iterator
1084 F = FilesInPreamble.begin(), FEnd = FilesInPreamble.end();
1085 !AnyFileChanged && F != FEnd;
1086 ++F) {
1087 llvm::StringMap<std::pair<off_t, time_t> >::iterator Overridden
1088 = OverriddenFiles.find(F->first());
1089 if (Overridden != OverriddenFiles.end()) {
1090 // This file was remapped; check whether the newly-mapped file
1091 // matches up with the previous mapping.
1092 if (Overridden->second != F->second)
1093 AnyFileChanged = true;
1094 continue;
1095 }
1096
1097 // The file was not remapped; check whether it has changed on disk.
1098 struct stat StatBuf;
1099 if (stat(F->first(), &StatBuf)) {
1100 // If we can't stat the file, assume that something horrible happened.
1101 AnyFileChanged = true;
1102 } else if (StatBuf.st_size != F->second.first ||
1103 StatBuf.st_mtime != F->second.second)
1104 AnyFileChanged = true;
1105 }
1106
1107 if (!AnyFileChanged) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001108 // Okay! We can re-use the precompiled preamble.
1109
1110 // Set the state of the diagnostic object to mimic its state
1111 // after parsing the preamble.
Douglas Gregor32be4a52010-10-11 21:37:58 +00001112 // FIXME: This won't catch any #pragma push warning changes that
1113 // have occurred in the preamble.
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001114 getDiagnostics().Reset();
Douglas Gregor32be4a52010-10-11 21:37:58 +00001115 ProcessWarningOptions(getDiagnostics(),
1116 PreambleInvocation.getDiagnosticOpts());
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001117 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1118 if (StoredDiagnostics.size() > NumStoredDiagnosticsInPreamble)
1119 StoredDiagnostics.erase(
1120 StoredDiagnostics.begin() + NumStoredDiagnosticsInPreamble,
1121 StoredDiagnostics.end());
1122
1123 // Create a version of the main file buffer that is padded to
1124 // buffer size we reserved when creating the preamble.
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001125 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001126 PreambleReservedSize,
1127 FrontendOpts.Inputs[0].second);
1128 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001129 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001130
1131 // If we aren't allowed to rebuild the precompiled preamble, just
1132 // return now.
1133 if (!AllowRebuild)
1134 return 0;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001135
Douglas Gregor175c4a92010-07-23 23:58:40 +00001136 // We can't reuse the previously-computed preamble. Build a new one.
1137 Preamble.clear();
Douglas Gregor385103b2010-07-30 20:58:08 +00001138 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001139 PreambleRebuildCounter = 1;
Douglas Gregordf95a132010-08-09 20:45:32 +00001140 } else if (!AllowRebuild) {
1141 // We aren't allowed to rebuild the precompiled preamble; just
1142 // return now.
1143 return 0;
1144 }
Douglas Gregoreababfb2010-08-04 05:53:38 +00001145
1146 // If the preamble rebuild counter > 1, it's because we previously
1147 // failed to build a preamble and we're not yet ready to try
1148 // again. Decrement the counter and return a failure.
1149 if (PreambleRebuildCounter > 1) {
1150 --PreambleRebuildCounter;
1151 return 0;
1152 }
1153
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001154 // Create a temporary file for the precompiled preamble. In rare
1155 // circumstances, this can fail.
1156 std::string PreamblePCHPath = GetPreamblePCHPath();
1157 if (PreamblePCHPath.empty()) {
1158 // Try again next time.
1159 PreambleRebuildCounter = 1;
1160 return 0;
1161 }
1162
Douglas Gregor175c4a92010-07-23 23:58:40 +00001163 // We did not previously compute a preamble, or it can't be reused anyway.
Douglas Gregor213f18b2010-10-28 15:44:59 +00001164 SimpleTimer PreambleTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001165 PreambleTimer.setOutput("Precompiling preamble");
Douglas Gregor44c181a2010-07-23 00:33:23 +00001166
1167 // Create a new buffer that stores the preamble. The buffer also contains
1168 // extra space for the original contents of the file (which will be present
1169 // when we actually parse the file) along with more room in case the file
Douglas Gregor175c4a92010-07-23 23:58:40 +00001170 // grows.
1171 PreambleReservedSize = NewPreamble.first->getBufferSize();
1172 if (PreambleReservedSize < 4096)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001173 PreambleReservedSize = 8191;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001174 else
Douglas Gregor175c4a92010-07-23 23:58:40 +00001175 PreambleReservedSize *= 2;
1176
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001177 // Save the preamble text for later; we'll need to compare against it for
1178 // subsequent reparses.
1179 Preamble.assign(NewPreamble.first->getBufferStart(),
1180 NewPreamble.first->getBufferStart()
1181 + NewPreamble.second.first);
1182 PreambleEndsAtStartOfLine = NewPreamble.second.second;
1183
Douglas Gregor671947b2010-08-19 01:33:06 +00001184 delete PreambleBuffer;
1185 PreambleBuffer
Douglas Gregor175c4a92010-07-23 23:58:40 +00001186 = llvm::MemoryBuffer::getNewUninitMemBuffer(PreambleReservedSize,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001187 FrontendOpts.Inputs[0].second);
1188 memcpy(const_cast<char*>(PreambleBuffer->getBufferStart()),
Douglas Gregor175c4a92010-07-23 23:58:40 +00001189 NewPreamble.first->getBufferStart(), Preamble.size());
1190 memset(const_cast<char*>(PreambleBuffer->getBufferStart()) + Preamble.size(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001191 ' ', PreambleReservedSize - Preamble.size() - 1);
1192 const_cast<char*>(PreambleBuffer->getBufferEnd())[-1] = '\n';
Douglas Gregor44c181a2010-07-23 00:33:23 +00001193
1194 // Remap the main source file to the preamble buffer.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001195 llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001196 PreprocessorOpts.addRemappedFile(MainFilePath.str(), PreambleBuffer);
1197
1198 // Tell the compiler invocation to generate a temporary precompiled header.
1199 FrontendOpts.ProgramAction = frontend::GeneratePCH;
Douglas Gregor85e51912010-10-01 01:05:22 +00001200 FrontendOpts.ChainedPCH = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001201 // FIXME: Generate the precompiled header into memory?
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001202 FrontendOpts.OutputFile = PreamblePCHPath;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001203 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
1204 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001205
1206 // Create the compiler instance to use for building the precompiled preamble.
1207 CompilerInstance Clang;
1208 Clang.setInvocation(&PreambleInvocation);
1209 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
1210
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001211 // Set up diagnostics, capturing all of the diagnostics produced.
Douglas Gregor44c181a2010-07-23 00:33:23 +00001212 Clang.setDiagnostics(&getDiagnostics());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001213
1214 // Create the target instance.
1215 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
1216 Clang.getTargetOpts()));
1217 if (!Clang.hasTarget()) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001218 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1219 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001220 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001221 PreprocessorOpts.eraseRemappedFile(
1222 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001223 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001224 }
1225
1226 // Inform the target of the language options.
1227 //
1228 // FIXME: We shouldn't need to do this, the target should be immutable once
1229 // created. This complexity should be lifted elsewhere.
1230 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
1231
1232 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
1233 "Invocation must have exactly one source file!");
1234 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
1235 "FIXME: AST inputs not yet supported here!");
1236 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
1237 "IR inputs not support here!");
1238
1239 // Clear out old caches and data.
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001240 getDiagnostics().Reset();
Douglas Gregor32be4a52010-10-11 21:37:58 +00001241 ProcessWarningOptions(getDiagnostics(), Clang.getDiagnosticOpts());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001242 StoredDiagnostics.erase(
1243 StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver,
1244 StoredDiagnostics.end());
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001245 TopLevelDecls.clear();
1246 TopLevelDeclsInPreamble.clear();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001247
1248 // Create a file manager object to provide access to and cache the filesystem.
1249 Clang.setFileManager(new FileManager);
1250
1251 // Create the source manager.
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00001252 Clang.setSourceManager(new SourceManager(getDiagnostics(),
1253 Clang.getFileManager(),
1254 Clang.getFileSystemOpts()));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001255
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001256 llvm::OwningPtr<PrecompilePreambleAction> Act;
1257 Act.reset(new PrecompilePreambleAction(*this));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001258 if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
1259 Clang.getFrontendOpts().Inputs[0].first)) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001260 Clang.takeInvocation();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001261 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1262 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001263 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001264 PreprocessorOpts.eraseRemappedFile(
1265 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001266 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001267 }
1268
1269 Act->Execute();
1270 Act->EndSourceFile();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001271 Clang.takeInvocation();
1272
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001273 if (Diagnostics->hasErrorOccurred()) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001274 // There were errors parsing the preamble, so no precompiled header was
1275 // generated. Forget that we even tried.
Douglas Gregor06e50442010-09-27 16:43:25 +00001276 // FIXME: Should we leave a note for ourselves to try again?
Douglas Gregor175c4a92010-07-23 23:58:40 +00001277 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1278 Preamble.clear();
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001279 TopLevelDeclsInPreamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001280 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001281 PreprocessorOpts.eraseRemappedFile(
1282 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001283 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001284 }
1285
1286 // Keep track of the preamble we precompiled.
1287 PreambleFile = FrontendOpts.OutputFile;
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001288 NumStoredDiagnosticsInPreamble = StoredDiagnostics.size();
1289 NumWarningsInPreamble = getDiagnostics().getNumWarnings();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001290
1291 // Keep track of all of the files that the source manager knows about,
1292 // so we can verify whether they have changed or not.
1293 FilesInPreamble.clear();
1294 SourceManager &SourceMgr = Clang.getSourceManager();
1295 const llvm::MemoryBuffer *MainFileBuffer
1296 = SourceMgr.getBuffer(SourceMgr.getMainFileID());
1297 for (SourceManager::fileinfo_iterator F = SourceMgr.fileinfo_begin(),
1298 FEnd = SourceMgr.fileinfo_end();
1299 F != FEnd;
1300 ++F) {
1301 const FileEntry *File = F->second->Entry;
1302 if (!File || F->second->getRawBuffer() == MainFileBuffer)
1303 continue;
1304
1305 FilesInPreamble[File->getName()]
1306 = std::make_pair(F->second->getSize(), File->getModificationTime());
1307 }
1308
Douglas Gregoreababfb2010-08-04 05:53:38 +00001309 PreambleRebuildCounter = 1;
Douglas Gregor671947b2010-08-19 01:33:06 +00001310 PreprocessorOpts.eraseRemappedFile(
1311 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001312 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregor754f3492010-07-24 00:38:13 +00001313 PreambleReservedSize,
1314 FrontendOpts.Inputs[0].second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001315}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001316
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001317void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1318 std::vector<Decl *> Resolved;
1319 Resolved.reserve(TopLevelDeclsInPreamble.size());
1320 ExternalASTSource &Source = *getASTContext().getExternalSource();
1321 for (unsigned I = 0, N = TopLevelDeclsInPreamble.size(); I != N; ++I) {
1322 // Resolve the declaration ID to an actual declaration, possibly
1323 // deserializing the declaration in the process.
1324 Decl *D = Source.GetExternalDecl(TopLevelDeclsInPreamble[I]);
1325 if (D)
1326 Resolved.push_back(D);
1327 }
1328 TopLevelDeclsInPreamble.clear();
1329 TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1330}
1331
1332unsigned ASTUnit::getMaxPCHLevel() const {
1333 if (!getOnlyLocalDecls())
1334 return Decl::MaxPCHLevel;
1335
Sebastian Redl1d9f1fe2010-10-05 16:15:19 +00001336 return 0;
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001337}
1338
Douglas Gregor213f18b2010-10-28 15:44:59 +00001339llvm::StringRef ASTUnit::getMainFileName() const {
1340 return Invocation->getFrontendOpts().Inputs[0].second;
1341}
1342
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001343bool ASTUnit::LoadFromCompilerInvocation(bool PrecompilePreamble) {
1344 if (!Invocation)
1345 return true;
1346
1347 // We'll manage file buffers ourselves.
1348 Invocation->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1349 Invocation->getFrontendOpts().DisableFree = false;
1350
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001351 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregor99ba2022010-10-27 17:24:53 +00001352 if (PrecompilePreamble) {
Douglas Gregor08bb4c62010-11-15 23:00:34 +00001353 PreambleRebuildCounter = 2;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001354 OverrideMainBuffer
1355 = getMainBufferWithPrecompiledPreamble(*Invocation);
1356 }
1357
Douglas Gregor213f18b2010-10-28 15:44:59 +00001358 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001359 ParsingTimer.setOutput("Parsing " + getMainFileName());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001360
Douglas Gregor213f18b2010-10-28 15:44:59 +00001361 return Parse(OverrideMainBuffer);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001362}
1363
Douglas Gregorabc563f2010-07-19 21:46:24 +00001364ASTUnit *ASTUnit::LoadFromCompilerInvocation(CompilerInvocation *CI,
1365 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
1366 bool OnlyLocalDecls,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001367 bool CaptureDiagnostics,
Douglas Gregordf95a132010-08-09 20:45:32 +00001368 bool PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001369 bool CompleteTranslationUnit,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001370 bool CacheCodeCompletionResults) {
Douglas Gregorabc563f2010-07-19 21:46:24 +00001371 // Create the AST unit.
1372 llvm::OwningPtr<ASTUnit> AST;
1373 AST.reset(new ASTUnit(false));
Douglas Gregore47be3e2010-11-11 00:39:14 +00001374 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001375 AST->Diagnostics = Diags;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001376 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001377 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregordf95a132010-08-09 20:45:32 +00001378 AST->CompleteTranslationUnit = CompleteTranslationUnit;
Douglas Gregor87c08a52010-08-13 22:48:40 +00001379 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Douglas Gregor08bb4c62010-11-15 23:00:34 +00001380 AST->CacheCodeCompletionCoolDown = 1;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001381 AST->Invocation.reset(CI);
1382
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001383 return AST->LoadFromCompilerInvocation(PrecompilePreamble)? 0 : AST.take();
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001384}
Daniel Dunbar7b556682009-12-02 03:23:45 +00001385
1386ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin,
1387 const char **ArgEnd,
Douglas Gregor28019772010-04-05 23:52:57 +00001388 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
Daniel Dunbar869824e2009-12-13 03:46:13 +00001389 llvm::StringRef ResourceFilesPath,
Daniel Dunbar7b556682009-12-02 03:23:45 +00001390 bool OnlyLocalDecls,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001391 bool CaptureDiagnostics,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001392 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +00001393 unsigned NumRemappedFiles,
Douglas Gregordf95a132010-08-09 20:45:32 +00001394 bool PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001395 bool CompleteTranslationUnit,
Douglas Gregor99ba2022010-10-27 17:24:53 +00001396 bool CacheCodeCompletionResults,
1397 bool CXXPrecompilePreamble,
1398 bool CXXChainedPCH) {
Douglas Gregor28019772010-04-05 23:52:57 +00001399 if (!Diags.getPtr()) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001400 // No diagnostics engine was provided, so create our own diagnostics object
1401 // with the default options.
1402 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00001403 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001404 }
1405
Daniel Dunbar7b556682009-12-02 03:23:45 +00001406 llvm::SmallVector<const char *, 16> Args;
1407 Args.push_back("<clang>"); // FIXME: Remove dummy argument.
1408 Args.insert(Args.end(), ArgBegin, ArgEnd);
1409
1410 // FIXME: Find a cleaner way to force the driver into restricted modes. We
1411 // also want to force it to use clang.
1412 Args.push_back("-fsyntax-only");
1413
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001414 llvm::SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
1415
1416 llvm::OwningPtr<CompilerInvocation> CI;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001417
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001418 {
Douglas Gregore47be3e2010-11-11 00:39:14 +00001419 CaptureDroppedDiagnostics Capture(CaptureDiagnostics, *Diags,
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001420 StoredDiagnostics);
Daniel Dunbar3bd54cc2010-01-25 00:44:02 +00001421
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001422 // FIXME: We shouldn't have to pass in the path info.
1423 driver::Driver TheDriver("clang", llvm::sys::getHostTriple(),
1424 "a.out", false, false, *Diags);
Daniel Dunbar3bd54cc2010-01-25 00:44:02 +00001425
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001426 // Don't check that inputs exist, they have been remapped.
1427 TheDriver.setCheckInputsExist(false);
Daniel Dunbar7b556682009-12-02 03:23:45 +00001428
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001429 llvm::OwningPtr<driver::Compilation> C(
1430 TheDriver.BuildCompilation(Args.size(), Args.data()));
1431
1432 // We expect to get back exactly one command job, if we didn't something
1433 // failed.
1434 const driver::JobList &Jobs = C->getJobs();
1435 if (Jobs.size() != 1 || !isa<driver::Command>(Jobs.begin())) {
1436 llvm::SmallString<256> Msg;
1437 llvm::raw_svector_ostream OS(Msg);
1438 C->PrintJob(OS, C->getJobs(), "; ", true);
1439 Diags->Report(diag::err_fe_expected_compiler_job) << OS.str();
1440 return 0;
1441 }
1442
1443 const driver::Command *Cmd = cast<driver::Command>(*Jobs.begin());
1444 if (llvm::StringRef(Cmd->getCreator().getName()) != "clang") {
1445 Diags->Report(diag::err_fe_expected_clang_command);
1446 return 0;
1447 }
1448
1449 const driver::ArgStringList &CCArgs = Cmd->getArguments();
1450 CI.reset(new CompilerInvocation);
1451 CompilerInvocation::CreateFromArgs(*CI,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001452 const_cast<const char **>(CCArgs.data()),
1453 const_cast<const char **>(CCArgs.data()) +
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001454 CCArgs.size(),
1455 *Diags);
Daniel Dunbar7b556682009-12-02 03:23:45 +00001456 }
Douglas Gregore47be3e2010-11-11 00:39:14 +00001457
Douglas Gregor4db64a42010-01-23 00:14:00 +00001458 // Override any files that need remapping
1459 for (unsigned I = 0; I != NumRemappedFiles; ++I)
Daniel Dunbar807b0612010-01-30 21:47:16 +00001460 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
Daniel Dunbarb26d4832010-02-16 01:55:04 +00001461 RemappedFiles[I].second);
Douglas Gregor4db64a42010-01-23 00:14:00 +00001462
Daniel Dunbar8b9adfe2009-12-15 00:06:45 +00001463 // Override the resources path.
Daniel Dunbar807b0612010-01-30 21:47:16 +00001464 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
Daniel Dunbar7b556682009-12-02 03:23:45 +00001465
Douglas Gregor99ba2022010-10-27 17:24:53 +00001466 // Check whether we should precompile the preamble and/or use chained PCH.
1467 // FIXME: This is a temporary hack while we debug C++ chained PCH.
1468 if (CI->getLangOpts().CPlusPlus) {
1469 PrecompilePreamble = PrecompilePreamble && CXXPrecompilePreamble;
1470
1471 if (PrecompilePreamble && !CXXChainedPCH &&
1472 !CI->getPreprocessorOpts().ImplicitPCHInclude.empty())
1473 PrecompilePreamble = false;
1474 }
1475
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001476 // Create the AST unit.
1477 llvm::OwningPtr<ASTUnit> AST;
1478 AST.reset(new ASTUnit(false));
Douglas Gregore47be3e2010-11-11 00:39:14 +00001479 ConfigureDiags(Diags, *AST, CaptureDiagnostics);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001480 AST->Diagnostics = Diags;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001481 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001482 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001483 AST->CompleteTranslationUnit = CompleteTranslationUnit;
1484 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Douglas Gregor08bb4c62010-11-15 23:00:34 +00001485 AST->CacheCodeCompletionCoolDown = 1;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001486 AST->NumStoredDiagnosticsFromDriver = StoredDiagnostics.size();
1487 AST->NumStoredDiagnosticsInPreamble = StoredDiagnostics.size();
1488 AST->StoredDiagnostics.swap(StoredDiagnostics);
1489 AST->Invocation.reset(CI.take());
1490 return AST->LoadFromCompilerInvocation(PrecompilePreamble)? 0 : AST.take();
Daniel Dunbar7b556682009-12-02 03:23:45 +00001491}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001492
1493bool ASTUnit::Reparse(RemappedFile *RemappedFiles, unsigned NumRemappedFiles) {
1494 if (!Invocation.get())
1495 return true;
1496
Douglas Gregor213f18b2010-10-28 15:44:59 +00001497 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001498 ParsingTimer.setOutput("Reparsing " + getMainFileName());
Douglas Gregor213f18b2010-10-28 15:44:59 +00001499
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001500 // Remap files.
Douglas Gregorf128fed2010-08-20 00:02:33 +00001501 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1502 for (PreprocessorOptions::remapped_file_buffer_iterator
1503 R = PPOpts.remapped_file_buffer_begin(),
1504 REnd = PPOpts.remapped_file_buffer_end();
1505 R != REnd;
1506 ++R) {
1507 delete R->second;
1508 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001509 Invocation->getPreprocessorOpts().clearRemappedFiles();
1510 for (unsigned I = 0; I != NumRemappedFiles; ++I)
1511 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
1512 RemappedFiles[I].second);
1513
Douglas Gregoreababfb2010-08-04 05:53:38 +00001514 // If we have a preamble file lying around, or if we might try to
1515 // build a precompiled preamble, do so now.
Douglas Gregor754f3492010-07-24 00:38:13 +00001516 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregoreababfb2010-08-04 05:53:38 +00001517 if (!PreambleFile.empty() || PreambleRebuildCounter > 0)
Douglas Gregor2283d792010-08-20 00:59:43 +00001518 OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(*Invocation);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001519
Douglas Gregorabc563f2010-07-19 21:46:24 +00001520 // Clear out the diagnostics state.
Douglas Gregor32be4a52010-10-11 21:37:58 +00001521 if (!OverrideMainBuffer) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001522 getDiagnostics().Reset();
Douglas Gregor32be4a52010-10-11 21:37:58 +00001523 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1524 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001525
Douglas Gregor175c4a92010-07-23 23:58:40 +00001526 // Parse the sources
Douglas Gregor754f3492010-07-24 00:38:13 +00001527 bool Result = Parse(OverrideMainBuffer);
Douglas Gregor727d93e2010-08-17 00:40:40 +00001528
1529 if (ShouldCacheCodeCompletionResults) {
1530 if (CacheCodeCompletionCoolDown > 0)
1531 --CacheCodeCompletionCoolDown;
1532 else if (top_level_size() != NumTopLevelDeclsAtLastCompletionCache)
1533 CacheCodeCompletionResults();
1534 }
1535
Douglas Gregor175c4a92010-07-23 23:58:40 +00001536 return Result;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001537}
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001538
Douglas Gregor87c08a52010-08-13 22:48:40 +00001539//----------------------------------------------------------------------------//
1540// Code completion
1541//----------------------------------------------------------------------------//
1542
1543namespace {
1544 /// \brief Code completion consumer that combines the cached code-completion
1545 /// results from an ASTUnit with the code-completion results provided to it,
1546 /// then passes the result on to
1547 class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
1548 unsigned NormalContexts;
1549 ASTUnit &AST;
1550 CodeCompleteConsumer &Next;
1551
1552 public:
1553 AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
Douglas Gregor8071e422010-08-15 06:18:01 +00001554 bool IncludeMacros, bool IncludeCodePatterns,
1555 bool IncludeGlobals)
1556 : CodeCompleteConsumer(IncludeMacros, IncludeCodePatterns, IncludeGlobals,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001557 Next.isOutputBinary()), AST(AST), Next(Next)
1558 {
1559 // Compute the set of contexts in which we will look when we don't have
1560 // any information about the specific context.
1561 NormalContexts
1562 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
1563 | (1 << (CodeCompletionContext::CCC_ObjCInterface - 1))
1564 | (1 << (CodeCompletionContext::CCC_ObjCImplementation - 1))
1565 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
1566 | (1 << (CodeCompletionContext::CCC_Statement - 1))
1567 | (1 << (CodeCompletionContext::CCC_Expression - 1))
1568 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1))
1569 | (1 << (CodeCompletionContext::CCC_MemberAccess - 1))
Douglas Gregor02688102010-09-14 23:59:36 +00001570 | (1 << (CodeCompletionContext::CCC_ObjCProtocolName - 1))
Douglas Gregor52779fb2010-09-23 23:01:17 +00001571 | (1 << (CodeCompletionContext::CCC_ParenthesizedExpression - 1))
1572 | (1 << (CodeCompletionContext::CCC_Recovery - 1));
Douglas Gregor02688102010-09-14 23:59:36 +00001573
Douglas Gregor87c08a52010-08-13 22:48:40 +00001574 if (AST.getASTContext().getLangOptions().CPlusPlus)
1575 NormalContexts |= (1 << (CodeCompletionContext::CCC_EnumTag - 1))
1576 | (1 << (CodeCompletionContext::CCC_UnionTag - 1))
1577 | (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1));
1578 }
1579
1580 virtual void ProcessCodeCompleteResults(Sema &S,
1581 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00001582 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001583 unsigned NumResults);
Douglas Gregor87c08a52010-08-13 22:48:40 +00001584
1585 virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1586 OverloadCandidate *Candidates,
1587 unsigned NumCandidates) {
1588 Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates);
1589 }
1590 };
1591}
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001592
Douglas Gregor5f808c22010-08-16 21:18:39 +00001593/// \brief Helper function that computes which global names are hidden by the
1594/// local code-completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00001595static void CalculateHiddenNames(const CodeCompletionContext &Context,
1596 CodeCompletionResult *Results,
1597 unsigned NumResults,
1598 ASTContext &Ctx,
1599 llvm::StringSet<llvm::BumpPtrAllocator> &HiddenNames){
Douglas Gregor5f808c22010-08-16 21:18:39 +00001600 bool OnlyTagNames = false;
1601 switch (Context.getKind()) {
Douglas Gregor52779fb2010-09-23 23:01:17 +00001602 case CodeCompletionContext::CCC_Recovery:
Douglas Gregor5f808c22010-08-16 21:18:39 +00001603 case CodeCompletionContext::CCC_TopLevel:
1604 case CodeCompletionContext::CCC_ObjCInterface:
1605 case CodeCompletionContext::CCC_ObjCImplementation:
1606 case CodeCompletionContext::CCC_ObjCIvarList:
1607 case CodeCompletionContext::CCC_ClassStructUnion:
1608 case CodeCompletionContext::CCC_Statement:
1609 case CodeCompletionContext::CCC_Expression:
1610 case CodeCompletionContext::CCC_ObjCMessageReceiver:
1611 case CodeCompletionContext::CCC_MemberAccess:
1612 case CodeCompletionContext::CCC_Namespace:
1613 case CodeCompletionContext::CCC_Type:
Douglas Gregor2ccccb32010-08-23 18:23:48 +00001614 case CodeCompletionContext::CCC_Name:
1615 case CodeCompletionContext::CCC_PotentiallyQualifiedName:
Douglas Gregor02688102010-09-14 23:59:36 +00001616 case CodeCompletionContext::CCC_ParenthesizedExpression:
Douglas Gregor5f808c22010-08-16 21:18:39 +00001617 break;
1618
1619 case CodeCompletionContext::CCC_EnumTag:
1620 case CodeCompletionContext::CCC_UnionTag:
1621 case CodeCompletionContext::CCC_ClassOrStructTag:
1622 OnlyTagNames = true;
1623 break;
1624
1625 case CodeCompletionContext::CCC_ObjCProtocolName:
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001626 case CodeCompletionContext::CCC_MacroName:
1627 case CodeCompletionContext::CCC_MacroNameUse:
Douglas Gregorf29c5232010-08-24 22:20:20 +00001628 case CodeCompletionContext::CCC_PreprocessorExpression:
Douglas Gregor721f3592010-08-25 18:41:16 +00001629 case CodeCompletionContext::CCC_PreprocessorDirective:
Douglas Gregor59a66942010-08-25 18:04:30 +00001630 case CodeCompletionContext::CCC_NaturalLanguage:
Douglas Gregor458433d2010-08-26 15:07:07 +00001631 case CodeCompletionContext::CCC_SelectorName:
Douglas Gregor1a480c42010-08-27 17:35:51 +00001632 case CodeCompletionContext::CCC_TypeQualifiers:
Douglas Gregor52779fb2010-09-23 23:01:17 +00001633 case CodeCompletionContext::CCC_Other:
Douglas Gregor721f3592010-08-25 18:41:16 +00001634 // We're looking for nothing, or we're looking for names that cannot
1635 // be hidden.
Douglas Gregor5f808c22010-08-16 21:18:39 +00001636 return;
1637 }
1638
John McCall0a2c5e22010-08-25 06:19:51 +00001639 typedef CodeCompletionResult Result;
Douglas Gregor5f808c22010-08-16 21:18:39 +00001640 for (unsigned I = 0; I != NumResults; ++I) {
1641 if (Results[I].Kind != Result::RK_Declaration)
1642 continue;
1643
1644 unsigned IDNS
1645 = Results[I].Declaration->getUnderlyingDecl()->getIdentifierNamespace();
1646
1647 bool Hiding = false;
1648 if (OnlyTagNames)
1649 Hiding = (IDNS & Decl::IDNS_Tag);
1650 else {
1651 unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
Douglas Gregora5fb7c32010-08-16 23:05:20 +00001652 Decl::IDNS_Namespace | Decl::IDNS_Ordinary |
1653 Decl::IDNS_NonMemberOperator);
Douglas Gregor5f808c22010-08-16 21:18:39 +00001654 if (Ctx.getLangOptions().CPlusPlus)
1655 HiddenIDNS |= Decl::IDNS_Tag;
1656 Hiding = (IDNS & HiddenIDNS);
1657 }
1658
1659 if (!Hiding)
1660 continue;
1661
1662 DeclarationName Name = Results[I].Declaration->getDeclName();
1663 if (IdentifierInfo *Identifier = Name.getAsIdentifierInfo())
1664 HiddenNames.insert(Identifier->getName());
1665 else
1666 HiddenNames.insert(Name.getAsString());
1667 }
1668}
1669
1670
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001671void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
1672 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00001673 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001674 unsigned NumResults) {
1675 // Merge the results we were given with the results we cached.
1676 bool AddedResult = false;
Douglas Gregor5f808c22010-08-16 21:18:39 +00001677 unsigned InContexts
Douglas Gregor52779fb2010-09-23 23:01:17 +00001678 = (Context.getKind() == CodeCompletionContext::CCC_Recovery? NormalContexts
Douglas Gregor5f808c22010-08-16 21:18:39 +00001679 : (1 << (Context.getKind() - 1)));
1680
1681 // Contains the set of names that are hidden by "local" completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00001682 llvm::StringSet<llvm::BumpPtrAllocator> HiddenNames;
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001683 llvm::SmallVector<CodeCompletionString *, 4> StringsToDestroy;
John McCall0a2c5e22010-08-25 06:19:51 +00001684 typedef CodeCompletionResult Result;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001685 llvm::SmallVector<Result, 8> AllResults;
1686 for (ASTUnit::cached_completion_iterator
Douglas Gregor5535d572010-08-16 21:23:13 +00001687 C = AST.cached_completion_begin(),
1688 CEnd = AST.cached_completion_end();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001689 C != CEnd; ++C) {
1690 // If the context we are in matches any of the contexts we are
1691 // interested in, we'll add this result.
1692 if ((C->ShowInContexts & InContexts) == 0)
1693 continue;
1694
1695 // If we haven't added any results previously, do so now.
1696 if (!AddedResult) {
Douglas Gregor5f808c22010-08-16 21:18:39 +00001697 CalculateHiddenNames(Context, Results, NumResults, S.Context,
1698 HiddenNames);
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001699 AllResults.insert(AllResults.end(), Results, Results + NumResults);
1700 AddedResult = true;
1701 }
1702
Douglas Gregor5f808c22010-08-16 21:18:39 +00001703 // Determine whether this global completion result is hidden by a local
1704 // completion result. If so, skip it.
1705 if (C->Kind != CXCursor_MacroDefinition &&
1706 HiddenNames.count(C->Completion->getTypedText()))
1707 continue;
1708
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001709 // Adjust priority based on similar type classes.
1710 unsigned Priority = C->Priority;
Douglas Gregor4125c372010-08-25 18:03:13 +00001711 CXCursorKind CursorKind = C->Kind;
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001712 CodeCompletionString *Completion = C->Completion;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001713 if (!Context.getPreferredType().isNull()) {
1714 if (C->Kind == CXCursor_MacroDefinition) {
1715 Priority = getMacroUsagePriority(C->Completion->getTypedText(),
Douglas Gregorb05496d2010-09-20 21:11:48 +00001716 S.getLangOptions(),
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001717 Context.getPreferredType()->isAnyPointerType());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001718 } else if (C->Type) {
1719 CanQualType Expected
Douglas Gregor5535d572010-08-16 21:23:13 +00001720 = S.Context.getCanonicalType(
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001721 Context.getPreferredType().getUnqualifiedType());
1722 SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
1723 if (ExpectedSTC == C->TypeClass) {
1724 // We know this type is similar; check for an exact match.
1725 llvm::StringMap<unsigned> &CachedCompletionTypes
Douglas Gregor5535d572010-08-16 21:23:13 +00001726 = AST.getCachedCompletionTypes();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001727 llvm::StringMap<unsigned>::iterator Pos
Douglas Gregor5535d572010-08-16 21:23:13 +00001728 = CachedCompletionTypes.find(QualType(Expected).getAsString());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001729 if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
1730 Priority /= CCF_ExactTypeMatch;
1731 else
1732 Priority /= CCF_SimilarTypeMatch;
1733 }
1734 }
1735 }
1736
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001737 // Adjust the completion string, if required.
1738 if (C->Kind == CXCursor_MacroDefinition &&
1739 Context.getKind() == CodeCompletionContext::CCC_MacroNameUse) {
1740 // Create a new code-completion string that just contains the
1741 // macro name, without its arguments.
1742 Completion = new CodeCompletionString;
1743 Completion->AddTypedTextChunk(C->Completion->getTypedText());
1744 StringsToDestroy.push_back(Completion);
Douglas Gregor4125c372010-08-25 18:03:13 +00001745 CursorKind = CXCursor_NotImplemented;
1746 Priority = CCP_CodePattern;
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001747 }
1748
Douglas Gregor4125c372010-08-25 18:03:13 +00001749 AllResults.push_back(Result(Completion, Priority, CursorKind,
Douglas Gregor58ddb602010-08-23 23:00:57 +00001750 C->Availability));
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001751 }
1752
1753 // If we did not add any cached completion results, just forward the
1754 // results we were given to the next consumer.
1755 if (!AddedResult) {
1756 Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
1757 return;
1758 }
Douglas Gregor1e5e6682010-08-26 13:48:20 +00001759
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001760 Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
1761 AllResults.size());
Douglas Gregor1fbb4472010-08-24 20:21:13 +00001762
1763 for (unsigned I = 0, N = StringsToDestroy.size(); I != N; ++I)
1764 delete StringsToDestroy[I];
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001765}
1766
1767
1768
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001769void ASTUnit::CodeComplete(llvm::StringRef File, unsigned Line, unsigned Column,
1770 RemappedFile *RemappedFiles,
1771 unsigned NumRemappedFiles,
Douglas Gregorcee235c2010-08-05 09:09:23 +00001772 bool IncludeMacros,
1773 bool IncludeCodePatterns,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001774 CodeCompleteConsumer &Consumer,
1775 Diagnostic &Diag, LangOptions &LangOpts,
1776 SourceManager &SourceMgr, FileManager &FileMgr,
Douglas Gregor2283d792010-08-20 00:59:43 +00001777 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
1778 llvm::SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001779 if (!Invocation.get())
1780 return;
1781
Douglas Gregor213f18b2010-10-28 15:44:59 +00001782 SimpleTimer CompletionTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001783 CompletionTimer.setOutput("Code completion @ " + File + ":" +
1784 llvm::Twine(Line) + ":" + llvm::Twine(Column));
Douglas Gregordf95a132010-08-09 20:45:32 +00001785
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001786 CompilerInvocation CCInvocation(*Invocation);
1787 FrontendOptions &FrontendOpts = CCInvocation.getFrontendOpts();
1788 PreprocessorOptions &PreprocessorOpts = CCInvocation.getPreprocessorOpts();
Douglas Gregorcee235c2010-08-05 09:09:23 +00001789
Douglas Gregor87c08a52010-08-13 22:48:40 +00001790 FrontendOpts.ShowMacrosInCodeCompletion
1791 = IncludeMacros && CachedCompletionResults.empty();
Douglas Gregorcee235c2010-08-05 09:09:23 +00001792 FrontendOpts.ShowCodePatternsInCodeCompletion = IncludeCodePatterns;
Douglas Gregor8071e422010-08-15 06:18:01 +00001793 FrontendOpts.ShowGlobalSymbolsInCodeCompletion
1794 = CachedCompletionResults.empty();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001795 FrontendOpts.CodeCompletionAt.FileName = File;
1796 FrontendOpts.CodeCompletionAt.Line = Line;
1797 FrontendOpts.CodeCompletionAt.Column = Column;
1798
1799 // Set the language options appropriately.
1800 LangOpts = CCInvocation.getLangOpts();
1801
1802 CompilerInstance Clang;
1803 Clang.setInvocation(&CCInvocation);
1804 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
1805
1806 // Set up diagnostics, capturing any diagnostics produced.
1807 Clang.setDiagnostics(&Diag);
Douglas Gregor32be4a52010-10-11 21:37:58 +00001808 ProcessWarningOptions(Diag, CCInvocation.getDiagnosticOpts());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001809 CaptureDroppedDiagnostics Capture(true,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001810 Clang.getDiagnostics(),
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001811 StoredDiagnostics);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001812
1813 // Create the target instance.
1814 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
1815 Clang.getTargetOpts()));
1816 if (!Clang.hasTarget()) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001817 Clang.takeInvocation();
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001818 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001819 }
1820
1821 // Inform the target of the language options.
1822 //
1823 // FIXME: We shouldn't need to do this, the target should be immutable once
1824 // created. This complexity should be lifted elsewhere.
1825 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
1826
1827 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
1828 "Invocation must have exactly one source file!");
1829 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
1830 "FIXME: AST inputs not yet supported here!");
1831 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
1832 "IR inputs not support here!");
1833
1834
1835 // Use the source and file managers that we were given.
1836 Clang.setFileManager(&FileMgr);
1837 Clang.setSourceManager(&SourceMgr);
1838
1839 // Remap files.
1840 PreprocessorOpts.clearRemappedFiles();
Douglas Gregorb75d3df2010-08-04 17:07:00 +00001841 PreprocessorOpts.RetainRemappedFileBuffers = true;
Douglas Gregor2283d792010-08-20 00:59:43 +00001842 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001843 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first,
1844 RemappedFiles[I].second);
Douglas Gregor2283d792010-08-20 00:59:43 +00001845 OwnedBuffers.push_back(RemappedFiles[I].second);
1846 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001847
Douglas Gregor87c08a52010-08-13 22:48:40 +00001848 // Use the code completion consumer we were given, but adding any cached
1849 // code-completion results.
1850 AugmentedCodeCompleteConsumer
1851 AugmentedConsumer(*this, Consumer, FrontendOpts.ShowMacrosInCodeCompletion,
Douglas Gregor8071e422010-08-15 06:18:01 +00001852 FrontendOpts.ShowCodePatternsInCodeCompletion,
1853 FrontendOpts.ShowGlobalSymbolsInCodeCompletion);
Douglas Gregor87c08a52010-08-13 22:48:40 +00001854 Clang.setCodeCompletionConsumer(&AugmentedConsumer);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001855
Douglas Gregordf95a132010-08-09 20:45:32 +00001856 // If we have a precompiled preamble, try to use it. We only allow
1857 // the use of the precompiled preamble if we're if the completion
1858 // point is within the main file, after the end of the precompiled
1859 // preamble.
1860 llvm::MemoryBuffer *OverrideMainBuffer = 0;
1861 if (!PreambleFile.empty()) {
1862 using llvm::sys::FileStatus;
1863 llvm::sys::PathWithStatus CompleteFilePath(File);
1864 llvm::sys::PathWithStatus MainPath(OriginalSourceFile);
1865 if (const FileStatus *CompleteFileStatus = CompleteFilePath.getFileStatus())
1866 if (const FileStatus *MainStatus = MainPath.getFileStatus())
1867 if (CompleteFileStatus->getUniqueID() == MainStatus->getUniqueID())
Douglas Gregor2283d792010-08-20 00:59:43 +00001868 OverrideMainBuffer
Douglas Gregorc9c29a82010-08-25 18:04:15 +00001869 = getMainBufferWithPrecompiledPreamble(CCInvocation, false,
1870 Line - 1);
Douglas Gregordf95a132010-08-09 20:45:32 +00001871 }
1872
1873 // If the main file has been overridden due to the use of a preamble,
1874 // make that override happen and introduce the preamble.
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001875 StoredDiagnostics.insert(StoredDiagnostics.end(),
1876 this->StoredDiagnostics.begin(),
1877 this->StoredDiagnostics.begin() + NumStoredDiagnosticsFromDriver);
Douglas Gregordf95a132010-08-09 20:45:32 +00001878 if (OverrideMainBuffer) {
1879 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
1880 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
1881 PreprocessorOpts.PrecompiledPreambleBytes.second
1882 = PreambleEndsAtStartOfLine;
1883 PreprocessorOpts.ImplicitPCHInclude = PreambleFile;
1884 PreprocessorOpts.DisablePCHValidation = true;
1885
1886 // The stored diagnostics have the old source manager. Copy them
1887 // to our output set of stored diagnostics, updating the source
1888 // manager to the one we were given.
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001889 for (unsigned I = NumStoredDiagnosticsFromDriver,
1890 N = this->StoredDiagnostics.size();
1891 I < N; ++I) {
Douglas Gregordf95a132010-08-09 20:45:32 +00001892 StoredDiagnostics.push_back(this->StoredDiagnostics[I]);
1893 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(), SourceMgr);
1894 StoredDiagnostics[I].setLocation(Loc);
1895 }
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001896
Douglas Gregor2283d792010-08-20 00:59:43 +00001897 OwnedBuffers.push_back(OverrideMainBuffer);
Douglas Gregorf128fed2010-08-20 00:02:33 +00001898 } else {
1899 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
1900 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregordf95a132010-08-09 20:45:32 +00001901 }
1902
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001903 llvm::OwningPtr<SyntaxOnlyAction> Act;
1904 Act.reset(new SyntaxOnlyAction);
1905 if (Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
1906 Clang.getFrontendOpts().Inputs[0].first)) {
1907 Act->Execute();
1908 Act->EndSourceFile();
1909 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001910
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001911 // Steal back our resources.
1912 Clang.takeFileManager();
1913 Clang.takeSourceManager();
1914 Clang.takeInvocation();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001915 Clang.takeCodeCompletionConsumer();
1916}
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001917
1918bool ASTUnit::Save(llvm::StringRef File) {
1919 if (getDiagnostics().hasErrorOccurred())
1920 return true;
1921
1922 // FIXME: Can we somehow regenerate the stat cache here, or do we need to
1923 // unconditionally create a stat cache when we parse the file?
1924 std::string ErrorInfo;
Benjamin Kramer1395c5d2010-08-15 16:54:31 +00001925 llvm::raw_fd_ostream Out(File.str().c_str(), ErrorInfo,
1926 llvm::raw_fd_ostream::F_Binary);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001927 if (!ErrorInfo.empty() || Out.has_error())
1928 return true;
1929
1930 std::vector<unsigned char> Buffer;
1931 llvm::BitstreamWriter Stream(Buffer);
Sebastian Redla4232eb2010-08-18 23:56:21 +00001932 ASTWriter Writer(Stream);
1933 Writer.WriteAST(getSema(), 0, 0);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001934
1935 // Write the generated bitstream to "Out".
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001936 if (!Buffer.empty())
1937 Out.write((char *)&Buffer.front(), Buffer.size());
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001938 Out.close();
1939 return Out.has_error();
1940}