A file system that allows overlaying one AbstractFileSystem on top of another. More...

#include "llvm/Support/VirtualFileSystem.h"

Inheritance diagram for llvm::vfs::OverlayFileSystem:

Public Types
using	iterator = FileSystemList::reverse_iterator
using	const_iterator = FileSystemList::const_reverse_iterator
using	reverse_iterator = FileSystemList::iterator
using	const_reverse_iterator = FileSystemList::const_iterator
using	range = iterator_range<iterator>
using	const_range = iterator_range<const_iterator>

Public Member Functions
	OverlayFileSystem (IntrusiveRefCntPtr< FileSystem > Base)
void	pushOverlay (IntrusiveRefCntPtr< FileSystem > FS)
	Pushes a file system on top of the stack.
llvm::ErrorOr< Status >	status (const Twine &Path) override
bool	exists (const Twine &Path) override
llvm::ErrorOr< std::unique_ptr< File > >	openFileForRead (const Twine &Path) override
directory_iterator	dir_begin (const Twine &Dir, std::error_code &EC) override
llvm::ErrorOr< std::string >	getCurrentWorkingDirectory () const override
std::error_code	setCurrentWorkingDirectory (const Twine &Path) override
std::error_code	isLocal (const Twine &Path, bool &Result) override
std::error_code	getRealPath (const Twine &Path, SmallVectorImpl< char > &Output) override
iterator	overlays_begin ()
	Get an iterator pointing to the most recently added file system.
const_iterator	overlays_begin () const
iterator	overlays_end ()
	Get an iterator pointing one-past the least recently added file system.
const_iterator	overlays_end () const
reverse_iterator	overlays_rbegin ()
	Get an iterator pointing to the least recently added file system.
const_reverse_iterator	overlays_rbegin () const
reverse_iterator	overlays_rend ()
	Get an iterator pointing one-past the most recently added file system.
const_reverse_iterator	overlays_rend () const
range	overlays_range ()
const_range	overlays_range () const
Public Member Functions inherited from llvm::RTTIExtends< OverlayFileSystem, FileSystem >
const void *	dynamicClassID () const override
bool	isA () const
	Check whether this instance is a subclass of QueryT.

Static Public Attributes
static const char	ID = 0

Protected Member Functions
void	printImpl (raw_ostream &OS, PrintType Type, unsigned IndentLevel) const override
void	visitChildFileSystems (VisitCallbackTy Callback) override

Additional Inherited Members
Static Public Member Functions inherited from llvm::RTTIExtends< OverlayFileSystem, FileSystem >
static const void *	classID ()
static bool	classof (const T *R)

Detailed Description

A file system that allows overlaying one AbstractFileSystem on top of another.

Consists of a stack of >=1 FileSystem objects, which are treated as being one merged file system. When there is a directory that exists in more than one file system, the OverlayFileSystem contains a directory containing the union of their contents. The attributes (permissions, etc.) of the top-most (most recently added) directory are used. When there is a file that exists in more than one file system, the file in the top-most file system overrides the other(s).

Definition at line 395 of file VirtualFileSystem.h.

Member Typedef Documentation

◆ const_iterator

using llvm::vfs::OverlayFileSystem::const_iterator = FileSystemList::const_reverse_iterator

Definition at line 422 of file VirtualFileSystem.h.

◆ const_range

using llvm::vfs::OverlayFileSystem::const_range = iterator_range<const_iterator>

Definition at line 426 of file VirtualFileSystem.h.

◆ const_reverse_iterator

using llvm::vfs::OverlayFileSystem::const_reverse_iterator = FileSystemList::const_iterator

Definition at line 424 of file VirtualFileSystem.h.

◆ iterator

using llvm::vfs::OverlayFileSystem::iterator = FileSystemList::reverse_iterator

Definition at line 421 of file VirtualFileSystem.h.

◆ range

using llvm::vfs::OverlayFileSystem::range = iterator_range<iterator>

Definition at line 425 of file VirtualFileSystem.h.

◆ reverse_iterator

using llvm::vfs::OverlayFileSystem::reverse_iterator = FileSystemList::iterator

Definition at line 423 of file VirtualFileSystem.h.

Constructor & Destructor Documentation

◆ OverlayFileSystem()

OverlayFileSystem::OverlayFileSystem ( IntrusiveRefCntPtr< FileSystem > Base )

Definition at line 477 of file VirtualFileSystem.cpp.

Member Function Documentation

◆ dir_begin()

directory_iterator OverlayFileSystem::dir_begin	(	const Twine &	Dir,
		std::error_code &	EC )

override

Definition at line 650 of file VirtualFileSystem.cpp.

References llvm::Twine::str().

◆ exists()

bool OverlayFileSystem::exists ( const Twine & Path )

override

Definition at line 498 of file VirtualFileSystem.cpp.

References I, overlays_begin(), and overlays_end().

◆ getCurrentWorkingDirectory()

llvm::ErrorOr< std::string > OverlayFileSystem::getCurrentWorkingDirectory ( ) const

override

Definition at line 519 of file VirtualFileSystem.cpp.

Referenced by pushOverlay().

◆ getRealPath()

std::error_code OverlayFileSystem::getRealPath	(	const Twine &	Path,
		SmallVectorImpl< char > &	Output )

override

Definition at line 539 of file VirtualFileSystem.cpp.

References llvm::no_such_file_or_directory.

◆ isLocal()

std::error_code OverlayFileSystem::isLocal	(	const Twine &	Path,
		bool &	Result )

override

Definition at line 532 of file VirtualFileSystem.cpp.

References llvm::no_such_file_or_directory.

◆ openFileForRead()

ErrorOr< std::unique_ptr< File > > OverlayFileSystem::openFileForRead ( const Twine & Path )

override

Definition at line 508 of file VirtualFileSystem.cpp.

References I, llvm::vfs::make_error_code(), llvm::no_such_file_or_directory, overlays_begin(), and overlays_end().

◆ overlays_begin() [1/2]

iterator llvm::vfs::OverlayFileSystem::overlays_begin ( )

inline

Get an iterator pointing to the most recently added file system.

Definition at line 429 of file VirtualFileSystem.h.

Referenced by exists(), openFileForRead(), and status().

◆ overlays_begin() [2/2]

const_iterator llvm::vfs::OverlayFileSystem::overlays_begin ( ) const

inline

Definition at line 430 of file VirtualFileSystem.h.

◆ overlays_end() [1/2]

iterator llvm::vfs::OverlayFileSystem::overlays_end ( )

inline

Get an iterator pointing one-past the least recently added file system.

Definition at line 433 of file VirtualFileSystem.h.

Referenced by exists(), openFileForRead(), and status().

◆ overlays_end() [2/2]

const_iterator llvm::vfs::OverlayFileSystem::overlays_end ( ) const

inline

Definition at line 434 of file VirtualFileSystem.h.

◆ overlays_range() [1/2]

range llvm::vfs::OverlayFileSystem::overlays_range ( )

inline

Definition at line 444 of file VirtualFileSystem.h.

References llvm::reverse().

Referenced by printImpl(), and visitChildFileSystems().

◆ overlays_range() [2/2]

const_range llvm::vfs::OverlayFileSystem::overlays_range ( ) const

inline

Definition at line 445 of file VirtualFileSystem.h.

References llvm::reverse().

◆ overlays_rbegin() [1/2]

reverse_iterator llvm::vfs::OverlayFileSystem::overlays_rbegin ( )

inline

Get an iterator pointing to the least recently added file system.

Definition at line 437 of file VirtualFileSystem.h.

◆ overlays_rbegin() [2/2]

const_reverse_iterator llvm::vfs::OverlayFileSystem::overlays_rbegin ( ) const

inline

Definition at line 438 of file VirtualFileSystem.h.

◆ overlays_rend() [1/2]

reverse_iterator llvm::vfs::OverlayFileSystem::overlays_rend ( )

inline

Get an iterator pointing one-past the most recently added file system.

Definition at line 441 of file VirtualFileSystem.h.

◆ overlays_rend() [2/2]

const_reverse_iterator llvm::vfs::OverlayFileSystem::overlays_rend ( ) const

inline

Definition at line 442 of file VirtualFileSystem.h.

◆ printImpl()

void OverlayFileSystem::printImpl	(	raw_ostream &	OS,
		PrintType	Type,
		unsigned	IndentLevel ) const

overrideprotected

Definition at line 554 of file VirtualFileSystem.cpp.

References overlays_range().

◆ pushOverlay()

void OverlayFileSystem::pushOverlay ( IntrusiveRefCntPtr< FileSystem > FS )

Pushes a file system on top of the stack.

Definition at line 481 of file VirtualFileSystem.cpp.

References llvm::get(), and getCurrentWorkingDirectory().

◆ setCurrentWorkingDirectory()

std::error_code OverlayFileSystem::setCurrentWorkingDirectory ( const Twine & Path )

override

Definition at line 525 of file VirtualFileSystem.cpp.

◆ status()

ErrorOr< Status > OverlayFileSystem::status ( const Twine & Path )

override

Definition at line 488 of file VirtualFileSystem.cpp.

References I, llvm::vfs::make_error_code(), llvm::no_such_file_or_directory, overlays_begin(), and overlays_end().

◆ visitChildFileSystems()

void OverlayFileSystem::visitChildFileSystems ( VisitCallbackTy Callback )

overrideprotected

Definition at line 547 of file VirtualFileSystem.cpp.

References overlays_range().

Member Data Documentation

◆ ID

const char OverlayFileSystem::ID = 0

static

Definition at line 404 of file VirtualFileSystem.h.

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

include/llvm/Support/VirtualFileSystem.h
lib/Support/VirtualFileSystem.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_range

◆ const_reverse_iterator

◆ iterator

◆ range

◆ reverse_iterator

Constructor & Destructor Documentation

◆ OverlayFileSystem()

Member Function Documentation

◆ dir_begin()

◆ exists()

◆ getCurrentWorkingDirectory()

◆ getRealPath()

◆ isLocal()

◆ openFileForRead()

◆ overlays_begin() [1/2]

◆ overlays_begin() [2/2]

◆ overlays_end() [1/2]

◆ overlays_end() [2/2]

◆ overlays_range() [1/2]

◆ overlays_range() [2/2]

◆ overlays_rbegin() [1/2]

◆ overlays_rbegin() [2/2]

◆ overlays_rend() [1/2]

◆ overlays_rend() [2/2]

◆ printImpl()

◆ pushOverlay()

◆ setCurrentWorkingDirectory()

◆ status()

◆ visitChildFileSystems()

Member Data Documentation

◆ ID