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

Timestamp:

Jul 6, 2010 5:20:20 PM (15 years ago)

Author:

vboxsync

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

63442

Message:

Main: COM header cleanup (remove obscure and unused templates), second try

Location:

trunk/include/VBox/com

Files:

• ErrorInfo.h (modified) (13 diffs)
• Guid.h (modified) (1 diff)
• array.h (modified) (1 diff)
• com.h (modified) (1 diff)
• defs.h (modified) (1 diff)
• ptr.h (modified) (1 diff)

trunk/include/VBox/com/ErrorInfo.h

@@ -32 +32 @@
 #include "VBox/com/Guid.h"
 #include "VBox/com/assert.h"
-
-#include <iprt/memory> // for auto_copy_ptr
 
 struct IProgress;
@@ -109 +107 @@
      */
     explicit ErrorInfo()
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        { init(); }
-
-    /**
-     *  Constructs a new, "interfaceless" ErrorInfo instance that takes
-     *  the error information possibly set on the current thread by an
-     *  interface method of the given interface pointer.
-
-     *  If the given interface does not support providing error information or,
-     *  for some reason didn't set any error information, both
-     *  #isFullAvailable() and #isBasicAvailable() will return |false|.
-     *
-     *  @param aPtr pointer to the interface whose method returned an
-     *              error
-     */
-    template <class I> ErrorInfo (I *aPtr)
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        { init (aPtr, COM_IIDOF(I)); }
-
-    /**
-     *  Constructs a new ErrorInfo instance from the smart interface pointer.
-     *  See template <class I> ErrorInfo (I *aPtr) for details
-     *
-     *  @param aPtr smart pointer to the interface whose method returned
-     *              an error
-     */
-    template <class I> ErrorInfo (const ComPtr <I> &aPtr)
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        { init (static_cast <I*> (aPtr), COM_IIDOF(I)); }
-
-    /** Specialization for the IVirtualBoxErrorInfo smart pointer */
-    ErrorInfo (const ComPtr <IVirtualBoxErrorInfo> &aPtr)
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        { init (aPtr); }
-
-    /**
-     *  Constructs a new ErrorInfo instance from the IVirtualBoxErrorInfo
-     *  interface pointer. If this pointer is not NULL, both #isFullAvailable()
-     *  and #isBasicAvailable() will return |true|.
-     *
-     *  @param aInfo    pointer to the IVirtualBoxErrorInfo interface that
-     *                  holds error info to be fetched by this instance
-     */
-    ErrorInfo (IVirtualBoxErrorInfo *aInfo)
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        { init (aInfo); }
+        : mIsBasicAvailable(false),
+          mIsFullAvailable(false),
+          mResultCode(S_OK),
+          m_pNext(NULL)
+    {
+        init();
+    }
+
+    ErrorInfo(IUnknown *pObj, const GUID &aIID)
+        : mIsBasicAvailable(false),
+          mIsFullAvailable(false),
+          mResultCode(S_OK),
+          m_pNext(NULL)
+    {
+        init(pObj, aIID);
+    }
 
     virtual ~ErrorInfo();
@@ -175 +138 @@
      *  this method returns true (otherwise they simply return NULL-like values).
      */
-    bool isBasicAvailable() const { return mIsBasicAvailable; }
+    bool isBasicAvailable() const
+    {
+        return mIsBasicAvailable;
+    }
 
     /**
@@ -189 +155 @@
      *  this method returns true (otherwise they simply return NULL-like values).
      */
-    bool isFullAvailable() const { return mIsFullAvailable; }
-
-    /**
-     *  Returns @c true if both isBasicAvailable() and isFullAvailable() are
-     *  @c false.
-     */
-    bool isNull() const { return !mIsBasicAvailable && !mIsFullAvailable; }
+    bool isFullAvailable() const
+    {
+        return mIsFullAvailable;
+    }
 
     /**
      *  Returns the COM result code of the failed operation.
      */
-    HRESULT getResultCode() const { return mResultCode; }
+    HRESULT getResultCode() const
+    {
+        return mResultCode;
+    }
 
     /**
      *  Returns the IID of the interface that defined the error.
      */
-    const Guid &getInterfaceID() const { return mInterfaceID; }
+    const Guid& getInterfaceID() const
+    {
+        return mInterfaceID;
+    }
 
     /**
      *  Returns the name of the component that generated the error.
      */
-    const Bstr &getComponent() const { return mComponent; }
+    const Bstr& getComponent() const
+    {
+        return mComponent;
+    }
 
     /**
      *  Returns the textual description of the error.
      */
-    const Bstr &getText() const { return mText; }
+    const Bstr& getText() const
+    {
+        return mText;
+    }
 
     /**
      *  Returns the next error information object or @c NULL if there is none.
      */
-    const ErrorInfo *getNext() const { return mNext.get(); }
+    const ErrorInfo* getNext() const
+    {
+        return m_pNext;
+    }
 
     /**
      *  Returns the name of the interface that defined the error
      */
-    const Bstr &getInterfaceName() const { return mInterfaceName; }
+    const Bstr& getInterfaceName() const
+    {
+        return mInterfaceName;
+    }
 
     /**
@@ -234 +215 @@
      *  template <class I> ErrorInfo (const ComPtr <I> &i) constructor.
      */
-    const Guid &getCalleeIID() const { return mCalleeIID; }
+    const Guid& getCalleeIID() const
+    {
+        return mCalleeIID;
+    }
 
     /**
@@ -243 +227 @@
      *  template <class I> ErrorInfo (const ComPtr <I> &i) constructor.
      */
-    const Bstr &getCalleeName() const { return mCalleeName; }
+    const Bstr& getCalleeName() const
+    {
+        return mCalleeName;
+    }
 
     /**
@@ -253 +240 @@
         mIsBasicAvailable = false;
         mIsFullAvailable = false;
+
+        if (m_pNext)
+        {
+            delete m_pNext;
+            m_pNext = NULL;
+        }
 
         mResultCode = S_OK;
@@ -258 +251 @@
         mComponent.setNull();
         mText.setNull();
-        mNext.reset();
         mInterfaceName.setNull();
         mCalleeIID.clear();
@@ -267 +259 @@
 protected:
 
-    ErrorInfo (bool /* aDummy */)
-        : mIsBasicAvailable (false), mIsFullAvailable (false)
-        , mResultCode (S_OK)
-        {}
-
-    void init (bool aKeepObj = false);
-    void init (IUnknown *aUnk, const GUID &aIID, bool aKeepObj = false);
-    void init (IVirtualBoxErrorInfo *aInfo);
+    ErrorInfo(bool /* aDummy */)
+        : mIsBasicAvailable(false),
+          mIsFullAvailable(false),
+          mResultCode(S_OK),
+          m_pNext(NULL)
+    { }
+
+    void init(bool aKeepObj = false);
+    void init(IUnknown *aUnk, const GUID &aIID, bool aKeepObj = false);
+    void init(IVirtualBoxErrorInfo *aInfo);
 
     bool mIsBasicAvailable : 1;
@@ -284 +278 @@
     Bstr    mText;
 
-    cppx::auto_copy_ptr <ErrorInfo> mNext;
+    ErrorInfo *m_pNext;
 
     Bstr mInterfaceName;
@@ -290 +284 @@
     Bstr mCalleeName;
 
-    ComPtr <IUnknown> mErrorInfo;
+    ComPtr<IUnknown> mErrorInfo;
+
+private:
+    ErrorInfo(const ErrorInfo&);
 };
 
@@ -311 +308 @@
      *  @param  progress    the progress object representing a failed operation
      */
-    ProgressErrorInfo (IProgress *progress);
+    ProgressErrorInfo(IProgress *progress);
 };
 
@@ -381 +378 @@
         setNull();
         mForgot = false;
-        init (true /* aKeepObj */);
+        init(true /* aKeepObj */);
     }
 

trunk/include/VBox/com/Guid.h

@@ -44 +44 @@
 #include "VBox/com/string.h"
 
-#include <iprt/cpp/utils.h>
 #include <iprt/uuid.h>
 

trunk/include/VBox/com/array.h

@@ -168 +168 @@
 #include "VBox/com/ptr.h"
 #include "VBox/com/assert.h"
-
-#include "iprt/cpp/utils.h"
 
 #if defined (VBOX_WITH_XPCOM)

trunk/include/VBox/com/com.h

@@ -59 +59 @@
 void GetInterfaceNameByIID(const GUID &aIID, BSTR *aName);
 
-#ifdef VBOX_WITH_XPCOM
-
-/**
- *  Helper method to keep all the XPCOM headers out of include/VBox/com/ptr.h.
- */
-HRESULT GlueCreateObjectOnServer(const CLSID &clsid,
-                                 const char *serverName,
-                                 const nsIID &id,
-                                 void** ppobj);
-
-/**
- *  Helper method to keep all the XPCOM headers out of include/VBox/com/ptr.h.
- */
-HRESULT GlueCreateInstance(const CLSID &clsid,
-                           const nsIID &id,
-                           void** ppobj);
-
-#endif // VBOX_WITH_XPCOM
-
 /**
  *  Returns the VirtualBox user home directory.

trunk/include/VBox/com/defs.h

@@ -521 +521 @@
         if ((FAILED (aRC) && !FAILED (mRC)) ||
             (mRC == S_OK && aRC != S_OK))
-            mRC = aRC;
-
-        return *this;
-    }
-
-    operator HRESULT() const { return mRC; }
-
-    HRESULT *operator&() { return &mRC; }
-
-private:
-
-    HRESULT mRC;
-};
-
-/**
- * "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.
- */
-class LWResult
-{
-
-public:
-
-    /**
-     * 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).
-     */
-    LWResult (HRESULT aRC = E_FAIL) : mRC (aRC) {}
-
-    LWResult &operator= (HRESULT aRC)
-    {
-        if (FAILED (aRC) ||
-            (SUCCEEDED (mRC) && aRC != S_OK))
             mRC = aRC;
 

trunk/include/VBox/com/ptr.h

@@ -43 +43 @@
 #else
  #include <nsISupportsUtils.h>
+
 #endif /* !defined (VBOX_WITH_XPCOM) */
 
-#include <VBox/com/com.h>
+#include <VBox/com/defs.h>
+
+#ifdef VBOX_WITH_XPCOM
+
+namespace com
+{
+// declare a couple of XPCOM helper methods (defined in glue/com.cpp)
+// so we don't have to include a ton of XPCOM implementation headers here
+HRESULT GlueCreateObjectOnServer(const CLSID &clsid,
+                                 const char *serverName,
+                                 const nsIID &id,
+                                 void** ppobj);
+HRESULT GlueCreateInstance(const CLSID &clsid,
+                           const nsIID &id,
+                           void** ppobj);
+}
+
+#endif // VBOX_WITH_XPCOM
 
 /**