1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: runtime metadata information (extended class info)
4 // Author: Stefan Csomor
8 // Copyright: (c) 1997 Julian Smart
9 // (c) 2003 Stefan Csomor
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
16 #if defined(__GNUG__) && !defined(__APPLE__)
17 #pragma interface "xti.h"
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.
24 // This means we have the following domains :
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
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
40 #include "wx/memory.h"
42 #include "wx/string.h"
44 class WXDLLIMPEXP_BASE wxObject
;
45 class WXDLLIMPEXP_BASE wxClassInfo
;
46 class WXDLLIMPEXP_BASE wxHashTable
;
47 class WXDLLIMPEXP_BASE wxObjectRefData
;
48 class WXDLLIMPEXP_BASE wxEvent
;
50 typedef void (wxObject::*wxObjectEventFunction
)(wxEvent
&);
52 // ----------------------------------------------------------------------------
55 // In the header files there would no change from pure c++ code, in the
56 // implementation, an enum would have
57 // to be enumerated eg :
59 // WX_BEGIN_ENUM( wxFlavor )
60 // WX_ENUM_MEMBER( Vanilla )
61 // WX_ENUM_MEMBER( Chocolate )
62 // WX_ENUM_MEMBER( Strawberry )
63 // WX_END_ENUM( wxFlavor )
64 // ----------------------------------------------------------------------------
66 struct WXDLLIMPEXP_BASE wxEnumMemberData
72 class WXDLLIMPEXP_BASE wxEnumData
75 wxEnumData( wxEnumMemberData
* data
) ;
77 // returns true if the member has been found and sets the int value
78 // pointed to accordingly (if ptr != null )
79 // if not found returns false, value left unchanged
80 bool HasEnumMemberValue( const wxChar
*name
, int *value
= NULL
) ;
82 // returns the value of the member, if not found in debug mode an
83 // assert is issued, in release 0 is returned
84 int GetEnumMemberValue(const wxChar
*name
);
86 // returns the name of the enum member having the passed in value
87 // returns an emtpy string if not found
88 const wxChar
*GetEnumMemberName(int value
);
90 // returns the number of members in this enum
91 int GetEnumCount() { return m_count
; }
93 // returns the value of the nth member
94 int GetEnumMemberValueByIndex( int n
) ;
96 // returns the value of the nth member
97 const wxChar
*GetEnumMemberNameByIndex( int n
) ;
99 wxEnumMemberData
*m_members
;
103 #define WX_BEGIN_ENUM( e ) \
104 wxEnumMemberData s_enumDataMembers##e[] = {
106 #define WX_ENUM_MEMBER( v ) { #v, v } ,
108 #define WX_END_ENUM( e ) { NULL , 0 } } ; \
109 wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
110 wxEnumData *wxGetEnumData(e) { return &s_enumData##e ; } \
111 template<> const wxTypeInfo* wxGetTypeInfo( e * ){ static wxEnumTypeInfo s_typeInfo(wxT_ENUM , &s_enumData##e) ; return &s_typeInfo ; } \
112 template<> void wxStringReadValue(const wxString& s , e &data ) \
114 data = (e) s_enumData##e.GetEnumMemberValue(s) ; \
116 template<> void wxStringWriteValue(wxString &s , const e &data ) \
118 s = s_enumData##e.GetEnumMemberName((int)data) ; \
121 // ----------------------------------------------------------------------------
133 // typedef wxSet<wxFlavor> wxCoupe ;
135 // in the implementation file :
137 // WX_BEGIN_ENUM( wxFlavor )
138 // WX_ENUM_MEMBER( Vanilla )
139 // WX_ENUM_MEMBER( Chocolate )
140 // WX_ENUM_MEMBER( Strawberry )
141 // WX_END_ENUM( wxFlavor )
143 // WX_IMPLEMENT_SET_STREAMING( wxCoupe , wxFlavor )
145 // implementation note : no partial specialization for streaming, but a delegation to a
148 // ----------------------------------------------------------------------------
150 // in order to remove dependancy on string tokenizer
151 void wxSetStringToArray( const wxString
&s
, wxArrayString
&array
) ;
154 void wxSetFromString(const wxString
&s
, wxSet
<e
> &data
)
156 wxEnumData
* edata
= wxGetEnumData((e
) 0) ;
159 wxArrayString array
;
160 wxSetStringToArray( s
, array
) ;
162 for ( int i
= 0 ; i
< array
.Count() ; ++i
)
166 if ( edata
->HasEnumMemberValue( flag
, &ivalue
) )
168 data
.Set( (e
) ivalue
) ;
174 void wxSetToString( wxString
&s
, const wxSet
<e
> &data
)
176 wxEnumData
* edata
= wxGetEnumData((e
) 0) ;
177 int count
= edata
->GetEnumCount() ;
180 for ( i
= 0 ; i
< count
; i
++ )
182 e value
= (e
) edata
->GetEnumMemberValueByIndex(i
) ;
183 if ( data
.Contains( value
) )
185 // this could also be done by the templated calls
188 s
+= edata
->GetEnumMemberNameByIndex(i
) ;
193 // if the wxSet specialization above does not work for all compilers, add this to the WX_IMPLEMENT_SET_STREAMING macro
194 // template<> const wxTypeInfo* wxGetTypeInfo( SetName * ){ static wxEnumTypeInfo s_typeInfo(wxT_SET , &s_enumData##e) ; return &s_typeInfo ; }
196 #define WX_IMPLEMENT_SET_STREAMING(SetName,e) \
197 template<> void wxStringReadValue(const wxString &s , wxSet<e> &data ) \
199 wxSetFromString( s , data ) ; \
201 template<> void wxStringWriteValue( wxString &s , const wxSet<e> &data ) \
203 wxSetToString( s , data ) ; \
207 // ----------------------------------------------------------------------------
209 // ----------------------------------------------------------------------------
213 wxT_VOID
= 0, // unknown type
223 wxT_STRING
, // must be wxString
224 wxT_SET
, // must be wxSet<> template
226 wxT_OBJECT
, // must be a component (pointer !!!)
227 wxT_CUSTOM
, // user defined type (e.g. wxPoint)
228 wxT_DELEGATE
, // for connecting against an event source
229 wxT_LAST_TYPE_KIND
// sentinel for bad data, asserts, debugging
232 class WXDLLIMPEXP_BASE wxTypeInfo
235 wxTypeInfo() : m_kind( wxT_VOID
) {}
236 virtual ~wxTypeInfo() {}
237 wxTypeKind
GetKind() const { return m_kind
; }
242 class WXDLLIMPEXP_BASE wxBuiltInTypeInfo
: public wxTypeInfo
245 wxBuiltInTypeInfo( wxTypeKind kind
) { wxASSERT_MSG( kind
< wxT_SET
, wxT("Illegal Kind for Base Type") ) ; m_kind
= kind
;}
248 class WXDLLIMPEXP_BASE wxCustomTypeInfo
: public wxTypeInfo
251 wxCustomTypeInfo( const wxChar
*typeName
)
252 { m_kind
= wxT_CUSTOM
; m_typeName
= typeName
;}
253 const wxChar
*GetTypeName() const { return m_typeName
; }
255 const wxChar
*m_typeName
; // Kind == wxT_CUSTOM
258 class WXDLLIMPEXP_BASE wxEnumTypeInfo
: public wxTypeInfo
261 wxEnumTypeInfo( wxTypeKind kind
, wxEnumData
* enumInfo
)
262 { wxASSERT_MSG( kind
== wxT_ENUM
|| kind
== wxT_SET
, wxT("Illegal Kind for Enum Type")) ; m_kind
= kind
; m_enumInfo
= enumInfo
;}
263 const wxEnumData
* GetEnumData() const { return m_enumInfo
; }
265 wxEnumData
*m_enumInfo
; // Kind == wxT_ENUM or Kind == wxT_SET
268 class WXDLLIMPEXP_BASE wxClassTypeInfo
: public wxTypeInfo
271 wxClassTypeInfo( wxClassInfo
* classInfo
)
272 { m_kind
= wxT_OBJECT
; m_classInfo
= classInfo
;}
273 const wxClassInfo
*GetClassInfo() const { return m_classInfo
; }
275 wxClassInfo
*m_classInfo
; // Kind == wxT_OBJECT - could be NULL
278 // a delegate is an exposed event source
280 class WXDLLIMPEXP_BASE wxDelegateTypeInfo
: public wxTypeInfo
283 wxDelegateTypeInfo( int eventType
, wxClassInfo
* eventClass
)
284 { m_kind
= wxT_DELEGATE
; m_eventClass
= eventClass
; m_eventType
= eventType
;}
285 const wxClassInfo
*GetEventClass() const { assert( m_kind
== wxT_DELEGATE
) ; return m_eventClass
; }
286 int GetEventType() const { return m_eventType
; }
288 const wxClassInfo
*m_eventClass
; // (extended will merge into classinfo)
292 template<typename T
> const wxTypeInfo
* wxGetTypeInfo( T
* ) ;
294 template<typename T
> const wxTypeInfo
* wxGetTypeInfo( wxSet
<T
> * )
296 static wxEnumTypeInfo
s_typeInfo(wxT_SET
, wxGetEnumData((T
) 0) ) ; return &s_typeInfo
;
299 // this macro is for usage with custom, non-object derived classes and structs, wxPoint is such a custom type
301 #define WX_CUSTOM_TYPE_INFO( e ) \
302 template<> const wxTypeInfo* wxGetTypeInfo( e * ){ static wxCustomTypeInfo s_typeInfo(#e) ; return &s_typeInfo ; } \
304 // ----------------------------------------------------------------------------
307 // streaming is defined for xml constructs right now, the aim is to make this
308 // pluggable in the future
309 // ----------------------------------------------------------------------------
311 // convenience function (avoids including xml headers in users code)
314 void wxXmlAddContentToNode( wxXmlNode
* node
, const wxString
& data
) ;
315 wxString
wxXmlGetContentFromNode( wxXmlNode
*node
) ;
317 // templated streaming, every type must have their specialization for these methods
320 void wxStringReadValue( const wxString
&s
, T
&data
) ;
323 void wxStringWriteValue( wxString
&s
, const T
&data
) ;
325 // for simple types this default implementation is ok, composited structures will have to
326 // loop through their properties
329 void wxXmlReadValue( wxXmlNode
*node
, T
&data
)
331 wxStringReadValue
<T
>( wxXmlGetContentFromNode( node
) , data
) ;
335 void wxXmlWriteValue( wxXmlNode
*node
, const T
&data
)
338 wxStringWriteValue
<T
>( s
, data
) ;
339 wxXmlAddContentToNode( node
,s
) ;
342 // ----------------------------------------------------------------------------
343 // wxxVariant as typesafe data holder
344 // ----------------------------------------------------------------------------
346 class WXDLLIMPEXP_BASE wxxVariantData
349 virtual ~wxxVariantData() {}
351 // return a heap allocated duplicate
352 virtual wxxVariantData
* Clone() const = 0 ;
354 // returns the type info of the contentc
355 virtual const wxTypeInfo
* GetTypeInfo() const = 0 ;
357 // write the value into an xml node
358 virtual void Write( wxXmlNode
* node
) const = 0 ;
360 // read the value from the xml node
361 virtual void Read( wxXmlNode
* node
) = 0 ;
363 // write the value into a string
364 virtual void Write( wxString
&s
) const = 0 ;
366 // read the value from a string
367 virtual void Read( const wxString
&s
) = 0 ;
370 template<typename T
> class WXDLLIMPEXP_BASE wxxVariantDataT
: public wxxVariantData
373 wxxVariantDataT(T d
) : m_data(d
) {}
374 virtual ~wxxVariantDataT() {}
376 // get a copy of the stored data
377 T
Get() const { return m_data
; }
380 void Set(T d
) { m_data
= d
; }
382 // return a heap allocated duplicate
383 virtual wxxVariantData
* Clone() const { return new wxxVariantDataT
<T
>( Get() ) ; }
385 // returns the type info of the contentc
386 virtual const wxTypeInfo
* GetTypeInfo() const { return wxGetTypeInfo( (T
*) NULL
) ; }
388 // write the value into an xml node
389 virtual void Write( wxXmlNode
* node
) const { wxXmlWriteValue( node
, m_data
) ; }
391 // read the value from the xml node
392 virtual void Read( wxXmlNode
* node
) { wxXmlReadValue( node
, m_data
) ; }
394 // write the value into a string
395 virtual void Write( wxString
&s
) const { wxStringWriteValue( s
, m_data
) ; }
397 // read the value from a string
398 virtual void Read( const wxString
&s
) { wxStringReadValue( s
, m_data
) ; }
404 class WXDLLIMPEXP_BASE wxxVariant
407 wxxVariant() { m_data
= NULL
; }
408 wxxVariant( wxxVariantData
* data
, const wxString
& name
= wxT("") ) : m_data(data
) , m_name(name
) {}
409 wxxVariant( const wxxVariant
&d
) { if ( d
.m_data
) m_data
= d
.m_data
->Clone() ; else m_data
= NULL
; m_name
= d
.m_name
; }
411 template<typename T
> wxxVariant( T data
, const wxString
& name
= wxT("") ) :
412 m_data(new wxxVariantDataT
<T
>(data
) ), m_name(name
) {}
413 ~wxxVariant() { delete m_data
; }
415 // get a copy of the stored data
416 template<typename T
> T
Get() const
418 wxxVariantDataT
<T
> *dataptr
= dynamic_cast<wxxVariantDataT
<T
>*> (m_data
) ;
419 wxASSERT_MSG( dataptr
, "Cast not possible" ) ;
420 return dataptr
->Get() ;
424 template<typename T
> void Set(T data
) const
427 m_data
= new wxxVariantDataT
<T
>(data
) ;
430 wxxVariant
& operator=(const wxxVariant
&d
)
432 m_data
= d
.m_data
->Clone() ;
437 // gets the stored data casted to a wxObject* , returning NULL if cast is not possible
438 wxObject
* GetAsObject() const ;
440 // write the value into an xml node
441 void Write( wxXmlNode
* node
) const { m_data
->Write( node
) ; }
443 // read the value from the xml node
444 void Read( wxXmlNode
* node
) { m_data
->Read( node
) ; }
446 // write the value into a string
447 void Write( wxString
&s
) const { m_data
->Write( s
) ; }
449 // read the value from a string
450 void Read( const wxString
&s
) { m_data
->Read( s
) ; }
452 // returns this value as string
453 wxString
GetAsString() const
460 void SetFromString( const wxString
&s
)
465 wxxVariantData
* m_data
;
469 // ----------------------------------------------------------------------------
472 // wxPropertyInfo is used to inquire of the property by name. It doesn't
473 // provide access to the property, only information about it. If you
474 // want access, look at wxPropertyAccessor.
475 // ----------------------------------------------------------------------------
477 class WXDLLIMPEXP_BASE wxPropertyAccessor
481 class SetAndGetByRef
;
483 virtual void SetProperty(wxObject
*object
, const wxxVariant
&value
) const = 0 ;
484 virtual wxxVariant
GetProperty(wxObject
*object
) const = 0 ;
485 virtual bool HasSetter() const = 0 ;
486 virtual bool HasGetter() const = 0 ;
487 const wxChar
* GetGetterName() const { return m_setterName
; }
488 const wxChar
* GetSetterName() const { return m_getterName
; }
489 virtual wxxVariant
ReadValue( wxXmlNode
* node
) const = 0 ;
490 virtual void WriteValue( wxXmlNode
* node
, wxObject
*o
) const = 0 ;
491 virtual wxxVariant
ReadValue( const wxString
&value
) const = 0 ;
492 virtual void WriteValue( wxString
& value
, wxObject
*o
) const = 0 ;
494 const wxChar
*m_setterName
;
495 const wxChar
*m_getterName
;
499 void wxXmlReadValue( wxXmlNode
*node
, T
&data
) ;
502 void wxXmlWriteValue( wxXmlNode
*node
, const T
&data
) ;
504 template<class Klass
, typename T
>
505 class WXDLLIMPEXP_BASE wxPropertyAccessorT
: public wxPropertyAccessor
509 typedef void (Klass::*setter_t
)(T value
);
510 typedef void (Klass::*setter_ref_t
)(const T
& value
);
511 typedef T (Klass::*getter_t
)() const;
512 typedef const T
& (Klass::*getter_ref_t
)() const;
514 wxPropertyAccessorT(setter_t setter
, getter_t getter
, const wxChar
*g
, const wxChar
*s
)
515 : m_setter(setter
), m_setter_ref(NULL
), m_getter(getter
) ,m_getter_ref(NULL
) {m_setterName
= s
;m_getterName
=g
;}
517 wxPropertyAccessorT( getter_t getter
, const wxChar
*g
)
518 : m_setter(NULL
), m_setter_ref(NULL
), m_getter(getter
) ,m_getter_ref(NULL
) {m_setterName
= "";m_getterName
=g
;}
520 wxPropertyAccessorT(SetByRef
*, setter_ref_t setter
, getter_t getter
, const wxChar
*g
, const wxChar
*s
)
521 : m_setter(NULL
), m_setter_ref(setter
), m_getter(getter
) , m_getter_ref(NULL
){m_setterName
= s
;m_getterName
=g
;}
523 // wxPropertyAccessorT(setter_ref_t setter, getter_t getter, const wxChar *g, const wxChar *s)
524 // : m_setter(NULL), m_setter_ref(setter), m_getter(getter) , m_getter_ref(NULL){m_setterName = s;m_getterName=g ;}
526 wxPropertyAccessorT(SetAndGetByRef
*, setter_ref_t setter
, getter_ref_t getter
, const wxChar
*g
, const wxChar
*s
)
527 : m_setter(NULL
), m_setter_ref(setter
), m_getter(NULL
) , m_getter_ref(getter
){m_setterName
= s
;m_getterName
=g
;}
529 // wxPropertyAccessorT(setter_ref_t setter, getter_ref_t getter, const wxChar *g, const wxChar *s)
530 // : m_setter(NULL), m_setter_ref(setter), m_getter(NULL) , m_getter_ref(getter){m_setterName = s;m_getterName=g ;}
532 // wxPropertyAccessorT(setter_t setter, getter_ref_t getter, const wxChar *g, const wxChar *s)
533 // : m_setter(NULL), m_setter(setter), m_getter(NULL) , m_getter_ref(getter){m_setterName = s;m_getterName=g ;}
535 wxPropertyAccessorT(GetByRef
*, setter_t setter
, getter_ref_t getter
, const wxChar
*g
, const wxChar
*s
)
536 : m_setter(NULL
), m_setter(setter
), m_getter(NULL
) , m_getter_ref(getter
){m_setterName
= s
;m_getterName
=g
;}
538 // wxPropertyAccessorT( getter_ref_t getter, const wxChar *g)
539 // : m_setter(NULL), m_setter(NULL), m_getter(NULL) , m_getter_ref(getter){m_setterName = "";m_getterName=g ;}
541 // returns true if this accessor has a setter
542 bool HasSetter() const { return m_setter
!= NULL
|| m_setter_ref
!= NULL
; }
544 // return true if this accessor has a getter
545 bool HasGetter() const { return m_getter
!= NULL
|| m_getter_ref
!= NULL
; }
547 // set the property this accessor is responsible for in an object
548 void SetProperty(wxObject
*o
, const wxxVariant
&v
) const
550 Klass
*obj
= dynamic_cast<Klass
*>(o
);
551 T value
= v
.Get
<T
>();
553 (obj
->*(m_setter
))(value
);
555 (obj
->*(m_setter_ref
))(value
);
558 // gets the property this accessor is responsible for from an object
559 wxxVariant
GetProperty(wxObject
*o
) const
561 return wxxVariant( (wxxVariantData
* ) DoGetProperty( o
) ) ;
564 // write the property this accessor is responsible for from an object into
566 void WriteValue( wxXmlNode
* node
, wxObject
*o
) const
568 DoGetProperty( o
)->Write( node
) ;
571 // write the property this accessor is responsible for from an object into
573 void WriteValue( wxString
& s
, wxObject
*o
) const
575 DoGetProperty( o
)->Write( s
) ;
578 // read a wxxVariant having the correct type for the property this accessor
579 // is responsible for from an xml node
580 wxxVariant
ReadValue( wxXmlNode
* node
) const
583 wxXmlReadValue( node
, data
) ;
584 return wxxVariant( data
) ;
587 // read a wxxVariant having the correct type for the property this accessor
588 // is responsible for from a string
589 wxxVariant
ReadValue( const wxString
&value
) const
592 wxStringReadValue( value
, data
) ;
593 return wxxVariant( data
) ;
597 wxxVariantDataT
<T
>* DoGetProperty(wxObject
*o
) const
599 Klass
*obj
= dynamic_cast<Klass
*>(o
);
601 return new wxxVariantDataT
<T
>( (obj
->*(m_getter
))() ) ;
603 return new wxxVariantDataT
<T
>( (obj
->*(m_getter_ref
))() ) ;
607 setter_ref_t m_setter_ref
;
609 getter_ref_t m_getter_ref
;
612 class WXDLLIMPEXP_BASE wxPropertyInfo
615 wxPropertyInfo( wxPropertyInfo
* &iter
, const wxChar
*name
, const wxChar
*typeName
, const wxTypeInfo
* typeInfo
, wxPropertyAccessor
*accessor
, wxxVariant dv
) :
616 m_name( name
) , m_typeName(typeName
) , m_typeInfo( typeInfo
) , m_accessor( accessor
) , m_defaultValue( dv
)
623 wxPropertyInfo
* i
= iter
;
630 // return the name of this property
631 const wxChar
* GetName() const { return m_name
; }
633 // return the typename of this property
634 const wxChar
* GetTypeName() const { return m_typeName
; }
636 // return the type info of this property
637 const wxTypeInfo
* GetTypeInfo() const { return m_typeInfo
; }
639 // return the accessor for this property
640 wxPropertyAccessor
* GetAccessor() const { return m_accessor
; }
642 // returns NULL if this is the last property of this class
643 wxPropertyInfo
* GetNext() const { return m_next
; }
645 // returns the default value of this property, its kind may be wxT_VOID if it is not valid
646 wxxVariant
GetDefaultValue() const { return m_defaultValue
; }
648 const wxChar
* m_name
;
649 const wxChar
* m_typeName
;
650 const wxTypeInfo
* m_typeInfo
;
651 wxPropertyAccessor
* m_accessor
;
652 wxxVariant m_defaultValue
;
653 // string representation of the default value
654 // to be assigned by the designer to the property
655 // when the component is dropped on the container.
656 wxPropertyInfo
* m_next
;
659 #define WX_BEGIN_PROPERTIES_TABLE(theClass) \
660 const wxPropertyInfo *theClass::GetPropertiesStatic() \
662 typedef theClass class_t; \
663 static wxPropertyInfo* first = NULL ;
665 #define WX_END_PROPERTIES_TABLE() \
668 #define WX_PROPERTY( name , type , setter , getter ,defaultValue ) \
669 static wxPropertyAccessorT<class_t , type> _accessor##name( &setter , &getter , #setter , #getter ) ; \
670 static wxPropertyInfo _propertyInfo##name( first , #name , #type , wxGetTypeInfo( (type*) NULL ) ,&_accessor##name , wxxVariant(defaultValue) ) ;
672 #define WX_PROPERTY_SET_BY_REF( name , type , setter , getter ,defaultValue ) \
673 static wxPropertyAccessorT<class_t , type> _accessor##name( (wxPropertyAccessor::SetByRef*)NULL, &setter , &getter , #setter , #getter ) ; \
674 static wxPropertyInfo _propertyInfo##name( first , #name , #type , wxGetTypeInfo( (type*) NULL ) ,&_accessor##name , wxxVariant(defaultValue) ) ;
676 #define WX_READONLY_PROPERTY( name , type , getter ,defaultValue ) \
677 static wxPropertyAccessorT<class_t , type> _accessor##name( &getter , #getter ) ; \
678 static wxPropertyInfo _propertyInfo##name( first , #name , #type , wxGetTypeInfo( (type*) NULL ) ,&_accessor##name , wxxVariant(defaultValue) ) ;
680 #define WX_DELEGATE( name , eventType , eventClass ) \
681 static wxDelegateTypeInfo _typeInfo##name( eventType , CLASSINFO( eventClass ) ) ; \
682 static wxPropertyInfo _propertyInfo##name( first , #name , NULL , &_typeInfo##name , NULL , wxxVariant() ) ; \
684 // ----------------------------------------------------------------------------
687 // this is describing an event sink
688 // ----------------------------------------------------------------------------
693 wxHandlerInfo( wxHandlerInfo
* &iter
, const wxChar
*name
, wxObjectEventFunction address
, const wxClassInfo
* eventClassInfo
) :
694 m_name( name
) , m_eventClassInfo( eventClassInfo
) , m_eventFunction( address
)
701 wxHandlerInfo
* i
= iter
;
709 // get the name of the handler method
710 const wxChar
* GetName() const { return m_name
; }
712 // return the class info of the event
713 const wxClassInfo
* GetEventClassInfo() const { return m_eventClassInfo
; }
715 // get the handler function pointer
716 wxObjectEventFunction
GetEventFunction() const { return m_eventFunction
; }
718 // returns NULL if this is the last handler of this class
719 wxHandlerInfo
* GetNext() const { return m_next
; }
721 wxObjectEventFunction m_eventFunction
;
722 const wxChar
* m_name
;
723 const wxClassInfo
* m_eventClassInfo
;
724 wxHandlerInfo
* m_next
;
727 #define WX_HANDLER(name,eventClassType) \
728 static wxHandlerInfo _handlerInfo##name( first , #name , (wxObjectEventFunction) (wxEventFunction) &name , CLASSINFO( eventClassType ) ) ;
730 #define WX_BEGIN_HANDLERS_TABLE(theClass) \
731 const wxHandlerInfo *theClass::GetHandlersStatic() \
733 typedef theClass class_t; \
734 static wxHandlerInfo* first = NULL ;
736 #define WX_END_HANDLERS_TABLE() \
739 // ----------------------------------------------------------------------------
740 // Constructor Bridges
742 // allow to set up constructors with params during runtime
743 // ----------------------------------------------------------------------------
745 class WXDLLIMPEXP_BASE wxConstructorBridge
748 virtual void Create(wxObject
*o
, wxxVariant
*args
) = 0;
751 // Creator Bridges for all Numbers of Params
755 template<typename Class
>
756 struct wxConstructorBridge_0
: public wxConstructorBridge
758 void Create(wxObject
*o
, wxxVariant
*)
760 Class
*obj
= dynamic_cast<Class
*>(o
);
765 struct wxConstructorBridge_Dummy
: public wxConstructorBridge
767 void Create(wxObject
*, wxxVariant
*)
772 #define WX_CONSTRUCTOR_0(klass) \
773 wxConstructorBridge_0<klass> constructor##klass ; \
774 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
775 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
776 const int klass::sm_constructorPropertiesCount##klass = 0 ;
778 #define WX_CONSTRUCTOR_DUMMY(klass) \
779 wxConstructorBridge_Dummy constructor##klass ; \
780 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
781 const wxChar *klass::sm_constructorProperties##klass[] = { NULL } ; \
782 const int klass::sm_constructorPropertiesCount##klass = 0 ;
786 template<typename Class
, typename T0
>
787 struct wxConstructorBridge_1
: public wxConstructorBridge
789 void Create(wxObject
*o
, wxxVariant
*args
)
791 Class
*obj
= dynamic_cast<Class
*>(o
);
798 #define WX_CONSTRUCTOR_1(klass,t0,v0) \
799 wxConstructorBridge_1<klass,t0> constructor##klass ; \
800 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
801 const wxChar *klass::sm_constructorProperties##klass[] = { #v0 } ; \
802 const int klass::sm_constructorPropertiesCount##klass = 1 ;
806 template<typename Class
,
807 typename T0
, typename T1
>
808 struct wxConstructorBridge_2
: public wxConstructorBridge
810 void Create(wxObject
*o
, wxxVariant
*args
)
812 Class
*obj
= dynamic_cast<Class
*>(o
);
820 #define WX_CONSTRUCTOR_2(klass,t0,v0,t1,v1) \
821 wxConstructorBridge_2<klass,t0,t1> constructor##klass ; \
822 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
823 const wxChar *klass::sm_constructorProperties##klass[] = { #v0 , #v1 } ; \
824 const int klass::sm_constructorPropertiesCount##klass = 2;
828 template<typename Class
,
829 typename T0
, typename T1
, typename T2
>
830 struct wxConstructorBridge_3
: public wxConstructorBridge
832 void Create(wxObject
*o
, wxxVariant
*args
)
834 Class
*obj
= dynamic_cast<Class
*>(o
);
843 #define WX_CONSTRUCTOR_3(klass,t0,v0,t1,v1,t2,v2) \
844 wxConstructorBridge_3<klass,t0,t1,t2> constructor##klass ; \
845 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
846 const wxChar *klass::sm_constructorProperties##klass[] = { #v0 , #v1 , #v2 } ; \
847 const int klass::sm_constructorPropertiesCount##klass = 3 ;
851 template<typename Class
,
852 typename T0
, typename T1
, typename T2
, typename T3
>
853 struct wxConstructorBridge_4
: public wxConstructorBridge
855 void Create(wxObject
*o
, wxxVariant
*args
)
857 Class
*obj
= dynamic_cast<Class
*>(o
);
867 #define WX_CONSTRUCTOR_4(klass,t0,v0,t1,v1,t2,v2,t3,v3) \
868 wxConstructorBridge_4<klass,t0,t1,t2,t3> constructor##klass ; \
869 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
870 const wxChar *klass::sm_constructorProperties##klass[] = { #v0 , #v1 , #v2 , #v3 } ; \
871 const int klass::sm_constructorPropertiesCount##klass = 4 ;
875 template<typename Class
,
876 typename T0
, typename T1
, typename T2
, typename T3
, typename T4
>
877 struct wxConstructorBridge_5
: public wxConstructorBridge
879 void Create(wxObject
*o
, wxxVariant
*args
)
881 Class
*obj
= dynamic_cast<Class
*>(o
);
892 #define WX_CONSTRUCTOR_5(klass,t0,v0,t1,v1,t2,v2,t3,v3,t4,v4) \
893 wxConstructorBridge_5<klass,t0,t1,t2,t3,t4> constructor##klass ; \
894 wxConstructorBridge* klass::sm_constructor##klass = &constructor##klass ; \
895 const wxChar *klass::sm_constructorProperties##klass[] = { #v0 , #v1 , #v2 , #v3 , #v4 } ; \
896 const int klass::sm_constructorPropertiesCount##klass = 5;
898 // ----------------------------------------------------------------------------
900 // ----------------------------------------------------------------------------
902 typedef wxObject
*(*wxObjectConstructorFn
)(void);
903 typedef wxObject
* (*wxVariantToObjectConverter
)( const wxxVariant
&data
) ;
904 typedef wxxVariant (*wxObjectToVariantConverter
)( wxObject
* ) ;
906 class WXDLLIMPEXP_BASE wxClassInfo
909 wxClassInfo(const wxClassInfo
**_Parents
,
910 const wxChar
*_UnitName
,
911 const wxChar
*_ClassName
,
913 wxObjectConstructorFn ctor
,
914 const wxPropertyInfo
*_Props
,
915 const wxHandlerInfo
*_Handlers
,
916 wxConstructorBridge
* _Constructor
,
917 const wxChar
** _ConstructorProperties
,
918 const int _ConstructorPropertiesCount
,
919 wxVariantToObjectConverter _Converter1
,
920 wxObjectToVariantConverter _Converter2
921 ) : m_parents(_Parents
) , m_unitName(_UnitName
) ,m_className(_ClassName
),
922 m_objectSize(size
), m_objectConstructor(ctor
) , m_firstProperty(_Props
) , m_firstHandler(_Handlers
) , m_constructor( _Constructor
) ,
923 m_constructorProperties(_ConstructorProperties
) , m_constructorPropertiesCount(_ConstructorPropertiesCount
),
924 m_variantToObjectConverter( _Converter1
) , m_objectToVariantConverter( _Converter2
) , m_next(sm_first
)
927 Register( m_className
, this ) ;
932 wxObject
*CreateObject() { return m_objectConstructor
? (*m_objectConstructor
)() : 0; }
934 const wxChar
*GetClassName() const { return m_className
; }
935 const wxClassInfo
**GetParents() const { return m_parents
; }
936 int GetSize() const { return m_objectSize
; }
938 wxObjectConstructorFn
GetConstructor() const { return m_objectConstructor
; }
939 static const wxClassInfo
*GetFirst() { return sm_first
; }
940 const wxClassInfo
*GetNext() const { return m_next
; }
941 static wxClassInfo
*FindClass(const wxChar
*className
);
943 // Climb upwards through inheritance hierarchy.
944 // Dual inheritance is catered for.
946 bool IsKindOf(const wxClassInfo
*info
) const
953 for ( int i
= 0 ; m_parents
[i
] ; ++ i
)
955 if ( m_parents
[i
]->IsKindOf( info
) )
962 // Initializes parent pointers and hash table for fast searching.
963 // this is going to be removed by Register/Unregister calls
964 // in Constructor / Destructor together with making the hash map private
966 static void InitializeClasses();
968 // Cleans up hash table used for fast searching.
970 static void CleanUpClasses();
972 // returns the first property
973 const wxPropertyInfo
* GetFirstProperty() const { return m_firstProperty
; }
975 // returns the first handler
976 const wxHandlerInfo
* GetFirstHandler() const { return m_firstHandler
; }
978 // Call the Create method for a class
979 virtual void Create (wxObject
*object
, int ParamCount
, wxxVariant
*Params
)
981 wxASSERT_MSG( ParamCount
== m_constructorPropertiesCount
, wxT("Illegal Parameter Count for Create Method")) ;
982 m_constructor
->Create( object
, Params
) ;
985 // get number of parameters for constructor
986 virtual int GetCreateParamCount() const { return m_constructorPropertiesCount
; }
988 // get i-th constructor parameter
989 virtual const wxChar
* GetCreateParamName(int i
) const { return m_constructorProperties
[i
] ; }
991 // Runtime access to objects by property name, and variant data
992 virtual void SetProperty (wxObject
*object
, const wxChar
*PropertyName
, const wxxVariant
&Value
);
993 virtual wxxVariant
GetProperty (wxObject
*object
, const wxChar
*PropertyName
);
995 // we must be able to cast variants to wxObject pointers, templates seem not to be suitable
996 wxObject
* VariantToInstance( const wxxVariant
&data
) const { return m_variantToObjectConverter( data
) ; }
997 wxxVariant
InstanceToVariant( wxObject
*object
) const { return m_objectToVariantConverter( object
) ; }
999 // find property by name
1000 virtual const wxPropertyInfo
*FindPropertyInfo (const wxChar
*PropertyName
) const ;
1002 // find handler by name
1003 virtual const wxHandlerInfo
*FindHandlerInfo (const wxChar
*PropertyName
) const ;
1006 const wxChar
*m_className
;
1008 wxObjectConstructorFn m_objectConstructor
;
1010 // class info object live in a linked list:
1011 // pointers to its head and the next element in it
1013 static wxClassInfo
*sm_first
;
1014 wxClassInfo
*m_next
;
1016 // FIXME: this should be private (currently used directly by way too
1018 static wxHashTable
*sm_classTable
;
1021 const wxClassInfo
** m_parents
;
1022 const wxPropertyInfo
* m_firstProperty
;
1023 const wxHandlerInfo
* m_firstHandler
;
1024 const wxChar
* m_unitName
;
1026 wxConstructorBridge
* m_constructor
;
1027 const wxChar
** m_constructorProperties
;
1028 const int m_constructorPropertiesCount
;
1029 wxVariantToObjectConverter m_variantToObjectConverter
;
1030 wxObjectToVariantConverter m_objectToVariantConverter
;
1032 const wxPropertyAccessor
*FindAccessor (const wxChar
*propertyName
);
1034 // registers the class
1035 static void Register(const wxChar
*name
, wxClassInfo
*info
);
1037 static void Unregister(const wxChar
*name
);
1039 // InitializeClasses() helper
1040 static wxClassInfo
*GetBaseByName(const wxChar
*name
);
1042 DECLARE_NO_COPY_CLASS(wxClassInfo
)
1045 WXDLLIMPEXP_BASE wxObject
*wxCreateDynamicObject(const wxChar
*name
);
1047 // ----------------------------------------------------------------------------
1048 // Dynamic class macros
1049 // ----------------------------------------------------------------------------
1051 #define _DECLARE_DYNAMIC_CLASS(name) \
1053 static wxClassInfo sm_class##name; \
1054 static const wxClassInfo* sm_classParents##name[] ; \
1055 static const wxPropertyInfo* GetPropertiesStatic() ; \
1056 static const wxHandlerInfo* GetHandlersStatic() ; \
1057 virtual wxClassInfo *GetClassInfo() const \
1058 { return &name::sm_class##name; }
1060 #define DECLARE_DYNAMIC_CLASS(name) \
1061 _DECLARE_DYNAMIC_CLASS(name) \
1062 static wxConstructorBridge* sm_constructor##name ; \
1063 static const wxChar * sm_constructorProperties##name[] ; \
1064 static const int sm_constructorPropertiesCount##name ;
1066 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
1067 DECLARE_NO_ASSIGN_CLASS(name) \
1068 DECLARE_DYNAMIC_CLASS(name)
1070 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
1071 DECLARE_NO_COPY_CLASS(name) \
1072 DECLARE_DYNAMIC_CLASS(name)
1074 #define DECLARE_ABSTRACT_CLASS(name) _DECLARE_DYNAMIC_CLASS(name)
1075 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
1077 // -----------------------------------
1078 // for concrete classes
1079 // -----------------------------------
1081 // Single inheritance with one base class
1083 #define _IMPLEMENT_DYNAMIC_CLASS(name, basename, unit) \
1084 wxObject* wxConstructorFor##name() \
1085 { return new name; } \
1086 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1087 wxObject* wxVariantToObjectConverter##name ( const wxxVariant &data ) { return data.Get<name*>() ; } \
1088 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1089 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1090 (int) sizeof(name), \
1091 (wxObjectConstructorFn) wxConstructorFor##name , \
1092 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1093 name::sm_constructorPropertiesCount##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1094 template<> void wxStringReadValue(const wxString & , name * & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") ) ;}\
1095 template<> void wxStringWriteValue(wxString & , name* const & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1096 template<> const wxTypeInfo* wxGetTypeInfo( name ** ){ static wxClassTypeInfo s_typeInfo(&name::sm_class##name) ; return &s_typeInfo ; }
1098 #define IMPLEMENT_DYNAMIC_CLASS( name , basename ) \
1099 _IMPLEMENT_DYNAMIC_CLASS( name , basename , "" ) \
1100 const wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1101 const wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1102 WX_CONSTRUCTOR_DUMMY( name )
1104 #define IMPLEMENT_DYNAMIC_CLASS_XTI( name , basename , unit ) \
1105 _IMPLEMENT_DYNAMIC_CLASS( name , basename , unit )
1107 // this is for classes that do not derive from wxobject, there are no creators for these
1109 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_NO_BASE_XTI( name , unit ) \
1110 const wxClassInfo* name::sm_classParents##name[] = { NULL } ; \
1111 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1112 (int) sizeof(name), \
1113 (wxObjectConstructorFn) 0 , \
1114 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1116 template<> void wxStringReadValue(const wxString & , name * & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1117 template<> void wxStringWriteValue(wxString & , name* const & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1118 template<> const wxTypeInfo* wxGetTypeInfo( name ** ){ static wxClassTypeInfo s_typeInfo(&name::sm_class##name) ; return &s_typeInfo ; }
1120 // this is for subclasses that still do not derive from wxobject
1122 #define IMPLEMENT_DYNAMIC_CLASS_NO_WXOBJECT_XTI( name , basename, unit ) \
1123 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1124 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1125 (int) sizeof(name), \
1126 (wxObjectConstructorFn) 0 , \
1127 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1129 template<> void wxStringReadValue(const wxString & , name * & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1130 template<> void wxStringWriteValue(wxString & , name* const & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1131 template<> const wxTypeInfo* wxGetTypeInfo( name ** ){ static wxClassTypeInfo s_typeInfo(&name::sm_class##name) ; return &s_typeInfo ; }
1133 // Multiple inheritance with two base classes
1135 #define _IMPLEMENT_DYNAMIC_CLASS2(name, basename, basename2, unit) \
1136 wxObject* wxConstructorFor##name() \
1137 { return new name; } \
1138 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,&basename2::sm_class##basename2 , NULL } ; \
1139 wxObject* wxVariantToObjectConverter##name ( const wxxVariant &data ) { return data.Get<name*>() ; } \
1140 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1141 wxClassInfo name::sm_class##name(sm_classParents##name , wxT(unit) , wxT(#name), \
1142 (int) sizeof(name), \
1143 (wxObjectConstructorFn) wxConstructorFor##name , \
1144 name::GetPropertiesStatic(),name::GetHandlersStatic(),name::sm_constructor##name , name::sm_constructorProperties##name , \
1145 name::sm_constructorPropertiesCount##name , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1146 template<> void wxStringReadValue(const wxString & , name * & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1147 template<> void wxStringWriteValue(wxString & , name* const & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1148 template<> const wxTypeInfo* wxGetTypeInfo( name ** ){ static wxClassTypeInfo s_typeInfo(&name::sm_class##name) ; return &s_typeInfo ; }
1150 #define IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2) \
1151 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , "") \
1152 const wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; } \
1153 const wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1154 WX_CONSTRUCTOR_DUMMY( name )
1156 #define IMPLEMENT_DYNAMIC_CLASS2_XTI( name , basename , basename2, unit) \
1157 _IMPLEMENT_DYNAMIC_CLASS2( name , basename , basename2 , unit)
1159 // -----------------------------------
1160 // for abstract classes
1161 // -----------------------------------
1163 // Single inheritance with one base class
1165 #define _IMPLEMENT_ABSTRACT_CLASS(name, basename) \
1166 const wxClassInfo* name::sm_classParents##name[] = { &basename::sm_class##basename ,NULL } ; \
1167 wxObject* wxVariantToObjectConverter##name ( const wxxVariant &data ) { return data.Get<name*>() ; } \
1168 wxxVariant wxObjectToVariantConverter##name ( wxObject *data ) { return wxxVariant( dynamic_cast<name*> (data) ) ; } \
1169 wxClassInfo name::sm_class##name(sm_classParents##name , wxT("") , wxT(#name), \
1170 (int) sizeof(name), \
1171 (wxObjectConstructorFn) 0 , \
1172 name::GetPropertiesStatic(),name::GetHandlersStatic(),0 , 0 , \
1173 0 , wxVariantToObjectConverter##name , wxObjectToVariantConverter##name); \
1174 template<> void wxStringReadValue(const wxString & , name * & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1175 template<> void wxStringWriteValue(wxString & , name* const & ){wxASSERT_MSG( 0 , wxT("Illegal Spezialication Called") );}\
1176 template<> const wxTypeInfo* wxGetTypeInfo( name ** ){ static wxClassTypeInfo s_typeInfo(&name::sm_class##name) ; return &s_typeInfo ; }
1178 #define IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1179 _IMPLEMENT_ABSTRACT_CLASS( name , basename ) \
1180 const wxHandlerInfo *name::GetHandlersStatic() { return (wxHandlerInfo*) NULL ; } \
1181 const wxPropertyInfo *name::GetPropertiesStatic() { return (wxPropertyInfo*) NULL ; }
1183 // Multiple inheritance with two base classes
1185 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
1186 wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1), \
1187 wxT(#basename2), (int) sizeof(name), \
1188 (wxObjectConstructorFn) 0);
1190 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
1191 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2