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