/////////////////////////////////////////////////////////////////////////////// // Name: oleutils.h // Purpose: OLE helper routines, OLE debugging support &c // Author: Vadim Zeitlin // Modified by: // Created: 19.02.1998 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_OLEUTILS_H #define _WX_OLEUTILS_H #include "wx/defs.h" #if wxUSE_OLE // ole2.h includes windows.h, so include wrapwin.h first #include "wx/msw/wrapwin.h" // get IUnknown, REFIID &c #include #include "wx/intl.h" #include "wx/log.h" // ============================================================================ // General purpose functions and macros // ============================================================================ // ---------------------------------------------------------------------------- // initialize/cleanup OLE // ---------------------------------------------------------------------------- // call OleInitialize() or CoInitialize[Ex]() depending on the platform // // return true if ok, false otherwise inline bool wxOleInitialize() { // we need to initialize OLE library #ifdef __WXWINCE__ if ( FAILED(::CoInitializeEx(NULL, COINIT_MULTITHREADED)) ) #else if ( FAILED(::OleInitialize(NULL)) ) #endif { wxLogError(_("Cannot initialize OLE")); return false; } return true; } inline void wxOleUninitialize() { #ifdef __WXWINCE__ ::CoUninitialize(); #else ::OleUninitialize(); #endif } // ---------------------------------------------------------------------------- // misc helper functions/macros // ---------------------------------------------------------------------------- // release the interface pointer (if !NULL) inline void ReleaseInterface(IUnknown *pIUnk) { if ( pIUnk != NULL ) pIUnk->Release(); } // release the interface pointer (if !NULL) and make it NULL #define RELEASE_AND_NULL(p) if ( (p) != NULL ) { p->Release(); p = NULL; }; // return true if the iid is in the array extern bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount); // ============================================================================ // IUnknown implementation helpers // ============================================================================ /* The most dumb implementation of IUnknown methods. We don't support aggregation nor containment, but for 99% of cases this simple implementation is quite enough. Usage is trivial: here is all you should have 1) DECLARE_IUNKNOWN_METHODS in your (IUnknown derived!) class declaration 2) BEGIN/END_IID_TABLE with ADD_IID in between for all interfaces you support (at least all for which you intent to return 'this' from QI, i.e. you should derive from IFoo if you have ADD_IID(Foo)) somewhere else 3) IMPLEMENT_IUNKNOWN_METHODS somewhere also These macros are quite simple: AddRef and Release are trivial and QI does lookup in a static member array of IIDs and returns 'this' if it founds the requested interface in it or E_NOINTERFACE if not. */ /* wxAutoULong: this class is used for automatically initalising m_cRef to 0 */ class wxAutoULong { public: wxAutoULong(ULONG value = 0) : m_Value(value) { } operator ULONG&() { return m_Value; } ULONG& operator=(ULONG value) { m_Value = value; return m_Value; } wxAutoULong& operator++() { ++m_Value; return *this; } const wxAutoULong operator++( int ) { wxAutoULong temp = *this; ++m_Value; return temp; } wxAutoULong& operator--() { --m_Value; return *this; } const wxAutoULong operator--( int ) { wxAutoULong temp = *this; --m_Value; return temp; } private: ULONG m_Value; }; // declare the methods and the member variable containing reference count // you must also define the ms_aIids array somewhere with BEGIN_IID_TABLE // and friends (see below) #define DECLARE_IUNKNOWN_METHODS \ public: \ STDMETHODIMP QueryInterface(REFIID, void **); \ STDMETHODIMP_(ULONG) AddRef(); \ STDMETHODIMP_(ULONG) Release(); \ private: \ static const IID *ms_aIids[]; \ wxAutoULong m_cRef // macros for declaring supported interfaces // NB: you should write ADD_INTERFACE(Foo) and not ADD_INTERFACE(IID_IFoo)! #define BEGIN_IID_TABLE(cname) const IID *cname::ms_aIids[] = { #define ADD_IID(iid) &IID_I##iid, #define END_IID_TABLE } // implementation is as straightforward as possible // Parameter: classname - the name of the class #define IMPLEMENT_IUNKNOWN_METHODS(classname) \ STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv) \ { \ wxLogQueryInterface(_T(#classname), riid); \ \ if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) { \ *ppv = this; \ AddRef(); \ \ return S_OK; \ } \ else { \ *ppv = NULL; \ \ return (HRESULT) E_NOINTERFACE; \ } \ } \ \ STDMETHODIMP_(ULONG) classname::AddRef() \ { \ wxLogAddRef(_T(#classname), m_cRef); \ \ return ++m_cRef; \ } \ \ STDMETHODIMP_(ULONG) classname::Release() \ { \ wxLogRelease(_T(#classname), m_cRef); \ \ if ( --m_cRef == wxAutoULong(0) ) { \ delete this; \ return 0; \ } \ else \ return m_cRef; \ } // ============================================================================ // Debugging support // ============================================================================ // VZ: I don't know it's not done for compilers other than VC++ but I leave it // as is. Please note, though, that tracing OLE interface calls may be // incredibly useful when debugging OLE programs. #if defined(__WXDEBUG__) && ( ( defined(__VISUALC__) && (__VISUALC__ >= 1000) ) || defined(__MWERKS__) ) // ---------------------------------------------------------------------------- // All OLE specific log functions have DebugTrace level (as LogTrace) // ---------------------------------------------------------------------------- // tries to translate riid into a symbolic name, if possible void wxLogQueryInterface(const wxChar *szInterface, REFIID riid); // these functions print out the new value of reference counter void wxLogAddRef (const wxChar *szInterface, ULONG cRef); void wxLogRelease(const wxChar *szInterface, ULONG cRef); #else //!__WXDEBUG__ #define wxLogQueryInterface(szInterface, riid) #define wxLogAddRef(szInterface, cRef) #define wxLogRelease(szInterface, cRef) #endif //__WXDEBUG__ // wrapper around BSTR type (by Vadim Zeitlin) class WXDLLIMPEXP_CORE wxBasicString { public: // ctors & dtor wxBasicString(const wxString& str); wxBasicString(const wxBasicString& bstr); ~wxBasicString(); wxBasicString& operator=(const wxBasicString& bstr); // accessors // just get the string operator BSTR() const { return m_bstrBuf; } // retrieve a copy of our string - caller must SysFreeString() it later! BSTR Get() const { return SysAllocString(m_bstrBuf); } private: // actual string BSTR m_bstrBuf; }; #if wxUSE_VARIANT // Convert variants class WXDLLIMPEXP_FWD_BASE wxVariant; WXDLLIMPEXP_CORE bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant); WXDLLIMPEXP_CORE bool wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant); #endif // wxUSE_VARIANT // Convert string to Unicode WXDLLIMPEXP_CORE BSTR wxConvertStringToOle(const wxString& str); // Convert string from BSTR to wxString WXDLLIMPEXP_CORE wxString wxConvertStringFromOle(BSTR bStr); #else // !wxUSE_OLE // ---------------------------------------------------------------------------- // stub functions to avoid #if wxUSE_OLE in the main code // ---------------------------------------------------------------------------- inline bool wxOleInitialize() { return false; } inline void wxOleUninitialize() { } #endif // wxUSE_OLE/!wxUSE_OLE #endif //_WX_OLEUTILS_H