Humble Framework for SkyOS

---

HList.h

Go to the documentation of this file.

/****************************************************************************
**
**  $Header: /SkyOS.root/HFramework/HList.h 4     4/17/05 12:29p Lee Neuse $
**
****************************************************************************/
#ifndef HLIST_H
    #define HLIST_H

template <class T>
class HList :   public HObjNoCopy,
                public std::list<T>
    {
    typedef HObjNoCopy  base_class;
    static StringPtr    ClassName(void) { return "HList<T>"; }
public:
    typedef typename std::list<T>::iterator     HListIterator;
/*  -----------------------------------------------------------------------
    VARIABLES
    ----------------------------------------------------------------------- */

/*  -----------------------------------------------------------------------
    CTOR / DTOR
    ----------------------------------------------------------------------- */
public:
    HList(void)
        { /* EMPTY CTOR */ }

    ~HList(void)
        { 
        if (!IsNotEmpty())
            {
            DEBUG_LOG("~HList() => %u elements still in list\n", this->size());
            this->clear(); 
            }
        }
/*  -----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------- */
public:
    ErrCode             
    AddHead(const T & tData)
        {
        (void) this->push_front(tData);
        return HError::NoError();
        }
    ErrCode             
    AddTail(const T & tData)
        {
        (void) this->push_back(tData);
        return HError::NoError();
        }
    ErrCode
    InsertAfter(const T & tAfter, const T & tData)
        {
        ErrCode         ec = HError::NoError();
        HListIterator   it = this->find(this->begin(), this->end(), tAfter);
        
        if (it != this->end())
            this->insert(it, tData);
        else
            ec = HError::Set(ERR_NOT_FOUND, __FILE__, __LINE__);
            
        return ec;
        }
    ErrCode
    Remove(const T & tData)
        {
        ErrCode     ec = HError::NoError();
        
        if (IsNotEmpty())
            this->remove(tData);
        else
            ec = HError::Set(ERR_NOT_FOUND, __FILE__, __LINE__);
            
        return ec;
        }
    ErrCode
    RemoveAll(void)
        {
        (void) this->clear();
        return HError::NoError();
        }
    ErrCode
    RemoveDuplicates(void)
        {
        if (IsNotEmpty())
            (void) this->unique();
        return HError::NoError();
        }
    ErrCode
    RemoveHead(void)
        { 
        ErrCode     ec = HError::NoError();
        
        if (IsNotEmpty())
            (void) this->pop_front();
        else
            ec = HError::Set(ERR_NOT_FOUND, __FILE__, __LINE__);

        return ec;
        }
    ErrCode
    RemoveTail(void)
        { 
        ErrCode     ec = HError::NoError();
        
        if (IsNotEmpty())
            (void) this->pop_back();
        else
            ec = HError::Set(ERR_NOT_FOUND, __FILE__, __LINE__);
            
        return ec;
        }
    ErrCode
    Sort(void)
        { 
        if (GetSize() > 1)
            (void) this->sort();
            
        return HError::NoError();
        }
/*  -----------------------------------------------------------------------
    GETTERS & SETTERS
    ----------------------------------------------------------------------- */
public:
    inline const T &    GetHead(void) const throw()
                            {
                            if (this->empty())
                                HError::Throw(ERR_NOT_FOUND, __FILE__, __LINE__);
                            
                            return this->front();
                            }
    inline uint32       GetSize(void) const
                            { return this->size(); }
    inline const T &    GetTail(void) const throw()
                            {
                            if (this->empty())
                                HError::Throw(ERR_NOT_FOUND, __FILE__, __LINE__);
                            
                            return this->back();
                            }
/*  -----------------------------------------------------------------------
    INLINES
    ----------------------------------------------------------------------- */
public:
    inline bool     Contains(const T & tData) const throw ()
                            { return (std::find(this->begin(), this->end(), tData) != this->end()); }
    inline bool     IsEmpty(void) const
                            { return this->empty(); }
    inline bool     IsNotEmpty(void) const
                            { return !this->empty(); }
    };

#endif  // HLIST_H
/****************************************************************************
**
**  $History: HList.h $
 * 
 * *****************  Version 4  *****************
 * User: Lee Neuse    Date: 4/17/05    Time: 12:29p
 * Updated in $/SkyOS.root/HFramework
 * Development snapshot 050417
 * 
 * *****************  Version 3  *****************
 * User: Neusel       Date: 12/10/04   Time: 3:57p
 * Updated in $/SkyOS.root/pig/Humble
 * 20041210
 * 
 * *****************  Version 2  *****************
 * User: Neusel       Date: 11/30/04   Time: 1:01p
 * Updated in $/SkyOS.root/pig/Humble
 * Released as HUMBLE_VER 20041130.
 * 
 * *****************  Version 1  *****************
 * User: Neusel       Date: 11/23/04   Time: 8:24a
 * Created in $/SkyOS.root/pig/Humble
**
**  -------------------------------------------------------------------------
**
**  End of HList.h
**
****************************************************************************/

---