deprecated.h

Go to the documentation of this file.

 
#ifndef A_UTIL_UTIL_PREPROCESSOR_DEPRECATED_HEADER_INCLUDED
#define A_UTIL_UTIL_PREPROCESSOR_DEPRECATED_HEADER_INCLUDED
 
#include <a_util/preprocessor/to_string.h>

#ifdef _MSC_VER
#define DEV_ESSENTIAL_INTERNAL_PRAGMA_WARNING(msg)                                                 \
    __pragma(message(__FILE__ "(" A_UTIL_TO_STRING(__LINE__) "): " msg))
#else // ! _MSC_VER
#define DEV_ESSENTIAL_INTERNAL_TO_PRAGMA_WARNING(msg) A_UTIL_TO_STRING(GCC warning msg)
#define DEV_ESSENTIAL_INTERNAL_STRINGIFY_PRAGMA_WARNING(msg)                                       \
    DEV_ESSENTIAL_INTERNAL_TO_PRAGMA_WARNING(#msg)
#define DEV_ESSENTIAL_INTERNAL_PRAGMA_WARNING(msg)                                                 \
    _Pragma(DEV_ESSENTIAL_INTERNAL_STRINGIFY_PRAGMA_WARNING(msg))
#endif // _MSC_VER
 
#ifndef DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS
#define DEV_ESSENTIAL_DEPRECATED(msg)                                                              \
    [[deprecated(msg " To disable this warning, define "                                           \
                     "DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS.")]]

#ifdef _MSC_VER
#define DEV_ESSENTIAL_DEPRECATED_MACRO(macro_name, reason)                                         \
    DEV_ESSENTIAL_INTERNAL_PRAGMA_WARNING(                                                         \
        "\"" #macro_name                                                                           \
        "\" is deprecated and will be removed in an upcoming version. Reason: " #reason            \
        " Compile with /D \"DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS\" to disable this warning.")
#else  // !_MSC_VER
// clang-format off
#define DEV_ESSENTIAL_DEPRECATED_MACRO(macro_name, reason)                                         \
    DEV_ESSENTIAL_INTERNAL_PRAGMA_WARNING(                                                         \
        #macro_name is deprecated and will be removed in an upcoming version. Reason: reason       \
        Compile with -DDEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS to disable this warning.)
// clang-format on
#endif // _MSC_VER
 
#else // DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS
#define DEV_ESSENTIAL_DEPRECATED(_)
#define DEV_ESSENTIAL_DEPRECATED_MACRO(x, y)
#endif // DEV_ESSENTIAL_DISABLE_DEPRECATED_WARNINGS
 
#endif // A_UTIL_UTIL_PREPROCESSOR_DEPRECATED_HEADER_INCLUDED