VirtualBox

source: vbox/trunk/src/VBox/Main/webservice/websrv-wsdl.xsl@ 53517

Last change on this file since 53517 was 46478, checked in by vboxsync, 12 years ago

libs/xpcom: touch up Java XPCOM wrapper generation, new common exception handlin
g model
Main/glue: Java glue code with better exception handling, indentation/coding style fixes both in the XSLT and the generated code, touched up Java sample code showing exception handling and getting all error information, Python indentation/whitespace cleanup
Main/idl: make more interfaces available over the webservice, some minor docs changes, whitespace cleanup
Main/webservice: redo error reporting through exceptions, no longer loses error
information, allow more fine-grained suppression of methods/attributed, touched up C++ webservice sample code to support showing the full error information, build system changes to prepare for incremental Java compilation, indentation fixesFrontends/VBoxShell: minor cleanups, coding style fixes, indentation fixes, elim
inate warnings
  • Property svn:eol-style set to native
File size: 62.6 KB
Line 
1<?xml version="1.0"?>
2
3<!--
4
5 websrv-wsdl.xsl:
6 XSLT stylesheet that generates vboxweb.wsdl from
7 VirtualBox.xidl. This WSDL file represents our
8 web service API..
9 See webservice/Makefile.kmk for an overview of all the things
10 generated for the webservice.
11
12 Copyright (C) 2006-2013 Oracle Corporation
13
14 This file is part of VirtualBox Open Source Edition (OSE), as
15 available from http://www.virtualbox.org. This file is free software;
16 you can redistribute it and/or modify it under the terms of the GNU
17 General Public License (GPL) as published by the Free Software
18 Foundation, in version 2 as it comes in the "COPYING" file of the
19 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
20 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
21-->
22
23<!--
24 A WSDL document describes a web service using these major elements:
25 Element Defines
26 <types> The data types used by the web service, described in XML Schema
27 syntax.
28 <message> The messages used by the web service. A message is a function call
29 and with it come "parts", which are the parameters.
30 <portType> The operations performed by the web service. A portType can be thought
31 of as a class or, in COM terms, as an interface.
32 <binding> The communication protocols used by the web service.
33
34 The root tag is <definitions>.
35
36 Representing COM interfaces is tricky in WSDL 1.1, which doesn't really have them.
37 WSDL only knows about "port types", which are an abstract representation
38 of a group of functions. So for each "interface", we need to emit
39 a "port type"; in the port type, we declare each "interface method"
40 as one "operation". Each operation in turn consists of at least one
41 message for the method invocation, which contains all the "in" and
42 "inout" arguments. An optional second message for the response contains
43 the return value, if one is present in the IDL (called "_return" to
44 avoid name clashes), together with all the "out" and "inout" arguments.
45 Each of these messages, however, need to be independently declared
46 using the "message" element outside of the "port type" declaration.
47
48 As an example: To create this XPCOM IDL:
49
50 void createMachine (
51 in wstring baseFolder,
52 in wstring name,
53 [retval] out IMachine machine
54 );
55
56 the following exists in the XIDL:
57
58 <interface name="ifname">
59 <method name="createMachine">
60 <param name="baseFolder" type="wstring" dir="in" />
61 <param name="name" type="wstring" dir="in" />
62 <param name="machine" type="IMachine" dir="return" />
63 </method>
64 </interface>
65
66 So, we have two "in" parameters, and one "out" parameter. The
67 operation therefore requires two messages (one for the request,
68 with the two "in" parameters, and one for the result with the
69 return value). With RPC/encoded style, we end up with this:
70
71 <message name="ifname.methodname_Request">
72 <part name="baseFolder" type="xsd:string" />
73 <part name="name" type="xsd:string" />
74 </message>
75 <message name="ifname.methodname_Result">
76 <part name="_return" type="IMachine" />
77 </message>
78 <portType name="ifname">
79 <operation name="methodname"
80 <input message="ifname.methodname_Request" />
81 <output message="ifname.methodname_Result" />
82 </operation>
83 </portType>
84
85 With document/literal style, things get even more verbose, as
86 instead of listing the arguments and return values in the messages,
87 we declare a struct-like complexType in the <types> section
88 instead and then reference that type in the messages.
89-->
90
91<xsl:stylesheet
92 version="1.0"
93 targetNamespace="http://schemas.xmlsoap.org/wsdl/"
94 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
95 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
96 xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
97 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
98 xmlns:vbox="http://www.virtualbox.org/"
99 xmlns:exsl="http://exslt.org/common"
100 extension-element-prefixes="exsl">
101
102<xsl:param name="G_argDebug" />
103
104<xsl:output
105 method="xml"
106 version="1.0"
107 encoding="utf-8"
108 indent="yes"/>
109
110<xsl:strip-space
111 elements="*" />
112
113<!--**********************************************************************
114 *
115 * global XSLT variables
116 *
117 **********************************************************************-->
118
119<xsl:variable name="G_xsltFilename" select="'websrv-wsdl.xsl'" />
120
121<xsl:include href="../idl/typemap-shared.inc.xsl" />
122
123<!-- collect all interfaces with "wsmap='suppress'" in a global variable for
124 quick lookup -->
125<xsl:variable name="G_setSuppressedInterfaces"
126 select="//interface[@wsmap='suppress']" />
127
128<!-- this marker is used with WSDL document style to mark that a message
129 should have an automatic type that matches a complexType definition;
130 use a string that cannot possibly appear in an XIDL interface name -->
131<xsl:variable name="G_typeIsGlobalRequestElementMarker"
132 select="'&lt;&lt;&lt;&lt;Request'" />
133<xsl:variable name="G_typeIsGlobalResponseElementMarker"
134 select="'&lt;&lt;&lt;&lt;Response'" />
135
136<!--**********************************************************************
137 *
138 * shared helpers
139 *
140 **********************************************************************-->
141
142<!--
143 function emitConvertedType
144 -->
145<xsl:template name="emitConvertedType">
146 <xsl:param name="ifname" />
147 <xsl:param name="methodname" />
148 <xsl:param name="type" />
149 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('......emitConvertedType: type=&quot;', $type, '&quot;')" /></xsl:call-template>
150 <!-- look up XML Schema type from IDL type from table array in typemap-shared.inc.xsl -->
151 <xsl:variable name="xmltypefield" select="exsl:node-set($G_aSharedTypes)/type[@idlname=$type]/@xmlname" />
152 <xsl:choose>
153 <xsl:when test="$type=$G_typeIsGlobalRequestElementMarker"><xsl:value-of select="concat('vbox:', $ifname, $G_classSeparator, $methodname, $G_requestMessageElementSuffix)" /></xsl:when>
154 <xsl:when test="$type=$G_typeIsGlobalResponseElementMarker"><xsl:value-of select="concat('vbox:', $ifname, $G_classSeparator, $methodname, $G_responseMessageElementSuffix)" /></xsl:when>
155 <!-- if above lookup in table succeeded, use that type -->
156 <xsl:when test="string-length($xmltypefield)"><xsl:value-of select="concat('xsd:', $xmltypefield)" /></xsl:when>
157 <xsl:when test="$type='$unknown'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
158 <xsl:when test="$type='global'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
159 <xsl:when test="$type='managed'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
160 <xsl:when test="$type='explicit'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
161 <!-- enums are easy, these are defined in schema at the top of the wsdl -->
162 <xsl:when test="//enum[@name=$type]"><xsl:value-of select="concat('vbox:', $type)" /></xsl:when>
163 <!-- otherwise test for an interface with this name -->
164 <xsl:when test="//interface[@name=$type]">
165 <!-- the type is one of our own interfaces: then it must have a wsmap attr -->
166 <xsl:variable name="wsmap" select="//interface[@name=$type]/@wsmap" />
167 <xsl:choose>
168 <xsl:when test="not($wsmap)">
169 <xsl:call-template name="fatalError">
170 <xsl:with-param name="msg" select="concat('emitConvertedType: Type &quot;', $type, '&quot; in method &quot;', $ifname, '::', $methodname, '&quot; lacks wsmap attribute value in XIDL.')" />
171 </xsl:call-template>
172 </xsl:when>
173 <xsl:when test="$wsmap='struct'"><xsl:value-of select="concat('vbox:', $type)" /></xsl:when>
174 <xsl:when test="$wsmap='global'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
175 <xsl:when test="$wsmap='managed'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
176 <xsl:when test="$wsmap='explicit'"><xsl:value-of select="$G_typeObjectRef" /></xsl:when>
177 <xsl:when test="$wsmap='suppress'">
178 <xsl:call-template name="fatalError">
179 <xsl:with-param name="msg" select="concat('emitConvertedType: Type &quot;', $type, '&quot; in method &quot;', $ifname, '::', $methodname, '&quot; has wsmap=&quot;suppress&quot; attribute in XIDL. This function should have been suppressed as well.')" />
180 </xsl:call-template>
181 </xsl:when>
182 <xsl:otherwise>
183 <xsl:call-template name="fatalError">
184 <xsl:with-param name="msg" select="concat('emitConvertedType: Type &quot;', $type, '&quot; used in method &quot;', $ifname, '::', $methodname, '&quot; has unsupported wsmap attribute value &quot;', $wsmap, '&quot;')" />
185 </xsl:call-template>
186 </xsl:otherwise>
187 </xsl:choose>
188 </xsl:when>
189 <xsl:otherwise>
190 <xsl:call-template name="fatalError">
191 <xsl:with-param name="msg" select="concat('emitConvertedType: Unknown type &quot;', $type, '&quot; used in method &quot;', $ifname, '::', $methodname, '&quot;.')" />
192 </xsl:call-template>
193 </xsl:otherwise>
194 </xsl:choose>
195</xsl:template>
196
197<!--
198 function convertTypeAndEmitPartOrElement
199 -->
200<xsl:template name="convertTypeAndEmitPartOrElement">
201 <xsl:param name="ifname" />
202 <xsl:param name="methodname" />
203 <xsl:param name="name" />
204 <xsl:param name="type" />
205 <xsl:param name="safearray" /> <!-- "yes" if XIDL has safearray=yes -->
206 <xsl:param name="elname" /> <!-- "part" or "element" -->
207 <xsl:param name="attrname" /> <!-- attrib of part or element: <part type=...> or <part element=...> or <element type=...> -->
208
209 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('....convertTypeAndEmitPartOrElement: arg name: ', $name)" /></xsl:call-template>
210 <xsl:choose>
211 <xsl:when test="$safearray='yes' and $type='octet'">
212 <!-- we pass octet arrays as Base64-encoded strings. -->
213 <xsl:element name="{$elname}">
214 <xsl:attribute name="name"><xsl:value-of select="$name" /></xsl:attribute>
215 <xsl:attribute name="type"><xsl:value-of select="'xsd:string'" /></xsl:attribute>
216 </xsl:element>
217 </xsl:when>
218
219 <xsl:when test="$safearray='yes'">
220 <xsl:element name="{$elname}"> <!-- <part> or <element> -->
221 <xsl:attribute name="name"><xsl:value-of select="$name" /></xsl:attribute>
222 <xsl:attribute name="minOccurs"><xsl:value-of select="'0'" /></xsl:attribute>
223 <xsl:attribute name="maxOccurs"><xsl:value-of select="'unbounded'" /></xsl:attribute>
224 <xsl:attribute name="{$attrname}">
225 <xsl:call-template name="emitConvertedType">
226 <xsl:with-param name="ifname" select="$ifname" />
227 <xsl:with-param name="methodname" select="$methodname" />
228 <xsl:with-param name="type" select="$type" />
229 </xsl:call-template>
230 </xsl:attribute>
231 </xsl:element>
232 </xsl:when>
233 <xsl:otherwise>
234 <xsl:element name="{$elname}"> <!-- <part> or <element> -->
235 <xsl:attribute name="name"><xsl:value-of select="$name" /></xsl:attribute>
236 <xsl:attribute name="{$attrname}">
237 <xsl:call-template name="emitConvertedType">
238 <xsl:with-param name="ifname" select="$ifname" />
239 <xsl:with-param name="methodname" select="$methodname" />
240 <xsl:with-param name="type" select="$type" />
241 </xsl:call-template>
242 </xsl:attribute>
243 </xsl:element>
244 </xsl:otherwise>
245 </xsl:choose>
246</xsl:template>
247
248<!--
249 function emitRequestArgs
250 -->
251<xsl:template name="emitRequestArgs">
252 <xsl:param name="_ifname" /> <!-- interface name -->
253 <xsl:param name="_wsmap" /> <!-- interface's wsmap attribute -->
254 <xsl:param name="_methodname" />
255 <xsl:param name="_params" />
256 <xsl:param name="_valuetype" /> <!-- optional, for attribute setter messages -->
257 <xsl:param name="_valuesafearray" /> <!-- optional, 'yes' if attribute of setter has safearray=yes -->
258 <xsl:param name="_elname" /> <!-- "part" or "xsd:element" -->
259 <xsl:param name="_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
260
261 <!-- first parameter will be object on which method is called, depending on wsmap attribute -->
262 <xsl:choose>
263 <xsl:when test="($_wsmap='managed') or ($_wsmap='explicit')">
264 <xsl:call-template name="convertTypeAndEmitPartOrElement">
265 <xsl:with-param name="ifname" select="$_ifname" />
266 <xsl:with-param name="methodname" select="$_methodname" />
267 <xsl:with-param name="name" select="$G_nameObjectRef" />
268 <xsl:with-param name="type" select="$_wsmap" />
269 <xsl:with-param name="safearray" select="'no'" />
270 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
271 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
272 </xsl:call-template>
273 </xsl:when>
274 </xsl:choose>
275 <!-- now for the real parameters, if any -->
276 <xsl:for-each select="$_params">
277 <!-- emit only parts for "in" parameters -->
278 <xsl:if test="@dir='in'">
279 <xsl:call-template name="convertTypeAndEmitPartOrElement">
280 <xsl:with-param name="ifname" select="$_ifname" />
281 <xsl:with-param name="methodname" select="$_methodname" />
282 <xsl:with-param name="name" select="@name" />
283 <xsl:with-param name="type" select="@type" />
284 <xsl:with-param name="safearray" select="@safearray" />
285 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
286 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
287 </xsl:call-template>
288 </xsl:if>
289 </xsl:for-each>
290 <xsl:if test="$_valuetype">
291 <!-- <part>
292 <xsl:attribute name="name">value</xsl:attribute>
293 <xsl:attribute name="type"><xsl:value-of select='string($_valuetype)' /></xsl:attribute>
294 </part> -->
295 <xsl:call-template name="convertTypeAndEmitPartOrElement">
296 <xsl:with-param name="ifname" select="$_ifname" />
297 <xsl:with-param name="methodname" select="$_methodname" />
298 <xsl:with-param name="name" select="@name" />
299 <xsl:with-param name="type" select="@type" />
300 <xsl:with-param name="safearray" select="@safearray" />
301 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
302 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
303 </xsl:call-template>
304 </xsl:if>
305</xsl:template>
306
307<!--
308 function emitResultArgs
309 -->
310<xsl:template name="emitResultArgs">
311 <xsl:param name="_ifname" />
312 <xsl:param name="_methodname" />
313 <xsl:param name="_params" /> <!-- set of parameter elements -->
314 <xsl:param name="_resulttype" /> <!-- for attribute getter methods only -->
315 <xsl:param name="_resultsafearray" /> <!-- for attribute getter methods only -->
316 <xsl:param name="_elname" /> <!-- "part" or "xsd:element" -->
317 <xsl:param name="_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
318
319 <xsl:choose>
320 <xsl:when test="$_resulttype">
321 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $_ifname, '::', $_methodname, ': ', 'resultmsg for attr of type ', $_resulttype)" /></xsl:call-template>
322 <xsl:call-template name="convertTypeAndEmitPartOrElement">
323 <xsl:with-param name="ifname" select="$_ifname" />
324 <xsl:with-param name="methodname" select="$_methodname" />
325 <xsl:with-param name="name" select="$G_result" />
326 <xsl:with-param name="type" select="$_resulttype" />
327 <xsl:with-param name="safearray" select="$_resultsafearray" />
328 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
329 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
330 </xsl:call-template>
331 </xsl:when>
332 <xsl:otherwise>
333 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', 'resultmsg for method: ', $_ifname, '::', $_methodname)" /></xsl:call-template>
334 <xsl:for-each select="$_params">
335 <!-- emit only parts for "out" parameters -->
336 <xsl:if test="@dir='out'">
337 <xsl:call-template name="convertTypeAndEmitPartOrElement">
338 <xsl:with-param name="ifname" select="$_ifname" />
339 <xsl:with-param name="methodname" select="$_methodname" />
340 <xsl:with-param name="name"><xsl:value-of select="@name" /></xsl:with-param>
341 <xsl:with-param name="type"><xsl:value-of select="@type" /></xsl:with-param>
342 <xsl:with-param name="safearray" select="@safearray" />
343 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
344 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
345 </xsl:call-template>
346 </xsl:if>
347 <xsl:if test="@dir='return'">
348 <xsl:call-template name="convertTypeAndEmitPartOrElement">
349 <xsl:with-param name="ifname" select="$_ifname" />
350 <xsl:with-param name="methodname" select="$_methodname" />
351 <xsl:with-param name="name"><xsl:value-of select="$G_result" /></xsl:with-param>
352 <xsl:with-param name="type"><xsl:value-of select="@type" /></xsl:with-param>
353 <xsl:with-param name="safearray" select="@safearray" />
354 <xsl:with-param name="elname" select="$_elname" /> <!-- "part" or "element" -->
355 <xsl:with-param name="attrname" select="$_attrname" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
356 </xsl:call-template>
357 </xsl:if>
358 </xsl:for-each>
359 </xsl:otherwise>
360 </xsl:choose>
361</xsl:template>
362
363<!--
364 function emitRequestElements:
365 for "in" parameters
366 -->
367<xsl:template name="emitRequestElements">
368 <xsl:param name="_ifname" /> <!-- interface name -->
369 <xsl:param name="_wsmap" /> <!-- interface's wsmap attribute -->
370 <xsl:param name="_methodname" />
371 <xsl:param name="_params" />
372 <xsl:param name="_valuetype" /> <!-- optional, for attribute setter messages -->
373 <xsl:param name="_valuesafearray" /> <!-- optional, 'yes' if attribute of setter has safearray=yes -->
374
375 <xsd:element>
376 <xsl:attribute name="name"><xsl:value-of select="concat($_ifname, $G_classSeparator, $_methodname, $G_requestMessageElementSuffix)" /></xsl:attribute>
377 <xsd:complexType>
378 <xsd:sequence>
379 <xsl:call-template name="emitRequestArgs">
380 <xsl:with-param name="_ifname" select="$_ifname" /> <!-- interface name -->
381 <xsl:with-param name="_wsmap" select="$_wsmap" /> <!-- interface's wsmap attribute -->
382 <xsl:with-param name="_methodname" select="$_methodname" />
383 <xsl:with-param name="_params" select="$_params" />
384 <xsl:with-param name="_valuetype" select="$_valuetype" /> <!-- optional, for attribute setter messages -->
385 <xsl:with-param name="_valuesafearray" select="$_valuesafearray" /> <!-- optional, for attribute setter messages -->
386 <xsl:with-param name="_elname" select="'xsd:element'" /> <!-- "part" or "xsd:element" -->
387 <xsl:with-param name="_attrname" select="'type'" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
388 </xsl:call-template>
389 </xsd:sequence>
390 </xsd:complexType>
391 </xsd:element>
392</xsl:template>
393
394<!--
395 function emitResultElements:
396 for "out" and "return" parameters
397 -->
398<xsl:template name="emitResultElements">
399 <xsl:param name="_ifname" />
400 <xsl:param name="_methodname" />
401 <xsl:param name="_params" /> <!-- set of parameter elements -->
402 <xsl:param name="_resulttype" /> <!-- optional, for attribute getter methods only -->
403 <xsl:param name="_resultsafearray" /> <!-- optional, 'yes' if attribute of getter has safearray=yes -->
404
405 <xsd:element>
406 <xsl:attribute name="name"><xsl:value-of select="concat($_ifname, $G_classSeparator, $_methodname, $G_responseMessageElementSuffix)" /></xsl:attribute>
407 <xsd:complexType>
408 <xsd:sequence>
409 <xsl:call-template name="emitResultArgs">
410 <xsl:with-param name="_ifname" select="$_ifname" />
411 <xsl:with-param name="_methodname" select="$_methodname" />
412 <xsl:with-param name="_params" select="$_params" /> <!-- set of parameter elements -->
413 <xsl:with-param name="_resulttype" select="$_resulttype" /> <!-- for attribute getter methods only -->
414 <xsl:with-param name="_resultsafearray" select="$_resultsafearray" /> <!-- for attribute getter methods only -->
415 <xsl:with-param name="_elname" select="'xsd:element'" /> <!-- "part" or "xsd:element" -->
416 <xsl:with-param name="_attrname" select="'type'" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
417 </xsl:call-template>
418 </xsd:sequence>
419 </xsd:complexType>
420 </xsd:element>
421</xsl:template>
422
423<!--
424 function emitGetAttributeElements
425 -->
426<xsl:template name="emitGetAttributeElements">
427 <xsl:param name="ifname" />
428 <xsl:param name="wsmap" />
429 <xsl:param name="attrname" />
430 <xsl:param name="attrtype" />
431 <xsl:param name="attrsafearray" />
432
433 <xsl:variable name="attrGetter"><xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
434 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $ifname, '::', $attrGetter)" /></xsl:call-template>
435 <xsl:call-template name="emitRequestElements">
436 <xsl:with-param name="_ifname" select="$ifname" />
437 <xsl:with-param name="_wsmap" select="$wsmap" />
438 <xsl:with-param name="_methodname" select="$attrGetter" />
439 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
440 </xsl:call-template>
441 <xsl:call-template name="emitResultElements">
442 <xsl:with-param name="_ifname" select="$ifname" />
443 <xsl:with-param name="_methodname" select="$attrGetter" />
444 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
445 <xsl:with-param name="_resulttype" select='$attrtype' />
446 <xsl:with-param name="_resultsafearray" select='$attrsafearray' />
447 </xsl:call-template>
448</xsl:template>
449
450<!--
451 function: emitRequestMessage
452 for "in" parameters
453-->
454<xsl:template name="emitRequestMessage">
455 <xsl:param name="_ifname" /> <!-- interface name -->
456 <xsl:param name="_wsmap" /> <!-- interface's wsmap attribute -->
457 <xsl:param name="_methodname" />
458 <xsl:param name="_params" />
459 <xsl:param name="_valuetype" /> <!-- optional, for attribute setter messages -->
460
461 <wsdl:message>
462 <xsl:attribute name="name"><xsl:value-of select="concat($_ifname, $G_classSeparator, $_methodname, $G_methodRequest)" /></xsl:attribute>
463
464 <xsl:call-template name="convertTypeAndEmitPartOrElement">
465 <xsl:with-param name="ifname" select="$_ifname" />
466 <xsl:with-param name="methodname" select="$_methodname" />
467 <xsl:with-param name="name" select="'parameters'" />
468 <xsl:with-param name="type" select="$G_typeIsGlobalRequestElementMarker" />
469 <xsl:with-param name="safearray" select="'no'" />
470 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
471 <xsl:with-param name="attrname" select="'element'" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
472 </xsl:call-template>
473 </wsdl:message>
474</xsl:template>
475
476<!--
477 function: emitResultMessage
478 for "out" and "return" parameters
479-->
480<xsl:template name="emitResultMessage">
481 <xsl:param name="_ifname" />
482 <xsl:param name="_methodname" />
483 <xsl:param name="_params" /> <!-- set of parameter elements -->
484 <xsl:param name="_resulttype" /> <!-- for attribute getter methods only -->
485
486 <wsdl:message>
487 <xsl:attribute name="name"><xsl:copy-of select="$_ifname" /><xsl:value-of select="$G_classSeparator" /><xsl:value-of select="$_methodname" /><xsl:copy-of select="$G_methodResponse" /></xsl:attribute>
488
489 <!-- <xsl:variable name="cOutParams" select="count($_params[@dir='out']) + count($_params[@dir='return'])" /> -->
490 <xsl:call-template name="convertTypeAndEmitPartOrElement">
491 <xsl:with-param name="ifname" select="$_ifname" />
492 <xsl:with-param name="methodname" select="$_methodname" />
493 <xsl:with-param name="name" select="'parameters'" />
494 <xsl:with-param name="type" select="$G_typeIsGlobalResponseElementMarker" />
495 <xsl:with-param name="safearray" select="'no'" />
496 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
497 <xsl:with-param name="attrname" select="'element'" /> <!-- attrib of part of element: <part type=...> or <part element=...> or <element type=...> -->
498 </xsl:call-template>
499 </wsdl:message>
500</xsl:template>
501
502<!--
503 function emitGetAttributeMessages:
504-->
505<xsl:template name="emitGetAttributeMessages">
506 <xsl:param name="ifname" />
507 <xsl:param name="wsmap" />
508 <xsl:param name="attrname" />
509 <xsl:param name="attrtype" />
510
511 <xsl:variable name="attrGetter"><xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
512 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $ifname, '::', $attrGetter)" /></xsl:call-template>
513 <xsl:call-template name="emitRequestMessage">
514 <xsl:with-param name="_ifname" select="$ifname" />
515 <xsl:with-param name="_wsmap" select="$wsmap" />
516 <xsl:with-param name="_methodname" select="$attrGetter" />
517 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
518 </xsl:call-template>
519 <xsl:call-template name="emitResultMessage">
520 <xsl:with-param name="_ifname" select="$ifname" />
521 <xsl:with-param name="_methodname" select="$attrGetter" />
522 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
523 <xsl:with-param name="_resulttype" select='$attrtype' />
524 </xsl:call-template>
525</xsl:template>
526
527<!--
528 function emitSetAttributeMessages
529 -->
530<xsl:template name="emitSetAttributeMessages">
531 <xsl:param name="ifname" select="$ifname" />
532 <xsl:param name="wsmap" select="$wsmap" />
533 <xsl:param name="attrname" select="$attrname" />
534 <xsl:param name="attrtype" select="$attrtype" />
535
536 <xsl:variable name="attrSetter"><xsl:call-template name="makeSetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
537 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $ifname, '::', $attrSetter)" /></xsl:call-template>
538 <xsl:call-template name="emitRequestMessage">
539 <xsl:with-param name="_ifname" select="$ifname" />
540 <xsl:with-param name="_wsmap" select="$wsmap" />
541 <xsl:with-param name="_methodname" select="$attrSetter" />
542 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
543 <xsl:with-param name="_valuetype" select="$attrtype" />
544 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
545 </xsl:call-template>
546 <xsl:call-template name="emitResultMessage">
547 <xsl:with-param name="_ifname" select="$ifname" />
548 <xsl:with-param name="_methodname" select="$attrSetter" />
549 <xsl:with-param name="_params" select="/.." /> <!-- empty set -->
550 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
551 </xsl:call-template>
552</xsl:template>
553
554<!--
555 function emitInOutOperation:
556 referencing the messages that must have been emitted previously
557-->
558<xsl:template name="emitInOutOperation">
559 <xsl:param name="_ifname" /> <!-- interface name -->
560 <xsl:param name="_methodname" /> <!-- method name -->
561 <xsl:param name="_params" />
562 <xsl:param name="_resulttype" /> <!-- for attribute getter methods only -->
563 <xsl:param name="_fSoap" />
564
565 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('....emitInOutOperation ', $_ifname, '::', $_methodname)" /></xsl:call-template>
566
567 <wsdl:operation>
568 <xsl:attribute name="name">
569 <xsl:value-of select="concat($_ifname, '_', $_methodname)" />
570 </xsl:attribute>
571 <xsl:if test="$_fSoap">
572 <soap:operation>
573 <!-- VMware has an empty attribute like this as well -->
574 <xsl:attribute name="soapAction"><xsl:value-of select="''" /></xsl:attribute>
575 <xsl:attribute name="style"><xsl:value-of select="$G_basefmt" /></xsl:attribute>
576 </soap:operation>
577 </xsl:if>
578 <wsdl:input>
579 <xsl:choose>
580 <xsl:when test="$_fSoap">
581 <soap:body>
582 <xsl:attribute name="use"><xsl:value-of select="$G_parmfmt" /></xsl:attribute>
583 <!-- avoid jax-ws warning: <xsl:attribute name="namespace"><xsl:value-of select="concat($G_targetNamespace, $G_targetNamespaceSeparator)" /></xsl:attribute>-->
584 </soap:body>
585 </xsl:when>
586 <xsl:otherwise>
587 <xsl:attribute name="message">vbox:<xsl:copy-of select="$_ifname" /><xsl:value-of select="$G_classSeparator" /><xsl:value-of select="$_methodname" /><xsl:copy-of select="$G_methodRequest" /></xsl:attribute>
588 </xsl:otherwise>
589 </xsl:choose>
590 </wsdl:input>
591 <xsl:choose>
592 <xsl:when test="$_resulttype">
593 <wsdl:output>
594 <xsl:choose>
595 <xsl:when test="$_fSoap">
596 <soap:body>
597 <xsl:attribute name="use"><xsl:value-of select="$G_parmfmt" /></xsl:attribute>
598 <!-- avoid jax-ws warning: <xsl:attribute name="namespace"><xsl:value-of select="concat($G_targetNamespace, $G_targetNamespaceSeparator)" /></xsl:attribute> -->
599 </soap:body>
600 </xsl:when>
601 <xsl:otherwise>
602 <xsl:attribute name="message">vbox:<xsl:copy-of select="$_ifname" /><xsl:value-of select="$G_classSeparator" /><xsl:value-of select="$_methodname" /><xsl:copy-of select="$G_methodResponse" /></xsl:attribute>
603 </xsl:otherwise>
604 </xsl:choose>
605 </wsdl:output>
606 </xsl:when>
607 <xsl:otherwise>
608 <!-- <xsl:if test="count($_params[@dir='out'] | $_params[@dir='return']) > 0"> -->
609 <wsdl:output>
610 <xsl:choose>
611 <xsl:when test="$_fSoap">
612 <soap:body>
613 <xsl:attribute name="use"><xsl:value-of select="$G_parmfmt" /></xsl:attribute>
614 <!-- avoid jax-ws warning: <xsl:attribute name="namespace"><xsl:value-of select="concat($G_targetNamespace, $G_targetNamespaceSeparator)" /></xsl:attribute> -->
615 </soap:body>
616 </xsl:when>
617 <xsl:otherwise>
618 <xsl:attribute name="message">vbox:<xsl:copy-of select="$_ifname" /><xsl:value-of select="$G_classSeparator" /><xsl:value-of select="$_methodname" /><xsl:copy-of select="$G_methodResponse" /></xsl:attribute>
619 </xsl:otherwise>
620 </xsl:choose>
621 </wsdl:output>
622 <!-- </xsl:if> -->
623 </xsl:otherwise>
624 </xsl:choose>
625 <xsl:choose>
626 <xsl:when test="not($_fSoap)">
627 <wsdl:fault name="InvalidObjectFault" message="vbox:InvalidObjectFaultMsg" />
628 <wsdl:fault name="RuntimeFault" message="vbox:RuntimeFaultMsg" />
629 </xsl:when>
630 <xsl:otherwise>
631 <wsdl:fault name="InvalidObjectFault">
632 <soap:fault name="InvalidObjectFault">
633 <xsl:attribute name="use"><xsl:value-of select="$G_parmfmt" /></xsl:attribute>
634 </soap:fault>
635 </wsdl:fault>
636 <wsdl:fault name="RuntimeFault">
637 <soap:fault name="RuntimeFault">
638 <xsl:attribute name="use"><xsl:value-of select="$G_parmfmt" /></xsl:attribute>
639 </soap:fault>
640 </wsdl:fault>
641 </xsl:otherwise>
642 </xsl:choose>
643 </wsdl:operation>
644</xsl:template>
645
646<!--
647 function verifyInterface
648-->
649<xsl:template name="verifyInterface">
650 <xsl:param name="ifname" />
651 <xsl:param name="wsmap" />
652
653 <xsl:choose>
654 <xsl:when test="$wsmap='global'" />
655 <xsl:when test="$wsmap='managed'" />
656 <xsl:when test="$wsmap='explicit'" />
657 <xsl:when test="$wsmap='struct'" />
658 <xsl:when test="$wsmap='suppress'" />
659 <xsl:otherwise>
660 <xsl:call-template name="fatalError">
661 <xsl:with-param name="msg" select="concat(local-name(), ' template: Interface &quot;', $ifname, '&quot; has invalid wsmap attribute &quot;', $wsmap, '&quot; in XIDL.')" />
662 </xsl:call-template>
663 </xsl:otherwise>
664 </xsl:choose>
665
666 <!-- now make sure we have each interface only once -->
667 <xsl:if test="(count(//library/interface[@name=$ifname]) > 1)">
668 <xsl:call-template name="fatalError">
669 <xsl:with-param name="msg" select="concat(local-name(), ' template: There is more than one interface with a name=&quot;', $ifname, '&quot; attribute.')" />
670 </xsl:call-template>
671 </xsl:if>
672</xsl:template>
673
674<!--
675 function emitMessagesForInterface
676-->
677<xsl:template name="emitMessagesForInterface">
678 <xsl:param name="ifname" />
679 <xsl:param name="wsmap" />
680
681 <!-- 1) outside the portType, here come the in/out methods for all the "operations" we declare below;
682 a) for attributes (get/set methods)
683 b) for "real" methods
684 -->
685 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('************* messages for interface &quot;', $ifname, '&quot;')" /></xsl:call-template>
686 <!-- a) attributes first -->
687 <xsl:for-each select="attribute">
688 <xsl:variable name="attrname"><xsl:value-of select="@name" /></xsl:variable>
689 <xsl:variable name="attrtype"><xsl:value-of select="@type" /></xsl:variable>
690 <xsl:variable name="attrreadonly"><xsl:value-of select="@readonly" /></xsl:variable>
691 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('messages for ', $ifname, '::', $attrname, ': attribute of type &quot;', $attrtype, '&quot;, readonly: ', $attrreadonly)" /></xsl:call-template>
692 <!-- skip this attribute if it has parameters of a type that has wsmap="suppress" -->
693 <xsl:choose>
694 <xsl:when test="( $attrtype=($G_setSuppressedInterfaces/@name) )">
695 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is of a suppressed type')" /></xsl:comment>
696 </xsl:when>
697 <xsl:when test="@wsmap = 'suppress'">
698 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is suppressed')" /></xsl:comment>
699 </xsl:when>
700 <xsl:otherwise>
701 <xsl:choose>
702 <xsl:when test="@readonly='yes'">
703 <xsl:comment> readonly attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
704 </xsl:when>
705 <xsl:otherwise>
706 <xsl:comment> read/write attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
707 </xsl:otherwise>
708 </xsl:choose>
709 <!-- aa) get method: emit request and result -->
710 <xsl:call-template name="emitGetAttributeMessages">
711 <xsl:with-param name="ifname" select="$ifname" />
712 <xsl:with-param name="wsmap" select="$wsmap" />
713 <xsl:with-param name="attrname" select="$attrname" />
714 <xsl:with-param name="attrtype" select="$attrtype" />
715 </xsl:call-template>
716 <!-- bb) emit a set method if the attribute is read/write -->
717 <xsl:if test="not($attrreadonly='yes')">
718 <xsl:call-template name="emitSetAttributeMessages">
719 <xsl:with-param name="ifname" select="$ifname" />
720 <xsl:with-param name="wsmap" select="$wsmap" />
721 <xsl:with-param name="attrname" select="$attrname" />
722 <xsl:with-param name="attrtype" select="$attrtype" />
723 </xsl:call-template>
724 </xsl:if>
725 </xsl:otherwise>
726 </xsl:choose>
727 </xsl:for-each> <!-- select="attribute" -->
728 <!-- b) "real" methods after the attributes -->
729 <xsl:for-each select="method">
730 <xsl:variable name="methodname"><xsl:value-of select="@name" /></xsl:variable>
731 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('messages for ', $ifname, '::', $methodname, ': method')" /></xsl:call-template>
732 <xsl:comment> method <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$methodname" /> </xsl:comment>
733 <!-- skip this method if it has parameters of a type that has wsmap="suppress" -->
734 <xsl:choose>
735 <xsl:when test=" (param[@type=($G_setSuppressedInterfaces/@name)])
736 or (param[@mod='ptr'])" >
737 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it has parameters with suppressed types')" /></xsl:comment>
738 </xsl:when>
739 <xsl:when test="@wsmap = 'suppress'">
740 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it is suppressed')" /></xsl:comment>
741 </xsl:when>
742 <xsl:otherwise>
743 <!-- always emit a request message -->
744 <xsl:call-template name="emitRequestMessage">
745 <xsl:with-param name="_ifname" select="$ifname" />
746 <xsl:with-param name="_wsmap" select="$wsmap" />
747 <xsl:with-param name="_methodname" select="$methodname" />
748 <xsl:with-param name="_params" select="param" />
749 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
750 </xsl:call-template>
751 <!-- emit a second "result" message only if the method has "out" arguments or a return value -->
752 <!-- <xsl:if test="(count(param[@dir='out'] | param[@dir='return']) > 0)"> -->
753 <xsl:call-template name="emitResultMessage">
754 <xsl:with-param name="_ifname" select="$ifname" />
755 <xsl:with-param name="_wsmap" select="$wsmap" />
756 <xsl:with-param name="_methodname" select="@name" />
757 <xsl:with-param name="_params" select="param" />
758 <xsl:with-param name="elname" select="'wsdl:part'" /> <!-- "part" or "element" -->
759 </xsl:call-template>
760 <!-- </xsl:if> -->
761 </xsl:otherwise>
762 </xsl:choose>
763 </xsl:for-each>
764</xsl:template>
765
766<!--
767 function emitOperationsForInterface
768 -->
769<xsl:template name="emitOperationsInPortTypeForInterface">
770 <xsl:param name="ifname" />
771 <xsl:param name="wsmap" />
772
773 <!-- a) again, first for the attributes whose messages we produced above -->
774 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('************* portType for interface &quot;', $ifname, '&quot;')" /></xsl:call-template>
775 <xsl:for-each select="attribute">
776 <xsl:variable name="attrname" select="@name" />
777 <xsl:variable name="attrtype" select="@type" />
778 <xsl:variable name="attrreadonly" select="@readonly" />
779 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('operations for ', $ifname, '::', $attrname, ': attribute of type &quot;', $attrtype, '&quot;, readonly: ', $attrreadonly)" /></xsl:call-template>
780 <xsl:choose>
781 <!-- skip this attribute if it has parameters of a type that has wsmap="suppress" -->
782 <xsl:when test="( $attrtype=($G_setSuppressedInterfaces/@name) )">
783 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is of a suppressed type')" /></xsl:comment>
784 </xsl:when>
785 <xsl:when test="@wsmap = 'suppress'">
786 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is suppressed')" /></xsl:comment>
787 </xsl:when>
788 <xsl:otherwise>
789 <xsl:variable name="attrGetter"><xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
790 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $G_attributeGetPrefix, $attrname)" /></xsl:call-template>
791 <xsl:call-template name="emitInOutOperation">
792 <xsl:with-param name="_ifname" select="$ifname" />
793 <xsl:with-param name="_methodname" select="$attrGetter" />
794 <xsl:with-param name="_params" select="/.." />
795 <xsl:with-param name="_resulttype" select='$attrtype' />
796 </xsl:call-template>
797 <xsl:if test="not($attrreadonly='yes')">
798 <xsl:variable name="attrSetter"><xsl:call-template name="makeSetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
799 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $attrSetter)" /></xsl:call-template>
800 <xsl:call-template name="emitInOutOperation">
801 <xsl:with-param name="_ifname" select="$ifname" />
802 <xsl:with-param name="_methodname" select="$attrSetter" />
803 <xsl:with-param name="_params" select="/.." />
804 <xsl:with-param name="_resulttype" select='$attrtype' />
805 </xsl:call-template>
806 </xsl:if>
807 </xsl:otherwise>
808 </xsl:choose>
809 </xsl:for-each>
810 <!-- b) then for the "real" methods whose messages we produced above -->
811 <xsl:for-each select="method">
812 <xsl:variable name="methodname"><xsl:value-of select="@name" /></xsl:variable>
813 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('operations for ', $ifname, '::', $methodname, ': method')" /></xsl:call-template>
814 <!-- skip this method if it has parameters of a type that has wsmap="suppress" -->
815 <xsl:choose>
816 <xsl:when test=" (param[@type=($G_setSuppressedInterfaces/@name)])
817 or (param[@mod='ptr'])" >
818 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it has parameters with suppressed types')" /></xsl:comment>
819 </xsl:when>
820 <xsl:when test="@wsmap = 'suppress'">
821 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it is suppressed')" /></xsl:comment>
822 </xsl:when>
823 <xsl:otherwise>
824 <xsl:call-template name="emitInOutOperation">
825 <xsl:with-param name="_ifname" select="$ifname" />
826 <xsl:with-param name="_methodname" select="$methodname" />
827 <xsl:with-param name="_params" select="param" />
828 </xsl:call-template>
829 </xsl:otherwise>
830 </xsl:choose>
831 </xsl:for-each>
832</xsl:template>
833
834<!--
835 function emitOperationsInBindingForInterface
836 -->
837<xsl:template name="emitOperationsInBindingForInterface">
838 <xsl:param name="ifname" />
839 <xsl:param name="wsmap" />
840
841 <!-- a) again, first for the attributes whose messages we produced above -->
842 <xsl:for-each select="attribute">
843 <xsl:variable name="attrname" select="@name" />
844 <xsl:variable name="attrtype" select="@type" />
845 <xsl:variable name="attrreadonly" select="@readonly" />
846 <!-- skip this attribute if it has parameters of a type that has wsmap="suppress" -->
847 <xsl:choose>
848 <xsl:when test="( $attrtype=($G_setSuppressedInterfaces/@name) )">
849 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is of a suppressed type')" /></xsl:comment>
850 </xsl:when>
851 <xsl:when test="@wsmap = 'suppress'">
852 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is suppressed')" /></xsl:comment>
853 </xsl:when>
854 <xsl:otherwise>
855 <xsl:variable name="attrGetter"><xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
856 <xsl:call-template name="emitInOutOperation">
857 <xsl:with-param name="_ifname" select="$ifname" />
858 <xsl:with-param name="_methodname" select="$attrGetter" />
859 <xsl:with-param name="_params" select="/.." />
860 <xsl:with-param name="_resulttype" select='$attrtype' />
861 <xsl:with-param name="_fSoap" select="1" />
862 </xsl:call-template>
863 <xsl:if test="not($attrreadonly='yes')">
864 <xsl:variable name="attrSetter"><xsl:call-template name="makeSetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
865 <xsl:call-template name="emitInOutOperation">
866 <xsl:with-param name="_ifname" select="$ifname" />
867 <xsl:with-param name="_methodname" select="$attrSetter" />
868 <xsl:with-param name="_params" select="/.." />
869 <xsl:with-param name="_resulttype" select='$attrtype' />
870 <xsl:with-param name="_fSoap" select="1" />
871 </xsl:call-template>
872 </xsl:if>
873 </xsl:otherwise>
874 </xsl:choose>
875 </xsl:for-each>
876 <!-- b) then for the "real" methods whose messages we produced above -->
877 <xsl:for-each select="method">
878 <xsl:variable name="methodname"><xsl:value-of select="@name" /></xsl:variable>
879 <!-- skip this method if it has parameters of a type that has wsmap="suppress" -->
880 <xsl:choose>
881 <xsl:when test=" (param[@type=($G_setSuppressedInterfaces/@name)])
882 or (param[@mod='ptr'])" >
883 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it has parameters with suppressed types')" /></xsl:comment>
884 </xsl:when>
885 <xsl:when test="@wsmap = 'suppress'">
886 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it is suppressed')" /></xsl:comment>
887 </xsl:when>
888 <xsl:otherwise>
889 <xsl:call-template name="emitInOutOperation">
890 <xsl:with-param name="_ifname" select="$ifname" />
891 <xsl:with-param name="_methodname" select="$methodname" />
892 <xsl:with-param name="_params" select="param" />
893 <xsl:with-param name="_fSoap" select="1" />
894 </xsl:call-template>
895 </xsl:otherwise>
896 </xsl:choose>
897 </xsl:for-each>
898</xsl:template>
899
900<!--**********************************************************************
901 *
902 * matches
903 *
904 **********************************************************************-->
905
906<!--
907 template for "idl" match; this emits the header of the target file
908 and recurses into the libraries with interfaces (which are matched below)
909 -->
910<xsl:template match="/idl">
911 <xsl:comment>
912 DO NOT EDIT! This is a generated file.
913 Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
914 Generator: src/VBox/Main/webservice/websrv-wsdl.xsl
915</xsl:comment>
916
917 <xsl:apply-templates />
918
919</xsl:template>
920
921<!--
922 template for "if" match: ignore all ifs except those for wsdl
923 -->
924<xsl:template match="if">
925 <xsl:if test="@target='wsdl'">
926 <xsl:apply-templates/>
927 </xsl:if>
928</xsl:template>
929
930<!--
931 template for "cpp": ignore
932 -->
933<xsl:template match="cpp">
934<!-- ignore this -->
935</xsl:template>
936
937
938<!-- - - - - - - - - - - - - - - - - - - - - - -
939 class
940 - - - - - - - - - - - - - - - - - - - - - - -->
941
942<xsl:template match="module/class">
943<!-- swallow -->
944</xsl:template>
945
946<!-- - - - - - - - - - - - - - - - - - - - - - -
947 enum
948 - - - - - - - - - - - - - - - - - - - - - - -->
949
950<xsl:template match="enum">
951</xsl:template>
952
953<!-- - - - - - - - - - - - - - - - - - - - - - -
954 desc
955 - - - - - - - - - - - - - - - - - - - - - - -->
956
957<xsl:template match="desc">
958<!-- swallow -->
959</xsl:template>
960
961<!-- - - - - - - - - - - - - - - - - - - - - - -
962 note
963 - - - - - - - - - - - - - - - - - - - - - - -->
964
965<xsl:template match="note">
966 <xsl:apply-templates />
967</xsl:template>
968
969<!--
970 "library" match: we use this to emit most of the WSDL <types> section.
971 With WSDL "document" style, this requires us to go through all interfaces
972 and emit complexTypes for all method arguments and return values.
973-->
974<xsl:template match="library">
975 <wsdl:definitions
976 name="VirtualBox"
977 xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
978 <xsl:attribute name="targetNamespace"><xsl:value-of select="$G_targetNamespace" /></xsl:attribute>
979 <!-- at top of WSDL file, dump a <types> section with user-defined types -->
980 <xsl:comment>
981 ******************************************************
982 *
983 * WSDL type definitions in XML Schema
984 *
985 ******************************************************
986</xsl:comment>
987 <wsdl:types>
988 <xsd:schema>
989 <xsl:attribute name="targetNamespace"><xsl:value-of select='$G_targetNamespace' /></xsl:attribute>
990
991 <!-- type-define all enums -->
992 <xsl:comment>
993 ******************************************************
994 * enumerations
995 ******************************************************
996</xsl:comment>
997 <xsl:for-each select="//enum">
998 <xsl:comment> enum: <xsl:value-of select="@name" /> -
999 <xsl:for-each select="const">
1000 <xsl:value-of select="@name" />: <xsl:value-of select="@value" /> -
1001 </xsl:for-each>
1002</xsl:comment>
1003 <xsd:simpleType>
1004 <xsl:attribute name="name"><xsl:value-of select="@name" /></xsl:attribute>
1005 <xsd:restriction base="xsd:string">
1006 <!-- XML Schema does not seem to have a C-like mapping between identifiers and numbers;
1007 instead, it treats enumerations like strings that can have only specific values. -->
1008 <xsl:for-each select="const">
1009 <xsd:enumeration>
1010 <xsl:attribute name="value"><xsl:value-of select="@name" /></xsl:attribute>
1011 </xsd:enumeration>
1012 </xsl:for-each>
1013 </xsd:restriction>
1014 </xsd:simpleType>
1015 </xsl:for-each>
1016
1017 <!-- type-define all interfaces that have wsmap=struct as structs (complexTypes) -->
1018 <xsl:comment>
1019 ******************************************************
1020 * structs
1021 ******************************************************
1022</xsl:comment>
1023 <xsl:for-each select="//interface[@wsmap='struct']">
1024 <xsl:comment> interface <xsl:value-of select="@name" /> as struct: </xsl:comment>
1025 <xsd:complexType>
1026 <xsl:attribute name="name"><xsl:value-of select="@name" /></xsl:attribute>
1027 <xsd:sequence>
1028 <xsl:for-each select="attribute">
1029 <xsd:element>
1030 <xsl:attribute name="name"><xsl:value-of select="@name" /></xsl:attribute>
1031 <xsl:attribute name="type">
1032 <xsl:call-template name="emitConvertedType">
1033 <xsl:with-param name="type" select="@type" />
1034 </xsl:call-template>
1035 </xsl:attribute>
1036 </xsd:element>
1037 </xsl:for-each>
1038 </xsd:sequence>
1039 </xsd:complexType>
1040 </xsl:for-each>
1041
1042 <!-- for WSDL 'document' style, we need to emit elements since we can't
1043 refer to types in message parts as with RPC style -->
1044 <xsl:if test="$G_basefmt='document'">
1045 <xsl:comment>
1046 ******************************************************
1047 * elements for message arguments (parts); generated for WSDL 'document' style
1048 ******************************************************
1049</xsl:comment>
1050
1051 <xsl:for-each select="//interface">
1052 <xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
1053 <xsl:variable name="wsmap"><xsl:value-of select="@wsmap" /></xsl:variable>
1054
1055 <xsl:if test='not( ($wsmap="suppress") or ($wsmap="struct") )'>
1056 <xsl:comment>Interface <xsl:copy-of select="$ifname" /></xsl:comment>
1057 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('************* types: elements for interface &quot;', $ifname, '&quot;')" /></xsl:call-template>
1058 <!-- a) attributes first -->
1059 <xsl:for-each select="attribute">
1060 <xsl:variable name="attrname"><xsl:value-of select="@name" /></xsl:variable>
1061 <xsl:variable name="attrtype"><xsl:value-of select="@type" /></xsl:variable>
1062 <xsl:variable name="attrsafearray"><xsl:value-of select="@safearray" /></xsl:variable>
1063 <xsl:variable name="attrreadonly"><xsl:value-of select="@readonly" /></xsl:variable>
1064 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('elements for ', $ifname, '::', $attrname, ': attribute of type &quot;', $attrtype, '&quot;, readonly: ', $attrreadonly)" /></xsl:call-template>
1065 <!-- skip this attribute if it has parameters of a type that has wsmap="suppress" -->
1066 <xsl:choose>
1067 <xsl:when test="( $attrtype=($G_setSuppressedInterfaces/@name) )">
1068 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrtype, ' for it is of a suppressed type')" /></xsl:comment>
1069 </xsl:when>
1070 <xsl:when test="@wsmap = 'suppress'">
1071 <xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrname, ' for it is suppressed')" /></xsl:comment>
1072 </xsl:when>
1073 <xsl:otherwise>
1074 <xsl:choose>
1075 <xsl:when test="@readonly='yes'">
1076 <xsl:comment> readonly attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
1077 </xsl:when>
1078 <xsl:otherwise>
1079 <xsl:comment> read/write attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
1080 </xsl:otherwise>
1081 </xsl:choose>
1082 <!-- aa) get method: emit request and result -->
1083 <xsl:call-template name="emitGetAttributeElements">
1084 <xsl:with-param name="ifname" select="$ifname" />
1085 <xsl:with-param name="wsmap" select="$wsmap" />
1086 <xsl:with-param name="attrname" select="$attrname" />
1087 <xsl:with-param name="attrtype" select="$attrtype" />
1088 <xsl:with-param name="attrsafearray" select="$attrsafearray" />
1089 </xsl:call-template>
1090 <!-- bb) emit a set method if the attribute is read/write -->
1091 <xsl:if test="not($attrreadonly='yes')">
1092 <xsl:variable name="attrSetter"><xsl:call-template name="makeSetterName"><xsl:with-param name="attrname" select="$attrname" /></xsl:call-template></xsl:variable>
1093 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('..', $ifname, '::', $attrSetter)" /></xsl:call-template>
1094 <xsl:call-template name="emitRequestElements">
1095 <xsl:with-param name="_ifname" select="$ifname" />
1096 <xsl:with-param name="_wsmap" select="$wsmap" />
1097 <xsl:with-param name="_methodname" select="$attrSetter" />
1098 <xsl:with-param name="_params" select="/.." />
1099 <xsl:with-param name="_valuetype" select="$attrtype" />
1100 <xsl:with-param name="_valuesafearray" select="$attrsafearray" />
1101 </xsl:call-template>
1102 <xsl:call-template name="emitResultElements">
1103 <xsl:with-param name="_ifname" select="$ifname" />
1104 <xsl:with-param name="_methodname" select="$attrSetter" />
1105 <xsl:with-param name="_params" select="/.." />
1106 </xsl:call-template>
1107 </xsl:if>
1108 </xsl:otherwise>
1109 </xsl:choose>
1110 </xsl:for-each> <!-- select="attribute" -->
1111 <!-- b) "real" methods after the attributes -->
1112 <xsl:for-each select="method">
1113 <xsl:variable name="methodname"><xsl:value-of select="@name" /></xsl:variable>
1114 <xsl:call-template name="debugMsg"><xsl:with-param name="msg" select="concat('messages for ', $ifname, '::', $methodname, ': method')" /></xsl:call-template>
1115 <xsl:comment> method <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$methodname" /> </xsl:comment>
1116 <!-- skip this method if it has parameters of a type that has wsmap="suppress" -->
1117 <xsl:choose>
1118 <xsl:when test=" (param[@type=($G_setSuppressedInterfaces/@name)])
1119 or (param[@mod='ptr'])" >
1120 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it has parameters with suppressed types')" /></xsl:comment>
1121 </xsl:when>
1122 <xsl:when test="@wsmap = 'suppress'">
1123 <xsl:comment><xsl:value-of select="concat('skipping method ', $methodname, ' for it is suppressed')" /></xsl:comment>
1124 </xsl:when>
1125 <xsl:otherwise>
1126 <!-- always emit a request message -->
1127 <xsl:call-template name="emitRequestElements">
1128 <xsl:with-param name="_ifname" select="$ifname" />
1129 <xsl:with-param name="_wsmap" select="$wsmap" />
1130 <xsl:with-param name="_methodname" select="$methodname" />
1131 <xsl:with-param name="_params" select="param" />
1132 </xsl:call-template>
1133 <!-- emit a second "result" message only if the method has "out" arguments or a return value -->
1134 <!-- <xsl:if test="(count(param[@dir='out'] | param[@dir='return']) > 0)"> -->
1135 <xsl:call-template name="emitResultElements">
1136 <xsl:with-param name="_ifname" select="$ifname" />
1137 <xsl:with-param name="_wsmap" select="$wsmap" />
1138 <xsl:with-param name="_methodname" select="$methodname" />
1139 <xsl:with-param name="_params" select="param" />
1140 </xsl:call-template>
1141 <!-- </xsl:if> -->
1142 </xsl:otherwise>
1143 </xsl:choose>
1144 </xsl:for-each>
1145 </xsl:if> <!-- <xsl:if test='not( ($wsmap="suppress") or ($wsmap="struct") )'> -->
1146 </xsl:for-each>
1147
1148 </xsl:if> <!-- <xsl:if test="$G_basefmt='document'"> -->
1149
1150 <xsl:comment>
1151 ******************************************************
1152 * faults
1153 ******************************************************
1154</xsl:comment>
1155
1156 <xsd:element name="InvalidObjectFault">
1157 <xsd:complexType>
1158 <xsd:sequence>
1159 <xsd:element name="badObjectID">
1160 <xsl:attribute name="type">
1161 <xsl:value-of select="$G_typeObjectRef" />
1162 </xsl:attribute>
1163 </xsd:element>
1164 </xsd:sequence>
1165 </xsd:complexType>
1166 </xsd:element>
1167
1168 <xsd:element name="RuntimeFault">
1169 <xsd:complexType>
1170 <xsd:sequence>
1171 <xsd:element name="resultCode" type="xsd:int" />
1172 <xsd:element name="returnval">
1173 <xsl:attribute name="type">
1174 <xsl:value-of select="$G_typeObjectRef" />
1175 </xsl:attribute>
1176 </xsd:element>
1177 </xsd:sequence>
1178 </xsd:complexType>
1179 </xsd:element>
1180
1181 <!-- done! -->
1182 </xsd:schema>
1183
1184
1185 </wsdl:types>
1186
1187 <wsdl:message name="InvalidObjectFaultMsg">
1188 <wsdl:part name="fault" element="vbox:InvalidObjectFault" />
1189 </wsdl:message>
1190 <wsdl:message name="RuntimeFaultMsg">
1191 <wsdl:part name="fault" element="vbox:RuntimeFault" />
1192 </wsdl:message>
1193
1194 <xsl:comment>
1195 ******************************************************
1196 *
1197 * messages for all interfaces
1198 *
1199 ******************************************************
1200</xsl:comment>
1201
1202 <xsl:for-each select="//interface">
1203 <xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
1204 <xsl:variable name="wsmap"><xsl:value-of select="@wsmap" /></xsl:variable>
1205
1206 <xsl:call-template name="verifyInterface">
1207 <xsl:with-param name="ifname" select="$ifname" />
1208 <xsl:with-param name="wsmap" select="$wsmap" />
1209 </xsl:call-template>
1210
1211 <xsl:comment>
1212 *************************************
1213 messages for interface <xsl:copy-of select="$ifname" />
1214 *************************************
1215 </xsl:comment>
1216
1217 <xsl:if test='not( ($wsmap="suppress") or ($wsmap="struct") )'>
1218 <xsl:call-template name="emitMessagesForInterface">
1219 <xsl:with-param name="ifname" select="$ifname" />
1220 <xsl:with-param name="wsmap" select="$wsmap" />
1221 </xsl:call-template>
1222 </xsl:if>
1223 </xsl:for-each>
1224
1225 <xsl:comment>
1226 ******************************************************
1227 *
1228 * one portType for all interfaces
1229 *
1230 ******************************************************
1231 </xsl:comment>
1232
1233 <wsdl:portType>
1234 <xsl:attribute name="name"><xsl:copy-of select="'vbox'" /><xsl:value-of select="$G_portTypeSuffix" /></xsl:attribute>
1235
1236 <xsl:for-each select="//interface">
1237 <xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
1238 <xsl:variable name="wsmap"><xsl:value-of select="@wsmap" /></xsl:variable>
1239
1240 <xsl:comment>
1241 *************************************
1242 operations in portType for interface <xsl:copy-of select="$ifname" />
1243 *************************************
1244 </xsl:comment>
1245
1246 <xsl:if test='not( ($wsmap="suppress") or ($wsmap="struct") )'>
1247 <xsl:call-template name="emitOperationsInPortTypeForInterface">
1248 <xsl:with-param name="ifname" select="$ifname" />
1249 <xsl:with-param name="wsmap" select="$wsmap" />
1250 </xsl:call-template>
1251 </xsl:if>
1252 </xsl:for-each>
1253 </wsdl:portType>
1254
1255 <xsl:comment>
1256 ******************************************************
1257 *
1258 * one binding for all interfaces
1259 *
1260 ******************************************************
1261 </xsl:comment>
1262
1263 <wsdl:binding>
1264 <xsl:attribute name="name"><xsl:value-of select="concat('vbox', $G_bindingSuffix)" /></xsl:attribute>
1265 <xsl:attribute name="type"><xsl:value-of select="concat('vbox:vbox', $G_portTypeSuffix)" /></xsl:attribute>
1266
1267 <soap:binding>
1268 <xsl:attribute name="style"><xsl:value-of select="$G_basefmt" /></xsl:attribute>
1269 <xsl:attribute name="transport">http://schemas.xmlsoap.org/soap/http</xsl:attribute>
1270 </soap:binding>
1271
1272 <xsl:for-each select="//interface">
1273 <xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
1274 <xsl:variable name="wsmap"><xsl:value-of select="@wsmap" /></xsl:variable>
1275
1276 <xsl:comment>
1277 *************************************
1278 operations in portType for interface <xsl:copy-of select="$ifname" />
1279 *************************************
1280 </xsl:comment>
1281
1282 <xsl:if test='not( ($wsmap="suppress") or ($wsmap="struct") )'>
1283 <xsl:call-template name="emitOperationsInBindingForInterface">
1284 <xsl:with-param name="ifname" select="$ifname" />
1285 <xsl:with-param name="wsmap" select="$wsmap" />
1286 </xsl:call-template>
1287 </xsl:if>
1288 </xsl:for-each>
1289 </wsdl:binding>
1290
1291 </wsdl:definitions>
1292</xsl:template>
1293
1294
1295</xsl:stylesheet>
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