Files | Functions | Variables
BasisSettings

Files

file  BasisConfigSettings.cmake
 Sets basic variables used in CMake package configuration.
 
file  BasisProject.cmake
 Sets basic information about a BASIS Project and calls basis_project().
 
file  BasisSettings.cmake
 Default project-independent settings.
 
file  ConfigSettings.cmake
 Sets variables used in CMake package configuration.
 
file  CTestCustom.cmake
 Custom testing configuration.
 
file  Depends.cmake
 Find additional dependencies.
 
file  ProjectSettings.cmake
 Default project-dependent settings.
 
file  Settings.cmake
 Non-default project settings.
 

Functions

macro basis_add_mcc_options ()
 Add global MATLAB Compiler (mcc) options to CMake cache. More...
 
macro basis_add_mex_options ()
 Add global MATLAB MEX-script options to CMake cache. More...
 

Variables

cmake BASIS_ALL_DOC
 Advanced non-cached variable to request build of documentation targets as part of ALL target. More...
 
cmake BASIS_BASH_LIBRARY_TARGET
 Name of library target which builds Bash modules in PROJECT_LIBRARY_DIR. More...
 
option BASIS_BUILD_ONLY = OFF
 Request configuration of software build only, skipping steps related to packaging and installation. More...
 
option BASIS_COMPILE_MATLAB = ON
 Enable/Disable compilation of MATLAB sources if the MATLAB Compiler is available. More...
 
option BASIS_COMPILE_SCRIPTS = OFF
 Enable compilation of scripts if supported by the language. More...
 
cmake BASIS_CONFIGURE_PUBLIC_HEADERS
 Whether BASIS should configure any public header file with the .in file name suffix. More...
 
option BASIS_DEBUG = OFF
 Request debugging messages from BASIS functions. More...
 
cmake BASIS_DOXYGEN_DOXYFILE
 Default Doxygen configuration. More...
 
cmake BASIS_EXPORT_DEFAULT
 Whether to export targets by default. More...
 
cmake BASIS_EXPORT_ENABLED
 Whether to create "<Package><ExportSuffix>.cmake" file so other projects can import the exported targets. More...
 
cmake BASIS_EXPORT_SUFFIX
 Suffix used for target exports file "<Package><ExportSuffix>.cmake". More...
 
cmake BASIS_GE_CONFIG
 Name of build configuration ("$<CONFIG>") generator expression. More...
 
cmake BASIS_IMPORT_TARGETS
 Enable/disable import of targets using the BASIS ImportTools. More...
 
cmake BASIS_INSTALL_PUBLIC_HEADERS_OF_CXX_UTILITIES
 Force installation of public header files of BASIS C++ utilities. More...
 
option BASIS_INSTALL_SITE_PACKAGES = OFF
 Enable the installation of scripted modules in site specific default directories. More...
 
cmake BASIS_JYTHON_LIBRARY_TARGET
 Name of library target which builds Jython modules in PROJECT_LIBRARY_DIR. More...
 
cmake BASIS_LANGUAGES
 List of programming languages explicitly supported by BASIS. More...
 
cmake BASIS_LIBRARY_COMPONENT
 Default component used for library targets when no component is specified. More...
 
cmake BASIS_MATLAB_LIBRARY_TARGET
 Name of library target which builds MATLAB modules in PROJECT_LIBRARY_DIR. More...
 
 BASIS_METADATA_LIST_SWITCH
 Names of project meta-data switches. More...
 
cmake BASIS_NAMESPACE_DELIMITER_BASH
 Namespace delimiter used in Bash. More...
 
cmake BASIS_NAMESPACE_DELIMITER_CMAKE
 Namespace delimiter used in CMake. More...
 
cmake BASIS_NAMESPACE_DELIMITER_CXX
 Namespace delimiter used in C++. More...
 
cmake BASIS_NAMESPACE_DELIMITER_JYTHON
 Namespace delimiter used in Jython. More...
 
cmake BASIS_NAMESPACE_DELIMITER_MATLAB
 Namespace delimiter used in MATLAB. More...
 
cmake BASIS_NAMESPACE_DELIMITER_PERL
 Namespace delimiter used in Perl. More...
 
cmake BASIS_NAMESPACE_DELIMITER_PYTHON
 Namespace delimiter used in Python. More...
 
cmake BASIS_PERL_LIBRARY_TARGET
 Name of library target which builds Perl modules in PROJECT_LIBRARY_DIR. More...
 
cmake BASIS_PYTHON_LIBRARY_TARGET
 Name of library target which builds Python modules in PROJECT_LIBRARY_DIR. More...
 
option BASIS_REGISTER = ON
 Enable/disable registration of installed package in CMake registry. More...
 
option BASIS_REVISION_INFO = ON
 Disable use of the revision information obtained from the revision control software such as Subversion or Git. More...
 
cmake BASIS_RUNTIME_COMPONENT
 Default component used for executables when no component is specified. More...
 
cmake BASIS_SCRIPT_EXECUTE_PROCESS
 Script used to execute a process in CMake script mode. More...
 
cmake BASIS_SPHINX_CONFIG
 Default Sphinx configuration. More...
 
cmake BASIS_SPHINX_HTML_THEME
 Default Sphinx theme. More...
 
option BASIS_SUPERBUILD_MODULES = OFF
 EXPERIMENTAL - Build project modules as separate external projects. More...
 
cmake BASIS_SUPPORT_SLICER_MODULES
 Whether basis_project_begin() should support the configuration of Slicer modules. More...
 
cmake BASIS_SVN_USERS_FILE
 File used by default as –authors file to svn2cl. More...
 
cmake BASIS_USE_FULLY_QUALIFIED_UIDS
 Whether BASIS shall use fully-qualified target UIDs. More...
 
cmake BASIS_UTILITIES
 Enable the automatic detection of the use of the BASIS utilities. More...
 
option BASIS_VERBOSE = OFF
 Default Sphinx theme options. More...
 
cmake BUILD_APPLICATIONS_DEFAULT
 Request build/installation of applications. More...
 
option BUILD_BASIS_UTILITIES_FOR_BASH = OFF
 Whether to always build the BASIS Bash utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_CXX = OFF
 Whether to always build the BASIS C++ utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_PERL = OFF
 Whether to always build the BASIS Perl utilities even if not required by any target. More...
 
option BUILD_BASIS_UTILITIES_FOR_PYTHON = OFF
 Whether to always build the BASIS Python utilities even if not required by any target. More...
 
option BUILD_DOCUMENTATION = OFF
 Request build/installation of documentation. More...
 
option BUILD_EXAMPLE = OFF
 Request build/installation of example. More...
 
string CMAKE_BUILD_TYPE
 
cmake CMAKE_BUILD_WITH_INSTALL_RPATH
 
cmake CMAKE_INSTALL_RPATH_USE_LINK_PATH
 
cmake CMAKE_SKIP_BUILD_RPATH
 
cmake CMAKE_SKIP_RPATH
 
cmake PROJECT_NAMESPACE_CMAKE
 CMake namespace of project. More...
 
cmake PROJECT_NAMESPACE_JAVA
 CMake variable of Java package name of project. More...
 
cmake PROJECT_NAMESPACE_JYTHON
 CMake variable of Jython package name of project. More...
 
cmake PROJECT_NAMESPACE_MATLAB
 CMake variable of MATLAB package name of project. More...
 
cmake PROJECT_NAMESPACE_PERL
 CMake variable of Perl package name of project. More...
 
cmake PROJECT_NAMESPACE_PYTHON
 CMake variable of Python package name of project. More...
 
cmake PROJECT_PACKAGE_CONFIG_PREFIX
 Prefix/name of CMake package configuration file. More...
 
cmake TOPLEVEL_PROJECT_NAMESPACE_CMAKE
 CMake namespace of top-level project. More...
 
cmake TOPLEVEL_PROJECT_PACKAGE_CONFIG_PREFIX
 Prefix/name of CMake package configuration file of top-level project. More...
 
cmake TOPLEVEL_PROJECT_PACKAGE_UID
 UID of package in CMake's user package registry. More...
 

Detailed Description

Function Documentation

§ basis_add_mcc_options()

macro basis_add_mcc_options ( )

Add global MATLAB Compiler (mcc) options to CMake cache.

MATLAB Compiler options:
BASIS_MCC_MATLAB_MODE Enable/Disable invocation of MATLAB Compiler in MATLAB mode.
BASIS_MCC_FLAGS Compile flags used to build MATLAB Compiler targets.
BASIS_MCC_TIMEOUT Timeout for building MATLAB Compiler targets.
BASIS_MCC_RETRY_ATTEMPTS Maximum number of retries on MATLAB Compiler license checkout.
BASIS_MCC_RETRY_DELAY Delay between retries to build MATLAB Compiler compiled targets on license checkout errors.
Returns
Nothing.

§ basis_add_mex_options()

macro basis_add_mex_options ( )

Add global MATLAB MEX-script options to CMake cache.

MATLAB MEX-script options:
BASIS_MEX_TIMEOUT Timeout for MEX script execution.
BASIS_MEX_FLAGS Compile flags used to build MEX-files using the MEX script.
Returns
Nothing.

Variable Documentation

§ BASIS_ALL_DOC

cmake BASIS_ALL_DOC

Advanced non-cached variable to request build of documentation targets as part of ALL target.

Definition at line 800 of file BasisSettings.cmake.

§ BASIS_BASH_LIBRARY_TARGET

cmake BASIS_BASH_LIBRARY_TARGET

Name of library target which builds Bash modules in PROJECT_LIBRARY_DIR.

This variable is used by basis_configure_script_libraries() which is called by basis_project_begin() to add a library target of the given name for the build of the Bash modules found in the PROJECT_LIBRARY_DIR.

Note
The given target name is argument to the basis_add_library() command. Overwrite default value in Settings.cmake file of project if desired.

Definition at line 793 of file BasisSettings.cmake.

§ BASIS_BUILD_ONLY

option BASIS_BUILD_ONLY = OFF

Request configuration of software build only, skipping steps related to packaging and installation.

Definition at line 833 of file BasisSettings.cmake.

§ BASIS_COMPILE_MATLAB

option BASIS_COMPILE_MATLAB = ON

Enable/Disable compilation of MATLAB sources if the MATLAB Compiler is available.

Definition at line 42 of file MatlabTools.cmake.

§ BASIS_COMPILE_SCRIPTS

option BASIS_COMPILE_SCRIPTS = OFF

Enable compilation of scripts if supported by the language.

In particular, Python modules are compiled if this option is enabled and only the compiled modules are installed.

See also
basis_add_script_target()

Definition at line 592 of file BasisSettings.cmake.

§ BASIS_CONFIGURE_PUBLIC_HEADERS

cmake BASIS_CONFIGURE_PUBLIC_HEADERS

Whether BASIS should configure any public header file with the .in file name suffix.

If a project does not contain any such public header file (typically one named config.h.in), this option can be set to FALSE in the "config/Settings.cmake" file of the project. For better performance, if only one header file needs to be configured, this can be done manually by adding a corresponding configure_file() call to the root CMakeLists.txt file right after basis_project_begin(). The configured files should be written to the BINARY_INCLUDE_DIR which is located in the build tree of the project.

Definition at line 661 of file BasisSettings.cmake.

§ BASIS_DEBUG

option BASIS_DEBUG = OFF

Request debugging messages from BASIS functions.

Definition at line 829 of file BasisSettings.cmake.

§ BASIS_DOXYGEN_DOXYFILE

cmake BASIS_DOXYGEN_DOXYFILE

Default Doxygen configuration.

Definition at line 803 of file BasisSettings.cmake.

§ BASIS_EXPORT_DEFAULT

cmake BASIS_EXPORT_DEFAULT

Whether to export targets by default.

This global variable specifies the default for the export of build targets if the EXPORT or NO_EXPORT options of the basis_add_executable and basis_add_library commands are not given.

Definition at line 563 of file BasisSettings.cmake.

§ BASIS_EXPORT_ENABLED

cmake BASIS_EXPORT_ENABLED

Whether to create "<Package><ExportSuffix>.cmake" file so other projects can import the exported targets.

See also
GenerateConfig.cmake, ExportTools.cmake, http://www.cmake.org/cmake/help/v2.8.12/cmake.html#command:export

Definition at line 571 of file BasisSettings.cmake.

§ BASIS_EXPORT_SUFFIX

cmake BASIS_EXPORT_SUFFIX

Suffix used for target exports file "<Package><ExportSuffix>.cmake".

Definition at line 566 of file BasisSettings.cmake.

§ BASIS_GE_CONFIG

cmake BASIS_GE_CONFIG

Name of build configuration ("$<CONFIG>") generator expression.

Definition at line 45 of file BasisSettings.cmake.

§ BASIS_IMPORT_TARGETS

cmake BASIS_IMPORT_TARGETS

Enable/disable import of targets using the BASIS ImportTools.

Issues/limitations of CMake's "function" command complicate the definition of a custom set_target_properties function which can be used to collect "global" information about targets imported from the CMake package configuration of project dependencies. The workaround in the custom set_target_properties function defined in the ImportTools.cmake is extremely inefficient and slows down the configuration step a lot (cf. https://github.com/cmake-basis/BASIS/issues/494).

The only need for collecting this information for all (executable) targets imported from dependencies is for generating the executable target info table for the BASIS Utilities (cf. UtilitiesTools.cmake). Hence, when these are not used, the ImportTools.cmake are not needed. Further, when a project does not consist of modules, the imported targets are available in the scope of the project.

A project has to set BASIS_IMPORT_TARGETS to TRUE in its root CMakeLists.txt file before basis_project_begin() or basis_project_impl(), respectively, which in turn include the BASISUse.cmake file. This file includes the BASIS ImportTools module when BASIS_IMPORT_TARGETS is true.

Definition at line 703 of file BasisSettings.cmake.

§ BASIS_INSTALL_PUBLIC_HEADERS_OF_CXX_UTILITIES

cmake BASIS_INSTALL_PUBLIC_HEADERS_OF_CXX_UTILITIES

Force installation of public header files of BASIS C++ utilities.

If this variable is set to FALSE, each header file in the PROJECT_INCLUDE_DIR is scanned for an include statement which includes one of the public header files of the BASIS C++ utilities. If such include statement was found in a public header file of the project, the public header files of the BASIS C++ utilities are also installed as the project's public header files depend on them. You can set this variable to TRUE in the Settings.cmake file of your project to force the installation of the public header files of the project-specific BASIS C++ utilities.

See also
basis_install_public_headers()

Definition at line 651 of file BasisSettings.cmake.

§ BASIS_INSTALL_SITE_PACKAGES

option BASIS_INSTALL_SITE_PACKAGES = OFF

Enable the installation of scripted modules in site specific default directories.

If this option is ON, scripted modules such as Python and Perl modules, in particular, are installed in the default installation directories for site packages of the respective interpreter. This means that these modules may be installed outside the installation root directory as specified by the CMAKE_INSTALL_PREFIX. When this option is set to OFF, all modules are installed in subdirectories of the CMAKE_INSTALL_PREFIX. These directories may have to be added to the search path for modules manually as they might not be in the default search path of the respective interpreter.

The installation directories for public modules which are intended for external use can further be set using the -D option of CMake or be modified by editing the respective advanced CMake cache variables named INSTALL_<LANGgt;_SITE_DIR.

Note
Even though it is more convenient for the user of a package to have the modules being installed in the default directories, this option is set to OFF by default. The reasons are that it is in first place expected that the installation will copy files only to directories within the CMAKE_INSTALL_PREFIX. Moreover, it is not guaranteed that the user has write permissions for the default site packages directories. Last but not least, when installing public modules located in the PROJECT_LIBRARY_DIR source directory, BASIS does not set a default module PREFIX which reduces the risk of overwriting existing modules of other packages. If the developer of a BASIS package was not thorough enough and did not follow the guidelines, setting this option to ON has the potential risk of overwriting other packages' modules. Therefore, modules are only installed in system default locations if explicitly requested.

Definition at line 621 of file BasisSettings.cmake.

§ BASIS_JYTHON_LIBRARY_TARGET

cmake BASIS_JYTHON_LIBRARY_TARGET

Name of library target which builds Jython modules in PROJECT_LIBRARY_DIR.

This variable is used by basis_configure_script_libraries() which is called by basis_project_begin() to add a library target of the given name for the build of the Jython modules found in the PROJECT_LIBRARY_DIR.

Note
The given target name is argument to the basis_add_library() command. Overwrite default value in Settings.cmake file of project if desired.

Definition at line 763 of file BasisSettings.cmake.

§ BASIS_LANGUAGES

cmake BASIS_LANGUAGES

List of programming languages explicitly supported by BASIS.

Todo:
Add full support for Java.

Definition at line 712 of file BasisSettings.cmake.

§ BASIS_LIBRARY_COMPONENT

cmake BASIS_LIBRARY_COMPONENT

Default component used for library targets when no component is specified.

The default component a library target and its auxiliary files are associated with if no component was specified, explicitly.

Definition at line 520 of file BasisSettings.cmake.

§ BASIS_MATLAB_LIBRARY_TARGET

cmake BASIS_MATLAB_LIBRARY_TARGET

Name of library target which builds MATLAB modules in PROJECT_LIBRARY_DIR.

This variable is used by basis_configure_script_libraries() which is called by basis_project_begin() to add a library target of the given name for the build of the MATLAB modules found in the PROJECT_LIBRARY_DIR.

Note
The given target name is argument to the basis_add_library() command. Overwrite default value in Settings.cmake file of project if desired.

Definition at line 783 of file BasisSettings.cmake.

§ BASIS_METADATA_LIST_SWITCH

BASIS_METADATA_LIST_SWITCH

Names of project meta-data switches.

Definition at line 92 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_BASH

cmake BASIS_NAMESPACE_DELIMITER_BASH

Namespace delimiter used in Bash.

Note
Bash itself has no concept of namespaces. This namespace delimiter is used by the import() function of the BASIS Utilities for Bash.
See also
BasisBashUtilities

Definition at line 739 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_CMAKE

cmake BASIS_NAMESPACE_DELIMITER_CMAKE

Namespace delimiter used in CMake.

Definition at line 722 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_CXX

cmake BASIS_NAMESPACE_DELIMITER_CXX

Namespace delimiter used in C++.

Definition at line 724 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_JYTHON

cmake BASIS_NAMESPACE_DELIMITER_JYTHON

Namespace delimiter used in Jython.

Definition at line 728 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_MATLAB

cmake BASIS_NAMESPACE_DELIMITER_MATLAB

Namespace delimiter used in MATLAB.

Definition at line 732 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_PERL

cmake BASIS_NAMESPACE_DELIMITER_PERL

Namespace delimiter used in Perl.

Definition at line 730 of file BasisSettings.cmake.

§ BASIS_NAMESPACE_DELIMITER_PYTHON

cmake BASIS_NAMESPACE_DELIMITER_PYTHON

Namespace delimiter used in Python.

Definition at line 726 of file BasisSettings.cmake.

§ BASIS_PERL_LIBRARY_TARGET

cmake BASIS_PERL_LIBRARY_TARGET

Name of library target which builds Perl modules in PROJECT_LIBRARY_DIR.

This variable is used by basis_configure_script_libraries() which is called by basis_project_begin() to add a library target of the given name for the build of the Perl modules found in the PROJECT_LIBRARY_DIR.

Note
The given target name is argument to the basis_add_library() command. Overwrite default value in Settings.cmake file of project if desired.

Definition at line 773 of file BasisSettings.cmake.

§ BASIS_PYTHON_LIBRARY_TARGET

cmake BASIS_PYTHON_LIBRARY_TARGET

Name of library target which builds Python modules in PROJECT_LIBRARY_DIR.

This variable is used by basis_configure_script_libraries() which is called by basis_project_begin() to add a library target of the given name for the build of the Python modules found in the PROJECT_LIBRARY_DIR.

Note
The given target name is argument to the basis_add_library() command. Overwrite default value in Settings.cmake file of project if desired.

Definition at line 753 of file BasisSettings.cmake.

§ BASIS_REGISTER

option BASIS_REGISTER = ON

Enable/disable registration of installed package in CMake registry.

Definition at line 672 of file BasisSettings.cmake.

§ BASIS_REVISION_INFO

option BASIS_REVISION_INFO = ON

Disable use of the revision information obtained from the revision control software such as Subversion or Git.

If this option is TRUE, the revision information is not included in the PROJECT_RELEASE information.

Definition at line 583 of file BasisSettings.cmake.

§ BASIS_RUNTIME_COMPONENT

cmake BASIS_RUNTIME_COMPONENT

Default component used for executables when no component is specified.

The default component an executable target and its auxiliary files are associated with if no component was specified, explicitly.

Definition at line 526 of file BasisSettings.cmake.

§ BASIS_SCRIPT_EXECUTE_PROCESS

cmake BASIS_SCRIPT_EXECUTE_PROCESS

Script used to execute a process in CMake script mode.

In order to be able to assign a timeout to the execution of a custom command and to add some error message parsing, this script is used by some build rules to actually perform the build step. See for example, the build of executables using the MATLAB Compiler.

Definition at line 630 of file BasisSettings.cmake.

§ BASIS_SPHINX_CONFIG

cmake BASIS_SPHINX_CONFIG

Default Sphinx configuration.

Definition at line 806 of file BasisSettings.cmake.

§ BASIS_SPHINX_HTML_THEME

cmake BASIS_SPHINX_HTML_THEME

Default Sphinx theme.

Definition at line 809 of file BasisSettings.cmake.

§ BASIS_SUPERBUILD_MODULES

option BASIS_SUPERBUILD_MODULES = OFF

EXPERIMENTAL - Build project modules as separate external projects.

This may improve performance of the initial configure step but comes with the caveats inherent to the superbuild approach as implemented by the ExternalProject module.

Definition at line 679 of file BasisSettings.cmake.

§ BASIS_SUPPORT_SLICER_MODULES

cmake BASIS_SUPPORT_SLICER_MODULES

Whether basis_project_begin() should support the configuration of Slicer modules.

This option must be set to TRUE in "config/Settings.cmake" of a project which either itself or one of its modules is a 3D Slicer Extension.

See also
http://www.slicer.org

Definition at line 669 of file BasisSettings.cmake.

§ BASIS_SVN_USERS_FILE

cmake BASIS_SVN_USERS_FILE

File used by default as –authors file to svn2cl.

This file lists all Subversion users at SBIA and is used by default for the mapping of Subversion user names to real names during the generation of changelogs.

Definition at line 637 of file BasisSettings.cmake.

§ BASIS_USE_FULLY_QUALIFIED_UIDS

cmake BASIS_USE_FULLY_QUALIFIED_UIDS

Whether BASIS shall use fully-qualified target UIDs.

If this option is OFF, the namespace of the top-level BASIS project is not prepended to the actual CMake build target names.

For example, instead of the fully-qualified target UID "@PROJECT_NAME_L@.target", the CMake target name will simply be "target". Only when the target is referenced from another project, the fully-qualified target UID is usually required.

Definition at line 514 of file BasisSettings.cmake.

§ BASIS_UTILITIES

cmake BASIS_UTILITIES

Enable the automatic detection of the use of the BASIS utilities.

If TRUE, the basis_add_executable() and basis_add_library() commands will try to automatically detect whether a given executable or library makes use of the BASIS utilities. If so, it configures the utilities for this project and adds a respective library build target as well as a link dependency on this target. This was the default until BASIS v3.1. Since this version, it is recommended to either use the USE_BASIS_UTILITIES option of basis_add_executable() and basis_add_library() or to add a link dependency on "basis" (recommended):

Definition at line 542 of file BasisSettings.cmake.

§ BASIS_VERBOSE

option BASIS_VERBOSE = OFF

Default Sphinx theme options.

Request verbose messages from BASIS functions.

Definition at line 825 of file BasisSettings.cmake.

§ BUILD_APPLICATIONS_DEFAULT

cmake BUILD_APPLICATIONS_DEFAULT

Request build/installation of applications.

Definition at line 51 of file ProjectSettings.cmake.

§ BUILD_BASIS_UTILITIES_FOR_BASH

option BUILD_BASIS_UTILITIES_FOR_BASH = OFF

Whether to always build the BASIS Bash utilities even if not required by any target.

Definition at line 551 of file BasisSettings.cmake.

§ BUILD_BASIS_UTILITIES_FOR_CXX

option BUILD_BASIS_UTILITIES_FOR_CXX = OFF

Whether to always build the BASIS C++ utilities even if not required by any target.

Definition at line 545 of file BasisSettings.cmake.

§ BUILD_BASIS_UTILITIES_FOR_PERL

option BUILD_BASIS_UTILITIES_FOR_PERL = OFF

Whether to always build the BASIS Perl utilities even if not required by any target.

Definition at line 549 of file BasisSettings.cmake.

§ BUILD_BASIS_UTILITIES_FOR_PYTHON

option BUILD_BASIS_UTILITIES_FOR_PYTHON = OFF

Whether to always build the BASIS Python utilities even if not required by any target.

Definition at line 547 of file BasisSettings.cmake.

§ BUILD_DOCUMENTATION

option BUILD_DOCUMENTATION = OFF

Request build/installation of documentation.

Definition at line 40 of file ProjectSettings.cmake.

§ BUILD_EXAMPLE

option BUILD_EXAMPLE = OFF

Request build/installation of example.

Definition at line 45 of file ProjectSettings.cmake.

§ CMAKE_BUILD_TYPE

string CMAKE_BUILD_TYPE
Initial value:
= "Release"
option BASIS_INSTALL_RPATH = ON

Definition at line 845 of file BasisSettings.cmake.

§ CMAKE_BUILD_WITH_INSTALL_RPATH

cmake CMAKE_BUILD_WITH_INSTALL_RPATH

Definition at line 873 of file BasisSettings.cmake.

§ CMAKE_INSTALL_RPATH_USE_LINK_PATH

cmake CMAKE_INSTALL_RPATH_USE_LINK_PATH

Definition at line 870 of file BasisSettings.cmake.

§ CMAKE_SKIP_BUILD_RPATH

cmake CMAKE_SKIP_BUILD_RPATH

Definition at line 872 of file BasisSettings.cmake.

§ CMAKE_SKIP_RPATH

cmake CMAKE_SKIP_RPATH

Definition at line 869 of file BasisSettings.cmake.

§ PROJECT_NAMESPACE_CMAKE

cmake PROJECT_NAMESPACE_CMAKE

CMake namespace of project.

The CMake namespace of a BASIS project is made up of its name in lower case only as well as the namespace the project belongs to, i.e., the namespace of the project this project is a module of.

See also
basis_make_target_uid()
basis_get_target_uid()
basis_make_test_uid()
basis_get_test_uid()

Definition at line 77 of file ProjectSettings.cmake.

§ PROJECT_NAMESPACE_JAVA

cmake PROJECT_NAMESPACE_JAVA

CMake variable of Java package name of project.

The Java package name of a BASIS project is made up of the vendor name and the name of the package itself. Moreover, if the project is a module of another project, the name of the module may optionally be used as part of the namespace as well. Names of packages and sub-packages in Java are usually in lowercase only.

Definition at line 97 of file ProjectSettings.cmake.

§ PROJECT_NAMESPACE_JYTHON

cmake PROJECT_NAMESPACE_JYTHON

CMake variable of Jython package name of project.

The Jython package name of a BASIS project is made up of the vendor name and the name of the package itself. Moreover, if the project is a module of another project, the name of the module may optionally be used as part of the namespace as well. Names of packages and sub-packages in Jython are usually in lowercase only.

Definition at line 117 of file ProjectSettings.cmake.

§ PROJECT_NAMESPACE_MATLAB

cmake PROJECT_NAMESPACE_MATLAB

CMake variable of MATLAB package name of project.

The MATLAB package name of a BASIS project is made up of its name in lower case only as well as the package name of the project it belongs to.

For information on MATLAB's package and class folders, visit the following web page from MathWorks:

See also
http://www.mathworks.com/help/techdoc/matlab_oop/brfynt_-1.html

Definition at line 151 of file ProjectSettings.cmake.

§ PROJECT_NAMESPACE_PERL

cmake PROJECT_NAMESPACE_PERL

CMake variable of Perl package name of project.

The Perl package name of a BASIS project is made up of the vendor name and the name of the package itself. Moreover, if the project is a module of another project, the name of the module may optionally be used as part of the namespace as well. Names of packages and sub-packages in Perl are usually in mixed CamelCase starting with an uppercase letter. Note that Perl informally reserves lowercase module names for "pragma" modules such as integer and strict.

Definition at line 129 of file ProjectSettings.cmake.

§ PROJECT_NAMESPACE_PYTHON

cmake PROJECT_NAMESPACE_PYTHON

CMake variable of Python package name of project.

The Python package name of a BASIS project is made up of the vendor name and the name of the package itself. Moreover, if the project is a module of another project, the name of the module may optionally be used as part of the namespace as well. Names of packages and sub-packages in Python are usually in lowercase only.

Definition at line 107 of file ProjectSettings.cmake.

§ PROJECT_PACKAGE_CONFIG_PREFIX

cmake PROJECT_PACKAGE_CONFIG_PREFIX

Prefix/name of CMake package configuration file.

Definition at line 161 of file ProjectSettings.cmake.

§ TOPLEVEL_PROJECT_NAMESPACE_CMAKE

cmake TOPLEVEL_PROJECT_NAMESPACE_CMAKE

CMake namespace of top-level project.

This is the common namespace of a BASIS project and its modules. It is the part of the namespace which is only required if the project's targets are referenced from another project, but not within the project.

Definition at line 65 of file ProjectSettings.cmake.

§ TOPLEVEL_PROJECT_PACKAGE_CONFIG_PREFIX

cmake TOPLEVEL_PROJECT_PACKAGE_CONFIG_PREFIX

Prefix/name of CMake package configuration file of top-level project.

Definition at line 158 of file ProjectSettings.cmake.

§ TOPLEVEL_PROJECT_PACKAGE_UID

cmake TOPLEVEL_PROJECT_PACKAGE_UID

UID of package in CMake's user package registry.

The value of this variable is used as name for the registry file which contains the path to the package configuration file on Unix, or the name of the Windows registry key on Windows.

See also
http://www.cmake.org/Wiki/CMake/Tutorials/Package_Registry

Definition at line 170 of file ProjectSettings.cmake.