stmi::libconfig::dl Namespace Reference

Functions
const char *	getVersion () noexcept
	The stmm-input-dl library version. More...
std::vector< std::string >	getDataDirPaths () noexcept
	The system config plug-in paths. More...
std::string	getUserDataDirPath () noexcept
	The user plug-in path. More...

Function Documentation

getDataDirPaths()

std::vector<std::string> stmi::libconfig::dl::getDataDirPaths ( )

noexcept

The system config plug-in paths.

The plugin file names within the paths must satisfy regex [0-9][0-9](.+)\.dlp. If they don't they are ignored. The (.+) captures the name of the plugin. The first two digits of the file name represent the rank and are used to order (ascending) the plugins. Of the files with the same plugin name, the one associated with the lowest rank value is loaded (the others are skipped).

The path can also contain a "disabled-dlps.txt" file which lists plugin names that should not be loaded.

Example paths: "/usr/local/etc/stmm-input-dl" or "/etc/stmm-input-dl".

Returns

The system plug-in directories.

getUserDataDirPath()

std::string stmi::libconfig::dl::getUserDataDirPath ( )

noexcept

The user plug-in path.

Currently this path can only contain a "disabled-dlps.txt" file, which lists additional plugin names that should not be loaded by this library.

Example path: "/home/myname/.local/etc/stmm-input-dl".

Returns

The user plug-in directory.

getVersion()

const char* stmi::libconfig::dl::getVersion ( )

noexcept

The stmm-input-dl library version.

Returns

The version string. Cannot be empty.