blob: e5a8d17c203594e109b8d6b0eccd92db7706d2be [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"
Rafael Espindola34392372013-06-11 19:59:07 +000045#include "llvm/Support/PathV1.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000046#include "llvm/Support/Timer.h"
47#include "llvm/Support/raw_ostream.h"
Zhongxing Xuad23ebe2010-07-23 02:15:08 +000048#include <cstdio>
Chandler Carruth55fc8732012-12-04 09:13:33 +000049#include <cstdlib>
Douglas Gregorcc5888d2010-07-31 00:40:00 +000050#include <sys/stat.h>
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +000051using namespace clang;
52
Douglas Gregor213f18b2010-10-28 15:44:59 +000053using llvm::TimeRecord;
54
55namespace {
56 class SimpleTimer {
57 bool WantTiming;
58 TimeRecord Start;
59 std::string Output;
60
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000061 public:
Douglas Gregor9dba61a2010-11-01 13:48:43 +000062 explicit SimpleTimer(bool WantTiming) : WantTiming(WantTiming) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000063 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000064 Start = TimeRecord::getCurrentTime();
Douglas Gregor213f18b2010-10-28 15:44:59 +000065 }
66
Chris Lattner5f9e2722011-07-23 10:55:15 +000067 void setOutput(const Twine &Output) {
Douglas Gregor213f18b2010-10-28 15:44:59 +000068 if (WantTiming)
Benjamin Krameredfb7ec2010-11-09 20:00:56 +000069 this->Output = Output.str();
Douglas Gregor213f18b2010-10-28 15:44:59 +000070 }
71
Douglas Gregor213f18b2010-10-28 15:44:59 +000072 ~SimpleTimer() {
73 if (WantTiming) {
74 TimeRecord Elapsed = TimeRecord::getCurrentTime();
75 Elapsed -= Start;
76 llvm::errs() << Output << ':';
77 Elapsed.print(Elapsed, llvm::errs());
78 llvm::errs() << '\n';
79 }
80 }
81 };
Ted Kremenek1872b312011-10-27 17:55:18 +000082
83 struct OnDiskData {
84 /// \brief The file in which the precompiled preamble is stored.
85 std::string PreambleFile;
86
Rafael Espindolab804cb32013-06-26 03:52:38 +000087 /// \brief Temporary files that should be removed when the ASTUnit is
Ted Kremenek1872b312011-10-27 17:55:18 +000088 /// destroyed.
Rafael Espindolab804cb32013-06-26 03:52:38 +000089 SmallVector<std::string, 4> TemporaryFiles;
90
Ted Kremenek1872b312011-10-27 17:55:18 +000091 /// \brief Erase temporary files.
92 void CleanTemporaryFiles();
93
94 /// \brief Erase the preamble file.
95 void CleanPreambleFile();
96
97 /// \brief Erase temporary files and the preamble file.
98 void Cleanup();
99 };
100}
101
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000102static llvm::sys::SmartMutex<false> &getOnDiskMutex() {
103 static llvm::sys::SmartMutex<false> M(/* recursive = */ true);
104 return M;
105}
106
Dmitri Gribenkoc4a77902012-11-15 14:28:07 +0000107static void cleanupOnDiskMapAtExit();
Ted Kremenek1872b312011-10-27 17:55:18 +0000108
109typedef llvm::DenseMap<const ASTUnit *, OnDiskData *> OnDiskDataMap;
110static OnDiskDataMap &getOnDiskDataMap() {
111 static OnDiskDataMap M;
112 static bool hasRegisteredAtExit = false;
113 if (!hasRegisteredAtExit) {
114 hasRegisteredAtExit = true;
115 atexit(cleanupOnDiskMapAtExit);
116 }
117 return M;
118}
119
Dmitri Gribenkoc4a77902012-11-15 14:28:07 +0000120static void cleanupOnDiskMapAtExit() {
Argyrios Kyrtzidis81788132012-07-03 16:30:52 +0000121 // Use the mutex because there can be an alive thread destroying an ASTUnit.
122 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000123 OnDiskDataMap &M = getOnDiskDataMap();
124 for (OnDiskDataMap::iterator I = M.begin(), E = M.end(); I != E; ++I) {
125 // We don't worry about freeing the memory associated with OnDiskDataMap.
126 // All we care about is erasing stale files.
127 I->second->Cleanup();
128 }
129}
130
131static OnDiskData &getOnDiskData(const ASTUnit *AU) {
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000132 // We require the mutex since we are modifying the structure of the
133 // DenseMap.
134 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000135 OnDiskDataMap &M = getOnDiskDataMap();
136 OnDiskData *&D = M[AU];
137 if (!D)
138 D = new OnDiskData();
139 return *D;
140}
141
142static void erasePreambleFile(const ASTUnit *AU) {
143 getOnDiskData(AU).CleanPreambleFile();
144}
145
146static void removeOnDiskEntry(const ASTUnit *AU) {
Ted Kremeneke055f8a2011-10-27 19:44:25 +0000147 // We require the mutex since we are modifying the structure of the
148 // DenseMap.
149 llvm::MutexGuard Guard(getOnDiskMutex());
Ted Kremenek1872b312011-10-27 17:55:18 +0000150 OnDiskDataMap &M = getOnDiskDataMap();
151 OnDiskDataMap::iterator I = M.find(AU);
152 if (I != M.end()) {
153 I->second->Cleanup();
154 delete I->second;
155 M.erase(AU);
156 }
157}
158
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000159static void setPreambleFile(const ASTUnit *AU, StringRef preambleFile) {
Ted Kremenek1872b312011-10-27 17:55:18 +0000160 getOnDiskData(AU).PreambleFile = preambleFile;
161}
162
163static const std::string &getPreambleFile(const ASTUnit *AU) {
164 return getOnDiskData(AU).PreambleFile;
165}
166
167void OnDiskData::CleanTemporaryFiles() {
168 for (unsigned I = 0, N = TemporaryFiles.size(); I != N; ++I)
Rafael Espindolab804cb32013-06-26 03:52:38 +0000169 llvm::sys::fs::remove(TemporaryFiles[I]);
170 TemporaryFiles.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +0000171}
172
173void OnDiskData::CleanPreambleFile() {
174 if (!PreambleFile.empty()) {
175 llvm::sys::Path(PreambleFile).eraseFromDisk();
176 PreambleFile.clear();
177 }
178}
179
180void OnDiskData::Cleanup() {
181 CleanTemporaryFiles();
182 CleanPreambleFile();
183}
184
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000185struct ASTUnit::ASTWriterData {
186 SmallString<128> Buffer;
187 llvm::BitstreamWriter Stream;
188 ASTWriter Writer;
189
190 ASTWriterData() : Stream(Buffer), Writer(Stream) { }
191};
192
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000193void ASTUnit::clearFileLevelDecls() {
194 for (FileDeclsTy::iterator
195 I = FileDecls.begin(), E = FileDecls.end(); I != E; ++I)
196 delete I->second;
197 FileDecls.clear();
198}
199
Ted Kremenek1872b312011-10-27 17:55:18 +0000200void ASTUnit::CleanTemporaryFiles() {
201 getOnDiskData(this).CleanTemporaryFiles();
202}
203
Rafael Espindolab804cb32013-06-26 03:52:38 +0000204void ASTUnit::addTemporaryFile(StringRef TempFile) {
Ted Kremenek1872b312011-10-27 17:55:18 +0000205 getOnDiskData(this).TemporaryFiles.push_back(TempFile);
Douglas Gregor213f18b2010-10-28 15:44:59 +0000206}
207
Douglas Gregoreababfb2010-08-04 05:53:38 +0000208/// \brief After failing to build a precompiled preamble (due to
209/// errors in the source that occurs in the preamble), the number of
210/// reparses during which we'll skip even trying to precompile the
211/// preamble.
212const unsigned DefaultPreambleRebuildInterval = 5;
213
Douglas Gregore3c60a72010-11-17 00:13:31 +0000214/// \brief Tracks the number of ASTUnit objects that are currently active.
215///
216/// Used for debugging purposes only.
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000217static llvm::sys::cas_flag ActiveASTUnitObjects;
Douglas Gregore3c60a72010-11-17 00:13:31 +0000218
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000219ASTUnit::ASTUnit(bool _MainFileIsAST)
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +0000220 : Reader(0), HadModuleLoaderFatalFailure(false),
221 OnlyLocalDecls(false), CaptureDiagnostics(false),
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +0000222 MainFileIsAST(_MainFileIsAST),
Douglas Gregor467dc882011-08-25 22:30:56 +0000223 TUKind(TU_Complete), WantTiming(getenv("LIBCLANG_TIMING")),
Argyrios Kyrtzidis15727dd2011-03-05 01:03:48 +0000224 OwnsRemappedFileBuffers(true),
Douglas Gregor213f18b2010-10-28 15:44:59 +0000225 NumStoredDiagnosticsFromDriver(0),
Douglas Gregor671947b2010-08-19 01:33:06 +0000226 PreambleRebuildCounter(0), SavedMainFileBuffer(0), PreambleBuffer(0),
Argyrios Kyrtzidis98704012011-11-29 18:18:33 +0000227 NumWarningsInPreamble(0),
Douglas Gregor727d93e2010-08-17 00:40:40 +0000228 ShouldCacheCodeCompletionResults(false),
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000229 IncludeBriefCommentsInCodeCompletion(false), UserFilesAreVolatile(false),
Douglas Gregor9b7db622011-02-16 18:16:54 +0000230 CompletionCacheTopLevelHashValue(0),
231 PreambleTopLevelHashValue(0),
232 CurrentTopLevelHashValue(0),
Douglas Gregor8b1540c2010-08-19 00:45:44 +0000233 UnsafeToFree(false) {
Douglas Gregore3c60a72010-11-17 00:13:31 +0000234 if (getenv("LIBCLANG_OBJTRACKING")) {
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000235 llvm::sys::AtomicIncrement(&ActiveASTUnitObjects);
Douglas Gregore3c60a72010-11-17 00:13:31 +0000236 fprintf(stderr, "+++ %d translation units\n", ActiveASTUnitObjects);
237 }
Douglas Gregor385103b2010-07-30 20:58:08 +0000238}
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000239
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000240ASTUnit::~ASTUnit() {
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000241 // If we loaded from an AST file, balance out the BeginSourceFile call.
242 if (MainFileIsAST && getDiagnostics().getClient()) {
243 getDiagnostics().getClient()->EndSourceFile();
244 }
245
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000246 clearFileLevelDecls();
247
Ted Kremenek1872b312011-10-27 17:55:18 +0000248 // Clean up the temporary files and the preamble file.
249 removeOnDiskEntry(this);
250
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000251 // Free the buffers associated with remapped files. We are required to
252 // perform this operation here because we explicitly request that the
253 // compiler instance *not* free these buffers for each invocation of the
254 // parser.
Ted Kremenek4f327862011-03-21 18:40:17 +0000255 if (Invocation.getPtr() && OwnsRemappedFileBuffers) {
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +0000256 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
257 for (PreprocessorOptions::remapped_file_buffer_iterator
258 FB = PPOpts.remapped_file_buffer_begin(),
259 FBEnd = PPOpts.remapped_file_buffer_end();
260 FB != FBEnd;
261 ++FB)
262 delete FB->second;
263 }
Douglas Gregor28233422010-07-27 14:52:07 +0000264
265 delete SavedMainFileBuffer;
Douglas Gregor671947b2010-08-19 01:33:06 +0000266 delete PreambleBuffer;
267
Douglas Gregor213f18b2010-10-28 15:44:59 +0000268 ClearCachedCompletionResults();
Douglas Gregore3c60a72010-11-17 00:13:31 +0000269
270 if (getenv("LIBCLANG_OBJTRACKING")) {
Douglas Gregor1fd9e0d2010-12-07 00:05:48 +0000271 llvm::sys::AtomicDecrement(&ActiveASTUnitObjects);
Douglas Gregore3c60a72010-11-17 00:13:31 +0000272 fprintf(stderr, "--- %d translation units\n", ActiveASTUnitObjects);
273 }
Douglas Gregorabc563f2010-07-19 21:46:24 +0000274}
275
Argyrios Kyrtzidis7fe90f32012-01-17 18:48:07 +0000276void ASTUnit::setPreprocessor(Preprocessor *pp) { PP = pp; }
277
Douglas Gregor8071e422010-08-15 06:18:01 +0000278/// \brief Determine the set of code-completion contexts in which this
279/// declaration should be shown.
Dmitri Gribenko89cf4252013-01-23 17:21:11 +0000280static unsigned getDeclShowContexts(const NamedDecl *ND,
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000281 const LangOptions &LangOpts,
282 bool &IsNestedNameSpecifier) {
283 IsNestedNameSpecifier = false;
284
Douglas Gregor8071e422010-08-15 06:18:01 +0000285 if (isa<UsingShadowDecl>(ND))
286 ND = dyn_cast<NamedDecl>(ND->getUnderlyingDecl());
287 if (!ND)
288 return 0;
289
Richard Smith026b3582012-08-14 03:13:00 +0000290 uint64_t Contexts = 0;
Douglas Gregor8071e422010-08-15 06:18:01 +0000291 if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
292 isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND)) {
293 // Types can appear in these contexts.
294 if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000295 Contexts |= (1LL << CodeCompletionContext::CCC_TopLevel)
296 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
297 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
298 | (1LL << CodeCompletionContext::CCC_Statement)
299 | (1LL << CodeCompletionContext::CCC_Type)
300 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
Douglas Gregor8071e422010-08-15 06:18:01 +0000301
302 // In C++, types can appear in expressions contexts (for functional casts).
303 if (LangOpts.CPlusPlus)
Richard Smith026b3582012-08-14 03:13:00 +0000304 Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
Douglas Gregor8071e422010-08-15 06:18:01 +0000305
306 // In Objective-C, message sends can send interfaces. In Objective-C++,
307 // all types are available due to functional casts.
308 if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000309 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
Douglas Gregor3da626b2011-07-07 16:03:39 +0000310
311 // In Objective-C, you can only be a subclass of another Objective-C class
312 if (isa<ObjCInterfaceDecl>(ND))
Richard Smith026b3582012-08-14 03:13:00 +0000313 Contexts |= (1LL << CodeCompletionContext::CCC_ObjCInterfaceName);
Douglas Gregor8071e422010-08-15 06:18:01 +0000314
315 // Deal with tag names.
316 if (isa<EnumDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000317 Contexts |= (1LL << CodeCompletionContext::CCC_EnumTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000318
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000319 // Part of the nested-name-specifier in C++0x.
Richard Smith80ad52f2013-01-02 11:42:31 +0000320 if (LangOpts.CPlusPlus11)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000321 IsNestedNameSpecifier = true;
Dmitri Gribenko89cf4252013-01-23 17:21:11 +0000322 } else if (const RecordDecl *Record = dyn_cast<RecordDecl>(ND)) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000323 if (Record->isUnion())
Richard Smith026b3582012-08-14 03:13:00 +0000324 Contexts |= (1LL << CodeCompletionContext::CCC_UnionTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000325 else
Richard Smith026b3582012-08-14 03:13:00 +0000326 Contexts |= (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
Douglas Gregor8071e422010-08-15 06:18:01 +0000327
Douglas Gregor8071e422010-08-15 06:18:01 +0000328 if (LangOpts.CPlusPlus)
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000329 IsNestedNameSpecifier = true;
Douglas Gregor52779fb2010-09-23 23:01:17 +0000330 } else if (isa<ClassTemplateDecl>(ND))
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000331 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000332 } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
333 // Values can appear in these contexts.
Richard Smith026b3582012-08-14 03:13:00 +0000334 Contexts = (1LL << CodeCompletionContext::CCC_Statement)
335 | (1LL << CodeCompletionContext::CCC_Expression)
336 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
337 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver);
Douglas Gregor8071e422010-08-15 06:18:01 +0000338 } else if (isa<ObjCProtocolDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000339 Contexts = (1LL << CodeCompletionContext::CCC_ObjCProtocolName);
Douglas Gregor3da626b2011-07-07 16:03:39 +0000340 } else if (isa<ObjCCategoryDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000341 Contexts = (1LL << CodeCompletionContext::CCC_ObjCCategoryName);
Douglas Gregor8071e422010-08-15 06:18:01 +0000342 } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
Richard Smith026b3582012-08-14 03:13:00 +0000343 Contexts = (1LL << CodeCompletionContext::CCC_Namespace);
Douglas Gregor8071e422010-08-15 06:18:01 +0000344
345 // Part of the nested-name-specifier.
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000346 IsNestedNameSpecifier = true;
Douglas Gregor8071e422010-08-15 06:18:01 +0000347 }
348
349 return Contexts;
350}
351
Douglas Gregor87c08a52010-08-13 22:48:40 +0000352void ASTUnit::CacheCodeCompletionResults() {
353 if (!TheSema)
354 return;
355
Douglas Gregor213f18b2010-10-28 15:44:59 +0000356 SimpleTimer Timer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +0000357 Timer.setOutput("Cache global code completions for " + getMainFileName());
Douglas Gregor87c08a52010-08-13 22:48:40 +0000358
359 // Clear out the previous results.
360 ClearCachedCompletionResults();
361
362 // Gather the set of global code completions.
John McCall0a2c5e22010-08-25 06:19:51 +0000363 typedef CodeCompletionResult Result;
Chris Lattner5f9e2722011-07-23 10:55:15 +0000364 SmallVector<Result, 8> Results;
Douglas Gregor48601b32011-02-16 19:08:06 +0000365 CachedCompletionAllocator = new GlobalCodeCompletionAllocator;
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000366 CodeCompletionTUInfo CCTUInfo(CachedCompletionAllocator);
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000367 TheSema->GatherGlobalCodeCompletions(*CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000368 CCTUInfo, Results);
Douglas Gregor87c08a52010-08-13 22:48:40 +0000369
370 // Translate global code completions into cached completions.
Douglas Gregorf5586f62010-08-16 18:08:11 +0000371 llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
372
Douglas Gregor87c08a52010-08-13 22:48:40 +0000373 for (unsigned I = 0, N = Results.size(); I != N; ++I) {
374 switch (Results[I].Kind) {
Douglas Gregor8071e422010-08-15 06:18:01 +0000375 case Result::RK_Declaration: {
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000376 bool IsNestedNameSpecifier = false;
Douglas Gregor8071e422010-08-15 06:18:01 +0000377 CachedCodeCompletionResult CachedResult;
Douglas Gregor218937c2011-02-01 19:23:04 +0000378 CachedResult.Completion = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000379 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000380 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000381 IncludeBriefCommentsInCodeCompletion);
Douglas Gregor8071e422010-08-15 06:18:01 +0000382 CachedResult.ShowInContexts = getDeclShowContexts(Results[I].Declaration,
David Blaikie4e4d0842012-03-11 07:00:24 +0000383 Ctx->getLangOpts(),
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000384 IsNestedNameSpecifier);
Douglas Gregor8071e422010-08-15 06:18:01 +0000385 CachedResult.Priority = Results[I].Priority;
386 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000387 CachedResult.Availability = Results[I].Availability;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000388
Douglas Gregorf5586f62010-08-16 18:08:11 +0000389 // Keep track of the type of this completion in an ASTContext-agnostic
390 // way.
Douglas Gregorc4421e92010-08-16 16:46:30 +0000391 QualType UsageType = getDeclUsageType(*Ctx, Results[I].Declaration);
Douglas Gregorf5586f62010-08-16 18:08:11 +0000392 if (UsageType.isNull()) {
Douglas Gregorc4421e92010-08-16 16:46:30 +0000393 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000394 CachedResult.Type = 0;
395 } else {
396 CanQualType CanUsageType
397 = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
398 CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
399
400 // Determine whether we have already seen this type. If so, we save
401 // ourselves the work of formatting the type string by using the
402 // temporary, CanQualType-based hash table to find the associated value.
403 unsigned &TypeValue = CompletionTypes[CanUsageType];
404 if (TypeValue == 0) {
405 TypeValue = CompletionTypes.size();
406 CachedCompletionTypes[QualType(CanUsageType).getAsString()]
407 = TypeValue;
408 }
409
410 CachedResult.Type = TypeValue;
Douglas Gregorc4421e92010-08-16 16:46:30 +0000411 }
Douglas Gregorf5586f62010-08-16 18:08:11 +0000412
Douglas Gregor8071e422010-08-15 06:18:01 +0000413 CachedCompletionResults.push_back(CachedResult);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000414
415 /// Handle nested-name-specifiers in C++.
David Blaikie4e4d0842012-03-11 07:00:24 +0000416 if (TheSema->Context.getLangOpts().CPlusPlus &&
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000417 IsNestedNameSpecifier && !Results[I].StartsNestedNameSpecifier) {
418 // The contexts in which a nested-name-specifier can appear in C++.
Richard Smith026b3582012-08-14 03:13:00 +0000419 uint64_t NNSContexts
420 = (1LL << CodeCompletionContext::CCC_TopLevel)
421 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
422 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
423 | (1LL << CodeCompletionContext::CCC_Statement)
424 | (1LL << CodeCompletionContext::CCC_Expression)
425 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
426 | (1LL << CodeCompletionContext::CCC_EnumTag)
427 | (1LL << CodeCompletionContext::CCC_UnionTag)
428 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag)
429 | (1LL << CodeCompletionContext::CCC_Type)
430 | (1LL << CodeCompletionContext::CCC_PotentiallyQualifiedName)
431 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000432
433 if (isa<NamespaceDecl>(Results[I].Declaration) ||
434 isa<NamespaceAliasDecl>(Results[I].Declaration))
Richard Smith026b3582012-08-14 03:13:00 +0000435 NNSContexts |= (1LL << CodeCompletionContext::CCC_Namespace);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000436
437 if (unsigned RemainingContexts
438 = NNSContexts & ~CachedResult.ShowInContexts) {
439 // If there any contexts where this completion can be a
440 // nested-name-specifier but isn't already an option, create a
441 // nested-name-specifier completion.
442 Results[I].StartsNestedNameSpecifier = true;
Douglas Gregor218937c2011-02-01 19:23:04 +0000443 CachedResult.Completion
444 = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000445 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000446 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000447 IncludeBriefCommentsInCodeCompletion);
Douglas Gregora5fb7c32010-08-16 23:05:20 +0000448 CachedResult.ShowInContexts = RemainingContexts;
449 CachedResult.Priority = CCP_NestedNameSpecifier;
450 CachedResult.TypeClass = STC_Void;
451 CachedResult.Type = 0;
452 CachedCompletionResults.push_back(CachedResult);
453 }
454 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000455 break;
Douglas Gregor8071e422010-08-15 06:18:01 +0000456 }
457
Douglas Gregor87c08a52010-08-13 22:48:40 +0000458 case Result::RK_Keyword:
459 case Result::RK_Pattern:
460 // Ignore keywords and patterns; we don't care, since they are so
461 // easily regenerated.
462 break;
463
464 case Result::RK_Macro: {
465 CachedCodeCompletionResult CachedResult;
Douglas Gregor218937c2011-02-01 19:23:04 +0000466 CachedResult.Completion
467 = Results[I].CreateCodeCompletionString(*TheSema,
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +0000468 *CachedCompletionAllocator,
Argyrios Kyrtzidis7fdc8fd2012-11-16 03:34:57 +0000469 CCTUInfo,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +0000470 IncludeBriefCommentsInCodeCompletion);
Douglas Gregor87c08a52010-08-13 22:48:40 +0000471 CachedResult.ShowInContexts
Richard Smith026b3582012-08-14 03:13:00 +0000472 = (1LL << CodeCompletionContext::CCC_TopLevel)
473 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
474 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
475 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
476 | (1LL << CodeCompletionContext::CCC_ClassStructUnion)
477 | (1LL << CodeCompletionContext::CCC_Statement)
478 | (1LL << CodeCompletionContext::CCC_Expression)
479 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
480 | (1LL << CodeCompletionContext::CCC_MacroNameUse)
481 | (1LL << CodeCompletionContext::CCC_PreprocessorExpression)
482 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
483 | (1LL << CodeCompletionContext::CCC_OtherWithMacros);
Douglas Gregor2ccccb32010-08-23 18:23:48 +0000484
Douglas Gregor87c08a52010-08-13 22:48:40 +0000485 CachedResult.Priority = Results[I].Priority;
486 CachedResult.Kind = Results[I].CursorKind;
Douglas Gregor58ddb602010-08-23 23:00:57 +0000487 CachedResult.Availability = Results[I].Availability;
Douglas Gregor1827e102010-08-16 16:18:59 +0000488 CachedResult.TypeClass = STC_Void;
Douglas Gregorf5586f62010-08-16 18:08:11 +0000489 CachedResult.Type = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000490 CachedCompletionResults.push_back(CachedResult);
491 break;
492 }
493 }
Douglas Gregor87c08a52010-08-13 22:48:40 +0000494 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000495
496 // Save the current top-level hash value.
497 CompletionCacheTopLevelHashValue = CurrentTopLevelHashValue;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000498}
499
500void ASTUnit::ClearCachedCompletionResults() {
Douglas Gregor87c08a52010-08-13 22:48:40 +0000501 CachedCompletionResults.clear();
Douglas Gregorf5586f62010-08-16 18:08:11 +0000502 CachedCompletionTypes.clear();
Douglas Gregor48601b32011-02-16 19:08:06 +0000503 CachedCompletionAllocator = 0;
Douglas Gregor87c08a52010-08-13 22:48:40 +0000504}
505
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000506namespace {
507
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000508/// \brief Gathers information from ASTReader that will be used to initialize
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000509/// a Preprocessor.
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000510class ASTInfoCollector : public ASTReaderListener {
Douglas Gregor998b3d32011-09-01 23:39:15 +0000511 Preprocessor &PP;
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000512 ASTContext &Context;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000513 LangOptions &LangOpt;
Douglas Gregor57016dd2012-10-16 23:40:58 +0000514 IntrusiveRefCntPtr<TargetOptions> &TargetOpts;
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000515 IntrusiveRefCntPtr<TargetInfo> &Target;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000516 unsigned &Counter;
Mike Stump1eb44332009-09-09 15:08:12 +0000517
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000518 bool InitializedLanguage;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000519public:
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000520 ASTInfoCollector(Preprocessor &PP, ASTContext &Context, LangOptions &LangOpt,
Douglas Gregor57016dd2012-10-16 23:40:58 +0000521 IntrusiveRefCntPtr<TargetOptions> &TargetOpts,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000522 IntrusiveRefCntPtr<TargetInfo> &Target,
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000523 unsigned &Counter)
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000524 : PP(PP), Context(Context), LangOpt(LangOpt),
Douglas Gregor9a022bb2012-10-15 16:45:32 +0000525 TargetOpts(TargetOpts), Target(Target),
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000526 Counter(Counter),
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000527 InitializedLanguage(false) {}
Mike Stump1eb44332009-09-09 15:08:12 +0000528
Douglas Gregor27ffa6c2012-10-23 06:18:24 +0000529 virtual bool ReadLanguageOptions(const LangOptions &LangOpts,
Douglas Gregor38295be2012-10-22 23:51:00 +0000530 bool Complain) {
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000531 if (InitializedLanguage)
Douglas Gregor998b3d32011-09-01 23:39:15 +0000532 return false;
533
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000534 LangOpt = LangOpts;
535 InitializedLanguage = true;
536
537 updated();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000538 return false;
539 }
Mike Stump1eb44332009-09-09 15:08:12 +0000540
Douglas Gregor27ffa6c2012-10-23 06:18:24 +0000541 virtual bool ReadTargetOptions(const TargetOptions &TargetOpts,
Douglas Gregor38295be2012-10-22 23:51:00 +0000542 bool Complain) {
Douglas Gregor998b3d32011-09-01 23:39:15 +0000543 // If we've already initialized the target, don't do it again.
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000544 if (Target)
Douglas Gregor998b3d32011-09-01 23:39:15 +0000545 return false;
546
Douglas Gregor57016dd2012-10-16 23:40:58 +0000547 this->TargetOpts = new TargetOptions(TargetOpts);
Douglas Gregor49a87542012-11-16 04:24:59 +0000548 Target = TargetInfo::CreateTargetInfo(PP.getDiagnostics(),
549 &*this->TargetOpts);
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000550
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000551 updated();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000552 return false;
553 }
Mike Stump1eb44332009-09-09 15:08:12 +0000554
Argyrios Kyrtzidis62288ed2012-10-10 02:12:47 +0000555 virtual void ReadCounter(const serialization::ModuleFile &M, unsigned Value) {
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000556 Counter = Value;
557 }
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000558
559private:
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000560 void updated() {
561 if (!Target || !InitializedLanguage)
562 return;
563
564 // Inform the target of the language options.
565 //
566 // FIXME: We shouldn't need to do this, the target should be immutable once
567 // created. This complexity should be lifted elsewhere.
568 Target->setForcedLangOptions(LangOpt);
569
570 // Initialize the preprocessor.
571 PP.Initialize(*Target);
572
573 // Initialize the ASTContext
574 Context.InitBuiltinTypes(*Target);
Dmitri Gribenko6ebf0912013-02-22 14:21:27 +0000575
576 // We didn't have access to the comment options when the ASTContext was
577 // constructed, so register them now.
578 Context.getCommentCommandTraits().registerCommentOptions(
579 LangOpt.CommentOpts);
Argyrios Kyrtzidis7f186332012-09-14 20:24:53 +0000580 }
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000581};
582
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000583 /// \brief Diagnostic consumer that saves each diagnostic it is given.
David Blaikie26e7a902011-09-26 00:01:39 +0000584class StoredDiagnosticConsumer : public DiagnosticConsumer {
Chris Lattner5f9e2722011-07-23 10:55:15 +0000585 SmallVectorImpl<StoredDiagnostic> &StoredDiags;
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000586 SourceManager *SourceMgr;
587
Douglas Gregora88084b2010-02-18 18:08:43 +0000588public:
David Blaikie26e7a902011-09-26 00:01:39 +0000589 explicit StoredDiagnosticConsumer(
Chris Lattner5f9e2722011-07-23 10:55:15 +0000590 SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000591 : StoredDiags(StoredDiags), SourceMgr(0) { }
592
593 virtual void BeginSourceFile(const LangOptions &LangOpts,
594 const Preprocessor *PP = 0) {
595 if (PP)
596 SourceMgr = &PP->getSourceManager();
597 }
598
David Blaikied6471f72011-09-25 23:23:43 +0000599 virtual void HandleDiagnostic(DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +0000600 const Diagnostic &Info);
Douglas Gregora88084b2010-02-18 18:08:43 +0000601};
602
603/// \brief RAII object that optionally captures diagnostics, if
604/// there is no diagnostic client to capture them already.
605class CaptureDroppedDiagnostics {
David Blaikied6471f72011-09-25 23:23:43 +0000606 DiagnosticsEngine &Diags;
David Blaikie26e7a902011-09-26 00:01:39 +0000607 StoredDiagnosticConsumer Client;
David Blaikie78ad0b92011-09-25 23:39:51 +0000608 DiagnosticConsumer *PreviousClient;
Douglas Gregora88084b2010-02-18 18:08:43 +0000609
610public:
David Blaikied6471f72011-09-25 23:23:43 +0000611 CaptureDroppedDiagnostics(bool RequestCapture, DiagnosticsEngine &Diags,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000612 SmallVectorImpl<StoredDiagnostic> &StoredDiags)
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000613 : Diags(Diags), Client(StoredDiags), PreviousClient(0)
Douglas Gregora88084b2010-02-18 18:08:43 +0000614 {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000615 if (RequestCapture || Diags.getClient() == 0) {
616 PreviousClient = Diags.takeClient();
Douglas Gregora88084b2010-02-18 18:08:43 +0000617 Diags.setClient(&Client);
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000618 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000619 }
620
621 ~CaptureDroppedDiagnostics() {
Douglas Gregorbdbb0042010-08-18 22:29:43 +0000622 if (Diags.getClient() == &Client) {
623 Diags.takeClient();
624 Diags.setClient(PreviousClient);
625 }
Douglas Gregora88084b2010-02-18 18:08:43 +0000626 }
627};
628
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000629} // anonymous namespace
630
David Blaikie26e7a902011-09-26 00:01:39 +0000631void StoredDiagnosticConsumer::HandleDiagnostic(DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +0000632 const Diagnostic &Info) {
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000633 // Default implementation (Warnings/errors count).
David Blaikie78ad0b92011-09-25 23:39:51 +0000634 DiagnosticConsumer::HandleDiagnostic(Level, Info);
Argyrios Kyrtzidisf2224d82010-11-18 20:06:46 +0000635
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000636 // Only record the diagnostic if it's part of the source manager we know
637 // about. This effectively drops diagnostics from modules we're building.
638 // FIXME: In the long run, ee don't want to drop source managers from modules.
639 if (!Info.hasSourceManager() || &Info.getSourceManager() == SourceMgr)
640 StoredDiags.push_back(StoredDiagnostic(Level, Info));
Douglas Gregora88084b2010-02-18 18:08:43 +0000641}
642
Argyrios Kyrtzidis7eca8d22013-05-10 01:28:51 +0000643ASTMutationListener *ASTUnit::getASTMutationListener() {
644 if (WriterData)
645 return &WriterData->Writer;
646 return 0;
647}
648
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000649ASTDeserializationListener *ASTUnit::getDeserializationListener() {
650 if (WriterData)
651 return &WriterData->Writer;
652 return 0;
653}
654
Chris Lattner5f9e2722011-07-23 10:55:15 +0000655llvm::MemoryBuffer *ASTUnit::getBufferForFile(StringRef Filename,
Chris Lattner75dfb652010-11-23 09:19:42 +0000656 std::string *ErrorStr) {
Chris Lattner39b49bc2010-11-23 08:35:12 +0000657 assert(FileMgr);
Chris Lattner75dfb652010-11-23 09:19:42 +0000658 return FileMgr->getBufferForFile(Filename, ErrorStr);
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000659}
660
Douglas Gregore47be3e2010-11-11 00:39:14 +0000661/// \brief Configure the diagnostics object for use with ASTUnit.
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000662void ASTUnit::ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> &Diags,
Douglas Gregor0b53cf82011-01-19 01:02:47 +0000663 const char **ArgBegin, const char **ArgEnd,
Douglas Gregore47be3e2010-11-11 00:39:14 +0000664 ASTUnit &AST, bool CaptureDiagnostics) {
665 if (!Diags.getPtr()) {
666 // No diagnostics engine was provided, so create our own diagnostics object
667 // with the default options.
David Blaikie78ad0b92011-09-25 23:39:51 +0000668 DiagnosticConsumer *Client = 0;
Douglas Gregore47be3e2010-11-11 00:39:14 +0000669 if (CaptureDiagnostics)
David Blaikie26e7a902011-09-26 00:01:39 +0000670 Client = new StoredDiagnosticConsumer(AST.StoredDiagnostics);
Douglas Gregor02c23eb2012-10-23 22:26:28 +0000671 Diags = CompilerInstance::createDiagnostics(new DiagnosticOptions(),
Sean Silvad47afb92013-01-20 01:58:28 +0000672 Client,
Douglas Gregorcc2b6532013-05-03 23:07:45 +0000673 /*ShouldOwnClient=*/true);
Douglas Gregore47be3e2010-11-11 00:39:14 +0000674 } else if (CaptureDiagnostics) {
David Blaikie26e7a902011-09-26 00:01:39 +0000675 Diags->setClient(new StoredDiagnosticConsumer(AST.StoredDiagnostics));
Douglas Gregore47be3e2010-11-11 00:39:14 +0000676 }
677}
678
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000679ASTUnit *ASTUnit::LoadFromASTFile(const std::string &Filename,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +0000680 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +0000681 const FileSystemOptions &FileSystemOpts,
Ted Kremenek5cf48762009-10-17 00:34:24 +0000682 bool OnlyLocalDecls,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000683 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +0000684 unsigned NumRemappedFiles,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000685 bool CaptureDiagnostics,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000686 bool AllowPCHWithCompilerErrors,
687 bool UserFilesAreVolatile) {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000688 OwningPtr<ASTUnit> AST(new ASTUnit(true));
Ted Kremenekb547eeb2011-03-18 02:06:56 +0000689
690 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +0000691 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
692 ASTUnitCleanup(AST.get());
David Blaikied6471f72011-09-25 23:23:43 +0000693 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
694 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Ted Kremenek25a11e12011-03-22 01:15:24 +0000695 DiagCleanup(Diags.getPtr());
Ted Kremenekb547eeb2011-03-18 02:06:56 +0000696
Douglas Gregor0b53cf82011-01-19 01:02:47 +0000697 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +0000698
Douglas Gregor7d1d49d2009-10-16 20:01:17 +0000699 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +0000700 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor28019772010-04-05 23:52:57 +0000701 AST->Diagnostics = Diags;
Ted Kremenek4f327862011-03-21 18:40:17 +0000702 AST->FileMgr = new FileManager(FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000703 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Ted Kremenek4f327862011-03-21 18:40:17 +0000704 AST->SourceMgr = new SourceManager(AST->getDiagnostics(),
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +0000705 AST->getFileManager(),
706 UserFilesAreVolatile);
Douglas Gregorc042edd2012-10-24 16:19:39 +0000707 AST->HSOpts = new HeaderSearchOptions();
708
709 AST->HeaderInfo.reset(new HeaderSearch(AST->HSOpts,
710 AST->getFileManager(),
Douglas Gregor51f564f2011-12-31 04:05:44 +0000711 AST->getDiagnostics(),
Douglas Gregordc58aa72012-01-30 06:01:29 +0000712 AST->ASTFileLangOpts,
713 /*Target=*/0));
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000714
Douglas Gregor4db64a42010-01-23 00:14:00 +0000715 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +0000716 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
717 if (const llvm::MemoryBuffer *
718 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
719 // Create the file entry for the file that we're mapping from.
720 const FileEntry *FromFile
721 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
722 memBuf->getBufferSize(),
723 0);
724 if (!FromFile) {
725 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
726 << RemappedFiles[I].first;
727 delete memBuf;
728 continue;
729 }
730
731 // Override the contents of the "from" file with the contents of
732 // the "to" file.
733 AST->getSourceManager().overrideFileContents(FromFile, memBuf);
734
735 } else {
736 const char *fname = fileOrBuf.get<const char *>();
737 const FileEntry *ToFile = AST->FileMgr->getFile(fname);
738 if (!ToFile) {
739 AST->getDiagnostics().Report(diag::err_fe_remap_missing_to_file)
740 << RemappedFiles[I].first << fname;
741 continue;
742 }
743
744 // Create the file entry for the file that we're mapping from.
745 const FileEntry *FromFile
746 = AST->getFileManager().getVirtualFile(RemappedFiles[I].first,
747 ToFile->getSize(),
748 0);
749 if (!FromFile) {
750 AST->getDiagnostics().Report(diag::err_fe_remap_missing_from_file)
751 << RemappedFiles[I].first;
752 delete memBuf;
753 continue;
754 }
755
756 // Override the contents of the "from" file with the contents of
757 // the "to" file.
758 AST->getSourceManager().overrideFileContents(FromFile, ToFile);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000759 }
Douglas Gregor4db64a42010-01-23 00:14:00 +0000760 }
761
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000762 // Gather Info for preprocessor construction later on.
Mike Stump1eb44332009-09-09 15:08:12 +0000763
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000764 HeaderSearch &HeaderInfo = *AST->HeaderInfo.get();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000765 unsigned Counter;
766
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000767 OwningPtr<ASTReader> Reader;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000768
Douglas Gregor36a16492012-10-24 17:46:57 +0000769 AST->PP = new Preprocessor(new PreprocessorOptions(),
770 AST->getDiagnostics(), AST->ASTFileLangOpts,
Douglas Gregor998b3d32011-09-01 23:39:15 +0000771 /*Target=*/0, AST->getSourceManager(), HeaderInfo,
772 *AST,
773 /*IILookup=*/0,
774 /*OwnsHeaderSearch=*/false,
775 /*DelayInitialization=*/true);
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000776 Preprocessor &PP = *AST->PP;
777
778 AST->Ctx = new ASTContext(AST->ASTFileLangOpts,
779 AST->getSourceManager(),
780 /*Target=*/0,
781 PP.getIdentifierTable(),
782 PP.getSelectorTable(),
783 PP.getBuiltinInfo(),
784 /* size_reserve = */0,
785 /*DelayInitialization=*/true);
786 ASTContext &Context = *AST->Ctx;
Douglas Gregor998b3d32011-09-01 23:39:15 +0000787
Argyrios Kyrtzidis98e95bf2012-09-15 01:10:20 +0000788 bool disableValid = false;
789 if (::getenv("LIBCLANG_DISABLE_PCH_VALIDATION"))
790 disableValid = true;
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000791 Reader.reset(new ASTReader(PP, Context,
792 /*isysroot=*/"",
Argyrios Kyrtzidis98e95bf2012-09-15 01:10:20 +0000793 /*DisableValidation=*/disableValid,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +0000794 AllowPCHWithCompilerErrors));
Ted Kremenek8c647de2011-05-04 23:27:12 +0000795
796 // Recover resources if we crash before exiting this method.
797 llvm::CrashRecoveryContextCleanupRegistrar<ASTReader>
798 ReaderCleanup(Reader.get());
799
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000800 Reader->setListener(new ASTInfoCollector(*AST->PP, Context,
Argyrios Kyrtzidisf9ba8512013-05-08 23:46:55 +0000801 AST->ASTFileLangOpts,
Douglas Gregor9a022bb2012-10-15 16:45:32 +0000802 AST->TargetOpts, AST->Target,
Douglas Gregor43998902012-10-25 00:09:28 +0000803 Counter));
Daniel Dunbarcc318932009-09-03 05:59:35 +0000804
Douglas Gregor38295be2012-10-22 23:51:00 +0000805 switch (Reader->ReadAST(Filename, serialization::MK_MainFile,
Argyrios Kyrtzidis958bcaf2012-11-15 18:57:22 +0000806 SourceLocation(), ASTReader::ARR_None)) {
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000807 case ASTReader::Success:
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000808 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000809
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000810 case ASTReader::Failure:
Douglas Gregor677e15f2013-03-19 00:28:20 +0000811 case ASTReader::Missing:
Douglas Gregor4825fd72012-10-22 22:50:17 +0000812 case ASTReader::OutOfDate:
813 case ASTReader::VersionMismatch:
814 case ASTReader::ConfigurationMismatch:
815 case ASTReader::HadErrors:
Douglas Gregor3687e9d2010-04-05 21:10:19 +0000816 AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000817 return NULL;
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000818 }
Mike Stump1eb44332009-09-09 15:08:12 +0000819
Daniel Dunbar68d40e22009-12-02 08:44:16 +0000820 AST->OriginalSourceFile = Reader->getOriginalSourceFile();
821
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000822 PP.setCounterValue(Counter);
Mike Stump1eb44332009-09-09 15:08:12 +0000823
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000824 // Attach the AST reader to the AST context as an external AST
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000825 // source, so that declarations will be deserialized from the
Sebastian Redl3c7f4132010-08-18 23:57:06 +0000826 // AST file as needed.
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000827 ASTReader *ReaderPtr = Reader.get();
Dylan Noblesmith6f42b622012-02-05 02:12:40 +0000828 OwningPtr<ExternalASTSource> Source(Reader.take());
Ted Kremenek8c647de2011-05-04 23:27:12 +0000829
830 // Unregister the cleanup for ASTReader. It will get cleaned up
831 // by the ASTUnit cleanup.
832 ReaderCleanup.unregister();
833
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000834 Context.setExternalSource(Source);
835
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000836 // Create an AST consumer, even though it isn't used.
837 AST->Consumer.reset(new ASTConsumer);
838
Sebastian Redlc43b54c2010-08-18 23:56:43 +0000839 // Create a semantic analysis object and tell the AST reader about it.
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000840 AST->TheSema.reset(new Sema(PP, Context, *AST->Consumer));
841 AST->TheSema->Initialize();
842 ReaderPtr->InitializeSema(*AST->TheSema);
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +0000843 AST->Reader = ReaderPtr;
Douglas Gregor914ed9d2010-08-13 03:15:25 +0000844
Douglas Gregora4a90ca2013-05-03 22:58:43 +0000845 // Tell the diagnostic client that we have started a source file.
846 AST->getDiagnostics().getClient()->BeginSourceFile(Context.getLangOpts(),&PP);
847
Mike Stump1eb44332009-09-09 15:08:12 +0000848 return AST.take();
Argyrios Kyrtzidis0853a022009-06-20 08:08:23 +0000849}
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000850
851namespace {
852
Douglas Gregor9b7db622011-02-16 18:16:54 +0000853/// \brief Preprocessor callback class that updates a hash value with the names
854/// of all macros that have been defined by the translation unit.
855class MacroDefinitionTrackerPPCallbacks : public PPCallbacks {
856 unsigned &Hash;
857
858public:
859 explicit MacroDefinitionTrackerPPCallbacks(unsigned &Hash) : Hash(Hash) { }
860
Argyrios Kyrtzidisc5159782013-02-24 00:05:14 +0000861 virtual void MacroDefined(const Token &MacroNameTok,
862 const MacroDirective *MD) {
Douglas Gregor9b7db622011-02-16 18:16:54 +0000863 Hash = llvm::HashString(MacroNameTok.getIdentifierInfo()->getName(), Hash);
864 }
865};
866
867/// \brief Add the given declaration to the hash of all top-level entities.
868void AddTopLevelDeclarationToHash(Decl *D, unsigned &Hash) {
869 if (!D)
870 return;
871
872 DeclContext *DC = D->getDeclContext();
873 if (!DC)
874 return;
875
876 if (!(DC->isTranslationUnit() || DC->getLookupParent()->isTranslationUnit()))
877 return;
878
879 if (NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
880 if (ND->getIdentifier())
881 Hash = llvm::HashString(ND->getIdentifier()->getName(), Hash);
882 else if (DeclarationName Name = ND->getDeclName()) {
883 std::string NameStr = Name.getAsString();
884 Hash = llvm::HashString(NameStr, Hash);
885 }
886 return;
Argyrios Kyrtzidis1f3ff6a2013-06-24 21:19:12 +0000887 }
888
889 if (ImportDecl *ImportD = dyn_cast<ImportDecl>(D)) {
890 if (Module *Mod = ImportD->getImportedModule()) {
891 std::string ModName = Mod->getFullModuleName();
892 Hash = llvm::HashString(ModName, Hash);
893 }
894 return;
895 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000896}
897
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000898class TopLevelDeclTrackerConsumer : public ASTConsumer {
899 ASTUnit &Unit;
Douglas Gregor9b7db622011-02-16 18:16:54 +0000900 unsigned &Hash;
901
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000902public:
Douglas Gregor9b7db622011-02-16 18:16:54 +0000903 TopLevelDeclTrackerConsumer(ASTUnit &_Unit, unsigned &Hash)
904 : Unit(_Unit), Hash(Hash) {
905 Hash = 0;
906 }
Douglas Gregor9b7db622011-02-16 18:16:54 +0000907
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000908 void handleTopLevelDecl(Decl *D) {
Argyrios Kyrtzidis35593a92011-11-16 02:35:10 +0000909 if (!D)
910 return;
911
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000912 // FIXME: Currently ObjC method declarations are incorrectly being
913 // reported as top-level declarations, even though their DeclContext
914 // is the containing ObjC @interface/@implementation. This is a
915 // fundamental problem in the parser right now.
916 if (isa<ObjCMethodDecl>(D))
917 return;
918
919 AddTopLevelDeclarationToHash(D, Hash);
920 Unit.addTopLevelDecl(D);
921
922 handleFileLevelDecl(D);
923 }
924
925 void handleFileLevelDecl(Decl *D) {
926 Unit.addFileLevelDecl(D);
927 if (NamespaceDecl *NSD = dyn_cast<NamespaceDecl>(D)) {
928 for (NamespaceDecl::decl_iterator
929 I = NSD->decls_begin(), E = NSD->decls_end(); I != E; ++I)
930 handleFileLevelDecl(*I);
Ted Kremenekda5a4282010-05-03 20:16:35 +0000931 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000932 }
Sebastian Redl27372b42010-08-11 18:52:41 +0000933
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +0000934 bool HandleTopLevelDecl(DeclGroupRef D) {
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000935 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it)
936 handleTopLevelDecl(*it);
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +0000937 return true;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000938 }
939
Sebastian Redl27372b42010-08-11 18:52:41 +0000940 // We're not interested in "interesting" decls.
941 void HandleInterestingDecl(DeclGroupRef) {}
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +0000942
943 void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
944 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it)
945 handleTopLevelDecl(*it);
946 }
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000947
Argyrios Kyrtzidis7eca8d22013-05-10 01:28:51 +0000948 virtual ASTMutationListener *GetASTMutationListener() {
949 return Unit.getASTMutationListener();
950 }
951
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +0000952 virtual ASTDeserializationListener *GetASTDeserializationListener() {
953 return Unit.getDeserializationListener();
954 }
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000955};
956
957class TopLevelDeclTrackerAction : public ASTFrontendAction {
958public:
959 ASTUnit &Unit;
960
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000961 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000962 StringRef InFile) {
Douglas Gregor9b7db622011-02-16 18:16:54 +0000963 CI.getPreprocessor().addPPCallbacks(
964 new MacroDefinitionTrackerPPCallbacks(Unit.getCurrentTopLevelHashValue()));
965 return new TopLevelDeclTrackerConsumer(Unit,
966 Unit.getCurrentTopLevelHashValue());
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000967 }
968
969public:
Daniel Dunbarf772d1e2009-12-04 08:17:33 +0000970 TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
971
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000972 virtual bool hasCodeCompletionSupport() const { return false; }
Douglas Gregor467dc882011-08-25 22:30:56 +0000973 virtual TranslationUnitKind getTranslationUnitKind() {
974 return Unit.getTranslationUnitKind();
Douglas Gregordf95a132010-08-09 20:45:32 +0000975 }
Daniel Dunbar521bf9c2009-12-01 09:51:01 +0000976};
977
Benjamin Kramerb62b8b92013-06-11 13:07:19 +0000978class PrecompilePreambleAction : public ASTFrontendAction {
979 ASTUnit &Unit;
980 bool HasEmittedPreamblePCH;
981
982public:
983 explicit PrecompilePreambleAction(ASTUnit &Unit)
984 : Unit(Unit), HasEmittedPreamblePCH(false) {}
985
986 virtual ASTConsumer *CreateASTConsumer(CompilerInstance &CI,
987 StringRef InFile);
988 bool hasEmittedPreamblePCH() const { return HasEmittedPreamblePCH; }
989 void setHasEmittedPreamblePCH() { HasEmittedPreamblePCH = true; }
990 virtual bool shouldEraseOutputFiles() { return !hasEmittedPreamblePCH(); }
991
992 virtual bool hasCodeCompletionSupport() const { return false; }
993 virtual bool hasASTFileSupport() const { return false; }
994 virtual TranslationUnitKind getTranslationUnitKind() { return TU_Prefix; }
995};
996
Argyrios Kyrtzidis92ddef12011-09-19 20:40:48 +0000997class PrecompilePreambleConsumer : public PCHGenerator {
Douglas Gregor1d715ac2010-08-03 08:14:03 +0000998 ASTUnit &Unit;
Benjamin Kramerb62b8b92013-06-11 13:07:19 +0000999 unsigned &Hash;
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001000 std::vector<Decl *> TopLevelDecls;
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001001 PrecompilePreambleAction *Action;
1002
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001003public:
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001004 PrecompilePreambleConsumer(ASTUnit &Unit, PrecompilePreambleAction *Action,
1005 const Preprocessor &PP, StringRef isysroot,
1006 raw_ostream *Out)
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001007 : PCHGenerator(PP, "", 0, isysroot, Out, /*AllowASTWithErrors=*/true),
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001008 Unit(Unit), Hash(Unit.getCurrentTopLevelHashValue()), Action(Action) {
Douglas Gregor9b7db622011-02-16 18:16:54 +00001009 Hash = 0;
1010 }
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001011
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +00001012 virtual bool HandleTopLevelDecl(DeclGroupRef D) {
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001013 for (DeclGroupRef::iterator it = D.begin(), ie = D.end(); it != ie; ++it) {
1014 Decl *D = *it;
1015 // FIXME: Currently ObjC method declarations are incorrectly being
1016 // reported as top-level declarations, even though their DeclContext
1017 // is the containing ObjC @interface/@implementation. This is a
1018 // fundamental problem in the parser right now.
1019 if (isa<ObjCMethodDecl>(D))
1020 continue;
Douglas Gregor9b7db622011-02-16 18:16:54 +00001021 AddTopLevelDeclarationToHash(D, Hash);
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001022 TopLevelDecls.push_back(D);
1023 }
Argyrios Kyrtzidis88c25962011-11-18 00:26:59 +00001024 return true;
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001025 }
1026
1027 virtual void HandleTranslationUnit(ASTContext &Ctx) {
1028 PCHGenerator::HandleTranslationUnit(Ctx);
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001029 if (hasEmittedPCH()) {
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001030 // Translate the top-level declarations we captured during
1031 // parsing into declaration IDs in the precompiled
1032 // preamble. This will allow us to deserialize those top-level
1033 // declarations when requested.
1034 for (unsigned I = 0, N = TopLevelDecls.size(); I != N; ++I)
1035 Unit.addTopLevelDeclFromPreamble(
1036 getWriter().getDeclID(TopLevelDecls[I]));
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001037
1038 Action->setHasEmittedPreamblePCH();
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001039 }
1040 }
1041};
1042
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001043}
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001044
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001045ASTConsumer *PrecompilePreambleAction::CreateASTConsumer(CompilerInstance &CI,
1046 StringRef InFile) {
1047 std::string Sysroot;
1048 std::string OutputFile;
1049 raw_ostream *OS = 0;
1050 if (GeneratePCHAction::ComputeASTConsumerArguments(CI, InFile, Sysroot,
1051 OutputFile, OS))
1052 return 0;
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001053
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001054 if (!CI.getFrontendOpts().RelocatablePCH)
1055 Sysroot.clear();
Douglas Gregor832d6202011-07-22 16:35:34 +00001056
Benjamin Kramerb62b8b92013-06-11 13:07:19 +00001057 CI.getPreprocessor().addPPCallbacks(new MacroDefinitionTrackerPPCallbacks(
1058 Unit.getCurrentTopLevelHashValue()));
1059 return new PrecompilePreambleConsumer(Unit, this, CI.getPreprocessor(),
1060 Sysroot, OS);
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001061}
1062
Benjamin Kramerfe57db22013-05-05 12:39:28 +00001063static bool isNonDriverDiag(const StoredDiagnostic &StoredDiag) {
1064 return StoredDiag.getLocation().isValid();
1065}
1066
1067static void
1068checkAndRemoveNonDriverDiags(SmallVectorImpl<StoredDiagnostic> &StoredDiags) {
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001069 // Get rid of stored diagnostics except the ones from the driver which do not
1070 // have a source location.
Benjamin Kramerfe57db22013-05-05 12:39:28 +00001071 StoredDiags.erase(
1072 std::remove_if(StoredDiags.begin(), StoredDiags.end(), isNonDriverDiag),
1073 StoredDiags.end());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001074}
1075
1076static void checkAndSanitizeDiags(SmallVectorImpl<StoredDiagnostic> &
1077 StoredDiagnostics,
1078 SourceManager &SM) {
1079 // The stored diagnostic has the old source manager in it; update
1080 // the locations to refer into the new source manager. Since we've
1081 // been careful to make sure that the source manager's state
1082 // before and after are identical, so that we can reuse the source
1083 // location itself.
1084 for (unsigned I = 0, N = StoredDiagnostics.size(); I < N; ++I) {
1085 if (StoredDiagnostics[I].getLocation().isValid()) {
1086 FullSourceLoc Loc(StoredDiagnostics[I].getLocation(), SM);
1087 StoredDiagnostics[I].setLocation(Loc);
1088 }
1089 }
1090}
1091
Douglas Gregorabc563f2010-07-19 21:46:24 +00001092/// Parse the source file into a translation unit using the given compiler
1093/// invocation, replacing the current translation unit.
1094///
1095/// \returns True if a failure occurred that causes the ASTUnit not to
1096/// contain any translation-unit information, false otherwise.
Douglas Gregor754f3492010-07-24 00:38:13 +00001097bool ASTUnit::Parse(llvm::MemoryBuffer *OverrideMainBuffer) {
Douglas Gregor28233422010-07-27 14:52:07 +00001098 delete SavedMainFileBuffer;
1099 SavedMainFileBuffer = 0;
1100
Ted Kremenek4f327862011-03-21 18:40:17 +00001101 if (!Invocation) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001102 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001103 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +00001104 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001105
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001106 // Create the compiler instance to use for building the AST.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001107 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001108
1109 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001110 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1111 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001112
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001113 IntrusiveRefCntPtr<CompilerInvocation>
Argyrios Kyrtzidis26d43cd2011-09-12 18:09:38 +00001114 CCInvocation(new CompilerInvocation(*Invocation));
1115
1116 Clang->setInvocation(CCInvocation.getPtr());
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001117 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregorabc563f2010-07-19 21:46:24 +00001118
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001119 // Set up diagnostics, capturing any diagnostics that would
1120 // otherwise be dropped.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001121 Clang->setDiagnostics(&getDiagnostics());
Douglas Gregor3687e9d2010-04-05 21:10:19 +00001122
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001123 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001124 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001125 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00001126 if (!Clang->hasTarget()) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001127 delete OverrideMainBuffer;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001128 return true;
Douglas Gregor671947b2010-08-19 01:33:06 +00001129 }
1130
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001131 // Inform the target of the language options.
1132 //
1133 // FIXME: We shouldn't need to do this, the target should be immutable once
1134 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001135 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001136
Ted Kremenek03201fb2011-03-21 18:40:07 +00001137 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001138 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001139 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001140 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001141 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Daniel Dunbarfaddc3e2010-06-07 23:26:47 +00001142 "IR inputs not support here!");
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001143
Douglas Gregorabc563f2010-07-19 21:46:24 +00001144 // Configure the various subsystems.
1145 // FIXME: Should we retain the previous file manager?
Ted Kremenekd3b74d92011-11-17 23:01:24 +00001146 LangOpts = &Clang->getLangOpts();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001147 FileSystemOpts = Clang->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00001148 FileMgr = new FileManager(FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001149 SourceMgr = new SourceManager(getDiagnostics(), *FileMgr,
1150 UserFilesAreVolatile);
Douglas Gregor914ed9d2010-08-13 03:15:25 +00001151 TheSema.reset();
Ted Kremenek4f327862011-03-21 18:40:17 +00001152 Ctx = 0;
1153 PP = 0;
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +00001154 Reader = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001155
1156 // Clear out old caches and data.
1157 TopLevelDecls.clear();
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00001158 clearFileLevelDecls();
Douglas Gregorabc563f2010-07-19 21:46:24 +00001159 CleanTemporaryFiles();
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001160
Douglas Gregorf128fed2010-08-20 00:02:33 +00001161 if (!OverrideMainBuffer) {
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001162 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregorf128fed2010-08-20 00:02:33 +00001163 TopLevelDeclsInPreamble.clear();
1164 }
1165
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001166 // Create a file manager object to provide access to and cache the filesystem.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001167 Clang->setFileManager(&getFileManager());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001168
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001169 // Create the source manager.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001170 Clang->setSourceManager(&getSourceManager());
Douglas Gregorabc563f2010-07-19 21:46:24 +00001171
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001172 // If the main file has been overridden due to the use of a preamble,
1173 // make that override happen and introduce the preamble.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001174 PreprocessorOptions &PreprocessorOpts = Clang->getPreprocessorOpts();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001175 if (OverrideMainBuffer) {
1176 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
1177 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
1178 PreprocessorOpts.PrecompiledPreambleBytes.second
1179 = PreambleEndsAtStartOfLine;
Ted Kremenek1872b312011-10-27 17:55:18 +00001180 PreprocessorOpts.ImplicitPCHInclude = getPreambleFile(this);
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001181 PreprocessorOpts.DisablePCHValidation = true;
Douglas Gregor28233422010-07-27 14:52:07 +00001182
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001183 // The stored diagnostic has the old source manager in it; update
1184 // the locations to refer into the new source manager. Since we've
1185 // been careful to make sure that the source manager's state
1186 // before and after are identical, so that we can reuse the source
1187 // location itself.
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001188 checkAndSanitizeDiags(StoredDiagnostics, getSourceManager());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001189
1190 // Keep track of the override buffer;
1191 SavedMainFileBuffer = OverrideMainBuffer;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001192 }
1193
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001194 OwningPtr<TopLevelDeclTrackerAction> Act(
Ted Kremenek25a11e12011-03-22 01:15:24 +00001195 new TopLevelDeclTrackerAction(*this));
1196
1197 // Recover resources if we crash before exiting this method.
1198 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1199 ActCleanup(Act.get());
1200
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00001201 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0]))
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001202 goto error;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001203
1204 if (OverrideMainBuffer) {
Ted Kremenek1872b312011-10-27 17:55:18 +00001205 std::string ModName = getPreambleFile(this);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001206 TranslateStoredDiagnostics(Clang->getModuleManager(), ModName,
1207 getSourceManager(), PreambleDiagnostics,
1208 StoredDiagnostics);
1209 }
1210
Argyrios Kyrtzidis374a00b2012-06-08 05:48:06 +00001211 if (!Act->Execute())
1212 goto error;
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001213
1214 transferASTDataFromCompilerInstance(*Clang);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001215
Daniel Dunbarf772d1e2009-12-04 08:17:33 +00001216 Act->EndSourceFile();
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001217
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001218 FailedParseDiagnostics.clear();
1219
Douglas Gregorabc563f2010-07-19 21:46:24 +00001220 return false;
Ted Kremenek4f327862011-03-21 18:40:17 +00001221
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001222error:
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001223 // Remove the overridden buffer we used for the preamble.
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001224 if (OverrideMainBuffer) {
Douglas Gregor671947b2010-08-19 01:33:06 +00001225 delete OverrideMainBuffer;
Douglas Gregor37cf6632010-10-06 21:11:08 +00001226 SavedMainFileBuffer = 0;
Douglas Gregorfae3b2f2010-07-27 00:27:13 +00001227 }
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001228
1229 // Keep the ownership of the data in the ASTUnit because the client may
1230 // want to see the diagnostics.
1231 transferASTDataFromCompilerInstance(*Clang);
1232 FailedParseDiagnostics.swap(StoredDiagnostics);
Douglas Gregord54eb442010-10-12 16:25:54 +00001233 StoredDiagnostics.clear();
Argyrios Kyrtzidis3e9d3262011-10-24 17:25:20 +00001234 NumStoredDiagnosticsFromDriver = 0;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001235 return true;
1236}
1237
Douglas Gregor44c181a2010-07-23 00:33:23 +00001238/// \brief Simple function to retrieve a path for a preamble precompiled header.
1239static std::string GetPreamblePCHPath() {
1240 // FIXME: This is lame; sys::Path should provide this function (in particular,
1241 // it should know how to find the temporary files dir).
1242 // FIXME: This is really lame. I copied this code from the Driver!
Douglas Gregor424668c2010-09-11 18:05:19 +00001243 // FIXME: This is a hack so that we can override the preamble file during
1244 // crash-recovery testing, which is the only case where the preamble files
1245 // are not necessarily cleaned up.
1246 const char *TmpFile = ::getenv("CINDEXTEST_PREAMBLE_FILE");
1247 if (TmpFile)
1248 return TmpFile;
1249
Douglas Gregor44c181a2010-07-23 00:33:23 +00001250 std::string Error;
1251 const char *TmpDir = ::getenv("TMPDIR");
1252 if (!TmpDir)
1253 TmpDir = ::getenv("TEMP");
1254 if (!TmpDir)
1255 TmpDir = ::getenv("TMP");
Douglas Gregorc6cb2b02010-09-11 17:51:16 +00001256#ifdef LLVM_ON_WIN32
1257 if (!TmpDir)
1258 TmpDir = ::getenv("USERPROFILE");
1259#endif
Douglas Gregor44c181a2010-07-23 00:33:23 +00001260 if (!TmpDir)
1261 TmpDir = "/tmp";
1262 llvm::sys::Path P(TmpDir);
Douglas Gregorc6cb2b02010-09-11 17:51:16 +00001263 P.createDirectoryOnDisk(true);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001264 P.appendComponent("preamble");
Douglas Gregor6bf18302010-08-11 13:06:56 +00001265 P.appendSuffix("pch");
Argyrios Kyrtzidisbc9d5a32011-07-21 18:44:46 +00001266 if (P.makeUnique(/*reuse_current=*/false, /*ErrMsg*/0))
Douglas Gregor44c181a2010-07-23 00:33:23 +00001267 return std::string();
1268
Douglas Gregor44c181a2010-07-23 00:33:23 +00001269 return P.str();
1270}
1271
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001272/// \brief Compute the preamble for the main file, providing the source buffer
1273/// that corresponds to the main file along with a pair (bytes, start-of-line)
1274/// that describes the preamble.
1275std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> >
Douglas Gregordf95a132010-08-09 20:45:32 +00001276ASTUnit::ComputePreamble(CompilerInvocation &Invocation,
1277 unsigned MaxLines, bool &CreatedBuffer) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001278 FrontendOptions &FrontendOpts = Invocation.getFrontendOpts();
Chris Lattner39b49bc2010-11-23 08:35:12 +00001279 PreprocessorOptions &PreprocessorOpts = Invocation.getPreprocessorOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001280 CreatedBuffer = false;
1281
Douglas Gregor44c181a2010-07-23 00:33:23 +00001282 // Try to determine if the main file has been remapped, either from the
1283 // command line (to another file) or directly through the compiler invocation
1284 // (to a memory buffer).
Douglas Gregor175c4a92010-07-23 23:58:40 +00001285 llvm::MemoryBuffer *Buffer = 0;
Rafael Espindola105b2072013-06-18 19:40:07 +00001286 std::string MainFilePath(FrontendOpts.Inputs[0].getFile());
1287 uint64_t MainFileID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001288 if (!llvm::sys::fs::getUniqueID(MainFilePath, MainFileID)) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001289 // Check whether there is a file-file remapping of the main file
1290 for (PreprocessorOptions::remapped_file_iterator
Douglas Gregor175c4a92010-07-23 23:58:40 +00001291 M = PreprocessorOpts.remapped_file_begin(),
1292 E = PreprocessorOpts.remapped_file_end();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001293 M != E;
1294 ++M) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001295 std::string MPath(M->first);
1296 uint64_t MID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001297 if (!llvm::sys::fs::getUniqueID(MPath, MID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001298 if (MainFileID == MID) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001299 // We found a remapping. Try to load the resulting, remapped source.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001300 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001301 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001302 CreatedBuffer = false;
1303 }
1304
Argyrios Kyrtzidis389db162010-11-03 22:45:23 +00001305 Buffer = getBufferForFile(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001306 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001307 return std::make_pair((llvm::MemoryBuffer*)0,
1308 std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001309 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001310 }
1311 }
1312 }
1313
1314 // Check whether there is a file-buffer remapping. It supercedes the
1315 // file-file remapping.
1316 for (PreprocessorOptions::remapped_file_buffer_iterator
1317 M = PreprocessorOpts.remapped_file_buffer_begin(),
1318 E = PreprocessorOpts.remapped_file_buffer_end();
1319 M != E;
1320 ++M) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001321 std::string MPath(M->first);
1322 uint64_t MID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00001323 if (!llvm::sys::fs::getUniqueID(MPath, MID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00001324 if (MainFileID == MID) {
1325 // We found a remapping.
Douglas Gregor175c4a92010-07-23 23:58:40 +00001326 if (CreatedBuffer) {
Douglas Gregor44c181a2010-07-23 00:33:23 +00001327 delete Buffer;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001328 CreatedBuffer = false;
1329 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001330
Douglas Gregor175c4a92010-07-23 23:58:40 +00001331 Buffer = const_cast<llvm::MemoryBuffer *>(M->second);
Douglas Gregor44c181a2010-07-23 00:33:23 +00001332 }
1333 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001334 }
Douglas Gregor44c181a2010-07-23 00:33:23 +00001335 }
1336
1337 // If the main source file was not remapped, load it now.
1338 if (!Buffer) {
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001339 Buffer = getBufferForFile(FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001340 if (!Buffer)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001341 return std::make_pair((llvm::MemoryBuffer*)0, std::make_pair(0, true));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001342
1343 CreatedBuffer = true;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001344 }
1345
Argyrios Kyrtzidis03c107a2011-08-25 20:39:19 +00001346 return std::make_pair(Buffer, Lexer::ComputePreamble(Buffer,
Ted Kremenekd3b74d92011-11-17 23:01:24 +00001347 *Invocation.getLangOpts(),
Argyrios Kyrtzidis03c107a2011-08-25 20:39:19 +00001348 MaxLines));
Douglas Gregor175c4a92010-07-23 23:58:40 +00001349}
1350
Douglas Gregor754f3492010-07-24 00:38:13 +00001351static llvm::MemoryBuffer *CreatePaddedMainFileBuffer(llvm::MemoryBuffer *Old,
Douglas Gregor754f3492010-07-24 00:38:13 +00001352 unsigned NewSize,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001353 StringRef NewName) {
Douglas Gregor754f3492010-07-24 00:38:13 +00001354 llvm::MemoryBuffer *Result
1355 = llvm::MemoryBuffer::getNewUninitMemBuffer(NewSize, NewName);
1356 memcpy(const_cast<char*>(Result->getBufferStart()),
1357 Old->getBufferStart(), Old->getBufferSize());
1358 memset(const_cast<char*>(Result->getBufferStart()) + Old->getBufferSize(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001359 ' ', NewSize - Old->getBufferSize() - 1);
1360 const_cast<char*>(Result->getBufferEnd())[-1] = '\n';
Douglas Gregor754f3492010-07-24 00:38:13 +00001361
Douglas Gregor754f3492010-07-24 00:38:13 +00001362 return Result;
1363}
1364
Douglas Gregor175c4a92010-07-23 23:58:40 +00001365/// \brief Attempt to build or re-use a precompiled preamble when (re-)parsing
1366/// the source file.
1367///
1368/// This routine will compute the preamble of the main source file. If a
1369/// non-trivial preamble is found, it will precompile that preamble into a
1370/// precompiled header so that the precompiled preamble can be used to reduce
1371/// reparsing time. If a precompiled preamble has already been constructed,
1372/// this routine will determine if it is still valid and, if so, avoid
1373/// rebuilding the precompiled preamble.
1374///
Douglas Gregordf95a132010-08-09 20:45:32 +00001375/// \param AllowRebuild When true (the default), this routine is
1376/// allowed to rebuild the precompiled preamble if it is found to be
1377/// out-of-date.
1378///
1379/// \param MaxLines When non-zero, the maximum number of lines that
1380/// can occur within the preamble.
1381///
Douglas Gregor754f3492010-07-24 00:38:13 +00001382/// \returns If the precompiled preamble can be used, returns a newly-allocated
1383/// buffer that should be used in place of the main file when doing so.
1384/// Otherwise, returns a NULL pointer.
Douglas Gregordf95a132010-08-09 20:45:32 +00001385llvm::MemoryBuffer *ASTUnit::getMainBufferWithPrecompiledPreamble(
Douglas Gregor01b6e312011-07-01 18:22:13 +00001386 const CompilerInvocation &PreambleInvocationIn,
Douglas Gregordf95a132010-08-09 20:45:32 +00001387 bool AllowRebuild,
1388 unsigned MaxLines) {
Douglas Gregor01b6e312011-07-01 18:22:13 +00001389
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001390 IntrusiveRefCntPtr<CompilerInvocation>
Douglas Gregor01b6e312011-07-01 18:22:13 +00001391 PreambleInvocation(new CompilerInvocation(PreambleInvocationIn));
1392 FrontendOptions &FrontendOpts = PreambleInvocation->getFrontendOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001393 PreprocessorOptions &PreprocessorOpts
Douglas Gregor01b6e312011-07-01 18:22:13 +00001394 = PreambleInvocation->getPreprocessorOpts();
Douglas Gregor175c4a92010-07-23 23:58:40 +00001395
1396 bool CreatedPreambleBuffer = false;
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001397 std::pair<llvm::MemoryBuffer *, std::pair<unsigned, bool> > NewPreamble
Douglas Gregor01b6e312011-07-01 18:22:13 +00001398 = ComputePreamble(*PreambleInvocation, MaxLines, CreatedPreambleBuffer);
Douglas Gregor175c4a92010-07-23 23:58:40 +00001399
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001400 // If ComputePreamble() Take ownership of the preamble buffer.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001401 OwningPtr<llvm::MemoryBuffer> OwnedPreambleBuffer;
Douglas Gregor73fc9122010-11-16 20:45:51 +00001402 if (CreatedPreambleBuffer)
1403 OwnedPreambleBuffer.reset(NewPreamble.first);
1404
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001405 if (!NewPreamble.second.first) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001406 // We couldn't find a preamble in the main source. Clear out the current
1407 // preamble, if we have one. It's obviously no good any more.
1408 Preamble.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +00001409 erasePreambleFile(this);
Douglas Gregoreababfb2010-08-04 05:53:38 +00001410
1411 // The next time we actually see a preamble, precompile it.
1412 PreambleRebuildCounter = 1;
Douglas Gregor754f3492010-07-24 00:38:13 +00001413 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001414 }
1415
1416 if (!Preamble.empty()) {
1417 // We've previously computed a preamble. Check whether we have the same
1418 // preamble now that we did before, and that there's enough space in
1419 // the main-file buffer within the precompiled preamble to fit the
1420 // new main file.
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001421 if (Preamble.size() == NewPreamble.second.first &&
1422 PreambleEndsAtStartOfLine == NewPreamble.second.second &&
Douglas Gregor592508e2010-07-24 00:42:07 +00001423 NewPreamble.first->getBufferSize() < PreambleReservedSize-2 &&
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001424 memcmp(Preamble.getBufferStart(), NewPreamble.first->getBufferStart(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001425 NewPreamble.second.first) == 0) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001426 // The preamble has not changed. We may be able to re-use the precompiled
1427 // preamble.
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001428
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001429 // Check that none of the files used by the preamble have changed.
1430 bool AnyFileChanged = false;
1431
1432 // First, make a record of those files that have been overridden via
1433 // remapping or unsaved_files.
1434 llvm::StringMap<std::pair<off_t, time_t> > OverriddenFiles;
1435 for (PreprocessorOptions::remapped_file_iterator
1436 R = PreprocessorOpts.remapped_file_begin(),
1437 REnd = PreprocessorOpts.remapped_file_end();
1438 !AnyFileChanged && R != REnd;
1439 ++R) {
1440 struct stat StatBuf;
Anders Carlsson340415c2011-03-18 19:23:38 +00001441 if (FileMgr->getNoncachedStatValue(R->second, StatBuf)) {
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001442 // If we can't stat the file we're remapping to, assume that something
1443 // horrible happened.
1444 AnyFileChanged = true;
1445 break;
1446 }
Douglas Gregor754f3492010-07-24 00:38:13 +00001447
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001448 OverriddenFiles[R->first] = std::make_pair(StatBuf.st_size,
1449 StatBuf.st_mtime);
1450 }
1451 for (PreprocessorOptions::remapped_file_buffer_iterator
1452 R = PreprocessorOpts.remapped_file_buffer_begin(),
1453 REnd = PreprocessorOpts.remapped_file_buffer_end();
1454 !AnyFileChanged && R != REnd;
1455 ++R) {
1456 // FIXME: Should we actually compare the contents of file->buffer
1457 // remappings?
1458 OverriddenFiles[R->first] = std::make_pair(R->second->getBufferSize(),
1459 0);
1460 }
1461
1462 // Check whether anything has changed.
1463 for (llvm::StringMap<std::pair<off_t, time_t> >::iterator
1464 F = FilesInPreamble.begin(), FEnd = FilesInPreamble.end();
1465 !AnyFileChanged && F != FEnd;
1466 ++F) {
1467 llvm::StringMap<std::pair<off_t, time_t> >::iterator Overridden
1468 = OverriddenFiles.find(F->first());
1469 if (Overridden != OverriddenFiles.end()) {
1470 // This file was remapped; check whether the newly-mapped file
1471 // matches up with the previous mapping.
1472 if (Overridden->second != F->second)
1473 AnyFileChanged = true;
1474 continue;
1475 }
1476
1477 // The file was not remapped; check whether it has changed on disk.
1478 struct stat StatBuf;
Anders Carlsson340415c2011-03-18 19:23:38 +00001479 if (FileMgr->getNoncachedStatValue(F->first(), StatBuf)) {
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001480 // If we can't stat the file, assume that something horrible happened.
1481 AnyFileChanged = true;
1482 } else if (StatBuf.st_size != F->second.first ||
1483 StatBuf.st_mtime != F->second.second)
1484 AnyFileChanged = true;
1485 }
1486
1487 if (!AnyFileChanged) {
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001488 // Okay! We can re-use the precompiled preamble.
1489
1490 // Set the state of the diagnostic object to mimic its state
1491 // after parsing the preamble.
1492 getDiagnostics().Reset();
Douglas Gregor32be4a52010-10-11 21:37:58 +00001493 ProcessWarningOptions(getDiagnostics(),
Douglas Gregor01b6e312011-07-01 18:22:13 +00001494 PreambleInvocation->getDiagnosticOpts());
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001495 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001496
1497 // Create a version of the main file buffer that is padded to
1498 // buffer size we reserved when creating the preamble.
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001499 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001500 PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001501 FrontendOpts.Inputs[0].getFile());
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001502 }
Douglas Gregor175c4a92010-07-23 23:58:40 +00001503 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001504
1505 // If we aren't allowed to rebuild the precompiled preamble, just
1506 // return now.
1507 if (!AllowRebuild)
1508 return 0;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001509
Douglas Gregor175c4a92010-07-23 23:58:40 +00001510 // We can't reuse the previously-computed preamble. Build a new one.
1511 Preamble.clear();
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001512 PreambleDiagnostics.clear();
Ted Kremenek1872b312011-10-27 17:55:18 +00001513 erasePreambleFile(this);
Douglas Gregoreababfb2010-08-04 05:53:38 +00001514 PreambleRebuildCounter = 1;
Douglas Gregordf95a132010-08-09 20:45:32 +00001515 } else if (!AllowRebuild) {
1516 // We aren't allowed to rebuild the precompiled preamble; just
1517 // return now.
1518 return 0;
1519 }
Douglas Gregoreababfb2010-08-04 05:53:38 +00001520
1521 // If the preamble rebuild counter > 1, it's because we previously
1522 // failed to build a preamble and we're not yet ready to try
1523 // again. Decrement the counter and return a failure.
1524 if (PreambleRebuildCounter > 1) {
1525 --PreambleRebuildCounter;
1526 return 0;
1527 }
1528
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001529 // Create a temporary file for the precompiled preamble. In rare
1530 // circumstances, this can fail.
1531 std::string PreamblePCHPath = GetPreamblePCHPath();
1532 if (PreamblePCHPath.empty()) {
1533 // Try again next time.
1534 PreambleRebuildCounter = 1;
1535 return 0;
1536 }
1537
Douglas Gregor175c4a92010-07-23 23:58:40 +00001538 // We did not previously compute a preamble, or it can't be reused anyway.
Douglas Gregor213f18b2010-10-28 15:44:59 +00001539 SimpleTimer PreambleTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001540 PreambleTimer.setOutput("Precompiling preamble");
Douglas Gregor44c181a2010-07-23 00:33:23 +00001541
1542 // Create a new buffer that stores the preamble. The buffer also contains
1543 // extra space for the original contents of the file (which will be present
1544 // when we actually parse the file) along with more room in case the file
Douglas Gregor175c4a92010-07-23 23:58:40 +00001545 // grows.
1546 PreambleReservedSize = NewPreamble.first->getBufferSize();
1547 if (PreambleReservedSize < 4096)
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001548 PreambleReservedSize = 8191;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001549 else
Douglas Gregor175c4a92010-07-23 23:58:40 +00001550 PreambleReservedSize *= 2;
1551
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001552 // Save the preamble text for later; we'll need to compare against it for
1553 // subsequent reparses.
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001554 StringRef MainFilename = PreambleInvocation->getFrontendOpts().Inputs[0].getFile();
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00001555 Preamble.assign(FileMgr->getFile(MainFilename),
1556 NewPreamble.first->getBufferStart(),
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001557 NewPreamble.first->getBufferStart()
1558 + NewPreamble.second.first);
1559 PreambleEndsAtStartOfLine = NewPreamble.second.second;
1560
Douglas Gregor671947b2010-08-19 01:33:06 +00001561 delete PreambleBuffer;
1562 PreambleBuffer
Douglas Gregor175c4a92010-07-23 23:58:40 +00001563 = llvm::MemoryBuffer::getNewUninitMemBuffer(PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001564 FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001565 memcpy(const_cast<char*>(PreambleBuffer->getBufferStart()),
Douglas Gregor175c4a92010-07-23 23:58:40 +00001566 NewPreamble.first->getBufferStart(), Preamble.size());
1567 memset(const_cast<char*>(PreambleBuffer->getBufferStart()) + Preamble.size(),
Douglas Gregorf4f6c9d2010-07-26 21:36:20 +00001568 ' ', PreambleReservedSize - Preamble.size() - 1);
1569 const_cast<char*>(PreambleBuffer->getBufferEnd())[-1] = '\n';
Douglas Gregor44c181a2010-07-23 00:33:23 +00001570
1571 // Remap the main source file to the preamble buffer.
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001572 llvm::sys::PathWithStatus MainFilePath(FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001573 PreprocessorOpts.addRemappedFile(MainFilePath.str(), PreambleBuffer);
1574
1575 // Tell the compiler invocation to generate a temporary precompiled header.
1576 FrontendOpts.ProgramAction = frontend::GeneratePCH;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001577 // FIXME: Generate the precompiled header into memory?
Douglas Gregor2cd4fd42010-09-11 17:56:52 +00001578 FrontendOpts.OutputFile = PreamblePCHPath;
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001579 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
1580 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001581
1582 // Create the compiler instance to use for building the precompiled preamble.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001583 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001584
1585 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001586 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1587 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00001588
Douglas Gregor01b6e312011-07-01 18:22:13 +00001589 Clang->setInvocation(&*PreambleInvocation);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001590 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001591
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001592 // Set up diagnostics, capturing all of the diagnostics produced.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001593 Clang->setDiagnostics(&getDiagnostics());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001594
1595 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001596 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001597 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00001598 if (!Clang->hasTarget()) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001599 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1600 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001601 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001602 PreprocessorOpts.eraseRemappedFile(
1603 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001604 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001605 }
1606
1607 // Inform the target of the language options.
1608 //
1609 // FIXME: We shouldn't need to do this, the target should be immutable once
1610 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001611 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001612
Ted Kremenek03201fb2011-03-21 18:40:07 +00001613 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001614 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001615 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001616 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001617 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Douglas Gregor44c181a2010-07-23 00:33:23 +00001618 "IR inputs not support here!");
1619
1620 // Clear out old caches and data.
Douglas Gregoraa3e6ba2010-10-08 04:03:57 +00001621 getDiagnostics().Reset();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001622 ProcessWarningOptions(getDiagnostics(), Clang->getDiagnosticOpts());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001623 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001624 TopLevelDecls.clear();
1625 TopLevelDeclsInPreamble.clear();
Douglas Gregor44c181a2010-07-23 00:33:23 +00001626
1627 // Create a file manager object to provide access to and cache the filesystem.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001628 Clang->setFileManager(new FileManager(Clang->getFileSystemOpts()));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001629
1630 // Create the source manager.
Ted Kremenek03201fb2011-03-21 18:40:07 +00001631 Clang->setSourceManager(new SourceManager(getDiagnostics(),
Ted Kremenek4f327862011-03-21 18:40:17 +00001632 Clang->getFileManager()));
Douglas Gregor44c181a2010-07-23 00:33:23 +00001633
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001634 OwningPtr<PrecompilePreambleAction> Act;
Douglas Gregor1d715ac2010-08-03 08:14:03 +00001635 Act.reset(new PrecompilePreambleAction(*this));
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00001636 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
Douglas Gregor175c4a92010-07-23 23:58:40 +00001637 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1638 Preamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001639 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001640 PreprocessorOpts.eraseRemappedFile(
1641 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001642 return 0;
Douglas Gregor44c181a2010-07-23 00:33:23 +00001643 }
1644
1645 Act->Execute();
1646 Act->EndSourceFile();
Ted Kremenek4f327862011-03-21 18:40:17 +00001647
Argyrios Kyrtzidis1f01f7c2013-06-11 00:36:55 +00001648 if (!Act->hasEmittedPreamblePCH()) {
Argyrios Kyrtzidis739f9e52013-06-11 16:42:34 +00001649 // The preamble PCH failed (e.g. there was a module loading fatal error),
1650 // so no precompiled header was generated. Forget that we even tried.
Douglas Gregor06e50442010-09-27 16:43:25 +00001651 // FIXME: Should we leave a note for ourselves to try again?
Douglas Gregor175c4a92010-07-23 23:58:40 +00001652 llvm::sys::Path(FrontendOpts.OutputFile).eraseFromDisk();
1653 Preamble.clear();
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001654 TopLevelDeclsInPreamble.clear();
Douglas Gregoreababfb2010-08-04 05:53:38 +00001655 PreambleRebuildCounter = DefaultPreambleRebuildInterval;
Douglas Gregor671947b2010-08-19 01:33:06 +00001656 PreprocessorOpts.eraseRemappedFile(
1657 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor754f3492010-07-24 00:38:13 +00001658 return 0;
Douglas Gregor175c4a92010-07-23 23:58:40 +00001659 }
1660
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001661 // Transfer any diagnostics generated when parsing the preamble into the set
1662 // of preamble diagnostics.
1663 PreambleDiagnostics.clear();
1664 PreambleDiagnostics.insert(PreambleDiagnostics.end(),
Argyrios Kyrtzidis3e9d3262011-10-24 17:25:20 +00001665 stored_diag_afterDriver_begin(), stored_diag_end());
Argyrios Kyrtzidis7f3a4582012-02-01 19:54:02 +00001666 checkAndRemoveNonDriverDiags(StoredDiagnostics);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00001667
Douglas Gregor175c4a92010-07-23 23:58:40 +00001668 // Keep track of the preamble we precompiled.
Ted Kremenek1872b312011-10-27 17:55:18 +00001669 setPreambleFile(this, FrontendOpts.OutputFile);
Douglas Gregorc0659ec2010-08-02 20:51:39 +00001670 NumWarningsInPreamble = getDiagnostics().getNumWarnings();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001671
1672 // Keep track of all of the files that the source manager knows about,
1673 // so we can verify whether they have changed or not.
1674 FilesInPreamble.clear();
Ted Kremenek03201fb2011-03-21 18:40:07 +00001675 SourceManager &SourceMgr = Clang->getSourceManager();
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001676 const llvm::MemoryBuffer *MainFileBuffer
1677 = SourceMgr.getBuffer(SourceMgr.getMainFileID());
1678 for (SourceManager::fileinfo_iterator F = SourceMgr.fileinfo_begin(),
1679 FEnd = SourceMgr.fileinfo_end();
1680 F != FEnd;
1681 ++F) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00001682 const FileEntry *File = F->second->OrigEntry;
Douglas Gregorcc5888d2010-07-31 00:40:00 +00001683 if (!File || F->second->getRawBuffer() == MainFileBuffer)
1684 continue;
1685
1686 FilesInPreamble[File->getName()]
1687 = std::make_pair(F->second->getSize(), File->getModificationTime());
1688 }
1689
Douglas Gregoreababfb2010-08-04 05:53:38 +00001690 PreambleRebuildCounter = 1;
Douglas Gregor671947b2010-08-19 01:33:06 +00001691 PreprocessorOpts.eraseRemappedFile(
1692 PreprocessorOpts.remapped_file_buffer_end() - 1);
Douglas Gregor9b7db622011-02-16 18:16:54 +00001693
1694 // If the hash of top-level entities differs from the hash of the top-level
1695 // entities the last time we rebuilt the preamble, clear out the completion
1696 // cache.
1697 if (CurrentTopLevelHashValue != PreambleTopLevelHashValue) {
1698 CompletionCacheTopLevelHashValue = 0;
1699 PreambleTopLevelHashValue = CurrentTopLevelHashValue;
1700 }
1701
Douglas Gregor754f3492010-07-24 00:38:13 +00001702 return CreatePaddedMainFileBuffer(NewPreamble.first,
Douglas Gregor754f3492010-07-24 00:38:13 +00001703 PreambleReservedSize,
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001704 FrontendOpts.Inputs[0].getFile());
Douglas Gregor44c181a2010-07-23 00:33:23 +00001705}
Douglas Gregorabc563f2010-07-19 21:46:24 +00001706
Douglas Gregoreb8837b2010-08-03 19:06:41 +00001707void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1708 std::vector<Decl *> Resolved;
1709 Resolved.reserve(TopLevelDeclsInPreamble.size());
1710 ExternalASTSource &Source = *getASTContext().getExternalSource();
1711 for (unsigned I = 0, N = TopLevelDeclsInPreamble.size(); I != N; ++I) {
1712 // Resolve the declaration ID to an actual declaration, possibly
1713 // deserializing the declaration in the process.
1714 Decl *D = Source.GetExternalDecl(TopLevelDeclsInPreamble[I]);
1715 if (D)
1716 Resolved.push_back(D);
1717 }
1718 TopLevelDeclsInPreamble.clear();
1719 TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1720}
1721
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001722void ASTUnit::transferASTDataFromCompilerInstance(CompilerInstance &CI) {
1723 // Steal the created target, context, and preprocessor.
1724 TheSema.reset(CI.takeSema());
1725 Consumer.reset(CI.takeASTConsumer());
1726 Ctx = &CI.getASTContext();
1727 PP = &CI.getPreprocessor();
1728 CI.setSourceManager(0);
1729 CI.setFileManager(0);
1730 Target = &CI.getTarget();
1731 Reader = CI.getModuleManager();
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00001732 HadModuleLoaderFatalFailure = CI.hadModuleLoaderFatalFailure();
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001733}
1734
Chris Lattner5f9e2722011-07-23 10:55:15 +00001735StringRef ASTUnit::getMainFileName() const {
Argyrios Kyrtzidis814b51a2013-01-11 22:11:14 +00001736 if (Invocation && !Invocation->getFrontendOpts().Inputs.empty()) {
1737 const FrontendInputFile &Input = Invocation->getFrontendOpts().Inputs[0];
1738 if (Input.isFile())
1739 return Input.getFile();
1740 else
1741 return Input.getBuffer()->getBufferIdentifier();
1742 }
1743
1744 if (SourceMgr) {
1745 if (const FileEntry *
1746 FE = SourceMgr->getFileEntryForID(SourceMgr->getMainFileID()))
1747 return FE->getName();
1748 }
1749
1750 return StringRef();
Douglas Gregor213f18b2010-10-28 15:44:59 +00001751}
1752
Argyrios Kyrtzidis44f65a52013-03-05 20:21:14 +00001753StringRef ASTUnit::getASTFileName() const {
1754 if (!isMainFileAST())
1755 return StringRef();
1756
1757 serialization::ModuleFile &
1758 Mod = Reader->getModuleManager().getPrimaryModule();
1759 return Mod.FileName;
1760}
1761
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001762ASTUnit *ASTUnit::create(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001763 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001764 bool CaptureDiagnostics,
1765 bool UserFilesAreVolatile) {
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001766 OwningPtr<ASTUnit> AST;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001767 AST.reset(new ASTUnit(false));
Argyrios Kyrtzidis991bf492011-11-28 04:55:55 +00001768 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001769 AST->Diagnostics = Diags;
Ted Kremenek4f327862011-03-21 18:40:17 +00001770 AST->Invocation = CI;
Anders Carlsson0d8d7e62011-03-18 18:22:40 +00001771 AST->FileSystemOpts = CI->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00001772 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001773 AST->UserFilesAreVolatile = UserFilesAreVolatile;
1774 AST->SourceMgr = new SourceManager(AST->getDiagnostics(), *AST->FileMgr,
1775 UserFilesAreVolatile);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00001776
1777 return AST.take();
1778}
1779
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001780ASTUnit *ASTUnit::LoadFromCompilerInvocationAction(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001781 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001782 ASTFrontendAction *Action,
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001783 ASTUnit *Unit,
1784 bool Persistent,
1785 StringRef ResourceFilesPath,
1786 bool OnlyLocalDecls,
1787 bool CaptureDiagnostics,
1788 bool PrecompilePreamble,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001789 bool CacheCodeCompletionResults,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001790 bool IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001791 bool UserFilesAreVolatile,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001792 OwningPtr<ASTUnit> *ErrAST) {
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001793 assert(CI && "A CompilerInvocation is required");
1794
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001795 OwningPtr<ASTUnit> OwnAST;
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001796 ASTUnit *AST = Unit;
1797 if (!AST) {
1798 // Create the AST unit.
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001799 OwnAST.reset(create(CI, Diags, CaptureDiagnostics, UserFilesAreVolatile));
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001800 AST = OwnAST.get();
1801 }
1802
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001803 if (!ResourceFilesPath.empty()) {
1804 // Override the resources path.
1805 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
1806 }
1807 AST->OnlyLocalDecls = OnlyLocalDecls;
1808 AST->CaptureDiagnostics = CaptureDiagnostics;
1809 if (PrecompilePreamble)
1810 AST->PreambleRebuildCounter = 2;
Douglas Gregor467dc882011-08-25 22:30:56 +00001811 AST->TUKind = Action ? Action->getTranslationUnitKind() : TU_Complete;
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001812 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001813 AST->IncludeBriefCommentsInCodeCompletion
1814 = IncludeBriefCommentsInCodeCompletion;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001815
1816 // Recover resources if we crash before exiting this method.
1817 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001818 ASTUnitCleanup(OwnAST.get());
David Blaikied6471f72011-09-25 23:23:43 +00001819 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1820 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001821 DiagCleanup(Diags.getPtr());
1822
1823 // We'll manage file buffers ourselves.
1824 CI->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1825 CI->getFrontendOpts().DisableFree = false;
1826 ProcessWarningOptions(AST->getDiagnostics(), CI->getDiagnosticOpts());
1827
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001828 // Create the compiler instance to use for building the AST.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001829 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001830
1831 // Recover resources if we crash before exiting this method.
1832 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1833 CICleanup(Clang.get());
1834
1835 Clang->setInvocation(CI);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001836 AST->OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001837
1838 // Set up diagnostics, capturing any diagnostics that would
1839 // otherwise be dropped.
1840 Clang->setDiagnostics(&AST->getDiagnostics());
1841
1842 // Create the target instance.
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001843 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00001844 &Clang->getTargetOpts()));
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001845 if (!Clang->hasTarget())
1846 return 0;
1847
1848 // Inform the target of the language options.
1849 //
1850 // FIXME: We shouldn't need to do this, the target should be immutable once
1851 // created. This complexity should be lifted elsewhere.
1852 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
1853
1854 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1855 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001856 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001857 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00001858 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001859 "IR inputs not supported here!");
1860
1861 // Configure the various subsystems.
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001862 AST->TheSema.reset();
1863 AST->Ctx = 0;
1864 AST->PP = 0;
Argyrios Kyrtzidis62ba9f62011-11-01 17:14:15 +00001865 AST->Reader = 0;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001866
1867 // Create a file manager object to provide access to and cache the filesystem.
1868 Clang->setFileManager(&AST->getFileManager());
1869
1870 // Create the source manager.
1871 Clang->setSourceManager(&AST->getSourceManager());
1872
1873 ASTFrontendAction *Act = Action;
1874
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001875 OwningPtr<TopLevelDeclTrackerAction> TrackerAct;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001876 if (!Act) {
1877 TrackerAct.reset(new TopLevelDeclTrackerAction(*AST));
1878 Act = TrackerAct.get();
1879 }
1880
1881 // Recover resources if we crash before exiting this method.
1882 llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1883 ActCleanup(TrackerAct.get());
1884
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001885 if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
1886 AST->transferASTDataFromCompilerInstance(*Clang);
1887 if (OwnAST && ErrAST)
1888 ErrAST->swap(OwnAST);
1889
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001890 return 0;
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001891 }
Argyrios Kyrtzidis6f3ce972011-11-28 04:56:00 +00001892
1893 if (Persistent && !TrackerAct) {
1894 Clang->getPreprocessor().addPPCallbacks(
1895 new MacroDefinitionTrackerPPCallbacks(AST->getCurrentTopLevelHashValue()));
1896 std::vector<ASTConsumer*> Consumers;
1897 if (Clang->hasASTConsumer())
1898 Consumers.push_back(Clang->takeASTConsumer());
1899 Consumers.push_back(new TopLevelDeclTrackerConsumer(*AST,
1900 AST->getCurrentTopLevelHashValue()));
1901 Clang->setASTConsumer(new MultiplexConsumer(Consumers));
1902 }
Argyrios Kyrtzidis374a00b2012-06-08 05:48:06 +00001903 if (!Act->Execute()) {
1904 AST->transferASTDataFromCompilerInstance(*Clang);
1905 if (OwnAST && ErrAST)
1906 ErrAST->swap(OwnAST);
1907
1908 return 0;
1909 }
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001910
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001911 // Steal the created target, context, and preprocessor.
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001912 AST->transferASTDataFromCompilerInstance(*Clang);
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001913
1914 Act->EndSourceFile();
1915
Argyrios Kyrtzidisabb5afa2011-10-14 21:22:05 +00001916 if (OwnAST)
1917 return OwnAST.take();
1918 else
1919 return AST;
Argyrios Kyrtzidisd808bd22011-05-03 23:26:34 +00001920}
1921
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001922bool ASTUnit::LoadFromCompilerInvocation(bool PrecompilePreamble) {
1923 if (!Invocation)
1924 return true;
1925
1926 // We'll manage file buffers ourselves.
1927 Invocation->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1928 Invocation->getFrontendOpts().DisableFree = false;
Douglas Gregor0b53cf82011-01-19 01:02:47 +00001929 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001930
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001931 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Douglas Gregor99ba2022010-10-27 17:24:53 +00001932 if (PrecompilePreamble) {
Douglas Gregor08bb4c62010-11-15 23:00:34 +00001933 PreambleRebuildCounter = 2;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001934 OverrideMainBuffer
1935 = getMainBufferWithPrecompiledPreamble(*Invocation);
1936 }
1937
Douglas Gregor213f18b2010-10-28 15:44:59 +00001938 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00001939 ParsingTimer.setOutput("Parsing " + getMainFileName());
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001940
Ted Kremenek25a11e12011-03-22 01:15:24 +00001941 // Recover resources if we crash before exiting this method.
1942 llvm::CrashRecoveryContextCleanupRegistrar<llvm::MemoryBuffer>
1943 MemBufferCleanup(OverrideMainBuffer);
1944
Douglas Gregor213f18b2010-10-28 15:44:59 +00001945 return Parse(OverrideMainBuffer);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001946}
1947
Douglas Gregorabc563f2010-07-19 21:46:24 +00001948ASTUnit *ASTUnit::LoadFromCompilerInvocation(CompilerInvocation *CI,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001949 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Douglas Gregorabc563f2010-07-19 21:46:24 +00001950 bool OnlyLocalDecls,
Douglas Gregor44c181a2010-07-23 00:33:23 +00001951 bool CaptureDiagnostics,
Douglas Gregordf95a132010-08-09 20:45:32 +00001952 bool PrecompilePreamble,
Douglas Gregor467dc882011-08-25 22:30:56 +00001953 TranslationUnitKind TUKind,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001954 bool CacheCodeCompletionResults,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001955 bool IncludeBriefCommentsInCodeCompletion,
1956 bool UserFilesAreVolatile) {
Douglas Gregorabc563f2010-07-19 21:46:24 +00001957 // Create the AST unit.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00001958 OwningPtr<ASTUnit> AST;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001959 AST.reset(new ASTUnit(false));
Douglas Gregor0b53cf82011-01-19 01:02:47 +00001960 ConfigureDiags(Diags, 0, 0, *AST, CaptureDiagnostics);
Douglas Gregorabc563f2010-07-19 21:46:24 +00001961 AST->Diagnostics = Diags;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001962 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00001963 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor467dc882011-08-25 22:30:56 +00001964 AST->TUKind = TUKind;
Douglas Gregor87c08a52010-08-13 22:48:40 +00001965 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001966 AST->IncludeBriefCommentsInCodeCompletion
1967 = IncludeBriefCommentsInCodeCompletion;
Ted Kremenek4f327862011-03-21 18:40:17 +00001968 AST->Invocation = CI;
Argyrios Kyrtzidiseb8fc582013-01-21 18:45:42 +00001969 AST->FileSystemOpts = CI->getFileSystemOpts();
1970 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001971 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Douglas Gregorabc563f2010-07-19 21:46:24 +00001972
Ted Kremenekb547eeb2011-03-18 02:06:56 +00001973 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00001974 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1975 ASTUnitCleanup(AST.get());
David Blaikied6471f72011-09-25 23:23:43 +00001976 llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1977 llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine> >
Ted Kremenek25a11e12011-03-22 01:15:24 +00001978 DiagCleanup(Diags.getPtr());
Ted Kremenekb547eeb2011-03-18 02:06:56 +00001979
Douglas Gregor4cd912a2010-10-12 00:50:20 +00001980 return AST->LoadFromCompilerInvocation(PrecompilePreamble)? 0 : AST.take();
Daniel Dunbar521bf9c2009-12-01 09:51:01 +00001981}
Daniel Dunbar7b556682009-12-02 03:23:45 +00001982
1983ASTUnit *ASTUnit::LoadFromCommandLine(const char **ArgBegin,
1984 const char **ArgEnd,
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00001985 IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
Chris Lattner5f9e2722011-07-23 10:55:15 +00001986 StringRef ResourceFilesPath,
Daniel Dunbar7b556682009-12-02 03:23:45 +00001987 bool OnlyLocalDecls,
Douglas Gregore47be3e2010-11-11 00:39:14 +00001988 bool CaptureDiagnostics,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001989 RemappedFile *RemappedFiles,
Douglas Gregora88084b2010-02-18 18:08:43 +00001990 unsigned NumRemappedFiles,
Argyrios Kyrtzidis299a4a92011-03-08 23:35:24 +00001991 bool RemappedFilesKeepOriginalName,
Douglas Gregordf95a132010-08-09 20:45:32 +00001992 bool PrecompilePreamble,
Douglas Gregor467dc882011-08-25 22:30:56 +00001993 TranslationUnitKind TUKind,
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00001994 bool CacheCodeCompletionResults,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00001995 bool IncludeBriefCommentsInCodeCompletion,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00001996 bool AllowPCHWithCompilerErrors,
Erik Verbruggen6a91d382012-04-12 10:11:59 +00001997 bool SkipFunctionBodies,
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00001998 bool UserFilesAreVolatile,
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00001999 bool ForSerialization,
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00002000 OwningPtr<ASTUnit> *ErrAST) {
Douglas Gregor28019772010-04-05 23:52:57 +00002001 if (!Diags.getPtr()) {
Douglas Gregor3687e9d2010-04-05 21:10:19 +00002002 // No diagnostics engine was provided, so create our own diagnostics object
2003 // with the default options.
Sean Silvad47afb92013-01-20 01:58:28 +00002004 Diags = CompilerInstance::createDiagnostics(new DiagnosticOptions());
Douglas Gregor3687e9d2010-04-05 21:10:19 +00002005 }
Daniel Dunbar7b556682009-12-02 03:23:45 +00002006
Chris Lattner5f9e2722011-07-23 10:55:15 +00002007 SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002008
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00002009 IntrusiveRefCntPtr<CompilerInvocation> CI;
Douglas Gregore47be3e2010-11-11 00:39:14 +00002010
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002011 {
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002012
Douglas Gregore47be3e2010-11-11 00:39:14 +00002013 CaptureDroppedDiagnostics Capture(CaptureDiagnostics, *Diags,
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002014 StoredDiagnostics);
Daniel Dunbar3bd54cc2010-01-25 00:44:02 +00002015
Argyrios Kyrtzidis832316e2011-04-04 23:11:45 +00002016 CI = clang::createInvocationFromCommandLine(
Frits van Bommele9c02652011-07-18 12:00:32 +00002017 llvm::makeArrayRef(ArgBegin, ArgEnd),
2018 Diags);
Argyrios Kyrtzidis054e4f52011-04-04 21:38:51 +00002019 if (!CI)
Argyrios Kyrtzidis4e03c2b2011-03-07 22:45:01 +00002020 return 0;
Daniel Dunbar7b556682009-12-02 03:23:45 +00002021 }
Douglas Gregore47be3e2010-11-11 00:39:14 +00002022
Douglas Gregor4db64a42010-01-23 00:14:00 +00002023 // Override any files that need remapping
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002024 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
2025 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2026 if (const llvm::MemoryBuffer *
2027 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2028 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, memBuf);
2029 } else {
2030 const char *fname = fileOrBuf.get<const char *>();
2031 CI->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first, fname);
2032 }
2033 }
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00002034 PreprocessorOptions &PPOpts = CI->getPreprocessorOpts();
2035 PPOpts.RemappedFilesKeepOriginalName = RemappedFilesKeepOriginalName;
2036 PPOpts.AllowPCHWithCompilerErrors = AllowPCHWithCompilerErrors;
Douglas Gregor4db64a42010-01-23 00:14:00 +00002037
Daniel Dunbar8b9adfe2009-12-15 00:06:45 +00002038 // Override the resources path.
Daniel Dunbar807b0612010-01-30 21:47:16 +00002039 CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
Daniel Dunbar7b556682009-12-02 03:23:45 +00002040
Erik Verbruggen6a91d382012-04-12 10:11:59 +00002041 CI->getFrontendOpts().SkipFunctionBodies = SkipFunctionBodies;
2042
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002043 // Create the AST unit.
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002044 OwningPtr<ASTUnit> AST;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002045 AST.reset(new ASTUnit(false));
Douglas Gregor0b53cf82011-01-19 01:02:47 +00002046 ConfigureDiags(Diags, ArgBegin, ArgEnd, *AST, CaptureDiagnostics);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002047 AST->Diagnostics = Diags;
Ted Kremenekd04a9822011-11-17 23:01:17 +00002048 Diags = 0; // Zero out now to ease cleanup during crash recovery.
Anders Carlsson0d8d7e62011-03-18 18:22:40 +00002049 AST->FileSystemOpts = CI->getFileSystemOpts();
Ted Kremenek4f327862011-03-21 18:40:17 +00002050 AST->FileMgr = new FileManager(AST->FileSystemOpts);
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002051 AST->OnlyLocalDecls = OnlyLocalDecls;
Douglas Gregore47be3e2010-11-11 00:39:14 +00002052 AST->CaptureDiagnostics = CaptureDiagnostics;
Douglas Gregor467dc882011-08-25 22:30:56 +00002053 AST->TUKind = TUKind;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002054 AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002055 AST->IncludeBriefCommentsInCodeCompletion
2056 = IncludeBriefCommentsInCodeCompletion;
Argyrios Kyrtzidisff398962012-07-11 20:59:04 +00002057 AST->UserFilesAreVolatile = UserFilesAreVolatile;
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002058 AST->NumStoredDiagnosticsFromDriver = StoredDiagnostics.size();
Douglas Gregor4cd912a2010-10-12 00:50:20 +00002059 AST->StoredDiagnostics.swap(StoredDiagnostics);
Ted Kremenek4f327862011-03-21 18:40:17 +00002060 AST->Invocation = CI;
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002061 if (ForSerialization)
2062 AST->WriterData.reset(new ASTWriterData());
Ted Kremenekd04a9822011-11-17 23:01:17 +00002063 CI = 0; // Zero out now to ease cleanup during crash recovery.
Ted Kremenekb547eeb2011-03-18 02:06:56 +00002064
2065 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00002066 llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
2067 ASTUnitCleanup(AST.get());
Ted Kremenekb547eeb2011-03-18 02:06:56 +00002068
Argyrios Kyrtzidise722ed62012-04-11 02:11:16 +00002069 if (AST->LoadFromCompilerInvocation(PrecompilePreamble)) {
2070 // Some error occurred, if caller wants to examine diagnostics, pass it the
2071 // ASTUnit.
2072 if (ErrAST) {
2073 AST->StoredDiagnostics.swap(AST->FailedParseDiagnostics);
2074 ErrAST->swap(AST);
2075 }
2076 return 0;
2077 }
2078
2079 return AST.take();
Daniel Dunbar7b556682009-12-02 03:23:45 +00002080}
Douglas Gregorabc563f2010-07-19 21:46:24 +00002081
2082bool ASTUnit::Reparse(RemappedFile *RemappedFiles, unsigned NumRemappedFiles) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002083 if (!Invocation)
Douglas Gregorabc563f2010-07-19 21:46:24 +00002084 return true;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002085
2086 clearFileLevelDecls();
Douglas Gregorabc563f2010-07-19 21:46:24 +00002087
Douglas Gregor213f18b2010-10-28 15:44:59 +00002088 SimpleTimer ParsingTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00002089 ParsingTimer.setOutput("Reparsing " + getMainFileName());
Douglas Gregor213f18b2010-10-28 15:44:59 +00002090
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002091 // Remap files.
Douglas Gregorf128fed2010-08-20 00:02:33 +00002092 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
2093 for (PreprocessorOptions::remapped_file_buffer_iterator
2094 R = PPOpts.remapped_file_buffer_begin(),
2095 REnd = PPOpts.remapped_file_buffer_end();
2096 R != REnd;
2097 ++R) {
2098 delete R->second;
2099 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002100 Invocation->getPreprocessorOpts().clearRemappedFiles();
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002101 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
2102 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2103 if (const llvm::MemoryBuffer *
2104 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2105 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
2106 memBuf);
2107 } else {
2108 const char *fname = fileOrBuf.get<const char *>();
2109 Invocation->getPreprocessorOpts().addRemappedFile(RemappedFiles[I].first,
2110 fname);
2111 }
2112 }
Douglas Gregorcc5888d2010-07-31 00:40:00 +00002113
Douglas Gregoreababfb2010-08-04 05:53:38 +00002114 // If we have a preamble file lying around, or if we might try to
2115 // build a precompiled preamble, do so now.
Douglas Gregor754f3492010-07-24 00:38:13 +00002116 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Ted Kremenek1872b312011-10-27 17:55:18 +00002117 if (!getPreambleFile(this).empty() || PreambleRebuildCounter > 0)
Douglas Gregor2283d792010-08-20 00:59:43 +00002118 OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(*Invocation);
Douglas Gregor175c4a92010-07-23 23:58:40 +00002119
Douglas Gregorabc563f2010-07-19 21:46:24 +00002120 // Clear out the diagnostics state.
Argyrios Kyrtzidise6825d32011-11-03 20:28:19 +00002121 getDiagnostics().Reset();
2122 ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
Argyrios Kyrtzidis27368f92011-11-03 20:57:33 +00002123 if (OverrideMainBuffer)
2124 getDiagnostics().setNumWarnings(NumWarningsInPreamble);
Argyrios Kyrtzidise6825d32011-11-03 20:28:19 +00002125
Douglas Gregor175c4a92010-07-23 23:58:40 +00002126 // Parse the sources
Douglas Gregor9b7db622011-02-16 18:16:54 +00002127 bool Result = Parse(OverrideMainBuffer);
Argyrios Kyrtzidis2fe17fc2011-10-31 21:25:31 +00002128
2129 // If we're caching global code-completion results, and the top-level
2130 // declarations have changed, clear out the code-completion cache.
2131 if (!Result && ShouldCacheCodeCompletionResults &&
2132 CurrentTopLevelHashValue != CompletionCacheTopLevelHashValue)
2133 CacheCodeCompletionResults();
Douglas Gregor9b7db622011-02-16 18:16:54 +00002134
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002135 // We now need to clear out the completion info related to this translation
2136 // unit; it'll be recreated if necessary.
2137 CCTUInfo.reset();
Douglas Gregor8fa0a802011-08-04 20:04:59 +00002138
Douglas Gregor175c4a92010-07-23 23:58:40 +00002139 return Result;
Douglas Gregorabc563f2010-07-19 21:46:24 +00002140}
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002141
Douglas Gregor87c08a52010-08-13 22:48:40 +00002142//----------------------------------------------------------------------------//
2143// Code completion
2144//----------------------------------------------------------------------------//
2145
2146namespace {
2147 /// \brief Code completion consumer that combines the cached code-completion
2148 /// results from an ASTUnit with the code-completion results provided to it,
2149 /// then passes the result on to
2150 class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
Richard Smith026b3582012-08-14 03:13:00 +00002151 uint64_t NormalContexts;
Douglas Gregor87c08a52010-08-13 22:48:40 +00002152 ASTUnit &AST;
2153 CodeCompleteConsumer &Next;
2154
2155 public:
2156 AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002157 const CodeCompleteOptions &CodeCompleteOpts)
2158 : CodeCompleteConsumer(CodeCompleteOpts, Next.isOutputBinary()),
2159 AST(AST), Next(Next)
Douglas Gregor87c08a52010-08-13 22:48:40 +00002160 {
2161 // Compute the set of contexts in which we will look when we don't have
2162 // any information about the specific context.
2163 NormalContexts
Richard Smith026b3582012-08-14 03:13:00 +00002164 = (1LL << CodeCompletionContext::CCC_TopLevel)
2165 | (1LL << CodeCompletionContext::CCC_ObjCInterface)
2166 | (1LL << CodeCompletionContext::CCC_ObjCImplementation)
2167 | (1LL << CodeCompletionContext::CCC_ObjCIvarList)
2168 | (1LL << CodeCompletionContext::CCC_Statement)
2169 | (1LL << CodeCompletionContext::CCC_Expression)
2170 | (1LL << CodeCompletionContext::CCC_ObjCMessageReceiver)
2171 | (1LL << CodeCompletionContext::CCC_DotMemberAccess)
2172 | (1LL << CodeCompletionContext::CCC_ArrowMemberAccess)
2173 | (1LL << CodeCompletionContext::CCC_ObjCPropertyAccess)
2174 | (1LL << CodeCompletionContext::CCC_ObjCProtocolName)
2175 | (1LL << CodeCompletionContext::CCC_ParenthesizedExpression)
2176 | (1LL << CodeCompletionContext::CCC_Recovery);
Douglas Gregor02688102010-09-14 23:59:36 +00002177
David Blaikie4e4d0842012-03-11 07:00:24 +00002178 if (AST.getASTContext().getLangOpts().CPlusPlus)
Richard Smith026b3582012-08-14 03:13:00 +00002179 NormalContexts |= (1LL << CodeCompletionContext::CCC_EnumTag)
2180 | (1LL << CodeCompletionContext::CCC_UnionTag)
2181 | (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002182 }
2183
2184 virtual void ProcessCodeCompleteResults(Sema &S,
2185 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00002186 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002187 unsigned NumResults);
Douglas Gregor87c08a52010-08-13 22:48:40 +00002188
2189 virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
2190 OverloadCandidate *Candidates,
2191 unsigned NumCandidates) {
2192 Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates);
2193 }
Douglas Gregor218937c2011-02-01 19:23:04 +00002194
Douglas Gregordae68752011-02-01 22:57:45 +00002195 virtual CodeCompletionAllocator &getAllocator() {
Douglas Gregor218937c2011-02-01 19:23:04 +00002196 return Next.getAllocator();
2197 }
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002198
2199 virtual CodeCompletionTUInfo &getCodeCompletionTUInfo() {
2200 return Next.getCodeCompletionTUInfo();
2201 }
Douglas Gregor87c08a52010-08-13 22:48:40 +00002202 };
2203}
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002204
Douglas Gregor5f808c22010-08-16 21:18:39 +00002205/// \brief Helper function that computes which global names are hidden by the
2206/// local code-completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00002207static void CalculateHiddenNames(const CodeCompletionContext &Context,
2208 CodeCompletionResult *Results,
2209 unsigned NumResults,
2210 ASTContext &Ctx,
2211 llvm::StringSet<llvm::BumpPtrAllocator> &HiddenNames){
Douglas Gregor5f808c22010-08-16 21:18:39 +00002212 bool OnlyTagNames = false;
2213 switch (Context.getKind()) {
Douglas Gregor52779fb2010-09-23 23:01:17 +00002214 case CodeCompletionContext::CCC_Recovery:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002215 case CodeCompletionContext::CCC_TopLevel:
2216 case CodeCompletionContext::CCC_ObjCInterface:
2217 case CodeCompletionContext::CCC_ObjCImplementation:
2218 case CodeCompletionContext::CCC_ObjCIvarList:
2219 case CodeCompletionContext::CCC_ClassStructUnion:
2220 case CodeCompletionContext::CCC_Statement:
2221 case CodeCompletionContext::CCC_Expression:
2222 case CodeCompletionContext::CCC_ObjCMessageReceiver:
Douglas Gregor3da626b2011-07-07 16:03:39 +00002223 case CodeCompletionContext::CCC_DotMemberAccess:
2224 case CodeCompletionContext::CCC_ArrowMemberAccess:
2225 case CodeCompletionContext::CCC_ObjCPropertyAccess:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002226 case CodeCompletionContext::CCC_Namespace:
2227 case CodeCompletionContext::CCC_Type:
Douglas Gregor2ccccb32010-08-23 18:23:48 +00002228 case CodeCompletionContext::CCC_Name:
2229 case CodeCompletionContext::CCC_PotentiallyQualifiedName:
Douglas Gregor02688102010-09-14 23:59:36 +00002230 case CodeCompletionContext::CCC_ParenthesizedExpression:
Douglas Gregor0f91c8c2011-07-30 06:55:39 +00002231 case CodeCompletionContext::CCC_ObjCInterfaceName:
Douglas Gregor5f808c22010-08-16 21:18:39 +00002232 break;
2233
2234 case CodeCompletionContext::CCC_EnumTag:
2235 case CodeCompletionContext::CCC_UnionTag:
2236 case CodeCompletionContext::CCC_ClassOrStructTag:
2237 OnlyTagNames = true;
2238 break;
2239
2240 case CodeCompletionContext::CCC_ObjCProtocolName:
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002241 case CodeCompletionContext::CCC_MacroName:
2242 case CodeCompletionContext::CCC_MacroNameUse:
Douglas Gregorf29c5232010-08-24 22:20:20 +00002243 case CodeCompletionContext::CCC_PreprocessorExpression:
Douglas Gregor721f3592010-08-25 18:41:16 +00002244 case CodeCompletionContext::CCC_PreprocessorDirective:
Douglas Gregor59a66942010-08-25 18:04:30 +00002245 case CodeCompletionContext::CCC_NaturalLanguage:
Douglas Gregor458433d2010-08-26 15:07:07 +00002246 case CodeCompletionContext::CCC_SelectorName:
Douglas Gregor1a480c42010-08-27 17:35:51 +00002247 case CodeCompletionContext::CCC_TypeQualifiers:
Douglas Gregor52779fb2010-09-23 23:01:17 +00002248 case CodeCompletionContext::CCC_Other:
Douglas Gregor5c722c702011-02-18 23:30:37 +00002249 case CodeCompletionContext::CCC_OtherWithMacros:
Douglas Gregor3da626b2011-07-07 16:03:39 +00002250 case CodeCompletionContext::CCC_ObjCInstanceMessage:
2251 case CodeCompletionContext::CCC_ObjCClassMessage:
2252 case CodeCompletionContext::CCC_ObjCCategoryName:
Douglas Gregor721f3592010-08-25 18:41:16 +00002253 // We're looking for nothing, or we're looking for names that cannot
2254 // be hidden.
Douglas Gregor5f808c22010-08-16 21:18:39 +00002255 return;
2256 }
2257
John McCall0a2c5e22010-08-25 06:19:51 +00002258 typedef CodeCompletionResult Result;
Douglas Gregor5f808c22010-08-16 21:18:39 +00002259 for (unsigned I = 0; I != NumResults; ++I) {
2260 if (Results[I].Kind != Result::RK_Declaration)
2261 continue;
2262
2263 unsigned IDNS
2264 = Results[I].Declaration->getUnderlyingDecl()->getIdentifierNamespace();
2265
2266 bool Hiding = false;
2267 if (OnlyTagNames)
2268 Hiding = (IDNS & Decl::IDNS_Tag);
2269 else {
2270 unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
Douglas Gregora5fb7c32010-08-16 23:05:20 +00002271 Decl::IDNS_Namespace | Decl::IDNS_Ordinary |
2272 Decl::IDNS_NonMemberOperator);
David Blaikie4e4d0842012-03-11 07:00:24 +00002273 if (Ctx.getLangOpts().CPlusPlus)
Douglas Gregor5f808c22010-08-16 21:18:39 +00002274 HiddenIDNS |= Decl::IDNS_Tag;
2275 Hiding = (IDNS & HiddenIDNS);
2276 }
2277
2278 if (!Hiding)
2279 continue;
2280
2281 DeclarationName Name = Results[I].Declaration->getDeclName();
2282 if (IdentifierInfo *Identifier = Name.getAsIdentifierInfo())
2283 HiddenNames.insert(Identifier->getName());
2284 else
2285 HiddenNames.insert(Name.getAsString());
2286 }
2287}
2288
2289
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002290void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
2291 CodeCompletionContext Context,
John McCall0a2c5e22010-08-25 06:19:51 +00002292 CodeCompletionResult *Results,
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002293 unsigned NumResults) {
2294 // Merge the results we were given with the results we cached.
2295 bool AddedResult = false;
Richard Smith026b3582012-08-14 03:13:00 +00002296 uint64_t InContexts =
2297 Context.getKind() == CodeCompletionContext::CCC_Recovery
2298 ? NormalContexts : (1LL << Context.getKind());
Douglas Gregor5f808c22010-08-16 21:18:39 +00002299 // Contains the set of names that are hidden by "local" completion results.
Ted Kremenekc198f612010-11-07 06:11:36 +00002300 llvm::StringSet<llvm::BumpPtrAllocator> HiddenNames;
John McCall0a2c5e22010-08-25 06:19:51 +00002301 typedef CodeCompletionResult Result;
Chris Lattner5f9e2722011-07-23 10:55:15 +00002302 SmallVector<Result, 8> AllResults;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002303 for (ASTUnit::cached_completion_iterator
Douglas Gregor5535d572010-08-16 21:23:13 +00002304 C = AST.cached_completion_begin(),
2305 CEnd = AST.cached_completion_end();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002306 C != CEnd; ++C) {
2307 // If the context we are in matches any of the contexts we are
2308 // interested in, we'll add this result.
2309 if ((C->ShowInContexts & InContexts) == 0)
2310 continue;
2311
2312 // If we haven't added any results previously, do so now.
2313 if (!AddedResult) {
Douglas Gregor5f808c22010-08-16 21:18:39 +00002314 CalculateHiddenNames(Context, Results, NumResults, S.Context,
2315 HiddenNames);
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002316 AllResults.insert(AllResults.end(), Results, Results + NumResults);
2317 AddedResult = true;
2318 }
2319
Douglas Gregor5f808c22010-08-16 21:18:39 +00002320 // Determine whether this global completion result is hidden by a local
2321 // completion result. If so, skip it.
2322 if (C->Kind != CXCursor_MacroDefinition &&
2323 HiddenNames.count(C->Completion->getTypedText()))
2324 continue;
2325
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002326 // Adjust priority based on similar type classes.
2327 unsigned Priority = C->Priority;
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002328 CodeCompletionString *Completion = C->Completion;
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002329 if (!Context.getPreferredType().isNull()) {
2330 if (C->Kind == CXCursor_MacroDefinition) {
2331 Priority = getMacroUsagePriority(C->Completion->getTypedText(),
David Blaikie4e4d0842012-03-11 07:00:24 +00002332 S.getLangOpts(),
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002333 Context.getPreferredType()->isAnyPointerType());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002334 } else if (C->Type) {
2335 CanQualType Expected
Douglas Gregor5535d572010-08-16 21:23:13 +00002336 = S.Context.getCanonicalType(
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002337 Context.getPreferredType().getUnqualifiedType());
2338 SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
2339 if (ExpectedSTC == C->TypeClass) {
2340 // We know this type is similar; check for an exact match.
2341 llvm::StringMap<unsigned> &CachedCompletionTypes
Douglas Gregor5535d572010-08-16 21:23:13 +00002342 = AST.getCachedCompletionTypes();
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002343 llvm::StringMap<unsigned>::iterator Pos
Douglas Gregor5535d572010-08-16 21:23:13 +00002344 = CachedCompletionTypes.find(QualType(Expected).getAsString());
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002345 if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
2346 Priority /= CCF_ExactTypeMatch;
2347 else
2348 Priority /= CCF_SimilarTypeMatch;
2349 }
2350 }
2351 }
2352
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002353 // Adjust the completion string, if required.
2354 if (C->Kind == CXCursor_MacroDefinition &&
2355 Context.getKind() == CodeCompletionContext::CCC_MacroNameUse) {
2356 // Create a new code-completion string that just contains the
2357 // macro name, without its arguments.
Argyrios Kyrtzidis28a83f52012-04-10 17:23:48 +00002358 CodeCompletionBuilder Builder(getAllocator(), getCodeCompletionTUInfo(),
2359 CCP_CodePattern, C->Availability);
Douglas Gregor218937c2011-02-01 19:23:04 +00002360 Builder.AddTypedTextChunk(C->Completion->getTypedText());
Douglas Gregor4125c372010-08-25 18:03:13 +00002361 Priority = CCP_CodePattern;
Douglas Gregor218937c2011-02-01 19:23:04 +00002362 Completion = Builder.TakeString();
Douglas Gregor1fbb4472010-08-24 20:21:13 +00002363 }
2364
Argyrios Kyrtzidisc04bb922012-09-27 00:24:09 +00002365 AllResults.push_back(Result(Completion, Priority, C->Kind,
Douglas Gregor58ddb602010-08-23 23:00:57 +00002366 C->Availability));
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002367 }
2368
2369 // If we did not add any cached completion results, just forward the
2370 // results we were given to the next consumer.
2371 if (!AddedResult) {
2372 Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
2373 return;
2374 }
Douglas Gregor1e5e6682010-08-26 13:48:20 +00002375
Douglas Gregor697ca6d2010-08-16 20:01:48 +00002376 Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
2377 AllResults.size());
2378}
2379
2380
2381
Chris Lattner5f9e2722011-07-23 10:55:15 +00002382void ASTUnit::CodeComplete(StringRef File, unsigned Line, unsigned Column,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002383 RemappedFile *RemappedFiles,
2384 unsigned NumRemappedFiles,
Douglas Gregorcee235c2010-08-05 09:09:23 +00002385 bool IncludeMacros,
2386 bool IncludeCodePatterns,
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002387 bool IncludeBriefComments,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002388 CodeCompleteConsumer &Consumer,
David Blaikied6471f72011-09-25 23:23:43 +00002389 DiagnosticsEngine &Diag, LangOptions &LangOpts,
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002390 SourceManager &SourceMgr, FileManager &FileMgr,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002391 SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
2392 SmallVectorImpl<const llvm::MemoryBuffer *> &OwnedBuffers) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002393 if (!Invocation)
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002394 return;
2395
Douglas Gregor213f18b2010-10-28 15:44:59 +00002396 SimpleTimer CompletionTimer(WantTiming);
Benjamin Krameredfb7ec2010-11-09 20:00:56 +00002397 CompletionTimer.setOutput("Code completion @ " + File + ":" +
Chris Lattner5f9e2722011-07-23 10:55:15 +00002398 Twine(Line) + ":" + Twine(Column));
Douglas Gregordf95a132010-08-09 20:45:32 +00002399
Dylan Noblesmithc93dc782012-02-20 14:00:23 +00002400 IntrusiveRefCntPtr<CompilerInvocation>
Ted Kremenek4f327862011-03-21 18:40:17 +00002401 CCInvocation(new CompilerInvocation(*Invocation));
2402
2403 FrontendOptions &FrontendOpts = CCInvocation->getFrontendOpts();
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002404 CodeCompleteOptions &CodeCompleteOpts = FrontendOpts.CodeCompleteOpts;
Ted Kremenek4f327862011-03-21 18:40:17 +00002405 PreprocessorOptions &PreprocessorOpts = CCInvocation->getPreprocessorOpts();
Douglas Gregorcee235c2010-08-05 09:09:23 +00002406
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002407 CodeCompleteOpts.IncludeMacros = IncludeMacros &&
2408 CachedCompletionResults.empty();
2409 CodeCompleteOpts.IncludeCodePatterns = IncludeCodePatterns;
2410 CodeCompleteOpts.IncludeGlobals = CachedCompletionResults.empty();
2411 CodeCompleteOpts.IncludeBriefComments = IncludeBriefComments;
2412
2413 assert(IncludeBriefComments == this->IncludeBriefCommentsInCodeCompletion);
2414
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002415 FrontendOpts.CodeCompletionAt.FileName = File;
2416 FrontendOpts.CodeCompletionAt.Line = Line;
2417 FrontendOpts.CodeCompletionAt.Column = Column;
2418
2419 // Set the language options appropriately.
Ted Kremenekd3b74d92011-11-17 23:01:24 +00002420 LangOpts = *CCInvocation->getLangOpts();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002421
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002422 OwningPtr<CompilerInstance> Clang(new CompilerInstance());
Ted Kremenek03201fb2011-03-21 18:40:07 +00002423
2424 // Recover resources if we crash before exiting this method.
Ted Kremenek25a11e12011-03-22 01:15:24 +00002425 llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
2426 CICleanup(Clang.get());
Ted Kremenek03201fb2011-03-21 18:40:07 +00002427
Ted Kremenek4f327862011-03-21 18:40:17 +00002428 Clang->setInvocation(&*CCInvocation);
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002429 OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002430
2431 // Set up diagnostics, capturing any diagnostics produced.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002432 Clang->setDiagnostics(&Diag);
Ted Kremenek4f327862011-03-21 18:40:17 +00002433 ProcessWarningOptions(Diag, CCInvocation->getDiagnosticOpts());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002434 CaptureDroppedDiagnostics Capture(true,
Ted Kremenek03201fb2011-03-21 18:40:07 +00002435 Clang->getDiagnostics(),
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002436 StoredDiagnostics);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002437
2438 // Create the target instance.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002439 Clang->setTarget(TargetInfo::CreateTargetInfo(Clang->getDiagnostics(),
Douglas Gregor49a87542012-11-16 04:24:59 +00002440 &Clang->getTargetOpts()));
Ted Kremenek03201fb2011-03-21 18:40:07 +00002441 if (!Clang->hasTarget()) {
Ted Kremenek4f327862011-03-21 18:40:17 +00002442 Clang->setInvocation(0);
Douglas Gregorbdbb0042010-08-18 22:29:43 +00002443 return;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002444 }
2445
2446 // Inform the target of the language options.
2447 //
2448 // FIXME: We shouldn't need to do this, the target should be immutable once
2449 // created. This complexity should be lifted elsewhere.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002450 Clang->getTarget().setForcedLangOptions(Clang->getLangOpts());
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002451
Ted Kremenek03201fb2011-03-21 18:40:07 +00002452 assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002453 "Invocation must have exactly one source file!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002454 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_AST &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002455 "FIXME: AST inputs not yet supported here!");
Argyrios Kyrtzidis8616f9a2012-11-09 19:40:39 +00002456 assert(Clang->getFrontendOpts().Inputs[0].getKind() != IK_LLVM_IR &&
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002457 "IR inputs not support here!");
2458
2459
2460 // Use the source and file managers that we were given.
Ted Kremenek03201fb2011-03-21 18:40:07 +00002461 Clang->setFileManager(&FileMgr);
2462 Clang->setSourceManager(&SourceMgr);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002463
2464 // Remap files.
2465 PreprocessorOpts.clearRemappedFiles();
Douglas Gregorb75d3df2010-08-04 17:07:00 +00002466 PreprocessorOpts.RetainRemappedFileBuffers = true;
Douglas Gregor2283d792010-08-20 00:59:43 +00002467 for (unsigned I = 0; I != NumRemappedFiles; ++I) {
Argyrios Kyrtzidisb1c86492011-03-05 01:03:53 +00002468 FilenameOrMemBuf fileOrBuf = RemappedFiles[I].second;
2469 if (const llvm::MemoryBuffer *
2470 memBuf = fileOrBuf.dyn_cast<const llvm::MemoryBuffer *>()) {
2471 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first, memBuf);
2472 OwnedBuffers.push_back(memBuf);
2473 } else {
2474 const char *fname = fileOrBuf.get<const char *>();
2475 PreprocessorOpts.addRemappedFile(RemappedFiles[I].first, fname);
2476 }
Douglas Gregor2283d792010-08-20 00:59:43 +00002477 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002478
Douglas Gregor87c08a52010-08-13 22:48:40 +00002479 // Use the code completion consumer we were given, but adding any cached
2480 // code-completion results.
Douglas Gregor7f946ad2010-11-29 16:13:56 +00002481 AugmentedCodeCompleteConsumer *AugmentedConsumer
Dmitri Gribenkod99ef532012-07-02 17:35:10 +00002482 = new AugmentedCodeCompleteConsumer(*this, Consumer, CodeCompleteOpts);
Ted Kremenek03201fb2011-03-21 18:40:07 +00002483 Clang->setCodeCompletionConsumer(AugmentedConsumer);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002484
Douglas Gregordf95a132010-08-09 20:45:32 +00002485 // If we have a precompiled preamble, try to use it. We only allow
2486 // the use of the precompiled preamble if we're if the completion
2487 // point is within the main file, after the end of the precompiled
2488 // preamble.
2489 llvm::MemoryBuffer *OverrideMainBuffer = 0;
Ted Kremenek1872b312011-10-27 17:55:18 +00002490 if (!getPreambleFile(this).empty()) {
Douglas Gregordf95a132010-08-09 20:45:32 +00002491 using llvm::sys::FileStatus;
Rafael Espindola105b2072013-06-18 19:40:07 +00002492 std::string CompleteFilePath(File);
2493 uint64_t CompleteFileID;
2494
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00002495 if (!llvm::sys::fs::getUniqueID(CompleteFilePath, CompleteFileID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00002496 std::string MainPath(OriginalSourceFile);
2497 uint64_t MainID;
Rafael Espindolada4cb0c2013-06-20 15:12:38 +00002498 if (!llvm::sys::fs::getUniqueID(MainPath, MainID)) {
Rafael Espindola105b2072013-06-18 19:40:07 +00002499 if (CompleteFileID == MainID && Line > 1)
Douglas Gregor2283d792010-08-20 00:59:43 +00002500 OverrideMainBuffer
Ted Kremenek4f327862011-03-21 18:40:17 +00002501 = getMainBufferWithPrecompiledPreamble(*CCInvocation, false,
Douglas Gregorc9c29a82010-08-25 18:04:15 +00002502 Line - 1);
Rafael Espindola105b2072013-06-18 19:40:07 +00002503 }
2504 }
Douglas Gregordf95a132010-08-09 20:45:32 +00002505 }
2506
2507 // If the main file has been overridden due to the use of a preamble,
2508 // make that override happen and introduce the preamble.
2509 if (OverrideMainBuffer) {
2510 PreprocessorOpts.addRemappedFile(OriginalSourceFile, OverrideMainBuffer);
2511 PreprocessorOpts.PrecompiledPreambleBytes.first = Preamble.size();
2512 PreprocessorOpts.PrecompiledPreambleBytes.second
2513 = PreambleEndsAtStartOfLine;
Ted Kremenek1872b312011-10-27 17:55:18 +00002514 PreprocessorOpts.ImplicitPCHInclude = getPreambleFile(this);
Douglas Gregordf95a132010-08-09 20:45:32 +00002515 PreprocessorOpts.DisablePCHValidation = true;
2516
Douglas Gregor2283d792010-08-20 00:59:43 +00002517 OwnedBuffers.push_back(OverrideMainBuffer);
Douglas Gregorf128fed2010-08-20 00:02:33 +00002518 } else {
2519 PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
2520 PreprocessorOpts.PrecompiledPreambleBytes.second = false;
Douglas Gregordf95a132010-08-09 20:45:32 +00002521 }
2522
Argyrios Kyrtzidise50904f2012-11-02 22:18:44 +00002523 // Disable the preprocessing record if modules are not enabled.
2524 if (!Clang->getLangOpts().Modules)
2525 PreprocessorOpts.DetailedRecord = false;
Douglas Gregordca8ee82011-05-06 16:33:08 +00002526
Dylan Noblesmith6f42b622012-02-05 02:12:40 +00002527 OwningPtr<SyntaxOnlyAction> Act;
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002528 Act.reset(new SyntaxOnlyAction);
Douglas Gregor1f6b2b52012-01-20 16:28:04 +00002529 if (Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002530 Act->Execute();
2531 Act->EndSourceFile();
2532 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00002533}
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002534
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002535bool ASTUnit::Save(StringRef File) {
Argyrios Kyrtzidis3b7deda2013-05-24 05:44:08 +00002536 if (HadModuleLoaderFatalFailure)
2537 return true;
2538
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002539 // Write to a temporary file and later rename it to the actual file, to avoid
2540 // possible race conditions.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00002541 SmallString<128> TempPath;
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +00002542 TempPath = File;
2543 TempPath += "-%%%%%%%%";
2544 int fd;
2545 if (llvm::sys::fs::unique_file(TempPath.str(), fd, TempPath,
2546 /*makeAbsolute=*/false))
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002547 return true;
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002548
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002549 // FIXME: Can we somehow regenerate the stat cache here, or do we need to
2550 // unconditionally create a stat cache when we parse the file?
Argyrios Kyrtzidis7e909852011-07-28 00:45:10 +00002551 llvm::raw_fd_ostream Out(fd, /*shouldClose=*/true);
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002552
2553 serialize(Out);
2554 Out.close();
Argyrios Kyrtzidis4bd26542012-03-13 02:17:06 +00002555 if (Out.has_error()) {
2556 Out.clear_error();
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002557 return true;
Argyrios Kyrtzidis4bd26542012-03-13 02:17:06 +00002558 }
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002559
Rafael Espindola8d2a7012011-12-25 01:18:52 +00002560 if (llvm::sys::fs::rename(TempPath.str(), File)) {
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002561 bool exists;
2562 llvm::sys::fs::remove(TempPath.str(), exists);
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002563 return true;
Argyrios Kyrtzidis9cca68d2011-07-21 18:44:49 +00002564 }
2565
Argyrios Kyrtzidise6d22022012-09-26 16:39:46 +00002566 return false;
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002567}
2568
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002569static bool serializeUnit(ASTWriter &Writer,
2570 SmallVectorImpl<char> &Buffer,
2571 Sema &S,
2572 bool hasErrors,
2573 raw_ostream &OS) {
Argyrios Kyrtzidis4182ed62012-10-31 20:59:50 +00002574 Writer.WriteAST(S, std::string(), 0, "", hasErrors);
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002575
2576 // Write the generated bitstream to "Out".
2577 if (!Buffer.empty())
2578 OS.write(Buffer.data(), Buffer.size());
2579
2580 return false;
2581}
2582
Chris Lattner5f9e2722011-07-23 10:55:15 +00002583bool ASTUnit::serialize(raw_ostream &OS) {
Argyrios Kyrtzidisbef35c92012-03-07 01:51:17 +00002584 bool hasErrors = getDiagnostics().hasErrorOccurred();
Argyrios Kyrtzidisb0f4b9a2011-03-09 17:21:42 +00002585
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002586 if (WriterData)
2587 return serializeUnit(WriterData->Writer, WriterData->Buffer,
2588 getSema(), hasErrors, OS);
2589
Daniel Dunbar8d6ff022012-02-29 20:31:23 +00002590 SmallString<128> Buffer;
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002591 llvm::BitstreamWriter Stream(Buffer);
Sebastian Redla4232eb2010-08-18 23:56:21 +00002592 ASTWriter Writer(Stream);
Argyrios Kyrtzidis900ab952012-10-11 16:05:00 +00002593 return serializeUnit(Writer, Buffer, getSema(), hasErrors, OS);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00002594}
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002595
2596typedef ContinuousRangeMap<unsigned, int, 2> SLocRemap;
2597
2598static void TranslateSLoc(SourceLocation &L, SLocRemap &Remap) {
2599 unsigned Raw = L.getRawEncoding();
2600 const unsigned MacroBit = 1U << 31;
2601 L = SourceLocation::getFromRawEncoding((Raw & MacroBit) |
2602 ((Raw & ~MacroBit) + Remap.find(Raw & ~MacroBit)->second));
2603}
2604
2605void ASTUnit::TranslateStoredDiagnostics(
2606 ASTReader *MMan,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002607 StringRef ModName,
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002608 SourceManager &SrcMgr,
Chris Lattner5f9e2722011-07-23 10:55:15 +00002609 const SmallVectorImpl<StoredDiagnostic> &Diags,
2610 SmallVectorImpl<StoredDiagnostic> &Out) {
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002611 // The stored diagnostic has the old source manager in it; update
2612 // the locations to refer into the new source manager. We also need to remap
2613 // all the locations to the new view. This includes the diag location, any
2614 // associated source ranges, and the source ranges of associated fix-its.
2615 // FIXME: There should be a cleaner way to do this.
2616
Chris Lattner5f9e2722011-07-23 10:55:15 +00002617 SmallVector<StoredDiagnostic, 4> Result;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002618 Result.reserve(Diags.size());
2619 assert(MMan && "Don't have a module manager");
Douglas Gregor1a4761e2011-11-30 23:21:26 +00002620 serialization::ModuleFile *Mod = MMan->ModuleMgr.lookup(ModName);
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002621 assert(Mod && "Don't have preamble module");
2622 SLocRemap &Remap = Mod->SLocRemap;
2623 for (unsigned I = 0, N = Diags.size(); I != N; ++I) {
2624 // Rebuild the StoredDiagnostic.
2625 const StoredDiagnostic &SD = Diags[I];
2626 SourceLocation L = SD.getLocation();
2627 TranslateSLoc(L, Remap);
2628 FullSourceLoc Loc(L, SrcMgr);
2629
Chris Lattner5f9e2722011-07-23 10:55:15 +00002630 SmallVector<CharSourceRange, 4> Ranges;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002631 Ranges.reserve(SD.range_size());
2632 for (StoredDiagnostic::range_iterator I = SD.range_begin(),
2633 E = SD.range_end();
2634 I != E; ++I) {
2635 SourceLocation BL = I->getBegin();
2636 TranslateSLoc(BL, Remap);
2637 SourceLocation EL = I->getEnd();
2638 TranslateSLoc(EL, Remap);
2639 Ranges.push_back(CharSourceRange(SourceRange(BL, EL), I->isTokenRange()));
2640 }
2641
Chris Lattner5f9e2722011-07-23 10:55:15 +00002642 SmallVector<FixItHint, 2> FixIts;
Douglas Gregorf62d43d2011-07-19 16:10:42 +00002643 FixIts.reserve(SD.fixit_size());
2644 for (StoredDiagnostic::fixit_iterator I = SD.fixit_begin(),
2645 E = SD.fixit_end();
2646 I != E; ++I) {
2647 FixIts.push_back(FixItHint());
2648 FixItHint &FH = FixIts.back();
2649 FH.CodeToInsert = I->CodeToInsert;
2650 SourceLocation BL = I->RemoveRange.getBegin();
2651 TranslateSLoc(BL, Remap);
2652 SourceLocation EL = I->RemoveRange.getEnd();
2653 TranslateSLoc(EL, Remap);
2654 FH.RemoveRange = CharSourceRange(SourceRange(BL, EL),
2655 I->RemoveRange.isTokenRange());
2656 }
2657
2658 Result.push_back(StoredDiagnostic(SD.getLevel(), SD.getID(),
2659 SD.getMessage(), Loc, Ranges, FixIts));
2660 }
2661 Result.swap(Out);
2662}
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002663
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002664static inline bool compLocDecl(std::pair<unsigned, Decl *> L,
2665 std::pair<unsigned, Decl *> R) {
2666 return L.first < R.first;
2667}
2668
2669void ASTUnit::addFileLevelDecl(Decl *D) {
2670 assert(D);
Douglas Gregor66e87002011-11-07 18:53:57 +00002671
2672 // We only care about local declarations.
2673 if (D->isFromASTFile())
2674 return;
Argyrios Kyrtzidis332cb9b2011-10-31 07:19:59 +00002675
2676 SourceManager &SM = *SourceMgr;
2677 SourceLocation Loc = D->getLocation();
2678 if (Loc.isInvalid() || !SM.isLocalSourceLocation(Loc))
2679 return;
2680
2681 // We only keep track of the file-level declarations of each file.
2682 if (!D->getLexicalDeclContext()->isFileContext())
2683 return;
2684
2685 SourceLocation FileLoc = SM.getFileLoc(Loc);
2686 assert(SM.isLocalSourceLocation(FileLoc));
2687 FileID FID;
2688 unsigned Offset;
2689 llvm::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
2690 if (FID.isInvalid())
2691 return;
2692
2693 LocDeclsTy *&Decls = FileDecls[FID];
2694 if (!Decls)
2695 Decls = new LocDeclsTy();
2696
2697 std::pair<unsigned, Decl *> LocDecl(Offset, D);
2698
2699 if (Decls->empty() || Decls->back().first <= Offset) {
2700 Decls->push_back(LocDecl);
2701 return;
2702 }
2703
2704 LocDeclsTy::iterator
2705 I = std::upper_bound(Decls->begin(), Decls->end(), LocDecl, compLocDecl);
2706
2707 Decls->insert(I, LocDecl);
2708}
2709
Argyrios Kyrtzidisdfb332d2011-11-03 02:20:32 +00002710void ASTUnit::findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
2711 SmallVectorImpl<Decl *> &Decls) {
2712 if (File.isInvalid())
2713 return;
2714
2715 if (SourceMgr->isLoadedFileID(File)) {
2716 assert(Ctx->getExternalSource() && "No external source!");
2717 return Ctx->getExternalSource()->FindFileRegionDecls(File, Offset, Length,
2718 Decls);
2719 }
2720
2721 FileDeclsTy::iterator I = FileDecls.find(File);
2722 if (I == FileDecls.end())
2723 return;
2724
2725 LocDeclsTy &LocDecls = *I->second;
2726 if (LocDecls.empty())
2727 return;
2728
2729 LocDeclsTy::iterator
2730 BeginIt = std::lower_bound(LocDecls.begin(), LocDecls.end(),
2731 std::make_pair(Offset, (Decl*)0), compLocDecl);
2732 if (BeginIt != LocDecls.begin())
2733 --BeginIt;
2734
Argyrios Kyrtzidisc14a03d2011-11-23 20:27:36 +00002735 // If we are pointing at a top-level decl inside an objc container, we need
2736 // to backtrack until we find it otherwise we will fail to report that the
2737 // region overlaps with an objc container.
2738 while (BeginIt != LocDecls.begin() &&
2739 BeginIt->second->isTopLevelDeclInObjCContainer())
2740 --BeginIt;
2741
Argyrios Kyrtzidisdfb332d2011-11-03 02:20:32 +00002742 LocDeclsTy::iterator
2743 EndIt = std::upper_bound(LocDecls.begin(), LocDecls.end(),
2744 std::make_pair(Offset+Length, (Decl*)0),
2745 compLocDecl);
2746 if (EndIt != LocDecls.end())
2747 ++EndIt;
2748
2749 for (LocDeclsTy::iterator DIt = BeginIt; DIt != EndIt; ++DIt)
2750 Decls.push_back(DIt->second);
2751}
2752
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002753SourceLocation ASTUnit::getLocation(const FileEntry *File,
2754 unsigned Line, unsigned Col) const {
2755 const SourceManager &SM = getSourceManager();
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002756 SourceLocation Loc = SM.translateFileLineCol(File, Line, Col);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002757 return SM.getMacroArgExpandedLocation(Loc);
2758}
2759
2760SourceLocation ASTUnit::getLocation(const FileEntry *File,
2761 unsigned Offset) const {
2762 const SourceManager &SM = getSourceManager();
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002763 SourceLocation FileLoc = SM.translateFileLineCol(File, 1, 1);
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002764 return SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Offset));
2765}
2766
Argyrios Kyrtzidisee0f84f2011-09-26 08:01:41 +00002767/// \brief If \arg Loc is a loaded location from the preamble, returns
2768/// the corresponding local location of the main file, otherwise it returns
2769/// \arg Loc.
2770SourceLocation ASTUnit::mapLocationFromPreamble(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, PreambleID, &Offs) && Offs < Preamble.size()) {
2780 SourceLocation FileLoc
2781 = SourceMgr->getLocForStartOfFile(SourceMgr->getMainFileID());
2782 return FileLoc.getLocWithOffset(Offs);
2783 }
2784
2785 return Loc;
2786}
2787
2788/// \brief If \arg Loc is a local location of the main file but inside the
2789/// preamble chunk, returns the corresponding loaded location from the
2790/// preamble, otherwise it returns \arg Loc.
2791SourceLocation ASTUnit::mapLocationToPreamble(SourceLocation Loc) {
2792 FileID PreambleID;
2793 if (SourceMgr)
2794 PreambleID = SourceMgr->getPreambleFileID();
2795
2796 if (Loc.isInvalid() || Preamble.empty() || PreambleID.isInvalid())
2797 return Loc;
2798
2799 unsigned Offs;
2800 if (SourceMgr->isInFileID(Loc, SourceMgr->getMainFileID(), &Offs) &&
2801 Offs < Preamble.size()) {
2802 SourceLocation FileLoc = SourceMgr->getLocForStartOfFile(PreambleID);
2803 return FileLoc.getLocWithOffset(Offs);
2804 }
2805
2806 return Loc;
2807}
2808
Argyrios Kyrtzidisf226ff92011-10-25 00:29:50 +00002809bool ASTUnit::isInPreambleFileID(SourceLocation Loc) {
2810 FileID FID;
2811 if (SourceMgr)
2812 FID = SourceMgr->getPreambleFileID();
2813
2814 if (Loc.isInvalid() || FID.isInvalid())
2815 return false;
2816
2817 return SourceMgr->isInFileID(Loc, FID);
2818}
2819
2820bool ASTUnit::isInMainFileID(SourceLocation Loc) {
2821 FileID FID;
2822 if (SourceMgr)
2823 FID = SourceMgr->getMainFileID();
2824
2825 if (Loc.isInvalid() || FID.isInvalid())
2826 return false;
2827
2828 return SourceMgr->isInFileID(Loc, FID);
2829}
2830
2831SourceLocation ASTUnit::getEndOfPreambleFileID() {
2832 FileID FID;
2833 if (SourceMgr)
2834 FID = SourceMgr->getPreambleFileID();
2835
2836 if (FID.isInvalid())
2837 return SourceLocation();
2838
2839 return SourceMgr->getLocForEndOfFile(FID);
2840}
2841
2842SourceLocation ASTUnit::getStartOfMainFileID() {
2843 FileID FID;
2844 if (SourceMgr)
2845 FID = SourceMgr->getMainFileID();
2846
2847 if (FID.isInvalid())
2848 return SourceLocation();
2849
2850 return SourceMgr->getLocForStartOfFile(FID);
2851}
2852
Argyrios Kyrtzidis632dcc92012-10-02 16:10:51 +00002853std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
2854ASTUnit::getLocalPreprocessingEntities() const {
2855 if (isMainFileAST()) {
2856 serialization::ModuleFile &
2857 Mod = Reader->getModuleManager().getPrimaryModule();
2858 return Reader->getModulePreprocessedEntities(Mod);
2859 }
2860
2861 if (PreprocessingRecord *PPRec = PP->getPreprocessingRecord())
2862 return std::make_pair(PPRec->local_begin(), PPRec->local_end());
2863
2864 return std::make_pair(PreprocessingRecord::iterator(),
2865 PreprocessingRecord::iterator());
2866}
2867
Argyrios Kyrtzidis95c579c2012-10-03 01:58:28 +00002868bool ASTUnit::visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn) {
Argyrios Kyrtzidis2093e0b2012-10-02 21:09:13 +00002869 if (isMainFileAST()) {
2870 serialization::ModuleFile &
2871 Mod = Reader->getModuleManager().getPrimaryModule();
2872 ASTReader::ModuleDeclIterator MDI, MDE;
2873 llvm::tie(MDI, MDE) = Reader->getModuleFileLevelDecls(Mod);
2874 for (; MDI != MDE; ++MDI) {
2875 if (!Fn(context, *MDI))
2876 return false;
2877 }
2878
2879 return true;
2880 }
2881
2882 for (ASTUnit::top_level_iterator TL = top_level_begin(),
2883 TLEnd = top_level_end();
2884 TL != TLEnd; ++TL) {
2885 if (!Fn(context, *TL))
2886 return false;
2887 }
2888
2889 return true;
2890}
2891
Argyrios Kyrtzidis3da76bf2012-10-03 21:05:51 +00002892namespace {
2893struct PCHLocatorInfo {
2894 serialization::ModuleFile *Mod;
2895 PCHLocatorInfo() : Mod(0) {}
2896};
2897}
2898
2899static bool PCHLocator(serialization::ModuleFile &M, void *UserData) {
2900 PCHLocatorInfo &Info = *static_cast<PCHLocatorInfo*>(UserData);
2901 switch (M.Kind) {
2902 case serialization::MK_Module:
2903 return true; // skip dependencies.
2904 case serialization::MK_PCH:
2905 Info.Mod = &M;
2906 return true; // found it.
2907 case serialization::MK_Preamble:
2908 return false; // look in dependencies.
2909 case serialization::MK_MainFile:
2910 return false; // look in dependencies.
2911 }
2912
2913 return true;
2914}
2915
2916const FileEntry *ASTUnit::getPCHFile() {
2917 if (!Reader)
2918 return 0;
2919
2920 PCHLocatorInfo Info;
2921 Reader->getModuleManager().visit(PCHLocator, &Info);
2922 if (Info.Mod)
2923 return Info.Mod->File;
2924
2925 return 0;
2926}
2927
Argyrios Kyrtzidis62288ed2012-10-10 02:12:47 +00002928bool ASTUnit::isModuleFile() {
2929 return isMainFileAST() && !ASTFileLangOpts.CurrentModule.empty();
2930}
2931
Argyrios Kyrtzidis507097e2011-09-19 20:40:35 +00002932void ASTUnit::PreambleData::countLines() const {
2933 NumLines = 0;
2934 if (empty())
2935 return;
2936
2937 for (std::vector<char>::const_iterator
2938 I = Buffer.begin(), E = Buffer.end(); I != E; ++I) {
2939 if (*I == '\n')
2940 ++NumLines;
2941 }
2942 if (Buffer.back() != '\n')
2943 ++NumLines;
2944}
Argyrios Kyrtzidisa696ece2011-10-10 21:57:12 +00002945
2946#ifndef NDEBUG
2947ASTUnit::ConcurrencyState::ConcurrencyState() {
2948 Mutex = new llvm::sys::MutexImpl(/*recursive=*/true);
2949}
2950
2951ASTUnit::ConcurrencyState::~ConcurrencyState() {
2952 delete static_cast<llvm::sys::MutexImpl *>(Mutex);
2953}
2954
2955void ASTUnit::ConcurrencyState::start() {
2956 bool acquired = static_cast<llvm::sys::MutexImpl *>(Mutex)->tryacquire();
2957 assert(acquired && "Concurrent access to ASTUnit!");
2958}
2959
2960void ASTUnit::ConcurrencyState::finish() {
2961 static_cast<llvm::sys::MutexImpl *>(Mutex)->release();
2962}
2963
2964#else // NDEBUG
2965
2966ASTUnit::ConcurrencyState::ConcurrencyState() {}
2967ASTUnit::ConcurrencyState::~ConcurrencyState() {}
2968void ASTUnit::ConcurrencyState::start() {}
2969void ASTUnit::ConcurrencyState::finish() {}
2970
2971#endif