list.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef COMMON_LIST_H
#define COMMON_LIST_H

#include "common/list_intern.h"

namespace Common {

template<typename t_T>
class List {
protected:
    typedef ListInternal::NodeBase      NodeBase; 
    typedef ListInternal::Node<t_T>     Node;     
    NodeBase _anchor; 
public:
    typedef ListInternal::Iterator<t_T>     iterator; 
    typedef ListInternal::ConstIterator<t_T>    const_iterator; 
    typedef t_T value_type; 
    typedef uint size_type; 
public:
    constexpr List() : _anchor(&_anchor, &_anchor) {}
    List(const List<t_T> &list) {  
        _anchor._prev = &_anchor;
        _anchor._next = &_anchor;

        insert(begin(), list.begin(), list.end());
    }

    ~List() {
        clear();
    }

    template<class... TArgs>
    iterator emplace(iterator pos, TArgs &&...args) {
        emplace(pos._node, Common::forward<TArgs>(args)...);
        return --pos;
    }

    iterator insert(iterator pos, const t_T &element) {
        insert(pos._node, element);
        return --pos;
    }

    iterator insert(iterator pos, t_T &&element) {
        insert(pos._node, Common::move(element));
        return --pos;
    }

    template<typename iterator2>
    void insert(iterator pos, iterator2 first, iterator2 last) {
        for (; first != last; ++first)
            insert(pos, *first);
    }

    iterator erase(iterator pos) {
        assert(pos != end());
        return iterator(erase(pos._node)._next);
    }

    iterator reverse_erase(iterator pos) {
        assert(pos != end());
        return iterator(erase(pos._node)._prev);
    }

    iterator erase(iterator first, iterator last) {
        NodeBase *f = first._node;
        NodeBase *l = last._node;
        while (f != l)
            f = erase(f)._next;
        return last;
    }

    void remove(const t_T &val) {
        NodeBase *i = _anchor._next;
        while (i != &_anchor)
            if (val == static_cast<Node *>(i)->_data)
                i = erase(i)._next;
            else
                i = i->_next;
    }

    template<class... TArgs>
    void emplace_front(TArgs &&...args) {
        emplace(_anchor._next, Common::forward<TArgs>(args)...);
    }

    void push_front(const t_T &element) {
        insert(_anchor._next, element);
    }

    void push_front(t_T &&element) {
        insert(_anchor._next, Common::move(element));
    }

    template<class... TArgs>
    void emplace_back(TArgs &&...args) {
        emplace(&_anchor, Common::forward<TArgs>(args)...);
    }

    void push_back(const t_T &element) {
        insert(&_anchor, element);
    }

    void push_back(t_T &&element) {
        insert(&_anchor, Common::move(element));
    }

    void pop_front() {
        assert(!empty());
        erase(_anchor._next);
    }

    void pop_back() {
        assert(!empty());
        erase(_anchor._prev);
    }

    t_T &front() {
        return static_cast<Node *>(_anchor._next)->_data;
    }

    const t_T &front() const {
        return static_cast<Node *>(_anchor._next)->_data;
    }

    t_T &back() {
        return static_cast<Node *>(_anchor._prev)->_data;
    }

    const t_T &back() const {
        return static_cast<Node *>(_anchor._prev)->_data;
    }

    List<t_T> &operator=(const List<t_T> &list) {
        if (this != &list) {
            iterator i;
            const iterator e = end();
            const_iterator i2;
            const_iterator e2 = list.end();

            for (i = begin(), i2 = list.begin(); (i != e) && (i2 != e2); ++i, ++i2) {
                static_cast<Node *>(i._node)->_data = static_cast<const Node *>(i2._node)->_data;
            }

            if (i == e)
                insert(i, i2, e2);
            else
                erase(i, e);
        }

        return *this;
    }

    size_type size() const {
        size_type n = 0;
        for (const NodeBase *cur = _anchor._next; cur != &_anchor; cur = cur->_next)
            ++n;
        return n;
    }

    void clear() {
        NodeBase *pos = _anchor._next;
        while (pos != &_anchor) {
            Node *node = static_cast<Node *>(pos);
            pos = pos->_next;
            delete node;
        }

        _anchor._prev = &_anchor;
        _anchor._next = &_anchor;
    }

    bool empty() const {
        return (&_anchor == _anchor._next);
    }

    iterator        begin() {
        return iterator(_anchor._next);
    }

    iterator        reverse_begin() {
        return iterator(_anchor._prev);
    }

    iterator        end() {
        return iterator(&_anchor);
    }

    const_iterator  begin() const {
        return const_iterator(_anchor._next);
    }

    const_iterator  reverse_begin() const {
        return const_iterator(_anchor._prev);
    }

    const_iterator  end() const {
        return const_iterator(const_cast<NodeBase *>(&_anchor));
    }

protected:
    NodeBase erase(NodeBase *pos) {
        NodeBase n = *pos;
        Node *node = static_cast<Node *>(pos);
        n._prev->_next = n._next;
        n._next->_prev = n._prev;
        delete node;
        return n;
    }

    template<class... TArgs>
    void emplace(NodeBase *pos, TArgs&&... args) {
        ListInternal::NodeBase *newNode = new Node(Common::forward<TArgs>(args)...);
        assert(newNode);

        newNode->_next = pos;
        newNode->_prev = pos->_prev;
        newNode->_prev->_next = newNode;
        newNode->_next->_prev = newNode;
    }

    void insert(NodeBase *pos, const t_T &element) {
        ListInternal::NodeBase *newNode = new Node(element);
        assert(newNode);

        newNode->_next = pos;
        newNode->_prev = pos->_prev;
        newNode->_prev->_next = newNode;
        newNode->_next->_prev = newNode;
    }

    void insert(NodeBase *pos, t_T &&element) {
        ListInternal::NodeBase *newNode = new Node(Common::move(element));
        assert(newNode);

        newNode->_next = pos;
        newNode->_prev = pos->_prev;
        newNode->_prev->_next = newNode;
        newNode->_next->_prev = newNode;
    }
};

} // End of namespace Common

#endif