Finds Matlab installations and provides Matlab tools and libraries to cmake.
This package first intention is to find the libraries associated with Matlab in order to be able to build Matlab extensions (mex files). It can also be used:
The module supports the following components:
Note
The version given to the find_package() directive is the Matlab version, which should not be confused with the Matlab release name (eg. R2014). The matlab_get_version_from_release_name() and matlab_get_release_name_from_version() allow a mapping from the release name to the version.
The variable Matlab_ROOT_DIR may be specified in order to give the path of the desired Matlab version. Otherwise, the behaviour is platform specific:
Additional information is provided when MATLAB_FIND_DEBUG is set. When a Matlab binary is found automatically and the MATLAB_VERSION is not given, the version is queried from Matlab directly. On Windows, it can make a window running Matlab appear.
The mapping of the release names and the version of Matlab is performed by defining pairs (name, version). The variable MATLAB_ADDITIONAL_VERSIONS may be provided before the call to the find_package() in order to handle additional versions.
A Matlab scripts can be added to the set of tests using the matlab_add_unit_test(). By default, the Matlab unit test framework will be used (>= 2013a) to run this script, but regular .m files returning an exit code can be used as well (0 indicating a success).
Users or projects may set the following variables to configure the module behaviour:
By default, every symbols inside a MEX file defined with the command matlab_add_mex() have hidden visibility, except for the entry point. This is the default behaviour of the MEX compiler, which lowers the risk of symbol collision between the libraries shipped with Matlab, and the libraries to which the MEX file is linking to. This is also the default on Windows platforms.
However, this is not sufficient in certain case, where for instance your MEX file is linking against libraries that are already loaded by Matlab, even if those libraries have different SONAMES. A possible solution is to hide the symbols of the libraries to which the MEX target is linking to. This can be achieved in GNU GCC compilers with the linker option -Wl,--exclude-libs,ALL.
The root folder of the Matlab installation. If set before the call to find_package(), the module will look for the components in that path. If not set, then an automatic search of Matlab will be performed. If set, it should point to a valid version of Matlab.
If set, the lookup of Matlab and the intermediate configuration steps are outputted to the console.
If set, specifies additional versions of Matlab that may be looked for. The variable should be a list of strings, organised by pairs of release name and versions, such as follows:
set(MATLAB_ADDITIONAL_VERSIONS
"release_name1=corresponding_version1"
"release_name2=corresponding_version2"
...
)
Example:
set(MATLAB_ADDITIONAL_VERSIONS
"R2013b=8.2"
"R2013a=8.1"
"R2012b=8.0")
The order of entries in this list matters when several versions of Matlab are installed. The priority is set according to the ordering in this list.
Returns the version of Matlab (17.58) from a release name (R2017k)
Returns the release name (R2017k) from the version of Matlab (17.58)
This function parses the registry and founds the Matlab versions that are installed. The found versions are returned in matlab_versions. Set win64 to TRUE if the 64 bit version of Matlab should be looked for The returned list contains all versions under HKLM\\SOFTWARE\\Mathworks\\MATLAB or an empty list in case an error occurred (or nothing found).
Note
Only the versions are provided. No check is made over the existence of the installation referenced in the registry,
Populates the Matlab root with valid versions of Matlab. The returned matlab_roots is organized in pairs (version_number,matlab_root_path).
matlab_get_all_valid_matlab_roots_from_registry(
matlab_versions
matlab_roots)
Returns the extension of the mex files (the suffixes). This function should not be called before the appropriate Matlab root has been found.
matlab_get_mex_suffix(
matlab_root
mex_suffix)
This function runs Matlab program specified on arguments and extracts its version.
matlab_get_version_from_matlab_run(
matlab_binary_path
matlab_list_versions)
Adds a Matlab unit test to the test set of cmake/ctest. This command requires the component MAIN_PROGRAM. The unit test uses the Matlab unittest framework (default, available starting Matlab 2013b+) except if the option NO_UNITTEST_FRAMEWORK is given.
The function expects one Matlab test script file to be given. In the case NO_UNITTEST_FRAMEWORK is given, the unittest script file should contain the script to be run, plus an exit command with the exit value. This exit value will be passed to the ctest framework (0 success, non 0 failure). Additional arguments accepted by add_test() can be passed through TEST_ARGS (eg. CONFIGURATION <config> ...).
matlab_add_unit_test(
NAME <name>
UNITTEST_FILE matlab_file_containing_unittest.m
[UNITTEST_PRECOMMAND matlab_command_to_run]
[TIMEOUT timeout]
[ADDITIONAL_PATH path1 [path2 ...]]
[MATLAB_ADDITIONAL_STARTUP_OPTIONS option1 [option2 ...]]
[TEST_ARGS arg1 [arg2 ...]]
[NO_UNITTEST_FRAMEWORK]
)
The function arguments are:
Adds a Matlab MEX target. This commands compiles the given sources with the current tool-chain in order to produce a MEX file. The final name of the produced output may be specified, as well as additional link libraries, and a documentation entry for the MEX file. Remaining arguments of the call are passed to the add_library() command.
matlab_add_mex(
NAME <name>
SRC src1 [src2 ...]
[OUTPUT_NAME output_name]
[DOCUMENTATION file.txt]
[LINK_TO target1 target2 ...]
[...]
)
The documentation file is not processed and should be in the following format:
% This is the documentation
function ret = mex_target_output_name(input1)