#include <Filesystem.h>

Inheritance diagram for Filesystem:

Collaboration diagram for Filesystem:

Public Types
typedef Filesystem (	ProbeCallback) (Disk *)

Public Member Functions
	Filesystem ()

virtual	~Filesystem ()

virtual bool	initialise (Disk *pDisk)=0

virtual File *	find (const StringView &path)

virtual File *	find (const String &path)

virtual File *	find (const StringView &path, File *pStartNode)

virtual File *	find (const String &path, File *pStartNode)

virtual File *	getRoot () const =0

virtual String	getVolumeLabel () const =0

bool	createFile (const StringView &path, uint32_t mask, File *pStartNode=0)

bool	createDirectory (const StringView &path, uint32_t mask, File *pStartNode=0)

bool	createSymlink (const StringView &path, const String &value, File *pStartNode=0)

bool	createLink (const StringView &path, File target, File pStartNode=0)

bool	remove (const StringView &path, File *pStartNode=0)

Disk *	getDisk ()

bool	isReadOnly ()

virtual bool	isCaseSensitive ()

virtual bool	remove (File parent, File file)=0

Protected Member Functions
virtual bool	createFile (File *parent, const String &filename, uint32_t mask)=0

virtual bool	createDirectory (File *parent, const String &filename, uint32_t mask)=0

virtual bool	createSymlink (File *parent, const String &filename, const String &value)=0

virtual bool	createLink (File parent, const String &filename, File target)

Protected Attributes
bool	m_bReadOnly

Disk *	m_pDisk

Private Member Functions
File *	getTrueRoot ()

File *	findNode (File *pNode, StringView path)

File *	findParent (StringView path, File *pStartNode, String &filename)

	Filesystem (const Filesystem &)

void	operator= (const Filesystem &)

Private Attributes
size_t	m_nAliases

Friends
class	VFS

Detailed Description

This class provides the abstract skeleton that all filesystems must implement.

Thanks to gr00ber at #osdev for the inspiration for the caching algorithms.

Definition at line 36 of file Filesystem.h.

Member Typedef Documentation

typedef Filesystem*(* Filesystem::ProbeCallback) (Disk *)

Type of the probing callback given to the VFS. Probe function - if this filesystem is found on the given Disk device, create a new instance of it and return that. Else return 0.

Definition at line 58 of file Filesystem.h.

Constructor & Destructor Documentation

Filesystem::Filesystem ( )

Constructor - creates a blank object.

Definition at line 35 of file Filesystem.cc.

References ~Filesystem().

Filesystem::~Filesystem ( )

virtualdefault

Destructor

Referenced by Filesystem().

Here is the caller graph for this function:

Filesystem::Filesystem ( const Filesystem & )

private

Copy constructor.

Note: NOT implemented.

Member Function Documentation

bool Filesystem::createDirectory	(	const StringView &	path,
		uint32_t	mask,
		File *	pStartNode = `0`
	)

Creates a directory on the filesystem. Fails if the dir's parent directory does not exist.

Definition at line 112 of file Filesystem.cc.

References VFS::checkAccess(), createDirectory(), findNode(), findParent(), and getTrueRoot().

Referenced by createDirectory(), VFS::createDirectory(), and RamFs::getVolumeLabel().

Here is the caller graph for this function:

virtual bool Filesystem::createDirectory	(	File *	parent,
		const String &	filename,
		uint32_t	mask
	)

protectedpure virtual

createDirectory calls this after it has parsed the string path.

Implemented in ConsoleManager, DevFs, ProcFs, RamFs, UnixFilesystem, RawFs, FatFilesystem, Iso9660Filesystem, and Ext2Filesystem.

bool Filesystem::createFile	(	const StringView &	path,
		uint32_t	mask,
		File *	pStartNode = `0`
	)

Creates a file on the filesystem - fails if the file's parent directory does not exist.

Definition at line 75 of file Filesystem.cc.

References VFS::checkAccess(), createFile(), findNode(), findParent(), and getTrueRoot().

Referenced by FatFilesystem::createDirectory(), FatFilesystem::createFile(), createFile(), VFS::createFile(), and RamFs::getVolumeLabel().

Here is the caller graph for this function:

virtual bool Filesystem::createFile	(	File *	parent,
		const String &	filename,
		uint32_t	mask
	)

protectedpure virtual

createFile calls this after it has parsed the string path.

Implemented in ConsoleManager, DevFs, ProcFs, RamFs, UnixFilesystem, RawFs, FatFilesystem, Iso9660Filesystem, and Ext2Filesystem.

bool Filesystem::createLink	(	const StringView &	path,
		File *	target,
		File *	pStartNode = `0`
	)

Creates a hard link on the filesystem to the given target.

Definition at line 188 of file Filesystem.cc.

References VFS::checkAccess(), createLink(), findNode(), findParent(), and getTrueRoot().

Referenced by createLink(), and VFS::createLink().

Here is the caller graph for this function:

bool Filesystem::createLink	(	File *	parent,
		const String &	filename,
		File *	target
	)

protectedvirtual

createLink calls this after it has parsed the string path.

Reimplemented in Ext2Filesystem.

Definition at line 498 of file Filesystem.cc.

bool Filesystem::createSymlink	(	const StringView &	path,
		const String &	value,
		File *	pStartNode = `0`
	)

Creates a symlink on the filesystem, with the given value.

Definition at line 149 of file Filesystem.cc.

References VFS::checkAccess(), createSymlink(), findNode(), findParent(), and getTrueRoot().

Referenced by createSymlink(), VFS::createSymlink(), and RamFs::getVolumeLabel().

Here is the caller graph for this function:

virtual bool Filesystem::createSymlink	(	File *	parent,
		const String &	filename,
		const String &	value
	)

protectedpure virtual

createSymlink calls this after it has parsed the string path.

Implemented in ConsoleManager, DevFs, ProcFs, RamFs, UnixFilesystem, RawFs, FatFilesystem, Iso9660Filesystem, and Ext2Filesystem.

File * Filesystem::find ( const StringView & path )

virtual

Attempt to find a file or directory in this filesystem.

Parameters

path	The path to the file, in UTF-8 format, without filesystem identifier (e.g. not "root:/file", but "/file").
pStartNode	The node to start parsing 'path' from - defaults to / but is expected to contain the current working directory.