Serves as component for path and filesystem functionality. More...

Classes
class	Path

class	PathException
	Exception class used by Path methods. More...

Enumerations
enum	Error { OK , OPEN_FAILED , GENERAL_FAILURE , IO_ERROR , INVALID_PATH , ACCESS_DENIED }
	Enumerates possible error values for filesystem interaction. More...

enum	EnumDirFlags { ED_FILES = 0x1 , ED_DIRECTORIES = 0x2 }
	Enumeration for possible listings in a directory, usable in function enumDirectory() More...

enum class	DiffOptions : std::uint64_t { none = 0 }

Functions
Path	getTempDirectory ()

Path	getWorkingDirectory ()

Error	setWorkingDirectory (const Path &path)

Error	readTextFile (const Path &file_path, std::string &content)

Error	readTextLines (const Path &file_path, std::vector< std::string > &vec_lines)

Error	writeTextFile (const Path &file_path, const std::string &content)

Error	enumDirectory (const Path &dir_path, std::vector< Path > &vec_entries, std::int32_t flags=ED_FILES\|ED_DIRECTORIES)

bool	exists (const Path &path)

bool	createDirectory (const Path &path)

bool	isFile (const Path &file_path)

bool	isDirectory (const Path &dir_path)

bool	remove (const Path &path)

bool	rename (const Path &path, const Path &new_path)

std::int64_t	compareFiles (const Path &p1, const Path &p2)

std::int64_t	compareFiles (const Path &p1, const Path &p2, DiffOptions options)

bool	operator== (const Path &lhs, const Path &rhs)

bool	operator!= (const Path &lhs, const Path &rhs)

std::ostream &	operator<< (std::ostream &os, const Path &p)

Path	operator+ (const Path &a, const Path &b)

Detailed Description

Serves as component for path and filesystem functionality.

Enumeration Type Documentation

◆ DiffOptions

enum class a_util::filesystem::DiffOptions : std::uint64_t

strong

Available options for operations comparing files or directories.

Enumerator
none	Default behavior; needs to be specified by the using function.

◆ EnumDirFlags

enum a_util::filesystem::EnumDirFlags

Enumeration for possible listings in a directory, usable in function enumDirectory()

Enumerator
ED_FILES	List files in the directory.
ED_DIRECTORIES	List directories in the directory.

◆ Error

enum a_util::filesystem::Error

Enumerates possible error values for filesystem interaction.

Enumerator
OK	No error, basically meaning success.
OPEN_FAILED	Opening a file or folder from the filesystem failed.
GENERAL_FAILURE	General errors.
IO_ERROR	Input/output error during filesystem access.
INVALID_PATH	Accessed path on the filesystem is invalid.
ACCESS_DENIED	Access to file or folder in the filesystem denied.

Function Documentation

◆ compareFiles() [1/2]

std::int64_t a_util::filesystem::compareFiles	(	const Path &	p1,
		const Path &	p2 )

Compare content of two files.

Parameters

[in]	p1	Path to first file.
[in]	p2	Path to second file.

Return values

0	File contents are equal or p1 and p2 are the same file.
>0	Position of the first different character in the files.
<0	Comparison not possible, e.g. file does not exist or path is a directory.

Exceptions

ios_base::failure exception if cannot open the file, or try to access character after the end of file, or no character were written or error was set in ifstream.

◆ compareFiles() [2/2]

std::int64_t a_util::filesystem::compareFiles	(	const Path &	p1,
		const Path &	p2,
		DiffOptions	options )

Parameters

[in]

options

Options controlling the behavior of the diff operation. Supported options:

DiffOptions::none Files are bitwise equal

Compare content of two files.

Parameters

[in]	p1	Path to first file.
[in]	p2	Path to second file.

Return values

0	File contents are equal or p1 and p2 are the same file.
>0	Position of the first different character in the files.
<0	Comparison not possible, e.g. file does not exist or path is a directory.

Exceptions

ios_base::failure exception if cannot open the file, or try to access character after the end of file, or no character were written or error was set in ifstream.

◆ createDirectory()

bool a_util::filesystem::createDirectory ( const Path & path )

Create a new directory on the filesystem

Note: All given non-existing subdirectories are created as well

Parameters

[in] path Path to the directory to create

Returns: true if the directory was created or already exists, false otherwise

◆ enumDirectory()

Error a_util::filesystem::enumDirectory	(	const Path &	dir_path,
		std::vector< Path > &	vec_entries,
		std::int32_t	flags = ED_FILES\|ED_DIRECTORIES )

List all entries in a directory

Parameters

[in]	dir_path	Path to the directory to list the entries from
[out]	vec_entries	All entries listed in the directory
[in]	flags	EnumDirFlags filtering what to list in the directory

Return values

INVALID_PATH	The path does not exist or is not a directory
GENERAL_FAILURE	Some unknown error while listing entries in the directory occurred
OK	Entries listed successfully, with the list being copied to `vec_entries`

◆ exists()

bool a_util::filesystem::exists ( const Path & path )

Check whether the file or directory exists on the filesystem

Parameters

[in] path Path to the file or directory

Returns: true if the path exists, false otherwise

◆ getTempDirectory()

Path a_util::filesystem::getTempDirectory ( )

Retrieve path to the temp directory of the system

Returns: Temp directory of the system

◆ getWorkingDirectory()

Path a_util::filesystem::getWorkingDirectory ( )

Retrieve path to the working directory of the current process

Returns: Current working directory path

◆ isDirectory()

bool a_util::filesystem::isDirectory ( const Path & dir_path )

Check whether the path points to a directory on the filesystem

Parameters

[in] dir_path Path to the directory to check

Returns: true if the path points to a directory, false otherwise

◆ isFile()

bool a_util::filesystem::isFile ( const Path & file_path )

Check whether the path points to a file on the filesystem

Parameters

[in] file_path Path to the file to check

Returns: true if the path points to a file, false otherwise

◆ operator!=()

bool a_util::filesystem::operator!=	(	const Path &	lhs,
		const Path &	rhs )

Check two paths for inequality

Note: The paths are compared syntactically, any canonicalization must be done manually!

Parameters

[in]	lhs	Right hand side object
[in]	rhs	Left hand side object

Return values

true	if the paths are not equal, false otherwise

◆ operator+()

Path a_util::filesystem::operator+	(	const Path &	a,
		const Path &	b )

Appends two paths, forming a new path

Parameters

[in]	a	The left path
[in]	b	The right path

Return values

A	new path combined from a and b (or empty, in case of an error)

◆ operator<<()

std::ostream & a_util::filesystem::operator<<	(	std::ostream &	os,
		const Path &	p )

Performs stream output on the path p

Note: The implemenation simply calls toString() without arguments.; This mean that this operator doesn't support a non-default separator

Parameters

[in]	os	the output stream
[in]	p	path to print

Return values

the	output stream

◆ operator==()

bool a_util::filesystem::operator==	(	const Path &	lhs,
		const Path &	rhs )

Check two paths for equality

Note: The paths are compared syntactically, any canonicalization must be done manually!

Parameters

[in]	lhs	Right hand side object
[in]	rhs	Left hand side object

Return values

true	if the paths are equal, false otherwise

◆ readTextFile()

Error a_util::filesystem::readTextFile	(	const Path &	file_path,
		std::string &	content )

Read entire content of a text file into a string

Parameters

[in]	file_path	Path to the file to be read
[out]	content	Destination string to be filled

Return values

OPEN_FAILED	File could not be opened
GENERAL_FAILURE	Seeking the file did not succeed
IO_ERROR	Some I/O error occurred while reading the file
OK	Content successfully read and copied to out parameter `content`

◆ readTextLines()

Error a_util::filesystem::readTextLines	(	const Path &	file_path,
		std::vector< std::string > &	vec_lines )

Read entire content of a text file and split it every new line, dropping the EOL characters

Parameters

[in]	file_path	Path to the file to be read
[out]	vec_lines	Vector of strings with each string containing one line of the file

Returns: Same values documented in readTextFile()

◆ remove()

bool a_util::filesystem::remove ( const Path & path )

Remove the file or directory pointed to by path.

Note: Directories and their content are deleted recursively.

Parameters

[in] path Path to the element to be deleted.

Returns: true if the element could be deleted, false otherwise.

◆ rename()

bool a_util::filesystem::rename	(	const Path &	path,
		const Path &	new_path )

Rename or move a file or directory from path to new_path.

Parameters

[in]	path	Path to the file or directory to be renamed or moved.
[in]	new_path	Path the file or directory is renamed of moved to.

Returns: true on success, false otherwise.

◆ setWorkingDirectory()

Error a_util::filesystem::setWorkingDirectory ( const Path & path )

Set the working directory

Parameters

[in] path Path to the new working directory

Return values

INVALID_PATH	The path is invalid/nonexisting or a file path
GENERAL_FAILURE	The OS failed to set the working directory
OK	Working directory was successfully set

◆ writeTextFile()

Error a_util::filesystem::writeTextFile	(	const Path &	file_path,
		const std::string &	content )

Open a file in mode 'w' and write new content to it.

Parameters

[in]	file_path	Path to the file to (over-)write
[in]	content	Content to write to the file

Return values

OPEN_FAILED	File could not be opened
IO_ERROR	Some I/O error occurred while writing the file
OK	Content successfully read and copied to out parameter `content`

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ DiffOptions

◆ EnumDirFlags

◆ Error

Function Documentation

◆ compareFiles() [1/2]

◆ compareFiles() [2/2]

◆ createDirectory()

◆ enumDirectory()

◆ exists()

◆ getTempDirectory()

◆ getWorkingDirectory()

◆ isDirectory()

◆ isFile()

◆ operator!=()

◆ operator+()

◆ operator<<()

◆ operator==()

◆ readTextFile()

◆ readTextLines()

◆ remove()

◆ rename()

◆ setWorkingDirectory()

◆ writeTextFile()