catch2/internal/catch_config_static_analysis_support.hpp

0001
0002 //              Copyright Catch2 Authors
0003 // Distributed under the Boost Software License, Version 1.0.
0004 //   (See accompanying file LICENSE.txt or copy at
0005 //        https://www.boost.org/LICENSE_1_0.txt)
0006
0007 // SPDX-License-Identifier: BSL-1.0
0008
0009 /** \file
0010  * Wrapper for the STATIC_ANALYSIS_SUPPORT configuration option
0011  *
0012  * Some of Catch2's macros can be defined differently to work better with
0013  * static analysis tools, like clang-tidy or coverity.
0014  * Currently the main use case is to show that `SECTION`s are executed
0015  * exclusively, and not all in one run of a `TEST_CASE`.
0016  */
0017
0018 #ifndef CATCH_CONFIG_STATIC_ANALYSIS_SUPPORT_HPP_INCLUDED
0019 #define CATCH_CONFIG_STATIC_ANALYSIS_SUPPORT_HPP_INCLUDED
0020
0021 #include <catch2/catch_user_config.hpp>
0022
0023 #if defined(__clang_analyzer__) || defined(__COVERITY__)
0024     #define CATCH_INTERNAL_CONFIG_STATIC_ANALYSIS_SUPPORT
0025 #endif
0026
0027 #if defined( CATCH_INTERNAL_CONFIG_STATIC_ANALYSIS_SUPPORT ) && \
0028     !defined( CATCH_CONFIG_NO_EXPERIMENTAL_STATIC_ANALYSIS_SUPPORT ) && \
0029     !defined( CATCH_CONFIG_EXPERIMENTAL_STATIC_ANALYSIS_SUPPORT )
0030 #    define CATCH_CONFIG_EXPERIMENTAL_STATIC_ANALYSIS_SUPPORT
0031 #endif
0032
0033
0034 #endif // CATCH_CONFIG_STATIC_ANALYSIS_SUPPORT_HPP_INCLUDED