clang  16.0.0git
Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::CompilerInvocation Class Reference

Helper class for holding the data necessary to invoke the compiler. More...

#include "clang/Frontend/CompilerInvocation.h"

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

Public Types

using StringAllocator = llvm::function_ref< const char *(const llvm::Twine &)>
 

Public Member Functions

std::string getModuleHash () const
 Retrieve a module hash string that is suitable for uniquely identifying the conditions under which the module was built. More...
 
void generateCC1CommandLine (llvm::SmallVectorImpl< const char * > &Args, StringAllocator SA) const
 Generate cc1-compatible command line arguments from this instance. More...
 
std::vector< std::stringgetCC1CommandLine () const
 Generate cc1-compatible command line arguments from this instance, wrapping the result as a std::vector<std::string>. More...
 
void resetNonModularOptions ()
 Reset all of the options that are not considered when building a module. More...
 
void clearImplicitModuleBuildOptions ()
 Disable implicit modules and canonicalize options that are only used by implicit modules. More...
 
- Public Member Functions inherited from clang::CompilerInvocationRefBase
 CompilerInvocationRefBase ()
 
 CompilerInvocationRefBase (const CompilerInvocationRefBase &X)
 
 CompilerInvocationRefBase (CompilerInvocationRefBase &&X)
 
CompilerInvocationRefBaseoperator= (CompilerInvocationRefBase X)
 
CompilerInvocationRefBaseoperator= (CompilerInvocationRefBase &&X)
 
 ~CompilerInvocationRefBase ()
 
LangOptionsgetLangOpts ()
 
const LangOptionsgetLangOpts () const
 
TargetOptionsgetTargetOpts ()
 
const TargetOptionsgetTargetOpts () const
 
DiagnosticOptionsgetDiagnosticOpts () const
 
HeaderSearchOptionsgetHeaderSearchOpts ()
 
const HeaderSearchOptionsgetHeaderSearchOpts () const
 
std::shared_ptr< HeaderSearchOptionsgetHeaderSearchOptsPtr () const
 
std::shared_ptr< PreprocessorOptionsgetPreprocessorOptsPtr ()
 
PreprocessorOptionsgetPreprocessorOpts ()
 
const PreprocessorOptionsgetPreprocessorOpts () const
 
AnalyzerOptionsRef getAnalyzerOpts () const
 
- Public Member Functions inherited from clang::CompilerInvocationValueBase
MigratorOptionsgetMigratorOpts ()
 
const MigratorOptionsgetMigratorOpts () const
 
CodeGenOptionsgetCodeGenOpts ()
 
const CodeGenOptionsgetCodeGenOpts () const
 
DependencyOutputOptionsgetDependencyOutputOpts ()
 
const DependencyOutputOptionsgetDependencyOutputOpts () const
 
FileSystemOptionsgetFileSystemOpts ()
 
const FileSystemOptionsgetFileSystemOpts () const
 
FrontendOptionsgetFrontendOpts ()
 
const FrontendOptionsgetFrontendOpts () const
 
PreprocessorOutputOptionsgetPreprocessorOutputOpts ()
 
const PreprocessorOutputOptionsgetPreprocessorOutputOpts () const
 

Static Public Member Functions

static bool CreateFromArgs (CompilerInvocation &Res, ArrayRef< const char * > CommandLineArgs, DiagnosticsEngine &Diags, const char *Argv0=nullptr)
 Create a compiler invocation from a list of input options. More...
 
static std::string GetResourcesPath (const char *Argv0, void *MainAddr)
 Get the directory where the compiler headers reside, relative to the compiler binary (found by the passed in arguments). More...
 

Additional Inherited Members

- Public Attributes inherited from clang::CompilerInvocationRefBase
std::shared_ptr< LangOptionsLangOpts
 Options controlling the language variant. More...
 
std::shared_ptr< TargetOptionsTargetOpts
 Options controlling the target. More...
 
IntrusiveRefCntPtr< DiagnosticOptionsDiagnosticOpts
 Options controlling the diagnostic engine. More...
 
std::shared_ptr< HeaderSearchOptionsHeaderSearchOpts
 Options controlling the #include directive. More...
 
std::shared_ptr< PreprocessorOptionsPreprocessorOpts
 Options controlling the preprocessor (aside from #include handling). More...
 
AnalyzerOptionsRef AnalyzerOpts
 Options controlling the static analyzer. More...
 
- Protected Attributes inherited from clang::CompilerInvocationValueBase
MigratorOptions MigratorOpts
 
CodeGenOptions CodeGenOpts
 Options controlling IRgen and the backend. More...
 
DependencyOutputOptions DependencyOutputOpts
 Options controlling dependency output. More...
 
FileSystemOptions FileSystemOpts
 Options controlling file system operations. More...
 
FrontendOptions FrontendOpts
 Options controlling the frontend itself. More...
 
PreprocessorOutputOptions PreprocessorOutputOpts
 Options controlling preprocessed output. More...
 

Detailed Description

Helper class for holding the data necessary to invoke the compiler.

This class is designed to represent an abstract "invocation" of the compiler, including data such as the include paths, the code generation options, the warning flags, and so on.

Definition at line 193 of file CompilerInvocation.h.

Member Typedef Documentation

◆ StringAllocator

using clang::CompilerInvocation::StringAllocator = llvm::function_ref<const char *(const llvm::Twine &)>

Definition at line 226 of file CompilerInvocation.h.

Member Function Documentation

◆ clearImplicitModuleBuildOptions()

void CompilerInvocation::clearImplicitModuleBuildOptions ( )

◆ CreateFromArgs()

bool CompilerInvocation::CreateFromArgs ( CompilerInvocation Res,
ArrayRef< const char * >  CommandLineArgs,
DiagnosticsEngine Diags,
const char *  Argv0 = nullptr 
)
static

Create a compiler invocation from a list of input options.

Returns
true on success.
false if an error was encountered while parsing the arguments and attempts to recover and continue parsing the rest of the arguments. The recovery is best-effort and only guarantees that Res will end up in one of the vaild-to-access (albeit arbitrary) states.
Parameters
[out]Res- The resulting invocation.
[in]CommandLineArgs- Array of argument strings, this must not contain "-cc1".

Definition at line 4562 of file CompilerInvocation.cpp.

References generateCC1CommandLine(), and RoundTrip().

Referenced by clang::createInvocation(), main(), and clang::tooling::newInvocation().

◆ generateCC1CommandLine()

void CompilerInvocation::generateCC1CommandLine ( llvm::SmallVectorImpl< const char * > &  Args,
StringAllocator  SA 
) const

Generate cc1-compatible command line arguments from this instance.

Parameters
[out]Args- The generated arguments. Note that the caller is responsible for inserting the path to the clang executable and "-cc1" if desired.
SA- A function that given a Twine can allocate storage for a given command line argument and return a pointer to the newly allocated string. The returned pointer is what gets appended to Args.

Definition at line 4677 of file CompilerInvocation.cpp.

References clang::CompilerInvocationRefBase::AnalyzerOpts, clang::CompilerInvocationValueBase::CodeGenOpts, clang::FrontendOptions::DashX, clang::CompilerInvocationValueBase::DependencyOutputOpts, clang::CompilerInvocationRefBase::DiagnosticOpts, clang::CompilerInvocationValueBase::FileSystemOpts, clang::CompilerInvocationValueBase::FrontendOpts, GenerateAnalyzerArgs(), GenerateDependencyOutputArgs(), GenerateFileSystemArgs(), GenerateFrontendArgs(), GenerateHeaderSearchArgs(), GenerateMigratorArgs(), GeneratePreprocessorArgs(), GeneratePreprocessorOutputArgs(), GenerateTargetArgs(), clang::CompilerInvocationRefBase::HeaderSearchOpts, clang::CompilerInvocationRefBase::LangOpts, clang::CompilerInvocationValueBase::MigratorOpts, clang::FrontendOptions::OutputFile, clang::CompilerInvocationRefBase::PreprocessorOpts, clang::CompilerInvocationValueBase::PreprocessorOutputOpts, clang::FrontendOptions::ProgramAction, and clang::CompilerInvocationRefBase::TargetOpts.

Referenced by CreateFromArgs(), and getModuleContextHash().

◆ getCC1CommandLine()

std::vector< std::string > CompilerInvocation::getCC1CommandLine ( ) const

Generate cc1-compatible command line arguments from this instance, wrapping the result as a std::vector<std::string>.

This is a (less-efficient) wrapper over generateCC1CommandLine().

Definition at line 4698 of file CompilerInvocation.cpp.

◆ getModuleHash()

std::string CompilerInvocation::getModuleHash ( ) const

Retrieve a module hash string that is suitable for uniquely identifying the conditions under which the module was built.

Definition at line 4581 of file CompilerInvocation.cpp.

References clang::SanitizerSet::clear(), clang::PreprocessorOptions::DetailedRecord, clang::SanitizerSet::empty(), clang::getClangFullRepositoryVersion(), clang::CompilerInvocationValueBase::getCodeGenOpts(), clang::CompilerInvocationRefBase::getDiagnosticOpts(), clang::CompilerInvocationValueBase::getFrontendOpts(), clang::CompilerInvocationRefBase::getHeaderSearchOpts(), clang::getPPTransparentSanitizers(), clang::CompilerInvocationRefBase::getPreprocessorOpts(), clang::CompilerInvocationRefBase::LangOpts, clang::SanitizerSet::Mask, clang::HeaderSearchOptions::ModuleFormat, clang::HeaderSearchOptions::ModulesIgnoreMacros, clang::HeaderSearchOptions::ModulesStrictContextHash, clang::HeaderSearchOptions::ModulesValidateDiagnosticOptions, clang::HeaderSearchOptions::ModuleUserBuildPath, clang::HeaderSearchOptions::ResourceDir, clang::HeaderSearchOptions::Sysroot, clang::HeaderSearchOptions::SystemHeaderPrefixes, clang::CompilerInvocationRefBase::TargetOpts, clang::threadSafety::sx::toString(), clang::HeaderSearchOptions::UseBuiltinIncludes, clang::HeaderSearchOptions::UseDebugInfo, clang::HeaderSearchOptions::UseLibcxx, clang::PreprocessorOptions::UsePredefines, clang::HeaderSearchOptions::UserEntries, clang::HeaderSearchOptions::UseStandardCXXIncludes, clang::HeaderSearchOptions::UseStandardSystemIncludes, clang::serialization::VERSION_MAJOR, and clang::serialization::VERSION_MINOR.

Referenced by clang::CompilerInstance::createPreprocessor(), and clang::tooling::dependencies::ModuleDepCollectorPP::FileChanged().

◆ GetResourcesPath()

std::string CompilerInvocation::GetResourcesPath ( const char *  Argv0,
void *  MainAddr 
)
static

Get the directory where the compiler headers reside, relative to the compiler binary (found by the passed in arguments).

Parameters
Argv0- The program path (from argv[0]), for finding the builtin compiler path.
MainAddr- The address of main (or some other function in the main executable), for finding the builtin compiler path.

Definition at line 2949 of file CompilerInvocation.cpp.

References string().

Referenced by injectResourceDir().

◆ resetNonModularOptions()

void CompilerInvocation::resetNonModularOptions ( )

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