core.hpp

Go to the documentation of this file.

#pragma once
 
// Platform-specific API macros
#ifdef HELIOS_PLATFORM_WINDOWS
#ifdef HELIOS_BUILD_SHARED
#define HELIOS_API __declspec(dllexport)
#else
#define HELIOS_API __declspec(dllimport)
#endif
#elifdef HELIOS_PLATFORM_LINUX
#ifdef HELIOS_BUILD_SHARED
#define HELIOS_API __attribute__((visibility("default")))
#else
#define HELIOS_API
#endif
#else
#define HELIOS_API
#endif
 
#ifdef HELIOS_PLATFORM_WINDOWS
#define HELIOS_EXPORT __declspec(dllexport)
#elifdef HELIOS_PLATFORM_LINUX
#define HELIOS_EXPORT __attribute__((visibility("default")))
#else
#define HELIOS_EXPORT
#endif
 
// Debug break functionality
#ifdef HELIOS_ENABLE_ASSERTS
 
// TODO: Replace with std::breakpoint() from <debugging> in C++26
// https://en.cppreference.com/w/cpp/utility/breakpoint.html
 
// MSVC: Use the intrinsic which maps to the appropriate inlined assembly
#if defined(_MSC_VER) && (_MSC_VER >= 1300)
#define HELIOS_DEBUG_BREAK() __debugbreak()
 
// ARM64 on Apple: Use signal-based break (better debugger integration)
#elif defined(__arm64__) && defined(__APPLE__)
#include <unistd.h>
#include <csignal>
#define HELIOS_DEBUG_BREAK() ::kill(::getpid(), SIGINT)
 
// ARM64 with GCC/Clang: Use brk instruction
#elif defined(__arm64__) && (defined(__GNUC__) || defined(__clang__))
#define HELIOS_DEBUG_BREAK() __asm__("brk 0")
 
// ARM (32-bit) on Apple: Use trap instruction
#elif defined(__arm__) && defined(__APPLE__)
#define HELIOS_DEBUG_BREAK() __asm__("trap")
 
// ARM (32-bit) with GCC/Clang: Use bkpt instruction
#elif defined(__arm__) && (defined(__GNUC__) || defined(__clang__))
#define HELIOS_DEBUG_BREAK() __asm__("bkpt 0")
 
// ARM with Arm Compiler: Use breakpoint intrinsic
#elif defined(__arm__) && defined(__ARMCC_VERSION)
#define HELIOS_DEBUG_BREAK() __breakpoint(0)
 
// x86/x86_64 with Clang/GCC: Use int3 instruction (AT&T syntax)
#elif (defined(__x86_64__) || defined(__i386__)) && (defined(__GNUC__) || defined(__clang__))
#define HELIOS_DEBUG_BREAK() __asm__("int3")
 
// x86/x86_64 with MSVC: Use int3 instruction (Intel syntax)
#elif (defined(_M_X64) || defined(_M_IX86)) && defined(_MSC_VER)
#define HELIOS_DEBUG_BREAK() __asm int 3
 
// PowerPC: Trigger exception via opcode 0x00000000
#elif defined(__powerpc__) || defined(__ppc__) || defined(_ARCH_PPC)
#define HELIOS_DEBUG_BREAK() __asm__(".long 0")
 
// WebAssembly: No breakpoint support, use unreachable
#elif defined(__wasm__)
#define HELIOS_DEBUG_BREAK() __asm__("unreachable")
 
// Fallback: Use compiler builtin trap (works on most modern compilers)
#elif defined(__has_builtin) && __has_builtin(__builtin_trap)
#define HELIOS_DEBUG_BREAK() __builtin_trap()
 
// Last resort: Use signal-based approach
#else
#include <csignal>
#define HELIOS_DEBUG_BREAK() ::std::raise(SIGTRAP)
 
#endif
 
#else
// Debug break disabled in release builds
#define HELIOS_DEBUG_BREAK()
#endif
 
#include <utility>
#define HELIOS_UNREACHABLE() std::unreachable()
 
// Release mode unreachable
#ifndef HELIOS_DEBUG_MODE
#define HELIOS_RELEASE_UNREACHABLE() HELIOS_UNREACHABLE()
#else
#define HELIOS_RELEASE_UNREACHABLE()
#endif
 
// Utility macros
#define HELIOS_BIT(x) (1 << (x))
 
// Stringify macros
#define HELIOS_STRINGIFY_IMPL(x) #x
#define HELIOS_STRINGIFY(x) HELIOS_STRINGIFY_IMPL(x)
 
// Concatenation macros
#define HELIOS_CONCAT_IMPL(a, b) a##b
#define HELIOS_CONCAT(a, b) HELIOS_CONCAT_IMPL(a, b)
 
// Anonymous variable generation
#define HELIOS_ANONYMOUS_VAR(prefix) HELIOS_CONCAT(prefix, __LINE__)
 
// Force inline macros
#ifdef _MSC_VER
#define HELIOS_FORCE_INLINE __forceinline
#elif defined(__GNUC__) || defined(__clang__)
#define HELIOS_FORCE_INLINE __attribute__((always_inline)) inline
#else
#define HELIOS_FORCE_INLINE inline
#endif
 
// No inline macros
#ifdef _MSC_VER
#define HELIOS_NO_INLINE __declspec(noinline)
#elif defined(__GNUC__) || defined(__clang__)
#define HELIOS_NO_INLINE __attribute__((noinline))
#else
#define HELIOS_NO_INLINE
#endif
 
// Compiler-specific branch prediction hints (fallback)
#if defined(__GNUC__) || defined(__clang__)
#define HELIOS_EXPECT_TRUE(x) __builtin_expect(!!(x), 1)
#define HELIOS_EXPECT_FALSE(x) __builtin_expect(!!(x), 0)
#else
#define HELIOS_EXPECT_TRUE(x) (x)
#define HELIOS_EXPECT_FALSE(x) (x)
#endif
 
#if defined(__cpp_lib_move_only_function) && __cpp_lib_move_only_function >= 202110L
#define HELIOS_MOVEONLY_FUNCTION_AVALIABLE
#endif
 
#if defined(__cpp_lib_containers_ranges) && __cpp_lib_containers_ranges >= 202202L
#define HELIOS_CONTAINERS_RANGES_AVALIABLE
#endif