dispatch.c 14.9 KB
Newer Older
1 2 3 4 5
/**
 * Dispatch API functions
 *
 * Copyright 2000  Francois Jacques, Macadamian Technologies Inc.
 *
6 7 8 9 10 11 12 13 14 15 16 17
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 20 21
 *
 */

22 23
#include "config.h"

24 25
#include <stdlib.h>
#include <string.h>
26
#include <stdarg.h>
27 28
#include <stdio.h>
#include <ctype.h>
29

30 31
#define COBJMACROS

32
#include "windef.h"
33
#include "winbase.h"
34
#include "objbase.h"
35
#include "oleauto.h"
36
#include "winerror.h"
37

38
#include "wine/debug.h"
39

40
WINE_DEFAULT_DEBUG_CHANNEL(ole);
41 42

/******************************************************************************
43
 *		DispInvoke (OLEAUT32.30)
44
 *
Jon Griffiths's avatar
Jon Griffiths committed
45
 * Call an object method using the information from its type library.
46 47
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
48 49 50 51 52 53
 *  Success: S_OK.
 *  Failure: Returns DISP_E_EXCEPTION and updates pexcepinfo if an exception occurs.
 *           DISP_E_BADPARAMCOUNT if the number of parameters is incorrect.
 *           DISP_E_MEMBERNOTFOUND if the method does not exist.
 *           puArgErr is updated if a parameter error (see notes) occurs.
 *           Otherwise, returns the result of calling ITypeInfo_Invoke().
54
 *
Jon Griffiths's avatar
Jon Griffiths committed
55 56 57 58 59 60 61 62 63
 * NOTES
 *  Parameter errors include the following:
 *| DISP_E_BADVARTYPE
 *| E_INVALIDARG            An argument was invalid
 *| DISP_E_TYPEMISMATCH,
 *| DISP_E_OVERFLOW         An argument was valid but could not be coerced
 *| DISP_E_PARAMNOTOPTIONAL A non optional parameter was not passed
 *| DISP_E_PARAMNOTFOUND    A parameter was passed that was not expected by the method
 *  This call defers to ITypeInfo_Invoke().
64
 */
65
HRESULT WINAPI DispInvoke(
Jon Griffiths's avatar
Jon Griffiths committed
66 67 68 69 70 71 72 73
	VOID       *_this,        /* [in] Object to call method on */
	ITypeInfo  *ptinfo,       /* [in] Object type info */
	DISPID      dispidMember, /* [in] DISPID of the member (e.g. from GetIDsOfNames()) */
	USHORT      wFlags,       /* [in] Kind of method call (DISPATCH_ flags from "oaidl.h") */
	DISPPARAMS *pparams,      /* [in] Array of method arguments */
	VARIANT    *pvarResult,   /* [out] Destination for the result of the call */
	EXCEPINFO  *pexcepinfo,   /* [out] Destination for exception information */
	UINT       *puArgErr)     /* [out] Destination for bad argument */
74
{
75
    TRACE("\n");
76

Jon Griffiths's avatar
Jon Griffiths committed
77 78
    return ITypeInfo_Invoke(ptinfo, _this, dispidMember, wFlags,
                            pparams, pvarResult, pexcepinfo, puArgErr);
79 80 81
}

/******************************************************************************
82
 *		DispGetIDsOfNames (OLEAUT32.29)
83
 *
84
 * Convert a set of parameter names to DISPIDs for DispInvoke().
85 86
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
87 88
 *  Success: S_OK.
 *  Failure: An HRESULT error code.
89
 *
Jon Griffiths's avatar
Jon Griffiths committed
90 91
 * NOTES
 *  This call defers to ITypeInfo_GetIDsOfNames(). The ITypeInfo interface passed
92
 *  as ptinfo contains the information to map names to DISPIDs.
93
 */
94
HRESULT WINAPI DispGetIDsOfNames(
Jon Griffiths's avatar
Jon Griffiths committed
95
	ITypeInfo  *ptinfo,    /* [in] Object's type info */
96
	OLECHAR   **rgszNames, /* [in] Array of names to get DISPIDs for */
Jon Griffiths's avatar
Jon Griffiths committed
97
	UINT        cNames,    /* [in] Number of names in rgszNames */
98
	DISPID     *rgdispid)  /* [out] Destination for converted DISPIDs */
99
{
Jon Griffiths's avatar
Jon Griffiths committed
100
    return ITypeInfo_GetIDsOfNames(ptinfo, rgszNames, cNames, rgdispid);
101 102 103
}

/******************************************************************************
104
 *		DispGetParam (OLEAUT32.28)
105
 *
106
 * Retrieve a parameter from a DISPPARAMS structure and coerce it to the
Jon Griffiths's avatar
Jon Griffiths committed
107
 * specified variant type.
108 109
 *
 * NOTES
Jon Griffiths's avatar
Jon Griffiths committed
110
 *  Coercion is done using system (0) locale.
111 112
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
113 114 115 116
 *  Success: S_OK.
 *  Failure: DISP_E_PARAMNOTFOUND, if position is invalid. or
 *           DISP_E_TYPEMISMATCH, if the coercion failed. puArgErr is
 *           set to the index of the argument in pdispparams.
117
 */
118
HRESULT WINAPI DispGetParam(
Jon Griffiths's avatar
Jon Griffiths committed
119 120 121 122 123
	DISPPARAMS *pdispparams, /* [in] Parameter list */
	UINT        position,    /* [in] Position of parameter to coerce in pdispparams */
	VARTYPE     vtTarg,      /* [in] Type of value to coerce to */
	VARIANT    *pvarResult,  /* [out] Destination for resulting variant */
	UINT       *puArgErr)    /* [out] Destination for error code */
124
{
Ove Kaaven's avatar
Ove Kaaven committed
125 126 127 128 129 130
    /* position is counted backwards */
    UINT pos;
    HRESULT hr;

    TRACE("position=%d, cArgs=%d, cNamedArgs=%d\n",
          position, pdispparams->cArgs, pdispparams->cNamedArgs);
131

132 133
    if (position < pdispparams->cArgs)
    {
Ove Kaaven's avatar
Ove Kaaven committed
134 135
      /* positional arg? */
      pos = pdispparams->cArgs - position - 1;
136 137 138
    }
    else
    {
Ove Kaaven's avatar
Ove Kaaven committed
139 140 141 142 143 144 145
      /* FIXME: is this how to handle named args? */
      for (pos=0; pos<pdispparams->cNamedArgs; pos++)
        if (pdispparams->rgdispidNamedArgs[pos] == position) break;

      if (pos==pdispparams->cNamedArgs)
        return DISP_E_PARAMNOTFOUND;
    }
146 147 148 149 150 151 152 153 154 155 156 157 158

    if (pdispparams->cArgs > 0 && !pdispparams->rgvarg)
    {
        hr = E_INVALIDARG;
        goto done;
    }

    if (!pvarResult)
    {
        hr = E_INVALIDARG;
        goto done;
    }

Ove Kaaven's avatar
Ove Kaaven committed
159 160 161
    hr = VariantChangeType(pvarResult,
                           &pdispparams->rgvarg[pos],
                           0, vtTarg);
162 163 164 165 166

done:
    if (FAILED(hr))
        *puArgErr = pos;

Ove Kaaven's avatar
Ove Kaaven committed
167
    return hr;
168
}
169

170

Jon Griffiths's avatar
Jon Griffiths committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
/******************************************************************************
 * IDispatch {OLEAUT32}
 *
 * NOTES
 *  The IDispatch interface provides a single interface to dispatch method calls,
 *  regardless of whether the object to be called is in or out of process,
 *  local or remote (e.g. being called over a network). This interface is late-bound
 *  (linked at run-time), as opposed to early-bound (linked at compile time).
 *
 *  The interface is used by objects that wish to called by scripting
 *  languages such as VBA, in order to minimise the amount of COM and C/C++
 *  knowledge required, or by objects that wish to live out of process from code
 *  that will call their methods.
 *
 *  Method, property and parameter names can be localised. The details required to
 *  map names to methods and parameters are collected in a type library, usually
 *  output by an IDL compiler using the objects IDL description. This information is
188
 *  accessible programmatically through the ITypeLib interface (for a type library),
Jon Griffiths's avatar
Jon Griffiths committed
189 190 191 192 193 194 195 196
 *  and the ITypeInfo interface (for an object within the type library). Type information
 *  can also be created at run-time using CreateDispTypeInfo().
 *
 * WRAPPERS
 *  Instead of using IDispatch directly, there are several wrapper functions available
 *  to simplify the process of calling an objects methods through IDispatch.
 *
 *  A standard implementation of an IDispatch object is created by calling
197
 *  CreateStdDispatch(). Numeric Id values for the parameters and methods (DISPIDs)
Jon Griffiths's avatar
Jon Griffiths committed
198 199
 *  of an object of interest are retrieved by calling DispGetIDsOfNames(). DispGetParam()
 *  retrieves information about a particular parameter. Finally the DispInvoke()
200
 *  function is responsible for actually calling methods on an object.
Jon Griffiths's avatar
Jon Griffiths committed
201 202 203 204
 *
 * METHODS
 */

205 206
typedef struct
{
207
    IDispatch IDispatch_iface;
208 209
    void * pvThis;
    ITypeInfo * pTypeInfo;
210
    LONG ref;
211 212
} StdDispatch;

213 214 215 216 217
static inline StdDispatch *impl_from_IDispatch(IDispatch *iface)
{
    return CONTAINING_RECORD(iface, StdDispatch, IDispatch_iface);
}

Jon Griffiths's avatar
Jon Griffiths committed
218 219 220 221 222
/******************************************************************************
 * IDispatch_QueryInterface {OLEAUT32}
 *
 * See IUnknown_QueryInterface.
 */
223 224 225 226 227
static HRESULT WINAPI StdDispatch_QueryInterface(
  LPDISPATCH iface,
  REFIID riid,
  void** ppvObject)
{
228
    StdDispatch *This = impl_from_IDispatch(iface);
229 230 231
    TRACE("(%p)->(%s, %p)\n", This, debugstr_guid(riid), ppvObject);

    *ppvObject = NULL;
232 233 234 235

    if (IsEqualIID(riid, &IID_IDispatch) ||
        IsEqualIID(riid, &IID_IUnknown))
    {
236 237
        *ppvObject = iface;
        IDispatch_AddRef(iface);
238
        return S_OK;
239 240 241 242
    }
    return E_NOINTERFACE;
}

Jon Griffiths's avatar
Jon Griffiths committed
243 244 245 246 247
/******************************************************************************
 * IDispatch_AddRef {OLEAUT32}
 *
 * See IUnknown_AddRef.
 */
248 249
static ULONG WINAPI StdDispatch_AddRef(LPDISPATCH iface)
{
250
    StdDispatch *This = impl_from_IDispatch(iface);
251
    ULONG refCount = InterlockedIncrement(&This->ref);
252

253
    TRACE("(%p)->(ref before=%u)\n",This, refCount - 1);
254 255

    return refCount;
256 257
}

Jon Griffiths's avatar
Jon Griffiths committed
258 259 260 261 262
/******************************************************************************
 * IDispatch_Release {OLEAUT32}
 *
 * See IUnknown_Release.
 */
263 264
static ULONG WINAPI StdDispatch_Release(LPDISPATCH iface)
{
265
    StdDispatch *This = impl_from_IDispatch(iface);
266
    ULONG refCount = InterlockedDecrement(&This->ref);
267

268
    TRACE("(%p)->(ref before=%u)\n", This, refCount + 1);
269

270
    if (!refCount)
271 272
    {
        ITypeInfo_Release(This->pTypeInfo);
273
        CoTaskMemFree(This);
274
    }
275

276
    return refCount;
277 278
}

Jon Griffiths's avatar
Jon Griffiths committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
/******************************************************************************
 * IDispatch_GetTypeInfoCount {OLEAUT32}
 *
 * Get the count of type information in an IDispatch interface.
 *
 * PARAMS
 *  iface   [I] IDispatch interface
 *  pctinfo [O] Destination for the count
 *
 * RETURNS
 *  Success: S_OK. pctinfo is updated with the count. This is always 1 if
 *           the object provides type information, and 0 if it does not.
 *  Failure: E_NOTIMPL. The object does not provide type information.
 *
 * NOTES
 *  See IDispatch() and IDispatch_GetTypeInfo().
 */
296 297 298
static HRESULT WINAPI StdDispatch_GetTypeInfoCount(LPDISPATCH iface, UINT * pctinfo)
{
    TRACE("(%p)\n", pctinfo);
299
    *pctinfo = 1;
300 301 302
    return S_OK;
}

Jon Griffiths's avatar
Jon Griffiths committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
/******************************************************************************
 * IDispatch_GetTypeInfo {OLEAUT32}
 *
 * Get type information from an IDispatch interface.
 *
 * PARAMS
 *  iface   [I] IDispatch interface
 *  iTInfo  [I] Index of type information.
 *  lcid    [I] Locale of the type information to get
 *  ppTInfo [O] Destination for the ITypeInfo object
 *
 * RETURNS
 *  Success: S_OK. ppTInfo is updated with the objects type information
 *  Failure: DISP_E_BADINDEX, if iTInfo is any value other than 0.
 *
 * NOTES
 *  See IDispatch.
 */
321 322
static HRESULT WINAPI StdDispatch_GetTypeInfo(LPDISPATCH iface, UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo)
{
323
    StdDispatch *This = impl_from_IDispatch(iface);
324
    TRACE("(%d, %x, %p)\n", iTInfo, lcid, ppTInfo);
325

Jon Griffiths's avatar
Jon Griffiths committed
326
    *ppTInfo = NULL;
327 328
    if (iTInfo != 0)
        return DISP_E_BADINDEX;
Jon Griffiths's avatar
Jon Griffiths committed
329

330 331 332
    *ppTInfo = This->pTypeInfo;
    ITypeInfo_AddRef(*ppTInfo);

333 334 335
    return S_OK;
}

Jon Griffiths's avatar
Jon Griffiths committed
336 337 338
/******************************************************************************
 * IDispatch_GetIDsOfNames {OLEAUT32}
 *
339
 * Convert a methods name and an optional set of parameter names into DISPIDs
Jon Griffiths's avatar
Jon Griffiths committed
340 341 342 343 344 345 346 347
 * for passing to IDispatch_Invoke().
 *
 * PARAMS
 *  iface     [I] IDispatch interface
 *  riid      [I] Reserved, set to IID_NULL
 *  rgszNames [I] Name to convert
 *  cNames    [I] Number of names in rgszNames
 *  lcid      [I] Locale of the type information to convert from
348
 *  rgDispId  [O] Destination for converted DISPIDs.
Jon Griffiths's avatar
Jon Griffiths committed
349 350 351 352 353
 *
 * RETURNS
 *  Success: S_OK.
 *  Failure: DISP_E_UNKNOWNNAME, if any of the names is invalid.
 *           DISP_E_UNKNOWNLCID if lcid is invalid.
354
 *           Otherwise, an HRESULT error code.
Jon Griffiths's avatar
Jon Griffiths committed
355 356 357 358 359 360 361
 *
 * NOTES
 *  This call defers to ITypeInfo_GetIDsOfNames(), using the ITypeInfo object
 *  contained within the IDispatch object.
 *  The first member of the names list must be a method name. The names following
 *  the method name are the parameters for that method.
 */
362 363
static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, LPOLESTR * rgszNames, UINT cNames, LCID lcid, DISPID * rgDispId)
{
364
    StdDispatch *This = impl_from_IDispatch(iface);
365
    TRACE("(%s, %p, %d, 0x%x, %p)\n", debugstr_guid(riid), rgszNames, cNames, lcid, rgDispId);
366 367 368 369 370 371 372 373 374

    if (!IsEqualGUID(riid, &IID_NULL))
    {
        FIXME(" expected riid == IID_NULL\n");
        return E_INVALIDARG;
    }
    return DispGetIDsOfNames(This->pTypeInfo, rgszNames, cNames, rgDispId);
}

Jon Griffiths's avatar
Jon Griffiths committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
/******************************************************************************
 * IDispatch_Invoke {OLEAUT32}
 *
 * Call an object method.
 *
 * PARAMS
 *  iface        [I] IDispatch interface
 *  dispIdMember [I] DISPID of the method (from GetIDsOfNames())
 *  riid         [I] Reserved, set to IID_NULL
 *  lcid         [I] Locale of the type information to convert parameters with
 *  wFlags,      [I] Kind of method call (DISPATCH_ flags from "oaidl.h")
 *  pDispParams  [I] Array of method arguments
 *  pVarResult   [O] Destination for the result of the call
 *  pExcepInfo   [O] Destination for exception information
 *  puArgErr     [O] Destination for bad argument
 *
 * RETURNS
 *  Success: S_OK.
 *  Failure: See DispInvoke() for failure cases.
 *
 * NOTES
 *  See DispInvoke() and IDispatch().
 */
static HRESULT WINAPI StdDispatch_Invoke(LPDISPATCH iface, DISPID dispIdMember, REFIID riid, LCID lcid,
                                         WORD wFlags, DISPPARAMS * pDispParams, VARIANT * pVarResult,
                                         EXCEPINFO * pExcepInfo, UINT * puArgErr)
401
{
402
    StdDispatch *This = impl_from_IDispatch(iface);
403
    TRACE("(%d, %s, 0x%x, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
404 405 406 407 408 409 410 411 412

    if (!IsEqualGUID(riid, &IID_NULL))
    {
        FIXME(" expected riid == IID_NULL\n");
        return E_INVALIDARG;
    }
    return DispInvoke(This->pvThis, This->pTypeInfo, dispIdMember, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
}

413
static const IDispatchVtbl StdDispatch_VTable =
414 415 416 417 418 419 420 421 422 423
{
  StdDispatch_QueryInterface,
  StdDispatch_AddRef,
  StdDispatch_Release,
  StdDispatch_GetTypeInfoCount,
  StdDispatch_GetTypeInfo,
  StdDispatch_GetIDsOfNames,
  StdDispatch_Invoke
};

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
/******************************************************************************
 * CreateStdDispatch [OLEAUT32.32]
 *
 * Create and return a standard IDispatch object.
 *
 * RETURNS
 *  Success: S_OK. ppunkStdDisp contains the new object.
 *  Failure: An HRESULT error code.
 *
 * NOTES
 *  Outer unknown appears to be completely ignored.
 */
HRESULT WINAPI CreateStdDispatch(
        IUnknown* punkOuter,
        void* pvThis,
	ITypeInfo* ptinfo,
	IUnknown** stddisp)
441
{
442 443 444 445 446 447
    StdDispatch *pStdDispatch;

    TRACE("(%p, %p, %p, %p)\n", punkOuter, pvThis, ptinfo, stddisp);

    if (!pvThis || !ptinfo || !stddisp)
        return E_INVALIDARG;
448 449 450

    pStdDispatch = CoTaskMemAlloc(sizeof(StdDispatch));
    if (!pStdDispatch)
451
        return E_OUTOFMEMORY;
452

453
    pStdDispatch->IDispatch_iface.lpVtbl = &StdDispatch_VTable;
454
    pStdDispatch->pvThis = pvThis;
455
    pStdDispatch->pTypeInfo = ptinfo;
456 457
    pStdDispatch->ref = 1;

458 459
    /* we keep a reference to the type info so prevent it from
     * being destroyed until we are done with it */
460 461
    ITypeInfo_AddRef(ptinfo);
    *stddisp = (IUnknown*)&pStdDispatch->IDispatch_iface;
462

463
    return S_OK;
464
}