list.hpp

Go to the documentation of this file.

 
#ifndef Om_List_
 
    #define Om_List_ \
    Om::List
 
    #ifndef Om_Macro_Precompilation_
 
        #include "boost/array.hpp"
 
    #endif
 
namespace Om {
 
    // MARK: - Om::List
 
    template <typename ThisValue>
    class List {
 
    public: // MARK: public (static)
 
        enum NodeIndex {
            theFrontNodeIndex,
            theBackNodeIndex
        };
 
        class Node;
 
    public: // MARK: public (non-static)
 
        List();
 
        void Clear();
 
        Node * GetNode(NodeIndex const);
 
        Node const * GetNode(NodeIndex const) const;
 
        bool IsEmpty() const;
 
        void LinkNode(
            NodeIndex const,
            Node &
        );
 
        void RelinkNode(
            NodeIndex const,
            Node &
        );
 
        void Swap(List &);
 
        Node * UnlinkNode(NodeIndex const);
 
    private: // MARK: private (static)
 
        typedef boost::array<
            Node *,
            2
        > NodeArray;
 
    private: // MARK: private (non-static)
 
        NodeArray thisNodeArray;
 
    };
 
    // MARK: - Om::List::Node
 
    template <typename ThisValue>
    class List<ThisValue>::Node {
 
        friend class List<ThisValue>;
 
    public: // MARK: public (non-static)
 
        Node();
 
        Node * GetNode(NodeIndex const);
 
        Node const * GetNode(NodeIndex const) const;
 
        ThisValue & GetValue();
 
        ThisValue const & GetValue() const;
 
    private: // MARK: private (non-static)
 
        NodeArray thisNodeArray;
 
        ThisValue thisValue;
 
    };
 
}
 
    #include "om/list.cpp"
 
#endif