]> git.saurik.com Git - wxWidgets.git/blob - include/wx/object.h
f285a791f5f713bc8a208988a37f8b865a69dcd7
[wxWidgets.git] / include / wx / object.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: object.h
3 // Purpose: wxObject class, plus run-time type information macros
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_OBJECTH__
13 #define _WX_OBJECTH__
14
15 #ifdef __GNUG__
16 #pragma interface "object.h"
17 #endif
18
19 #include "wx/defs.h"
20 #include "wx/memory.h"
21
22 class WXDLLEXPORT wxObject;
23
24 #if wxUSE_DYNAMIC_CLASSES
25
26 // #ifdef __GNUWIN32__
27 #ifdef GetClassName
28 #undef GetClassName
29 #endif
30 #ifdef GetClassInfo
31 #undef GetClassInfo
32 #endif
33 // #endif
34
35 class WXDLLEXPORT wxClassInfo;
36 class WXDLLEXPORT wxInputStream;
37 class WXDLLEXPORT wxOutputStream;
38 class WXDLLEXPORT wxObjectInputStream;
39 class WXDLLEXPORT wxObjectOutputStream;
40 class WXDLLEXPORT wxHashTable;
41 class WXDLLEXPORT wxObject_Serialize;
42
43 #if wxUSE_IOSTREAMH
44 // N.B. BC++ doesn't have istream.h, ostream.h
45 # include <iostream.h>
46 #else
47 # include <ostream>
48 # if defined(__VISUALC__) || defined(__MWERKS__)
49 using namespace std;
50 # endif
51 #endif
52
53 /*
54 * Dynamic object system declarations
55 */
56
57 typedef wxObject * (*wxObjectConstructorFn) (void);
58
59 class WXDLLEXPORT wxClassInfo
60 {
61 public:
62 wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn fn);
63
64 wxObject *CreateObject(void);
65
66 inline char *GetClassName(void) const { return m_className; }
67 inline char *GetBaseClassName1(void) const { return m_baseClassName1; }
68 inline char *GetBaseClassName2(void) const { return m_baseClassName2; }
69 inline wxClassInfo* GetBaseClass1() const { return m_baseInfo1; }
70 inline wxClassInfo* GetBaseClass2() const { return m_baseInfo2; }
71 inline int GetSize(void) const { return m_objectSize; }
72 inline wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
73 static inline wxClassInfo* GetFirst() { return sm_first; }
74 inline wxClassInfo* GetNext() const { return m_next; }
75 bool IsKindOf(wxClassInfo *info) const;
76
77 static wxClassInfo *FindClass(char *c);
78
79 // Initializes parent pointers and hash table for fast searching.
80 static void InitializeClasses(void);
81
82 // Cleans up hash table used for fast searching.
83 static void CleanUpClasses(void);
84
85 public:
86 char* m_className;
87 char* m_baseClassName1;
88 char* m_baseClassName2;
89 int m_objectSize;
90 wxObjectConstructorFn m_objectConstructor;
91
92 // Pointers to base wxClassInfos: set in InitializeClasses
93 // called from wx_main.cc
94 wxClassInfo* m_baseInfo1;
95 wxClassInfo* m_baseInfo2;
96
97 static wxClassInfo* sm_first;
98 wxClassInfo* m_next;
99
100 static wxHashTable* sm_classTable;
101 };
102
103 WXDLLEXPORT wxObject* wxCreateDynamicObject(const char *name);
104
105 #if wxUSE_SERIAL
106 WXDLLEXPORT wxObject* wxCreateStoredObject( wxInputStream& stream );
107 #endif
108
109 #define DECLARE_DYNAMIC_CLASS(name) \
110 public:\
111 static wxClassInfo sm_class##name;\
112 wxClassInfo *GetClassInfo() const \
113 { return &name::sm_class##name; }
114
115 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
116 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
117
118 //////
119 ////// for concrete classes
120 //////
121
122 // Single inheritance with one base class
123 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
124 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
125 { return new name; }\
126 wxClassInfo name::sm_class##name((char *) #name, (char *) #basename, (char *) NULL, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
127
128 // Multiple inheritance with two base classes
129 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
130 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
131 { return new name; }\
132 wxClassInfo name::sm_class##name((char *) #name, (char *) #basename1, (char *) #basename2, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
133
134 //////
135 ////// for abstract classes
136 //////
137
138 // Single inheritance with one base class
139 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
140 wxClassInfo name::sm_class##name((char *) #name, (char *) #basename, \
141 (char *) NULL, (int) sizeof(name), (wxObjectConstructorFn) NULL);
142
143 // Multiple inheritance with two base classes
144 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
145 wxClassInfo name::sm_class##name((char *) #name, (char *) #basename1, (char *) #basename2, (int) sizeof(name), (wxObjectConstructorFn) NULL);
146
147 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
148 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
149
150 #define CLASSINFO(name) (&name::sm_class##name)
151
152 #else
153
154 // No dynamic class system: so stub out the macros
155 #define DECLARE_DYNAMIC_CLASS(name)
156 #define DECLARE_ABSTRACT_CLASS(name)
157 #define DECLARE_CLASS(name)
158 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)
159 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
160 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)
161 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
162 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
163 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
164
165 #endif
166
167 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
168
169 // Just seems a bit nicer-looking (pretend it's not a macro)
170 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
171
172 // Unfortunately Borland seems to need this include.
173 #ifdef __BORLANDC__
174 #if wxUSE_IOSTREAMH
175 #include <iostream.h>
176 #else
177 #include <iostream>
178 #endif
179 #endif
180
181 class WXDLLEXPORT wxObjectRefData;
182
183 class WXDLLEXPORT wxObject
184 {
185 public:
186
187 // This is equivalent to using the macro DECLARE_ABSTRACT_CLASS
188 static wxClassInfo sm_classwxObject;
189
190 wxObject(void);
191 virtual ~wxObject(void);
192
193 virtual wxClassInfo *GetClassInfo(void) const { return &sm_classwxObject; }
194
195 bool IsKindOf(wxClassInfo *info) const;
196
197 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
198 void * operator new (size_t size, char * fileName = NULL, int lineNum = 0);
199 void operator delete (void * buf);
200
201 // VC++ 6.0
202 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
203 void operator delete(void *buf, char*, int);
204 #endif
205
206 // Causes problems for VC++
207 #if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) &6 !defined( __MWERKS__)
208 void * operator new[] (size_t size, char * fileName = NULL, int lineNum = 0);
209 void operator delete[] (void * buf);
210 #endif
211
212 #ifdef __MWERKS__
213 void * operator new[] (size_t size, char * fileName , int lineNum = 0);
214 void operator delete[] (void * buf);
215 #endif
216
217 #endif // Debug & memory tracing
218
219 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
220 virtual void Dump(ostream& str);
221 #endif
222
223 #if wxUSE_SERIAL
224 virtual void StoreObject( wxObjectOutputStream &stream );
225 virtual void LoadObject( wxObjectInputStream &stream );
226 #endif
227
228 // make a 'clone' of the object
229 void Ref(const wxObject& clone);
230
231 // destroy a reference
232 void UnRef(void);
233
234 inline wxObjectRefData *GetRefData(void) const { return m_refData; }
235 inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
236
237 protected:
238 wxObjectRefData* m_refData;
239 #if wxUSE_SERIAL
240 wxObject_Serialize* m_serialObj;
241 #endif
242 };
243
244 /*
245 * wxObjectData
246 */
247
248 class WXDLLEXPORT wxObjectRefData {
249
250 friend class wxObject;
251
252 public:
253 wxObjectRefData(void);
254 virtual ~wxObjectRefData(void);
255
256 inline int GetRefCount(void) const { return m_count; }
257 private:
258 int m_count;
259 };
260
261 #ifdef __WXDEBUG__
262 #ifndef WXDEBUG_NEW
263 #define WXDEBUG_NEW new(__FILE__,__LINE__)
264 #endif
265 #else
266 #define WXDEBUG_NEW new
267 #endif
268
269 // Redefine new to be the debugging version. This doesn't
270 // work with all compilers, in which case you need to
271 // use WXDEBUG_NEW explicitly if you wish to use the debugging version.
272
273 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
274 #define new new(__FILE__,__LINE__)
275 #endif
276
277 #endif
278 // _WX_OBJECTH__
279
280