]> git.saurik.com Git - wxWidgets.git/blob - src/msw/ole/dataobj.cpp
Corrected wxFormatConverter for strings which need
[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_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 // set data functions
414 STDMETHODIMP wxIDataObject::SetData(FORMATETC *pformatetc,
415 STGMEDIUM *pmedium,
416 BOOL fRelease)
417 {
418 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::SetData"));
419
420 switch ( pmedium->tymed )
421 {
422 case TYMED_GDI:
423 m_pDataObject->SetData(wxDF_BITMAP, 0, &pmedium->hBitmap);
424 break;
425
426 case TYMED_ENHMF:
427 m_pDataObject->SetData(wxDF_ENHMETAFILE, 0, &pmedium->hEnhMetaFile);
428 break;
429
430 case TYMED_MFPICT:
431 // fall through - we pass METAFILEPICT through HGLOBAL
432 case TYMED_HGLOBAL:
433 {
434 wxDataFormat format = pformatetc->cfFormat;
435
436 // this is quite weird, but for file drag and drop, explorer
437 // calls our SetData() with the formats we do *not* support!
438 //
439 // as we can't fix this bug in explorer (it's a bug because it
440 // should only use formats returned by EnumFormatEtc), do the
441 // check here
442 if ( !m_pDataObject->IsSupportedFormat(format) ) {
443 // go away!
444 return DV_E_FORMATETC;
445 }
446
447 // copy data
448 const void *pBuf = GlobalLock(pmedium->hGlobal);
449 if ( pBuf == NULL ) {
450 wxLogLastError(wxT("GlobalLock"));
451
452 return E_OUTOFMEMORY;
453 }
454
455 // we've got a problem with SetData() here because the base
456 // class version requires the size parameter which we don't
457 // have anywhere in OLE data transfer - so we need to
458 // synthetise it for known formats and we suppose that all data
459 // in custom formats starts with a DWORD containing the size
460 size_t size;
461 switch ( format )
462 {
463 case CF_TEXT:
464 case CF_OEMTEXT:
465 size = strlen((const char *)pBuf);
466 break;
467 #if !defined(__WATCOMC__) && ! (defined(__BORLANDC__) && (__BORLANDC__ < 0x500))
468 case CF_UNICODETEXT:
469 #if ( defined(__BORLANDC__) && (__BORLANDC__ > 0x530) ) \
470 || ( defined(__MWERKS__) && defined(__WXMSW__) )
471 size = std::wcslen((const wchar_t *)pBuf) * sizeof(wchar_t);
472 #else
473 size = ::wcslen((const wchar_t *)pBuf) * sizeof(wchar_t);
474 #endif
475 break;
476 #endif
477 case CF_BITMAP:
478 case CF_HDROP:
479 // these formats don't use size at all, anyhow (but
480 // pass data by handle, which is always a single DWORD)
481 size = 0;
482 break;
483
484 case CF_DIB:
485 // the handler will calculate size itself (it's too
486 // complicated to do it here)
487 size = 0;
488 break;
489
490 case CF_METAFILEPICT:
491 size = sizeof(METAFILEPICT);
492 break;
493
494 default:
495 {
496 // we suppose that the size precedes the data
497 pBuf = m_pDataObject->GetSizeFromBuffer( pBuf, &size, format );
498 if (! format.IsStandard() ) {
499 // see GetData for coresponding increment
500 size -= m_pDataObject->GetBufferOffset( format );
501 }
502 }
503 }
504
505 bool ok = m_pDataObject->SetData(format, size, pBuf);
506
507 GlobalUnlock(pmedium->hGlobal);
508
509 if ( !ok ) {
510 return E_UNEXPECTED;
511 }
512 }
513 break;
514
515 default:
516 return DV_E_TYMED;
517 }
518
519 if ( fRelease ) {
520 // we own the medium, so we must release it - but do *not* free any
521 // data we pass by handle because we have copied it elsewhere
522 switch ( pmedium->tymed )
523 {
524 case TYMED_GDI:
525 pmedium->hBitmap = 0;
526 break;
527
528 case TYMED_MFPICT:
529 pmedium->hMetaFilePict = 0;
530 break;
531
532 case TYMED_ENHMF:
533 pmedium->hEnhMetaFile = 0;
534 break;
535 }
536
537 ReleaseStgMedium(pmedium);
538 }
539
540 return S_OK;
541 }
542
543 // information functions
544 STDMETHODIMP wxIDataObject::QueryGetData(FORMATETC *pformatetc)
545 {
546 // do we accept data in this format?
547 if ( pformatetc == NULL ) {
548 wxLogTrace(wxTRACE_OleCalls,
549 wxT("wxIDataObject::QueryGetData: invalid ptr."));
550
551 return E_INVALIDARG;
552 }
553
554 // the only one allowed by current COM implementation
555 if ( pformatetc->lindex != -1 ) {
556 wxLogTrace(wxTRACE_OleCalls,
557 wxT("wxIDataObject::QueryGetData: bad lindex %d"),
558 pformatetc->lindex);
559
560 return DV_E_LINDEX;
561 }
562
563 // we don't support anything other (THUMBNAIL, ICON, DOCPRINT...)
564 if ( pformatetc->dwAspect != DVASPECT_CONTENT ) {
565 wxLogTrace(wxTRACE_OleCalls,
566 wxT("wxIDataObject::QueryGetData: bad dwAspect %d"),
567 pformatetc->dwAspect);
568
569 return DV_E_DVASPECT;
570 }
571
572 // and now check the type of data requested
573 wxDataFormat format = pformatetc->cfFormat;
574 if ( m_pDataObject->IsSupportedFormat(format) ) {
575 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::QueryGetData: %s ok"),
576 wxGetFormatName(format));
577 }
578 else {
579 wxLogTrace(wxTRACE_OleCalls,
580 wxT("wxIDataObject::QueryGetData: %s unsupported"),
581 wxGetFormatName(format));
582
583 return DV_E_FORMATETC;
584 }
585
586 // we only transfer data by global memory, except for some particular cases
587 DWORD tymed = pformatetc->tymed;
588 if ( (format == wxDF_BITMAP && !(tymed & TYMED_GDI)) &&
589 !(tymed & TYMED_HGLOBAL) ) {
590 // it's not what we're waiting for
591 wxLogTrace(wxTRACE_OleCalls,
592 wxT("wxIDataObject::QueryGetData: %s != %s"),
593 GetTymedName(tymed),
594 GetTymedName(format == wxDF_BITMAP ? TYMED_GDI
595 : TYMED_HGLOBAL));
596
597 return DV_E_TYMED;
598 }
599
600 return S_OK;
601 }
602
603 STDMETHODIMP wxIDataObject::GetCanonicalFormatEtc(FORMATETC *WXUNUSED(pFormatetcIn),
604 FORMATETC *pFormatetcOut)
605 {
606 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::GetCanonicalFormatEtc"));
607
608 // TODO we might want something better than this trivial implementation here
609 if ( pFormatetcOut != NULL )
610 pFormatetcOut->ptd = NULL;
611
612 return DATA_S_SAMEFORMATETC;
613 }
614
615 STDMETHODIMP wxIDataObject::EnumFormatEtc(DWORD dwDir,
616 IEnumFORMATETC **ppenumFormatEtc)
617 {
618 wxLogTrace(wxTRACE_OleCalls, wxT("wxIDataObject::EnumFormatEtc"));
619
620 wxDataObject::Direction dir = dwDir == DATADIR_GET ? wxDataObject::Get
621 : wxDataObject::Set;
622
623 size_t nFormatCount = m_pDataObject->GetFormatCount(dir);
624 wxDataFormat format;
625 wxDataFormat *formats;
626 formats = nFormatCount == 1 ? &format : new wxDataFormat[nFormatCount];
627 m_pDataObject->GetAllFormats(formats, dir);
628
629 wxIEnumFORMATETC *pEnum = new wxIEnumFORMATETC(formats, nFormatCount);
630 pEnum->AddRef();
631 *ppenumFormatEtc = pEnum;
632
633 if ( formats != &format ) {
634 delete [] formats;
635 }
636
637 return S_OK;
638 }
639
640 // ----------------------------------------------------------------------------
641 // advise sink functions (not implemented)
642 // ----------------------------------------------------------------------------
643
644 STDMETHODIMP wxIDataObject::DAdvise(FORMATETC *WXUNUSED(pformatetc),
645 DWORD WXUNUSED(advf),
646 IAdviseSink *WXUNUSED(pAdvSink),
647 DWORD *WXUNUSED(pdwConnection))
648 {
649 return OLE_E_ADVISENOTSUPPORTED;
650 }
651
652 STDMETHODIMP wxIDataObject::DUnadvise(DWORD WXUNUSED(dwConnection))
653 {
654 return OLE_E_ADVISENOTSUPPORTED;
655 }
656
657 STDMETHODIMP wxIDataObject::EnumDAdvise(IEnumSTATDATA **WXUNUSED(ppenumAdvise))
658 {
659 return OLE_E_ADVISENOTSUPPORTED;
660 }
661
662 // ----------------------------------------------------------------------------
663 // wxDataObject
664 // ----------------------------------------------------------------------------
665
666 wxDataObject::wxDataObject()
667 {
668 m_pIDataObject = new wxIDataObject(this);
669 m_pIDataObject->AddRef();
670 }
671
672 wxDataObject::~wxDataObject()
673 {
674 ReleaseInterface(m_pIDataObject);
675 }
676
677 void wxDataObject::SetAutoDelete()
678 {
679 ((wxIDataObject *)m_pIDataObject)->SetDeleteFlag();
680 m_pIDataObject->Release();
681
682 // so that the dtor doesnt' crash
683 m_pIDataObject = NULL;
684 }
685
686 size_t wxDataObject::GetBufferOffset( const wxDataFormat& WXUNUSED(format) )
687 {
688 return sizeof(size_t);
689 }
690
691 const void* wxDataObject::GetSizeFromBuffer( const void* buffer, size_t* size,
692 const wxDataFormat& WXUNUSED(format) )
693 {
694 size_t* p = (size_t*)buffer;
695 *size = *p;
696
697 return p + 1;
698 }
699
700 void* wxDataObject::SetSizeInBuffer( void* buffer, size_t size,
701 const wxDataFormat& WXUNUSED(format) )
702 {
703 size_t* p = (size_t*)buffer;
704 *p = size;
705
706 return p + 1;
707 }
708
709 #ifdef __WXDEBUG__
710
711 const wxChar *wxDataObject::GetFormatName(wxDataFormat format)
712 {
713 // case 'xxx' is not a valid value for switch of enum 'wxDataFormat'
714 #ifdef __VISUALC__
715 #pragma warning(disable:4063)
716 #endif // VC++
717
718 static wxChar s_szBuf[256];
719 switch ( format ) {
720 case CF_TEXT: return wxT("CF_TEXT");
721 case CF_BITMAP: return wxT("CF_BITMAP");
722 case CF_METAFILEPICT: return wxT("CF_METAFILEPICT");
723 case CF_SYLK: return wxT("CF_SYLK");
724 case CF_DIF: return wxT("CF_DIF");
725 case CF_TIFF: return wxT("CF_TIFF");
726 case CF_OEMTEXT: return wxT("CF_OEMTEXT");
727 case CF_DIB: return wxT("CF_DIB");
728 case CF_PALETTE: return wxT("CF_PALETTE");
729 case CF_PENDATA: return wxT("CF_PENDATA");
730 case CF_RIFF: return wxT("CF_RIFF");
731 case CF_WAVE: return wxT("CF_WAVE");
732 case CF_UNICODETEXT: return wxT("CF_UNICODETEXT");
733 case CF_ENHMETAFILE: return wxT("CF_ENHMETAFILE");
734 case CF_HDROP: return wxT("CF_HDROP");
735 case CF_LOCALE: return wxT("CF_LOCALE");
736
737 default:
738 if ( !::GetClipboardFormatName(format, s_szBuf, WXSIZEOF(s_szBuf)) )
739 {
740 // it must be a new predefined format we don't know the name of
741 wxSprintf(s_szBuf, wxT("unknown CF (0x%04x)"), format.GetFormatId());
742 }
743
744 return s_szBuf;
745 }
746
747 #ifdef __VISUALC__
748 #pragma warning(default:4063)
749 #endif // VC++
750 }
751
752 #endif // Debug
753
754 // ----------------------------------------------------------------------------
755 // wxBitmapDataObject supports CF_DIB format
756 // ----------------------------------------------------------------------------
757
758 size_t wxBitmapDataObject::GetDataSize() const
759 {
760 return wxConvertBitmapToDIB(NULL, GetBitmap());
761 }
762
763 bool wxBitmapDataObject::GetDataHere(void *buf) const
764 {
765 return wxConvertBitmapToDIB((LPBITMAPINFO)buf, GetBitmap()) != 0;
766 }
767
768 bool wxBitmapDataObject::SetData(size_t WXUNUSED(len), const void *buf)
769 {
770 wxBitmap bitmap(wxConvertDIBToBitmap((const LPBITMAPINFO)buf));
771
772 if ( !bitmap.Ok() ) {
773 wxFAIL_MSG(wxT("pasting/dropping invalid bitmap"));
774
775 return FALSE;
776 }
777
778 SetBitmap(bitmap);
779
780 return TRUE;
781 }
782
783 // ----------------------------------------------------------------------------
784 // wxBitmapDataObject2 supports CF_BITMAP format
785 // ----------------------------------------------------------------------------
786
787 // the bitmaps aren't passed by value as other types of data (i.e. by copying
788 // the data into a global memory chunk and passing it to the clipboard or
789 // another application or whatever), but by handle, so these generic functions
790 // don't make much sense to them.
791
792 size_t wxBitmapDataObject2::GetDataSize() const
793 {
794 return 0;
795 }
796
797 bool wxBitmapDataObject2::GetDataHere(void *pBuf) const
798 {
799 // we put a bitmap handle into pBuf
800 *(WXHBITMAP *)pBuf = GetBitmap().GetHBITMAP();
801
802 return TRUE;
803 }
804
805 bool wxBitmapDataObject2::SetData(size_t WXUNUSED(len), const void *pBuf)
806 {
807 HBITMAP hbmp = *(HBITMAP *)pBuf;
808
809 BITMAP bmp;
810 if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
811 {
812 wxLogLastError(wxT("GetObject(HBITMAP)"));
813 }
814
815 wxBitmap bitmap(bmp.bmWidth, bmp.bmHeight, bmp.bmPlanes);
816 bitmap.SetHBITMAP((WXHBITMAP)hbmp);
817
818 if ( !bitmap.Ok() ) {
819 wxFAIL_MSG(wxT("pasting/dropping invalid bitmap"));
820
821 return FALSE;
822 }
823
824 SetBitmap(bitmap);
825
826 return TRUE;
827 }
828
829 #if 0
830
831 size_t wxBitmapDataObject::GetDataSize(const wxDataFormat& format) const
832 {
833 if ( format.GetFormatId() == CF_DIB )
834 {
835 // create the DIB
836 ScreenHDC hdc;
837
838 // shouldn't be selected into a DC or GetDIBits() would fail
839 wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
840 wxT("can't copy bitmap selected into wxMemoryDC") );
841
842 // first get the info
843 BITMAPINFO bi;
844 if ( !GetDIBits(hdc, (HBITMAP)m_bitmap.GetHBITMAP(), 0, 0,
845 NULL, &bi, DIB_RGB_COLORS) )
846 {
847 wxLogLastError(wxT("GetDIBits(NULL)"));
848
849 return 0;
850 }
851
852 return sizeof(BITMAPINFO) + bi.bmiHeader.biSizeImage;
853 }
854 else // CF_BITMAP
855 {
856 // no data to copy - we don't pass HBITMAP via global memory
857 return 0;
858 }
859 }
860
861 bool wxBitmapDataObject::GetDataHere(const wxDataFormat& format,
862 void *pBuf) const
863 {
864 wxASSERT_MSG( m_bitmap.Ok(), wxT("copying invalid bitmap") );
865
866 HBITMAP hbmp = (HBITMAP)m_bitmap.GetHBITMAP();
867 if ( format.GetFormatId() == CF_DIB )
868 {
869 // create the DIB
870 ScreenHDC hdc;
871
872 // shouldn't be selected into a DC or GetDIBits() would fail
873 wxASSERT_MSG( !m_bitmap.GetSelectedInto(),
874 wxT("can't copy bitmap selected into wxMemoryDC") );
875
876 // first get the info
877 BITMAPINFO *pbi = (BITMAPINFO *)pBuf;
878 if ( !GetDIBits(hdc, hbmp, 0, 0, NULL, pbi, DIB_RGB_COLORS) )
879 {
880 wxLogLastError(wxT("GetDIBits(NULL)"));
881
882 return 0;
883 }
884
885 // and now copy the bits
886 if ( !GetDIBits(hdc, hbmp, 0, pbi->bmiHeader.biHeight, pbi + 1,
887 pbi, DIB_RGB_COLORS) )
888 {
889 wxLogLastError(wxT("GetDIBits"));
890
891 return FALSE;
892 }
893 }
894 else // CF_BITMAP
895 {
896 // we put a bitmap handle into pBuf
897 *(HBITMAP *)pBuf = hbmp;
898 }
899
900 return TRUE;
901 }
902
903 bool wxBitmapDataObject::SetData(const wxDataFormat& format,
904 size_t size, const void *pBuf)
905 {
906 HBITMAP hbmp;
907 if ( format.GetFormatId() == CF_DIB )
908 {
909 // here we get BITMAPINFO struct followed by the actual bitmap bits and
910 // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
911 ScreenHDC hdc;
912
913 BITMAPINFO *pbmi = (BITMAPINFO *)pBuf;
914 BITMAPINFOHEADER *pbmih = &pbmi->bmiHeader;
915 hbmp = CreateDIBitmap(hdc, pbmih, CBM_INIT,
916 pbmi + 1, pbmi, DIB_RGB_COLORS);
917 if ( !hbmp )
918 {
919 wxLogLastError(wxT("CreateDIBitmap"));
920 }
921
922 m_bitmap.SetWidth(pbmih->biWidth);
923 m_bitmap.SetHeight(pbmih->biHeight);
924 }
925 else // CF_BITMAP
926 {
927 // it's easy with bitmaps: we pass them by handle
928 hbmp = *(HBITMAP *)pBuf;
929
930 BITMAP bmp;
931 if ( !GetObject(hbmp, sizeof(BITMAP), &bmp) )
932 {
933 wxLogLastError(wxT("GetObject(HBITMAP)"));
934 }
935
936 m_bitmap.SetWidth(bmp.bmWidth);
937 m_bitmap.SetHeight(bmp.bmHeight);
938 m_bitmap.SetDepth(bmp.bmPlanes);
939 }
940
941 m_bitmap.SetHBITMAP((WXHBITMAP)hbmp);
942
943 wxASSERT_MSG( m_bitmap.Ok(), wxT("pasting invalid bitmap") );
944
945 return TRUE;
946 }
947
948 #endif // 0
949
950 // ----------------------------------------------------------------------------
951 // wxFileDataObject
952 // ----------------------------------------------------------------------------
953
954 bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *pData)
955 {
956 m_filenames.Empty();
957
958 // the documentation states that the first member of DROPFILES structure is
959 // a "DWORD offset of double NUL terminated file list". What they mean by
960 // this (I wonder if you see it immediately) is that the list starts at
961 // ((char *)&(pDropFiles.pFiles)) + pDropFiles.pFiles. We're also advised
962 // to use DragQueryFile to work with this structure, but not told where and
963 // how to get HDROP.
964 HDROP hdrop = (HDROP)pData; // NB: it works, but I'm not sure about it
965
966 // get number of files (magic value -1)
967 UINT nFiles = ::DragQueryFile(hdrop, (unsigned)-1, NULL, 0u);
968
969 wxCHECK_MSG ( nFiles != (UINT)-1, FALSE, wxT("wrong HDROP handle") );
970
971 // for each file get the length, allocate memory and then get the name
972 wxString str;
973 UINT len, n;
974 for ( n = 0; n < nFiles; n++ ) {
975 // +1 for terminating NUL
976 len = ::DragQueryFile(hdrop, n, NULL, 0) + 1;
977
978 UINT len2 = ::DragQueryFile(hdrop, n, str.GetWriteBuf(len), len);
979 str.UngetWriteBuf();
980 m_filenames.Add(str);
981
982 if ( len2 != len - 1 ) {
983 wxLogDebug(wxT("In wxFileDropTarget::OnDrop DragQueryFile returned\
984 %d characters, %d expected."), len2, len - 1);
985 }
986 }
987
988 return TRUE;
989 }
990
991 void wxFileDataObject::AddFile(const wxString& file)
992 {
993 // just add file to filenames array
994 // all useful data (such as DROPFILES struct) will be
995 // created later as necessary
996 m_filenames.Add(file);
997 }
998
999 size_t wxFileDataObject::GetDataSize() const
1000 {
1001 // size returned will be the size of the DROPFILES structure,
1002 // plus the list of filesnames (null byte separated), plus
1003 // a double null at the end
1004
1005 // if no filenames in list, size is 0
1006 if ( m_filenames.GetCount() == 0 )
1007 return 0;
1008
1009 // inital size of DROPFILES struct + null byte
1010 size_t sz = sizeof(DROPFILES) + 1;
1011
1012 size_t count = m_filenames.GetCount();
1013 for ( size_t i = 0; i < count; i++ )
1014 {
1015 // add filename length plus null byte
1016 sz += m_filenames[i].Len() + 1;
1017 }
1018
1019 return sz;
1020 }
1021
1022 bool wxFileDataObject::GetDataHere(void *pData) const
1023 {
1024 // pData points to an externally allocated memory block
1025 // created using the size returned by GetDataSize()
1026
1027 // if pData is NULL, or there are no files, return
1028 if ( !pData || m_filenames.GetCount() == 0 )
1029 return FALSE;
1030
1031 // convert data pointer to a DROPFILES struct pointer
1032 LPDROPFILES pDrop = (LPDROPFILES) pData;
1033
1034 // initialize DROPFILES struct
1035 pDrop->pFiles = sizeof(DROPFILES);
1036 pDrop->fNC = FALSE; // not non-client coords
1037 #if wxUSE_UNICODE
1038 pDrop->fWide = TRUE;
1039 #else // ANSI
1040 pDrop->fWide = FALSE;
1041 #endif // Unicode/Ansi
1042
1043 // set start of filenames list (null separated)
1044 wxChar *pbuf = (wxChar*) ((BYTE *)pDrop + sizeof(DROPFILES));
1045
1046 size_t count = m_filenames.GetCount();
1047 for (size_t i = 0; i < count; i++ )
1048 {
1049 // copy filename to pbuf and add null terminator
1050 size_t len = m_filenames[i].Len();
1051 memcpy(pbuf, m_filenames[i], len);
1052 pbuf += len;
1053 *pbuf++ = wxT('\0');
1054 }
1055
1056 // add final null terminator
1057 *pbuf = wxT('\0');
1058
1059 return TRUE;
1060 }
1061
1062 // ----------------------------------------------------------------------------
1063 // wxURLDataObject
1064 // ----------------------------------------------------------------------------
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& WXUNUSED(format) )
1073 {
1074 return 0;
1075 }
1076
1077 virtual const void* GetSizeFromBuffer( const void* buffer, size_t* size,
1078 const wxDataFormat& WXUNUSED(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 WXUNUSED(size),
1087 const wxDataFormat& WXUNUSED(format) )
1088 {
1089 return buffer;
1090 }
1091
1092 #if wxUSE_UNICODE
1093 virtual bool GetDataHere( void* buffer ) const
1094 {
1095 // CFSTR_SHELLURL is _always_ ANSI!
1096 wxCharBuffer char_buffer( GetDataSize() );
1097 wxCustomDataObject::GetDataHere( (void*)char_buffer.data() );
1098 wxString unicode_buffer( char_buffer );
1099 memcpy( buffer, unicode_buffer.c_str(),
1100 ( unicode_buffer.length() + 1 ) * sizeof(wxChar) );
1101
1102 return TRUE;
1103 }
1104 #endif
1105 };
1106
1107
1108
1109 wxURLDataObject::wxURLDataObject()
1110 {
1111 // we support CF_TEXT and CFSTR_SHELLURL formats which are basicly the same
1112 // but it seems that some browsers only provide one of them so we have to
1113 // support both
1114 Add(new wxTextDataObject);
1115 Add(new CFSTR_SHELLURLDataObject());
1116
1117 // we don't have any data yet
1118 m_dataObjectLast = NULL;
1119 }
1120
1121 bool wxURLDataObject::SetData(const wxDataFormat& format,
1122 size_t len,
1123 const void *buf)
1124 {
1125 m_dataObjectLast = GetObject(format);
1126
1127 wxCHECK_MSG( m_dataObjectLast, FALSE,
1128 wxT("unsupported format in wxURLDataObject"));
1129
1130 return m_dataObjectLast->SetData(len, buf);
1131 }
1132
1133 wxString wxURLDataObject::GetURL() const
1134 {
1135 wxString url;
1136 wxCHECK_MSG( m_dataObjectLast, url, _T("no data in wxURLDataObject") );
1137
1138 size_t len = m_dataObjectLast->GetDataSize();
1139
1140 m_dataObjectLast->GetDataHere(url.GetWriteBuf(len));
1141 url.UngetWriteBuf();
1142
1143 return url;
1144 }
1145
1146 void wxURLDataObject::SetURL(const wxString& url)
1147 {
1148 SetData(wxDataFormat(wxUSE_UNICODE ? wxDF_UNICODETEXT : wxDF_TEXT),
1149 url.Length()+1, url.c_str());
1150
1151 // CFSTR_SHELLURL is always supposed to be ANSI...
1152 wxWX2MBbuf urlA = (wxWX2MBbuf)url.mbc_str();
1153 size_t len = strlen(urlA);
1154 SetData(wxDataFormat(CFSTR_SHELLURL), len+1, (const char*)urlA);
1155 }
1156
1157 // ----------------------------------------------------------------------------
1158 // private functions
1159 // ----------------------------------------------------------------------------
1160
1161 static size_t wxGetNumOfBitmapColors(size_t bitsPerPixel)
1162 {
1163 switch ( bitsPerPixel )
1164 {
1165 case 1:
1166 // monochrome bitmap, 2 entries
1167 return 2;
1168
1169 case 4:
1170 return 16;
1171
1172 case 8:
1173 return 256;
1174
1175 case 24:
1176 // may be used with 24bit bitmaps, but we don't use it here - fall
1177 // through
1178
1179 case 16:
1180 case 32:
1181 // bmiColors not used at all with these bitmaps
1182 return 0;
1183
1184 default:
1185 wxFAIL_MSG( wxT("unknown bitmap format") );
1186 return 0;
1187 }
1188 }
1189
1190 size_t wxConvertBitmapToDIB(LPBITMAPINFO pbi, const wxBitmap& bitmap)
1191 {
1192 wxASSERT_MSG( bitmap.Ok(), wxT("invalid bmp can't be converted to DIB") );
1193
1194 // shouldn't be selected into a DC or GetDIBits() would fail
1195 wxASSERT_MSG( !bitmap.GetSelectedInto(),
1196 wxT("can't copy bitmap selected into wxMemoryDC") );
1197
1198 // prepare all the info we need
1199 BITMAP bm;
1200 HBITMAP hbmp = (HBITMAP)bitmap.GetHBITMAP();
1201 if ( !GetObject(hbmp, sizeof(bm), &bm) )
1202 {
1203 wxLogLastError(wxT("GetObject(bitmap)"));
1204
1205 return 0;
1206 }
1207
1208 // calculate the number of bits per pixel and the number of items in
1209 // bmiColors array (whose meaning depends on the bitmap format)
1210 WORD biBits = bm.bmPlanes * bm.bmBitsPixel;
1211 WORD biColors = (WORD)wxGetNumOfBitmapColors(biBits);
1212
1213 BITMAPINFO bi2;
1214
1215 bool wantSizeOnly = pbi == NULL;
1216 if ( wantSizeOnly )
1217 pbi = &bi2;
1218
1219 // just for convenience
1220 BITMAPINFOHEADER& bi = pbi->bmiHeader;
1221
1222 bi.biSize = sizeof(BITMAPINFOHEADER);
1223 bi.biWidth = bm.bmWidth;
1224 bi.biHeight = bm.bmHeight;
1225 bi.biPlanes = 1;
1226 bi.biBitCount = biBits;
1227 bi.biCompression = BI_RGB;
1228 bi.biSizeImage = 0;
1229 bi.biXPelsPerMeter = 0;
1230 bi.biYPelsPerMeter = 0;
1231 bi.biClrUsed = 0;
1232 bi.biClrImportant = 0;
1233
1234 // memory we need for BITMAPINFO only
1235 DWORD dwLen = bi.biSize + biColors * sizeof(RGBQUAD);
1236
1237 // first get the image size
1238 ScreenHDC hdc;
1239 if ( !GetDIBits(hdc, hbmp, 0, bi.biHeight, NULL, pbi, DIB_RGB_COLORS) )
1240 {
1241 wxLogLastError(wxT("GetDIBits(NULL)"));
1242
1243 return 0;
1244 }
1245
1246 if ( wantSizeOnly )
1247 {
1248 // size of the header + size of the image
1249 return dwLen + bi.biSizeImage;
1250 }
1251
1252 // and now copy the bits
1253 void *image = (char *)pbi + dwLen;
1254 if ( !GetDIBits(hdc, hbmp, 0, bi.biHeight, image, pbi, DIB_RGB_COLORS) )
1255 {
1256 wxLogLastError(wxT("GetDIBits"));
1257
1258 return 0;
1259 }
1260
1261 return dwLen + bi.biSizeImage;
1262 }
1263
1264 wxBitmap wxConvertDIBToBitmap(const LPBITMAPINFO pbmi)
1265 {
1266 // here we get BITMAPINFO struct followed by the actual bitmap bits and
1267 // BITMAPINFO starts with BITMAPINFOHEADER followed by colour info
1268 const BITMAPINFOHEADER *pbmih = &pbmi->bmiHeader;
1269
1270 // biClrUsed has the number of colors, unless it's 0
1271 int numColors = pbmih->biClrUsed;
1272 if (numColors==0)
1273 {
1274 numColors = wxGetNumOfBitmapColors(pbmih->biBitCount);
1275 }
1276
1277 // offset of image from the beginning of the header
1278 DWORD ofs = numColors * sizeof(RGBQUAD);
1279 void *image = (char *)pbmih + sizeof(BITMAPINFOHEADER) + ofs;
1280
1281 ScreenHDC hdc;
1282 HBITMAP hbmp = CreateDIBitmap(hdc, pbmih, CBM_INIT,
1283 image, pbmi, DIB_RGB_COLORS);
1284 if ( !hbmp )
1285 {
1286 wxLogLastError(wxT("CreateDIBitmap"));
1287 }
1288
1289 wxBitmap bitmap(pbmih->biWidth, pbmih->biHeight, pbmih->biBitCount);
1290 bitmap.SetHBITMAP((WXHBITMAP)hbmp);
1291
1292 return bitmap;
1293 }
1294
1295 #ifdef __WXDEBUG__
1296
1297 static const wxChar *GetTymedName(DWORD tymed)
1298 {
1299 static wxChar s_szBuf[128];
1300 switch ( tymed ) {
1301 case TYMED_HGLOBAL: return wxT("TYMED_HGLOBAL");
1302 case TYMED_FILE: return wxT("TYMED_FILE");
1303 case TYMED_ISTREAM: return wxT("TYMED_ISTREAM");
1304 case TYMED_ISTORAGE: return wxT("TYMED_ISTORAGE");
1305 case TYMED_GDI: return wxT("TYMED_GDI");
1306 case TYMED_MFPICT: return wxT("TYMED_MFPICT");
1307 case TYMED_ENHMF: return wxT("TYMED_ENHMF");
1308 default:
1309 wxSprintf(s_szBuf, wxT("type of media format %ld (unknown)"), tymed);
1310 return s_szBuf;
1311 }
1312 }
1313
1314 #endif // Debug
1315
1316 #else // not using OLE at all
1317 // ----------------------------------------------------------------------------
1318 // wxDataObject
1319 // ----------------------------------------------------------------------------
1320
1321 wxDataObject::wxDataObject()
1322 {
1323 }
1324
1325 wxDataObject::~wxDataObject()
1326 {
1327 }
1328
1329 void wxDataObject::SetAutoDelete()
1330 {
1331 }
1332
1333 #ifdef __WXDEBUG__
1334 const wxChar *wxDataObject::GetFormatName(wxDataFormat format)
1335 {
1336 return NULL;
1337 }
1338 #endif
1339
1340 #endif
1341