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

#include "clang/Lex/HeaderSearchOptions.h"

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.

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.

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.

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

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

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

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

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

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

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

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

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

unsigned	ImplicitModuleMaps: 1
	Implicit module maps.

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.

unsigned	ModuleFileHomeIsCwd: 1
	Set the base path of a built module file to be the current working directory.

unsigned	EnablePrebuiltImplicitModules: 1
	Also search for prebuilt implicit modules in the prebuilt module cache path.

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

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.

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

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

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

unsigned	UseBuiltinIncludes: 1
	Include the compiler builtin includes.

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

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

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

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

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

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

unsigned	ValidateASTInputFilesContent: 1

unsigned	ForceCheckCXX20ModulesInputFiles: 1

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

unsigned	ModulesValidateDiagnosticOptions: 1

unsigned	ModulesHashContent: 1

unsigned	ModulesStrictContextHash: 1
	Whether we should include all things that could impact the module in the hash.

Detailed Description

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

Definition at line 68 of file HeaderSearchOptions.h.

Constructor & Destructor Documentation

◆ HeaderSearchOptions()

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

inline

Definition at line 231 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 245 of file HeaderSearchOptions.h.

References UserEntries.

Referenced by ParseHeaderSearchArgs().

◆ AddPrebuiltModulePath()

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

inline

Definition at line 261 of file HeaderSearchOptions.h.

References PrebuiltModulePaths.

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 253 of file HeaderSearchOptions.h.

References SystemHeaderPrefixes.

Referenced by ParseHeaderSearchArgs().

◆ AddVFSOverlayFile()

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

inline

Definition at line 257 of file HeaderSearchOptions.h.

References VFSOverlayFiles.

Referenced by ParseHeaderSearchArgs().

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 178 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions(), and clang::ASTReader::ReadAST().

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

◆ EnablePrebuiltImplicitModules

unsigned clang::HeaderSearchOptions::EnablePrebuiltImplicitModules

Also search for prebuilt implicit modules in the prebuilt module cache path.

Definition at line 154 of file HeaderSearchOptions.h.

Referenced by selectModuleSource().

◆ ForceCheckCXX20ModulesInputFiles

unsigned clang::HeaderSearchOptions::ForceCheckCXX20ModulesInputFiles

Definition at line 215 of file HeaderSearchOptions.h.

◆ ImplicitModuleMaps

unsigned clang::HeaderSearchOptions::ImplicitModuleMaps

Implicit module maps.

This option is enabld by default when modules is enabled.

Definition at line 135 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions().

◆ ModuleCachePath

std::string clang::HeaderSearchOptions::ModuleCachePath

The directory used for the module cache.

Definition at line 113 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions(), GenerateHeaderSearchArgs(), 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 172 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions(), 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 163 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions(), and pruneModuleCache().

◆ ModuleFileHomeIsCwd

unsigned clang::HeaderSearchOptions::ModuleFileHomeIsCwd

Set the base path of a built module file to be the current working directory.

This is useful for sharing module files across machines that build with different paths without having to rewrite all modulemap files to have working directory relative paths.

Definition at line 150 of file HeaderSearchOptions.h.

◆ ModuleFormat

std::string clang::HeaderSearchOptions::ModuleFormat

The module/pch container format.

Definition at line 125 of file HeaderSearchOptions.h.

Referenced by clang::DumpModuleInfoAction::BeginInvocation(), clang::CompilerInvocation::getModuleHash(), clang::CompilerInstance::getPCHContainerReader(), and clang::CompilerInstance::getPCHContainerWriter().

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

◆ ModulesHashContent

unsigned clang::HeaderSearchOptions::ModulesHashContent

Definition at line 222 of file HeaderSearchOptions.h.

◆ 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 182 of file HeaderSearchOptions.h.

Referenced by GenerateHeaderSearchArgs(), clang::CompilerInvocation::getModuleHash(), makeCommonInvocationForModuleBuild(), and ParseHeaderSearchArgs().

◆ ModulesStrictContextHash

unsigned clang::HeaderSearchOptions::ModulesStrictContextHash

Whether we should include all things that could impact the module in the hash.

This includes things like the full header search path, and enabled diagnostics.

Definition at line 229 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::getModuleHash().

◆ ModulesValidateDiagnosticOptions

unsigned clang::HeaderSearchOptions::ModulesValidateDiagnosticOptions

Definition at line 220 of file HeaderSearchOptions.h.

Referenced by clang::DumpModuleInfoAction::ExecuteAction(), and clang::CompilerInvocation::getModuleHash().

◆ 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 205 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::clearImplicitModuleBuildOptions(), and clang::ASTReader::ReadAST().

◆ ModulesValidateSystemHeaders

unsigned clang::HeaderSearchOptions::ModulesValidateSystemHeaders

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

Definition at line 208 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInstance::createASTReader(), and clang::CompilerInstance::createPCHExternalASTSource().

◆ ModuleUserBuildPath

std::string clang::HeaderSearchOptions::ModuleUserBuildPath

The directory used for a user build.

Definition at line 116 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::getModuleHash().

◆ PrebuiltModuleFiles

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

The mapping of module names to prebuilt module files.

Definition at line 119 of file HeaderSearchOptions.h.

Referenced by GenerateHeaderSearchArgs(), ParseHeaderSearchArgs(), and selectModuleSource().

◆ PrebuiltModulePaths

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

The directories used to load prebuilt module files.

Definition at line 122 of file HeaderSearchOptions.h.

Referenced by AddPrebuiltModulePath(), GenerateHeaderSearchArgs(), and selectModuleSource().

◆ ResourceDir

std::string clang::HeaderSearchOptions::ResourceDir

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

Definition at line 110 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions(), clang::CompilerInvocation::getModuleHash(), and clang::ASTUnit::LoadFromCompilerInvocationAction().

◆ Sysroot

std::string clang::HeaderSearchOptions::Sysroot

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

Definition at line 100 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions(), clang::GeneratePCHAction::ComputeASTConsumerArguments(), clang::CompilerInstance::createASTReader(), clang::VerifyPCHAction::ExecuteAction(), clang::Sema::getDarwinSDKInfoForAvailabilityChecking(), clang::CompilerInvocation::getModuleHash(), initTargetOptions(), and ParseHeaderSearchArgs().

◆ SystemHeaderPrefixes

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

User-specified system header prefixes.

Definition at line 106 of file HeaderSearchOptions.h.

Referenced by AddSystemHeaderPrefix(), clang::ApplyHeaderSearchOptions(), GenerateHeaderSearchArgs(), and clang::CompilerInvocation::getModuleHash().

◆ UseBuiltinIncludes

unsigned clang::HeaderSearchOptions::UseBuiltinIncludes

Include the compiler builtin includes.

Definition at line 188 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions(), and clang::CompilerInvocation::getModuleHash().

◆ UseDebugInfo

unsigned clang::HeaderSearchOptions::UseDebugInfo

Whether the module includes debug information (-gmodules).

Definition at line 218 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::getModuleHash().

◆ UseLibcxx

unsigned clang::HeaderSearchOptions::UseLibcxx

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

Definition at line 197 of file HeaderSearchOptions.h.

Referenced by GenerateHeaderSearchArgs(), clang::CompilerInvocation::getModuleHash(), and ParseHeaderSearchArgs().

◆ UserEntries

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

User specified include entries.

Definition at line 103 of file HeaderSearchOptions.h.

Referenced by AddPath(), clang::ApplyHeaderSearchOptions(), GenerateHeaderSearchArgs(), clang::CompilerInvocation::getModuleHash(), initTargetOptions(), and optimizeHeaderSearchOpts().

◆ UseStandardCXXIncludes

unsigned clang::HeaderSearchOptions::UseStandardCXXIncludes

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

Definition at line 194 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::getModuleHash().

◆ UseStandardSystemIncludes

unsigned clang::HeaderSearchOptions::UseStandardSystemIncludes

Include the system standard include search directories.

Definition at line 191 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInvocation::getModuleHash().

◆ ValidateASTInputFilesContent

unsigned clang::HeaderSearchOptions::ValidateASTInputFilesContent

Definition at line 212 of file HeaderSearchOptions.h.

Referenced by clang::CompilerInstance::createASTReader(), and clang::CompilerInstance::createPCHExternalASTSource().

◆ Verbose

unsigned clang::HeaderSearchOptions::Verbose

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

Definition at line 200 of file HeaderSearchOptions.h.

Referenced by clang::ApplyHeaderSearchOptions().

◆ VFSOverlayFiles

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

The set of user-provided virtual filesystem overlay files.

Definition at line 185 of file HeaderSearchOptions.h.

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

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

◆ EnablePrebuiltImplicitModules

◆ ForceCheckCXX20ModulesInputFiles

◆ ImplicitModuleMaps

◆ ModuleCachePath

◆ ModuleCachePruneAfter

◆ ModuleCachePruneInterval

◆ ModuleFileHomeIsCwd

◆ ModuleFormat

◆ ModuleMapFileHomeIsCwd

◆ ModulesHashContent

◆ ModulesIgnoreMacros

◆ ModulesStrictContextHash

◆ ModulesValidateDiagnosticOptions

◆ ModulesValidateOncePerBuildSession

◆ ModulesValidateSystemHeaders

◆ ModuleUserBuildPath

◆ PrebuiltModuleFiles

◆ PrebuiltModulePaths

◆ ResourceDir

◆ Sysroot

◆ SystemHeaderPrefixes

◆ UseBuiltinIncludes

◆ UseDebugInfo

◆ UseLibcxx

◆ UserEntries

◆ UseStandardCXXIncludes

◆ UseStandardSystemIncludes

◆ ValidateASTInputFilesContent

◆ Verbose

◆ VFSOverlayFiles