The base class of CompilerInvocation. More...

#include "clang/Frontend/CompilerInvocation.h"

Inheritance diagram for clang::CompilerInvocationBase:

Classes
struct	EmptyConstructor
	Dummy tag type whose instance can be passed into the constructor to prevent creation of the reference-counted option objects. More...

Public Member Functions

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.

Protected Member Functions
	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

Protected Attributes
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.
using	StringAllocator = llvm::function_ref<const char *(const Twine &)>
	Command line generation.
using	ArgumentConsumer = llvm::function_ref<void(const Twine &)>
void	visitPathsImpl (llvm::function_ref< bool(std::string &)> Predicate)
	Visits paths stored in the invocation.
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>.

Detailed Description

The base class of CompilerInvocation.

It keeps individual option objects behind reference-counted pointers, which is useful for clients that want to keep select option objects alive (even after CompilerInvocation gets destroyed) without making a copy.

Definition at line 79 of file CompilerInvocation.h.

Member Typedef Documentation

◆ ArgumentConsumer

using clang::CompilerInvocationBase::ArgumentConsumer = llvm::function_ref<void(const Twine &)>

Definition at line 183 of file CompilerInvocation.h.

◆ StringAllocator

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

Command line generation.

Definition at line 164 of file CompilerInvocation.h.

Constructor & Destructor Documentation

◆ CompilerInvocationBase() [1/4]

CompilerInvocationBase::CompilerInvocationBase ( )

protected

◆ CompilerInvocationBase() [2/4]

clang::CompilerInvocationBase::CompilerInvocationBase ( EmptyConstructor )

inlineprotected

Definition at line 124 of file CompilerInvocation.h.

◆ CompilerInvocationBase() [3/4]

clang::CompilerInvocationBase::CompilerInvocationBase ( const CompilerInvocationBase & X )

protecteddelete

References CompilerInvocationBase(), and X.

◆ CompilerInvocationBase() [4/4]

clang::CompilerInvocationBase::CompilerInvocationBase ( CompilerInvocationBase && X )

protecteddefault

References CompilerInvocationBase(), and X.

◆ ~CompilerInvocationBase()

clang::CompilerInvocationBase::~CompilerInvocationBase ( )

protecteddefault

Member Function Documentation

◆ deep_copy_assign()

CompilerInvocationBase & CompilerInvocationBase::deep_copy_assign ( const CompilerInvocationBase & X )

protected

◆ generateCC1CommandLine() [1/2]

void CompilerInvocationBase::generateCC1CommandLine ( ArgumentConsumer Consumer ) const

Generate cc1-compatible command line arguments from this instance.

Parameters

Consumer - Callback that gets invoked for every single generated command line argument.

Definition at line 5363 of file CompilerInvocation.cpp.

References GenerateAnalyzerArgs(), GenerateAPINotesArgs(), GenerateDependencyOutputArgs(), GenerateFileSystemArgs(), GenerateFrontendArgs(), GenerateHeaderSearchArgs(), GenerateMigratorArgs(), GeneratePointerAuthArgs(), GeneratePreprocessorArgs(), GeneratePreprocessorOutputArgs(), GenerateTargetArgs(), getAnalyzerOpts(), getAPINotesOpts(), getCodeGenOpts(), getDependencyOutputOpts(), getDiagnosticOpts(), getFileSystemOpts(), getFrontendOpts(), getHeaderSearchOpts(), getLangOpts(), getMigratorOpts(), getPreprocessorOpts(), getPreprocessorOutputOpts(), getTargetOpts(), and clang::T.

◆ generateCC1CommandLine() [2/2]

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

inline

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

References generateCC1CommandLine().

Referenced by clang::CompilerInvocation::checkCC1RoundTrip(), clang::CompilerInvocation::CreateFromArgs(), generateCC1CommandLine(), getCC1CommandLine(), and getModuleContextHash().

◆ getAnalyzerOpts()

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

inline

Definition at line 141 of file CompilerInvocation.h.

References AnalyzerOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getAPINotesOpts()

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

inline

Definition at line 143 of file CompilerInvocation.h.

References APINotesOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getCC1CommandLine()

std::vector< std::string > CompilerInvocationBase::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 5387 of file CompilerInvocation.cpp.

References generateCC1CommandLine().

Referenced by clang::tooling::dependencies::CompilerInstanceWithContext::computeDependencies().

◆ getCodeGenOpts()

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

inline

Definition at line 144 of file CompilerInvocation.h.

References CodeGenOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getDependencyOutputOpts()

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

inline

Definition at line 147 of file CompilerInvocation.h.

References DependencyOutputOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getDiagnosticOpts()

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

inline

Definition at line 138 of file CompilerInvocation.h.

References DiagnosticOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getFileSystemOpts()

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

inline

Definition at line 145 of file CompilerInvocation.h.

References FSOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getFrontendOpts()

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

inline

Definition at line 146 of file CompilerInvocation.h.

References FrontendOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getHeaderSearchOpts()

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

inline

Definition at line 139 of file CompilerInvocation.h.

References HSOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getLangOpts()

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

inline

Const getters.

Definition at line 136 of file CompilerInvocation.h.

References LangOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getMigratorOpts()

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

inline

Definition at line 142 of file CompilerInvocation.h.

References MigratorOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getPreprocessorOpts()

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

inline

Definition at line 140 of file CompilerInvocation.h.

References PPOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getPreprocessorOutputOpts()

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

inline

Definition at line 150 of file CompilerInvocation.h.

References PreprocessorOutputOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ getTargetOpts()

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

inline

Definition at line 137 of file CompilerInvocation.h.

References TargetOpts.

Referenced by generateCC1CommandLine(), and clang::CompilerInvocation::~CompilerInvocation().

◆ operator=() [1/2]

CompilerInvocationBase & clang::CompilerInvocationBase::operator= ( CompilerInvocationBase && X )

protecteddefault

References CompilerInvocationBase(), and X.

◆ operator=() [2/2]

CompilerInvocationBase & clang::CompilerInvocationBase::operator= ( const CompilerInvocationBase & X )

protecteddelete

References CompilerInvocationBase(), and X.

◆ shallow_copy_assign()

CompilerInvocationBase & CompilerInvocationBase::shallow_copy_assign ( const CompilerInvocationBase & X )

protected

Definition at line 161 of file CompilerInvocation.cpp.

References AnalyzerOpts, APINotesOpts, CodeGenOpts, CompilerInvocationBase(), DependencyOutputOpts, DiagnosticOpts, FrontendOpts, FSOpts, HSOpts, LangOpts, MigratorOpts, PPOpts, PreprocessorOutputOpts, TargetOpts, and X.

Referenced by clang::CowCompilerInvocation::CowCompilerInvocation(), and clang::CowCompilerInvocation::operator=().

◆ visitPaths()

void CompilerInvocationBase::visitPaths ( llvm::function_ref< bool(StringRef)> Callback ) const

Visitation.

Visits paths stored in the invocation. The callback may return true to short-circuit the visitation, or return false to continue visiting.

Definition at line 5355 of file CompilerInvocation.cpp.

References CompilerInvocationBase(), and visitPathsImpl().

Referenced by isSafeToIgnoreCWD().

◆ visitPathsImpl()

void CompilerInvocationBase::visitPathsImpl ( llvm::function_ref< bool(std::string &)> Predicate )

protected

Visits paths stored in the invocation.

This is generally unsafe to call directly, and each sub-class need to ensure calling this doesn't violate its invariants.

Definition at line 5282 of file CompilerInvocation.cpp.

References CodeGenOpts, DependencyOutputOpts, clang::File, FrontendOpts, FSOpts, HSOpts, LangOpts, PPOpts, RETURN_IF, and RETURN_IF_MANY.

Referenced by visitPaths().

Member Data Documentation

◆ AnalyzerOpts

std::shared_ptr<AnalyzerOptions> clang::CompilerInvocationBase::AnalyzerOpts

protected

Options controlling the static analyzer.

Definition at line 97 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getAnalyzerOpts(), getAnalyzerOpts(), clang::CowCompilerInvocation::getMutAnalyzerOpts(), and shallow_copy_assign().

◆ APINotesOpts

std::shared_ptr<APINotesOptions> clang::CompilerInvocationBase::APINotesOpts

protected

Options controlling API notes.

Definition at line 102 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getAPINotesOpts(), getAPINotesOpts(), clang::CompilerInvocation::getModuleHash(), clang::CowCompilerInvocation::getMutAPINotesOpts(), and shallow_copy_assign().

◆ CodeGenOpts

std::shared_ptr<CodeGenOptions> clang::CompilerInvocationBase::CodeGenOpts

protected

Options controlling IRgen and the backend.

Definition at line 105 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getCodeGenOpts(), getCodeGenOpts(), clang::CowCompilerInvocation::getMutCodeGenOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ DependencyOutputOpts

std::shared_ptr<DependencyOutputOptions> clang::CompilerInvocationBase::DependencyOutputOpts

protected

Options controlling dependency output.

Definition at line 114 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getDependencyOutputOpts(), getDependencyOutputOpts(), clang::CowCompilerInvocation::getMutDependencyOutputOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ DiagnosticOpts

std::shared_ptr<DiagnosticOptions> clang::CompilerInvocationBase::DiagnosticOpts

protected

Options controlling the diagnostic engine.

Definition at line 88 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getDiagnosticOpts(), getDiagnosticOpts(), clang::CowCompilerInvocation::getMutDiagnosticOpts(), and shallow_copy_assign().

◆ FrontendOpts

std::shared_ptr<FrontendOptions> clang::CompilerInvocationBase::FrontendOpts

protected

Options controlling the frontend itself.

Definition at line 111 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getFrontendOpts(), getFrontendOpts(), clang::CowCompilerInvocation::getMutFrontendOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ FSOpts

std::shared_ptr<FileSystemOptions> clang::CompilerInvocationBase::FSOpts

protected

Options controlling file system operations.

Definition at line 108 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getFileSystemOpts(), getFileSystemOpts(), clang::CowCompilerInvocation::getMutFileSystemOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ HSOpts

std::shared_ptr<HeaderSearchOptions> clang::CompilerInvocationBase::HSOpts

protected

Options controlling the #include directive.

Definition at line 91 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getHeaderSearchOpts(), getHeaderSearchOpts(), clang::CowCompilerInvocation::getMutHeaderSearchOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ LangOpts

std::shared_ptr<LangOptions> clang::CompilerInvocationBase::LangOpts

protected

Options controlling the language variant.

Definition at line 82 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getLangOpts(), getLangOpts(), clang::CowCompilerInvocation::getMutLangOpts(), clang::CompilerInvocation::setDefaultPointerAuthOptions(), shallow_copy_assign(), and visitPathsImpl().

◆ MigratorOpts

std::shared_ptr<MigratorOptions> clang::CompilerInvocationBase::MigratorOpts

protected

Definition at line 99 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CompilerInvocation::getMigratorOpts(), getMigratorOpts(), clang::CowCompilerInvocation::getMutMigratorOpts(), and shallow_copy_assign().

◆ PPOpts

std::shared_ptr<PreprocessorOptions> clang::CompilerInvocationBase::PPOpts

protected

Options controlling the preprocessor (aside from #include handling).

Definition at line 94 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CowCompilerInvocation::getMutPreprocessorOpts(), clang::CompilerInvocation::getPreprocessorOpts(), getPreprocessorOpts(), shallow_copy_assign(), and visitPathsImpl().

◆ PreprocessorOutputOpts

std::shared_ptr<PreprocessorOutputOptions> clang::CompilerInvocationBase::PreprocessorOutputOpts

protected

Options controlling preprocessed output.

Definition at line 117 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CowCompilerInvocation::getMutPreprocessorOutputOpts(), clang::CompilerInvocation::getPreprocessorOutputOpts(), getPreprocessorOutputOpts(), and shallow_copy_assign().

◆ TargetOpts

std::shared_ptr<TargetOptions> clang::CompilerInvocationBase::TargetOpts

protected

Options controlling the target.

Definition at line 85 of file CompilerInvocation.h.

Referenced by CompilerInvocationBase(), deep_copy_assign(), clang::CowCompilerInvocation::getMutTargetOpts(), clang::CompilerInvocation::getTargetOpts(), getTargetOpts(), and shallow_copy_assign().

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

include/clang/Frontend/CompilerInvocation.h
lib/Frontend/CompilerInvocation.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ArgumentConsumer

◆ StringAllocator

Constructor & Destructor Documentation

◆ CompilerInvocationBase() [1/4]

◆ CompilerInvocationBase() [2/4]

◆ CompilerInvocationBase() [3/4]

◆ CompilerInvocationBase() [4/4]

◆ ~CompilerInvocationBase()

Member Function Documentation

◆ deep_copy_assign()

◆ generateCC1CommandLine() [1/2]

◆ generateCC1CommandLine() [2/2]

◆ getAnalyzerOpts()

◆ getAPINotesOpts()

◆ getCC1CommandLine()

◆ getCodeGenOpts()

◆ getDependencyOutputOpts()

◆ getDiagnosticOpts()

◆ getFileSystemOpts()

◆ getFrontendOpts()

◆ getHeaderSearchOpts()

◆ getLangOpts()

◆ getMigratorOpts()

◆ getPreprocessorOpts()

◆ getPreprocessorOutputOpts()

◆ getTargetOpts()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ shallow_copy_assign()

◆ visitPaths()

◆ visitPathsImpl()

Member Data Documentation

◆ AnalyzerOpts

◆ APINotesOpts

◆ CodeGenOpts

◆ DependencyOutputOpts

◆ DiagnosticOpts

◆ FrontendOpts

◆ FSOpts

◆ HSOpts

◆ LangOpts

◆ MigratorOpts

◆ PPOpts

◆ PreprocessorOutputOpts

◆ TargetOpts