/////////////////////////////////////////////////////////////////////////////// // // 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. // /////////////////////////////////////////////////////////////////////////////// #pragma once #ifndef GSL_STRING_SPAN_H #define GSL_STRING_SPAN_H #include "gsl_assert" #include "gsl_util" #include "span" #include #include #include #ifdef _MSC_VER // No MSVC does constexpr fully yet #pragma push_macro("constexpr") #define constexpr /*constexpr*/ #pragma warning(push) // blanket turn off warnings from CppCoreCheck for now // so people aren't annoyed by them when running the tool. // more targeted suppressions will be added in a future update to the GSL #pragma warning(disable : 26481 26482 26483 26485 26490 26491 26492 26493 26495) // VS 2013 workarounds #if _MSC_VER <= 1800 #define GSL_MSVC_HAS_TYPE_DEDUCTION_BUG #define GSL_MSVC_HAS_SFINAE_SUBSTITUTION_ICE #define GSL_MSVC_NO_CPP14_STD_EQUAL #define GSL_MSVC_NO_DEFAULT_MOVE_CTOR // noexcept is not understood #ifndef GSL_THROW_ON_CONTRACT_VIOLATION #pragma push_macro("noexcept") #define noexcept /*noexcept*/ #endif #endif // _MSC_VER <= 1800 #endif // _MSC_VER #ifndef __CYGWIN__ #define GSL_PLATFORM_HAS_STRNLEN #endif // In order to test the library, we need it to throw exceptions that we can catch #ifdef GSL_THROW_ON_CONTRACT_VIOLATION #ifdef _MSC_VER #pragma push_macro("noexcept") #endif #define noexcept /*noexcept*/ #endif // GSL_THROW_ON_CONTRACT_VIOLATION namespace gsl { // // czstring and wzstring // // These are "tag" typedef's for C-style strings (i.e. null-terminated character arrays) // that allow static analysis to help find bugs. // // There are no additional features/semantics that we can find a way to add inside the // type system for these types that will not either incur significant runtime costs or // (sometimes needlessly) break existing programs when introduced. // template using basic_zstring = CharT*; template using czstring = basic_zstring; template using cwzstring = basic_zstring; template using zstring = basic_zstring; template using wzstring = basic_zstring; namespace details { inline std::size_t string_length(const char *str, std::size_t n) { #ifdef GSL_PLATFORM_HAS_STRNLEN return strnlen(str, n); #else if (str == nullptr || n == 0) return 0; std::size_t len = 0; span str_span{str, n}; while (len < n && str_span[len]) len++; return len; #endif } } // // ensure_sentinel() // // Provides a way to obtain an span from a contiguous sequence // that ends with a (non-inclusive) sentinel value. // // Will fail-fast if sentinel cannot be found before max elements are examined. // template span ensure_sentinel(T* seq, std::ptrdiff_t max = PTRDIFF_MAX) { auto cur = seq; while ((cur - seq) < max && *cur != Sentinel) ++cur; Ensures(*cur == Sentinel); return {seq, cur - seq}; } // // ensure_z - creates a span for a czstring or cwzstring. // Will fail fast if a null-terminator cannot be found before // the limit of size_type. // template inline span ensure_z(T* const& sz, std::ptrdiff_t max = PTRDIFF_MAX) { return ensure_sentinel(sz, max); } // TODO (neilmac) there is probably a better template-magic way to get the const and non-const // overloads to share an implementation inline span ensure_z(char* const& sz, std::ptrdiff_t max) { auto len = details::string_length(sz, narrow_cast(max)); Ensures(sz[len] == 0); return {sz, static_cast(len)}; } inline span ensure_z(const char* const& sz, std::ptrdiff_t max) { auto len = details::string_length(sz, narrow_cast(max)); Ensures(sz[len] == 0); return {sz, static_cast(len)}; } inline span ensure_z(wchar_t* const& sz, std::ptrdiff_t max) { auto len = wcsnlen(sz, narrow_cast(max)); Ensures(sz[len] == 0); return {sz, static_cast(len)}; } inline span ensure_z(const wchar_t* const& sz, std::ptrdiff_t max) { auto len = wcsnlen(sz, narrow_cast(max)); Ensures(sz[len] == 0); return {sz, static_cast(len)}; } template span ensure_z(T (&sz)[N]) { return ensure_z(&sz[0], static_cast(N)); } template span::type, dynamic_extent> ensure_z(Cont& cont) { return ensure_z(cont.data(), static_cast(cont.length())); } template class basic_string_span; namespace details { template struct is_basic_string_span_oracle : std::false_type { }; template struct is_basic_string_span_oracle> : std::true_type { }; template struct is_basic_string_span : is_basic_string_span_oracle> { }; template struct length_func { }; template <> struct length_func { std::ptrdiff_t operator()(char* const ptr, std::ptrdiff_t length) noexcept { return narrow_cast(details::string_length(ptr, narrow_cast(length))); } }; template <> struct length_func { std::ptrdiff_t operator()(wchar_t* const ptr, std::ptrdiff_t length) noexcept { return narrow_cast(wcsnlen(ptr, narrow_cast(length))); } }; template <> struct length_func { std::ptrdiff_t operator()(const char* const ptr, std::ptrdiff_t length) noexcept { return narrow_cast(details::string_length(ptr, narrow_cast(length))); } }; template <> struct length_func { std::ptrdiff_t operator()(const wchar_t* const ptr, std::ptrdiff_t length) noexcept { return narrow_cast(wcsnlen(ptr, narrow_cast(length))); } }; } // // string_span and relatives // template class basic_string_span { public: using element_type = CharT; using pointer = std::add_pointer_t; using reference = std::add_lvalue_reference_t; using const_reference = std::add_lvalue_reference_t>; using impl_type = span; using index_type = typename impl_type::index_type; using iterator = typename impl_type::iterator; using const_iterator = typename impl_type::const_iterator; using reverse_iterator = typename impl_type::reverse_iterator; using const_reverse_iterator = typename impl_type::const_reverse_iterator; // default (empty) constexpr basic_string_span() noexcept = default; // copy constexpr basic_string_span(const basic_string_span& other) noexcept = default; // move #ifndef GSL_MSVC_NO_DEFAULT_MOVE_CTOR constexpr basic_string_span(basic_string_span&& other) noexcept = default; #else constexpr basic_string_span(basic_string_span&& other) : span_(std::move(other.span_)) {} #endif // assign constexpr basic_string_span& operator=(const basic_string_span& other) noexcept = default; // move assign #ifndef GSL_MSVC_NO_DEFAULT_MOVE_CTOR constexpr basic_string_span& operator=(basic_string_span&& other) noexcept = default; #else constexpr basic_string_span& operator=(basic_string_span&& other) noexcept { span_ = std::move(other.span_); return *this; } #endif // from nullptr constexpr basic_string_span(std::nullptr_t ptr) noexcept : span_(ptr) {} constexpr basic_string_span(pointer ptr, index_type length) : span_(ptr, length) {} constexpr basic_string_span(pointer firstElem, pointer lastElem) : span_(firstElem, lastElem) {} // 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)) { } template > constexpr basic_string_span(std::array& arr) noexcept : span_(arr) { } template > constexpr basic_string_span(const std::array& arr) noexcept : span_(arr) { } // Container signature should work for basic_string after C++17 version exists template constexpr basic_string_span(std::basic_string& str) : span_(&str[0], str.length()) { } template constexpr basic_string_span(const std::basic_string& str) : span_(&str[0], str.length()) { } // from containers. Containers must have a pointer type and data() function signatures template ::value && std::is_convertible::value && std::is_convertible().data())>::value>> constexpr basic_string_span(Container& cont) : span_(cont) { } template ::value && std::is_convertible::value && std::is_convertible().data())>::value>> constexpr basic_string_span(const Container& cont) : span_(cont) { } // from string_span template < class OtherValueType, std::ptrdiff_t OtherExtent, class = std::enable_if_t::impl_type, impl_type>::value>> constexpr basic_string_span(basic_string_span other) : span_(other.data(), other.length()) { } template constexpr basic_string_span first() const { return {span_.template first()}; } constexpr basic_string_span first(index_type count) const { return {span_.first(count)}; } template constexpr basic_string_span last() const { return {span_.template last()}; } constexpr basic_string_span last(index_type count) const { return {span_.last(count)}; } template constexpr basic_string_span subspan() const { return {span_.template subspan()}; } constexpr basic_string_span subspan(index_type offset, index_type count = dynamic_extent) const { return {span_.subspan(offset, count)}; } constexpr reference operator[](index_type idx) const { return span_[idx]; } constexpr reference operator()(index_type idx) const { return span_[idx]; } constexpr pointer data() const { return span_.data(); } constexpr index_type length() const noexcept { return span_.size(); } constexpr index_type size() const noexcept { return span_.size(); } constexpr index_type size_bytes() const noexcept { return span_.size_bytes(); } constexpr index_type length_bytes() const noexcept { return span_.length_bytes(); } constexpr bool empty() const noexcept { return size() == 0; } constexpr iterator begin() const noexcept { return span_.begin(); } constexpr iterator end() const noexcept { return span_.end(); } constexpr const_iterator cbegin() const noexcept { return span_.cbegin(); } constexpr const_iterator cend() const noexcept { return span_.cend(); } constexpr reverse_iterator rbegin() const noexcept { return span_.rbegin(); } constexpr reverse_iterator rend() const noexcept { return span_.rend(); } constexpr const_reverse_iterator crbegin() const noexcept { return span_.crbegin(); } constexpr const_reverse_iterator crend() const noexcept { return span_.crend(); } private: static impl_type remove_z(pointer const& sz, std::ptrdiff_t max) { return {sz, details::length_func()(sz, max)}; } template static impl_type remove_z(element_type (&sz)[N]) { return remove_z(&sz[0], narrow_cast(N)); } impl_type span_; }; template using string_span = basic_string_span; template using cstring_span = basic_string_span; template using wstring_span = basic_string_span; template using cwstring_span = basic_string_span; // // to_string() allow (explicit) conversions from string_span to string // #ifndef GSL_MSVC_HAS_TYPE_DEDUCTION_BUG template std::basic_string::type> to_string(basic_string_span view) { return {view.data(), static_cast(view.length())}; } #else inline std::string to_string(cstring_span<> view) { return {view.data(), static_cast(view.length())}; } inline std::string to_string(string_span<> view) { return {view.data(), static_cast(view.length())}; } inline std::wstring to_string(cwstring_span<> view) { return {view.data(), static_cast(view.length())}; } inline std::wstring to_string(wstring_span<> view) { return {view.data(), static_cast(view.length())}; } #endif // zero-terminated string span, used to convert // zero-terminated spans to legacy strings template class basic_zstring_span { public: using value_type = CharT; using const_value_type = std::add_const_t; using pointer = std::add_pointer_t; using const_pointer = std::add_pointer_t; using zstring_type = basic_zstring; using const_zstring_type = basic_zstring; using impl_type = span; using string_span_type = basic_string_span; constexpr basic_zstring_span(impl_type s) noexcept : span_(s) { // expects a zero-terminated span Expects(s[s.size() - 1] == '\0'); } // copy constexpr basic_zstring_span(const basic_zstring_span& other) = default; // move #ifndef GSL_MSVC_NO_DEFAULT_MOVE_CTOR constexpr basic_zstring_span(basic_zstring_span&& other) = default; #else constexpr basic_zstring_span(basic_zstring_span&& other) : span_(std::move(other.span_)) {} #endif // assign constexpr basic_zstring_span& operator=(const basic_zstring_span& other) = default; // move assign #ifndef GSL_MSVC_NO_DEFAULT_MOVE_CTOR constexpr basic_zstring_span& operator=(basic_zstring_span&& other) = default; #else constexpr basic_zstring_span& operator=(basic_zstring_span&& other) { span_ = std::move(other.span_); return *this; } #endif constexpr bool empty() const noexcept { return span_.size() == 0; } constexpr string_span_type as_string_span() const noexcept { return span_.first(span_.size() - 1); } constexpr string_span_type ensure_z() const noexcept { return gsl::ensure_z(span_); } constexpr const_zstring_type assume_z() const noexcept { return span_.data(); } private: impl_type span_; }; template using zstring_span = basic_zstring_span; template using wzstring_span = basic_zstring_span; template using czstring_span = basic_zstring_span; template using cwzstring_span = basic_zstring_span; // operator == template ::value || std::is_convertible>>::value>> bool operator==(const gsl::basic_string_span& one, const T& other) noexcept { gsl::basic_string_span> tmp(other); #ifdef GSL_MSVC_NO_CPP14_STD_EQUAL return (one.size() == tmp.size()) && std::equal(one.begin(), one.end(), tmp.begin()); #else return std::equal(one.begin(), one.end(), tmp.begin(), tmp.end()); #endif } template ::value && std::is_convertible>>::value>> bool operator==(const T& one, const gsl::basic_string_span& other) noexcept { gsl::basic_string_span> tmp(one); #ifdef GSL_MSVC_NO_CPP14_STD_EQUAL return (tmp.size() == other.size()) && std::equal(tmp.begin(), tmp.end(), other.begin()); #else return std::equal(tmp.begin(), tmp.end(), other.begin(), other.end()); #endif } // operator != template , Extent>>::value>> bool operator!=(gsl::basic_string_span one, const T& other) noexcept { return !(one == other); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename Dummy = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> bool operator!=(const T& one, gsl::basic_string_span other) noexcept { return !(one == other); } // operator< template , Extent>>::value>> bool operator<(gsl::basic_string_span one, const T& other) noexcept { gsl::basic_string_span, Extent> tmp(other); return std::lexicographical_compare(one.begin(), one.end(), tmp.begin(), tmp.end()); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename Dummy = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> bool operator<(const T& one, gsl::basic_string_span other) noexcept { gsl::basic_string_span, Extent> tmp(one); return std::lexicographical_compare(tmp.begin(), tmp.end(), other.begin(), other.end()); } #ifndef _MSC_VER // VS treats temp and const containers as convertible to basic_string_span, // so the cases below are already covered by the previous operators template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator<(gsl::basic_string_span one, const T& other) noexcept { gsl::basic_string_span, Extent> tmp(other); return std::lexicographical_compare(one.begin(), one.end(), tmp.begin(), tmp.end()); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator<(const T& one, gsl::basic_string_span other) noexcept { gsl::basic_string_span, Extent> tmp(one); return std::lexicographical_compare(tmp.begin(), tmp.end(), other.begin(), other.end()); } #endif // operator <= template , Extent>>::value>> bool operator<=(gsl::basic_string_span one, const T& other) noexcept { return !(other < one); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename Dummy = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> bool operator<=(const T& one, gsl::basic_string_span other) noexcept { return !(other < one); } #ifndef _MSC_VER // VS treats temp and const containers as convertible to basic_string_span, // so the cases below are already covered by the previous operators template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator<=(gsl::basic_string_span one, const T& other) noexcept { return !(other < one); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator<=(const T& one, gsl::basic_string_span other) noexcept { return !(other < one); } #endif // operator> template , Extent>>::value>> bool operator>(gsl::basic_string_span one, const T& other) noexcept { return other < one; } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename Dummy = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> bool operator>(const T& one, gsl::basic_string_span other) noexcept { return other < one; } #ifndef _MSC_VER // VS treats temp and const containers as convertible to basic_string_span, // so the cases below are already covered by the previous operators template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator>(gsl::basic_string_span one, const T& other) noexcept { return other < one; } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator>(const T& one, gsl::basic_string_span other) noexcept { return other < one; } #endif // operator >= template , Extent>>::value>> bool operator>=(gsl::basic_string_span one, const T& other) noexcept { return !(one < other); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename Dummy = std::enable_if_t< std::is_convertible, Extent>>::value && !gsl::details::is_basic_string_span::value>> bool operator>=(const T& one, gsl::basic_string_span other) noexcept { return !(one < other); } #ifndef _MSC_VER // VS treats temp and const containers as convertible to basic_string_span, // so the cases below are already covered by the previous operators template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator>=(gsl::basic_string_span one, const T& other) noexcept { return !(one < other); } template < typename CharT, std::ptrdiff_t Extent = gsl::dynamic_extent, typename T, typename DataType = typename T::value_type, typename Dummy = std::enable_if_t< !gsl::details::is_span::value && !gsl::details::is_basic_string_span::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> bool operator>=(const T& one, gsl::basic_string_span other) noexcept { return !(one < other); } #endif } // namespace GSL #ifdef _MSC_VER #pragma warning(pop) #undef constexpr #pragma pop_macro("constexpr") // VS 2013 workarounds #if _MSC_VER <= 1800 #ifndef GSL_THROW_ON_CONTRACT_VIOLATION #undef noexcept #pragma pop_macro("noexcept") #endif // GSL_THROW_ON_CONTRACT_VIOLATION #undef GSL_MSVC_HAS_TYPE_DEDUCTION_BUG #undef GSL_MSVC_HAS_SFINAE_SUBSTITUTION_ICE #undef GSL_MSVC_NO_CPP14_STD_EQUAL #undef GSL_MSVC_NO_DEFAULT_MOVE_CTOR #endif // _MSC_VER <= 1800 #endif // _MSC_VER #if defined(GSL_THROW_ON_CONTRACT_VIOLATION) #undef noexcept #ifdef _MSC_VER #pragma pop_macro("noexcept") #endif #endif // GSL_THROW_ON_CONTRACT_VIOLATION #endif // GSL_STRING_SPAN_H