pg_tree.h

/*
    Copyright (c) 2007-2009 Takashi Kitao
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    1. Redistributions of source code must retain the above copyright
    `  notice, this list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright
    `  notice, this list of conditions and the following disclaimer in the
    `  documentation and/or other materials provided with the distribution.

    3. The name of the author may not be used to endorse or promote products
    `  derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


template<class T> class pgTree
{
public:
    pgDefineException(ExceptionInvalidArgument);
    pgDefineException(ExceptionInvalidCall);
    pgDefineException(ExceptionNotInitialized);

    pgTree()
    {
        m_self = NULL;
        m_parent = NULL;
        m_last_child = NULL;
        m_prev = m_next = NULL;
    }

    ~pgTree()
    {
        leave();
        clear();
    }

    void init(T* self)
    {
        if (!self)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        m_self = self;
    }

    T* getSelf() const
    {
        if (!m_self)
        {
            pgThrow(ExceptionNotInitialized);
        }

        return m_self;
    }

    bool hasParent() const
    {
        return m_parent ? true : false;
    }

    pgTree<T>* getParentN() const
    {
        return m_parent;
    }

    pgTree<T>* getPrevAllN() const
    {
        return m_prev;
    }

    pgTree<T>* getNextAllN() const
    {
        return m_next;
    }

    pgTree<T>* getPrevSiblingN() const
    {
        if (!hasParent())
        {
            pgThrow(ExceptionInvalidCall);
        }

        if (m_prev != m_parent)
        {
            pgTree<T>* prev = m_prev;

            while (prev->m_parent != m_parent)
            {
                prev = prev->m_parent;
            }

            return prev;
        }
        else
        {
            return NULL;
        }
    }

    pgTree<T>* getNextSiblingN() const
    {
        if (!hasParent())
        {
            pgThrow(ExceptionInvalidCall);
        }

        pgTree<T>* desc = getLastDesc();
        pgTree<T>* next = desc->m_next;

        return (next && next->m_parent == m_parent) ? next : NULL;
    }

    void joinBefore(pgTree<T>* tree)
    {
        if (!tree || tree == this || !tree->hasParent())
        {
            pgThrow(ExceptionInvalidArgument);
        }

        for (pgTree<T>* parent = tree->m_parent; parent; parent = parent->m_parent)
        {
            if (parent == this)
            {
                pgThrow(ExceptionInvalidArgument);
            }
        }

        leave();

        pgTree<T>* desc = getLastDesc();

        m_parent = tree->m_parent;
        m_prev = tree->m_prev;
        desc->m_next = tree;

        m_prev->m_next = this;
        desc->m_next->m_prev = desc;
    }

    void joinAfter(pgTree<T>* tree)
    {
        if (!tree || tree == this || !tree->hasParent())
        {
            pgThrow(ExceptionInvalidArgument);
        }

        for (pgTree<T>* parent = tree->m_parent; parent; parent = parent->m_parent)
        {
            if (parent == this)
            {
                pgThrow(ExceptionInvalidArgument);
            }
        }

        leave();

        pgTree<T>* tree_desc = tree->getLastDesc();
        pgTree<T>* this_desc = getLastDesc();

        m_parent = tree->m_parent;
        m_prev = tree_desc;
        this_desc->m_next = tree_desc->m_next;

        m_prev->m_next = this;

        if (this_desc->m_next)
        {
            this_desc->m_next->m_prev = this_desc;
        }

        if (m_parent->m_last_child == tree)
        {
            m_parent->m_last_child = this;
        }
    }

    void leave()
    {
        if (hasParent())
        {
            pgTree<T>* desc = getLastDesc();

            if (m_parent->m_last_child == this)
            {
                m_parent->m_last_child = getPrevSiblingN();
            }

            m_prev->m_next = desc->m_next;

            if (desc->m_next)
            {
                desc->m_next->m_prev = m_prev;
            }

            m_parent = NULL;
            m_prev = desc->m_next = NULL;
        }
    }

    bool hasChild() const
    {
        return m_last_child ? true : false;
    }

    pgTree<T>* getFirstChildN() const
    {
        return hasChild() ? m_next : NULL;
    }

    pgTree<T>* getLastChildN() const
    {
        return m_last_child;
    }

    pgTree<T>* getLastDesc() const
    {
        pgTree<T>* desc = const_cast<pgTree<T>*>(this);

        while (desc->m_last_child)
        {
            desc = desc->m_last_child;
        }

        return desc;
    }

    void addFirst(pgTree<T>* child)
    {
        if (!child || child == this)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        for (pgTree<T>* parent = m_parent; parent; parent = parent->m_parent)
        {
            if (parent == child)
            {
                pgThrow(ExceptionInvalidArgument);
            }
        }

        child->leave();

        pgTree<T>* child_desc = child->getLastDesc();

        child->m_parent = this;
        child->m_prev = this;
        child_desc->m_next = m_next;

        child->m_prev->m_next = child;

        if (child_desc->m_next)
        {
            child_desc->m_next->m_prev = child_desc;
        }

        if (!m_last_child)
        {
            m_last_child = child;
        }
    }

    void addLast(pgTree<T>* child)
    {
        if (!child || child == this)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        for (pgTree<T>* parent = m_parent; parent; parent = parent->m_parent)
        {
            if (parent == child)
            {
                pgThrow(ExceptionInvalidArgument);
            }
        }

        child->leave();

        pgTree<T>* this_desc = getLastDesc();
        pgTree<T>* child_desc = child->getLastDesc();

        child->m_parent = this;
        child->m_prev = this_desc;
        child_desc->m_next = this_desc->m_next;

        child->m_prev->m_next = child;

        if (child_desc->m_next)
        {
            child_desc->m_next->m_prev = child_desc;
        }

        m_last_child = child;
    }

    void clear()
    {
        while (hasChild())
        {
            getFirstChildN()->leave();
        }
    }

private:
    pgTree(const pgTree<T>&) {}
    void operator=(const pgTree<T>&) {}

    T* m_self;
    pgTree<T>* m_parent;
    pgTree<T>* m_last_child;
    pgTree<T>* m_prev;
    pgTree<T>* m_next;
};

---