This package generates CMake functions, macros and templates. The main idea is to not duplicate common cmake functionalities along different packages.

This is a very useful package for a developer as it allows to compile a library, documentation or tool abstracting from cmake functions.

First, every module must have its own CMakeLists.txt. This CMake must:

1. Set its version cmake_minimum_required(VERSION 3.5)
2. Find this package find_package(cmake_utils REQUIRES)
3. Configure project configure_project()
4. Call project explicitly project(${MODULE_NAME} VERSION ${MODULE_VERSION} DESCRIPTION ${MODULE_DESCRIPTION})

From this point, the CMakeLists has everything loaded and can keep calling cmake_utils macros without needed to include or load anything.

In order to compile a C++ library, use the following macros:

1. To configure every C++ required flag and variable: configure_project_cpp()
2. To compile library: compile_library(${<src path>} ${<include path>})
3. To compile tests for the library: compile_test(${<test path>})
4. To install the package following eprosima defaults eprosima_packaging()

In order create a package (called Module from now on) using this library, three main files are required in the parent directory:

The file project_settings.cmake should be a CMake file with definitions of important variables. Check the table below to see which variables are required and which are useful to use.

The file VERSION must contain 3 lines with the version of this module. The version will be loaded from this file if it is not set in project_settings.cmake.

Every module requires to have a LICENSE file in order to install it with the result of the module.

These are the variables that could/must be set in the project_settings.cmake file. Those variables which default is x must be set, and those with - are not required.

Setting the CMake variable <library>_MINIMUM_VERSION will force the find_package call to look for library <library> with minimum version ${<library>_MINIMUM_VERSION}.

e.g.

set(MODULE_FIND_PACKAGES fastdds)
set(fastdds_MINIMUM_VERSION "3.0.0") # This will force to use a version of fastdds higher or equal 3.0.0

There are default CMake options used within cmake_utils package that will always be set. In case the user sets these variables, they will have that value. Otherwise, they will be initialized to their corresponding default value.