src/msw/ole/dataobj.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/ole/dataobj.cpp
   3 // Purpose:     implementation of wx[I]DataObject class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     10.05.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "dataobj.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #if defined(__BORLANDC__)
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/intl.h"
  33     #include "wx/log.h"
  34 #endif
  35
  36 #include "wx/dataobj.h"
  37
  38 #if wxUSE_OLE && defined(__WIN32__) && !defined(__GNUWIN32_OLD__)
  39
  40 #include "wx/msw/private.h"         // includes <windows.h>
  41
  42 // for some compilers, the entire ole2.h must be included, not only oleauto.h
  43 #if wxUSE_NORLANDER_HEADERS || defined(__WATCOMC__)
  44   #include <ole2.h>
  45 #endif
  46
  47 #include <oleauto.h>
  48 #include <shlobj.h>
  49
  50 #include "wx/msw/ole/oleutils.h"
  51
  52 #include "wx/msw/dib.h"
  53
  54 #ifndef CFSTR_SHELLURL
  55 #define CFSTR_SHELLURL _T("UniformResourceLocator")
  56 #endif
  57
  58 // ----------------------------------------------------------------------------
  59 // functions
  60 // ----------------------------------------------------------------------------
  61
  62 #ifdef __WXDEBUG__
  63     static const wxChar *GetTymedName(DWORD tymed);
  64 #else // !Debug
  65     #define GetTymedName(tymed) _T("")
  66 #endif // Debug/!Debug
  67
  68 // ----------------------------------------------------------------------------
  69 // wxIEnumFORMATETC interface implementation
  70 // ----------------------------------------------------------------------------
  71
  72 class wxIEnumFORMATETC : public IEnumFORMATETC
  73 {
  74 public:
  75     wxIEnumFORMATETC(const wxDataFormat* formats, ULONG nCount);
  76     virtual ~wxIEnumFORMATETC() { delete [] m_formats; }
  77
  78     DECLARE_IUNKNOWN_METHODS;
  79
  80     // IEnumFORMATETC
  81     STDMETHODIMP Next(ULONG celt, FORMATETC *rgelt, ULONG *pceltFetched);
  82     STDMETHODIMP Skip(ULONG celt);
  83     STDMETHODIMP Reset();
  84     STDMETHODIMP Clone(IEnumFORMATETC **ppenum);
  85
  86 private:
  87     CLIPFORMAT *m_formats;  // formats we can provide data in
  88     ULONG       m_nCount,   // number of formats we support
  89                 m_nCurrent; // current enum position
  90
  91     DECLARE_NO_COPY_CLASS(wxIEnumFORMATETC)
  92 };
  93
  94 // ----------------------------------------------------------------------------
  95 // wxIDataObject implementation of IDataObject interface
  96 // ----------------------------------------------------------------------------
  97
  98 class wxIDataObject : public IDataObject
  99 {
 100 public:
 101     wxIDataObject(wxDataObject *pDataObject);
 102     virtual ~wxIDataObject();
 103
 104     // normally, wxDataObject controls our lifetime (i.e. we're deleted when it
 105     // is), but in some cases, the situation is inversed, that is we delete it
 106     // when this object is deleted - setting this flag enables such logic
 107     void SetDeleteFlag() { m_mustDelete = TRUE; }
 108
 109     DECLARE_IUNKNOWN_METHODS;
 110
 111     // IDataObject
 112     STDMETHODIMP GetData(FORMATETC *pformatetcIn, STGMEDIUM *pmedium);
 113     STDMETHODIMP GetDataHere(FORMATETC *pformatetc, STGMEDIUM *pmedium);
 114     STDMETHODIMP QueryGetData(FORMATETC *pformatetc);
 115     STDMETHODIMP GetCanonicalFormatEtc(FORMATETC *In, FORMATETC *pOut);
 116     STDMETHODIMP SetData(FORMATETC *pfetc, STGMEDIUM *pmedium, BOOL fRelease);
 117     STDMETHODIMP EnumFormatEtc(DWORD dwDirection, IEnumFORMATETC **ppenumFEtc);
 118     STDMETHODIMP DAdvise(FORMATETC *pfetc, DWORD ad, IAdviseSink *p, DWORD *pdw);
 119     STDMETHODIMP DUnadvise(DWORD dwConnection);
 120     STDMETHODIMP EnumDAdvise(IEnumSTATDATA **ppenumAdvise);
 121
 122 private:
 123     wxDataObject *m_pDataObject;      // pointer to C++ class we belong to
 124
 125     bool m_mustDelete;
 126
 127     DECLARE_NO_COPY_CLASS(wxIDataObject)
 128 };
 129
 130 // ============================================================================
 131 // implementation
 132 // ============================================================================
 133
 134 // ----------------------------------------------------------------------------
 135 // wxDataFormat
 136 // ----------------------------------------------------------------------------
 137
 138 void wxDataFormat::SetId(const wxChar *format)
 139 {
 140     m_format = (wxDataFormat::NativeFormat)::RegisterClipboardFormat(format);
 141     if ( !m_format )
 142     {
 143         wxLogError(_("Couldn't register clipboard format '%s'."), format);
 144     }
 145 }
 146
 147 wxString wxDataFormat::GetId() const
 148 {
 149     static const int max = 256;
 150
 151     wxString s;
 152
 153     wxCHECK_MSG( !IsStandard(), s,
 154                  wxT("name of predefined format cannot be retrieved") );
 155
 156     int len = ::GetClipboardFormatName(m_format, s.GetWriteBuf(max), max);
 157     s.UngetWriteBuf();
 158
 159     if ( !len )
 160     {
 161         wxLogError(_("The clipboard format '%d' doesn't exist."), m_format);
 162     }
 163
 164     return s;
 165 }
 166
 167 // ----------------------------------------------------------------------------
 168 // wxIEnumFORMATETC
 169 // ----------------------------------------------------------------------------
 170
 171 BEGIN_IID_TABLE(wxIEnumFORMATETC)
 172     ADD_IID(Unknown)
 173     ADD_IID(EnumFORMATETC)
 174 END_IID_TABLE;
 175
 176 IMPLEMENT_IUNKNOWN_METHODS(wxIEnumFORMATETC)
 177
 178 wxIEnumFORMATETC::wxIEnumFORMATETC(const wxDataFormat *formats, ULONG nCount)
 179 {
 180     m_nCurrent = 0;
 181     m_nCount = nCount;
 182     m_formats = new CLIPFORMAT[nCount];
 183     for ( ULONG n = 0; n < nCount; n++ ) {
 184         m_formats[n] = formats[n].GetFormatId();
 185     }
 186 }
 187
 188 STDMETHODIMP wxIEnumFORMATETC::Next(ULONG      celt,
 189                                     FORMATETC *rgelt,
 190                                     ULONG     *WXUNUSED(pceltFetched))
 191 {
 192     wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Next"));
 193
 194     if ( celt > 1 ) {
 195         // we only return 1 element at a time - mainly because I'm too lazy to
 196         // implement something which you're never asked for anyhow
 197         return S_FALSE;
 198     }
 199
 200     if ( m_nCurrent < m_nCount ) {
 201         FORMATETC format;
 202         format.cfFormat = m_formats[m_nCurrent++];
 203         format.ptd      = NULL;
 204         format.dwAspect = DVASPECT_CONTENT;
 205         format.lindex   = -1;
 206         format.tymed    = TYMED_HGLOBAL;
 207         *rgelt = format;
 208
 209         return S_OK;
 210     }
 211     else {
 212         // bad index
 213         return S_FALSE;
 214     }
 215 }
 216
 217 STDMETHODIMP wxIEnumFORMATETC::Skip(ULONG celt)
 218 {
 219     wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Skip"));
 220
 221     m_nCurrent += celt;
 222     if ( m_nCurrent < m_nCount )
 223         return S_OK;
 224
 225     // no, can't skip this many elements
 226     m_nCurrent -= celt;
 227
 228     return S_FALSE;
 229 }
 230
 231 STDMETHODIMP wxIEnumFORMATETC::Reset()
 232 {
 233     wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Reset"));
 234
 235     m_nCurrent = 0;
 236
 237     return S_OK;
 238 }
 239
 240 STDMETHODIMP wxIEnumFORMATETC::Clone(IEnumFORMATETC **ppenum)
 241 {
 242     wxLogTrace(wxTRACE_OleCalls, wxT("wxIEnumFORMATETC::Clone"));
 243
 244     // unfortunately, we can't reuse the code in ctor - types are different
 245     wxIEnumFORMATETC *pNew = new wxIEnumFORMATETC(NULL, 0);
 246     pNew->m_nCount = m_nCount;
 247     pNew->m_formats = new CLIPFORMAT[m_nCount];
 248     for ( ULONG n = 0; n < m_nCount; n++ ) {
 249         pNew->m_formats[n] = m_formats[n];
 250     }
 251     pNew->AddRef();
 252     *ppenum = pNew;
 253
 254     return S_OK;
 255 }
 256
 257 // ----------------------------------------------------------------------------
 258 // wxIDataObject
 259 // ----------------------------------------------------------------------------
 260
 261 BEGIN_IID_TABLE(wxIDataObject)
 262     ADD_IID(Unknown)
 263     ADD_IID(DataObject)
 264 END_IID_TABLE;
 265
 266 IMPLEMENT_IUNKNOWN_METHODS(wxIDataObject)
 267
 268 wxIDataObject::wxIDataObject(wxDataObject *pDataObject)
 269 {
 270     m_pDataObject = pDataObject;
 271     m_mustDelete = FALSE;
 272 }
 273
 274 wxIDataObject::~wxIDataObject()
 275 {
 276     if ( m_mustDelete )
 277     {
 278         delete m_pDataObject;
 279     }
 280 }
 281
 282 // get data functions
 283 STDMETHODIMP wxIDataObject::GetData(FORMATETC *pformatetcIn, STGMEDIUM *pmedium)
 284 {
 285     wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetData"));
 286
 287     // is data is in our format?
 288     HRESULT hr = QueryGetData(pformatetcIn);
 289     if ( FAILED(hr) )
 290         return hr;
 291
 292     // for the bitmaps and metafiles we use the handles instead of global memory
 293     // to pass the data
 294     wxDataFormat format = (wxDataFormat::NativeFormat)pformatetcIn->cfFormat;
 295
 296     switch ( format )
 297     {
 298         case wxDF_BITMAP:
 299             pmedium->tymed = TYMED_GDI;
 300             break;
 301
 302         case wxDF_ENHMETAFILE:
 303             pmedium->tymed = TYMED_ENHMF;
 304             break;
 305
 306         case wxDF_METAFILE:
 307             pmedium->hGlobal = GlobalAlloc(GMEM_MOVEABLE | GMEM_SHARE,
 308                                            sizeof(METAFILEPICT));
 309             if ( !pmedium->hGlobal ) {
 310                 wxLogLastError(wxT("GlobalAlloc"));
 311                 return E_OUTOFMEMORY;
 312             }
 313             pmedium->tymed = TYMED_MFPICT;
 314             break;
 315
 316         default:
 317             // alloc memory
 318             size_t size = m_pDataObject->GetDataSize(format);
 319             if ( !size ) {
 320                 // it probably means that the method is just not implemented
 321                 wxLogDebug(wxT("Invalid data size - can't be 0"));
 322
 323                 return DV_E_FORMATETC;
 324             }
 325
 326             if ( !format.IsStandard() ) {
 327                 // for custom formats, put the size with the data - alloc the
 328                 // space for it
 329                 // MB: not completely sure this is correct,
 330                 //     even if I can't figure out what's wrong
 331                 size += m_pDataObject->GetBufferOffset( format );
 332             }
 333
 334             HGLOBAL hGlobal = GlobalAlloc(GMEM_MOVEABLE | GMEM_SHARE, size);
 335             if ( hGlobal == NULL ) {
 336                 wxLogLastError(wxT("GlobalAlloc"));
 337                 return E_OUTOFMEMORY;
 338             }
 339
 340             // copy data
 341             pmedium->tymed   = TYMED_HGLOBAL;
 342             pmedium->hGlobal = hGlobal;
 343     }
 344
 345     pmedium->pUnkForRelease = NULL;
 346
 347     // do copy the data
 348     hr = GetDataHere(pformatetcIn, pmedium);
 349     if ( FAILED(hr) ) {
 350         // free resources we allocated
 351         if ( pmedium->tymed & (TYMED_HGLOBAL | TYMED_MFPICT) ) {
 352             GlobalFree(pmedium->hGlobal);
 353         }
 354
 355         return hr;
 356     }
 357
 358     return S_OK;
 359 }
 360
 361 STDMETHODIMP wxIDataObject::GetDataHere(FORMATETC *pformatetc,
 362                                         STGMEDIUM *pmedium)
 363 {
 364     wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetDataHere"));
 365
 366     // put data in caller provided medium
 367     switch ( pmedium->tymed )
 368     {
 369         case TYMED_GDI:
 370             if ( !m_pDataObject->GetDataHere(wxDF_BITMAP, &pmedium->hBitmap) )
 371                 return E_UNEXPECTED;
 372             break;
 373
 374         case TYMED_ENHMF:
 375             if ( !m_pDataObject->GetDataHere(wxDF_ENHMETAFILE,
 376                                              &pmedium->hEnhMetaFile) )
 377                 return E_UNEXPECTED;
 378             break;
 379
 380         case TYMED_MFPICT:
 381             // fall through - we pass METAFILEPICT through HGLOBAL
 382
 383         case TYMED_HGLOBAL:
 384             {
 385                 // copy data
 386                 HGLOBAL hGlobal = pmedium->hGlobal;
 387                 void *pBuf = GlobalLock(hGlobal);
 388                 if ( pBuf == NULL ) {
 389                     wxLogLastError(wxT("GlobalLock"));
 390                     return E_OUTOFMEMORY;
 391                 }
 392
 393                 wxDataFormat format = pformatetc->cfFormat;
 394                 if ( !format.IsStandard() ) {
 395                     // for custom formats, put the size with the data
 396                     pBuf = m_pDataObject->SetSizeInBuffer( pBuf, GlobalSize(hGlobal), format );
 397                 }
 398
 399                 if ( !m_pDataObject->GetDataHere(format, pBuf) )
 400                     return E_UNEXPECTED;
 401
 402                 GlobalUnlock(hGlobal);
 403             }
 404             break;
 405
 406         default:
 407             return DV_E_TYMED;
 408     }
 409
 410     return S_OK;
 411 }
 412
 413 #ifdef __DIGITALMARS__
 414 extern "C"
 415 size_t wxDataObjectComposite::GetBufferOffset( const wxDataFormat& format );
 416
 417 extern "C"
 418 const void* wxDataObjectComposite::GetSizeFromBuffer( const void* buffer,
 419                                                       size_t* size,
 420                                                       const wxDataFormat& format ) ;
 421 extern "C"
 422 void* wxDataObjectComposite::SetSizeInBuffer( void* buffer, size_t size,
 423                                               const wxDataFormat& format ) ;
 424
 425 #endif
 426
 427 // set data functions
 428 STDMETHODIMP wxIDataObject::SetData(FORMATETC *pformatetc,
 429                                     STGMEDIUM *pmedium,
 430                                     BOOL       fRelease)
 431 {
 432     wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::SetData"));
 433
 434     switch ( pmedium->tymed )
 435     {
 436         case TYMED_GDI:
 437             m_pDataObject->SetData(wxDF_BITMAP, 0, &pmedium->hBitmap);
 438             break;
 439
 440         case TYMED_ENHMF:
 441             m_pDataObject->SetData(wxDF_ENHMETAFILE, 0, &pmedium->hEnhMetaFile);
 442             break;
 443
 444         case TYMED_MFPICT:
 445             // fall through - we pass METAFILEPICT through HGLOBAL
 446         case TYMED_HGLOBAL:
 447             {
 448                 wxDataFormat format = pformatetc->cfFormat;
 449
 450                 // this is quite weird, but for file drag and drop, explorer
 451                 // calls our SetData() with the formats we do *not* support!
 452                 //
 453                 // as we can't fix this bug in explorer (it's a bug because it
 454                 // should only use formats returned by EnumFormatEtc), do the
 455                 // check here
 456                 if ( !m_pDataObject->IsSupported(format, wxDataObject::Set) ) {
 457                     // go away!
 458                     return DV_E_FORMATETC;
 459                 }
 460
 461                 // copy data
 462                 const void *pBuf = GlobalLock(pmedium->hGlobal);
 463                 if ( pBuf == NULL ) {
 464                     wxLogLastError(wxT("GlobalLock"));
 465
 466                     return E_OUTOFMEMORY;
 467                 }
 468
 469                 // we've got a problem with SetData() here because the base
 470                 // class version requires the size parameter which we don't
 471                 // have anywhere in OLE data transfer - so we need to
 472                 // synthetise it for known formats and we suppose that all data
 473                 // in custom formats starts with a DWORD containing the size
 474                 size_t size;
 475                 switch ( format )
 476                 {
 477                     case CF_TEXT:
 478                     case CF_OEMTEXT:
 479                         size = strlen((const char *)pBuf);
 480                         break;
 481 #if !defined(__WATCOMC__) && ! (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
 482                     case CF_UNICODETEXT:
 483 #if ( defined(__BORLANDC__) && (__BORLANDC__ > 0x530) ) \
 484     || ( defined(__MWERKS__) && defined(__WXMSW__) )
 485                         size = std::wcslen((const wchar_t *)pBuf) * sizeof(wchar_t);
 486 #else
 487                         size = wxWcslen((const wchar_t *)pBuf) * sizeof(wchar_t);
 488 #endif
 489                         break;
 490 #endif
 491                     case CF_BITMAP:
 492                     case CF_HDROP:
 493                         // these formats don't use size at all, anyhow (but
 494                         // pass data by handle, which is always a single DWORD)
 495                         size = 0;
 496                         break;
 497
 498                     case CF_DIB:
 499                         // the handler will calculate size itself (it's too
 500                         // complicated to do it here)
 501                         size = 0;
 502                         break;
 503
 504                     case CF_METAFILEPICT:
 505                         size = sizeof(METAFILEPICT);
 506                         break;
 507
 508                     default:
 509                         {
 510                             // we suppose that the size precedes the data
 511                             pBuf = m_pDataObject->GetSizeFromBuffer( pBuf, &size, format );
 512                             if (! format.IsStandard() ) {
 513                                 // see GetData for coresponding increment
 514                                 size -= m_pDataObject->GetBufferOffset( format  );
 515                             }
 516                         }
 517                 }
 518
 519                 bool ok = m_pDataObject->SetData(format, size, pBuf);
 520
 521                 GlobalUnlock(pmedium->hGlobal);
 522
 523                 if ( !ok ) {
 524                     return E_UNEXPECTED;
 525                 }
 526             }
 527             break;
 528
 529         default:
 530             return DV_E_TYMED;
 531     }
 532
 533     if ( fRelease ) {
 534         // we own the medium, so we must release it - but do *not* free any
 535         // data we pass by handle because we have copied it elsewhere
 536         switch ( pmedium->tymed )
 537         {
 538             case TYMED_GDI:
 539                 pmedium->hBitmap = 0;
 540                 break;
 541
 542             case TYMED_MFPICT:
 543                 pmedium->hMetaFilePict = 0;
 544                 break;
 545
 546             case TYMED_ENHMF:
 547                 pmedium->hEnhMetaFile = 0;
 548                 break;
 549         }
 550
 551         ReleaseStgMedium(pmedium);
 552     }
 553
 554     return S_OK;
 555 }
 556
 557 // information functions
 558 STDMETHODIMP wxIDataObject::QueryGetData(FORMATETC *pformatetc)
 559 {
 560     // do we accept data in this format?
 561     if ( pformatetc == NULL ) {
 562         wxLogTrace(wxTRACE_OleCalls,
 563                    wxT("wxIDataObject::QueryGetData: invalid ptr."));
 564
 565         return E_INVALIDARG;
 566     }
 567
 568     // the only one allowed by current COM implementation
 569     if ( pformatetc->lindex != -1 ) {
 570         wxLogTrace(wxTRACE_OleCalls,
 571                    wxT("wxIDataObject::QueryGetData: bad lindex %ld"),
 572                    pformatetc->lindex);
 573
 574         return DV_E_LINDEX;
 575     }
 576
 577     // we don't support anything other (THUMBNAIL, ICON, DOCPRINT...)
 578     if ( pformatetc->dwAspect != DVASPECT_CONTENT ) {
 579         wxLogTrace(wxTRACE_OleCalls,
 580                    wxT("wxIDataObject::QueryGetData: bad dwAspect %ld"),
 581                    pformatetc->dwAspect);
 582
 583         return DV_E_DVASPECT;
 584     }
 585
 586     // and now check the type of data requested
 587     wxDataFormat format = pformatetc->cfFormat;
 588     if ( m_pDataObject->IsSupportedFormat(format) ) {
 589         wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::QueryGetData: %s ok"),
 590                    wxGetFormatName(format));
 591     }
 592     else {
 593         wxLogTrace(wxTRACE_OleCalls,
 594                    wxT("wxIDataObject::QueryGetData: %s unsupported"),
 595                    wxGetFormatName(format));
 596
 597         return DV_E_FORMATETC;
 598     }
 599
 600     // we only transfer data by global memory, except for some particular cases
 601     DWORD tymed = pformatetc->tymed;
 602     if ( (format == wxDF_BITMAP && !(tymed & TYMED_GDI)) &&
 603          !(tymed & TYMED_HGLOBAL) ) {
 604         // it's not what we're waiting for
 605         wxLogTrace(wxTRACE_OleCalls,
 606                    wxT("wxIDataObject::QueryGetData: %s != %s"),
 607                    GetTymedName(tymed),
 608                    GetTymedName(format == wxDF_BITMAP ? TYMED_GDI
 609                                                       : TYMED_HGLOBAL));
 610
 611         return DV_E_TYMED;
 612     }
 613
 614     return S_OK;
 615 }
 616
 617 STDMETHODIMP wxIDataObject::GetCanonicalFormatEtc(FORMATETC *WXUNUSED(pFormatetcIn),
 618                                                   FORMATETC *pFormatetcOut)
 619 {
 620     wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetCanonicalFormatEtc"));
 621
 622     // TODO we might want something better than this trivial implementation here
 623     if ( pFormatetcOut != NULL )
 624         pFormatetcOut->ptd = NULL;
 625
 626     return DATA_S_SAMEFORMATETC;
 627 }
 628
 629 STDMETHODIMP wxIDataObject::EnumFormatEtc(DWORD dwDir,
 630                                           IEnumFORMATETC **ppenumFormatEtc)
 631 {
 632     wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::EnumFormatEtc"));
 633
 634     wxDataObject::Direction dir = dwDir == DATADIR_GET ? wxDataObject::Get
 635                                                        : wxDataObject::Set;
 636
 637     size_t nFormatCount = m_pDataObject->GetFormatCount(dir);
 638     wxDataFormat format;
 639     wxDataFormat *formats;
 640     formats = nFormatCount == 1 ? &format : new wxDataFormat[nFormatCount];
 641     m_pDataObject->GetAllFormats(formats, dir);
 642
 643     wxIEnumFORMATETC *pEnum = new wxIEnumFORMATETC(formats, nFormatCount);
 644     pEnum->AddRef();
 645     *ppenumFormatEtc = pEnum;
 646
 647     if ( formats != &format ) {
 648         delete [] formats;
 649     }
 650
 651     return S_OK;
 652 }
 653
 654 // ----------------------------------------------------------------------------
 655 // advise sink functions (not implemented)
 656 // ----------------------------------------------------------------------------
 657
 658 STDMETHODIMP wxIDataObject::DAdvise(FORMATETC   *WXUNUSED(pformatetc),
 659                                     DWORD        WXUNUSED(advf),
 660                                     IAdviseSink *WXUNUSED(pAdvSink),
 661                                     DWORD       *WXUNUSED(pdwConnection))
 662 {
 663   return OLE_E_ADVISENOTSUPPORTED;
 664 }
 665
 666 STDMETHODIMP wxIDataObject::DUnadvise(DWORD WXUNUSED(dwConnection))
 667 {
 668   return OLE_E_ADVISENOTSUPPORTED;
 669 }
 670
 671 STDMETHODIMP wxIDataObject::EnumDAdvise(IEnumSTATDATA **WXUNUSED(ppenumAdvise))
 672 {
 673   return OLE_E_ADVISENOTSUPPORTED;
 674 }
 675
 676 // ----------------------------------------------------------------------------
 677 // wxDataObject
 678 // ----------------------------------------------------------------------------
 679
 680 wxDataObject::wxDataObject()
 681 {
 682     m_pIDataObject = new wxIDataObject(this);
 683     m_pIDataObject->AddRef();
 684 }
 685
 686 wxDataObject::~wxDataObject()
 687 {
 688     ReleaseInterface(m_pIDataObject);
 689 }
 690
 691 void wxDataObject::SetAutoDelete()
 692 {
 693     ((wxIDataObject *)m_pIDataObject)->SetDeleteFlag();
 694     m_pIDataObject->Release();
 695
 696     // so that the dtor doesnt' crash
 697     m_pIDataObject = NULL;
 698 }
 699
 700 size_t wxDataObject::GetBufferOffset( const wxDataFormat& WXUNUSED(format) )
 701 {
 702     return sizeof(size_t);
 703 }
 704
 705 const void* wxDataObject::GetSizeFromBuffer( const void* buffer, size_t* size,
 706                                              const wxDataFormat& WXUNUSED(format) )
 707 {
 708     size_t* p = (size_t*)buffer;
 709     *size = *p;
 710
 711     return p + 1;
 712 }
 713
 714 void* wxDataObject::SetSizeInBuffer( void* buffer, size_t size,
 715                                        const wxDataFormat& WXUNUSED(format) )
 716 {
 717     size_t* p = (size_t*)buffer;
 718     *p = size;
 719
 720     return p + 1;
 721 }
 722
 723 #ifdef __WXDEBUG__
 724
 725 const wxChar *wxDataObject::GetFormatName(wxDataFormat format)
 726 {
 727     // case 'xxx' is not a valid value for switch of enum 'wxDataFormat'
 728     #ifdef __VISUALC__
 729         #pragma warning(disable:4063)
 730     #endif // VC++
 731
 732     static wxChar s_szBuf[256];
 733     switch ( format ) {
 734         case CF_TEXT:         return wxT("CF_TEXT");
 735         case CF_BITMAP:       return wxT("CF_BITMAP");
 736         case CF_METAFILEPICT: return wxT("CF_METAFILEPICT");
 737         case CF_SYLK:         return wxT("CF_SYLK");
 738         case CF_DIF:          return wxT("CF_DIF");
 739         case CF_TIFF:         return wxT("CF_TIFF");
 740         case CF_OEMTEXT:      return wxT("CF_OEMTEXT");
 741         case CF_DIB:          return wxT("CF_DIB");
 742         case CF_PALETTE:      return wxT("CF_PALETTE");
 743         case CF_PENDATA:      return wxT("CF_PENDATA");
 744         case CF_RIFF:         return wxT("CF_RIFF");
 745         case CF_WAVE:         return wxT("CF_WAVE");
 746         case CF_UNICODETEXT:  return wxT("CF_UNICODETEXT");
 747         case CF_ENHMETAFILE:  return wxT("CF_ENHMETAFILE");
 748         case CF_HDROP:        return wxT("CF_HDROP");
 749         case CF_LOCALE:       return wxT("CF_LOCALE");
 750
 751         default:
 752             if ( !::GetClipboardFormatName(format, s_szBuf, WXSIZEOF(s_szBuf)) )
 753             {
 754                 // it must be a new predefined format we don't know the name of
 755                 wxSprintf(s_szBuf, wxT("unknown CF (0x%04x)"), format.GetFormatId());
 756             }
 757
 758             return s_szBuf;
 759     }
 760
 761     #ifdef __VISUALC__
 762         #pragma warning(default:4063)
 763     #endif // VC++
 764 }
 765
 766 #endif // Debug
 767
 768 // ----------------------------------------------------------------------------
 769 // wxBitmapDataObject supports CF_DIB format
 770 // ----------------------------------------------------------------------------
 771
 772 size_t wxBitmapDataObject::GetDataSize() const
 773 {
 774     return wxDIB::ConvertFromBitmap(NULL, GetHbitmapOf(GetBitmap()));
 775 }
 776
 777 bool wxBitmapDataObject::GetDataHere(void *buf) const
 778 {
 779     BITMAPINFO * const pbi = (BITMAPINFO *)buf;
 780
 781     return wxDIB::ConvertFromBitmap(pbi, GetHbitmapOf(GetBitmap())) != 0;
 782 }
 783
 784 bool wxBitmapDataObject::SetData(size_t WXUNUSED(len), const void *buf)
 785 {
 786     const BITMAPINFO * const pbmi = (const BITMAPINFO *)buf;
 787
 788     HBITMAP hbmp = wxDIB::ConvertToBitmap(pbmi);
 789
 790     wxCHECK_MSG( hbmp, FALSE, wxT("pasting/dropping invalid bitmap") );
 791
 792     const BITMAPINFOHEADER * const pbmih = &pbmi->bmiHeader;
 793     wxBitmap bitmap(pbmih->biWidth, pbmih->biHeight, pbmih->biBitCount);
 794     bitmap.SetHBITMAP((WXHBITMAP)hbmp);
 795
 796     // TODO: create wxPalette if the bitmap has any
 797
 798     SetBitmap(bitmap);
 799
 800     return TRUE;
 801 }
 802
 803 // ----------------------------------------------------------------------------
 804 // wxBitmapDataObject2 supports CF_BITMAP format
 805 // ----------------------------------------------------------------------------
 806
 807 // the bitmaps aren't passed by value as other types of data (i.e. by copying
 808 // the data into a global memory chunk and passing it to the clipboard or
 809 // another application or whatever), but by handle, so these generic functions
 810 // don't make much sense to them.
 811
 812 size_t wxBitmapDataObject2::GetDataSize() const
 813 {
 814     return 0;
 815 }
 816
 817 bool wxBitmapDataObject2::GetDataHere(void *pBuf) const
 818 {
 819     // we put a bitmap handle into pBuf
 820     *(WXHBITMAP *)pBuf = GetBitmap().GetHBITMAP();
 821
 822     return TRUE;
 823 }
 824
 825 bool wxBitmapDataObject2::SetData(size_t WXUNUSED(len), const void *pBuf)
 826 {
 827     HBITMAP hbmp = *(HBITMAP *)pBuf;
 828
 829     BITMAP bmp;
 830     if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
 831     {
 832         wxLogLastError(wxT("GetObject(HBITMAP)"));
 833     }
 834
 835     wxBitmap bitmap(bmp.bmWidth, bmp.bmHeight, bmp.bmPlanes);
 836     bitmap.SetHBITMAP((WXHBITMAP)hbmp);
 837
 838     if ( !bitmap.Ok() ) {
 839         wxFAIL_MSG(wxT("pasting/dropping invalid bitmap"));
 840
 841         return FALSE;
 842     }
 843
 844     SetBitmap(bitmap);
 845
 846     return TRUE;
 847 }
 848
 849 #if 0
 850
 851 size_t wxBitmapDataObject::GetDataSize(const wxDataFormat& format) const
 852 {
 853     if ( format.GetFormatId() == CF_DIB )
 854     {
 855         // create the DIB
 856         ScreenHDC hdc;
 857
 858         // shouldn't be selected into a DC or GetDIBits() would fail
 859         wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
 860                       wxT("can't copy bitmap selected into wxMemoryDC") );
 861
 862         // first get the info
 863         BITMAPINFO bi;
 864         if ( !GetDIBits(hdc, (HBITMAP)m_bitmap.GetHBITMAP(), 0, 0,
 865                         NULL, &bi, DIB_RGB_COLORS) )
 866         {
 867             wxLogLastError(wxT("GetDIBits(NULL)"));
 868
 869             return 0;
 870         }
 871
 872         return sizeof(BITMAPINFO) + bi.bmiHeader.biSizeImage;
 873     }
 874     else // CF_BITMAP
 875     {
 876         // no data to copy - we don't pass HBITMAP via global memory
 877         return 0;
 878     }
 879 }
 880
 881 bool wxBitmapDataObject::GetDataHere(const wxDataFormat& format,
 882                                      void *pBuf) const
 883 {
 884     wxASSERT_MSG( m_bitmap.Ok(), wxT("copying invalid bitmap") );
 885
 886     HBITMAP hbmp = (HBITMAP)m_bitmap.GetHBITMAP();
 887     if ( format.GetFormatId() == CF_DIB )
 888     {
 889         // create the DIB
 890         ScreenHDC hdc;
 891
 892         // shouldn't be selected into a DC or GetDIBits() would fail
 893         wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
 894                       wxT("can't copy bitmap selected into wxMemoryDC") );
 895
 896         // first get the info
 897         BITMAPINFO *pbi = (BITMAPINFO *)pBuf;
 898         if ( !GetDIBits(hdc, hbmp, 0, 0, NULL, pbi, DIB_RGB_COLORS) )
 899         {
 900             wxLogLastError(wxT("GetDIBits(NULL)"));
 901
 902             return 0;
 903         }
 904
 905         // and now copy the bits
 906         if ( !GetDIBits(hdc, hbmp, 0, pbi->bmiHeader.biHeight, pbi + 1,
 907                         pbi, DIB_RGB_COLORS) )
 908         {
 909             wxLogLastError(wxT("GetDIBits"));
 910
 911             return FALSE;
 912         }
 913     }
 914     else // CF_BITMAP
 915     {
 916         // we put a bitmap handle into pBuf
 917         *(HBITMAP *)pBuf = hbmp;
 918     }
 919
 920     return TRUE;
 921 }
 922
 923 bool wxBitmapDataObject::SetData(const wxDataFormat& format,
 924                                  size_t size, const void *pBuf)
 925 {
 926     HBITMAP hbmp;
 927     if ( format.GetFormatId() == CF_DIB )
 928     {
 929         // here we get BITMAPINFO struct followed by the actual bitmap bits and
 930         // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
 931         ScreenHDC hdc;
 932
 933         BITMAPINFO *pbmi = (BITMAPINFO *)pBuf;
 934         BITMAPINFOHEADER *pbmih = &pbmi->bmiHeader;
 935         hbmp = CreateDIBitmap(hdc, pbmih, CBM_INIT,
 936                               pbmi + 1, pbmi, DIB_RGB_COLORS);
 937         if ( !hbmp )
 938         {
 939             wxLogLastError(wxT("CreateDIBitmap"));
 940         }
 941
 942         m_bitmap.SetWidth(pbmih->biWidth);
 943         m_bitmap.SetHeight(pbmih->biHeight);
 944     }
 945     else // CF_BITMAP
 946     {
 947         // it's easy with bitmaps: we pass them by handle
 948         hbmp = *(HBITMAP *)pBuf;
 949
 950         BITMAP bmp;
 951         if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
 952         {
 953             wxLogLastError(wxT("GetObject(HBITMAP)"));
 954         }
 955
 956         m_bitmap.SetWidth(bmp.bmWidth);
 957         m_bitmap.SetHeight(bmp.bmHeight);
 958         m_bitmap.SetDepth(bmp.bmPlanes);
 959     }
 960
 961     m_bitmap.SetHBITMAP((WXHBITMAP)hbmp);
 962
 963     wxASSERT_MSG( m_bitmap.Ok(), wxT("pasting invalid bitmap") );
 964
 965     return TRUE;
 966 }
 967
 968 #endif // 0
 969
 970 // ----------------------------------------------------------------------------
 971 // wxFileDataObject
 972 // ----------------------------------------------------------------------------
 973
 974 bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *pData)
 975 {
 976 //FIX ME  __DIGITALMARS__
 977 #if defined (__DIGITALMARS__)
 978     //DragQueryFile not in any library
 979     wxLogDebug(wxT("In wxFileDataObject::SetData code not executed - no Digital Mars library "));
 980     return FALSE;
 981 #endif
 982     m_filenames.Empty();
 983
 984     // the documentation states that the first member of DROPFILES structure is
 985     // a "DWORD offset of double NUL terminated file list". What they mean by
 986     // this (I wonder if you see it immediately) is that the list starts at
 987     // ((char *)&(pDropFiles.pFiles)) + pDropFiles.pFiles. We're also advised
 988     // to use DragQueryFile to work with this structure, but not told where and
 989     // how to get HDROP.
 990     HDROP hdrop = (HDROP)pData;   // NB: it works, but I'm not sure about it
 991
 992     // get number of files (magic value -1)
 993     UINT nFiles = ::DragQueryFile(hdrop, (unsigned)-1, NULL, 0u);
 994
 995     wxCHECK_MSG ( nFiles != (UINT)-1, FALSE, wxT("wrong HDROP handle") );
 996
 997     // for each file get the length, allocate memory and then get the name
 998     wxString str;
 999     UINT len, n;
1000     for ( n = 0; n < nFiles; n++ ) {
1001         // +1 for terminating NUL
1002         len = ::DragQueryFile(hdrop, n, NULL, 0) + 1;
1003
1004         UINT len2 = ::DragQueryFile(hdrop, n, str.GetWriteBuf(len), len);
1005         str.UngetWriteBuf();
1006         m_filenames.Add(str);
1007
1008         if ( len2 != len - 1 ) {
1009             wxLogDebug(wxT("In wxFileDropTarget::OnDrop DragQueryFile returned\
1010  %d characters, %d expected."), len2, len - 1);
1011         }
1012     }
1013
1014     return TRUE;
1015 }
1016
1017 void wxFileDataObject::AddFile(const wxString& file)
1018 {
1019     // just add file to filenames array
1020     // all useful data (such as DROPFILES struct) will be
1021     // created later as necessary
1022     m_filenames.Add(file);
1023 }
1024
1025 size_t wxFileDataObject::GetDataSize() const
1026 {
1027     // size returned will be the size of the DROPFILES structure,
1028     // plus the list of filesnames (null byte separated), plus
1029     // a double null at the end
1030
1031     // if no filenames in list, size is 0
1032     if ( m_filenames.GetCount() == 0 )
1033         return 0;
1034
1035     // inital size of DROPFILES struct + null byte
1036     size_t sz = sizeof(DROPFILES) + 1;
1037
1038     size_t count = m_filenames.GetCount();
1039     for ( size_t i = 0; i < count; i++ )
1040     {
1041         // add filename length plus null byte
1042         sz += m_filenames[i].Len() + 1;
1043     }
1044
1045     return sz;
1046 }
1047
1048 bool wxFileDataObject::GetDataHere(void *pData) const
1049 {
1050     // pData points to an externally allocated memory block
1051     // created using the size returned by GetDataSize()
1052
1053     // if pData is NULL, or there are no files, return
1054     if ( !pData || m_filenames.GetCount() == 0 )
1055         return FALSE;
1056
1057     // convert data pointer to a DROPFILES struct pointer
1058     LPDROPFILES pDrop = (LPDROPFILES) pData;
1059
1060     // initialize DROPFILES struct
1061     pDrop->pFiles = sizeof(DROPFILES);
1062     pDrop->fNC = FALSE;                 // not non-client coords
1063 #if wxUSE_UNICODE
1064     pDrop->fWide = TRUE;
1065 #else // ANSI
1066     pDrop->fWide = FALSE;
1067 #endif // Unicode/Ansi
1068
1069     // set start of filenames list (null separated)
1070     wxChar *pbuf = (wxChar*) ((BYTE *)pDrop + sizeof(DROPFILES));
1071
1072     size_t count = m_filenames.GetCount();
1073     for (size_t i = 0; i < count; i++ )
1074     {
1075         // copy filename to pbuf and add null terminator
1076         size_t len = m_filenames[i].Len();
1077         memcpy(pbuf, m_filenames[i], len);
1078         pbuf += len;
1079         *pbuf++ = wxT('\0');
1080     }
1081
1082     // add final null terminator
1083     *pbuf = wxT('\0');
1084
1085     return TRUE;
1086 }
1087
1088 // ----------------------------------------------------------------------------
1089 // wxURLDataObject
1090 // ----------------------------------------------------------------------------
1091
1092 class CFSTR_SHELLURLDataObject : public wxCustomDataObject
1093 {
1094 public:
1095     CFSTR_SHELLURLDataObject() : wxCustomDataObject(CFSTR_SHELLURL) {}
1096 protected:
1097     virtual size_t GetBufferOffset( const wxDataFormat& WXUNUSED(format) )
1098     {
1099         return 0;
1100     }
1101
1102     virtual const void* GetSizeFromBuffer( const void* buffer, size_t* size,
1103                                            const wxDataFormat& WXUNUSED(format) )
1104     {
1105         // CFSTR_SHELLURL is _always_ ANSI text
1106         *size = strlen( (const char*)buffer );
1107
1108         return buffer;
1109     }
1110
1111     virtual void* SetSizeInBuffer( void* buffer, size_t WXUNUSED(size),
1112                                    const wxDataFormat& WXUNUSED(format) )
1113     {
1114         return buffer;
1115     }
1116
1117 #if wxUSE_UNICODE
1118     virtual bool GetDataHere( void* buffer ) const
1119     {
1120         // CFSTR_SHELLURL is _always_ ANSI!
1121         wxCharBuffer char_buffer( GetDataSize() );
1122         wxCustomDataObject::GetDataHere( (void*)char_buffer.data() );
1123         wxString unicode_buffer( char_buffer, wxConvLibc );
1124         memcpy( buffer, unicode_buffer.c_str(),
1125                 ( unicode_buffer.length() + 1 ) * sizeof(wxChar) );
1126
1127         return TRUE;
1128     }
1129 #endif
1130 };
1131
1132
1133
1134 wxURLDataObject::wxURLDataObject()
1135 {
1136     // we support CF_TEXT and CFSTR_SHELLURL formats which are basicly the same
1137     // but it seems that some browsers only provide one of them so we have to
1138     // support both
1139     Add(new wxTextDataObject);
1140     Add(new CFSTR_SHELLURLDataObject());
1141
1142     // we don't have any data yet
1143     m_dataObjectLast = NULL;
1144 }
1145
1146 bool wxURLDataObject::SetData(const wxDataFormat& format,
1147                               size_t len,
1148                               const void *buf)
1149 {
1150     m_dataObjectLast = GetObject(format);
1151
1152     wxCHECK_MSG( m_dataObjectLast, FALSE,
1153                  wxT("unsupported format in wxURLDataObject"));
1154
1155     return m_dataObjectLast->SetData(len, buf);
1156 }
1157
1158 wxString wxURLDataObject::GetURL() const
1159 {
1160     wxString url;
1161     wxCHECK_MSG( m_dataObjectLast, url, _T("no data in wxURLDataObject") );
1162
1163     size_t len = m_dataObjectLast->GetDataSize();
1164
1165     m_dataObjectLast->GetDataHere(url.GetWriteBuf(len));
1166     url.UngetWriteBuf();
1167
1168     return url;
1169 }
1170
1171 void wxURLDataObject::SetURL(const wxString& url)
1172 {
1173     SetData(wxDataFormat(wxUSE_UNICODE ? wxDF_UNICODETEXT : wxDF_TEXT),
1174             url.Length()+1, url.c_str());
1175
1176     // CFSTR_SHELLURL is always supposed to be ANSI...
1177     wxWX2MBbuf urlA = (wxWX2MBbuf)url.mbc_str();
1178     size_t len = strlen(urlA);
1179     SetData(wxDataFormat(CFSTR_SHELLURL), len+1, (const char*)urlA);
1180 }
1181
1182 // ----------------------------------------------------------------------------
1183 // private functions
1184 // ----------------------------------------------------------------------------
1185
1186 #ifdef __WXDEBUG__
1187
1188 static const wxChar *GetTymedName(DWORD tymed)
1189 {
1190     static wxChar s_szBuf[128];
1191     switch ( tymed ) {
1192         case TYMED_HGLOBAL:   return wxT("TYMED_HGLOBAL");
1193         case TYMED_FILE:      return wxT("TYMED_FILE");
1194         case TYMED_ISTREAM:   return wxT("TYMED_ISTREAM");
1195         case TYMED_ISTORAGE:  return wxT("TYMED_ISTORAGE");
1196         case TYMED_GDI:       return wxT("TYMED_GDI");
1197         case TYMED_MFPICT:    return wxT("TYMED_MFPICT");
1198         case TYMED_ENHMF:     return wxT("TYMED_ENHMF");
1199         default:
1200             wxSprintf(s_szBuf, wxT("type of media format %ld (unknown)"), tymed);
1201             return s_szBuf;
1202     }
1203 }
1204
1205 #endif // Debug
1206
1207 #else // not using OLE at all
1208 // ----------------------------------------------------------------------------
1209 // wxDataObject
1210 // ----------------------------------------------------------------------------
1211
1212 wxDataObject::wxDataObject()
1213 {
1214 }
1215
1216 wxDataObject::~wxDataObject()
1217 {
1218 }
1219
1220 void wxDataObject::SetAutoDelete()
1221 {
1222 }
1223
1224 #ifdef __WXDEBUG__
1225 const wxChar *wxDataObject::GetFormatName(wxDataFormat format)
1226 {
1227     return NULL;
1228 }
1229 #endif
1230
1231 #endif
1232