Core class specifies the basic static information for the CamiTK API. More...
#include <Core.h>
Static Public Member Functions | |
runtime directory information | |
static const QStringList | getComponentDirectories () |
get all the component directories. More... | |
static const QStringList | getActionDirectories () |
get all the action directories. More... | |
static const QStringList | getViewerDirectories () |
get all the viewers directories. More... | |
static const QString | getTestDataDir () |
Get a valid camitk test data directory name. More... | |
static const QStringList | getInstallDirectories (QString suffix, bool exitOnError=true) |
get all installation directories, suffixed by the given word. More... | |
static const QString | getConfig () |
get more information about installation, etc... More... | |
static const QString | getPaths () |
get all important paths More... | |
static const QString | getGlobalInstallDir () |
get the CAMITK_DIR (where camitk-config is installed) More... | |
static const QString | getUserInstallDir () |
get the user config directory (this is the local installation directory) More... | |
static const QString | getCurrentWorkingDir () |
get the current working directory (during dev, this should be the build directory, which is an installation directory) More... | |
static const QString | getBugReport () |
get a well formed bug report with all necessary information More... | |
runtime build information | |
get the type of build we are running, Debug or Release
| |
static const bool | isDebugBuild () |
Static Public Attributes | |
CamiTK Version variables set at configure time | |
complete version string | |
static const char * | version = "CamiTK 5.2.0" |
static const char * | shortVersion = "camitk-5.2" |
short version string (all in lower case, without the patch number) More... | |
static const char * | soVersion = "5" |
version used for so name More... | |
static const char * | debugPostfix = "-debug" |
debug postfix used on MSVC to distinguished between release and debug version More... | |
static const char * | libDir = "lib" |
library folder set depending on the compiler and environment choice (it could be lib/ or lib64/ on Linux). More... | |
Core class specifies the basic static information for the CamiTK API.
Extensions can only be in three different places:
Taking into account multiarch is difficult as some compiler/OS define CMAKE_INSTALL_LIBDIR to different values ("lib", "lib64" or even "lib/x86_64-linux-gnu" or more complicated paths). This value sometimes depends on where CMAKE_INSTALL_PATH points to (see CMake GNUInstallDirs module). For instance on debian, if CMAKE_INSTALL_PATH is equals to "/usr" then CMAKE_INSTALL_LIBDIR is set to "lib/ARCH", but if CMAKE_INSTALL_PATH is anything else, it is just set to "lib". The Core::libDir
variable is defined when CamiTK core is compiled (see CamiTKVersion.h.in
), but the CamiTK repositories are required also when a CamiTK application is launched.
The difficulty therefore arises as CamiTK has to load all type of extensions in all type of repositories and this must include:
Note that "lib/" was the only possible value of CMAKE_INSTALL_LIBDIR before multiarch was taken into account in CamiTK 5.0.
To take into account both situations, that result in a multitude of possible directories, it was decided that:
Core::libDir
or lib/
Core::libDir
is equal to lib/
must be taken into account to avoid duplicates
|
static |
get all the action directories.
It gets all the valid directories where actions are installed, and insert them in this particular order:
Referenced by camitk::ExtensionManager::autoload(), and getPaths().
|
static |
get a well formed bug report with all necessary information
References getConfig().
Referenced by main(), and GenerateBugReportProcess::run().
|
static |
get all the component directories.
It gets all the valid directories where components are installed, and insert them in this particular order:
Referenced by camitk::ExtensionManager::autoload(), getPaths(), camitk::Application::open(), camitk::Application::openDirectory(), and camitk::Application::save().
|
static |
get more information about installation, etc...
References a, camitk::ExtensionManager::getActionExtensionsList(), camitk::ActionExtension::getActions(), camitk::ExtensionManager::getComponentExtensionsList(), getCurrentWorkingDir(), camitk::ExtensionManager::getDataDirectoryComponentsList(), camitk::ComponentExtension::getFileExtensions(), getGlobalInstallDir(), camitk::ExtensionManager::getInstallationString(), camitk::ActionExtension::getLocation(), camitk::ComponentExtension::getLocation(), camitk::ViewerExtension::getLocation(), camitk::ComponentExtension::getName(), camitk::ActionExtension::getName(), camitk::ViewerExtension::getName(), getPaths(), getUserInstallDir(), camitk::ExtensionManager::getViewerExtensionsList(), and camitk::ViewerExtension::getViewers().
Referenced by getBugReport(), and main().
|
static |
get the current working directory (during dev, this should be the build directory, which is an installation directory)
Referenced by getConfig(), getInstallDirectories(), getPaths(), and camitk::Application::saveHistoryAsSXML().
|
static |
get the CAMITK_DIR (where camitk-config is installed)
References camitk::Application::getName(), and getUserInstallDir().
Referenced by getConfig(), getInstallDirectories(), getPaths(), camitk::ExtensionManager::loadExtension(), and main().
|
static |
get all installation directories, suffixed by the given word.
All the returned Strings are unique valid directories, sorted in this particular order:
It uses getExtensionDirectories() to take multiarch into account
If no directory is available and exitOnError is true, the application exits. There are situation (namely for checking testdata dir) where it not mandatory to find a directory. In this case, exitOnError should be set to false so that the application does not exit.
References CAMITK_ERROR_ALT, getCurrentWorkingDir(), getGlobalInstallDir(), and getUserInstallDir().
Referenced by getTestDataDir().
|
static |
get all important paths
References getActionDirectories(), getComponentDirectories(), getCurrentWorkingDir(), getGlobalInstallDir(), getTestDataDir(), getUserInstallDir(), getViewerDirectories(), isDebugBuild(), shortVersion, soVersion, and version.
Referenced by getConfig(), and main().
|
static |
Get a valid camitk test data directory name.
It returns the first valid test data directory that is found. Checking is done in this particular order:
If none of this three directories is valid, return user's home directory.
A test data directory is valid if it exists and contains a least one file.
References getInstallDirectories(), and shortVersion.
Referenced by camitk::Application::Application(), and getPaths().
|
static |
get the user config directory (this is the local installation directory)
References camitk::Application::getSettings().
Referenced by getConfig(), getGlobalInstallDir(), getInstallDirectories(), and getPaths().
|
static |
get all the viewers directories.
It gets all the valid directories where viewers are installed, and insert them in this particular order:
Referenced by camitk::ExtensionManager::autoload(), and getPaths().
|
static |
|
static |
debug postfix used on MSVC to distinguished between release and debug version
|
static |
library folder set depending on the compiler and environment choice (it could be lib/ or lib64/ on Linux).
libDir value is set directly to the value of CMAKE_INSTALL_LIBDIR.
Although it can not be called a version variable per se, it is required for the extension manager to find the available extensions.
Referenced by camitk::ExtensionManager::getInstallationString(), and camitk::ExtensionManager::loadExtension().
|
static |
short version string (all in lower case, without the patch number)
Referenced by getPaths(), getTestDataDir(), camitk::ExtensionManager::loadExtension(), and main().
|
static |
version used for so name
Referenced by getPaths().
|
static |
Referenced by getPaths(), main(), camitk::MainWindow::redirectToConsole(), and usage().