CompilerSupport.hpp

// SPDX-FileCopyrightText: 2025-2026 Vincent Leroy
// SPDX-License-Identifier: MIT
//
// This file is part of dfx.
//
// Licensed under the MIT License. See the LICENSE file in the project root
// for full license information.
 
#pragma once
 
// Project includes
#include "ArchDetection.hpp"
#include "Exception.hpp"
 
#define DFX_PRAGMA(x) _Pragma(#x)
 
#if defined(DFX_PLATFORM_COMPILER_CLANG)
# define DFX_DIAGNOSTIC_PUSH DFX_PRAGMA(clang diagnostic push)
# define DFX_DIAGNOSTIC_POP  DFX_PRAGMA(clang diagnostic pop)
#elif defined(DFX_PLATFORM_COMPILER_GCC)
# define DFX_DIAGNOSTIC_PUSH DFX_PRAGMA(GCC diagnostic push)
# define DFX_DIAGNOSTIC_POP  DFX_PRAGMA(GCC diagnostic pop)
#else
# define DFX_DIAGNOSTIC_PUSH
# define DFX_DIAGNOSTIC_POP
#endif
 
#if defined(DFX_PLATFORM_COMPILER_CLANG)
# define DFX_DIAGNOSTIC_IGNORE(warningName) DFX_PRAGMA(clang diagnostic ignored warningName)
#elif defined(DFX_PLATFORM_COMPILER_GCC)
# define DFX_DIAGNOSTIC_IGNORE(warningName) DFX_PRAGMA(GCC diagnostic ignored warningName)
#else
# define DFX_DIAGNOSTIC_IGNORE(x)
#endif
 
#ifdef DFX_PLATFORM_COMPILER_CLANG_OR_GCC
# define DFX_LIKELY(expr)       __builtin_expect(!!(expr), true)
# define DFX_UNLIKELY(expr)     __builtin_expect(!!(expr), false)
# define DFX_UNREACHABLE_IMPL() std::unreachable()
# define DFX_ATTR(...)          __attribute__((__VA_ARGS__))
#else
# define DFX_LIKELY(expr)       (expr)
# define DFX_UNLIKELY(expr)     (expr)
# define DFX_UNREACHABLE_IMPL() std::abort()
# define DFX_ATTR(expr)
#endif // DFX_PLATFORM_COMPILER_CLANG_OR_GCC
 
#define DFX_ALWAYS_INLINE      DFX_ATTR(always_inline)
#define DFX_PACKED             DFX_ATTR(packed)
#define DFX_ALIGNED(n)         DFX_ATTR(aligned(n))
#define DFX_DEPRECATED         [[deprecated]]
#define DFX_DEPRECATED_X(msg)  [[deprecated(msg)]]
 
#define DFX_UNREACHABLE() do { DFX_THROW("Unreachable code was reached"); DFX_UNREACHABLE_IMPL(); } while (false)