utility.h

Go to the documentation of this file.

 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2016 John Wellbelove
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
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 ETL_UTILITY_INCLUDED
#define ETL_UTILITY_INCLUDED
 
#include "platform.h"
#include "type_traits.h"
 
#include "private/tuple_element.h"
#include "private/tuple_size.h"
 
#if defined(ETL_IN_UNIT_TEST) || ETL_USING_STL
  #if ETL_USING_CPP11
    #include <utility>
  #else
    #include <algorithm>
  #endif
#endif

 
namespace etl
{
#if ETL_USING_CPP11
  //******************************************************************************
  template <typename T>
  constexpr typename etl::remove_reference<T>::type&& move(T&& t) ETL_NOEXCEPT
  {
    return static_cast<typename etl::remove_reference<T>::type&&>(t);
  }
 
  //******************************************************************************
  template <typename T>
  constexpr T&& forward(typename etl::remove_reference<T>::type& t) ETL_NOEXCEPT
  {
    return static_cast<T&&>(t);
  }
 
  template <typename T>
  constexpr T&& forward(typename etl::remove_reference<T>::type&& t) ETL_NOEXCEPT
  {
    ETL_STATIC_ASSERT(!etl::is_lvalue_reference<T>::value, "Invalid rvalue to lvalue conversion");
    return static_cast<T&&>(t);
  }
 
  //******************************************************************************
  //******************************************************************************
  //***********************************
  //***********************************
  template <typename T, typename U>
  ETL_NODISCARD
  ETL_CONSTEXPR
  etl::enable_if_t<etl::is_const<etl::remove_reference_t<T>>::value && etl::is_lvalue_reference<T>::value, const etl::remove_reference_t<U>&>
    forward_like(U&& u) ETL_NOEXCEPT
  {
    return static_cast<const etl::remove_reference_t<U>&>(u);
  }
 
  //***********************************
  //***********************************
  template <typename T, typename U>
  ETL_NODISCARD
  ETL_CONSTEXPR
  etl::enable_if_t<etl::is_const<etl::remove_reference_t<T>>::value && !etl::is_lvalue_reference<T>::value, const etl::remove_reference_t<U>&&>
    forward_like(U&& u) ETL_NOEXCEPT
  {
    return static_cast<const etl::remove_reference_t<U>&&>(u);
  }
 
  //***********************************
  //***********************************
  template <typename T, typename U>
  ETL_NODISCARD
  ETL_CONSTEXPR
  etl::enable_if_t<!etl::is_const<etl::remove_reference_t<T>>::value && etl::is_lvalue_reference<T>::value, etl::remove_reference_t<U>&>
    forward_like(U&& u) ETL_NOEXCEPT
  {
    return static_cast<etl::remove_reference_t<U>&>(u);
  }
 
  //***********************************
  //***********************************
  template <typename T, typename U>
  ETL_NODISCARD
  ETL_CONSTEXPR
  etl::enable_if_t<!etl::is_const<etl::remove_reference_t<T>>::value && !etl::is_lvalue_reference<T>::value, etl::remove_reference_t<U>&&>
    forward_like(U&& u) ETL_NOEXCEPT
  {
    return static_cast<etl::remove_reference_t<U>&&>(u);
  }
 
  //***********************************
  // Defines the type that forward_like would cast to.
  //***********************************
  template <typename T, typename U>
  using forward_like_t = decltype(etl::forward_like<T>(etl::declval<U&>()));
#endif
 
  //***********************************
  // Gets the underlying type of an enum.
  //***********************************
  template <typename T>
  ETL_CONSTEXPR typename underlying_type<T>::type to_underlying(T value) ETL_NOEXCEPT
  {
    return static_cast<typename underlying_type<T>::type>(value);
  }
 
  // We can't have std::swap and etl::swap templates coexisting in the unit tests
  // as the compiler will be unable to decide which one to use, due to ADL.
#if ETL_NOT_USING_STL && !defined(ETL_IN_UNIT_TEST)
  //***************************************************************************
  // swap
  template <typename T>
  ETL_CONSTEXPR14 void swap(T& a, T& b) ETL_NOEXCEPT
  {
    T temp(ETL_MOVE(a));
    a = ETL_MOVE(b);
    b = ETL_MOVE(temp);
  }
 
  template< class T, size_t Size >
  ETL_CONSTEXPR14 void swap(T(&a)[Size], T(&b)[Size]) ETL_NOEXCEPT
  {
    for (size_t i = 0UL; i < Size; ++i)
    {
      swap(a[i], b[i]);
    }
  }
#endif
 
  //***************************************************************************
  //***************************************************************************
  template <typename T1, typename T2>
  struct pair
  {
    typedef T1 first_type;   
    typedef T2 second_type;  
 
    T1 first;   
    T2 second;  
 
    //***************************************************************************
    //***************************************************************************
    ETL_CONSTEXPR pair()
      : first(T1())
      , second(T2())
    {
    }
 
    //***************************************************************************
    //***************************************************************************
    ETL_CONSTEXPR14 pair(const T1& a, const T2& b)
      : first(a)
      , second(b)
    {
    }
 
#if ETL_USING_CPP11
    //***************************************************************************
    //***************************************************************************
    template <typename U1, typename U2>
    ETL_CONSTEXPR14 pair(U1&& a, U2&& b)
      : first(etl::forward<U1>(a))
      , second(etl::forward<U2>(b))
    {
    }
#endif
 
    //***************************************************************************
    //***************************************************************************
    template <typename U1, typename U2>
    ETL_CONSTEXPR14 pair(const pair<U1, U2>& other)
      : first(other.first)
      , second(other.second)
    {
    }

    pair(const pair<T1, T2>& other)
      : first(other.first)
      , second(other.second)
    {
    }
 
#if ETL_USING_CPP11
    template <typename U1, typename U2>
    ETL_CONSTEXPR14 pair(pair<U1, U2>&& other)
      : first(etl::forward<U1>(other.first))
      , second(etl::forward<U2>(other.second))
    {
    }
#endif
 
#if defined(ETL_IN_UNIT_TEST) || ETL_USING_STL
    template <typename U1, typename U2>
    operator std::pair<U1, U2>()
    {
      return std::make_pair(first, second);
    }

    template <typename U1, typename U2>
    pair(const std::pair<U1, U2>& other)
      : first(other.first)
      , second(other.second)
    {
    }
 
#if ETL_USING_CPP11
    template <typename U1, typename U2>
    pair(std::pair<U1, U2>&& other)
      : first(etl::forward<U1>(other.first))
      , second(etl::forward<U2>(other.second))
    {
    }
#endif
#endif
 
    void swap(pair<T1, T2>& other)
    {
      using ETL_OR_STD::swap;
 
      swap(first, other.first);
      swap(second, other.second);
    }
 
    pair<T1, T2>& operator =(const pair<T1, T2>& other)
    {
      first = other.first;
      second = other.second;
 
      return *this;
    }
 
    template <typename U1, typename U2>
    pair<U1, U2>& operator =(const pair<U1, U2>& other)
    {
      first = other.first;
      second = other.second;
 
      return *this;
    }
 
#if ETL_USING_CPP11
    pair<T1, T2>& operator =(pair<T1, T2>&& other)
    {
      first = etl::forward<T1>(other.first);
      second = etl::forward<T2>(other.second);
 
      return *this;
    }
 
    template <typename U1, typename U2>
    pair<U1, U2>& operator =(pair<U1, U2>&& other)
    {
      first = etl::forward<U1>(other.first);
      second = etl::forward<U2>(other.second);
 
      return *this;
    }
#endif
  };
 
  //***************************************************************************
  //***************************************************************************
#if ETL_USING_CPP11
  template <typename T1, typename T2>
  inline pair<T1, T2> make_pair(T1&& a, T2&& b)
  {
    return pair<T1, T2>(etl::forward<T1>(a), etl::forward<T2>(b));
  }
#else
  template <typename T1, typename T2>
  inline pair<T1, T2> make_pair(T1 a, T2 b)
  {
    return pair<T1, T2>(a, b);
  }
#endif
 
#if ETL_USING_CPP11
  //******************************************************************************
  template <size_t Index, typename T1, typename T2>
  struct tuple_element<Index, ETL_OR_STD::pair<T1, T2> >
  {
    ETL_STATIC_ASSERT(Index < 2U, "pair has only 2 elements");
  };
 
  template <typename T1, typename T2>
  struct tuple_element<0U, ETL_OR_STD::pair<T1, T2> >
  {
    typedef T1 type;
  };
 
  template <typename T1, typename T2>
  struct tuple_element<1U, ETL_OR_STD::pair<T1, T2> >
  {
    typedef T2 type;
  };
 
  //******************************************************************************
  template <typename T1, typename T2>
  struct tuple_size<ETL_OR_STD::pair<T1, T2>> : public etl::integral_constant<size_t, 2U>
  {
  };
#endif
 
  //******************************************************************************
  template <typename T1, typename T2>
  inline void swap(pair<T1, T2>& a, pair<T1, T2>& b)
  {
    a.swap(b);
  }

  template <typename T1, typename T2>
  inline bool operator ==(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
#include "private/diagnostic_float_equal_push.h"
    return (a.first == b.first) && !(a.second < b.second) && !(a.second > b.second);
#include "private/diagnostic_pop.h"
  }

  template <typename T1, typename T2>
  inline bool operator !=(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
    return !(a == b);
  }
 
  template <typename T1, typename T2>
  inline bool operator <(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
    return (a.first < b.first) ||
      (!(b.first < a.first) && (a.second < b.second));
  }

  template <typename T1, typename T2>
  inline bool operator >(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
    return (b < a);
  }

  template <typename T1, typename T2>
  inline bool operator <=(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
    return !(b < a);
  }

  template <typename T1, typename T2>
  inline bool operator >=(const pair<T1, T2>& a, const pair<T1, T2>& b)
  {
    return !(a < b);
  }
 
  //***************************************************************************
  //***************************************************************************
  template <typename TPair>
  struct select1st
  {
    typedef typename TPair::first_type type;  
 
    //***************************************************************************
    //***************************************************************************
    type& operator()(TPair& p) const
    {
      return p.first;
    }
 
    //***************************************************************************
    //
    const type& operator()(const TPair& p) const
    {
      return p.first;
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename TPair>
  struct select2nd
  {
    typedef typename TPair::second_type type;  
 
    //***************************************************************************
    //***************************************************************************
    type& operator()(TPair& p) const
    {
      return p.second;
    }
 
    //***************************************************************************
    //***************************************************************************
    const type& operator()(const TPair& p) const
    {
      return p.second;
    }
  };
 
#if ETL_NOT_USING_STL || ETL_CPP14_NOT_SUPPORTED
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  T exchange(T& object, const T& new_value)
  {
    T old_value = object;
    object = new_value;
    return old_value;
  }
 
  template <typename T, typename U>
  T exchange(T& object, const U& new_value)
  {
    T old_value = object;
    object = new_value;
    return old_value;
  }
#else
  //***************************************************************************
  //***************************************************************************
  template <typename T, typename U = T>
  T exchange(T& object, const U& new_value)
  {
    return std::exchange(object, new_value);
  }
#endif
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  typename etl::add_const<T>::type& as_const(T& t)
  {
    return t;
  }
 
  //***************************************************************************
  //***************************************************************************
#if ETL_USING_CPP11
  template <typename T, T... Integers>
  class integer_sequence
  {
  public:
  
    ETL_STATIC_ASSERT(etl::is_integral<T>::value, "Integral types only");
 
    typedef T value_type;
  
    static ETL_CONSTEXPR size_t size() ETL_NOEXCEPT 
    { 
      return sizeof...(Integers);
    }
  };
 
  namespace private_integer_sequence
  {
    template <size_t Count, typename IndexSeq>
    struct make_index_sequence;
 
    template <size_t Count, size_t... Indices>
    struct make_index_sequence<Count, etl::integer_sequence<size_t, Indices...>>
    {
      using type = typename make_index_sequence<Count - 1, etl::integer_sequence<size_t, Count - 1, Indices...>>::type;
    };
 
    template <size_t... Indices>
    struct make_index_sequence<0, etl::integer_sequence<size_t, Indices...>>
    {
      using type = etl::integer_sequence<size_t, Indices...>;
    };
  }
 
  //***********************************
  template <size_t Count>
  using make_index_sequence = typename private_integer_sequence::make_index_sequence<Count, etl::integer_sequence<size_t>>::type;
 
  template <typename... TTypes>
  using make_index_sequence_for = typename private_integer_sequence::make_index_sequence<sizeof...(TTypes), etl::integer_sequence<size_t>>::type;
 
  //***********************************
  template <size_t... Indices>
  using index_sequence = etl::integer_sequence<size_t, Indices...>;
 
  template <typename... TTypes>
  using index_sequence_for = typename etl::make_index_sequence_for<TTypes...>;
#endif
 
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  struct coordinate_2d
  {
    coordinate_2d()
      : x(T(0))
      , y(T(0))
    {
    }
 
    coordinate_2d(T x_, T y_)
      : x(x_)
      , y(y_)
    {
    }
 
    friend bool operator ==(const coordinate_2d& lhs, const coordinate_2d& rhs)
    {
      return (lhs.x == rhs.x) && (lhs.y == rhs.y);
    }
 
    friend bool operator !=(const coordinate_2d& lhs, const coordinate_2d& rhs)
    {
      return !(lhs == rhs);
    }
 
    T x;
    T y;
  };
 
  //***************************************************************************
  //***************************************************************************
  
  //*************************
  struct in_place_t 
  {
    explicit ETL_CONSTEXPR in_place_t() {}
  };
 
#if ETL_USING_CPP17
  inline constexpr in_place_t in_place{};
#endif
  
  //*************************
  template <typename T> struct in_place_type_t 
  {
    explicit ETL_CONSTEXPR in_place_type_t() {}
  };
 
#if ETL_USING_CPP17
  template <typename T>
  inline constexpr in_place_type_t<T> in_place_type{};
#endif
 
  //*************************
  template <size_t Index> struct in_place_index_t 
  {
    explicit ETL_CONSTEXPR in_place_index_t() {}
  };
 
#if ETL_USING_CPP17
  template <size_t Index>
  inline constexpr in_place_index_t<Index> in_place_index{};
#endif
 
#if ETL_USING_CPP11
  //*************************************************************************
  // A function wrapper for free/global functions.
  // Deprecated.
  // See etl::function_ptr_as_functor for a runtime time wrapper option.
  // See etl::function_as_functor for a compile time wrapper option.
  //*************************************************************************
  template <typename TReturn, typename... TParams>
  class ETL_DEPRECATED functor
  {
  public:
 
    //*********************************
    //*********************************
    constexpr functor(TReturn(*ptr_)(TParams...))
      : ptr(ptr_)
    {
    }
 
    //*********************************
    //*********************************
    constexpr TReturn operator()(TParams... args) const
    {
      return ptr(etl::forward<TParams>(args)...);
    }
 
  private:

    TReturn(*ptr)(TParams...);
  };
 
  //*****************************************************************************
  // Wrap a member function with a static free function.
  // Creates a static member function that calls the specified member function.
  // Deprecated
  // See etl::member_function_as_static
  //*****************************************************************************
  template <typename T>
  class member_function_wrapper;
 
  template <typename TReturn, typename... TParams>
  class ETL_DEPRECATED member_function_wrapper<TReturn(TParams...)>
  {
  public:
 
    template <typename T, T& Instance, TReturn(T::* Method)(TParams...)>
    static constexpr TReturn function(TParams... params)
    {
      return (Instance.*Method)(etl::forward<TParams>(params)...);
    }
  };
 
  //*****************************************************************************
  // Wrap a functor with a static free function.
  // Creates a static member function that calls the specified functor.
  // Deprecated
  // See etl::functor_as_static
  //*****************************************************************************
  template <typename T>
  class functor_wrapper;
 
  template <typename TReturn, typename... TParams>
  class functor_wrapper<TReturn(TParams...)>
  {
  public:
 
    template <typename TFunctor, TFunctor& Instance>
    static constexpr TReturn function(TParams... params)
    {
      return Instance(etl::forward<TParams>(params)...);
    }
  };
#endif
 
#if ETL_USING_CPP17
  //*****************************************************************************
  // Wraps a functor with a static free function at compile time.
  // Creates a static member 'call' that calls the specified functor.
  //*****************************************************************************
  template <auto& Instance>
  struct functor_as_static 
  {
    template <typename... TArgs>
    static constexpr auto call(TArgs&&... args)
    {
      return (Instance.operator())(etl::forward<TArgs>(args)...);
    }
  };
 
  //*****************************************************************************
  // Wraps a member function with a static free function at compile time.
  // Creates a static member 'call' that calls the specified member function.
  //*****************************************************************************
  template <auto Method, auto& Instance>
  struct member_function_as_static 
  {
    template <typename... TArgs>
    static constexpr auto call(TArgs&&... args)
    {
      return (Instance.*Method)(etl::forward<TArgs>(args)...);
    }
  };
 
  //*****************************************************************************
  // Wraps a member function with a functor at compile time.
  // Creates a functor that calls the specified member function.
  //*****************************************************************************
  template <auto Method, auto& Instance>
  class member_function_as_functor
  {
  public:
 
    template <typename... TArgs>
    constexpr auto operator()(TArgs&&... args) const -> decltype((Instance.*Method)(etl::forward<TArgs>(args)...))
    {
      return (Instance.*Method)(etl::forward<TArgs>(args)...);
    }
  };
 
  //*****************************************************************************
  // Wraps a function with a functor at compile time.
  // Creates a functor that calls the specified free function.
  //*****************************************************************************
  template <auto Function>
  class function_as_functor
  {
  public:
 
    template<typename... TArgs>
    constexpr auto operator()(TArgs&&... args) const -> decltype(Function(etl::forward<TArgs>(args)...))
    {
      return Function(etl::forward<TArgs>(args)...);
    }
  };
#endif
 
#if ETL_USING_CPP11
  //*****************************************************************************
  // Wraps a function pointer with a functor at run time.
  // Creates a functor that calls the specified free function.
  //*****************************************************************************
  template <typename T>
  class function_ptr_as_functor;
 
  template <typename TReturn, typename... TArgs>
  class function_ptr_as_functor<TReturn(TArgs...)>
  {
  public:
 
    //*********************************
    //*********************************
    constexpr function_ptr_as_functor(TReturn(*ptr_)(TArgs...))
      : ptr(ptr_)
    {
    }
 
    //*********************************
    //*********************************
    constexpr TReturn operator()(TArgs... args) const
    {
      return ptr(etl::forward<TArgs>(args)...);
    }
 
  private:

    TReturn(*ptr)(TArgs...);
  };
#endif
 
#if ETL_USING_CPP17 && !defined(ETL_FORCE_CPP11_NONTYPE)
  //*****************************************************************************
  // Wraps a non-type template parameter as a type.
  //*****************************************************************************
  template <auto Value>
  struct nontype_t
  {
    static constexpr decltype(Value) value = Value;
  };
#elif ETL_USING_CPP11
  //*****************************************************************************
  // Wraps a non-type template parameter as a type.
  //*****************************************************************************
  template <typename T, T Value>
  struct nontype_t
  {
    static constexpr T value = Value;
  };
#endif
}
 
#endif