src/msw/ole/automtn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  13 #pragma implementation "automtn.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #if defined(__BORLANDC__)
  20 #pragma hdrstop
  21 #endif
  22
  23 #include "wx/log.h"
  24 #include "wx/msw/ole/automtn.h"
  25
  26 #include <windows.h>
  27 #include <ole2ver.h>
  28 #include <oleauto.h>
  29 #include <math.h>
  30 #include <time.h>
  31
  32 #ifdef GetObject
  33 #undef GetObject
  34 #endif
  35
  36 // wrapper around BSTR type (by Vadim Zeitlin)
  37
  38 class WXDLLEXPORT BasicString
  39 {
  40 public:
  41   // ctors & dtor
  42   BasicString(const char *sz);
  43  ~BasicString();
  44
  45   // accessors
  46     // just get the string
  47   operator BSTR() const { return m_wzBuf; }
  48     // retrieve a copy of our string - caller must SysFreeString() it later!
  49   BSTR Get() const { return SysAllocString(m_wzBuf); }
  50
  51 private:
  52   // @@@ not implemented (but should be)
  53   BasicString(const BasicString&);
  54   BasicString& operator=(const BasicString&);
  55
  56   OLECHAR *m_wzBuf;     // actual string
  57 };
  58
  59 // Convert variants
  60 static bool ConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant) ;
  61 static bool ConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant) ;
  62
  63 // Convert string to Unicode
  64 static BSTR ConvertStringToOle(const wxString& str);
  65
  66 // Convert string from BSTR to wxString
  67 static wxString ConvertStringFromOle(BSTR bStr);
  68
  69 // Verifies will fail if the needed buffer size is too large
  70 #define MAX_TIME_BUFFER_SIZE    128         // matches that in timecore.cpp
  71 #define MIN_DATE                (-657434L)  // about year 100
  72 #define MAX_DATE                2958465L    // about year 9999
  73
  74 // Half a second, expressed in days
  75 #define HALF_SECOND  (1.0/172800.0)
  76
  77 // One-based array of days in year at month start
  78 static int rgMonthDays[13] =
  79         {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365};
  80
  81 static BOOL OleDateFromTm(WORD wYear, WORD wMonth, WORD wDay,
  82         WORD wHour, WORD wMinute, WORD wSecond, DATE& dtDest);
  83 static BOOL TmFromOleDate(DATE dtSrc, struct tm& tmDest);
  84 static void TmConvertToStandardFormat(struct tm& tmSrc);
  85 static double DoubleFromDate(DATE dt);
  86 static DATE DateFromDouble(double dbl);
  87
  88 static void ClearVariant(VARIANTARG *pvarg) ;
  89 static void ReleaseVariant(VARIANTARG *pvarg) ;
  90 // static void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr);
  91
  92 /*
  93  * wxAutomationObject
  94  */
  95
  96 wxAutomationObject::wxAutomationObject(WXIDISPATCH* dispatchPtr)
  97 {
  98         m_dispatchPtr = dispatchPtr;
  99 }
 100
 101 wxAutomationObject::~wxAutomationObject()
 102 {
 103         if (m_dispatchPtr)
 104         {
 105                 ((IDispatch*)m_dispatchPtr)->Release();
 106                 m_dispatchPtr = NULL;
 107         }
 108 }
 109
 110 #define INVOKEARG(i) (args ? args[i] : *(ptrArgs[i]))
 111
 112 // For Put/Get, no named arguments are allowed.
 113 bool wxAutomationObject::Invoke(const wxString& member, int action,
 114         wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[]) const
 115 {
 116         if (!m_dispatchPtr)
 117                 return FALSE;
 118
 119         // nonConstMember is necessary because the wxString class doesn't have enough consts...
 120         wxString nonConstMember(member);
 121
 122         int ch = nonConstMember.Find('.');
 123         if (ch != -1)
 124         {
 125                 // Use dot notation to get the next object
 126                 wxString member2(nonConstMember.Left((size_t) ch));
 127                 wxString rest(nonConstMember.Right(nonConstMember.Length() - ch - 1));
 128                 wxAutomationObject obj;
 129                 if (!GetObject(obj, member2))
 130                         return FALSE;
 131                 return obj.Invoke(rest, action, retValue, noArgs, args, ptrArgs);
 132         }
 133
 134         VARIANTARG vReturn;
 135         ClearVariant(& vReturn);
 136
 137         VARIANTARG* vReturnPtr = & vReturn;
 138
 139         // Find number of names args
 140         int namedArgCount = 0;
 141         int i;
 142         for (i = 0; i < noArgs; i++)
 143                 if (!INVOKEARG(i).GetName().IsNull())
 144                 {
 145                         namedArgCount ++;
 146                 }
 147
 148         int namedArgStringCount = namedArgCount + 1;
 149         BSTR* argNames = new BSTR[namedArgStringCount];
 150         argNames[0] = ConvertStringToOle(member);
 151
 152         // Note that arguments are specified in reverse order
 153         // (all totally logical; hey, we're dealing with OLE here.)
 154
 155         int j = 0;
 156         for (i = 0; i < namedArgCount; i++)
 157         {
 158                 if (!INVOKEARG(i).GetName().IsNull())
 159                 {
 160                         argNames[(namedArgCount-j)] = ConvertStringToOle(INVOKEARG(i).GetName());
 161                         j ++;
 162                 }
 163         }
 164
 165         // + 1 for the member name, + 1 again in case we're a 'put'
 166         DISPID* dispIds = new DISPID[namedArgCount + 2];
 167
 168         HRESULT hr;
 169         DISPPARAMS dispparams;
 170         unsigned int uiArgErr;
 171         EXCEPINFO excep;
 172
 173         // Get the IDs for the member and its arguments.  GetIDsOfNames expects the
 174         // member name as the first name, followed by argument names (if any).
 175         hr = ((IDispatch*)m_dispatchPtr)->GetIDsOfNames(IID_NULL, argNames,
 176                                                                 1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
 177         if (FAILED(hr))
 178         {
 179 //              ShowException(szMember, hr, NULL, 0);
 180                 return FALSE;
 181         }
 182
 183         // if doing a property put(ref), we need to adjust the first argument to have a
 184         // named arg of DISPID_PROPERTYPUT.
 185         if (action & (DISPATCH_PROPERTYPUT | DISPATCH_PROPERTYPUTREF))
 186         {
 187                 namedArgCount = 1;
 188                 dispIds[1] = DISPID_PROPERTYPUT;
 189                 vReturnPtr = (VARIANTARG*) NULL;
 190         }
 191
 192         // Convert the wxVariants to VARIANTARGs
 193         VARIANTARG* oleArgs = new VARIANTARG[noArgs];
 194         for (i = 0; i < noArgs; i++)
 195         {
 196                 // Again, reverse args
 197                 if (!ConvertVariantToOle(INVOKEARG((noArgs-1) - i), oleArgs[i]))
 198                         return FALSE; // TODO: clean up memory at this point
 199         }
 200
 201         dispparams.rgdispidNamedArgs = dispIds + 1;
 202         dispparams.rgvarg = oleArgs;
 203         dispparams.cArgs = noArgs;
 204         dispparams.cNamedArgs = namedArgCount;
 205
 206         excep.pfnDeferredFillIn = NULL;
 207
 208         hr = ((IDispatch*)m_dispatchPtr)->Invoke(dispIds[0], IID_NULL, LOCALE_SYSTEM_DEFAULT,
 209                                                 action, &dispparams, vReturnPtr, &excep, &uiArgErr);
 210
 211         for (i = 0; i < namedArgStringCount; i++)
 212         {
 213                 SysFreeString(argNames[i]);
 214         }
 215         delete[] argNames;
 216         delete[] dispIds;
 217
 218         for (i = 0; i < noArgs; i++)
 219                 ReleaseVariant(& oleArgs[i]) ;
 220         delete[] oleArgs;
 221
 222         if (FAILED(hr))
 223         {
 224                 // display the exception information if appropriate:
 225 //              ShowException((const char*) member, hr, &excep, uiArgErr);
 226
 227                 // free exception structure information
 228                 SysFreeString(excep.bstrSource);
 229                 SysFreeString(excep.bstrDescription);
 230                 SysFreeString(excep.bstrHelpFile);
 231
 232                 if (vReturnPtr)
 233                         ReleaseVariant(vReturnPtr);
 234                 return FALSE;
 235         }
 236         else
 237         {
 238                 if (vReturnPtr)
 239                 {
 240                         // Convert result to wxVariant form
 241                         ConvertOleToVariant(vReturn, retValue);
 242                         // Mustn't release the dispatch pointer
 243                         if (vReturn.vt == VT_DISPATCH)
 244                         {
 245                                 vReturn.pdispVal = (IDispatch*) NULL;
 246                         }
 247                         ReleaseVariant(& vReturn);
 248                 }
 249         }
 250         return TRUE;
 251 }
 252
 253 // Invoke a member function
 254 wxVariant wxAutomationObject::CallMethod(const wxString& member, int noArgs, wxVariant args[])
 255 {
 256         wxVariant retVariant;
 257         if (!Invoke(member, DISPATCH_METHOD, retVariant, noArgs, args))
 258         {
 259                 retVariant.MakeNull();
 260         }
 261         return retVariant;
 262 }
 263
 264 wxVariant wxAutomationObject::CallMethod(const wxString& member,
 265                 const wxVariant& arg1, const wxVariant& arg2,
 266                 const wxVariant& arg3, const wxVariant& arg4,
 267                 const wxVariant& arg5, const wxVariant& arg6)
 268 {
 269         const wxVariant** args = new const wxVariant*[6];
 270         int i = 0;
 271         if (!arg1.IsNull())
 272         {
 273                 args[i] = & arg1;
 274                 i ++;
 275         }
 276         if (!arg2.IsNull())
 277         {
 278                 args[i] = & arg2;
 279                 i ++;
 280         }
 281         if (!arg3.IsNull())
 282         {
 283                 args[i] = & arg3;
 284                 i ++;
 285         }
 286         if (!arg4.IsNull())
 287         {
 288                 args[i] = & arg4;
 289                 i ++;
 290         }
 291         if (!arg5.IsNull())
 292         {
 293                 args[i] = & arg5;
 294                 i ++;
 295         }
 296         if (!arg6.IsNull())
 297         {
 298                 args[i] = & arg6;
 299                 i ++;
 300         }
 301         wxVariant retVariant;
 302         if (!Invoke(member, DISPATCH_METHOD, retVariant, i, NULL, args))
 303         {
 304                 retVariant.MakeNull();
 305         }
 306         delete[] args;
 307         return retVariant;
 308 }
 309
 310 // Get/Set property
 311 wxVariant wxAutomationObject::GetProperty(const wxString& property, int noArgs, wxVariant args[]) const
 312 {
 313         wxVariant retVariant;
 314         if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 315         {
 316                 retVariant.MakeNull();
 317         }
 318         return retVariant;
 319 }
 320
 321 wxVariant wxAutomationObject::GetProperty(const wxString& property,
 322                 const wxVariant& arg1, const wxVariant& arg2,
 323                 const wxVariant& arg3, const wxVariant& arg4,
 324                 const wxVariant& arg5, const wxVariant& arg6)
 325 {
 326         const wxVariant** args = new const wxVariant*[6];
 327         int i = 0;
 328         if (!arg1.IsNull())
 329         {
 330                 args[i] = & arg1;
 331                 i ++;
 332         }
 333         if (!arg2.IsNull())
 334         {
 335                 args[i] = & arg2;
 336                 i ++;
 337         }
 338         if (!arg3.IsNull())
 339         {
 340                 args[i] = & arg3;
 341                 i ++;
 342         }
 343         if (!arg4.IsNull())
 344         {
 345                 args[i] = & arg4;
 346                 i ++;
 347         }
 348         if (!arg5.IsNull())
 349         {
 350                 args[i] = & arg5;
 351                 i ++;
 352         }
 353         if (!arg6.IsNull())
 354         {
 355                 args[i] = & arg6;
 356                 i ++;
 357         }
 358         wxVariant retVariant;
 359         if (!Invoke(property, DISPATCH_PROPERTYGET, retVariant, i, NULL, args))
 360         {
 361                 retVariant.MakeNull();
 362         }
 363         delete[] args;
 364         return retVariant;
 365 }
 366
 367 bool wxAutomationObject::PutProperty(const wxString& property, int noArgs, wxVariant args[])
 368 {
 369         wxVariant retVariant;
 370         if (!Invoke(property, DISPATCH_PROPERTYPUT, retVariant, noArgs, args))
 371         {
 372                 return FALSE;
 373         }
 374         return TRUE;
 375 }
 376
 377 bool wxAutomationObject::PutProperty(const wxString& property,
 378                 const wxVariant& arg1, const wxVariant& arg2,
 379                 const wxVariant& arg3, const wxVariant& arg4,
 380                 const wxVariant& arg5, const wxVariant& arg6)
 381 {
 382         const wxVariant** args = new const wxVariant*[6];
 383         int i = 0;
 384         if (!arg1.IsNull())
 385         {
 386                 args[i] = & arg1;
 387                 i ++;
 388         }
 389         if (!arg2.IsNull())
 390         {
 391                 args[i] = & arg2;
 392                 i ++;
 393         }
 394         if (!arg3.IsNull())
 395         {
 396                 args[i] = & arg3;
 397                 i ++;
 398         }
 399         if (!arg4.IsNull())
 400         {
 401                 args[i] = & arg4;
 402                 i ++;
 403         }
 404         if (!arg5.IsNull())
 405         {
 406                 args[i] = & arg5;
 407                 i ++;
 408         }
 409         if (!arg6.IsNull())
 410         {
 411                 args[i] = & arg6;
 412                 i ++;
 413         }
 414         wxVariant retVariant;
 415         bool ret = Invoke(property, DISPATCH_PROPERTYPUT, retVariant, i, NULL, args);
 416         delete[] args;
 417         return ret;
 418 }
 419
 420
 421 // Uses DISPATCH_PROPERTYGET
 422 // and returns a dispatch pointer. The calling code should call Release
 423 // on the pointer, though this could be implicit by constructing an wxAutomationObject
 424 // with it and letting the destructor call Release.
 425 WXIDISPATCH* wxAutomationObject::GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const
 426 {
 427         wxVariant retVariant;
 428         if (Invoke(property, DISPATCH_PROPERTYGET, retVariant, noArgs, args))
 429         {
 430                 if (retVariant.GetType() == "void*")
 431                 {
 432                         return (WXIDISPATCH*) retVariant.GetVoidPtr();
 433                 }
 434                 else
 435                 {
 436                         return (WXIDISPATCH*) NULL;
 437                 }
 438         }
 439         else
 440                 return (WXIDISPATCH*) NULL;
 441 }
 442
 443 // A way of initialising another wxAutomationObject with a dispatch object
 444 bool wxAutomationObject::GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, wxVariant args[]) const
 445 {
 446         WXIDISPATCH* dispatch = GetDispatchProperty(property, noArgs, args);
 447         if (dispatch)
 448         {
 449                 obj.SetDispatchPtr(dispatch);
 450                 return TRUE;
 451         }
 452         else
 453                 return FALSE;
 454 }
 455
 456 // Get a dispatch pointer from the current object associated
 457 // with a class id
 458 bool wxAutomationObject::GetInstance(const wxString& classId) const
 459 {
 460         if (m_dispatchPtr)
 461                 return FALSE;
 462
 463         CLSID clsId;
 464         IUnknown * pUnk = NULL;
 465
 466         BasicString unicodeName((const char*) classId);
 467
 468         if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 469         {
 470                 wxLogWarning("Cannot obtain CLSID from ProgID");
 471                 return FALSE;
 472         }
 473
 474         if (FAILED(GetActiveObject(clsId, NULL, &pUnk)))
 475         {
 476                 wxLogWarning("Cannot find an active object");
 477                 return FALSE;
 478         }
 479
 480         if (pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr) != S_OK)
 481         {
 482                 wxLogWarning("Cannot find IDispatch interface");
 483                 return FALSE;
 484         }
 485
 486         return TRUE;
 487 }
 488
 489 // Get a dispatch pointer from a new object associated
 490 // with the given class id
 491 bool wxAutomationObject::CreateInstance(const wxString& classId) const
 492 {
 493         if (m_dispatchPtr)
 494                 return FALSE;
 495
 496         CLSID clsId;
 497         IUnknown * pUnk = NULL;
 498
 499         BasicString unicodeName((const char*) classId);
 500
 501         if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
 502         {
 503                 wxLogWarning("Cannot obtain CLSID from ProgID");
 504                 return FALSE;
 505         }
 506
 507         // start a new copy of Excel, grab the IDispatch interface
 508         if (FAILED(CoCreateInstance(clsId, NULL, CLSCTX_LOCAL_SERVER, IID_IDispatch, (void**)&m_dispatchPtr)))
 509         {
 510                 wxLogWarning("Cannot start an instance of this class.");
 511                 return FALSE;
 512         }
 513
 514         return TRUE;
 515 }
 516
 517
 518 bool ConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant)
 519 {
 520         ClearVariant(&oleVariant);
 521         if (variant.IsNull())
 522         {
 523                 oleVariant.vt = VT_NULL;
 524                 return TRUE;
 525         }
 526
 527     wxString type(variant.GetType());
 528
 529     if (type == "long")
 530     {
 531         oleVariant.vt = VT_I4;
 532         oleVariant.lVal = variant.GetLong() ;
 533     }
 534     else if (type == "double")
 535     {
 536         oleVariant.vt = VT_R8;
 537         oleVariant.dblVal = variant.GetDouble();
 538     }
 539     else if (type == "bool")
 540     {
 541         oleVariant.vt = VT_BOOL;
 542 #ifdef __WATCOMC__
 543         oleVariant.bool = variant.GetBool();
 544 #else
 545         oleVariant.boolVal = variant.GetBool();
 546 #endif
 547     }
 548     else if (type == "string")
 549     {
 550         wxString str( variant.GetString() );
 551         oleVariant.vt = VT_BSTR;
 552         oleVariant.bstrVal = ConvertStringToOle(str);
 553     }
 554     else if (type == "date")
 555     {
 556         wxDate date( variant.GetDate() );
 557         oleVariant.vt = VT_DATE;
 558
 559                 if (!OleDateFromTm(date.GetYear(), date.GetMonth(), date.GetDay(),
 560                                 0, 0, 0, oleVariant.date))
 561                         return FALSE;
 562     }
 563     else if (type == "time")
 564     {
 565         wxTime time( variant.GetTime() );
 566         oleVariant.vt = VT_DATE;
 567
 568                 if (!OleDateFromTm(time.GetYear(), time.GetMonth(), time.GetDay(),
 569                         time.GetHour(), time.GetMinute(), time.GetSecond(), oleVariant.date))
 570                         return FALSE;
 571     }
 572     else if (type == "void*")
 573     {
 574         oleVariant.vt = VT_DISPATCH;
 575         oleVariant.pdispVal = (IDispatch*) variant.GetVoidPtr();
 576     }
 577     else if (type == "list" || type == "stringlist")
 578     {
 579         oleVariant.vt = VT_VARIANT | VT_ARRAY;
 580
 581             SAFEARRAY *psa;
 582             SAFEARRAYBOUND saBound;
 583             VARIANTARG *pvargBase;
 584             VARIANTARG *pvarg;
 585             int i, j;
 586
 587         int iCount = variant.GetCount();
 588
 589             saBound.lLbound = 0;
 590             saBound.cElements = iCount;
 591
 592             psa = SafeArrayCreate(VT_VARIANT, 1, &saBound);
 593             if (psa == NULL)
 594                     return FALSE;
 595
 596             SafeArrayAccessData(psa, (void**)&pvargBase);
 597
 598             pvarg = pvargBase;
 599             for (i = 0; i < iCount; i++)
 600             {
 601                     // copy each string in the list of strings
 602             wxVariant eachVariant(variant[i]);
 603             if (!ConvertVariantToOle(eachVariant, * pvarg))
 604             {
 605                             // memory failure:  back out and free strings alloc'ed up to
 606                             // now, and then the array itself.
 607                             pvarg = pvargBase;
 608                             for (j = 0; j < i; j++)
 609                             {
 610                                     SysFreeString(pvarg->bstrVal);
 611                                     pvarg++;
 612                             }
 613                             SafeArrayDestroy(psa);
 614                             return FALSE;
 615                     }
 616                     pvarg++;
 617             }
 618
 619             SafeArrayUnaccessData(psa);
 620
 621         oleVariant.parray = psa;
 622     }
 623     else
 624     {
 625         oleVariant.vt = VT_NULL;
 626         return FALSE;
 627     }
 628     return TRUE;
 629 }
 630
 631 #ifndef VT_TYPEMASK
 632 #define VT_TYPEMASK 0xfff
 633 #endif
 634
 635 bool ConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant)
 636 {
 637         switch (oleVariant.vt & VT_TYPEMASK)
 638         {
 639         case VT_BSTR:
 640                 {
 641                         wxString str(ConvertStringFromOle(oleVariant.bstrVal));
 642                         variant = str;
 643                         break;
 644                 }
 645         case VT_DATE:
 646                 {
 647                         struct tm tmTemp;
 648                         if (!TmFromOleDate(oleVariant.date, tmTemp))
 649                                 return FALSE;
 650
 651                         wxDate date(tmTemp.tm_yday, tmTemp.tm_mon, tmTemp.tm_year);
 652                         wxTime time(date, tmTemp.tm_hour, tmTemp.tm_min, tmTemp.tm_sec);
 653
 654                         variant = time;
 655                         break;
 656                 }
 657         case VT_I4:
 658                 {
 659                         variant = (long) oleVariant.lVal;
 660                         break;
 661                 }
 662         case VT_I2:
 663                 {
 664                         variant = (long) oleVariant.iVal;
 665                         break;
 666                 }
 667
 668         case VT_BOOL:
 669                 {
 670 #ifdef __WATCOMC__
 671                         variant = (bool) (oleVariant.bool != 0);
 672 #else
 673                         variant = (bool) (oleVariant.boolVal != 0);
 674 #endif
 675                         break;
 676                 }
 677         case VT_R8:
 678                 {
 679                         variant = oleVariant.dblVal;
 680                         break;
 681                 }
 682         case VT_ARRAY:
 683                 {
 684                         variant.ClearList();
 685
 686                         int cDims, cElements, i;
 687                         VARIANTARG* pvdata;
 688
 689                         // Iterate the dimensions: number of elements is x*y*z
 690                         for (cDims = 0, cElements = 1;
 691                                 cDims < oleVariant.parray->cDims; cDims ++)
 692                                         cElements *= oleVariant.parray->rgsabound[cDims].cElements;
 693
 694                         // Get a pointer to the data
 695                         HRESULT hr = SafeArrayAccessData(oleVariant.parray, (void HUGEP* FAR*) & pvdata);
 696                         if (hr != NOERROR)
 697                                 return FALSE;
 698                         // Iterate the data.
 699                         for (i = 0; i < cElements; i++)
 700                         {
 701                                 VARIANTARG& oleElement = pvdata[i];
 702                                 wxVariant vElement;
 703                                 if (!ConvertOleToVariant(oleElement, vElement))
 704                                         return FALSE;
 705
 706                                 variant.Append(vElement);
 707                         }
 708                         SafeArrayUnaccessData(oleVariant.parray);
 709                         break;
 710                 }
 711         case VT_DISPATCH:
 712                 {
 713                         variant = (void*) oleVariant.pdispVal;
 714                         break;
 715                 }
 716         case VT_NULL:
 717                 {
 718                         variant.MakeNull();
 719                         break;
 720                 }
 721         case VT_EMPTY:
 722                 {
 723                         break;  // Ignore Empty Variant, used only during destruction of objects
 724                 }
 725         default:
 726                 {
 727                         wxLogError("wxAutomationObject::ConvertOleToVariant: Unknown variant value type");
 728                         return FALSE;
 729                 }
 730         }
 731     return TRUE;
 732 }
 733
 734 static BSTR ConvertStringToOle(const wxString& str)
 735 {
 736 /*
 737         unsigned int len = strlen((const char*) str);
 738         unsigned short* s = new unsigned short[len*2+2];
 739         unsigned int i;
 740         memset(s, 0, len*2+2);
 741         for (i=0; i < len; i++)
 742                 s[i*2] = str[i];
 743 */
 744         BasicString bstr((const char*) str);
 745         return bstr.Get();
 746 }
 747
 748 static wxString ConvertStringFromOle(BSTR bStr)
 749 {
 750         int len = SysStringLen(bStr) + 1;
 751         char    *buf = new char[len];
 752         int i = wcstombs( buf, bStr, len);
 753
 754         wxString str(buf);
 755         delete[] buf;
 756         return str;
 757 }
 758
 759 // ----------------------------------------------------------------------------
 760 // BasicString
 761 // ----------------------------------------------------------------------------
 762
 763 // ctor takes an ANSI string and transforms it to Unicode
 764 BasicString::BasicString(const char *sz)
 765 {
 766   // get the size of required buffer
 767   UINT lenAnsi = strlen(sz);
 768   UINT lenWide = mbstowcs(NULL, sz, lenAnsi);
 769
 770   if ( lenWide > 0 ) {
 771     m_wzBuf = new OLECHAR[lenWide + 1];
 772     mbstowcs(m_wzBuf, sz, lenAnsi);
 773     m_wzBuf[lenWide] = L'\0';
 774   }
 775   else {
 776     m_wzBuf = NULL;
 777   }
 778 }
 779
 780 // dtor frees memory
 781 BasicString::~BasicString()
 782 {
 783   delete [] m_wzBuf;
 784 }
 785
 786 /////////////////////////////////////////////////////////////////////////////
 787 // COleDateTime class HELPERS - implementation
 788
 789 BOOL OleDateFromTm(WORD wYear, WORD wMonth, WORD wDay,
 790         WORD wHour, WORD wMinute, WORD wSecond, DATE& dtDest)
 791 {
 792         // Validate year and month (ignore day of week and milliseconds)
 793         if (wYear > 9999 || wMonth < 1 || wMonth > 12)
 794                 return FALSE;
 795
 796         //  Check for leap year and set the number of days in the month
 797         BOOL bLeapYear = ((wYear & 3) == 0) &&
 798                 ((wYear % 100) != 0 || (wYear % 400) == 0);
 799
 800         int nDaysInMonth =
 801                 rgMonthDays[wMonth] - rgMonthDays[wMonth-1] +
 802                 ((bLeapYear && wDay == 29 && wMonth == 2) ? 1 : 0);
 803
 804         // Finish validating the date
 805         if (wDay < 1 || wDay > nDaysInMonth ||
 806                 wHour > 23 || wMinute > 59 ||
 807                 wSecond > 59)
 808         {
 809                 return FALSE;
 810         }
 811
 812         // Cache the date in days and time in fractional days
 813         long nDate;
 814         double dblTime;
 815
 816         //It is a valid date; make Jan 1, 1AD be 1
 817         nDate = wYear*365L + wYear/4 - wYear/100 + wYear/400 +
 818                 rgMonthDays[wMonth-1] + wDay;
 819
 820         //  If leap year and it's before March, subtract 1:
 821         if (wMonth <= 2 && bLeapYear)
 822                 --nDate;
 823
 824         //  Offset so that 12/30/1899 is 0
 825         nDate -= 693959L;
 826
 827         dblTime = (((long)wHour * 3600L) +  // hrs in seconds
 828                 ((long)wMinute * 60L) +  // mins in seconds
 829                 ((long)wSecond)) / 86400.;
 830
 831         dtDest = (double) nDate + ((nDate >= 0) ? dblTime : -dblTime);
 832
 833         return TRUE;
 834 }
 835
 836 BOOL TmFromOleDate(DATE dtSrc, struct tm& tmDest)
 837 {
 838         // The legal range does not actually span year 0 to 9999.
 839         if (dtSrc > MAX_DATE || dtSrc < MIN_DATE) // about year 100 to about 9999
 840                 return FALSE;
 841
 842         long nDays;             // Number of days since Dec. 30, 1899
 843         long nDaysAbsolute;     // Number of days since 1/1/0
 844         long nSecsInDay;        // Time in seconds since midnight
 845         long nMinutesInDay;     // Minutes in day
 846
 847         long n400Years;         // Number of 400 year increments since 1/1/0
 848         long n400Century;       // Century within 400 year block (0,1,2 or 3)
 849         long n4Years;           // Number of 4 year increments since 1/1/0
 850         long n4Day;             // Day within 4 year block
 851                                                         //  (0 is 1/1/yr1, 1460 is 12/31/yr4)
 852         long n4Yr;              // Year within 4 year block (0,1,2 or 3)
 853         BOOL bLeap4 = TRUE;     // TRUE if 4 year block includes leap year
 854
 855         double dblDate = dtSrc; // tempory serial date
 856
 857         // If a valid date, then this conversion should not overflow
 858         nDays = (long)dblDate;
 859
 860         // Round to the second
 861         dblDate += ((dtSrc > 0.0) ? HALF_SECOND : -HALF_SECOND);
 862
 863         nDaysAbsolute = (long)dblDate + 693959L; // Add days from 1/1/0 to 12/30/1899
 864
 865         dblDate = fabs(dblDate);
 866         nSecsInDay = (long)((dblDate - floor(dblDate)) * 86400.);
 867
 868         // Calculate the day of week (sun=1, mon=2...)
 869         //   -1 because 1/1/0 is Sat.  +1 because we want 1-based
 870         tmDest.tm_wday = (int)((nDaysAbsolute - 1) % 7L) + 1;
 871
 872         // Leap years every 4 yrs except centuries not multiples of 400.
 873         n400Years = (long)(nDaysAbsolute / 146097L);
 874
 875         // Set nDaysAbsolute to day within 400-year block
 876         nDaysAbsolute %= 146097L;
 877
 878         // -1 because first century has extra day
 879         n400Century = (long)((nDaysAbsolute - 1) / 36524L);
 880
 881         // Non-leap century
 882         if (n400Century != 0)
 883         {
 884                 // Set nDaysAbsolute to day within century
 885                 nDaysAbsolute = (nDaysAbsolute - 1) % 36524L;
 886
 887                 // +1 because 1st 4 year increment has 1460 days
 888                 n4Years = (long)((nDaysAbsolute + 1) / 1461L);
 889
 890                 if (n4Years != 0)
 891                         n4Day = (long)((nDaysAbsolute + 1) % 1461L);
 892                 else
 893                 {
 894                         bLeap4 = FALSE;
 895                         n4Day = (long)nDaysAbsolute;
 896                 }
 897         }
 898         else
 899         {
 900                 // Leap century - not special case!
 901                 n4Years = (long)(nDaysAbsolute / 1461L);
 902                 n4Day = (long)(nDaysAbsolute % 1461L);
 903         }
 904
 905         if (bLeap4)
 906         {
 907                 // -1 because first year has 366 days
 908                 n4Yr = (n4Day - 1) / 365;
 909
 910                 if (n4Yr != 0)
 911                         n4Day = (n4Day - 1) % 365;
 912         }
 913         else
 914         {
 915                 n4Yr = n4Day / 365;
 916                 n4Day %= 365;
 917         }
 918
 919         // n4Day is now 0-based day of year. Save 1-based day of year, year number
 920         tmDest.tm_yday = (int)n4Day + 1;
 921         tmDest.tm_year = n400Years * 400 + n400Century * 100 + n4Years * 4 + n4Yr;
 922
 923         // Handle leap year: before, on, and after Feb. 29.
 924         if (n4Yr == 0 && bLeap4)
 925         {
 926                 // Leap Year
 927                 if (n4Day == 59)
 928                 {
 929                         /* Feb. 29 */
 930                         tmDest.tm_mon = 2;
 931                         tmDest.tm_mday = 29;
 932                         goto DoTime;
 933                 }
 934
 935                 // Pretend it's not a leap year for month/day comp.
 936                 if (n4Day >= 60)
 937                         --n4Day;
 938         }
 939
 940         // Make n4DaY a 1-based day of non-leap year and compute
 941         //  month/day for everything but Feb. 29.
 942         ++n4Day;
 943
 944         // Month number always >= n/32, so save some loop time */
 945         for (tmDest.tm_mon = (n4Day >> 5) + 1;
 946                 n4Day > rgMonthDays[tmDest.tm_mon]; tmDest.tm_mon++);
 947
 948         tmDest.tm_mday = (int)(n4Day - rgMonthDays[tmDest.tm_mon-1]);
 949
 950 DoTime:
 951         if (nSecsInDay == 0)
 952                 tmDest.tm_hour = tmDest.tm_min = tmDest.tm_sec = 0;
 953         else
 954         {
 955                 tmDest.tm_sec = (int)nSecsInDay % 60L;
 956                 nMinutesInDay = nSecsInDay / 60L;
 957                 tmDest.tm_min = (int)nMinutesInDay % 60;
 958                 tmDest.tm_hour = (int)nMinutesInDay / 60;
 959         }
 960
 961         return TRUE;
 962 }
 963
 964 void TmConvertToStandardFormat(struct tm& tmSrc)
 965 {
 966         // Convert afx internal tm to format expected by runtimes (_tcsftime, etc)
 967         tmSrc.tm_year -= 1900;  // year is based on 1900
 968         tmSrc.tm_mon -= 1;      // month of year is 0-based
 969         tmSrc.tm_wday -= 1;     // day of week is 0-based
 970         tmSrc.tm_yday -= 1;     // day of year is 0-based
 971 }
 972
 973 double DoubleFromDate(DATE dt)
 974 {
 975         // No problem if positive
 976         if (dt >= 0)
 977                 return dt;
 978
 979         // If negative, must convert since negative dates not continuous
 980         // (examples: -1.25 to -.75, -1.50 to -.50, -1.75 to -.25)
 981         double temp = ceil(dt);
 982         return temp - (dt - temp);
 983 }
 984
 985 DATE DateFromDouble(double dbl)
 986 {
 987         // No problem if positive
 988         if (dbl >= 0)
 989                 return dbl;
 990
 991         // If negative, must convert since negative dates not continuous
 992         // (examples: -.75 to -1.25, -.50 to -1.50, -.25 to -1.75)
 993         double temp = floor(dbl); // dbl is now whole part
 994         return temp + (temp - dbl);
 995 }
 996
 997 /*
 998  *  ClearVariant
 999  *
1000  *  Zeros a variant structure without regard to current contents
1001  */
1002 static void ClearVariant(VARIANTARG *pvarg)
1003 {
1004         pvarg->vt = VT_EMPTY;
1005         pvarg->wReserved1 = 0;
1006         pvarg->wReserved2 = 0;
1007         pvarg->wReserved3 = 0;
1008         pvarg->lVal = 0;
1009 }
1010
1011 /*
1012  *  ReleaseVariant
1013  *
1014  *  Clears a particular variant structure and releases any external objects
1015  *  or memory contained in the variant.  Supports the data types listed above.
1016  */
1017 static void ReleaseVariant(VARIANTARG *pvarg)
1018 {
1019         VARTYPE vt;
1020         VARIANTARG _huge *pvargArray;
1021         long lLBound, lUBound, l;
1022
1023         vt = pvarg->vt & 0xfff;         // mask off flags
1024
1025         // check if an array.  If so, free its contents, then the array itself.
1026         if (V_ISARRAY(pvarg))
1027         {
1028                 // variant arrays are all this routine currently knows about.  Since a
1029                 // variant can contain anything (even other arrays), call ourselves
1030                 // recursively.
1031                 if (vt == VT_VARIANT)
1032                 {
1033                         SafeArrayGetLBound(pvarg->parray, 1, &lLBound);
1034                         SafeArrayGetUBound(pvarg->parray, 1, &lUBound);
1035
1036                         if (lUBound > lLBound)
1037                         {
1038                                 lUBound -= lLBound;
1039
1040                                 SafeArrayAccessData(pvarg->parray, (void**)&pvargArray);
1041
1042                                 for (l = 0; l < lUBound; l++)
1043                                 {
1044                                         ReleaseVariant(pvargArray);
1045                                         pvargArray++;
1046                                 }
1047
1048                                 SafeArrayUnaccessData(pvarg->parray);
1049                         }
1050                 }
1051                 else
1052                 {
1053                         wxLogWarning("ReleaseVariant: Array contains non-variant type");
1054                 }
1055
1056                 // Free the array itself.
1057                 SafeArrayDestroy(pvarg->parray);
1058         }
1059         else
1060         {
1061                 switch (vt)
1062                 {
1063                         case VT_DISPATCH:
1064                                 if (pvarg->pdispVal)
1065                                         pvarg->pdispVal->Release();
1066                                 break;
1067
1068                         case VT_BSTR:
1069                                 SysFreeString(pvarg->bstrVal);
1070                                 break;
1071
1072                         case VT_I2:
1073                         case VT_BOOL:
1074                         case VT_R8:
1075                         case VT_ERROR:          // to avoid erroring on an error return from Excel
1076                                 // no work for these types
1077                                 break;
1078
1079                         default:
1080                                 wxLogWarning("ReleaseVariant: Unknown type");
1081                                 break;
1082                 }
1083         }
1084
1085         ClearVariant(pvarg);
1086 }
1087
1088 #if 0
1089
1090 void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr)
1091 {
1092         TCHAR szBuf[512];
1093
1094         switch (GetScode(hr))
1095         {
1096                 case DISP_E_UNKNOWNNAME:
1097                         wsprintf(szBuf, L"%s: Unknown name or named argument.", szMember);
1098                         break;
1099
1100                 case DISP_E_BADPARAMCOUNT:
1101                         wsprintf(szBuf, L"%s: Incorrect number of arguments.", szMember);
1102                         break;
1103
1104                 case DISP_E_EXCEPTION:
1105                         wsprintf(szBuf, L"%s: Error %d: ", szMember, pexcep->wCode);
1106                         if (pexcep->bstrDescription != NULL)
1107                                 lstrcat(szBuf, pexcep->bstrDescription);
1108                         else
1109                                 lstrcat(szBuf, L"<<No Description>>");
1110                         break;
1111
1112                 case DISP_E_MEMBERNOTFOUND:
1113                         wsprintf(szBuf, L"%s: method or property not found.", szMember);
1114                         break;
1115
1116                 case DISP_E_OVERFLOW:
1117                         wsprintf(szBuf, L"%s: Overflow while coercing argument values.", szMember);
1118                         break;
1119
1120                 case DISP_E_NONAMEDARGS:
1121                         wsprintf(szBuf, L"%s: Object implementation does not support named arguments.",
1122                                                 szMember);
1123                     break;
1124
1125                 case DISP_E_UNKNOWNLCID:
1126                         wsprintf(szBuf, L"%s: The locale ID is unknown.", szMember);
1127                         break;
1128
1129                 case DISP_E_PARAMNOTOPTIONAL:
1130                         wsprintf(szBuf, L"%s: Missing a required parameter.", szMember);
1131                         break;
1132
1133                 case DISP_E_PARAMNOTFOUND:
1134                         wsprintf(szBuf, L"%s: Argument not found, argument %d.", szMember, uiArgErr);
1135                         break;
1136
1137                 case DISP_E_TYPEMISMATCH:
1138                         wsprintf(szBuf, L"%s: Type mismatch, argument %d.", szMember, uiArgErr);
1139                         break;
1140
1141                 default:
1142                         wsprintf(szBuf, L"%s: Unknown error occured.", szMember);
1143                         break;
1144         }
1145
1146         wxLogWarning(szBuf);
1147 }
1148
1149 #endif
1150