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 <stdlib.h>
#include <string.h>
24
#include <stdarg.h>
25 26
#include <stdio.h>
#include <ctype.h>
27

28 29
#define COBJMACROS

30
#include "windef.h"
31
#include "winbase.h"
32
#include "objbase.h"
33
#include "oleauto.h"
34
#include "winerror.h"
35

36
#include "wine/debug.h"
37

38
WINE_DEFAULT_DEBUG_CHANNEL(ole);
39 40

/******************************************************************************
41
 *		DispInvoke (OLEAUT32.30)
42
 *
Jon Griffiths's avatar
Jon Griffiths committed
43
 * Call an object method using the information from its type library.
44 45
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
46 47 48 49 50 51
 *  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().
52
 *
Jon Griffiths's avatar
Jon Griffiths committed
53 54 55 56 57 58 59 60 61
 * 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().
62
 */
63
HRESULT WINAPI DispInvoke(
Jon Griffiths's avatar
Jon Griffiths committed
64 65 66 67 68 69 70 71
	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 */
72
{
73
    TRACE("\n");
74

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

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

/******************************************************************************
102
 *		DispGetParam (OLEAUT32.28)
103
 *
104
 * Retrieve a parameter from a DISPPARAMS structure and coerce it to the
Jon Griffiths's avatar
Jon Griffiths committed
105
 * specified variant type.
106 107
 *
 * NOTES
Jon Griffiths's avatar
Jon Griffiths committed
108
 *  Coercion is done using system (0) locale.
109 110
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
111 112 113 114
 *  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.
115
 */
116
HRESULT WINAPI DispGetParam(
Jon Griffiths's avatar
Jon Griffiths committed
117 118 119 120 121
	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 */
122
{
Ove Kaaven's avatar
Ove Kaaven committed
123 124 125 126 127 128
    /* position is counted backwards */
    UINT pos;
    HRESULT hr;

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

130 131
    if (position < pdispparams->cArgs)
    {
Ove Kaaven's avatar
Ove Kaaven committed
132 133
      /* positional arg? */
      pos = pdispparams->cArgs - position - 1;
134 135 136
    }
    else
    {
Ove Kaaven's avatar
Ove Kaaven committed
137 138 139 140 141 142 143
      /* 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;
    }
144 145 146 147 148 149 150 151 152 153 154 155 156

    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
157 158 159
    hr = VariantChangeType(pvarResult,
                           &pdispparams->rgvarg[pos],
                           0, vtTarg);
160 161 162 163 164

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

Ove Kaaven's avatar
Ove Kaaven committed
165
    return hr;
166
}
167

168

Jon Griffiths's avatar
Jon Griffiths committed
169 170 171 172 173 174 175 176 177 178
/******************************************************************************
 * 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
179
 *  languages such as VBA, in order to minimize the amount of COM and C/C++
Jon Griffiths's avatar
Jon Griffiths committed
180 181 182 183 184 185
 *  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
186
 *  accessible programmatically through the ITypeLib interface (for a type library),
Jon Griffiths's avatar
Jon Griffiths committed
187 188 189 190 191 192 193 194
 *  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
195
 *  CreateStdDispatch(). Numeric Id values for the parameters and methods (DISPIDs)
Jon Griffiths's avatar
Jon Griffiths committed
196 197
 *  of an object of interest are retrieved by calling DispGetIDsOfNames(). DispGetParam()
 *  retrieves information about a particular parameter. Finally the DispInvoke()
198
 *  function is responsible for actually calling methods on an object.
Jon Griffiths's avatar
Jon Griffiths committed
199 200 201 202
 *
 * METHODS
 */

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

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

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

    *ppvObject = NULL;
230 231 232 233

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

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

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

    return refCount;
254 255
}

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

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

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

274
    return refCount;
275 276
}

Jon Griffiths's avatar
Jon Griffiths committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
/******************************************************************************
 * 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().
 */
294 295 296
static HRESULT WINAPI StdDispatch_GetTypeInfoCount(LPDISPATCH iface, UINT * pctinfo)
{
    TRACE("(%p)\n", pctinfo);
297
    *pctinfo = 1;
298 299 300
    return S_OK;
}

Jon Griffiths's avatar
Jon Griffiths committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/******************************************************************************
 * 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.
 */
319 320
static HRESULT WINAPI StdDispatch_GetTypeInfo(LPDISPATCH iface, UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo)
{
321
    StdDispatch *This = impl_from_IDispatch(iface);
322
    TRACE("(%d, %x, %p)\n", iTInfo, lcid, ppTInfo);
323

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

328 329 330
    *ppTInfo = This->pTypeInfo;
    ITypeInfo_AddRef(*ppTInfo);

331 332 333
    return S_OK;
}

Jon Griffiths's avatar
Jon Griffiths committed
334 335 336
/******************************************************************************
 * IDispatch_GetIDsOfNames {OLEAUT32}
 *
337
 * Convert a methods name and an optional set of parameter names into DISPIDs
Jon Griffiths's avatar
Jon Griffiths committed
338 339 340 341 342 343 344 345
 * 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
346
 *  rgDispId  [O] Destination for converted DISPIDs.
Jon Griffiths's avatar
Jon Griffiths committed
347 348 349 350 351
 *
 * RETURNS
 *  Success: S_OK.
 *  Failure: DISP_E_UNKNOWNNAME, if any of the names is invalid.
 *           DISP_E_UNKNOWNLCID if lcid is invalid.
352
 *           Otherwise, an HRESULT error code.
Jon Griffiths's avatar
Jon Griffiths committed
353 354 355 356 357 358 359
 *
 * 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.
 */
360 361
static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, LPOLESTR * rgszNames, UINT cNames, LCID lcid, DISPID * rgDispId)
{
362
    StdDispatch *This = impl_from_IDispatch(iface);
363
    TRACE("(%s, %p, %d, 0x%x, %p)\n", debugstr_guid(riid), rgszNames, cNames, lcid, rgDispId);
364 365 366 367 368 369 370 371 372

    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
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
/******************************************************************************
 * 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)
399
{
400
    StdDispatch *This = impl_from_IDispatch(iface);
401
    TRACE("(%d, %s, 0x%x, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);
402 403 404 405 406 407 408 409 410

    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);
}

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

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
/******************************************************************************
 * 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)
439
{
440 441 442 443 444 445
    StdDispatch *pStdDispatch;

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

    if (!pvThis || !ptinfo || !stddisp)
        return E_INVALIDARG;
446 447 448

    pStdDispatch = CoTaskMemAlloc(sizeof(StdDispatch));
    if (!pStdDispatch)
449
        return E_OUTOFMEMORY;
450

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

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

461
    return S_OK;
462
}