Program Listing for File span.h

Return to documentation for file (include/opentelemetry/nostd/span.h)

// Copyright 2020, OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifdef HAVE_CPP_STDLIB
#  include "opentelemetry/std/span.h"
#else
#  include <array>
#  include <cassert>
#  include <cstddef>
#  include <exception>
#  include <iterator>
#  include <type_traits>

#  include "opentelemetry/nostd/utility.h"
#  include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace nostd
{
constexpr size_t dynamic_extent = static_cast<size_t>(-1);

template <class T, size_t Extent = dynamic_extent>
class span;

namespace detail
{
template <class T>
struct is_specialized_span_convertible : std::false_type
{};

template <class T, size_t N>
struct is_specialized_span_convertible<std::array<T, N>> : std::true_type
{};

template <class T, size_t N>
struct is_specialized_span_convertible<T[N]> : std::true_type
{};

template <class T, size_t Extent>
struct is_specialized_span_convertible<span<T, Extent>> : std::true_type
{};
}  // namespace detail

template <class T, size_t Extent>
class span
{
public:
  static constexpr size_t extent = Extent;

  // This arcane code is how we make default-construction result in an SFINAE error
  // with C++11 when Extent != 0 as specified by the std::span API.
  //
  // See https://stackoverflow.com/a/10309720/4447365
  template <bool B = Extent == 0, typename std::enable_if<B>::type * = nullptr>
  span() noexcept : data_{nullptr}
  {}

  span(T *data, size_t count) noexcept : data_{data}
  {
    if (count != Extent)
    {
      std::terminate();
    }
  }

  span(T *first, T *last) noexcept : data_{first}
  {
    if (std::distance(first, last) != Extent)
    {
      std::terminate();
    }
  }

  template <size_t N, typename std::enable_if<Extent == N>::type * = nullptr>
  span(T (&array)[N]) noexcept : data_{array}
  {}

  template <size_t N, typename std::enable_if<Extent == N>::type * = nullptr>
  span(std::array<T, N> &array) noexcept : data_{array.data()}
  {}

  template <size_t N, typename std::enable_if<Extent == N>::type * = nullptr>
  span(const std::array<T, N> &array) noexcept : data_{array.data()}
  {}

  template <
      class C,
      typename std::enable_if<!detail::is_specialized_span_convertible<C>::value &&
                              std::is_convertible<typename std::remove_pointer<decltype(nostd::data(
                                                      std::declval<C &>()))>::type (*)[],
                                                  T (*)[]>::value &&
                              std::is_convertible<decltype(nostd::size(std::declval<const C &>())),
                                                  size_t>::value>::type * = nullptr>
  span(C &c) noexcept(noexcept(nostd::data(c), nostd::size(c))) : data_{nostd::data(c)}
  {
    if (nostd::size(c) != Extent)
    {
      std::terminate();
    }
  }

  template <
      class C,
      typename std::enable_if<!detail::is_specialized_span_convertible<C>::value &&
                              std::is_convertible<typename std::remove_pointer<decltype(nostd::data(
                                                      std::declval<const C &>()))>::type (*)[],
                                                  T (*)[]>::value &&
                              std::is_convertible<decltype(nostd::size(std::declval<const C &>())),
                                                  size_t>::value>::type * = nullptr>
  span(const C &c) noexcept(noexcept(nostd::data(c), nostd::size(c))) : data_{nostd::data(c)}
  {
    if (nostd::size(c) != Extent)
    {
      std::terminate();
    }
  }

  template <class U,
            size_t N,
            typename std::enable_if<N == Extent &&
                                    std::is_convertible<U (*)[], T (*)[]>::value>::type * = nullptr>
  span(const span<U, N> &other) noexcept : data_{other.data()}
  {}

  span(const span &) noexcept = default;

  bool empty() const noexcept { return Extent == 0; }

  T *data() const noexcept { return data_; }

  size_t size() const noexcept { return Extent; }

  T &operator[](size_t index) const noexcept
  {
    assert(index < Extent);
    return data_[index];
  }

  T *begin() const noexcept { return data_; }

  T *end() const noexcept { return data_ + Extent; }

private:
  T *data_;
};

template <class T>
class span<T, dynamic_extent>
{
public:
  static constexpr size_t extent = dynamic_extent;

  span() noexcept : extent_{0}, data_{nullptr} {}

  span(T *data, size_t count) noexcept : extent_{count}, data_{data} {}

  span(T *first, T *last) noexcept
      : extent_{static_cast<size_t>(std::distance(first, last))}, data_{first}
  {
    assert(first <= last);
  }

  template <size_t N>
  span(T (&array)[N]) noexcept : extent_{N}, data_{array}
  {}

  template <size_t N>
  span(std::array<T, N> &array) noexcept : extent_{N}, data_{array.data()}
  {}

  template <size_t N>
  span(const std::array<T, N> &array) noexcept : extent_{N}, data_{array.data()}
  {}

  template <
      class C,
      typename std::enable_if<!detail::is_specialized_span_convertible<C>::value &&
                              std::is_convertible<typename std::remove_pointer<decltype(nostd::data(
                                                      std::declval<C &>()))>::type (*)[],
                                                  T (*)[]>::value &&
                              std::is_convertible<decltype(nostd::size(std::declval<const C &>())),
                                                  size_t>::value>::type * = nullptr>
  span(C &c) noexcept(noexcept(nostd::data(c), nostd::size(c)))
      : extent_{nostd::size(c)}, data_{nostd::data(c)}
  {}

  template <
      class C,
      typename std::enable_if<!detail::is_specialized_span_convertible<C>::value &&
                              std::is_convertible<typename std::remove_pointer<decltype(nostd::data(
                                                      std::declval<const C &>()))>::type (*)[],
                                                  T (*)[]>::value &&
                              std::is_convertible<decltype(nostd::size(std::declval<const C &>())),
                                                  size_t>::value>::type * = nullptr>
  span(const C &c) noexcept(noexcept(nostd::data(c), nostd::size(c)))
      : extent_{nostd::size(c)}, data_{nostd::data(c)}
  {}

  template <class U,
            size_t N,
            typename std::enable_if<std::is_convertible<U (*)[], T (*)[]>::value>::type * = nullptr>
  span(const span<U, N> &other) noexcept : extent_{other.size()}, data_{other.data()}
  {}

  span(const span &) noexcept = default;

  bool empty() const noexcept { return extent_ == 0; }

  T *data() const noexcept { return data_; }

  size_t size() const noexcept { return extent_; }

  T &operator[](size_t index) const noexcept
  {
    assert(index < extent_);
    return data_[index];
  }

  T *begin() const noexcept { return data_; }

  T *end() const noexcept { return data_ + extent_; }

private:
  // Note: matches libstdc++'s layout for std::span
  // See
  // https://github.com/gcc-mirror/gcc/blob/a60701e05b3878000ff9fdde1aecbc472b9dec5a/libstdc%2B%2B-v3/include/std/span#L402-L403
  size_t extent_;
  T *data_;
};
}  // namespace nostd
OPENTELEMETRY_END_NAMESPACE
#endif