Add version header

jeremy-rifkin · Dec 21, 2024 · 1f6a059 · 1f6a059
1 parent 2a960b1
commit 1f6a059
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -133,6 +133,11 @@ target_compile_options(
   ${warning_options}
 )
 
+set(LIBASSERT_VERSION_MAJOR ${CMAKE_PROJECT_VERSION_MAJOR})
+set(LIBASSERT_VERSION_MINOR ${CMAKE_PROJECT_VERSION_MINOR})
+set(LIBASSERT_VERSION_PATCH ${CMAKE_PROJECT_VERSION_PATCH})
+configure_file("${PROJECT_SOURCE_DIR}/cmake/in/version-hpp.in" "${PROJECT_BINARY_DIR}/include/libassert/version.hpp")
+
 # ---- Generate Build Info Headers ----
 
 # used in export header generated below

diff --git a/README.md b/README.md
@@ -35,6 +35,7 @@
   - [Custom Failure Handlers](#custom-failure-handlers-1)
   - [Breakpoints](#breakpoints)
   - [Other Configurations](#other-configurations)
+  - [Library Version](#library-version)
 - [Integration with Test Libraries](#integration-with-test-libraries)
   - [Catch2](#catch2)
   - [GoogleTest](#googletest)
@@ -788,6 +789,10 @@ gcc 10 and the library can surpress that warning for gcc 12. <!-- https://godbol
 - `LIBASSERT_USE_EXTERNAL_CPPTRACE`: Use an externam cpptrace instead of aquiring the library with FetchContent
 - `LIBASSERT_USE_EXTERNAL_MAGIC_ENUM`: Use an externam magic enum instead of aquiring the library with FetchContent
 
+## Library Version
+
+`<libassert/version.hpp>` provides version macros for the library.
+
 # Integration with Test Libraries
 
 > [!NOTE]

diff --git a/cmake/InstallRules.cmake b/cmake/InstallRules.cmake
@@ -5,6 +5,7 @@ include(CMakePackageConfigHelpers)
 install(
   DIRECTORY
   "${PROJECT_SOURCE_DIR}/include/"     # our header files
+  "${PROJECT_BINARY_DIR}/include/"     # generated header files
   DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
   COMPONENT ${package_name}-development
 )

diff --git a/cmake/in/version-hpp.in b/cmake/in/version-hpp.in
@@ -0,0 +1,10 @@
+#ifndef LIBASSERT_VERSION_HPP
+#define LIBASSERT_VERSION_HPP
+
+#define LIBASSERT_VERSION_MAJOR @LIBASSERT_VERSION_MAJOR@
+#define LIBASSERT_VERSION_MINOR @LIBASSERT_VERSION_MINOR@
+#define LIBASSERT_VERSION_PATCH @LIBASSERT_VERSION_PATCH@
+#define LIBASSERT_TO_VERSION(MAJOR, MINOR, PATCH) ((MAJOR) * 10000 + (MINOR) * 100 + (PATCH))
+#define LIBASSERT_VERSION LIBASSERT_TO_VERSION(LIBASSERT_VERSION_MAJOR, LIBASSERT_VERSION_MINOR, LIBASSERT_VERSION_PATCH)
+
+#endif
diff --git a/tests/demo/demo.cpp b/tests/demo/demo.cpp
@@ -18,6 +18,7 @@
 #include <vector>
 
 #include <libassert/assert.hpp>
+#include <libassert/version.hpp>
 
 #define ESC "\033["
 #define RED ESC "1;31m"