Refactor QtADS Version To Auto-Generate ads_version.h

.gitignore

@@ -10,6 +10,7 @@ Makefile
 *.dll
 *.a
 build*
+ads_version.h
 
 # IDEs
 .idea

CMakeLists.txt

@@ -4,39 +4,10 @@ if (POLICY CMP0091)
   cmake_policy(SET CMP0091 NEW)
 endif (POLICY CMP0091)
 
-# Add cmake modules path (required for Versioning.cmake and git revision description)
+# Add cmake modules path (required for Versioning.cmake)
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules ${CMAKE_MODULE_PATH})
 
-# By default, the version information is extracted from the git index. However,
-# we can override this behavior by explicitly setting ADS_VERSION and
-# skipping the git checks. This is useful for cases where this project is being
-# used independently of its original git repo (e.g. vendored in another project)
-if(NOT ADS_VERSION)
-    include(GetGitRevisionDescription)
-    git_describe(GitTagVersion --tags)
-    string(REGEX REPLACE "^([0-9]+)\\..*" "\\1" VERSION_MAJOR "${GitTagVersion}")
-    string(REGEX REPLACE "^[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${GitTagVersion}")
-    string(REGEX REPLACE "^[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${GitTagVersion}")
-    set(VERSION_SHORT "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
-    set(VERSION_SONAME "${VERSION_MAJOR}")
-else()
-    string(REGEX MATCHALL "[\.]" VERSION_DOT_MATCHES ${ADS_VERSION})
-    list(LENGTH VERSION_DOT_MATCHES VERSION_DOT_COUNT)
-    if(VERSION_DOT_COUNT EQUAL 2)
-        set(VERSION_SHORT ${ADS_VERSION})
-        string(REGEX REPLACE "^([0-9]+)\\..*" "\\1" VERSION_SONAME "${ADS_VERSION}")
-        # Set PROJECT_VERSION_* variables for Versioning.cmake
-        string(REGEX MATCHALL "[0-9]+" VERSION_PARTS "${ADS_VERSION}")
-        list(GET VERSION_PARTS 0 PROJECT_VERSION_MAJOR)
-        list(GET VERSION_PARTS 1 PROJECT_VERSION_MINOR)
-        list(GET VERSION_PARTS 2 PROJECT_VERSION_PATCH)
-    else()
-        message(FATAL_ERROR "ADS_VERSION must be in major.minor.patch format, e.g. 3.8.1. Got ${ADS_VERSION}")
-    endif()
-endif()
-
-
-project(QtADS LANGUAGES CXX VERSION ${VERSION_SHORT})
+project(QtADS LANGUAGES CXX VERSION 5.0.0)
 
 option(BUILD_STATIC "Build the static library" OFF)
 option(BUILD_EXAMPLES "Build the examples" ON)

cmake/modules/FileVersionInfo.rc.in

@@ -13,12 +13,11 @@ BEGIN
     BEGIN
         BLOCK "040904b0"
         BEGIN
-            VALUE "CompanyName",      "My Company\0"
+            VALUE "CompanyName",      "N/A\0"
+            VALUE "ProductName",      "@PROJECT_NAME@\0"
             VALUE "FileDescription",  "@PROJECT_NAME@\0"
-            VALUE "FileVersion",      "@PROJECT_VERSION_STRING@\0"
-            VALUE "ProductVersion",   "@PROJECT_VERSION_STRING@\0"
-            VALUE "GitCommitFull",    "@PROJECT_GIT_HASH@\0"
-            VALUE "GitCommitShort",   "@PROJECT_GIT_HASH_SHORT@\0"
+            VALUE "FileVersion",      "@PROJECT_VERSION@\0"
+            VALUE "ProductVersion",   "@PROJECT_VERSION@\0"
         END
     END
 

cmake/modules/Versioning.cmake

@@ -8,58 +8,32 @@
 set(_VERSIONING_MODULE_DIR "${CMAKE_CURRENT_LIST_DIR}" CACHE INTERNAL "Versioning module directory")
 
 # ------------------------------------------------------------
-# Extract version information from Git or use predefined version
+# Function: Generates the required version header for the ADS
+# library.  Should only be called by the ADS library target.
 # ------------------------------------------------------------
-if(NOT DEFINED PROJECT_VERSION_MAJOR OR NOT DEFINED PROJECT_VERSION_MINOR OR NOT DEFINED PROJECT_VERSION_PATCH)
-    # Get tag (expected: v1.2.3 or 1.2.3 or 1.2.3-12-gHASH)
-    execute_process(
-        COMMAND git describe --tags --dirty
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE GIT_DESC_RAW
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-    )
-
-    # Remove leading "v" if present
-    string(REGEX REPLACE "^v" "" GIT_DESC "${GIT_DESC_RAW}")
-
-    # Extract major.minor.patch
-    string(REGEX MATCH "^([0-9]+)\\.([0-9]+)\\.([0-9]+)" _ "${GIT_DESC}")
-    set(PROJECT_VERSION_MAJOR "${CMAKE_MATCH_1}")
-    set(PROJECT_VERSION_MINOR "${CMAKE_MATCH_2}")
-    set(PROJECT_VERSION_PATCH "${CMAKE_MATCH_3}")
-
-
-
-    # Commit hash (full + short)
-    execute_process(
-        COMMAND git rev-parse HEAD
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE PROJECT_GIT_HASH
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-    )
-
-    execute_process(
-        COMMAND git rev-parse --short HEAD
-        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-        OUTPUT_VARIABLE PROJECT_GIT_HASH_SHORT
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-    )
-endif()
-
-set(PROJECT_VERSION_STRING
-    "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
-)
-
-# Export variables to 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)
-set(PROJECT_VERSION_STRING "${PROJECT_VERSION_STRING}" PARENT_SCOPE)
-set(PROJECT_GIT_HASH "${PROJECT_GIT_HASH}" PARENT_SCOPE)
-set(PROJECT_GIT_HASH_SHORT "${PROJECT_GIT_HASH_SHORT}" PARENT_SCOPE)
+function(generate_ads_version_header)
+    # configure ads_version.h from ads_version.h.in
+    if(NOT DEFINED QtADS_VERSION_MAJOR OR
+       NOT DEFINED QtADS_VERSION_MINOR OR
+       NOT DEFINED QtADS_VERSION_PATCH)
+        message(
+            FATAL_ERROR
+            "ADS major, minor, or patch version variables not defined!")
+    endif()
 
-# Public variable for users
-set(PROJECT_AUTO_VERSION "${PROJECT_VERSION_STRING}" PARENT_SCOPE)
+    string(TIMESTAMP QtADS_AUTO_GEN_DATE "%d.%m.%Y")
+
+    if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/ads_globals.h")
+        message(
+            FATAL_ERROR
+            "Unable to place ads_version.h next to ads_globals.h")
+    else()
+        configure_file(
+            "${_VERSIONING_MODULE_DIR}/ads_version.h.in"
+            "${CMAKE_CURRENT_SOURCE_DIR}/ads_version.h"
+            @ONLY)
+    endif()
+endfunction()
 
 # ------------------------------------------------------------
 # Reusable function: Attach Windows version resources to target