hxsettings.h

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#if !LIBHATCHET_VER
#error #include <hx/libhatchet.h> instead.
#endif

#ifndef __has_include
#define __has_include(x) 0
#endif
 
#if defined HX_DOXYGEN_PARSER
#define HX_CPLUSPLUS 202302L // See Doxyfile.
#define HX_C_BEGIN_ extern "C" {
#define HX_C_END_ }
#elif defined __cplusplus
#define HX_CPLUSPLUS __cplusplus
#define HX_C_BEGIN_ extern "C" {
#define HX_C_END_ }
#else
// This is C. Providing 0 here avoids warnings about using undefined variables.
#define HX_CPLUSPLUS 0
#define HX_C_BEGIN_
#define HX_C_END_
#endif
 
#if !defined HX_USE_INLINING_ATTR
#define HX_USE_INLINING_ATTR 1
#endif
 
// -- Target settings for Doxygen ----------------------------------------------
// See the Doxyfile. Run doxygen with no args.
#if defined HX_DOXYGEN_PARSER

#define HX_USE_THREADS 11

#define HX_USE_LIBCXX 1

#define hxbreakpoint() true

#define hxrestrict

#define hxattr_allocator(...)

#define hxattr_assume(...) (void)0

#define hxattr_cold

#define hxattr_flatten

#define hxattr_hot

#define hxattr_nodiscard

#define hxattr_noexcept

#define hxattr_nonnull(...)

#define hxattr_noinline

#define hxattr_noreturn

#define hxattr_printf(...)

#define hxattr_weak

#define hxinline inline
 
// -- Target settings for MSVC -------------------------------------------------
// MSVC doesn't support C++'s feature test macros very well.
#elif defined _MSC_VER
 
#if defined __clang__
#error Clang detected masquerading as MSVC - not supported due to intrinsic use.
#endif
 
#if !defined __cpp_exceptions && !defined _HAS_EXCEPTIONS
#define _HAS_EXCEPTIONS 0
#endif
 
#if !defined HX_USE_THREADS
#define HX_USE_THREADS 11
#endif
 
#if !defined HX_USE_LIBCXX
#define HX_USE_LIBCXX 1
#endif
 
#define hxbreakpoint() (__debugbreak(),true)
#define hxrestrict __restrict
#define hxattr_allocator(...)
#define hxattr_assume(condition_) __assume(condition_)
#define hxattr_cold
#define hxattr_flatten
#define hxattr_hot
#if HX_CPLUSPLUS
#define hxattr_nodiscard [[nodiscard]]
#else
#define hxattr_nodiscard
#endif
#define hxattr_noexcept
#define hxattr_nonnull(...)
#define hxattr_noinline __declspec(noinline)
#if HX_CPLUSPLUS
#define hxattr_noreturn [[noreturn]]
#else
#define hxattr_noreturn
#endif
#define hxattr_printf(...)
// #define hxattr_weak __declspec(selectany) is not used as MSVC treats all
// library objects as weak.
#define hxattr_weak
 
#if HX_USE_INLINING_ATTR
#define hxinline inline __forceinline
#else
#define hxinline inline
#endif
 
// -- Target settings for Clang and GCC ----------------------------------------
// Further compilers will require customization.
#else // Assume gcc/clang.
 
// hxthreads.hpp should work in C++11 with pthread.h. _POSIX_THREADS is the
// correct way to observe the -pthread compiler flag.
#if !defined HX_USE_THREADS
#if __has_include(<threads.h>)
#define HX_USE_THREADS 11
#elif defined _POSIX_THREADS
#define HX_USE_THREADS 1
#else
#define HX_USE_THREADS 0
#endif
#endif
 
#if !defined HX_USE_LIBCXX
#define HX_USE_LIBCXX 1
#elif !(HX_USE_LIBCXX) && !defined HX_SKIP_LIBCXX_CHECK && __has_include(<new>)
#error Use -nostdinc++ to use the C headers instead of the C++ ones.
#endif
 
// HX_USE_SIGTRAP is not always defined like the other HX_USE_* macros.
#if !defined HX_USE_SIGTRAP && defined __has_builtin && __has_builtin(__builtin_debugtrap)
#define hxbreakpoint() (__builtin_debugtrap(),true)
#else
#define hxbreakpoint() (raise(SIGTRAP),true)
#endif
 
#define hxrestrict __restrict
 
// hxattr_allocator - Collection of attributes for allocators.
#if defined __clang__
#define hxattr_allocator(...) \
    __attribute__((returns_nonnull)) __attribute__((warn_unused_result))
#elif __GNUC__ >= 11
#define hxattr_allocator(...) __attribute__((malloc(__VA_ARGS__))) \
    __attribute__((returns_nonnull)) __attribute__((warn_unused_result))
#else
#define hxattr_allocator(...) __attribute__((malloc)) \
    __attribute__((returns_nonnull)) __attribute__((warn_unused_result))
#endif
 
#if defined __clang__
#define hxattr_assume(condition_) __builtin_assume(condition_)
#else
// The solution for gcc may have side effects. Use with caution.
// #define hxattr_assume(condition_) (void)((bool)(condition_) || (__builtin_unreachable(),0))
#define hxattr_assume(...) (void)0
#endif
 
// __attribute__ is used instead of [[...]] because it works in an extern "C"
// block.
 
#define hxattr_cold __attribute__((cold))
#if HX_USE_INLINING_ATTR && (defined __clang__ || __GNUC__ >= 11)
#define hxattr_flatten __attribute__((flatten))
#else
#define hxattr_flatten
#endif
#if HX_USE_INLINING_ATTR
#define hxattr_hot __attribute__((hot))
#else
#define hxattr_hot
#endif
#define hxattr_nodiscard __attribute__((warn_unused_result))
#define hxattr_noexcept __attribute__((nothrow))
#define hxattr_nonnull(...)__attribute__((nonnull(__VA_ARGS__)))
#define hxattr_noinline __attribute__((noinline))
#define hxattr_noreturn __attribute__((noreturn))
#define hxattr_printf(pos_, start_) __attribute__((format(printf, pos_, start_)))
#define hxattr_weak __attribute__((weak))
 
#ifndef hxinline
#if HX_USE_INLINING_ATTR
#define hxinline inline __attribute__((always_inline))
#else
#define hxinline inline
#endif
#endif
 
#endif // target specific settings
 
// -- Target independent -------------------------------------------------------
#if HX_CPLUSPLUS >= 202302L
#define hxconstexpr constexpr
#else
#define hxconstexpr
#endif // HX_CPLUSPLUS < 202302L
 
#if HX_CPLUSPLUS >= 201703L
#define hxinline_constexpr inline constexpr
#define hxif_constexpr if constexpr
#else
#define hxinline_constexpr constexpr
#define hxif_constexpr if
#endif
 
#if !defined HX_USE_MACROS_WITH_MODULE
#define HX_USE_MACROS_WITH_MODULE 0
#endif
 
#if !defined HX_USE_CONSOLE
#define HX_USE_CONSOLE ((HX_CPLUSPLUS >= 202002L) ? 1 : 0)
#elif (HX_USE_CONSOLE) && HX_CPLUSPLUS && HX_CPLUSPLUS < 202002L
#error The console requires C++20 or later.
#endif
#if (HX_USE_CONSOLE) > 1 && defined __wasm__
// This warning is primarily for security and sanity checking reasons.
#error The debug console is not designed for use with WASM.
#endif
 
#if !defined HX_USE_LOGGING
#define HX_USE_LOGGING 2
#endif
 
#if !defined HX_USE_FILE_IO
#define HX_USE_FILE_IO 1
#endif
 
#if !defined HX_USE_PROFILER
#define HX_USE_PROFILER 0
#endif
 
#if !defined HX_CYCLES_PER_SECOND
#define HX_CYCLES_PER_SECOND 3.0e+9
#endif
 
#if !defined HX_PROFILER_MAX_RECORDS
#define HX_PROFILER_MAX_RECORDS 4096
#endif
 
#if !defined HX_USE_MEMORY_MANAGER
#define HX_USE_MEMORY_MANAGER 1
#endif
 
#if !defined HX_PROVIDE_NEW_DELETE
#define HX_PROVIDE_NEW_DELETE !(HX_USE_LIBCXX)
#endif

#define HX_KIB (1 << 10)

#define HX_MIB (1 << 20)

#define HX_GIB (1 << 30)
 
#if !defined HX_MEMORY_BUDGET_PERMANENT
#define HX_MEMORY_BUDGET_PERMANENT      (4u * HX_KIB)
#endif
 
#if !defined HX_MEMORY_MAX_STACKS
#define HX_MEMORY_MAX_STACKS 3u
#endif
 
#if !defined HX_RADIX_SORT_MIN_SIZE
#define HX_RADIX_SORT_MIN_SIZE 32
#endif
 
#if !defined HX_MAX_LINE
#define HX_MAX_LINE (2 * HX_KIB)
#endif
 
#if !defined HX_USE_GOOGLE_TEST
#define HX_USE_GOOGLE_TEST 0
#endif
 
#if (HX_HARDENING_MODE) == HX_HARDENING_MODE_DEBUG && defined __GLIBC__ && !defined __FAST_MATH__
#if !defined HX_USE_FLOATING_POINT_TRAPS
#define HX_USE_FLOATING_POINT_TRAPS 1
#endif
#else
#undef HX_USE_FLOATING_POINT_TRAPS
#define HX_USE_FLOATING_POINT_TRAPS 0
#endif

#define HX_QUOTE(x_) #x_

// `HX_TEST_ERROR_HANDLING` - Tests that the failure of tests is handled
// correctly. Set to `0` if not defined. Set by `testerrorhandling.sh` and
// `coverage.sh`.
#if !defined HX_TEST_ERROR_HANDLING
#define HX_TEST_ERROR_HANDLING 0
#endif
 
#if HX_CPLUSPLUS
// HX_USE_* feature test flags must not be empty as that is evaluated as 0.
#define HX_CHECK_USE_(x_) static_assert(HX_QUOTE(x_)[0] != 0, #x_ " must not be empty");
HX_CHECK_USE_(HX_PROVIDE_NEW_DELETE)
HX_CHECK_USE_(HX_TEST_ERROR_HANDLING)
HX_CHECK_USE_(HX_USE_CONSOLE)
HX_CHECK_USE_(HX_USE_FILE_IO)
HX_CHECK_USE_(HX_USE_FLOATING_POINT_TRAPS)
HX_CHECK_USE_(HX_USE_GOOGLE_TEST)
HX_CHECK_USE_(HX_USE_INLINING_ATTR)
HX_CHECK_USE_(HX_USE_LIBCXX)
HX_CHECK_USE_(HX_USE_LOGGING)
HX_CHECK_USE_(HX_USE_MEMORY_MANAGER)
HX_CHECK_USE_(HX_USE_MACROS_WITH_MODULE)
HX_CHECK_USE_(HX_USE_PROFILER)
HX_CHECK_USE_(HX_USE_THREADS)
#endif
 
// HX_APPEND_COUNTER - Used to generate unique identifiers. This is weird
// because the ## operator happens before macro arg evaluation and both happen
// before general macro evaluation.
#define HX_APPEND_COUNTER2_(x_, y_) x_ ## y_
#define HX_APPEND_COUNTER_(x_, y_) HX_APPEND_COUNTER2_(x_, y_)
#define HX_APPEND_COUNTER(x_) HX_APPEND_COUNTER_(x_, __COUNTER__)
 
// HX_INL_BEGIN_/HX_INL_END_ - These allow excluding .inl files from the module
// export block. See hxmodule.cppm for details.
#if !defined HX_INL_BEGIN_
#define HX_INL_BEGIN_
#define HX_INL_END_
#endif
 
// HX_USE_NAMESPACE - Wraps the entire library in a namespace when HX_USE_NAMESPACE is
// defined as a valid namespace identifier.
#if HX_CPLUSPLUS && defined HX_USE_NAMESPACE
HX_CHECK_USE_(HX_USE_NAMESPACE)
#define HX_NS_BEGIN_  namespace HX_USE_NAMESPACE {
#define HX_NS_END_    }
#define HX_NS_PREFIX_ HX_USE_NAMESPACE::
#define HX_NS_USE     using namespace HX_USE_NAMESPACE;
#else
#define HX_NS_BEGIN_
#define HX_NS_END_
#define HX_NS_PREFIX_
#define HX_NS_USE
#endif
 
#if !(HX_USE_MACROS_WITH_MODULE)
HX_C_BEGIN_

struct hxsettings_t {
    uint8_t log_level;

    bool deallocate_permanent;

    bool test_break_on_failure;

    const char* test_filter;
};

extern struct hxsettings_t hxg_settings;

void hxsettings_construct_(void);
 
HX_C_END_
#endif // HX_USE_MACROS_WITH_MODULE