Set projet's version in CMake

the patch is based on pmem/pmemstream and pmem/pmemkv projects.
VERSION is set via 'project' command. An extra UMF_SRC_VERSION
is set via helper function parsing 'git describe' output.

Author: lukaszstolarczuk

CMakeLists.txt

@@ -8,6 +8,22 @@ project(
     VERSION 0.1.0
     LANGUAGES C)
 
+# needed when UMF is used as an external project
+set(UMF_CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+
+list(APPEND CMAKE_MODULE_PATH "${UMF_CMAKE_SOURCE_DIR}/cmake")
+include(helpers)
+
+# CMAKE_PROJECT_VERSION[.MAJOR|MINOR|PATCH] is set via 'project' command - it
+# cannot contain any "pre-release" part, though. We use custom "UMF_SRC_VERSION"
+# to store more accurate version - this var should be used, e.g., for creating
+# packages.
+set_source_version()
+message(
+    STATUS
+        "UMF version: ${CMAKE_PROJECT_VERSION} (source version: ${UMF_SRC_VERSION})"
+)
+
 # Build Options
 option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" OFF)
 option(UMF_BUILD_LEVEL_ZERO_PROVIDER "Build Level Zero memory provider" ON)
@@ -109,12 +125,6 @@ include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)
 find_package(PkgConfig)
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
-include(helpers)
-
-# needed when UMF is used as an external project
-set(UMF_CMAKE_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
-
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_UMF_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

cmake/helpers.cmake

@@ -10,6 +10,70 @@
 include(CheckCCompilerFlag)
 include(CheckCXXCompilerFlag)
 
+# src version shows the current version, as reported by 'git describe', unless
+# 'git' is not available, then fall back to the top-level defined version
+function(set_source_version)
+    execute_process(
+        COMMAND git describe --always
+        OUTPUT_VARIABLE GIT_VERSION
+        WORKING_DIRECTORY ${UMF_CMAKE_SOURCE_DIR}
+        OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
+
+    if(GIT_VERSION)
+        # 1.5.0 - we're on a tag
+        string(REGEX MATCHALL "\^([0-9]+\.[0-9]+\.[0-9]+)\$" MATCHES
+                     ${GIT_VERSION})
+        if(MATCHES)
+            set(UMF_SRC_VERSION
+                "${CMAKE_MATCH_1}"
+                PARENT_SCOPE)
+            return()
+        endif()
+
+        # 1.5.0-rc1 - we're on a RC tag
+        string(REGEX MATCHALL "\^([0-9]+\.[0-9]+\.[0-9]+\-rc[0-9]+)\$" MATCHES
+                     ${GIT_VERSION})
+        if(MATCHES)
+            set(UMF_SRC_VERSION
+                "${CMAKE_MATCH_1}"
+                PARENT_SCOPE)
+            return()
+        endif()
+
+        # 1.5.0-rc1-19-gb8f78a329 -> 1.5.0-rc1.git19.gb8f78a329
+        string(REGEX MATCHALL "([0-9.]*)-rc([0-9]*)-([0-9]*)-([0-9a-g]*)"
+                     MATCHES ${GIT_VERSION})
+        if(MATCHES)
+            set(UMF_SRC_VERSION
+                "${CMAKE_MATCH_1}-rc${CMAKE_MATCH_2}.git${CMAKE_MATCH_3}.${CMAKE_MATCH_4}"
+                PARENT_SCOPE)
+            return()
+        endif()
+
+        # 1.5.0-19-gb8f78a329 -> 1.5.0-git19.gb8f78a329
+        string(REGEX MATCHALL "([0-9.]*)-([0-9]*)-([0-9a-g]*)" MATCHES
+                     ${GIT_VERSION})
+        if(MATCHES)
+            set(UMF_SRC_VERSION
+                "${CMAKE_MATCH_1}-git${CMAKE_MATCH_2}.${CMAKE_MATCH_3}"
+                PARENT_SCOPE)
+            return()
+        endif()
+
+        # no full version is available (e.g. only a hash commit) or a pattern
+        # was not recognized
+        set(UMF_SRC_VERSION
+            "${CMAKE_PROJECT_VERSION}.git.${GIT_VERSION}"
+            PARENT_SCOPE)
+    else()
+        # git reported no version. Use version set up in the top-level CMake
+        # with a "devel" suffix
+        set(UMF_SRC_VERSION
+            "${CMAKE_PROJECT_VERSION}-devel"
+            PARENT_SCOPE)
+    endif()
+endfunction()
+
 # Sets ${ret} to version of program specified by ${name} in major.minor format
 function(get_program_version_major_minor name ret)
     execute_process(

src/CMakeLists.txt

@@ -114,8 +114,9 @@ if(UMF_BUILD_SHARED_LIBRARY)
         WINDOWS_DEF_FILE ${CMAKE_CURRENT_SOURCE_DIR}/libumf.def)
     set(UMF_PRIVATE_COMPILE_DEFINITIONS ${UMF_PRIVATE_COMPILE_DEFINITIONS}
                                         "UMF_SHARED_LIBRARY")
-    set_target_properties(umf PROPERTIES RUNTIME_OUTPUT_DIRECTORY
-                                         ${CMAKE_UMF_OUTPUT_DIRECTORY})
+    set_target_properties(
+        umf PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_UMF_OUTPUT_DIRECTORY}
+                       VERSION ${CMAKE_PROJECT_VERSION})
 else()
     add_umf_library(
         NAME umf