Merge PR #125 from tudasc/devel

Release 1.8

Author: ahueck

.clang-format

@@ -2,18 +2,19 @@ Language: Cpp
 # BasedOnStyle:  Google
 AccessModifierOffset: -1
 AlignAfterOpenBracket: Align
-AlignConsecutiveAssignments: true
-AlignEscapedNewlinesLeft: true
+AlignConsecutiveAssignments: AcrossComments
+AlignConsecutiveMacros: AcrossComments
+AlignEscapedNewlines: Left
 AlignOperands: true
 AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: true
-AllowShortBlocksOnASingleLine: false
+AllowShortBlocksOnASingleLine: Never
 AllowShortCaseLabelsOnASingleLine: false
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: false
-AlwaysBreakAfterDefinitionReturnType: false
-AlwaysBreakTemplateDeclarations: true
+AllowShortFunctionsOnASingleLine: None
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakTemplateDeclarations: Yes
 AlwaysBreakBeforeMultilineStrings: true
 BreakBeforeBinaryOperators: None
 BreakBeforeTernaryOperators: true
@@ -27,7 +28,6 @@ DerivePointerAlignment: false
 ExperimentalAutoDetectBinPacking: false
 IndentCaseLabels: true
 IndentWrappedFunctionNames: false
-IndentFunctionDeclarationAfterType: false
 MaxEmptyLinesToKeep: 1
 KeepEmptyLinesAtTheStartOfBlocks: false
 NamespaceIndentation: None
@@ -43,7 +43,7 @@ PenaltyReturnTypeOnItsOwnLine: 200
 PointerAlignment: Left
 SpacesBeforeTrailingComments: 2
 Cpp11BracedListStyle: true
-Standard: Cpp11
+Standard: c++17
 IndentWidth: 2
 TabWidth: 2
 UseTab: Never

.codespellrc

@@ -0,0 +1,8 @@
+[codespell]
+builtin = clear,rare,en-GB_to_en-US,names,informal,code
+check-filenames =
+check-hidden =
+skip = */.git,*/build*,*/.codespellrc,*/install,*/lulesh,wrap.py
+quiet-level = 2
+ignore-regex = ^#include <(?:stdio)\.h>$|DEPENDEES|\\endcode
+ignore-words-list = uint

.github/workflows/basic-ci.yml

@@ -24,7 +24,7 @@ jobs:
             -a \( -name "*.c" -o -name "*.cpp" -o -name "*.h" \) \
             -not -path "*/lulesh/*" -not -path "*/CallSite.h" \
             -print0 \
-            | xargs -0 clang-format-10 -i
+            | xargs -0 clang-format-12 -i
 
       - name: Format check
         run: |
@@ -37,9 +37,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: codespell-project/actions-codespell@master
-        with:
-          path: demo lib test
-          skip: ./.git,*.py,*/lulesh
 
   lit-suite:
     runs-on: ubuntu-20.04
@@ -103,15 +100,15 @@ jobs:
 
       - name: Prepare TypeART coverage
         if: matrix.preset.coverage
-        run: cmake --build build --target lcov-clean
+        run: cmake --build build --target typeart-lcov-clean
 
       - name: Test TypeART lit-suite
         if: matrix.preset.skip_test == false
-        run: cmake --build build --target lit-pass-test
+        run: cmake --build build --target check-typeart
 
       - name: Build coverage report
         if: matrix.preset.coverage
-        run: cmake --build build --target lcov-html
+        run: cmake --build build --target typeart-lcov-html
 
       - name: Prepare coverage artifact
         if: matrix.preset.coverage

AUTHORS

@@ -1,4 +1,4 @@
-# This is the official list of TypeART authors for copyright purposes.
+# This is the official list of TypeART contributors.
 
 # Names should be added to this file as one of
 #     Organization's name
@@ -10,6 +10,7 @@ TU Darmstadt, Darmstadt, Germany
 Jan-Patrick Lehr <Scientific Computing>
 Alexander Hück <Scientific Computing>
 Sebastian Kreutzer <Scientific Computing>
+Alexander Linne <Scientific Computing>
 
 RWTH Aachen, Aachen, Germany
 Joachim Protze <IT Center>

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.20)
 
 project(typeart
-  VERSION 1.7
+  VERSION 1.8
   HOMEPAGE_URL https://github.com/tudasc/TypeART
   DESCRIPTION "LLVM-based type and memory allocation tracking sanitizer"
 )
@@ -13,8 +13,10 @@ else()
   set(TYPEART_IS_TOP_LEVEL false)
 endif()
 
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-set(CMAKE_VERBOSE_MAKEFILE ON)
+if(TYPEART_IS_TOP_LEVEL)
+  set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+  set(CMAKE_VERBOSE_MAKEFILE OFF)
+endif()
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -24,13 +26,12 @@ list(
   APPEND
   CMAKE_MODULE_PATH
   ${CMAKE_CURRENT_SOURCE_DIR}/cmake
-  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules
 )
 
-include(ToolchainOptions)
+include(typeartToolchainOptions)
 
-add_format_target(
-  format-sources "Formats project source files"
+typeart_add_format_target(
+  typeart-format-sources "Formats project source files"
   TARGETS lib/passes/*.cpp
           lib/passes/*.h
           lib/runtime/*.cpp
@@ -53,13 +54,13 @@ write_basic_package_version_file(
   COMPATIBILITY SameMinorVersion
 )
 
-set(INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR})
+set(INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME})
 set(LIBRARY_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR})
 set(BINARY_INSTALL_DIR ${CMAKE_INSTALL_BINDIR})
 set(CMAKE_INSTALL_DIR ${TYPEART_INSTALL_CONFIGDIR})
 
 configure_package_config_file(
-  ${PROJECT_SOURCE_DIR}/cmake/Config.cmake.in
+  ${PROJECT_SOURCE_DIR}/cmake/typeartConfig.cmake.in
   ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
   INSTALL_DESTINATION ${TYPEART_INSTALL_CONFIGDIR}
   PATH_VARS INCLUDE_INSTALL_DIR
@@ -76,12 +77,14 @@ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
 # export(PACKAGE ${PROJECT_NAME})
 
 if(TYPEART_IS_TOP_LEVEL)
-  enable_testing()
-  add_subdirectory(test)
-endif()
+  if(TYPEART_TEST_CONFIG)
+    enable_testing()
+    add_subdirectory(test)
+  endif()
 
-feature_summary(WHAT ENABLED_FEATURES PACKAGES_FOUND PACKAGES_NOT_FOUND
-  DESCRIPTION "TypeART ${PROJECT_VERSION} package and feature info:"
-  INCLUDE_QUIET_PACKAGES
-  QUIET_ON_EMPTY
-)
+  feature_summary(WHAT ENABLED_FEATURES PACKAGES_FOUND PACKAGES_NOT_FOUND
+    DESCRIPTION "TypeART ${PROJECT_VERSION} package and feature info:"
+    INCLUDE_QUIET_PACKAGES
+    QUIET_ON_EMPTY
+  )
+endif()

CMakePresets.json

@@ -19,39 +19,39 @@
       "name": "tsan",
       "hidden": true,
       "cacheVariables": {
-        "ENABLE_ASAN": "OFF",
-        "ENABLE_UBSAN": "OFF",
-        "ENABLE_TSAN": "ON"
+        "TYPEART_ASAN": "OFF",
+        "TYPEART_UBSAN": "OFF",
+        "TYPEART_TSAN": "ON"
       }
     },
     {
       "name": "san",
       "hidden": true,
       "cacheVariables": {
-        "ENABLE_ASAN": "ON",
-        "ENABLE_UBSAN": "ON",
-        "ENABLE_TSAN": "OFF"
+        "TYPEART_ASAN": "ON",
+        "TYPEART_UBSAN": "ON",
+        "TYPEART_TSAN": "OFF"
       }
     },
     {
       "name": "thread-unsafe",
       "hidden": true,
       "cacheVariables": {
-        "DISABLE_THREAD_SAFETY": "ON"
+        "TYPEART_DISABLE_THREAD_SAFETY": "ON"
       }
     },
     {
       "name": "safe-ptr",
       "hidden": true,
       "cacheVariables": {
-        "ENABLE_SAFEPTR": "ON"
+        "TYPEART_SAFEPTR": "ON"
       }
     },
     {
       "name": "coverage",
       "hidden": true,
       "cacheVariables": {
-        "ENABLE_CODE_COVERAGE": "ON"
+        "TYPEART_CODE_COVERAGE": "ON"
       }
     },
     {
@@ -65,8 +65,8 @@
       ],
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
-        "TEST_CONFIG": "ON",
-        "SOFTCOUNTERS": "ON"
+        "TYPEART_TEST_CONFIG": "ON",
+        "TYPEART_SOFTCOUNTERS": "ON"
       }
     },
     {
@@ -89,7 +89,7 @@
         "release"
       ],
       "cacheVariables": {
-        "SOFTCOUNTERS": "ON"
+        "TYPEART_SOFTCOUNTERS": "ON"
       }
     },
     {
@@ -137,8 +137,8 @@
         "develop"
       ],
       "cacheVariables": {
-        "ENABLE_ASAN": "OFF",
-        "ENABLE_UBSAN": "OFF"
+        "TYPEART_ASAN": "OFF",
+        "TYPEART_UBSAN": "OFF"
       }
     },
     {