added GetBaseClassName1 and 2 for memory.cpp compiles
[wxWidgets.git] / include / wx / xti.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/xti.hG
3 // Purpose: runtime metadata information (extended class info)
4 // Author: Stefan Csomor
5 // Modified by:
6 // Created: 27/07/03
7 // RCS-ID: $Id$
8 // Copyright: (c) 1997 Julian Smart
9 // (c) 2003 Stefan Csomor
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_XTIH__
14 #define _WX_XTIH__
15
16 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
17 #pragma interface "xti.h"
18 #endif
19
20 // We want to support properties, event sources and events sinks through
21 // explicit declarations, using templates and specialization to make the
22 // effort as painless as possible.
23 //
24 // This means we have the following domains :
25 //
26 // - Type Information for categorizing built in types as well as custom types
27 // this includes information about enums, their values and names
28 // - Type safe value storage : a kind of wxVariant, called right now wxxVariant
29 // which will be merged with wxVariant
30 // - Property Information and Property Accessors providing access to a class'
31 // values and exposed event delegates
32 // - Information about event handlers
33 // - extended Class Information for accessing all these
34
35 // ----------------------------------------------------------------------------
36 // headers
37 // ----------------------------------------------------------------------------
38
39 #include "wx/defs.h"
40 #include "wx/memory.h"
41 #include "wx/flags.h"
42 #include "wx/string.h"
43 #include "wx/arrstr.h"
44 #include "wx/hashmap.h"
45
46 #include <typeinfo>
47
48 // we will move this later to defs.h
49
50 #if !wxCHECK_GCC_VERSION( 3 , 4 )
51 # define wxUSE_MEMBER_TEMPLATES 0
52 #endif
53
54 #ifdef _MSC_VER
55 # if _MSC_VER <= 1200
56 # define wxUSE_MEMBER_TEMPLATES 0
57 # endif
58 #endif
59
60 #ifndef wxUSE_MEMBER_TEMPLATES
61 #define wxUSE_MEMBER_TEMPLATES 1
62 #endif
63
64 #if wxUSE_MEMBER_TEMPLATES
65 #define WX_TEMPLATED_MEMBER_CALL( method , type ) method<type>()
66 #define WX_TEMPLATED_MEMBER_FIX( type )
67 #else
68 #define WX_TEMPLATED_MEMBER_CALL( method , type ) method((type*)NULL)
69 #define WX_TEMPLATED_MEMBER_FIX( type ) type* =NULL
70 #endif
71
72 class WXDLLIMPEXP_BASE wxObject;
73 class WXDLLIMPEXP_BASE wxClassInfo;
74 class WXDLLIMPEXP_BASE wxDynamicClassInfo;
75 class WXDLLIMPEXP_BASE wxHashTable;
76 class WXDLLIMPEXP_BASE wxObjectRefData;
77 class WXDLLIMPEXP_BASE wxEvent;
78
79 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
80
81 // ----------------------------------------------------------------------------
82 // Enum Support
83 //
84 // In the header files there would no change from pure c++ code, in the
85 // implementation, an enum would have
86 // to be enumerated eg :
87 //
88 // WX_BEGIN_ENUM( wxFlavor )
89 // WX_ENUM_MEMBER( Vanilla )
90 // WX_ENUM_MEMBER( Chocolate )
91 // WX_ENUM_MEMBER( Strawberry )
92 // WX_END_ENUM( wxFlavor )
93 // ----------------------------------------------------------------------------
94
95 struct WXDLLIMPEXP_BASE wxEnumMemberData
96 {
97 const wxChar* m_name;
98 int m_value;
99 };
100
101 class WXDLLIMPEXP_BASE wxEnumData
102 {
103 public :
104 wxEnumData( wxEnumMemberData* data ) ;
105
106 // returns true if the member has been found and sets the int value
107 // pointed to accordingly (if ptr != null )
108 // if not found returns false, value left unchanged
109 bool HasEnumMemberValue( const wxChar *name , int *value = NULL ) const ;
110
111 // returns the value of the member, if not found in debug mode an
112 // assert is issued, in release 0 is returned
113 int GetEnumMemberValue(const wxChar *name ) const ;
114
115 // returns the name of the enum member having the passed in value
116 // returns an emtpy string if not found
117 const wxChar *GetEnumMemberName(int value) const ;
118
119 // returns the number of members in this enum
120 int GetEnumCount() const { return m_count ; }
121
122 // returns the value of the nth member
123 int GetEnumMemberValueByIndex( int n ) const ;
124
125 // returns the value of the nth member
126 const wxChar *GetEnumMemberNameByIndex( int n ) const ;
127 private :
128 wxEnumMemberData *m_members;
129 int m_count ;
130 };
131
132 #define WX_BEGIN_ENUM( e ) \
133 wxEnumMemberData s_enumDataMembers##e[] = {
134
135 #define WX_ENUM_MEMBER( v ) { wxT(#v), v } ,
136
137 #define WX_END_ENUM( e ) { NULL , 0 } } ; \
138 wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
139 wxEnumData *wxGetEnumData(e) { return &s_enumData##e ; } \
140 template<> void wxStringReadValue(const wxString& s , e &data ) \
141 { \
142 data = (e) s_enumData##e.GetEnumMemberValue(s) ; \
143 } \
144 template<> void wxStringWriteValue(wxString &s , const e &data ) \
145 { \
146 s = s_enumData##e.GetEnumMemberName((int)data) ; \
147 } \
148 void FromLong##e( long data , wxxVariant& result ) { result = wxxVariant((e)data) ;} \
149 void ToLong##e( const wxxVariant& data , long &result ) { result = (long) data.Get<e>() ;} \
150 wxEnumTypeInfo s_typeInfo##e(wxT_ENUM , &s_enumData##e , &wxToStringConverter<e> , &wxFromStringConverter<e> , &ToLong##e , &FromLong##e , typeid(e).name() ) ;
151
152 // ----------------------------------------------------------------------------
153 // Set Support
154 //
155 // in the header :
156 //
157 // enum wxFlavor
158 // {
159 // Vanilla,
160 // Chocolate,
161 // Strawberry,
162 // };
163 //
164 // typedef wxBitset<wxFlavor> wxCoupe ;
165 //
166 // in the implementation file :
167 //
168 // WX_BEGIN_ENUM( wxFlavor )
169 // WX_ENUM_MEMBER( Vanilla )
170 // WX_ENUM_MEMBER( Chocolate )
171 // WX_ENUM_MEMBER( Strawberry )
172 // WX_END_ENUM( wxFlavor )
173 //
174 // WX_IMPLEMENT_SET_STREAMING( wxCoupe , wxFlavor )
175 //
176 // implementation note : no partial specialization for streaming, but a delegation to a
177 // different class
178 //
179 // ----------------------------------------------------------------------------
180
181 // in order to remove dependancy on string tokenizer
182 void wxSetStringToArray( const wxString &s , wxArrayString &array ) ;
183
184 template<typename e>
185 void wxSetFromString(const wxString &s , wxBitset<e> &data )
186 {
187 wxEnumData* edata = wxGetEnumData((e) 0) ;
188 data.reset() ;
189
190 wxArrayString array ;
191 wxSetStringToArray( s , array ) ;
192 wxString flag;
193 for ( int i = 0 ; i < array.Count() ; ++i )
194 {
195 flag = array[i] ;
196 int ivalue ;
197 if ( edata->HasEnumMemberValue( flag , &ivalue ) )
198 {
199 data.set( (e) ivalue ) ;
200 }
201 }
202 }
203
204 template<typename e>
205 void wxSetToString( wxString &s , const wxBitset<e> &data )
206 {
207 wxEnumData* edata = wxGetEnumData((e) 0) ;
208 int count = edata->GetEnumCount() ;
209 int i ;
210 s.Clear() ;
211 for ( i = 0 ; i < count ; i++ )
212 {
213 e value = (e) edata->GetEnumMemberValueByIndex(i) ;
214 if ( data.test( value ) )
215 {
216 // this could also be done by the templated calls
217 if ( !s.IsEmpty() )
218 s +=wxT("|") ;
219 s += edata->GetEnumMemberNameByIndex(i) ;
220 }
221 }
222 }
223
224 #define WX_IMPLEMENT_SET_STREAMING(SetName,e) \
225 template<> void wxStringReadValue(const wxString &s , wxBitset<e> &data ) \
226 { \
227 wxSetFromString( s , data ) ; \
228 } \
229 template<> void wxStringWriteValue( wxString &s , const wxBitset<e> &data ) \
230 { \
231 wxSetToString( s , data ) ; \
232 } \
233 void FromLong##SetName( long data , wxxVariant& result ) { result = wxxVariant(SetName((unsigned long)data)) ;} \
234 void ToLong##SetName( const wxxVariant& data , long &result ) { result = (long) data.Get<SetName>().to_ulong() ;} \
235 wxEnumTypeInfo s_typeInfo##SetName(wxT_SET , &s_enumData##e , &wxToStringConverter<SetName> , &wxFromStringConverter<SetName> , &ToLong##SetName , &FromLong##SetName, typeid(SetName).name() ) ; \
236 }
237
238 template<typename e>
239 void wxFlagsFromString(const wxString &s , e &data )
240 {
241 wxEnumData* edata = wxGetEnumData((e*) 0) ;
242 data.m_data = 0 ;
243
244 wxArrayString array ;
245 wxSetStringToArray( s , array ) ;
246 wxString flag;
247 for ( size_t i = 0 ; i < array.Count() ; ++i )
248 {
249 flag = array[i] ;
250 int ivalue ;
251 if ( edata->HasEnumMemberValue( flag , &ivalue ) )
252 {
253 data.m_data |= ivalue ;
254 }
255 }
256 }
257
258 template<typename e>
259 void wxFlagsToString( wxString &s , const e& data )
260 {
261 wxEnumData* edata = wxGetEnumData((e*) 0) ;
262 int count = edata->GetEnumCount() ;
263 int i ;
264 s.Clear() ;
265 long dataValue = data.m_data ;
266 for ( i = 0 ; i < count ; i++ )
267 {
268 int value = edata->GetEnumMemberValueByIndex(i) ;
269 // make this to allow for multi-bit constants to work
270 if ( value && ( dataValue & value ) == value )
271 {
272 // clear the flags we just set
273 dataValue &= ~value ;
274 // this could also be done by the templated calls
275 if ( !s.IsEmpty() )
276 s +=wxT("|") ;
277 s += edata->GetEnumMemberNameByIndex(i) ;
278 }
279 }
280 }
281
282 #define WX_BEGIN_FLAGS( e ) \
283 wxEnumMemberData s_enumDataMembers##e[] = {
284
285 #define WX_FLAGS_MEMBER( v ) { wxT(#v), v } ,
286
287 #define WX_END_FLAGS( e ) { NULL , 0 } } ; \
288 wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
289 wxEnumData *wxGetEnumData(e*) { return &s_enumData##e ; } \
290 template<> void wxStringReadValue(const wxString &s , e &data ) \
291 { \
292 wxFlagsFromString<e>( s , data ) ; \
293 } \
294 template<> void wxStringWriteValue( wxString &s , const e& data ) \
295 { \
296 wxFlagsToString<e>( s , data ) ; \
297 } \
298 void FromLong##e( long data , wxxVariant& result ) { result = wxxVariant(e(data)) ;} \
299 void ToLong##e( const wxxVariant& data , long &result ) { result = (long) data.Get<e>().m_data ;} \
300 wxEnumTypeInfo s_typeInfo##e(wxT_SET , &s_enumData##e , &wxToStringConverter<e> , &wxFromStringConverter<e> , &ToLong##e , &FromLong##e, typeid(e).name() ) ;
301 // ----------------------------------------------------------------------------
302 // Type Information
303 // ----------------------------------------------------------------------------
304 //
305 //
306 // All data exposed by the RTTI is characterized using the following classes.
307 // The first characterization is done by wxTypeKind. All enums up to and including
308 // wxT_CUSTOM represent so called simple types. These cannot be divided any further.
309 // They can be converted to and from wxStrings, that's all.
310
311
312 enum wxTypeKind
313 {
314 wxT_VOID = 0, // unknown type
315 wxT_BOOL,
316 wxT_CHAR,
317 wxT_UCHAR,
318 wxT_INT,
319 wxT_UINT,
320 wxT_LONG,
321 wxT_ULONG,
322 wxT_FLOAT,
323 wxT_DOUBLE,
324 wxT_STRING, // must be wxString
325 wxT_SET, // must be wxBitset<> template
326 wxT_ENUM,
327 wxT_CUSTOM, // user defined type (e.g. wxPoint)
328
329 wxT_LAST_SIMPLE_TYPE_KIND = wxT_CUSTOM ,
330
331 wxT_OBJECT_PTR, // object reference
332 wxT_OBJECT , // embedded object
333 wxT_COLLECTION , // collection
334
335 wxT_DELEGATE , // for connecting against an event source
336
337 wxT_LAST_TYPE_KIND = wxT_DELEGATE // sentinel for bad data, asserts, debugging
338 };
339
340 class WXDLLIMPEXP_BASE wxxVariant ;
341 class WXDLLIMPEXP_BASE wxTypeInfo ;
342
343 WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxTypeInfo* , wxTypeInfoMap , class WXDLLIMPEXP_BASE ) ;
344
345 class WXDLLIMPEXP_BASE wxTypeInfo
346 {
347 public :
348 typedef void (*converterToString_t)( const wxxVariant& data , wxString &result ) ;
349 typedef void (*converterFromString_t)( const wxString& data , wxxVariant &result ) ;
350
351 wxTypeInfo(wxTypeKind kind,
352 converterToString_t to = NULL, converterFromString_t from = NULL,
353 const wxString &name = wxEmptyString):
354 m_toString(to), m_fromString(from), m_kind(kind), m_name(name)
355 {
356 Register();
357 }
358 #if wxUSE_UNICODE
359 wxTypeInfo(wxTypeKind kind,
360 converterToString_t to = NULL, converterFromString_t from = NULL,
361 const char *name = ""):
362 m_toString(to), m_fromString(from), m_kind(kind), m_name(wxString::FromAscii(name))
363 {
364 Register();
365 }
366 #endif
367
368 virtual ~wxTypeInfo()
369 {
370 Unregister() ;
371 }
372
373 // return the kind of this type (wxT_... constants)
374 wxTypeKind GetKind() const { return m_kind ; }
375
376 // returns the unique name of this type
377 const wxString& GetTypeName() const { return m_name ; }
378
379 // is this type a delegate type
380 bool IsDelegateType() const { return m_kind == wxT_DELEGATE ; }
381
382 // is this type a custom type
383 bool IsCustomType() const { return m_kind == wxT_CUSTOM ; }
384
385 // is this type an object type
386 bool IsObjectType() const { return m_kind == wxT_OBJECT || m_kind == wxT_OBJECT_PTR ; }
387
388 // can the content of this type be converted to and from strings ?
389 bool HasStringConverters() const { return m_toString != NULL && m_fromString != NULL ; }
390
391 // convert a wxxVariant holding data of this type into a string
392 void ConvertToString( const wxxVariant& data , wxString &result ) const
393
394 { wxASSERT_MSG( m_toString , wxT("String conversions not supported") ) ; (*m_toString)( data , result ) ; }
395
396 // convert a string into a wxxVariant holding the corresponding data in this type
397 void ConvertFromString( const wxString& data , wxxVariant &result ) const
398 { wxASSERT_MSG( m_fromString , wxT("String conversions not supported") ) ; (*m_fromString)( data , result ) ; }
399
400 #if wxUSE_UNICODE
401 static wxTypeInfo *FindType(const char *typeName) { return FindType( wxString::FromAscii(typeName) ) ; }
402 #endif
403 static wxTypeInfo *FindType(const wxChar *typeName);
404
405 private :
406
407 void Register();
408 void Unregister();
409
410 converterToString_t m_toString ;
411 converterFromString_t m_fromString ;
412
413 static wxTypeInfoMap* sm_typeTable ;
414
415 wxTypeKind m_kind;
416 wxString m_name;
417 };
418
419 class WXDLLIMPEXP_BASE wxBuiltInTypeInfo : public wxTypeInfo
420 {
421 public :
422 wxBuiltInTypeInfo( wxTypeKind kind , converterToString_t to = NULL , converterFromString_t from = NULL , const wxString &name = wxEmptyString ) :
423 wxTypeInfo( kind , to , from , name )
424 { wxASSERT_MSG( GetKind() < wxT_SET , wxT("Illegal Kind for Base Type") ) ; }
425 #if wxUSE_UNICODE
426 wxBuiltInTypeInfo( wxTypeKind kind , converterToString_t to , converterFromString_t from , const char *name ) :
427 wxTypeInfo( kind , to , from , name )
428 { wxASSERT_MSG( GetKind() < wxT_SET , wxT("Illegal Kind for Base Type") ) ; }
429 #endif
430 } ;
431
432 class WXDLLIMPEXP_BASE wxCustomTypeInfo : public wxTypeInfo
433 {
434 public :
435 wxCustomTypeInfo( const wxString &name , converterToString_t to , converterFromString_t from ) :
436 wxTypeInfo( wxT_CUSTOM , to , from , name )
437 {}
438 #if wxUSE_UNICODE
439 wxCustomTypeInfo( const char *name , converterToString_t to , converterFromString_t from ) :
440 wxTypeInfo( wxT_CUSTOM , to , from , name )
441 {}
442 #endif
443 } ;
444
445 class WXDLLIMPEXP_BASE wxEnumTypeInfo : public wxTypeInfo
446 {
447 public :
448 typedef void (*converterToLong_t)( const wxxVariant& data , long &result ) ;
449 typedef void (*converterFromLong_t)( long data , wxxVariant &result ) ;
450
451 wxEnumTypeInfo( wxTypeKind kind , wxEnumData* enumInfo , converterToString_t to , converterFromString_t from ,
452 converterToLong_t toLong , converterFromLong_t fromLong , const wxString &name ) :
453 wxTypeInfo( kind , to , from , name ) , m_toLong( toLong ) , m_fromLong( fromLong )
454 { wxASSERT_MSG( kind == wxT_ENUM || kind == wxT_SET , wxT("Illegal Kind for Enum Type")) ; m_enumInfo = enumInfo ;}
455
456 #if wxUSE_UNICODE
457 wxEnumTypeInfo( wxTypeKind kind , wxEnumData* enumInfo , converterToString_t to , converterFromString_t from ,
458 converterToLong_t toLong , converterFromLong_t fromLong , const char * name ) :
459 wxTypeInfo( kind , to , from , name ) , m_toLong( toLong ) , m_fromLong( fromLong )
460 { wxASSERT_MSG( kind == wxT_ENUM || kind == wxT_SET , wxT("Illegal Kind for Enum Type")) ; m_enumInfo = enumInfo ;}
461 #endif
462 const wxEnumData* GetEnumData() const { return m_enumInfo ; }
463
464 // convert a wxxVariant holding data of this type into a long
465 void ConvertToLong( const wxxVariant& data , long &result ) const
466
467 { wxASSERT_MSG( m_toLong , wxT("Long conversions not supported") ) ; (*m_toLong)( data , result ) ; }
468
469 // convert a long into a wxxVariant holding the corresponding data in this type
470 void ConvertFromLong( long data , wxxVariant &result ) const
471 { wxASSERT_MSG( m_fromLong , wxT("Long conversions not supported") ) ; (*m_fromLong)( data , result ) ; }
472
473 private :
474 converterToLong_t m_toLong ;
475 converterFromLong_t m_fromLong ;
476
477 wxEnumData *m_enumInfo; // Kind == wxT_ENUM or Kind == wxT_SET
478 } ;
479
480 class WXDLLIMPEXP_BASE wxClassTypeInfo : public wxTypeInfo
481 {
482 public :
483 wxClassTypeInfo( wxTypeKind kind , wxClassInfo* classInfo , converterToString_t to = NULL , converterFromString_t from = NULL , const wxString &name = wxEmptyString) ;
484 #if wxUSE_UNICODE
485 wxClassTypeInfo( wxTypeKind kind , wxClassInfo* classInfo , converterToString_t to , converterFromString_t from , const char *name ) ;
486 #endif
487 const wxClassInfo *GetClassInfo() const { return m_classInfo ; }
488 private :
489 wxClassInfo *m_classInfo; // Kind == wxT_OBJECT - could be NULL
490 } ;
491
492 class WXDLLIMPEXP_BASE wxCollectionTypeInfo : public wxTypeInfo
493 {
494 public :
495 wxCollectionTypeInfo( const wxString &elementName , converterToString_t to , converterFromString_t from , const wxString &name) :
496 wxTypeInfo( wxT_COLLECTION , to , from , name )
497 { m_elementTypeName = elementName ; m_elementType = NULL ;}
498 #if wxUSE_UNICODE
499 wxCollectionTypeInfo( const char *elementName , converterToString_t to , converterFromString_t from , const char *name ) :
500 wxTypeInfo( wxT_COLLECTION , to , from , name )
501 { m_elementTypeName = wxString::FromAscii( elementName ) ; m_elementType = NULL ;}
502 #endif
503 const wxTypeInfo* GetElementType() const
504 {
505 if ( m_elementType == NULL )
506 m_elementType = wxTypeInfo::FindType( m_elementTypeName ) ;
507 return m_elementType ; }
508 private :
509 mutable wxTypeInfo * m_elementType ;
510 wxString m_elementTypeName ;
511 } ;
512
513 // a delegate is an exposed event source
514
515 class WXDLLIMPEXP_BASE wxDelegateTypeInfo : public wxTypeInfo
516 {
517 public :
518 wxDelegateTypeInfo( int eventType , wxClassInfo* eventClass , converterToString_t to = NULL , converterFromString_t from = NULL ) ;
519 wxDelegateTypeInfo( int eventType , int lastEventType, wxClassInfo* eventClass , converterToString_t to = NULL , converterFromString_t from = NULL ) ;
520 int GetEventType() const { return m_eventType ; }
521 int GetLastEventType() const { return m_lastEventType ; }
522 const wxClassInfo* GetEventClass() const { return m_eventClass ; }
523 private :
524 const wxClassInfo *m_eventClass; // (extended will merge into classinfo)
525 int m_eventType ;
526 int m_lastEventType ;
527 } ;
528
529 template<typename T> const wxTypeInfo* wxGetTypeInfo( T * ) { return wxTypeInfo::FindType(typeid(T).name()) ; }
530
531 // this macro is for usage with custom, non-object derived classes and structs, wxPoint is such a custom type
532
533 #define WX_CUSTOM_TYPE_INFO( e , toString , fromString ) \
534 wxCustomTypeInfo s_typeInfo##e(typeid(e).name() , &toString , &fromString) ;
535
536 #define WX_COLLECTION_TYPE_INFO( element , collection ) \
537 wxCollectionTypeInfo s_typeInfo##collection( typeid(element).name() , NULL , NULL , typeid(collection).name() ) ;
538
539 // sometimes a compiler invents specializations that are nowhere called, use this macro to satisfy the refs
540
541 #define WX_ILLEGAL_TYPE_SPECIALIZATION( a )
542 /*
543 template<> const wxTypeInfo* wxGetTypeInfo( a * ) { assert(0) ; \
544 static wxBuiltInTypeInfo s_typeInfo( wxT_VOID ) ; return &s_typeInfo ; } \
545 template<> void wxStringReadValue(const wxString & , a & ) { assert(0) ; }\
546 template<> void wxStringWriteValue(wxString & , a const & ) { assert(0) ; }
547 */
548
549 // ----------------------------------------------------------------------------
550 // wxxVariant as typesafe data holder
551 // ----------------------------------------------------------------------------
552
553 class WXDLLIMPEXP_BASE wxxVariantData
554 {
555 public:
556 virtual ~wxxVariantData() {}
557
558 // return a heap allocated duplicate
559 virtual wxxVariantData* Clone() const = 0 ;
560
561 // returns the type info of the contentc
562 virtual const wxTypeInfo* GetTypeInfo() const = 0 ;
563 } ;
564
565 template<typename T> class wxxVariantDataT : public wxxVariantData
566 {
567 public:
568 wxxVariantDataT(const T& d) : m_data(d) {}
569 virtual ~wxxVariantDataT() {}
570
571 // get a ref to the stored data
572 T & Get() { return m_data; }
573
574 // get a const ref to the stored data
575 const T & Get() const { return m_data; }
576
577 // set the data
578 void Set(const T& d) { m_data = d; }
579
580 // return a heap allocated duplicate
581 virtual wxxVariantData* Clone() const { return new wxxVariantDataT<T>( Get() ) ; }
582
583 // returns the type info of the contentc
584 virtual const wxTypeInfo* GetTypeInfo() const { return wxGetTypeInfo( (T*) NULL ) ; }
585
586 private:
587 T m_data;
588 };
589
590 class WXDLLIMPEXP_BASE wxxVariant
591 {
592 public :
593 wxxVariant() { m_data = NULL ; }
594 wxxVariant( wxxVariantData* data , const wxString& name = wxT("") ) : m_data(data) , m_name(name) {}
595 wxxVariant( const wxxVariant &d ) { if ( d.m_data ) m_data = d.m_data->Clone() ; else m_data = NULL ; m_name = d.m_name ; }
596
597 template<typename T> wxxVariant( const T& data , const wxString& name = wxT("") ) :
598 m_data(new wxxVariantDataT<T>(data) ), m_name(name) {}
599
600 ~wxxVariant() { delete m_data ; }
601
602 // get a ref to the stored data
603 template<typename T> T& Get(WX_TEMPLATED_MEMBER_FIX(T))
604 {
605 wxxVariantDataT<T> *dataptr = dynamic_cast<wxxVariantDataT<T>*> (m_data) ;
606 wxASSERT_MSG( dataptr , wxT("Cast not possible") ) ;
607 return dataptr->Get() ;
608 }
609
610 // get a ref to the stored data
611 template<typename T> const T& Get(WX_TEMPLATED_MEMBER_FIX(T)) const
612 {
613 const wxxVariantDataT<T> *dataptr = dynamic_cast<const wxxVariantDataT<T>*> (m_data) ;
614 wxASSERT_MSG( dataptr , wxT("Cast not possible") ) ;
615 return dataptr->Get() ;
616 }
617
618 bool IsEmpty() const { return m_data == NULL ; }
619
620 template<typename T> bool HasData() const
621 {
622 const wxxVariantDataT<T> *dataptr = dynamic_cast<const wxxVariantDataT<T>*> (m_data) ;
623 return dataptr != NULL ;
624 }
625
626 // stores the data
627 template<typename T> void Set(const T& data) const
628 {
629 delete m_data ;
630 m_data = new wxxVariantDataT<T>(data) ;
631 }
632
633 wxxVariant& operator=(const wxxVariant &d)
634 {
635 m_data = d.m_data->Clone() ;
636 m_name = d.m_name ;
637 return *this ;
638 }
639
640 // gets the stored data casted to a wxObject* , returning NULL if cast is not possible
641 wxObject* GetAsObject() ;
642
643 // get the typeinfo of the stored object
644 const wxTypeInfo* GetTypeInfo() const { return m_data->GetTypeInfo() ; }
645
646 // returns this value as string
647 wxString GetAsString() const
648 {
649 wxString s ;
650 GetTypeInfo()->ConvertToString( *this , s ) ;
651 return s ;
652 }
653 const wxString& GetName() const { return m_name ; }
654 private :
655 wxxVariantData* m_data ;
656 wxString m_name ;
657 } ;
658
659 #include <wx/dynarray.h>
660
661 WX_DECLARE_OBJARRAY_WITH_DECL(wxxVariant, wxxVariantArray, class WXDLLIMPEXP_BASE);
662
663 // templated streaming, every type must have their specialization for these methods
664
665 template<typename T>
666 void wxStringReadValue( const wxString &s , T &data );
667
668 template<typename T>
669 void wxStringWriteValue( wxString &s , const T &data);
670
671 template<typename T>
672 void wxToStringConverter( const wxxVariant &v, wxString &s) { wxStringWriteValue( s , v.WX_TEMPLATED_MEMBER_CALL(Get , T) ) ; }
673
674 template<typename T>
675 void wxFromStringConverter( const wxString &s, wxxVariant &v) { T d ; wxStringReadValue( s , d ) ; v = wxxVariant(d) ; } \
676
677 // ----------------------------------------------------------------------------
678 // Property Support
679 //
680 // wxPropertyInfo is used to inquire of the property by name. It doesn't
681 // provide access to the property, only information about it. If you
682 // want access, look at wxPropertyAccessor.
683 // ----------------------------------------------------------------------------
684
685 class WXDLLIMPEXP_BASE wxSetter
686 {
687 public:
688 wxSetter( const wxString name ) { m_name = name ; }
689 virtual ~wxSetter() {}
690 virtual void Set( wxObject *object, const wxxVariant &variantValue ) const = 0;
691 const wxString& GetName() const { return m_name ; }
692 private:
693 wxString m_name;
694 };
695
696 class WXDLLIMPEXP_BASE wxGetter
697 {
698 public:
699 wxGetter( const wxString name ) { m_name = name ; }
700 virtual ~wxGetter() {}
701 virtual void Get( const wxObject *object , wxxVariant& result) const = 0;
702 const wxString& GetName() const { return m_name ; }
703 private:
704 wxString m_name;
705 };
706
707 class WXDLLIMPEXP_BASE wxCollectionGetter
708 {
709 public :
710 wxCollectionGetter( const wxString name ) { m_name = name ; }
711 virtual ~wxCollectionGetter() {}
712 virtual void Get( const wxObject *object , wxxVariantArray& result) const = 0;
713 const wxString& GetName() const { return m_name ; }
714 private :
715 wxString m_name ;
716 } ;
717
718 template<typename coll_t> void wxCollectionToVariantArray( const coll_t& coll , wxxVariantArray& result ) ;
719
720 class WXDLLIMPEXP_BASE wxAdder
721 {
722 public :
723 wxAdder( const wxString name ) { m_name = name ; }
724 virtual ~wxAdder() {}
725 virtual void Add( wxObject *object, const wxxVariant &variantValue ) const= 0;
726 const wxString& GetName() const { return m_name ; }
727 private :
728 wxString m_name ;
729 } ;
730
731
732
733 #define WX_SETTER( property, Klass, valueType, setterMethod ) \
734 class wxSetter##property : public wxSetter \
735 { \
736 public: \
737 wxSetter##property() : wxSetter( wxT(#setterMethod) ) {} \
738 ~wxSetter##property() {} \
739 void Set( wxObject *object, const wxxVariant &variantValue ) const \
740 { \
741 Klass *obj = dynamic_cast<Klass*>(object) ; \
742 if ( variantValue.HasData<valueType>() ) \
743 obj->setterMethod(variantValue.Get<valueType>()) ; \
744 else \
745 obj->setterMethod(*variantValue.Get<valueType*>()) ; \
746 } \
747 } ;
748
749 #define WX_GETTER( property, Klass, valueType , gettermethod ) \
750 class wxGetter##property : public wxGetter \
751 { \
752 public : \
753 wxGetter##property() : wxGetter( wxT(#gettermethod) ) {} \
754 ~wxGetter##property() {} \
755 void Get( const wxObject *object , wxxVariant &result) const \
756 { \
757 const Klass *obj = dynamic_cast<const Klass*>(object) ; \
758 result = wxxVariant( obj->gettermethod() ) ; \
759 } \
760 } ;
761
762 #define WX_ADDER( property, Klass, valueType , addermethod ) \
763 class wxAdder##property : public wxAdder \
764 { \
765 public: \
766 wxAdder##property() : wxAdder( wxT(#addermethod) ) {} \
767 ~wxAdder##property() {} \
768 void Add( wxObject *object, const wxxVariant &variantValue ) const \
769 { \
770 Klass *obj = dynamic_cast<Klass*>(object) ; \
771 if ( variantValue.HasData<valueType>() ) \
772 obj->addermethod(variantValue.Get<valueType>()) ; \
773 else \
774 obj->addermethod(*variantValue.Get<valueType*>()) ; \
775 } \
776 } ;
777
778 #define WX_COLLECTION_GETTER( property, Klass, valueType , gettermethod ) \
779 class wxCollectionGetter##property : public wxCollectionGetter \
780 { \
781 public : \
782 wxCollectionGetter##property() : wxCollectionGetter( wxT(#gettermethod) ) {} \
783 ~wxCollectionGetter##property() {} \
784 void Get( const wxObject *object , wxxVariantArray &result) const \
785 { \
786 const Klass *obj = dynamic_cast<const Klass*>(object) ; \
787 wxCollectionToVariantArray( obj->gettermethod() , result ) ; \
788 } \
789 } ;
790
791 class WXDLLIMPEXP_BASE wxPropertyAccessor
792 {
793 public :
794 wxPropertyAccessor( wxSetter *setter , wxGetter *getter , wxAdder *adder , wxCollectionGetter *collectionGetter )
795 { m_setter = setter ; m_getter = getter ; m_adder = adder ; m_collectionGetter = collectionGetter ;}
796
797 virtual ~wxPropertyAccessor() {}
798
799 // Setting a simple property (non-collection)
800 virtual void SetProperty(wxObject *object, const wxxVariant &value) const
801 { wxASSERT_MSG(m_setter,wxT("SetProperty called w/o valid setter") ) ; m_setter->Set( object , value ) ;}
802
803 // Getting a simple property (non-collection)
804 virtual void GetProperty(const wxObject *object, wxxVariant &result) const
805 { wxASSERT_MSG(m_getter,wxT("GetProperty called w/o valid getter") ) ; m_getter->Get( object , result ) ;}
806
807 // Adding an element to a collection property
808 virtual void AddToPropertyCollection(wxObject *object, const wxxVariant &value) const
809 { wxASSERT_MSG(m_adder,wxT("AddToPropertyCollection called w/o valid adder") ) ; m_adder->Add( object , value ) ;}
810
811 // Getting a collection property
812 virtual void GetPropertyCollection( const wxObject *obj, wxxVariantArray &result) const
813 { wxASSERT_MSG(m_collectionGetter,wxT("GetPropertyCollection called w/o valid collection getter") ) ; m_collectionGetter->Get( obj , result) ;}
814
815 virtual bool HasSetter() const { return m_setter != NULL ; }
816 virtual bool HasCollectionGetter() const { return m_collectionGetter != NULL ; }
817 virtual bool HasGetter() const { return m_getter != NULL ; }
818 virtual bool HasAdder() const { return m_adder != NULL ; }
819
820 virtual const wxString& GetCollectionGetterName() const
821 { return m_collectionGetter->GetName() ; }
822 virtual const wxString& GetGetterName() const
823 { return m_getter->GetName() ; }
824 virtual const wxString& GetSetterName() const
825 { return m_setter->GetName() ; }
826 virtual const wxString& GetAdderName() const
827 { return m_adder->GetName() ; }
828
829 protected :
830 wxSetter *m_setter ;
831 wxAdder *m_adder ;
832 wxGetter *m_getter ;
833 wxCollectionGetter* m_collectionGetter ;
834 };
835
836 class WXDLLIMPEXP_BASE wxGenericPropertyAccessor : public wxPropertyAccessor
837 {
838 public :
839 wxGenericPropertyAccessor( const wxString &propName ) ;
840 ~wxGenericPropertyAccessor() ;
841
842 void RenameProperty( const wxString &oldName , const wxString &newName )
843 {
844 wxASSERT( oldName == m_propertyName ) ; m_propertyName = newName ;
845 }
846 virtual bool HasSetter() const { return true ; }
847 virtual bool HasGetter() const { return true ; }
848 virtual bool HasAdder() const { return false ; }
849 virtual bool HasCollectionGetter() const { return false ; }
850
851 virtual const wxString& GetGetterName() const
852 { return m_getterName ; }
853 virtual const wxString& GetSetterName() const
854 { return m_setterName ; }
855
856 virtual void SetProperty(wxObject *object, const wxxVariant &value) const ;
857 virtual void GetProperty(const wxObject *object, wxxVariant &value) const ;
858
859 // Adding an element to a collection property
860 virtual void AddToPropertyCollection(wxObject *WXUNUSED(object), const wxxVariant &WXUNUSED(value)) const
861 { wxASSERT_MSG(0,wxT("AddToPropertyCollection called on a generic accessor") ) ;}
862
863 // Getting a collection property
864 virtual void GetPropertyCollection( const wxObject *WXUNUSED(obj), wxxVariantArray &WXUNUSED(result)) const
865 { wxASSERT_MSG(0,wxT("GetPropertyCollection called on a generic accessor") ) ;}
866 private :
867 struct wxGenericPropertyAccessorInternal ;
868 wxGenericPropertyAccessorInternal* m_data ;
869 wxString m_propertyName ;
870 wxString m_setterName ;
871 wxString m_getterName ;
872 } ;
873
874 typedef long wxPropertyInfoFlags ;
875 enum {
876 // will be removed in future releases
877 wxPROP_DEPRECATED = 0x00000001 ,
878 // object graph property, will be streamed with priority (after constructor properties)
879 wxPROP_OBJECT_GRAPH = 0x00000002 ,
880 // this will only be streamed out and in as enum/set, the internal representation is still a long
881 wxPROP_ENUM_STORE_LONG = 0x00000004 ,
882 // don't stream out this property, needed eg to avoid streaming out children that are always created by their parents
883 wxPROP_DONT_STREAM = 0x00000008 ,
884 } ;
885
886 class WXDLLIMPEXP_BASE wxPropertyInfo
887 {
888 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
889 public :
890 wxPropertyInfo(wxPropertyInfo* &iter,
891 wxClassInfo* itsClass,
892 const wxString& name,
893 const wxString& typeName,
894 wxPropertyAccessor *accessor,
895 wxxVariant dv,
896 wxPropertyInfoFlags flags = 0,
897 const wxString& helpString = wxEmptyString,
898 const wxString& groupString = wxEmptyString) :
899 m_itsClass(itsClass),
900 m_name(name),
901 m_typeInfo(NULL),
902 m_typeName(typeName) ,
903 m_collectionElementTypeInfo(NULL),
904 m_accessor(accessor),
905 m_defaultValue(dv),
906 m_flags(flags),
907 m_helpString(helpString),
908 m_groupString(groupString)
909 {
910 Insert(iter);
911 }
912
913 #if wxUSE_UNICODE
914 wxPropertyInfo(wxPropertyInfo* &iter,
915 wxClassInfo* itsClass,
916 const wxString& name,
917 const char* typeName,
918 wxPropertyAccessor *accessor,
919 wxxVariant dv,
920 wxPropertyInfoFlags flags = 0,
921 const wxString& helpString = wxEmptyString,
922 const wxString& groupString = wxEmptyString) :
923 m_itsClass(itsClass),
924 m_name(name),
925 m_typeInfo(NULL),
926 m_typeName(wxString::FromAscii(typeName)) ,
927 m_collectionElementTypeInfo(NULL),
928 m_accessor(accessor),
929 m_defaultValue(dv),
930 m_flags(flags),
931 m_helpString(helpString),
932 m_groupString(groupString)
933 {
934 Insert(iter);
935 }
936 #endif
937 wxPropertyInfo(wxPropertyInfo* &iter,
938 wxClassInfo* itsClass,
939 const wxString& name,
940 wxDelegateTypeInfo* type,
941 wxPropertyAccessor *accessor,
942 wxxVariant dv,
943 wxPropertyInfoFlags flags = 0,
944 const wxString& helpString = wxEmptyString,
945 const wxString& groupString = wxEmptyString) :
946 m_itsClass(itsClass),
947 m_name(name),
948 m_typeInfo(type),
949 m_collectionElementTypeInfo(NULL),
950 m_accessor(accessor),
951 m_defaultValue(dv),
952 m_flags(flags),
953 m_helpString(helpString),
954 m_groupString(groupString)
955 {
956 Insert(iter);
957 }
958
959 wxPropertyInfo(wxPropertyInfo* &iter,
960 wxClassInfo* itsClass, const wxString& name,
961 const wxString& collectionTypeName,
962 const wxString& elementTypeName,
963 wxPropertyAccessor *accessor,
964 wxPropertyInfoFlags flags = 0,
965 const wxString& helpString = wxEmptyString,
966 const wxString& groupString = wxEmptyString) :
967 m_itsClass(itsClass),
968 m_name(name),
969 m_typeInfo(NULL),
970 m_typeName(collectionTypeName) ,
971 m_collectionElementTypeInfo(NULL),
972 m_collectionElementTypeName(elementTypeName),
973 m_accessor(accessor) ,
974 m_flags(flags),
975 m_helpString(helpString),
976 m_groupString(groupString)
977 {
978 Insert(iter);
979 }
980
981 #if wxUSE_UNICODE
982 wxPropertyInfo(wxPropertyInfo* &iter,
983 wxClassInfo* itsClass, const wxString& name,
984 const char* collectionTypeName,
985 const char* elementTypeName,
986 wxPropertyAccessor *accessor,
987 wxPropertyInfoFlags flags = 0,
988 const wxString& helpString = wxEmptyString,
989 const wxString& groupString = wxEmptyString) :
990 m_itsClass(itsClass),
991 m_name(name),
992 m_typeInfo(NULL),
993 m_typeName(wxString::FromAscii(collectionTypeName)) ,
994 m_collectionElementTypeInfo(NULL),
995 m_collectionElementTypeName(wxString::FromAscii(elementTypeName)),
996 m_accessor(accessor) ,
997 m_flags(flags),
998 m_helpString(helpString),
999 m_groupString(groupString)
1000 {
1001 Insert(iter);
1002 }
1003 #endif
1004 ~wxPropertyInfo() ;
1005
1006 // return the class this property is declared in
1007 const wxClassInfo* GetDeclaringClass() const { return m_itsClass ; }
1008
1009 // return the name of this property
1010 const wxString& GetName() const { return m_name ; }
1011
1012 // returns the flags of this property
1013 wxPropertyInfoFlags GetFlags() const { return m_flags ;}
1014
1015 // returns the short help string of this property
1016 const wxString& GetHelpString() const { return m_helpString ; }
1017
1018 // returns the group string of this property
1019 const wxString& GetGroupString() const { return m_groupString ; }
1020
1021 // return the element type info of this property (for collections, otherwise NULL)
1022 const wxTypeInfo * GetCollectionElementTypeInfo() const
1023 {
1024 if ( m_collectionElementTypeInfo == NULL )
1025 m_collectionElementTypeInfo = wxTypeInfo::FindType(m_collectionElementTypeName) ;
1026 return m_collectionElementTypeInfo ;
1027 }
1028
1029 // return the type info of this property
1030 const wxTypeInfo * GetTypeInfo() const
1031 {
1032 if ( m_typeInfo == NULL )
1033 m_typeInfo = wxTypeInfo::FindType(m_typeName) ;
1034 return m_typeInfo ;
1035 }
1036
1037 // return the accessor for this property
1038 wxPropertyAccessor* GetAccessor() const { return m_accessor ; }
1039
1040 // returns NULL if this is the last property of this class
1041 wxPropertyInfo* GetNext() const { return m_next ; }
1042
1043 // returns the default value of this property, its kind may be wxT_VOID if it is not valid
1044 wxxVariant GetDefaultValue() const { return m_defaultValue ; }
1045 private :
1046 void Insert(wxPropertyInfo* &iter)
1047 {
1048 m_next = NULL ;
1049 if ( iter == NULL )
1050 iter = this ;
1051 else
1052 {
1053 wxPropertyInfo* i = iter ;
1054 while( i->m_next )
1055 i = i->m_next ;
1056
1057 i->m_next = this ;
1058 }
1059 }
1060
1061 wxClassInfo* m_itsClass ;
1062 wxString m_name ;
1063 mutable wxTypeInfo* m_typeInfo ;
1064 wxString m_typeName ;
1065 mutable wxTypeInfo* m_collectionElementTypeInfo ;
1066 wxString m_collectionElementTypeName ;
1067 wxPropertyAccessor* m_accessor ;
1068 wxxVariant m_defaultValue;
1069 wxPropertyInfoFlags m_flags ;
1070 wxString m_helpString ;
1071 wxString m_groupString ;
1072 // string representation of the default value
1073 // to be assigned by the designer to the property
1074 // when the component is dropped on the container.
1075 wxPropertyInfo* m_next ;
1076 };
1077
1078 WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxPropertyInfo* , wxPropertyInfoMap , class WXDLLIMPEXP_BASE ) ;
1079
1080 #define WX_BEGIN_PROPERTIES_TABLE(theClass) \
1081 wxPropertyInfo *theClass::GetPropertiesStatic() \
1082 { \
1083 typedef theClass class_t; \
1084 static wxPropertyInfo* first = NULL ;
1085
1086 #define WX_END_PROPERTIES_TABLE() \
1087 return first ; }
1088
1089 #define WX_HIDE_PROPERTY( pname ) \
1090 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(void).name() ,NULL , wxxVariant() , wxPROP_DONT_STREAM , wxEmptyString , wxEmptyString ) ;
1091
1092 #define WX_PROPERTY( pname , type , setter , getter ,defaultValue , flags , help , group) \
1093 WX_SETTER( pname , class_t , type , setter ) \
1094 static wxSetter##pname _setter##pname ; \
1095 WX_GETTER( pname , class_t , type , getter ) \
1096 static wxGetter##pname _getter##pname ; \
1097 static wxPropertyAccessor _accessor##pname( &_setter##pname , &_getter##pname , NULL , NULL ) ; \
1098 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(type).name() ,&_accessor##pname , wxxVariant(defaultValue) , flags , group , help ) ;
1099
1100 #define WX_PROPERTY_FLAGS( pname , flags , type , setter , getter ,defaultValue , pflags , help , group) \
1101 WX_SETTER( pname , class_t , type , setter ) \
1102 static wxSetter##pname _setter##pname ; \
1103 WX_GETTER( pname , class_t , type , getter ) \
1104 static wxGetter##pname _getter##pname ; \
1105 static wxPropertyAccessor _accessor##pname( &_setter##pname , &_getter##pname , NULL , NULL ) ; \
1106 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(flags).name() ,&_accessor##pname , wxxVariant(defaultValue), wxPROP_ENUM_STORE_LONG | pflags , help , group ) ;
1107
1108 #define WX_READONLY_PROPERTY( pname , type , getter ,defaultValue , flags , help , group) \
1109 WX_GETTER( pname , class_t , type , getter ) \
1110 static wxGetter##pname _getter##pname ; \
1111 static wxPropertyAccessor _accessor##pname( NULL , &_getter##pname , NULL , NULL ) ; \
1112 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(type).name() ,&_accessor##pname , wxxVariant(defaultValue), flags , help , group ) ;
1113
1114 #define WX_READONLY_PROPERTY_FLAGS( pname , flags , type , getter ,defaultValue , pflags , help , group) \
1115 WX_GETTER( pname , class_t , type , getter ) \
1116 static wxGetter##pname _getter##pname ; \
1117 static wxPropertyAccessor _accessor##pname( NULL , &_getter##pname , NULL , NULL ) ; \
1118 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(flags).name() ,&_accessor##pname , wxxVariant(defaultValue), wxPROP_ENUM_STORE_LONG | pflags , help , group ) ;
1119
1120 #define WX_PROPERTY_COLLECTION( pname , colltype , addelemtype , adder , getter , flags , help , group ) \
1121 WX_ADDER( pname , class_t , addelemtype , adder ) \
1122 static wxAdder##pname _adder##pname ; \
1123 WX_COLLECTION_GETTER( pname , class_t , colltype , getter ) \
1124 static wxCollectionGetter##pname _collectionGetter##pname ; \
1125 static wxPropertyAccessor _accessor##pname( NULL , NULL ,&_adder##pname , &_collectionGetter##pname ) ; \
1126 static wxPropertyInfo _propertyInfo##pname( first , class_t::GetClassInfoStatic() , wxT(#pname) , typeid(colltype).name() ,typeid(addelemtype).name() ,&_accessor##pname , flags , help , group ) ;
1127
1128 #define WX_READONLY_PROPERTY_COLLECTION( pname , colltype , addelemtype , getter , flags , help , group) \
1129 WX_COLLECTION_GETTER( pname , class_t , colltype , getter ) \
1130 static wxCollectionGetter##pname _collectionGetter##pname ; \
1131 static wxPropertyAccessor _accessor##pname( NULL , NULL , NULL , &_collectionGetter##pname ) ; \
1132 static wxPropertyInfo _propertyInfo##pname( first ,class_t::GetClassInfoStatic() , wxT(#pname) , typeid(colltype).name() ,typeid(addelemtype).name() ,&_accessor##pname , flags , help , group ) ;
1133
1134
1135 #define WX_EVENT_PROPERTY( name , eventType , eventClass ) \
1136 static wxDelegateTypeInfo _typeInfo##name( eventType , CLASSINFO( eventClass ) ) ; \
1137 static wxPropertyInfo _propertyInfo##name( first ,class_t::GetClassInfoStatic() , wxT(#name) , &_typeInfo##name , NULL , wxxVariant() ) ; \
1138
1139 #define WX_EVENT_RANGE_PROPERTY( name , eventType , lastEventType , eventClass ) \
1140 static wxDelegateTypeInfo _typeInfo##name( eventType , lastEventType , CLASSINFO( eventClass ) ) ; \
1141 static wxPropertyInfo _propertyInfo##name( first , class_t::GetClassInfoStatic() , wxT(#name) , &_typeInfo##name , NULL , wxxVariant() ) ; \
1142
1143 // ----------------------------------------------------------------------------
1144 // Implementation Helper for Simple Properties
1145 // ----------------------------------------------------------------------------
1146
1147 #define WX_IMPLEMENT_PROPERTY(name, type) \
1148 private:\
1149 type m_##name; \
1150 public: \
1151 void Set##name( type const & p) { m_##name = p; } \
1152 type const & Get##name() const { return m_##name; }
1153
1154 // ----------------------------------------------------------------------------
1155 // Handler Info
1156 //
1157 // this is describing an event sink
1158 // ----------------------------------------------------------------------------
1159
1160 class WXDLLIMPEXP_BASE wxHandlerInfo
1161 {
1162 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
1163 public :
1164 wxHandlerInfo(wxHandlerInfo* &iter,
1165 wxClassInfo* itsClass,
1166 const wxString& name,
1167 wxObjectEventFunction address,
1168 const wxClassInfo* eventClassInfo) :
1169 m_eventFunction(address),
1170 m_name(name),
1171 m_eventClassInfo(eventClassInfo) ,
1172 m_itsClass(itsClass)
1173 {
1174 m_next = NULL ;
1175 if ( iter == NULL )
1176 iter = this ;
1177 else
1178 {
1179 wxHandlerInfo* i = iter ;
1180 while( i->m_next )
1181 i = i->m_next ;
1182
1183 i->m_next = this ;
1184 }
1185 }
1186
1187 ~wxHandlerInfo() ;
1188
1189 // return the name of this handler
1190 const wxString& GetName() const { return m_name ; }
1191
1192 // return the class info of the event
1193 const wxClassInfo * GetEventClassInfo() const { return m_eventClassInfo ; }
1194
1195 // get the handler function pointer
1196 wxObjectEventFunction GetEventFunction() const { return m_eventFunction ; }
1197
1198 // returns NULL if this is the last handler of this class
1199 wxHandlerInfo* GetNext() const { return m_next ; }
1200
1201 // return the class this property is declared in
1202 const wxClassInfo* GetDeclaringClass() const { return m_itsClass ; }
1203
1204 private :
1205 wxObjectEventFunction m_eventFunction ;
1206 wxString m_name;
1207 const wxClassInfo* m_eventClassInfo ;
1208 wxHandlerInfo* m_next ;
1209 wxClassInfo* m_itsClass ;
1210 };
1211
1212 #define WX_HANDLER(name,eventClassType) \
1213 static wxHandlerInfo _handlerInfo##name( first , class_t::GetClassInfoStatic() , #name , (wxObjectEventFunction) (wxEventFunction) &name , CLASSINFO( eventClassType ) ) ;
1214
1215 #define WX_BEGIN_HANDLERS_TABLE(theClass) \
1216 wxHandlerInfo *theClass::GetHandlersStatic() \
1217 { \
1218 typedef theClass class_t; \
1219 static wxHandlerInfo* first = NULL ;
1220
1221 #define WX_END_HANDLERS_TABLE() \
1222 return first ; }
1223
1224 // ----------------------------------------------------------------------------
1225 // Constructor Bridges
1226 //
1227 // allow to set up constructors with params during runtime
1228 // ----------------------------------------------------------------------------
1229
1230 class WXDLLIMPEXP_BASE wxConstructorBridge
1231 {
1232 public :
1233 virtual void Create(wxObject * &o, wxxVariant *args) = 0;
1234 };
1235
1236 // a direct constructor bridge calls the operator new for this class and
1237 // passes all params to the constructor. needed for classes that cannot be
1238 // instantiated using alloc-create semantics
1239 class WXDLLIMPEXP_BASE wxDirectConstructorBrigde : public wxConstructorBridge
1240 {
1241 public :
1242 virtual void Create(wxObject * &o, wxxVariant *args) = 0;
1243 } ;
1244
1245 // Creator Bridges for all Numbers of Params
1246
1247 // no params
1248
1249 template<typename Class>
1250 struct wxConstructorBridge_0 : public wxConstructorBridge
1251 {
1252 void Create(wxObject * &o, wxxVariant *)
1253 {
1254 Class *obj = dynamic_cast<Class*>(o);
1255 obj->Create();
1256 }
1257 };
1258
1259 struct wxConstructorBridge_Dummy : public wxConstructorBridge
1260 {
1261 void Create(wxObject *&, wxxVariant *)
1262 {
1263 }
1264 } ;
1265
1266 #define WX_CONSTRUCTOR_0(klass) \
1267 wxConstructorBridge_0<klass> constructor##klass ; \
1268 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1269 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
1270 const int klass::sm_constructorPropertiesCount##klass = 0 ;
1271
1272 #define WX_CONSTRUCTOR_DUMMY(klass) \
1273 wxConstructorBridge_Dummy constructor##klass ; \
1274 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1275 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
1276 const int klass::sm_constructorPropertiesCount##klass = 0 ;
1277
1278 // 1 param
1279
1280 template<typename Class, typename T0>
1281 struct wxConstructorBridge_1 : public wxConstructorBridge
1282 {
1283 void Create(wxObject * &o, wxxVariant *args)
1284 {
1285 Class *obj = dynamic_cast<Class*>(o);
1286 obj->Create(
1287 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0)
1288 );
1289 }
1290 };
1291
1292 #define WX_CONSTRUCTOR_1(klass,t0,v0) \
1293 wxConstructorBridge_1<klass,t0> constructor##klass ; \
1294 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1295 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) } ; \
1296 const int klass::sm_constructorPropertiesCount##klass = 1 ;
1297
1298 // 2 params
1299
1300 template<typename Class,
1301 typename T0, typename T1>
1302 struct wxConstructorBridge_2 : public wxConstructorBridge
1303 {
1304 void Create(wxObject * &o, wxxVariant *args)
1305 {
1306 Class *obj = dynamic_cast<Class*>(o);
1307 obj->Create(
1308 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1309 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1)
1310 );
1311 }
1312 };
1313
1314 #define WX_CONSTRUCTOR_2(klass,t0,v0,t1,v1) \
1315 wxConstructorBridge_2<klass,t0,t1> constructor##klass ; \
1316 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1317 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) } ; \
1318 const int klass::sm_constructorPropertiesCount##klass = 2;
1319
1320 // direct constructor version
1321
1322 template<typename Class,
1323 typename T0, typename T1>
1324 struct wxDirectConstructorBridge_2 : public wxDirectConstructorBrigde
1325 {
1326 void Create(wxObject * &o, wxxVariant *args)
1327 {
1328 o = new Class(
1329 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1330 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1)
1331 );
1332 }
1333 };
1334
1335 #define WX_DIRECT_CONSTRUCTOR_2(klass,t0,v0,t1,v1) \
1336 wxDirectConstructorBridge_2<klass,t0,t1> constructor##klass ; \
1337 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1338 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) } ; \
1339 const int klass::sm_constructorPropertiesCount##klass = 2;
1340
1341
1342 // 3 params
1343
1344 template<typename Class,
1345 typename T0, typename T1, typename T2>
1346 struct wxConstructorBridge_3 : public wxConstructorBridge
1347 {
1348 void Create(wxObject * &o, wxxVariant *args)
1349 {
1350 Class *obj = dynamic_cast<Class*>(o);
1351 obj->Create(
1352 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1353 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1354 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2)
1355 );
1356 }
1357 };
1358
1359 #define WX_CONSTRUCTOR_3(klass,t0,v0,t1,v1,t2,v2) \
1360 wxConstructorBridge_3<klass,t0,t1,t2> constructor##klass ; \
1361 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1362 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) } ; \
1363 const int klass::sm_constructorPropertiesCount##klass = 3 ;
1364
1365 // 4 params
1366
1367 template<typename Class,
1368 typename T0, typename T1, typename T2, typename T3>
1369 struct wxConstructorBridge_4 : public wxConstructorBridge
1370 {
1371 void Create(wxObject * &o, wxxVariant *args)
1372 {
1373 Class *obj = dynamic_cast<Class*>(o);
1374 obj->Create(
1375 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1376 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1377 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1378 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3)
1379 );
1380 }
1381 };
1382
1383 #define WX_CONSTRUCTOR_4(klass,t0,v0,t1,v1,t2,v2,t3,v3) \
1384 wxConstructorBridge_4<klass,t0,t1,t2,t3> constructor##klass ; \
1385 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1386 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) } ; \
1387 const int klass::sm_constructorPropertiesCount##klass = 4 ;
1388
1389 // 5 params
1390
1391 template<typename Class,
1392 typename T0, typename T1, typename T2, typename T3, typename T4>
1393 struct wxConstructorBridge_5 : public wxConstructorBridge
1394 {
1395 void Create(wxObject * &o, wxxVariant *args)
1396 {
1397 Class *obj = dynamic_cast<Class*>(o);
1398 obj->Create(
1399 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1400 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1401 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1402 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1403 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4)
1404 );
1405 }
1406 };
1407
1408 #define WX_CONSTRUCTOR_5(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4) \
1409 wxConstructorBridge_5<klass,t0,t1,t2,t3,t4> constructor##klass ; \
1410 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1411 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) } ; \
1412 const int klass::sm_constructorPropertiesCount##klass = 5;
1413
1414 // 6 params
1415
1416 template<typename Class,
1417 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5>
1418 struct wxConstructorBridge_6 : public wxConstructorBridge
1419 {
1420 void Create(wxObject * &o, wxxVariant *args)
1421 {
1422 Class *obj = dynamic_cast<Class*>(o);
1423 obj->Create(
1424 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1425 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1426 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1427 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1428 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1429 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5)
1430 );
1431 }
1432 };
1433
1434 #define WX_CONSTRUCTOR_6(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5) \
1435 wxConstructorBridge_6<klass,t0,t1,t2,t3,t4,t5> constructor##klass ; \
1436 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1437 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) } ; \
1438 const int klass::sm_constructorPropertiesCount##klass = 6;
1439
1440 // direct constructor version
1441
1442 template<typename Class,
1443 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5>
1444 struct wxDirectConstructorBridge_6 : public wxDirectConstructorBrigde
1445 {
1446 void Create(wxObject * &o, wxxVariant *args)
1447 {
1448 o = new Class(
1449 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1450 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1451 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1452 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1453 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1454 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5)
1455 );
1456 }
1457 };
1458
1459 #define WX_DIRECT_CONSTRUCTOR_6(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5) \
1460 wxDirectConstructorBridge_6<klass,t0,t1,t2,t3,t4,t5> constructor##klass ; \
1461 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1462 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) } ; \
1463 const int klass::sm_constructorPropertiesCount##klass = 6;
1464
1465 // 7 params
1466
1467 template<typename Class,
1468 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
1469 struct wxConstructorBridge_7 : public wxConstructorBridge
1470 {
1471 void Create(wxObject * &o, wxxVariant *args)
1472 {
1473 Class *obj = dynamic_cast<Class*>(o);
1474 obj->Create(
1475 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1476 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1477 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1478 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1479 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1480 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5) ,
1481 args[6].WX_TEMPLATED_MEMBER_CALL(Get , T6)
1482 );
1483 }
1484 };
1485
1486 #define WX_CONSTRUCTOR_7(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5,t6,v6) \
1487 wxConstructorBridge_7<klass,t0,t1,t2,t3,t4,t5,t6> constructor##klass ; \
1488 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1489 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) , wxT(#v6) } ; \
1490 const int klass::sm_constructorPropertiesCount##klass = 7;
1491
1492 // 8 params
1493
1494 template<typename Class,
1495 typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7>
1496 struct wxConstructorBridge_8 : public wxConstructorBridge
1497 {
1498 void Create(wxObject * &o, wxxVariant *args)
1499 {
1500 Class *obj = dynamic_cast<Class*>(o);
1501 obj->Create(
1502 args[0].WX_TEMPLATED_MEMBER_CALL(Get , T0) ,
1503 args[1].WX_TEMPLATED_MEMBER_CALL(Get , T1) ,
1504 args[2].WX_TEMPLATED_MEMBER_CALL(Get , T2) ,
1505 args[3].WX_TEMPLATED_MEMBER_CALL(Get , T3) ,
1506 args[4].WX_TEMPLATED_MEMBER_CALL(Get , T4) ,
1507 args[5].WX_TEMPLATED_MEMBER_CALL(Get , T5) ,
1508 args[6].WX_TEMPLATED_MEMBER_CALL(Get , T6) ,
1509 args[7].WX_TEMPLATED_MEMBER_CALL(Get , T7)
1510 );
1511 }
1512 };
1513
1514 #define WX_CONSTRUCTOR_8(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4,t5,v5,t6,v6,t7,v7) \
1515 wxConstructorBridge_8<klass,t0,t1,t2,t3,t4,t5,t6,t7> constructor##klass ; \
1516 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
1517 const wxChar *klass::sm_constructorProperties##klass[] = { wxT(#v0) , wxT(#v1) , wxT(#v2) , wxT(#v3) , wxT(#v4) , wxT(#v5) , wxT(#v6) , wxT(#v7) } ; \
1518 const int klass::sm_constructorPropertiesCount##klass = 8;
1519 // ----------------------------------------------------------------------------
1520 // wxClassInfo
1521 // ----------------------------------------------------------------------------
1522
1523 typedef wxObject *(*wxObjectConstructorFn)(void);
1524 typedef wxObject* (*wxVariantToObjectConverter)( wxxVariant &data ) ;
1525 typedef wxxVariant (*wxObjectToVariantConverter)( wxObject* ) ;
1526
1527 class WXDLLIMPEXP_BASE wxWriter;
1528 class WXDLLIMPEXP_BASE wxPersister;
1529
1530 typedef bool (*wxObjectStreamingCallback) ( const wxObject *, wxWriter * , wxPersister * , wxxVariantArray & ) ;
1531
1532 class WXDLLIMPEXP_BASE wxClassInfo
1533 {
1534 friend class WXDLLIMPEXP_BASE wxPropertyInfo ;
1535 friend class WXDLLIMPEXP_BASE wxHandlerInfo ;
1536 public:
1537 wxClassInfo(const wxClassInfo **_Parents,
1538 const wxChar *_UnitName,
1539 const wxChar *_ClassName,
1540 int size,
1541 wxObjectConstructorFn ctor ,
1542 wxPropertyInfo *_Props ,
1543 wxHandlerInfo *_Handlers ,
1544 wxConstructorBridge* _Constructor ,
1545 const wxChar ** _ConstructorProperties ,
1546 const int _ConstructorPropertiesCount ,
1547 wxVariantToObjectConverter _PtrConverter1 ,
1548 wxVariantToObjectConverter _Converter2 ,
1549 wxObjectToVariantConverter _Converter3 ,
1550 wxObjectStreamingCallback _streamingCallback = NULL
1551 ) :
1552
1553 m_className(_ClassName),
1554 m_objectSize(size),
1555 m_objectConstructor(ctor),
1556 m_next(sm_first),
1557 m_firstProperty(_Props),
1558 m_firstHandler(_Handlers),
1559 m_parents(_Parents),
1560 m_unitName(_UnitName),
1561 m_constructor(_Constructor),
1562 m_constructorProperties(_ConstructorProperties),
1563 m_constructorPropertiesCount(_ConstructorPropertiesCount),
1564 m_variantOfPtrToObjectConverter(_PtrConverter1),
1565 m_variantToObjectConverter(_Converter2),
1566 m_objectToVariantConverter(_Converter3),
1567 m_streamingCallback(_streamingCallback)
1568 {
1569 sm_first = this;
1570 Register() ;
1571 }
1572
1573 wxClassInfo(const wxChar *_UnitName, const wxChar *_ClassName,
1574 const wxClassInfo **_Parents) :
1575 m_className(_ClassName),
1576 m_objectSize(0),
1577 m_objectConstructor(NULL),
1578 m_next(sm_first),
1579 m_firstProperty(NULL),
1580 m_firstHandler(NULL),
1581 m_parents(_Parents),
1582 m_unitName(_UnitName),
1583 m_constructor(NULL),
1584 m_constructorProperties(NULL),
1585 m_constructorPropertiesCount(0),
1586 m_variantOfPtrToObjectConverter(NULL),
1587 m_variantToObjectConverter(NULL),
1588 m_objectToVariantConverter(NULL),
1589 m_streamingCallback(NULL)
1590 {
1591 sm_first = this;
1592 Register() ;
1593 }
1594
1595 virtual ~wxClassInfo() ;
1596
1597 // allocates an instance of this class, this object does not have to be initialized or fully constructed
1598 // as this call will be followed by a call to Create
1599 virtual wxObject *AllocateObject() const { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
1600
1601 // 'old naming' for AllocateObject staying here for backward compatibility
1602 wxObject *CreateObject() const { return AllocateObject() ; }
1603
1604 // direct construction call for classes that cannot construct instances via alloc/create
1605 wxObject *ConstructObject(int ParamCount, wxxVariant *Params) const
1606 {
1607 wxASSERT_MSG( ParamCount == m_constructorPropertiesCount , wxT("Illegal Parameter Count for ConstructObject Method")) ;
1608 wxObject *object = NULL ;
1609 m_constructor->Create( object , Params ) ;
1610 return object ;
1611 }
1612
1613 bool NeedsDirectConstruction() const { return dynamic_cast<wxDirectConstructorBrigde*>( m_constructor) != NULL ; }
1614
1615 const wxChar *GetClassName() const { return m_className; }
1616 const wxChar *GetBaseClassName1() const
1617 { return m_parents[0] ? m_parents[0]->GetClassName() : NULL; }
1618 const wxChar *GetBaseClassName2() const
1619 { return (m_parents[0] && m_parents[1]) ? m_parents[1]->GetClassName() : NULL; }
1620 const wxChar *GetIncludeName() const { return m_unitName ; }
1621 const wxClassInfo **GetParents() const { return m_parents; }
1622 int GetSize() const { return m_objectSize; }
1623
1624 wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
1625 static const wxClassInfo *GetFirst() { return sm_first; }
1626 const wxClassInfo *GetNext() const { return m_next; }
1627 static wxClassInfo *FindClass(const wxChar *className);
1628
1629 // Climb upwards through inheritance hierarchy.
1630 // Dual inheritance is catered for.
1631
1632 bool IsKindOf(const wxClassInfo *info) const
1633 {
1634 if ( info != 0 )
1635 {
1636 if ( info == this )
1637 return true ;
1638
1639 for ( int i = 0 ; m_parents[i] ; ++ i )
1640 {
1641 if ( m_parents[i]->IsKindOf( info ) )
1642 return true ;
1643 }
1644 }
1645 return false ;
1646 }
1647
1648 // if there is a callback registered with that class it will be called
1649 // before this object will be written to disk, it can veto streaming out
1650 // this object by returning false, if this class has not registered a
1651 // callback, the search will go up the inheritance tree if no callback has
1652 // been registered true will be returned by default
1653 bool BeforeWriteObject( const wxObject *obj, wxWriter *streamer , wxPersister *persister , wxxVariantArray &metadata) const ;
1654
1655 // gets the streaming callback from this class or any superclass
1656 wxObjectStreamingCallback GetStreamingCallback() const ;
1657
1658 #ifdef WXWIN_COMPATIBILITY_2_4
1659 // Initializes parent pointers and hash table for fast searching.
1660 wxDEPRECATED( static void InitializeClasses() );
1661 // Cleans up hash table used for fast searching.
1662 wxDEPRECATED( static void CleanUpClasses() );
1663 #endif
1664 static void CleanUp();
1665
1666 // returns the first property
1667 const wxPropertyInfo* GetFirstProperty() const { return m_firstProperty ; }
1668
1669 // returns the first handler
1670 const wxHandlerInfo* GetFirstHandler() const { return m_firstHandler ; }
1671
1672 // Call the Create upon an instance of the class, in the end the object is fully
1673 // initialized
1674 virtual void Create (wxObject *object, int ParamCount, wxxVariant *Params) const
1675 {
1676 wxASSERT_MSG( ParamCount == m_constructorPropertiesCount , wxT("Illegal Parameter Count for Create Method")) ;
1677 m_constructor->Create( object , Params ) ;
1678 }
1679
1680 // get number of parameters for constructor
1681 virtual int GetCreateParamCount() const { return m_constructorPropertiesCount; }
1682
1683 // get n-th constructor parameter
1684 virtual const wxChar* GetCreateParamName(int n) const { return m_constructorProperties[n] ; }
1685
1686 // Runtime access to objects for simple properties (get/set) by property name, and variant data
1687 virtual void SetProperty (wxObject *object, const wxChar *propertyName, const wxxVariant &value) const ;
1688 virtual wxxVariant GetProperty (wxObject *object, const wxChar *propertyName) const;
1689
1690 // Runtime access to objects for collection properties by property name
1691 virtual wxxVariantArray GetPropertyCollection(wxObject *object, const wxChar *propertyName) const ;
1692 virtual void AddToPropertyCollection(wxObject *object, const wxChar *propertyName , const wxxVariant& value) const ;
1693
1694 // we must be able to cast variants to wxObject pointers, templates seem not to be suitable
1695 wxObject* VariantToInstance( wxxVariant &data ) const
1696 { if ( data.GetTypeInfo()->GetKind() == wxT_OBJECT )
1697 return m_variantToObjectConverter( data ) ;
1698 else
1699 return m_variantOfPtrToObjectConverter( data ) ;
1700 }
1701
1702 wxxVariant InstanceToVariant( wxObject *object ) const { return m_objectToVariantConverter( object ) ; }
1703
1704 // find property by name
1705 virtual const wxPropertyInfo *FindPropertyInfo (const wxChar *PropertyName) const ;
1706
1707 // find handler by name
1708 virtual const wxHandlerInfo *FindHandlerInfo (const wxChar *PropertyName) const ;
1709
1710 // find property by name
1711 virtual wxPropertyInfo *FindPropertyInfoInThisClass (const wxChar *PropertyName) const ;
1712
1713 // find handler by name
1714 virtual wxHandlerInfo *FindHandlerInfoInThisClass (const wxChar *PropertyName) const ;
1715
1716 // puts all the properties of this class and its superclasses in the map, as long as there is not yet
1717 // an entry with the same name (overriding mechanism)
1718 void GetProperties( wxPropertyInfoMap &map ) const ;
1719 public:
1720 const wxChar *m_className;
1721 int m_objectSize;
1722 wxObjectConstructorFn m_objectConstructor;
1723
1724 // class info object live in a linked list:
1725 // pointers to its head and the next element in it
1726
1727 static wxClassInfo *sm_first;
1728 wxClassInfo *m_next;
1729
1730 // FIXME: this should be private (currently used directly by way too
1731 // many clients)
1732 static wxHashTable *sm_classTable;
1733
1734 protected :
1735 wxPropertyInfo * m_firstProperty ;
1736 wxHandlerInfo * m_firstHandler ;
1737 private:
1738 const wxClassInfo** m_parents ;
1739 const wxChar* m_unitName;
1740
1741 wxConstructorBridge* m_constructor ;
1742 const wxChar ** m_constructorProperties ;
1743 const int m_constructorPropertiesCount ;
1744 wxVariantToObjectConverter m_variantOfPtrToObjectConverter ;
1745 wxVariantToObjectConverter m_variantToObjectConverter ;
1746 wxObjectToVariantConverter m_objectToVariantConverter ;
1747 wxObjectStreamingCallback m_streamingCallback ;
1748 const wxPropertyAccessor *FindAccessor (const wxChar *propertyName) const ;
1749
1750
1751 // InitializeClasses() helper
1752 static wxClassInfo *GetBaseByName(const wxChar *name) ;
1753
1754 protected:
1755 // registers the class
1756 void Register();
1757 void Unregister();
1758
1759 DECLARE_NO_COPY_CLASS(wxClassInfo)
1760 };
1761
1762
1763 WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
1764
1765 // ----------------------------------------------------------------------------
1766 // wxDynamicObject
1767 // ----------------------------------------------------------------------------
1768 //
1769 // this object leads to having a pure runtime-instantiation
1770
1771 class WXDLLIMPEXP_BASE wxDynamicClassInfo : public wxClassInfo
1772 {
1773 public :
1774 wxDynamicClassInfo( const wxChar *_UnitName, const wxChar *_ClassName , const wxClassInfo* superClass ) ;
1775 virtual ~wxDynamicClassInfo() ;
1776
1777 // constructs a wxDynamicObject with an instance
1778 virtual wxObject *AllocateObject() const ;
1779
1780 // Call the Create method for a class
1781 virtual void Create (wxObject *object, int ParamCount, wxxVariant *Params) const ;
1782
1783 // get number of parameters for constructor
1784 virtual int GetCreateParamCount() const ;
1785
1786 // get i-th constructor parameter
1787 virtual const wxChar* GetCreateParamName(int i) const ;
1788
1789 // Runtime access to objects by property name, and variant data
1790 virtual void SetProperty (wxObject *object, const wxChar *PropertyName, const wxxVariant &Value) const ;
1791 virtual wxxVariant GetProperty (wxObject *object, const wxChar *PropertyName) const ;
1792
1793 // adds a property to this class at runtime
1794 void AddProperty( const wxChar *propertyName , const wxTypeInfo* typeInfo ) ;
1795
1796 // removes an existing runtime-property
1797 void RemoveProperty( const wxChar *propertyName ) ;
1798
1799 // renames an existing runtime-property
1800 void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ;
1801
1802 // as a handler to this class at runtime
1803 void AddHandler( const wxChar *handlerName , wxObjectEventFunction address , const wxClassInfo* eventClassInfo ) ;
1804
1805 // removes an existing runtime-handler
1806 void RemoveHandler( const wxChar *handlerName ) ;
1807
1808 // renames an existing runtime-handler
1809 void RenameHandler( const wxChar *oldHandlerName , const wxChar *newHandlerName ) ;
1810 } ;
1811
1812 // ----------------------------------------------------------------------------
1813 // Dynamic class macros
1814 // ----------------------------------------------------------------------------
1815
1816 #define _DECLARE_DYNAMIC_CLASS(name) \
1817 public: \
1818 static wxClassInfo sm_class##name; \
1819 static const wxClassInfo* sm_classParents##name[] ; \
1820 static wxPropertyInfo* GetPropertiesStatic() ; \
1821 static wxHandlerInfo* GetHandlersStatic() ; \
1822 static wxClassInfo *GetClassInfoStatic() \
1823 { return &name::sm_class##name; } \
1824 virtual wxClassInfo *GetClassInfo() const \
1825 { return &name::sm_class##name; }
1826
1827 #define DECLARE_DYNAMIC_CLASS(name) \
1828 static wxConstructorBridge* sm_constructor##name ; \
1829 static const wxChar * sm_constructorProperties##name[] ; \
1830 static const int sm_constructorPropertiesCount##name ; \
1831 _DECLARE_DYNAMIC_CLASS(name)
1832
1833 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
1834 DECLARE_NO_ASSIGN_CLASS(name) \
1835 DECLARE_DYNAMIC_CLASS(name)
1836
1837 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
1838 DECLARE_NO_COPY_CLASS(name) \
1839 DECLARE_DYNAMIC_CLASS(name)
1840
1841 #define DECLARE_ABSTRACT_CLASS(name) _DECLARE_DYNAMIC_CLASS(name)
1842 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
1843
1844 // -----------------------------------
1845 // for concrete classes
1846 // -----------------------------------
1847
1848 // Single inheritance with one base class
1849
1850 #define _TYPEINFO_CLASSES(n , toString , fromString ) \
1851 wxClassTypeInfo s_typeInfo##n(wxT_OBJECT , &n::sm_class##n , toString , fromString , typeid(n).name()) ; \
1852 wxClassTypeInfo s_typeInfoPtr##n(wxT_OBJECT_PTR , &n::sm_class##n , toString , fromString , typeid(n*).name()) ;
1853
1854 #define _IMPLEMENT_DYNAMIC_CLASS(name, basename, unit , callback) \
1855 wxObject* wxConstructorFor##name() \
1856 { return new name; } \
1857 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1858 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1859 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1860 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1861 (int) sizeof(name), \
1862 (wxObjectConstructorFn) wxConstructorFor##name , \
1863 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1864 name::sm_constructorPropertiesCount##name , wxVariantOfPtrToObjectConverter##name , NULL , wxObjectToVariantConverter##name , callback);
1865
1866 #define _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY(name, basename, unit, callback ) \
1867 wxObject* wxConstructorFor##name() \
1868 { return new name; } \
1869 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1870 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return &data.Get<name>() ; } \
1871 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1872 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1873 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1874 (int) sizeof(name), \
1875 (wxObjectConstructorFn) wxConstructorFor##name , \
1876 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1877 name::sm_constructorPropertiesCount##name , wxVariantOfPtrToObjectConverter##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name, callback);
1878
1879 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename ) \
1880 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , "" , NULL ) \
1881 _TYPEINFO_CLASSES(name, NULL , NULL) \
1882 const wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1883 const wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1884 WX_CONSTRUCTOR_DUMMY( name )
1885
1886 #define IMPLEMENT_DYNAMIC_CLASS( name , basename ) \
1887 _IMPLEMENT_DYNAMIC_CLASS( name , basename , "" , NULL ) \
1888 _TYPEINFO_CLASSES(name, NULL , NULL) \
1889 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1890 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1891 WX_CONSTRUCTOR_DUMMY( name )
1892
1893 #define IMPLEMENT_DYNAMIC_CLASS_XTI( name , basename , unit ) \
1894 _IMPLEMENT_DYNAMIC_CLASS( name , basename , unit , NULL ) \
1895 _TYPEINFO_CLASSES(name, NULL , NULL)
1896
1897 #define IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK( name , basename , unit , callback ) \
1898 _IMPLEMENT_DYNAMIC_CLASS( name , basename , unit , &callback ) \
1899 _TYPEINFO_CLASSES(name, NULL , NULL)
1900
1901 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY_XTI( name , basename , unit ) \
1902 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , unit , NULL ) \
1903 _TYPEINFO_CLASSES(name, NULL , NULL)
1904
1905 #define IMPLEMENT_DYNAMIC_CLASS_WITH_COPY_AND_STREAMERS_XTI( name , basename , unit , toString , fromString ) \
1906 _IMPLEMENT_DYNAMIC_CLASS_WITH_COPY( name , basename , unit , NULL ) \
1907 _TYPEINFO_CLASSES(name, toString , fromString)
1908
1909 // this is for classes that do not derive from wxobject, there are no creators for these
1910
1911 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_NO_BASE_XTI( name , unit ) \
1912 const wxClassInfo* name::sm_classParents##name[] = { NULL } ; \
1913 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1914 (int) sizeof(name), \
1915 (wxObjectConstructorFn) 0 , \
1916 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1917 0 , 0 , 0 ); \
1918 _TYPEINFO_CLASSES(name, NULL , NULL)
1919
1920 // this is for subclasses that still do not derive from wxobject
1921
1922 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_XTI( name , basename, unit ) \
1923 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1924 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1925 (int) sizeof(name), \
1926 (wxObjectConstructorFn) 0 , \
1927 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1928 0 , 0 , 0 ); \
1929 _TYPEINFO_CLASSES(name, NULL , NULL)
1930
1931
1932 // Multiple inheritance with two base classes
1933
1934 #define _IMPLEMENT_DYNAMIC_CLASS2(name, basename, basename2, unit) \
1935 wxObject* wxConstructorFor##name() \
1936 { return new name; } \
1937 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,&basename2::sm_class##basename2 , NULL } ; \
1938 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1939 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1940 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1941 (int) sizeof(name), \
1942 (wxObjectConstructorFn) wxConstructorFor##name , \
1943 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1944 name::sm_constructorPropertiesCount##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1945
1946 #define IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2) \
1947 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , "") \
1948 _TYPEINFO_CLASSES(name, NULL , NULL) \
1949 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1950 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1951 WX_CONSTRUCTOR_DUMMY( name )
1952
1953 #define IMPLEMENT_DYNAMIC_CLASS2_XTI( name , basename , basename2, unit) \
1954 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , unit) \
1955 _TYPEINFO_CLASSES(name, NULL , NULL)
1956
1957
1958 // -----------------------------------
1959 // for abstract classes
1960 // -----------------------------------
1961
1962 // Single inheritance with one base class
1963
1964 #define _IMPLEMENT_ABSTRACT_CLASS(name, basename) \
1965 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1966 wxObject* wxVariantToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1967 wxObject* wxVariantOfPtrToObjectConverter##name ( wxxVariant &data ) { return data.Get<name*>() ; } \
1968 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1969 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1970 (int) sizeof(name), \
1971 (wxObjectConstructorFn) 0 , \
1972 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1973 0 , wxVariantOfPtrToObjectConverter##name ,wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1974 _TYPEINFO_CLASSES(name, NULL , NULL)
1975
1976 #define IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1977 _IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1978 wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1979 wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; }
1980
1981 // Multiple inheritance with two base classes
1982
1983 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
1984 wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1), \
1985 wxT(#basename2), (int) sizeof(name), \
1986 (wxObjectConstructorFn) 0);
1987
1988 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
1989 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
1990
1991 // --------------------------------------------------------------------------
1992 // Collection Support
1993 // --------------------------------------------------------------------------
1994
1995 template<typename iter , typename collection_t > void wxListCollectionToVariantArray( const collection_t& coll , wxxVariantArray &value )
1996 {
1997 iter current = coll.GetFirst() ;
1998 while (current)
1999 {
2000 value.Add( new wxxVariant(current->GetData()) ) ;
2001 current = current->GetNext();
2002 }
2003 }
2004
2005 template<typename collection_t> void wxArrayCollectionToVariantArray( const collection_t& coll , wxxVariantArray &value )
2006 {
2007 for( size_t i = 0 ; i < coll.GetCount() ; i++ )
2008 {
2009 value.Add( new wxxVariant(coll[i]) ) ;
2010 }
2011 }
2012
2013
2014 #endif