KisForestDetail::CompositionIterator< T, is_const > Class Template Reference

#include <KisForest.h>

Inheritance diagram for KisForestDetail::CompositionIterator< T, is_const >:

Public Types
using	NodeType = typename BaseIteratorType::NodeType
using	RootNodeType = typename BaseIteratorType::RootNodeType
using	traversal_state = TraversalState

Public Member Functions
	CompositionIterator (NodeType *node, traversal_state state=Enter)
NodeType *	node () const
	operator CompositionIterator< T, true > () const
traversal_state	state () const

Private Types
using	BaseClass
using	BaseIteratorType = typename CompositionIterator::base_type

Private Member Functions
void	increment ()
bool	tryJumpToPos (typename CompositionIterator::base_type it, TraversalState newState)

Private Attributes
traversal_state	m_state = Enter

Friends
class	boost::iterator_core_access

Detailed Description

template<typename T, bool is_const>
class KisForestDetail::CompositionIterator< T, is_const >

Definition at line 485 of file KisForest.h.

Member Typedef Documentation

BaseClass

template<typename T , bool is_const>

using KisForestDetail::CompositionIterator< T, is_const >::BaseClass

private

Initial value:

 boost::iterator_adaptor<
        CompositionIterator<T, is_const>,
        ChildIterator<T, is_const>,
        boost::use_default,
        boost::forward_traversal_tag>

Definition at line 492 of file KisForest.h.

BaseIteratorType

template<typename T , bool is_const>

using KisForestDetail::CompositionIterator< T, is_const >::BaseIteratorType = typename CompositionIterator::base_type

private

Definition at line 498 of file KisForest.h.

NodeType

template<typename T , bool is_const>

using KisForestDetail::CompositionIterator< T, is_const >::NodeType = typename BaseIteratorType::NodeType

Definition at line 503 of file KisForest.h.

RootNodeType

template<typename T , bool is_const>

using KisForestDetail::CompositionIterator< T, is_const >::RootNodeType = typename BaseIteratorType::RootNodeType

Definition at line 502 of file KisForest.h.

traversal_state

template<typename T , bool is_const>

using KisForestDetail::CompositionIterator< T, is_const >::traversal_state = TraversalState

Definition at line 501 of file KisForest.h.

Constructor & Destructor Documentation

CompositionIterator()

template<typename T , bool is_const>

KisForestDetail::CompositionIterator< T, is_const >::CompositionIterator ( NodeType * node, traversal_state state = Enter )

inline

Definition at line 510 of file KisForest.h.

        : BaseClass(BaseIteratorType(node, node ? node->parent : nullptr, 0)),
          m_state(state)
    {
    }

Member Function Documentation

increment()

template<typename T , bool is_const>

void KisForestDetail::CompositionIterator< T, is_const >::increment ( )

inlineprivate

Definition at line 540 of file KisForest.h.

                     {
        switch (m_state) {
        case Enter:
            if (tryJumpToPos(childBegin(this->base()), Enter)) return;
            if (tryJumpToPos(this->base(), Leave)) return;
            break;
        case Leave:
            if (tryJumpToPos(std::next(this->base()), Enter)) return;
            if (tryJumpToPos(parent(this->base()), Leave)) return;
            break;
        }
 
        this->base_reference() = BaseIteratorType(nullptr, nullptr, 0);
    }

References KisForestDetail::childBegin(), KisForestDetail::Enter, KisForestDetail::Leave, KisForestDetail::CompositionIterator< T, is_const >::m_state, KisForestDetail::parent(), and KisForestDetail::CompositionIterator< T, is_const >::tryJumpToPos().

node()

template<typename T , bool is_const>

NodeType * KisForestDetail::CompositionIterator< T, is_const >::node ( ) const

inline

Definition at line 505 of file KisForest.h.

                           {
        return this->base().node();
    }

operator CompositionIterator< T, true >()

template<typename T , bool is_const>

KisForestDetail::CompositionIterator< T, is_const >::operator CompositionIterator< T, true > ( ) const

inline

Definition at line 520 of file KisForest.h.

                                                  {
        return CompositionIterator<T, true>(this->m_node, this->m_state);
    }

References KisForestDetail::CompositionIterator< T, is_const >::m_state.

state()

template<typename T , bool is_const>

traversal_state KisForestDetail::CompositionIterator< T, is_const >::state ( ) const

inline

Definition at line 516 of file KisForest.h.

                                  {
        return m_state;
    }

References KisForestDetail::CompositionIterator< T, is_const >::m_state.

tryJumpToPos()

template<typename T , bool is_const>

bool KisForestDetail::CompositionIterator< T, is_const >::tryJumpToPos ( typename CompositionIterator< T, is_const >::base_type it, TraversalState newState )

inlineprivate

Definition at line 527 of file KisForest.h.

                                               {
        bool result = false;
 
        if (!isEnd(it)) {
            this->base_reference() = it;
            result = true;
            m_state = newState;
        }
 
        return result;
    }

References KisForestDetail::isEnd(), and KisForestDetail::CompositionIterator< T, is_const >::m_state.

Friends And Related Symbol Documentation

boost::iterator_core_access

template<typename T , bool is_const>

friend class boost::iterator_core_access

friend

Definition at line 525 of file KisForest.h.

Member Data Documentation

m_state

template<typename T , bool is_const>

traversal_state KisForestDetail::CompositionIterator< T, is_const >::m_state = Enter

private

Definition at line 556 of file KisForest.h.

---

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

• libs/global/KisForest.h