clang  8.0.0svn
Classes | Public Member Functions | Public Attributes | List of all members
clang::PreprocessorOptions Class Reference

PreprocessorOptions - This class is used for passing the various options used in preprocessor initialization to InitializePreprocessor(). More...

#include "clang/Lex/PreprocessorOptions.h"

Collaboration diagram for clang::PreprocessorOptions:
Collaboration graph
[legend]

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, boolPrecompiledPreambleBytes
 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...
 
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< FailedModulesSetFailedModules
 The set of modules that failed to build. More...
 

Detailed Description

PreprocessorOptions - This class is used for passing the various options used in preprocessor initialization to InitializePreprocessor().

Definition at line 43 of file PreprocessorOptions.h.

Constructor & Destructor Documentation

◆ PreprocessorOptions()

clang::PreprocessorOptions::PreprocessorOptions ( )
inline

Definition at line 174 of file PreprocessorOptions.h.

Member Function Documentation

◆ addMacroDef()

void clang::PreprocessorOptions::addMacroDef ( StringRef  Name)
inline

Definition at line 176 of file PreprocessorOptions.h.

◆ addMacroUndef()

void clang::PreprocessorOptions::addMacroUndef ( StringRef  Name)
inline

Definition at line 177 of file PreprocessorOptions.h.

◆ addRemappedFile() [1/2]

void clang::PreprocessorOptions::addRemappedFile ( StringRef  From,
StringRef  To 
)
inline

◆ addRemappedFile() [2/2]

void clang::PreprocessorOptions::addRemappedFile ( StringRef  From,
llvm::MemoryBuffer *  To 
)
inline

Definition at line 183 of file PreprocessorOptions.h.

◆ clearRemappedFiles()

void clang::PreprocessorOptions::clearRemappedFiles ( )
inline

Definition at line 187 of file PreprocessorOptions.h.

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

◆ resetNonModularOptions()

void clang::PreprocessorOptions::resetNonModularOptions ( )
inline

Reset any options that are not considered when building a module.

Definition at line 194 of file PreprocessorOptions.h.

Member Data Documentation

◆ AllowPCHWithCompilerErrors

bool clang::PreprocessorOptions::AllowPCHWithCompilerErrors = false

When true, a PCH with compiler errors will not be rejected.

Definition at line 85 of file PreprocessorOptions.h.

Referenced by clang::FrontendAction::BeginSourceFile(), clang::GeneratePCHAction::CreateASTConsumer(), clang::ASTUnit::LoadFromCommandLine(), and ParsePreprocessorArgs().

◆ ChainedIncludes

std::vector<std::string> clang::PreprocessorOptions::ChainedIncludes

Headers that will be converted to chained PCHs in memory.

Definition at line 78 of file PreprocessorOptions.h.

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

◆ DeserializedPCHDeclsToErrorOn

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 92 of file PreprocessorOptions.h.

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

◆ DetailedRecord

bool clang::PreprocessorOptions::DetailedRecord = false

Whether we should maintain a detailed record of all macro definitions and expansions.

Definition at line 55 of file PreprocessorOptions.h.

Referenced by checkPreprocessorOptions(), clang::ASTUnit::CodeComplete(), clang::CompilerInstance::createPreprocessor(), clang::CompilerInvocation::getModuleHash(), and ParsePreprocessorArgs().

◆ DisablePCHValidation

bool clang::PreprocessorOptions::DisablePCHValidation = false

When true, disables most of the normal validation performed on precompiled headers.

Definition at line 82 of file PreprocessorOptions.h.

Referenced by clang::FrontendAction::BeginSourceFile(), clang::CompilerInstance::createModuleManager(), and ParsePreprocessorArgs().

◆ DumpDeserializedPCHDecls

bool clang::PreprocessorOptions::DumpDeserializedPCHDecls = false

Dump declarations that are deserialized from PCH, for testing.

Definition at line 88 of file PreprocessorOptions.h.

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

◆ FailedModules

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 171 of file PreprocessorOptions.h.

Referenced by compileModuleImpl(), and clang::CompilerInstance::loadModule().

◆ GeneratePreamble

bool clang::PreprocessorOptions::GeneratePreamble = false

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 106 of file PreprocessorOptions.h.

Referenced by clang::PrecompiledPreamble::Build().

◆ ImplicitPCHInclude

std::string clang::PreprocessorOptions::ImplicitPCHInclude

◆ Includes

std::vector<std::string> clang::PreprocessorOptions::Includes

◆ LexEditorPlaceholders

bool clang::PreprocessorOptions::LexEditorPlaceholders = true

When enabled, the preprocessor will construct editor placeholder tokens.

Definition at line 121 of file PreprocessorOptions.h.

Referenced by findPlaceholderEnd().

◆ MacroIncludes

std::vector<std::string> clang::PreprocessorOptions::MacroIncludes

Definition at line 47 of file PreprocessorOptions.h.

Referenced by checkPreprocessorOptions().

◆ Macros

std::vector<std::pair<std::string, bool> > clang::PreprocessorOptions::Macros

Definition at line 45 of file PreprocessorOptions.h.

Referenced by collectMacroDefinitions().

◆ ObjCXXARCStandardLibrary

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 149 of file PreprocessorOptions.h.

◆ PCHThroughHeader

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 72 of file PreprocessorOptions.h.

Referenced by checkPreprocessorOptions(), and ParsePreprocessorArgs().

◆ PCHWithHdrStop

bool clang::PreprocessorOptions::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.

Definition at line 59 of file PreprocessorOptions.h.

Referenced by ParsePreprocessorArgs().

◆ PCHWithHdrStopCreate

bool clang::PreprocessorOptions::PCHWithHdrStopCreate = false

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 65 of file PreprocessorOptions.h.

Referenced by ParsePreprocessorArgs().

◆ PrecompiledPreambleBytes

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 99 of file PreprocessorOptions.h.

Referenced by clang::PrecompiledPreamble::Build(), clang::ASTUnit::CodeComplete(), clang::CompilerInstance::createPCHExternalASTSource(), clang::VerifyPCHAction::ExecuteAction(), and ParsePreprocessorArgs().

◆ RemappedFileBuffers

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 136 of file PreprocessorOptions.h.

Referenced by InitializeFileRemapping(), clang::ASTUnit::Reparse(), and clang::ASTUnit::~ASTUnit().

◆ RemappedFiles

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 131 of file PreprocessorOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation(), clang::arcmt::getFileRemappings(), and InitializeFileRemapping().

◆ RemappedFilesKeepOriginalName

bool clang::PreprocessorOptions::RemappedFilesKeepOriginalName = true

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 125 of file PreprocessorOptions.h.

Referenced by clang::FixItRecompile::BeginInvocation(), InitializeFileRemapping(), and clang::ASTUnit::LoadFromCommandLine().

◆ RetainRemappedFileBuffers

bool clang::PreprocessorOptions::RetainRemappedFileBuffers = false

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 144 of file PreprocessorOptions.h.

Referenced by clang::arcmt::FileRemapper::applyMappings(), clang::PrecompiledPreamble::Build(), clang::ASTUnit::CodeComplete(), and InitializeFileRemapping().

◆ SingleFileParseMode

bool clang::PreprocessorOptions::SingleFileParseMode = false

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 118 of file PreprocessorOptions.h.

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

◆ UsePredefines

bool clang::PreprocessorOptions::UsePredefines = true

Initialize the preprocessor with the compiler and target specific predefines.

Definition at line 51 of file PreprocessorOptions.h.

Referenced by checkPreprocessorOptions(), clang::CompilerInvocation::getModuleHash(), and ParsePreprocessorArgs().

◆ WriteCommentListToPCH

bool clang::PreprocessorOptions::WriteCommentListToPCH = true

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 111 of file PreprocessorOptions.h.


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