contrib/llvm/tools/clang/include/clang/Frontend/CompilerInstance.h

   1 //===-- CompilerInstance.h - Clang Compiler Instance ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_CLANG_FRONTEND_COMPILERINSTANCE_H_
  11 #define LLVM_CLANG_FRONTEND_COMPILERINSTANCE_H_
  12
  13 #include "clang/AST/ASTConsumer.h"
  14 #include "clang/Basic/Diagnostic.h"
  15 #include "clang/Basic/SourceManager.h"
  16 #include "clang/Frontend/CompilerInvocation.h"
  17 #include "clang/Frontend/PCHContainerOperations.h"
  18 #include "clang/Frontend/Utils.h"
  19 #include "clang/Lex/HeaderSearchOptions.h"
  20 #include "clang/Lex/ModuleLoader.h"
  21 #include "llvm/ADT/ArrayRef.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  24 #include "llvm/ADT/StringRef.h"
  25 #include <cassert>
  26 #include <list>
  27 #include <memory>
  28 #include <string>
  29 #include <utility>
  30
  31 namespace llvm {
  32 class raw_fd_ostream;
  33 class Timer;
  34 class TimerGroup;
  35 }
  36
  37 namespace clang {
  38 class ASTContext;
  39 class ASTReader;
  40 class CodeCompleteConsumer;
  41 class DiagnosticsEngine;
  42 class DiagnosticConsumer;
  43 class ExternalASTSource;
  44 class FileEntry;
  45 class FileManager;
  46 class FrontendAction;
  47 class MemoryBufferCache;
  48 class Module;
  49 class Preprocessor;
  50 class Sema;
  51 class SourceManager;
  52 class TargetInfo;
  53
  54 /// CompilerInstance - Helper class for managing a single instance of the Clang
  55 /// compiler.
  56 ///
  57 /// The CompilerInstance serves two purposes:
  58 ///  (1) It manages the various objects which are necessary to run the compiler,
  59 ///      for example the preprocessor, the target information, and the AST
  60 ///      context.
  61 ///  (2) It provides utility routines for constructing and manipulating the
  62 ///      common Clang objects.
  63 ///
  64 /// The compiler instance generally owns the instance of all the objects that it
  65 /// manages. However, clients can still share objects by manually setting the
  66 /// object and retaking ownership prior to destroying the CompilerInstance.
  67 ///
  68 /// The compiler instance is intended to simplify clients, but not to lock them
  69 /// in to the compiler instance for everything. When possible, utility functions
  70 /// come in two forms; a short form that reuses the CompilerInstance objects,
  71 /// and a long form that takes explicit instances of any required objects.
  72 class CompilerInstance : public ModuleLoader {
  73   /// The options used in this compiler instance.
  74   std::shared_ptr<CompilerInvocation> Invocation;
  75
  76   /// The diagnostics engine instance.
  77   IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics;
  78
  79   /// The target being compiled for.
  80   IntrusiveRefCntPtr<TargetInfo> Target;
  81
  82   /// Auxiliary Target info.
  83   IntrusiveRefCntPtr<TargetInfo> AuxTarget;
  84
  85   /// The virtual file system.
  86   IntrusiveRefCntPtr<vfs::FileSystem> VirtualFileSystem;
  87
  88   /// The file manager.
  89   IntrusiveRefCntPtr<FileManager> FileMgr;
  90
  91   /// The source manager.
  92   IntrusiveRefCntPtr<SourceManager> SourceMgr;
  93
  94   /// The cache of PCM files.
  95   IntrusiveRefCntPtr<MemoryBufferCache> PCMCache;
  96
  97   /// The preprocessor.
  98   std::shared_ptr<Preprocessor> PP;
  99
 100   /// The AST context.
 101   IntrusiveRefCntPtr<ASTContext> Context;
 102
 103   /// An optional sema source that will be attached to sema.
 104   IntrusiveRefCntPtr<ExternalSemaSource> ExternalSemaSrc;
 105
 106   /// The AST consumer.
 107   std::unique_ptr<ASTConsumer> Consumer;
 108
 109   /// The code completion consumer.
 110   std::unique_ptr<CodeCompleteConsumer> CompletionConsumer;
 111
 112   /// \brief The semantic analysis object.
 113   std::unique_ptr<Sema> TheSema;
 114
 115   /// \brief The frontend timer group.
 116   std::unique_ptr<llvm::TimerGroup> FrontendTimerGroup;
 117
 118   /// \brief The frontend timer.
 119   std::unique_ptr<llvm::Timer> FrontendTimer;
 120
 121   /// \brief The ASTReader, if one exists.
 122   IntrusiveRefCntPtr<ASTReader> ModuleManager;
 123
 124   /// \brief The module dependency collector for crashdumps
 125   std::shared_ptr<ModuleDependencyCollector> ModuleDepCollector;
 126
 127   /// \brief The module provider.
 128   std::shared_ptr<PCHContainerOperations> ThePCHContainerOperations;
 129
 130   /// \brief The dependency file generator.
 131   std::unique_ptr<DependencyFileGenerator> TheDependencyFileGenerator;
 132
 133   std::vector<std::shared_ptr<DependencyCollector>> DependencyCollectors;
 134
 135   /// \brief The set of top-level modules that has already been loaded,
 136   /// along with the module map
 137   llvm::DenseMap<const IdentifierInfo *, Module *> KnownModules;
 138
 139   /// \brief The set of top-level modules that has already been built on the
 140   /// fly as part of this overall compilation action.
 141   std::map<std::string, std::string> BuiltModules;
 142
 143   /// Should we delete the BuiltModules when we're done?
 144   bool DeleteBuiltModules = true;
 145
 146   /// \brief The location of the module-import keyword for the last module
 147   /// import.
 148   SourceLocation LastModuleImportLoc;
 149
 150   /// \brief The result of the last module import.
 151   ///
 152   ModuleLoadResult LastModuleImportResult;
 153
 154   /// \brief Whether we should (re)build the global module index once we
 155   /// have finished with this translation unit.
 156   bool BuildGlobalModuleIndex = false;
 157
 158   /// \brief We have a full global module index, with all modules.
 159   bool HaveFullGlobalModuleIndex = false;
 160
 161   /// \brief One or more modules failed to build.
 162   bool ModuleBuildFailed = false;
 163
 164   /// \brief Holds information about the output file.
 165   ///
 166   /// If TempFilename is not empty we must rename it to Filename at the end.
 167   /// TempFilename may be empty and Filename non-empty if creating the temporary
 168   /// failed.
 169   struct OutputFile {
 170     std::string Filename;
 171     std::string TempFilename;
 172
 173     OutputFile(std::string filename, std::string tempFilename)
 174         : Filename(std::move(filename)), TempFilename(std::move(tempFilename)) {
 175     }
 176   };
 177
 178   /// If the output doesn't support seeking (terminal, pipe). we switch
 179   /// the stream to a buffer_ostream. These are the buffer and the original
 180   /// stream.
 181   std::unique_ptr<llvm::raw_fd_ostream> NonSeekStream;
 182
 183   /// The list of active output files.
 184   std::list<OutputFile> OutputFiles;
 185
 186   CompilerInstance(const CompilerInstance &) = delete;
 187   void operator=(const CompilerInstance &) = delete;
 188 public:
 189   explicit CompilerInstance(
 190       std::shared_ptr<PCHContainerOperations> PCHContainerOps =
 191           std::make_shared<PCHContainerOperations>(),
 192       MemoryBufferCache *SharedPCMCache = nullptr);
 193   ~CompilerInstance() override;
 194
 195   /// @name High-Level Operations
 196   /// {
 197
 198   /// ExecuteAction - Execute the provided action against the compiler's
 199   /// CompilerInvocation object.
 200   ///
 201   /// This function makes the following assumptions:
 202   ///
 203   ///  - The invocation options should be initialized. This function does not
 204   ///    handle the '-help' or '-version' options, clients should handle those
 205   ///    directly.
 206   ///
 207   ///  - The diagnostics engine should have already been created by the client.
 208   ///
 209   ///  - No other CompilerInstance state should have been initialized (this is
 210   ///    an unchecked error).
 211   ///
 212   ///  - Clients should have initialized any LLVM target features that may be
 213   ///    required.
 214   ///
 215   ///  - Clients should eventually call llvm_shutdown() upon the completion of
 216   ///    this routine to ensure that any managed objects are properly destroyed.
 217   ///
 218   /// Note that this routine may write output to 'stderr'.
 219   ///
 220   /// \param Act - The action to execute.
 221   /// \return - True on success.
 222   //
 223   // FIXME: This function should take the stream to write any debugging /
 224   // verbose output to as an argument.
 225   //
 226   // FIXME: Eliminate the llvm_shutdown requirement, that should either be part
 227   // of the context or else not CompilerInstance specific.
 228   bool ExecuteAction(FrontendAction &Act);
 229
 230   /// }
 231   /// @name Compiler Invocation and Options
 232   /// {
 233
 234   bool hasInvocation() const { return Invocation != nullptr; }
 235
 236   CompilerInvocation &getInvocation() {
 237     assert(Invocation && "Compiler instance has no invocation!");
 238     return *Invocation;
 239   }
 240
 241   /// setInvocation - Replace the current invocation.
 242   void setInvocation(std::shared_ptr<CompilerInvocation> Value);
 243
 244   /// \brief Indicates whether we should (re)build the global module index.
 245   bool shouldBuildGlobalModuleIndex() const;
 246
 247   /// \brief Set the flag indicating whether we should (re)build the global
 248   /// module index.
 249   void setBuildGlobalModuleIndex(bool Build) {
 250     BuildGlobalModuleIndex = Build;
 251   }
 252
 253   /// }
 254   /// @name Forwarding Methods
 255   /// {
 256
 257   AnalyzerOptionsRef getAnalyzerOpts() {
 258     return Invocation->getAnalyzerOpts();
 259   }
 260
 261   CodeGenOptions &getCodeGenOpts() {
 262     return Invocation->getCodeGenOpts();
 263   }
 264   const CodeGenOptions &getCodeGenOpts() const {
 265     return Invocation->getCodeGenOpts();
 266   }
 267
 268   DependencyOutputOptions &getDependencyOutputOpts() {
 269     return Invocation->getDependencyOutputOpts();
 270   }
 271   const DependencyOutputOptions &getDependencyOutputOpts() const {
 272     return Invocation->getDependencyOutputOpts();
 273   }
 274
 275   DiagnosticOptions &getDiagnosticOpts() {
 276     return Invocation->getDiagnosticOpts();
 277   }
 278   const DiagnosticOptions &getDiagnosticOpts() const {
 279     return Invocation->getDiagnosticOpts();
 280   }
 281
 282   FileSystemOptions &getFileSystemOpts() {
 283     return Invocation->getFileSystemOpts();
 284   }
 285   const FileSystemOptions &getFileSystemOpts() const {
 286     return Invocation->getFileSystemOpts();
 287   }
 288
 289   FrontendOptions &getFrontendOpts() {
 290     return Invocation->getFrontendOpts();
 291   }
 292   const FrontendOptions &getFrontendOpts() const {
 293     return Invocation->getFrontendOpts();
 294   }
 295
 296   HeaderSearchOptions &getHeaderSearchOpts() {
 297     return Invocation->getHeaderSearchOpts();
 298   }
 299   const HeaderSearchOptions &getHeaderSearchOpts() const {
 300     return Invocation->getHeaderSearchOpts();
 301   }
 302   std::shared_ptr<HeaderSearchOptions> getHeaderSearchOptsPtr() const {
 303     return Invocation->getHeaderSearchOptsPtr();
 304   }
 305
 306   LangOptions &getLangOpts() {
 307     return *Invocation->getLangOpts();
 308   }
 309   const LangOptions &getLangOpts() const {
 310     return *Invocation->getLangOpts();
 311   }
 312
 313   PreprocessorOptions &getPreprocessorOpts() {
 314     return Invocation->getPreprocessorOpts();
 315   }
 316   const PreprocessorOptions &getPreprocessorOpts() const {
 317     return Invocation->getPreprocessorOpts();
 318   }
 319
 320   PreprocessorOutputOptions &getPreprocessorOutputOpts() {
 321     return Invocation->getPreprocessorOutputOpts();
 322   }
 323   const PreprocessorOutputOptions &getPreprocessorOutputOpts() const {
 324     return Invocation->getPreprocessorOutputOpts();
 325   }
 326
 327   TargetOptions &getTargetOpts() {
 328     return Invocation->getTargetOpts();
 329   }
 330   const TargetOptions &getTargetOpts() const {
 331     return Invocation->getTargetOpts();
 332   }
 333
 334   /// }
 335   /// @name Diagnostics Engine
 336   /// {
 337
 338   bool hasDiagnostics() const { return Diagnostics != nullptr; }
 339
 340   /// Get the current diagnostics engine.
 341   DiagnosticsEngine &getDiagnostics() const {
 342     assert(Diagnostics && "Compiler instance has no diagnostics!");
 343     return *Diagnostics;
 344   }
 345
 346   /// setDiagnostics - Replace the current diagnostics engine.
 347   void setDiagnostics(DiagnosticsEngine *Value);
 348
 349   DiagnosticConsumer &getDiagnosticClient() const {
 350     assert(Diagnostics && Diagnostics->getClient() &&
 351            "Compiler instance has no diagnostic client!");
 352     return *Diagnostics->getClient();
 353   }
 354
 355   /// }
 356   /// @name Target Info
 357   /// {
 358
 359   bool hasTarget() const { return Target != nullptr; }
 360
 361   TargetInfo &getTarget() const {
 362     assert(Target && "Compiler instance has no target!");
 363     return *Target;
 364   }
 365
 366   /// Replace the current Target.
 367   void setTarget(TargetInfo *Value);
 368
 369   /// }
 370   /// @name AuxTarget Info
 371   /// {
 372
 373   TargetInfo *getAuxTarget() const { return AuxTarget.get(); }
 374
 375   /// Replace the current AuxTarget.
 376   void setAuxTarget(TargetInfo *Value);
 377
 378   /// }
 379   /// @name Virtual File System
 380   /// {
 381
 382   bool hasVirtualFileSystem() const { return VirtualFileSystem != nullptr; }
 383
 384   vfs::FileSystem &getVirtualFileSystem() const {
 385     assert(hasVirtualFileSystem() &&
 386            "Compiler instance has no virtual file system");
 387     return *VirtualFileSystem;
 388   }
 389
 390   /// \brief Replace the current virtual file system.
 391   ///
 392   /// \note Most clients should use setFileManager, which will implicitly reset
 393   /// the virtual file system to the one contained in the file manager.
 394   void setVirtualFileSystem(IntrusiveRefCntPtr<vfs::FileSystem> FS) {
 395     VirtualFileSystem = std::move(FS);
 396   }
 397
 398   /// }
 399   /// @name File Manager
 400   /// {
 401
 402   bool hasFileManager() const { return FileMgr != nullptr; }
 403
 404   /// Return the current file manager to the caller.
 405   FileManager &getFileManager() const {
 406     assert(FileMgr && "Compiler instance has no file manager!");
 407     return *FileMgr;
 408   }
 409
 410   void resetAndLeakFileManager() {
 411     BuryPointer(FileMgr.get());
 412     FileMgr.resetWithoutRelease();
 413   }
 414
 415   /// \brief Replace the current file manager and virtual file system.
 416   void setFileManager(FileManager *Value);
 417
 418   /// }
 419   /// @name Source Manager
 420   /// {
 421
 422   bool hasSourceManager() const { return SourceMgr != nullptr; }
 423
 424   /// Return the current source manager.
 425   SourceManager &getSourceManager() const {
 426     assert(SourceMgr && "Compiler instance has no source manager!");
 427     return *SourceMgr;
 428   }
 429
 430   void resetAndLeakSourceManager() {
 431     BuryPointer(SourceMgr.get());
 432     SourceMgr.resetWithoutRelease();
 433   }
 434
 435   /// setSourceManager - Replace the current source manager.
 436   void setSourceManager(SourceManager *Value);
 437
 438   /// }
 439   /// @name Preprocessor
 440   /// {
 441
 442   bool hasPreprocessor() const { return PP != nullptr; }
 443
 444   /// Return the current preprocessor.
 445   Preprocessor &getPreprocessor() const {
 446     assert(PP && "Compiler instance has no preprocessor!");
 447     return *PP;
 448   }
 449
 450   std::shared_ptr<Preprocessor> getPreprocessorPtr() { return PP; }
 451
 452   void resetAndLeakPreprocessor() {
 453     BuryPointer(new std::shared_ptr<Preprocessor>(PP));
 454   }
 455
 456   /// Replace the current preprocessor.
 457   void setPreprocessor(std::shared_ptr<Preprocessor> Value);
 458
 459   /// }
 460   /// @name ASTContext
 461   /// {
 462
 463   bool hasASTContext() const { return Context != nullptr; }
 464
 465   ASTContext &getASTContext() const {
 466     assert(Context && "Compiler instance has no AST context!");
 467     return *Context;
 468   }
 469
 470   void resetAndLeakASTContext() {
 471     BuryPointer(Context.get());
 472     Context.resetWithoutRelease();
 473   }
 474
 475   /// setASTContext - Replace the current AST context.
 476   void setASTContext(ASTContext *Value);
 477
 478   /// \brief Replace the current Sema; the compiler instance takes ownership
 479   /// of S.
 480   void setSema(Sema *S);
 481
 482   /// }
 483   /// @name ASTConsumer
 484   /// {
 485
 486   bool hasASTConsumer() const { return (bool)Consumer; }
 487
 488   ASTConsumer &getASTConsumer() const {
 489     assert(Consumer && "Compiler instance has no AST consumer!");
 490     return *Consumer;
 491   }
 492
 493   /// takeASTConsumer - Remove the current AST consumer and give ownership to
 494   /// the caller.
 495   std::unique_ptr<ASTConsumer> takeASTConsumer() { return std::move(Consumer); }
 496
 497   /// setASTConsumer - Replace the current AST consumer; the compiler instance
 498   /// takes ownership of \p Value.
 499   void setASTConsumer(std::unique_ptr<ASTConsumer> Value);
 500
 501   /// }
 502   /// @name Semantic analysis
 503   /// {
 504   bool hasSema() const { return (bool)TheSema; }
 505
 506   Sema &getSema() const {
 507     assert(TheSema && "Compiler instance has no Sema object!");
 508     return *TheSema;
 509   }
 510
 511   std::unique_ptr<Sema> takeSema();
 512   void resetAndLeakSema();
 513
 514   /// }
 515   /// @name Module Management
 516   /// {
 517
 518   IntrusiveRefCntPtr<ASTReader> getModuleManager() const;
 519   void setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader);
 520
 521   std::shared_ptr<ModuleDependencyCollector> getModuleDepCollector() const;
 522   void setModuleDepCollector(
 523       std::shared_ptr<ModuleDependencyCollector> Collector);
 524
 525   std::shared_ptr<PCHContainerOperations> getPCHContainerOperations() const {
 526     return ThePCHContainerOperations;
 527   }
 528
 529   /// Return the appropriate PCHContainerWriter depending on the
 530   /// current CodeGenOptions.
 531   const PCHContainerWriter &getPCHContainerWriter() const {
 532     assert(Invocation && "cannot determine module format without invocation");
 533     StringRef Format = getHeaderSearchOpts().ModuleFormat;
 534     auto *Writer = ThePCHContainerOperations->getWriterOrNull(Format);
 535     if (!Writer) {
 536       if (Diagnostics)
 537         Diagnostics->Report(diag::err_module_format_unhandled) << Format;
 538       llvm::report_fatal_error("unknown module format");
 539     }
 540     return *Writer;
 541   }
 542
 543   /// Return the appropriate PCHContainerReader depending on the
 544   /// current CodeGenOptions.
 545   const PCHContainerReader &getPCHContainerReader() const {
 546     assert(Invocation && "cannot determine module format without invocation");
 547     StringRef Format = getHeaderSearchOpts().ModuleFormat;
 548     auto *Reader = ThePCHContainerOperations->getReaderOrNull(Format);
 549     if (!Reader) {
 550       if (Diagnostics)
 551         Diagnostics->Report(diag::err_module_format_unhandled) << Format;
 552       llvm::report_fatal_error("unknown module format");
 553     }
 554     return *Reader;
 555   }
 556
 557   /// }
 558   /// @name Code Completion
 559   /// {
 560
 561   bool hasCodeCompletionConsumer() const { return (bool)CompletionConsumer; }
 562
 563   CodeCompleteConsumer &getCodeCompletionConsumer() const {
 564     assert(CompletionConsumer &&
 565            "Compiler instance has no code completion consumer!");
 566     return *CompletionConsumer;
 567   }
 568
 569   /// setCodeCompletionConsumer - Replace the current code completion consumer;
 570   /// the compiler instance takes ownership of \p Value.
 571   void setCodeCompletionConsumer(CodeCompleteConsumer *Value);
 572
 573   /// }
 574   /// @name Frontend timer
 575   /// {
 576
 577   bool hasFrontendTimer() const { return (bool)FrontendTimer; }
 578
 579   llvm::Timer &getFrontendTimer() const {
 580     assert(FrontendTimer && "Compiler instance has no frontend timer!");
 581     return *FrontendTimer;
 582   }
 583
 584   /// }
 585   /// @name Output Files
 586   /// {
 587
 588   /// addOutputFile - Add an output file onto the list of tracked output files.
 589   ///
 590   /// \param OutFile - The output file info.
 591   void addOutputFile(OutputFile &&OutFile);
 592
 593   /// clearOutputFiles - Clear the output file list. The underlying output
 594   /// streams must have been closed beforehand.
 595   ///
 596   /// \param EraseFiles - If true, attempt to erase the files from disk.
 597   void clearOutputFiles(bool EraseFiles);
 598
 599   /// }
 600   /// @name Construction Utility Methods
 601   /// {
 602
 603   /// Create the diagnostics engine using the invocation's diagnostic options
 604   /// and replace any existing one with it.
 605   ///
 606   /// Note that this routine also replaces the diagnostic client,
 607   /// allocating one if one is not provided.
 608   ///
 609   /// \param Client If non-NULL, a diagnostic client that will be
 610   /// attached to (and, then, owned by) the DiagnosticsEngine inside this AST
 611   /// unit.
 612   ///
 613   /// \param ShouldOwnClient If Client is non-NULL, specifies whether
 614   /// the diagnostic object should take ownership of the client.
 615   void createDiagnostics(DiagnosticConsumer *Client = nullptr,
 616                          bool ShouldOwnClient = true);
 617
 618   /// Create a DiagnosticsEngine object with a the TextDiagnosticPrinter.
 619   ///
 620   /// If no diagnostic client is provided, this creates a
 621   /// DiagnosticConsumer that is owned by the returned diagnostic
 622   /// object, if using directly the caller is responsible for
 623   /// releasing the returned DiagnosticsEngine's client eventually.
 624   ///
 625   /// \param Opts - The diagnostic options; note that the created text
 626   /// diagnostic object contains a reference to these options.
 627   ///
 628   /// \param Client If non-NULL, a diagnostic client that will be
 629   /// attached to (and, then, owned by) the returned DiagnosticsEngine
 630   /// object.
 631   ///
 632   /// \param CodeGenOpts If non-NULL, the code gen options in use, which may be
 633   /// used by some diagnostics printers (for logging purposes only).
 634   ///
 635   /// \return The new object on success, or null on failure.
 636   static IntrusiveRefCntPtr<DiagnosticsEngine>
 637   createDiagnostics(DiagnosticOptions *Opts,
 638                     DiagnosticConsumer *Client = nullptr,
 639                     bool ShouldOwnClient = true,
 640                     const CodeGenOptions *CodeGenOpts = nullptr);
 641
 642   /// Create the file manager and replace any existing one with it.
 643   void createFileManager();
 644
 645   /// Create the source manager and replace any existing one with it.
 646   void createSourceManager(FileManager &FileMgr);
 647
 648   /// Create the preprocessor, using the invocation, file, and source managers,
 649   /// and replace any existing one with it.
 650   void createPreprocessor(TranslationUnitKind TUKind);
 651
 652   std::string getSpecificModuleCachePath();
 653
 654   /// Create the AST context.
 655   void createASTContext();
 656
 657   /// Create an external AST source to read a PCH file and attach it to the AST
 658   /// context.
 659   void createPCHExternalASTSource(StringRef Path, bool DisablePCHValidation,
 660                                   bool AllowPCHWithCompilerErrors,
 661                                   void *DeserializationListener,
 662                                   bool OwnDeserializationListener);
 663
 664   /// Create an external AST source to read a PCH file.
 665   ///
 666   /// \return - The new object on success, or null on failure.
 667   static IntrusiveRefCntPtr<ASTReader> createPCHExternalASTSource(
 668       StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
 669       bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
 670       const PCHContainerReader &PCHContainerRdr,
 671       ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
 672       DependencyFileGenerator *DependencyFile,
 673       ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,
 674       void *DeserializationListener, bool OwnDeserializationListener,
 675       bool Preamble, bool UseGlobalModuleIndex);
 676
 677   /// Create a code completion consumer using the invocation; note that this
 678   /// will cause the source manager to truncate the input source file at the
 679   /// completion point.
 680   void createCodeCompletionConsumer();
 681
 682   /// Create a code completion consumer to print code completion results, at
 683   /// \p Filename, \p Line, and \p Column, to the given output stream \p OS.
 684   static CodeCompleteConsumer *createCodeCompletionConsumer(
 685       Preprocessor &PP, StringRef Filename, unsigned Line, unsigned Column,
 686       const CodeCompleteOptions &Opts, raw_ostream &OS);
 687
 688   /// \brief Create the Sema object to be used for parsing.
 689   void createSema(TranslationUnitKind TUKind,
 690                   CodeCompleteConsumer *CompletionConsumer);
 691
 692   /// Create the frontend timer and replace any existing one with it.
 693   void createFrontendTimer();
 694
 695   /// Create the default output file (from the invocation's options) and add it
 696   /// to the list of tracked output files.
 697   ///
 698   /// The files created by this function always use temporary files to write to
 699   /// their result (that is, the data is written to a temporary file which will
 700   /// atomically replace the target output on success).
 701   ///
 702   /// \return - Null on error.
 703   std::unique_ptr<raw_pwrite_stream>
 704   createDefaultOutputFile(bool Binary = true, StringRef BaseInput = "",
 705                           StringRef Extension = "");
 706
 707   /// Create a new output file and add it to the list of tracked output files,
 708   /// optionally deriving the output path name.
 709   ///
 710   /// \return - Null on error.
 711   std::unique_ptr<raw_pwrite_stream>
 712   createOutputFile(StringRef OutputPath, bool Binary, bool RemoveFileOnSignal,
 713                    StringRef BaseInput, StringRef Extension, bool UseTemporary,
 714                    bool CreateMissingDirectories = false);
 715
 716   /// Create a new output file, optionally deriving the output path name.
 717   ///
 718   /// If \p OutputPath is empty, then createOutputFile will derive an output
 719   /// path location as \p BaseInput, with any suffix removed, and \p Extension
 720   /// appended. If \p OutputPath is not stdout and \p UseTemporary
 721   /// is true, createOutputFile will create a new temporary file that must be
 722   /// renamed to \p OutputPath in the end.
 723   ///
 724   /// \param OutputPath - If given, the path to the output file.
 725   /// \param Error [out] - On failure, the error.
 726   /// \param BaseInput - If \p OutputPath is empty, the input path name to use
 727   /// for deriving the output path.
 728   /// \param Extension - The extension to use for derived output names.
 729   /// \param Binary - The mode to open the file in.
 730   /// \param RemoveFileOnSignal - Whether the file should be registered with
 731   /// llvm::sys::RemoveFileOnSignal. Note that this is not safe for
 732   /// multithreaded use, as the underlying signal mechanism is not reentrant
 733   /// \param UseTemporary - Create a new temporary file that must be renamed to
 734   /// OutputPath in the end.
 735   /// \param CreateMissingDirectories - When \p UseTemporary is true, create
 736   /// missing directories in the output path.
 737   /// \param ResultPathName [out] - If given, the result path name will be
 738   /// stored here on success.
 739   /// \param TempPathName [out] - If given, the temporary file path name
 740   /// will be stored here on success.
 741   std::unique_ptr<raw_pwrite_stream>
 742   createOutputFile(StringRef OutputPath, std::error_code &Error, bool Binary,
 743                    bool RemoveFileOnSignal, StringRef BaseInput,
 744                    StringRef Extension, bool UseTemporary,
 745                    bool CreateMissingDirectories, std::string *ResultPathName,
 746                    std::string *TempPathName);
 747
 748   std::unique_ptr<raw_pwrite_stream> createNullOutputFile();
 749
 750   /// }
 751   /// @name Initialization Utility Methods
 752   /// {
 753
 754   /// InitializeSourceManager - Initialize the source manager to set InputFile
 755   /// as the main file.
 756   ///
 757   /// \return True on success.
 758   bool InitializeSourceManager(const FrontendInputFile &Input);
 759
 760   /// InitializeSourceManager - Initialize the source manager to set InputFile
 761   /// as the main file.
 762   ///
 763   /// \return True on success.
 764   static bool InitializeSourceManager(const FrontendInputFile &Input,
 765                                       DiagnosticsEngine &Diags,
 766                                       FileManager &FileMgr,
 767                                       SourceManager &SourceMgr,
 768                                       HeaderSearch *HS,
 769                                       DependencyOutputOptions &DepOpts,
 770                                       const FrontendOptions &Opts);
 771
 772   /// }
 773
 774   // Create module manager.
 775   void createModuleManager();
 776
 777   bool loadModuleFile(StringRef FileName);
 778
 779   ModuleLoadResult loadModule(SourceLocation ImportLoc, ModuleIdPath Path,
 780                               Module::NameVisibilityKind Visibility,
 781                               bool IsInclusionDirective) override;
 782
 783   void loadModuleFromSource(SourceLocation ImportLoc, StringRef ModuleName,
 784                             StringRef Source) override;
 785
 786   void makeModuleVisible(Module *Mod, Module::NameVisibilityKind Visibility,
 787                          SourceLocation ImportLoc) override;
 788
 789   bool hadModuleLoaderFatalFailure() const {
 790     return ModuleLoader::HadFatalFailure;
 791   }
 792
 793   GlobalModuleIndex *loadGlobalModuleIndex(SourceLocation TriggerLoc) override;
 794
 795   bool lookupMissingImports(StringRef Name, SourceLocation TriggerLoc) override;
 796
 797   void addDependencyCollector(std::shared_ptr<DependencyCollector> Listener) {
 798     DependencyCollectors.push_back(std::move(Listener));
 799   }
 800
 801   void setExternalSemaSource(IntrusiveRefCntPtr<ExternalSemaSource> ESS);
 802
 803   MemoryBufferCache &getPCMCache() const { return *PCMCache; }
 804 };
 805
 806 } // end namespace clang
 807
 808 #endif