Add experimental support for libassert

Morwenn · Jul 22, 2023 · 48593f2 · 48593f2
1 parent 3a5bca3
commit 48593f2
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 11 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,6 +17,18 @@ option(CPPSORT_BUILD_TESTING "Build the cpp-sort test suite" ${BUILD_TESTING})
 option(CPPSORT_BUILD_EXAMPLES "Build the cpp-sort examples" ${BUILD_EXAMPLES})
 option(CPPSORT_ENABLE_AUDITS "Enable assertions in the library" OFF)
 option(CPPSORT_ENABLE_ASSERTIONS "Enable assertions in the library" ${CPPSORT_ENABLE_AUDITS})
+option(CPPSORT_USE_LIBASSERT "Use libassert for assertions (experimental)" OFF)
+
+# Optionally use libassert for assertions
+if (CPPSORT_USE_LIBASSERT)
+    include(DownloadProject)
+    download_project(PROJ libassert
+                     GIT_REPOSITORY https://github.com/jeremy-rifkin/libassert
+                     GIT_TAG main
+                     UPDATE_DISCONNECTED 1
+    )
+    add_subdirectory(${libassert_SOURCE_DIR} ${libassert_BINARY_DIR})
+endif()
 
 # Create cpp-sort library and configure it
 add_library(cpp-sort INTERFACE)
@@ -29,7 +41,10 @@ target_compile_features(cpp-sort INTERFACE cxx_std_14)
 
 # MSVC won't work without a stricter standard compliance
 if (MSVC)
-    target_compile_options(cpp-sort INTERFACE /permissive-)
+    target_compile_options(cpp-sort INTERFACE
+        /permissive-
+        /Zc:preprocessor
+    )
 endif()
 
 # Handle diagnostic options
@@ -40,6 +55,16 @@ if (CPPSORT_ENABLE_AUDITS)
     target_compile_definitions(cpp-sort INTERFACE CPPSORT_ENABLE_AUDITS)
 endif()
 
+# Optionally link to libassert
+if (CPPSORT_USE_LIBASSERT)
+    target_link_libraries(cpp-sort INTERFACE
+        assert
+        $<$<BOOL:${WIN32}>:dbghelp>
+        ${CMAKE_DL_LIBS}
+    )
+    target_compile_definitions(cpp-sort INTERFACE CPPSORT_USE_LIBASSERT)
+endif()
+
 add_library(cpp-sort::cpp-sort ALIAS cpp-sort)
 
 # Install targets and files

diff --git a/include/cpp-sort/detail/config.h b/include/cpp-sort/detail/config.h
@@ -68,6 +68,9 @@
 
 #if defined(CPPSORT_ENABLE_ASSERTIONS)
 #   include <cassert>
+#   if defined(CPPSORT_USE_LIBASSERT)
+#       include <assert.hpp>
+#   endif
 #endif
 
 ////////////////////////////////////////////////////////////
@@ -78,11 +81,21 @@
 // explicitly enabled in cpp-sort
 
 #if !defined(NDEBUG) && defined(CPPSORT_ENABLE_ASSERTIONS)
-#   ifndef CPPSORT_ASSERT
-#       define CPPSORT_ASSERT(...) assert((__VA_ARGS__))
+#   if !defined(CPPSORT_ASSERT)
+#       if defined(CPPSORT_USE_LIBASSERT)
+#           define CPPSORT_ASSERT(...) ASSERT(__VA_ARGS__)
+#       else
+#           define CPPSORT_ARG2(_0, _1, _2, ...) _2
+#           define CPPSORT_NARG2(...) CPPSORT_ARG2(__VA_ARGS__, 2, 1, 0)
+#           define CPPSORT_ONE_OR_TWO_ARGS_1(condition) assert(condition)
+#           define CPPSORT_ONE_OR_TWO_ARGS_2(condition, message) assert(condition && message)
+#           define CPPSORT_ONE_OR_TWO_ARGS_N(N, ...) CPPSORT_ONE_OR_TWO_ARGS_##N(__VA_ARGS__)
+#           define CPPSORT_ONE_OR_TWO_ARGS(N, ...) CPPSORT_ONE_OR_TWO_ARGS_N(N, __VA_ARGS__)
+#           define CPPSORT_ASSERT(...) CPPSORT_ONE_OR_TWO_ARGS(CPPSORT_NARG2(__VA_ARGS__), __VA_ARGS__)
+#       endif
 #   endif
 #else
-#   define CPPSORT_ASSERT(...)
+#   define CPPSORT_ASSERT(...) ((void)0)
 #endif
 
 ////////////////////////////////////////////////////////////
@@ -97,7 +110,7 @@
 #       define CPPSORT_AUDIT(...) CPPSORT_ASSERT(__VA_ARGS__)
 #   endif
 #else
-#   define CPPSORT_AUDIT(...)
+#   define CPPSORT_AUDIT(...) ((void)0)
 #endif
 
 ////////////////////////////////////////////////////////////
@@ -118,7 +131,7 @@
 #elif defined(_MSC_VER)
 #   define CPPSORT_ASSUME(expression) __assume(expression)
 #else
-#   define CPPSORT_ASSUME(cond)
+#   define CPPSORT_ASSUME(cond) ((void)0)
 #endif
 
 ////////////////////////////////////////////////////////////
@@ -129,13 +142,13 @@
 // reached
 
 #if !defined(NDEBUG) && defined(CPPSORT_ENABLE_AUDITS)
-#   define CPPSORT_UNREACHABLE CPPSORT_ASSERT(false && "unreachable");
+#   define CPPSORT_UNREACHABLE CPPSORT_ASSERT(false, "unreachable")
 #elif defined(__GNUC__) || defined(__clang__)
 #   define CPPSORT_UNREACHABLE __builtin_unreachable()
 #elif defined(_MSC_VER)
 #   define CPPSORT_UNREACHABLE __assume(false)
 #else
-#   define CPPSORT_UNREACHABLE
+#   define CPPSORT_UNREACHABLE ((void)0)
 #endif
 
 ////////////////////////////////////////////////////////////

diff --git a/include/cpp-sort/detail/timsort.h b/include/cpp-sort/detail/timsort.h
@@ -6,7 +6,7 @@
  * - http://cr.openjdk.java.net/~martin/webrevs/openjdk7/timsort/raw_files/new/src/share/classes/java/util/TimSort.java
  *
  * Copyright (c) 2011 Fuji, Goro (gfx) <gfuji@cpan.org>.
- * Copyright (c) 2015-2022 Morwenn.
+ * Copyright (c) 2015-2023 Morwenn.
  * Copyright (c) 2021 Igor Kushnir <igorkuo@gmail.com>.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -565,7 +565,7 @@ namespace detail
                 dest[len2] = iter_move(cursor1);
             }
             else {
-                CPPSORT_ASSERT(len1 != 0 && "comparison function violates its general contract");
+                CPPSORT_ASSERT(len1 != 0, "comparison function violates its general contract");
                 CPPSORT_ASSERT(len2 == 0);
                 CPPSORT_ASSERT(len1 > 1);
                 detail::move(cursor1, cursor1 + len1, dest);
@@ -715,7 +715,7 @@ namespace detail
                 detail::move_backward(cursor1 - len1, cursor1, dest + (1 + len1));
                 *dest = iter_move(cursor2);
             } else {
-                CPPSORT_ASSERT(len2 != 0 && "comparison function violates its general contract");
+                CPPSORT_ASSERT(len2 != 0, "comparison function violates its general contract");
                 CPPSORT_ASSERT(len1 == 0);
                 CPPSORT_ASSERT(len2 > 1);
                 detail::move(buffer.get(), buffer.get() + len2, dest - (len2 - 1));