defs.h@ 28197

Last change on this file since 28197 was 27782, checked in by vboxsync, 15 years ago
typo
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 22.9 KB

Line
1	/** @file
2	* MS COM / XPCOM Abstraction Layer:
3	* Common definitions
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 Sun Microsystems, Inc.
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*
26	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27	* Clara, CA 95054 USA or visit http://www.sun.com if you need
28	* additional information or have any questions.
29	*/
30
31	#ifndef ___VBox_com_defs_h
32	#define ___VBox_com_defs_h
33
34	/* Make sure all the stdint.h macros are included - must come first! */
35	#ifndef __STDC_LIMIT_MACROS
36	# define __STDC_LIMIT_MACROS
37	#endif
38	#ifndef __STDC_CONSTANT_MACROS
39	# define __STDC_CONSTANT_MACROS
40	#endif
41
42	#if defined (RT_OS_OS2)
43
44	#if defined(RT_MAX) && RT_MAX != 22
45	# error RT_MAX already defined by <iprt/cdefs.h>! Make sure <VBox/com/defs.h> \
46	is included before it.
47	#endif
48
49	/* Make sure OS/2 Toolkit headers are pulled in to have BOOL/ULONG/etc. typedefs
50	* already defined in order to be able to redefine them using #define. It's
51	* also important to do it before iprt/cdefs.h, otherwise we'll lose RT_MAX in
52	* all code that uses COM Glue. */
53	#define INCL_BASE
54	#define INCL_PM
55	#include <os2.h>
56
57	/* OS/2 Toolkit defines TRUE and FALSE */
58	#undef FALSE
59	#undef TRUE
60
61	#endif /* defined (RT_OS_OS2) */
62
63	/* Include iprt/types.h (which also includes iprt/types.h) now to make sure iprt
64	* gets to stdint.h first, otherwise a system/xpcom header might beat us and
65	* we'll be without the macros that are optional in C++. */
66	#include <iprt/types.h>
67
68	#if !defined (VBOX_WITH_XPCOM)
69
70	#if defined (RT_OS_WINDOWS)
71
72	// Windows COM
73	/////////////////////////////////////////////////////////////////////////////
74
75	#include <objbase.h>
76	#ifndef VBOX_COM_NO_ATL
77	# include <atlbase.h>
78	#include <atlcom.h>
79	#endif
80
81	#define NS_DECL_ISUPPORTS
82	#define NS_IMPL_ISUPPORTS1_CI(a, b)
83
84	/* these are XPCOM only, one for every interface implemented */
85	#define NS_DECL_ISUPPORTS
86
87	/** Returns @c true if @a rc represents a warning result code */
88	#define SUCCEEDED_WARNING(rc) (SUCCEEDED (rc) && (rc) != S_OK)
89
90	/** Immutable BSTR string */
91	typedef const OLECHAR *CBSTR;
92
93	/** Input BSTR argument of interface method declaration. */
94	#define IN_BSTR BSTR
95
96	/** Input GUID argument of interface method declaration. */
97	#define IN_GUID GUID
98	/** Output GUID argument of interface method declaration. */
99	#define OUT_GUID GUID*
100
101	/** Makes the name of the getter interface function (n must be capitalized). */
102	#define COMGETTER(n) get_##n
103	/** Makes the name of the setter interface function (n must be capitalized). */
104	#define COMSETTER(n) put_##n
105
106	/**
107	* Declares an input safearray parameter in the COM method implementation. Also
108	* used to declare the COM attribute setter parameter. Corresponds to either of
109	* the following XIDL definitions:
110	* <pre>
111	* <param name="arg" ... dir="in" safearray="yes"/>
112	* ...
113	* <attribute name="arg" ... safearray="yes"/>
114	* </pre>
115	*
116	* The method implementation should use the com::SafeArray helper class to work
117	* with parameters declared using this define.
118	*
119	* @param aType Array element type.
120	* @param aArg Parameter/attribute name.
121	*/
122	#define ComSafeArrayIn(aType, aArg) SAFEARRAY **aArg
123
124	/**
125	* Expands to @true if the given input safearray parameter is a "null pointer"
126	* which makes it impossible to use it for reading safearray data.
127	*/
128	#define ComSafeArrayInIsNull(aArg) ((aArg) == NULL \|\| *(aArg) == NULL)
129
130	/**
131	* Wraps the given parameter name to generate an expression that is suitable for
132	* passing the parameter to functions that take input safearray parameters
133	* declared using the ComSafeArrayIn marco.
134	*
135	* @param aArg Parameter name to wrap. The given parameter must be declared
136	* within the calling function using the ComSafeArrayIn macro.
137	*/
138	#define ComSafeArrayInArg(aArg) aArg
139
140	/**
141	* Declares an output safearray parameter in the COM method implementation. Also
142	* used to declare the COM attribute getter parameter. Corresponds to either of
143	* the following XIDL definitions:
144	* <pre>
145	* <param name="arg" ... dir="out" safearray="yes"/>
146	* <param name="arg" ... dir="return" safearray="yes"/>
147	* ...
148	* <attribute name="arg" ... safearray="yes"/>
149	* </pre>
150	*
151	* The method implementation should use the com::SafeArray helper class to work
152	* with parameters declared using this define.
153	*
154	* @param aType Array element type.
155	* @param aArg Parameter/attribute name.
156	*/
157	#define ComSafeArrayOut(aType, aArg) SAFEARRAY **aArg
158
159	/**
160	* Expands to @true if the given output safearray parameter is a "null pointer"
161	* which makes it impossible to use it for returning a safearray.
162	*/
163	#define ComSafeArrayOutIsNull(aArg) ((aArg) == NULL)
164
165	/**
166	* Wraps the given parameter name to generate an expression that is suitable for
167	* passing the parameter to functions that take output safearray parameters
168	* declared using the ComSafeArrayOut marco.
169	*
170	* @param aArg Parameter name to wrap. The given parameter must be declared
171	* within the calling function using the ComSafeArrayOut macro.
172	*/
173	#define ComSafeArrayOutArg(aArg) aArg
174
175	/**
176	* Version of ComSafeArrayIn for GUID.
177	* @param aArg Parameter name to wrap.
178	*/
179	#define ComSafeGUIDArrayIn(aArg) SAFEARRAY **aArg
180
181	/**
182	* Version of ComSafeArrayInIsNull for GUID.
183	* @param aArg Parameter name to wrap.
184	*/
185	#define ComSafeGUIDArrayInIsNull(aArg) ComSafeArrayInIsNull (aArg)
186
187	/**
188	* Version of ComSafeArrayInArg for GUID.
189	* @param aArg Parameter name to wrap.
190	*/
191	#define ComSafeGUIDArrayInArg(aArg) ComSafeArrayInArg (aArg)
192
193	/**
194	* Version of ComSafeArrayOut for GUID.
195	* @param aArg Parameter name to wrap.
196	*/
197	#define ComSafeGUIDArrayOut(aArg) SAFEARRAY **aArg
198
199	/**
200	* Version of ComSafeArrayOutIsNull for GUID.
201	* @param aArg Parameter name to wrap.
202	*/
203	#define ComSafeGUIDArrayOutIsNull(aArg) ComSafeArrayOutIsNull (aArg)
204
205	/**
206	* Version of ComSafeArrayOutArg for GUID.
207	* @param aArg Parameter name to wrap.
208	*/
209	#define ComSafeGUIDArrayOutArg(aArg) ComSafeArrayOutArg (aArg)
210
211	/**
212	* Returns the const reference to the IID (i.e., \|const GUID &\|) of the given
213	* interface.
214	*
215	* @param i interface class
216	*/
217	#define COM_IIDOF(I) _ATL_IIDOF (I)
218
219	#else /* defined (RT_OS_WINDOWS) */
220
221	#error "VBOX_WITH_XPCOM must be defined on a platform other than Windows!"
222
223	#endif /* defined (RT_OS_WINDOWS) */
224
225	#else /* !defined (VBOX_WITH_XPCOM) */
226
227	// XPCOM
228	/////////////////////////////////////////////////////////////////////////////
229
230	#if defined (RT_OS_DARWIN) \|\| (defined (QT_VERSION) && (QT_VERSION >= 0x040000))
231	/* CFBase.h defines these &
232	* qglobal.h from Qt4 defines these */
233	# undef FALSE
234	# undef TRUE
235	#endif /* RT_OS_DARWIN \|\| QT_VERSION */
236
237	#include <nsID.h>
238
239	#define ATL_NO_VTABLE
240	#define DECLARE_CLASSFACTORY(a)
241	#define DECLARE_CLASSFACTORY_SINGLETON(a)
242	#define DECLARE_REGISTRY_RESOURCEID(a)
243	#define DECLARE_NOT_AGGREGATABLE(a)
244	#define DECLARE_PROTECT_FINAL_CONSTRUCT()
245	#define BEGIN_COM_MAP(a)
246	#define COM_INTERFACE_ENTRY(a)
247	#define COM_INTERFACE_ENTRY2(a,b)
248	#define END_COM_MAP() NS_DECL_ISUPPORTS
249
250	#define HRESULT nsresult
251	#define SUCCEEDED NS_SUCCEEDED
252	#define FAILED NS_FAILED
253
254	#define SUCCEEDED_WARNING(rc) (NS_SUCCEEDED (rc) && (rc) != NS_OK)
255
256	#define IUnknown nsISupports
257
258	#define BOOL PRBool
259	#define BYTE PRUint8
260	#define SHORT PRInt16
261	#define USHORT PRUint16
262	#define LONG PRInt32
263	#define ULONG PRUint32
264	#define LONG64 PRInt64
265	#define ULONG64 PRUint64
266	/* XPCOM has only 64bit floats */
267	#define FLOAT PRFloat64
268	#define DOUBLE PRFloat64
269
270	#define FALSE PR_FALSE
271	#define TRUE PR_TRUE
272
273	#define OLECHAR wchar_t
274
275	/* note: typedef to semantically match BSTR on Win32 */
276	typedef PRUnichar *BSTR;
277	typedef const PRUnichar *CBSTR;
278	typedef BSTR *LPBSTR;
279
280	/** Input BSTR argument the interface method declaration. */
281	#define IN_BSTR CBSTR
282
283	/**
284	* Type to define a raw GUID variable (for members use the com::Guid class
285	* instead).
286	*/
287	#define GUID nsID
288	/** Input GUID argument the interface method declaration. */
289	#define IN_GUID const nsID &
290	/** Output GUID argument the interface method declaration. */
291	#define OUT_GUID nsID **
292
293	/** Makes the name of the getter interface function (n must be capitalized). */
294	#define COMGETTER(n) Get##n
295	/** Makes the name of the setter interface function (n must be capitalized). */
296	#define COMSETTER(n) Set##n
297
298	/* safearray input parameter macros */
299	#define ComSafeArrayIn(aType, aArg) PRUint32 aArg##Size, aType *aArg
300	#define ComSafeArrayInIsNull(aArg) ((aArg) == NULL)
301	#define ComSafeArrayInArg(aArg) aArg##Size, aArg
302
303	/* safearray output parameter macros */
304	#define ComSafeArrayOut(aType, aArg) PRUint32 aArg##Size, aType *aArg
305	#define ComSafeArrayOutIsNull(aArg) ((aArg) == NULL)
306	#define ComSafeArrayOutArg(aArg) aArg##Size, aArg
307
308	/* safearray input parameter macros for GUID */
309	#define ComSafeGUIDArrayIn(aArg) PRUint32 aArg##Size, const nsID **aArg
310	#define ComSafeGUIDArrayInIsNull(aArg) ComSafeArrayInIsNull (aArg)
311	#define ComSafeGUIDArrayInArg(aArg) ComSafeArrayInArg (aArg)
312
313	/* safearray output parameter macros for GUID */
314	#define ComSafeGUIDArrayOut(aArg) PRUint32 aArg##Size, nsID **aArg
315	#define ComSafeGUIDArrayOutIsNull(aArg) ComSafeArrayOutIsNull (aArg)
316	#define ComSafeGUIDArrayOutArg(aArg) ComSafeArrayOutArg (aArg)
317
318	/* CLSID and IID for compatibility with Win32 */
319	typedef nsCID CLSID;
320	typedef nsIID IID;
321
322	/* OLE error codes */
323	#define S_OK ((nsresult) NS_OK)
324	#define E_UNEXPECTED NS_ERROR_UNEXPECTED
325	#define E_NOTIMPL NS_ERROR_NOT_IMPLEMENTED
326	#define E_OUTOFMEMORY NS_ERROR_OUT_OF_MEMORY
327	#define E_INVALIDARG NS_ERROR_INVALID_ARG
328	#define E_NOINTERFACE NS_ERROR_NO_INTERFACE
329	#define E_POINTER NS_ERROR_NULL_POINTER
330	#define E_ABORT NS_ERROR_ABORT
331	#define E_FAIL NS_ERROR_FAILURE
332	/* Note: a better analog for E_ACCESSDENIED would probably be
333	* NS_ERROR_NOT_AVAILABLE, but we want binary compatibility for now. */
334	#define E_ACCESSDENIED ((nsresult) 0x80070005L)
335
336	#define STDMETHOD(a) NS_IMETHOD a
337	#define STDMETHODIMP NS_IMETHODIMP
338
339	#define COM_IIDOF(I) NS_GET_IID (I)
340
341	/* A few very simple ATL emulator classes to provide
342	* FinalConstruct()/FinalRelease() functionality on Linux. */
343
344	class CComMultiThreadModel
345	{
346	};
347
348	template <class Base> class CComObjectRootEx : public Base
349	{
350	public:
351	HRESULT FinalConstruct() { return S_OK; }
352	void FinalRelease() {}
353	};
354
355	template <class Base> class CComObject : public Base
356	{
357	public:
358	virtual ~CComObject() { this->FinalRelease(); }
359	};
360
361	/* helper functions */
362	extern "C"
363	{
364	BSTR SysAllocString (const OLECHAR* sz);
365	BSTR SysAllocStringByteLen (char *psz, unsigned int len);
366	BSTR SysAllocStringLen (const OLECHAR *pch, unsigned int cch);
367	void SysFreeString (BSTR bstr);
368	int SysReAllocString (BSTR pbstr, const OLECHAR psz);
369	int SysReAllocStringLen (BSTR pbstr, const OLECHAR psz, unsigned int cch);
370	unsigned int SysStringByteLen (BSTR bstr);
371	unsigned int SysStringLen (BSTR bstr);
372	}
373
374	/**
375	* 'Constructor' for the component class.
376	* This constructor, as opposed to NS_GENERIC_FACTORY_CONSTRUCTOR,
377	* assumes that the component class is derived from the CComObjectRootEx<>
378	* template, so it calls FinalConstruct() right after object creation
379	* and ensures that FinalRelease() will be called right before destruction.
380	* The result from FinalConstruct() is returned to the caller.
381	*/
382	#define NS_GENERIC_FACTORY_CONSTRUCTOR_WITH_RC(_InstanceClass) \
383	static NS_IMETHODIMP \
384	_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
385	void **aResult) \
386	{ \
387	nsresult rv; \
388	\
389	*aResult = NULL; \
390	if (NULL != aOuter) { \
391	rv = NS_ERROR_NO_AGGREGATION; \
392	return rv; \
393	} \
394	\
395	CComObject <_InstanceClass> *inst = new CComObject <_InstanceClass>(); \
396	if (NULL == inst) { \
397	rv = NS_ERROR_OUT_OF_MEMORY; \
398	return rv; \
399	} \
400	\
401	NS_ADDREF(inst); /* protect FinalConstruct() */ \
402	rv = inst->FinalConstruct(); \
403	if (NS_SUCCEEDED(rv)) \
404	rv = inst->QueryInterface(aIID, aResult); \
405	NS_RELEASE(inst); \
406	\
407	return rv; \
408	}
409
410	/**
411	* 'Constructor' that uses an existing getter function that gets a singleton.
412	* The getter function must have the following prototype:
413	* nsresult _GetterProc (_InstanceClass **inst)
414	* This constructor, as opposed to NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR,
415	* lets the getter function return a result code that is passed back to the
416	* caller that tries to instantiate the object.
417	* NOTE: assumes that getter does an AddRef - so additional AddRef is not done.
418	*/
419	#define NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR_WITH_RC(_InstanceClass, _GetterProc) \
420	static NS_IMETHODIMP \
421	_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
422	void **aResult) \
423	{ \
424	nsresult rv; \
425	\
426	_InstanceClass * inst = NULL; /* initialized to shut up gcc */ \
427	\
428	*aResult = NULL; \
429	if (NULL != aOuter) { \
430	rv = NS_ERROR_NO_AGGREGATION; \
431	return rv; \
432	} \
433	\
434	rv = _GetterProc(&inst); \
435	if (NS_FAILED(rv)) \
436	return rv; \
437	\
438	/* sanity check */ \
439	if (NULL == inst) \
440	return NS_ERROR_OUT_OF_MEMORY; \
441	\
442	/* NS_ADDREF(inst); */ \
443	if (NS_SUCCEEDED(rv)) { \
444	rv = inst->QueryInterface(aIID, aResult); \
445	} \
446	NS_RELEASE(inst); \
447	\
448	return rv; \
449	}
450
451	#endif /* !defined (VBOX_WITH_XPCOM) */
452
453	/**
454	* Declares a wchar_t string literal from the argument.
455	* Necessary to overcome MSC / GCC differences.
456	* @param s expression to stringify
457	*/
458	#if defined (_MSC_VER)
459	# define WSTR_LITERAL(s) L#s
460	#elif defined (__GNUC__)
461	# define WSTR_LITERAL(s) L""#s
462	#else
463	# error "Unsupported compiler!"
464	#endif
465
466	namespace com
467	{
468
469	/**
470	* "First worst" result type.
471	*
472	* Variables of this class are used instead of HRESULT variables when it is
473	* desirable to memorize the "first worst" result code instead of the last
474	* assigned one. In other words, an assignment operation to a variable of this
475	* class will succeed only if the result code to assign has worse severity. The
476	* following table demonstrate this (the first column lists the previous result
477	* code stored in the variable, the first row lists the new result code being
478	* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
479	* result code):
480	*
481	* {{{
482	* FAILED > S_OK S_OK
483	* FAILED - - -
484	* > S_OK A - -
485	* S_OK A A -
486	*
487	* }}}
488	*
489	* In practice, you will need to use a FWResult variable when you call some COM
490	* method B after another COM method A fails and want to return the result code
491	* of A even if B also fails, but want to return the failed result code of B if
492	* A issues a warning or succeeds.
493	*/
494	class FWResult
495	{
496
497	public:
498
499	/**
500	* Constructs a new variable. Note that by default this constructor sets the
501	* result code to E_FAIL to make sure a failure is returned to the caller if
502	* the variable is never assigned another value (which is considered as the
503	* improper use of this class).
504	*/
505	FWResult (HRESULT aRC = E_FAIL) : mRC (aRC) {}
506
507	FWResult &operator= (HRESULT aRC)
508	{
509	if ((FAILED (aRC) && !FAILED (mRC)) \|\|
510	(mRC == S_OK && aRC != S_OK))
511	mRC = aRC;
512
513	return *this;
514	}
515
516	operator HRESULT() const { return mRC; }
517
518	HRESULT *operator&() { return &mRC; }
519
520	private:
521
522	HRESULT mRC;
523	};
524
525	/**
526	* "Last worst" result type.
527	*
528	* Variables of this class are used instead of HRESULT variables when it is
529	* desirable to memorize the "last worst" result code instead of the last
530	* assigned one. In other words, an assignment operation to a variable of this
531	* class will succeed only if the result code to assign has the same or worse
532	* severity. The following table demonstrate this (the first column lists the
533	* previous result code stored in the variable, the first row lists the new
534	* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
535	* result code):
536	*
537	* {{{
538	* FAILED > S_OK S_OK
539	* FAILED A - -
540	* > S_OK A A -
541	* S_OK A A -
542	*
543	* }}}
544	*
545	* In practice, you will need to use a LWResult variable when you call some COM
546	* method B after COM method A fails and want to return the result code of B
547	* if B also fails, but still want to return the failed result code of A if B
548	* issues a warning or succeeds.
549	*/
550	class LWResult
551	{
552
553	public:
554
555	/**
556	* Constructs a new variable. Note that by default this constructor sets the
557	* result code to E_FAIL to make sure a failure is returned to the caller if
558	* the variable is never assigned another value (which is considered as the
559	* improper use of this class).
560	*/
561	LWResult (HRESULT aRC = E_FAIL) : mRC (aRC) {}
562
563	LWResult &operator= (HRESULT aRC)
564	{
565	if (FAILED (aRC) \|\|
566	(SUCCEEDED (mRC) && aRC != S_OK))
567	mRC = aRC;
568
569	return *this;
570	}
571
572	operator HRESULT() const { return mRC; }
573
574	HRESULT *operator&() { return &mRC; }
575
576	private:
577
578	HRESULT mRC;
579	};
580
581	// use this macro to implement scriptable interfaces
582	#ifdef RT_OS_WINDOWS
583	#define VBOX_SCRIPTABLE_IMPL(iface) \
584	public IDispatchImpl<iface, &IID_##iface, &LIBID_VirtualBox, \
585	kTypeLibraryMajorVersion, kTypeLibraryMinorVersion>
586
587	#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface) \
588	STDMETHOD(QueryInterface)(REFIID riid , void **ppObj) \
589	{ \
590	if (riid == IID_IUnknown) \
591	{ \
592	ppObj = (IUnknown)this; \
593	AddRef(); \
594	return S_OK; \
595	} \
596	if (riid == IID_IDispatch) \
597	{ \
598	ppObj = (IDispatch)this; \
599	AddRef(); \
600	return S_OK; \
601	} \
602	if (riid == IID_##iface) \
603	{ \
604	ppObj = (iface)this; \
605	AddRef(); \
606	return S_OK; \
607	} \
608	*ppObj = NULL; \
609	return E_NOINTERFACE; \
610	}
611	#else
612	#define VBOX_SCRIPTABLE_IMPL(iface) \
613	public iface
614	#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface)
615	#endif
616
617
618	} /* namespace com */
619
620	#endif /* ___VBox_com_defs_h */

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

source: vbox/trunk/include/VBox/com/defs.h@ 28197

Download in other formats: