CMake Utils

This code is still in BETA and may not work when used.

CMake GetProject

get_project() function, downloads and adds as a sub directory (can be disabled) an external library. The download is performed at configuration time. Does not rely on FetchContent or ExternalProject.

The default directory where GetProject puts the libraries in ${CMAKE_HOME_DIRECTORY}/libs. If the GET_PROJECT_OUTPUT_DIR is set before including GetProject.cmake, the user defined directory will be used.

The output will be placed in ${GET_PROJECT_OUTPUT_DIR}/${LIBRARY_NAME}. LIBRARY_NAME will be obtained through the GIT_REPOSITORY if not provided.

get_project(
        URL                    # Library URL
        GIT_REPOSITORY         # Library git repository
        FILE                   # If ARGS_URL downloads a single file
        LIBRARY_NAME           # Library name (can be inferred from git repo)
        INSTALL_ENABLED        # If the library needs to be installed (requires extra build)
        DOWNLOAD_ONLY          # If ON the library won't be added as a sub directory
        BRANCH                 # Library git branch
        KEEP_UPDATED           # If the library should be kept updated
        VERSION                # A valid tag or LATEST for the latest release
        OPTIONS                # Options that will be defined before adding the sub directory.
)

Setting INSTALL_ENABLED to true will cause the script to configure, build and then install the library. This will be done at configure time.

Usage

The URL, GIT_REPOSITORY arguments are mutually exclusive.

The BRANCH arguments may be used with the KEEP_UPDATED option, VERSION is used when no branch is provided.

PyRunner

run_python_script() function, executes a python3 script at configure time. The function allows for a list of python dependencies with minimum required versions.

run_python_script(
        NAME                      # Script path/name
        CWD                       # Working directory
        MIN_PYTHON_VERSION        # Minimum interpreter version
        MAX_PYTHON_VERSION        # Maximum interpreter version
        DEPENDENCIES              # Python dependencies
        ARGS                      # Script args
)

Usage

The NAME argument is the only required one.

The DEPENDENCIES list elements follow the format name(:major!(.minor)(.patch)(<anything>)!). The '!' after major indicates that the dependency major version must match the one provided. The '!' at the end means that the version must completely match the one provided.

Valid dependencies elements are:

• requests (any version of the library 'requests')
• requests:1.0.0 (at least version 1.0.0 of the library 'requests')
• requests:1!.0.0 (version 1.*.* of the library 'requests')
• requests:1.0.0! (version 1.0.0 of the library 'requests')