refactor cmake configuration (#172)

* remove useless option

* cmake extract version

* add cmake option prefix

* add docs target

* fetch doxygen-css

* fetch doctest

* fetch liburing

Author: wokron

.github/workflows/ci-latest-kernel.yml

@@ -21,10 +21,8 @@ jobs:
     timeout-minutes: 30
 
     steps:
-      - name: Checkout Repository and Submodules
+      - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          submodules: true
 
       - name: Update Apt Packages
         run: sudo apt-get update
@@ -69,13 +67,13 @@ jobs:
       - name: Configure CMake
         run: |
           cmake -B ${{github.workspace}}/build \
-              -DBUILD_EXAMPLES=ON \
-              -DBUILD_BENCHMARKS=ON \
-              -DBUILD_TESTS=ON \
+              -DCONDY_BUILD_EXAMPLES=ON \
+              -DCONDY_BUILD_BENCHMARKS=ON \
+              -DCONDY_BUILD_TESTS=ON \
               -DCMAKE_C_COMPILER=clang \
               -DCMAKE_CXX_COMPILER=clang++ \
               -DCMAKE_BUILD_TYPE=Release \
-              -DTESTS_STATIC_LINK=ON
+              -DCONDY_TESTS_STATIC_LINK=ON
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build -j$(nproc)

.github/workflows/ci-main.yml

@@ -29,17 +29,8 @@ jobs:
         sanitizer: [ tsan, asan ]
 
     steps:
-      - name: Checkout Repository and Submodules
+      - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          submodules: true
-
-      - name: Checkout Liburing to Specified Version
-        run: |
-          cd ./third_party/liburing
-          git fetch --tags
-          git checkout liburing-${{ env.LIBURING_VERSION }}
-          cd ../../
 
       # GCC 15 Regression https://gcc.gnu.org/bugzilla/show_bug.cgi?id=124584
       - name: Install GCC 14
@@ -57,14 +48,15 @@ jobs:
           echo "Using compiler: $COMPILER"
           SANITIZER_FLAG=""
           if [ "${{ matrix.sanitizer }}" = "tsan" ]; then
-            SANITIZER_FLAG="-DTESTS_TSAN=ON"
+            SANITIZER_FLAG="-DCONDY_TESTS_TSAN=ON"
           elif [ "${{ matrix.sanitizer }}" = "asan" ]; then
-            SANITIZER_FLAG="-DTESTS_ASAN=ON"
+            SANITIZER_FLAG="-DCONDY_TESTS_ASAN=ON"
           fi
           cmake -B ${{github.workspace}}/build \
-              -DBUILD_EXAMPLES=ON \
-              -DBUILD_BENCHMARKS=ON \
-              -DBUILD_TESTS=ON \
+              -DCONDY_BUILD_EXAMPLES=ON \
+              -DCONDY_BUILD_BENCHMARKS=ON \
+              -DCONDY_BUILD_TESTS=ON \
+              -DCONDY_LINK_LIBURING_VERSION=${{ env.LIBURING_VERSION }} \
               $SANITIZER_FLAG \
               -DCMAKE_C_COMPILER=${{matrix.compiler.cc}} \
               -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}} \

.github/workflows/ci-static-check.yml

@@ -31,24 +31,20 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          submodules: true
-
-      - name: Configure liburing
-        run: |
-          cd third_party/liburing
-          ./configure --cc=clang --cxx=clang++
 
       - name: Configure CMake
         run: |
           cmake -B ${{github.workspace}}/build \
-              -DBUILD_EXAMPLES=ON \
-              -DBUILD_BENCHMARKS=ON \
-              -DBUILD_TESTS=ON \
+              -DCONDY_BUILD_EXAMPLES=ON \
+              -DCONDY_BUILD_BENCHMARKS=ON \
+              -DCONDY_BUILD_TESTS=ON \
               -DCMAKE_C_COMPILER=clang \
               -DCMAKE_CXX_COMPILER=clang++ \
               -DCMAKE_BUILD_TYPE=Debug \
               -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 
+      - name: Build liburing
+        run: cmake --build ${{github.workspace}}/build --target liburing_ext
+
       - name: Static Analysis
         run: bash ./scripts/check-all.sh

.github/workflows/ci-toolchain.yml

@@ -27,25 +27,17 @@ jobs:
         generator: [ "Ninja", "Unix Makefiles" ]
 
     steps:
-      - name: Checkout Repository and Submodules
+      - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          submodules: true
-
-      - name: Checkout Liburing Version
-        run: |
-          cd ./third_party/liburing
-          git fetch --tags
-          git checkout liburing-${{ matrix.liburing-version }}
-          cd ../../
 
       - name: Configure CMake
         run: |
           cmake -B ${{github.workspace}}/build \
               -G "${{ matrix.generator }}" \
-              -DBUILD_EXAMPLES=ON \
-              -DBUILD_BENCHMARKS=ON \
-              -DBUILD_TESTS=ON \
+              -DCONDY_BUILD_EXAMPLES=ON \
+              -DCONDY_BUILD_BENCHMARKS=ON \
+              -DCONDY_BUILD_TESTS=ON \
+              -DCONDY_LINK_LIBURING_VERSION=${{ matrix.liburing-version }} \
               -DCMAKE_C_COMPILER=${{ matrix.compiler.cc }} \
               -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cxx }} \
               -DCMAKE_BUILD_TYPE=Debug
@@ -66,8 +58,9 @@ jobs:
           && !(matrix.compiler.cc == 'gcc' && matrix.liburing-version == '2.3')
         run: |
           cmake -B ${{github.workspace}}/build_module -G Ninja \
-              -DBUILD_MODULE=ON \
-              -DBUILD_EXAMPLES=ON \
+              -DCONDY_BUILD_MODULE=ON \
+              -DCONDY_BUILD_EXAMPLES=ON \
+              -DCONDY_LINK_LIBURING_VERSION=${{ matrix.liburing-version }} \
               -DCMAKE_C_COMPILER=${{ matrix.compiler.cc }} \
               -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cxx }}
           ninja -C ${{github.workspace}}/build_module module-hello

.github/workflows/deploy-docs.yml

@@ -23,10 +23,6 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Checkout Doxygen Style
-        run: |
-          git submodule update --init --depth 1 ./third_party/doxygen-awesome-css
-
       - name: Install Doxygen
         run: |
           sudo apt-get update
@@ -36,14 +32,16 @@ jobs:
         id: pages
         uses: actions/configure-pages@v5
 
-      - name: Build with Doxygen
-        run: |
-          doxygen Doxyfile
+      - name: Configure CMake
+        run: cmake -B build -DCONDY_BUILD_DOCS=ON
+
+      - name: Build Documentation
+        run: cmake --build build --target docs
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./docs/html
+          path: ./build/docs/html
 
   deploy:
     needs: build

.gitmodules

@@ -1,32 +1,75 @@
 cmake_minimum_required(VERSION 3.13)
 
-project(condy LANGUAGES CXX)
-
-option(BUILD_EXAMPLES "Build examples" OFF)
-option(BUILD_BENCHMARKS "Build benchmarks" OFF)
-option(BUILD_TESTS "Build tests" OFF)
-option(BUILD_MODULE "Build C++ module interface" OFF)
-option(ENABLE_CLANG_TIDY "Enable clang-tidy static analysis" OFF)
-option(TESTS_STATIC_LINK "Use static linking for tests" OFF)
-option(TESTS_TSAN "Enable thread sanitizer for tests" OFF)
-option(TESTS_ASAN "Enable address and undefined behavior sanitizers for tests" OFF)
-option(LINK_LIBURING "Use liburing from third_party and link it to condy" ON)
-
-if (ENABLE_CLANG_TIDY)
-    find_program(CLANG_TIDY_EXE NAMES "clang-tidy")
-    if(CLANG_TIDY_EXE)
-        message(STATUS "Found clang-tidy: ${CLANG_TIDY_EXE}")
-        set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_EXE}")
-    else()
-        message(WARNING "clang-tidy not found, static analysis will be disabled")
-    endif()
+# Version is defined once in the version header.
+set(CONDY_VERSION_HEADER include/condy/version.hpp)
+file(READ ${CONDY_VERSION_HEADER} _condy_version_h)
+string(REGEX MATCH "#define CONDY_VERSION_MAJOR ([0-9]+)" _condy_ver_m "${_condy_version_h}")
+set(CONDY_VERSION_MAJOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "#define CONDY_VERSION_MINOR ([0-9]+)" _condy_ver_m "${_condy_version_h}")
+set(CONDY_VERSION_MINOR ${CMAKE_MATCH_1})
+if(NOT CONDY_VERSION_MAJOR OR NOT CONDY_VERSION_MINOR)
+    message(FATAL_ERROR "Failed to parse version from ${CONDY_VERSION_HEADER}")
 endif()
+set(CONDY_VERSION_STRING "v${CONDY_VERSION_MAJOR}.${CONDY_VERSION_MINOR}")
+
+project(condy VERSION ${CONDY_VERSION_MAJOR}.${CONDY_VERSION_MINOR} LANGUAGES CXX)
+message(STATUS "Configuring condy ${CONDY_VERSION_STRING}")
+
+option(CONDY_BUILD_EXAMPLES "Build examples" OFF)
+option(CONDY_BUILD_BENCHMARKS "Build benchmarks" OFF)
+option(CONDY_BUILD_TESTS "Build tests" OFF)
+option(CONDY_BUILD_MODULE "Build C++ module interface" OFF)
+option(CONDY_BUILD_DOCS "Build Doxygen documentation" OFF)
+option(CONDY_TESTS_STATIC_LINK "Use static linking for tests" OFF)
+option(CONDY_TESTS_TSAN "Enable thread sanitizer for tests" OFF)
+option(CONDY_TESTS_ASAN "Enable address and undefined behavior sanitizers for tests" OFF)
+option(CONDY_LINK_LIBURING "Use liburing and link it to condy" ON)
+set(CONDY_LINK_LIBURING_VERSION "2.15" CACHE STRING "liburing version to fetch and link")
+
+# Backward compatibility for the unprefixed option names.
+macro(condy_legacy_option legacy new)
+    if(DEFINED ${legacy})
+        message(DEPRECATION "The ${legacy} option is deprecated, use ${new} instead")
+        get_property(_condy_${new}_desc CACHE ${new} PROPERTY HELPSTRING)
+        set(${new} ${${legacy}} CACHE BOOL "${_condy_${new}_desc}" FORCE)
+    endif()
+endmacro()
+condy_legacy_option(BUILD_EXAMPLES CONDY_BUILD_EXAMPLES)
+condy_legacy_option(BUILD_BENCHMARKS CONDY_BUILD_BENCHMARKS)
+condy_legacy_option(BUILD_TESTS CONDY_BUILD_TESTS)
+condy_legacy_option(BUILD_MODULE CONDY_BUILD_MODULE)
+condy_legacy_option(TESTS_STATIC_LINK CONDY_TESTS_STATIC_LINK)
+condy_legacy_option(TESTS_TSAN CONDY_TESTS_TSAN)
+condy_legacy_option(TESTS_ASAN CONDY_TESTS_ASAN)
+condy_legacy_option(LINK_LIBURING CONDY_LINK_LIBURING)
+
+include(FetchContent)
+
+set(DOXYGEN_AWESOME_CSS_VERSION v2.4.1)
+set(DOCTEST_VERSION v2.5.0)
+set(LIBURING_VERSION liburing-${CONDY_LINK_LIBURING_VERSION})
+
+FetchContent_Declare(
+    doxygen-awesome-css
+    URL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/${DOXYGEN_AWESOME_CSS_VERSION}/doxygen-awesome.css
+    DOWNLOAD_NO_EXTRACT TRUE
+)
+FetchContent_Declare(
+    doctest
+    URL https://raw.githubusercontent.com/doctest/doctest/${DOCTEST_VERSION}/doctest/doctest.h
+    DOWNLOAD_NO_EXTRACT TRUE
+)
+FetchContent_Declare(
+    liburing
+    URL https://github.com/axboe/liburing/archive/refs/tags/${LIBURING_VERSION}.tar.gz
+    DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+)
 
 add_library(condy INTERFACE)
 target_include_directories(condy INTERFACE include)
 target_compile_features(condy INTERFACE cxx_std_20)
 
-if(BUILD_EXAMPLES OR BUILD_BENCHMARKS OR BUILD_TESTS OR LINK_LIBURING OR BUILD_MODULE)
+if(CONDY_BUILD_EXAMPLES OR CONDY_BUILD_BENCHMARKS OR CONDY_BUILD_TESTS OR CONDY_LINK_LIBURING)
     enable_language(C)
     include(ExternalProject)
 
@@ -38,30 +81,30 @@ if(BUILD_EXAMPLES OR BUILD_BENCHMARKS OR BUILD_TESTS OR LINK_LIBURING OR BUILD_M
     endif()
 
     # liburing
-    set(LIBURING_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/third_party/liburing)
-    message(STATUS "Configuring liburing in ${LIBURING_SOURCE_DIR}")
+    message(STATUS "Fetching liburing ${LIBURING_VERSION}")
+    FetchContent_MakeAvailable(liburing)
 
     ExternalProject_Add(
         liburing_ext
-        SOURCE_DIR ${LIBURING_SOURCE_DIR}
+        SOURCE_DIR ${liburing_SOURCE_DIR}
         CONFIGURE_COMMAND ./configure --cc=${CMAKE_C_COMPILER} --cxx=${CMAKE_CXX_COMPILER}
         BUILD_COMMAND ${MAKE_EXECUTABLE} -C src
         BUILD_IN_SOURCE 1
         INSTALL_COMMAND ""
-        BUILD_BYPRODUCTS ${LIBURING_SOURCE_DIR}/src/liburing.a
+        BUILD_BYPRODUCTS ${liburing_SOURCE_DIR}/src/liburing.a
     )
 
     add_library(uring STATIC IMPORTED GLOBAL)
-    set_target_properties(uring PROPERTIES IMPORTED_LOCATION ${LIBURING_SOURCE_DIR}/src/liburing.a)
-    target_include_directories(uring INTERFACE ${LIBURING_SOURCE_DIR}/src/include)
+    set_target_properties(uring PROPERTIES IMPORTED_LOCATION ${liburing_SOURCE_DIR}/src/liburing.a)
+    target_include_directories(uring INTERFACE ${liburing_SOURCE_DIR}/src/include)
     add_dependencies(uring liburing_ext)
 endif()
 
-if(LINK_LIBURING)
+if(CONDY_LINK_LIBURING)
     target_link_libraries(condy INTERFACE uring)
 endif()
 
-if(BUILD_MODULE)
+if(CONDY_BUILD_MODULE)
     set(CMAKE_CXX_SCAN_FOR_MODULES ON)
     message(STATUS "Configuring C++ module interface in ${CMAKE_CURRENT_SOURCE_DIR}/module")
     add_subdirectory(module)
@@ -78,20 +121,22 @@ if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
     add_compile_options(-Wno-maybe-uninitialized)
 endif()
 
-if(BUILD_EXAMPLES)
+if(CONDY_BUILD_EXAMPLES)
     message(STATUS "Configuring examples in ${CMAKE_CURRENT_SOURCE_DIR}/examples")
     add_subdirectory(examples)
 endif()
 
-if(BUILD_BENCHMARKS)
+if(CONDY_BUILD_BENCHMARKS)
     message(STATUS "Configuring benchmarks in ${CMAKE_CURRENT_SOURCE_DIR}/benchmarks")
     add_subdirectory(benchmarks)
 endif()
 
-if(BUILD_TESTS)
-    # doctest
-    add_subdirectory(third_party/doctest)
+if(CONDY_BUILD_TESTS)
     message(STATUS "Configuring tests in ${CMAKE_CURRENT_SOURCE_DIR}/tests")
     enable_testing()
     add_subdirectory(tests)
+endif()
+
+if(CONDY_BUILD_DOCS)
+    add_subdirectory(docs)
 endif()

CMakeLists.txt

@@ -0,0 +1,15 @@
+find_program(DOXYGEN_EXECUTABLE NAMES doxygen REQUIRED)
+
+message(STATUS "Fetching doxygen-awesome-css")
+FetchContent_MakeAvailable(doxygen-awesome-css)
+FetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR)
+
+set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+add_custom_target(docs
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generate Doxygen documentation into ${CMAKE_CURRENT_BINARY_DIR}/html"
+    VERBATIM)