blob: 72f5d4c18e0e472a7abc83abf04e61978619faa7 [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"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000015#include "clang/AST/ASTConsumer.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000016#include "clang/AST/ASTContext.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000017#include "clang/AST/DeclVisitor.h"
18#include "clang/AST/StmtVisitor.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000019#include "clang/AST/TypeOrdering.h"
20#include "clang/Basic/Diagnostic.h"
21#include "clang/Basic/TargetInfo.h"
22#include "clang/Basic/TargetOptions.h"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000023#include "clang/Frontend/CompilerInstance.h"
24#include "clang/Frontend/FrontendActions.h"
Daniel Dunbar7b556682009-12-02 03:23:45 +000025#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbar521bf9c2009-12-01 09:51:01 +000026#include "clang/Frontend/FrontendOptions.h"
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +000027#include "clang/Frontend/MultiplexConsumer.h"
Douglas Gregor32be4a52010-10-11 21:37:58 +000028#include "clang/Frontend/Utils.h"
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000029#include "clang/Lex/HeaderSearch.h"
30#include "clang/Lex/Preprocessor.h"
Douglas Gregor36a16492012-10-24 17:46:57 +000031#include "clang/Lex/PreprocessorOptions.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000032#include "clang/Serialization/ASTReader.h"
33#include "clang/Serialization/ASTWriter.h"
Chris Lattner7f9fc3f2011-03-23 04:04:01 +000034#include "llvm/ADT/ArrayRef.h"
Douglas Gregor9b7db622011-02-16 18:16:54 +000035#include "llvm/ADT/StringExtras.h"
Douglas Gregor349d38c2010-08-16 23:08:34 +000036#include "llvm/ADT/StringSet.h"
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +000037#include "llvm/Support/Atomic.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000038#include "llvm/Support/CrashRecoveryContext.h"
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +000039#include "llvm/Support/FileSystem.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000040#include "llvm/Support/Host.h"
41#include "llvm/Support/MemoryBuffer.h"
Argyrios Kyrtzidisa696ece2011-10-10 21:57:12 +000042#include "llvm/Support/Mutex.h"
Ted Kremeneke055f8a2011-10-27 19:44:25 +000043#include "llvm/Support/MutexGuard.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000044#include "llvm/Support/Path.h"
45#include "llvm/Support/Timer.h"
46#include "llvm/Support/raw_ostream.h"
Zhongxing Xuad23ebe2010-07-23 02:15:08 +000047#include <cstdio>
Chandler Carruth55fc8732012-12-04 09:13:33 +000048#include <cstdlib>
Douglas Gregorcc5888d2010-07-31 00:40:00 +000049#include <sys/stat.h>
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000050using namespace clang;
51
Douglas Gregor213f18b2010-10-28 15:44:59 +000052using llvm::TimeRecord;
53
54namespace {
55 class SimpleTimer {
56 bool WantTiming;
57 TimeRecord Start;
58 std::string Output;
59
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000060 public:
Douglas Gregor9dba61a2010-11-01 13:48:43 +000061 explicit SimpleTimer(bool WantTiming) : WantTiming(WantTiming) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000062 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000063 Start = TimeRecord::getCurrentTime();
Douglas Gregor213f18b2010-10-28 15:44:59 +000064 }
65
Chris Lattner5f9e2722011-07-23 10:55:15 +000066 void setOutput(const Twine &Output) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000067 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000068 this->Output = Output.str();
Douglas Gregor213f18b2010-10-28 15:44:59 +000069 }
70
Douglas Gregor213f18b2010-10-28 15:44:59 +000071 ~SimpleTimer() {
72 if (WantTiming) {
73 TimeRecord Elapsed = TimeRecord::getCurrentTime();
74 Elapsed -= Start;
75 llvm::errs() << Output << ':';
76 Elapsed.print(Elapsed, llvm::errs());
77 llvm::errs() << '\n';
78 }
79 }
80 };
Ted Kremenek1872b312011-10-27 17:55:18 +000081
82 struct OnDiskData {
83 /// \brief The file in which the precompiled preamble is stored.
84 std::string PreambleFile;
85
Rafael Espindolab804cb32013-06-26 03:52:38 +000086 /// \brief Temporary files that should be removed when the ASTUnit is
Ted Kremenek1872b312011-10-27 17:55:18 +000087 /// destroyed.
Rafael Espindolab804cb32013-06-26 03:52:38 +000088 SmallVector<std::string, 4> TemporaryFiles;
89
Ted Kremenek1872b312011-10-27 17:55:18 +000090 /// \brief Erase temporary files.
91 void CleanTemporaryFiles();
92
93 /// \brief Erase the preamble file.
94 void CleanPreambleFile();
95
96 /// \brief Erase temporary files and the preamble file.
97 void Cleanup();
98 };
99}
100
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000101static llvm::sys::SmartMutex<false> &getOnDiskMutex() {
102 static llvm::sys::SmartMutex<false> M(/* recursive = */ true);
103 return M;
104}
105
Dmitri Gribenkoc4a77902012-11-15 14:28:07 +0000106static void cleanupOnDiskMapAtExit();
Ted Kremenek1872b312011-10-27 17:55:18 +0000107
108typedef llvm::DenseMap<const ASTUnit *, OnDiskData *> OnDiskDataMap;
109static OnDiskDataMap &getOnDiskDataMap() {
110 static OnDiskDataMap M;
111 static bool hasRegisteredAtExit = false;
112 if (!hasRegisteredAtExit) {
113 hasRegisteredAtExit = true;
114 atexit(cleanupOnDiskMapAtExit);
115 }
116 return M;
117}
118
Dmitri Gribenkoc4a77902012-11-15 14:28:07 +0000119static void cleanupOnDiskMapAtExit() {
Argyrios Kyrtzidis81788132012-07-03 16:30:52 +0000120 // Use the mutex because there can be an alive thread destroying an ASTUnit.
121 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000122 OnDiskDataMap &M = getOnDiskDataMap();
123 for (OnDiskDataMap::iterator I = M.begin(), E = M.end(); I != E; ++I) {
124 // We don't worry about freeing the memory associated with OnDiskDataMap.
125 // All we care about is erasing stale files.
126 I->second->Cleanup();
127 }
128}
129
130static OnDiskData &getOnDiskData(const ASTUnit *AU) {
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000131 // We require the mutex since we are modifying the structure of the
132 // DenseMap.
133 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000134 OnDiskDataMap &M = getOnDiskDataMap();
135 OnDiskData *&D = M[AU];
136 if (!D)
137 D = new OnDiskData();
138 return *D;
139}
140
141static void erasePreambleFile(const ASTUnit *AU) {
142 getOnDiskData(AU).CleanPreambleFile();
143}
144
145static void removeOnDiskEntry(const ASTUnit *AU) {
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000146 // We require the mutex since we are modifying the structure of the
147 // DenseMap.
148 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000149 OnDiskDataMap &M = getOnDiskDataMap();
150 OnDiskDataMap::iterator I = M.find(AU);
151 if (I != M.end()) {
152 I->second->Cleanup();
153 delete I->second;
154 M.erase(AU);
155 }
156}
157
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000158static void setPreambleFile(const ASTUnit *AU, StringRef preambleFile) {
Ted Kremenek1872b312011-10-27 17:55:18 +0000159 getOnDiskData(AU).PreambleFile = preambleFile;
160}
161
162static const std::string &getPreambleFile(const ASTUnit *AU) {
163 return getOnDiskData(AU).PreambleFile;
164}
165
166void OnDiskData::CleanTemporaryFiles() {
167 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
Rafael Espindolab804cb32013-06-26 03:52:38 +0000168 llvm::sys::fs::remove(TemporaryFiles[I]);
169 TemporaryFiles.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +0000170}
171
172void OnDiskData::CleanPreambleFile() {
173 if (!PreambleFile.empty()) {
Rafael Espindola85d28482013-06-26 04:02:37 +0000174 llvm::sys::fs::remove(PreambleFile);
Ted Kremenek1872b312011-10-27 17:55:18 +0000175 PreambleFile.clear();
176 }
177}
178
179void OnDiskData::Cleanup() {
180 CleanTemporaryFiles();
181 CleanPreambleFile();
182}
183
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000184struct ASTUnit::ASTWriterData {
185 SmallString<128> Buffer;
186 llvm::BitstreamWriter Stream;
187 ASTWriter Writer;
188
189 ASTWriterData() : Stream(Buffer), Writer(Stream) { }
190};
191
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000192void ASTUnit::clearFileLevelDecls() {
193 for (FileDeclsTy::iterator
194 I = FileDecls.begin(), E = FileDecls.end(); I != E; ++I)
195 delete I->second;
196 FileDecls.clear();
197}
198
Ted Kremenek1872b312011-10-27 17:55:18 +0000199void ASTUnit::CleanTemporaryFiles() {
200 getOnDiskData(this).CleanTemporaryFiles();
201}
202
Rafael Espindolab804cb32013-06-26 03:52:38 +0000203void ASTUnit::addTemporaryFile(StringRef TempFile) {
Ted Kremenek1872b312011-10-27 17:55:18 +0000204 getOnDiskData(this).TemporaryFiles.push_back(TempFile);
Douglas Gregor213f18b2010-10-28 15:44:59 +0000205}
206
Douglas Gregoreababfb2010-08-04 05:53:38 +0000207/// \brief After failing to build a precompiled preamble (due to
208/// errors in the source that occurs in the preamble), the number of
209/// reparses during which we'll skip even trying to precompile the
210/// preamble.
211const unsigned DefaultPreambleRebuildInterval = 5;
212
Douglas Gregore3c60a72010-11-17 00:13:31 +0000213/// \brief Tracks the number of ASTUnit objects that are currently active.
214///
215/// Used for debugging purposes only.
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000216static llvm::sys::cas_flag ActiveASTUnitObjects;
Douglas Gregore3c60a72010-11-17 00:13:31 +0000217
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000218ASTUnit::ASTUnit(bool _MainFileIsAST)
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +0000219 : Reader(0), HadModuleLoaderFatalFailure(false),
220 OnlyLocalDecls(false), CaptureDiagnostics(false),
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000221 MainFileIsAST(_MainFileIsAST),
Douglas Gregor467dc882011-08-25 22:30:56 +0000222 TUKind(TU_Complete), WantTiming(getenv("LIBCLANG_TIMING")),
Argyrios Kyrtzidis15727dd2011-03-05 01:03:48 +0000223 OwnsRemappedFileBuffers(true),
Douglas Gregor213f18b2010-10-28 15:44:59 +0000224 NumStoredDiagnosticsFromDriver(0),
Douglas Gregor671947b2010-08-19 01:33:06 +0000225 PreambleRebuildCounter(0), SavedMainFileBuffer(0), PreambleBuffer(0),
Argyrios Kyrtzidis98704012011-11-29 18:18:33 +0000226 NumWarningsInPreamble(0),
Douglas Gregor727d93e2010-08-17 00:40:40 +0000227 ShouldCacheCodeCompletionResults(false),
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000228 IncludeBriefCommentsInCodeCompletion(false), UserFilesAreVolatile(false),
Douglas Gregor9b7db622011-02-16 18:16:54 +0000229 CompletionCacheTopLevelHashValue(0),
230 PreambleTopLevelHashValue(0),
231 CurrentTopLevelHashValue(0),
Douglas Gregor8b1540c2010-08-19 00:45:44 +0000232 UnsafeToFree(false) {
Douglas Gregore3c60a72010-11-17 00:13:31 +0000233 if (getenv("LIBCLANG_OBJTRACKING")) {
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000234 llvm::sys::AtomicIncrement(&ActiveASTUnitObjects);
Douglas Gregore3c60a72010-11-17 00:13:31 +0000235 fprintf(stderr, "+++ %d translation units\n", ActiveASTUnitObjects);
236 }
Douglas Gregor385103b2010-07-30 20:58:08 +0000237}
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000238
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000239ASTUnit::~ASTUnit() {
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000240 // If we loaded from an AST file, balance out the BeginSourceFile call.
241 if (MainFileIsAST && getDiagnostics().getClient()) {
242 getDiagnostics().getClient()->EndSourceFile();
243 }
244
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000245 clearFileLevelDecls();
246
Ted Kremenek1872b312011-10-27 17:55:18 +0000247 // Clean up the temporary files and the preamble file.
248 removeOnDiskEntry(this);
249
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000250 // Free the buffers associated with remapped files. We are required to
251 // perform this operation here because we explicitly request that the
252 // compiler instance *not* free these buffers for each invocation of the
253 // parser.
Ted Kremenek4f327862011-03-21 18:40:17 +0000254 if (Invocation.getPtr() && OwnsRemappedFileBuffers) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000255 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
256 for (PreprocessorOptions::remapped_file_buffer_iterator
257 FB = PPOpts.remapped_file_buffer_begin(),
258 FBEnd = PPOpts.remapped_file_buffer_end();
259 FB != FBEnd;
260 ++FB)
261 delete FB->second;
262 }
Douglas Gregor28233422010-07-27 14:52:07 +0000263
264 delete SavedMainFileBuffer;
Douglas Gregor671947b2010-08-19 01:33:06 +0000265 delete PreambleBuffer;
266
Douglas Gregor213f18b2010-10-28 15:44:59 +0000267 ClearCachedCompletionResults();
Douglas Gregore3c60a72010-11-17 00:13:31 +0000268
269 if (getenv("LIBCLANG_OBJTRACKING")) {
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000270 llvm::sys::AtomicDecrement(&ActiveASTUnitObjects);
Douglas Gregore3c60a72010-11-17 00:13:31 +0000271 fprintf(stderr, "--- %d translation units\n", ActiveASTUnitObjects);
272 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000273}
274
Argyrios Kyrtzidis7fe90f32012-01-17 18:48:07 +0000275void ASTUnit::setPreprocessor(Preprocessor *pp) { PP = pp; }
276
Douglas Gregor8071e422010-08-15 06:18:01 +0000277/// \brief Determine the set of code-completion contexts in which this
278/// declaration should be shown.
Dmitri Gribenko89cf4252013-01-23 17:21:11 +0000279static unsigned getDeclShowContexts(const NamedDecl *ND,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000280 const LangOptions &LangOpts,
281 bool &IsNestedNameSpecifier) {
282 IsNestedNameSpecifier = false;
283
Douglas Gregor8071e422010-08-15 06:18:01 +0000284 if (isa<UsingShadowDecl>(ND))
285 ND = dyn_cast<NamedDecl>(ND->getUnderlyingDecl());
286 if (!ND)
287 return 0;
288
Richard Smith026b3582012-08-14 03:13:00 +0000289 uint64_t Contexts = 0;
Douglas Gregor8071e422010-08-15 06:18:01 +0000290 if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
291 isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND)) {
292 // Types can appear in these contexts.
293 if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000294 Contexts |= (1LL << CodeCompletionContext::CCC_TopLevel)
295 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
296 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
297 | (1LL << CodeCompletionContext::CCC_Statement)
298 | (1LL << CodeCompletionContext::CCC_Type)
299 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
Douglas Gregor8071e422010-08-15 06:18:01 +0000300
301 // In C++, types can appear in expressions contexts (for functional casts).
302 if (LangOpts.CPlusPlus)
Richard Smith026b3582012-08-14 03:13:00 +0000303 Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
Douglas Gregor8071e422010-08-15 06:18:01 +0000304
305 // In Objective-C, message sends can send interfaces. In Objective-C++,
306 // all types are available due to functional casts.
307 if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000308 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
Douglas Gregor3da626b2011-07-07 16:03:39 +0000309
310 // In Objective-C, you can only be a subclass of another Objective-C class
311 if (isa<ObjCInterfaceDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000312 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCInterfaceName);
Douglas Gregor8071e422010-08-15 06:18:01 +0000313
314 // Deal with tag names.
315 if (isa<EnumDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000316 Contexts |= (1LL << CodeCompletionContext::CCC_EnumTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000317
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000318 // Part of the nested-name-specifier in C++0x.
Richard Smith80ad52f2013-01-02 11:42:31 +0000319 if (LangOpts.CPlusPlus11)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000320 IsNestedNameSpecifier = true;
Dmitri Gribenko89cf4252013-01-23 17:21:11 +0000321 } else if (const RecordDecl *Record = dyn_cast<RecordDecl>(ND)) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000322 if (Record->isUnion())
Richard Smith026b3582012-08-14 03:13:00 +0000323 Contexts |= (1LL << CodeCompletionContext::CCC_UnionTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000324 else
Richard Smith026b3582012-08-14 03:13:00 +0000325 Contexts |= (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000326
Douglas Gregor8071e422010-08-15 06:18:01 +0000327 if (LangOpts.CPlusPlus)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000328 IsNestedNameSpecifier = true;
Douglas Gregor52779fb2010-09-23 23:01:17 +0000329 } else if (isa<ClassTemplateDecl>(ND))
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000330 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000331 } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
332 // Values can appear in these contexts.
Richard Smith026b3582012-08-14 03:13:00 +0000333 Contexts = (1LL << CodeCompletionContext::CCC_Statement)
334 | (1LL << CodeCompletionContext::CCC_Expression)
335 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
336 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
Douglas Gregor8071e422010-08-15 06:18:01 +0000337 } else if (isa<ObjCProtocolDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000338 Contexts = (1LL << CodeCompletionContext::CCC_ObjCProtocolName);
Douglas Gregor3da626b2011-07-07 16:03:39 +0000339 } else if (isa<ObjCCategoryDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000340 Contexts = (1LL << CodeCompletionContext::CCC_ObjCCategoryName);
Douglas Gregor8071e422010-08-15 06:18:01 +0000341 } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000342 Contexts = (1LL << CodeCompletionContext::CCC_Namespace);
Douglas Gregor8071e422010-08-15 06:18:01 +0000343
344 // Part of the nested-name-specifier.
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000345 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000346 }
347
348 return Contexts;
349}
350
Douglas Gregor87c08a52010-08-13 22:48:40 +0000351void ASTUnit::CacheCodeCompletionResults() {
352 if (!TheSema)
353 return;
354
Douglas Gregor213f18b2010-10-28 15:44:59 +0000355 SimpleTimer Timer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +0000356 Timer.setOutput("Cache global code completions for " + getMainFileName());
Douglas Gregor87c08a52010-08-13 22:48:40 +0000357
358 // Clear out the previous results.
359 ClearCachedCompletionResults();
360
361 // Gather the set of global code completions.
John McCall0a2c5e22010-08-25 06:19:51 +0000362 typedef CodeCompletionResult Result;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000363 SmallVector<Result, 8> Results;
Douglas Gregor48601b32011-02-16 19:08:06 +0000364 CachedCompletionAllocator = new GlobalCodeCompletionAllocator;
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000365 CodeCompletionTUInfo CCTUInfo(CachedCompletionAllocator);
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000366 TheSema->GatherGlobalCodeCompletions(*CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000367 CCTUInfo, Results);
Douglas Gregor87c08a52010-08-13 22:48:40 +0000368
369 // Translate global code completions into cached completions.
Douglas Gregorf5586f62010-08-16 18:08:11 +0000370 llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
371
Douglas Gregor87c08a52010-08-13 22:48:40 +0000372 for (unsigned I = 0, N = Results.size(); I != N; ++I) {
373 switch (Results[I].Kind) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000374 case Result::RK_Declaration: {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000375 bool IsNestedNameSpecifier = false;
Douglas Gregor8071e422010-08-15 06:18:01 +0000376 CachedCodeCompletionResult CachedResult;
Douglas Gregor218937c2011-02-01 19:23:04 +0000377 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000378 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000379 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000380 IncludeBriefCommentsInCodeCompletion);
Douglas Gregor8071e422010-08-15 06:18:01 +0000381 CachedResult.ShowInContexts = getDeclShowContexts(Results[I].Declaration,
David Blaikie4e4d0842012-03-11 07:00:24 +0000382 Ctx->getLangOpts(),
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000383 IsNestedNameSpecifier);
Douglas Gregor8071e422010-08-15 06:18:01 +0000384 CachedResult.Priority = Results[I].Priority;
385 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000386 CachedResult.Availability = Results[I].Availability;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000387
Douglas Gregorf5586f62010-08-16 18:08:11 +0000388 // Keep track of the type of this completion in an ASTContext-agnostic
389 // way.
Douglas Gregorc4421e92010-08-16 16:46:30 +0000390 QualType UsageType = getDeclUsageType(*Ctx, Results[I].Declaration);
Douglas Gregorf5586f62010-08-16 18:08:11 +0000391 if (UsageType.isNull()) {
Douglas Gregorc4421e92010-08-16 16:46:30 +0000392 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000393 CachedResult.Type = 0;
394 } else {
395 CanQualType CanUsageType
396 = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
397 CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
398
399 // Determine whether we have already seen this type. If so, we save
400 // ourselves the work of formatting the type string by using the
401 // temporary, CanQualType-based hash table to find the associated value.
402 unsigned &TypeValue = CompletionTypes[CanUsageType];
403 if (TypeValue == 0) {
404 TypeValue = CompletionTypes.size();
405 CachedCompletionTypes[QualType(CanUsageType).getAsString()]
406 = TypeValue;
407 }
408
409 CachedResult.Type = TypeValue;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000410 }
Douglas Gregorf5586f62010-08-16 18:08:11 +0000411
Douglas Gregor8071e422010-08-15 06:18:01 +0000412 CachedCompletionResults.push_back(CachedResult);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000413
414 /// Handle nested-name-specifiers in C++.
David Blaikie4e4d0842012-03-11 07:00:24 +0000415 if (TheSema->Context.getLangOpts().CPlusPlus &&
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000416 IsNestedNameSpecifier && !Results[I].StartsNestedNameSpecifier) {
417 // The contexts in which a nested-name-specifier can appear in C++.
Richard Smith026b3582012-08-14 03:13:00 +0000418 uint64_t NNSContexts
419 = (1LL << CodeCompletionContext::CCC_TopLevel)
420 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
421 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
422 | (1LL << CodeCompletionContext::CCC_Statement)
423 | (1LL << CodeCompletionContext::CCC_Expression)
424 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
425 | (1LL << CodeCompletionContext::CCC_EnumTag)
426 | (1LL << CodeCompletionContext::CCC_UnionTag)
427 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag)
428 | (1LL << CodeCompletionContext::CCC_Type)
429 | (1LL << CodeCompletionContext::CCC_PotentiallyQualifiedName)
430 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000431
432 if (isa<NamespaceDecl>(Results[I].Declaration) ||
433 isa<NamespaceAliasDecl>(Results[I].Declaration))
Richard Smith026b3582012-08-14 03:13:00 +0000434 NNSContexts |= (1LL << CodeCompletionContext::CCC_Namespace);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000435
436 if (unsigned RemainingContexts
437 = NNSContexts & ~CachedResult.ShowInContexts) {
438 // If there any contexts where this completion can be a
439 // nested-name-specifier but isn't already an option, create a
440 // nested-name-specifier completion.
441 Results[I].StartsNestedNameSpecifier = true;
Douglas Gregor218937c2011-02-01 19:23:04 +0000442 CachedResult.Completion
443 = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000444 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000445 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000446 IncludeBriefCommentsInCodeCompletion);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000447 CachedResult.ShowInContexts = RemainingContexts;
448 CachedResult.Priority = CCP_NestedNameSpecifier;
449 CachedResult.TypeClass = STC_Void;
450 CachedResult.Type = 0;
451 CachedCompletionResults.push_back(CachedResult);
452 }
453 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000454 break;
Douglas Gregor8071e422010-08-15 06:18:01 +0000455 }
456
Douglas Gregor87c08a52010-08-13 22:48:40 +0000457 case Result::RK_Keyword:
458 case Result::RK_Pattern:
459 // Ignore keywords and patterns; we don't care, since they are so
460 // easily regenerated.
461 break;
462
463 case Result::RK_Macro: {
464 CachedCodeCompletionResult CachedResult;
Douglas Gregor218937c2011-02-01 19:23:04 +0000465 CachedResult.Completion
466 = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000467 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000468 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000469 IncludeBriefCommentsInCodeCompletion);
Douglas Gregor87c08a52010-08-13 22:48:40 +0000470 CachedResult.ShowInContexts
Richard Smith026b3582012-08-14 03:13:00 +0000471 = (1LL << CodeCompletionContext::CCC_TopLevel)
472 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
473 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
474 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
475 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
476 | (1LL << CodeCompletionContext::CCC_Statement)
477 | (1LL << CodeCompletionContext::CCC_Expression)
478 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
479 | (1LL << CodeCompletionContext::CCC_MacroNameUse)
480 | (1LL << CodeCompletionContext::CCC_PreprocessorExpression)
481 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
482 | (1LL << CodeCompletionContext::CCC_OtherWithMacros);
Douglas Gregor2ccccb32010-08-23 18:23:48 +0000483
Douglas Gregor87c08a52010-08-13 22:48:40 +0000484 CachedResult.Priority = Results[I].Priority;
485 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000486 CachedResult.Availability = Results[I].Availability;
Douglas Gregor1827e102010-08-16 16:18:59 +0000487 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000488 CachedResult.Type = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000489 CachedCompletionResults.push_back(CachedResult);
490 break;
491 }
492 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000493 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000494
495 // Save the current top-level hash value.
496 CompletionCacheTopLevelHashValue = CurrentTopLevelHashValue;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000497}
498
499void ASTUnit::ClearCachedCompletionResults() {
Douglas Gregor87c08a52010-08-13 22:48:40 +0000500 CachedCompletionResults.clear();
Douglas Gregorf5586f62010-08-16 18:08:11 +0000501 CachedCompletionTypes.clear();
Douglas Gregor48601b32011-02-16 19:08:06 +0000502 CachedCompletionAllocator = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000503}
504
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000505namespace {
506
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000507/// \brief Gathers information from ASTReader that will be used to initialize
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000508/// a Preprocessor.
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000509class ASTInfoCollector : public ASTReaderListener {
Douglas Gregor998b3d32011-09-01 23:39:15 +0000510 Preprocessor &PP;
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000511 ASTContext &Context;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000512 LangOptions &LangOpt;
Douglas Gregor57016dd2012-10-16 23:40:58 +0000513 IntrusiveRefCntPtr<TargetOptions> &TargetOpts;
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000514 IntrusiveRefCntPtr<TargetInfo> &Target;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000515 unsigned &Counter;
Mike Stump1eb44332009-09-09 15:08:12 +0000516
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000517 bool InitializedLanguage;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000518public:
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000519 ASTInfoCollector(Preprocessor &PP, ASTContext &Context, LangOptions &LangOpt,
Douglas Gregor57016dd2012-10-16 23:40:58 +0000520 IntrusiveRefCntPtr<TargetOptions> &TargetOpts,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000521 IntrusiveRefCntPtr<TargetInfo> &Target,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000522 unsigned &Counter)
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000523 : PP(PP), Context(Context), LangOpt(LangOpt),
Douglas Gregor9a022bb2012-10-15 16:45:32 +0000524 TargetOpts(TargetOpts), Target(Target),
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000525 Counter(Counter),
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000526 InitializedLanguage(false) {}
Mike Stump1eb44332009-09-09 15:08:12 +0000527
Douglas Gregor27ffa6c2012-10-23 06:18:24 +0000528 virtual bool ReadLanguageOptions(const LangOptions &LangOpts,
Douglas Gregor38295be2012-10-22 23:51:00 +0000529 bool Complain) {
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000530 if (InitializedLanguage)
Douglas Gregor998b3d32011-09-01 23:39:15 +0000531 return false;
532
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000533 LangOpt = LangOpts;
534 InitializedLanguage = true;
535
536 updated();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000537 return false;
538 }
Mike Stump1eb44332009-09-09 15:08:12 +0000539
Douglas Gregor27ffa6c2012-10-23 06:18:24 +0000540 virtual bool ReadTargetOptions(const TargetOptions &TargetOpts,
Douglas Gregor38295be2012-10-22 23:51:00 +0000541 bool Complain) {
Douglas Gregor998b3d32011-09-01 23:39:15 +0000542 // If we've already initialized the target, don't do it again.
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000543 if (Target)
Douglas Gregor998b3d32011-09-01 23:39:15 +0000544 return false;
545
Douglas Gregor57016dd2012-10-16 23:40:58 +0000546 this->TargetOpts = new TargetOptions(TargetOpts);
Douglas Gregor49a87542012-11-16 04:24:59 +0000547 Target = TargetInfo::CreateTargetInfo(PP.getDiagnostics(),
548 &*this->TargetOpts);
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000549
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000550 updated();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000551 return false;
552 }
Mike Stump1eb44332009-09-09 15:08:12 +0000553
Argyrios Kyrtzidis62288ed2012-10-10 02:12:47 +0000554 virtual void ReadCounter(const serialization::ModuleFile &M, unsigned Value) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000555 Counter = Value;
556 }
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000557
558private:
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000559 void updated() {
560 if (!Target || !InitializedLanguage)
561 return;
562
563 // Inform the target of the language options.
564 //
565 // FIXME: We shouldn't need to do this, the target should be immutable once
566 // created. This complexity should be lifted elsewhere.
567 Target->setForcedLangOptions(LangOpt);
568
569 // Initialize the preprocessor.
570 PP.Initialize(*Target);
571
572 // Initialize the ASTContext
573 Context.InitBuiltinTypes(*Target);
Dmitri Gribenko6ebf0912013-02-22 14:21:27 +0000574
575 // We didn't have access to the comment options when the ASTContext was
576 // constructed, so register them now.
577 Context.getCommentCommandTraits().registerCommentOptions(
578 LangOpt.CommentOpts);
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000579 }
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000580};
581
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000582 /// \brief Diagnostic consumer that saves each diagnostic it is given.
David Blaikie26e7a902011-09-26 00:01:39 +0000583class StoredDiagnosticConsumer : public DiagnosticConsumer {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000584 SmallVectorImpl<StoredDiagnostic> &StoredDiags;
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000585 SourceManager *SourceMgr;
586
Douglas Gregora88084b2010-02-18 18:08:43 +0000587public:
David Blaikie26e7a902011-09-26 00:01:39 +0000588 explicit StoredDiagnosticConsumer(
Chris Lattner5f9e2722011-07-23 10:55:15 +0000589 SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000590 : StoredDiags(StoredDiags), SourceMgr(0) { }
591
592 virtual void BeginSourceFile(const LangOptions &LangOpts,
593 const Preprocessor *PP = 0) {
594 if (PP)
595 SourceMgr = &PP->getSourceManager();
596 }
597
David Blaikied6471f72011-09-25 23:23:43 +0000598 virtual void HandleDiagnostic(DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +0000599 const Diagnostic &Info);
Douglas Gregora88084b2010-02-18 18:08:43 +0000600};
601
602/// \brief RAII object that optionally captures diagnostics, if
603/// there is no diagnostic client to capture them already.
604class CaptureDroppedDiagnostics {
David Blaikied6471f72011-09-25 23:23:43 +0000605 DiagnosticsEngine &Diags;
David Blaikie26e7a902011-09-26 00:01:39 +0000606 StoredDiagnosticConsumer Client;
David Blaikie78ad0b92011-09-25 23:39:51 +0000607 DiagnosticConsumer *PreviousClient;
Douglas Gregora88084b2010-02-18 18:08:43 +0000608
609public:
David Blaikied6471f72011-09-25 23:23:43 +0000610 CaptureDroppedDiagnostics(bool RequestCapture, DiagnosticsEngine &Diags,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000611 SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000612 : Diags(Diags), Client(StoredDiags), PreviousClient(0)
Douglas Gregora88084b2010-02-18 18:08:43 +0000613 {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000614 if (RequestCapture || Diags.getClient() == 0) {
615 PreviousClient = Diags.takeClient();
Douglas Gregora88084b2010-02-18 18:08:43 +0000616 Diags.setClient(&Client);
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000617 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000618 }
619
620 ~CaptureDroppedDiagnostics() {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000621 if (Diags.getClient() == &Client) {
622 Diags.takeClient();
623 Diags.setClient(PreviousClient);
624 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000625 }
626};
627
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000628} // anonymous namespace
629
David Blaikie26e7a902011-09-26 00:01:39 +0000630void StoredDiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +0000631 const Diagnostic &Info) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000632 // Default implementation (Warnings/errors count).
David Blaikie78ad0b92011-09-25 23:39:51 +0000633 DiagnosticConsumer::HandleDiagnostic(Level, Info);
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000634
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000635 // Only record the diagnostic if it's part of the source manager we know
636 // about. This effectively drops diagnostics from modules we're building.
637 // FIXME: In the long run, ee don't want to drop source managers from modules.
638 if (!Info.hasSourceManager() || &Info.getSourceManager() == SourceMgr)
639 StoredDiags.push_back(StoredDiagnostic(Level, Info));
Douglas Gregora88084b2010-02-18 18:08:43 +0000640}
641
Argyrios Kyrtzidis7eca8d22013-05-10 01:28:51 +0000642ASTMutationListener *ASTUnit::getASTMutationListener() {
643 if (WriterData)
644 return &WriterData->Writer;
645 return 0;
646}
647
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000648ASTDeserializationListener *ASTUnit::getDeserializationListener() {
649 if (WriterData)
650 return &WriterData->Writer;
651 return 0;
652}
653
Chris Lattner5f9e2722011-07-23 10:55:15 +0000654llvm::MemoryBuffer *ASTUnit::getBufferForFile(StringRef Filename,
Chris Lattner75dfb652010-11-23 09:19:42 +0000655 std::string *ErrorStr) {
Chris Lattner39b49bc2010-11-23 08:35:12 +0000656 assert(FileMgr);
Chris Lattner75dfb652010-11-23 09:19:42 +0000657 return FileMgr->getBufferForFile(Filename, ErrorStr);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000658}
659
Douglas Gregore47be3e2010-11-11 00:39:14 +0000660/// \brief Configure the diagnostics object for use with ASTUnit.
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000661void ASTUnit::ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> &Diags,
Douglas Gregor0b53cf82011-01-19 01:02:47 +0000662 const char **ArgBegin, const char **ArgEnd,
Douglas Gregore47be3e2010-11-11 00:39:14 +0000663 ASTUnit &AST, bool CaptureDiagnostics) {
664 if (!Diags.getPtr()) {
665 // No diagnostics engine was provided, so create our own diagnostics object
666 // with the default options.
David Blaikie78ad0b92011-09-25 23:39:51 +0000667 DiagnosticConsumer *Client = 0;
Douglas Gregore47be3e2010-11-11 00:39:14 +0000668 if (CaptureDiagnostics)
David Blaikie26e7a902011-09-26 00:01:39 +0000669 Client = new StoredDiagnosticConsumer(AST.StoredDiagnostics);
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000670 Diags = CompilerInstance::createDiagnostics(new DiagnosticOptions(),
Sean Silvad47afb92013-01-20 01:58:28 +0000671 Client,
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000672 /*ShouldOwnClient=*/true);
Douglas Gregore47be3e2010-11-11 00:39:14 +0000673 } else if (CaptureDiagnostics) {
David Blaikie26e7a902011-09-26 00:01:39 +0000674 Diags->setClient(new StoredDiagnosticConsumer(AST.StoredDiagnostics));
Douglas Gregore47be3e2010-11-11 00:39:14 +0000675 }
676}
677
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000678ASTUnit *ASTUnit::LoadFromASTFile(const std::string &Filename,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000679 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000680 const FileSystemOptions &FileSystemOpts,
Ted Kremenek5cf48762009-10-17 00:34:24 +0000681 bool OnlyLocalDecls,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000682 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +0000683 unsigned NumRemappedFiles,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000684 bool CaptureDiagnostics,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000685 bool AllowPCHWithCompilerErrors,
686 bool UserFilesAreVolatile) {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000687 OwningPtr<ASTUnit> AST(new ASTUnit(true));
Ted Kremenekb547eeb2011-03-18 02:06:56 +0000688
689 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +0000690 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
691 ASTUnitCleanup(AST.get());
David Blaikied6471f72011-09-25 23:23:43 +0000692 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
693 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Ted Kremenek25a11e12011-03-22 01:15:24 +0000694 DiagCleanup(Diags.getPtr());
Ted Kremenekb547eeb2011-03-18 02:06:56 +0000695
Douglas Gregor0b53cf82011-01-19 01:02:47 +0000696 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +0000697
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000698 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +0000699 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor28019772010-04-05 23:52:57 +0000700 AST->Diagnostics = Diags;
Ted Kremenek4f327862011-03-21 18:40:17 +0000701 AST->FileMgr = new FileManager(FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000702 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Ted Kremenek4f327862011-03-21 18:40:17 +0000703 AST->SourceMgr = new SourceManager(AST->getDiagnostics(),
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000704 AST->getFileManager(),
705 UserFilesAreVolatile);
Douglas Gregorc042edd2012-10-24 16:19:39 +0000706 AST->HSOpts = new HeaderSearchOptions();
707
708 AST->HeaderInfo.reset(new HeaderSearch(AST->HSOpts,
709 AST->getFileManager(),
Douglas Gregor51f564f2011-12-31 04:05:44 +0000710 AST->getDiagnostics(),
Douglas Gregordc58aa72012-01-30 06:01:29 +0000711 AST->ASTFileLangOpts,
712 /*Target=*/0));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000713
Douglas Gregor4db64a42010-01-23 00:14:00 +0000714 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000715 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
716 if (const llvm::MemoryBuffer *
717 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
718 // Create the file entry for the file that we're mapping from.
719 const FileEntry *FromFile
720 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
721 memBuf->getBufferSize(),
722 0);
723 if (!FromFile) {
724 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
725 << RemappedFiles[I].first;
726 delete memBuf;
727 continue;
728 }
729
730 // Override the contents of the "from" file with the contents of
731 // the "to" file.
732 AST->getSourceManager().overrideFileContents(FromFile, memBuf);
733
734 } else {
735 const char *fname = fileOrBuf.get<const char *>();
736 const FileEntry *ToFile = AST->FileMgr->getFile(fname);
737 if (!ToFile) {
738 AST->getDiagnostics().Report(diag::err_fe_remap_missing_to_file)
739 << RemappedFiles[I].first << fname;
740 continue;
741 }
742
743 // Create the file entry for the file that we're mapping from.
744 const FileEntry *FromFile
745 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
746 ToFile->getSize(),
747 0);
748 if (!FromFile) {
749 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
750 << RemappedFiles[I].first;
751 delete memBuf;
752 continue;
753 }
754
755 // Override the contents of the "from" file with the contents of
756 // the "to" file.
757 AST->getSourceManager().overrideFileContents(FromFile, ToFile);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000758 }
Douglas Gregor4db64a42010-01-23 00:14:00 +0000759 }
760
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000761 // Gather Info for preprocessor construction later on.
Mike Stump1eb44332009-09-09 15:08:12 +0000762
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000763 HeaderSearch &HeaderInfo = *AST->HeaderInfo.get();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000764 unsigned Counter;
765
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000766 OwningPtr<ASTReader> Reader;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000767
Douglas Gregor36a16492012-10-24 17:46:57 +0000768 AST->PP = new Preprocessor(new PreprocessorOptions(),
769 AST->getDiagnostics(), AST->ASTFileLangOpts,
Douglas Gregor998b3d32011-09-01 23:39:15 +0000770 /*Target=*/0, AST->getSourceManager(), HeaderInfo,
771 *AST,
772 /*IILookup=*/0,
773 /*OwnsHeaderSearch=*/false,
774 /*DelayInitialization=*/true);
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000775 Preprocessor &PP = *AST->PP;
776
777 AST->Ctx = new ASTContext(AST->ASTFileLangOpts,
778 AST->getSourceManager(),
779 /*Target=*/0,
780 PP.getIdentifierTable(),
781 PP.getSelectorTable(),
782 PP.getBuiltinInfo(),
783 /* size_reserve = */0,
784 /*DelayInitialization=*/true);
785 ASTContext &Context = *AST->Ctx;
Douglas Gregor998b3d32011-09-01 23:39:15 +0000786
Argyrios Kyrtzidis98e95bf2012-09-15 01:10:20 +0000787 bool disableValid = false;
788 if (::getenv("LIBCLANG_DISABLE_PCH_VALIDATION"))
789 disableValid = true;
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000790 Reader.reset(new ASTReader(PP, Context,
791 /*isysroot=*/"",
Argyrios Kyrtzidis98e95bf2012-09-15 01:10:20 +0000792 /*DisableValidation=*/disableValid,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000793 AllowPCHWithCompilerErrors));
Ted Kremenek8c647de2011-05-04 23:27:12 +0000794
795 // Recover resources if we crash before exiting this method.
796 llvm::CrashRecoveryContextCleanupRegistrar<ASTReader>
797 ReaderCleanup(Reader.get());
798
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000799 Reader->setListener(new ASTInfoCollector(*AST->PP, Context,
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000800 AST->ASTFileLangOpts,
Douglas Gregor9a022bb2012-10-15 16:45:32 +0000801 AST->TargetOpts, AST->Target,
Douglas Gregor43998902012-10-25 00:09:28 +0000802 Counter));
Daniel Dunbarcc318932009-09-03 05:59:35 +0000803
Douglas Gregor38295be2012-10-22 23:51:00 +0000804 switch (Reader->ReadAST(Filename, serialization::MK_MainFile,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +0000805 SourceLocation(), ASTReader::ARR_None)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000806 case ASTReader::Success:
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000807 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000808
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000809 case ASTReader::Failure:
Douglas Gregor677e15f2013-03-19 00:28:20 +0000810 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +0000811 case ASTReader::OutOfDate:
812 case ASTReader::VersionMismatch:
813 case ASTReader::ConfigurationMismatch:
814 case ASTReader::HadErrors:
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000815 AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000816 return NULL;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000817 }
Mike Stump1eb44332009-09-09 15:08:12 +0000818
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000819 AST->OriginalSourceFile = Reader->getOriginalSourceFile();
820
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000821 PP.setCounterValue(Counter);
Mike Stump1eb44332009-09-09 15:08:12 +0000822
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000823 // Attach the AST reader to the AST context as an external AST
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000824 // source, so that declarations will be deserialized from the
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000825 // AST file as needed.
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000826 ASTReader *ReaderPtr = Reader.get();
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000827 OwningPtr<ExternalASTSource> Source(Reader.take());
Ted Kremenek8c647de2011-05-04 23:27:12 +0000828
829 // Unregister the cleanup for ASTReader. It will get cleaned up
830 // by the ASTUnit cleanup.
831 ReaderCleanup.unregister();
832
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000833 Context.setExternalSource(Source);
834
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000835 // Create an AST consumer, even though it isn't used.
836 AST->Consumer.reset(new ASTConsumer);
837
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000838 // Create a semantic analysis object and tell the AST reader about it.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000839 AST->TheSema.reset(new Sema(PP, Context, *AST->Consumer));
840 AST->TheSema->Initialize();
841 ReaderPtr->InitializeSema(*AST->TheSema);
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +0000842 AST->Reader = ReaderPtr;
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000843
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000844 // Tell the diagnostic client that we have started a source file.
845 AST->getDiagnostics().getClient()->BeginSourceFile(Context.getLangOpts(),&PP);
846
Mike Stump1eb44332009-09-09 15:08:12 +0000847 return AST.take();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000848}
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000849
850namespace {
851
Douglas Gregor9b7db622011-02-16 18:16:54 +0000852/// \brief Preprocessor callback class that updates a hash value with the names
853/// of all macros that have been defined by the translation unit.
854class MacroDefinitionTrackerPPCallbacks : public PPCallbacks {
855 unsigned &Hash;
856
857public:
858 explicit MacroDefinitionTrackerPPCallbacks(unsigned &Hash) : Hash(Hash) { }
859
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000860 virtual void MacroDefined(const Token &MacroNameTok,
861 const MacroDirective *MD) {
Douglas Gregor9b7db622011-02-16 18:16:54 +0000862 Hash = llvm::HashString(MacroNameTok.getIdentifierInfo()->getName(), Hash);
863 }
864};
865
866/// \brief Add the given declaration to the hash of all top-level entities.
867void AddTopLevelDeclarationToHash(Decl *D, unsigned &Hash) {
868 if (!D)
869 return;
870
871 DeclContext *DC = D->getDeclContext();
872 if (!DC)
873 return;
874
875 if (!(DC->isTranslationUnit() || DC->getLookupParent()->isTranslationUnit()))
876 return;
877
878 if (NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
879 if (ND->getIdentifier())
880 Hash = llvm::HashString(ND->getIdentifier()->getName(), Hash);
881 else if (DeclarationName Name = ND->getDeclName()) {
882 std::string NameStr = Name.getAsString();
883 Hash = llvm::HashString(NameStr, Hash);
884 }
885 return;
Argyrios Kyrtzidis1f3ff6a2013-06-24 21:19:12 +0000886 }
887
888 if (ImportDecl *ImportD = dyn_cast<ImportDecl>(D)) {
889 if (Module *Mod = ImportD->getImportedModule()) {
890 std::string ModName = Mod->getFullModuleName();
891 Hash = llvm::HashString(ModName, Hash);
892 }
893 return;
894 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000895}
896
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000897class TopLevelDeclTrackerConsumer : public ASTConsumer {
898 ASTUnit &Unit;
Douglas Gregor9b7db622011-02-16 18:16:54 +0000899 unsigned &Hash;
900
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000901public:
Douglas Gregor9b7db622011-02-16 18:16:54 +0000902 TopLevelDeclTrackerConsumer(ASTUnit &_Unit, unsigned &Hash)
903 : Unit(_Unit), Hash(Hash) {
904 Hash = 0;
905 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000906
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000907 void handleTopLevelDecl(Decl *D) {
Argyrios Kyrtzidis35593a92011-11-16 02:35:10 +0000908 if (!D)
909 return;
910
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000911 // FIXME: Currently ObjC method declarations are incorrectly being
912 // reported as top-level declarations, even though their DeclContext
913 // is the containing ObjC @interface/@implementation. This is a
914 // fundamental problem in the parser right now.
915 if (isa<ObjCMethodDecl>(D))
916 return;
917
918 AddTopLevelDeclarationToHash(D, Hash);
919 Unit.addTopLevelDecl(D);
920
921 handleFileLevelDecl(D);
922 }
923
924 void handleFileLevelDecl(Decl *D) {
925 Unit.addFileLevelDecl(D);
926 if (NamespaceDecl *NSD = dyn_cast<NamespaceDecl>(D)) {
927 for (NamespaceDecl::decl_iterator
928 I = NSD->decls_begin(), E = NSD->decls_end(); I != E; ++I)
929 handleFileLevelDecl(*I);
Ted Kremenekda5a4282010-05-03 20:16:35 +0000930 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000931 }
Sebastian Redl27372b42010-08-11 18:52:41 +0000932
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +0000933 bool HandleTopLevelDecl(DeclGroupRef D) {
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000934 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it)
935 handleTopLevelDecl(*it);
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +0000936 return true;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000937 }
938
Sebastian Redl27372b42010-08-11 18:52:41 +0000939 // We're not interested in "interesting" decls.
940 void HandleInterestingDecl(DeclGroupRef) {}
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000941
942 void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
943 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it)
944 handleTopLevelDecl(*it);
945 }
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000946
Argyrios Kyrtzidis7eca8d22013-05-10 01:28:51 +0000947 virtual ASTMutationListener *GetASTMutationListener() {
948 return Unit.getASTMutationListener();
949 }
950
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000951 virtual ASTDeserializationListener *GetASTDeserializationListener() {
952 return Unit.getDeserializationListener();
953 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000954};
955
956class TopLevelDeclTrackerAction : public ASTFrontendAction {
957public:
958 ASTUnit &Unit;
959
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000960 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000961 StringRef InFile) {
Douglas Gregor9b7db622011-02-16 18:16:54 +0000962 CI.getPreprocessor().addPPCallbacks(
963 new MacroDefinitionTrackerPPCallbacks(Unit.getCurrentTopLevelHashValue()));
964 return new TopLevelDeclTrackerConsumer(Unit,
965 Unit.getCurrentTopLevelHashValue());
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000966 }
967
968public:
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000969 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
970
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000971 virtual bool hasCodeCompletionSupport() const { return false; }
Douglas Gregor467dc882011-08-25 22:30:56 +0000972 virtual TranslationUnitKind getTranslationUnitKind() {
973 return Unit.getTranslationUnitKind();
Douglas Gregordf95a132010-08-09 20:45:32 +0000974 }
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000975};
976
Benjamin Kramerb62b8b92013-06-11 13:07:19 +0000977class PrecompilePreambleAction : public ASTFrontendAction {
978 ASTUnit &Unit;
979 bool HasEmittedPreamblePCH;
980
981public:
982 explicit PrecompilePreambleAction(ASTUnit &Unit)
983 : Unit(Unit), HasEmittedPreamblePCH(false) {}
984
985 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
986 StringRef InFile);
987 bool hasEmittedPreamblePCH() const { return HasEmittedPreamblePCH; }
988 void setHasEmittedPreamblePCH() { HasEmittedPreamblePCH = true; }
989 virtual bool shouldEraseOutputFiles() { return !hasEmittedPreamblePCH(); }
990
991 virtual bool hasCodeCompletionSupport() const { return false; }
992 virtual bool hasASTFileSupport() const { return false; }
993 virtual TranslationUnitKind getTranslationUnitKind() { return TU_Prefix; }
994};
995
Argyrios Kyrtzidis92ddef12011-09-19 20:40:48 +0000996class PrecompilePreambleConsumer : public PCHGenerator {
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000997 ASTUnit &Unit;
Benjamin Kramerb62b8b92013-06-11 13:07:19 +0000998 unsigned &Hash;
Douglas Gregoreb8837b2010-08-03 19:06:41 +0000999 std::vector<Decl *> TopLevelDecls;
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001000 PrecompilePreambleAction *Action;
1001
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001002public:
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001003 PrecompilePreambleConsumer(ASTUnit &Unit, PrecompilePreambleAction *Action,
1004 const Preprocessor &PP, StringRef isysroot,
1005 raw_ostream *Out)
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001006 : PCHGenerator(PP, "", 0, isysroot, Out, /*AllowASTWithErrors=*/true),
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001007 Unit(Unit), Hash(Unit.getCurrentTopLevelHashValue()), Action(Action) {
Douglas Gregor9b7db622011-02-16 18:16:54 +00001008 Hash = 0;
1009 }
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001010
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +00001011 virtual bool HandleTopLevelDecl(DeclGroupRef D) {
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001012 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
1013 Decl *D = *it;
1014 // FIXME: Currently ObjC method declarations are incorrectly being
1015 // reported as top-level declarations, even though their DeclContext
1016 // is the containing ObjC @interface/@implementation. This is a
1017 // fundamental problem in the parser right now.
1018 if (isa<ObjCMethodDecl>(D))
1019 continue;
Douglas Gregor9b7db622011-02-16 18:16:54 +00001020 AddTopLevelDeclarationToHash(D, Hash);
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001021 TopLevelDecls.push_back(D);
1022 }
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +00001023 return true;
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001024 }
1025
1026 virtual void HandleTranslationUnit(ASTContext &Ctx) {
1027 PCHGenerator::HandleTranslationUnit(Ctx);
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001028 if (hasEmittedPCH()) {
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001029 // Translate the top-level declarations we captured during
1030 // parsing into declaration IDs in the precompiled
1031 // preamble. This will allow us to deserialize those top-level
1032 // declarations when requested.
1033 for (unsigned I = 0, N = TopLevelDecls.size(); I != N; ++I)
1034 Unit.addTopLevelDeclFromPreamble(
1035 getWriter().getDeclID(TopLevelDecls[I]));
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001036
1037 Action->setHasEmittedPreamblePCH();
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001038 }
1039 }
1040};
1041
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001042}
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001043
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001044ASTConsumer *PrecompilePreambleAction::CreateASTConsumer(CompilerInstance &CI,
1045 StringRef InFile) {
1046 std::string Sysroot;
1047 std::string OutputFile;
1048 raw_ostream *OS = 0;
1049 if (GeneratePCHAction::ComputeASTConsumerArguments(CI, InFile, Sysroot,
1050 OutputFile, OS))
1051 return 0;
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001052
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001053 if (!CI.getFrontendOpts().RelocatablePCH)
1054 Sysroot.clear();
Douglas Gregor832d6202011-07-22 16:35:34 +00001055
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001056 CI.getPreprocessor().addPPCallbacks(new MacroDefinitionTrackerPPCallbacks(
1057 Unit.getCurrentTopLevelHashValue()));
1058 return new PrecompilePreambleConsumer(Unit, this, CI.getPreprocessor(),
1059 Sysroot, OS);
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001060}
1061
Benjamin Kramerfe57db22013-05-05 12:39:28 +00001062static bool isNonDriverDiag(const StoredDiagnostic &StoredDiag) {
1063 return StoredDiag.getLocation().isValid();
1064}
1065
1066static void
1067checkAndRemoveNonDriverDiags(SmallVectorImpl<StoredDiagnostic> &StoredDiags) {
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001068 // Get rid of stored diagnostics except the ones from the driver which do not
1069 // have a source location.
Benjamin Kramerfe57db22013-05-05 12:39:28 +00001070 StoredDiags.erase(
1071 std::remove_if(StoredDiags.begin(), StoredDiags.end(), isNonDriverDiag),
1072 StoredDiags.end());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001073}
1074
1075static void checkAndSanitizeDiags(SmallVectorImpl<StoredDiagnostic> &
1076 StoredDiagnostics,
1077 SourceManager &SM) {
1078 // The stored diagnostic has the old source manager in it; update
1079 // the locations to refer into the new source manager. Since we've
1080 // been careful to make sure that the source manager's state
1081 // before and after are identical, so that we can reuse the source
1082 // location itself.
1083 for (unsigned I = 0, N = StoredDiagnostics.size(); I < N; ++I) {
1084 if (StoredDiagnostics[I].getLocation().isValid()) {
1085 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(), SM);
1086 StoredDiagnostics[I].setLocation(Loc);
1087 }
1088 }
1089}
1090
Douglas Gregorabc563f2010-07-19 21:46:24 +00001091/// Parse the source file into a translation unit using the given compiler
1092/// invocation, replacing the current translation unit.
1093///
1094/// \returns True if a failure occurred that causes the ASTUnit not to
1095/// contain any translation-unit information, false otherwise.
Douglas Gregor754f3492010-07-24 00:38:13 +00001096bool ASTUnit::Parse(llvm::MemoryBuffer *OverrideMainBuffer) {
Douglas Gregor28233422010-07-27 14:52:07 +00001097 delete SavedMainFileBuffer;
1098 SavedMainFileBuffer = 0;
1099
Ted Kremenek4f327862011-03-21 18:40:17 +00001100 if (!Invocation) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001101 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001102 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +00001103 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001104
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001105 // Create the compiler instance to use for building the AST.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001106 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001107
1108 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001109 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1110 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001111
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001112 IntrusiveRefCntPtr<CompilerInvocation>
Argyrios Kyrtzidis26d43cd2011-09-12 18:09:38 +00001113 CCInvocation(new CompilerInvocation(*Invocation));
1114
1115 Clang->setInvocation(CCInvocation.getPtr());
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001116 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregorabc563f2010-07-19 21:46:24 +00001117
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001118 // Set up diagnostics, capturing any diagnostics that would
1119 // otherwise be dropped.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001120 Clang->setDiagnostics(&getDiagnostics());
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001121
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001122 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001123 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001124 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00001125 if (!Clang->hasTarget()) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001126 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001127 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +00001128 }
1129
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001130 // Inform the target of the language options.
1131 //
1132 // FIXME: We shouldn't need to do this, the target should be immutable once
1133 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001134 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001135
Ted Kremenek03201fb2011-03-21 18:40:07 +00001136 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001137 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001138 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001139 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001140 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Daniel Dunbarfaddc3e2010-06-07 23:26:47 +00001141 "IR inputs not support here!");
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001142
Douglas Gregorabc563f2010-07-19 21:46:24 +00001143 // Configure the various subsystems.
1144 // FIXME: Should we retain the previous file manager?
Ted Kremenekd3b74d92011-11-17 23:01:24 +00001145 LangOpts = &Clang->getLangOpts();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001146 FileSystemOpts = Clang->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00001147 FileMgr = new FileManager(FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001148 SourceMgr = new SourceManager(getDiagnostics(), *FileMgr,
1149 UserFilesAreVolatile);
Douglas Gregor914ed9d2010-08-13 03:15:25 +00001150 TheSema.reset();
Ted Kremenek4f327862011-03-21 18:40:17 +00001151 Ctx = 0;
1152 PP = 0;
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +00001153 Reader = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001154
1155 // Clear out old caches and data.
1156 TopLevelDecls.clear();
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00001157 clearFileLevelDecls();
Douglas Gregorabc563f2010-07-19 21:46:24 +00001158 CleanTemporaryFiles();
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001159
Douglas Gregorf128fed2010-08-20 00:02:33 +00001160 if (!OverrideMainBuffer) {
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001161 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregorf128fed2010-08-20 00:02:33 +00001162 TopLevelDeclsInPreamble.clear();
1163 }
1164
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001165 // Create a file manager object to provide access to and cache the filesystem.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001166 Clang->setFileManager(&getFileManager());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001167
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001168 // Create the source manager.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001169 Clang->setSourceManager(&getSourceManager());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001170
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001171 // If the main file has been overridden due to the use of a preamble,
1172 // make that override happen and introduce the preamble.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001173 PreprocessorOptions &PreprocessorOpts = Clang->getPreprocessorOpts();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001174 if (OverrideMainBuffer) {
1175 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
1176 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
1177 PreprocessorOpts.PrecompiledPreambleBytes.second
1178 = PreambleEndsAtStartOfLine;
Ted Kremenek1872b312011-10-27 17:55:18 +00001179 PreprocessorOpts.ImplicitPCHInclude = getPreambleFile(this);
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001180 PreprocessorOpts.DisablePCHValidation = true;
Douglas Gregor28233422010-07-27 14:52:07 +00001181
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001182 // The stored diagnostic has the old source manager in it; update
1183 // the locations to refer into the new source manager. Since we've
1184 // been careful to make sure that the source manager's state
1185 // before and after are identical, so that we can reuse the source
1186 // location itself.
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001187 checkAndSanitizeDiags(StoredDiagnostics, getSourceManager());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001188
1189 // Keep track of the override buffer;
1190 SavedMainFileBuffer = OverrideMainBuffer;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001191 }
1192
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001193 OwningPtr<TopLevelDeclTrackerAction> Act(
Ted Kremenek25a11e12011-03-22 01:15:24 +00001194 new TopLevelDeclTrackerAction(*this));
1195
1196 // Recover resources if we crash before exiting this method.
1197 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1198 ActCleanup(Act.get());
1199
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00001200 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0]))
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001201 goto error;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001202
1203 if (OverrideMainBuffer) {
Ted Kremenek1872b312011-10-27 17:55:18 +00001204 std::string ModName = getPreambleFile(this);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001205 TranslateStoredDiagnostics(Clang->getModuleManager(), ModName,
1206 getSourceManager(), PreambleDiagnostics,
1207 StoredDiagnostics);
1208 }
1209
Argyrios Kyrtzidis374a00b2012-06-08 05:48:06 +00001210 if (!Act->Execute())
1211 goto error;
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001212
1213 transferASTDataFromCompilerInstance(*Clang);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001214
Daniel Dunbarf772d1e2009-12-04 08:17:33 +00001215 Act->EndSourceFile();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001216
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001217 FailedParseDiagnostics.clear();
1218
Douglas Gregorabc563f2010-07-19 21:46:24 +00001219 return false;
Ted Kremenek4f327862011-03-21 18:40:17 +00001220
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001221error:
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001222 // Remove the overridden buffer we used for the preamble.
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001223 if (OverrideMainBuffer) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001224 delete OverrideMainBuffer;
Douglas Gregor37cf6632010-10-06 21:11:08 +00001225 SavedMainFileBuffer = 0;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001226 }
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001227
1228 // Keep the ownership of the data in the ASTUnit because the client may
1229 // want to see the diagnostics.
1230 transferASTDataFromCompilerInstance(*Clang);
1231 FailedParseDiagnostics.swap(StoredDiagnostics);
Douglas Gregord54eb442010-10-12 16:25:54 +00001232 StoredDiagnostics.clear();
Argyrios Kyrtzidis3e9d3262011-10-24 17:25:20 +00001233 NumStoredDiagnosticsFromDriver = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001234 return true;
1235}
1236
Douglas Gregor44c181a2010-07-23 00:33:23 +00001237/// \brief Simple function to retrieve a path for a preamble precompiled header.
1238static std::string GetPreamblePCHPath() {
Douglas Gregor424668c2010-09-11 18:05:19 +00001239 // FIXME: This is a hack so that we can override the preamble file during
1240 // crash-recovery testing, which is the only case where the preamble files
Rafael Espindola85d28482013-06-26 04:02:37 +00001241 // are not necessarily cleaned up.
Douglas Gregor424668c2010-09-11 18:05:19 +00001242 const char *TmpFile = ::getenv("CINDEXTEST_PREAMBLE_FILE");
1243 if (TmpFile)
1244 return TmpFile;
Rafael Espindola85d28482013-06-26 04:02:37 +00001245
1246 SmallString<128> Path;
Rafael Espindola1ec4a862013-07-05 20:00:06 +00001247 llvm::sys::fs::createTemporaryFile("preamble", "pch", Path);
Rafael Espindola85d28482013-06-26 04:02:37 +00001248
1249 return Path.str();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001250}
1251
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001252/// \brief Compute the preamble for the main file, providing the source buffer
1253/// that corresponds to the main file along with a pair (bytes, start-of-line)
1254/// that describes the preamble.
1255std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
Douglas Gregordf95a132010-08-09 20:45:32 +00001256ASTUnit::ComputePreamble(CompilerInvocation &Invocation,
1257 unsigned MaxLines, bool &CreatedBuffer) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001258 FrontendOptions &FrontendOpts = Invocation.getFrontendOpts();
Chris Lattner39b49bc2010-11-23 08:35:12 +00001259 PreprocessorOptions &PreprocessorOpts = Invocation.getPreprocessorOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001260 CreatedBuffer = false;
1261
Douglas Gregor44c181a2010-07-23 00:33:23 +00001262 // Try to determine if the main file has been remapped, either from the
1263 // command line (to another file) or directly through the compiler invocation
1264 // (to a memory buffer).
Douglas Gregor175c4a92010-07-23 23:58:40 +00001265 llvm::MemoryBuffer *Buffer = 0;
Rafael Espindola105b2072013-06-18 19:40:07 +00001266 std::string MainFilePath(FrontendOpts.Inputs[0].getFile());
Rafael Espindola44888352013-07-29 21:26:52 +00001267 llvm::sys::fs::UniqueID MainFileID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001268 if (!llvm::sys::fs::getUniqueID(MainFilePath, MainFileID)) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001269 // Check whether there is a file-file remapping of the main file
1270 for (PreprocessorOptions::remapped_file_iterator
Douglas Gregor175c4a92010-07-23 23:58:40 +00001271 M = PreprocessorOpts.remapped_file_begin(),
1272 E = PreprocessorOpts.remapped_file_end();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001273 M != E;
1274 ++M) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001275 std::string MPath(M->first);
Rafael Espindola44888352013-07-29 21:26:52 +00001276 llvm::sys::fs::UniqueID MID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001277 if (!llvm::sys::fs::getUniqueID(MPath, MID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001278 if (MainFileID == MID) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001279 // We found a remapping. Try to load the resulting, remapped source.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001280 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001281 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001282 CreatedBuffer = false;
1283 }
1284
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00001285 Buffer = getBufferForFile(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001286 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001287 return std::make_pair((llvm::MemoryBuffer*)0,
1288 std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001289 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001290 }
1291 }
1292 }
1293
1294 // Check whether there is a file-buffer remapping. It supercedes the
1295 // file-file remapping.
1296 for (PreprocessorOptions::remapped_file_buffer_iterator
1297 M = PreprocessorOpts.remapped_file_buffer_begin(),
1298 E = PreprocessorOpts.remapped_file_buffer_end();
1299 M != E;
1300 ++M) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001301 std::string MPath(M->first);
Rafael Espindola44888352013-07-29 21:26:52 +00001302 llvm::sys::fs::UniqueID MID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001303 if (!llvm::sys::fs::getUniqueID(MPath, MID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001304 if (MainFileID == MID) {
1305 // We found a remapping.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001306 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001307 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001308 CreatedBuffer = false;
1309 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001310
Douglas Gregor175c4a92010-07-23 23:58:40 +00001311 Buffer = const_cast<llvm::MemoryBuffer *>(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001312 }
1313 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001314 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001315 }
1316
1317 // If the main source file was not remapped, load it now.
1318 if (!Buffer) {
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001319 Buffer = getBufferForFile(FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001320 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001321 return std::make_pair((llvm::MemoryBuffer*)0, std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001322
1323 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001324 }
1325
Argyrios Kyrtzidis03c107a2011-08-25 20:39:19 +00001326 return std::make_pair(Buffer, Lexer::ComputePreamble(Buffer,
Ted Kremenekd3b74d92011-11-17 23:01:24 +00001327 *Invocation.getLangOpts(),
Argyrios Kyrtzidis03c107a2011-08-25 20:39:19 +00001328 MaxLines));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001329}
1330
Douglas Gregor754f3492010-07-24 00:38:13 +00001331static llvm::MemoryBuffer *CreatePaddedMainFileBuffer(llvm::MemoryBuffer *Old,
Douglas Gregor754f3492010-07-24 00:38:13 +00001332 unsigned NewSize,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001333 StringRef NewName) {
Douglas Gregor754f3492010-07-24 00:38:13 +00001334 llvm::MemoryBuffer *Result
1335 = llvm::MemoryBuffer::getNewUninitMemBuffer(NewSize, NewName);
1336 memcpy(const_cast<char*>(Result->getBufferStart()),
1337 Old->getBufferStart(), Old->getBufferSize());
1338 memset(const_cast<char*>(Result->getBufferStart()) + Old->getBufferSize(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001339 ' ', NewSize - Old->getBufferSize() - 1);
1340 const_cast<char*>(Result->getBufferEnd())[-1] = '\n';
Douglas Gregor754f3492010-07-24 00:38:13 +00001341
Douglas Gregor754f3492010-07-24 00:38:13 +00001342 return Result;
1343}
1344
Douglas Gregor175c4a92010-07-23 23:58:40 +00001345/// \brief Attempt to build or re-use a precompiled preamble when (re-)parsing
1346/// the source file.
1347///
1348/// This routine will compute the preamble of the main source file. If a
1349/// non-trivial preamble is found, it will precompile that preamble into a
1350/// precompiled header so that the precompiled preamble can be used to reduce
1351/// reparsing time. If a precompiled preamble has already been constructed,
1352/// this routine will determine if it is still valid and, if so, avoid
1353/// rebuilding the precompiled preamble.
1354///
Douglas Gregordf95a132010-08-09 20:45:32 +00001355/// \param AllowRebuild When true (the default), this routine is
1356/// allowed to rebuild the precompiled preamble if it is found to be
1357/// out-of-date.
1358///
1359/// \param MaxLines When non-zero, the maximum number of lines that
1360/// can occur within the preamble.
1361///
Douglas Gregor754f3492010-07-24 00:38:13 +00001362/// \returns If the precompiled preamble can be used, returns a newly-allocated
1363/// buffer that should be used in place of the main file when doing so.
1364/// Otherwise, returns a NULL pointer.
Douglas Gregordf95a132010-08-09 20:45:32 +00001365llvm::MemoryBuffer *ASTUnit::getMainBufferWithPrecompiledPreamble(
Douglas Gregor01b6e312011-07-01 18:22:13 +00001366 const CompilerInvocation &PreambleInvocationIn,
Douglas Gregordf95a132010-08-09 20:45:32 +00001367 bool AllowRebuild,
1368 unsigned MaxLines) {
Douglas Gregor01b6e312011-07-01 18:22:13 +00001369
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001370 IntrusiveRefCntPtr<CompilerInvocation>
Douglas Gregor01b6e312011-07-01 18:22:13 +00001371 PreambleInvocation(new CompilerInvocation(PreambleInvocationIn));
1372 FrontendOptions &FrontendOpts = PreambleInvocation->getFrontendOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001373 PreprocessorOptions &PreprocessorOpts
Douglas Gregor01b6e312011-07-01 18:22:13 +00001374 = PreambleInvocation->getPreprocessorOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001375
1376 bool CreatedPreambleBuffer = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001377 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > NewPreamble
Douglas Gregor01b6e312011-07-01 18:22:13 +00001378 = ComputePreamble(*PreambleInvocation, MaxLines, CreatedPreambleBuffer);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001379
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001380 // If ComputePreamble() Take ownership of the preamble buffer.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001381 OwningPtr<llvm::MemoryBuffer> OwnedPreambleBuffer;
Douglas Gregor73fc9122010-11-16 20:45:51 +00001382 if (CreatedPreambleBuffer)
1383 OwnedPreambleBuffer.reset(NewPreamble.first);
1384
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001385 if (!NewPreamble.second.first) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001386 // We couldn't find a preamble in the main source. Clear out the current
1387 // preamble, if we have one. It's obviously no good any more.
1388 Preamble.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +00001389 erasePreambleFile(this);
Douglas Gregoreababfb2010-08-04 05:53:38 +00001390
1391 // The next time we actually see a preamble, precompile it.
1392 PreambleRebuildCounter = 1;
Douglas Gregor754f3492010-07-24 00:38:13 +00001393 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001394 }
1395
1396 if (!Preamble.empty()) {
1397 // We've previously computed a preamble. Check whether we have the same
1398 // preamble now that we did before, and that there's enough space in
1399 // the main-file buffer within the precompiled preamble to fit the
1400 // new main file.
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001401 if (Preamble.size() == NewPreamble.second.first &&
1402 PreambleEndsAtStartOfLine == NewPreamble.second.second &&
Douglas Gregor592508e2010-07-24 00:42:07 +00001403 NewPreamble.first->getBufferSize() < PreambleReservedSize-2 &&
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001404 memcmp(Preamble.getBufferStart(), NewPreamble.first->getBufferStart(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001405 NewPreamble.second.first) == 0) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001406 // The preamble has not changed. We may be able to re-use the precompiled
1407 // preamble.
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001408
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001409 // Check that none of the files used by the preamble have changed.
1410 bool AnyFileChanged = false;
1411
1412 // First, make a record of those files that have been overridden via
1413 // remapping or unsaved_files.
1414 llvm::StringMap<std::pair<off_t, time_t> > OverriddenFiles;
1415 for (PreprocessorOptions::remapped_file_iterator
1416 R = PreprocessorOpts.remapped_file_begin(),
1417 REnd = PreprocessorOpts.remapped_file_end();
1418 !AnyFileChanged && R != REnd;
1419 ++R) {
Rafael Espindolaaefb1d32013-07-29 18:22:23 +00001420 llvm::sys::fs::file_status Status;
1421 if (FileMgr->getNoncachedStatValue(R->second, Status)) {
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001422 // If we can't stat the file we're remapping to, assume that something
1423 // horrible happened.
1424 AnyFileChanged = true;
1425 break;
1426 }
Rafael Espindolaaefb1d32013-07-29 18:22:23 +00001427
1428 OverriddenFiles[R->first] = std::make_pair(
1429 Status.getSize(), Status.getLastModificationTime().toEpochTime());
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001430 }
1431 for (PreprocessorOptions::remapped_file_buffer_iterator
1432 R = PreprocessorOpts.remapped_file_buffer_begin(),
1433 REnd = PreprocessorOpts.remapped_file_buffer_end();
1434 !AnyFileChanged && R != REnd;
1435 ++R) {
1436 // FIXME: Should we actually compare the contents of file->buffer
1437 // remappings?
1438 OverriddenFiles[R->first] = std::make_pair(R->second->getBufferSize(),
1439 0);
1440 }
1441
1442 // Check whether anything has changed.
1443 for (llvm::StringMap<std::pair<off_t, time_t> >::iterator
1444 F = FilesInPreamble.begin(), FEnd = FilesInPreamble.end();
1445 !AnyFileChanged && F != FEnd;
1446 ++F) {
1447 llvm::StringMap<std::pair<off_t, time_t> >::iterator Overridden
1448 = OverriddenFiles.find(F->first());
1449 if (Overridden != OverriddenFiles.end()) {
1450 // This file was remapped; check whether the newly-mapped file
1451 // matches up with the previous mapping.
1452 if (Overridden->second != F->second)
1453 AnyFileChanged = true;
1454 continue;
1455 }
1456
1457 // The file was not remapped; check whether it has changed on disk.
Rafael Espindolaaefb1d32013-07-29 18:22:23 +00001458 llvm::sys::fs::file_status Status;
1459 if (FileMgr->getNoncachedStatValue(F->first(), Status)) {
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001460 // If we can't stat the file, assume that something horrible happened.
1461 AnyFileChanged = true;
Rafael Espindolaaefb1d32013-07-29 18:22:23 +00001462 } else if (Status.getSize() != uint64_t(F->second.first) ||
1463 Status.getLastModificationTime().toEpochTime() !=
1464 uint64_t(F->second.second))
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001465 AnyFileChanged = true;
1466 }
1467
1468 if (!AnyFileChanged) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001469 // Okay! We can re-use the precompiled preamble.
1470
1471 // Set the state of the diagnostic object to mimic its state
1472 // after parsing the preamble.
1473 getDiagnostics().Reset();
Douglas Gregor32be4a52010-10-11 21:37:58 +00001474 ProcessWarningOptions(getDiagnostics(),
Douglas Gregor01b6e312011-07-01 18:22:13 +00001475 PreambleInvocation->getDiagnosticOpts());
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001476 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001477
1478 // Create a version of the main file buffer that is padded to
1479 // buffer size we reserved when creating the preamble.
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001480 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001481 PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001482 FrontendOpts.Inputs[0].getFile());
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001483 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001484 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001485
1486 // If we aren't allowed to rebuild the precompiled preamble, just
1487 // return now.
1488 if (!AllowRebuild)
1489 return 0;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001490
Douglas Gregor175c4a92010-07-23 23:58:40 +00001491 // We can't reuse the previously-computed preamble. Build a new one.
1492 Preamble.clear();
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001493 PreambleDiagnostics.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +00001494 erasePreambleFile(this);
Douglas Gregoreababfb2010-08-04 05:53:38 +00001495 PreambleRebuildCounter = 1;
Douglas Gregordf95a132010-08-09 20:45:32 +00001496 } else if (!AllowRebuild) {
1497 // We aren't allowed to rebuild the precompiled preamble; just
1498 // return now.
1499 return 0;
1500 }
Douglas Gregoreababfb2010-08-04 05:53:38 +00001501
1502 // If the preamble rebuild counter > 1, it's because we previously
1503 // failed to build a preamble and we're not yet ready to try
1504 // again. Decrement the counter and return a failure.
1505 if (PreambleRebuildCounter > 1) {
1506 --PreambleRebuildCounter;
1507 return 0;
1508 }
1509
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001510 // Create a temporary file for the precompiled preamble. In rare
1511 // circumstances, this can fail.
1512 std::string PreamblePCHPath = GetPreamblePCHPath();
1513 if (PreamblePCHPath.empty()) {
1514 // Try again next time.
1515 PreambleRebuildCounter = 1;
1516 return 0;
1517 }
1518
Douglas Gregor175c4a92010-07-23 23:58:40 +00001519 // We did not previously compute a preamble, or it can't be reused anyway.
Douglas Gregor213f18b2010-10-28 15:44:59 +00001520 SimpleTimer PreambleTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001521 PreambleTimer.setOutput("Precompiling preamble");
Douglas Gregor44c181a2010-07-23 00:33:23 +00001522
1523 // Create a new buffer that stores the preamble. The buffer also contains
1524 // extra space for the original contents of the file (which will be present
1525 // when we actually parse the file) along with more room in case the file
Douglas Gregor175c4a92010-07-23 23:58:40 +00001526 // grows.
1527 PreambleReservedSize = NewPreamble.first->getBufferSize();
1528 if (PreambleReservedSize < 4096)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001529 PreambleReservedSize = 8191;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001530 else
Douglas Gregor175c4a92010-07-23 23:58:40 +00001531 PreambleReservedSize *= 2;
1532
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001533 // Save the preamble text for later; we'll need to compare against it for
1534 // subsequent reparses.
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001535 StringRef MainFilename = PreambleInvocation->getFrontendOpts().Inputs[0].getFile();
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001536 Preamble.assign(FileMgr->getFile(MainFilename),
1537 NewPreamble.first->getBufferStart(),
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001538 NewPreamble.first->getBufferStart()
1539 + NewPreamble.second.first);
1540 PreambleEndsAtStartOfLine = NewPreamble.second.second;
1541
Douglas Gregor671947b2010-08-19 01:33:06 +00001542 delete PreambleBuffer;
1543 PreambleBuffer
Douglas Gregor175c4a92010-07-23 23:58:40 +00001544 = llvm::MemoryBuffer::getNewUninitMemBuffer(PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001545 FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001546 memcpy(const_cast<char*>(PreambleBuffer->getBufferStart()),
Douglas Gregor175c4a92010-07-23 23:58:40 +00001547 NewPreamble.first->getBufferStart(), Preamble.size());
1548 memset(const_cast<char*>(PreambleBuffer->getBufferStart()) + Preamble.size(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001549 ' ', PreambleReservedSize - Preamble.size() - 1);
1550 const_cast<char*>(PreambleBuffer->getBufferEnd())[-1] = '\n';
Rafael Espindola1cd7df42013-06-26 04:12:57 +00001551
Douglas Gregor44c181a2010-07-23 00:33:23 +00001552 // Remap the main source file to the preamble buffer.
Rafael Espindola1cd7df42013-06-26 04:12:57 +00001553 StringRef MainFilePath = FrontendOpts.Inputs[0].getFile();
1554 PreprocessorOpts.addRemappedFile(MainFilePath, PreambleBuffer);
1555
Douglas Gregor44c181a2010-07-23 00:33:23 +00001556 // Tell the compiler invocation to generate a temporary precompiled header.
1557 FrontendOpts.ProgramAction = frontend::GeneratePCH;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001558 // FIXME: Generate the precompiled header into memory?
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001559 FrontendOpts.OutputFile = PreamblePCHPath;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001560 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
1561 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001562
1563 // Create the compiler instance to use for building the precompiled preamble.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001564 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001565
1566 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001567 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1568 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001569
Douglas Gregor01b6e312011-07-01 18:22:13 +00001570 Clang->setInvocation(&*PreambleInvocation);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001571 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001572
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001573 // Set up diagnostics, capturing all of the diagnostics produced.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001574 Clang->setDiagnostics(&getDiagnostics());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001575
1576 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001577 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001578 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00001579 if (!Clang->hasTarget()) {
Rafael Espindola21b18242013-06-26 04:26:38 +00001580 llvm::sys::fs::remove(FrontendOpts.OutputFile);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001581 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001582 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001583 PreprocessorOpts.eraseRemappedFile(
1584 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001585 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001586 }
1587
1588 // Inform the target of the language options.
1589 //
1590 // FIXME: We shouldn't need to do this, the target should be immutable once
1591 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001592 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001593
Ted Kremenek03201fb2011-03-21 18:40:07 +00001594 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001595 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001596 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001597 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001598 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001599 "IR inputs not support here!");
1600
1601 // Clear out old caches and data.
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001602 getDiagnostics().Reset();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001603 ProcessWarningOptions(getDiagnostics(), Clang->getDiagnosticOpts());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001604 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001605 TopLevelDecls.clear();
1606 TopLevelDeclsInPreamble.clear();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001607
1608 // Create a file manager object to provide access to and cache the filesystem.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001609 Clang->setFileManager(new FileManager(Clang->getFileSystemOpts()));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001610
1611 // Create the source manager.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001612 Clang->setSourceManager(new SourceManager(getDiagnostics(),
Ted Kremenek4f327862011-03-21 18:40:17 +00001613 Clang->getFileManager()));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001614
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001615 OwningPtr<PrecompilePreambleAction> Act;
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001616 Act.reset(new PrecompilePreambleAction(*this));
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00001617 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
Rafael Espindola21b18242013-06-26 04:26:38 +00001618 llvm::sys::fs::remove(FrontendOpts.OutputFile);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001619 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001620 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001621 PreprocessorOpts.eraseRemappedFile(
1622 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001623 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001624 }
1625
1626 Act->Execute();
1627 Act->EndSourceFile();
Ted Kremenek4f327862011-03-21 18:40:17 +00001628
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001629 if (!Act->hasEmittedPreamblePCH()) {
Argyrios Kyrtzidis739f9e52013-06-11 16:42:34 +00001630 // The preamble PCH failed (e.g. there was a module loading fatal error),
1631 // so no precompiled header was generated. Forget that we even tried.
Douglas Gregor06e50442010-09-27 16:43:25 +00001632 // FIXME: Should we leave a note for ourselves to try again?
Rafael Espindola21b18242013-06-26 04:26:38 +00001633 llvm::sys::fs::remove(FrontendOpts.OutputFile);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001634 Preamble.clear();
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001635 TopLevelDeclsInPreamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001636 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001637 PreprocessorOpts.eraseRemappedFile(
1638 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001639 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001640 }
1641
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001642 // Transfer any diagnostics generated when parsing the preamble into the set
1643 // of preamble diagnostics.
1644 PreambleDiagnostics.clear();
1645 PreambleDiagnostics.insert(PreambleDiagnostics.end(),
Argyrios Kyrtzidis3e9d3262011-10-24 17:25:20 +00001646 stored_diag_afterDriver_begin(), stored_diag_end());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001647 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001648
Douglas Gregor175c4a92010-07-23 23:58:40 +00001649 // Keep track of the preamble we precompiled.
Ted Kremenek1872b312011-10-27 17:55:18 +00001650 setPreambleFile(this, FrontendOpts.OutputFile);
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001651 NumWarningsInPreamble = getDiagnostics().getNumWarnings();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001652
1653 // Keep track of all of the files that the source manager knows about,
1654 // so we can verify whether they have changed or not.
1655 FilesInPreamble.clear();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001656 SourceManager &SourceMgr = Clang->getSourceManager();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001657 const llvm::MemoryBuffer *MainFileBuffer
1658 = SourceMgr.getBuffer(SourceMgr.getMainFileID());
1659 for (SourceManager::fileinfo_iterator F = SourceMgr.fileinfo_begin(),
1660 FEnd = SourceMgr.fileinfo_end();
1661 F != FEnd;
1662 ++F) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001663 const FileEntry *File = F->second->OrigEntry;
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001664 if (!File || F->second->getRawBuffer() == MainFileBuffer)
1665 continue;
1666
1667 FilesInPreamble[File->getName()]
1668 = std::make_pair(F->second->getSize(), File->getModificationTime());
1669 }
1670
Douglas Gregoreababfb2010-08-04 05:53:38 +00001671 PreambleRebuildCounter = 1;
Douglas Gregor671947b2010-08-19 01:33:06 +00001672 PreprocessorOpts.eraseRemappedFile(
1673 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor9b7db622011-02-16 18:16:54 +00001674
1675 // If the hash of top-level entities differs from the hash of the top-level
1676 // entities the last time we rebuilt the preamble, clear out the completion
1677 // cache.
1678 if (CurrentTopLevelHashValue != PreambleTopLevelHashValue) {
1679 CompletionCacheTopLevelHashValue = 0;
1680 PreambleTopLevelHashValue = CurrentTopLevelHashValue;
1681 }
1682
Douglas Gregor754f3492010-07-24 00:38:13 +00001683 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregor754f3492010-07-24 00:38:13 +00001684 PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001685 FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001686}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001687
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001688void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1689 std::vector<Decl *> Resolved;
1690 Resolved.reserve(TopLevelDeclsInPreamble.size());
1691 ExternalASTSource &Source = *getASTContext().getExternalSource();
1692 for (unsigned I = 0, N = TopLevelDeclsInPreamble.size(); I != N; ++I) {
1693 // Resolve the declaration ID to an actual declaration, possibly
1694 // deserializing the declaration in the process.
1695 Decl *D = Source.GetExternalDecl(TopLevelDeclsInPreamble[I]);
1696 if (D)
1697 Resolved.push_back(D);
1698 }
1699 TopLevelDeclsInPreamble.clear();
1700 TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1701}
1702
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001703void ASTUnit::transferASTDataFromCompilerInstance(CompilerInstance &CI) {
1704 // Steal the created target, context, and preprocessor.
1705 TheSema.reset(CI.takeSema());
1706 Consumer.reset(CI.takeASTConsumer());
1707 Ctx = &CI.getASTContext();
1708 PP = &CI.getPreprocessor();
1709 CI.setSourceManager(0);
1710 CI.setFileManager(0);
1711 Target = &CI.getTarget();
1712 Reader = CI.getModuleManager();
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001713 HadModuleLoaderFatalFailure = CI.hadModuleLoaderFatalFailure();
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001714}
1715
Chris Lattner5f9e2722011-07-23 10:55:15 +00001716StringRef ASTUnit::getMainFileName() const {
Argyrios Kyrtzidis814b51a2013-01-11 22:11:14 +00001717 if (Invocation && !Invocation->getFrontendOpts().Inputs.empty()) {
1718 const FrontendInputFile &Input = Invocation->getFrontendOpts().Inputs[0];
1719 if (Input.isFile())
1720 return Input.getFile();
1721 else
1722 return Input.getBuffer()->getBufferIdentifier();
1723 }
1724
1725 if (SourceMgr) {
1726 if (const FileEntry *
1727 FE = SourceMgr->getFileEntryForID(SourceMgr->getMainFileID()))
1728 return FE->getName();
1729 }
1730
1731 return StringRef();
Douglas Gregor213f18b2010-10-28 15:44:59 +00001732}
1733
Argyrios Kyrtzidis44f65a52013-03-05 20:21:14 +00001734StringRef ASTUnit::getASTFileName() const {
1735 if (!isMainFileAST())
1736 return StringRef();
1737
1738 serialization::ModuleFile &
1739 Mod = Reader->getModuleManager().getPrimaryModule();
1740 return Mod.FileName;
1741}
1742
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001743ASTUnit *ASTUnit::create(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001744 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001745 bool CaptureDiagnostics,
1746 bool UserFilesAreVolatile) {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001747 OwningPtr<ASTUnit> AST;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001748 AST.reset(new ASTUnit(false));
Argyrios Kyrtzidis991bf492011-11-28 04:55:55 +00001749 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001750 AST->Diagnostics = Diags;
Ted Kremenek4f327862011-03-21 18:40:17 +00001751 AST->Invocation = CI;
Anders Carlsson0d8d7e62011-03-18 18:22:40 +00001752 AST->FileSystemOpts = CI->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00001753 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001754 AST->UserFilesAreVolatile = UserFilesAreVolatile;
1755 AST->SourceMgr = new SourceManager(AST->getDiagnostics(), *AST->FileMgr,
1756 UserFilesAreVolatile);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001757
1758 return AST.take();
1759}
1760
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001761ASTUnit *ASTUnit::LoadFromCompilerInvocationAction(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001762 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001763 ASTFrontendAction *Action,
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001764 ASTUnit *Unit,
1765 bool Persistent,
1766 StringRef ResourceFilesPath,
1767 bool OnlyLocalDecls,
1768 bool CaptureDiagnostics,
1769 bool PrecompilePreamble,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001770 bool CacheCodeCompletionResults,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001771 bool IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001772 bool UserFilesAreVolatile,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001773 OwningPtr<ASTUnit> *ErrAST) {
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001774 assert(CI && "A CompilerInvocation is required");
1775
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001776 OwningPtr<ASTUnit> OwnAST;
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001777 ASTUnit *AST = Unit;
1778 if (!AST) {
1779 // Create the AST unit.
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001780 OwnAST.reset(create(CI, Diags, CaptureDiagnostics, UserFilesAreVolatile));
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001781 AST = OwnAST.get();
1782 }
1783
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001784 if (!ResourceFilesPath.empty()) {
1785 // Override the resources path.
1786 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
1787 }
1788 AST->OnlyLocalDecls = OnlyLocalDecls;
1789 AST->CaptureDiagnostics = CaptureDiagnostics;
1790 if (PrecompilePreamble)
1791 AST->PreambleRebuildCounter = 2;
Douglas Gregor467dc882011-08-25 22:30:56 +00001792 AST->TUKind = Action ? Action->getTranslationUnitKind() : TU_Complete;
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001793 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001794 AST->IncludeBriefCommentsInCodeCompletion
1795 = IncludeBriefCommentsInCodeCompletion;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001796
1797 // Recover resources if we crash before exiting this method.
1798 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001799 ASTUnitCleanup(OwnAST.get());
David Blaikied6471f72011-09-25 23:23:43 +00001800 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1801 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001802 DiagCleanup(Diags.getPtr());
1803
1804 // We'll manage file buffers ourselves.
1805 CI->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1806 CI->getFrontendOpts().DisableFree = false;
1807 ProcessWarningOptions(AST->getDiagnostics(), CI->getDiagnosticOpts());
1808
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001809 // Create the compiler instance to use for building the AST.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001810 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001811
1812 // Recover resources if we crash before exiting this method.
1813 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1814 CICleanup(Clang.get());
1815
1816 Clang->setInvocation(CI);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001817 AST->OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001818
1819 // Set up diagnostics, capturing any diagnostics that would
1820 // otherwise be dropped.
1821 Clang->setDiagnostics(&AST->getDiagnostics());
1822
1823 // Create the target instance.
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001824 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001825 &Clang->getTargetOpts()));
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001826 if (!Clang->hasTarget())
1827 return 0;
1828
1829 // Inform the target of the language options.
1830 //
1831 // FIXME: We shouldn't need to do this, the target should be immutable once
1832 // created. This complexity should be lifted elsewhere.
1833 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
1834
1835 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1836 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001837 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001838 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001839 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001840 "IR inputs not supported here!");
1841
1842 // Configure the various subsystems.
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001843 AST->TheSema.reset();
1844 AST->Ctx = 0;
1845 AST->PP = 0;
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +00001846 AST->Reader = 0;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001847
1848 // Create a file manager object to provide access to and cache the filesystem.
1849 Clang->setFileManager(&AST->getFileManager());
1850
1851 // Create the source manager.
1852 Clang->setSourceManager(&AST->getSourceManager());
1853
1854 ASTFrontendAction *Act = Action;
1855
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001856 OwningPtr<TopLevelDeclTrackerAction> TrackerAct;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001857 if (!Act) {
1858 TrackerAct.reset(new TopLevelDeclTrackerAction(*AST));
1859 Act = TrackerAct.get();
1860 }
1861
1862 // Recover resources if we crash before exiting this method.
1863 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1864 ActCleanup(TrackerAct.get());
1865
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001866 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
1867 AST->transferASTDataFromCompilerInstance(*Clang);
1868 if (OwnAST && ErrAST)
1869 ErrAST->swap(OwnAST);
1870
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001871 return 0;
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001872 }
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001873
1874 if (Persistent && !TrackerAct) {
1875 Clang->getPreprocessor().addPPCallbacks(
1876 new MacroDefinitionTrackerPPCallbacks(AST->getCurrentTopLevelHashValue()));
1877 std::vector<ASTConsumer*> Consumers;
1878 if (Clang->hasASTConsumer())
1879 Consumers.push_back(Clang->takeASTConsumer());
1880 Consumers.push_back(new TopLevelDeclTrackerConsumer(*AST,
1881 AST->getCurrentTopLevelHashValue()));
1882 Clang->setASTConsumer(new MultiplexConsumer(Consumers));
1883 }
Argyrios Kyrtzidis374a00b2012-06-08 05:48:06 +00001884 if (!Act->Execute()) {
1885 AST->transferASTDataFromCompilerInstance(*Clang);
1886 if (OwnAST && ErrAST)
1887 ErrAST->swap(OwnAST);
1888
1889 return 0;
1890 }
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001891
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001892 // Steal the created target, context, and preprocessor.
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001893 AST->transferASTDataFromCompilerInstance(*Clang);
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001894
1895 Act->EndSourceFile();
1896
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001897 if (OwnAST)
1898 return OwnAST.take();
1899 else
1900 return AST;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001901}
1902
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001903bool ASTUnit::LoadFromCompilerInvocation(bool PrecompilePreamble) {
1904 if (!Invocation)
1905 return true;
1906
1907 // We'll manage file buffers ourselves.
1908 Invocation->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1909 Invocation->getFrontendOpts().DisableFree = false;
Douglas Gregor0b53cf82011-01-19 01:02:47 +00001910 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001911
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001912 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregor99ba2022010-10-27 17:24:53 +00001913 if (PrecompilePreamble) {
Douglas Gregor08bb4c62010-11-15 23:00:34 +00001914 PreambleRebuildCounter = 2;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001915 OverrideMainBuffer
1916 = getMainBufferWithPrecompiledPreamble(*Invocation);
1917 }
1918
Douglas Gregor213f18b2010-10-28 15:44:59 +00001919 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001920 ParsingTimer.setOutput("Parsing " + getMainFileName());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001921
Ted Kremenek25a11e12011-03-22 01:15:24 +00001922 // Recover resources if we crash before exiting this method.
1923 llvm::CrashRecoveryContextCleanupRegistrar<llvm::MemoryBuffer>
1924 MemBufferCleanup(OverrideMainBuffer);
1925
Douglas Gregor213f18b2010-10-28 15:44:59 +00001926 return Parse(OverrideMainBuffer);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001927}
1928
Douglas Gregorabc563f2010-07-19 21:46:24 +00001929ASTUnit *ASTUnit::LoadFromCompilerInvocation(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001930 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Douglas Gregorabc563f2010-07-19 21:46:24 +00001931 bool OnlyLocalDecls,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001932 bool CaptureDiagnostics,
Douglas Gregordf95a132010-08-09 20:45:32 +00001933 bool PrecompilePreamble,
Douglas Gregor467dc882011-08-25 22:30:56 +00001934 TranslationUnitKind TUKind,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001935 bool CacheCodeCompletionResults,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001936 bool IncludeBriefCommentsInCodeCompletion,
1937 bool UserFilesAreVolatile) {
Douglas Gregorabc563f2010-07-19 21:46:24 +00001938 // Create the AST unit.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001939 OwningPtr<ASTUnit> AST;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001940 AST.reset(new ASTUnit(false));
Douglas Gregor0b53cf82011-01-19 01:02:47 +00001941 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001942 AST->Diagnostics = Diags;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001943 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001944 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor467dc882011-08-25 22:30:56 +00001945 AST->TUKind = TUKind;
Douglas Gregor87c08a52010-08-13 22:48:40 +00001946 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001947 AST->IncludeBriefCommentsInCodeCompletion
1948 = IncludeBriefCommentsInCodeCompletion;
Ted Kremenek4f327862011-03-21 18:40:17 +00001949 AST->Invocation = CI;
Argyrios Kyrtzidiseb8fc582013-01-21 18:45:42 +00001950 AST->FileSystemOpts = CI->getFileSystemOpts();
1951 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001952 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001953
Ted Kremenekb547eeb2011-03-18 02:06:56 +00001954 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001955 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1956 ASTUnitCleanup(AST.get());
David Blaikied6471f72011-09-25 23:23:43 +00001957 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1958 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Ted Kremenek25a11e12011-03-22 01:15:24 +00001959 DiagCleanup(Diags.getPtr());
Ted Kremenekb547eeb2011-03-18 02:06:56 +00001960
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001961 return AST->LoadFromCompilerInvocation(PrecompilePreamble)? 0 : AST.take();
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001962}
Daniel Dunbar7b556682009-12-02 03:23:45 +00001963
1964ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin,
1965 const char **ArgEnd,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001966 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001967 StringRef ResourceFilesPath,
Daniel Dunbar7b556682009-12-02 03:23:45 +00001968 bool OnlyLocalDecls,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001969 bool CaptureDiagnostics,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001970 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +00001971 unsigned NumRemappedFiles,
Argyrios Kyrtzidis299a4a92011-03-08 23:35:24 +00001972 bool RemappedFilesKeepOriginalName,
Douglas Gregordf95a132010-08-09 20:45:32 +00001973 bool PrecompilePreamble,
Douglas Gregor467dc882011-08-25 22:30:56 +00001974 TranslationUnitKind TUKind,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00001975 bool CacheCodeCompletionResults,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001976 bool IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001977 bool AllowPCHWithCompilerErrors,
Erik Verbruggen6a91d382012-04-12 10:11:59 +00001978 bool SkipFunctionBodies,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001979 bool UserFilesAreVolatile,
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00001980 bool ForSerialization,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001981 OwningPtr<ASTUnit> *ErrAST) {
Douglas Gregor28019772010-04-05 23:52:57 +00001982 if (!Diags.getPtr()) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001983 // No diagnostics engine was provided, so create our own diagnostics object
1984 // with the default options.
Sean Silvad47afb92013-01-20 01:58:28 +00001985 Diags = CompilerInstance::createDiagnostics(new DiagnosticOptions());
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001986 }
Daniel Dunbar7b556682009-12-02 03:23:45 +00001987
Chris Lattner5f9e2722011-07-23 10:55:15 +00001988 SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001989
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001990 IntrusiveRefCntPtr<CompilerInvocation> CI;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001991
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001992 {
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001993
Douglas Gregore47be3e2010-11-11 00:39:14 +00001994 CaptureDroppedDiagnostics Capture(CaptureDiagnostics, *Diags,
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001995 StoredDiagnostics);
Daniel Dunbar3bd54cc2010-01-25 00:44:02 +00001996
Argyrios Kyrtzidis832316e2011-04-04 23:11:45 +00001997 CI = clang::createInvocationFromCommandLine(
Frits van Bommele9c02652011-07-18 12:00:32 +00001998 llvm::makeArrayRef(ArgBegin, ArgEnd),
1999 Diags);
Argyrios Kyrtzidis054e4f52011-04-04 21:38:51 +00002000 if (!CI)
Argyrios Kyrtzidis4e03c2b2011-03-07 22:45:01 +00002001 return 0;
Daniel Dunbar7b556682009-12-02 03:23:45 +00002002 }
Douglas Gregore47be3e2010-11-11 00:39:14 +00002003
Douglas Gregor4db64a42010-01-23 00:14:00 +00002004 // Override any files that need remapping
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002005 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
2006 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2007 if (const llvm::MemoryBuffer *
2008 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2009 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, memBuf);
2010 } else {
2011 const char *fname = fileOrBuf.get<const char *>();
2012 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, fname);
2013 }
2014 }
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00002015 PreprocessorOptions &PPOpts = CI->getPreprocessorOpts();
2016 PPOpts.RemappedFilesKeepOriginalName = RemappedFilesKeepOriginalName;
2017 PPOpts.AllowPCHWithCompilerErrors = AllowPCHWithCompilerErrors;
Douglas Gregor4db64a42010-01-23 00:14:00 +00002018
Daniel Dunbar8b9adfe2009-12-15 00:06:45 +00002019 // Override the resources path.
Daniel Dunbar807b0612010-01-30 21:47:16 +00002020 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
Daniel Dunbar7b556682009-12-02 03:23:45 +00002021
Erik Verbruggen6a91d382012-04-12 10:11:59 +00002022 CI->getFrontendOpts().SkipFunctionBodies = SkipFunctionBodies;
2023
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002024 // Create the AST unit.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002025 OwningPtr<ASTUnit> AST;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002026 AST.reset(new ASTUnit(false));
Douglas Gregor0b53cf82011-01-19 01:02:47 +00002027 ConfigureDiags(Diags, ArgBegin, ArgEnd, *AST, CaptureDiagnostics);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002028 AST->Diagnostics = Diags;
Ted Kremenekd04a9822011-11-17 23:01:17 +00002029 Diags = 0; // Zero out now to ease cleanup during crash recovery.
Anders Carlsson0d8d7e62011-03-18 18:22:40 +00002030 AST->FileSystemOpts = CI->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00002031 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002032 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00002033 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor467dc882011-08-25 22:30:56 +00002034 AST->TUKind = TUKind;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002035 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002036 AST->IncludeBriefCommentsInCodeCompletion
2037 = IncludeBriefCommentsInCodeCompletion;
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00002038 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002039 AST->NumStoredDiagnosticsFromDriver = StoredDiagnostics.size();
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002040 AST->StoredDiagnostics.swap(StoredDiagnostics);
Ted Kremenek4f327862011-03-21 18:40:17 +00002041 AST->Invocation = CI;
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002042 if (ForSerialization)
2043 AST->WriterData.reset(new ASTWriterData());
Ted Kremenekd04a9822011-11-17 23:01:17 +00002044 CI = 0; // Zero out now to ease cleanup during crash recovery.
Ted Kremenekb547eeb2011-03-18 02:06:56 +00002045
2046 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00002047 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
2048 ASTUnitCleanup(AST.get());
Ted Kremenekb547eeb2011-03-18 02:06:56 +00002049
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00002050 if (AST->LoadFromCompilerInvocation(PrecompilePreamble)) {
2051 // Some error occurred, if caller wants to examine diagnostics, pass it the
2052 // ASTUnit.
2053 if (ErrAST) {
2054 AST->StoredDiagnostics.swap(AST->FailedParseDiagnostics);
2055 ErrAST->swap(AST);
2056 }
2057 return 0;
2058 }
2059
2060 return AST.take();
Daniel Dunbar7b556682009-12-02 03:23:45 +00002061}
Douglas Gregorabc563f2010-07-19 21:46:24 +00002062
2063bool ASTUnit::Reparse(RemappedFile *RemappedFiles, unsigned NumRemappedFiles) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002064 if (!Invocation)
Douglas Gregorabc563f2010-07-19 21:46:24 +00002065 return true;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002066
2067 clearFileLevelDecls();
Douglas Gregorabc563f2010-07-19 21:46:24 +00002068
Douglas Gregor213f18b2010-10-28 15:44:59 +00002069 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00002070 ParsingTimer.setOutput("Reparsing " + getMainFileName());
Douglas Gregor213f18b2010-10-28 15:44:59 +00002071
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002072 // Remap files.
Douglas Gregorf128fed2010-08-20 00:02:33 +00002073 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
2074 for (PreprocessorOptions::remapped_file_buffer_iterator
2075 R = PPOpts.remapped_file_buffer_begin(),
2076 REnd = PPOpts.remapped_file_buffer_end();
2077 R != REnd;
2078 ++R) {
2079 delete R->second;
2080 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002081 Invocation->getPreprocessorOpts().clearRemappedFiles();
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002082 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
2083 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2084 if (const llvm::MemoryBuffer *
2085 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2086 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
2087 memBuf);
2088 } else {
2089 const char *fname = fileOrBuf.get<const char *>();
2090 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
2091 fname);
2092 }
2093 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002094
Douglas Gregoreababfb2010-08-04 05:53:38 +00002095 // If we have a preamble file lying around, or if we might try to
2096 // build a precompiled preamble, do so now.
Douglas Gregor754f3492010-07-24 00:38:13 +00002097 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Ted Kremenek1872b312011-10-27 17:55:18 +00002098 if (!getPreambleFile(this).empty() || PreambleRebuildCounter > 0)
Douglas Gregor2283d792010-08-20 00:59:43 +00002099 OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(*Invocation);
Douglas Gregor175c4a92010-07-23 23:58:40 +00002100
Douglas Gregorabc563f2010-07-19 21:46:24 +00002101 // Clear out the diagnostics state.
Argyrios Kyrtzidise6825d32011-11-03 20:28:19 +00002102 getDiagnostics().Reset();
2103 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
Argyrios Kyrtzidis27368f92011-11-03 20:57:33 +00002104 if (OverrideMainBuffer)
2105 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
Argyrios Kyrtzidise6825d32011-11-03 20:28:19 +00002106
Douglas Gregor175c4a92010-07-23 23:58:40 +00002107 // Parse the sources
Douglas Gregor9b7db622011-02-16 18:16:54 +00002108 bool Result = Parse(OverrideMainBuffer);
Argyrios Kyrtzidis2fe17fc2011-10-31 21:25:31 +00002109
2110 // If we're caching global code-completion results, and the top-level
2111 // declarations have changed, clear out the code-completion cache.
2112 if (!Result && ShouldCacheCodeCompletionResults &&
2113 CurrentTopLevelHashValue != CompletionCacheTopLevelHashValue)
2114 CacheCodeCompletionResults();
Douglas Gregor9b7db622011-02-16 18:16:54 +00002115
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002116 // We now need to clear out the completion info related to this translation
2117 // unit; it'll be recreated if necessary.
2118 CCTUInfo.reset();
Douglas Gregor8fa0a802011-08-04 20:04:59 +00002119
Douglas Gregor175c4a92010-07-23 23:58:40 +00002120 return Result;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002121}
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002122
Douglas Gregor87c08a52010-08-13 22:48:40 +00002123//----------------------------------------------------------------------------//
2124// Code completion
2125//----------------------------------------------------------------------------//
2126
2127namespace {
2128 /// \brief Code completion consumer that combines the cached code-completion
2129 /// results from an ASTUnit with the code-completion results provided to it,
2130 /// then passes the result on to
2131 class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
Richard Smith026b3582012-08-14 03:13:00 +00002132 uint64_t NormalContexts;
Douglas Gregor87c08a52010-08-13 22:48:40 +00002133 ASTUnit &AST;
2134 CodeCompleteConsumer &Next;
2135
2136 public:
2137 AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002138 const CodeCompleteOptions &CodeCompleteOpts)
2139 : CodeCompleteConsumer(CodeCompleteOpts, Next.isOutputBinary()),
2140 AST(AST), Next(Next)
Douglas Gregor87c08a52010-08-13 22:48:40 +00002141 {
2142 // Compute the set of contexts in which we will look when we don't have
2143 // any information about the specific context.
2144 NormalContexts
Richard Smith026b3582012-08-14 03:13:00 +00002145 = (1LL << CodeCompletionContext::CCC_TopLevel)
2146 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
2147 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
2148 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
2149 | (1LL << CodeCompletionContext::CCC_Statement)
2150 | (1LL << CodeCompletionContext::CCC_Expression)
2151 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
2152 | (1LL << CodeCompletionContext::CCC_DotMemberAccess)
2153 | (1LL << CodeCompletionContext::CCC_ArrowMemberAccess)
2154 | (1LL << CodeCompletionContext::CCC_ObjCPropertyAccess)
2155 | (1LL << CodeCompletionContext::CCC_ObjCProtocolName)
2156 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
2157 | (1LL << CodeCompletionContext::CCC_Recovery);
Douglas Gregor02688102010-09-14 23:59:36 +00002158
David Blaikie4e4d0842012-03-11 07:00:24 +00002159 if (AST.getASTContext().getLangOpts().CPlusPlus)
Richard Smith026b3582012-08-14 03:13:00 +00002160 NormalContexts |= (1LL << CodeCompletionContext::CCC_EnumTag)
2161 | (1LL << CodeCompletionContext::CCC_UnionTag)
2162 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002163 }
2164
2165 virtual void ProcessCodeCompleteResults(Sema &S,
2166 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00002167 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002168 unsigned NumResults);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002169
2170 virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
2171 OverloadCandidate *Candidates,
2172 unsigned NumCandidates) {
2173 Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates);
2174 }
Douglas Gregor218937c2011-02-01 19:23:04 +00002175
Douglas Gregordae68752011-02-01 22:57:45 +00002176 virtual CodeCompletionAllocator &getAllocator() {
Douglas Gregor218937c2011-02-01 19:23:04 +00002177 return Next.getAllocator();
2178 }
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002179
2180 virtual CodeCompletionTUInfo &getCodeCompletionTUInfo() {
2181 return Next.getCodeCompletionTUInfo();
2182 }
Douglas Gregor87c08a52010-08-13 22:48:40 +00002183 };
2184}
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002185
Douglas Gregor5f808c22010-08-16 21:18:39 +00002186/// \brief Helper function that computes which global names are hidden by the
2187/// local code-completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00002188static void CalculateHiddenNames(const CodeCompletionContext &Context,
2189 CodeCompletionResult *Results,
2190 unsigned NumResults,
2191 ASTContext &Ctx,
2192 llvm::StringSet<llvm::BumpPtrAllocator> &HiddenNames){
Douglas Gregor5f808c22010-08-16 21:18:39 +00002193 bool OnlyTagNames = false;
2194 switch (Context.getKind()) {
Douglas Gregor52779fb2010-09-23 23:01:17 +00002195 case CodeCompletionContext::CCC_Recovery:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002196 case CodeCompletionContext::CCC_TopLevel:
2197 case CodeCompletionContext::CCC_ObjCInterface:
2198 case CodeCompletionContext::CCC_ObjCImplementation:
2199 case CodeCompletionContext::CCC_ObjCIvarList:
2200 case CodeCompletionContext::CCC_ClassStructUnion:
2201 case CodeCompletionContext::CCC_Statement:
2202 case CodeCompletionContext::CCC_Expression:
2203 case CodeCompletionContext::CCC_ObjCMessageReceiver:
Douglas Gregor3da626b2011-07-07 16:03:39 +00002204 case CodeCompletionContext::CCC_DotMemberAccess:
2205 case CodeCompletionContext::CCC_ArrowMemberAccess:
2206 case CodeCompletionContext::CCC_ObjCPropertyAccess:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002207 case CodeCompletionContext::CCC_Namespace:
2208 case CodeCompletionContext::CCC_Type:
Douglas Gregor2ccccb32010-08-23 18:23:48 +00002209 case CodeCompletionContext::CCC_Name:
2210 case CodeCompletionContext::CCC_PotentiallyQualifiedName:
Douglas Gregor02688102010-09-14 23:59:36 +00002211 case CodeCompletionContext::CCC_ParenthesizedExpression:
Douglas Gregor0f91c8c2011-07-30 06:55:39 +00002212 case CodeCompletionContext::CCC_ObjCInterfaceName:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002213 break;
2214
2215 case CodeCompletionContext::CCC_EnumTag:
2216 case CodeCompletionContext::CCC_UnionTag:
2217 case CodeCompletionContext::CCC_ClassOrStructTag:
2218 OnlyTagNames = true;
2219 break;
2220
2221 case CodeCompletionContext::CCC_ObjCProtocolName:
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002222 case CodeCompletionContext::CCC_MacroName:
2223 case CodeCompletionContext::CCC_MacroNameUse:
Douglas Gregorf29c5232010-08-24 22:20:20 +00002224 case CodeCompletionContext::CCC_PreprocessorExpression:
Douglas Gregor721f3592010-08-25 18:41:16 +00002225 case CodeCompletionContext::CCC_PreprocessorDirective:
Douglas Gregor59a66942010-08-25 18:04:30 +00002226 case CodeCompletionContext::CCC_NaturalLanguage:
Douglas Gregor458433d2010-08-26 15:07:07 +00002227 case CodeCompletionContext::CCC_SelectorName:
Douglas Gregor1a480c42010-08-27 17:35:51 +00002228 case CodeCompletionContext::CCC_TypeQualifiers:
Douglas Gregor52779fb2010-09-23 23:01:17 +00002229 case CodeCompletionContext::CCC_Other:
Douglas Gregor5c722c702011-02-18 23:30:37 +00002230 case CodeCompletionContext::CCC_OtherWithMacros:
Douglas Gregor3da626b2011-07-07 16:03:39 +00002231 case CodeCompletionContext::CCC_ObjCInstanceMessage:
2232 case CodeCompletionContext::CCC_ObjCClassMessage:
2233 case CodeCompletionContext::CCC_ObjCCategoryName:
Douglas Gregor721f3592010-08-25 18:41:16 +00002234 // We're looking for nothing, or we're looking for names that cannot
2235 // be hidden.
Douglas Gregor5f808c22010-08-16 21:18:39 +00002236 return;
2237 }
2238
John McCall0a2c5e22010-08-25 06:19:51 +00002239 typedef CodeCompletionResult Result;
Douglas Gregor5f808c22010-08-16 21:18:39 +00002240 for (unsigned I = 0; I != NumResults; ++I) {
2241 if (Results[I].Kind != Result::RK_Declaration)
2242 continue;
2243
2244 unsigned IDNS
2245 = Results[I].Declaration->getUnderlyingDecl()->getIdentifierNamespace();
2246
2247 bool Hiding = false;
2248 if (OnlyTagNames)
2249 Hiding = (IDNS & Decl::IDNS_Tag);
2250 else {
2251 unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
Douglas Gregora5fb7c32010-08-16 23:05:20 +00002252 Decl::IDNS_Namespace | Decl::IDNS_Ordinary |
2253 Decl::IDNS_NonMemberOperator);
David Blaikie4e4d0842012-03-11 07:00:24 +00002254 if (Ctx.getLangOpts().CPlusPlus)
Douglas Gregor5f808c22010-08-16 21:18:39 +00002255 HiddenIDNS |= Decl::IDNS_Tag;
2256 Hiding = (IDNS & HiddenIDNS);
2257 }
2258
2259 if (!Hiding)
2260 continue;
2261
2262 DeclarationName Name = Results[I].Declaration->getDeclName();
2263 if (IdentifierInfo *Identifier = Name.getAsIdentifierInfo())
2264 HiddenNames.insert(Identifier->getName());
2265 else
2266 HiddenNames.insert(Name.getAsString());
2267 }
2268}
2269
2270
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002271void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
2272 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00002273 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002274 unsigned NumResults) {
2275 // Merge the results we were given with the results we cached.
2276 bool AddedResult = false;
Richard Smith026b3582012-08-14 03:13:00 +00002277 uint64_t InContexts =
2278 Context.getKind() == CodeCompletionContext::CCC_Recovery
2279 ? NormalContexts : (1LL << Context.getKind());
Douglas Gregor5f808c22010-08-16 21:18:39 +00002280 // Contains the set of names that are hidden by "local" completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00002281 llvm::StringSet<llvm::BumpPtrAllocator> HiddenNames;
John McCall0a2c5e22010-08-25 06:19:51 +00002282 typedef CodeCompletionResult Result;
Chris Lattner5f9e2722011-07-23 10:55:15 +00002283 SmallVector<Result, 8> AllResults;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002284 for (ASTUnit::cached_completion_iterator
Douglas Gregor5535d572010-08-16 21:23:13 +00002285 C = AST.cached_completion_begin(),
2286 CEnd = AST.cached_completion_end();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002287 C != CEnd; ++C) {
2288 // If the context we are in matches any of the contexts we are
2289 // interested in, we'll add this result.
2290 if ((C->ShowInContexts & InContexts) == 0)
2291 continue;
2292
2293 // If we haven't added any results previously, do so now.
2294 if (!AddedResult) {
Douglas Gregor5f808c22010-08-16 21:18:39 +00002295 CalculateHiddenNames(Context, Results, NumResults, S.Context,
2296 HiddenNames);
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002297 AllResults.insert(AllResults.end(), Results, Results + NumResults);
2298 AddedResult = true;
2299 }
2300
Douglas Gregor5f808c22010-08-16 21:18:39 +00002301 // Determine whether this global completion result is hidden by a local
2302 // completion result. If so, skip it.
2303 if (C->Kind != CXCursor_MacroDefinition &&
2304 HiddenNames.count(C->Completion->getTypedText()))
2305 continue;
2306
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002307 // Adjust priority based on similar type classes.
2308 unsigned Priority = C->Priority;
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002309 CodeCompletionString *Completion = C->Completion;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002310 if (!Context.getPreferredType().isNull()) {
2311 if (C->Kind == CXCursor_MacroDefinition) {
2312 Priority = getMacroUsagePriority(C->Completion->getTypedText(),
David Blaikie4e4d0842012-03-11 07:00:24 +00002313 S.getLangOpts(),
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002314 Context.getPreferredType()->isAnyPointerType());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002315 } else if (C->Type) {
2316 CanQualType Expected
Douglas Gregor5535d572010-08-16 21:23:13 +00002317 = S.Context.getCanonicalType(
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002318 Context.getPreferredType().getUnqualifiedType());
2319 SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
2320 if (ExpectedSTC == C->TypeClass) {
2321 // We know this type is similar; check for an exact match.
2322 llvm::StringMap<unsigned> &CachedCompletionTypes
Douglas Gregor5535d572010-08-16 21:23:13 +00002323 = AST.getCachedCompletionTypes();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002324 llvm::StringMap<unsigned>::iterator Pos
Douglas Gregor5535d572010-08-16 21:23:13 +00002325 = CachedCompletionTypes.find(QualType(Expected).getAsString());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002326 if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
2327 Priority /= CCF_ExactTypeMatch;
2328 else
2329 Priority /= CCF_SimilarTypeMatch;
2330 }
2331 }
2332 }
2333
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002334 // Adjust the completion string, if required.
2335 if (C->Kind == CXCursor_MacroDefinition &&
2336 Context.getKind() == CodeCompletionContext::CCC_MacroNameUse) {
2337 // Create a new code-completion string that just contains the
2338 // macro name, without its arguments.
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002339 CodeCompletionBuilder Builder(getAllocator(), getCodeCompletionTUInfo(),
2340 CCP_CodePattern, C->Availability);
Douglas Gregor218937c2011-02-01 19:23:04 +00002341 Builder.AddTypedTextChunk(C->Completion->getTypedText());
Douglas Gregor4125c372010-08-25 18:03:13 +00002342 Priority = CCP_CodePattern;
Douglas Gregor218937c2011-02-01 19:23:04 +00002343 Completion = Builder.TakeString();
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002344 }
2345
Argyrios Kyrtzidisc04bb922012-09-27 00:24:09 +00002346 AllResults.push_back(Result(Completion, Priority, C->Kind,
Douglas Gregor58ddb602010-08-23 23:00:57 +00002347 C->Availability));
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002348 }
2349
2350 // If we did not add any cached completion results, just forward the
2351 // results we were given to the next consumer.
2352 if (!AddedResult) {
2353 Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
2354 return;
2355 }
Douglas Gregor1e5e6682010-08-26 13:48:20 +00002356
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002357 Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
2358 AllResults.size());
2359}
2360
2361
2362
Chris Lattner5f9e2722011-07-23 10:55:15 +00002363void ASTUnit::CodeComplete(StringRef File, unsigned Line, unsigned Column,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002364 RemappedFile *RemappedFiles,
2365 unsigned NumRemappedFiles,
Douglas Gregorcee235c2010-08-05 09:09:23 +00002366 bool IncludeMacros,
2367 bool IncludeCodePatterns,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002368 bool IncludeBriefComments,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002369 CodeCompleteConsumer &Consumer,
David Blaikied6471f72011-09-25 23:23:43 +00002370 DiagnosticsEngine &Diag, LangOptions &LangOpts,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002371 SourceManager &SourceMgr, FileManager &FileMgr,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002372 SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
2373 SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002374 if (!Invocation)
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002375 return;
2376
Douglas Gregor213f18b2010-10-28 15:44:59 +00002377 SimpleTimer CompletionTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00002378 CompletionTimer.setOutput("Code completion @ " + File + ":" +
Chris Lattner5f9e2722011-07-23 10:55:15 +00002379 Twine(Line) + ":" + Twine(Column));
Douglas Gregordf95a132010-08-09 20:45:32 +00002380
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00002381 IntrusiveRefCntPtr<CompilerInvocation>
Ted Kremenek4f327862011-03-21 18:40:17 +00002382 CCInvocation(new CompilerInvocation(*Invocation));
2383
2384 FrontendOptions &FrontendOpts = CCInvocation->getFrontendOpts();
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002385 CodeCompleteOptions &CodeCompleteOpts = FrontendOpts.CodeCompleteOpts;
Ted Kremenek4f327862011-03-21 18:40:17 +00002386 PreprocessorOptions &PreprocessorOpts = CCInvocation->getPreprocessorOpts();
Douglas Gregorcee235c2010-08-05 09:09:23 +00002387
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002388 CodeCompleteOpts.IncludeMacros = IncludeMacros &&
2389 CachedCompletionResults.empty();
2390 CodeCompleteOpts.IncludeCodePatterns = IncludeCodePatterns;
2391 CodeCompleteOpts.IncludeGlobals = CachedCompletionResults.empty();
2392 CodeCompleteOpts.IncludeBriefComments = IncludeBriefComments;
2393
2394 assert(IncludeBriefComments == this->IncludeBriefCommentsInCodeCompletion);
2395
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002396 FrontendOpts.CodeCompletionAt.FileName = File;
2397 FrontendOpts.CodeCompletionAt.Line = Line;
2398 FrontendOpts.CodeCompletionAt.Column = Column;
2399
2400 // Set the language options appropriately.
Ted Kremenekd3b74d92011-11-17 23:01:24 +00002401 LangOpts = *CCInvocation->getLangOpts();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002402
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002403 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00002404
2405 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00002406 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
2407 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00002408
Ted Kremenek4f327862011-03-21 18:40:17 +00002409 Clang->setInvocation(&*CCInvocation);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002410 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002411
2412 // Set up diagnostics, capturing any diagnostics produced.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002413 Clang->setDiagnostics(&Diag);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002414 CaptureDroppedDiagnostics Capture(true,
Ted Kremenek03201fb2011-03-21 18:40:07 +00002415 Clang->getDiagnostics(),
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002416 StoredDiagnostics);
Manuel Klimekf0c06a32013-07-18 14:23:12 +00002417 ProcessWarningOptions(Diag, CCInvocation->getDiagnosticOpts());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002418
2419 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002420 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00002421 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00002422 if (!Clang->hasTarget()) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002423 Clang->setInvocation(0);
Douglas Gregorbdbb0042010-08-18 22:29:43 +00002424 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002425 }
2426
2427 // Inform the target of the language options.
2428 //
2429 // FIXME: We shouldn't need to do this, the target should be immutable once
2430 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002431 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002432
Ted Kremenek03201fb2011-03-21 18:40:07 +00002433 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002434 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002435 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002436 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002437 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002438 "IR inputs not support here!");
2439
2440
2441 // Use the source and file managers that we were given.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002442 Clang->setFileManager(&FileMgr);
2443 Clang->setSourceManager(&SourceMgr);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002444
2445 // Remap files.
2446 PreprocessorOpts.clearRemappedFiles();
Douglas Gregorb75d3df2010-08-04 17:07:00 +00002447 PreprocessorOpts.RetainRemappedFileBuffers = true;
Douglas Gregor2283d792010-08-20 00:59:43 +00002448 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002449 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2450 if (const llvm::MemoryBuffer *
2451 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2452 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first, memBuf);
2453 OwnedBuffers.push_back(memBuf);
2454 } else {
2455 const char *fname = fileOrBuf.get<const char *>();
2456 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first, fname);
2457 }
Douglas Gregor2283d792010-08-20 00:59:43 +00002458 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002459
Douglas Gregor87c08a52010-08-13 22:48:40 +00002460 // Use the code completion consumer we were given, but adding any cached
2461 // code-completion results.
Douglas Gregor7f946ad2010-11-29 16:13:56 +00002462 AugmentedCodeCompleteConsumer *AugmentedConsumer
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002463 = new AugmentedCodeCompleteConsumer(*this, Consumer, CodeCompleteOpts);
Ted Kremenek03201fb2011-03-21 18:40:07 +00002464 Clang->setCodeCompletionConsumer(AugmentedConsumer);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002465
Douglas Gregordf95a132010-08-09 20:45:32 +00002466 // If we have a precompiled preamble, try to use it. We only allow
2467 // the use of the precompiled preamble if we're if the completion
2468 // point is within the main file, after the end of the precompiled
2469 // preamble.
2470 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Ted Kremenek1872b312011-10-27 17:55:18 +00002471 if (!getPreambleFile(this).empty()) {
Rafael Espindola105b2072013-06-18 19:40:07 +00002472 std::string CompleteFilePath(File);
Rafael Espindola44888352013-07-29 21:26:52 +00002473 llvm::sys::fs::UniqueID CompleteFileID;
Rafael Espindola105b2072013-06-18 19:40:07 +00002474
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00002475 if (!llvm::sys::fs::getUniqueID(CompleteFilePath, CompleteFileID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00002476 std::string MainPath(OriginalSourceFile);
Rafael Espindola44888352013-07-29 21:26:52 +00002477 llvm::sys::fs::UniqueID MainID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00002478 if (!llvm::sys::fs::getUniqueID(MainPath, MainID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00002479 if (CompleteFileID == MainID && Line > 1)
Douglas Gregor2283d792010-08-20 00:59:43 +00002480 OverrideMainBuffer
Ted Kremenek4f327862011-03-21 18:40:17 +00002481 = getMainBufferWithPrecompiledPreamble(*CCInvocation, false,
Douglas Gregorc9c29a82010-08-25 18:04:15 +00002482 Line - 1);
Rafael Espindola105b2072013-06-18 19:40:07 +00002483 }
2484 }
Douglas Gregordf95a132010-08-09 20:45:32 +00002485 }
2486
2487 // If the main file has been overridden due to the use of a preamble,
2488 // make that override happen and introduce the preamble.
2489 if (OverrideMainBuffer) {
2490 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
2491 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
2492 PreprocessorOpts.PrecompiledPreambleBytes.second
2493 = PreambleEndsAtStartOfLine;
Ted Kremenek1872b312011-10-27 17:55:18 +00002494 PreprocessorOpts.ImplicitPCHInclude = getPreambleFile(this);
Douglas Gregordf95a132010-08-09 20:45:32 +00002495 PreprocessorOpts.DisablePCHValidation = true;
2496
Douglas Gregor2283d792010-08-20 00:59:43 +00002497 OwnedBuffers.push_back(OverrideMainBuffer);
Douglas Gregorf128fed2010-08-20 00:02:33 +00002498 } else {
2499 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
2500 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregordf95a132010-08-09 20:45:32 +00002501 }
2502
Argyrios Kyrtzidise50904f2012-11-02 22:18:44 +00002503 // Disable the preprocessing record if modules are not enabled.
2504 if (!Clang->getLangOpts().Modules)
2505 PreprocessorOpts.DetailedRecord = false;
Douglas Gregordca8ee82011-05-06 16:33:08 +00002506
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002507 OwningPtr<SyntaxOnlyAction> Act;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002508 Act.reset(new SyntaxOnlyAction);
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00002509 if (Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002510 Act->Execute();
2511 Act->EndSourceFile();
2512 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002513}
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002514
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002515bool ASTUnit::Save(StringRef File) {
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00002516 if (HadModuleLoaderFatalFailure)
2517 return true;
2518
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002519 // Write to a temporary file and later rename it to the actual file, to avoid
2520 // possible race conditions.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002521 SmallString<128> TempPath;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +00002522 TempPath = File;
2523 TempPath += "-%%%%%%%%";
2524 int fd;
Rafael Espindola70e7aec2013-07-05 21:13:58 +00002525 if (llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath))
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002526 return true;
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002527
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002528 // FIXME: Can we somehow regenerate the stat cache here, or do we need to
2529 // unconditionally create a stat cache when we parse the file?
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +00002530 llvm::raw_fd_ostream Out(fd, /*shouldClose=*/true);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002531
2532 serialize(Out);
2533 Out.close();
Argyrios Kyrtzidis4bd26542012-03-13 02:17:06 +00002534 if (Out.has_error()) {
2535 Out.clear_error();
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002536 return true;
Argyrios Kyrtzidis4bd26542012-03-13 02:17:06 +00002537 }
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002538
Rafael Espindola8d2a7012011-12-25 01:18:52 +00002539 if (llvm::sys::fs::rename(TempPath.str(), File)) {
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002540 bool exists;
2541 llvm::sys::fs::remove(TempPath.str(), exists);
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002542 return true;
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002543 }
2544
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002545 return false;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002546}
2547
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002548static bool serializeUnit(ASTWriter &Writer,
2549 SmallVectorImpl<char> &Buffer,
2550 Sema &S,
2551 bool hasErrors,
2552 raw_ostream &OS) {
Argyrios Kyrtzidis4182ed62012-10-31 20:59:50 +00002553 Writer.WriteAST(S, std::string(), 0, "", hasErrors);
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002554
2555 // Write the generated bitstream to "Out".
2556 if (!Buffer.empty())
2557 OS.write(Buffer.data(), Buffer.size());
2558
2559 return false;
2560}
2561
Chris Lattner5f9e2722011-07-23 10:55:15 +00002562bool ASTUnit::serialize(raw_ostream &OS) {
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00002563 bool hasErrors = getDiagnostics().hasErrorOccurred();
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002564
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002565 if (WriterData)
2566 return serializeUnit(WriterData->Writer, WriterData->Buffer,
2567 getSema(), hasErrors, OS);
2568
Daniel Dunbar8d6ff022012-02-29 20:31:23 +00002569 SmallString<128> Buffer;
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002570 llvm::BitstreamWriter Stream(Buffer);
Sebastian Redla4232eb2010-08-18 23:56:21 +00002571 ASTWriter Writer(Stream);
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002572 return serializeUnit(Writer, Buffer, getSema(), hasErrors, OS);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002573}
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002574
2575typedef ContinuousRangeMap<unsigned, int, 2> SLocRemap;
2576
2577static void TranslateSLoc(SourceLocation &L, SLocRemap &Remap) {
2578 unsigned Raw = L.getRawEncoding();
2579 const unsigned MacroBit = 1U << 31;
2580 L = SourceLocation::getFromRawEncoding((Raw & MacroBit) |
2581 ((Raw & ~MacroBit) + Remap.find(Raw & ~MacroBit)->second));
2582}
2583
2584void ASTUnit::TranslateStoredDiagnostics(
2585 ASTReader *MMan,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002586 StringRef ModName,
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002587 SourceManager &SrcMgr,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002588 const SmallVectorImpl<StoredDiagnostic> &Diags,
2589 SmallVectorImpl<StoredDiagnostic> &Out) {
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002590 // The stored diagnostic has the old source manager in it; update
2591 // the locations to refer into the new source manager. We also need to remap
2592 // all the locations to the new view. This includes the diag location, any
2593 // associated source ranges, and the source ranges of associated fix-its.
2594 // FIXME: There should be a cleaner way to do this.
2595
Chris Lattner5f9e2722011-07-23 10:55:15 +00002596 SmallVector<StoredDiagnostic, 4> Result;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002597 Result.reserve(Diags.size());
2598 assert(MMan && "Don't have a module manager");
Douglas Gregor1a4761e2011-11-30 23:21:26 +00002599 serialization::ModuleFile *Mod = MMan->ModuleMgr.lookup(ModName);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002600 assert(Mod && "Don't have preamble module");
2601 SLocRemap &Remap = Mod->SLocRemap;
2602 for (unsigned I = 0, N = Diags.size(); I != N; ++I) {
2603 // Rebuild the StoredDiagnostic.
2604 const StoredDiagnostic &SD = Diags[I];
2605 SourceLocation L = SD.getLocation();
2606 TranslateSLoc(L, Remap);
2607 FullSourceLoc Loc(L, SrcMgr);
2608
Chris Lattner5f9e2722011-07-23 10:55:15 +00002609 SmallVector<CharSourceRange, 4> Ranges;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002610 Ranges.reserve(SD.range_size());
2611 for (StoredDiagnostic::range_iterator I = SD.range_begin(),
2612 E = SD.range_end();
2613 I != E; ++I) {
2614 SourceLocation BL = I->getBegin();
2615 TranslateSLoc(BL, Remap);
2616 SourceLocation EL = I->getEnd();
2617 TranslateSLoc(EL, Remap);
2618 Ranges.push_back(CharSourceRange(SourceRange(BL, EL), I->isTokenRange()));
2619 }
2620
Chris Lattner5f9e2722011-07-23 10:55:15 +00002621 SmallVector<FixItHint, 2> FixIts;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002622 FixIts.reserve(SD.fixit_size());
2623 for (StoredDiagnostic::fixit_iterator I = SD.fixit_begin(),
2624 E = SD.fixit_end();
2625 I != E; ++I) {
2626 FixIts.push_back(FixItHint());
2627 FixItHint &FH = FixIts.back();
2628 FH.CodeToInsert = I->CodeToInsert;
2629 SourceLocation BL = I->RemoveRange.getBegin();
2630 TranslateSLoc(BL, Remap);
2631 SourceLocation EL = I->RemoveRange.getEnd();
2632 TranslateSLoc(EL, Remap);
2633 FH.RemoveRange = CharSourceRange(SourceRange(BL, EL),
2634 I->RemoveRange.isTokenRange());
2635 }
2636
2637 Result.push_back(StoredDiagnostic(SD.getLevel(), SD.getID(),
2638 SD.getMessage(), Loc, Ranges, FixIts));
2639 }
2640 Result.swap(Out);
2641}
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002642
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002643static inline bool compLocDecl(std::pair<unsigned, Decl *> L,
2644 std::pair<unsigned, Decl *> R) {
2645 return L.first < R.first;
2646}
2647
2648void ASTUnit::addFileLevelDecl(Decl *D) {
2649 assert(D);
Douglas Gregor66e87002011-11-07 18:53:57 +00002650
2651 // We only care about local declarations.
2652 if (D->isFromASTFile())
2653 return;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002654
2655 SourceManager &SM = *SourceMgr;
2656 SourceLocation Loc = D->getLocation();
2657 if (Loc.isInvalid() || !SM.isLocalSourceLocation(Loc))
2658 return;
2659
2660 // We only keep track of the file-level declarations of each file.
2661 if (!D->getLexicalDeclContext()->isFileContext())
2662 return;
2663
2664 SourceLocation FileLoc = SM.getFileLoc(Loc);
2665 assert(SM.isLocalSourceLocation(FileLoc));
2666 FileID FID;
2667 unsigned Offset;
2668 llvm::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
2669 if (FID.isInvalid())
2670 return;
2671
2672 LocDeclsTy *&Decls = FileDecls[FID];
2673 if (!Decls)
2674 Decls = new LocDeclsTy();
2675
2676 std::pair<unsigned, Decl *> LocDecl(Offset, D);
2677
2678 if (Decls->empty() || Decls->back().first <= Offset) {
2679 Decls->push_back(LocDecl);
2680 return;
2681 }
2682
2683 LocDeclsTy::iterator
2684 I = std::upper_bound(Decls->begin(), Decls->end(), LocDecl, compLocDecl);
2685
2686 Decls->insert(I, LocDecl);
2687}
2688
Argyrios Kyrtzidisdfb332d2011-11-03 02:20:32 +00002689void ASTUnit::findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
2690 SmallVectorImpl<Decl *> &Decls) {
2691 if (File.isInvalid())
2692 return;
2693
2694 if (SourceMgr->isLoadedFileID(File)) {
2695 assert(Ctx->getExternalSource() && "No external source!");
2696 return Ctx->getExternalSource()->FindFileRegionDecls(File, Offset, Length,
2697 Decls);
2698 }
2699
2700 FileDeclsTy::iterator I = FileDecls.find(File);
2701 if (I == FileDecls.end())
2702 return;
2703
2704 LocDeclsTy &LocDecls = *I->second;
2705 if (LocDecls.empty())
2706 return;
2707
2708 LocDeclsTy::iterator
2709 BeginIt = std::lower_bound(LocDecls.begin(), LocDecls.end(),
2710 std::make_pair(Offset, (Decl*)0), compLocDecl);
2711 if (BeginIt != LocDecls.begin())
2712 --BeginIt;
2713
Argyrios Kyrtzidisc14a03d2011-11-23 20:27:36 +00002714 // If we are pointing at a top-level decl inside an objc container, we need
2715 // to backtrack until we find it otherwise we will fail to report that the
2716 // region overlaps with an objc container.
2717 while (BeginIt != LocDecls.begin() &&
2718 BeginIt->second->isTopLevelDeclInObjCContainer())
2719 --BeginIt;
2720
Argyrios Kyrtzidisdfb332d2011-11-03 02:20:32 +00002721 LocDeclsTy::iterator
2722 EndIt = std::upper_bound(LocDecls.begin(), LocDecls.end(),
2723 std::make_pair(Offset+Length, (Decl*)0),
2724 compLocDecl);
2725 if (EndIt != LocDecls.end())
2726 ++EndIt;
2727
2728 for (LocDeclsTy::iterator DIt = BeginIt; DIt != EndIt; ++DIt)
2729 Decls.push_back(DIt->second);
2730}
2731
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002732SourceLocation ASTUnit::getLocation(const FileEntry *File,
2733 unsigned Line, unsigned Col) const {
2734 const SourceManager &SM = getSourceManager();
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002735 SourceLocation Loc = SM.translateFileLineCol(File, Line, Col);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002736 return SM.getMacroArgExpandedLocation(Loc);
2737}
2738
2739SourceLocation ASTUnit::getLocation(const FileEntry *File,
2740 unsigned Offset) const {
2741 const SourceManager &SM = getSourceManager();
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002742 SourceLocation FileLoc = SM.translateFileLineCol(File, 1, 1);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002743 return SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Offset));
2744}
2745
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002746/// \brief If \arg Loc is a loaded location from the preamble, returns
2747/// the corresponding local location of the main file, otherwise it returns
2748/// \arg Loc.
2749SourceLocation ASTUnit::mapLocationFromPreamble(SourceLocation Loc) {
2750 FileID PreambleID;
2751 if (SourceMgr)
2752 PreambleID = SourceMgr->getPreambleFileID();
2753
2754 if (Loc.isInvalid() || Preamble.empty() || PreambleID.isInvalid())
2755 return Loc;
2756
2757 unsigned Offs;
2758 if (SourceMgr->isInFileID(Loc, PreambleID, &Offs) && Offs < Preamble.size()) {
2759 SourceLocation FileLoc
2760 = SourceMgr->getLocForStartOfFile(SourceMgr->getMainFileID());
2761 return FileLoc.getLocWithOffset(Offs);
2762 }
2763
2764 return Loc;
2765}
2766
2767/// \brief If \arg Loc is a local location of the main file but inside the
2768/// preamble chunk, returns the corresponding loaded location from the
2769/// preamble, otherwise it returns \arg Loc.
2770SourceLocation ASTUnit::mapLocationToPreamble(SourceLocation Loc) {
2771 FileID PreambleID;
2772 if (SourceMgr)
2773 PreambleID = SourceMgr->getPreambleFileID();
2774
2775 if (Loc.isInvalid() || Preamble.empty() || PreambleID.isInvalid())
2776 return Loc;
2777
2778 unsigned Offs;
2779 if (SourceMgr->isInFileID(Loc, SourceMgr->getMainFileID(), &Offs) &&
2780 Offs < Preamble.size()) {
2781 SourceLocation FileLoc = SourceMgr->getLocForStartOfFile(PreambleID);
2782 return FileLoc.getLocWithOffset(Offs);
2783 }
2784
2785 return Loc;
2786}
2787
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00002788bool ASTUnit::isInPreambleFileID(SourceLocation Loc) {
2789 FileID FID;
2790 if (SourceMgr)
2791 FID = SourceMgr->getPreambleFileID();
2792
2793 if (Loc.isInvalid() || FID.isInvalid())
2794 return false;
2795
2796 return SourceMgr->isInFileID(Loc, FID);
2797}
2798
2799bool ASTUnit::isInMainFileID(SourceLocation Loc) {
2800 FileID FID;
2801 if (SourceMgr)
2802 FID = SourceMgr->getMainFileID();
2803
2804 if (Loc.isInvalid() || FID.isInvalid())
2805 return false;
2806
2807 return SourceMgr->isInFileID(Loc, FID);
2808}
2809
2810SourceLocation ASTUnit::getEndOfPreambleFileID() {
2811 FileID FID;
2812 if (SourceMgr)
2813 FID = SourceMgr->getPreambleFileID();
2814
2815 if (FID.isInvalid())
2816 return SourceLocation();
2817
2818 return SourceMgr->getLocForEndOfFile(FID);
2819}
2820
2821SourceLocation ASTUnit::getStartOfMainFileID() {
2822 FileID FID;
2823 if (SourceMgr)
2824 FID = SourceMgr->getMainFileID();
2825
2826 if (FID.isInvalid())
2827 return SourceLocation();
2828
2829 return SourceMgr->getLocForStartOfFile(FID);
2830}
2831
Argyrios Kyrtzidis632dcc92012-10-02 16:10:51 +00002832std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
2833ASTUnit::getLocalPreprocessingEntities() const {
2834 if (isMainFileAST()) {
2835 serialization::ModuleFile &
2836 Mod = Reader->getModuleManager().getPrimaryModule();
2837 return Reader->getModulePreprocessedEntities(Mod);
2838 }
2839
2840 if (PreprocessingRecord *PPRec = PP->getPreprocessingRecord())
2841 return std::make_pair(PPRec->local_begin(), PPRec->local_end());
2842
2843 return std::make_pair(PreprocessingRecord::iterator(),
2844 PreprocessingRecord::iterator());
2845}
2846
Argyrios Kyrtzidis95c579c2012-10-03 01:58:28 +00002847bool ASTUnit::visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn) {
Argyrios Kyrtzidis2093e0b2012-10-02 21:09:13 +00002848 if (isMainFileAST()) {
2849 serialization::ModuleFile &
2850 Mod = Reader->getModuleManager().getPrimaryModule();
2851 ASTReader::ModuleDeclIterator MDI, MDE;
2852 llvm::tie(MDI, MDE) = Reader->getModuleFileLevelDecls(Mod);
2853 for (; MDI != MDE; ++MDI) {
2854 if (!Fn(context, *MDI))
2855 return false;
2856 }
2857
2858 return true;
2859 }
2860
2861 for (ASTUnit::top_level_iterator TL = top_level_begin(),
2862 TLEnd = top_level_end();
2863 TL != TLEnd; ++TL) {
2864 if (!Fn(context, *TL))
2865 return false;
2866 }
2867
2868 return true;
2869}
2870
Argyrios Kyrtzidis3da76bf2012-10-03 21:05:51 +00002871namespace {
2872struct PCHLocatorInfo {
2873 serialization::ModuleFile *Mod;
2874 PCHLocatorInfo() : Mod(0) {}
2875};
2876}
2877
2878static bool PCHLocator(serialization::ModuleFile &M, void *UserData) {
2879 PCHLocatorInfo &Info = *static_cast<PCHLocatorInfo*>(UserData);
2880 switch (M.Kind) {
2881 case serialization::MK_Module:
2882 return true; // skip dependencies.
2883 case serialization::MK_PCH:
2884 Info.Mod = &M;
2885 return true; // found it.
2886 case serialization::MK_Preamble:
2887 return false; // look in dependencies.
2888 case serialization::MK_MainFile:
2889 return false; // look in dependencies.
2890 }
2891
2892 return true;
2893}
2894
2895const FileEntry *ASTUnit::getPCHFile() {
2896 if (!Reader)
2897 return 0;
2898
2899 PCHLocatorInfo Info;
2900 Reader->getModuleManager().visit(PCHLocator, &Info);
2901 if (Info.Mod)
2902 return Info.Mod->File;
2903
2904 return 0;
2905}
2906
Argyrios Kyrtzidis62288ed2012-10-10 02:12:47 +00002907bool ASTUnit::isModuleFile() {
2908 return isMainFileAST() && !ASTFileLangOpts.CurrentModule.empty();
2909}
2910
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002911void ASTUnit::PreambleData::countLines() const {
2912 NumLines = 0;
2913 if (empty())
2914 return;
2915
2916 for (std::vector<char>::const_iterator
2917 I = Buffer.begin(), E = Buffer.end(); I != E; ++I) {
2918 if (*I == '\n')
2919 ++NumLines;
2920 }
2921 if (Buffer.back() != '\n')
2922 ++NumLines;
2923}
Argyrios Kyrtzidisa696ece2011-10-10 21:57:12 +00002924
2925#ifndef NDEBUG
2926ASTUnit::ConcurrencyState::ConcurrencyState() {
2927 Mutex = new llvm::sys::MutexImpl(/*recursive=*/true);
2928}
2929
2930ASTUnit::ConcurrencyState::~ConcurrencyState() {
2931 delete static_cast<llvm::sys::MutexImpl *>(Mutex);
2932}
2933
2934void ASTUnit::ConcurrencyState::start() {
2935 bool acquired = static_cast<llvm::sys::MutexImpl *>(Mutex)->tryacquire();
2936 assert(acquired && "Concurrent access to ASTUnit!");
2937}
2938
2939void ASTUnit::ConcurrencyState::finish() {
2940 static_cast<llvm::sys::MutexImpl *>(Mutex)->release();
2941}
2942
2943#else // NDEBUG
2944
2945ASTUnit::ConcurrencyState::ConcurrencyState() {}
2946ASTUnit::ConcurrencyState::~ConcurrencyState() {}
2947void ASTUnit::ConcurrencyState::start() {}
2948void ASTUnit::ConcurrencyState::finish() {}
2949
2950#endif