blob: 9aa9f5b6ccab19d7b728bda6fff68901b9cd58de [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"
Sebastian Redl6ab7cd82010-08-18 23:57:17 +000028#include "clang/Serialization/ASTReader.h"
Sebastian Redl7faa2ec2010-08-18 23:56:37 +000029#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000030#include "clang/Lex/HeaderSearch.h"
31#include "clang/Lex/Preprocessor.h"
Daniel Dunbard58c03f2009-11-15 06:48:46 +000032#include "clang/Basic/TargetOptions.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000033#include "clang/Basic/TargetInfo.h"
34#include "clang/Basic/Diagnostic.h"
Douglas Gregor349d38c2010-08-16 23:08:34 +000035#include "llvm/ADT/StringSet.h"
Douglas Gregor4db64a42010-01-23 00:14:00 +000036#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbar7b556682009-12-02 03:23:45 +000037#include "llvm/System/Host.h"
Benjamin Kramer4a630d32009-10-18 11:34:14 +000038#include "llvm/System/Path.h"
Douglas Gregordf95a132010-08-09 20:45:32 +000039#include "llvm/Support/raw_ostream.h"
Douglas Gregor385103b2010-07-30 20:58:08 +000040#include "llvm/Support/Timer.h"
Douglas Gregor44c181a2010-07-23 00:33:23 +000041#include <cstdlib>
Zhongxing Xuad23ebe2010-07-23 02:15:08 +000042#include <cstdio>
Douglas Gregorcc5888d2010-07-31 00:40:00 +000043#include <sys/stat.h>
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000044using namespace clang;
45
Douglas Gregoreababfb2010-08-04 05:53:38 +000046/// \brief After failing to build a precompiled preamble (due to
47/// errors in the source that occurs in the preamble), the number of
48/// reparses during which we'll skip even trying to precompile the
49/// preamble.
50const unsigned DefaultPreambleRebuildInterval = 5;
51
Douglas Gregor3687e9d2010-04-05 21:10:19 +000052ASTUnit::ASTUnit(bool _MainFileIsAST)
Douglas Gregorabc563f2010-07-19 21:46:24 +000053 : CaptureDiagnostics(false), MainFileIsAST(_MainFileIsAST),
Douglas Gregordf95a132010-08-09 20:45:32 +000054 CompleteTranslationUnit(true), ConcurrencyCheckValue(CheckUnlocked),
Douglas Gregor671947b2010-08-19 01:33:06 +000055 PreambleRebuildCounter(0), SavedMainFileBuffer(0), PreambleBuffer(0),
Douglas Gregor727d93e2010-08-17 00:40:40 +000056 ShouldCacheCodeCompletionResults(false),
57 NumTopLevelDeclsAtLastCompletionCache(0),
Douglas Gregor8b1540c2010-08-19 00:45:44 +000058 CacheCodeCompletionCoolDown(0),
59 UnsafeToFree(false) {
Douglas Gregor385103b2010-07-30 20:58:08 +000060}
Douglas Gregor3687e9d2010-04-05 21:10:19 +000061
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000062ASTUnit::~ASTUnit() {
Douglas Gregorbdf60622010-03-05 21:16:25 +000063 ConcurrencyCheckValue = CheckLocked;
Douglas Gregorabc563f2010-07-19 21:46:24 +000064 CleanTemporaryFiles();
Douglas Gregor175c4a92010-07-23 23:58:40 +000065 if (!PreambleFile.empty())
Douglas Gregor385103b2010-07-30 20:58:08 +000066 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +000067
68 // Free the buffers associated with remapped files. We are required to
69 // perform this operation here because we explicitly request that the
70 // compiler instance *not* free these buffers for each invocation of the
71 // parser.
72 if (Invocation.get()) {
73 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
74 for (PreprocessorOptions::remapped_file_buffer_iterator
75 FB = PPOpts.remapped_file_buffer_begin(),
76 FBEnd = PPOpts.remapped_file_buffer_end();
77 FB != FBEnd;
78 ++FB)
79 delete FB->second;
80 }
Douglas Gregor28233422010-07-27 14:52:07 +000081
82 delete SavedMainFileBuffer;
Douglas Gregor671947b2010-08-19 01:33:06 +000083 delete PreambleBuffer;
84
Douglas Gregor87c08a52010-08-13 22:48:40 +000085 ClearCachedCompletionResults();
86
Douglas Gregor385103b2010-07-30 20:58:08 +000087 for (unsigned I = 0, N = Timers.size(); I != N; ++I)
88 delete Timers[I];
Douglas Gregorabc563f2010-07-19 21:46:24 +000089}
90
91void ASTUnit::CleanTemporaryFiles() {
Douglas Gregor313e26c2010-02-18 23:35:40 +000092 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
93 TemporaryFiles[I].eraseFromDisk();
Douglas Gregorabc563f2010-07-19 21:46:24 +000094 TemporaryFiles.clear();
Steve Naroffe19944c2009-10-15 22:23:48 +000095}
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000096
Douglas Gregor8071e422010-08-15 06:18:01 +000097/// \brief Determine the set of code-completion contexts in which this
98/// declaration should be shown.
99static unsigned getDeclShowContexts(NamedDecl *ND,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000100 const LangOptions &LangOpts,
101 bool &IsNestedNameSpecifier) {
102 IsNestedNameSpecifier = false;
103
Douglas Gregor8071e422010-08-15 06:18:01 +0000104 if (isa<UsingShadowDecl>(ND))
105 ND = dyn_cast<NamedDecl>(ND->getUnderlyingDecl());
106 if (!ND)
107 return 0;
108
109 unsigned Contexts = 0;
110 if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
111 isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND)) {
112 // Types can appear in these contexts.
113 if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
114 Contexts |= (1 << (CodeCompletionContext::CCC_TopLevel - 1))
115 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
116 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
117 | (1 << (CodeCompletionContext::CCC_Statement - 1))
118 | (1 << (CodeCompletionContext::CCC_Type - 1));
119
120 // In C++, types can appear in expressions contexts (for functional casts).
121 if (LangOpts.CPlusPlus)
122 Contexts |= (1 << (CodeCompletionContext::CCC_Expression - 1));
123
124 // In Objective-C, message sends can send interfaces. In Objective-C++,
125 // all types are available due to functional casts.
126 if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
127 Contexts |= (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1));
128
129 // Deal with tag names.
130 if (isa<EnumDecl>(ND)) {
131 Contexts |= (1 << (CodeCompletionContext::CCC_EnumTag - 1));
132
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000133 // Part of the nested-name-specifier in C++0x.
Douglas Gregor8071e422010-08-15 06:18:01 +0000134 if (LangOpts.CPlusPlus0x)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000135 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000136 } else if (RecordDecl *Record = dyn_cast<RecordDecl>(ND)) {
137 if (Record->isUnion())
138 Contexts |= (1 << (CodeCompletionContext::CCC_UnionTag - 1));
139 else
140 Contexts |= (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1));
141
Douglas Gregor8071e422010-08-15 06:18:01 +0000142 if (LangOpts.CPlusPlus)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000143 IsNestedNameSpecifier = true;
144 } else if (isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND))
145 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000146 } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
147 // Values can appear in these contexts.
148 Contexts = (1 << (CodeCompletionContext::CCC_Statement - 1))
149 | (1 << (CodeCompletionContext::CCC_Expression - 1))
150 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1));
151 } else if (isa<ObjCProtocolDecl>(ND)) {
152 Contexts = (1 << (CodeCompletionContext::CCC_ObjCProtocolName - 1));
153 } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000154 Contexts = (1 << (CodeCompletionContext::CCC_Namespace - 1));
Douglas Gregor8071e422010-08-15 06:18:01 +0000155
156 // Part of the nested-name-specifier.
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000157 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000158 }
159
160 return Contexts;
161}
162
Douglas Gregor87c08a52010-08-13 22:48:40 +0000163void ASTUnit::CacheCodeCompletionResults() {
164 if (!TheSema)
165 return;
166
167 llvm::Timer *CachingTimer = 0;
168 if (TimerGroup.get()) {
169 CachingTimer = new llvm::Timer("Cache global code completions",
170 *TimerGroup);
171 CachingTimer->startTimer();
172 Timers.push_back(CachingTimer);
173 }
174
175 // Clear out the previous results.
176 ClearCachedCompletionResults();
177
178 // Gather the set of global code completions.
179 typedef CodeCompleteConsumer::Result Result;
180 llvm::SmallVector<Result, 8> Results;
181 TheSema->GatherGlobalCodeCompletions(Results);
182
183 // Translate global code completions into cached completions.
Douglas Gregorf5586f62010-08-16 18:08:11 +0000184 llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
185
Douglas Gregor87c08a52010-08-13 22:48:40 +0000186 for (unsigned I = 0, N = Results.size(); I != N; ++I) {
187 switch (Results[I].Kind) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000188 case Result::RK_Declaration: {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000189 bool IsNestedNameSpecifier = false;
Douglas Gregor8071e422010-08-15 06:18:01 +0000190 CachedCodeCompletionResult CachedResult;
191 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
192 CachedResult.ShowInContexts = getDeclShowContexts(Results[I].Declaration,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000193 Ctx->getLangOptions(),
194 IsNestedNameSpecifier);
Douglas Gregor8071e422010-08-15 06:18:01 +0000195 CachedResult.Priority = Results[I].Priority;
196 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000197
Douglas Gregorf5586f62010-08-16 18:08:11 +0000198 // Keep track of the type of this completion in an ASTContext-agnostic
199 // way.
Douglas Gregorc4421e92010-08-16 16:46:30 +0000200 QualType UsageType = getDeclUsageType(*Ctx, Results[I].Declaration);
Douglas Gregorf5586f62010-08-16 18:08:11 +0000201 if (UsageType.isNull()) {
Douglas Gregorc4421e92010-08-16 16:46:30 +0000202 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000203 CachedResult.Type = 0;
204 } else {
205 CanQualType CanUsageType
206 = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
207 CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
208
209 // Determine whether we have already seen this type. If so, we save
210 // ourselves the work of formatting the type string by using the
211 // temporary, CanQualType-based hash table to find the associated value.
212 unsigned &TypeValue = CompletionTypes[CanUsageType];
213 if (TypeValue == 0) {
214 TypeValue = CompletionTypes.size();
215 CachedCompletionTypes[QualType(CanUsageType).getAsString()]
216 = TypeValue;
217 }
218
219 CachedResult.Type = TypeValue;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000220 }
Douglas Gregorf5586f62010-08-16 18:08:11 +0000221
Douglas Gregor8071e422010-08-15 06:18:01 +0000222 CachedCompletionResults.push_back(CachedResult);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000223
224 /// Handle nested-name-specifiers in C++.
225 if (TheSema->Context.getLangOptions().CPlusPlus &&
226 IsNestedNameSpecifier && !Results[I].StartsNestedNameSpecifier) {
227 // The contexts in which a nested-name-specifier can appear in C++.
228 unsigned NNSContexts
229 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
230 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
231 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
232 | (1 << (CodeCompletionContext::CCC_Statement - 1))
233 | (1 << (CodeCompletionContext::CCC_Expression - 1))
234 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1))
235 | (1 << (CodeCompletionContext::CCC_EnumTag - 1))
236 | (1 << (CodeCompletionContext::CCC_UnionTag - 1))
237 | (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1))
238 | (1 << (CodeCompletionContext::CCC_Type - 1));
239
240 if (isa<NamespaceDecl>(Results[I].Declaration) ||
241 isa<NamespaceAliasDecl>(Results[I].Declaration))
242 NNSContexts |= (1 << (CodeCompletionContext::CCC_Namespace - 1));
243
244 if (unsigned RemainingContexts
245 = NNSContexts & ~CachedResult.ShowInContexts) {
246 // If there any contexts where this completion can be a
247 // nested-name-specifier but isn't already an option, create a
248 // nested-name-specifier completion.
249 Results[I].StartsNestedNameSpecifier = true;
250 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
251 CachedResult.ShowInContexts = RemainingContexts;
252 CachedResult.Priority = CCP_NestedNameSpecifier;
253 CachedResult.TypeClass = STC_Void;
254 CachedResult.Type = 0;
255 CachedCompletionResults.push_back(CachedResult);
256 }
257 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000258 break;
Douglas Gregor8071e422010-08-15 06:18:01 +0000259 }
260
Douglas Gregor87c08a52010-08-13 22:48:40 +0000261 case Result::RK_Keyword:
262 case Result::RK_Pattern:
263 // Ignore keywords and patterns; we don't care, since they are so
264 // easily regenerated.
265 break;
266
267 case Result::RK_Macro: {
268 CachedCodeCompletionResult CachedResult;
269 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema);
270 CachedResult.ShowInContexts
271 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
272 | (1 << (CodeCompletionContext::CCC_ObjCInterface - 1))
273 | (1 << (CodeCompletionContext::CCC_ObjCImplementation - 1))
274 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
275 | (1 << (CodeCompletionContext::CCC_ClassStructUnion - 1))
276 | (1 << (CodeCompletionContext::CCC_Statement - 1))
277 | (1 << (CodeCompletionContext::CCC_Expression - 1))
278 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1));
279 CachedResult.Priority = Results[I].Priority;
280 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor1827e102010-08-16 16:18:59 +0000281 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000282 CachedResult.Type = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000283 CachedCompletionResults.push_back(CachedResult);
284 break;
285 }
286 }
287 Results[I].Destroy();
288 }
289
290 if (CachingTimer)
291 CachingTimer->stopTimer();
Douglas Gregor727d93e2010-08-17 00:40:40 +0000292
293 // Make a note of the state when we performed this caching.
294 NumTopLevelDeclsAtLastCompletionCache = top_level_size();
295 CacheCodeCompletionCoolDown = 15;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000296}
297
298void ASTUnit::ClearCachedCompletionResults() {
299 for (unsigned I = 0, N = CachedCompletionResults.size(); I != N; ++I)
300 delete CachedCompletionResults[I].Completion;
301 CachedCompletionResults.clear();
Douglas Gregorf5586f62010-08-16 18:08:11 +0000302 CachedCompletionTypes.clear();
Douglas Gregor87c08a52010-08-13 22:48:40 +0000303}
304
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000305namespace {
306
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000307/// \brief Gathers information from ASTReader that will be used to initialize
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000308/// a Preprocessor.
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000309class ASTInfoCollector : public ASTReaderListener {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000310 LangOptions &LangOpt;
311 HeaderSearch &HSI;
312 std::string &TargetTriple;
313 std::string &Predefines;
314 unsigned &Counter;
Mike Stump1eb44332009-09-09 15:08:12 +0000315
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000316 unsigned NumHeaderInfos;
Mike Stump1eb44332009-09-09 15:08:12 +0000317
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000318public:
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000319 ASTInfoCollector(LangOptions &LangOpt, HeaderSearch &HSI,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000320 std::string &TargetTriple, std::string &Predefines,
321 unsigned &Counter)
322 : LangOpt(LangOpt), HSI(HSI), TargetTriple(TargetTriple),
323 Predefines(Predefines), Counter(Counter), NumHeaderInfos(0) {}
Mike Stump1eb44332009-09-09 15:08:12 +0000324
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000325 virtual bool ReadLanguageOptions(const LangOptions &LangOpts) {
326 LangOpt = LangOpts;
327 return false;
328 }
Mike Stump1eb44332009-09-09 15:08:12 +0000329
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000330 virtual bool ReadTargetTriple(llvm::StringRef Triple) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000331 TargetTriple = Triple;
332 return false;
333 }
Mike Stump1eb44332009-09-09 15:08:12 +0000334
Sebastian Redlcb481aa2010-07-14 23:29:55 +0000335 virtual bool ReadPredefinesBuffer(const PCHPredefinesBlocks &Buffers,
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000336 llvm::StringRef OriginalFileName,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000337 std::string &SuggestedPredefines) {
Sebastian Redlcb481aa2010-07-14 23:29:55 +0000338 Predefines = Buffers[0].Data;
339 for (unsigned I = 1, N = Buffers.size(); I != N; ++I) {
340 Predefines += Buffers[I].Data;
341 }
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000342 return false;
343 }
Mike Stump1eb44332009-09-09 15:08:12 +0000344
Douglas Gregorec1afbf2010-03-16 19:09:18 +0000345 virtual void ReadHeaderFileInfo(const HeaderFileInfo &HFI, unsigned ID) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000346 HSI.setHeaderFileInfoForUID(HFI, NumHeaderInfos++);
347 }
Mike Stump1eb44332009-09-09 15:08:12 +0000348
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000349 virtual void ReadCounter(unsigned Value) {
350 Counter = Value;
351 }
352};
353
Douglas Gregora88084b2010-02-18 18:08:43 +0000354class StoredDiagnosticClient : public DiagnosticClient {
355 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags;
356
357public:
358 explicit StoredDiagnosticClient(
359 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags)
360 : StoredDiags(StoredDiags) { }
361
362 virtual void HandleDiagnostic(Diagnostic::Level Level,
363 const DiagnosticInfo &Info);
364};
365
366/// \brief RAII object that optionally captures diagnostics, if
367/// there is no diagnostic client to capture them already.
368class CaptureDroppedDiagnostics {
369 Diagnostic &Diags;
370 StoredDiagnosticClient Client;
371 DiagnosticClient *PreviousClient;
372
373public:
374 CaptureDroppedDiagnostics(bool RequestCapture, Diagnostic &Diags,
375 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000376 : Diags(Diags), Client(StoredDiags), PreviousClient(0)
Douglas Gregora88084b2010-02-18 18:08:43 +0000377 {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000378 if (RequestCapture || Diags.getClient() == 0) {
379 PreviousClient = Diags.takeClient();
Douglas Gregora88084b2010-02-18 18:08:43 +0000380 Diags.setClient(&Client);
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000381 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000382 }
383
384 ~CaptureDroppedDiagnostics() {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000385 if (Diags.getClient() == &Client) {
386 Diags.takeClient();
387 Diags.setClient(PreviousClient);
388 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000389 }
390};
391
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000392} // anonymous namespace
393
Douglas Gregora88084b2010-02-18 18:08:43 +0000394void StoredDiagnosticClient::HandleDiagnostic(Diagnostic::Level Level,
395 const DiagnosticInfo &Info) {
396 StoredDiags.push_back(StoredDiagnostic(Level, Info));
397}
398
Steve Naroff77accc12009-09-03 18:19:54 +0000399const std::string &ASTUnit::getOriginalSourceFileName() {
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000400 return OriginalSourceFile;
Steve Naroff77accc12009-09-03 18:19:54 +0000401}
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000402
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000403const std::string &ASTUnit::getASTFileName() {
404 assert(isMainFileAST() && "Not an ASTUnit from an AST file!");
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000405 return static_cast<ASTReader *>(Ctx->getExternalSource())->getFileName();
Steve Naroffe19944c2009-10-15 22:23:48 +0000406}
407
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000408ASTUnit *ASTUnit::LoadFromASTFile(const std::string &Filename,
Douglas Gregor28019772010-04-05 23:52:57 +0000409 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
Ted Kremenek5cf48762009-10-17 00:34:24 +0000410 bool OnlyLocalDecls,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000411 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +0000412 unsigned NumRemappedFiles,
413 bool CaptureDiagnostics) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000414 llvm::OwningPtr<ASTUnit> AST(new ASTUnit(true));
415
Douglas Gregor28019772010-04-05 23:52:57 +0000416 if (!Diags.getPtr()) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000417 // No diagnostics engine was provided, so create our own diagnostics object
418 // with the default options.
419 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +0000420 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000421 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000422
423 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000424 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregor28019772010-04-05 23:52:57 +0000425 AST->Diagnostics = Diags;
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000426 AST->FileMgr.reset(new FileManager);
427 AST->SourceMgr.reset(new SourceManager(AST->getDiagnostics()));
Steve Naroff36c44642009-10-19 14:34:22 +0000428 AST->HeaderInfo.reset(new HeaderSearch(AST->getFileManager()));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000429
Douglas Gregora88084b2010-02-18 18:08:43 +0000430 // If requested, capture diagnostics in the ASTUnit.
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000431 CaptureDroppedDiagnostics Capture(CaptureDiagnostics, AST->getDiagnostics(),
Douglas Gregor405634b2010-04-05 18:10:21 +0000432 AST->StoredDiagnostics);
Douglas Gregora88084b2010-02-18 18:08:43 +0000433
Douglas Gregor4db64a42010-01-23 00:14:00 +0000434 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
435 // Create the file entry for the file that we're mapping from.
436 const FileEntry *FromFile
437 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
438 RemappedFiles[I].second->getBufferSize(),
439 0);
440 if (!FromFile) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000441 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
Douglas Gregor4db64a42010-01-23 00:14:00 +0000442 << RemappedFiles[I].first;
Douglas Gregorc8dfe5e2010-02-27 01:32:48 +0000443 delete RemappedFiles[I].second;
Douglas Gregor4db64a42010-01-23 00:14:00 +0000444 continue;
445 }
446
447 // Override the contents of the "from" file with the contents of
448 // the "to" file.
449 AST->getSourceManager().overrideFileContents(FromFile,
450 RemappedFiles[I].second);
451 }
452
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000453 // Gather Info for preprocessor construction later on.
Mike Stump1eb44332009-09-09 15:08:12 +0000454
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000455 LangOptions LangInfo;
456 HeaderSearch &HeaderInfo = *AST->HeaderInfo.get();
457 std::string TargetTriple;
458 std::string Predefines;
459 unsigned Counter;
460
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000461 llvm::OwningPtr<ASTReader> Reader;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000462
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000463 Reader.reset(new ASTReader(AST->getSourceManager(), AST->getFileManager(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000464 AST->getDiagnostics()));
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000465 Reader->setListener(new ASTInfoCollector(LangInfo, HeaderInfo, TargetTriple,
Daniel Dunbarcc318932009-09-03 05:59:35 +0000466 Predefines, Counter));
467
Sebastian Redl571db7f2010-08-18 23:56:56 +0000468 switch (Reader->ReadAST(Filename)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000469 case ASTReader::Success:
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000470 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000471
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000472 case ASTReader::Failure:
473 case ASTReader::IgnorePCH:
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000474 AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000475 return NULL;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000476 }
Mike Stump1eb44332009-09-09 15:08:12 +0000477
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000478 AST->OriginalSourceFile = Reader->getOriginalSourceFile();
479
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000480 // AST file loaded successfully. Now create the preprocessor.
Mike Stump1eb44332009-09-09 15:08:12 +0000481
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000482 // Get information about the target being compiled for.
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000483 //
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000484 // FIXME: This is broken, we should store the TargetOptions in the AST file.
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000485 TargetOptions TargetOpts;
486 TargetOpts.ABI = "";
John McCall875ab102010-08-22 06:43:33 +0000487 TargetOpts.CXXABI = "";
Daniel Dunbard58c03f2009-11-15 06:48:46 +0000488 TargetOpts.CPU = "";
489 TargetOpts.Features.clear();
490 TargetOpts.Triple = TargetTriple;
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000491 AST->Target.reset(TargetInfo::CreateTargetInfo(AST->getDiagnostics(),
492 TargetOpts));
493 AST->PP.reset(new Preprocessor(AST->getDiagnostics(), LangInfo,
494 *AST->Target.get(),
Daniel Dunbar31b87d82009-09-21 03:03:39 +0000495 AST->getSourceManager(), HeaderInfo));
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000496 Preprocessor &PP = *AST->PP.get();
497
Daniel Dunbard5b61262009-09-21 03:03:47 +0000498 PP.setPredefines(Reader->getSuggestedPredefines());
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000499 PP.setCounterValue(Counter);
Daniel Dunbarcc318932009-09-03 05:59:35 +0000500 Reader->setPreprocessor(PP);
Mike Stump1eb44332009-09-09 15:08:12 +0000501
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000502 // Create and initialize the ASTContext.
503
504 AST->Ctx.reset(new ASTContext(LangInfo,
Daniel Dunbar31b87d82009-09-21 03:03:39 +0000505 AST->getSourceManager(),
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000506 *AST->Target.get(),
507 PP.getIdentifierTable(),
508 PP.getSelectorTable(),
509 PP.getBuiltinInfo(),
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000510 /* size_reserve = */0));
511 ASTContext &Context = *AST->Ctx.get();
Mike Stump1eb44332009-09-09 15:08:12 +0000512
Daniel Dunbarcc318932009-09-03 05:59:35 +0000513 Reader->InitializeContext(Context);
Mike Stump1eb44332009-09-09 15:08:12 +0000514
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000515 // Attach the AST reader to the AST context as an external AST
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000516 // source, so that declarations will be deserialized from the
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000517 // AST file as needed.
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000518 ASTReader *ReaderPtr = Reader.get();
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000519 llvm::OwningPtr<ExternalASTSource> Source(Reader.take());
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000520 Context.setExternalSource(Source);
521
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000522 // Create an AST consumer, even though it isn't used.
523 AST->Consumer.reset(new ASTConsumer);
524
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000525 // Create a semantic analysis object and tell the AST reader about it.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000526 AST->TheSema.reset(new Sema(PP, Context, *AST->Consumer));
527 AST->TheSema->Initialize();
528 ReaderPtr->InitializeSema(*AST->TheSema);
529
Mike Stump1eb44332009-09-09 15:08:12 +0000530 return AST.take();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000531}
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000532
533namespace {
534
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000535class TopLevelDeclTrackerConsumer : public ASTConsumer {
536 ASTUnit &Unit;
537
538public:
539 TopLevelDeclTrackerConsumer(ASTUnit &_Unit) : Unit(_Unit) {}
540
541 void HandleTopLevelDecl(DeclGroupRef D) {
Ted Kremenekda5a4282010-05-03 20:16:35 +0000542 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
543 Decl *D = *it;
544 // FIXME: Currently ObjC method declarations are incorrectly being
545 // reported as top-level declarations, even though their DeclContext
546 // is the containing ObjC @interface/@implementation. This is a
547 // fundamental problem in the parser right now.
548 if (isa<ObjCMethodDecl>(D))
549 continue;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000550 Unit.addTopLevelDecl(D);
Ted Kremenekda5a4282010-05-03 20:16:35 +0000551 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000552 }
Sebastian Redl27372b42010-08-11 18:52:41 +0000553
554 // We're not interested in "interesting" decls.
555 void HandleInterestingDecl(DeclGroupRef) {}
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000556};
557
558class TopLevelDeclTrackerAction : public ASTFrontendAction {
559public:
560 ASTUnit &Unit;
561
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000562 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
563 llvm::StringRef InFile) {
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000564 return new TopLevelDeclTrackerConsumer(Unit);
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000565 }
566
567public:
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000568 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
569
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000570 virtual bool hasCodeCompletionSupport() const { return false; }
Douglas Gregordf95a132010-08-09 20:45:32 +0000571 virtual bool usesCompleteTranslationUnit() {
572 return Unit.isCompleteTranslationUnit();
573 }
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000574};
575
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000576class PrecompilePreambleConsumer : public PCHGenerator {
577 ASTUnit &Unit;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000578 std::vector<Decl *> TopLevelDecls;
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000579
580public:
581 PrecompilePreambleConsumer(ASTUnit &Unit,
582 const Preprocessor &PP, bool Chaining,
583 const char *isysroot, llvm::raw_ostream *Out)
584 : PCHGenerator(PP, Chaining, isysroot, Out), Unit(Unit) { }
585
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000586 virtual void HandleTopLevelDecl(DeclGroupRef D) {
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000587 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
588 Decl *D = *it;
589 // FIXME: Currently ObjC method declarations are incorrectly being
590 // reported as top-level declarations, even though their DeclContext
591 // is the containing ObjC @interface/@implementation. This is a
592 // fundamental problem in the parser right now.
593 if (isa<ObjCMethodDecl>(D))
594 continue;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000595 TopLevelDecls.push_back(D);
596 }
597 }
598
599 virtual void HandleTranslationUnit(ASTContext &Ctx) {
600 PCHGenerator::HandleTranslationUnit(Ctx);
601 if (!Unit.getDiagnostics().hasErrorOccurred()) {
602 // Translate the top-level declarations we captured during
603 // parsing into declaration IDs in the precompiled
604 // preamble. This will allow us to deserialize those top-level
605 // declarations when requested.
606 for (unsigned I = 0, N = TopLevelDecls.size(); I != N; ++I)
607 Unit.addTopLevelDeclFromPreamble(
608 getWriter().getDeclID(TopLevelDecls[I]));
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000609 }
610 }
611};
612
613class PrecompilePreambleAction : public ASTFrontendAction {
614 ASTUnit &Unit;
615
616public:
617 explicit PrecompilePreambleAction(ASTUnit &Unit) : Unit(Unit) {}
618
619 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
620 llvm::StringRef InFile) {
621 std::string Sysroot;
622 llvm::raw_ostream *OS = 0;
623 bool Chaining;
624 if (GeneratePCHAction::ComputeASTConsumerArguments(CI, InFile, Sysroot,
625 OS, Chaining))
626 return 0;
627
628 const char *isysroot = CI.getFrontendOpts().RelocatablePCH ?
629 Sysroot.c_str() : 0;
630 return new PrecompilePreambleConsumer(Unit, CI.getPreprocessor(), Chaining,
631 isysroot, OS);
632 }
633
634 virtual bool hasCodeCompletionSupport() const { return false; }
635 virtual bool hasASTFileSupport() const { return false; }
Douglas Gregordf95a132010-08-09 20:45:32 +0000636 virtual bool usesCompleteTranslationUnit() { return false; }
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000637};
638
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000639}
640
Douglas Gregorabc563f2010-07-19 21:46:24 +0000641/// Parse the source file into a translation unit using the given compiler
642/// invocation, replacing the current translation unit.
643///
644/// \returns True if a failure occurred that causes the ASTUnit not to
645/// contain any translation-unit information, false otherwise.
Douglas Gregor754f3492010-07-24 00:38:13 +0000646bool ASTUnit::Parse(llvm::MemoryBuffer *OverrideMainBuffer) {
Douglas Gregor28233422010-07-27 14:52:07 +0000647 delete SavedMainFileBuffer;
648 SavedMainFileBuffer = 0;
649
Douglas Gregor671947b2010-08-19 01:33:06 +0000650 if (!Invocation.get()) {
651 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000652 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +0000653 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000654
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000655 // Create the compiler instance to use for building the AST.
Daniel Dunbarcb6dda12009-12-02 08:43:56 +0000656 CompilerInstance Clang;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000657 Clang.setInvocation(Invocation.take());
658 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
659
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000660 // Set up diagnostics, capturing any diagnostics that would
661 // otherwise be dropped.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000662 Clang.setDiagnostics(&getDiagnostics());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000663 CaptureDroppedDiagnostics Capture(CaptureDiagnostics,
664 getDiagnostics(),
665 StoredDiagnostics);
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000666
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000667 // Create the target instance.
668 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
669 Clang.getTargetOpts()));
Douglas Gregor671947b2010-08-19 01:33:06 +0000670 if (!Clang.hasTarget()) {
671 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000672 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +0000673 }
674
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000675 // Inform the target of the language options.
676 //
677 // FIXME: We shouldn't need to do this, the target should be immutable once
678 // created. This complexity should be lifted elsewhere.
679 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000680
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000681 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
682 "Invocation must have exactly one source file!");
Daniel Dunbarc34ce3f2010-06-07 23:22:09 +0000683 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000684 "FIXME: AST inputs not yet supported here!");
Daniel Dunbarfaddc3e2010-06-07 23:26:47 +0000685 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
686 "IR inputs not support here!");
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000687
Douglas Gregorabc563f2010-07-19 21:46:24 +0000688 // Configure the various subsystems.
689 // FIXME: Should we retain the previous file manager?
690 FileMgr.reset(new FileManager);
691 SourceMgr.reset(new SourceManager(getDiagnostics()));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000692 TheSema.reset();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000693 Ctx.reset();
694 PP.reset();
695
696 // Clear out old caches and data.
697 TopLevelDecls.clear();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000698 CleanTemporaryFiles();
699 PreprocessedEntitiesByFile.clear();
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000700
Douglas Gregorf128fed2010-08-20 00:02:33 +0000701 if (!OverrideMainBuffer) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000702 StoredDiagnostics.clear();
Douglas Gregorf128fed2010-08-20 00:02:33 +0000703 TopLevelDeclsInPreamble.clear();
704 }
705
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000706 // Create a file manager object to provide access to and cache the filesystem.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000707 Clang.setFileManager(&getFileManager());
708
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000709 // Create the source manager.
Douglas Gregorabc563f2010-07-19 21:46:24 +0000710 Clang.setSourceManager(&getSourceManager());
711
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000712 // If the main file has been overridden due to the use of a preamble,
713 // make that override happen and introduce the preamble.
714 PreprocessorOptions &PreprocessorOpts = Clang.getPreprocessorOpts();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000715 std::string PriorImplicitPCHInclude;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000716 if (OverrideMainBuffer) {
717 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
718 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
719 PreprocessorOpts.PrecompiledPreambleBytes.second
720 = PreambleEndsAtStartOfLine;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000721 PriorImplicitPCHInclude = PreprocessorOpts.ImplicitPCHInclude;
Douglas Gregor385103b2010-07-30 20:58:08 +0000722 PreprocessorOpts.ImplicitPCHInclude = PreambleFile;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000723 PreprocessorOpts.DisablePCHValidation = true;
Douglas Gregor28233422010-07-27 14:52:07 +0000724
725 // Keep track of the override buffer;
726 SavedMainFileBuffer = OverrideMainBuffer;
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000727
728 // The stored diagnostic has the old source manager in it; update
729 // the locations to refer into the new source manager. Since we've
730 // been careful to make sure that the source manager's state
731 // before and after are identical, so that we can reuse the source
732 // location itself.
733 for (unsigned I = 0, N = StoredDiagnostics.size(); I != N; ++I) {
734 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(),
735 getSourceManager());
736 StoredDiagnostics[I].setLocation(Loc);
737 }
Douglas Gregorf128fed2010-08-20 00:02:33 +0000738 } else {
739 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
740 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000741 }
742
Douglas Gregorabc563f2010-07-19 21:46:24 +0000743 llvm::OwningPtr<TopLevelDeclTrackerAction> Act;
744 Act.reset(new TopLevelDeclTrackerAction(*this));
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000745 if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
Daniel Dunbard3598a62010-06-07 23:23:06 +0000746 Clang.getFrontendOpts().Inputs[0].first))
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000747 goto error;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000748
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000749 Act->Execute();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000750
Daniel Dunbar64a32ba2009-12-01 21:57:33 +0000751 // Steal the created target, context, and preprocessor, and take back the
752 // source and file managers.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000753 TheSema.reset(Clang.takeSema());
754 Consumer.reset(Clang.takeASTConsumer());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000755 Ctx.reset(Clang.takeASTContext());
756 PP.reset(Clang.takePreprocessor());
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000757 Clang.takeSourceManager();
758 Clang.takeFileManager();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000759 Target.reset(Clang.takeTarget());
760
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000761 Act->EndSourceFile();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000762
763 // Remove the overridden buffer we used for the preamble.
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000764 if (OverrideMainBuffer) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000765 PreprocessorOpts.eraseRemappedFile(
766 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000767 PreprocessorOpts.ImplicitPCHInclude = PriorImplicitPCHInclude;
768 }
769
Douglas Gregorabc563f2010-07-19 21:46:24 +0000770 Invocation.reset(Clang.takeInvocation());
Douglas Gregor87c08a52010-08-13 22:48:40 +0000771
772 // If we were asked to cache code-completion results and don't have any
773 // results yet, do so now.
774 if (ShouldCacheCodeCompletionResults && CachedCompletionResults.empty())
775 CacheCodeCompletionResults();
776
Douglas Gregorabc563f2010-07-19 21:46:24 +0000777 return false;
778
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000779error:
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000780 // Remove the overridden buffer we used for the preamble.
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000781 if (OverrideMainBuffer) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000782 PreprocessorOpts.eraseRemappedFile(
783 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000784 PreprocessorOpts.DisablePCHValidation = true;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000785 PreprocessorOpts.ImplicitPCHInclude = PriorImplicitPCHInclude;
Douglas Gregor671947b2010-08-19 01:33:06 +0000786 delete OverrideMainBuffer;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +0000787 }
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000788
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000789 Clang.takeSourceManager();
790 Clang.takeFileManager();
Douglas Gregorabc563f2010-07-19 21:46:24 +0000791 Invocation.reset(Clang.takeInvocation());
792 return true;
793}
794
Douglas Gregor44c181a2010-07-23 00:33:23 +0000795/// \brief Simple function to retrieve a path for a preamble precompiled header.
796static std::string GetPreamblePCHPath() {
797 // FIXME: This is lame; sys::Path should provide this function (in particular,
798 // it should know how to find the temporary files dir).
799 // FIXME: This is really lame. I copied this code from the Driver!
800 std::string Error;
801 const char *TmpDir = ::getenv("TMPDIR");
802 if (!TmpDir)
803 TmpDir = ::getenv("TEMP");
804 if (!TmpDir)
805 TmpDir = ::getenv("TMP");
806 if (!TmpDir)
807 TmpDir = "/tmp";
808 llvm::sys::Path P(TmpDir);
809 P.appendComponent("preamble");
Douglas Gregor6bf18302010-08-11 13:06:56 +0000810 P.appendSuffix("pch");
Douglas Gregor44c181a2010-07-23 00:33:23 +0000811 if (P.createTemporaryFileOnDisk())
812 return std::string();
813
Douglas Gregor44c181a2010-07-23 00:33:23 +0000814 return P.str();
815}
816
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000817/// \brief Compute the preamble for the main file, providing the source buffer
818/// that corresponds to the main file along with a pair (bytes, start-of-line)
819/// that describes the preamble.
820std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
Douglas Gregordf95a132010-08-09 20:45:32 +0000821ASTUnit::ComputePreamble(CompilerInvocation &Invocation,
822 unsigned MaxLines, bool &CreatedBuffer) {
Douglas Gregor175c4a92010-07-23 23:58:40 +0000823 FrontendOptions &FrontendOpts = Invocation.getFrontendOpts();
Douglas Gregor44c181a2010-07-23 00:33:23 +0000824 PreprocessorOptions &PreprocessorOpts
Douglas Gregor175c4a92010-07-23 23:58:40 +0000825 = Invocation.getPreprocessorOpts();
826 CreatedBuffer = false;
827
Douglas Gregor44c181a2010-07-23 00:33:23 +0000828 // Try to determine if the main file has been remapped, either from the
829 // command line (to another file) or directly through the compiler invocation
830 // (to a memory buffer).
Douglas Gregor175c4a92010-07-23 23:58:40 +0000831 llvm::MemoryBuffer *Buffer = 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000832 llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].second);
833 if (const llvm::sys::FileStatus *MainFileStatus = MainFilePath.getFileStatus()) {
834 // Check whether there is a file-file remapping of the main file
835 for (PreprocessorOptions::remapped_file_iterator
Douglas Gregor175c4a92010-07-23 23:58:40 +0000836 M = PreprocessorOpts.remapped_file_begin(),
837 E = PreprocessorOpts.remapped_file_end();
Douglas Gregor44c181a2010-07-23 00:33:23 +0000838 M != E;
839 ++M) {
840 llvm::sys::PathWithStatus MPath(M->first);
841 if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) {
842 if (MainFileStatus->uniqueID == MStatus->uniqueID) {
843 // We found a remapping. Try to load the resulting, remapped source.
Douglas Gregor175c4a92010-07-23 23:58:40 +0000844 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +0000845 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +0000846 CreatedBuffer = false;
847 }
848
Douglas Gregor44c181a2010-07-23 00:33:23 +0000849 Buffer = llvm::MemoryBuffer::getFile(M->second);
850 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000851 return std::make_pair((llvm::MemoryBuffer*)0,
852 std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000853 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000854
Douglas Gregor175c4a92010-07-23 23:58:40 +0000855 // Remove this remapping. We've captured the buffer already.
Douglas Gregor44c181a2010-07-23 00:33:23 +0000856 M = PreprocessorOpts.eraseRemappedFile(M);
857 E = PreprocessorOpts.remapped_file_end();
Daniel Dunbarc1cf1582010-08-19 19:40:40 +0000858 if (M == E)
859 break;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000860 }
861 }
862 }
863
864 // Check whether there is a file-buffer remapping. It supercedes the
865 // file-file remapping.
866 for (PreprocessorOptions::remapped_file_buffer_iterator
867 M = PreprocessorOpts.remapped_file_buffer_begin(),
868 E = PreprocessorOpts.remapped_file_buffer_end();
869 M != E;
870 ++M) {
871 llvm::sys::PathWithStatus MPath(M->first);
872 if (const llvm::sys::FileStatus *MStatus = MPath.getFileStatus()) {
873 if (MainFileStatus->uniqueID == MStatus->uniqueID) {
874 // We found a remapping.
Douglas Gregor175c4a92010-07-23 23:58:40 +0000875 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +0000876 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +0000877 CreatedBuffer = false;
878 }
Douglas Gregor44c181a2010-07-23 00:33:23 +0000879
Douglas Gregor175c4a92010-07-23 23:58:40 +0000880 Buffer = const_cast<llvm::MemoryBuffer *>(M->second);
881
882 // Remove this remapping. We've captured the buffer already.
Douglas Gregor44c181a2010-07-23 00:33:23 +0000883 M = PreprocessorOpts.eraseRemappedFile(M);
884 E = PreprocessorOpts.remapped_file_buffer_end();
Daniel Dunbarc1cf1582010-08-19 19:40:40 +0000885 if (M == E)
886 break;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000887 }
888 }
Douglas Gregor175c4a92010-07-23 23:58:40 +0000889 }
Douglas Gregor44c181a2010-07-23 00:33:23 +0000890 }
891
892 // If the main source file was not remapped, load it now.
893 if (!Buffer) {
894 Buffer = llvm::MemoryBuffer::getFile(FrontendOpts.Inputs[0].second);
895 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000896 return std::make_pair((llvm::MemoryBuffer*)0, std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000897
898 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +0000899 }
900
Douglas Gregordf95a132010-08-09 20:45:32 +0000901 return std::make_pair(Buffer, Lexer::ComputePreamble(Buffer, MaxLines));
Douglas Gregor175c4a92010-07-23 23:58:40 +0000902}
903
Douglas Gregor754f3492010-07-24 00:38:13 +0000904static llvm::MemoryBuffer *CreatePaddedMainFileBuffer(llvm::MemoryBuffer *Old,
905 bool DeleteOld,
906 unsigned NewSize,
907 llvm::StringRef NewName) {
908 llvm::MemoryBuffer *Result
909 = llvm::MemoryBuffer::getNewUninitMemBuffer(NewSize, NewName);
910 memcpy(const_cast<char*>(Result->getBufferStart()),
911 Old->getBufferStart(), Old->getBufferSize());
912 memset(const_cast<char*>(Result->getBufferStart()) + Old->getBufferSize(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000913 ' ', NewSize - Old->getBufferSize() - 1);
914 const_cast<char*>(Result->getBufferEnd())[-1] = '\n';
Douglas Gregor754f3492010-07-24 00:38:13 +0000915
916 if (DeleteOld)
917 delete Old;
918
919 return Result;
920}
921
Douglas Gregor175c4a92010-07-23 23:58:40 +0000922/// \brief Attempt to build or re-use a precompiled preamble when (re-)parsing
923/// the source file.
924///
925/// This routine will compute the preamble of the main source file. If a
926/// non-trivial preamble is found, it will precompile that preamble into a
927/// precompiled header so that the precompiled preamble can be used to reduce
928/// reparsing time. If a precompiled preamble has already been constructed,
929/// this routine will determine if it is still valid and, if so, avoid
930/// rebuilding the precompiled preamble.
931///
Douglas Gregordf95a132010-08-09 20:45:32 +0000932/// \param AllowRebuild When true (the default), this routine is
933/// allowed to rebuild the precompiled preamble if it is found to be
934/// out-of-date.
935///
936/// \param MaxLines When non-zero, the maximum number of lines that
937/// can occur within the preamble.
938///
Douglas Gregor754f3492010-07-24 00:38:13 +0000939/// \returns If the precompiled preamble can be used, returns a newly-allocated
940/// buffer that should be used in place of the main file when doing so.
941/// Otherwise, returns a NULL pointer.
Douglas Gregordf95a132010-08-09 20:45:32 +0000942llvm::MemoryBuffer *ASTUnit::getMainBufferWithPrecompiledPreamble(
Douglas Gregor2283d792010-08-20 00:59:43 +0000943 CompilerInvocation PreambleInvocation,
Douglas Gregordf95a132010-08-09 20:45:32 +0000944 bool AllowRebuild,
945 unsigned MaxLines) {
Douglas Gregor175c4a92010-07-23 23:58:40 +0000946 FrontendOptions &FrontendOpts = PreambleInvocation.getFrontendOpts();
947 PreprocessorOptions &PreprocessorOpts
948 = PreambleInvocation.getPreprocessorOpts();
949
950 bool CreatedPreambleBuffer = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000951 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > NewPreamble
Douglas Gregordf95a132010-08-09 20:45:32 +0000952 = ComputePreamble(PreambleInvocation, MaxLines, CreatedPreambleBuffer);
Douglas Gregor175c4a92010-07-23 23:58:40 +0000953
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000954 if (!NewPreamble.second.first) {
Douglas Gregor175c4a92010-07-23 23:58:40 +0000955 // We couldn't find a preamble in the main source. Clear out the current
956 // preamble, if we have one. It's obviously no good any more.
957 Preamble.clear();
958 if (!PreambleFile.empty()) {
Douglas Gregor385103b2010-07-30 20:58:08 +0000959 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregor175c4a92010-07-23 23:58:40 +0000960 PreambleFile.clear();
961 }
962 if (CreatedPreambleBuffer)
963 delete NewPreamble.first;
Douglas Gregoreababfb2010-08-04 05:53:38 +0000964
965 // The next time we actually see a preamble, precompile it.
966 PreambleRebuildCounter = 1;
Douglas Gregor754f3492010-07-24 00:38:13 +0000967 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +0000968 }
969
970 if (!Preamble.empty()) {
971 // We've previously computed a preamble. Check whether we have the same
972 // preamble now that we did before, and that there's enough space in
973 // the main-file buffer within the precompiled preamble to fit the
974 // new main file.
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000975 if (Preamble.size() == NewPreamble.second.first &&
976 PreambleEndsAtStartOfLine == NewPreamble.second.second &&
Douglas Gregor592508e2010-07-24 00:42:07 +0000977 NewPreamble.first->getBufferSize() < PreambleReservedSize-2 &&
Douglas Gregor175c4a92010-07-23 23:58:40 +0000978 memcmp(&Preamble[0], NewPreamble.first->getBufferStart(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000979 NewPreamble.second.first) == 0) {
Douglas Gregor175c4a92010-07-23 23:58:40 +0000980 // The preamble has not changed. We may be able to re-use the precompiled
981 // preamble.
Douglas Gregorc0659ec2010-08-02 20:51:39 +0000982
Douglas Gregorcc5888d2010-07-31 00:40:00 +0000983 // Check that none of the files used by the preamble have changed.
984 bool AnyFileChanged = false;
985
986 // First, make a record of those files that have been overridden via
987 // remapping or unsaved_files.
988 llvm::StringMap<std::pair<off_t, time_t> > OverriddenFiles;
989 for (PreprocessorOptions::remapped_file_iterator
990 R = PreprocessorOpts.remapped_file_begin(),
991 REnd = PreprocessorOpts.remapped_file_end();
992 !AnyFileChanged && R != REnd;
993 ++R) {
994 struct stat StatBuf;
995 if (stat(R->second.c_str(), &StatBuf)) {
996 // If we can't stat the file we're remapping to, assume that something
997 // horrible happened.
998 AnyFileChanged = true;
999 break;
1000 }
Douglas Gregor754f3492010-07-24 00:38:13 +00001001
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001002 OverriddenFiles[R->first] = std::make_pair(StatBuf.st_size,
1003 StatBuf.st_mtime);
1004 }
1005 for (PreprocessorOptions::remapped_file_buffer_iterator
1006 R = PreprocessorOpts.remapped_file_buffer_begin(),
1007 REnd = PreprocessorOpts.remapped_file_buffer_end();
1008 !AnyFileChanged && R != REnd;
1009 ++R) {
1010 // FIXME: Should we actually compare the contents of file->buffer
1011 // remappings?
1012 OverriddenFiles[R->first] = std::make_pair(R->second->getBufferSize(),
1013 0);
1014 }
1015
1016 // Check whether anything has changed.
1017 for (llvm::StringMap<std::pair<off_t, time_t> >::iterator
1018 F = FilesInPreamble.begin(), FEnd = FilesInPreamble.end();
1019 !AnyFileChanged && F != FEnd;
1020 ++F) {
1021 llvm::StringMap<std::pair<off_t, time_t> >::iterator Overridden
1022 = OverriddenFiles.find(F->first());
1023 if (Overridden != OverriddenFiles.end()) {
1024 // This file was remapped; check whether the newly-mapped file
1025 // matches up with the previous mapping.
1026 if (Overridden->second != F->second)
1027 AnyFileChanged = true;
1028 continue;
1029 }
1030
1031 // The file was not remapped; check whether it has changed on disk.
1032 struct stat StatBuf;
1033 if (stat(F->first(), &StatBuf)) {
1034 // If we can't stat the file, assume that something horrible happened.
1035 AnyFileChanged = true;
1036 } else if (StatBuf.st_size != F->second.first ||
1037 StatBuf.st_mtime != F->second.second)
1038 AnyFileChanged = true;
1039 }
1040
1041 if (!AnyFileChanged) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001042 // Okay! We can re-use the precompiled preamble.
1043
1044 // Set the state of the diagnostic object to mimic its state
1045 // after parsing the preamble.
1046 getDiagnostics().Reset();
1047 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1048 if (StoredDiagnostics.size() > NumStoredDiagnosticsInPreamble)
1049 StoredDiagnostics.erase(
1050 StoredDiagnostics.begin() + NumStoredDiagnosticsInPreamble,
1051 StoredDiagnostics.end());
1052
1053 // Create a version of the main file buffer that is padded to
1054 // buffer size we reserved when creating the preamble.
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001055 return CreatePaddedMainFileBuffer(NewPreamble.first,
1056 CreatedPreambleBuffer,
1057 PreambleReservedSize,
1058 FrontendOpts.Inputs[0].second);
1059 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001060 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001061
1062 // If we aren't allowed to rebuild the precompiled preamble, just
1063 // return now.
1064 if (!AllowRebuild)
1065 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001066
1067 // We can't reuse the previously-computed preamble. Build a new one.
1068 Preamble.clear();
Douglas Gregor385103b2010-07-30 20:58:08 +00001069 llvm::sys::Path(PreambleFile).eraseFromDisk();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001070 PreambleRebuildCounter = 1;
Douglas Gregordf95a132010-08-09 20:45:32 +00001071 } else if (!AllowRebuild) {
1072 // We aren't allowed to rebuild the precompiled preamble; just
1073 // return now.
1074 return 0;
1075 }
Douglas Gregoreababfb2010-08-04 05:53:38 +00001076
1077 // If the preamble rebuild counter > 1, it's because we previously
1078 // failed to build a preamble and we're not yet ready to try
1079 // again. Decrement the counter and return a failure.
1080 if (PreambleRebuildCounter > 1) {
1081 --PreambleRebuildCounter;
1082 return 0;
1083 }
1084
Douglas Gregor175c4a92010-07-23 23:58:40 +00001085 // We did not previously compute a preamble, or it can't be reused anyway.
Douglas Gregor385103b2010-07-30 20:58:08 +00001086 llvm::Timer *PreambleTimer = 0;
1087 if (TimerGroup.get()) {
1088 PreambleTimer = new llvm::Timer("Precompiling preamble", *TimerGroup);
1089 PreambleTimer->startTimer();
1090 Timers.push_back(PreambleTimer);
1091 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001092
1093 // Create a new buffer that stores the preamble. The buffer also contains
1094 // extra space for the original contents of the file (which will be present
1095 // when we actually parse the file) along with more room in case the file
Douglas Gregor175c4a92010-07-23 23:58:40 +00001096 // grows.
1097 PreambleReservedSize = NewPreamble.first->getBufferSize();
1098 if (PreambleReservedSize < 4096)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001099 PreambleReservedSize = 8191;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001100 else
Douglas Gregor175c4a92010-07-23 23:58:40 +00001101 PreambleReservedSize *= 2;
1102
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001103 // Save the preamble text for later; we'll need to compare against it for
1104 // subsequent reparses.
1105 Preamble.assign(NewPreamble.first->getBufferStart(),
1106 NewPreamble.first->getBufferStart()
1107 + NewPreamble.second.first);
1108 PreambleEndsAtStartOfLine = NewPreamble.second.second;
1109
Douglas Gregor671947b2010-08-19 01:33:06 +00001110 delete PreambleBuffer;
1111 PreambleBuffer
Douglas Gregor175c4a92010-07-23 23:58:40 +00001112 = llvm::MemoryBuffer::getNewUninitMemBuffer(PreambleReservedSize,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001113 FrontendOpts.Inputs[0].second);
1114 memcpy(const_cast<char*>(PreambleBuffer->getBufferStart()),
Douglas Gregor175c4a92010-07-23 23:58:40 +00001115 NewPreamble.first->getBufferStart(), Preamble.size());
1116 memset(const_cast<char*>(PreambleBuffer->getBufferStart()) + Preamble.size(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001117 ' ', PreambleReservedSize - Preamble.size() - 1);
1118 const_cast<char*>(PreambleBuffer->getBufferEnd())[-1] = '\n';
Douglas Gregor44c181a2010-07-23 00:33:23 +00001119
1120 // Remap the main source file to the preamble buffer.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001121 llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001122 PreprocessorOpts.addRemappedFile(MainFilePath.str(), PreambleBuffer);
1123
1124 // Tell the compiler invocation to generate a temporary precompiled header.
1125 FrontendOpts.ProgramAction = frontend::GeneratePCH;
Sebastian Redlf65339e2010-08-06 00:35:11 +00001126 // FIXME: Set ChainedPCH unconditionally, once it is ready.
1127 if (::getenv("LIBCLANG_CHAINING"))
1128 FrontendOpts.ChainedPCH = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001129 // FIXME: Generate the precompiled header into memory?
Douglas Gregor385103b2010-07-30 20:58:08 +00001130 FrontendOpts.OutputFile = GetPreamblePCHPath();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001131
1132 // Create the compiler instance to use for building the precompiled preamble.
1133 CompilerInstance Clang;
1134 Clang.setInvocation(&PreambleInvocation);
1135 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
1136
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001137 // Set up diagnostics, capturing all of the diagnostics produced.
Douglas Gregor44c181a2010-07-23 00:33:23 +00001138 Clang.setDiagnostics(&getDiagnostics());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001139 CaptureDroppedDiagnostics Capture(CaptureDiagnostics,
1140 getDiagnostics(),
1141 StoredDiagnostics);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001142
1143 // Create the target instance.
1144 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
1145 Clang.getTargetOpts()));
1146 if (!Clang.hasTarget()) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001147 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1148 Preamble.clear();
1149 if (CreatedPreambleBuffer)
1150 delete NewPreamble.first;
Douglas Gregor385103b2010-07-30 20:58:08 +00001151 if (PreambleTimer)
1152 PreambleTimer->stopTimer();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001153 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001154 PreprocessorOpts.eraseRemappedFile(
1155 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001156 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001157 }
1158
1159 // Inform the target of the language options.
1160 //
1161 // FIXME: We shouldn't need to do this, the target should be immutable once
1162 // created. This complexity should be lifted elsewhere.
1163 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
1164
1165 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
1166 "Invocation must have exactly one source file!");
1167 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
1168 "FIXME: AST inputs not yet supported here!");
1169 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
1170 "IR inputs not support here!");
1171
1172 // Clear out old caches and data.
1173 StoredDiagnostics.clear();
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001174 TopLevelDecls.clear();
1175 TopLevelDeclsInPreamble.clear();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001176
1177 // Create a file manager object to provide access to and cache the filesystem.
1178 Clang.setFileManager(new FileManager);
1179
1180 // Create the source manager.
1181 Clang.setSourceManager(new SourceManager(getDiagnostics()));
1182
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001183 llvm::OwningPtr<PrecompilePreambleAction> Act;
1184 Act.reset(new PrecompilePreambleAction(*this));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001185 if (!Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
1186 Clang.getFrontendOpts().Inputs[0].first)) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001187 Clang.takeInvocation();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001188 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1189 Preamble.clear();
1190 if (CreatedPreambleBuffer)
1191 delete NewPreamble.first;
Douglas Gregor385103b2010-07-30 20:58:08 +00001192 if (PreambleTimer)
1193 PreambleTimer->stopTimer();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001194 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001195 PreprocessorOpts.eraseRemappedFile(
1196 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001197 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001198 }
1199
1200 Act->Execute();
1201 Act->EndSourceFile();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001202 Clang.takeInvocation();
1203
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001204 if (Diagnostics->hasErrorOccurred()) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001205 // There were errors parsing the preamble, so no precompiled header was
1206 // generated. Forget that we even tried.
1207 // FIXME: Should we leave a note for ourselves to try again?
1208 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1209 Preamble.clear();
1210 if (CreatedPreambleBuffer)
1211 delete NewPreamble.first;
Douglas Gregor385103b2010-07-30 20:58:08 +00001212 if (PreambleTimer)
1213 PreambleTimer->stopTimer();
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001214 TopLevelDeclsInPreamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001215 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001216 PreprocessorOpts.eraseRemappedFile(
1217 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001218 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001219 }
1220
1221 // Keep track of the preamble we precompiled.
1222 PreambleFile = FrontendOpts.OutputFile;
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001223 NumStoredDiagnosticsInPreamble = StoredDiagnostics.size();
1224 NumWarningsInPreamble = getDiagnostics().getNumWarnings();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001225
1226 // Keep track of all of the files that the source manager knows about,
1227 // so we can verify whether they have changed or not.
1228 FilesInPreamble.clear();
1229 SourceManager &SourceMgr = Clang.getSourceManager();
1230 const llvm::MemoryBuffer *MainFileBuffer
1231 = SourceMgr.getBuffer(SourceMgr.getMainFileID());
1232 for (SourceManager::fileinfo_iterator F = SourceMgr.fileinfo_begin(),
1233 FEnd = SourceMgr.fileinfo_end();
1234 F != FEnd;
1235 ++F) {
1236 const FileEntry *File = F->second->Entry;
1237 if (!File || F->second->getRawBuffer() == MainFileBuffer)
1238 continue;
1239
1240 FilesInPreamble[File->getName()]
1241 = std::make_pair(F->second->getSize(), File->getModificationTime());
1242 }
1243
Douglas Gregor385103b2010-07-30 20:58:08 +00001244 if (PreambleTimer)
1245 PreambleTimer->stopTimer();
1246
Douglas Gregoreababfb2010-08-04 05:53:38 +00001247 PreambleRebuildCounter = 1;
Douglas Gregor671947b2010-08-19 01:33:06 +00001248 PreprocessorOpts.eraseRemappedFile(
1249 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001250 return CreatePaddedMainFileBuffer(NewPreamble.first,
1251 CreatedPreambleBuffer,
1252 PreambleReservedSize,
1253 FrontendOpts.Inputs[0].second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001254}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001255
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001256void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1257 std::vector<Decl *> Resolved;
1258 Resolved.reserve(TopLevelDeclsInPreamble.size());
1259 ExternalASTSource &Source = *getASTContext().getExternalSource();
1260 for (unsigned I = 0, N = TopLevelDeclsInPreamble.size(); I != N; ++I) {
1261 // Resolve the declaration ID to an actual declaration, possibly
1262 // deserializing the declaration in the process.
1263 Decl *D = Source.GetExternalDecl(TopLevelDeclsInPreamble[I]);
1264 if (D)
1265 Resolved.push_back(D);
1266 }
1267 TopLevelDeclsInPreamble.clear();
1268 TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1269}
1270
1271unsigned ASTUnit::getMaxPCHLevel() const {
1272 if (!getOnlyLocalDecls())
1273 return Decl::MaxPCHLevel;
1274
1275 unsigned Result = 0;
1276 if (isMainFileAST() || SavedMainFileBuffer)
1277 ++Result;
1278 return Result;
1279}
1280
Douglas Gregorabc563f2010-07-19 21:46:24 +00001281ASTUnit *ASTUnit::LoadFromCompilerInvocation(CompilerInvocation *CI,
1282 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
1283 bool OnlyLocalDecls,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001284 bool CaptureDiagnostics,
Douglas Gregordf95a132010-08-09 20:45:32 +00001285 bool PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001286 bool CompleteTranslationUnit,
1287 bool CacheCodeCompletionResults) {
Douglas Gregorabc563f2010-07-19 21:46:24 +00001288 if (!Diags.getPtr()) {
1289 // No diagnostics engine was provided, so create our own diagnostics object
1290 // with the default options.
1291 DiagnosticOptions DiagOpts;
1292 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
1293 }
1294
1295 // Create the AST unit.
1296 llvm::OwningPtr<ASTUnit> AST;
1297 AST.reset(new ASTUnit(false));
1298 AST->Diagnostics = Diags;
1299 AST->CaptureDiagnostics = CaptureDiagnostics;
1300 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregordf95a132010-08-09 20:45:32 +00001301 AST->CompleteTranslationUnit = CompleteTranslationUnit;
Douglas Gregor87c08a52010-08-13 22:48:40 +00001302 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001303 AST->Invocation.reset(CI);
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001304 CI->getPreprocessorOpts().RetainRemappedFileBuffers = true;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001305
Douglas Gregor385103b2010-07-30 20:58:08 +00001306 if (getenv("LIBCLANG_TIMING"))
1307 AST->TimerGroup.reset(
1308 new llvm::TimerGroup(CI->getFrontendOpts().Inputs[0].second));
1309
1310
Douglas Gregor754f3492010-07-24 00:38:13 +00001311 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregorfd0b8702010-07-28 22:12:37 +00001312 // FIXME: When C++ PCH is ready, allow use of it for a precompiled preamble.
Douglas Gregoreababfb2010-08-04 05:53:38 +00001313 if (PrecompilePreamble && !CI->getLangOpts().CPlusPlus) {
1314 AST->PreambleRebuildCounter = 1;
Douglas Gregor2283d792010-08-20 00:59:43 +00001315 OverrideMainBuffer
1316 = AST->getMainBufferWithPrecompiledPreamble(*AST->Invocation);
Douglas Gregoreababfb2010-08-04 05:53:38 +00001317 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001318
Douglas Gregor385103b2010-07-30 20:58:08 +00001319 llvm::Timer *ParsingTimer = 0;
1320 if (AST->TimerGroup.get()) {
1321 ParsingTimer = new llvm::Timer("Initial parse", *AST->TimerGroup);
1322 ParsingTimer->startTimer();
1323 AST->Timers.push_back(ParsingTimer);
1324 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001325
Douglas Gregor385103b2010-07-30 20:58:08 +00001326 bool Failed = AST->Parse(OverrideMainBuffer);
1327 if (ParsingTimer)
1328 ParsingTimer->stopTimer();
1329
1330 return Failed? 0 : AST.take();
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001331}
Daniel Dunbar7b556682009-12-02 03:23:45 +00001332
1333ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin,
1334 const char **ArgEnd,
Douglas Gregor28019772010-04-05 23:52:57 +00001335 llvm::IntrusiveRefCntPtr<Diagnostic> Diags,
Daniel Dunbar869824e2009-12-13 03:46:13 +00001336 llvm::StringRef ResourceFilesPath,
Daniel Dunbar7b556682009-12-02 03:23:45 +00001337 bool OnlyLocalDecls,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001338 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +00001339 unsigned NumRemappedFiles,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001340 bool CaptureDiagnostics,
Douglas Gregordf95a132010-08-09 20:45:32 +00001341 bool PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001342 bool CompleteTranslationUnit,
1343 bool CacheCodeCompletionResults) {
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001344 bool CreatedDiagnosticsObject = false;
1345
Douglas Gregor28019772010-04-05 23:52:57 +00001346 if (!Diags.getPtr()) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001347 // No diagnostics engine was provided, so create our own diagnostics object
1348 // with the default options.
1349 DiagnosticOptions DiagOpts;
Douglas Gregor28019772010-04-05 23:52:57 +00001350 Diags = CompilerInstance::createDiagnostics(DiagOpts, 0, 0);
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001351 CreatedDiagnosticsObject = true;
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001352 }
1353
Daniel Dunbar7b556682009-12-02 03:23:45 +00001354 llvm::SmallVector<const char *, 16> Args;
1355 Args.push_back("<clang>"); // FIXME: Remove dummy argument.
1356 Args.insert(Args.end(), ArgBegin, ArgEnd);
1357
1358 // FIXME: Find a cleaner way to force the driver into restricted modes. We
1359 // also want to force it to use clang.
1360 Args.push_back("-fsyntax-only");
1361
Daniel Dunbar869824e2009-12-13 03:46:13 +00001362 // FIXME: We shouldn't have to pass in the path info.
Daniel Dunbar0bbad512010-07-19 00:44:04 +00001363 driver::Driver TheDriver("clang", llvm::sys::getHostTriple(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001364 "a.out", false, false, *Diags);
Daniel Dunbar3bd54cc2010-01-25 00:44:02 +00001365
1366 // Don't check that inputs exist, they have been remapped.
1367 TheDriver.setCheckInputsExist(false);
1368
Daniel Dunbar7b556682009-12-02 03:23:45 +00001369 llvm::OwningPtr<driver::Compilation> C(
1370 TheDriver.BuildCompilation(Args.size(), Args.data()));
1371
1372 // We expect to get back exactly one command job, if we didn't something
1373 // failed.
1374 const driver::JobList &Jobs = C->getJobs();
1375 if (Jobs.size() != 1 || !isa<driver::Command>(Jobs.begin())) {
1376 llvm::SmallString<256> Msg;
1377 llvm::raw_svector_ostream OS(Msg);
1378 C->PrintJob(OS, C->getJobs(), "; ", true);
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001379 Diags->Report(diag::err_fe_expected_compiler_job) << OS.str();
Daniel Dunbar7b556682009-12-02 03:23:45 +00001380 return 0;
1381 }
1382
1383 const driver::Command *Cmd = cast<driver::Command>(*Jobs.begin());
1384 if (llvm::StringRef(Cmd->getCreator().getName()) != "clang") {
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001385 Diags->Report(diag::err_fe_expected_clang_command);
Daniel Dunbar7b556682009-12-02 03:23:45 +00001386 return 0;
1387 }
1388
1389 const driver::ArgStringList &CCArgs = Cmd->getArguments();
Daniel Dunbar807b0612010-01-30 21:47:16 +00001390 llvm::OwningPtr<CompilerInvocation> CI(new CompilerInvocation);
Dan Gohmancb421fa2010-04-19 16:39:44 +00001391 CompilerInvocation::CreateFromArgs(*CI,
1392 const_cast<const char **>(CCArgs.data()),
1393 const_cast<const char **>(CCArgs.data()) +
Douglas Gregor44c181a2010-07-23 00:33:23 +00001394 CCArgs.size(),
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001395 *Diags);
Daniel Dunbar1e69fe32009-12-13 03:45:58 +00001396
Douglas Gregor4db64a42010-01-23 00:14:00 +00001397 // Override any files that need remapping
1398 for (unsigned I = 0; I != NumRemappedFiles; ++I)
Daniel Dunbar807b0612010-01-30 21:47:16 +00001399 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
Daniel Dunbarb26d4832010-02-16 01:55:04 +00001400 RemappedFiles[I].second);
Douglas Gregor4db64a42010-01-23 00:14:00 +00001401
Daniel Dunbar8b9adfe2009-12-15 00:06:45 +00001402 // Override the resources path.
Daniel Dunbar807b0612010-01-30 21:47:16 +00001403 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
Daniel Dunbar7b556682009-12-02 03:23:45 +00001404
Douglas Gregorf4210892010-08-18 23:38:21 +00001405 CI->getFrontendOpts().DisableFree = false;
Douglas Gregora88084b2010-02-18 18:08:43 +00001406 return LoadFromCompilerInvocation(CI.take(), Diags, OnlyLocalDecls,
Douglas Gregordf95a132010-08-09 20:45:32 +00001407 CaptureDiagnostics, PrecompilePreamble,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001408 CompleteTranslationUnit,
1409 CacheCodeCompletionResults);
Daniel Dunbar7b556682009-12-02 03:23:45 +00001410}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001411
1412bool ASTUnit::Reparse(RemappedFile *RemappedFiles, unsigned NumRemappedFiles) {
1413 if (!Invocation.get())
1414 return true;
1415
Douglas Gregor385103b2010-07-30 20:58:08 +00001416 llvm::Timer *ReparsingTimer = 0;
1417 if (TimerGroup.get()) {
1418 ReparsingTimer = new llvm::Timer("Reparse", *TimerGroup);
1419 ReparsingTimer->startTimer();
1420 Timers.push_back(ReparsingTimer);
1421 }
1422
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001423 // Remap files.
Douglas Gregorf128fed2010-08-20 00:02:33 +00001424 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1425 for (PreprocessorOptions::remapped_file_buffer_iterator
1426 R = PPOpts.remapped_file_buffer_begin(),
1427 REnd = PPOpts.remapped_file_buffer_end();
1428 R != REnd;
1429 ++R) {
1430 delete R->second;
1431 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001432 Invocation->getPreprocessorOpts().clearRemappedFiles();
1433 for (unsigned I = 0; I != NumRemappedFiles; ++I)
1434 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
1435 RemappedFiles[I].second);
1436
Douglas Gregoreababfb2010-08-04 05:53:38 +00001437 // If we have a preamble file lying around, or if we might try to
1438 // build a precompiled preamble, do so now.
Douglas Gregor754f3492010-07-24 00:38:13 +00001439 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregoreababfb2010-08-04 05:53:38 +00001440 if (!PreambleFile.empty() || PreambleRebuildCounter > 0)
Douglas Gregor2283d792010-08-20 00:59:43 +00001441 OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(*Invocation);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001442
Douglas Gregorabc563f2010-07-19 21:46:24 +00001443 // Clear out the diagnostics state.
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001444 if (!OverrideMainBuffer)
1445 getDiagnostics().Reset();
Douglas Gregorabc563f2010-07-19 21:46:24 +00001446
Douglas Gregor175c4a92010-07-23 23:58:40 +00001447 // Parse the sources
Douglas Gregor754f3492010-07-24 00:38:13 +00001448 bool Result = Parse(OverrideMainBuffer);
Douglas Gregor385103b2010-07-30 20:58:08 +00001449 if (ReparsingTimer)
1450 ReparsingTimer->stopTimer();
Douglas Gregor727d93e2010-08-17 00:40:40 +00001451
1452 if (ShouldCacheCodeCompletionResults) {
1453 if (CacheCodeCompletionCoolDown > 0)
1454 --CacheCodeCompletionCoolDown;
1455 else if (top_level_size() != NumTopLevelDeclsAtLastCompletionCache)
1456 CacheCodeCompletionResults();
1457 }
1458
Douglas Gregor175c4a92010-07-23 23:58:40 +00001459 return Result;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001460}
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001461
Douglas Gregor87c08a52010-08-13 22:48:40 +00001462//----------------------------------------------------------------------------//
1463// Code completion
1464//----------------------------------------------------------------------------//
1465
1466namespace {
1467 /// \brief Code completion consumer that combines the cached code-completion
1468 /// results from an ASTUnit with the code-completion results provided to it,
1469 /// then passes the result on to
1470 class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
1471 unsigned NormalContexts;
1472 ASTUnit &AST;
1473 CodeCompleteConsumer &Next;
1474
1475 public:
1476 AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
Douglas Gregor8071e422010-08-15 06:18:01 +00001477 bool IncludeMacros, bool IncludeCodePatterns,
1478 bool IncludeGlobals)
1479 : CodeCompleteConsumer(IncludeMacros, IncludeCodePatterns, IncludeGlobals,
Douglas Gregor87c08a52010-08-13 22:48:40 +00001480 Next.isOutputBinary()), AST(AST), Next(Next)
1481 {
1482 // Compute the set of contexts in which we will look when we don't have
1483 // any information about the specific context.
1484 NormalContexts
1485 = (1 << (CodeCompletionContext::CCC_TopLevel - 1))
1486 | (1 << (CodeCompletionContext::CCC_ObjCInterface - 1))
1487 | (1 << (CodeCompletionContext::CCC_ObjCImplementation - 1))
1488 | (1 << (CodeCompletionContext::CCC_ObjCIvarList - 1))
1489 | (1 << (CodeCompletionContext::CCC_Statement - 1))
1490 | (1 << (CodeCompletionContext::CCC_Expression - 1))
1491 | (1 << (CodeCompletionContext::CCC_ObjCMessageReceiver - 1))
1492 | (1 << (CodeCompletionContext::CCC_MemberAccess - 1))
1493 | (1 << (CodeCompletionContext::CCC_ObjCProtocolName - 1));
1494
1495 if (AST.getASTContext().getLangOptions().CPlusPlus)
1496 NormalContexts |= (1 << (CodeCompletionContext::CCC_EnumTag - 1))
1497 | (1 << (CodeCompletionContext::CCC_UnionTag - 1))
1498 | (1 << (CodeCompletionContext::CCC_ClassOrStructTag - 1));
1499 }
1500
1501 virtual void ProcessCodeCompleteResults(Sema &S,
1502 CodeCompletionContext Context,
1503 Result *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001504 unsigned NumResults);
Douglas Gregor87c08a52010-08-13 22:48:40 +00001505
1506 virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1507 OverloadCandidate *Candidates,
1508 unsigned NumCandidates) {
1509 Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates);
1510 }
1511 };
1512}
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001513
Douglas Gregor5f808c22010-08-16 21:18:39 +00001514/// \brief Helper function that computes which global names are hidden by the
1515/// local code-completion results.
1516void CalculateHiddenNames(const CodeCompletionContext &Context,
1517 CodeCompleteConsumer::Result *Results,
1518 unsigned NumResults,
1519 ASTContext &Ctx,
1520 llvm::StringSet<> &HiddenNames) {
1521 bool OnlyTagNames = false;
1522 switch (Context.getKind()) {
1523 case CodeCompletionContext::CCC_Other:
1524 case CodeCompletionContext::CCC_TopLevel:
1525 case CodeCompletionContext::CCC_ObjCInterface:
1526 case CodeCompletionContext::CCC_ObjCImplementation:
1527 case CodeCompletionContext::CCC_ObjCIvarList:
1528 case CodeCompletionContext::CCC_ClassStructUnion:
1529 case CodeCompletionContext::CCC_Statement:
1530 case CodeCompletionContext::CCC_Expression:
1531 case CodeCompletionContext::CCC_ObjCMessageReceiver:
1532 case CodeCompletionContext::CCC_MemberAccess:
1533 case CodeCompletionContext::CCC_Namespace:
1534 case CodeCompletionContext::CCC_Type:
1535 break;
1536
1537 case CodeCompletionContext::CCC_EnumTag:
1538 case CodeCompletionContext::CCC_UnionTag:
1539 case CodeCompletionContext::CCC_ClassOrStructTag:
1540 OnlyTagNames = true;
1541 break;
1542
1543 case CodeCompletionContext::CCC_ObjCProtocolName:
1544 // If we're just looking for protocol names, nothing can hide them.
1545 return;
1546 }
1547
1548 typedef CodeCompleteConsumer::Result Result;
1549 for (unsigned I = 0; I != NumResults; ++I) {
1550 if (Results[I].Kind != Result::RK_Declaration)
1551 continue;
1552
1553 unsigned IDNS
1554 = Results[I].Declaration->getUnderlyingDecl()->getIdentifierNamespace();
1555
1556 bool Hiding = false;
1557 if (OnlyTagNames)
1558 Hiding = (IDNS & Decl::IDNS_Tag);
1559 else {
1560 unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
Douglas Gregora5fb7c32010-08-16 23:05:20 +00001561 Decl::IDNS_Namespace | Decl::IDNS_Ordinary |
1562 Decl::IDNS_NonMemberOperator);
Douglas Gregor5f808c22010-08-16 21:18:39 +00001563 if (Ctx.getLangOptions().CPlusPlus)
1564 HiddenIDNS |= Decl::IDNS_Tag;
1565 Hiding = (IDNS & HiddenIDNS);
1566 }
1567
1568 if (!Hiding)
1569 continue;
1570
1571 DeclarationName Name = Results[I].Declaration->getDeclName();
1572 if (IdentifierInfo *Identifier = Name.getAsIdentifierInfo())
1573 HiddenNames.insert(Identifier->getName());
1574 else
1575 HiddenNames.insert(Name.getAsString());
1576 }
1577}
1578
1579
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001580void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
1581 CodeCompletionContext Context,
1582 Result *Results,
1583 unsigned NumResults) {
1584 // Merge the results we were given with the results we cached.
1585 bool AddedResult = false;
Douglas Gregor5f808c22010-08-16 21:18:39 +00001586 unsigned InContexts
1587 = (Context.getKind() == CodeCompletionContext::CCC_Other? NormalContexts
1588 : (1 << (Context.getKind() - 1)));
1589
1590 // Contains the set of names that are hidden by "local" completion results.
1591 llvm::StringSet<> HiddenNames;
1592
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001593 typedef CodeCompleteConsumer::Result Result;
1594 llvm::SmallVector<Result, 8> AllResults;
1595 for (ASTUnit::cached_completion_iterator
Douglas Gregor5535d572010-08-16 21:23:13 +00001596 C = AST.cached_completion_begin(),
1597 CEnd = AST.cached_completion_end();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001598 C != CEnd; ++C) {
1599 // If the context we are in matches any of the contexts we are
1600 // interested in, we'll add this result.
1601 if ((C->ShowInContexts & InContexts) == 0)
1602 continue;
1603
1604 // If we haven't added any results previously, do so now.
1605 if (!AddedResult) {
Douglas Gregor5f808c22010-08-16 21:18:39 +00001606 CalculateHiddenNames(Context, Results, NumResults, S.Context,
1607 HiddenNames);
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001608 AllResults.insert(AllResults.end(), Results, Results + NumResults);
1609 AddedResult = true;
1610 }
1611
Douglas Gregor5f808c22010-08-16 21:18:39 +00001612 // Determine whether this global completion result is hidden by a local
1613 // completion result. If so, skip it.
1614 if (C->Kind != CXCursor_MacroDefinition &&
1615 HiddenNames.count(C->Completion->getTypedText()))
1616 continue;
1617
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001618 // Adjust priority based on similar type classes.
1619 unsigned Priority = C->Priority;
1620 if (!Context.getPreferredType().isNull()) {
1621 if (C->Kind == CXCursor_MacroDefinition) {
1622 Priority = getMacroUsagePriority(C->Completion->getTypedText(),
1623 Context.getPreferredType()->isAnyPointerType());
1624 } else if (C->Type) {
1625 CanQualType Expected
Douglas Gregor5535d572010-08-16 21:23:13 +00001626 = S.Context.getCanonicalType(
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001627 Context.getPreferredType().getUnqualifiedType());
1628 SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
1629 if (ExpectedSTC == C->TypeClass) {
1630 // We know this type is similar; check for an exact match.
1631 llvm::StringMap<unsigned> &CachedCompletionTypes
Douglas Gregor5535d572010-08-16 21:23:13 +00001632 = AST.getCachedCompletionTypes();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001633 llvm::StringMap<unsigned>::iterator Pos
Douglas Gregor5535d572010-08-16 21:23:13 +00001634 = CachedCompletionTypes.find(QualType(Expected).getAsString());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00001635 if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
1636 Priority /= CCF_ExactTypeMatch;
1637 else
1638 Priority /= CCF_SimilarTypeMatch;
1639 }
1640 }
1641 }
1642
1643 AllResults.push_back(Result(C->Completion, Priority, C->Kind));
1644 }
1645
1646 // If we did not add any cached completion results, just forward the
1647 // results we were given to the next consumer.
1648 if (!AddedResult) {
1649 Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
1650 return;
1651 }
1652
1653 Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
1654 AllResults.size());
1655}
1656
1657
1658
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001659void ASTUnit::CodeComplete(llvm::StringRef File, unsigned Line, unsigned Column,
1660 RemappedFile *RemappedFiles,
1661 unsigned NumRemappedFiles,
Douglas Gregorcee235c2010-08-05 09:09:23 +00001662 bool IncludeMacros,
1663 bool IncludeCodePatterns,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001664 CodeCompleteConsumer &Consumer,
1665 Diagnostic &Diag, LangOptions &LangOpts,
1666 SourceManager &SourceMgr, FileManager &FileMgr,
Douglas Gregor2283d792010-08-20 00:59:43 +00001667 llvm::SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
1668 llvm::SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001669 if (!Invocation.get())
1670 return;
1671
Douglas Gregordf95a132010-08-09 20:45:32 +00001672 llvm::Timer *CompletionTimer = 0;
1673 if (TimerGroup.get()) {
1674 llvm::SmallString<128> TimerName;
1675 llvm::raw_svector_ostream TimerNameOut(TimerName);
1676 TimerNameOut << "Code completion @ " << File << ":" << Line << ":"
1677 << Column;
1678 CompletionTimer = new llvm::Timer(TimerNameOut.str(), *TimerGroup);
1679 CompletionTimer->startTimer();
1680 Timers.push_back(CompletionTimer);
1681 }
1682
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001683 CompilerInvocation CCInvocation(*Invocation);
1684 FrontendOptions &FrontendOpts = CCInvocation.getFrontendOpts();
1685 PreprocessorOptions &PreprocessorOpts = CCInvocation.getPreprocessorOpts();
Douglas Gregorcee235c2010-08-05 09:09:23 +00001686
Douglas Gregor87c08a52010-08-13 22:48:40 +00001687 FrontendOpts.ShowMacrosInCodeCompletion
1688 = IncludeMacros && CachedCompletionResults.empty();
Douglas Gregorcee235c2010-08-05 09:09:23 +00001689 FrontendOpts.ShowCodePatternsInCodeCompletion = IncludeCodePatterns;
Douglas Gregor8071e422010-08-15 06:18:01 +00001690 FrontendOpts.ShowGlobalSymbolsInCodeCompletion
1691 = CachedCompletionResults.empty();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001692 FrontendOpts.CodeCompletionAt.FileName = File;
1693 FrontendOpts.CodeCompletionAt.Line = Line;
1694 FrontendOpts.CodeCompletionAt.Column = Column;
1695
Douglas Gregorcee235c2010-08-05 09:09:23 +00001696 // Turn on spell-checking when performing code completion. It leads
1697 // to better results.
1698 unsigned SpellChecking = CCInvocation.getLangOpts().SpellChecking;
1699 CCInvocation.getLangOpts().SpellChecking = 1;
1700
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001701 // Set the language options appropriately.
1702 LangOpts = CCInvocation.getLangOpts();
1703
1704 CompilerInstance Clang;
1705 Clang.setInvocation(&CCInvocation);
1706 OriginalSourceFile = Clang.getFrontendOpts().Inputs[0].second;
1707
1708 // Set up diagnostics, capturing any diagnostics produced.
1709 Clang.setDiagnostics(&Diag);
1710 CaptureDroppedDiagnostics Capture(true,
1711 Clang.getDiagnostics(),
1712 StoredDiagnostics);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001713
1714 // Create the target instance.
1715 Clang.setTarget(TargetInfo::CreateTargetInfo(Clang.getDiagnostics(),
1716 Clang.getTargetOpts()));
1717 if (!Clang.hasTarget()) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001718 Clang.takeInvocation();
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001719 CCInvocation.getLangOpts().SpellChecking = SpellChecking;
1720 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001721 }
1722
1723 // Inform the target of the language options.
1724 //
1725 // FIXME: We shouldn't need to do this, the target should be immutable once
1726 // created. This complexity should be lifted elsewhere.
1727 Clang.getTarget().setForcedLangOptions(Clang.getLangOpts());
1728
1729 assert(Clang.getFrontendOpts().Inputs.size() == 1 &&
1730 "Invocation must have exactly one source file!");
1731 assert(Clang.getFrontendOpts().Inputs[0].first != IK_AST &&
1732 "FIXME: AST inputs not yet supported here!");
1733 assert(Clang.getFrontendOpts().Inputs[0].first != IK_LLVM_IR &&
1734 "IR inputs not support here!");
1735
1736
1737 // Use the source and file managers that we were given.
1738 Clang.setFileManager(&FileMgr);
1739 Clang.setSourceManager(&SourceMgr);
1740
1741 // Remap files.
1742 PreprocessorOpts.clearRemappedFiles();
Douglas Gregorb75d3df2010-08-04 17:07:00 +00001743 PreprocessorOpts.RetainRemappedFileBuffers = true;
Douglas Gregor2283d792010-08-20 00:59:43 +00001744 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001745 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first,
1746 RemappedFiles[I].second);
Douglas Gregor2283d792010-08-20 00:59:43 +00001747 OwnedBuffers.push_back(RemappedFiles[I].second);
1748 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001749
Douglas Gregor87c08a52010-08-13 22:48:40 +00001750 // Use the code completion consumer we were given, but adding any cached
1751 // code-completion results.
1752 AugmentedCodeCompleteConsumer
1753 AugmentedConsumer(*this, Consumer, FrontendOpts.ShowMacrosInCodeCompletion,
Douglas Gregor8071e422010-08-15 06:18:01 +00001754 FrontendOpts.ShowCodePatternsInCodeCompletion,
1755 FrontendOpts.ShowGlobalSymbolsInCodeCompletion);
Douglas Gregor87c08a52010-08-13 22:48:40 +00001756 Clang.setCodeCompletionConsumer(&AugmentedConsumer);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001757
Douglas Gregordf95a132010-08-09 20:45:32 +00001758 // If we have a precompiled preamble, try to use it. We only allow
1759 // the use of the precompiled preamble if we're if the completion
1760 // point is within the main file, after the end of the precompiled
1761 // preamble.
1762 llvm::MemoryBuffer *OverrideMainBuffer = 0;
1763 if (!PreambleFile.empty()) {
1764 using llvm::sys::FileStatus;
1765 llvm::sys::PathWithStatus CompleteFilePath(File);
1766 llvm::sys::PathWithStatus MainPath(OriginalSourceFile);
1767 if (const FileStatus *CompleteFileStatus = CompleteFilePath.getFileStatus())
1768 if (const FileStatus *MainStatus = MainPath.getFileStatus())
1769 if (CompleteFileStatus->getUniqueID() == MainStatus->getUniqueID())
Douglas Gregor2283d792010-08-20 00:59:43 +00001770 OverrideMainBuffer
1771 = getMainBufferWithPrecompiledPreamble(CCInvocation, false, Line);
Douglas Gregordf95a132010-08-09 20:45:32 +00001772 }
1773
1774 // If the main file has been overridden due to the use of a preamble,
1775 // make that override happen and introduce the preamble.
1776 if (OverrideMainBuffer) {
1777 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
1778 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
1779 PreprocessorOpts.PrecompiledPreambleBytes.second
1780 = PreambleEndsAtStartOfLine;
1781 PreprocessorOpts.ImplicitPCHInclude = PreambleFile;
1782 PreprocessorOpts.DisablePCHValidation = true;
1783
1784 // The stored diagnostics have the old source manager. Copy them
1785 // to our output set of stored diagnostics, updating the source
1786 // manager to the one we were given.
1787 for (unsigned I = 0, N = this->StoredDiagnostics.size(); I != N; ++I) {
1788 StoredDiagnostics.push_back(this->StoredDiagnostics[I]);
1789 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(), SourceMgr);
1790 StoredDiagnostics[I].setLocation(Loc);
1791 }
Douglas Gregor2283d792010-08-20 00:59:43 +00001792
1793 OwnedBuffers.push_back(OverrideMainBuffer);
Douglas Gregorf128fed2010-08-20 00:02:33 +00001794 } else {
1795 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
1796 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregordf95a132010-08-09 20:45:32 +00001797 }
1798
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001799 llvm::OwningPtr<SyntaxOnlyAction> Act;
1800 Act.reset(new SyntaxOnlyAction);
1801 if (Act->BeginSourceFile(Clang, Clang.getFrontendOpts().Inputs[0].second,
1802 Clang.getFrontendOpts().Inputs[0].first)) {
1803 Act->Execute();
1804 Act->EndSourceFile();
1805 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001806
1807 if (CompletionTimer)
1808 CompletionTimer->stopTimer();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001809
1810 // Steal back our resources.
1811 Clang.takeFileManager();
1812 Clang.takeSourceManager();
1813 Clang.takeInvocation();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001814 Clang.takeCodeCompletionConsumer();
Douglas Gregorcee235c2010-08-05 09:09:23 +00001815 CCInvocation.getLangOpts().SpellChecking = SpellChecking;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001816}
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001817
1818bool ASTUnit::Save(llvm::StringRef File) {
1819 if (getDiagnostics().hasErrorOccurred())
1820 return true;
1821
1822 // FIXME: Can we somehow regenerate the stat cache here, or do we need to
1823 // unconditionally create a stat cache when we parse the file?
1824 std::string ErrorInfo;
Benjamin Kramer1395c5d2010-08-15 16:54:31 +00001825 llvm::raw_fd_ostream Out(File.str().c_str(), ErrorInfo,
1826 llvm::raw_fd_ostream::F_Binary);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001827 if (!ErrorInfo.empty() || Out.has_error())
1828 return true;
1829
1830 std::vector<unsigned char> Buffer;
1831 llvm::BitstreamWriter Stream(Buffer);
Sebastian Redla4232eb2010-08-18 23:56:21 +00001832 ASTWriter Writer(Stream);
1833 Writer.WriteAST(getSema(), 0, 0);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001834
1835 // Write the generated bitstream to "Out".
Douglas Gregorbdbb0042010-08-18 22:29:43 +00001836 if (!Buffer.empty())
1837 Out.write((char *)&Buffer.front(), Buffer.size());
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001838 Out.close();
1839 return Out.has_error();
1840}