annotations.h

#ifndef PROTON_ANNOTATIONS_H
#define PROTON_ANNOTATIONS_H 1
 
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
// compiler specific attribute translation
// msvc should come first, so if clang is in msvc mode it gets the right defines
 
// warn format placeholders
 
// NOTE: this will only do checking in msvc with versions that support /analyze
#ifdef _MSC_VER
 
    #include <stddef.h>
 
    #ifdef _USE_ATTRIBUTES_FOR_SAL
        #undef _USE_ATTRIBUTES_FOR_SAL
    #endif
 
    #define _USE_ATTRIBUTES_FOR_SAL 1
    #include <sal.h>
 
    #define PN_PRINTF_FORMAT _Printf_format_string_
    #define PN_PRINTF_FORMAT_ATTR(format_param, dots_param) 
 
#elif defined(__GNUC__)
 
    #define PN_PRINTF_FORMAT 
    #define PN_PRINTF_FORMAT_ATTR(format_param, dots_param) \
      __attribute__((__format__(__printf__, format_param, dots_param)))
 
#else
 
    #define PN_PRINTF_FORMAT 
    #define PN_PRINTF_FORMAT_ATTR(format_param, dots_param) 
 
#endif
 
 
// warn unused result
#if defined(__has_cpp_attribute)
    #if __has_cpp_attribute(nodiscard)
        #define PN_NODISCARD [[nodiscard]]
    #endif
#endif
#if !defined PN_NODISCARD
    #if defined(_MSC_VER) && (_MSC_VER >= 1700)
        #define PN_NODISCARD _Check_return_
    #elif defined(__GNUC__)
        #define PN_NODISCARD __attribute__((__warn_unused_result__))
    #else
        #define PN_NODISCARD
    #endif
#endif
 
// fallthrough
#if defined __cplusplus && defined __has_cpp_attribute
    #if __has_cpp_attribute(fallthrough) && __cplusplus >= __has_cpp_attribute(fallthrough)
        #define PN_FALLTHROUGH [[fallthrough]]
    #endif
#elif defined __STDC_VERSION__ && defined __has_c_attribute
    #if __has_c_attribute(fallthrough) && __STDC_VERSION__ >= __has_c_attribute(fallthrough)
        #define PN_FALLTHROUGH [[fallthrough]]
    #endif
#endif
#if !defined PN_FALLTHROUGH && defined __has_attribute
    #if __has_attribute(__fallthrough__)
        #define PN_FALLTHROUGH __attribute__((__fallthrough__))
    #endif
#endif
#if !defined PN_FALLTHROUGH
    #define PN_FALLTHROUGH (void)0
#endif
 
// Generalize warning push/pop.
#if defined(__GNUC__) || defined(__clang__)
    // Clang & GCC
    #define PN_PUSH_WARNING _Pragma("GCC diagnostic push")
    #define PN_POP_WARNING _Pragma("GCC diagnostic pop")
    #define PN_GNU_DISABLE_WARNING_INTERNAL2(warningName) #warningName
    #define PN_GNU_DISABLE_WARNING(warningName) _Pragma(PN_GNU_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored warningName))
    #ifdef __clang__
        #define PN_CLANG_DISABLE_WARNING(warningName) PN_GNU_DISABLE_WARNING(warningName)
        #define PN_GCC_DISABLE_WARNING(warningName)
    #else
        #define PN_CLANG_DISABLE_WARNING(warningName)
        #define PN_GCC_DISABLE_WARNING(warningName) PN_GNU_DISABLE_WARNING(warningName)
    #endif
    #define PN_MSVC_DISABLE_WARNING(warningNumber)
#elif defined(_MSC_VER)
    #define PN_PUSH_WARNING __pragma(warning(push))
    #define PN_POP_WARNING __pragma(warning(pop))
    // Disable the GCC warnings.
    #define PN_GNU_DISABLE_WARNING(warningName)
    #define PN_GCC_DISABLE_WARNING(warningName)
    #define PN_CLANG_DISABLE_WARNING(warningName)
    #define PN_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable : warningNumber))
#else
    #define PN_PUSH_WARNING
    #define PN_POP_WARNING
    #define PN_GNU_DISABLE_WARNING(warningName)
    #define PN_GCC_DISABLE_WARNING(warningName)
    #define PN_CLANG_DISABLE_WARNING(warningName)
    #define PN_MSVC_DISABLE_WARNING(warningNumber)
#endif
 
#endif /* annotations.h */