From 2e461ee14a423be299727011036cbfa943bd3b16 Mon Sep 17 00:00:00 2001 From: OEOTYAN <1124718975@qq.com> Date: Wed, 11 May 2022 22:42:29 +0800 Subject: [PATCH] update --- gsl/algorithm | 63 ++ gsl/assert | 136 +++ gsl/byte | 213 +++++ gsl/gsl | 19 +- gsl/gsl_algorithm | 65 +- gsl/gsl_assert | 136 +-- gsl/gsl_byte | 212 +---- gsl/gsl_narrow | 3 + gsl/gsl_util | 157 +--- gsl/multi_span | 2273 --------------------------------------------- gsl/narrow | 83 ++ gsl/pointers | 114 ++- gsl/span | 174 ++-- gsl/span_ext | 22 +- gsl/string_span | 253 +++-- gsl/util | 160 ++++ src/HopperFix.cpp | 57 +- 17 files changed, 1048 insertions(+), 3092 deletions(-) create mode 100644 gsl/algorithm create mode 100644 gsl/assert create mode 100644 gsl/byte create mode 100644 gsl/gsl_narrow delete mode 100644 gsl/multi_span create mode 100644 gsl/narrow create mode 100644 gsl/util diff --git a/gsl/algorithm b/gsl/algorithm new file mode 100644 index 0000000..584f5cd --- /dev/null +++ b/gsl/algorithm @@ -0,0 +1,63 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// 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_ALGORITHM_H +#define GSL_ALGORITHM_H + +#include "assert" // for Expects +#include "span" // for dynamic_extent, span + +#include // for copy_n +#include // for ptrdiff_t +#include // for is_assignable + +#ifdef _MSC_VER +#pragma warning(push) + +// turn off some warnings that are noisy about our Expects statements +#pragma warning(disable : 4127) // conditional expression is constant +#pragma warning(disable : 4996) // unsafe use of std::copy_n + +#endif // _MSC_VER + +namespace gsl +{ +// Note: this will generate faster code than std::copy using span iterator in older msvc+stl +// not necessary for msvc since VS2017 15.8 (_MSC_VER >= 1915) +template +void copy(span src, span dest) +{ + static_assert(std::is_assignable::value, + "Elements of source span can not be assigned to elements of destination span"); + static_assert(SrcExtent == dynamic_extent || DestExtent == dynamic_extent || + (SrcExtent <= DestExtent), + "Source range is longer than target range"); + + Expects(dest.size() >= src.size()); + // clang-format off + GSL_SUPPRESS(stl.1) // NO-FORMAT: attribute + // clang-format on + std::copy_n(src.data(), src.size(), dest.data()); +} + +} // namespace gsl + +#ifdef _MSC_VER +#pragma warning(pop) +#endif // _MSC_VER + +#endif // GSL_ALGORITHM_H diff --git a/gsl/assert b/gsl/assert new file mode 100644 index 0000000..a601204 --- /dev/null +++ b/gsl/assert @@ -0,0 +1,136 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// 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 + +// +// 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(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS)) +#define GSL_KERNEL_MODE + +#define GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND +#include +#define RANGE_CHECKS_FAILURE 0 + +#if defined(__clang__) +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Winvalid-noreturn" +#endif // defined(__clang__) + +#else // defined(_MSC_VER) && (defined(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && + // !_HAS_EXCEPTIONS)) + +#include + +#endif // defined(_MSC_VER) && (defined(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && + // !_HAS_EXCEPTIONS)) + +// +// 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) && !defined(__INTEL_COMPILER) +#define GSL_SUPPRESS(x) [[gsl::suppress(x)]] +#else +#define GSL_SUPPRESS(x) +#endif // _MSC_VER +#endif // __clang__ + +#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 // defined(__clang__) || defined(__GNUC__) + +// +// 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(0) : __builtin_unreachable()) +#else +#define GSL_ASSUME(cond) static_cast((cond) ? 0 : 0) +#endif + +// +// GSL.assert: assertions +// + +namespace gsl +{ + +namespace details +{ +#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) + + typedef void(__cdecl* terminate_handler)(); + + // clang-format off + GSL_SUPPRESS(f.6) // NO-FORMAT: attribute + // clang-format on + [[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 // defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) + + [[noreturn]] inline void terminate() noexcept + { +#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) + (*gsl::details::get_terminate_handler())(); +#else + std::terminate(); +#endif // defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) + } + +} // namespace details +} // namespace gsl + +#define GSL_CONTRACT_CHECK(type, cond) \ + (GSL_LIKELY(cond) ? static_cast(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 diff --git a/gsl/byte b/gsl/byte new file mode 100644 index 0000000..9231340 --- /dev/null +++ b/gsl/byte @@ -0,0 +1,213 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// 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_BYTE_H +#define GSL_BYTE_H + +// +// make suppress attributes work for some compilers +// Hopefully temporary until suppression standardization occurs +// +#if defined(__clang__) +#define GSL_SUPPRESS(x) [[gsl::suppress("x")]] +#else +#if defined(_MSC_VER) && !defined(__INTEL_COMPILER) +#define GSL_SUPPRESS(x) [[gsl::suppress(x)]] +#else +#define GSL_SUPPRESS(x) +#endif // _MSC_VER +#endif // __clang__ + +#include + +// VS2017 15.8 added support for the __cpp_lib_byte definition +// To do: drop _HAS_STD_BYTE when support for pre 15.8 expires +#ifdef _MSC_VER + +#pragma warning(push) + +// Turn MSVC /analyze rules that generate too much noise. TODO: fix in the tool. +#pragma warning(disable : 26493) // don't use c-style casts // TODO: MSVC suppression in templates + // does not always work + +#ifndef GSL_USE_STD_BYTE +// this tests if we are under MSVC and the standard lib has std::byte and it is enabled +#if (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || \ + (defined(__cpp_lib_byte) && __cpp_lib_byte >= 201603) + +#define GSL_USE_STD_BYTE 1 + +#else // (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || (defined(__cpp_lib_byte) && __cpp_lib_byte >= + // 201603) + +#define GSL_USE_STD_BYTE 0 + +#endif // (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || (defined(__cpp_lib_byte) && __cpp_lib_byte >= + // 201603) +#endif // GSL_USE_STD_BYTE + +#else // _MSC_VER + +#ifndef GSL_USE_STD_BYTE +#include /* __cpp_lib_byte */ +// this tests if we are under GCC or Clang with enough -std=c++1z power to get us std::byte +// also check if libc++ version is sufficient (> 5.0) or libstdc++ actually contains std::byte +#if defined(__cplusplus) && (__cplusplus >= 201703L) && \ + (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || \ + defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) + +#define GSL_USE_STD_BYTE 1 + +#else // defined(__cplusplus) && (__cplusplus >= 201703L) && + // (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || + // defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) + +#define GSL_USE_STD_BYTE 0 + +#endif // defined(__cplusplus) && (__cplusplus >= 201703L) && + // (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || + // defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) +#endif // GSL_USE_STD_BYTE + +#endif // _MSC_VER + +// Use __may_alias__ attribute on gcc and clang +#if defined __clang__ || (defined(__GNUC__) && __GNUC__ > 5) +#define byte_may_alias __attribute__((__may_alias__)) +#else // defined __clang__ || defined __GNUC__ +#define byte_may_alias +#endif // defined __clang__ || defined __GNUC__ + +#if GSL_USE_STD_BYTE +#include +#endif + +namespace gsl +{ +#if GSL_USE_STD_BYTE + +using std::byte; +using std::to_integer; + +#else // GSL_USE_STD_BYTE + +// This is a simple definition for now that allows +// use of byte within span<> to be standards-compliant +enum class byte_may_alias byte : unsigned char +{ +}; + +template ::value>> +constexpr byte& operator<<=(byte& b, IntegerType shift) noexcept +{ + return b = byte(static_cast(b) << shift); +} + +template ::value>> +constexpr byte operator<<(byte b, IntegerType shift) noexcept +{ + return byte(static_cast(b) << shift); +} + +template ::value>> +constexpr byte& operator>>=(byte& b, IntegerType shift) noexcept +{ + return b = byte(static_cast(b) >> shift); +} + +template ::value>> +constexpr byte operator>>(byte b, IntegerType shift) noexcept +{ + return byte(static_cast(b) >> shift); +} + +constexpr byte& operator|=(byte& l, byte r) noexcept +{ + return l = byte(static_cast(l) | static_cast(r)); +} + +constexpr byte operator|(byte l, byte r) noexcept +{ + return byte(static_cast(l) | static_cast(r)); +} + +constexpr byte& operator&=(byte& l, byte r) noexcept +{ + return l = byte(static_cast(l) & static_cast(r)); +} + +constexpr byte operator&(byte l, byte r) noexcept +{ + return byte(static_cast(l) & static_cast(r)); +} + +constexpr byte& operator^=(byte& l, byte r) noexcept +{ + return l = byte(static_cast(l) ^ static_cast(r)); +} + +constexpr byte operator^(byte l, byte r) noexcept +{ + return byte(static_cast(l) ^ static_cast(r)); +} + +constexpr byte operator~(byte b) noexcept { return byte(~static_cast(b)); } + +template ::value>> +constexpr IntegerType to_integer(byte b) noexcept +{ + return static_cast(b); +} + +#endif // GSL_USE_STD_BYTE + +template +constexpr byte to_byte_impl(T t) noexcept +{ + static_assert( + E, "gsl::to_byte(t) must be provided an unsigned char, otherwise data loss may occur. " + "If you are calling to_byte with an integer contant use: gsl::to_byte() version."); + return static_cast(t); +} +template <> +// NOTE: need suppression since c++14 does not allow "return {t}" +// GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: suppression does not work +constexpr byte to_byte_impl(unsigned char t) noexcept +{ + return byte(t); +} + +template +constexpr byte to_byte(T t) noexcept +{ + return to_byte_impl::value, T>(t); +} + +template +constexpr byte to_byte() noexcept +{ + static_assert(I >= 0 && I <= 255, + "gsl::byte only has 8 bits of storage, values must be in range 0-255"); + return static_cast(I); +} + +} // namespace gsl + +#ifdef _MSC_VER +#pragma warning(pop) +#endif // _MSC_VER + +#endif // GSL_BYTE_H diff --git a/gsl/gsl b/gsl/gsl index b1f23c2..3d9e288 100644 --- a/gsl/gsl +++ b/gsl/gsl @@ -17,13 +17,16 @@ #ifndef GSL_GSL_H #define GSL_GSL_H -#include "gsl_algorithm" // copy -#include "gsl_assert" // Ensures/Expects -#include "gsl_byte" // byte -#include "gsl_util" // finally()/narrow()/narrow_cast()... -#include "multi_span" // multi_span, strided_span... -#include "pointers" // owner, not_null -#include "span" // span -#include "string_span" // zstring, string_span, zstring_builder... +#include "algorithm" // copy +#include "assert" // Ensures/Expects +#include "byte" // byte +#include "pointers" // owner, not_null +#include "span" // span +#include "string_span" // zstring, string_span, zstring_builder... +#include "util" // finally()/narrow_cast()... + +#ifdef __cpp_exceptions +#include "narrow" // narrow() +#endif #endif // GSL_GSL_H diff --git a/gsl/gsl_algorithm b/gsl/gsl_algorithm index 649408b..d516e2e 100644 --- a/gsl/gsl_algorithm +++ b/gsl/gsl_algorithm @@ -1,61 +1,4 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// 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_ALGORITHM_H -#define GSL_ALGORITHM_H - -#include "gsl_assert" // for Expects -#include "span" // for dynamic_extent, span - -#include // for copy_n -#include // for ptrdiff_t -#include // for is_assignable - -#ifdef _MSC_VER -#pragma warning(push) - -// turn off some warnings that are noisy about our Expects statements -#pragma warning(disable : 4127) // conditional expression is constant -#pragma warning(disable : 4996) // unsafe use of std::copy_n - -#endif // _MSC_VER - -namespace gsl -{ -// Note: this will generate faster code than std::copy using span iterator in older msvc+stl -// not necessary for msvc since VS2017 15.8 (_MSC_VER >= 1915) -template -void copy(span src, span dest) -{ - static_assert(std::is_assignable::value, - "Elements of source span can not be assigned to elements of destination span"); - static_assert(SrcExtent == dynamic_extent || DestExtent == dynamic_extent || - (SrcExtent <= DestExtent), - "Source range is longer than target range"); - - Expects(dest.size() >= src.size()); - GSL_SUPPRESS(stl.1) // NO-FORMAT: attribute - std::copy_n(src.data(), src.size(), dest.data()); -} - -} // namespace gsl - -#ifdef _MSC_VER -#pragma warning(pop) -#endif // _MSC_VER - -#endif // GSL_ALGORITHM_H +#pragma once +#pragma message( \ + "This header will soon be removed. Use instead of ") +#include "algorithm" diff --git a/gsl/gsl_assert b/gsl/gsl_assert index 96eaada..35a6e78 100644 --- a/gsl/gsl_assert +++ b/gsl/gsl_assert @@ -1,133 +1,3 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// 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 - -// -// 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(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS)) - -#define GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND -#include -#define RANGE_CHECKS_FAILURE 0 - -#if defined(__clang__) -#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Winvalid-noreturn" -#endif // defined(__clang__) - -#else // defined(_MSC_VER) && (defined(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS)) - -#include - -#endif // defined(_MSC_VER) && (defined(_KERNEL_MODE) || (defined(_HAS_EXCEPTIONS) && !_HAS_EXCEPTIONS)) - -// -// 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__ - -#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 // defined(__clang__) || defined(__GNUC__) - -// -// 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(0) : __builtin_unreachable()) -#else -#define GSL_ASSUME(cond) static_cast((cond) ? 0 : 0) -#endif - -// -// GSL.assert: assertions -// - -namespace gsl -{ - -namespace details -{ -#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) - - typedef void(__cdecl* terminate_handler)(); - - // clang-format off - GSL_SUPPRESS(f.6) // NO-FORMAT: attribute - // clang-format on - [[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 // defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) - - [[noreturn]] inline void terminate() noexcept - { -#if defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) - (*gsl::details::get_terminate_handler())(); -#else - std::terminate(); -#endif // defined(GSL_MSVC_USE_STL_NOEXCEPTION_WORKAROUND) - } - -} // namespace details -} // namespace gsl - -#define GSL_CONTRACT_CHECK(type, cond) \ - (GSL_LIKELY(cond) ? static_cast(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 +#pragma once +#pragma message("This header will soon be removed. Use instead of ") +#include "assert" diff --git a/gsl/gsl_byte b/gsl/gsl_byte index 9e68d0d..399025c 100644 --- a/gsl/gsl_byte +++ b/gsl/gsl_byte @@ -1,209 +1,3 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// 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_BYTE_H -#define GSL_BYTE_H - -// -// make suppress attributes work 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__ - -#include - -// VS2017 15.8 added support for the __cpp_lib_byte definition -// To do: drop _HAS_STD_BYTE when support for pre 15.8 expires -#ifdef _MSC_VER - -#pragma warning(push) - -// Turn MSVC /analyze rules that generate too much noise. TODO: fix in the tool. -#pragma warning(disable : 26493) // don't use c-style casts // TODO: MSVC suppression in templates does not always work - -#ifndef GSL_USE_STD_BYTE -// this tests if we are under MSVC and the standard lib has std::byte and it is enabled -#if (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || (defined(__cpp_lib_byte) && __cpp_lib_byte >= 201603) - -#define GSL_USE_STD_BYTE 1 - -#else // (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || (defined(__cpp_lib_byte) && __cpp_lib_byte >= 201603) - -#define GSL_USE_STD_BYTE 0 - -#endif // (defined(_HAS_STD_BYTE) && _HAS_STD_BYTE) || (defined(__cpp_lib_byte) && __cpp_lib_byte >= 201603) -#endif // GSL_USE_STD_BYTE - -#else // _MSC_VER - -#ifndef GSL_USE_STD_BYTE -#include /* __cpp_lib_byte */ -// this tests if we are under GCC or Clang with enough -std:c++1z power to get us std::byte -// also check if libc++ version is sufficient (> 5.0) or libstc++ actually contains std::byte -#if defined(__cplusplus) && (__cplusplus >= 201703L) && \ - (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || \ - defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) - -#define GSL_USE_STD_BYTE 1 - -#else // defined(__cplusplus) && (__cplusplus >= 201703L) && - // (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || - // defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) - -#define GSL_USE_STD_BYTE 0 - -#endif //defined(__cplusplus) && (__cplusplus >= 201703L) && - // (defined(__cpp_lib_byte) && (__cpp_lib_byte >= 201603) || - // defined(_LIBCPP_VERSION) && (_LIBCPP_VERSION >= 5000)) -#endif // GSL_USE_STD_BYTE - -#endif // _MSC_VER - -// Use __may_alias__ attribute on gcc and clang -#if defined __clang__ || (defined(__GNUC__) && __GNUC__ > 5) -#define byte_may_alias __attribute__((__may_alias__)) -#else // defined __clang__ || defined __GNUC__ -#define byte_may_alias -#endif // defined __clang__ || defined __GNUC__ - -#if GSL_USE_STD_BYTE -#include -#endif - -namespace gsl -{ -#if GSL_USE_STD_BYTE - -using std::byte; -using std::to_integer; - -#else // GSL_USE_STD_BYTE - -// This is a simple definition for now that allows -// use of byte within span<> to be standards-compliant -enum class byte_may_alias byte : unsigned char -{ -}; - -template ::value>> -constexpr byte& operator<<=(byte& b, IntegerType shift) noexcept -{ - return b = byte(static_cast(b) << shift); -} - -template ::value>> -constexpr byte operator<<(byte b, IntegerType shift) noexcept -{ - return byte(static_cast(b) << shift); -} - -template ::value>> -constexpr byte& operator>>=(byte& b, IntegerType shift) noexcept -{ - return b = byte(static_cast(b) >> shift); -} - -template ::value>> -constexpr byte operator>>(byte b, IntegerType shift) noexcept -{ - return byte(static_cast(b) >> shift); -} - -constexpr byte& operator|=(byte& l, byte r) noexcept -{ - return l = byte(static_cast(l) | static_cast(r)); -} - -constexpr byte operator|(byte l, byte r) noexcept -{ - return byte(static_cast(l) | static_cast(r)); -} - -constexpr byte& operator&=(byte& l, byte r) noexcept -{ - return l = byte(static_cast(l) & static_cast(r)); -} - -constexpr byte operator&(byte l, byte r) noexcept -{ - return byte(static_cast(l) & static_cast(r)); -} - -constexpr byte& operator^=(byte& l, byte r) noexcept -{ - return l = byte(static_cast(l) ^ static_cast(r)); -} - -constexpr byte operator^(byte l, byte r) noexcept -{ - return byte(static_cast(l) ^ static_cast(r)); -} - -constexpr byte operator~(byte b) noexcept { return byte(~static_cast(b)); } - -template ::value>> -constexpr IntegerType to_integer(byte b) noexcept -{ - return static_cast(b); -} - -#endif // GSL_USE_STD_BYTE - -template -constexpr byte to_byte_impl(T t) noexcept -{ - static_assert( - E, "gsl::to_byte(t) must be provided an unsigned char, otherwise data loss may occur. " - "If you are calling to_byte with an integer contant use: gsl::to_byte() version."); - return static_cast(t); -} -template <> -// NOTE: need suppression since c++14 does not allow "return {t}" -// GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: suppression does not work -constexpr byte to_byte_impl(unsigned char t) noexcept -{ - return byte(t); -} - -template -constexpr byte to_byte(T t) noexcept -{ - return to_byte_impl::value, T>(t); -} - -template -constexpr byte to_byte() noexcept -{ - static_assert(I >= 0 && I <= 255, - "gsl::byte only has 8 bits of storage, values must be in range 0-255"); - return static_cast(I); -} - -} // namespace gsl - -#ifdef _MSC_VER -#pragma warning(pop) -#endif // _MSC_VER - -#endif // GSL_BYTE_H +#pragma once +#pragma message("This header will soon be removed. Use instead of ") +#include "byte" diff --git a/gsl/gsl_narrow b/gsl/gsl_narrow new file mode 100644 index 0000000..59685fc --- /dev/null +++ b/gsl/gsl_narrow @@ -0,0 +1,3 @@ +#pragma once +#pragma message("This header will soon be removed. Use instead of ") +#include "narrow" diff --git a/gsl/gsl_util b/gsl/gsl_util index ba57b7c..bd17d3e 100644 --- a/gsl/gsl_util +++ b/gsl/gsl_util @@ -1,154 +1,3 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// 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_UTIL_H -#define GSL_UTIL_H - -#include "gsl_assert" // for Expects - -#include -#include // for ptrdiff_t, size_t -#include // for initializer_list -#include // for is_signed, integral_constant -#include // for exchange, forward - -#if defined(_MSC_VER) && !defined(__clang__) - -#pragma warning(push) -#pragma warning(disable : 4127) // conditional expression is constant - -#endif // _MSC_VER - -namespace gsl -{ -// -// GSL.util: utilities -// - -// index type for all container indexes/subscripts/sizes -using index = std::ptrdiff_t; - -// final_action allows you to ensure something gets run at the end of a scope -template -class final_action -{ -public: - explicit final_action(F f) noexcept : f_(std::move(f)) {} - - final_action(final_action&& other) noexcept : f_(std::move(other.f_)), invoke_(std::exchange(other.invoke_, false)) {} - - final_action(const final_action&) = delete; - final_action& operator=(const final_action&) = delete; - final_action& operator=(final_action&&) = delete; - - GSL_SUPPRESS(f.6) // NO-FORMAT: attribute // terminate if throws - ~final_action() noexcept - { - if (invoke_) f_(); - } - -private: - F f_; - bool invoke_{true}; -}; - -// finally() - convenience function to generate a final_action -template -final_action finally(const F& f) noexcept -{ - return final_action(f); -} - -template -final_action finally(F&& f) noexcept -{ - return final_action(std::forward(f)); -} - -// narrow_cast(): a searchable way to do narrowing casts of values -template -GSL_SUPPRESS(type.1) // NO-FORMAT: attribute -constexpr T narrow_cast(U&& u) noexcept -{ - return static_cast(std::forward(u)); -} - -struct narrowing_error : public std::exception -{ -}; - -namespace details -{ - template - struct is_same_signedness - : public std::integral_constant::value == std::is_signed::value> - { - }; -} // namespace details - -// narrow() : a checked version of narrow_cast() that throws if the cast changed the value -template -GSL_SUPPRESS(type.1) // NO-FORMAT: attribute -GSL_SUPPRESS(f.6) // NO-FORMAT: attribute // TODO: MSVC /analyze does not recognise noexcept(false) -constexpr -T narrow(U u) noexcept(false) -{ - T t = narrow_cast(u); - if (static_cast(t) != u) throw narrowing_error{}; - if (!details::is_same_signedness::value && ((t < T{}) != (u < U{}))) - throw narrowing_error{}; - return t; -} - -// -// at() - Bounds-checked way of accessing builtin arrays, std::array, std::vector -// -template -GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute -GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute -constexpr T& at(T (&arr)[N], const index i) -{ - Expects(i >= 0 && i < narrow_cast(N)); - return arr[narrow_cast(i)]; -} - -template -GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute -GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute -constexpr auto at(Cont& cont, const index i) -> decltype(cont[cont.size()]) -{ - Expects(i >= 0 && i < narrow_cast(cont.size())); - using size_type = decltype(cont.size()); - return cont[narrow_cast(i)]; -} - -template -GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute -constexpr T at(const std::initializer_list cont, const index i) -{ - Expects(i >= 0 && i < narrow_cast(cont.size())); - return *(cont.begin() + i); -} - -} // namespace gsl - -#if defined(_MSC_VER) && !defined(__clang__) - -#pragma warning(pop) - -#endif // _MSC_VER - -#endif // GSL_UTIL_H +#pragma once +#pragma message("This header will soon be removed. Use instead of ") +#include "util" diff --git a/gsl/multi_span b/gsl/multi_span deleted file mode 100644 index 7a50715..0000000 --- a/gsl/multi_span +++ /dev/null @@ -1,2273 +0,0 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// 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_MULTI_SPAN_H -#define GSL_MULTI_SPAN_H - -#include "gsl_assert" // for Expects -#include "gsl_byte" // for byte -#include "gsl_util" // for narrow_cast - -#include // for transform, lexicographical_compare -#include // for array -#include // for std::ptrdiff_t, size_t, nullptr_t -#include // for PTRDIFF_MAX -#include // for divides, multiplies, minus, negate, plus -#include // for initializer_list -#include // for iterator, random_access_iterator_tag -#include // for numeric_limits -#include -#include -#include -#include // for basic_string -#include // for enable_if_t, remove_cv_t, is_same, is_co... -#include - -#if defined(_MSC_VER) && !defined(__clang__) - -// turn off some warnings that are noisy about our Expects statements -#pragma warning(push) -#pragma warning(disable : 4127) // conditional expression is constant -#pragma warning(disable : 4702) // unreachable code - -// Turn MSVC /analyze rules that generate too much noise. TODO: fix in the tool. -#pragma warning(disable : 26495) // uninitalized member when constructor calls constructor -#pragma warning(disable : 26473) // in some instantiations we cast to the same type -#pragma warning(disable : 26490) // TODO: bug in parser - attributes and templates -#pragma warning(disable : 26465) // TODO: bug - suppression does not work on template functions -#pragma warning(disable : 4996) // use of function or classes marked [[deprecated]] - -#if _MSC_VER < 1910 -#pragma push_macro("constexpr") -#define constexpr /*constexpr*/ - -#endif // _MSC_VER < 1910 -#endif // _MSC_VER - -#if defined(__GNUC__) || defined(__clang__) -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wdeprecated-declarations" -#endif - -// GCC 7 does not like the signed unsigned missmatch (size_t std::ptrdiff_t) -// While there is a conversion from signed to unsigned, it happens at -// compiletime, so the compiler wouldn't have to warn indiscriminently, but -// could check if the source value actually doesn't fit into the target type -// and only warn in those cases. -#if defined(__GNUC__) && __GNUC__ > 6 -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wsign-conversion" -#endif - -namespace gsl -{ - -/* -** begin definitions of index and bounds -*/ -namespace details -{ - template - struct [[deprecated]] SizeTypeTraits - { - static const SizeType max_value = std::numeric_limits::max(); - }; - - template - class [[deprecated]] are_integral : public std::integral_constant - { - }; - - template - class [[deprecated]] are_integral - : public std::integral_constant::value && are_integral::value> - { - }; -} // namespace details - -template -class [[deprecated]] multi_span_index final { - static_assert(Rank > 0, "Rank must be greater than 0!"); - - template - friend class multi_span_index; - -public: - static const std::size_t rank = Rank; - using value_type = std::ptrdiff_t; - using size_type = value_type; - using reference = std::add_lvalue_reference_t; - using const_reference = std::add_lvalue_reference_t>; - - constexpr multi_span_index() noexcept {} - - constexpr multi_span_index(const value_type(&values)[Rank]) noexcept - { - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - std::copy(values, values + Rank, elems); - } - - template ::value>> - constexpr multi_span_index(Ts... ds) noexcept : elems{narrow_cast(ds)...} - {} - - constexpr multi_span_index(const multi_span_index& other) noexcept = default; - - constexpr multi_span_index& operator=(const multi_span_index& rhs) noexcept = default; - - // Preconditions: component_idx < rank - GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr reference operator[](std::size_t component_idx) - { - Expects(component_idx < Rank); // Component index must be less than rank - return elems[component_idx]; - } - - // Preconditions: component_idx < rank - GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr const_reference operator[](std::size_t component_idx) const - { - Expects(component_idx < Rank); // Component index must be less than rank - return elems[component_idx]; - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - constexpr bool operator==(const multi_span_index& rhs) const - { - return std::equal(elems, elems + rank, rhs.elems); - } - - constexpr bool operator!=(const multi_span_index& rhs) const { return !(*this == rhs); } - - constexpr multi_span_index operator+() const noexcept { return *this; } - - constexpr multi_span_index operator-() const - { - multi_span_index ret = *this; - std::transform(ret, ret + rank, ret, std::negate{}); - return ret; - } - - constexpr multi_span_index operator+(const multi_span_index& rhs) const - { - multi_span_index ret = *this; - ret += rhs; - return ret; - } - - constexpr multi_span_index operator-(const multi_span_index& rhs) const - { - multi_span_index ret = *this; - ret -= rhs; - return ret; - } - - constexpr multi_span_index& operator+=(const multi_span_index& rhs) - { - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - std::transform(elems, elems + rank, rhs.elems, elems, std::plus{}); - return *this; - } - - constexpr multi_span_index& operator-=(const multi_span_index& rhs) - { - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - std::transform(elems, elems + rank, rhs.elems, elems, std::minus{}); - return *this; - } - - constexpr multi_span_index operator*(value_type v) const - { - multi_span_index ret = *this; - ret *= v; - return ret; - } - - constexpr multi_span_index operator/(value_type v) const - { - multi_span_index ret = *this; - ret /= v; - return ret; - } - - friend constexpr multi_span_index operator*(value_type v, const multi_span_index& rhs) - { - return rhs * v; - } - - constexpr multi_span_index& operator*=(value_type v) - { - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - std::transform(elems, elems + rank, elems, - [v](value_type x) { return std::multiplies{}(x, v); }); - return *this; - } - - constexpr multi_span_index& operator/=(value_type v) - { - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute - std::transform(elems, elems + rank, elems, - [v](value_type x) { return std::divides{}(x, v); }); - return *this; - } - -private: - value_type elems[Rank] = {}; -}; - -#if !defined(_MSC_VER) || _MSC_VER >= 1910 - -struct [[deprecated]] static_bounds_dynamic_range_t -{ - template ::value>> - constexpr operator T() const noexcept - { - return narrow_cast(-1); - } -}; - -constexpr bool operator==(static_bounds_dynamic_range_t, static_bounds_dynamic_range_t) noexcept -{ - return true; -} - -constexpr bool operator!=(static_bounds_dynamic_range_t, static_bounds_dynamic_range_t) noexcept -{ - return false; -} - -template ::value>> -constexpr bool operator==(static_bounds_dynamic_range_t, T other) noexcept -{ - return narrow_cast(-1) == other; -} - -template ::value>> -constexpr bool operator==(T left, static_bounds_dynamic_range_t right) noexcept -{ - return right == left; -} - -template ::value>> -constexpr bool operator!=(static_bounds_dynamic_range_t, T other) noexcept -{ - return narrow_cast(-1) != other; -} - -template ::value>> -constexpr bool operator!=(T left, static_bounds_dynamic_range_t right) noexcept -{ - return right != left; -} - -constexpr static_bounds_dynamic_range_t dynamic_range{}; -#else -const std::ptrdiff_t dynamic_range = -1; -#endif - -struct [[deprecated]] generalized_mapping_tag -{ -}; -struct[[deprecated]] contiguous_mapping_tag : generalized_mapping_tag{}; - -namespace details -{ - - template - struct [[deprecated]] LessThan - { - static const bool value = Left < Right; - }; - - template - struct [[deprecated]] BoundsRanges { - using size_type = std::ptrdiff_t; - static const size_type Depth = 0; - static const size_type DynamicNum = 0; - static const size_type CurrentRange = 1; - static const size_type TotalSize = 1; - - // TODO : following signature is for work around VS bug - template - constexpr BoundsRanges(const OtherRange&, bool /* firstLevel */) - {} - - constexpr BoundsRanges(const std::ptrdiff_t* const) {} - constexpr BoundsRanges() noexcept = default; - - template - constexpr void serialize(T&) const - {} - - template - constexpr size_type linearize(const T&) const - { - return 0; - } - - template - constexpr size_type contains(const T&) const - { - return -1; - } - - constexpr size_type elementNum(std::size_t) const noexcept { return 0; } - - constexpr size_type totalSize() const noexcept { return TotalSize; } - - constexpr bool operator==(const BoundsRanges&) const noexcept { return true; } - }; - - template - struct[[deprecated]] BoundsRanges : BoundsRanges - { - using Base = BoundsRanges; - using size_type = std::ptrdiff_t; - static const std::size_t Depth = Base::Depth + 1; - static const std::size_t DynamicNum = Base::DynamicNum + 1; - static const size_type CurrentRange = dynamic_range; - static const size_type TotalSize = dynamic_range; - - private: - size_type m_bound; - - public: - GSL_SUPPRESS( - f.23) // NO-FORMAT: attribute // this pointer type is cannot be assigned nullptr - issue in not_null - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - constexpr BoundsRanges(const std::ptrdiff_t* const arr) - : Base(arr + 1), m_bound(*arr * this->Base::totalSize()) - { - Expects(0 <= *arr); - } - - constexpr BoundsRanges() noexcept : m_bound(0) {} - - template - constexpr BoundsRanges(const BoundsRanges& other, - bool /* firstLevel */ = true) - : Base(static_cast&>(other), false) - , m_bound(other.totalSize()) - {} - - template - constexpr void serialize(T & arr) const - { - arr[Dim] = elementNum(); - this->Base::template serialize(arr); - } - - template - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type linearize(const T& arr) const - { - const size_type index = this->Base::totalSize() * arr[Dim]; - Expects(index < m_bound); - return index + this->Base::template linearize(arr); - } - - template - constexpr size_type contains(const T& arr) const - { - const std::ptrdiff_t last = this->Base::template contains(arr); - if (last == -1) return -1; - const std::ptrdiff_t cur = this->Base::totalSize() * arr[Dim]; - return cur < m_bound ? cur + last : -1; - } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type totalSize() const noexcept { return m_bound; } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type elementNum() const noexcept - { - return totalSize() / this->Base::totalSize(); - } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type elementNum(std::size_t dim) const noexcept - { - if (dim > 0) - return this->Base::elementNum(dim - 1); - else - return elementNum(); - } - - constexpr bool operator==(const BoundsRanges& rhs) const noexcept - { - return m_bound == rhs.m_bound && - static_cast(*this) == static_cast(rhs); - } - }; - - template - struct[[deprecated]] BoundsRanges : BoundsRanges - { - using Base = BoundsRanges; - using size_type = std::ptrdiff_t; - static const std::size_t Depth = Base::Depth + 1; - static const std::size_t DynamicNum = Base::DynamicNum; - static const size_type CurrentRange = CurRange; - static const size_type TotalSize = - Base::TotalSize == dynamic_range ? dynamic_range : CurrentRange * Base::TotalSize; - - constexpr BoundsRanges(const std::ptrdiff_t* const arr) : Base(arr) {} - constexpr BoundsRanges() = default; - - template - constexpr BoundsRanges(const BoundsRanges& other, - bool firstLevel = true) - : Base(static_cast&>(other), false) - { - GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: false positive - (void) firstLevel; - } - - template - constexpr void serialize(T & arr) const - { - arr[Dim] = elementNum(); - this->Base::template serialize(arr); - } - - template - constexpr size_type linearize(const T& arr) const - { - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - Expects(arr[Dim] >= 0 && arr[Dim] < CurrentRange); // Index is out of range - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - const std::ptrdiff_t d = arr[Dim]; - return this->Base::totalSize() * d + this->Base::template linearize(arr); - } - - template - constexpr size_type contains(const T& arr) const - { - if (arr[Dim] >= CurrentRange) return -1; - const size_type last = this->Base::template contains(arr); - if (last == -1) return -1; - return this->Base::totalSize() * arr[Dim] + last; - } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type totalSize() const noexcept - { - return CurrentRange * this->Base::totalSize(); - } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type elementNum() const noexcept { return CurrentRange; } - - GSL_SUPPRESS( - c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used - constexpr size_type elementNum(std::size_t dim) const noexcept - { - if (dim > 0) - return this->Base::elementNum(dim - 1); - else - return elementNum(); - } - - constexpr bool operator==(const BoundsRanges& rhs) const noexcept - { - return static_cast(*this) == static_cast(rhs); - } - }; - - template - struct[[deprecated]] BoundsRangeConvertible - : public std::integral_constant= TargetType::TotalSize || - TargetType::TotalSize == dynamic_range || - SourceType::TotalSize == dynamic_range || - TargetType::TotalSize == 0)>{}; - - template - struct [[deprecated]] TypeListIndexer { - const TypeChain& obj_; - constexpr TypeListIndexer(const TypeChain& obj) : obj_(obj) {} - - template - constexpr const TypeChain& getObj(std::true_type) - { - return obj_; - } - - template - constexpr auto getObj(std::false_type) - ->decltype(TypeListIndexer(static_cast(obj_)).template get()) - { - return TypeListIndexer(static_cast(obj_)).template get(); - } - - template - constexpr auto get()->decltype(getObj(std::integral_constant())) - { - return getObj(std::integral_constant()); - } - }; - - template - constexpr TypeListIndexer createTypeListIndexer(const TypeChain& obj) - { - return TypeListIndexer(obj); - } - - template 1), - typename Ret = std::enable_if_t>> - constexpr Ret shift_left(const multi_span_index& other) noexcept - { - Ret ret{}; - for (std::size_t i = 0; i < Rank - 1; ++i) - { - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - ret[i] = other[i + 1]; - } - return ret; - } -} // namespace details - -template -class [[deprecated]] bounds_iterator; - -template -class [[deprecated]] static_bounds { -public: - static_bounds(const details::BoundsRanges&) {} -}; - -template -class[[deprecated]] static_bounds -{ - using MyRanges = details::BoundsRanges; - - MyRanges m_ranges; - constexpr static_bounds(const MyRanges& range) noexcept : m_ranges(range) {} - - template - friend class static_bounds; - -public: - static const std::size_t rank = MyRanges::Depth; - static const std::size_t dynamic_rank = MyRanges::DynamicNum; - static const std::ptrdiff_t static_size = MyRanges::TotalSize; - - using size_type = std::ptrdiff_t; - using index_type = multi_span_index; - using const_index_type = std::add_const_t; - using iterator = bounds_iterator; - using const_iterator = bounds_iterator; - using difference_type = std::ptrdiff_t; - using sliced_type = static_bounds; - using mapping_type = contiguous_mapping_tag; - - constexpr static_bounds() /*noexcept*/ = default; - - template - struct BoundsRangeConvertible2; - - template > - static auto helpBoundsRangeConvertible(SourceType, TargetType, std::true_type)->Ret; - - template - static auto helpBoundsRangeConvertible(SourceType, TargetType, ...)->std::false_type; - - template - struct BoundsRangeConvertible2 - : decltype(helpBoundsRangeConvertible( - SourceType(), TargetType(), - std::integral_constant())) - { - }; - - template - struct BoundsRangeConvertible2 : std::true_type - { - }; - - template - struct BoundsRangeConvertible - : decltype(helpBoundsRangeConvertible( - SourceType(), TargetType(), - std::integral_constant::value || - TargetType::CurrentRange == dynamic_range || - SourceType::CurrentRange == dynamic_range)>())) - { - }; - - template - struct BoundsRangeConvertible : std::true_type - { - }; - - template , - details::BoundsRanges>::value>> - constexpr static_bounds(const static_bounds& other) : m_ranges(other.m_ranges) - { - Expects((MyRanges::DynamicNum == 0 && details::BoundsRanges::DynamicNum == 0) || - MyRanges::DynamicNum > 0 || other.m_ranges.totalSize() >= m_ranges.totalSize()); - } - - constexpr static_bounds(std::initializer_list il) : m_ranges(il.begin()) - { - // Size of the initializer list must match the rank of the array - Expects((MyRanges::DynamicNum == 0 && il.size() == 1 && *il.begin() == static_size) || - MyRanges::DynamicNum == il.size()); - // Size of the range must be less than the max element of the size type - Expects(m_ranges.totalSize() <= PTRDIFF_MAX); - } - - constexpr sliced_type slice() const noexcept - { - return sliced_type{static_cast&>(m_ranges)}; - } - - constexpr size_type stride() const noexcept { return rank > 1 ? slice().size() : 1; } - - constexpr size_type size() const noexcept { return m_ranges.totalSize(); } - - constexpr size_type total_size() const noexcept { return m_ranges.totalSize(); } - - constexpr size_type linearize(const index_type& idx) const { return m_ranges.linearize(idx); } - - constexpr bool contains(const index_type& idx) const noexcept - { - return m_ranges.contains(idx) != -1; - } - - constexpr size_type operator[](std::size_t idx) const noexcept - { - return m_ranges.elementNum(idx); - } - - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < rank, - "dimension should be less than rank (dimension count starts from 0)"); - return details::createTypeListIndexer(m_ranges).template get().elementNum(); - } - - template - constexpr size_type extent(IntType dim) const - { - static_assert(std::is_integral::value, - "Dimension parameter must be supplied as an integral type."); - auto real_dim = narrow_cast(dim); - Expects(real_dim < rank); - - return m_ranges.elementNum(real_dim); - } - - constexpr index_type index_bounds() const noexcept - { - size_type extents[rank] = {}; - m_ranges.serialize(extents); - return {extents}; - } - - template - constexpr bool operator==(const static_bounds& rhs) const noexcept - { - return this->size() == rhs.size(); - } - - template - constexpr bool operator!=(const static_bounds& rhs) const noexcept - { - return !(*this == rhs); - } - - constexpr const_iterator begin() const noexcept { return const_iterator(*this, index_type{}); } - - constexpr const_iterator end() const noexcept - { - return const_iterator(*this, this->index_bounds()); - } -}; - -template -class [[deprecated]] strided_bounds { - template - friend class strided_bounds; - -public: - static const std::size_t rank = Rank; - using value_type = std::ptrdiff_t; - using reference = std::add_lvalue_reference_t; - using const_reference = std::add_const_t; - using size_type = value_type; - using difference_type = value_type; - using index_type = multi_span_index; - using const_index_type = std::add_const_t; - using iterator = bounds_iterator; - using const_iterator = bounds_iterator; - static const value_type dynamic_rank = rank; - static const value_type static_size = dynamic_range; - using sliced_type = std::conditional_t, void>; - using mapping_type = generalized_mapping_tag; - - constexpr strided_bounds(const strided_bounds&) noexcept = default; - - constexpr strided_bounds& operator=(const strided_bounds&) noexcept = default; - - constexpr strided_bounds(const value_type(&values)[rank], index_type strides) - : m_extents(values), m_strides(std::move(strides)) - {} - - constexpr strided_bounds(const index_type& extents, const index_type& strides) noexcept - : m_extents(extents), m_strides(strides) - {} - - constexpr index_type strides() const noexcept { return m_strides; } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type total_size() const noexcept - { - size_type ret = 0; - for (std::size_t i = 0; i < rank; ++i) { ret += (m_extents[i] - 1) * m_strides[i]; } - return ret + 1; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type size() const noexcept - { - size_type ret = 1; - for (std::size_t i = 0; i < rank; ++i) { ret *= m_extents[i]; } - return ret; - } - - constexpr bool contains(const index_type& idx) const noexcept - { - for (std::size_t i = 0; i < rank; ++i) - { - if (idx[i] < 0 || idx[i] >= m_extents[i]) return false; - } - return true; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type linearize(const index_type& idx) const - { - size_type ret = 0; - for (std::size_t i = 0; i < rank; i++) - { - Expects(idx[i] < m_extents[i]); // index is out of bounds of the array - ret += idx[i] * m_strides[i]; - } - return ret; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type stride() const noexcept { return m_strides[0]; } - - template 1), typename Ret = std::enable_if_t> - constexpr sliced_type slice() const - { - return {details::shift_left(m_extents), details::shift_left(m_strides)}; - } - - template - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr size_type extent() const noexcept - { - static_assert(Dim < Rank, - "dimension should be less than rank (dimension count starts from 0)"); - return m_extents[Dim]; - } - - constexpr index_type index_bounds() const noexcept { return m_extents; } - - constexpr const_iterator begin() const noexcept { return const_iterator{*this, index_type{}}; } - - constexpr const_iterator end() const noexcept { return const_iterator{*this, index_bounds()}; } - -private: - index_type m_extents; - index_type m_strides; -}; - -template -struct[[deprecated]] is_bounds : std::integral_constant{}; -template -struct[[deprecated]] is_bounds> : std::integral_constant{}; -template -struct[[deprecated]] is_bounds> : std::integral_constant{}; - -template -class [[deprecated]] bounds_iterator { -public: - static const std::size_t rank = IndexType::rank; - using iterator_category = std::random_access_iterator_tag; - using value_type = IndexType; - using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; - using index_type = value_type; - using index_size_type = typename IndexType::value_type; - template - explicit bounds_iterator(const Bounds& bnd, value_type curr) noexcept - : boundary_(bnd.index_bounds()), curr_(std::move(curr)) - { - static_assert(is_bounds::value, "Bounds type must be provided"); - } - - constexpr reference operator*() const noexcept { return curr_; } - - constexpr pointer operator->() const noexcept { return &curr_; } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute - constexpr bounds_iterator& operator++() noexcept - - { - for (std::size_t i = rank; i-- > 0;) - { - if (curr_[i] < boundary_[i] - 1) - { - curr_[i]++; - return *this; - } - curr_[i] = 0; - } - // If we're here we've wrapped over - set to past-the-end. - curr_ = boundary_; - return *this; - } - - constexpr bounds_iterator operator++(int) noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr bounds_iterator& operator--() - { - if (!less(curr_, boundary_)) - { - // if at the past-the-end, set to last element - for (std::size_t i = 0; i < rank; ++i) { curr_[i] = boundary_[i] - 1; } - return *this; - } - for (std::size_t i = rank; i-- > 0;) - { - if (curr_[i] >= 1) - { - curr_[i]--; - return *this; - } - curr_[i] = boundary_[i] - 1; - } - // If we're here the preconditions were violated - // "pre: there exists s such that r == ++s" - Expects(false); - return *this; - } - - constexpr bounds_iterator operator--(int) noexcept - { - auto ret = *this; - --(*this); - return ret; - } - - constexpr bounds_iterator operator+(difference_type n) const noexcept - { - bounds_iterator ret{*this}; - return ret += n; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr bounds_iterator& operator+=(difference_type n) - { - auto linear_idx = linearize(curr_) + n; - std::remove_const_t stride = 0; - stride[rank - 1] = 1; - for (std::size_t i = rank - 1; i-- > 0;) { stride[i] = stride[i + 1] * boundary_[i + 1]; } - for (std::size_t i = 0; i < rank; ++i) - { - curr_[i] = linear_idx / stride[i]; - linear_idx = linear_idx % stride[i]; - } - // index is out of bounds of the array - Expects(!less(curr_, index_type{}) && !less(boundary_, curr_)); - return *this; - } - - constexpr bounds_iterator operator-(difference_type n) const noexcept - { - bounds_iterator ret{*this}; - return ret -= n; - } - - constexpr bounds_iterator& operator-=(difference_type n) noexcept { return *this += -n; } - - constexpr difference_type operator-(const bounds_iterator& rhs) const noexcept - { - return linearize(curr_) - linearize(rhs.curr_); - } - - constexpr value_type operator[](difference_type n) const noexcept { return *(*this + n); } - - constexpr bool operator==(const bounds_iterator& rhs) const noexcept - { - return curr_ == rhs.curr_; - } - - constexpr bool operator!=(const bounds_iterator& rhs) const noexcept { return !(*this == rhs); } - - constexpr bool operator<(const bounds_iterator& rhs) const noexcept - { - return less(curr_, rhs.curr_); - } - - constexpr bool operator<=(const bounds_iterator& rhs) const noexcept { return !(rhs < *this); } - - constexpr bool operator>(const bounds_iterator& rhs) const noexcept { return rhs < *this; } - - constexpr bool operator>=(const bounds_iterator& rhs) const noexcept { return !(rhs > *this); } - - void swap(bounds_iterator & rhs) noexcept - { - std::swap(boundary_, rhs.boundary_); - std::swap(curr_, rhs.curr_); - } - -private: - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr bool less(index_type & one, index_type & other) const noexcept - { - for (std::size_t i = 0; i < rank; ++i) - { - if (one[i] < other[i]) return true; - } - return false; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - constexpr index_size_type linearize(const value_type& idx) const noexcept - { - // TODO: Smarter impl. - // Check if past-the-end - index_size_type multiplier = 1; - index_size_type res = 0; - if (!less(idx, boundary_)) - { - res = 1; - for (std::size_t i = rank; i-- > 0;) - { - res += (idx[i] - 1) * multiplier; - multiplier *= boundary_[i]; - } - } - else - { - for (std::size_t i = rank; i-- > 0;) - { - res += idx[i] * multiplier; - multiplier *= boundary_[i]; - } - } - return res; - } - - value_type boundary_; - std::remove_const_t curr_; -}; - -template -bounds_iterator operator+(typename bounds_iterator::difference_type n, - const bounds_iterator& rhs) noexcept -{ - return rhs + n; -} - -namespace details -{ - template - constexpr std::enable_if_t< - std::is_same::value, - typename Bounds::index_type> - make_stride(const Bounds& bnd) noexcept - { - return bnd.strides(); - } - - // Make a stride vector from bounds, assuming contiguous memory. - template - constexpr std::enable_if_t< - std::is_same::value, - typename Bounds::index_type> - make_stride(const Bounds& bnd) noexcept - { - auto extents = bnd.index_bounds(); - typename Bounds::size_type stride[Bounds::rank] = {}; - - stride[Bounds::rank - 1] = 1; - for (std::size_t i = 1; i < Bounds::rank; ++i) - { - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute - stride[Bounds::rank - i - 1] = stride[Bounds::rank - i] * extents[Bounds::rank - i]; - } - return {stride}; - } - - template - void verifyBoundsReshape(const BoundsSrc& src, const BoundsDest& dest) - { - static_assert(is_bounds::value && is_bounds::value, - "The src type and dest type must be bounds"); - static_assert(std::is_same::value, - "The source type must be a contiguous bounds"); - static_assert(BoundsDest::static_size == dynamic_range || - BoundsSrc::static_size == dynamic_range || - BoundsDest::static_size == BoundsSrc::static_size, - "The source bounds must have same size as dest bounds"); - Expects(src.size() == dest.size()); - } - -} // namespace details - -template -class [[deprecated]] contiguous_span_iterator; -template -class [[deprecated]] general_span_iterator; - -template -struct [[deprecated]] dim_t -{ - static const std::ptrdiff_t value = DimSize; -}; -template <> -struct [[deprecated]] dim_t -{ - static const std::ptrdiff_t value = dynamic_range; - const std::ptrdiff_t dvalue; - constexpr dim_t(std::ptrdiff_t size) noexcept : dvalue(size) {} -}; - -template = 0)>> -constexpr dim_t dim() noexcept -{ - return dim_t(); -} - -template > -constexpr dim_t dim(std::ptrdiff_t n) noexcept -{ - return dim_t<>(n); -} - -template -class [[deprecated("gsl::multi_span is deprecated because it is not in the C++ Core Guidelines")]] multi_span; - -template -class [[deprecated("gsl::strided_span is deprecated because it is not in the C++ Core Guidelines")]] strided_span; - -namespace details -{ - template - struct [[deprecated]] SpanTypeTraits - { - using value_type = T; - using size_type = std::size_t; - }; - - template - struct [[deprecated]] SpanTypeTraits< - Traits, typename std::is_reference::type> - { - using value_type = typename Traits::span_traits::value_type; - using size_type = typename Traits::span_traits::size_type; - }; - - template - struct [[deprecated]] SpanArrayTraits - { - using type = multi_span; - using value_type = T; - using bounds_type = static_bounds; - using pointer = T*; - using reference = T&; - }; - template - struct [[deprecated]] SpanArrayTraits : SpanArrayTraits - { - }; - - template - BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::true_type) // dynamic size - { - Expects(totalSize >= 0 && totalSize <= PTRDIFF_MAX); - return BoundsType{totalSize}; - } - template - BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::false_type) // static size - { - Expects(BoundsType::static_size <= totalSize); - return {}; - } - template - BoundsType newBoundsHelper(std::ptrdiff_t totalSize) - { - static_assert(BoundsType::dynamic_rank <= 1, "dynamic rank must less or equal to 1"); - return newBoundsHelperImpl( - totalSize, std::integral_constant()); - } - - struct [[deprecated]] Sep - { - }; - - template - T static_as_multi_span_helper(Sep, Args... args) - { - return T{narrow_cast(args)...}; - } - template - std::enable_if_t< - !std::is_same>::value && !std::is_same::value, T> - static_as_multi_span_helper(Arg, Args... args) - { - return static_as_multi_span_helper(args...); - } - template - T static_as_multi_span_helper(dim_t val, Args... args) - { - return static_as_multi_span_helper(args..., val.dvalue); - } - - template - struct [[deprecated]] static_as_multi_span_static_bounds_helper - { - using type = static_bounds<(Dimensions::value)...>; - }; - - template - struct [[deprecated]] is_multi_span_oracle : std::false_type - { - }; - - template - struct [[deprecated]] is_multi_span_oracle> - : std::true_type - { - }; - - template - struct [[deprecated]] is_multi_span_oracle> : std::true_type - { - }; - - template - struct [[deprecated]] is_multi_span : is_multi_span_oracle> - { - }; -} // namespace details - -template -class [[deprecated("gsl::multi_span is deprecated because it is not in the C++ Core Guidelines")]] multi_span { - // TODO do we still need this? - template - friend class multi_span; - -public: - using bounds_type = static_bounds; - static const std::size_t Rank = bounds_type::rank; - using size_type = typename bounds_type::size_type; - using index_type = typename bounds_type::index_type; - using value_type = ValueType; - using const_value_type = std::add_const_t; - using pointer = std::add_pointer_t; - using reference = std::add_lvalue_reference_t; - using iterator = contiguous_span_iterator; - using const_span = multi_span; - using const_iterator = contiguous_span_iterator; - using reverse_iterator = std::reverse_iterator; - using const_reverse_iterator = std::reverse_iterator; - using sliced_type = - std::conditional_t>; - -private: - pointer data_; - bounds_type bounds_; - - friend iterator; - friend const_iterator; - -public: - // default constructor - same as constructing from nullptr_t - GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive - constexpr multi_span() noexcept : multi_span(nullptr, bounds_type{}) - { - static_assert(bounds_type::dynamic_rank != 0 || - (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), - "Default construction of multi_span only possible " - "for dynamic or fixed, zero-length spans."); - } - - // construct from nullptr - get an empty multi_span - GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive - constexpr multi_span(std::nullptr_t) noexcept : multi_span(nullptr, bounds_type{}) - { - static_assert(bounds_type::dynamic_rank != 0 || - (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), - "nullptr_t construction of multi_span only possible " - "for dynamic or fixed, zero-length spans."); - } - - // construct from nullptr with size of 0 (helps with template function calls) - template ::value>> - - // GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive // TODO: parser bug - constexpr multi_span(std::nullptr_t, IntType size) : multi_span(nullptr, bounds_type{}) - { - static_assert(bounds_type::dynamic_rank != 0 || - (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), - "nullptr_t construction of multi_span only possible " - "for dynamic or fixed, zero-length spans."); - Expects(size == 0); - } - - // construct from a single element - - GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive - constexpr multi_span(reference data) noexcept : multi_span(&data, bounds_type{1}) - { - static_assert(bounds_type::dynamic_rank > 0 || bounds_type::static_size == 0 || - bounds_type::static_size == 1, - "Construction from a single element only possible " - "for dynamic or fixed spans of length 0 or 1."); - } - - // prevent constructing from temporaries for single-elements - constexpr multi_span(value_type &&) = delete; - - // construct from pointer + length - GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive - constexpr multi_span(pointer ptr, size_type size) : multi_span(ptr, bounds_type{size}) {} - - // construct from pointer + length - multidimensional - constexpr multi_span(pointer data, bounds_type bounds) : data_(data), bounds_(std::move(bounds)) - { - Expects((bounds_.size() > 0 && data != nullptr) || bounds_.size() == 0); - } - - // construct from begin,end pointer pair - template ::value && - details::LessThan::value>> - constexpr multi_span(pointer begin, Ptr end) - : multi_span(begin, - details::newBoundsHelper(static_cast(end) - begin)) - { - Expects(begin != nullptr && end != nullptr && begin <= static_cast(end)); - } - - // construct from n-dimensions static array - template > - constexpr multi_span(T(&arr)[N]) - : multi_span(reinterpret_cast(arr), bounds_type{typename Helper::bounds_type{}}) - { - static_assert(std::is_convertible::value, - "Cannot convert from source type to target multi_span type."); - static_assert(std::is_convertible::value, - "Cannot construct a multi_span from an array with fewer elements."); - } - - // construct from n-dimensions dynamic array (e.g. new int[m][4]) - // (precedence will be lower than the 1-dimension pointer) - template > - constexpr multi_span(T* const& data, size_type size) - : multi_span(reinterpret_cast(data), typename Helper::bounds_type{size}) - { - static_assert(std::is_convertible::value, - "Cannot convert from source type to target multi_span type."); - } - - // construct from std::array - template - constexpr multi_span(std::array & arr) - : multi_span(arr.data(), bounds_type{static_bounds{}}) - { - static_assert( - std::is_convertible(*)[]>::value, - "Cannot convert from source type to target multi_span type."); - static_assert(std::is_convertible, bounds_type>::value, - "You cannot construct a multi_span from a std::array of smaller size."); - } - - // construct from const std::array - template - constexpr multi_span(const std::array& arr) - : multi_span(arr.data(), bounds_type{static_bounds{}}) - { - static_assert( - std::is_convertible(*)[]>::value, - "Cannot convert from source type to target multi_span type."); - static_assert(std::is_convertible, bounds_type>::value, - "You cannot construct a multi_span from a std::array of smaller size."); - } - - // prevent constructing from temporary std::array - template - constexpr multi_span(std::array && arr) = delete; - - // construct from containers - // future: could use contiguous_iterator_traits to identify only contiguous containers - // type-requirements: container must have .size(), operator[] which are value_type compatible - template ::value && - std::is_convertible::value && - std::is_same().size(), - *std::declval().data())>, - DataType>::value>> - constexpr multi_span(Cont & cont) - : multi_span(static_cast(cont.data()), - details::newBoundsHelper(narrow_cast(cont.size()))) - {} - - // prevent constructing from temporary containers - template ::value && - std::is_convertible::value && - std::is_same().size(), - *std::declval().data())>, - DataType>::value>> - explicit constexpr multi_span(Cont && cont) = delete; - - // construct from a convertible multi_span - template , - typename = std::enable_if_t::value && - std::is_convertible::value>> - constexpr multi_span(multi_span other) - : data_(other.data_), bounds_(other.bounds_) - {} - - // trivial copy and move - constexpr multi_span(const multi_span&) = default; - constexpr multi_span(multi_span &&) = default; - - // trivial assignment - constexpr multi_span& operator=(const multi_span&) = default; - constexpr multi_span& operator=(multi_span&&) = default; - - // first() - extract the first Count elements into a new multi_span - template - - constexpr multi_span first() const - { - static_assert(Count >= 0, "Count must be >= 0."); - static_assert(bounds_type::static_size == dynamic_range || - Count <= bounds_type::static_size, - "Count is out of bounds."); - - Expects(bounds_type::static_size != dynamic_range || Count <= this->size()); - return {this->data(), Count}; - } - - // first() - extract the first count elements into a new multi_span - constexpr multi_span first(size_type count) const - { - Expects(count >= 0 && count <= this->size()); - return {this->data(), count}; - } - - // last() - extract the last Count elements into a new multi_span - template - constexpr multi_span last() const - { - static_assert(Count >= 0, "Count must be >= 0."); - static_assert(bounds_type::static_size == dynamic_range || - Count <= bounds_type::static_size, - "Count is out of bounds."); - - Expects(bounds_type::static_size != dynamic_range || Count <= this->size()); - return {this->data() + this->size() - Count, Count}; - } - - // last() - extract the last count elements into a new multi_span - constexpr multi_span last(size_type count) const - { - Expects(count >= 0 && count <= this->size()); - return {this->data() + this->size() - count, count}; - } - - // subspan() - create a subview of Count elements starting at Offset - template - constexpr multi_span subspan() const - { - static_assert(Count >= 0, "Count must be >= 0."); - static_assert(Offset >= 0, "Offset must be >= 0."); - static_assert(bounds_type::static_size == dynamic_range || - ((Offset <= bounds_type::static_size) && - Count <= bounds_type::static_size - Offset), - "You must describe a sub-range within bounds of the multi_span."); - - Expects(bounds_type::static_size != dynamic_range || - (Offset <= this->size() && Count <= this->size() - Offset)); - return {this->data() + Offset, Count}; - } - - // subspan() - create a subview of count elements starting at offset - // supplying dynamic_range for count will consume all available elements from offset - constexpr multi_span subspan(size_type offset, - size_type count = dynamic_range) const - { - Expects((offset >= 0 && offset <= this->size()) && - (count == dynamic_range || (count <= this->size() - offset))); - return {this->data() + offset, count == dynamic_range ? this->length() - offset : count}; - } - - // section - creates a non-contiguous, strided multi_span from a contiguous one - constexpr strided_span section(index_type origin, index_type extents) const - { - const size_type size = this->bounds().total_size() - this->bounds().linearize(origin); - return {&this->operator[](origin), size, - strided_bounds{extents, details::make_stride(bounds())}}; - } - - // length of the multi_span in elements - constexpr size_type size() const noexcept { return bounds_.size(); } - - // length of the multi_span in elements - constexpr size_type length() const noexcept { return this->size(); } - - // length of the multi_span in bytes - constexpr size_type size_bytes() const noexcept - { - return narrow_cast(sizeof(value_type)) * this->size(); - } - - // length of the multi_span in bytes - constexpr size_type length_bytes() const noexcept { return this->size_bytes(); } - - constexpr bool empty() const noexcept { return this->size() == 0; } - - static constexpr std::size_t rank() { return Rank; } - - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < Rank, - "Dimension should be less than rank (dimension count starts from 0)."); - return bounds_.template extent(); - } - - template - constexpr size_type extent(IntType dim) const - { - return bounds_.extent(dim); - } - - constexpr bounds_type bounds() const noexcept { return bounds_; } - - constexpr pointer data() const noexcept { return data_; } - - template - constexpr reference operator()(FirstIndex idx) - { - return this->operator[](narrow_cast(idx)); - } - - template - constexpr reference operator()(FirstIndex firstIndex, OtherIndices... indices) - { - const index_type idx = {narrow_cast(firstIndex), - narrow_cast(indices)...}; - return this->operator[](idx); - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - constexpr reference operator[](const index_type& idx) const - { - return data_[bounds_.linearize(idx)]; - } - - template 1), typename Ret = std::enable_if_t> - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - constexpr Ret operator[](size_type idx) const - { - Expects(idx >= 0 && idx < bounds_.size()); // index is out of bounds of the array - const size_type ridx = idx * bounds_.stride(); - - // index is out of bounds of the underlying data - Expects(ridx < bounds_.total_size()); - return Ret{data_ + ridx, bounds_.slice()}; - } - - constexpr iterator begin() const noexcept { return iterator{this, true}; } - - constexpr iterator end() const noexcept { return iterator{this, false}; } - - GSL_SUPPRESS(type.1) // NO-FORMAT: attribute - constexpr const_iterator cbegin() const noexcept - { - return const_iterator{reinterpret_cast(this), true}; - } - - constexpr const_iterator cend() const noexcept - { - return const_iterator{reinterpret_cast(this), false}; - } - - constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator{end()}; } - - constexpr reverse_iterator rend() const noexcept { return reverse_iterator{begin()}; } - - constexpr const_reverse_iterator crbegin() const noexcept - { - return const_reverse_iterator{cend()}; - } - - constexpr const_reverse_iterator crend() const noexcept - { - return const_reverse_iterator{cbegin()}; - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator==(const multi_span& other) const - { - return bounds_.size() == other.bounds_.size() && - (data_ == other.data_ || std::equal(this->begin(), this->end(), other.begin())); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator!=(const multi_span& other) const - { - return !(*this == other); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator<(const multi_span& other) const - { - return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator<=(const multi_span& other) const - { - return !(other < *this); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator>(const multi_span& other) - const noexcept - { - return (other < *this); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator>=(const multi_span& other) const - { - return !(*this < other); - } -}; - -// -// Free functions for manipulating spans -// - -// reshape a multi_span into a different dimensionality -// DimCount and Enabled here are workarounds for a bug in MSVC 2015 -template 0), typename = std::enable_if_t> -constexpr auto as_multi_span(SpanType s, Dimensions2... dims) - -> multi_span -{ - static_assert(details::is_multi_span::value, - "Variadic as_multi_span() is for reshaping existing spans."); - using BoundsType = - typename multi_span::bounds_type; - const auto tobounds = details::static_as_multi_span_helper(dims..., details::Sep{}); - details::verifyBoundsReshape(s.bounds(), tobounds); - return {s.data(), tobounds}; -} - -// convert a multi_span to a multi_span -template -multi_span -as_bytes(multi_span s) noexcept -{ - static_assert(std::is_trivial>::value, - "The value_type of multi_span must be a trivial type."); - return {reinterpret_cast(s.data()), s.size_bytes()}; -} - -// convert a multi_span to a multi_span (a writeable byte multi_span) -// this is not currently a portable function that can be relied upon to work -// on all implementations. It should be considered an experimental extension -// to the standard GSL interface. -template -multi_span as_writeable_bytes(multi_span s) noexcept -{ - static_assert(std::is_trivial>::value, - "The value_type of multi_span must be a trivial type."); - return {reinterpret_cast(s.data()), s.size_bytes()}; -} - -// convert a multi_span to a multi_span -// this is not currently a portable function that can be relied upon to work -// on all implementations. It should be considered an experimental extension -// to the standard GSL interface. -template -constexpr auto as_multi_span(multi_span s) -> multi_span< - const U, static_cast( - multi_span::bounds_type::static_size != dynamic_range - ? (static_cast( - multi_span::bounds_type::static_size) / - sizeof(U)) - : dynamic_range)> -{ - using ConstByteSpan = multi_span; - static_assert( - std::is_trivial>::value && - (ConstByteSpan::bounds_type::static_size == dynamic_range || - ConstByteSpan::bounds_type::static_size % narrow_cast(sizeof(U)) == 0), - "Target type must be a trivial type and its size must match the byte array size"); - - Expects((s.size_bytes() % narrow_cast(sizeof(U))) == 0 && - (s.size_bytes() / narrow_cast(sizeof(U))) < PTRDIFF_MAX); - return {reinterpret_cast(s.data()), - s.size_bytes() / narrow_cast(sizeof(U))}; -} - -// convert a multi_span to a multi_span -// this is not currently a portable function that can be relied upon to work -// on all implementations. It should be considered an experimental extension -// to the standard GSL interface. -template -constexpr auto as_multi_span(multi_span s) - -> multi_span( - multi_span::bounds_type::static_size != dynamic_range - ? static_cast( - multi_span::bounds_type::static_size) / - sizeof(U) - : dynamic_range)> -{ - using ByteSpan = multi_span; - static_assert(std::is_trivial>::value && - (ByteSpan::bounds_type::static_size == dynamic_range || - ByteSpan::bounds_type::static_size % sizeof(U) == 0), - "Target type must be a trivial type and its size must match the byte array size"); - - Expects((s.size_bytes() % sizeof(U)) == 0); - return {reinterpret_cast(s.data()), - s.size_bytes() / narrow_cast(sizeof(U))}; -} - -template -constexpr auto as_multi_span(T* const& ptr, dim_t... args) - -> multi_span, Dimensions...> -{ - return {reinterpret_cast*>(ptr), - details::static_as_multi_span_helper>(args..., - details::Sep{})}; -} - -template -constexpr auto as_multi_span(T* arr, std::ptrdiff_t len) -> - typename details::SpanArrayTraits::type -{ - return {reinterpret_cast*>(arr), len}; -} - -template -constexpr auto as_multi_span(T (&arr)[N]) -> - typename details::SpanArrayTraits::type -{ - return {arr}; -} - -template -constexpr multi_span as_multi_span(const std::array& arr) -{ - return {arr}; -} - -template -constexpr multi_span as_multi_span(const std::array&&) = delete; - -template -constexpr multi_span as_multi_span(std::array& arr) -{ - return {arr}; -} - -template -constexpr multi_span as_multi_span(T* begin, T* end) -{ - return {begin, end}; -} - -template -constexpr auto as_multi_span(Cont& arr) -> std::enable_if_t< - !details::is_multi_span>::value, - multi_span, dynamic_range>> -{ - Expects(arr.size() < PTRDIFF_MAX); - return {arr.data(), narrow_cast(arr.size())}; -} - -template -constexpr auto as_multi_span(Cont&& arr) -> std::enable_if_t< - !details::is_multi_span>::value, - multi_span, dynamic_range>> = delete; - -// from basic_string which doesn't have nonconst .data() member like other contiguous containers -template -GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute -constexpr auto as_multi_span(std::basic_string& str) - -> multi_span -{ - Expects(str.size() < PTRDIFF_MAX); - return {&str[0], narrow_cast(str.size())}; -} - -// strided_span is an extension that is not strictly part of the GSL at this time. -// It is kept here while the multidimensional interface is still being defined. -template -class [[deprecated("gsl::strided_span is deprecated because it is not in the C++ Core Guidelines")]] strided_span -{ -public: - using bounds_type = strided_bounds; - using size_type = typename bounds_type::size_type; - using index_type = typename bounds_type::index_type; - using value_type = ValueType; - using const_value_type = std::add_const_t; - using pointer = std::add_pointer_t; - using reference = std::add_lvalue_reference_t; - using iterator = general_span_iterator; - using const_strided_span = strided_span; - using const_iterator = general_span_iterator; - using reverse_iterator = std::reverse_iterator; - using const_reverse_iterator = std::reverse_iterator; - using sliced_type = - std::conditional_t>; - -private: - pointer data_; - bounds_type bounds_; - - friend iterator; - friend const_iterator; - template - friend class strided_span; - -public: - // from raw data - constexpr strided_span(pointer ptr, size_type size, bounds_type bounds) - : data_(ptr), bounds_(std::move(bounds)) - { - Expects((bounds_.size() > 0 && ptr != nullptr) || bounds_.size() == 0); - // Bounds cross data boundaries - Expects(this->bounds().total_size() <= size); - GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: false positive - (void) size; - } - - // from static array of size N - template - constexpr strided_span(value_type (&values)[N], bounds_type bounds) - : strided_span(values, N, std::move(bounds)) - {} - - // from array view - template ::value, - typename = std::enable_if_t> - constexpr strided_span(multi_span av, bounds_type bounds) - : strided_span(av.data(), av.bounds().total_size(), std::move(bounds)) - {} - - // convertible - template ::value>> - constexpr strided_span(const strided_span& other) - : data_(other.data_), bounds_(other.bounds_) - {} - - // convert from bytes - template - constexpr strided_span< - typename std::enable_if::value, OtherValueType>::type, - Rank> - as_strided_span() const - { - static_assert((sizeof(OtherValueType) >= sizeof(value_type)) && - (sizeof(OtherValueType) % sizeof(value_type) == 0), - "OtherValueType should have a size to contain a multiple of ValueTypes"); - auto d = narrow_cast(sizeof(OtherValueType) / sizeof(value_type)); - - const size_type size = this->bounds().total_size() / d; - - GSL_SUPPRESS(type.3) // NO-FORMAT: attribute - return {const_cast(reinterpret_cast(this->data())), - size, - bounds_type{resize_extent(this->bounds().index_bounds(), d), - resize_stride(this->bounds().strides(), d)}}; - } - - constexpr strided_span section(index_type origin, index_type extents) const - { - const size_type size = this->bounds().total_size() - this->bounds().linearize(origin); - return {&this->operator[](origin), size, - bounds_type{extents, details::make_stride(bounds())}}; - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - constexpr reference operator[](const index_type& idx) const - { - return data_[bounds_.linearize(idx)]; - } - - template 1), typename Ret = std::enable_if_t> - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - constexpr Ret operator[](size_type idx) const - { - Expects(idx < bounds_.size()); // index is out of bounds of the array - const size_type ridx = idx * bounds_.stride(); - - // index is out of bounds of the underlying data - Expects(ridx < bounds_.total_size()); - return {data_ + ridx, bounds_.slice().total_size(), bounds_.slice()}; - } - - constexpr bounds_type bounds() const noexcept { return bounds_; } - - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < Rank, - "dimension should be less than Rank (dimension count starts from 0)"); - return bounds_.template extent(); - } - - constexpr size_type size() const noexcept { return bounds_.size(); } - - constexpr pointer data() const noexcept { return data_; } - - constexpr bool empty() const noexcept { return this->size() == 0; } - - constexpr explicit operator bool() const noexcept { return data_ != nullptr; } - - constexpr iterator begin() const { return iterator{this, true}; } - - constexpr iterator end() const { return iterator{this, false}; } - - constexpr const_iterator cbegin() const - { - return const_iterator{reinterpret_cast(this), true}; - } - - constexpr const_iterator cend() const - { - return const_iterator{reinterpret_cast(this), false}; - } - - constexpr reverse_iterator rbegin() const { return reverse_iterator{end()}; } - - constexpr reverse_iterator rend() const { return reverse_iterator{begin()}; } - - constexpr const_reverse_iterator crbegin() const { return const_reverse_iterator{cend()}; } - - constexpr const_reverse_iterator crend() const { return const_reverse_iterator{cbegin()}; } - - template , - std::remove_cv_t>::value>> - constexpr bool operator==(const strided_span& other) const - { - return bounds_.size() == other.bounds_.size() && - (data_ == other.data_ || std::equal(this->begin(), this->end(), other.begin())); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator!=(const strided_span& other) const - { - return !(*this == other); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator<(const strided_span& other) const - { - return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator<=(const strided_span& other) const - { - return !(other < *this); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator>(const strided_span& other) const - { - return (other < *this); - } - - template , - std::remove_cv_t>::value>> - constexpr bool operator>=(const strided_span& other) const - { - return !(*this < other); - } - -private: - static index_type resize_extent(const index_type& extent, std::ptrdiff_t d) - { - // The last dimension of the array needs to contain a multiple of new type elements - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - Expects(extent[Rank - 1] >= d && (extent[Rank - 1] % d == 0)); - - index_type ret = extent; - ret[Rank - 1] /= d; - - return ret; - } - - template > - static index_type resize_stride(const index_type& strides, std::ptrdiff_t, void* = nullptr) - { - // Only strided arrays with regular strides can be resized - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - Expects(strides[Rank - 1] == 1); - - return strides; - } - - template 1), typename = std::enable_if_t> - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - static index_type resize_stride(const index_type& strides, std::ptrdiff_t d) - { - // Only strided arrays with regular strides can be resized - Expects(strides[Rank - 1] == 1); - // The strides must have contiguous chunks of - // memory that can contain a multiple of new type elements - Expects(strides[Rank - 2] >= d && (strides[Rank - 2] % d == 0)); - - for (std::size_t i = Rank - 1; i > 0; --i) - { - // Only strided arrays with regular strides can be resized - Expects((strides[i - 1] >= strides[i]) && (strides[i - 1] % strides[i] == 0)); - } - - index_type ret = strides / d; - ret[Rank - 1] = 1; - - return ret; - } -}; - -template -class [[deprecated]] contiguous_span_iterator { -public: - using iterator_category = std::random_access_iterator_tag; - using value_type = typename Span::value_type; - using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; - -private: - template - friend class multi_span; - - pointer data_; - const Span* m_validator; - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - void validateThis() const - { - // iterator is out of range of the array - Expects(data_ >= m_validator->data_ && data_ < m_validator->data_ + m_validator->size()); - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - contiguous_span_iterator(const Span* container, bool isbegin) - : data_(isbegin ? container->data_ : container->data_ + container->size()) - , m_validator(container) - {} - -public: - reference operator*() const - { - validateThis(); - return *data_; - } - pointer operator->() const - { - validateThis(); - return data_; - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - contiguous_span_iterator& operator++() noexcept - { - ++data_; - return *this; - } - contiguous_span_iterator operator++(int) noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute - contiguous_span_iterator& operator--() noexcept - { - --data_; - return *this; - } - contiguous_span_iterator operator--(int) noexcept - { - auto ret = *this; - --(*this); - return ret; - } - contiguous_span_iterator operator+(difference_type n) const noexcept - { - contiguous_span_iterator ret{*this}; - return ret += n; - } - contiguous_span_iterator& operator+=(difference_type n) noexcept - { - data_ += n; - return *this; - } - contiguous_span_iterator operator-(difference_type n) const noexcept - { - contiguous_span_iterator ret{*this}; - return ret -= n; - } - - contiguous_span_iterator& operator-=(difference_type n) { return *this += -n; } - difference_type operator-(const contiguous_span_iterator& rhs) const - { - Expects(m_validator == rhs.m_validator); - return data_ - rhs.data_; - } - reference operator[](difference_type n) const { return *(*this + n); } - bool operator==(const contiguous_span_iterator& rhs) const - { - Expects(m_validator == rhs.m_validator); - return data_ == rhs.data_; - } - - bool operator!=(const contiguous_span_iterator& rhs) const { return !(*this == rhs); } - - bool operator<(const contiguous_span_iterator& rhs) const - { - Expects(m_validator == rhs.m_validator); - return data_ < rhs.data_; - } - - bool operator<=(const contiguous_span_iterator& rhs) const { return !(rhs < *this); } - bool operator>(const contiguous_span_iterator& rhs) const { return rhs < *this; } - bool operator>=(const contiguous_span_iterator& rhs) const { return !(rhs > *this); } - - void swap(contiguous_span_iterator & rhs) noexcept - { - std::swap(data_, rhs.data_); - std::swap(m_validator, rhs.m_validator); - } -}; - -template -contiguous_span_iterator operator+(typename contiguous_span_iterator::difference_type n, - const contiguous_span_iterator& rhs) noexcept -{ - return rhs + n; -} - -template -class [[deprecated]] general_span_iterator { -public: - using iterator_category = std::random_access_iterator_tag; - using value_type = typename Span::value_type; - using difference_type = std::ptrdiff_t; - using pointer = value_type*; - using reference = value_type&; - -private: - template - friend class strided_span; - - const Span* m_container; - typename Span::bounds_type::iterator m_itr; - general_span_iterator(const Span* container, bool isbegin) - : m_container(container) - , m_itr(isbegin ? m_container->bounds().begin() : m_container->bounds().end()) - {} - -public: - reference operator*() noexcept { return (*m_container)[*m_itr]; } - pointer operator->() noexcept { return &(*m_container)[*m_itr]; } - general_span_iterator& operator++() noexcept - { - ++m_itr; - return *this; - } - general_span_iterator operator++(int) noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - general_span_iterator& operator--() noexcept - { - --m_itr; - return *this; - } - general_span_iterator operator--(int) noexcept - { - auto ret = *this; - --(*this); - return ret; - } - general_span_iterator operator+(difference_type n) const noexcept - { - general_span_iterator ret{*this}; - return ret += n; - } - general_span_iterator& operator+=(difference_type n) noexcept - { - m_itr += n; - return *this; - } - general_span_iterator operator-(difference_type n) const noexcept - { - general_span_iterator ret{*this}; - return ret -= n; - } - general_span_iterator& operator-=(difference_type n) noexcept { return *this += -n; } - difference_type operator-(const general_span_iterator& rhs) const - { - Expects(m_container == rhs.m_container); - return m_itr - rhs.m_itr; - } - - GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute - value_type operator[](difference_type n) const { return (*m_container)[m_itr[n]]; } - - bool operator==(const general_span_iterator& rhs) const - { - Expects(m_container == rhs.m_container); - return m_itr == rhs.m_itr; - } - bool operator!=(const general_span_iterator& rhs) const { return !(*this == rhs); } - bool operator<(const general_span_iterator& rhs) const - { - Expects(m_container == rhs.m_container); - return m_itr < rhs.m_itr; - } - bool operator<=(const general_span_iterator& rhs) const { return !(rhs < *this); } - bool operator>(const general_span_iterator& rhs) const { return rhs < *this; } - bool operator>=(const general_span_iterator& rhs) const { return !(rhs > *this); } - void swap(general_span_iterator & rhs) noexcept - { - std::swap(m_itr, rhs.m_itr); - std::swap(m_container, rhs.m_container); - } -}; - -template -general_span_iterator operator+(typename general_span_iterator::difference_type n, - const general_span_iterator& rhs) noexcept -{ - return rhs + n; -} - -} // namespace gsl - -#if defined(_MSC_VER) && !defined(__clang__) -#if _MSC_VER < 1910 - -#undef constexpr -#pragma pop_macro("constexpr") -#endif // _MSC_VER < 1910 - -#pragma warning(pop) - -#endif // _MSC_VER - -#if defined(__GNUC__) && __GNUC__ > 6 -#pragma GCC diagnostic pop -#endif // __GNUC__ > 6 - -#if defined(__GNUC__) || defined(__clang__) -#pragma GCC diagnostic pop -#endif - -#endif // GSL_MULTI_SPAN_H diff --git a/gsl/narrow b/gsl/narrow new file mode 100644 index 0000000..662999e --- /dev/null +++ b/gsl/narrow @@ -0,0 +1,83 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// 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_NARROW_H +#define GSL_NARROW_H +#include "assert" // for GSL_SUPPRESS +#include "util" // for narrow_cast +#include // for std::exception +namespace gsl +{ +struct narrowing_error : public std::exception +{ + const char* what() const noexcept override { return "narrowing_error"; } +}; + +// narrow() : a checked version of narrow_cast() that throws if the cast changed the value +template ::value>::type* = nullptr> +// clang-format off +GSL_SUPPRESS(type.1) // NO-FORMAT: attribute +GSL_SUPPRESS(f.6) // NO-FORMAT: attribute // TODO: MSVC /analyze does not recognise noexcept(false) +GSL_SUPPRESS(es.46) // NO-FORMAT: attribute // The warning suggests that a floating->unsigned conversion can occur + // in the static_cast below, and that gsl::narrow should be used instead. + // Suppress this warning, since gsl::narrow is defined in terms of + // static_cast + // clang-format on + constexpr T narrow(U u) noexcept(false) +{ + constexpr const bool is_different_signedness = + (std::is_signed::value != std::is_signed::value); + +GSL_SUPPRESS(es.103) // NO-FORMAT: attribute // don't overflow +GSL_SUPPRESS(es.104) // NO-FORMAT: attribute // don't underflow +GSL_SUPPRESS(p.2) // NO-FORMAT: attribute // don't rely on undefined behavior + const T t = narrow_cast(u); // While this is technically undefined behavior in some cases (i.e., if the source value is of floating-point type + // and cannot fit into the destination integral type), the resultant behavior is benign on the platforms + // that we target (i.e., no hardware trap representations are hit). + +#if defined(__clang__) || defined(__GNUC__) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wfloat-equal" +#endif + if (static_cast(t) != u || (is_different_signedness && ((t < T{}) != (u < U{})))) + { + throw narrowing_error{}; + } +#if defined(__clang__) || defined(__GNUC__) + #pragma GCC diagnostic pop +#endif + + return t; +} + +template ::value>::type* = nullptr> +// clang-format off +GSL_SUPPRESS(type.1) // NO-FORMAT: attribute +GSL_SUPPRESS(f.6) // NO-FORMAT: attribute // TODO: MSVC /analyze does not recognise noexcept(false) + // clang-format on + constexpr T narrow(U u) noexcept(false) +{ + const T t = narrow_cast(u); + + if (static_cast(t) != u) + { + throw narrowing_error{}; + } + + return t; +} +} // namespace gsl +#endif // GSL_NARROW_H diff --git a/gsl/pointers b/gsl/pointers index 3893ffb..a0a77ac 100644 --- a/gsl/pointers +++ b/gsl/pointers @@ -17,33 +17,48 @@ #ifndef GSL_POINTERS_H #define GSL_POINTERS_H -#include "gsl_assert" // for Ensures, Expects +#include "assert" // for Ensures, Expects #include // for forward -#include // for ptrdiff_t, nullptr_t, ostream, size_t +#include // for ptrdiff_t, nullptr_t, size_t #include // for shared_ptr, unique_ptr #include // for hash #include // for enable_if_t, is_convertible, is_assignable -#if defined(_MSC_VER) && _MSC_VER < 1910 && !defined(__clang__) -#pragma push_macro("constexpr") -#define constexpr /*constexpr*/ - -#endif // defined(_MSC_VER) && _MSC_VER < 1910 +#if !defined(GSL_NO_IOSTREAMS) +#include // for ostream +#endif // !defined(GSL_NO_IOSTREAMS) namespace gsl { +namespace details +{ + template + struct is_comparable_to_nullptr : std::false_type + { + }; + + template + struct is_comparable_to_nullptr< + T, + std::enable_if_t() != nullptr), bool>::value>> + : std::true_type + { + }; +} // namespace details + // // GSL.owner: ownership pointers // -using std::unique_ptr; using std::shared_ptr; +using std::unique_ptr; // // owner // -// owner is designed as a bridge for code that must deal directly with owning pointers for some reason +// owner is designed as a bridge for code that must deal directly with owning pointers for some +// reason // // T must be a pointer type // - disallow construction from any type other than pointer type @@ -69,7 +84,7 @@ template class not_null { public: - static_assert(std::is_assignable::value, "T cannot be assigned nullptr."); + static_assert(details::is_comparable_to_nullptr::value, "T cannot be compared to nullptr."); template ::value>> constexpr not_null(U&& u) : ptr_(std::forward(u)) @@ -78,27 +93,25 @@ public: } template ::value>> - constexpr not_null(T u) : ptr_(u) + constexpr not_null(T u) : ptr_(std::move(u)) { Expects(ptr_ != nullptr); } template ::value>> constexpr not_null(const not_null& other) : not_null(other.get()) - { - } + {} not_null(const not_null& other) = default; not_null& operator=(const not_null& other) = default; - - constexpr T get() const + constexpr std::conditional_t::value, T, const T&> get() const { Ensures(ptr_ != nullptr); return ptr_; } constexpr operator T() const { return get(); } - constexpr T operator->() const { return get(); } + constexpr decltype(auto) operator->() const { return get(); } constexpr decltype(auto) operator*() const { return *get(); } // prevents compilation when someone attempts to assign a null pointer constant @@ -119,49 +132,64 @@ private: }; template -auto make_not_null(T&& t) { +auto make_not_null(T&& t) noexcept +{ return not_null>>{std::forward(t)}; } +#if !defined(GSL_NO_IOSTREAMS) template std::ostream& operator<<(std::ostream& os, const not_null& val) { os << val.get(); return os; } +#endif // !defined(GSL_NO_IOSTREAMS) template -auto operator==(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() == rhs.get()) +auto operator==(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() == rhs.get())) + -> decltype(lhs.get() == rhs.get()) { return lhs.get() == rhs.get(); } template -auto operator!=(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() != rhs.get()) +auto operator!=(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() != rhs.get())) + -> decltype(lhs.get() != rhs.get()) { return lhs.get() != rhs.get(); } template -auto operator<(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() < rhs.get()) +auto operator<(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() < rhs.get())) + -> decltype(lhs.get() < rhs.get()) { return lhs.get() < rhs.get(); } template -auto operator<=(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() <= rhs.get()) +auto operator<=(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() <= rhs.get())) + -> decltype(lhs.get() <= rhs.get()) { return lhs.get() <= rhs.get(); } template -auto operator>(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() > rhs.get()) +auto operator>(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() > rhs.get())) + -> decltype(lhs.get() > rhs.get()) { return lhs.get() > rhs.get(); } template -auto operator>=(const not_null& lhs, const not_null& rhs) -> decltype(lhs.get() >= rhs.get()) +auto operator>=(const not_null& lhs, + const not_null& rhs) noexcept(noexcept(lhs.get() >= rhs.get())) + -> decltype(lhs.get() >= rhs.get()) { return lhs.get() >= rhs.get(); } @@ -183,7 +211,7 @@ namespace std template struct hash> { - std::size_t operator()(const gsl::not_null& value) const { return hash{}(value); } + std::size_t operator()(const gsl::not_null& value) const { return hash{}(value.get()); } }; } // namespace std @@ -209,28 +237,23 @@ namespace gsl // - remove unnecessary asserts // template -class strict_not_null: public not_null +class strict_not_null : public not_null { public: - template ::value>> - constexpr explicit strict_not_null(U&& u) : - not_null(std::forward(u)) + constexpr explicit strict_not_null(U&& u) : not_null(std::forward(u)) {} template ::value>> - constexpr explicit strict_not_null(T u) : - not_null(u) + constexpr explicit strict_not_null(T u) : not_null(u) {} template ::value>> - constexpr strict_not_null(const not_null& other) : - not_null(other) + constexpr strict_not_null(const not_null& other) : not_null(other) {} template ::value>> - constexpr strict_not_null(const strict_not_null& other) : - not_null(other) + constexpr strict_not_null(const strict_not_null& other) : not_null(other) {} strict_not_null(strict_not_null&& other) = default; @@ -267,15 +290,18 @@ template strict_not_null operator+(std::ptrdiff_t, const strict_not_null&) = delete; template -auto make_strict_not_null(T&& t) { +auto make_strict_not_null(T&& t) noexcept +{ return strict_not_null>>{std::forward(t)}; } -#if ( defined(__cpp_deduction_guides) && (__cpp_deduction_guides >= 201611L) ) +#if (defined(__cpp_deduction_guides) && (__cpp_deduction_guides >= 201611L)) // deduction guides to prevent the ctad-maybe-unsupported warning -template not_null(T) -> not_null; -template strict_not_null(T) -> strict_not_null; +template +not_null(T) -> not_null; +template +strict_not_null(T) -> strict_not_null; #endif // ( defined(__cpp_deduction_guides) && (__cpp_deduction_guides >= 201611L) ) @@ -286,16 +312,12 @@ namespace std template struct hash> { - std::size_t operator()(const gsl::strict_not_null& value) const { return hash{}(value); } + std::size_t operator()(const gsl::strict_not_null& value) const + { + return hash{}(value.get()); + } }; } // namespace std -#if defined(_MSC_VER) && _MSC_VER < 1910 && !defined(__clang__) - -#undef constexpr -#pragma pop_macro("constexpr") - -#endif // defined(_MSC_VER) && _MSC_VER < 1910 && !defined(__clang__) - #endif // GSL_POINTERS_H diff --git a/gsl/span b/gsl/span index 6371349..4d5bc7c 100644 --- a/gsl/span +++ b/gsl/span @@ -17,14 +17,21 @@ #ifndef GSL_SPAN_H #define GSL_SPAN_H -#include "gsl_assert" // for Expects -#include "gsl_byte" // for byte +#include "assert" // for Expects +#include "byte" // for byte +#include "span_ext" // for span specialization of gsl::at and other span-related extensions +#include "util" // for narrow_cast #include // for array #include // for ptrdiff_t, size_t, nullptr_t #include // for reverse_iterator, distance, random_access_... +#include // for pointer_traits #include // for enable_if_t, declval, is_convertible, inte... +#if defined(__has_include) && __has_include() +#include +#endif + #if defined(_MSC_VER) && !defined(__clang__) #pragma warning(push) @@ -59,12 +66,6 @@ namespace gsl { -// [views.constants], constants -constexpr const std::size_t dynamic_extent = static_cast(-1); - -template -class span; - // implementation details namespace details { @@ -100,7 +101,7 @@ namespace details template struct is_allowed_extent_conversion - : std::integral_constant + : std::integral_constant { }; @@ -114,6 +115,9 @@ namespace details class span_iterator { public: +#if defined(__cpp_lib_ranges) || (defined(_MSVC_STL_VERSION) && defined(__cpp_lib_concepts)) + using iterator_concept = std::contiguous_iterator_tag; +#endif // __cpp_lib_ranges using iterator_category = std::random_access_iterator_tag; using value_type = std::remove_cv_t; using difference_type = std::ptrdiff_t; @@ -151,6 +155,9 @@ namespace details { Expects(begin_ && current_ && end_); Expects(current_ < end_); + // clang-format off + GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute + // clang-format on ++current_; return *this; } @@ -182,6 +189,9 @@ namespace details if (n != 0) Expects(begin_ && current_ && end_); if (n > 0) Expects(end_ - current_ >= n); if (n < 0) Expects(current_ - begin_ >= -n); + // clang-format off + GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute + // clang-format on current_ += n; return *this; } @@ -327,8 +337,24 @@ namespace details pointer begin_ = nullptr; pointer end_ = nullptr; pointer current_ = nullptr; + + template + friend struct std::pointer_traits; }; +}} // namespace gsl::details + +template +struct std::pointer_traits<::gsl::details::span_iterator> { + using pointer = ::gsl::details::span_iterator; + using element_type = Type; + using difference_type = ptrdiff_t; + + static constexpr element_type* to_address(const pointer i) noexcept { + return i.current_; + } +}; +namespace gsl { namespace details { template class extent_type { @@ -421,32 +447,32 @@ public: constexpr span() noexcept : storage_(nullptr, details::extent_type<0>()) {} - template = 0> + template = 0> constexpr explicit span(pointer ptr, size_type count) noexcept : storage_(ptr, count) { Expects(count == Extent); } - template = 0> + template = 0> constexpr span(pointer ptr, size_type count) noexcept : storage_(ptr, count) {} - template = 0> + template = 0> constexpr explicit span(pointer firstElem, pointer lastElem) noexcept - : storage_(firstElem, static_cast(lastElem - firstElem)) + : storage_(firstElem, narrow_cast(lastElem - firstElem)) { Expects(lastElem - firstElem == static_cast(Extent)); } - template = 0> + template = 0> constexpr span(pointer firstElem, pointer lastElem) noexcept - : storage_(firstElem, static_cast(lastElem - firstElem)) + : storage_(firstElem, narrow_cast(lastElem - firstElem)) {} template ::value, int> = 0> constexpr span(element_type (&arr)[N]) noexcept - : storage_(KnownNotNull{arr + 0}, details::extent_type()) + : storage_(KnownNotNull{arr}, details::extent_type()) {} template < @@ -471,66 +497,70 @@ public: // requirement on Container to be a contiguous sequence container. template ::value && !details::is_std_array::value && - std::is_pointer().data())>::value && - std::is_convertible< - std::remove_pointer_t().data())> (*)[], - element_type (*)[]>::value, int> = 0> + MyExtent != dynamic_extent && !details::is_span::value && + !details::is_std_array::value && + std::is_pointer().data())>::value && + std::is_convertible< + std::remove_pointer_t().data())> (*)[], + element_type (*)[]>::value, + int> = 0> constexpr explicit span(Container& cont) noexcept : span(cont.data(), cont.size()) {} template ::value && !details::is_std_array::value && - std::is_pointer().data())>::value && - std::is_convertible< - std::remove_pointer_t().data())> (*)[], - element_type (*)[]>::value, int> = 0> + MyExtent == dynamic_extent && !details::is_span::value && + !details::is_std_array::value && + std::is_pointer().data())>::value && + std::is_convertible< + std::remove_pointer_t().data())> (*)[], + element_type (*)[]>::value, + int> = 0> constexpr span(Container& cont) noexcept : span(cont.data(), cont.size()) {} - template ::value && !details::is_span::value && - !details::is_std_array::value && - std::is_pointer().data())>::value && - std::is_convertible().data())> (*)[], - element_type (*)[]>::value, int> = 0> + template < + std::size_t MyExtent = Extent, class Container, + std::enable_if_t< + MyExtent != dynamic_extent && std::is_const::value && + !details::is_span::value && !details::is_std_array::value && + std::is_pointer().data())>::value && + std::is_convertible< + std::remove_pointer_t().data())> (*)[], + element_type (*)[]>::value, + int> = 0> constexpr explicit span(const Container& cont) noexcept : span(cont.data(), cont.size()) {} - template ::value && !details::is_span::value && - !details::is_std_array::value && - std::is_pointer().data())>::value && - std::is_convertible().data())> (*)[], - element_type (*)[]>::value, int> = 0> + template < + std::size_t MyExtent = Extent, class Container, + std::enable_if_t< + MyExtent == dynamic_extent && std::is_const::value && + !details::is_span::value && !details::is_std_array::value && + std::is_pointer().data())>::value && + std::is_convertible< + std::remove_pointer_t().data())> (*)[], + element_type (*)[]>::value, + int> = 0> constexpr span(const Container& cont) noexcept : span(cont.data(), cont.size()) {} constexpr span(const span& other) noexcept = default; - template < - class OtherElementType, std::size_t OtherExtent, std::size_t MyExtent = Extent, - std::enable_if_t< - (MyExtent == dynamic_extent || MyExtent == OtherExtent) && - details::is_allowed_element_type_conversion::value, int> = 0> + template ::value, + int> = 0> constexpr span(const span& other) noexcept : storage_(other.data(), details::extent_type(other.size())) {} - template < - class OtherElementType, std::size_t OtherExtent, std::size_t MyExtent = Extent, - std::enable_if_t< - MyExtent != dynamic_extent && OtherExtent == dynamic_extent && - details::is_allowed_element_type_conversion::value, int> = 0> + template ::value, + int> = 0> constexpr explicit span(const span& other) noexcept : storage_(other.data(), details::extent_type(other.size())) {} @@ -564,7 +594,8 @@ public: typename details::calculate_subspan_type::type { Expects((size() >= Offset) && (Count == dynamic_extent || (Count <= size() - Offset))); - using type = typename details::calculate_subspan_type::type; + using type = + typename details::calculate_subspan_type::type; return type{data() + Offset, Count == dynamic_extent ? size() - Offset : Count}; } @@ -580,9 +611,8 @@ public: return make_subspan(size() - count, dynamic_extent, subspan_selector{}); } - constexpr span subspan(size_type offset, - size_type count = dynamic_extent) const - noexcept + constexpr span + subspan(size_type offset, size_type count = dynamic_extent) const noexcept { return make_subspan(offset, count, subspan_selector{}); } @@ -676,14 +706,11 @@ private: template constexpr storage_type(KnownNotNull data, OtherExtentType ext) : ExtentType(ext), data_(data.p) - { - Expects(ExtentType::size() != dynamic_extent); - } + {} template constexpr storage_type(pointer data, OtherExtentType ext) : ExtentType(ext), data_(data) { - Expects(ExtentType::size() != dynamic_extent); Expects(data || ExtentType::size() == 0); } @@ -705,9 +732,8 @@ private: }; template - constexpr span make_subspan(size_type offset, size_type count, - subspan_selector) const - noexcept + constexpr span + make_subspan(size_type offset, size_type count, subspan_selector) const noexcept { const span tmp(*this); return tmp.subspan(offset, count); @@ -732,21 +758,21 @@ private: // Deduction Guides template -span(Type (&)[Extent])->span; +span(Type (&)[Extent]) -> span; template -span(std::array&)->span; +span(std::array&) -> span; template -span(const std::array&)->span; +span(const std::array&) -> span; template ().data())>> -span(Container&)->span; + class Element = std::remove_pointer_t().data())>> +span(Container&) -> span; template ().data())>> -span(const Container&)->span; + class Element = std::remove_pointer_t().data())>> +span(const Container&) -> span; #endif // ( defined(__cpp_deduction_guides) && (__cpp_deduction_guides >= 201611L) ) diff --git a/gsl/span_ext b/gsl/span_ext index 750b502..fd4d1ce 100644 --- a/gsl/span_ext +++ b/gsl/span_ext @@ -27,17 +27,29 @@ // /////////////////////////////////////////////////////////////////////////////// +#include "assert" // GSL_KERNEL_MODE +#include "util" // for narrow_cast, narrow -#include "gsl_util" // for narrow_cast, narrow -#include "span" // for span +#include // for ptrdiff_t, size_t +#include +#ifndef GSL_KERNEL_MODE #include // for lexicographical_compare -#include // for ptrdiff_t, size_t -#include +#endif // GSL_KERNEL_MODE namespace gsl { +// [span.views.constants], constants +constexpr const std::size_t dynamic_extent = narrow_cast(-1); + +template +class span; + +// std::equal and std::lexicographical_compare are not /kernel compatible +// so all comparison operators must be removed for kernel mode. +#ifndef GSL_KERNEL_MODE + // [span.comparison], span comparison operators template constexpr bool operator==(span l, span r) @@ -75,6 +87,8 @@ constexpr bool operator>=(span l, span return !(l < r); } +#endif // GSL_KERNEL_MODE + // // make_span() - Utility functions for creating spans // diff --git a/gsl/string_span b/gsl/string_span index 48a65e7..7d6006c 100644 --- a/gsl/string_span +++ b/gsl/string_span @@ -17,16 +17,16 @@ #ifndef GSL_STRING_SPAN_H #define GSL_STRING_SPAN_H -#include "gsl_assert" // for Ensures, Expects -#include "gsl_util" // for narrow_cast -#include "span_ext" // for operator!=, operator==, dynamic_extent +#include "assert" // for Ensures, Expects +#include "span_ext" // for operator!=, operator==, dynamic_extent +#include "util" // for narrow_cast #include // for equal, lexicographical_compare #include // for array #include // for size_t, nullptr_t #include // for PTRDIFF_MAX #include -#include // for basic_string, allocator, char_traits +#include // for basic_string, allocator, char_traits #include // for declval, is_convertible, enable_if_t, add_... #if defined(_MSC_VER) && !defined(__clang__) @@ -35,8 +35,13 @@ // Turn MSVC /analyze rules that generate too much noise. TODO: fix in the tool. #pragma warning(disable : 26446) // TODO: bug in parser - attributes and templates #pragma warning(disable : 26481) // TODO: suppress does not work inside templates sometimes +#pragma warning(disable : 4996) // use of functions & classes marked [[deprecated]] +#endif // _MSC_VER -#endif // _MSC_VER +#if defined(__GNUC__) || defined(__clang__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wdeprecated-declarations" +#endif namespace gsl { @@ -54,34 +59,28 @@ namespace gsl template using basic_zstring = CharT*; -template -using czstring = basic_zstring; +using czstring = basic_zstring; -template -using cwzstring = basic_zstring; +using cwzstring = basic_zstring; -template -using cu16zstring = basic_zstring; +using cu16zstring = basic_zstring; -template -using cu32zstring = basic_zstring; +using cu32zstring = basic_zstring; -template -using zstring = basic_zstring; +using zstring = basic_zstring; -template -using wzstring = basic_zstring; +using wzstring = basic_zstring; -template -using u16zstring = basic_zstring; +using u16zstring = basic_zstring; -template -using u32zstring = basic_zstring; +using u32zstring = basic_zstring; namespace details { template - std::size_t string_length(const CharT* str, std::size_t n) + [[deprecated("string_span was removed from the C++ Core Guidelines. For more information, see " + "isocpp/CppCoreGuidelines PR#1680")]] constexpr std::size_t + string_length(const CharT* str, std::size_t n) { if (str == nullptr || n == dynamic_extent) return 0; @@ -103,73 +102,86 @@ namespace details // Will fail-fast if sentinel cannot be found before max elements are examined. // template -span ensure_sentinel(T* seq, - std::size_t max = static_cast(-1)) +[[deprecated("string_span was removed from the C++ Core Guidelines. For more information, see " + "isocpp/CppCoreGuidelines PR#1680")]] constexpr span +ensure_sentinel(T* seq, std::size_t max = static_cast(-1)) { Ensures(seq != nullptr); - GSL_SUPPRESS( - f.23) // NO-FORMAT: attribute // TODO: false positive // TODO: suppress does not work + // clang-format off + GSL_SUPPRESS(f.23) // TODO: false positive // TODO: suppress does not work + // clang-format on auto cur = seq; Ensures(cur != nullptr); // workaround for removing the warning - GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute // TODO: suppress does not work + // clang-format off + GSL_SUPPRESS(bounds.1) // TODO: suppress does not work + // clang-format on while (static_cast(cur - seq) < max && *cur != Sentinel) ++cur; Ensures(*cur == Sentinel); return {seq, static_cast(cur - seq)}; } // -// ensure_z - creates a span for a zero terminated strings. -// Will fail fast if a null-terminator cannot be found before -// the limit of size_type. +// ensure_z - creates a span for a zero terminated strings. The span will not contain the zero +// termination. Will fail fast if a null-terminator cannot be found before the limit of size_type. // template -span ensure_z(CharT* const& sz, - std::size_t max = static_cast(-1)) +[[deprecated("string_span was removed from the C++ Core Guidelines. For more information, see " + "isocpp/CppCoreGuidelines PR#1680")]] constexpr span +ensure_z(CharT* const& sz, std::size_t max = static_cast(-1)) { return ensure_sentinel(sz, max); } template -span ensure_z(CharT (&sz)[N]) +constexpr span ensure_z(CharT (&sz)[N]) { return ensure_z(&sz[0], N); } template -span::type, dynamic_extent> +[[deprecated( + "string_span was removed from the C++ Core Guidelines. For more information, see " + "isocpp/CppCoreGuidelines PR#1680")]] constexpr span::type, + dynamic_extent> ensure_z(Cont& cont) { return ensure_z(cont.data(), cont.size()); } template -class basic_string_span; +class [[deprecated("string_span was removed from the C++ Core Guidelines. For more information, " + "see isocpp/CppCoreGuidelines PR#1680")]] basic_string_span; namespace details { template - struct is_basic_string_span_oracle : std::false_type - { - }; + struct [[deprecated( + "string_span was removed from the C++ Core Guidelines. For more information, " + "see isocpp/CppCoreGuidelines PR#1680")]] is_basic_string_span_oracle : std::false_type{}; template - struct is_basic_string_span_oracle> : std::true_type - { - }; + struct [[deprecated( + "string_span was removed from the C++ Core Guidelines. For more information, see " + "isocpp/CppCoreGuidelines PR#1680")]] is_basic_string_span_oracle> + : std::true_type{}; template - struct is_basic_string_span : is_basic_string_span_oracle> - { - }; + struct [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] is_basic_string_span + : is_basic_string_span_oracle>{}; } // namespace details // // string_span and relatives // template -class basic_string_span +class [[deprecated("string_span was removed from the C++ Core Guidelines. For more information, " + "see isocpp/CppCoreGuidelines PR#1680")]] basic_string_span { public: using element_type = CharT; @@ -198,11 +210,11 @@ public: // From static arrays - if 0-terminated, remove 0 from the view // All other containers allow 0s within the length, so we do not remove them template - constexpr basic_string_span(element_type (&arr)[N]) : span_(remove_z(arr)) + constexpr basic_string_span(element_type(&arr)[N]) : span_(remove_z(arr)) {} template > - constexpr basic_string_span(std::array& arr) noexcept : span_(arr) + constexpr basic_string_span(std::array & arr) noexcept : span_(arr) {} template > @@ -211,8 +223,8 @@ public: // Container signature should work for basic_string after C++17 version exists template - // GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute // TODO: parser bug - constexpr basic_string_span(std::basic_string& str) + // GSL_SUPPRESS(bounds.4) // TODO: parser bug + constexpr basic_string_span(std::basic_string & str) : span_(&str[0], str.length()) {} @@ -228,7 +240,7 @@ public: std::is_convertible::value && std::is_convertible().data())>::value>> - constexpr basic_string_span(Container& cont) : span_(cont) + constexpr basic_string_span(Container & cont) : span_(cont) {} template ()}; } - constexpr basic_string_span - subspan(size_type offset, size_type count = dynamic_extent) const + constexpr basic_string_span subspan( + size_type offset, size_type count = dynamic_extent) const { return {span_.subspan(offset, count)}; } @@ -301,13 +313,13 @@ public: constexpr reverse_iterator rend() const noexcept { return span_.rend(); } private: - static impl_type remove_z(pointer const& sz, std::size_t max) + static constexpr impl_type remove_z(pointer const& sz, std::size_t max) { return impl_type(sz, details::string_length(sz, max)); } template - static impl_type remove_z(element_type (&sz)[N]) + static constexpr impl_type remove_z(element_type(&sz)[N]) { return remove_z(&sz[0], N); } @@ -316,35 +328,51 @@ private: }; template -using string_span = basic_string_span; +using string_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using cstring_span = basic_string_span; +using cstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using wstring_span = basic_string_span; +using wstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using cwstring_span = basic_string_span; +using cwstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using u16string_span = basic_string_span; +using u16string_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using cu16string_span = basic_string_span; +using cu16string_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using u32string_span = basic_string_span; +using u32string_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; template -using cu32string_span = basic_string_span; +using cu32string_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_string_span; // // to_string() allow (explicit) conversions from string_span to string // template -std::basic_string::type> +constexpr std::basic_string::type> to_string(basic_string_span view) { return {view.data(), narrow_cast(view.length())}; @@ -352,32 +380,38 @@ to_string(basic_string_span view) template , typename Allocator = std::allocator, typename gCharT, std::size_t Extent> -std::basic_string to_basic_string(basic_string_span view) +constexpr std::basic_string +to_basic_string(basic_string_span view) { return {view.data(), narrow_cast(view.length())}; } template -basic_string_span::value> +constexpr basic_string_span::value> as_bytes(basic_string_span s) noexcept { - GSL_SUPPRESS(type.1) // NO-FORMAT: attribute + // clang-format off + GSL_SUPPRESS(type.1) + // clang-format on return {reinterpret_cast(s.data()), s.size_bytes()}; } template ::value>> -basic_string_span::value> +constexpr basic_string_span::value> as_writable_bytes(basic_string_span s) noexcept { - GSL_SUPPRESS(type.1) // NO-FORMAT: attribute + // clang-format off + GSL_SUPPRESS(type.1) + // clang-format on return {reinterpret_cast(s.data()), s.size_bytes()}; } // zero-terminated string span, used to convert // zero-terminated spans to legacy strings template -class basic_zstring_span +class [[deprecated("string_span was removed from the C++ Core Guidelines. For more information, " + "see isocpp/CppCoreGuidelines PR#1680")]] basic_zstring_span { public: using value_type = CharT; @@ -395,14 +429,15 @@ public: constexpr basic_zstring_span(impl_type s) : span_(s) { // expects a zero-terminated span - Expects(s[s.size() - 1] == '\0'); + Expects(s.size() > 0); + Expects(s[s.size() - 1] == value_type{}); } // copy constexpr basic_zstring_span(const basic_zstring_span& other) = default; // move - constexpr basic_zstring_span(basic_zstring_span&& other) = default; + constexpr basic_zstring_span(basic_zstring_span && other) = default; // assign constexpr basic_zstring_span& operator=(const basic_zstring_span& other) = default; @@ -410,12 +445,11 @@ public: // move assign constexpr basic_zstring_span& operator=(basic_zstring_span&& other) = default; - constexpr bool empty() const noexcept { return span_.size() == 0; } + constexpr bool empty() const noexcept { return false; } constexpr string_span_type as_string_span() const noexcept { - const auto sz = span_.size(); - return {span_.data(), sz > 1 ? sz - 1 : 0}; + return {span_.data(), span_.size() - 1}; } constexpr string_span_type ensure_z() const { return gsl::ensure_z(span_); } @@ -426,28 +460,44 @@ private: }; template -using zstring_span = basic_zstring_span; +using zstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using wzstring_span = basic_zstring_span; +using wzstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using u16zstring_span = basic_zstring_span; +using u16zstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using u32zstring_span = basic_zstring_span; +using u32zstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using czstring_span = basic_zstring_span; +using czstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using cwzstring_span = basic_zstring_span; +using cwzstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For more " + "information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using cu16zstring_span = basic_zstring_span; +using cu16zstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For " + "more information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; template -using cu32zstring_span = basic_zstring_span; +using cu32zstring_span [[deprecated("string_span was removed from the C++ Core Guidelines. For " + "more information, see isocpp/CppCoreGuidelines PR#1680")]] = + basic_zstring_span; // operator == template & other } // operator != -template , Extent>>::value>> bool operator!=(gsl::basic_string_span one, const T& other) @@ -480,7 +530,7 @@ bool operator!=(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> @@ -490,7 +540,7 @@ bool operator!=(const T& one, gsl::basic_string_span other) } // operator< -template , Extent>>::value>> bool operator<(gsl::basic_string_span one, const T& other) @@ -500,7 +550,7 @@ bool operator<(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> @@ -516,7 +566,7 @@ bool operator<(const T& one, gsl::basic_string_span other) // so the cases below are already covered by the previous operators template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -530,7 +580,7 @@ bool operator<(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -545,7 +595,7 @@ bool operator<(const T& one, gsl::basic_string_span other) #endif // operator <= -template , Extent>>::value>> bool operator<=(gsl::basic_string_span one, const T& other) @@ -554,7 +604,7 @@ bool operator<=(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> @@ -569,7 +619,7 @@ bool operator<=(const T& one, gsl::basic_string_span other) // so the cases below are already covered by the previous operators template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -582,7 +632,7 @@ bool operator<=(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -596,7 +646,7 @@ bool operator<=(const T& one, gsl::basic_string_span other) #endif // operator> -template , Extent>>::value>> bool operator>(gsl::basic_string_span one, const T& other) @@ -605,7 +655,7 @@ bool operator>(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> @@ -620,7 +670,7 @@ bool operator>(const T& one, gsl::basic_string_span other) // so the cases below are already covered by the previous operators template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -633,7 +683,7 @@ bool operator>(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -647,7 +697,7 @@ bool operator>(const T& one, gsl::basic_string_span other) #endif // operator >= -template , Extent>>::value>> bool operator>=(gsl::basic_string_span one, const T& other) @@ -656,7 +706,7 @@ bool operator>=(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> @@ -671,7 +721,7 @@ bool operator>=(const T& one, gsl::basic_string_span other) // so the cases below are already covered by the previous operators template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -684,7 +734,7 @@ bool operator>=(gsl::basic_string_span one, const T& other) } template < - typename CharT, std::size_t Extent = gsl::dynamic_extent, typename T, + typename CharT, std::size_t Extent = dynamic_extent, typename T, typename DataType = typename T::value_type, typename = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && @@ -703,4 +753,7 @@ bool operator>=(const T& one, gsl::basic_string_span other) #endif // _MSC_VER +#if defined(__GNUC__) || defined(__clang__) +#pragma GCC diagnostic pop +#endif #endif // GSL_STRING_SPAN_H diff --git a/gsl/util b/gsl/util new file mode 100644 index 0000000..b6dbd18 --- /dev/null +++ b/gsl/util @@ -0,0 +1,160 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// 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_UTIL_H +#define GSL_UTIL_H + +#include "assert" // for Expects + +#include +#include // for ptrdiff_t, size_t +#include // for initializer_list +#include // for is_signed, integral_constant +#include // for exchange, forward + +#if defined(__has_include) && __has_include() +#include +#if defined(__cpp_lib_span) && __cpp_lib_span >= 202002L +#include +#endif // __cpp_lib_span >= 202002L +#endif //__has_include() + +#if defined(_MSC_VER) && !defined(__clang__) + +#pragma warning(push) +#pragma warning(disable : 4127) // conditional expression is constant + +#endif // _MSC_VER + +#if defined(__cplusplus) && (__cplusplus >= 201703L) +#define GSL_NODISCARD [[nodiscard]] +#else +#define GSL_NODISCARD +#endif // defined(__cplusplus) && (__cplusplus >= 201703L) + +namespace gsl +{ +// +// GSL.util: utilities +// + +// index type for all container indexes/subscripts/sizes +using index = std::ptrdiff_t; + +// final_action allows you to ensure something gets run at the end of a scope +template +class final_action +{ +public: + static_assert(!std::is_reference::value && !std::is_const::value && + !std::is_volatile::value, + "Final_action should store its callable by value"); + + explicit final_action(F f) noexcept : f_(std::move(f)) {} + + final_action(final_action&& other) noexcept + : f_(std::move(other.f_)), invoke_(std::exchange(other.invoke_, false)) + {} + + final_action(const final_action&) = delete; + final_action& operator=(const final_action&) = delete; + final_action& operator=(final_action&&) = delete; + + // clang-format off + GSL_SUPPRESS(f.6) // NO-FORMAT: attribute // terminate if throws + // clang-format on + ~final_action() noexcept + { + if (invoke_) f_(); + } + +private: + F f_; + bool invoke_{true}; +}; + +// finally() - convenience function to generate a final_action +template +GSL_NODISCARD final_action::type>::type> +finally(F&& f) noexcept +{ + return final_action::type>::type>( + std::forward(f)); +} + +// narrow_cast(): a searchable way to do narrowing casts of values +template +// clang-format off +GSL_SUPPRESS(type.1) // NO-FORMAT: attribute + // clang-format on + constexpr T narrow_cast(U&& u) noexcept +{ + return static_cast(std::forward(u)); +} + +// +// at() - Bounds-checked way of accessing builtin arrays, std::array, std::vector +// +template +// clang-format off +GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute +GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute + // clang-format on + constexpr T& at(T (&arr)[N], const index i) +{ + Expects(i >= 0 && i < narrow_cast(N)); + return arr[narrow_cast(i)]; +} + +template +// clang-format off +GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute +GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute + // clang-format on + constexpr auto at(Cont& cont, const index i) -> decltype(cont[cont.size()]) +{ + Expects(i >= 0 && i < narrow_cast(cont.size())); + using size_type = decltype(cont.size()); + return cont[narrow_cast(i)]; +} + +template +// clang-format off +GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute + // clang-format on + constexpr T at(const std::initializer_list cont, const index i) +{ + Expects(i >= 0 && i < narrow_cast(cont.size())); + return *(cont.begin() + i); +} + +#if defined(__cpp_lib_span) && __cpp_lib_span >= 202002L +template +constexpr auto at(std::span sp, const index i) -> decltype(sp[sp.size()]) +{ + Expects(i >= 0 && i < narrow_cast(sp.size())); + return sp[gsl::narrow_cast(i)]; +} +#endif // __cpp_lib_span >= 202002L +} // namespace gsl + +#if defined(_MSC_VER) && !defined(__clang__) + +#pragma warning(pop) + +#endif // _MSC_VER + +#endif // GSL_UTIL_H diff --git a/src/HopperFix.cpp b/src/HopperFix.cpp index 24c74f9..ab7a1d2 100644 --- a/src/HopperFix.cpp +++ b/src/HopperFix.cpp @@ -30,28 +30,31 @@ namespace { // fix hopper THook(gsl::span>*, MSSYM_MD5_21a49b5175e9c00856ce77825b121141, - void* bs, + void* blockSource, void* a2, uint64_t type, AABB* aABB) { auto volume = abs((aABB->max.x - aABB->min.x) * (aABB->max.y - aABB->min.y) * (aABB->max.z - aABB->min.z)); - if (type != ITEM_ENTITY || volume < 0.9994f || volume > 1.000001f) - return original(bs, a2, type, aABB); + if (type != ITEM_ENTITY || volume < 0.9994f || + volume > 1.000001f) // isn't hopper or hopper_minecart + return original(blockSource, a2, type, aABB); + if (abs(frac(aABB->min.y) - 0.625f) < 0.0001f && abs(frac((aABB->max.x + aABB->min.x) / 2.0f) - 0.5f) < 0.0001f && abs(frac((aABB->max.z + aABB->min.z) / 2.0f) - 0.5f) < 0.0001f) { + // is hopper aABB->max.y += 0.375f; } aABB->min.x = aABB->min.x - 0.125f; aABB->min.z = aABB->min.z - 0.125f; aABB->max.x = aABB->max.x + 0.125f; aABB->max.z = aABB->max.z + 0.125f; - auto list = original(bs, a2, type, aABB); + auto list = original(blockSource, a2, type, aABB); // std::cout << list->size(); if (list->size() > 0 && list->size() != static_cast(-1)) { - std::vector list2; + std::vector suckList; for (int i = 0; i < list->size(); i++) { auto item = list->operator[](i); auto pos = item->getPos(); @@ -60,38 +63,36 @@ THook(gsl::span>*, if (pos->x > aABB->min.x && pos->z > aABB->min.z && pos->x < aABB->max.x && pos->z < aABB->max.z) { // std::cout << "true" << std::endl; - // if (i > 0) { - // std::swap(list->operator[](0), list->operator[](i)); - // std::swap(list->operator[](0), list->operator[](i)); - list2.push_back(list->operator[](i)); - //} + suckList.push_back(list->operator[](i)); } } - if (list2.size() > 1) { - auto random = getRand(list2.size()); - std::swap(list2[0], list2[random]); + if (suckList.size() > 1) { + auto random = getRand(suckList.size()); + std::swap(suckList[0], suckList[random]); } - *((int64_t*)bs + 20) = *((int64_t*)bs + 19); // clear + auto mEntityList = (int64_t*)((char*)blockSource + 152); + + *((int64_t*)blockSource + 20) = + *((int64_t*)blockSource + 19); // clear list - auto v6 = (int64_t*)((char*)bs + 152); - for (auto* i : list2) { - float** v39 = (float**)v6[1]; + for (auto* i : suckList) { + float** v39 = (float**)mEntityList[1]; int64_t v52; *(int64_t*)&v52 = (int64_t)i; *v39 = (float*)i; - v6[1] += 8i64; + mEntityList[1] += 8i64; } - auto v44 = (int64_t*)*v6; - auto v45 = (int64_t*)v6[1]; - auto v46 = (int64_t*)*v6; - int64_t* v7; - v7 = (int64_t*)a2; - if ((int64_t*)*v6 == v45) { + auto v44 = (int64_t*)*mEntityList; + auto v45 = (int64_t*)mEntityList[1]; + auto v46 = (int64_t*)*mEntityList; + int64_t* result; + result = (int64_t*)a2; + if ((int64_t*)*mEntityList == v45) { LABEL_69: auto v27 = v45 - v44; - *v7 = v27; + *result = v27; } else { while (*v46) { if (++v46 == v45) @@ -99,12 +100,8 @@ THook(gsl::span>*, } } // std::cout << "hooked" << std::endl; - return (gsl::span>*)v7; + return (gsl::span>*)result; } return list; - // if (list->size() < 2) - // return list; - // auto random = getRand(list->size()); - // std::swap(list->operator[](0), list->operator[](random)); }