VirtualBox

source: vbox/trunk/src/VBox/Main/idl/apiwrap-server.xsl@ 61572

Last change on this file since 61572 was 60765, checked in by vboxsync, 9 years ago

API: stop using ATL and use a vastly smaller lookalike instead, plus a lot of cleanups
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 96.7 KB
Line 
1<?xml version="1.0"?>
2
3<!--
4 apiwrap-server.xsl:
5 XSLT stylesheet that generates C++ API wrappers (server side) from
6 VirtualBox.xidl.
7
8 Copyright (C) 2010-2016 Oracle Corporation
9
10 This file is part of VirtualBox Open Source Edition (OSE), as
11 available from http://www.virtualbox.org. This file is free software;
12 you can redistribute it and/or modify it under the terms of the GNU
13 General Public License (GPL) as published by the Free Software
14 Foundation, in version 2 as it comes in the "COPYING" file of the
15 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17-->
18
19<xsl:stylesheet
20 version="1.0"
21 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
22 xmlns:exsl="http://exslt.org/common"
23 extension-element-prefixes="exsl">
24
25<xsl:output method="text"/>
26
27<xsl:strip-space elements="*"/>
28
29<!-- - - - - - - - - - - - - - - - - - - - - - -
30 global XSLT variables
31 - - - - - - - - - - - - - - - - - - - - - - -->
32
33<xsl:variable name="G_xsltFilename" select="'apiwrap-server.xsl'"/>
34
35<xsl:variable name="G_root" select="/"/>
36
37<xsl:include href="typemap-shared.inc.xsl"/>
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<!-- - - - - - - - - - - - - - - - - - - - - - -
47templates for file separation
48 - - - - - - - - - - - - - - - - - - - - - - -->
49
50<xsl:template match="interface" mode="startfile">
51 <xsl:param name="file"/>
52
53 <xsl:call-template name="xsltprocNewlineOutputHack"/>
54 <xsl:value-of select="concat($G_sNewLine, '// ##### BEGINFILE &quot;', $file, '&quot;', $G_sNewLine)"/>
55</xsl:template>
56
57<xsl:template match="interface" mode="endfile">
58 <xsl:param name="file"/>
59
60 <xsl:value-of select="concat($G_sNewLine, '// ##### ENDFILE &quot;', $file, '&quot;', $G_sNewLine)"/>
61</xsl:template>
62
63<!-- - - - - - - - - - - - - - - - - - - - - - -
64templates for file headers/footers
65 - - - - - - - - - - - - - - - - - - - - - - -->
66
67<xsl:template name="fileheader">
68 <xsl:param name="class"/>
69 <xsl:param name="name"/>
70 <xsl:param name="type"/>
71
72 <xsl:text>/** @file
73</xsl:text>
74 <xsl:value-of select="concat(' * VirtualBox API class wrapper ', $type, ' for I', $class, '.')"/>
75 <xsl:text>
76 *
77 * DO NOT EDIT! This is a generated file.
78 * Generated from: src/VBox/Main/idl/VirtualBox.xidl
79 * Generator: src/VBox/Main/idl/apiwrap-server.xsl
80 */
81
82/**
83 * Copyright (C) 2010-2015 Oracle Corporation
84 *
85 * This file is part of VirtualBox Open Source Edition (OSE), as
86 * available from http://www.virtualbox.org. This file is free software;
87 * you can redistribute it and/or modify it under the terms of the GNU
88 * General Public License (GPL) as published by the Free Software
89 * Foundation, in version 2 as it comes in the "COPYING" file of the
90 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
91 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
92 */
93
94</xsl:text>
95</xsl:template>
96
97<!-- Emits COM_INTERFACE_ENTRY statements for the current interface node and whatever it inherits from. -->
98<xsl:template name="emitCOMInterfaces">
99 <xsl:value-of select="concat(' COM_INTERFACE_ENTRY(', @name, ')' , $G_sNewLine)"/>
100 <!-- now recurse to emit all base interfaces -->
101 <xsl:variable name="extends" select="@extends"/>
102 <xsl:if test="$extends and not($extends='$unknown') and not($extends='$errorinfo')">
103 <xsl:for-each select="key('G_keyInterfacesByName', $extends)">
104 <xsl:call-template name="emitCOMInterfaces"/>
105 </xsl:for-each>
106 </xsl:if>
107</xsl:template>
108
109<xsl:template match="interface" mode="classheader">
110 <xsl:param name="addinterfaces"/>
111 <xsl:value-of select="concat('#ifndef ', substring(@name, 2), 'Wrap_H_', $G_sNewLine)"/>
112 <xsl:value-of select="concat('#define ', substring(@name, 2), 'Wrap_H_')"/>
113 <xsl:text>
114
115#include "VirtualBoxBase.h"
116#include "Wrapper.h"
117
118</xsl:text>
119 <xsl:value-of select="concat('class ATL_NO_VTABLE ', substring(@name, 2), 'Wrap:')"/>
120 <xsl:text>
121 public VirtualBoxBase,
122</xsl:text>
123 <xsl:value-of select="concat(' VBOX_SCRIPTABLE_IMPL(', @name, ')')"/>
124 <xsl:if test="count(exsl:node-set($addinterfaces)/token) > 0">
125 <xsl:text>,</xsl:text>
126 </xsl:if>
127 <xsl:value-of select="$G_sNewLine"/>
128 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
129 <xsl:value-of select="concat(' VBOX_SCRIPTABLE_IMPL(', text(), ')')"/>
130 <xsl:if test="not(position()=last())">
131 <xsl:text>,</xsl:text>
132 </xsl:if>
133 <xsl:value-of select="$G_sNewLine"/>
134 </xsl:for-each>
135 <xsl:text>{
136 Q_OBJECT
137
138public:
139</xsl:text>
140 <xsl:value-of select="concat(' VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(', substring(@name, 2), 'Wrap, ', @name, ')', $G_sNewLine)"/>
141 <xsl:value-of select="concat(' DECLARE_NOT_AGGREGATABLE(', substring(@name, 2), 'Wrap)', $G_sNewLine)"/>
142 <xsl:text> DECLARE_PROTECT_FINAL_CONSTRUCT()
143
144</xsl:text>
145 <xsl:value-of select="concat(' BEGIN_COM_MAP(', substring(@name, 2), 'Wrap)', $G_sNewLine)"/>
146 <xsl:text> COM_INTERFACE_ENTRY(ISupportErrorInfo)
147</xsl:text>
148 <xsl:call-template name="emitCOMInterfaces"/>
149 <xsl:value-of select="concat(' COM_INTERFACE_ENTRY2(IDispatch, ', @name, ')', $G_sNewLine)"/>
150 <xsl:variable name="manualAddInterfaces">
151 <xsl:call-template name="checkoption">
152 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
153 <xsl:with-param name="option" select="'manualaddinterfaces'"/>
154 </xsl:call-template>
155 </xsl:variable>
156 <xsl:if test="not($manualAddInterfaces = 'true')">
157 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
158 <!-- This is super tricky, as the for-each switches to the node set,
159 which means the normal document isn't available any more. We get
160 the data we need, uses a for-each to switch document and then a
161 key() to look up the interface by name. -->
162 <xsl:variable name="addifname">
163 <xsl:value-of select="string(.)"/>
164 </xsl:variable>
165 <xsl:for-each select="$G_root">
166 <xsl:for-each select="key('G_keyInterfacesByName', $addifname)">
167 <xsl:call-template name="emitCOMInterfaces"/>
168 </xsl:for-each>
169 </xsl:for-each>
170 </xsl:for-each>
171 </xsl:if>
172 <xsl:value-of select="concat(' VBOX_TWEAK_INTERFACE_ENTRY(', @name, ')', $G_sNewLine)"/>
173 <xsl:text> END_COM_MAP()
174
175</xsl:text>
176 <xsl:value-of select="concat(' DECLARE_EMPTY_CTOR_DTOR(', substring(@name, 2), 'Wrap)', $G_sNewLine)"/>
177</xsl:template>
178
179<xsl:template match="interface" mode="classfooter">
180 <xsl:param name="addinterfaces"/>
181 <xsl:text>};
182
183</xsl:text>
184 <xsl:value-of select="concat('#endif // !', substring(@name, 2), 'Wrap_H_', $G_sNewLine)"/>
185</xsl:template>
186
187<xsl:template match="interface" mode="codeheader">
188 <xsl:param name="addinterfaces"/>
189 <xsl:value-of select="concat('#define LOG_GROUP_MAIN_OVERRIDE LOG_GROUP_MAIN_', translate(substring(@name, 2), $G_lowerCase, $G_upperCase), $G_sNewLine, $G_sNewLine)"/>
190 <xsl:value-of select="concat('#include &quot;', substring(@name, 2), 'Wrap.h&quot;', $G_sNewLine)"/>
191 <xsl:text>#include "Logging.h"
192#ifdef VBOX_WITH_DTRACE_R3_MAIN
193# include "dtrace/VBoxAPI.h"
194#endif
195
196</xsl:text>
197</xsl:template>
198
199<xsl:template name="emitISupports">
200 <xsl:param name="classname"/>
201 <xsl:param name="extends"/>
202 <xsl:param name="addinterfaces"/>
203 <xsl:param name="depth"/>
204 <xsl:param name="interfacelist"/>
205
206 <xsl:choose>
207 <xsl:when test="$extends and not($extends='$unknown') and not($extends='$errorinfo')">
208 <xsl:variable name="newextends" select="key('G_keyInterfacesByName', $extends)/@extends"/>
209 <xsl:variable name="newiflist" select="concat($interfacelist, ', ', $extends)"/>
210 <xsl:call-template name="emitISupports">
211 <xsl:with-param name="classname" select="$classname"/>
212 <xsl:with-param name="extends" select="$newextends"/>
213 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
214 <xsl:with-param name="depth" select="$depth + 1"/>
215 <xsl:with-param name="interfacelist" select="$newiflist"/>
216 </xsl:call-template>
217 </xsl:when>
218 <xsl:otherwise>
219 <xsl:variable name="addinterfaces_ns" select="exsl:node-set($addinterfaces)"/>
220 <xsl:choose>
221 <xsl:when test="count($addinterfaces_ns/token) > 0">
222 <xsl:variable name="addifname" select="$addinterfaces_ns/token[1]"/>
223 <xsl:variable name="addif" select="key('G_keyInterfacesByName', $addifname)/@extends"/>
224 <xsl:variable name="newextends" select="$addif/@extends"/>
225 <xsl:variable name="newaddinterfaces" select="$addinterfaces_ns/token[position() > 1]"/>
226 <xsl:variable name="newiflist" select="concat($interfacelist, ', ', $addifname)"/>
227 <xsl:call-template name="emitISupports">
228 <xsl:with-param name="classname" select="$classname"/>
229 <xsl:with-param name="extends" select="$newextends"/>
230 <xsl:with-param name="addinterfaces" select="$newaddinterfaces"/>
231 <xsl:with-param name="depth" select="$depth + 1"/>
232 <xsl:with-param name="interfacelist" select="$newiflist"/>
233 </xsl:call-template>
234 </xsl:when>
235 <xsl:otherwise>
236 <xsl:value-of select="concat('NS_IMPL_THREADSAFE_ISUPPORTS', $depth, '_CI(', $classname, ', ', $interfacelist, ')', $G_sNewLine)"/>
237 </xsl:otherwise>
238 </xsl:choose>
239 </xsl:otherwise>
240 </xsl:choose>
241</xsl:template>
242
243<xsl:template match="interface" mode="codefooter">
244 <xsl:param name="addinterfaces"/>
245 <xsl:text>#ifdef VBOX_WITH_XPCOM
246</xsl:text>
247 <xsl:value-of select="concat('NS_DECL_CLASSINFO(', substring(@name, 2), 'Wrap)', $G_sNewLine)"/>
248
249 <xsl:variable name="manualAddInterfaces">
250 <xsl:call-template name="checkoption">
251 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
252 <xsl:with-param name="option" select="'manualaddinterfaces'"/>
253 </xsl:call-template>
254 </xsl:variable>
255 <xsl:choose>
256 <xsl:when test="$manualAddInterfaces = 'true'">
257 <xsl:variable name="nulladdinterfaces"></xsl:variable>
258 <xsl:call-template name="emitISupports">
259 <xsl:with-param name="classname" select="concat(substring(@name, 2), 'Wrap')"/>
260 <xsl:with-param name="extends" select="@extends"/>
261 <xsl:with-param name="addinterfaces" select="$nulladdinterfaces"/>
262 <xsl:with-param name="depth" select="1"/>
263 <xsl:with-param name="interfacelist" select="@name"/>
264 </xsl:call-template>
265 </xsl:when>
266 <xsl:otherwise>
267 <xsl:call-template name="emitISupports">
268 <xsl:with-param name="classname" select="concat(substring(@name, 2), 'Wrap')"/>
269 <xsl:with-param name="extends" select="@extends"/>
270 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
271 <xsl:with-param name="depth" select="1"/>
272 <xsl:with-param name="interfacelist" select="@name"/>
273 </xsl:call-template>
274 </xsl:otherwise>
275 </xsl:choose>
276 <xsl:text>#endif // VBOX_WITH_XPCOM
277</xsl:text>
278</xsl:template>
279
280
281<!-- - - - - - - - - - - - - - - - - - - - - - -
282 templates for dealing with names and parameters
283 - - - - - - - - - - - - - - - - - - - - - - -->
284
285<xsl:template name="tospace">
286 <xsl:param name="str"/>
287 <xsl:value-of select="translate($str, 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_', ' ')"/>
288</xsl:template>
289
290<xsl:template name="checkoption">
291 <xsl:param name="optionlist"/>
292 <xsl:param name="option"/>
293 <xsl:value-of select="string-length($option) > 0 and contains(concat(',', translate($optionlist, ' ', ''), ','), concat(',', $option, ','))"/>
294</xsl:template>
295
296<xsl:template name="getattrlist">
297 <xsl:param name="val"/>
298 <xsl:param name="separator" select="','"/>
299
300 <xsl:if test="$val and $val != ''">
301 <xsl:choose>
302 <xsl:when test="contains($val,$separator)">
303 <token>
304 <xsl:value-of select="substring-before($val,$separator)"/>
305 </token>
306 <xsl:call-template name="getattrlist">
307 <xsl:with-param name="val" select="substring-after($val,$separator)"/>
308 <xsl:with-param name="separator" select="$separator"/>
309 </xsl:call-template>
310 </xsl:when>
311 <xsl:otherwise>
312 <token><xsl:value-of select="$val"/></token>
313 </xsl:otherwise>
314 </xsl:choose>
315 </xsl:if>
316</xsl:template>
317
318<xsl:template name="translatepublictype">
319 <xsl:param name="type"/>
320 <xsl:param name="dir"/>
321 <xsl:param name="mod"/>
322
323 <xsl:choose>
324 <xsl:when test="$type='wstring' or $type='uuid'">
325 <xsl:if test="$dir='in'">
326 <xsl:text>IN_</xsl:text>
327 </xsl:if>
328 <xsl:text>BSTR</xsl:text>
329 </xsl:when>
330
331 <xsl:when test="$type='$unknown'">
332 <xsl:text>IUnknown *</xsl:text>
333 </xsl:when>
334
335 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
336 <xsl:value-of select="concat($type, ' *')"/>
337 </xsl:when>
338
339 <xsl:when test="count(key('G_keyEnumsByName', $type)) > 0">
340 <xsl:value-of select="concat($type, '_T')"/>
341 </xsl:when>
342
343 <!-- Micro optimizations: Put off wraptypefield calculation as long as possible; Check interfaces before enums. -->
344 <xsl:otherwise>
345 <!-- get C++ glue type from IDL type from table in typemap-shared.inc.xsl -->
346 <xsl:variable name="gluetypefield" select="exsl:node-set($G_aSharedTypes)/type[@idlname=$type]/@gluename"/>
347 <xsl:choose>
348 <xsl:when test="string-length($gluetypefield)">
349 <xsl:value-of select="$gluetypefield"/>
350 </xsl:when>
351
352 <xsl:otherwise>
353 <xsl:call-template name="fatalError">
354 <xsl:with-param name="msg" select="concat('translatepublictype: Type &quot;', $type, '&quot; is not supported.')"/>
355 </xsl:call-template>
356 </xsl:otherwise>
357 </xsl:choose>
358 </xsl:otherwise>
359 </xsl:choose>
360 <xsl:if test="$mod='ptr'">
361 <xsl:text> *</xsl:text>
362 </xsl:if>
363</xsl:template>
364
365<xsl:template name="translatewrappedtype">
366 <xsl:param name="type"/>
367 <xsl:param name="dir"/>
368 <xsl:param name="mod"/>
369 <xsl:param name="safearray"/>
370
371 <xsl:choose>
372 <xsl:when test="$type='wstring'">
373 <xsl:if test="$dir='in' and not($safearray='yes')">
374 <xsl:text>const </xsl:text>
375 </xsl:if>
376 <xsl:text>com::Utf8Str &amp;</xsl:text>
377 </xsl:when>
378
379 <xsl:when test="$type='uuid'">
380 <xsl:if test="$dir='in'">
381 <xsl:text>const </xsl:text>
382 </xsl:if>
383 <xsl:text>com::Guid &amp;</xsl:text>
384 </xsl:when>
385
386 <xsl:when test="$type='$unknown'">
387 <xsl:if test="$dir='in' and not($safearray='yes')">
388 <xsl:text>const </xsl:text>
389 </xsl:if>
390 <xsl:text>ComPtr&lt;IUnknown&gt; &amp;</xsl:text>
391 </xsl:when>
392
393 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
394 <xsl:if test="$dir='in' and not($safearray='yes')">
395 <xsl:text>const </xsl:text>
396 </xsl:if>
397 <xsl:value-of select="concat('ComPtr&lt;', $type, '&gt; &amp;')"/>
398 </xsl:when>
399
400 <xsl:when test="count(key('G_keyEnumsByName', $type)) > 0">
401 <xsl:value-of select="concat($type, '_T')"/>
402 </xsl:when>
403
404 <!-- Micro optimizations: Put off wraptypefield calculation as long as possible; Check interfaces before enums. -->
405 <xsl:otherwise>
406 <!-- get C++ wrap type from IDL type from table in typemap-shared.inc.xsl -->
407 <xsl:variable name="wraptypefield" select="exsl:node-set($G_aSharedTypes)/type[@idlname=$type]/@gluename"/>
408 <xsl:choose>
409 <xsl:when test="string-length($wraptypefield)">
410 <xsl:value-of select="$wraptypefield"/>
411 </xsl:when>
412
413 <xsl:otherwise>
414 <xsl:call-template name="fatalError">
415 <xsl:with-param name="msg" select="concat('translatewrappedtype: Type &quot;', $type, '&quot; is not supported.')"/>
416 </xsl:call-template>
417 </xsl:otherwise>
418 </xsl:choose>
419 </xsl:otherwise>
420 </xsl:choose>
421 <xsl:if test="$mod='ptr'">
422 <xsl:text> *</xsl:text>
423 </xsl:if>
424</xsl:template>
425
426<xsl:template name="translatefmtspectype">
427 <xsl:param name="type"/>
428 <xsl:param name="dir"/>
429 <xsl:param name="mod"/>
430 <xsl:param name="safearray"/>
431 <xsl:param name="isref"/>
432
433 <!-- get C format string for IDL type from table in typemap-shared.inc.xsl -->
434 <xsl:variable name="wrapfmt" select="exsl:node-set($G_aSharedTypes)/type[@idlname=$type]/@gluefmt"/>
435 <xsl:choose>
436 <xsl:when test="$mod='ptr' or ($isref='yes' and $dir!='in')">
437 <xsl:text>%p</xsl:text>
438 </xsl:when>
439 <xsl:when test="$safearray='yes'">
440 <xsl:text>%zu</xsl:text>
441 </xsl:when>
442 <xsl:when test="string-length($wrapfmt)">
443 <xsl:value-of select="$wrapfmt"/>
444 </xsl:when>
445 <xsl:when test="$type='$unknown'">
446 <xsl:text>%p</xsl:text>
447 </xsl:when>
448 <xsl:when test="count(key('G_keyEnumsByName', $type)) > 0">
449 <xsl:text>%RU32</xsl:text>
450 </xsl:when>
451 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
452 <xsl:text>%p</xsl:text>
453 </xsl:when>
454 <xsl:otherwise>
455 <xsl:call-template name="fatalError">
456 <xsl:with-param name="msg" select="concat('translatefmtcpectype: Type &quot;', $type, '&quot; is not supported.')"/>
457 </xsl:call-template>
458 </xsl:otherwise>
459 </xsl:choose>
460</xsl:template>
461
462<xsl:template name="translatedtracetype">
463 <xsl:param name="type"/>
464 <xsl:param name="dir"/>
465 <xsl:param name="mod"/>
466
467 <!-- get dtrace probe type from IDL type from table in typemap-shared.inc.xsl -->
468 <xsl:variable name="dtracetypefield" select="exsl:node-set($G_aSharedTypes)/type[@idlname=$type]/@dtracename"/>
469 <xsl:choose>
470 <xsl:when test="string-length($dtracetypefield)">
471 <xsl:value-of select="$dtracetypefield"/>
472 </xsl:when>
473 <xsl:when test="$type='$unknown'">
474 <!-- <xsl:text>struct IUnknown *</xsl:text> -->
475 <xsl:text>void *</xsl:text>
476 </xsl:when>
477 <xsl:when test="count(key('G_keyEnumsByName', $type)) > 0">
478 <!-- <xsl:value-of select="concat($type, '_T')"/> - later we can emit enums into dtrace the library -->
479 <xsl:text>int</xsl:text>
480 </xsl:when>
481 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
482 <!--
483 <xsl:value-of select="concat('struct ', $type, ' *')"/>
484 -->
485 <xsl:text>void *</xsl:text>
486 </xsl:when>
487 <xsl:otherwise>
488 <xsl:call-template name="fatalError">
489 <xsl:with-param name="msg" select="concat('translatedtracetype Type &quot;', $type, '&quot; is not supported.')"/>
490 </xsl:call-template>
491 </xsl:otherwise>
492 </xsl:choose>
493 <xsl:if test="$mod='ptr'">
494 <xsl:text> *</xsl:text>
495 </xsl:if>
496</xsl:template>
497
498
499<!-- - - - - - - - - - - - - - - - - - - - - - -
500 templates for handling entire interfaces and their contents
501 - - - - - - - - - - - - - - - - - - - - - - -->
502
503<!-- Called on interface node. -->
504<xsl:template name="emitInterface">
505 <!-- sources, headers and dtrace-probes all needs attribute lists -->
506 <xsl:variable name="addinterfaces">
507 <xsl:call-template name="getattrlist">
508 <xsl:with-param name="val" select="@wrap-hint-server-addinterfaces"/>
509 </xsl:call-template>
510 </xsl:variable>
511
512 <!-- interface santiy check, prevents crashes -->
513 <xsl:if test="(count(attribute) + count(method)) = 0">
514 <xsl:message terminate="yes">
515 Interface <xsl:value-of select="@name"/> is empty which causes midl generated proxy
516 stubs to crash. Please add a dummy:<xsl:value-of select="$G_sNewLine"/>
517 &lt;attribute name="midlDoesNotLikeEmptyInterfaces" readonly="yes" type="boolean"/&gt;
518 </xsl:message>
519 </xsl:if>
520
521 <xsl:choose>
522 <xsl:when test="$generating = 'sources'">
523 <xsl:if test="(position() mod 2) = $reminder">
524 <xsl:call-template name="emitCode">
525 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
526 </xsl:call-template>
527 </xsl:if>
528 </xsl:when>
529 <xsl:when test="$generating = 'headers'">
530 <xsl:call-template name="emitHeader">
531 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
532 </xsl:call-template>
533 </xsl:when>
534 <xsl:when test="$generating = 'dtrace-probes'">
535 <xsl:call-template name="emitDTraceProbes">
536 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
537 </xsl:call-template>
538 </xsl:when>
539 <xsl:otherwise><xsl:message terminate="yes">Otherwise oops in emitInterface</xsl:message></xsl:otherwise>
540 </xsl:choose>
541</xsl:template>
542
543<!-- Called on a method param or attribute node. -->
544<xsl:template name="emitPublicParameter">
545 <xsl:param name="dir"/>
546
547 <xsl:variable name="gluetype">
548 <xsl:call-template name="translatepublictype">
549 <xsl:with-param name="type" select="@type"/>
550 <xsl:with-param name="dir" select="$dir"/>
551 <xsl:with-param name="mod" select="@mod"/>
552 </xsl:call-template>
553 </xsl:variable>
554
555 <xsl:choose>
556 <xsl:when test="@safearray='yes'">
557 <xsl:choose>
558 <xsl:when test="$dir='in'">
559 <xsl:text>ComSafeArrayIn(</xsl:text>
560 </xsl:when>
561 <xsl:otherwise>
562 <xsl:text>ComSafeArrayOut(</xsl:text>
563 </xsl:otherwise>
564 </xsl:choose>
565 <xsl:value-of select="$gluetype"/>
566 <xsl:text>, a</xsl:text>
567 <xsl:call-template name="capitalize">
568 <xsl:with-param name="str" select="@name"/>
569 </xsl:call-template>
570 <xsl:text>)</xsl:text>
571 </xsl:when>
572 <xsl:otherwise>
573 <xsl:value-of select="$gluetype"/>
574 <xsl:if test="substring($gluetype,string-length($gluetype))!='*'">
575 <xsl:text> </xsl:text>
576 </xsl:if>
577 <xsl:if test="$dir != 'in'">
578 <xsl:text>*</xsl:text>
579 </xsl:if>
580 <xsl:text>a</xsl:text>
581 <xsl:call-template name="capitalize">
582 <xsl:with-param name="str" select="@name"/>
583 </xsl:call-template>
584 </xsl:otherwise>
585 </xsl:choose>
586</xsl:template>
587
588<xsl:template match="attribute/@type | param/@type" mode="wrapped">
589 <xsl:param name="dir"/>
590
591 <xsl:variable name="wraptype">
592 <xsl:call-template name="translatewrappedtype">
593 <xsl:with-param name="type" select="."/>
594 <xsl:with-param name="dir" select="$dir"/>
595 <xsl:with-param name="mod" select="../@mod"/>
596 <xsl:with-param name="safearray" select="../@safearray"/>
597 </xsl:call-template>
598 </xsl:variable>
599 <xsl:variable name="lastchar">
600 <xsl:value-of select="substring($wraptype, string-length($wraptype))"/>
601 </xsl:variable>
602
603 <xsl:choose>
604 <xsl:when test="../@safearray='yes'">
605 <xsl:if test="$dir='in'">
606 <xsl:text>const </xsl:text>
607 </xsl:if>
608 <xsl:text>std::vector&lt;</xsl:text>
609 <xsl:choose>
610 <xsl:when test="$lastchar = '&amp;'">
611 <xsl:variable name="wraptype2">
612 <xsl:value-of select="substring($wraptype, 1, string-length($wraptype)-2)"/>
613 </xsl:variable>
614 <xsl:value-of select="$wraptype2"/>
615 <xsl:if test="substring($wraptype2,string-length($wraptype2)) = '&gt;'">
616 <xsl:text> </xsl:text>
617 </xsl:if>
618 </xsl:when>
619 <xsl:when test="lastchar = '&gt;'">
620 <xsl:value-of select="concat($wraptype, ' ')"/>
621 </xsl:when>
622 <xsl:otherwise>
623 <xsl:value-of select="$wraptype"/>
624 </xsl:otherwise>
625 </xsl:choose>
626 <xsl:text>&gt; &amp;</xsl:text>
627 </xsl:when>
628 <xsl:otherwise>
629 <xsl:value-of select="$wraptype"/>
630 <xsl:if test="$lastchar != '&amp;'">
631 <xsl:if test="$lastchar != '*'">
632 <xsl:text> </xsl:text>
633 </xsl:if>
634 <xsl:if test="$dir != 'in'">
635 <xsl:text>*</xsl:text>
636 </xsl:if>
637 </xsl:if>
638 </xsl:otherwise>
639 </xsl:choose>
640 <xsl:text>a</xsl:text>
641 <xsl:call-template name="capitalize">
642 <xsl:with-param name="str" select="../@name"/>
643 </xsl:call-template>
644</xsl:template>
645
646<xsl:template match="attribute/@type | param/@type" mode="logparamtext">
647 <xsl:param name="dir"/>
648 <xsl:param name="isref"/>
649
650 <xsl:if test="$isref!='yes' and ($dir='out' or $dir='ret')">
651 <xsl:text>*</xsl:text>
652 </xsl:if>
653 <xsl:text>a</xsl:text>
654 <xsl:call-template name="capitalize">
655 <xsl:with-param name="str" select="../@name"/>
656 </xsl:call-template>
657 <xsl:text>=</xsl:text>
658 <xsl:call-template name="translatefmtspectype">
659 <xsl:with-param name="type" select="."/>
660 <xsl:with-param name="dir" select="$dir"/>
661 <xsl:with-param name="mod" select="../@mod"/>
662 <xsl:with-param name="safearray" select="../@safearray"/>
663 <xsl:with-param name="isref" select="$isref"/>
664 </xsl:call-template>
665</xsl:template>
666
667<xsl:template match="attribute/@type | param/@type" mode="logparamval">
668 <xsl:param name="dir"/>
669 <xsl:param name="isref"/>
670
671 <xsl:choose>
672 <xsl:when test="../@safearray='yes' and $isref!='yes'">
673 <xsl:text>ComSafeArraySize(</xsl:text>
674 <xsl:if test="$isref!='yes' and $dir!='in'">
675 <xsl:text>*</xsl:text>
676 </xsl:if>
677 </xsl:when>
678 <xsl:when test="$isref!='yes' and $dir!='in'">
679 <xsl:text>*</xsl:text>
680 </xsl:when>
681 </xsl:choose>
682 <xsl:text>a</xsl:text>
683 <xsl:call-template name="capitalize">
684 <xsl:with-param name="str" select="../@name"/>
685 </xsl:call-template>
686 <xsl:choose>
687 <xsl:when test="../@safearray='yes' and $isref!='yes'">
688 <xsl:text>)</xsl:text>
689 </xsl:when>
690 </xsl:choose>
691</xsl:template>
692
693<!-- Emits the DTrace probe parameter value (using tmps), invoked on param or attribute node. -->
694<xsl:template name="emitDTraceParamValue">
695 <xsl:param name="dir"/>
696
697 <xsl:variable name="viatmpvar">
698 <xsl:for-each select="@type">
699 <xsl:call-template name="paramconversionviatmp">
700 <xsl:with-param name="dir" select="$dir"/>
701 </xsl:call-template>
702 </xsl:for-each>
703 </xsl:variable>
704
705 <xsl:variable name="type" select="@type"/>
706 <xsl:choose>
707 <!-- Doesn't help to inline paramconversionviatmp: <xsl:when test="$type = 'wstring' or $type = '$unknown' or $type = 'uuid' or @safearray = 'yes' or count(key('G_keyInterfacesByName', $type)) > 0"> -->
708 <xsl:when test="$viatmpvar = 'yes'">
709 <xsl:variable name="tmpname">
710 <xsl:text>Tmp</xsl:text>
711 <xsl:call-template name="capitalize">
712 <xsl:with-param name="str" select="@name"/>
713 </xsl:call-template>
714 </xsl:variable>
715
716 <xsl:choose>
717 <xsl:when test="@safearray = 'yes'">
718 <xsl:text>(uint32_t)</xsl:text>
719 <xsl:value-of select="$tmpname"/>
720 <xsl:text>.array().size(), </xsl:text>
721 <!-- Later:
722 <xsl:value-of select="concat($tmpname, '.array().data(), ')"/>
723 -->
724 <xsl:text>NULL /*for now*/</xsl:text>
725 </xsl:when>
726 <xsl:when test="$type = 'wstring'">
727 <xsl:value-of select="$tmpname"/>
728 <xsl:text>.str().c_str()</xsl:text>
729 </xsl:when>
730 <xsl:when test="$type = 'uuid'">
731 <xsl:value-of select="$tmpname"/>
732 <xsl:text>.uuid().toStringCurly().c_str()</xsl:text>
733 </xsl:when>
734 <xsl:when test="$type = '$unknown'">
735 <xsl:text>(void *)</xsl:text>
736 <xsl:value-of select="$tmpname"/>
737 <xsl:text>.ptr()</xsl:text>
738 </xsl:when>
739 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
740 <xsl:text>(void *)</xsl:text>
741 <xsl:value-of select="$tmpname"/>
742 <xsl:text>.ptr()</xsl:text>
743 </xsl:when>
744 <xsl:otherwise>
745 <xsl:value-of select="$tmpname"/>
746 </xsl:otherwise>
747 </xsl:choose>
748 </xsl:when>
749
750 <xsl:otherwise>
751 <xsl:if test="$dir != 'in'">
752 <xsl:text>*</xsl:text>
753 </xsl:if>
754 <xsl:text>a</xsl:text>
755 <xsl:call-template name="capitalize">
756 <xsl:with-param name="str" select="@name"/>
757 </xsl:call-template>
758
759 <xsl:if test="$type = 'boolean'">
760 <xsl:text> != FALSE</xsl:text>
761 </xsl:if>
762 </xsl:otherwise>
763 </xsl:choose>
764</xsl:template>
765
766<!--
767Same as emitDTraceParamValue except no temporary variables are used (they are out of scope).
768Note! There are two other instances of this code with different @dir values, see below.
769-->
770<xsl:template name="emitDTraceParamValNoTmp">
771 <!-- To speed this up, the logic of paramconversionviatmp has been duplicated/inlined here. -->
772 <xsl:variable name="type" select="@type"/>
773 <xsl:choose>
774 <xsl:when test="@safearray = 'yes'">
775 <xsl:text>0, 0</xsl:text>
776 </xsl:when>
777 <xsl:when test="$type = 'wstring' or $type = '$unknown' or $type = 'uuid' or count(key('G_keyInterfacesByName', $type)) > 0">
778 <xsl:text>0</xsl:text>
779 </xsl:when>
780 <xsl:otherwise>
781 <xsl:if test="@dir != 'in'">
782 <xsl:text>*</xsl:text>
783 </xsl:if>
784 <xsl:text>a</xsl:text>
785 <xsl:call-template name="capitalize">
786 <xsl:with-param name="str" select="@name"/>
787 </xsl:call-template>
788 <xsl:if test="$type = 'boolean'">
789 <xsl:text> != FALSE</xsl:text>
790 </xsl:if>
791 </xsl:otherwise>
792 </xsl:choose>
793</xsl:template>
794
795<!-- Copy of emitDTraceParamValNoTmp with @dir = 'in' for speeding up the code (noticable difference). -->
796<xsl:template name="emitDTraceParamValNoTmp-DirIn">
797 <xsl:variable name="type" select="@type"/>
798 <xsl:choose>
799 <xsl:when test="@safearray = 'yes'">
800 <xsl:text>0, 0</xsl:text>
801 </xsl:when>
802 <xsl:when test="$type = 'wstring' or $type = '$unknown' or $type = 'uuid' or count(key('G_keyInterfacesByName', $type)) > 0">
803 <xsl:text>0</xsl:text>
804 </xsl:when>
805 <xsl:otherwise>
806 <xsl:text>a</xsl:text>
807 <xsl:call-template name="capitalize">
808 <xsl:with-param name="str" select="@name"/>
809 </xsl:call-template>
810 <xsl:if test="$type = 'boolean'">
811 <xsl:text> != FALSE</xsl:text>
812 </xsl:if>
813 </xsl:otherwise>
814 </xsl:choose>
815</xsl:template>
816
817<!-- Copy of emitDTraceParamValNoTmp with @dir != 'in' for speeding up attributes (noticable difference). -->
818<xsl:template name="emitDTraceParamValNoTmp-DirNotIn">
819 <xsl:variable name="type" select="@type"/>
820 <xsl:choose>
821 <xsl:when test="@safearray = 'yes'">
822 <xsl:text>0, 0</xsl:text>
823 </xsl:when>
824 <xsl:when test="$type = 'wstring' or $type = '$unknown' or $type = 'uuid' or count(key('G_keyInterfacesByName', $type)) > 0">
825 <xsl:text>0</xsl:text>
826 </xsl:when>
827 <xsl:otherwise>
828 <xsl:text>*a</xsl:text>
829 <xsl:call-template name="capitalize">
830 <xsl:with-param name="str" select="@name"/>
831 </xsl:call-template>
832 <xsl:if test="$type = 'boolean'">
833 <xsl:text> != FALSE</xsl:text>
834 </xsl:if>
835 </xsl:otherwise>
836 </xsl:choose>
837</xsl:template>
838
839<xsl:template match="attribute/@type | param/@type" mode="dtraceparamdecl">
840 <xsl:param name="dir"/>
841
842 <xsl:variable name="gluetype">
843 <xsl:call-template name="translatedtracetype">
844 <xsl:with-param name="type" select="."/>
845 <xsl:with-param name="dir" select="$dir"/>
846 <xsl:with-param name="mod" select="../@mod"/>
847 </xsl:call-template>
848 </xsl:variable>
849
850 <!-- Safe arrays get an extra size parameter. -->
851 <xsl:if test="../@safearray='yes'">
852 <xsl:text>uint32_t a_c</xsl:text>
853 <xsl:call-template name="capitalize">
854 <xsl:with-param name="str" select="../@name"/>
855 </xsl:call-template>
856 <xsl:text>, </xsl:text>
857 </xsl:if>
858
859 <xsl:value-of select="$gluetype"/>
860 <xsl:choose>
861 <xsl:when test="../@safearray='yes'">
862 <xsl:text> *a_pa</xsl:text>
863 </xsl:when>
864 <xsl:otherwise>
865 <xsl:if test="substring($gluetype,string-length($gluetype))!='*'">
866 <xsl:text> </xsl:text>
867 </xsl:if>
868 <xsl:text>a_</xsl:text>
869 </xsl:otherwise>
870 </xsl:choose>
871
872 <xsl:call-template name="capitalize">
873 <xsl:with-param name="str" select="../@name"/>
874 </xsl:call-template>
875</xsl:template>
876
877<!-- Call this to determine whether a temporary conversion variable is used for the current parameter.
878Returns empty if not needed, non-empty ('yes') if needed. -->
879<xsl:template name="paramconversionviatmp">
880 <xsl:param name="dir"/>
881 <xsl:variable name="type" select="."/>
882 <xsl:choose>
883 <xsl:when test="$type = 'wstring' or $type = '$unknown' or $type = 'uuid'">
884 <xsl:text>yes</xsl:text>
885 </xsl:when>
886 <xsl:when test="../@safearray = 'yes'">
887 <xsl:text>yes</xsl:text>
888 </xsl:when>
889 <xsl:when test="$type = 'boolean' or $type = 'long' or $type = 'long' or $type = 'long long'"/> <!-- XXX: drop this? -->
890 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
891 <xsl:text>yes</xsl:text>
892 </xsl:when>
893 </xsl:choose>
894</xsl:template>
895
896<!-- Call this to get the argument conversion class, if any is needed. -->
897<xsl:template name="paramconversionclass">
898 <xsl:param name="dir"/>
899
900 <xsl:variable name="type" select="."/>
901 <xsl:choose>
902 <xsl:when test="$type='$unknown'">
903 <xsl:if test="../@safearray='yes'">
904 <xsl:text>Array</xsl:text>
905 </xsl:if>
906 <xsl:choose>
907 <xsl:when test="$dir='in'">
908 <xsl:text>ComTypeInConverter&lt;IUnknown&gt;</xsl:text>
909 </xsl:when>
910 <xsl:otherwise>
911 <xsl:text>ComTypeOutConverter&lt;IUnknown&gt;</xsl:text>
912 </xsl:otherwise>
913 </xsl:choose>
914 </xsl:when>
915
916 <xsl:when test="$type='wstring'">
917 <xsl:if test="../@safearray='yes'">
918 <xsl:text>Array</xsl:text>
919 </xsl:if>
920 <xsl:choose>
921 <xsl:when test="$dir='in'">
922 <xsl:text>BSTRInConverter</xsl:text>
923 </xsl:when>
924 <xsl:otherwise>
925 <xsl:text>BSTROutConverter</xsl:text>
926 </xsl:otherwise>
927 </xsl:choose>
928 </xsl:when>
929
930 <xsl:when test="$type='uuid'">
931 <xsl:if test="../@safearray='yes'">
932 <xsl:text>Array</xsl:text>
933 </xsl:if>
934 <xsl:choose>
935 <xsl:when test="$dir='in'">
936 <xsl:text>UuidInConverter</xsl:text>
937 </xsl:when>
938 <xsl:otherwise>
939 <xsl:text>UuidOutConverter</xsl:text>
940 </xsl:otherwise>
941 </xsl:choose>
942 </xsl:when>
943
944 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
945 <xsl:if test="../@safearray='yes'">
946 <xsl:text>Array</xsl:text>
947 </xsl:if>
948 <xsl:choose>
949 <xsl:when test="$dir='in'">
950 <xsl:text>ComTypeInConverter</xsl:text>
951 </xsl:when>
952 <xsl:otherwise>
953 <xsl:text>ComTypeOutConverter</xsl:text>
954 </xsl:otherwise>
955 </xsl:choose>
956 <xsl:value-of select="concat('&lt;', $type, '&gt;')"/>
957 </xsl:when>
958
959 <xsl:when test="../@safearray='yes'">
960 <xsl:text>Array</xsl:text>
961 <xsl:choose>
962 <xsl:when test="$dir='in'">
963 <xsl:text>InConverter</xsl:text>
964 </xsl:when>
965 <xsl:otherwise>
966 <xsl:text>OutConverter</xsl:text>
967 </xsl:otherwise>
968 </xsl:choose>
969 <xsl:variable name="gluetype">
970 <xsl:call-template name="translatepublictype">
971 <xsl:with-param name="type" select="."/>
972 <xsl:with-param name="dir" select="$dir"/>
973 <xsl:with-param name="mod" select="../@mod"/>
974 </xsl:call-template>
975 </xsl:variable>
976 <xsl:value-of select="concat('&lt;', $gluetype, '&gt;')"/>
977 </xsl:when>
978 </xsl:choose>
979</xsl:template>
980
981<!-- Emits code for converting the parameter to a temporary variable. -->
982<xsl:template match="attribute/@type | param/@type" mode="paramvalconversion2tmpvar">
983 <xsl:param name="dir"/>
984
985 <xsl:variable name="conversionclass">
986 <xsl:call-template name="paramconversionclass">
987 <xsl:with-param name="dir" select="$dir"/>
988 </xsl:call-template>
989 </xsl:variable>
990
991 <xsl:if test="$conversionclass != ''">
992 <xsl:value-of select="$conversionclass"/>
993 <xsl:text> Tmp</xsl:text>
994 <xsl:call-template name="capitalize">
995 <xsl:with-param name="str" select="../@name"/>
996 </xsl:call-template>
997 <xsl:text>(</xsl:text>
998 <xsl:if test="../@safearray = 'yes'">
999 <xsl:choose>
1000 <xsl:when test="$dir = 'in'">
1001 <xsl:text>ComSafeArrayInArg(</xsl:text>
1002 </xsl:when>
1003 <xsl:otherwise>
1004 <xsl:text>ComSafeArrayOutArg(</xsl:text>
1005 </xsl:otherwise>
1006 </xsl:choose>
1007 </xsl:if>
1008 <xsl:text>a</xsl:text>
1009 <xsl:call-template name="capitalize">
1010 <xsl:with-param name="str" select="../@name"/>
1011 </xsl:call-template>
1012 <xsl:if test="../@safearray = 'yes'">
1013 <xsl:text>)</xsl:text>
1014 </xsl:if>
1015 <xsl:text>);</xsl:text>
1016 </xsl:if>
1017
1018</xsl:template>
1019
1020<!-- Partner to paramvalconversion2tmpvar that emits the parameter when calling call the internal worker method. -->
1021<xsl:template match="attribute/@type | param/@type" mode="paramvalconversionusingtmp">
1022 <xsl:param name="dir"/>
1023
1024 <xsl:variable name="viatmpvar">
1025 <xsl:call-template name="paramconversionviatmp">
1026 <xsl:with-param name="dir" select="$dir"/>
1027 </xsl:call-template>
1028 </xsl:variable>
1029 <xsl:variable name="type" select="."/>
1030
1031 <xsl:choose>
1032 <xsl:when test="$viatmpvar = 'yes'">
1033 <xsl:text>Tmp</xsl:text>
1034 <xsl:call-template name="capitalize">
1035 <xsl:with-param name="str" select="../@name"/>
1036 </xsl:call-template>
1037
1038 <xsl:choose>
1039 <xsl:when test="../@safearray='yes'">
1040 <xsl:text>.array()</xsl:text>
1041 </xsl:when>
1042 <xsl:when test="$type = 'wstring'">
1043 <xsl:text>.str()</xsl:text>
1044 </xsl:when>
1045 <xsl:when test="$type = 'uuid'">
1046 <xsl:text>.uuid()</xsl:text>
1047 </xsl:when>
1048 <xsl:when test="$type = '$unknown'">
1049 <xsl:text>.ptr()</xsl:text>
1050 </xsl:when>
1051 <xsl:when test="count(key('G_keyInterfacesByName', $type)) > 0">
1052 <xsl:text>.ptr()</xsl:text>
1053 </xsl:when>
1054 <xsl:otherwise><xsl:message terminate="yes">Oops #1</xsl:message></xsl:otherwise>
1055 </xsl:choose>
1056 </xsl:when>
1057
1058 <xsl:otherwise>
1059 <xsl:text>a</xsl:text>
1060 <xsl:call-template name="capitalize">
1061 <xsl:with-param name="str" select="../@name"/>
1062 </xsl:call-template>
1063
1064 <!-- Make sure BOOL values we pass down are either TRUE or FALSE. -->
1065 <xsl:if test="$type = 'boolean' and $dir = 'in'">
1066 <xsl:text> != FALSE</xsl:text>
1067 </xsl:if>
1068 </xsl:otherwise>
1069 </xsl:choose>
1070
1071</xsl:template>
1072
1073<!-- - - - - - - - - - - - - - - - - - - - - - -
1074 emit attribute
1075 - - - - - - - - - - - - - - - - - - - - - - -->
1076
1077<xsl:template match="attribute" mode="public">
1078 <xsl:param name="target"/>
1079
1080 <xsl:call-template name="emitTargetBegin">
1081 <xsl:with-param name="target" select="$target"/>
1082 </xsl:call-template>
1083
1084 <xsl:variable name="attrbasename">
1085 <xsl:call-template name="capitalize">
1086 <xsl:with-param name="str" select="@name"/>
1087 </xsl:call-template>
1088 </xsl:variable>
1089
1090 <xsl:value-of select="concat(' STDMETHOD(COMGETTER(', $attrbasename, '))(')"/>
1091 <xsl:call-template name="emitPublicParameter">
1092 <xsl:with-param name="dir">out</xsl:with-param>
1093 </xsl:call-template>
1094 <xsl:text>);
1095</xsl:text>
1096
1097 <xsl:if test="not(@readonly) or @readonly!='yes'">
1098 <xsl:value-of select="concat(' STDMETHOD(COMSETTER(', $attrbasename, '))(')"/>
1099 <xsl:call-template name="emitPublicParameter">
1100 <xsl:with-param name="dir">in</xsl:with-param>
1101 </xsl:call-template>
1102 <xsl:text>);
1103</xsl:text>
1104 </xsl:if>
1105
1106 <xsl:call-template name="emitTargetEnd">
1107 <xsl:with-param name="target" select="$target"/>
1108 </xsl:call-template>
1109</xsl:template>
1110
1111<xsl:template match="attribute" mode="wrapped">
1112 <xsl:param name="target"/>
1113
1114 <xsl:call-template name="emitTargetBegin">
1115 <xsl:with-param name="target" select="$target"/>
1116 </xsl:call-template>
1117
1118 <xsl:variable name="attrbasename">
1119 <xsl:call-template name="capitalize">
1120 <xsl:with-param name="str" select="@name"/>
1121 </xsl:call-template>
1122 </xsl:variable>
1123
1124 <xsl:if test="$attrbasename = 'MidlDoesNotLikeEmptyInterfaces'">
1125 <xsl:text> //</xsl:text>
1126 </xsl:if>
1127
1128 <xsl:value-of select="concat(' virtual HRESULT get', $attrbasename, '(')"/>
1129 <xsl:variable name="passAutoCaller">
1130 <xsl:call-template name="checkoption">
1131 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1132 <xsl:with-param name="option" select="'passcaller'"/>
1133 </xsl:call-template>
1134 </xsl:variable>
1135 <xsl:if test="$passAutoCaller = 'true'">
1136 <xsl:text>AutoCaller &amp;aAutoCaller, </xsl:text>
1137 </xsl:if>
1138 <xsl:apply-templates select="@type" mode="wrapped">
1139 <xsl:with-param name="dir" select="'out'"/>
1140 </xsl:apply-templates>
1141 <xsl:text>) = 0;
1142</xsl:text>
1143
1144 <xsl:if test="not(@readonly) or @readonly!='yes'">
1145 <xsl:value-of select="concat(' virtual HRESULT set', $attrbasename, '(')"/>
1146 <xsl:if test="$passAutoCaller = 'true'">
1147 <xsl:text>AutoCaller &amp;aAutoCaller, </xsl:text>
1148 </xsl:if>
1149 <xsl:apply-templates select="@type" mode="wrapped">
1150 <xsl:with-param name="dir" select="'in'"/>
1151 </xsl:apply-templates>
1152 <xsl:text>) = 0;
1153</xsl:text>
1154 </xsl:if>
1155
1156 <xsl:call-template name="emitTargetEnd">
1157 <xsl:with-param name="target" select="$target"/>
1158 </xsl:call-template>
1159</xsl:template>
1160
1161<xsl:template match="attribute" mode="code">
1162 <xsl:param name="topclass"/>
1163 <xsl:param name="dtracetopclass"/>
1164 <xsl:param name="target"/>
1165
1166 <xsl:call-template name="emitTargetBegin">
1167 <xsl:with-param name="target" select="$target"/>
1168 </xsl:call-template>
1169
1170 <xsl:variable name="attrbasename">
1171 <xsl:call-template name="capitalize">
1172 <xsl:with-param name="str" select="@name"/>
1173 </xsl:call-template>
1174 </xsl:variable>
1175 <xsl:variable name="limitedAutoCaller">
1176 <xsl:call-template name="checkoption">
1177 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1178 <xsl:with-param name="option" select="'limitedcaller'"/>
1179 </xsl:call-template>
1180 </xsl:variable>
1181
1182 <xsl:variable name="dtraceattrname">
1183 <xsl:choose>
1184 <xsl:when test="@dtracename">
1185 <xsl:value-of select="@dtracename"/>
1186 </xsl:when>
1187 <xsl:otherwise>
1188 <xsl:value-of select="$attrbasename"/>
1189 </xsl:otherwise>
1190 </xsl:choose>
1191 </xsl:variable>
1192
1193 <xsl:value-of select="concat('STDMETHODIMP ', $topclass, 'Wrap::COMGETTER(', $attrbasename, ')(')"/>
1194 <xsl:call-template name="emitPublicParameter">
1195 <xsl:with-param name="dir">out</xsl:with-param>
1196 </xsl:call-template>
1197 <xsl:text>)
1198{</xsl:text>
1199 <xsl:if test="$attrbasename = 'MidlDoesNotLikeEmptyInterfaces'">
1200 <xsl:text>
1201#if 0 /* This is a dummy attribute */</xsl:text>
1202 </xsl:if>
1203 <xsl:text>
1204 LogRelFlow(("{%p} %s: enter </xsl:text>
1205 <xsl:apply-templates select="@type" mode="logparamtext">
1206 <xsl:with-param name="dir" select="'out'"/>
1207 <xsl:with-param name="isref" select="'yes'"/>
1208 </xsl:apply-templates>
1209 <xsl:text>\n", this, </xsl:text>
1210 <xsl:value-of select="concat('&quot;', $topclass, '::get', $attrbasename, '&quot;, ')"/>
1211 <xsl:apply-templates select="@type" mode="logparamval">
1212 <xsl:with-param name="dir" select="'out'"/>
1213 <xsl:with-param name="isref" select="'yes'"/>
1214 </xsl:apply-templates>
1215 <xsl:text>));
1216
1217 VirtualBoxBase::clearError();
1218
1219 HRESULT hrc;
1220
1221 try
1222 {
1223 CheckComArgOutPointerValidThrow(a</xsl:text>
1224 <xsl:value-of select="$attrbasename"/>
1225 <xsl:text>);
1226 </xsl:text>
1227 <xsl:apply-templates select="@type" mode="paramvalconversion2tmpvar">
1228 <xsl:with-param name="dir" select="'out'"/>
1229 </xsl:apply-templates>
1230 <xsl:if test="$attrbasename != 'MidlDoesNotLikeEmptyInterfaces'">
1231 <xsl:text>
1232#ifdef VBOX_WITH_DTRACE_R3_MAIN
1233 </xsl:text>
1234 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_GET_', $dtraceattrname, '_ENTER('), $G_lowerCase, $G_upperCase)"/>
1235 <xsl:text>this);
1236#endif</xsl:text>
1237 </xsl:if>
1238 <xsl:text>
1239 </xsl:text>
1240 <xsl:choose>
1241 <xsl:when test="$limitedAutoCaller = 'true'">
1242 <xsl:text>AutoLimitedCaller</xsl:text>
1243 </xsl:when>
1244 <xsl:otherwise>
1245 <xsl:text>AutoCaller</xsl:text>
1246 </xsl:otherwise>
1247 </xsl:choose>
1248 <xsl:text> autoCaller(this);
1249 hrc = autoCaller.rc();
1250 if (SUCCEEDED(hrc))
1251 {
1252</xsl:text>
1253 <xsl:value-of select="concat(' hrc = get', $attrbasename, '(')"/>
1254 <xsl:variable name="passAutoCaller">
1255 <xsl:call-template name="checkoption">
1256 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1257 <xsl:with-param name="option" select="'passcaller'"/>
1258 </xsl:call-template>
1259 </xsl:variable>
1260 <xsl:if test="$passAutoCaller = 'true'">
1261 <xsl:text>autoCaller, </xsl:text>
1262 </xsl:if>
1263 <xsl:apply-templates select="@type" mode="paramvalconversionusingtmp">
1264 <xsl:with-param name="dir" select="'out'"/>
1265 </xsl:apply-templates>
1266 <xsl:text>);
1267 }</xsl:text>
1268 <xsl:if test="$attrbasename != 'MidlDoesNotLikeEmptyInterfaces'">
1269 <xsl:text>
1270#ifdef VBOX_WITH_DTRACE_R3_MAIN
1271 </xsl:text>
1272 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_GET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1273 <xsl:text>this, hrc, 0 /*normal*/,</xsl:text>
1274 <xsl:call-template name="emitDTraceParamValue">
1275 <xsl:with-param name="dir">out</xsl:with-param>
1276 </xsl:call-template>
1277 <xsl:text>);
1278#endif</xsl:text>
1279 </xsl:if>
1280 <xsl:text>
1281 }
1282 catch (HRESULT hrc2)
1283 {
1284 hrc = hrc2;</xsl:text>
1285 <xsl:if test="$attrbasename != 'MidlDoesNotLikeEmptyInterfaces'">
1286 <xsl:text>
1287#ifdef VBOX_WITH_DTRACE_R3_MAIN
1288 </xsl:text>
1289 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_GET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1290 <xsl:text>this, hrc, 1 /*hrc exception*/,</xsl:text>
1291 <xsl:call-template name="emitDTraceParamValNoTmp-DirNotIn"/>
1292 <xsl:text>);
1293#endif</xsl:text>
1294 </xsl:if>
1295 <xsl:text>
1296 }
1297 catch (...)
1298 {
1299 hrc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);</xsl:text>
1300 <xsl:if test="$attrbasename != 'MidlDoesNotLikeEmptyInterfaces'">
1301 <xsl:text>
1302#ifdef VBOX_WITH_DTRACE_R3_MAIN
1303 </xsl:text>
1304 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_GET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1305 <xsl:text>this, hrc, 9 /*unhandled exception*/,</xsl:text>
1306 <xsl:call-template name="emitDTraceParamValNoTmp-DirNotIn"/>
1307 <xsl:text>);
1308#endif</xsl:text>
1309 </xsl:if>
1310 <xsl:text>
1311 }
1312
1313 LogRelFlow(("{%p} %s: leave </xsl:text>
1314 <xsl:apply-templates select="@type" mode="logparamtext">
1315 <xsl:with-param name="dir" select="'out'"/>
1316 <xsl:with-param name="isref" select="''"/>
1317 </xsl:apply-templates>
1318 <xsl:text> hrc=%Rhrc\n", this, </xsl:text>
1319 <xsl:value-of select="concat('&quot;', $topclass, '::get', $dtraceattrname, '&quot;, ')"/>
1320 <xsl:apply-templates select="@type" mode="logparamval">
1321 <xsl:with-param name="dir" select="'out'"/>
1322 <xsl:with-param name="isref" select="''"/>
1323 </xsl:apply-templates>
1324 <xsl:text>, hrc));
1325 return hrc;</xsl:text>
1326 <xsl:if test="$attrbasename = 'MidlDoesNotLikeEmptyInterfaces'">
1327 <xsl:text>
1328#else /* dummy attribute */
1329 return E_FAIL;
1330#endif /* dummy attribute */</xsl:text>
1331 </xsl:if>
1332 <xsl:text>
1333}
1334</xsl:text>
1335 <xsl:if test="not(@readonly) or @readonly!='yes'">
1336 <xsl:text>
1337</xsl:text>
1338 <xsl:value-of select="concat('STDMETHODIMP ', $topclass, 'Wrap::COMSETTER(', $attrbasename, ')(')"/>
1339 <xsl:call-template name="emitPublicParameter">
1340 <xsl:with-param name="dir">in</xsl:with-param>
1341 </xsl:call-template>
1342 <!-- @todo check in parameters if possible -->
1343 <xsl:text>)
1344{
1345 LogRelFlow(("{%p} %s: enter </xsl:text>
1346 <xsl:apply-templates select="@type" mode="logparamtext">
1347 <xsl:with-param name="dir" select="'in'"/>
1348 <xsl:with-param name="isref" select="''"/>
1349 </xsl:apply-templates>
1350 <xsl:text>\n", this, </xsl:text>
1351 <xsl:value-of select="concat('&quot;', $topclass, '::set', $attrbasename, '&quot;, ')"/>
1352 <xsl:apply-templates select="@type" mode="logparamval">
1353 <xsl:with-param name="dir" select="'in'"/>
1354 <xsl:with-param name="isref" select="''"/>
1355 </xsl:apply-templates>
1356 <xsl:text>));
1357
1358 VirtualBoxBase::clearError();
1359
1360 HRESULT hrc;
1361
1362 try
1363 {
1364 </xsl:text>
1365 <xsl:apply-templates select="@type" mode="paramvalconversion2tmpvar">
1366 <xsl:with-param name="dir" select="'in'"/>
1367 </xsl:apply-templates>
1368 <xsl:text>
1369
1370#ifdef VBOX_WITH_DTRACE_R3_MAIN
1371 </xsl:text>
1372 <xsl:value-of select="translate(concat('VBOXAPI_', $topclass, '_SET_', $dtraceattrname, '_ENTER('), $G_lowerCase, $G_upperCase)"/>
1373 <xsl:text>this, </xsl:text>
1374 <xsl:call-template name="emitDTraceParamValue">
1375 <xsl:with-param name="dir">in</xsl:with-param>
1376 </xsl:call-template>
1377 <xsl:text>);
1378#endif
1379 </xsl:text>
1380 <xsl:choose>
1381 <xsl:when test="$limitedAutoCaller = 'true'">
1382 <xsl:text>AutoLimitedCaller</xsl:text>
1383 </xsl:when>
1384 <xsl:otherwise>
1385 <xsl:text>AutoCaller</xsl:text>
1386 </xsl:otherwise>
1387 </xsl:choose>
1388 <xsl:text> autoCaller(this);
1389 hrc = autoCaller.rc();
1390 if (SUCCEEDED(hrc))
1391 {
1392</xsl:text>
1393 <xsl:value-of select="concat(' hrc = set', $attrbasename, '(')"/>
1394 <xsl:if test="$passAutoCaller = 'true'">
1395 <xsl:text>autoCaller, </xsl:text>
1396 </xsl:if>
1397 <xsl:apply-templates select="@type" mode="paramvalconversionusingtmp">
1398 <xsl:with-param name="dir" select="'in'"/>
1399 </xsl:apply-templates>
1400 <xsl:text>);
1401 }
1402#ifdef VBOX_WITH_DTRACE_R3_MAIN
1403 </xsl:text>
1404 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_SET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1405 <xsl:text>this, hrc, 0 /*normal*/,</xsl:text>
1406 <xsl:call-template name="emitDTraceParamValue">
1407 <xsl:with-param name="dir">in</xsl:with-param>
1408 </xsl:call-template>
1409 <xsl:text>);
1410#endif
1411 }
1412 catch (HRESULT hrc2)
1413 {
1414 hrc = hrc2;
1415#ifdef VBOX_WITH_DTRACE_R3_MAIN
1416 </xsl:text>
1417 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_SET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1418 <xsl:text>this, hrc, 1 /*hrc exception*/,</xsl:text>
1419 <xsl:call-template name="emitDTraceParamValNoTmp-DirIn"/>
1420 <xsl:text>);
1421#endif
1422 }
1423 catch (...)
1424 {
1425 hrc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
1426#ifdef VBOX_WITH_DTRACE_R3_MAIN
1427 </xsl:text>
1428 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_SET_', $dtraceattrname, '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1429 <xsl:text>this, hrc, 9 /*unhandled exception*/,</xsl:text>
1430 <xsl:call-template name="emitDTraceParamValNoTmp-DirIn"/>
1431 <xsl:text>);
1432#endif
1433 }
1434
1435 LogRelFlow(("{%p} %s: leave hrc=%Rhrc\n", this, </xsl:text>
1436 <xsl:value-of select="concat('&quot;', $topclass, '::set', $attrbasename, '&quot;, ')"/>
1437 <xsl:text>hrc));
1438 return hrc;
1439}
1440</xsl:text>
1441 </xsl:if>
1442
1443 <xsl:call-template name="emitTargetEnd">
1444 <xsl:with-param name="target" select="$target"/>
1445 </xsl:call-template>
1446
1447 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1448</xsl:template>
1449
1450<!-- - - - - - - - - - - - - - - - - - - - - - -
1451 Emit DTrace probes for the given attribute.
1452 - - - - - - - - - - - - - - - - - - - - - - -->
1453<xsl:template match="attribute" mode="dtrace-probes">
1454 <xsl:param name="topclass"/>
1455 <xsl:param name="dtracetopclass"/>
1456 <xsl:param name="target"/>
1457
1458 <xsl:variable name="dtraceattrname">
1459 <xsl:choose>
1460 <xsl:when test="@dtracename">
1461 <xsl:value-of select="@dtracename"/>
1462 </xsl:when>
1463 <xsl:otherwise>
1464 <!-- attrbasename -->
1465 <xsl:call-template name="capitalize">
1466 <xsl:with-param name="str" select="@name"/>
1467 </xsl:call-template>
1468 </xsl:otherwise>
1469 </xsl:choose>
1470 </xsl:variable>
1471
1472 <xsl:if test="@name != 'midlDoesNotLikeEmptyInterfaces'">
1473 <xsl:text> probe </xsl:text>
1474 <!-- <xsl:value-of select="concat($dtracetopclass, '__get__', $dtraceattrname, '__enter(struct ', $topclass)"/> -->
1475 <xsl:value-of select="concat($dtracetopclass, '__get__', $dtraceattrname, '__enter(void')"/>
1476 <xsl:text> *a_pThis);
1477 probe </xsl:text>
1478 <!-- <xsl:value-of select="concat($dtracetopclass, '__get__', $dtraceattrname, '__return(struct ', $topclass, ' *a_pThis')"/> -->
1479 <xsl:value-of select="concat($dtracetopclass, '__get__', $dtraceattrname, '__return(void *a_pThis')"/>
1480 <xsl:text>, uint32_t a_hrc, int32_t enmWhy, </xsl:text>
1481 <xsl:apply-templates select="@type" mode="dtraceparamdecl">
1482 <xsl:with-param name="dir">out</xsl:with-param>
1483 </xsl:apply-templates>
1484 <xsl:text>);
1485</xsl:text>
1486 </xsl:if>
1487 <xsl:if test="(not(@readonly) or @readonly!='yes') and @name != 'midlDoesNotLikeEmptyInterfaces'">
1488 <xsl:text> probe </xsl:text>
1489 <!-- <xsl:value-of select="concat($topclass, '__set__', $dtraceattrname, '__enter(struct ', $topclass, ' *a_pThis, ')"/>-->
1490 <xsl:value-of select="concat($topclass, '__set__', $dtraceattrname, '__enter(void *a_pThis, ')"/>
1491 <xsl:apply-templates select="@type" mode="dtraceparamdecl">
1492 <xsl:with-param name="dir" select="'in'"/>
1493 </xsl:apply-templates>
1494 <xsl:text>);
1495 probe </xsl:text>
1496 <!-- <xsl:value-of select="concat($dtracetopclass, '__set__', $dtraceattrname, '__return(struct ', $topclass, ' *a_pThis')"/> -->
1497 <xsl:value-of select="concat($dtracetopclass, '__set__', $dtraceattrname, '__return(void *a_pThis')"/>
1498 <xsl:text>, uint32_t a_hrc, int32_t enmWhy, </xsl:text>
1499 <xsl:apply-templates select="@type" mode="dtraceparamdecl">
1500 <xsl:with-param name="dir">in</xsl:with-param>
1501 </xsl:apply-templates>
1502 <xsl:text>);
1503</xsl:text>
1504 </xsl:if>
1505</xsl:template>
1506
1507<!-- - - - - - - - - - - - - - - - - - - - - - -
1508 Emit all attributes of an interface (current node).
1509 - - - - - - - - - - - - - - - - - - - - - - -->
1510<xsl:template name="emitAttributes">
1511 <xsl:param name="topclass"/>
1512 <xsl:param name="dtracetopclass"/>
1513 <xsl:param name="pmode"/>
1514
1515 <xsl:variable name="name" select="@name"/>
1516 <!-- first recurse to emit all base interfaces -->
1517 <xsl:variable name="extends" select="@extends"/>
1518 <xsl:if test="$extends and not($extends='$unknown') and not($extends='$errorinfo')">
1519 <xsl:for-each select="key('G_keyInterfacesByName', $extends)">
1520 <xsl:call-template name="emitAttributes">
1521 <xsl:with-param name="topclass" select="$topclass"/>
1522 <xsl:with-param name="pmode" select="$pmode"/>
1523 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
1524 </xsl:call-template>
1525 </xsl:for-each>
1526 </xsl:if>
1527
1528 <xsl:choose>
1529 <xsl:when test="$pmode='code'">
1530 <xsl:text>//
1531</xsl:text>
1532 <xsl:value-of select="concat('// ', $name, ' properties')"/>
1533 <xsl:text>
1534//
1535
1536</xsl:text>
1537 </xsl:when>
1538 <xsl:when test="$pmode != 'dtrace-probes'">
1539 <xsl:value-of select="concat($G_sNewLine, ' // ', $pmode, ' ', $name, ' properties', $G_sNewLine)"/>
1540 </xsl:when>
1541 </xsl:choose>
1542 <xsl:choose>
1543 <xsl:when test="$pmode='public'">
1544 <xsl:apply-templates select="./attribute | ./if" mode="public">
1545 <xsl:with-param name="emitmode" select="'attribute'"/>
1546 </xsl:apply-templates>
1547 <xsl:variable name="reservedAttributes" select="@reservedAttributes"/>
1548 <xsl:if test="$reservedAttributes > 0">
1549 <!-- tricky way to do a "for" loop without recursion -->
1550 <xsl:for-each select="(//*)[position() &lt;= $reservedAttributes]">
1551 <xsl:text> STDMETHOD(COMGETTER(InternalAndReservedAttribute</xsl:text>
1552 <xsl:value-of select="concat(position(), $name)"/>
1553 <xsl:text>))(ULONG *aReserved);&#x0A;</xsl:text>
1554 </xsl:for-each>
1555 </xsl:if>
1556 </xsl:when>
1557 <xsl:when test="$pmode='wrapped'">
1558 <xsl:apply-templates select="./attribute | ./if" mode="wrapped">
1559 <xsl:with-param name="emitmode" select="'attribute'"/>
1560 </xsl:apply-templates>
1561 </xsl:when>
1562 <xsl:when test="$pmode='code'">
1563 <xsl:apply-templates select="./attribute | ./if" mode="code">
1564 <xsl:with-param name="topclass" select="$topclass"/>
1565 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
1566 <xsl:with-param name="emitmode" select="'attribute'"/>
1567 </xsl:apply-templates>
1568 <xsl:variable name="reservedAttributes" select="@reservedAttributes"/>
1569 <xsl:if test="$reservedAttributes > 0">
1570 <!-- tricky way to do a "for" loop without recursion -->
1571 <xsl:for-each select="(//*)[position() &lt;= $reservedAttributes]">
1572 <xsl:value-of select="concat('STDMETHODIMP ', $topclass, 'Wrap::COMGETTER(InternalAndReservedAttribute', position(), $name, ')(ULONG *aReserved)&#x0A;')"/>
1573 <xsl:text>{
1574 NOREF(aReserved);
1575 return E_NOTIMPL;
1576}
1577
1578</xsl:text>
1579 </xsl:for-each>
1580 </xsl:if>
1581 </xsl:when>
1582 <xsl:when test="$pmode = 'dtrace-probes'">
1583 <xsl:apply-templates select="./attribute | ./if" mode="dtrace-probes">
1584 <xsl:with-param name="topclass" select="$topclass"/>
1585 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
1586 <xsl:with-param name="emitmode" select="'attribute'"/>
1587 </xsl:apply-templates>
1588 </xsl:when>
1589 <xsl:otherwise><xsl:message terminate="yes">Otherwise oops in emitAttributes</xsl:message></xsl:otherwise>
1590 </xsl:choose>
1591</xsl:template>
1592
1593<xsl:template name="emitTargetBegin">
1594 <xsl:param name="target"/>
1595
1596 <xsl:choose>
1597 <xsl:when test="$target = ''"/>
1598 <xsl:when test="$target = 'xpidl'">
1599 <xsl:text>#ifdef VBOX_WITH_XPCOM
1600</xsl:text>
1601 </xsl:when>
1602 <xsl:when test="$target = 'midl'">
1603 <xsl:text>#ifndef VBOX_WITH_XPCOM
1604</xsl:text>
1605 </xsl:when>
1606 <xsl:otherwise><xsl:message terminate="yes">Otherwise oops in emitTargetBegin: target=<xsl:value-of select="$target"/></xsl:message></xsl:otherwise>
1607 </xsl:choose>
1608</xsl:template>
1609
1610<xsl:template name="emitTargetEnd">
1611 <xsl:param name="target"/>
1612
1613 <xsl:choose>
1614 <xsl:when test="$target = ''"/>
1615 <xsl:when test="$target = 'xpidl'">
1616 <xsl:text>#endif /* VBOX_WITH_XPCOM */
1617</xsl:text>
1618 </xsl:when>
1619 <xsl:when test="$target = 'midl'">
1620 <xsl:text>#endif /* !VBOX_WITH_XPCOM */
1621</xsl:text>
1622 </xsl:when>
1623 <xsl:otherwise><xsl:message terminate="yes">Otherwise oops in emitTargetEnd target=<xsl:value-of select="$target"/></xsl:message></xsl:otherwise>
1624 </xsl:choose>
1625</xsl:template>
1626
1627
1628<!-- - - - - - - - - - - - - - - - - - - - - - -
1629 emit method
1630 - - - - - - - - - - - - - - - - - - - - - - -->
1631
1632<xsl:template match="method" mode="public">
1633 <xsl:param name="target"/>
1634
1635 <xsl:call-template name="emitTargetBegin">
1636 <xsl:with-param name="target" select="$target"/>
1637 </xsl:call-template>
1638
1639 <xsl:variable name="methodindent">
1640 <xsl:call-template name="tospace">
1641 <xsl:with-param name="str" select="@name"/>
1642 </xsl:call-template>
1643 </xsl:variable>
1644
1645 <xsl:text> STDMETHOD(</xsl:text>
1646 <xsl:call-template name="capitalize">
1647 <xsl:with-param name="str" select="@name"/>
1648 </xsl:call-template>
1649 <xsl:text>)(</xsl:text>
1650 <xsl:for-each select="param">
1651 <xsl:call-template name="emitPublicParameter">
1652 <xsl:with-param name="dir" select="@dir"/>
1653 </xsl:call-template>
1654 <xsl:if test="not(position()=last())">
1655 <xsl:text>,
1656 </xsl:text>
1657 <xsl:value-of select="$methodindent"/>
1658 </xsl:if>
1659 </xsl:for-each>
1660 <xsl:text>);
1661</xsl:text>
1662
1663 <xsl:call-template name="emitTargetEnd">
1664 <xsl:with-param name="target" select="$target"/>
1665 </xsl:call-template>
1666</xsl:template>
1667
1668<xsl:template match="method" mode="wrapped">
1669 <xsl:param name="target"/>
1670
1671 <xsl:call-template name="emitTargetBegin">
1672 <xsl:with-param name="target" select="$target"/>
1673 </xsl:call-template>
1674
1675 <xsl:variable name="methodindent">
1676 <xsl:call-template name="tospace">
1677 <xsl:with-param name="str" select="@name"/>
1678 </xsl:call-template>
1679 </xsl:variable>
1680
1681 <xsl:text> virtual HRESULT </xsl:text>
1682 <xsl:call-template name="uncapitalize">
1683 <xsl:with-param name="str" select="@name"/>
1684 </xsl:call-template>
1685 <xsl:text>(</xsl:text>
1686 <xsl:variable name="passAutoCaller">
1687 <xsl:call-template name="checkoption">
1688 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1689 <xsl:with-param name="option" select="'passcaller'"/>
1690 </xsl:call-template>
1691 </xsl:variable>
1692 <xsl:if test="$passAutoCaller = 'true'">
1693 <xsl:text>AutoCaller &amp;aAutoCaller</xsl:text>
1694 <xsl:if test="count(param) > 0">
1695 <xsl:text>,
1696 </xsl:text>
1697 <xsl:value-of select="$methodindent"/>
1698 </xsl:if>
1699 </xsl:if>
1700 <xsl:for-each select="param">
1701 <xsl:apply-templates select="@type" mode="wrapped">
1702 <xsl:with-param name="dir" select="@dir"/>
1703 </xsl:apply-templates>
1704 <xsl:if test="not(position()=last())">
1705 <xsl:text>,
1706 </xsl:text>
1707 <xsl:value-of select="$methodindent"/>
1708 </xsl:if>
1709 </xsl:for-each>
1710 <xsl:text>) = 0;
1711</xsl:text>
1712
1713 <xsl:call-template name="emitTargetEnd">
1714 <xsl:with-param name="target" select="$target"/>
1715 </xsl:call-template>
1716</xsl:template>
1717
1718<xsl:template match="method" mode="code">
1719 <xsl:param name="topclass"/>
1720 <xsl:param name="dtracetopclass"/>
1721 <xsl:param name="target"/>
1722
1723 <xsl:call-template name="emitTargetBegin">
1724 <xsl:with-param name="target" select="$target"/>
1725 </xsl:call-template>
1726
1727 <xsl:variable name="methodindent">
1728 <xsl:call-template name="tospace">
1729 <xsl:with-param name="str" select="@name"/>
1730 </xsl:call-template>
1731 </xsl:variable>
1732 <xsl:variable name="methodclassindent">
1733 <xsl:call-template name="tospace">
1734 <xsl:with-param name="str" select="concat($topclass, @name)"/>
1735 </xsl:call-template>
1736 </xsl:variable>
1737 <xsl:variable name="methodbasename">
1738 <xsl:call-template name="capitalize">
1739 <xsl:with-param name="str" select="@name"/>
1740 </xsl:call-template>
1741 </xsl:variable>
1742 <xsl:variable name="limitedAutoCaller">
1743 <xsl:call-template name="checkoption">
1744 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1745 <xsl:with-param name="option" select="'limitedcaller'"/>
1746 </xsl:call-template>
1747 </xsl:variable>
1748 <xsl:variable name="dtracemethodname">
1749 <xsl:choose>
1750 <xsl:when test="@dtracename">
1751 <xsl:value-of select="@dtracename"/>
1752 </xsl:when>
1753 <xsl:otherwise>
1754 <xsl:value-of select="@name"/>
1755 </xsl:otherwise>
1756 </xsl:choose>
1757 </xsl:variable>
1758 <xsl:variable name="dtracenamehack"> <!-- Ugly hack to deal with Session::assignMachine and similar. -->
1759 <xsl:if test="name(..) = 'if'">
1760 <xsl:value-of select="concat('__', ../@target)"/>
1761 </xsl:if>
1762 </xsl:variable>
1763
1764 <xsl:value-of select="concat('STDMETHODIMP ', $topclass, 'Wrap::', $methodbasename, '(')"/>
1765 <xsl:for-each select="param">
1766 <xsl:call-template name="emitPublicParameter">
1767 <xsl:with-param name="dir" select="@dir"/>
1768 </xsl:call-template>
1769 <xsl:if test="not(position()=last())">
1770 <xsl:text>,
1771 </xsl:text>
1772 <xsl:value-of select="$methodclassindent"/>
1773 </xsl:if>
1774 </xsl:for-each>
1775 <xsl:text>)
1776{
1777 LogRelFlow(("{%p} %s:enter</xsl:text>
1778 <xsl:for-each select="param">
1779 <xsl:text> </xsl:text>
1780 <xsl:apply-templates select="@type" mode="logparamtext">
1781 <xsl:with-param name="dir" select="@dir"/>
1782 <xsl:with-param name="isref" select="'yes'"/>
1783 </xsl:apply-templates>
1784 </xsl:for-each>
1785 <xsl:text>\n", this</xsl:text>
1786 <xsl:value-of select="concat(', &quot;', $topclass, '::', @name, '&quot;')"/>
1787 <xsl:for-each select="param">
1788 <xsl:text>, </xsl:text>
1789 <xsl:apply-templates select="@type" mode="logparamval">
1790 <xsl:with-param name="dir" select="@dir"/>
1791 <xsl:with-param name="isref" select="'yes'"/>
1792 </xsl:apply-templates>
1793 </xsl:for-each>
1794 <xsl:text>));
1795
1796 VirtualBoxBase::clearError();
1797
1798 HRESULT hrc;
1799
1800 try
1801 {
1802</xsl:text>
1803 <!-- @todo check in parameters if possible -->
1804 <xsl:for-each select="param">
1805 <xsl:if test="@dir!='in'">
1806 <xsl:text> CheckComArgOutPointerValidThrow(a</xsl:text>
1807 <xsl:call-template name="capitalize">
1808 <xsl:with-param name="str" select="@name"/>
1809 </xsl:call-template>
1810 <xsl:text>);
1811</xsl:text>
1812 </xsl:if>
1813 </xsl:for-each>
1814<xsl:text>
1815</xsl:text>
1816 <xsl:for-each select="param">
1817 <xsl:text>
1818 </xsl:text>
1819 <xsl:apply-templates select="@type" mode="paramvalconversion2tmpvar">
1820 <xsl:with-param name="dir" select="@dir"/>
1821 </xsl:apply-templates>
1822 </xsl:for-each>
1823 <xsl:text>
1824
1825#ifdef VBOX_WITH_DTRACE_R3_MAIN
1826 </xsl:text>
1827 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_', $dtracemethodname, substring($dtracenamehack, 2), '_ENTER('), $G_lowerCase, $G_upperCase)"/>
1828 <xsl:text>this</xsl:text>
1829 <xsl:for-each select="param[@dir='in']">
1830 <xsl:text>, </xsl:text>
1831 <xsl:call-template name="emitDTraceParamValue">
1832 <xsl:with-param name="dir" select="@dir"/>
1833 </xsl:call-template>
1834 </xsl:for-each>
1835 <xsl:text>);
1836#endif
1837 </xsl:text>
1838 <xsl:choose>
1839 <xsl:when test="$limitedAutoCaller = 'true'">
1840 <xsl:text>AutoLimitedCaller</xsl:text>
1841 </xsl:when>
1842 <xsl:otherwise>
1843 <xsl:text>AutoCaller</xsl:text>
1844 </xsl:otherwise>
1845 </xsl:choose>
1846 <xsl:text> autoCaller(this);
1847 hrc = autoCaller.rc();
1848 if (SUCCEEDED(hrc))
1849 {
1850</xsl:text>
1851 <xsl:value-of select="concat(' hrc = ', @name, '(')"/>
1852 <xsl:variable name="passAutoCaller">
1853 <xsl:call-template name="checkoption">
1854 <xsl:with-param name="optionlist" select="@wrap-hint-server"/>
1855 <xsl:with-param name="option" select="'passcaller'"/>
1856 </xsl:call-template>
1857 </xsl:variable>
1858 <xsl:if test="$passAutoCaller = 'true'">
1859 <xsl:text>autoCaller</xsl:text>
1860 <xsl:if test="count(param) > 0">
1861 <xsl:text>,
1862 </xsl:text>
1863 <xsl:value-of select="$methodindent"/>
1864 </xsl:if>
1865 </xsl:if>
1866 <xsl:for-each select="param">
1867 <xsl:apply-templates select="@type" mode="paramvalconversionusingtmp">
1868 <xsl:with-param name="dir" select="@dir"/>
1869 </xsl:apply-templates>
1870 <xsl:if test="not(position()=last())">
1871 <xsl:text>,
1872 </xsl:text>
1873 <xsl:value-of select="$methodindent"/>
1874 </xsl:if>
1875 </xsl:for-each>
1876 <xsl:text>);
1877 }
1878#ifdef VBOX_WITH_DTRACE_R3_MAIN
1879 </xsl:text>
1880 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_', $dtracemethodname, substring($dtracenamehack, 2), '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1881 <xsl:text>this, hrc, 0 /*normal*/</xsl:text>
1882 <xsl:for-each select="param">
1883 <xsl:text>, </xsl:text>
1884 <xsl:call-template name="emitDTraceParamValue">
1885 <xsl:with-param name="dir" select="@dir"/>
1886 </xsl:call-template>
1887 </xsl:for-each>
1888 <xsl:text>);
1889#endif
1890 }
1891 catch (HRESULT hrc2)
1892 {
1893 hrc = hrc2;
1894#ifdef VBOX_WITH_DTRACE_R3_MAIN
1895 </xsl:text>
1896 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_', $dtracemethodname, substring($dtracenamehack, 2), '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1897 <xsl:text>this, hrc, 1 /*hrc exception*/</xsl:text>
1898 <xsl:for-each select="param">
1899 <xsl:text>, </xsl:text>
1900 <xsl:call-template name="emitDTraceParamValNoTmp"/>
1901 </xsl:for-each>
1902 <xsl:text>);
1903#endif
1904 }
1905 catch (...)
1906 {
1907 hrc = VirtualBoxBase::handleUnexpectedExceptions(this, RT_SRC_POS);
1908#ifdef VBOX_WITH_DTRACE_R3_MAIN
1909 </xsl:text>
1910 <xsl:value-of select="translate(concat('VBOXAPI_', $dtracetopclass, '_', $dtracemethodname, substring($dtracenamehack, 2), '_RETURN('), $G_lowerCase, $G_upperCase)"/>
1911 <xsl:text>this, hrc, 9 /*unhandled exception*/</xsl:text>
1912 <xsl:for-each select="param">
1913 <xsl:text>, </xsl:text>
1914 <xsl:call-template name="emitDTraceParamValNoTmp"/>
1915 </xsl:for-each>
1916 <xsl:text>);
1917#endif
1918 }
1919
1920 LogRelFlow(("{%p} %s: leave</xsl:text>
1921 <xsl:for-each select="param">
1922 <xsl:if test="@dir!='in'">
1923 <xsl:text> </xsl:text>
1924 <xsl:apply-templates select="@type" mode="logparamtext">
1925 <xsl:with-param name="dir" select="@dir"/>
1926 <xsl:with-param name="isref" select="''"/>
1927 </xsl:apply-templates>
1928 </xsl:if>
1929 </xsl:for-each>
1930 <xsl:text> hrc=%Rhrc\n", this</xsl:text>
1931 <xsl:value-of select="concat(', &quot;', $topclass, '::', @name, '&quot;')"/>
1932 <xsl:for-each select="param">
1933 <xsl:if test="@dir!='in'">
1934 <xsl:text>, </xsl:text>
1935 <xsl:apply-templates select="@type" mode="logparamval">
1936 <xsl:with-param name="dir" select="@dir"/>
1937 <xsl:with-param name="isref" select="''"/>
1938 </xsl:apply-templates>
1939 </xsl:if>
1940 </xsl:for-each>
1941 <xsl:text>, hrc));
1942 return hrc;
1943}
1944</xsl:text>
1945
1946 <xsl:call-template name="emitTargetEnd">
1947 <xsl:with-param name="target" select="$target"/>
1948 </xsl:call-template>
1949
1950 <xsl:text>
1951</xsl:text>
1952</xsl:template>
1953
1954<!-- - - - - - - - - - - - - - - - - - - - - - -
1955 Emits the DTrace probes for a method.
1956 - - - - - - - - - - - - - - - - - - - - - - -->
1957<xsl:template match="method" mode="dtrace-probes">
1958 <xsl:param name="topclass"/>
1959 <xsl:param name="dtracetopclass"/>
1960 <xsl:param name="target"/>
1961
1962 <xsl:variable name="dtracemethodname">
1963 <xsl:choose>
1964 <xsl:when test="@dtracename">
1965 <xsl:value-of select="@dtracename"/>
1966 </xsl:when>
1967 <xsl:otherwise>
1968 <xsl:value-of select="@name"/>
1969 </xsl:otherwise>
1970 </xsl:choose>
1971 </xsl:variable>
1972 <xsl:variable name="dtracenamehack"> <!-- Ugly hack to deal with Session::assignMachine and similar. -->
1973 <xsl:if test="name(..) = 'if'">
1974 <xsl:value-of select="concat('__', ../@target)"/>
1975 </xsl:if>
1976 </xsl:variable>
1977
1978 <xsl:text> probe </xsl:text>
1979 <!-- <xsl:value-of select="concat($dtracetopclass, '__', $dtracemethodname, $dtracenamehack, '__enter(struct ', $dtracetopclass, ' *a_pThis')"/> -->
1980 <xsl:value-of select="concat($dtracetopclass, '__', $dtracemethodname, $dtracenamehack, '__enter(void *a_pThis')"/>
1981 <xsl:for-each select="param[@dir='in']">
1982 <xsl:text>, </xsl:text>
1983 <xsl:apply-templates select="@type" mode="dtraceparamdecl">
1984 <xsl:with-param name="dir" select="'@dir'"/>
1985 </xsl:apply-templates>
1986 </xsl:for-each>
1987 <xsl:text>);
1988 probe </xsl:text>
1989 <!-- <xsl:value-of select="concat($dtracetopclass, '__', $dtracemethodname, '__return(struct ', $dtracetopclass, ' *a_pThis')"/> -->
1990 <xsl:value-of select="concat($dtracetopclass, '__', $dtracemethodname, $dtracenamehack, '__return(void *a_pThis')"/>
1991 <xsl:text>, uint32_t a_hrc, int32_t enmWhy</xsl:text>
1992 <xsl:for-each select="param">
1993 <xsl:text>, </xsl:text>
1994 <xsl:apply-templates select="@type" mode="dtraceparamdecl">
1995 <xsl:with-param name="dir" select="'@dir'"/>
1996 </xsl:apply-templates>
1997 </xsl:for-each>
1998 <xsl:text>);
1999</xsl:text>
2000
2001</xsl:template>
2002
2003
2004<xsl:template name="emitIf">
2005 <xsl:param name="passmode"/>
2006 <xsl:param name="target"/>
2007 <xsl:param name="topclass"/>
2008 <xsl:param name="emitmode"/>
2009 <xsl:param name="dtracetopclass"/>
2010
2011 <xsl:if test="($target = 'xpidl') or ($target = 'midl')">
2012 <xsl:choose>
2013 <xsl:when test="$passmode='public'">
2014 <xsl:choose>
2015 <xsl:when test="$emitmode='method'">
2016 <xsl:apply-templates select="method" mode="public">
2017 <xsl:with-param name="target" select="$target"/>
2018 </xsl:apply-templates>
2019 </xsl:when>
2020 <xsl:when test="$emitmode='attribute'">
2021 <xsl:apply-templates select="attribute" mode="public">
2022 <xsl:with-param name="target" select="$target"/>
2023 </xsl:apply-templates>
2024 </xsl:when>
2025 <xsl:otherwise/>
2026 </xsl:choose>
2027 </xsl:when>
2028 <xsl:when test="$passmode='wrapped'">
2029 <xsl:choose>
2030 <xsl:when test="$emitmode='method'">
2031 <xsl:apply-templates select="method" mode="wrapped">
2032 <xsl:with-param name="target" select="$target"/>
2033 </xsl:apply-templates>
2034 </xsl:when>
2035 <xsl:when test="$emitmode='attribute'">
2036 <xsl:apply-templates select="attribute" mode="wrapped">
2037 <xsl:with-param name="target" select="$target"/>
2038 </xsl:apply-templates>
2039 </xsl:when>
2040 <xsl:otherwise/>
2041 </xsl:choose>
2042 </xsl:when>
2043 <xsl:when test="$passmode='code'">
2044 <xsl:choose>
2045 <xsl:when test="$emitmode='method'">
2046 <xsl:apply-templates select="method" mode="code">
2047 <xsl:with-param name="target" select="$target"/>
2048 <xsl:with-param name="topclass" select="$topclass"/>
2049 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2050 </xsl:apply-templates>
2051 </xsl:when>
2052 <xsl:when test="$emitmode='attribute'">
2053 <xsl:apply-templates select="attribute" mode="code">
2054 <xsl:with-param name="target" select="$target"/>
2055 <xsl:with-param name="topclass" select="$topclass"/>
2056 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2057 </xsl:apply-templates>
2058 </xsl:when>
2059 <xsl:otherwise/>
2060 </xsl:choose>
2061 </xsl:when>
2062 <xsl:when test="$passmode = 'dtrace-probes'">
2063 <xsl:choose>
2064 <xsl:when test="$emitmode = 'method'">
2065 <xsl:apply-templates select="method" mode="dtrace-probes">
2066 <xsl:with-param name="target" select="$target"/>
2067 <xsl:with-param name="topclass" select="$topclass"/>
2068 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2069 </xsl:apply-templates>
2070 </xsl:when>
2071 <xsl:when test="$emitmode = 'attribute'">
2072 <xsl:apply-templates select="attribute" mode="dtrace-probes">
2073 <xsl:with-param name="target" select="$target"/>
2074 <xsl:with-param name="topclass" select="$topclass"/>
2075 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2076 </xsl:apply-templates>
2077 </xsl:when>
2078 <xsl:otherwise/>
2079 </xsl:choose>
2080 </xsl:when>
2081 <xsl:otherwise/>
2082 </xsl:choose>
2083 </xsl:if>
2084</xsl:template>
2085
2086<xsl:template match="if" mode="public">
2087 <xsl:param name="emitmode"/>
2088
2089 <xsl:call-template name="emitIf">
2090 <xsl:with-param name="passmode" select="'public'"/>
2091 <xsl:with-param name="target" select="@target"/>
2092 <xsl:with-param name="emitmode" select="$emitmode"/>
2093 </xsl:call-template>
2094</xsl:template>
2095
2096<xsl:template match="if" mode="wrapped">
2097 <xsl:param name="emitmode"/>
2098
2099 <xsl:call-template name="emitIf">
2100 <xsl:with-param name="passmode" select="'wrapped'"/>
2101 <xsl:with-param name="target" select="@target"/>
2102 <xsl:with-param name="emitmode" select="$emitmode"/>
2103 </xsl:call-template>
2104</xsl:template>
2105
2106<xsl:template match="if" mode="code">
2107 <xsl:param name="topclass"/>
2108 <xsl:param name="emitmode"/>
2109 <xsl:param name="dtracetopclass"/>
2110
2111 <xsl:call-template name="emitIf">
2112 <xsl:with-param name="passmode" select="'code'"/>
2113 <xsl:with-param name="target" select="@target"/>
2114 <xsl:with-param name="emitmode" select="$emitmode"/>
2115 <xsl:with-param name="topclass" select="$topclass"/>
2116 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2117 </xsl:call-template>
2118</xsl:template>
2119
2120<xsl:template match="if" mode="dtrace-probes">
2121 <xsl:param name="topclass"/>
2122 <xsl:param name="emitmode"/>
2123 <xsl:param name="dtracetopclass"/>
2124
2125 <xsl:call-template name="emitIf">
2126 <xsl:with-param name="passmode" select="'dtrace-probes'"/>
2127 <xsl:with-param name="target" select="@target"/>
2128 <xsl:with-param name="emitmode" select="$emitmode"/>
2129 <xsl:with-param name="topclass" select="$topclass"/>
2130 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2131 </xsl:call-template>
2132</xsl:template>
2133
2134<!-- - - - - - - - - - - - - - - - - - - - - - -
2135 emit all methods of the current interface
2136 - - - - - - - - - - - - - - - - - - - - - - -->
2137<xsl:template name="emitMethods">
2138 <xsl:param name="topclass"/>
2139 <xsl:param name="pmode"/>
2140 <xsl:param name="dtracetopclass"/>
2141
2142 <xsl:variable name="name" select="@name"/>
2143 <!-- first recurse to emit all base interfaces -->
2144 <xsl:variable name="extends" select="@extends"/>
2145 <xsl:if test="$extends and not($extends='$unknown') and not($extends='$errorinfo')">
2146 <xsl:for-each select="key('G_keyInterfacesByName', $extends)">
2147 <xsl:call-template name="emitMethods">
2148 <xsl:with-param name="topclass" select="$topclass"/>
2149 <xsl:with-param name="pmode" select="$pmode"/>
2150 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2151 </xsl:call-template>
2152 </xsl:for-each>
2153 </xsl:if>
2154
2155 <xsl:choose>
2156 <xsl:when test="$pmode='code'">
2157 <xsl:text>//
2158</xsl:text>
2159 <xsl:value-of select="concat('// ', $name, ' methods')"/>
2160 <xsl:text>
2161//
2162
2163</xsl:text>
2164 </xsl:when>
2165 <xsl:when test="$pmode='dtrace-probes'"/>
2166 <xsl:otherwise>
2167 <xsl:value-of select="concat($G_sNewLine, ' // ', $pmode, ' ', $name, ' methods', $G_sNewLine)"/>
2168 </xsl:otherwise>
2169 </xsl:choose>
2170 <xsl:choose>
2171 <xsl:when test="$pmode='public'">
2172 <xsl:apply-templates select="./method | ./if" mode="public">
2173 <xsl:with-param name="emitmode" select="'method'"/>
2174 </xsl:apply-templates>
2175 <xsl:variable name="reservedMethods" select="@reservedMethods"/>
2176 <xsl:if test="$reservedMethods > 0">
2177 <!-- tricky way to do a "for" loop without recursion -->
2178 <xsl:for-each select="(//*)[position() &lt;= $reservedMethods]">
2179 <xsl:text> STDMETHOD(InternalAndReservedMethod</xsl:text>
2180 <xsl:value-of select="concat(position(), $name)"/>
2181 <xsl:text>)();&#x0A;</xsl:text>
2182 </xsl:for-each>
2183 </xsl:if>
2184 </xsl:when>
2185 <xsl:when test="$pmode='wrapped'">
2186 <xsl:apply-templates select="./method | ./if" mode="wrapped">
2187 <xsl:with-param name="emitmode" select="'method'"/>
2188 </xsl:apply-templates>
2189 </xsl:when>
2190 <xsl:when test="$pmode='code'">
2191 <xsl:apply-templates select="./method | ./if" mode="code">
2192 <xsl:with-param name="topclass" select="$topclass"/>
2193 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2194 <xsl:with-param name="emitmode" select="'method'"/>
2195 </xsl:apply-templates>
2196 <xsl:variable name="reservedMethods" select="@reservedMethods"/>
2197 <xsl:if test="$reservedMethods > 0">
2198 <!-- tricky way to do a "for" loop without recursion -->
2199 <xsl:for-each select="(//*)[position() &lt;= $reservedMethods]">
2200 <xsl:value-of select="concat('STDMETHODIMP ', $topclass, 'Wrap::InternalAndReservedMethod', position(), $name, '()&#x0A;')"/>
2201 <xsl:text>{
2202 return E_NOTIMPL;
2203}
2204
2205</xsl:text>
2206 </xsl:for-each>
2207 </xsl:if>
2208 </xsl:when>
2209 <xsl:when test="$pmode='dtrace-probes'">
2210 <xsl:apply-templates select="./method | ./if" mode="dtrace-probes">
2211 <xsl:with-param name="topclass" select="$topclass"/>
2212 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2213 <xsl:with-param name="emitmode" select="'method'"/>
2214 </xsl:apply-templates>
2215 </xsl:when>
2216 <xsl:otherwise/>
2217 </xsl:choose>
2218</xsl:template>
2219
2220<!-- - - - - - - - - - - - - - - - - - - - - - -
2221 emit all attributes and methods declarations of the current interface
2222 - - - - - - - - - - - - - - - - - - - - - - -->
2223<xsl:template name="emitInterfaceDecls">
2224 <xsl:param name="pmode"/>
2225
2226 <!-- attributes -->
2227 <xsl:call-template name="emitAttributes">
2228 <xsl:with-param name="pmode" select="$pmode"/>
2229 </xsl:call-template>
2230
2231 <!-- methods -->
2232 <xsl:call-template name="emitMethods">
2233 <xsl:with-param name="pmode" select="$pmode"/>
2234 </xsl:call-template>
2235</xsl:template>
2236
2237<!-- - - - - - - - - - - - - - - - - - - - - - -
2238 emit auxiliary method declarations of the current interface
2239 - - - - - - - - - - - - - - - - - - - - - - -->
2240<xsl:template name="emitAuxMethodDecls">
2241 <!-- currently nothing, maybe later some generic FinalConstruct/... helper declaration for ComObjPtr -->
2242</xsl:template>
2243
2244<!-- - - - - - - - - - - - - - - - - - - - - - -
2245 emit the header file of the current interface
2246 - - - - - - - - - - - - - - - - - - - - - - -->
2247<xsl:template name="emitHeader">
2248 <xsl:param name="addinterfaces"/>
2249
2250 <xsl:variable name="filename" select="concat(substring(@name, 2), 'Wrap.h')"/>
2251
2252 <xsl:apply-templates select="." mode="startfile">
2253 <xsl:with-param name="file" select="$filename"/>
2254 </xsl:apply-templates>
2255 <xsl:call-template name="fileheader">
2256 <xsl:with-param name="name" select="$filename"/>
2257 <xsl:with-param name="class" select="substring(@name, 2)"/>
2258 <xsl:with-param name="type" select="'header'"/>
2259 </xsl:call-template>
2260 <xsl:apply-templates select="." mode="classheader">
2261 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
2262 </xsl:apply-templates>
2263
2264 <!-- interface attributes/methods (public) -->
2265 <xsl:call-template name="emitInterfaceDecls">
2266 <xsl:with-param name="pmode" select="'public'"/>
2267 </xsl:call-template>
2268
2269 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
2270 <!-- This is super tricky, as the for-each switches to the node set,
2271 which means the normal document isn't available any more. We get
2272 the data we need, uses a for-each to switch document and then a
2273 key() to look up the interface by name. -->
2274 <xsl:variable name="addifname">
2275 <xsl:value-of select="string(.)"/>
2276 </xsl:variable>
2277 <xsl:for-each select="$G_root">
2278 <xsl:for-each select="key('G_keyInterfacesByName', $addifname)">
2279 <xsl:call-template name="emitInterfaceDecls">
2280 <xsl:with-param name="pmode" select="'public'"/>
2281 </xsl:call-template>
2282 </xsl:for-each>
2283 </xsl:for-each>
2284 </xsl:for-each>
2285
2286 <!-- auxiliary methods (public) -->
2287 <xsl:call-template name="emitAuxMethodDecls"/>
2288
2289 <!-- switch to private -->
2290 <xsl:text>
2291private:</xsl:text>
2292
2293 <!-- wrapped interface attributes/methods (private) -->
2294 <xsl:call-template name="emitInterfaceDecls">
2295 <xsl:with-param name="pmode" select="'wrapped'"/>
2296 </xsl:call-template>
2297
2298 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
2299 <!-- This is super tricky, as the for-each switches to the node set,
2300 which means the normal document isn't available any more. We get
2301 the data we need, uses a for-each to switch document and then a
2302 key() to look up the interface by name. -->
2303 <xsl:variable name="addifname">
2304 <xsl:value-of select="string(.)"/>
2305 </xsl:variable>
2306 <xsl:for-each select="$G_root">
2307 <xsl:for-each select="key('G_keyInterfacesByName', $addifname)">
2308 <xsl:call-template name="emitInterfaceDecls">
2309 <xsl:with-param name="pmode" select="'wrapped'"/>
2310 </xsl:call-template>
2311 </xsl:for-each>
2312 </xsl:for-each>
2313 </xsl:for-each>
2314
2315 <xsl:apply-templates select="." mode="classfooter"/>
2316 <xsl:apply-templates select="." mode="endfile">
2317 <xsl:with-param name="file" select="$filename"/>
2318 </xsl:apply-templates>
2319</xsl:template>
2320
2321<!-- - - - - - - - - - - - - - - - - - - - - - -
2322 emit all attributes and methods definitions (pmode=code) or probes (pmode=dtrace-probes) of the current interface
2323 - - - - - - - - - - - - - - - - - - - - - - -->
2324<xsl:template name="emitInterfaceDefs">
2325 <xsl:param name="addinterfaces"/>
2326 <xsl:param name="pmode" select="'code'"/>
2327
2328 <xsl:variable name="topclass" select="substring(@name, 2)"/>
2329 <xsl:variable name="dtracetopclass">
2330 <xsl:choose>
2331 <xsl:when test="@dtracename"><xsl:value-of select="@dtracename"/></xsl:when>
2332 <xsl:otherwise><xsl:value-of select="$topclass"/></xsl:otherwise>
2333 </xsl:choose>
2334 </xsl:variable>
2335
2336 <xsl:if test="$pmode = 'code'">
2337 <xsl:value-of select="concat('DEFINE_EMPTY_CTOR_DTOR(', $topclass, 'Wrap)', $G_sNewLine, $G_sNewLine)"/>
2338 </xsl:if>
2339
2340 <!-- attributes -->
2341 <xsl:call-template name="emitAttributes">
2342 <xsl:with-param name="topclass" select="$topclass"/>
2343 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2344 <xsl:with-param name="pmode" select="$pmode"/>
2345 </xsl:call-template>
2346
2347 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
2348 <!-- This is super tricky, as the for-each switches to the node set,
2349 which means the normal document isn't available any more. We get
2350 the data we need, uses a for-each to switch document and then a
2351 key() to look up the interface by name. -->
2352 <xsl:variable name="addifname">
2353 <xsl:value-of select="string(.)"/>
2354 </xsl:variable>
2355 <xsl:for-each select="$G_root">
2356 <xsl:for-each select="key('G_keyInterfacesByName', $addifname)">
2357 <xsl:call-template name="emitAttributes">
2358 <xsl:with-param name="topclass" select="$topclass"/>
2359 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2360 <xsl:with-param name="pmode" select="$pmode"/>
2361 </xsl:call-template>
2362 </xsl:for-each>
2363 </xsl:for-each>
2364 </xsl:for-each>
2365
2366 <!-- methods -->
2367 <xsl:call-template name="xsltprocNewlineOutputHack"/>
2368 <xsl:call-template name="emitMethods">
2369 <xsl:with-param name="topclass" select="$topclass"/>
2370 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2371 <xsl:with-param name="pmode" select="$pmode"/>
2372 </xsl:call-template>
2373
2374 <xsl:for-each select="exsl:node-set($addinterfaces)/token">
2375 <!-- This is super tricky, as the for-each switches to the node set,
2376 which means the normal document isn't available any more. We get
2377 the data we need, uses a for-each to switch document and then a
2378 key() to look up the interface by name. -->
2379 <xsl:variable name="addifname">
2380 <xsl:value-of select="string(.)"/>
2381 </xsl:variable>
2382 <xsl:for-each select="$G_root">
2383 <xsl:for-each select="key('G_keyInterfacesByName', $addifname)">
2384 <xsl:call-template name="emitMethods">
2385 <xsl:with-param name="topclass" select="$topclass"/>
2386 <xsl:with-param name="dtracetopclass" select="$dtracetopclass"/>
2387 <xsl:with-param name="pmode" select="$pmode"/>
2388 </xsl:call-template>
2389 </xsl:for-each>
2390 </xsl:for-each>
2391 </xsl:for-each>
2392</xsl:template>
2393
2394<!-- - - - - - - - - - - - - - - - - - - - - - -
2395 emit auxiliary method declarations of the current interface
2396 - - - - - - - - - - - - - - - - - - - - - - -->
2397<xsl:template name="emitAuxMethodDefs">
2398 <xsl:param name="pmode" select="'code'"/>
2399 <!-- currently nothing, maybe later some generic FinalConstruct/... implementation -->
2400</xsl:template>
2401
2402
2403<!-- - - - - - - - - - - - - - - - - - - - - - -
2404 emit the code file of the current interface
2405 - - - - - - - - - - - - - - - - - - - - - - -->
2406<xsl:template name="emitCode">
2407 <xsl:param name="addinterfaces"/>
2408
2409 <xsl:variable name="filename" select="concat(substring(@name, 2), 'Wrap.cpp')"/>
2410
2411 <xsl:apply-templates select="." mode="startfile">
2412 <xsl:with-param name="file" select="$filename"/>
2413 </xsl:apply-templates>
2414 <xsl:call-template name="fileheader">
2415 <xsl:with-param name="name" select="$filename"/>
2416 <xsl:with-param name="class" select="substring(@name, 2)"/>
2417 <xsl:with-param name="type" select="'code'"/>
2418 </xsl:call-template>
2419 <xsl:apply-templates select="." mode="codeheader">
2420 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
2421 </xsl:apply-templates>
2422
2423 <!-- interface attributes/methods (public) -->
2424 <xsl:call-template name="emitInterfaceDefs">
2425 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
2426 </xsl:call-template>
2427
2428 <!-- auxiliary methods (public) -->
2429 <xsl:call-template name="emitAuxMethodDefs"/>
2430
2431 <xsl:apply-templates select="." mode="codefooter">
2432 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
2433 </xsl:apply-templates>
2434 <xsl:apply-templates select="." mode="endfile">
2435 <xsl:with-param name="file" select="$filename"/>
2436 </xsl:apply-templates>
2437</xsl:template>
2438
2439<!-- - - - - - - - - - - - - - - - - - - - - - -
2440 emit the DTrace probes for the current interface
2441 - - - - - - - - - - - - - - - - - - - - - - -->
2442<xsl:template name="emitDTraceProbes">
2443 <xsl:param name="addinterfaces"/>
2444
2445 <!-- interface attributes/methods (public) -->
2446 <xsl:call-template name="emitInterfaceDefs">
2447 <xsl:with-param name="addinterfaces" select="$addinterfaces"/>
2448 <xsl:with-param name="pmode">dtrace-probes</xsl:with-param>
2449 </xsl:call-template>
2450
2451 <!-- auxiliary methods (public) -->
2452 <xsl:call-template name="emitAuxMethodDefs">
2453 <xsl:with-param name="pmode">dtrace-probes</xsl:with-param>
2454 </xsl:call-template>
2455
2456</xsl:template>
2457
2458<!-- - - - - - - - - - - - - - - - - - - - - - -
2459 wildcard match, ignore everything which has no explicit match
2460 - - - - - - - - - - - - - - - - - - - - - - -->
2461
2462<xsl:template match="*"/>
2463
2464<!-- - - - - - - - - - - - - - - - - - - - - - -
2465 ignore all if tags except those for XPIDL or MIDL target
2466 - - - - - - - - - - - - - - - - - - - - - - -->
2467
2468<xsl:template match="if">
2469 <xsl:if test="(@target = 'xpidl') or (@target = 'midl')">
2470 <xsl:apply-templates/>
2471 </xsl:if>
2472</xsl:template>
2473
2474<!-- - - - - - - - - - - - - - - - - - - - - - -
2475 interface match
2476 - - - - - - - - - - - - - - - - - - - - - - -->
2477
2478<xsl:template match="interface">
2479 <xsl:if test="not(@internal='yes') and not(@supportsErrorInfo='no')">
2480 <xsl:call-template name="emitInterface"/>
2481 </xsl:if>
2482</xsl:template>
2483
2484<!-- - - - - - - - - - - - - - - - - - - - - - -
2485 library match
2486 - - - - - - - - - - - - - - - - - - - - - - -->
2487
2488<xsl:template match="library">
2489 <xsl:apply-templates/>
2490</xsl:template>
2491
2492<!-- - - - - - - - - - - - - - - - - - - - - - -
2493 root match
2494 - - - - - - - - - - - - - - - - - - - - - - -->
2495
2496<xsl:template match="/idl">
2497 <xsl:choose>
2498 <xsl:when test="$generating = 'headers'">
2499 <xsl:apply-templates/>
2500 </xsl:when>
2501 <xsl:when test="$generating = 'sources'">
2502 <xsl:apply-templates/>
2503 </xsl:when>
2504 <xsl:when test="$generating = 'dtrace-probes'">
2505 <xsl:apply-templates/>
2506 </xsl:when>
2507 <xsl:otherwise>
2508 <xsl:message terminate="yes">
2509 Unknown string parameter value: generating='<xsl:value-of select="$generating"/>'
2510 </xsl:message>
2511 </xsl:otherwise>
2512 </xsl:choose>
2513</xsl:template>
2514
2515</xsl:stylesheet>
2516<!-- vi: set tabstop=4 shiftwidth=4 expandtab: -->
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette