--- /dev/null
+#[===[.md:
+# DynamicVersion
+
+Helper module to get the project's version dynamically. Format is compatible with python's
+[`setuptools_scm`](https://github.com/pypa/setuptools_scm#git-archives)
+
+## Commands
+
+- {command}`dynamic_version`
+
+]===]
+
+include_guard()
+list(APPEND CMAKE_MESSAGE_CONTEXT DynamicVersion)
+if (POLICY CMP0140)
+ # Enable using return(PROPAGATE)
+ # TODO: Remove when cmake 3.25 is commonly distributed
+ cmake_policy(SET CMP0140 NEW)
+endif ()
+
+#[==============================================================================================[
+# Preparations #
+]==============================================================================================]
+
+# No specific preparations
+
+#[==============================================================================================[
+# Main interface #
+]==============================================================================================]
+
+function(dynamic_version)
+ #[===[.md:
+ # dynamic_version
+
+ Configure project to use dynamic versioning
+
+ ## Synopsis
+ ```cmake
+ Main interface
+ dynamic_version(PROJECT_PREFIX <prefix>)
+ dynamic_version(PROJECT_PREFIX <prefix>
+ [OUTPUT_VERSION <var>] [OUTPUT_VERSION_FULL <var>]
+ [OUTPUT_DESCRIBE <var>] [OUTPUT_COMMIT <var>]
+ [OUTPUT_DISTANCE <var>] [OUTPUT_SHORT_HASH <var>]
+ [VERSION_FULL_MODE <string>]
+ [PROJECT_SOURCE <path>] [GIT_ARCHIVAL_FILE <file>]
+ )
+
+ Fallbacks
+ dynamic_version(...
+ [ALLOW_FAILS] [FALLBACK_VERSION <version>] [FALLBACK_HASH <string>])
+
+ Additional configurations
+ dynamic_version(...
+ [TMP_FOLDER <path>] [FALLBACK_VERSION <version>] [FALLBACK_HASH <string>])
+ ```
+
+ ## Options
+ `PROJECT_PREFIX`
+ Prefix to be used for namespacing targets, typically ${PROJECT_NAME}
+
+ `OUTPUT_VERSION` [Default: PROJECT_VERSION]
+ Variable where to save the calculated version
+
+ `OUTPUT_VERSION_FULL` [Default: PROJECT_VERSION_FULL]
+ Variable where to save the full version in the format
+
+ `VERSION_FULL_MODE` [Default: DEV]
+ Format of the `OUTPUT_VERSION_FULL`. Must be one of [`DEV`, `POST`]
+
+ `OUTPUT_DESCRIBE` [Default: GIT_DESCRIBE]
+ Variable where to save the pure `git describe` output
+
+ `OUTPUT_COMMIT` [Default: GIT_COMMIT]
+ Variable where to save the current git commit hash
+
+ `OUTPUT_DISTANCE` [Default: GIT_DISTANCE]
+ Variable where to save the distance from git tag
+
+ `OUTPUT_SHORT_HASH` [Default: GIT_SHORT_HASH]
+ Variable where to save the shortened git commit hash
+
+ `PROJECT_SOURCE` [Default: `${CMAKE_CURRENT_SOURCE_DIR}`]
+ Location of the project source. Has to be either an extracted git archive or a git clone
+
+ `GIT_ARCHIVAL_FILE` [Default: `${PROJECT_SOURCE}/.git_archival.txt`]
+ Location of `.git_archival.txt` file. See [pypa/setuptools_scm](https://github.com/pypa/setuptools_scm#git-archives)
+ for more details
+
+ `FALLBACK_VERSION`
+ Fallback version to be set if version cannot be dynamically determined. Implies `ALLOW_FAILS`
+
+ `FALLBACK_HASH`
+ Fallback git hash to be used in `OUTPUT_COMMIT` if commit cannot be determined.
+ If not defined target GitHash will not be created if project is not a git repo
+
+ `ALLOW_FAILS`
+ Do not return with `FATAL_ERROR` if version cannot be dynamically determined. CMakeLists author is responsible
+ for setting appropriate version if fails
+
+ ### Additional configuration options
+
+ `TMP_FOLDER` [Default: `${CMAKE_CURRENT_BINARY_DIR}/tmp`]
+ Temporary path to store `DynamicVersion`'s temporary files
+
+ `OUTPUT_FOLDER` [Default: `${CMAKE_CURRENT_BINARY_DIR}`]
+ Path where to store generated files
+
+ ## Targets
+ `${PROJECT_PREFIX}Version`
+ Target that recalculates the dynamic version each time. See [](#Output-files) for using dependencies that only
+ change when the actual commit/describe/version change.
+
+ `${PROJECT_PREFIX}GitHash`
+ Target that recalculates the git hash each time.
+
+ ## Output files
+ :::{note}
+ These files are updated only when the contents change. You can use them as dependencies for files generated from
+ <inv:cmake:cmake:command#command:configure_file>. See <inv:cmake:cmake:prop_sf#prop_sf:OBJECT_DEPENDS> for more
+ info on how to add file-level dependency
+ :::
+
+ `${OUTPUT_FOLDER}/.DynamicVersion.json`
+ All computed data of `DynamicVersion`
+
+ `${OUTPUT_FOLDER}/.version`
+ Computed version
+
+ `${OUTPUT_FOLDER}/.git_describe`
+ Computed git describe
+
+ `${OUTPUT_FOLDER}/.git_commit`
+ Current commit
+
+ ## See also
+ - [pypa/setuptools_scm](https://github.com/pypa/setuptools_scm)
+
+ ]===]
+
+ list(APPEND CMAKE_MESSAGE_CONTEXT dynamic_version)
+ set(ARGS_Options
+ ALLOW_FAILS
+ )
+ set(ARGS_OneValue
+ PROJECT_PREFIX
+ OUTPUT_VERSION
+ OUTPUT_VERSION_FULL
+ VERSION_FULL_MODE
+ OUTPUT_DESCRIBE
+ OUTPUT_COMMIT
+ OUTPUT_DISTANCE
+ OUTPUT_SHORT_HASH
+ PROJECT_SOURCE
+ GIT_ARCHIVAL_FILE
+ FALLBACK_VERSION
+ FALLBACK_HASH
+ TMP_FOLDER
+ OUTPUT_FOLDER
+ )
+ set(ARGS_MultiValue
+ )
+
+ cmake_parse_arguments(PARSE_ARGV 0 ARGS "${ARGS_Options}" "${ARGS_OneValue}" "${ARGS_MultiValue}")
+
+ set(DynamicVersion_ARGS)
+
+ # Set default values
+ if (NOT DEFINED ARGS_OUTPUT_VERSION)
+ set(ARGS_OUTPUT_VERSION PROJECT_VERSION)
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_VERSION_FULL)
+ set(ARGS_OUTPUT_VERSION_FULL PROJECT_VERSION_FULL)
+ endif ()
+ if (NOT DEFINED ARGS_VERSION_FULL_MODE)
+ set(ARGS_VERSION_FULL_MODE DEV)
+ elseif (NOT ARGS_VERSION_FULL_MODE MATCHES "(DEV|POST)")
+ message(FATAL_ERROR "Unsupported VERSION_FULL_MODE = ${ARGS_VERSION_FULL_MODE}")
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_DESCRIBE)
+ set(ARGS_OUTPUT_DESCRIBE GIT_DESCRIBE)
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_COMMIT)
+ set(ARGS_OUTPUT_COMMIT GIT_COMMIT)
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_DISTANCE)
+ set(ARGS_OUTPUT_DISTANCE GIT_DISTANCE)
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_SHORT_HASH)
+ set(ARGS_OUTPUT_SHORT_HASH GIT_SHORT_HASH)
+ endif ()
+ if (NOT DEFINED ARGS_PROJECT_SOURCE)
+ set(ARGS_PROJECT_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
+ endif ()
+ if (NOT DEFINED ARGS_GIT_ARCHIVAL_FILE)
+ set(ARGS_GIT_ARCHIVAL_FILE ${ARGS_PROJECT_SOURCE}/.git_archival.txt)
+ endif ()
+ if (DEFINED ARGS_FALLBACK_VERSION OR ARGS_ALLOW_FAILS)
+ # If we have a fallback version or it is specified it is ok if this fails, don't make messages FATAL_ERROR
+ set(error_message_type AUTHOR_WARNING)
+ else ()
+ # Otherwise it should
+ set(error_message_type FATAL_ERROR)
+ endif ()
+ if (NOT ARGS_PROJECT_PREFIX)
+ message(AUTHOR_WARNING
+ "No PROJECT_PREFIX was given. Please provide one to avoid target name clashes"
+ )
+ elseif (NOT ARGS_PROJECT_PREFIX MATCHES ".*_$")
+ # Append an underscore _ to the prefix if not provided
+ message(AUTHOR_WARNING
+ "PROJECT_PREFIX did not contain an underscore, please add it for clarity"
+ )
+ set(ARGS_PROJECT_PREFIX ${ARGS_PROJECT_PREFIX}_)
+ endif ()
+ if (NOT DEFINED ARGS_TMP_FOLDER)
+ set(ARGS_TMP_FOLDER ${CMAKE_CURRENT_BINARY_DIR}/tmp)
+ endif ()
+ if (NOT DEFINED ARGS_OUTPUT_FOLDER)
+ set(ARGS_OUTPUT_FOLDER ${CMAKE_CURRENT_BINARY_DIR})
+ endif ()
+ if (ARGS_OUTPUT_FOLDER EQUAL ARGS_TMP_FOLDER)
+ message(FATAL_ERROR
+ "OUTPUT_FOLDER and TMP_FOLDER cannot point to the same path"
+ )
+ endif ()
+
+ list(APPEND DynamicVersion_ARGS
+ PROJECT_SOURCE ${ARGS_PROJECT_SOURCE}
+ GIT_ARCHIVAL_FILE ${ARGS_GIT_ARCHIVAL_FILE}
+ TMP_FOLDER ${ARGS_TMP_FOLDER}
+ VERSION_FULL_MODE ${ARGS_VERSION_FULL_MODE}
+ )
+ if (DEFINED ARGS_FALLBACK_VERSION)
+ list(APPEND DynamicVersion_ARGS
+ FALLBACK_VERSION ${ARGS_FALLBACK_VERSION})
+ endif ()
+ if (DEFINED ARGS_FALLBACK_HASH)
+ list(APPEND DynamicVersion_ARGS
+ FALLBACK_HASH ${ARGS_FALLBACK_HASH})
+ endif ()
+ if (ARGS_ALLOW_FAILS)
+ list(APPEND DynamicVersion_ARGS ALLOW_FAILS)
+ endif ()
+ # Normalize DynamicVersion_ARGS to be passed as string
+ list(JOIN DynamicVersion_ARGS "\\;" DynamicVersion_ARGS)
+
+ # Execute get_dynamic_version once to know the current configuration
+ execute_process(COMMAND ${CMAKE_COMMAND}
+ -DDynamicVersion_RUN:BOOL=True
+ # Note: DynamicVersion_ARGS cannot be escaped with ""
+ -DDynamicVersion_ARGS:STRING=${DynamicVersion_ARGS}
+ -P ${CMAKE_CURRENT_FUNCTION_LIST_FILE}
+ COMMAND_ERROR_IS_FATAL ANY)
+
+ # Copy all configured files
+ foreach (file IN ITEMS .DynamicVersion.json .version .git_describe .git_commit)
+ if (EXISTS ${ARGS_TMP_FOLDER}/${file})
+ if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.21)
+ file(COPY_FILE ${ARGS_TMP_FOLDER}/${file} ${ARGS_OUTPUT_FOLDER}/${file})
+ else ()
+ file(COPY ${ARGS_TMP_FOLDER}/${file} DESTINATION ${ARGS_OUTPUT_FOLDER}/)
+ endif ()
+ endif ()
+ endforeach ()
+
+ # Check configuration state
+ file(READ ${ARGS_TMP_FOLDER}/.DynamicVersion.json data)
+ # failed, mode, and version are always set if get_dynamic_version did not exit with failure
+ string(JSON failed GET ${data} failed)
+ string(JSON ${ARGS_OUTPUT_VERSION} GET ${data} version)
+ string(JSON ${ARGS_OUTPUT_VERSION_FULL} GET ${data} version-full)
+ # Other outputs are optional, populate the variables if found
+ # These are populated if failed = false
+ string(JSON ${ARGS_OUTPUT_SHORT_HASH} ERROR_VARIABLE _ GET ${data} short-hash)
+ string(JSON ${ARGS_OUTPUT_DISTANCE} ERROR_VARIABLE _ GET ${data} distance)
+ # These may not be populated depending on mode
+ string(JSON ${ARGS_OUTPUT_COMMIT} ERROR_VARIABLE _ GET ${data} commit)
+ string(JSON ${ARGS_OUTPUT_DESCRIBE} ERROR_VARIABLE _ GET ${data} describe)
+
+ # Configure targets
+ if (failed)
+ # If configuration failed, create dummy targets
+ add_custom_target(${ARGS_PROJECT_PREFIX}Version
+ COMMAND ${CMAKE_COMMAND} -E true)
+ add_custom_target(${ARGS_PROJECT_PREFIX}GitHash
+ COMMAND ${CMAKE_COMMAND} -E true)
+ else ()
+ # Otherwise create the targets outputting to the appropriate files
+ add_custom_target(${ARGS_PROJECT_PREFIX}DynamicVersion ALL
+ BYPRODUCTS ${ARGS_TMP_FOLDER}/.DynamicVersion.json ${ARGS_TMP_FOLDER}/.git_describe ${ARGS_TMP_FOLDER}/.version
+ COMMAND ${CMAKE_COMMAND}
+ -DDynamicVersion_RUN:BOOL=True
+ # Note: For some reason DynamicVersion_ARGS needs "" here, but it doesn't in execute_process
+ -DDynamicVersion_ARGS:STRING="${DynamicVersion_ARGS}"
+ -P ${CMAKE_CURRENT_FUNCTION_LIST_FILE}
+ COMMAND ${CMAKE_COMMAND} -E copy_if_different ${ARGS_TMP_FOLDER}/.DynamicVersion.json ${ARGS_OUTPUT_FOLDER}/.DynamicVersion.json
+ )
+ set(extra_version_args)
+ # .git_describe might not be generated, e.g. if it's an sdist. Make it optional
+ if (EXISTS ${ARGS_OUTPUT_FOLDER}/.git_describe)
+ list(APPEND extra_version_args
+ COMMAND ${CMAKE_COMMAND} -E copy_if_different ${ARGS_TMP_FOLDER}/.git_describe ${ARGS_OUTPUT_FOLDER}/.git_describe
+ )
+ endif ()
+ add_custom_target(${ARGS_PROJECT_PREFIX}Version ALL
+ DEPENDS ${ARGS_PROJECT_PREFIX}DynamicVersion
+ COMMAND ${CMAKE_COMMAND} -E copy_if_different ${ARGS_TMP_FOLDER}/.version ${ARGS_OUTPUT_FOLDER}/.version
+ ${extra_version_args}
+ )
+ # .git_commit might not exist, make the target a no-op in that case
+ if (NOT EXISTS ${ARGS_OUTPUT_FOLDER}/.git_commit)
+ add_custom_target(${ARGS_PROJECT_PREFIX}GitHash
+ COMMAND ${CMAKE_COMMAND} -E true)
+ else ()
+ add_custom_target(${ARGS_PROJECT_PREFIX}GitHash
+ DEPENDS ${ARGS_PROJECT_PREFIX}DynamicVersion
+ COMMAND ${CMAKE_COMMAND} -E copy_if_different ${ARGS_TMP_FOLDER}/.git_commit ${ARGS_OUTPUT_FOLDER}/.git_commit
+ )
+ endif ()
+ endif ()
+
+ # This ensures that the project is reconfigured (at least at second run) whenever the version changes
+ set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} APPEND
+ PROPERTY CMAKE_CONFIGURE_DEPENDS ${ARGS_OUTPUT_FOLDER}/.version)
+
+ message(VERBOSE
+ "Calculated version = ${${ARGS_OUTPUT_VERSION}}"
+ )
+
+ if (CMAKE_VERSION VERSION_LESS 3.25)
+ # TODO: Remove when cmake 3.25 is commonly distributed
+ set(${ARGS_OUTPUT_DESCRIBE} ${${ARGS_OUTPUT_DESCRIBE}} PARENT_SCOPE)
+ set(${ARGS_OUTPUT_VERSION} ${${ARGS_OUTPUT_VERSION}} PARENT_SCOPE)
+ set(${ARGS_OUTPUT_VERSION_FULL} ${${ARGS_OUTPUT_VERSION_FULL}} PARENT_SCOPE)
+ set(${ARGS_OUTPUT_COMMIT} ${${ARGS_OUTPUT_COMMIT}} PARENT_SCOPE)
+ set(${ARGS_OUTPUT_DISTANCE} ${${ARGS_OUTPUT_DISTANCE}} PARENT_SCOPE)
+ set(${ARGS_OUTPUT_SHORT_HASH} ${${ARGS_OUTPUT_SHORT_HASH}} PARENT_SCOPE)
+ endif ()
+ return(PROPAGATE
+ ${ARGS_OUTPUT_DESCRIBE}
+ ${ARGS_OUTPUT_VERSION}
+ ${ARGS_OUTPUT_VERSION_FULL}
+ ${ARGS_OUTPUT_COMMIT}
+ ${ARGS_OUTPUT_DISTANCE}
+ ${ARGS_OUTPUT_SHORT_HASH}
+ )
+endfunction()
+
+
+#[==============================================================================================[
+# Auxiliary interface #
+]==============================================================================================]
+
+function(get_dynamic_version)
+ #[===[.md:
+ # get_dynamic_version
+
+ Internal function that is called to calculate the dynamic version. This function is called by the
+ `${PROJECT_PREFIX}DynamicVersion` targets generated by {command}`dynamic_version`.
+
+ In a nutshell, the `DynamicVersion.cmake` is executed with the variable `DynamicVersion_RUN` set to true.
+
+ ## Synopsis
+ ```cmake
+ get_dynamic_version(PROJECT_SOURCE <path> GIT_ARCHIVAL_FILE <file>
+ TMP_FOLDER <path> VERSION_FULL_MODE <string>
+ [FALLBACK_VERSION <version>] [FALLBACK_HASH <string>]
+ )
+ ```
+
+ ## Options
+ See {command}`dynamic_version` for details
+
+ ## See also
+ - [pypa/setuptools_scm](https://github.com/pypa/setuptools_scm)
+
+ ]===]
+
+ list(APPEND CMAKE_MESSAGE_CONTEXT get_dynamic_version)
+ set(ARGS_Options
+ ALLOW_FAILS
+ )
+ set(ARGS_OneValue
+ PROJECT_SOURCE
+ VERSION_FULL_MODE
+ GIT_ARCHIVAL_FILE
+ FALLBACK_VERSION
+ FALLBACK_HASH
+ TMP_FOLDER
+ )
+ set(ARGS_MultiValue
+ )
+
+ cmake_parse_arguments(PARSE_ARGV 0 ARGS "${ARGS_Options}" "${ARGS_OneValue}" "${ARGS_MultiValue}")
+
+ if (DEFINED ARGS_FALLBACK_VERSION OR ARGS_ALLOW_FAILS)
+ # If we have a fallback version or it is specified it is ok if this fails, don't make messages FATAL_ERROR
+ set(error_message_type AUTHOR_WARNING)
+ else ()
+ # Otherwise it should fail
+ set(error_message_type FATAL_ERROR)
+ endif ()
+
+ set(data "{}")
+ # Default set
+ string(JSON data SET ${data} failed true)
+ if (ARGS_ALLOW_FAILS)
+ string(JSON data SET ${data} allow-fails true)
+ else ()
+ string(JSON data SET ${data} allow-fails false)
+ endif ()
+
+ # Set fallback values
+ if (DEFINED ARGS_FALLBACK_VERSION)
+ string(JSON data SET
+ ${data} version \"${ARGS_FALLBACK_VERSION}\")
+ string(JSON data SET
+ ${data} version-full \"${ARGS_FALLBACK_VERSION}\")
+ file(WRITE ${ARGS_TMP_FOLDER}/.version ${ARGS_FALLBACK_VERSION})
+ endif ()
+ if (DEFINED ARGS_FALLBACK_HASH)
+ string(JSON data SET
+ ${data} commit \"${ARGS_FALLBACK_HASH}\")
+ file(WRITE ${ARGS_TMP_FOLDER}/.git_commit ${ARGS_FALLBACK_HASH})
+ endif ()
+
+ file(WRITE ${ARGS_TMP_FOLDER}/.DynamicVersion.json ${data})
+
+ # Check git_archival.txt file is present and properly written
+ if (NOT EXISTS ${ARGS_GIT_ARCHIVAL_FILE})
+ # If git_archival.txt is missing, project is ill-formed
+ message(${error_message_type}
+ "Missing file .git_archival.txt\n"
+ " .git_archival.txt: ${ARGS_GIT_ARCHIVAL_FILE}"
+ )
+ return()
+ endif ()
+ file(STRINGS ${ARGS_GIT_ARCHIVAL_FILE} describe-name
+ REGEX "^describe-name:.*")
+ if (NOT describe-name)
+ # If git_archival.txt does not contain the field "describe-name:", it is ill-formed
+ message(${error_message_type}
+ "Missing string \"describe-name\" in .git_archival.txt\n"
+ " .git_archival.txt: ${ARGS_GIT_ARCHIVAL_FILE}"
+ )
+ return()
+ endif ()
+
+ # Try to get the version statically, and if it fails, get it from VCS
+ if (EXISTS ${ARGS_PROJECT_SOURCE}/PKG-INFO)
+ # Case1: Python sdist archive. Get everything from PKG-INFO file
+ set(mode pkg-info)
+ file(STRINGS ${ARGS_PROJECT_SOURCE}/PKG-INFO version
+ REGEX "^Version:[ ]?(([0-9\\.]+)([a-zA-Z0-9]*)?(\\.(dev|post)([0-9]+)\\+g([a-f0-9]+))?)$")
+ # Cannot use Regex match from here, need to run string(REGEX MATCH) again
+ # https://gitlab.kitware.com/cmake/cmake/-/issues/23770
+ string(REGEX MATCH "^Version:[ ]?(([0-9\\.]+)([a-zA-Z0-9]*)?(\\.(dev|post)([0-9]+)\\+g([a-f0-9]+))?)$" version "${version}")
+ # Regex match groups: https://regex101.com/r/G4Ox4X/5
+ # 1: Full version string
+ # 2: Version string
+ # 3: Version suffix (e.g. rc, alpha, etc.)
+ # 4: Development suffix
+ # 5: dev/post
+ # 6: git distance
+ # 7: short_hash
+ set(version-full ${CMAKE_MATCH_1})
+ set(version ${CMAKE_MATCH_2})
+ set(version-suffix ${CMAKE_MATCH_3})
+ if (CMAKE_MATCH_4)
+ set(distance ${CMAKE_MATCH_6})
+ set(short-hash ${CMAKE_MATCH_7})
+ string(JSON data SET
+ ${data} dev-type \"${CMAKE_MATCH_5}\")
+ else ()
+ set(distance 0)
+ endif ()
+ message(DEBUG "Found version in PKG-INFO")
+ elseif (describe-name MATCHES "^describe-name:[ ]?(v?([0-9\\.]+)(-?[a-zA-z0-9]*)?(-([0-9]+)-g([a-f0-9]+))?)$")
+ # Case2: Git archive. Get everything from git_archival.txt file
+ set(mode git-archive)
+ # Regex match groups: https://regex101.com/r/osVZpm/4
+ # 1: Git describe
+ # 2: Version string
+ # 3: Version suffix (e.g. rc, alpha, etc.)
+ # 4: Development suffix
+ # 5: git distance
+ # 6: short_hash
+ set(describe ${CMAKE_MATCH_1})
+ set(version ${CMAKE_MATCH_2})
+ set(version-suffix ${CMAKE_MATCH_3})
+ if (CMAKE_MATCH_4)
+ set(distance ${CMAKE_MATCH_5})
+ set(short-hash ${CMAKE_MATCH_6})
+ else ()
+ set(distance 0)
+ endif ()
+ # Get commit hash
+ file(STRINGS ${ARGS_GIT_ARCHIVAL_FILE} node
+ REGEX "^node:[ ]?(.*)")
+ # Cannot use Regex match from here, need to run string(REGEX MATCH) again
+ # https://gitlab.kitware.com/cmake/cmake/-/issues/23770
+ string(REGEX MATCH "^node:[ ]?(.*)" node "${node}")
+ set(commit ${CMAKE_MATCH_1})
+ message(DEBUG "Found version in git-archival.txt")
+ else ()
+ # Default: Git repository. Call git commands
+ set(mode git)
+ find_package(Git REQUIRED)
+ # Test if project is a git repository
+ execute_process(COMMAND ${GIT_EXECUTABLE} status
+ WORKING_DIRECTORY ${ARGS_PROJECT_SOURCE}
+ RESULT_VARIABLE git_status_result
+ OUTPUT_QUIET)
+ if (NOT git_status_result EQUAL 0)
+ message(${error_message_type}
+ "Project source is neither a git repository nor a git archive:\n"
+ " Source: ${ARGS_PROJECT_SOURCE}"
+ )
+ return()
+ endif ()
+ # Get version and describe-name
+ execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --long --match=?[0-9.]*
+ WORKING_DIRECTORY ${ARGS_PROJECT_SOURCE}
+ OUTPUT_VARIABLE describe-name
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+ RESULT_VARIABLE git_describe_result
+ )
+ if (NOT git_status_result EQUAL 0)
+ message(${error_message_type}
+ "Git describe failed:\n"
+ " Source: ${ARGS_PROJECT_SOURCE}"
+ )
+ return()
+ endif ()
+ # Match any part containing digits and periods (strips out rc and so on)
+ if (NOT describe-name MATCHES "^(v?([0-9\\.]+)(-?[a-zA-z0-9]*)?(-([0-9]+)-g([a-f0-9]+))?)$")
+ message(${error_message_type}
+ "Version tag is ill-formatted\n"
+ " Describe-name: ${describe-name}"
+ )
+ return()
+ endif ()
+ # Regex match groups: https://regex101.com/r/GIfYI1/2
+ # 1: Git describe
+ # 2: Version string
+ # 3: Version suffix (e.g. rc, alpha, etc.)
+ # 4: Development suffix
+ # 5: git distance
+ # 6: short_hash
+ set(describe ${CMAKE_MATCH_1})
+ set(version ${CMAKE_MATCH_2})
+ set(version-suffix ${CMAKE_MATCH_3})
+ if (CMAKE_MATCH_4)
+ set(distance ${CMAKE_MATCH_5})
+ set(short-hash ${CMAKE_MATCH_6})
+ else ()
+ set(distance 0)
+ endif ()
+ # Get commit hash
+ execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse HEAD
+ WORKING_DIRECTORY ${ARGS_PROJECT_SOURCE}
+ OUTPUT_VARIABLE commit
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+ RESULT_VARIABLE git_rev_parser_result
+ )
+ if (NOT git_rev_parser_result EQUAL 0)
+ message(${error_message_type}
+ "Could not get current git commit:\n"
+ " Source: ${ARGS_PROJECT_SOURCE}"
+ )
+ return()
+ endif ()
+ message(DEBUG "Found version git repo")
+ endif ()
+
+ # Construct the version_full if it was not already provided
+ if (NOT version-full)
+ string(REGEX REPLACE "[-_]" "" version-suffix-sanitized "${version-suffix}")
+ if (distance EQUAL 0)
+ # If the distance is 0, just use the original tag version with sanitized suffix
+ set(version-full "${version}${version-suffix-sanitized}")
+ else ()
+ # Otherwise construct it according to VERSION_FULL_MODE
+ if (ARGS_VERSION_FULL_MODE STREQUAL DEV)
+ # In DEV mode, we bump the last digit of the version. If this is in version-suffix, like `-rcX`, then
+ # this must be bumped instead
+ if (version-suffix-sanitized MATCHES "([a-zA-Z]*)([0-9]+)")
+ math(EXPR bumped_number "${CMAKE_MATCH_2} + 1")
+ set(version-suffix-sanitized "${CMAKE_MATCH_1}${bumped_number}")
+ elseif (version MATCHES "([0-9\\.]*\\.)([0-9]+)")
+ math(EXPR bumped_number "${CMAKE_MATCH_2} + 1")
+ set(version "${CMAKE_MATCH_1}${bumped_number}")
+ else ()
+ message(FATAL_ERROR "Assert False: version = ${version}")
+ endif ()
+ set(version-full "${version}${version-suffix-sanitized}.dev${distance}+g${short-hash}")
+ elseif (ARGS_VERSION_FULL_MODE STREQUAL POST)
+ set(version-full "${version}${version-suffix-sanitized}.post${distance}+g${short-hash}")
+ else ()
+ message(FATAL_ERROR "Assert False: VERSION_FULL_MODE = ${ARGS_VERSION_FULL_MODE}")
+ endif ()
+ endif ()
+ endif ()
+
+ # Construct the JSON data
+ string(JSON data SET ${data}
+ mode \"${mode}\"
+ )
+ string(JSON data SET ${data}
+ version \"${version}\"
+ )
+ file(WRITE ${ARGS_TMP_FOLDER}/.version ${version})
+ string(JSON data SET ${data}
+ version-full \"${version-full}\"
+ )
+ if (describe)
+ string(JSON data SET ${data}
+ describe \"${describe}\"
+ )
+ file(WRITE ${ARGS_TMP_FOLDER}/.git_describe ${describe})
+ endif ()
+ if (commit)
+ string(JSON data SET ${data}
+ commit \"${commit}\"
+ )
+ file(WRITE ${ARGS_TMP_FOLDER}/.git_commit ${commit})
+ endif ()
+ set(JSON data SET ${data}
+ version-full \"${version-full}\"
+ )
+ string(JSON data SET ${data}
+ version-suffix \"${version-suffix}\"
+ )
+ string(JSON data SET ${data}
+ distance ${distance}
+ )
+ if (short-hash)
+ string(JSON data SET ${data}
+ short-hash \"${short-hash}\"
+ )
+ endif ()
+
+ # Mark success and output results
+ string(JSON data SET ${data} failed false)
+ message(DEBUG
+ "Computed data:\n"
+ " data = ${data}"
+ )
+ file(WRITE ${ARGS_TMP_FOLDER}/.DynamicVersion.json ${data})
+endfunction()
+
+
+#[==============================================================================================[
+# Private interface #
+]==============================================================================================]
+
+# No private interface
+
+
+#[==============================================================================================[
+# Misc #
+]==============================================================================================]
+
+# Logic to run get_dynamic_version() by running this script
+if (DynamicVersion_RUN)
+ if (NOT DEFINED DynamicVersion_ARGS)
+ message(FATAL_ERROR
+ "DynamicVersion_ARGS not defined"
+ )
+ endif ()
+ get_dynamic_version(${DynamicVersion_ARGS})
+endif ()
+
+list(POP_BACK CMAKE_MESSAGE_CONTEXT)
