]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/dataobj.cpp
minimize overlay area to avoid eg scrolling artifacts when using a caret
[wxWidgets.git] / src / gtk / dataobj.cpp
index a3ed60aa983ac693f9db3e897f55abbc8bce909b..ef24cfe8afc6dea778727548f8dcf1a211163f24 100644 (file)
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        dataobj.cpp
+// Name:        src/gtk/dataobj.cpp
 // Purpose:     wxDataObject class
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "dataobj.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#if wxUSE_DATAOBJ
 
 #include "wx/dataobj.h"
-#include "wx/app.h"
-#include "wx/debug.h"
 
-#include "gdk/gdk.h"
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/image.h"
+#endif
 
+#include "wx/mstream.h"
+#include "wx/uri.h"
+
+#include "wx/gtk/private.h"
 
 //-------------------------------------------------------------------------
 // global data
 //-------------------------------------------------------------------------
 
 GdkAtom  g_textAtom        = 0;
+GdkAtom  g_altTextAtom     = 0;
+GdkAtom  g_pngAtom         = 0;
+GdkAtom  g_fileAtom        = 0;
 
 //-------------------------------------------------------------------------
 // wxDataFormat
 //-------------------------------------------------------------------------
 
-IMPLEMENT_CLASS(wxDataFormat, wxObject)
-
 wxDataFormat::wxDataFormat()
 {
-    if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE );
+    // do *not* call PrepareFormats() from here for 2 reasons:
+    //
+    // 1. we will have time to do it later because some other Set function
+    //    must be called before we really need them
+    //
+    // 2. doing so prevents us from declaring global wxDataFormats because
+    //    calling PrepareFormats (and thus gdk_atom_intern) before GDK is
+    //    initialised will result in a crash
     m_type = wxDF_INVALID;
-    m_hasAtom = FALSE;
-    m_atom = (GdkAtom) 0;
+    m_format = (GdkAtom) 0;
 }
 
-wxDataFormat::wxDataFormat( wxDataType type )
+wxDataFormat::wxDataFormat( wxDataFormatId type )
 {
-    if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE );
+    PrepareFormats();
     SetType( type );
 }
 
-wxDataFormat::wxDataFormat( const wxString &id )
+wxDataFormat::wxDataFormat( const wxChar *id )
 {
-    if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE );
+    PrepareFormats();
     SetId( id );
 }
 
-wxDataFormat::wxDataFormat( wxDataFormat &format )
+wxDataFormat::wxDataFormat( const wxString &id )
 {
-    if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE );
-    m_type = format.GetType();
-    m_id = format.GetId();
-    m_hasAtom = TRUE;
-    m_atom = format.GetAtom();
+    PrepareFormats();
+    SetId( id );
 }
 
-wxDataFormat::wxDataFormat( const GdkAtom atom )
+wxDataFormat::wxDataFormat( NativeFormat format )
 {
-    if (!g_textAtom) g_textAtom = gdk_atom_intern( "TEXT", FALSE );
-    m_hasAtom = TRUE;
-    
-    m_atom = atom;
-    
-    if (m_atom == g_textAtom)
-    {
-        m_type = wxDF_TEXT;
-    } else
-    if (m_atom == GDK_TARGET_BITMAP)
-    {
-        m_type = wxDF_BITMAP;
-    } else
-    {
-        m_type = wxDF_PRIVATE;
-       m_id = gdk_atom_name( m_atom );
-       
-       if (m_id == "file:ALL")
-       {
-           m_type = wxDF_FILENAME;
-       }
-    }
+    PrepareFormats();
+    SetId( format );
 }
 
-void wxDataFormat::SetType( wxDataType type )
+void wxDataFormat::SetType( wxDataFormatId type )
 {
+    PrepareFormats();
+
     m_type = type;
-    
-    if (m_type == wxDF_TEXT)
-    {
-        m_id = "TEXT";
-    } 
+
+#if wxUSE_UNICODE
+    if (m_type == wxDF_UNICODETEXT)
+        m_format = g_textAtom;
+    else if (m_type == wxDF_TEXT)
+        m_format = g_altTextAtom;
+#else
+    if (m_type == wxDF_TEXT || m_type == wxDF_UNICODETEXT)
+        m_format = g_textAtom;
+#endif
     else
     if (m_type == wxDF_BITMAP)
-    {
-        m_id = "BITMAP";
-    } 
+        m_format = g_pngAtom;
     else
     if (m_type == wxDF_FILENAME)
-    {
-        m_id = "file:ALL";
-    }
+        m_format = g_fileAtom;
     else
     {
-       wxFAIL_MSG( "invalid dataformat" );
+       wxFAIL_MSG( wxT("invalid dataformat") );
     }
-    
-    m_hasAtom = FALSE;
 }
-  
-wxDataType wxDataFormat::GetType() const
+
+wxDataFormatId wxDataFormat::GetType() const
 {
     return m_type;
 }
 
 wxString wxDataFormat::GetId() const
 {
-    return m_id;
-}
-
-void wxDataFormat::SetId( const wxString &id )
-{
-    m_type = wxDF_PRIVATE;
-    m_id = id;
-    m_hasAtom = FALSE;
+    wxGtkString atom_name(gdk_atom_name(m_format));
+    return wxString::FromAscii(atom_name);
 }
 
-GdkAtom wxDataFormat::GetAtom()
+void wxDataFormat::SetId( NativeFormat format )
 {
-    if (!m_hasAtom)
-    {
-        m_hasAtom = TRUE;
-       
-       if (m_type == wxDF_TEXT)
-       {
-            m_atom = g_textAtom;
-        }
-       else
-        if (m_type == wxDF_BITMAP)
-        {
-            m_atom = GDK_TARGET_BITMAP;
-        } 
-       else
-        if (m_type == wxDF_PRIVATE)
-        {
-            m_atom = gdk_atom_intern( WXSTRINGCAST( m_id ), FALSE );
-        } 
-       else
-       if (m_type == wxDF_FILENAME)
-       {
-           m_atom = gdk_atom_intern( "file:ALL", FALSE );
-       } 
-       else
-       {
-           m_hasAtom = FALSE;
-           m_atom = (GdkAtom) 0;
-       }
-    }
-    
-    return m_atom;
-}
-
-//-------------------------------------------------------------------------
-// wxDataBroker
-//-------------------------------------------------------------------------
+    PrepareFormats();
+    m_format = format;
 
-IMPLEMENT_CLASS(wxDataBroker,wxObject)
-
-wxDataBroker::wxDataBroker() 
-{ 
-    m_dataObjects.DeleteContents(TRUE);
-    m_preferred = 0;
+    if (m_format == g_textAtom)
+#if wxUSE_UNICODE
+        m_type = wxDF_UNICODETEXT;
+#else
+        m_type = wxDF_TEXT;
+#endif
+    else
+    if (m_format == g_altTextAtom)
+        m_type = wxDF_TEXT;
+    else
+    if (m_format == g_pngAtom)
+        m_type = wxDF_BITMAP;
+    else
+    if (m_format == g_fileAtom)
+        m_type = wxDF_FILENAME;
+    else
+        m_type = wxDF_PRIVATE;
 }
 
-void wxDataBroker::Add( wxDataObject *dataObject, bool preferred )
-{ 
-    if (preferred) m_preferred = m_dataObjects.GetCount();
-    m_dataObjects.Append( dataObject );
-}  
-  
-size_t wxDataBroker::GetFormatCount() const
-{ 
-    return m_dataObjects.GetCount(); 
-}
-    
-wxDataFormat &wxDataBroker::GetPreferredFormat() const
-{ 
-    wxNode *node = m_dataObjects.Nth( m_preferred );
-    
-    wxASSERT( node );
-    
-    wxDataObject* data_obj = (wxDataObject*)node->Data();
-    
-    return data_obj->GetFormat();
-}
-    
-wxDataFormat &wxDataBroker::GetNthFormat( size_t nth ) const
-{ 
-    wxNode *node = m_dataObjects.Nth( nth );
-
-    wxASSERT( node );
-    
-    wxDataObject* data_obj = (wxDataObject*)node->Data();
-    
-    return data_obj->GetFormat();
-}
-    
-bool wxDataBroker::IsSupportedFormat( wxDataFormat &format ) const
-{ 
-    wxNode *node = m_dataObjects.First();
-    while (node)
-    {
-        wxDataObject *dobj = (wxDataObject*)node->Data();
-       
-       if (dobj->GetFormat().GetAtom() == format.GetAtom())
-       {
-           return TRUE;
-       }
-    
-        node = node->Next();
-    }
-    
-    return FALSE;
-}
-  
-size_t wxDataBroker::GetSize( wxDataFormat& format ) const
-{
-    wxNode *node = m_dataObjects.First();
-    while (node)
-    {
-        wxDataObject *dobj = (wxDataObject*)node->Data();
-       
-       if (dobj->GetFormat().GetAtom() == format.GetAtom())
-       {
-           return dobj->GetSize();
-       }
-    
-        node = node->Next();
-    }
-    
-    return 0;
-}
-    
-void wxDataBroker::WriteData( wxDataFormat& format, void *dest ) const
+void wxDataFormat::SetId( const wxChar *id )
 {
-    wxNode *node = m_dataObjects.First();
-    while (node)
-    {
-        wxDataObject *dobj = (wxDataObject*)node->Data();
-       
-       if (dobj->GetFormat().GetAtom() == format.GetAtom())
-       {
-           dobj->WriteData( dest );
-       }
-    
-        node = node->Next();
-    }
+    PrepareFormats();
+    m_type = wxDF_PRIVATE;
+    wxString tmp( id );
+    m_format = gdk_atom_intern( (const char*) tmp.ToAscii(), FALSE );
+}
+
+void wxDataFormat::PrepareFormats()
+{
+    // VZ: GNOME included in RedHat 6.1 uses the MIME types below and not the
+    //     atoms STRING and file:ALL as the old code was, but normal X apps
+    //     use STRING for text selection when transfering the data via
+    //     clipboard, for example, so do use STRING for now (GNOME apps will
+    //     probably support STRING as well for compatibility anyhow), but use
+    //     text/uri-list for file dnd because compatibility is not important
+    //     here (with whom?)
+    if (!g_textAtom)
+#if wxUSE_UNICODE
+        g_textAtom = gdk_atom_intern( "UTF8_STRING", FALSE );
+        g_altTextAtom = gdk_atom_intern( "STRING", FALSE );
+#else
+        g_textAtom = gdk_atom_intern( "STRING" /* "text/plain" */, FALSE );
+#endif
+    if (!g_pngAtom)
+        g_pngAtom = gdk_atom_intern( "image/png", FALSE );
+    if (!g_fileAtom)
+        g_fileAtom = gdk_atom_intern( "text/uri-list", FALSE );
 }
 
 //-------------------------------------------------------------------------
 // wxDataObject
 //-------------------------------------------------------------------------
 
-IMPLEMENT_ABSTRACT_CLASS( wxDataObject, wxObject )
-
 wxDataObject::wxDataObject()
 {
 }
-  
+
 wxDataObject::~wxDataObject()
 {
+    // dtor is empty but needed for Darwin and AIX -- otherwise it doesn't link
 }
 
-wxDataFormat &wxDataObject::GetFormat()
+bool wxDataObject::IsSupportedFormat(const wxDataFormat& format, Direction dir) const
 {
-    return m_format;
-}
+    size_t nFormatCount = GetFormatCount(dir);
+    if ( nFormatCount == 1 )
+    {
+        return format == GetPreferredFormat();
+    }
+    else
+    {
+        wxDataFormat *formats = new wxDataFormat[nFormatCount];
+        GetAllFormats(formats,dir);
 
-wxDataType wxDataObject::GetFormatType() const
-{
-    return m_format.GetType();
-}
+        size_t n;
+        for ( n = 0; n < nFormatCount; n++ )
+        {
+            if ( formats[n] == format )
+                break;
+        }
 
-wxString wxDataObject::GetFormatId() const
-{
-    return m_format.GetId();
-}
+        delete [] formats;
 
-GdkAtom wxDataObject::GetFormatAtom() const
-{
-    GdkAtom ret = ((wxDataObject*) this)->m_format.GetAtom();
-    return ret;
-}  
+        // found?
+        return n < nFormatCount;
+    }
+}
 
 // ----------------------------------------------------------------------------
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS( wxTextDataObject, wxDataObject )
-
-wxTextDataObject::wxTextDataObject()
+#if defined(__WXGTK20__) && wxUSE_UNICODE
+void wxTextDataObject::GetAllFormats(wxDataFormat *formats, wxDataObjectBase::Direction dir) const
 {
-    m_format.SetType( wxDF_TEXT );
+    *formats++ = GetPreferredFormat();
+    *formats = g_altTextAtom;
 }
+#endif
 
-wxTextDataObject::wxTextDataObject( const wxString& data )
-{
-    m_format.SetType( wxDF_TEXT );
-    
-    m_data = data;
-}
+// ----------------------------------------------------------------------------
+// wxFileDataObject
+// ----------------------------------------------------------------------------
 
-void wxTextDataObject::SetText( const wxString& data ) 
+bool wxFileDataObject::GetDataHere(void *buf) const
 {
-    m_data = data;
-}
+    wxString filenames;
 
-wxString wxTextDataObject::GetText() const
-{
-    return m_data;
-}
+    for (size_t i = 0; i < m_filenames.GetCount(); i++)
+    {
+        filenames += wxT("file:");
+        filenames += m_filenames[i];
+        filenames += wxT("\r\n");
+    }
 
-void wxTextDataObject::WriteData( void *dest ) const
-{
-    WriteString( m_data, dest );
-}
+    memcpy( buf, filenames.mbc_str(), filenames.length() + 1 );
 
-size_t wxTextDataObject::GetSize() const
-{
-    return m_data.Len() + 1;
+    return true;
 }
 
-void wxTextDataObject::WriteString( const wxString &str, void *dest ) const
+size_t wxFileDataObject::GetDataSize() const
 {
-    memcpy( dest, m_data.c_str(), GetSize() );
-}
-    
-// ----------------------------------------------------------------------------
-// wxFileDataObject
-// ----------------------------------------------------------------------------
+    size_t res = 0;
 
-IMPLEMENT_DYNAMIC_CLASS( wxFileDataObject, wxDataObject )
+    for (size_t i = 0; i < m_filenames.GetCount(); i++)
+    {
+        // This is junk in UTF-8
+        res += m_filenames[i].length();
+        res += 5 + 2; // "file:" (5) + "\r\n" (2)
+    }
 
-wxFileDataObject::wxFileDataObject()
-{
-    m_format.SetType( wxDF_FILENAME );
+    return res + 1;
 }
 
-void wxFileDataObject::AddFile( const wxString &file )
-{ 
-    m_files += file; 
-    m_files += (char)0; 
-}
-    
-wxString wxFileDataObject::GetFiles() const
-{ 
-    return m_files; 
-}
-    
-void wxFileDataObject::WriteData( void *dest ) const
+bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *buf)
 {
-    memcpy( dest, m_files.c_str(), GetSize() );
+    m_filenames.Empty();
+
+    // we get data in the text/uri-list format, i.e. as a sequence of URIs
+    // (filenames prefixed by "file:") delimited by "\r\n"
+    wxString filename;
+    for ( const char *p = (const char *)buf; ; p++ )
+    {
+        // some broken programs (testdnd GTK+ sample!) omit the trailing
+        // "\r\n", so check for '\0' explicitly here instead of doing it in
+        // the loop statement to account for it
+        if ( (*p == '\r' && *(p+1) == '\n') || !*p )
+        {
+            size_t lenPrefix = 5; // strlen("file:")
+            if ( filename.Left(lenPrefix).MakeLower() == _T("file:") )
+            {
+                // sometimes the syntax is "file:filename", sometimes it's
+                // URL-like: "file://filename" - deal with both
+                if ( filename[lenPrefix] == _T('/') &&
+                     filename[lenPrefix + 1] == _T('/') )
+                {
+                    // skip the slashes
+                    lenPrefix += 2;
+                }
+
+                AddFile(wxURI::Unescape(filename.c_str() + lenPrefix));
+                filename.Empty();
+            }
+            else if ( !filename.empty() )
+            {
+                wxLogDebug(_T("Unsupported URI \"%s\" in wxFileDataObject"),
+                           filename.c_str());
+            }
+
+            if ( !*p )
+                break;
+
+            // skip '\r'
+            p++;
+        }
+        else
+        {
+            filename += *p;
+        }
+    }
+
+    return true;
 }
-size_t wxFileDataObject::GetSize() const
+
+void wxFileDataObject::AddFile( const wxString &filename )
 {
-    return m_files.Len() + 1;
+   m_filenames.Add( filename );
 }
-  
+
 // ----------------------------------------------------------------------------
 // wxBitmapDataObject
 // ----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS( wxBitmapDataObject, wxDataObject )
-
 wxBitmapDataObject::wxBitmapDataObject()
 {
-    m_format.SetType( wxDF_BITMAP );
+    Init();
 }
 
 wxBitmapDataObject::wxBitmapDataObject( const wxBitmap& bitmap )
+                  : wxBitmapDataObjectBase(bitmap)
 {
-    m_format.SetType( wxDF_BITMAP );
-    
-    m_bitmap = bitmap;
-}
+    Init();
 
-void wxBitmapDataObject::SetBitmap( const wxBitmap &bitmap )
-{
-    m_bitmap = bitmap;
+    DoConvertToPng();
 }
 
-wxBitmap wxBitmapDataObject::GetBitmap() const
+wxBitmapDataObject::~wxBitmapDataObject()
 {
-    return m_bitmap;
+    Clear();
 }
 
-void wxBitmapDataObject::WriteData( void *dest ) const
+void wxBitmapDataObject::SetBitmap( const wxBitmap &bitmap )
 {
-    WriteBitmap( m_bitmap, dest );
-}
+    ClearAll();
 
-size_t wxBitmapDataObject::GetSize() const
-{
-    return 0;
+    wxBitmapDataObjectBase::SetBitmap(bitmap);
+
+    DoConvertToPng();
 }
 
-void wxBitmapDataObject::WriteBitmap( const wxBitmap &bitmap, void *dest ) const
+bool wxBitmapDataObject::GetDataHere(void *buf) const
 {
-    memcpy( dest, m_bitmap.GetPixmap(), GetSize() );
-}
-    
-// ----------------------------------------------------------------------------
-// wxPrivateDataObject
-// ----------------------------------------------------------------------------
+    if ( !m_pngSize )
+    {
+        wxFAIL_MSG( wxT("attempt to copy empty bitmap failed") );
 
-IMPLEMENT_DYNAMIC_CLASS( wxPrivateDataObject, wxDataObject )
-
-wxPrivateDataObject::wxPrivateDataObject() 
-{ 
-    m_id = "application/";
-    m_id += wxTheApp->GetAppName();
-    
-    m_format.SetId( m_id );
-    
-    m_size = 0; 
-    m_data = (char*) NULL; 
-}
-    
-wxPrivateDataObject::~wxPrivateDataObject()
-{ 
-    if (m_data) delete[] m_data; 
-}
-  
-void wxPrivateDataObject::SetId( const wxString& id )
-{ 
-    m_id = id;
-    m_format.SetId( m_id );
-}
-    
-wxString wxPrivateDataObject::GetId() const
-{ 
-    return m_id; 
-}
+        return false;
+    }
 
-void wxPrivateDataObject::SetData( const char *data, size_t size )
-{
-    m_size = size;
-    
-    if (m_data) delete[] m_data;
-    
-    m_data = new char[size];
+    memcpy(buf, m_pngData, m_pngSize);
 
-    memcpy( m_data, data, size );  
+    return true;
 }
 
-char* wxPrivateDataObject::GetData() const
+bool wxBitmapDataObject::SetData(size_t size, const void *buf)
 {
-    return m_data;
-}
+    Clear();
 
-void wxPrivateDataObject::WriteData( void *dest ) const
-{
-    WriteData( m_data, dest );
-}
+    wxCHECK_MSG( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
+                 false, wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
 
-size_t wxPrivateDataObject::GetSize() const
-{
-   return m_size;
+    m_pngSize = size;
+    m_pngData = malloc(m_pngSize);
+
+    memcpy(m_pngData, buf, m_pngSize);
+
+    wxMemoryInputStream mstream((char*) m_pngData, m_pngSize);
+    wxImage image;
+    if ( !image.LoadFile( mstream, wxBITMAP_TYPE_PNG ) )
+    {
+        return false;
+    }
+
+    m_bitmap = wxBitmap(image);
+
+    return m_bitmap.Ok();
 }
 
-void wxPrivateDataObject::WriteData( const char *data, void *dest ) const
+void wxBitmapDataObject::DoConvertToPng()
 {
-    memcpy( dest, data, GetSize() );
+    if ( !m_bitmap.Ok() )
+        return;
+
+    wxCHECK_RET( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
+                 wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
+
+    wxImage image = m_bitmap.ConvertToImage();
+
+    wxCountingOutputStream count;
+    image.SaveFile(count, wxBITMAP_TYPE_PNG);
+
+    m_pngSize = count.GetSize() + 100; // sometimes the size seems to vary ???
+    m_pngData = malloc(m_pngSize);
+
+    wxMemoryOutputStream mstream((char*) m_pngData, m_pngSize);
+    image.SaveFile(mstream, wxBITMAP_TYPE_PNG);
 }
 
+#endif // wxUSE_DATAOBJ