FrontendOptions - Options for controlling the behavior of the frontend. More...

#include "clang/Frontend/FrontendOptions.h"

Public Types
enum	{ ARCMT_None , ARCMT_Check , ARCMT_Modify , ARCMT_Migrate }

enum	{ ObjCMT_None = 0 , ObjCMT_Literals = 0x1 , ObjCMT_Subscripting = 0x2 , ObjCMT_ReadonlyProperty = 0x4 , ObjCMT_ReadwriteProperty = 0x8 , ObjCMT_Property = (ObjCMT_ReadonlyProperty \| ObjCMT_ReadwriteProperty) , ObjCMT_Annotation = 0x10 , ObjCMT_Instancetype = 0x20 , ObjCMT_NsMacros = 0x40 , ObjCMT_ProtocolConformance = 0x80 , ObjCMT_AtomicProperty = 0x100 , ObjCMT_ReturnsInnerPointerProperty = 0x200 , ObjCMT_NsAtomicIOSOnlyProperty = 0x400 , ObjCMT_DesignatedInitializer = 0x800 , ObjCMT_PropertyDotSyntax = 0x1000 , ObjCMT_MigrateDecls , ObjCMT_MigrateAll }

Public Member Functions
	FrontendOptions ()

Static Public Member Functions
static InputKind	getInputKindForExtension (StringRef Extension)
	getInputKindForExtension - Return the appropriate input kind for a file extension.

Public Attributes
unsigned	DisableFree: 1
	Disable memory freeing on exit.

unsigned	RelocatablePCH: 1
	When generating PCH files, instruct the AST writer to create relocatable PCH files.

unsigned	ShowHelp: 1
	Show the -help text.

unsigned	ShowStats: 1
	Show frontend performance metrics and statistics.

unsigned	AppendStats: 1

unsigned	PrintSupportedCPUs: 1
	print the supported cpus for the current target

unsigned	PrintSupportedExtensions: 1
	Print the supported extensions for the current target.

unsigned	PrintEnabledExtensions: 1
	Print the extensions enabled for the current target.

unsigned	ShowVersion: 1
	Show the -version text.

unsigned	FixWhatYouCan: 1
	Apply fixes even if there are unfixable errors.

unsigned	FixOnlyWarnings: 1
	Apply fixes only for warnings.

unsigned	FixAndRecompile: 1
	Apply fixes and recompile.

unsigned	FixToTemporaries: 1
	Apply fixes to temporary files.

unsigned	ARCMTMigrateEmitARCErrors: 1
	Emit ARC errors even if the migrator can fix them.

unsigned	SkipFunctionBodies: 1
	Skip over function bodies to speed up parsing in cases you do not need them (e.g.

unsigned	UseGlobalModuleIndex: 1
	Whether we can use the global module index if available.

unsigned	GenerateGlobalModuleIndex: 1
	Whether we can generate the global module index if needed.

unsigned	ASTDumpDecls: 1
	Whether we include declaration dumps in AST dumps.

unsigned	ASTDumpAll: 1
	Whether we deserialize all decls when forming AST dumps.

unsigned	ASTDumpLookups: 1
	Whether we include lookup table dumps in AST dumps.

unsigned	ASTDumpDeclTypes: 1
	Whether we include declaration type dumps in AST dumps.

unsigned	BuildingImplicitModule: 1
	Whether we are performing an implicit module build.

unsigned	BuildingImplicitModuleUsesLock: 1
	Whether to use a filesystem lock when building implicit modules.

unsigned	ModulesEmbedAllFiles: 1
	Whether we should embed all used files into the PCM file.

unsigned	IncludeTimestamps: 1
	Whether timestamps should be written to the produced PCH file.

unsigned	UseTemporary: 1
	Should a temporary file be used during compilation.

unsigned	IsSystemModule: 1
	When using -emit-module, treat the modulemap as a system module.

unsigned	AllowPCMWithCompilerErrors: 1
	Output (and read) PCM files regardless of compiler errors.

unsigned	ModulesShareFileManager: 1
	Whether to share the FileManager when building modules.

unsigned	EmitSymbolGraph: 1
	Whether to emit symbol graph files as a side effect of compilation.

unsigned	EmitExtensionSymbolGraphs: 1
	Whether to emit additional symbol graphs for extended modules.

unsigned	EmitSymbolGraphSymbolLabelsForTesting: 1
	Whether to emit symbol labels for testing in generated symbol graphs.

unsigned	EmitPrettySymbolGraphs: 1
	Whether to emit symbol labels for testing in generated symbol graphs.

unsigned	GenReducedBMI: 1
	Whether to generate reduced BMI for C++20 named modules.

unsigned	UseClangIRPipeline: 1
	Use Clang IR pipeline to emit code.

CodeCompleteOptions	CodeCompleteOpts

ASTDumpOutputFormat	ASTDumpFormat = ADOF_Default
	Specifies the output format of the AST.

enum clang::FrontendOptions:: { ... }	ARCMTAction = ARCMT_None

unsigned	ObjCMTAction = ObjCMT_None

std::string	ObjCMTAllowListPath

std::string	MTMigrateDir

std::string	ARCMTMigrateReportOut

InputKind	DashX
	The input kind, either specified via -x argument or deduced from the input file name.

SmallVector< FrontendInputFile, 0 >	Inputs
	The input files and their types.

std::string	OriginalModuleMap
	When the input is a module map, the original module map file from which that map was inferred, if any (for umbrella modules).

std::string	OutputFile
	The output file, if any.

std::string	FixItSuffix
	If given, the new suffix for fix-it rewritten files.

std::string	ASTDumpFilter
	If given, filter dumped AST Decl nodes by this substring.

ParsedSourceLocation	CodeCompletionAt
	If given, enable code completion at the provided location.

frontend::ActionKind	ProgramAction = frontend::ParseSyntaxOnly
	The frontend action to perform.

std::string	ActionName
	The name of the action to run when using a plugin action.

std::string	ProductName
	The name of the product the input files belong too.

std::vector< std::string >	ExtractAPIIgnoresFileList

std::string	SymbolGraphOutputDir

std::map< std::string, std::vector< std::string > >	PluginArgs
	Args to pass to the plugins.

std::vector< std::string >	AddPluginActions
	The list of plugin actions to run in addition to the normal action.

std::vector< std::string >	Plugins
	The list of plugins to load.

std::vector< std::shared_ptr< ModuleFileExtension > >	ModuleFileExtensions
	The list of module file extensions.

std::vector< std::string >	ModuleMapFiles
	The list of module map files to load before processing the input.

std::vector< std::string >	ModuleFiles
	The list of additional prebuilt module files to load before processing the input.

std::vector< std::string >	ModulesEmbedFiles
	The list of files to embed into the compiled module file.

std::vector< std::string >	ASTMergeFiles
	The list of AST files to merge.

std::vector< std::string >	LLVMArgs
	A list of arguments to forward to LLVM's option processing; this should only be used for debugging and experimental features.

std::string	OverrideRecordLayoutsFile
	File name of the file that will provide record layouts (in the format produced by -fdump-record-layouts).

std::string	AuxTriple
	Auxiliary triple for CUDA/HIP compilation.

std::optional< std::string >	AuxTargetCPU
	Auxiliary target CPU for CUDA/HIP compilation.

std::optional< std::vector< std::string > >	AuxTargetFeatures
	Auxiliary target features for CUDA/HIP compilation.

std::string	StatsFile
	Filename to write statistics to.

unsigned	TimeTraceGranularity
	Minimum time granularity (in microseconds) traced by time profiler.

unsigned	TimeTraceVerbose: 1
	Make time trace capture verbose event details (e.g.

std::string	TimeTracePath
	Path which stores the output files for -ftime-trace.

std::string	ModuleOutputPath
	Output Path for module output file.

Detailed Description

FrontendOptions - Options for controlling the behavior of the frontend.

Definition at line 279 of file FrontendOptions.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
ARCMT_None
ARCMT_Check
ARCMT_Modify
ARCMT_Migrate

Definition at line 427 of file FrontendOptions.h.

◆ anonymous enum

anonymous enum

Enumerator
ObjCMT_None
ObjCMT_Literals	Enable migration to modern ObjC literals.
ObjCMT_Subscripting	Enable migration to modern ObjC subscripting.
ObjCMT_ReadonlyProperty	Enable migration to modern ObjC readonly property.
ObjCMT_ReadwriteProperty	Enable migration to modern ObjC readwrite property.
ObjCMT_Property	Enable migration to modern ObjC property.
ObjCMT_Annotation	Enable annotation of ObjCMethods of all kinds.
ObjCMT_Instancetype	Enable migration of ObjC methods to 'instancetype'.
ObjCMT_NsMacros	Enable migration to NS_ENUM/NS_OPTIONS macros.
ObjCMT_ProtocolConformance	Enable migration to add conforming protocols.
ObjCMT_AtomicProperty	prefer 'atomic' property over 'nonatomic'.
ObjCMT_ReturnsInnerPointerProperty	annotate property with NS_RETURNS_INNER_POINTER
ObjCMT_NsAtomicIOSOnlyProperty	use NS_NONATOMIC_IOSONLY for property 'atomic' attribute
ObjCMT_DesignatedInitializer	Enable inferring NS_DESIGNATED_INITIALIZER for ObjC methods.
ObjCMT_PropertyDotSyntax	Enable converting setter/getter expressions to property-dot syntx.
ObjCMT_MigrateDecls
ObjCMT_MigrateAll

Definition at line 434 of file FrontendOptions.h.

Constructor & Destructor Documentation

◆ FrontendOptions()

clang::FrontendOptions::FrontendOptions ( )

inline

Definition at line 595 of file FrontendOptions.h.

Member Function Documentation

◆ getInputKindForExtension()

InputKind FrontendOptions::getInputKindForExtension ( StringRef Extension )

static

getInputKindForExtension - Return the appropriate input kind for a file extension.

For example, "c" would return Language::C.

Returns: The input kind for the extension, or Language::Unknown if the extension is not recognized.

Definition at line 15 of file FrontendOptions.cpp.

References clang::Asm, clang::C, clang::CIR, clang::CUDA, clang::CXX, clang::HIP, clang::HLSL, clang::LLVM_IR, clang::ObjC, clang::ObjCXX, clang::OpenCL, clang::OpenCLCXX, clang::InputKind::Precompiled, and clang::Unknown.

Referenced by ParseFrontendArgs().

Member Data Documentation

◆ ActionName

std::string clang::FrontendOptions::ActionName

The name of the action to run when using a plugin action.

Definition at line 520 of file FrontendOptions.h.

Referenced by clang::CreateFrontendBaseAction(), GenerateFrontendArgs(), clang::CompilerInstance::LoadRequestedPlugins(), and ParseFrontendArgs().

◆ AddPluginActions

std::vector<std::string> clang::FrontendOptions::AddPluginActions

The list of plugin actions to run in addition to the normal action.

Definition at line 539 of file FrontendOptions.h.

◆ AllowPCMWithCompilerErrors

unsigned clang::FrontendOptions::AllowPCMWithCompilerErrors

Output (and read) PCM files regardless of compiler errors.

Definition at line 392 of file FrontendOptions.h.

Referenced by clang::CompilerInstance::createASTReader(), clang::GenerateModuleAction::CreateMultiplexConsumer(), and clang::GenerateModuleAction::shouldEraseOutputFiles().

◆ AppendStats

unsigned clang::FrontendOptions::AppendStats

Definition at line 299 of file FrontendOptions.h.

◆

enum { ... } clang::FrontendOptions::ARCMTAction

Referenced by clang::CreateFrontendAction(), makeCommonInvocationForModuleBuild(), and ParseFrontendArgs().

◆ ARCMTMigrateEmitARCErrors

unsigned clang::FrontendOptions::ARCMTMigrateEmitARCErrors

Emit ARC errors even if the migrator can fix them.

Definition at line 335 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction().

◆ ARCMTMigrateReportOut

std::string clang::FrontendOptions::ARCMTMigrateReportOut

Definition at line 491 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction().

◆ ASTDumpAll

unsigned clang::FrontendOptions::ASTDumpAll

Whether we deserialize all decls when forming AST dumps.

Definition at line 356 of file FrontendOptions.h.

Referenced by clang::ASTDumpAction::CreateASTConsumer(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ ASTDumpDecls

unsigned clang::FrontendOptions::ASTDumpDecls

Whether we include declaration dumps in AST dumps.

Definition at line 352 of file FrontendOptions.h.

Referenced by clang::ASTDumpAction::CreateASTConsumer(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ ASTDumpDeclTypes

unsigned clang::FrontendOptions::ASTDumpDeclTypes

Whether we include declaration type dumps in AST dumps.

Definition at line 364 of file FrontendOptions.h.

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

◆ ASTDumpFilter

std::string clang::FrontendOptions::ASTDumpFilter

If given, filter dumped AST Decl nodes by this substring.

Definition at line 511 of file FrontendOptions.h.

Referenced by clang::ASTPrintAction::CreateASTConsumer(), and clang::ASTDumpAction::CreateASTConsumer().

◆ ASTDumpFormat

ASTDumpOutputFormat clang::FrontendOptions::ASTDumpFormat = ADOF_Default

Specifies the output format of the AST.

Definition at line 425 of file FrontendOptions.h.

Referenced by clang::ASTDumpAction::CreateASTConsumer(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ ASTDumpLookups

unsigned clang::FrontendOptions::ASTDumpLookups

Whether we include lookup table dumps in AST dumps.

Definition at line 360 of file FrontendOptions.h.

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

◆ ASTMergeFiles

std::vector<std::string> clang::FrontendOptions::ASTMergeFiles

The list of AST files to merge.

Definition at line 558 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction().

◆ AuxTargetCPU

std::optional<std::string> clang::FrontendOptions::AuxTargetCPU

Auxiliary target CPU for CUDA/HIP compilation.

Definition at line 572 of file FrontendOptions.h.

Referenced by clang::CompilerInstance::createTarget(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ AuxTargetFeatures

std::optional<std::vector<std::string> > clang::FrontendOptions::AuxTargetFeatures

Auxiliary target features for CUDA/HIP compilation.

Definition at line 575 of file FrontendOptions.h.

Referenced by clang::CompilerInstance::createTarget(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ AuxTriple

std::string clang::FrontendOptions::AuxTriple

Auxiliary triple for CUDA/HIP compilation.

Definition at line 569 of file FrontendOptions.h.

◆ BuildingImplicitModule

unsigned clang::FrontendOptions::BuildingImplicitModule

Whether we are performing an implicit module build.

Definition at line 368 of file FrontendOptions.h.

Referenced by clang::GenerateModuleAction::CreateMultiplexConsumer().

◆ BuildingImplicitModuleUsesLock

unsigned clang::FrontendOptions::BuildingImplicitModuleUsesLock

Whether to use a filesystem lock when building implicit modules.

Definition at line 372 of file FrontendOptions.h.

Referenced by compileModuleAndReadAST().

◆ CodeCompleteOpts

CodeCompleteOptions clang::FrontendOptions::CodeCompleteOpts

Definition at line 422 of file FrontendOptions.h.

Referenced by clang::ASTUnit::CodeComplete().

◆ CodeCompletionAt

ParsedSourceLocation clang::FrontendOptions::CodeCompletionAt

If given, enable code completion at the provided location.

Definition at line 514 of file FrontendOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), clang::CompilerInstance::createCodeCompletionConsumer(), clang::ASTFrontendAction::ExecuteAction(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ DashX

InputKind clang::FrontendOptions::DashX

The input kind, either specified via -x argument or deduced from the input file name.

Definition at line 495 of file FrontendOptions.h.

Referenced by GenerateFrontendArgs(), and ParseFrontendArgs().

◆ DisableFree

unsigned clang::FrontendOptions::DisableFree

Disable memory freeing on exit.

Definition at line 283 of file FrontendOptions.h.

Referenced by clang::FrontendAction::EndSourceFile(), clang::ExecuteCompilerInvocation(), FixupInvocation(), and clang::tooling::newInvocation().

◆ EmitExtensionSymbolGraphs

unsigned clang::FrontendOptions::EmitExtensionSymbolGraphs

Whether to emit additional symbol graphs for extended modules.

Definition at line 404 of file FrontendOptions.h.

Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().

◆ EmitPrettySymbolGraphs

unsigned clang::FrontendOptions::EmitPrettySymbolGraphs

Whether to emit symbol labels for testing in generated symbol graphs.

Definition at line 412 of file FrontendOptions.h.

Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().

◆ EmitSymbolGraph

unsigned clang::FrontendOptions::EmitSymbolGraph

Whether to emit symbol graph files as a side effect of compilation.

Definition at line 400 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction().

◆ EmitSymbolGraphSymbolLabelsForTesting

unsigned clang::FrontendOptions::EmitSymbolGraphSymbolLabelsForTesting

Whether to emit symbol labels for testing in generated symbol graphs.

Definition at line 408 of file FrontendOptions.h.

Referenced by clang::ExtractAPIActionBase::ImplEndSourceFileAction().

◆ ExtractAPIIgnoresFileList

std::vector<std::string> clang::FrontendOptions::ExtractAPIIgnoresFileList

Definition at line 529 of file FrontendOptions.h.

Referenced by clang::ExtractAPIAction::CreateASTConsumer(), and clang::WrappingExtractAPIAction::CreateASTConsumer().

◆ FixAndRecompile

unsigned clang::FrontendOptions::FixAndRecompile

Apply fixes and recompile.

Definition at line 327 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction().

◆ FixItSuffix

std::string clang::FrontendOptions::FixItSuffix

If given, the new suffix for fix-it rewritten files.

Definition at line 508 of file FrontendOptions.h.

Referenced by clang::FixItAction::BeginSourceFileAction(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ FixOnlyWarnings

unsigned clang::FrontendOptions::FixOnlyWarnings

Apply fixes only for warnings.

Definition at line 323 of file FrontendOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation().

◆ FixToTemporaries

unsigned clang::FrontendOptions::FixToTemporaries

Apply fixes to temporary files.

Definition at line 331 of file FrontendOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation().

◆ FixWhatYouCan

unsigned clang::FrontendOptions::FixWhatYouCan

Apply fixes even if there are unfixable errors.

Definition at line 319 of file FrontendOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation(), and clang::FixItAction::BeginSourceFileAction().

◆ GenerateGlobalModuleIndex

unsigned clang::FrontendOptions::GenerateGlobalModuleIndex

Whether we can generate the global module index if needed.

Definition at line 348 of file FrontendOptions.h.

Referenced by compileModule(), and FixupInvocation().

◆ GenReducedBMI

unsigned clang::FrontendOptions::GenReducedBMI

Whether to generate reduced BMI for C++20 named modules.

Definition at line 416 of file FrontendOptions.h.

Referenced by clang::CodeGenAction::BeginSourceFileAction(), clang::CodeGenAction::CreateASTConsumer(), and clang::GenerateModuleInterfaceAction::CreateASTConsumer().

◆ IncludeTimestamps

unsigned clang::FrontendOptions::IncludeTimestamps

Whether timestamps should be written to the produced PCH file.

Definition at line 380 of file FrontendOptions.h.

Referenced by clang::GenerateModuleAction::CreateMultiplexConsumer().

◆ Inputs

SmallVector<FrontendInputFile, 0> clang::FrontendOptions::Inputs

The input files and their types.

Definition at line 498 of file FrontendOptions.h.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), applyTransforms(), clang::FixItRecompile::BeginInvocation(), clang::PrecompiledPreamble::Build(), clang::ReplCodeCompleter::codeComplete(), clang::ExtractAPIAction::CreateASTConsumer(), clang::WrappingExtractAPIAction::CreateASTConsumer(), clang::createChainedIncludesSource(), GenerateFrontendArgs(), makeCommonInvocationForModuleBuild(), and ParseFrontendArgs().

◆ IsSystemModule

unsigned clang::FrontendOptions::IsSystemModule

When using -emit-module, treat the modulemap as a system module.

Definition at line 388 of file FrontendOptions.h.

Referenced by ParseFrontendArgs().

◆ LLVMArgs

std::vector<std::string> clang::FrontendOptions::LLVMArgs

A list of arguments to forward to LLVM's option processing; this should only be used for debugging and experimental features.

Definition at line 562 of file FrontendOptions.h.

Referenced by clang::ExecuteCompilerInvocation(), and makeCommonInvocationForModuleBuild().

◆ ModuleFileExtensions

std::vector<std::shared_ptr<ModuleFileExtension> > clang::FrontendOptions::ModuleFileExtensions

The list of module file extensions.

Definition at line 545 of file FrontendOptions.h.

Referenced by clang::GenerateModuleAction::CreateMultiplexConsumer(), clang::VerifyPCHAction::ExecuteAction(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ ModuleFiles

std::vector<std::string> clang::FrontendOptions::ModuleFiles

The list of additional prebuilt module files to load before processing the input.

Definition at line 552 of file FrontendOptions.h.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), clang::FrontendAction::BeginSourceFile(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ ModuleMapFiles

std::vector<std::string> clang::FrontendOptions::ModuleMapFiles

The list of module map files to load before processing the input.

Definition at line 548 of file FrontendOptions.h.

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

◆ ModuleOutputPath

std::string clang::FrontendOptions::ModuleOutputPath

Output Path for module output file.

Definition at line 592 of file FrontendOptions.h.

Referenced by clang::CodeGenAction::CreateASTConsumer(), and clang::GenerateModuleInterfaceAction::CreateASTConsumer().

◆ ModulesEmbedAllFiles

unsigned clang::FrontendOptions::ModulesEmbedAllFiles

Whether we should embed all used files into the PCM file.

Definition at line 376 of file FrontendOptions.h.

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

◆ ModulesEmbedFiles

std::vector<std::string> clang::FrontendOptions::ModulesEmbedFiles

The list of files to embed into the compiled module file.

Definition at line 555 of file FrontendOptions.h.

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

◆ ModulesShareFileManager

unsigned clang::FrontendOptions::ModulesShareFileManager

Whether to share the FileManager when building modules.

Definition at line 396 of file FrontendOptions.h.

◆ MTMigrateDir

std::string clang::FrontendOptions::MTMigrateDir

Definition at line 490 of file FrontendOptions.h.

Referenced by clang::CreateFrontendAction(), and makeCommonInvocationForModuleBuild().

◆ ObjCMTAction

unsigned clang::FrontendOptions::ObjCMTAction = ObjCMT_None

Definition at line 487 of file FrontendOptions.h.

Referenced by clang::arcmt::MigrateSourceAction::CreateASTConsumer(), clang::CreateFrontendAction(), makeCommonInvocationForModuleBuild(), and ParseFrontendArgs().

◆ ObjCMTAllowListPath

std::string clang::FrontendOptions::ObjCMTAllowListPath

Definition at line 488 of file FrontendOptions.h.

Referenced by clang::arcmt::MigrateSourceAction::CreateASTConsumer().

◆ OriginalModuleMap

std::string clang::FrontendOptions::OriginalModuleMap

When the input is a module map, the original module map file from which that map was inferred, if any (for umbrella modules).

Definition at line 502 of file FrontendOptions.h.

Referenced by prepareToBuildModule().

◆ OutputFile

std::string clang::FrontendOptions::OutputFile

The output file, if any.

Definition at line 505 of file FrontendOptions.h.

Referenced by clang::PrecompiledPreamble::Build(), clang::ento::CreateAnalysisConsumer(), clang::arcmt::MigrateSourceAction::CreateASTConsumer(), clang::GenerateModuleInterfaceAction::CreateASTConsumer(), clang::CompilerInstance::createDefaultOutputFile(), clang::GenerateModuleAction::CreateMultiplexConsumer(), clang::GeneratePCHAction::CreateOutputFile(), clang::DumpModuleInfoAction::ExecuteAction(), and makeCommonInvocationForModuleBuild().

◆ OverrideRecordLayoutsFile

std::string clang::FrontendOptions::OverrideRecordLayoutsFile

File name of the file that will provide record layouts (in the format produced by -fdump-record-layouts).

Definition at line 566 of file FrontendOptions.h.

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

◆ PluginArgs

std::map<std::string, std::vector<std::string> > clang::FrontendOptions::PluginArgs

Args to pass to the plugins.

Definition at line 536 of file FrontendOptions.h.

Referenced by clang::CreateFrontendBaseAction(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ Plugins

std::vector<std::string> clang::FrontendOptions::Plugins

The list of plugins to load.

Definition at line 542 of file FrontendOptions.h.

Referenced by clang::ento::CreateAnalysisConsumer(), GenerateFrontendArgs(), and ParseFrontendArgs().

◆ PrintEnabledExtensions

unsigned clang::FrontendOptions::PrintEnabledExtensions

Print the extensions enabled for the current target.

Definition at line 311 of file FrontendOptions.h.

◆ PrintSupportedCPUs

unsigned clang::FrontendOptions::PrintSupportedCPUs

print the supported cpus for the current target

Definition at line 303 of file FrontendOptions.h.

◆ PrintSupportedExtensions

unsigned clang::FrontendOptions::PrintSupportedExtensions

Print the supported extensions for the current target.

Definition at line 307 of file FrontendOptions.h.

◆ ProductName

std::string clang::FrontendOptions::ProductName

The name of the product the input files belong too.

Definition at line 524 of file FrontendOptions.h.

Referenced by clang::ExtractAPIAction::CreateASTConsumer(), and clang::WrappingExtractAPIAction::CreateASTConsumer().

◆ ProgramAction

frontend::ActionKind clang::FrontendOptions::ProgramAction = frontend::ParseSyntaxOnly

The frontend action to perform.

Definition at line 517 of file FrontendOptions.h.

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), clang::PrecompiledPreamble::Build(), clang::CreateFrontendAction(), clang::CreateFrontendBaseAction(), GenerateFrontendArgs(), clang::IncrementalAction::IncrementalAction(), InitializePredefinedMacros(), clang::CompilerInstance::LoadRequestedPlugins(), makeCommonInvocationForModuleBuild(), and ParseFrontendArgs().

◆ RelocatablePCH

unsigned clang::FrontendOptions::RelocatablePCH

When generating PCH files, instruct the AST writer to create relocatable PCH files.

Definition at line 288 of file FrontendOptions.h.

Referenced by clang::GeneratePCHAction::ComputeASTConsumerArguments(), and clang::GeneratePCHAction::CreateASTConsumer().

◆ ShowHelp

unsigned clang::FrontendOptions::ShowHelp

Show the -help text.

Definition at line 292 of file FrontendOptions.h.

Referenced by clang::ExecuteCompilerInvocation().

◆ ShowStats

unsigned clang::FrontendOptions::ShowStats

Show frontend performance metrics and statistics.

Definition at line 296 of file FrontendOptions.h.

Referenced by clang::FrontendAction::EndSourceFile(), clang::ASTFrontendAction::ExecuteAction(), and FixupInvocation().

◆ ShowVersion

unsigned clang::FrontendOptions::ShowVersion

Show the -version text.

Definition at line 315 of file FrontendOptions.h.

Referenced by clang::ExecuteCompilerInvocation().

◆ SkipFunctionBodies

unsigned clang::FrontendOptions::SkipFunctionBodies

Skip over function bodies to speed up parsing in cases you do not need them (e.g.

with code completion).

Definition at line 340 of file FrontendOptions.h.

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

◆ StatsFile

std::string clang::FrontendOptions::StatsFile

Filename to write statistics to.

Definition at line 578 of file FrontendOptions.h.

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

◆ SymbolGraphOutputDir

std::string clang::FrontendOptions::SymbolGraphOutputDir

Definition at line 533 of file FrontendOptions.h.

Referenced by clang::ExtractAPIAction::CreateASTConsumer(), and clang::CreateFrontendAction().

◆ TimeTraceGranularity

unsigned clang::FrontendOptions::TimeTraceGranularity

Minimum time granularity (in microseconds) traced by time profiler.

Definition at line 581 of file FrontendOptions.h.

◆ TimeTracePath

std::string clang::FrontendOptions::TimeTracePath

Path which stores the output files for -ftime-trace.

Definition at line 589 of file FrontendOptions.h.

◆ TimeTraceVerbose

unsigned clang::FrontendOptions::TimeTraceVerbose

Make time trace capture verbose event details (e.g.

source filenames). This can increase the size of the output by 2-3 times.

Definition at line 586 of file FrontendOptions.h.

◆ UseClangIRPipeline

unsigned clang::FrontendOptions::UseClangIRPipeline

Use Clang IR pipeline to emit code.

Definition at line 420 of file FrontendOptions.h.

Referenced by ParseFrontendArgs().

◆ UseGlobalModuleIndex

unsigned clang::FrontendOptions::UseGlobalModuleIndex

Whether we can use the global module index if available.

Definition at line 344 of file FrontendOptions.h.

Referenced by FixupInvocation().

◆ UseTemporary

unsigned clang::FrontendOptions::UseTemporary

Should a temporary file be used during compilation.

Definition at line 384 of file FrontendOptions.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FrontendOptions()

Member Function Documentation

◆ getInputKindForExtension()

Member Data Documentation

◆ ActionName

◆ AddPluginActions

◆ AllowPCMWithCompilerErrors

◆ AppendStats

◆

◆ ARCMTMigrateEmitARCErrors

◆ ARCMTMigrateReportOut

◆ ASTDumpAll

◆ ASTDumpDecls

◆ ASTDumpDeclTypes

◆ ASTDumpFilter

◆ ASTDumpFormat

◆ ASTDumpLookups

◆ ASTMergeFiles

◆ AuxTargetCPU

◆ AuxTargetFeatures

◆ AuxTriple

◆ BuildingImplicitModule

◆ BuildingImplicitModuleUsesLock

◆ CodeCompleteOpts

◆ CodeCompletionAt

◆ DashX

◆ DisableFree

◆ EmitExtensionSymbolGraphs

◆ EmitPrettySymbolGraphs

◆ EmitSymbolGraph

◆ EmitSymbolGraphSymbolLabelsForTesting

◆ ExtractAPIIgnoresFileList

◆ FixAndRecompile

◆ FixItSuffix

◆ FixOnlyWarnings

◆ FixToTemporaries

◆ FixWhatYouCan

◆ GenerateGlobalModuleIndex

◆ GenReducedBMI

◆ IncludeTimestamps

◆ Inputs

◆ IsSystemModule

◆ LLVMArgs

◆ ModuleFileExtensions

◆ ModuleFiles

◆ ModuleMapFiles

◆ ModuleOutputPath

◆ ModulesEmbedAllFiles

◆ ModulesEmbedFiles

◆ ModulesShareFileManager

◆ MTMigrateDir

◆ ObjCMTAction

◆ ObjCMTAllowListPath

◆ OriginalModuleMap

◆ OutputFile

◆ OverrideRecordLayoutsFile

◆ PluginArgs

◆ Plugins

◆ PrintEnabledExtensions

◆ PrintSupportedCPUs

◆ PrintSupportedExtensions

◆ ProductName

◆ ProgramAction

◆ RelocatablePCH

◆ ShowHelp

◆ ShowStats

◆ ShowVersion

◆ SkipFunctionBodies

◆ StatsFile

◆ SymbolGraphOutputDir

◆ TimeTraceGranularity