]>
git.saurik.com Git - wxWidgets.git/blob - include/wx/ptr_scpd.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: scoped smart pointer class
4 // Author: Jesse Lovelace <jllovela@eos.ncsu.edu>
8 // Copyright: (c) Jesse Lovelace and original Boost authors (see below)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // This class closely follows the implementation of the boost
13 // library scoped_ptr and is an adaption for c++ macro's in
14 // the wxWidgets project. The original authors of the boost
15 // scoped_ptr are given below with their respective copyrights.
17 // (C) Copyright Greg Colvin and Beman Dawes 1998, 1999.
18 // Copyright (c) 2001, 2002 Peter Dimov
20 // Permission to copy, use, modify, sell and distribute this software
21 // is granted provided this copyright notice appears in all copies.
22 // This software is provided "as is" without express or implied
23 // warranty, and with no claim as to its suitability for any purpose.
25 // See http://www.boost.org/libs/smart_ptr/scoped_ptr.htm for documentation.
28 #ifndef __WX_SCOPED_POINTER__
29 #define __WX_SCOPED_POINTER__
34 checked deleters are used to make sure that the type being deleted is really
35 a complete type.: otherwise sizeof() would result in a compile-time error
37 do { ... } while ( 0 ) construct is used to have an anonymous scope
38 (otherwise we could have name clashes between different "complete"s) but
39 still force a semicolon after the macro
43 #define wxFOR_ONCE(name) for(int name=0; name<1; name++)
44 #define wxPRE_NO_WARNING_SCOPE(name) wxFOR_ONCE(wxMAKE_UNIQUE_NAME(name))
45 #define wxPOST_NO_WARNING_SCOPE(name)
47 #define wxPRE_NO_WARNING_SCOPE(name) do
48 #define wxPOST_NO_WARNING_SCOPE(name) while ( 0 )
51 #define wxCHECKED_DELETE(ptr) \
52 wxPRE_NO_WARNING_SCOPE(scope_var1) \
54 typedef char complete[sizeof(*ptr)]; \
56 } wxPOST_NO_WARNING_SCOPE(scope_var1)
58 #define wxCHECKED_DELETE_ARRAY(ptr) \
59 wxPRE_NO_WARNING_SCOPE(scope_var2) \
61 typedef char complete[sizeof(*ptr)]; \
63 } wxPOST_NO_WARNING_SCOPE(scope_var2)
65 /* These scoped pointers are *not* assignable and cannot be used
66 within a container. Look for wxDECLARE_SHARED_PTR for this
69 In addition, the type being used *must* be complete at the time
70 that wxDEFINE_SCOPED_* is called or a compiler error will result.
71 This is because the class checks for the completeness of the type
76 #define wxDECLARE_SCOPED_PTR(T, name) \
83 name & operator=(name const &); \
86 wxEXPLICIT name(T * ptr = NULL) \
91 void reset(T * ptr = NULL) \
107 T & operator*() const \
109 wxASSERT(m_ptr != NULL); \
113 T * operator->() const \
115 wxASSERT(m_ptr != NULL); \
124 void swap(name & ot) \
126 T * tmp = ot.m_ptr; \
132 #define wxDEFINE_SCOPED_PTR(T, name)\
135 wxCHECKED_DELETE(m_ptr); \
138 // this macro can be used for the most common case when you want to declare and
139 // define the scoped pointer at the same time and want to use the standard
140 // naming convention: auto pointer to Foo is called FooPtr
141 #define wxDEFINE_SCOPED_PTR_TYPE(T) \
142 wxDECLARE_SCOPED_PTR(T, T ## Ptr) \
143 wxDEFINE_SCOPED_PTR(T, T ## Ptr)
145 // the same but for arrays instead of simple pointers
146 #define wxDECLARE_SCOPED_ARRAY(T, name)\
151 name(name const &); \
152 name & operator=(name const &); \
155 wxEXPLICIT name(T * p = NULL) : m_ptr(p) \
159 void reset(T * p = NULL); \
161 T & operator[](long int i) const\
163 wxASSERT(m_ptr != NULL); \
173 void swap(name & ot) \
175 T * tmp = ot.m_ptr; \
181 #define wxDEFINE_SCOPED_ARRAY(T, name) \
184 wxCHECKED_DELETE_ARRAY(m_ptr); \
186 void name::reset(T * p){ \
189 wxCHECKED_DELETE_ARRAY(m_ptr); \
194 // ----------------------------------------------------------------------------
195 // "Tied" scoped pointer: same as normal one but also sets the value of
196 // some other variable to the pointer value
197 // ----------------------------------------------------------------------------
199 #define wxDEFINE_TIED_SCOPED_PTR_TYPE(T) \
200 wxDEFINE_SCOPED_PTR_TYPE(T) \
201 class T ## TiedPtr : public T ## Ptr \
204 T ## TiedPtr(T **pp, T *p) \
205 : T ## Ptr(p), m_pp(pp) \
221 #endif // __WX_SCOPED_POINTER__