clang  13.0.0git
Classes | Public Member Functions | List of all members
clang::CompilerInstance Class Reference

CompilerInstance - Helper class for managing a single instance of the Clang compiler. More...

#include "clang/Frontend/CompilerInstance.h"

Inheritance diagram for clang::CompilerInstance:
Inheritance graph
[legend]
Collaboration diagram for clang::CompilerInstance:
Collaboration graph
[legend]

Public Member Functions

 CompilerInstance (std::shared_ptr< PCHContainerOperations > PCHContainerOps=std::make_shared< PCHContainerOperations >(), InMemoryModuleCache *SharedModuleCache=nullptr)
 
 ~CompilerInstance () override
 
High-Level Operations

{

bool ExecuteAction (FrontendAction &Act)
 ExecuteAction - Execute the provided action against the compiler's CompilerInvocation object. More...
 
Compiler Invocation and Options

}

{

bool hasInvocation () const
 
CompilerInvocationgetInvocation ()
 
void setInvocation (std::shared_ptr< CompilerInvocation > Value)
 setInvocation - Replace the current invocation. More...
 
bool shouldBuildGlobalModuleIndex () const
 Indicates whether we should (re)build the global module index. More...
 
void setBuildGlobalModuleIndex (bool Build)
 Set the flag indicating whether we should (re)build the global module index. More...
 
Forwarding Methods

}

{

AnalyzerOptionsRef getAnalyzerOpts ()
 
CodeGenOptionsgetCodeGenOpts ()
 
const CodeGenOptionsgetCodeGenOpts () const
 
DependencyOutputOptionsgetDependencyOutputOpts ()
 
const DependencyOutputOptionsgetDependencyOutputOpts () const
 
DiagnosticOptionsgetDiagnosticOpts ()
 
const DiagnosticOptionsgetDiagnosticOpts () const
 
FileSystemOptionsgetFileSystemOpts ()
 
const FileSystemOptionsgetFileSystemOpts () const
 
FrontendOptionsgetFrontendOpts ()
 
const FrontendOptionsgetFrontendOpts () const
 
HeaderSearchOptionsgetHeaderSearchOpts ()
 
const HeaderSearchOptionsgetHeaderSearchOpts () const
 
std::shared_ptr< HeaderSearchOptionsgetHeaderSearchOptsPtr () const
 
LangOptionsgetLangOpts ()
 
const LangOptionsgetLangOpts () const
 
PreprocessorOptionsgetPreprocessorOpts ()
 
const PreprocessorOptionsgetPreprocessorOpts () const
 
PreprocessorOutputOptionsgetPreprocessorOutputOpts ()
 
const PreprocessorOutputOptionsgetPreprocessorOutputOpts () const
 
TargetOptionsgetTargetOpts ()
 
const TargetOptionsgetTargetOpts () const
 
Diagnostics Engine

}

{

bool hasDiagnostics () const
 
DiagnosticsEnginegetDiagnostics () const
 Get the current diagnostics engine. More...
 
void setDiagnostics (DiagnosticsEngine *Value)
 setDiagnostics - Replace the current diagnostics engine. More...
 
DiagnosticConsumergetDiagnosticClient () const
 
VerboseOutputStream

}

}

void setVerboseOutputStream (raw_ostream &Value)
 Replace the current stream for verbose output. More...
 
void setVerboseOutputStream (std::unique_ptr< raw_ostream > Value)
 Replace the current stream for verbose output. More...
 
raw_ostream & getVerboseOutputStream ()
 Get the current stream for verbose output. More...
 
Target Info

}

{

bool hasTarget () const
 
TargetInfogetTarget () const
 
void setTarget (TargetInfo *Value)
 Replace the current Target. More...
 
AuxTarget Info

}

{

TargetInfogetAuxTarget () const
 
void setAuxTarget (TargetInfo *Value)
 Replace the current AuxTarget. More...
 
bool createTarget ()
 
Virtual File System

}

{

llvm::vfs::FileSystem & getVirtualFileSystem () const
 
File Manager

}

{

bool hasFileManager () const
 
FileManagergetFileManager () const
 Return the current file manager to the caller. More...
 
void resetAndLeakFileManager ()
 
void setFileManager (FileManager *Value)
 Replace the current file manager and virtual file system. More...
 
Source Manager

}

{

bool hasSourceManager () const
 
SourceManagergetSourceManager () const
 Return the current source manager. More...
 
void resetAndLeakSourceManager ()
 
void setSourceManager (SourceManager *Value)
 setSourceManager - Replace the current source manager. More...
 
Preprocessor

}

{

bool hasPreprocessor () const
 
PreprocessorgetPreprocessor () const
 Return the current preprocessor. More...
 
std::shared_ptr< PreprocessorgetPreprocessorPtr ()
 
void resetAndLeakPreprocessor ()
 
void setPreprocessor (std::shared_ptr< Preprocessor > Value)
 Replace the current preprocessor. More...
 
ASTContext

}

{

bool hasASTContext () const
 
ASTContextgetASTContext () const
 
void resetAndLeakASTContext ()
 
void setASTContext (ASTContext *Value)
 setASTContext - Replace the current AST context. More...
 
void setSema (Sema *S)
 Replace the current Sema; the compiler instance takes ownership of S. More...
 
ASTConsumer

}

{

bool hasASTConsumer () const
 
ASTConsumergetASTConsumer () const
 
std::unique_ptr< ASTConsumertakeASTConsumer ()
 takeASTConsumer - Remove the current AST consumer and give ownership to the caller. More...
 
void setASTConsumer (std::unique_ptr< ASTConsumer > Value)
 setASTConsumer - Replace the current AST consumer; the compiler instance takes ownership of Value. More...
 
Semantic analysis

}

{

bool hasSema () const
 
SemagetSema () const
 
std::unique_ptr< SematakeSema ()
 
void resetAndLeakSema ()
 
Module Management

}

{

IntrusiveRefCntPtr< ASTReadergetASTReader () const
 
void setASTReader (IntrusiveRefCntPtr< ASTReader > Reader)
 
std::shared_ptr< ModuleDependencyCollectorgetModuleDepCollector () const
 
void setModuleDepCollector (std::shared_ptr< ModuleDependencyCollector > Collector)
 
std::shared_ptr< PCHContainerOperationsgetPCHContainerOperations () const
 
const PCHContainerWritergetPCHContainerWriter () const
 Return the appropriate PCHContainerWriter depending on the current CodeGenOptions. More...
 
const PCHContainerReadergetPCHContainerReader () const
 Return the appropriate PCHContainerReader depending on the current CodeGenOptions. More...
 
Code Completion

}

{

bool hasCodeCompletionConsumer () const
 
CodeCompleteConsumergetCodeCompletionConsumer () const
 
void setCodeCompletionConsumer (CodeCompleteConsumer *Value)
 setCodeCompletionConsumer - Replace the current code completion consumer; the compiler instance takes ownership of Value. More...
 
Frontend timer

}

{

bool hasFrontendTimer () const
 
llvm::Timer & getFrontendTimer () const
 
Output Files

}

{

void clearOutputFiles (bool EraseFiles)
 clearOutputFiles - Clear the output file list. More...
 
- Public Member Functions inherited from clang::ModuleLoader
 ModuleLoader (bool BuildingModule=false)
 
virtual ~ModuleLoader ()
 
bool buildingModule () const
 Returns true if this instance is building a module. More...
 
void setBuildingModule (bool BuildingModuleFlag)
 Flag indicating whether this instance is building a module. More...
 

Construction Utility Methods

}

{

void createDiagnostics (DiagnosticConsumer *Client=nullptr, bool ShouldOwnClient=true)
 Create the diagnostics engine using the invocation's diagnostic options and replace any existing one with it. More...
 
FileManagercreateFileManager (IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS=nullptr)
 Create the file manager and replace any existing one with it. More...
 
void createSourceManager (FileManager &FileMgr)
 Create the source manager and replace any existing one with it. More...
 
void createPreprocessor (TranslationUnitKind TUKind)
 Create the preprocessor, using the invocation, file, and source managers, and replace any existing one with it. More...
 
std::string getSpecificModuleCachePath (StringRef ModuleHash)
 
std::string getSpecificModuleCachePath ()
 
void createASTContext ()
 Create the AST context. More...
 
void createPCHExternalASTSource (StringRef Path, DisableValidationForModuleKind DisableValidation, bool AllowPCHWithCompilerErrors, void *DeserializationListener, bool OwnDeserializationListener)
 Create an external AST source to read a PCH file and attach it to the AST context. More...
 
void createCodeCompletionConsumer ()
 Create a code completion consumer using the invocation; note that this will cause the source manager to truncate the input source file at the completion point. More...
 
void createSema (TranslationUnitKind TUKind, CodeCompleteConsumer *CompletionConsumer)
 Create the Sema object to be used for parsing. More...
 
void createFrontendTimer ()
 Create the frontend timer and replace any existing one with it. More...
 
std::unique_ptr< raw_pwrite_stream > createDefaultOutputFile (bool Binary=true, StringRef BaseInput="", StringRef Extension="", bool RemoveFileOnSignal=true, bool CreateMissingDirectories=false)
 Create the default output file (from the invocation's options) and add it to the list of tracked output files. More...
 
std::unique_ptr< raw_pwrite_stream > createOutputFile (StringRef OutputPath, bool Binary, bool RemoveFileOnSignal, bool UseTemporary, bool CreateMissingDirectories=false)
 Create a new output file, optionally deriving the output path name, and add it to the list of tracked output files. More...
 
std::unique_ptr< raw_pwrite_stream > createNullOutputFile ()
 
static IntrusiveRefCntPtr< DiagnosticsEnginecreateDiagnostics (DiagnosticOptions *Opts, DiagnosticConsumer *Client=nullptr, bool ShouldOwnClient=true, const CodeGenOptions *CodeGenOpts=nullptr)
 Create a DiagnosticsEngine object with a the TextDiagnosticPrinter. More...
 
static IntrusiveRefCntPtr< ASTReadercreatePCHExternalASTSource (StringRef Path, StringRef Sysroot, DisableValidationForModuleKind DisableValidation, bool AllowPCHWithCompilerErrors, Preprocessor &PP, InMemoryModuleCache &ModuleCache, ASTContext &Context, const PCHContainerReader &PCHContainerRdr, ArrayRef< std::shared_ptr< ModuleFileExtension >> Extensions, ArrayRef< std::shared_ptr< DependencyCollector >> DependencyCollectors, void *DeserializationListener, bool OwnDeserializationListener, bool Preamble, bool UseGlobalModuleIndex)
 Create an external AST source to read a PCH file. More...
 
static CodeCompleteConsumercreateCodeCompletionConsumer (Preprocessor &PP, StringRef Filename, unsigned Line, unsigned Column, const CodeCompleteOptions &Opts, raw_ostream &OS)
 Create a code completion consumer to print code completion results, at Filename, Line, and Column, to the given output stream OS. More...
 

Initialization Utility Methods

}

{

bool InitializeSourceManager (const FrontendInputFile &Input)
 InitializeSourceManager - Initialize the source manager to set InputFile as the main file. More...
 
void setOutputStream (std::unique_ptr< llvm::raw_pwrite_stream > OutStream)
 } More...
 
std::unique_ptr< llvm::raw_pwrite_stream > takeOutputStream ()
 
void createASTReader ()
 
bool loadModuleFile (StringRef FileName)
 
ModuleLoadResult loadModule (SourceLocation ImportLoc, ModuleIdPath Path, Module::NameVisibilityKind Visibility, bool IsInclusionDirective) override
 Attempt to load the given module. More...
 
void createModuleFromSource (SourceLocation ImportLoc, StringRef ModuleName, StringRef Source) override
 Attempt to create the given module from the specified source buffer. More...
 
void makeModuleVisible (Module *Mod, Module::NameVisibilityKind Visibility, SourceLocation ImportLoc) override
 Make the given module visible. More...
 
bool hadModuleLoaderFatalFailure () const
 
GlobalModuleIndexloadGlobalModuleIndex (SourceLocation TriggerLoc) override
 Load, create, or return global module. More...
 
bool lookupMissingImports (StringRef Name, SourceLocation TriggerLoc) override
 Check global module index for missing imports. More...
 
void addDependencyCollector (std::shared_ptr< DependencyCollector > Listener)
 
void setExternalSemaSource (IntrusiveRefCntPtr< ExternalSemaSource > ESS)
 
InMemoryModuleCachegetModuleCache () const
 
static bool InitializeSourceManager (const FrontendInputFile &Input, DiagnosticsEngine &Diags, FileManager &FileMgr, SourceManager &SourceMgr)
 InitializeSourceManager - Initialize the source manager to set InputFile as the main file. More...
 

Additional Inherited Members

- Public Attributes inherited from clang::ModuleLoader
bool HadFatalFailure = false
 

Detailed Description

CompilerInstance - Helper class for managing a single instance of the Clang compiler.

The CompilerInstance serves two purposes: (1) It manages the various objects which are necessary to run the compiler, for example the preprocessor, the target information, and the AST context. (2) It provides utility routines for constructing and manipulating the common Clang objects.

The compiler instance generally owns the instance of all the objects that it manages. However, clients can still share objects by manually setting the object and retaking ownership prior to destroying the CompilerInstance.

The compiler instance is intended to simplify clients, but not to lock them in to the compiler instance for everything. When possible, utility functions come in two forms; a short form that reuses the CompilerInstance objects, and a long form that takes explicit instances of any required objects.

Definition at line 73 of file CompilerInstance.h.

Constructor & Destructor Documentation

◆ CompilerInstance()

CompilerInstance::CompilerInstance ( std::shared_ptr< PCHContainerOperations PCHContainerOps = std::make_shared<PCHContainerOperations>(),
InMemoryModuleCache SharedModuleCache = nullptr 
)
explicit

Definition at line 58 of file CompilerInstance.cpp.

◆ ~CompilerInstance()

CompilerInstance::~CompilerInstance ( )
override

Definition at line 67 of file CompilerInstance.cpp.

Member Function Documentation

◆ addDependencyCollector()

void clang::CompilerInstance::addDependencyCollector ( std::shared_ptr< DependencyCollector Listener)
inline

Definition at line 812 of file CompilerInstance.h.

Referenced by createPreprocessor().

◆ clearOutputFiles()

void CompilerInstance::clearOutputFiles ( bool  EraseFiles)

clearOutputFiles - Clear the output file list.

The underlying output streams must have been closed beforehand.

Parameters
EraseFiles- If true, attempt to erase the files from disk.

Definition at line 699 of file CompilerInstance.cpp.

References getDiagnostics(), clang::transformer::remove(), and clang::DiagnosticsEngine::Report().

Referenced by clang::FrontendAction::EndSourceFile().

◆ createASTContext()

void CompilerInstance::createASTContext ( )

◆ createASTReader()

void CompilerInstance::createASTReader ( )

◆ createCodeCompletionConsumer() [1/2]

void CompilerInstance::createCodeCompletionConsumer ( )

Create a code completion consumer using the invocation; note that this will cause the source manager to truncate the input source file at the completion point.

Definition at line 647 of file CompilerInstance.cpp.

References clang::FrontendOptions::CodeCompletionAt, clang::ParsedSourceLocation::Column, EnableCodeCompletion(), clang::ParsedSourceLocation::FileName, getFrontendOpts(), getPreprocessor(), clang::ParsedSourceLocation::Line, and setCodeCompletionConsumer().

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ createCodeCompletionConsumer() [2/2]

CodeCompleteConsumer * CompilerInstance::createCodeCompletionConsumer ( Preprocessor PP,
StringRef  Filename,
unsigned  Line,
unsigned  Column,
const CodeCompleteOptions Opts,
raw_ostream &  OS 
)
static

Create a code completion consumer to print code completion results, at Filename, Line, and Column, to the given output stream OS.

Definition at line 673 of file CompilerInstance.cpp.

References EnableCodeCompletion(), Filename, and Line.

◆ createDefaultOutputFile()

std::unique_ptr< raw_pwrite_stream > CompilerInstance::createDefaultOutputFile ( bool  Binary = true,
StringRef  BaseInput = "",
StringRef  Extension = "",
bool  RemoveFileOnSignal = true,
bool  CreateMissingDirectories = false 
)

Create the default output file (from the invocation's options) and add it to the list of tracked output files.

The files created by this are usually removed on signal, and, depending on FrontendOptions, may also use a temporary file (that is, the data is written to a temporary file which will atomically replace the target output on success). If a client (like libclang) needs to disable RemoveFileOnSignal, temporary files will be forced on.

Returns
- Null on error.

Definition at line 735 of file CompilerInstance.cpp.

References createOutputFile(), getFrontendOpts(), and clang::FrontendOptions::OutputFile.

Referenced by clang::RewriteIncludesAction::BeginSourceFileAction(), clang::HTMLPrintAction::CreateASTConsumer(), clang::ASTPrintAction::CreateASTConsumer(), clang::RewriteObjCAction::CreateASTConsumer(), clang::GeneratePCHAction::CreateOutputFile(), clang::RewriteMacrosAction::ExecuteAction(), clang::RewriteTestAction::ExecuteAction(), clang::PrintPreprocessedAction::ExecuteAction(), and GetOutputStream().

◆ createDiagnostics() [1/2]

void CompilerInstance::createDiagnostics ( DiagnosticConsumer Client = nullptr,
bool  ShouldOwnClient = true 
)

Create the diagnostics engine using the invocation's diagnostic options and replace any existing one with it.

Note that this routine also replaces the diagnostic client, allocating one if one is not provided.

Parameters
ClientIf non-NULL, a diagnostic client that will be attached to (and, then, owned by) the DiagnosticsEngine inside this AST unit.
ShouldOwnClientIf Client is non-NULL, specifies whether the diagnostic object should take ownership of the client.

Definition at line 322 of file CompilerInstance.cpp.

References getCodeGenOpts(), and getDiagnosticOpts().

Referenced by clang::createInvocationFromCommandLine(), main(), and clang::tooling::FrontendActionFactory::runInvocation().

◆ createDiagnostics() [2/2]

IntrusiveRefCntPtr< DiagnosticsEngine > CompilerInstance::createDiagnostics ( DiagnosticOptions Opts,
DiagnosticConsumer Client = nullptr,
bool  ShouldOwnClient = true,
const CodeGenOptions CodeGenOpts = nullptr 
)
static

Create a DiagnosticsEngine object with a the TextDiagnosticPrinter.

If no diagnostic client is provided, this creates a DiagnosticConsumer that is owned by the returned diagnostic object, if using directly the caller is responsible for releasing the returned DiagnosticsEngine's client eventually.

Parameters
Opts- The diagnostic options; note that the created text diagnostic object contains a reference to these options.
ClientIf non-NULL, a diagnostic client that will be attached to (and, then, owned by) the returned DiagnosticsEngine object.
CodeGenOptsIf non-NULL, the code gen options in use, which may be used by some diagnostics printers (for logging purposes only).
Returns
The new object on success, or null on failure.

Definition at line 329 of file CompilerInstance.cpp.

References clang::DiagnosticOptions::DiagnosticLogFile, clang::DiagnosticOptions::DiagnosticSerializationFile, clang::ProcessWarningOptions(), SetUpDiagnosticLog(), and SetupSerializedDiagnostics().

◆ createFileManager()

FileManager * CompilerInstance::createFileManager ( IntrusiveRefCntPtr< llvm::vfs::FileSystem >  VFS = nullptr)

Create the file manager and replace any existing one with it.

Returns
The new file manager on success, or null on failure.

Definition at line 364 of file CompilerInstance.cpp.

References clang::createVFSFromCompilerInvocation(), getDiagnostics(), getFileSystemOpts(), and getInvocation().

Referenced by clang::FrontendAction::BeginSourceFile().

◆ createFrontendTimer()

void CompilerInstance::createFrontendTimer ( )

Create the frontend timer and replace any existing one with it.

Definition at line 664 of file CompilerInstance.cpp.

◆ createModuleFromSource()

void CompilerInstance::createModuleFromSource ( SourceLocation  Loc,
StringRef  ModuleName,
StringRef  Source 
)
overridevirtual

Attempt to create the given module from the specified source buffer.

Does not load the module or make any submodule visible; for that, use loadModule and makeModuleVisible.

Parameters
LocThe location at which to create the module.
ModuleNameThe name of the module to create.
SourceThe source of the module: a (preprocessed) module map.

Implements clang::ModuleLoader.

Definition at line 2034 of file CompilerInstance.cpp.

References compileModuleImpl(), getDiagnostics(), getLanguageFromOptions(), clang::isAlphanumeric(), clang::InputKind::ModuleMap, clang::DiagnosticsEngine::Report(), and string().

◆ createNullOutputFile()

std::unique_ptr< raw_pwrite_stream > CompilerInstance::createNullOutputFile ( )

Definition at line 757 of file CompilerInstance.cpp.

Referenced by GetOutputStream().

◆ createOutputFile()

std::unique_ptr< raw_pwrite_stream > CompilerInstance::createOutputFile ( StringRef  OutputPath,
bool  Binary,
bool  RemoveFileOnSignal,
bool  UseTemporary,
bool  CreateMissingDirectories = false 
)

Create a new output file, optionally deriving the output path name, and add it to the list of tracked output files.

Returns
- Null on error.

Definition at line 762 of file CompilerInstance.cpp.

References getDiagnostics(), and clang::DiagnosticsEngine::Report().

Referenced by createDefaultOutputFile().

◆ createPCHExternalASTSource() [1/2]

void CompilerInstance::createPCHExternalASTSource ( StringRef  Path,
DisableValidationForModuleKind  DisableValidation,
bool  AllowPCHWithCompilerErrors,
void *  DeserializationListener,
bool  OwnDeserializationListener 
)

Create an external AST source to read a PCH file and attach it to the AST context.

Definition at line 555 of file CompilerInstance.cpp.

References getASTContext(), getFrontendOpts(), getHeaderSearchOpts(), getModuleCache(), getPCHContainerReader(), getPreprocessor(), getPreprocessorOpts(), clang::Preamble, and clang::PreprocessorOptions::PrecompiledPreambleBytes.

◆ createPCHExternalASTSource() [2/2]

IntrusiveRefCntPtr< ASTReader > CompilerInstance::createPCHExternalASTSource ( StringRef  Path,
StringRef  Sysroot,
DisableValidationForModuleKind  DisableValidation,
bool  AllowPCHWithCompilerErrors,
Preprocessor PP,
InMemoryModuleCache ModuleCache,
ASTContext Context,
const PCHContainerReader PCHContainerRdr,
ArrayRef< std::shared_ptr< ModuleFileExtension >>  Extensions,
ArrayRef< std::shared_ptr< DependencyCollector >>  DependencyCollectors,
void *  DeserializationListener,
bool  OwnDeserializationListener,
bool  Preamble,
bool  UseGlobalModuleIndex 
)
static

◆ createPreprocessor()

void CompilerInstance::createPreprocessor ( TranslationUnitKind  TUKind)

◆ createSema()

void CompilerInstance::createSema ( TranslationUnitKind  TUKind,
CodeCompleteConsumer CompletionConsumer 
)

Create the Sema object to be used for parsing.

Definition at line 686 of file CompilerInstance.cpp.

References getASTConsumer(), getASTContext(), and getPreprocessor().

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ createSourceManager()

void CompilerInstance::createSourceManager ( FileManager FileMgr)

Create the source manager and replace any existing one with it.

Definition at line 377 of file CompilerInstance.cpp.

References getDiagnostics().

Referenced by clang::FrontendAction::BeginSourceFile(), main(), and clang::tooling::FrontendActionFactory::runInvocation().

◆ createTarget()

bool CompilerInstance::createTarget ( )

◆ ExecuteAction()

bool CompilerInstance::ExecuteAction ( FrontendAction Act)

ExecuteAction - Execute the provided action against the compiler's CompilerInvocation object.

This function makes the following assumptions:

  • The invocation options should be initialized. This function does not handle the '-help' or '-version' options, clients should handle those directly.
  • The diagnostics engine should have already been created by the client.
  • No other CompilerInstance state should have been initialized (this is an unchecked error).
  • Clients should have initialized any LLVM target features that may be required.
  • Clients should eventually call llvm_shutdown() upon the completion of this routine to ensure that any managed objects are properly destroyed.

Note that this routine may write output to 'stderr'.

Parameters
Act- The action to execute.
Returns
- True on success.

Definition at line 919 of file CompilerInstance.cpp.

References createTarget(), getFrontendOpts(), getHeaderSearchOpts(), getTarget(), getVerboseOutputStream(), hasDiagnostics(), clang::TargetInfo::noSignedCharForObjCBool(), clang::noteBottomOfStack(), clang::FrontendAction::PrepareToExecute(), and clang::frontend::RewriteObjC.

Referenced by clang::ExecuteCompilerInvocation(), main(), and clang::tooling::FrontendActionFactory::runInvocation().

◆ getAnalyzerOpts()

AnalyzerOptionsRef clang::CompilerInstance::getAnalyzerOpts ( )
inline

◆ getASTConsumer()

ASTConsumer& clang::CompilerInstance::getASTConsumer ( ) const
inline

◆ getASTContext()

ASTContext& clang::CompilerInstance::getASTContext ( ) const
inline

◆ getASTReader()

IntrusiveRefCntPtr< ASTReader > CompilerInstance::getASTReader ( ) const

◆ getAuxTarget()

TargetInfo* clang::CompilerInstance::getAuxTarget ( ) const
inline

Definition at line 380 of file CompilerInstance.h.

Referenced by createASTContext(), createPreprocessor(), and createTarget().

◆ getCodeCompletionConsumer()

CodeCompleteConsumer& clang::CompilerInstance::getCodeCompletionConsumer ( ) const
inline

Definition at line 559 of file CompilerInstance.h.

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ getCodeGenOpts() [1/2]

CodeGenOptions& clang::CompilerInstance::getCodeGenOpts ( )
inline

◆ getCodeGenOpts() [2/2]

const CodeGenOptions& clang::CompilerInstance::getCodeGenOpts ( ) const
inline

Definition at line 256 of file CompilerInstance.h.

◆ getDependencyOutputOpts() [1/2]

DependencyOutputOptions& clang::CompilerInstance::getDependencyOutputOpts ( )
inline

Definition at line 260 of file CompilerInstance.h.

Referenced by createPreprocessor().

◆ getDependencyOutputOpts() [2/2]

const DependencyOutputOptions& clang::CompilerInstance::getDependencyOutputOpts ( ) const
inline

Definition at line 263 of file CompilerInstance.h.

◆ getDiagnosticClient()

DiagnosticConsumer& clang::CompilerInstance::getDiagnosticClient ( ) const
inline

◆ getDiagnosticOpts() [1/2]

DiagnosticOptions& clang::CompilerInstance::getDiagnosticOpts ( )
inline

◆ getDiagnosticOpts() [2/2]

const DiagnosticOptions& clang::CompilerInstance::getDiagnosticOpts ( ) const
inline

Definition at line 270 of file CompilerInstance.h.

◆ getDiagnostics()

DiagnosticsEngine& clang::CompilerInstance::getDiagnostics ( ) const
inline

◆ getFileManager()

FileManager& clang::CompilerInstance::getFileManager ( ) const
inline

◆ getFileSystemOpts() [1/2]

FileSystemOptions& clang::CompilerInstance::getFileSystemOpts ( )
inline

◆ getFileSystemOpts() [2/2]

const FileSystemOptions& clang::CompilerInstance::getFileSystemOpts ( ) const
inline

Definition at line 277 of file CompilerInstance.h.

◆ getFrontendOpts() [1/2]

FrontendOptions& clang::CompilerInstance::getFrontendOpts ( )
inline

◆ getFrontendOpts() [2/2]

const FrontendOptions& clang::CompilerInstance::getFrontendOpts ( ) const
inline

Definition at line 284 of file CompilerInstance.h.

◆ getFrontendTimer()

llvm::Timer& clang::CompilerInstance::getFrontendTimer ( ) const
inline

Definition at line 575 of file CompilerInstance.h.

Referenced by clang::FrontendAction::Execute().

◆ getHeaderSearchOpts() [1/2]

HeaderSearchOptions& clang::CompilerInstance::getHeaderSearchOpts ( )
inline

◆ getHeaderSearchOpts() [2/2]

const HeaderSearchOptions& clang::CompilerInstance::getHeaderSearchOpts ( ) const
inline

Definition at line 291 of file CompilerInstance.h.

◆ getHeaderSearchOptsPtr()

std::shared_ptr<HeaderSearchOptions> clang::CompilerInstance::getHeaderSearchOptsPtr ( ) const
inline

Definition at line 294 of file CompilerInstance.h.

Referenced by createPreprocessor().

◆ getInvocation()

CompilerInvocation& clang::CompilerInstance::getInvocation ( )
inline

◆ getLangOpts() [1/2]

LangOptions& clang::CompilerInstance::getLangOpts ( )
inline

◆ getLangOpts() [2/2]

const LangOptions& clang::CompilerInstance::getLangOpts ( ) const
inline

Definition at line 301 of file CompilerInstance.h.

◆ getModuleCache()

InMemoryModuleCache& clang::CompilerInstance::getModuleCache ( ) const
inline

◆ getModuleDepCollector()

std::shared_ptr< ModuleDependencyCollector > CompilerInstance::getModuleDepCollector ( ) const

Definition at line 202 of file CompilerInstance.cpp.

◆ getPCHContainerOperations()

std::shared_ptr<PCHContainerOperations> clang::CompilerInstance::getPCHContainerOperations ( ) const
inline

◆ getPCHContainerReader()

const PCHContainerReader& clang::CompilerInstance::getPCHContainerReader ( ) const
inline

◆ getPCHContainerWriter()

const PCHContainerWriter& clang::CompilerInstance::getPCHContainerWriter ( ) const
inline

◆ getPreprocessor()

Preprocessor& clang::CompilerInstance::getPreprocessor ( ) const
inline

◆ getPreprocessorOpts() [1/2]

PreprocessorOptions& clang::CompilerInstance::getPreprocessorOpts ( )
inline

◆ getPreprocessorOpts() [2/2]

const PreprocessorOptions& clang::CompilerInstance::getPreprocessorOpts ( ) const
inline

Definition at line 308 of file CompilerInstance.h.

◆ getPreprocessorOutputOpts() [1/2]

PreprocessorOutputOptions& clang::CompilerInstance::getPreprocessorOutputOpts ( )
inline

◆ getPreprocessorOutputOpts() [2/2]

const PreprocessorOutputOptions& clang::CompilerInstance::getPreprocessorOutputOpts ( ) const
inline

Definition at line 315 of file CompilerInstance.h.

◆ getPreprocessorPtr()

std::shared_ptr<Preprocessor> clang::CompilerInstance::getPreprocessorPtr ( )
inline

Definition at line 446 of file CompilerInstance.h.

◆ getSema()

Sema& clang::CompilerInstance::getSema ( ) const
inline

◆ getSourceManager()

SourceManager& clang::CompilerInstance::getSourceManager ( ) const
inline

◆ getSpecificModuleCachePath() [1/2]

std::string clang::CompilerInstance::getSpecificModuleCachePath ( )
inline

Definition at line 647 of file CompilerInstance.h.

References getInvocation().

Referenced by createPreprocessor().

◆ getSpecificModuleCachePath() [2/2]

std::string CompilerInstance::getSpecificModuleCachePath ( StringRef  ModuleHash)

Definition at line 534 of file CompilerInstance.cpp.

References getHeaderSearchOpts(), and string().

Referenced by clang::FrontendAction::BeginSourceFile().

◆ getTarget()

TargetInfo& clang::CompilerInstance::getTarget ( ) const
inline

◆ getTargetOpts() [1/2]

TargetOptions& clang::CompilerInstance::getTargetOpts ( )
inline

◆ getTargetOpts() [2/2]

const TargetOptions& clang::CompilerInstance::getTargetOpts ( ) const
inline

Definition at line 322 of file CompilerInstance.h.

◆ getVerboseOutputStream()

raw_ostream& clang::CompilerInstance::getVerboseOutputStream ( )
inline

Get the current stream for verbose output.

Definition at line 358 of file CompilerInstance.h.

Referenced by ExecuteAction().

◆ getVirtualFileSystem()

llvm::vfs::FileSystem & CompilerInstance::getVirtualFileSystem ( ) const

◆ hadModuleLoaderFatalFailure()

bool clang::CompilerInstance::hadModuleLoaderFatalFailure ( ) const
inline

Definition at line 804 of file CompilerInstance.h.

References clang::ModuleLoader::HadFatalFailure.

◆ hasASTConsumer()

bool clang::CompilerInstance::hasASTConsumer ( ) const
inline

Definition at line 482 of file CompilerInstance.h.

Referenced by clang::FrontendAction::BeginSourceFile(), and createASTReader().

◆ hasASTContext()

bool clang::CompilerInstance::hasASTContext ( ) const
inline

Definition at line 459 of file CompilerInstance.h.

Referenced by createASTReader().

◆ hasCodeCompletionConsumer()

bool clang::CompilerInstance::hasCodeCompletionConsumer ( ) const
inline

Definition at line 557 of file CompilerInstance.h.

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ hasDiagnostics()

bool clang::CompilerInstance::hasDiagnostics ( ) const
inline

◆ hasFileManager()

bool clang::CompilerInstance::hasFileManager ( ) const
inline

◆ hasFrontendTimer()

bool clang::CompilerInstance::hasFrontendTimer ( ) const
inline

Definition at line 573 of file CompilerInstance.h.

Referenced by clang::FrontendAction::Execute().

◆ hasInvocation()

bool clang::CompilerInstance::hasInvocation ( ) const
inline

Definition at line 226 of file CompilerInstance.h.

◆ hasPreprocessor()

bool clang::CompilerInstance::hasPreprocessor ( ) const
inline

◆ hasSema()

bool clang::CompilerInstance::hasSema ( ) const
inline

Definition at line 500 of file CompilerInstance.h.

Referenced by createASTReader(), and clang::ASTFrontendAction::ExecuteAction().

◆ hasSourceManager()

bool clang::CompilerInstance::hasSourceManager ( ) const
inline

Definition at line 418 of file CompilerInstance.h.

Referenced by clang::FrontendAction::BeginSourceFile().

◆ hasTarget()

bool clang::CompilerInstance::hasTarget ( ) const
inline

Definition at line 366 of file CompilerInstance.h.

References clang::Target.

Referenced by createTarget().

◆ InitializeSourceManager() [1/2]

bool CompilerInstance::InitializeSourceManager ( const FrontendInputFile Input)

InitializeSourceManager - Initialize the source manager to set InputFile as the main file.

Returns
True on success.

Definition at line 870 of file CompilerInstance.cpp.

References getDiagnostics(), getFileManager(), and getSourceManager().

Referenced by clang::FrontendAction::BeginSourceFile().

◆ InitializeSourceManager() [2/2]

bool CompilerInstance::InitializeSourceManager ( const FrontendInputFile Input,
DiagnosticsEngine Diags,
FileManager FileMgr,
SourceManager SourceMgr 
)
static

◆ loadGlobalModuleIndex()

GlobalModuleIndex * CompilerInstance::loadGlobalModuleIndex ( SourceLocation  TriggerLoc)
overridevirtual

Load, create, or return global module.

This function returns an existing global module index, if one had already been loaded or created, or loads one if it exists, or creates one if it doesn't exist. Also, importantly, if the index doesn't cover all the modules in the module map, it will be update to do so here, because of its use in searching for needed module imports and associated fixit messages.

Parameters
TriggerLocThe location for what triggered the load.
Returns
Returns null if load failed.

Implements clang::ModuleLoader.

Definition at line 2098 of file CompilerInstance.cpp.

References clang::ModuleLoader::buildingModule(), createASTReader(), clang::Module::DefinitionLoc, clang::Module::getASTFile(), getFileManager(), clang::Preprocessor::getHeaderSearchInfo(), clang::HeaderSearch::getModuleMap(), getPCHContainerReader(), getPreprocessor(), hasFileManager(), hasPreprocessor(), clang::Module::Hidden, loadModule(), clang::ModuleMap::module_begin(), clang::ModuleMap::module_end(), clang::Module::Name, shouldBuildGlobalModuleIndex(), and clang::GlobalModuleIndex::writeIndex().

◆ loadModule()

ModuleLoadResult CompilerInstance::loadModule ( SourceLocation  ImportLoc,
ModuleIdPath  Path,
Module::NameVisibilityKind  Visibility,
bool  IsInclusionDirective 
)
overridevirtual

Attempt to load the given module.

This routine attempts to load the module described by the given parameters. If there is a module cache, this may implicitly compile the module before loading it.

Parameters
ImportLocThe location of the 'import' keyword.
PathThe identifiers (and their locations) of the module "path", e.g., "std.vector" would be split into "std" and "vector".
VisibilityThe visibility provided for the names in the loaded module.
IsInclusionDirectiveIndicates that this module is being loaded implicitly, due to the presence of an inclusion directive. Otherwise, it is being loaded due to an import declaration.
Returns
If successful, returns the loaded module. Otherwise, returns NULL to indicate that the module could not be loaded.

FIXME: perhaps we should (a) look for a module using the module name

Implements clang::ModuleLoader.

Definition at line 1839 of file CompilerInstance.cpp.

References clang::ModuleMap::cacheModuleLoad(), clang::ModuleMap::getCachedModuleLoad(), clang::Preprocessor::getHeaderSearchInfo(), getLangOpts(), clang::HeaderSearch::getModuleMap(), getPreprocessor(), and clang::SourceLocation::isValid().

Referenced by loadGlobalModuleIndex().

◆ loadModuleFile()

bool CompilerInstance::loadModuleFile ( StringRef  FileName)

◆ lookupMissingImports()

bool CompilerInstance::lookupMissingImports ( StringRef  Name,
SourceLocation  TriggerLoc 
)
overridevirtual

Check global module index for missing imports.

Parameters
NameThe symbol name to look for.
TriggerLocThe location for what triggered the load.
Returns
Returns true if any modules with that symbol found.

Implements clang::ModuleLoader.

Definition at line 2168 of file CompilerInstance.cpp.

◆ makeModuleVisible()

void CompilerInstance::makeModuleVisible ( Module Mod,
Module::NameVisibilityKind  Visibility,
SourceLocation  ImportLoc 
)
overridevirtual

Make the given module visible.

Implements clang::ModuleLoader.

Definition at line 2087 of file CompilerInstance.cpp.

References createASTReader().

◆ resetAndLeakASTContext()

void clang::CompilerInstance::resetAndLeakASTContext ( )
inline

Definition at line 466 of file CompilerInstance.h.

Referenced by clang::FrontendAction::EndSourceFile().

◆ resetAndLeakFileManager()

void clang::CompilerInstance::resetAndLeakFileManager ( )
inline

Definition at line 406 of file CompilerInstance.h.

Referenced by clang::FrontendAction::EndSourceFile().

◆ resetAndLeakPreprocessor()

void clang::CompilerInstance::resetAndLeakPreprocessor ( )
inline

Definition at line 448 of file CompilerInstance.h.

Referenced by clang::FrontendAction::EndSourceFile().

◆ resetAndLeakSema()

void CompilerInstance::resetAndLeakSema ( )

Definition at line 2191 of file CompilerInstance.cpp.

References takeSema().

Referenced by clang::FrontendAction::EndSourceFile().

◆ resetAndLeakSourceManager()

void clang::CompilerInstance::resetAndLeakSourceManager ( )
inline

Definition at line 426 of file CompilerInstance.h.

Referenced by clang::FrontendAction::EndSourceFile().

◆ setASTConsumer()

void CompilerInstance::setASTConsumer ( std::unique_ptr< ASTConsumer Value)

setASTConsumer - Replace the current AST consumer; the compiler instance takes ownership of Value.

Definition at line 177 of file CompilerInstance.cpp.

References getASTConsumer(), getASTContext(), and clang::ASTConsumer::Initialize().

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::FrontendAction::EndSourceFile().

◆ setASTContext()

void CompilerInstance::setASTContext ( ASTContext Value)

setASTContext - Replace the current AST context.

Definition at line 166 of file CompilerInstance.cpp.

References getASTConsumer(), getASTContext(), and clang::ASTConsumer::Initialize().

Referenced by clang::FrontendAction::BeginSourceFile(), createASTContext(), and clang::FrontendAction::EndSourceFile().

◆ setASTReader()

void CompilerInstance::setASTReader ( IntrusiveRefCntPtr< ASTReader Reader)

Definition at line 195 of file CompilerInstance.cpp.

◆ setAuxTarget()

void CompilerInstance::setAuxTarget ( TargetInfo Value)

Replace the current AuxTarget.

Definition at line 98 of file CompilerInstance.cpp.

Referenced by createTarget().

◆ setBuildGlobalModuleIndex()

void clang::CompilerInstance::setBuildGlobalModuleIndex ( bool  Build)
inline

Set the flag indicating whether we should (re)build the global module index.

Definition at line 241 of file CompilerInstance.h.

Referenced by compileModule().

◆ setCodeCompletionConsumer()

void CompilerInstance::setCodeCompletionConsumer ( CodeCompleteConsumer Value)

setCodeCompletionConsumer - Replace the current code completion consumer; the compiler instance takes ownership of Value.

Definition at line 184 of file CompilerInstance.cpp.

Referenced by createCodeCompletionConsumer().

◆ setDiagnostics()

void CompilerInstance::setDiagnostics ( DiagnosticsEngine Value)

setDiagnostics - Replace the current diagnostics engine.

Definition at line 83 of file CompilerInstance.cpp.

◆ setExternalSemaSource()

void CompilerInstance::setExternalSemaSource ( IntrusiveRefCntPtr< ExternalSemaSource ESS)

Definition at line 2193 of file CompilerInstance.cpp.

◆ setFileManager()

void CompilerInstance::setFileManager ( FileManager Value)

◆ setInvocation()

void CompilerInstance::setInvocation ( std::shared_ptr< CompilerInvocation Value)

setInvocation - Replace the current invocation.

Definition at line 71 of file CompilerInstance.cpp.

Referenced by main(), and clang::tooling::FrontendActionFactory::runInvocation().

◆ setModuleDepCollector()

void CompilerInstance::setModuleDepCollector ( std::shared_ptr< ModuleDependencyCollector Collector)

Definition at line 206 of file CompilerInstance.cpp.

◆ setOutputStream()

void clang::CompilerInstance::setOutputStream ( std::unique_ptr< llvm::raw_pwrite_stream >  OutStream)
inline

}

Definition at line 764 of file CompilerInstance.h.

◆ setPreprocessor()

void CompilerInstance::setPreprocessor ( std::shared_ptr< Preprocessor Value)

Replace the current preprocessor.

Definition at line 162 of file CompilerInstance.cpp.

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::FrontendAction::EndSourceFile().

◆ setSema()

void CompilerInstance::setSema ( Sema S)

Replace the current Sema; the compiler instance takes ownership of S.

Definition at line 173 of file CompilerInstance.cpp.

Referenced by clang::FrontendAction::EndSourceFile().

◆ setSourceManager()

void CompilerInstance::setSourceManager ( SourceManager Value)

setSourceManager - Replace the current source manager.

Definition at line 158 of file CompilerInstance.cpp.

Referenced by clang::FixItRecompile::BeginInvocation(), clang::FrontendAction::BeginSourceFile(), and clang::FrontendAction::EndSourceFile().

◆ setTarget()

void CompilerInstance::setTarget ( TargetInfo Value)

Replace the current Target.

Definition at line 97 of file CompilerInstance.cpp.

Referenced by createTarget().

◆ setVerboseOutputStream() [1/2]

void CompilerInstance::setVerboseOutputStream ( raw_ostream &  Value)

Replace the current stream for verbose output.

Definition at line 87 of file CompilerInstance.cpp.

◆ setVerboseOutputStream() [2/2]

void CompilerInstance::setVerboseOutputStream ( std::unique_ptr< raw_ostream >  Value)

Replace the current stream for verbose output.

Definition at line 92 of file CompilerInstance.cpp.

◆ shouldBuildGlobalModuleIndex()

bool CompilerInstance::shouldBuildGlobalModuleIndex ( ) const

Indicates whether we should (re)build the global module index.

Definition at line 76 of file CompilerInstance.cpp.

References getFrontendOpts().

Referenced by clang::FrontendAction::Execute(), and loadGlobalModuleIndex().

◆ takeASTConsumer()

std::unique_ptr<ASTConsumer> clang::CompilerInstance::takeASTConsumer ( )
inline

takeASTConsumer - Remove the current AST consumer and give ownership to the caller.

Definition at line 491 of file CompilerInstance.h.

Referenced by clang::FrontendAction::EndSourceFile().

◆ takeOutputStream()

std::unique_ptr<llvm::raw_pwrite_stream> clang::CompilerInstance::takeOutputStream ( )
inline

Definition at line 768 of file CompilerInstance.h.

Referenced by clang::CodeGenAction::CreateASTConsumer().

◆ takeSema()

std::unique_ptr< Sema > CompilerInstance::takeSema ( )

Definition at line 188 of file CompilerInstance.cpp.

Referenced by resetAndLeakSema().


The documentation for this class was generated from the following files: