Added features to dyninstAPI library, including the ability to delete
[dyninst.git] / dyninstAPI / h / BPatch_Vector.h
1 /*
2  * Copyright (c) 1996 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef _BPatch_Vector_h_
43 #define _BPatch_Vector_h_
44
45 #include <stdlib.h>
46 #include <assert.h>
47
48 #ifdef external_templates
49 #pragma interface
50 #endif /* external_templates */
51
52 template<class T>
53 class BPatch_Vector {
54     int         reserved;       // Number of objects for which space is reserved
55     int         len;            // The current number of objects in the vector
56     T*          data;           // Points to the array of objects
57
58     void        reserve(int n);
59     inline void copy_from(const BPatch_Vector &);
60 public:
61     BPatch_Vector(int n = 0);
62     BPatch_Vector(const BPatch_Vector<T> &);
63     ~BPatch_Vector();
64
65     BPatch_Vector<T>& operator=(const BPatch_Vector<T> &);
66
67     int         size() const { return len; }
68     void        push_back(const T& x);
69
70     const T&    operator[](int n) const;
71 };
72
73 // Reserve space for at least n entries in the vector
74 template<class T>
75 void BPatch_Vector<T>::reserve(int n)
76 {
77     if (n > reserved) { // If we haven't already reserved enough space
78         // Generally we double the size each time we reserve memory, so
79         // that we're not doing it for every insertion.
80         if (reserved*2 > n) n = reserved*2;
81
82         // Create a new array with enough space
83         T* new_data = new T[n];
84
85         // Copy the entries from the old array to the new one
86         for (int i = 0; i < len; i++)
87             new_data[i] = data[i];
88
89         // Get rid of the old array and set up to use the new one
90         delete [] data;
91         data = new_data;
92         reserved = n;
93     }
94     assert(data != NULL || n == 0);
95 }
96
97 // Copy the contents of another vector into this one.
98 template<class T>
99 inline void BPatch_Vector<T>::copy_from(const BPatch_Vector &src)
100 {
101     reserved = src.reserved;
102     len      = src.len;
103     data     = new T[reserved];
104
105     for (int i = 0; i < src.len; i++)
106         data[i] = src.data[i];
107 }
108
109 // Contructor.  Takes one optional parameter, the number of entries for which
110 // to reserve space.
111 template<class T>
112 BPatch_Vector<T>::BPatch_Vector(int n) : reserved(0), len(0), data(NULL)
113 {
114     assert(n >= 0);
115     if (n > 0) reserve(n);
116 }
117
118 // Copy constructor.
119 template<class T>
120 BPatch_Vector<T>::BPatch_Vector(const BPatch_Vector<T> &src)
121 {
122     copy_from(src);
123 }
124
125 // Destructor.  Frees allocated memory.
126 template<class T>
127 BPatch_Vector<T>::~BPatch_Vector()
128 {
129     delete [] data;
130 }
131
132 // Assignment operator.  Delete the contents of this vector and copy the
133 // contents of the other vector into it.
134 template<class T>
135 BPatch_Vector<T>& BPatch_Vector<T>::operator=(const BPatch_Vector<T> &src)
136 {
137     delete [] data;
138
139     copy_from(src);
140
141     return *this;
142 }
143
144 // Add an element to the end of the vector.
145 template<class T>
146 void BPatch_Vector<T>::push_back(const T& x)
147 {
148     reserve(len+1);
149     data[len] = x;
150     len++;
151 }
152
153 // Reference the nth element of the vector.
154 template<class T>
155 const T& BPatch_Vector<T>::operator[](int n) const
156 {
157     assert(data != NULL && n >= 0 && n < len);
158     return data[n];
159 }
160
161 #endif /* _BPatch_Vector_h_ */