comimpl.xsl@ 30522

Last change on this file since 30522 was 30521, checked in by vboxsync, 15 years ago
Main: veto event class, more events
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 17.1 KB

Line
1	<xsl:stylesheet version = '1.0'
2	xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
3	xmlns:vbox="http://www.virtualbox.org/"
4	xmlns:exsl="http://exslt.org/common"
5	extension-element-prefixes="exsl">
6
7	<!--
8
9	comimpl.xsl:
10	XSLT stylesheet that generates COM C++ classes implementing
11	interfaces described in VirtualBox.xidl.
12	For now we generate implementation for events, as they are
13	rather trivial container classes for their read-only attributes.
14	Further extension to other interfaces is possible and anticipated.
15
16	Copyright (C) 2010 Oracle Corporation
17
18	This file is part of VirtualBox Open Source Edition (OSE), as
19	available from http://www.virtualbox.org. This file is free software;
20	you can redistribute it and/or modify it under the terms of the GNU
21	General Public License (GPL) as published by the Free Software
22	Foundation, in version 2 as it comes in the "COPYING" file of the
23	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
24	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
25	-->
26
27	<xsl:output
28	method="text"
29	version="1.0"
30	encoding="utf-8"
31	indent="no"/>
32
33	<xsl:include href="../webservice/websrv-shared.inc.xsl" />
34
35	<!-- $G_kind contains what kind of COM class implementation we generate -->
36	<xsl:variable name="G_xsltFilename" select="'autogen.xsl'" />
37
38	<xsl:template name="fileheader">
39	<xsl:param name="name" />
40	<xsl:text>/**
41	* Copyright (C) 2010 Oracle Corporation
42	*
43	* This file is part of VirtualBox Open Source Edition (OSE), as
44	* available from http://www.virtualbox.org. This file is free software;
45	* you can redistribute it and/or modify it under the terms of the GNU
46	* General Public License (GPL) as published by the Free Software
47	* Foundation, in version 2 as it comes in the "COPYING" file of the
48	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
49	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
50	*
51	</xsl:text>
52	<xsl:value-of select="concat(' * ',$name)"/>
53	<xsl:text>
54	*
55	* DO NOT EDIT! This is a generated file.
56	* Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
57	* Generator: src/VBox/Main/idl/autogen.xsl
58	*/
59
60	</xsl:text>
61	</xsl:template>
62
63	<xsl:template name="genComEntry">
64	<xsl:param name="name" />
65	<xsl:variable name="extends">
66	<xsl:value-of select="//interface[@name=$name]/@extends" />
67	</xsl:variable>
68
69	<xsl:value-of select="concat(' COM_INTERFACE_ENTRY(', $name, ') ')" />
70	<xsl:choose>
71	<xsl:when test="$extends='$unknown'">
72	<xsl:value-of select=" ' COM_INTERFACE_ENTRY(IDispatch) '" />
73	</xsl:when>
74	<xsl:when test="//interface[@name=$extends]">
75	<xsl:call-template name="genComEntry">
76	<xsl:with-param name="name" select="$extends" />
77	</xsl:call-template>
78	</xsl:when>
79	<xsl:otherwise>
80	<xsl:call-template name="fatalError">
81	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $extends)" />
82	</xsl:call-template>
83	</xsl:otherwise>
84	</xsl:choose>
85	</xsl:template>
86
87	<xsl:template name="typeIdl2Back">
88	<xsl:param name="type" />
89	<xsl:param name="safearray" />
90	<xsl:param name="param" />
91	<xsl:param name="dir" />
92
93	<xsl:choose>
94	<xsl:when test="(($type='wstring') or ($type='uuid')) and ($param='yes')">
95	<xsl:value-of select="'BSTR'" />
96	</xsl:when>
97	<xsl:when test="(($type='wstring') or ($type='uuid')) and not($param='yes')">
98	<xsl:value-of select="'Bstr'" />
99	</xsl:when>
100	<xsl:when test="//enum[@name=$type]">
101	<xsl:value-of select="concat($type,'_T')"/>
102	</xsl:when>
103	<xsl:when test="//interface[@name=$type]">
104	<xsl:choose>
105	<xsl:when test="$param='no'">
106	<xsl:value-of select="concat('ComPtr<',$type,'>')"/>
107	</xsl:when>
108	<xsl:when test="$param='yes'">
109	<xsl:value-of select="concat($type,'*')"/>
110	</xsl:when>
111	</xsl:choose>
112	</xsl:when>
113	<xsl:when test="$type='boolean'">
114	<xsl:value-of select="'BOOL'" />
115	</xsl:when>
116	<xsl:when test="$type='unsigned long'">
117	<xsl:value-of select="'ULONG'" />
118	</xsl:when>
119	<xsl:when test="$type='long'">
120	<xsl:value-of select="'LONG'" />
121	</xsl:when>
122	<xsl:when test="$type='unsigned long long'">
123	<xsl:value-of select="'ULONG64'" />
124	</xsl:when>
125	<xsl:when test="$type='long long'">
126	<xsl:value-of select="'LONG64'" />
127	</xsl:when>
128	<xsl:otherwise>
129	<xsl:call-template name="fatalError">
130	<xsl:with-param name="msg" select="concat('Unhandled type: ', $type)" />
131	</xsl:call-template>
132	</xsl:otherwise>
133	</xsl:choose>
134
135	<xsl:if test="$dir='out'">
136	<xsl:value-of select="'*'"/>
137	</xsl:if>
138	</xsl:template>
139
140
141	<xsl:template name="genSetParam">
142	<xsl:param name="member"/>
143	<xsl:param name="param"/>
144	<xsl:param name="type"/>
145	<xsl:param name="safearray"/>
146
147	<xsl:value-of select="concat(' ', $member, ' = ', $param, '; ')"/>
148	</xsl:template>
149
150	<xsl:template name="genRetParam">
151	<xsl:param name="member"/>
152	<xsl:param name="param"/>
153	<xsl:param name="type"/>
154	<xsl:param name="safearray"/>
155	<xsl:choose>
156	<xsl:when test="($type='wstring') or ($type = 'uuid')">
157	<xsl:value-of select="concat(' ', $member, '.cloneTo(', $param, '); ')"/>
158	</xsl:when>
159	<xsl:when test="//interface[@name=$type]">
160	<xsl:value-of select="concat(' ', $member, '.queryInterfaceTo(', $param, '); ')"/>
161	</xsl:when>
162	<xsl:otherwise>
163	<xsl:value-of select="concat(' *', $param, ' = ', $member, '; ')"/>
164	</xsl:otherwise>
165	</xsl:choose>
166	</xsl:template>
167
168	<xsl:template name="genAttrInitCode">
169	<xsl:param name="name" />
170	<xsl:param name="obj" />
171	<xsl:variable name="extends">
172	<xsl:value-of select="//interface[@name=$name]/@extends" />
173	</xsl:variable>
174
175	<xsl:choose>
176	<xsl:when test="$extends='IEvent'">
177	</xsl:when>
178	<xsl:when test="//interface[@name=$extends]">
179	<xsl:call-template name="genAttrInitCode">
180	<xsl:with-param name="name" select="$extends" />
181	<xsl:with-param name="obj" select="$obj" />
182	</xsl:call-template>
183	</xsl:when>
184	<xsl:otherwise>
185	<xsl:call-template name="fatalError">
186	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
187	</xsl:call-template>
188	</xsl:otherwise>
189	</xsl:choose>
190
191
192	<xsl:for-each select="//interface[@name=$name]/attribute">
193	<xsl:variable name="aType">
194	<xsl:call-template name="typeIdl2Back">
195	<xsl:with-param name="type" select="@type" />
196	<xsl:with-param name="safearray" select="@safearray" />
197	<xsl:with-param name="param" select="'yes'" />
198	<xsl:with-param name="dir" select="'in'" />
199	</xsl:call-template>
200	</xsl:variable>
201
202	<xsl:value-of select="concat(' ',$aType, ' a_',@name,' = va_arg(args, ',$aType,'); ')"/>
203	<xsl:value-of select="concat(' ',$obj, '->set_', @name, '(a_', @name, '); ')"/>
204	</xsl:for-each>
205	</xsl:template>
206
207	<xsl:template name="genImplList">
208	<xsl:param name="impl" />
209	<xsl:param name="name" />
210	<xsl:param name="depth" />
211	<xsl:param name="parents" />
212
213	<xsl:variable name="extends">
214	<xsl:value-of select="//interface[@name=$name]/@extends" />
215	</xsl:variable>
216
217	<xsl:choose>
218	<xsl:when test="$extends='IEvent'">
219	<xsl:value-of select=" '#ifdef VBOX_WITH_XPCOM '" />
220	<xsl:value-of select="concat('NS_DECL_CLASSINFO(', $impl, ') ')" />
221	<xsl:value-of select="concat('NS_IMPL_THREADSAFE_ISUPPORTS',$depth,'_CI(', $impl, ', ', $name, $parents, ', IEvent) ')" />
222	<xsl:value-of select=" '#endif '"/>
223	</xsl:when>
224	<xsl:when test="//interface[@name=$extends]">
225	<xsl:call-template name="genImplList">
226	<xsl:with-param name="impl" select="$impl" />
227	<xsl:with-param name="name" select="$extends" />
228	<xsl:with-param name="depth" select="$depth+1" />
229	<xsl:with-param name="parents" select="concat($parents, ', ', @name)" />
230	</xsl:call-template>
231	</xsl:when>
232	<xsl:otherwise>
233	<xsl:call-template name="fatalError">
234	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
235	</xsl:call-template>
236	</xsl:otherwise>
237	</xsl:choose>
238	</xsl:template>
239
240	<xsl:template name="genAttrCode">
241	<xsl:param name="name" />
242	<xsl:param name="depth" />
243	<xsl:param name="parents" />
244
245	<xsl:variable name="extends">
246	<xsl:value-of select="//interface[@name=$name]/@extends" />
247	</xsl:variable>
248
249	<xsl:for-each select="//interface[@name=$name]/attribute">
250	<xsl:variable name="mName">
251	<xsl:value-of select="concat('m_', @name)" />
252	</xsl:variable>
253	<xsl:variable name="mType">
254	<xsl:call-template name="typeIdl2Back">
255	<xsl:with-param name="type" select="@type" />
256	<xsl:with-param name="safearray" select="@safearray" />
257	<xsl:with-param name="param" select="'no'" />
258	<xsl:with-param name="dir" select="'in'" />
259	</xsl:call-template>
260	</xsl:variable>
261	<xsl:variable name="pName">
262	<xsl:value-of select="concat('a_', @name)" />
263	</xsl:variable>
264	<xsl:variable name="pTypeOut">
265	<xsl:call-template name="typeIdl2Back">
266	<xsl:with-param name="type" select="@type" />
267	<xsl:with-param name="safearray" select="@safearray" />
268	<xsl:with-param name="param" select="'yes'" />
269	<xsl:with-param name="dir" select="'out'" />
270	</xsl:call-template>
271	</xsl:variable>
272	<xsl:variable name="pTypeIn">
273	<xsl:call-template name="typeIdl2Back">
274	<xsl:with-param name="type" select="@type" />
275	<xsl:with-param name="safearray" select="@safearray" />
276	<xsl:with-param name="param" select="'yes'" />
277	<xsl:with-param name="dir" select="'in'" />
278	</xsl:call-template>
279	</xsl:variable>
280	<xsl:variable name="capsName">
281	<xsl:call-template name="capitalize">
282	<xsl:with-param name="str" select="@name" />
283	</xsl:call-template>
284	</xsl:variable>
285	<xsl:value-of select=" ' '" />
286	<xsl:value-of select="concat(' // attribute ', @name,' ')" />
287	<xsl:value-of select=" 'private: '" />
288	<xsl:value-of select="concat(' ', $mType, ' ', $mName,'; ')" />
289	<xsl:value-of select=" 'public: '" />
290	<xsl:value-of select="concat(' STDMETHOD(COMGETTER(', $capsName,'))(',$pTypeOut, ' ', $pName,') { ')" />
291	<xsl:call-template name="genRetParam">
292	<xsl:with-param name="type" select="@type" />
293	<xsl:with-param name="member" select="$mName" />
294	<xsl:with-param name="param" select="$pName" />
295	<xsl:with-param name="safearray" select="@safearray" />
296	</xsl:call-template>
297	<xsl:value-of select=" ' return S_OK; '" />
298	<xsl:value-of select=" ' } '" />
299
300	<xsl:value-of select=" ' // purely internal setter '" />
301	<xsl:value-of select="concat(' int set_', @name,'(',$pTypeIn, ' ', $pName,') { ')" />
302	<xsl:call-template name="genSetParam">
303	<xsl:with-param name="type" select="@type" />
304	<xsl:with-param name="member" select="$mName" />
305	<xsl:with-param name="param" select="$pName" />
306	<xsl:with-param name="safearray" select="@safearray" />
307	</xsl:call-template>
308	<xsl:value-of select=" ' return S_OK; '" />
309	<xsl:value-of select=" ' } '" />
310	</xsl:for-each>
311
312	<xsl:choose>
313	<xsl:when test="$extends='IEvent'">
314	<xsl:value-of select=" ' // skipping IEvent attributes '" />
315	</xsl:when>
316	<xsl:when test="//interface[@name=$extends]">
317	<xsl:call-template name="genAttrCode">
318	<xsl:with-param name="name" select="$extends" />
319	<xsl:with-param name="depth" select="$depth+1" />
320	<xsl:with-param name="parents" select="concat($parents, ', ', @name)" />
321	</xsl:call-template>
322	</xsl:when>
323	<xsl:otherwise>
324	<xsl:call-template name="fatalError">
325	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $extends)" />
326	</xsl:call-template>
327	</xsl:otherwise>
328	</xsl:choose>
329	</xsl:template>
330
331	<xsl:template name="genEventImpl">
332	<xsl:param name="implName" />
333
334	<xsl:value-of select="concat('class ATL_NO_VTABLE ',$implName,
335	' : public VirtualBoxBase, VBOX_SCRIPTABLE_IMPL(',
336	@name, ') { ')" />
337	<xsl:value-of select="'public: '" />
338	<xsl:value-of select="concat(' DECLARE_NOT_AGGREGATABLE(', $implName, ') ')" />
339	<xsl:value-of select=" ' DECLARE_PROTECT_FINAL_CONSTRUCT() '" />
340	<xsl:value-of select="concat(' BEGIN_COM_MAP(', $implName, ') ')" />
341	<xsl:call-template name="genComEntry">
342	<xsl:with-param name="name" select="@name" />
343	</xsl:call-template>
344	<xsl:value-of select=" ' END_COM_MAP() '" />
345	<xsl:value-of select="concat(' ', $implName, '() {} ')" />
346	<xsl:value-of select="concat(' virtual ~', $implName, '() {} ')" />
347	<xsl:text><![CDATA[
348	HRESULT FinalConstruct()
349	{
350	return mEvent.createObject();
351	}
352	void FinalRelease() {
353	mEvent->FinalRelease();
354	}
355	STDMETHOD(COMGETTER(Type)) (VBoxEventType_T *aType)
356	{
357	return mEvent->COMGETTER(Type) (aType);
358	}
359	STDMETHOD(COMGETTER(Source)) (IEventSource * *aSource)
360	{
361	return mEvent->COMGETTER(Source) (aSource);
362	}
363	STDMETHOD(COMGETTER(Waitable)) (BOOL *aWaitable)
364	{
365	return mEvent->COMGETTER(Waitable) (aWaitable);
366	}
367	STDMETHOD(SetProcessed)()
368	{
369	return mEvent->SetProcessed();
370	}
371	STDMETHOD(WaitProcessed)(LONG aTimeout, BOOL *aResult)
372	{
373	return mEvent->WaitProcessed(aTimeout, aResult);
374	}
375	HRESULT init (IEventSource* aSource, VBoxEventType_T aType, BOOL aWaitable)
376	{
377	return mEvent->init(aSource, aType, aWaitable);
378	}
379	void uninit()
380	{
381	mEvent->uninit();
382	}
383	]]></xsl:text>
384	<xsl:value-of select=" 'private: '" />
385	<xsl:value-of select=" ' ComObjPtr<VBoxEvent> mEvent; '" />
386
387	<xsl:call-template name="genAttrCode">
388	<xsl:with-param name="name" select="@name" />
389	</xsl:call-template>
390	<xsl:value-of select="'}; '" />
391
392
393	<xsl:call-template name="genImplList">
394	<xsl:with-param name="impl" select="$implName" />
395	<xsl:with-param name="name" select="@name" />
396	<xsl:with-param name="depth" select="'2'" />
397	<xsl:with-param name="parents" select="''" />
398	</xsl:call-template>
399
400	</xsl:template>
401
402
403	<xsl:template name="genSwitchCase">
404	<xsl:param name="implName" />
405	<xsl:variable name="waitable">
406	<xsl:choose>
407	<xsl:when test="@waitable='yes'">
408	<xsl:value-of select="'TRUE'"/>
409	</xsl:when>
410	<xsl:otherwise>
411	<xsl:value-of select="'FALSE'"/>
412	</xsl:otherwise>
413	</xsl:choose>
414	</xsl:variable>
415	<xsl:value-of select="concat(' case VBoxEventType_', @id, ': ')"/>
416	<xsl:value-of select=" ' { '"/>
417	<xsl:value-of select="concat(' ComObjPtr<', $implName, '> obj; ')"/>
418	<xsl:value-of select=" ' obj.createObject(); '"/>
419	<xsl:value-of select="concat(' obj->init(source, aType, ', $waitable, '); ')"/>
420	<xsl:call-template name="genAttrInitCode">
421	<xsl:with-param name="name" select="@name" />
422	<xsl:with-param name="obj" select="'obj'" />
423	</xsl:call-template>
424	<xsl:value-of select=" ' obj.queryInterfaceTo(mEvent.asOutParam()); '"/>
425	<xsl:value-of select=" ' break; '"/>
426	<xsl:value-of select=" ' } '"/>
427	</xsl:template>
428
429	<xsl:template name="genCommonEventCode">
430	<xsl:text><![CDATA[
431	HRESULT VBoxEventDesc::init(IEventSource* source, VBoxEventType_T aType, ...)
432	{
433	va_list args;
434	va_start(args, aType);
435	switch (aType)
436	{
437	]]></xsl:text>
438
439	<xsl:for-each select="//interface[@autogen=$G_kind]">
440	<xsl:variable name="implName">
441	<xsl:value-of select="concat(@name,'Impl')" />
442	</xsl:variable>
443	<xsl:call-template name="genSwitchCase">
444	<xsl:with-param name="implName" select="$implName" />
445	</xsl:call-template>
446	</xsl:for-each>
447
448	<xsl:text><![CDATA[
449	default:
450	if (1) AssertFailed();
451	}
452	va_end(args);
453
454	return S_OK;
455	}
456	]]></xsl:text>
457
458	</xsl:template>
459
460
461	<xsl:template match="/">
462	<xsl:call-template name="fileheader">
463	<xsl:with-param name="name" select="'VBoxEvents.cpp'" />
464	</xsl:call-template>
465
466	<xsl:value-of select="'#include "EventImpl.h" '" />
467
468	<!-- Interfaces -->
469	<xsl:for-each select="//interface[@autogen=$G_kind]">
470	<xsl:value-of select="concat('// ', @name, ' implementation code ')" />
471	<xsl:variable name="implName">
472	<xsl:value-of select="concat(@name,'Impl')" />
473	</xsl:variable>
474
475	<xsl:choose>
476	<xsl:when test="$G_kind='VBoxEvent'">
477	<xsl:call-template name="genEventImpl">
478	<xsl:with-param name="implName" select="$implName" />
479	</xsl:call-template>
480	</xsl:when>
481	</xsl:choose>
482	</xsl:for-each>
483
484	<!-- Global code -->
485	<xsl:choose>
486	<xsl:when test="$G_kind='VBoxEvent'">
487	<xsl:call-template name="genCommonEventCode">
488	</xsl:call-template>
489	</xsl:when>
490	</xsl:choose>
491	</xsl:template>
492
493	</xsl:stylesheet>

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/idl/comimpl.xsl@ 30522

Download in other formats: