/////////////////////////////////////////////////////////////////////////////// // // 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_SPAN_H #define GSL_SPAN_H #include "gsl_assert.h" #include "gsl_util.h" #include #include #include #include #include #include #ifdef _MSC_VER // turn off some warnings that are noisy about our Expects statements #pragma warning(push) #pragma warning(disable : 4127) // conditional expression is constant // No MSVC does constexpr fully yet #pragma push_macro("constexpr") #define constexpr // VS 2013 workarounds #if _MSC_VER <= 1800 #define GSL_MSVC_HAS_VARIADIC_CTOR_BUG #define GSL_MSVC_NO_SUPPORT_FOR_MOVE_CTOR_DEFAULT // noexcept is not understood #ifndef GSL_THROW_ON_CONTRACT_VIOLATION #pragma push_macro("noexcept") #define noexcept /* nothing */ #endif // turn off some misguided warnings #pragma warning(push) #pragma warning(disable : 4351) // warns about newly introduced aggregate initializer behavior #pragma warning(disable : 4512) // warns that assignment op could not be generated #endif // _MSC_VER <= 1800 #endif // _MSC_VER #ifdef GSL_THROW_ON_CONTRACT_VIOLATION #ifdef _MSC_VER #pragma push_macro("noexcept") #endif #define noexcept /* nothing */ #endif // GSL_THROW_ON_CONTRACT_VIOLATION namespace gsl { // [views.constants], constants constexpr const std::ptrdiff_t dynamic_extent = -1; // [span], class template span template class span { public: // constants and types using element_type = ElementType; using index_type = std::ptrdiff_t; using pointer = element_type*; using reference = element_type&; #if 0 // TODO using iterator = /*implementation-defined */; using const_iterator = /* implementation-defined */; using reverse_iterator = std::reverse_iterator; using const_reverse_iterator = std::reverse_iterator; #endif constexpr static const index_type extent = Extent; // [span.cons], span constructors, copy, assignment, and destructor constexpr span() noexcept : storage_(nullptr, extent_type<0>()) {} constexpr span(nullptr_t) noexcept : span() {} constexpr span(pointer ptr, index_type count) : storage_(ptr, count) { Expects(((!ptr && count == 0) || (ptr && count >= 0))); } constexpr span(pointer firstElem, pointer lastElem) : storage_(firstElem, std::distance(firstElem, lastElem)) {} template constexpr span(element_type(&arr)[N]) : storage_(&arr[0], extent_type()) {} template constexpr span(std::array, N>& arr) : storage_(&arr[0], extent_type()) {} template constexpr span(const std::array, N>& arr) : storage_(&arr[0], extent_type()) {} #if 0 // TODO template constexpr span(Container& cont); template span(const Container&&) = delete; constexpr span(const span& other) noexcept = default; constexpr span(span&& other) noexcept = default; template constexpr span(const span& other); template constexpr span(span&& other); ~span() noexcept = default; constexpr span& operator=(const span& other) noexcept = default; constexpr span& operator=(span&& other) noexcept = default; // [span.sub], span subviews template constexpr span first() const; template constexpr span last() const; template constexpr span subspan() const; constexpr span first(index_type count) const; constexpr span last(index_type count) const; constexpr span subspan(index_type offset, index_type count = dynamic_extent) const; #endif // [span.obs], span observers constexpr index_type length() const noexcept { return size(); } constexpr index_type size() const noexcept { return storage_.size(); } constexpr index_type length_bytes() const noexcept { return size_bytes(); } constexpr index_type size_bytes() const noexcept { return size() * sizeof(element_type); } constexpr bool empty() const noexcept { return size() == 0; } // [span.elem], span element access constexpr reference operator[](index_type idx) const { Expects(idx >= 0 && idx < storage_.size()); return storage_.data()[idx]; } constexpr reference operator()(index_type idx) const { return this->operator[](idx); } constexpr pointer data() const noexcept { return storage_.data(); } #if 0 // TODO // [span.iter], span iterator support iterator begin() const noexcept; iterator end() const noexcept; const_iterator cbegin() const noexcept; const_iterator cend() const noexcept; reverse_iterator rbegin() const noexcept; reverse_iterator rend() const noexcept; const_reverse_iterator crbegin() const noexcept; const_reverse_iterator crend() const noexcept; #endif private: template class extent_type; template class extent_type { public: static_assert(Extent >= 0, "A fixed-size span must be >= 0 in size."); constexpr extent_type() noexcept {} template constexpr extent_type(extent_type) noexcept { static_assert(Other == Extent, "Mismatch between fixed-size extent and size of initializing data."); } constexpr extent_type(index_type size) { Expects(size == Extent); } constexpr inline index_type size() const noexcept { return Extent; } }; template <> class extent_type { public: template explicit constexpr extent_type(extent_type ext) : size_(ext.size()) {} explicit constexpr extent_type(index_type size) : size_(size) { Expects(size >= 0); } constexpr inline index_type size() const noexcept { return size_; } private: index_type size_; }; // this implementation detail class lets us take advantage of the // empty base class optimization to pay for only storage of a single // pointer in the case of fixed-size spans template class storage_type : public ExtentType { public: template storage_type(pointer data, OtherExtentType ext) : ExtentType(ext), data_(data) {} //storage_type(pointer data, ExtentType ext) // : ExtentType(ext), data_(data) {} constexpr inline pointer data() const noexcept { return data_; } private: pointer data_; }; storage_type> storage_; }; #if 0 // TODO // [span.comparison], span comparison operators template constexpr bool operator==(const span& l, const span& r) const noexcept; template constexpr bool operator!=(const span& l, const span& r) const noexcept; template constexpr bool operator<(const span& l, const span& r) const noexcept; template constexpr bool operator<=(const span& l, const span& r) const noexcept; template constexpr bool operator>(const span& l, const span& r) const noexcept; template constexpr bool operator>=(const span& l, const span& r) const noexcept; #endif #if 0 // TODO // [span.objectrep], views of object representation template constexpr span as_bytes(span s) noexcept; template constexpr span as_writeable_bytes(span) noexcept; #endif } // namespace gsl #ifdef _MSC_VER #undef constexpr #pragma pop_macro("constexpr") #if _MSC_VER <= 1800 #pragma warning(pop) #ifndef GSL_THROW_ON_CONTRACT_VIOLATION #undef noexcept #pragma pop_macro("noexcept") #endif // GSL_THROW_ON_CONTRACT_VIOLATION #undef GSL_MSVC_HAS_VARIADIC_CTOR_BUG #endif // _MSC_VER <= 1800 #endif // _MSC_VER #if defined(GSL_THROW_ON_CONTRACT_VIOLATION) #undef noexcept #ifdef _MSC_VER #pragma warning(pop) #pragma pop_macro("noexcept") #endif #endif // GSL_THROW_ON_CONTRACT_VIOLATION #endif // GSL_SPAN_H