clang 8.0.0

Public Member Functions | Friends | List of all members
clang::FileEntry Class Reference

Cached information about one file (either on disk or in the virtual file system). More...

`#include "clang/Basic/FileManager.h"`

## Public Member Functions
| FileEntry ()
| FileEntry (const FileEntry &)=delete
FileEntry & | operator= (const FileEntry &)=delete
StringRef | getName () const
StringRef | tryGetRealPathName () const
bool | isValid () const
off_t | getSize () const
unsigned | getUID () const
const llvm::sys::fs::UniqueID & | getUniqueID () const
bool | isInPCH () const
time_t | getModificationTime () const
const DirectoryEntry * | getDir () const
| Return the directory the file lives in. More...
bool | operator< (const FileEntry &RHS) const
bool | isNamedPipe () const
| Check whether the file is a named pipe (and thus can't be opened by the native FileManager methods). More...
void | closeFile () const
bool | isOpenForTests () const

## Friends
class | FileManager

## Detailed Description

Cached information about one file (either on disk or in the virtual file system).

If the 'File' member is valid, then this FileEntry has an open file descriptor for the file.

Definition at line 60 of file FileManager.h.

## Constructor & Destructor Documentation

## ◆ FileEntry() [1/2]

clang::FileEntry::FileEntry | ( |  | ) |
| inline

Definition at line 78 of file FileManager.h.

## ◆ FileEntry() [2/2]

clang::FileEntry::FileEntry | ( | const FileEntry & |  | ) |
| delete

## Member Function Documentation

## ◆ closeFile()

void clang::FileEntry::closeFile | ( |  | ) | const
| inline

Definition at line 103 of file FileManager.h.

Referenced by clang::FileManager::getBufferForFile(), and clang::FileManager::getVirtualFile().

## ◆ getDir()

const DirectoryEntry* clang::FileEntry::getDir | ( |  | ) | const
| inline

Return the directory the file lives in.

Definition at line 95 of file FileManager.h.

Referenced by computeRelativePath(), DetectEOL(), clang::DirectoryLookup::getName(), getPrivateModuleMap(), getPublicModuleMap(), clang::ModuleMap::isBuiltinHeader(), clang::ModuleMap::isHeaderUnavailableInModule(), clang::HeaderSearch::loadModuleMapFile(), clang::Preprocessor::LookupFile(), needModuleLookup(), clang::ModuleMap::setUmbrellaHeader(), and clang::HeaderSearch::ShouldEnterIncludeFile().

## ◆ getModificationTime()

time_t clang::FileEntry::getModificationTime | ( |  | ) | const
| inline

Definition at line 92 of file FileManager.h.

Referenced by clang::PrecompiledPreamble::Build(), clang::arcmt::FileRemapper::flushToFile(), clang::serialization::reader::HeaderFileInfoTrait::GetInternalKey(), clang::ASTWriter::getTimestampForOutput(), clang::Preprocessor::HandlePragmaDependency(), clang::arcmt::FileRemapper::initFromFile(), clang::serialization::ModuleManager::lookupModuleFile(), clang::ModuleMap::resolveHeaderDirectives(), and clang::ASTReader::resolvePendingMacro().

## ◆ getName()

StringRef clang::FileEntry::getName | ( |  | ) | const
| inline

Definition at line 85 of file FileManager.h.

Referenced by clang::ModuleMap::addHeader(), applyEditsToTemp(), clang::arcmt::MigrationProcess::applyTransform(), clang::tooling::AtomicChange::AtomicChange(), clang::DependencyCollector::attachToASTReader(), clang::DependencyFileGenerator::AttachToASTReader(), clang::FrontendAction::BeginSourceFile(), clang::PrecompiledPreamble::Build(), checkMSVCHeaderSearch(), compareCrossTUSourceLocs(), compileModuleImpl(), computeRelativePath(), CreateSLocExpansionAbbrev(), diagnoseFrameworkInclude(), clang::ModuleMap::diagnoseHeaderInclusion(), clang::TextDiagnostic::emitDiagnosticLoc(), clang::arcmt::FileRemapper::flushToFile(), getActualFileUID(), clang::SrcMgr::ContentCache::getBuffer(), clang::FileManager::getBufferForFile(), clang::HeaderSearch::getCachedModuleFileName(), getFileName(), clang::serialization::reader::HeaderFileInfoTrait::GetInternalKey(), clang::SourceManager::getPresumedLoc(), getPrivateModuleMap(), getPublicModuleMap(), clang::LogDiagnosticPrinter::HandleDiagnostic(), hasSuperInitCall(), clang::FileManager::invalidateCache(), clang::ModuleMap::isBuiltinHeader(), clang::HeaderSearch::LookupSubframeworkHeader(), clang::tooling::operator==(), clang::Rewriter::overwriteChangedFiles(), clang::arcmt::FileRemapper::overwriteOriginal(), printLoc(), clang::HeaderSearch::ShouldEnterIncludeFile(), suggestModule(), clang::HeaderSearch::suggestPathToFileForDiagnostics(), clang::SourceManager::translateFile(), clang::VerifyDiagnosticConsumer::UpdateParsedFileStatus(), clang::arcmt::writeARCDiagsToPlist(), and clang::FixItRewriter::WriteFixedFiles().

## ◆ getSize()

off_t clang::FileEntry::getSize | ( |  | ) | const
| inline

Definition at line 88 of file FileManager.h.

Referenced by clang::PrecompiledPreamble::Build(), clang::HeaderMap::Create(), createFile(), CreateSLocExpansionAbbrev(), clang::SrcMgr::ContentCache::getBuffer(), clang::FileManager::getBufferForFile(), clang::serialization::reader::HeaderFileInfoTrait::GetInternalKey(), clang::SrcMgr::ContentCache::getSize(), InitializeFileRemapping(), clang::serialization::ModuleManager::lookupModuleFile(), clang::SourceManager::overrideFileContents(), clang::ModuleMap::resolveHeaderDirectives(), and clang::ASTReader::resolvePendingMacro().

## ◆ getUID()

unsigned clang::FileEntry::getUID | ( |  | ) | const
| inline

Definition at line 89 of file FileManager.h.

Referenced by clang::AttachDependencyGraphGen(), clang::HeaderSearch::getExistingFileInfo(), and clang::HeaderSearch::getFileInfo().

## ◆ getUniqueID()

const llvm::sys::fs::UniqueID& clang::FileEntry::getUniqueID | ( |  | ) | const
| inline

Definition at line 90 of file FileManager.h.

Referenced by clang::FileManager::invalidateCache().

## ◆ isInPCH()

bool clang::FileEntry::isInPCH | ( |  | ) | const
| inline

Definition at line 91 of file FileManager.h.

Referenced by clang::TextDiagnostic::emitDiagnosticLoc().

## ◆ isNamedPipe()

bool clang::FileEntry::isNamedPipe | ( |  | ) | const
| inline

Check whether the file is a named pipe (and thus can't be opened by the native FileManager methods).

Definition at line 101 of file FileManager.h.

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

## ◆ isOpenForTests()

bool clang::FileEntry::isOpenForTests | ( |  | ) | const
| inline

Definition at line 109 of file FileManager.h.

## ◆ isValid()

bool clang::FileEntry::isValid | ( |  | ) | const
| inline

Definition at line 87 of file FileManager.h.

Referenced by clang::TextDiagnostic::emitDiagnosticLoc(), clang::FileManager::getFile(), clang::FileManager::getVirtualFile(), and clang::LogDiagnosticPrinter::HandleDiagnostic().

## ◆ operator<()

bool clang::FileEntry::operator< | ( | const FileEntry & | RHS | ) | const
| inline

Definition at line 97 of file FileManager.h.

## ◆ operator=()

FileEntry& clang::FileEntry::operator= | ( | const FileEntry & |  | ) |
| delete

## ◆ tryGetRealPathName()

StringRef clang::FileEntry::tryGetRealPathName | ( |  | ) | const
| inline

Definition at line 86 of file FileManager.h.

Referenced by clang::Preprocessor::checkModuleIsAvailable(), and getFileName().

## Friends And Related Function Documentation

## ◆ FileManager

friend class FileManager
| friend

Definition at line 61 of file FileManager.h.

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

- include/clang/Basic/FileManager.h