Merge branch 'main' into msvc

Author: aminya

.github/workflows/ci.yml

@@ -50,6 +50,7 @@ jobs:
           cmake: true
           ninja: true
           vcpkg: true
+          conan: true
           cppcheck: true
           clangtidy: true
           task: true
@@ -59,4 +60,12 @@ jobs:
         run: |
           task test
           task test_release
-          task test_install
+          task test_install
+
+      - name: Lint
+        if: ${{ matrix.os == 'ubuntu-20.04' && matrix.compiler == 'gcc' }}
+        run: |
+          # TODO add to setup-cpp
+          python3 -m pip install --user cmakelint cmake-format
+
+          task lint

README.md

@@ -2,7 +2,7 @@
 
 A general-purpose CMake library that provides functions that improve the CMake experience.
 
-It provdes different functions such as `project_options`, `package_project`, `dynamic_project_options`, `run_vcpkg`, `target_link_system_libraries`, etc.
+It provides different functions such as `project_options`, `package_project`, `dynamic_project_options`, `run_vcpkg`, `target_link_system_libraries`, etc.
 
 ## Usage
 
@@ -15,10 +15,11 @@ cmake_minimum_required(VERSION 3.16)
 # If commented, the latest supported standard for your compiler is automatically set.
 # set(CMAKE_CXX_STANDARD 20)
 
-# Add project_options v0.17.0
+# Add project_options v0.19.0
 # https://github.com/cpp-best-practices/project_options
+# Change the version in the following URL to update the package (watch the releases of the repository for future updates)
 include(FetchContent)
-FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.17.0.zip)
+FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.19.0.zip)
 FetchContent_MakeAvailable(_project_options)
 include(${_project_options_SOURCE_DIR}/Index.cmake)
 
@@ -125,8 +126,8 @@ target_link_libraries(my_lib PRIVATE project_options project_warnings) # link pr
 
 # Includes
 set(INCLUDE_DIR "include") # must be relative paths
-target_include_directories(my_lib INTERFACE "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${INCLUDE_DIR}>"
-                                            "$<INSTALL_INTERFACE:./${CMAKE_INSTALL_INCLUDEDIR}>")
+target_include_directories(my_lib PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${INCLUDE_DIR}>"
+                                         "$<INSTALL_INTERFACE:./${CMAKE_INSTALL_INCLUDEDIR}>")
 
 # Find dependencies:
 set(DEPENDENCIES_CONFIGURED fmt Eigen3)
@@ -146,7 +147,7 @@ target_link_system_libraries(
 # Package the project
 package_project(
   TARGETS my_lib
-  INTERFACE_INCLUDES ${INCLUDE_DIR}
+  PUBLIC_INCLUDES ${INCLUDE_DIR}
 )
 ```
 
@@ -284,10 +285,11 @@ cmake_minimum_required(VERSION 3.16)
 # If commented, the latest supported standard for your compiler is automatically set.
 # set(CMAKE_CXX_STANDARD 20)
 
-# Add project_options v0.17.0
+# Add project_options v0.19.0
 # https://github.com/cpp-best-practices/project_options
+# Change the version in the following URL to update the package (watch the releases of the repository for future updates)
 include(FetchContent)
-FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.17.0.zip)
+FetchContent_Declare(_project_options URL https://github.com/cpp-best-practices/project_options/archive/refs/tags/v0.19.0.zip)
 FetchContent_MakeAvailable(_project_options)
 include(${_project_options_SOURCE_DIR}/Index.cmake)
 

Taskfile.yml

@@ -13,21 +13,31 @@ tasks:
     - cd ./test/build && ctest -C Release --verbose
 
   test_install:
-      cmds:
+    cmds:
       - task: test_release
       - cmake --install ./test/build --config Release --prefix ./install
       - cmake ./test_install -B ./test_install/build -DCMAKE_BUILD_TYPE:STRING=Release -G "Ninja Multi-Config" -DCMAKE_PREFIX_PATH:STRING={{.CWD}}/install;
       - cmake --build ./test_install/build --config Release
       - cd ./test_install/build && ctest -C Release --verbose
-      vars:
-        CWD:
-          sh: git rev-parse --show-toplevel
+    vars:
+      CWD:
+        sh: git rev-parse --show-toplevel
 
-  format:
-    - clang-format -i ./test/src/*/*.cpp ./test/include/*/*.hpp ./test_install/*.cpp
-    - cmake-format --in-place ./Index.cmake ./src/*.cmake ./test/CMakeLists.txt ./test_install/CMakeLists.txt
+  lint:
+    - |
+      {{if eq OS "windows"}} 
+        powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { if ((get-item $file).Extension -in ".cpp", ".hpp", ".c", ".cc", ".cxx", ".hxx", ".ixx") { clang-format -i -style=file $file } }' 
+      {{else}} 
+        git ls-files --exclude-standard | grep -E '\.(cpp|hpp|c|cc|cxx|hxx|ixx)$' | xargs clang-format -i -style=file 
+      {{end}}
+    - |
+      {{if eq OS "windows"}} 
+      powershell -c '$files=(git ls-files --exclude-standard); foreach ($file in $files) { $item=(get-item $file); if (($item.Name -eq "CMakeLists.txt") -or ($item.Extension -in ".cmake")) { cmake-format --in-place $file; cmake-lint $file --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations } }'
+      {{else}}
+        git ls-files --exclude-standard | grep -E '(CMakeLists\.txt)|(\.(cmake))$' | xargs cmake-format --in-place | xargs cmake-lint --disabled-codes C0103 C0301 R0912 R0915 R0913 --suppress-decorations
+      {{end}}
 
-  lint: cmake-lint ./Index.cmake ./src/*.cmake
+    - ~/vcpkg/vcpkg format-manifest ./test/vcpkg.json ./test_install/vcpkg.json
 
   clean: |
     {{if eq OS "windows"}} 

src/CompilerWarnings.cmake

@@ -1,7 +1,7 @@
-# from here:
+# Set the compiler warnings
 #
+# https://clang.llvm.org/docs/DiagnosticsReference.html
 # https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
-
 function(
   set_project_warnings
   project_name

src/Conan.cmake

@@ -1,3 +1,4 @@
+# Run Conan for dependency management
 macro(run_conan)
   # Download automatically, you can also just copy the conan.cmake file
   if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")

src/Doxygen.cmake

@@ -29,9 +29,9 @@ function(enable_doxygen DOXYGEN_THEME)
 
   if("${DOXYGEN_THEME}" STREQUAL "awesome" OR "${DOXYGEN_THEME}" STREQUAL "awesome-sidebar")
     # use a modern doxygen theme
-    # https://github.com/jothepro/doxygen-awesome-css v1.6.1
+    # https://github.com/jothepro/doxygen-awesome-css v2.0.2
     FetchContent_Declare(_doxygen_theme
-                         URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v1.6.1.zip)
+                         URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/tags/v2.0.2.zip)
     FetchContent_MakeAvailable(_doxygen_theme)
     if("${DOXYGEN_THEME}" STREQUAL "awesome" OR "${DOXYGEN_THEME}" STREQUAL "awesome-sidebar")
       set(DOXYGEN_HTML_EXTRA_STYLESHEET "${_doxygen_theme_SOURCE_DIR}/doxygen-awesome.css")

src/DynamicProjectOptions.cmake

@@ -4,21 +4,21 @@
 #  * ENABLE_CLANG_TIDY: ON for Ninja/Makefiles
 #  * ENABLE_SANITIZER_UNDEFINED: ON for Compilers that support it
 #  * ENABLE_CPPCHECK: ON for Ninja/Makefiles
-
+#
 # For non-developer builds
 #  -DENABLE_DEVELOPER_MODE:BOOL=OFF
 # Is recommended
-
+#
 # In developer mode, all features have options that show up in the CMake GUI tools
-
+#
 # dynamic_project_options() macro enables all recommended defaults with appropriately
 # applied options from the GUI which are set
-
+#
 # Any default can be overridden
 # set(<feature_name>_DEFAULT <value>) - set default for both user and developer modes
 # set(<feature_name>_DEVELOPER_DEFAULT <value>) - set default for developer mode
 # set(<feature_name>_USER_DEFAULT <value>) - set default for user mode
-
+#
 macro(dynamic_project_options)
   option(ENABLE_DEVELOPER_MODE "Set up defaults for a developer of the project, and let developer change options" OFF)
   if(NOT ${ENABLE_DEVELOPER_MODE})

src/Index.cmake

@@ -95,24 +95,24 @@ macro(project_options)
   include("${ProjectOptions_SRC_DIR}/StandardProjectSettings.cmake")
   include("${ProjectOptions_SRC_DIR}/Optimization.cmake")
 
+  # Link this 'library' to set the c++ standard / compile-time options requested
+  add_library(project_options INTERFACE)
+
   if(NOT
-     "${ProjectOptions_IPO}"
+     "${ProjectOptions_ENABLE_IPO}"
      STREQUAL
      "")
     message(WARNING "Deprecation: Use ENABLE_INTERPROCEDURAL_OPTIMIZATION instead of ENABLE_IPO")
-    set(ProjectOptions_ENABLE_INTERPROCEDURAL_OPTIMIZATION ${ProjectOptions_IPO})
+    set(ProjectOptions_ENABLE_INTERPROCEDURAL_OPTIMIZATION ${ProjectOptions_ENABLE_IPO})
   endif()
   if(${ProjectOptions_ENABLE_INTERPROCEDURAL_OPTIMIZATION})
-    enable_interprocedural_optimization()
+    enable_interprocedural_optimization(project_options)
   endif()
 
   if(${ProjectOptions_ENABLE_NATIVE_OPTIMIZATION})
-    enable_native_optimization()
+    enable_native_optimization(project_options)
   endif()
 
-  # Link this 'library' to set the c++ standard / compile-time options requested
-  add_library(project_options INTERFACE)
-
   if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
     if(ProjectOptions_ENABLE_BUILD_WITH_TIME_TRACE)
       target_compile_options(project_options INTERFACE -ftime-trace)

src/Linker.cmake

@@ -1,3 +1,6 @@
+# TODO use function arguments instead of CMake cache variables and options
+
+# Set the linker to use for the linking phase
 macro(configure_linker project_name)
   include(CheckCXXCompilerFlag)
 

src/Optimization.cmake

@@ -1,20 +1,31 @@
-macro(enable_interprocedural_optimization)
+macro(enable_interprocedural_optimization project_name)
   if(CMAKE_BUILD_TYPE STREQUAL "Release" OR CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
     include(CheckIPOSupported)
     check_ipo_supported(RESULT result OUTPUT output)
     if(result)
+      # If a static library of this project is used in another project that does not have `CMAKE_INTERPROCEDURAL_OPTIMIZATION` enabled, a linker error might happen.
+      # TODO set this option in `package_project` function.
+      message(
+        STATUS
+          "Interprocedural optimization is enabled. In other projects, linking with the compiled libraries of this project might require `set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)`"
+      )
       set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
+      set_target_properties(${project_name} PROPERTIES INTERPROCEDURAL_OPTIMIZATION ON)
     else()
-      message(SEND_ERROR "IPO is not supported: ${output}")
+      message(WARNING "Interprocedural Optimization is not supported. Not using it. Here is the error log: ${output}")
     endif()
   endif()
 endmacro()
 
-macro(enable_native_optimization)
-  message(STATUS "Enabling the optimizations specific to the current build machine (less portable)")
-  if(MSVC)
-    target_compile_options(${project_name} PRIVATE /arch:native)
-  else()
-    target_compile_options(${project_name} PRIVATE -march=native)
+macro(enable_native_optimization project_name)
+  detect_architecture(_arch)
+  if("${_arch}" STREQUAL "x64")
+    message(STATUS "Enabling the optimizations specific to the current build machine (less portable)")
+    if(MSVC)
+      # TODO It seems it only accepts the exact instruction set like AVX https://docs.microsoft.com/en-us/cpp/build/reference/arch-x64
+      # target_compile_options(${project_name} INTERFACE /arch:native)
+    else()
+      target_compile_options(${project_name} INTERFACE -march=native)
+    endif()
   endif()
 endmacro()