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