easy3d::file_system Namespace Reference

A very basic filesystem implementation. More...

Functions
bool	is_file (const std::string &path)
	Tests if 'path' is an existing file.
bool	is_directory (const std::string &path)
	Tests if 'path' is an existing directory.
bool	create_directory (const std::string &path)
	Creates a directory entitled 'path'.
bool	delete_file (const std::string &path)
	Deletes the file 'path'.
bool	delete_directory (const std::string &path)
	Deletes the directory 'path' (and its contents will be deleted recursively).
bool	delete_contents (const std::string &path)
	Deletes the contents of the directory 'path' (the directory will not be deleted).
void	get_directory_entries (const std::string &path, std::vector< std::string > &entries, bool recursive)
	Queries the entries of a directory (including subdirectories and files).
void	get_files (const std::string &path, std::vector< std::string > &files, bool recursive)
	Queries file entries of a directory 'path'.
void	get_sub_directories (const std::string &path, std::vector< std::string > &subs, bool recursive)
	Query subdirectory entries of a directory 'path'.
std::string	current_working_directory ()
	Query the current working directory.
bool	set_current_working_directory (const std::string &path)
	Set the current working directory.
std::string	home_directory ()
	Query the home path for the current user.
std::string	executable ()
	Query the name of this executable.
std::string	executable_directory ()
	Query the directory where the executable file is located.
bool	rename_file (const std::string &old_name, const std::string &new_name)
	Rename the file from 'old_name' to 'new_name'.
time_t	time_stamp (const std::string &path)
	Query the time stamp of a file or directory.
std::string	time_string (const std::string &path)
	Query the time stamp of a file or directory as a string.
std::ifstream::pos_type	file_size (const std::string &path)
	Query the size of the file.
std::string	parent_directory (const std::string &path)
	Query the parent path from full name of a file or directory (e.g., /a/b/c.Ext => /a/b)
std::string	extension (const std::string &path, bool lower=true)
	Query the file extension without dot (e.g., /a/b/c.Ext => Ext).
std::string	simple_name (const std::string &path)
	Gets file name without path but with extension (e.g, /a/b/c.Ext => c.Ext)
std::string	base_name (const std::string &path)
	Gets file name without path and last extension (e.g., c:/file.ext1.ext2 => file.ext1; /a/b/c.Ext => c).
std::string	name_less_extension (const std::string &path)
	Gets file path without last extension (e.g., /a/b/c.Ext => /a/b/c; file.ext1.ext2 => file.ext1).
std::string	name_less_all_extensions (const std::string &path)
	Gets file path without all extensions (e.g., /a/b/c.Ext => /a/b/c; file.ext1.ext2 => file).
std::string	replace_extension (std::string const &path, const std::string &ext)
	Replaces the extension of the given file with 'ext'. If the file name does not have an extension, the expected new extension is appended.
std::string	path_root (const std::string &path)
	Gets root part of a path ("/" or "C:"), or an empty string if none found.
bool	is_absolute_path (const std::string &path)
	Tests if path is absolute, as !get_path_root(path).empty(). .
std::string	relative_path (const std::string &from, const std::string &to)
	Compute the relative path from 'from' to 'to'.
std::string	absolute_path (const std::string &path)
	Converts to absolute path (i.e., removes .. and . from a path string).
std::string	convert_to_windows_style (const std::string &path)
	Converts the path to Windows style, i.e., forward slashes (/) to back slashes (\).
std::string	convert_to_unix_style (const std::string &path)
	Converts the path to Unix style, i.e., back slashes (\) to forward slashes (/).
std::string	convert_to_native_style (const std::string &path)
	Convert a path string such that it uses the current platform's path separators.
char	native_path_separator ()
	Gets the path separator of the current platform.
bool	is_native_style (const std::string &path)
	Checks sif the path contains only the current platform's path separators.
bool	copy_file (const std::string &original, const std::string &copy)
	Makes a copy of an existing file.
bool	file_contains_string (const std::string &filename, const std::string &str)
	Checks if a file contains string 'str'.
void	read_file_to_string (const std::string &filename, std::string &str)
	Reads the contents of a file into a string.
void	write_string_to_file (const std::string &str, const std::string &filename)
	Writes the string into a file.

Detailed Description

A very basic filesystem implementation.

Attention

Functions are not sufficiently tested.

Todo

[Liangliang] Comprehensive tests.

See also

ghc::filesystem - A C++17-like filesystem implementation for C++11/C++147/C++17 https://github.com/gulrak/filesystem/blob/master/include/ghc/filesystem.hpp

Function Documentation

absolute_path()

std::string absolute_path

(

const std::string &

path

)

Converts to absolute path (i.e., removes .. and . from a path string).

Parameters

path	The path string.

Returns

The absolute path.

base_name()

std::string base_name

(

const std::string &

path

)

Gets file name without path and last extension (e.g., c:/file.ext1.ext2 => file.ext1; /a/b/c.Ext => c).

Parameters

path	The full path of a file.

Returns

The string of the file name without path and last extension

convert_to_native_style()

std::string convert_to_native_style

(

const std::string &

path

)

Convert a path string such that it uses the current platform's path separators.

Parameters

path	The path string.

Returns

The path in native style.

See also

convert_to_windows_style(), convert_to_unix_style().

Examples

Tutorial_203_Viewer_wxWidgets/main.cpp.

convert_to_unix_style()

std::string convert_to_unix_style

(

const std::string &

path

)

Converts the path to Unix style, i.e., back slashes (\) to forward slashes (/).

Parameters

path	The path string.

Returns

The path in Unix style.

See also

convert_to_windows_style(), convert_to_native_style().

convert_to_windows_style()

std::string convert_to_windows_style

(

const std::string &

path

)

Converts the path to Windows style, i.e., forward slashes (/) to back slashes (\).

Parameters

path	The path string.

Returns

The path in Windows style.

See also

convert_to_unix_style(), convert_to_native_style().

copy_file()

bool copy_file	(	const std::string &	original,
		const std::string &	copy )

Makes a copy of an existing file.

Parameters

original	The file name of the original file.
copy	The file name of the copy

Returns

true on success.

create_directory()

bool create_directory

(

const std::string &

path

)

Creates a directory entitled 'path'.

Parameters

path	The full path of the directory to be created.

Returns

ture If the directory has been successfully created or already exists.

current_working_directory()

std::string current_working_directory

(

)

Query the current working directory.

Returns

The string representing the current working directory.

delete_contents()

bool delete_contents

(

const std::string &

path

)

Deletes the contents of the directory 'path' (the directory will not be deleted).

Parameters

path	The full path of a directory.

Returns

ture If the contents of directory have been successfully deleted or don't exist.

Todo

[Liangliang] Test if path should be absolute.

delete_directory()

bool delete_directory

(

const std::string &

path

)

Deletes the directory 'path' (and its contents will be deleted recursively).

Parameters

path	The full path of a directory.

Returns

ture If the directory has been successfully deleted or doesn't exist.

Todo

[Liangliang] Test if path should be absolute.

delete_file()

bool delete_file

(

const std::string &

path

)

Deletes the file 'path'.

Parameters

path	The full path of a file.

Returns

ture If the file has been successfully deleted or doesn't exist.

Todo

[Liangliang] Test if path should be absolute.

executable()

std::string executable

(

)

Query the name of this executable.

Returns

The string representing the full path of this executable, e.g., C:/a/b/c.exe

executable_directory()

std::string executable_directory

(

)

Query the directory where the executable file is located.

Returns

The string representing the directory in which the executable resides.

extension()

std::string extension	(	const std::string &	path,
		bool	lower = true )

Query the file extension without dot (e.g., /a/b/c.Ext => Ext).

Parameters

path	The full path of a file.
lower	Converts the string to lower case if true.

Returns

The string of the file extension.

Examples

Tutorial_203_Viewer_wxWidgets/main.cpp, Tutorial_204_Viewer_Qt/main.cpp, and Tutorial_308_TexturedMesh/main.cpp.

file_contains_string()

bool file_contains_string	(	const std::string &	filename,
		const std::string &	str )

Checks if a file contains string 'str'.

Parameters

filename	The string of the file name.
str	The string to be checked.

Returns

true if the file contains the string.

file_size()

std::ifstream::pos_type file_size

(

const std::string &

path

)

Query the size of the file.

Parameters

path	The full path of the file.

Returns

The size of the file (in bytes).

get_directory_entries()

void get_directory_entries	(	const std::string &	path,
		std::vector< std::string > &	entries,
		bool	recursive )

Queries the entries of a directory (including subdirectories and files).

Parameters

path	The full path of a directory.
entries	Return the entries of the directory. Result strings are simple names (i.e., without the path part, e.g., cat.png).
recursive	Performs the query recursively if true.

See also

get_files(), get_sub_directories().

get_files()

void get_files	(	const std::string &	path,
		std::vector< std::string > &	files,
		bool	recursive )

Queries file entries of a directory 'path'.

Parameters

path	The full path of a directory.
files	Return the file entries of 'path'. Result strings are simple names (i.e., without the 'path' part, e.g., cat.png).
recursive	Perform the query recursively if true.

See also

get_directory_entries(), get_sub_directories().

get_sub_directories()

void get_sub_directories	(	const std::string &	path,
		std::vector< std::string > &	subs,
		bool	recursive )

Query subdirectory entries of a directory 'path'.

Parameters

path	The full path of a directory.
subs	Return the subdirectory entries of 'path'. Result strings are only the names of the subdirectories (i.e., without the 'path' part).
recursive	Perform the query recursively if true.

See also

get_directory_entries(), get_files().

home_directory()

std::string home_directory

(

)

Query the home path for the current user.

Returns

The string representing the home directory of the current user.

is_absolute_path()

bool is_absolute_path

(

const std::string &

path

)

Tests if path is absolute, as !get_path_root(path).empty(). .

Parameters

path

The path.

Returns

true if the path is absolute. Tests if path is absolute, as !get_path_root(path).empty().

is_directory()

bool is_directory

(

const std::string &

path

)

Tests if 'path' is an existing directory.

Parameters

path	The full path of a directory.

Returns

ture If the directory 'path' exists.

Examples

Tutorial_204_Viewer_Qt/main.cpp.

is_file()

bool is_file

(

const std::string &

path

)

Tests if 'path' is an existing file.

Parameters

path	The full path of a file (including file extension).

Returns

ture If the file 'path' exists.

Examples

Tutorial_308_TexturedMesh/main.cpp.

is_native_style()

bool is_native_style

(

const std::string &

path

)

Checks sif the path contains only the current platform's path separators.

Returns

true if the path contains only the current platform's path separators.

name_less_all_extensions()

std::string name_less_all_extensions

(

const std::string &

path

)

Gets file path without all extensions (e.g., /a/b/c.Ext => /a/b/c; file.ext1.ext2 => file).

Parameters

path	The full path of a file.

Returns

The string of the file path without all extensions.

name_less_extension()

std::string name_less_extension

(

const std::string &

path

)

Gets file path without last extension (e.g., /a/b/c.Ext => /a/b/c; file.ext1.ext2 => file.ext1).

Parameters

path	The full path of a file.

Returns

The string of the file path without last extension.

native_path_separator()

char native_path_separator

(

)

Gets the path separator of the current platform.

Returns

The path separator in native style.

parent_directory()

std::string parent_directory

(

const std::string &

path

)

Query the parent path from full name of a file or directory (e.g., /a/b/c.Ext => /a/b)

Parameters

path	The full path of the file or directory.

Returns

The string of the parent path.

Examples

Tutorial_203_Viewer_wxWidgets/main.cpp.

path_root()

std::string path_root

(

const std::string &

path

)

Gets root part of a path ("/" or "C:"), or an empty string if none found.

Parameters

path

The path.

Returns

The string representing the root part of the path.

read_file_to_string()

void read_file_to_string	(	const std::string &	filename,
		std::string &	str )

Reads the contents of a file into a string.

Parameters

filename	The string of the file name.
str	The destination string.

relative_path()

std::string relative_path	(	const std::string &	from,
		const std::string &	to )

Compute the relative path from 'from' to 'to'.

Parameters

from	The 'from' directory.
to	The 'to' directory.

Returns

If 'to' is in a subdirectory of 'from' then this function returns the subpath, otherwise it just returns the file name.

Attention

The function does not automatically resolve paths as the system does, so be careful to give canonical paths. However, the function interprets slashes ('/') and backslashes ('\') as they were equal.

rename_file()

bool rename_file	(	const std::string &	old_name,
		const std::string &	new_name )

Rename the file from 'old_name' to 'new_name'.

Parameters

old_name	The full path of the file to be renamed.
new_name	The full path of the file's new name.

Returns

true on success.

replace_extension()

std::string replace_extension	(	std::string const &	path,
		const std::string &	ext )

Replaces the extension of the given file with 'ext'. If the file name does not have an extension, the expected new extension is appended.

Parameters

path	The file name.
ext	The expected new extension.

Returns

The string of the new file name/

Examples

Tutorial_203_Viewer_wxWidgets/main.cpp, and Tutorial_204_Viewer_Qt/main.cpp.

set_current_working_directory()

bool set_current_working_directory

(

const std::string &

path

)

Set the current working directory.

Parameters

path	The string representing the new current working directory.

Returns

true on success.

simple_name()

std::string simple_name

(

const std::string &

path

)

Gets file name without path but with extension (e.g, /a/b/c.Ext => c.Ext)

Parameters

path	The full path of a file.

Returns

The string of the file name without path but with extension.

Examples

Tutorial_203_Viewer_wxWidgets/main.cpp, and Tutorial_204_Viewer_Qt/main.cpp.

time_stamp()

time_t time_stamp

(

const std::string &

path

)

Query the time stamp of a file or directory.

Parameters

path	The full path of the file or directory.

Returns

The time stamp.

time_string()

std::string time_string

(

const std::string &

path

)

Query the time stamp of a file or directory as a string.

Parameters

path	The full path of the file or directory.

Returns

The string of the time stamp.

write_string_to_file()

void write_string_to_file	(	const std::string &	str,
		const std::string &	filename )

Writes the string into a file.

Parameters

str	The string.
filename	The string of the file name.