clang  8.0.0svn
CompilerInstance.h
Go to the documentation of this file.
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"
18 #include "clang/Frontend/Utils.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.
73  /// The options used in this compiler instance.
74  std::shared_ptr<CompilerInvocation> Invocation;
75 
76  /// The diagnostics engine instance.
78 
79  /// The target being compiled for.
81 
82  /// Auxiliary Target info.
84 
85  /// The virtual file system.
86  IntrusiveRefCntPtr<vfs::FileSystem> VirtualFileSystem;
87 
88  /// The file manager.
90 
91  /// The source manager.
93 
94  /// The cache of PCM files.
96 
97  /// The preprocessor.
98  std::shared_ptr<Preprocessor> PP;
99 
100  /// The AST context.
102 
103  /// An optional sema source that will be attached to sema.
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  /// The semantic analysis object.
113  std::unique_ptr<Sema> TheSema;
114 
115  /// The frontend timer group.
116  std::unique_ptr<llvm::TimerGroup> FrontendTimerGroup;
117 
118  /// The frontend timer.
119  std::unique_ptr<llvm::Timer> FrontendTimer;
120 
121  /// The ASTReader, if one exists.
122  IntrusiveRefCntPtr<ASTReader> ModuleManager;
123 
124  /// The module dependency collector for crashdumps
125  std::shared_ptr<ModuleDependencyCollector> ModuleDepCollector;
126 
127  /// The module provider.
128  std::shared_ptr<PCHContainerOperations> ThePCHContainerOperations;
129 
130  /// The dependency file generator.
131  std::unique_ptr<DependencyFileGenerator> TheDependencyFileGenerator;
132 
133  std::vector<std::shared_ptr<DependencyCollector>> DependencyCollectors;
134 
135  /// 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  /// 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  /// The location of the module-import keyword for the last module
147  /// import.
148  SourceLocation LastModuleImportLoc;
149 
150  /// The result of the last module import.
151  ///
152  ModuleLoadResult LastModuleImportResult;
153 
154  /// Whether we should (re)build the global module index once we
155  /// have finished with this translation unit.
156  bool BuildGlobalModuleIndex = false;
157 
158  /// We have a full global module index, with all modules.
159  bool HaveFullGlobalModuleIndex = false;
160 
161  /// One or more modules failed to build.
162  bool ModuleBuildFailed = false;
163 
164  /// 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  /// Force an output buffer.
187  std::unique_ptr<llvm::raw_pwrite_stream> OutputStream;
188 
189  CompilerInstance(const CompilerInstance &) = delete;
190  void operator=(const CompilerInstance &) = delete;
191 public:
192  explicit CompilerInstance(
193  std::shared_ptr<PCHContainerOperations> PCHContainerOps =
194  std::make_shared<PCHContainerOperations>(),
195  MemoryBufferCache *SharedPCMCache = nullptr);
196  ~CompilerInstance() override;
197 
198  /// @name High-Level Operations
199  /// {
200 
201  /// ExecuteAction - Execute the provided action against the compiler's
202  /// CompilerInvocation object.
203  ///
204  /// This function makes the following assumptions:
205  ///
206  /// - The invocation options should be initialized. This function does not
207  /// handle the '-help' or '-version' options, clients should handle those
208  /// directly.
209  ///
210  /// - The diagnostics engine should have already been created by the client.
211  ///
212  /// - No other CompilerInstance state should have been initialized (this is
213  /// an unchecked error).
214  ///
215  /// - Clients should have initialized any LLVM target features that may be
216  /// required.
217  ///
218  /// - Clients should eventually call llvm_shutdown() upon the completion of
219  /// this routine to ensure that any managed objects are properly destroyed.
220  ///
221  /// Note that this routine may write output to 'stderr'.
222  ///
223  /// \param Act - The action to execute.
224  /// \return - True on success.
225  //
226  // FIXME: This function should take the stream to write any debugging /
227  // verbose output to as an argument.
228  //
229  // FIXME: Eliminate the llvm_shutdown requirement, that should either be part
230  // of the context or else not CompilerInstance specific.
231  bool ExecuteAction(FrontendAction &Act);
232 
233  /// }
234  /// @name Compiler Invocation and Options
235  /// {
236 
237  bool hasInvocation() const { return Invocation != nullptr; }
238 
240  assert(Invocation && "Compiler instance has no invocation!");
241  return *Invocation;
242  }
243 
244  /// setInvocation - Replace the current invocation.
245  void setInvocation(std::shared_ptr<CompilerInvocation> Value);
246 
247  /// Indicates whether we should (re)build the global module index.
248  bool shouldBuildGlobalModuleIndex() const;
249 
250  /// Set the flag indicating whether we should (re)build the global
251  /// module index.
252  void setBuildGlobalModuleIndex(bool Build) {
253  BuildGlobalModuleIndex = Build;
254  }
255 
256  /// }
257  /// @name Forwarding Methods
258  /// {
259 
261  return Invocation->getAnalyzerOpts();
262  }
263 
265  return Invocation->getCodeGenOpts();
266  }
268  return Invocation->getCodeGenOpts();
269  }
270 
272  return Invocation->getDependencyOutputOpts();
273  }
275  return Invocation->getDependencyOutputOpts();
276  }
277 
279  return Invocation->getDiagnosticOpts();
280  }
282  return Invocation->getDiagnosticOpts();
283  }
284 
286  return Invocation->getFileSystemOpts();
287  }
289  return Invocation->getFileSystemOpts();
290  }
291 
293  return Invocation->getFrontendOpts();
294  }
296  return Invocation->getFrontendOpts();
297  }
298 
300  return Invocation->getHeaderSearchOpts();
301  }
303  return Invocation->getHeaderSearchOpts();
304  }
305  std::shared_ptr<HeaderSearchOptions> getHeaderSearchOptsPtr() const {
306  return Invocation->getHeaderSearchOptsPtr();
307  }
308 
310  return *Invocation->getLangOpts();
311  }
312  const LangOptions &getLangOpts() const {
313  return *Invocation->getLangOpts();
314  }
315 
317  return Invocation->getPreprocessorOpts();
318  }
320  return Invocation->getPreprocessorOpts();
321  }
322 
324  return Invocation->getPreprocessorOutputOpts();
325  }
327  return Invocation->getPreprocessorOutputOpts();
328  }
329 
331  return Invocation->getTargetOpts();
332  }
333  const TargetOptions &getTargetOpts() const {
334  return Invocation->getTargetOpts();
335  }
336 
337  /// }
338  /// @name Diagnostics Engine
339  /// {
340 
341  bool hasDiagnostics() const { return Diagnostics != nullptr; }
342 
343  /// Get the current diagnostics engine.
345  assert(Diagnostics && "Compiler instance has no diagnostics!");
346  return *Diagnostics;
347  }
348 
349  /// setDiagnostics - Replace the current diagnostics engine.
350  void setDiagnostics(DiagnosticsEngine *Value);
351 
353  assert(Diagnostics && Diagnostics->getClient() &&
354  "Compiler instance has no diagnostic client!");
355  return *Diagnostics->getClient();
356  }
357 
358  /// }
359  /// @name Target Info
360  /// {
361 
362  bool hasTarget() const { return Target != nullptr; }
363 
365  assert(Target && "Compiler instance has no target!");
366  return *Target;
367  }
368 
369  /// Replace the current Target.
370  void setTarget(TargetInfo *Value);
371 
372  /// }
373  /// @name AuxTarget Info
374  /// {
375 
376  TargetInfo *getAuxTarget() const { return AuxTarget.get(); }
377 
378  /// Replace the current AuxTarget.
379  void setAuxTarget(TargetInfo *Value);
380 
381  /// }
382  /// @name Virtual File System
383  /// {
384 
385  bool hasVirtualFileSystem() const { return VirtualFileSystem != nullptr; }
386 
388  assert(hasVirtualFileSystem() &&
389  "Compiler instance has no virtual file system");
390  return *VirtualFileSystem;
391  }
392 
393  /// Replace the current virtual file system.
394  ///
395  /// \note Most clients should use setFileManager, which will implicitly reset
396  /// the virtual file system to the one contained in the file manager.
398  VirtualFileSystem = std::move(FS);
399  }
400 
401  /// }
402  /// @name File Manager
403  /// {
404 
405  bool hasFileManager() const { return FileMgr != nullptr; }
406 
407  /// Return the current file manager to the caller.
409  assert(FileMgr && "Compiler instance has no file manager!");
410  return *FileMgr;
411  }
412 
414  BuryPointer(FileMgr.get());
415  FileMgr.resetWithoutRelease();
416  }
417 
418  /// Replace the current file manager and virtual file system.
419  void setFileManager(FileManager *Value);
420 
421  /// }
422  /// @name Source Manager
423  /// {
424 
425  bool hasSourceManager() const { return SourceMgr != nullptr; }
426 
427  /// Return the current source manager.
429  assert(SourceMgr && "Compiler instance has no source manager!");
430  return *SourceMgr;
431  }
432 
434  BuryPointer(SourceMgr.get());
435  SourceMgr.resetWithoutRelease();
436  }
437 
438  /// setSourceManager - Replace the current source manager.
439  void setSourceManager(SourceManager *Value);
440 
441  /// }
442  /// @name Preprocessor
443  /// {
444 
445  bool hasPreprocessor() const { return PP != nullptr; }
446 
447  /// Return the current preprocessor.
449  assert(PP && "Compiler instance has no preprocessor!");
450  return *PP;
451  }
452 
453  std::shared_ptr<Preprocessor> getPreprocessorPtr() { return PP; }
454 
456  BuryPointer(new std::shared_ptr<Preprocessor>(PP));
457  }
458 
459  /// Replace the current preprocessor.
460  void setPreprocessor(std::shared_ptr<Preprocessor> Value);
461 
462  /// }
463  /// @name ASTContext
464  /// {
465 
466  bool hasASTContext() const { return Context != nullptr; }
467 
469  assert(Context && "Compiler instance has no AST context!");
470  return *Context;
471  }
472 
474  BuryPointer(Context.get());
475  Context.resetWithoutRelease();
476  }
477 
478  /// setASTContext - Replace the current AST context.
479  void setASTContext(ASTContext *Value);
480 
481  /// Replace the current Sema; the compiler instance takes ownership
482  /// of S.
483  void setSema(Sema *S);
484 
485  /// }
486  /// @name ASTConsumer
487  /// {
488 
489  bool hasASTConsumer() const { return (bool)Consumer; }
490 
492  assert(Consumer && "Compiler instance has no AST consumer!");
493  return *Consumer;
494  }
495 
496  /// takeASTConsumer - Remove the current AST consumer and give ownership to
497  /// the caller.
498  std::unique_ptr<ASTConsumer> takeASTConsumer() { return std::move(Consumer); }
499 
500  /// setASTConsumer - Replace the current AST consumer; the compiler instance
501  /// takes ownership of \p Value.
502  void setASTConsumer(std::unique_ptr<ASTConsumer> Value);
503 
504  /// }
505  /// @name Semantic analysis
506  /// {
507  bool hasSema() const { return (bool)TheSema; }
508 
509  Sema &getSema() const {
510  assert(TheSema && "Compiler instance has no Sema object!");
511  return *TheSema;
512  }
513 
514  std::unique_ptr<Sema> takeSema();
515  void resetAndLeakSema();
516 
517  /// }
518  /// @name Module Management
519  /// {
520 
521  IntrusiveRefCntPtr<ASTReader> getModuleManager() const;
522  void setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader);
523 
524  std::shared_ptr<ModuleDependencyCollector> getModuleDepCollector() const;
525  void setModuleDepCollector(
526  std::shared_ptr<ModuleDependencyCollector> Collector);
527 
528  std::shared_ptr<PCHContainerOperations> getPCHContainerOperations() const {
529  return ThePCHContainerOperations;
530  }
531 
532  /// Return the appropriate PCHContainerWriter depending on the
533  /// current CodeGenOptions.
535  assert(Invocation && "cannot determine module format without invocation");
536  StringRef Format = getHeaderSearchOpts().ModuleFormat;
537  auto *Writer = ThePCHContainerOperations->getWriterOrNull(Format);
538  if (!Writer) {
539  if (Diagnostics)
540  Diagnostics->Report(diag::err_module_format_unhandled) << Format;
541  llvm::report_fatal_error("unknown module format");
542  }
543  return *Writer;
544  }
545 
546  /// Return the appropriate PCHContainerReader depending on the
547  /// current CodeGenOptions.
549  assert(Invocation && "cannot determine module format without invocation");
550  StringRef Format = getHeaderSearchOpts().ModuleFormat;
551  auto *Reader = ThePCHContainerOperations->getReaderOrNull(Format);
552  if (!Reader) {
553  if (Diagnostics)
554  Diagnostics->Report(diag::err_module_format_unhandled) << Format;
555  llvm::report_fatal_error("unknown module format");
556  }
557  return *Reader;
558  }
559 
560  /// }
561  /// @name Code Completion
562  /// {
563 
564  bool hasCodeCompletionConsumer() const { return (bool)CompletionConsumer; }
565 
567  assert(CompletionConsumer &&
568  "Compiler instance has no code completion consumer!");
569  return *CompletionConsumer;
570  }
571 
572  /// setCodeCompletionConsumer - Replace the current code completion consumer;
573  /// the compiler instance takes ownership of \p Value.
574  void setCodeCompletionConsumer(CodeCompleteConsumer *Value);
575 
576  /// }
577  /// @name Frontend timer
578  /// {
579 
580  bool hasFrontendTimer() const { return (bool)FrontendTimer; }
581 
582  llvm::Timer &getFrontendTimer() const {
583  assert(FrontendTimer && "Compiler instance has no frontend timer!");
584  return *FrontendTimer;
585  }
586 
587  /// }
588  /// @name Output Files
589  /// {
590 
591  /// addOutputFile - Add an output file onto the list of tracked output files.
592  ///
593  /// \param OutFile - The output file info.
594  void addOutputFile(OutputFile &&OutFile);
595 
596  /// clearOutputFiles - Clear the output file list. The underlying output
597  /// streams must have been closed beforehand.
598  ///
599  /// \param EraseFiles - If true, attempt to erase the files from disk.
600  void clearOutputFiles(bool EraseFiles);
601 
602  /// }
603  /// @name Construction Utility Methods
604  /// {
605 
606  /// Create the diagnostics engine using the invocation's diagnostic options
607  /// and replace any existing one with it.
608  ///
609  /// Note that this routine also replaces the diagnostic client,
610  /// allocating one if one is not provided.
611  ///
612  /// \param Client If non-NULL, a diagnostic client that will be
613  /// attached to (and, then, owned by) the DiagnosticsEngine inside this AST
614  /// unit.
615  ///
616  /// \param ShouldOwnClient If Client is non-NULL, specifies whether
617  /// the diagnostic object should take ownership of the client.
618  void createDiagnostics(DiagnosticConsumer *Client = nullptr,
619  bool ShouldOwnClient = true);
620 
621  /// Create a DiagnosticsEngine object with a the TextDiagnosticPrinter.
622  ///
623  /// If no diagnostic client is provided, this creates a
624  /// DiagnosticConsumer that is owned by the returned diagnostic
625  /// object, if using directly the caller is responsible for
626  /// releasing the returned DiagnosticsEngine's client eventually.
627  ///
628  /// \param Opts - The diagnostic options; note that the created text
629  /// diagnostic object contains a reference to these options.
630  ///
631  /// \param Client If non-NULL, a diagnostic client that will be
632  /// attached to (and, then, owned by) the returned DiagnosticsEngine
633  /// object.
634  ///
635  /// \param CodeGenOpts If non-NULL, the code gen options in use, which may be
636  /// used by some diagnostics printers (for logging purposes only).
637  ///
638  /// \return The new object on success, or null on failure.
640  createDiagnostics(DiagnosticOptions *Opts,
641  DiagnosticConsumer *Client = nullptr,
642  bool ShouldOwnClient = true,
643  const CodeGenOptions *CodeGenOpts = nullptr);
644 
645  /// Create the file manager and replace any existing one with it.
646  ///
647  /// \return The new file manager on success, or null on failure.
648  FileManager *createFileManager();
649 
650  /// Create the source manager and replace any existing one with it.
651  void createSourceManager(FileManager &FileMgr);
652 
653  /// Create the preprocessor, using the invocation, file, and source managers,
654  /// and replace any existing one with it.
655  void createPreprocessor(TranslationUnitKind TUKind);
656 
657  std::string getSpecificModuleCachePath();
658 
659  /// Create the AST context.
660  void createASTContext();
661 
662  /// Create an external AST source to read a PCH file and attach it to the AST
663  /// context.
664  void createPCHExternalASTSource(StringRef Path, bool DisablePCHValidation,
665  bool AllowPCHWithCompilerErrors,
666  void *DeserializationListener,
667  bool OwnDeserializationListener);
668 
669  /// Create an external AST source to read a PCH file.
670  ///
671  /// \return - The new object on success, or null on failure.
672  static IntrusiveRefCntPtr<ASTReader> createPCHExternalASTSource(
673  StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
674  bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
675  const PCHContainerReader &PCHContainerRdr,
676  ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
677  DependencyFileGenerator *DependencyFile,
678  ArrayRef<std::shared_ptr<DependencyCollector>> DependencyCollectors,
679  void *DeserializationListener, bool OwnDeserializationListener,
680  bool Preamble, bool UseGlobalModuleIndex);
681 
682  /// Create a code completion consumer using the invocation; note that this
683  /// will cause the source manager to truncate the input source file at the
684  /// completion point.
685  void createCodeCompletionConsumer();
686 
687  /// Create a code completion consumer to print code completion results, at
688  /// \p Filename, \p Line, and \p Column, to the given output stream \p OS.
689  static CodeCompleteConsumer *createCodeCompletionConsumer(
690  Preprocessor &PP, StringRef Filename, unsigned Line, unsigned Column,
691  const CodeCompleteOptions &Opts, raw_ostream &OS);
692 
693  /// Create the Sema object to be used for parsing.
694  void createSema(TranslationUnitKind TUKind,
695  CodeCompleteConsumer *CompletionConsumer);
696 
697  /// Create the frontend timer and replace any existing one with it.
698  void createFrontendTimer();
699 
700  /// Create the default output file (from the invocation's options) and add it
701  /// to the list of tracked output files.
702  ///
703  /// The files created by this function always use temporary files to write to
704  /// their result (that is, the data is written to a temporary file which will
705  /// atomically replace the target output on success).
706  ///
707  /// \return - Null on error.
708  std::unique_ptr<raw_pwrite_stream>
709  createDefaultOutputFile(bool Binary = true, StringRef BaseInput = "",
710  StringRef Extension = "");
711 
712  /// Create a new output file and add it to the list of tracked output files,
713  /// optionally deriving the output path name.
714  ///
715  /// \return - Null on error.
716  std::unique_ptr<raw_pwrite_stream>
717  createOutputFile(StringRef OutputPath, bool Binary, bool RemoveFileOnSignal,
718  StringRef BaseInput, StringRef Extension, bool UseTemporary,
719  bool CreateMissingDirectories = false);
720 
721  /// Create a new output file, optionally deriving the output path name.
722  ///
723  /// If \p OutputPath is empty, then createOutputFile will derive an output
724  /// path location as \p BaseInput, with any suffix removed, and \p Extension
725  /// appended. If \p OutputPath is not stdout and \p UseTemporary
726  /// is true, createOutputFile will create a new temporary file that must be
727  /// renamed to \p OutputPath in the end.
728  ///
729  /// \param OutputPath - If given, the path to the output file.
730  /// \param Error [out] - On failure, the error.
731  /// \param BaseInput - If \p OutputPath is empty, the input path name to use
732  /// for deriving the output path.
733  /// \param Extension - The extension to use for derived output names.
734  /// \param Binary - The mode to open the file in.
735  /// \param RemoveFileOnSignal - Whether the file should be registered with
736  /// llvm::sys::RemoveFileOnSignal. Note that this is not safe for
737  /// multithreaded use, as the underlying signal mechanism is not reentrant
738  /// \param UseTemporary - Create a new temporary file that must be renamed to
739  /// OutputPath in the end.
740  /// \param CreateMissingDirectories - When \p UseTemporary is true, create
741  /// missing directories in the output path.
742  /// \param ResultPathName [out] - If given, the result path name will be
743  /// stored here on success.
744  /// \param TempPathName [out] - If given, the temporary file path name
745  /// will be stored here on success.
746  std::unique_ptr<raw_pwrite_stream>
747  createOutputFile(StringRef OutputPath, std::error_code &Error, bool Binary,
748  bool RemoveFileOnSignal, StringRef BaseInput,
749  StringRef Extension, bool UseTemporary,
750  bool CreateMissingDirectories, std::string *ResultPathName,
751  std::string *TempPathName);
752 
753  std::unique_ptr<raw_pwrite_stream> createNullOutputFile();
754 
755  /// }
756  /// @name Initialization Utility Methods
757  /// {
758 
759  /// InitializeSourceManager - Initialize the source manager to set InputFile
760  /// as the main file.
761  ///
762  /// \return True on success.
763  bool InitializeSourceManager(const FrontendInputFile &Input);
764 
765  /// InitializeSourceManager - Initialize the source manager to set InputFile
766  /// as the main file.
767  ///
768  /// \return True on success.
769  static bool InitializeSourceManager(const FrontendInputFile &Input,
770  DiagnosticsEngine &Diags,
771  FileManager &FileMgr,
772  SourceManager &SourceMgr,
773  HeaderSearch *HS,
774  DependencyOutputOptions &DepOpts,
775  const FrontendOptions &Opts);
776 
777  /// }
778 
779  void setOutputStream(std::unique_ptr<llvm::raw_pwrite_stream> OutStream) {
780  OutputStream = std::move(OutStream);
781  }
782 
783  std::unique_ptr<llvm::raw_pwrite_stream> takeOutputStream() {
784  return std::move(OutputStream);
785  }
786 
787  // Create module manager.
788  void createModuleManager();
789 
790  bool loadModuleFile(StringRef FileName);
791 
792  ModuleLoadResult loadModule(SourceLocation ImportLoc, ModuleIdPath Path,
794  bool IsInclusionDirective) override;
795 
796  void loadModuleFromSource(SourceLocation ImportLoc, StringRef ModuleName,
797  StringRef Source) override;
798 
799  void makeModuleVisible(Module *Mod, Module::NameVisibilityKind Visibility,
800  SourceLocation ImportLoc) override;
801 
803  return ModuleLoader::HadFatalFailure;
804  }
805 
806  GlobalModuleIndex *loadGlobalModuleIndex(SourceLocation TriggerLoc) override;
807 
808  bool lookupMissingImports(StringRef Name, SourceLocation TriggerLoc) override;
809 
810  void addDependencyCollector(std::shared_ptr<DependencyCollector> Listener) {
811  DependencyCollectors.push_back(std::move(Listener));
812  }
813 
814  void setExternalSemaSource(IntrusiveRefCntPtr<ExternalSemaSource> ESS);
815 
816  MemoryBufferCache &getPCMCache() const { return *PCMCache; }
817 };
818 
819 } // end namespace clang
820 
821 #endif
LangOptions & getLangOpts()
CompilerInvocation & getInvocation()
PreprocessorOptions & getPreprocessorOpts()
Implements support for file system lookup, file system caching, and directory search management...
Definition: FileManager.h:116
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:34
const TargetOptions & getTargetOpts() const
DominatorTree GraphTraits specialization so the DominatorTree can be iterable by generic graph iterat...
Definition: Dominators.h:30
Defines the SourceManager interface.
std::shared_ptr< PCHContainerOperations > getPCHContainerOperations() const
Abstract base class for actions which can be performed by the frontend.
DiagnosticOptions & getDiagnosticOpts()
std::shared_ptr< HeaderSearchOptions > getHeaderSearchOptsPtr() const
const HeaderSearchOptions & getHeaderSearchOpts() const
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
ASTContext & getASTContext() const
const FrontendOptions & getFrontendOpts() const
Options for controlling the target.
Definition: TargetOptions.h:26
Manage memory buffers across multiple users.
Abstract interface, implemented by clients of the front-end, which formats and prints fully processed...
Definition: Diagnostic.h:1487
DependencyOutputOptions & getDependencyOutputOpts()
const FileSystemOptions & getFileSystemOpts() const
const DependencyOutputOptions & getDependencyOutputOpts() const
void setOutputStream(std::unique_ptr< llvm::raw_pwrite_stream > OutStream)
}
The virtual file system interface.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
CodeGenOptions & getCodeGenOpts()
const PreprocessorOutputOptions & getPreprocessorOutputOpts() const
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:50
Describes a module or submodule.
Definition: Module.h:65
MemoryBufferCache & getPCMCache() const
const PCHContainerWriter & getPCHContainerWriter() const
Return the appropriate PCHContainerWriter depending on the current CodeGenOptions.
void setBuildGlobalModuleIndex(bool Build)
Set the flag indicating whether we should (re)build the global module index.
This abstract interface provides operations for creating containers for serialized ASTs (precompiled ...
FrontendOptions & getFrontendOpts()
Visibility
Describes the different kinds of visibility that a declaration may have.
Definition: Visibility.h:34
PreprocessorOutputOptions & getPreprocessorOutputOpts()
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:149
ASTConsumer & getASTConsumer() const
Defines the Diagnostic-related interfaces.
HeaderSearchOptions & getHeaderSearchOpts()
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
Builds a depdenency file when attached to a Preprocessor (for includes) and ASTReader (for module imp...
Definition: Utils.h:119
AnalyzerOptionsRef getAnalyzerOpts()
CodeCompleteConsumer & getCodeCompletionConsumer() const
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc.
Definition: HeaderSearch.h:148
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:277
void setVirtualFileSystem(IntrusiveRefCntPtr< vfs::FileSystem > FS)
Replace the current virtual file system.
Describes the result of attempting to load a module.
Definition: ModuleLoader.h:36
StringRef Filename
Definition: Format.cpp:1602
PreprocessorOutputOptions - Options for controlling the C preprocessor output (e.g., -E).
Exposes information about the current target.
Definition: TargetInfo.h:54
void addDependencyCollector(std::shared_ptr< DependencyCollector > Listener)
const AnnotatedLine * Line
TargetInfo * getAuxTarget() const
const CodeGenOptions & getCodeGenOpts() const
An input file for the front end.
FileSystemOptions & getFileSystemOpts()
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
Encodes a location in the source.
std::unique_ptr< llvm::raw_pwrite_stream > takeOutputStream()
Options for controlling the compiler diagnostics engine.
bool hasVirtualFileSystem() const
const DiagnosticOptions & getDiagnosticOpts() const
DependencyOutputOptions - Options for controlling the compiler dependency file generation.
const PreprocessorOptions & getPreprocessorOpts() const
A global index for a set of module files, providing information about the identifiers within those mo...
Abstract interface for a consumer of code-completion information.
Options controlling the behavior of code completion.
Dataflow Directional Tag Classes.
FileManager & getFileManager() const
Return the current file manager to the caller.
llvm::Timer & getFrontendTimer() const
vfs::FileSystem & getVirtualFileSystem() const
Helper class for holding the data necessary to invoke the compiler.
SourceManager & getSourceManager() const
Return the current source manager.
FrontendOptions - Options for controlling the behavior of the frontend.
Abstract interface for a module loader.
Definition: ModuleLoader.h:74
void BuryPointer(const void *Ptr)
TargetInfo & getTarget() const
CodeGenOptions - Track various options which control how the code is optimized and passed to the back...
const LangOptions & getLangOpts() const
Keeps track of options that affect how file operations are performed.
Preprocessor & getPreprocessor() const
Return the current preprocessor.
bool hasCodeCompletionConsumer() const
DiagnosticConsumer & getDiagnosticClient() const
TranslationUnitKind
Describes the kind of translation unit being processed.
Definition: LangOptions.h:329
const PCHContainerReader & getPCHContainerReader() const
Return the appropriate PCHContainerReader depending on the current CodeGenOptions.
bool hadModuleLoaderFatalFailure() const
NameVisibilityKind
Describes the visibility of the various names within a particular module.
Definition: Module.h:267
DiagnosticsEngine & getDiagnostics() const
Get the current diagnostics engine.
HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSea...
std::unique_ptr< ASTConsumer > takeASTConsumer()
takeASTConsumer - Remove the current AST consumer and give ownership to the caller.
TargetOptions & getTargetOpts()
This class handles loading and caching of source files into memory.
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:127