spine-runtimes/spine-cpp/spine-cpp/include/spine/ContainerUtil.h

/******************************************************************************
 * Spine Runtimes Software License v2.5
 *
 * Copyright (c) 2013-2016, Esoteric Software
 * All rights reserved.
 *
 * You are granted a perpetual, non-exclusive, non-sublicensable, and
 * non-transferable license to use, install, execute, and perform the Spine
 * Runtimes software and derivative works solely for personal or internal
 * use. Without the written permission of Esoteric Software (see Section 2 of
 * the Spine Software License Agreement), you may not (a) modify, translate,
 * adapt, or develop new applications using the Spine Runtimes or otherwise
 * create derivative works or improvements of the Spine Runtimes or (b) remove,
 * delete, alter, or obscure any trademarks or any copyright, trademark, patent,
 * or other intellectual property or proprietary rights notices on or in the
 * Software, including any copy thereof. Redistributions in binary or source
 * form must include this license and terms.
 *
 * THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL ESOTERIC SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS INTERRUPTION, OR LOSS OF
 * USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

#ifndef Spine_ContainerUtil_h
#define Spine_ContainerUtil_h

#include <spine/Vector.h>
#include <spine/HashMap.h>

#include <string>
#include <assert.h>

namespace Spine
{
    class ContainerUtil
    {
    public:
        /// Finds an item by comparing each item's name.
        /// It is more efficient to cache the results of this method than to call it multiple times.
        /// @return May be NULL.
        template<typename T>
        static T* findWithName(Vector<T*>& items, std::string name)
        {
            assert(name.length() > 0);
            
            for (T** i = items.begin(); i != items.end(); ++i)
            {
                T* item = (*i);
                if (item->getName() == name)
                {
                    return item;
                }
            }
            
            return NULL;
        }
        
        /// @return -1 if the item was not found.
        template<typename T>
        static int findIndexWithName(Vector<T*>& items, std::string name)
        {
            assert(name.length() > 0);
            
            for (size_t i = 0, len = items.size(); i < len; ++i)
            {
                T* item = items[i];
                if (item->getName() == name)
                {
                    return static_cast<int>(i);
                }
            }
            
            return -1;
        }
        
        /// Finds an item by comparing each item's name.
        /// It is more efficient to cache the results of this method than to call it multiple times.
        /// @return May be NULL.
        template<typename T>
        static T* findWithDataName(Vector<T*>& items, std::string name)
        {
            assert(name.length() > 0);
            
            for (T** i = items.begin(); i != items.end(); ++i)
            {
                T* item = (*i);
                if (item->getData().getName() == name)
                {
                    return item;
                }
            }
            
            return NULL;
        }
        
        /// @return -1 if the item was not found.
        template<typename T>
        static int findIndexWithDataName(Vector<T*>& items, std::string name)
        {
            assert(name.length() > 0);
            
            for (size_t i = 0, len = items.size(); i < len; ++i)
            {
                T* item = items[i];
                if (item->getData().getName() == name)
                {
                    return static_cast<int>(i);
                }
            }
            
            return -1;
        }
        
        template<typename T>
        static void cleanUpVectorOfPointers(Vector<T*>& items)
        {
            for (size_t i = 0; i < items.size(); )
            {
                T* item = items[i];
                delete item;
                
                items.erase(i);
            }
        }
        
        template<typename K, typename T, typename H>
        static void cleanUpHashMapOfPointers(HashMap<K, T*, H>& hashMap)
        {
            for (typename HashMap<K, T*, H>::Iterator i = hashMap.begin(); i != hashMap.end(); )
            {
                delete i.second();
                
                i = hashMap.erase(i);
            }
        }
        
    private:
        // ctor, copy ctor, and assignment should be private in a Singleton
        ContainerUtil();
        ContainerUtil(const ContainerUtil&);
        ContainerUtil& operator=(const ContainerUtil&);
    };
}

#endif /* Spine_ContainerUtil_h */