LLVM 17.0.0git
|
The virtual file system interface. More...
#include "llvm/Support/VirtualFileSystem.h"
Public Types | |
enum class | PrintType { Summary , Contents , RecursiveContents } |
Public Member Functions | |
virtual | ~FileSystem () |
virtual llvm::ErrorOr< Status > | status (const Twine &Path)=0 |
Get the status of the entry at Path , if one exists. | |
virtual llvm::ErrorOr< std::unique_ptr< File > > | openFileForRead (const Twine &Path)=0 |
Get a File object for the file at Path , if one exists. | |
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > | getBufferForFile (const Twine &Name, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatile=false) |
This is a convenience method that opens a file, gets its content and then closes the file. | |
virtual directory_iterator | dir_begin (const Twine &Dir, std::error_code &EC)=0 |
Get a directory_iterator for Dir . | |
virtual std::error_code | setCurrentWorkingDirectory (const Twine &Path)=0 |
Set the working directory. | |
virtual llvm::ErrorOr< std::string > | getCurrentWorkingDirectory () const =0 |
Get the working directory of this file system. | |
virtual std::error_code | getRealPath (const Twine &Path, SmallVectorImpl< char > &Output) const |
Gets real path of Path e.g. | |
bool | exists (const Twine &Path) |
Check whether a file exists. Provided for convenience. | |
virtual std::error_code | isLocal (const Twine &Path, bool &Result) |
Is the file mounted on a local filesystem? | |
virtual std::error_code | makeAbsolute (SmallVectorImpl< char > &Path) const |
Make Path an absolute path. | |
void | print (raw_ostream &OS, PrintType Type=PrintType::Contents, unsigned IndentLevel=0) const |
LLVM_DUMP_METHOD void | dump () const |
![]() | |
void | Retain () const |
void | Release () const |
Protected Member Functions | |
virtual void | printImpl (raw_ostream &OS, PrintType Type, unsigned IndentLevel) const |
void | printIndent (raw_ostream &OS, unsigned IndentLevel) const |
![]() | |
ThreadSafeRefCountedBase ()=default | |
ThreadSafeRefCountedBase (const ThreadSafeRefCountedBase &) | |
ThreadSafeRefCountedBase & | operator= (const ThreadSafeRefCountedBase &)=delete |
~ThreadSafeRefCountedBase () | |
The virtual file system interface.
Definition at line 267 of file VirtualFileSystem.h.
|
strong |
Enumerator | |
---|---|
Summary | |
Contents | |
RecursiveContents |
Definition at line 321 of file VirtualFileSystem.h.
|
virtualdefault |
|
pure virtual |
Get a directory_iterator for Dir
.
Implemented in llvm::FileCollectorFileSystem, llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, and llvm::vfs::RedirectingFileSystem.
Referenced by getHighestNumericTupleInDirectory().
void FileSystem::dump | ( | ) | const |
Definition at line 154 of file VirtualFileSystem.cpp.
References llvm::dbgs(), print(), and RecursiveContents.
Check whether a file exists. Provided for convenience.
Definition at line 148 of file VirtualFileSystem.cpp.
References llvm::vfs::Status::exists(), and status().
Referenced by llvm::findVCToolChainViaEnvironment(), llvm::getWindowsSDKDir(), llvm::vfs::RedirectingFileSystem::setCurrentWorkingDirectory(), and llvm::useUniversalCRT().
ErrorOr< std::unique_ptr< MemoryBuffer > > FileSystem::getBufferForFile | ( | const Twine & | Name, |
int64_t | FileSize = -1 , |
||
bool | RequiresNullTerminator = true , |
||
bool | IsVolatile = false |
||
) |
This is a convenience method that opens a file, gets its content and then closes the file.
Definition at line 118 of file VirtualFileSystem.cpp.
References F, Name, and openFileForRead().
Referenced by llvm::SpecialCaseList::createInternal().
|
pure virtual |
Get the working directory of this file system.
Implemented in llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, llvm::vfs::RedirectingFileSystem, and llvm::FileCollectorFileSystem.
Referenced by llvm::cl::ExpansionContext::expandResponseFiles(), and makeAbsolute().
|
virtual |
Gets real path of Path
e.g.
collapse all . and .. patterns, resolve symlinks. For real file system, this uses llvm::sys::fs::real_path
. This returns errc::operation_not_permitted if not implemented by subclass.
Reimplemented in llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, llvm::vfs::RedirectingFileSystem, and llvm::FileCollectorFileSystem.
Definition at line 139 of file VirtualFileSystem.cpp.
References llvm::operation_not_permitted.
Is the file mounted on a local filesystem?
Reimplemented in llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, llvm::vfs::RedirectingFileSystem, and llvm::FileCollectorFileSystem.
Definition at line 144 of file VirtualFileSystem.cpp.
References llvm::operation_not_permitted.
|
virtual |
Make Path an absolute path.
Makes Path absolute using the current directory if it is not already. An empty Path will result in the current directory.
/absolute/path => /absolute/path relative/../path => <current-directory>/relative/../path
Path | A path that is modified to be an absolute path. |
Reimplemented in llvm::vfs::RedirectingFileSystem.
Definition at line 127 of file VirtualFileSystem.cpp.
References getCurrentWorkingDirectory(), llvm::sys::path::is_absolute(), and llvm::sys::fs::make_absolute().
Referenced by llvm::vfs::RedirectingFileSystem::create(), llvm::cl::ExpansionContext::findConfigFile(), llvm::vfs::InMemoryFileSystem::getRealPath(), llvm::cl::ExpansionContext::readConfigFile(), and llvm::vfs::InMemoryFileSystem::setCurrentWorkingDirectory().
|
pure virtual |
Get a File
object for the file at Path
, if one exists.
Implemented in llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, llvm::vfs::RedirectingFileSystem, and llvm::FileCollectorFileSystem.
Referenced by getBufferForFile().
|
inline |
Definition at line 322 of file VirtualFileSystem.h.
References OS, and printImpl().
Referenced by dump().
|
inlineprotectedvirtual |
Reimplemented in llvm::vfs::OverlayFileSystem, llvm::vfs::InMemoryFileSystem, and llvm::vfs::RedirectingFileSystem.
Definition at line 332 of file VirtualFileSystem.h.
References OS, and printIndent().
Referenced by print().
|
inlineprotected |
Definition at line 338 of file VirtualFileSystem.h.
References OS.
Referenced by llvm::vfs::RedirectingFileSystem::printEntry(), printImpl(), llvm::vfs::OverlayFileSystem::printImpl(), llvm::vfs::InMemoryFileSystem::printImpl(), and llvm::vfs::RedirectingFileSystem::printImpl().
|
pure virtual |
Set the working directory.
This will affect all following operations on this file system and may propagate down for nested file systems.
Implemented in llvm::FileCollectorFileSystem, llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, and llvm::vfs::RedirectingFileSystem.
|
pure virtual |
Get the status of the entry at Path
, if one exists.
Implemented in llvm::vfs::OverlayFileSystem, llvm::vfs::ProxyFileSystem, llvm::vfs::InMemoryFileSystem, llvm::vfs::RedirectingFileSystem, and llvm::FileCollectorFileSystem.
Referenced by exists(), llvm::cl::ExpansionContext::expandResponseFiles(), llvm::cl::ExpansionContext::findConfigFile(), llvm::findVCToolChainViaSetupConfig(), and getHighestNumericTupleInDirectory().