clang 22.0.0git
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:
[legend]

Public Member Functions

 CompilerInvocation ()=default
 CompilerInvocation (const CompilerInvocation &X)
 CompilerInvocation (CompilerInvocation &&)=default
CompilerInvocation & operator= (const CompilerInvocation &X)
 ~CompilerInvocation ()=default
 CompilerInvocation (const CowCompilerInvocation &X)
CompilerInvocation & operator= (const CowCompilerInvocation &X)
std::string getModuleHash () const
 Retrieve a module hash string that is suitable for uniquely identifying the conditions under which the module was built.
void resetNonModularOptions ()
 Reset all of the options that are not considered when building a module.
void clearImplicitModuleBuildOptions ()
 Disable implicit modules and canonicalize options that are only used by implicit modules.
LangOptions & getLangOpts ()
 Mutable getters.
TargetOptions & getTargetOpts ()
DiagnosticOptions & getDiagnosticOpts ()
HeaderSearchOptions & getHeaderSearchOpts ()
PreprocessorOptions & getPreprocessorOpts ()
AnalyzerOptions & getAnalyzerOpts ()
MigratorOptions & getMigratorOpts ()
APINotesOptions & getAPINotesOpts ()
CodeGenOptions & getCodeGenOpts ()
FileSystemOptions & getFileSystemOpts ()
FrontendOptions & getFrontendOpts ()
DependencyOutputOptions & getDependencyOutputOpts ()
PreprocessorOutputOptions & getPreprocessorOutputOpts ()
const LangOptions & getLangOpts () const
 Const getters.
const TargetOptions & getTargetOpts () const
const DiagnosticOptions & getDiagnosticOpts () const
const HeaderSearchOptions & getHeaderSearchOpts () const
const PreprocessorOptions & getPreprocessorOpts () const
const AnalyzerOptions & getAnalyzerOpts () const
const MigratorOptions & getMigratorOpts () const
const APINotesOptions & getAPINotesOpts () const
const CodeGenOptions & getCodeGenOpts () const
const FileSystemOptions & getFileSystemOpts () const
const FrontendOptions & getFrontendOpts () const
const DependencyOutputOptions & getDependencyOutputOpts () const
const PreprocessorOutputOptions & getPreprocessorOutputOpts () const
Public Member Functions inherited from clang::CompilerInvocationBase
const LangOptions & getLangOpts () const
 Const getters.
const TargetOptions & getTargetOpts () const
const DiagnosticOptions & getDiagnosticOpts () const
const HeaderSearchOptions & getHeaderSearchOpts () const
const PreprocessorOptions & getPreprocessorOpts () const
const AnalyzerOptions & getAnalyzerOpts () const
const MigratorOptions & getMigratorOpts () const
const APINotesOptions & getAPINotesOpts () const
const CodeGenOptions & getCodeGenOpts () const
const FileSystemOptions & getFileSystemOpts () const
const FrontendOptions & getFrontendOpts () const
const DependencyOutputOptions & getDependencyOutputOpts () const
const PreprocessorOutputOptions & getPreprocessorOutputOpts () const
void visitPaths (llvm::function_ref< bool(StringRef)> Callback) const
 Visitation.
void generateCC1CommandLine (llvm::SmallVectorImpl< const char * > &Args, StringAllocator SA) const
 Generate cc1-compatible command line arguments from this instance.
void generateCC1CommandLine (ArgumentConsumer Consumer) const
 Generate cc1-compatible command line arguments from this instance.
std::vector< std::string > getCC1CommandLine () const
 Generate cc1-compatible command line arguments from this instance, wrapping the result as a std::vector<std::string>.

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.
static void setDefaultPointerAuthOptions (PointerAuthOptions &Opts, const LangOptions &LangOpts, const llvm::Triple &Triple)
 Populate Opts with the default set of pointer authentication-related options given LangOpts and Triple.
static bool checkCC1RoundTrip (ArrayRef< const char * > Args, DiagnosticsEngine &Diags, const char *Argv0=nullptr)
 Check that Args can be parsed and re-serialized without change, emiting diagnostics for any differences.

Additional Inherited Members

using StringAllocator = llvm::function_ref<const char *(const Twine &)>
 Command line generation.
using ArgumentConsumer = llvm::function_ref<void(const Twine &)>
Protected Member Functions inherited from clang::CompilerInvocationBase
 CompilerInvocationBase ()
 CompilerInvocationBase (EmptyConstructor)
 CompilerInvocationBase (const CompilerInvocationBase &X)=delete
 CompilerInvocationBase (CompilerInvocationBase &&X)=default
CompilerInvocationBase & operator= (const CompilerInvocationBase &X)=delete
CompilerInvocationBase & deep_copy_assign (const CompilerInvocationBase &X)
CompilerInvocationBase & shallow_copy_assign (const CompilerInvocationBase &X)
CompilerInvocationBase & operator= (CompilerInvocationBase &&X)=default
 ~CompilerInvocationBase ()=default
void visitPathsImpl (llvm::function_ref< bool(std::string &)> Predicate)
 Visits paths stored in the invocation.
Protected Attributes inherited from clang::CompilerInvocationBase
std::shared_ptr< LangOptions > LangOpts
 Options controlling the language variant.
std::shared_ptr< TargetOptions > TargetOpts
 Options controlling the target.
std::shared_ptr< DiagnosticOptions > DiagnosticOpts
 Options controlling the diagnostic engine.
std::shared_ptr< HeaderSearchOptions > HSOpts
 Options controlling the #include directive.
std::shared_ptr< PreprocessorOptions > PPOpts
 Options controlling the preprocessor (aside from #include handling).
std::shared_ptr< AnalyzerOptions > AnalyzerOpts
 Options controlling the static analyzer.
std::shared_ptr< MigratorOptions > MigratorOpts
std::shared_ptr< APINotesOptions > APINotesOpts
 Options controlling API notes.
std::shared_ptr< CodeGenOptions > CodeGenOpts
 Options controlling IRgen and the backend.
std::shared_ptr< FileSystemOptions > FSOpts
 Options controlling file system operations.
std::shared_ptr< FrontendOptions > FrontendOpts
 Options controlling the frontend itself.
std::shared_ptr< DependencyOutputOptions > DependencyOutputOpts
 Options controlling dependency output.
std::shared_ptr< PreprocessorOutputOptions > PreprocessorOutputOpts
 Options controlling preprocessed output.

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 229 of file CompilerInvocation.h.

Constructor & Destructor Documentation

◆ CompilerInvocation() [1/4]

clang::CompilerInvocation::CompilerInvocation ( )
default

Referenced by checkCC1RoundTrip(), CompilerInvocation(), CompilerInvocation(), CreateFromArgs(), operator=(), and ~CompilerInvocation().

◆ CompilerInvocation() [2/4]

clang::CompilerInvocation::CompilerInvocation ( const CompilerInvocation & X)
inline

Definition at line 232 of file CompilerInvocation.h.

References CompilerInvocation(), clang::CompilerInvocationBase::CompilerInvocationBase(), clang::CompilerInvocationBase::deep_copy_assign(), and X.

◆ CompilerInvocation() [3/4]

clang::CompilerInvocation::CompilerInvocation ( CompilerInvocation && )
default

References CompilerInvocation().

◆ ~CompilerInvocation()

clang::CompilerInvocation::~CompilerInvocation ( )
default

References CompilerInvocation(), clang::CompilerInvocationBase::getAnalyzerOpts(), clang::CompilerInvocationBase::getAPINotesOpts(), clang::CompilerInvocationBase::getCodeGenOpts(), clang::CompilerInvocationBase::getDependencyOutputOpts(), clang::CompilerInvocationBase::getDiagnosticOpts(), clang::CompilerInvocationBase::getFileSystemOpts(), clang::CompilerInvocationBase::getFrontendOpts(), clang::CompilerInvocationBase::getHeaderSearchOpts(), clang::CompilerInvocationBase::getLangOpts(), clang::CompilerInvocationBase::getMigratorOpts(), clang::CompilerInvocationBase::getPreprocessorOpts(), clang::CompilerInvocationBase::getPreprocessorOutputOpts(), clang::CompilerInvocationBase::getTargetOpts(), and X.

◆ CompilerInvocation() [4/4]

CompilerInvocation::CompilerInvocation ( const CowCompilerInvocation & X)
explicit

Definition at line 178 of file CompilerInvocation.cpp.

References clang::CompilerInvocationBase::CompilerInvocationBase(), clang::CompilerInvocationBase::deep_copy_assign(), and X.

Member Function Documentation

◆ checkCC1RoundTrip()

bool CompilerInvocation::checkCC1RoundTrip ( ArrayRef< const char * > Args,
DiagnosticsEngine & Diags,
const char * Argv0 = nullptr )
static

Check that Args can be parsed and re-serialized without change, emiting diagnostics for any differences.

This check is only suitable for command-lines that are expected to already be canonical.

Returns
false if there are any errors.

Definition at line 878 of file CompilerInvocation.cpp.

References CompilerInvocation(), clang::CompilerInvocationBase::generateCC1CommandLine(), and RoundTrip().

◆ clearImplicitModuleBuildOptions()

void CompilerInvocation::clearImplicitModuleBuildOptions ( )

Disable implicit modules and canonicalize options that are only used by implicit modules.

so use the default values so they may be dropped from the command-line.

Definition at line 5375 of file CompilerInvocation.cpp.

References clang::HeaderSearchOptions::BuildSessionTimestamp, getHeaderSearchOpts(), getLangOpts(), clang::HeaderSearchOptions::ImplicitModuleMaps, clang::HeaderSearchOptions::ModuleCachePath, clang::HeaderSearchOptions::ModuleCachePruneAfter, clang::HeaderSearchOptions::ModuleCachePruneInterval, and clang::HeaderSearchOptions::ModulesValidateOncePerBuildSession.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), and makeCommonInvocationForModuleBuild().

◆ 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 5095 of file CompilerInvocation.cpp.

References CompilerInvocation(), clang::CompilerInvocationBase::generateCC1CommandLine(), and RoundTrip().

Referenced by clang::tooling::dependencies::createCompilerInvocation(), clang::createInvocation(), clang::tooling::dependencies::CompilerInstanceWithContext::initialize(), clang::tooling::newInvocation(), and clang::TestAST::TestAST().

◆ getAnalyzerOpts() [1/2]

AnalyzerOptions & clang::CompilerInvocation::getAnalyzerOpts ( )
inline

Definition at line 272 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::AnalyzerOpts.

◆ getAnalyzerOpts() [2/2]

const AnalyzerOptions & clang::CompilerInvocationBase::getAnalyzerOpts ( ) const
inline

Definition at line 141 of file CompilerInvocation.h.

◆ getAPINotesOpts() [1/2]

APINotesOptions & clang::CompilerInvocation::getAPINotesOpts ( )
inline

Definition at line 274 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::APINotesOpts.

Referenced by getModuleHash().

◆ getAPINotesOpts() [2/2]

const APINotesOptions & clang::CompilerInvocationBase::getAPINotesOpts ( ) const
inline

Definition at line 143 of file CompilerInvocation.h.

◆ getCodeGenOpts() [1/2]

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

Definition at line 275 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::CodeGenOpts.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), FixupInvocation(), getModuleHash(), makeCommonInvocationForModuleBuild(), clang::tooling::newInvocation(), and resetNonModularOptions().

◆ getCodeGenOpts() [2/2]

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

Definition at line 144 of file CompilerInvocation.h.

◆ getDependencyOutputOpts() [1/2]

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

Definition at line 278 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::DependencyOutputOpts.

Referenced by makeCommonInvocationForModuleBuild(), and clang::tooling::dependencies::takeAndUpdateDependencyOutputOptionsFrom().

◆ getDependencyOutputOpts() [2/2]

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

Definition at line 147 of file CompilerInvocation.h.

◆ getDiagnosticOpts() [1/2]

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

Definition at line 269 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::DiagnosticOpts.

Referenced by getModuleHash(), and makeCommonInvocationForModuleBuild().

◆ getDiagnosticOpts() [2/2]

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

Definition at line 138 of file CompilerInvocation.h.

◆ getFileSystemOpts() [1/2]

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

Definition at line 276 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::FSOpts.

◆ getFileSystemOpts() [2/2]

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

Definition at line 145 of file CompilerInvocation.h.

◆ getFrontendOpts() [1/2]

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

Definition at line 277 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::FrontendOpts.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), compileModuleAndReadAST(), FixupInvocation(), getModuleHash(), makeCommonInvocationForModuleBuild(), and clang::tooling::newInvocation().

◆ getFrontendOpts() [2/2]

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

Definition at line 146 of file CompilerInvocation.h.

◆ getHeaderSearchOpts() [1/2]

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

Definition at line 270 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::HSOpts.

Referenced by clearImplicitModuleBuildOptions(), clang::createVFSFromCompilerInvocation(), getModuleHash(), makeCommonInvocationForModuleBuild(), and resetNonModularOptions().

◆ getHeaderSearchOpts() [2/2]

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

Definition at line 139 of file CompilerInvocation.h.

◆ getLangOpts() [1/2]

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

Mutable getters.

Definition at line 267 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::LangOpts.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), clearImplicitModuleBuildOptions(), FixupInvocation(), getModuleHash(), makeCommonInvocationForModuleBuild(), clang::PrecompiledPreamble::OverridePreamble(), and resetNonModularOptions().

◆ getLangOpts() [2/2]

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

Const getters.

Definition at line 136 of file CompilerInvocation.h.

◆ getMigratorOpts() [1/2]

MigratorOptions & clang::CompilerInvocation::getMigratorOpts ( )
inline

Definition at line 273 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::MigratorOpts.

◆ getMigratorOpts() [2/2]

const MigratorOptions & clang::CompilerInvocationBase::getMigratorOpts ( ) const
inline

Definition at line 142 of file CompilerInvocation.h.

◆ 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 5114 of file CompilerInvocation.cpp.

References clang::CompilerInvocationBase::APINotesOpts, clang::SanitizerSet::clear(), clang::PreprocessorOptions::DetailedRecord, clang::SanitizerSet::empty(), getAPINotesOpts(), clang::getClangFullRepositoryVersion(), getCodeGenOpts(), getDiagnosticOpts(), getFrontendOpts(), getHeaderSearchOpts(), getLangOpts(), clang::getPPTransparentSanitizers(), getPreprocessorOpts(), getTargetOpts(), clang::Macro, clang::Macros, clang::SanitizerSet::Mask, clang::HeaderSearchOptions::ModuleFormat, clang::HeaderSearchOptions::ModulesIgnoreMacros, clang::HeaderSearchOptions::ModulesStrictContextHash, clang::HeaderSearchOptions::ModulesValidateDiagnosticOptions, clang::HeaderSearchOptions::ModuleUserBuildPath, clang::HeaderSearchOptions::ResourceDir, clang::Result, clang::LangOptions::Sanitize, clang::HeaderSearchOptions::Sysroot, clang::HeaderSearchOptions::SystemHeaderPrefixes, 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, clang::serialization::VERSION_MINOR, and clang::HeaderSearchOptions::VFSOverlayFiles.

Referenced by clang::CompilerInstance::createPreprocessor().

◆ getPreprocessorOpts() [1/2]

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

Definition at line 271 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::PPOpts.

Referenced by getBufferForFileHandlingRemapping(), getModuleHash(), makeCommonInvocationForModuleBuild(), and resetNonModularOptions().

◆ getPreprocessorOpts() [2/2]

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

Definition at line 140 of file CompilerInvocation.h.

◆ getPreprocessorOutputOpts() [1/2]

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

Definition at line 281 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::PreprocessorOutputOpts.

◆ getPreprocessorOutputOpts() [2/2]

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

Definition at line 150 of file CompilerInvocation.h.

◆ getTargetOpts() [1/2]

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

Definition at line 268 of file CompilerInvocation.h.

References clang::CompilerInvocationBase::TargetOpts.

Referenced by FixupInvocation(), and getModuleHash().

◆ getTargetOpts() [2/2]

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

Definition at line 137 of file CompilerInvocation.h.

◆ operator=() [1/2]

CompilerInvocation & clang::CompilerInvocation::operator= ( const CompilerInvocation & X)
inline

Definition at line 237 of file CompilerInvocation.h.

References CompilerInvocation(), clang::CompilerInvocationBase::deep_copy_assign(), and X.

◆ operator=() [2/2]

CompilerInvocation & CompilerInvocation::operator= ( const CowCompilerInvocation & X)

Definition at line 184 of file CompilerInvocation.cpp.

References clang::CompilerInvocationBase::deep_copy_assign(), and X.

◆ resetNonModularOptions()

void CompilerInvocation::resetNonModularOptions ( )

Reset all of the options that are not considered when building a module.

Definition at line 5369 of file CompilerInvocation.cpp.

References getCodeGenOpts(), getHeaderSearchOpts(), getLangOpts(), getPreprocessorOpts(), clang::CodeGenOptions::resetNonModularOptions(), clang::LangOptions::resetNonModularOptions(), and clang::PreprocessorOptions::resetNonModularOptions().

Referenced by makeCommonInvocationForModuleBuild().

◆ setDefaultPointerAuthOptions()

void CompilerInvocation::setDefaultPointerAuthOptions ( PointerAuthOptions & Opts,
const LangOptions & LangOpts,
const llvm::Triple & Triple )
static

Populate Opts with the default set of pointer authentication-related options given LangOpts and Triple.

Note: This is intended to be used by tools which must be aware of pointer authentication-related code generation, e.g. lldb.

Definition at line 1428 of file CompilerInvocation.cpp.

References clang::PointerAuthOptions::AArch64JumpTableHardening, clang::PointerAuthOptions::AuthTraps, clang::PointerAuthOptions::BlockByrefHelperFunctionPointers, clang::BlockDescriptorConstantDiscriminator, clang::PointerAuthOptions::BlockDescriptorPointers, clang::PointerAuthOptions::BlockHelperFunctionPointers, clang::PointerAuthOptions::BlockInvocationFunctionPointers, clang::ClassROConstantDiscriminator, clang::PointerAuthOptions::CXXMemberFunctionPointers, clang::PointerAuthOptions::CXXTypeInfoVTablePointer, clang::PointerAuthOptions::CXXVirtualFunctionPointers, clang::PointerAuthOptions::CXXVirtualVariadicFunctionPointers, clang::PointerAuthOptions::CXXVTablePointers, clang::PointerAuthOptions::CXXVTTVTablePointers, clang::PointerAuthOptions::FunctionPointers, clang::PointerAuthOptions::IndirectGotos, clang::InitFiniPointerConstantDiscriminator, clang::PointerAuthOptions::InitFiniPointers, clang::IsaPointerConstantDiscriminator, clang::CompilerInvocationBase::LangOpts, clang::MethodListPointerConstantDiscriminator, clang::PointerAuthOptions::ObjCClassROPointers, clang::PointerAuthOptions::ObjCIsaPointers, clang::PointerAuthOptions::ObjCMethodListFunctionPointers, clang::PointerAuthOptions::ObjCMethodListPointer, clang::PointerAuthOptions::ObjCSuperPointers, clang::PointerAuthOptions::ReturnAddresses, clang::StdTypeInfoVTablePointerConstantDiscrimination, and clang::SuperPointerConstantDiscriminator.

Referenced by parsePointerAuthOptions().

The documentation for this class was generated from the following files:
Generated on for clang by doxygen 1.14.0