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

#include <FrontendOptions.h>

Collaboration diagram for clang::FrontendOptions:

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)
Public Attributes
unsigned	DisableFree: 1
	Disable memory freeing on exit.
unsigned	RelocatablePCH: 1
unsigned	ShowHelp: 1
	Show the -help text.
unsigned	ShowStats: 1
unsigned	ShowTimers: 1
unsigned	ShowVersion: 1
	Show the -version text.
unsigned	FixWhatYouCan: 1
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
unsigned	SkipFunctionBodies: 1
unsigned	UseGlobalModuleIndex: 1
unsigned	GenerateGlobalModuleIndex: 1
unsigned	ASTDumpDecls: 1
unsigned	ASTDumpLookups: 1
CodeCompleteOptions	CodeCompleteOpts
enum clang::FrontendOptions:: { ... }	ARCMTAction
unsigned	ObjCMTAction
std::string	ObjCMTWhiteListPath
std::string	MTMigrateDir
std::string	ARCMTMigrateReportOut
std::vector< FrontendInputFile >	Inputs
	The input files and their types.
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
	The frontend action to perform.
std::string	ActionName
	The name of the action to run when using a plugin action.
std::vector< std::string >	PluginArgs
	Args to pass to the plugin.
std::vector< std::string >	AddPluginActions
	The list of plugin actions to run in addition to the normal action.
std::vector< std::vector < std::string > >	AddPluginArgs
	Args to pass to the additional plugins.
std::vector< std::string >	Plugins
	The list of plugins to load.
std::vector< std::string >	ModuleFiles
	The list of additional prebuilt module files to load before processing the input.
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).

Detailed Description

FrontendOptions - Options for controlling the behavior of the frontend.

Definition at line 118 of file FrontendOptions.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

ARCMT_None
ARCMT_Check
ARCMT_Modify
ARCMT_Migrate

Definition at line 152 of file FrontendOptions.h.

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 159 of file FrontendOptions.h.

Constructor & Destructor Documentation

clang::FrontendOptions::FrontendOptions ( ) [inline]

Definition at line 252 of file FrontendOptions.h.

Member Function Documentation

InputKind FrontendOptions::getInputKindForExtension ( StringRef Extension ) [static]

getInputKindForExtension - Return the appropriate input kind for a file extension. For example, "c" would return IK_C.

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

Definition at line 14 of file FrontendOptions.cpp.

References clang::IK_Asm, clang::IK_AST, clang::IK_C, clang::IK_CUDA, clang::IK_CXX, clang::IK_LLVM_IR, clang::IK_ObjC, clang::IK_ObjCXX, clang::IK_OpenCL, clang::IK_PreprocessedC, clang::IK_PreprocessedCXX, clang::IK_PreprocessedObjC, and clang::IK_PreprocessedObjCXX.

Referenced by ParseFrontendArgs().

Member Data Documentation

std::string clang::FrontendOptions::ActionName

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

Definition at line 222 of file FrontendOptions.h.

Referenced by CreateFrontendBaseAction(), and ParseFrontendArgs().

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

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

Definition at line 228 of file FrontendOptions.h.

Referenced by ParseFrontendArgs().

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

Args to pass to the additional plugins.

Definition at line 231 of file FrontendOptions.h.

Referenced by ParseFrontendArgs().

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

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::ARCMTMigrateEmitARCErrors

Definition at line 135 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

std::string clang::FrontendOptions::ARCMTMigrateReportOut

Definition at line 201 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::ASTDumpDecls

Whether we include declaration dumps in AST dumps.

Definition at line 145 of file FrontendOptions.h.

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

std::string clang::FrontendOptions::ASTDumpFilter

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

Definition at line 213 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ASTDumpLookups

Whether we include lookup table dumps in AST dumps.

Definition at line 147 of file FrontendOptions.h.

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

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

The list of AST files to merge.

Definition at line 241 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

CodeCompleteOptions clang::FrontendOptions::CodeCompleteOpts

Definition at line 150 of file FrontendOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), and ParseFrontendArgs().

ParsedSourceLocation clang::FrontendOptions::CodeCompletionAt

If given, enable code completion at the provided location.

Definition at line 216 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::DisableFree

Disable memory freeing on exit.

Definition at line 120 of file FrontendOptions.h.

Referenced by compileModuleImpl(), clang::FrontendAction::EndSourceFile(), clang::ExecuteCompilerInvocation(), clang::ASTUnit::LoadFromCompilerInvocationAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::FixAndRecompile

Apply fixes and recompile.

Definition at line 133 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

std::string clang::FrontendOptions::FixItSuffix

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

Definition at line 210 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::FixOnlyWarnings

Apply fixes only for warnings.

Definition at line 132 of file FrontendOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::FixToTemporaries

Apply fixes to temporary files.

Definition at line 134 of file FrontendOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::FixWhatYouCan

Apply fixes even if there are unfixable errors.

Definition at line 130 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::GenerateGlobalModuleIndex

Whether we can generate the global module index if needed.

Definition at line 143 of file FrontendOptions.h.

Referenced by compileModuleImpl(), ParseFrontendArgs(), and clang::CompilerInstance::shouldBuildGlobalModuleIndex().

std::vector<FrontendInputFile> clang::FrontendOptions::Inputs

The input files and their types.

Definition at line 204 of file FrontendOptions.h.

Referenced by applyTransforms(), clang::FixItRecompile::BeginInvocation(), compileModuleImpl(), clang::createChainedIncludesSource(), clang::ASTUnit::getMainFileName(), and ParseFrontendArgs().

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 245 of file FrontendOptions.h.

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

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

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

Definition at line 238 of file FrontendOptions.h.

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

std::string clang::FrontendOptions::MTMigrateDir

Definition at line 200 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::ObjCMTAction

Definition at line 197 of file FrontendOptions.h.

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

std::string clang::FrontendOptions::ObjCMTWhiteListPath

Definition at line 198 of file FrontendOptions.h.

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

std::string clang::FrontendOptions::OutputFile

The output file, if any.

Definition at line 207 of file FrontendOptions.h.

Referenced by compileModuleImpl(), clang::GeneratePCHAction::ComputeASTConsumerArguments(), clang::GenerateModuleAction::ComputeASTConsumerArguments(), clang::ento::CreateAnalysisConsumer(), clang::arcmt::MigrateSourceAction::CreateASTConsumer(), clang::DumpModuleInfoAction::ExecuteAction(), clang::GeneratePTHAction::ExecuteAction(), and ParseFrontendArgs().

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 249 of file FrontendOptions.h.

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

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

Args to pass to the plugin.

Definition at line 225 of file FrontendOptions.h.

Referenced by CreateFrontendBaseAction(), and ParseFrontendArgs().

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

The list of plugins to load.

Definition at line 234 of file FrontendOptions.h.

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

frontend::ActionKind clang::FrontendOptions::ProgramAction

The frontend action to perform.

Definition at line 219 of file FrontendOptions.h.

Referenced by clang::CompilerInvocation::CreateFromArgs(), CreateFrontendAction(), CreateFrontendBaseAction(), InitializePredefinedMacros(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::RelocatablePCH

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

Definition at line 121 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowHelp

Show the -help text.

Definition at line 124 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowStats

Show frontend performance metrics and statistics.

Definition at line 125 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowTimers

Show timers for individual actions.

Definition at line 127 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowVersion

Show the -version text.

Definition at line 129 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::SkipFunctionBodies

Emit ARC errors even if the migrator can fix them Skip over function bodies to speed up parsing in cases you do not need them (e.g. with code completion).

Definition at line 137 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::UseGlobalModuleIndex

Whether we can use the global module index if available.

Definition at line 141 of file FrontendOptions.h.

Referenced by clang::CompilerInstance::createModuleManager(), and ParseFrontendArgs().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation