Core class specifies the basic static information for the CamiTK API. More...

#include <Core.h>

Collaboration diagram for camitk::Core:

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 Returns true if running in Debug, elsewhere false for Release build.
static const bool	isDebugBuild ()

Static Public Attributes
CamiTK Version variables set at configure time
complete version string
static const char *	version = "CamiTK 5.0.2"

static const char *	shortVersion = "camitk-5.0"
	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 environement choice (it could be lib/ or lib64/ on Linux). More...

Static Private Member Functions
static const QStringList	getExtensionDirectories (QString extensionType)
	Used by getInstallDirectories to determine the list of extension repositories This method check both `Core::libDir` and `lib/` (if different) subdirectories in order to take multiarch into account. More...

Detailed Description

Core class specifies the basic static information for the CamiTK API.

Extensions can only be in three different places:

CAMITK_DIR (where the libcamitkcore is)
user config directory
current wording directory

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:

extensions build during CamiTK core compilation (which lands in CMAKE_INSTALL_LIBDIR, and might be as complex as "lib/x86_64-linux-gnu", i.e., include a subdirectory)
extensions build by CEP outside CamiTK Community Edition (which will most certainly/by default be "lib/")

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:

repositories should be looked for either in Core::libDir or lib/
the case when Core::libDir is equal to lib/ must be taken into account to avoid duplicates

Member Function Documentation

◆ getActionDirectories()

const QStringList camitk::Core::getActionDirectories ( )

static

get all the action directories.

It gets all the valid directories where actions are installed, and insert them in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

◆ getBugReport()

const QString camitk::Core::getBugReport ( )

static

get a well formed bug report with all necessary information

Referenced by main(), and GenerateBugReportProcess::run().

Here is the caller graph for this function:

◆ getComponentDirectories()

const QStringList camitk::Core::getComponentDirectories ( )

static

get all the component directories.

It gets all the valid directories where components are installed, and insert them in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

Referenced by camitk::Application::open(), camitk::Application::openDirectory(), and camitk::Application::save().

Here is the caller graph for this function:

◆ getConfig()

const QString camitk::Core::getConfig ( )

static

get more information about installation, etc...

Referenced by main().

Here is the caller graph for this function:

◆ getCurrentWorkingDir()

const QString camitk::Core::getCurrentWorkingDir ( )

static

get the current working directory (during dev, this should be the build directory, which is an installation directory)

Referenced by camitk::Application::saveHistoryAsSXML().

Here is the caller graph for this function:

◆ getExtensionDirectories()

const QStringList camitk::Core::getExtensionDirectories ( QString extensionType )

staticprivate

Used by getInstallDirectories to determine the list of extension repositories This method check both Core::libDir and lib/ (if different) subdirectories in order to take multiarch into account.

Parameters

extensionType the type of extensions ("actions", "components" or "viewers")

References getInstallDirectories(), and shortVersion.

Here is the call graph for this function:

◆ getGlobalInstallDir()

const QString camitk::Core::getGlobalInstallDir ( )

static

get the CAMITK_DIR (where camitk-config is installed)

References getUserInstallDir().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstallDirectories()

const QStringList camitk::Core::getInstallDirectories	(	QString	suffix,
		bool	exitOnError = `true`
	)

static

get all installation directories, suffixed by the given word.

All the returned Strings are unique valid directories, sorted in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

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.

Referenced by getExtensionDirectories().

Here is the caller graph for this function:

◆ getPaths()

const QString camitk::Core::getPaths ( )

static

get all important paths

Referenced by main().

Here is the caller graph for this function:

◆ getTestDataDir()

const QString camitk::Core::getTestDataDir ( )

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:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

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.

Returns: a null QString, checkable with isNull(), if no test data directory found

Referenced by camitk::Application::Application().

Here is the caller graph for this function:

◆ getUserInstallDir()

const QString camitk::Core::getUserInstallDir ( )

static

get the user config directory (this is the local installation directory)

Referenced by getGlobalInstallDir().

Here is the caller graph for this function:

◆ getViewerDirectories()

const QStringList camitk::Core::getViewerDirectories ( )

static

get all the viewers directories.

It gets all the valid directories where viewers are installed, and insert them in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

◆ isDebugBuild()

const bool camitk::Core::isDebugBuild ( )

static

Member Data Documentation

◆ debugPostfix

const char * camitk::Core::debugPostfix = "-debug"

static

debug postfix used on MSVC to distinguished between release and debug version

◆ libDir

const char * camitk::Core::libDir = "lib"

static

library folder set depending on the compiler and environement 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.

◆ shortVersion

const char * camitk::Core::shortVersion = "camitk-5.0"

static

short version string (all in lower case, without the patch number)

Referenced by getExtensionDirectories(), and main().

◆ soVersion

const char * camitk::Core::soVersion = "5"

static

version used for so name

◆ version

const char * camitk::Core::version = "CamiTK 5.0.2"

static

Referenced by main(), and usage().

The documentation for this class was generated from the following files:

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ getActionDirectories()

◆ getBugReport()

◆ getComponentDirectories()

◆ getConfig()

◆ getCurrentWorkingDir()

◆ getExtensionDirectories()

◆ getGlobalInstallDir()

◆ getInstallDirectories()

◆ getPaths()

◆ getTestDataDir()

◆ getUserInstallDir()

◆ getViewerDirectories()

◆ isDebugBuild()

Member Data Documentation

◆ debugPostfix

◆ libDir

◆ shortVersion

◆ soVersion

◆ version