dispatch.c 15 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 18
 * 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
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
#include "winreg.h"
38
#include "winnls.h"         /* for PRIMARYLANGID */
39

40
#include "wine/debug.h"
41

42
WINE_DEFAULT_DEBUG_CHANNEL(ole);
43

44
static IDispatch * WINAPI StdDispatch_Construct(IUnknown * punkOuter, void * pvThis, ITypeInfo * pTypeInfo);
45 46

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

Jon Griffiths's avatar
Jon Griffiths committed
81 82
    return ITypeInfo_Invoke(ptinfo, _this, dispidMember, wFlags,
                            pparams, pvarResult, pexcepinfo, puArgErr);
83 84 85
}

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

/******************************************************************************
108
 *		DispGetParam (OLEAUT32.28)
109
 *
Jon Griffiths's avatar
Jon Griffiths committed
110 111
 * Retrive a parameter from a DISPPARAMS structure and coerce it to the
 * specified variant type.
112 113
 *
 * NOTES
Jon Griffiths's avatar
Jon Griffiths committed
114
 *  Coercion is done using system (0) locale.
115 116
 *
 * RETURNS
Jon Griffiths's avatar
Jon Griffiths committed
117 118 119 120
 *  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.
121
 */
122
HRESULT WINAPI DispGetParam(
Jon Griffiths's avatar
Jon Griffiths committed
123 124 125 126 127
	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 */
128
{
Ove Kaaven's avatar
Ove Kaaven committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    /* position is counted backwards */
    UINT pos;
    HRESULT hr;

    TRACE("position=%d, cArgs=%d, cNamedArgs=%d\n",
          position, pdispparams->cArgs, pdispparams->cNamedArgs);
    if (position < pdispparams->cArgs) {
      /* positional arg? */
      pos = pdispparams->cArgs - position - 1;
    } else {
      /* 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;
    }
    hr = VariantChangeType(pvarResult,
                           &pdispparams->rgvarg[pos],
                           0, vtTarg);
    if (hr == DISP_E_TYPEMISMATCH) *puArgErr = pos;
    return hr;
151
}
152 153 154

/******************************************************************************
 * CreateStdDispatch [OLEAUT32.32]
Jon Griffiths's avatar
Jon Griffiths committed
155 156 157 158 159 160
 *
 * Create and return a standard IDispatch object.
 *
 * RETURNS
 *  Success: S_OK. ppunkStdDisp contains the new object.
 *  Failure: An HRESULT error code.
161 162 163
 *
 * NOTES
 *  Outer unknown appears to be completely ignored.
164 165 166 167 168 169 170
 */
HRESULT WINAPI CreateStdDispatch(
        IUnknown* punkOuter,
        void* pvThis,
	ITypeInfo* ptinfo,
	IUnknown** ppunkStdDisp)
{
171 172 173 174 175 176
    TRACE("(%p, %p, %p, %p)\n", punkOuter, pvThis, ptinfo, ppunkStdDisp);

    *ppunkStdDisp = (LPUNKNOWN)StdDispatch_Construct(punkOuter, pvThis, ptinfo);
    if (!*ppunkStdDisp)
        return E_OUTOFMEMORY;
    return S_OK;
177 178
}

179

Jon Griffiths's avatar
Jon Griffiths committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
/******************************************************************************
 * 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
Francois Gouget's avatar
Francois Gouget committed
197
 *  accessible programatically through the ITypeLib interface (for a type library),
Jon Griffiths's avatar
Jon Griffiths committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
 *  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
 *  CreateStdDispatch(). Numeric Id values for the parameters and methods (DISPID's)
 *  of an object of interest are retrieved by calling DispGetIDsOfNames(). DispGetParam()
 *  retrieves information about a particular parameter. Finally the DispInvoke()
 *  function is responsable for actually calling methods on an object.
 *
 * METHODS
 */

214 215
typedef struct
{
216
    const IDispatchVtbl *lpVtbl;
217 218
    void * pvThis;
    ITypeInfo * pTypeInfo;
219
    LONG ref;
220 221
} StdDispatch;

Jon Griffiths's avatar
Jon Griffiths committed
222 223 224 225 226
/******************************************************************************
 * IDispatch_QueryInterface {OLEAUT32}
 *
 * See IUnknown_QueryInterface.
 */
227 228 229 230 231
static HRESULT WINAPI StdDispatch_QueryInterface(
  LPDISPATCH iface,
  REFIID riid,
  void** ppvObject)
{
232
    StdDispatch *This = (StdDispatch *)iface;
233 234 235 236 237 238 239 240 241 242 243 244
    TRACE("(%p)->(%s, %p)\n", iface, debugstr_guid(riid), ppvObject);

    if (IsEqualIID(riid, &IID_IDispatch) ||
        IsEqualIID(riid, &IID_IUnknown))
    {
        *ppvObject = (LPVOID)This;
	IUnknown_AddRef((LPUNKNOWN)*ppvObject);
	return S_OK;
    }
    return E_NOINTERFACE;
}

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

255 256 257
    TRACE("(%p)->(ref before=%lu)\n",This, refCount - 1);

    return refCount;
258 259
}

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

270
    TRACE("(%p)->(ref before=%lu)\n", This, refCount + 1);
271

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

278
    return refCount;
279 280
}

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

Jon Griffiths's avatar
Jon Griffiths committed
303
    *pctinfo = This->pTypeInfo ? 1 : 0;
304 305 306
    return S_OK;
}

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

Jon Griffiths's avatar
Jon Griffiths committed
330
    *ppTInfo = NULL;
331 332
    if (iTInfo != 0)
        return DISP_E_BADINDEX;
Jon Griffiths's avatar
Jon Griffiths committed
333 334 335 336 337 338

    if (This->pTypeInfo)
    {
      *ppTInfo = This->pTypeInfo;
      ITypeInfo_AddRef(*ppTInfo);
    }
339 340 341
    return S_OK;
}

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

    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
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
/******************************************************************************
 * 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)
407
{
408
    StdDispatch *This = (StdDispatch *)iface;
409 410 411 412 413 414 415 416 417 418
    TRACE("(%ld, %s, 0x%lx, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);

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

419
static const IDispatchVtbl StdDispatch_VTable =
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
{
  StdDispatch_QueryInterface,
  StdDispatch_AddRef,
  StdDispatch_Release,
  StdDispatch_GetTypeInfoCount,
  StdDispatch_GetTypeInfo,
  StdDispatch_GetIDsOfNames,
  StdDispatch_Invoke
};

static IDispatch * WINAPI StdDispatch_Construct(
  IUnknown * punkOuter,
  void * pvThis,
  ITypeInfo * pTypeInfo)
{
    StdDispatch * pStdDispatch;

    pStdDispatch = CoTaskMemAlloc(sizeof(StdDispatch));
    if (!pStdDispatch)
        return (IDispatch *)pStdDispatch;

    pStdDispatch->lpVtbl = &StdDispatch_VTable;
    pStdDispatch->pvThis = pvThis;
    pStdDispatch->pTypeInfo = pTypeInfo;
    pStdDispatch->ref = 1;

446 447 448 449
    /* we keep a reference to the type info so prevent it from
     * being destroyed until we are done with it */
    ITypeInfo_AddRef(pTypeInfo);

450 451
    return (IDispatch *)pStdDispatch;
}