#define wxUSE_OLE_AUTOMATION 0
#endif
-#if wxUSE_OLE_AUTOMATION
-
#ifndef WX_PRECOMP
#include "wx/log.h"
#include "wx/math.h"
#if wxUSE_DATETIME
#include "wx/datetime.h"
-#endif // wxUSE_TIMEDATE
+#endif // wxUSE_DATETIME
+
+#if wxUSE_OLE_AUTOMATION
-static void ClearVariant(VARIANTARG *pvarg) ;
-static void ReleaseVariant(VARIANTARG *pvarg) ;
-// static void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr);
+// Report an OLE error when calling the specified method to the user via wxLog.
+static void
+ShowException(const wxString& member,
+ HRESULT hr,
+ EXCEPINFO *pexcep = NULL,
+ unsigned int uiArgErr = 0);
-/*
- * wxAutomationObject
- */
+// wxAutomationObject
wxAutomationObject::wxAutomationObject(WXIDISPATCH* dispatchPtr)
{
if (!m_dispatchPtr)
return false;
- // nonConstMember is necessary because the wxString class doesn't have enough consts...
- wxString nonConstMember(member);
-
- int ch = nonConstMember.Find('.');
+ int ch = member.Find('.');
if (ch != -1)
{
// Use dot notation to get the next object
- wxString member2(nonConstMember.Left((size_t) ch));
- wxString rest(nonConstMember.Right(nonConstMember.length() - ch - 1));
+ wxString member2(member.Left((size_t) ch));
+ wxString rest(member.Right(member.length() - ch - 1));
wxAutomationObject obj;
if (!GetObject(obj, member2))
return false;
}
VARIANTARG vReturn;
- ClearVariant(& vReturn);
+ VariantInit(& vReturn);
VARIANTARG* vReturnPtr = & vReturn;
int namedArgCount = 0;
int i;
for (i = 0; i < noArgs; i++)
- if (!INVOKEARG(i).GetName().IsNull())
+ if ( !INVOKEARG(i).GetName().empty() )
{
namedArgCount ++;
}
int j = 0;
for (i = 0; i < namedArgCount; i++)
{
- if (!INVOKEARG(i).GetName().IsNull())
+ if ( !INVOKEARG(i).GetName().empty() )
{
argNames[(namedArgCount-j)] = wxConvertStringToOle(INVOKEARG(i).GetName());
j ++;
HRESULT hr;
DISPPARAMS dispparams;
unsigned int uiArgErr;
- EXCEPINFO excep;
// Get the IDs for the member and its arguments. GetIDsOfNames expects the
// member name as the first name, followed by argument names (if any).
1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
if (FAILED(hr))
{
-// ShowException(szMember, hr, NULL, 0);
+ ShowException(member, hr);
delete[] argNames;
delete[] dispIds;
return false;
{
namedArgCount = 1;
dispIds[1] = DISPID_PROPERTYPUT;
- vReturnPtr = (VARIANTARG*) NULL;
+ vReturnPtr = NULL;
}
// Convert the wxVariants to VARIANTARGs
dispparams.cArgs = noArgs;
dispparams.cNamedArgs = namedArgCount;
- excep.pfnDeferredFillIn = NULL;
+ EXCEPINFO excep;
+ wxZeroMemory(excep);
hr = ((IDispatch*)m_dispatchPtr)->Invoke(dispIds[0], IID_NULL, LOCALE_SYSTEM_DEFAULT,
(WORD)action, &dispparams, vReturnPtr, &excep, &uiArgErr);
delete[] dispIds;
for (i = 0; i < noArgs; i++)
- ReleaseVariant(& oleArgs[i]) ;
+ VariantClear(& oleArgs[i]) ;
delete[] oleArgs;
if (FAILED(hr))
{
// display the exception information if appropriate:
-// ShowException((const char*) member, hr, &excep, uiArgErr);
+ ShowException(member, hr, &excep, uiArgErr);
// free exception structure information
SysFreeString(excep.bstrSource);
SysFreeString(excep.bstrHelpFile);
if (vReturnPtr)
- ReleaseVariant(vReturnPtr);
+ VariantClear(vReturnPtr);
return false;
}
else
// Mustn't release the dispatch pointer
if (vReturn.vt == VT_DISPATCH)
{
- vReturn.pdispVal = (IDispatch*) NULL;
+ vReturn.pdispVal = NULL;
}
- ReleaseVariant(& vReturn);
+ VariantClear(& vReturn);
}
}
return true;
}
}
- return (WXIDISPATCH*) NULL;
+ return NULL;
}
// Uses DISPATCH_PROPERTYGET
}
}
- return (WXIDISPATCH*) NULL;
+ return NULL;
}
return false;
}
-// Get a dispatch pointer from the current object associated
-// with a class id
-bool wxAutomationObject::GetInstance(const wxString& classId) const
+namespace
{
- if (m_dispatchPtr)
- return false;
-
- CLSID clsId;
- IUnknown * pUnk = NULL;
-
- wxBasicString unicodeName(classId.mb_str());
-
- if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
- {
- wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
- return false;
- }
- if (FAILED(GetActiveObject(clsId, NULL, &pUnk)))
+HRESULT wxCLSIDFromProgID(const wxString& progId, CLSID& clsId)
+{
+ HRESULT hr = CLSIDFromProgID(wxBasicString(progId), &clsId);
+ if ( FAILED(hr) )
{
- wxLogWarning(wxT("Cannot find an active object"));
- return false;
+ wxLogSysError(hr, _("Failed to find CLSID of \"%s\""), progId);
}
+ return hr;
+}
- if (pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr) != S_OK)
+void *DoCreateInstance(const wxString& progId, const CLSID& clsId)
+{
+ // get the server IDispatch interface
+ //
+ // NB: using CLSCTX_INPROC_HANDLER results in failure when getting
+ // Automation interface for Microsoft Office applications so don't use
+ // CLSCTX_ALL which includes it
+ void *pDispatch = NULL;
+ HRESULT hr = CoCreateInstance(clsId, NULL, CLSCTX_SERVER,
+ IID_IDispatch, &pDispatch);
+ if (FAILED(hr))
{
- wxLogWarning(wxT("Cannot find IDispatch interface"));
- return false;
+ wxLogSysError(hr, _("Failed to create an instance of \"%s\""), progId);
+ return NULL;
}
- return true;
+ return pDispatch;
}
-// Get a dispatch pointer from a new object associated
-// with the given class id
-bool wxAutomationObject::CreateInstance(const wxString& classId) const
+} // anonymous namespace
+
+// Get a dispatch pointer from the current object associated
+// with a ProgID
+bool wxAutomationObject::GetInstance(const wxString& progId, int flags) const
{
if (m_dispatchPtr)
return false;
CLSID clsId;
-
- wxBasicString unicodeName(classId.mb_str());
-
- if (FAILED(CLSIDFromProgID((BSTR) unicodeName, &clsId)))
- {
- wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
- return false;
- }
-
- // start a new copy of Excel, grab the IDispatch interface
- if (FAILED(CoCreateInstance(clsId, NULL, CLSCTX_LOCAL_SERVER, IID_IDispatch, (void**)&m_dispatchPtr)))
- {
- wxLogWarning(wxT("Cannot start an instance of this class."));
+ HRESULT hr = wxCLSIDFromProgID(progId, clsId);
+ if (FAILED(hr))
return false;
- }
-
- return true;
-}
-
-
-WXDLLEXPORT bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant)
-{
- ClearVariant(&oleVariant);
- if (variant.IsNull())
- {
- oleVariant.vt = VT_NULL;
- return true;
- }
-
- wxString type(variant.GetType());
-
-
- if (type == wxT("long"))
- {
- oleVariant.vt = VT_I4;
- oleVariant.lVal = variant.GetLong() ;
- }
- // cVal not always present
-#ifndef __GNUWIN32__
- else if (type == wxT("char"))
- {
- oleVariant.vt=VT_I1; // Signed Char
- oleVariant.cVal=variant.GetChar();
- }
-#endif
- else if (type == wxT("double"))
- {
- oleVariant.vt = VT_R8;
- oleVariant.dblVal = variant.GetDouble();
- }
- else if (type == wxT("bool"))
- {
- oleVariant.vt = VT_BOOL;
- // 'bool' required for VC++ 4 apparently
-#if (defined(__VISUALC__) && (__VISUALC__ <= 1000))
- oleVariant.bool = variant.GetBool();
-#else
- oleVariant.boolVal = variant.GetBool();
-#endif
- }
- else if (type == wxT("string"))
- {
- wxString str( variant.GetString() );
- oleVariant.vt = VT_BSTR;
- oleVariant.bstrVal = wxConvertStringToOle(str);
- }
-#if wxUSE_DATETIME
- else if (type == wxT("datetime"))
- {
- wxDateTime date( variant.GetDateTime() );
- oleVariant.vt = VT_DATE;
-
- long dosDateTime = date.GetAsDOS();
- short dosDate = short((dosDateTime & 0xFFFF0000) >> 16);
- short dosTime = short(dosDateTime & 0xFFFF);
- DosDateTimeToVariantTime(dosDate, dosTime, & oleVariant.date);
- }
-#endif
- else if (type == wxT("void*"))
- {
- oleVariant.vt = VT_DISPATCH;
- oleVariant.pdispVal = (IDispatch*) variant.GetVoidPtr();
- }
- else if (type == wxT("list") || type == wxT("stringlist"))
+ IUnknown *pUnk = NULL;
+ hr = GetActiveObject(clsId, NULL, &pUnk);
+ if (FAILED(hr))
{
- oleVariant.vt = VT_VARIANT | VT_ARRAY;
-
- SAFEARRAY *psa;
- SAFEARRAYBOUND saBound;
- VARIANTARG *pvargBase;
- VARIANTARG *pvarg;
- int i, j;
-
- int iCount = variant.GetCount();
-
- saBound.lLbound = 0;
- saBound.cElements = iCount;
-
- psa = SafeArrayCreate(VT_VARIANT, 1, &saBound);
- if (psa == NULL)
- return false;
-
- SafeArrayAccessData(psa, (void**)&pvargBase);
-
- pvarg = pvargBase;
- for (i = 0; i < iCount; i++)
+ if ( flags & wxAutomationInstance_CreateIfNeeded )
+ {
+ const_cast<wxAutomationObject *>(this)->
+ m_dispatchPtr = DoCreateInstance(progId, clsId);
+ if ( m_dispatchPtr )
+ return true;
+ }
+ else
{
- // copy each string in the list of strings
- wxVariant eachVariant(variant[i]);
- if (!wxConvertVariantToOle(eachVariant, * pvarg))
+ // Log an error except if we're supposed to fail silently when the
+ // error is that no current instance exists.
+ if ( hr != MK_E_UNAVAILABLE ||
+ !(flags & wxAutomationInstance_SilentIfNone) )
{
- // memory failure: back out and free strings alloc'ed up to
- // now, and then the array itself.
- pvarg = pvargBase;
- for (j = 0; j < i; j++)
- {
- SysFreeString(pvarg->bstrVal);
- pvarg++;
- }
- SafeArrayDestroy(psa);
- return false;
+ wxLogSysError(hr,
+ _("Cannot get an active instance of \"%s\""),
+ progId);
}
- pvarg++;
}
- SafeArrayUnaccessData(psa);
-
- oleVariant.parray = psa;
- }
- else
- {
- oleVariant.vt = VT_NULL;
return false;
}
- return true;
-}
-#ifndef VT_TYPEMASK
-#define VT_TYPEMASK 0xfff
-#endif
-
-WXDLLEXPORT bool wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant)
-{
- switch (oleVariant.vt & VT_TYPEMASK)
+ hr = pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr);
+ if (FAILED(hr))
{
- case VT_BSTR:
- {
- wxString str(wxConvertStringFromOle(oleVariant.bstrVal));
- variant = str;
- break;
- }
- case VT_DATE:
- {
-#if wxUSE_DATETIME
- unsigned short dosDate = 0;
- unsigned short dosTime = 0;
- VariantTimeToDosDateTime(oleVariant.date, & dosDate, & dosTime);
-
- long dosDateTime = (dosDate << 16) || dosTime;
- wxDateTime date;
- date.SetFromDOS(dosDateTime);
- variant = date;
-#endif
- break;
- }
- case VT_I4:
- {
- variant = (long) oleVariant.lVal;
- break;
- }
- case VT_I2:
- {
- variant = (long) oleVariant.iVal;
- break;
- }
-
- case VT_BOOL:
- {
-#if (defined(_MSC_VER) && (_MSC_VER <= 1000) && !defined(__MWERKS__) ) //GC
-#ifndef HAVE_BOOL // Can't use bool operator if no native bool type
- variant = (long) (oleVariant.bool != 0);
-#else
- variant = (bool) (oleVariant.bool != 0);
-#endif
-#else
-#ifndef HAVE_BOOL // Can't use bool operator if no native bool type
- variant = (long) (oleVariant.boolVal != 0);
-#else
- variant = (bool) (oleVariant.boolVal != 0);
-#endif
-#endif
- break;
- }
- case VT_R8:
- {
- variant = oleVariant.dblVal;
- break;
- }
- case VT_ARRAY:
- {
- variant.ClearList();
-
- int cDims, cElements, i;
- VARIANTARG* pvdata;
-
- // Iterate the dimensions: number of elements is x*y*z
- for (cDims = 0, cElements = 1;
- cDims < oleVariant.parray->cDims; cDims ++)
- cElements *= oleVariant.parray->rgsabound[cDims].cElements;
-
- // Get a pointer to the data
- HRESULT hr = SafeArrayAccessData(oleVariant.parray, (void HUGEP* FAR*) & pvdata);
- if (hr != NOERROR)
- return false;
- // Iterate the data.
- for (i = 0; i < cElements; i++)
- {
- VARIANTARG& oleElement = pvdata[i];
- wxVariant vElement;
- if (!wxConvertOleToVariant(oleElement, vElement))
- return false;
-
- variant.Append(vElement);
- }
- SafeArrayUnaccessData(oleVariant.parray);
- break;
- }
- case VT_DISPATCH:
- {
- variant = (void*) oleVariant.pdispVal;
- break;
- }
- case VT_NULL:
- {
- variant.MakeNull();
- break;
- }
- case VT_EMPTY:
- {
- break; // Ignore Empty Variant, used only during destruction of objects
- }
- default:
- {
- wxLogError(wxT("wxAutomationObject::ConvertOleToVariant: Unknown variant value type"));
- return false;
- }
+ wxLogSysError(hr,
+ _("Failed to get OLE automation interface for \"%s\""),
+ progId);
+ return false;
}
- return true;
-}
-/*
- * ClearVariant
- *
- * Zeros a variant structure without regard to current contents
- */
-static void ClearVariant(VARIANTARG *pvarg)
-{
- pvarg->vt = VT_EMPTY;
- pvarg->wReserved1 = 0;
- pvarg->wReserved2 = 0;
- pvarg->wReserved3 = 0;
- pvarg->lVal = 0;
+ return true;
}
-/*
- * ReleaseVariant
- *
- * Clears a particular variant structure and releases any external objects
- * or memory contained in the variant. Supports the data types listed above.
- */
-static void ReleaseVariant(VARIANTARG *pvarg)
+// Get a dispatch pointer from a new object associated
+// with the given ProgID
+bool wxAutomationObject::CreateInstance(const wxString& progId) const
{
- VARTYPE vt;
- VARIANTARG _huge *pvargArray;
- long lLBound, lUBound, l;
-
- vt = (VARTYPE)(pvarg->vt & 0xfff); // mask off flags
-
- // check if an array. If so, free its contents, then the array itself.
- if (V_ISARRAY(pvarg))
- {
- // variant arrays are all this routine currently knows about. Since a
- // variant can contain anything (even other arrays), call ourselves
- // recursively.
- if (vt == VT_VARIANT)
- {
- SafeArrayGetLBound(pvarg->parray, 1, &lLBound);
- SafeArrayGetUBound(pvarg->parray, 1, &lUBound);
-
- if (lUBound > lLBound)
- {
- lUBound -= lLBound;
-
- SafeArrayAccessData(pvarg->parray, (void**)&pvargArray);
-
- for (l = 0; l < lUBound; l++)
- {
- ReleaseVariant(pvargArray);
- pvargArray++;
- }
+ if (m_dispatchPtr)
+ return false;
- SafeArrayUnaccessData(pvarg->parray);
- }
- }
- else
- {
- wxLogWarning(wxT("ReleaseVariant: Array contains non-variant type"));
- }
+ CLSID clsId;
+ HRESULT hr = wxCLSIDFromProgID(progId, clsId);
+ if (FAILED(hr))
+ return false;
- // Free the array itself.
- SafeArrayDestroy(pvarg->parray);
- }
- else
- {
- switch (vt)
- {
- case VT_DISPATCH:
- if (pvarg->pdispVal)
- pvarg->pdispVal->Release();
- break;
-
- case VT_BSTR:
- SysFreeString(pvarg->bstrVal);
- break;
-
- case VT_I2:
- case VT_I4:
- case VT_BOOL:
- case VT_R8:
- case VT_ERROR: // to avoid erroring on an error return from Excel
- case VT_EMPTY:
- // no work for these types
- break;
-
- default:
- wxLogWarning(wxT("ReleaseVariant: Unknown type"));
- break;
- }
- }
+ const_cast<wxAutomationObject *>(this)->
+ m_dispatchPtr = DoCreateInstance(progId, clsId);
- ClearVariant(pvarg);
+ return m_dispatchPtr != NULL;
}
-#if 0
-
-void ShowException(LPOLESTR szMember, HRESULT hr, EXCEPINFO *pexcep, unsigned int uiArgErr)
+static void
+ShowException(const wxString& member,
+ HRESULT hr,
+ EXCEPINFO *pexcep,
+ unsigned int uiArgErr)
{
- TCHAR szBuf[512];
-
+ wxString message;
switch (GetScode(hr))
{
case DISP_E_UNKNOWNNAME:
- wsprintf(szBuf, L"%s: Unknown name or named argument.", szMember);
+ message = _("Unknown name or named argument.");
break;
case DISP_E_BADPARAMCOUNT:
- wsprintf(szBuf, L"%s: Incorrect number of arguments.", szMember);
+ message = _("Incorrect number of arguments.");
break;
case DISP_E_EXCEPTION:
- wsprintf(szBuf, L"%s: Error %d: ", szMember, pexcep->wCode);
- if (pexcep->bstrDescription != NULL)
- lstrcat(szBuf, pexcep->bstrDescription);
+ if ( pexcep )
+ {
+ if ( pexcep->bstrDescription )
+ message << pexcep->bstrDescription << wxS(" ");
+ message += wxString::Format(wxS("error code %u"), pexcep->wCode);
+ }
else
- lstrcat(szBuf, L"<<No Description>>");
+ {
+ message = _("Unknown exception");
+ }
break;
case DISP_E_MEMBERNOTFOUND:
- wsprintf(szBuf, L"%s: method or property not found.", szMember);
+ message = _("Method or property not found.");
break;
case DISP_E_OVERFLOW:
- wsprintf(szBuf, L"%s: Overflow while coercing argument values.", szMember);
+ message = _("Overflow while coercing argument values.");
break;
case DISP_E_NONAMEDARGS:
- wsprintf(szBuf, L"%s: Object implementation does not support named arguments.",
- szMember);
+ message = _("Object implementation does not support named arguments.");
break;
case DISP_E_UNKNOWNLCID:
- wsprintf(szBuf, L"%s: The locale ID is unknown.", szMember);
+ message = _("The locale ID is unknown.");
break;
case DISP_E_PARAMNOTOPTIONAL:
- wsprintf(szBuf, L"%s: Missing a required parameter.", szMember);
+ message = _("Missing a required parameter.");
break;
case DISP_E_PARAMNOTFOUND:
- wsprintf(szBuf, L"%s: Argument not found, argument %d.", szMember, uiArgErr);
+ message.Printf(_("Argument %u not found."), uiArgErr);
break;
case DISP_E_TYPEMISMATCH:
- wsprintf(szBuf, L"%s: Type mismatch, argument %d.", szMember, uiArgErr);
+ message.Printf(_("Type mismatch in argument %u."), uiArgErr);
+ break;
+
+ case ERROR_FILE_NOT_FOUND:
+ message = _("The system cannot find the file specified.");
+ break;
+
+ case REGDB_E_CLASSNOTREG:
+ message = _("Class not registered.");
break;
default:
- wsprintf(szBuf, L"%s: Unknown error occurred.", szMember);
+ message.Printf(_("Unknown error %08x"), hr);
break;
}
- wxLogWarning(szBuf);
+ wxLogError(_("OLE Automation error in %s: %s"), member, message);
}
-#endif
-
#endif // wxUSE_OLE_AUTOMATION
projects / wxWidgets.git / blobdiff