UT/UT_PtrArray.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Cristin Barghiel
 *      Side Effects Software Inc.
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        Utility Library (C++)
 *
 * COMMENTS:
 *      This is a class template that implements a resizable array of 
 *      arbitrary objects. The template parameter represents the type
 *      of object, and is called utPtr. You can instantiate this class
 *      with any object or pointer, such as:
 *              UT_PtrArray<GeoPoint*>          pObj;
 */

#ifndef __UT_PtrArray_h__
#define __UT_PtrArray_h__

#include "UT_ValArray.h"

UT_API extern int UTcomparePointers(void *const* a, void *const* b);

// TODO: Do not add new methods to this class.  The methods implemented
// here are only provided for compatibility until we sweep the baseline to
// use the UT_ValArray interface exclusively.
template <typename T>
class UT_PtrArray : public UT_ValArray<T> {
public:
    UT_PtrArray(const UT_PtrArray<T> &a)
        : UT_ValArray<T>(a) {}
    explicit UT_PtrArray(unsigned int sz = 0)
        : UT_ValArray<T>(sz) {}

    T           removeLast()
                {
                    if (UT_ValArray<T>::entries())
                    {
                        T       val = UT_ValArray<T>::last();
                        UT_ValArray<T>::removeLast();
                        return val;
                    }
                    return 0;
                }
};

typedef UT_PtrArray<const char *>       UT_StringList;

#endif

---