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