Warnings.hpp

Go to the documentation of this file.

#pragma once
/// @file Warnings.hpp
/// @brief Cross-compiler macros for saving / restoring / disabling warnings.
///
/// Typical pattern around third-party headers that generate noise:
/// ```cpp
/// DISABLE_WARNING_PUSH
/// DISABLE_WARNING_UNUSED_VALUE
/// #include "noisy_header.h"
/// DISABLE_WARNING_POP
/// ```
///
/// Each supported compiler (MSVC, clang-MSVC, clang, GCC) provides the full
/// macro set; others fall through to no-ops.
 
/*------------------------------------------*/
// Warning disabler:
 
#if defined(_MSC_VER) && defined(_WIN32) && !defined(__clang__)
#    define DISABLE_WARNING_PUSH __pragma(warning(push))
#    define DISABLE_WARNING_POP __pragma(warning(pop))
#    define DISABLE_WARNING(warningNumber) __pragma(warning(disable : warningNumber))
 
#    define DISABLE_WARNING_UNREFERENCED_FORMAL_PARAMETER DISABLE_WARNING(4100)
#    define DISABLE_WARNING_UNREFERENCED_FUNCTION DISABLE_WARNING(4505)
#    define DISABLE_WARNING_DEPRECATED_DECLARATIONS
#    define DISABLE_WARNING_UNUSED_VALUE
#    define DISABLE_WARNING_MAYBE_UNINITIALIZED
#    define DISABLE_WARNING_CLASS_MEMACCESS
// other warnings you want to deactivate...
 
#elif defined(_MSC_VER) && defined(_WIN32) && defined(__clang__) // for clang-msvc on win, change a bit from unix version
 
#    define DO_PRAGMA(X) _Pragma(#X)
#    define DISABLE_WARNING_PUSH DO_PRAGMA(GCC diagnostic push)
#    define DISABLE_WARNING_POP DO_PRAGMA(GCC diagnostic pop)
#    define DISABLE_WARNING(warningName) DO_PRAGMA(GCC diagnostic ignored warningName)
 
#    define DISABLE_WARNING_UNREFERENCED_FORMAL_PARAMETER DISABLE_WARNING("-Wunused-parameter")
#    define DISABLE_WARNING_UNREFERENCED_FUNCTION DISABLE_WARNING("-Wunused-function")
#    define DISABLE_WARNING_DEPRECATED_DECLARATIONS DISABLE_WARNING("-Wdeprecated-declarations")
#    define DISABLE_WARNING_UNUSED_VALUE DISABLE_WARNING("-Wunused-value")
#    define DISABLE_WARNING_MAYBE_UNINITIALIZED
#    define DISABLE_WARNING_CLASS_MEMACCESS
 
#elif defined(__clang__) // unix + gcc/clang
 
#    define DO_PRAGMA(X) _Pragma(#X)
#    define DISABLE_WARNING_PUSH DO_PRAGMA(GCC diagnostic push)
#    define DISABLE_WARNING_POP DO_PRAGMA(GCC diagnostic pop)
#    define DISABLE_WARNING(warningName) DO_PRAGMA(GCC diagnostic ignored warningName)
 
#    define DISABLE_WARNING_UNREFERENCED_FORMAL_PARAMETER DISABLE_WARNING("-Wunused-parameter")
#    define DISABLE_WARNING_UNREFERENCED_FUNCTION DISABLE_WARNING("-Wunused-function")
#    define DISABLE_WARNING_DEPRECATED_DECLARATIONS DISABLE_WARNING("-Wdeprecated-declarations")
#    define DISABLE_WARNING_UNUSED_VALUE DISABLE_WARNING("-Wunused-value")
#    define DISABLE_WARNING_MAYBE_UNINITIALIZED // not supported by clang
#    define DISABLE_WARNING_CLASS_MEMACCESS DISABLE_WARNING("-Wclass-memaccess")
 
#elif defined(__GNUC__) // unix + gcc/clang
#    define DO_PRAGMA(X) _Pragma(#X)
#    define DISABLE_WARNING_PUSH DO_PRAGMA(GCC diagnostic push)
#    define DISABLE_WARNING_POP DO_PRAGMA(GCC diagnostic pop)
#    define DISABLE_WARNING(warningName) DO_PRAGMA(GCC diagnostic ignored warningName)
 
#    define DISABLE_WARNING_UNREFERENCED_FORMAL_PARAMETER DISABLE_WARNING("-Wunused-parameter")
#    define DISABLE_WARNING_UNREFERENCED_FUNCTION DISABLE_WARNING("-Wunused-function")
#    define DISABLE_WARNING_DEPRECATED_DECLARATIONS DISABLE_WARNING("-Wdeprecated-declarations")
#    define DISABLE_WARNING_UNUSED_VALUE DISABLE_WARNING("-Wunused-value")
#    define DISABLE_WARNING_MAYBE_UNINITIALIZED DISABLE_WARNING("-Wmaybe-uninitialized")
#    define DISABLE_WARNING_CLASS_MEMACCESS DISABLE_WARNING("-Wclass-memaccess")
#else
#    define DISABLE_WARNING_PUSH
#    define DISABLE_WARNING_POP
#    define DISABLE_WARNING_UNREFERENCED_FORMAL_PARAMETER
#    define DISABLE_WARNING_UNUSED_VALUE
#    define DISABLE_WARNING_UNREFERENCED_FUNCTION
#    define DISABLE_WARNING_CLASS_MEMACCESS
// other warnings you want to deactivate...
 
#endif
 
/*------------------------------------------*/