2 * XPath/XSLPattern query result node list implementation
4 * Copyright 2005 Mike McCormack
5 * Copyright 2007 Mikolaj Zalewski
6 * Copyright 2010 Adam Martinson for CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
29 # include <libxml/parser.h>
30 # include <libxml/xmlerror.h>
31 # include <libxml/xpath.h>
32 # include <libxml/xpathInternals.h>
40 #include "msxml2did.h"
42 #include "msxml_private.h"
44 #include "wine/debug.h"
46 /* This file implements the object returned by a XPath query. Note that this is
47 * not the IXMLDOMNodeList returned by childNodes - it's implemented in nodelist.c.
48 * They are different because the list returned by XPath queries:
49 * - is static - gives the results for the XML tree as it existed during the
50 * execution of the query
51 * - supports IXMLDOMSelection
55 WINE_DEFAULT_DEBUG_CHANNEL(msxml);
59 int registerNamespaces(xmlXPathContextPtr ctxt);
60 xmlChar* XSLPattern_to_XPath(xmlXPathContextPtr ctxt, xmlChar const* xslpat_str);
64 IEnumVARIANT IEnumVARIANT_iface;
72 const struct enumvariant_funcs *funcs;
78 IXMLDOMSelection IXMLDOMSelection_iface;
81 xmlXPathObjectPtr result;
83 IEnumVARIANT *enumvariant;
86 static HRESULT selection_get_item(IUnknown *iface, LONG index, VARIANT* item)
88 V_VT(item) = VT_DISPATCH;
89 return IXMLDOMSelection_get_item((IXMLDOMSelection*)iface, index, (IXMLDOMNode**)&V_DISPATCH(item));
92 static HRESULT selection_next(IUnknown *iface)
95 HRESULT hr = IXMLDOMSelection_nextNode((IXMLDOMSelection*)iface, &node);
96 if (hr == S_OK) IXMLDOMNode_Release(node);
100 static const struct enumvariant_funcs selection_enumvariant = {
105 static inline domselection *impl_from_IXMLDOMSelection( IXMLDOMSelection *iface )
107 return CONTAINING_RECORD(iface, domselection, IXMLDOMSelection_iface);
110 static inline enumvariant *impl_from_IEnumVARIANT( IEnumVARIANT *iface )
112 return CONTAINING_RECORD(iface, enumvariant, IEnumVARIANT_iface);
115 static HRESULT WINAPI domselection_QueryInterface(
116 IXMLDOMSelection *iface,
120 domselection *This = impl_from_IXMLDOMSelection( iface );
122 TRACE("(%p)->(%s %p)\n", iface, debugstr_guid(riid), ppvObject);
127 if ( IsEqualGUID( riid, &IID_IUnknown ) ||
128 IsEqualGUID( riid, &IID_IXMLDOMNodeList ) ||
129 IsEqualGUID( riid, &IID_IXMLDOMSelection ))
131 *ppvObject = &This->IXMLDOMSelection_iface;
133 else if (IsEqualGUID( riid, &IID_IEnumVARIANT ))
135 if (!This->enumvariant)
137 HRESULT hr = create_enumvariant((IUnknown*)iface, FALSE, &selection_enumvariant, &This->enumvariant);
138 if (FAILED(hr)) return hr;
141 return IEnumVARIANT_QueryInterface(This->enumvariant, &IID_IEnumVARIANT, ppvObject);
143 else if (dispex_query_interface(&This->dispex, riid, ppvObject))
145 return *ppvObject ? S_OK : E_NOINTERFACE;
149 TRACE("interface %s not implemented\n", debugstr_guid(riid));
151 return E_NOINTERFACE;
154 IXMLDOMSelection_AddRef( iface );
159 static ULONG WINAPI domselection_AddRef(
160 IXMLDOMSelection *iface )
162 domselection *This = impl_from_IXMLDOMSelection( iface );
163 ULONG ref = InterlockedIncrement( &This->ref );
164 TRACE("(%p)->(%d)\n", This, ref);
168 static ULONG WINAPI domselection_Release(
169 IXMLDOMSelection *iface )
171 domselection *This = impl_from_IXMLDOMSelection( iface );
172 ULONG ref = InterlockedDecrement(&This->ref);
174 TRACE("(%p)->(%d)\n", This, ref);
177 xmlXPathFreeObject(This->result);
178 xmldoc_release(This->node->doc);
179 if (This->enumvariant) IEnumVARIANT_Release(This->enumvariant);
180 release_dispex(&This->dispex);
187 static HRESULT WINAPI domselection_GetTypeInfoCount(
188 IXMLDOMSelection *iface,
191 domselection *This = impl_from_IXMLDOMSelection( iface );
192 return IDispatchEx_GetTypeInfoCount(&This->dispex.IDispatchEx_iface, pctinfo);
195 static HRESULT WINAPI domselection_GetTypeInfo(
196 IXMLDOMSelection *iface,
199 ITypeInfo** ppTInfo )
201 domselection *This = impl_from_IXMLDOMSelection( iface );
202 return IDispatchEx_GetTypeInfo(&This->dispex.IDispatchEx_iface,
203 iTInfo, lcid, ppTInfo);
206 static HRESULT WINAPI domselection_GetIDsOfNames(
207 IXMLDOMSelection *iface,
214 domselection *This = impl_from_IXMLDOMSelection( iface );
215 return IDispatchEx_GetIDsOfNames(&This->dispex.IDispatchEx_iface,
216 riid, rgszNames, cNames, lcid, rgDispId);
219 static HRESULT WINAPI domselection_Invoke(
220 IXMLDOMSelection *iface,
225 DISPPARAMS* pDispParams,
227 EXCEPINFO* pExcepInfo,
230 domselection *This = impl_from_IXMLDOMSelection( iface );
231 return IDispatchEx_Invoke(&This->dispex.IDispatchEx_iface,
232 dispIdMember, riid, lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
235 static HRESULT WINAPI domselection_get_item(
236 IXMLDOMSelection* iface,
238 IXMLDOMNode** listItem)
240 domselection *This = impl_from_IXMLDOMSelection( iface );
242 TRACE("(%p)->(%d %p)\n", This, index, listItem);
249 if (index < 0 || index >= xmlXPathNodeSetGetLength(This->result->nodesetval))
252 *listItem = create_node(xmlXPathNodeSetItem(This->result->nodesetval, index));
253 This->resultPos = index + 1;
258 static HRESULT WINAPI domselection_get_length(
259 IXMLDOMSelection* iface,
262 domselection *This = impl_from_IXMLDOMSelection( iface );
264 TRACE("(%p)->(%p)\n", This, listLength);
269 *listLength = xmlXPathNodeSetGetLength(This->result->nodesetval);
273 static HRESULT WINAPI domselection_nextNode(
274 IXMLDOMSelection* iface,
275 IXMLDOMNode** nextItem)
277 domselection *This = impl_from_IXMLDOMSelection( iface );
279 TRACE("(%p)->(%p)\n", This, nextItem );
286 if (This->resultPos >= xmlXPathNodeSetGetLength(This->result->nodesetval))
289 *nextItem = create_node(xmlXPathNodeSetItem(This->result->nodesetval, This->resultPos));
294 static HRESULT WINAPI domselection_reset(
295 IXMLDOMSelection* iface)
297 domselection *This = impl_from_IXMLDOMSelection( iface );
304 static HRESULT WINAPI domselection_get__newEnum(
305 IXMLDOMSelection* iface,
308 domselection *This = impl_from_IXMLDOMSelection( iface );
310 TRACE("(%p)->(%p)\n", This, enumv);
312 return create_enumvariant((IUnknown*)iface, TRUE, &selection_enumvariant, (IEnumVARIANT**)enumv);
315 static HRESULT WINAPI domselection_get_expr(
316 IXMLDOMSelection* iface,
319 domselection *This = impl_from_IXMLDOMSelection( iface );
320 FIXME("(%p)->(%p)\n", This, p);
324 static HRESULT WINAPI domselection_put_expr(
325 IXMLDOMSelection* iface,
328 domselection *This = impl_from_IXMLDOMSelection( iface );
329 FIXME("(%p)->(%s)\n", This, debugstr_w(p));
333 static HRESULT WINAPI domselection_get_context(
334 IXMLDOMSelection* iface,
337 domselection *This = impl_from_IXMLDOMSelection( iface );
338 FIXME("(%p)->(%p)\n", This, node);
342 static HRESULT WINAPI domselection_putref_context(
343 IXMLDOMSelection* iface,
346 domselection *This = impl_from_IXMLDOMSelection( iface );
347 FIXME("(%p)->(%p)\n", This, node);
351 static HRESULT WINAPI domselection_peekNode(
352 IXMLDOMSelection* iface,
355 domselection *This = impl_from_IXMLDOMSelection( iface );
356 FIXME("(%p)->(%p)\n", This, node);
360 static HRESULT WINAPI domselection_matches(
361 IXMLDOMSelection* iface,
363 IXMLDOMNode **out_node)
365 domselection *This = impl_from_IXMLDOMSelection( iface );
366 FIXME("(%p)->(%p %p)\n", This, node, out_node);
370 static HRESULT WINAPI domselection_removeNext(
371 IXMLDOMSelection* iface,
374 domselection *This = impl_from_IXMLDOMSelection( iface );
375 FIXME("(%p)->(%p)\n", This, node);
379 static HRESULT WINAPI domselection_removeAll(
380 IXMLDOMSelection* iface)
382 domselection *This = impl_from_IXMLDOMSelection( iface );
383 FIXME("(%p)\n", This);
387 static HRESULT WINAPI domselection_clone(
388 IXMLDOMSelection* iface,
389 IXMLDOMSelection **node)
391 domselection *This = impl_from_IXMLDOMSelection( iface );
392 FIXME("(%p)->(%p)\n", This, node);
396 static HRESULT WINAPI domselection_getProperty(
397 IXMLDOMSelection* iface,
401 domselection *This = impl_from_IXMLDOMSelection( iface );
402 FIXME("(%p)->(%s %p)\n", This, debugstr_w(p), var);
406 static HRESULT WINAPI domselection_setProperty(
407 IXMLDOMSelection* iface,
411 domselection *This = impl_from_IXMLDOMSelection( iface );
412 FIXME("(%p)->(%s %s)\n", This, debugstr_w(p), debugstr_variant(&var));
416 static const struct IXMLDOMSelectionVtbl domselection_vtbl =
418 domselection_QueryInterface,
420 domselection_Release,
421 domselection_GetTypeInfoCount,
422 domselection_GetTypeInfo,
423 domselection_GetIDsOfNames,
425 domselection_get_item,
426 domselection_get_length,
427 domselection_nextNode,
429 domselection_get__newEnum,
430 domselection_get_expr,
431 domselection_put_expr,
432 domselection_get_context,
433 domselection_putref_context,
434 domselection_peekNode,
435 domselection_matches,
436 domselection_removeNext,
437 domselection_removeAll,
439 domselection_getProperty,
440 domselection_setProperty
443 /* IEnumVARIANT support */
444 static HRESULT WINAPI enumvariant_QueryInterface(
449 enumvariant *This = impl_from_IEnumVARIANT( iface );
451 TRACE("(%p)->(%s %p)\n", This, debugstr_guid(riid), ppvObject);
455 if (IsEqualGUID( riid, &IID_IUnknown ))
458 *ppvObject = &This->IEnumVARIANT_iface;
460 return IUnknown_QueryInterface(This->outer, riid, ppvObject);
462 else if (IsEqualGUID( riid, &IID_IEnumVARIANT ))
464 *ppvObject = &This->IEnumVARIANT_iface;
467 return IUnknown_QueryInterface(This->outer, riid, ppvObject);
469 IEnumVARIANT_AddRef( iface );
474 static ULONG WINAPI enumvariant_AddRef(IEnumVARIANT *iface )
476 enumvariant *This = impl_from_IEnumVARIANT( iface );
477 ULONG ref = InterlockedIncrement( &This->ref );
478 TRACE("(%p)->(%d)\n", This, ref);
482 static ULONG WINAPI enumvariant_Release(IEnumVARIANT *iface )
484 enumvariant *This = impl_from_IEnumVARIANT( iface );
485 ULONG ref = InterlockedDecrement(&This->ref);
487 TRACE("(%p)->(%d)\n", This, ref);
490 if (This->own) IUnknown_Release(This->outer);
497 static HRESULT WINAPI enumvariant_Next(
503 enumvariant *This = impl_from_IEnumVARIANT( iface );
506 TRACE("(%p)->(%u %p %p)\n", This, celt, var, fetched);
508 if (fetched) *fetched = 0;
510 if (celt && !var) return E_INVALIDARG;
512 for (; celt > 0; celt--, var++, This->pos++)
514 HRESULT hr = This->funcs->get_item(This->outer, This->pos, var);
517 V_VT(var) = VT_EMPTY;
523 if (fetched) (*fetched)++;
525 /* we need to advance one step more for some reason */
528 if (This->funcs->next)
529 This->funcs->next(This->outer);
532 return celt == 0 ? S_OK : S_FALSE;
535 static HRESULT WINAPI enumvariant_Skip(
539 enumvariant *This = impl_from_IEnumVARIANT( iface );
540 FIXME("(%p)->(%u): stub\n", This, celt);
544 static HRESULT WINAPI enumvariant_Reset(IEnumVARIANT *iface)
546 enumvariant *This = impl_from_IEnumVARIANT( iface );
547 FIXME("(%p): stub\n", This);
551 static HRESULT WINAPI enumvariant_Clone(
552 IEnumVARIANT *iface, IEnumVARIANT **ppenum)
554 enumvariant *This = impl_from_IEnumVARIANT( iface );
555 FIXME("(%p)->(%p): stub\n", This, ppenum);
559 static const struct IEnumVARIANTVtbl EnumVARIANTVtbl =
561 enumvariant_QueryInterface,
570 HRESULT create_enumvariant(IUnknown *outer, BOOL own, const struct enumvariant_funcs *funcs, IEnumVARIANT **penum)
574 This = heap_alloc(sizeof(enumvariant));
575 if (!This) return E_OUTOFMEMORY;
577 This->IEnumVARIANT_iface.lpVtbl = &EnumVARIANTVtbl;
585 IUnknown_AddRef(This->outer);
587 *penum = &This->IEnumVARIANT_iface;
588 IEnumVARIANT_AddRef(*penum);
592 static HRESULT domselection_get_dispid(IUnknown *iface, BSTR name, DWORD flags, DISPID *dispid)
597 for(ptr = name; *ptr && isdigitW(*ptr); ptr++)
598 idx = idx*10 + (*ptr-'0');
600 return DISP_E_UNKNOWNNAME;
602 *dispid = DISPID_DOM_COLLECTION_BASE + idx;
603 TRACE("ret %x\n", *dispid);
607 static HRESULT domselection_invoke(IUnknown *iface, DISPID id, LCID lcid, WORD flags, DISPPARAMS *params,
608 VARIANT *res, EXCEPINFO *ei)
610 domselection *This = impl_from_IXMLDOMSelection( (IXMLDOMSelection*)iface );
612 TRACE("(%p)->(%x %x %x %p %p %p)\n", This, id, lcid, flags, params, res, ei);
614 V_VT(res) = VT_DISPATCH;
615 V_DISPATCH(res) = NULL;
617 if (id < DISPID_DOM_COLLECTION_BASE || id > DISPID_DOM_COLLECTION_MAX)
618 return DISP_E_UNKNOWNNAME;
622 case INVOKE_PROPERTYGET:
624 IXMLDOMNode *disp = NULL;
626 IXMLDOMSelection_get_item(&This->IXMLDOMSelection_iface, id - DISPID_DOM_COLLECTION_BASE, &disp);
627 V_DISPATCH(res) = (IDispatch*)disp;
632 FIXME("unimplemented flags %x\n", flags);
637 TRACE("ret %p\n", V_DISPATCH(res));
642 static const dispex_static_data_vtbl_t domselection_dispex_vtbl = {
643 domselection_get_dispid,
647 static const tid_t domselection_iface_tids[] = {
648 IXMLDOMSelection_tid,
651 static dispex_static_data_t domselection_dispex = {
652 &domselection_dispex_vtbl,
653 IXMLDOMSelection_tid,
655 domselection_iface_tids
658 #define XSLPATTERN_CHECK_ARGS(n) \
660 FIXME("XSLPattern syntax error: Expected %i arguments, got %i\n", n, nargs); \
661 xmlXPathSetArityError(pctx); \
666 static void XSLPattern_index(xmlXPathParserContextPtr pctx, int nargs)
668 XSLPATTERN_CHECK_ARGS(0);
670 xmlXPathPositionFunction(pctx, 0);
671 xmlXPathReturnNumber(pctx, xmlXPathPopNumber(pctx) - 1.0);
674 static void XSLPattern_end(xmlXPathParserContextPtr pctx, int nargs)
677 XSLPATTERN_CHECK_ARGS(0);
679 xmlXPathPositionFunction(pctx, 0);
680 pos = xmlXPathPopNumber(pctx);
681 xmlXPathLastFunction(pctx, 0);
682 last = xmlXPathPopNumber(pctx);
683 xmlXPathReturnBoolean(pctx, pos == last);
686 static void XSLPattern_nodeType(xmlXPathParserContextPtr pctx, int nargs)
688 XSLPATTERN_CHECK_ARGS(0);
689 xmlXPathReturnNumber(pctx, pctx->context->node->type);
692 static void XSLPattern_OP_IEq(xmlXPathParserContextPtr pctx, int nargs)
694 xmlChar *arg1, *arg2;
695 XSLPATTERN_CHECK_ARGS(2);
697 arg2 = xmlXPathPopString(pctx);
698 arg1 = xmlXPathPopString(pctx);
699 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) == 0);
704 static void XSLPattern_OP_INEq(xmlXPathParserContextPtr pctx, int nargs)
706 xmlChar *arg1, *arg2;
707 XSLPATTERN_CHECK_ARGS(2);
709 arg2 = xmlXPathPopString(pctx);
710 arg1 = xmlXPathPopString(pctx);
711 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) != 0);
716 static void XSLPattern_OP_ILt(xmlXPathParserContextPtr pctx, int nargs)
718 xmlChar *arg1, *arg2;
719 XSLPATTERN_CHECK_ARGS(2);
721 arg2 = xmlXPathPopString(pctx);
722 arg1 = xmlXPathPopString(pctx);
723 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) < 0);
728 static void XSLPattern_OP_ILEq(xmlXPathParserContextPtr pctx, int nargs)
730 xmlChar *arg1, *arg2;
731 XSLPATTERN_CHECK_ARGS(2);
733 arg2 = xmlXPathPopString(pctx);
734 arg1 = xmlXPathPopString(pctx);
735 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) <= 0);
740 static void XSLPattern_OP_IGt(xmlXPathParserContextPtr pctx, int nargs)
742 xmlChar *arg1, *arg2;
743 XSLPATTERN_CHECK_ARGS(2);
745 arg2 = xmlXPathPopString(pctx);
746 arg1 = xmlXPathPopString(pctx);
747 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) > 0);
752 static void XSLPattern_OP_IGEq(xmlXPathParserContextPtr pctx, int nargs)
754 xmlChar *arg1, *arg2;
755 XSLPATTERN_CHECK_ARGS(2);
757 arg2 = xmlXPathPopString(pctx);
758 arg1 = xmlXPathPopString(pctx);
759 xmlXPathReturnBoolean(pctx, xmlStrcasecmp(arg1, arg2) >= 0);
764 static void query_serror(void* ctx, xmlErrorPtr err)
766 LIBXML2_CALLBACK_SERROR(domselection_create, err);
769 HRESULT create_selection(xmlNodePtr node, xmlChar* query, IXMLDOMNodeList **out)
771 domselection *This = heap_alloc(sizeof(domselection));
772 xmlXPathContextPtr ctxt = xmlXPathNewContext(node->doc);
775 TRACE("(%p, %s, %p)\n", node, debugstr_a((char const*)query), out);
778 if (!This || !ctxt || !query)
780 xmlXPathFreeContext(ctxt);
782 return E_OUTOFMEMORY;
785 This->IXMLDOMSelection_iface.lpVtbl = &domselection_vtbl;
789 This->enumvariant = NULL;
790 init_dispex(&This->dispex, (IUnknown*)&This->IXMLDOMSelection_iface, &domselection_dispex);
791 xmldoc_add_ref(This->node->doc);
793 ctxt->error = query_serror;
795 registerNamespaces(ctxt);
797 if (is_xpathmode(This->node->doc))
799 xmlXPathRegisterAllFunctions(ctxt);
800 This->result = xmlXPathEvalExpression(query, ctxt);
804 xmlChar* pattern_query = XSLPattern_to_XPath(ctxt, query);
806 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"not", xmlXPathNotFunction);
807 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"boolean", xmlXPathBooleanFunction);
809 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"index", XSLPattern_index);
810 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"end", XSLPattern_end);
811 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"nodeType", XSLPattern_nodeType);
813 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_IEq", XSLPattern_OP_IEq);
814 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_INEq", XSLPattern_OP_INEq);
815 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_ILt", XSLPattern_OP_ILt);
816 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_ILEq", XSLPattern_OP_ILEq);
817 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_IGt", XSLPattern_OP_IGt);
818 xmlXPathRegisterFunc(ctxt, (xmlChar const*)"OP_IGEq", XSLPattern_OP_IGEq);
820 This->result = xmlXPathEvalExpression(pattern_query, ctxt);
821 xmlFree(pattern_query);
824 if (!This->result || This->result->type != XPATH_NODESET)
830 *out = (IXMLDOMNodeList*)&This->IXMLDOMSelection_iface;
832 TRACE("found %d matches\n", xmlXPathNodeSetGetLength(This->result->nodesetval));
835 if (This && FAILED(hr))
836 IXMLDOMSelection_Release( &This->IXMLDOMSelection_iface );
837 xmlXPathFreeContext(ctxt);