HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSearch object. More...

#include "clang/Lex/HeaderSearchOptions.h"

Collaboration diagram for clang::HeaderSearchOptions:

[legend]

Classes
struct	Entry

struct	SystemHeaderPrefix

Public Member Functions
	HeaderSearchOptions (StringRef _Sysroot="/")

void	AddPath (StringRef Path, frontend::IncludeDirGroup Group, bool IsFramework, bool IgnoreSysRoot)
	AddPath - Add the `Path` path to the specified `Group` list. More...

void	AddSystemHeaderPrefix (StringRef Prefix, bool IsSystemHeader)
	AddSystemHeaderPrefix - Override whether #include directives naming a path starting with `Prefix` should be considered as naming a system header. More...

void	AddVFSOverlayFile (StringRef Name)

void	AddPrebuiltModulePath (StringRef Name)

Public Attributes
std::string	Sysroot
	If non-empty, the directory to use as a "virtual system root" for include paths. More...

std::vector< Entry >	UserEntries
	User specified include entries. More...

std::vector< SystemHeaderPrefix >	SystemHeaderPrefixes
	User-specified system header prefixes. More...

std::string	ResourceDir
	The directory which holds the compiler resource files (builtin includes, etc.). More...

std::string	ModuleCachePath
	The directory used for the module cache. More...

std::string	ModuleUserBuildPath
	The directory used for a user build. More...

std::map< std::string, std::string >	PrebuiltModuleFiles
	The mapping of module names to prebuilt module files. More...

std::vector< std::string >	PrebuiltModulePaths
	The directories used to load prebuilt module files. More...

std::string	ModuleFormat
	The module/pch container format. More...

unsigned	DisableModuleHash: 1
	Whether we should disable the use of the hash string within the module cache. More...

unsigned	ImplicitModuleMaps: 1
	Implicit module maps. More...

unsigned	ModuleMapFileHomeIsCwd: 1
	Set the 'home directory' of a module map file to the current working directory (or the home directory of the module map file that contained the 'extern module' directive importing this module map file if any) rather than the directory containing the module map file. More...

unsigned	ModuleCachePruneInterval = 7 * 24 * 60 * 60
	The interval (in seconds) between pruning operations. More...

unsigned	ModuleCachePruneAfter = 31 * 24 * 60 * 60
	The time (in seconds) after which an unused module file will be considered unused and will, therefore, be pruned. More...

uint64_t	BuildSessionTimestamp = 0
	The time in seconds when the build session started. More...

llvm::SmallSetVector< llvm::CachedHashString, 16 >	ModulesIgnoreMacros
	The set of macro names that should be ignored for the purposes of computing the module hash. More...

std::vector< std::string >	VFSOverlayFiles
	The set of user-provided virtual filesystem overlay files. More...

unsigned	UseBuiltinIncludes: 1
	Include the compiler builtin includes. More...

unsigned	UseStandardSystemIncludes: 1
	Include the system standard include search directories. More...

unsigned	UseStandardCXXIncludes: 1
	Include the system standard C++ library include search directories. More...

unsigned	UseLibcxx: 1
	Use libc++ instead of the default libstdc++. More...

unsigned	Verbose: 1
	Whether header search information should be output as for -v. More...

unsigned	ModulesValidateOncePerBuildSession: 1
	If true, skip verifying input files used by modules if the module was already verified during this build session (see `BuildSessionTimestamp`). More...

unsigned	ModulesValidateSystemHeaders: 1
	Whether to validate system input files when a module is loaded. More...

unsigned	UseDebugInfo: 1
	Whether the module includes debug information (-gmodules). More...

unsigned	ModulesValidateDiagnosticOptions: 1

unsigned	ModulesHashContent: 1

Detailed Description

HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSearch object.

Definition at line 67 of file HeaderSearchOptions.h.

Constructor & Destructor Documentation

◆ HeaderSearchOptions()

clang::HeaderSearchOptions::HeaderSearchOptions ( StringRef _Sysroot = "/" )

inline

Definition at line 206 of file HeaderSearchOptions.h.

Member Function Documentation

◆ AddPath()

void clang::HeaderSearchOptions::AddPath	(	StringRef	Path,
		frontend::IncludeDirGroup	Group,
		bool	IsFramework,
		bool	IgnoreSysRoot
	)

inline

AddPath - Add the Path path to the specified Group list.

Definition at line 216 of file HeaderSearchOptions.h.

◆ AddPrebuiltModulePath()

void clang::HeaderSearchOptions::AddPrebuiltModulePath ( StringRef Name )

inline

Definition at line 232 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ AddSystemHeaderPrefix()

void clang::HeaderSearchOptions::AddSystemHeaderPrefix	(	StringRef	Prefix,
		bool	IsSystemHeader
	)

inline

AddSystemHeaderPrefix - Override whether #include directives naming a path starting with Prefix should be considered as naming a system header.

Definition at line 224 of file HeaderSearchOptions.h.

◆ AddVFSOverlayFile()

void clang::HeaderSearchOptions::AddVFSOverlayFile ( StringRef Name )

inline

Definition at line 228 of file HeaderSearchOptions.h.

Member Data Documentation

◆ BuildSessionTimestamp

uint64_t clang::HeaderSearchOptions::BuildSessionTimestamp = 0

The time in seconds when the build session started.

This time is used by other optimizations in header search and module loading.

Definition at line 167 of file HeaderSearchOptions.h.

Referenced by isDiagnosedResult(), and ParseHeaderSearchArgs().

◆ DisableModuleHash

unsigned clang::HeaderSearchOptions::DisableModuleHash

Whether we should disable the use of the hash string within the module cache.

Note: Only used for testing!

Definition at line 130 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInstance::getSpecificModuleCachePath(), and ParseHeaderSearchArgs().

◆ ImplicitModuleMaps

unsigned clang::HeaderSearchOptions::ImplicitModuleMaps

Implicit module maps.

This option is enabld by default when modules is enabled.

Definition at line 134 of file HeaderSearchOptions.h.

Referenced by clang::ModuleMap::isBuiltinHeader(), and ParseHeaderSearchArgs().

◆ ModuleCachePath

std::string clang::HeaderSearchOptions::ModuleCachePath

The directory used for the module cache.

Definition at line 112 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs(), and pruneModuleCache().

◆ ModuleCachePruneAfter

unsigned clang::HeaderSearchOptions::ModuleCachePruneAfter = 31 * 24 * 60 * 60

The time (in seconds) after which an unused module file will be considered unused and will, therefore, be pruned.

When the module cache is pruned, any module file that has not been accessed in this many seconds will be removed. The default value is large, e.g., a month, to avoid forcing infrequently-used modules to be regenerated often.

Definition at line 161 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs(), and pruneModuleCache().

◆ ModuleCachePruneInterval

unsigned clang::HeaderSearchOptions::ModuleCachePruneInterval = 7 * 24 * 60 * 60

The interval (in seconds) between pruning operations.

This operation is expensive, because it requires Clang to walk through the directory structure of the module cache, stat()'ing and removing files.

The default value is large, e.g., the operation runs once a week.

Definition at line 152 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs(), and pruneModuleCache().

◆ ModuleFormat

std::string clang::HeaderSearchOptions::ModuleFormat

The module/pch container format.

Definition at line 124 of file HeaderSearchOptions.h.

Referenced by clang::DumpModuleInfoAction::BeginInvocation(), and ParseHeaderSearchArgs().

◆ ModuleMapFileHomeIsCwd

unsigned clang::HeaderSearchOptions::ModuleMapFileHomeIsCwd

Set the 'home directory' of a module map file to the current working directory (or the home directory of the module map file that contained the 'extern module' directive importing this module map file if any) rather than the directory containing the module map file.

The home directory is where we look for files named in the module map file.

Definition at line 143 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ ModulesHashContent

unsigned clang::HeaderSearchOptions::ModulesHashContent

Definition at line 204 of file HeaderSearchOptions.h.

Referenced by compileModuleImpl(), and ParseHeaderSearchArgs().

◆ ModulesIgnoreMacros

llvm::SmallSetVector<llvm::CachedHashString, 16> clang::HeaderSearchOptions::ModulesIgnoreMacros

The set of macro names that should be ignored for the purposes of computing the module hash.

Definition at line 171 of file HeaderSearchOptions.h.

Referenced by compileModuleImpl(), and ParseHeaderSearchArgs().

◆ ModulesValidateDiagnosticOptions

unsigned clang::HeaderSearchOptions::ModulesValidateDiagnosticOptions

Definition at line 202 of file HeaderSearchOptions.h.

Referenced by moduleKindForDiagnostic(), and ParseHeaderSearchArgs().

◆ ModulesValidateOncePerBuildSession

unsigned clang::HeaderSearchOptions::ModulesValidateOncePerBuildSession

If true, skip verifying input files used by modules if the module was already verified during this build session (see BuildSessionTimestamp).

Definition at line 194 of file HeaderSearchOptions.h.

Referenced by isDiagnosedResult(), and ParseHeaderSearchArgs().

◆ ModulesValidateSystemHeaders

unsigned clang::HeaderSearchOptions::ModulesValidateSystemHeaders

Whether to validate system input files when a module is loaded.

Definition at line 197 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInstance::createModuleManager(), clang::CompilerInstance::createPCHExternalASTSource(), and ParseHeaderSearchArgs().

◆ ModuleUserBuildPath

std::string clang::HeaderSearchOptions::ModuleUserBuildPath

The directory used for a user build.

Definition at line 115 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ PrebuiltModuleFiles

std::map<std::string, std::string> clang::HeaderSearchOptions::PrebuiltModuleFiles

The mapping of module names to prebuilt module files.

Definition at line 118 of file HeaderSearchOptions.h.

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

◆ PrebuiltModulePaths

std::vector<std::string> clang::HeaderSearchOptions::PrebuiltModulePaths

The directories used to load prebuilt module files.

Definition at line 121 of file HeaderSearchOptions.h.

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

◆ ResourceDir

std::string clang::HeaderSearchOptions::ResourceDir

The directory which holds the compiler resource files (builtin includes, etc.).

Definition at line 109 of file HeaderSearchOptions.h.

Referenced by clang::ASTUnit::LoadFromCompilerInvocationAction(), and ParseHeaderSearchArgs().

◆ Sysroot

std::string clang::HeaderSearchOptions::Sysroot

If non-empty, the directory to use as a "virtual system root" for include paths.

Definition at line 99 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions(), clang::GeneratePCHAction::ComputeASTConsumerArguments(), clang::CompilerInstance::createModuleManager(), clang::CompilerInstance::createPreprocessor(), clang::VerifyPCHAction::ExecuteAction(), and ParseHeaderSearchArgs().

◆ SystemHeaderPrefixes

std::vector<SystemHeaderPrefix> clang::HeaderSearchOptions::SystemHeaderPrefixes

User-specified system header prefixes.

Definition at line 105 of file HeaderSearchOptions.h.

◆ UseBuiltinIncludes

unsigned clang::HeaderSearchOptions::UseBuiltinIncludes

Include the compiler builtin includes.

Definition at line 177 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ UseDebugInfo

unsigned clang::HeaderSearchOptions::UseDebugInfo

Whether the module includes debug information (-gmodules).

Definition at line 200 of file HeaderSearchOptions.h.

◆ UseLibcxx

unsigned clang::HeaderSearchOptions::UseLibcxx

Use libc++ instead of the default libstdc++.

Definition at line 186 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ UserEntries

std::vector<Entry> clang::HeaderSearchOptions::UserEntries

User specified include entries.

Definition at line 102 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions().

◆ UseStandardCXXIncludes

unsigned clang::HeaderSearchOptions::UseStandardCXXIncludes

Include the system standard C++ library include search directories.

Definition at line 183 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ UseStandardSystemIncludes

unsigned clang::HeaderSearchOptions::UseStandardSystemIncludes

Include the system standard include search directories.

Definition at line 180 of file HeaderSearchOptions.h.

Referenced by ParseHeaderSearchArgs().

◆ Verbose

unsigned clang::HeaderSearchOptions::Verbose

Whether header search information should be output as for -v.

Definition at line 189 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions(), and ParseHeaderSearchArgs().

◆ VFSOverlayFiles

std::vector<std::string> clang::HeaderSearchOptions::VFSOverlayFiles

The set of user-provided virtual filesystem overlay files.

Definition at line 174 of file HeaderSearchOptions.h.

Referenced by collectVFSEntries(), and clang::createVFSFromCompilerInvocation().

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

include/clang/Lex/HeaderSearchOptions.h

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HeaderSearchOptions()

Member Function Documentation

◆ AddPath()

◆ AddPrebuiltModulePath()

◆ AddSystemHeaderPrefix()

◆ AddVFSOverlayFile()

Member Data Documentation

◆ BuildSessionTimestamp

◆ DisableModuleHash

◆ ImplicitModuleMaps

◆ ModuleCachePath

◆ ModuleCachePruneAfter

◆ ModuleCachePruneInterval

◆ ModuleFormat

◆ ModuleMapFileHomeIsCwd

◆ ModulesHashContent

◆ ModulesIgnoreMacros

◆ ModulesValidateDiagnosticOptions

◆ ModulesValidateOncePerBuildSession

◆ ModulesValidateSystemHeaders

◆ ModuleUserBuildPath

◆ PrebuiltModuleFiles

◆ PrebuiltModulePaths

◆ ResourceDir

◆ Sysroot

◆ SystemHeaderPrefixes

◆ UseBuiltinIncludes

◆ UseDebugInfo

◆ UseLibcxx

◆ UserEntries

◆ UseStandardCXXIncludes

◆ UseStandardSystemIncludes

◆ Verbose

◆ VFSOverlayFiles