src/foundation/ZUtil_STL.h

/*  @(#) $Id: ZUtil_STL.h,v 1.12 2006/10/30 06:13:19 agreen Exp $ */

/* ------------------------------------------------------------
Copyright (c) 2002 Andrew Green and Learning in Motion, Inc.
http://www.zoolib.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------ */

#ifndef __ZUtil_STL__
#define __ZUtil_STL__
#include "zconfig.h"

#include "ZCompat_algorithm.h"
#include "ZDebug.h"

#include <map>
#include <set>
#include <vector>

namespace ZUtil_STL {

// ==================================================

template <class InputIterator>
void sDeleteAll(InputIterator begin, InputIterator end)
        {
        while (begin != end)
                {
                delete *begin;
                ++begin;
                }
        }

// ==================================================

template <typename T, typename S>
bool sContains(const std::vector<T>& iVector, S iElement)
        { return iVector.end() != find(iVector.begin(), iVector.end(), iElement); }


template <typename T, typename S>
bool sContains(const std::set<T>& iSet, S iElement)
        { return iSet.end() != iSet.find(iElement); }


template <typename K, typename V>
bool sContains(const std::map<K, V>& iMap, K iKey)
        { return iMap.end() != iMap.find(iKey); }


template <typename T>
bool sPushBackIfNotContains(std::vector<T>& ioVector, T iElement)
        {
        typename std::vector<T>::iterator i = find(ioVector.begin(), ioVector.end(), iElement);
        if (i != ioVector.end())
                return false;
        ioVector.push_back(iElement);
        return true;
        }


template <typename T>
void sPushBackMustNotContain(const int iDebugLevel, std::vector<T>& ioVector, T iElement)
        {
        ZAssertStop(iDebugLevel, ioVector.end() == find(ioVector.begin(), ioVector.end(), iElement));
        ioVector.push_back(iElement);
        }


template <typename T>
void sInsertMustNotContain(const int iDebugLevel, std::set<T>& ioSet, T iElement)
        {
        ZAssertStop(iDebugLevel, ioSet.end() == ioSet.find(iElement));
        ioSet.insert(iElement);
        }


template <typename T>
bool sInsertIfNotContains(std::set<T>& ioSet, T iElement)
        {
        typename std::set<T>::iterator i = ioSet.lower_bound(iElement);
        if (ioSet.end() == i || *i != iElement)
                {
                ioSet.insert(i, iElement);
                return true;
                }
        return false;
        }


template <typename T>
bool sEraseIfContains(std::vector<T>& ioVector, T iElement)
        {
        typename std::vector<T>::iterator i = find(ioVector.begin(), ioVector.end(), iElement);
        if (i == ioVector.end())
                return false;
        ioVector.erase(i);
        return true;
        }


template <typename T>
bool sEraseIfContains(std::set<T>& ioSet, T iElement)
        {
        typename std::set<T>::iterator i = ioSet.find(iElement);
        if (i != ioSet.end())
                {
                ioSet.erase(i);
                return true;
                }
        return false;
        }


template <typename T>
typename std::vector<T>::iterator sEraseMustContain(
        const int iDebugLevel, std::vector<T>& ioVector, T iElement)
        {
        typename std::vector<T>::iterator i = find(ioVector.begin(), ioVector.end(), iElement);
        ZAssertStop(iDebugLevel, i != ioVector.end());
        return ioVector.erase(i);
        }


template <typename T>
void sEraseMustContain(const int iDebugLevel, std::set<T>& ioSet, T iElement)
        {
        typename std::set<T>::iterator i = ioSet.find(iElement);
        ZAssertStop(iDebugLevel, i != ioSet.end());
        ioSet.erase(i);
        }

// ==================================================

template <typename T>
bool sSortedContains(const std::vector<T>& iVector, T iElement)
        {
        typename std::vector<T>::const_iterator i
                = lower_bound(iVector.begin(), iVector.end(), iElement);
        return i != iVector.end() && *i == iElement;
        }


template <typename T>
bool sSortedInsertIfNotContains(std::vector<T>& iVector, T iElement)
        {
        typename std::vector<T>::iterator i = lower_bound(iVector.begin(), iVector.end(), iElement);
        if (i != iVector.end() && *i == iElement)
                return false;
        iVector.insert(i, iElement);
        return true;
        }


template <typename T>
bool sSortedEraseIfContains(std::vector<T>& iVector, T iElement)
        {
        typename std::vector<T>::iterator i = lower_bound(iVector.begin(), iVector.end(), iElement);
        if (i == iVector.end() || *i != iElement)
                return false;
        iVector.erase(i);
        return true;
        }


template <typename T>
void sSortedInsertMustNotContain(const int iDebugLevel, std::vector<T>& iVector, T iElement)
        {
        typename std::vector<T>::iterator i = lower_bound(iVector.begin(), iVector.end(), iElement);
        ZAssertStop(iDebugLevel, i == iVector.end() || *i != iElement);
        iVector.insert(i, iElement);
        }


template <typename T>
void sSortedEraseMustContain(const int iDebugLevel, std::vector<T>& iVector, T iElement)
        {
        typename std::vector<T>::iterator i = lower_bound(iVector.begin(), iVector.end(), iElement);
        ZAssertStop(iDebugLevel, i != iVector.end() && *i == iElement);
        iVector.erase(i);
        }

// ==================================================

template <typename K, typename V>
bool sEraseIfContains(std::map<K, V>& ioMap, K iKey)
        {
        typename std::map<K, V>::iterator i = ioMap.find(iKey);
        if (i != ioMap.end())
                {
                ioMap.erase(i);
                return true;
                }
        return false;
        }


template <typename K, typename V>
void sEraseMustContain(const int iDebugLevel, std::map<K, V>& ioMap, K iKey)
        {
        typename std::map<K, V>::iterator i = ioMap.find(iKey);
        ZAssertStop(iDebugLevel, i != ioMap.end());
        ioMap.erase(i);
        }


template <typename K, typename V>
V sEraseAndReturn(const int iDebugLevel, std::map<K, V>& ioMap, K iKey)
        {       
        typename std::map<K, V>::iterator iter = ioMap.find(iKey);
        ZAssertStop(iDebugLevel, ioMap.end() != iter);
        V result = (*iter).second;
        ioMap.erase(iter);
        return result;
        }


template <typename K, typename V>
void sInsertMustNotContain(const int iDebugLevel, std::map<K, V>& ioMap, K iKey, V iValue)
        {
        ZAssertStop(iDebugLevel, ioMap.end() == ioMap.find(iKey));
        ioMap.insert(typename std::map<K, V>::value_type(iKey, iValue));
        }

} // namespace ZUtil_STL

#endif // __ZUtil_STL__

---