projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
include stdlib.h to get malloc/free decl
[wxWidgets.git] / include / wx / buffer.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/buffer.h
3 // Purpose: auto buffer classes: buffers which automatically free memory
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 12.04.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 // these classes are for private use only for now, they're not documented
13
14 #ifndef _WX_BUFFER_H
15 #define _WX_BUFFER_H
16
17 #include "wx/wxchar.h"
18
19 #include <stdlib.h> // malloc() and free()
20
21 // ----------------------------------------------------------------------------
22 // Special classes for (wide) character strings: they use malloc/free instead
23 // of new/delete
24 // ----------------------------------------------------------------------------
25
26 #define DEFINE_BUFFER(classname, chartype, strdupfunc) \
27 class classname \
28 { \
29 public: \
30 classname(const chartype *str) \
31 : m_str(str ? strdupfunc(str) : NULL) \
32 { \
33 } \
34 \
35 classname(size_t len) \
36 : m_str((chartype *)malloc((len + 1)*sizeof(chartype))) \
37 { \
38 m_str[len] = (chartype)0; \
39 } \
40 \
41 /* no need to check for NULL, free() does it */ \
42 ~classname() { free(m_str); } \
43 \
44 /* \
45 WARNING: \
46 \
47 the copy ctor and assignment operators change the passed in object \
48 even although it is declared as "const", so: \
49 \
50 a) it shouldn't be really const \
51 b) you shouldn't use it afterwards (or know that it was reset) \
52 \
53 This is very ugly but is unfortunately needed to make the normal use\
54 of classname buffer objects possible and is very similar to what \
55 std::auto_ptr<> does (as if it were an excuse...) \
56 */ \
57 \
58 /* \
59 because of the remark above, release() is declared const even if it \
60 isn't really const \
61 */ \
62 chartype *release() const \
63 { \
64 chartype *p = m_str; \
65 ((classname *)this)->m_str = NULL; \
66 return p; \
67 } \
68 \
69 classname(const classname& src) \
70 : m_str(src.release()) \
71 { \
72 } \
73 \
74 classname& operator=(const chartype *str) \
75 { \
76 free(m_str); \
77 m_str = str ? strdupfunc(str) : NULL; \
78 return *this; \
79 } \
80 \
81 classname& operator=(const classname& src) \
82 { \
83 free(m_str); \
84 m_str = src.release(); \
85 \
86 return *this; \
87 } \
88 \
89 chartype *data() { return m_str; } \
90 const chartype *data() const { return m_str; } \
91 operator const chartype *() const { return m_str; } \
92 chartype operator[](size_t n) const { return m_str[n]; } \
93 \
94 private: \
95 chartype *m_str; \
96 }
97
98 DEFINE_BUFFER(wxCharBuffer, char, wxStrdupA);
99
100 #if wxUSE_WCHAR_T
101
102 DEFINE_BUFFER(wxWCharBuffer, wchar_t, wxStrdupW);
103
104 #endif // wxUSE_WCHAR_T
105
106 #undef DEFINE_BUFFER
107
108 #if wxUSE_UNICODE
109 #define wxMB2WXbuf wxWCharBuffer
110 #define wxWX2MBbuf wxCharBuffer
111 #define wxWC2WXbuf wxChar*
112 #define wxWX2WCbuf wxChar*
113 #else // ANSI
114 #define wxMB2WXbuf wxChar*
115 #define wxWX2MBbuf wxChar*
116 #define wxWC2WXbuf wxCharBuffer
117 #define wxWX2WCbuf wxWCharBuffer
118 #endif // Unicode/ANSI
119
120 // ----------------------------------------------------------------------------
121 // A class for holding growable data buffers (not necessarily strings)
122 // ----------------------------------------------------------------------------
123
124 // This class manages the actual data buffer pointer and is ref-counted.
125 class wxMemoryBufferData
126 {
127 public:
128 // the initial size and also the size added by ResizeIfNeeded()
129 enum { BLOCK_SIZE = 1024 };
130
131 friend class wxMemoryBuffer;
132
133 // everyting is private as it can only be used by wxMemoryBuffer
134 private:
135 wxMemoryBufferData(size_t size = wxMemoryBufferData::BLOCK_SIZE)
136 : m_data(size ? malloc(size) : NULL), m_size(size), m_len(0), m_ref(0)
137 {
138 }
139 ~wxMemoryBufferData() { free(m_data); }
140
141
142 void ResizeIfNeeded(size_t newSize)
143 {
144 if (newSize > m_size)
145 {
146 void *dataOld = m_data;
147 m_data = realloc(m_data, newSize + wxMemoryBufferData::BLOCK_SIZE);
148 if ( !m_data )
149 {
150 free(dataOld);
151 }
152
153 m_size = newSize + wxMemoryBufferData::BLOCK_SIZE;
154 }
155 }
156
157 void IncRef() { m_ref += 1; }
158 void DecRef()
159 {
160 m_ref -= 1;
161 if (m_ref == 0) // are there no more references?
162 delete this;
163 }
164
165
166 // the buffer containing the data
167 void *m_data;
168
169 // the size of the buffer
170 size_t m_size;
171
172 // the amount of data currently in the buffer
173 size_t m_len;
174
175 // the reference count
176 size_t m_ref;
177
178 DECLARE_NO_COPY_CLASS(wxMemoryBufferData)
179 };
180
181
182 class wxMemoryBuffer
183 {
184 public:
185 // ctor and dtor
186 wxMemoryBuffer(size_t size = wxMemoryBufferData::BLOCK_SIZE)
187 {
188 m_bufdata = new wxMemoryBufferData(size);
189 m_bufdata->IncRef();
190 }
191
192 ~wxMemoryBuffer() { m_bufdata->DecRef(); }
193
194
195 // copy and assignment
196 wxMemoryBuffer(const wxMemoryBuffer& src)
197 : m_bufdata(src.m_bufdata)
198 {
199 m_bufdata->IncRef();
200 }
201
202 wxMemoryBuffer& operator=(const wxMemoryBuffer& src)
203 {
204 m_bufdata->DecRef();
205 m_bufdata = src.m_bufdata;
206 m_bufdata->IncRef();
207 return *this;
208 }
209
210
211 // Accessors
212 void *GetData() const { return m_bufdata->m_data; }
213 size_t GetBufSize() const { return m_bufdata->m_size; }
214 size_t GetDataLen() const { return m_bufdata->m_len; }
215
216 void SetBufSize(size_t size) { m_bufdata->ResizeIfNeeded(size); }
217 void SetDataLen(size_t len)
218 {
219 wxASSERT(len <= m_bufdata->m_size);
220 m_bufdata->m_len = len;
221 }
222
223 // Ensure the buffer is big enough and return a pointer to it
224 void *GetWriteBuf(size_t sizeNeeded)
225 {
226 m_bufdata->ResizeIfNeeded(sizeNeeded);
227 return m_bufdata->m_data;
228 }
229
230 // Update the length after the write
231 void UngetWriteBuf(size_t sizeUsed) { SetDataLen(sizeUsed); }
232
233 // Like the above, but appends to the buffer
234 void *GetAppendBuf(size_t sizeNeeded)
235 {
236 m_bufdata->ResizeIfNeeded(m_bufdata->m_len + sizeNeeded);
237 return (char*)m_bufdata->m_data + m_bufdata->m_len;
238 }
239
240 // Update the length after the append
241 void UngetAppendBuf(size_t sizeUsed)
242 {
243 SetDataLen(m_bufdata->m_len + sizeUsed);
244 }
245
246 // Other ways to append to the buffer
247 void AppendByte(char data)
248 {
249 wxCHECK_RET( m_bufdata->m_data, _T("invalid wxMemoryBuffer") );
250
251 m_bufdata->ResizeIfNeeded(m_bufdata->m_len + 1);
252 *(((char*)m_bufdata->m_data) + m_bufdata->m_len) = data;
253 m_bufdata->m_len += 1;
254 }
255
256 void AppendData(void* data, size_t len)
257 {
258 memcpy(GetAppendBuf(len), data, len);
259 UngetAppendBuf(len);
260 }
261
262 operator const char *() const { return (const char*)GetData(); }
263
264 private:
265 wxMemoryBufferData* m_bufdata;
266 };
267
268 // ----------------------------------------------------------------------------
269 // template class for any kind of data
270 // ----------------------------------------------------------------------------
271
272 // TODO
273
274 #endif // _WX_BUFFER_H
wxWidgets (Impactor)