propagate_const_array.h

Go to the documentation of this file.

#ifndef FWCore_Utilities_interface_propagate_const_array_h
#define FWCore_Utilities_interface_propagate_const_array_h
// -*- C++ -*-
//
// Package:     FWCore/Utilities
// Class  :     propagate_const_array
// Description: Propagate const to array-like objects. Based on C++ experimental std::propagate_const.
//              If used with an array of incomplete type, edm::propagate_const_array can only be declared
//              and assigned to nullptr, but not assigned to an actual object or dereferenced.

// system include files
#include <cstddef>
#include <type_traits>
#include <utility>

// user include files

// forward declarations

namespace edm {
  namespace impl {

    template <typename T>
    concept ArrayAddressable = requires(T& a) { a[0]; } or std::is_array_v<T>;

    // for a type T, return the type of the return value of the subscript operator T[N]
    template <typename T, typename = void, typename = void>
    struct subscript_type {};

    // the specialisations for arrays allow supporting incomplete types
    template <typename T>
    struct subscript_type<T[]> {
      using type = T;
    };

    template <typename T, int N>
    struct subscript_type<T[N]> {
      using type = T;
    };

    // for non-array types that implement the subscript operator[], a complete type is needed
    template <typename T>
      requires requires {
        requires not std::is_array_v<T>;
        requires ArrayAddressable<T>;
      }
    struct subscript_type<T> {
      using type = typename std::remove_reference<decltype(std::declval<T&>()[0])>::type;
    };

    template <typename T>
    using subscript_type_t = typename subscript_type<T>::type;

  }  // namespace impl

  template <impl::ArrayAddressable T>
  class propagate_const_array;

  template <typename T>
  constexpr std::decay_t<T>& get_underlying(propagate_const_array<T>&);
  template <typename T>
  constexpr std::decay_t<T> const& get_underlying(propagate_const_array<T> const&);

  template <impl::ArrayAddressable T>
  class propagate_const_array {
  public:
    friend constexpr std::decay_t<T>& get_underlying<T>(propagate_const_array<T>&);
    friend constexpr std::decay_t<T> const& get_underlying<T>(propagate_const_array<T> const&);

    template <impl::ArrayAddressable U>
    friend class propagate_const_array;

    using element_type = typename impl::subscript_type_t<T>;

    constexpr propagate_const_array() = default;
    constexpr propagate_const_array(propagate_const_array<T>&&) = default;
    propagate_const_array(propagate_const_array<T> const&) = delete;
    template <typename U>
    constexpr propagate_const_array(U&& u) : m_value(std::forward<U>(u)) {}

    constexpr propagate_const_array<T>& operator=(propagate_const_array&&) = default;
    propagate_const_array<T>& operator=(propagate_const_array<T> const&) = delete;

    template <typename U>
    constexpr propagate_const_array& operator=(propagate_const_array<U>& other) {
      static_assert(std::is_convertible_v<std::decay_t<U>, std::decay_t<T>>,
                    "Cannot assign propagate_const_array<> of incompatible types");
      m_value = other.m_value;
      return *this;
    }

    template <typename U>
    constexpr propagate_const_array& operator=(U&& u) {
      m_value = std::forward<U>(u);
      return *this;
    }

    // ---------- const member functions ---------------------
    constexpr element_type const* get() const { return &m_value[0]; }
    constexpr element_type const& operator[](std::ptrdiff_t pos) const { return m_value[pos]; }

    constexpr operator element_type const*() const { return this->get(); }

    // ---------- member functions ---------------------------
    constexpr element_type* get() { return &m_value[0]; }
    constexpr element_type& operator[](std::ptrdiff_t pos) { return m_value[pos]; }

    constexpr operator element_type*() { return this->get(); }

  private:
    // ---------- member data --------------------------------
    std::decay_t<T> m_value;
  };

  template <typename T>
  constexpr std::decay_t<T>& get_underlying(propagate_const_array<T>& iP) {
    return iP.m_value;
  }

  template <typename T>
  constexpr std::decay_t<T> const& get_underlying(propagate_const_array<T> const& iP) {
    return iP.m_value;
  }

}  // namespace edm

#endif  // FWCore_Utilities_interface_propagate_const_array_h