True Axis Physics SDK 1.2.0.1 Beta Documentation
www.trueaxis.com

---

List.h

//---------------------------------------------------------------------------------
// File Name: List.h
// Description: Singular Linked List Class.
//              The Type must contain a default constructor.
//              The list handles memory allocation of the items.
//
// Copyright (C) 2004 - 2006 True Axis Pty Ltd, Australia. 
// All Rights Reserved.
//
// History:
//      Created File.
//---------------------------------------------------------------------------------

#ifndef TA_LIST_H
#define TA_LIST_H

#ifndef TA_DEBUG_H
#include "Debug.h"
#endif // TA_DEBUG_H

#ifndef TA_MEMORYMGR_H
#include "MemoryMgr.h"
#endif // TA_MEMORYMGR_H

namespace TA
{

template <class Type>
class TACOMMON_CLASS List
{
protected:
    struct Item;    

public: 
    class Iterator
    {
    public:
        Iterator() { m_pItem = 0; }
        ~Iterator() { Finalise(); }
        void operator ++() { if (m_pItem) m_pItem = m_pItem->pNext; }
        Type& operator *() { return m_pItem->data; }
        bool AtEnd() { return m_pItem == 0; }
    private:
        friend class List;
        void Initialise(Item* pItem) { m_pItem = pItem; }
        void Finalise() { m_pItem = 0; }
        Item* m_pItem;
    };
    class ConstIterator
    {
    public:
        ConstIterator() { m_pItem = 0; }
        ~ConstIterator() { Finalise(); }
        void operator ++() { if (m_pItem) m_pItem = m_pItem->pNext; }
        const Type& operator *() { return m_pItem->data; }
        bool AtEnd() { return m_pItem == 0; }
    private:
        friend class List;
        void Initialise(Item* pItem) { m_pItem = pItem; }
        void Finalise() { m_pItem = 0; }
        const Item* m_pItem;
    };

    // todo: a const iterator

    List();
    ~List();

    // No need for Initialise
    void Finalise();
    void Clear();

    int GetSize() const; // slow as
    bool IsEmpty() const;

    // Array operator
    Type& operator [] (int nIndex);
    const Type& operator [] (int nIndex) const;

    Type& Append();
    void Append(const Type& value) { Append() = value; }
    void RemoveByValue(const Type& value);
    void Remove(const Type* pValue);
    Iterator GetIterator() { Iterator it; it.Initialise(m_pStart); return it; }
    ConstIterator GetConstIterator() const { ConstIterator it; it.Initialise(m_pStart); return it; }
    
protected:
    struct Item
    {
        Type data; // Must be first in this structure.
        Item* pNext;
    };
    Item* m_pStart;
    Item* m_pEnd;
};

}

#include "List.inl"

#endif // TA_LIST_H

---

© Copyright 2004-2006 TRUE AXIS PTY LTD Australia. All rights reserved.