]> git.saurik.com Git - wxWidgets.git/blame - src/common/object.cpp
wxBitmap compilation fix for BCC enforced typecast in resource.cpp
[wxWidgets.git] / src / common / object.cpp
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: object.cpp
3// Purpose: wxObject implementation
4// Author: Julian Smart
5// Modified by:
6// Created: 04/01/98
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart and Markus Holzem
3f4a0c5b 9// Licence: wxWindows license
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
12#ifdef __GNUG__
13#pragma implementation "object.h"
14#endif
15
16// For compilers that support precompilation, includes "wx.h".
17#include "wx/wxprec.h"
18
19#ifdef __BORLANDC__
20#pragma hdrstop
21#endif
22
1678ad78 23#ifndef WX_PRECOMP
794df945 24 #include "wx/hash.h"
1ccbb61a 25 #if wxUSE_SERIAL
794df945
VZ
26 #include "wx/objstrm.h"
27 #include "wx/serbase.h"
28
29 // for error messages
30 #include "wx/log.h"
31 #include "wx/intl.h"
32 #endif // wxUSE_SERIAL
33#endif // WX_PRECOMP
c801d85f
KB
34
35#include <string.h>
36#include <assert.h>
37
ea57084d 38#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
c801d85f
KB
39#include "wx/memory.h"
40#endif
41
ea57084d 42#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
3f4a0c5b
VZ
43 // for wxObject::Dump
44 #include "wx/ioswrap.h"
415ca026
DW
45 #if defined(__VISAGECPP__)
46 // help with VA debugging
47 #define DEBUG_PRINTF(NAME) { static int raz=0; \
48 printf( #NAME " %i\n",raz); fflush(stdout); \
49 raz++; \
50 }
51 #else
52 #define DEBUG_PRINTF(NAME)
53 #endif
c801d85f
KB
54#endif
55
223d09f6 56wxClassInfo wxObject::sm_classwxObject((wxChar *) wxT("wxObject"), (wxChar *) NULL, (wxChar *) NULL, (int ) sizeof(wxObject), (wxObjectConstructorFn) NULL);
0c32066b
JS
57wxClassInfo* wxClassInfo::sm_first = (wxClassInfo *) NULL;
58wxHashTable* wxClassInfo::sm_classTable = (wxHashTable*) NULL;
c801d85f 59
415ca026
DW
60#if defined(__WXDEBUG__) && defined(__VISAGECPP__)
61 int wxObject::N = 0; // total number of objects
62 int wxObject::Nid = 0;// object serial counter
63#endif // __WXDEBUG__
64
f6bcfd97
BP
65// These are here so we can avoid 'always true/false' warnings
66// by referring to these instead of TRUE/FALSE
67const bool wxTrue = TRUE;
68const bool wxFalse = FALSE;
69
c801d85f
KB
70/*
71 * wxWindows root object.
72 */
73
afb74891 74wxObject::wxObject()
c801d85f 75{
afb74891 76 m_refData = (wxObjectRefData *) NULL;
1ccbb61a 77#if wxUSE_SERIAL
afb74891 78 m_serialObj = (wxObject_Serialize *)NULL;
f4a8c29f 79#endif
415ca026
DW
80#if defined(__WXDEBUG__) && defined(__VISAGECPP__)
81 id = Nid++;
82 N++;
83// { printf("wxObject %i/%i \t",id,N);
84// }
85#endif
c801d85f
KB
86}
87
afb74891 88wxObject::~wxObject()
c801d85f 89{
afb74891 90 UnRef();
1ccbb61a 91#if wxUSE_SERIAL
afb74891
VZ
92 if (m_serialObj)
93 delete m_serialObj;
f4a8c29f 94#endif
415ca026
DW
95#if defined(__WXDEBUG__) && defined(__VISAGECPP__)
96 N--;
97// { printf("~wxObject %i/%i \t",id,N);
98// }
99#endif //__WXDEBUG__
c801d85f
KB
100}
101
102/*
103 * Is this object a kind of (a subclass of) 'info'?
104 * E.g. is wxWindow a kind of wxObject?
105 * Go from this class to superclass, taking into account
106 * two possible base classes.
107 */
afb74891 108
341287bf 109bool wxObject::IsKindOf(wxClassInfo *info) const
c801d85f 110{
afb74891
VZ
111 wxClassInfo *thisInfo = GetClassInfo();
112 if (thisInfo)
113 return thisInfo->IsKindOf(info);
114 else
115 return FALSE;
c801d85f
KB
116}
117
a737331d
GL
118wxObject *wxObject::Clone() const
119{
aadbdf11
GL
120 wxObject *object = GetClassInfo()->CreateObject();
121 CopyObject(*object);
122 return object;
123}
124
72cdf4c9 125#ifdef __WXDEBUG__
aadbdf11 126void wxObject::CopyObject(wxObject& object_dest) const
72cdf4c9
VZ
127#else // !Debug
128void wxObject::CopyObject(wxObject& WXUNUSED(object_dest)) const
129#endif // Debug/!Debug
aadbdf11
GL
130{
131 wxASSERT(object_dest.GetClassInfo()->IsKindOf(GetClassInfo()));
a737331d
GL
132}
133
38830220 134#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
c801d85f
KB
135void wxObject::Dump(ostream& str)
136{
afb74891
VZ
137 if (GetClassInfo() && GetClassInfo()->GetClassName())
138 str << GetClassInfo()->GetClassName();
139 else
140 str << "unknown object class";
c801d85f
KB
141}
142#endif
143
ea57084d 144#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
c801d85f
KB
145
146#ifdef new
147#undef new
148#endif
149
4de6207a 150void *wxObject::operator new (size_t size, wxChar * fileName, int lineNum)
c801d85f 151{
afb74891 152 return wxDebugAlloc(size, fileName, lineNum, TRUE);
c801d85f
KB
153}
154
415ca026
DW
155#if defined(__VISAGECPP__)
156# if __DEBUG_ALLOC__
157void wxObject::operator delete (void * buf,const char * _fname, size_t _line)
158{
159 wxDebugFree(buf);
160}
161# endif //__DEBUG_ALLOC__
162#else
c801d85f
KB
163void wxObject::operator delete (void * buf)
164{
afb74891 165 wxDebugFree(buf);
c801d85f 166}
415ca026 167#endif // __VISAGECPP__
c801d85f 168
76626af2 169// VC++ 6.0
3f4a0c5b 170#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
f6bcfd97 171void wxObject::operator delete(void* pData, wxChar* /* fileName */, int /* lineNum */)
76626af2 172{
afb74891 173 ::operator delete(pData);
76626af2
JS
174}
175#endif
176
c801d85f 177// Cause problems for VC++ - crashes
7c74e7fe 178#if (!defined(__VISUALC__) && wxUSE_ARRAY_MEMORY_OPERATORS ) || defined(__MWERKS__)
4de6207a 179void * wxObject::operator new[] (size_t size, wxChar * fileName, int lineNum)
c801d85f 180{
afb74891 181 return wxDebugAlloc(size, fileName, lineNum, TRUE, TRUE);
c801d85f
KB
182}
183
184void wxObject::operator delete[] (void * buf)
185{
afb74891 186 wxDebugFree(buf, TRUE);
c801d85f
KB
187}
188#endif
189
190#endif
191
192/*
193 * Class info: provides run-time class type information.
194 */
195
cf2f341a 196wxClassInfo::wxClassInfo(wxChar *cName, wxChar *baseName1, wxChar *baseName2, int sz, wxObjectConstructorFn constr)
c801d85f 197{
afb74891
VZ
198 m_className = cName;
199 m_baseClassName1 = baseName1;
200 m_baseClassName2 = baseName2;
201
202 m_objectSize = sz;
203 m_objectConstructor = constr;
204
205 m_next = sm_first;
206 sm_first = this;
207
208 m_baseInfo1 = (wxClassInfo *) NULL;
209 m_baseInfo2 = (wxClassInfo *) NULL;
c801d85f
KB
210}
211
afb74891 212wxObject *wxClassInfo::CreateObject()
c801d85f 213{
afb74891
VZ
214 if (m_objectConstructor)
215 return (wxObject *)(*m_objectConstructor)();
216 else
217 return (wxObject *) NULL;
c801d85f
KB
218}
219
cf2f341a 220wxClassInfo *wxClassInfo::FindClass(wxChar *c)
c801d85f 221{
afb74891
VZ
222 wxClassInfo *p = sm_first;
223 while (p)
224 {
cf2f341a 225 if (p && p->GetClassName() && wxStrcmp(p->GetClassName(), c) == 0)
afb74891
VZ
226 return p;
227 p = p->m_next;
228 }
229 return (wxClassInfo *) NULL;
c801d85f
KB
230}
231
232// Climb upwards through inheritance hierarchy.
233// Dual inheritance is catered for.
341287bf 234bool wxClassInfo::IsKindOf(wxClassInfo *info) const
c801d85f 235{
afb74891
VZ
236 if (info == NULL)
237 return FALSE;
238
afb74891
VZ
239 if (this == info)
240 return TRUE;
c801d85f 241
afb74891
VZ
242 if (m_baseInfo1)
243 if (m_baseInfo1->IsKindOf(info))
244 return TRUE;
c801d85f 245
afb74891
VZ
246 if (m_baseInfo2)
247 return m_baseInfo2->IsKindOf(info);
c801d85f 248
afb74891 249 return FALSE;
c801d85f
KB
250}
251
252// Set pointers to base class(es) to speed up IsKindOf
afb74891 253void wxClassInfo::InitializeClasses()
c801d85f 254{
309689b2
VZ
255 // using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you
256 // link any object module twice mistakenly) will break this function
257 // because it will enter an infinite loop and eventually die with "out of
258 // memory" - as this is quite hard to detect if you're unaware of this,
259 // try to do some checks here
260#ifdef __WXDEBUG__
261 // more classes than we'll ever have
262 static const size_t nMaxClasses = 10000;
263 size_t nClass = 0;
264#endif // Debug
265
afb74891
VZ
266 wxClassInfo::sm_classTable = new wxHashTable(wxKEY_STRING);
267
268 // Index all class infos by their class name
269 wxClassInfo *info = sm_first;
270 while (info)
271 {
272 if (info->m_className)
309689b2
VZ
273 {
274 wxASSERT_MSG( ++nClass < nMaxClasses,
f6bcfd97 275 _T("an infinite loop detected - have you used IMPLEMENT_DYNAMIC_CLASS() twice (may be by linking some object module(s) twice)?") );
309689b2 276
afb74891 277 sm_classTable->Put(info->m_className, (wxObject *)info);
309689b2
VZ
278 }
279
afb74891
VZ
280 info = info->m_next;
281 }
282
283 // Set base pointers for each wxClassInfo
284 info = sm_first;
285 while (info)
286 {
287 if (info->GetBaseClassName1())
288 info->m_baseInfo1 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName1());
289 if (info->GetBaseClassName2())
290 info->m_baseInfo2 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName2());
291 info = info->m_next;
292 }
c801d85f
KB
293}
294
afb74891 295void wxClassInfo::CleanUpClasses()
c801d85f 296{
0c32066b
JS
297 delete wxClassInfo::sm_classTable;
298 wxClassInfo::sm_classTable = NULL;
299}
f4a8c29f 300
cf2f341a 301wxObject *wxCreateDynamicObject(const wxChar *name)
0c32066b 302{
bbee61e5 303#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
415ca026 304 DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
bbee61e5
JJ
305#endif
306
0c32066b
JS
307 if (wxClassInfo::sm_classTable)
308 {
309 wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
310 if (!info)
311 return (wxObject *)NULL;
312
313 return info->CreateObject();
314 }
315 else
316 {
317 wxClassInfo *info = wxClassInfo::sm_first;
318 while (info)
319 {
cf2f341a 320 if (info->m_className && wxStrcmp(info->m_className, name) == 0)
0c32066b
JS
321 return info->CreateObject();
322 info = info->m_next;
323 }
324 return (wxObject*) NULL;
325 }
c801d85f
KB
326}
327
1ccbb61a 328#if wxUSE_SERIAL
c801d85f 329
7a4b9130
GL
330#include "wx/serbase.h"
331#include "wx/dynlib.h"
7a4b9130 332
1678ad78 333wxObject* wxCreateStoredObject( wxInputStream &stream )
c801d85f 334{
afb74891
VZ
335 wxObjectInputStream obj_s(stream);
336 return obj_s.LoadObject();
c801d85f
KB
337};
338
7a4b9130
GL
339void wxObject::StoreObject( wxObjectOutputStream& stream )
340{
bbee61e5 341#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
415ca026 342 DEBUG_PRINTF(wxObject::StoreObject)
bbee61e5
JJ
343#endif
344
afb74891
VZ
345 wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize";
346 wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial");
7a4b9130 347
afb74891
VZ
348 if (!lib) {
349 wxLogError(_("Can't load wxSerial dynamic library."));
350 return;
351 }
f4a8c29f 352 if (!m_serialObj) {
afb74891
VZ
353 m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name );
354
355 if (!m_serialObj) {
356 wxLogError(_("Can't find the serialization object '%s' "
357 "for the object '%s'."),
358 obj_name.c_str(),
359 GetClassInfo()->GetClassName());
360 return;
361 }
362 m_serialObj->SetObject(this);
f4a8c29f 363 }
7a4b9130 364
afb74891 365 m_serialObj->StoreObject(stream);
7a4b9130
GL
366}
367
368void wxObject::LoadObject( wxObjectInputStream& stream )
369{
bbee61e5 370#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
415ca026 371 DEBUG_PRINTF(wxObject::LoadObject)
bbee61e5
JJ
372#endif
373
afb74891
VZ
374 wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize";
375 wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial");
7a4b9130 376
f4a8c29f 377 if (!m_serialObj) {
afb74891
VZ
378 m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name );
379
380 if (!m_serialObj) {
381 wxLogError(_("Can't find the serialization object '%s' "
382 "for the object '%s'."),
383 obj_name.c_str(),
384 GetClassInfo()->GetClassName());
385 return;
386 }
387 m_serialObj->SetObject(this);
f4a8c29f 388 }
6f34921d 389
afb74891 390 m_serialObj->LoadObject(stream);
7a4b9130
GL
391}
392
bfc6fde4 393#endif // wxUSE_SERIAL
c801d85f
KB
394
395/*
396 * wxObject: cloning of objects
397 */
398
399void wxObject::Ref(const wxObject& clone)
400{
bbee61e5 401#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
415ca026 402 DEBUG_PRINTF(wxObject::Ref)
bbee61e5
JJ
403#endif
404 // delete reference to old data
c801d85f
KB
405 UnRef();
406 // reference new data
407 if (clone.m_refData) {
408 m_refData = clone.m_refData;
409 ++(m_refData->m_count);
410 }
411}
412
afb74891 413void wxObject::UnRef()
c801d85f 414{
4fe5383d
VZ
415 if ( m_refData )
416 {
417 wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
418
419 if ( !--m_refData->m_count )
c801d85f 420 delete m_refData;
4fe5383d 421 m_refData = (wxObjectRefData *) NULL;
c801d85f 422 }
c801d85f
KB
423}
424
425/*
426 * wxObjectData
427 */
428
429wxObjectRefData::wxObjectRefData(void) : m_count(1)
430{
431}
432
afb74891 433wxObjectRefData::~wxObjectRefData()
c801d85f
KB
434{
435}