Template for an intrusive list iterator. More...

#include <cmsis-plus/utils/lists.h>

Public Types
Public Types
using	value_type = U
	Type of value "pointed to" by the iterator.

using	pointer = U *
	Type of pointer to object "pointed to" by the iterator.

using	reference = U &
	Type of reference to object "pointed to" by the iterator.

using	iterator_pointer = N *
	Type of reference to the iterator internal pointer.

using	difference_type = ptrdiff_t
	Type of pointer difference.

using	iterator_category = std::forward_iterator_tag
	Category of iterator.

Public Member Functions
Constructors & Destructor
constexpr	intrusive_list_iterator ()

constexpr	intrusive_list_iterator (iterator_pointer const node)

constexpr	intrusive_list_iterator (reference element)

Operators
pointer	operator-> () const

reference	operator* () const

intrusive_list_iterator &	operator++ ()

intrusive_list_iterator	operator++ (int)

intrusive_list_iterator &	operator-- ()

intrusive_list_iterator	operator-- (int)

bool	operator== (const intrusive_list_iterator &other) const

bool	operator!= (const intrusive_list_iterator &other) const

Public Member Functions
pointer	get_pointer (void) const
	Get the object node from the intrusive node.

iterator_pointer	get_iterator_pointer () const

Protected Attributes
Private Member Variables
iterator_pointer	node_
	Pointer to intrusive node.

Detailed Description

template<typename T, typename N, N T::* MP, typename U = T>
class os::utils::intrusive_list_iterator< T, N, MP, U >

Template Parameters

T	Type of object that includes the intrusive node.
N	Type of intrusive node. Must have the public members prev & next.
MP	Name of the intrusive node member in object T.
U	Type stored in the list, derived from T.

This class provides an interface similar to std::list::iterator.

Definition at line 543 of file lists.h.

Member Typedef Documentation

◆ difference_type

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::difference_type = ptrdiff_t

Definition at line 574 of file lists.h.

◆ iterator_category

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::iterator_category = std::forward_iterator_tag

Definition at line 579 of file lists.h.

◆ iterator_pointer

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::iterator_pointer = N*

Definition at line 569 of file lists.h.

◆ pointer

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::pointer = U*

Definition at line 559 of file lists.h.

◆ reference

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::reference = U&

Definition at line 564 of file lists.h.

◆ value_type

template<typename T , typename N , N T::* MP, typename U = T>

using os::utils::intrusive_list_iterator< T, N, MP, U >::value_type = U

Definition at line 554 of file lists.h.

Constructor & Destructor Documentation

◆ intrusive_list_iterator() [1/3]

template<typename T , typename N , N T::* MP, typename U >

constexpr os::utils::intrusive_list_iterator< T, N, MP, U >::intrusive_list_iterator

constexpr

Definition at line 1022 of file lists.h.

        : node_{}
    {
    }

◆ intrusive_list_iterator() [2/3]

template<typename T , typename N , N T::* MP, typename U >

constexpr os::utils::intrusive_list_iterator< T, N, MP, U >::intrusive_list_iterator ( iterator_pointer const node )

explicitconstexpr

Definition at line 1028 of file lists.h.

        : node_{ node }
    {
    }

◆ intrusive_list_iterator() [3/3]

template<typename T , typename N , N T::* MP, typename U >

constexpr os::utils::intrusive_list_iterator< T, N, MP, U >::intrusive_list_iterator ( reference element )

explicitconstexpr

Definition at line 1035 of file lists.h.

        : node_{ &(element.*MP) }
    {
      static_assert (std::is_convertible<U, T>::value == true,
                     "U must be implicitly convertible to T!");
    }

Member Function Documentation

◆ get_iterator_pointer()

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U >::iterator_pointer os::utils::intrusive_list_iterator< T, N, MP, U >::get_iterator_pointer

inline

Definition at line 1127 of file lists.h.

    {
      return node_;
    }

◆ get_pointer()

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U >::pointer os::utils::intrusive_list_iterator< T, N, MP, U >::get_pointer ( void ) const

inline

Returns: Pointer to object node.

Definition at line 1109 of file lists.h.

    {
      // static_assert(std::is_convertible<U, T>::value == true, "U must be
      // implicitly convertible to T!");
 
      // Compute the distance between the member intrusive link
      // node and the class begin.
      const auto offset = reinterpret_cast<difference_type> (
          &(static_cast<T*> (nullptr)->*MP));
 
      // Compute the address of the object which includes the
      // intrusive node, by adjusting down the node address.
      return reinterpret_cast<pointer> (
          reinterpret_cast<difference_type> (node_) - offset);
    }

◆ operator!=()

template<typename T , typename N , N T::* MP, typename U >

bool os::utils::intrusive_list_iterator< T, N, MP, U >::operator!= ( const intrusive_list_iterator< T, N, MP, U > & other ) const

inline

Definition at line 1101 of file lists.h.

    {
      return node_ != other.node_;
    }

References os::utils::intrusive_list_iterator< T, N, MP, U >::node_.

◆ operator*()

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U >::reference os::utils::intrusive_list_iterator< T, N, MP, U >::operator*

inline

Definition at line 1052 of file lists.h.

    {
      return *get_pointer ();
    }

◆ operator++() [1/2]

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U > & os::utils::intrusive_list_iterator< T, N, MP, U >::operator++

inline

Definition at line 1059 of file lists.h.

    {
      node_ = static_cast<iterator_pointer> (node_->next ());
      return *this;
    }

◆ operator++() [2/2]

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U > os::utils::intrusive_list_iterator< T, N, MP, U >::operator++ ( int )

inline

Definition at line 1067 of file lists.h.

    {
      const auto tmp = *this;
      node_ = static_cast<iterator_pointer> (node_->next ());
      return tmp;
    }

◆ operator--() [1/2]

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U > & os::utils::intrusive_list_iterator< T, N, MP, U >::operator--

inline

Definition at line 1076 of file lists.h.

    {
      node_ = static_cast<iterator_pointer> (node_->prev ());
      return *this;
    }

◆ operator--() [2/2]

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U > os::utils::intrusive_list_iterator< T, N, MP, U >::operator-- ( int )

Definition at line 1084 of file lists.h.

    {
      const auto tmp = *this;
      node_ = static_cast<iterator_pointer> (node_->prev ());
      return tmp;
    }

◆ operator->()

template<typename T , typename N , N T::* MP, typename U >

intrusive_list_iterator< T, N, MP, U >::pointer os::utils::intrusive_list_iterator< T, N, MP, U >::operator->

inline

Definition at line 1045 of file lists.h.

    {
      return get_pointer ();
    }

◆ operator==()

template<typename T , typename N , N T::* MP, typename U >

bool os::utils::intrusive_list_iterator< T, N, MP, U >::operator== ( const intrusive_list_iterator< T, N, MP, U > & other ) const

inline

Definition at line 1093 of file lists.h.

    {
      return node_ == other.node_;
    }

References os::utils::intrusive_list_iterator< T, N, MP, U >::node_.

Member Data Documentation

◆ node_

template<typename T , typename N , N T::* MP, typename U = T>

iterator_pointer os::utils::intrusive_list_iterator< T, N, MP, U >::node_

protected

Definition at line 662 of file lists.h.

Referenced by os::utils::intrusive_list_iterator< T, N, MP, U >::operator!=(), and os::utils::intrusive_list_iterator< T, N, MP, U >::operator==().

The documentation for this class was generated from the following file:

lists.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ iterator_pointer

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ intrusive_list_iterator() [1/3]

◆ intrusive_list_iterator() [2/3]

◆ intrusive_list_iterator() [3/3]

Member Function Documentation

◆ get_iterator_pointer()

◆ get_pointer()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator->()

◆ operator==()

Member Data Documentation

◆ node_