[Win] Replace MIDL [in/out] comments with equivalent SAL
[WebKit-https.git] / Source / 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  * 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 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 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 COMEnumVariant_h
27 #define COMEnumVariant_h
28
29 #ifndef NOMINMAX
30 #define NOMINMAX
31 #endif
32 #include <unknwn.h>
33
34
35 #include "COMVariantSetter.h"
36
37 template<typename ContainerType>
38 class COMEnumVariant : public IEnumVARIANT {
39     WTF_MAKE_NONCOPYABLE(COMEnumVariant);
40 public:
41     static COMEnumVariant* adopt(ContainerType&);
42     static COMEnumVariant* createInstance(const ContainerType&);
43
44     // IUnknown
45     virtual HRESULT STDMETHODCALLTYPE QueryInterface(_In_ REFIID riid, _COM_Outptr_ void** ppvObject);
46     virtual ULONG STDMETHODCALLTYPE AddRef();
47     virtual ULONG STDMETHODCALLTYPE Release();
48
49     // IEnumVARIANT
50     virtual HRESULT STDMETHODCALLTYPE Next(ULONG celt, VARIANT* rgVar, ULONG* pCeltFetched);
51     virtual HRESULT STDMETHODCALLTYPE Skip(ULONG celt);
52     virtual HRESULT STDMETHODCALLTYPE Reset();
53     virtual HRESULT STDMETHODCALLTYPE Clone(_COM_Outptr_opt_ IEnumVARIANT** ppEnum);
54
55 private:
56     COMEnumVariant()
57     {
58     }
59
60     COMEnumVariant(const ContainerType& container)
61         : m_container(container)       
62         , m_currentPos(m_container.begin())
63     {
64     }
65
66     ~COMEnumVariant() {}
67
68     ULONG m_refCount { 0 };
69
70     ContainerType m_container;
71     typename ContainerType::const_iterator m_currentPos;
72 };
73
74 // COMEnumVariant ------------------------------------------------------------------
75 template<typename ContainerType>
76 COMEnumVariant<typename ContainerType>* COMEnumVariant<ContainerType>::adopt(ContainerType& container) 
77 {
78     COMEnumVariant* instance = new COMEnumVariant;
79     instance->m_container.swap(container);
80     instance->m_currentPos = instance->m_container.begin();
81     instance->AddRef();
82     return instance;
83 }
84
85 template<typename ContainerType>
86 COMEnumVariant<typename ContainerType>* COMEnumVariant<ContainerType>::createInstance(const ContainerType& container)
87 {
88     COMEnumVariant* instance = new COMEnumVariant(container);
89     instance->AddRef();
90     return instance;
91 }
92
93 // IUnknown ------------------------------------------------------------------------
94 template<typename ContainerType>
95 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::QueryInterface(_In_ REFIID riid, _COM_Outptr_ void** ppvObject)
96 {
97     if (!ppvObject)
98         return E_POINTER;
99     *ppvObject = nullptr;
100     if (IsEqualGUID(riid, IID_IUnknown))
101         *ppvObject = static_cast<COMEnumVariant*>(this);
102     else if (IsEqualGUID(riid, IID_IEnumVARIANT))
103         *ppvObject = static_cast<COMEnumVariant*>(this);
104     else
105         return E_NOINTERFACE;
106
107     AddRef();
108     return S_OK;
109 }
110
111 template<typename ContainerType>
112 ULONG STDMETHODCALLTYPE COMEnumVariant<ContainerType>::AddRef()
113 {
114     return ++m_refCount;
115 }
116
117 template<typename ContainerType>
118 ULONG STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Release()
119 {
120     ULONG newRef = --m_refCount;
121     if (!newRef)
122         delete this;
123
124     return newRef;
125 }
126
127 // IEnumVARIANT --------------------------------------------------------------------
128 template<typename ContainerType>
129 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Next(ULONG celt, VARIANT* rgVar, ULONG* pCeltFetched)
130 {
131     if (pCeltFetched)
132         *pCeltFetched = 0;
133     if (!rgVar)
134         return E_POINTER;
135     for (unsigned i = 0 ; i < celt; i++)
136         ::VariantInit(&rgVar[i]);
137
138     for (unsigned i = 0; i < celt; i++) {
139         if (m_currentPos == m_container.end())
140             return S_FALSE;
141
142         COMVariantSetter<ContainerType::ValueType>::setVariant(&rgVar[i], *m_currentPos);
143         ++m_currentPos;
144         if (pCeltFetched)
145             (*pCeltFetched)++;
146     }
147
148     return S_OK;
149 }
150
151 template<typename ContainerType>
152 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Skip(ULONG celt) 
153 {
154     for (unsigned i = 0; i < celt; i++) {
155         if (m_currentPos == m_container.end())
156             return S_FALSE;
157
158         ++m_currentPos;
159     }
160     return S_OK;
161 }
162     
163 template<typename ContainerType>
164 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Reset() 
165 {
166     m_currentPos = m_container.begin();
167     return S_OK;
168 }
169     
170 template<typename ContainerType>
171 HRESULT STDMETHODCALLTYPE COMEnumVariant<ContainerType>::Clone(_COM_Outptr_opt_ IEnumVARIANT** ppEnum)
172 {
173     if (!ppEnum)
174         return E_POINTER;
175
176     *ppEnum = nullptr;
177     return E_NOTIMPL;
178 }
179
180 #endif