Reviewed by Anders.
[WebKit-https.git] / 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
35 typedef long HRESULT;
36
37 // FIXME: Should we put this into the WebCore namespace and use "using" on it
38 // as we do with things in WTF? 
39
40 enum AdoptCOMTag { AdoptCOM };
41 enum QueryTag { Query };
42
43 template <typename T> class COMPtr {
44 public:
45     COMPtr() : m_ptr(0) { }
46     COMPtr(T* ptr) : m_ptr(ptr) { if (m_ptr) m_ptr->AddRef(); }
47     COMPtr(AdoptCOMTag, T* ptr) : m_ptr(ptr) { }
48     COMPtr(const COMPtr& o) : m_ptr(o.m_ptr) { if (T* ptr = m_ptr) ptr->AddRef(); }
49
50     inline COMPtr(QueryTag, IUnknown* ptr) : m_ptr(copyQueryInterfaceRef(ptr)) { }
51     template <typename U> inline COMPtr(QueryTag, const COMPtr<U>& ptr) : m_ptr(copyQueryInterfaceRef(ptr)) { }
52
53     ~COMPtr() { if (m_ptr) m_ptr->Release(); }
54
55     T* get() const { return m_ptr; }
56
57     T& operator*() const { return *m_ptr; }
58     T* operator->() const { return m_ptr; }
59
60     T** operator&() { ASSERT(!m_ptr); return &m_ptr; }
61
62     bool operator!() const { return !m_ptr; }
63     
64     // This conversion operator allows implicit conversion to bool but not to other integer types.
65     typedef T* (COMPtr::*UnspecifiedBoolType)() const;
66     operator UnspecifiedBoolType() const { return m_ptr ? &COMPtr::get : 0; }
67
68     COMPtr& operator=(const COMPtr&);
69     COMPtr& operator=(T*);
70     template <typename U> COMPtr& operator=(const COMPtr<U>&);
71   
72     void query(IUnknown* ptr) { adoptRef(copyQueryInterfaceRef(ptr)); }
73     template <typename U> inline void query(const COMPtr<U>& ptr) { query(ptr.get()); }
74
75     HRESULT copyRefTo(T**);
76     void adoptRef(T*);
77
78 private:
79     static T* copyQueryInterfaceRef(IUnknown*);
80
81     T* m_ptr;
82 };
83
84 template <typename T> inline T* COMPtr<T>::copyQueryInterfaceRef(IUnknown* ptr)
85 {
86     if (!ptr)
87         return 0;
88     T* result;
89     if (FAILED(ptr->QueryInterface(&result)))
90         return 0;
91     return result;
92 }
93
94 template <typename T> inline HRESULT COMPtr<T>::copyRefTo(T** ptr)
95 {
96     if (!ptr)
97         return E_POINTER;
98     *ptr = m_ptr;
99     if (m_ptr)
100         m_ptr->AddRef();
101     return S_OK;
102 }
103
104 template <typename T> inline void COMPtr<T>::adoptRef(T *ptr)
105 {
106     if (m_ptr)
107         m_ptr->Release();
108     m_ptr = ptr;
109 }
110
111 template <typename T> inline COMPtr<T>& COMPtr<T>::operator=(const COMPtr<T>& o)
112 {
113     T* optr = o.get();
114     if (optr)
115         optr->AddRef();
116     T* ptr = m_ptr;
117     m_ptr = optr;
118     if (ptr)
119         ptr->Release();
120     return *this;
121 }
122
123 template <typename T> template <typename U> inline COMPtr<T>& COMPtr<T>::operator=(const COMPtr<U>& o)
124 {
125     T* optr = o.get();
126     if (optr)
127         optr->AddRef();
128     T* ptr = m_ptr;
129     m_ptr = optr;
130     if (ptr)
131         ptr->Release();
132     return *this;
133 }
134
135 template <typename T> inline COMPtr<T>& COMPtr<T>::operator=(T* optr)
136 {
137     if (optr)
138         optr->AddRef();
139     T* ptr = m_ptr;
140     m_ptr = optr;
141     if (ptr)
142         ptr->Release();
143     return *this;
144 }
145
146 template <typename T, typename U> inline bool operator==(const COMPtr<T>& a, const COMPtr<U>& b)
147 {
148     return a.get() == b.get();
149 }
150
151 template <typename T, typename U> inline bool operator==(const COMPtr<T>& a, U* b)
152 {
153     return a.get() == b;
154 }
155
156 template <typename T, typename U> inline bool operator==(T* a, const COMPtr<U>& b) 
157 {
158     return a == b.get();
159 }
160
161 template <typename T, typename U> inline bool operator!=(const COMPtr<T>& a, const COMPtr<U>& b)
162 {
163     return a.get() != b.get();
164 }
165
166 template <typename T, typename U> inline bool operator!=(const COMPtr<T>& a, U* b)
167 {
168     return a.get() != b;
169 }
170
171 template <typename T, typename U> inline bool operator!=(T* a, const COMPtr<U>& b)
172 {
173     return a != b.get();
174 }
175
176 #endif