cpplocate::utils Namespace Reference

Functions
CPPLOCATE_API void	replace (std::string &str, const std::string &original, const std::string &substitute)
CPPLOCATE_API void	trim (std::string &str)
CPPLOCATE_API std::string	trimPath (const std::string &str)
CPPLOCATE_API std::string	trimPath (std::string &&str)
CPPLOCATE_API std::string	unifiedPath (const std::string &path)
CPPLOCATE_API std::string	unifiedPath (std::string &&path)
CPPLOCATE_API std::string	getDirectoryPath (const std::string &fullpath)
CPPLOCATE_API size_t	posAfterString (const std::string &str, const std::string &substr)
CPPLOCATE_API std::string	getSystemBasePath (const std::string &path)
CPPLOCATE_API void	split (const std::string &str, char delim, std::vector< std::string > &values)
CPPLOCATE_API std::string	join (const std::vector< std::string > &values, const std::string &delim)
CPPLOCATE_API void	getPaths (const std::string &str, std::vector< std::string > &values)
CPPLOCATE_API std::string	getEnv (const std::string &name)
CPPLOCATE_API bool	fileExists (const std::string &path)
CPPLOCATE_API bool	loadModule (const std::string &directory, const std::string &name, ModuleInfo &info)

Function Documentation

CPPLOCATE_API void cpplocate::utils::replace	(	std::string &	str,
		const std::string &	original,
		const std::string &	substitute
	)

Replace all occurences of a substring in string.

Parameters

[in,out]	str	String
[in]	original	Original string
[in]	substitute	Substitute string

CPPLOCATE_API void cpplocate::utils::trim

(

std::string &

str

)

Remove spaces at the beginning and the end of a string.

Parameters

[in,out]

str

String

CPPLOCATE_API std::string cpplocate::utils::trimPath

(

const std::string &

str

)

Remove spaces and trailing slash/backslash from path.

Parameters

[in]

path

Path

Returns

Trimmed path

CPPLOCATE_API std::string cpplocate::utils::trimPath

(

std::string &&

str

)

Remove spaces and trailing slash/backslash from path.

Parameters

[in]

path

Path

Returns

Trimmed path

CPPLOCATE_API std::string cpplocate::utils::unifiedPath

(

const std::string &

path

)

Convert path into unified form (replace '\' with '/')

Parameters

[in]

path

Path

Returns

Path with forward slashes

CPPLOCATE_API std::string cpplocate::utils::unifiedPath

(

std::string &&

path

)

Convert path into unified form (replace '\' with '/')

Parameters

[in]

path

Path

Returns

Path with forward slashes

CPPLOCATE_API std::string cpplocate::utils::getDirectoryPath

(

const std::string &

fullpath

)

Cut away filename portion of a path, get path to directory.

Parameters

[in]

fullpath

Path (e.g., '/path/to/file.txt')

Returns

Directory path (e.g., '/path/to')

CPPLOCATE_API size_t cpplocate::utils::posAfterString	(	const std::string &	str,
		const std::string &	substr
	)

Get position right after given substring (searched from right to left)

Parameters

[in]	str	Full string
[in]	substr	Substring to search for

Returns

Position after substring if substring was found, else string::npos

CPPLOCATE_API std::string cpplocate::utils::getSystemBasePath

(

const std::string &

path

)

Get system base path for path to library or executable.

Parameters

[in]

path

Path to library or executable (e.g., '/usr/bin/myapp')

Returns

System path path (e.g., '/usr')

Remarks

This function returns the base path if the given file is a system path. Otherwise, it returns an empty string.

Examples: '/usr/bin/myapp' -> '/usr' '/usr/local/bin/myapp' -> '/usr/local' '/usr/lib/mylib.so' -> '/usr' '/usr/lib64/mylib.so' -> '/usr' '/usr/local/lib64/mylib.so' -> '/usr/local' '/crosscompile/armv4/usr/lib/mylib.so.2' -> '/crosscompile/armv4/usr'

CPPLOCATE_API void cpplocate::utils::split	(	const std::string &	str,
		char	delim,
		std::vector< std::string > &	values
	)

Split string into array of strings.

Parameters

[in]	str	Input string
[in]	delim	Delimiter used to split the string
[out]	values	Output vector

CPPLOCATE_API std::string cpplocate::utils::join	(	const std::vector< std::string > &	values,
		const std::string &	delim
	)

Join array of strings into a single string.

Parameters

[out]	values	Input vector
[in]	delim	Delimiter used to join the string

Returns

Joined string

CPPLOCATE_API void cpplocate::utils::getPaths	(	const std::string &	str,
		std::vector< std::string > &	values
	)

Split list of paths separated by : or ; into list of paths.

Parameters

[in]	paths	Input string
[out]	values	Output vector

Remarks

On windows, the separator ';' is used, ':' on all other systems

CPPLOCATE_API std::string cpplocate::utils::getEnv

(

const std::string &

name

)

Get value of environment variable.

Parameters

[in]

name

Name of environment variable

Returns

Value of the environment variable

CPPLOCATE_API bool cpplocate::utils::fileExists

(

const std::string &

path

)

Check if file or directory exists.

Parameters

[in]

path

Path to file or directory

Returns

'true' if it exists, else 'false'

CPPLOCATE_API bool cpplocate::utils::loadModule	(	const std::string &	directory,
		const std::string &	name,
		ModuleInfo &	info
	)

Load module information file.

Parameters

[in]	directory	Path to directory
[in]	name	Module name
[out]	info	Module information

Returns

'true' if module could be loaded successfully, else 'false'

Remarks

The filename is constructed as <directory>/<name>.modinfo