Add CMake options for sanitizers

.github/workflows/ci.yml

@@ -18,32 +18,30 @@ env:
 
 jobs:
   MacOS:
-    runs-on: macos-latest
+    runs-on: macos-15
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_PATHS }}
           key: ${{ github.job }}-${{ env.CACHE_VERSION }}
       - name: build
-        env:
-          DEVELOPER_DIR: /Applications/Xcode_11.7.app/Contents/Developer
         run: ./scripts/build.sh
 
   Linux:
     strategy:
       fail-fast: false
       matrix:
         options:
-          - name: "Linux: gcc-9"
-            run: ./scripts/build.sh -DCMAKE_CXX_COMPIILER=g++-9
-          - name: "Linux: clang-10"
-            run: ./scripts/build.sh -DCMAKE_CXX_COMPILER=clang++-10
+          - name: "Linux: gcc"
+            run: ./scripts/build.sh -DCMAKE_CXX_COMPILER=g++
+          - name: "Linux: clang"
+            run: ./scripts/build.sh -DCMAKE_CXX_COMPILER=clang++
     name: "${{ matrix.options.name }}"
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_PATHS }}
           key: ${{ github.job }}-${{ matrix.options.name }}-${{ env.CACHE_VERSION }}
@@ -52,13 +50,13 @@ jobs:
 
   clang-tidy:
     name: "Linux: clang-tidy"
-    runs-on: ubuntu-latest
-    container: soramitsu/kagome-dev:2-minideb
+    runs-on: ubuntu-24.04
+    container: qdrvm/kagome-dev@sha256:2d70246c32418a3dd45c246d3f5c2dd99bdafde145b903271849affe476c4cfc
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ${{ env.CACHE_PATHS }}
           key: ${{ github.job }}-${{ env.CACHE_VERSION }}

.gitignore

@@ -1,4 +1,6 @@
-build
 .vscode
 .idea
-cmake-build-*/
+**/build/
+**/build-*/
+**/cmake-build-*/
+Testing

CMakeLists.txt

@@ -1,62 +1,143 @@
 #
-# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# Copyright Quadrivium LLC
+# All Rights Reserved
 # SPDX-License-Identifier: Apache-2.0
 #
 
 cmake_minimum_required(VERSION 3.12)
 
-include(${CMAKE_CURRENT_LIST_DIR}/cmake/HunterGate.cmake)
-set(HUNTER_STATUS_DEBUG ON)
-HunterGate(
-        URL  https://github.com/soramitsu/soramitsu-hunter/archive/9ca72322e8d9de70d360dc7f371b223d32999123.zip
-        SHA1 37cc1150526fb9c5dcf197f918e5d9aab611823f
-)
+option(JAM_COMPATIBLE "Build compatible with JAM-codec" OFF)
+option(CUSTOM_CONFIG_SUPPORT "Support custom config of coder" OFF)
+option(BUILD_TESTS "Whether to include the test suite in build" OFF)
+
+option(SCALE_ASAN "Build with address sanitizer" OFF)
+option(SCALE_UBSAN "Build with undefined behavior sanitizer" OFF)
+option(SCALE_TSAN "Build with thread sanitizer" OFF)
+
+set(MAX_AGGREGATE_FIELDS 20 CACHE STRING "Max number of aggregates fields (1..1000); for generation")
+
+if (PACKAGE_MANAGER)
+    if(PACKAGE_MANAGER NOT MATCHES "^(hunter|vcpkg)$")
+        message(FATAL_ERROR "PACKAGE_MANAGER must be set to 'hunter', 'vcpkg' or isn't set")
+    endif ()
+else ()
+    set(PACKAGE_MANAGER "hunter")
+    if (CMAKE_TOOLCHAIN_FILE)
+        get_filename_component(ACTUAL_NAME ${CMAKE_TOOLCHAIN_FILE} NAME)
+        if(ACTUAL_NAME STREQUAL "vcpkg.cmake")
+            message(STATUS "vcpkg will be used because vcpkg.cmake has found")
+            set(PACKAGE_MANAGER "vcpkg")
+        endif ()
+    endif ()
+endif ()
+message(STATUS "Selected package manager: ${PACKAGE_MANAGER}")
+
+if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.27")
+    cmake_policy(SET CMP0144 NEW)
+endif ()
+
+if (PACKAGE_MANAGER STREQUAL "hunter")
+    include("cmake/Hunter/init.cmake")
+endif ()
+
+if(BUILD_TESTS)
+    if (PACKAGE_MANAGER STREQUAL "vcpkg")
+        list(APPEND VCPKG_MANIFEST_FEATURES scale-tests)
+    endif()
+endif()
 
-project(Scale CXX)
+project(Scale LANGUAGES CXX VERSION 2.0.0)
 
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-option(BUILD_TESTS "Whether to include the test suite in build" OFF)
+if (PACKAGE_MANAGER STREQUAL "hunter")
+    hunter_add_package(Boost)
+    find_package(Boost)
+else()
+    find_package(Boost CONFIG REQUIRED COMPONENTS endian multiprecision)
+endif ()
+
+if (PACKAGE_MANAGER STREQUAL "hunter")
+    hunter_add_package(qtils)
+endif ()
+find_package(qtils CONFIG REQUIRED)
 
-hunter_add_package(Boost)
-find_package(Boost CONFIG REQUIRED)
+SET(JAM_COMPATIBILITY_ENABLED "${JAM_COMPATIBLE}")
+set(CUSTOM_CONFIG_ENABLED "${CUSTOM_CONFIG_SUPPORT}")
+configure_file("${CMAKE_SOURCE_DIR}/include/scale/definitions.hpp.in" "${CMAKE_BINARY_DIR}/include/scale/definitions.hpp")
 
-hunter_add_package(Microsoft.GSL)
-find_package(Microsoft.GSL CONFIG REQUIRED)
+if (SCALE_ASAN)
+    add_compile_options(-fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer)
+    add_link_options(-fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer)
+endif()
+if (SCALE_UBSAN)
+    add_compile_options(-fsanitize=undefined -fno-omit-frame-pointer)
+    add_link_options(-fsanitize=undefined -fno-omit-frame-pointer)
+endif()
+if (SCALE_TSAN)
+    add_compile_options(-fsanitize=thread -fno-omit-frame-pointer)
+    add_link_options(-fsanitize=thread -fno-omit-frame-pointer)
+endif()
 
 add_subdirectory(src)
 
 if (BUILD_TESTS)
     enable_testing()
-    add_subdirectory(test ${CMAKE_BINARY_DIR}/tests_bin)
-endif()
+    add_subdirectory(test ${CMAKE_BINARY_DIR}/test_bin)
+endif ()
 
 ###############################################################################
 #   INSTALLATION
 ###############################################################################
 
 include(GNUInstallDirs)
 
-install(TARGETS scale buffer scale_encode_append EXPORT scaleConfig
+install(TARGETS scale EXPORT scaleConfig
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
     INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
     PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
     FRAMEWORK DESTINATION ${CMAKE_INSTALL_PREFIX}
-    )
+)
+
+install(TARGETS scale_append EXPORT scaleConfig
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    FRAMEWORK DESTINATION ${CMAKE_INSTALL_PREFIX}
+)
 
 install(
     DIRECTORY ${CMAKE_SOURCE_DIR}/include/scale
     DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+    FILES_MATCHING PATTERN "*.hpp"
+)
+install(
+    DIRECTORY ${CMAKE_BINARY_DIR}/include/scale
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+include(CMakePackageConfigHelpers)
+
+write_basic_package_version_file(
+    ${CMAKE_CURRENT_BINARY_DIR}/scaleConfigVersion.cmake
+    COMPATIBILITY SameMajorVersion
+)
+
+install(
+    FILES ${CMAKE_CURRENT_BINARY_DIR}/scaleConfigVersion.cmake
+    DESTINATION share/scale
 )
 
 install(
     EXPORT scaleConfig
-    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/scale
+    DESTINATION share/scale
     NAMESPACE scale::
 )