Merge pull request #92 from orange-cpp/feature/projection_utility

added vcpkg integration

Author: orange-cpp

.github/workflows/cmake-multi-platform.yml

@@ -19,23 +19,28 @@ jobs:
  name: Arch Linux (Clang)
  runs-on: ubuntu-latest
  container: archlinux:latest
-
+ env:
+ VCPKG_ROOT: ${{ github.workspace }}/vcpkg
  steps:
  - name: Install basic tool-chain with pacman
  shell: bash
  run: |
  pacman -Sy --noconfirm archlinux-keyring
  pacman -Syu --noconfirm --needed \
- git base-devel clang cmake ninja
+ git base-devel clang cmake ninja zip unzip fmt
 
  - name: Checkout repository (with sub-modules)
  uses: actions/checkout@v4
  with:
  submodules: recursive
 
+ - name: Set up vcpkg
+ shell: bash
+ run: |
+ git clone https://github.com/microsoft/vcpkg "$VCPKG_ROOT"
  - name: Configure (cmake --preset)
  shell: bash
- run: cmake --preset linux-release -DOMATH_BUILD_TESTS=ON -DOMATH_BUILD_BENCHMARK=OFF
+ run: cmake --preset linux-release -DOMATH_BUILD_TESTS=ON -DOMATH_BUILD_BENCHMARK=OFF -DOMATH_BUILD_VIA_VCPKG=ON -DVCPKG_MANIFEST_FEATURES="imgui;avx2;tests"
 
  - name: Build
  shell: bash
@@ -47,12 +52,14 @@ jobs:
 
 
 
-##############################################################################
-# 2) Windows – MSVC / Ninja
-##############################################################################
+ ##############################################################################
+ # 2) Windows – MSVC / Ninja
+ ##############################################################################
  windows-build-and-test:
  name: Windows (MSVC)
  runs-on: windows-latest
+ env:
+ OMATH_BUILD_VIA_VCPKG: ON
 
  steps:
  - name: Checkout repository (with sub-modules)
@@ -68,7 +75,7 @@ jobs:
 
  - name: Configure (cmake --preset)
  shell: bash
- run: cmake --preset windows-release -DOMATH_BUILD_TESTS=ON -DOMATH_BUILD_BENCHMARK=OFF
+ run: cmake --preset windows-release -DOMATH_BUILD_TESTS=ON -DOMATH_BUILD_BENCHMARK=OFF -DOMATH_BUILD_VIA_VCPKG=ON -DVCPKG_MANIFEST_FEATURES="imgui;avx2;tests"
 
  - name: Build
  shell: bash

.gitmodules

@@ -1,6 +0,0 @@
-[submodule "extlibs/googletest"]
-path = extlibs/googletest
-url = https://github.com/google/googletest.git
-[submodule "extlibs/benchmark"]
-path = extlibs/benchmark
-url = https://github.com/google/benchmark.git

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.26)
 
-project(omath VERSION 3.9.2 LANGUAGES CXX)
+project(omath VERSION 4.0.0 LANGUAGES CXX)
 
 include(CMakePackageConfigHelpers)
 include(CheckCXXCompilerFlag)
@@ -12,7 +12,7 @@ else ()
 endif ()
 
 option(OMATH_BUILD_TESTS "Build unit tests" ${PROJECT_IS_TOP_LEVEL})
-option(OMATH_BUILD_BENCHMARK "Build benchmarks" ${PROJECT_IS_TOP_LEVEL})
+option(OMATH_BUILD_BENCHMARK "Build benchmarks" OFF)
 option(OMATH_THREAT_WARNING_AS_ERROR "Set highest level of warnings and force compiler to treat them as errors" ON)
 option(OMATH_BUILD_AS_SHARED_LIBRARY "Build Omath as .so or .dll" OFF)
 option(OMATH_USE_AVX2 "Omath will use AVX2 to boost performance" ${COMPILER_SUPPORTS_AVX2})
@@ -21,7 +21,28 @@ option(OMATH_BUILD_EXAMPLES "Build example projects with you can learn & play" O
 option(OMATH_STATIC_MSVC_RUNTIME_LIBRARY "Force Omath to link static runtime" OFF)
 option(OMATH_SUPRESS_SAFETY_CHECKS "Supress some safety checks in release build to improve general performance" ON)
 option(OMATH_USE_UNITY_BUILD "Will enable unity build to speed up compilation" OFF)
-option(OMATH_ENABLE_LEGACY "Will enable legacy classes that MUST be used ONLY for backward compatibility" OFF)
+option(OMATH_ENABLE_LEGACY "Will enable legacy classes that MUST be used ONLY for backward compatibility" ON)
+
+option(OMATH_BUILD_VIA_VCPKG "Will enable building using vcpkg, vcpkg will override some options that were set in vcpkg.json file, and search for dependencies using vcpkg" OFF)
+
+if (OMATH_BUILD_VIA_VCPKG AND NOT CMAKE_TOOLCHAIN_FILE)
+ message(FATAL_ERROR "[${PROJECT_NAME}] CMAKE_TOOLCHAIN_FILE IS EMPTY! Please set env variable called 'VCPKG_ROOT' to vcpkg root folder here is an example: 'C:/vcpkg' or '/home/user/vcpkg' ")
+endif ()
+
+if (OMATH_BUILD_VIA_VCPKG AND VCPKG_MANIFEST_FEATURES)
+ foreach (omath_feature IN LISTS VCPKG_MANIFEST_FEATURES)
+ if (omath_feature STREQUAL "imgui")
+ set(OMATH_IMGUI_INTEGRATION ON)
+ elseif (omath_feature STREQUAL "avx2")
+ set(OMATH_USE_AVX2 ${COMPILER_SUPPORTS_AVX2})
+ elseif (omath_feature STREQUAL "tests")
+ set(OMATH_BUILD_TESTS ON)
+ elseif (omath_feature STREQUAL "benchmark")
+ set(OMATH_BUILD_BENCHMARK ON)
+ endif ()
+
+ endforeach ()
+endif ()
 
 if (OMATH_USE_AVX2 AND NOT COMPILER_SUPPORTS_AVX2)
  message(WARNING "OMATH_USE_AVX2 requested, but compiler/target does not support AVX2. Disabling.")
@@ -40,6 +61,7 @@ if (${PROJECT_IS_TOP_LEVEL})
  message(STATUS "[${PROJECT_NAME}]: AVX2 feature status ${OMATH_USE_AVX2}")
  message(STATUS "[${PROJECT_NAME}]: ImGUI integration feature status ${OMATH_IMGUI_INTEGRATION}")
  message(STATUS "[${PROJECT_NAME}]: Legacy features support ${OMATH_ENABLE_LEGACY}")
+ message(STATUS "[${PROJECT_NAME}]: Building using vcpkg ${OMATH_BUILD_VIA_VCPKG}")
 endif ()
 
 file(GLOB_RECURSE OMATH_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp")
@@ -84,7 +106,7 @@ if (OMATH_SUPRESS_SAFETY_CHECKS)
 endif ()
 
 if (OMATH_ENABLE_LEGACY)
- target_compile_options(${PROJECT_NAME} PUBLIC OMATH_ENABLE_LEGACY)
+ target_compile_definitions(${PROJECT_NAME} PUBLIC OMATH_ENABLE_LEGACY)
 endif ()
 
 set_target_properties(${PROJECT_NAME} PROPERTIES
@@ -117,9 +139,6 @@ endif ()
 
 target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_23)
 
-add_subdirectory(extlibs)
-
-
 if (OMATH_BUILD_TESTS)
  add_subdirectory(tests)
  target_compile_definitions(${PROJECT_NAME} PUBLIC OMATH_BUILD_TESTS)

CMakePresets.json

@@ -8,7 +8,10 @@
  "binaryDir": "${sourceDir}/cmake-build/build/${presetName}",
  "installDir": "${sourceDir}/cmake-build/install/${presetName}",
  "cacheVariables": {
- "CMAKE_CXX_COMPILER": "cl.exe"
+ "CMAKE_CXX_COMPILER": "cl.exe",
+ "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+ "VCPKG_INSTALLED_DIR": "${sourceDir}/cmake-build/vcpkg_installed",
+ "CMAKE_MAKE_PROGRAM": "Ninja"
  },
  "condition": {
  "type": "equals",
@@ -24,6 +27,25 @@
  "CMAKE_BUILD_TYPE": "Debug"
  }
  },
+ {
+ "name": "windows-debug-vcpkg",
+ "displayName": "Debug",
+ "inherits": "windows-base",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Debug",
+ "OMATH_BUILD_VIA_VCPKG": "ON",
+ "VCPKG_MANIFEST_FEATURES": "tests;imgui;avx2"
+ }
+ },
+ {
+ "name": "windows-release-vcpkg",
+ "displayName": "Release",
+ "inherits": "windows-base",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Release",
+ "OMATH_BUILD_VIA_VCPKG": "ON"
+ }
+ },
  {
  "name": "windows-release",
  "displayName": "Release",
@@ -39,7 +61,10 @@
  "binaryDir": "${sourceDir}/cmake-build/build/${presetName}",
  "installDir": "${sourceDir}/cmake-build/install/${presetName}",
  "cacheVariables": {
- "CMAKE_CXX_COMPILER": "clang++"
+ "CMAKE_CXX_COMPILER": "clang++",
+ "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+ "VCPKG_INSTALLED_DIR": "${sourceDir}/cmake-build/vcpkg_installed",
+ "CMAKE_MAKE_PROGRAM": "ninja"
  },
  "condition": {
  "type": "equals",
@@ -55,6 +80,15 @@
  "CMAKE_BUILD_TYPE": "Debug"
  }
  },
+ {
+ "name": "linux-debug-vcpkg",
+ "displayName": "Linux Debug",
+ "inherits": "linux-base",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Debug",
+ "OMATH_BUILD_VIA_VCPKG": "ON"
+ }
+ },
  {
  "name": "linux-release",
  "displayName": "Linux Release",
@@ -63,6 +97,15 @@
  "CMAKE_BUILD_TYPE": "Release"
  }
  },
+ {
+ "name": "linux-release-vcpkg",
+ "displayName": "Linux Release",
+ "inherits": "linux-debug",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Release",
+ "OMATH_BUILD_VIA_VCPKG": "ON"
+ }
+ },
  {
  "name": "darwin-base",
  "hidden": true,
@@ -86,13 +129,31 @@
  "CMAKE_BUILD_TYPE": "Debug"
  }
  },
+ {
+ "name": "darwin-debug-vcpkg",
+ "displayName": "Darwin Debug",
+ "inherits": "darwin-base",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Debug",
+ "OMATH_BUILD_VIA_VCPKG": "ON"
+ }
+ },
  {
  "name": "darwin-release",
  "displayName": "Darwin Release",
  "inherits": "darwin-debug",
  "cacheVariables": {
  "CMAKE_BUILD_TYPE": "Release"
  }
+ },
+ {
+ "name": "darwin-release-vcpkg",
+ "displayName": "Darwin Release",
+ "inherits": "darwin-debug",
+ "cacheVariables": {
+ "CMAKE_BUILD_TYPE": "Release",
+ "OMATH_BUILD_VIA_VCPKG": "ON"
+ }
  }
  ]
 }

VERSION

@@ -1 +1 @@
-3.9.2
+4.0.0

benchmark/CMakeLists.txt

@@ -11,5 +11,9 @@ set_target_properties(${PROJECT_NAME} PROPERTIES
  CXX_STANDARD 23
  CXX_STANDARD_REQUIRED ON)
 
-
-target_link_libraries(${PROJECT_NAME} PRIVATE benchmark::benchmark omath)
+if (TARGET benchmark::benchmark)
+ target_link_libraries(${PROJECT_NAME} PRIVATE benchmark::benchmark omath)
+else()
+ find_package(benchmark CONFIG REQUIRED)
+ target_link_libraries(${PROJECT_NAME} PRIVATE benchmark::benchmark omath)
+endif ()

extlibs/CMakeLists.txt

@@ -39,6 +39,7 @@ namespace omath
  class Mat final
  {
  public:
+ using ContainedType = Type;
  constexpr Mat() noexcept
  {
  clear();