TIFF fix.

[wxWidgets.git] / src / msw / clipbrd.cpp

diff --git a/src/msw/clipbrd.cpp b/src/msw/clipbrd.cpp
index bd37c1ba565ca1fae7fa75b599a18e3975bb2e6d..1166f73e3304cafe41b36d1839fdefc14e5855de 100644 (file)
--- a/src/msw/clipbrd.cpp
+++ b/src/msw/clipbrd.cpp
@@ -6,461 +6,823 @@
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows license
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// ===========================================================================
+// declarations
+// ===========================================================================
+
+// ---------------------------------------------------------------------------
+// headers
+// ---------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "clipbrd.h"
+    #pragma implementation "clipbrd.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-#include "wx/setup.h"
+    #include "wx/setup.h"

 #endif
 
 #if wxUSE_CLIPBOARD
 
 #ifndef WX_PRECOMP
 #endif
 
 #if wxUSE_CLIPBOARD
 
 #ifndef WX_PRECOMP

-#include "wx/object.h"
-#include "wx/event.h"
-#include "wx/app.h"
-#include "wx/frame.h"
-#include "wx/bitmap.h"
-#include "wx/utils.h"
+    #include "wx/object.h"
+    #include "wx/event.h"
+    #include "wx/app.h"
+    #include "wx/frame.h"
+    #include "wx/bitmap.h"
+    #include "wx/utils.h"
+    #include "wx/intl.h"
+#endif
+
+#if wxUSE_METAFILE
+    #include "wx/metafile.h"

 #endif
 
 #endif
 

-#include "wx/metafile.h"
+#include "wx/log.h"

 #include "wx/clipbrd.h"
 #include "wx/clipbrd.h"

+
+#include <string.h>
+#include <windows.h>
+

 #include "wx/msw/private.h"
 #include "wx/msw/dib.h"
 
 #include "wx/msw/private.h"
 #include "wx/msw/dib.h"
 

-#include <string.h>
+// wxDataObject is tied to OLE/drag and drop implementation, therefore so are
+// the functions using wxDataObject in wxClipboard
+#define wxUSE_DATAOBJ wxUSE_DRAG_AND_DROP

 
 

-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
-IMPLEMENT_ABSTRACT_CLASS(wxClipboardClient, wxObject)
+#if wxUSE_DATAOBJ
+    #include "wx/dataobj.h"
+
+    // use OLE clipboard
+    #define wxUSE_OLE_CLIPBOARD 1
+#else // !wxUSE_DATAOBJ
+    // use Win clipboard API
+    #define wxUSE_OLE_CLIPBOARD 0

 #endif
 
 #endif
 

-bool wxClipboardIsOpen = FALSE;
+#if wxUSE_OLE_CLIPBOARD
+    #include <ole2.h>
+#endif // wxUSE_OLE_CLIPBOARD

 
 

-bool wxOpenClipboard(void)
-{
-  if (wxTheApp->GetTopWindow() && !wxClipboardIsOpen)
-  {
-    wxClipboardIsOpen = (::OpenClipboard((HWND) wxTheApp->GetTopWindow()->GetHWND()) != 0);
-    return wxClipboardIsOpen;
-  }
-  else return FALSE;
-}
+#ifdef __WIN16__
+    #define memcpy hmemcpy
+#endif
+
+// ===========================================================================
+// implementation
+// ===========================================================================

 
 

-bool wxCloseClipboard(void)
+// ---------------------------------------------------------------------------
+// old-style clipboard functions using Windows API
+// ---------------------------------------------------------------------------
+
+static bool gs_wxClipboardIsOpen = FALSE;
+
+bool wxOpenClipboard()

 {
 {

-  if (wxClipboardIsOpen)
-  {
-    wxClipboardIsOpen = FALSE;
-  }
-  return (::CloseClipboard() != 0);
+    wxCHECK_MSG( !gs_wxClipboardIsOpen, TRUE, wxT("clipboard already opened.") );
+
+    wxWindow *win = wxTheApp->GetTopWindow();
+    if ( win )
+    {
+        gs_wxClipboardIsOpen = ::OpenClipboard((HWND)win->GetHWND()) != 0;
+
+        if ( !gs_wxClipboardIsOpen )
+            wxLogSysError(_("Failed to open the clipboard."));
+
+        return gs_wxClipboardIsOpen;
+    }
+    else
+    {
+        wxLogDebug(wxT("Can not open clipboard without a main window."));
+
+        return FALSE;
+    }

 }
 
 }
 

-bool wxEmptyClipboard(void)
+bool wxCloseClipboard()

 {
 {

-  return (::EmptyClipboard() != 0);
+    wxCHECK_MSG( gs_wxClipboardIsOpen, FALSE, wxT("clipboard is not opened") );
+
+    gs_wxClipboardIsOpen = FALSE;
+
+    if ( ::CloseClipboard() == 0 )
+    {
+        wxLogSysError(_("Failed to close the clipboard."));
+
+        return FALSE;
+    }
+
+    return TRUE;

 }
 
 }
 

-bool wxClipboardOpen(void)
+bool wxEmptyClipboard()

 {
 {

-  return wxClipboardIsOpen;
+    if ( ::EmptyClipboard() == 0 )
+    {
+        wxLogSysError(_("Failed to empty the clipboard."));
+
+        return FALSE;
+    }
+
+    return TRUE;

 }
 
 }
 

-bool wxIsClipboardFormatAvailable(int dataFormat)
+bool wxIsClipboardOpened()

 {
 {

-  return (::IsClipboardFormatAvailable(dataFormat) != 0);
+  return gs_wxClipboardIsOpen;

 }
 
 }
 

-bool wxSetClipboardData(int dataFormat, wxObject *obj, int width, int height)
+bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)

 {
 {

-  switch (dataFormat)
-  {
-    case wxDF_BITMAP:
+    if ( ::IsClipboardFormatAvailable(dataFormat) )

     {
     {

-      wxBitmap *wxBM = (wxBitmap *)obj;
-
-      HDC hdcMem = CreateCompatibleDC(NULL);
-      HDC hdcSrc = CreateCompatibleDC(NULL);
-      HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, (HBITMAP) wxBM->GetHBITMAP());
-      HBITMAP hBitmap = CreateCompatibleBitmap(hdcSrc,
-                                              wxBM->GetWidth(), wxBM->GetHeight());
-      if (!hBitmap)
-      {
-        SelectObject(hdcSrc, old);
-        DeleteDC(hdcMem);
-        DeleteDC(hdcSrc);
-        return FALSE;
-      }
-      HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
-      BitBlt(hdcMem, 0, 0, wxBM->GetWidth(), wxBM->GetHeight(),
-             hdcSrc, 0, 0, SRCCOPY);
-
-      // Select new bitmap out of memory DC
-      SelectObject(hdcMem, old1);
-
-      // Set the data
-      bool success = (bool)(::SetClipboardData(CF_BITMAP, hBitmap) != 0);
-
-      // Clean up
-      SelectObject(hdcSrc, old);
-      DeleteDC(hdcSrc);
-      DeleteDC(hdcMem);      
-      return success;
-      break;
+        // ok from the first try
+        return TRUE;

     }
     }

-    case wxDF_DIB:
-    {
-#if wxUSE_IMAGE_LOADING_IN_MSW
-      HBITMAP hBitmap=(HBITMAP) ((wxBitmap *)obj)->GetHBITMAP();
-      HANDLE hDIB=BitmapToDIB(hBitmap,NULL); // NULL==uses system palette
-      bool success = (::SetClipboardData(CF_DIB,hDIB) != 0);
-#else
-      bool success=FALSE;
-#endif
-      return success;
-      break;
-    }
-#if wxUSE_METAFILE
-    case wxDF_METAFILE:
+
+    // for several standard formats, we can convert from some other ones too
+    switch ( dataFormat.GetFormatId() )

     {
     {

-      wxMetaFile *wxMF = (wxMetaFile *)obj;
-      HANDLE data = GlobalAlloc(GHND, sizeof(METAFILEPICT) + 1);
-#ifdef __WINDOWS_386__
-      METAFILEPICT *mf = (METAFILEPICT *)MK_FP32(GlobalLock(data));
-#else
-      METAFILEPICT *mf = (METAFILEPICT *)GlobalLock(data);
-#endif
+        // for bitmaps, DIBs will also do
+        case CF_BITMAP:
+            return ::IsClipboardFormatAvailable(CF_DIB) != 0;

 
 

-      mf->mm = wxMF->GetWindowsMappingMode();
-      mf->xExt = width;
-      mf->yExt = height;
-      mf->hMF = (HMETAFILE) wxMF->GetHMETAFILE();
-      GlobalUnlock(data);
-      wxMF->SetHMETAFILE((WXHANDLE) NULL);
+#if wxUSE_ENH_METAFILE
+        case CF_METAFILEPICT:
+            return ::IsClipboardFormatAvailable(CF_ENHMETAFILE) != 0;
+#endif // wxUSE_ENH_METAFILE

 
 

-      return (SetClipboardData(CF_METAFILEPICT, data) != 0);
-      break;
+        default:
+            return FALSE;

     }
     }

-#endif
-    case CF_SYLK:
-    case CF_DIF:
-    case CF_TIFF:
-    case CF_PALETTE:
+}
+
+bool wxSetClipboardData(wxDataFormat dataFormat,
+                        const void *data,
+                        int width, int height)
+{
+    HANDLE handle = 0; // return value of SetClipboardData
+
+    switch (dataFormat)

     {
     {

-      return FALSE;
-      break;
+        case wxDF_BITMAP:
+            {
+                wxBitmap *bitmap = (wxBitmap *)data;
+
+                HDC hdcMem = CreateCompatibleDC((HDC) NULL);
+                HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
+                HBITMAP old = (HBITMAP)
+                    ::SelectObject(hdcSrc, (HBITMAP)bitmap->GetHBITMAP());
+                HBITMAP hBitmap = CreateCompatibleBitmap(hdcSrc,
+                                                         bitmap->GetWidth(),
+                                                         bitmap->GetHeight());
+                if (!hBitmap)
+                {
+                    SelectObject(hdcSrc, old);
+                    DeleteDC(hdcMem);
+                    DeleteDC(hdcSrc);
+                    return FALSE;
+                }
+
+                HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hBitmap);
+                BitBlt(hdcMem, 0, 0, bitmap->GetWidth(), bitmap->GetHeight(),
+                       hdcSrc, 0, 0, SRCCOPY);
+
+                // Select new bitmap out of memory DC
+                SelectObject(hdcMem, old1);
+
+                // Set the data
+                handle = ::SetClipboardData(CF_BITMAP, hBitmap);
+
+                // Clean up
+                SelectObject(hdcSrc, old);
+                DeleteDC(hdcSrc);
+                DeleteDC(hdcMem);
+                break;
+            }
+
+        case wxDF_DIB:
+            {
+#if wxUSE_IMAGE_LOADING_IN_MSW
+                wxBitmap *bitmap = (wxBitmap *)data;
+                HBITMAP hBitmap = (HBITMAP)bitmap->GetHBITMAP();
+                // NULL palette means to use the system one
+                HANDLE hDIB = wxBitmapToDIB(hBitmap, (HPALETTE)NULL); 
+                handle = SetClipboardData(CF_DIB, hDIB);
+#endif // wxUSE_IMAGE_LOADING_IN_MSW
+                break;
+            }
+
+    // VZ: I'm told that this code works, but it doesn't seem to work for me
+    //     and, anyhow, I'd be highly surprized if it did. So I leave it here
+    //     but IMNSHO it is completely broken.
+#if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH)
+        case wxDF_METAFILE:
+            {
+                wxMetafile *wxMF = (wxMetafile *)data;
+                HANDLE data = GlobalAlloc(GHND, sizeof(METAFILEPICT) + 1);
+                METAFILEPICT *mf = (METAFILEPICT *)GlobalLock(data);
+
+                mf->mm = wxMF->GetWindowsMappingMode();
+                mf->xExt = width;
+                mf->yExt = height;
+                mf->hMF = (HMETAFILE) wxMF->GetHMETAFILE();
+                GlobalUnlock(data);
+                wxMF->SetHMETAFILE((WXHANDLE) NULL);
+
+                handle = SetClipboardData(CF_METAFILEPICT, data);
+                break;
+            }
+#endif // wxUSE_METAFILE
+
+#if wxUSE_ENH_METAFILE
+        case wxDF_ENHMETAFILE:
+            {
+                wxEnhMetaFile *emf = (wxEnhMetaFile *)data;
+                wxEnhMetaFile emfCopy = *emf;
+
+                handle = SetClipboardData(CF_ENHMETAFILE,
+                                          (void *)emfCopy.GetHENHMETAFILE());
+            }
+            break;
+#endif // wxUSE_ENH_METAFILE
+
+        case CF_SYLK:
+        case CF_DIF:
+        case CF_TIFF:
+        case CF_PALETTE:
+        default:
+            {
+                wxLogError(_("Unsupported clipboard format."));
+                return FALSE;
+            }
+
+        case wxDF_OEMTEXT:
+            dataFormat = wxDF_TEXT;
+            // fall through
+
+        case wxDF_TEXT:
+            {
+                char *s = (char *)data;
+
+                width = strlen(s) + 1;
+                height = 1;
+                DWORD l = (width * height);
+                HANDLE hGlobalMemory = GlobalAlloc(GHND, l);
+                if ( hGlobalMemory )
+                {
+                    LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
+
+                    memcpy(lpGlobalMemory, s, l);
+
+                    GlobalUnlock(hGlobalMemory);
+                }
+
+                handle = SetClipboardData(dataFormat, hGlobalMemory);
+                break;
+            }

     }
     }

-    case wxDF_OEMTEXT:
-      dataFormat = wxDF_TEXT;
-    case wxDF_TEXT:
-       width = strlen((char *)obj) + 1;
-       height = 1;
-    default:
+
+    if ( handle == 0 )

     {
     {

-      char *s = (char *)obj;
-      DWORD l;
+        wxLogSysError(_("Failed to set clipboard data."));

 
 

-      l = (width * height);
-      HANDLE hGlobalMemory = GlobalAlloc(GHND, l);
-                if (!hGlobalMemory)

         return FALSE;
         return FALSE;

-
-#ifdef __WINDOWS_386__
-      LPSTR lpGlobalMemory = (LPSTR)MK_FP32(GlobalLock(hGlobalMemory));
-#else
-      LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
-#endif
-
-#ifdef __WIN32__
-      memcpy(lpGlobalMemory, s, l);
-#elif defined(__WATCOMC__) && defined(__WINDOWS_386__)
-      memcpy(lpGlobalMemory, s, l);
-#else
-      hmemcpy(lpGlobalMemory, s, l);
-#endif
-
-      GlobalUnlock(hGlobalMemory);
-      HANDLE success = SetClipboardData(dataFormat, hGlobalMemory);
-      return (success != 0);
-      break;

     }
     }

-  }
-  return FALSE;
+
+    return TRUE;

 }
 
 }
 

-wxObject *wxGetClipboardData(int dataFormat, long *len)
+void *wxGetClipboardData(wxDataFormat dataFormat, long *len)

 {
 {

-  switch (dataFormat)
-  {
-    case wxDF_BITMAP:
-    {
-      BITMAP bm;
-      HBITMAP hBitmap = (HBITMAP) GetClipboardData(CF_BITMAP);
-      if (!hBitmap)
-        return NULL;
-
-      HDC hdcMem = CreateCompatibleDC(NULL);
-      HDC hdcSrc = CreateCompatibleDC(NULL);
-
-      HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, hBitmap);
-      GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
-
-      HBITMAP hNewBitmap = CreateBitmapIndirect(&bm);
-
-      if (!hNewBitmap)
-      {
-        SelectObject(hdcSrc, old);
-        DeleteDC(hdcMem);
-        DeleteDC(hdcSrc);
-        return NULL;
-      }
-
-      HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hNewBitmap);
-      BitBlt(hdcMem, 0, 0, bm.bmWidth, bm.bmHeight,
-             hdcSrc, 0, 0, SRCCOPY);
-
-      // Select new bitmap out of memory DC
-      SelectObject(hdcMem, old1);
-
-      // Clean up
-      SelectObject(hdcSrc, old);
-      DeleteDC(hdcSrc);
-      DeleteDC(hdcMem);
-
-      // Create and return a new wxBitmap
-      wxBitmap *wxBM = new wxBitmap;
-      wxBM->SetHBITMAP((WXHBITMAP) hNewBitmap);
-      wxBM->SetWidth(bm.bmWidth);
-      wxBM->SetHeight(bm.bmHeight);
-      wxBM->SetDepth(bm.bmPlanes);
-      wxBM->SetOk(TRUE);
-      return (wxObject *)wxBM;
-      break;
-    }
-    case wxDF_METAFILE:
-    case CF_SYLK:
-    case CF_DIF:
-    case CF_TIFF:
-    case CF_PALETTE:
-    case wxDF_DIB:
-    {
-      return FALSE;
-      break;
-    }
-    case wxDF_OEMTEXT:
-      dataFormat = wxDF_TEXT;
-         case wxDF_TEXT:
-    default:
+    void *retval = NULL;
+
+    switch ( dataFormat )

     {
     {

-      HANDLE hGlobalMemory = GetClipboardData(dataFormat);
-      if (!hGlobalMemory)
-        return NULL;
+        case wxDF_BITMAP:
+            {
+                BITMAP bm;
+                HBITMAP hBitmap = (HBITMAP) GetClipboardData(CF_BITMAP);
+                if (!hBitmap)
+                    break;
+
+                HDC hdcMem = CreateCompatibleDC((HDC) NULL);
+                HDC hdcSrc = CreateCompatibleDC((HDC) NULL);
+
+                HBITMAP old = (HBITMAP) ::SelectObject(hdcSrc, hBitmap);
+                GetObject(hBitmap, sizeof(BITMAP), (LPSTR)&bm);
+
+                HBITMAP hNewBitmap = CreateBitmapIndirect(&bm);
+
+                if (!hNewBitmap)
+                {
+                    SelectObject(hdcSrc, old);
+                    DeleteDC(hdcMem);
+                    DeleteDC(hdcSrc);
+                    break;
+                }
+
+                HBITMAP old1 = (HBITMAP) SelectObject(hdcMem, hNewBitmap);
+                BitBlt(hdcMem, 0, 0, bm.bmWidth, bm.bmHeight,
+                       hdcSrc, 0, 0, SRCCOPY);
+
+                // Select new bitmap out of memory DC
+                SelectObject(hdcMem, old1);
+
+                // Clean up
+                SelectObject(hdcSrc, old);
+                DeleteDC(hdcSrc);
+                DeleteDC(hdcMem);
+
+                // Create and return a new wxBitmap
+                wxBitmap *wxBM = new wxBitmap;
+                wxBM->SetHBITMAP((WXHBITMAP) hNewBitmap);
+                wxBM->SetWidth(bm.bmWidth);
+                wxBM->SetHeight(bm.bmHeight);
+                wxBM->SetDepth(bm.bmPlanes);
+#if WXWIN_COMPATIBILITY_2
+                wxBM->SetOk(TRUE);
+#endif // WXWIN_COMPATIBILITY_2
+                retval = wxBM;
+                break;
+            }
+
+        case wxDF_METAFILE:
+        case CF_SYLK:
+        case CF_DIF:
+        case CF_TIFF:
+        case CF_PALETTE:
+        case wxDF_DIB:
+            {
+                wxLogError(_("Unsupported clipboard format."));
+                return FALSE;
+            }
+
+        case wxDF_OEMTEXT:
+            dataFormat = wxDF_TEXT;
+            // fall through
+
+        case wxDF_TEXT:
+            {
+                HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
+                if (!hGlobalMemory)
+                    break;

 
 

-      int hsize = (int)GlobalSize(hGlobalMemory);
-      if (len)
-        *len = hsize;
+                DWORD hsize = ::GlobalSize(hGlobalMemory);
+                if (len)
+                    *len = hsize;

 
 

-      char *s = new char[hsize];
-      if (!s)
-        return NULL;
+                char *s = new char[hsize];
+                if (!s)
+                    break;

 
 

-#ifdef __WINDOWS_386__
-      LPSTR lpGlobalMemory = (LPSTR)MK_FP32(GlobalLock(hGlobalMemory));
-#else
-      LPSTR lpGlobalMemory = (LPSTR)GlobalLock(hGlobalMemory);
-#endif
+                LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);

 
 

-#ifdef __WIN32__
-      memcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#elif __WATCOMC__ && defined(__WINDOWS_386__)
-      memcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#else
-      hmemcpy(s, lpGlobalMemory, GlobalSize(hGlobalMemory));
-#endif
+                memcpy(s, lpGlobalMemory, hsize);
+
+                ::GlobalUnlock(hGlobalMemory);
+
+                retval = s;
+                break;
+            }
+
+        default:
+            {
+                HANDLE hGlobalMemory = ::GetClipboardData(dataFormat);
+                if ( !hGlobalMemory )
+                    break;
+
+                DWORD size = ::GlobalSize(hGlobalMemory);
+                if ( len )
+                    *len = size;

 
 

-      GlobalUnlock(hGlobalMemory);
+                void *buf = malloc(size);
+                if ( !buf )
+                    break;

 
 

-      return (wxObject *)s;
-      break;
+                LPSTR lpGlobalMemory = (LPSTR)::GlobalLock(hGlobalMemory);
+
+                memcpy(buf, lpGlobalMemory, size);
+
+                ::GlobalUnlock(hGlobalMemory);
+
+                retval = buf;
+                break;
+            }
+    }
+
+    if ( !retval )
+    {
+        wxLogSysError(_("Failed to retrieve data from the clipboard."));

     }
     }

-  }
-  return NULL;
+
+    return retval;

 }
 
 }
 

-int  wxEnumClipboardFormats(int dataFormat)
+wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)

 {
   return ::EnumClipboardFormats(dataFormat);
 }
 
 {
   return ::EnumClipboardFormats(dataFormat);
 }
 

-int  wxRegisterClipboardFormat(char *formatName)
+int wxRegisterClipboardFormat(wxChar *formatName)

 {
   return ::RegisterClipboardFormat(formatName);
 }
 
 {
   return ::RegisterClipboardFormat(formatName);
 }
 

-bool wxGetClipboardFormatName(int dataFormat, char *formatName, int maxCount)
+bool wxGetClipboardFormatName(wxDataFormat dataFormat,
+                              wxChar *formatName,
+                              int maxCount)

 {
 {

-  return (::GetClipboardFormatName(dataFormat, formatName, maxCount) > 0);
+  return ::GetClipboardFormatName((int)dataFormat, formatName, maxCount) > 0;

 }
 
 }
 

-/*
- * Generalized clipboard implementation by Matthew Flatt
- */
+// ---------------------------------------------------------------------------
+// wxClipboard
+// ---------------------------------------------------------------------------

 
 

-wxClipboard *wxTheClipboard = NULL;
+IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)

 
 

-void wxInitClipboard(void)
+wxClipboard::wxClipboard()

 {
 {

-  if (!wxTheClipboard)
-    wxTheClipboard = new wxClipboard;
+    m_clearOnExit = FALSE;

 }
 
 }
 

-wxClipboard::wxClipboard()
+wxClipboard::~wxClipboard()

 {
 {

-  clipOwner = NULL;
-  cbString = NULL;
+    if ( m_clearOnExit )
+    {
+        Clear();
+    }

 }
 
 }
 

-wxClipboard::~wxClipboard()
+void wxClipboard::Clear()

 {
 {

-  if (clipOwner)
-    clipOwner->BeingReplaced();
-  if (cbString)
-    delete[] cbString;
+#if wxUSE_OLE_CLIPBOARD
+    if ( FAILED(OleSetClipboard(NULL)) )
+    {
+        wxLogLastError("OleSetClipboard(NULL)");
+    }
+#endif

 }
 
 }
 

-static int FormatStringToID(char *str)
+bool wxClipboard::Flush()

 {
 {

-  if (!strcmp(str, "TEXT"))
-    return wxDF_TEXT;
+#if wxUSE_OLE_CLIPBOARD
+    if ( FAILED(OleFlushClipboard()) )
+    {
+        wxLogLastError("OleFlushClipboard");

 
 

-  return wxRegisterClipboardFormat(str);
+        return FALSE;
+    }
+    else
+    {
+        m_clearOnExit = FALSE;
+
+        return TRUE;
+    }
+#else // !wxUSE_OLE_CLIPBOARD
+    return FALSE;
+#endif // wxUSE_OLE_CLIPBOARD/!wxUSE_OLE_CLIPBOARD

 }
 
 }
 

-void wxClipboard::SetClipboardClient(wxClipboardClient *client, long time)
+bool wxClipboard::Open()

 {
 {

-  bool got_selection;
-
-  if (clipOwner)
-    clipOwner->BeingReplaced();
-  clipOwner = client;
-  if (cbString) {
-    delete[] cbString;
-    cbString = NULL;
-  }
-
-  if (wxOpenClipboard()) {
-    char **formats, *data;
-         int i;
-    int ftype;
-    long size;
-
-    formats = clipOwner->formats.ListToArray(FALSE);
-    for (i = clipOwner->formats.Number(); i--; ) {
-      ftype = FormatStringToID(formats[i]);
-      data = clipOwner->GetData(formats[i], &size);
-      if (!wxSetClipboardData(ftype, (wxObject *)data, size, 1)) {
-        got_selection = FALSE;
-        break;
-      }
-    }
+    // OLE opens clipboard for us
+#if wxUSE_OLE_CLIPBOARD
+    return TRUE;
+#else
+    return wxOpenClipboard();
+#endif
+}

 
 

-    if (i < 0)
-      got_selection = wxCloseClipboard();
-  } else
-    got_selection = FALSE;
-  
-  got_selection = FALSE; // Assume another process takes over
-
-  if (!got_selection) {
-    clipOwner->BeingReplaced();
-         clipOwner = NULL;
-  }
+bool wxClipboard::IsOpened() const
+{
+#if wxUSE_OLE_CLIPBOARD
+    return TRUE;
+#else
+    return wxIsClipboardOpened();
+#endif

 }
 
 }
 

-wxClipboardClient *wxClipboard::GetClipboardClient()
+bool wxClipboard::SetData( wxDataObject *data )

 {
 {

-  return clipOwner;
+#if !wxUSE_OLE_CLIPBOARD
+    (void)wxEmptyClipboard();
+#endif // wxUSE_OLE_CLIPBOARD
+
+    if ( data )
+        return AddData(data);
+    else
+        return TRUE;

 }
 
 }
 

-void wxClipboard::SetClipboardString(char *str, long time)
+bool wxClipboard::AddData( wxDataObject *data )

 {
 {

-  bool got_selection;
+    wxCHECK_MSG( data, FALSE, wxT("data is invalid") );

 
 

-  if (clipOwner) {
-    clipOwner->BeingReplaced();
-    clipOwner = NULL;
-  }
-  if (cbString)
-    delete[] cbString;
+#if wxUSE_OLE_CLIPBOARD
+    HRESULT hr = OleSetClipboard(data->GetInterface());
+    if ( FAILED(hr) )
+    {
+        wxLogSysError(hr, _("Failed to put data on the clipboard"));

 
 

-  cbString = str;
+        // don't free anything in this case

 
 

-  if (wxOpenClipboard()) {
-    if (!wxSetClipboardData(wxDF_TEXT, (wxObject *)str))
-      got_selection = FALSE;
-    else
-                got_selection = wxCloseClipboard();
-  } else
-    got_selection = FALSE;
+        return FALSE;
+    }
+
+    // we have a problem here because we should delete wxDataObject, but we
+    // can't do it because IDataObject which we just gave to the clipboard
+    // would try to use it when it will need the data. IDataObject is ref
+    // counted and so doesn't suffer from such problem, so we release it now
+    // and tell it to delete wxDataObject when it is deleted itself.
+    data->SetAutoDelete();
+
+    // we have to call either OleSetClipboard(NULL) or OleFlushClipboard() when
+    // using OLE clipboard when the app terminates - by default, we call
+    // OleSetClipboard(NULL) which won't waste RAM, but the app can call
+    // wxClipboard::Flush() to chaneg this
+    m_clearOnExit = TRUE;

 
 

-  got_selection = FALSE; // Assume another process takes over
+    return TRUE;
+#elif wxUSE_DATAOBJ
+    wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );

 
 

-  if (!got_selection) {
-    delete[] cbString;
-    cbString = NULL;
-  }
+    wxDataFormat format = data->GetFormat();
+
+    switch ( format )
+    {
+        case wxDF_TEXT:
+        case wxDF_OEMTEXT:
+        {
+            wxTextDataObject* textDataObject = (wxTextDataObject*) data;
+            wxString str(textDataObject->GetText());
+            return wxSetClipboardData(format, str.c_str());
+        }
+
+        case wxDF_BITMAP:
+        case wxDF_DIB:
+        {
+            wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject*) data;
+            wxBitmap bitmap(bitmapDataObject->GetBitmap());
+            return wxSetClipboardData(data->GetFormat(), &bitmap);
+        }
+
+#if wxUSE_METAFILE
+        case wxDF_METAFILE:
+        {
+            wxMetafileDataObject* metaFileDataObject = 
+                (wxMetafileDataObject*) data;
+            wxMetafile metaFile = metaFileDataObject->GetMetafile();
+            return wxSetClipboardData(wxDF_METAFILE, &metaFile,
+                                      metaFileDataObject->GetWidth(),
+                                      metaFileDataObject->GetHeight());
+        }
+#endif // wxUSE_METAFILE
+
+        default:
+            return wxSetClipboardData(data);
+    }
+#else // !wxUSE_DATAOBJ
+    return FALSE;
+#endif // wxUSE_DATAOBJ/!wxUSE_DATAOBJ

 }
 
 }
 

-char *wxClipboard::GetClipboardString(long time)
+void wxClipboard::Close()

 {
 {

-  char *str;
-  long length;
-
-  str = GetClipboardData("TEXT", &length, time);
-  if (!str) {
-    str = new char[1];
-    *str = 0;
-  }
+    // OLE closes clipboard for us
+#if !wxUSE_OLE_CLIPBOARD
+    wxCloseClipboard();
+#endif
+}

 
 

-  return str;
+bool wxClipboard::IsSupported( wxDataFormat format )
+{
+    return wxIsClipboardFormatAvailable(format);

 }
 
 }
 

-char *wxClipboard::GetClipboardData(char *format, long *length, long time)
+bool wxClipboard::GetData( wxDataObject& data )

 {
 {

-  if (clipOwner)  {
-         if (clipOwner->formats.Member(format))
-      return clipOwner->GetData(format, length);
+#if wxUSE_OLE_CLIPBOARD
+    IDataObject *pDataObject = NULL;
+    HRESULT hr = OleGetClipboard(&pDataObject);
+    if ( FAILED(hr) || !pDataObject )
+    {
+        wxLogSysError(hr, _("Failed to get data from the clipboard"));
+
+        return FALSE;
+    }
+
+    // build the list of supported formats
+    size_t nFormats = data.GetFormatCount(wxDataObject::Set);
+    wxDataFormat format, *formats;
+    if ( nFormats == 1 )
+    {
+        // the most common case
+        formats = &format;
+    }

     else
     else

-      return NULL;
-  } else if (cbString) {
-    if (!strcmp(format, "TEXT"))
-      return copystring(cbString);
+    {
+        // bad luck, need to alloc mem
+        formats = new wxDataFormat[nFormats];
+    }
+
+    data.GetAllFormats(formats, wxDataObject::Set);
+
+    // get the format enumerator
+    bool result = FALSE;
+    wxArrayInt supportedFormats;
+    IEnumFORMATETC *pEnumFormatEtc = NULL;
+    hr = pDataObject->EnumFormatEtc(DATADIR_GET, &pEnumFormatEtc);
+    if ( FAILED(hr) || !pEnumFormatEtc )
+    {
+        wxLogSysError(hr,
+                      _("Failed to retrieve the supported clipboard formats"));
+    }

     else
     else

-      return NULL;
-  } else {
-    if (wxOpenClipboard()) {
-      receivedString = (char *)wxGetClipboardData(FormatStringToID(format), 
-                                                  length);
-      wxCloseClipboard();
-    } else
-      receivedString = NULL;
-
-    return receivedString;
-  }
-}
+    {
+        // ask for the supported formats and see if there are any we support
+        FORMATETC formatEtc;
+        for ( ;; )
+        {
+            ULONG nCount;
+            hr = pEnumFormatEtc->Next(1, &formatEtc, &nCount);
+
+            // don't use FAILED() because S_FALSE would pass it
+            if ( hr != S_OK )
+            {
+                // no more formats
+                break;
+            }
+
+            CLIPFORMAT cf = formatEtc.cfFormat;
+
+#ifdef __WXDEBUG__
+            wxLogTrace(wxTRACE_OleCalls,
+                       wxT("Object on the clipboard supports format %s."),
+                       wxDataObject::GetFormatName(cf));
+#endif // Debug
+
+            // is supported?
+            for ( size_t n = 0; n < nFormats; n++ )
+            {
+                if ( formats[n].GetFormatId() == cf )
+                {
+                    if ( supportedFormats.Index(cf) == wxNOT_FOUND )
+                    {
+                        supportedFormats.Add(cf);
+                    }
+                }
+            }
+        }
+
+        pEnumFormatEtc->Release();
+    }

 
 

+    if ( formats != &format )
+    {
+        delete [] formats;
+    }
+    //else: we didn't allocate any memory
+
+    if ( !supportedFormats.IsEmpty() )
+    {
+        FORMATETC formatEtc;
+        formatEtc.ptd      = NULL;
+        formatEtc.dwAspect = DVASPECT_CONTENT;
+        formatEtc.lindex   = -1;
+
+        size_t nSupportedFormats = supportedFormats.GetCount();
+        for ( size_t n = 0; !result && (n < nSupportedFormats); n++ )
+        {
+            STGMEDIUM medium;
+            formatEtc.cfFormat = supportedFormats[n];
+
+            // use the appropriate tymed
+            switch ( formatEtc.cfFormat )
+            {
+                case CF_BITMAP:
+                    formatEtc.tymed = TYMED_GDI;
+                    break;
+
+                case CF_METAFILEPICT:
+                    formatEtc.tymed = TYMED_MFPICT;
+                    break;
+
+                case CF_ENHMETAFILE:
+                    formatEtc.tymed = TYMED_ENHMF;
+                    break;
+
+                default:
+                    formatEtc.tymed = TYMED_HGLOBAL;
+            }
+
+            // try to get data
+            hr = pDataObject->GetData(&formatEtc, &medium);
+            if ( FAILED(hr) )
+            {
+                // try other tymed for GDI objects
+                if ( formatEtc.cfFormat == CF_BITMAP )
+                {
+                    formatEtc.tymed = TYMED_HGLOBAL;
+                    hr = pDataObject->GetData(&formatEtc, &medium);
+                }
+            }
+
+            if ( SUCCEEDED(hr) )
+            {
+                // pass the data to the data object
+                hr = data.GetInterface()->SetData(&formatEtc, &medium, TRUE);
+                if ( FAILED(hr) )
+                {
+                    wxLogDebug(wxT("Failed to set data in wxIDataObject"));
+
+                    // IDataObject only takes the ownership of data if it
+                    // successfully got it - which is not the case here
+                    ReleaseStgMedium(&medium);
+                }
+                else
+                {
+                    result = TRUE;
+                }
+            }
+            //else: unsupported tymed?
+        }
+    }
+    //else: unsupported format

 
 

+    // clean up and return
+    pDataObject->Release();
+
+    return result;
+#elif wxUSE_DATAOBJ
+    wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
+
+    wxDataFormat format = data.GetFormat();
+    switch ( format )
+    {
+        case wxDF_TEXT:
+        case wxDF_OEMTEXT:
+        {
+            wxTextDataObject& textDataObject = (wxTextDataObject &)data;
+            char* s = (char*)wxGetClipboardData(format);
+            if ( !s )
+                return FALSE;
+
+            textDataObject.SetText(s);
+            delete [] s;
+
+            return TRUE;
+        }
+
+        case wxDF_BITMAP:
+        case wxDF_DIB:
+        {
+            wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data;
+            wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(data->GetFormat());
+            if ( !bitmap )
+                return FALSE;
+
+            bitmapDataObject.SetBitmap(*bitmap);
+            delete bitmap;
+
+            return TRUE;
+        }
+#if wxUSE_METAFILE
+        case wxDF_METAFILE:
+        {
+            wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data;
+            wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
+            if ( !metaFile )
+                return FALSE;
+
+            metaFileDataObject.SetMetafile(*metaFile);
+            delete metaFile;
+
+            return TRUE;
+        }
+#endif // wxUSE_METAFILE
+    }
+#else // !wxUSE_DATAOBJ
+    wxFAIL_MSG( wxT("no clipboard implementation") );
+#endif // wxUSE_OLE_CLIPBOARD/wxUSE_DATAOBJ
+
+    return FALSE;
+}
+
+#else
+    #error "Please turn wxUSE_CLIPBOARD on to compile this file."

 #endif // wxUSE_CLIPBOARD
 
 #endif // wxUSE_CLIPBOARD