defs.h@ 24130

Last change on this file since 24130 was 23223, checked in by vboxsync, 15 years ago
API: big medium handling change and lots of assorted other cleanups and fixes
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-2009 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
267	#define FALSE PR_FALSE
268	#define TRUE PR_TRUE
269
270	#define OLECHAR wchar_t
271
272	/* note: typedef to semantically match BSTR on Win32 */
273	typedef PRUnichar *BSTR;
274	typedef const PRUnichar *CBSTR;
275	typedef BSTR *LPBSTR;
276
277	/** Input BSTR argument the interface method declaration. */
278	#define IN_BSTR CBSTR
279
280	/**
281	* Type to define a raw GUID variable (for members use the com::Guid class
282	* instead).
283	*/
284	#define GUID nsID
285	/** Input GUID argument the interface method declaration. */
286	#define IN_GUID const nsID &
287	/** Output GUID argument the interface method declaration. */
288	#define OUT_GUID nsID **
289
290	/** Makes the name of the getter interface function (n must be capitalized). */
291	#define COMGETTER(n) Get##n
292	/** Makes the name of the setter interface function (n must be capitalized). */
293	#define COMSETTER(n) Set##n
294
295	/* safearray input parameter macros */
296	#define ComSafeArrayIn(aType, aArg) PRUint32 aArg##Size, aType *aArg
297	#define ComSafeArrayInIsNull(aArg) ((aArg) == NULL)
298	#define ComSafeArrayInArg(aArg) aArg##Size, aArg
299
300	/* safearray output parameter macros */
301	#define ComSafeArrayOut(aType, aArg) PRUint32 aArg##Size, aType *aArg
302	#define ComSafeArrayOutIsNull(aArg) ((aArg) == NULL)
303	#define ComSafeArrayOutArg(aArg) aArg##Size, aArg
304
305	/* safearray input parameter macros for GUID */
306	#define ComSafeGUIDArrayIn(aArg) PRUint32 aArg##Size, const nsID **aArg
307	#define ComSafeGUIDArrayInIsNull(aArg) ComSafeArrayInIsNull (aArg)
308	#define ComSafeGUIDArrayInArg(aArg) ComSafeArrayInArg (aArg)
309
310	/* safearray output parameter macros for GUID */
311	#define ComSafeGUIDArrayOut(aArg) PRUint32 aArg##Size, nsID **aArg
312	#define ComSafeGUIDArrayOutIsNull(aArg) ComSafeArrayOutIsNull (aArg)
313	#define ComSafeGUIDArrayOutArg(aArg) ComSafeArrayOutArg (aArg)
314
315	/* CLSID and IID for compatibility with Win32 */
316	typedef nsCID CLSID;
317	typedef nsIID IID;
318
319	/* OLE error codes */
320	#define S_OK ((nsresult) NS_OK)
321	#define E_UNEXPECTED NS_ERROR_UNEXPECTED
322	#define E_NOTIMPL NS_ERROR_NOT_IMPLEMENTED
323	#define E_OUTOFMEMORY NS_ERROR_OUT_OF_MEMORY
324	#define E_INVALIDARG NS_ERROR_INVALID_ARG
325	#define E_NOINTERFACE NS_ERROR_NO_INTERFACE
326	#define E_POINTER NS_ERROR_NULL_POINTER
327	#define E_ABORT NS_ERROR_ABORT
328	#define E_FAIL NS_ERROR_FAILURE
329	/* Note: a better analog for E_ACCESSDENIED would probably be
330	* NS_ERROR_NOT_AVAILABLE, but we want binary compatibility for now. */
331	#define E_ACCESSDENIED ((nsresult) 0x80070005L)
332
333	#define STDMETHOD(a) NS_IMETHOD a
334	#define STDMETHODIMP NS_IMETHODIMP
335
336	#define COM_IIDOF(I) NS_GET_IID (I)
337
338	/* A few very simple ATL emulator classes to provide
339	* FinalConstruct()/FinalRelease() functionality on Linux. */
340
341	class CComMultiThreadModel
342	{
343	};
344
345	template <class Base> class CComObjectRootEx : public Base
346	{
347	public:
348	HRESULT FinalConstruct() { return S_OK; }
349	void FinalRelease() {}
350	};
351
352	template <class Base> class CComObject : public Base
353	{
354	public:
355	virtual ~CComObject() { this->FinalRelease(); }
356	};
357
358	/* helper functions */
359	extern "C"
360	{
361	BSTR SysAllocString (const OLECHAR* sz);
362	BSTR SysAllocStringByteLen (char *psz, unsigned int len);
363	BSTR SysAllocStringLen (const OLECHAR *pch, unsigned int cch);
364	void SysFreeString (BSTR bstr);
365	int SysReAllocString (BSTR pbstr, const OLECHAR psz);
366	int SysReAllocStringLen (BSTR pbstr, const OLECHAR psz, unsigned int cch);
367	unsigned int SysStringByteLen (BSTR bstr);
368	unsigned int SysStringLen (BSTR bstr);
369	}
370
371	/**
372	* 'Constructor' for the component class.
373	* This constructor, as opposed to NS_GENERIC_FACTORY_CONSTRUCTOR,
374	* assumes that the component class is derived from the CComObjectRootEx<>
375	* template, so it calls FinalConstruct() right after object creation
376	* and ensures that FinalRelease() will be called right before destruction.
377	* The result from FinalConstruct() is returned to the caller.
378	*/
379	#define NS_GENERIC_FACTORY_CONSTRUCTOR_WITH_RC(_InstanceClass) \
380	static NS_IMETHODIMP \
381	_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
382	void **aResult) \
383	{ \
384	nsresult rv; \
385	\
386	*aResult = NULL; \
387	if (NULL != aOuter) { \
388	rv = NS_ERROR_NO_AGGREGATION; \
389	return rv; \
390	} \
391	\
392	CComObject <_InstanceClass> *inst = new CComObject <_InstanceClass>(); \
393	if (NULL == inst) { \
394	rv = NS_ERROR_OUT_OF_MEMORY; \
395	return rv; \
396	} \
397	\
398	NS_ADDREF(inst); /* protect FinalConstruct() */ \
399	rv = inst->FinalConstruct(); \
400	if (NS_SUCCEEDED(rv)) \
401	rv = inst->QueryInterface(aIID, aResult); \
402	NS_RELEASE(inst); \
403	\
404	return rv; \
405	}
406
407	/**
408	* 'Constructor' that uses an existing getter function that gets a singleton.
409	* The getter function must have the following prototype:
410	* nsresult _GetterProc (_InstanceClass **inst)
411	* This constructor, as opposed to NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR,
412	* lets the getter function return a result code that is passed back to the
413	* caller that tries to instantiate the object.
414	* NOTE: assumes that getter does an AddRef - so additional AddRef is not done.
415	*/
416	#define NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR_WITH_RC(_InstanceClass, _GetterProc) \
417	static NS_IMETHODIMP \
418	_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
419	void **aResult) \
420	{ \
421	nsresult rv; \
422	\
423	_InstanceClass * inst; \
424	\
425	*aResult = NULL; \
426	if (NULL != aOuter) { \
427	rv = NS_ERROR_NO_AGGREGATION; \
428	return rv; \
429	} \
430	\
431	rv = _GetterProc(&inst); \
432	if (NS_FAILED(rv)) \
433	return rv; \
434	\
435	/* sanity check */ \
436	if (NULL == inst) \
437	return NS_ERROR_OUT_OF_MEMORY; \
438	\
439	/* NS_ADDREF(inst); */ \
440	if (NS_SUCCEEDED(rv)) { \
441	rv = inst->QueryInterface(aIID, aResult); \
442	} \
443	NS_RELEASE(inst); \
444	\
445	return rv; \
446	}
447
448	#endif /* !defined (VBOX_WITH_XPCOM) */
449
450	/**
451	* Declares a wchar_t string literal from the argument.
452	* Necessary to overcome MSC / GCC differences.
453	* @param s expression to stringify
454	*/
455	#if defined (_MSC_VER)
456	# define WSTR_LITERAL(s) L#s
457	#elif defined (__GNUC__)
458	# define WSTR_LITERAL(s) L""#s
459	#else
460	# error "Unsupported compiler!"
461	#endif
462
463	namespace com
464	{
465
466	/**
467	* "First worst" result type.
468	*
469	* Variables of this class are used instead of HRESULT variables when it is
470	* desirable to memorize the "first worst" result code instead of the last
471	* assigned one. In other words, an assignment operation to a variable of this
472	* class will succeed only if the result code to assign has worse severity. The
473	* following table demonstrate this (the first column lists the previous result
474	* code stored in the variable, the first row lists the new result code being
475	* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
476	* result code):
477	*
478	* {{{
479	* FAILED > S_OK S_OK
480	* FAILED - - -
481	* > S_OK A - -
482	* S_OK A A -
483	*
484	* }}}
485	*
486	* In practice, you will need to use a FWResult variable when you call some COM
487	* method B after another COM method A fails and want to return the result code
488	* of A even if B also fails, but want to return the failed result code of B if
489	* A issues a warning or succeeds.
490	*/
491	class FWResult
492	{
493
494	public:
495
496	/**
497	* Constructs a new variable. Note that by default this constructor sets the
498	* result code to E_FAIL to make sure a failure is returned to the caller if
499	* the variable is never assigned another value (which is considered as the
500	* improper use of this class).
501	*/
502	FWResult (HRESULT aRC = E_FAIL) : mRC (aRC) {}
503
504	FWResult &operator= (HRESULT aRC)
505	{
506	if ((FAILED (aRC) && !FAILED (mRC)) \|\|
507	(mRC == S_OK && aRC != S_OK))
508	mRC = aRC;
509
510	return *this;
511	}
512
513	operator HRESULT() const { return mRC; }
514
515	HRESULT *operator&() { return &mRC; }
516
517	private:
518
519	HRESULT mRC;
520	};
521
522	/**
523	* "Last worst" result type.
524	*
525	* Variables of this class are used instead of HRESULT variables when it is
526	* desirable to memorize the "last worst" result code instead of the last
527	* assigned one. In other words, an assignment operation to a variable of this
528	* class will succeed only if the result code to assign has the same or worse
529	* severity. The following table demonstrate this (the first column lists the
530	* previous result code stored in the variable, the first row lists the new
531	* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
532	* result code):
533	*
534	* {{{
535	* FAILED > S_OK S_OK
536	* FAILED A - -
537	* > S_OK A A -
538	* S_OK A A -
539	*
540	* }}}
541	*
542	* In practice, you will need to use a LWResult variable when you call some COM
543	* method B after COM method A fails and want to return the result code of B
544	* if B also fails, but still want to return the failed result code of A if B
545	* issues a warning or succeeds.
546	*/
547	class LWResult
548	{
549
550	public:
551
552	/**
553	* Constructs a new variable. Note that by default this constructor sets the
554	* result code to E_FAIL to make sure a failure is returned to the caller if
555	* the variable is never assigned another value (which is considered as the
556	* improper use of this class).
557	*/
558	LWResult (HRESULT aRC = E_FAIL) : mRC (aRC) {}
559
560	LWResult &operator= (HRESULT aRC)
561	{
562	if (FAILED (aRC) \|\|
563	(SUCCEEDED (mRC) && aRC != S_OK))
564	mRC = aRC;
565
566	return *this;
567	}
568
569	operator HRESULT() const { return mRC; }
570
571	HRESULT *operator&() { return &mRC; }
572
573	private:
574
575	HRESULT mRC;
576	};
577
578	// use this macro to implement scriptable interfaces
579	#ifdef RT_OS_WINDOWS
580	#define VBOX_SCRIPTABLE_IMPL(iface) \
581	public IDispatchImpl<iface, &IID_##iface, &LIBID_VirtualBox, \
582	kTypeLibraryMajorVersion, kTypeLibraryMinorVersion>
583
584	#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface) \
585	STDMETHOD(QueryInterface)(REFIID riid , void **ppObj) \
586	{ \
587	if (riid == IID_IUnknown) \
588	{ \
589	ppObj = (IUnknown)this; \
590	AddRef(); \
591	return S_OK; \
592	} \
593	if (riid == IID_IDispatch) \
594	{ \
595	ppObj = (IDispatch)this; \
596	AddRef(); \
597	return S_OK; \
598	} \
599	if (riid == IID_##iface) \
600	{ \
601	ppObj = (iface)this; \
602	AddRef(); \
603	return S_OK; \
604	} \
605	*ppObj = NULL; \
606	return E_NOINTERFACE; \
607	}
608	#else
609	#define VBOX_SCRIPTABLE_IMPL(iface) \
610	public iface
611	#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface)
612	#endif
613
614
615	} /* namespace com */
616
617	#endif /* ___VBox_com_defs_h */

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

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

Download in other formats: