mirror of
https://github.com/microsoft/GSL.git
synced 2024-11-03 17:56:43 -05:00
136 lines
3.7 KiB
Plaintext
136 lines
3.7 KiB
Plaintext
///////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (c) 2015 Microsoft Corporation. All rights reserved.
|
|
//
|
|
// This code is licensed under the MIT License (MIT).
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
//
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef GSL_CONTRACTS_H
|
|
#define GSL_CONTRACTS_H
|
|
|
|
#include <exception>
|
|
|
|
//
|
|
// make suppress attributes parse for some compilers
|
|
// Hopefully temporary until suppression standardization occurs
|
|
//
|
|
#if defined(__clang__)
|
|
#define GSL_SUPPRESS(x) [[gsl::suppress("x")]]
|
|
#else
|
|
#if defined(_MSC_VER)
|
|
#define GSL_SUPPRESS(x) [[gsl::suppress(x)]]
|
|
#else
|
|
#define GSL_SUPPRESS(x)
|
|
#endif // _MSC_VER
|
|
#endif // __clang__
|
|
|
|
//
|
|
// Temporary until MSVC STL supports no-exceptions mode.
|
|
// Currently terminate is a no-op in this mode, so we add termination behavior back
|
|
//
|
|
#if defined(_MSC_VER) && defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS
|
|
#define GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND
|
|
#include <intrin.h>
|
|
#define RANGE_CHECKS_FAILURE 0
|
|
|
|
#if defined(__clang__)
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Winvalid-noreturn"
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#define GSL_STRINGIFY_DETAIL(x) #x
|
|
#define GSL_STRINGIFY(x) GSL_STRINGIFY_DETAIL(x)
|
|
|
|
#if defined(__clang__) || defined(__GNUC__)
|
|
#define GSL_LIKELY(x) __builtin_expect(!!(x), 1)
|
|
#define GSL_UNLIKELY(x) __builtin_expect(!!(x), 0)
|
|
#else
|
|
#define GSL_LIKELY(x) (!!(x))
|
|
#define GSL_UNLIKELY(x) (!!(x))
|
|
#endif
|
|
|
|
//
|
|
// GSL_ASSUME(cond)
|
|
//
|
|
// Tell the optimizer that the predicate cond must hold. It is unspecified
|
|
// whether or not cond is actually evaluated.
|
|
//
|
|
#ifdef _MSC_VER
|
|
#define GSL_ASSUME(cond) __assume(cond)
|
|
#elif defined(__GNUC__)
|
|
#define GSL_ASSUME(cond) ((cond) ? static_cast<void>(0) : __builtin_unreachable())
|
|
#else
|
|
#define GSL_ASSUME(cond) static_cast<void>((cond) ? 0 : 0)
|
|
#endif
|
|
|
|
//
|
|
// GSL.assert: assertions
|
|
//
|
|
|
|
namespace gsl
|
|
{
|
|
|
|
namespace details
|
|
{
|
|
#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND)
|
|
|
|
typedef void (__cdecl *terminate_handler)();
|
|
|
|
GSL_SUPPRESS(f.6) // NO-FORMAT: attribute
|
|
[[noreturn]] inline void __cdecl default_terminate_handler()
|
|
{
|
|
__fastfail(RANGE_CHECKS_FAILURE);
|
|
}
|
|
|
|
inline gsl::details::terminate_handler& get_terminate_handler() noexcept
|
|
{
|
|
static terminate_handler handler = &default_terminate_handler;
|
|
return handler;
|
|
}
|
|
|
|
#endif
|
|
|
|
[[noreturn]] inline void terminate() noexcept
|
|
{
|
|
#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND)
|
|
(*gsl::details::get_terminate_handler())();
|
|
#else
|
|
std::terminate();
|
|
#endif
|
|
}
|
|
|
|
template <typename Exception>
|
|
[[deprecated("GSL no longer supports throwing for contract violations. Use gsl::details::terminate() instead.")]]
|
|
[[noreturn]] void throw_exception(Exception&&) noexcept
|
|
{
|
|
gsl::details::terminate();
|
|
}
|
|
|
|
|
|
} // namespace details
|
|
} // namespace gsl
|
|
|
|
|
|
#define GSL_CONTRACT_CHECK(type, cond) \
|
|
(GSL_LIKELY(cond) ? static_cast<void>(0) : gsl::details::terminate())
|
|
|
|
#define Expects(cond) GSL_CONTRACT_CHECK("Precondition", cond)
|
|
#define Ensures(cond) GSL_CONTRACT_CHECK("Postcondition", cond)
|
|
|
|
#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) && defined(__clang__)
|
|
#pragma clang diagnostic pop
|
|
#endif
|
|
|
|
#endif // GSL_CONTRACTS_H
|