git.oblomov.eu Git - wine/blob - 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 "msxml6.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 int registerNamespaces(xmlXPathContextPtr ctxt);
  54
  55 typedef struct _queryresult
  56 {
  57     DispatchEx dispex;
  58     const struct IXMLDOMNodeListVtbl *lpVtbl;
  59     LONG ref;
  60     xmlNodePtr node;
  61     xmlXPathObjectPtr result;
  62     int resultPos;
  63 } queryresult;
  64
  65 static inline queryresult *impl_from_IXMLDOMNodeList( IXMLDOMNodeList *iface )
  66 {
  67     return (queryresult *)((char*)iface - FIELD_OFFSET(queryresult, lpVtbl));
  68 }
  69
  70 #define XMLQUERYRES(x)  ((IXMLDOMNodeList*)&(x)->lpVtbl)
  71
  72 static HRESULT WINAPI queryresult_QueryInterface(
  73     IXMLDOMNodeList *iface,
  74     REFIID riid,
  75     void** ppvObject )
  76 {
  77     queryresult *This = impl_from_IXMLDOMNodeList( iface );
  78
  79     TRACE("(%p)->(%s %p)\n", iface, debugstr_guid(riid), ppvObject);
  80
  81     if(!ppvObject)
  82         return E_INVALIDARG;
  83
  84     if ( IsEqualGUID( riid, &IID_IUnknown ) ||
  85          IsEqualGUID( riid, &IID_IXMLDOMNodeList ) )
  86     {
  87         *ppvObject = iface;
  88     }
  89     else if(dispex_query_interface(&This->dispex, riid, ppvObject))
  90     {
  91         return *ppvObject ? S_OK : E_NOINTERFACE;
  92     }
  93     else
  94     {
  95         FIXME("interface %s not implemented\n", debugstr_guid(riid));
  96         *ppvObject = NULL;
  97         return E_NOINTERFACE;
  98     }
  99
 100     IXMLDOMNodeList_AddRef( iface );
 101
 102     return S_OK;
 103 }
 104
 105 static ULONG WINAPI queryresult_AddRef(
 106     IXMLDOMNodeList *iface )
 107 {
 108     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 109     return InterlockedIncrement( &This->ref );
 110 }
 111
 112 static ULONG WINAPI queryresult_Release(
 113     IXMLDOMNodeList *iface )
 114 {
 115     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 116     ULONG ref;
 117
 118     ref = InterlockedDecrement(&This->ref);
 119     if ( ref == 0 )
 120     {
 121         xmlXPathFreeObject(This->result);
 122         xmldoc_release(This->node->doc);
 123         heap_free(This);
 124     }
 125
 126     return ref;
 127 }
 128
 129 static HRESULT WINAPI queryresult_GetTypeInfoCount(
 130     IXMLDOMNodeList *iface,
 131     UINT* pctinfo )
 132 {
 133     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 134
 135     TRACE("(%p)->(%p)\n", This, pctinfo);
 136
 137     *pctinfo = 1;
 138
 139     return S_OK;
 140 }
 141
 142 static HRESULT WINAPI queryresult_GetTypeInfo(
 143     IXMLDOMNodeList *iface,
 144     UINT iTInfo,
 145     LCID lcid,
 146     ITypeInfo** ppTInfo )
 147 {
 148     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 149     HRESULT hr;
 150
 151     TRACE("(%p)->(%u %u %p)\n", This, iTInfo, lcid, ppTInfo);
 152
 153     hr = get_typeinfo(IXMLDOMNodeList_tid, ppTInfo);
 154
 155     return hr;
 156 }
 157
 158 static HRESULT WINAPI queryresult_GetIDsOfNames(
 159     IXMLDOMNodeList *iface,
 160     REFIID riid,
 161     LPOLESTR* rgszNames,
 162     UINT cNames,
 163     LCID lcid,
 164     DISPID* rgDispId )
 165 {
 166     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 167     ITypeInfo *typeinfo;
 168     HRESULT hr;
 169
 170     TRACE("(%p)->(%s %p %u %u %p)\n", This, debugstr_guid(riid), rgszNames, cNames,
 171           lcid, rgDispId);
 172
 173     if(!rgszNames || cNames == 0 || !rgDispId)
 174         return E_INVALIDARG;
 175
 176     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
 177     if(SUCCEEDED(hr))
 178     {
 179         hr = ITypeInfo_GetIDsOfNames(typeinfo, rgszNames, cNames, rgDispId);
 180         ITypeInfo_Release(typeinfo);
 181     }
 182
 183     return hr;
 184 }
 185
 186 static HRESULT WINAPI queryresult_Invoke(
 187     IXMLDOMNodeList *iface,
 188     DISPID dispIdMember,
 189     REFIID riid,
 190     LCID lcid,
 191     WORD wFlags,
 192     DISPPARAMS* pDispParams,
 193     VARIANT* pVarResult,
 194     EXCEPINFO* pExcepInfo,
 195     UINT* puArgErr )
 196 {
 197     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 198     ITypeInfo *typeinfo;
 199     HRESULT hr;
 200
 201     TRACE("(%p)->(%d %s %d %d %p %p %p %p)\n", This, dispIdMember, debugstr_guid(riid),
 202           lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
 203
 204     hr = get_typeinfo(IXMLDOMNodeList_tid, &typeinfo);
 205     if(SUCCEEDED(hr))
 206     {
 207         hr = ITypeInfo_Invoke(typeinfo, &(This->lpVtbl), dispIdMember, wFlags, pDispParams,
 208                 pVarResult, pExcepInfo, puArgErr);
 209         ITypeInfo_Release(typeinfo);
 210     }
 211
 212     return hr;
 213 }
 214
 215 static HRESULT WINAPI queryresult_get_item(
 216         IXMLDOMNodeList* iface,
 217         LONG index,
 218         IXMLDOMNode** listItem)
 219 {
 220     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 221
 222     TRACE("(%p)->(%d %p)\n", This, index, listItem);
 223
 224     if(!listItem)
 225         return E_INVALIDARG;
 226
 227     *listItem = NULL;
 228
 229     if (index < 0 || index >= xmlXPathNodeSetGetLength(This->result->nodesetval))
 230         return S_FALSE;
 231
 232     *listItem = create_node(xmlXPathNodeSetItem(This->result->nodesetval, index));
 233     This->resultPos = index + 1;
 234
 235     return S_OK;
 236 }
 237
 238 static HRESULT WINAPI queryresult_get_length(
 239         IXMLDOMNodeList* iface,
 240         LONG* listLength)
 241 {
 242     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 243
 244     TRACE("(%p)->(%p)\n", This, listLength);
 245
 246     if(!listLength)
 247         return E_INVALIDARG;
 248
 249     *listLength = xmlXPathNodeSetGetLength(This->result->nodesetval);
 250     return S_OK;
 251 }
 252
 253 static HRESULT WINAPI queryresult_nextNode(
 254         IXMLDOMNodeList* iface,
 255         IXMLDOMNode** nextItem)
 256 {
 257     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 258
 259     TRACE("(%p)->(%p)\n", This, nextItem );
 260
 261     if(!nextItem)
 262         return E_INVALIDARG;
 263
 264     *nextItem = NULL;
 265
 266     if (This->resultPos >= xmlXPathNodeSetGetLength(This->result->nodesetval))
 267         return S_FALSE;
 268
 269     *nextItem = create_node(xmlXPathNodeSetItem(This->result->nodesetval, This->resultPos));
 270     This->resultPos++;
 271     return S_OK;
 272 }
 273
 274 static HRESULT WINAPI queryresult_reset(
 275         IXMLDOMNodeList* iface)
 276 {
 277     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 278
 279     TRACE("%p\n", This);
 280     This->resultPos = 0;
 281     return S_OK;
 282 }
 283
 284 static HRESULT WINAPI queryresult__newEnum(
 285         IXMLDOMNodeList* iface,
 286         IUnknown** ppUnk)
 287 {
 288     queryresult *This = impl_from_IXMLDOMNodeList( iface );
 289     FIXME("(%p)->(%p)\n", This, ppUnk);
 290     return E_NOTIMPL;
 291 }
 292
 293
 294 static const struct IXMLDOMNodeListVtbl queryresult_vtbl =
 295 {
 296     queryresult_QueryInterface,
 297     queryresult_AddRef,
 298     queryresult_Release,
 299     queryresult_GetTypeInfoCount,
 300     queryresult_GetTypeInfo,
 301     queryresult_GetIDsOfNames,
 302     queryresult_Invoke,
 303     queryresult_get_item,
 304     queryresult_get_length,
 305     queryresult_nextNode,
 306     queryresult_reset,
 307     queryresult__newEnum,
 308 };
 309
 310 static HRESULT queryresult_get_dispid(IUnknown *iface, BSTR name, DWORD flags, DISPID *dispid)
 311 {
 312     queryresult *This = impl_from_IXMLDOMNodeList( (IXMLDOMNodeList*)iface );
 313     WCHAR *ptr;
 314     int idx = 0;
 315
 316     for(ptr = name; *ptr && isdigitW(*ptr); ptr++)
 317         idx = idx*10 + (*ptr-'0');
 318     if(*ptr)
 319         return DISP_E_UNKNOWNNAME;
 320
 321     if(idx >= xmlXPathNodeSetGetLength(This->result->nodesetval))
 322         return DISP_E_UNKNOWNNAME;
 323
 324     *dispid = MSXML_DISPID_CUSTOM_MIN + idx;
 325     TRACE("ret %x\n", *dispid);
 326     return S_OK;
 327 }
 328
 329 static HRESULT queryresult_invoke(IUnknown *iface, DISPID id, LCID lcid, WORD flags, DISPPARAMS *params,
 330         VARIANT *res, EXCEPINFO *ei)
 331 {
 332     queryresult *This = impl_from_IXMLDOMNodeList( (IXMLDOMNodeList*)iface );
 333
 334     TRACE("(%p)->(%x %x %x %p %p %p)\n", This, id, lcid, flags, params, res, ei);
 335
 336     V_VT(res) = VT_DISPATCH;
 337     V_DISPATCH(res) = NULL;
 338
 339     switch(flags)
 340     {
 341         case INVOKE_PROPERTYGET:
 342         {
 343             IXMLDOMNode *disp = NULL;
 344
 345             queryresult_get_item(XMLQUERYRES(This), id - MSXML_DISPID_CUSTOM_MIN, &disp);
 346             V_DISPATCH(res) = (IDispatch*)disp;
 347             break;
 348         }
 349         default:
 350         {
 351             FIXME("unimplemented flags %x\n", flags);
 352             break;
 353         }
 354     }
 355
 356     TRACE("ret %p\n", V_DISPATCH(res));
 357
 358     return S_OK;
 359 }
 360
 361 static const dispex_static_data_vtbl_t queryresult_dispex_vtbl = {
 362     queryresult_get_dispid,
 363     queryresult_invoke
 364 };
 365
 366 static const tid_t queryresult_iface_tids[] = {
 367     IXMLDOMNodeList_tid,
 368     0
 369 };
 370 static dispex_static_data_t queryresult_dispex = {
 371     &queryresult_dispex_vtbl,
 372     IXMLDOMSelection_tid,
 373     NULL,
 374     queryresult_iface_tids
 375 };
 376
 377 HRESULT queryresult_create(xmlNodePtr node, LPCWSTR szQuery, IXMLDOMNodeList **out)
 378 {
 379     queryresult *This = heap_alloc_zero(sizeof(queryresult));
 380     xmlXPathContextPtr ctxt = xmlXPathNewContext(node->doc);
 381     xmlChar *str = xmlChar_from_wchar(szQuery);
 382     HRESULT hr;
 383
 384     TRACE("(%p, %s, %p)\n", node, wine_dbgstr_w(szQuery), out);
 385
 386     *out = NULL;
 387     if (This == NULL || ctxt == NULL || str == NULL)
 388     {
 389         hr = E_OUTOFMEMORY;
 390         goto cleanup;
 391     }
 392
 393     This->lpVtbl = &queryresult_vtbl;
 394     This->ref = 1;
 395     This->resultPos = 0;
 396     This->node = node;
 397     xmldoc_add_ref(This->node->doc);
 398
 399     ctxt->node = node;
 400     registerNamespaces(ctxt);
 401
 402     This->result = xmlXPathEval(str, ctxt);
 403     if (!This->result || This->result->type != XPATH_NODESET)
 404     {
 405         hr = E_FAIL;
 406         goto cleanup;
 407     }
 408
 409     init_dispex(&This->dispex, (IUnknown*)&This->lpVtbl, &queryresult_dispex);
 410
 411     *out = (IXMLDOMNodeList *) &This->lpVtbl;
 412     hr = S_OK;
 413     TRACE("found %d matches\n", xmlXPathNodeSetGetLength(This->result->nodesetval));
 414
 415 cleanup:
 416     if (This != NULL && FAILED(hr))
 417         IXMLDOMNodeList_Release( (IXMLDOMNodeList*) &This->lpVtbl );
 418     xmlXPathFreeContext(ctxt);
 419     heap_free(str);
 420     return hr;
 421 }
 422
 423 #endif