Refactor: separate cmake tools/options + setup docs generation

ramsafin · ramsafin · commit a1b763b10678 · 2025-06-27T17:52:41.000+03:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -7,7 +7,7 @@ on:
   push:
     branches: [master]
     paths:
-      - 'Doxyfile'
+      - 'docs/Doxyfile.in'
       - 'include/**/*.hpp'
       - 'src/**/*.cpp'
       - '.github/workflows/docs.yml'
@@ -25,7 +25,7 @@ jobs:
       - name: Set up CMake + Doxygen dependencies
         run: |
           sudo apt update
-          sudo apt install -y cmake doxygen graphviz ninja-build
+          sudo apt install -y doxygen graphviz cmake ninja-build g++ gcc
 
       - name: Configure project with CMake Preset
         run: cmake --preset gcc-RelWithDebInfo
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ cmake_install.cmake
 Makefile
 compile_commands.json
 install/
+!cmake/install
 
 # === Ninja build ===
 *.ninja
@@ -51,5 +52,5 @@ test_output/
 
 # === Docs ===
 docs/*
+!docs/Doxyfile.in
 !docs/mainpage.md
-
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -18,15 +18,16 @@ if(CMAKE_CONFIGURATION_TYPES)
   set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING "" FORCE)
 endif()
 
-# Load cmake modules: sanitizers, warnings, lto
+# Load cmake modules
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
-include(LTO)
-include(Warnings)
-include(Sanitizers)
+# Warnings, sanitizers, Link Time Optimiziatiion (LTO)
+include(options/LTO)
+include(options/Warnings)
+include(options/Sanitizers)
 
 # === Libraries ===
-add_subdirectory(src)
+add_subdirectory(src) # modern_cpp_template::math
 
 # === Application ===
 add_executable(${PROJECT_NAME}
@@ -41,72 +42,14 @@ enable_lto(${PROJECT_NAME})
 enable_sanitizers(${PROJECT_NAME})
 enable_strict_warnings(${PROJECT_NAME})
 
-# === Unit Testing ===
+# === Tests ===
 if(ENABLE_TESTING)
   enable_testing()
   add_subdirectory(tests)
 endif()
 
-# === Installtion ===
-include(GNUInstallDirs)
-include(CMakePackageConfigHelpers)
+# === Docs ===
+include(tools/Doxygen)
 
-install(TARGETS math
-  EXPORT ${PROJECT_NAME}Targets
-  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-  INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-)
-
-install(
-  DIRECTORY ${CMAKE_SOURCE_DIR}/include/
-  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-)
-
-# Export the targets to a file
-install(
-  EXPORT ${PROJECT_NAME}Targets
-  NAMESPACE ${PROJECT_NAME}::
-  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-)
-
-# Configure a version file
-write_basic_package_version_file(
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-  VERSION ${PROJECT_VERSION}
-  COMPATIBILITY SameMajorVersion
-)
-
-# Configure the main config file
-configure_package_config_file(
-  "${CMAKE_SOURCE_DIR}/cmake/Config.cmake.in"
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-)
-
-# Install the config + version
-install(FILES
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
-)
-
-# === Documentation ===
-find_package(Doxygen QUIET)
-
-if(DOXYGEN_FOUND)
-  set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
-  set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.generated)
-
-  configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
-
-  add_custom_target(docs
-    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-    COMMENT "Generating API documentation with Doxygen"
-    VERBATIM
-  )
-else()
-  message(STATUS "Doxygen not found. 'docs' target will not be available.")
-endif()
+# === Installation ===
+include(install/InstallConfig)
diff --git a/cmake/install/Config.cmake.in b/cmake/install/Config.cmake.in
diff --git a/cmake/install/InstallConfig.cmake b/cmake/install/InstallConfig.cmake
@@ -0,0 +1,47 @@
+# Enables standard install paths: lib/, include/, bin/, etc.
+include(GNUInstallDirs)
+
+# Provides helpers for writing version/config files
+include(CMakePackageConfigHelpers)
+
+# Install compiled library (static or shared)
+install(TARGETS math
+  EXPORT ${PROJECT_NAME}Targets               # export target for find_package
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} # static libs
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} # shared libs
+  INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+# Install public headers (recursive copy of include/)
+install(
+  DIRECTORY ${CMAKE_SOURCE_DIR}/include/
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+# Install target exports as <project>Targets.cmake
+install(
+  EXPORT ${PROJECT_NAME}Targets
+  NAMESPACE ${PROJECT_NAME}::  # enables find_package to use <project>::<library>
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+)
+
+# Generate a <project>ConfigVersion.cmake file
+write_basic_package_version_file(
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+  VERSION ${PROJECT_VERSION}
+  COMPATIBILITY SameMajorVersion # enforces semantic versioning: X.*
+)
+
+# Generate <project>Config.cmake from a template
+configure_package_config_file(
+  "${CMAKE_SOURCE_DIR}/cmake/install/Config.cmake.in"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+)
+
+# Install config files
+install(FILES
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
+)
diff --git a/cmake/options/LTO.cmake b/cmake/options/LTO.cmake
@@ -1,6 +1,9 @@
+# Apply LTO to a specific target
 function(enable_lto target)
   if(CMAKE_INTERPROCEDURAL_OPTIMIZATION)
     set_property(TARGET ${target} PROPERTY INTERPROCEDURAL_OPTIMIZATION TRUE)
     message(STATUS "🔧\tEnabled LTO for target ${target}")
+  else()
+    message(STATUS "ℹ️\tCMAKE_INTERPROCEDURAL_OPTIMIZATION not enabled globally. Skipping LTO for target ${target}")
   endif()
 endfunction()
diff --git a/cmake/options/Sanitizers.cmake b/cmake/options/Sanitizers.cmake
@@ -1,3 +1,4 @@
+# Define sanitizer flags only in Sanitize build type
 if(CMAKE_BUILD_TYPE STREQUAL "Sanitize")
   set(SANITIZER_FLAGS
     -fsanitize=address
@@ -8,10 +9,13 @@ if(CMAKE_BUILD_TYPE STREQUAL "Sanitize")
   message(STATUS "✅\tSanitize build enabled with flags: ${SANITIZER_FLAGS}")
 endif()
 
+# Apply sanitizer flags to a specific target
 function(enable_sanitizers target)
   if(CMAKE_BUILD_TYPE STREQUAL "Sanitize")
     target_compile_options(${target} PRIVATE ${SANITIZER_FLAGS})
     target_link_options(${target} PRIVATE ${SANITIZER_FLAGS})
     message(STATUS "✅\tEnabled sanitizers for target ${target}")
+  else()
+    message(STATUS "ℹ️\tSkipping sanitizers for target: ${target} (build type: ${CMAKE_BUILD_TYPE})")
   endif()
 endfunction()
diff --git a/cmake/options/Warnings.cmake b/cmake/options/Warnings.cmake
@@ -1,3 +1,4 @@
+# Applies standard warning flags (-Wall, -Wextra, etc.)
 function(enable_warnings target)
   if(CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
     target_compile_options(${target} PRIVATE
@@ -8,9 +9,12 @@ function(enable_warnings target)
       -Wsign-conversion
     )
     message(STATUS "⚠️\tEnabled warnings for target ${target}")
+  else()
+    message(STATUS "Skipping warnings: unsupported compiler ${CMAKE_CXX_COMPILER_ID}")
   endif()
 endfunction()
 
+# Applies warnings and treats them as errors (-Werror)
 function(enable_strict_warnings target)
   enable_warnings(${target})
   target_compile_options(${target} PRIVATE -Werror)
diff --git a/cmake/tools/ClangFormat.cmake b/cmake/tools/ClangFormat.cmake
diff --git a/cmake/tools/ClangTidy.cmake b/cmake/tools/ClangTidy.cmake
diff --git a/cmake/tools/Doxygen.cmake b/cmake/tools/Doxygen.cmake
@@ -0,0 +1,27 @@
+find_package(Doxygen QUIET)
+
+if(DOXYGEN_FOUND)
+  set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
+  set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.generated)
+  set(DOXYGEN_OUTPUT_DIR ${CMAKE_BINARY_DIR}/docs/html)
+
+  if(EXISTS ${DOXYGEN_IN})
+    # Ensure output directory exists
+    file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
+
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+
+    add_custom_target(docs
+      COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+      COMMENT "Generating API documentation with Doxygen"
+      VERBATIM
+    )
+    set_target_properties(docs PROPERTIES FOLDER "Documentation")
+    message(STATUS "ℹ️\t'docs' target is available. Output: ${DOXYGEN_OUTPUT_DIR}")
+  else()
+    message(WARNING "Doxygen file not found: ${DOXYGEN_IN}")
+  endif()
+else()
+  message(STATUS "⚠️\tDoxygen not found. 'docs' target will not be available.")
+endif()
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -68,7 +68,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs
+OUTPUT_DIRECTORY       = @DOXYGEN_OUTPUT_DIR@
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = docs/mainpage.md include/ src/
+INPUT                  = @CMAKE_SOURCE_DIR@/include @CMAKE_SOURCE_DIR@/src @CMAKE_SOURCE_DIR@/docs/mainpage.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
