blob: 37490074fa5dcdb8b96ac09a1bf9c5e9667f9bea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/util/CcAutoDeletePointer.h $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 1995,2013 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef CcAutoDeletePointer_h
#define CcAutoDeletePointer_h
// Class Specification *************************************************
//
// Class name: CcAutoDeletePointer
// Parent class: None.
//
// Summary: This class is used to implement an automatic delete on a
// pointer to memory obtained via new for a single instance.
// Its primary purpose is for use in functions that create a
// single instance dynamically and then perform some operations
// that may throw an exception.
//
// This class should be used as a local variable so that when the
// varaible goes out of scope, the destructor is called and the
// memory pointer is deleted. Because the variable is local, if
// an exception is thrown, it is guaranteed that the destructor
// for this variable will be run and the memory pointer will be
// deleted properly.
//
// Access to the pointer is available through the pointer
// dereference operators, operator->() and
// operator*(). The normal delete syntax is used
// (i.e. "delete ptr;").
//
// Cardinality: N
//
// Performance/Implementation:
// Space Complexity: Constant
// Time Complexity: Constant
//
// Usage Examples:
//
// struct MyType
// {
// void bar(void);
// };
//
// void foo(void)
// {
// CcAutoDeletePointer<MyType> ptr(new MyType());
//
// // Operations that may throw an exception
//
// ptr->bar(); // Using the pointer
//
// (*ptr).bar(); // Dereferencing
// }
//
//
// End Class Specification *********************************************
// Includes
namespace PRDF
{
template <class T>
class CcAutoDeletePointer
{
public: // public member functions
CcAutoDeletePointer(T * ptr);
// Function Specification ********************************************
//
// Purpose: Initialization
// Parameters: ptr: Pointer to auto-delete
// Returns: No value returned
// Requirements: None.
// Promises: All data members are initialized.
// Exceptions: None.
// Concurrency: N/A
//
// End Function Specification ****************************************
~CcAutoDeletePointer(void);
// Function Specification ********************************************
//
// Purpose: Destruction
// Parameters: None.
// Returns: No value returned
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: N/A
// Notes: The function deletes the data member pointer.
//
// End Function Specification ****************************************
T * operator->(void) const;
// Function Specification ********************************************
//
// Purpose: Provide access to pointer.
// Parameters: None.
// Returns: Pointer to template type.
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
//
// End Function Specification ****************************************
T & operator*(void) const;
// Function Specification ********************************************
//
// Purpose: Provide access to pointer.
// Parameters: None.
// Returns: Reference to template type.
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
//
// End Function Specification ****************************************
private:
CcAutoDeletePointer(const CcAutoDeletePointer<T> & e);
// Function Specification ********************************************
//
// Purpose: Copy
// Parameters: e: Reference to instance to copy
// Returns: No value returned.
// Requirements: None.
// Promises: All data members are initialized.
// Exceptions: None.
// Concurrency: N/A.
// Notes: This copy constructor is declared private and not defined
// to prohibit copying.
//
// End Function Specification ****************************************
CcAutoDeletePointer<T> & operator=(const CcAutoDeletePointer<T> & e);
// Function Specification ********************************************
//
// Purpose: Assigment
// Parameters: e: Reference to instance to assign from
// Returns: Reference to this instance
// Requirements: None.
// Promises: All data members will be assigned.
// Exceptions: N/A.
// Concurrency: N/A.
// Notes: This assignment operator is declared private and not defined
// to prohibit copying.
//
// End Function Specification ****************************************
T * pointer;
};
// Class Specification *************************************************
//
// Class name: CcAutoDeletePointerVector
// Parent class: None.
//
// Summary: This class is used to implement an automatic delete on a
// pointer to memory obtained via new for multiple instances.
// Its primary purpose is for use in functions that allocate
// multiple instances dynamically (e.g. "T * ptr = new T[5];")
// and then perform some operations that may throw an
// exception.
//
// This class should be used as a local variable so that when the
// varaible goes out of scope, the destructor is called and the
// memory pointer is deleted. Because the variable is local, if
// an exception is thrown, it is guaranteed that the destructor
// for this variable will be run and the memory pointer will be
// deleted properly.
//
// Access to the pointer is available through operator(). The
// vector delete syntax is used (e.g. "delete [] ptr;").
//
// Cardinality: N
//
// Performance/Implementation:
// Space Complexity: Constant
// Time Complexity: Constant
//
// Usage Examples:
//
// void foo(void)
// {
// CcAutoDeletePointerVector<char> ptr(new char[4]);
//
// // Operations that may throw an exception
//
// strcpy(ptr(), "abc"); // Using the Pointer
// }
//
//
// End Class Specification *********************************************
template <class T>
class CcAutoDeletePointerVector
{
public: // public member functions
CcAutoDeletePointerVector(T * ptr);
// Function Specification ********************************************
//
// Purpose: Initialization
// Parameters: ptr: Pointer to auto-delete
// Returns: No value returned
// Requirements: None.
// Promises: All data members are initialized.
// Exceptions: None.
// Concurrency: N/A
//
// End Function Specification ****************************************
~CcAutoDeletePointerVector(void);
// Function Specification ********************************************
//
// Purpose: Destruction
// Parameters: None.
// Returns: No value returned
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: N/A
// Notes: The function deletes the data member pointer.
//
// End Function Specification ****************************************
T * operator()(void) const;
// Function Specification ********************************************
//
// Purpose: Provide access to pointer.
// Parameters: None.
// Returns: Pointer to template type.
// Requirements: None.
// Promises: None.
// Exceptions: None.
// Concurrency: Reentrant
//
// End Function Specification ****************************************
private:
CcAutoDeletePointerVector(const CcAutoDeletePointerVector<T> & e);
// Function Specification ********************************************
//
// Purpose: Copy
// Parameters: e: Reference to instance to copy
// Returns: No value returned.
// Requirements: None.
// Promises: All data members are initialized.
// Exceptions: None.
// Concurrency: N/A.
// Notes: This copy constructor is declared private and not defined
// to prohibit copying.
//
// End Function Specification ****************************************
CcAutoDeletePointerVector<T> & operator=(
const CcAutoDeletePointerVector<T> & e);
// Function Specification ********************************************
//
// Purpose: Assigment
// Parameters: e: Reference to instance to assign from
// Returns: Reference to this instance
// Requirements: None.
// Promises: All data members will be assigned.
// Exceptions: N/A.
// Concurrency: N/A.
// Notes: This assignment operator is declared private and not defined
// to prohibit copying.
//
// End Function Specification ****************************************
T * pointer;
};
} // end namespace PRDF
#include <CcAutoDeletePointer.inl>
#endif
|
