compiler_compatibility.hpp File Reference

Header file containing macros for compiler compatibility and warning suppression. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	CBEAM_SUPPRESS_WARNINGS_PUSH()
#define	CBEAM_SUPPRESS_WARNINGS_POP()

Detailed Description

Header file containing macros for compiler compatibility and warning suppression.

This file may contain various utilities and macros to handle compiler-specific behavior and compatibility issues.

Macro Definition Documentation

CBEAM_SUPPRESS_WARNINGS_POP

#define CBEAM_SUPPRESS_WARNINGS_POP

(

)

Restores the compiler warning state to what it was before CBEAM_SUPPRESS_WARNINGS_PUSH.

This macro should be used after including a third-party library header to revert the compiler's warning state back to its previous configuration. It ensures that the warning suppression is only effective for the specific includes where it's applied.

The restoration mechanism varies based on the compiler (MSVC, GCC, Clang, Mingw).

CBEAM_SUPPRESS_WARNINGS_PUSH

#define CBEAM_SUPPRESS_WARNINGS_PUSH

(

)

Temporarily suppresses compiler warnings for third-party library includes.

This macro is intended to be used before including a third-party library header that generates compiler warnings. It works by pushing the current warning state onto a stack and setting the compiler to ignore specific warnings. This helps in keeping the build logs clean from warnings in external code that are not of concern for the project.

The suppression mechanism varies based on the compiler (MSVC, GCC, Clang, Mingw).