src/common/dobjcmn.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/dobjcmn.cpp
   3 // Purpose:     implementation of data object methods common to all platforms
   4 // Author:      Vadim Zeitlin, Robert Roebling
   5 // Modified by:
   6 // Created:     19.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets Team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_DATAOBJ
  20
  21 #include "wx/dataobj.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/app.h"
  25 #endif
  26
  27 // ----------------------------------------------------------------------------
  28 // lists
  29 // ----------------------------------------------------------------------------
  30
  31 #include "wx/listimpl.cpp"
  32
  33 WX_DEFINE_LIST(wxSimpleDataObjectList)
  34
  35 // ----------------------------------------------------------------------------
  36 // globals
  37 // ----------------------------------------------------------------------------
  38
  39 static wxDataFormat dataFormatInvalid;
  40 WXDLLEXPORT const wxDataFormat& wxFormatInvalid = dataFormatInvalid;
  41
  42 // ============================================================================
  43 // implementation
  44 // ============================================================================
  45
  46 // ----------------------------------------------------------------------------
  47 // wxDataObjectBase
  48 // ----------------------------------------------------------------------------
  49
  50 wxDataObjectBase::~wxDataObjectBase()
  51 {
  52 }
  53
  54 bool wxDataObjectBase::IsSupported(const wxDataFormat& format,
  55                                    Direction dir) const
  56 {
  57     size_t nFormatCount = GetFormatCount( dir );
  58     if ( nFormatCount == 1 )
  59     {
  60         return format == GetPreferredFormat( dir );
  61     }
  62     else
  63     {
  64         wxDataFormat *formats = new wxDataFormat[nFormatCount];
  65         GetAllFormats( formats, dir );
  66
  67         size_t n;
  68         for ( n = 0; n < nFormatCount; n++ )
  69         {
  70             if ( formats[n] == format )
  71                 break;
  72         }
  73
  74         delete [] formats;
  75
  76         // found?
  77         return n < nFormatCount;
  78     }
  79 }
  80
  81 // ----------------------------------------------------------------------------
  82 // wxDataObjectComposite
  83 // ----------------------------------------------------------------------------
  84
  85 wxDataObjectComposite::wxDataObjectComposite()
  86 {
  87     m_preferred = 0;
  88     m_receivedFormat = wxFormatInvalid;
  89 }
  90
  91 wxDataObjectComposite::~wxDataObjectComposite()
  92 {
  93     WX_CLEAR_LIST( wxSimpleDataObjectList, m_dataObjects );
  94 }
  95
  96 wxDataObjectSimple *
  97 wxDataObjectComposite::GetObject(const wxDataFormat& format, wxDataObjectBase::Direction dir) const
  98 {
  99     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.GetFirst();
 100
 101     while ( node )
 102     {
 103         wxDataObjectSimple *dataObj = node->GetData();
 104
 105         if (dataObj->IsSupported(format,dir))
 106           return dataObj;
 107         node = node->GetNext();
 108     }
 109     return NULL;
 110 }
 111
 112 void wxDataObjectComposite::Add(wxDataObjectSimple *dataObject, bool preferred)
 113 {
 114     if ( preferred )
 115         m_preferred = m_dataObjects.GetCount();
 116
 117     m_dataObjects.Append( dataObject );
 118 }
 119
 120 wxDataFormat wxDataObjectComposite::GetReceivedFormat() const
 121 {
 122     return m_receivedFormat;
 123 }
 124
 125 wxDataFormat
 126 wxDataObjectComposite::GetPreferredFormat(Direction WXUNUSED(dir)) const
 127 {
 128     wxSimpleDataObjectList::compatibility_iterator node = m_dataObjects.Item( m_preferred );
 129
 130     wxCHECK_MSG( node, wxFormatInvalid, wxT("no preferred format") );
 131
 132     wxDataObjectSimple* dataObj = node->GetData();
 133
 134     return dataObj->GetFormat();
 135 }
 136
 137 #if defined(__WXMSW__)
 138
 139 size_t wxDataObjectComposite::GetBufferOffset( const wxDataFormat& format )
 140 {
 141     wxDataObjectSimple *dataObj = GetObject(format);
 142
 143     wxCHECK_MSG( dataObj, 0,
 144                  wxT("unsupported format in wxDataObjectComposite"));
 145
 146     return dataObj->GetBufferOffset( format );
 147 }
 148
 149
 150 const void* wxDataObjectComposite::GetSizeFromBuffer( const void* buffer,
 151                                                       size_t* size,
 152                                                       const wxDataFormat& format )
 153 {
 154     wxDataObjectSimple *dataObj = GetObject(format);
 155
 156     wxCHECK_MSG( dataObj, NULL,
 157                  wxT("unsupported format in wxDataObjectComposite"));
 158
 159     return dataObj->GetSizeFromBuffer( buffer, size, format );
 160 }
 161
 162
 163 void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
 164                                               const wxDataFormat& format )
 165 {
 166     wxDataObjectSimple *dataObj = GetObject( format );
 167
 168     wxCHECK_MSG( dataObj, NULL,
 169                  wxT("unsupported format in wxDataObjectComposite"));
 170
 171     return dataObj->SetSizeInBuffer( buffer, size, format );
 172 }
 173
 174 #endif
 175
 176 size_t wxDataObjectComposite::GetFormatCount(Direction dir) const
 177 {
 178     size_t n = 0;
 179
 180     // NOTE: some wxDataObjectSimple objects may return a number greater than 1
 181     //       from GetFormatCount(): this is the case of e.g. wxTextDataObject
 182     //       under wxMac and wxGTK
 183     wxSimpleDataObjectList::compatibility_iterator node;
 184     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
 185         n += node->GetData()->GetFormatCount(dir);
 186
 187     return n;
 188 }
 189
 190 void wxDataObjectComposite::GetAllFormats(wxDataFormat *formats,
 191                                           Direction dir) const
 192 {
 193     size_t index(0);
 194     wxSimpleDataObjectList::compatibility_iterator node;
 195
 196     for ( node = m_dataObjects.GetFirst(); node; node = node->GetNext() )
 197     {
 198         // NOTE: some wxDataObjectSimple objects may return more than 1 format
 199         //       from GetAllFormats(): this is the case of e.g. wxTextDataObject
 200         //       under wxMac and wxGTK
 201         node->GetData()->GetAllFormats(formats+index, dir);
 202         index += node->GetData()->GetFormatCount(dir);
 203     }
 204 }
 205
 206 size_t wxDataObjectComposite::GetDataSize(const wxDataFormat& format) const
 207 {
 208     wxDataObjectSimple *dataObj = GetObject(format);
 209
 210     wxCHECK_MSG( dataObj, 0,
 211                  wxT("unsupported format in wxDataObjectComposite"));
 212
 213     return dataObj->GetDataSize();
 214 }
 215
 216 bool wxDataObjectComposite::GetDataHere(const wxDataFormat& format,
 217                                         void *buf) const
 218 {
 219     wxDataObjectSimple *dataObj = GetObject( format );
 220
 221     wxCHECK_MSG( dataObj, false,
 222                  wxT("unsupported format in wxDataObjectComposite"));
 223
 224     return dataObj->GetDataHere( buf );
 225 }
 226
 227 bool wxDataObjectComposite::SetData(const wxDataFormat& format,
 228                                     size_t len,
 229                                     const void *buf)
 230 {
 231     wxDataObjectSimple *dataObj = GetObject( format );
 232
 233     wxCHECK_MSG( dataObj, false,
 234                  wxT("unsupported format in wxDataObjectComposite"));
 235
 236     m_receivedFormat = format;
 237
 238     // Notice that we must pass "format" here as wxTextDataObject, that we can
 239     // have as one of our "simple" sub-objects actually is not that simple and
 240     // can support multiple formats (ASCII/UTF-8/UTF-16/...) and so needs to
 241     // know which one it is given.
 242     return dataObj->SetData( format, len, buf );
 243 }
 244
 245 // ----------------------------------------------------------------------------
 246 // wxTextDataObject
 247 // ----------------------------------------------------------------------------
 248
 249 #ifdef wxNEEDS_UTF8_FOR_TEXT_DATAOBJ
 250
 251 // FIXME-UTF8: we should be able to merge wchar_t and UTF-8 versions once we
 252 //             have a way to get UTF-8 string (and its length) in both builds
 253 //             without loss of efficiency (i.e. extra buffer copy/strlen call)
 254
 255 #if wxUSE_UNICODE_WCHAR
 256
 257 static inline wxMBConv& GetConv(const wxDataFormat& format)
 258 {
 259     // use UTF8 for wxDF_UNICODETEXT and UCS4 for wxDF_TEXT
 260     return format == wxDF_UNICODETEXT ? wxConvUTF8 : wxConvLibc;
 261 }
 262
 263 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 264 {
 265     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
 266
 267     return buffer ? strlen( buffer ) : 0;
 268 }
 269
 270 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 271 {
 272     if ( !buf )
 273         return false;
 274
 275     wxCharBuffer buffer = GetConv(format).cWX2MB( GetText().c_str() );
 276     if ( !buffer )
 277         return false;
 278
 279     memcpy( (char*) buf, buffer, GetDataSize(format) );
 280     // strcpy( (char*) buf, buffer );
 281
 282     return true;
 283 }
 284
 285 bool wxTextDataObject::SetData(const wxDataFormat& format,
 286                                size_t WXUNUSED(len), const void *buf)
 287 {
 288     if ( buf == NULL )
 289         return false;
 290
 291     wxWCharBuffer buffer = GetConv(format).cMB2WX( (const char*)buf );
 292
 293     SetText( buffer );
 294
 295     return true;
 296 }
 297
 298 #else // wxUSE_UNICODE_UTF8
 299
 300 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 301 {
 302     if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
 303     {
 304         return m_text.utf8_length();
 305     }
 306     else // wxDF_TEXT
 307     {
 308         const wxCharBuffer buf(wxConvLocal.cWC2MB(m_text.wc_str()));
 309         return buf ? strlen(buf) : 0;
 310     }
 311 }
 312
 313 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 314 {
 315     if ( !buf )
 316         return false;
 317
 318     if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
 319     {
 320         memcpy(buf, m_text.utf8_str(), m_text.utf8_length());
 321     }
 322     else // wxDF_TEXT
 323     {
 324         const wxCharBuffer bufLocal(wxConvLocal.cWC2MB(m_text.wc_str()));
 325         if ( !bufLocal )
 326             return false;
 327
 328         memcpy(buf, bufLocal, strlen(bufLocal));
 329     }
 330
 331     return true;
 332 }
 333
 334 bool wxTextDataObject::SetData(const wxDataFormat& format,
 335                                size_t len, const void *buf_)
 336 {
 337     const char * const buf = static_cast<const char *>(buf_);
 338
 339     if ( buf == NULL )
 340         return false;
 341
 342     if ( format == wxDF_UNICODETEXT || wxLocaleIsUtf8 )
 343     {
 344         // normally the data is in UTF-8 so we could use FromUTF8Unchecked()
 345         // but it's not absolutely clear what GTK+ does if the clipboard data
 346         // is not in UTF-8 so do an extra check for tranquility, it shouldn't
 347         // matter much if we lose a bit of performance when pasting from
 348         // clipboard
 349         m_text = wxString::FromUTF8(buf, len);
 350     }
 351     else // wxDF_TEXT, convert from current (non-UTF8) locale
 352     {
 353         m_text = wxConvLocal.cMB2WC(buf, len, NULL);
 354     }
 355
 356     return true;
 357 }
 358
 359 #endif // wxUSE_UNICODE_WCHAR/wxUSE_UNICODE_UTF8
 360
 361 #elif defined(wxNEEDS_UTF16_FOR_TEXT_DATAOBJ)
 362
 363 namespace
 364 {
 365
 366 inline wxMBConv& GetConv(const wxDataFormat& format)
 367 {
 368     static wxMBConvUTF16 s_UTF16Converter;
 369
 370     return format == wxDF_UNICODETEXT ? static_cast<wxMBConv&>(s_UTF16Converter)
 371                                       : static_cast<wxMBConv&>(wxConvLocal);
 372 }
 373
 374 } // anonymous namespace
 375
 376 size_t wxTextDataObject::GetDataSize(const wxDataFormat& format) const
 377 {
 378     return GetConv(format).WC2MB(NULL, GetText().wc_str(), 0);
 379 }
 380
 381 bool wxTextDataObject::GetDataHere(const wxDataFormat& format, void *buf) const
 382 {
 383     if ( buf == NULL )
 384         return false;
 385
 386     wxCharBuffer buffer(GetConv(format).cWX2MB(GetText().c_str()));
 387
 388     memcpy(buf, buffer.data(), buffer.length());
 389
 390     return true;
 391 }
 392
 393 bool wxTextDataObject::SetData(const wxDataFormat& format,
 394                                size_t WXUNUSED(len),
 395                                const void *buf)
 396 {
 397     if ( buf == NULL )
 398         return false;
 399
 400     SetText(GetConv(format).cMB2WX(static_cast<const char*>(buf)));
 401
 402     return true;
 403 }
 404
 405 #else // !wxNEEDS_UTF{8,16}_FOR_TEXT_DATAOBJ
 406
 407 size_t wxTextDataObject::GetDataSize() const
 408 {
 409     return GetTextLength() * sizeof(wxChar);
 410 }
 411
 412 bool wxTextDataObject::GetDataHere(void *buf) const
 413 {
 414     // NOTE: use wxTmemcpy() instead of wxStrncpy() to allow
 415     //       retrieval of strings with embedded NULLs
 416     wxTmemcpy( (wxChar*)buf, GetText().c_str(), GetTextLength() );
 417
 418     return true;
 419 }
 420
 421 bool wxTextDataObject::SetData(size_t len, const void *buf)
 422 {
 423     SetText( wxString((const wxChar*)buf, len/sizeof(wxChar)) );
 424
 425     return true;
 426 }
 427
 428 #endif // different wxTextDataObject implementations
 429
 430 size_t wxHTMLDataObject::GetDataSize() const
 431 {
 432     size_t size = 0;
 433     // Windows and Mac always use UTF-8, and docs suggest GTK does as well.
 434     wxCharBuffer buffer =  wxConvUTF8.cWX2MB( GetHTML().c_str() );
 435
 436     if (buffer)
 437     {
 438         size = strlen( buffer );
 439 #ifdef __WXMSW__
 440         // On Windows we need to add some stuff to the string to satisfy
 441         // its clipboard format requirements.
 442         size += 400;
 443 #endif
 444     }
 445
 446     return size;
 447 }
 448
 449 bool wxHTMLDataObject::GetDataHere(void *buf) const
 450 {
 451     if ( !buf )
 452         return false;
 453
 454     // Windows and Mac always use UTF-8, and docs suggest GTK does as well.
 455     wxCharBuffer html =  wxConvUTF8.cWX2MB( GetHTML().c_str() );
 456     if ( !html )
 457         return false;
 458
 459     size_t bytes = GetDataSize();
 460 #ifdef __WXMSW__
 461     // add the extra info that the MSW clipboard format requires.
 462     char* buffer = new char[bytes];
 463
 464         // Create a template string for the HTML header...
 465     strcpy(buffer,
 466         "Version:0.9\r\n"
 467         "StartHTML:00000000\r\n"
 468         "EndHTML:00000000\r\n"
 469         "StartFragment:00000000\r\n"
 470         "EndFragment:00000000\r\n"
 471         "<html><body>\r\n"
 472         "<!--StartFragment -->\r\n");
 473
 474     // Append the HTML...
 475     strcat(buffer, html);
 476     strcat(buffer, "\r\n");
 477     // Finish up the HTML format...
 478     strcat(buffer,
 479         "<!--EndFragment-->\r\n"
 480         "</body>\r\n"
 481         "</html>");
 482
 483     // Now go back, calculate all the lengths, and write out the
 484     // necessary header information. Note, wsprintf() truncates the
 485     // string when you overwrite it so you follow up with code to replace
 486     // the 0 appended at the end with a '\r'...
 487     char *ptr = strstr(buffer, "StartHTML");
 488     sprintf(ptr+10, "%08u", (unsigned)(strstr(buffer, "<html>") - buffer));
 489     *(ptr+10+8) = '\r';
 490
 491     ptr = strstr(buffer, "EndHTML");
 492     sprintf(ptr+8, "%08u", (unsigned)strlen(buffer));
 493     *(ptr+8+8) = '\r';
 494
 495     ptr = strstr(buffer, "StartFragment");
 496     sprintf(ptr+14, "%08u", (unsigned)(strstr(buffer, "<!--StartFrag") - buffer));
 497     *(ptr+14+8) = '\r';
 498
 499     ptr = strstr(buffer, "EndFragment");
 500     sprintf(ptr+12, "%08u", (unsigned)(strstr(buffer, "<!--EndFrag") - buffer));
 501     *(ptr+12+8) = '\r';
 502 #else
 503     wxCharBuffer buffer = html;
 504 #endif // __WXMSW__
 505
 506     memcpy( (char*) buf, buffer, bytes );
 507
 508     return true;
 509 }
 510
 511 bool wxHTMLDataObject::SetData(size_t WXUNUSED(len), const void *buf)
 512 {
 513     if ( buf == NULL )
 514         return false;
 515
 516     // Windows and Mac always use UTF-8, and docs suggest GTK does as well.
 517     wxWCharBuffer buffer =  wxConvUTF8.cMB2WX( (const char*)buf );
 518
 519     wxString html(buffer);
 520     // To be consistent with other platforms, we only add the Fragment part
 521     // of the Windows HTML clipboard format to the data object.
 522 #ifdef __WXMSW__
 523     int fragmentStart = html.rfind("StartFragment");
 524     int fragmentEnd = html.rfind("EndFragment");
 525
 526     if (fragmentStart != wxNOT_FOUND && fragmentEnd != wxNOT_FOUND)
 527     {
 528         int startCommentEnd = html.find("-->", fragmentStart) + 3;
 529         int endCommentStart = html.rfind("<!--", fragmentEnd);
 530
 531         if (startCommentEnd != wxNOT_FOUND && endCommentStart != wxNOT_FOUND)
 532             html = html.Mid(startCommentEnd, endCommentStart - startCommentEnd);
 533     }
 534 #endif
 535     SetHTML( html );
 536
 537     return true;
 538 }
 539
 540
 541 // ----------------------------------------------------------------------------
 542 // wxCustomDataObject
 543 // ----------------------------------------------------------------------------
 544
 545 wxCustomDataObject::wxCustomDataObject(const wxDataFormat& format)
 546     : wxDataObjectSimple(format)
 547 {
 548     m_data = NULL;
 549     m_size = 0;
 550 }
 551
 552 wxCustomDataObject::~wxCustomDataObject()
 553 {
 554     Free();
 555 }
 556
 557 void wxCustomDataObject::TakeData(size_t size, void *data)
 558 {
 559     Free();
 560
 561     m_size = size;
 562     m_data = data;
 563 }
 564
 565 void *wxCustomDataObject::Alloc(size_t size)
 566 {
 567     return (void *)new char[size];
 568 }
 569
 570 void wxCustomDataObject::Free()
 571 {
 572     delete [] (char*)m_data;
 573     m_size = 0;
 574     m_data = NULL;
 575 }
 576
 577 size_t wxCustomDataObject::GetDataSize() const
 578 {
 579     return GetSize();
 580 }
 581
 582 bool wxCustomDataObject::GetDataHere(void *buf) const
 583 {
 584     if ( buf == NULL )
 585         return false;
 586
 587     void *data = GetData();
 588     if ( data == NULL )
 589         return false;
 590
 591     memcpy( buf, data, GetSize() );
 592
 593     return true;
 594 }
 595
 596 bool wxCustomDataObject::SetData(size_t size, const void *buf)
 597 {
 598     Free();
 599
 600     m_data = Alloc(size);
 601     if ( m_data == NULL )
 602         return false;
 603
 604     m_size = size;
 605     memcpy( m_data, buf, m_size );
 606
 607     return true;
 608 }
 609
 610 // ============================================================================
 611 // some common dnd related code
 612 // ============================================================================
 613
 614 #if wxUSE_DRAG_AND_DROP
 615
 616 #include "wx/dnd.h"
 617
 618 // ----------------------------------------------------------------------------
 619 // wxTextDropTarget
 620 // ----------------------------------------------------------------------------
 621
 622 // NB: we can't use "new" in ctor initializer lists because this provokes an
 623 //     internal compiler error with VC++ 5.0 (hey, even gcc compiles this!),
 624 //     so use SetDataObject() instead
 625
 626 wxTextDropTarget::wxTextDropTarget()
 627 {
 628     SetDataObject(new wxTextDataObject);
 629 }
 630
 631 wxDragResult wxTextDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
 632 {
 633     if ( !GetData() )
 634         return wxDragNone;
 635
 636     wxTextDataObject *dobj = (wxTextDataObject *)m_dataObject;
 637     return OnDropText( x, y, dobj->GetText() ) ? def : wxDragNone;
 638 }
 639
 640 // ----------------------------------------------------------------------------
 641 // wxFileDropTarget
 642 // ----------------------------------------------------------------------------
 643
 644 wxFileDropTarget::wxFileDropTarget()
 645 {
 646     SetDataObject(new wxFileDataObject);
 647 }
 648
 649 wxDragResult wxFileDropTarget::OnData(wxCoord x, wxCoord y, wxDragResult def)
 650 {
 651     if ( !GetData() )
 652         return wxDragNone;
 653
 654     wxFileDataObject *dobj = (wxFileDataObject *)m_dataObject;
 655     return OnDropFiles( x, y, dobj->GetFilenames() ) ? def : wxDragNone;
 656 }
 657
 658 #endif // wxUSE_DRAG_AND_DROP
 659
 660 #endif // wxUSE_DATAOBJ