comimpl.xsl@ 56328

Last change on this file since 56328 was 56328, checked in by vboxsync, 9 years ago
(c) in generated headers
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 32.7 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-2015 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="typemap-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
39	<!-- - - - - - - - - - - - - - - - - - - - - - -
40	Keys for more efficiently looking up of types.
41	- - - - - - - - - - - - - - - - - - - - - - -->
42
43	<xsl:key name="G_keyEnumsByName" match="//enum[@name]" use="@name"/>
44	<xsl:key name="G_keyInterfacesByName" match="//interface[@name]" use="@name"/>
45
46	<!-- - - - - - - - - - - - - - - - - - - - - - -
47	- - - - - - - - - - - - - - - - - - - - - - -->
48
49	<xsl:template name="fileheader">
50	<xsl:param name="name" />
51	<xsl:text>/** @file </xsl:text>
52	<xsl:value-of select="$name"/>
53	<xsl:text>
54	* DO NOT EDIT! This is a generated file.
55	* Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
56	* Generator: src/VBox/Main/idl/comimpl.xsl
57	*/
58
59	/*
60	* Copyright (C) 2010-2015 Oracle Corporation
61	*
62	* This file is part of VirtualBox Open Source Edition (OSE), as
63	* available from http://www.virtualbox.org. This file is free software;
64	* you can redistribute it and/or modify it under the terms of the GNU
65	* General Public License (GPL) as published by the Free Software
66	* Foundation, in version 2 as it comes in the "COPYING" file of the
67	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
68	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
69	*/
70
71	</xsl:text>
72	</xsl:template>
73
74	<xsl:template name="genComEntry">
75	<xsl:param name="name" />
76	<xsl:variable name="extends">
77	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
78	</xsl:variable>
79
80	<xsl:value-of select="concat(' COM_INTERFACE_ENTRY(', $name, ') ')" />
81	<xsl:choose>
82	<xsl:when test="$extends='$unknown'">
83	<!-- Reached base -->
84	</xsl:when>
85	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
86	<xsl:call-template name="genComEntry">
87	<xsl:with-param name="name" select="$extends" />
88	</xsl:call-template>
89	</xsl:when>
90	<xsl:otherwise>
91	<xsl:call-template name="fatalError">
92	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $extends)" />
93	</xsl:call-template>
94	</xsl:otherwise>
95	</xsl:choose>
96	</xsl:template>
97
98	<xsl:template name="typeIdl2Back">
99	<xsl:param name="type" />
100	<xsl:param name="safearray" />
101	<xsl:param name="param" />
102	<xsl:param name="dir" />
103	<xsl:param name="mod" />
104
105	<xsl:choose>
106	<xsl:when test="$safearray='yes'">
107	<xsl:variable name="elemtype">
108	<xsl:call-template name="typeIdl2Back">
109	<xsl:with-param name="type" select="$type" />
110	<xsl:with-param name="safearray" select="''" />
111	<xsl:with-param name="dir" select="'in'" />
112	</xsl:call-template>
113	</xsl:variable>
114	<xsl:choose>
115	<xsl:when test="$param and ($dir='in')">
116	<xsl:value-of select="concat('ComSafeArrayIn(',$elemtype,',', $param,')')"/>
117	</xsl:when>
118	<xsl:when test="$param and ($dir='out')">
119	<xsl:value-of select="concat('ComSafeArrayOut(',$elemtype,', ', $param, ')')"/>
120	</xsl:when>
121	<xsl:otherwise>
122	<xsl:value-of select="concat('com::SafeArray<',$elemtype,'>')"/>
123	</xsl:otherwise>
124	</xsl:choose>
125	</xsl:when>
126	<xsl:otherwise>
127	<xsl:choose>
128	<xsl:when test="$mod='ptr'">
129	<xsl:value-of select="'BYTE*'" />
130	</xsl:when>
131	<xsl:when test="(($type='wstring') or ($type='uuid'))">
132	<xsl:choose>
133	<xsl:when test="$param and ($dir='in')">
134	<xsl:value-of select="'CBSTR'"/>
135	</xsl:when>
136	<xsl:when test="$param and ($dir='out')">
137	<xsl:value-of select="'BSTR'"/>
138	</xsl:when>
139	<xsl:otherwise>
140	<xsl:value-of select="'Bstr'"/>
141	</xsl:otherwise>
142	</xsl:choose>
143	</xsl:when>
144	<xsl:when test="count(key('G_keyEnumsByName', $type)) > 0">
145	<xsl:value-of select="concat($type,'_T')"/>
146	</xsl:when>
147	<xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
148	<xsl:choose>
149	<xsl:when test="$param">
150	<xsl:value-of select="concat($type,'*')"/>
151	</xsl:when>
152	<xsl:otherwise>
153	<xsl:value-of select="concat('ComPtr<',$type,'>')"/>
154	</xsl:otherwise>
155	</xsl:choose>
156	</xsl:when>
157	<xsl:when test="$type='boolean'">
158	<xsl:value-of select="'BOOL'" />
159	</xsl:when>
160	<xsl:when test="$type='octet'">
161	<xsl:value-of select="'BYTE'" />
162	</xsl:when>
163	<xsl:when test="$type='unsigned short'">
164	<xsl:value-of select="'USHORT'" />
165	</xsl:when>
166	<xsl:when test="$type='short'">
167	<xsl:value-of select="'SHORT'" />
168	</xsl:when>
169	<xsl:when test="$type='unsigned long'">
170	<xsl:value-of select="'ULONG'" />
171	</xsl:when>
172	<xsl:when test="$type='long'">
173	<xsl:value-of select="'LONG'" />
174	</xsl:when>
175	<xsl:when test="$type='unsigned long long'">
176	<xsl:value-of select="'ULONG64'" />
177	</xsl:when>
178	<xsl:when test="$type='long long'">
179	<xsl:value-of select="'LONG64'" />
180	</xsl:when>
181	<xsl:otherwise>
182	<xsl:call-template name="fatalError">
183	<xsl:with-param name="msg" select="concat('Unhandled type: ', $type)" />
184	</xsl:call-template>
185	</xsl:otherwise>
186	</xsl:choose>
187	<xsl:if test="$dir='out'">
188	<xsl:value-of select="'*'"/>
189	</xsl:if>
190	<xsl:if test="$param and not($param='_')">
191	<xsl:value-of select="concat(' ', $param)"/>
192	</xsl:if>
193	</xsl:otherwise>
194	</xsl:choose>
195
196	</xsl:template>
197
198
199	<xsl:template name="genSetParam">
200	<xsl:param name="member"/>
201	<xsl:param name="param"/>
202	<xsl:param name="type"/>
203	<xsl:param name="safearray"/>
204
205	<xsl:choose>
206	<xsl:when test="$safearray='yes'">
207	<xsl:variable name="elemtype">
208	<xsl:call-template name="typeIdl2Back">
209	<xsl:with-param name="type" select="$type" />
210	<xsl:with-param name="safearray" select="''" />
211	<xsl:with-param name="dir" select="'in'" />
212	</xsl:call-template>
213	</xsl:variable>
214	<xsl:value-of select="concat(' SafeArray<', $elemtype, '> aArr(ComSafeArrayInArg(',$param,')); ')"/>
215	<xsl:value-of select="concat(' ',$member, '.initFrom(aArr); ')"/>
216	</xsl:when>
217	<xsl:otherwise>
218	<xsl:value-of select="concat(' ', $member, ' = ', $param, '; ')"/>
219	</xsl:otherwise>
220	</xsl:choose>
221	</xsl:template>
222
223	<xsl:template name="genRetParam">
224	<xsl:param name="member"/>
225	<xsl:param name="param"/>
226	<xsl:param name="type"/>
227	<xsl:param name="safearray"/>
228	<xsl:choose>
229	<xsl:when test="$safearray='yes'">
230	<xsl:variable name="elemtype">
231	<xsl:call-template name="typeIdl2Back">
232	<xsl:with-param name="type" select="$type" />
233	<xsl:with-param name="safearray" select="''" />
234	<xsl:with-param name="dir" select="'in'" />
235	</xsl:call-template>
236	</xsl:variable>
237	<xsl:value-of select="concat(' SafeArray<', $elemtype,'> result; ')"/>
238	<xsl:value-of select="concat(' ', $member, '.cloneTo(result); ')"/>
239	<xsl:value-of select="concat(' result.detachTo(ComSafeArrayOutArg(', $param, ')); ')"/>
240	</xsl:when>
241	<xsl:otherwise>
242	<xsl:choose>
243	<xsl:when test="($type='wstring') or ($type = 'uuid')">
244	<xsl:value-of select="concat(' ', $member, '.cloneTo(', $param, '); ')"/>
245	</xsl:when>
246	<xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
247	<xsl:value-of select="concat(' ', $member, '.queryInterfaceTo(', $param, '); ')"/>
248	</xsl:when>
249	<xsl:otherwise>
250	<xsl:value-of select="concat(' *', $param, ' = ', $member, '; ')"/>
251	</xsl:otherwise>
252	</xsl:choose>
253	</xsl:otherwise>
254	</xsl:choose>
255	</xsl:template>
256
257	<xsl:template name="genAttrInitCode">
258	<xsl:param name="name" />
259	<xsl:param name="obj" />
260	<xsl:variable name="extends">
261	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
262	</xsl:variable>
263
264	<xsl:choose>
265	<xsl:when test="$extends='IEvent'">
266	</xsl:when>
267	<xsl:when test="$extends='IReusableEvent'">
268	</xsl:when>
269	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
270	<xsl:call-template name="genAttrInitCode">
271	<xsl:with-param name="name" select="$extends" />
272	<xsl:with-param name="obj" select="$obj" />
273	</xsl:call-template>
274	</xsl:when>
275	<xsl:otherwise>
276	<xsl:call-template name="fatalError">
277	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
278	</xsl:call-template>
279	</xsl:otherwise>
280	</xsl:choose>
281
282	<xsl:for-each select="key('G_keyInterfacesByName', $name)/attribute[@name != 'midlDoesNotLikeEmptyInterfaces']">
283	<xsl:variable name="aName" select="concat('a_',@name)"/>
284	<xsl:variable name="aTypeName">
285	<xsl:call-template name="typeIdl2Back">
286	<xsl:with-param name="type" select="@type" />
287	<xsl:with-param name="safearray" select="@safearray" />
288	<xsl:with-param name="param" select="$aName" />
289	<xsl:with-param name="dir" select="'in'" />
290	<xsl:with-param name="mod" select="@mod" />
291	</xsl:call-template>
292	</xsl:variable>
293	<xsl:variable name="aType">
294	<xsl:call-template name="typeIdl2Back">
295	<xsl:with-param name="type" select="@type" />
296	<xsl:with-param name="safearray" select="@safearray" />
297	<xsl:with-param name="param" select="'_'" />
298	<xsl:with-param name="dir" select="'in'" />
299	<xsl:with-param name="mod" select="@mod" />
300	</xsl:call-template>
301	</xsl:variable>
302
303	<xsl:choose>
304	<xsl:when test="@safearray='yes'">
305	<xsl:variable name="elemtype">
306	<xsl:call-template name="typeIdl2Back">
307	<xsl:with-param name="type" select="@type" />
308	<xsl:with-param name="safearray" select="''" />
309	<xsl:with-param name="dir" select="'in'" />
310	</xsl:call-template>
311	</xsl:variable>
312	<xsl:value-of select=" '#ifdef RT_OS_WINDOWS '"/>
313	<xsl:value-of select="concat(' SAFEARRAY aPtr_', @name, ' = va_arg(args, SAFEARRAY ); ')"/>
314	<xsl:value-of select="concat(' com::SafeArray<', $elemtype,'> aArr_', @name, '(aPtr_', @name, '); ')"/>
315	<xsl:value-of select=" '#else '"/>
316	<xsl:value-of select="concat(' PRUint32 aArrSize_', @name, ' = va_arg(args, PRUint32); ')"/>
317	<xsl:value-of select="concat(' void* aPtr_', @name, ' = va_arg(args, void*); ')"/>
318	<xsl:value-of select="concat(' com::SafeArray<', $elemtype,'> aArr_', @name, '(aArrSize_', @name, ', (', $elemtype,'*)aPtr_', @name, '); ')"/>
319	<xsl:value-of select=" '#endif '"/>
320	<xsl:value-of select="concat(' ',$obj, '->set_', @name, '(ComSafeArrayAsInParam(aArr_', @name, ')); ')"/>
321	</xsl:when>
322	<xsl:otherwise>
323	<xsl:value-of select="concat(' ',$aTypeName, ' = va_arg(args, ',$aType,'); ')"/>
324	<xsl:value-of select="concat(' ',$obj, '->set_', @name, '(',$aName, '); ')"/>
325	</xsl:otherwise>
326	</xsl:choose>
327	</xsl:for-each>
328	</xsl:template>
329
330	<xsl:template name="genImplList">
331	<xsl:param name="impl" />
332	<xsl:param name="name" />
333	<xsl:param name="depth" />
334	<xsl:param name="parents" />
335
336	<xsl:variable name="extends">
337	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
338	</xsl:variable>
339
340	<xsl:choose>
341	<xsl:when test="$name='IEvent'">
342	<xsl:value-of select=" '#ifdef VBOX_WITH_XPCOM '" />
343	<xsl:value-of select="concat('NS_DECL_CLASSINFO(', $impl, ') ')" />
344	<xsl:value-of select="concat('NS_IMPL_THREADSAFE_ISUPPORTS',$depth,'_CI(', $impl, $parents, ', IEvent) ')" />
345	<xsl:value-of select=" '#endif '"/>
346	</xsl:when>
347	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
348	<xsl:call-template name="genImplList">
349	<xsl:with-param name="impl" select="$impl" />
350	<xsl:with-param name="name" select="$extends" />
351	<xsl:with-param name="depth" select="$depth+1" />
352	<xsl:with-param name="parents" select="concat($parents, ', ', $name)" />
353	</xsl:call-template>
354	</xsl:when>
355	<xsl:otherwise>
356	<xsl:call-template name="fatalError">
357	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
358	</xsl:call-template>
359	</xsl:otherwise>
360	</xsl:choose>
361	</xsl:template>
362
363	<xsl:template name="genAttrCode">
364	<xsl:param name="name" />
365	<xsl:param name="depth" />
366	<xsl:param name="parents" />
367
368	<xsl:variable name="extends">
369	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
370	</xsl:variable>
371
372	<xsl:for-each select="key('G_keyInterfacesByName', $name)/attribute">
373	<xsl:variable name="mName">
374	<xsl:value-of select="concat('m_', @name)" />
375	</xsl:variable>
376	<xsl:variable name="mType">
377	<xsl:call-template name="typeIdl2Back">
378	<xsl:with-param name="type" select="@type" />
379	<xsl:with-param name="safearray" select="@safearray" />
380	<xsl:with-param name="dir" select="'in'" />
381	<xsl:with-param name="mod" select="@mod" />
382	</xsl:call-template>
383	</xsl:variable>
384	<xsl:variable name="pName">
385	<xsl:value-of select="concat('a_', @name)" />
386	</xsl:variable>
387	<xsl:variable name="pTypeNameOut">
388	<xsl:call-template name="typeIdl2Back">
389	<xsl:with-param name="type" select="@type" />
390	<xsl:with-param name="safearray" select="@safearray" />
391	<xsl:with-param name="param" select="$pName" />
392	<xsl:with-param name="dir" select="'out'" />
393	<xsl:with-param name="mod" select="@mod" />
394	</xsl:call-template>
395	</xsl:variable>
396
397	<xsl:variable name="pTypeNameIn">
398	<xsl:call-template name="typeIdl2Back">
399	<xsl:with-param name="type" select="@type" />
400	<xsl:with-param name="safearray" select="@safearray" />
401	<xsl:with-param name="param" select="$pName" />
402	<xsl:with-param name="dir" select="'in'" />
403	<xsl:with-param name="mod" select="@mod" />
404	</xsl:call-template>
405	</xsl:variable>
406
407	<xsl:variable name="capsName">
408	<xsl:call-template name="capitalize">
409	<xsl:with-param name="str" select="@name" />
410	</xsl:call-template>
411	</xsl:variable>
412
413	<xsl:value-of select=" ' '" />
414	<xsl:value-of select="concat(' // attribute ', @name,' ')" />
415	<xsl:value-of select=" 'private: '" />
416	<xsl:value-of select="concat(' ', $mType, ' ', $mName,'; ')" />
417	<xsl:value-of select=" 'public: '" />
418	<xsl:value-of select="concat(' STDMETHOD(COMGETTER(', $capsName,'))(',$pTypeNameOut,') { ')" />
419	<xsl:call-template name="genRetParam">
420	<xsl:with-param name="type" select="@type" />
421	<xsl:with-param name="member" select="$mName" />
422	<xsl:with-param name="param" select="$pName" />
423	<xsl:with-param name="safearray" select="@safearray" />
424	</xsl:call-template>
425	<xsl:value-of select=" ' return S_OK; '" />
426	<xsl:value-of select=" ' } '" />
427
428	<xsl:if test="not(@readonly='yes')">
429	<xsl:value-of select="concat(' STDMETHOD(COMSETTER(', $capsName,'))(',$pTypeNameIn,') { ')" />
430	<xsl:call-template name="genSetParam">
431	<xsl:with-param name="type" select="@type" />
432	<xsl:with-param name="member" select="$mName" />
433	<xsl:with-param name="param" select="$pName" />
434	<xsl:with-param name="safearray" select="@safearray" />
435	</xsl:call-template>
436	<xsl:value-of select=" ' return S_OK; '" />
437	<xsl:value-of select=" ' } '" />
438	</xsl:if>
439
440	<xsl:value-of select=" ' // purely internal setter '" />
441	<xsl:value-of select="concat(' HRESULT set_', @name,'(',$pTypeNameIn, ') { ')" />
442	<xsl:call-template name="genSetParam">
443	<xsl:with-param name="type" select="@type" />
444	<xsl:with-param name="member" select="$mName" />
445	<xsl:with-param name="param" select="$pName" />
446	<xsl:with-param name="safearray" select="@safearray" />
447	</xsl:call-template>
448	<xsl:value-of select=" ' return S_OK; '" />
449	<xsl:value-of select=" ' } '" />
450	</xsl:for-each>
451
452	<xsl:choose>
453	<xsl:when test="$extends='IEvent'">
454	<xsl:value-of select=" ' // skipping IEvent attributes '" />
455	</xsl:when>
456	<xsl:when test="$extends='IReusableEvent'">
457	<xsl:value-of select=" ' // skipping IReusableEvent attributes '" />
458	</xsl:when>
459	<xsl:when test="$extends='IVetoEvent'">
460	<xsl:value-of select=" ' // skipping IVetoEvent attributes '" />
461	</xsl:when>
462	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
463	<xsl:call-template name="genAttrCode">
464	<xsl:with-param name="name" select="$extends" />
465	<xsl:with-param name="depth" select="$depth+1" />
466	<xsl:with-param name="parents" select="concat($parents, ', ', @name)" />
467	</xsl:call-template>
468	</xsl:when>
469	<xsl:otherwise>
470	<xsl:call-template name="fatalError">
471	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $extends)" />
472	</xsl:call-template>
473	</xsl:otherwise>
474	</xsl:choose>
475	</xsl:template>
476
477	<xsl:template name="genEventImpl">
478	<xsl:param name="implName" />
479	<xsl:param name="isVeto" />
480	<xsl:param name="isReusable" />
481
482	<xsl:value-of select="concat('class ATL_NO_VTABLE ',$implName,
483	' : public VirtualBoxBase, VBOX_SCRIPTABLE_IMPL(',
484	@name, ') { ')" />
485	<xsl:value-of select="'public: '" />
486	<xsl:value-of select="concat(' VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(', $implName, ', ', @name, ') ')" />
487	<xsl:value-of select="concat(' DECLARE_NOT_AGGREGATABLE(', $implName, ') ')" />
488	<xsl:value-of select=" ' DECLARE_PROTECT_FINAL_CONSTRUCT() '" />
489	<xsl:value-of select="concat(' BEGIN_COM_MAP(', $implName, ') ')" />
490	<xsl:value-of select="concat(' VBOX_DEFAULT_INTERFACE_ENTRIES(', @name, ') ')" />
491
492	<xsl:call-template name="genComEntry">
493	<xsl:with-param name="name" select="@name" />
494	</xsl:call-template>
495	<xsl:value-of select=" ' END_COM_MAP() '" />
496	<xsl:value-of select="concat(' ',$implName,'() { /printf("',$implName,'\n")/;} ')" />
497	<xsl:value-of select="concat(' virtual ~',$implName,'() { /printf("~',$implName,'\n")/; uninit(); } ')" />
498	<xsl:text><![CDATA[
499	HRESULT FinalConstruct()
500	{
501	BaseFinalConstruct();
502	return mEvent.createObject();
503	}
504	void FinalRelease()
505	{
506	mEvent->FinalRelease();
507	BaseFinalRelease();
508	}
509	STDMETHOD(COMGETTER(Type))(VBoxEventType_T *aType)
510	{
511	return mEvent->COMGETTER(Type)(aType);
512	}
513	STDMETHOD(COMGETTER(Source))(IEventSource * *aSource)
514	{
515	return mEvent->COMGETTER(Source)(aSource);
516	}
517	STDMETHOD(COMGETTER(Waitable))(BOOL *aWaitable)
518	{
519	return mEvent->COMGETTER(Waitable)(aWaitable);
520	}
521	STDMETHOD(SetProcessed)()
522	{
523	return mEvent->SetProcessed();
524	}
525	STDMETHOD(WaitProcessed)(LONG aTimeout, BOOL *aResult)
526	{
527	return mEvent->WaitProcessed(aTimeout, aResult);
528	}
529	void uninit()
530	{
531	if (!mEvent.isNull())
532	{
533	mEvent->uninit();
534	mEvent.setNull();
535	}
536	}
537	]]></xsl:text>
538	<xsl:choose>
539	<xsl:when test="$isVeto='yes'">
540	<xsl:text><![CDATA[
541	HRESULT init(IEventSource* aSource, VBoxEventType_T aType, BOOL aWaitable = TRUE)
542	{
543	NOREF(aWaitable);
544	return mEvent->init(aSource, aType);
545	}
546	STDMETHOD(AddVeto)(IN_BSTR aVeto)
547	{
548	return mEvent->AddVeto(aVeto);
549	}
550	STDMETHOD(IsVetoed)(BOOL *aResult)
551	{
552	return mEvent->IsVetoed(aResult);
553	}
554	STDMETHOD(GetVetos)(ComSafeArrayOut(BSTR, aVetos))
555	{
556	return mEvent->GetVetos(ComSafeArrayOutArg(aVetos));
557	}
558	STDMETHOD(AddApproval)(IN_BSTR aReason)
559	{
560	return mEvent->AddApproval(aReason);
561	}
562	STDMETHOD(IsApproved)(BOOL *aResult)
563	{
564	return mEvent->IsApproved(aResult);
565	}
566	STDMETHOD(GetApprovals)(ComSafeArrayOut(BSTR, aReasons))
567	{
568	return mEvent->GetApprovals(ComSafeArrayOutArg(aReasons));
569	}
570	private:
571	ComObjPtr<VBoxVetoEvent> mEvent;
572	]]></xsl:text>
573	</xsl:when>
574	<xsl:when test="$isReusable='yes'">
575	<xsl:text>
576	<![CDATA[
577	HRESULT init(IEventSource* aSource, VBoxEventType_T aType, BOOL aWaitable = FALSE)
578	{
579	mGeneration = 1;
580	return mEvent->init(aSource, aType, aWaitable);
581	}
582	STDMETHOD(COMGETTER(Generation))(ULONG *aGeneration)
583	{
584	*aGeneration = mGeneration;
585	return S_OK;
586	}
587	STDMETHOD(Reuse)()
588	{
589	ASMAtomicIncU32((volatile uint32_t*)&mGeneration);
590	return S_OK;
591	}
592	private:
593	volatile ULONG mGeneration;
594	ComObjPtr<VBoxEvent> mEvent;
595	]]></xsl:text>
596	</xsl:when>
597	<xsl:otherwise>
598	<xsl:text><![CDATA[
599	HRESULT init(IEventSource* aSource, VBoxEventType_T aType, BOOL aWaitable)
600	{
601	return mEvent->init(aSource, aType, aWaitable);
602	}
603	private:
604	ComObjPtr<VBoxEvent> mEvent;
605	]]></xsl:text>
606	</xsl:otherwise>
607	</xsl:choose>
608
609	<!-- Before we generate attribute code, we check and make sure there are attributes here. -->
610	<xsl:if test="count(attribute) = 0 and @name != 'INATNetworkAlterEvent'">
611	<xsl:call-template name="fatalError">
612	<xsl:with-param name="msg">error: <xsl:value-of select="@name"/> has no attributes</xsl:with-param>
613	</xsl:call-template>
614	</xsl:if>
615
616	<xsl:call-template name="genAttrCode">
617	<xsl:with-param name="name" select="@name" />
618	</xsl:call-template>
619	<xsl:value-of select="'}; '" />
620
621
622	<xsl:call-template name="genImplList">
623	<xsl:with-param name="impl" select="$implName" />
624	<xsl:with-param name="name" select="@name" />
625	<xsl:with-param name="depth" select="'1'" />
626	<xsl:with-param name="parents" select="''" />
627	</xsl:call-template>
628
629	</xsl:template>
630
631
632	<xsl:template name="genSwitchCase">
633	<xsl:param name="ifaceName" />
634	<xsl:param name="implName" />
635	<xsl:param name="reinit" />
636	<xsl:variable name="waitable">
637	<xsl:choose>
638	<xsl:when test="@waitable='yes'">
639	<xsl:value-of select="'TRUE'"/>
640	</xsl:when>
641	<xsl:otherwise>
642	<xsl:value-of select="'FALSE'"/>
643	</xsl:otherwise>
644	</xsl:choose>
645	</xsl:variable>
646	<xsl:value-of select="concat(' case VBoxEventType_', @id, ': ')"/>
647	<xsl:value-of select=" ' { '"/>
648	<xsl:choose>
649	<xsl:when test="$reinit='yes'">
650	<xsl:value-of select="concat(' ComPtr<', $ifaceName, '> iobj; ')"/>
651	<xsl:value-of select=" ' iobj = mEvent; '"/>
652	<xsl:value-of select=" ' Assert(!iobj.isNull()); '"/>
653	<xsl:value-of select="concat(' ',$implName, '* obj = (', $implName, ')(', $ifaceName, ')iobj; ')"/>
654	<xsl:value-of select=" ' obj->Reuse(); '"/>
655	</xsl:when>
656	<xsl:otherwise>
657	<xsl:value-of select="concat(' ComObjPtr<', $implName, '> obj; ')"/>
658	<xsl:value-of select=" ' obj.createObject(); '"/>
659	<xsl:value-of select="concat(' obj->init(aSource, aType, ', $waitable, '); ')"/>
660	</xsl:otherwise>
661	</xsl:choose>
662	<xsl:call-template name="genAttrInitCode">
663	<xsl:with-param name="name" select="@name" />
664	<xsl:with-param name="obj" select="'obj'" />
665	</xsl:call-template>
666	<xsl:if test="not($reinit='yes')">
667	<xsl:value-of select=" ' obj.queryInterfaceTo(mEvent.asOutParam()); '"/>
668	</xsl:if>
669	<xsl:value-of select=" ' break; '"/>
670	<xsl:value-of select=" ' } '"/>
671	</xsl:template>
672
673	<xsl:template name="genCommonEventCode">
674	<xsl:call-template name="fileheader">
675	<xsl:with-param name="name" select="'VBoxEvents.cpp'" />
676	</xsl:call-template>
677
678	<xsl:text><![CDATA[
679	#include <VBox/com/array.h>
680	#include <iprt/asm.h>
681	#include "EventImpl.h"
682	]]></xsl:text>
683
684	<!-- Interfaces -->
685	<xsl:for-each select="//interface[@autogen=$G_kind]">
686	<xsl:value-of select="concat('// ', @name, ' implementation code')" />
687	<xsl:call-template name="xsltprocNewlineOutputHack"/>
688	<xsl:variable name="implName">
689	<xsl:value-of select="substring(@name, 2)" />
690	</xsl:variable>
691
692	<xsl:choose>
693	<xsl:when test="$G_kind='VBoxEvent'">
694	<xsl:variable name="isVeto">
695	<xsl:if test="@extends='IVetoEvent'">
696	<xsl:value-of select="'yes'" />
697	</xsl:if>
698	</xsl:variable>
699	<xsl:variable name="isReusable">
700	<xsl:if test="@extends='IReusableEvent'">
701	<xsl:value-of select="'yes'" />
702	</xsl:if>
703	</xsl:variable>
704	<xsl:call-template name="genEventImpl">
705	<xsl:with-param name="implName" select="$implName" />
706	<xsl:with-param name="isVeto" select="$isVeto" />
707	<xsl:with-param name="isReusable" select="$isReusable" />
708	</xsl:call-template>
709	</xsl:when>
710	</xsl:choose>
711	</xsl:for-each>
712
713	<xsl:text><![CDATA[
714	HRESULT VBoxEventDesc::init(IEventSource *aSource, VBoxEventType_T aType, ...)
715	{
716	va_list args;
717
718	mEventSource = aSource;
719	va_start(args, aType);
720	switch (aType)
721	{
722	]]></xsl:text>
723
724	<xsl:for-each select="//interface[@autogen=$G_kind]">
725	<xsl:variable name="implName">
726	<xsl:value-of select="substring(@name, 2)" />
727	</xsl:variable>
728	<xsl:call-template name="genSwitchCase">
729	<xsl:with-param name="ifaceName" select="@name" />
730	<xsl:with-param name="implName" select="$implName" />
731	<xsl:with-param name="reinit" select="'no'" />
732	</xsl:call-template>
733	</xsl:for-each>
734
735	<xsl:text><![CDATA[
736	default:
737	AssertFailed();
738	}
739	va_end(args);
740
741	return S_OK;
742	}
743	]]></xsl:text>
744
745	<xsl:text><![CDATA[
746	HRESULT VBoxEventDesc::reinit(VBoxEventType_T aType, ...)
747	{
748	va_list args;
749
750	va_start(args, aType);
751	switch (aType)
752	{
753	]]></xsl:text>
754
755	<xsl:for-each select="//interface[@autogen=$G_kind and @extends='IReusableEvent']">
756	<xsl:variable name="implName">
757	<xsl:value-of select="substring(@name, 2)" />
758	</xsl:variable>
759	<xsl:call-template name="genSwitchCase">
760	<xsl:with-param name="ifaceName" select="@name" />
761	<xsl:with-param name="implName" select="$implName" />
762	<xsl:with-param name="reinit" select="'yes'" />
763	</xsl:call-template>
764	</xsl:for-each>
765
766	<xsl:text><![CDATA[
767	default:
768	AssertFailed();
769	}
770	va_end(args);
771
772	return S_OK;
773	}
774	]]></xsl:text>
775
776	</xsl:template>
777
778	<xsl:template name="genFormalParams">
779	<xsl:param name="name" />
780	<xsl:variable name="extends">
781	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
782	</xsl:variable>
783
784	<xsl:choose>
785	<xsl:when test="$extends='IEvent'">
786	</xsl:when>
787	<xsl:when test="$extends='IReusableEvent'">
788	</xsl:when>
789	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
790	<xsl:call-template name="genFormalParams">
791	<xsl:with-param name="name" select="$extends" />
792	</xsl:call-template>
793	</xsl:when>
794	<xsl:otherwise>
795	<xsl:call-template name="fatalError">
796	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
797	</xsl:call-template>
798	</xsl:otherwise>
799	</xsl:choose>
800
801	<xsl:for-each select="key('G_keyInterfacesByName', $name)/attribute[@name != 'midlDoesNotLikeEmptyInterfaces']">
802	<xsl:variable name="aName" select="concat('a_',@name)"/>
803	<xsl:variable name="aTypeName">
804	<xsl:call-template name="typeIdl2Back">
805	<xsl:with-param name="type" select="@type" />
806	<xsl:with-param name="safearray" select="@safearray" />
807	<xsl:with-param name="param" select="$aName" />
808	<xsl:with-param name="dir" select="'in'" />
809	<xsl:with-param name="mod" select="@mod" />
810	</xsl:call-template>
811	</xsl:variable>
812	<xsl:value-of select="concat(', ',$aTypeName)"/>
813	</xsl:for-each>
814	</xsl:template>
815
816	<xsl:template name="genFactParams">
817	<xsl:param name="name" />
818	<xsl:variable name="extends">
819	<xsl:value-of select="key('G_keyInterfacesByName', $name)/@extends" />
820	</xsl:variable>
821
822	<xsl:choose>
823	<xsl:when test="$extends='IEvent'">
824	</xsl:when>
825	<xsl:when test="$extends='IReusableEvent'">
826	</xsl:when>
827	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
828	<xsl:call-template name="genFactParams">
829	<xsl:with-param name="name" select="$extends" />
830	</xsl:call-template>
831	</xsl:when>
832	<xsl:otherwise>
833	<xsl:call-template name="fatalError">
834	<xsl:with-param name="msg" select="concat('No idea how to process it: ', $name)" />
835	</xsl:call-template>
836	</xsl:otherwise>
837	</xsl:choose>
838
839	<xsl:for-each select="key('G_keyInterfacesByName', $name)/attribute[@name != 'midlDoesNotLikeEmptyInterfaces']">
840	<xsl:variable name="aName" select="concat('a_',@name)"/>
841	<xsl:choose>
842	<xsl:when test="@safearray='yes'">
843	<xsl:value-of select="concat(', ComSafeArrayInArg(',$aName,')')"/>
844	</xsl:when>
845	<xsl:otherwise>
846	<xsl:value-of select="concat(', ',$aName)"/>
847	</xsl:otherwise>
848	</xsl:choose>
849	</xsl:for-each>
850	</xsl:template>
851
852	<xsl:template name="genCommonEventHeader">
853	<xsl:call-template name="fileheader">
854	<xsl:with-param name="name" select="'VBoxEvents.h'" />
855	</xsl:call-template>
856
857	<xsl:text><![CDATA[
858	#include "EventImpl.h"
859	]]></xsl:text>
860
861	<!-- Interfaces -->
862	<xsl:for-each select="//interface[@autogen='VBoxEvent']">
863	<xsl:value-of select="concat('// ', @name, ' generation routine ')" />
864	<xsl:variable name="evname">
865	<xsl:value-of select="substring(@name, 2)" />
866	</xsl:variable>
867	<xsl:variable name="evid">
868	<xsl:value-of select="concat('On', substring(@name, 2, string-length(@name)-6))" />
869	</xsl:variable>
870
871	<xsl:variable name="ifname">
872	<xsl:value-of select="@name" />
873	</xsl:variable>
874
875	<xsl:value-of select="concat('DECLINLINE(void) fire', $evname, '(IEventSource* aSource')"/>
876	<xsl:call-template name="genFormalParams">
877	<xsl:with-param name="name" select="$ifname" />
878	</xsl:call-template>
879	<xsl:value-of select=" ') { '"/>
880
881	<xsl:value-of select=" ' VBoxEventDesc evDesc; '"/>
882	<xsl:value-of select="concat(' evDesc.init(aSource, VBoxEventType_',$evid)"/>
883	<xsl:call-template name="genFactParams">
884	<xsl:with-param name="name" select="$ifname" />
885	</xsl:call-template>
886	<xsl:value-of select="'); '"/>
887	<xsl:value-of select=" ' evDesc.fire(/* do not wait for delivery */ 0); '"/>
888	<xsl:value-of select=" '} '"/>
889	</xsl:for-each>
890	</xsl:template>
891
892	<xsl:template match="/">
893	<!-- Global code -->
894	<xsl:choose>
895	<xsl:when test="$G_kind='VBoxEvent'">
896	<xsl:call-template name="genCommonEventCode">
897	</xsl:call-template>
898	</xsl:when>
899	<xsl:when test="$G_kind='VBoxEventHeader'">
900	<xsl:call-template name="genCommonEventHeader">
901	</xsl:call-template>
902	</xsl:when>
903	<xsl:otherwise>
904	<xsl:call-template name="fatalError">
905	<xsl:with-param name="msg" select="concat('Request unsupported: ', $G_kind)" />
906	</xsl:call-template>
907	</xsl:otherwise>
908	</xsl:choose>
909	</xsl:template>
910
911	</xsl:stylesheet>

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

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

Download in other formats: