feat: add git tools module

Signed-off-by: msclock <[email protected]>

cmake/configure/Common.cmake

@@ -8,12 +8,11 @@ include_guard(GLOBAL)
 Show project version friendly
 ]]
 macro(show_project_version)
-  message(STATUS "PROJECT_VRESION finally:${PROJECT_VERSION}")
+  message(STATUS "CMAKE_PROJECT_VERSION finally:${CMAKE_PROJECT_VERSION}")
   message(STATUS "CMAKE_PROJECT_VERSION_MAJOR: ${CMAKE_PROJECT_VERSION_MAJOR}")
   message(STATUS "CMAKE_PROJECT_VERSION_MINOR: ${CMAKE_PROJECT_VERSION_MINOR}")
   message(STATUS "CMAKE_PROJECT_VERSION_PATCH: ${CMAKE_PROJECT_VERSION_PATCH}")
   message(STATUS "CMAKE_PROJECT_VERSION_TWEAK: ${CMAKE_PROJECT_VERSION_TWEAK}")
-  message(STATUS "CMAKE_PROJECT_VERSION finally:${CMAKE_PROJECT_VERSION}")
 endmacro()
 
 #[[

cmake/configure/FindSphinx.cmake

@@ -220,13 +220,11 @@ function(_sphinx_generate_conf_py _target _cachedir)
   endif()
 
   if(NOT DEFINED SPHINX_VERSION)
-    set(SPHINX_VERSION
-        "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
-    )
+    set(SPHINX_VERSION "${CMAKE_PROJECT_VERSION}")
   endif()
 
   if(NOT DEFINED SPHINX_RELEASE)
-    set(SPHINX_RELEASE "${PROJECT_VERSION}")
+    set(SPHINX_RELEASE "${CMAKE_PROJECT_VERSION}")
   endif()
 
   if(NOT DEFINED SPHINX_LANGUAGE)

cmake/configure/GitTools.cmake

@@ -0,0 +1,317 @@
+#[[
+This module provides some git stuffs.
+]]
+
+include_guard(GLOBAL)
+
+#[[
+A function to generate a git version header using the current
+project git meta.
+
+Arguments:
+  CONFIGURE_HEADER_FILE - git header configuration content.
+    Default to ${CMAKE_BINARY_DIR}/git/git.h.in (optional)
+  DESTINATION - git header destination to generate.
+    Default to ${CMAKE_BINARY_DIR}/git/include/git.h (optional)
+
+Example:
+
+  include(GitTools)
+  gennerate_git_header()
+  add_library(header INTERFACE)
+  target_include_interface_directories(header ${CMAKE_BINARY_DIR}/git/include)
+  target_link_libraries(header INTERFACE absl::log)
+  install_target(
+    NAME
+    header
+    VERSION
+    ${CMAKE_PROJECT_VERSION}
+    TARGETS
+    header
+    INCLUDES
+    ${CMAKE_BINARY_DIR}/git/include/)
+
+]]
+function(generate_git_header)
+  set(_opts)
+  set(_single_opts CONFIGURE_HEADER_FILE DESTINATION)
+  set(_multi_opts)
+  cmake_parse_arguments(arg "${_opts}" "${_single_opts}" "${_multi_opts}"
+                        ${ARGN})
+
+  if(NOT arg_DESTINATION)
+    set(arg_DESTINATION ${CMAKE_BINARY_DIR}/git/include/git.h)
+  endif()
+
+  if(NOT arg_CONFIGURE_HEADER_FILE)
+    set(_configure_git_header_content
+        "#pragma once
+// git.h
+// https://raw.githubusercontent.com/andrew-hardin/cmake-git-version-tracking/master/git.h
+//
+// Released under the MIT License.
+// https://raw.githubusercontent.com/andrew-hardin/cmake-git-version-tracking/master/LICENSE
+
+#include <stdbool.h>
+
+#ifdef __cplusplus
+#define GIT_EXTERN_C_BEGIN                extern \"C\" {
+#define GIT_VERSION_TRACKING_EXTERN_C_END }
+#else
+#define GIT_EXTERN_C_BEGIN
+#define GIT_VERSION_TRACKING_EXTERN_C_END
+#endif
+
+// Don't mangle the C function names if included in a CXX file.
+GIT_EXTERN_C_BEGIN
+
+/// The commit project version.
+const char* git_ProjectVersion() {
+    return R\"(@CMAKE_PROJECT_VERSION@)\"\;
+}
+
+/// The commit project version major.
+const char* git_ProjectVersionMajor() {
+    return R\"(@CMAKE_PROJECT_VERSION_MAJOR@)\"\;
+}
+
+/// The commit project version minor.
+const char* git_ProjectVersionMinor() {
+    return R\"(@CMAKE_PROJECT_VERSION_MINOR@)\"\;
+}
+
+/// The commit project version patch.
+const char* git_ProjectVersionPatch() {
+    return R\"(@CMAKE_PROJECT_VERSION_PATCH@)\"\;
+}
+
+/// The commit project version tweak.
+const char* git_ProjectVersionTweak() {
+    return R\"(@CMAKE_PROJECT_VERSION_TWEAK@)\"\;
+}
+
+/// The commit author's name.
+const char* git_AuthorName() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_AUTHOR_NAME@)\"\;
+}
+
+/// The commit author's email.
+const char* git_AuthorEmail() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_AUTHOR_EMAIL@)\"\;
+}
+
+/// The commit last tag.
+const char* git_CommitTag() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_TAG@)\"\;
+}
+
+/// The commit number since last tag.
+const char* git_CommitTagRevision() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_TAG_REVISION@)\"\;
+}
+
+/// The commit number.
+const char* git_CommitRevision() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_REVISION@)\"\;
+}
+
+/// The commit number of the day.
+const char* git_CommitDateRevision() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_DATE_REVISION@)\"\;
+}
+
+/// The commit SHA1.
+const char* git_CommitSHA1() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_HASH@)\"\;
+}
+
+/// The commit short SHA1.
+const char* git_CommitSHA1Short() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_HASH_SHORT@)\"\;
+}
+
+/// The commit date.
+const char* git_CommitDate() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_AUTHOR_DATE@)\"\;
+}
+
+/// The commit time.
+const char* git_CommitTime() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_AUTHOR_TIME@)\"\;
+}
+
+/// The commit TZ.
+const char* git_CommitTZ() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_AUTHOR_TZ@)\"\;
+}
+
+/// The commit subject.
+const char* git_CommitSubject() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_SUBJECT@)\"\;
+}
+
+/// The commit body.
+const char* git_CommitBody() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_BODY@)\"\;
+}
+
+/// The commit describe.
+const char* git_Describe() {
+    return R\"(@CMAKE_PROJECT_GIT_COMMIT_DESCRIBE@)\"\;
+}
+
+GIT_VERSION_TRACKING_EXTERN_C_END
+#undef GIT_EXTERN_C_BEGIN
+#undef GIT_VERSION_TRACKING_EXTERN_C_END
+
+#ifdef __cplusplus
+
+/// This is a utility extension for C++ projects.
+/// It provides a \"git\" namespace that wraps the
+/// C methods in more(?) ergonomic types.
+///
+/// This is header-only in an effort to keep the
+/// underlying static library C99 compliant.
+
+// We really want to use std::string_view if it appears
+// that the compiler will support it. If that fails,
+// revert back to std::string.
+#define GIT_VERSION_CPP_17_STANDARD 201703L
+#if __cplusplus >= GIT_VERSION_CPP_17_STANDARD
+#define GIT_VERSION_USE_STRING_VIEW 1
+#else
+#define GIT_VERSION_USE_STRING_VIEW 0
+#endif
+
+#if GIT_VERSION_USE_STRING_VIEW
+#include <cstring>
+#include <string_view>
+#else
+#include <string>
+#endif
+
+namespace git {
+
+#if GIT_VERSION_USE_STRING_VIEW
+using StringOrView = std::string_view\;
+#else
+typedef std::string StringOrView\;
+#endif
+
+namespace internal {
+
+/// Short-hand method for initializing a std::string or std::string_view given a C-style const char*.
+inline const StringOrView InitString(const char* from_c_interface) {
+#if GIT_VERSION_USE_STRING_VIEW
+    return StringOrView{from_c_interface, std::strlen(from_c_interface)}\;
+#else
+    return std::string(from_c_interface)\;
+#endif
+}
+
+} // namespace internal
+
+inline const StringOrView& ProjectVersion() {
+  static const StringOrView kValue = internal::InitString(git_ProjectVersion())\;
+  return kValue\;
+}
+inline const StringOrView& ProjectVersionMajor() {
+  static const StringOrView kValue = internal::InitString(git_ProjectVersionMajor())\;
+  return kValue\;
+}
+inline const StringOrView& ProjectVersionMinor() {
+  static const StringOrView kValue = internal::InitString(git_ProjectVersionMinor())\;
+  return kValue\;
+}
+inline const StringOrView& ProjectVersionPatch() {
+  static const StringOrView kValue = internal::InitString(git_ProjectVersionPatch())\;
+  return kValue\;
+}
+inline const StringOrView& ProjectVersionTweak() {
+  static const StringOrView kValue = internal::InitString(git_ProjectVersionTweak())\;
+  return kValue\;
+}
+inline const StringOrView& AuthorName() {
+    static const StringOrView kValue = internal::InitString(git_AuthorName())\;
+    return kValue\;
+}
+inline const StringOrView AuthorEmail() {
+    static const StringOrView kValue = internal::InitString(git_AuthorEmail())\;
+    return kValue\;
+}
+inline const StringOrView CommitTag() {
+  static const StringOrView kValue = internal::InitString(git_CommitTag())\;
+  return kValue\;
+}
+inline const StringOrView CommitTagRevision() {
+  static const StringOrView kValue = internal::InitString(git_CommitTagRevision())\;
+  return kValue\;
+}
+inline const StringOrView CommitRevision() {
+  static const StringOrView kValue = internal::InitString(git_CommitRevision())\;
+  return kValue\;
+}
+inline const StringOrView CommitDateRevision() {
+  static const StringOrView kValue = internal::InitString(git_CommitDateRevision())\;
+  return kValue\;
+}
+inline const StringOrView CommitSHA1() {
+    static const StringOrView kValue = internal::InitString(git_CommitSHA1())\;
+    return kValue\;
+}
+inline const StringOrView CommitSHA1Short() {
+  static const StringOrView kValue = internal::InitString(git_CommitSHA1Short())\;
+  return kValue\;
+}
+inline const StringOrView CommitDate() {
+    static const StringOrView kValue = internal::InitString(git_CommitDate())\;
+    return kValue\;
+}
+inline const StringOrView CommitTime() {
+  static const StringOrView kValue = internal::InitString(git_CommitTime())\;
+  return kValue\;
+}
+inline const StringOrView CommitTZ() {
+  static const StringOrView kValue = internal::InitString(git_CommitTZ())\;
+  return kValue\;
+}
+inline const StringOrView CommitSubject() {
+    static const StringOrView kValue = internal::InitString(git_CommitSubject())\;
+    return kValue\;
+}
+inline const StringOrView CommitBody() {
+    static const StringOrView kValue = internal::InitString(git_CommitBody())\;
+    return kValue\;
+}
+inline const StringOrView Describe() {
+    static const StringOrView kValue = internal::InitString(git_Describe())\;
+    return kValue\;
+}
+
+} // namespace git
+
+// Cleanup our defines to avoid polluting.
+#undef GIT_VERSION_USE_STRING_VIEW
+#undef GIT_VERSION_CPP_17_STANDARD
+
+#endif // __cplusplus
+")
+
+    set(arg_CONFIGURE_HEADER_FILE ${CMAKE_BINARY_DIR}/git/git.h.in)
+    file(WRITE ${arg_CONFIGURE_HEADER_FILE} ${_configure_git_header_content})
+  endif()
+
+  configure_file("${arg_CONFIGURE_HEADER_FILE}" "${arg_DESTINATION}" @ONLY)
+
+  get_filename_component(arg_DESTINATION_PATH ${arg_DESTINATION} DIRECTORY)
+
+  message(
+    STATUS
+      "Generated git header including project metadata in ${arg_DESTINATION} from ${arg_CONFIGURE_HEADER_FILE}
+  Usage:
+    include_directories(${arg_DESTINATION_PATH})
+    # Or
+    target_include_directories(${arg_DESTINATION_PATH})
+    # Or refer to https://github.com/msclock/cmake-modules/blob/master/cmake/configure/Common.cmake
+    target_include_interface_directories(${arg_DESTINATION_PATH})")
+endfunction()

cmake/install/Common.cmake

@@ -45,7 +45,7 @@ Example:
     NAME
     header
     VERSION
-    ${PROJECT_VERSION}
+    ${CMAKE_PROJECT_VERSION}
     INCLUDES
     ${CMAKE_CURRENT_SOURCE_DIR}/include/ # install subdirectories with /
     TARGETS