]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/ole/oleutils.h
Allow headers to be compiled in Objective-C++ mode
[wxWidgets.git] / include / wx / msw / ole / oleutils.h
index 1430abbbe294aecd3e20e65703cfb161354c65b9..afab7f2854375b1a95acbd73ebd5d0b795b542eb 100644 (file)
@@ -2,20 +2,25 @@
 // Name:        oleutils.h
 // Purpose:     OLE helper routines, OLE debugging support &c
 // Author:      Vadim Zeitlin
-// Modified by: 
+// Modified by:
 // Created:     19.02.1998
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#ifndef   _OLEUTILS_H
-#define   _OLEUTILS_H
+#ifndef   _WX_OLEUTILS_H
+#define   _WX_OLEUTILS_H
 
 #ifdef __GNUG__
 #pragma interface "oleutils.h"
 #endif
 
+#include "wx/defs.h"
+
+// get IUnknown, REFIID &c
+#include <ole2.h>
+
 // ============================================================================
 // General purpose functions and macros
 // ============================================================================
@@ -35,32 +40,54 @@ inline void ReleaseInterface(IUnknown *pIUnk)
 #define   RELEASE_AND_NULL(p)   if ( (p) != NULL ) { p->Release(); p = NULL; };
 
 // return TRUE if the iid is in the array
-bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
+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 
+   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_METHOS in your (IUnknown derived!) class declaration
+   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_METHOS somewhere also
+   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) { return m_Value = 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 **);                    \
@@ -68,7 +95,7 @@ bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
     STDMETHODIMP_(ULONG)  Release();                                          \
   private:                                                                    \
     static  const IID    *ms_aIids[];                                         \
-    ULONG                 m_cRef
+    wxAutoULong           m_cRef
 
 // macros for declaring supported interfaces
 // NB: you should write ADD_INTERFACE(Foo) and not ADD_INTERFACE(IID_IFoo)!
@@ -81,9 +108,9 @@ bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
 #define   IMPLEMENT_IUNKNOWN_METHODS(classname)                               \
   STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv)             \
   {                                                                           \
-    wxLogQueryInterface(#classname, riid);                                    \
+    wxLogQueryInterface(_T(#classname), riid);                                \
                                                                               \
-    if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) {                  \
+    if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) {                \
       *ppv = this;                                                            \
       AddRef();                                                               \
                                                                               \
@@ -92,20 +119,20 @@ bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
     else {                                                                    \
       *ppv = NULL;                                                            \
                                                                               \
-      return (HRESULT) E_NOINTERFACE;                                                   \
+      return (HRESULT) E_NOINTERFACE;                                         \
     }                                                                         \
   }                                                                           \
                                                                               \
   STDMETHODIMP_(ULONG) classname::AddRef()                                    \
   {                                                                           \
-    wxLogAddRef(#classname, m_cRef);                                          \
+    wxLogAddRef(_T(#classname), m_cRef);                                      \
                                                                               \
     return ++m_cRef;                                                          \
   }                                                                           \
                                                                               \
   STDMETHODIMP_(ULONG) classname::Release()                                   \
   {                                                                           \
-    wxLogRelease(#classname, m_cRef);                                         \
+    wxLogRelease(_T(#classname), m_cRef);                                     \
                                                                               \
     if ( --m_cRef == 0 ) {                                                    \
       delete this;                                                            \
@@ -119,27 +146,65 @@ bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
 // Debugging support
 // ============================================================================
 
-#ifdef  __DEBUG__
-
-// ----------------------------------------------------------------------------
-// 
-// ----------------------------------------------------------------------------
-
+// 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 char *szInterface, REFIID riid);
+void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);
 
 // these functions print out the new value of reference counter
-void wxLogAddRef (const char *szInterface, ULONG cRef);
-void wxLogRelease(const char *szInterface, ULONG cRef);
+void wxLogAddRef (const wxChar *szInterface, ULONG cRef);
+void wxLogRelease(const wxChar *szInterface, ULONG cRef);
 
-#else   //!DEBUG
+#else   //!WXDEBUG
   #define   wxLogQueryInterface(szInterface, riid)
   #define   wxLogAddRef(szInterface, cRef)
   #define   wxLogRelease(szInterface, cRef)
-#endif  //DEBUG
+#endif  //WXDEBUG
+
+// wrapper around BSTR type (by Vadim Zeitlin)
+
+class WXDLLEXPORT wxBasicString
+{
+public:
+    // ctors & dtor
+    wxBasicString(const char *sz);
+    wxBasicString(const wxString& str);
+    ~wxBasicString();
+    
+    void Init(const char* sz);
+    
+    // accessors
+    // just get the string
+    operator BSTR() const { return m_wzBuf; }
+    // retrieve a copy of our string - caller must SysFreeString() it later!
+    BSTR Get() const { return SysAllocString(m_wzBuf); }
+    
+private:
+    // @@@ not implemented (but should be)
+    wxBasicString(const wxBasicString&);
+    wxBasicString& operator=(const wxBasicString&);
+    
+    OLECHAR *m_wzBuf;     // actual string
+};
+
+// Convert variants
+class WXDLLEXPORT wxVariant;
+
+bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant) ;
+bool wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant) ;
+
+// Convert string to Unicode
+BSTR wxConvertStringToOle(const wxString& str);
+
+// Convert string from BSTR to wxString
+wxString wxConvertStringFromOle(BSTR bStr);
+
+
+#endif  //_WX_OLEUTILS_H
 
-#endif  //_OLEUTILS_H
\ No newline at end of file