attempt to tame composite data objects

[wxWidgets.git] / src / mac / carbon / clipbrd.cpp

diff --git a/src/mac/carbon/clipbrd.cpp b/src/mac/carbon/clipbrd.cpp
index 28a4b9ef3f793e2311c40ba9c4433c6c8ddfbf47..e331d80f8e792c8b58115123bd728235e6248e3c 100644 (file)
--- a/src/mac/carbon/clipbrd.cpp
+++ b/src/mac/carbon/clipbrd.cpp
@@ -1,16 +1,15 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        clipbrd.cpp
 // Purpose:     Clipboard functionality
 /////////////////////////////////////////////////////////////////////////////
 // Name:        clipbrd.cpp
 // Purpose:     Clipboard functionality

-// Author:      AUTHOR
+// Author:      Stefan Csomor

 // Modified by:
 // Modified by:

-// Created:     ??/??/98
+// Created:     1998-01-01

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__

-#pragma implementation

 #pragma implementation "clipbrd.h"
 #endif
 
 #pragma implementation "clipbrd.h"
 #endif
 


@@ -20,217 +19,388 @@
 #include "wx/utils.h"
 #include "wx/metafile.h"
 #include "wx/clipbrd.h"
 #include "wx/utils.h"
 #include "wx/metafile.h"
 #include "wx/clipbrd.h"

+#include "wx/intl.h"
+#include "wx/log.h"

 
 

-#include <string.h>
-
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxClipboard, wxObject)
-IMPLEMENT_ABSTRACT_CLASS(wxClipboardClient, wxObject)
+#ifndef __DARWIN__
+#include <Scrap.h>

 #endif
 #endif

+#include "wx/mac/uma.h"

 
 

-bool wxOpenClipboard()
-{
-    return TRUE;
-}
+#define wxUSE_DATAOBJ 1

 
 

-bool wxCloseClipboard()
-{
-    return FALSE;
-}
+#include <string.h>

 
 

-bool wxEmptyClipboard()
-{
-               ZeroScrap() ;
-    return 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 = _T("clipboard");

 
 

-bool wxClipboardOpen()
+void *wxGetClipboardData(wxDataFormat dataFormat, long *len)

 {
 {

-    // TODO
-    return FALSE;
-}
+#if !TARGET_CARBON
+    OSErr err = noErr ;
+#else
+    OSStatus err = noErr ;
+#endif
+    void * data = NULL ;
+    Size byteCount;

 
 

-bool wxIsClipboardFormatAvailable(int dataFormat)
-{
-    // TODO
-    return FALSE;
-}
+    switch (dataFormat.GetType())
+    {
+    case wxDF_OEMTEXT:
+        dataFormat = wxDF_TEXT;
+        // fall through

 
 

-bool wxSetClipboardData(int dataFormat, wxObject *obj, int width, int height)
-{
-    // TODO
-    return FALSE;
-}
+    case wxDF_TEXT:
+        break;
+    case wxDF_UNICODETEXT:
+        break;
+    case wxDF_BITMAP :
+    case wxDF_METAFILE :
+        break ;
+    default:
+        {
+            wxLogError(_("Unsupported clipboard format."));
+            return NULL;
+        }
+    }

 
 

-wxObject *wxGetClipboardData(int dataFormat, long *len)
-{
-    // TODO
-    return NULL;
-}
+#if TARGET_CARBON
+    ScrapRef scrapRef;
+
+    err = GetCurrentScrap( &scrapRef );
+    if ( err != noTypeErr && err != memFullErr )
+    {
+        ScrapFlavorFlags    flavorFlags;
+
+        if (( err = GetScrapFlavorFlags( scrapRef, dataFormat.GetFormatId(), &flavorFlags )) == noErr)
+        {
+            if (( err = GetScrapFlavorSize( scrapRef, dataFormat.GetFormatId(), &byteCount )) == noErr)
+            {
+                Size allocSize = byteCount ;
+                if ( dataFormat.GetType() == wxDF_TEXT )
+                    allocSize += 1 ;
+                else if ( dataFormat.GetType() == wxDF_UNICODETEXT )
+                    allocSize += 2 ;
+
+                data = new char[ allocSize ] ;
+
+                if (( err = GetScrapFlavorData( scrapRef, dataFormat.GetFormatId(), &byteCount , data )) == noErr )
+                {
+                    *len = allocSize ;
+                    if ( dataFormat.GetType() == wxDF_TEXT )
+                        ((char*)data)[byteCount] = 0 ;
+                    if ( dataFormat.GetType() == wxDF_UNICODETEXT )
+                        ((wxChar*)data)[byteCount/2] = 0 ;
+                }
+                else
+                {
+                    delete[] ((char *)data) ;
+                    data = NULL ;
+                }
+            }
+        }
+    }

 
 

-int  wxEnumClipboardFormats(int dataFormat)
-{
-    // TODO
-    return 0;
-}
+#else
+    long offset ;
+    Handle datahandle = NewHandle(0) ;
+    HLock( datahandle ) ;
+    GetScrap( datahandle , dataFormat.GetFormatId() , &offset ) ;
+    HUnlock( datahandle ) ;
+    if ( GetHandleSize( datahandle ) > 0 )
+    {
+        byteCount = GetHandleSize( datahandle ) ;
+        Size allocSize = byteCount ;
+        if ( dataFormat.GetType() == wxDF_TEXT )
+            allocSize += 1 ;
+        else if ( dataFormat.GetType() == wxDF_UNICODETEXT )
+            allocSize += 2 ;
+
+        data = new char[ allocSize ] ;
+
+        memcpy( (char*) data , (char*) *datahandle , byteCount ) ;
+        if ( dataFormat.GetType() == wxDF_TEXT )
+            ((char*)data)[byteCount] = 0 ;
+        if ( dataFormat.GetType() == wxDF_UNICODETEXT )
+            ((wxChar*)data)[byteCount/2] = 0 ;
+        *len = byteCount ;
+    }
+    DisposeHandle( datahandle ) ;
+#endif
+    if ( err )
+    {
+        wxLogSysError(_("Failed to get clipboard data."));

 
 

-int  wxRegisterClipboardFormat(char *formatName)
-{
-    // TODO
-    return 0;
-}
+        return NULL ;
+    }

 
 

-bool wxGetClipboardFormatName(int dataFormat, char *formatName, int maxCount)
-{
-    // TODO
-    return FALSE;
+    if ( dataFormat.GetType() == wxDF_TEXT )
+    {
+        wxMacConvertNewlines10To13( (char*) data ) ;
+    }
+
+    return data;

 }
 
 }
 

+

 /*
  * Generalized clipboard implementation by Matthew Flatt
  */
 
 /*
  * Generalized clipboard implementation by Matthew Flatt
  */
 

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

 
 

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

 {
 {

-  if (!wxTheClipboard)
-    wxTheClipboard = new wxClipboard;
+    m_open = false ;
+    m_data = NULL ;

 }
 
 }
 

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

 {
 {

-  clipOwner = NULL;
-  cbString = NULL;
+    if (m_data)
+    {
+        delete m_data;
+        m_data = (wxDataObject*) NULL;
+    }

 }
 
 }
 

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

 {
 {

-  if (clipOwner)
-    clipOwner->BeingReplaced();
-  if (cbString)
-    delete[] cbString;
+    if (m_data)
+    {
+        delete m_data;
+        m_data = (wxDataObject*) NULL;
+    }
+#if TARGET_CARBON
+    OSStatus err ;
+    err = ClearCurrentScrap( );
+#else
+    OSErr err ;
+    err = ZeroScrap( );
+#endif
+    if ( err )
+    {
+        wxLogSysError(_("Failed to empty the clipboard."));
+    }

 }
 
 }
 

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

 {
 {

-  if (!strcmp(str, "TEXT"))
-    return wxDF_TEXT;
+    return FALSE;
+}

 
 

-  return wxRegisterClipboardFormat(str);
+bool wxClipboard::Open()
+{
+    wxCHECK_MSG( !m_open, FALSE, wxT("clipboard already open") );
+    m_open = true ;
+    return true ;

 }
 
 }
 

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

 {
 {

-  bool got_selection;
-
-  if (clipOwner)
-    clipOwner->BeingReplaced();
-  clipOwner = client;
-  if (cbString) {
-    delete[] cbString;
-    cbString = NULL;
-  }
+    return m_open;
+}

 
 

-  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;
-      }
-    }
+bool wxClipboard::SetData( wxDataObject *data )
+{
+    wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") );

 
 

-    if (i < 0)
-      got_selection = wxCloseClipboard();
-  } else
-    got_selection = FALSE;
-  
-  got_selection = FALSE; // Assume another process takes over
+    wxCHECK_MSG( data, FALSE, wxT("data is invalid") );

 
 

-  if (!got_selection) {
-    clipOwner->BeingReplaced();
-         clipOwner = NULL;
-  }
+    Clear();
+    // as we can only store one wxDataObject, this is the same in this
+    // implementation
+    return AddData( data );

 }
 
 }
 

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

 {
 {

-  return clipOwner;
-}
+    wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") );

 
 

-void wxClipboard::SetClipboardString(char *str, long time)
-{/*
-  bool got_selection;
+    wxCHECK_MSG( data, FALSE, wxT("data is invalid") );

 
 

-  if (clipOwner) {
-    clipOwner->BeingReplaced();
-    clipOwner = NULL;
-  }
-  if (cbString)
-    delete[] cbString;
+    /* we can only store one wxDataObject */
+    Clear();

 
 

-  cbString = str;
+    m_data = data;

 
 

-  if (wxOpenClipboard()) {
-    if (!wxSetClipboardData(wxDF_TEXT, (wxObject *)str))
-      got_selection = FALSE;
-    else
-                got_selection = wxCloseClipboard();
-  } else
-    got_selection = FALSE;
+    /* get formats from wxDataObjects */
+    wxDataFormat *array = new wxDataFormat[ m_data->GetFormatCount() ];
+    m_data->GetAllFormats( array );

 
 

-  got_selection = FALSE; // Assume another process takes over
+    for (size_t i = 0; i < m_data->GetFormatCount(); i++)
+    {
+        wxLogTrace( TRACE_CLIPBOARD,
+                    wxT("wxClipboard now supports atom %s"),
+                    array[i].GetId().c_str() );

 
 

-  if (!got_selection) {
-    delete[] cbString;
-    cbString = NULL;
-  }
-  */
+#if !TARGET_CARBON
+        OSErr err = noErr ;
+#else
+        OSStatus err = noErr ;
+#endif
+        size_t sz = data->GetDataSize( array[i] ) ;
+        void* buf = malloc( sz + 1 ) ;
+        if ( buf )
+        {        
+            data->GetDataHere( array[i] , buf ) ;
+            OSType mactype = 0 ;
+            switch ( array[i].GetType() )
+            {
+               case wxDF_TEXT:
+               case wxDF_OEMTEXT:
+                    mactype = kScrapFlavorTypeText ;
+               break ;
+    #if wxUSE_UNICODE
+               case wxDF_UNICODETEXT :
+                    mactype = kScrapFlavorTypeUnicode ;
+               break ;
+    #endif
+    #if wxUSE_DRAG_AND_DROP
+            case wxDF_METAFILE:
+                    mactype = kScrapFlavorTypePicture ;
+               break ;
+    #endif
+               case wxDF_BITMAP:
+               case wxDF_DIB:
+                    mactype = kScrapFlavorTypePicture ;
+                    break ;
+               default:
+                    break ;
+            }
+            UMAPutScrap( sz , mactype , buf ) ;
+            free( buf ) ;
+        }
+    }
+
+    delete[] array;
+
+    return true ;

 }
 
 }
 

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

 {
 {

-  char *str;
-  long length;
+    wxCHECK_RET( m_open, wxT("clipboard not open") );
+
+    m_open = false ;
+    
+       // Get rid of cached object.  If this is not done copying from another application will
+       // only work once
+    if (m_data)
+    {
+        delete m_data;
+        m_data = (wxDataObject*) NULL;
+    }    
+           
+}

 
 

-  str = GetClipboardData("TEXT", &length, time);
-  if (!str) {
-    str = new char[1];
-    *str = 0;
+bool wxClipboard::IsSupported( const wxDataFormat &dataFormat )
+{
+  if ( m_data )
+  {
+    return m_data->IsSupported( 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;

 
 

-  return str;
+#else
+    long offset ;
+    Handle datahandle = NewHandle(0) ;
+    HLock( datahandle ) ;
+    GetScrap( datahandle , dataFormat.GetFormatId() , &offset ) ;
+    HUnlock( datahandle ) ;
+    bool hasData = GetHandleSize( datahandle ) > 0 ;
+    DisposeHandle( datahandle ) ;
+    return hasData ;
+#endif

 }
 
 }
 

-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);
-    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;
-  }
-}
+    wxCHECK_MSG( m_open, FALSE, wxT("clipboard not open") );
+
+    size_t formatcount = data.GetFormatCount() + 1 ;
+    wxDataFormat *array = new wxDataFormat[ formatcount  ];
+    array[0] = data.GetPreferredFormat();
+    data.GetAllFormats( &array[1] );
+
+    bool transferred = false ;
+
+    if ( m_data )
+    {
+      for (size_t i = 0; !transferred && i < formatcount ; i++)
+      {
+          wxDataFormat format = array[i] ;
+          if ( m_data->IsSupported( format ) )
+          {
+            int size = m_data->GetDataSize( format );
+            transferred = true ;
+
+            if (size == 0)
+            {
+              data.SetData(format , 0 , 0 ) ;
+            }
+            else
+            {
+              char *d = new char[size];
+              m_data->GetDataHere( format , (void*) d );
+              data.SetData( format , size , d ) ;
+              delete[] d ;
+            }
+          }
+       }
+    }
+    /* get formats from wxDataObjects */
+    if ( !transferred )
+    {
+      for (size_t i = 0; !transferred && i < formatcount ; i++)
+      {
+          wxDataFormat format = array[i] ;
+
+          switch ( format.GetType() )
+          {
+              case wxDF_TEXT :
+              case wxDF_OEMTEXT :
+              case wxDF_BITMAP :
+              case wxDF_METAFILE :
+              {
+                  long len ;
+                  char* s = (char*)wxGetClipboardData(format, &len );
+                  if ( s )
+                  {
+                    data.SetData( format , len , s ) ;
+                    delete [] s;
+
+                    transferred = true ;
+                  }
+              }
+                            break ;
+
+              default :
+                break ;
+          }
+       }
+    }

 
 

+    delete[] array ;
+    return transferred ;
+}