clang
3.7.0
|
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc. More...
#include <HeaderSearch.h>
Public Types | |
typedef std::vector < DirectoryLookup > ::const_iterator | search_dir_iterator |
Public Member Functions | |
HeaderSearch (IntrusiveRefCntPtr< HeaderSearchOptions > HSOpts, SourceManager &SourceMgr, DiagnosticsEngine &Diags, const LangOptions &LangOpts, const TargetInfo *Target) | |
~HeaderSearch () | |
HeaderSearchOptions & | getHeaderSearchOpts () const |
Retrieve the header-search options with which this header search was initialized. More... | |
FileManager & | getFileMgr () const |
void | SetSearchPaths (const std::vector< DirectoryLookup > &dirs, unsigned angledDirIdx, unsigned systemDirIdx, bool noCurDirSearch) |
Interface for setting the file search paths. More... | |
void | AddSearchPath (const DirectoryLookup &dir, bool isAngled) |
Add an additional search path. More... | |
void | SetSystemHeaderPrefixes (ArrayRef< std::pair< std::string, bool > > P) |
Set the list of system header prefixes. More... | |
bool | HasIncludeAliasMap () const |
Checks whether the map exists or not. More... | |
void | AddIncludeAlias (StringRef Source, StringRef Dest) |
Map the source include name to the dest include name. More... | |
StringRef | MapHeaderToIncludeAlias (StringRef Source) |
void | setModuleCachePath (StringRef CachePath) |
Set the path to the module cache. More... | |
StringRef | getModuleCachePath () const |
Retrieve the path to the module cache. More... | |
void | setDirectoryHasModuleMap (const DirectoryEntry *Dir) |
Consider modules when including files from this directory. More... | |
void | ClearFileInfo () |
Forget everything we know about headers so far. More... | |
void | SetExternalLookup (ExternalPreprocessorSource *EPS) |
ExternalPreprocessorSource * | getExternalLookup () const |
void | SetExternalSource (ExternalHeaderFileInfoSource *ES) |
Set the external source of header information. More... | |
void | setTarget (const TargetInfo &Target) |
Set the target information for the header search, if not already known. More... | |
const FileEntry * | LookupFile (StringRef Filename, SourceLocation IncludeLoc, bool isAngled, const DirectoryLookup *FromDir, const DirectoryLookup *&CurDir, ArrayRef< std::pair< const FileEntry *, const DirectoryEntry * >> Includers, SmallVectorImpl< char > *SearchPath, SmallVectorImpl< char > *RelativePath, ModuleMap::KnownHeader *SuggestedModule, bool SkipCache=false) |
Given a "foo" or <foo> reference, look up the indicated file, return null on failure. More... | |
const FileEntry * | LookupSubframeworkHeader (StringRef Filename, const FileEntry *RelativeFileEnt, SmallVectorImpl< char > *SearchPath, SmallVectorImpl< char > *RelativePath, ModuleMap::KnownHeader *SuggestedModule) |
Look up a subframework for the specified #include file. More... | |
FrameworkCacheEntry & | LookupFrameworkCache (StringRef FWName) |
Look up the specified framework name in our framework cache. More... | |
bool | ShouldEnterIncludeFile (Preprocessor &PP, const FileEntry *File, bool isImport, Module *CorrespondingModule) |
Mark the specified file as a target of of a #include, #include_next, or #import directive. More... | |
SrcMgr::CharacteristicKind | getFileDirFlavor (const FileEntry *File) |
Return whether the specified file is a normal header, a system header, or a C++ friendly system header. More... | |
void | MarkFileIncludeOnce (const FileEntry *File) |
Mark the specified file as a "once only" file, e.g. due to #pragma once. More... | |
void | MarkFileSystemHeader (const FileEntry *File) |
Mark the specified file as a system header, e.g. due to #pragma GCC system_header. More... | |
void | MarkFileModuleHeader (const FileEntry *File, ModuleMap::ModuleHeaderRole Role, bool IsCompiledModuleHeader) |
Mark the specified file as part of a module. More... | |
void | IncrementIncludeCount (const FileEntry *File) |
Increment the count for the number of times the specified FileEntry has been entered. More... | |
void | SetFileControllingMacro (const FileEntry *File, const IdentifierInfo *ControllingMacro) |
Mark the specified file as having a controlling macro. More... | |
bool | FirstTimeLexingFile (const FileEntry *File) |
Return true if this is the first time encountering this header. More... | |
bool | isFileMultipleIncludeGuarded (const FileEntry *File) |
Determine whether this file is intended to be safe from multiple inclusions, e.g., it has #pragma once or a controlling macro. More... | |
const HeaderMap * | CreateHeaderMap (const FileEntry *FE) |
std::string | getModuleFileName (Module *Module) |
Retrieve the name of the module file that should be used to load the given module. More... | |
std::string | getModuleFileName (StringRef ModuleName, StringRef ModuleMapPath) |
Retrieve the name of the module file that should be used to load a module with the given name. More... | |
Module * | lookupModule (StringRef ModuleName, bool AllowSearch=true) |
Lookup a module Search for a module with the given name. More... | |
const FileEntry * | lookupModuleMapFile (const DirectoryEntry *Dir, bool IsFramework) |
Try to find a module map file in the given directory, returning nullptr if none is found. More... | |
void | IncrementFrameworkLookupCount () |
bool | hasModuleMap (StringRef Filename, const DirectoryEntry *Root, bool IsSystem) |
Determine whether there is a module map that may map the header with the given file name to a (sub)module. Always returns false if modules are disabled. More... | |
ModuleMap::KnownHeader | findModuleForHeader (const FileEntry *File) const |
Retrieve the module that corresponds to the given file, if any. More... | |
bool | loadModuleMapFile (const FileEntry *File, bool IsSystem) |
Read the contents of the given module map file. More... | |
void | collectAllModules (SmallVectorImpl< Module * > &Modules) |
Collect the set of all known, top-level modules. More... | |
void | loadTopLevelSystemModules () |
Load all known, top-level system modules. More... | |
ModuleMap & | getModuleMap () |
Retrieve the module map. More... | |
unsigned | header_file_size () const |
bool | tryGetFileInfo (const FileEntry *FE, HeaderFileInfo &Result) const |
Get a HeaderFileInfo structure for the specified FileEntry , if one exists. More... | |
search_dir_iterator | search_dir_begin () const |
search_dir_iterator | search_dir_end () const |
unsigned | search_dir_size () const |
search_dir_iterator | quoted_dir_begin () const |
search_dir_iterator | quoted_dir_end () const |
search_dir_iterator | angled_dir_begin () const |
search_dir_iterator | angled_dir_end () const |
search_dir_iterator | system_dir_begin () const |
search_dir_iterator | system_dir_end () const |
StringRef | getUniqueFrameworkName (StringRef Framework) |
Retrieve a uniqued framework name. More... | |
void | PrintStats () |
size_t | getTotalMemory () const |
Static Public Member Functions | |
static std::string | NormalizeDashIncludePath (StringRef File, FileManager &FileMgr) |
Friends | |
class | DirectoryLookup |
Encapsulates the information needed to find the file referenced by a #include or #include_next, (sub-)framework lookup, etc.
Definition at line 151 of file HeaderSearch.h.
typedef std::vector<DirectoryLookup>::const_iterator clang::HeaderSearch::search_dir_iterator |
Definition at line 594 of file HeaderSearch.h.
HeaderSearch::HeaderSearch | ( | IntrusiveRefCntPtr< HeaderSearchOptions > | HSOpts, |
SourceManager & | SourceMgr, | ||
DiagnosticsEngine & | Diags, | ||
const LangOptions & | LangOpts, | ||
const TargetInfo * | Target | ||
) |
Definition at line 55 of file HeaderSearch.cpp.
HeaderSearch::~HeaderSearch | ( | ) |
Definition at line 73 of file HeaderSearch.cpp.
|
inline |
Map the source include name to the dest include name.
The Source should include the angle brackets or quotes, the dest should not. This allows for distinction between <> and "" headers.
Definition at line 312 of file HeaderSearch.h.
Referenced by clang::Preprocessor::HandlePragmaIncludeAlias().
|
inline |
Add an additional search path.
Definition at line 292 of file HeaderSearch.h.
|
inline |
Definition at line 606 of file HeaderSearch.h.
|
inline |
Definition at line 609 of file HeaderSearch.h.
|
inline |
Forget everything we know about headers so far.
Definition at line 346 of file HeaderSearch.h.
void HeaderSearch::collectAllModules | ( | SmallVectorImpl< Module * > & | Modules | ) |
Collect the set of all known, top-level modules.
Modules | Will be filled with the set of known, top-level modules. |
Definition at line 1297 of file HeaderSearch.cpp.
References clang::FileManager::getDirectory(), loadModuleMapFile(), clang::ModuleMap::module_begin(), and clang::ModuleMap::module_end().
CreateHeaderMap - This method returns a HeaderMap for the specified FileEntry, uniquing them through the 'HeaderMaps' datastructure.
Definition at line 103 of file HeaderSearch.cpp.
References clang::HeaderMap::Create().
ModuleMap::KnownHeader HeaderSearch::findModuleForHeader | ( | const FileEntry * | File | ) | const |
Retrieve the module that corresponds to the given file, if any.
File | The header that we wish to map to a module. |
Definition at line 1141 of file HeaderSearch.cpp.
References clang::ModuleMap::findModuleForHeader().
Referenced by getFileAndSuggestModule(), clang::VerifyDiagnosticConsumer::HandleDiagnostic(), LookupFile(), and LookupSubframeworkHeader().
Return true if this is the first time encountering this header.
Definition at line 469 of file HeaderSearch.h.
References clang::HeaderFileInfo::NumIncludes.
Referenced by clang::Preprocessor::HandleEndOfFile().
|
inline |
Definition at line 354 of file HeaderSearch.h.
|
inline |
Return whether the specified file is a normal header, a system header, or a C++ friendly system header.
Definition at line 430 of file HeaderSearch.h.
References clang::HeaderFileInfo::DirInfo.
|
inline |
Definition at line 276 of file HeaderSearch.h.
Referenced by clang::ApplyHeaderSearchOptions(), getFileAndSuggestModule(), and clang::DirectoryLookup::LookupFile().
|
inline |
Retrieve the header-search options with which this header search was initialized.
Definition at line 274 of file HeaderSearch.h.
Referenced by clang::CompilerInstance::createPCHExternalASTSource(), and loadModuleMapFile().
|
inline |
Retrieve the path to the module cache.
Definition at line 338 of file HeaderSearch.h.
Referenced by clang::FrontendAction::Execute().
std::string HeaderSearch::getModuleFileName | ( | Module * | Module | ) |
Retrieve the name of the module file that should be used to load the given module.
Module | The module whose module file name will be returned. |
Definition at line 122 of file HeaderSearch.cpp.
References getModuleMap(), clang::ModuleMap::getModuleMapFileForUniquing(), clang::FileEntry::getName(), and clang::Module::Name.
Referenced by clang::GenerateModuleAction::ComputeASTConsumerArguments().
std::string HeaderSearch::getModuleFileName | ( | StringRef | ModuleName, |
StringRef | ModuleMapPath | ||
) |
Retrieve the name of the module file that should be used to load a module with the given name.
ModuleName | The module whose module file name will be returned. |
ModuleMapPath | A path that when combined with ModuleName uniquely identifies this module. See Module::ModuleMap. |
Definition at line 128 of file HeaderSearch.cpp.
References clang::FileManager::getCanonicalName(), clang::FileManager::getDirectory(), and clang::Result.
|
inline |
Retrieve the module map.
Definition at line 585 of file HeaderSearch.h.
Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::ApplyHeaderSearchOptions(), clang::GenerateModuleAction::BeginSourceFileAction(), compileModuleImpl(), clang::Preprocessor::getModuleContainingLocation(), getModuleFileName(), clang::Preprocessor::getModuleForLocation(), clang::Preprocessor::HandleEndOfFile(), clang::ASTWriter::inferSubmoduleIDFromLocation(), clang::CompilerInstance::loadGlobalModuleIndex(), and clang::Preprocessor::LookupFile().
size_t HeaderSearch::getTotalMemory | ( | ) | const |
Definition at line 1081 of file HeaderSearch.cpp.
StringRef HeaderSearch::getUniqueFrameworkName | ( | StringRef | Framework | ) |
Retrieve a uniqued framework name.
Definition at line 1089 of file HeaderSearch.cpp.
Referenced by LookupFile().
|
inline |
Checks whether the map exists or not.
Definition at line 306 of file HeaderSearch.h.
bool HeaderSearch::hasModuleMap | ( | StringRef | Filename, |
const DirectoryEntry * | Root, | ||
bool | IsSystem | ||
) |
Determine whether there is a module map that may map the header with the given file name to a (sub)module. Always returns false if modules are disabled.
Filename | The name of the file. |
Root | The "root" directory, at which we should stop looking for module maps. |
IsSystem | Whether the directories we're looking at are system header directories. |
Definition at line 1093 of file HeaderSearch.cpp.
References clang::FileManager::getDirectory(), clang::DirectoryEntry::getName(), and loadModuleMapFile().
Referenced by getFileAndSuggestModule(), and LookupFile().
|
inline |
Definition at line 587 of file HeaderSearch.h.
|
inline |
Definition at line 521 of file HeaderSearch.h.
|
inline |
Increment the count for the number of times the specified FileEntry has been entered.
Definition at line 455 of file HeaderSearch.h.
References clang::HeaderFileInfo::NumIncludes.
Referenced by clang::Preprocessor::EnterMainSourceFile().
Determine whether this file is intended to be safe from multiple inclusions, e.g., it has #pragma once or a controlling macro.
This routine does not consider the effect of #import
Definition at line 1012 of file HeaderSearch.cpp.
References clang::HeaderFileInfo::ControllingMacro, clang::HeaderFileInfo::ControllingMacroID, clang::ExternalHeaderFileInfoSource::GetHeaderFileInfo(), clang::FileEntry::getUID(), clang::HeaderFileInfo::isImport, clang::HeaderFileInfo::isPragmaOnce, mergeHeaderFileInfo(), and clang::HeaderFileInfo::Resolved.
Read the contents of the given module map file.
File | The module map file. |
IsSystem | Whether this file is in a system header directory. |
Definition at line 1163 of file HeaderSearch.cpp.
References clang::FileEntry::getDir(), clang::FileManager::getDirectory(), getHeaderSearchOpts(), and clang::DirectoryEntry::getName().
Referenced by clang::FrontendAction::BeginSourceFile(), clang::GenerateModuleAction::BeginSourceFileAction(), collectAllModules(), hasModuleMap(), loadTopLevelSystemModules(), and lookupModule().
void HeaderSearch::loadTopLevelSystemModules | ( | ) |
Load all known, top-level system modules.
Definition at line 1350 of file HeaderSearch.cpp.
References loadModuleMapFile().
const FileEntry * HeaderSearch::LookupFile | ( | StringRef | Filename, |
SourceLocation | IncludeLoc, | ||
bool | isAngled, | ||
const DirectoryLookup * | FromDir, | ||
const DirectoryLookup *& | CurDir, | ||
ArrayRef< std::pair< const FileEntry *, const DirectoryEntry * >> | Includers, | ||
SmallVectorImpl< char > * | SearchPath, | ||
SmallVectorImpl< char > * | RelativePath, | ||
ModuleMap::KnownHeader * | SuggestedModule, | ||
bool | SkipCache = false |
||
) |
Given a "foo" or <foo> reference, look up the indicated file, return null on failure.
IncludeLoc | Used for diagnostics if valid. |
isAngled | indicates whether the file reference is a <> reference. |
CurDir | If non-null, the file was found in the specified directory search location. This is used to implement #include_next. |
Includers | Indicates where the #including file(s) are, in case relative searches are needed. In reverse order of inclusion. |
SearchPath | If non-null, will be set to the search path relative to which the file was found. If the include path is absolute, SearchPath will be set to an empty string. |
RelativePath | If non-null, will be set to the path relative to SearchPath at which the file was found. This only differs from the Filename for framework includes. |
SuggestedModule | If non-null, and the file found is semantically part of a known module, this will be set to the module that should be imported instead of preprocessing/parsing the file found. |
LookupFile - Given a "foo" or <foo> reference, look up the indicated file, return null on failure. isAngled indicates whether the file reference is for system #include's or not (i.e. using <> instead of ""). Includers, if non-empty, indicates where the #including file(s) are, in case a relative search is needed. Microsoft mode will pass all #including files.
Definition at line 586 of file HeaderSearch.cpp.
References clang::SrcMgr::C_System, clang::SrcMgr::C_User, checkMSVCHeaderSearch(), copyString(), clang::HeaderFileInfo::DirInfo, findModuleForHeader(), clang::HeaderFileInfo::Framework, clang::FileEntry::getDir(), clang::DirectoryLookup::getDirCharacteristic(), clang::FileManager::getFile(), getFileAndSuggestModule(), getUniqueFrameworkName(), hasModuleMap(), clang::HeaderFileInfo::IndexHeaderMapHeader, clang::DiagnosticsEngine::isIgnored(), and clang::DirectoryLookup::isIndexHeaderMap().
Referenced by clang::Preprocessor::LookupFile().
|
inline |
Look up the specified framework name in our framework cache.
Definition at line 416 of file HeaderSearch.h.
Lookup a module Search for a module with the given name.
ModuleName | The name of the module we're looking for. |
AllowSearch | Whether we are allowed to search in the various search directories to produce a module definition. If not, this lookup will only return an already-known module. |
Definition at line 165 of file HeaderSearch.cpp.
References clang::SrcMgr::C_User, clang::ModuleMap::findModule(), clang::FileManager::getDirectory(), and loadModuleMapFile().
Referenced by clang::GenerateModuleAction::BeginSourceFileAction(), and clang::Preprocessor::getCurrentModule().
const FileEntry * HeaderSearch::lookupModuleMapFile | ( | const DirectoryEntry * | Dir, |
bool | IsFramework | ||
) |
Try to find a module map file in the given directory, returning nullptr
if none is found.
Definition at line 1222 of file HeaderSearch.cpp.
References clang::FileManager::getFile(), and clang::DirectoryEntry::getName().
const FileEntry * HeaderSearch::LookupSubframeworkHeader | ( | StringRef | Filename, |
const FileEntry * | ContextFileEnt, | ||
SmallVectorImpl< char > * | SearchPath, | ||
SmallVectorImpl< char > * | RelativePath, | ||
ModuleMap::KnownHeader * | SuggestedModule | ||
) |
Look up a subframework for the specified #include file.
For example, if #include'ing <HIToolbox/HIToolbox.h> from within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox is a subframework within Carbon.framework. If so, return the FileEntry for the designated file, otherwise return null.
LookupSubframeworkHeader - Look up a subframework for the specified #include file. For example, if #include'ing <HIToolbox/HIToolbox.h> from within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox is a subframework within Carbon.framework. If so, return the FileEntry for the designated file, otherwise return null.
Definition at line 840 of file HeaderSearch.cpp.
References clang::HeaderFileInfo::DirInfo, findModuleForHeader(), clang::FileManager::getDirectory(), clang::FileManager::getFile(), clang::DirectoryEntry::getName(), clang::FileEntry::getName(), and getTopFrameworkDir().
Referenced by clang::Preprocessor::LookupFile().
|
inline |
MapHeaderToIncludeAlias - Maps one header file name to a different header file name, for use with the include_alias pragma. Note that the source file name should include the angle brackets or quotes. Returns StringRef as null if the header cannot be mapped.
Definition at line 322 of file HeaderSearch.h.
|
inline |
Mark the specified file as a "once only" file, e.g. due to #pragma once.
Definition at line 436 of file HeaderSearch.h.
References clang::HeaderFileInfo::isImport, and clang::HeaderFileInfo::isPragmaOnce.
Referenced by clang::Preprocessor::HandlePragmaOnce().
void HeaderSearch::MarkFileModuleHeader | ( | const FileEntry * | File, |
ModuleMap::ModuleHeaderRole | Role, | ||
bool | IsCompiledModuleHeader | ||
) |
Mark the specified file as part of a module.
Definition at line 1026 of file HeaderSearch.cpp.
References clang::FileEntry::getUID(), clang::HeaderFileInfo::isCompilingModuleHeader, clang::HeaderFileInfo::isModuleHeader, and clang::HeaderFileInfo::setHeaderRole().
Referenced by clang::ModuleMap::addHeader().
|
inline |
Mark the specified file as a system header, e.g. due to #pragma GCC system_header.
Definition at line 444 of file HeaderSearch.h.
References clang::SrcMgr::C_System, and clang::HeaderFileInfo::DirInfo.
Referenced by clang::Preprocessor::HandlePragmaSystemHeader().
|
static |
void HeaderSearch::PrintStats | ( | ) |
Definition at line 79 of file HeaderSearch.cpp.
Referenced by clang::FrontendAction::EndSourceFile().
|
inline |
Definition at line 599 of file HeaderSearch.h.
|
inline |
Definition at line 602 of file HeaderSearch.h.
|
inline |
Definition at line 595 of file HeaderSearch.h.
|
inline |
Definition at line 596 of file HeaderSearch.h.
|
inline |
Definition at line 597 of file HeaderSearch.h.
|
inline |
Consider modules when including files from this directory.
Definition at line 341 of file HeaderSearch.h.
|
inline |
Definition at line 350 of file HeaderSearch.h.
|
inline |
Set the external source of header information.
Definition at line 359 of file HeaderSearch.h.
|
inline |
Mark the specified file as having a controlling macro.
This is used by the multiple-include optimization to eliminate no-op #includes.
Definition at line 463 of file HeaderSearch.h.
References clang::HeaderFileInfo::ControllingMacro.
Referenced by clang::Preprocessor::HandleEndOfFile().
|
inline |
Set the path to the module cache.
Definition at line 333 of file HeaderSearch.h.
|
inline |
Interface for setting the file search paths.
Definition at line 279 of file HeaderSearch.h.
|
inline |
Set the list of system header prefixes.
Definition at line 301 of file HeaderSearch.h.
References P.
void HeaderSearch::setTarget | ( | const TargetInfo & | Target | ) |
Set the target information for the header search, if not already known.
Definition at line 551 of file HeaderSearch.cpp.
References clang::ModuleMap::setTarget().
Referenced by clang::Preprocessor::Initialize().
bool HeaderSearch::ShouldEnterIncludeFile | ( | Preprocessor & | PP, |
const FileEntry * | File, | ||
bool | isImport, | ||
Module * | CorrespondingModule | ||
) |
Mark the specified file as a target of of a #include, #include_next, or #import directive.
Definition at line 1038 of file HeaderSearch.cpp.
References clang::HeaderFileInfo::getControllingMacro(), clang::HeaderFileInfo::isImport, clang::Preprocessor::isMacroDefined(), clang::Preprocessor::isMacroDefinedInLocalModule(), and clang::HeaderFileInfo::NumIncludes.
|
inline |
Definition at line 613 of file HeaderSearch.h.
|
inline |
Definition at line 616 of file HeaderSearch.h.
bool HeaderSearch::tryGetFileInfo | ( | const FileEntry * | FE, |
HeaderFileInfo & | Result | ||
) | const |
Get a HeaderFileInfo
structure for the specified FileEntry
, if one exists.
Definition at line 1000 of file HeaderSearch.cpp.
References clang::FileEntry::getUID(), and clang::HeaderFileInfo::IsValid.
|
friend |
Definition at line 264 of file HeaderSearch.h.