set eol-style to native on tons of files to head off future mixed-line-ending problems
[WebKit-https.git] / WebKit / win / COMEnumVariant.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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef COMEnumVariant_h
30 #define COMEnumVariant_h
31
32 #define NOMINMAX
33 #include <unknwn.h>
34
35 #include <WebCore/BString.h>
36 #include <wtf/Assertions.h>
37 #include <wtf/Noncopyable.h>
38
39 namespace WebCore {
40     class String;
41 }
42
43 template<typename T> struct COMVariantSetter {};
44
45 template<> struct COMVariantSetter<WebCore::String>
46 {
47     static void setVariant(VARIANT* variant, const WebCore::String& value)
48     {
49         ASSERT(V_VT(variant) == VT_EMPTY);
50
51         V_VT(variant) = VT_BSTR;
52         V_BSTR(variant) = WebCore::BString(value).release();
53     }
54 };
55
56 template<> struct COMVariantSetter<unsigned long long>
57 {
58     static void setVariant(VARIANT* variant, unsigned long long value)
59     {
60         ASSERT(V_VT(variant) == VT_EMPTY);
61
62         V_VT(variant) = VT_UI8;
63         V_UI8(variant) = value;
64     }
65 };
66
67 template<typename COMType, typename UnderlyingType>
68 struct COMIUnknownVariantSetter
69 {
70     static void setVariant(VARIANT* variant, const UnderlyingType& value)
71     {
72         ASSERT(V_VT(variant) == VT_EMPTY);
73
74         V_VT(variant) = VT_UNKNOWN;
75         V_UNKNOWN(variant) = COMType::createInstance(value);
76     }
77 };
78
79 template<typename ContainerType>
80 class COMEnumVariant : public IEnumVARIANT, Noncopyable {
81 public:
82     static COMEnumVariant* adopt(ContainerType&);
83     static COMEnumVariant* createInstance(const ContainerType&);
84
85     // IUnknown
86     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID riid, void** ppvObject);
87     virtual ULONG STDMETHODCALLTYPE AddRef();
88     virtual ULONG STDMETHODCALLTYPE Release();
89
90     // IEnumVARIANT
91     virtual HRESULT STDMETHODCALLTYPE Next(ULONG celt, VARIANT* rgVar, ULONG* pCeltFetched);
92     virtual HRESULT STDMETHODCALLTYPE Skip(ULONG celt);
93     virtual HRESULT STDMETHODCALLTYPE Reset();
94     virtual HRESULT STDMETHODCALLTYPE Clone(IEnumVARIANT** ppEnum);
95
96 private:
97     COMEnumVariant()
98         : m_refCount(0)
99     {
100     }
101
102     COMEnumVariant(const ContainerType& container)
103         : m_refCount(0)
104         , m_container(container)       
105         , m_currentPos(m_container.begin())
106     {
107     }
108
109     ~COMEnumVariant() {}
110
111     ULONG m_refCount;
112
113     ContainerType m_container;
114     typename ContainerType::const_iterator m_currentPos;
115 };
116
117 // COMEnumVariant ------------------------------------------------------------------
118 template<typename ContainerType>
119 COMEnumVariant<typename ContainerType>* COMEnumVariant<ContainerType>::adopt(ContainerType& container) 
120 {
121     COMEnumVariant* instance = new COMEnumVariant;
122     instance->m_container.swap(container);
123     instance->m_currentPos = instance->m_container.begin();
124     instance->AddRef();
125     return instance;
126 }
127
128 template<typename ContainerType>
129 COMEnumVariant<typename ContainerType>* COMEnumVariant<ContainerType>::createInstance(const ContainerType& container)
130 {
131     COMEnumVariant* instance = new COMEnumVariant(container);
132     instance->AddRef();
133     return instance;
134 }
135
136 // IUnknown ------------------------------------------------------------------------
137 template<typename ContainerType>
138 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::QueryInterface(REFIID riid, void** ppvObject)
139 {
140     *ppvObject = 0;
141     if (IsEqualGUID(riid, IID_IUnknown))
142         *ppvObject = static_cast<COMEnumVariant*>(this);
143     else if (IsEqualGUID(riid, IID_IEnumVARIANT))
144         *ppvObject = static_cast<COMEnumVariant*>(this);
145     else
146         return E_NOINTERFACE;
147
148     AddRef();
149     return S_OK;
150 }
151
152 template<typename ContainerType>
153 ULONG STDMETHODCALLTYPE COMEnumVariant<ContainerType>::AddRef()
154 {
155     return ++m_refCount;
156 }
157
158 template<typename ContainerType>
159 ULONG STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Release()
160 {
161     ULONG newRef = --m_refCount;
162     if (!newRef)
163         delete this;
164
165     return newRef;
166 }
167
168 // IEnumVARIANT --------------------------------------------------------------------
169 template<typename ContainerType>
170 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Next(ULONG celt, VARIANT* rgVar, ULONG* pCeltFetched)
171 {
172     if (pCeltFetched)
173         *pCeltFetched = 0;
174     if (!rgVar)
175         return E_POINTER;
176     for (unsigned i = 0 ; i < celt; i++)
177         VariantInit(&rgVar[i]);
178
179     for (unsigned i = 0; i < celt; i++) {
180         if (m_currentPos == m_container.end())
181             return S_FALSE;
182
183         COMVariantSetter<ContainerType::ValueType>::setVariant(&rgVar[i], *m_currentPos);
184         ++m_currentPos;
185         if (pCeltFetched)
186             (*pCeltFetched)++;
187     }
188
189     return S_OK;
190 }
191
192 template<typename ContainerType>
193 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Skip(ULONG celt) 
194 {
195     for (unsigned i = 0; i < celt; i++) {
196         if (m_currentPos == m_container.end())
197             return S_FALSE;
198
199         ++m_currentPos;
200     }
201     return S_OK;
202 }
203     
204 template<typename ContainerType>
205 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Reset() 
206 {
207     m_currentPos = m_container.begin();
208     return S_OK;
209 }
210     
211 template<typename ContainerType>
212 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Clone(IEnumVARIANT** ppEnum)
213 {
214     if (!ppEnum)
215         return E_POINTER;
216
217     *ppEnum = 0;
218     return E_NOTIMPL;
219 }
220
221 #endif