websrv-php.xsl@ 96399

Last change on this file since 96399 was 96308, checked in by vboxsync, 2 years ago
src/VBox/Main: XML/XSL comment fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 21.5 KB

Line
1	<xsl:stylesheet version = '1.0'
2	xmlns:xsl='http://www.w3.org/1999/XSL/Transform'
3	xmlns:vbox="http://www.virtualbox.org/">
4
5	<!--
6	websrv-php.xsl:
7	XSLT stylesheet that generates vboxServiceWrappers.php from
8	VirtualBox.xidl. This PHP file represents our
9	web service API. Depends on WSDL file for actual SOAP bindings.
10
11	Contributed by James Lucas (mjlucas at eng.uts.edu.au).
12	-->
13	<!--
14	Copyright (C) 2008-2022 Oracle Corporation
15
16	This file is part of VirtualBox Open Source Edition (OSE), as
17	available from http://www.virtualbox.org. This file is free software;
18	you can redistribute it and/or modify it under the terms of the GNU
19	General Public License (GPL) as published by the Free Software
20	Foundation, in version 2 as it comes in the "COPYING" file of the
21	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
22	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
23	-->
24
25
26	<xsl:output
27	method="text"
28	version="1.0"
29	encoding="utf-8"
30	indent="no"/>
31
32	<xsl:include href="../idl/typemap-shared.inc.xsl" />
33
34	<xsl:variable name="G_setSuppressedInterfaces"
35	select="//interface[@wsmap='suppress']" />
36
37	<xsl:key name="G_keyInterfacesByName" match="//interface[@name]" use="@name"/>
38
39	<xsl:template name="emitOutParam">
40	<xsl:param name="type" />
41	<xsl:param name="value" />
42	<xsl:param name="safearray" />
43
44	<xsl:choose>
45	<xsl:when test="$type='wstring' or $type='uuid'">
46	<xsl:call-template name="emitPrimitive">
47	<xsl:with-param name="type">string</xsl:with-param>
48	<xsl:with-param name="value" select="$value" />
49	<xsl:with-param name="safearray" select="$safearray"/>
50	</xsl:call-template>
51	</xsl:when>
52	<xsl:when test="$type='boolean'">
53	<xsl:call-template name="emitPrimitive">
54	<xsl:with-param name="type">bool</xsl:with-param>
55	<xsl:with-param name="value" select="$value" />
56	<xsl:with-param name="safearray" select="$safearray"/>
57	</xsl:call-template>
58	</xsl:when>
59	<xsl:when test="$type='short' or $type='unsigned short' or $type='long' or $type='octet'">
60	<xsl:call-template name="emitPrimitive">
61	<xsl:with-param name="type">int</xsl:with-param>
62	<xsl:with-param name="value" select="$value" />
63	<xsl:with-param name="safearray" select="$safearray"/>
64	</xsl:call-template>
65	</xsl:when>
66	<xsl:when test="$type='double' or $type='float' or $type='unsigned long' or $type='long long' or $type='unsigned long long'">
67	<xsl:call-template name="emitPrimitive">
68	<xsl:with-param name="type">float</xsl:with-param>
69	<xsl:with-param name="value" select="$value" />
70	<xsl:with-param name="safearray" select="$safearray"/>
71	</xsl:call-template>
72	</xsl:when>
73	<xsl:when test="$type='$unknown'">
74	<xsl:call-template name="emitObject">
75	<xsl:with-param name="type">VBox_ManagedObject</xsl:with-param>
76	<xsl:with-param name="value" select="$value" />
77	<xsl:with-param name="safearray" select="$safearray"/>
78	</xsl:call-template>
79	</xsl:when>
80	<xsl:otherwise>
81	<xsl:call-template name="emitObject">
82	<xsl:with-param name="type" select="$type" />
83	<xsl:with-param name="value" select="$value" />
84	<xsl:with-param name="safearray" select="$safearray"/>
85	</xsl:call-template>
86	</xsl:otherwise>
87	</xsl:choose>
88	</xsl:template>
89
90	<xsl:template name="emitObject">
91	<xsl:param name="type" />
92	<xsl:param name="value" />
93	<xsl:param name="safearray" />
94	<xsl:choose>
95	<xsl:when test="$safearray='yes'">
96	<xsl:text>new </xsl:text><xsl:value-of select="$type" />Collection ($this->connection, (array)<xsl:value-of select="$value"/><xsl:text>)</xsl:text>
97	</xsl:when>
98	<xsl:otherwise>
99	<xsl:text>new </xsl:text><xsl:value-of select="$type" /> ($this->connection, <xsl:value-of select="$value"/><xsl:text>)</xsl:text>
100	</xsl:otherwise>
101	</xsl:choose>
102	</xsl:template>
103
104	<xsl:template name="emitPrimitive">
105	<xsl:param name="type" />
106	<xsl:param name="value" />
107	<xsl:param name="safearray" />
108	<xsl:choose>
109	<xsl:when test="$safearray='yes'">
110	<xsl:text>(array)</xsl:text><xsl:value-of select="$value"/>
111	</xsl:when>
112	<xsl:otherwise>
113	<xsl:text>(</xsl:text><xsl:value-of select="$type" /><xsl:text>)</xsl:text><xsl:value-of select="$value"/>
114	</xsl:otherwise>
115	</xsl:choose>
116	</xsl:template>
117
118	<xsl:template name="emitGetAttribute">
119	<xsl:param name="ifname" />
120	<xsl:param name="attrname" />
121	<xsl:param name="attrtype" />
122	<xsl:param name="attrsafearray" />
123	<xsl:variable name="fname"><xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="$attrname"/></xsl:call-template> </xsl:variable>
124	public function <xsl:value-of select="$fname"/>()
125	{
126	$request = new stdClass();
127	$request->_this = $this->handle;
128	$response = $this->connection->__soapCall('<xsl:value-of select="$ifname"/>_<xsl:value-of select="$fname"/>', array((array)$request));
129	<xsl:text>return </xsl:text>
130	<xsl:call-template name="emitOutParam">
131	<xsl:with-param name="type" select="$attrtype" />
132	<xsl:with-param name="value" select="concat('$response->','returnval')" />
133	<xsl:with-param name="safearray" select="@safearray"/>
134	</xsl:call-template><xsl:text>;</xsl:text>
135	}
136	</xsl:template>
137
138	<xsl:template name="emitSetAttribute">
139	<xsl:param name="ifname" />
140	<xsl:param name="attrname" />
141	<xsl:param name="attrtype" />
142	<xsl:param name="attrsafearray" />
143	<xsl:variable name="fname"><xsl:call-template name="makeSetterName"><xsl:with-param name="attrname" select="$attrname"/></xsl:call-template></xsl:variable>
144	public function <xsl:value-of select="$fname"/>($value)
145	{
146	$request = new stdClass();
147	$request->_this = $this->handle;
148	<xsl:choose>
149	<xsl:when test="$attrsafearray='yes'"> if (is_array($value) \|\| is_null($value) \|\| is_scalar($value))</xsl:when>
150	<xsl:otherwise> if (is_null($value) \|\| is_scalar($value))</xsl:otherwise>
151	</xsl:choose>
152	{
153	$request-><xsl:value-of select="$attrname"/> = $value;
154	}
155	else
156	{
157	$request-><xsl:value-of select="$attrname"/> = $value->handle;
158	}
159	$this->connection->__soapCall('<xsl:value-of select="$ifname"/>_<xsl:value-of select="$fname"/>', array((array)$request));
160	}
161	</xsl:template>
162
163	<xsl:template name="interface">
164	<xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
165	<xsl:variable name="wsmap"><xsl:value-of select="@wsmap" /></xsl:variable>
166	<xsl:variable name="extends"><xsl:value-of select="@extends" /></xsl:variable>
167	<xsl:text>
168	/**
169	* Generated VBoxWebService Interface Wrapper
170	*/
171	</xsl:text>
172	<xsl:choose>
173	<xsl:when test="($extends = '$unknown') or ($extends = '$errorinfo')">
174	<xsl:value-of select="concat('class ', $ifname, ' extends VBox_ManagedObject { ')" />
175	</xsl:when>
176	<xsl:when test="count(key('G_keyInterfacesByName', $extends)) > 0">
177	<xsl:value-of select="concat('class ', $ifname, ' extends ', $extends, ' { ')" />
178	</xsl:when>
179	</xsl:choose>
180	<xsl:for-each select="method">
181	<xsl:if test="not((param[@type=($G_setSuppressedInterfaces/@name)])
182	or (param[@mod='ptr']))" >
183	<xsl:call-template name="method">
184	<xsl:with-param name="wsmap" select="$wsmap" />
185	</xsl:call-template>
186	</xsl:if>
187	</xsl:for-each>
188	<xsl:for-each select="attribute">
189	<xsl:variable name="attrname"><xsl:value-of select="@name" /></xsl:variable>
190	<xsl:variable name="attrtype"><xsl:value-of select="@type" /></xsl:variable>
191	<xsl:variable name="attrreadonly"><xsl:value-of select="@readonly" /></xsl:variable>
192	<xsl:variable name="attrsafearray"><xsl:value-of select="@safearray" /></xsl:variable>
193	<!-- skip this attribute if it has parameters of a type that has wsmap="suppress" -->
194	<xsl:choose>
195	<xsl:when test="( $attrtype=($G_setSuppressedInterfaces/@name) )">
196	<xsl:comment><xsl:value-of select="concat('skipping attribute ', $attrtype, ' for it is of a suppressed type')" /></xsl:comment>
197	</xsl:when>
198	<xsl:otherwise>
199	<xsl:choose>
200	<xsl:when test="@readonly='yes'">
201	<xsl:comment> readonly attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
202	</xsl:when>
203	<xsl:otherwise>
204	<xsl:comment> read/write attribute <xsl:copy-of select="$ifname" />::<xsl:copy-of select="$attrname" /> </xsl:comment>
205	</xsl:otherwise>
206	</xsl:choose>
207	<!-- aa) get method: emit request and result -->
208	<xsl:call-template name="emitGetAttribute">
209	<xsl:with-param name="ifname" select="$ifname" />
210	<xsl:with-param name="attrname" select="$attrname" />
211	<xsl:with-param name="attrtype" select="$attrtype" />
212	<xsl:with-param name="attrsafearray" select="$attrsafearray" />
213	</xsl:call-template>
214	<!-- bb) emit a set method if the attribute is read/write -->
215	<xsl:if test="not($attrreadonly='yes')">
216	<xsl:call-template name="emitSetAttribute">
217	<xsl:with-param name="ifname" select="$ifname" />
218	<xsl:with-param name="attrname" select="$attrname" />
219	<xsl:with-param name="attrtype" select="$attrtype" />
220	<xsl:with-param name="attrsafearray" select="$attrsafearray" />
221	</xsl:call-template>
222	</xsl:if>
223	</xsl:otherwise>
224	</xsl:choose>
225	</xsl:for-each>
226	<xsl:text>}
227	</xsl:text>
228	</xsl:template>
229
230	<xsl:template name="collection">
231	<xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
232	<xsl:text>
233	/**
234	* Generated VBoxWebService Managed Object Collection
235	*/</xsl:text>
236	class <xsl:value-of select="$ifname"/>Collection extends VBox_ManagedObjectCollection
237	{
238	protected $_interfaceName = "<xsl:value-of select="$ifname"/>";
239	}
240	</xsl:template>
241
242	<xsl:template name="interfacestruct">
243	<xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
244	<xsl:text>
245	/**
246	* Generated VBoxWebService Struct
247	*/</xsl:text>
248	class <xsl:value-of select="$ifname"/> extends VBox_Struct
249	{
250	<xsl:for-each select="attribute"> protected $<xsl:value-of select="@name"/>;
251	</xsl:for-each>
252	public function __construct($connection, $values)
253	{
254	$this->connection = $connection;
255	<xsl:for-each select="attribute"> $this-><xsl:value-of select="@name"/> = $values-><xsl:value-of select="@name"/>;
256	</xsl:for-each> }
257
258	<xsl:for-each select="attribute"> public function <xsl:call-template name="makeGetterName"><xsl:with-param name="attrname" select="@name"/></xsl:call-template>()
259	{
260	<xsl:text>return </xsl:text>
261	<xsl:call-template name="emitOutParam">
262	<xsl:with-param name="type" select="@type" />
263	<xsl:with-param name="value" select="concat('$this->',@name)" />
264	<xsl:with-param name="safearray" select="@safearray"/>
265	</xsl:call-template>;
266	}
267	</xsl:for-each>}
268	</xsl:template>
269
270	<xsl:template name="structcollection">
271	<xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
272	<xsl:text>
273	/**
274	* Generated VBoxWebService Struct Collection
275	*/</xsl:text>
276	class <xsl:value-of select="$ifname"/>Collection extends VBox_StructCollection
277	{
278	protected $_interfaceName = "<xsl:value-of select="$ifname"/>";
279	}
280	</xsl:template>
281
282	<xsl:template name="genreq">
283	<xsl:param name="wsmap" />
284	<xsl:text> $request = new stdClass();
285	</xsl:text>
286	<xsl:if test="$wsmap='managed'"> $request->_this = $this->handle;</xsl:if>
287	<xsl:for-each select="param[@dir='in']">
288	$request-><xsl:value-of select="@name" /> = $arg_<xsl:value-of select="@name" /><xsl:text>;</xsl:text>
289	</xsl:for-each>
290	$response = $this->connection->__soapCall('<xsl:value-of select="../@name"/>_<xsl:value-of select="@name"/>', array((array)$request));
291	return <xsl:if test="param[@dir='out']">
292	<xsl:text>array(</xsl:text>
293	</xsl:if>
294	<xsl:for-each select="param[@dir='return']">
295	<xsl:call-template name="emitOutParam">
296	<xsl:with-param name="type" select="@type" />
297	<xsl:with-param name="value" select="concat('$response->','returnval')" />
298	<xsl:with-param name="safearray" select="@safearray"/>
299	</xsl:call-template>
300	<xsl:if test="../param[@dir='out']">
301	<xsl:text>, </xsl:text>
302	</xsl:if>
303	</xsl:for-each>
304	<xsl:for-each select="param[@dir='out']">
305	<xsl:if test="not(position()=1)">
306	<xsl:text>, </xsl:text>
307	</xsl:if>
308	<xsl:call-template name="emitOutParam">
309	<xsl:with-param name="type" select="@type" />
310	<xsl:with-param name="value" select="concat('$response->',@name)" />
311	<xsl:with-param name="safearray" select="@safearray"/>
312	</xsl:call-template>
313	</xsl:for-each>
314	<xsl:if test="param[@dir='out']">
315	<xsl:text>)</xsl:text>
316	</xsl:if>
317	<xsl:text>; </xsl:text>
318	</xsl:template>
319
320	<xsl:template name="method" >
321	<xsl:param name="wsmap" />
322	public function <xsl:value-of select="@name"/><xsl:text>(</xsl:text>
323	<xsl:for-each select="param[@dir='in']">
324	<xsl:if test="not(position()=1)">
325	<xsl:text>, </xsl:text>
326	</xsl:if>
327	<xsl:value-of select="concat('$arg_',@name)"/>
328	</xsl:for-each> <xsl:text>) { </xsl:text>
329	<xsl:call-template name="genreq"><xsl:with-param name="wsmap" select="$wsmap" /></xsl:call-template>
330	<xsl:text> } </xsl:text>
331	</xsl:template>
332
333	<xsl:template name="enum">
334	<xsl:text>
335	/**
336	* Generated VBoxWebService ENUM
337	*/</xsl:text>
338	class <xsl:value-of select="@name"/> extends VBox_Enum
339	{
340	public $NameMap = array(<xsl:for-each select="const"><xsl:if test="not(@wsmap='suppress')"><xsl:value-of select="@value"/> => '<xsl:value-of select="@name"/>'<xsl:if test="not(position()=last())">, </xsl:if></xsl:if></xsl:for-each>);
341	public $ValueMap = array(<xsl:for-each select="const"><xsl:if test="not(@wsmap='suppress')">'<xsl:value-of select="@name"/>' => <xsl:value-of select="@value"/><xsl:if test="not(position()=last())">, </xsl:if></xsl:if></xsl:for-each>);
342	}
343	</xsl:template>
344
345	<xsl:template name="enumcollection">
346	<xsl:variable name="ifname"><xsl:value-of select="@name" /></xsl:variable>
347	<xsl:text>
348	/**
349	* Generated VBoxWebService Enum Collection
350	*/</xsl:text>
351	class <xsl:value-of select="$ifname"/>Collection extends VBox_EnumCollection
352	{
353	protected $_interfaceName = "<xsl:value-of select="$ifname"/>";
354	}
355	</xsl:template>
356
357	<xsl:template name="comResultCodes">
358	const <xsl:value-of select="@name"/> = <xsl:value-of select="@value"/>;
359	</xsl:template>
360
361	<xsl:template match="/">
362	<xsl:text><?php
363
364	/*
365	* Copyright (C) 2008-2022 Oracle Corporation
366	*
367	* This file is part of a free software library; you can redistribute
368	* it and/or modify it under the terms of the GNU Lesser General
369	* Public License version 2.1 as published by the Free Software
370	* Foundation and shipped in the "COPYING.LIB" file with this library.
371	* The library is distributed in the hope that it will be useful,
372	* but WITHOUT ANY WARRANTY of any kind.
373	*
374	* Oracle LGPL Disclaimer: For the avoidance of doubt, except that if
375	* any license choice other than GPL or LGPL is available it will
376	* apply instead, Oracle elects to use only the Lesser General Public
377	* License version 2.1 (LGPLv2) at this time for any software where
378	* a choice of LGPL license versions is made available with the
379	* language indicating that LGPLv2 or any later version may be used,
380	* or where a choice of which version of the LGPL is applied is
381	* otherwise unspecified.
382	*
383	* This file is autogenerated from VirtualBox.xidl, DO NOT EDIT!
384	*/
385
386	class VBox_ManagedObject
387	{
388	protected $connection;
389	protected $handle;
390
391	public function __construct($soap, $handle = null)
392	{
393	$this->connection = $soap;
394	$this->handle = $handle;
395	}
396
397	public function __toString()
398	{
399	return (string)$this->handle;
400	}
401
402	public function __set($attr, $value)
403	{
404	$methodName = "set" . $attr;
405	if (method_exists($this, $methodName))
406	$this->$methodName($value);
407	else
408	throw new Exception("Attribute does not exist");
409	}
410
411	public function __get($attr)
412	{
413	$methodName = "get" . $attr;
414	if (method_exists($this, $methodName))
415	return $this->$methodName();
416	else
417	throw new Exception("Attribute does not exist");
418	}
419
420	public function getHandle()
421	{
422	return $this->handle;
423	}
424
425	public function cast($class)
426	{
427	if (is_subclass_of($class, 'VBox_ManagedObject'))
428	{
429	return new $class($this->connection, $this->handle);
430	}
431	throw new Exception('Cannot cast VBox_ManagedObject to non-child class VBox_ManagedObject');
432	}
433
434	public function releaseRemote()
435	{
436	try
437	{
438	$request = new stdClass();
439	$request->_this = $this->handle;
440	$this->connection->__soapCall('IManagedObjectRef_release', array((array)$request));
441	}
442	catch (Exception $ex)
443	{
444	}
445	}
446	}
447
448	abstract class VBox_Collection implements ArrayAccess, Iterator, Countable
449	{
450	protected $_connection;
451	protected $_values;
452	protected $_objects;
453	protected $_interfaceName;
454
455	public function __construct($soap, array $values = array())
456	{
457	$this->_connection = $soap;
458	$this->_values = $values;
459	$this->_soapToObject();
460	}
461
462	protected function _soapToObject()
463	{
464	$this->_objects = array();
465	foreach($this->_values as $value)
466	{
467	$this->_objects[] = new $this->_interfaceName($this->_connection, $value);
468	}
469	}
470
471	/ ArrayAccess Functions /
472	public function offsetSet($offset, $value)
473	{
474	if ($value instanceof $this->_interfaceName)
475	{
476	if ($offset)
477	{
478	$this->_objects[$offset] = $value;
479	}
480	else
481	{
482	$this->_objects[] = $value;
483	}
484	}
485	else
486	{
487	throw new Exception("Value must be a instance of " . $this->_interfaceName);
488	}
489	}
490
491	public function offsetExists($offset)
492	{
493	return isset($this->_objects[$offset]);
494	}
495
496	public function offsetUnset($offset)
497	{
498	unset($this->_objects[$offset]);
499	}
500
501	public function offsetGet($offset)
502	{
503	return isset($this->_objects[$offset]) ? $this->_objects[$offset] : null;
504	}
505
506	/ Iterator Functions /
507	public function rewind()
508	{
509	reset($this->_objects);
510	}
511
512	public function current()
513	{
514	return current($this->_objects);
515	}
516
517	public function key()
518	{
519	return key($this->_objects);
520	}
521
522	public function next()
523	{
524	return next($this->_objects);
525	}
526
527	public function valid()
528	{
529	return ($this->current() !== false);
530	}
531
532	/ Countable Functions /
533	public function count()
534	{
535	return count($this->_objects);
536	}
537	}
538
539	class VBox_ManagedObjectCollection extends VBox_Collection
540	{
541	protected $_interfaceName = 'VBox_ManagedObject';
542
543	// Result is undefined if this is called AFTER any call to VBox_Collection::offsetSet or VBox_Collection::offsetUnset
544	public function setInterfaceName($interface)
545	{
546	if (!is_subclass_of($interface, 'VBox_ManagedObject'))
547	{
548	throw new Exception('Cannot set collection interface to non-child class of VBox_ManagedObject');
549	}
550	$this->_interfaceName = $interface;
551	$this->_soapToObject();
552	}
553	}
554
555	abstract class VBox_Struct
556	{
557	protected $connection;
558
559	public function __get($attr)
560	{
561	$methodName = "get" . $attr;
562	if (method_exists($this, $methodName))
563	return $this->$methodName();
564	else
565	throw new Exception("Attribute does not exist");
566	}
567	}
568
569	abstract class VBox_StructCollection extends VBox_Collection
570	{
571
572	public function __construct($soap, array $values = array())
573	{
574	if (!(array_values($values) === $values))
575	{
576	$values = array((object)$values); //Fix for when struct return value only contains one list item (e.g. one medium attachment)
577	}
578	parent::__construct($soap, $values);
579	}
580	}
581
582	abstract class VBox_Enum
583	{
584	protected $_handle;
585
586	public function __construct($connection, $handle)
587	{
588	if (is_string($handle))
589	$this->_handle = $this->ValueMap[$handle];
590	else
591	$this->_handle = $handle;
592	}
593
594	public function __toString()
595	{
596	return (string)$this->NameMap[$this->_handle];
597	}
598	}
599
600	abstract class VBox_EnumCollection extends VBox_Collection
601	{
602	}
603
604	</xsl:text>
605
606	<xsl:text>
607	/**
608	* VirtualBox COM result codes
609	*/
610	class VirtualBox_COM_result_codes
611	{
612	</xsl:text>
613	<xsl:for-each select="/idl/library/result">
614	<xsl:call-template name="comResultCodes"/>
615	</xsl:for-each>
616	<xsl:text>
617	}
618	</xsl:text>
619	<xsl:for-each select="//interface[@wsmap='managed' or @wsmap='global']">
620	<xsl:call-template name="interface"/>
621	<xsl:call-template name="collection"/>
622	</xsl:for-each>
623	<xsl:for-each select="//interface[@wsmap='struct']">
624	<xsl:call-template name="interfacestruct"/>
625	<xsl:call-template name="structcollection"/>
626	</xsl:for-each>
627	<xsl:for-each select="//enum">
628	<xsl:call-template name="enum"/>
629	<xsl:call-template name="enumcollection"/>
630	</xsl:for-each>
631
632	</xsl:template>
633
634	</xsl:stylesheet>

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

source: vbox/trunk/src/VBox/Main/webservice/websrv-php.xsl@ 96399

Download in other formats: