clang  3.9.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
clang::FrontendOptions Class Reference

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

#include <FrontendOptions.h>

Collaboration diagram for clang::FrontendOptions:
[legend]

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. More...
 

Public Attributes

unsigned DisableFree: 1
 Disable memory freeing on exit. More...
 
unsigned RelocatablePCH: 1
 When generating PCH files, instruct the AST writer to create relocatable PCH files. More...
 
unsigned ShowHelp: 1
 Show the -help text. More...
 
unsigned ShowStats: 1
 Show frontend performance metrics and statistics. More...
 
unsigned ShowTimers: 1
 Show timers for individual actions. More...
 
unsigned ShowVersion: 1
 Show the -version text. More...
 
unsigned FixWhatYouCan: 1
 Apply fixes even if there are unfixable errors. More...
 
unsigned FixOnlyWarnings: 1
 Apply fixes only for warnings. More...
 
unsigned FixAndRecompile: 1
 Apply fixes and recompile. More...
 
unsigned FixToTemporaries: 1
 Apply fixes to temporary files. More...
 
unsigned ARCMTMigrateEmitARCErrors: 1
 
unsigned SkipFunctionBodies: 1
 Emit ARC errors even if the migrator can fix them. More...
 
unsigned UseGlobalModuleIndex: 1
 Whether we can use the global module index if available. More...
 
unsigned GenerateGlobalModuleIndex: 1
 Whether we can generate the global module index if needed. More...
 
unsigned ASTDumpDecls: 1
 Whether we include declaration dumps in AST dumps. More...
 
unsigned ASTDumpLookups: 1
 Whether we include lookup table dumps in AST dumps. More...
 
unsigned BuildingImplicitModule: 1
 Whether we are performing an implicit module build. More...
 
unsigned ModulesEmbedAllFiles: 1
 Whether we should embed all used files into the PCM file. More...
 
unsigned IncludeTimestamps: 1
 Whether timestamps should be written to the produced PCH file. More...
 
CodeCompleteOptions CodeCompleteOpts
 
enum clang::FrontendOptions:: { ... }  ARCMTAction
 
unsigned ObjCMTAction
 
std::string ObjCMTWhiteListPath
 
std::string MTMigrateDir
 
std::string ARCMTMigrateReportOut
 
std::vector< FrontendInputFileInputs
 The input files and their types. More...
 
std::string OutputFile
 The output file, if any. More...
 
std::string FixItSuffix
 If given, the new suffix for fix-it rewritten files. More...
 
std::string ASTDumpFilter
 If given, filter dumped AST Decl nodes by this substring. More...
 
ParsedSourceLocation CodeCompletionAt
 If given, enable code completion at the provided location. More...
 
frontend::ActionKind ProgramAction
 The frontend action to perform. More...
 
std::string ActionName
 The name of the action to run when using a plugin action. More...
 
std::unordered_map
< std::string, std::vector
< std::string > > 
PluginArgs
 Args to pass to the plugins. More...
 
std::vector< std::string > AddPluginActions
 The list of plugin actions to run in addition to the normal action. More...
 
std::vector< std::string > Plugins
 The list of plugins to load. More...
 
std::vector
< IntrusiveRefCntPtr
< ModuleFileExtension > > 
ModuleFileExtensions
 The list of module file extensions. More...
 
std::vector< std::string > ModuleMapFiles
 The list of module map files to load before processing the input. More...
 
std::vector< std::string > ModuleFiles
 The list of additional prebuilt module files to load before processing the input. More...
 
std::vector< std::string > ModulesEmbedFiles
 The list of files to embed into the compiled module file. More...
 
std::vector< std::string > ASTMergeFiles
 The list of AST files to merge. More...
 
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. More...
 
std::string OverrideRecordLayoutsFile
 File name of the file that will provide record layouts (in the format produced by -fdump-record-layouts). More...
 
std::string AuxTriple
 Auxiliary triple for CUDA compilation. More...
 
std::string FindPchSource
 If non-empty, search the pch input file as it was a header. More...
 

Detailed Description

FrontendOptions - Options for controlling the behavior of the frontend.

Definition at line 122 of file FrontendOptions.h.

Member Enumeration Documentation

anonymous enum
Enumerator
ARCMT_None 
ARCMT_Check 
ARCMT_Modify 
ARCMT_Migrate 

Definition at line 162 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 169 of file FrontendOptions.h.

Constructor & Destructor Documentation

clang::FrontendOptions::FrontendOptions ( )
inline

Definition at line 275 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_PreprocessedCuda, 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 232 of file FrontendOptions.h.

Referenced by CreateFrontendBaseAction(), clang::ExecuteCompilerInvocation(), 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 238 of file FrontendOptions.h.

Referenced by ParseFrontendArgs().

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

Definition at line 139 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

std::string clang::FrontendOptions::ARCMTMigrateReportOut

Definition at line 211 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::ASTDumpDecls

Whether we include declaration dumps in AST dumps.

Definition at line 149 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 223 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 151 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 257 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

std::string clang::FrontendOptions::AuxTriple

Auxiliary triple for CUDA compilation.

Definition at line 268 of file FrontendOptions.h.

Referenced by clang::CompilerInvocation::CreateFromArgs(), clang::CompilerInstance::ExecuteAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::BuildingImplicitModule

Whether we are performing an implicit module build.

Definition at line 153 of file FrontendOptions.h.

Referenced by compileModuleImpl(), and clang::GenerateModuleAction::CreateASTConsumer().

CodeCompleteOptions clang::FrontendOptions::CodeCompleteOpts

Definition at line 160 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 226 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::DisableFree
std::string clang::FrontendOptions::FindPchSource

If non-empty, search the pch input file as it was a header.

Definition at line 272 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::FixAndRecompile

Apply fixes and recompile.

Definition at line 137 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 220 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::FixOnlyWarnings

Apply fixes only for warnings.

Definition at line 136 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::FixToTemporaries

Apply fixes to temporary files.

Definition at line 138 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 134 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 147 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::IncludeTimestamps

Whether timestamps should be written to the produced PCH file.

Definition at line 157 of file FrontendOptions.h.

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

std::vector<FrontendInputFile> clang::FrontendOptions::Inputs
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 261 of file FrontendOptions.h.

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

std::vector<IntrusiveRefCntPtr<ModuleFileExtension> > clang::FrontendOptions::ModuleFileExtensions
std::vector<std::string> clang::FrontendOptions::ModuleFiles

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

Definition at line 251 of file FrontendOptions.h.

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

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

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

Definition at line 247 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ModulesEmbedAllFiles

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

Definition at line 155 of file FrontendOptions.h.

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

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

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

Definition at line 254 of file FrontendOptions.h.

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

std::string clang::FrontendOptions::MTMigrateDir

Definition at line 210 of file FrontendOptions.h.

Referenced by CreateFrontendAction(), and ParseFrontendArgs().

unsigned clang::FrontendOptions::ObjCMTAction
std::string clang::FrontendOptions::ObjCMTWhiteListPath
std::string clang::FrontendOptions::OutputFile
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 265 of file FrontendOptions.h.

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

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

Args to pass to the plugins.

Definition at line 235 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 241 of file FrontendOptions.h.

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

frontend::ActionKind clang::FrontendOptions::ProgramAction
unsigned clang::FrontendOptions::RelocatablePCH

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

Definition at line 125 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 128 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowStats

Show frontend performance metrics and statistics.

Definition at line 129 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 131 of file FrontendOptions.h.

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

unsigned clang::FrontendOptions::ShowVersion

Show the -version text.

Definition at line 133 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 141 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 145 of file FrontendOptions.h.

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


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