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