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

Timestamp:

Jan 22, 2008 1:35:10 PM (17 years ago)

Author:

vboxsync

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

27415

Message:

Main: Better ComPtrBase::equalsTo() specialization for IUnknown (allows to avoid unnecessary QueryInterface calls which is sensitive for IPC).

File:

• trunk/include/VBox/com/ptr.h (modified) (21 diffs)

trunk/include/VBox/com/ptr.h

@@ -62 +62 @@
 {
 protected:
+
     static void addref (C *p) { p->AddRef(); }
     static void release (C *p) { p->Release(); }
@@ -73 +74 @@
 {
 protected:
+
     static void addref (C *p) {}
     static void release (C *p) {}
@@ -78 +80 @@
 
 /**
+ *  Equality operations for the ComPtrBase template.
+ */
+template <class C>
+class ComPtrEqOps
+{
+protected:
+
+    template <class I>
+    static bool equals (C *aThis, I *aThat)
+    {
+        IUnknown *thatUnk = NULL, *thisUnk = NULL;
+        if (aThat)
+            aThat->QueryInterface (COM_IIDOF (IUnknown), (void **) &thatUnk);
+        if (aThis)
+            aThis->QueryInterface (COM_IIDOF (IUnknown), (void **) &thisUnk);
+        bool equal = thisUnk == thatUnk;
+        if (thisUnk)
+            thisUnk->Release();
+        if (thatUnk)
+            thatUnk->Release();
+        return equal;
+    }
+
+    /* specialization for IUnknown */
+    template<>
+    static bool equals <IUnknown> (C *aThis, IUnknown *aThat)
+    {
+        IUnknown *thisUnk = NULL;
+        if (aThis)
+            aThis->QueryInterface (COM_IIDOF (IUnknown), (void **) &thisUnk);
+        bool equal = thisUnk == aThat;
+        if (thisUnk)
+            thisUnk->Release();
+        return equal;
+    }
+};
+
+/** Specialization for IUnknown */
+template<>
+class ComPtrEqOps <IUnknown>
+{
+protected:
+
+    template <class I>
+    static bool equals (IUnknown *aThis, I *aThat)
+    {
+        IUnknown *thatUnk = NULL;
+        if (aThat)
+            aThat->QueryInterface (COM_IIDOF (IUnknown), (void **) &thatUnk);
+        bool equal = aThis == thatUnk;
+        if (thatUnk)
+            thatUnk->Release();
+        return equal;
+    }
+
+    /* specialization for IUnknown */
+    template<>
+    static bool equals <IUnknown> (IUnknown *aThis, IUnknown *aThat)
+    {
+        return aThis == aThat;
+    }
+};
+
+/** 
  *  Base template for smart COM pointers. Not intended to be used directly.
  */
 template <class C, template <class> class RefOps = ComStrongRef>
-class ComPtrBase : protected RefOps <C>
+class ComPtrBase : protected RefOps <C>, protected ComPtrEqOps <C>
 {
 public:
 
-    // a special template to disable AddRef()/Release()
+    /* special template to disable AddRef()/Release() */
     template <class I>
-    class NoAddRefRelease : public I {
+    class NoAddRefRelease : public I
+    {
         private:
 #if !defined (VBOX_WITH_XPCOM)
@@ -106 +173 @@
     ~ComPtrBase() { release(); }
 
-    ComPtrBase &operator= (const ComPtrBase &that) {
+    ComPtrBase &operator= (const ComPtrBase &that)
+    {
         safe_assign (that.p);
         return *this;
     }
-    ComPtrBase &operator= (C *that_p) {
+
+    ComPtrBase &operator= (C *that_p)
+    {
         safe_assign (that_p);
         return *this;
@@ -117 +187 @@
 public:
 
-    void setNull() {
+    void setNull()
+    {
         release();
         p = NULL;
     }
 
-    bool isNull() const {
+    bool isNull() const
+    {
         return (p == NULL);
     }
+
     bool operator! () const { return isNull(); }
 
@@ -131 +204 @@
 
     template <class I>
-    bool equalsTo (I *i) const {
-        IUnknown *this_unk = NULL, *that_unk = NULL;
-        if (i)
-            i->QueryInterface (COM_IIDOF (IUnknown), (void**) &that_unk);
-        if (p)
-            p->QueryInterface (COM_IIDOF (IUnknown), (void**) &this_unk);
-        bool equal = this_unk == that_unk;
-        if (that_unk)
-            that_unk->Release();
-        if (this_unk)
-            this_unk->Release();
-        return equal;
+    bool equalsTo (I *aThat) const
+    {
+        return equals (p, aThat);
     }
 
     template <class OC>
-    bool equalsTo (const ComPtrBase <OC> &oc) const {
+    bool equalsTo (const ComPtrBase <OC> &oc) const
+    {
         return equalsTo ((OC *) oc);
     }
@@ -157 +222 @@
      *  pointer).
      */
-    NoAddRefRelease <C> *operator-> () const {
+    NoAddRefRelease <C> *operator-> () const
+    {
         AssertMsg (p, ("Managed pointer must not be null\n"));
         return (NoAddRefRelease <C> *) p;
@@ -163 +229 @@
 
     template <class I>
-    HRESULT queryInterfaceTo (I **pp) const {
-        if (pp) {
-            if (p) {
-                return p->QueryInterface (COM_IIDOF (I), (void**) pp);
-            } else {
+    HRESULT queryInterfaceTo (I **pp) const
+    {
+        if (pp)
+        {
+            if (p)
+            {
+                return p->QueryInterface (COM_IIDOF (I), (void **) pp);
+            }
+            else
+            {
                 *pp = NULL;
                 return S_OK;
             }
-        } else {
-            return E_INVALIDARG;
         }
+
+        return E_INVALIDARG;
     }
 
     /** Intended to pass instances as out parameters to interface methods */
-    C **asOutParam() {
+    C **asOutParam()
+    {
         setNull();
         return &p;
@@ -184 +256 @@
 private:
 
-    void addref() {
+    void addref()
+    {
         if (p)
             RefOps <C>::addref (p);
     }
-    void release() {
+
+    void release()
+    {
         if (p)
             RefOps <C>::release (p);
     }
 
-    void safe_assign (C *that_p) {
-        // be aware of self-assignment
+    void safe_assign (C *that_p)
+    {
+        /* be aware of self-assignment */
         if (that_p)
             RefOps <C>::addref (that_p);
@@ -219 +295 @@
     ComPtr () : Base() {}
     ComPtr (const ComPtr &that) : Base (that) {}
-    ComPtr &operator= (const ComPtr &that) {
+    ComPtr &operator= (const ComPtr &that)
+    {
         Base::operator= (that);
         return *this;
@@ -226 +303 @@
     template <class OI>
     ComPtr (OI *that_p) : Base () { operator= (that_p); }
-    // specialization for I
+
+    /* specialization for I */
     ComPtr (I *that_p) : Base (that_p) {}
 
@@ -233 +311 @@
 
     template <class OI>
-    ComPtr &operator= (OI *that_p) {
+    ComPtr &operator= (OI *that_p)
+    {
         if (that_p)
             that_p->QueryInterface (COM_IIDOF (I), (void **) Base::asOutParam());
@@ -240 +319 @@
         return *this;
     }
-    // specialization for I
-    ComPtr &operator= (I *that_p) {
+
+    /* specialization for I */
+    ComPtr &operator=(I *that_p)
+    {
         Base::operator= (that_p);
         return *this;
@@ -247 +328 @@
 
     template <class OC>
-    ComPtr &operator= (const ComPtr <OC, RefOps> &oc) {
+    ComPtr &operator= (const ComPtr <OC, RefOps> &oc)
+    {
         return operator= ((OC *) oc);
     }
@@ -316 +398 @@
             PRUint32 serverID = 0;
             rc = ipcServ->ResolveClientName (serverName, &serverID);
-            if (SUCCEEDED (rc)) {
+            if (SUCCEEDED (rc))
+            {
                 nsCOMPtr <ipcIDConnectService> dconServ =
                     do_GetService (IPC_DCONNECTSERVICE_CONTRACTID, &rc);
@@ -346 +429 @@
     ComPtr () : Base() {}
     ComPtr (const ComPtr &that) : Base (that) {}
-    ComPtr &operator= (const ComPtr &that) {
+    ComPtr &operator= (const ComPtr &that)
+    {
         Base::operator= (that);
         return *this;
@@ -358 +442 @@
 
     template <class OI>
-    ComPtr &operator= (OI *that_p) {
+    ComPtr &operator= (OI *that_p)
+    {
         if (that_p)
             that_p->QueryInterface (COM_IIDOF (IUnknown), (void **) Base::asOutParam());
@@ -367 +452 @@
 
     template <class OC>
-    ComPtr &operator= (const ComPtr <OC, RefOps> &oc) {
+    ComPtr &operator= (const ComPtr <OC, RefOps> &oc)
+    {
         return operator= ((OC *) oc);
     }
@@ -390 +476 @@
     ComObjPtr (const ComObjPtr &that) : Base (that) {}
     ComObjPtr (C *that_p) : Base (that_p) {}
-    ComObjPtr &operator= (const ComObjPtr &that) {
+
+    ComObjPtr &operator= (const ComObjPtr &that)
+    {
         Base::operator= (that);
         return *this;
     }
-    ComObjPtr &operator= (C *that_p) {
+
+    ComObjPtr &operator= (C *that_p)
+    {
         Base::operator= (that_p);
         return *this;
@@ -412 +502 @@
      *  does otherwise.
      */
-    HRESULT createObject() {
+    HRESULT createObject()
+    {
         HRESULT rc;
 #if !defined (VBOX_WITH_XPCOM)
 #   ifdef VBOX_COM_OUTOFPROC_MODULE
         CComObjectNoLock <C> *obj = new CComObjectNoLock <C>();
-        if (obj) {
+        if (obj)
+        {
             obj->InternalFinalConstructAddRef();
             rc = obj->FinalConstruct();
             obj->InternalFinalConstructRelease();
-        } else {
+        }
+        else
             rc = E_OUTOFMEMORY;
-        }
 #   else
         CComObject <C> *obj = NULL;
@@ -430 +522 @@
 #else /* !defined (VBOX_WITH_XPCOM) */
         CComObject <C> *obj = new CComObject <C>();
-        if (obj) {
+        if (obj)
             rc = obj->FinalConstruct();
-        } else {
+        else
             rc = E_OUTOFMEMORY;
-        }
 #endif /* !defined (VBOX_WITH_XPCOM) */
         *this = obj;