LLVM  10.0.0svn
Public Member Functions | List of all members
llvm::vfs::InMemoryFileSystem Class Reference

An in-memory file system. More...

#include "llvm/Support/VirtualFileSystem.h"

Inheritance diagram for llvm::vfs::InMemoryFileSystem:
Inheritance graph
[legend]
Collaboration diagram for llvm::vfs::InMemoryFileSystem:
Collaboration graph
[legend]

Public Member Functions

 InMemoryFileSystem (bool UseNormalizedPaths=true)
 
 ~InMemoryFileSystem () override
 
bool addFile (const Twine &Path, time_t ModificationTime, std::unique_ptr< llvm::MemoryBuffer > Buffer, Optional< uint32_t > User=None, Optional< uint32_t > Group=None, Optional< llvm::sys::fs::file_type > Type=None, Optional< llvm::sys::fs::perms > Perms=None)
 Add a file containing a buffer or a directory to the VFS with a path. More...
 
bool addHardLink (const Twine &From, const Twine &To)
 Add a hard link to a file. More...
 
bool addFileNoOwn (const Twine &Path, time_t ModificationTime, llvm::MemoryBuffer *Buffer, Optional< uint32_t > User=None, Optional< uint32_t > Group=None, Optional< llvm::sys::fs::file_type > Type=None, Optional< llvm::sys::fs::perms > Perms=None)
 Add a buffer to the VFS with a path. More...
 
std::string toString () const
 
bool useNormalizedPaths () const
 Return true if this file system normalizes . and .. in paths. More...
 
llvm::ErrorOr< Statusstatus (const Twine &Path) override
 Get the status of the entry at Path, if one exists. More...
 
llvm::ErrorOr< std::unique_ptr< File > > openFileForRead (const Twine &Path) override
 Get a File object for the file at Path, if one exists. More...
 
directory_iterator dir_begin (const Twine &Dir, std::error_code &EC) override
 Get a directory_iterator for Dir. More...
 
llvm::ErrorOr< std::string > getCurrentWorkingDirectory () const override
 Get the working directory of this file system. More...
 
std::error_code getRealPath (const Twine &Path, SmallVectorImpl< char > &Output) const override
 Canonicalizes Path by combining with the current working directory and normalizing the path (e.g. More...
 
std::error_code isLocal (const Twine &Path, bool &Result) override
 Is the file mounted on a local filesystem? More...
 
std::error_code setCurrentWorkingDirectory (const Twine &Path) override
 Set the working directory. More...
 
- Public Member Functions inherited from llvm::vfs::FileSystem
virtual ~FileSystem ()
 
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. More...
 
bool exists (const Twine &Path)
 Check whether a file exists. Provided for convenience. More...
 
std::error_code makeAbsolute (SmallVectorImpl< char > &Path) const
 Make Path an absolute path. More...
 
- Public Member Functions inherited from llvm::ThreadSafeRefCountedBase< FileSystem >
void Retain () const
 
void Release () const
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::ThreadSafeRefCountedBase< FileSystem >
 ThreadSafeRefCountedBase ()
 

Detailed Description

An in-memory file system.

Definition at line 415 of file VirtualFileSystem.h.

Constructor & Destructor Documentation

◆ InMemoryFileSystem()

llvm::vfs::InMemoryFileSystem::InMemoryFileSystem ( bool  UseNormalizedPaths = true)
explicit

Definition at line 679 of file VirtualFileSystem.cpp.

References ~InMemoryFileSystem().

◆ ~InMemoryFileSystem()

llvm::vfs::InMemoryFileSystem::~InMemoryFileSystem ( )
overridedefault

Referenced by InMemoryFileSystem().

Member Function Documentation

◆ addFile()

bool llvm::vfs::InMemoryFileSystem::addFile ( const Twine Path,
time_t  ModificationTime,
std::unique_ptr< llvm::MemoryBuffer Buffer,
Optional< uint32_t User = None,
Optional< uint32_t Group = None,
Optional< llvm::sys::fs::file_type Type = None,
Optional< llvm::sys::fs::perms Perms = None 
)

Add a file containing a buffer or a directory to the VFS with a path.

The VFS owns the buffer. If present, User, Group, Type and Perms apply to the newly-created file or directory.

Returns
true if the file or directory was successfully added, false if the file or directory already exists in the file system with different contents.

Definition at line 783 of file VirtualFileSystem.cpp.

◆ addFileNoOwn()

bool llvm::vfs::InMemoryFileSystem::addFileNoOwn ( const Twine Path,
time_t  ModificationTime,
llvm::MemoryBuffer Buffer,
Optional< uint32_t User = None,
Optional< uint32_t Group = None,
Optional< llvm::sys::fs::file_type Type = None,
Optional< llvm::sys::fs::perms Perms = None 
)

Add a buffer to the VFS with a path.

The VFS does not own the buffer. If present, User, Group, Type and Perms apply to the newly-created file or directory.

Returns
true if the file or directory was successfully added, false if the file or directory already exists in the file system with different contents.

Definition at line 793 of file VirtualFileSystem.cpp.

References llvm::MemoryBuffer::getBuffer(), llvm::MemoryBuffer::getBufferIdentifier(), and llvm::MemoryBuffer::getMemBuffer().

◆ addHardLink()

bool llvm::vfs::InMemoryFileSystem::addHardLink ( const Twine From,
const Twine To 
)

Add a hard link to a file.

Here hard links are not intended to be fully equivalent to the classical filesystem. Both the hard link and the file share the same buffer and status (and thus have the same UniqueID). Because of this there is no way to distinguish between the link and the file after the link has been added.

The To path must be an existing file or a hardlink. The From file must not have been added before. The To Path must not be a directory. The From Node is added as a hard link which points to the resolved file of To Node.

Returns
true if the above condition is satisfied and hardlink was successfully created, false otherwise.

Definition at line 850 of file VirtualFileSystem.cpp.

References llvm::vfs::lookupInMemoryNode(), and llvm::None.

◆ dir_begin()

directory_iterator llvm::vfs::InMemoryFileSystem::dir_begin ( const Twine Dir,
std::error_code &  EC 
)
overridevirtual

Get a directory_iterator for Dir.

Note
The 'end' iterator is directory_iterator().

Implements llvm::vfs::FileSystem.

Definition at line 934 of file VirtualFileSystem.cpp.

◆ getCurrentWorkingDirectory()

llvm::ErrorOr<std::string> llvm::vfs::InMemoryFileSystem::getCurrentWorkingDirectory ( ) const
inlineoverridevirtual

Get the working directory of this file system.

Implements llvm::vfs::FileSystem.

Definition at line 481 of file VirtualFileSystem.h.

References llvm::MachO::DiagHandler(), llvm::vfs::getNextVirtualUniqueID(), llvm::vfs::getRealFileSystem(), and llvm::vfs::getVFSFromYAML().

Referenced by getRealPath().

◆ getRealPath()

std::error_code llvm::vfs::InMemoryFileSystem::getRealPath ( const Twine Path,
SmallVectorImpl< char > &  Output 
) const
overridevirtual

Canonicalizes Path by combining with the current working directory and normalizing the path (e.g.

remove dots). If the current working directory is not set, this returns errc::operation_not_permitted.

This doesn't resolve symlinks as they are not supported in in-memory file system.

Reimplemented from llvm::vfs::FileSystem.

Definition at line 968 of file VirtualFileSystem.cpp.

References getCurrentWorkingDirectory(), llvm::vfs::FileSystem::makeAbsolute(), llvm::operation_not_permitted, llvm::sys::path::remove_dots(), and llvm::Twine::toVector().

◆ isLocal()

std::error_code llvm::vfs::InMemoryFileSystem::isLocal ( const Twine Path,
bool Result 
)
overridevirtual

Is the file mounted on a local filesystem?

Reimplemented from llvm::vfs::FileSystem.

Definition at line 980 of file VirtualFileSystem.cpp.

◆ openFileForRead()

llvm::ErrorOr< std::unique_ptr< File > > llvm::vfs::InMemoryFileSystem::openFileForRead ( const Twine Path)
overridevirtual

Get a File object for the file at Path, if one exists.

Implements llvm::vfs::FileSystem.

Definition at line 870 of file VirtualFileSystem.cpp.

◆ setCurrentWorkingDirectory()

std::error_code llvm::vfs::InMemoryFileSystem::setCurrentWorkingDirectory ( const Twine Path)
overridevirtual

Set the working directory.

This will affect all following operations on this file system and may propagate down for nested file systems.

Implements llvm::vfs::FileSystem.

Definition at line 950 of file VirtualFileSystem.cpp.

References assert(), llvm::SmallVectorBase::empty(), llvm::vfs::FileSystem::makeAbsolute(), llvm::sys::path::remove_dots(), llvm::SmallString< InternalLen >::str(), llvm::Twine::toVector(), and useNormalizedPaths().

◆ status()

llvm::ErrorOr< Status > llvm::vfs::InMemoryFileSystem::status ( const Twine Path)
overridevirtual

Get the status of the entry at Path, if one exists.

Implements llvm::vfs::FileSystem.

Definition at line 862 of file VirtualFileSystem.cpp.

Referenced by llvm::vfs::RedirectingFileSystem::dir_begin(), and llvm::vfs::RedirectingFileSystem::status().

◆ toString()

std::string llvm::vfs::InMemoryFileSystem::toString ( ) const

◆ useNormalizedPaths()

bool llvm::vfs::InMemoryFileSystem::useNormalizedPaths ( ) const
inline

Return true if this file system normalizes . and .. in paths.

Definition at line 474 of file VirtualFileSystem.h.

References llvm::sys::fs::openFileForRead(), and llvm::sys::fs::status().

Referenced by llvm::vfs::lookupInMemoryNode(), setCurrentWorkingDirectory(), and toString().


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