Changeset 30714 in vbox for trunk/include/VBox/com

Timestamp:

Jul 7, 2010 4:20:03 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

63479

Message:

Main: remove SupportErrorInfo template magic

Location:

trunk/include/VBox/com

Files:

• SupportErrorInfo.h (modified) (3 diffs)
• VirtualBoxErrorInfo.h (modified) (1 diff)
• defs.h (modified) (2 diffs)

trunk/include/VBox/com/SupportErrorInfo.h

@@ -155 +155 @@
     }
 
+    /**
+     * Returns true if multi-mode is enabled for the current thread (i.e. at
+     * least one MultiResult instance exists on the stack somewhere).
+     * @return
+     */
+    static bool isMultiEnabled();
+
 private:
 
@@ -164 +171 @@
     static RTTLS sCounter;
 
-    friend class SupportErrorInfoBase;
     friend class MultiResultRef;
 };
@@ -202 +208 @@
 };
 
-/**
- * The SupportErrorInfoBase template class provides basic error info support.
- *
- * Basic error info support includes a group of setError() methods to set
- * extended error information on the current thread. This support does not
- * include all necessary implementation details (for example, implementation of
- * the ISupportErrorInfo interface on MS COM) to make the error info support
- * fully functional in a target component. These details are provided by the
- * SupportErrorInfoDerived class.
- *
- * This way, this class is intended to be directly inherited only by
- * intermediate component base classes that will be then inherited by final
- * component classes through the SupportErrorInfoDerived template class. In
- * all other cases, the SupportErrorInfoImpl class should be used as a base for
- * final component classes instead.
- */
-class SupportErrorInfoBase
-{
-    static HRESULT setErrorInternal(HRESULT aResultCode,
-                                    const GUID *aIID,
-                                    const char *aComponent,
-                                    const Utf8Str &strText,
-                                    bool aWarning,
-                                    IVirtualBoxErrorInfo *aInfo = NULL);
-
-protected:
-
-    /**
-     * Returns an interface ID that is to be used in short setError() variants
-     * to specify the interface that has defined the error. Must be implemented
-     * in subclasses.
-     */
-    virtual const GUID &mainInterfaceID() const = 0;
-
-    /**
-     * Returns an component name (in UTF8) that is to be used in short
-     * setError() variants to specify the interface that has defined the error.
-     * Must be implemented in subclasses.
-     */
-    virtual const char *componentName() const = 0;
-
-    /**
-     * Same as #setError (HRESULT, const GUID &, const char *, const char *) but
-     * interprets the @a aText argument as a RTPrintf-like format string and the
-     * @a aArgs argument as an argument list for this format string.
-     */
-    static HRESULT setErrorV(HRESULT aResultCode, const GUID &aIID,
-                             const char *aComponent, const char *aText,
-                             va_list aArgs)
-    {
-        return setErrorInternal(aResultCode, &aIID, aComponent,
-                                Utf8StrFmtVA(aText, aArgs),
-                                false /* aWarning */);
-    }
-
-    /**
-     * Same as #setWarning (HRESULT, const GUID &, const char *, const char *)
-     * but interprets the @a aText argument as a RTPrintf-like format string and
-     * the @a aArgs argument as an argument list for this format string.
-     */
-    static HRESULT setWarningV(HRESULT aResultCode, const GUID &aIID,
-                               const char *aComponent, const char *aText,
-                               va_list aArgs)
-    {
-        return setErrorInternal(aResultCode, &aIID,
-                                aComponent,
-                                Utf8StrFmtVA(aText, aArgs),
-                                true /* aWarning */);
-    }
-
-    /**
-     * Same as #setError (HRESULT, const GUID &, const char *, const char *) but
-     * interprets the @a aText argument as a RTPrintf-like format string and
-     * takes a variable list of arguments for this format string.
-     */
-    static HRESULT setError(HRESULT aResultCode,
-                            const GUID &aIID,
-                            const char *aComponent,
-                            const char *aText,
-                            ...);
-
-    /**
-     * Same as #setWarning (HRESULT, const GUID &, const char *, const char *)
-     * but interprets the @a aText argument as a RTPrintf-like format string and
-     * takes a variable list of arguments for this format string.
-     */
-    static HRESULT setWarning(HRESULT aResultCode, const GUID &aIID,
-                              const char *aComponent, const char *aText,
-                              ...);
-
-    /**
-     * Sets the given error info object on the current thread.
-     *
-     * Note that In multi-error mode (see MultiResult), the existing error info
-     * object (if any) will be preserved by attaching it to the tail of the
-     * error chain of the given aInfo object.
-     *
-     * @param aInfo     Error info object to set (must not be NULL).
-     */
-    static HRESULT setErrorInfo(IVirtualBoxErrorInfo *aInfo)
-    {
-        AssertReturn (aInfo != NULL, E_FAIL);
-        return setErrorInternal(0, NULL, NULL, Utf8Str::Null, false, aInfo);
-    }
-
-    /**
-     * Same as #setError (HRESULT, const GUID &, const char *, const char *,
-     * ...) but uses the return value of the mainInterfaceID() method as an @a
-     * aIID argument and the return value of the componentName() method as a @a
-     * aComponent argument.
-     *
-     * This method is the most common (and convenient) way to set error
-     * information from within a component method. The typical usage pattern is:
-     * <code>
-     *     return setError (E_FAIL, "Terrible Error");
-     * </code>
-     * or
-     * <code>
-     *     HRESULT rc = setError (E_FAIL, "Terrible Error");
-     *     ...
-     *     return rc;
-     * </code>
-     */
-    HRESULT setError(HRESULT aResultCode, const char *aText, ...);
-
-    HRESULT setError(HRESULT aResultCode, const Utf8Str &strText);
-
-    /**
-     * Same as #setWarning (HRESULT, const GUID &, const char *, const char *,
-     * ...) but uses the return value of the mainInterfaceID() method as an @a
-     * aIID argument and the return value of the componentName() method as a @a
-     * aComponent argument.
-     *
-     * This method is the most common (and convenient) way to set warning
-     * information from within a component method. The typical usage pattern is:
-     * <code>
-     *     return setWarning (E_FAIL, "Dangerous warning");
-     * </code>
-     * or
-     * <code>
-     *     HRESULT rc = setWarning (E_FAIL, "Dangerous warning");
-     *     ...
-     *     return rc;
-     * </code>
-     */
-    HRESULT setWarning (HRESULT aResultCode, const char *aText, ...);
-
-    /**
-     * Same as #setError (HRESULT, const char *, ...) but takes a va_list
-     * argument instead of a variable argument list.
-     */
-    HRESULT setErrorV (HRESULT aResultCode, const char *aText, va_list aArgs)
-    {
-        return setError (aResultCode, mainInterfaceID(), componentName(),
-                         aText, aArgs);
-    }
-
-    /**
-     * Same as #setWarning (HRESULT, const char *, ...) but takes a va_list
-     * argument instead of a variable argument list.
-     */
-    HRESULT setWarningV (HRESULT aResultCode, const char *aText, va_list aArgs)
-    {
-        return setWarning (aResultCode, mainInterfaceID(), componentName(),
-                           aText, aArgs);
-    }
-
-    /**
-     * Same as #setError (HRESULT, const char *, ...) but allows to specify the
-     * interface ID manually.
-     */
-    HRESULT setError (HRESULT aResultCode, const GUID &aIID,
-                      const char *aText, ...);
-
-    /**
-     * Same as #setWarning (HRESULT, const char *, ...) but allows to specify
-     * the interface ID manually.
-     */
-    HRESULT setWarning (HRESULT aResultCode, const GUID &aIID,
-                        const char *aText, ...);
-};
-
-////////////////////////////////////////////////////////////////////////////////
-
-/**
- * The SupportErrorInfoDerived template class implements the remaining parts
- * of error info support in addition to SupportErrorInfoBase.
- *
- * These parts include the ISupportErrorInfo implementation on the MS COM
- * platform and implementations of mandatory SupportErrorInfoBase virtual
- * methods.
- *
- * On MS COM, the @a C template argument must declare a COM interface map using
- * BEGIN_COM_MAP / END_COM_MAP macros and this map must contain a
- * COM_INTERFACE_ENTRY(ISupportErrorInfo) definition. All interface entries that
- * follow it will be considered to support IErrorInfo, i.e. the
- * InterfaceSupportsErrorInfo() implementation will return S_OK for the
- * corresponding IIDs.
- *
- * On all platforms, the @a C template argument must be a subclass of
- * SupportErrorInfoBase and also define the following method: <tt>public static
- * const char *ComponentName()</tt> that will be used as a value returned by the
- * SupportErrorInfoBase::componentName() implementation.
- *
- * If SupportErrorInfoBase is used as a base for an intermediate component base
- * class FooBase then the final component FooFinal that inherits FooBase should
- * use this template class as follows:
- * <code>
- *     class FooFinal : public SupportErrorInfoDerived <FooBase, FooFinal, IFoo>
- *     {
- *         ...
- *     };
- * </code>
- *
- * Note that if you don not use intermediate component base classes, you should
- * use the SupportErrorInfoImpl class as a base for your component instead.
- *
- * @param B     Intermediate component base derived from SupportErrorInfoBase.
- * @param C     Component class that implements one or more COM interfaces.
- * @param I     Default interface for the component (for short #setError()
- *              versions).
- */
-template <class B, class C, class I>
-class ATL_NO_VTABLE SupportErrorInfoDerived : public B
-#if !defined (VBOX_WITH_XPCOM)
-    , public ISupportErrorInfo
-#endif
-{
-public:
-
-#if !defined (VBOX_WITH_XPCOM)
-    STDMETHOD(InterfaceSupportsErrorInfo) (REFIID aIID)
-    {
-        const _ATL_INTMAP_ENTRY* pEntries = C::_GetEntries();
-        Assert (pEntries);
-        if (!pEntries)
-            return S_FALSE;
-
-        BOOL bSupports = FALSE;
-        BOOL bISupportErrorInfoFound = FALSE;
-
-        while (pEntries->pFunc != NULL && !bSupports)
-        {
-            if (!bISupportErrorInfoFound)
-            {
-                /* skip the COM map entries until ISupportErrorInfo is found */
-                bISupportErrorInfoFound =
-                    InlineIsEqualGUID (*(pEntries->piid), IID_ISupportErrorInfo);
-            }
-            else
-            {
-                /* look for the requested interface in the rest of the com map */
-                bSupports = InlineIsEqualGUID (*(pEntries->piid), aIID);
-            }
-            pEntries++;
-        }
-
-        Assert (bISupportErrorInfoFound);
-
-        return bSupports ? S_OK : S_FALSE;
-    }
-#endif /* !defined (VBOX_WITH_XPCOM) */
-
-protected:
-
-    virtual const GUID &mainInterfaceID() const { return COM_IIDOF (I); }
-
-    virtual const char *componentName() const { return C::ComponentName(); }
-};
-
-////////////////////////////////////////////////////////////////////////////////
-
-/**
- * The SupportErrorInfoImpl template class provides complete error info support
- * for COM component classes.
- *
- * Complete error info support includes what both SupportErrorInfoBase and
- * SupportErrorInfoDerived provide, e.g. a variety of setError() methods to
- * set extended error information from within a component's method
- * implementation and all necessary additional interface implementations (see
- * descriptions of these classes for details).
- *
- * To add error info support to a Foo component that implements a IFoo
- * interface, use the following pattern:
- * <code>
- *     class Foo : public SupportErrorInfoImpl <Foo, IFoo>
- *     {
- *     public:
- *
- *         ...
- *
- *         static const char *ComponentName() const { return "Foo"; }
- *     };
- * </code>
- *
- * Note that your component class (the @a C template argument) must provide the
- * ComponentName() implementation as shown above.
- *
- * @param C Component class that implements one or more COM interfaces.
- * @param I Default interface for the component (for short #setError()
- *          versions).
- */
-template <class C, class I>
-class ATL_NO_VTABLE SupportErrorInfoImpl
-    : public SupportErrorInfoDerived <SupportErrorInfoBase, C, I>
-{
-};
 
 } /* namespace com */

trunk/include/VBox/com/VirtualBoxErrorInfo.h

@@ -144 +144 @@
 
     // IVirtualBoxErrorInfo properties
-    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_ResultCode_TO_OBJ (mReal)
-    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_InterfaceID_TO_OBJ (mReal)
-    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_Component_TO_OBJ (mReal)
-    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_Text_TO_OBJ (mReal)
+    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_ResultCode_TO_OBJ(mReal)
+    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_InterfaceID_TO_OBJ(mReal)
+    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_Component_TO_OBJ(mReal)
+    COM_FORWARD_IVirtualBoxErrorInfo_GETTER_Text_TO_OBJ(mReal)
     STDMETHOD(COMGETTER(Next)) (IVirtualBoxErrorInfo **aNext);
 

trunk/include/VBox/com/defs.h

@@ -225 +225 @@
  *  @param i    interface class
  */
-#define COM_IIDOF(I) _ATL_IIDOF (I)
+#define COM_IIDOF(I) _ATL_IIDOF(I)
 
 #else /* defined (RT_OS_WINDOWS) */
@@ -349 +349 @@
 #define STDMETHODIMP NS_IMETHODIMP
 
-#define COM_IIDOF(I) NS_GET_IID (I)
+#define COM_IIDOF(I) NS_GET_IID(I)
 
 /* A few very simple ATL emulator classes to provide