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
|
/////////////////////////////////////////////////////////////////////////////
// Name: wx/scopedarray.h
// Purpose: interface of wxScopedArray
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxScopedArray
This is a simple scoped smart pointer array implementation that is similar to
the Boost smart pointers (see http://www.boost.org/) but rewritten to
use macros instead.
@b Example:
Below is an example of using a wxWidgets scoped smart pointer and pointer array.
@code
class MyClass { ... };
// declare a smart pointer to a MyClass called wxMyClassPtr
wxDECLARE_SCOPED_PTR(MyClass, wxMyClassPtr)
// declare a smart pointer to an array of chars
wxDECLARE_SCOPED_ARRAY(char, wxCharArray)
...
// define the first pointer class, must be complete
wxDEFINE_SCOPED_PTR(MyClass, wxMyClassPtr)
// define the second pointer class
wxDEFINE_SCOPED_ARRAY(char, wxCharArray)
// create an object with a new pointer to MyClass
wxMyClassPtr theObj(new MyClass());
// reset the pointer (deletes the previous one)
theObj.reset(new MyClass());
// access the pointer
theObj->MyFunc();
// create an object with a new array of chars
wxCharArray theCharObj(new char[100]);
// access the array
theCharObj[0] = "!";
@endcode
<b>Declaring new smart pointer types:</b>
@code
wxDECLAR_SCOPED_ARRAY( TYPE, // type of the values
CLASSNAME ); // name of the class
@endcode
A smart pointer holds a pointer to an object (which must be complete when
wxDEFINE_SCOPED_ARRAY() is called).
The memory used by the object is deleted when the smart pointer goes out of
scope. The first argument of the macro is the pointer type, the second is the
name of the new smart pointer class being created. Below we will use wxScopedArray
to represent the scoped pointer array class, but the user may create the class with
any legal name.
@library{wxbase}
@category{smartpointers}
@see wxScopedPtr
*/
class wxScopedArray
{
public:
/**
Creates the smart pointer with the given pointer or none if @NULL. On
compilers that support it, this uses the explicit keyword.
*/
wxScopedArray(type* T = NULL);
/**
This operator gets the pointer stored in the smart pointer or returns @NULL if
there is none.
*/
const T* get();
/**
This operator acts like the standard [] indexing operator for C++ arrays. The
function does not do bounds checking.
*/
const T& operator [](long int i);
/**
Deletes the currently held pointer and sets it to 'p' or to @NULL if no
arguments are specified. This function does check to make sure that the
pointer you are assigning is not the same pointer that is already stored.
*/
reset(T* p = NULL);
/**
Swap the pointer inside the smart pointer with @a ot. The pointer being swapped
must be of the same type (hence the same class name).
*/
swap(wxScopedArray& ot);
};
/**
A scoped array template class.
This class is similar to boost scoped_array class:
http://www.boost.org/doc/libs/1_37_0/libs/smart_ptr/scoped_array.htm
Notice that objects of this class intentionally cannot be copied.
@library{wxbase}
@category{smartpointers}
*/
template <class T>
class wxScopedArray
{
public:
/// The type of the array elements.
typedef T element_type;
/**
Constructor takes ownership of the given array.
If @a array is @NULL, reset() must presumably be called later.
@param array
An array allocated using @c new[] or @NULL.
*/
explicit wxScopedArray(T * array = NULL);
/// Destructor destroy the array.
~wxScopedArray();
/**
Conversion to a boolean expression (in a variant which is not
convertible to anything but a boolean expression).
If this class contains a valid array it will return @true, if it contains
a @NULL pointer it will return @false.
*/
operator unspecified_bool_type() const;
/**
Change the array pointer stored.
The previously stored array is deleted.
@param array
An array allocated using @c new[] or @NULL.
*/
void reset(T *array = NULL);
/**
Return the n-th element of the array.
Must not be called if the array has no valid pointer.
*/
T& operator[](size_t n) const;
/**
Return the array pointer.
The returned pointer may be @NULL. It must not be deleted by the
caller, call @c reset(NULL) instead.
*/
T *get() const;
/// Swaps the contents of this array with another one.
void swap(wxScopedArray &other);
};
|
