2 * OLE 2 clipboard support
4 * Copyright 1999 Noel Borthwick <noel@macadamian.com>
5 * Copyright 2000 Abey George <abey@macadamian.com>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 * This file contains the implementation for the OLE Clipboard and its
23 * internal interfaces. The OLE clipboard interacts with an IDataObject
24 * interface via the OleSetClipboard, OleGetClipboard and
25 * OleIsCurrentClipboard API's. An internal IDataObject delegates
26 * to a client supplied IDataObject or the WIN32 clipboard API depending
27 * on whether OleSetClipboard has been invoked.
28 * Here are some operating scenarios:
30 * 1. OleSetClipboard called: In this case the internal IDataObject
31 * delegates to the client supplied IDataObject. Additionally OLE takes
32 * ownership of the Windows clipboard and any HGLOCBAL IDataObject
33 * items are placed on the Windows clipboard. This allows non OLE aware
34 * applications to access these. A local WinProc fields WM_RENDERFORMAT
35 * and WM_RENDERALLFORMATS messages in this case.
37 * 2. OleGetClipboard called without previous OleSetClipboard. Here the internal
38 * IDataObject functionality wraps around the WIN32 clipboard API.
40 * 3. OleGetClipboard called after previous OleSetClipboard. Here the internal
41 * IDataObject delegates to the source IDataObjects functionality directly,
42 * thereby bypassing the Windows clipboard.
44 * Implementation references : Inside OLE 2'nd edition by Kraig Brockschmidt
47 * - Support for pasting between different processes. OLE clipboard support
48 * currently works only for in process copy and paste. Since we internally
49 * store a pointer to the source's IDataObject and delegate to that, this
50 * will fail if the IDataObject client belongs to a different process.
51 * - IDataObject::GetDataHere is not implemented
52 * - OleFlushClipboard needs to additionally handle TYMED_IStorage media
53 * by copying the storage into global memory. Subsequently the default
54 * data object exposed through OleGetClipboard must convert this TYMED_HGLOBAL
55 * back to TYMED_IStorage.
56 * - OLE1 compatibility formats to be synthesized from OLE2 formats and put on
57 * clipboard in OleSetClipboard.
67 #define NONAMELESSUNION
76 #include "wine/debug.h"
79 #include "storage32.h"
81 #include "compobj_private.h"
83 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
85 /* Structure of 'Ole Private Data' clipboard format */
89 DWORD first_use
; /* Has this cf been added to the list already */
91 } ole_priv_data_entry
;
96 DWORD size
; /* in bytes of the entire structure */
98 DWORD count
; /* no. of format entries */
100 ole_priv_data_entry entries
[1]; /* array of size count */
101 /* then follows any DVTARGETDEVICE structures referenced in the FORMATETCs */
104 /*****************************************************************************
107 * Returns a ptr to a target device at a given offset from the
108 * start of the ole_priv_data.
110 * Used when unpacking ole private data from the clipboard.
112 static inline DVTARGETDEVICE
*td_offs_to_ptr(ole_priv_data
*data
, DWORD_PTR off
)
114 if(off
== 0) return NULL
;
115 return (DVTARGETDEVICE
*)((char*)data
+ off
);
118 /*****************************************************************************
121 * Get the offset from the start of the ole_priv_data of the idx'th
124 * Used when packing ole private data to the clipboard.
126 static inline DWORD_PTR
td_get_offs(ole_priv_data
*data
, DWORD idx
)
128 if(data
->entries
[idx
].fmtetc
.ptd
== NULL
) return 0;
129 return (char*)data
->entries
[idx
].fmtetc
.ptd
- (char*)data
;
132 /****************************************************************************
133 * Consumer snapshot. Represents the state of the ole clipboard
134 * returned by OleGetClipboard().
136 typedef struct snapshot
138 IDataObject IDataObject_iface
;
141 DWORD seq_no
; /* Clipboard sequence number corresponding to this snapshot */
143 IDataObject
*data
; /* If we unmarshal a remote data object we hold a ref here */
146 /****************************************************************************
149 typedef struct ole_clipbrd
151 snapshot
*latest_snapshot
; /* Latest consumer snapshot */
153 HWND window
; /* Hidden clipboard window */
154 IDataObject
*src_data
; /* Source object passed to OleSetClipboard */
155 ole_priv_data
*cached_enum
; /* Cached result from the enumeration of src data object */
156 IStream
*marshal_data
; /* Stream onto which to marshal src_data */
159 static inline snapshot
*impl_from_IDataObject(IDataObject
*iface
)
161 return CONTAINING_RECORD(iface
, snapshot
, IDataObject_iface
);
164 typedef struct PresentationDataHeader
167 DWORD dwObjectExtentX
;
168 DWORD dwObjectExtentY
;
170 } PresentationDataHeader
;
173 * The one and only ole_clipbrd object which is created by OLEClipbrd_Initialize()
175 static ole_clipbrd
* theOleClipboard
;
177 static CRITICAL_SECTION latest_snapshot_cs
;
178 static CRITICAL_SECTION_DEBUG latest_snapshot_cs_debug
=
180 0, 0, &latest_snapshot_cs
,
181 { &latest_snapshot_cs_debug
.ProcessLocksList
, &latest_snapshot_cs_debug
.ProcessLocksList
},
182 0, 0, { (DWORD_PTR
)(__FILE__
": clipboard last snapshot") }
184 static CRITICAL_SECTION latest_snapshot_cs
= { &latest_snapshot_cs_debug
, -1, 0, 0, 0, 0 };
186 static inline HRESULT
get_ole_clipbrd(ole_clipbrd
**clipbrd
)
188 struct oletls
*info
= COM_CurrentInfo();
192 return CO_E_NOTINITIALIZED
;
193 *clipbrd
= theOleClipboard
;
199 * Name of our registered OLE clipboard window class
201 static const WCHAR clipbrd_wndclass
[] = {'C','L','I','P','B','R','D','W','N','D','C','L','A','S','S',0};
203 UINT ownerlink_clipboard_format
= 0;
204 UINT filename_clipboard_format
= 0;
205 UINT filenameW_clipboard_format
= 0;
206 UINT dataobject_clipboard_format
= 0;
207 UINT embedded_object_clipboard_format
= 0;
208 UINT embed_source_clipboard_format
= 0;
209 UINT custom_link_source_clipboard_format
= 0;
210 UINT link_source_clipboard_format
= 0;
211 UINT object_descriptor_clipboard_format
= 0;
212 UINT link_source_descriptor_clipboard_format
= 0;
213 UINT ole_private_data_clipboard_format
= 0;
215 static UINT wine_marshal_clipboard_format
;
217 static inline const char *dump_fmtetc(FORMATETC
*fmt
)
219 if (!fmt
) return "(null)";
220 return wine_dbg_sprintf("cf %04x ptd %p aspect %x lindex %d tymed %x",
221 fmt
->cfFormat
, fmt
->ptd
, fmt
->dwAspect
, fmt
->lindex
, fmt
->tymed
);
224 /*---------------------------------------------------------------------*
225 * Implementation of the internal IEnumFORMATETC interface returned by
226 * the OLE clipboard's IDataObject.
227 *---------------------------------------------------------------------*/
229 typedef struct enum_fmtetc
231 IEnumFORMATETC IEnumFORMATETC_iface
;
234 UINT pos
; /* current enumerator position */
238 static inline enum_fmtetc
*impl_from_IEnumFORMATETC(IEnumFORMATETC
*iface
)
240 return CONTAINING_RECORD(iface
, enum_fmtetc
, IEnumFORMATETC_iface
);
243 /************************************************************************
244 * OLEClipbrd_IEnumFORMATETC_QueryInterface (IUnknown)
246 * See Windows documentation for more details on IUnknown methods.
248 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_QueryInterface
249 (LPENUMFORMATETC iface
, REFIID riid
, LPVOID
* ppvObj
)
251 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
253 TRACE("(%p)->(IID: %s, %p)\n", This
, debugstr_guid(riid
), ppvObj
);
257 if(IsEqualIID(riid
, &IID_IUnknown
) ||
258 IsEqualIID(riid
, &IID_IEnumFORMATETC
))
265 IEnumFORMATETC_AddRef((IEnumFORMATETC
*)*ppvObj
);
266 TRACE("-- Interface: (%p)->(%p)\n",ppvObj
,*ppvObj
);
270 TRACE("-- Interface: E_NOINTERFACE\n");
271 return E_NOINTERFACE
;
274 /************************************************************************
275 * OLEClipbrd_IEnumFORMATETC_AddRef (IUnknown)
278 static ULONG WINAPI
OLEClipbrd_IEnumFORMATETC_AddRef(LPENUMFORMATETC iface
)
280 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
281 TRACE("(%p)->(count=%u)\n",This
, This
->ref
);
283 return InterlockedIncrement(&This
->ref
);
286 /************************************************************************
287 * OLEClipbrd_IEnumFORMATETC_Release (IUnknown)
289 * See Windows documentation for more details on IUnknown methods.
291 static ULONG WINAPI
OLEClipbrd_IEnumFORMATETC_Release(LPENUMFORMATETC iface
)
293 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
296 TRACE("(%p)->(count=%u)\n",This
, This
->ref
);
298 ref
= InterlockedDecrement(&This
->ref
);
301 TRACE("() - destroying IEnumFORMATETC(%p)\n",This
);
302 HeapFree(GetProcessHeap(), 0, This
->data
);
303 HeapFree(GetProcessHeap(), 0, This
);
308 /************************************************************************
309 * OLEClipbrd_IEnumFORMATETC_Next (IEnumFORMATETC)
311 * Standard enumerator members for IEnumFORMATETC
313 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Next
314 (LPENUMFORMATETC iface
, ULONG celt
, FORMATETC
*rgelt
, ULONG
*pceltFethed
)
316 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
318 HRESULT hres
= S_FALSE
;
320 TRACE("(%p)->(pos=%u)\n", This
, This
->pos
);
322 if (This
->pos
< This
->data
->count
)
324 cfetch
= This
->data
->count
- This
->pos
;
331 for(i
= 0; i
< cfetch
; i
++)
333 hres
= copy_formatetc(rgelt
+ i
, &This
->data
->entries
[This
->pos
++].fmtetc
);
334 if(FAILED(hres
)) return hres
;
344 *pceltFethed
= cfetch
;
350 /************************************************************************
351 * OLEClipbrd_IEnumFORMATETC_Skip (IEnumFORMATETC)
353 * Standard enumerator members for IEnumFORMATETC
355 static HRESULT WINAPI
OLEClipbrd_IEnumFORMATETC_Skip(LPENUMFORMATETC iface
, ULONG celt
)
357 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
358 TRACE("(%p)->(num=%u)\n", This
, celt
);
361 if (This
->pos
> This
->data
->count
)
363 This
->pos
= This
->data
->count
;
369 /************************************************************************
370 * OLEClipbrd_IEnumFORMATETC_Reset (IEnumFORMATETC)
372 * Standard enumerator members for IEnumFORMATETC
374 static HRESULT WINAPI
OLEClipbrd_IEnumFORMATETC_Reset(LPENUMFORMATETC iface
)
376 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
377 TRACE("(%p)->()\n", This
);
383 static HRESULT
enum_fmtetc_construct(ole_priv_data
*data
, UINT pos
, IEnumFORMATETC
**obj
);
385 /************************************************************************
386 * OLEClipbrd_IEnumFORMATETC_Clone (IEnumFORMATETC)
388 * Standard enumerator members for IEnumFORMATETC
390 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Clone
391 (LPENUMFORMATETC iface
, LPENUMFORMATETC
* obj
)
393 enum_fmtetc
*This
= impl_from_IEnumFORMATETC(iface
);
394 ole_priv_data
*new_data
;
397 TRACE("(%p)->(%p)\n", This
, obj
);
399 if ( !obj
) return E_INVALIDARG
;
402 new_data
= HeapAlloc(GetProcessHeap(), 0, This
->data
->size
);
403 if(!new_data
) return E_OUTOFMEMORY
;
404 memcpy(new_data
, This
->data
, This
->data
->size
);
406 /* Fixup any target device ptrs */
407 for(i
= 0; i
< This
->data
->count
; i
++)
408 new_data
->entries
[i
].fmtetc
.ptd
=
409 td_offs_to_ptr(new_data
, td_get_offs(This
->data
, i
));
411 return enum_fmtetc_construct(new_data
, This
->pos
, obj
);
414 static const IEnumFORMATETCVtbl efvt
=
416 OLEClipbrd_IEnumFORMATETC_QueryInterface
,
417 OLEClipbrd_IEnumFORMATETC_AddRef
,
418 OLEClipbrd_IEnumFORMATETC_Release
,
419 OLEClipbrd_IEnumFORMATETC_Next
,
420 OLEClipbrd_IEnumFORMATETC_Skip
,
421 OLEClipbrd_IEnumFORMATETC_Reset
,
422 OLEClipbrd_IEnumFORMATETC_Clone
425 /************************************************************************
426 * enum_fmtetc_construct
428 * Creates an IEnumFORMATETC enumerator from ole_priv_data which it then owns.
430 static HRESULT
enum_fmtetc_construct(ole_priv_data
*data
, UINT pos
, IEnumFORMATETC
**obj
)
435 ef
= HeapAlloc(GetProcessHeap(), 0, sizeof(*ef
));
436 if (!ef
) return E_OUTOFMEMORY
;
439 ef
->IEnumFORMATETC_iface
.lpVtbl
= &efvt
;
443 TRACE("(%p)->()\n", ef
);
444 *obj
= &ef
->IEnumFORMATETC_iface
;
448 /***********************************************************************
451 * Helper method to duplicate an HGLOBAL chunk of memory
453 static HRESULT
dup_global_mem( HGLOBAL src
, DWORD flags
, HGLOBAL
*dst
)
455 void *src_ptr
, *dst_ptr
;
459 if ( !src
) return S_FALSE
;
461 size
= GlobalSize(src
);
463 *dst
= GlobalAlloc( flags
, size
);
464 if ( !*dst
) return E_OUTOFMEMORY
;
466 src_ptr
= GlobalLock(src
);
467 dst_ptr
= GlobalLock(*dst
);
469 memcpy(dst_ptr
, src_ptr
, size
);
477 /***********************************************************************
480 * Helper function to duplicate a handle to a METAFILEPICT, and the
481 * contained HMETAFILE.
483 static HRESULT
dup_metafilepict(HGLOBAL src
, HGLOBAL
*pdest
)
487 METAFILEPICT
*dest_ptr
;
491 /* Copy the METAFILEPICT structure. */
492 hr
= dup_global_mem(src
, GMEM_DDESHARE
|GMEM_MOVEABLE
, &dest
);
493 if (FAILED(hr
)) return hr
;
495 dest_ptr
= GlobalLock(dest
);
496 if (!dest_ptr
) return E_FAIL
;
498 /* Give the new METAFILEPICT a separate HMETAFILE. */
499 dest_ptr
->hMF
= CopyMetaFileW(dest_ptr
->hMF
, NULL
);
514 /***********************************************************************
517 * Helper function to GlobalFree a handle to a METAFILEPICT, and also
518 * free the contained HMETAFILE.
520 static void free_metafilepict(HGLOBAL src
)
522 METAFILEPICT
*src_ptr
;
524 src_ptr
= GlobalLock(src
);
527 DeleteMetaFile(src_ptr
->hMF
);
533 /***********************************************************************
536 * Helper function to duplicate an HBITMAP.
538 static HRESULT
dup_bitmap(HBITMAP src
, HBITMAP
*pdest
)
541 HGDIOBJ orig_src_bitmap
;
545 src_dc
= CreateCompatibleDC(NULL
);
546 orig_src_bitmap
= SelectObject(src_dc
, src
);
547 GetObjectW(src
, sizeof bm
, &bm
);
548 dest
= CreateCompatibleBitmap(src_dc
, bm
.bmWidth
, bm
.bmHeight
);
551 HDC dest_dc
= CreateCompatibleDC(NULL
);
552 HGDIOBJ orig_dest_bitmap
= SelectObject(dest_dc
, dest
);
553 BitBlt(dest_dc
, 0, 0, bm
.bmWidth
, bm
.bmHeight
, src_dc
, 0, 0, SRCCOPY
);
554 SelectObject(dest_dc
, orig_dest_bitmap
);
557 SelectObject(src_dc
, orig_src_bitmap
);
560 return dest
? S_OK
: E_FAIL
;
563 /************************************************************
564 * render_embed_source_hack
566 * This is clearly a hack and has no place in the clipboard code.
569 static HRESULT
render_embed_source_hack(IDataObject
*data
, LPFORMATETC fmt
)
572 HGLOBAL hStorage
= 0;
574 ILockBytes
*ptrILockBytes
;
576 memset(&std
, 0, sizeof(STGMEDIUM
));
577 std
.tymed
= fmt
->tymed
= TYMED_ISTORAGE
;
579 hStorage
= GlobalAlloc(GMEM_SHARE
|GMEM_MOVEABLE
, 0);
580 if (hStorage
== NULL
) return E_OUTOFMEMORY
;
581 hr
= CreateILockBytesOnHGlobal(hStorage
, FALSE
, &ptrILockBytes
);
584 GlobalFree(hStorage
);
588 hr
= StgCreateDocfileOnILockBytes(ptrILockBytes
, STGM_SHARE_EXCLUSIVE
|STGM_READWRITE
, 0, &std
.u
.pstg
);
589 ILockBytes_Release(ptrILockBytes
);
591 if (FAILED(hr
= IDataObject_GetDataHere(theOleClipboard
->src_data
, fmt
, &std
)))
593 WARN("() : IDataObject_GetDataHere failed to render clipboard data! (%x)\n", hr
);
594 GlobalFree(hStorage
);
598 if (1) /* check whether the presentation data is already -not- present */
602 METAFILEPICT
*mfp
= 0;
604 fmt2
.cfFormat
= CF_METAFILEPICT
;
606 fmt2
.dwAspect
= DVASPECT_CONTENT
;
608 fmt2
.tymed
= TYMED_MFPICT
;
610 memset(&std2
, 0, sizeof(STGMEDIUM
));
611 std2
.tymed
= TYMED_MFPICT
;
613 /* Get the metafile picture out of it */
615 if (SUCCEEDED(hr
= IDataObject_GetData(theOleClipboard
->src_data
, &fmt2
, &std2
)))
617 mfp
= GlobalLock(std2
.u
.hGlobal
);
622 OLECHAR name
[]={ 2, 'O', 'l', 'e', 'P', 'r', 'e', 's', '0', '0', '0', 0};
623 IStream
*pStream
= 0;
625 PresentationDataHeader pdh
;
629 CHAR strOleTypeName
[51];
630 BYTE OlePresStreamHeader
[] =
632 0xFF, 0xFF, 0xFF, 0xFF, 0x03, 0x00, 0x00, 0x00,
633 0x04, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
634 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00,
635 0x00, 0x00, 0x00, 0x00
638 nSize
= GetMetaFileBitsEx(mfp
->hMF
, 0, NULL
);
640 memset(&pdh
, 0, sizeof(PresentationDataHeader
));
641 memcpy(&pdh
, OlePresStreamHeader
, sizeof(OlePresStreamHeader
));
643 pdh
.dwObjectExtentX
= mfp
->xExt
;
644 pdh
.dwObjectExtentY
= mfp
->yExt
;
647 hr
= IStorage_CreateStream(std
.u
.pstg
, name
, STGM_CREATE
|STGM_SHARE_EXCLUSIVE
|STGM_READWRITE
, 0, 0, &pStream
);
649 hr
= IStream_Write(pStream
, &pdh
, sizeof(PresentationDataHeader
), NULL
);
651 mfBits
= HeapAlloc(GetProcessHeap(), 0, nSize
);
652 nSize
= GetMetaFileBitsEx(mfp
->hMF
, nSize
, mfBits
);
654 hr
= IStream_Write(pStream
, mfBits
, nSize
, NULL
);
656 IStream_Release(pStream
);
658 HeapFree(GetProcessHeap(), 0, mfBits
);
660 GlobalUnlock(std2
.u
.hGlobal
);
661 ReleaseStgMedium(&std2
);
663 ReadClassStg(std
.u
.pstg
, &clsID
);
664 ProgIDFromCLSID(&clsID
, &strProgID
);
666 WideCharToMultiByte( CP_ACP
, 0, strProgID
, -1, strOleTypeName
, sizeof(strOleTypeName
), NULL
, NULL
);
667 STORAGE_CreateOleStream(std
.u
.pstg
, 0);
668 OLECONVERT_CreateCompObjStream(std
.u
.pstg
, strOleTypeName
);
669 CoTaskMemFree(strProgID
);
673 if ( !SetClipboardData( fmt
->cfFormat
, hStorage
) )
675 WARN("() : Failed to set rendered clipboard data into clipboard!\n");
676 GlobalFree(hStorage
);
677 hr
= CLIPBRD_E_CANT_SET
;
680 ReleaseStgMedium(&std
);
684 /************************************************************************
685 * find_format_in_list
687 * Returns the first entry that matches the provided clipboard format.
689 static inline ole_priv_data_entry
*find_format_in_list(ole_priv_data_entry
*entries
, DWORD num
, UINT cf
)
692 for(i
= 0; i
< num
; i
++)
693 if(entries
[i
].fmtetc
.cfFormat
== cf
)
699 /***************************************************************************
700 * get_data_from_storage
702 * Returns storage data in an HGLOBAL.
704 static HRESULT
get_data_from_storage(IDataObject
*data
, FORMATETC
*fmt
, HGLOBAL
*mem
)
715 h
= GlobalAlloc( GMEM_DDESHARE
|GMEM_MOVEABLE
, 0 );
716 if(!h
) return E_OUTOFMEMORY
;
718 hr
= CreateILockBytesOnHGlobal(h
, FALSE
, &lbs
);
721 hr
= StgCreateDocfileOnILockBytes(lbs
, STGM_CREATE
|STGM_SHARE_EXCLUSIVE
|STGM_READWRITE
, 0, &stg
);
722 ILockBytes_Release(lbs
);
731 med
.tymed
= stg_fmt
.tymed
= TYMED_ISTORAGE
;
733 med
.pUnkForRelease
= NULL
;
735 hr
= IDataObject_GetDataHere(data
, &stg_fmt
, &med
);
738 memset(&med
, 0, sizeof(med
));
739 hr
= IDataObject_GetData(data
, &stg_fmt
, &med
);
740 if(FAILED(hr
)) goto end
;
742 hr
= IStorage_CopyTo(med
.u
.pstg
, 0, NULL
, NULL
, stg
);
743 ReleaseStgMedium(&med
);
744 if(FAILED(hr
)) goto end
;
749 IStorage_Release(stg
);
750 if(FAILED(hr
)) GlobalFree(h
);
754 /***************************************************************************
755 * get_data_from_stream
757 * Returns stream data in an HGLOBAL.
759 static HRESULT
get_data_from_stream(IDataObject
*data
, FORMATETC
*fmt
, HGLOBAL
*mem
)
769 h
= GlobalAlloc( GMEM_DDESHARE
|GMEM_MOVEABLE
, 0 );
770 if(!h
) return E_OUTOFMEMORY
;
772 hr
= CreateStreamOnHGlobal(h
, FALSE
, &stm
);
773 if(FAILED(hr
)) goto error
;
776 med
.tymed
= stm_fmt
.tymed
= TYMED_ISTREAM
;
778 med
.pUnkForRelease
= NULL
;
780 hr
= IDataObject_GetDataHere(data
, &stm_fmt
, &med
);
786 memset(&med
, 0, sizeof(med
));
787 hr
= IDataObject_GetData(data
, &stm_fmt
, &med
);
788 if(FAILED(hr
)) goto error
;
791 IStream_Seek(med
.u
.pstm
, offs
, STREAM_SEEK_CUR
, &pos
);
792 IStream_Seek(med
.u
.pstm
, offs
, STREAM_SEEK_SET
, NULL
);
793 hr
= IStream_CopyTo(med
.u
.pstm
, stm
, pos
, NULL
, NULL
);
794 ReleaseStgMedium(&med
);
795 if(FAILED(hr
)) goto error
;
798 IStream_Release(stm
);
802 if(stm
) IStream_Release(stm
);
807 /***************************************************************************
808 * get_data_from_global
810 * Returns global data in an HGLOBAL.
812 static HRESULT
get_data_from_global(IDataObject
*data
, FORMATETC
*fmt
, HGLOBAL
*mem
)
822 mem_fmt
.tymed
= TYMED_HGLOBAL
;
823 memset(&med
, 0, sizeof(med
));
825 hr
= IDataObject_GetData(data
, &mem_fmt
, &med
);
826 if(FAILED(hr
)) return hr
;
828 hr
= dup_global_mem(med
.u
.hGlobal
, GMEM_DDESHARE
|GMEM_MOVEABLE
, &h
);
830 if(SUCCEEDED(hr
)) *mem
= h
;
832 ReleaseStgMedium(&med
);
837 /***************************************************************************
838 * get_data_from_enhmetafile
840 static HRESULT
get_data_from_enhmetafile(IDataObject
*data
, FORMATETC
*fmt
, HGLOBAL
*mem
)
850 mem_fmt
.tymed
= TYMED_ENHMF
;
851 memset(&med
, 0, sizeof(med
));
853 hr
= IDataObject_GetData(data
, &mem_fmt
, &med
);
854 if(FAILED(hr
)) return hr
;
856 copy
= CopyEnhMetaFileW(med
.u
.hEnhMetaFile
, NULL
);
857 if(copy
) *mem
= (HGLOBAL
)copy
;
860 ReleaseStgMedium(&med
);
865 /***************************************************************************
866 * get_data_from_metafilepict
868 static HRESULT
get_data_from_metafilepict(IDataObject
*data
, FORMATETC
*fmt
, HGLOBAL
*mem
)
878 mem_fmt
.tymed
= TYMED_MFPICT
;
879 memset(&med
, 0, sizeof(med
));
881 hr
= IDataObject_GetData(data
, &mem_fmt
, &med
);
882 if(FAILED(hr
)) return hr
;
884 hr
= dup_metafilepict(med
.u
.hMetaFilePict
, ©
);
886 if(SUCCEEDED(hr
)) *mem
= copy
;
888 ReleaseStgMedium(&med
);
893 /***************************************************************************
894 * get_data_from_bitmap
896 * Returns bitmap in an HBITMAP.
898 static HRESULT
get_data_from_bitmap(IDataObject
*data
, FORMATETC
*fmt
, HBITMAP
*hbm
)
908 mem_fmt
.tymed
= TYMED_GDI
;
909 memset(&med
, 0, sizeof(med
));
911 hr
= IDataObject_GetData(data
, &mem_fmt
, &med
);
912 if(FAILED(hr
)) return hr
;
914 hr
= dup_bitmap(med
.u
.hBitmap
, ©
);
916 if(SUCCEEDED(hr
)) *hbm
= copy
;
918 ReleaseStgMedium(&med
);
923 /***********************************************************************
926 * Render the clipboard data. Note that this call will delegate to the
927 * source data object.
929 static HRESULT
render_format(IDataObject
*data
, LPFORMATETC fmt
)
931 HANDLE clip_data
= NULL
; /* HGLOBAL unless otherwise specified */
934 /* Embed source hack */
935 if(fmt
->cfFormat
== embed_source_clipboard_format
)
937 return render_embed_source_hack(data
, fmt
);
940 if(fmt
->tymed
& TYMED_ISTORAGE
)
942 hr
= get_data_from_storage(data
, fmt
, &clip_data
);
944 else if(fmt
->tymed
& TYMED_ISTREAM
)
946 hr
= get_data_from_stream(data
, fmt
, &clip_data
);
948 else if(fmt
->tymed
& TYMED_HGLOBAL
)
950 hr
= get_data_from_global(data
, fmt
, &clip_data
);
952 else if(fmt
->tymed
& TYMED_ENHMF
)
954 hr
= get_data_from_enhmetafile(data
, fmt
, &clip_data
);
956 else if(fmt
->tymed
& TYMED_MFPICT
)
958 /* Returns global handle to METAFILEPICT, containing a copied HMETAFILE */
959 hr
= get_data_from_metafilepict(data
, fmt
, &clip_data
);
961 else if(fmt
->tymed
& TYMED_GDI
)
963 /* Returns HBITMAP not HGLOBAL */
964 hr
= get_data_from_bitmap(data
, fmt
, (HBITMAP
*)&clip_data
);
968 FIXME("Unhandled tymed %x\n", fmt
->tymed
);
974 if ( !SetClipboardData(fmt
->cfFormat
, clip_data
) )
976 WARN("() : Failed to set rendered clipboard data into clipboard!\n");
977 if(fmt
->tymed
& TYMED_MFPICT
)
978 free_metafilepict(clip_data
);
979 else if(fmt
->tymed
& TYMED_GDI
)
980 DeleteObject(clip_data
);
982 GlobalFree(clip_data
);
983 hr
= CLIPBRD_E_CANT_SET
;
990 /*---------------------------------------------------------------------*
991 * Implementation of the internal IDataObject interface exposed by
993 *---------------------------------------------------------------------*/
996 /************************************************************************
997 * snapshot_QueryInterface
999 static HRESULT WINAPI
snapshot_QueryInterface(IDataObject
*iface
,
1000 REFIID riid
, void **ppvObject
)
1002 snapshot
*This
= impl_from_IDataObject(iface
);
1003 TRACE("(%p)->(IID:%s, %p)\n", This
, debugstr_guid(riid
), ppvObject
);
1005 if ( (This
==0) || (ppvObject
==0) )
1006 return E_INVALIDARG
;
1010 if (IsEqualIID(&IID_IUnknown
, riid
) ||
1011 IsEqualIID(&IID_IDataObject
, riid
))
1017 WARN( "() : asking for unsupported interface %s\n", debugstr_guid(riid
));
1018 return E_NOINTERFACE
;
1021 IUnknown_AddRef((IUnknown
*)*ppvObject
);
1026 /************************************************************************
1029 static ULONG WINAPI
snapshot_AddRef(IDataObject
*iface
)
1031 snapshot
*This
= impl_from_IDataObject(iface
);
1033 TRACE("(%p)->(count=%u)\n", This
, This
->ref
);
1035 return InterlockedIncrement(&This
->ref
);
1038 /************************************************************************
1041 static ULONG WINAPI
snapshot_Release(IDataObject
*iface
)
1043 snapshot
*This
= impl_from_IDataObject(iface
);
1046 TRACE("(%p)->(count=%u)\n", This
, This
->ref
);
1048 ref
= InterlockedDecrement(&This
->ref
);
1052 EnterCriticalSection(&latest_snapshot_cs
);
1055 LeaveCriticalSection(&latest_snapshot_cs
);
1058 if (theOleClipboard
->latest_snapshot
== This
)
1059 theOleClipboard
->latest_snapshot
= NULL
;
1060 LeaveCriticalSection(&latest_snapshot_cs
);
1062 if(This
->data
) IDataObject_Release(This
->data
);
1063 HeapFree(GetProcessHeap(), 0, This
);
1069 /************************************************************
1070 * get_current_ole_clip_window
1072 * Return the window that owns the ole clipboard.
1074 * If the clipboard is flushed or not owned by ole this will
1077 static HWND
get_current_ole_clip_window(void)
1082 h
= GetClipboardData(dataobject_clipboard_format
);
1084 ptr
= GlobalLock(h
);
1085 if(!ptr
) return NULL
;
1091 /************************************************************
1092 * get_current_dataobject
1094 * Return an unmarshalled IDataObject if there is a current
1095 * (ie non-flushed) object on the ole clipboard.
1097 static HRESULT
get_current_dataobject(IDataObject
**data
)
1099 HRESULT hr
= S_FALSE
;
1100 HWND wnd
= get_current_ole_clip_window();
1107 if(!wnd
) return S_FALSE
;
1109 h
= GetClipboardData(wine_marshal_clipboard_format
);
1110 if(!h
) return S_FALSE
;
1111 if(GlobalSize(h
) <= 1) return S_FALSE
;
1112 ptr
= GlobalLock(h
);
1113 if(!ptr
) return S_FALSE
;
1115 hr
= CreateStreamOnHGlobal(NULL
, TRUE
, &stm
);
1116 if(FAILED(hr
)) goto end
;
1118 hr
= IStream_Write(stm
, ptr
, GlobalSize(h
), NULL
);
1122 IStream_Seek(stm
, pos
, STREAM_SEEK_SET
, NULL
);
1123 hr
= CoUnmarshalInterface(stm
, &IID_IDataObject
, (void**)data
);
1125 IStream_Release(stm
);
1132 static DWORD
get_tymed_from_nonole_cf(UINT cf
)
1134 if(cf
>= 0xc000) return TYMED_ISTREAM
| TYMED_HGLOBAL
;
1140 case CF_UNICODETEXT
:
1141 return TYMED_ISTREAM
| TYMED_HGLOBAL
;
1142 case CF_ENHMETAFILE
:
1144 case CF_METAFILEPICT
:
1145 return TYMED_MFPICT
;
1149 FIXME("returning TYMED_NULL for cf %04x\n", cf
);
1154 /***********************************************************
1157 * Returns a copy of the Ole Private Data
1159 static HRESULT
get_priv_data(ole_priv_data
**data
)
1163 ole_priv_data
*ret
= NULL
;
1167 handle
= GetClipboardData( ole_private_data_clipboard_format
);
1170 ole_priv_data
*src
= GlobalLock(handle
);
1175 /* FIXME: sanity check on size */
1176 ret
= HeapAlloc(GetProcessHeap(), 0, src
->size
);
1179 GlobalUnlock(handle
);
1180 return E_OUTOFMEMORY
;
1182 memcpy(ret
, src
, src
->size
);
1183 GlobalUnlock(handle
);
1185 /* Fixup any target device offsets to ptrs */
1186 for(i
= 0; i
< ret
->count
; i
++)
1187 ret
->entries
[i
].fmtetc
.ptd
=
1188 td_offs_to_ptr(ret
, (DWORD_PTR
) ret
->entries
[i
].fmtetc
.ptd
);
1192 if(!ret
) /* Non-ole data */
1195 DWORD count
= 0, idx
, size
= FIELD_OFFSET(ole_priv_data
, entries
);
1197 for(cf
= 0; (cf
= EnumClipboardFormats(cf
)) != 0; count
++)
1200 if (GetClipboardFormatNameW(cf
, buf
, sizeof(buf
) / sizeof(WCHAR
)))
1201 TRACE("cf %04x %s\n", cf
, debugstr_w(buf
));
1203 TRACE("cf %04x\n", cf
);
1205 TRACE("count %d\n", count
);
1206 size
+= count
* sizeof(ret
->entries
[0]);
1208 /* There are holes in fmtetc so zero init */
1209 ret
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, size
);
1210 if(!ret
) return E_OUTOFMEMORY
;
1214 for(cf
= 0, idx
= 0; (cf
= EnumClipboardFormats(cf
)) != 0; idx
++)
1216 ret
->entries
[idx
].fmtetc
.cfFormat
= cf
;
1217 ret
->entries
[idx
].fmtetc
.ptd
= NULL
;
1218 ret
->entries
[idx
].fmtetc
.dwAspect
= DVASPECT_CONTENT
;
1219 ret
->entries
[idx
].fmtetc
.lindex
= -1;
1220 ret
->entries
[idx
].fmtetc
.tymed
= get_tymed_from_nonole_cf(cf
);
1221 ret
->entries
[idx
].first_use
= 1;
1229 /************************************************************************
1230 * get_stgmed_for_global
1232 * Returns a stg medium with a copy of the global handle
1234 static HRESULT
get_stgmed_for_global(HGLOBAL h
, STGMEDIUM
*med
)
1238 med
->pUnkForRelease
= NULL
;
1239 med
->tymed
= TYMED_NULL
;
1241 hr
= dup_global_mem(h
, GMEM_MOVEABLE
, &med
->u
.hGlobal
);
1243 if(SUCCEEDED(hr
)) med
->tymed
= TYMED_HGLOBAL
;
1248 /************************************************************************
1249 * get_stgmed_for_stream
1251 * Returns a stg medium with a stream based on the handle
1253 static HRESULT
get_stgmed_for_stream(HGLOBAL h
, STGMEDIUM
*med
)
1258 med
->pUnkForRelease
= NULL
;
1259 med
->tymed
= TYMED_NULL
;
1261 hr
= dup_global_mem(h
, GMEM_MOVEABLE
, &dst
);
1262 if(FAILED(hr
)) return hr
;
1264 hr
= CreateStreamOnHGlobal(dst
, TRUE
, &med
->u
.pstm
);
1271 med
->tymed
= TYMED_ISTREAM
;
1275 /************************************************************************
1276 * get_stgmed_for_storage
1278 * Returns a stg medium with a storage based on the handle
1280 static HRESULT
get_stgmed_for_storage(HGLOBAL h
, STGMEDIUM
*med
)
1286 med
->pUnkForRelease
= NULL
;
1287 med
->tymed
= TYMED_NULL
;
1289 hr
= dup_global_mem(h
, GMEM_MOVEABLE
, &dst
);
1290 if(FAILED(hr
)) return hr
;
1292 hr
= CreateILockBytesOnHGlobal(dst
, TRUE
, &lbs
);
1299 hr
= StgOpenStorageOnILockBytes(lbs
, NULL
, STGM_SHARE_EXCLUSIVE
| STGM_READWRITE
, NULL
, 0, &med
->u
.pstg
);
1300 ILockBytes_Release(lbs
);
1307 med
->tymed
= TYMED_ISTORAGE
;
1311 /************************************************************************
1312 * get_stgmed_for_emf
1314 * Returns a stg medium with an enhanced metafile based on the handle
1316 static HRESULT
get_stgmed_for_emf(HENHMETAFILE hemf
, STGMEDIUM
*med
)
1318 med
->pUnkForRelease
= NULL
;
1319 med
->tymed
= TYMED_NULL
;
1321 med
->u
.hEnhMetaFile
= CopyEnhMetaFileW(hemf
, NULL
);
1322 if(!med
->u
.hEnhMetaFile
) return E_OUTOFMEMORY
;
1323 med
->tymed
= TYMED_ENHMF
;
1327 /************************************************************************
1328 * get_stgmed_for_bitmap
1330 * Returns a stg medium with a bitmap based on the handle
1332 static HRESULT
get_stgmed_for_bitmap(HBITMAP hbmp
, STGMEDIUM
*med
)
1336 med
->pUnkForRelease
= NULL
;
1337 med
->tymed
= TYMED_NULL
;
1339 hr
= dup_bitmap(hbmp
, &med
->u
.hBitmap
);
1344 med
->tymed
= TYMED_GDI
;
1348 static inline BOOL
string_off_equal(const DVTARGETDEVICE
*t1
, WORD off1
, const DVTARGETDEVICE
*t2
, WORD off2
)
1350 const WCHAR
*str1
, *str2
;
1352 if(off1
== 0 && off2
== 0) return TRUE
;
1353 if(off1
== 0 || off2
== 0) return FALSE
;
1355 str1
= (const WCHAR
*)((const char*)t1
+ off1
);
1356 str2
= (const WCHAR
*)((const char*)t2
+ off2
);
1358 return !lstrcmpW(str1
, str2
);
1361 static inline BOOL
td_equal(const DVTARGETDEVICE
*t1
, const DVTARGETDEVICE
*t2
)
1363 if(t1
== NULL
&& t2
== NULL
) return TRUE
;
1364 if(t1
== NULL
|| t2
== NULL
) return FALSE
;
1366 if(!string_off_equal(t1
, t1
->tdDriverNameOffset
, t2
, t2
->tdDriverNameOffset
))
1368 if(!string_off_equal(t1
, t1
->tdDeviceNameOffset
, t2
, t2
->tdDeviceNameOffset
))
1370 if(!string_off_equal(t1
, t1
->tdPortNameOffset
, t2
, t2
->tdPortNameOffset
))
1373 /* FIXME check devmode? */
1378 /************************************************************************
1381 static HRESULT WINAPI
snapshot_GetData(IDataObject
*iface
, FORMATETC
*fmt
,
1384 snapshot
*This
= impl_from_IDataObject(iface
);
1387 ole_priv_data
*enum_data
= NULL
;
1388 ole_priv_data_entry
*entry
;
1391 TRACE("(%p, %p {%s}, %p)\n", iface
, fmt
, dump_fmtetc(fmt
), med
);
1393 if ( !fmt
|| !med
) return E_INVALIDARG
;
1395 memset(med
, 0, sizeof(*med
));
1397 if ( !OpenClipboard(NULL
)) return CLIPBRD_E_CANT_OPEN
;
1400 hr
= get_current_dataobject(&This
->data
);
1404 hr
= IDataObject_GetData(This
->data
, fmt
, med
);
1409 h
= GetClipboardData(fmt
->cfFormat
);
1412 hr
= DV_E_FORMATETC
;
1416 hr
= get_priv_data(&enum_data
);
1417 if(FAILED(hr
)) goto end
;
1419 entry
= find_format_in_list(enum_data
->entries
, enum_data
->count
, fmt
->cfFormat
);
1422 if(!td_equal(fmt
->ptd
, entry
->fmtetc
.ptd
))
1424 hr
= DV_E_FORMATETC
;
1427 mask
= fmt
->tymed
& entry
->fmtetc
.tymed
;
1428 if(!mask
) mask
= fmt
->tymed
& (TYMED_ISTREAM
| TYMED_HGLOBAL
);
1430 else /* non-Ole format */
1431 mask
= fmt
->tymed
& TYMED_HGLOBAL
;
1433 if(mask
& TYMED_ISTORAGE
)
1434 hr
= get_stgmed_for_storage(h
, med
);
1435 else if(mask
& TYMED_HGLOBAL
)
1436 hr
= get_stgmed_for_global(h
, med
);
1437 else if(mask
& TYMED_ISTREAM
)
1438 hr
= get_stgmed_for_stream(h
, med
);
1439 else if(mask
& TYMED_ENHMF
)
1440 hr
= get_stgmed_for_emf((HENHMETAFILE
)h
, med
);
1441 else if(mask
& TYMED_GDI
)
1442 hr
= get_stgmed_for_bitmap((HBITMAP
)h
, med
);
1445 FIXME("Unhandled tymed - mask %x req tymed %x\n", mask
, fmt
->tymed
);
1451 HeapFree(GetProcessHeap(), 0, enum_data
);
1452 if ( !CloseClipboard() ) hr
= CLIPBRD_E_CANT_CLOSE
;
1456 /************************************************************************
1457 * snapshot_GetDataHere
1459 static HRESULT WINAPI
snapshot_GetDataHere(IDataObject
*iface
, FORMATETC
*fmt
,
1462 snapshot
*This
= impl_from_IDataObject(iface
);
1465 ole_priv_data
*enum_data
= NULL
;
1466 ole_priv_data_entry
*entry
;
1469 if ( !fmt
|| !med
) return E_INVALIDARG
;
1471 TRACE("(%p, %p {%s}, %p (tymed %x)\n", iface
, fmt
, dump_fmtetc(fmt
), med
, med
->tymed
);
1473 if ( !OpenClipboard(NULL
)) return CLIPBRD_E_CANT_OPEN
;
1476 hr
= get_current_dataobject(&This
->data
);
1480 hr
= IDataObject_GetDataHere(This
->data
, fmt
, med
);
1488 h
= GetClipboardData(fmt
->cfFormat
);
1491 hr
= DV_E_FORMATETC
;
1495 hr
= get_priv_data(&enum_data
);
1496 if(FAILED(hr
)) goto end
;
1498 entry
= find_format_in_list(enum_data
->entries
, enum_data
->count
, fmt
->cfFormat
);
1501 if(!td_equal(fmt
->ptd
, entry
->fmtetc
.ptd
))
1503 hr
= DV_E_FORMATETC
;
1506 supported
= entry
->fmtetc
.tymed
;
1508 else /* non-Ole format */
1509 supported
= TYMED_HGLOBAL
;
1515 DWORD src_size
= GlobalSize(h
);
1516 DWORD dst_size
= GlobalSize(med
->u
.hGlobal
);
1518 if(dst_size
>= src_size
)
1520 void *src
= GlobalLock(h
);
1521 void *dst
= GlobalLock(med
->u
.hGlobal
);
1523 memcpy(dst
, src
, src_size
);
1524 GlobalUnlock(med
->u
.hGlobal
);
1532 DWORD src_size
= GlobalSize(h
);
1533 void *src
= GlobalLock(h
);
1534 hr
= IStream_Write(med
->u
.pstm
, src
, src_size
, NULL
);
1538 case TYMED_ISTORAGE
:
1541 if(!(supported
& TYMED_ISTORAGE
))
1546 hr
= get_stgmed_for_storage(h
, ©
);
1549 hr
= IStorage_CopyTo(copy
.u
.pstg
, 0, NULL
, NULL
, med
->u
.pstg
);
1550 ReleaseStgMedium(©
);
1555 FIXME("Unhandled tymed - supported %x req tymed %x\n", supported
, med
->tymed
);
1561 HeapFree(GetProcessHeap(), 0, enum_data
);
1562 if ( !CloseClipboard() ) hr
= CLIPBRD_E_CANT_CLOSE
;
1566 /************************************************************************
1567 * snapshot_QueryGetData
1569 * The OLE Clipboard's implementation of this method delegates to
1570 * a data source if there is one or wraps around the windows clipboard
1571 * function IsClipboardFormatAvailable() otherwise.
1574 static HRESULT WINAPI
snapshot_QueryGetData(IDataObject
*iface
, FORMATETC
*fmt
)
1576 FIXME("(%p, %p {%s})\n", iface
, fmt
, dump_fmtetc(fmt
));
1578 if (!fmt
) return E_INVALIDARG
;
1580 if ( fmt
->dwAspect
!= DVASPECT_CONTENT
) return DV_E_FORMATETC
;
1582 if ( fmt
->lindex
!= -1 ) return DV_E_FORMATETC
;
1584 return (IsClipboardFormatAvailable(fmt
->cfFormat
)) ? S_OK
: DV_E_CLIPFORMAT
;
1587 /************************************************************************
1588 * snapshot_GetCanonicalFormatEtc
1590 static HRESULT WINAPI
snapshot_GetCanonicalFormatEtc(IDataObject
*iface
, FORMATETC
*fmt_in
,
1593 TRACE("(%p, %p, %p)\n", iface
, fmt_in
, fmt_out
);
1595 if ( !fmt_in
|| !fmt_out
) return E_INVALIDARG
;
1598 return DATA_S_SAMEFORMATETC
;
1601 /************************************************************************
1604 * The OLE Clipboard does not implement this method
1606 static HRESULT WINAPI
snapshot_SetData(IDataObject
*iface
, FORMATETC
*fmt
,
1607 STGMEDIUM
*med
, BOOL release
)
1609 TRACE("(%p, %p, %p, %d): not implemented\n", iface
, fmt
, med
, release
);
1613 /************************************************************************
1614 * snapshot_EnumFormatEtc
1617 static HRESULT WINAPI
snapshot_EnumFormatEtc(IDataObject
*iface
, DWORD dir
,
1618 IEnumFORMATETC
**enum_fmt
)
1621 ole_priv_data
*data
= NULL
;
1623 TRACE("(%p, %x, %p)\n", iface
, dir
, enum_fmt
);
1627 if ( dir
!= DATADIR_GET
) return E_NOTIMPL
;
1628 if ( !OpenClipboard(NULL
) ) return CLIPBRD_E_CANT_OPEN
;
1630 hr
= get_priv_data(&data
);
1632 if(FAILED(hr
)) goto end
;
1634 hr
= enum_fmtetc_construct( data
, 0, enum_fmt
);
1637 if ( !CloseClipboard() ) hr
= CLIPBRD_E_CANT_CLOSE
;
1641 /************************************************************************
1644 * The OLE Clipboard does not implement this method
1646 static HRESULT WINAPI
snapshot_DAdvise(IDataObject
*iface
, FORMATETC
*fmt
,
1647 DWORD flags
, IAdviseSink
*sink
,
1650 TRACE("(%p, %p, %x, %p, %p): not implemented\n", iface
, fmt
, flags
, sink
, conn
);
1654 /************************************************************************
1655 * snapshot_DUnadvise
1657 * The OLE Clipboard does not implement this method
1659 static HRESULT WINAPI
snapshot_DUnadvise(IDataObject
* iface
, DWORD conn
)
1661 TRACE("(%p, %d): not implemented\n", iface
, conn
);
1665 /************************************************************************
1666 * snapshot_EnumDAdvise
1668 * The OLE Clipboard does not implement this method
1670 static HRESULT WINAPI
snapshot_EnumDAdvise(IDataObject
* iface
,
1671 IEnumSTATDATA
** enum_advise
)
1673 TRACE("(%p, %p): not implemented\n", iface
, enum_advise
);
1677 static const IDataObjectVtbl snapshot_vtable
=
1679 snapshot_QueryInterface
,
1683 snapshot_GetDataHere
,
1684 snapshot_QueryGetData
,
1685 snapshot_GetCanonicalFormatEtc
,
1687 snapshot_EnumFormatEtc
,
1690 snapshot_EnumDAdvise
1693 /*---------------------------------------------------------------------*
1694 * Internal implementation methods for the OLE clipboard
1695 *---------------------------------------------------------------------*/
1697 static snapshot
*snapshot_construct(DWORD seq_no
)
1701 This
= HeapAlloc( GetProcessHeap(), 0, sizeof(*This
) );
1702 if (!This
) return NULL
;
1704 This
->IDataObject_iface
.lpVtbl
= &snapshot_vtable
;
1706 This
->seq_no
= seq_no
;
1712 /*********************************************************
1713 * register_clipboard_formats
1715 static void register_clipboard_formats(void)
1717 static const WCHAR OwnerLink
[] = {'O','w','n','e','r','L','i','n','k',0};
1718 static const WCHAR FileName
[] = {'F','i','l','e','N','a','m','e',0};
1719 static const WCHAR FileNameW
[] = {'F','i','l','e','N','a','m','e','W',0};
1720 static const WCHAR DataObject
[] = {'D','a','t','a','O','b','j','e','c','t',0};
1721 static const WCHAR EmbeddedObject
[] = {'E','m','b','e','d','d','e','d',' ','O','b','j','e','c','t',0};
1722 static const WCHAR EmbedSource
[] = {'E','m','b','e','d',' ','S','o','u','r','c','e',0};
1723 static const WCHAR CustomLinkSource
[] = {'C','u','s','t','o','m',' ','L','i','n','k',' ','S','o','u','r','c','e',0};
1724 static const WCHAR LinkSource
[] = {'L','i','n','k',' ','S','o','u','r','c','e',0};
1725 static const WCHAR ObjectDescriptor
[] = {'O','b','j','e','c','t',' ','D','e','s','c','r','i','p','t','o','r',0};
1726 static const WCHAR LinkSourceDescriptor
[] = {'L','i','n','k',' ','S','o','u','r','c','e',' ',
1727 'D','e','s','c','r','i','p','t','o','r',0};
1728 static const WCHAR OlePrivateData
[] = {'O','l','e',' ','P','r','i','v','a','t','e',' ','D','a','t','a',0};
1730 static const WCHAR WineMarshalledDataObject
[] = {'W','i','n','e',' ','M','a','r','s','h','a','l','l','e','d',' ',
1731 'D','a','t','a','O','b','j','e','c','t',0};
1733 ownerlink_clipboard_format
= RegisterClipboardFormatW(OwnerLink
);
1734 filename_clipboard_format
= RegisterClipboardFormatW(FileName
);
1735 filenameW_clipboard_format
= RegisterClipboardFormatW(FileNameW
);
1736 dataobject_clipboard_format
= RegisterClipboardFormatW(DataObject
);
1737 embedded_object_clipboard_format
= RegisterClipboardFormatW(EmbeddedObject
);
1738 embed_source_clipboard_format
= RegisterClipboardFormatW(EmbedSource
);
1739 custom_link_source_clipboard_format
= RegisterClipboardFormatW(CustomLinkSource
);
1740 link_source_clipboard_format
= RegisterClipboardFormatW(LinkSource
);
1741 object_descriptor_clipboard_format
= RegisterClipboardFormatW(ObjectDescriptor
);
1742 link_source_descriptor_clipboard_format
= RegisterClipboardFormatW(LinkSourceDescriptor
);
1743 ole_private_data_clipboard_format
= RegisterClipboardFormatW(OlePrivateData
);
1745 wine_marshal_clipboard_format
= RegisterClipboardFormatW(WineMarshalledDataObject
);
1748 /***********************************************************************
1749 * OLEClipbrd_Initialize()
1750 * Initializes the OLE clipboard.
1752 void OLEClipbrd_Initialize(void)
1754 register_clipboard_formats();
1756 if ( !theOleClipboard
)
1758 ole_clipbrd
* clipbrd
;
1763 clipbrd
= HeapAlloc( GetProcessHeap(), 0, sizeof(*clipbrd
) );
1764 if (!clipbrd
) return;
1766 clipbrd
->latest_snapshot
= NULL
;
1767 clipbrd
->window
= NULL
;
1768 clipbrd
->src_data
= NULL
;
1769 clipbrd
->cached_enum
= NULL
;
1771 h
= GlobalAlloc(GMEM_DDESHARE
| GMEM_MOVEABLE
, 0);
1774 HeapFree(GetProcessHeap(), 0, clipbrd
);
1778 if(FAILED(CreateStreamOnHGlobal(h
, TRUE
, &clipbrd
->marshal_data
)))
1781 HeapFree(GetProcessHeap(), 0, clipbrd
);
1785 theOleClipboard
= clipbrd
;
1789 /*********************************************************************
1790 * set_clipboard_formats
1792 * Enumerate all formats supported by the source and make
1793 * those formats available using delayed rendering using SetClipboardData.
1794 * Cache the enumeration list and make that list visible as the
1795 * 'Ole Private Data' format on the clipboard.
1798 static HRESULT
set_clipboard_formats(ole_clipbrd
*clipbrd
, IDataObject
*data
)
1802 IEnumFORMATETC
*enum_fmt
;
1803 HGLOBAL priv_data_handle
;
1804 DWORD_PTR target_offset
;
1805 ole_priv_data
*priv_data
;
1806 DWORD count
= 0, needed
= sizeof(*priv_data
), idx
;
1808 hr
= IDataObject_EnumFormatEtc(data
, DATADIR_GET
, &enum_fmt
);
1809 if(FAILED(hr
)) return hr
;
1811 while(IEnumFORMATETC_Next(enum_fmt
, 1, &fmt
, NULL
) == S_OK
)
1814 needed
+= sizeof(priv_data
->entries
[0]);
1817 needed
+= fmt
.ptd
->tdSize
;
1818 CoTaskMemFree(fmt
.ptd
);
1822 /* Windows pads the list with two empty ole_priv_data_entries, one
1823 * after the entries array and one after the target device data.
1824 * Allocating with zero init to zero these pads. */
1826 needed
+= sizeof(priv_data
->entries
[0]); /* initialisation of needed includes one of these. */
1827 priv_data_handle
= GlobalAlloc(GMEM_DDESHARE
| GMEM_MOVEABLE
| GMEM_ZEROINIT
, needed
);
1828 priv_data
= GlobalLock(priv_data_handle
);
1830 priv_data
->unk1
= 0;
1831 priv_data
->size
= needed
;
1832 priv_data
->unk2
= 1;
1833 priv_data
->count
= count
;
1834 priv_data
->unk3
[0] = 0;
1835 priv_data
->unk3
[1] = 0;
1837 IEnumFORMATETC_Reset(enum_fmt
);
1840 target_offset
= FIELD_OFFSET(ole_priv_data
, entries
[count
+ 1]); /* count entries + one pad. */
1842 while(IEnumFORMATETC_Next(enum_fmt
, 1, &fmt
, NULL
) == S_OK
)
1844 TRACE("%s\n", dump_fmtetc(&fmt
));
1846 priv_data
->entries
[idx
].fmtetc
= fmt
;
1849 memcpy((char*)priv_data
+ target_offset
, fmt
.ptd
, fmt
.ptd
->tdSize
);
1850 priv_data
->entries
[idx
].fmtetc
.ptd
= (DVTARGETDEVICE
*)target_offset
;
1851 target_offset
+= fmt
.ptd
->tdSize
;
1852 CoTaskMemFree(fmt
.ptd
);
1855 priv_data
->entries
[idx
].first_use
= !find_format_in_list(priv_data
->entries
, idx
, fmt
.cfFormat
);
1856 priv_data
->entries
[idx
].unk
[0] = 0;
1857 priv_data
->entries
[idx
].unk
[1] = 0;
1859 if (priv_data
->entries
[idx
].first_use
)
1860 SetClipboardData(fmt
.cfFormat
, NULL
);
1865 IEnumFORMATETC_Release(enum_fmt
);
1867 /* Cache the list and fixup any target device offsets to ptrs */
1868 clipbrd
->cached_enum
= HeapAlloc(GetProcessHeap(), 0, needed
);
1869 memcpy(clipbrd
->cached_enum
, priv_data
, needed
);
1870 for(idx
= 0; idx
< clipbrd
->cached_enum
->count
; idx
++)
1871 clipbrd
->cached_enum
->entries
[idx
].fmtetc
.ptd
=
1872 td_offs_to_ptr(clipbrd
->cached_enum
, (DWORD_PTR
)clipbrd
->cached_enum
->entries
[idx
].fmtetc
.ptd
);
1874 GlobalUnlock(priv_data_handle
);
1875 if(!SetClipboardData(ole_private_data_clipboard_format
, priv_data_handle
))
1877 GlobalFree(priv_data_handle
);
1878 return CLIPBRD_E_CANT_SET
;
1884 static HWND
create_clipbrd_window(void);
1886 /***********************************************************************
1887 * get_clipbrd_window
1889 static inline HRESULT
get_clipbrd_window(ole_clipbrd
*clipbrd
, HWND
*wnd
)
1891 if ( !clipbrd
->window
)
1892 clipbrd
->window
= create_clipbrd_window();
1894 *wnd
= clipbrd
->window
;
1895 return *wnd
? S_OK
: E_FAIL
;
1899 /**********************************************************************
1900 * release_marshal_data
1902 * Releases the data and sets the stream back to zero size.
1904 static inline void release_marshal_data(IStream
*stm
)
1907 ULARGE_INTEGER size
;
1908 pos
.QuadPart
= size
.QuadPart
= 0;
1910 IStream_Seek(stm
, pos
, STREAM_SEEK_SET
, NULL
);
1911 CoReleaseMarshalData(stm
);
1912 IStream_Seek(stm
, pos
, STREAM_SEEK_SET
, NULL
);
1913 IStream_SetSize(stm
, size
);
1916 /***********************************************************************
1917 * expose_marshalled_dataobject
1919 * Sets the marshalled dataobject to the clipboard. In the flushed case
1920 * we set a zero sized HGLOBAL to clear the old marshalled data.
1922 static HRESULT
expose_marshalled_dataobject(ole_clipbrd
*clipbrd
, IDataObject
*data
)
1929 GetHGlobalFromStream(clipbrd
->marshal_data
, &h_stm
);
1930 dup_global_mem(h_stm
, GMEM_DDESHARE
|GMEM_MOVEABLE
, &h
);
1933 h
= GlobalAlloc(GMEM_DDESHARE
|GMEM_MOVEABLE
, 1);
1935 if(!h
) return E_OUTOFMEMORY
;
1937 if(!SetClipboardData(wine_marshal_clipboard_format
, h
))
1940 return CLIPBRD_E_CANT_SET
;
1945 /***********************************************************************
1946 * set_src_dataobject
1948 * Clears and sets the clipboard's src IDataObject.
1950 * To marshal the source dataobject we do something rather different from Windows.
1951 * We set a clipboard format which contains the marshalled data.
1952 * Windows sets two window props one of which is an IID, the other is an endpoint number.
1954 static HRESULT
set_src_dataobject(ole_clipbrd
*clipbrd
, IDataObject
*data
)
1959 if(FAILED(hr
= get_clipbrd_window(clipbrd
, &wnd
))) return hr
;
1961 if(clipbrd
->src_data
)
1963 release_marshal_data(clipbrd
->marshal_data
);
1965 IDataObject_Release(clipbrd
->src_data
);
1966 clipbrd
->src_data
= NULL
;
1967 HeapFree(GetProcessHeap(), 0, clipbrd
->cached_enum
);
1968 clipbrd
->cached_enum
= NULL
;
1975 IDataObject_AddRef(data
);
1976 clipbrd
->src_data
= data
;
1978 IDataObject_QueryInterface(data
, &IID_IUnknown
, (void**)&unk
);
1979 hr
= CoMarshalInterface(clipbrd
->marshal_data
, &IID_IDataObject
, unk
,
1980 MSHCTX_LOCAL
, NULL
, MSHLFLAGS_TABLESTRONG
);
1981 IUnknown_Release(unk
); /* Don't hold a ref on IUnknown, we have one on IDataObject. */
1982 if(FAILED(hr
)) return hr
;
1983 hr
= set_clipboard_formats(clipbrd
, data
);
1988 /***********************************************************************
1989 * OLEClipbrd_UnInitialize()
1990 * Un-Initializes the OLE clipboard
1992 void OLEClipbrd_UnInitialize(void)
1994 ole_clipbrd
*clipbrd
= theOleClipboard
;
2000 static const WCHAR ole32W
[] = {'o','l','e','3','2',0};
2001 HINSTANCE hinst
= GetModuleHandleW(ole32W
);
2003 /* OleUninitialize() does not release the reference to the dataobject, so
2004 take an additional reference here. This reference is then leaked. */
2005 if (clipbrd
->src_data
)
2007 IDataObject_AddRef(clipbrd
->src_data
);
2008 set_src_dataobject(clipbrd
, NULL
);
2011 if ( clipbrd
->window
)
2013 DestroyWindow(clipbrd
->window
);
2014 UnregisterClassW( clipbrd_wndclass
, hinst
);
2017 IStream_Release(clipbrd
->marshal_data
);
2018 HeapFree(GetProcessHeap(), 0, clipbrd
);
2019 theOleClipboard
= NULL
;
2023 /***********************************************************************
2026 static LRESULT CALLBACK
clipbrd_wndproc(HWND hwnd
, UINT message
, WPARAM wparam
, LPARAM lparam
)
2028 ole_clipbrd
*clipbrd
;
2030 get_ole_clipbrd(&clipbrd
);
2034 case WM_RENDERFORMAT
:
2037 ole_priv_data_entry
*entry
;
2039 TRACE("(): WM_RENDERFORMAT(cfFormat=%x)\n", cf
);
2040 entry
= find_format_in_list(clipbrd
->cached_enum
->entries
, clipbrd
->cached_enum
->count
, cf
);
2043 render_format(clipbrd
->src_data
, &entry
->fmtetc
);
2048 case WM_RENDERALLFORMATS
:
2051 ole_priv_data_entry
*entries
;
2053 TRACE("(): WM_RENDERALLFORMATS\n");
2055 if (!clipbrd
|| !clipbrd
->cached_enum
) break;
2056 entries
= clipbrd
->cached_enum
->entries
;
2057 for(i
= 0; i
< clipbrd
->cached_enum
->count
; i
++)
2059 if(entries
[i
].first_use
)
2060 render_format(clipbrd
->src_data
, &entries
[i
].fmtetc
);
2065 case WM_DESTROYCLIPBOARD
:
2067 TRACE("(): WM_DESTROYCLIPBOARD\n");
2069 set_src_dataobject(clipbrd
, NULL
);
2074 return DefWindowProcW(hwnd
, message
, wparam
, lparam
);
2081 /***********************************************************************
2082 * create_clipbrd_window
2084 static HWND
create_clipbrd_window(void)
2087 static const WCHAR ole32W
[] = {'o','l','e','3','2',0};
2088 static const WCHAR title
[] = {'C','l','i','p','b','o','a','r','d','W','i','n','d','o','w',0};
2089 HINSTANCE hinst
= GetModuleHandleW(ole32W
);
2091 class.cbSize
= sizeof(class);
2093 class.lpfnWndProc
= clipbrd_wndproc
;
2094 class.cbClsExtra
= 0;
2095 class.cbWndExtra
= 0;
2096 class.hInstance
= hinst
;
2099 class.hbrBackground
= 0;
2100 class.lpszMenuName
= NULL
;
2101 class.lpszClassName
= clipbrd_wndclass
;
2102 class.hIconSm
= NULL
;
2104 RegisterClassExW(&class);
2106 return CreateWindowW(clipbrd_wndclass
, title
, WS_POPUP
| WS_CLIPSIBLINGS
| WS_OVERLAPPED
,
2107 0, 0, 0, 0, HWND_MESSAGE
, NULL
, hinst
, 0);
2110 /*********************************************************************
2111 * set_dataobject_format
2113 * Windows creates a 'DataObject' clipboard format that contains the
2114 * clipboard window's HWND or NULL if the Ole clipboard has been flushed.
2116 static HRESULT
set_dataobject_format(HWND hwnd
)
2118 HGLOBAL h
= GlobalAlloc(GMEM_DDESHARE
| GMEM_MOVEABLE
, sizeof(hwnd
));
2121 if(!h
) return E_OUTOFMEMORY
;
2123 data
= GlobalLock(h
);
2127 if(!SetClipboardData(dataobject_clipboard_format
, h
))
2130 return CLIPBRD_E_CANT_SET
;
2136 /*---------------------------------------------------------------------*
2137 * Win32 OLE clipboard API
2138 *---------------------------------------------------------------------*/
2140 /***********************************************************************
2141 * OleSetClipboard [OLE32.@]
2142 * Places a pointer to the specified data object onto the clipboard,
2143 * making the data object accessible to the OleGetClipboard function.
2147 * S_OK IDataObject pointer placed on the clipboard
2148 * CLIPBRD_E_CANT_OPEN OpenClipboard failed
2149 * CLIPBRD_E_CANT_EMPTY EmptyClipboard failed
2150 * CLIPBRD_E_CANT_CLOSE CloseClipboard failed
2151 * CLIPBRD_E_CANT_SET SetClipboard failed
2154 HRESULT WINAPI
OleSetClipboard(IDataObject
* data
)
2157 ole_clipbrd
*clipbrd
;
2160 TRACE("(%p)\n", data
);
2162 if(FAILED(hr
= get_ole_clipbrd(&clipbrd
))) return hr
;
2164 if(FAILED(hr
= get_clipbrd_window(clipbrd
, &wnd
))) return hr
;
2166 if ( !OpenClipboard(wnd
) ) return CLIPBRD_E_CANT_OPEN
;
2168 if ( !EmptyClipboard() )
2170 hr
= CLIPBRD_E_CANT_EMPTY
;
2174 hr
= set_src_dataobject(clipbrd
, data
);
2175 if(FAILED(hr
)) goto end
;
2179 hr
= expose_marshalled_dataobject(clipbrd
, data
);
2180 if(FAILED(hr
)) goto end
;
2181 hr
= set_dataobject_format(wnd
);
2186 if ( !CloseClipboard() ) hr
= CLIPBRD_E_CANT_CLOSE
;
2190 expose_marshalled_dataobject(clipbrd
, NULL
);
2191 set_src_dataobject(clipbrd
, NULL
);
2198 /***********************************************************************
2199 * OleGetClipboard [OLE32.@]
2200 * Returns a pointer to our internal IDataObject which represents the conceptual
2201 * state of the Windows clipboard. If the current clipboard already contains
2202 * an IDataObject, our internal IDataObject will delegate to this object.
2204 HRESULT WINAPI
OleGetClipboard(IDataObject
**obj
)
2207 ole_clipbrd
*clipbrd
;
2210 TRACE("(%p)\n", obj
);
2212 if(!obj
) return E_INVALIDARG
;
2215 if(FAILED(hr
= get_ole_clipbrd(&clipbrd
))) return hr
;
2217 seq_no
= GetClipboardSequenceNumber();
2218 EnterCriticalSection(&latest_snapshot_cs
);
2219 if(clipbrd
->latest_snapshot
&& clipbrd
->latest_snapshot
->seq_no
!= seq_no
)
2220 clipbrd
->latest_snapshot
= NULL
;
2222 if(!clipbrd
->latest_snapshot
)
2224 clipbrd
->latest_snapshot
= snapshot_construct(seq_no
);
2225 if(!clipbrd
->latest_snapshot
)
2227 LeaveCriticalSection(&latest_snapshot_cs
);
2228 return E_OUTOFMEMORY
;
2232 *obj
= &clipbrd
->latest_snapshot
->IDataObject_iface
;
2233 IDataObject_AddRef(*obj
);
2234 LeaveCriticalSection(&latest_snapshot_cs
);
2239 /******************************************************************************
2240 * OleFlushClipboard [OLE32.@]
2241 * Renders the data from the source IDataObject into the windows clipboard
2243 * TODO: OleFlushClipboard needs to additionally handle TYMED_IStorage media
2244 * by copying the storage into global memory. Subsequently the default
2245 * data object exposed through OleGetClipboard must convert this TYMED_HGLOBAL
2246 * back to TYMED_IStorage.
2248 HRESULT WINAPI
OleFlushClipboard(void)
2251 ole_clipbrd
*clipbrd
;
2256 if(FAILED(hr
= get_ole_clipbrd(&clipbrd
))) return hr
;
2258 if(FAILED(hr
= get_clipbrd_window(clipbrd
, &wnd
))) return hr
;
2261 * Already flushed or no source DataObject? Nothing to do.
2263 if (!clipbrd
->src_data
) return S_OK
;
2265 if (!OpenClipboard(wnd
)) return CLIPBRD_E_CANT_OPEN
;
2267 SendMessageW(wnd
, WM_RENDERALLFORMATS
, 0, 0);
2269 hr
= set_dataobject_format(NULL
);
2271 expose_marshalled_dataobject(clipbrd
, NULL
);
2272 set_src_dataobject(clipbrd
, NULL
);
2274 if ( !CloseClipboard() ) hr
= CLIPBRD_E_CANT_CLOSE
;
2280 /***********************************************************************
2281 * OleIsCurrentClipboard [OLE32.@]
2283 HRESULT WINAPI
OleIsCurrentClipboard(IDataObject
*data
)
2286 ole_clipbrd
*clipbrd
;
2289 if(FAILED(hr
= get_ole_clipbrd(&clipbrd
))) return hr
;
2291 if (data
== NULL
) return S_FALSE
;
2293 return (data
== clipbrd
->src_data
) ? S_OK
: S_FALSE
;