# SPDX-FileCopyrightText: 2014 Alex Merry # SPDX-FileCopyrightText: 2012 Alexander Neundorf # # SPDX-License-Identifier: BSD-3-Clause #[=======================================================================[.rst: ECMSetupVersion --------------- Handle library version information. :: ecm_setup_version( VARIABLE_PREFIX [SOVERSION ] [VERSION_HEADER ] [PACKAGE_VERSION_FILE [COMPATIBILITY ]] ) This parses a version string and sets up a standard set of version variables. It can optionally also create a C version header file and a CMake package version file to install along with the library. If the ```` argument is of the form ``..`` (or ``...``), The following CMake variables are set:: _VERSION_MAJOR - _VERSION_MINOR - _VERSION_PATCH - _VERSION - _SOVERSION - , or if SOVERSION was not given For backward-compatibility also this variable is set (only if the minimum required version of ECM is < 5.83):: _VERSION_STRING - (use _VERSION instead) With CMake versions older than 4.0.0 and if CMake policy CMP0048 is not ``NEW``, the following CMake variables will also be set:: PROJECT_VERSION_MAJOR - PROJECT_VERSION_MINOR - PROJECT_VERSION_PATCH - PROJECT_VERSION - For backward-compatibility, if CMake policy CMP0048 is not ``NEW``, also this variable is set (only if the minimum required version of ECM is < 5.83):: PROJECT_VERSION_STRING - (use PROJECT_VERSION instead) If the ``VERSION_HEADER`` option is used, a simple C header is generated with the given filename. If filename is a relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The generated header contains the following macros:: _VERSION_MAJOR - as an integer _VERSION_MINOR - as an integer _VERSION_PATCH - as an integer _VERSION_STRING - as a C string _VERSION - the version as an integer ``_VERSION`` has ```` in the bottom 8 bits, ```` in the next 8 bits and ```` in the remaining bits. Note that ```` and ```` must be less than 256. If the ``PACKAGE_VERSION_FILE`` option is used, a simple CMake package version file is created using the ``write_basic_package_version_file()`` macro provided by CMake. It should be installed in the same location as the Config.cmake file of the library so that it can be found by ``find_package()``. If the filename is a relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The optional ``COMPATIBILITY`` option is forwarded to ``write_basic_package_version_file()``, and defaults to ``AnyNewerVersion``. With CMake versions >= 4.0.0 or if CMake policy CMP0048 is ``NEW``, an alternative form of the command is available:: ecm_setup_version(PROJECT [VARIABLE_PREFIX ] [SOVERSION ] [VERSION_HEADER ] [PACKAGE_VERSION_FILE ] ) This will use the version information set by the ``project()`` command. ``VARIABLE_PREFIX`` defaults to the project name. Note that ``PROJECT`` must be the first argument. In all other respects, it behaves like the other form of the command. Since pre-1.0.0. ``COMPATIBILITY`` option available since 1.6.0. #]=======================================================================] # cache set policy at time of module inclusion if(CMAKE_MAJOR_VERSION VERSION_LESS 4) cmake_policy(GET CMP0048 _ecm_setup_version_project_version_policy) endif() cmake_policy(VERSION 3.16) include(CMakePackageConfigHelpers) # save the location of the header template while CMAKE_CURRENT_LIST_DIR # has the value we want set(_ECM_SETUP_VERSION_HEADER_TEMPLATE "${CMAKE_CURRENT_LIST_DIR}/ECMVersionHeader.h.in") function(ecm_setup_version _version) set(options ) set(oneValueArgs VARIABLE_PREFIX SOVERSION VERSION_HEADER PACKAGE_VERSION_FILE COMPATIBILITY) set(multiValueArgs ) cmake_parse_arguments(ESV "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) if(ESV_UNPARSED_ARGUMENTS) message(FATAL_ERROR "Unknown keywords given to ECM_SETUP_VERSION(): \"${ESV_UNPARSED_ARGUMENTS}\"") endif() set(project_manages_version FALSE) set(use_project_version FALSE) if(CMAKE_MAJOR_VERSION VERSION_GREATER_EQUAL 4) set(project_manages_version TRUE) if(_version STREQUAL "PROJECT") set(use_project_version TRUE) endif() else() if(_ecm_setup_version_project_version_policy STREQUAL "NEW") set(project_manages_version TRUE) if(_version STREQUAL "PROJECT") set(use_project_version TRUE) endif() elseif(_version STREQUAL "PROJECT") message(FATAL_ERROR "ecm_setup_version given PROJECT argument, but CMP0048 is not NEW") endif() endif() set(should_set_prefixed_vars TRUE) if(NOT ESV_VARIABLE_PREFIX) if(use_project_version) set(ESV_VARIABLE_PREFIX "${PROJECT_NAME}") set(should_set_prefixed_vars FALSE) else() message(FATAL_ERROR "Required argument PREFIX missing in ECM_SETUP_VERSION() call") endif() endif() if(use_project_version) set(_version "${PROJECT_VERSION}") # drop leading 0 from values to avoid bogus octal values in c/C++ e.g. with 08 or 09 string(REGEX REPLACE "0*([0-9]+)" "\\1" _major "${PROJECT_VERSION_MAJOR}") string(REGEX REPLACE "0*([0-9]+)" "\\1" _minor "${PROJECT_VERSION_MINOR}") string(REGEX REPLACE "0*([0-9]+)" "\\1" _patch "${PROJECT_VERSION_PATCH}") else() string(REGEX REPLACE "^0*([0-9]+)\\.[0-9]+\\.[0-9]+.*" "\\1" _major "${_version}") string(REGEX REPLACE "^[0-9]+\\.0*([0-9]+)\\.[0-9]+.*" "\\1" _minor "${_version}") string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.0*([0-9]+).*" "\\1" _patch "${_version}") endif() if(NOT DEFINED ESV_SOVERSION) # use DEFINED, so "0" as valid SO version is not evaluated to FALSE set(ESV_SOVERSION ${_major}) endif() if(ECM_GLOBAL_FIND_VERSION VERSION_LESS 5.83.0) set(_set_backward_compat_version_string_vars TRUE) else() set(_set_backward_compat_version_string_vars FALSE) endif() if(should_set_prefixed_vars) set(${ESV_VARIABLE_PREFIX}_VERSION "${_version}") set(${ESV_VARIABLE_PREFIX}_VERSION_MAJOR ${_major}) set(${ESV_VARIABLE_PREFIX}_VERSION_MINOR ${_minor}) set(${ESV_VARIABLE_PREFIX}_VERSION_PATCH ${_patch}) endif() set(${ESV_VARIABLE_PREFIX}_SOVERSION ${ESV_SOVERSION}) if(NOT project_manages_version) set(PROJECT_VERSION "${_version}") set(PROJECT_VERSION_MAJOR "${_major}") set(PROJECT_VERSION_MINOR "${_minor}") set(PROJECT_VERSION_PATCH "${_patch}") endif() if(_set_backward_compat_version_string_vars) set(PROJECT_VERSION_STRING "${PROJECT_VERSION}") set(${ESV_VARIABLE_PREFIX}_VERSION_STRING "${${ESV_VARIABLE_PREFIX}_VERSION}") endif() if(ESV_VERSION_HEADER) set(HEADER_PREFIX "${ESV_VARIABLE_PREFIX}") set(HEADER_VERSION "${_version}") set(HEADER_VERSION_MAJOR "${_major}") set(HEADER_VERSION_MINOR "${_minor}") set(HEADER_VERSION_PATCH "${_patch}") configure_file("${_ECM_SETUP_VERSION_HEADER_TEMPLATE}" "${ESV_VERSION_HEADER}") endif() if(ESV_PACKAGE_VERSION_FILE) if(NOT ESV_COMPATIBILITY) set(ESV_COMPATIBILITY AnyNewerVersion) endif() write_basic_package_version_file("${ESV_PACKAGE_VERSION_FILE}" VERSION ${_version} COMPATIBILITY ${ESV_COMPATIBILITY}) endif() if(should_set_prefixed_vars) set(${ESV_VARIABLE_PREFIX}_VERSION_MAJOR "${${ESV_VARIABLE_PREFIX}_VERSION_MAJOR}" PARENT_SCOPE) set(${ESV_VARIABLE_PREFIX}_VERSION_MINOR "${${ESV_VARIABLE_PREFIX}_VERSION_MINOR}" PARENT_SCOPE) set(${ESV_VARIABLE_PREFIX}_VERSION_PATCH "${${ESV_VARIABLE_PREFIX}_VERSION_PATCH}" PARENT_SCOPE) set(${ESV_VARIABLE_PREFIX}_VERSION "${${ESV_VARIABLE_PREFIX}_VERSION}" PARENT_SCOPE) endif() # always set the soversion set(${ESV_VARIABLE_PREFIX}_SOVERSION "${${ESV_VARIABLE_PREFIX}_SOVERSION}" PARENT_SCOPE) if(NOT project_manages_version) set(PROJECT_VERSION "${PROJECT_VERSION}" PARENT_SCOPE) set(PROJECT_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}" PARENT_SCOPE) set(PROJECT_VERSION_MINOR "${PROJECT_VERSION_MINOR}" PARENT_SCOPE) set(PROJECT_VERSION_PATCH "${PROJECT_VERSION_PATCH}" PARENT_SCOPE) endif() if(_set_backward_compat_version_string_vars) set(PROJECT_VERSION_STRING "${PROJECT_VERSION_STRING}" PARENT_SCOPE) set(${ESV_VARIABLE_PREFIX}_VERSION_STRING "${${ESV_VARIABLE_PREFIX}_VERSION}" PARENT_SCOPE) endif() endfunction()