Elements::Kernel::Path Namespace Reference

Typedefs
using	Item = boost::filesystem::path

Enumerations
enum	Type {   Type::executable, Type::library, Type::python, Type::configuration,   Type::auxiliary }

Functions
ELEMENTS_API std::vector< Item >	getLocationsFromEnv (const std::string &path_variable, bool exist_only=false)
	function to get the locations from an environment variable More...
ELEMENTS_API std::vector< Item >	getLocations (const Type &path_type, bool exist_only=false)
	function to get the locations for the specific type More...
template<typename T , typename U >
ELEMENTS_API Item	getPathFromLocations (const T &file_name, const std::vector< U > &locations)
	retrieve path from a file name and a set of location to look into More...
template ELEMENTS_API Item	getPathFromLocations (const Item &file_name, const std::vector< Item > &locations)
template ELEMENTS_API Item	getPathFromLocations (const Item &file_name, const std::vector< std::string > &locations)
template ELEMENTS_API Item	getPathFromLocations (const std::string &file_name, const std::vector< Item > &locations)
template ELEMENTS_API Item	getPathFromLocations (const std::string &file_name, const std::vector< std::string > &locations)
template<typename T , typename U >
ELEMENTS_API std::vector< Item >	getAllPathFromLocations (const T &file_name, const std::vector< U > &locations)
	retrieve all the paths from a file name and a set of location to look into More...
template ELEMENTS_API std::vector< Item >	getAllPathFromLocations (const Item &file_name, const std::vector< Item > &locations)
template ELEMENTS_API std::vector< Item >	getAllPathFromLocations (const Item &file_name, const std::vector< std::string > &locations)
template ELEMENTS_API std::vector< Item >	getAllPathFromLocations (const std::string &file_name, const std::vector< Item > &locations)
template ELEMENTS_API std::vector< Item >	getAllPathFromLocations (const std::string &file_name, const std::vector< std::string > &locations)
template<typename T >
ELEMENTS_API Item	getPathFromEnvVariable (const T &file_name, const std::string &path_variable)
	retrieve path from a file name and an environment variable to look into More...
template ELEMENTS_API Item	getPathFromEnvVariable< Item > (const Item &file_name, const std::string &path_variable)
template ELEMENTS_API Item	getPathFromEnvVariable< std::string > (const std::string &file_name, const std::string &path_variable)
template<typename T >
ELEMENTS_API std::string	joinPath (const std::vector< T > &path_list)
	collate a vector of path into a string using PATH_SEP More...
template ELEMENTS_API std::string	joinPath (const std::vector< Item > &path_list)
template ELEMENTS_API std::string	joinPath (const std::vector< std::string > &path_list)
template<typename... Args>
ELEMENTS_API auto	join (Args &&... args) -> decltype(joinPath(std::forward< Args >(args)...))
	alias for the joinPath function More...
ELEMENTS_API std::vector< Item >	splitPath (const std::string &path_string)
	split a string into a vector of path using PATH_SEP More...
template<typename... Args>
ELEMENTS_API auto	split (Args &&... args) -> decltype(splitPath(std::forward< Args >(args)...))
	alias for the splitPath function More...
template<typename T , typename U >
ELEMENTS_API std::vector< Item >	multiPathAppend (const std::vector< T > &initial_locations, const std::vector< U > &suffixes)
	path join each suffix to each initial locations More...
template ELEMENTS_API std::vector< Item >	multiPathAppend (const std::vector< Item > &initial_locations, const std::vector< Item > &suffixes)
template ELEMENTS_API std::vector< Item >	multiPathAppend (const std::vector< Item > &initial_locations, const std::vector< std::string > &suffixes)
template ELEMENTS_API std::vector< Item >	multiPathAppend (const std::vector< std::string > &initial_locations, const std::vector< Item > &suffixes)
template ELEMENTS_API std::vector< Item >	multiPathAppend (const std::vector< std::string > &initial_locations, const std::vector< std::string > &suffixes)
template<typename T >
ELEMENTS_API std::vector< Item >	removeDuplicates (const std::vector< T > &path_list)
	remove duplicated paths keeping the order More...
template ELEMENTS_API std::vector< Item >	removeDuplicates (const std::vector< Item > &path_list)
template ELEMENTS_API std::vector< Item >	removeDuplicates (const std::vector< std::string > &path_list)
template Item	getPathFromEnvVariable< string > (const string &file_name, const string &path_variable)

Variables
const ELEMENTS_API std::string	PATH_SEP {":"}
	Separator of path entries. Usually ":" on Unix. More...
const ELEMENTS_API std::map< Type, const std::string >	VARIABLE
	map containing the name of the path variable for each type More...
const ELEMENTS_API std::map< Type, const std::vector< std::string > >	SUFFIXES
	map containing the default project installation suffixes for each variable More...
const ELEMENTS_API std::map< Type, const std::vector< std::string > >	DEFAULT_LOCATIONS
	map containing the default external locations for each variable More...
const ELEMENTS_API std::map< Type, const bool >	HAS_SUBLEVELS
	map containing the sub-level property of the path components More...

Typedef Documentation

Item

using Elements::Kernel::Path::Item = typedef boost::filesystem::path

Examples

ElementsKernel/tests/src/Configuration_test.cpp.

Definition at line 56 of file Path.h.

Enumeration Type Documentation

Type

enum Elements::Kernel::Path::Type

strong

Enumerator
executable
library
python
configuration
auxiliary

Definition at line 50 of file Path.h.

Function Documentation

getAllPathFromLocations() [1/4]

template vector< Item > Elements::Kernel::Path::getAllPathFromLocations	(	const Item &	file_name,
		const std::vector< Item > &	locations
	)

getAllPathFromLocations() [2/4]

template vector< Item > Elements::Kernel::Path::getAllPathFromLocations	(	const Item &	file_name,
		const std::vector< std::string > &	locations
	)

getAllPathFromLocations() [3/4]

template vector< Item > Elements::Kernel::Path::getAllPathFromLocations	(	const std::string &	file_name,
		const std::vector< Item > &	locations
	)

getAllPathFromLocations() [4/4]

template vector< Item > Elements::Kernel::Path::getAllPathFromLocations	(	const std::string &	file_name,
		const std::vector< std::string > &	locations
	)

getPathFromEnvVariable< Item >()

template Item Elements::Kernel::Path::getPathFromEnvVariable< Item >	(	const Item &	file_name,
		const std::string &	path_variable
	)

getPathFromEnvVariable< std::string >()

template ELEMENTS_API Item Elements::Kernel::Path::getPathFromEnvVariable< std::string >	(	const std::string &	file_name,
		const std::string &	path_variable
	)

getPathFromEnvVariable< string >()

template Item Elements::Kernel::Path::getPathFromEnvVariable< string >	(	const string &	file_name,
		const string &	path_variable
	)

getPathFromLocations() [1/4]

template Item Elements::Kernel::Path::getPathFromLocations	(	const Item &	file_name,
		const std::vector< Item > &	locations
	)

getPathFromLocations() [2/4]

template Item Elements::Kernel::Path::getPathFromLocations	(	const Item &	file_name,
		const std::vector< std::string > &	locations
	)

getPathFromLocations() [3/4]

template Item Elements::Kernel::Path::getPathFromLocations	(	const std::string &	file_name,
		const std::vector< Item > &	locations
	)

getPathFromLocations() [4/4]

template Item Elements::Kernel::Path::getPathFromLocations	(	const std::string &	file_name,
		const std::vector< std::string > &	locations
	)

joinPath() [1/2]

template string Elements::Kernel::Path::joinPath

(

const std::vector< Item > &

path_list

)

joinPath() [2/2]

template string Elements::Kernel::Path::joinPath

(

const std::vector< std::string > &

path_list

)

multiPathAppend() [1/4]

template vector< Item > Elements::Kernel::Path::multiPathAppend	(	const std::vector< Item > &	initial_locations,
		const std::vector< Item > &	suffixes
	)

multiPathAppend() [2/4]

template vector< Item > Elements::Kernel::Path::multiPathAppend	(	const std::vector< Item > &	initial_locations,
		const std::vector< std::string > &	suffixes
	)

multiPathAppend() [3/4]

template vector< Item > Elements::Kernel::Path::multiPathAppend	(	const std::vector< std::string > &	initial_locations,
		const std::vector< Item > &	suffixes
	)

multiPathAppend() [4/4]

template vector< Item > Elements::Kernel::Path::multiPathAppend	(	const std::vector< std::string > &	initial_locations,
		const std::vector< std::string > &	suffixes
	)

removeDuplicates() [1/2]

template vector< Item > Elements::Kernel::Path::removeDuplicates

(

const std::vector< Item > &

path_list

)

removeDuplicates() [2/2]

template vector< Item > Elements::Kernel::Path::removeDuplicates

(

const std::vector< std::string > &

path_list

)