suppress (harmless) unused parameter warnings

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

diff --git a/src/common/dobjcmn.cpp b/src/common/dobjcmn.cpp
index 95cfb73bce2ab6d824f434433cd95687f3eecbc2..d9327709c5bd5b8447cc9e15d0f5f59d3bc7d4ee 100644 (file)
--- a/src/common/dobjcmn.cpp
+++ b/src/common/dobjcmn.cpp
@@ -1,53 +1,43 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// 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:
 // Created:     19.10.99
 // RCS-ID:      $Id$
 // Purpose:     implementation of data object methods common to all platforms
 // Author:      Vadim Zeitlin, Robert Roebling
 // Modified by:
 // Created:     19.10.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows Team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets Team
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-
-#ifdef __GNUG__
-    #pragma implementation "dataobjbase.h"
-#endif
-
+// For compilers that support precompilation, includes "wx.h".

 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 

-#ifndef WX_PRECOMP
-    #include "wx/app.h"
-    #include "wx/debug.h"
-#endif // WX_PRECOMP
+#if wxUSE_DATAOBJ

 
 #include "wx/dataobj.h"
 
 
 #include "wx/dataobj.h"
 

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

 // ----------------------------------------------------------------------------
 // lists
 // ----------------------------------------------------------------------------
 
 #include "wx/listimpl.cpp"
 
 // ----------------------------------------------------------------------------
 // lists
 // ----------------------------------------------------------------------------
 
 #include "wx/listimpl.cpp"
 

-WX_DEFINE_LIST(wxSimpleDataObjectList);
+WX_DEFINE_LIST(wxSimpleDataObjectList)

 
 // ----------------------------------------------------------------------------
 // globals
 // ----------------------------------------------------------------------------
 
 static wxDataFormat dataFormatInvalid;
 
 // ----------------------------------------------------------------------------
 // globals
 // ----------------------------------------------------------------------------
 
 static wxDataFormat dataFormatInvalid;

-const wxDataFormat& wxFormatInvalid = dataFormatInvalid;
+WXDLLEXPORT const wxDataFormat& wxFormatInvalid = dataFormatInvalid;

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -61,14 +51,52 @@ wxDataObjectBase::~wxDataObjectBase()
 {
 }
 
 {
 }
 

+bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
+                                   Direction dir) const
+{
+    size_t nFormatCount = GetFormatCount( dir );
+    if ( nFormatCount == 1 )
+    {
+        return format == GetPreferredFormat( dir );
+    }
+    else
+    {
+        wxDataFormat *formats = new wxDataFormat[nFormatCount];
+        GetAllFormats( formats, dir );
+
+        size_t n;
+        for ( n = 0; n < nFormatCount; n++ )
+        {
+            if ( formats[n] == format )
+                break;
+        }
+
+        delete [] formats;
+
+        // found?
+        return n < nFormatCount;
+    }
+}
+

 // ----------------------------------------------------------------------------
 // wxDataObjectComposite
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxDataObjectComposite
 // ----------------------------------------------------------------------------
 

+wxDataObjectComposite::wxDataObjectComposite()
+{
+    m_preferred = 0;
+    m_receivedFormat = wxFormatInvalid;
+}
+
+wxDataObjectComposite::~wxDataObjectComposite()
+{
+    WX_CLEAR_LIST( wxSimpleDataObjectList, m_dataObjects );
+}
+

 wxDataObjectSimple *
 wxDataObjectComposite::GetObject(const wxDataFormat& format) const
 {
 wxDataObjectSimple *
 wxDataObjectComposite::GetObject(const wxDataFormat& format) const
 {

-    wxSimpleDataObjectList::Node *node = m_dataObjects.GetFirst();
+    wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();

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


@@ -92,10 +120,15 @@ 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
 {

-    wxSimpleDataObjectList::Node *node = m_dataObjects.Item( m_preferred );
+    wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.Item( m_preferred );

 
     wxCHECK_MSG( node, wxFormatInvalid, wxT("no preferred format") );
 
 
     wxCHECK_MSG( node, wxFormatInvalid, wxT("no preferred format") );
 


@@ -104,6 +137,45 @@ wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
     return dataObj->GetFormat();
 }
 
     return dataObj->GetFormat();
 }
 

+#if defined(__WXMSW__)
+
+size_t wxDataObjectComposite::GetBufferOffset( const wxDataFormat& format )
+{
+    wxDataObjectSimple *dataObj = GetObject(format);
+
+    wxCHECK_MSG( dataObj, 0,
+                 wxT("unsupported format in wxDataObjectComposite"));
+
+    return dataObj->GetBufferOffset( format );
+}
+
+
+const void* wxDataObjectComposite::GetSizeFromBuffer( const void* buffer,
+                                                      size_t* size,
+                                                      const wxDataFormat& format )
+{
+    wxDataObjectSimple *dataObj = GetObject(format);
+
+    wxCHECK_MSG( dataObj, NULL,
+                 wxT("unsupported format in wxDataObjectComposite"));
+
+    return dataObj->GetSizeFromBuffer( buffer, size, format );
+}
+
+
+void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
+                                              const wxDataFormat& format )
+{
+    wxDataObjectSimple *dataObj = GetObject( format );
+
+    wxCHECK_MSG( dataObj, NULL,
+                 wxT("unsupported format in wxDataObjectComposite"));
+
+    return dataObj->SetSizeInBuffer( buffer, size, format );
+}
+
+#endif
+

 size_t wxDataObjectComposite::GetFormatCount(Direction WXUNUSED(dir)) const
 {
     // TODO what about the Get/Set only formats?
 size_t wxDataObjectComposite::GetFormatCount(Direction WXUNUSED(dir)) const
 {
     // TODO what about the Get/Set only formats?


@@ -114,7 +186,7 @@ void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,
                                           Direction WXUNUSED(dir)) const
 {
     size_t n = 0;
                                           Direction WXUNUSED(dir)) const
 {
     size_t n = 0;

-    wxSimpleDataObjectList::Node *node;
+    wxSimpleDataObjectList::compatibility_iterator node;

     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {
         // TODO if ( !outputOnlyToo ) && this one counts ...
     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
     {
         // TODO if ( !outputOnlyToo ) && this one counts ...


@@ -135,95 +207,214 @@ 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,
+    wxCHECK_MSG( dataObj, false,

                  wxT("unsupported format in wxDataObjectComposite"));
 
                  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,
+    wxCHECK_MSG( dataObj, false,

                  wxT("unsupported format in wxDataObjectComposite"));
 
                  wxT("unsupported format in wxDataObjectComposite"));
 

-    return dataObj->SetData(len, buf);
+    m_receivedFormat = format;
+    return dataObj->SetData( len, buf );

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

-size_t wxTextDataObject::GetDataSize() const
+#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)

 {
 {

-    return GetTextLength();
+    // use UTF8 for wxDF_UNICODETEXT and UCS4 for wxDF_TEXT
+    return format == wxDF_UNICODETEXT ? wxConvUTF8 : wxConvLibc;

 }
 
 }
 

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

 {
 {

-    strcpy((char *)buf, GetText().mb_str());
+    wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );

 
 

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

 }
 
 }
 

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

 {
 {

-    SetText(wxString((const char *)buf));
+    if ( !buf )
+        return false;

 
 

-    return TRUE;
+    wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
+    if ( !buffer )
+        return false;
+
+    memcpy( (char*) buf, buffer, GetDataSize(format) );
+    // strcpy( (char*) buf, buffer );
+
+    return true;

 }
 
 }
 

-// ----------------------------------------------------------------------------
-// wxFileDataObjectBase
-// ----------------------------------------------------------------------------
+bool wxTextDataObject::SetData(const wxDataFormat& format,
+                               size_t WXUNUSED(len), const void *buf)
+{
+    if ( buf == NULL )
+        return false;

 
 

-// 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
+    wxWCharBuffer buffer = GetConv(format).cMB2WX( (const char*)buf );

 
 

-wxString wxFileDataObjectBase::GetFilenames() const
+    SetText( buffer );
+
+    return true;
+}
+
+#else // wxUSE_UNICODE_UTF8
+
+size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const

 {
 {

-    wxString str;
-    size_t count = m_filenames.GetCount();
-    for ( size_t n = 0; n < count; n++ )
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )

     {
     {

-        str << m_filenames[n] << wxT('\0');
+        return m_text.utf8_length();
+    }
+    else // wxDF_TEXT
+    {
+        const wxCharBuffer buf(wxConvLocal.cWC2MB(m_text.wc_str()));
+        return buf ? strlen(buf) : 0;

     }
     }

-
-    return str;

 }
 
 }
 

-void wxFileDataObjectBase::SetFilenames(const wxChar* filenames)
+bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const

 {
 {

-    m_filenames.Empty();
+    if ( !buf )
+        return false;

 
 

-    wxString current;
-    for ( const wxChar *pc = filenames; ; pc++ )
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )

     {
     {

-        if ( *pc )
-        {
-            current += *pc;
-        }
-        else
-        {
-            if ( !current )
-            {
-                // 2 consecutive NULs - this is the end of the string
-                break;
-            }
+        memcpy(buf, m_text.utf8_str(), m_text.utf8_length());
+    }
+    else // wxDF_TEXT
+    {
+        const wxCharBuffer bufLocal(wxConvLocal.cWC2MB(m_text.wc_str()));
+        if ( !bufLocal )
+            return false;

 
 

-            m_filenames.Add(current);
-            current.Empty();
-        }
+        memcpy(buf, bufLocal, strlen(bufLocal));

     }
     }

+
+    return true;
+}
+
+bool wxTextDataObject::SetData(const wxDataFormat& format,
+                               size_t len, const void *buf_)
+{
+    const char * const buf = static_cast<const char *>(buf_);
+
+    if ( buf == NULL )
+        return false;
+
+    if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
+    {
+        // 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);
+    }
+
+    return true;
+}
+
+#endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8
+
+#elif defined(wxNEEDS_UTF16_FOR_TEXT_DATAOBJ)
+
+static wxMBConvUTF16 sUTF16Converter;
+
+static inline wxMBConv& GetConv(const wxDataFormat& format)
+{
+    return
+        format == wxDF_UNICODETEXT
+        ? (wxMBConv&) sUTF16Converter
+        : (wxMBConv&) wxConvLocal;
+}
+
+size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
+{
+    size_t len = GetConv(format).WC2MB( NULL, GetText().c_str(), 0 );
+    len += (format == wxDF_UNICODETEXT ? 2 : 1);
+
+    return len;
+}
+
+bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
+{
+    if ( buf == NULL )
+        return false;
+
+    wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
+
+    size_t len = GetConv(format).WC2MB( NULL, GetText().c_str(), 0 );
+    len += (format == wxDF_UNICODETEXT ? 2 : 1);
+
+    // trailing (uni)char 0
+    memcpy( (char*)buf, (const char*)buffer, len );
+
+    return true;
+}
+
+bool wxTextDataObject::SetData(const wxDataFormat& format,
+                               size_t WXUNUSED(len), const void *buf)
+{
+    if ( buf == NULL )
+        return false;
+
+    wxWCharBuffer buffer = GetConv(format).cMB2WX( (const char*)buf );
+
+    SetText( buffer );
+
+    return true;
+}
+
+#else // !wxNEEDS_UTF{8,16}_FOR_TEXT_DATAOBJ
+
+size_t wxTextDataObject::GetDataSize() const
+{
+    return GetTextLength() * sizeof(wxChar);
+}
+
+bool wxTextDataObject::GetDataHere(void *buf) const
+{
+    wxStrcpy( (wxChar*)buf, GetText().c_str() );
+
+    return true;
+}
+
+bool wxTextDataObject::SetData(size_t WXUNUSED(len), const void *buf)
+{
+    SetText( wxString((const wxChar*)buf) );
+
+    return true;

 }
 
 }
 

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

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


@@ -232,9 +423,10 @@ void wxFileDataObjectBase::SetFilenames(const wxChar* filenames)
 wxCustomDataObject::wxCustomDataObject(const wxDataFormat& format)
     : wxDataObjectSimple(format)
 {
 wxCustomDataObject::wxCustomDataObject(const wxDataFormat& format)
     : wxDataObjectSimple(format)
 {

+    m_data = NULL;
+    m_size = 0;

 }
 
 }
 

-

 wxCustomDataObject::~wxCustomDataObject()
 {
     Free();
 wxCustomDataObject::~wxCustomDataObject()
 {
     Free();


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

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

     m_size = 0;
     m_size = 0;

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

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


@@ -267,13 +459,16 @@ 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 )
-        return FALSE;
+    if ( data == NULL )
+        return false;

 
 

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

 
 

-    return TRUE;
+    return true;

 }
 
 bool wxCustomDataObject::SetData(size_t size, const void *buf)
 }
 
 bool wxCustomDataObject::SetData(size_t size, const void *buf)


@@ -281,11 +476,63 @@ bool wxCustomDataObject::SetData(size_t size, const void *buf)
     Free();
 
     m_data = Alloc(size);
     Free();
 
     m_data = Alloc(size);

-    if ( !m_data )
-        return FALSE;
+    if ( m_data == NULL )
+        return false;
+
+    m_size = size;
+    memcpy( m_data, buf, m_size );
+
+    return true;
+}
+
+// ============================================================================
+// some common dnd related code
+// ============================================================================

 
 

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

 
 

-    return TRUE;
+#include "wx/dnd.h"
+
+// ----------------------------------------------------------------------------
+// wxTextDropTarget
+// ----------------------------------------------------------------------------
+
+// NB: we can't use "new" in ctor initializer lists because this provokes an
+//     internal compiler error with VC++ 5.0 (hey, even gcc compiles this!),
+//     so use SetDataObject() instead
+
+wxTextDropTarget::wxTextDropTarget()
+{
+    SetDataObject(new wxTextDataObject);

 }
 
 }
 

+wxDragResult wxTextDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
+{
+    if ( !GetData() )
+        return wxDragNone;
+
+    wxTextDataObject *dobj = (wxTextDataObject *)m_dataObject;
+    return OnDropText( x, y, dobj->GetText() ) ? def : wxDragNone;
+}
+
+// ----------------------------------------------------------------------------
+// wxFileDropTarget
+// ----------------------------------------------------------------------------
+
+wxFileDropTarget::wxFileDropTarget()
+{
+    SetDataObject(new wxFileDataObject);
+}
+
+wxDragResult wxFileDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
+{
+    if ( !GetData() )
+        return wxDragNone;
+
+    wxFileDataObject *dobj = (wxFileDataObject *)m_dataObject;
+    return OnDropFiles( x, y, dobj->GetFilenames() ) ? def : wxDragNone;
+}
+
+#endif // wxUSE_DRAG_AND_DROP
+
+#endif // wxUSE_DATAOBJ