#include <KisForest.h>

Public Types
using	child_iterator = ChildIterator<T, false>

using	composition_iterator = CompositionIterator<T, false>

using	const_child_iterator = ChildIterator<T, true>

using	const_composition_iterator = CompositionIterator<T, true>

using	const_depth_first_tail_iterator = DepthFirstIterator<T, Leave, true>

using	const_hierarchy_iterator = HierarchyIterator<T, true>

using	const_iterator = DepthFirstIterator<T, Enter, true>

using	depth_first_tail_iterator = DepthFirstIterator<T, Leave, false>

using	hierarchy_iterator = HierarchyIterator<T, false>

using	iterator = DepthFirstIterator<T, Enter, false>

using	value_type = T

Public Member Functions
iterator	begin ()

const_iterator	begin () const

child_iterator	childBegin ()

const_child_iterator	childBegin () const

child_iterator	childEnd ()

const_child_iterator	childEnd () const

composition_iterator	compositionBegin ()

const_composition_iterator	compositionBegin () const

composition_iterator	compositionEnd ()

const_composition_iterator	compositionEnd () const

const_iterator	constBegin () const

const_child_iterator	constChildBegin () const

const_child_iterator	constChildEnd () const

const_composition_iterator	constCompositionBegin () const

const_composition_iterator	constCompositionEnd () const

const_depth_first_tail_iterator	constDepthFirstTailBegin () const

const_depth_first_tail_iterator	constDepthFirstTailEnd () const

const_iterator	constEnd () const

const_child_iterator	constParentEnd () const

depth_first_tail_iterator	depthFirstTailBegin ()

const_depth_first_tail_iterator	depthFirstTailBegin () const

depth_first_tail_iterator	depthFirstTailEnd ()

const_depth_first_tail_iterator	depthFirstTailEnd () const

bool	empty () const

iterator	end ()

const_iterator	end () const

child_iterator	erase (child_iterator pos)
	Removes element at position `pos`. If `pos` is 'end', then result is undefined.

child_iterator	erase (child_iterator pos, child_iterator end)
	erases all elements from `pos` to `end` (excluding `end`)

	Forest ()

	Forest (const Forest< T > &rhs)

template<typename X >
child_iterator	insert (child_iterator pos, X &&value)
	Inserts element `value` into position `pos`. `value` becomes the child of the same parent as `pos` and is placed right before `pos`.

child_iterator	move (child_iterator subtree, child_iterator newPos)
	move a subtree to new position Moves `subtree` into a new position pointer by `newPos`. `newPos` must not be inside the subtree, otherwise cycling links may appear.

Forest< T > &	operator= (const Forest< T > &rhs)

child_iterator	parentEnd ()

const_child_iterator	parentEnd () const

void	swap (Forest &other)

	~Forest ()

Private Member Functions
void	cloneChildren (const_child_iterator oldParent, child_iterator parent)

void	linkAfter (Node< T > node, Node< T > afterMe)

void	linkBefore (Node< T > node, Node< T > beforeMe)

void	linkNode (child_iterator pos, Node< T > *node)

void	unlinkNode (Node< T > *node)

Static Private Member Functions
template<class ForestType , class IteratorType = DepthFirstIterator<typename ForestType::value_type, Enter, std::is_const_v<ForestType>>>
static IteratorType	beginImpl (ForestType &forest)

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>
static IteratorType	childBeginImpl (ForestType &forest)

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>
static IteratorType	childEndImpl (ForestType &forest)

template<class ForestType , class IteratorType = CompositionIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>
static IteratorType	compositionBeginImpl (ForestType &forest)

template<class ForestType , class IteratorType = CompositionIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>
static IteratorType	compositionEndImpl (ForestType &forest)

template<class ForestType , class IteratorType = DepthFirstIterator<typename ForestType::value_type, Enter, std::is_const_v<ForestType>>>
static IteratorType	endImpl (ForestType &forest)

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>
static IteratorType	parentEndImpl (ForestType &forest)

Private Attributes
RootNode< T >	m_root

Detailed Description

template<typename T>
class KisForestDetail::Forest< T >

Forest implements a container for composing tree-like structures from arbitrary objects.

All add/remove operations are implemented via child_iterator. You can convert any iterator type into a child iterator via siblingCurrent() function.

// Forest:

//

// 0 1

// 2

// 3 5 6

// 7

// 4

// 8 9

// 10

KisForest<int> forest;

auto it0 = forest.insert(childBegin(forest), 0);

auto it8 = forest.insert(childEnd(forest), 8);

auto it1 = forest.insert(childEnd(it0), 1);

auto it2 = forest.insert(childEnd(it0), 2);

auto it3 = forest.insert(childEnd(it0), 3);

auto it4 = forest.insert(childEnd(it0), 4);

auto it5 = forest.insert(childEnd(it3), 5);

auto it6 = forest.insert(childEnd(it5), 6);

auto it7 = forest.insert(childEnd(it5), 7);

auto it9 = forest.insert(childEnd(it8), 9);

auto it10 = forest.insert(childEnd(it8), 10);

// iterate through all elements of the forest

for (auto it = subtreeBegin(forest); it != subtreeEnd(forest); ++it) {

qDebug() << *it << it.state();

}

// prints: 0,1,2,3,5,6,7,4,8,9,10

KisForestDetail::Forest
Definition KisForest.h:777

KisForestDetail::Forest::childEnd
child_iterator childEnd()
Definition KisForest.h:880

KisForestDetail::Forest::insert
child_iterator insert(child_iterator pos, X &&value)
Inserts element value into position pos. value becomes the child of the same parent as pos and is pla...
Definition KisForest.h:943

KisForestDetail::Forest::childBegin
child_iterator childBegin()
Definition KisForest.h:876

KisForestDetail::subtreeBegin
ResultIterator subtreeBegin(Iterator it)
Definition KisForest.h:688

KisForestDetail::subtreeEnd
ResultIterator subtreeEnd(Iterator it)
Definition KisForest.h:696

Definition at line 776 of file KisForest.h.

Member Typedef Documentation

◆ child_iterator

template<typename T >

using KisForestDetail::Forest< T >::child_iterator = ChildIterator<T, false>

Definition at line 805 of file KisForest.h.

◆ composition_iterator

template<typename T >

using KisForestDetail::Forest< T >::composition_iterator = CompositionIterator<T, false>

Definition at line 808 of file KisForest.h.

◆ const_child_iterator

template<typename T >

using KisForestDetail::Forest< T >::const_child_iterator = ChildIterator<T, true>

Definition at line 806 of file KisForest.h.

◆ const_composition_iterator

template<typename T >

using KisForestDetail::Forest< T >::const_composition_iterator = CompositionIterator<T, true>

Definition at line 809 of file KisForest.h.

◆ const_depth_first_tail_iterator

template<typename T >

using KisForestDetail::Forest< T >::const_depth_first_tail_iterator = DepthFirstIterator<T, Leave, true>

Definition at line 818 of file KisForest.h.

◆ const_hierarchy_iterator

template<typename T >

using KisForestDetail::Forest< T >::const_hierarchy_iterator = HierarchyIterator<T, true>

Definition at line 812 of file KisForest.h.

◆ const_iterator

template<typename T >

using KisForestDetail::Forest< T >::const_iterator = DepthFirstIterator<T, Enter, true>

Definition at line 815 of file KisForest.h.

◆ depth_first_tail_iterator

template<typename T >

using KisForestDetail::Forest< T >::depth_first_tail_iterator = DepthFirstIterator<T, Leave, false>

Definition at line 817 of file KisForest.h.

◆ hierarchy_iterator

template<typename T >

using KisForestDetail::Forest< T >::hierarchy_iterator = HierarchyIterator<T, false>

Definition at line 811 of file KisForest.h.

◆ iterator

template<typename T >

using KisForestDetail::Forest< T >::iterator = DepthFirstIterator<T, Enter, false>

Definition at line 814 of file KisForest.h.

◆ value_type

template<typename T >

using KisForestDetail::Forest< T >::value_type = T

Definition at line 803 of file KisForest.h.

Constructor & Destructor Documentation

◆ Forest() [1/2]

template<typename T >

KisForestDetail::Forest< T >::Forest ( )

inline

Definition at line 779 of file KisForest.h.

780 {

781 }

◆ ~Forest()

template<typename T >

KisForestDetail::Forest< T >::~Forest ( )

inline

Definition at line 783 of file KisForest.h.

              {
        erase(childBegin(), childEnd());
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), and KisForestDetail::Forest< T >::erase().

◆ Forest() [2/2]

template<typename T >

KisForestDetail::Forest< T >::Forest ( const Forest< T > & rhs )

inline

Definition at line 787 of file KisForest.h.

                                 {
        for (auto it = rhs.childBegin(); it != rhs.childEnd(); ++it) {
            auto cloneIt = this->insert(this->childEnd(), *it);
            cloneChildren(it, cloneIt);
        }
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), KisForestDetail::Forest< T >::cloneChildren(), and KisForestDetail::Forest< T >::insert().

Member Function Documentation

◆ begin() [1/2]

template<typename T >

iterator KisForestDetail::Forest< T >::begin ( )

inline

Definition at line 828 of file KisForest.h.

                     {
        return beginImpl(*this);
    }

References KisForestDetail::Forest< T >::beginImpl().

◆ begin() [2/2]

template<typename T >

const_iterator KisForestDetail::Forest< T >::begin ( ) const

inline

Definition at line 836 of file KisForest.h.

                                 {
        return beginImpl(*this);
    }

References KisForestDetail::Forest< T >::beginImpl().

◆ beginImpl()

template<typename T >

template<class ForestType , class IteratorType = DepthFirstIterator<typename ForestType::value_type, Enter, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::beginImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1105 of file KisForest.h.

                                                      {
        return IteratorType(forest.m_root.firstChild);
    }

◆ childBegin() [1/2]

template<typename T >

child_iterator KisForestDetail::Forest< T >::childBegin ( )

inline

Definition at line 876 of file KisForest.h.

                                {
        return childBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::childBeginImpl().

◆ childBegin() [2/2]

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::childBegin ( ) const

inline

Definition at line 888 of file KisForest.h.

                                            {
        return childBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::childBeginImpl().

◆ childBeginImpl()

template<typename T >

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::childBeginImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1083 of file KisForest.h.

                                                           {
        return IteratorType(forest.m_root.firstChild, &forest.m_root, 0);
    }

◆ childEnd() [1/2]

template<typename T >

child_iterator KisForestDetail::Forest< T >::childEnd ( )

inline

Definition at line 880 of file KisForest.h.

                              {
        return childEndImpl(*this);
    }

References KisForestDetail::Forest< T >::childEndImpl().

◆ childEnd() [2/2]

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::childEnd ( ) const

inline

Definition at line 892 of file KisForest.h.

                                          {
        return childEndImpl(*this);
    }

References KisForestDetail::Forest< T >::childEndImpl().

◆ childEndImpl()

template<typename T >

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::childEndImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1090 of file KisForest.h.

                                                         {
        return IteratorType(nullptr, &forest.m_root, 0);
    }

◆ cloneChildren()

template<typename T >

void KisForestDetail::Forest< T >::cloneChildren	(	const_child_iterator	oldParent,
		child_iterator	parent )

inlineprivate

Definition at line 1070 of file KisForest.h.

                                                                              {
        auto it = KisForestDetail::childBegin(oldParent);
        auto end = KisForestDetail::childEnd(oldParent);
        for (;it != end; ++it) {
            auto itClone = this->insert(KisForestDetail::childEnd(parent), *it);
            cloneChildren(it, itClone);
        }
    }

References KisForestDetail::childBegin(), KisForestDetail::childEnd(), KisForestDetail::Forest< T >::cloneChildren(), KisForestDetail::Forest< T >::end(), and KisForestDetail::Forest< T >::insert().

◆ compositionBegin() [1/2]

template<typename T >

composition_iterator KisForestDetail::Forest< T >::compositionBegin ( )

inline

Definition at line 912 of file KisForest.h.

                                            {
        return compositionBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionBeginImpl().

◆ compositionBegin() [2/2]

template<typename T >

const_composition_iterator KisForestDetail::Forest< T >::compositionBegin ( ) const

inline

Definition at line 920 of file KisForest.h.

                                                        {
        return compositionBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionBeginImpl().

◆ compositionBeginImpl()

template<typename T >

template<class ForestType , class IteratorType = CompositionIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::compositionBeginImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1121 of file KisForest.h.

                                                                 {
        return IteratorType(forest.m_root.firstChild);
    }

◆ compositionEnd() [1/2]

template<typename T >

composition_iterator KisForestDetail::Forest< T >::compositionEnd ( )

inline

Definition at line 916 of file KisForest.h.

                                          {
        return compositionEndImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionEndImpl().

◆ compositionEnd() [2/2]

template<typename T >

const_composition_iterator KisForestDetail::Forest< T >::compositionEnd ( ) const

inline

Definition at line 924 of file KisForest.h.

                                                      {
        return compositionEndImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionEndImpl().

◆ compositionEndImpl()

template<typename T >

template<class ForestType , class IteratorType = CompositionIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::compositionEndImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1128 of file KisForest.h.

                                                               {
        Q_UNUSED(forest);
        return IteratorType(nullptr);
    }

◆ constBegin()

template<typename T >

const_iterator KisForestDetail::Forest< T >::constBegin ( ) const

inline

Definition at line 844 of file KisForest.h.

                                      {
        return beginImpl(*this);
    }

References KisForestDetail::Forest< T >::beginImpl().

◆ constChildBegin()

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::constChildBegin ( ) const

inline

Definition at line 900 of file KisForest.h.

                                                 {
        return childBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::childBeginImpl().

◆ constChildEnd()

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::constChildEnd ( ) const

inline

Definition at line 904 of file KisForest.h.

                                               {
        return childEndImpl(*this);
    }

References KisForestDetail::Forest< T >::childEndImpl().

◆ constCompositionBegin()

template<typename T >

const_composition_iterator KisForestDetail::Forest< T >::constCompositionBegin ( ) const

inline

Definition at line 928 of file KisForest.h.

                                                             {
        return compositionBeginImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionBeginImpl().

◆ constCompositionEnd()

template<typename T >

const_composition_iterator KisForestDetail::Forest< T >::constCompositionEnd ( ) const

inline

Definition at line 932 of file KisForest.h.

                                                           {
        return compositionEndImpl(*this);
    }

References KisForestDetail::Forest< T >::compositionEndImpl().

◆ constDepthFirstTailBegin()

template<typename T >

const_depth_first_tail_iterator KisForestDetail::Forest< T >::constDepthFirstTailBegin ( ) const

inline

Definition at line 868 of file KisForest.h.

                                                                     {
        return tailSubtreeBegin(constBegin());
    }

References KisForestDetail::Forest< T >::constBegin(), and KisForestDetail::tailSubtreeBegin().

◆ constDepthFirstTailEnd()

template<typename T >

const_depth_first_tail_iterator KisForestDetail::Forest< T >::constDepthFirstTailEnd ( ) const

inline

Definition at line 872 of file KisForest.h.

                                                                   {
        return tailSubtreeEnd(constEnd());
    }

References KisForestDetail::Forest< T >::constEnd(), and KisForestDetail::tailSubtreeEnd().

◆ constEnd()

template<typename T >

const_iterator KisForestDetail::Forest< T >::constEnd ( ) const

inline

Definition at line 848 of file KisForest.h.

                                    {
        return endImpl(*this);
    }

References KisForestDetail::Forest< T >::endImpl().

◆ constParentEnd()

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::constParentEnd ( ) const

inline

Definition at line 908 of file KisForest.h.

                                                {
        return parentEndImpl(*this);
    }

References KisForestDetail::Forest< T >::parentEndImpl().

◆ depthFirstTailBegin() [1/2]

template<typename T >

depth_first_tail_iterator KisForestDetail::Forest< T >::depthFirstTailBegin ( )

inline

Definition at line 852 of file KisForest.h.

                                                    {
        return tailSubtreeBegin(begin());
    }

References KisForestDetail::Forest< T >::begin(), and KisForestDetail::tailSubtreeBegin().

◆ depthFirstTailBegin() [2/2]

template<typename T >

const_depth_first_tail_iterator KisForestDetail::Forest< T >::depthFirstTailBegin ( ) const

inline

Definition at line 860 of file KisForest.h.

                                                                {
        return tailSubtreeBegin(constBegin());
    }

References KisForestDetail::Forest< T >::constBegin(), and KisForestDetail::tailSubtreeBegin().

◆ depthFirstTailEnd() [1/2]

template<typename T >

depth_first_tail_iterator KisForestDetail::Forest< T >::depthFirstTailEnd ( )

inline

Definition at line 856 of file KisForest.h.

                                                  {
        return tailSubtreeEnd(end());
    }

References KisForestDetail::Forest< T >::end(), and KisForestDetail::tailSubtreeEnd().

◆ depthFirstTailEnd() [2/2]

template<typename T >

const_depth_first_tail_iterator KisForestDetail::Forest< T >::depthFirstTailEnd ( ) const

inline

Definition at line 864 of file KisForest.h.

                                                              {
        return tailSubtreeEnd(constEnd());
    }

References KisForestDetail::Forest< T >::constEnd(), and KisForestDetail::tailSubtreeEnd().

◆ empty()

template<typename T >

bool KisForestDetail::Forest< T >::empty ( ) const

inline

Definition at line 820 of file KisForest.h.

                       {
        return !m_root.firstChild;
    }

References KisForestDetail::Forest< T >::m_root.

◆ end() [1/2]

template<typename T >

iterator KisForestDetail::Forest< T >::end ( )

inline

Definition at line 832 of file KisForest.h.

                   {
        return endImpl(*this);
    }

References KisForestDetail::Forest< T >::endImpl().

◆ end() [2/2]

template<typename T >

const_iterator KisForestDetail::Forest< T >::end ( ) const

inline

Definition at line 840 of file KisForest.h.

                               {
        return endImpl(*this);
    }

References KisForestDetail::Forest< T >::endImpl().

◆ endImpl()

template<typename T >

template<class ForestType , class IteratorType = DepthFirstIterator<typename ForestType::value_type, Enter, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::endImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1113 of file KisForest.h.

                                                    {
        Q_UNUSED(forest);
        return IteratorType(nullptr);
    }

◆ erase() [1/2]

template<typename T >

child_iterator KisForestDetail::Forest< T >::erase ( child_iterator pos )

inline

Removes element at position pos. If pos is 'end', then result is undefined.

Returns: the element following pos

Definition at line 956 of file KisForest.h.

                                             {
        child_iterator nextNode = std::next(pos);
        Node<T> *node = pos.node();
 
        Node<T> *lastNode = node;
        for (auto it = tailSubtreeBegin(pos); it != tailSubtreeEnd(pos); ++it) {
 
            if (lastNode != node) {
                delete lastNode;
            }
            lastNode = it.node();
        }
 
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(lastNode == node, pos);
 
        unlinkNode(node);
        delete node;
 
        return nextNode;
    }

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisForestDetail::BaseIterator< BaseClass, T, Tag, is_const >::node(), KisForestDetail::tailSubtreeBegin(), KisForestDetail::tailSubtreeEnd(), and KisForestDetail::Forest< T >::unlinkNode().

◆ erase() [2/2]

template<typename T >

child_iterator KisForestDetail::Forest< T >::erase	(	child_iterator	pos,
		child_iterator	end )

inline

erases all elements from pos to end (excluding end)

Returns: end

Definition at line 981 of file KisForest.h.

                                                                 {
        while (pos != end) {
            pos = erase(pos);
        }
        return pos;
    }

References KisForestDetail::Forest< T >::erase().

◆ insert()

template<typename T >

template<typename X >

child_iterator KisForestDetail::Forest< T >::insert	(	child_iterator	pos,
		X &&	value )

inline

Inserts element value into position pos. value becomes the child of the same parent as pos and is placed right before pos.

Returns: iterator pointing to the inserted element

Definition at line 943 of file KisForest.h.

                                                         {
        Node<T> *node = new Node<T>(std::forward<X>(value));
 
        linkNode(pos, node);
 
        return child_iterator(node, node->parent, 0);
    }

References KisForestDetail::Forest< T >::linkNode(), KisForestDetail::RootNodeImpl< Base >::parent, and value().

◆ linkAfter()

template<typename T >

void KisForestDetail::Forest< T >::linkAfter	(	Node< T > *	node,
		Node< T > *	afterMe )

inlineprivate

Definition at line 1020 of file KisForest.h.

                                                           {
        if (afterMe) {
            node->prevSibling = afterMe;
            afterMe->nextSibling = node;
        }
    }

References KisForestDetail::BaseNode< Base >::nextSibling, and KisForestDetail::BaseNode< Base >::prevSibling.

◆ linkBefore()

template<typename T >

void KisForestDetail::Forest< T >::linkBefore	(	Node< T > *	node,
		Node< T > *	beforeMe )

inlineprivate

Definition at line 1013 of file KisForest.h.

                                                             {
        if (beforeMe) {
            node->nextSibling = beforeMe;
            beforeMe->prevSibling = node;
        }
    }

References KisForestDetail::BaseNode< Base >::nextSibling, and KisForestDetail::BaseNode< Base >::prevSibling.

◆ linkNode()

template<typename T >

void KisForestDetail::Forest< T >::linkNode	(	child_iterator	pos,
		Node< T > *	node )

inlineprivate

Definition at line 1027 of file KisForest.h.

                                                            {
        Node<T> *nextNode = pos.node();
        RootNode<T> *parentNode = pos.m_parent;
 
        Node<T> *prevNode = nextNode ?
                            nextNode->prevSibling :
                            parentNode ? parentNode->lastChild : m_root.lastChild;
 
        linkAfter(node, prevNode);
        linkBefore(node, nextNode);
 
        KIS_SAFE_ASSERT_RECOVER_RETURN(parentNode);
        if (!nextNode) {
            parentNode->lastChild = node;
        }
 
        if (nextNode == parentNode->firstChild) {
            parentNode->firstChild = node;
        }
        node->parent = parentNode;
    }

References KisForestDetail::RootNodeImpl< Base >::firstChild, KIS_SAFE_ASSERT_RECOVER_RETURN, KisForestDetail::RootNodeImpl< Base >::lastChild, KisForestDetail::Forest< T >::linkAfter(), KisForestDetail::Forest< T >::linkBefore(), KisForestDetail::ChildIterator< T, is_const >::m_parent, KisForestDetail::Forest< T >::m_root, KisForestDetail::BaseIterator< BaseClass, T, Tag, is_const >::node(), KisForestDetail::RootNodeImpl< Base >::parent, and KisForestDetail::BaseNode< Base >::prevSibling.

◆ move()

template<typename T >

child_iterator KisForestDetail::Forest< T >::move	(	child_iterator	subtree,
		child_iterator	newPos )

inline

move a subtree to new position Moves subtree into a new position pointer by newPos. newPos must not be inside the subtree, otherwise cycling links may appear.

Returns: iterator to a new position of subtree

Definition at line 994 of file KisForest.h.

                                                                       {
        // sanity check for cycling move
        for (auto it = hierarchyBegin(newPos); it != hierarchyEnd(newPos); ++it) {
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(it.node() != subtree.node(), subtree);
        }
 
        Node<T> *node = subtree.node();
        unlinkNode(node);
 
        node->prevSibling = nullptr;
        node->nextSibling = nullptr;
        node->parent = nullptr;
 
        linkNode(newPos, node);
        return child_iterator(node, node->parent, 0);
    }

References KisForestDetail::hierarchyBegin(), KisForestDetail::hierarchyEnd(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisForestDetail::Forest< T >::linkNode(), KisForestDetail::BaseNode< Base >::nextSibling, KisForestDetail::BaseIterator< BaseClass, T, Tag, is_const >::node(), KisForestDetail::RootNodeImpl< Base >::parent, KisForestDetail::BaseNode< Base >::prevSibling, and KisForestDetail::Forest< T >::unlinkNode().

◆ operator=()

template<typename T >

Forest< T > & KisForestDetail::Forest< T >::operator= ( const Forest< T > & rhs )

inline

Definition at line 794 of file KisForest.h.

                                               {
        erase(childBegin(), childEnd());
        for (auto it = rhs.childBegin(); it != rhs.childEnd(); ++it) {
            auto cloneIt = this->insert(this->childEnd(), *it);
            cloneChildren(it, cloneIt);
        }
        return *this;
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), KisForestDetail::Forest< T >::cloneChildren(), KisForestDetail::Forest< T >::erase(), and KisForestDetail::Forest< T >::insert().

◆ parentEnd() [1/2]

template<typename T >

child_iterator KisForestDetail::Forest< T >::parentEnd ( )

inline

Definition at line 884 of file KisForest.h.

                               {
        return parentEndImpl(*this);
    }

References KisForestDetail::Forest< T >::parentEndImpl().

◆ parentEnd() [2/2]

template<typename T >

const_child_iterator KisForestDetail::Forest< T >::parentEnd ( ) const

inline

Definition at line 896 of file KisForest.h.

                                           {
        return parentEndImpl(*this);
    }

References KisForestDetail::Forest< T >::parentEndImpl().

◆ parentEndImpl()

template<typename T >

template<class ForestType , class IteratorType = ChildIterator<typename ForestType::value_type, std::is_const_v<ForestType>>>

static IteratorType KisForestDetail::Forest< T >::parentEndImpl ( ForestType & forest )

inlinestaticprivate

Definition at line 1097 of file KisForest.h.

                                                          {
        return IteratorType(nullptr, &forest.m_root, -1);
    }

◆ swap()

template<typename T >

void KisForestDetail::Forest< T >::swap ( Forest< T > & other )

inline

Definition at line 824 of file KisForest.h.

                             {
        std::swap(m_root, other.m_root);
    }

References KisForestDetail::Forest< T >::m_root.

◆ unlinkNode()

template<typename T >

void KisForestDetail::Forest< T >::unlinkNode ( Node< T > * node )

inlineprivate

Definition at line 1049 of file KisForest.h.

                                          {
        RootNode<T> *parentNode = node->parent;
 
        if (node->nextSibling) {
            node->nextSibling->prevSibling = node->prevSibling;
        }
 
        if (node->prevSibling) {
            node->prevSibling->nextSibling = node->nextSibling;
        }
 
        KIS_SAFE_ASSERT_RECOVER_RETURN(parentNode);
        if (parentNode->firstChild == node) {
            parentNode->firstChild = node->nextSibling;
        }
 
        if (parentNode->lastChild == node) {
            parentNode->lastChild = node->prevSibling;
        }
    }

References KisForestDetail::RootNodeImpl< Base >::firstChild, KIS_SAFE_ASSERT_RECOVER_RETURN, KisForestDetail::RootNodeImpl< Base >::lastChild, KisForestDetail::BaseNode< Base >::nextSibling, KisForestDetail::RootNodeImpl< Base >::parent, and KisForestDetail::BaseNode< Base >::prevSibling.

Member Data Documentation

◆ m_root

template<typename T >

RootNode<T> KisForestDetail::Forest< T >::m_root

private

Definition at line 1134 of file KisForest.h.

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

libs/global/KisForest.h

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ child_iterator

◆ composition_iterator

◆ const_child_iterator

◆ const_composition_iterator

◆ const_depth_first_tail_iterator

◆ const_hierarchy_iterator

◆ const_iterator

◆ depth_first_tail_iterator

◆ hierarchy_iterator

◆ iterator

◆ value_type

Constructor & Destructor Documentation

◆ Forest() [1/2]

◆ ~Forest()

◆ Forest() [2/2]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ beginImpl()

◆ childBegin() [1/2]

◆ childBegin() [2/2]

◆ childBeginImpl()

◆ childEnd() [1/2]

◆ childEnd() [2/2]

◆ childEndImpl()

◆ cloneChildren()

◆ compositionBegin() [1/2]

◆ compositionBegin() [2/2]

◆ compositionBeginImpl()

◆ compositionEnd() [1/2]

◆ compositionEnd() [2/2]

◆ compositionEndImpl()

◆ constBegin()

◆ constChildBegin()

◆ constChildEnd()

◆ constCompositionBegin()

◆ constCompositionEnd()

◆ constDepthFirstTailBegin()

◆ constDepthFirstTailEnd()

◆ constEnd()

◆ constParentEnd()

◆ depthFirstTailBegin() [1/2]

◆ depthFirstTailBegin() [2/2]

◆ depthFirstTailEnd() [1/2]

◆ depthFirstTailEnd() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ endImpl()

◆ erase() [1/2]

◆ erase() [2/2]

◆ insert()

◆ linkAfter()

◆ linkBefore()

◆ linkNode()

◆ move()

◆ operator=()

◆ parentEnd() [1/2]

◆ parentEnd() [2/2]

◆ parentEndImpl()

◆ swap()

◆ unlinkNode()

Member Data Documentation

◆ m_root