libqi  1.14
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Namespaces | Macros | Functions
path.hpp File Reference

find bin/lib/data/conf for the current application More...

#include <string>
#include <vector>
#include <qi/config.hpp>

Go to the source code of this file.

Namespaces

namespace  qi::path
 Set of tools to handle SDK layouts.
namespace  qi
 qi general namespace

Functions

QI_API std::string qi::path::sdkPrefix ()
 Return the default SDK prefix path.It's always a complete, native path.
QI_API std::vector< std::string > qi::path::detail::getSdkPrefixes ()
 Return the SDK prefixes list. It's always complete, native paths.
QI_API void qi::path::detail::addOptionalSdkPrefix (const char *prefix)
 Add a new SDK prefix to the list of searchable prefixes.
QI_API void qi::path::detail::clearOptionalSdkPrefix ()
 Reset the list of additional SDK prefixes.
QI_API std::string qi::path::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 qi::path::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 qi::path::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 qi::path::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 > qi::path::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 > qi::path::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 > qi::path::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 > qi::path::libPaths ()
 Get the list of directories used when searching for libraries.This is used by the qi::path::findLib() method.
QI_API std::string qi::path::userWritableDataPath (const std::string &applicationName, const std::string &filename)
 Get the writable data files path for users.
QI_API std::string qi::path::userWritableConfPath (const std::string &applicationName, const std::string &filename="")
 Get the writable configuration files path for users.

Detailed Description

find bin/lib/data/conf for the current application

Definition in file path.hpp.