1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: streaming runtime metadata information (extended class info)
4 // Author: Stefan Csomor
8 // Copyright: (c) 2003 Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_XTISTRMH__
13 #define _WX_XTISTRMH__
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "xtistrm.h"
21 #if wxUSE_EXTENDED_RTTI
23 const int wxInvalidObjectID
= -2 ;
24 const int wxNullObjectID
= -1 ;
26 // Filer contains the interfaces for streaming objects in and out of XML,
27 // rendering them either to objects in memory, or to code. Note: We
28 // consider the process of generating code to be one of *depersisting* the
29 // object from xml, *not* of persisting the object to code from an object
30 // in memory. This distincation can be confusing, and should be kept
31 // in mind when looking at the property streamers and callback interfaces
35 Main interfaces for streaming out objects.
38 // ----------------------------------------------------------------------------
41 // This class will be asked during the streaming-out process about every single
42 // property or object instance. It can veto streaming out by returning false
43 // or modify the value before it is streamed-out.
44 // ----------------------------------------------------------------------------
52 // will be called before an object is written, may veto by returning false
53 virtual bool BeforeWriteObject( wxWriter
*WXUNUSED(writer
) , const wxObject
*WXUNUSED(object
) , const wxClassInfo
*WXUNUSED(classInfo
) ) { return true ; }
55 // will be called after this object has been written, may be needed for adjusting stacks
56 virtual void AfterWriteObject( wxWriter
*WXUNUSED(writer
) , const wxObject
*WXUNUSED(object
) , const wxClassInfo
*WXUNUSED(classInfo
) ) {}
58 // will be called before a property gets written, may change the value , eg replace a concrete wxSize by wxSize( -1 , -1 ) or veto
59 // writing that property at all by returning false
60 virtual bool BeforeWriteProperty( wxWriter
*WXUNUSED(writer
) , const wxPropertyInfo
*WXUNUSED(propInfo
) , wxxVariant
&WXUNUSED(value
) ) { return true ; }
62 // will be called before a property gets written, may change the value , eg replace a concrete wxSize by wxSize( -1 , -1 ) or veto
63 // writing that property at all by returning false
64 virtual bool BeforeWriteProperty( wxWriter
*WXUNUSED(writer
) , const wxPropertyInfo
*WXUNUSED(propInfo
) , wxxVariantArray
&WXUNUSED(value
) ) { return true ; }
66 // will be called after a property has been written out, may be needed for adjusting stacks
67 virtual void AfterWriteProperty( wxWriter
*WXUNUSED(writer
) , const wxPropertyInfo
*WXUNUSED(propInfo
) ) {}
69 // will be called before this delegate gets written
70 virtual bool BeforeWriteDelegate( wxWriter
*WXUNUSED(writer
) , const wxObject
*WXUNUSED(object
), const wxClassInfo
* WXUNUSED(classInfo
) , const wxPropertyInfo
*WXUNUSED(propInfo
) ,
71 const wxObject
*&WXUNUSED(eventSink
) , const wxHandlerInfo
* &WXUNUSED(handlerInfo
) ) { return true ; }
73 virtual void AfterWriteDelegate( wxWriter
*WXUNUSED(writer
) , const wxObject
*WXUNUSED(object
), const wxClassInfo
* WXUNUSED(classInfo
) , const wxPropertyInfo
*WXUNUSED(propInfo
) ,
74 const wxObject
*&WXUNUSED(eventSink
) , const wxHandlerInfo
* &WXUNUSED(handlerInfo
) ) { }
77 class wxWriter
: public wxObject
83 // with this call you start writing out a new top-level object
84 void WriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, wxPersister
*persister
, const wxString
&name
) ;
87 // Managing the object identity table a.k.a context
89 // these methods make sure that no object gets written twice, because sometimes multiple calls to the WriteObject will be
90 // made without wanting to have duplicate objects written, the object identity table will be reset manually
92 virtual void ClearObjectContext() ;
94 // gets the object Id for a passed in object in the context
95 int GetObjectID(const wxObject
*obj
) ;
97 // returns true if this object has already been written in this context
98 bool IsObjectKnown( const wxObject
*obj
) ;
101 // streaming callbacks
103 // these callbacks really write out the values in the stream format
105 // begins writing out a new toplevel entry which has the indicated unique name
106 virtual void DoBeginWriteTopLevelEntry( const wxString
&name
) = 0 ;
108 // ends writing out a new toplevel entry which has the indicated unique name
109 virtual void DoEndWriteTopLevelEntry( const wxString
&name
) = 0 ;
111 // start of writing an object having the passed in ID
112 virtual void DoBeginWriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, int objectID
) = 0 ;
114 // end of writing an toplevel object name param is used for unique identification within the container
115 virtual void DoEndWriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, int objectID
) = 0 ;
117 // writes a simple property in the stream format
118 virtual void DoWriteSimpleType( wxxVariant
&value
) = 0 ;
120 // start of writing a complex property into the stream (
121 virtual void DoBeginWriteProperty( const wxPropertyInfo
*propInfo
) = 0 ;
123 // end of writing a complex property into the stream
124 virtual void DoEndWriteProperty( const wxPropertyInfo
*propInfo
) = 0;
126 virtual void DoBeginWriteElement() = 0 ;
127 virtual void DoEndWriteElement() = 0 ;
128 // insert an object reference to an already written object
129 virtual void DoWriteRepeatedObject( int objectID
) = 0 ;
131 // insert a null reference
132 virtual void DoWriteNullObject() = 0 ;
134 // writes a delegate in the stream format
135 virtual void DoWriteDelegate( const wxObject
*object
, const wxClassInfo
* classInfo
, const wxPropertyInfo
*propInfo
,
136 const wxObject
*eventSink
, int sinkObjectID
, const wxClassInfo
* eventSinkClassInfo
, const wxHandlerInfo
* handlerIndo
) = 0;
139 struct wxWriterInternal
;
140 wxWriterInternal
* m_data
;
142 struct wxWriterInternalPropertiesData
;
144 void WriteAllProperties( const wxObject
* obj
, const wxClassInfo
* ci
, wxPersister
*persister
, wxWriterInternalPropertiesData
* data
) ;
145 void WriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, wxPersister
*persister
, bool isEmbedded
) ;
146 void FindConnectEntry(const wxWindow
* evSource
,const wxDelegateTypeInfo
* dti
, const wxObject
* &sink
, const wxHandlerInfo
*&handler
) ;
149 class wxXmlWriter
: public wxWriter
153 wxXmlWriter( wxXmlNode
* parent
) ;
157 // streaming callbacks
159 // these callbacks really write out the values in the stream format
163 // streaming callbacks
165 // these callbacks really write out the values in the stream format
167 // begins writing out a new toplevel entry which has the indicated unique name
168 virtual void DoBeginWriteTopLevelEntry( const wxString
&name
) ;
170 // ends writing out a new toplevel entry which has the indicated unique name
171 virtual void DoEndWriteTopLevelEntry( const wxString
&name
) ;
173 // start of writing an object having the passed in ID
174 virtual void DoBeginWriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, int objectID
) ;
176 // end of writing an toplevel object name param is used for unique identification within the container
177 virtual void DoEndWriteObject(const wxObject
*object
, const wxClassInfo
*classInfo
, int objectID
) ;
179 // writes a simple property in the stream format
180 virtual void DoWriteSimpleType( wxxVariant
&value
) ;
182 // start of writing a complex property into the stream (
183 virtual void DoBeginWriteProperty( const wxPropertyInfo
*propInfo
) ;
185 // end of writing a complex property into the stream
186 virtual void DoEndWriteProperty( const wxPropertyInfo
*propInfo
) ;
188 virtual void DoBeginWriteElement() ;
189 virtual void DoEndWriteElement() ;
191 // insert an object reference to an already written object
192 virtual void DoWriteRepeatedObject( int objectID
) ;
194 // insert a null reference
195 virtual void DoWriteNullObject() ;
197 // writes a delegate in the stream format
198 virtual void DoWriteDelegate( const wxObject
*object
, const wxClassInfo
* classInfo
, const wxPropertyInfo
*propInfo
,
199 const wxObject
*eventSink
, int sinkObjectID
, const wxClassInfo
* eventSinkClassInfo
, const wxHandlerInfo
* handlerIndo
) ;
201 struct wxXmlWriterInternal
;
202 wxXmlWriterInternal
* m_data
;
206 Streaming callbacks for depersisting XML to code, or running objects
209 class wxDepersister
;
212 wxReader handles streaming in a class from a arbitrary format. While walking through
213 it issues calls out to interfaces to depersist the guts from the underlying storage format.
216 class wxReader
: public wxObject
222 // the only thing wxReader knows about is the class info by object ID
223 wxClassInfo
*GetObjectClassInfo(int objectID
) ;
224 bool HasObjectClassInfo( int objectID
) ;
225 void SetObjectClassInfo(int objectID
, wxClassInfo
* classInfo
);
227 // Reads the component the reader is pointed at from the underlying format.
228 // The return value is the root object ID, which can
229 // then be used to ask the depersister about that object
230 virtual int ReadObject( const wxString
&name
, wxDepersister
*depersist
) = 0 ;
233 struct wxReaderInternal
;
234 wxReaderInternal
*m_data
;
238 wxXmlReader handles streaming in a class from XML
241 class wxXmlReader
: public wxReader
244 wxXmlReader(wxXmlNode
*parent
) { m_parent
= parent
; }
247 // Reads a component from XML. The return value is the root object ID, which can
248 // then be used to ask the depersister about that object
250 virtual int ReadObject( const wxString
&name
, wxDepersister
*depersist
) ;
253 int ReadComponent(wxXmlNode
*parent
, wxDepersister
*callbacks
);
255 // accessor is only used as a temporary measure
256 wxxVariant
ReadValue(wxXmlNode
*Node
,
257 wxPropertyAccessor
*accessor
);
259 wxXmlNode
* m_parent
;
262 // This abstract class matches the allocate-init/create model of creation of objects.
263 // At runtime, these will create actual instances, and manipulate them.
264 // When generating code, these will just create statements of C++
265 // code to create the objects.
270 // allocate the new object on the heap, that object will have the passed in ID
271 virtual void AllocateObject(int ObjectID
, wxClassInfo
*ClassInfo
) = 0;
273 // initialize the already allocated object having the ID ObjectID with the Create method
274 // creation parameters which are objects are having their Ids passed in objectIDValues
275 // having objectId <> wxInvalidObjectID
277 virtual void CreateObject(int ObjectID
,
278 const wxClassInfo
*ClassInfo
,
280 wxxVariant
*VariantValues
,
281 int *objectIDValues
,
282 const wxClassInfo
**objectClassInfos
285 // destroy the heap-allocated object having the ID ObjectID, this may be used if an object
286 // is embedded in another object and set via value semantics, so the intermediate
287 // object can be destroyed after safely
288 virtual void DestroyObject(int ObjectID
, wxClassInfo
*ClassInfo
) = 0;
290 // set the corresponding property
291 virtual void SetProperty(int ObjectID
,
292 const wxClassInfo
*ClassInfo
,
293 const wxPropertyInfo
* PropertyInfo
,
294 const wxxVariant
&VariantValue
) = 0;
296 // sets the corresponding property (value is an object)
297 virtual void SetPropertyAsObject(int ObjectId
,
298 const wxClassInfo
*ClassInfo
,
299 const wxPropertyInfo
* PropertyInfo
,
300 int valueObjectId
) = 0;
303 // sets the corresponding event handler
304 virtual void SetConnect(int EventSourceObjectID
,
305 const wxClassInfo
*EventSourceClassInfo
,
306 const wxDelegateTypeInfo
*delegateInfo
,
307 const wxClassInfo
*EventSinkClassInfo
,
308 const wxHandlerInfo
* handlerInfo
,
309 int EventSinkObjectID
) = 0;
313 wxRuntimeDepersister implements the callbacks that will depersist
314 an object into a running memory image, as opposed to writing
315 C++ initialization code to bring the object to life.
317 class wxRuntimeDepersister
: public wxDepersister
319 struct wxRuntimeDepersisterInternal
;
320 wxRuntimeDepersisterInternal
* m_data
;
322 wxRuntimeDepersister() ;
323 ~wxRuntimeDepersister() ;
325 // returns the object having the corresponding ID fully constructed
326 wxObject
*GetObject(int objectID
) ;
328 // allocate the new object on the heap, that object will have the passed in ID
329 virtual void AllocateObject(int objectID
, wxClassInfo
*classInfo
) ;
331 // initialize the already allocated object having the ID ObjectID with the Create method
332 // creation parameters which are objects are having their Ids passed in objectIDValues
333 // having objectId <> wxInvalidObjectID
335 virtual void CreateObject(int ObjectID
,
336 const wxClassInfo
*ClassInfo
,
338 wxxVariant
*VariantValues
,
340 const wxClassInfo
**objectClassInfos
343 // destroy the heap-allocated object having the ID ObjectID, this may be used if an object
344 // is embedded in another object and set via value semantics, so the intermediate
345 // object can be destroyed after safely
346 virtual void DestroyObject(int objectID
, wxClassInfo
*classInfo
) ;
348 // set the corresponding property
349 virtual void SetProperty(int objectID
,
350 const wxClassInfo
*classInfo
,
351 const wxPropertyInfo
* propertyInfo
,
352 const wxxVariant
&variantValue
);
354 // sets the corresponding property (value is an object)
355 virtual void SetPropertyAsObject(int objectId
,
356 const wxClassInfo
*classInfo
,
357 const wxPropertyInfo
* propertyInfo
,
361 // sets the corresponding event handler
362 virtual void SetConnect(int eventSourceObjectID
,
363 const wxClassInfo
*eventSourceClassInfo
,
364 const wxDelegateTypeInfo
*delegateInfo
,
365 const wxClassInfo
*eventSinkClassInfo
,
366 const wxHandlerInfo
* handlerInfo
,
367 int eventSinkObjectID
) ;
371 wxDepersisterCode implements the callbacks that will depersist
372 an object into a C++ initialization function.
375 class wxTextOutputStream
;
377 class wxCodeDepersister
: public wxDepersister
380 struct wxCodeDepersisterInternal
;
381 wxCodeDepersisterInternal
* m_data
;
382 wxTextOutputStream
*m_fp
;
383 wxString
ValueAsCode( const wxxVariant
¶m
) ;
385 wxCodeDepersister(wxTextOutputStream
*out
) ;
386 ~wxCodeDepersister() ;
388 // allocate the new object on the heap, that object will have the passed in ID
389 virtual void AllocateObject(int objectID
, wxClassInfo
*classInfo
) ;
391 // initialize the already allocated object having the ID ObjectID with the Create method
392 // creation parameters which are objects are having their Ids passed in objectIDValues
393 // having objectId <> wxInvalidObjectID
395 virtual void CreateObject(int objectID
,
396 const wxClassInfo
*classInfo
,
398 wxxVariant
*variantValues
,
400 const wxClassInfo
**objectClassInfos
403 // destroy the heap-allocated object having the ID ObjectID, this may be used if an object
404 // is embedded in another object and set via value semantics, so the intermediate
405 // object can be destroyed after safely
406 virtual void DestroyObject(int objectID
, wxClassInfo
*classInfo
) ;
408 // set the corresponding property
409 virtual void SetProperty(int objectID
,
410 const wxClassInfo
*classInfo
,
411 const wxPropertyInfo
* propertyInfo
,
412 const wxxVariant
&variantValue
);
414 // sets the corresponding property (value is an object)
415 virtual void SetPropertyAsObject(int objectId
,
416 const wxClassInfo
*classInfo
,
417 const wxPropertyInfo
* propertyInfo
,
421 // sets the corresponding event handler
422 virtual void SetConnect(int eventSourceObjectID
,
423 const wxClassInfo
*eventSourceClassInfo
,
424 const wxDelegateTypeInfo
*delegateInfo
,
425 const wxClassInfo
*eventSinkClassInfo
,
426 const wxHandlerInfo
* handlerInfo
,
427 int eventSinkObjectID
) ;
430 #endif // wxUSE_EXTENDED_RTTI