git.oblomov.eu Git - wine/blob - dlls/oleaut32/dispatch.c

   1 /**
   2  * Dispatch API functions
   3  *
   4  * Copyright 2000  Francois Jacques, Macadamian Technologies Inc.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * TODO: Type coercion is implemented in variant.c but not called yet.
  21  */
  22
  23 #include "config.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <ctype.h>
  29
  30 #include "windef.h"
  31 #include "objbase.h"
  32 #include "oleauto.h"
  33 #include "winerror.h"
  34 #include "winreg.h"         /* for HKEY_LOCAL_MACHINE */
  35 #include "winnls.h"         /* for PRIMARYLANGID */
  36
  37 #include "wine/debug.h"
  38
  39 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  40 WINE_DECLARE_DEBUG_CHANNEL(typelib);
  41
  42 static IDispatch * WINAPI StdDispatch_Construct(IUnknown * punkOuter, void * pvThis, ITypeInfo * pTypeInfo);
  43
  44 /******************************************************************************
  45  *              DispInvoke (OLEAUT32.30)
  46  *
  47  * Call an object method using the information from its type library.
  48  *
  49  * RETURNS
  50  *  Success: S_OK.
  51  *  Failure: Returns DISP_E_EXCEPTION and updates pexcepinfo if an exception occurs.
  52  *           DISP_E_BADPARAMCOUNT if the number of parameters is incorrect.
  53  *           DISP_E_MEMBERNOTFOUND if the method does not exist.
  54  *           puArgErr is updated if a parameter error (see notes) occurs.
  55  *           Otherwise, returns the result of calling ITypeInfo_Invoke().
  56  *
  57  * NOTES
  58  *  Parameter errors include the following:
  59  *| DISP_E_BADVARTYPE
  60  *| E_INVALIDARG            An argument was invalid
  61  *| DISP_E_TYPEMISMATCH,
  62  *| DISP_E_OVERFLOW         An argument was valid but could not be coerced
  63  *| DISP_E_PARAMNOTOPTIONAL A non optional parameter was not passed
  64  *| DISP_E_PARAMNOTFOUND    A parameter was passed that was not expected by the method
  65  *  This call defers to ITypeInfo_Invoke().
  66  */
  67 HRESULT WINAPI DispInvoke(
  68         VOID       *_this,        /* [in] Object to call method on */
  69         ITypeInfo  *ptinfo,       /* [in] Object type info */
  70         DISPID      dispidMember, /* [in] DISPID of the member (e.g. from GetIDsOfNames()) */
  71         USHORT      wFlags,       /* [in] Kind of method call (DISPATCH_ flags from "oaidl.h") */
  72         DISPPARAMS *pparams,      /* [in] Array of method arguments */
  73         VARIANT    *pvarResult,   /* [out] Destination for the result of the call */
  74         EXCEPINFO  *pexcepinfo,   /* [out] Destination for exception information */
  75         UINT       *puArgErr)     /* [out] Destination for bad argument */
  76 {
  77     /**
  78      * TODO:
  79      * For each param, call DispGetParam to perform type coercion
  80      */
  81     FIXME("Coercion of arguments not implemented\n");
  82
  83     return ITypeInfo_Invoke(ptinfo, _this, dispidMember, wFlags,
  84                             pparams, pvarResult, pexcepinfo, puArgErr);
  85 }
  86
  87 /******************************************************************************
  88  *              DispGetIDsOfNames (OLEAUT32.29)
  89  *
  90  * Convert a set of parameter names to DISPID's for DispInvoke().
  91  *
  92  * RETURNS
  93  *  Success: S_OK.
  94  *  Failure: An HRESULT error code.
  95  *
  96  * NOTES
  97  *  This call defers to ITypeInfo_GetIDsOfNames(). The ITypeInfo interface passed
  98  *  as ptinfo contains the information to map names to DISPID's.
  99  */
 100 HRESULT WINAPI DispGetIDsOfNames(
 101         ITypeInfo  *ptinfo,    /* [in] Object's type info */
 102         OLECHAR   **rgszNames, /* [in] Array of names to get DISPID's for */
 103         UINT        cNames,    /* [in] Number of names in rgszNames */
 104         DISPID     *rgdispid)  /* [out] Destination for converted DISPID's */
 105 {
 106     return ITypeInfo_GetIDsOfNames(ptinfo, rgszNames, cNames, rgdispid);
 107 }
 108
 109 /******************************************************************************
 110  *              DispGetParam (OLEAUT32.28)
 111  *
 112  * Retrive a parameter from a DISPPARAMS structure and coerce it to the
 113  * specified variant type.
 114  *
 115  * NOTES
 116  *  Coercion is done using system (0) locale.
 117  *
 118  * RETURNS
 119  *  Success: S_OK.
 120  *  Failure: DISP_E_PARAMNOTFOUND, if position is invalid. or
 121  *           DISP_E_TYPEMISMATCH, if the coercion failed. puArgErr is
 122  *           set to the index of the argument in pdispparams.
 123  */
 124 HRESULT WINAPI DispGetParam(
 125         DISPPARAMS *pdispparams, /* [in] Parameter list */
 126         UINT        position,    /* [in] Position of parameter to coerce in pdispparams */
 127         VARTYPE     vtTarg,      /* [in] Type of value to coerce to */
 128         VARIANT    *pvarResult,  /* [out] Destination for resulting variant */
 129         UINT       *puArgErr)    /* [out] Destination for error code */
 130 {
 131     /* position is counted backwards */
 132     UINT pos;
 133     HRESULT hr;
 134
 135     TRACE("position=%d, cArgs=%d, cNamedArgs=%d\n",
 136           position, pdispparams->cArgs, pdispparams->cNamedArgs);
 137     if (position < pdispparams->cArgs) {
 138       /* positional arg? */
 139       pos = pdispparams->cArgs - position - 1;
 140     } else {
 141       /* FIXME: is this how to handle named args? */
 142       for (pos=0; pos<pdispparams->cNamedArgs; pos++)
 143         if (pdispparams->rgdispidNamedArgs[pos] == position) break;
 144
 145       if (pos==pdispparams->cNamedArgs)
 146         return DISP_E_PARAMNOTFOUND;
 147     }
 148     hr = VariantChangeType(pvarResult,
 149                            &pdispparams->rgvarg[pos],
 150                            0, vtTarg);
 151     if (hr == DISP_E_TYPEMISMATCH) *puArgErr = pos;
 152     return hr;
 153 }
 154
 155 /******************************************************************************
 156  * CreateStdDispatch [OLEAUT32.32]
 157  *
 158  * Create and return a standard IDispatch object.
 159  *
 160  * RETURNS
 161  *  Success: S_OK. ppunkStdDisp contains the new object.
 162  *  Failure: An HRESULT error code.
 163  *
 164  * NOTES
 165  *  Outer unknown appears to be completely ignored.
 166  */
 167 HRESULT WINAPI CreateStdDispatch(
 168         IUnknown* punkOuter,
 169         void* pvThis,
 170         ITypeInfo* ptinfo,
 171         IUnknown** ppunkStdDisp)
 172 {
 173     TRACE("(%p, %p, %p, %p)\n", punkOuter, pvThis, ptinfo, ppunkStdDisp);
 174
 175     *ppunkStdDisp = (LPUNKNOWN)StdDispatch_Construct(punkOuter, pvThis, ptinfo);
 176     if (!*ppunkStdDisp)
 177         return E_OUTOFMEMORY;
 178     return S_OK;
 179 }
 180
 181 /******************************************************************************
 182  * CreateDispTypeInfo [OLEAUT32.31]
 183  *
 184  * Build type information for an object so it can be called through an
 185  * IDispatch interface.
 186  *
 187  * RETURNS
 188  *  Success: S_OK. pptinfo contains the created ITypeInfo object.
 189  *  Failure: E_INVALIDARG, if one or more arguments is invalid.
 190  *
 191  * NOTES
 192  *  This call allows an objects methods to be accessed through IDispatch, by
 193  *  building an ITypeInfo object that IDispatch can use to call through.
 194  */
 195 HRESULT WINAPI CreateDispTypeInfo(
 196         INTERFACEDATA *pidata, /* [I] Description of the interface to build type info for */
 197         LCID lcid, /* [I] Locale Id */
 198         ITypeInfo **pptinfo) /* [O] Destination for created ITypeInfo object */
 199 {
 200         FIXME("(%p,%ld,%p),stub\n",pidata,lcid,pptinfo);
 201         return 0;
 202 }
 203
 204 /******************************************************************************
 205  * IDispatch {OLEAUT32}
 206  *
 207  * NOTES
 208  *  The IDispatch interface provides a single interface to dispatch method calls,
 209  *  regardless of whether the object to be called is in or out of process,
 210  *  local or remote (e.g. being called over a network). This interface is late-bound
 211  *  (linked at run-time), as opposed to early-bound (linked at compile time).
 212  *
 213  *  The interface is used by objects that wish to called by scripting
 214  *  languages such as VBA, in order to minimise the amount of COM and C/C++
 215  *  knowledge required, or by objects that wish to live out of process from code
 216  *  that will call their methods.
 217  *
 218  *  Method, property and parameter names can be localised. The details required to
 219  *  map names to methods and parameters are collected in a type library, usually
 220  *  output by an IDL compiler using the objects IDL description. This information is
 221  *  accessable programatically through the ITypeLib interface (for a type library),
 222  *  and the ITypeInfo interface (for an object within the type library). Type information
 223  *  can also be created at run-time using CreateDispTypeInfo().
 224  *
 225  * WRAPPERS
 226  *  Instead of using IDispatch directly, there are several wrapper functions available
 227  *  to simplify the process of calling an objects methods through IDispatch.
 228  *
 229  *  A standard implementation of an IDispatch object is created by calling
 230  *  CreateStdDispatch(). Numeric Id values for the parameters and methods (DISPID's)
 231  *  of an object of interest are retrieved by calling DispGetIDsOfNames(). DispGetParam()
 232  *  retrieves information about a particular parameter. Finally the DispInvoke()
 233  *  function is responsable for actually calling methods on an object.
 234  *
 235  * METHODS
 236  */
 237
 238 typedef struct
 239 {
 240     ICOM_VFIELD(IDispatch);
 241     void * pvThis;
 242     ITypeInfo * pTypeInfo;
 243     ULONG ref;
 244 } StdDispatch;
 245
 246 /******************************************************************************
 247  * IDispatch_QueryInterface {OLEAUT32}
 248  *
 249  * See IUnknown_QueryInterface.
 250  */
 251 static HRESULT WINAPI StdDispatch_QueryInterface(
 252   LPDISPATCH iface,
 253   REFIID riid,
 254   void** ppvObject)
 255 {
 256     ICOM_THIS(StdDispatch, iface);
 257     TRACE("(%p)->(%s, %p)\n", iface, debugstr_guid(riid), ppvObject);
 258
 259     if (IsEqualIID(riid, &IID_IDispatch) ||
 260         IsEqualIID(riid, &IID_IUnknown))
 261     {
 262         *ppvObject = (LPVOID)This;
 263         IUnknown_AddRef((LPUNKNOWN)*ppvObject);
 264         return S_OK;
 265     }
 266     return E_NOINTERFACE;
 267 }
 268
 269 /******************************************************************************
 270  * IDispatch_AddRef {OLEAUT32}
 271  *
 272  * See IUnknown_AddRef.
 273  */
 274 static ULONG WINAPI StdDispatch_AddRef(LPDISPATCH iface)
 275 {
 276     ICOM_THIS(StdDispatch, iface);
 277     TRACE("()\n");
 278
 279     return ++This->ref;
 280 }
 281
 282 /******************************************************************************
 283  * IDispatch_Release {OLEAUT32}
 284  *
 285  * See IUnknown_Release.
 286  */
 287 static ULONG WINAPI StdDispatch_Release(LPDISPATCH iface)
 288 {
 289     ICOM_THIS(StdDispatch, iface);
 290     ULONG ret;
 291     TRACE("(%p)->()\n", This);
 292
 293     ret = This->ref--;
 294
 295     if (This->ref == 0)
 296     {
 297         ITypeInfo_Release(This->pTypeInfo);
 298         CoTaskMemFree(This);
 299     }
 300
 301     return ret;
 302 }
 303
 304 /******************************************************************************
 305  * IDispatch_GetTypeInfoCount {OLEAUT32}
 306  *
 307  * Get the count of type information in an IDispatch interface.
 308  *
 309  * PARAMS
 310  *  iface   [I] IDispatch interface
 311  *  pctinfo [O] Destination for the count
 312  *
 313  * RETURNS
 314  *  Success: S_OK. pctinfo is updated with the count. This is always 1 if
 315  *           the object provides type information, and 0 if it does not.
 316  *  Failure: E_NOTIMPL. The object does not provide type information.
 317  *
 318  * NOTES
 319  *  See IDispatch() and IDispatch_GetTypeInfo().
 320  */
 321 static HRESULT WINAPI StdDispatch_GetTypeInfoCount(LPDISPATCH iface, UINT * pctinfo)
 322 {
 323     ICOM_THIS(StdDispatch, iface);
 324     TRACE("(%p)\n", pctinfo);
 325
 326     *pctinfo = This->pTypeInfo ? 1 : 0;
 327     return S_OK;
 328 }
 329
 330 /******************************************************************************
 331  * IDispatch_GetTypeInfo {OLEAUT32}
 332  *
 333  * Get type information from an IDispatch interface.
 334  *
 335  * PARAMS
 336  *  iface   [I] IDispatch interface
 337  *  iTInfo  [I] Index of type information.
 338  *  lcid    [I] Locale of the type information to get
 339  *  ppTInfo [O] Destination for the ITypeInfo object
 340  *
 341  * RETURNS
 342  *  Success: S_OK. ppTInfo is updated with the objects type information
 343  *  Failure: DISP_E_BADINDEX, if iTInfo is any value other than 0.
 344  *
 345  * NOTES
 346  *  See IDispatch.
 347  */
 348 static HRESULT WINAPI StdDispatch_GetTypeInfo(LPDISPATCH iface, UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo)
 349 {
 350     ICOM_THIS(StdDispatch, iface);
 351     TRACE("(%d, %lx, %p)\n", iTInfo, lcid, ppTInfo);
 352
 353     *ppTInfo = NULL;
 354     if (iTInfo != 0)
 355         return DISP_E_BADINDEX;
 356
 357     if (This->pTypeInfo)
 358     {
 359       *ppTInfo = This->pTypeInfo;
 360       ITypeInfo_AddRef(*ppTInfo);
 361     }
 362     return S_OK;
 363 }
 364
 365 /******************************************************************************
 366  * IDispatch_GetIDsOfNames {OLEAUT32}
 367  *
 368  * Convert a methods name and an optional set of parameter names into DISPID's
 369  * for passing to IDispatch_Invoke().
 370  *
 371  * PARAMS
 372  *  iface     [I] IDispatch interface
 373  *  riid      [I] Reserved, set to IID_NULL
 374  *  rgszNames [I] Name to convert
 375  *  cNames    [I] Number of names in rgszNames
 376  *  lcid      [I] Locale of the type information to convert from
 377  *  rgDispId  [O] Destination for converted DISPID's.
 378  *
 379  * RETURNS
 380  *  Success: S_OK.
 381  *  Failure: DISP_E_UNKNOWNNAME, if any of the names is invalid.
 382  *           DISP_E_UNKNOWNLCID if lcid is invalid.
 383  *           Otherwise, an An HRESULT error code.
 384  *
 385  * NOTES
 386  *  This call defers to ITypeInfo_GetIDsOfNames(), using the ITypeInfo object
 387  *  contained within the IDispatch object.
 388  *  The first member of the names list must be a method name. The names following
 389  *  the method name are the parameters for that method.
 390  */
 391 static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, LPOLESTR * rgszNames, UINT cNames, LCID lcid, DISPID * rgDispId)
 392 {
 393     ICOM_THIS(StdDispatch, iface);
 394     TRACE("(%s, %p, %d, 0x%lx, %p)\n", debugstr_guid(riid), rgszNames, cNames, lcid, rgDispId);
 395
 396     if (!IsEqualGUID(riid, &IID_NULL))
 397     {
 398         FIXME(" expected riid == IID_NULL\n");
 399         return E_INVALIDARG;
 400     }
 401     return DispGetIDsOfNames(This->pTypeInfo, rgszNames, cNames, rgDispId);
 402 }
 403
 404 /******************************************************************************
 405  * IDispatch_Invoke {OLEAUT32}
 406  *
 407  * Call an object method.
 408  *
 409  * PARAMS
 410  *  iface        [I] IDispatch interface
 411  *  dispIdMember [I] DISPID of the method (from GetIDsOfNames())
 412  *  riid         [I] Reserved, set to IID_NULL
 413  *  lcid         [I] Locale of the type information to convert parameters with
 414  *  wFlags,      [I] Kind of method call (DISPATCH_ flags from "oaidl.h")
 415  *  pDispParams  [I] Array of method arguments
 416  *  pVarResult   [O] Destination for the result of the call
 417  *  pExcepInfo   [O] Destination for exception information
 418  *  puArgErr     [O] Destination for bad argument
 419  *
 420  * RETURNS
 421  *  Success: S_OK.
 422  *  Failure: See DispInvoke() for failure cases.
 423  *
 424  * NOTES
 425  *  See DispInvoke() and IDispatch().
 426  */
 427 static HRESULT WINAPI StdDispatch_Invoke(LPDISPATCH iface, DISPID dispIdMember, REFIID riid, LCID lcid,
 428                                          WORD wFlags, DISPPARAMS * pDispParams, VARIANT * pVarResult,
 429                                          EXCEPINFO * pExcepInfo, UINT * puArgErr)
 430 {
 431     ICOM_THIS(StdDispatch, iface);
 432     TRACE("(%ld, %s, 0x%lx, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
 433
 434     if (!IsEqualGUID(riid, &IID_NULL))
 435     {
 436         FIXME(" expected riid == IID_NULL\n");
 437         return E_INVALIDARG;
 438     }
 439     return DispInvoke(This->pvThis, This->pTypeInfo, dispIdMember, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
 440 }
 441
 442 static ICOM_VTABLE(IDispatch) StdDispatch_VTable =
 443 {
 444   ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
 445   StdDispatch_QueryInterface,
 446   StdDispatch_AddRef,
 447   StdDispatch_Release,
 448   StdDispatch_GetTypeInfoCount,
 449   StdDispatch_GetTypeInfo,
 450   StdDispatch_GetIDsOfNames,
 451   StdDispatch_Invoke
 452 };
 453
 454 static IDispatch * WINAPI StdDispatch_Construct(
 455   IUnknown * punkOuter,
 456   void * pvThis,
 457   ITypeInfo * pTypeInfo)
 458 {
 459     StdDispatch * pStdDispatch;
 460
 461     pStdDispatch = CoTaskMemAlloc(sizeof(StdDispatch));
 462     if (!pStdDispatch)
 463         return (IDispatch *)pStdDispatch;
 464
 465     pStdDispatch->lpVtbl = &StdDispatch_VTable;
 466     pStdDispatch->pvThis = pvThis;
 467     pStdDispatch->pTypeInfo = pTypeInfo;
 468     pStdDispatch->ref = 1;
 469
 470     /* we keep a reference to the type info so prevent it from
 471      * being destroyed until we are done with it */
 472     ITypeInfo_AddRef(pTypeInfo);
 473
 474     return (IDispatch *)pStdDispatch;
 475 }