Archive file system implementation. More...

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

Inheritance diagram for ArchiveFileSystem:

Collaboration diagram for ArchiveFileSystem:

Classes
struct	FileInformation

Public Member Functions
	ArchiveFileSystem (const string &fileName="archive.ta")
	Public constructor. More...

virtual	~ArchiveFileSystem ()
	Public destructor. More...

const string &	getArchiveFileName ()

const string	getFileName (const string &path, const string &fileName) override
	Get file name. More...

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

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

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

bool	fileExists (const string &fileName) override
	Check if file exists. More...

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

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

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

const string	getContentAsString (const string &pathName, const string &fileName) override
	Get content as string. More...

void	setContentFromString (const string &pathName, const string &fileName, const string &content) override
	Set content from string. More...

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

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

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

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

const string	getCanonicalPath (const string &pathName, const string &fileName) override
	Get canonical path name. More...

const string	getCurrentWorkingPathName () override
	Get current working path name. More...

void	changePath (const string &pathName) override
	Change path. More...

const string	getPathName (const string &fileName) override
	Get path name. More...

const string	getFileName (const string &fileName) override
	Get file name. More...

void	createPath (const string &pathName) override
	Create path. More...

void	removePath (const string &pathName, bool recursive) override
	Remove path. More...

void	removeFile (const string &pathName, const string &fileName) override
	Remove file. More...

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

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

const string	computeSHA256Hash ()
	Compute SHA256 hash. More...

Public Member Functions inherited from FileSystemInterface
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...

Private Member Functions
void	decompress (vector< uint8_t > &inContent, vector< uint8_t > &outContent)
	Decompress from archive. More...

Private Attributes
string	fileName

Mutex	ifsMutex

ifstream	ifs

map< string, FileInformation >	fileInformations

Detailed Description

Archive file system implementation.

Author: Andreas Drewke

Definition at line 27 of file ArchiveFileSystem.h.

Constructor & Destructor Documentation

◆ ArchiveFileSystem()

ArchiveFileSystem ( const string & fileName = "archive.ta" )

Public constructor.

Parameters

fileName archive file name

Definition at line 39 of file ArchiveFileSystem.cpp.

◆ ~ArchiveFileSystem()

~ArchiveFileSystem ( )

virtual

Public destructor.

Definition at line 73 of file ArchiveFileSystem.cpp.

Member Function Documentation

◆ changePath()

void changePath ( const string & pathName )

overridevirtual

Change path.

Parameters

pathName path name

Implements FileSystemInterface.

Definition at line 391 of file ArchiveFileSystem.cpp.

◆ computeSHA256Hash()

const string computeSHA256Hash ( )

Compute SHA256 hash.

Definition at line 428 of file ArchiveFileSystem.cpp.

◆ createPath()

void createPath ( const string & pathName )

overridevirtual

Create path.

Parameters

pathName path name

Implements FileSystemInterface.

Definition at line 408 of file ArchiveFileSystem.cpp.

◆ decompress()

void decompress	(	vector< uint8_t > &	inContent,
		vector< uint8_t > &	outContent
	)

private

Decompress from archive.

Parameters

inContent	compressed content
outContent	uncompressed out content

Exceptions

tdme::os::filesystem::FileSystemException

Definition at line 160 of file ArchiveFileSystem.cpp.

◆ fileExists()

bool fileExists ( const string & fileName )

overridevirtual

Check if file exists.

Parameters

fileName file name

Returns: bool if file exists

Implements FileSystemInterface.

Definition at line 117 of file ArchiveFileSystem.cpp.

◆ getArchiveFileName()

const string & getArchiveFileName ( )

Returns: Returns underlying TDME2 archive file name

Definition at line 78 of file ArchiveFileSystem.cpp.

◆ getCanonicalPath()

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

overridevirtual

Get canonical path name.

Parameters

pathName	path name
fileName	file name

Returns: canonical path

Implements FileSystemInterface.

Definition at line 329 of file ArchiveFileSystem.cpp.

◆ getContent()

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

overridevirtual

Get file content.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 275 of file ArchiveFileSystem.cpp.

◆ getContentAsString()

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

overridevirtual

Get content as string.

Parameters

pathName	path name
fileName	file name

Returns: string

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 230 of file ArchiveFileSystem.cpp.

◆ getContentAsStringArray()

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

overridevirtual

Get file content as string array.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 313 of file ArchiveFileSystem.cpp.

◆ getCurrentWorkingPathName()

const string getCurrentWorkingPathName ( )

overridevirtual

Get current working path name.

Returns: current working path

Implements FileSystemInterface.

Definition at line 387 of file ArchiveFileSystem.cpp.

◆ getFileName() [1/2]

const string getFileName ( const string & fileName )

overridevirtual

Get file name.

Parameters

fileName file name

Returns: canonical path

Implements FileSystemInterface.

Definition at line 401 of file ArchiveFileSystem.cpp.

◆ getFileName() [2/2]

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

overridevirtual

Get file name.

Parameters

pathName	path name
fileName	file name

Returns: complete filename with path and file

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 82 of file ArchiveFileSystem.cpp.

◆ getFileSize()

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

overridevirtual

Return file size of given file.

Parameters

pathName	path name
fileName	file name

Returns: file size

Implements FileSystemInterface.

Definition at line 145 of file ArchiveFileSystem.cpp.

◆ getPathName()

const string getPathName ( const string & fileName )

overridevirtual

Get path name.

Parameters

fileName file name

Returns: canonical path

Implements FileSystemInterface.

Definition at line 394 of file ArchiveFileSystem.cpp.

◆ getThumbnailAttachment() [1/2]

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

overridevirtual

Reads a thumbnail attachment from binary file.

Parameters

pathName	path name
fileName	file name
thumbnailAttachmentContent	thumbnail attachment content

Returns: attachment available

Implements FileSystemInterface.

Definition at line 420 of file ArchiveFileSystem.cpp.

◆ getThumbnailAttachment() [2/2]

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

overridevirtual

Reads a thumbnail attachment from data vector.

Parameters

content	content
thumbnailAttachmentContent	thumbnail attachment content

Returns: attachment available

Implements FileSystemInterface.

Definition at line 424 of file ArchiveFileSystem.cpp.

◆ isDrive()

bool isDrive ( const string & pathName )

overridevirtual

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

Parameters

pathName path name

Returns: if file is a drive

Implements FileSystemInterface.

Definition at line 113 of file ArchiveFileSystem.cpp.

◆ isExecutable()

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

overridevirtual

Returns if file is a executable file.

Parameters

pathName	path name
fileName	file name

Returns: is executable

Implements FileSystemInterface.

Definition at line 126 of file ArchiveFileSystem.cpp.

◆ isPath()

bool isPath ( const string & pathName )

overridevirtual

Check if file is a path.

Parameters

pathName path name

Returns: if file is a path

Implements FileSystemInterface.

Definition at line 109 of file ArchiveFileSystem.cpp.

◆ list()

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

overridevirtual

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

Implements FileSystemInterface.

Definition at line 86 of file ArchiveFileSystem.cpp.

◆ removeFile()

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

overridevirtual

Remove file.

Parameters

pathName	path name
fileName	file name

Returns: success

Implements FileSystemInterface.

Definition at line 416 of file ArchiveFileSystem.cpp.

◆ removePath()

void removePath	(	const string &	pathName,
		bool	recursive
	)

overridevirtual

Remove path.

Parameters

pathName	path name
recursive	remove recursive

Returns: success

Implements FileSystemInterface.

Definition at line 412 of file ArchiveFileSystem.cpp.

◆ setContent()

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

overridevirtual

Set file content.

Parameters

pathName	path name
fileName	file name
content	content vector

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 309 of file ArchiveFileSystem.cpp.

◆ setContentFromString()

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

overridevirtual

Set content from string.

Parameters

pathName	path name
fileName	file name
content	content string

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 271 of file ArchiveFileSystem.cpp.

◆ setContentFromStringArray()

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

overridevirtual

Set file content as string array.

Parameters

pathName	path name
fileName	file name
content	string array

Returns: byte array

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 324 of file ArchiveFileSystem.cpp.

◆ setExecutable()

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

overridevirtual

Set up file to be an executable file.

Parameters

pathName	path name
fileName	file name

Returns: success

Exceptions

tdme::os::filesystem::FileSystemException

Implements FileSystemInterface.

Definition at line 141 of file ArchiveFileSystem.cpp.

Member Data Documentation

◆ fileInformations

map<string, FileInformation> fileInformations

private

Definition at line 41 of file ArchiveFileSystem.h.

◆ fileName

string fileName

private

Definition at line 38 of file ArchiveFileSystem.h.

◆ ifs

ifstream ifs

private

Definition at line 40 of file ArchiveFileSystem.h.

◆ ifsMutex

Mutex ifsMutex

private

Definition at line 39 of file ArchiveFileSystem.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ArchiveFileSystem()

◆ ~ArchiveFileSystem()

Member Function Documentation

◆ changePath()

◆ computeSHA256Hash()

◆ createPath()

◆ decompress()

◆ fileExists()

◆ getArchiveFileName()

◆ 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()

Member Data Documentation

◆ fileInformations

◆ fileName

◆ ifs

◆ ifsMutex