]> git.saurik.com Git - wxWidgets.git/blobdiff - src/mac/carbon/clipbrd.cpp
cleanup
[wxWidgets.git] / src / mac / carbon / clipbrd.cpp
index 1e99ca3ce739603d45eb2db60a3babba6f133e1b..99a8fba35c5af8a98508d5c99755fa84a5778a73 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        clipbrd.cpp
+// Name:        src/mac/carbon/clipbrd.cpp
 // Purpose:     Clipboard functionality
-// Author:      AUTHOR
+// Author:      Stefan Csomor;
+//              Generalized clipboard implementation by Matthew Flatt
 // Modified by:
-// Created:     ??/??/98
+// Created:     1998-01-01
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation
-#pragma implementation "clipbrd.h"
+#include "wx/wxprec.h"
+
+#if wxUSE_CLIPBOARD
+
+#include "wx/clipbrd.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+    #include "wx/frame.h"
+    #include "wx/bitmap.h"
 #endif
 
-#include "wx/app.h"
-#include "wx/frame.h"
-#include "wx/bitmap.h"
-#include "wx/utils.h"
 #include "wx/metafile.h"
-#include "wx/clipbrd.h"
-#include "wx/intl.h"
+
+#include "wx/mac/uma.h"
 
 #define wxUSE_DATAOBJ 1
 
 #include <string.h>
 
-// open/close
 
-bool clipboard_opened = false ;
+// the trace mask we use with wxLogTrace() - call
+// wxLog::AddTraceMask(TRACE_CLIPBOARD) to enable the trace messages from here
+// (there will be a *lot* of them!)
+static const wxChar *TRACE_CLIPBOARD = wxT("clipboard");
 
-bool wxOpenClipboard()
-{
-       clipboard_opened = true ;
-    return TRUE;
-}
+IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
 
-bool wxCloseClipboard()
-{
-       clipboard_opened = false ;
-    return TRUE;
-}
-
-bool wxIsClipboardOpened()
-{
-     return clipboard_opened;
-}
+// in order to keep the binary interface the same this class
+// serves just to have a few additional member variables inside
+// the clipboard class
 
-bool wxEmptyClipboard()
+class wxMacBinaryCompatHelper : public wxDataObject
 {
-       
-#if TARGET_CARBON
-       OSStatus err ;
-       err = ClearCurrentScrap( );
-#else
-       OSErr err ;
-       err = ZeroScrap( );
-#endif
-       if ( err )
-       {
-        wxLogSysError(_("Failed to empty the clipboard."));
-               return FALSE ;
-       }
-    return TRUE;
-}
-
-// get/set data
-
-// clipboard formats
-
-bool wxIsClipboardFormatAvailable(wxDataFormat dataFormat)
-{
-#if TARGET_CARBON
-       OSStatus err = noErr;
-       ScrapRef scrapRef;
-       
-       err = GetCurrentScrap( &scrapRef );
-       if ( err != noTypeErr && err != memFullErr )    
-       {
-               ScrapFlavorFlags        flavorFlags;
-               Size                            byteCount;
-               
-               if (( err = GetScrapFlavorFlags( scrapRef, dataFormat.GetFormatId(), &flavorFlags )) == noErr)
-               {
-                       if (( err = GetScrapFlavorSize( scrapRef, dataFormat.GetFormatId(), &byteCount )) == noErr)
-                       {
-                               return TRUE ;
-                       }
-               }
-       }
-       return FALSE;
-       
-#else
-       long offset ;
-       if ( GetScrap( NULL , dataFormat.GetFormatId() , &offset ) > 0 )
-       {
-               return TRUE ;
-       }
-     return FALSE;
-#endif
-}
-
-bool wxSetClipboardData(wxDataFormat dataFormat,const void *data,int width , int height)
-{
-#if !TARGET_CARBON
-       OSErr err = noErr ;
-#else
-       OSStatus err = noErr ;
-#endif
-       
-    switch (dataFormat.GetType())
+public :
+    wxMacBinaryCompatHelper() 
     {
-        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;
-            }
-
-#if wxUSE_METAFILE
-        case wxDF_METAFILE:
-            {
-                wxMetafile *wxMF = (wxMetafile *)data;
-                               PicHandle pict = wxMF->GetHMETAFILE() ;
-                               HLock( (Handle) pict ) ;
-#if !TARGET_CARBON
-                               err = PutScrap( GetHandleSize(  (Handle) pict ) , 'PICT' , *pict ) ;
-#else
-                               ScrapRef        scrap;
-                               err = GetCurrentScrap (&scrap); 
-                               if ( !err )
-                               {
-                                       err = PutScrapFlavor (scrap, 'PICT', 0, GetHandleSize((Handle) pict), *pict);
-                               }
-#endif
-                               HUnlock(  (Handle) pict ) ;
-                break;
-            }
-#endif
-        case wxDF_SYLK:
-        case wxDF_DIF:
-        case wxDF_TIFF:
-        case wxDF_PALETTE:
-        default:
-            {
-                wxLogError(_("Unsupported clipboard format."));
-                return FALSE;
-            }
-
-        case wxDF_OEMTEXT:
-            dataFormat = wxDF_TEXT;
-            // fall through
-
-        case wxDF_TEXT:
-            {
-               wxString mac ;
-               if ( wxApp::s_macDefaultEncodingIsPC )
-               {
-                       mac = wxMacMakeMacStringFromPC((char *)data) ;
-               }
-               else
-               {
-                       mac = (char *)data ;
-               }
-#if !TARGET_CARBON
-                               err = PutScrap( mac.Length() , 'TEXT' , mac.c_str() ) ;
-#else
-                               ScrapRef        scrap;
-                               err = GetCurrentScrap (&scrap); 
-                               if ( !err )
-                               {
-                                       err = PutScrapFlavor (scrap, 'TEXT', 0, mac.Length(), mac.c_str());
-                               }
-#endif
-                break;
-            }
+        m_trueData = NULL;
     }
 
-    if ( err )
+    ~wxMacBinaryCompatHelper() 
     {
-        wxLogSysError(_("Failed to set clipboard data."));
-
-        return FALSE;
+        if (m_trueData != NULL)
+    {
+            delete m_trueData;
+            m_trueData = NULL;
+        }
     }
 
-    return TRUE;
-}
+    virtual wxDataFormat GetPreferredFormat(Direction dir = Get) const 
+        {
+        return wxDataFormat();
+    }
 
-wxDataFormat wxEnumClipboardFormats(wxDataFormat dataFormat)
-{
-    return wxDataFormat();
-}
+    virtual size_t GetFormatCount(Direction dir = Get) const 
+                {
+        return 0;
+                    }
 
-int  wxRegisterClipboardFormat(wxChar *formatName)
-{
-    return 0;
-}
+    virtual void GetAllFormats(wxDataFormat *formats,
+                               Direction dir = Get) const
+                {
+    }
 
-bool wxGetClipboardFormatName(wxDataFormat dataFormat, wxChar *formatName, int maxCount)
-{
-    return FALSE;
-}
+    virtual size_t GetDataSize(const wxDataFormat& format) const
+    {
+        return 0;
+    }
 
-void *wxGetClipboardData(wxDataFormat dataFormat, long *len)
-{
-    return NULL;
-}
+    virtual bool GetDataHere(const wxDataFormat& format, void *buf) const
+    {
+        return false;
+    }
 
+    // only relevant from here on
 
-/*
- * Generalized clipboard implementation by Matthew Flatt
- */
+    wxDataObject* m_trueData;
+    wxCFRef<PasteboardRef> m_pasteboard;
+};
 
-IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxClipboardBase)
+#define M_CLIPBOARD ((wxMacBinaryCompatHelper*)m_data)
 
 wxClipboard::wxClipboard()
 {
-    m_clearOnExit = FALSE;
+    m_open = false;
+    m_data = new wxMacBinaryCompatHelper() ;
+    PasteboardRef clipboard = 0;
+    OSStatus err = PasteboardCreate( kPasteboardClipboard, &clipboard );
+    if (err != noErr)
+    {
+        wxLogSysError( wxT("Failed to create the clipboard.") );
+    }
+    M_CLIPBOARD->m_pasteboard.reset(clipboard);
 }
 
 wxClipboard::~wxClipboard()
 {
-    if ( m_clearOnExit )
-    {
-        Clear();
-    }
+    M_CLIPBOARD->m_pasteboard.reset((PasteboardRef)0);
+        delete m_data;
 }
 
 void wxClipboard::Clear()
 {
+    if (M_CLIPBOARD->m_trueData != NULL)
+    {
+        delete M_CLIPBOARD->m_trueData;
+        M_CLIPBOARD->m_trueData = NULL;
+    }
+
+    OSStatus err = PasteboardClear( M_CLIPBOARD->m_pasteboard );
+    if (err != noErr)
+    {
+        wxLogSysError( wxT("Failed to empty the clipboard.") );
+    }
 }
 
 bool wxClipboard::Flush()
 {
-    return FALSE;
+    return false;
 }
 
 bool wxClipboard::Open()
 {
-    return wxOpenClipboard();
+    wxCHECK_MSG( !m_open, false, wxT("clipboard already open") );
+
+    m_open = true;
+
+    return true;
 }
 
 bool wxClipboard::IsOpened() const
 {
-    return wxIsClipboardOpened();
+    return m_open;
 }
 
-static int FormatStringToID(char *str)
+bool wxClipboard::SetData( wxDataObject *data )
 {
-  if (!strcmp(str, "TEXT"))
-    return wxDF_TEXT;
+    if ( IsUsingPrimarySelection() )
+        return false;
 
-  return wxRegisterClipboardFormat(str);
-}
+    wxCHECK_MSG( m_open, false, wxT("clipboard not open") );
+    wxCHECK_MSG( data, false, wxT("data is invalid") );
 
-bool wxClipboard::SetData( wxDataObject *data )
-{
-    (void)wxEmptyClipboard();
+    Clear();
 
-    if ( data )
-        return AddData(data);
-    else
-        return TRUE;
+    // as we can only store one wxDataObject,
+    // this is the same in this implementation
+    return AddData( data );
 }
 
 bool wxClipboard::AddData( wxDataObject *data )
 {
-    wxCHECK_MSG( data, FALSE, wxT("data is invalid") );
+    if ( IsUsingPrimarySelection() )
+        return false;
 
-#if wxUSE_DATAOBJ
-    wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
+    wxCHECK_MSG( m_open, false, wxT("clipboard not open") );
+    wxCHECK_MSG( data, false, wxT("data is invalid") );
 
-    wxDataFormat format = data->GetPreferredFormat();
+    // we can only store one wxDataObject
+    Clear();
 
-    switch ( format.GetType() )
-    {
-        case wxDF_TEXT:
-        case wxDF_OEMTEXT:
-        {
-            wxTextDataObject* textDataObject = (wxTextDataObject*) data;
-            wxString str(textDataObject->GetText());
-            return wxSetClipboardData(format, str.c_str());
-        }
+    PasteboardSyncFlags syncFlags = PasteboardSynchronize( M_CLIPBOARD->m_pasteboard );
+    wxCHECK_MSG( !(syncFlags&kPasteboardModified), false, wxT("clipboard modified after clear") );
+    wxCHECK_MSG( (syncFlags&kPasteboardClientIsOwner), false, wxT("client couldn't own clipboard") );
 
-        case wxDF_BITMAP:
-        case wxDF_DIB:
-        {
-            wxBitmapDataObject* bitmapDataObject = (wxBitmapDataObject*) data;
-            wxBitmap bitmap(bitmapDataObject->GetBitmap());
-            return wxSetClipboardData(format, &bitmap);
-        }
+    M_CLIPBOARD->m_trueData = data;
 
-#if 0 // 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
+    data->AddToPasteboard( M_CLIPBOARD->m_pasteboard, 1 );
 
-        default:
- //           return wxSetClipboardData(data);
-                               break ;
-    }
-#else // !wxUSE_DATAOBJ
-#endif 
-    return FALSE;
+    return true;
 }
 
 void wxClipboard::Close()
 {
-    wxCloseClipboard();
+    wxCHECK_RET( m_open, wxT("clipboard not open") );
+
+    m_open = false;
+
+    // Get rid of cached object.
+    // If this is not done, copying data from
+    // another application will only work once
+    if (M_CLIPBOARD->m_trueData)
+    {
+        delete M_CLIPBOARD->m_trueData;
+        M_CLIPBOARD->m_trueData = (wxDataObject*) NULL;
+    }
 }
 
-bool wxClipboard::IsSupported( const wxDataFormat &format )
+bool wxClipboard::IsSupported( const wxDataFormat &dataFormat )
 {
-    return wxIsClipboardFormatAvailable(format);
+    if ( M_CLIPBOARD->m_trueData )
+        return M_CLIPBOARD->m_trueData->IsSupported( dataFormat );
+    return wxDataObject::IsFormatInPasteboard( M_CLIPBOARD->m_pasteboard, dataFormat );
 }
 
 bool wxClipboard::GetData( wxDataObject& data )
 {
-#if wxUSE_DATAOBJ
-    wxCHECK_MSG( wxIsClipboardOpened(), FALSE, wxT("clipboard not open") );
-
-    wxDataFormat format = data.GetPreferredFormat();
-    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;
+    if ( IsUsingPrimarySelection() )
+        return false;
 
-            return TRUE;
-        }
+    wxCHECK_MSG( m_open, false, wxT("clipboard not open") );
 
-        case wxDF_BITMAP:
-        case wxDF_DIB:
-        {
-            wxBitmapDataObject& bitmapDataObject = (wxBitmapDataObject &)data;
-            wxBitmap* bitmap = (wxBitmap *)wxGetClipboardData(format );
-            if ( !bitmap )
-                return FALSE;
+    size_t formatcount = data.GetFormatCount() + 1;
+    wxDataFormat *array = new wxDataFormat[ formatcount ];
+    array[0] = data.GetPreferredFormat();
+    data.GetAllFormats( &array[1] );
 
-            bitmapDataObject.SetBitmap(*bitmap);
-            delete bitmap;
+    bool transferred = false;
 
-            return TRUE;
-        }
-#if 0 // wxUSE_METAFILE
-        case wxDF_METAFILE:
+    if ( M_CLIPBOARD->m_trueData )
+    {
+        for (size_t i = 0; !transferred && i < formatcount; i++)
         {
-            wxMetafileDataObject& metaFileDataObject = (wxMetafileDataObject &)data;
-            wxMetafile* metaFile = (wxMetafile *)wxGetClipboardData(wxDF_METAFILE);
-            if ( !metaFile )
-                return FALSE;
-
-            metaFileDataObject.SetMetafile(*metaFile);
-            delete metaFile;
+            wxDataFormat format = array[ i ];
+            if ( M_CLIPBOARD->m_trueData->IsSupported( format ) )
+            {
+                int dataSize = M_CLIPBOARD->m_trueData->GetDataSize( format );
+                transferred = true;
 
-            return TRUE;
+                if (dataSize == 0)
+                {
+                    data.SetData( format, 0, 0 );
+                }
+                else
+                {
+                    char *d = new char[ dataSize ];
+                    M_CLIPBOARD->m_trueData->GetDataHere( format, (void*)d );
+                    data.SetData( format, dataSize, d );
+                    delete [] d;
+                }
+            }
         }
-#endif // wxUSE_METAFILE
-    }
-#else // !wxUSE_DATAOBJ
-    wxFAIL_MSG( wxT("no clipboard implementation") );
-#endif
-    return FALSE;
-}
-/*
-void wxClipboard::SetClipboardClient(wxClipboardClient *client, long time)
-{
-  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;
-      }
     }
 
-    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;
-  }
-}
-
-wxClipboardClient *wxClipboard::GetClipboardClient()
-{
-  return clipOwner;
-}
-
-void wxClipboard::SetClipboardString(char *str, long time)
-{
-  bool got_selection;
-
-  if (clipOwner) {
-    clipOwner->BeingReplaced();
-    clipOwner = NULL;
-  }
-  if (cbString)
-    delete[] cbString;
-
-  cbString = str;
-
-  if (wxOpenClipboard()) {
-    if (!wxSetClipboardData(wxDF_TEXT, (wxObject *)str))
-      got_selection = FALSE;
-    else
-                got_selection = wxCloseClipboard();
-  } else
-    got_selection = FALSE;
-
-  got_selection = FALSE; // Assume another process takes over
-
-  if (!got_selection) {
-    delete[] cbString;
-    cbString = NULL;
-  }
-}
-char *wxClipboard::GetClipboardString(long time)
-{
-  char *str;
-  long length;
-
-  str = GetClipboardData("TEXT", &length, time);
-  if (!str) {
-    str = new char[1];
-    *str = 0;
-  }
-
-  return str;
-}
+    // get formats from wxDataObjects
+    if ( !transferred )
+    {
+        transferred = data.GetFromPasteboard( M_CLIPBOARD->m_pasteboard ) ;
+    }
 
+    delete [] array;
 
-char *wxClipboard::GetClipboardData(char *format, long *length, long time)
-{
-  if (clipOwner)  {
-         if (clipOwner->formats.Member(format))
-      return clipOwner->GetData(format, length);
-    else
-      return NULL;
-  } else if (cbString) {
-    if (!strcmp(format, "TEXT"))
-      return copystring(cbString);
-    else
-      return NULL;
-  } else {
-    if (wxOpenClipboard()) {
-      receivedString = (char *)wxGetClipboardData(FormatStringToID(format), 
-                                                  length);
-      wxCloseClipboard();
-    } else
-      receivedString = NULL;
-
-    return receivedString;
-  }
+    return transferred;
 }
-*/
 
+#endif