VirtualBox

source: vbox/trunk/src/VBox/Main/cbinding/capiidl.xsl@ 64468

Last change on this file since 64468 was 62770, checked in by vboxsync, 8 years ago

Main/cbining: warnings
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 103.8 KB
Line 
1<?xml version="1.0"?>
2<!-- $Id: capiidl.xsl 62770 2016-07-31 17:10:35Z vboxsync $ -->
3
4<!--
5 * A template to generate a C header file for all relevant XPCOM interfaces
6 * provided or needed for calling the VirtualBox API. The header file also
7 * works on Windows, by using the C bindings header created by the MS COM IDL
8 * compiler (which simultaneously supports C and C++, unlike XPCOM).
9
10 Copyright (C) 2008-2016 Oracle Corporation
11
12 This file is part of VirtualBox Open Source Edition (OSE), as
13 available from http://www.virtualbox.org. This file is free software;
14 you can redistribute it and/or modify it under the terms of the GNU
15 General Public License (GPL) as published by the Free Software
16 Foundation, in version 2 as it comes in the "COPYING" file of the
17 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19-->
20
21<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
22<xsl:output method="text"/>
23
24<xsl:strip-space elements="*"/>
25
26
27<xsl:include href="../idl/typemap-shared.inc.xsl"/>
28
29<!--
30// Keys for more efficiently looking up of types.
31/////////////////////////////////////////////////////////////////////////////
32-->
33
34<xsl:key name="G_keyInterfacesByName" match="//interface[@name]" use="@name"/>
35
36
37<!--
38// templates
39/////////////////////////////////////////////////////////////////////////////
40-->
41
42
43<!--
44 * not explicitly matched elements and attributes
45-->
46<xsl:template match="*"/>
47
48
49<!--
50 * header
51-->
52<xsl:template match="/idl">
53 <xsl:text>/*
54 * DO NOT EDIT! This is a generated file.
55 *
56 * Header file which provides C declarations for VirtualBox Main API
57 * (COM interfaces), generated from XIDL (XML interface definition).
58 * On Windows (which uses COM instead of XPCOM) the native C support
59 * is used, and most of this file is not used.
60 *
61 * Source : src/VBox/Main/idl/VirtualBox.xidl
62 * Generator : src/VBox/Main/cbinding/capiidl.xsl
63 *
64 * This file contains portions from the following Mozilla XPCOM files:
65 * xpcom/include/xpcom/nsID.h
66 * xpcom/include/nsIException.h
67 * xpcom/include/nsprpub/prtypes.h
68 * xpcom/include/xpcom/nsISupportsBase.h
69 *
70 * These files were originally triple-licensed (MPL/GPL2/LGPL2.1). Oracle
71 * elects to distribute this derived work under the LGPL2.1 only.
72 */
73
74/*
75 * Copyright (C) 2008-2016 Oracle Corporation
76 *
77 * This file is part of a free software library; you can redistribute
78 * it and/or modify it under the terms of the GNU Lesser General
79 * Public License version 2.1 as published by the Free Software
80 * Foundation and shipped in the "COPYING" file with this library.
81 * The library is distributed in the hope that it will be useful,
82 * but WITHOUT ANY WARRANTY of any kind.
83 *
84 * Oracle LGPL Disclaimer: For the avoidance of doubt, except that if
85 * any license choice other than GPL or LGPL is available it will
86 * apply instead, Oracle elects to use only the Lesser General Public
87 * License version 2.1 (LGPLv2) at this time for any software where
88 * a choice of LGPL license versions is made available with the
89 * language indicating that LGPLv2 or any later version may be used,
90 * or where a choice of which version of the LGPL is applied is
91 * otherwise unspecified.
92 */
93
94#ifndef ___VirtualBox_CAPI_h
95#define ___VirtualBox_CAPI_h
96
97#ifdef _WIN32
98# pragma warning(push)
99# pragma warning(disable:4668 4255) /* -Wall and windows.h */
100# undef COBJMACROS
101# define COBJMACROS
102# include "Windows.h"
103# pragma warning(pop)
104#endif /* _WIN32 */
105
106#ifdef WIN32
107# ifdef IN_VBOXCAPI
108# define VBOXCAPI_DECL(type) extern __declspec(dllexport) type
109# else /* !IN_VBOXCAPI */
110# define VBOXCAPI_DECL(type) __declspec(dllimport) type
111# endif /* !IN_VBOXCAPI */
112#endif /* WIN32 */
113
114#ifdef __cplusplus
115/* The C++ treatment in this file is not meant for SDK users, it only exists
116 * so that this file can be used to produce the VBoxCAPI shared library which
117 * has to use C++ as it does all the conversion magic. */
118# ifdef IN_VBOXCAPI
119# include "VBox/com/VirtualBox.h"
120# ifndef WIN32
121# include "nsIEventQueue.h"
122# endif /* !WIN32 */
123# else /* !IN_VBOXCAPI */
124# error Do not include this header file from C++ code
125# endif /* !IN_VBOXCAPI */
126#endif /* __cplusplus */
127
128#ifdef __GNUC__
129# define VBOX_EXTERN_CONST(type, name) extern const type name __attribute__((nocommon))
130#else /* !__GNUC__ */
131# define VBOX_EXTERN_CONST(type, name) extern const type name
132#endif /* !__GNUC__ */
133
134/* Treat WIN32 completely separately, as on Windows VirtualBox uses COM, not
135 * XPCOM like on all other platforms. While the code below would also compile
136 * on Windows, we need to switch to the native C support provided by the header
137 * files produced by the COM IDL compiler. */
138#ifdef WIN32
139# include "ObjBase.h"
140# include "oaidl.h"
141# include "VirtualBox.h"
142
143#ifndef __cplusplus
144/* Skip this in the C++ case as there's already a definition for CBSTR. */
145typedef const BSTR CBSTR;
146#endif /* !__cplusplus */
147
148#define VBOX_WINAPI WINAPI
149
150#define ComSafeArrayAsInParam(f) (f)
151#define ComSafeArrayAsOutParam(f) (&amp;(f))
152#define ComSafeArrayAsOutTypeParam(f,t) (&amp;(f))
153#define ComSafeArrayAsOutIfaceParam(f,t) (&amp;(f))
154
155#else /* !WIN32 */
156
157#include &lt;stddef.h&gt;
158#include "wchar.h"
159
160#ifdef IN_VBOXCAPI
161# define VBOXCAPI_DECL(type) PR_EXPORT(type)
162#else /* !IN_VBOXCAPI */
163# define VBOXCAPI_DECL(type) PR_IMPORT(type)
164#endif /* !IN_VBOXCAPI */
165
166#ifndef __cplusplus
167
168#if defined(WIN32)
169
170#define PR_EXPORT(__type) extern __declspec(dllexport) __type
171#define PR_EXPORT_DATA(__type) extern __declspec(dllexport) __type
172#define PR_IMPORT(__type) __declspec(dllimport) __type
173#define PR_IMPORT_DATA(__type) __declspec(dllimport) __type
174
175#define PR_EXTERN(__type) extern __declspec(dllexport) __type
176#define PR_IMPLEMENT(__type) __declspec(dllexport) __type
177#define PR_EXTERN_DATA(__type) extern __declspec(dllexport) __type
178#define PR_IMPLEMENT_DATA(__type) __declspec(dllexport) __type
179
180#define PR_CALLBACK
181#define PR_CALLBACK_DECL
182#define PR_STATIC_CALLBACK(__x) static __x
183
184#elif defined(XP_BEOS)
185
186#define PR_EXPORT(__type) extern __declspec(dllexport) __type
187#define PR_EXPORT_DATA(__type) extern __declspec(dllexport) __type
188#define PR_IMPORT(__type) extern __declspec(dllexport) __type
189#define PR_IMPORT_DATA(__type) extern __declspec(dllexport) __type
190
191#define PR_EXTERN(__type) extern __declspec(dllexport) __type
192#define PR_IMPLEMENT(__type) __declspec(dllexport) __type
193#define PR_EXTERN_DATA(__type) extern __declspec(dllexport) __type
194#define PR_IMPLEMENT_DATA(__type) __declspec(dllexport) __type
195
196#define PR_CALLBACK
197#define PR_CALLBACK_DECL
198#define PR_STATIC_CALLBACK(__x) static __x
199
200#elif defined(WIN16)
201
202#define PR_CALLBACK_DECL __cdecl
203
204#if defined(_WINDLL)
205#define PR_EXPORT(__type) extern __type _cdecl _export _loadds
206#define PR_IMPORT(__type) extern __type _cdecl _export _loadds
207#define PR_EXPORT_DATA(__type) extern __type _export
208#define PR_IMPORT_DATA(__type) extern __type _export
209
210#define PR_EXTERN(__type) extern __type _cdecl _export _loadds
211#define PR_IMPLEMENT(__type) __type _cdecl _export _loadds
212#define PR_EXTERN_DATA(__type) extern __type _export
213#define PR_IMPLEMENT_DATA(__type) __type _export
214
215#define PR_CALLBACK __cdecl __loadds
216#define PR_STATIC_CALLBACK(__x) static __x PR_CALLBACK
217
218#else /* this must be .EXE */
219#define PR_EXPORT(__type) extern __type _cdecl _export
220#define PR_IMPORT(__type) extern __type _cdecl _export
221#define PR_EXPORT_DATA(__type) extern __type _export
222#define PR_IMPORT_DATA(__type) extern __type _export
223
224#define PR_EXTERN(__type) extern __type _cdecl _export
225#define PR_IMPLEMENT(__type) __type _cdecl _export
226#define PR_EXTERN_DATA(__type) extern __type _export
227#define PR_IMPLEMENT_DATA(__type) __type _export
228
229#define PR_CALLBACK __cdecl __loadds
230#define PR_STATIC_CALLBACK(__x) __x PR_CALLBACK
231#endif /* _WINDLL */
232
233#elif defined(XP_MAC)
234
235#define PR_EXPORT(__type) extern __declspec(export) __type
236#define PR_EXPORT_DATA(__type) extern __declspec(export) __type
237#define PR_IMPORT(__type) extern __declspec(export) __type
238#define PR_IMPORT_DATA(__type) extern __declspec(export) __type
239
240#define PR_EXTERN(__type) extern __declspec(export) __type
241#define PR_IMPLEMENT(__type) __declspec(export) __type
242#define PR_EXTERN_DATA(__type) extern __declspec(export) __type
243#define PR_IMPLEMENT_DATA(__type) __declspec(export) __type
244
245#define PR_CALLBACK
246#define PR_CALLBACK_DECL
247#define PR_STATIC_CALLBACK(__x) static __x
248
249#elif defined(XP_OS2) &amp;&amp; defined(__declspec)
250
251#define PR_EXPORT(__type) extern __declspec(dllexport) __type
252#define PR_EXPORT_DATA(__type) extern __declspec(dllexport) __type
253#define PR_IMPORT(__type) __declspec(dllimport) __type
254#define PR_IMPORT_DATA(__type) __declspec(dllimport) __type
255
256#define PR_EXTERN(__type) extern __declspec(dllexport) __type
257#define PR_IMPLEMENT(__type) __declspec(dllexport) __type
258#define PR_EXTERN_DATA(__type) extern __declspec(dllexport) __type
259#define PR_IMPLEMENT_DATA(__type) __declspec(dllexport) __type
260
261#define PR_CALLBACK
262#define PR_CALLBACK_DECL
263#define PR_STATIC_CALLBACK(__x) static __x
264
265#elif defined(XP_OS2_VACPP)
266
267#define PR_EXPORT(__type) extern __type
268#define PR_EXPORT_DATA(__type) extern __type
269#define PR_IMPORT(__type) extern __type
270#define PR_IMPORT_DATA(__type) extern __type
271
272#define PR_EXTERN(__type) extern __type
273#define PR_IMPLEMENT(__type) __type
274#define PR_EXTERN_DATA(__type) extern __type
275#define PR_IMPLEMENT_DATA(__type) __type
276#define PR_CALLBACK _Optlink
277#define PR_CALLBACK_DECL
278#define PR_STATIC_CALLBACK(__x) static __x PR_CALLBACK
279
280#else /* Unix */
281
282# ifdef VBOX_HAVE_VISIBILITY_HIDDEN
283# define PR_EXPORT(__type) __attribute__((visibility("default"))) extern __type
284# define PR_EXPORT_DATA(__type) __attribute__((visibility("default"))) extern __type
285# define PR_IMPORT(__type) extern __type
286# define PR_IMPORT_DATA(__type) extern __type
287# define PR_EXTERN(__type) __attribute__((visibility("default"))) extern __type
288# define PR_IMPLEMENT(__type) __attribute__((visibility("default"))) __type
289# define PR_EXTERN_DATA(__type) __attribute__((visibility("default"))) extern __type
290# define PR_IMPLEMENT_DATA(__type) __attribute__((visibility("default"))) __type
291# define PR_CALLBACK
292# define PR_CALLBACK_DECL
293# define PR_STATIC_CALLBACK(__x) static __x
294# else
295# define PR_EXPORT(__type) extern __type
296# define PR_EXPORT_DATA(__type) extern __type
297# define PR_IMPORT(__type) extern __type
298# define PR_IMPORT_DATA(__type) extern __type
299# define PR_EXTERN(__type) extern __type
300# define PR_IMPLEMENT(__type) __type
301# define PR_EXTERN_DATA(__type) extern __type
302# define PR_IMPLEMENT_DATA(__type) __type
303# define PR_CALLBACK
304# define PR_CALLBACK_DECL
305# define PR_STATIC_CALLBACK(__x) static __x
306# endif
307#endif
308
309#if defined(_NSPR_BUILD_)
310#define NSPR_API(__type) PR_EXPORT(__type)
311#define NSPR_DATA_API(__type) PR_EXPORT_DATA(__type)
312#else
313#define NSPR_API(__type) PR_IMPORT(__type)
314#define NSPR_DATA_API(__type) PR_IMPORT_DATA(__type)
315#endif
316
317typedef unsigned char PRUint8;
318#if (defined(HPUX) &amp;&amp; defined(__cplusplus) \
319 &amp;&amp; !defined(__GNUC__) &amp;&amp; __cplusplus &lt; 199707L) \
320 || (defined(SCO) &amp;&amp; defined(__cplusplus) \
321 &amp;&amp; !defined(__GNUC__) &amp;&amp; __cplusplus == 1L)
322typedef char PRInt8;
323#else
324typedef signed char PRInt8;
325#endif
326
327#define PR_INT8_MAX 127
328#define PR_INT8_MIN (-128)
329#define PR_UINT8_MAX 255U
330
331typedef unsigned short PRUint16;
332typedef short PRInt16;
333
334#define PR_INT16_MAX 32767
335#define PR_INT16_MIN (-32768)
336#define PR_UINT16_MAX 65535U
337
338typedef unsigned int PRUint32;
339typedef int PRInt32;
340#define PR_INT32(x) x
341#define PR_UINT32(x) x ## U
342
343#define PR_INT32_MAX PR_INT32(2147483647)
344#define PR_INT32_MIN (-PR_INT32_MAX - 1)
345#define PR_UINT32_MAX PR_UINT32(4294967295)
346
347typedef long PRInt64;
348typedef unsigned long PRUint64;
349typedef int PRIntn;
350typedef unsigned int PRUintn;
351
352typedef double PRFloat64;
353typedef size_t PRSize;
354
355typedef ptrdiff_t PRPtrdiff;
356
357typedef unsigned long PRUptrdiff;
358
359typedef PRIntn PRBool;
360
361#define PR_TRUE 1
362#define PR_FALSE 0
363
364typedef PRUint8 PRPackedBool;
365
366/*
367** Status code used by some routines that have a single point of failure or
368** special status return.
369*/
370typedef enum { PR_FAILURE = -1, PR_SUCCESS = 0 } PRStatus;
371
372#ifndef __PRUNICHAR__
373#define __PRUNICHAR__
374#if defined(WIN32) || defined(XP_MAC)
375typedef wchar_t PRUnichar;
376#else
377typedef PRUint16 PRUnichar;
378#endif
379typedef PRUnichar *BSTR;
380typedef const PRUnichar *CBSTR;
381#endif
382
383typedef long PRWord;
384typedef unsigned long PRUword;
385
386#define nsnull 0
387typedef PRUint32 nsresult;
388
389#if defined(__GNUC__) &amp;&amp; (__GNUC__ > 2)
390#define NS_LIKELY(x) (__builtin_expect((x), 1))
391#define NS_UNLIKELY(x) (__builtin_expect((x), 0))
392#else
393#define NS_LIKELY(x) (x)
394#define NS_UNLIKELY(x) (x)
395#endif
396
397#define NS_FAILED(_nsresult) (NS_UNLIKELY((_nsresult) &amp; 0x80000000))
398#define NS_SUCCEEDED(_nsresult) (NS_LIKELY(!((_nsresult) &amp; 0x80000000)))
399
400#ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
401# define PR_IntervalNow VBoxNsprPR_IntervalNow
402# define PR_TicksPerSecond VBoxNsprPR_TicksPerSecond
403# define PR_SecondsToInterval VBoxNsprPR_SecondsToInterval
404# define PR_MillisecondsToInterval VBoxNsprPR_MillisecondsToInterval
405# define PR_MicrosecondsToInterval VBoxNsprPR_MicrosecondsToInterval
406# define PR_IntervalToSeconds VBoxNsprPR_IntervalToSeconds
407# define PR_IntervalToMilliseconds VBoxNsprPR_IntervalToMilliseconds
408# define PR_IntervalToMicroseconds VBoxNsprPR_IntervalToMicroseconds
409# define PR_EnterMonitor VBoxNsprPR_EnterMonitor
410# define PR_ExitMonitor VBoxNsprPR_ExitMonitor
411# define PR_Notify VBoxNsprPR_Notify
412# define PR_NotifyAll VBoxNsprPR_NotifyAll
413# define PR_Wait VBoxNsprPR_Wait
414# define PR_NewMonitor VBoxNsprPR_NewMonitor
415# define PR_DestroyMonitor VBoxNsprPR_DestroyMonitor
416#endif /* VBOX_WITH_XPCOM_NAMESPACE_CLEANUP */
417
418typedef PRUint32 PRIntervalTime;
419
420#define PR_INTERVAL_MIN 1000UL
421#define PR_INTERVAL_MAX 100000UL
422#define PR_INTERVAL_NO_WAIT 0UL
423#define PR_INTERVAL_NO_TIMEOUT 0xffffffffUL
424
425NSPR_API(PRIntervalTime) PR_IntervalNow(void);
426NSPR_API(PRUint32) PR_TicksPerSecond(void);
427NSPR_API(PRIntervalTime) PR_SecondsToInterval(PRUint32 seconds);
428NSPR_API(PRIntervalTime) PR_MillisecondsToInterval(PRUint32 milli);
429NSPR_API(PRIntervalTime) PR_MicrosecondsToInterval(PRUint32 micro);
430NSPR_API(PRUint32) PR_IntervalToSeconds(PRIntervalTime ticks);
431NSPR_API(PRUint32) PR_IntervalToMilliseconds(PRIntervalTime ticks);
432NSPR_API(PRUint32) PR_IntervalToMicroseconds(PRIntervalTime ticks);
433
434typedef struct PRMonitor PRMonitor;
435
436NSPR_API(PRMonitor*) PR_NewMonitor(void);
437NSPR_API(void) PR_DestroyMonitor(PRMonitor *mon);
438NSPR_API(void) PR_EnterMonitor(PRMonitor *mon);
439NSPR_API(PRStatus) PR_ExitMonitor(PRMonitor *mon);
440NSPR_API(PRStatus) PR_Wait(PRMonitor *mon, PRIntervalTime ticks);
441NSPR_API(PRStatus) PR_Notify(PRMonitor *mon);
442NSPR_API(PRStatus) PR_NotifyAll(PRMonitor *mon);
443
444#ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
445# define PR_CreateThread VBoxNsprPR_CreateThread
446# define PR_JoinThread VBoxNsprPR_JoinThread
447# define PR_Sleep VBoxNsprPR_Sleep
448# define PR_GetCurrentThread VBoxNsprPR_GetCurrentThread
449# define PR_GetThreadState VBoxNsprPR_GetThreadState
450# define PR_SetThreadPrivate VBoxNsprPR_SetThreadPrivate
451# define PR_GetThreadPrivate VBoxNsprPR_GetThreadPrivate
452# define PR_NewThreadPrivateIndex VBoxNsprPR_NewThreadPrivateIndex
453# define PR_GetThreadPriority VBoxNsprPR_GetThreadPriority
454# define PR_SetThreadPriority VBoxNsprPR_SetThreadPriority
455# define PR_Interrupt VBoxNsprPR_Interrupt
456# define PR_ClearInterrupt VBoxNsprPR_ClearInterrupt
457# define PR_BlockInterrupt VBoxNsprPR_BlockInterrupt
458# define PR_UnblockInterrupt VBoxNsprPR_UnblockInterrupt
459# define PR_GetThreadScope VBoxNsprPR_GetThreadScope
460# define PR_GetThreadType VBoxNsprPR_GetThreadType
461#endif /* VBOX_WITH_XPCOM_NAMESPACE_CLEANUP */
462
463typedef struct PRThread PRThread;
464typedef struct PRThreadStack PRThreadStack;
465
466typedef enum PRThreadType {
467 PR_USER_THREAD,
468 PR_SYSTEM_THREAD
469} PRThreadType;
470
471typedef enum PRThreadScope {
472 PR_LOCAL_THREAD,
473 PR_GLOBAL_THREAD,
474 PR_GLOBAL_BOUND_THREAD
475} PRThreadScope;
476
477typedef enum PRThreadState {
478 PR_JOINABLE_THREAD,
479 PR_UNJOINABLE_THREAD
480} PRThreadState;
481
482typedef enum PRThreadPriority
483{
484 PR_PRIORITY_FIRST = 0, /* just a placeholder */
485 PR_PRIORITY_LOW = 0, /* the lowest possible priority */
486 PR_PRIORITY_NORMAL = 1, /* most common expected priority */
487 PR_PRIORITY_HIGH = 2, /* slightly more aggressive scheduling */
488 PR_PRIORITY_URGENT = 3, /* it does little good to have more than one */
489 PR_PRIORITY_LAST = 3 /* this is just a placeholder */
490} PRThreadPriority;
491
492NSPR_API(PRThread*) PR_CreateThread(PRThreadType type,
493 void (PR_CALLBACK *start)(void *arg),
494 void *arg,
495 PRThreadPriority priority,
496 PRThreadScope scope,
497 PRThreadState state,
498 PRUint32 stackSize);
499NSPR_API(PRStatus) PR_JoinThread(PRThread *thread);
500NSPR_API(PRThread*) PR_GetCurrentThread(void);
501#ifndef NO_NSPR_10_SUPPORT
502#define PR_CurrentThread() PR_GetCurrentThread() /* for nspr1.0 compat. */
503#endif /* NO_NSPR_10_SUPPORT */
504NSPR_API(PRThreadPriority) PR_GetThreadPriority(const PRThread *thread);
505NSPR_API(void) PR_SetThreadPriority(PRThread *thread, PRThreadPriority priority);
506
507typedef void (PR_CALLBACK *PRThreadPrivateDTOR)(void *priv);
508
509NSPR_API(PRStatus) PR_NewThreadPrivateIndex(
510 PRUintn *newIndex, PRThreadPrivateDTOR destructor);
511NSPR_API(PRStatus) PR_SetThreadPrivate(PRUintn tpdIndex, void *priv);
512NSPR_API(void*) PR_GetThreadPrivate(PRUintn tpdIndex);
513NSPR_API(PRStatus) PR_Interrupt(PRThread *thread);
514NSPR_API(void) PR_ClearInterrupt(void);
515NSPR_API(void) PR_BlockInterrupt(void);
516NSPR_API(void) PR_UnblockInterrupt(void);
517NSPR_API(PRStatus) PR_Sleep(PRIntervalTime ticks);
518NSPR_API(PRThreadScope) PR_GetThreadScope(const PRThread *thread);
519NSPR_API(PRThreadType) PR_GetThreadType(const PRThread *thread);
520NSPR_API(PRThreadState) PR_GetThreadState(const PRThread *thread);
521
522#ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
523# define PR_DestroyLock VBoxNsprPR_DestroyLock
524# define PR_Lock VBoxNsprPR_Lock
525# define PR_NewLock VBoxNsprPR_NewLock
526# define PR_Unlock VBoxNsprPR_Unlock
527#endif /* VBOX_WITH_XPCOM_NAMESPACE_CLEANUP */
528
529typedef struct PRLock PRLock;
530
531NSPR_API(PRLock*) PR_NewLock(void);
532NSPR_API(void) PR_DestroyLock(PRLock *lock);
533NSPR_API(void) PR_Lock(PRLock *lock);
534NSPR_API(PRStatus) PR_Unlock(PRLock *lock);
535
536#ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
537# define PR_NewCondVar VBoxNsprPR_NewCondVar
538# define PR_DestroyCondVar VBoxNsprPR_DestroyCondVar
539# define PR_WaitCondVar VBoxNsprPR_WaitCondVar
540# define PR_NotifyCondVar VBoxNsprPR_NotifyCondVar
541# define PR_NotifyAllCondVar VBoxNsprPR_NotifyAllCondVar
542#endif /* VBOX_WITH_XPCOM_NAMESPACE_CLEANUP */
543
544typedef struct PRCondVar PRCondVar;
545
546NSPR_API(PRCondVar*) PR_NewCondVar(PRLock *lock);
547NSPR_API(void) PR_DestroyCondVar(PRCondVar *cvar);
548NSPR_API(PRStatus) PR_WaitCondVar(PRCondVar *cvar, PRIntervalTime timeout);
549NSPR_API(PRStatus) PR_NotifyCondVar(PRCondVar *cvar);
550NSPR_API(PRStatus) PR_NotifyAllCondVar(PRCondVar *cvar);
551
552typedef struct PRCListStr PRCList;
553
554struct PRCListStr {
555 PRCList *next;
556 PRCList *prev;
557};
558
559#ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
560# define PL_DestroyEvent VBoxNsplPL_DestroyEvent
561# define PL_HandleEvent VBoxNsplPL_HandleEvent
562# define PL_InitEvent VBoxNsplPL_InitEvent
563# define PL_CreateEventQueue VBoxNsplPL_CreateEventQueue
564# define PL_CreateMonitoredEventQueue VBoxNsplPL_CreateMonitoredEventQueue
565# define PL_CreateNativeEventQueue VBoxNsplPL_CreateNativeEventQueue
566# define PL_DequeueEvent VBoxNsplPL_DequeueEvent
567# define PL_DestroyEventQueue VBoxNsplPL_DestroyEventQueue
568# define PL_EventAvailable VBoxNsplPL_EventAvailable
569# define PL_EventLoop VBoxNsplPL_EventLoop
570# define PL_GetEvent VBoxNsplPL_GetEvent
571# define PL_GetEventOwner VBoxNsplPL_GetEventOwner
572# define PL_GetEventQueueMonitor VBoxNsplPL_GetEventQueueMonitor
573# define PL_GetEventQueueSelectFD VBoxNsplPL_GetEventQueueSelectFD
574# define PL_MapEvents VBoxNsplPL_MapEvents
575# define PL_PostEvent VBoxNsplPL_PostEvent
576# define PL_PostSynchronousEvent VBoxNsplPL_PostSynchronousEvent
577# define PL_ProcessEventsBeforeID VBoxNsplPL_ProcessEventsBeforeID
578# define PL_ProcessPendingEvents VBoxNsplPL_ProcessPendingEvents
579# define PL_RegisterEventIDFunc VBoxNsplPL_RegisterEventIDFunc
580# define PL_RevokeEvents VBoxNsplPL_RevokeEvents
581# define PL_UnregisterEventIDFunc VBoxNsplPL_UnregisterEventIDFunc
582# define PL_WaitForEvent VBoxNsplPL_WaitForEvent
583# define PL_IsQueueNative VBoxNsplPL_IsQueueNative
584# define PL_IsQueueOnCurrentThread VBoxNsplPL_IsQueueOnCurrentThread
585# define PL_FavorPerformanceHint VBoxNsplPL_FavorPerformanceHint
586#endif /* VBOX_WITH_XPCOM_NAMESPACE_CLEANUP */
587
588typedef struct PLEvent PLEvent;
589typedef struct PLEventQueue PLEventQueue;
590
591PR_EXTERN(PLEventQueue*)
592PL_CreateEventQueue(const char* name, PRThread* handlerThread);
593PR_EXTERN(PLEventQueue *)
594 PL_CreateNativeEventQueue(
595 const char *name,
596 PRThread *handlerThread
597 );
598PR_EXTERN(PLEventQueue *)
599 PL_CreateMonitoredEventQueue(
600 const char *name,
601 PRThread *handlerThread
602 );
603PR_EXTERN(void)
604PL_DestroyEventQueue(PLEventQueue* self);
605PR_EXTERN(PRMonitor*)
606PL_GetEventQueueMonitor(PLEventQueue* self);
607
608#define PL_ENTER_EVENT_QUEUE_MONITOR(queue) \
609 PR_EnterMonitor(PL_GetEventQueueMonitor(queue))
610
611#define PL_EXIT_EVENT_QUEUE_MONITOR(queue) \
612 PR_ExitMonitor(PL_GetEventQueueMonitor(queue))
613
614PR_EXTERN(PRStatus) PL_PostEvent(PLEventQueue* self, PLEvent* event);
615PR_EXTERN(void*) PL_PostSynchronousEvent(PLEventQueue* self, PLEvent* event);
616PR_EXTERN(PLEvent*) PL_GetEvent(PLEventQueue* self);
617PR_EXTERN(PRBool) PL_EventAvailable(PLEventQueue* self);
618
619typedef void (PR_CALLBACK *PLEventFunProc)(PLEvent* event, void* data, PLEventQueue* queue);
620
621PR_EXTERN(void) PL_MapEvents(PLEventQueue* self, PLEventFunProc fun, void* data);
622PR_EXTERN(void) PL_RevokeEvents(PLEventQueue* self, void* owner);
623PR_EXTERN(void) PL_ProcessPendingEvents(PLEventQueue* self);
624PR_EXTERN(PLEvent*) PL_WaitForEvent(PLEventQueue* self);
625PR_EXTERN(void) PL_EventLoop(PLEventQueue* self);
626PR_EXTERN(PRInt32) PL_GetEventQueueSelectFD(PLEventQueue* self);
627PR_EXTERN(PRBool) PL_IsQueueOnCurrentThread( PLEventQueue *queue );
628PR_EXTERN(PRBool) PL_IsQueueNative(PLEventQueue *queue);
629
630typedef void* (PR_CALLBACK *PLHandleEventProc)(PLEvent* self);
631typedef void (PR_CALLBACK *PLDestroyEventProc)(PLEvent* self);
632PR_EXTERN(void)
633PL_InitEvent(PLEvent* self, void* owner,
634 PLHandleEventProc handler,
635 PLDestroyEventProc destructor);
636PR_EXTERN(void*) PL_GetEventOwner(PLEvent* self);
637PR_EXTERN(void) PL_HandleEvent(PLEvent* self);
638PR_EXTERN(void) PL_DestroyEvent(PLEvent* self);
639PR_EXTERN(void) PL_DequeueEvent(PLEvent* self, PLEventQueue* queue);
640PR_EXTERN(void) PL_FavorPerformanceHint(PRBool favorPerformanceOverEventStarvation, PRUint32 starvationDelay);
641
642struct PLEvent {
643 PRCList link;
644 PLHandleEventProc handler;
645 PLDestroyEventProc destructor;
646 void* owner;
647 void* synchronousResult;
648 PRLock* lock;
649 PRCondVar* condVar;
650 PRBool handled;
651#ifdef PL_POST_TIMINGS
652 PRIntervalTime postTime;
653#endif
654#ifdef XP_UNIX
655 unsigned long id;
656#endif /* XP_UNIX */
657 /* other fields follow... */
658};
659
660#if defined(XP_WIN) || defined(XP_OS2)
661
662PR_EXTERN(HWND)
663 PL_GetNativeEventReceiverWindow(
664 PLEventQueue *eqp
665 );
666#endif /* XP_WIN || XP_OS2 */
667
668#ifdef XP_UNIX
669
670PR_EXTERN(PRInt32)
671PL_ProcessEventsBeforeID(PLEventQueue *aSelf, unsigned long aID);
672
673typedef unsigned long (PR_CALLBACK *PLGetEventIDFunc)(void *aClosure);
674
675PR_EXTERN(void)
676PL_RegisterEventIDFunc(PLEventQueue *aSelf, PLGetEventIDFunc aFunc,
677 void *aClosure);
678PR_EXTERN(void) PL_UnregisterEventIDFunc(PLEventQueue *aSelf);
679
680#endif /* XP_UNIX */
681
682/* Standard "it worked" return value */
683#define NS_OK 0
684
685#define NS_ERROR_BASE ((nsresult) 0xC1F30000)
686
687/* Returned when an instance is not initialized */
688#define NS_ERROR_NOT_INITIALIZED (NS_ERROR_BASE + 1)
689
690/* Returned when an instance is already initialized */
691#define NS_ERROR_ALREADY_INITIALIZED (NS_ERROR_BASE + 2)
692
693/* Returned by a not implemented function */
694#define NS_ERROR_NOT_IMPLEMENTED ((nsresult) 0x80004001L)
695
696/* Returned when a given interface is not supported. */
697#define NS_NOINTERFACE ((nsresult) 0x80004002L)
698#define NS_ERROR_NO_INTERFACE NS_NOINTERFACE
699
700#define NS_ERROR_INVALID_POINTER ((nsresult) 0x80004003L)
701#define NS_ERROR_NULL_POINTER NS_ERROR_INVALID_POINTER
702
703/* Returned when a function aborts */
704#define NS_ERROR_ABORT ((nsresult) 0x80004004L)
705
706/* Returned when a function fails */
707#define NS_ERROR_FAILURE ((nsresult) 0x80004005L)
708
709/* Returned when an unexpected error occurs */
710#define NS_ERROR_UNEXPECTED ((nsresult) 0x8000ffffL)
711
712/* Returned when a memory allocation fails */
713#define NS_ERROR_OUT_OF_MEMORY ((nsresult) 0x8007000eL)
714
715/* Returned when an illegal value is passed */
716#define NS_ERROR_ILLEGAL_VALUE ((nsresult) 0x80070057L)
717#define NS_ERROR_INVALID_ARG NS_ERROR_ILLEGAL_VALUE
718
719/* Returned when a class doesn't allow aggregation */
720#define NS_ERROR_NO_AGGREGATION ((nsresult) 0x80040110L)
721
722/* Returned when an operation can't complete due to an unavailable resource */
723#define NS_ERROR_NOT_AVAILABLE ((nsresult) 0x80040111L)
724
725/* Returned when a class is not registered */
726#define NS_ERROR_FACTORY_NOT_REGISTERED ((nsresult) 0x80040154L)
727
728/* Returned when a class cannot be registered, but may be tried again later */
729#define NS_ERROR_FACTORY_REGISTER_AGAIN ((nsresult) 0x80040155L)
730
731/* Returned when a dynamically loaded factory couldn't be found */
732#define NS_ERROR_FACTORY_NOT_LOADED ((nsresult) 0x800401f8L)
733
734/* Returned when a factory doesn't support signatures */
735#define NS_ERROR_FACTORY_NO_SIGNATURE_SUPPORT \
736 (NS_ERROR_BASE + 0x101)
737
738/* Returned when a factory already is registered */
739#define NS_ERROR_FACTORY_EXISTS (NS_ERROR_BASE + 0x100)
740
741/**
742 * An "interface id" which can be used to uniquely identify a given
743 * interface.
744 * A "unique identifier". This is modeled after OSF DCE UUIDs.
745 */
746
747struct nsID {
748 PRUint32 m0;
749 PRUint16 m1;
750 PRUint16 m2;
751 PRUint8 m3[8];
752};
753
754typedef struct nsID nsID;
755typedef nsID nsIID;
756typedef nsID nsCID;
757
758#endif /* __cplusplus */
759
760#define VBOX_WINAPI
761
762/* Various COM types defined by their XPCOM equivalent */
763typedef PRInt64 LONG64;
764typedef PRInt32 LONG;
765typedef PRInt32 DWORD;
766typedef PRInt16 SHORT;
767typedef PRUint64 ULONG64;
768typedef PRUint32 ULONG;
769typedef PRUint16 USHORT;
770
771typedef PRBool BOOL;
772
773#ifndef FALSE
774#define FALSE 0
775#define TRUE 1
776#endif
777
778#define HRESULT nsresult
779#define SUCCEEDED NS_SUCCEEDED
780#define FAILED NS_FAILED
781
782/* OLE error codes */
783#define S_OK ((nsresult)NS_OK)
784#define E_UNEXPECTED NS_ERROR_UNEXPECTED
785#define E_NOTIMPL NS_ERROR_NOT_IMPLEMENTED
786#define E_OUTOFMEMORY NS_ERROR_OUT_OF_MEMORY
787#define E_INVALIDARG NS_ERROR_INVALID_ARG
788#define E_NOINTERFACE NS_ERROR_NO_INTERFACE
789#define E_POINTER NS_ERROR_NULL_POINTER
790#define E_ABORT NS_ERROR_ABORT
791#define E_FAIL NS_ERROR_FAILURE
792/* Note: a better analog for E_ACCESSDENIED would probably be
793 * NS_ERROR_NOT_AVAILABLE, but we want binary compatibility for now. */
794#define E_ACCESSDENIED ((nsresult)0x80070005L)
795
796/* Basic vartype for COM compatibility. */
797typedef enum VARTYPE
798{
799 VT_I2 = 2,
800 VT_I4 = 3,
801 VT_BSTR = 8,
802 VT_DISPATCH = 9,
803 VT_BOOL = 11,
804 VT_UNKNOWN = 13,
805 VT_I1 = 16,
806 VT_UI1 = 17,
807 VT_UI2 = 18,
808 VT_UI4 = 19,
809 VT_I8 = 20,
810 VT_UI8 = 21,
811 VT_HRESULT = 25
812} VARTYPE;
813
814/* Basic safearray type for COM compatibility. */
815typedef struct SAFEARRAY
816{
817 void *pv;
818 ULONG c;
819} SAFEARRAY;
820
821#define ComSafeArrayAsInParam(f) ((f) ? (f)->c : 0), ((f) ? (f)->pv : NULL)
822#define ComSafeArrayAsOutParam(f) (&amp;((f)->c)), (&amp;((f)->pv))
823#define ComSafeArrayAsOutTypeParam(f,t) (&amp;((f)->c)), (t**)(&amp;((f)->pv))
824#define ComSafeArrayAsOutIfaceParam(f,t) (&amp;((f)->c)), (t**)(&amp;((f)->pv))
825
826/* Glossing over differences between COM and XPCOM */
827#define IErrorInfo nsIException
828#define IUnknown nsISupports
829#define IDispatch nsISupports
830
831/* Make things as COM compatible as possible */
832#define interface struct
833#ifdef CONST_VTABLE
834# define CONST_VTBL const
835#else /* !CONST_VTABLE */
836# define CONST_VTBL
837#endif /* !CONST_VTABLE */
838
839#ifndef __cplusplus
840
841/** @todo this first batch of forward declarations (and the corresponding ones
842 * generated for each interface) are 100% redundant, remove eventually. */
843interface nsISupports; /* forward declaration */
844interface nsIException; /* forward declaration */
845interface nsIStackFrame; /* forward declaration */
846interface nsIEventTarget;/* forward declaration */
847interface nsIEventQueue; /* forward declaration */
848
849typedef interface nsISupports nsISupports; /* forward declaration */
850typedef interface nsIException nsIException; /* forward declaration */
851typedef interface nsIStackFrame nsIStackFrame; /* forward declaration */
852typedef interface nsIEventTarget nsIEventTarget;/* forward declaration */
853typedef interface nsIEventQueue nsIEventQueue; /* forward declaration */
854
855/* starting interface: nsISupports */
856#define NS_ISUPPORTS_IID_STR "00000000-0000-0000-c000-000000000046"
857
858#define NS_ISUPPORTS_IID \
859 { 0x00000000, 0x0000, 0x0000, \
860 {0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46} }
861
862/**
863 * Reference count values
864 *
865 * This is the return type for AddRef() and Release() in nsISupports.
866 * IUnknown of COM returns an unsigned long from equivalent functions.
867 * The following ifdef exists to maintain binary compatibility with
868 * IUnknown.
869 */
870#if defined(XP_WIN) &amp;&amp; PR_BYTES_PER_LONG == 4
871typedef unsigned long nsrefcnt;
872#else
873typedef PRUint32 nsrefcnt;
874#endif
875
876/**
877 * Basic component object model interface. Objects which implement
878 * this interface support runtime interface discovery (QueryInterface)
879 * and a reference counted memory model (AddRef/Release). This is
880 * modelled after the win32 IUnknown API.
881 */
882#ifndef VBOX_WITH_GLUE
883struct nsISupports_vtbl
884{
885 nsresult (*QueryInterface)(nsISupports *pThis, const nsID *iid, void **resultp);
886 nsrefcnt (*AddRef)(nsISupports *pThis);
887 nsrefcnt (*Release)(nsISupports *pThis);
888};
889#else /* !VBOX_WITH_GLUE */
890struct nsISupportsVtbl
891{
892 nsresult (*QueryInterface)(nsISupports *pThis, const nsID *iid, void **resultp);
893 nsrefcnt (*AddRef)(nsISupports *pThis);
894 nsrefcnt (*Release)(nsISupports *pThis);
895};
896#define nsISupports_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
897#define nsISupports_AddRef(p) ((p)->lpVtbl->AddRef(p))
898#define nsISupports_Release(p) ((p)->lpVtbl->Release(p))
899#define IUnknown_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
900#define IUnknown_AddRef(p) ((p)->lpVtbl->AddRef(p))
901#define IUnknown_Release(p) ((p)->lpVtbl->Release(p))
902#define IDispatch_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
903#define IDispatch_AddRef(p) ((p)->lpVtbl->AddRef(p))
904#define IDispatch_Release(p) ((p)->lpVtbl->Release(p))
905#endif /* !VBOX_WITH_GLUE */
906
907interface nsISupports
908{
909#ifndef VBOX_WITH_GLUE
910 struct nsISupports_vtbl *vtbl;
911#else /* !VBOX_WITH_GLUE */
912 CONST_VTBL struct nsISupportsVtbl *lpVtbl;
913#endif /* !VBOX_WITH_GLUE */
914};
915
916/* starting interface: nsIException */
917#define NS_IEXCEPTION_IID_STR "f3a8d3b4-c424-4edc-8bf6-8974c983ba78"
918
919#define NS_IEXCEPTION_IID \
920 {0xf3a8d3b4, 0xc424, 0x4edc, \
921 { 0x8b, 0xf6, 0x89, 0x74, 0xc9, 0x83, 0xba, 0x78 }}
922
923#ifndef VBOX_WITH_GLUE
924struct nsIException_vtbl
925{
926 /* Methods from the interface nsISupports */
927 struct nsISupports_vtbl nsisupports;
928
929 nsresult (*GetMessage)(nsIException *pThis, PRUnichar * *aMessage);
930 nsresult (*GetResult)(nsIException *pThis, nsresult *aResult);
931 nsresult (*GetName)(nsIException *pThis, PRUnichar * *aName);
932 nsresult (*GetFilename)(nsIException *pThis, PRUnichar * *aFilename);
933 nsresult (*GetLineNumber)(nsIException *pThis, PRUint32 *aLineNumber);
934 nsresult (*GetColumnNumber)(nsIException *pThis, PRUint32 *aColumnNumber);
935 nsresult (*GetLocation)(nsIException *pThis, nsIStackFrame * *aLocation);
936 nsresult (*GetInner)(nsIException *pThis, nsIException * *aInner);
937 nsresult (*GetData)(nsIException *pThis, nsISupports * *aData);
938 nsresult (*ToString)(nsIException *pThis, PRUnichar **_retval);
939};
940#else /* !VBOX_WITH_GLUE */
941struct nsIExceptionVtbl
942{
943 nsresult (*QueryInterface)(nsIException *pThis, const nsID *iid, void **resultp);
944 nsrefcnt (*AddRef)(nsIException *pThis);
945 nsrefcnt (*Release)(nsIException *pThis);
946
947 nsresult (*GetMessage)(nsIException *pThis, PRUnichar * *aMessage);
948 nsresult (*GetResult)(nsIException *pThis, nsresult *aResult);
949 nsresult (*GetName)(nsIException *pThis, PRUnichar * *aName);
950 nsresult (*GetFilename)(nsIException *pThis, PRUnichar * *aFilename);
951 nsresult (*GetLineNumber)(nsIException *pThis, PRUint32 *aLineNumber);
952 nsresult (*GetColumnNumber)(nsIException *pThis, PRUint32 *aColumnNumber);
953 nsresult (*GetLocation)(nsIException *pThis, nsIStackFrame * *aLocation);
954 nsresult (*GetInner)(nsIException *pThis, nsIException * *aInner);
955 nsresult (*GetData)(nsIException *pThis, nsISupports * *aData);
956 nsresult (*ToString)(nsIException *pThis, PRUnichar **_retval);
957};
958#define nsIException_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
959#define nsIException_AddRef(p) ((p)->lpVtbl->AddRef(p))
960#define nsIException_Release(p) ((p)->lpVtbl->Release(p))
961#define nsIException_get_Message(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))
962#define nsIException_GetMessage(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))
963#define nsIException_get_Result(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))
964#define nsIException_GetResult(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))
965#define nsIException_get_Name(p, aName) ((p)->lpVtbl->GetName(p, aName))
966#define nsIException_GetName(p, aName) ((p)->lpVtbl->GetName(p, aName))
967#define nsIException_get_Filename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
968#define nsIException_GetFilename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
969#define nsIException_get_LineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
970#define nsIException_GetLineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
971#define nsIException_get_ColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))
972#define nsIException_GetColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))
973#define nsIException_get_Inner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))
974#define nsIException_GetInner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))
975#define nsIException_get_Data(p, aData) ((p)->lpVtbl->GetData(p, aData))
976#define nsIException_GetData(p, aData) ((p)->lpVtbl->GetData(p, aData))
977#define nsIException_ToString(p, retval) ((p)->lpVtbl->ToString(p, retval))
978#define IErrorInfo_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
979#define IErrorInfo_AddRef(p) ((p)->lpVtbl->AddRef(p))
980#define IErrorInfo_Release(p) ((p)->lpVtbl->Release(p))
981#define IErrorInfo_get_Message(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))
982#define IErrorInfo_GetMessage(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))
983#define IErrorInfo_get_Result(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))
984#define IErrorInfo_GetResult(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))
985#define IErrorInfo_get_Name(p, aName) ((p)->lpVtbl->GetName(p, aName))
986#define IErrorInfo_GetName(p, aName) ((p)->lpVtbl->GetName(p, aName))
987#define IErrorInfo_get_Filename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
988#define IErrorInfo_GetFilename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
989#define IErrorInfo_get_LineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
990#define IErrorInfo_GetLineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
991#define IErrorInfo_get_ColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))
992#define IErrorInfo_GetColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))
993#define IErrorInfo_get_Inner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))
994#define IErrorInfo_GetInner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))
995#define IErrorInfo_get_Data(p, aData) ((p)->lpVtbl->GetData(p, aData))
996#define IErrorInfo_GetData(p, aData) ((p)->lpVtbl->GetData(p, aData))
997#define IErrorInfo_ToString(p, retval) ((p)->lpVtbl->ToString(p, retval))
998#endif /* !VBOX_WITH_GLUE */
999
1000interface nsIException
1001{
1002#ifndef VBOX_WITH_GLUE
1003 struct nsIException_vtbl *vtbl;
1004#else /* !VBOX_WITH_GLUE */
1005 CONST_VTBL struct nsIExceptionVtbl *lpVtbl;
1006#endif /* !VBOX_WITH_GLUE */
1007};
1008
1009/* starting interface: nsIStackFrame */
1010#define NS_ISTACKFRAME_IID_STR "91d82105-7c62-4f8b-9779-154277c0ee90"
1011
1012#define NS_ISTACKFRAME_IID \
1013 {0x91d82105, 0x7c62, 0x4f8b, \
1014 { 0x97, 0x79, 0x15, 0x42, 0x77, 0xc0, 0xee, 0x90 }}
1015
1016#ifndef VBOX_WITH_GLUE
1017struct nsIStackFrame_vtbl
1018{
1019 /* Methods from the interface nsISupports */
1020 struct nsISupports_vtbl nsisupports;
1021
1022 nsresult (*GetLanguage)(nsIStackFrame *pThis, PRUint32 *aLanguage);
1023 nsresult (*GetLanguageName)(nsIStackFrame *pThis, PRUnichar * *aLanguageName);
1024 nsresult (*GetFilename)(nsIStackFrame *pThis, PRUnichar * *aFilename);
1025 nsresult (*GetName)(nsIStackFrame *pThis, PRUnichar * *aName);
1026 nsresult (*GetLineNumber)(nsIStackFrame *pThis, PRInt32 *aLineNumber);
1027 nsresult (*GetSourceLine)(nsIStackFrame *pThis, PRUnichar * *aSourceLine);
1028 nsresult (*GetCaller)(nsIStackFrame *pThis, nsIStackFrame * *aCaller);
1029 nsresult (*ToString)(nsIStackFrame *pThis, PRUnichar **_retval);
1030};
1031#else /* !VBOX_WITH_GLUE */
1032struct nsIStackFrameVtbl
1033{
1034 nsresult (*QueryInterface)(nsIStackFrame *pThis, const nsID *iid, void **resultp);
1035 nsrefcnt (*AddRef)(nsIStackFrame *pThis);
1036 nsrefcnt (*Release)(nsIStackFrame *pThis);
1037
1038 nsresult (*GetLanguage)(nsIStackFrame *pThis, PRUint32 *aLanguage);
1039 nsresult (*GetLanguageName)(nsIStackFrame *pThis, PRUnichar * *aLanguageName);
1040 nsresult (*GetFilename)(nsIStackFrame *pThis, PRUnichar * *aFilename);
1041 nsresult (*GetName)(nsIStackFrame *pThis, PRUnichar * *aName);
1042 nsresult (*GetLineNumber)(nsIStackFrame *pThis, PRInt32 *aLineNumber);
1043 nsresult (*GetSourceLine)(nsIStackFrame *pThis, PRUnichar * *aSourceLine);
1044 nsresult (*GetCaller)(nsIStackFrame *pThis, nsIStackFrame * *aCaller);
1045 nsresult (*ToString)(nsIStackFrame *pThis, PRUnichar **_retval);
1046};
1047#define nsIStackFrame_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
1048#define nsIStackFrame_AddRef(p) ((p)->lpVtbl->AddRef(p))
1049#define nsIStackFrame_Release(p) ((p)->lpVtbl->Release(p))
1050#define nsIStackFrame_get_Language(p, aLanguage) ((p)->lpVtbl->GetLanguge(p, aLanguage))
1051#define nsIStackFrame_GetLanguage(p, aLanguage) ((p)->lpVtbl->GetLanguge(p, aLanguage))
1052#define nsIStackFrame_get_LanguageName(p, aLanguageName) ((p)->lpVtbl->GetLanguageName(p, aLanguageName))
1053#define nsIStackFrame_GetLanguageName(p, aLanguageName) ((p)->lpVtbl->GetLanguageName(p, aLanguageName))
1054#define nsIStackFrame_get_Filename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
1055#define nsIStackFrame_GetFilename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))
1056#define nsIStackFrame_get_Name(p, aName) ((p)->lpVtbl->GetName(p, aName))
1057#define nsIStackFrame_GetName(p, aName) ((p)->lpVtbl->GetName(p, aName))
1058#define nsIStackFrame_get_LineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
1059#define nsIStackFrame_GetLineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))
1060#define nsIStackFrame_get_SourceLine(p, aSourceLine) ((p)->lpVtbl->GetSourceLine(p, aSourceLine))
1061#define nsIStackFrame_GetSourceLine(p, aSourceLine) ((p)->lpVtbl->GetSourceLine(p, aSourceLine))
1062#define nsIStackFrame_get_Caller(p, aCaller) ((p)->lpVtbl->GetCaller(p, aCaller))
1063#define nsIStackFrame_GetCaller(p, aCaller) ((p)->lpVtbl->GetCaller(p, aCaller))
1064#define nsIStackFrame_ToString(p, retval) ((p)->lpVtbl->ToString(p, retval))
1065#endif /* !VBOX_WITH_GLUE */
1066
1067interface nsIStackFrame
1068{
1069#ifndef VBOX_WITH_GLUE
1070 struct nsIStackFrame_vtbl *vtbl;
1071#else /* !VBOX_WITH_GLUE */
1072 CONST_VTBL struct nsIStackFrameVtbl *lpVtbl;
1073#endif /* !VBOX_WITH_GLUE */
1074};
1075
1076/* starting interface: nsIEventTarget */
1077#define NS_IEVENTTARGET_IID_STR "ea99ad5b-cc67-4efb-97c9-2ef620a59f2a"
1078
1079#define NS_IEVENTTARGET_IID \
1080 {0xea99ad5b, 0xcc67, 0x4efb, \
1081 { 0x97, 0xc9, 0x2e, 0xf6, 0x20, 0xa5, 0x9f, 0x2a }}
1082
1083#ifndef VBOX_WITH_GLUE
1084struct nsIEventTarget_vtbl
1085{
1086 struct nsISupports_vtbl nsisupports;
1087
1088 nsresult (*PostEvent)(nsIEventTarget *pThis, PLEvent * aEvent);
1089 nsresult (*IsOnCurrentThread)(nsIEventTarget *pThis, PRBool *_retval);
1090};
1091#else /* !VBOX_WITH_GLUE */
1092struct nsIEventTargetVtbl
1093{
1094 nsresult (*QueryInterface)(nsIEventTarget *pThis, const nsID *iid, void **resultp);
1095 nsrefcnt (*AddRef)(nsIEventTarget *pThis);
1096 nsrefcnt (*Release)(nsIEventTarget *pThis);
1097
1098 nsresult (*PostEvent)(nsIEventTarget *pThis, PLEvent * aEvent);
1099 nsresult (*IsOnCurrentThread)(nsIEventTarget *pThis, PRBool *_retval);
1100};
1101#define nsIEventTarget_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
1102#define nsIEventTarget_AddRef(p) ((p)->lpVtbl->AddRef(p))
1103#define nsIEventTarget_Release(p) ((p)->lpVtbl->Release(p))
1104#define nsIEventTarget_PostEvent(p, aEvent) ((p)->lpVtbl->PostEvent(p, aEvent))
1105#define nsIEventTarget_IsOnCurrentThread(p, retval) ((p)->lpVtbl->IsOnCurrentThread(p, retval))
1106#endif /* !VBOX_WITH_GLUE */
1107
1108interface nsIEventTarget
1109{
1110#ifndef VBOX_WITH_GLUE
1111 struct nsIEventTarget_vtbl *vtbl;
1112#else /* !VBOX_WITH_GLUE */
1113 CONST_VTBL struct nsIEventTargetVtbl *lpVtbl;
1114#endif /* !VBOX_WITH_GLUE */
1115};
1116
1117/* starting interface: nsIEventQueue */
1118#define NS_IEVENTQUEUE_IID_STR "176afb41-00a4-11d3-9f2a-00400553eef0"
1119
1120#define NS_IEVENTQUEUE_IID \
1121 {0x176afb41, 0x00a4, 0x11d3, \
1122 { 0x9f, 0x2a, 0x00, 0x40, 0x05, 0x53, 0xee, 0xf0 }}
1123
1124#ifndef VBOX_WITH_GLUE
1125struct nsIEventQueue_vtbl
1126{
1127 struct nsIEventTarget_vtbl nsieventtarget;
1128
1129 nsresult (*InitEvent)(nsIEventQueue *pThis, PLEvent * aEvent, void * owner, PLHandleEventProc handler, PLDestroyEventProc destructor);
1130 nsresult (*PostSynchronousEvent)(nsIEventQueue *pThis, PLEvent * aEvent, void * *aResult);
1131 nsresult (*PendingEvents)(nsIEventQueue *pThis, PRBool *_retval);
1132 nsresult (*ProcessPendingEvents)(nsIEventQueue *pThis);
1133 nsresult (*EventLoop)(nsIEventQueue *pThis);
1134 nsresult (*EventAvailable)(nsIEventQueue *pThis, PRBool *aResult);
1135 nsresult (*GetEvent)(nsIEventQueue *pThis, PLEvent * *_retval);
1136 nsresult (*HandleEvent)(nsIEventQueue *pThis, PLEvent * aEvent);
1137 nsresult (*WaitForEvent)(nsIEventQueue *pThis, PLEvent * *_retval);
1138 PRInt32 (*GetEventQueueSelectFD)(nsIEventQueue *pThis);
1139 nsresult (*Init)(nsIEventQueue *pThis, PRBool aNative);
1140 nsresult (*InitFromPRThread)(nsIEventQueue *pThis, PRThread * thread, PRBool aNative);
1141 nsresult (*InitFromPLQueue)(nsIEventQueue *pThis, PLEventQueue * aQueue);
1142 nsresult (*EnterMonitor)(nsIEventQueue *pThis);
1143 nsresult (*ExitMonitor)(nsIEventQueue *pThis);
1144 nsresult (*RevokeEvents)(nsIEventQueue *pThis, void * owner);
1145 nsresult (*GetPLEventQueue)(nsIEventQueue *pThis, PLEventQueue * *_retval);
1146 nsresult (*IsQueueNative)(nsIEventQueue *pThis, PRBool *_retval);
1147 nsresult (*StopAcceptingEvents)(nsIEventQueue *pThis);
1148};
1149#else /* !VBOX_WITH_GLUE */
1150struct nsIEventQueueVtbl
1151{
1152 nsresult (*QueryInterface)(nsIEventQueue *pThis, const nsID *iid, void **resultp);
1153 nsrefcnt (*AddRef)(nsIEventQueue *pThis);
1154 nsrefcnt (*Release)(nsIEventQueue *pThis);
1155
1156 nsresult (*PostEvent)(nsIEventQueue *pThis, PLEvent * aEvent);
1157 nsresult (*IsOnCurrentThread)(nsIEventQueue *pThis, PRBool *_retval);
1158
1159 nsresult (*InitEvent)(nsIEventQueue *pThis, PLEvent * aEvent, void * owner, PLHandleEventProc handler, PLDestroyEventProc destructor);
1160 nsresult (*PostSynchronousEvent)(nsIEventQueue *pThis, PLEvent * aEvent, void * *aResult);
1161 nsresult (*PendingEvents)(nsIEventQueue *pThis, PRBool *_retval);
1162 nsresult (*ProcessPendingEvents)(nsIEventQueue *pThis);
1163 nsresult (*EventLoop)(nsIEventQueue *pThis);
1164 nsresult (*EventAvailable)(nsIEventQueue *pThis, PRBool *aResult);
1165 nsresult (*GetEvent)(nsIEventQueue *pThis, PLEvent * *_retval);
1166 nsresult (*HandleEvent)(nsIEventQueue *pThis, PLEvent * aEvent);
1167 nsresult (*WaitForEvent)(nsIEventQueue *pThis, PLEvent * *_retval);
1168 PRInt32 (*GetEventQueueSelectFD)(nsIEventQueue *pThis);
1169 nsresult (*Init)(nsIEventQueue *pThis, PRBool aNative);
1170 nsresult (*InitFromPRThread)(nsIEventQueue *pThis, PRThread * thread, PRBool aNative);
1171 nsresult (*InitFromPLQueue)(nsIEventQueue *pThis, PLEventQueue * aQueue);
1172 nsresult (*EnterMonitor)(nsIEventQueue *pThis);
1173 nsresult (*ExitMonitor)(nsIEventQueue *pThis);
1174 nsresult (*RevokeEvents)(nsIEventQueue *pThis, void * owner);
1175 nsresult (*GetPLEventQueue)(nsIEventQueue *pThis, PLEventQueue * *_retval);
1176 nsresult (*IsQueueNative)(nsIEventQueue *pThis, PRBool *_retval);
1177 nsresult (*StopAcceptingEvents)(nsIEventQueue *pThis);
1178};
1179#define nsIEventQueue_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))
1180#define nsIEventQueue_AddRef(p) ((p)->lpVtbl->AddRef(p))
1181#define nsIEventQueue_Release(p) ((p)->lpVtbl->Release(p))
1182#define nsIEventQueue_PostEvent(p, aEvent) ((p)->lpVtbl->PostEvent(p, aEvent))
1183#define nsIEventQueue_IsOnCurrentThread(p, retval) ((p)->lpVtbl->IsOnCurrentThread(p, retval))
1184#define nsIEventQueue_InitEvent(p, aEvent, owner, handler, destructor) ((p)->lpVtbl->InitEvent(p, aEvent, owner, handler, destructor))
1185#define nsIEventQueue_PostSynchronousEvent(p, aEvent, aResult) ((p)->lpVtbl->PostSynchronousEvent(p, aEvent, aResult))
1186#define nsIEventQueue_ProcessPendingEvents(p) ((p)->lpVtbl->ProcessPendingEvents(p))
1187#define nsIEventQueue_EventLoop(p) ((p)->lpVtbl->EventLoop(p))
1188#define nsIEventQueue_EventAvailable(p, aResult) ((p)->lpVtbl->EventAvailable(p, aResult))
1189#define nsIEventQueue_get_Event(p, aEvent) ((p)->lpVtbl->GetEvent(p, aEvent))
1190#define nsIEventQueue_GetEvent(p, aEvent) ((p)->lpVtbl->GetEvent(p, aEvent))
1191#define nsIEventQueue_HandleEvent(p, aEvent) ((p)->lpVtbl->HandleEvent(p, aEvent))
1192#define nsIEventQueue_WaitForEvent(p, aEvent) ((p)->lpVtbl->WaitForEvent(p, aEvent))
1193#define nsIEventQueue_GetEventQueueSelectFD(p) ((p)->lpVtbl->GetEventQueueSelectFD(p))
1194#define nsIEventQueue_Init(p, aNative) ((p)->lpVtbl->Init(p, aNative))
1195#define nsIEventQueue_InitFromPLQueue(p, aQueue) ((p)->lpVtbl->InitFromPLQueue(p, aQueue))
1196#define nsIEventQueue_EnterMonitor(p) ((p)->lpVtbl->EnterMonitor(p))
1197#define nsIEventQueue_ExitMonitor(p) ((p)->lpVtbl->ExitMonitor(p))
1198#define nsIEventQueue_RevokeEvents(p, owner) ((p)->lpVtbl->RevokeEvents(p, owner))
1199#define nsIEventQueue_GetPLEventQueue(p, retval) ((p)->lpVtbl->GetPLEventQueue(p, retval))
1200#define nsIEventQueue_IsQueueNative(p, retval) ((p)->lpVtbl->IsQueueNative(p, retval))
1201#define nsIEventQueue_StopAcceptingEvents(p) ((p)->lpVtbl->StopAcceptingEvents(p))
1202#endif /* !VBOX_WITH_GLUE */
1203
1204interface nsIEventQueue
1205{
1206#ifndef VBOX_WITH_GLUE
1207 struct nsIEventQueue_vtbl *vtbl;
1208#else /* !VBOX_WITH_GLUE */
1209 CONST_VTBL struct nsIEventQueueVtbl *lpVtbl;
1210#endif /* !VBOX_WITH_GLUE */
1211};
1212</xsl:text>
1213 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1214 <xsl:apply-templates/>
1215 <xsl:text>
1216
1217#endif /* __cplusplus */
1218
1219#endif /* !WIN32 */
1220
1221#ifdef __cplusplus
1222extern "C"
1223{
1224#endif /* __cplusplus */
1225
1226
1227/**
1228 * Function table for dynamic linking.
1229 * Use VBoxGetCAPIFunctions() to obtain the pointer to it.
1230 */
1231typedef struct VBOXCAPI
1232{
1233 /** The size of the structure. */
1234 unsigned cb;
1235 /** The structure version. */
1236 unsigned uVersion;
1237
1238 /** Gets the VirtualBox version, major * 1000000 + minor * 1000 + patch. */
1239 unsigned int (*pfnGetVersion)(void);
1240
1241 /** Gets the VirtualBox API version, major * 1000 + minor, e.g. 4003. */
1242 unsigned int (*pfnGetAPIVersion)(void);
1243
1244 /**
1245 * New and preferred way to initialize the C bindings for an API client.
1246 *
1247 * This way is much more flexible, as it can easily handle multiple
1248 * sessions (important with more complicated API clients, including
1249 * multithreaded ones), and even VBoxSVC crashes can be detected and
1250 * processed appropriately by listening for events from the associated
1251 * event source in VirtualBoxClient. It is completely up to the client
1252 * to decide what to do (terminate or continue after getting new
1253 * object references to server-side objects). Must be called in the
1254 * primary thread of the client, later API use can be done in any
1255 * thread.
1256 *
1257 * Note that the returned reference is owned by the caller, and thus it's
1258 * the caller's responsibility to handle the reference count appropriately.
1259 *
1260 * @param pszVirtualBoxClientIID pass IVIRTUALBOXCLIENT_IID_STR
1261 * @param ppVirtualBoxClient output parameter for VirtualBoxClient
1262 * reference, handled as usual with COM/XPCOM.
1263 * @returns COM/XPCOM error code
1264 */
1265 HRESULT (*pfnClientInitialize)(const char *pszVirtualBoxClientIID,
1266 IVirtualBoxClient **ppVirtualBoxClient);
1267 /**
1268 * Initialize the use of the C bindings in a non-primary thread.
1269 *
1270 * Must be called on any newly created thread which wants to use the
1271 * VirtualBox API.
1272 *
1273 * @returns COM/XPCOM error code
1274 */
1275 HRESULT (*pfnClientThreadInitialize)(void);
1276 /**
1277 * Uninitialize the use of the C bindings in a non-primary thread.
1278 *
1279 * Should be called before terminating the thread which initialized the
1280 * C bindings using pfnClientThreadInitialize.
1281 *
1282 * @returns COM/XPCOM error code
1283 */
1284 HRESULT (*pfnClientThreadUninitialize)(void);
1285 /**
1286 * Uninitialize the C bindings for an API client.
1287 *
1288 * Should be called when the API client is about to terminate and does
1289 * not want to use the C bindings any more. It will invalidate all
1290 * object references. It is possible, however, to change one's mind,
1291 * and call pfnClientInitialize again to continue using the API, as long
1292 * as none of the object references from before the re-initialization
1293 * are used. Must be called from the primary thread of the client.
1294 */
1295 void (*pfnClientUninitialize)(void);
1296
1297 /**
1298 * Deprecated way to initialize the C bindings and getting important
1299 * object references. Kept for backwards compatibility.
1300 *
1301 * If any returned reference is NULL then the initialization failed.
1302 * Note that the returned references are owned by the C bindings. The
1303 * number of calls to Release in the client code must match the number
1304 * of calls to AddRef, and additionally at no point in time there can
1305 * be more Release calls than AddRef calls.
1306 *
1307 * @param pszVirtualBoxIID pass IVIRTUALBOX_IID_STR
1308 * @param ppVirtualBox output parameter for VirtualBox reference,
1309 * owned by C bindings
1310 * @param pszSessionIID pass ISESSION_IID_STR
1311 * @param ppSession output parameter for Session reference,
1312 * owned by C bindings
1313 */
1314 void (*pfnComInitialize)(const char *pszVirtualBoxIID,
1315 IVirtualBox **ppVirtualBox,
1316 const char *pszSessionIID,
1317 ISession **ppSession);
1318 /**
1319 * Deprecated way to uninitialize the C bindings for an API client.
1320 * Kept for backwards compatibility and must be used if the C bindings
1321 * were initialized using pfnComInitialize. */
1322 void (*pfnComUninitialize)(void);
1323
1324 /**
1325 * Free string managed by COM/XPCOM.
1326 *
1327 * @param pwsz pointer to string to be freed
1328 */
1329 void (*pfnComUnallocString)(BSTR pwsz);
1330#ifndef WIN32
1331 /** Legacy function, was always for freeing strings only. */
1332#define pfnComUnallocMem(pv) pfnComUnallocString((BSTR)(pv))
1333#endif /* !WIN32 */
1334
1335 /**
1336 * Convert string from UTF-16 encoding to UTF-8 encoding.
1337 *
1338 * @param pwszString input string
1339 * @param ppszString output string
1340 * @returns IPRT status code
1341 */
1342 int (*pfnUtf16ToUtf8)(CBSTR pwszString, char **ppszString);
1343 /**
1344 * Convert string from UTF-8 encoding to UTF-16 encoding.
1345 *
1346 * @param pszString input string
1347 * @param ppwszString output string
1348 * @returns IPRT status code
1349 */
1350 int (*pfnUtf8ToUtf16)(const char *pszString, BSTR *ppwszString);
1351 /**
1352 * Free memory returned by pfnUtf16ToUtf8. Do not use for anything else.
1353 *
1354 * @param pszString string to be freed.
1355 */
1356 void (*pfnUtf8Free)(char *pszString);
1357 /**
1358 * Free memory returned by pfnUtf8ToUtf16. Do not use for anything else.
1359 *
1360 * @param pwszString string to be freed.
1361 */
1362 void (*pfnUtf16Free)(BSTR pwszString);
1363
1364 /**
1365 * Create a safearray (used for passing arrays to COM/XPCOM)
1366 *
1367 * Must be freed by pfnSafeArrayDestroy.
1368 *
1369 * @param vt variant type, defines the size of the elements
1370 * @param lLbound lower bound of the index, should be 0
1371 * @param cElements number of elements
1372 * @returns pointer to safearray
1373 */
1374 SAFEARRAY *(*pfnSafeArrayCreateVector)(VARTYPE vt, LONG lLbound, ULONG cElements);
1375 /**
1376 * Pre-allocate a safearray to be used by an out safearray parameter
1377 *
1378 * Must be freed by pfnSafeArrayDestroy.
1379 *
1380 * @returns pointer to safearray (system dependent, may be NULL if
1381 * there is no need to pre-allocate a safearray)
1382 */
1383 SAFEARRAY *(*pfnSafeArrayOutParamAlloc)(void);
1384 /**
1385 * Copy a C array into a safearray (for passing as an input parameter)
1386 *
1387 * @param psa pointer to already created safearray.
1388 * @param pv pointer to memory block to copy into safearray.
1389 * @param cb number of bytes to copy.
1390 * @returns COM/XPCOM error code
1391 */
1392 HRESULT (*pfnSafeArrayCopyInParamHelper)(SAFEARRAY *psa, const void *pv, ULONG cb);
1393 /**
1394 * Copy a safearray into a C array (for getting an output parameter)
1395 *
1396 * @param ppv output pointer to newly created array, which has to
1397 * be freed with pfnArrayOutFree.
1398 * @param pcb number of bytes in the output buffer.
1399 * @param vt variant type, defines the size of the elements
1400 * @param psa pointer to safearray for getting the data
1401 * @returns COM/XPCOM error code
1402 */
1403 HRESULT (*pfnSafeArrayCopyOutParamHelper)(void **ppv, ULONG *pcb, VARTYPE vt, SAFEARRAY *psa);
1404 /**
1405 * Copy a safearray into a C array (special variant for interface pointers)
1406 *
1407 * @param ppaObj output pointer to newly created array, which has
1408 * to be freed with pfnArrayOutFree. Note that it's the caller's
1409 * responsibility to call Release() on each non-NULL interface
1410 * pointer before freeing.
1411 * @param pcObj number of pointers in the output buffer.
1412 * @param psa pointer to safearray for getting the data
1413 * @returns COM/XPCOM error code
1414 */
1415 HRESULT (*pfnSafeArrayCopyOutIfaceParamHelper)(IUnknown ***ppaObj, ULONG *pcObj, SAFEARRAY *psa);
1416 /**
1417 * Free a safearray
1418 *
1419 * @param psa pointer to safearray
1420 * @returns COM/XPCOM error code
1421 */
1422 HRESULT (*pfnSafeArrayDestroy)(SAFEARRAY *psa);
1423 /**
1424 * Free an out array created by pfnSafeArrayCopyOutParamHelper or
1425 * pdnSafeArrayCopyOutIfaceParamHelper.
1426 *
1427 * @param psa pointer to memory block
1428 * @returns COM/XPCOM error code
1429 */
1430 HRESULT (*pfnArrayOutFree)(void *pv);
1431
1432#ifndef WIN32
1433 /**
1434 * Get XPCOM event queue. Deprecated!
1435 *
1436 * @param ppEventQueue output parameter for nsIEventQueue reference,
1437 * owned by C bindings.
1438 */
1439 void (*pfnGetEventQueue)(nsIEventQueue **ppEventQueue);
1440#endif /* !WIN32 */
1441
1442 /**
1443 * Get current COM/XPCOM exception.
1444 *
1445 * @param ppException output parameter for exception info reference,
1446 * may be @c NULL if no exception object has been created by
1447 * a previous COM/XPCOM call.
1448 * @returns COM/XPCOM error code
1449 */
1450 HRESULT (*pfnGetException)(IErrorInfo **ppException);
1451 /**
1452 * Clears current COM/XPCOM exception.
1453 *
1454 * @returns COM/XPCOM error code
1455 */
1456 HRESULT (*pfnClearException)(void);
1457
1458 /**
1459 * Process the event queue for a given amount of time.
1460 *
1461 * Must be called on the primary thread. Typical timeouts are from 200 to
1462 * 5000 msecs, to allow for checking a volatile variable if the event queue
1463 * processing should be terminated (,
1464 * or 0 if only the pending events should be processed, without waiting.
1465 *
1466 * @param iTimeoutMS how long to process the event queue, -1 means
1467 * infinitely long
1468 * @returns status code
1469 * @retval 0 if at least one event has been processed
1470 * @retval 1 if any signal interrupted the native system call (or returned
1471 * otherwise)
1472 * @retval 2 if the event queue was explicitly interrupted
1473 * @retval 3 if the timeout expired
1474 * @retval 4 if the function was called from the wrong thread
1475 * @retval 5 for all other (unexpected) errors
1476 */
1477 int (*pfnProcessEventQueue)(LONG64 iTimeoutMS);
1478 /**
1479 * Interrupt event queue processing.
1480 *
1481 * Can be called on any thread. Note that this function is not async-signal
1482 * safe, so never use it in such a context, instead use a volatile global
1483 * variable and a sensible timeout.
1484 * @returns 0 if successful, 1 otherwise.
1485 */
1486 int (*pfnInterruptEventQueueProcessing)(void);
1487
1488 /**
1489 * Clear memory used by a UTF-8 string. Must be zero terminated.
1490 * Can be used for any UTF-8 or ASCII/ANSI string.
1491 *
1492 * @param pszString input/output string
1493 */
1494 void (*pfnUtf8Clear)(char *pszString);
1495 /**
1496 * Clear memory used by a UTF-16 string. Must be zero terminated.
1497 * Can be used for any UTF-16 or UCS-2 string.
1498 *
1499 * @param pwszString input/output string
1500 */
1501 void (*pfnUtf16Clear)(BSTR pwszString);
1502
1503 /** Tail version, same as uVersion.
1504 *
1505 * This should only be accessed if for some reason an API client needs
1506 * exactly the version it requested, or if cb is used to calculate the
1507 * address of this field. It may move as the structure before this is
1508 * allowed to grow as long as all the data from earlier minor versions
1509 * remains at the same place.
1510 */
1511 unsigned uEndVersion;
1512} VBOXCAPI;
1513/** Pointer to a const VBOXCAPI function table. */
1514typedef VBOXCAPI const *PCVBOXCAPI;
1515#ifndef WIN32
1516/** Backwards compatibility: Pointer to a const VBOXCAPI function table.
1517 * Use PCVBOXCAPI instead. */
1518typedef VBOXCAPI const *PCVBOXXPCOM;
1519#endif /* !WIN32 */
1520
1521#ifndef WIN32
1522/** Backwards compatibility: make sure old code using VBOXXPCOMC still compiles.
1523 * Use VBOXCAPI instead. */
1524#define VBOXXPCOMC VBOXCAPI
1525#endif /* !WIN32 */
1526
1527/** Extract the C API style major version.
1528 * Useful for comparing the interface version in VBOXCAPI::uVersion. */
1529#define VBOX_CAPI_MAJOR(x) (((x) &amp; 0xffff0000U) &gt;&gt; 16)
1530
1531/** Extract the C API style major version.
1532 * Useful for comparing the interface version in VBOXCAPI::uVersion. */
1533#define VBOX_CAPI_MINOR(x) ((x) &amp; 0x0000ffffU)
1534
1535/** The current interface version.
1536 * For use with VBoxGetCAPIFunctions and to be found in VBOXCAPI::uVersion. */
1537#define VBOX_CAPI_VERSION 0x00040001U
1538
1539#ifndef WIN32
1540/** Backwards compatibility: The current interface version.
1541 * Use VBOX_CAPI_VERSION instead. */
1542#define VBOX_XPCOMC_VERSION VBOX_CAPI_VERSION
1543#endif /* !WIN32 */
1544
1545/** VBoxGetCAPIFunctions. */
1546VBOXCAPI_DECL(PCVBOXCAPI) VBoxGetCAPIFunctions(unsigned uVersion);
1547#ifndef WIN32
1548/** Backwards compatibility: VBoxGetXPCOMCFunctions.
1549 * Use VBoxGetCAPIFunctions instead. */
1550VBOXCAPI_DECL(PCVBOXCAPI) VBoxGetXPCOMCFunctions(unsigned uVersion);
1551#endif /* !WIN32 */
1552
1553/** Typedef for VBoxGetCAPIFunctions. */
1554typedef PCVBOXCAPI (*PFNVBOXGETCAPIFUNCTIONS)(unsigned uVersion);
1555#ifndef WIN32
1556/** Backwards compatibility: Typedef for VBoxGetXPCOMCFunctions.
1557 * Use PFNVBOXGETCAPIFUNCTIONS instead. */
1558typedef PCVBOXCAPI (*PFNVBOXGETXPCOMCFUNCTIONS)(unsigned uVersion);
1559#endif /* !WIN32 */
1560
1561/** The symbol name of VBoxGetCAPIFunctions. */
1562#ifdef __OS2__
1563# define VBOX_GET_CAPI_FUNCTIONS_SYMBOL_NAME "_VBoxGetCAPIFunctions"
1564#else /* !__OS2__ */
1565# define VBOX_GET_CAPI_FUNCTIONS_SYMBOL_NAME "VBoxGetCAPIFunctions"
1566#endif /* !__OS2__ */
1567#ifndef WIN32
1568/** Backwards compatibility: The symbol name of VBoxGetXPCOMCFunctions.
1569 * Use VBOX_GET_CAPI_FUNCTIONS_SYMBOL_NAME instead. */
1570# ifdef __OS2__
1571# define VBOX_GET_XPCOMC_FUNCTIONS_SYMBOL_NAME "_VBoxGetXPCOMCFunctions"
1572# else /* !__OS2__ */
1573# define VBOX_GET_XPCOMC_FUNCTIONS_SYMBOL_NAME "VBoxGetXPCOMCFunctions"
1574# endif /* !__OS2__ */
1575#endif /* !WIN32 */
1576
1577
1578#ifdef __cplusplus
1579}
1580#endif /* __cplusplus */
1581
1582#endif /* !___VirtualBox_CAPI_h */
1583</xsl:text>
1584</xsl:template>
1585
1586<!--
1587 * ignore all |if|s except those for XPIDL target
1588-->
1589<xsl:template match="if">
1590 <xsl:if test="@target='xpidl'">
1591 <xsl:apply-templates/>
1592 </xsl:if>
1593</xsl:template>
1594<xsl:template match="if" mode="forward">
1595 <xsl:if test="@target='xpidl'">
1596 <xsl:apply-templates mode="forward"/>
1597 </xsl:if>
1598</xsl:template>
1599<xsl:template match="if" mode="forwarder">
1600 <xsl:if test="@target='midl'">
1601 <xsl:apply-templates mode="forwarder"/>
1602 </xsl:if>
1603</xsl:template>
1604
1605
1606<!--
1607 * libraries
1608-->
1609<xsl:template match="library">
1610 <!-- result codes -->
1611 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1612 <xsl:for-each select="result">
1613 <xsl:apply-templates select="."/>
1614 </xsl:for-each>
1615 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1616 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1617 <!-- forward declarations -->
1618 <xsl:apply-templates select="interface | if/interface" mode="forward"/>
1619 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1620 <!-- typedef'ing the struct declarations -->
1621 <xsl:apply-templates select="interface | if/interface" mode="typedef"/>
1622 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1623 <!-- all enums go first -->
1624 <xsl:apply-templates select="enum | if/enum"/>
1625 <!-- everything else but result codes and enums -->
1626 <xsl:apply-templates select="*[not(self::result or self::enum) and
1627 not(self::if[result] or self::if[enum])]"/>
1628 <!-- -->
1629</xsl:template>
1630
1631
1632<!--
1633 * result codes
1634-->
1635<xsl:template match="result">
1636 <xsl:value-of select="concat('#define ',@name,' ((HRESULT)',@value, ')')"/>
1637 <xsl:text>&#x0A;</xsl:text>
1638</xsl:template>
1639
1640
1641<!--
1642 * forward declarations
1643-->
1644<xsl:template match="interface" mode="forward">
1645 <xsl:if test="not(@internal='yes')">
1646 <xsl:text>interface </xsl:text>
1647 <xsl:value-of select="@name"/>
1648 <xsl:text>;&#x0A;</xsl:text>
1649 </xsl:if>
1650</xsl:template>
1651
1652
1653<!--
1654 * typedef'ing the struct declarations
1655-->
1656<xsl:template match="interface" mode="typedef">
1657 <xsl:if test="not(@internal='yes')">
1658 <xsl:text>typedef interface </xsl:text>
1659 <xsl:value-of select="@name"/>
1660 <xsl:text> </xsl:text>
1661 <xsl:value-of select="@name"/>
1662 <xsl:text>;&#x0A;</xsl:text>
1663 </xsl:if>
1664</xsl:template>
1665
1666
1667<!--
1668 * COBJMACRO style convenience macros for calling methods
1669-->
1670<xsl:template match="interface" mode="cobjmacro">
1671 <xsl:param name="iface"/>
1672
1673 <xsl:variable name="extends" select="@extends"/>
1674 <xsl:choose>
1675 <xsl:when test="$extends='$unknown'">
1676 <xsl:text>#define </xsl:text>
1677 <xsl:value-of select="$iface"/>
1678 <xsl:text>_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))&#x0A;</xsl:text>
1679 <xsl:text>#define </xsl:text>
1680 <xsl:value-of select="$iface"/>
1681 <xsl:text>_AddRef(p) ((p)->lpVtbl->AddRef(p))&#x0A;</xsl:text>
1682 <xsl:text>#define </xsl:text>
1683 <xsl:value-of select="$iface"/>
1684 <xsl:text>_Release(p) ((p)->lpVtbl->Release(p))&#x0A;</xsl:text>
1685 </xsl:when>
1686 <xsl:when test="$extends='$errorinfo'">
1687 <xsl:text>#define </xsl:text>
1688 <xsl:value-of select="$iface"/>
1689 <xsl:text>_QueryInterface(p, iid, resultp) ((p)->lpVtbl->QueryInterface(p, iid, resultp))&#x0A;</xsl:text>
1690 <xsl:text>#define </xsl:text>
1691 <xsl:value-of select="$iface"/>
1692 <xsl:text>_AddRef(p) ((p)->lpVtbl->AddRef(p))&#x0A;</xsl:text>
1693 <xsl:text>#define </xsl:text>
1694 <xsl:value-of select="$iface"/>
1695 <xsl:text>_Release(p) ((p)->lpVtbl->Release(p))&#x0A;</xsl:text>
1696 <xsl:text>#define </xsl:text>
1697 <xsl:value-of select="$iface"/>
1698 <xsl:text>_get_Message(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))&#x0A;</xsl:text>
1699 <xsl:text>#define </xsl:text>
1700 <xsl:value-of select="$iface"/>
1701 <xsl:text>_GetMessage(p, aMessage) ((p)->lpVtbl->GetMessage(p, aMessage))&#x0A;</xsl:text>
1702 <xsl:text>#define </xsl:text>
1703 <xsl:value-of select="$iface"/>
1704 <xsl:text>_get_Result(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))&#x0A;</xsl:text>
1705 <xsl:text>#define </xsl:text>
1706 <xsl:value-of select="$iface"/>
1707 <xsl:text>_GetResult(p, aResult) ((p)->lpVtbl->GetResult(p, aResult))&#x0A;</xsl:text>
1708 <xsl:text>#define </xsl:text>
1709 <xsl:value-of select="$iface"/>
1710 <xsl:text>_get_Name(p, aName) ((p)->lpVtbl->GetName(p, aName))&#x0A;</xsl:text>
1711 <xsl:text>#define </xsl:text>
1712 <xsl:value-of select="$iface"/>
1713 <xsl:text>_GetName(p, aName) ((p)->lpVtbl->GetName(p, aName))&#x0A;</xsl:text>
1714 <xsl:text>#define </xsl:text>
1715 <xsl:value-of select="$iface"/>
1716 <xsl:text>_get_Filename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))&#x0A;</xsl:text>
1717 <xsl:text>#define </xsl:text>
1718 <xsl:value-of select="$iface"/>
1719 <xsl:text>_GetFilename(p, aFilename) ((p)->lpVtbl->GetFilename(p, aFilename))&#x0A;</xsl:text>
1720 <xsl:text>#define </xsl:text>
1721 <xsl:value-of select="$iface"/>
1722 <xsl:text>_get_LineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))&#x0A;</xsl:text>
1723 <xsl:text>#define </xsl:text>
1724 <xsl:value-of select="$iface"/>
1725 <xsl:text>_GetLineNumber(p, aLineNumber) ((p)->lpVtbl->GetLineNumber(p, aLineNumber))&#x0A;</xsl:text>
1726 <xsl:text>#define </xsl:text>
1727 <xsl:value-of select="$iface"/>
1728 <xsl:text>_get_ColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))&#x0A;</xsl:text>
1729 <xsl:text>#define </xsl:text>
1730 <xsl:value-of select="$iface"/>
1731 <xsl:text>_GetColumnNumber(p, aColumnNumber) ((p)->lpVtbl->GetColumnNumber(p, aColumnNumber))&#x0A;</xsl:text>
1732 <xsl:text>#define </xsl:text>
1733 <xsl:value-of select="$iface"/>
1734 <xsl:text>_get_Location(p, aLocation) ((p)->lpVtbl->GetLocation(p, aLocation))&#x0A;</xsl:text>
1735 <xsl:text>#define </xsl:text>
1736 <xsl:value-of select="$iface"/>
1737 <xsl:text>_GetLocation(p, aLocation) ((p)->lpVtbl->GetLocation(p, aLocation))&#x0A;</xsl:text>
1738 <xsl:text>#define </xsl:text>
1739 <xsl:value-of select="$iface"/>
1740 <xsl:text>_get_Inner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))&#x0A;</xsl:text>
1741 <xsl:text>#define </xsl:text>
1742 <xsl:value-of select="$iface"/>
1743 <xsl:text>_GetInner(p, aInner) ((p)->lpVtbl->GetInner(p, aInner))&#x0A;</xsl:text>
1744 <xsl:text>#define </xsl:text>
1745 <xsl:value-of select="$iface"/>
1746 <xsl:text>_get_Data(p, aData) ((p)->lpVtbl->GetData(p, aData))&#x0A;</xsl:text>
1747 <xsl:text>#define </xsl:text>
1748 <xsl:value-of select="$iface"/>
1749 <xsl:text>_GetData(p, aData) ((p)->lpVtbl->GetData(p, aData))&#x0A;</xsl:text>
1750 <xsl:text>#define </xsl:text>
1751 <xsl:value-of select="$iface"/>
1752 <xsl:text>_ToString(p, retval) ((p)->lpVtbl->ToString(p, retval))&#x0A;</xsl:text>
1753 </xsl:when>
1754 <xsl:otherwise>
1755 <xsl:apply-templates select="key('G_keyInterfacesByName', $extends)" mode="cobjmacro">
1756 <xsl:with-param name="iface" select="$iface"/>
1757 </xsl:apply-templates>
1758 </xsl:otherwise>
1759 </xsl:choose>
1760 <!-- attributes (properties) -->
1761 <xsl:apply-templates select="attribute | if/attribute" mode="cobjmacro">
1762 <xsl:with-param name="iface" select="$iface"/>
1763 </xsl:apply-templates>
1764 <!-- methods -->
1765 <xsl:apply-templates select="method | if/method" mode="cobjmacro">
1766 <xsl:with-param name="iface" select="$iface"/>
1767 </xsl:apply-templates>
1768</xsl:template>
1769
1770
1771<!--
1772 * emit flat vtable, compatible with COM
1773-->
1774<xsl:template match="interface" mode="vtab_flat">
1775 <xsl:param name="iface"/>
1776
1777 <xsl:variable name="name" select="@name"/>
1778 <xsl:variable name="extends" select="@extends"/>
1779 <xsl:choose>
1780 <xsl:when test="$extends='$unknown'">
1781 <xsl:text> nsresult (*QueryInterface)(</xsl:text>
1782 <xsl:value-of select="$iface"/>
1783 <xsl:text> *pThis, const nsID *iid, void **resultp);&#x0A;</xsl:text>
1784 <xsl:text> nsrefcnt (*AddRef)(</xsl:text>
1785 <xsl:value-of select="$iface"/>
1786 <xsl:text> *pThis);&#x0A;</xsl:text>
1787 <xsl:text> nsrefcnt (*Release)(</xsl:text>
1788 <xsl:value-of select="$iface"/>
1789 <xsl:text> *pThis);&#x0A;</xsl:text>
1790 </xsl:when>
1791 <xsl:when test="$extends='$errorinfo'">
1792 <xsl:text> nsresult (*QueryInterface)(</xsl:text>
1793 <xsl:value-of select="$iface"/>
1794 <xsl:text> *pThis, const nsID *iid, void **resultp);&#x0A;</xsl:text>
1795 <xsl:text> nsrefcnt (*AddRef)(</xsl:text>
1796 <xsl:value-of select="$iface"/>
1797 <xsl:text> *pThis);&#x0A;</xsl:text>
1798 <xsl:text> nsrefcnt (*Release)(</xsl:text>
1799 <xsl:value-of select="$iface"/>
1800 <xsl:text> *pThis);&#x0A;</xsl:text>
1801 <xsl:text> nsresult (*GetMessage)(</xsl:text>
1802 <xsl:value-of select="$iface"/>
1803 <xsl:text> *pThis, PRUnichar * *aMessage);&#x0A;</xsl:text>
1804 <xsl:text> nsresult (*GetResult)(</xsl:text>
1805 <xsl:value-of select="$iface"/>
1806 <xsl:text> *pThis, nsresult *aResult);&#x0A;</xsl:text>
1807 <xsl:text> nsresult (*GetName)(</xsl:text>
1808 <xsl:value-of select="$iface"/>
1809 <xsl:text>*pThis, PRUnichar * *aName);&#x0A;</xsl:text>
1810 <xsl:text> nsresult (*GetFilename)(</xsl:text>
1811 <xsl:value-of select="$iface"/>
1812 <xsl:text> *pThis, PRUnichar * *aFilename);&#x0A;</xsl:text>
1813 <xsl:text> nsresult (*GetLineNumber)(</xsl:text>
1814 <xsl:value-of select="$iface"/>
1815 <xsl:text> *pThis, PRUint32 *aLineNumber);&#x0A;</xsl:text>
1816 <xsl:text> nsresult (*GetColumnNumber)(</xsl:text>
1817 <xsl:value-of select="$iface"/>
1818 <xsl:text> *pThis, PRUint32 *aColumnNumber);&#x0A;</xsl:text>
1819 <xsl:text> nsresult (*GetLocation)(</xsl:text>
1820 <xsl:value-of select="$iface"/>
1821 <xsl:text> *pThis, nsIStackFrame * *aLocation);&#x0A;</xsl:text>
1822 <xsl:text> nsresult (*GetInner)(</xsl:text>
1823 <xsl:value-of select="$iface"/>
1824 <xsl:text> *pThis, nsIException * *aInner);&#x0A;</xsl:text>
1825 <xsl:text> nsresult (*GetData)(</xsl:text>
1826 <xsl:value-of select="$iface"/>
1827 <xsl:text> *pThis, nsISupports * *aData);&#x0A;</xsl:text>
1828 <xsl:text> nsresult (*ToString)(</xsl:text>
1829 <xsl:value-of select="$iface"/>
1830 <xsl:text> *pThis, PRUnichar **_retval);&#x0A;</xsl:text>
1831 </xsl:when>
1832 <xsl:otherwise>
1833 <xsl:apply-templates select="key('G_keyInterfacesByName', $extends)" mode="vtab_flat">
1834 <xsl:with-param name="iface" select="$iface"/>
1835 </xsl:apply-templates>
1836 </xsl:otherwise>
1837 </xsl:choose>
1838 <!-- attributes (properties) -->
1839 <xsl:apply-templates select="attribute | if/attribute">
1840 <xsl:with-param name="iface" select="$iface"/>
1841 </xsl:apply-templates>
1842 <xsl:variable name="reservedAttributes" select="@reservedAttributes"/>
1843 <xsl:if test="$reservedAttributes > 0">
1844 <!-- tricky way to do a "for" loop without recursion -->
1845 <xsl:for-each select="(//*)[position() &lt;= $reservedAttributes]">
1846 <xsl:text> nsresult (*GetInternalAndReservedAttribute</xsl:text>
1847 <xsl:value-of select="concat(position(), $name)"/>
1848 <xsl:text>)(</xsl:text>
1849 <xsl:value-of select="$iface"/>
1850 <xsl:text> *pThis, PRUint32 *reserved);&#x0A;&#x0A;</xsl:text>
1851 </xsl:for-each>
1852 </xsl:if>
1853 <!-- methods -->
1854 <xsl:apply-templates select="method | if/method">
1855 <xsl:with-param name="iface" select="$iface"/>
1856 </xsl:apply-templates>
1857 <xsl:variable name="reservedMethods" select="@reservedMethods"/>
1858 <xsl:if test="$reservedMethods > 0">
1859 <!-- tricky way to do a "for" loop without recursion -->
1860 <xsl:for-each select="(//*)[position() &lt;= $reservedMethods]">
1861 <xsl:text> nsresult (*InternalAndReservedMethod</xsl:text>
1862 <xsl:value-of select="concat(position(), $name)"/>
1863 <xsl:text>)(</xsl:text>
1864 <xsl:value-of select="$iface"/>
1865 <xsl:text> *pThis);&#x0A;&#x0A;</xsl:text>
1866 </xsl:for-each>
1867 </xsl:if>
1868</xsl:template>
1869
1870
1871<!--
1872 * interfaces
1873-->
1874<xsl:template match="interface">
1875 <xsl:if test="not(@internal='yes')">
1876 <xsl:variable name="name" select="@name"/>
1877 <xsl:text>/* Start of struct </xsl:text>
1878 <xsl:value-of select="$name"/>
1879 <xsl:text> declaration */&#x0A;</xsl:text>
1880 <xsl:text>#define </xsl:text>
1881 <xsl:call-template name="string-to-upper">
1882 <xsl:with-param name="str" select="$name"/>
1883 </xsl:call-template>
1884 <xsl:value-of select="concat('_IID_STR &quot;',@uuid,'&quot;')"/>
1885 <xsl:text>&#x0A;</xsl:text>
1886 <xsl:text>#define </xsl:text>
1887 <xsl:call-template name="string-to-upper">
1888 <xsl:with-param name="str" select="$name"/>
1889 </xsl:call-template>
1890 <xsl:text>_IID { \&#x0A;</xsl:text>
1891 <xsl:text> 0x</xsl:text><xsl:value-of select="substring(@uuid,1,8)"/>
1892 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,10,4)"/>
1893 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,15,4)"/>
1894 <xsl:text>, \&#x0A; </xsl:text>
1895 <xsl:text>{ 0x</xsl:text><xsl:value-of select="substring(@uuid,20,2)"/>
1896 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,22,2)"/>
1897 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,25,2)"/>
1898 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,27,2)"/>
1899 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,29,2)"/>
1900 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,31,2)"/>
1901 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,33,2)"/>
1902 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,35,2)"/>
1903 <xsl:text> } \&#x0A;}&#x0A;</xsl:text>
1904 <xsl:text>/* COM compatibility */&#x0A;</xsl:text>
1905 <xsl:text>VBOX_EXTERN_CONST(nsIID, IID_</xsl:text>
1906 <xsl:value-of select="$name"/>
1907 <xsl:text>);&#x0A;</xsl:text>
1908 <xsl:text>#ifndef VBOX_WITH_GLUE&#x0A;</xsl:text>
1909 <xsl:text>struct </xsl:text>
1910 <xsl:value-of select="$name"/>
1911 <xsl:text>_vtbl&#x0A;{&#x0A;</xsl:text>
1912 <xsl:text> </xsl:text>
1913 <xsl:choose>
1914 <xsl:when test="@extends='$unknown'">struct nsISupports_vtbl nsisupports;</xsl:when>
1915 <xsl:when test="@extends='$errorinfo'">struct nsIException_vtbl nsiexception;</xsl:when>
1916 <xsl:otherwise>
1917 <xsl:text>struct </xsl:text>
1918 <xsl:value-of select="@extends"/>
1919 <xsl:text>_vtbl </xsl:text>
1920 <xsl:call-template name="string-to-lower">
1921 <xsl:with-param name="str" select="@extends"/>
1922 </xsl:call-template>
1923 <xsl:text>;</xsl:text>
1924 </xsl:otherwise>
1925 </xsl:choose>
1926 <xsl:text>&#x0A;&#x0A;</xsl:text>
1927 <!-- attributes (properties) -->
1928 <xsl:apply-templates select="attribute | if/attribute"/>
1929 <xsl:variable name="reservedAttributes" select="@reservedAttributes"/>
1930 <xsl:if test="$reservedAttributes > 0">
1931 <!-- tricky way to do a "for" loop without recursion -->
1932 <xsl:for-each select="(//*)[position() &lt;= $reservedAttributes]">
1933 <xsl:text> nsresult (*GetInternalAndReservedAttribute</xsl:text>
1934 <xsl:value-of select="concat(position(), $name)"/>
1935 <xsl:text>)(</xsl:text>
1936 <xsl:value-of select="$name"/>
1937 <xsl:text> *pThis, PRUint32 *reserved);&#x0A;&#x0A;</xsl:text>
1938 </xsl:for-each>
1939 </xsl:if>
1940 <!-- methods -->
1941 <xsl:apply-templates select="method | if/method"/>
1942 <xsl:variable name="reservedMethods" select="@reservedMethods"/>
1943 <xsl:if test="$reservedMethods > 0">
1944 <!-- tricky way to do a "for" loop without recursion -->
1945 <xsl:for-each select="(//*)[position() &lt;= $reservedMethods]">
1946 <xsl:text> nsresult (*InternalAndReservedMethod</xsl:text>
1947 <xsl:value-of select="concat(position(), $name)"/>
1948 <xsl:text>)(</xsl:text>
1949 <xsl:value-of select="$name"/>
1950 <xsl:text> *pThis);&#x0A;&#x0A;</xsl:text>
1951 </xsl:for-each>
1952 </xsl:if>
1953 <!-- -->
1954 <xsl:text>};&#x0A;</xsl:text>
1955 <xsl:text>#else /* VBOX_WITH_GLUE */&#x0A;</xsl:text>
1956 <xsl:text>struct </xsl:text>
1957 <xsl:value-of select="$name"/>
1958 <xsl:text>Vtbl&#x0A;{&#x0A;</xsl:text>
1959 <xsl:apply-templates select="." mode="vtab_flat">
1960 <xsl:with-param name="iface" select="$name"/>
1961 </xsl:apply-templates>
1962 <xsl:text>};&#x0A;</xsl:text>
1963 <xsl:apply-templates select="." mode="cobjmacro">
1964 <xsl:with-param name="iface" select="$name"/>
1965 </xsl:apply-templates>
1966 <!-- -->
1967 <xsl:text>#endif /* VBOX_WITH_GLUE */&#x0A;</xsl:text>
1968 <xsl:text>&#x0A;</xsl:text>
1969 <xsl:text>interface </xsl:text>
1970 <xsl:value-of select="$name"/>
1971 <xsl:text>&#x0A;{&#x0A;</xsl:text>
1972 <xsl:text>#ifndef VBOX_WITH_GLUE&#x0A;</xsl:text>
1973 <xsl:text> struct </xsl:text>
1974 <xsl:value-of select="$name"/>
1975 <xsl:text>_vtbl *vtbl;&#x0A;</xsl:text>
1976 <xsl:text>#else /* VBOX_WITH_GLUE */&#x0A;</xsl:text>
1977 <xsl:text> CONST_VTBL struct </xsl:text>
1978 <xsl:value-of select="$name"/>
1979 <xsl:text>Vtbl *lpVtbl;&#x0A;</xsl:text>
1980 <xsl:text>#endif /* VBOX_WITH_GLUE */&#x0A;</xsl:text>
1981 <xsl:text>};&#x0A;</xsl:text>
1982 <xsl:text>/* End of struct </xsl:text>
1983 <xsl:value-of select="$name"/>
1984 <xsl:text> declaration */&#x0A;&#x0A;</xsl:text>
1985 <xsl:call-template name="xsltprocNewlineOutputHack"/>
1986 </xsl:if>
1987</xsl:template>
1988
1989
1990<!--
1991 * attributes
1992-->
1993<xsl:template match="attribute">
1994 <xsl:param name="iface" select="ancestor::interface/@name"/>
1995
1996 <xsl:choose>
1997 <!-- safearray pseudo attribute -->
1998 <xsl:when test="@safearray='yes'">
1999 <!-- getter -->
2000 <xsl:text> nsresult (*Get</xsl:text>
2001 <xsl:call-template name="capitalize">
2002 <xsl:with-param name="str" select="@name"/>
2003 </xsl:call-template>
2004 <xsl:text>)(</xsl:text>
2005 <xsl:value-of select="$iface" />
2006 <xsl:text> *pThis, </xsl:text>
2007 <!-- array size -->
2008 <xsl:text>PRUint32 *</xsl:text>
2009 <xsl:value-of select="@name"/>
2010 <xsl:text>Size, </xsl:text>
2011 <!-- array pointer -->
2012 <xsl:apply-templates select="@type" mode="forwarder"/>
2013 <xsl:text> **</xsl:text>
2014 <xsl:value-of select="@name"/>
2015 <xsl:text>);&#x0A;</xsl:text>
2016 <!-- setter -->
2017 <xsl:if test="not(@readonly='yes')">
2018 <xsl:text> nsresult (*Set</xsl:text>
2019 <xsl:call-template name="capitalize">
2020 <xsl:with-param name="str" select="@name"/>
2021 </xsl:call-template>
2022 <xsl:text>)(</xsl:text>
2023 <xsl:value-of select="$iface" />
2024 <xsl:text> *pThis, </xsl:text>
2025 <!-- array size -->
2026 <xsl:text>PRUint32 </xsl:text>
2027 <xsl:value-of select="@name"/>
2028 <xsl:text>Size, </xsl:text>
2029 <!-- array pointer -->
2030 <xsl:apply-templates select="@type" mode="forwarder"/>
2031 <xsl:text> *</xsl:text>
2032 <xsl:value-of select="@name"/>
2033 <xsl:text>);&#x0A;</xsl:text>
2034 </xsl:if>
2035 </xsl:when>
2036 <!-- normal attribute -->
2037 <xsl:otherwise>
2038 <xsl:text> </xsl:text>
2039 <xsl:if test="@readonly='yes'">
2040 <xsl:text>nsresult (*Get</xsl:text>
2041 <xsl:call-template name="capitalize">
2042 <xsl:with-param name="str" select="@name"/>
2043 </xsl:call-template>
2044 <xsl:text>)(</xsl:text>
2045 <xsl:value-of select="$iface" />
2046 <xsl:text> *pThis, </xsl:text>
2047 <xsl:apply-templates select="@type" mode="forwarder"/>
2048 <xsl:text> *</xsl:text>
2049 <xsl:value-of select="@name"/>
2050 <xsl:text>);&#x0A;</xsl:text>
2051 </xsl:if>
2052 <xsl:choose>
2053 <xsl:when test="@readonly='yes'">
2054 </xsl:when>
2055 <xsl:otherwise>
2056 <xsl:text>nsresult (*Get</xsl:text>
2057 <xsl:call-template name="capitalize">
2058 <xsl:with-param name="str" select="@name"/>
2059 </xsl:call-template>
2060 <xsl:text>)(</xsl:text>
2061 <xsl:value-of select="$iface" />
2062 <xsl:text> *pThis, </xsl:text>
2063 <xsl:apply-templates select="@type" mode="forwarder"/>
2064 <xsl:text> *</xsl:text>
2065 <xsl:value-of select="@name"/>
2066 <xsl:text>);&#x0A; </xsl:text>
2067 <xsl:text>nsresult (*Set</xsl:text>
2068 <xsl:call-template name="capitalize">
2069 <xsl:with-param name="str" select="@name"/>
2070 </xsl:call-template>
2071 <xsl:text>)(</xsl:text>
2072 <xsl:value-of select="$iface" />
2073 <xsl:text> *pThis, </xsl:text>
2074 <xsl:apply-templates select="@type" mode="forwarder"/>
2075 <xsl:text> </xsl:text>
2076 <xsl:value-of select="@name"/>
2077 <xsl:text>);&#x0A;</xsl:text>
2078 </xsl:otherwise>
2079 </xsl:choose>
2080 </xsl:otherwise>
2081 </xsl:choose>
2082 <xsl:text>&#x0A;</xsl:text>
2083</xsl:template>
2084
2085<xsl:template match="attribute" mode="cobjmacro">
2086 <xsl:param name="iface"/>
2087
2088 <!-- getter (COM compatible) -->
2089 <xsl:text>#define </xsl:text>
2090 <xsl:value-of select="concat($iface, '_get_')"/>
2091 <xsl:call-template name="capitalize">
2092 <xsl:with-param name="str" select="@name"/>
2093 </xsl:call-template>
2094 <xsl:text>(p, a</xsl:text>
2095 <xsl:call-template name="capitalize">
2096 <xsl:with-param name="str" select="@name"/>
2097 </xsl:call-template>
2098 <xsl:text>) ((p)->lpVtbl->Get</xsl:text>
2099 <xsl:call-template name="capitalize">
2100 <xsl:with-param name="str" select="@name"/>
2101 </xsl:call-template>
2102 <xsl:text>(p, a</xsl:text>
2103 <xsl:call-template name="capitalize">
2104 <xsl:with-param name="str" select="@name"/>
2105 </xsl:call-template>
2106 <xsl:text>))&#x0A;</xsl:text>
2107
2108 <!-- getter (XPCOM compatible) -->
2109 <xsl:text>#define </xsl:text>
2110 <xsl:value-of select="concat($iface, '_Get')"/>
2111 <xsl:call-template name="capitalize">
2112 <xsl:with-param name="str" select="@name"/>
2113 </xsl:call-template>
2114 <xsl:text>(p, a</xsl:text>
2115 <xsl:call-template name="capitalize">
2116 <xsl:with-param name="str" select="@name"/>
2117 </xsl:call-template>
2118 <xsl:text>) ((p)->lpVtbl->Get</xsl:text>
2119 <xsl:call-template name="capitalize">
2120 <xsl:with-param name="str" select="@name"/>
2121 </xsl:call-template>
2122 <xsl:text>(p, a</xsl:text>
2123 <xsl:call-template name="capitalize">
2124 <xsl:with-param name="str" select="@name"/>
2125 </xsl:call-template>
2126 <xsl:text>))&#x0A;</xsl:text>
2127
2128 <xsl:if test="not(@readonly='yes')">
2129 <!-- setter (COM compatible) -->
2130 <xsl:text>#define </xsl:text>
2131 <xsl:value-of select="concat($iface, '_put_')"/>
2132 <xsl:call-template name="capitalize">
2133 <xsl:with-param name="str" select="@name"/>
2134 </xsl:call-template>
2135 <xsl:text>(p, a</xsl:text>
2136 <xsl:call-template name="capitalize">
2137 <xsl:with-param name="str" select="@name"/>
2138 </xsl:call-template>
2139 <xsl:text>) ((p)->lpVtbl->Set</xsl:text>
2140 <xsl:call-template name="capitalize">
2141 <xsl:with-param name="str" select="@name"/>
2142 </xsl:call-template>
2143 <xsl:text>(p, a</xsl:text>
2144 <xsl:call-template name="capitalize">
2145 <xsl:with-param name="str" select="@name"/>
2146 </xsl:call-template>
2147 <xsl:text>))&#x0A;</xsl:text>
2148
2149 <!-- setter (XPCOM compatible) -->
2150 <xsl:text>#define </xsl:text>
2151 <xsl:value-of select="concat($iface, '_Set')"/>
2152 <xsl:call-template name="capitalize">
2153 <xsl:with-param name="str" select="@name"/>
2154 </xsl:call-template>
2155 <xsl:text>(p, a</xsl:text>
2156 <xsl:call-template name="capitalize">
2157 <xsl:with-param name="str" select="@name"/>
2158 </xsl:call-template>
2159 <xsl:text>) ((p)->lpVtbl->Set</xsl:text>
2160 <xsl:call-template name="capitalize">
2161 <xsl:with-param name="str" select="@name"/>
2162 </xsl:call-template>
2163 <xsl:text>(p, a</xsl:text>
2164 <xsl:call-template name="capitalize">
2165 <xsl:with-param name="str" select="@name"/>
2166 </xsl:call-template>
2167 <xsl:text>))&#x0A;</xsl:text>
2168
2169 </xsl:if>
2170</xsl:template>
2171
2172<!--
2173 * methods
2174-->
2175<xsl:template match="method">
2176 <xsl:param name="iface" select="ancestor::interface/@name"/>
2177
2178 <xsl:if test="param/@mod='ptr'">
2179 <!-- methods using native types must be non-scriptable
2180 <xsl:text> [noscript]&#x0A;</xsl:text>-->
2181 </xsl:if>
2182 <xsl:text> nsresult (*</xsl:text>
2183 <xsl:call-template name="capitalize">
2184 <xsl:with-param name="str" select="@name"/>
2185 </xsl:call-template>
2186 <xsl:if test="param">
2187 <xsl:text>)(&#x0A;</xsl:text>
2188 <xsl:text> </xsl:text>
2189 <xsl:value-of select="$iface" />
2190 <xsl:text> *pThis,&#x0A;</xsl:text>
2191 <xsl:for-each select="param [position() != last()]">
2192 <xsl:text> </xsl:text>
2193 <xsl:apply-templates select="."/>
2194 <xsl:text>,&#x0A;</xsl:text>
2195 </xsl:for-each>
2196 <xsl:text> </xsl:text>
2197 <xsl:apply-templates select="param [last()]"/>
2198 <xsl:text>&#x0A; );&#x0A;</xsl:text>
2199 </xsl:if>
2200 <xsl:if test="not(param)">
2201 <xsl:text>)(</xsl:text>
2202 <xsl:value-of select="$iface" />
2203 <xsl:text> *pThis );&#x0A;</xsl:text>
2204 </xsl:if>
2205 <xsl:text>&#x0A;</xsl:text>
2206</xsl:template>
2207
2208<xsl:template match="method" mode="cobjmacro">
2209 <xsl:param name="iface"/>
2210
2211 <xsl:text>#define </xsl:text>
2212 <xsl:value-of select="concat($iface, '_')"/>
2213 <xsl:call-template name="capitalize">
2214 <xsl:with-param name="str" select="@name"/>
2215 </xsl:call-template>
2216 <xsl:text>(p</xsl:text>
2217 <xsl:for-each select="param">
2218 <xsl:text>, a</xsl:text>
2219 <xsl:call-template name="capitalize">
2220 <xsl:with-param name="str" select="@name"/>
2221 </xsl:call-template>
2222 </xsl:for-each>
2223 <xsl:text>) ((p)->lpVtbl-></xsl:text>
2224 <xsl:call-template name="capitalize">
2225 <xsl:with-param name="str" select="@name"/>
2226 </xsl:call-template>
2227 <xsl:text>(p</xsl:text>
2228 <xsl:for-each select="param">
2229 <xsl:text>, a</xsl:text>
2230 <xsl:call-template name="capitalize">
2231 <xsl:with-param name="str" select="@name"/>
2232 </xsl:call-template>
2233 </xsl:for-each>
2234 <xsl:text>))&#x0A;</xsl:text>
2235</xsl:template>
2236
2237
2238<!--
2239 * modules
2240-->
2241<xsl:template match="module">
2242 <xsl:apply-templates select="class"/>
2243</xsl:template>
2244
2245
2246<!--
2247 * co-classes
2248-->
2249<xsl:template match="module/class">
2250 <!-- class and contract id -->
2251 <xsl:text>&#x0A;</xsl:text>
2252 <xsl:text>#define NS_</xsl:text>
2253 <xsl:call-template name="string-to-upper">
2254 <xsl:with-param name="str" select="@name"/>
2255 </xsl:call-template>
2256 <xsl:text>_CID { \&#x0A;</xsl:text>
2257 <xsl:text> 0x</xsl:text><xsl:value-of select="substring(@uuid,1,8)"/>
2258 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,10,4)"/>
2259 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,15,4)"/>
2260 <xsl:text>, \&#x0A; </xsl:text>
2261 <xsl:text>{ 0x</xsl:text><xsl:value-of select="substring(@uuid,20,2)"/>
2262 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,22,2)"/>
2263 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,25,2)"/>
2264 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,27,2)"/>
2265 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,29,2)"/>
2266 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,31,2)"/>
2267 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,33,2)"/>
2268 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,35,2)"/>
2269 <xsl:text> } \&#x0A;}&#x0A;</xsl:text>
2270 <xsl:text>#define NS_</xsl:text>
2271 <xsl:call-template name="string-to-upper">
2272 <xsl:with-param name="str" select="@name"/>
2273 </xsl:call-template>
2274 <!-- Contract ID -->
2275 <xsl:text>_CONTRACTID &quot;@</xsl:text>
2276 <xsl:value-of select="@namespace"/>
2277 <xsl:text>/</xsl:text>
2278 <xsl:value-of select="@name"/>
2279 <xsl:text>;1&quot;&#x0A;</xsl:text>
2280 <!-- CLSID_xxx declarations for XPCOM, for compatibility with Win32 -->
2281 <xsl:text>/* COM compatibility */&#x0A;</xsl:text>
2282 <xsl:text>VBOX_EXTERN_CONST(nsCID, CLSID_</xsl:text>
2283 <xsl:value-of select="@name"/>
2284 <xsl:text>);&#x0A;</xsl:text>
2285 <xsl:text>&#x0A;&#x0A;</xsl:text>
2286</xsl:template>
2287
2288
2289<!--
2290 * enums
2291-->
2292<xsl:template match="enum">
2293 <xsl:text>/* Start of enum </xsl:text>
2294 <xsl:value-of select="@name"/>
2295 <xsl:text> declaration */&#x0A;</xsl:text>
2296 <xsl:text>#define </xsl:text>
2297 <xsl:call-template name="string-to-upper">
2298 <xsl:with-param name="str" select="@name"/>
2299 </xsl:call-template>
2300 <xsl:value-of select="concat('_IID_STR &quot;',@uuid,'&quot;')"/>
2301 <xsl:text>&#x0A;</xsl:text>
2302 <xsl:text>#define </xsl:text>
2303 <xsl:call-template name="string-to-upper">
2304 <xsl:with-param name="str" select="@name"/>
2305 </xsl:call-template>
2306 <xsl:text>_IID { \&#x0A;</xsl:text>
2307 <xsl:text> 0x</xsl:text><xsl:value-of select="substring(@uuid,1,8)"/>
2308 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,10,4)"/>
2309 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,15,4)"/>
2310 <xsl:text>, \&#x0A; </xsl:text>
2311 <xsl:text>{ 0x</xsl:text><xsl:value-of select="substring(@uuid,20,2)"/>
2312 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,22,2)"/>
2313 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,25,2)"/>
2314 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,27,2)"/>
2315 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,29,2)"/>
2316 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,31,2)"/>
2317 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,33,2)"/>
2318 <xsl:text>, 0x</xsl:text><xsl:value-of select="substring(@uuid,35,2)"/>
2319 <xsl:text> } \&#x0A;}&#x0A;</xsl:text>
2320 <xsl:text>typedef enum </xsl:text>
2321 <xsl:value-of select="@name"/>
2322 <xsl:text>&#x0A;{&#x0A;</xsl:text>
2323 <xsl:variable name="this" select="."/>
2324 <xsl:for-each select="const">
2325 <xsl:text> </xsl:text>
2326 <xsl:value-of select="$this/@name"/>
2327 <xsl:text>_</xsl:text>
2328 <xsl:value-of select="@name"/> = <xsl:value-of select="@value"/>
2329 <xsl:if test="position() != last()">
2330 <xsl:text>,</xsl:text>
2331 </xsl:if>
2332 <xsl:text>&#x0A;</xsl:text>
2333 </xsl:for-each>
2334 <xsl:text>} </xsl:text>
2335 <xsl:value-of select="@name"/>
2336 <xsl:text>;&#x0A;</xsl:text>
2337 <xsl:text>/* End of enum </xsl:text>
2338 <xsl:value-of select="@name"/>
2339 <xsl:text> declaration */
2340#define </xsl:text>
2341 <xsl:value-of select="concat(@name, '_T PRUint32&#x0A;&#x0A;&#x0A;')"/>
2342</xsl:template>
2343
2344
2345<!--
2346 * method parameters
2347-->
2348<xsl:template match="method/param">
2349 <xsl:choose>
2350 <!-- safearray parameters -->
2351 <xsl:when test="@safearray='yes'">
2352 <!-- array size -->
2353 <xsl:choose>
2354 <xsl:when test="@dir='in'">
2355 <xsl:text>PRUint32 </xsl:text>
2356 <xsl:value-of select="@name"/>
2357 <xsl:text>Size,&#x0A;</xsl:text>
2358 </xsl:when>
2359 <xsl:when test="@dir='out'">
2360 <xsl:text>PRUint32 *</xsl:text>
2361 <xsl:value-of select="@name"/>
2362 <xsl:text>Size,&#x0A;</xsl:text>
2363 </xsl:when>
2364 <xsl:when test="@dir='return'">
2365 <xsl:text>PRUint32 *</xsl:text>
2366 <xsl:value-of select="@name"/>
2367 <xsl:text>Size,&#x0A;</xsl:text>
2368 </xsl:when>
2369 <xsl:otherwise>
2370 <xsl:text>PRUint32 </xsl:text>
2371 <xsl:value-of select="@name"/>
2372 <xsl:text>Size,&#x0A;</xsl:text>
2373 </xsl:otherwise>
2374 </xsl:choose>
2375 <!-- array pointer -->
2376 <xsl:text> </xsl:text>
2377 <xsl:choose>
2378 <xsl:when test="@dir='in'">
2379 <xsl:apply-templates select="@type" mode="forwarder"/>
2380 <xsl:text>*</xsl:text>
2381 </xsl:when>
2382 <xsl:when test="@dir='out'">
2383 <xsl:apply-templates select="@type" mode="forwarder"/>
2384 <xsl:text>**</xsl:text>
2385 </xsl:when>
2386 <xsl:when test="@dir='return'">
2387 <xsl:apply-templates select="@type" mode="forwarder"/>
2388 <xsl:text>**</xsl:text>
2389 </xsl:when>
2390 <xsl:otherwise>
2391 <xsl:apply-templates select="@type" mode="forwarder"/>
2392 <xsl:text>*</xsl:text>
2393 </xsl:otherwise>
2394 </xsl:choose>
2395 <xsl:text> </xsl:text>
2396 <xsl:value-of select="@name"/>
2397 </xsl:when>
2398 <!-- normal and array parameters -->
2399 <xsl:otherwise>
2400 <xsl:choose>
2401 <xsl:when test="@dir='in'">
2402 <xsl:apply-templates select="@type" mode="forwarder"/>
2403 <xsl:text></xsl:text>
2404 </xsl:when>
2405 <xsl:when test="@dir='out'">
2406 <xsl:apply-templates select="@type" mode="forwarder"/>
2407 <xsl:text> *</xsl:text>
2408 </xsl:when>
2409 <xsl:when test="@dir='return'">
2410 <xsl:apply-templates select="@type" mode="forwarder"/>
2411 <xsl:text> *</xsl:text>
2412 </xsl:when>
2413 <xsl:otherwise>
2414 <xsl:apply-templates select="@type" mode="forwarder"/>
2415 <xsl:text></xsl:text>
2416 </xsl:otherwise>
2417 </xsl:choose>
2418 <xsl:text> </xsl:text>
2419 <xsl:value-of select="@name"/>
2420 </xsl:otherwise>
2421 </xsl:choose>
2422</xsl:template>
2423
2424<xsl:template match="method/param" mode="forwarder">
2425 <xsl:if test="@safearray='yes'">
2426 <xsl:text>PRUint32</xsl:text>
2427 <xsl:if test="@dir='out' or @dir='return'">
2428 <xsl:text> *</xsl:text>
2429 </xsl:if>
2430 <xsl:text> a</xsl:text>
2431 <xsl:call-template name="capitalize">
2432 <xsl:with-param name="str" select="@name"/>
2433 </xsl:call-template>
2434 <xsl:text>Size, </xsl:text>
2435 </xsl:if>
2436 <xsl:apply-templates select="@type" mode="forwarder"/>
2437 <xsl:if test="@dir='out' or @dir='return'">
2438 <xsl:text> *</xsl:text>
2439 </xsl:if>
2440 <xsl:if test="@safearray='yes'">
2441 <xsl:text> *</xsl:text>
2442 </xsl:if>
2443 <xsl:text> a</xsl:text>
2444 <xsl:call-template name="capitalize">
2445 <xsl:with-param name="str" select="@name"/>
2446 </xsl:call-template>
2447</xsl:template>
2448
2449
2450<!--
2451 * attribute/parameter type conversion
2452-->
2453<xsl:template match="attribute/@type | param/@type">
2454 <xsl:variable name="self_target" select="current()/ancestor::if/@target"/>
2455
2456 <xsl:choose>
2457 <!-- modifiers (ignored for 'enumeration' attributes)-->
2458 <xsl:when test="name(current())='type' and ../@mod">
2459 <xsl:choose>
2460 <xsl:when test="../@mod='ptr'">
2461 <xsl:choose>
2462 <!-- standard types -->
2463 <!--xsl:when test=".='result'">??</xsl:when-->
2464 <xsl:when test=".='boolean'">booleanPtr</xsl:when>
2465 <xsl:when test=".='octet'">octetPtr</xsl:when>
2466 <xsl:when test=".='short'">shortPtr</xsl:when>
2467 <xsl:when test=".='unsigned short'">ushortPtr</xsl:when>
2468 <xsl:when test=".='long'">longPtr</xsl:when>
2469 <xsl:when test=".='long long'">llongPtr</xsl:when>
2470 <xsl:when test=".='unsigned long'">ulongPtr</xsl:when>
2471 <xsl:when test=".='unsigned long long'">ullongPtr</xsl:when>
2472 <xsl:otherwise>
2473 <xsl:message terminate="yes">
2474 <xsl:value-of select="concat(../../../@name,'::',../../@name,'::',../@name,': ')"/>
2475 <xsl:text>attribute 'mod=</xsl:text>
2476 <xsl:value-of select="concat('&quot;',../@mod,'&quot;')"/>
2477 <xsl:text>' cannot be used with type </xsl:text>
2478 <xsl:value-of select="concat('&quot;',current(),'&quot;!')"/>
2479 </xsl:message>
2480 </xsl:otherwise>
2481 </xsl:choose>
2482 </xsl:when>
2483 <xsl:when test="../@mod='string'">
2484 <xsl:choose>
2485 <!-- standard types -->
2486 <!--xsl:when test=".='result'">??</xsl:when-->
2487 <xsl:when test=".='uuid'">wstring</xsl:when>
2488 <xsl:otherwise>
2489 <xsl:message terminate="yes">
2490 <xsl:value-of select="concat(../../../@name,'::',../../@name,'::',../@name,': ')"/>
2491 <xsl:text>attribute 'mod=</xsl:text>
2492 <xsl:value-of select="concat('&quot;',../@mod,'&quot;')"/>
2493 <xsl:text>' cannot be used with type </xsl:text>
2494 <xsl:value-of select="concat('&quot;',current(),'&quot;!')"/>
2495 </xsl:message>
2496 </xsl:otherwise>
2497 </xsl:choose>
2498 </xsl:when>
2499 <xsl:otherwise>
2500 <xsl:message terminate="yes">
2501 <xsl:value-of select="concat(../../../@name,'::',../../@name,'::',../@name,': ')"/>
2502 <xsl:value-of select="concat('value &quot;',../@mod,'&quot; ')"/>
2503 <xsl:text>of attribute 'mod' is invalid!</xsl:text>
2504 </xsl:message>
2505 </xsl:otherwise>
2506 </xsl:choose>
2507 </xsl:when>
2508 <!-- no modifiers -->
2509 <xsl:otherwise>
2510 <xsl:choose>
2511 <!-- standard types -->
2512 <xsl:when test=".='result'">nsresult</xsl:when>
2513 <xsl:when test=".='boolean'">boolean</xsl:when>
2514 <xsl:when test=".='octet'">octet</xsl:when>
2515 <xsl:when test=".='short'">short</xsl:when>
2516 <xsl:when test=".='unsigned short'">unsigned short</xsl:when>
2517 <xsl:when test=".='long'">long</xsl:when>
2518 <xsl:when test=".='long long'">long long</xsl:when>
2519 <xsl:when test=".='unsigned long'">unsigned long</xsl:when>
2520 <xsl:when test=".='unsigned long long'">unsigned long long</xsl:when>
2521 <xsl:when test=".='char'">char</xsl:when>
2522 <xsl:when test=".='wchar'">wchar</xsl:when>
2523 <xsl:when test=".='string'">string</xsl:when>
2524 <xsl:when test=".='wstring'">wstring</xsl:when>
2525 <!-- UUID type -->
2526 <xsl:when test=".='uuid'">
2527 <xsl:choose>
2528 <xsl:when test="name(..)='attribute'">
2529 <xsl:choose>
2530 <xsl:when test="../@readonly='yes'">
2531 <xsl:text>nsIDPtr</xsl:text>
2532 </xsl:when>
2533 <xsl:otherwise>
2534 <xsl:message terminate="yes">
2535 <xsl:value-of select="../@name"/>
2536 <xsl:text>: Non-readonly uuid attributes are not supported!</xsl:text>
2537 </xsl:message>
2538 </xsl:otherwise>
2539 </xsl:choose>
2540 </xsl:when>
2541 <xsl:when test="name(..)='param'">
2542 <xsl:choose>
2543 <xsl:when test="../@dir='in' and not(../@safearray='yes')">
2544 <xsl:text>nsIDRef</xsl:text>
2545 </xsl:when>
2546 <xsl:otherwise>
2547 <xsl:text>nsIDPtr</xsl:text>
2548 </xsl:otherwise>
2549 </xsl:choose>
2550 </xsl:when>
2551 </xsl:choose>
2552 </xsl:when>
2553 <!-- system interface types -->
2554 <xsl:when test=".='$unknown'">nsISupports</xsl:when>
2555 <xsl:otherwise>
2556 <xsl:choose>
2557 <!-- enum types -->
2558 <xsl:when test="
2559 (ancestor::library/enum[@name=current()]) or
2560 (ancestor::library/if[@target=$self_target]/enum[@name=current()])
2561 ">
2562 <xsl:text>PRUint32</xsl:text>
2563 </xsl:when>
2564 <!-- custom interface types -->
2565 <xsl:when test="
2566 (name(current())='enumerator' and
2567 ((ancestor::library/enumerator[@name=current()]) or
2568 (ancestor::library/if[@target=$self_target]/enumerator[@name=current()]))
2569 ) or
2570 ((ancestor::library/interface[@name=current()]) or
2571 (ancestor::library/if[@target=$self_target]/interface[@name=current()])
2572 )
2573 ">
2574 <xsl:value-of select="."/>
2575 </xsl:when>
2576 <!-- other types -->
2577 <xsl:otherwise>
2578 <xsl:message terminate="yes">
2579 <xsl:text>Unknown parameter type: </xsl:text>
2580 <xsl:value-of select="."/>
2581 </xsl:message>
2582 </xsl:otherwise>
2583 </xsl:choose>
2584 </xsl:otherwise>
2585 </xsl:choose>
2586 </xsl:otherwise>
2587 </xsl:choose>
2588</xsl:template>
2589
2590<xsl:template match="attribute/@type | param/@type" mode="forwarder">
2591
2592 <xsl:variable name="self_target" select="current()/ancestor::if/@target"/>
2593
2594 <xsl:choose>
2595 <!-- modifiers (ignored for 'enumeration' attributes)-->
2596 <xsl:when test="name(current())='type' and ../@mod">
2597 <xsl:choose>
2598 <xsl:when test="../@mod='ptr'">
2599 <xsl:choose>
2600 <!-- standard types -->
2601 <!--xsl:when test=".='result'">??</xsl:when-->
2602 <xsl:when test=".='boolean'">PRBool *</xsl:when>
2603 <xsl:when test=".='octet'">PRUint8 *</xsl:when>
2604 <xsl:when test=".='short'">PRInt16 *</xsl:when>
2605 <xsl:when test=".='unsigned short'">PRUint16 *</xsl:when>
2606 <xsl:when test=".='long'">PRInt32 *</xsl:when>
2607 <xsl:when test=".='long long'">PRInt64 *</xsl:when>
2608 <xsl:when test=".='unsigned long'">PRUint32 *</xsl:when>
2609 <xsl:when test=".='unsigned long long'">PRUint64 *</xsl:when>
2610 <xsl:otherwise>
2611 <xsl:message terminate="yes">
2612 <xsl:value-of select="concat(../../../@name,'::',../../@name,'::',../@name,': ')"/>
2613 <xsl:text>attribute 'mod=</xsl:text>
2614 <xsl:value-of select="concat('&quot;',../@mod,'&quot;')"/>
2615 <xsl:text>' cannot be used with type </xsl:text>
2616 <xsl:value-of select="concat('&quot;',current(),'&quot;!')"/>
2617 </xsl:message>
2618 </xsl:otherwise>
2619 </xsl:choose>
2620 </xsl:when>
2621 <xsl:when test="../@mod='string'">
2622 <xsl:choose>
2623 <!-- standard types -->
2624 <!--xsl:when test=".='result'">??</xsl:when-->
2625 <xsl:when test=".='uuid'">PRUnichar *</xsl:when>
2626 <xsl:otherwise>
2627 <xsl:message terminate="yes">
2628 <xsl:value-of select="concat(../../../@name,'::',../../@name,'::',../@name,': ')"/>
2629 <xsl:text>attribute 'mod=</xsl:text>
2630 <xsl:value-of select="concat('&quot;',../@mod,'&quot;')"/>
2631 <xsl:text>' cannot be used with type </xsl:text>
2632 <xsl:value-of select="concat('&quot;',current(),'&quot;!')"/>
2633 </xsl:message>
2634 </xsl:otherwise>
2635 </xsl:choose>
2636 </xsl:when>
2637 </xsl:choose>
2638 </xsl:when>
2639 <!-- no modifiers -->
2640 <xsl:otherwise>
2641 <xsl:choose>
2642 <!-- standard types -->
2643 <xsl:when test=".='result'">nsresult</xsl:when>
2644 <xsl:when test=".='boolean'">PRBool</xsl:when>
2645 <xsl:when test=".='octet'">PRUint8</xsl:when>
2646 <xsl:when test=".='short'">PRInt16</xsl:when>
2647 <xsl:when test=".='unsigned short'">PRUint16</xsl:when>
2648 <xsl:when test=".='long'">PRInt32</xsl:when>
2649 <xsl:when test=".='long long'">PRInt64</xsl:when>
2650 <xsl:when test=".='unsigned long'">PRUint32</xsl:when>
2651 <xsl:when test=".='unsigned long long'">PRUint64</xsl:when>
2652 <xsl:when test=".='char'">char</xsl:when>
2653 <xsl:when test=".='wchar'">PRUnichar</xsl:when>
2654 <!-- string types -->
2655 <xsl:when test=".='string'">char *</xsl:when>
2656 <xsl:when test=".='wstring'">PRUnichar *</xsl:when>
2657 <!-- UUID type -->
2658 <xsl:when test=".='uuid'">
2659 <xsl:choose>
2660 <xsl:when test="name(..)='attribute'">
2661 <xsl:choose>
2662 <xsl:when test="../@readonly='yes'">
2663 <xsl:text>nsID *</xsl:text>
2664 </xsl:when>
2665 </xsl:choose>
2666 </xsl:when>
2667 <xsl:when test="name(..)='param'">
2668 <xsl:choose>
2669 <xsl:when test="../@dir='in' and not(../@safearray='yes')">
2670 <xsl:text>const nsID *</xsl:text>
2671 </xsl:when>
2672 <xsl:otherwise>
2673 <xsl:text>nsID *</xsl:text>
2674 </xsl:otherwise>
2675 </xsl:choose>
2676 </xsl:when>
2677 </xsl:choose>
2678 </xsl:when>
2679 <!-- system interface types -->
2680 <xsl:when test=".='$unknown'">nsISupports *</xsl:when>
2681 <xsl:otherwise>
2682 <xsl:choose>
2683 <!-- enum types -->
2684 <xsl:when test="
2685 (ancestor::library/enum[@name=current()]) or
2686 (ancestor::library/if[@target=$self_target]/enum[@name=current()])
2687 ">
2688 <xsl:text>PRUint32</xsl:text>
2689 </xsl:when>
2690 <!-- custom interface types -->
2691 <xsl:when test="
2692 (name(current())='enumerator' and
2693 ((ancestor::library/enumerator[@name=current()]) or
2694 (ancestor::library/if[@target=$self_target]/enumerator[@name=current()]))
2695 ) or
2696 ((ancestor::library/interface[@name=current()]) or
2697 (ancestor::library/if[@target=$self_target]/interface[@name=current()])
2698 )
2699 ">
2700 <xsl:value-of select="."/>
2701 <xsl:text> *</xsl:text>
2702 </xsl:when>
2703 <!-- other types -->
2704 </xsl:choose>
2705 </xsl:otherwise>
2706 </xsl:choose>
2707 </xsl:otherwise>
2708 </xsl:choose>
2709</xsl:template>
2710
2711</xsl:stylesheet>
2712
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