clang  10.0.0svn
ASTUnit.cpp
Go to the documentation of this file.
1 //===- ASTUnit.cpp - ASTUnit utility --------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // ASTUnit Implementation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "clang/Frontend/ASTUnit.h"
14 #include "clang/AST/ASTConsumer.h"
15 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/DeclCXX.h"
20 #include "clang/AST/DeclGroup.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/Type.h"
27 #include "clang/AST/TypeOrdering.h"
28 #include "clang/Basic/Diagnostic.h"
31 #include "clang/Basic/LLVM.h"
34 #include "clang/Basic/Module.h"
37 #include "clang/Basic/TargetInfo.h"
47 #include "clang/Frontend/Utils.h"
48 #include "clang/Lex/HeaderSearch.h"
50 #include "clang/Lex/Lexer.h"
51 #include "clang/Lex/PPCallbacks.h"
53 #include "clang/Lex/Preprocessor.h"
55 #include "clang/Lex/Token.h"
58 #include "clang/Sema/Sema.h"
66 #include "llvm/ADT/ArrayRef.h"
67 #include "llvm/ADT/DenseMap.h"
68 #include "llvm/ADT/IntrusiveRefCntPtr.h"
69 #include "llvm/ADT/None.h"
70 #include "llvm/ADT/Optional.h"
71 #include "llvm/ADT/STLExtras.h"
72 #include "llvm/ADT/SmallString.h"
73 #include "llvm/ADT/SmallVector.h"
74 #include "llvm/ADT/StringMap.h"
75 #include "llvm/ADT/StringRef.h"
76 #include "llvm/ADT/StringSet.h"
77 #include "llvm/ADT/Twine.h"
78 #include "llvm/ADT/iterator_range.h"
79 #include "llvm/Bitstream/BitstreamWriter.h"
80 #include "llvm/Support/Allocator.h"
81 #include "llvm/Support/Casting.h"
82 #include "llvm/Support/CrashRecoveryContext.h"
83 #include "llvm/Support/DJB.h"
84 #include "llvm/Support/ErrorHandling.h"
85 #include "llvm/Support/ErrorOr.h"
86 #include "llvm/Support/FileSystem.h"
87 #include "llvm/Support/FileUtilities.h"
88 #include "llvm/Support/MemoryBuffer.h"
89 #include "llvm/Support/Timer.h"
90 #include "llvm/Support/VirtualFileSystem.h"
91 #include "llvm/Support/raw_ostream.h"
92 #include <algorithm>
93 #include <atomic>
94 #include <cassert>
95 #include <cstdint>
96 #include <cstdio>
97 #include <cstdlib>
98 #include <memory>
99 #include <mutex>
100 #include <string>
101 #include <tuple>
102 #include <utility>
103 #include <vector>
104 
105 using namespace clang;
106 
107 using llvm::TimeRecord;
108 
109 namespace {
110 
111  class SimpleTimer {
112  bool WantTiming;
113  TimeRecord Start;
114  std::string Output;
115 
116  public:
117  explicit SimpleTimer(bool WantTiming) : WantTiming(WantTiming) {
118  if (WantTiming)
119  Start = TimeRecord::getCurrentTime();
120  }
121 
122  ~SimpleTimer() {
123  if (WantTiming) {
124  TimeRecord Elapsed = TimeRecord::getCurrentTime();
125  Elapsed -= Start;
126  llvm::errs() << Output << ':';
127  Elapsed.print(Elapsed, llvm::errs());
128  llvm::errs() << '\n';
129  }
130  }
131 
132  void setOutput(const Twine &Output) {
133  if (WantTiming)
134  this->Output = Output.str();
135  }
136  };
137 
138 } // namespace
139 
140 template <class T>
141 static std::unique_ptr<T> valueOrNull(llvm::ErrorOr<std::unique_ptr<T>> Val) {
142  if (!Val)
143  return nullptr;
144  return std::move(*Val);
145 }
146 
147 template <class T>
148 static bool moveOnNoError(llvm::ErrorOr<T> Val, T &Output) {
149  if (!Val)
150  return false;
151  Output = std::move(*Val);
152  return true;
153 }
154 
155 /// Get a source buffer for \p MainFilePath, handling all file-to-file
156 /// and file-to-buffer remappings inside \p Invocation.
157 static std::unique_ptr<llvm::MemoryBuffer>
159  llvm::vfs::FileSystem *VFS,
160  StringRef FilePath, bool isVolatile) {
161  const auto &PreprocessorOpts = Invocation.getPreprocessorOpts();
162 
163  // Try to determine if the main file has been remapped, either from the
164  // command line (to another file) or directly through the compiler
165  // invocation (to a memory buffer).
166  llvm::MemoryBuffer *Buffer = nullptr;
167  std::unique_ptr<llvm::MemoryBuffer> BufferOwner;
168  auto FileStatus = VFS->status(FilePath);
169  if (FileStatus) {
170  llvm::sys::fs::UniqueID MainFileID = FileStatus->getUniqueID();
171 
172  // Check whether there is a file-file remapping of the main file
173  for (const auto &RF : PreprocessorOpts.RemappedFiles) {
174  std::string MPath(RF.first);
175  auto MPathStatus = VFS->status(MPath);
176  if (MPathStatus) {
177  llvm::sys::fs::UniqueID MID = MPathStatus->getUniqueID();
178  if (MainFileID == MID) {
179  // We found a remapping. Try to load the resulting, remapped source.
180  BufferOwner = valueOrNull(VFS->getBufferForFile(RF.second, -1, true, isVolatile));
181  if (!BufferOwner)
182  return nullptr;
183  }
184  }
185  }
186 
187  // Check whether there is a file-buffer remapping. It supercedes the
188  // file-file remapping.
189  for (const auto &RB : PreprocessorOpts.RemappedFileBuffers) {
190  std::string MPath(RB.first);
191  auto MPathStatus = VFS->status(MPath);
192  if (MPathStatus) {
193  llvm::sys::fs::UniqueID MID = MPathStatus->getUniqueID();
194  if (MainFileID == MID) {
195  // We found a remapping.
196  BufferOwner.reset();
197  Buffer = const_cast<llvm::MemoryBuffer *>(RB.second);
198  }
199  }
200  }
201  }
202 
203  // If the main source file was not remapped, load it now.
204  if (!Buffer && !BufferOwner) {
205  BufferOwner = valueOrNull(VFS->getBufferForFile(FilePath, -1, true, isVolatile));
206  if (!BufferOwner)
207  return nullptr;
208  }
209 
210  if (BufferOwner)
211  return BufferOwner;
212  if (!Buffer)
213  return nullptr;
214  return llvm::MemoryBuffer::getMemBufferCopy(Buffer->getBuffer(), FilePath);
215 }
216 
219  llvm::BitstreamWriter Stream;
221 
223  : Stream(Buffer), Writer(Stream, Buffer, ModuleCache, {}) {}
224 };
225 
226 void ASTUnit::clearFileLevelDecls() {
227  llvm::DeleteContainerSeconds(FileDecls);
228 }
229 
230 /// After failing to build a precompiled preamble (due to
231 /// errors in the source that occurs in the preamble), the number of
232 /// reparses during which we'll skip even trying to precompile the
233 /// preamble.
235 
236 /// Tracks the number of ASTUnit objects that are currently active.
237 ///
238 /// Used for debugging purposes only.
239 static std::atomic<unsigned> ActiveASTUnitObjects;
240 
241 ASTUnit::ASTUnit(bool _MainFileIsAST)
242  : MainFileIsAST(_MainFileIsAST), WantTiming(getenv("LIBCLANG_TIMING")),
243  ShouldCacheCodeCompletionResults(false),
244  IncludeBriefCommentsInCodeCompletion(false), UserFilesAreVolatile(false),
245  UnsafeToFree(false) {
246  if (getenv("LIBCLANG_OBJTRACKING"))
247  fprintf(stderr, "+++ %u translation units\n", ++ActiveASTUnitObjects);
248 }
249 
250 ASTUnit::~ASTUnit() {
251  // If we loaded from an AST file, balance out the BeginSourceFile call.
252  if (MainFileIsAST && getDiagnostics().getClient()) {
254  }
255 
256  clearFileLevelDecls();
257 
258  // Free the buffers associated with remapped files. We are required to
259  // perform this operation here because we explicitly request that the
260  // compiler instance *not* free these buffers for each invocation of the
261  // parser.
262  if (Invocation && OwnsRemappedFileBuffers) {
263  PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
264  for (const auto &RB : PPOpts.RemappedFileBuffers)
265  delete RB.second;
266  }
267 
268  ClearCachedCompletionResults();
269 
270  if (getenv("LIBCLANG_OBJTRACKING"))
271  fprintf(stderr, "--- %u translation units\n", --ActiveASTUnitObjects);
272 }
273 
274 void ASTUnit::setPreprocessor(std::shared_ptr<Preprocessor> PP) {
275  this->PP = std::move(PP);
276 }
277 
279  assert(getDiagnostics().getClient() && Ctx &&
280  "Bad context for source file");
281  getDiagnostics().getClient()->BeginSourceFile(Ctx->getLangOpts(), PP.get());
282 }
283 
284 /// Determine the set of code-completion contexts in which this
285 /// declaration should be shown.
286 static uint64_t getDeclShowContexts(const NamedDecl *ND,
287  const LangOptions &LangOpts,
288  bool &IsNestedNameSpecifier) {
289  IsNestedNameSpecifier = false;
290 
291  if (isa<UsingShadowDecl>(ND))
292  ND = ND->getUnderlyingDecl();
293  if (!ND)
294  return 0;
295 
296  uint64_t Contexts = 0;
297  if (isa<TypeDecl>(ND) || isa<ObjCInterfaceDecl>(ND) ||
298  isa<ClassTemplateDecl>(ND) || isa<TemplateTemplateParmDecl>(ND) ||
299  isa<TypeAliasTemplateDecl>(ND)) {
300  // Types can appear in these contexts.
301  if (LangOpts.CPlusPlus || !isa<TagDecl>(ND))
302  Contexts |= (1LL << CodeCompletionContext::CCC_TopLevel)
308 
309  // In C++, types can appear in expressions contexts (for functional casts).
310  if (LangOpts.CPlusPlus)
311  Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
312 
313  // In Objective-C, message sends can send interfaces. In Objective-C++,
314  // all types are available due to functional casts.
315  if (LangOpts.CPlusPlus || isa<ObjCInterfaceDecl>(ND))
317 
318  // In Objective-C, you can only be a subclass of another Objective-C class
319  if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(ND)) {
320  // Objective-C interfaces can be used in a class property expression.
321  if (ID->getDefinition())
322  Contexts |= (1LL << CodeCompletionContext::CCC_Expression);
324  }
325 
326  // Deal with tag names.
327  if (isa<EnumDecl>(ND)) {
328  Contexts |= (1LL << CodeCompletionContext::CCC_EnumTag);
329 
330  // Part of the nested-name-specifier in C++0x.
331  if (LangOpts.CPlusPlus11)
332  IsNestedNameSpecifier = true;
333  } else if (const auto *Record = dyn_cast<RecordDecl>(ND)) {
334  if (Record->isUnion())
335  Contexts |= (1LL << CodeCompletionContext::CCC_UnionTag);
336  else
337  Contexts |= (1LL << CodeCompletionContext::CCC_ClassOrStructTag);
338 
339  if (LangOpts.CPlusPlus)
340  IsNestedNameSpecifier = true;
341  } else if (isa<ClassTemplateDecl>(ND))
342  IsNestedNameSpecifier = true;
343  } else if (isa<ValueDecl>(ND) || isa<FunctionTemplateDecl>(ND)) {
344  // Values can appear in these contexts.
345  Contexts = (1LL << CodeCompletionContext::CCC_Statement)
349  } else if (isa<ObjCProtocolDecl>(ND)) {
351  } else if (isa<ObjCCategoryDecl>(ND)) {
353  } else if (isa<NamespaceDecl>(ND) || isa<NamespaceAliasDecl>(ND)) {
354  Contexts = (1LL << CodeCompletionContext::CCC_Namespace);
355 
356  // Part of the nested-name-specifier.
357  IsNestedNameSpecifier = true;
358  }
359 
360  return Contexts;
361 }
362 
363 void ASTUnit::CacheCodeCompletionResults() {
364  if (!TheSema)
365  return;
366 
367  SimpleTimer Timer(WantTiming);
368  Timer.setOutput("Cache global code completions for " + getMainFileName());
369 
370  // Clear out the previous results.
371  ClearCachedCompletionResults();
372 
373  // Gather the set of global code completions.
375  SmallVector<Result, 8> Results;
376  CachedCompletionAllocator = std::make_shared<GlobalCodeCompletionAllocator>();
377  CodeCompletionTUInfo CCTUInfo(CachedCompletionAllocator);
378  TheSema->GatherGlobalCodeCompletions(*CachedCompletionAllocator,
379  CCTUInfo, Results);
380 
381  // Translate global code completions into cached completions.
382  llvm::DenseMap<CanQualType, unsigned> CompletionTypes;
384 
385  for (auto &R : Results) {
386  switch (R.Kind) {
387  case Result::RK_Declaration: {
388  bool IsNestedNameSpecifier = false;
389  CachedCodeCompletionResult CachedResult;
390  CachedResult.Completion = R.CreateCodeCompletionString(
391  *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
392  IncludeBriefCommentsInCodeCompletion);
393  CachedResult.ShowInContexts = getDeclShowContexts(
394  R.Declaration, Ctx->getLangOpts(), IsNestedNameSpecifier);
395  CachedResult.Priority = R.Priority;
396  CachedResult.Kind = R.CursorKind;
397  CachedResult.Availability = R.Availability;
398 
399  // Keep track of the type of this completion in an ASTContext-agnostic
400  // way.
401  QualType UsageType = getDeclUsageType(*Ctx, R.Declaration);
402  if (UsageType.isNull()) {
403  CachedResult.TypeClass = STC_Void;
404  CachedResult.Type = 0;
405  } else {
406  CanQualType CanUsageType
407  = Ctx->getCanonicalType(UsageType.getUnqualifiedType());
408  CachedResult.TypeClass = getSimplifiedTypeClass(CanUsageType);
409 
410  // Determine whether we have already seen this type. If so, we save
411  // ourselves the work of formatting the type string by using the
412  // temporary, CanQualType-based hash table to find the associated value.
413  unsigned &TypeValue = CompletionTypes[CanUsageType];
414  if (TypeValue == 0) {
415  TypeValue = CompletionTypes.size();
416  CachedCompletionTypes[QualType(CanUsageType).getAsString()]
417  = TypeValue;
418  }
419 
420  CachedResult.Type = TypeValue;
421  }
422 
423  CachedCompletionResults.push_back(CachedResult);
424 
425  /// Handle nested-name-specifiers in C++.
426  if (TheSema->Context.getLangOpts().CPlusPlus && IsNestedNameSpecifier &&
427  !R.StartsNestedNameSpecifier) {
428  // The contexts in which a nested-name-specifier can appear in C++.
429  uint64_t NNSContexts
442 
443  if (isa<NamespaceDecl>(R.Declaration) ||
444  isa<NamespaceAliasDecl>(R.Declaration))
445  NNSContexts |= (1LL << CodeCompletionContext::CCC_Namespace);
446 
447  if (uint64_t RemainingContexts
448  = NNSContexts & ~CachedResult.ShowInContexts) {
449  // If there any contexts where this completion can be a
450  // nested-name-specifier but isn't already an option, create a
451  // nested-name-specifier completion.
452  R.StartsNestedNameSpecifier = true;
453  CachedResult.Completion = R.CreateCodeCompletionString(
454  *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
455  IncludeBriefCommentsInCodeCompletion);
456  CachedResult.ShowInContexts = RemainingContexts;
457  CachedResult.Priority = CCP_NestedNameSpecifier;
458  CachedResult.TypeClass = STC_Void;
459  CachedResult.Type = 0;
460  CachedCompletionResults.push_back(CachedResult);
461  }
462  }
463  break;
464  }
465 
466  case Result::RK_Keyword:
467  case Result::RK_Pattern:
468  // Ignore keywords and patterns; we don't care, since they are so
469  // easily regenerated.
470  break;
471 
472  case Result::RK_Macro: {
473  CachedCodeCompletionResult CachedResult;
474  CachedResult.Completion = R.CreateCodeCompletionString(
475  *TheSema, CCContext, *CachedCompletionAllocator, CCTUInfo,
476  IncludeBriefCommentsInCodeCompletion);
477  CachedResult.ShowInContexts
490 
491  CachedResult.Priority = R.Priority;
492  CachedResult.Kind = R.CursorKind;
493  CachedResult.Availability = R.Availability;
494  CachedResult.TypeClass = STC_Void;
495  CachedResult.Type = 0;
496  CachedCompletionResults.push_back(CachedResult);
497  break;
498  }
499  }
500  }
501 
502  // Save the current top-level hash value.
503  CompletionCacheTopLevelHashValue = CurrentTopLevelHashValue;
504 }
505 
506 void ASTUnit::ClearCachedCompletionResults() {
507  CachedCompletionResults.clear();
508  CachedCompletionTypes.clear();
509  CachedCompletionAllocator = nullptr;
510 }
511 
512 namespace {
513 
514 /// Gathers information from ASTReader that will be used to initialize
515 /// a Preprocessor.
516 class ASTInfoCollector : public ASTReaderListener {
517  Preprocessor &PP;
518  ASTContext *Context;
519  HeaderSearchOptions &HSOpts;
520  PreprocessorOptions &PPOpts;
521  LangOptions &LangOpt;
522  std::shared_ptr<TargetOptions> &TargetOpts;
523  IntrusiveRefCntPtr<TargetInfo> &Target;
524  unsigned &Counter;
525  bool InitializedLanguage = false;
526 
527 public:
528  ASTInfoCollector(Preprocessor &PP, ASTContext *Context,
529  HeaderSearchOptions &HSOpts, PreprocessorOptions &PPOpts,
530  LangOptions &LangOpt,
531  std::shared_ptr<TargetOptions> &TargetOpts,
532  IntrusiveRefCntPtr<TargetInfo> &Target, unsigned &Counter)
533  : PP(PP), Context(Context), HSOpts(HSOpts), PPOpts(PPOpts),
534  LangOpt(LangOpt), TargetOpts(TargetOpts), Target(Target),
535  Counter(Counter) {}
536 
537  bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
538  bool AllowCompatibleDifferences) override {
539  if (InitializedLanguage)
540  return false;
541 
542  LangOpt = LangOpts;
543  InitializedLanguage = true;
544 
545  updated();
546  return false;
547  }
548 
549  bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
550  StringRef SpecificModuleCachePath,
551  bool Complain) override {
552  this->HSOpts = HSOpts;
553  return false;
554  }
555 
556  bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
557  std::string &SuggestedPredefines) override {
558  this->PPOpts = PPOpts;
559  return false;
560  }
561 
562  bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
563  bool AllowCompatibleDifferences) override {
564  // If we've already initialized the target, don't do it again.
565  if (Target)
566  return false;
567 
568  this->TargetOpts = std::make_shared<TargetOptions>(TargetOpts);
569  Target =
570  TargetInfo::CreateTargetInfo(PP.getDiagnostics(), this->TargetOpts);
571 
572  updated();
573  return false;
574  }
575 
576  void ReadCounter(const serialization::ModuleFile &M,
577  unsigned Value) override {
578  Counter = Value;
579  }
580 
581 private:
582  void updated() {
583  if (!Target || !InitializedLanguage)
584  return;
585 
586  // Inform the target of the language options.
587  //
588  // FIXME: We shouldn't need to do this, the target should be immutable once
589  // created. This complexity should be lifted elsewhere.
590  Target->adjust(LangOpt);
591 
592  // Initialize the preprocessor.
593  PP.Initialize(*Target);
594 
595  if (!Context)
596  return;
597 
598  // Initialize the ASTContext
599  Context->InitBuiltinTypes(*Target);
600 
601  // Adjust printing policy based on language options.
602  Context->setPrintingPolicy(PrintingPolicy(LangOpt));
603 
604  // We didn't have access to the comment options when the ASTContext was
605  // constructed, so register them now.
607  LangOpt.CommentOpts);
608  }
609 };
610 
611 /// Diagnostic consumer that saves each diagnostic it is given.
612 class FilterAndStoreDiagnosticConsumer : public DiagnosticConsumer {
615  bool CaptureNonErrorsFromIncludes = true;
616  const LangOptions *LangOpts = nullptr;
617  SourceManager *SourceMgr = nullptr;
618 
619 public:
620  FilterAndStoreDiagnosticConsumer(
623  bool CaptureNonErrorsFromIncludes)
624  : StoredDiags(StoredDiags), StandaloneDiags(StandaloneDiags),
625  CaptureNonErrorsFromIncludes(CaptureNonErrorsFromIncludes) {
626  assert((StoredDiags || StandaloneDiags) &&
627  "No output collections were passed to StoredDiagnosticConsumer.");
628  }
629 
630  void BeginSourceFile(const LangOptions &LangOpts,
631  const Preprocessor *PP = nullptr) override {
632  this->LangOpts = &LangOpts;
633  if (PP)
634  SourceMgr = &PP->getSourceManager();
635  }
636 
637  void HandleDiagnostic(DiagnosticsEngine::Level Level,
638  const Diagnostic &Info) override;
639 };
640 
641 /// RAII object that optionally captures and filters diagnostics, if
642 /// there is no diagnostic client to capture them already.
643 class CaptureDroppedDiagnostics {
644  DiagnosticsEngine &Diags;
645  FilterAndStoreDiagnosticConsumer Client;
646  DiagnosticConsumer *PreviousClient = nullptr;
647  std::unique_ptr<DiagnosticConsumer> OwningPreviousClient;
648 
649 public:
650  CaptureDroppedDiagnostics(
651  CaptureDiagsKind CaptureDiagnostics, DiagnosticsEngine &Diags,
654  : Diags(Diags),
655  Client(StoredDiags, StandaloneDiags,
656  CaptureDiagnostics !=
658  if (CaptureDiagnostics != CaptureDiagsKind::None ||
659  Diags.getClient() == nullptr) {
660  OwningPreviousClient = Diags.takeClient();
661  PreviousClient = Diags.getClient();
662  Diags.setClient(&Client, false);
663  }
664  }
665 
666  ~CaptureDroppedDiagnostics() {
667  if (Diags.getClient() == &Client)
668  Diags.setClient(PreviousClient, !!OwningPreviousClient.release());
669  }
670 };
671 
672 } // namespace
673 
675 makeStandaloneDiagnostic(const LangOptions &LangOpts,
676  const StoredDiagnostic &InDiag);
677 
678 static bool isInMainFile(const clang::Diagnostic &D) {
679  if (!D.hasSourceManager() || !D.getLocation().isValid())
680  return false;
681 
682  auto &M = D.getSourceManager();
683  return M.isWrittenInMainFile(M.getExpansionLoc(D.getLocation()));
684 }
685 
686 void FilterAndStoreDiagnosticConsumer::HandleDiagnostic(
688  // Default implementation (Warnings/errors count).
690 
691  // Only record the diagnostic if it's part of the source manager we know
692  // about. This effectively drops diagnostics from modules we're building.
693  // FIXME: In the long run, ee don't want to drop source managers from modules.
694  if (!Info.hasSourceManager() || &Info.getSourceManager() == SourceMgr) {
695  if (!CaptureNonErrorsFromIncludes && Level <= DiagnosticsEngine::Warning &&
696  !isInMainFile(Info)) {
697  return;
698  }
699 
700  StoredDiagnostic *ResultDiag = nullptr;
701  if (StoredDiags) {
702  StoredDiags->emplace_back(Level, Info);
703  ResultDiag = &StoredDiags->back();
704  }
705 
706  if (StandaloneDiags) {
708  if (!ResultDiag) {
709  StoredDiag.emplace(Level, Info);
710  ResultDiag = StoredDiag.getPointer();
711  }
712  StandaloneDiags->push_back(
713  makeStandaloneDiagnostic(*LangOpts, *ResultDiag));
714  }
715  }
716 }
717 
719  return Reader;
720 }
721 
723  if (WriterData)
724  return &WriterData->Writer;
725  return nullptr;
726 }
727 
729  if (WriterData)
730  return &WriterData->Writer;
731  return nullptr;
732 }
733 
734 std::unique_ptr<llvm::MemoryBuffer>
735 ASTUnit::getBufferForFile(StringRef Filename, std::string *ErrorStr) {
736  assert(FileMgr);
737  auto Buffer = FileMgr->getBufferForFile(Filename, UserFilesAreVolatile);
738  if (Buffer)
739  return std::move(*Buffer);
740  if (ErrorStr)
741  *ErrorStr = Buffer.getError().message();
742  return nullptr;
743 }
744 
745 /// Configure the diagnostics object for use with ASTUnit.
746 void ASTUnit::ConfigureDiags(IntrusiveRefCntPtr<DiagnosticsEngine> Diags,
747  ASTUnit &AST,
748  CaptureDiagsKind CaptureDiagnostics) {
749  assert(Diags.get() && "no DiagnosticsEngine was provided");
750  if (CaptureDiagnostics != CaptureDiagsKind::None)
751  Diags->setClient(new FilterAndStoreDiagnosticConsumer(
752  &AST.StoredDiagnostics, nullptr,
754 }
755 
756 std::unique_ptr<ASTUnit> ASTUnit::LoadFromASTFile(
757  const std::string &Filename, const PCHContainerReader &PCHContainerRdr,
759  const FileSystemOptions &FileSystemOpts, bool UseDebugInfo,
760  bool OnlyLocalDecls, ArrayRef<RemappedFile> RemappedFiles,
761  CaptureDiagsKind CaptureDiagnostics, bool AllowPCHWithCompilerErrors,
762  bool UserFilesAreVolatile) {
763  std::unique_ptr<ASTUnit> AST(new ASTUnit(true));
764 
765  // Recover resources if we crash before exiting this method.
766  llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
767  ASTUnitCleanup(AST.get());
768  llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
769  llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
770  DiagCleanup(Diags.get());
771 
772  ConfigureDiags(Diags, *AST, CaptureDiagnostics);
773 
774  AST->LangOpts = std::make_shared<LangOptions>();
775  AST->OnlyLocalDecls = OnlyLocalDecls;
776  AST->CaptureDiagnostics = CaptureDiagnostics;
777  AST->Diagnostics = Diags;
779  llvm::vfs::getRealFileSystem();
780  AST->FileMgr = new FileManager(FileSystemOpts, VFS);
781  AST->UserFilesAreVolatile = UserFilesAreVolatile;
782  AST->SourceMgr = new SourceManager(AST->getDiagnostics(),
783  AST->getFileManager(),
784  UserFilesAreVolatile);
785  AST->ModuleCache = new InMemoryModuleCache;
786  AST->HSOpts = std::make_shared<HeaderSearchOptions>();
787  AST->HSOpts->ModuleFormat = PCHContainerRdr.getFormat();
788  AST->HeaderInfo.reset(new HeaderSearch(AST->HSOpts,
789  AST->getSourceManager(),
790  AST->getDiagnostics(),
791  AST->getLangOpts(),
792  /*Target=*/nullptr));
793  AST->PPOpts = std::make_shared<PreprocessorOptions>();
794 
795  for (const auto &RemappedFile : RemappedFiles)
796  AST->PPOpts->addRemappedFile(RemappedFile.first, RemappedFile.second);
797 
798  // Gather Info for preprocessor construction later on.
799 
800  HeaderSearch &HeaderInfo = *AST->HeaderInfo;
801  unsigned Counter;
802 
803  AST->PP = std::make_shared<Preprocessor>(
804  AST->PPOpts, AST->getDiagnostics(), *AST->LangOpts,
805  AST->getSourceManager(), HeaderInfo, AST->ModuleLoader,
806  /*IILookup=*/nullptr,
807  /*OwnsHeaderSearch=*/false);
808  Preprocessor &PP = *AST->PP;
809 
810  if (ToLoad >= LoadASTOnly)
811  AST->Ctx = new ASTContext(*AST->LangOpts, AST->getSourceManager(),
812  PP.getIdentifierTable(), PP.getSelectorTable(),
813  PP.getBuiltinInfo());
814 
815  bool disableValid = false;
816  if (::getenv("LIBCLANG_DISABLE_PCH_VALIDATION"))
817  disableValid = true;
818  AST->Reader = new ASTReader(
819  PP, *AST->ModuleCache, AST->Ctx.get(), PCHContainerRdr, {},
820  /*isysroot=*/"",
821  /*DisableValidation=*/disableValid, AllowPCHWithCompilerErrors);
822 
823  AST->Reader->setListener(std::make_unique<ASTInfoCollector>(
824  *AST->PP, AST->Ctx.get(), *AST->HSOpts, *AST->PPOpts, *AST->LangOpts,
825  AST->TargetOpts, AST->Target, Counter));
826 
827  // Attach the AST reader to the AST context as an external AST
828  // source, so that declarations will be deserialized from the
829  // AST file as needed.
830  // We need the external source to be set up before we read the AST, because
831  // eagerly-deserialized declarations may use it.
832  if (AST->Ctx)
833  AST->Ctx->setExternalSource(AST->Reader);
834 
835  switch (AST->Reader->ReadAST(Filename, serialization::MK_MainFile,
837  case ASTReader::Success:
838  break;
839 
840  case ASTReader::Failure:
841  case ASTReader::Missing:
846  AST->getDiagnostics().Report(diag::err_fe_unable_to_load_pch);
847  return nullptr;
848  }
849 
850  AST->OriginalSourceFile = AST->Reader->getOriginalSourceFile();
851 
852  PP.setCounterValue(Counter);
853 
854  // Create an AST consumer, even though it isn't used.
855  if (ToLoad >= LoadASTOnly)
856  AST->Consumer.reset(new ASTConsumer);
857 
858  // Create a semantic analysis object and tell the AST reader about it.
859  if (ToLoad >= LoadEverything) {
860  AST->TheSema.reset(new Sema(PP, *AST->Ctx, *AST->Consumer));
861  AST->TheSema->Initialize();
862  AST->Reader->InitializeSema(*AST->TheSema);
863  }
864 
865  // Tell the diagnostic client that we have started a source file.
866  AST->getDiagnostics().getClient()->BeginSourceFile(PP.getLangOpts(), &PP);
867 
868  return AST;
869 }
870 
871 /// Add the given macro to the hash of all top-level entities.
872 static void AddDefinedMacroToHash(const Token &MacroNameTok, unsigned &Hash) {
873  Hash = llvm::djbHash(MacroNameTok.getIdentifierInfo()->getName(), Hash);
874 }
875 
876 namespace {
877 
878 /// Preprocessor callback class that updates a hash value with the names
879 /// of all macros that have been defined by the translation unit.
880 class MacroDefinitionTrackerPPCallbacks : public PPCallbacks {
881  unsigned &Hash;
882 
883 public:
884  explicit MacroDefinitionTrackerPPCallbacks(unsigned &Hash) : Hash(Hash) {}
885 
886  void MacroDefined(const Token &MacroNameTok,
887  const MacroDirective *MD) override {
888  AddDefinedMacroToHash(MacroNameTok, Hash);
889  }
890 };
891 
892 } // namespace
893 
894 /// Add the given declaration to the hash of all top-level entities.
895 static void AddTopLevelDeclarationToHash(Decl *D, unsigned &Hash) {
896  if (!D)
897  return;
898 
899  DeclContext *DC = D->getDeclContext();
900  if (!DC)
901  return;
902 
903  if (!(DC->isTranslationUnit() || DC->getLookupParent()->isTranslationUnit()))
904  return;
905 
906  if (const auto *ND = dyn_cast<NamedDecl>(D)) {
907  if (const auto *EnumD = dyn_cast<EnumDecl>(D)) {
908  // For an unscoped enum include the enumerators in the hash since they
909  // enter the top-level namespace.
910  if (!EnumD->isScoped()) {
911  for (const auto *EI : EnumD->enumerators()) {
912  if (EI->getIdentifier())
913  Hash = llvm::djbHash(EI->getIdentifier()->getName(), Hash);
914  }
915  }
916  }
917 
918  if (ND->getIdentifier())
919  Hash = llvm::djbHash(ND->getIdentifier()->getName(), Hash);
920  else if (DeclarationName Name = ND->getDeclName()) {
921  std::string NameStr = Name.getAsString();
922  Hash = llvm::djbHash(NameStr, Hash);
923  }
924  return;
925  }
926 
927  if (const auto *ImportD = dyn_cast<ImportDecl>(D)) {
928  if (const Module *Mod = ImportD->getImportedModule()) {
929  std::string ModName = Mod->getFullModuleName();
930  Hash = llvm::djbHash(ModName, Hash);
931  }
932  return;
933  }
934 }
935 
936 namespace {
937 
938 class TopLevelDeclTrackerConsumer : public ASTConsumer {
939  ASTUnit &Unit;
940  unsigned &Hash;
941 
942 public:
943  TopLevelDeclTrackerConsumer(ASTUnit &_Unit, unsigned &Hash)
944  : Unit(_Unit), Hash(Hash) {
945  Hash = 0;
946  }
947 
948  void handleTopLevelDecl(Decl *D) {
949  if (!D)
950  return;
951 
952  // FIXME: Currently ObjC method declarations are incorrectly being
953  // reported as top-level declarations, even though their DeclContext
954  // is the containing ObjC @interface/@implementation. This is a
955  // fundamental problem in the parser right now.
956  if (isa<ObjCMethodDecl>(D))
957  return;
958 
960  Unit.addTopLevelDecl(D);
961 
962  handleFileLevelDecl(D);
963  }
964 
965  void handleFileLevelDecl(Decl *D) {
966  Unit.addFileLevelDecl(D);
967  if (auto *NSD = dyn_cast<NamespaceDecl>(D)) {
968  for (auto *I : NSD->decls())
969  handleFileLevelDecl(I);
970  }
971  }
972 
973  bool HandleTopLevelDecl(DeclGroupRef D) override {
974  for (auto *TopLevelDecl : D)
975  handleTopLevelDecl(TopLevelDecl);
976  return true;
977  }
978 
979  // We're not interested in "interesting" decls.
980  void HandleInterestingDecl(DeclGroupRef) override {}
981 
982  void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override {
983  for (auto *TopLevelDecl : D)
984  handleTopLevelDecl(TopLevelDecl);
985  }
986 
987  ASTMutationListener *GetASTMutationListener() override {
988  return Unit.getASTMutationListener();
989  }
990 
991  ASTDeserializationListener *GetASTDeserializationListener() override {
992  return Unit.getDeserializationListener();
993  }
994 };
995 
996 class TopLevelDeclTrackerAction : public ASTFrontendAction {
997 public:
998  ASTUnit &Unit;
999 
1000  std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
1001  StringRef InFile) override {
1003  std::make_unique<MacroDefinitionTrackerPPCallbacks>(
1004  Unit.getCurrentTopLevelHashValue()));
1005  return std::make_unique<TopLevelDeclTrackerConsumer>(
1006  Unit, Unit.getCurrentTopLevelHashValue());
1007  }
1008 
1009 public:
1010  TopLevelDeclTrackerAction(ASTUnit &_Unit) : Unit(_Unit) {}
1011 
1012  bool hasCodeCompletionSupport() const override { return false; }
1013 
1015  return Unit.getTranslationUnitKind();
1016  }
1017 };
1018 
1019 class ASTUnitPreambleCallbacks : public PreambleCallbacks {
1020 public:
1021  unsigned getHash() const { return Hash; }
1022 
1023  std::vector<Decl *> takeTopLevelDecls() { return std::move(TopLevelDecls); }
1024 
1025  std::vector<serialization::DeclID> takeTopLevelDeclIDs() {
1026  return std::move(TopLevelDeclIDs);
1027  }
1028 
1029  void AfterPCHEmitted(ASTWriter &Writer) override {
1030  TopLevelDeclIDs.reserve(TopLevelDecls.size());
1031  for (const auto *D : TopLevelDecls) {
1032  // Invalid top-level decls may not have been serialized.
1033  if (D->isInvalidDecl())
1034  continue;
1035  TopLevelDeclIDs.push_back(Writer.getDeclID(D));
1036  }
1037  }
1038 
1039  void HandleTopLevelDecl(DeclGroupRef DG) override {
1040  for (auto *D : DG) {
1041  // FIXME: Currently ObjC method declarations are incorrectly being
1042  // reported as top-level declarations, even though their DeclContext
1043  // is the containing ObjC @interface/@implementation. This is a
1044  // fundamental problem in the parser right now.
1045  if (isa<ObjCMethodDecl>(D))
1046  continue;
1048  TopLevelDecls.push_back(D);
1049  }
1050  }
1051 
1052  std::unique_ptr<PPCallbacks> createPPCallbacks() override {
1053  return std::make_unique<MacroDefinitionTrackerPPCallbacks>(Hash);
1054  }
1055 
1056 private:
1057  unsigned Hash = 0;
1058  std::vector<Decl *> TopLevelDecls;
1059  std::vector<serialization::DeclID> TopLevelDeclIDs;
1061 };
1062 
1063 } // namespace
1064 
1065 static bool isNonDriverDiag(const StoredDiagnostic &StoredDiag) {
1066  return StoredDiag.getLocation().isValid();
1067 }
1068 
1069 static void
1071  // Get rid of stored diagnostics except the ones from the driver which do not
1072  // have a source location.
1073  StoredDiags.erase(
1074  std::remove_if(StoredDiags.begin(), StoredDiags.end(), isNonDriverDiag),
1075  StoredDiags.end());
1076 }
1077 
1079  StoredDiagnostics,
1080  SourceManager &SM) {
1081  // The stored diagnostic has the old source manager in it; update
1082  // the locations to refer into the new source manager. Since we've
1083  // been careful to make sure that the source manager's state
1084  // before and after are identical, so that we can reuse the source
1085  // location itself.
1086  for (auto &SD : StoredDiagnostics) {
1087  if (SD.getLocation().isValid()) {
1088  FullSourceLoc Loc(SD.getLocation(), SM);
1089  SD.setLocation(Loc);
1090  }
1091  }
1092 }
1093 
1094 /// Parse the source file into a translation unit using the given compiler
1095 /// invocation, replacing the current translation unit.
1096 ///
1097 /// \returns True if a failure occurred that causes the ASTUnit not to
1098 /// contain any translation-unit information, false otherwise.
1099 bool ASTUnit::Parse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1100  std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer,
1102  if (!Invocation)
1103  return true;
1104 
1105  if (VFS && FileMgr)
1106  assert(VFS == &FileMgr->getVirtualFileSystem() &&
1107  "VFS passed to Parse and VFS in FileMgr are different");
1108 
1109  auto CCInvocation = std::make_shared<CompilerInvocation>(*Invocation);
1110  if (OverrideMainBuffer) {
1111  assert(Preamble &&
1112  "No preamble was built, but OverrideMainBuffer is not null");
1113  Preamble->AddImplicitPreamble(*CCInvocation, VFS, OverrideMainBuffer.get());
1114  // VFS may have changed...
1115  }
1116 
1117  // Create the compiler instance to use for building the AST.
1118  std::unique_ptr<CompilerInstance> Clang(
1119  new CompilerInstance(std::move(PCHContainerOps)));
1120 
1121  // Ensure that Clang has a FileManager with the right VFS, which may have
1122  // changed above in AddImplicitPreamble. If VFS is nullptr, rely on
1123  // createFileManager to create one.
1124  if (VFS && FileMgr && &FileMgr->getVirtualFileSystem() == VFS)
1125  Clang->setFileManager(&*FileMgr);
1126  else
1127  FileMgr = Clang->createFileManager(std::move(VFS));
1128 
1129  // Recover resources if we crash before exiting this method.
1130  llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1131  CICleanup(Clang.get());
1132 
1133  Clang->setInvocation(CCInvocation);
1134  OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
1135 
1136  // Set up diagnostics, capturing any diagnostics that would
1137  // otherwise be dropped.
1138  Clang->setDiagnostics(&getDiagnostics());
1139 
1140  // Create the target instance.
1141  Clang->setTarget(TargetInfo::CreateTargetInfo(
1142  Clang->getDiagnostics(), Clang->getInvocation().TargetOpts));
1143  if (!Clang->hasTarget())
1144  return true;
1145 
1146  // Inform the target of the language options.
1147  //
1148  // FIXME: We shouldn't need to do this, the target should be immutable once
1149  // created. This complexity should be lifted elsewhere.
1150  Clang->getTarget().adjust(Clang->getLangOpts());
1151 
1152  assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1153  "Invocation must have exactly one source file!");
1154  assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
1156  "FIXME: AST inputs not yet supported here!");
1157  assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
1159  "IR inputs not support here!");
1160 
1161  // Configure the various subsystems.
1162  LangOpts = Clang->getInvocation().LangOpts;
1163  FileSystemOpts = Clang->getFileSystemOpts();
1164 
1165  ResetForParse();
1166 
1167  SourceMgr = new SourceManager(getDiagnostics(), *FileMgr,
1168  UserFilesAreVolatile);
1169  if (!OverrideMainBuffer) {
1170  checkAndRemoveNonDriverDiags(StoredDiagnostics);
1171  TopLevelDeclsInPreamble.clear();
1172  }
1173 
1174  // Create a file manager object to provide access to and cache the filesystem.
1175  Clang->setFileManager(&getFileManager());
1176 
1177  // Create the source manager.
1178  Clang->setSourceManager(&getSourceManager());
1179 
1180  // If the main file has been overridden due to the use of a preamble,
1181  // make that override happen and introduce the preamble.
1182  if (OverrideMainBuffer) {
1183  // 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.
1188  checkAndSanitizeDiags(StoredDiagnostics, getSourceManager());
1189 
1190  // Keep track of the override buffer;
1191  SavedMainFileBuffer = std::move(OverrideMainBuffer);
1192  }
1193 
1194  std::unique_ptr<TopLevelDeclTrackerAction> Act(
1195  new TopLevelDeclTrackerAction(*this));
1196 
1197  // Recover resources if we crash before exiting this method.
1198  llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1199  ActCleanup(Act.get());
1200 
1201  if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0]))
1202  goto error;
1203 
1204  if (SavedMainFileBuffer)
1205  TranslateStoredDiagnostics(getFileManager(), getSourceManager(),
1206  PreambleDiagnostics, StoredDiagnostics);
1207  else
1208  PreambleSrcLocCache.clear();
1209 
1210  if (llvm::Error Err = Act->Execute()) {
1211  consumeError(std::move(Err)); // FIXME this drops errors on the floor.
1212  goto error;
1213  }
1214 
1215  transferASTDataFromCompilerInstance(*Clang);
1216 
1217  Act->EndSourceFile();
1218 
1219  FailedParseDiagnostics.clear();
1220 
1221  return false;
1222 
1223 error:
1224  // Remove the overridden buffer we used for the preamble.
1225  SavedMainFileBuffer = nullptr;
1226 
1227  // Keep the ownership of the data in the ASTUnit because the client may
1228  // want to see the diagnostics.
1229  transferASTDataFromCompilerInstance(*Clang);
1230  FailedParseDiagnostics.swap(StoredDiagnostics);
1231  StoredDiagnostics.clear();
1232  NumStoredDiagnosticsFromDriver = 0;
1233  return true;
1234 }
1235 
1236 static std::pair<unsigned, unsigned>
1238  const LangOptions &LangOpts) {
1239  CharSourceRange FileRange = Lexer::makeFileCharRange(Range, SM, LangOpts);
1240  unsigned Offset = SM.getFileOffset(FileRange.getBegin());
1241  unsigned EndOffset = SM.getFileOffset(FileRange.getEnd());
1242  return std::make_pair(Offset, EndOffset);
1243 }
1244 
1246  const LangOptions &LangOpts,
1247  const FixItHint &InFix) {
1248  ASTUnit::StandaloneFixIt OutFix;
1249  OutFix.RemoveRange = makeStandaloneRange(InFix.RemoveRange, SM, LangOpts);
1251  LangOpts);
1252  OutFix.CodeToInsert = InFix.CodeToInsert;
1254  return OutFix;
1255 }
1256 
1259  const StoredDiagnostic &InDiag) {
1261  OutDiag.ID = InDiag.getID();
1262  OutDiag.Level = InDiag.getLevel();
1263  OutDiag.Message = InDiag.getMessage();
1264  OutDiag.LocOffset = 0;
1265  if (InDiag.getLocation().isInvalid())
1266  return OutDiag;
1267  const SourceManager &SM = InDiag.getLocation().getManager();
1268  SourceLocation FileLoc = SM.getFileLoc(InDiag.getLocation());
1269  OutDiag.Filename = SM.getFilename(FileLoc);
1270  if (OutDiag.Filename.empty())
1271  return OutDiag;
1272  OutDiag.LocOffset = SM.getFileOffset(FileLoc);
1273  for (const auto &Range : InDiag.getRanges())
1274  OutDiag.Ranges.push_back(makeStandaloneRange(Range, SM, LangOpts));
1275  for (const auto &FixIt : InDiag.getFixIts())
1276  OutDiag.FixIts.push_back(makeStandaloneFixIt(SM, LangOpts, FixIt));
1277 
1278  return OutDiag;
1279 }
1280 
1281 /// Attempt to build or re-use a precompiled preamble when (re-)parsing
1282 /// the source file.
1283 ///
1284 /// This routine will compute the preamble of the main source file. If a
1285 /// non-trivial preamble is found, it will precompile that preamble into a
1286 /// precompiled header so that the precompiled preamble can be used to reduce
1287 /// reparsing time. If a precompiled preamble has already been constructed,
1288 /// this routine will determine if it is still valid and, if so, avoid
1289 /// rebuilding the precompiled preamble.
1290 ///
1291 /// \param AllowRebuild When true (the default), this routine is
1292 /// allowed to rebuild the precompiled preamble if it is found to be
1293 /// out-of-date.
1294 ///
1295 /// \param MaxLines When non-zero, the maximum number of lines that
1296 /// can occur within the preamble.
1297 ///
1298 /// \returns If the precompiled preamble can be used, returns a newly-allocated
1299 /// buffer that should be used in place of the main file when doing so.
1300 /// Otherwise, returns a NULL pointer.
1301 std::unique_ptr<llvm::MemoryBuffer>
1302 ASTUnit::getMainBufferWithPrecompiledPreamble(
1303  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1304  CompilerInvocation &PreambleInvocationIn,
1305  IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS, bool AllowRebuild,
1306  unsigned MaxLines) {
1307  auto MainFilePath =
1308  PreambleInvocationIn.getFrontendOpts().Inputs[0].getFile();
1309  std::unique_ptr<llvm::MemoryBuffer> MainFileBuffer =
1310  getBufferForFileHandlingRemapping(PreambleInvocationIn, VFS.get(),
1311  MainFilePath, UserFilesAreVolatile);
1312  if (!MainFileBuffer)
1313  return nullptr;
1314 
1315  PreambleBounds Bounds =
1316  ComputePreambleBounds(*PreambleInvocationIn.getLangOpts(),
1317  MainFileBuffer.get(), MaxLines);
1318  if (!Bounds.Size)
1319  return nullptr;
1320 
1321  if (Preamble) {
1322  if (Preamble->CanReuse(PreambleInvocationIn, MainFileBuffer.get(), Bounds,
1323  VFS.get())) {
1324  // Okay! We can re-use the precompiled preamble.
1325 
1326  // Set the state of the diagnostic object to mimic its state
1327  // after parsing the preamble.
1328  getDiagnostics().Reset();
1330  PreambleInvocationIn.getDiagnosticOpts());
1331  getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1332 
1333  PreambleRebuildCountdown = 1;
1334  return MainFileBuffer;
1335  } else {
1336  Preamble.reset();
1337  PreambleDiagnostics.clear();
1338  TopLevelDeclsInPreamble.clear();
1339  PreambleSrcLocCache.clear();
1340  PreambleRebuildCountdown = 1;
1341  }
1342  }
1343 
1344  // If the preamble rebuild counter > 1, it's because we previously
1345  // failed to build a preamble and we're not yet ready to try
1346  // again. Decrement the counter and return a failure.
1347  if (PreambleRebuildCountdown > 1) {
1348  --PreambleRebuildCountdown;
1349  return nullptr;
1350  }
1351 
1352  assert(!Preamble && "No Preamble should be stored at that point");
1353  // If we aren't allowed to rebuild the precompiled preamble, just
1354  // return now.
1355  if (!AllowRebuild)
1356  return nullptr;
1357 
1358  ++PreambleCounter;
1359 
1360  SmallVector<StandaloneDiagnostic, 4> NewPreambleDiagsStandalone;
1361  SmallVector<StoredDiagnostic, 4> NewPreambleDiags;
1362  ASTUnitPreambleCallbacks Callbacks;
1363  {
1365  if (CaptureDiagnostics != CaptureDiagsKind::None)
1366  Capture.emplace(CaptureDiagnostics, *Diagnostics, &NewPreambleDiags,
1367  &NewPreambleDiagsStandalone);
1368 
1369  // We did not previously compute a preamble, or it can't be reused anyway.
1370  SimpleTimer PreambleTimer(WantTiming);
1371  PreambleTimer.setOutput("Precompiling preamble");
1372 
1373  const bool PreviousSkipFunctionBodies =
1374  PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies;
1375  if (SkipFunctionBodies == SkipFunctionBodiesScope::Preamble)
1376  PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies = true;
1377 
1378  llvm::ErrorOr<PrecompiledPreamble> NewPreamble = PrecompiledPreamble::Build(
1379  PreambleInvocationIn, MainFileBuffer.get(), Bounds, *Diagnostics, VFS,
1380  PCHContainerOps, /*StoreInMemory=*/false, Callbacks);
1381 
1382  PreambleInvocationIn.getFrontendOpts().SkipFunctionBodies =
1383  PreviousSkipFunctionBodies;
1384 
1385  if (NewPreamble) {
1386  Preamble = std::move(*NewPreamble);
1387  PreambleRebuildCountdown = 1;
1388  } else {
1389  switch (static_cast<BuildPreambleError>(NewPreamble.getError().value())) {
1391  // Try again next time.
1392  PreambleRebuildCountdown = 1;
1393  return nullptr;
1398  // These erros are more likely to repeat, retry after some period.
1399  PreambleRebuildCountdown = DefaultPreambleRebuildInterval;
1400  return nullptr;
1401  }
1402  llvm_unreachable("unexpected BuildPreambleError");
1403  }
1404  }
1405 
1406  assert(Preamble && "Preamble wasn't built");
1407 
1408  TopLevelDecls.clear();
1409  TopLevelDeclsInPreamble = Callbacks.takeTopLevelDeclIDs();
1410  PreambleTopLevelHashValue = Callbacks.getHash();
1411 
1412  NumWarningsInPreamble = getDiagnostics().getNumWarnings();
1413 
1414  checkAndRemoveNonDriverDiags(NewPreambleDiags);
1415  StoredDiagnostics = std::move(NewPreambleDiags);
1416  PreambleDiagnostics = std::move(NewPreambleDiagsStandalone);
1417 
1418  // If the hash of top-level entities differs from the hash of the top-level
1419  // entities the last time we rebuilt the preamble, clear out the completion
1420  // cache.
1421  if (CurrentTopLevelHashValue != PreambleTopLevelHashValue) {
1422  CompletionCacheTopLevelHashValue = 0;
1423  PreambleTopLevelHashValue = CurrentTopLevelHashValue;
1424  }
1425 
1426  return MainFileBuffer;
1427 }
1428 
1429 void ASTUnit::RealizeTopLevelDeclsFromPreamble() {
1430  assert(Preamble && "Should only be called when preamble was built");
1431 
1432  std::vector<Decl *> Resolved;
1433  Resolved.reserve(TopLevelDeclsInPreamble.size());
1435  for (const auto TopLevelDecl : TopLevelDeclsInPreamble) {
1436  // Resolve the declaration ID to an actual declaration, possibly
1437  // deserializing the declaration in the process.
1438  if (Decl *D = Source.GetExternalDecl(TopLevelDecl))
1439  Resolved.push_back(D);
1440  }
1441  TopLevelDeclsInPreamble.clear();
1442  TopLevelDecls.insert(TopLevelDecls.begin(), Resolved.begin(), Resolved.end());
1443 }
1444 
1445 void ASTUnit::transferASTDataFromCompilerInstance(CompilerInstance &CI) {
1446  // Steal the created target, context, and preprocessor if they have been
1447  // created.
1448  assert(CI.hasInvocation() && "missing invocation");
1449  LangOpts = CI.getInvocation().LangOpts;
1450  TheSema = CI.takeSema();
1451  Consumer = CI.takeASTConsumer();
1452  if (CI.hasASTContext())
1453  Ctx = &CI.getASTContext();
1454  if (CI.hasPreprocessor())
1455  PP = CI.getPreprocessorPtr();
1456  CI.setSourceManager(nullptr);
1457  CI.setFileManager(nullptr);
1458  if (CI.hasTarget())
1459  Target = &CI.getTarget();
1460  Reader = CI.getModuleManager();
1461  HadModuleLoaderFatalFailure = CI.hadModuleLoaderFatalFailure();
1462 }
1463 
1464 StringRef ASTUnit::getMainFileName() const {
1465  if (Invocation && !Invocation->getFrontendOpts().Inputs.empty()) {
1466  const FrontendInputFile &Input = Invocation->getFrontendOpts().Inputs[0];
1467  if (Input.isFile())
1468  return Input.getFile();
1469  else
1470  return Input.getBuffer()->getBufferIdentifier();
1471  }
1472 
1473  if (SourceMgr) {
1474  if (const FileEntry *
1475  FE = SourceMgr->getFileEntryForID(SourceMgr->getMainFileID()))
1476  return FE->getName();
1477  }
1478 
1479  return {};
1480 }
1481 
1482 StringRef ASTUnit::getASTFileName() const {
1483  if (!isMainFileAST())
1484  return {};
1485 
1487  Mod = Reader->getModuleManager().getPrimaryModule();
1488  return Mod.FileName;
1489 }
1490 
1491 std::unique_ptr<ASTUnit>
1492 ASTUnit::create(std::shared_ptr<CompilerInvocation> CI,
1494  CaptureDiagsKind CaptureDiagnostics,
1495  bool UserFilesAreVolatile) {
1496  std::unique_ptr<ASTUnit> AST(new ASTUnit(false));
1497  ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1499  createVFSFromCompilerInvocation(*CI, *Diags);
1500  AST->Diagnostics = Diags;
1501  AST->FileSystemOpts = CI->getFileSystemOpts();
1502  AST->Invocation = std::move(CI);
1503  AST->FileMgr = new FileManager(AST->FileSystemOpts, VFS);
1504  AST->UserFilesAreVolatile = UserFilesAreVolatile;
1505  AST->SourceMgr = new SourceManager(AST->getDiagnostics(), *AST->FileMgr,
1506  UserFilesAreVolatile);
1507  AST->ModuleCache = new InMemoryModuleCache;
1508 
1509  return AST;
1510 }
1511 
1513  std::shared_ptr<CompilerInvocation> CI,
1514  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1516  ASTUnit *Unit, bool Persistent, StringRef ResourceFilesPath,
1517  bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1518  unsigned PrecompilePreambleAfterNParses, bool CacheCodeCompletionResults,
1519  bool IncludeBriefCommentsInCodeCompletion, bool UserFilesAreVolatile,
1520  std::unique_ptr<ASTUnit> *ErrAST) {
1521  assert(CI && "A CompilerInvocation is required");
1522 
1523  std::unique_ptr<ASTUnit> OwnAST;
1524  ASTUnit *AST = Unit;
1525  if (!AST) {
1526  // Create the AST unit.
1527  OwnAST = create(CI, Diags, CaptureDiagnostics, UserFilesAreVolatile);
1528  AST = OwnAST.get();
1529  if (!AST)
1530  return nullptr;
1531  }
1532 
1533  if (!ResourceFilesPath.empty()) {
1534  // Override the resources path.
1535  CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
1536  }
1537  AST->OnlyLocalDecls = OnlyLocalDecls;
1538  AST->CaptureDiagnostics = CaptureDiagnostics;
1539  if (PrecompilePreambleAfterNParses > 0)
1540  AST->PreambleRebuildCountdown = PrecompilePreambleAfterNParses;
1541  AST->TUKind = Action ? Action->getTranslationUnitKind() : TU_Complete;
1542  AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1543  AST->IncludeBriefCommentsInCodeCompletion
1544  = IncludeBriefCommentsInCodeCompletion;
1545 
1546  // Recover resources if we crash before exiting this method.
1547  llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1548  ASTUnitCleanup(OwnAST.get());
1549  llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1550  llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
1551  DiagCleanup(Diags.get());
1552 
1553  // We'll manage file buffers ourselves.
1554  CI->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1555  CI->getFrontendOpts().DisableFree = false;
1556  ProcessWarningOptions(AST->getDiagnostics(), CI->getDiagnosticOpts());
1557 
1558  // Create the compiler instance to use for building the AST.
1559  std::unique_ptr<CompilerInstance> Clang(
1560  new CompilerInstance(std::move(PCHContainerOps)));
1561 
1562  // Recover resources if we crash before exiting this method.
1563  llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
1564  CICleanup(Clang.get());
1565 
1566  Clang->setInvocation(std::move(CI));
1567  AST->OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
1568 
1569  // Set up diagnostics, capturing any diagnostics that would
1570  // otherwise be dropped.
1571  Clang->setDiagnostics(&AST->getDiagnostics());
1572 
1573  // Create the target instance.
1574  Clang->setTarget(TargetInfo::CreateTargetInfo(
1575  Clang->getDiagnostics(), Clang->getInvocation().TargetOpts));
1576  if (!Clang->hasTarget())
1577  return nullptr;
1578 
1579  // Inform the target of the language options.
1580  //
1581  // FIXME: We shouldn't need to do this, the target should be immutable once
1582  // created. This complexity should be lifted elsewhere.
1583  Clang->getTarget().adjust(Clang->getLangOpts());
1584 
1585  assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
1586  "Invocation must have exactly one source file!");
1587  assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
1589  "FIXME: AST inputs not yet supported here!");
1590  assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
1592  "IR inputs not support here!");
1593 
1594  // Configure the various subsystems.
1595  AST->TheSema.reset();
1596  AST->Ctx = nullptr;
1597  AST->PP = nullptr;
1598  AST->Reader = nullptr;
1599 
1600  // Create a file manager object to provide access to and cache the filesystem.
1601  Clang->setFileManager(&AST->getFileManager());
1602 
1603  // Create the source manager.
1604  Clang->setSourceManager(&AST->getSourceManager());
1605 
1606  FrontendAction *Act = Action;
1607 
1608  std::unique_ptr<TopLevelDeclTrackerAction> TrackerAct;
1609  if (!Act) {
1610  TrackerAct.reset(new TopLevelDeclTrackerAction(*AST));
1611  Act = TrackerAct.get();
1612  }
1613 
1614  // Recover resources if we crash before exiting this method.
1615  llvm::CrashRecoveryContextCleanupRegistrar<TopLevelDeclTrackerAction>
1616  ActCleanup(TrackerAct.get());
1617 
1618  if (!Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
1619  AST->transferASTDataFromCompilerInstance(*Clang);
1620  if (OwnAST && ErrAST)
1621  ErrAST->swap(OwnAST);
1622 
1623  return nullptr;
1624  }
1625 
1626  if (Persistent && !TrackerAct) {
1627  Clang->getPreprocessor().addPPCallbacks(
1628  std::make_unique<MacroDefinitionTrackerPPCallbacks>(
1629  AST->getCurrentTopLevelHashValue()));
1630  std::vector<std::unique_ptr<ASTConsumer>> Consumers;
1631  if (Clang->hasASTConsumer())
1632  Consumers.push_back(Clang->takeASTConsumer());
1633  Consumers.push_back(std::make_unique<TopLevelDeclTrackerConsumer>(
1634  *AST, AST->getCurrentTopLevelHashValue()));
1635  Clang->setASTConsumer(
1636  std::make_unique<MultiplexConsumer>(std::move(Consumers)));
1637  }
1638  if (llvm::Error Err = Act->Execute()) {
1639  consumeError(std::move(Err)); // FIXME this drops errors on the floor.
1640  AST->transferASTDataFromCompilerInstance(*Clang);
1641  if (OwnAST && ErrAST)
1642  ErrAST->swap(OwnAST);
1643 
1644  return nullptr;
1645  }
1646 
1647  // Steal the created target, context, and preprocessor.
1648  AST->transferASTDataFromCompilerInstance(*Clang);
1649 
1650  Act->EndSourceFile();
1651 
1652  if (OwnAST)
1653  return OwnAST.release();
1654  else
1655  return AST;
1656 }
1657 
1658 bool ASTUnit::LoadFromCompilerInvocation(
1659  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1660  unsigned PrecompilePreambleAfterNParses,
1662  if (!Invocation)
1663  return true;
1664 
1665  assert(VFS && "VFS is null");
1666 
1667  // We'll manage file buffers ourselves.
1668  Invocation->getPreprocessorOpts().RetainRemappedFileBuffers = true;
1669  Invocation->getFrontendOpts().DisableFree = false;
1670  getDiagnostics().Reset();
1671  ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1672 
1673  std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
1674  if (PrecompilePreambleAfterNParses > 0) {
1675  PreambleRebuildCountdown = PrecompilePreambleAfterNParses;
1676  OverrideMainBuffer =
1677  getMainBufferWithPrecompiledPreamble(PCHContainerOps, *Invocation, VFS);
1678  getDiagnostics().Reset();
1679  ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1680  }
1681 
1682  SimpleTimer ParsingTimer(WantTiming);
1683  ParsingTimer.setOutput("Parsing " + getMainFileName());
1684 
1685  // Recover resources if we crash before exiting this method.
1686  llvm::CrashRecoveryContextCleanupRegistrar<llvm::MemoryBuffer>
1687  MemBufferCleanup(OverrideMainBuffer.get());
1688 
1689  return Parse(std::move(PCHContainerOps), std::move(OverrideMainBuffer), VFS);
1690 }
1691 
1692 std::unique_ptr<ASTUnit> ASTUnit::LoadFromCompilerInvocation(
1693  std::shared_ptr<CompilerInvocation> CI,
1694  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1696  bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1697  unsigned PrecompilePreambleAfterNParses, TranslationUnitKind TUKind,
1698  bool CacheCodeCompletionResults, bool IncludeBriefCommentsInCodeCompletion,
1699  bool UserFilesAreVolatile) {
1700  // Create the AST unit.
1701  std::unique_ptr<ASTUnit> AST(new ASTUnit(false));
1702  ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1703  AST->Diagnostics = Diags;
1704  AST->OnlyLocalDecls = OnlyLocalDecls;
1705  AST->CaptureDiagnostics = CaptureDiagnostics;
1706  AST->TUKind = TUKind;
1707  AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1708  AST->IncludeBriefCommentsInCodeCompletion
1709  = IncludeBriefCommentsInCodeCompletion;
1710  AST->Invocation = std::move(CI);
1711  AST->FileSystemOpts = FileMgr->getFileSystemOpts();
1712  AST->FileMgr = FileMgr;
1713  AST->UserFilesAreVolatile = UserFilesAreVolatile;
1714 
1715  // Recover resources if we crash before exiting this method.
1716  llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1717  ASTUnitCleanup(AST.get());
1718  llvm::CrashRecoveryContextCleanupRegistrar<DiagnosticsEngine,
1719  llvm::CrashRecoveryContextReleaseRefCleanup<DiagnosticsEngine>>
1720  DiagCleanup(Diags.get());
1721 
1722  if (AST->LoadFromCompilerInvocation(std::move(PCHContainerOps),
1723  PrecompilePreambleAfterNParses,
1724  &AST->FileMgr->getVirtualFileSystem()))
1725  return nullptr;
1726  return AST;
1727 }
1728 
1730  const char **ArgBegin, const char **ArgEnd,
1731  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1732  IntrusiveRefCntPtr<DiagnosticsEngine> Diags, StringRef ResourceFilesPath,
1733  bool OnlyLocalDecls, CaptureDiagsKind CaptureDiagnostics,
1734  ArrayRef<RemappedFile> RemappedFiles, bool RemappedFilesKeepOriginalName,
1735  unsigned PrecompilePreambleAfterNParses, TranslationUnitKind TUKind,
1736  bool CacheCodeCompletionResults, bool IncludeBriefCommentsInCodeCompletion,
1737  bool AllowPCHWithCompilerErrors, SkipFunctionBodiesScope SkipFunctionBodies,
1738  bool SingleFileParse, bool UserFilesAreVolatile, bool ForSerialization,
1739  bool RetainExcludedConditionalBlocks,
1740  llvm::Optional<StringRef> ModuleFormat, std::unique_ptr<ASTUnit> *ErrAST,
1742  assert(Diags.get() && "no DiagnosticsEngine was provided");
1743 
1744  SmallVector<StoredDiagnostic, 4> StoredDiagnostics;
1745 
1746  std::shared_ptr<CompilerInvocation> CI;
1747 
1748  {
1749  CaptureDroppedDiagnostics Capture(CaptureDiagnostics, *Diags,
1750  &StoredDiagnostics, nullptr);
1751 
1753  llvm::makeArrayRef(ArgBegin, ArgEnd), Diags, VFS);
1754  if (!CI)
1755  return nullptr;
1756  }
1757 
1758  // Override any files that need remapping
1759  for (const auto &RemappedFile : RemappedFiles) {
1760  CI->getPreprocessorOpts().addRemappedFile(RemappedFile.first,
1761  RemappedFile.second);
1762  }
1763  PreprocessorOptions &PPOpts = CI->getPreprocessorOpts();
1764  PPOpts.RemappedFilesKeepOriginalName = RemappedFilesKeepOriginalName;
1765  PPOpts.AllowPCHWithCompilerErrors = AllowPCHWithCompilerErrors;
1766  PPOpts.SingleFileParseMode = SingleFileParse;
1767  PPOpts.RetainExcludedConditionalBlocks = RetainExcludedConditionalBlocks;
1768 
1769  // Override the resources path.
1770  CI->getHeaderSearchOpts().ResourceDir = ResourceFilesPath;
1771 
1772  CI->getFrontendOpts().SkipFunctionBodies =
1773  SkipFunctionBodies == SkipFunctionBodiesScope::PreambleAndMainFile;
1774 
1775  if (ModuleFormat)
1776  CI->getHeaderSearchOpts().ModuleFormat = ModuleFormat.getValue();
1777 
1778  // Create the AST unit.
1779  std::unique_ptr<ASTUnit> AST;
1780  AST.reset(new ASTUnit(false));
1781  AST->NumStoredDiagnosticsFromDriver = StoredDiagnostics.size();
1782  AST->StoredDiagnostics.swap(StoredDiagnostics);
1783  ConfigureDiags(Diags, *AST, CaptureDiagnostics);
1784  AST->Diagnostics = Diags;
1785  AST->FileSystemOpts = CI->getFileSystemOpts();
1786  if (!VFS)
1787  VFS = llvm::vfs::getRealFileSystem();
1788  VFS = createVFSFromCompilerInvocation(*CI, *Diags, VFS);
1789  AST->FileMgr = new FileManager(AST->FileSystemOpts, VFS);
1790  AST->ModuleCache = new InMemoryModuleCache;
1791  AST->OnlyLocalDecls = OnlyLocalDecls;
1792  AST->CaptureDiagnostics = CaptureDiagnostics;
1793  AST->TUKind = TUKind;
1794  AST->ShouldCacheCodeCompletionResults = CacheCodeCompletionResults;
1795  AST->IncludeBriefCommentsInCodeCompletion
1796  = IncludeBriefCommentsInCodeCompletion;
1797  AST->UserFilesAreVolatile = UserFilesAreVolatile;
1798  AST->Invocation = CI;
1799  AST->SkipFunctionBodies = SkipFunctionBodies;
1800  if (ForSerialization)
1801  AST->WriterData.reset(new ASTWriterData(*AST->ModuleCache));
1802  // Zero out now to ease cleanup during crash recovery.
1803  CI = nullptr;
1804  Diags = nullptr;
1805 
1806  // Recover resources if we crash before exiting this method.
1807  llvm::CrashRecoveryContextCleanupRegistrar<ASTUnit>
1808  ASTUnitCleanup(AST.get());
1809 
1810  if (AST->LoadFromCompilerInvocation(std::move(PCHContainerOps),
1811  PrecompilePreambleAfterNParses,
1812  VFS)) {
1813  // Some error occurred, if caller wants to examine diagnostics, pass it the
1814  // ASTUnit.
1815  if (ErrAST) {
1816  AST->StoredDiagnostics.swap(AST->FailedParseDiagnostics);
1817  ErrAST->swap(AST);
1818  }
1819  return nullptr;
1820  }
1821 
1822  return AST.release();
1823 }
1824 
1825 bool ASTUnit::Reparse(std::shared_ptr<PCHContainerOperations> PCHContainerOps,
1826  ArrayRef<RemappedFile> RemappedFiles,
1828  if (!Invocation)
1829  return true;
1830 
1831  if (!VFS) {
1832  assert(FileMgr && "FileMgr is null on Reparse call");
1833  VFS = &FileMgr->getVirtualFileSystem();
1834  }
1835 
1836  clearFileLevelDecls();
1837 
1838  SimpleTimer ParsingTimer(WantTiming);
1839  ParsingTimer.setOutput("Reparsing " + getMainFileName());
1840 
1841  // Remap files.
1842  PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1843  for (const auto &RB : PPOpts.RemappedFileBuffers)
1844  delete RB.second;
1845 
1846  Invocation->getPreprocessorOpts().clearRemappedFiles();
1847  for (const auto &RemappedFile : RemappedFiles) {
1848  Invocation->getPreprocessorOpts().addRemappedFile(RemappedFile.first,
1849  RemappedFile.second);
1850  }
1851 
1852  // If we have a preamble file lying around, or if we might try to
1853  // build a precompiled preamble, do so now.
1854  std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
1855  if (Preamble || PreambleRebuildCountdown > 0)
1856  OverrideMainBuffer =
1857  getMainBufferWithPrecompiledPreamble(PCHContainerOps, *Invocation, VFS);
1858 
1859  // Clear out the diagnostics state.
1860  FileMgr.reset();
1861  getDiagnostics().Reset();
1862  ProcessWarningOptions(getDiagnostics(), Invocation->getDiagnosticOpts());
1863  if (OverrideMainBuffer)
1864  getDiagnostics().setNumWarnings(NumWarningsInPreamble);
1865 
1866  // Parse the sources
1867  bool Result =
1868  Parse(std::move(PCHContainerOps), std::move(OverrideMainBuffer), VFS);
1869 
1870  // If we're caching global code-completion results, and the top-level
1871  // declarations have changed, clear out the code-completion cache.
1872  if (!Result && ShouldCacheCodeCompletionResults &&
1873  CurrentTopLevelHashValue != CompletionCacheTopLevelHashValue)
1874  CacheCodeCompletionResults();
1875 
1876  // We now need to clear out the completion info related to this translation
1877  // unit; it'll be recreated if necessary.
1878  CCTUInfo.reset();
1879 
1880  return Result;
1881 }
1882 
1884  SavedMainFileBuffer.reset();
1885 
1886  SourceMgr.reset();
1887  TheSema.reset();
1888  Ctx.reset();
1889  PP.reset();
1890  Reader.reset();
1891 
1892  TopLevelDecls.clear();
1893  clearFileLevelDecls();
1894 }
1895 
1896 //----------------------------------------------------------------------------//
1897 // Code completion
1898 //----------------------------------------------------------------------------//
1899 
1900 namespace {
1901 
1902  /// Code completion consumer that combines the cached code-completion
1903  /// results from an ASTUnit with the code-completion results provided to it,
1904  /// then passes the result on to
1905  class AugmentedCodeCompleteConsumer : public CodeCompleteConsumer {
1906  uint64_t NormalContexts;
1907  ASTUnit &AST;
1908  CodeCompleteConsumer &Next;
1909 
1910  public:
1911  AugmentedCodeCompleteConsumer(ASTUnit &AST, CodeCompleteConsumer &Next,
1912  const CodeCompleteOptions &CodeCompleteOpts)
1913  : CodeCompleteConsumer(CodeCompleteOpts), AST(AST), Next(Next) {
1914  // Compute the set of contexts in which we will look when we don't have
1915  // any information about the specific context.
1916  NormalContexts
1930 
1931  if (AST.getASTContext().getLangOpts().CPlusPlus)
1932  NormalContexts |= (1LL << CodeCompletionContext::CCC_EnumTag)
1935  }
1936 
1937  void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
1938  CodeCompletionResult *Results,
1939  unsigned NumResults) override;
1940 
1941  void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg,
1942  OverloadCandidate *Candidates,
1943  unsigned NumCandidates,
1944  SourceLocation OpenParLoc) override {
1945  Next.ProcessOverloadCandidates(S, CurrentArg, Candidates, NumCandidates,
1946  OpenParLoc);
1947  }
1948 
1949  CodeCompletionAllocator &getAllocator() override {
1950  return Next.getAllocator();
1951  }
1952 
1954  return Next.getCodeCompletionTUInfo();
1955  }
1956  };
1957 
1958 } // namespace
1959 
1960 /// Helper function that computes which global names are hidden by the
1961 /// local code-completion results.
1962 static void CalculateHiddenNames(const CodeCompletionContext &Context,
1963  CodeCompletionResult *Results,
1964  unsigned NumResults,
1965  ASTContext &Ctx,
1966  llvm::StringSet<llvm::BumpPtrAllocator> &HiddenNames){
1967  bool OnlyTagNames = false;
1968  switch (Context.getKind()) {
1987  break;
1988 
1992  OnlyTagNames = true;
1993  break;
1994 
2010  // We're looking for nothing, or we're looking for names that cannot
2011  // be hidden.
2012  return;
2013  }
2014 
2015  using Result = CodeCompletionResult;
2016  for (unsigned I = 0; I != NumResults; ++I) {
2017  if (Results[I].Kind != Result::RK_Declaration)
2018  continue;
2019 
2020  unsigned IDNS
2022 
2023  bool Hiding = false;
2024  if (OnlyTagNames)
2025  Hiding = (IDNS & Decl::IDNS_Tag);
2026  else {
2027  unsigned HiddenIDNS = (Decl::IDNS_Type | Decl::IDNS_Member |
2030  if (Ctx.getLangOpts().CPlusPlus)
2031  HiddenIDNS |= Decl::IDNS_Tag;
2032  Hiding = (IDNS & HiddenIDNS);
2033  }
2034 
2035  if (!Hiding)
2036  continue;
2037 
2038  DeclarationName Name = Results[I].Declaration->getDeclName();
2040  HiddenNames.insert(Identifier->getName());
2041  else
2042  HiddenNames.insert(Name.getAsString());
2043  }
2044 }
2045 
2046 void AugmentedCodeCompleteConsumer::ProcessCodeCompleteResults(Sema &S,
2047  CodeCompletionContext Context,
2048  CodeCompletionResult *Results,
2049  unsigned NumResults) {
2050  // Merge the results we were given with the results we cached.
2051  bool AddedResult = false;
2052  uint64_t InContexts =
2054  ? NormalContexts : (1LL << Context.getKind());
2055  // Contains the set of names that are hidden by "local" completion results.
2056  llvm::StringSet<llvm::BumpPtrAllocator> HiddenNames;
2057  using Result = CodeCompletionResult;
2058  SmallVector<Result, 8> AllResults;
2060  C = AST.cached_completion_begin(),
2061  CEnd = AST.cached_completion_end();
2062  C != CEnd; ++C) {
2063  // If the context we are in matches any of the contexts we are
2064  // interested in, we'll add this result.
2065  if ((C->ShowInContexts & InContexts) == 0)
2066  continue;
2067 
2068  // If we haven't added any results previously, do so now.
2069  if (!AddedResult) {
2070  CalculateHiddenNames(Context, Results, NumResults, S.Context,
2071  HiddenNames);
2072  AllResults.insert(AllResults.end(), Results, Results + NumResults);
2073  AddedResult = true;
2074  }
2075 
2076  // Determine whether this global completion result is hidden by a local
2077  // completion result. If so, skip it.
2078  if (C->Kind != CXCursor_MacroDefinition &&
2079  HiddenNames.count(C->Completion->getTypedText()))
2080  continue;
2081 
2082  // Adjust priority based on similar type classes.
2083  unsigned Priority = C->Priority;
2084  CodeCompletionString *Completion = C->Completion;
2085  if (!Context.getPreferredType().isNull()) {
2086  if (C->Kind == CXCursor_MacroDefinition) {
2087  Priority = getMacroUsagePriority(C->Completion->getTypedText(),
2088  S.getLangOpts(),
2089  Context.getPreferredType()->isAnyPointerType());
2090  } else if (C->Type) {
2093  Context.getPreferredType().getUnqualifiedType());
2094  SimplifiedTypeClass ExpectedSTC = getSimplifiedTypeClass(Expected);
2095  if (ExpectedSTC == C->TypeClass) {
2096  // We know this type is similar; check for an exact match.
2097  llvm::StringMap<unsigned> &CachedCompletionTypes
2098  = AST.getCachedCompletionTypes();
2099  llvm::StringMap<unsigned>::iterator Pos
2100  = CachedCompletionTypes.find(QualType(Expected).getAsString());
2101  if (Pos != CachedCompletionTypes.end() && Pos->second == C->Type)
2102  Priority /= CCF_ExactTypeMatch;
2103  else
2104  Priority /= CCF_SimilarTypeMatch;
2105  }
2106  }
2107  }
2108 
2109  // Adjust the completion string, if required.
2110  if (C->Kind == CXCursor_MacroDefinition &&
2112  // Create a new code-completion string that just contains the
2113  // macro name, without its arguments.
2114  CodeCompletionBuilder Builder(getAllocator(), getCodeCompletionTUInfo(),
2115  CCP_CodePattern, C->Availability);
2116  Builder.AddTypedTextChunk(C->Completion->getTypedText());
2117  Priority = CCP_CodePattern;
2118  Completion = Builder.TakeString();
2119  }
2120 
2121  AllResults.push_back(Result(Completion, Priority, C->Kind,
2122  C->Availability));
2123  }
2124 
2125  // If we did not add any cached completion results, just forward the
2126  // results we were given to the next consumer.
2127  if (!AddedResult) {
2128  Next.ProcessCodeCompleteResults(S, Context, Results, NumResults);
2129  return;
2130  }
2131 
2132  Next.ProcessCodeCompleteResults(S, Context, AllResults.data(),
2133  AllResults.size());
2134 }
2135 
2137  StringRef File, unsigned Line, unsigned Column,
2138  ArrayRef<RemappedFile> RemappedFiles, bool IncludeMacros,
2139  bool IncludeCodePatterns, bool IncludeBriefComments,
2140  CodeCompleteConsumer &Consumer,
2141  std::shared_ptr<PCHContainerOperations> PCHContainerOps,
2142  DiagnosticsEngine &Diag, LangOptions &LangOpts, SourceManager &SourceMgr,
2143  FileManager &FileMgr, SmallVectorImpl<StoredDiagnostic> &StoredDiagnostics,
2145  if (!Invocation)
2146  return;
2147 
2148  SimpleTimer CompletionTimer(WantTiming);
2149  CompletionTimer.setOutput("Code completion @ " + File + ":" +
2150  Twine(Line) + ":" + Twine(Column));
2151 
2152  auto CCInvocation = std::make_shared<CompilerInvocation>(*Invocation);
2153 
2154  FrontendOptions &FrontendOpts = CCInvocation->getFrontendOpts();
2155  CodeCompleteOptions &CodeCompleteOpts = FrontendOpts.CodeCompleteOpts;
2156  PreprocessorOptions &PreprocessorOpts = CCInvocation->getPreprocessorOpts();
2157 
2158  CodeCompleteOpts.IncludeMacros = IncludeMacros &&
2159  CachedCompletionResults.empty();
2160  CodeCompleteOpts.IncludeCodePatterns = IncludeCodePatterns;
2161  CodeCompleteOpts.IncludeGlobals = CachedCompletionResults.empty();
2162  CodeCompleteOpts.IncludeBriefComments = IncludeBriefComments;
2163  CodeCompleteOpts.LoadExternal = Consumer.loadExternal();
2164  CodeCompleteOpts.IncludeFixIts = Consumer.includeFixIts();
2165 
2166  assert(IncludeBriefComments == this->IncludeBriefCommentsInCodeCompletion);
2167 
2168  FrontendOpts.CodeCompletionAt.FileName = File;
2169  FrontendOpts.CodeCompletionAt.Line = Line;
2170  FrontendOpts.CodeCompletionAt.Column = Column;
2171 
2172  // Set the language options appropriately.
2173  LangOpts = *CCInvocation->getLangOpts();
2174 
2175  // Spell-checking and warnings are wasteful during code-completion.
2176  LangOpts.SpellChecking = false;
2177  CCInvocation->getDiagnosticOpts().IgnoreWarnings = true;
2178 
2179  std::unique_ptr<CompilerInstance> Clang(
2180  new CompilerInstance(PCHContainerOps));
2181 
2182  // Recover resources if we crash before exiting this method.
2183  llvm::CrashRecoveryContextCleanupRegistrar<CompilerInstance>
2184  CICleanup(Clang.get());
2185 
2186  auto &Inv = *CCInvocation;
2187  Clang->setInvocation(std::move(CCInvocation));
2188  OriginalSourceFile = Clang->getFrontendOpts().Inputs[0].getFile();
2189 
2190  // Set up diagnostics, capturing any diagnostics produced.
2191  Clang->setDiagnostics(&Diag);
2192  CaptureDroppedDiagnostics Capture(CaptureDiagsKind::All,
2193  Clang->getDiagnostics(),
2194  &StoredDiagnostics, nullptr);
2195  ProcessWarningOptions(Diag, Inv.getDiagnosticOpts());
2196 
2197  // Create the target instance.
2198  Clang->setTarget(TargetInfo::CreateTargetInfo(
2199  Clang->getDiagnostics(), Clang->getInvocation().TargetOpts));
2200  if (!Clang->hasTarget()) {
2201  Clang->setInvocation(nullptr);
2202  return;
2203  }
2204 
2205  // Inform the target of the language options.
2206  //
2207  // FIXME: We shouldn't need to do this, the target should be immutable once
2208  // created. This complexity should be lifted elsewhere.
2209  Clang->getTarget().adjust(Clang->getLangOpts());
2210 
2211  assert(Clang->getFrontendOpts().Inputs.size() == 1 &&
2212  "Invocation must have exactly one source file!");
2213  assert(Clang->getFrontendOpts().Inputs[0].getKind().getFormat() ==
2215  "FIXME: AST inputs not yet supported here!");
2216  assert(Clang->getFrontendOpts().Inputs[0].getKind().getLanguage() !=
2218  "IR inputs not support here!");
2219 
2220  // Use the source and file managers that we were given.
2221  Clang->setFileManager(&FileMgr);
2222  Clang->setSourceManager(&SourceMgr);
2223 
2224  // Remap files.
2225  PreprocessorOpts.clearRemappedFiles();
2226  PreprocessorOpts.RetainRemappedFileBuffers = true;
2227  for (const auto &RemappedFile : RemappedFiles) {
2228  PreprocessorOpts.addRemappedFile(RemappedFile.first, RemappedFile.second);
2229  OwnedBuffers.push_back(RemappedFile.second);
2230  }
2231 
2232  // Use the code completion consumer we were given, but adding any cached
2233  // code-completion results.
2234  AugmentedCodeCompleteConsumer *AugmentedConsumer
2235  = new AugmentedCodeCompleteConsumer(*this, Consumer, CodeCompleteOpts);
2236  Clang->setCodeCompletionConsumer(AugmentedConsumer);
2237 
2238  // If we have a precompiled preamble, try to use it. We only allow
2239  // the use of the precompiled preamble if we're if the completion
2240  // point is within the main file, after the end of the precompiled
2241  // preamble.
2242  std::unique_ptr<llvm::MemoryBuffer> OverrideMainBuffer;
2243  if (Preamble) {
2244  std::string CompleteFilePath(File);
2245 
2246  auto &VFS = FileMgr.getVirtualFileSystem();
2247  auto CompleteFileStatus = VFS.status(CompleteFilePath);
2248  if (CompleteFileStatus) {
2249  llvm::sys::fs::UniqueID CompleteFileID = CompleteFileStatus->getUniqueID();
2250 
2251  std::string MainPath(OriginalSourceFile);
2252  auto MainStatus = VFS.status(MainPath);
2253  if (MainStatus) {
2254  llvm::sys::fs::UniqueID MainID = MainStatus->getUniqueID();
2255  if (CompleteFileID == MainID && Line > 1)
2256  OverrideMainBuffer = getMainBufferWithPrecompiledPreamble(
2257  PCHContainerOps, Inv, &VFS, false, Line - 1);
2258  }
2259  }
2260  }
2261 
2262  // If the main file has been overridden due to the use of a preamble,
2263  // make that override happen and introduce the preamble.
2264  if (OverrideMainBuffer) {
2265  assert(Preamble &&
2266  "No preamble was built, but OverrideMainBuffer is not null");
2267 
2269  &FileMgr.getVirtualFileSystem();
2270  Preamble->AddImplicitPreamble(Clang->getInvocation(), VFS,
2271  OverrideMainBuffer.get());
2272  // FIXME: there is no way to update VFS if it was changed by
2273  // AddImplicitPreamble as FileMgr is accepted as a parameter by this method.
2274  // We use on-disk preambles instead and rely on FileMgr's VFS to ensure the
2275  // PCH files are always readable.
2276  OwnedBuffers.push_back(OverrideMainBuffer.release());
2277  } else {
2278  PreprocessorOpts.PrecompiledPreambleBytes.first = 0;
2279  PreprocessorOpts.PrecompiledPreambleBytes.second = false;
2280  }
2281 
2282  // Disable the preprocessing record if modules are not enabled.
2283  if (!Clang->getLangOpts().Modules)
2284  PreprocessorOpts.DetailedRecord = false;
2285 
2286  std::unique_ptr<SyntaxOnlyAction> Act;
2287  Act.reset(new SyntaxOnlyAction);
2288  if (Act->BeginSourceFile(*Clang.get(), Clang->getFrontendOpts().Inputs[0])) {
2289  if (llvm::Error Err = Act->Execute()) {
2290  consumeError(std::move(Err)); // FIXME this drops errors on the floor.
2291  }
2292  Act->EndSourceFile();
2293  }
2294 }
2295 
2296 bool ASTUnit::Save(StringRef File) {
2297  if (HadModuleLoaderFatalFailure)
2298  return true;
2299 
2300  // Write to a temporary file and later rename it to the actual file, to avoid
2301  // possible race conditions.
2302  SmallString<128> TempPath;
2303  TempPath = File;
2304  TempPath += "-%%%%%%%%";
2305  // FIXME: Can we somehow regenerate the stat cache here, or do we need to
2306  // unconditionally create a stat cache when we parse the file?
2307 
2308  if (llvm::Error Err = llvm::writeFileAtomically(
2309  TempPath, File, [this](llvm::raw_ostream &Out) {
2310  return serialize(Out) ? llvm::make_error<llvm::StringError>(
2311  "ASTUnit serialization failed",
2312  llvm::inconvertibleErrorCode())
2313  : llvm::Error::success();
2314  })) {
2315  consumeError(std::move(Err));
2316  return true;
2317  }
2318  return false;
2319 }
2320 
2321 static bool serializeUnit(ASTWriter &Writer,
2322  SmallVectorImpl<char> &Buffer,
2323  Sema &S,
2324  bool hasErrors,
2325  raw_ostream &OS) {
2326  Writer.WriteAST(S, std::string(), nullptr, "", hasErrors);
2327 
2328  // Write the generated bitstream to "Out".
2329  if (!Buffer.empty())
2330  OS.write(Buffer.data(), Buffer.size());
2331 
2332  return false;
2333 }
2334 
2335 bool ASTUnit::serialize(raw_ostream &OS) {
2336  // For serialization we are lenient if the errors were only warn-as-error kind.
2337  bool hasErrors = getDiagnostics().hasUncompilableErrorOccurred();
2338 
2339  if (WriterData)
2340  return serializeUnit(WriterData->Writer, WriterData->Buffer,
2341  getSema(), hasErrors, OS);
2342 
2343  SmallString<128> Buffer;
2344  llvm::BitstreamWriter Stream(Buffer);
2345  InMemoryModuleCache ModuleCache;
2346  ASTWriter Writer(Stream, Buffer, ModuleCache, {});
2347  return serializeUnit(Writer, Buffer, getSema(), hasErrors, OS);
2348 }
2349 
2351 
2352 void ASTUnit::TranslateStoredDiagnostics(
2353  FileManager &FileMgr,
2354  SourceManager &SrcMgr,
2357  // Map the standalone diagnostic into the new source manager. We also need to
2358  // remap all the locations to the new view. This includes the diag location,
2359  // any associated source ranges, and the source ranges of associated fix-its.
2360  // FIXME: There should be a cleaner way to do this.
2362  Result.reserve(Diags.size());
2363 
2364  for (const auto &SD : Diags) {
2365  // Rebuild the StoredDiagnostic.
2366  if (SD.Filename.empty())
2367  continue;
2368  auto FE = FileMgr.getFile(SD.Filename);
2369  if (!FE)
2370  continue;
2371  SourceLocation FileLoc;
2372  auto ItFileID = PreambleSrcLocCache.find(SD.Filename);
2373  if (ItFileID == PreambleSrcLocCache.end()) {
2374  FileID FID = SrcMgr.translateFile(*FE);
2375  FileLoc = SrcMgr.getLocForStartOfFile(FID);
2376  PreambleSrcLocCache[SD.Filename] = FileLoc;
2377  } else {
2378  FileLoc = ItFileID->getValue();
2379  }
2380 
2381  if (FileLoc.isInvalid())
2382  continue;
2383  SourceLocation L = FileLoc.getLocWithOffset(SD.LocOffset);
2384  FullSourceLoc Loc(L, SrcMgr);
2385 
2387  Ranges.reserve(SD.Ranges.size());
2388  for (const auto &Range : SD.Ranges) {
2389  SourceLocation BL = FileLoc.getLocWithOffset(Range.first);
2390  SourceLocation EL = FileLoc.getLocWithOffset(Range.second);
2391  Ranges.push_back(CharSourceRange::getCharRange(BL, EL));
2392  }
2393 
2395  FixIts.reserve(SD.FixIts.size());
2396  for (const auto &FixIt : SD.FixIts) {
2397  FixIts.push_back(FixItHint());
2398  FixItHint &FH = FixIts.back();
2399  FH.CodeToInsert = FixIt.CodeToInsert;
2400  SourceLocation BL = FileLoc.getLocWithOffset(FixIt.RemoveRange.first);
2401  SourceLocation EL = FileLoc.getLocWithOffset(FixIt.RemoveRange.second);
2403  }
2404 
2405  Result.push_back(StoredDiagnostic(SD.Level, SD.ID,
2406  SD.Message, Loc, Ranges, FixIts));
2407  }
2408  Result.swap(Out);
2409 }
2410 
2412  assert(D);
2413 
2414  // We only care about local declarations.
2415  if (D->isFromASTFile())
2416  return;
2417 
2418  SourceManager &SM = *SourceMgr;
2419  SourceLocation Loc = D->getLocation();
2420  if (Loc.isInvalid() || !SM.isLocalSourceLocation(Loc))
2421  return;
2422 
2423  // We only keep track of the file-level declarations of each file.
2424  if (!D->getLexicalDeclContext()->isFileContext())
2425  return;
2426 
2427  SourceLocation FileLoc = SM.getFileLoc(Loc);
2428  assert(SM.isLocalSourceLocation(FileLoc));
2429  FileID FID;
2430  unsigned Offset;
2431  std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
2432  if (FID.isInvalid())
2433  return;
2434 
2435  LocDeclsTy *&Decls = FileDecls[FID];
2436  if (!Decls)
2437  Decls = new LocDeclsTy();
2438 
2439  std::pair<unsigned, Decl *> LocDecl(Offset, D);
2440 
2441  if (Decls->empty() || Decls->back().first <= Offset) {
2442  Decls->push_back(LocDecl);
2443  return;
2444  }
2445 
2446  LocDeclsTy::iterator I =
2447  llvm::upper_bound(*Decls, LocDecl, llvm::less_first());
2448 
2449  Decls->insert(I, LocDecl);
2450 }
2451 
2452 void ASTUnit::findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
2453  SmallVectorImpl<Decl *> &Decls) {
2454  if (File.isInvalid())
2455  return;
2456 
2457  if (SourceMgr->isLoadedFileID(File)) {
2458  assert(Ctx->getExternalSource() && "No external source!");
2459  return Ctx->getExternalSource()->FindFileRegionDecls(File, Offset, Length,
2460  Decls);
2461  }
2462 
2463  FileDeclsTy::iterator I = FileDecls.find(File);
2464  if (I == FileDecls.end())
2465  return;
2466 
2467  LocDeclsTy &LocDecls = *I->second;
2468  if (LocDecls.empty())
2469  return;
2470 
2471  LocDeclsTy::iterator BeginIt =
2472  llvm::partition_point(LocDecls, [=](std::pair<unsigned, Decl *> LD) {
2473  return LD.first < Offset;
2474  });
2475  if (BeginIt != LocDecls.begin())
2476  --BeginIt;
2477 
2478  // If we are pointing at a top-level decl inside an objc container, we need
2479  // to backtrack until we find it otherwise we will fail to report that the
2480  // region overlaps with an objc container.
2481  while (BeginIt != LocDecls.begin() &&
2482  BeginIt->second->isTopLevelDeclInObjCContainer())
2483  --BeginIt;
2484 
2485  LocDeclsTy::iterator EndIt = llvm::upper_bound(
2486  LocDecls, std::make_pair(Offset + Length, (Decl *)nullptr),
2487  llvm::less_first());
2488  if (EndIt != LocDecls.end())
2489  ++EndIt;
2490 
2491  for (LocDeclsTy::iterator DIt = BeginIt; DIt != EndIt; ++DIt)
2492  Decls.push_back(DIt->second);
2493 }
2494 
2496  unsigned Line, unsigned Col) const {
2497  const SourceManager &SM = getSourceManager();
2498  SourceLocation Loc = SM.translateFileLineCol(File, Line, Col);
2499  return SM.getMacroArgExpandedLocation(Loc);
2500 }
2501 
2503  unsigned Offset) const {
2504  const SourceManager &SM = getSourceManager();
2505  SourceLocation FileLoc = SM.translateFileLineCol(File, 1, 1);
2506  return SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Offset));
2507 }
2508 
2509 /// If \arg Loc is a loaded location from the preamble, returns
2510 /// the corresponding local location of the main file, otherwise it returns
2511 /// \arg Loc.
2513  FileID PreambleID;
2514  if (SourceMgr)
2515  PreambleID = SourceMgr->getPreambleFileID();
2516 
2517  if (Loc.isInvalid() || !Preamble || PreambleID.isInvalid())
2518  return Loc;
2519 
2520  unsigned Offs;
2521  if (SourceMgr->isInFileID(Loc, PreambleID, &Offs) && Offs < Preamble->getBounds().Size) {
2522  SourceLocation FileLoc
2523  = SourceMgr->getLocForStartOfFile(SourceMgr->getMainFileID());
2524  return FileLoc.getLocWithOffset(Offs);
2525  }
2526 
2527  return Loc;
2528 }
2529 
2530 /// If \arg Loc is a local location of the main file but inside the
2531 /// preamble chunk, returns the corresponding loaded location from the
2532 /// preamble, otherwise it returns \arg Loc.
2534  FileID PreambleID;
2535  if (SourceMgr)
2536  PreambleID = SourceMgr->getPreambleFileID();
2537 
2538  if (Loc.isInvalid() || !Preamble || PreambleID.isInvalid())
2539  return Loc;
2540 
2541  unsigned Offs;
2542  if (SourceMgr->isInFileID(Loc, SourceMgr->getMainFileID(), &Offs) &&
2543  Offs < Preamble->getBounds().Size) {
2544  SourceLocation FileLoc = SourceMgr->getLocForStartOfFile(PreambleID);
2545  return FileLoc.getLocWithOffset(Offs);
2546  }
2547 
2548  return Loc;
2549 }
2550 
2552  FileID FID;
2553  if (SourceMgr)
2554  FID = SourceMgr->getPreambleFileID();
2555 
2556  if (Loc.isInvalid() || FID.isInvalid())
2557  return false;
2558 
2559  return SourceMgr->isInFileID(Loc, FID);
2560 }
2561 
2563  FileID FID;
2564  if (SourceMgr)
2565  FID = SourceMgr->getMainFileID();
2566 
2567  if (Loc.isInvalid() || FID.isInvalid())
2568  return false;
2569 
2570  return SourceMgr->isInFileID(Loc, FID);
2571 }
2572 
2574  FileID FID;
2575  if (SourceMgr)
2576  FID = SourceMgr->getPreambleFileID();
2577 
2578  if (FID.isInvalid())
2579  return {};
2580 
2581  return SourceMgr->getLocForEndOfFile(FID);
2582 }
2583 
2585  FileID FID;
2586  if (SourceMgr)
2587  FID = SourceMgr->getMainFileID();
2588 
2589  if (FID.isInvalid())
2590  return {};
2591 
2592  return SourceMgr->getLocForStartOfFile(FID);
2593 }
2594 
2595 llvm::iterator_range<PreprocessingRecord::iterator>
2597  if (isMainFileAST()) {
2599  Mod = Reader->getModuleManager().getPrimaryModule();
2600  return Reader->getModulePreprocessedEntities(Mod);
2601  }
2602 
2603  if (PreprocessingRecord *PPRec = PP->getPreprocessingRecord())
2604  return llvm::make_range(PPRec->local_begin(), PPRec->local_end());
2605 
2606  return llvm::make_range(PreprocessingRecord::iterator(),
2608 }
2609 
2611  if (isMainFileAST()) {
2613  Mod = Reader->getModuleManager().getPrimaryModule();
2614  for (const auto *D : Reader->getModuleFileLevelDecls(Mod)) {
2615  if (!Fn(context, D))
2616  return false;
2617  }
2618 
2619  return true;
2620  }
2621 
2623  TLEnd = top_level_end();
2624  TL != TLEnd; ++TL) {
2625  if (!Fn(context, *TL))
2626  return false;
2627  }
2628 
2629  return true;
2630 }
2631 
2633  if (!Reader)
2634  return nullptr;
2635 
2636  serialization::ModuleFile *Mod = nullptr;
2637  Reader->getModuleManager().visit([&Mod](serialization::ModuleFile &M) {
2638  switch (M.Kind) {
2639  case serialization::MK_ImplicitModule:
2640  case serialization::MK_ExplicitModule:
2641  case serialization::MK_PrebuiltModule:
2642  return true; // skip dependencies.
2643  case serialization::MK_PCH:
2644  Mod = &M;
2645  return true; // found it.
2646  case serialization::MK_Preamble:
2647  return false; // look in dependencies.
2648  case serialization::MK_MainFile:
2649  return false; // look in dependencies.
2650  }
2651 
2652  return true;
2653  });
2654  if (Mod)
2655  return Mod->File;
2656 
2657  return nullptr;
2658 }
2659 
2662 }
2663 
2665  auto &LangOpts = getLangOpts();
2666 
2667  Language Lang;
2668  if (LangOpts.OpenCL)
2669  Lang = Language::OpenCL;
2670  else if (LangOpts.CUDA)
2671  Lang = Language::CUDA;
2672  else if (LangOpts.RenderScript)
2673  Lang = Language::RenderScript;
2674  else if (LangOpts.CPlusPlus)
2675  Lang = LangOpts.ObjC ? Language::ObjCXX : Language::CXX;
2676  else
2677  Lang = LangOpts.ObjC ? Language::ObjC : Language::C;
2678 
2680  if (LangOpts.getCompilingModule() == LangOptions::CMK_ModuleMap)
2681  Fmt = InputKind::ModuleMap;
2682 
2683  // We don't know if input was preprocessed. Assume not.
2684  bool PP = false;
2685 
2686  return InputKind(Lang, Fmt, PP);
2687 }
2688 
2689 #ifndef NDEBUG
2690 ASTUnit::ConcurrencyState::ConcurrencyState() {
2691  Mutex = new std::recursive_mutex;
2692 }
2693 
2694 ASTUnit::ConcurrencyState::~ConcurrencyState() {
2695  delete static_cast<std::recursive_mutex *>(Mutex);
2696 }
2697 
2698 void ASTUnit::ConcurrencyState::start() {
2699  bool acquired = static_cast<std::recursive_mutex *>(Mutex)->try_lock();
2700  assert(acquired && "Concurrent access to ASTUnit!");
2701 }
2702 
2703 void ASTUnit::ConcurrencyState::finish() {
2704  static_cast<std::recursive_mutex *>(Mutex)->unlock();
2705 }
2706 
2707 #else // NDEBUG
2708 
2709 ASTUnit::ConcurrencyState::ConcurrencyState() { Mutex = nullptr; }
2710 ASTUnit::ConcurrencyState::~ConcurrencyState() {}
2711 void ASTUnit::ConcurrencyState::start() {}
2712 void ASTUnit::ConcurrencyState::finish() {}
2713 
2714 #endif // NDEBUG
An unknown context, in which we are recovering from a parsing error and don&#39;t know which completions ...
SourceLocation getLocForStartOfFile(FileID FID) const
Return the source location corresponding to the first byte of the specified file. ...
Defines the clang::ASTContext interface.
Describes the bounds (start, size) of the preamble and a flag required by PreprocessorOptions::Precom...
Definition: Lexer.h:58
unsigned getID() const
Definition: Diagnostic.h:1459
void ResetForParse()
Free data that will be re-generated on the next parse.
Definition: ASTUnit.cpp:1883
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
CompilerInvocation & getInvocation()
StringRef Identifier
Definition: Format.cpp:1815
SourceLocation getLocWithOffset(int Offset) const
Return a source location with the specified offset from this SourceLocation.
DiagnosticConsumer * getClient()
Definition: Diagnostic.h:510
A (possibly-)qualified type.
Definition: Type.h:643
virtual Decl * GetExternalDecl(uint32_t ID)
Resolve a declaration ID into a declaration, potentially building a new declaration.
static std::unique_ptr< T > valueOrNull(llvm::ErrorOr< std::unique_ptr< T >> Val)
Definition: ASTUnit.cpp:141
unsigned IncludeBriefComments
Show brief documentation comments in code completion results.
bool RemappedFilesKeepOriginalName
True if the SourceManager should report the original file name for contents of files that were remapp...
Implements support for file system lookup, file system caching, and directory search management...
Definition: FileManager.h:171
const LangOptions & getLangOpts() const
Definition: ASTUnit.h:461
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:33
std::pair< unsigned, unsigned > InsertFromRange
Definition: ASTUnit.h:93
void addTopLevelDecl(Decl *D)
Add a new top-level declaration.
Definition: ASTUnit.h:527
Defines the clang::FileManager interface and associated types.
Code completion for a selector, as in an @selector expression.
void EndSourceFile()
Perform any per-file post processing, deallocate per-file objects, and run statistics and output file...
Code completion occurred where an existing name(such as type, function or variable) is expected...
unsigned IncludeGlobals
Show top-level decls in code completion results.
unsigned getMacroUsagePriority(StringRef MacroName, const LangOptions &LangOpts, bool PreferredTypeIsPointer=false)
Determine the priority to be given to a macro code completion result with the given name...
Code completion where an Objective-C class message is expected.
C Language Family Type Representation.
Defines the SourceManager interface.
Code completion within a type-qualifier list.
Load everything, including Sema.
Definition: ASTUnit.h:678
Abstract base class for actions which can be performed by the frontend.
Defines the clang::Module class, which describes a module in the source code.
bool isLocalSourceLocation(SourceLocation Loc) const
Returns true if Loc did not come from a PCH/Module.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:88
ModuleKind Kind
The type of this module.
Definition: Module.h:119
const FileManager & getFileManager() const
Definition: ASTUnit.h:476
Defines the C++ template declaration subclasses.
const unsigned DefaultPreambleRebuildInterval
After failing to build a precompiled preamble (due to errors in the source that occurs in the preambl...
Definition: ASTUnit.cpp:234
Represents a diagnostic in a form that can be retained until its corresponding source manager is dest...
Definition: Diagnostic.h:1438
StringRef getASTFileName() const
If this ASTUnit came from an AST file, returns the filename for it.
Definition: ASTUnit.cpp:1482
std::string CodeToInsert
The actual code to insert at the insertion location, as a string.
Definition: Diagnostic.h:78
An unspecified code-completion context.
static std::unique_ptr< ASTUnit > create(std::shared_ptr< CompilerInvocation > CI, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, CaptureDiagsKind CaptureDiagnostics, bool UserFilesAreVolatile)
Create a ASTUnit. Gets ownership of the passed CompilerInvocation.
Definition: ASTUnit.cpp:1492
bool isCompilingModule() const
Are we compiling a module interface (.cppm or module map)?
Definition: LangOptions.h:279
std::shared_ptr< LangOptions > LangOpts
Options controlling the language variant.
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
Format
The input file format.
bool loadExternal() const
Hint whether to load data from the external AST in order to provide full results. ...
std::unique_ptr< DiagnosticConsumer > takeClient()
Return the current diagnostic client along with ownership of that client.
Definition: Diagnostic.h:518
unsigned getIdentifierNamespace() const
Definition: DeclBase.h:799
Code completion occurred where an Objective-C message receiver is expected.
ASTContext & getASTContext() const
The AST file has errors.
Definition: ASTReader.h:403
Code completion occurred on the right-hand side of a member access expression using the arrow operato...
Code completion occurred after the "enum" keyword, to indicate an enumeration name.
void setSourceManager(SourceManager *Value)
setSourceManager - Replace the current source manager.
virtual void EndSourceFile()
Callback to inform the diagnostic client that processing of a source file has ended.
Definition: Diagnostic.h:1521
Options for controlling the target.
Definition: TargetOptions.h:26
SourceLocation mapLocationToPreamble(SourceLocation Loc) const
If Loc is a local location of the main file but inside the preamble chunk, returns the corresponding ...
Definition: ASTUnit.cpp:2533
void addRemappedFile(StringRef From, StringRef To)
Abstract interface, implemented by clients of the front-end, which formats and prints fully processed...
Definition: Diagnostic.h:1489
NamedDecl * getUnderlyingDecl()
Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl.
Definition: Decl.h:439
static void checkAndSanitizeDiags(SmallVectorImpl< StoredDiagnostic > &StoredDiagnostics, SourceManager &SM)
Definition: ASTUnit.cpp:1078
Code completion occurred within the instance variable list of an Objective-C interface, implementation, or category implementation.
void AddTypedTextChunk(const char *Text)
Add a new typed-text chunk.
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:37
bool hasSourceManager() const
Definition: Diagnostic.h:1329
This interface provides a way to observe the actions of the preprocessor as it does its thing...
Definition: PPCallbacks.h:35
Parse and apply any fixits to the source.
Code completion occurred where both a new name and an existing symbol is permissible.
Types, declared with &#39;struct foo&#39;, typedefs, etc.
Definition: DeclBase.h:132
std::vector< std::pair< unsigned, unsigned > > Ranges
Definition: ASTUnit.h:104
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition: Decl.h:297
One of these records is kept for each identifier that is lexed.
CodeCompletionString * TakeString()
Take the resulting completion string.
cached_completion_iterator cached_completion_end()
Definition: ASTUnit.h:620
void setClient(DiagnosticConsumer *client, bool ShouldOwnClient=true)
Set the diagnostic client associated with this diagnostic object.
Definition: Diagnostic.cpp:99
SourceLocation getBegin() const
Iteration over the preprocessed entities.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:160
Utility class for loading a ASTContext from an AST file.
Definition: ASTUnit.h:89
bool BeginSourceFile(CompilerInstance &CI, const FrontendInputFile &Input)
Prepare the action for processing the input file Input.
SkipFunctionBodiesScope
Enumerates the available scopes for skipping function bodies.
Definition: ASTUnit.h:83
const llvm::MemoryBuffer * getBuffer() const
A "string" used to describe how code completion can be performed for an entity.
static std::atomic< unsigned > ActiveASTUnitObjects
Tracks the number of ASTUnit objects that are currently active.
Definition: ASTUnit.cpp:239
SourceLocation translateFileLineCol(const FileEntry *SourceFile, unsigned Line, unsigned Col) const
Get the source location for the given file:line:col triplet.
static bool moveOnNoError(llvm::ErrorOr< T > Val, T &Output)
Definition: ASTUnit.cpp:148
Kind getKind() const
Retrieve the kind of code-completion context.
Token - This structure provides full information about a lexed token.
Definition: Token.h:34
bool isInPreambleFileID(SourceLocation Loc) const
Definition: ASTUnit.cpp:2551
std::unique_ptr< llvm::MemoryBuffer > getBufferForFile(StringRef Filename, std::string *ErrorStr=nullptr)
Definition: ASTUnit.cpp:735
void setPrintingPolicy(const clang::PrintingPolicy &Policy)
Definition: ASTContext.h:674
std::shared_ptr< Preprocessor > getPreprocessorPtr()
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
Compiling a module from a module map.
Definition: LangOptions.h:78
Describes a module or submodule.
Definition: Module.h:64
StringRef getMainFileName() const
Definition: ASTUnit.cpp:1464
unsigned IncludeCodePatterns
Show code patterns in code completion results.
An allocator used specifically for the purpose of code completion.
DiagnosticsEngine::Level Level
Definition: ASTUnit.h:100
bool isInvalid() const
Load the AST, but do not restore Sema state.
Definition: ASTUnit.h:675
FileID translateFile(const FileEntry *SourceFile) const
Get the FileID for the given file.
void setPreprocessor(std::shared_ptr< Preprocessor > pp)
Definition: ASTUnit.cpp:274
A record of the steps taken while preprocessing a source file, including the various preprocessing di...
Namespaces, declared with &#39;namespace foo {}&#39;.
Definition: DeclBase.h:142
static std::unique_ptr< ASTUnit > LoadFromASTFile(const std::string &Filename, const PCHContainerReader &PCHContainerRdr, WhatToLoad ToLoad, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, const FileSystemOptions &FileSystemOpts, bool UseDebugInfo=false, bool OnlyLocalDecls=false, ArrayRef< RemappedFile > RemappedFiles=None, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, bool AllowPCHWithCompilerErrors=false, bool UserFilesAreVolatile=false)
Create a ASTUnit from an AST file.
Definition: ASTUnit.cpp:756
const SourceLocation & getLocation() const
Definition: Diagnostic.h:1328
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
void Initialize(const TargetInfo &Target, const TargetInfo *AuxTarget=nullptr)
Initialize the preprocessor using information about the target.
const FileEntry * getPCHFile()
Get the PCH file if one was included.
Definition: ASTUnit.cpp:2632
Code completion occurred where a preprocessor directive is expected.
bool serialize(raw_ostream &OS)
Serialize this translation unit with the given output stream.
Definition: ASTUnit.cpp:2335
CaptureDiagsKind
Enumerates the available kinds for capturing diagnostics.
Definition: ASTUnit.h:86
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:149
std::string ResourceDir
The directory which holds the compiler resource files (builtin includes, etc.).
virtual CodeCompletionTUInfo & getCodeCompletionTUInfo()=0
Code completion occurred within an Objective-C implementation or category implementation.
ArrayRef< CharSourceRange > getRanges() const
Definition: Diagnostic.h:1472
Defines the Diagnostic-related interfaces.
bool RetainRemappedFileBuffers
Whether the compiler instance should retain (i.e., not free) the buffers associated with remapped fil...
unsigned SkipFunctionBodies
Skip over function bodies to speed up parsing in cases you do not need them (e.g. ...
void addFileLevelDecl(Decl *D)
Add a new local file-level declaration.
Definition: ASTUnit.cpp:2411
QualType getDeclUsageType(ASTContext &C, const NamedDecl *ND)
Determine the type that this declaration will have if it is used as a type or in an expression...
Code completion occurred where a namespace or namespace alias is expected.
ASTDeserializationListener * getDeserializationListener()
Definition: ASTUnit.cpp:728
DeclContext * getLexicalDeclContext()
getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC)...
Definition: DeclBase.h:828
void setFileManager(FileManager *Value)
Replace the current file manager and virtual file system.
const LangOptions & getLangOpts() const
Definition: Sema.h:1288
static bool isNonDriverDiag(const StoredDiagnostic &StoredDiag)
Definition: ASTUnit.cpp:1065
StringRef getMessage() const
Definition: Diagnostic.h:1462
void Reset()
Reset the state of the diagnostic object to its initial configuration.
Definition: Diagnostic.cpp:121
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
The AST file itself appears corrupted.
Definition: ASTReader.h:386
Ordinary names.
Definition: DeclBase.h:146
virtual void ProcessOverloadCandidates(Sema &S, unsigned CurrentArg, OverloadCandidate *Candidates, unsigned NumCandidates, SourceLocation OpenParLoc)
Languages that the frontend can parse and compile.
Language
The language for the input, used to select and validate the language standard and possible actions...
Definition: LangStandard.h:19
std::vector< std::pair< std::string, llvm::MemoryBuffer * > > RemappedFileBuffers
The set of file-to-buffer remappings, which take existing files on the system (the first part of each...
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc.
Definition: HeaderSearch.h:158
FrontendOptions & getFrontendOpts()
A set of callbacks to gather useful information while building a preamble.
bool DetailedRecord
Whether we should maintain a detailed record of all macro definitions and expansions.
Code completion where an Objective-C category name is expected.
static void checkAndRemoveNonDriverDiags(SmallVectorImpl< StoredDiagnostic > &StoredDiags)
Definition: ASTUnit.cpp:1070
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:331
Code completion occurred within a "top-level" completion context, e.g., at namespace or global scope...
static void AddDefinedMacroToHash(const Token &MacroNameTok, unsigned &Hash)
Add the given macro to the hash of all top-level entities.
Definition: ASTUnit.cpp:872
This declaration is a C++ operator declared in a non-class context.
Definition: DeclBase.h:170
StringRef Filename
Definition: Format.cpp:1807
ASTFileSignature WriteAST(Sema &SemaRef, const std::string &OutputFile, Module *WritingModule, StringRef isysroot, bool hasErrors=false, bool ShouldCacheASTInMemory=false)
Write a precompiled header for the given semantic analysis.
Definition: ASTWriter.cpp:4693
bool isModuleFile() const
Returns true if the ASTUnit was constructed from a serialized module file.
Definition: ASTUnit.cpp:2660
IntrusiveRefCntPtr< ASTReader > getModuleManager() const
unsigned Offset
Definition: Format.cpp:1809
Code completion occurred where a protocol name is expected.
Allows QualTypes to be sorted and hence used in maps and sets.
CommentOptions CommentOpts
Options for parsing comments.
Definition: LangOptions.h:252
QualType getPreferredType() const
Retrieve the type that this expression would prefer to have, e.g., if the expression is a variable in...
CodeCompletionTUInfo & getCodeCompletionTUInfo()
Definition: ASTUnit.h:316
IntrusiveRefCntPtr< ASTReader > getASTReader() const
Definition: ASTUnit.cpp:718
Defines the clang::LangOptions interface.
static ASTUnit * LoadFromCommandLine(const char **ArgBegin, const char **ArgEnd, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, StringRef ResourceFilesPath, bool OnlyLocalDecls=false, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, ArrayRef< RemappedFile > RemappedFiles=None, bool RemappedFilesKeepOriginalName=true, unsigned PrecompilePreambleAfterNParses=0, TranslationUnitKind TUKind=TU_Complete, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool AllowPCHWithCompilerErrors=false, SkipFunctionBodiesScope SkipFunctionBodies=SkipFunctionBodiesScope::None, bool SingleFileParse=false, bool UserFilesAreVolatile=false, bool ForSerialization=false, bool RetainExcludedConditionalBlocks=false, llvm::Optional< StringRef > ModuleFormat=llvm::None, std::unique_ptr< ASTUnit > *ErrAST=nullptr, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)
LoadFromCommandLine - Create an ASTUnit from a vector of command line arguments, which must specify e...
Definition: ASTUnit.cpp:1729
bool isMainFileAST() const
Definition: ASTUnit.h:424
Represents a character-granular source range.
DiagnosticsEngine::Level getLevel() const
Definition: Diagnostic.h:1460
llvm::StringRef getAsString(SyncScope S)
Definition: SyncScope.h:50
std::pair< unsigned, unsigned > RemoveRange
Definition: ASTUnit.h:92
static void AddTopLevelDeclarationToHash(Decl *D, unsigned &Hash)
Add the given declaration to the hash of all top-level entities.
Definition: ASTUnit.cpp:895
unsigned & getCurrentTopLevelHashValue()
Retrieve a reference to the current top-level name hash value.
Definition: ASTUnit.h:543
bool hasUncompilableErrorOccurred() const
Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror...
Definition: Diagnostic.h:751
const AnnotatedLine * Line
ArrayRef< FixItHint > getFixIts() const
Definition: Diagnostic.h:1482
StringRef getFile() const
std::vector< StandaloneFixIt > FixIts
Definition: ASTUnit.h:105
std::string getAsString() const
Retrieve the human-readable string for this name.
Defines the clang::Preprocessor interface.
const NamedDecl * Declaration
When Kind == RK_Declaration or RK_Pattern, the declaration we are referring to.
bool isFileContext() const
Definition: DeclBase.h:1849
comments::CommandTraits & getCommentCommandTraits() const
Definition: ASTContext.h:879
const SourceManager & getManager() const
DeclContext * getDeclContext()
Definition: DeclBase.h:438
bool isWrittenInMainFile(SourceLocation Loc) const
Returns true if the spelling location for the given location is in the main file buffer.
An abstract interface that should be implemented by listeners that want to be notified when an AST en...
Information about a module that has been loaded by the ASTReader.
Definition: Module.h:107
IdentifierInfo * getAsIdentifierInfo() const
Retrieve the IdentifierInfo * stored in this declaration name, or null if this declaration name isn&#39;t...
Captures a result of code completion.
Priority for a nested-name-specifier.
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
Code completion in a parenthesized expression, which means that we may also have types here in C and ...
std::string FileName
The file name of the module file.
Definition: Module.h:122
bool BeforePreviousInsertions
Definition: Diagnostic.h:80
Code completion occurred in a context where natural language is expected, e.g., a comment or string l...
static TargetInfo * CreateTargetInfo(DiagnosticsEngine &Diags, const std::shared_ptr< TargetOptions > &Opts)
Construct a target for the given options.
Definition: Targets.cpp:613
PreambleBounds ComputePreambleBounds(const LangOptions &LangOpts, llvm::MemoryBuffer *Buffer, unsigned MaxLines)
Runs lexer to compute suggested preamble bounds.
SmallString< 128 > Buffer
Definition: ASTUnit.cpp:218
An input file for the front end.
static ASTUnit::StandaloneFixIt makeStandaloneFixIt(const SourceManager &SM, const LangOptions &LangOpts, const FixItHint &InFix)
Definition: ASTUnit.cpp:1245
top_level_iterator top_level_begin()
Definition: ASTUnit.h:502
The result type of a method or function.
bool isNull() const
Return true if this QualType doesn&#39;t point to a type yet.
Definition: Type.h:708
const SourceManager & SM
Definition: Format.cpp:1667
The client can&#39;t handle any AST loading failures.
Definition: ASTReader.h:1513
The AST file was missing.
Definition: ASTReader.h:389
CharSourceRange InsertFromRange
Code in the specific range that should be inserted in the insertion location.
Definition: Diagnostic.h:74
unsigned getNumWarnings() const
Definition: Diagnostic.h:761
std::unique_ptr< Sema > takeSema()
static CharSourceRange getCharRange(SourceRange R)
The context in which code completion occurred, so that the code-completion consumer can process the r...
bool AllowPCHWithCompilerErrors
When true, a PCH with compiler errors will not be rejected.
In-memory cache for modules.
CharSourceRange RemoveRange
Code that should be replaced to correct the error.
Definition: Diagnostic.h:70
unsigned getFileOffset(SourceLocation SpellingLoc) const
Returns the offset from the start of the file that the specified SourceLocation represents.
Abstract interface for external sources of AST nodes.
static void CalculateHiddenNames(const CodeCompletionContext &Context, CodeCompletionResult *Results, unsigned NumResults, ASTContext &Ctx, llvm::StringSet< llvm::BumpPtrAllocator > &HiddenNames)
Helper function that computes which global names are hidden by the local code-completion results...
Definition: ASTUnit.cpp:1962
StringRef getFilename(SourceLocation SpellingLoc) const
Return the filename of the file containing a SourceLocation.
The control block was read successfully.
Definition: ASTReader.h:383
std::pair< std::string, llvm::MemoryBuffer * > RemappedFile
A mapping from a file name to the memory buffer that stores the remapped contents of that file...
Definition: ASTUnit.h:662
Code completion occurred within a class, struct, or union.
Encapsulates changes to the "macros namespace" (the location where the macro name became active...
Definition: MacroInfo.h:290
#define false
Definition: stdbool.h:17
Kind
SourceLocation mapLocationFromPreamble(SourceLocation Loc) const
If Loc is a loaded location from the preamble, returns the corresponding local location of the main f...
Definition: ASTUnit.cpp:2512
OverloadCandidate - A single candidate in an overload set (C++ 13.3).
Definition: Overload.h:763
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
Encodes a location in the source.
Code completion occurred where a new name is expected.
bool isInMainFileID(SourceLocation Loc) const
Definition: ASTUnit.cpp:2562
Members, declared with object declarations within tag definitions.
Definition: DeclBase.h:138
FileSystemOptions & getFileSystemOpts()
Returns the current file system options.
Definition: FileManager.h:352
ParsedSourceLocation CodeCompletionAt
If given, enable code completion at the provided location.
virtual TranslationUnitKind getTranslationUnitKind()
For AST-based actions, the kind of translation unit we&#39;re handling.
llvm::StringMap< unsigned > & getCachedCompletionTypes()
Retrieve the mapping from formatted type names to unique type identifiers.
Definition: ASTUnit.h:306
std::vector< FrontendInputFile > Inputs
The input files and their types.
Sema & getSema() const
Definition: ASTUnit.h:456
void CodeComplete(StringRef File, unsigned Line, unsigned Column, ArrayRef< RemappedFile > RemappedFiles, bool IncludeMacros, bool IncludeCodePatterns, bool IncludeBriefComments, CodeCompleteConsumer &Consumer, std::shared_ptr< PCHContainerOperations > PCHContainerOps, DiagnosticsEngine &Diag, LangOptions &LangOpts, SourceManager &SourceMgr, FileManager &FileMgr, SmallVectorImpl< StoredDiagnostic > &StoredDiagnostics, SmallVectorImpl< const llvm::MemoryBuffer *> &OwnedBuffers)
Perform code completion at the given file, line, and column within this translation unit...
Definition: ASTUnit.cpp:2136
IdentifierInfo * getIdentifierInfo() const
Definition: Token.h:179
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:78
The kind of a file that we&#39;ve been handed as an input.
Code completion where the name of an Objective-C class is expected.
std::vector< CachedCodeCompletionResult >::iterator cached_completion_iterator
Definition: ASTUnit.h:614
void ProcessWarningOptions(DiagnosticsEngine &Diags, const DiagnosticOptions &Opts, bool ReportDiags=true)
ProcessWarningOptions - Initialize the diagnostic client and process the warning options specified on...
Definition: Warnings.cpp:43
Abstract base class to use for AST consumer-based frontend actions.
SourceLocation getFileLoc(SourceLocation Loc) const
Given Loc, if it is a macro location return the expansion location or the spelling location...
Code completion occurred within an Objective-C interface, protocol, or category interface.
Defines the clang::TargetOptions class.
DiagnosticOptions & getDiagnosticOpts() const
static std::pair< unsigned, unsigned > makeStandaloneRange(CharSourceRange Range, const SourceManager &SM, const LangOptions &LangOpts)
Definition: ASTUnit.cpp:1237
bool isAnyPointerType() const
Definition: Type.h:6395
bool isFromASTFile() const
Determine whether this declaration came from an AST file (such as a precompiled header or module) rat...
Definition: DeclBase.h:702
Divide by this factor when a code-completion result&#39;s type exactly matches the type we expect...
virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info)
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
Definition: Diagnostic.cpp:531
void setListener(std::unique_ptr< ASTReaderListener > Listener)
Set the AST callbacks listener.
Definition: ASTReader.h:1580
void InitBuiltinTypes(const TargetInfo &Target, const TargetInfo *AuxTarget=nullptr)
Initialize built-in types.
SourceManager & getSourceManager() const
Definition: Diagnostic.h:1330
SimplifiedTypeClass getSimplifiedTypeClass(CanQualType T)
Determine the simplified type class of the given canonical type.
llvm::BitstreamWriter Stream
Definition: ASTUnit.cpp:219
Divide by this factor when a code-completion result&#39;s type is similar to the type we expect (e...
TranslationUnitKind getTranslationUnitKind() const
Determine what kind of translation unit this AST represents.
Definition: ASTUnit.h:655
void setNumWarnings(unsigned NumWarnings)
Definition: Diagnostic.h:763
The AST file was writtten with a different language/target configuration.
Definition: ASTReader.h:400
bool visitLocalTopLevelDecls(void *context, DeclVisitorFn Fn)
Iterate over local declarations (locally parsed if this is a parsed source file or the loaded declara...
Definition: ASTUnit.cpp:2610
File is a PCH file treated as the actual main file.
Definition: Module.h:56
void registerCommentOptions(const CommentOptions &CommentOptions)
StringRef getName() const
Return the actual identifier string.
std::unique_ptr< CompilerInvocation > createInvocationFromCommandLine(ArrayRef< const char *> Args, IntrusiveRefCntPtr< DiagnosticsEngine > Diags=IntrusiveRefCntPtr< DiagnosticsEngine >(), IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr, bool ShouldRecoverOnErrors=false)
createInvocationFromCommandLine - Construct a compiler invocation object for a command line argument ...
Abstract interface for a consumer of code-completion information.
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Options controlling the behavior of code completion.
static ASTUnit::StandaloneDiagnostic makeStandaloneDiagnostic(const LangOptions &LangOpts, const StoredDiagnostic &InDiag)
Definition: ASTUnit.cpp:1258
Dataflow Directional Tag Classes.
virtual llvm::StringRef getFormat() const =0
Equivalent to the format passed to -fmodule-format=.
bool isValid() const
Return true if this is a valid SourceLocation object.
static std::unique_ptr< llvm::MemoryBuffer > getBufferForFileHandlingRemapping(const CompilerInvocation &Invocation, llvm::vfs::FileSystem *VFS, StringRef FilePath, bool isVolatile)
Get a source buffer for MainFilePath, handling all file-to-file and file-to-buffer remappings inside ...
Definition: ASTUnit.cpp:158
Code completion occurred where an macro is being defined.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1271
static uint64_t getDeclShowContexts(const NamedDecl *ND, const LangOptions &LangOpts, bool &IsNestedNameSpecifier)
Determine the set of code-completion contexts in which this declaration should be shown...
Definition: ASTUnit.cpp:286
PreprocessorOptions & getPreprocessorOpts()
static CharSourceRange makeFileCharRange(CharSourceRange Range, const SourceManager &SM, const LangOptions &LangOpts)
Accepts a range and returns a character range with file locations.
Definition: Lexer.cpp:875
llvm::Error Execute()
Set the source manager&#39;s main input file, and run the action.
Code completion occurred after the "struct" or "class" keyword, to indicate a struct or class name...
llvm::iterator_range< PreprocessingRecord::iterator > getLocalPreprocessingEntities() const
Returns an iterator range for the local preprocessing entities of the local Preprocessor, if this is a parsed source file, or the loaded preprocessing entities of the primary module if this is an AST file.
Definition: ASTUnit.cpp:2596
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:354
IntrusiveRefCntPtr< llvm::vfs::FileSystem > createVFSFromCompilerInvocation(const CompilerInvocation &CI, DiagnosticsEngine &Diags)
const FullSourceLoc & getLocation() const
Definition: Diagnostic.h:1461
Code completion occurred after the "union" keyword, to indicate a union name.
Code completion occurred where a macro name is expected (without any arguments, in the case of a func...
bool(*)(void *context, const Decl *D) DeclVisitorFn
Type for a function iterating over a number of declarations.
Definition: ASTUnit.h:636
bool includeFixIts() const
Whether to include completion items with small fix-its, e.g.
A builder class used to construct new code-completion strings.
Code completion where an Objective-C instance message is expected.
The name of a declaration.
ASTMutationListener * getASTMutationListener()
Definition: ASTUnit.cpp:722
static std::string getAsString(SplitQualType split, const PrintingPolicy &Policy)
Definition: Type.h:979
void enableSourceFileDiagnostics()
Enable source-range based diagnostic messages.
Definition: ASTUnit.cpp:278
bool SingleFileParseMode
When enabled, preprocessor is in a mode for parsing a single file only.
Helper class for holding the data necessary to invoke the compiler.
const HeaderSearchOptions & getHeaderSearchOpts() const
Definition: ASTUnit.h:466
static ASTUnit * LoadFromCompilerInvocationAction(std::shared_ptr< CompilerInvocation > CI, std::shared_ptr< PCHContainerOperations > PCHContainerOps, IntrusiveRefCntPtr< DiagnosticsEngine > Diags, FrontendAction *Action=nullptr, ASTUnit *Unit=nullptr, bool Persistent=true, StringRef ResourceFilesPath=StringRef(), bool OnlyLocalDecls=false, CaptureDiagsKind CaptureDiagnostics=CaptureDiagsKind::None, unsigned PrecompilePreambleAfterNParses=0, bool CacheCodeCompletionResults=false, bool IncludeBriefCommentsInCodeCompletion=false, bool UserFilesAreVolatile=false, std::unique_ptr< ASTUnit > *ErrAST=nullptr)
Create an ASTUnit from a source file, via a CompilerInvocation object, by invoking the optionally pro...
Definition: ASTUnit.cpp:1512
SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const
If Loc points inside a function macro argument, the returned location will be the macro location in w...
top_level_iterator top_level_end()
Definition: ASTUnit.h:509
A map from continuous integer ranges to some value, with a very specialized interface.
Tags, declared with &#39;struct foo;&#39; and referenced with &#39;struct foo&#39;.
Definition: DeclBase.h:127
FrontendOptions - Options for controlling the behavior of the frontend.
ExternalASTSource * getExternalSource() const
Retrieve a pointer to the external AST source associated with this AST context, if any...
Definition: ASTContext.h:1085
void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length, SmallVectorImpl< Decl *> &Decls)
Get the decls that are contained in a file in the Offset/Length range.
Definition: ASTUnit.cpp:2452
Code completion occurred where a statement (or declaration) is expected in a function, method, or block.
static llvm::ErrorOr< PrecompiledPreamble > Build(const CompilerInvocation &Invocation, const llvm::MemoryBuffer *MainFileBuffer, PreambleBounds Bounds, DiagnosticsEngine &Diagnostics, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS, std::shared_ptr< PCHContainerOperations > PCHContainerOps, bool StoreInMemory, PreambleCallbacks &Callbacks)
Try to build PrecompiledPreamble for Invocation.
Code completion occurred on the right-hand side of an Objective-C property access expression...
bool Save(StringRef File)
Save this translation unit to a file with the given name.
Definition: ASTUnit.cpp:2296
llvm::ErrorOr< const FileEntry * > getFile(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Lookup, cache, and verify the specified file (real or virtual).
bool Reparse(std::shared_ptr< PCHContainerOperations > PCHContainerOps, ArrayRef< RemappedFile > RemappedFiles=None, IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)
Reparse the source files using the same command-line options that were originally used to produce thi...
Definition: ASTUnit.cpp:1825
cached_completion_iterator cached_completion_begin()
Definition: ASTUnit.h:616
Abstract interface for callback invocations by the ASTReader.
Definition: ASTReader.h:126
SourceLocation getEndOfPreambleFileID() const
Definition: ASTUnit.cpp:2573
TargetInfo & getTarget() const
CodeCompleteOptions CodeCompleteOpts
unsigned Size
Size of the preamble in bytes.
Definition: Lexer.h:60
SourceLocation getEnd() const
ASTWriterData(InMemoryModuleCache &ModuleCache)
Definition: ASTUnit.cpp:222
const ASTContext & getASTContext() const
Definition: ASTUnit.h:439
Defines the PPCallbacks interface.
Keeps track of options that affect how file operations are performed.
Priority for a code pattern.
CanQualType getCanonicalType(QualType T) const
Return the canonical (structural) type corresponding to the specified potentially non-canonical type ...
Definition: ASTContext.h:2289
static bool serializeUnit(ASTWriter &Writer, SmallVectorImpl< char > &Buffer, Sema &S, bool hasErrors, raw_ostream &OS)
Definition: ASTUnit.cpp:2321
Preprocessor & getPreprocessor() const
Return the current preprocessor.
Code completion occurred within a preprocessor expression.
Code completion occurred where an expression is expected.
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
Defines the clang::SourceLocation class and associated facilities.
QualType getUnqualifiedType() const
Retrieve the unqualified variant of the given type, removing as little sugar as possible.
Definition: Type.h:6228
const DiagnosticsEngine & getDiagnostics() const
Definition: ASTUnit.h:429
Code completion inside the filename part of a #include directive.
virtual CodeCompletionAllocator & getAllocator()=0
Retrieve the allocator that will be used to allocate code completion strings.
DiagnosticsEngine & getDiagnostics() const
Definition: Preprocessor.h:901
static bool isInMainFile(const clang::Diagnostic &D)
Definition: ASTUnit.cpp:678
const SourceManager & getSourceManager() const
Definition: ASTUnit.h:432
An unspecified code-completion context where we should also add macro completions.
int Priority
Definition: Format.cpp:1811
unsigned IncludeFixIts
Include results after corrections (small fix-its), e.g.
Level
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:152
TranslationUnitKind
Describes the kind of translation unit being processed.
Definition: LangOptions.h:378
DeclContext * getLookupParent()
Find the parent context of this context that will be used for unqualified name lookup.
Definition: DeclBase.cpp:1040
Writes an AST file containing the contents of a translation unit.
Definition: ASTWriter.h:103
serialization::DeclID getDeclID(const Decl *D)
Determine the declaration ID of an already-emitted declaration.
Definition: ASTWriter.cpp:5706
bool hadModuleLoaderFatalFailure() const
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
Definition: Diagnostic.h:1317
std::pair< unsigned, bool > PrecompiledPreambleBytes
If non-zero, the implicit PCH include is actually a precompiled preamble that covers this number of b...
Defines the clang::TargetInfo interface.
The AST file is out-of-date relative to its input files, and needs to be regenerated.
Definition: ASTReader.h:393
A SourceLocation and its associated SourceManager.
HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSea...
The translation unit is a complete translation unit.
Definition: LangOptions.h:380
SourceLocation getStartOfMainFileID() const
Definition: ASTUnit.cpp:2584
LLVM IR: we accept this so that we can run the optimizer on it, and compile it to assembly or object ...
Defines the clang::FrontendAction interface and various convenience abstract classes (clang::ASTFront...
std::unique_ptr< ASTConsumer > takeASTConsumer()
takeASTConsumer - Remove the current AST consumer and give ownership to the caller.
unsigned LoadExternal
Hint whether to load data from the external AST to provide full results.
The AST file was written by a different version of Clang.
Definition: ASTReader.h:396
Code completion occurred on the right-hand side of a member access expression using the dot operator...
bool RetainExcludedConditionalBlocks
When enabled, excluded conditional blocks retain in the main file.
SimplifiedTypeClass
A simplified classification of types used when determining "similar" types for code completion...
Code completion occurred where a type name is expected.
Annotates a diagnostic with some code that should be inserted, removed, or replaced to fix the proble...
Definition: Diagnostic.h:66
unsigned IncludeMacros
Show macros in code completion results.
ASTContext & Context
Definition: Sema.h:377
This represents a decl that may have a name.
Definition: Decl.h:248
bool isTranslationUnit() const
Definition: DeclBase.h:1854
InputKind getInputKind() const
Determine the input kind this AST unit represents.
Definition: ASTUnit.cpp:2664
virtual void BeginSourceFile(const LangOptions &LangOpts, const Preprocessor *PP=nullptr)
Callback to inform the diagnostic client that processing of a source file is beginning.
Definition: Diagnostic.h:1513
const FileEntry * File
The file entry for the module file.
Definition: Module.h:163
const LangOptions & getLangOpts() const
Definition: ASTContext.h:723
SourceLocation getLocation(const FileEntry *File, unsigned Line, unsigned Col) const
Get the source location for the given file:line:col triplet.
Definition: ASTUnit.cpp:2495
llvm::vfs::FileSystem & getVirtualFileSystem() const
Definition: FileManager.h:355
void addPPCallbacks(std::unique_ptr< PPCallbacks > C)
Definition: Preprocessor.h:996
This class handles loading and caching of source files into memory.
SourceLocation getLocation() const
Definition: DeclBase.h:429
std::pair< FileID, unsigned > getDecomposedLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:125
std::vector< Decl * >::iterator top_level_iterator
Definition: ASTUnit.h:500