#include <nglobaldirs.h>
Static Public Member Functions | |
static std::string | home () |
Returns Regina's primary home directory on the system. | |
static std::string | pythonModule () |
Returns the directory in which Regina's python module is installed. | |
static std::string | pythonLibs () |
Returns the directory in which optional "helper" Python libraries are installed. | |
static std::string | examples () |
Returns the directory in which example data files and census data files are installed. | |
static std::string | engineDocs () |
Returns the directory in which API documentation for Regina's calculation engine is installed. |
These routines are only useful with a normal installation of Regina. Specifically, they return the relevant directories as they should be according to the arguments given to the configure script at build time. If Regina is being run directly out of the source tree, or if files were moved around after Regina was installed, then these directories might well not exist.
It is possible that, in future versions of Regina, these routines will support more interesting scenarios, such as running out of the source tree or moving ready-made "application bundles" around the system.
static std::string regina::NGlobalDirs::engineDocs | ( | ) | [static] |
Returns the directory in which API documentation for Regina's calculation engine is installed.
static std::string regina::NGlobalDirs::examples | ( | ) | [static] |
Returns the directory in which example data files and census data files are installed.
static std::string regina::NGlobalDirs::home | ( | ) | [static] |
Returns Regina's primary home directory on the system.
This directory should contains subdirectories scripts/, icons/, examples/ and so on.
static std::string regina::NGlobalDirs::pythonLibs | ( | ) | [static] |
Returns the directory in which optional "helper" Python libraries are installed.
These libraries are not a formal part of Regina, but can be made to load automatically as extra user libraries through Regina's python settings.
static std::string regina::NGlobalDirs::pythonModule | ( | ) | [static] |
Returns the directory in which Regina's python module is installed.