Humble Framework for SkyOS

---

HMap.h

Go to the documentation of this file.

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

template <class KEY, class T>
class HMap :    public HObjNoCopy,
                public std::map<KEY,T>
    {
    typedef HObjNoCopy  base_class;
    static StringPtr    ClassName(void) { return "HMap"; }

    typedef typename std::map<KEY, T>::iterator     HMapIterator;
    typedef typename std::map<KEY, T>::const_iterator   HMapConstIterator;
/*  ----------------------------------------------------------------------
    CTOR / DTOR
    ----------------------------------------------------------------------  */
public:
    HMap(void)
        { /* EMPTY CTOR */ }
    
    ~HMap(void) 
        { 
        if (!this->empty())
            {
            DEBUG_LOG("~HMap() => %u entries still in map\n", this->size());
            this->clear();
            }
        }
/*  ----------------------------------------------------------------------
    METHODS
    ----------------------------------------------------------------------  */
public:
    ErrCode
    Remove(const KEY & key)
        {
        ErrCode     ec = HError::NoError();
        
        try
            {
            HMapIterator    it;
            
            if ((it = this->find(key)) != this->end())
                this->erase(it);
            else
                ec = HError::SetSilent(ERR_NOT_FOUND, __FILE__, __LINE__);
            }
        catch (const std::exception & e)
            {
            DEBUG_LOG("HMap::Remove() => caught %s\n", e.what());
            if ((ec = ErrCode( HError::GetLastError() )) == NO_ERROR)
                ec = HError::Set(ERR_STL_EXCEPTION, __FILE__, __LINE__);
            }

        return ec;
        }
    ErrCode
    RemoveAll(void)
        {
        (void) this->clear();
        return HError::NoError();
        }
/*  ----------------------------------------------------------------------
    GETTERS & SETTERS
    ----------------------------------------------------------------------  */
    ErrCode             Get(const KEY & key, T & data) const
                            { 
                            ErrCode             ec = HError::NoError();
                            HMapConstIterator   it = this->find(key);
                                
                            if (it != this->end())
                                data = it->second;
                            else
                                ec = HError::SetSilent(ERR_NOT_FOUND, __FILE__, __LINE__);
                                
                            return ec;
                            }
    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(); }
    ErrCode             Set(const KEY & key, const T & data)
                            { 
                            ErrCode     ec = HError::NoError();

                            try
                                {
                                HMapIterator    it = this->find(key);
                                
                                if (it == this->end())
                                    this->insert( std::make_pair(key, data) );  // add new value
                                else
                                    it->second = data;  // update existing value
                                }
                            catch (const std::exception & e)
                                {
                                DEBUG_LOG("HMap::Set() => caught %s\n", e.what());
                                if ((ec = ErrCode( HError::GetLastError() )) == NO_ERROR)
                                    ec = HError::Set(ERR_STL_EXCEPTION, __FILE__, __LINE__);
                                }
                                
                            return ec;
                            }
/*  ----------------------------------------------------------------------
    INLINES
    ----------------------------------------------------------------------  */
public:
    inline bool     Contains(const KEY & key) const throw ()
                            { return (this->find(key) != this->end()); }
    inline bool     IsEmpty(void) const
                            { return this->empty(); }
    inline bool     IsNotEmpty(void) const
                            { return !this->empty(); }
    };

#endif  // HMAP_H
/****************************************************************************
**
**  $History: HMap.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: 2/04/05    Time: 10:45a
 * Updated in $/SkyOS.root/pig/Humble
 * 
 * *****************  Version 2  *****************
 * User: Neusel       Date: 12/24/04   Time: 3:59p
 * Updated in $/SkyOS.root/pig/Humble
 * 
 * *****************  Version 1  *****************
 * User: Neusel       Date: 12/23/04   Time: 1:34p
 * Created in $/SkyOS.root/pig/Humble
 * Posted as HFramework-debug 20041223
**
**  -------------------------------------------------------------------------
**
**  End of HMap.h
**
****************************************************************************/

---