clang
10.0.0git
|
PreprocessorOptions - This class is used for passing the various options used in preprocessor initialization to InitializePreprocessor(). More...
#include "clang/Lex/PreprocessorOptions.h"
Classes | |
class | FailedModulesSet |
Records the set of modules. More... | |
Public Member Functions | |
PreprocessorOptions () | |
void | addMacroDef (StringRef Name) |
void | addMacroUndef (StringRef Name) |
void | addRemappedFile (StringRef From, StringRef To) |
void | addRemappedFile (StringRef From, llvm::MemoryBuffer *To) |
void | clearRemappedFiles () |
void | resetNonModularOptions () |
Reset any options that are not considered when building a module. More... | |
Public Attributes | |
std::vector< std::pair< std::string, bool > > | Macros |
std::vector< std::string > | Includes |
std::vector< std::string > | MacroIncludes |
bool | UsePredefines = true |
Initialize the preprocessor with the compiler and target specific predefines. More... | |
bool | DetailedRecord = false |
Whether we should maintain a detailed record of all macro definitions and expansions. More... | |
bool | PCHWithHdrStop = false |
When true, we are creating or using a PCH where a #pragma hdrstop is expected to indicate the beginning or end of the PCH. More... | |
bool | PCHWithHdrStopCreate = false |
When true, we are creating a PCH or creating the PCH object while expecting a #pragma hdrstop to separate the two. More... | |
std::string | PCHThroughHeader |
If non-empty, the filename used in an #include directive in the primary source file (or command-line preinclude) that is used to implement MSVC-style precompiled headers. More... | |
std::string | ImplicitPCHInclude |
The implicit PCH included at the start of the translation unit, or empty. More... | |
std::vector< std::string > | ChainedIncludes |
Headers that will be converted to chained PCHs in memory. More... | |
bool | DisablePCHValidation = false |
When true, disables most of the normal validation performed on precompiled headers. More... | |
bool | AllowPCHWithCompilerErrors = false |
When true, a PCH with compiler errors will not be rejected. More... | |
bool | DumpDeserializedPCHDecls = false |
Dump declarations that are deserialized from PCH, for testing. More... | |
std::set< std::string > | DeserializedPCHDeclsToErrorOn |
This is a set of names for decls that we do not want to be deserialized, and we emit an error if they are; for testing purposes. More... | |
std::pair< unsigned, bool > | PrecompiledPreambleBytes |
If non-zero, the implicit PCH include is actually a precompiled preamble that covers this number of bytes in the main source file. More... | |
bool | GeneratePreamble = false |
True indicates that a preamble is being generated. More... | |
bool | WriteCommentListToPCH = true |
Whether to write comment locations into the PCH when building it. More... | |
bool | SingleFileParseMode = false |
When enabled, preprocessor is in a mode for parsing a single file only. More... | |
bool | LexEditorPlaceholders = true |
When enabled, the preprocessor will construct editor placeholder tokens. More... | |
bool | RemappedFilesKeepOriginalName = true |
True if the SourceManager should report the original file name for contents of files that were remapped to other files. More... | |
std::vector< std::pair< std::string, std::string > > | RemappedFiles |
The set of file remappings, which take existing files on the system (the first part of each pair) and gives them the contents of other files on the system (the second part of each pair). More... | |
std::vector< std::pair< std::string, llvm::MemoryBuffer * > > | RemappedFileBuffers |
The set of file-to-buffer remappings, which take existing files on the system (the first part of each pair) and gives them the contents of the specified memory buffer (the second part of each pair). More... | |
bool | RetainRemappedFileBuffers = false |
Whether the compiler instance should retain (i.e., not free) the buffers associated with remapped files. More... | |
bool | RetainExcludedConditionalBlocks = false |
When enabled, excluded conditional blocks retain in the main file. More... | |
ObjCXXARCStandardLibraryKind | ObjCXXARCStandardLibrary = ARCXX_nolib |
The Objective-C++ ARC standard library that we should support, by providing appropriate definitions to retrofit the standard library with support for lifetime-qualified pointers. More... | |
std::shared_ptr< FailedModulesSet > | FailedModules |
The set of modules that failed to build. More... | |
std::map< std::string, std::string, std::greater< std::string > > | MacroPrefixMap |
A prefix map for FILE and BASE_FILE. More... | |
ExcludedPreprocessorDirectiveSkipMapping * | ExcludedConditionalDirectiveSkipMappings = nullptr |
Contains the currently active skipped range mappings for skipping excluded conditional directives. More... | |
bool | SetUpStaticAnalyzer = false |
Set up preprocessor for RunAnalysis action. More... | |
bool | DisablePragmaDebugCrash = false |
Prevents intended crashes when using #pragma clang __debug. For testing. More... | |
PreprocessorOptions - This class is used for passing the various options used in preprocessor initialization to InitializePreprocessor().
Definition at line 45 of file PreprocessorOptions.h.
|
inline |
Definition at line 196 of file PreprocessorOptions.h.
|
inline |
Definition at line 198 of file PreprocessorOptions.h.
|
inline |
Definition at line 199 of file PreprocessorOptions.h.
|
inline |
Definition at line 201 of file PreprocessorOptions.h.
Referenced by clang::arcmt::FileRemapper::applyMappings(), clang::PrecompiledPreamble::Build(), and clang::ASTUnit::CodeComplete().
|
inline |
Definition at line 205 of file PreprocessorOptions.h.
|
inline |
Definition at line 209 of file PreprocessorOptions.h.
Referenced by clang::ASTUnit::CodeComplete(), and clang::ASTUnit::Reparse().
|
inline |
Reset any options that are not considered when building a module.
Definition at line 216 of file PreprocessorOptions.h.
When true, a PCH with compiler errors will not be rejected.
Definition at line 87 of file PreprocessorOptions.h.
Referenced by clang::GeneratePCHAction::CreateASTConsumer(), clang::ASTUnit::LoadFromCommandLine(), and ParsePreprocessorArgs().
std::vector<std::string> clang::PreprocessorOptions::ChainedIncludes |
Headers that will be converted to chained PCHs in memory.
Definition at line 80 of file PreprocessorOptions.h.
Referenced by clang::createChainedIncludesSource().
std::set<std::string> clang::PreprocessorOptions::DeserializedPCHDeclsToErrorOn |
This is a set of names for decls that we do not want to be deserialized, and we emit an error if they are; for testing purposes.
Definition at line 94 of file PreprocessorOptions.h.
Referenced by ParsePreprocessorArgs().
Whether we should maintain a detailed record of all macro definitions and expansions.
Definition at line 57 of file PreprocessorOptions.h.
Referenced by checkPreprocessorOptions(), clang::ASTUnit::CodeComplete(), clang::CompilerInstance::createPreprocessor(), clang::CompilerInvocation::getModuleHash(), and ParsePreprocessorArgs().
When true, disables most of the normal validation performed on precompiled headers.
Definition at line 84 of file PreprocessorOptions.h.
Referenced by clang::CompilerInstance::createASTReader(), and ParsePreprocessorArgs().
Prevents intended crashes when using #pragma clang __debug. For testing.
Definition at line 193 of file PreprocessorOptions.h.
Referenced by clang::Preprocessor::LexOnOffSwitch().
Dump declarations that are deserialized from PCH, for testing.
Definition at line 90 of file PreprocessorOptions.h.
Referenced by ParsePreprocessorArgs().
ExcludedPreprocessorDirectiveSkipMapping* clang::PreprocessorOptions::ExcludedConditionalDirectiveSkipMappings = nullptr |
Contains the currently active skipped range mappings for skipping excluded conditional directives.
The pointer is passed to the Preprocessor when it's constructed. The pointer is unowned, the client is responsible for its lifetime.
Definition at line 187 of file PreprocessorOptions.h.
std::shared_ptr<FailedModulesSet> clang::PreprocessorOptions::FailedModules |
The set of modules that failed to build.
This pointer will be shared among all of the compiler instances created to (re)build modules, so that once a module fails to build anywhere, other instances will see that the module has failed and won't try to build it again.
Definition at line 176 of file PreprocessorOptions.h.
Referenced by compileModuleImpl(), and selectModuleSource().
True indicates that a preamble is being generated.
When the lexer is done, one of the things that need to be preserved is the conditional if stack, so the ASTWriter/ASTReader can save/restore it when processing the rest of the file.
Definition at line 108 of file PreprocessorOptions.h.
Referenced by clang::PrecompiledPreamble::Build().
std::string clang::PreprocessorOptions::ImplicitPCHInclude |
The implicit PCH included at the start of the translation unit, or empty.
Definition at line 77 of file PreprocessorOptions.h.
Referenced by clang::FrontendAction::BeginSourceFile(), checkPreprocessorOptions(), collectIncludePCH(), createInvocationForMigration(), clang::PrecompiledPreamble::OverridePreamble(), and ParsePreprocessorArgs().
std::vector<std::string> clang::PreprocessorOptions::Includes |
Definition at line 48 of file PreprocessorOptions.h.
Referenced by checkPreprocessorOptions(), createInvocationForMigration(), and clang::CompilerInvocation::setLangDefaults().
When enabled, the preprocessor will construct editor placeholder tokens.
Definition at line 123 of file PreprocessorOptions.h.
Referenced by findPlaceholderEnd().
std::vector<std::string> clang::PreprocessorOptions::MacroIncludes |
Definition at line 49 of file PreprocessorOptions.h.
Referenced by checkPreprocessorOptions().
std::map<std::string, std::string, std::greater<std::string> > clang::PreprocessorOptions::MacroPrefixMap |
A prefix map for FILE and BASE_FILE.
Definition at line 179 of file PreprocessorOptions.h.
Referenced by ParsePreprocessorArgs().
std::vector<std::pair<std::string, bool> > clang::PreprocessorOptions::Macros |
Definition at line 47 of file PreprocessorOptions.h.
Referenced by collectMacroDefinitions().
ObjCXXARCStandardLibraryKind clang::PreprocessorOptions::ObjCXXARCStandardLibrary = ARCXX_nolib |
The Objective-C++ ARC standard library that we should support, by providing appropriate definitions to retrofit the standard library with support for lifetime-qualified pointers.
Definition at line 154 of file PreprocessorOptions.h.
std::string clang::PreprocessorOptions::PCHThroughHeader |
If non-empty, the filename used in an #include directive in the primary source file (or command-line preinclude) that is used to implement MSVC-style precompiled headers.
When creating a PCH, after the #include of this header, the PCH generation stops. When using a PCH, tokens are skipped until after an #include of this header is seen.
Definition at line 74 of file PreprocessorOptions.h.
Referenced by checkPreprocessorOptions(), and ParsePreprocessorArgs().
When true, we are creating or using a PCH where a #pragma hdrstop is expected to indicate the beginning or end of the PCH.
Definition at line 61 of file PreprocessorOptions.h.
Referenced by ParsePreprocessorArgs().
When true, we are creating a PCH or creating the PCH object while expecting a #pragma hdrstop to separate the two.
Allow for a missing #pragma hdrstop, which generates a PCH for the whole file, and creates an empty PCH object.
Definition at line 67 of file PreprocessorOptions.h.
Referenced by ParsePreprocessorArgs().
std::pair<unsigned, bool> clang::PreprocessorOptions::PrecompiledPreambleBytes |
If non-zero, the implicit PCH include is actually a precompiled preamble that covers this number of bytes in the main source file.
The boolean indicates whether the preamble ends at the start of a new line.
Definition at line 101 of file PreprocessorOptions.h.
Referenced by clang::PrecompiledPreamble::Build(), clang::ASTUnit::CodeComplete(), clang::CompilerInstance::createPCHExternalASTSource(), clang::VerifyPCHAction::ExecuteAction(), and ParsePreprocessorArgs().
std::vector<std::pair<std::string, llvm::MemoryBuffer *> > clang::PreprocessorOptions::RemappedFileBuffers |
The set of file-to-buffer remappings, which take existing files on the system (the first part of each pair) and gives them the contents of the specified memory buffer (the second part of each pair).
Definition at line 138 of file PreprocessorOptions.h.
Referenced by InitializeFileRemapping(), clang::ASTUnit::Reparse(), and clang::ASTUnit::~ASTUnit().
std::vector<std::pair<std::string, std::string> > clang::PreprocessorOptions::RemappedFiles |
The set of file remappings, which take existing files on the system (the first part of each pair) and gives them the contents of other files on the system (the second part of each pair).
Definition at line 133 of file PreprocessorOptions.h.
Referenced by clang::FixItRecompile::BeginInvocation(), clang::arcmt::getFileRemappings(), and InitializeFileRemapping().
True if the SourceManager should report the original file name for contents of files that were remapped to other files.
Defaults to true.
Definition at line 127 of file PreprocessorOptions.h.
Referenced by clang::FixItRecompile::BeginInvocation(), InitializeFileRemapping(), and clang::ASTUnit::LoadFromCommandLine().
When enabled, excluded conditional blocks retain in the main file.
Definition at line 149 of file PreprocessorOptions.h.
Referenced by clang::ASTUnit::LoadFromCommandLine().
Whether the compiler instance should retain (i.e., not free) the buffers associated with remapped files.
This flag defaults to false; it can be set true only through direct manipulation of the compiler invocation object, in cases where the compiler invocation and its buffers will be reused.
Definition at line 146 of file PreprocessorOptions.h.
Referenced by clang::arcmt::FileRemapper::applyMappings(), clang::PrecompiledPreamble::Build(), clang::ASTUnit::CodeComplete(), and InitializeFileRemapping().
Set up preprocessor for RunAnalysis action.
Definition at line 190 of file PreprocessorOptions.h.
When enabled, preprocessor is in a mode for parsing a single file only.
Disables #includes of other files and if there are unresolved identifiers in preprocessor directive conditions it causes all blocks to be parsed so that the client can get the maximum amount of information from the parser.
Definition at line 120 of file PreprocessorOptions.h.
Referenced by clang::ASTUnit::LoadFromCommandLine().
Initialize the preprocessor with the compiler and target specific predefines.
Definition at line 53 of file PreprocessorOptions.h.
Referenced by checkPreprocessorOptions(), clang::CompilerInvocation::getModuleHash(), and ParsePreprocessorArgs().
Whether to write comment locations into the PCH when building it.
Reading the comments from the PCH can be a performance hit even if the clients don't use them.
Definition at line 113 of file PreprocessorOptions.h.