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 #if wxUSE_OLE_AUTOMATION
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/log.h"
  29     #include "wx/math.h"
  30 #endif
  31
  32 #define _FORCENAMELESSUNION
  33 #include "wx/msw/private.h"
  34 #include "wx/msw/ole/oleutils.h"
  35 #include "wx/msw/ole/automtn.h"
  36
  37 #ifdef __WXWINCE__
  38 #include "wx/msw/wince/time.h"
  39 #else
  40 #include <time.h>
  41 #endif
  42
  43 #include <wtypes.h>
  44 #include <unknwn.h>
  45
  46 #include <ole2.h>
  47 #define _huge
  48
  49 #ifndef __WXWINCE__
  50 #include <ole2ver.h>
  51 #endif
  52
  53 #include <oleauto.h>
  54
  55 #if wxUSE_DATETIME
  56 #include "wx/datetime.h"
  57 #endif // wxUSE_DATETIME
  58
  59 static void ClearVariant(VARIANTARG *pvarg) ;
  60 static void ReleaseVariant(VARIANTARG *pvarg) ;
  61 // static void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr);
  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     ClearVariant(& 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     EXCEPINFO excep;
 143
 144     // Get the IDs for the member and its arguments.  GetIDsOfNames expects the
 145     // member name as the first name, followed by argument names (if any).
 146     hr = ((IDispatch*)m_dispatchPtr)->GetIDsOfNames(IID_NULL, argNames,
 147                                 1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
 148     if (FAILED(hr))
 149     {
 150 //        ShowException(szMember, hr, NULL, 0);
 151         delete[] argNames;
 152         delete[] dispIds;
 153         return false;
 154     }
 155
 156     // if doing a property put(ref), we need to adjust the first argument to have a
 157     // named arg of DISPID_PROPERTYPUT.
 158     if (action & (DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF))
 159     {
 160         namedArgCount = 1;
 161         dispIds[1] = DISPID_PROPERTYPUT;
 162         vReturnPtr = NULL;
 163     }
 164
 165     // Convert the wxVariants to VARIANTARGs
 166     VARIANTARG* oleArgs = new VARIANTARG[noArgs];
 167     for (i = 0; i < noArgs; i++)
 168     {
 169         // Again, reverse args
 170         if (!wxConvertVariantToOle(INVOKEARG((noArgs-1) - i), oleArgs[i]))
 171         {
 172             delete[] argNames;
 173             delete[] dispIds;
 174             delete[] oleArgs;
 175             return false;
 176         }
 177     }
 178
 179     dispparams.rgdispidNamedArgs = dispIds + 1;
 180     dispparams.rgvarg = oleArgs;
 181     dispparams.cArgs = noArgs;
 182     dispparams.cNamedArgs = namedArgCount;
 183
 184     excep.pfnDeferredFillIn = NULL;
 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         ReleaseVariant(& 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             ReleaseVariant(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             ReleaseVariant(& 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
 557 WXDLLEXPORT bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant)
 558 {
 559     ClearVariant(&oleVariant);
 560     if (variant.IsNull())
 561     {
 562         oleVariant.vt = VT_NULL;
 563         return true;
 564     }
 565
 566     wxString type(variant.GetType());
 567
 568
 569     if (type == wxT("long"))
 570     {
 571         oleVariant.vt = VT_I4;
 572         oleVariant.lVal = variant.GetLong() ;
 573     }
 574     // cVal not always present
 575 #ifndef __GNUWIN32__
 576     else if (type == wxT("char"))
 577     {
 578         oleVariant.vt=VT_I1;            // Signed Char
 579         oleVariant.cVal=variant.GetChar();
 580     }
 581 #endif
 582     else if (type == wxT("double"))
 583     {
 584         oleVariant.vt = VT_R8;
 585         oleVariant.dblVal = variant.GetDouble();
 586     }
 587     else if (type == wxT("bool"))
 588     {
 589         oleVariant.vt = VT_BOOL;
 590         // 'bool' required for VC++ 4 apparently
 591 #if (defined(__VISUALC__) && (__VISUALC__ <= 1000))
 592         oleVariant.bool = variant.GetBool();
 593 #else
 594         oleVariant.boolVal = variant.GetBool();
 595 #endif
 596     }
 597     else if (type == wxT("string"))
 598     {
 599         wxString str( variant.GetString() );
 600         oleVariant.vt = VT_BSTR;
 601         oleVariant.bstrVal = wxConvertStringToOle(str);
 602     }
 603 #if wxUSE_DATETIME
 604     else if (type == wxT("datetime"))
 605     {
 606         wxDateTime date( variant.GetDateTime() );
 607         oleVariant.vt = VT_DATE;
 608
 609         SYSTEMTIME st;
 610         date.GetAsMSWSysTime(&st);
 611
 612         SystemTimeToVariantTime(&st, &oleVariant.date);
 613     }
 614 #endif
 615     else if (type == wxT("void*"))
 616     {
 617         oleVariant.vt = VT_DISPATCH;
 618         oleVariant.pdispVal = (IDispatch*) variant.GetVoidPtr();
 619     }
 620     else if (type == wxT("list") || type == wxT("stringlist"))
 621     {
 622         oleVariant.vt = VT_VARIANT | VT_ARRAY;
 623
 624         SAFEARRAY *psa;
 625         SAFEARRAYBOUND saBound;
 626         VARIANTARG *pvargBase;
 627         VARIANTARG *pvarg;
 628         int i, j;
 629
 630         int iCount = variant.GetCount();
 631
 632         saBound.lLbound = 0;
 633         saBound.cElements = iCount;
 634
 635         psa = SafeArrayCreate(VT_VARIANT, 1, &saBound);
 636         if (psa == NULL)
 637             return false;
 638
 639         SafeArrayAccessData(psa, (void**)&pvargBase);
 640
 641         pvarg = pvargBase;
 642         for (i = 0; i < iCount; i++)
 643         {
 644             // copy each string in the list of strings
 645             wxVariant eachVariant(variant[i]);
 646             if (!wxConvertVariantToOle(eachVariant, * pvarg))
 647             {
 648                 // memory failure:  back out and free strings alloc'ed up to
 649                 // now, and then the array itself.
 650                 pvarg = pvargBase;
 651                 for (j = 0; j < i; j++)
 652                 {
 653                     SysFreeString(pvarg->bstrVal);
 654                     pvarg++;
 655                 }
 656                 SafeArrayDestroy(psa);
 657                 return false;
 658             }
 659             pvarg++;
 660         }
 661
 662         SafeArrayUnaccessData(psa);
 663
 664         oleVariant.parray = psa;
 665     }
 666     else
 667     {
 668         oleVariant.vt = VT_NULL;
 669         return false;
 670     }
 671     return true;
 672 }
 673
 674 #ifndef VT_TYPEMASK
 675 #define VT_TYPEMASK 0xfff
 676 #endif
 677
 678 WXDLLEXPORT bool
 679 wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant)
 680 {
 681     bool ok = true;
 682     if ( oleVariant.vt & VT_ARRAY )
 683     {
 684
 685         // Compute the total number of elements in all array dimensions
 686         int cElements = 1;
 687         for ( int cDims = 0; cDims < oleVariant.parray->cDims; cDims++ )
 688             cElements *= oleVariant.parray->rgsabound[cDims].cElements;
 689
 690         // Get a pointer to the data
 691         void* pvdata;
 692         HRESULT hr = SafeArrayAccessData(oleVariant.parray, &pvdata);
 693         if ( FAILED(hr) )
 694             return false;
 695
 696         switch (oleVariant.vt & VT_TYPEMASK)
 697         {
 698             case VT_VARIANT:
 699                 {
 700                     variant.ClearList();
 701                     VARIANTARG *variant_data=(VARIANTARG*)pvdata;
 702                     for ( int i = 0; i < cElements; i++ )
 703                     {
 704                         VARIANTARG& oleElement = variant_data[i];
 705                         wxVariant vElement;
 706                         if ( !wxConvertOleToVariant(oleElement, vElement) )
 707                         {
 708                             ok = false;
 709                             variant.ClearList();
 710                             break;
 711                         }
 712
 713                         variant.Append(vElement);
 714                     }
 715                 }
 716                 break;
 717
 718             case VT_BSTR:
 719                 {
 720                     wxArrayString strings;
 721                     BSTR *string_val=(BSTR*)pvdata;
 722                     for ( int i = 0; i < cElements; ++i )
 723                     {
 724                         wxString str=wxConvertStringFromOle(*string_val);
 725                         strings.Add(str);
 726                         ++string_val;
 727                     }
 728                     variant=strings;
 729                 }
 730                 break;
 731
 732             default:
 733                 wxLogDebug(wxT("unhandled VT_ARRAY type %x in wxConvertOleToVariant"),
 734                            oleVariant.vt & VT_TYPEMASK);
 735                 variant = wxVariant();
 736                 ok = false;
 737                 break;
 738         }
 739
 740         SafeArrayUnaccessData(oleVariant.parray);
 741     }
 742     else if ( oleVariant.vt & VT_BYREF )
 743     {
 744         switch ( oleVariant.vt & VT_TYPEMASK )
 745         {
 746             case VT_VARIANT:
 747                 {
 748                     VARIANTARG& oleReference = *((LPVARIANT)oleVariant.byref);
 749                     if (!wxConvertOleToVariant(oleReference,variant))
 750                         return false;
 751                     break;
 752                 }
 753
 754             default:
 755                 wxLogError(wxT("wxAutomationObject::ConvertOleToVariant: [as yet] unhandled reference %X"),
 756                             oleVariant.vt);
 757                 return false;
 758         }
 759     }
 760     else // simply type (not array or reference)
 761     {
 762         switch ( oleVariant.vt & VT_TYPEMASK )
 763         {
 764             case VT_BSTR:
 765                 {
 766                     wxString str(wxConvertStringFromOle(oleVariant.bstrVal));
 767                     variant = str;
 768                 }
 769                 break;
 770
 771             case VT_DATE:
 772 #if wxUSE_DATETIME
 773                 {
 774                     SYSTEMTIME st;
 775                     VariantTimeToSystemTime(oleVariant.date, &st);
 776
 777                     wxDateTime date;
 778                     date.SetFromMSWSysTime(st);
 779                     variant = date;
 780                 }
 781 #endif // wxUSE_DATETIME
 782                 break;
 783
 784             case VT_I4:
 785                 variant = (long) oleVariant.lVal;
 786                 break;
 787
 788             case VT_I2:
 789                 variant = (long) oleVariant.iVal;
 790                 break;
 791
 792             case VT_BOOL:
 793                 variant = oleVariant.boolVal != 0;
 794                 break;
 795
 796             case VT_R8:
 797                 variant = oleVariant.dblVal;
 798                 break;
 799
 800             case VT_DISPATCH:
 801                 variant = (void*) oleVariant.pdispVal;
 802                 break;
 803
 804             case VT_NULL:
 805                 variant.MakeNull();
 806                 break;
 807
 808             case VT_EMPTY:
 809                 break;    // Ignore Empty Variant, used only during destruction of objects
 810
 811             default:
 812                 wxLogError(wxT("wxAutomationObject::ConvertOleToVariant: Unknown variant value type %X -> %X"),
 813                            oleVariant.vt,oleVariant.vt&VT_TYPEMASK);
 814                 return false;
 815         }
 816     }
 817
 818     return ok;
 819 }
 820
 821 /*
 822  *  ClearVariant
 823  *
 824  *  Zeros a variant structure without regard to current contents
 825  */
 826 static void ClearVariant(VARIANTARG *pvarg)
 827 {
 828     pvarg->vt = VT_EMPTY;
 829     pvarg->wReserved1 = 0;
 830     pvarg->wReserved2 = 0;
 831     pvarg->wReserved3 = 0;
 832     pvarg->lVal = 0;
 833 }
 834
 835 /*
 836  *  ReleaseVariant
 837  *
 838  *  Clears a particular variant structure and releases any external objects
 839  *  or memory contained in the variant.  Supports the data types listed above.
 840  */
 841 static void ReleaseVariant(VARIANTARG *pvarg)
 842 {
 843     VARTYPE vt;
 844     VARIANTARG _huge *pvargArray;
 845     LONG lLBound, lUBound, l;
 846
 847     vt = (VARTYPE)(pvarg->vt & 0xfff);        // mask off flags
 848
 849     // check if an array.  If so, free its contents, then the array itself.
 850     if (V_ISARRAY(pvarg))
 851     {
 852         // variant arrays are all this routine currently knows about.  Since a
 853         // variant can contain anything (even other arrays), call ourselves
 854         // recursively.
 855         if (vt == VT_VARIANT)
 856         {
 857             SafeArrayGetLBound(pvarg->parray, 1, &lLBound);
 858             SafeArrayGetUBound(pvarg->parray, 1, &lUBound);
 859
 860             if (lUBound > lLBound)
 861             {
 862                 lUBound -= lLBound;
 863
 864                 SafeArrayAccessData(pvarg->parray, (void**)&pvargArray);
 865
 866                 for (l = 0; l < lUBound; l++)
 867                 {
 868                     ReleaseVariant(pvargArray);
 869                     pvargArray++;
 870                 }
 871
 872                 SafeArrayUnaccessData(pvarg->parray);
 873             }
 874         }
 875         else
 876         {
 877             wxLogWarning(wxT("ReleaseVariant: Array contains non-variant type"));
 878         }
 879
 880         // Free the array itself.
 881         SafeArrayDestroy(pvarg->parray);
 882     }
 883     else
 884     {
 885         switch (vt)
 886         {
 887             case VT_DISPATCH:
 888                 if (pvarg->pdispVal)
 889                     pvarg->pdispVal->Release();
 890                 break;
 891
 892             case VT_BSTR:
 893                 SysFreeString(pvarg->bstrVal);
 894                 break;
 895
 896             case VT_I2:
 897             case VT_I4:
 898             case VT_BOOL:
 899             case VT_R8:
 900             case VT_ERROR:        // to avoid erroring on an error return from Excel
 901             case VT_EMPTY:
 902             case VT_DATE:
 903                 // no work for these types
 904                 break;
 905
 906             default:
 907                 wxLogWarning(wxT("ReleaseVariant: Unknown type"));
 908                 break;
 909         }
 910     }
 911
 912     ClearVariant(pvarg);
 913 }
 914
 915 #if 0
 916
 917 void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr)
 918 {
 919     TCHAR szBuf[512];
 920
 921     switch (GetScode(hr))
 922     {
 923         case DISP_E_UNKNOWNNAME:
 924             wsprintf(szBuf, L"%s: Unknown name or named argument.", szMember);
 925             break;
 926
 927         case DISP_E_BADPARAMCOUNT:
 928             wsprintf(szBuf, L"%s: Incorrect number of arguments.", szMember);
 929             break;
 930
 931         case DISP_E_EXCEPTION:
 932             wsprintf(szBuf, L"%s: Error %d: ", szMember, pexcep->wCode);
 933             if (pexcep->bstrDescription != NULL)
 934                 lstrcat(szBuf, pexcep->bstrDescription);
 935             else
 936                 lstrcat(szBuf, L"<<No Description>>");
 937             break;
 938
 939         case DISP_E_MEMBERNOTFOUND:
 940             wsprintf(szBuf, L"%s: method or property not found.", szMember);
 941             break;
 942
 943         case DISP_E_OVERFLOW:
 944             wsprintf(szBuf, L"%s: Overflow while coercing argument values.", szMember);
 945             break;
 946
 947         case DISP_E_NONAMEDARGS:
 948             wsprintf(szBuf, L"%s: Object implementation does not support named arguments.",
 949                         szMember);
 950             break;
 951
 952         case DISP_E_UNKNOWNLCID:
 953             wsprintf(szBuf, L"%s: The locale ID is unknown.", szMember);
 954             break;
 955
 956         case DISP_E_PARAMNOTOPTIONAL:
 957             wsprintf(szBuf, L"%s: Missing a required parameter.", szMember);
 958             break;
 959
 960         case DISP_E_PARAMNOTFOUND:
 961             wsprintf(szBuf, L"%s: Argument not found, argument %d.", szMember, uiArgErr);
 962             break;
 963
 964         case DISP_E_TYPEMISMATCH:
 965             wsprintf(szBuf, L"%s: Type mismatch, argument %d.", szMember, uiArgErr);
 966             break;
 967
 968         default:
 969             wsprintf(szBuf, L"%s: Unknown error occurred.", szMember);
 970             break;
 971     }
 972
 973     wxLogWarning(szBuf);
 974 }
 975
 976 #endif
 977
 978 #endif // wxUSE_OLE_AUTOMATION