ICU-45 Created UVector and UStack.

X-SVN-Rev: 130

icu4c/source/common/common.dsp

@@ -254,6 +254,10 @@ SOURCE=.\ures.cpp
 
 SOURCE=.\ustring.c
 # End Source File
+# Begin Source File
+
+SOURCE=.\uvector.cpp
+# End Source File
 # End Group
 # Begin Group "Header Files"
 
@@ -974,6 +978,10 @@ InputPath=.\utypes.h
 
 !ENDIF 
 
+# End Source File
+# Begin Source File
+
+SOURCE=.\uvector.h
 # End Source File
 # End Group
 # Begin Group "Resource Files"

icu4c/source/common/uvector.cpp

@@ -0,0 +1,177 @@
+/*
+**********************************************************************
+*   Copyright (C) 1999 Alan Liu and others. All rights reserved.
+**********************************************************************
+*   Date        Name        Description
+*   10/22/99    alan        Creation.
+**********************************************************************
+*/
+
+#include "uvector.h"
+#include "cmemory.h"
+
+bool_t UVector::outOfMemory = FALSE;
+
+UVector::UVector(int32_t initialCapacity) :
+    capacity(0),
+    count(0),
+    elements(0),
+    deleter(0),
+    comparer(0) {
+
+    _init(initialCapacity);
+}
+
+UVector::UVector(Deleter d, Comparer c, int32_t initialCapacity) :
+    capacity(0),
+    count(0),
+    elements(0),
+    deleter(d),
+    comparer(c) {
+   
+    _init(initialCapacity);
+}
+
+void UVector::_init(int32_t initialCapacity) {
+    elements = new void*[initialCapacity];
+    if (elements == 0) {
+        outOfMemory = TRUE;
+    } else {
+        capacity = initialCapacity;
+    }
+}
+
+UVector::~UVector() {
+    removeAllElements();
+    delete[] elements;
+    elements = 0;
+}
+
+void UVector::addElement(void* obj) {
+    if (ensureCapacity(count)) {
+        elements[count++] = obj;
+    }
+}
+
+void UVector::setElementAt(void* obj, int32_t index) {
+    if (0 <= index && index < count) {
+        if (elements[index] != 0 && deleter != 0) {
+            (*deleter)(elements[index]);
+        }
+        elements[index] = obj;
+    }
+    /* else index out of range */
+}
+
+void UVector::insertElementAt(void* obj, int32_t index) {
+    // must have 0 <= index <= count
+    if (0 <= index && index <= count && ensureCapacity(count)) {
+        for (int32_t i=count; i>index; --i) {
+            elements[i] = elements[i-1];
+        }
+        elements[index] = obj;
+    }
+    /* else index out of range */
+}
+
+void* UVector::elementAt(int32_t index) const {
+    return (0 <= index && index < count) ? elements[index] : 0;
+}
+
+void UVector::removeElementAt(int32_t index) {
+    if (0 <= index && index < count) {
+        if (deleter != 0) {
+            (*deleter)(elements[index]);
+        }
+        for (int32_t i=index; i<count; ++i) {
+            elements[i] = elements[i+1];
+        }
+    }
+    /* else index out of range */
+}
+
+bool_t UVector::removeElement(void* obj) {
+    int32_t i = indexOf(obj);
+    if (i >= 0) {
+        removeElementAt(i);
+        return TRUE;
+    }
+    return FALSE;
+}
+
+void UVector::removeAllElements() {
+    if (deleter != 0) {
+        for (int32_t i=0; i<count; ++i) {
+            if (elements[i] != 0) {
+                (*deleter)(elements[i]);
+            }
+        }
+    }
+    count = 0;
+}
+
+int32_t UVector::indexOf(void* obj, int32_t startIndex) const {
+    if (comparer != 0) {
+        for (int32_t i=startIndex; i<count; ++i) {
+            if ((*comparer)(obj, elements[i])) {
+                return i;
+            }
+        }
+    }
+    return -1;
+}
+
+bool_t UVector::ensureCapacity(int32_t minimumCapacity) {
+    if (capacity >= minimumCapacity) {
+        return TRUE;
+    } else {
+        int32_t newCap = capacity * 2;
+        void** newElems = new void*[newCap];
+        if (newElems == 0) {
+            outOfMemory = TRUE;
+            return FALSE;
+        }
+        icu_memcpy(newElems, elements, sizeof(void*) * count);
+        delete[] elements;
+        elements = newElems;
+        capacity = newCap;
+        return TRUE;
+    }
+}
+
+UVector::Deleter UVector::setDeleter(Deleter d) {
+    Deleter old = deleter;
+    deleter = d;
+    return old;
+}
+
+UVector::Comparer UVector::setComparer(Comparer d) {
+    Comparer old = comparer;
+    comparer = d;
+    return old;
+}
+
+bool_t UVector::isOutOfMemory() {
+    return outOfMemory;
+}
+
+UStack::UStack(int32_t initialCapacity) :
+    UVector(initialCapacity) {
+}
+
+UStack::UStack(Deleter d, Comparer c, int32_t initialCapacity) :
+    UVector(d, c, initialCapacity) {
+}
+
+void* UStack::pop() {
+    void* obj = lastElement();
+    if (obj != 0) {
+        removeElementAt(size() - 1);
+    }
+    return obj;
+}
+
+int32_t UStack::search(void* obj) const {
+    int32_t i = indexOf(obj);
+    return (i >= 0) ? size() - i : i;
+}

icu4c/source/common/uvector.h

@@ -0,0 +1,241 @@
+/*
+**********************************************************************
+*   Copyright (C) 1999 Alan Liu and others. All rights reserved.
+**********************************************************************
+*   Date        Name        Description
+*   10/22/99    alan        Creation.  This is an internal header.
+*                           It should not be exported.
+**********************************************************************
+*/
+
+#ifndef UVECTOR_H
+#define UVECTOR_H
+
+#include "utypes.h"
+
+/**
+ * <p>Ultralightweight C++ implementation of a <tt>void*</tt> vector
+ * that is (mostly) compatible with java.util.Vector.
+ *
+ * <p>This is a very simple implementation, written to satisfy an
+ * immediate porting need.  As such, it is not completely fleshed out,
+ * and it aims for simplicity and conformity.  Nonetheless, it serves
+ * its purpose (porting code from java that uses java.util.Vector)
+ * well, and it could be easily made into a more robust vector class.
+ *
+ * <p><b>Design notes</b>
+ *
+ * <p>There is index bounds checking, but little is done about it.  If
+ * indices are out of bounds, either nothing happens, or zero is
+ * returned.  We <em>do</em> avoid indexing off into the weeds.
+ *
+ * <p>There is detection of out of memory, but the handling is very
+ * coarse-grained -- similar to UnicodeString's protocol, but even
+ * coarser.  The class contains <em>one static flag</em> that is set
+ * when any call to <tt>new</tt> returns zero.  This allows the caller
+ * to use several vectors and make just one check at the end to see if
+ * a memory failure occurred.  This is more efficient than making a
+ * check after each call on each vector when doing many operations on
+ * multiple vectors.  The single static flag works best when memory
+ * failures are infrequent, and when recovery options are limited or
+ * nonexistent.
+ *
+ * <p>Since we don't have garbage collection, UVector was given the
+ * option to <em>own</em>its contents.  To employ this, set a deleter
+ * function.  The deleter is called on a void* pointer when that
+ * pointer is released by the vector, either when the vector itself is
+ * destructed, or when a call to setElementAt() overwrites an element,
+ * or when a call to remove() or one of its variants explicitly
+ * removes an element.  If no deleter is set, or the deleter is set to
+ * zero, then it is assumed that the caller will delete elements as
+ * needed.
+ *
+ * <p>In order to implement methods such as contains() and indexOf(),
+ * UVector needs a way to compare objects for equality.  To do so, it
+ * uses a comparison frunction, or "comparer."  If the comparer is not
+ * set, or is set to zero, then all such methods will act as if the
+ * vector contains no element.  That is, indexOf() will always return
+ * -1, contains() will always return FALSE, etc.
+ *
+ * <p><b>To do</b>
+ *
+ * <p>Improve the handling of index out of bounds errors.
+ *
+ * @author Alan Liu
+ */
+class UVector {
+public:
+    typedef void (*Deleter)(void*);
+    typedef bool_t (*Comparer)(void*, void*);
+
+private:
+    int32_t count;
+
+    int32_t capacity;
+
+    void** elements;
+
+    Deleter deleter;
+
+    Comparer comparer;
+
+    static bool_t outOfMemory;
+
+public:
+    UVector(int32_t initialCapacity = 8);
+
+    UVector(Deleter d, Comparer c, int32_t initialCapacity = 8);
+
+    ~UVector();
+
+    void addElement(void* obj);
+
+    void setElementAt(void* obj, int32_t index);
+
+    void insertElementAt(void* obj, int32_t index);
+
+    void* elementAt(int32_t index) const;
+
+    void* firstElement() const;
+
+    void* lastElement() const;
+
+    int32_t indexOf(void* obj, int32_t startIndex = 0) const;
+
+    bool_t contains(void* obj) const;
+
+    void removeElementAt(int32_t index);
+
+    bool_t removeElement(void* obj);
+
+    void removeAllElements();
+
+    int32_t size() const;
+
+    bool_t isEmpty() const;
+
+    bool_t ensureCapacity(int32_t minimumCapacity);
+
+    // New API
+    Deleter setDeleter(Deleter d);
+
+    Comparer setComparer(Comparer c);
+
+    static bool_t isOutOfMemory();
+
+    void* operator[](int32_t index) const;
+
+private:
+    void _init(int32_t initialCapacity);
+
+    // Disallow
+    UVector(const UVector&);
+
+    // Disallow
+    UVector& operator=(const UVector&);
+};
+
+
+/**
+ * <p>Ultralightweight C++ implementation of a <tt>void*</tt> stack
+ * that is (mostly) compatible with java.util.Stack.  As in java, this
+ * is merely a paper thin layer around UVector.  See the UVector
+ * documentation for further information.
+ *
+ * <p><b>Design notes</b>
+ *
+ * <p>The element at index <tt>n-1</tt> is (of course) the top of the
+ * stack.
+ *
+ * <p>The poorly named <tt>empty()</tt> method doesn't empty the
+ * stack; it determines if the stack is empty.
+ *
+ * @author Alan Liu
+ */
+class UStack : public UVector {
+public:
+    UStack(int32_t initialCapacity = 8);
+
+    UStack(Deleter d, Comparer c, int32_t initialCapacity = 8);
+
+    // It's okay not to have a virtual destructor (in UVector)
+    // because UStack has no special cleanup to do.
+
+    bool_t empty() const;
+
+    void* peek() const;
+    
+    void* pop();
+    
+    void* push(void* obj);
+
+    int32_t search(void* obj) const;
+
+private:
+    // Disallow
+    UStack(const UStack&);
+
+    // Disallow
+    UStack& operator=(const UStack&);
+};
+
+
+// UVector inlines
+
+inline int32_t UVector::size() const {
+    return count;
+}
+
+inline bool_t UVector::isEmpty() const {
+    return count == 0;
+}
+
+inline bool_t UVector::contains(void* obj) const {
+    return indexOf(obj) >= 0;
+}
+
+inline void* UVector::firstElement() const {
+    return elementAt(0);
+}
+
+inline void* UVector::lastElement() const {
+    return elementAt(count-1);
+}
+
+inline void* UVector::operator[](int32_t index) const {
+    return elementAt(index);
+}
+
+// Dummy implementation - disallowed method
+UVector::UVector(const UVector&) {}
+
+// Dummy implementation - disallowed method
+UVector& UVector::operator=(const UVector&) {
+    return *this;
+}
+
+
+// UStack inlines
+
+inline bool_t UStack::empty() const {
+    return isEmpty();
+}
+
+inline void* UStack::peek() const {
+    return lastElement();
+}
+
+inline void* UStack::push(void* obj) {
+    addElement(obj);
+    return obj;
+}
+
+// Dummy implementation - disallowed method
+UStack::UStack(const UStack&) {}
+
+// Dummy implementation - disallowed method
+UStack& UStack::operator=(const UStack&) {
+    return *this;
+}
+
+#endif