WebCore/platform/win/COMPtr.h

   1 /*
   2  * Copyright (C) 2007 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef COMPtr_h
  27 #define COMPtr_h
  28
  29 #define NOMINMAX
  30
  31 #include <guiddef.h>
  32 #include <unknwn.h>
  33 #include <WTF/Assertions.h>
  34 #include <WTF/HashTraits.h>
  35
  36 typedef long HRESULT;
  37
  38 // FIXME: Should we put this into the WebCore namespace and use "using" on it
  39 // as we do with things in WTF?
  40
  41 enum AdoptCOMTag { AdoptCOM };
  42 enum QueryTag { Query };
  43 enum CreateTag { Create };
  44
  45 template <typename T> class COMPtr {
  46 public:
  47     COMPtr() : m_ptr(0) { }
  48     COMPtr(T* ptr) : m_ptr(ptr) { if (m_ptr) m_ptr->AddRef(); }
  49     COMPtr(AdoptCOMTag, T* ptr) : m_ptr(ptr) { }
  50     COMPtr(const COMPtr& o) : m_ptr(o.m_ptr) { if (T* ptr = m_ptr) ptr->AddRef(); }
  51
  52     inline COMPtr(QueryTag, IUnknown* ptr) : m_ptr(copyQueryInterfaceRef(ptr)) { }
  53     template <typename U> inline COMPtr(QueryTag, const COMPtr<U>& ptr) : m_ptr(copyQueryInterfaceRef(ptr.get())) { }
  54
  55     inline COMPtr(CreateTag, const IID& clsid) : m_ptr(createInstance(clsid)) { }
  56
  57     ~COMPtr() { if (m_ptr) m_ptr->Release(); }
  58
  59     T* get() const { return m_ptr; }
  60     T* releaseRef() { T* tmp = m_ptr; m_ptr = 0; return tmp; }
  61
  62     T& operator*() const { return *m_ptr; }
  63     T* operator->() const { return m_ptr; }
  64
  65     T** operator&() { ASSERT(!m_ptr); return &m_ptr; }
  66
  67     bool operator!() const { return !m_ptr; }
  68
  69     // This conversion operator allows implicit conversion to bool but not to other integer types.
  70     typedef T* (COMPtr::*UnspecifiedBoolType)() const;
  71     operator UnspecifiedBoolType() const { return m_ptr ? &COMPtr::get : 0; }
  72
  73     COMPtr& operator=(const COMPtr&);
  74     COMPtr& operator=(T*);
  75     template <typename U> COMPtr& operator=(const COMPtr<U>&);
  76
  77     void query(IUnknown* ptr) { adoptRef(copyQueryInterfaceRef(ptr)); }
  78     template <typename U> inline void query(const COMPtr<U>& ptr) { query(ptr.get()); }
  79
  80     void create(const IID& clsid) { adoptRef(createInstance(clsid)); }
  81
  82     template <typename U> HRESULT copyRefTo(U**);
  83     void adoptRef(T*);
  84
  85 private:
  86     static T* copyQueryInterfaceRef(IUnknown*);
  87     static T* createInstance(const IID& clsid);
  88
  89     T* m_ptr;
  90 };
  91
  92 template <typename T> inline T* COMPtr<T>::createInstance(const IID& clsid)
  93 {
  94     T* result;
  95     if (FAILED(CoCreateInstance(clsid, 0, CLSCTX_ALL, __uuidof(result), reinterpret_cast<void**>(&result))))
  96         return 0;
  97     return result;
  98 }
  99
 100 template <typename T> inline T* COMPtr<T>::copyQueryInterfaceRef(IUnknown* ptr)
 101 {
 102     if (!ptr)
 103         return 0;
 104     T* result;
 105     if (FAILED(ptr->QueryInterface(&result)))
 106         return 0;
 107     return result;
 108 }
 109
 110 template <typename T> template <typename U> inline HRESULT COMPtr<T>::copyRefTo(U** ptr)
 111 {
 112     if (!ptr)
 113         return E_POINTER;
 114     *ptr = m_ptr;
 115     if (m_ptr)
 116         m_ptr->AddRef();
 117     return S_OK;
 118 }
 119
 120 template <typename T> inline void COMPtr<T>::adoptRef(T *ptr)
 121 {
 122     if (m_ptr)
 123         m_ptr->Release();
 124     m_ptr = ptr;
 125 }
 126
 127 template <typename T> inline COMPtr<T>& COMPtr<T>::operator=(const COMPtr<T>& o)
 128 {
 129     T* optr = o.get();
 130     if (optr)
 131         optr->AddRef();
 132     T* ptr = m_ptr;
 133     m_ptr = optr;
 134     if (ptr)
 135         ptr->Release();
 136     return *this;
 137 }
 138
 139 template <typename T> template <typename U> inline COMPtr<T>& COMPtr<T>::operator=(const COMPtr<U>& o)
 140 {
 141     T* optr = o.get();
 142     if (optr)
 143         optr->AddRef();
 144     T* ptr = m_ptr;
 145     m_ptr = optr;
 146     if (ptr)
 147         ptr->Release();
 148     return *this;
 149 }
 150
 151 template <typename T> inline COMPtr<T>& COMPtr<T>::operator=(T* optr)
 152 {
 153     if (optr)
 154         optr->AddRef();
 155     T* ptr = m_ptr;
 156     m_ptr = optr;
 157     if (ptr)
 158         ptr->Release();
 159     return *this;
 160 }
 161
 162 template <typename T, typename U> inline bool operator==(const COMPtr<T>& a, const COMPtr<U>& b)
 163 {
 164     return a.get() == b.get();
 165 }
 166
 167 template <typename T, typename U> inline bool operator==(const COMPtr<T>& a, U* b)
 168 {
 169     return a.get() == b;
 170 }
 171
 172 template <typename T, typename U> inline bool operator==(T* a, const COMPtr<U>& b)
 173 {
 174     return a == b.get();
 175 }
 176
 177 template <typename T, typename U> inline bool operator!=(const COMPtr<T>& a, const COMPtr<U>& b)
 178 {
 179     return a.get() != b.get();
 180 }
 181
 182 template <typename T, typename U> inline bool operator!=(const COMPtr<T>& a, U* b)
 183 {
 184     return a.get() != b;
 185 }
 186
 187 template <typename T, typename U> inline bool operator!=(T* a, const COMPtr<U>& b)
 188 {
 189     return a != b.get();
 190 }
 191
 192 namespace WTF {
 193     template<typename P> struct HashTraits<COMPtr<P> > : GenericHashTraits<COMPtr<P> > {
 194         typedef HashTraits<typename IntTypes<sizeof(P*)>::SignedType> StorageTraits;
 195         typedef typename StorageTraits::TraitType StorageType;
 196         static const bool emptyValueIsZero = true;
 197         static const bool needsRef = true;
 198
 199         typedef union {
 200             P* m_p;
 201             StorageType m_s;
 202         } UnionType;
 203
 204         static void ref(const StorageType& s)
 205         {
 206             if (const P* p = reinterpret_cast<const UnionType*>(&s)->m_p)
 207                 const_cast<P*>(p)->AddRef();
 208         }
 209         static void deref(const StorageType& s)
 210         {
 211             if (const P* p = reinterpret_cast<const UnionType*>(&s)->m_p)
 212                 const_cast<P*>(p)->Release();
 213         }
 214     };
 215
 216     template<typename P> struct HashKeyStorageTraits<PtrHash<COMPtr<P> >, HashTraits<COMPtr<P> > > {
 217         typedef typename IntTypes<sizeof(P*)>::SignedType IntType;
 218         typedef IntHash<IntType> Hash;
 219         typedef HashTraits<IntType> Traits;
 220     };
 221
 222     template<typename P> struct DefaultHash<COMPtr<P> > { typedef PtrHash<COMPtr<P> > Hash; };
 223
 224     template<typename P> struct PtrHash<COMPtr<P> > {
 225         static unsigned hash(const COMPtr<P>& key) { return PtrHash<P*>::hash(key.get()); }
 226         static bool equal(const COMPtr<P>& a, const COMPtr<P>& b) { return a == b; }
 227     };
 228 }
 229
 230 #endif