Maps a definition location onto an #include file, based on a set of filename rules. More...

Public Member Functions
void	addMapping (FileEntryRef Header, llvm::StringRef CanonicalPath)
	Adds a file-to-string mapping from `ID` to `CanonicalPath`. More...

llvm::StringRef	mapSymbol (llvm::StringRef QualifiedName) const
	Returns the overridden include for symbol with `QualifiedName`, or "". More...

llvm::StringRef	mapHeader (FileEntryRef Header) const
	Returns the overridden include for files in `Header`, or "". More...

void	addSystemHeadersMapping (const LangOptions &Language)
	Adds mapping for system headers and some special symbols (e.g. More...

Detailed Description

Maps a definition location onto an #include file, based on a set of filename rules.

Only const methods (i.e. mapHeader) in this class are thread safe.

Definition at line 37 of file CanonicalIncludes.h.

Member Function Documentation

void clang::clangd::CanonicalIncludes::addMapping	(	FileEntryRef	Header,
		llvm::StringRef	CanonicalPath
	)

Adds a file-to-string mapping from ID to CanonicalPath.

Definition at line 670 of file CanonicalIncludes.cpp.

void clang::clangd::CanonicalIncludes::addSystemHeadersMapping ( const LangOptions & Language )

Adds mapping for system headers and some special symbols (e.g.

STL symbols in <iosfwd> need to be mapped individually). Approximately, the following system headers are handled:

C++ standard library e.g. bits/basic_string.h$ -> <string>
Posix library e.g. bits/pthreadtypes.h$ -> <pthread.h>
Compiler extensions, e.g. include/avx512bwintrin.h$ -> <immintrin.h> The mapping is hardcoded and hand-maintained, so it might not cover all headers.

Definition at line 733 of file CanonicalIncludes.cpp.

llvm::StringRef clang::clangd::CanonicalIncludes::mapHeader ( FileEntryRef Header ) const

Returns the overridden include for files in Header, or "".

Definition at line 679 of file CanonicalIncludes.cpp.

References Filename.

llvm::StringRef clang::clangd::CanonicalIncludes::mapSymbol ( llvm::StringRef QualifiedName ) const

Returns the overridden include for symbol with QualifiedName, or "".

Definition at line 702 of file CanonicalIncludes.cpp.

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