VirtualBox

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

Last change on this file since 3633 was 3601, checked in by vboxsync, 18 years ago

Undefine FALSE & TRUE on Darwin to kill some warnings.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.4 KB
Line 
1/** @file
2 *
3 * MS COM / XPCOM Abstraction Layer:
4 * Common definitions
5 */
6
7/*
8 * Copyright (C) 2006-2007 innotek GmbH
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License as published by the Free Software Foundation,
14 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
15 * distribution. VirtualBox OSE is distributed in the hope that it will
16 * be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * If you received this file as part of a commercial VirtualBox
19 * distribution, then only the terms of your commercial VirtualBox
20 * license agreement apply instead of the previous paragraph.
21 */
22
23#ifndef __VBox_com_defs_h__
24#define __VBox_com_defs_h__
25
26/*
27 * Include iprt/types.h now to make sure iprt get to stdint.h first,
28 * otherwise a system/xpcom header might beat us and we'll be without
29 * the macros that are optional in C++.
30 */
31#include <iprt/types.h>
32
33#if !defined (VBOX_WITH_XPCOM)
34
35#if defined (__WIN__)
36
37// Windows COM
38/////////////////////////////////////////////////////////////////////////////
39
40#include <objbase.h>
41#ifndef VBOX_COM_NO_ATL
42#include <atlbase.h>
43#endif
44
45#define NS_DECL_ISUPPORTS
46#define NS_IMPL_ISUPPORTS1_CI(a, b)
47
48/* these are XPCOM only, one for every interface implemented */
49#define NS_DECL_ISUPPORTS
50#define NS_DECL_IVIRTUALBOX
51#define NS_DECL_IMACHINECOLLECTION
52#define NS_DECL_IMACHINE
53
54/* input pointer argument to method */
55#define INPTR
56
57/* makes the name of the getter interface function (n must be capitalized) */
58#define COMGETTER(n) get_##n
59/* makes the name of the setter interface function (n must be capitalized) */
60#define COMSETTER(n) put_##n
61
62/* a type for an input GUID parameter in the interface method declaration */
63#define GUIDPARAM GUID
64/* a type for an output GUID parameter in the interface method declaration */
65#define GUIDPARAMOUT GUID*
66
67/**
68 * Returns the const reference to the IID (i.e., |const GUID &|) of the given
69 * interface.
70 *
71 * @param i interface class
72 */
73#define COM_IIDOF(I) _ATL_IIDOF (I)
74
75#else // defined (__WIN__)
76
77#error "VBOX_WITH_XPCOM is not defined!"
78
79#endif // defined (__WIN__)
80
81#else // !defined (VBOX_WITH_XPCOM)
82
83// XPCOM
84/////////////////////////////////////////////////////////////////////////////
85
86#if defined (__OS2__)
87
88/* Make sure OS/2 Toolkit headers are pulled in to have
89 * BOOL/ULONG/etc. typedefs already defined in order to be able to redefine
90 * them using #define. */
91#define INCL_BASE
92#define INCL_PM
93#include <os2.h>
94
95/* OS/2 Toolkit defines TRUE and FALSE */
96#undef FALSE
97#undef TRUE
98
99#endif // defined (__OS2__)
100
101#if defined (__DARWIN__)
102 /* CFBase.h defines these*/
103# undef FALSE
104# undef TRUE
105#endif /* __DARWIN__ */
106
107#include <nsID.h>
108
109#define ATL_NO_VTABLE
110#define DECLARE_CLASSFACTORY(a)
111#define DECLARE_CLASSFACTORY_SINGLETON(a)
112#define DECLARE_REGISTRY_RESOURCEID(a)
113#define DECLARE_NOT_AGGREGATABLE(a)
114#define DECLARE_PROTECT_FINAL_CONSTRUCT(a)
115#define BEGIN_COM_MAP(a)
116#define COM_INTERFACE_ENTRY(a)
117#define COM_INTERFACE_ENTRY2(a,b)
118#define END_COM_MAP(a)
119
120#define HRESULT nsresult
121#define SUCCEEDED NS_SUCCEEDED
122#define FAILED NS_FAILED
123#define NS_NULL nsnull
124
125#define IUnknown nsISupports
126
127#define BOOL PRBool
128#define BYTE PRUint8
129#define SHORT PRInt16
130#define USHORT PRUint16
131#define LONG PRInt32
132#define ULONG PRUint32
133#define LONG64 PRInt64
134#define ULONG64 PRUint64
135
136#define BSTR PRUnichar *
137#define LPBSTR BSTR *
138#define OLECHAR wchar_t
139
140#define FALSE PR_FALSE
141#define TRUE PR_TRUE
142
143/* makes the name of the getter interface function (n must be capitalized) */
144#define COMGETTER(n) Get##n
145/* makes the name of the setter interface function (n must be capitalized) */
146#define COMSETTER(n) Set##n
147
148/* a type to define a raw GUID variable (better to use the Guid class) */
149#define GUID nsID
150/* a type for an input GUID parameter in the interface method declaration */
151#define GUIDPARAM nsID &
152/* a type for an output GUID parameter in the interface method declaration */
153#define GUIDPARAMOUT nsID **
154
155/* CLSID and IID for compatibility with Win32 */
156typedef nsCID CLSID;
157typedef nsIID IID;
158
159/* OLE error codes */
160#define S_OK NS_OK
161#define E_UNEXPECTED NS_ERROR_UNEXPECTED
162#define E_NOTIMPL NS_ERROR_NOT_IMPLEMENTED
163#define E_OUTOFMEMORY NS_ERROR_OUT_OF_MEMORY
164#define E_INVALIDARG NS_ERROR_INVALID_ARG
165#define E_NOINTERFACE NS_ERROR_NO_INTERFACE
166#define E_POINTER NS_ERROR_NULL_POINTER
167#define E_ABORT NS_ERROR_ABORT
168#define E_FAIL NS_ERROR_FAILURE
169/* Note: a better analog for E_ACCESSDENIED would probably be
170 * NS_ERROR_NOT_AVAILABLE, but we want binary compatibility for now. */
171#define E_ACCESSDENIED ((nsresult) 0x80070005L)
172
173#define STDMETHOD(a) NS_IMETHOD a
174#define STDMETHODIMP NS_IMETHODIMP
175
176#define COM_IIDOF(I) NS_GET_IID (I)
177
178/* two very simple ATL emulator classes to provide
179 * FinalConstruct()/FinalRelease() functionality on Linux */
180
181class CComObjectRootEx
182{
183public:
184 HRESULT FinalConstruct() { return S_OK; }
185 void FinalRelease() {}
186};
187
188template <class Base> class CComObject : public Base
189{
190public:
191 virtual ~CComObject() { this->FinalRelease(); }
192};
193
194/* input pointer argument to method */
195#define INPTR const
196
197/* helper functions */
198extern "C"
199{
200BSTR SysAllocString (const OLECHAR* sz);
201BSTR SysAllocStringByteLen (char *psz, unsigned int len);
202BSTR SysAllocStringLen (const OLECHAR *pch, unsigned int cch);
203void SysFreeString (BSTR bstr);
204int SysReAllocString (BSTR *pbstr, const OLECHAR *psz);
205int SysReAllocStringLen (BSTR *pbstr, const OLECHAR *psz, unsigned int cch);
206unsigned int SysStringByteLen (BSTR bstr);
207unsigned int SysStringLen (BSTR bstr);
208}
209
210/**
211 * 'Constructor' for the component class.
212 * This constructor, as opposed to NS_GENERIC_FACTORY_CONSTRUCTOR,
213 * assumes that the component class is derived from the CComObjectRootEx<>
214 * template, so it calls FinalConstruct() right after object creation
215 * and ensures that FinalRelease() will be called right before destruction.
216 * The result from FinalConstruct() is returned to the caller.
217 */
218#define NS_GENERIC_FACTORY_CONSTRUCTOR_WITH_RC(_InstanceClass) \
219static NS_IMETHODIMP \
220_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
221 void **aResult) \
222{ \
223 nsresult rv; \
224 \
225 *aResult = NULL; \
226 if (NULL != aOuter) { \
227 rv = NS_ERROR_NO_AGGREGATION; \
228 return rv; \
229 } \
230 \
231 CComObject <_InstanceClass> *inst = new CComObject <_InstanceClass>(); \
232 if (NULL == inst) { \
233 rv = NS_ERROR_OUT_OF_MEMORY; \
234 return rv; \
235 } \
236 \
237 NS_ADDREF(inst); /* protect FinalConstruct() */ \
238 rv = inst->FinalConstruct(); \
239 if (NS_SUCCEEDED(rv)) \
240 rv = inst->QueryInterface(aIID, aResult); \
241 NS_RELEASE(inst); \
242 \
243 return rv; \
244}
245
246/**
247 * 'Constructor' that uses an existing getter function that gets a singleton.
248 * The getter function must have the following prototype:
249 * nsresult _GetterProc (_InstanceClass **inst)
250 * This constructor, as opposed to NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR,
251 * lets the getter function return a result code that is passed back to the
252 * caller that tries to instantiate the object.
253 * NOTE: assumes that getter does an AddRef - so additional AddRef is not done.
254 */
255#define NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR_WITH_RC(_InstanceClass, _GetterProc) \
256static NS_IMETHODIMP \
257_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, \
258 void **aResult) \
259{ \
260 nsresult rv; \
261 \
262 _InstanceClass * inst; \
263 \
264 *aResult = NULL; \
265 if (NULL != aOuter) { \
266 rv = NS_ERROR_NO_AGGREGATION; \
267 return rv; \
268 } \
269 \
270 rv = _GetterProc(&inst); \
271 if (NS_FAILED(rv)) \
272 return rv; \
273 \
274 /* sanity check */ \
275 if (NULL == inst) \
276 return NS_ERROR_OUT_OF_MEMORY; \
277 \
278 /* NS_ADDREF(inst); */ \
279 if (NS_SUCCEEDED(rv)) { \
280 rv = inst->QueryInterface(aIID, aResult); \
281 } \
282 NS_RELEASE(inst); \
283 \
284 return rv; \
285}
286
287#endif // !defined (__WIN__)
288
289/**
290 * Declares a whar_t string literal from the argument.
291 * Necessary to overcome MSC / GCC differences.
292 * @param s expression to stringify
293 */
294#if defined (_MSC_VER)
295# define WSTR_LITERAL(s) L#s
296#elif defined (__GNUC__)
297# define WSTR_LITERAL(s) L""#s
298#else
299# error "Unsupported compiler!"
300#endif
301
302#endif // __VBox_com_defs_h__
303
Note: See TracBrowser for help on using the repository browser.

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