Fix deprecating warning introduced in r72446.
[wxWidgets.git] / src / gtk / dataobj.cpp
index 2111b237e8608827d8164af84eee2011c16c72e8..db02431737fc45942e80cc4a0504bbb806cd882d 100644 (file)
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        dataobj.cpp
+// Name:        src/gtk/dataobj.cpp
 // Purpose:     wxDataObject class
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,22 +7,23 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/image.h"
+#endif
+
 #include "wx/mstream.h"
-#include "wx/image.h"
-#include "wx/log.h"
-#include "wx/url.h"
+#include "wx/uri.h"
 
-#include <gdk/gdk.h>
+#include "wx/gtk/private.h"
 
 //-------------------------------------------------------------------------
 // global data
@@ -32,6 +33,7 @@ GdkAtom  g_textAtom        = 0;
 GdkAtom  g_altTextAtom     = 0;
 GdkAtom  g_pngAtom         = 0;
 GdkAtom  g_fileAtom        = 0;
+GdkAtom  g_htmlAtom        = 0;
 
 //-------------------------------------------------------------------------
 // wxDataFormat
@@ -57,13 +59,7 @@ wxDataFormat::wxDataFormat( wxDataFormatId type )
     SetType( type );
 }
 
-wxDataFormat::wxDataFormat( const wxChar *id )
-{
-    PrepareFormats();
-    SetId( id );
-}
-
-wxDataFormat::wxDataFormat( const wxString &id )
+void wxDataFormat::InitFromString( const wxString &id )
 {
     PrepareFormats();
     SetId( id );
@@ -78,18 +74,21 @@ wxDataFormat::wxDataFormat( NativeFormat format )
 void wxDataFormat::SetType( wxDataFormatId type )
 {
     PrepareFormats();
-    
+
     m_type = type;
-    
+
 #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)
+#else // !wxUSE_UNICODE
+    // notice that we don't map wxDF_UNICODETEXT to g_textAtom here, this
+    // would lead the code elsewhere to treat data objects with this format as
+    // containing UTF-8 data which is not true
+    if (m_type == wxDF_TEXT)
         m_format = g_textAtom;
-#endif
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
     else
     if (m_type == wxDF_BITMAP)
         m_format = g_pngAtom;
@@ -97,6 +96,9 @@ void wxDataFormat::SetType( wxDataFormatId type )
     if (m_type == wxDF_FILENAME)
         m_format = g_fileAtom;
     else
+    if (m_type == wxDF_HTML)
+        m_format = g_htmlAtom;
+    else
     {
        wxFAIL_MSG( wxT("invalid dataformat") );
     }
@@ -109,8 +111,8 @@ wxDataFormatId wxDataFormat::GetType() const
 
 wxString wxDataFormat::GetId() const
 {
-    wxString ret = wxString::FromAscii( gdk_atom_name( m_format ) );
-    return ret;
+    wxGtkString atom_name(gdk_atom_name(m_format));
+    return wxString::FromAscii(atom_name);
 }
 
 void wxDataFormat::SetId( NativeFormat format )
@@ -133,38 +135,44 @@ void wxDataFormat::SetId( NativeFormat format )
     else
     if (m_format == g_fileAtom)
         m_type = wxDF_FILENAME;
+    else
+    if (m_format == g_htmlAtom)
+        m_type = wxDF_HTML;
     else
         m_type = wxDF_PRIVATE;
 }
 
-void wxDataFormat::SetId( const wxChar *id )
+void wxDataFormat::SetId( const wxString& id )
 {
     PrepareFormats();
     m_type = wxDF_PRIVATE;
-    wxString tmp( id );
-    m_format = gdk_atom_intern( (const char*) tmp.ToAscii(), FALSE ); 
+    m_format = gdk_atom_intern( id.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
+    //     use STRING for text selection when transferring 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 );
+    if (!g_htmlAtom)
+        g_htmlAtom = gdk_atom_intern( "text/html", FALSE );
 }
 
 //-------------------------------------------------------------------------
@@ -183,17 +191,17 @@ wxDataObject::~wxDataObject()
 bool wxDataObject::IsSupportedFormat(const wxDataFormat& format, Direction dir) const
 {
     size_t nFormatCount = GetFormatCount(dir);
-    if ( nFormatCount == 1 ) 
+    if ( nFormatCount == 1 )
     {
         return format == GetPreferredFormat();
     }
-    else 
+    else
     {
         wxDataFormat *formats = new wxDataFormat[nFormatCount];
         GetAllFormats(formats,dir);
 
         size_t n;
-        for ( n = 0; n < nFormatCount; n++ ) 
+        for ( n = 0; n < nFormatCount; n++ )
         {
             if ( formats[n] == format )
                 break;
@@ -210,13 +218,17 @@ bool wxDataObject::IsSupportedFormat(const wxDataFormat& format, Direction dir)
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 
-#if defined(__WXGTK20__) && wxUSE_UNICODE
-void wxTextDataObject::GetAllFormats(wxDataFormat *formats, wxDataObjectBase::Direction dir) const
+#if wxUSE_UNICODE
+
+void
+wxTextDataObject::GetAllFormats(wxDataFormat *formats,
+                                wxDataObjectBase::Direction WXUNUSED(dir)) const
 {
     *formats++ = GetPreferredFormat();
     *formats = g_altTextAtom;
 }
-#endif
+
+#endif // wxUSE_UNICODE
 
 // ----------------------------------------------------------------------------
 // wxFileDataObject
@@ -233,9 +245,9 @@ bool wxFileDataObject::GetDataHere(void *buf) const
         filenames += wxT("\r\n");
     }
 
-    memcpy( buf, filenames.mbc_str(), filenames.Len() + 1 );
+    memcpy( buf, filenames.mbc_str(), filenames.length() + 1 );
 
-    return TRUE;
+    return true;
 }
 
 size_t wxFileDataObject::GetDataSize() const
@@ -245,7 +257,7 @@ size_t wxFileDataObject::GetDataSize() const
     for (size_t i = 0; i < m_filenames.GetCount(); i++)
     {
         // This is junk in UTF-8
-        res += m_filenames[i].Len();
+        res += m_filenames[i].length();
         res += 5 + 2; // "file:" (5) + "\r\n" (2)
     }
 
@@ -254,56 +266,60 @@ size_t wxFileDataObject::GetDataSize() const
 
 bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *buf)
 {
+    // we get data in the text/uri-list format, i.e. as a sequence of URIs
+    // (filenames prefixed by "file:") delimited by "\r\n". size includes
+    // the trailing zero (in theory, not for Nautilus in early GNOME
+    // versions).
+
     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++ )
+    const gchar *nexttemp = (const gchar*) buf;
+    for ( ; ; )
     {
-        // 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 )
+        int len = 0;
+        const gchar *temp = nexttemp;
+        for (;;)
         {
-            size_t lenPrefix = 5; // strlen("file:")
-            if ( filename.Left(lenPrefix).MakeLower() == _T("file:") )
+            if (temp[len] == 0)
             {
-                // sometimes the syntax is "file:filename", sometimes it's
-                // URL-like: "file://filename" - deal with both
-                if ( filename[lenPrefix] == _T('/') &&
-                     filename[lenPrefix + 1] == _T('/') )
+                if (len > 0)
                 {
-                    // skip the slashes
-                    lenPrefix += 2;
+                    // if an app omits '\r''\n'
+                    nexttemp = temp+len;
+                    break;
                 }
 
-                AddFile(
-#if wxUSE_URL
-                        wxURL::ConvertFromURI
-#endif // wxUSE_URL
-                            (filename.c_str() + lenPrefix));
-                filename.Empty();
+                return true;
             }
-            else
+            if (temp[len] == '\r')
             {
-                wxLogDebug(_T("Unsupported URI '%s' in wxFileDataObject"),
-                           filename.c_str());
+                if (temp[len+1] == '\n')
+                    nexttemp = temp+len+2;
+                else
+                    nexttemp = temp+len+1;
+                break;
             }
+            len++;
+        }
 
-            if ( !*p )
-                break;
+        if (len == 0)
+            break;
 
-            // skip '\r'
-            p++;
-        }
-        else
+        // required to give it a trailing zero
+        gchar *uri = g_strndup( temp, len );
+
+        gchar *fn = g_filename_from_uri( uri, NULL, NULL );
+
+        g_free( uri );
+
+        if (fn)
         {
-            filename += *p;
+            AddFile( wxConvFileName->cMB2WX( fn ) );
+            g_free( fn );
         }
     }
 
-    return TRUE;
+    return true;
 }
 
 void wxFileDataObject::AddFile( const wxString &filename )
@@ -348,12 +364,12 @@ bool wxBitmapDataObject::GetDataHere(void *buf) const
     {
         wxFAIL_MSG( wxT("attempt to copy empty bitmap failed") );
 
-        return FALSE;
+        return false;
     }
 
     memcpy(buf, m_pngData, m_pngSize);
 
-    return TRUE;
+    return true;
 }
 
 bool wxBitmapDataObject::SetData(size_t size, const void *buf)
@@ -361,7 +377,7 @@ bool wxBitmapDataObject::SetData(size_t size, const void *buf)
     Clear();
 
     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!") );
+                 false, wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
 
     m_pngSize = size;
     m_pngData = malloc(m_pngSize);
@@ -372,17 +388,17 @@ bool wxBitmapDataObject::SetData(size_t size, const void *buf)
     wxImage image;
     if ( !image.LoadFile( mstream, wxBITMAP_TYPE_PNG ) )
     {
-        return FALSE;
+        return false;
     }
 
     m_bitmap = wxBitmap(image);
 
-    return m_bitmap.Ok();
+    return m_bitmap.IsOk();
 }
 
 void wxBitmapDataObject::DoConvertToPng()
 {
-    if ( !m_bitmap.Ok() )
+    if ( !m_bitmap.IsOk() )
         return;
 
     wxCHECK_RET( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
@@ -400,4 +416,105 @@ void wxBitmapDataObject::DoConvertToPng()
     image.SaveFile(mstream, wxBITMAP_TYPE_PNG);
 }
 
+// ----------------------------------------------------------------------------
+// wxURLDataObject
+// ----------------------------------------------------------------------------
+
+class wxTextURIListDataObject : public wxDataObjectSimple
+{
+public:
+    wxTextURIListDataObject(const wxString& url)
+        : wxDataObjectSimple(wxDataFormat(g_fileAtom)),
+          m_url(url)
+    {
+    }
+
+    const wxString& GetURL() const { return m_url; }
+    void SetURL(const wxString& url) { m_url = url; }
+
+
+    virtual size_t GetDataSize() const
+    {
+        // It is not totally clear whether we should include "\r\n" at the end
+        // of the string if there is only one URL or not, but not doing it
+        // doesn't seem to create any problems, so keep things simple.
+        return strlen(m_url.utf8_str()) + 1;
+    }
+
+    virtual bool GetDataHere(void *buf) const
+    {
+        char* const dst = static_cast<char*>(buf);
+
+        strcpy(dst, m_url.utf8_str());
+
+        return true;
+    }
+
+    virtual bool SetData(size_t len, const void *buf)
+    {
+        const char* const src = static_cast<const char*>(buf);
+
+        // The string might be "\r\n"-terminated but this is not necessarily
+        // the case (e.g. when dragging an URL from Firefox, it isn't).
+        if ( len > 1 && src[len - 1] == '\n' )
+        {
+            if ( len > 2 && src[len - 2] == '\r' )
+                len--;
+
+            len--;
+        }
+
+        m_url = wxString::FromUTF8(src, len);
+
+        return true;
+    }
+
+    // Must provide overloads to avoid hiding them (and warnings about it)
+    virtual size_t GetDataSize(const wxDataFormat&) const
+    {
+        return GetDataSize();
+    }
+    virtual bool GetDataHere(const wxDataFormat&, void *buf) const
+    {
+        return GetDataHere(buf);
+    }
+    virtual bool SetData(const wxDataFormat&, size_t len, const void *buf)
+    {
+        return SetData(len, buf);
+    }
+
+private:
+    wxString m_url;
+};
+
+wxURLDataObject::wxURLDataObject(const wxString& url) :
+    m_dobjURIList(new wxTextURIListDataObject(url)),
+    m_dobjText(new wxTextDataObject(url))
+{
+    // Use both URL-specific format and a plain text one to ensure that URLs
+    // can be pasted into any application.
+    Add(m_dobjURIList, true /* preferred */);
+    Add(m_dobjText);
+}
+
+void wxURLDataObject::SetURL(const wxString& url)
+{
+    m_dobjURIList->SetURL(url);
+    m_dobjText->SetText(url);
+}
+
+wxString wxURLDataObject::GetURL() const
+{
+    if ( GetReceivedFormat() == g_fileAtom )
+    {
+        // If we received the URL as an URI, use it.
+        return m_dobjURIList->GetURL();
+    }
+    else // Otherwise we either got it as text or didn't get anything yet.
+    {
+        // In either case using the text format should be fine.
+        return m_dobjText->GetText();
+    }
+}
 
+#endif // wxUSE_DATAOBJ