Don't handle branches specially when sorting items in wxDataViewCtrl.

[wxWidgets.git] / src / common / dobjcmn.cpp

diff --git a/src/common/dobjcmn.cpp b/src/common/dobjcmn.cpp
index ac306c2d902c1381e2f75ec45e81767720d4aa61..ebe87267b772dcf85d41bc70096d885818168ba8 100644 (file)
--- a/src/common/dobjcmn.cpp
+++ b/src/common/dobjcmn.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        common/dobjcmn.cpp
+// Name:        src/common/dobjcmn.cpp

 // Purpose:     implementation of data object methods common to all platforms
 // Author:      Vadim Zeitlin, Robert Roebling
 // Modified by:
 // Purpose:     implementation of data object methods common to all platforms
 // Author:      Vadim Zeitlin, Robert Roebling
 // Modified by:


@@ -9,18 +9,7 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "dataobjbase.h"
-#endif
-
+// For compilers that support precompilation, includes "wx.h".

 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__


@@ -29,12 +18,11 @@
 
 #if wxUSE_DATAOBJ
 
 
 #if wxUSE_DATAOBJ
 

+#include "wx/dataobj.h"
+

 #ifndef WX_PRECOMP
     #include "wx/app.h"
 #ifndef WX_PRECOMP
     #include "wx/app.h"

-    #include "wx/debug.h"
-#endif // WX_PRECOMP
-
-#include "wx/dataobj.h"
+#endif

 
 // ----------------------------------------------------------------------------
 // lists
 
 // ----------------------------------------------------------------------------
 // lists


@@ -42,7 +30,7 @@
 
 #include "wx/listimpl.cpp"
 
 
 #include "wx/listimpl.cpp"
 

-WX_DEFINE_LIST(wxSimpleDataObjectList);
+WX_DEFINE_LIST(wxSimpleDataObjectList)

 
 // ----------------------------------------------------------------------------
 // globals
 
 // ----------------------------------------------------------------------------
 // globals


@@ -66,15 +54,15 @@ wxDataObjectBase::~wxDataObjectBase()
 bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
                                    Direction dir) const
 {
 bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
                                    Direction dir) const
 {

-    size_t nFormatCount = GetFormatCount(dir);
+    size_t nFormatCount = GetFormatCount( dir );

     if ( nFormatCount == 1 )
     {
     if ( nFormatCount == 1 )
     {

-        return format == GetPreferredFormat(dir);
+        return format == GetPreferredFormat( dir );

     }
     else
     {
         wxDataFormat *formats = new wxDataFormat[nFormatCount];
     }
     else
     {
         wxDataFormat *formats = new wxDataFormat[nFormatCount];

-        GetAllFormats(formats, dir);
+        GetAllFormats( formats, dir );

 
         size_t n;
         for ( n = 0; n < nFormatCount; n++ )
 
         size_t n;
         for ( n = 0; n < nFormatCount; n++ )


@@ -97,30 +85,28 @@ bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
 wxDataObjectComposite::wxDataObjectComposite()
 {
     m_preferred = 0;
 wxDataObjectComposite::wxDataObjectComposite()
 {
     m_preferred = 0;

+    m_receivedFormat = wxFormatInvalid;

 }
 
 wxDataObjectComposite::~wxDataObjectComposite()
 {
 }
 
 wxDataObjectComposite::~wxDataObjectComposite()
 {

-    WX_CLEAR_LIST(wxSimpleDataObjectList, m_dataObjects);
+    WX_CLEAR_LIST( wxSimpleDataObjectList, m_dataObjects );

 }
 
 wxDataObjectSimple *
 }
 
 wxDataObjectSimple *

-wxDataObjectComposite::GetObject(const wxDataFormat& format) const
+wxDataObjectComposite::GetObject(const wxDataFormat& format, wxDataObjectBase::Direction dir) const

 {
     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();
 {
     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();

+

     while ( node )
     {
         wxDataObjectSimple *dataObj = node->GetData();
 
     while ( node )
     {
         wxDataObjectSimple *dataObj = node->GetData();
 

-        if ( dataObj->GetFormat() == format )
-        {
-            return dataObj;
-        }
-
+        if (dataObj->IsSupported(format,dir))
+          return dataObj;

         node = node->GetNext();
     }
         node = node->GetNext();
     }

-
-    return (wxDataObjectSimple *)NULL;
+    return NULL;

 }
 
 void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)
 }
 
 void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)


@@ -131,6 +117,11 @@ void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)
     m_dataObjects.Append( dataObject );
 }
 
     m_dataObjects.Append( dataObject );
 }
 

+wxDataFormat wxDataObjectComposite::GetReceivedFormat() const
+{
+    return m_receivedFormat;
+}
+

 wxDataFormat
 wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
 {
 wxDataFormat
 wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
 {


@@ -172,7 +163,7 @@ const void* wxDataObjectComposite::GetSizeFromBuffer( const void* buffer,
 void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
                                               const wxDataFormat& format )
 {
 void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
                                               const wxDataFormat& format )
 {

-    wxDataObjectSimple *dataObj = GetObject(format);
+    wxDataObjectSimple *dataObj = GetObject( format );

 
     wxCHECK_MSG( dataObj, NULL,
                  wxT("unsupported format in wxDataObjectComposite"));
 
     wxCHECK_MSG( dataObj, NULL,
                  wxT("unsupported format in wxDataObjectComposite"));


@@ -182,21 +173,33 @@ void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
 
 #endif
 
 
 #endif
 

-size_t wxDataObjectComposite::GetFormatCount(Direction WXUNUSED(dir)) const
+size_t wxDataObjectComposite::GetFormatCount(Direction dir) const

 {
 {

-    // TODO what about the Get/Set only formats?
-    return m_dataObjects.GetCount();
+    size_t n = 0;
+
+    // NOTE: some wxDataObjectSimple objects may return a number greater than 1
+    //       from GetFormatCount(): this is the case of e.g. wxTextDataObject
+    //       under wxMac and wxGTK
+    wxSimpleDataObjectList::compatibility_iterator node;
+    for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
+        n += node->GetData()->GetFormatCount(dir);
+
+    return n;

 }
 
 void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,
 }
 
 void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,

-                                          Direction WXUNUSED(dir)) const
+                                          Direction dir) const

 {
 {

-    size_t n = 0;
+    size_t index(0);

     wxSimpleDataObjectList::compatibility_iterator node;
     wxSimpleDataObjectList::compatibility_iterator node;

+

     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {
     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {

-        // TODO if ( !outputOnlyToo ) && this one counts ...
-        formats[n++] = node->GetData()->GetFormat();
+        // NOTE: some wxDataObjectSimple objects may return more than 1 format
+        //       from GetAllFormats(): this is the case of e.g. wxTextDataObject
+        //       under wxMac and wxGTK
+        node->GetData()->GetAllFormats(formats+index, dir);
+        index += node->GetData()->GetFormatCount(dir);

     }
 }
 
     }
 }
 


@@ -213,31 +216,43 @@ size_t wxDataObjectComposite::GetDataSize(const wxDataFormat& format) const
 bool wxDataObjectComposite::GetDataHere(const wxDataFormat& format,
                                         void *buf) const
 {
 bool wxDataObjectComposite::GetDataHere(const wxDataFormat& format,
                                         void *buf) const
 {

-    wxDataObjectSimple *dataObj = GetObject(format);
+    wxDataObjectSimple *dataObj = GetObject( format );

 
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 
 
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 

-    return dataObj->GetDataHere(buf);
+    return dataObj->GetDataHere( buf );

 }
 
 bool wxDataObjectComposite::SetData(const wxDataFormat& format,
                                     size_t len,
                                     const void *buf)
 {
 }
 
 bool wxDataObjectComposite::SetData(const wxDataFormat& format,
                                     size_t len,
                                     const void *buf)
 {

-    wxDataObjectSimple *dataObj = GetObject(format);
+    wxDataObjectSimple *dataObj = GetObject( format );

 
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 
 
     wxCHECK_MSG( dataObj, false,
                  wxT("unsupported format in wxDataObjectComposite"));
 

-    return dataObj->SetData(len, buf);
+    m_receivedFormat = format;
+
+    // Notice that we must pass "format" here as wxTextDataObject, that we can
+    // have as one of our "simple" sub-objects actually is not that simple and
+    // can support multiple formats (ASCII/UTF-8/UTF-16/...) and so needs to
+    // know which one it is given.
+    return dataObj->SetData( format, len, buf );

 }
 
 // ----------------------------------------------------------------------------
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxTextDataObject
 // ----------------------------------------------------------------------------
 

-#if defined(__WXGTK20__) && wxUSE_UNICODE
+#ifdef wxNEEDS_UTF8_FOR_TEXT_DATAOBJ
+
+// FIXME-UTF8: we should be able to merge wchar_t and UTF-8 versions once we
+//             have a way to get UTF-8 string (and its length) in both builds
+//             without loss of efficiency (i.e. extra buffer copy/strlen call)
+
+#if wxUSE_UNICODE_WCHAR

 
 static inline wxMBConv& GetConv(const wxDataFormat& format)
 {
 
 static inline wxMBConv& GetConv(const wxDataFormat& format)
 {


@@ -248,16 +263,21 @@ static inline wxMBConv& GetConv(const wxDataFormat& format)
 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 {
     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 {
     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );

-    return buffer ? strlen(buffer) + 1 : 0;
+
+    return buffer ? strlen( buffer ) : 0;

 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {
 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {

+    if ( !buf )
+        return false;
+

     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
     if ( !buffer )
         return false;
 
     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
     if ( !buffer )
         return false;
 

-    strcpy( (char*) buf, buffer );
+    memcpy( (char*) buf, buffer, GetDataSize(format) );
+    // strcpy( (char*) buf, buffer );

 
     return true;
 }
 
     return true;
 }


@@ -265,135 +285,147 @@ bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 bool wxTextDataObject::SetData(const wxDataFormat& format,
                                size_t WXUNUSED(len), const void *buf)
 {
 bool wxTextDataObject::SetData(const wxDataFormat& format,
                                size_t WXUNUSED(len), const void *buf)
 {

-    wxWCharBuffer buffer = GetConv(format).cMB2WX((const char *)buf);
-    if ( !buffer )
+    if ( buf == NULL )

         return false;
 
         return false;
 

-    SetText(buffer);
+    wxWCharBuffer buffer = GetConv(format).cMB2WX( (const char*)buf );
+
+    SetText( buffer );

 
     return true;
 }
 
 
     return true;
 }
 

-#elif wxUSE_UNICODE && defined(__WXMAC__)
+#else // wxUSE_UNICODE_UTF8

 
 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 {
 
 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 {

-    if (format == wxDF_UNICODETEXT)
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )

     {
     {

-        // host native is UTF16
-        wxMBConvUTF16BE converter ;
-        return converter.WC2MB( NULL , GetText().c_str() , 0 ) + 2; // add space for trailing unichar 0
+        return m_text.utf8_length();

     }
     }

-    else  // == wxDF_TEXT
+    else // wxDF_TEXT

     {
     {

-        wxCharBuffer buffer = wxConvLibc.cWX2MB( GetText().c_str() );
-        return strlen( (const char*) buffer ) + 1;
+        const wxCharBuffer buf(wxConvLocal.cWC2MB(m_text.wc_str()));
+        return buf ? strlen(buf) : 0;

     }
 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {
     }
 }
 
 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 {

-    if (format == wxDF_UNICODETEXT)
+    if ( !buf )
+        return false;
+
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )

     {
     {

-        // host native is UTF16
-        wxMBConvUTF16BE converter ;
-        size_t len = converter.WC2MB( NULL , GetText().c_str() , 0 ) ;
-        wxCharBuffer buffer = converter.cWX2MB( GetText().c_str() );
-        memcpy( (char*) buf, (const char*) buffer , len + 2); // trailing unichar 0
+        memcpy(buf, m_text.utf8_str(), m_text.utf8_length());

     }
     }

-    else
+    else // wxDF_TEXT

     {
     {

-        wxCharBuffer buffer = wxConvLibc.cWX2MB( GetText().c_str() );
-        strcpy( (char*) buf, (const char*) buffer );
+        const wxCharBuffer bufLocal(wxConvLocal.cWC2MB(m_text.wc_str()));
+        if ( !bufLocal )
+            return false;
+
+        memcpy(buf, bufLocal, strlen(bufLocal));

     }
 
     return true;
 }
 
 bool wxTextDataObject::SetData(const wxDataFormat& format,
     }
 
     return true;
 }
 
 bool wxTextDataObject::SetData(const wxDataFormat& format,

-                               size_t WXUNUSED(len), const void *buf)
+                               size_t len, const void *buf_)

 {
 {

-    if (format == wxDF_UNICODETEXT)
+    const char * const buf = static_cast<const char *>(buf_);
+
+    if ( buf == NULL )
+        return false;
+
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )

     {
     {

-        // host native is UTF16
-        wxMBConvUTF16BE converter ;
-        SetText( converter.cMB2WX( (const char*) buf ) );
+        // normally the data is in UTF-8 so we could use FromUTF8Unchecked()
+        // but it's not absolutely clear what GTK+ does if the clipboard data
+        // is not in UTF-8 so do an extra check for tranquility, it shouldn't
+        // matter much if we lose a bit of performance when pasting from
+        // clipboard
+        m_text = wxString::FromUTF8(buf, len);
+    }
+    else // wxDF_TEXT, convert from current (non-UTF8) locale
+    {
+        m_text = wxConvLocal.cMB2WC(buf, len, NULL);

     }
     }

-    else
-        SetText( wxConvLibc.cMB2WX( (const char*) buf ) );

 
     return true;
 }
 
 
     return true;
 }
 

-#else
+#endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8

 
 

-size_t wxTextDataObject::GetDataSize() const
+#elif defined(wxNEEDS_UTF16_FOR_TEXT_DATAOBJ)
+
+namespace

 {
 {

-    return GetTextLength() * sizeof(wxChar);
+
+inline wxMBConv& GetConv(const wxDataFormat& format)
+{
+    static wxMBConvUTF16 s_UTF16Converter;
+
+    return format == wxDF_UNICODETEXT ? static_cast<wxMBConv&>(s_UTF16Converter)
+                                      : static_cast<wxMBConv&>(wxConvLocal);

 }
 
 }
 

-bool wxTextDataObject::GetDataHere(void *buf) const
+} // anonymous namespace
+
+size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const

 {
 {

-    wxStrcpy((wxChar *)buf, GetText().c_str());
+    return GetConv(format).WC2MB(NULL, GetText().wc_str(), 0);
+}
+
+bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
+{
+    if ( buf == NULL )
+        return false;
+
+    wxCharBuffer buffer(GetConv(format).cWX2MB(GetText().c_str()));
+
+    memcpy(buf, buffer.data(), buffer.length());

 
     return true;
 }
 
 
     return true;
 }
 

-bool wxTextDataObject::SetData(size_t WXUNUSED(len), const void *buf)
+bool wxTextDataObject::SetData(const wxDataFormat& format,
+                               size_t WXUNUSED(len),
+                               const void *buf)

 {
 {

-    SetText(wxString((const wxChar *)buf));
+    if ( buf == NULL )
+        return false;
+
+    SetText(GetConv(format).cMB2WX(static_cast<const char*>(buf)));

 
     return true;
 }
 
 
     return true;
 }
 

-#endif
+#else // !wxNEEDS_UTF{8,16}_FOR_TEXT_DATAOBJ

 
 

-// ----------------------------------------------------------------------------
-// wxFileDataObjectBase
-// ----------------------------------------------------------------------------
-
-// VZ: I don't need this in MSW finally, so if it is needed in wxGTK, it should
-//     be moved to gtk/dataobj.cpp
-#if 0
+size_t wxTextDataObject::GetDataSize() const
+{
+    return GetTextLength() * sizeof(wxChar);
+}

 
 

-wxString wxFileDataObjectBase::GetFilenames() const
+bool wxTextDataObject::GetDataHere(void *buf) const

 {
 {

-    wxString str;
-    size_t count = m_filenames.GetCount();
-    for ( size_t n = 0; n < count; n++ )
-    {
-        str << m_filenames[n] << wxT('\0');
-    }
+    // NOTE: use wxTmemcpy() instead of wxStrncpy() to allow
+    //       retrieval of strings with embedded NULLs
+    wxTmemcpy( (wxChar*)buf, GetText().c_str(), GetTextLength() );

 
 

-    return str;
+    return true;

 }
 
 }
 

-void wxFileDataObjectBase::SetFilenames(const wxChar* filenames)
+bool wxTextDataObject::SetData(size_t len, const void *buf)

 {
 {

-    m_filenames.Empty();
+    SetText( wxString((const wxChar*)buf, len/sizeof(wxChar)) );

 
 

-    wxString current;
-    for ( const wxChar *pc = filenames; ; pc++ )
-    {
-        if ( *pc )
-        {
-            current += *pc;
-        }
-        else
-        {
-            if ( !current )
-            {
-                // 2 consecutive NULs - this is the end of the string
-                break;
-            }
-
-            m_filenames.Add(current);
-            current.Empty();
-        }
-    }
+    return true;

 }
 
 }
 

-#endif // 0
+#endif // different wxTextDataObject implementations

 
 // ----------------------------------------------------------------------------
 // wxCustomDataObject
 
 // ----------------------------------------------------------------------------
 // wxCustomDataObject


@@ -402,7 +434,8 @@ void wxFileDataObjectBase::SetFilenames(const wxChar* filenames)
 wxCustomDataObject::wxCustomDataObject(const wxDataFormat& format)
     : wxDataObjectSimple(format)
 {
 wxCustomDataObject::wxCustomDataObject(const wxDataFormat& format)
     : wxDataObjectSimple(format)
 {

-    m_data = (void *)NULL;
+    m_data = NULL;
+    m_size = 0;

 }
 
 wxCustomDataObject::~wxCustomDataObject()
 }
 
 wxCustomDataObject::~wxCustomDataObject()


@@ -425,9 +458,9 @@ void *wxCustomDataObject::Alloc(size_t size)
 
 void wxCustomDataObject::Free()
 {
 
 void wxCustomDataObject::Free()
 {

-    delete [] (char *)m_data;
+    delete [] (char*)m_data;

     m_size = 0;
     m_size = 0;

-    m_data = (void *)NULL;
+    m_data = NULL;

 }
 
 size_t wxCustomDataObject::GetDataSize() const
 }
 
 size_t wxCustomDataObject::GetDataSize() const


@@ -437,11 +470,14 @@ size_t wxCustomDataObject::GetDataSize() const
 
 bool wxCustomDataObject::GetDataHere(void *buf) const
 {
 
 bool wxCustomDataObject::GetDataHere(void *buf) const
 {

+    if ( buf == NULL )
+        return false;
+

     void *data = GetData();
     void *data = GetData();

-    if ( !data )
+    if ( data == NULL )

         return false;
 
         return false;
 

-    memcpy(buf, data, GetSize());
+    memcpy( buf, data, GetSize() );

 
     return true;
 }
 
     return true;
 }


@@ -451,10 +487,11 @@ bool wxCustomDataObject::SetData(size_t size, const void *buf)
     Free();
 
     m_data = Alloc(size);
     Free();
 
     m_data = Alloc(size);

-    if ( !m_data )
+    if ( m_data == NULL )

         return false;
 
         return false;
 

-    memcpy(m_data, buf, m_size = size);
+    m_size = size;
+    memcpy( m_data, buf, m_size );

 
     return true;
 }
 
     return true;
 }


@@ -486,7 +523,7 @@ wxDragResult wxTextDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
         return wxDragNone;
 
     wxTextDataObject *dobj = (wxTextDataObject *)m_dataObject;
         return wxDragNone;
 
     wxTextDataObject *dobj = (wxTextDataObject *)m_dataObject;

-    return OnDropText(x, y, dobj->GetText()) ? def : wxDragNone;
+    return OnDropText( x, y, dobj->GetText() ) ? def : wxDragNone;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -504,7 +541,7 @@ wxDragResult wxFileDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
         return wxDragNone;
 
     wxFileDataObject *dobj = (wxFileDataObject *)m_dataObject;
         return wxDragNone;
 
     wxFileDataObject *dobj = (wxFileDataObject *)m_dataObject;

-    return OnDropFiles(x, y, dobj->GetFilenames()) ? def : wxDragNone;
+    return OnDropFiles( x, y, dobj->GetFilenames() ) ? def : wxDragNone;

 }
 
 #endif // wxUSE_DRAG_AND_DROP
 }
 
 #endif // wxUSE_DRAG_AND_DROP