Switch to CPM and clean up code (#4)

* Switch from FetchContent to [CPM](https://github.com/cpm-cmake/CPM.cmake)
* Use `config.hpp` instead of `target_compile_definitions`
* Rename CMake options
* Add `spdlog` dependency for logging
* Renamed parameters to:
    * `e[ab][01]_t[01]` for edge-edge vertices
    * `v_t[01]` and `f[012]_t[01]` for vertex-face vertices
    * `[abcd]_t[01]` for generic vertices
* Combined VF and EE CCD into one generic function
* Changed `max_itr` to type `long`
* Add more doxygen comments
* Add `pbar` and CLI11 to Tight_Inclusion_bin
* Update README.md
* Removed figures from the repo

Author: zfergus

.github/workflows/continuous.yml

@@ -2,11 +2,8 @@ name: Build
 
 on:
   push:
-    branches:
-      - main
+    branches: [main]
   pull_request:
-    branches:
-      - main
 
 env:
   CTEST_OUTPUT_ON_FAILURE: ON
@@ -23,36 +20,37 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, macos-latest]
+        os: [ubuntu-latest, macos-latest]
         config: [Debug, Release]
         include:
           - os: macos-latest
             name: macOS
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             name: Linux
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3.5.3
         with:
           fetch-depth: 10
 
       - name: Dependencies (Linux)
         if: runner.os == 'Linux'
         run: |
           sudo apt-get update
-          sudo apt-get -o Acquire::Retries=3 install \
-            ccache \
-            libgmp-dev
+          sudo apt-get -o Acquire::Retries=3 install ccache libgmp-dev
+          echo 'CACHE_PATH=~/.cache/ccache' >> "$GITHUB_ENV"
 
       - name: Dependencies (macOS)
         if: runner.os == 'macOS'
-        run: brew install ccache gmp
+        run: |
+          brew install ccache gmp
+          echo 'CACHE_PATH=~/Library/Caches/ccache' >> "$GITHUB_ENV"
 
       - name: Cache Build
         id: cache-build
-        uses: actions/cache@v1
+        uses: actions/cache@v3.0.11
         with:
-          path: ~/.ccache
+          path: ${{ env.CACHE_PATH }}
           key: ${{ runner.os }}-${{ matrix.config }}-cache
 
       - name: Prepare ccache
@@ -67,8 +65,7 @@ jobs:
           cd build
           cmake .. \
             -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-            -DCMAKE_BUILD_TYPE=${{ matrix.config }} \
-            -DTIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT=ON
+            -DCMAKE_BUILD_TYPE=${{ matrix.config }}
 
       - name: Configure (Release)
         if: matrix.config == 'Release'
@@ -79,43 +76,40 @@ jobs:
             -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
             -DCMAKE_BUILD_TYPE=${{ matrix.config }} \
             -DTIGHT_INCLUSION_WITH_GMP=ON \
-            -DTIGHT_INCLUSION_WITH_TESTS=ON \
-            -DTIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT=ON
+            -DTIGHT_INCLUSION_WITH_SAMPLE_QUERIES=ON
 
       - name: Build
         run: cd build; make -j2; ccache --show-stats
 
       - name: Tests
-        run: cd build; ./Tight_Inclusion_bin
+        run: cd build; ./app/Tight_Inclusion_bin --no-pbar
 
   ####################
   # Windows
   ####################
 
   Windows:
-    runs-on: windows-2019
-    env:
-      CC: cl.exe
-      CXX: cl.exe
-      SCCACHE_IDLE_TIMEOUT: "12000"
+    runs-on: windows-latest
     strategy:
       fail-fast: false
       matrix:
         config: [Debug, Release]
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3.5.3
         with:
           fetch-depth: 10
-      - uses: seanmiddleditch/gha-setup-ninja@master
+
+      - name: Install Ninja
+        uses: seanmiddleditch/gha-setup-ninja@master
 
       - name: Set env
         run: |
           echo "appdata=$env:LOCALAPPDATA" >> ${env:GITHUB_ENV}
 
       - name: Cache build
         id: cache-build
-        uses: actions/cache@v2
+        uses: actions/cache@v3.0.11
         with:
           path: ${{ env.appdata }}\Mozilla\sccache
           key: ${{ runner.os }}-${{ matrix.config }}-cache-${{ github.sha }}
@@ -132,18 +126,15 @@ jobs:
       - name: Configure and build
         shell: cmd
         run: |
-          call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=x64
-          cmake --version
+          call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\VsDevCmd.bat" -arch=x64
           cmake -G Ninja ^
             -DCMAKE_CXX_COMPILER_LAUNCHER=sccache ^
             -DCMAKE_BUILD_TYPE=${{ matrix.config }} ^
-            -DTIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT=ON ^
             -B build ^
             -S .
-          cd build
-          ninja -j1
+          cmake --build build -j1
 
       - name: Tests
         run: |
           cd build
-          ./Tight_Inclusion_bin
+          ./app/Tight_Inclusion_bin --no-pbar

.gitignore

@@ -230,6 +230,10 @@ external
 sample-queries
 
 *.nosync
+
 ###############################################################################
+
 paper/
-fig/*.pdf
+TightInclusionOptions.cmake
+src/tight_inclusion/config.hpp
+app/config.hpp

CMakeLists.txt

@@ -7,7 +7,7 @@ else()
 endif()
 
 # Check required CMake version
-set(REQUIRED_CMAKE_VERSION "3.14.0")
+set(REQUIRED_CMAKE_VERSION "3.18.0")
 if(TIGHT_INCLUSION_TOPLEVEL_PROJECT)
     cmake_minimum_required(VERSION ${REQUIRED_CMAKE_VERSION})
 else()
@@ -24,24 +24,50 @@ if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/TightInclusionOptions.cmake)
     include(${CMAKE_CURRENT_SOURCE_DIR}/TightInclusionOptions.cmake)
 endif()
 
+# Enable ccache if available
+find_program(CCACHE_PROGRAM ccache)
+if(CCACHE_PROGRAM)
+    option(TIGHT_INCLUSION_WITH_CCACHE "Enable ccache when building Tight Inclusion" ${TIGHT_INCLUSION_TOPLEVEL_PROJECT})
+else()
+    option(TIGHT_INCLUSION_WITH_CCACHE "Enable ccache when building Tight Inclusion" OFF)
+endif()
+if(TIGHT_INCLUSION_WITH_CCACHE AND CCACHE_PROGRAM)
+    message(STATUS "Enabling Ccache support")
+    set(ccacheEnv
+        CCACHE_BASEDIR=${CMAKE_BINARY_DIR}
+        CCACHE_SLOPPINESS=clang_index_store,include_file_ctime,include_file_mtime,locale,pch_defines,time_macros
+    )
+    foreach(lang IN ITEMS C CXX)
+        set(CMAKE_${lang}_COMPILER_LAUNCHER
+            ${CMAKE_COMMAND} -E env ${ccacheEnv} ${CCACHE_PROGRAM}
+        )
+    endforeach()
+endif()
+
+################################################################################
+# CMake Policies
+################################################################################
+
+cmake_policy(SET CMP0054 NEW) # Only interpret if() arguments as variables or keywords when unquoted.
+cmake_policy(SET CMP0076 NEW) # target_sources() command converts relative paths to absolute.
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24")
+    cmake_policy(SET CMP0135 NEW) # Set the timestamps of all extracted contents to the time of the extraction.
+endif()
+
 ################################################################################
 
 project(TightInclusion
         DESCRIPTION "Tight Inclusion CCD"
-        LANGUAGES CXX)
+        LANGUAGES CXX
+        VERSION "1.0.4")
 
-OPTION(TIGHT_INCLUSION_WITH_TESTS             "Enable test functions"                                   OFF)
-OPTION(TIGHT_INCLUSION_WITH_GMP               "Enable rational based predicates, for debug"             OFF)
-OPTION(TIGHT_INCLUSION_WITH_TIMER             "Enable profiling timers, for debug"                      OFF)
-OPTION(TIGHT_INCLUSION_WITH_DOUBLE_PRECISION  "Enable double precision floating point numbers as input"  ON)
-OPTION(TIGHT_INCLUSION_LIMIT_QUEUE_SIZE       "Enable limitation of maximal queue size"                 OFF)
-
-# Option to supress progress output when on GH actions.
-OPTION(TIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT "Enable limitation of maximal queue size"               OFF)
-mark_as_advanced(TIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT)
+option(TIGHT_INCLUSION_WITH_GMP               "Enable rational based predicates (for debugging)"        OFF)
+option(TIGHT_INCLUSION_WITH_TIMER             "Enable profiling timers (for debugging)"                 OFF)
+option(TIGHT_INCLUSION_WITH_DOUBLE_PRECISION  "Enable double precision floating point numbers as input"  ON)
+option(TIGHT_INCLUSION_LIMIT_QUEUE_SIZE       "Enable limitation of maximal queue size"                 OFF)
 
 include(CMakeDependentOption)
-cmake_dependent_option(TIGHT_INCLUSION_FLOAT_WITH_DOUBLE_INPUT "Enable converting double queries to float" OFF "TIGHT_INCLUSION_WITH_DOUBLE_PRECISION" OFF)
+cmake_dependent_option(TIGHT_INCLUSION_FLOAT_WITH_DOUBLE_INPUT "Enable converting double queries to float" OFF "TIGHT_INCLUSION_WITH_DOUBLE_PRECISION" ON)
 
 # Set default minimum C++ standard
 if(TIGHT_INCLUSION_TOPLEVEL_PROJECT)
@@ -51,12 +77,19 @@ if(TIGHT_INCLUSION_TOPLEVEL_PROJECT)
 endif()
 
 ### Configuration
+set(TIGHT_INCLUSION_SOURCE_DIR "${PROJECT_SOURCE_DIR}/src/tight_inclusion")
+set(TIGHT_INCLUSION_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/src")
+
 list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/tight_inclusion/")
 list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/recipes/")
 list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/find/")
 
-# Tight Inclusion utils
-include(tight_inclusion_utils)
+# General CMake utils
+include(tight_inclusion_cpm_cache)
+include(tight_inclusion_use_colors)
+
+# Generate position-independent code by default
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 ################################################################################
 # Tight Inclusion Library
@@ -66,10 +99,16 @@ include(tight_inclusion_utils)
 add_library(tight_inclusion)
 add_library(tight_inclusion::tight_inclusion ALIAS tight_inclusion)
 
-add_subdirectory(src/tight_inclusion)
+# Fill in configuration options
+configure_file(
+  "${TIGHT_INCLUSION_SOURCE_DIR}/config.hpp.in"
+  "${TIGHT_INCLUSION_SOURCE_DIR}/config.hpp")
+
+# Add source and header files to tight_inclusion
+add_subdirectory("${TIGHT_INCLUSION_SOURCE_DIR}")
 
 # Public include directory for Tight Inclusion
-target_include_directories(tight_inclusion PUBLIC src)
+target_include_directories(tight_inclusion PUBLIC "${TIGHT_INCLUSION_INCLUDE_DIR}")
 
 ################################################################################
 # Optional Definitions
@@ -82,45 +121,23 @@ target_compile_definitions(tight_inclusion PUBLIC NOMINMAX)
 # Dependencies
 ################################################################################
 
-# Extra warnings
-include(tight_inclusion_warnings)
-target_link_libraries(tight_inclusion PRIVATE tight_inclusion::warnings)
-
-# libigl
+# Eigen
 include(eigen)
 target_link_libraries(tight_inclusion PUBLIC Eigen3::Eigen)
 
+# Logger
+include(spdlog)
+target_link_libraries(tight_inclusion PUBLIC spdlog::spdlog)
+
 # GMP (optional)
-if(TIGHT_INCLUSION_WITH_GMP OR TIGHT_INCLUSION_WITH_TESTS)
+if(TIGHT_INCLUSION_WITH_GMP)
     find_package(GMP REQUIRED)
     target_link_libraries(tight_inclusion PUBLIC gmp::gmp)
-    target_compile_definitions(tight_inclusion PUBLIC TIGHT_INCLUSION_USE_GMP)
 endif()
 
-################################################################################
-# Definitions
-################################################################################
-
-if(TIGHT_INCLUSION_WITH_TIMER)
-    target_compile_definitions(tight_inclusion PRIVATE TIGHT_INCLUSION_USE_TIMER)
-endif()
-
-if (TIGHT_INCLUSION_WITH_DOUBLE_PRECISION)
-    message(STATUS "Tight Inclusion: Using Double Precision Floating Points")
-    target_compile_definitions(tight_inclusion PUBLIC TIGHT_INCLUSION_DOUBLE)
-else()
-    message(STATUS "Tight Inclusion: Using Single Precision Floating Points")
-endif()
-
-if(TIGHT_INCLUSION_LIMIT_QUEUE_SIZE)
-    message(STATUS "Tight Inclusion: Limiting maximal queue size")
-    target_compile_definitions(tight_inclusion PUBLIC TIGHT_INCLUSION_LIMIT_QUEUE_SIZE)
-endif()
-
-if(TIGHT_INCLUSION_FLOAT_WITH_DOUBLE_INPUT)
-    message(STATUS "Tight Inclusion: Converting double inputs to float for tests")
-    target_compile_definitions(tight_inclusion PUBLIC TIGHT_INCLUSION_FWDI)
-endif()
+# Extra warnings (link last for highest priority)
+include(tight_inclusion_warnings)
+target_link_libraries(tight_inclusion PRIVATE tight_inclusion::warnings)
 
 ################################################################################
 # Compiler options
@@ -140,20 +157,5 @@ target_compile_features(tight_inclusion PUBLIC cxx_std_17)
 ################################################################################
 
 if(TIGHT_INCLUSION_TOPLEVEL_PROJECT)
-    add_executable(Tight_Inclusion_bin "app/main.cpp")
-    target_link_libraries(Tight_Inclusion_bin PUBLIC tight_inclusion)
-
-    set(TIGHT_INCLUSION_SAMPLE_QUERIES_DIR "${PROJECT_SOURCE_DIR}/sample-queries")
-    include(sample_queries)
-
-    if(TIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT)
-        target_compile_definitions(Tight_Inclusion_bin PUBLIC TIGHT_INCLUSION_SUPPRESS_PROGRESS_OUTPUT)
-    endif()
-
-    if (TIGHT_INCLUSION_WITH_TESTS)
-        target_sources(Tight_Inclusion_bin PUBLIC "app/read_rational_csv.cpp")
-        target_compile_definitions(Tight_Inclusion_bin PUBLIC TIGHT_INCLUSION_RUN_EXAMPLES)
-        target_compile_definitions(Tight_Inclusion_bin PUBLIC
-            TIGHT_INCLUSION_SAMPLE_QUERIES_DIR="${TIGHT_INCLUSION_SAMPLE_QUERIES_DIR}/")
-    endif()
+    add_subdirectory(app)
 endif()