自动生成版本号

Author: 9chu

COPYRIGHT.txt

@@ -54,6 +54,11 @@ Comment: Documents for LuaSTGPlus Danmaku Game Engine
 Copyright: 2022, 9chu.
 License: CC-BY-NC-SA-4.0
 
+Files: ./cmake/GenerateVersionHeader.cmake
+Comment: https://github.com/nocnokneo/cmake-git-versioning-example
+Copyright: 2021, Taylor Braun-Jones.
+License: Expat
+
 Files: ./include/lstg/Core/Math/Collider2D/IntersectCheck.hpp
 Comment: https://github.com/Xrysnow/lstgx_Math
 Copyright: 2018, Xrysnow.

cmake/GenerateVersionHeader.cmake

@@ -0,0 +1,22 @@
+if(GIT_EXECUTABLE)
+    get_filename_component(SRC_DIR ${SRC} DIRECTORY)
+    # Generate a git-describe version string from Git repository tags
+    execute_process(
+        COMMAND ${GIT_EXECUTABLE} describe --tags --dirty --match "v*"
+        WORKING_DIRECTORY ${SRC_DIR}
+        OUTPUT_VARIABLE GIT_DESCRIBE_VERSION
+        RESULT_VARIABLE GIT_DESCRIBE_ERROR_CODE
+        OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(NOT GIT_DESCRIBE_ERROR_CODE)
+        set(LSTG_VERSION ${GIT_DESCRIBE_VERSION})
+    endif()
+endif()
+
+# Final fallback: Just use a bogus version string that is semantically older
+# than anything else and spit out a warning to the developer.
+if(NOT DEFINED LSTG_VERSION)
+    set(LSTG_VERSION v0.0.0-unknown)
+    message(WARNING "Failed to determine LSTG_VERSION from Git tags. Using default version \"${LSTG_VERSION}\".")
+endif()
+
+configure_file(${SRC} ${DST} @ONLY)

src/v2/CMakeLists.txt

@@ -1,3 +1,12 @@
+### 生成版本号信息
+
+find_package(Git)
+add_custom_target(LuaSTGPlus2Version
+    ${CMAKE_COMMAND} -D SRC=${CMAKE_CURRENT_SOURCE_DIR}/Version.hpp.in
+    -D DST=${CMAKE_CURRENT_BINARY_DIR}/Version.hpp
+    -D GIT_EXECUTABLE=${GIT_EXECUTABLE}
+    -P ${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/GenerateVersionHeader.cmake)
+
 ### 目标
 # Lua 自动封装代码
 file(GLOB_RECURSE LSTG_V2_BRIDGE_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/../../include/lstg/v2/Bridge/*.hpp)
@@ -27,6 +36,7 @@ else()
 endif()
 target_include_directories(LuaSTGPlus2 PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/../../include ${CMAKE_CURRENT_BINARY_DIR})
 target_link_libraries(LuaSTGPlus2 PUBLIC LuaSTGPlusCore SDL2main cjson imgui implot)
+add_dependencies(LuaSTGPlus2 LuaSTGPlus2Version)
 
 #set(LSTG_V2_DEFS_PRIVATE)
 #message("[LSTG-v2] Private compiler definitions: ${LSTG_V2_DEFS_PRIVATE}")

src/v2/Main.cpp

@@ -11,6 +11,9 @@
 #include <lstg/Core/Pal.hpp>
 #include <lstg/Core/Logging.hpp>
 
+// 版本信息
+#include <Version.hpp>
+
 using namespace std;
 using namespace lstg;
 using namespace lstg::v2;
@@ -23,6 +26,11 @@ SDLMAIN_DECLSPEC int main(int argc, char* argv[])
 
     // 强制日志系统初始化
     Logging::GetInstance();
+#ifdef LSTG_DEVELOPMENT
+    LSTG_LOG_INFO("Version: {} (Development mode)", LSTG_VERSION);
+#else
+    LSTG_LOG_INFO("Version: {} (Shipping mode)", LSTG_VERSION);
+#endif
 
     // 初始化 GameApp
 #ifdef LSTG_PLATFORM_EMSCRIPTEN

src/v2/Version.hpp.in

@@ -0,0 +1,2 @@
+#pragma once
+#define LSTG_VERSION "@LSTG_VERSION@"