File system interface. More...

#include <tdme/os/filesystem/FileSystemInterface.h>

Inheritance diagram for FileSystemInterface:

Collaboration diagram for FileSystemInterface:

Public Member Functions
virtual	~FileSystemInterface ()
	Public destructor. More...

virtual const string	getFileName (const string &pathName, const string &fileName)=0
	Get file name. More...

virtual uint64_t	getFileSize (const string &pathName, const string &fileName)=0
	Return file size of given file. More...

virtual const string	getContentAsString (const string &pathName, const string &fileName)=0
	Get content as string. More...

virtual void	setContentFromString (const string &pathName, const string &fileName, const string &content)=0
	Set content from string. More...

virtual void	getContent (const string &pathName, const string &fileName, vector< uint8_t > &content)=0
	Get file content. More...

virtual void	setContent (const string &pathName, const string &fileName, const vector< uint8_t > &content)=0
	Set file content. More...

virtual void	getContentAsStringArray (const string &pathName, const string &fileName, vector< string > &content)=0
	Get file content as string array. More...

virtual void	setContentFromStringArray (const string &pathName, const string &fileName, const vector< string > &content)=0
	Set file content as string array. More...

virtual void	list (const string &pathName, vector< string > &files, FileNameFilter *filter=nullptr, bool addDrives=false)=0
	List files for given path and filter by a file name filter if not null. More...

virtual bool	isPath (const string &pathName)=0
	Check if file is a path. More...

virtual bool	isDrive (const string &pathName)=0
	Check if file is a drive (applies to Microsoft Windows only) More...

virtual bool	fileExists (const string &fileName)=0
	Check if file exists. More...

virtual bool	isExecutable (const string &pathName, const string &fileName)=0
	Returns if file is a executable file. More...

virtual void	setExecutable (const string &pathName, const string &fileName)=0
	Set up file to be an executable file. More...

virtual const string	getCanonicalPath (const string &pathName, const string &fileName)=0
	Get canonical path name. More...

virtual const string	getCurrentWorkingPathName ()=0
	Get current working path name. More...

virtual void	changePath (const string &pathName)=0
	Change path. More...

virtual const string	getPathName (const string &fileName)=0
	Get path name. More...

virtual const string	getFileName (const string &fileName)=0
	Get file name. More...

virtual void	createPath (const string &pathName)=0
	Create path. More...

virtual void	removePath (const string &pathName, bool recursive)=0
	Remove path. More...

virtual void	removeFile (const string &pathName, const string &fileName)=0
	Remove file. More...

virtual bool	getThumbnailAttachment (const string &pathName, const string &fileName, vector< uint8_t > &thumbnailAttachmentContent)=0
	Reads a thumbnail attachment from binary file. More...

virtual bool	getThumbnailAttachment (const vector< uint8_t > &content, vector< uint8_t > &thumbnailAttachmentContent)=0
	Reads a thumbnail attachment from data vector. More...

Detailed Description

File system interface.

Author: Andreas Drewke

Version: $Id$

Definition at line 23 of file FileSystemInterface.h.

Constructor & Destructor Documentation

◆ ~FileSystemInterface()

virtual ~FileSystemInterface ( )

inlinevirtual

Public destructor.

Definition at line 28 of file FileSystemInterface.h.

Member Function Documentation

◆ changePath()

virtual void changePath ( const string & pathName )

pure virtual

Change path.

Parameters

pathName path name

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ createPath()

virtual void createPath ( const string & pathName )

pure virtual

Create path.

Parameters

pathName path name

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ fileExists()

virtual bool fileExists ( const string & fileName )

pure virtual

Check if file exists.

Parameters

fileName file name

Returns: bool if file exists

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getCanonicalPath()

virtual const string getCanonicalPath	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Get canonical path name.

Parameters

pathName	path name
fileName	file name

Returns: canonical path

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getContent()

virtual void getContent	(	const string &	pathName,
		const string &	fileName,
		vector< uint8_t > &	content
	)

pure virtual

Get file content.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getContentAsString()

virtual const string getContentAsString	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Get content as string.

Parameters

pathName	path name
fileName	file name

Returns: string

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getContentAsStringArray()

virtual void getContentAsStringArray	(	const string &	pathName,
		const string &	fileName,
		vector< string > &	content
	)

pure virtual

Get file content as string array.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getCurrentWorkingPathName()

virtual const string getCurrentWorkingPathName ( )

pure virtual

Get current working path name.

Returns: current working path

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getFileName() [1/2]

virtual const string getFileName ( const string & fileName )

pure virtual

Get file name.

Parameters

fileName file name

Returns: canonical path

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getFileName() [2/2]

virtual const string getFileName	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Get file name.

Parameters

pathName	path name
fileName	file name

Returns: complete filename with path and file

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getFileSize()

virtual uint64_t getFileSize	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Return file size of given file.

Parameters

pathName	path name
fileName	file name

Returns: file size

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getPathName()

virtual const string getPathName ( const string & fileName )

pure virtual

Get path name.

Parameters

fileName file name

Returns: canonical path

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getThumbnailAttachment() [1/2]

virtual bool getThumbnailAttachment	(	const string &	pathName,
		const string &	fileName,
		vector< uint8_t > &	thumbnailAttachmentContent
	)

pure virtual

Reads a thumbnail attachment from binary file.

Parameters

pathName	path name
fileName	file name
thumbnailAttachmentContent	thumbnail attachment content

Returns: attachment available

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ getThumbnailAttachment() [2/2]

virtual bool getThumbnailAttachment	(	const vector< uint8_t > &	content,
		vector< uint8_t > &	thumbnailAttachmentContent
	)

pure virtual

Reads a thumbnail attachment from data vector.

Parameters

content	content
thumbnailAttachmentContent	thumbnail attachment content

Returns: attachment available

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ isDrive()

virtual bool isDrive ( const string & pathName )

pure virtual

Check if file is a drive (applies to Microsoft Windows only)

Parameters

pathName path name

Returns: if file is a drive

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ isExecutable()

virtual bool isExecutable	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Returns if file is a executable file.

Parameters

pathName	path name
fileName	file name

Returns: is executable

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ isPath()

virtual bool isPath ( const string & pathName )

pure virtual

Check if file is a path.

Parameters

pathName path name

Returns: if file is a path

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ list()

virtual void list	(	const string &	pathName,
		vector< string > &	files,
		FileNameFilter *	filter = `nullptr`,
		bool	addDrives = `false`
	)

pure virtual

List files for given path and filter by a file name filter if not null.

Parameters

pathName	path name
files	files
filter	filter or null, this filter can be created on stack as ownership will not be taken over
addDrives	add drives to list(applies to Microsoft Windows only)

Returns: file names

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ removeFile()

virtual void removeFile	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Remove file.

Parameters

pathName	path name
fileName	file name

Returns: success

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ removePath()

virtual void removePath	(	const string &	pathName,
		bool	recursive
	)

pure virtual

Remove path.

Parameters

pathName	path name
recursive	remove recursive

Returns: success

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ setContent()

virtual void setContent	(	const string &	pathName,
		const string &	fileName,
		const vector< uint8_t > &	content
	)

pure virtual

Set file content.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ setContentFromString()

virtual void setContentFromString	(	const string &	pathName,
		const string &	fileName,
		const string &	content
	)

pure virtual

Set content from string.

Parameters

pathName	path name
fileName	file name
content	content string

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ setContentFromStringArray()

virtual void setContentFromStringArray	(	const string &	pathName,
		const string &	fileName,
		const vector< string > &	content
	)

pure virtual

Set file content as string array.

Parameters

pathName	path name
fileName	file name
content	string array

Returns: byte array

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

◆ setExecutable()

virtual void setExecutable	(	const string &	pathName,
		const string &	fileName
	)

pure virtual

Set up file to be an executable file.

Parameters

pathName	path name
fileName	file name

Returns: success

Exceptions

tdme::os::filesystem::FileSystemException

Implemented in ArchiveFileSystem, and StandardFileSystem.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/os/filesystem/FileSystemInterface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~FileSystemInterface()

Member Function Documentation

◆ changePath()

◆ createPath()

◆ fileExists()

◆ getCanonicalPath()

◆ getContent()

◆ getContentAsString()

◆ getContentAsStringArray()

◆ getCurrentWorkingPathName()

◆ getFileName() [1/2]

◆ getFileName() [2/2]

◆ getFileSize()

◆ getPathName()

◆ getThumbnailAttachment() [1/2]

◆ getThumbnailAttachment() [2/2]

◆ isDrive()

◆ isExecutable()

◆ isPath()

◆ list()

◆ removeFile()

◆ removePath()

◆ setContent()

◆ setContentFromString()

◆ setContentFromStringArray()

◆ setExecutable()