defs.h revision e64031e20c39650a7bc902a3e1aba613b9415dee
/** @file
* MS COM / XPCOM Abstraction Layer:
* Common definitions
*/
/*
* Copyright (C) 2006-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_com_defs_h
#define ___VBox_com_defs_h
/* Make sure all the stdint.h macros are included - must come first! */
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
#if defined (RT_OS_OS2)
#endif
* already defined in order to be able to redefine them using #define. It's
* all code that uses COM Glue. */
#define INCL_BASE
#define INCL_PM
#include <os2.h>
/* OS/2 Toolkit defines TRUE and FALSE */
#endif /* defined (RT_OS_OS2) */
* we'll be without the macros that are optional in C++. */
#if !defined (VBOX_WITH_XPCOM)
#if defined (RT_OS_WINDOWS)
// Windows COM
/////////////////////////////////////////////////////////////////////////////
#include <objbase.h>
#ifndef VBOX_COM_NO_ATL
# include <atlbase.h>
#include <atlcom.h>
#endif
#define NS_DECL_ISUPPORTS
#define NS_IMPL_ISUPPORTS1_CI(a, b)
/* these are XPCOM only, one for every interface implemented */
#define NS_DECL_ISUPPORTS
/** Returns @c true if @a rc represents a warning result code */
/** Immutable BSTR string */
/** Input BSTR argument of interface method declaration. */
/** Input GUID argument of interface method declaration. */
/** Output GUID argument of interface method declaration. */
/** Makes the name of the getter interface function (n must be capitalized). */
/** Makes the name of the setter interface function (n must be capitalized). */
/**
* Declares an input safearray parameter in the COM method implementation. Also
* used to declare the COM attribute setter parameter. Corresponds to either of
* the following XIDL definitions:
* <pre>
* <param name="arg" ... dir="in" safearray="yes"/>
* ...
* <attribute name="arg" ... safearray="yes"/>
* </pre>
*
* The method implementation should use the com::SafeArray helper class to work
* with parameters declared using this define.
*
* @param aType Array element type.
*/
/**
* Expands to @true if the given input safearray parameter is a "null pointer"
* which makes it impossible to use it for reading safearray data.
*/
/**
* Wraps the given parameter name to generate an expression that is suitable for
* passing the parameter to functions that take input safearray parameters
* declared using the ComSafeArrayIn marco.
*
* @param aArg Parameter name to wrap. The given parameter must be declared
* within the calling function using the ComSafeArrayIn macro.
*/
/**
* Declares an output safearray parameter in the COM method implementation. Also
* used to declare the COM attribute getter parameter. Corresponds to either of
* the following XIDL definitions:
* <pre>
* <param name="arg" ... dir="out" safearray="yes"/>
* <param name="arg" ... dir="return" safearray="yes"/>
* ...
* <attribute name="arg" ... safearray="yes"/>
* </pre>
*
* The method implementation should use the com::SafeArray helper class to work
* with parameters declared using this define.
*
* @param aType Array element type.
*/
/**
* Expands to @true if the given output safearray parameter is a "null pointer"
* which makes it impossible to use it for returning a safearray.
*/
/**
* Wraps the given parameter name to generate an expression that is suitable for
* passing the parameter to functions that take output safearray parameters
* declared using the ComSafeArrayOut marco.
*
* @param aArg Parameter name to wrap. The given parameter must be declared
* within the calling function using the ComSafeArrayOut macro.
*/
/**
* Version of ComSafeArrayIn for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Version of ComSafeArrayInIsNull for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Version of ComSafeArrayInArg for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Version of ComSafeArrayOut for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Version of ComSafeArrayOutIsNull for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Version of ComSafeArrayOutArg for GUID.
* @param aArg Parameter name to wrap.
*/
/**
* Returns the const reference to the IID (i.e., |const GUID &|) of the given
* interface.
*
* @param i interface class
*/
#define COM_IIDOF(I) _ATL_IIDOF (I)
#else /* defined (RT_OS_WINDOWS) */
#error "VBOX_WITH_XPCOM must be defined on a platform other than Windows!"
#endif /* defined (RT_OS_WINDOWS) */
#else /* !defined (VBOX_WITH_XPCOM) */
// XPCOM
/////////////////////////////////////////////////////////////////////////////
/* CFBase.h defines these &
* qglobal.h from Qt4 defines these */
#endif /* RT_OS_DARWIN || QT_VERSION */
#include <nsID.h>
#define ATL_NO_VTABLE
#define DECLARE_CLASSFACTORY(a)
#define DECLARE_CLASSFACTORY_SINGLETON(a)
#define DECLARE_REGISTRY_RESOURCEID(a)
#define DECLARE_NOT_AGGREGATABLE(a)
#define DECLARE_PROTECT_FINAL_CONSTRUCT()
#define BEGIN_COM_MAP(a)
#define COM_INTERFACE_ENTRY(a)
#define COM_INTERFACE_ENTRY2(a,b)
#define END_COM_MAP() NS_DECL_ISUPPORTS
#define SUCCEEDED NS_SUCCEEDED
#define IUnknown nsISupports
/* XPCOM has only 64bit floats */
/* note: typedef to semantically match BSTR on Win32 */
/** Input BSTR argument the interface method declaration. */
/**
* Type to define a raw GUID variable (for members use the com::Guid class
* instead).
*/
/** Input GUID argument the interface method declaration. */
/** Output GUID argument the interface method declaration. */
/** Makes the name of the getter interface function (n must be capitalized). */
/** Makes the name of the setter interface function (n must be capitalized). */
/* safearray input parameter macros */
/* safearray output parameter macros */
/* safearray input parameter macros for GUID */
/* safearray output parameter macros for GUID */
/* CLSID and IID for compatibility with Win32 */
/* OLE error codes */
#define E_UNEXPECTED NS_ERROR_UNEXPECTED
#define E_NOTIMPL NS_ERROR_NOT_IMPLEMENTED
#define E_OUTOFMEMORY NS_ERROR_OUT_OF_MEMORY
#define E_INVALIDARG NS_ERROR_INVALID_ARG
#define E_NOINTERFACE NS_ERROR_NO_INTERFACE
#define E_POINTER NS_ERROR_NULL_POINTER
#define E_ABORT NS_ERROR_ABORT
#define E_FAIL NS_ERROR_FAILURE
/* Note: a better analog for E_ACCESSDENIED would probably be
* NS_ERROR_NOT_AVAILABLE, but we want binary compatibility for now. */
#define STDMETHOD(a) NS_IMETHOD a
#define STDMETHODIMP NS_IMETHODIMP
#define COM_IIDOF(I) NS_GET_IID (I)
/* A few very simple ATL emulator classes to provide
* FinalConstruct()/FinalRelease() functionality on Linux. */
{
};
{
void FinalRelease() {}
};
{
};
/* helper functions */
extern "C"
{
}
/**
* 'Constructor' for the component class.
* This constructor, as opposed to NS_GENERIC_FACTORY_CONSTRUCTOR,
* assumes that the component class is derived from the CComObjectRootEx<>
* template, so it calls FinalConstruct() right after object creation
* and ensures that FinalRelease() will be called right before destruction.
* The result from FinalConstruct() is returned to the caller.
*/
static NS_IMETHODIMP \
void **aResult) \
{ \
\
return rv; \
} \
\
rv = NS_ERROR_OUT_OF_MEMORY; \
return rv; \
} \
\
if (NS_SUCCEEDED(rv)) \
NS_RELEASE(inst); \
\
return rv; \
}
/**
* 'Constructor' that uses an existing getter function that gets a singleton.
* The getter function must have the following prototype:
* nsresult _GetterProc (_InstanceClass **inst)
* This constructor, as opposed to NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR,
* lets the getter function return a result code that is passed back to the
* caller that tries to instantiate the object.
* NOTE: assumes that getter does an AddRef - so additional AddRef is not done.
*/
static NS_IMETHODIMP \
void **aResult) \
{ \
\
\
return rv; \
} \
\
return rv; \
\
/* sanity check */ \
return NS_ERROR_OUT_OF_MEMORY; \
\
/* NS_ADDREF(inst); */ \
if (NS_SUCCEEDED(rv)) { \
} \
NS_RELEASE(inst); \
\
return rv; \
}
#endif /* !defined (VBOX_WITH_XPCOM) */
/**
* Declares a wchar_t string literal from the argument.
* Necessary to overcome MSC / GCC differences.
* @param s expression to stringify
*/
#if defined (_MSC_VER)
# define WSTR_LITERAL(s) L#s
# define WSTR_LITERAL(s) L""#s
#else
# error "Unsupported compiler!"
#endif
{
/**
* "First worst" result type.
*
* Variables of this class are used instead of HRESULT variables when it is
* desirable to memorize the "first worst" result code instead of the last
* assigned one. In other words, an assignment operation to a variable of this
* class will succeed only if the result code to assign has worse severity. The
* following table demonstrate this (the first column lists the previous result
* code stored in the variable, the first row lists the new result code being
* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
* result code):
*
* {{{
* FAILED > S_OK S_OK
* FAILED - - -
* > S_OK A - -
* S_OK A A -
*
* }}}
*
* In practice, you will need to use a FWResult variable when you call some COM
* method B after another COM method A fails and want to return the result code
* of A even if B also fails, but want to return the failed result code of B if
* A issues a warning or succeeds.
*/
{
/**
* Constructs a new variable. Note that by default this constructor sets the
* result code to E_FAIL to make sure a failure is returned to the caller if
* the variable is never assigned another value (which is considered as the
* improper use of this class).
*/
{
return *this;
}
};
/**
* "Last worst" result type.
*
* Variables of this class are used instead of HRESULT variables when it is
* desirable to memorize the "last worst" result code instead of the last
* assigned one. In other words, an assignment operation to a variable of this
* class will succeed only if the result code to assign has the same or worse
* severity. The following table demonstrate this (the first column lists the
* previous result code stored in the variable, the first row lists the new
* assigned, 'A' means the assignment will take place, '> S_OK' means a warning
* result code):
*
* {{{
* FAILED > S_OK S_OK
* FAILED A - -
* > S_OK A A -
* S_OK A A -
*
* }}}
*
* In practice, you will need to use a LWResult variable when you call some COM
* method B after COM method A fails and want to return the result code of B
* if B also fails, but still want to return the failed result code of A if B
* issues a warning or succeeds.
*/
{
/**
* Constructs a new variable. Note that by default this constructor sets the
* result code to E_FAIL to make sure a failure is returned to the caller if
* the variable is never assigned another value (which is considered as the
* improper use of this class).
*/
{
return *this;
}
};
// use this macro to implement scriptable interfaces
#ifdef RT_OS_WINDOWS
#define VBOX_SCRIPTABLE_IMPL(iface) \
#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface) \
{ \
if (riid == IID_IUnknown) \
{ \
AddRef(); \
return S_OK; \
} \
if (riid == IID_IDispatch) \
{ \
AddRef(); \
return S_OK; \
} \
{ \
AddRef(); \
return S_OK; \
} \
return E_NOINTERFACE; \
}
#else
#define VBOX_SCRIPTABLE_IMPL(iface) \
#define VBOX_SCRIPTABLE_DISPATCH_IMPL(iface)
#endif
} /* namespace com */
#endif /* ___VBox_com_defs_h */