VirtualBox

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

Last change on this file since 86692 was 85121, checked in by vboxsync, 4 years ago

iprt/cdefs.h: Refactored the typedef use of DECLCALLBACK as well as DECLCALLBACKMEMBER to wrap the whole expression, similar to the DECLR?CALLBACKMEMBER macros. This allows adding a throw() at the end when compiling with the VC++ compiler to indicate that the callbacks won't throw anything, so we can stop supressing the C5039 warning about passing functions that can potential throw C++ exceptions to extern C code that can't necessarily cope with such (unwind,++). Introduced a few _EX variations that allows specifying different/no calling convention too, as that's handy when dynamically resolving host APIs. Fixed numerous places missing DECLCALLBACK and such. Left two angry @todos regarding use of CreateThread. bugref:9794

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

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