experimental_api.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
// Check if user has explicitly opted in to experimental APIs
#ifndef NETWORK_USE_EXPERIMENTAL
 
#if defined(__GNUC__) || defined(__clang__)
#define NETWORK_EXPERIMENTAL_STATIC_ASSERT_MSG                                                     \
    "This is an experimental API. Define NETWORK_USE_EXPERIMENTAL before including this header. " \
    "Example: #define NETWORK_USE_EXPERIMENTAL"
#else
#define NETWORK_EXPERIMENTAL_STATIC_ASSERT_MSG                                                     \
    "Experimental API - define NETWORK_USE_EXPERIMENTAL to use"
#endif
 
#define NETWORK_REQUIRE_EXPERIMENTAL                                                               \
    static_assert(false, NETWORK_EXPERIMENTAL_STATIC_ASSERT_MSG)
 
#else // NETWORK_USE_EXPERIMENTAL is defined
 
#define NETWORK_REQUIRE_EXPERIMENTAL // No-op when opted in
 
#endif // NETWORK_USE_EXPERIMENTAL
 
#if defined(__cplusplus) && __cplusplus >= 201402L
#define NETWORK_EXPERIMENTAL_API                                                                   \
    [[deprecated("Experimental API - may change between minor versions without notice")]]
#else
#define NETWORK_EXPERIMENTAL_API
#endif
 
#if defined(__GNUC__) || defined(__clang__)
#define NETWORK_EXPERIMENTAL_WARNING(msg) _Pragma(#msg)
#elif defined(_MSC_VER)
#define NETWORK_EXPERIMENTAL_WARNING(msg) __pragma(message(msg))
#else
#define NETWORK_EXPERIMENTAL_WARNING(msg)
#endif
 
namespace kcenon::network::experimental
{
} // namespace kcenon::network::experimental