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", xmlXPathNodeSetGetLength(This->result->nodesetval));
 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(!ppvObject)
 122         return E_INVALIDARG;
 123
 124     if ( IsEqualGUID( riid, &IID_IUnknown ) ||
 125          IsEqualGUID( riid, &IID_IDispatch ) ||
 126          IsEqualGUID( riid, &IID_IXMLDOMNodeList ) )
 127     {
 128         *ppvObject = iface;
 129     }
 130     else
 131     {
 132         FIXME("interface %s not implemented\n", debugstr_guid(riid));
 133         *ppvObject = NULL;
 134         return E_NOINTERFACE;
 135     }
 136
 137     IXMLDOMNodeList_AddRef( iface );
 138
 139     return S_OK;
 140 }
 141
 142 static ULONG WINAPI queryresult_AddRef(
 143     IXMLDOMNodeList *iface )
 144 {
 145     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 146     return InterlockedIncrement( &This->ref );
 147 }
 148
 149 static ULONG WINAPI queryresult_Release(
 150     IXMLDOMNodeList *iface )
 151 {
 152     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 153     ULONG ref;
 154
 155     ref = InterlockedDecrement(&This->ref);
 156     if ( ref == 0 )
 157     {
 158         xmlXPathFreeObject(This->result);
 159         xmldoc_release(This->node->doc);
 160         CoTaskMemFree(This);
 161     }
 162
 163     return ref;
 164 }
 165
 166 static HRESULT WINAPI queryresult_GetTypeInfoCount(
 167     IXMLDOMNodeList *iface,
 168     UINT* pctinfo )
 169 {
 170     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 171
 172     TRACE("(%p)->(%p)\n", This, pctinfo);
 173
 174     *pctinfo = 1;
 175
 176     return S_OK;
 177 }
 178
 179 static HRESULT WINAPI queryresult_GetTypeInfo(
 180     IXMLDOMNodeList *iface,
 181     UINT iTInfo,
 182     LCID lcid,
 183     ITypeInfo** ppTInfo )
 184 {
 185     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 186     HRESULT hr;
 187
 188     TRACE("(%p)->(%u %u %p)\n", This, iTInfo, lcid, ppTInfo);
 189
 190     hr = get_typeinfo(IXMLDOMNodeList_tid, ppTInfo);
 191
 192     return hr;
 193 }
 194
 195 static HRESULT WINAPI queryresult_GetIDsOfNames(
 196     IXMLDOMNodeList *iface,
 197     REFIID riid,
 198     LPOLESTR* rgszNames,
 199     UINT cNames,
 200     LCID lcid,
 201     DISPID* rgDispId )
 202 {
 203     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 204     ITypeInfo *typeinfo;
 205     HRESULT hr;
 206
 207     TRACE("(%p)->(%s %p %u %u %p)\n", This, debugstr_guid(riid), rgszNames, cNames,
 208           lcid, rgDispId);
 209
 210     if(!rgszNames || cNames == 0 || !rgDispId)
 211         return E_INVALIDARG;
 212
 213     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
 214     if(SUCCEEDED(hr))
 215     {
 216         hr = ITypeInfo_GetIDsOfNames(typeinfo, rgszNames, cNames, rgDispId);
 217         ITypeInfo_Release(typeinfo);
 218     }
 219
 220     return hr;
 221 }
 222
 223 static HRESULT WINAPI queryresult_Invoke(
 224     IXMLDOMNodeList *iface,
 225     DISPID dispIdMember,
 226     REFIID riid,
 227     LCID lcid,
 228     WORD wFlags,
 229     DISPPARAMS* pDispParams,
 230     VARIANT* pVarResult,
 231     EXCEPINFO* pExcepInfo,
 232     UINT* puArgErr )
 233 {
 234     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 235     ITypeInfo *typeinfo;
 236     HRESULT hr;
 237
 238     TRACE("(%p)->(%d %s %d %d %p %p %p %p)\n", This, dispIdMember, debugstr_guid(riid),
 239           lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
 240
 241     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
 242     if(SUCCEEDED(hr))
 243     {
 244         hr = ITypeInfo_Invoke(typeinfo, &(This->lpVtbl), dispIdMember, wFlags, pDispParams,
 245                 pVarResult, pExcepInfo, puArgErr);
 246         ITypeInfo_Release(typeinfo);
 247     }
 248
 249     return hr;
 250 }
 251
 252 static HRESULT WINAPI queryresult_get_item(
 253         IXMLDOMNodeList* iface,
 254         long index,
 255         IXMLDOMNode** listItem)
 256 {
 257     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 258
 259     TRACE("%p %ld\n", This, index);
 260
 261     if(!listItem)
 262         return E_INVALIDARG;
 263
 264     *listItem = NULL;
 265
 266     if (index < 0 || index >= xmlXPathNodeSetGetLength(This->result->nodesetval))
 267         return S_FALSE;
 268
 269     *listItem = create_node(This->result->nodesetval->nodeTab[index]);
 270     This->resultPos = index + 1;
 271
 272     return S_OK;
 273 }
 274
 275 static HRESULT WINAPI queryresult_get_length(
 276         IXMLDOMNodeList* iface,
 277         long* listLength)
 278 {
 279     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 280
 281     TRACE("%p\n", This);
 282
 283     if(!listLength)
 284         return E_INVALIDARG;
 285
 286     *listLength = xmlXPathNodeSetGetLength(This->result->nodesetval);
 287     return S_OK;
 288 }
 289
 290 static HRESULT WINAPI queryresult_nextNode(
 291         IXMLDOMNodeList* iface,
 292         IXMLDOMNode** nextItem)
 293 {
 294     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 295
 296     TRACE("%p %p\n", This, nextItem );
 297
 298     if(!nextItem)
 299         return E_INVALIDARG;
 300
 301     *nextItem = NULL;
 302
 303     if (This->resultPos >= xmlXPathNodeSetGetLength(This->result->nodesetval))
 304         return S_FALSE;
 305
 306     *nextItem = create_node(This->result->nodesetval->nodeTab[This->resultPos]);
 307     This->resultPos++;
 308     return S_OK;
 309 }
 310
 311 static HRESULT WINAPI queryresult_reset(
 312         IXMLDOMNodeList* iface)
 313 {
 314     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 315
 316     TRACE("%p\n", This);
 317     This->resultPos = 0;
 318     return S_OK;
 319 }
 320
 321 static HRESULT WINAPI queryresult__newEnum(
 322         IXMLDOMNodeList* iface,
 323         IUnknown** ppUnk)
 324 {
 325     FIXME("\n");
 326     return E_NOTIMPL;
 327 }
 328
 329
 330 static const struct IXMLDOMNodeListVtbl queryresult_vtbl =
 331 {
 332     queryresult_QueryInterface,
 333     queryresult_AddRef,
 334     queryresult_Release,
 335     queryresult_GetTypeInfoCount,
 336     queryresult_GetTypeInfo,
 337     queryresult_GetIDsOfNames,
 338     queryresult_Invoke,
 339     queryresult_get_item,
 340     queryresult_get_length,
 341     queryresult_nextNode,
 342     queryresult_reset,
 343     queryresult__newEnum,
 344 };
 345
 346 #endif