msxml3: Improved checking of failed case.
[wine] / dlls / msxml3 / queryresult.c
1 /*
2  *    XPath query result node list implementation (TODO: XSLPattern support)
3  *
4  * Copyright 2005 Mike McCormack
5  * Copyright 2007 Mikolaj Zalewski
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #define COBJMACROS
23
24 #include "config.h"
25
26 #include <stdarg.h>
27 #include "windef.h"
28 #include "winbase.h"
29 #include "winuser.h"
30 #include "ole2.h"
31 #include "msxml2.h"
32
33 #include "msxml_private.h"
34
35 #include "wine/debug.h"
36
37 /* This file implements the object returned by a XPath query. Note that this is
38  * not the IXMLDOMNodeList returned by childNodes - it's implemented in nodelist.c.
39  * They are different because the list returned by XPath queries:
40  *  - is static - gives the results for the XML tree as it existed during the
41  *    execution of the query
42  *  - supports IXMLDOMSelection (TODO)
43  *
44  * TODO: XSLPattern support
45  */
46
47 WINE_DEFAULT_DEBUG_CHANNEL(msxml);
48
49 #ifdef HAVE_LIBXML2
50
51 #include <libxml/xpath.h>
52
53 static const struct IXMLDOMNodeListVtbl queryresult_vtbl;
54
55 typedef struct _queryresult
56 {
57     const struct IXMLDOMNodeListVtbl *lpVtbl;
58     LONG ref;
59     xmlNodePtr node;
60     xmlXPathObjectPtr result;
61     int resultPos;
62 } queryresult;
63
64 static inline queryresult *impl_from_IXMLDOMNodeList( IXMLDOMNodeList *iface )
65 {
66     return (queryresult *)((char*)iface - FIELD_OFFSET(queryresult, lpVtbl));
67 }
68
69 HRESULT queryresult_create(xmlNodePtr node, LPWSTR szQuery, IXMLDOMNodeList **out)
70 {
71     queryresult *This = CoTaskMemAlloc(sizeof(queryresult));
72     xmlXPathContextPtr ctxt = xmlXPathNewContext(node->doc);
73     xmlChar *str = xmlChar_from_wchar(szQuery);
74     HRESULT hr;
75
76
77     TRACE("(%p, %s, %p)\n", node, wine_dbgstr_w(szQuery), out);
78
79     *out = NULL;
80     if (This == NULL || ctxt == NULL || str == NULL)
81     {
82         hr = E_OUTOFMEMORY;
83         goto cleanup;
84     }
85
86     This->lpVtbl = &queryresult_vtbl;
87     This->ref = 1;
88     This->resultPos = 0;
89     This->node = node;
90     xmldoc_add_ref(This->node->doc);
91
92     ctxt->node = node;
93     This->result = xmlXPathEval(str, ctxt);
94     if (!This->result || This->result->type != XPATH_NODESET)
95     {
96         hr = E_FAIL;
97         goto cleanup;
98     }
99
100     *out = (IXMLDOMNodeList *)This;
101     hr = S_OK;
102     TRACE("found %d matches\n", This->result->nodesetval->nodeNr);
103
104 cleanup:
105     if (This != NULL && FAILED(hr))
106         IXMLDOMNodeList_Release( (IXMLDOMNodeList*) &This->lpVtbl );
107     if (ctxt != NULL)
108         xmlXPathFreeContext(ctxt);
109     HeapFree(GetProcessHeap(), 0, str);
110     return hr;
111 }
112
113
114 static HRESULT WINAPI queryresult_QueryInterface(
115     IXMLDOMNodeList *iface,
116     REFIID riid,
117     void** ppvObject )
118 {
119     TRACE("%p %s %p\n", iface, debugstr_guid(riid), ppvObject);
120
121     if ( IsEqualGUID( riid, &IID_IUnknown ) ||
122          IsEqualGUID( riid, &IID_IDispatch ) ||
123          IsEqualGUID( riid, &IID_IXMLDOMNodeList ) )
124     {
125         *ppvObject = iface;
126     }
127     else
128     {
129         FIXME("interface %s not implemented\n", debugstr_guid(riid));
130         *ppvObject = NULL;
131         return E_NOINTERFACE;
132     }
133
134     IXMLDOMNodeList_AddRef( iface );
135
136     return S_OK;
137 }
138
139 static ULONG WINAPI queryresult_AddRef(
140     IXMLDOMNodeList *iface )
141 {
142     queryresult *This = impl_from_IXMLDOMNodeList( iface );
143     return InterlockedIncrement( &This->ref );
144 }
145
146 static ULONG WINAPI queryresult_Release(
147     IXMLDOMNodeList *iface )
148 {
149     queryresult *This = impl_from_IXMLDOMNodeList( iface );
150     ULONG ref;
151
152     ref = InterlockedDecrement(&This->ref);
153     if ( ref == 0 )
154     {
155         xmlXPathFreeObject(This->result);
156         xmldoc_release(This->node->doc);
157         CoTaskMemFree(This);
158     }
159
160     return ref;
161 }
162
163 static HRESULT WINAPI queryresult_GetTypeInfoCount(
164     IXMLDOMNodeList *iface,
165     UINT* pctinfo )
166 {
167     queryresult *This = impl_from_IXMLDOMNodeList( iface );
168
169     TRACE("(%p)->(%p)\n", This, pctinfo);
170
171     *pctinfo = 1;
172
173     return S_OK;
174 }
175
176 static HRESULT WINAPI queryresult_GetTypeInfo(
177     IXMLDOMNodeList *iface,
178     UINT iTInfo,
179     LCID lcid,
180     ITypeInfo** ppTInfo )
181 {
182     queryresult *This = impl_from_IXMLDOMNodeList( iface );
183     HRESULT hr;
184
185     TRACE("(%p)->(%u %u %p)\n", This, iTInfo, lcid, ppTInfo);
186
187     hr = get_typeinfo(IXMLDOMNodeList_tid, ppTInfo);
188
189     return hr;
190 }
191
192 static HRESULT WINAPI queryresult_GetIDsOfNames(
193     IXMLDOMNodeList *iface,
194     REFIID riid,
195     LPOLESTR* rgszNames,
196     UINT cNames,
197     LCID lcid,
198     DISPID* rgDispId )
199 {
200     queryresult *This = impl_from_IXMLDOMNodeList( iface );
201     ITypeInfo *typeinfo;
202     HRESULT hr;
203
204     TRACE("(%p)->(%s %p %u %u %p)\n", This, debugstr_guid(riid), rgszNames, cNames,
205           lcid, rgDispId);
206
207     if(!rgszNames || cNames == 0 || !rgDispId)
208         return E_INVALIDARG;
209
210     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
211     if(SUCCEEDED(hr))
212     {
213         hr = ITypeInfo_GetIDsOfNames(typeinfo, rgszNames, cNames, rgDispId);
214         ITypeInfo_Release(typeinfo);
215     }
216
217     return hr;
218 }
219
220 static HRESULT WINAPI queryresult_Invoke(
221     IXMLDOMNodeList *iface,
222     DISPID dispIdMember,
223     REFIID riid,
224     LCID lcid,
225     WORD wFlags,
226     DISPPARAMS* pDispParams,
227     VARIANT* pVarResult,
228     EXCEPINFO* pExcepInfo,
229     UINT* puArgErr )
230 {
231     queryresult *This = impl_from_IXMLDOMNodeList( iface );
232     ITypeInfo *typeinfo;
233     HRESULT hr;
234
235     TRACE("(%p)->(%d %s %d %d %p %p %p %p)\n", This, dispIdMember, debugstr_guid(riid),
236           lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
237
238     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
239     if(SUCCEEDED(hr))
240     {
241         hr = ITypeInfo_Invoke(typeinfo, &(This->lpVtbl), dispIdMember, wFlags, pDispParams,
242                 pVarResult, pExcepInfo, puArgErr);
243         ITypeInfo_Release(typeinfo);
244     }
245
246     return hr;
247 }
248
249 static HRESULT WINAPI queryresult_get_item(
250         IXMLDOMNodeList* iface,
251         long index,
252         IXMLDOMNode** listItem)
253 {
254     queryresult *This = impl_from_IXMLDOMNodeList( iface );
255
256     TRACE("%p %ld\n", This, index);
257
258     *listItem = NULL;
259
260     if (index < 0 || index >= This->result->nodesetval->nodeNr)
261         return S_FALSE;
262
263     *listItem = create_node(This->result->nodesetval->nodeTab[index]);
264     This->resultPos = index + 1;
265
266     return S_OK;
267 }
268
269 static HRESULT WINAPI queryresult_get_length(
270         IXMLDOMNodeList* iface,
271         long* listLength)
272 {
273     queryresult *This = impl_from_IXMLDOMNodeList( iface );
274
275     TRACE("%p\n", This);
276
277     *listLength = This->result->nodesetval->nodeNr;
278     return S_OK;
279 }
280
281 static HRESULT WINAPI queryresult_nextNode(
282         IXMLDOMNodeList* iface,
283         IXMLDOMNode** nextItem)
284 {
285     queryresult *This = impl_from_IXMLDOMNodeList( iface );
286
287     TRACE("%p %p\n", This, nextItem );
288
289     *nextItem = NULL;
290
291     if (This->resultPos >= This->result->nodesetval->nodeNr)
292         return S_FALSE;
293
294     *nextItem = create_node(This->result->nodesetval->nodeTab[This->resultPos]);
295     This->resultPos++;
296     return S_OK;
297 }
298
299 static HRESULT WINAPI queryresult_reset(
300         IXMLDOMNodeList* iface)
301 {
302     queryresult *This = impl_from_IXMLDOMNodeList( iface );
303
304     TRACE("%p\n", This);
305     This->resultPos = 0;
306     return S_OK;
307 }
308
309 static HRESULT WINAPI queryresult__newEnum(
310         IXMLDOMNodeList* iface,
311         IUnknown** ppUnk)
312 {
313     FIXME("\n");
314     return E_NOTIMPL;
315 }
316
317
318 static const struct IXMLDOMNodeListVtbl queryresult_vtbl =
319 {
320     queryresult_QueryInterface,
321     queryresult_AddRef,
322     queryresult_Release,
323     queryresult_GetTypeInfoCount,
324     queryresult_GetTypeInfo,
325     queryresult_GetIDsOfNames,
326     queryresult_Invoke,
327     queryresult_get_item,
328     queryresult_get_length,
329     queryresult_nextNode,
330     queryresult_reset,
331     queryresult__newEnum,
332 };
333
334 #endif