Centralize compiler detection for GCC, clang, MSVC and MINGW32.

examples/231-Cfg-OutputStreams.cpp

@@ -10,6 +10,8 @@
 #include <sstream>
 #include <cstdio>
 
+#include <catch2/internal/catch_compiler_detections.hpp>
+
 class out_buff : public std::stringbuf {
     std::FILE* m_stream;
 public:
@@ -31,7 +33,7 @@ class out_buff : public std::stringbuf {
 
 out_buff::~out_buff() { pubsync(); }
 
-#if defined(__clang__)
+#if defined(CATCH_COMPILER_CLANG)
 #pragma clang diagnostic ignored "-Wexit-time-destructors" // static variables in cout/cerr/clog
 #endif
 

src/catch2/benchmark/catch_optimizer.hpp

@@ -10,7 +10,9 @@
 #ifndef CATCH_OPTIMIZER_HPP_INCLUDED
 #define CATCH_OPTIMIZER_HPP_INCLUDED
 
-#if defined(_MSC_VER)
+#include <catch2/internal/catch_compiler_detections.hpp>
+
+#if defined(CATCH_COMPILER_MSC)
 #   include <atomic> // atomic_thread_fence
 #endif
 
@@ -20,7 +22,7 @@
 
 namespace Catch {
     namespace Benchmark {
-#if defined(__GNUC__) || defined(__clang__)
+#if defined(CATCH_COMPILER_GCC) || defined(CATCH_COMPILER_CLANG)
         template <typename T>
         inline void keep_memory(T* p) {
             asm volatile("" : : "g"(p) : "memory");
@@ -32,7 +34,7 @@ namespace Catch {
         namespace Detail {
             inline void optimizer_barrier() { keep_memory(); }
         } // namespace Detail
-#elif defined(_MSC_VER)
+#elif defined(CATCH_COMPILER_MSC)
 
 #pragma optimize("", off)
         template <typename T>

src/catch2/benchmark/detail/catch_estimate_clock.hpp

@@ -16,6 +16,7 @@
 #include <catch2/benchmark/detail/catch_measure.hpp>
 #include <catch2/benchmark/detail/catch_run_for_at_least.hpp>
 #include <catch2/benchmark/catch_clock.hpp>
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_unique_ptr.hpp>
 
 #include <algorithm>
@@ -95,12 +96,12 @@ namespace Catch {
 
             template <typename Clock>
             Environment<FloatDuration<Clock>> measure_environment() {
-#if defined(__clang__)
+#if defined(CATCH_COMPILER_CLANG)
 #    pragma clang diagnostic push
 #    pragma clang diagnostic ignored "-Wexit-time-destructors"
 #endif
                 static Catch::Detail::unique_ptr<Environment<FloatDuration<Clock>>> env;
-#if defined(__clang__)
+#if defined(CATCH_COMPILER_CLANG)
 #    pragma clang diagnostic pop
 #endif
                 if (env) {

src/catch2/catch_all.hpp

@@ -50,6 +50,7 @@
 #include <catch2/internal/catch_clara.hpp>
 #include <catch2/internal/catch_commandline.hpp>
 #include <catch2/internal/catch_compiler_capabilities.hpp>
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_config_android_logwrite.hpp>
 #include <catch2/internal/catch_config_counter.hpp>
 #include <catch2/internal/catch_config_uncaught_exceptions.hpp>

src/catch2/catch_config.cpp

@@ -6,7 +6,9 @@
 
 // SPDX-License-Identifier: BSL-1.0
 #include <catch2/catch_config.hpp>
+
 #include <catch2/catch_user_config.hpp>
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_enforce.hpp>
 #include <catch2/internal/catch_stringref.hpp>
 #include <catch2/internal/catch_string_manip.hpp>
@@ -65,14 +67,14 @@ namespace Catch {
         // during test, Bazel will not generate a default XML output.
         // This allows the XML output file to contain higher level of detail
         // than what is possible otherwise.
-#    if defined( _MSC_VER )
+#    if defined( CATCH_COMPILER_MSC )
         // On Windows getenv throws a warning as there is no input validation,
         // since the key is hardcoded, this should not be an issue.
 #        pragma warning( push )
 #        pragma warning( disable : 4996 )
 #    endif
         const auto bazelOutputFilePtr = std::getenv( "XML_OUTPUT_FILE" );
-#    if defined( _MSC_VER )
+#    if defined( CATCH_COMPILER_MSC )
 #        pragma warning( pop )
 #    endif
         if ( bazelOutputFilePtr != nullptr ) {

src/catch2/catch_template_test_macros.hpp

@@ -8,11 +8,13 @@
 #ifndef CATCH_TEMPLATE_TEST_MACROS_HPP_INCLUDED
 #define CATCH_TEMPLATE_TEST_MACROS_HPP_INCLUDED
 
+#include <catch2/internal/catch_compiler_detections.hpp>
+
 // We need this suppression to leak, because it took until GCC 10
 // for the front end to handle local suppression via _Pragma properly
 // inside templates (so `TEMPLATE_TEST_CASE` and co).
 // **THIS IS DIFFERENT FOR STANDARD TESTS, WHERE GCC 9 IS SUFFICIENT**
-#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && __GNUC__ < 10
+#if defined(CATCH_COMPILER_GCC) && __GNUC__ < 10
 #pragma GCC diagnostic ignored "-Wparentheses"
 #endif
 

src/catch2/catch_test_case_info.hpp

@@ -8,6 +8,7 @@
 #ifndef CATCH_TEST_CASE_INFO_HPP_INCLUDED
 #define CATCH_TEST_CASE_INFO_HPP_INCLUDED
 
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_source_line_info.hpp>
 #include <catch2/internal/catch_noncopyable.hpp>
 #include <catch2/internal/catch_stringref.hpp>
@@ -18,7 +19,7 @@
 #include <string>
 #include <vector>
 
-#ifdef __clang__
+#ifdef CATCH_COMPILER_CLANG
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wpadded"
 #endif
@@ -123,7 +124,7 @@ namespace Catch {
                       SourceLineInfo const& lineInfo );
 }
 
-#ifdef __clang__
+#ifdef CATCH_COMPILER_CLANG
 #pragma clang diagnostic pop
 #endif
 

src/catch2/catch_test_spec.hpp

@@ -8,7 +8,9 @@
 #ifndef CATCH_TEST_SPEC_HPP_INCLUDED
 #define CATCH_TEST_SPEC_HPP_INCLUDED
 
-#ifdef __clang__
+#include <catch2/internal/catch_compiler_detections.hpp>
+
+#ifdef CATCH_COMPILER_CLANG
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wpadded"
 #endif
@@ -81,7 +83,7 @@ namespace Catch {
     };
 }
 
-#ifdef __clang__
+#ifdef CATCH_COMPILER_CLANG
 #pragma clang diagnostic pop
 #endif
 

src/catch2/catch_tostring.hpp

@@ -16,6 +16,7 @@
 #include <string.h>
 
 #include <catch2/internal/catch_compiler_capabilities.hpp>
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_config_wchar.hpp>
 #include <catch2/internal/catch_reusable_string_stream.hpp>
 #include <catch2/internal/catch_void_type.hpp>
@@ -25,7 +26,7 @@
 #include <string_view>
 #endif
 
-#ifdef _MSC_VER
+#ifdef CATCH_COMPILER_MSC
 #pragma warning(push)
 #pragma warning(disable:4180) // We attempt to stream a function (address) by const&, which MSVC complains about but is harmless
 #endif
@@ -625,7 +626,7 @@ struct ratio_string<std::milli> {
         static std::string convert(std::chrono::time_point<std::chrono::system_clock, Duration> const& time_point) {
             auto converted = std::chrono::system_clock::to_time_t(time_point);
 
-#ifdef _MSC_VER
+#ifdef CATCH_COMPILER_MSC
             std::tm timeInfo = {};
             gmtime_s(&timeInfo, &converted);
 #else
@@ -636,7 +637,7 @@ struct ratio_string<std::milli> {
             char timeStamp[timeStampSize];
             const char * const fmt = "%Y-%m-%dT%H:%M:%SZ";
 
-#ifdef _MSC_VER
+#ifdef CATCH_COMPILER_MSC
             std::strftime(timeStamp, timeStampSize, fmt, &timeInfo);
 #else
             std::strftime(timeStamp, timeStampSize, fmt, timeInfo);
@@ -660,7 +661,7 @@ namespace Catch { \
 
 #define CATCH_REGISTER_ENUM( enumName, ... ) INTERNAL_CATCH_REGISTER_ENUM( enumName, __VA_ARGS__ )
 
-#ifdef _MSC_VER
+#ifdef CATCH_COMPILER_MSC
 #pragma warning(pop)
 #endif
 

src/catch2/internal/catch_clara.hpp

@@ -8,14 +8,16 @@
 #ifndef CATCH_CLARA_HPP_INCLUDED
 #define CATCH_CLARA_HPP_INCLUDED
 
-#if defined( __clang__ )
+#include <catch2/internal/catch_compiler_detections.hpp>
+
+#if defined( CATCH_COMPILER_CLANG )
 #    pragma clang diagnostic push
 #    pragma clang diagnostic ignored "-Wweak-vtables"
 #    pragma clang diagnostic ignored "-Wshadow"
 #    pragma clang diagnostic ignored "-Wdeprecated"
 #endif
 
-#if defined( __GNUC__ )
+#if defined( CATCH_COMPILER_GCC )
 #    pragma GCC diagnostic push
 #    pragma GCC diagnostic ignored "-Wsign-conversion"
 #endif
@@ -697,11 +699,11 @@ namespace Catch {
     } // namespace Clara
 } // namespace Catch
 
-#if defined( __clang__ )
+#if defined( CATCH_COMPILER_CLANG )
 #    pragma clang diagnostic pop
 #endif
 
-#if defined( __GNUC__ )
+#if defined( CATCH_COMPILER_GCC )
 #    pragma GCC diagnostic pop
 #endif
 

src/catch2/internal/catch_combined_tu.cpp

@@ -45,7 +45,6 @@ namespace Catch {
 //////////////////////////////////////////
 
 #include <catch2/internal/catch_polyfills.hpp>
-#include <catch2/internal/catch_compiler_capabilities.hpp>
 #include <cmath>
 
 namespace Catch {
@@ -74,7 +73,6 @@ namespace Catch {
 // vvv formerly catch_uncaught_exceptions.cpp vvv //
 ////////////////////////////////////////////////////
 
-#include <catch2/internal/catch_compiler_capabilities.hpp>
 #include <catch2/internal/catch_uncaught_exceptions.hpp>
 #include <catch2/internal/catch_config_uncaught_exceptions.hpp>
 
@@ -130,7 +128,6 @@ namespace Catch {
 // vvv formerly catch_startup_exception_registry.cpp vvv //
 ///////////////////////////////////////////////////////////
 #include <catch2/internal/catch_startup_exception_registry.hpp>
-#include <catch2/internal/catch_compiler_capabilities.hpp>
 
 namespace Catch {
 #if !defined(CATCH_CONFIG_DISABLE_EXCEPTIONS)

src/catch2/internal/catch_compiler_capabilities.hpp

@@ -24,6 +24,7 @@
 // Many features, at point of detection, define an _INTERNAL_ macro, so they
 // can be combined, en-mass, with the _NO_ forms later.
 
+#include <catch2/internal/catch_compiler_detections.hpp>
 #include <catch2/internal/catch_platform.hpp>
 #include <catch2/catch_user_config.hpp>
 
@@ -41,7 +42,7 @@
 
 // Only GCC compiler should be used in this block, so other compilers trying to
 // mask themselves as GCC should be ignored.
-#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && !defined(__CUDACC__) && !defined(__LCC__)
+#if defined(CATCH_COMPILER_GCC)
 #    define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "GCC diagnostic push" )
 #    define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION  _Pragma( "GCC diagnostic pop" )
 
@@ -57,7 +58,7 @@
 
 #endif
 
-#if defined(__clang__) && !defined(_MSC_VER)
+#if defined(CATCH_COMPILER_CLANG)
 
 #    define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma( "clang diagnostic push" )
 #    define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION  _Pragma( "clang diagnostic pop" )
@@ -99,7 +100,7 @@
 #    define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS \
          _Pragma( "clang diagnostic ignored \"-Wunused-template\"" )
 
-#endif // __clang__
+#endif // CATCH_COMPILER_CLANG
 
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -126,7 +127,7 @@
 
 ////////////////////////////////////////////////////////////////////////////////
 // Not all Windows environments support SEH properly
-#if defined(__MINGW32__)
+#if defined(CATCH_COMPILER_MINGW32)
 #    define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH
 #endif
 
@@ -155,7 +156,7 @@
 
 ////////////////////////////////////////////////////////////////////////////////
 // Visual C++
-#if defined(_MSC_VER)
+#if defined(CATCH_COMPILER_MSVC)
 
 #  define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma( warning(push) )
 #  define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION  __pragma( warning(pop) )

src/catch2/internal/catch_compiler_detections.hpp

@@ -0,0 +1,26 @@
+
+//              Copyright Catch2 Authors
+// Distributed under the Boost Software License, Version 1.0.
+//   (See accompanying file LICENSE_1_0.txt or copy at
+//        https://www.boost.org/LICENSE_1_0.txt)
+
+#ifndef CATCH_COMPILER_DETECTIONS_HPP_INCLUDED
+#define CATCH_COMPILER_DETECTIONS_HPP_INCLUDED
+
+#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && !defined(__CUDACC__) && !defined(__LCC__)
+#define CATCH_COMPILER_GCC
+#endif
+
+#if defined(__clang__)
+#define CATCH_COMPILER_CLANG
+#endif
+
+#if defined(_MSC_VER) && !defined(__clang__)
+#define CATCH_COMPILER_MSVC
+#endif
+
+#if defined(__MINGW32__)
+#define CATCH_COMPILER_MINGW32
+#endif
+
+#endif // CATCH_COMPILER_DETECTIONS_HPP_INCLUDED

src/catch2/internal/catch_config_uncaught_exceptions.hpp

@@ -17,7 +17,9 @@
 #ifndef CATCH_CONFIG_UNCAUGHT_EXCEPTIONS_HPP_INCLUDED
 #define CATCH_CONFIG_UNCAUGHT_EXCEPTIONS_HPP_INCLUDED
 
-#if defined(_MSC_VER)
+#include <catch2/internal/catch_compiler_detections.hpp>
+
+#if defined(CATCH_COMPILER_MSVC)
 #  if _MSC_VER >= 1900 // Visual Studio 2015 or newer
 #    define CATCH_INTERNAL_CONFIG_CPP17_UNCAUGHT_EXCEPTIONS
 #  endif

src/catch2/internal/catch_console_colour.cpp

@@ -4,14 +4,16 @@
 //   (See accompanying file LICENSE_1_0.txt or copy at
 //        https://www.boost.org/LICENSE_1_0.txt)
 
+#include <catch2/internal/catch_console_colour.hpp>
+#include <catch2/internal/catch_compiler_detections.hpp>
+
 // SPDX-License-Identifier: BSL-1.0
-#if defined(__clang__)
+#if defined(CATCH_COMPILER_CLANG)
 #    pragma clang diagnostic push
 #    pragma clang diagnostic ignored "-Wexit-time-destructors"
 #endif
 
 
-#include <catch2/internal/catch_console_colour.hpp>
 #include <catch2/internal/catch_enforce.hpp>
 #include <catch2/internal/catch_errno_guard.hpp>
 #include <catch2/interfaces/catch_interfaces_config.hpp>
@@ -280,7 +282,7 @@ namespace Catch {
 
 } // end namespace Catch
 
-#if defined(__clang__)
+#if defined(CATCH_COMPILER_CLANG)
 #    pragma clang diagnostic pop
 #endif