libqi  1.14
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
qi::path Namespace Reference

Set of tools to handle SDK layouts. More...

Functions

QI_API std::string sdkPrefix ()
 Return the default SDK prefix path.It's always a complete, native path.
QI_API std::string findBin (const std::string &name)
 Look for a binary.This will search in all SDK prefixes for a file named 'name'. It will then add '.exe' suffix if needed.
QI_API std::string findLib (const std::string &name)
 Look for a library.This will search in all SDK prefixes for a file named 'name'. It will then add 'lib' prefix, and appropriated suffixes ('.dll' on windows, '.so' on linux, '.dylib' on mac).
QI_API std::string findConf (const std::string &applicationName, const std::string &filename)
 Look for a configuration file.The file is searched in a list of possible directories, the first match is returned.
QI_API std::string findData (const std::string &applicationName, const std::string &filename)
 Look for a data file.The file is search in a list of possible directories, the first match is returned. The list of paths is constructed like this:
QI_API std::vector< std::string > confPaths (const std::string &applicationName="")
 Get the list of directories used when searching for configuration files for the given application name.This is used by the qi::path::findConfigurationPath method.
QI_API std::vector< std::string > dataPaths (const std::string &applicationName="")
 Get the list of directories used when searching for data files for the given application name.This is used by the qi::path::findDataPath method.
QI_API std::vector< std::string > binPaths ()
 Get the list of directories used when searching for binaries.This is used by the qi::path::findBin() method.
QI_API std::vector< std::string > libPaths ()
 Get the list of directories used when searching for libraries.This is used by the qi::path::findLib() method.
QI_API std::string userWritableDataPath (const std::string &applicationName, const std::string &filename)
 Get the writable data files path for users.
QI_API std::string userWritableConfPath (const std::string &applicationName, const std::string &filename="")
 Get the writable configuration files path for users.

Detailed Description

Set of tools to handle SDK layouts.

Warning:
Every string MUST be encoded in UTF8. Every returned string are encoded in UTF-8.