cc.h

Go to the documentation of this file.

/**
 * @file cc.h
 * @brief Utility marks which could partially be available with gnu compiler.
 * @details Keys.h will utilise it to have keywords
 * */
#include "./LangVer.h"
 
/**
 * @def _ae2f_gnuc
 * @brief Available when compiled with gcc compiler.
 *
 * @def N_ae2f_gnuc
 * @brief Available when not compiled with gnu compiler.
 * */
#undef  _ae2f_gnuc
#undef  N_ae2f_gnuc
#if defined(__GNUC__)
#define _ae2f_gnuc(a)   a
#define N_ae2f_gnuc(a)
#else
#define _ae2f_gnuc(a)
#define N_ae2f_gnuc(a)  a
#endif
 
/**
 * @def _ae2f_msvc
 * @brief Available when compiled with msvc.
 *
 * @def N_ae2f_msvc
 * @brief Available when not compiled with msvc.
 * */
#undef  _ae2f_msvc
#undef  N_ae2f_msvc
#if defined(_MSC_VER)
#define _ae2f_msvc(a)   a
#define N_ae2f_msvc(a)
#else
#define _ae2f_msvc(a)
#define N_ae2f_msvc(a)  a
#endif
 
/** 
 * @def ae2f_ccpure
 * @brief Keyword as `[[pure]]` on C23.
 * */
#undef  ae2f_ccpure
#if _ae2f_gnuc(!)0
#define ae2f_ccpure __attribute__((pure))
#elif   __ae2f_stdcheck_C(202300L) && ae2f_stdcc_v
#define ae2f_ccpure [[pure]]
#else
#define ae2f_ccpure
#endif
 
 
/** 
 * @def ae2f_ccconst
 * @brief Keyword as `[[const]]` on C23..
 * */
#undef  ae2f_ccconst
#if _ae2f_gnuc(!)0
#define ae2f_ccconst    __attribute__((const))
#elif __ae2f_stdcheck_C(202300L) && ae2f_stdcc_v
#define ae2f_ccconst    [[const]]
#else
#define ae2f_ccconst
#endif
 
/** 
 * @def ae2f_restrict
 * @brief Keyword as `restrict` on C99.
 * */
#undef  ae2f_restrict
#if _ae2f_gnuc(!)0
#define ae2f_restrict   __restrict
#elif   _ae2f_msvc(!)0
#define ae2f_restrict   __restrict
#elif   __ae2f_stdcheck_C(199900L) && ae2f_stdcc_v
#define ae2f_restrict   restrict
#else
#define ae2f_restrict
#endif
 
/**
 * @def ae2f_retnew
 * @brief The returning pointer does not alias to existing object.
 * */
#undef  ae2f_retnew
#if _ae2f_msvc(1) +0
#define ae2f_retnew __declspec(restrict)
#elif   _ae2f_gnuc(!)0
#define ae2f_retnew __attribute__((malloc))
#else
#define ae2f_retnew
#endif
 
/**
 * @def ae2f_decl
 * @brief Function declare for shared object
 * */
#undef  ae2f_decl
#if _ae2f_msvc(1) +0
#define ae2f_decl   __declspec(dllimport)
#else
#define ae2f_decl
#endif
 
/**
 * @def ae2f_impl
 * @brief Function implementation for shared object
 * */
#undef  ae2f_impl
#if _ae2f_gnuc(!)0
#define ae2f_impl   __attribute__((visibility("default")))
#elif   _ae2f_msvc(!)0
#define ae2f_impl   __declspec(dllexport)
#else
#define ae2f_impl
#endif
 
/**
 * @def ae2f_noexcept
 * @brief marker that this function does not throw something.
 * */
#undef  ae2f_noexcept
#if _ae2f_gnuc(!)0
#define ae2f_noexcept   __attribute__((nothrow))
#elif   _ae2f_msvc(!)0
#define ae2f_noexcept   __declspec(nothrow)
#elif   ae2f_stdcc_v >= 201100L
#define ae2f_noexcept   noexcept
#else
#define ae2f_noexcept
#endif
 
 
/**
 * @def     ae2f_inline
 * @brief   `inline`
 * */
#undef  ae2f_inline
#if _ae2f_gnuc(!)0
#define     ae2f_inline __inline__
#elif   _ae2f_msvc(!)0
#define     ae2f_inline __inline
#elif   ae2f_stdc_v >= 199900L || ae2f_stdcc_v
#define     ae2f_inline inline
#else
#define     ae2f_inline
#endif
 
/**
 * @def     ae2f_fallthrough
 * @brief   explicitly tells compiler that fallthrough on switch is expected.
 * */
#undef  ae2f_fallthrough
#if _ae2f_gnuc(!)0
#define     ae2f_fallthrough    __attribute__((fallthrough))
#elif   _ae2f_msvc(!)0 && _MSC_VER >= 1934
#define     ae2f_fallthrough    [[fallthrough]]
#elif   ae2f_stdc_v >= 202300L || ae2f_stdcc_v
#define     ae2f_fallthrough    [[fallthrough]]
#else
#define     ae2f_fallthrough
#endif
 
 
/**
 * @def     ae2f_expected
 * @brief   expectes `a` as `true`.
 *
 * @def     ae2f_expected_not
 * @brief   expectes `a` as `false`.
 * */
#undef  ae2f_expected
#undef  ae2f_expected_not
#if _ae2f_gnuc(!)0
#define     ae2f_expected(a)    (__builtin_expect(!!(a), 1))
#define     ae2f_expected_not(a)    (__builtin_expect(!!(a), 0))
#elif   _ae2f_msvc(!)0 && _MSVC_LANG >= 202002L || ae2f_stdcc_v >= 202002L
#define     ae2f_expected(a)    (a) [[likely]]
#define     ae2f_expected_not(a)    (a) [[unlikely]]
#else
#define     ae2f_expected(a)    a
#define     ae2f_expected_not(a)    a
#endif
 
#undef      ae2f_unexpected
#define     ae2f_unexpected     ae2f_expected_not
 
#undef  ae2f_unexpected_but_if
#define ae2f_unexpected_but_if(a)   if(ae2f_expected_not(a))
 
#undef  ae2f_expected_if
#define ae2f_expected_if(a)     if(ae2f_expected(a))
 
#undef  ae2f_unexpected_else
#define ae2f_unexpected_else(a)     if(!ae2f_unexpected(a))
 
#undef  ae2f_expected_but_else
#define ae2f_expected_but_else(a)   if(!(ae2f_expected(a)))
 
/**
 * @def     ae2f_unreachable
 * @brief   tells the compiler that below this keyword is not expected to be reached.
 * */
#undef  ae2f_unreachable
#if _ae2f_gnuc(!)0
#define     ae2f_unreachable()  __builtin_unreachable()
#elif   _ae2f_msvc(!)0
#define     ae2f_unreachable()  __assume(0)
#else
#define     ae2f_unreachable()
#endif
 
/**
 * @def     ae2f_assume
 * @brief   tells the compiler that value if `a` is `false`, 
 * below this keyword is not expected to be reached.
 * @see ae2f_unreachable
 * */
#undef  ae2f_assume
#if _ae2f_gnuc(!)0 && (__GNUC__ >= 13)
#define     ae2f_assume(a)  __attribute__((__assume__(a)))
#elif   _ae2f_msvc(!)0
#define     ae2f_assume(a)  __assume(a)
#else
#define     ae2f_assume(a)  if(!(a)) { ae2f_unreachable(); }
#endif