CompilerSupport.hpp

// SPDX-FileCopyrightText: 2025 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 DIAGNOSTIC_PRAGMA(x) _Pragma(#x)
 
#if defined(PLATFORM_COMPILER_CLANG)
# define DIAGNOSTIC_PUSH DIAGNOSTIC_PRAGMA(clang diagnostic push)
# define DIAGNOSTIC_POP  DIAGNOSTIC_PRAGMA(clang diagnostic pop)
#elif defined(PLATFORM_COMPILER_GCC)
# define DIAGNOSTIC_PUSH DIAGNOSTIC_PRAGMA(GCC diagnostic push)
# define DIAGNOSTIC_POP  DIAGNOSTIC_PRAGMA(GCC diagnostic pop)
#else
# define DIAGNOSTIC_PUSH
# define DIAGNOSTIC_POP
#endif
 
#if defined(PLATFORM_COMPILER_CLANG)
# define DIAGNOSTIC_IGNORE(warningName) DIAGNOSTIC_PRAGMA(clang diagnostic ignored warningName)
#elif defined(PLATFORM_COMPILER_GCC)
# define DIAGNOSTIC_IGNORE(warningName) DIAGNOSTIC_PRAGMA(GCC diagnostic ignored warningName)
#else
# define DIAGNOSTIC_IGNORE(x)
#endif
 
#ifdef PLATFORM_COMPILER_CLANG_OR_GCC
# define LIKELY(expr)       __builtin_expect(!!(expr), true)
# define UNLIKELY(expr)     __builtin_expect(!!(expr), false)
# define UNREACHABLE_IMPL() std::unreachable()
# define VISIBLE_FUNC_ATTR   __attribute__((visibility("default")))
# define HIDDEN_FUNC_ATTR    __attribute__((visibility("hidden")))
# define ALWAYS_INLINE_ATTR  __attribute__((always_inline))
#else
# define LIKELY(expr)       (expr)
# define UNLIKELY(expr)     (expr)
# define UNREACHABLE_IMPL() std::abort()
# define VISIBLE_FUNC_ATTR
# define HIDDEN_FUNC_ATTR
# define ALWAYS_INLINE_ATTR
#endif // PLATFORM_COMPILER_CLANG_OR_GCC
 
#define UNREACHABLE() do { THROW("Unreachable code was reached"); UNREACHABLE_IMPL(); } while (false)