datatools::ui::path Namespace Reference

Functions
const std::string &	root_path ()
const std::string &	home_interface_path ()
const std::string &	current_interface_path ()
const std::string &	current_parent_interface_path ()
char	sep ()
char	exec ()
std::string	remove_trailing_sep (const std::string &path_)
std::string	basename (const std::string &path)
	Return the basename of a command or interface path. More...
std::string	parent_path (const std::string &path)
	Return the parent interface path of a command or interface path. More...
bool	is_hidden (const std::string &name_)
	Check if a name is hidden. More...
bool	is_valid_name (const std::string &name_)
	Check if a name is valid. More...
bool	is_valid_path (const std::string &path_)
	Check if a path is valid. More...
bool	is_absolute_path (const std::string &path_)
	Check if a path is absolute. More...
bool	build_leaf_full_path (const std::string &parent_path_, const std::string &leaf_name_, std::string &full_leaf_path_)
	Build the full path of a leaf with respect to its parent path. More...
bool	is_child_of (const std::string &child_candidate_, const std::string &parent_path_)
	Check if an absolute path if a child of another absolute path. More...
std::string	build_path (const std::list< std::string > &segments_)
	Return the parent interface path of a command or interface path. More...

Function Documentation

basename()

std::string datatools::ui::path::basename

(

const std::string &

path

)

Return the basename of a command or interface path.

build_leaf_full_path()

bool datatools::ui::path::build_leaf_full_path	(	const std::string &	parent_path_,
		const std::string &	leaf_name_,
		std::string &	full_leaf_path_
	)

Build the full path of a leaf with respect to its parent path.

build_path()

std::string datatools::ui::path::build_path

(

const std::list< std::string > &

segments_

)

Return the parent interface path of a command or interface path.

current_interface_path()

const std::string& datatools::ui::path::current_interface_path

(

)

current_parent_interface_path()

const std::string& datatools::ui::path::current_parent_interface_path

(

)

exec()

char datatools::ui::path::exec

(

)

home_interface_path()

const std::string& datatools::ui::path::home_interface_path

(

)

is_absolute_path()

bool datatools::ui::path::is_absolute_path

(

const std::string &

path_

)

Check if a path is absolute.

is_child_of()

bool datatools::ui::path::is_child_of	(	const std::string &	child_candidate_,
		const std::string &	parent_path_
	)

Check if an absolute path if a child of another absolute path.

is_hidden()

bool datatools::ui::path::is_hidden

(

const std::string &

name_

)

Check if a name is hidden.

is_valid_name()

bool datatools::ui::path::is_valid_name

(

const std::string &

name_

)

Check if a name is valid.

is_valid_path()

bool datatools::ui::path::is_valid_path

(

const std::string &

path_

)

Check if a path is valid.

parent_path()

std::string datatools::ui::path::parent_path

(

const std::string &

path

)

Return the parent interface path of a command or interface path.

remove_trailing_sep()

std::string datatools::ui::path::remove_trailing_sep

(

const std::string &

path_

)

Remove trailing '/' character for an interface path

Examples: Path "" returns "" Path "/" returns "/" Path "foo" returns "foo" Path "/foo/bar" returns "/foo/bar" Path "/foo/bar/" returns "/foo/bar"

root_path()

const std::string& datatools::ui::path::root_path

(

)

sep()

char datatools::ui::path::sep

(

)