/*
Copyright (c) 2015 Timur Gafarov 

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/

module dgl.util.linkedlist;

import dlib.core.memory;

public:

struct LinkedListElement(T)
{
    LinkedListElement!(T)* next = null;
    T datum;

    this(LinkedListElement!(T)* n)
    {
        next = n;
        datum = T.init;
    }
}

struct LinkedList(T, bool ordered = true)
{
    LinkedListElement!(T)* head = null;
    LinkedListElement!(T)* tail = null;
    size_t length = 0;

    @property bool empty()
    {
        return length == 0;
    }

    void clear()
    {
        LinkedListElement!(T)* element = head;
        while (element !is null)
        {
            auto e = element;
            element = element.next;
            Delete(e);
        }
        head = null;
        tail = null;
        length = 0;
    }

    void traverse(void delegate(ref T v, LinkedListElement!(T)* elem) func)
    {
        LinkedListElement!(T)* element = head;
        while (element !is null)
        {
            func(element.datum, element);
            element = element.next;
        }
    }

    int opApply(int delegate(uint, ref T) dg)
    {
        int result = 0;
        uint index = 0;

        LinkedListElement!(T)* element = head;
        while (element !is null)
        {
            result = dg(index, element.datum);
            if (result)
                break;
            element = element.next;
            index++;
        }

        return result;
    }

    LinkedListElement!(T)* append(T v)
    {
        length++;
        
        if (tail is null)
        {
            tail = New!(LinkedListElement!(T))(null);
            tail.datum = v;
        }
        else
        {
            tail.next = New!(LinkedListElement!(T))(null);
            tail.next.datum = v;
            tail = tail.next;
        }

        if (head is null) head = tail;
        
        return tail;
    }

    LinkedListElement!(T)* insertAfter(LinkedListElement!(T)* element, T v)
    {
        length++;
        auto newElement = New!(LinkedListElement!(T))(null);
        newElement.datum = v;
        newElement.next = element.next;
        element.next = newElement;
        if (element is tail) tail = newElement;
        return newElement;
    }

    LinkedListElement!(T)* insertBeginning(T v)
    {
        length++;
        auto newElement = New!(LinkedListElement!(T))(null);
        newElement.datum = v;
        newElement.next = head;
        head = newElement;
        return newElement;
    }

    void removeAfter(LinkedListElement!(T)* element)
    {
        length--;
        auto obsolete = element.next;
        if (obsolete !is null)
        {
            if (obsolete is tail) tail = element;
            element.next = obsolete.next;
            Delete(obsolete);
        }
    }

    void removeBeginning()
    {
        length--;
        auto obsolete = head;
        if (obsolete !is null)
        {
            head = obsolete.next;
            Delete(obsolete);
        }
    }

    void appendList(LinkedList!(T) list)
    {
        length += list.length;
        tail.next = list.head;
        tail = list.tail;
    }

    LinkedListElement!(T)* search(T v)
    {
        LinkedListElement!(T)* element = head;
        LinkedListElement!(T)* prevElement = head;
        while (element !is null)
        {
            if (element.datum == v)
            {
                static if (!ordered)
                {
                   /*
                    * Move-to-front heuristic:
                    * Move an element to the beginning of the list once it is found. 
                    * This scheme ensures that the most recently used items are also 
                    * the quickest to find again.
                    */
                    prevElement.next = element.next;
                    element.next = head;
                    head = element;
                }

                return element;
            }

            prevElement = element;
            element = element.next;
        }

        return null;
    }

    T[] toArray()
    {
        T[] arr = New!(T[])(length);
        foreach(i, v; this)
            arr[i] = v;
        return arr;
    }
}