pg_map.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 K, class D> class pgMap
{
public:
    pgDefineException(ExceptionInvalidArgument);
    pgDefineException(ExceptionNotFound);
    pgDefineException(ExceptionNotInitialized);
    pgDefineException(ExceptionSameKeyExists);

    pgMap()
    {
        m_hash_list = NULL;
        m_last_item1 = m_last_item2 = m_last_item3 = NULL;
        m_hash_size = 0;
        m_data_num = 0;
    }

    ~pgMap()
    {
        clear();

        if (m_hash_list)
        {
            pgDeleteArray(m_hash_list, pgList<MapItem>);
        }
    }

    void init(u16 hash_size)
    {
        if (hash_size == 0)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        clear();

        if (m_hash_list)
        {
            pgDeleteArray(m_hash_list, pgList<MapItem>);
        }

        m_hash_size = hash_size;
        pgNewArray(m_hash_list, pgList<MapItem>, m_hash_size);
    }

    u16 getHashSize() const
    {
        return m_hash_size;
    }

    u16 getDataNum() const
    {
        return m_data_num;
    }

    D* get(K key)
    {
        D* data = getN(key);

        if (!data)
        {
            pgThrow(ExceptionNotFound);
        }

        return data;
    }

    D* getN(K key)
    {
        if (!m_hash_list)
        {
            pgThrow(ExceptionNotInitialized);
        }

        if (m_last_item1 && m_last_item1->key == key)
        {
            return &m_last_item1->data;
        }
        else if (m_last_item2 && m_last_item2->key == key)
        {
            MapItem* item = m_last_item1;
            m_last_item1 = m_last_item2;
            m_last_item2 = item;

            return &m_last_item1->data;
        }
        else if (m_last_item3 && m_last_item3->key == key)
        {
            MapItem* item = m_last_item1;
            m_last_item1 = m_last_item3;
            m_last_item3 = m_last_item2;
            m_last_item2 = item;

            return &m_last_item1->data;
        }
        else
        {
            s32 index = key % m_hash_size;
            pgList<MapItem>* hash_list = &m_hash_list[(index < 0) ? -index : index];

            for (typename pgList<MapItem>::Item* item = hash_list->getFirstN(); item; item = item->getNextN())
            {
                if (item->getSelf()->key == key)
                {
                    m_last_item3 = m_last_item2;
                    m_last_item2 = m_last_item1;
                    m_last_item1 = item->getSelf();

                    hash_list->addFirst(item);

                    return &m_last_item1->data;
                }
            }

            return NULL;
        }
    }

    void add(K key, const D& data)
    {
        if (!m_hash_list)
        {
            pgThrow(ExceptionNotInitialized);
        }

        if (getN(key))
        {
            pgThrow(ExceptionSameKeyExists);
        }

        MapItem* new_item = pgNew(MapItem);

        new_item->order_item.init(new_item);
        new_item->hash_item.init(new_item);
        new_item->key = key;
        new_item->data = data;

        m_order_list.addLast(&new_item->order_item);

        s32 index = key % m_hash_size;
        m_hash_list[(index < 0) ? -index : index].addLast(&new_item->hash_item);

        m_data_num++;
    }

    void remove(K key)
    {
        if (!m_hash_list)
        {
            pgThrow(ExceptionNotInitialized);
        }

        if (m_last_item1 && m_last_item1->key == key)
        {
            pgDelete(m_last_item1, MapItem);
            m_data_num--;

            m_last_item1 = m_last_item2;
            m_last_item2 = m_last_item3;
            m_last_item3 = NULL;
        }
        else if (m_last_item2 && m_last_item2->key == key)
        {
            pgDelete(m_last_item2, MapItem);
            m_data_num--;

            m_last_item2 = m_last_item3;
            m_last_item3 = NULL;
        }
        else if (m_last_item3 && m_last_item3->key == key)
        {
            pgDelete(m_last_item3, MapItem);
            m_data_num--;

            m_last_item3 = NULL;
        }
        else
        {
            s32 index = key % m_hash_size;
            pgList<MapItem>* hash_list = &m_hash_list[(index < 0) ? -index : index];

            for (typename pgList<MapItem>::Item* item = hash_list->getFirstN(); item; item = item->getNextN())
            {
                if (item->getSelf()->key == key)
                {
                    pgDelete(item->getSelf(), MapItem);
                    m_data_num--;

                    return;
                }
            }

            pgThrow(ExceptionNotFound);
        }
    }

    void clear()
    {
        m_order_list.clear();

        if (m_hash_list)
        {
            for (s32 i = 0; i < m_hash_size; i++)
            {
                pgList<MapItem>* hash_list = &m_hash_list[i];

                while (hash_list->hasItem())
                {
                    pgDelete(hash_list->getFirstN()->getSelf(), MapItem);
                }
            }

            m_last_item1 = m_last_item2 = m_last_item3 = NULL;
            m_data_num = 0;
        }
    }

    const K* getFirstKeyN() const
    {
        if (!m_hash_list)
        {
            pgThrow(ExceptionNotInitialized);
        }

        return m_order_list.hasItem() ? &m_order_list.getFirstN()->getSelf()->key : NULL;
    }

    const K* getLastKeyN() const
    {
        if (!m_hash_list)
        {
            pgThrow(ExceptionNotInitialized);
        }

        return m_order_list.hasItem() ? &m_order_list.getLastN()->getSelf()->key : NULL;
    }

    const K* getPrevKeyN(K key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* prev = reinterpret_cast<MapItem*>(get(key))->order_item.getPrevN();

            return prev ? &prev->getSelf()->key : NULL;
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        return NULL;
    }

    const K* getNextKeyN(K key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* next = reinterpret_cast<MapItem*>(get(key))->order_item.getNextN();

            return next ? &next->getSelf()->key : NULL;
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }

        return NULL;
    }

    void moveFirst(K key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* item = &reinterpret_cast<MapItem*>(get(key))->order_item;

            m_order_list.addFirst(item);
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }
    }

    void moveLast(K key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* item = &reinterpret_cast<MapItem*>(get(key))->order_item;

            m_order_list.addLast(item);
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }
    }

    void moveBefore(K key, K next_key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* item = &reinterpret_cast<MapItem*>(get(key))->order_item;
            typename pgList<MapItem>::Item* next = &reinterpret_cast<MapItem*>(get(next_key))->order_item;

            item->joinBefore(next);
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }
    }

    void moveAfter(K key, K prev_key)
    {
        pgTry
        {
            typename pgList<MapItem>::Item* item = &reinterpret_cast<MapItem*>(get(key))->order_item;
            typename pgList<MapItem>::Item* prev = &reinterpret_cast<MapItem*>(get(prev_key))->order_item;

            item->joinAfter(prev);
        }
        pgCatch(ExceptionNotFound)
        {
            pgThrow(ExceptionInvalidArgument);
        }
    }

private:
    struct MapItem
    {
        D data; // This data member must be at the top of this structure.
        typename pgList<MapItem>::Item order_item;
        typename pgList<MapItem>::Item hash_item;
        K key;
    };

    pgMap(const pgMap<K, D>&) {}
    void operator=(const pgMap<K, D>&) {}

    pgList<MapItem> m_order_list;
    pgList<MapItem>* m_hash_list;
    MapItem* m_last_item1;
    MapItem* m_last_item2;
    MapItem* m_last_item3;
    u16 m_hash_size;
    u16 m_data_num;
};

---