src/msw/ole/automtn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/ole/automtn.cpp
   3 // Purpose:     OLE automation utilities
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     11/6/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998, Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #if defined(__BORLANDC__)
  16     #pragma hdrstop
  17 #endif
  18
  19 // With Borland C++, all samples crash if this is compiled in.
  20 #if (defined(__BORLANDC__) && (__BORLANDC__ < 0x520)) || defined(__CYGWIN10__)
  21     #undef wxUSE_OLE_AUTOMATION
  22     #define wxUSE_OLE_AUTOMATION 0
  23 #endif
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/log.h"
  27     #include "wx/math.h"
  28 #endif
  29
  30 #define _FORCENAMELESSUNION
  31 #include "wx/msw/private.h"
  32 #include "wx/msw/ole/oleutils.h"
  33 #include "wx/msw/ole/automtn.h"
  34
  35 #ifdef __WXWINCE__
  36 #include "wx/msw/wince/time.h"
  37 #else
  38 #include <time.h>
  39 #endif
  40
  41 #include <wtypes.h>
  42 #include <unknwn.h>
  43
  44 #include <ole2.h>
  45 #define _huge
  46
  47 #ifndef __WXWINCE__
  48 #include <ole2ver.h>
  49 #endif
  50
  51 #include <oleauto.h>
  52
  53 #if wxUSE_DATETIME
  54 #include "wx/datetime.h"
  55 #endif // wxUSE_DATETIME
  56
  57 extern void wxClearVariant(VARIANTARG *pvarg) ;
  58 extern void wxReleaseVariant(VARIANTARG *pvarg) ;
  59 // static void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr);
  60
  61 #if wxUSE_OLE_AUTOMATION
  62
  63 /*
  64  * wxAutomationObject
  65  */
  66
  67 wxAutomationObject::wxAutomationObject(WXIDISPATCH* dispatchPtr)
  68 {
  69     m_dispatchPtr = dispatchPtr;
  70 }
  71
  72 wxAutomationObject::~wxAutomationObject()
  73 {
  74     if (m_dispatchPtr)
  75     {
  76         ((IDispatch*)m_dispatchPtr)->Release();
  77         m_dispatchPtr = NULL;
  78     }
  79 }
  80
  81 #define INVOKEARG(i) (args ? args[i] : *(ptrArgs[i]))
  82
  83 // For Put/Get, no named arguments are allowed.
  84 bool wxAutomationObject::Invoke(const wxString& member, int action,
  85         wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[]) const
  86 {
  87     if (!m_dispatchPtr)
  88         return false;
  89
  90     // nonConstMember is necessary because the wxString class doesn't have enough consts...
  91     wxString nonConstMember(member);
  92
  93     int ch = nonConstMember.Find('.');
  94     if (ch != -1)
  95     {
  96         // Use dot notation to get the next object
  97         wxString member2(nonConstMember.Left((size_t) ch));
  98         wxString rest(nonConstMember.Right(nonConstMember.length() - ch - 1));
  99         wxAutomationObject obj;
 100         if (!GetObject(obj, member2))
 101             return false;
 102         return obj.Invoke(rest, action, retValue, noArgs, args, ptrArgs);
 103     }
 104
 105     VARIANTARG vReturn;
 106     wxClearVariant(& vReturn);
 107
 108     VARIANTARG* vReturnPtr = & vReturn;
 109
 110     // Find number of names args
 111     int namedArgCount = 0;
 112     int i;
 113     for (i = 0; i < noArgs; i++)
 114         if (!INVOKEARG(i).GetName().IsNull())
 115         {
 116             namedArgCount ++;
 117         }
 118
 119     int namedArgStringCount = namedArgCount + 1;
 120     BSTR* argNames = new BSTR[namedArgStringCount];
 121     argNames[0] = wxConvertStringToOle(member);
 122
 123     // Note that arguments are specified in reverse order
 124     // (all totally logical; hey, we're dealing with OLE here.)
 125
 126     int j = 0;
 127     for (i = 0; i < namedArgCount; i++)
 128     {
 129         if (!INVOKEARG(i).GetName().IsNull())
 130         {
 131             argNames[(namedArgCount-j)] = wxConvertStringToOle(INVOKEARG(i).GetName());
 132             j ++;
 133         }
 134     }
 135
 136     // + 1 for the member name, + 1 again in case we're a 'put'
 137     DISPID* dispIds = new DISPID[namedArgCount + 2];
 138
 139     HRESULT hr;
 140     DISPPARAMS dispparams;
 141     unsigned int uiArgErr;
 142
 143     // Get the IDs for the member and its arguments.  GetIDsOfNames expects the
 144     // member name as the first name, followed by argument names (if any).
 145     hr = ((IDispatch*)m_dispatchPtr)->GetIDsOfNames(IID_NULL, argNames,
 146                                 1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
 147     if (FAILED(hr))
 148     {
 149 //        ShowException(szMember, hr, NULL, 0);
 150         delete[] argNames;
 151         delete[] dispIds;
 152         return false;
 153     }
 154
 155     // if doing a property put(ref), we need to adjust the first argument to have a
 156     // named arg of DISPID_PROPERTYPUT.
 157     if (action & (DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF))
 158     {
 159         namedArgCount = 1;
 160         dispIds[1] = DISPID_PROPERTYPUT;
 161         vReturnPtr = NULL;
 162     }
 163
 164     // Convert the wxVariants to VARIANTARGs
 165     VARIANTARG* oleArgs = new VARIANTARG[noArgs];
 166     for (i = 0; i < noArgs; i++)
 167     {
 168         // Again, reverse args
 169         if (!wxConvertVariantToOle(INVOKEARG((noArgs-1) - i), oleArgs[i]))
 170         {
 171             delete[] argNames;
 172             delete[] dispIds;
 173             delete[] oleArgs;
 174             return false;
 175         }
 176     }
 177
 178     dispparams.rgdispidNamedArgs = dispIds + 1;
 179     dispparams.rgvarg = oleArgs;
 180     dispparams.cArgs = noArgs;
 181     dispparams.cNamedArgs = namedArgCount;
 182
 183     EXCEPINFO excep;
 184     wxZeroMemory(excep);
 185
 186     hr = ((IDispatch*)m_dispatchPtr)->Invoke(dispIds[0], IID_NULL, LOCALE_SYSTEM_DEFAULT,
 187                         (WORD)action, &dispparams, vReturnPtr, &excep, &uiArgErr);
 188
 189     for (i = 0; i < namedArgStringCount; i++)
 190     {
 191         SysFreeString(argNames[i]);
 192     }
 193     delete[] argNames;
 194     delete[] dispIds;
 195
 196     for (i = 0; i < noArgs; i++)
 197         wxReleaseVariant(& oleArgs[i]) ;
 198     delete[] oleArgs;
 199
 200     if (FAILED(hr))
 201     {
 202         // display the exception information if appropriate:
 203 //        ShowException((const char*) member, hr, &excep, uiArgErr);
 204
 205         // free exception structure information
 206         SysFreeString(excep.bstrSource);
 207         SysFreeString(excep.bstrDescription);
 208         SysFreeString(excep.bstrHelpFile);
 209
 210         if (vReturnPtr)
 211             wxReleaseVariant(vReturnPtr);
 212         return false;
 213     }
 214     else
 215     {
 216         if (vReturnPtr)
 217         {
 218             // Convert result to wxVariant form
 219             wxConvertOleToVariant(vReturn, retValue);
 220             // Mustn't release the dispatch pointer
 221             if (vReturn.vt == VT_DISPATCH)
 222             {
 223                 vReturn.pdispVal = NULL;
 224             }
 225             wxReleaseVariant(& vReturn);
 226         }
 227     }
 228     return true;
 229 }
 230
 231 // Invoke a member function
 232 wxVariant wxAutomationObject::CallMethod(const wxString& member, int noArgs, wxVariant args[])
 233 {
 234     wxVariant retVariant;
 235     if (!Invoke(member, DISPATCH_METHOD, retVariant, noArgs, args))
 236     {
 237         retVariant.MakeNull();
 238     }
 239     return retVariant;
 240 }
 241
 242 wxVariant wxAutomationObject::CallMethodArray(const wxString& member, int noArgs, const wxVariant **args)
 243 {
 244     wxVariant retVariant;
 245     if (!Invoke(member, DISPATCH_METHOD, retVariant, noArgs, NULL, args))
 246     {
 247         retVariant.MakeNull();
 248     }
 249     return retVariant;
 250 }
 251
 252 wxVariant wxAutomationObject::CallMethod(const wxString& member,
 253         const wxVariant& arg1, const wxVariant& arg2,
 254         const wxVariant& arg3, const wxVariant& arg4,
 255         const wxVariant& arg5, const wxVariant& arg6)
 256 {
 257     const wxVariant** args = new const wxVariant*[6];
 258     int i = 0;
 259     if (!arg1.IsNull())
 260     {
 261         args[i] = & arg1;
 262         i ++;
 263     }
 264     if (!arg2.IsNull())
 265     {
 266         args[i] = & arg2;
 267         i ++;
 268     }
 269     if (!arg3.IsNull())
 270     {
 271         args[i] = & arg3;
 272         i ++;
 273     }
 274     if (!arg4.IsNull())
 275     {
 276         args[i] = & arg4;
 277         i ++;
 278     }
 279     if (!arg5.IsNull())
 280     {
 281         args[i] = & arg5;
 282         i ++;
 283     }
 284     if (!arg6.IsNull())
 285     {
 286         args[i] = & arg6;
 287         i ++;
 288     }
 289     wxVariant retVariant;
 290     if (!Invoke(member, DISPATCH_METHOD, retVariant, i, NULL, args))
 291     {
 292         retVariant.MakeNull();
 293     }
 294     delete[] args;
 295     return retVariant;
 296 }
 297
 298 // Get/Set property
 299 wxVariant wxAutomationObject::GetPropertyArray(const wxString& property, int noArgs, const wxVariant **args) const
 300 {
 301     wxVariant retVariant;
 302     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, NULL, args))
 303     {
 304         retVariant.MakeNull();
 305     }
 306     return retVariant;
 307 }
 308 wxVariant wxAutomationObject::GetProperty(const wxString& property, int noArgs, wxVariant args[]) const
 309 {
 310     wxVariant retVariant;
 311     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 312     {
 313         retVariant.MakeNull();
 314     }
 315     return retVariant;
 316 }
 317
 318 wxVariant wxAutomationObject::GetProperty(const wxString& property,
 319         const wxVariant& arg1, const wxVariant& arg2,
 320         const wxVariant& arg3, const wxVariant& arg4,
 321         const wxVariant& arg5, const wxVariant& arg6)
 322 {
 323     const wxVariant** args = new const wxVariant*[6];
 324     int i = 0;
 325     if (!arg1.IsNull())
 326     {
 327         args[i] = & arg1;
 328         i ++;
 329     }
 330     if (!arg2.IsNull())
 331     {
 332         args[i] = & arg2;
 333         i ++;
 334     }
 335     if (!arg3.IsNull())
 336     {
 337         args[i] = & arg3;
 338         i ++;
 339     }
 340     if (!arg4.IsNull())
 341     {
 342         args[i] = & arg4;
 343         i ++;
 344     }
 345     if (!arg5.IsNull())
 346     {
 347         args[i] = & arg5;
 348         i ++;
 349     }
 350     if (!arg6.IsNull())
 351     {
 352         args[i] = & arg6;
 353         i ++;
 354     }
 355     wxVariant retVariant;
 356     if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, i, NULL, args))
 357     {
 358         retVariant.MakeNull();
 359     }
 360     delete[] args;
 361     return retVariant;
 362 }
 363
 364 bool wxAutomationObject::PutProperty(const wxString& property, int noArgs, wxVariant args[])
 365 {
 366     wxVariant retVariant;
 367     if (!Invoke(property, DISPATCH_PROPERTYPUT, retVariant, noArgs, args))
 368     {
 369         return false;
 370     }
 371     return true;
 372 }
 373
 374 bool wxAutomationObject::PutPropertyArray(const wxString& property, int noArgs, const wxVariant **args)
 375 {
 376     wxVariant retVariant;
 377     if (!Invoke(property, DISPATCH_PROPERTYPUT, retVariant, noArgs, NULL, args))
 378     {
 379         return false;
 380     }
 381     return true;
 382 }
 383
 384 bool wxAutomationObject::PutProperty(const wxString& property,
 385         const wxVariant& arg1, const wxVariant& arg2,
 386         const wxVariant& arg3, const wxVariant& arg4,
 387         const wxVariant& arg5, const wxVariant& arg6)
 388 {
 389     const wxVariant** args = new const wxVariant*[6];
 390     int i = 0;
 391     if (!arg1.IsNull())
 392     {
 393         args[i] = & arg1;
 394         i ++;
 395     }
 396     if (!arg2.IsNull())
 397     {
 398         args[i] = & arg2;
 399         i ++;
 400     }
 401     if (!arg3.IsNull())
 402     {
 403         args[i] = & arg3;
 404         i ++;
 405     }
 406     if (!arg4.IsNull())
 407     {
 408         args[i] = & arg4;
 409         i ++;
 410     }
 411     if (!arg5.IsNull())
 412     {
 413         args[i] = & arg5;
 414         i ++;
 415     }
 416     if (!arg6.IsNull())
 417     {
 418         args[i] = & arg6;
 419         i ++;
 420     }
 421     wxVariant retVariant;
 422     bool ret = Invoke(property, DISPATCH_PROPERTYPUT, retVariant, i, NULL, args);
 423     delete[] args;
 424     return ret;
 425 }
 426
 427
 428 // Uses DISPATCH_PROPERTYGET
 429 // and returns a dispatch pointer. The calling code should call Release
 430 // on the pointer, though this could be implicit by constructing an wxAutomationObject
 431 // with it and letting the destructor call Release.
 432 WXIDISPATCH* wxAutomationObject::GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const
 433 {
 434     wxVariant retVariant;
 435     if (Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 436     {
 437         if (retVariant.GetType() == wxT("void*"))
 438         {
 439             return (WXIDISPATCH*) retVariant.GetVoidPtr();
 440         }
 441     }
 442
 443     return NULL;
 444 }
 445
 446 // Uses DISPATCH_PROPERTYGET
 447 // and returns a dispatch pointer. The calling code should call Release
 448 // on the pointer, though this could be implicit by constructing an wxAutomationObject
 449 // with it and letting the destructor call Release.
 450 WXIDISPATCH* wxAutomationObject::GetDispatchProperty(const wxString& property, int noArgs, const wxVariant **args) const
 451 {
 452     wxVariant retVariant;
 453     if (Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, NULL, args))
 454     {
 455         if (retVariant.GetType() == wxT("void*"))
 456         {
 457             return (WXIDISPATCH*) retVariant.GetVoidPtr();
 458         }
 459     }
 460
 461     return NULL;
 462 }
 463
 464
 465 // A way of initialising another wxAutomationObject with a dispatch object
 466 bool wxAutomationObject::GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, wxVariant args[]) const
 467 {
 468     WXIDISPATCH* dispatch = GetDispatchProperty(property, noArgs, args);
 469     if (dispatch)
 470     {
 471         obj.SetDispatchPtr(dispatch);
 472         return true;
 473     }
 474     else
 475         return false;
 476 }
 477
 478 // A way of initialising another wxAutomationObject with a dispatch object
 479 bool wxAutomationObject::GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, const wxVariant **args) const
 480 {
 481     WXIDISPATCH* dispatch = GetDispatchProperty(property, noArgs, args);
 482     if (dispatch)
 483     {
 484         obj.SetDispatchPtr(dispatch);
 485         return true;
 486     }
 487     else
 488         return false;
 489 }
 490
 491 // Get a dispatch pointer from the current object associated
 492 // with a class id
 493 bool wxAutomationObject::GetInstance(const wxString& classId) const
 494 {
 495     if (m_dispatchPtr)
 496         return false;
 497
 498     CLSID clsId;
 499     IUnknown * pUnk = NULL;
 500
 501     wxBasicString unicodeName(classId);
 502
 503     if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 504     {
 505         wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
 506         return false;
 507     }
 508
 509     if (FAILED(GetActiveObject(clsId, NULL, &pUnk)))
 510     {
 511         wxLogWarning(wxT("Cannot find an active object"));
 512         return false;
 513     }
 514
 515     if (pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr) != S_OK)
 516     {
 517         wxLogWarning(wxT("Cannot find IDispatch interface"));
 518         return false;
 519     }
 520
 521     return true;
 522 }
 523
 524 // Get a dispatch pointer from a new object associated
 525 // with the given class id
 526 bool wxAutomationObject::CreateInstance(const wxString& classId) const
 527 {
 528     if (m_dispatchPtr)
 529         return false;
 530
 531     CLSID clsId;
 532
 533     wxBasicString unicodeName(classId);
 534
 535     if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 536     {
 537         wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
 538         return false;
 539     }
 540
 541     // get the server IDispatch interface
 542     //
 543     // NB: using CLSCTX_INPROC_HANDLER results in failure when getting
 544     //     Automation interface for Microsoft Office applications so don't use
 545     //     CLSCTX_ALL which includes it
 546     if (FAILED(CoCreateInstance(clsId, NULL, CLSCTX_SERVER, IID_IDispatch,
 547                                 (void**)&m_dispatchPtr)))
 548     {
 549         wxLogWarning(wxT("Cannot start an instance of this class."));
 550         return false;
 551     }
 552
 553     return true;
 554 }
 555
 556 #endif // wxUSE_OLE_AUTOMATION
 557
 558 #if 0
 559
 560 void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr)
 561 {
 562     TCHAR szBuf[512];
 563
 564     switch (GetScode(hr))
 565     {
 566         case DISP_E_UNKNOWNNAME:
 567             wsprintf(szBuf, L"%s: Unknown name or named argument.", szMember);
 568             break;
 569
 570         case DISP_E_BADPARAMCOUNT:
 571             wsprintf(szBuf, L"%s: Incorrect number of arguments.", szMember);
 572             break;
 573
 574         case DISP_E_EXCEPTION:
 575             wsprintf(szBuf, L"%s: Error %d: ", szMember, pexcep->wCode);
 576             if (pexcep->bstrDescription != NULL)
 577                 lstrcat(szBuf, pexcep->bstrDescription);
 578             else
 579                 lstrcat(szBuf, L"<<No Description>>");
 580             break;
 581
 582         case DISP_E_MEMBERNOTFOUND:
 583             wsprintf(szBuf, L"%s: method or property not found.", szMember);
 584             break;
 585
 586         case DISP_E_OVERFLOW:
 587             wsprintf(szBuf, L"%s: Overflow while coercing argument values.", szMember);
 588             break;
 589
 590         case DISP_E_NONAMEDARGS:
 591             wsprintf(szBuf, L"%s: Object implementation does not support named arguments.",
 592                         szMember);
 593             break;
 594
 595         case DISP_E_UNKNOWNLCID:
 596             wsprintf(szBuf, L"%s: The locale ID is unknown.", szMember);
 597             break;
 598
 599         case DISP_E_PARAMNOTOPTIONAL:
 600             wsprintf(szBuf, L"%s: Missing a required parameter.", szMember);
 601             break;
 602
 603         case DISP_E_PARAMNOTFOUND:
 604             wsprintf(szBuf, L"%s: Argument not found, argument %d.", szMember, uiArgErr);
 605             break;
 606
 607         case DISP_E_TYPEMISMATCH:
 608             wsprintf(szBuf, L"%s: Type mismatch, argument %d.", szMember, uiArgErr);
 609             break;
 610
 611         default:
 612             wsprintf(szBuf, L"%s: Unknown error occurred.", szMember);
 613             break;
 614     }
 615
 616     wxLogWarning(szBuf);
 617 }
 618
 619 #endif