msi: Fix a typo.
[wine/wine-kai.git] / dlls / ole32 / clipboard.c
blob621bbe5039f0c3b91b21801e16ba687f82c7dc54
1 /*
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
21 * NOTES:
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
46 * TODO:
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.
61 #include <assert.h>
62 #include <stdarg.h>
63 #include <string.h>
65 #define COBJMACROS
66 #define NONAMELESSUNION
67 #define NONAMELESSSTRUCT
69 #include "windef.h"
70 #include "winbase.h"
71 #include "wingdi.h"
72 #include "winuser.h"
73 #include "winerror.h"
74 #include "winnls.h"
75 #include "ole2.h"
76 #include "wine/debug.h"
77 #include "olestd.h"
79 #include "storage32.h"
81 #define HANDLE_ERROR(err) { hr = err; TRACE("(HRESULT=%lx)\n", (HRESULT)err); goto CLEANUP; }
83 WINE_DEFAULT_DEBUG_CHANNEL(ole);
85 /****************************************************************************
86 * OLEClipbrd
87 * DO NOT add any members before the VTables declaration!
89 struct OLEClipbrd
92 * List all interface VTables here
94 const IDataObjectVtbl* lpvtbl1; /* IDataObject VTable */
97 * The hidden OLE clipboard window. This window is used as the bridge between the
98 * the OLE and windows clipboard API. (Windows creates one such window per process)
100 HWND hWndClipboard;
103 * Pointer to the source data object (via OleSetClipboard)
105 IDataObject* pIDataObjectSrc;
108 * The registered DataObject clipboard format
110 UINT cfDataObj;
113 * The handle to ourself
115 HGLOBAL hSelf;
118 * Reference count of this object
120 LONG ref;
123 typedef struct OLEClipbrd OLEClipbrd;
126 /****************************************************************************
127 * IEnumFORMATETC implementation
128 * DO NOT add any members before the VTables declaration!
130 typedef struct
132 /* IEnumFORMATETC VTable */
133 const IEnumFORMATETCVtbl *lpVtbl;
135 /* IEnumFORMATETC fields */
136 UINT posFmt; /* current enumerator position */
137 UINT countFmt; /* number of EnumFORMATETC's in array */
138 LPFORMATETC pFmt; /* array of EnumFORMATETC's */
141 * Reference count of this object
143 LONG ref;
146 * IUnknown implementation of the parent data object.
148 IUnknown* pUnkDataObj;
150 } IEnumFORMATETCImpl;
152 typedef struct PresentationDataHeader
154 BYTE unknown1[28];
155 DWORD dwObjectExtentX;
156 DWORD dwObjectExtentY;
157 DWORD dwSize;
158 } PresentationDataHeader;
161 * The one and only OLEClipbrd object which is created by OLEClipbrd_Initialize()
163 static HGLOBAL hTheOleClipboard = 0;
164 static OLEClipbrd* theOleClipboard = NULL;
168 * Prototypes for the methods of the OLEClipboard class.
170 void OLEClipbrd_Initialize(void);
171 void OLEClipbrd_UnInitialize(void);
172 static OLEClipbrd* OLEClipbrd_Construct(void);
173 static void OLEClipbrd_Destroy(OLEClipbrd* ptrToDestroy);
174 static HWND OLEClipbrd_CreateWindow(void);
175 static void OLEClipbrd_DestroyWindow(HWND hwnd);
176 static LRESULT CALLBACK OLEClipbrd_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
177 static HRESULT OLEClipbrd_RenderFormat( IDataObject *pIDataObject, LPFORMATETC pFormatetc );
178 static HGLOBAL OLEClipbrd_GlobalDupMem( HGLOBAL hGlobalSrc );
181 * Prototypes for the methods of the OLEClipboard class
182 * that implement IDataObject methods.
184 static HRESULT WINAPI OLEClipbrd_IDataObject_QueryInterface(
185 IDataObject* iface,
186 REFIID riid,
187 void** ppvObject);
188 static ULONG WINAPI OLEClipbrd_IDataObject_AddRef(
189 IDataObject* iface);
190 static ULONG WINAPI OLEClipbrd_IDataObject_Release(
191 IDataObject* iface);
192 static HRESULT WINAPI OLEClipbrd_IDataObject_GetData(
193 IDataObject* iface,
194 LPFORMATETC pformatetcIn,
195 STGMEDIUM* pmedium);
196 static HRESULT WINAPI OLEClipbrd_IDataObject_GetDataHere(
197 IDataObject* iface,
198 LPFORMATETC pformatetc,
199 STGMEDIUM* pmedium);
200 static HRESULT WINAPI OLEClipbrd_IDataObject_QueryGetData(
201 IDataObject* iface,
202 LPFORMATETC pformatetc);
203 static HRESULT WINAPI OLEClipbrd_IDataObject_GetCanonicalFormatEtc(
204 IDataObject* iface,
205 LPFORMATETC pformatectIn,
206 LPFORMATETC pformatetcOut);
207 static HRESULT WINAPI OLEClipbrd_IDataObject_SetData(
208 IDataObject* iface,
209 LPFORMATETC pformatetc,
210 STGMEDIUM* pmedium,
211 BOOL fRelease);
212 static HRESULT WINAPI OLEClipbrd_IDataObject_EnumFormatEtc(
213 IDataObject* iface,
214 DWORD dwDirection,
215 IEnumFORMATETC** ppenumFormatEtc);
216 static HRESULT WINAPI OLEClipbrd_IDataObject_DAdvise(
217 IDataObject* iface,
218 FORMATETC* pformatetc,
219 DWORD advf,
220 IAdviseSink* pAdvSink,
221 DWORD* pdwConnection);
222 static HRESULT WINAPI OLEClipbrd_IDataObject_DUnadvise(
223 IDataObject* iface,
224 DWORD dwConnection);
225 static HRESULT WINAPI OLEClipbrd_IDataObject_EnumDAdvise(
226 IDataObject* iface,
227 IEnumSTATDATA** ppenumAdvise);
230 * Prototypes for the IEnumFORMATETC methods.
232 static LPENUMFORMATETC OLEClipbrd_IEnumFORMATETC_Construct(UINT cfmt, const FORMATETC afmt[],
233 LPUNKNOWN pUnkDataObj);
234 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_QueryInterface(LPENUMFORMATETC iface, REFIID riid,
235 LPVOID* ppvObj);
236 static ULONG WINAPI OLEClipbrd_IEnumFORMATETC_AddRef(LPENUMFORMATETC iface);
237 static ULONG WINAPI OLEClipbrd_IEnumFORMATETC_Release(LPENUMFORMATETC iface);
238 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Next(LPENUMFORMATETC iface, ULONG celt,
239 FORMATETC* rgelt, ULONG* pceltFethed);
240 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Skip(LPENUMFORMATETC iface, ULONG celt);
241 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Reset(LPENUMFORMATETC iface);
242 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Clone(LPENUMFORMATETC iface, LPENUMFORMATETC* ppenum);
246 * Virtual function table for the OLEClipbrd's exposed IDataObject interface
248 static const IDataObjectVtbl OLEClipbrd_IDataObject_VTable =
250 OLEClipbrd_IDataObject_QueryInterface,
251 OLEClipbrd_IDataObject_AddRef,
252 OLEClipbrd_IDataObject_Release,
253 OLEClipbrd_IDataObject_GetData,
254 OLEClipbrd_IDataObject_GetDataHere,
255 OLEClipbrd_IDataObject_QueryGetData,
256 OLEClipbrd_IDataObject_GetCanonicalFormatEtc,
257 OLEClipbrd_IDataObject_SetData,
258 OLEClipbrd_IDataObject_EnumFormatEtc,
259 OLEClipbrd_IDataObject_DAdvise,
260 OLEClipbrd_IDataObject_DUnadvise,
261 OLEClipbrd_IDataObject_EnumDAdvise
265 * Virtual function table for IEnumFORMATETC interface
267 static const IEnumFORMATETCVtbl efvt =
269 OLEClipbrd_IEnumFORMATETC_QueryInterface,
270 OLEClipbrd_IEnumFORMATETC_AddRef,
271 OLEClipbrd_IEnumFORMATETC_Release,
272 OLEClipbrd_IEnumFORMATETC_Next,
273 OLEClipbrd_IEnumFORMATETC_Skip,
274 OLEClipbrd_IEnumFORMATETC_Reset,
275 OLEClipbrd_IEnumFORMATETC_Clone
279 * Name of our registered OLE clipboard window class
281 static const CHAR OLEClipbrd_WNDCLASS[] = "CLIPBRDWNDCLASS";
284 * If we need to store state info we can store it here.
285 * For now we don't need this functionality.
287 typedef struct tagClipboardWindowInfo
289 } ClipboardWindowInfo;
292 /*---------------------------------------------------------------------*
293 * Win32 OLE clipboard API
294 *---------------------------------------------------------------------*/
296 /***********************************************************************
297 * OleSetClipboard [OLE32.@]
298 * Places a pointer to the specified data object onto the clipboard,
299 * making the data object accessible to the OleGetClipboard function.
301 * RETURNS
303 * S_OK IDataObject pointer placed on the clipboard
304 * CLIPBRD_E_CANT_OPEN OpenClipboard failed
305 * CLIPBRD_E_CANT_EMPTY EmptyClipboard failed
306 * CLIPBRD_E_CANT_CLOSE CloseClipboard failed
307 * CLIPBRD_E_CANT_SET SetClipboard failed
310 HRESULT WINAPI OleSetClipboard(IDataObject* pDataObj)
312 HRESULT hr = S_OK;
313 IEnumFORMATETC* penumFormatetc = NULL;
314 FORMATETC rgelt;
315 BOOL bClipboardOpen = FALSE;
317 HGLOBAL hDataObject = 0;
318 OLEClipbrd **ppDataObject;
321 TRACE("(%p)\n", pDataObj);
324 * Make sure we have a clipboard object
326 OLEClipbrd_Initialize();
329 * If the Ole clipboard window hasn't been created yet, create it now.
331 if ( !theOleClipboard->hWndClipboard )
332 theOleClipboard->hWndClipboard = OLEClipbrd_CreateWindow();
334 if ( !theOleClipboard->hWndClipboard ) /* sanity check */
335 HANDLE_ERROR( E_FAIL );
338 * Open the Windows clipboard, associating it with our hidden window
340 if ( !(bClipboardOpen = OpenClipboard(theOleClipboard->hWndClipboard)) )
341 HANDLE_ERROR( CLIPBRD_E_CANT_OPEN );
344 * Empty the current clipboard and make our window the clipboard owner
345 * NOTE: This will trigger a WM_DESTROYCLIPBOARD message
347 if ( !EmptyClipboard() )
348 HANDLE_ERROR( CLIPBRD_E_CANT_EMPTY );
351 * If we are already holding on to an IDataObject first release that.
353 if ( theOleClipboard->pIDataObjectSrc )
355 IDataObject_Release(theOleClipboard->pIDataObjectSrc);
356 theOleClipboard->pIDataObjectSrc = NULL;
360 * AddRef the data object passed in and save its pointer.
361 * A NULL value indicates that the clipboard should be emptied.
363 theOleClipboard->pIDataObjectSrc = pDataObj;
364 if ( pDataObj )
366 IDataObject_AddRef(theOleClipboard->pIDataObjectSrc);
370 * Enumerate all HGLOBAL formats supported by the source and make
371 * those formats available using delayed rendering using SetClipboardData.
372 * Only global memory based data items may be made available to non-OLE
373 * applications via the standard Windows clipboard API. Data based on other
374 * mediums(non TYMED_HGLOBAL) can only be accessed via the Ole Clipboard API.
376 * TODO: Do we need to additionally handle TYMED_IStorage media by copying
377 * the storage into global memory?
379 if ( pDataObj )
381 if ( FAILED(hr = IDataObject_EnumFormatEtc( pDataObj,
382 DATADIR_GET,
383 &penumFormatetc )))
385 HANDLE_ERROR( hr );
388 while ( S_OK == IEnumFORMATETC_Next(penumFormatetc, 1, &rgelt, NULL) )
390 if ( rgelt.tymed == TYMED_HGLOBAL )
392 CHAR szFmtName[80];
393 TRACE("(cfFormat=%d:%s)\n", rgelt.cfFormat,
394 GetClipboardFormatNameA(rgelt.cfFormat, szFmtName, sizeof(szFmtName)-1)
395 ? szFmtName : "");
397 SetClipboardData( rgelt.cfFormat, NULL);
400 IEnumFORMATETC_Release(penumFormatetc);
404 * Windows additionally creates a new "DataObject" clipboard format
405 * and stores in on the clipboard. We could possibly store a pointer
406 * to our internal IDataObject interface on the clipboard. I'm not
407 * sure what the use of this is though.
408 * Enable the code below for this functionality.
411 theOleClipboard->cfDataObj = RegisterClipboardFormatA("DataObject");
412 hDataObject = GlobalAlloc( GMEM_DDESHARE|GMEM_MOVEABLE|GMEM_ZEROINIT,
413 sizeof(OLEClipbrd *));
414 if (hDataObject==0)
415 HANDLE_ERROR( E_OUTOFMEMORY );
417 ppDataObject = (OLEClipbrd**)GlobalLock(hDataObject);
418 *ppDataObject = theOleClipboard;
419 GlobalUnlock(hDataObject);
421 if ( !SetClipboardData( theOleClipboard->cfDataObj, hDataObject ) )
422 HANDLE_ERROR( CLIPBRD_E_CANT_SET );
425 hr = S_OK;
427 CLEANUP:
430 * Close Windows clipboard (It remains associated with our window)
432 if ( bClipboardOpen && !CloseClipboard() )
433 hr = CLIPBRD_E_CANT_CLOSE;
436 * Release the source IDataObject if something failed
438 if ( FAILED(hr) )
440 if (theOleClipboard->pIDataObjectSrc)
442 IDataObject_Release(theOleClipboard->pIDataObjectSrc);
443 theOleClipboard->pIDataObjectSrc = NULL;
447 return hr;
451 /***********************************************************************
452 * OleGetClipboard [OLE32.@]
453 * Returns a pointer to our internal IDataObject which represents the conceptual
454 * state of the Windows clipboard. If the current clipboard already contains
455 * an IDataObject, our internal IDataObject will delegate to this object.
457 HRESULT WINAPI OleGetClipboard(IDataObject** ppDataObj)
459 HRESULT hr = S_OK;
460 TRACE("()\n");
463 * Make sure we have a clipboard object
465 OLEClipbrd_Initialize();
467 if (!theOleClipboard)
468 return E_OUTOFMEMORY;
470 /* Return a reference counted IDataObject */
471 hr = IDataObject_QueryInterface( (IDataObject*)&(theOleClipboard->lpvtbl1),
472 &IID_IDataObject, (void**)ppDataObj);
473 return hr;
476 /******************************************************************************
477 * OleFlushClipboard [OLE32.@]
478 * Renders the data from the source IDataObject into the windows clipboard
480 * TODO: OleFlushClipboard needs to additionally handle TYMED_IStorage media
481 * by copying the storage into global memory. Subsequently the default
482 * data object exposed through OleGetClipboard must convert this TYMED_HGLOBAL
483 * back to TYMED_IStorage.
485 HRESULT WINAPI OleFlushClipboard(void)
487 IEnumFORMATETC* penumFormatetc = NULL;
488 FORMATETC rgelt;
489 HRESULT hr = S_OK;
490 BOOL bClipboardOpen = FALSE;
491 IDataObject* pIDataObjectSrc = NULL;
493 TRACE("()\n");
496 * Make sure we have a clipboard object
498 OLEClipbrd_Initialize();
501 * Already flushed or no source DataObject? Nothing to do.
503 if (!theOleClipboard->pIDataObjectSrc)
504 return S_OK;
507 * Addref and save the source data object we are holding on to temporarily,
508 * since it will be released when we empty the clipboard.
510 pIDataObjectSrc = theOleClipboard->pIDataObjectSrc;
511 IDataObject_AddRef(pIDataObjectSrc);
514 * Open the Windows clipboard
516 if ( !(bClipboardOpen = OpenClipboard(theOleClipboard->hWndClipboard)) )
517 HANDLE_ERROR( CLIPBRD_E_CANT_OPEN );
520 * Empty the current clipboard
522 if ( !EmptyClipboard() )
523 HANDLE_ERROR( CLIPBRD_E_CANT_EMPTY );
526 * Render all HGLOBAL formats supported by the source into
527 * the windows clipboard.
529 if ( FAILED( hr = IDataObject_EnumFormatEtc( pIDataObjectSrc,
530 DATADIR_GET,
531 &penumFormatetc) ))
533 HANDLE_ERROR( hr );
536 while ( S_OK == IEnumFORMATETC_Next(penumFormatetc, 1, &rgelt, NULL) )
538 if ( rgelt.tymed == TYMED_HGLOBAL )
540 CHAR szFmtName[80];
541 TRACE("(cfFormat=%d:%s)\n", rgelt.cfFormat,
542 GetClipboardFormatNameA(rgelt.cfFormat, szFmtName, sizeof(szFmtName)-1)
543 ? szFmtName : "");
546 * Render the clipboard data
548 if ( FAILED(OLEClipbrd_RenderFormat( pIDataObjectSrc, &rgelt )) )
549 continue;
553 IEnumFORMATETC_Release(penumFormatetc);
556 * Release the source data object we are holding on to
558 IDataObject_Release(pIDataObjectSrc);
560 CLEANUP:
563 * Close Windows clipboard (It remains associated with our window)
565 if ( bClipboardOpen && !CloseClipboard() )
566 hr = CLIPBRD_E_CANT_CLOSE;
568 return hr;
572 /***********************************************************************
573 * OleIsCurrentClipboard [OLE32.@]
575 HRESULT WINAPI OleIsCurrentClipboard(IDataObject *pDataObject)
577 TRACE("()\n");
579 * Make sure we have a clipboard object
581 OLEClipbrd_Initialize();
583 if (!theOleClipboard)
584 return E_OUTOFMEMORY;
586 return (pDataObject == theOleClipboard->pIDataObjectSrc) ? S_OK : S_FALSE;
590 /*---------------------------------------------------------------------*
591 * Internal implementation methods for the OLE clipboard
592 *---------------------------------------------------------------------*/
594 /***********************************************************************
595 * OLEClipbrd_Initialize()
596 * Initializes the OLE clipboard.
598 void OLEClipbrd_Initialize(void)
601 * Create the clipboard if necessary
603 if ( !theOleClipboard )
605 TRACE("()\n");
606 theOleClipboard = OLEClipbrd_Construct();
611 /***********************************************************************
612 * OLEClipbrd_UnInitialize()
613 * Un-Initializes the OLE clipboard
615 void OLEClipbrd_UnInitialize(void)
617 TRACE("()\n");
619 * Destroy the clipboard if no one holds a reference to us.
620 * Note that the clipboard was created with a reference count of 1.
622 if ( theOleClipboard && (theOleClipboard->ref <= 1) )
624 OLEClipbrd_Destroy( theOleClipboard );
626 else
628 WARN( "() : OLEClipbrd_UnInitialize called while client holds an IDataObject reference!\n");
633 /*********************************************************
634 * Construct the OLEClipbrd class.
636 static OLEClipbrd* OLEClipbrd_Construct(void)
638 OLEClipbrd* newObject = NULL;
639 HGLOBAL hNewObject = 0;
642 * Allocate space for the object. We use GlobalAlloc since we need
643 * an HGLOBAL to expose our DataObject as a registered clipboard type.
645 hNewObject = GlobalAlloc( GMEM_DDESHARE|GMEM_MOVEABLE|GMEM_ZEROINIT,
646 sizeof(OLEClipbrd));
647 if (hNewObject==0)
648 return NULL;
651 * Lock the handle for the entire lifetime of the clipboard.
653 newObject = GlobalLock(hNewObject);
656 * Initialize the virtual function table.
658 newObject->lpvtbl1 = &OLEClipbrd_IDataObject_VTable;
661 * Start with one reference count. The caller of this function
662 * must release the interface pointer when it is done.
664 newObject->ref = 1;
666 newObject->hSelf = hNewObject;
669 * The Ole clipboard is a singleton - save the global handle and pointer
671 theOleClipboard = newObject;
672 hTheOleClipboard = hNewObject;
674 return theOleClipboard;
677 static void OLEClipbrd_Destroy(OLEClipbrd* ptrToDestroy)
679 TRACE("()\n");
681 if ( !ptrToDestroy )
682 return;
685 * Destroy the Ole clipboard window
687 if ( ptrToDestroy->hWndClipboard )
688 OLEClipbrd_DestroyWindow(ptrToDestroy->hWndClipboard);
691 * Free the actual OLE Clipboard structure.
693 TRACE("() - Destroying clipboard data object.\n");
694 GlobalUnlock(ptrToDestroy->hSelf);
695 GlobalFree(ptrToDestroy->hSelf);
698 * The Ole clipboard is a singleton (ptrToDestroy == theOleClipboard)
700 theOleClipboard = NULL;
701 hTheOleClipboard = 0;
705 /***********************************************************************
706 * OLEClipbrd_CreateWindow()
707 * Create the clipboard window
709 static HWND OLEClipbrd_CreateWindow(void)
711 HWND hwnd = 0;
712 WNDCLASSEXA wcex;
715 * Register the clipboard window class if necessary
717 ZeroMemory( &wcex, sizeof(WNDCLASSEXA));
719 wcex.cbSize = sizeof(WNDCLASSEXA);
720 /* Windows creates this class with a style mask of 0
721 * We don't bother doing this since the FindClassByAtom code
722 * would have to be changed to deal with this idiosyncrasy. */
723 wcex.style = CS_GLOBALCLASS;
724 wcex.lpfnWndProc = OLEClipbrd_WndProc;
725 wcex.hInstance = 0;
726 wcex.lpszClassName = OLEClipbrd_WNDCLASS;
728 RegisterClassExA(&wcex);
731 * Create a hidden window to receive OLE clipboard messages
735 * If we need to store state info we can store it here.
736 * For now we don't need this functionality.
737 * ClipboardWindowInfo clipboardInfo;
738 * ZeroMemory( &trackerInfo, sizeof(ClipboardWindowInfo));
741 hwnd = CreateWindowA(OLEClipbrd_WNDCLASS,
742 "ClipboardWindow",
743 WS_POPUP | WS_CLIPSIBLINGS | WS_OVERLAPPED,
744 CW_USEDEFAULT, CW_USEDEFAULT,
745 CW_USEDEFAULT, CW_USEDEFAULT,
749 0 /*(LPVOID)&clipboardInfo */);
751 return hwnd;
754 /***********************************************************************
755 * OLEClipbrd_DestroyWindow(HWND)
756 * Destroy the clipboard window and unregister its class
758 static void OLEClipbrd_DestroyWindow(HWND hwnd)
761 * Destroy clipboard window and unregister its WNDCLASS
763 DestroyWindow(hwnd);
764 UnregisterClassA( OLEClipbrd_WNDCLASS, 0 );
767 /***********************************************************************
768 * OLEClipbrd_WndProc(HWND, unsigned, WORD, LONG)
769 * Processes messages sent to the OLE clipboard window.
770 * Note that we will intercept messages in our WndProc only when data
771 * has been placed in the clipboard via OleSetClipboard().
772 * i.e. Only when OLE owns the windows clipboard.
774 static LRESULT CALLBACK OLEClipbrd_WndProc
775 (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
777 switch (message)
780 * WM_RENDERFORMAT
781 * We receive this message to allow us to handle delayed rendering of
782 * a specific clipboard format when an application requests data in
783 * that format by calling GetClipboardData.
784 * (Recall that in OleSetClipboard, we used SetClipboardData to
785 * make all HGLOBAL formats supported by the source IDataObject
786 * available using delayed rendering)
787 * On receiving this message we must actually render the data in the
788 * specified format and place it on the clipboard by calling the
789 * SetClipboardData function.
791 case WM_RENDERFORMAT:
793 FORMATETC rgelt;
795 ZeroMemory( &rgelt, sizeof(FORMATETC));
798 * Initialize FORMATETC to a Windows clipboard friendly format
800 rgelt.cfFormat = (UINT) wParam;
801 rgelt.dwAspect = DVASPECT_CONTENT;
802 rgelt.lindex = -1;
803 rgelt.tymed = TYMED_HGLOBAL;
805 TRACE("(): WM_RENDERFORMAT(cfFormat=%d)\n", rgelt.cfFormat);
808 * Render the clipboard data.
809 * (We must have a source data object or we wouldn't be in this WndProc)
811 OLEClipbrd_RenderFormat( (IDataObject*)&(theOleClipboard->lpvtbl1), &rgelt );
813 break;
817 * WM_RENDERALLFORMATS
818 * Sent before the clipboard owner window is destroyed.
819 * We should receive this message only when OleUninitialize is called
820 * while we have an IDataObject in the clipboard.
821 * For the content of the clipboard to remain available to other
822 * applications, we must render data in all the formats the source IDataObject
823 * is capable of generating, and place the data on the clipboard by calling
824 * SetClipboardData.
826 case WM_RENDERALLFORMATS:
828 IEnumFORMATETC* penumFormatetc = NULL;
829 FORMATETC rgelt;
831 TRACE("(): WM_RENDERALLFORMATS\n");
834 * Render all HGLOBAL formats supported by the source into
835 * the windows clipboard.
837 if ( FAILED( IDataObject_EnumFormatEtc( (IDataObject*)&(theOleClipboard->lpvtbl1),
838 DATADIR_GET, &penumFormatetc) ) )
840 WARN("(): WM_RENDERALLFORMATS failed to retrieve EnumFormatEtc!\n");
841 return 0;
844 while ( S_OK == IEnumFORMATETC_Next(penumFormatetc, 1, &rgelt, NULL) )
846 if ( rgelt.tymed == TYMED_HGLOBAL )
849 * Render the clipboard data.
851 if ( FAILED(OLEClipbrd_RenderFormat( (IDataObject*)&(theOleClipboard->lpvtbl1), &rgelt )) )
852 continue;
854 TRACE("(): WM_RENDERALLFORMATS(cfFormat=%d)\n", rgelt.cfFormat);
858 IEnumFORMATETC_Release(penumFormatetc);
860 break;
864 * WM_DESTROYCLIPBOARD
865 * This is sent by EmptyClipboard before the clipboard is emptied.
866 * We should release any IDataObject we are holding onto when we receive
867 * this message, since it indicates that the OLE clipboard should be empty
868 * from this point on.
870 case WM_DESTROYCLIPBOARD:
872 TRACE("(): WM_DESTROYCLIPBOARD\n");
874 * Release the data object we are holding on to
876 if ( theOleClipboard->pIDataObjectSrc )
878 IDataObject_Release(theOleClipboard->pIDataObjectSrc);
879 theOleClipboard->pIDataObjectSrc = NULL;
881 break;
885 case WM_ASKCBFORMATNAME:
886 case WM_CHANGECBCHAIN:
887 case WM_DRAWCLIPBOARD:
888 case WM_SIZECLIPBOARD:
889 case WM_HSCROLLCLIPBOARD:
890 case WM_VSCROLLCLIPBOARD:
891 case WM_PAINTCLIPBOARD:
893 default:
894 return DefWindowProcA(hWnd, message, wParam, lParam);
897 return 0;
900 #define MAX_CLIPFORMAT_NAME 80
902 /***********************************************************************
903 * OLEClipbrd_RenderFormat(LPFORMATETC)
904 * Render the clipboard data. Note that this call will delegate to the
905 * source data object.
906 * Note: This function assumes it is passed an HGLOBAL format to render.
908 static HRESULT OLEClipbrd_RenderFormat(IDataObject *pIDataObject, LPFORMATETC pFormatetc)
910 STGMEDIUM std;
911 HGLOBAL hDup;
912 HRESULT hr = S_OK;
913 char szFmtName[MAX_CLIPFORMAT_NAME];
914 ILockBytes *ptrILockBytes = 0;
915 HGLOBAL hStorage = 0;
917 GetClipboardFormatNameA(pFormatetc->cfFormat, szFmtName, MAX_CLIPFORMAT_NAME);
919 /* If embed source */
920 if (!strcmp(szFmtName, CF_EMBEDSOURCE))
922 memset(&std, 0, sizeof(STGMEDIUM));
923 std.tymed = pFormatetc->tymed = TYMED_ISTORAGE;
925 hStorage = GlobalAlloc(GMEM_SHARE|GMEM_MOVEABLE, 0);
926 if (hStorage == NULL)
927 HANDLE_ERROR( E_OUTOFMEMORY );
928 hr = CreateILockBytesOnHGlobal(hStorage, FALSE, &ptrILockBytes);
929 hr = StgCreateDocfileOnILockBytes(ptrILockBytes, STGM_SHARE_EXCLUSIVE|STGM_READWRITE, 0, &std.u.pstg);
931 if (FAILED(hr = IDataObject_GetDataHere(theOleClipboard->pIDataObjectSrc, pFormatetc, &std)))
933 WARN("() : IDataObject_GetDataHere failed to render clipboard data! (%lx)\n", hr);
934 GlobalFree(hStorage);
935 return hr;
938 if (1) /* check whether the presentation data is already -not- present */
940 FORMATETC fmt2;
941 STGMEDIUM std2;
942 METAFILEPICT *mfp = 0;
944 fmt2.cfFormat = CF_METAFILEPICT;
945 fmt2.ptd = 0;
946 fmt2.dwAspect = DVASPECT_CONTENT;
947 fmt2.lindex = -1;
948 fmt2.tymed = TYMED_MFPICT;
950 memset(&std2, 0, sizeof(STGMEDIUM));
951 std2.tymed = TYMED_MFPICT;
953 /* Get the metafile picture out of it */
955 if (!FAILED(hr = IDataObject_GetData(theOleClipboard->pIDataObjectSrc, &fmt2, &std2)))
957 mfp = (METAFILEPICT *)GlobalLock(std2.u.hGlobal);
960 if (mfp)
962 OLECHAR name[]={ 2, 'O', 'l', 'e', 'P', 'r', 'e', 's', '0', '0', '0', 0};
963 IStream *pStream = 0;
964 void *mfBits;
965 PresentationDataHeader pdh;
966 INT nSize;
967 CLSID clsID;
968 LPOLESTR strProgID;
969 CHAR strOleTypeName[51];
970 BYTE OlePresStreamHeader [] =
972 0xFF, 0xFF, 0xFF, 0xFF, 0x03, 0x00, 0x00, 0x00,
973 0x04, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
974 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00,
975 0x00, 0x00, 0x00, 0x00
978 nSize = GetMetaFileBitsEx(mfp->hMF, 0, NULL);
980 memset(&pdh, 0, sizeof(PresentationDataHeader));
981 memcpy(&pdh, OlePresStreamHeader, sizeof(OlePresStreamHeader));
983 pdh.dwObjectExtentX = mfp->xExt;
984 pdh.dwObjectExtentY = mfp->yExt;
985 pdh.dwSize = nSize;
987 hr = IStorage_CreateStream(std.u.pstg, name, STGM_CREATE|STGM_SHARE_EXCLUSIVE|STGM_READWRITE, 0, 0, &pStream);
989 hr = IStream_Write(pStream, &pdh, sizeof(PresentationDataHeader), NULL);
991 mfBits = HeapAlloc(GetProcessHeap(), 0, nSize);
992 nSize = GetMetaFileBitsEx(mfp->hMF, nSize, mfBits);
994 hr = IStream_Write(pStream, mfBits, nSize, NULL);
996 IStream_Release(pStream);
998 HeapFree(GetProcessHeap(), 0, mfBits);
1000 GlobalUnlock(std2.u.hGlobal);
1002 ReadClassStg(std.u.pstg, &clsID);
1003 ProgIDFromCLSID(&clsID, &strProgID);
1005 WideCharToMultiByte( CP_ACP, 0, strProgID, -1, strOleTypeName, sizeof(strOleTypeName), NULL, NULL );
1006 OLECONVERT_CreateOleStream(std.u.pstg);
1007 OLECONVERT_CreateCompObjStream(std.u.pstg, strOleTypeName);
1011 else
1013 if (FAILED(hr = IDataObject_GetData(pIDataObject, pFormatetc, &std)))
1015 WARN("() : IDataObject_GetData failed to render clipboard data! (%lx)\n", hr);
1016 GlobalFree(hStorage);
1017 return hr;
1020 /* To put a copy back on the clipboard */
1022 hStorage = std.u.hGlobal;
1026 * Put a copy of the rendered data back on the clipboard
1029 if ( !(hDup = OLEClipbrd_GlobalDupMem(hStorage)) )
1030 HANDLE_ERROR( E_OUTOFMEMORY );
1032 if ( !SetClipboardData( pFormatetc->cfFormat, hDup ) )
1034 GlobalFree(hDup);
1035 WARN("() : Failed to set rendered clipboard data into clipboard!\n");
1038 CLEANUP:
1040 ReleaseStgMedium(&std);
1042 return hr;
1046 /***********************************************************************
1047 * OLEClipbrd_GlobalDupMem( HGLOBAL )
1048 * Helper method to duplicate an HGLOBAL chunk of memory
1050 static HGLOBAL OLEClipbrd_GlobalDupMem( HGLOBAL hGlobalSrc )
1052 HGLOBAL hGlobalDest;
1053 PVOID pGlobalSrc, pGlobalDest;
1054 DWORD cBytes;
1056 if ( !hGlobalSrc )
1057 return 0;
1059 cBytes = GlobalSize(hGlobalSrc);
1060 if ( 0 == cBytes )
1061 return 0;
1063 hGlobalDest = GlobalAlloc( GMEM_DDESHARE|GMEM_MOVEABLE,
1064 cBytes );
1065 if ( !hGlobalDest )
1066 return 0;
1068 pGlobalSrc = GlobalLock(hGlobalSrc);
1069 pGlobalDest = GlobalLock(hGlobalDest);
1070 if ( !pGlobalSrc || !pGlobalDest )
1072 GlobalFree(hGlobalDest);
1073 return 0;
1076 memcpy(pGlobalDest, pGlobalSrc, cBytes);
1078 GlobalUnlock(hGlobalSrc);
1079 GlobalUnlock(hGlobalDest);
1081 return hGlobalDest;
1085 /*---------------------------------------------------------------------*
1086 * Implementation of the internal IDataObject interface exposed by
1087 * the OLE clipboard.
1088 *---------------------------------------------------------------------*/
1091 /************************************************************************
1092 * OLEClipbrd_IDataObject_QueryInterface (IUnknown)
1094 * See Windows documentation for more details on IUnknown methods.
1096 static HRESULT WINAPI OLEClipbrd_IDataObject_QueryInterface(
1097 IDataObject* iface,
1098 REFIID riid,
1099 void** ppvObject)
1102 * Declare "This" pointer
1104 OLEClipbrd *This = (OLEClipbrd *)iface;
1105 TRACE("(%p)->(\n\tIID:\t%s,%p)\n",This,debugstr_guid(riid),ppvObject);
1108 * Perform a sanity check on the parameters.
1110 if ( (This==0) || (ppvObject==0) )
1111 return E_INVALIDARG;
1114 * Initialize the return parameter.
1116 *ppvObject = 0;
1119 * Compare the riid with the interface IDs implemented by this object.
1121 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
1123 *ppvObject = iface;
1125 else if (memcmp(&IID_IDataObject, riid, sizeof(IID_IDataObject)) == 0)
1127 *ppvObject = (IDataObject*)&(This->lpvtbl1);
1129 else /* We only support IUnknown and IDataObject */
1131 WARN( "() : asking for unsupported interface %s\n", debugstr_guid(riid));
1132 return E_NOINTERFACE;
1136 * Query Interface always increases the reference count by one when it is
1137 * successful.
1139 IUnknown_AddRef((IUnknown*)*ppvObject);
1141 return S_OK;
1144 /************************************************************************
1145 * OLEClipbrd_IDataObject_AddRef (IUnknown)
1147 * See Windows documentation for more details on IUnknown methods.
1149 static ULONG WINAPI OLEClipbrd_IDataObject_AddRef(
1150 IDataObject* iface)
1153 * Declare "This" pointer
1155 OLEClipbrd *This = (OLEClipbrd *)iface;
1157 TRACE("(%p)->(count=%lu)\n",This, This->ref);
1159 return InterlockedIncrement(&This->ref);
1163 /************************************************************************
1164 * OLEClipbrd_IDataObject_Release (IUnknown)
1166 * See Windows documentation for more details on IUnknown methods.
1168 static ULONG WINAPI OLEClipbrd_IDataObject_Release(
1169 IDataObject* iface)
1172 * Declare "This" pointer
1174 OLEClipbrd *This = (OLEClipbrd *)iface;
1175 ULONG ref;
1177 TRACE("(%p)->(count=%lu)\n",This, This->ref);
1180 * Decrease the reference count on this object.
1182 ref = InterlockedDecrement(&This->ref);
1185 * If the reference count goes down to 0, perform suicide.
1187 if (ref == 0)
1189 OLEClipbrd_Destroy(This);
1192 return ref;
1196 /************************************************************************
1197 * OLEClipbrd_IDataObject_GetData (IDataObject)
1199 * The OLE Clipboard's implementation of this method delegates to
1200 * a data source if there is one or wraps around the windows clipboard
1202 * See Windows documentation for more details on IDataObject methods.
1204 static HRESULT WINAPI OLEClipbrd_IDataObject_GetData(
1205 IDataObject* iface,
1206 LPFORMATETC pformatetcIn,
1207 STGMEDIUM* pmedium)
1209 HANDLE hData = 0;
1210 BOOL bClipboardOpen = FALSE;
1211 HRESULT hr = S_OK;
1212 LPVOID src;
1215 * Declare "This" pointer
1217 OLEClipbrd *This = (OLEClipbrd *)iface;
1219 TRACE("(%p,%p,%p)\n", iface, pformatetcIn, pmedium);
1221 if ( !pformatetcIn || !pmedium )
1222 return E_INVALIDARG;
1225 * If we have a data source placed on the clipboard (via OleSetClipboard)
1226 * simply delegate to the source object's QueryGetData
1227 * NOTE: This code assumes that the IDataObject is in the same address space!
1228 * We will need to add marshalling support when Wine handles multiple processes.
1230 if ( This->pIDataObjectSrc )
1232 return IDataObject_GetData(This->pIDataObjectSrc, pformatetcIn, pmedium);
1235 if ( pformatetcIn->lindex != -1 )
1236 return DV_E_LINDEX;
1237 if ( (pformatetcIn->tymed & TYMED_HGLOBAL) != TYMED_HGLOBAL )
1238 return DV_E_TYMED;
1240 if ( pformatetcIn->dwAspect != DVASPECT_CONTENT )
1241 return DV_E_DVASPECT;
1245 * Otherwise, get the data from the windows clipboard using GetClipboardData
1247 if ( !(bClipboardOpen = OpenClipboard(theOleClipboard->hWndClipboard)) )
1248 HANDLE_ERROR( CLIPBRD_E_CANT_OPEN );
1250 hData = GetClipboardData(pformatetcIn->cfFormat);
1252 /* Must make a copy of global handle returned by GetClipboardData; it
1253 * is not valid after we call CloseClipboard
1254 * Application is responsible for freeing the memory (Forte Agent does this)
1256 src = GlobalLock(hData);
1257 if(src) {
1258 LPVOID dest;
1259 ULONG size;
1260 HANDLE hDest;
1262 size = GlobalSize(hData);
1263 hDest = GlobalAlloc(GHND, size);
1264 dest = GlobalLock(hDest);
1265 memcpy(dest, src, size);
1266 GlobalUnlock(hDest);
1267 GlobalUnlock(hData);
1268 hData = hDest;
1272 * Return the clipboard data in the storage medium structure
1274 pmedium->tymed = (hData == 0) ? TYMED_NULL : TYMED_HGLOBAL;
1275 pmedium->u.hGlobal = (HGLOBAL)hData;
1276 pmedium->pUnkForRelease = NULL;
1278 hr = S_OK;
1280 CLEANUP:
1282 * Close Windows clipboard
1284 if ( bClipboardOpen && !CloseClipboard() )
1285 hr = CLIPBRD_E_CANT_CLOSE;
1287 if ( FAILED(hr) )
1288 return hr;
1289 return (hData == 0) ? DV_E_FORMATETC : S_OK;
1292 static HRESULT WINAPI OLEClipbrd_IDataObject_GetDataHere(
1293 IDataObject* iface,
1294 LPFORMATETC pformatetc,
1295 STGMEDIUM* pmedium)
1297 FIXME(": Stub\n");
1298 return E_NOTIMPL;
1301 /************************************************************************
1302 * OLEClipbrd_IDataObject_QueryGetData (IDataObject)
1304 * The OLE Clipboard's implementation of this method delegates to
1305 * a data source if there is one or wraps around the windows clipboard
1306 * function IsClipboardFormatAvailable() otherwise.
1308 * See Windows documentation for more details on IDataObject methods.
1310 static HRESULT WINAPI OLEClipbrd_IDataObject_QueryGetData(
1311 IDataObject* iface,
1312 LPFORMATETC pformatetc)
1315 * Declare "This" pointer
1317 OLEClipbrd *This = (OLEClipbrd *)iface;
1319 TRACE("(%p, %p)\n", iface, pformatetc);
1322 * If we have a data source placed on the clipboard (via OleSetClipboard)
1323 * simply delegate to the source object's QueryGetData
1325 if ( This->pIDataObjectSrc )
1327 return IDataObject_QueryGetData(This->pIDataObjectSrc, pformatetc);
1330 if (!pformatetc)
1331 return E_INVALIDARG;
1333 if ( pformatetc->dwAspect != DVASPECT_CONTENT )
1334 return DV_E_DVASPECT;
1336 if ( pformatetc->lindex != -1 )
1337 return DV_E_LINDEX;
1339 /* TODO: Handle TYMED_IStorage media which were put on the clipboard
1340 * by copying the storage into global memory. We must convert this
1341 * TYMED_HGLOBAL back to TYMED_IStorage.
1343 if ( pformatetc->tymed != TYMED_HGLOBAL )
1344 return DV_E_TYMED;
1347 * Delegate to the Windows clipboard function IsClipboardFormatAvailable
1349 return (IsClipboardFormatAvailable(pformatetc->cfFormat)) ? S_OK : DV_E_FORMATETC;
1352 /************************************************************************
1353 * OLEClipbrd_IDataObject_GetCanonicalFormatEtc (IDataObject)
1355 * See Windows documentation for more details on IDataObject methods.
1357 static HRESULT WINAPI OLEClipbrd_IDataObject_GetCanonicalFormatEtc(
1358 IDataObject* iface,
1359 LPFORMATETC pformatectIn,
1360 LPFORMATETC pformatetcOut)
1362 TRACE("(%p, %p, %p)\n", iface, pformatectIn, pformatetcOut);
1364 if ( !pformatectIn || !pformatetcOut )
1365 return E_INVALIDARG;
1367 memcpy(pformatetcOut, pformatectIn, sizeof(FORMATETC));
1368 return DATA_S_SAMEFORMATETC;
1371 /************************************************************************
1372 * OLEClipbrd_IDataObject_SetData (IDataObject)
1374 * The OLE Clipboard's does not implement this method
1376 * See Windows documentation for more details on IDataObject methods.
1378 static HRESULT WINAPI OLEClipbrd_IDataObject_SetData(
1379 IDataObject* iface,
1380 LPFORMATETC pformatetc,
1381 STGMEDIUM* pmedium,
1382 BOOL fRelease)
1384 TRACE("\n");
1385 return E_NOTIMPL;
1388 /************************************************************************
1389 * OLEClipbrd_IDataObject_EnumFormatEtc (IDataObject)
1391 * See Windows documentation for more details on IDataObject methods.
1393 static HRESULT WINAPI OLEClipbrd_IDataObject_EnumFormatEtc(
1394 IDataObject* iface,
1395 DWORD dwDirection,
1396 IEnumFORMATETC** ppenumFormatEtc)
1398 HRESULT hr = S_OK;
1399 FORMATETC *afmt = NULL;
1400 int cfmt, i;
1401 UINT format;
1402 BOOL bClipboardOpen;
1405 * Declare "This" pointer
1407 OLEClipbrd *This = (OLEClipbrd *)iface;
1409 TRACE("(%p, %lx, %p)\n", iface, dwDirection, ppenumFormatEtc);
1412 * If we have a data source placed on the clipboard (via OleSetClipboard)
1413 * simply delegate to the source object's EnumFormatEtc
1415 if ( This->pIDataObjectSrc )
1417 return IDataObject_EnumFormatEtc(This->pIDataObjectSrc,
1418 dwDirection, ppenumFormatEtc);
1422 * Otherwise we must provide our own enumerator which wraps around the
1423 * Windows clipboard function EnumClipboardFormats
1425 if ( !ppenumFormatEtc )
1426 return E_INVALIDARG;
1428 if ( dwDirection != DATADIR_GET ) /* IDataObject_SetData not implemented */
1429 return E_NOTIMPL;
1432 * Store all current clipboard formats in an array of FORMATETC's,
1433 * and create an IEnumFORMATETC enumerator from this list.
1435 cfmt = CountClipboardFormats();
1436 afmt = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
1437 sizeof(FORMATETC) * cfmt);
1439 * Open the Windows clipboard, associating it with our hidden window
1441 if ( !(bClipboardOpen = OpenClipboard(This->hWndClipboard)) )
1442 HANDLE_ERROR( CLIPBRD_E_CANT_OPEN );
1445 * Store all current clipboard formats in an array of FORMATETC's
1446 * TODO: Handle TYMED_IStorage media which were put on the clipboard
1447 * by copying the storage into global memory. We must convert this
1448 * TYMED_HGLOBAL back to TYMED_IStorage.
1450 for (i = 0, format = 0; i < cfmt; i++)
1452 format = EnumClipboardFormats(format);
1453 if (!format) /* Failed! */
1455 ERR("EnumClipboardFormats failed to return format!\n");
1456 HANDLE_ERROR( E_FAIL );
1459 /* Init the FORMATETC struct */
1460 afmt[i].cfFormat = format;
1461 afmt[i].ptd = NULL;
1462 afmt[i].dwAspect = DVASPECT_CONTENT;
1463 afmt[i].lindex = -1;
1464 afmt[i].tymed = TYMED_HGLOBAL;
1468 * Create an EnumFORMATETC enumerator and return an
1469 * EnumFORMATETC after bumping up its ref count
1471 *ppenumFormatEtc = OLEClipbrd_IEnumFORMATETC_Construct( cfmt, afmt, (LPUNKNOWN)iface);
1472 if (!(*ppenumFormatEtc))
1473 HANDLE_ERROR( E_OUTOFMEMORY );
1475 if (FAILED( hr = IEnumFORMATETC_AddRef(*ppenumFormatEtc)))
1476 HANDLE_ERROR( hr );
1478 hr = S_OK;
1480 CLEANUP:
1482 * Free the array of FORMATETC's
1484 HeapFree(GetProcessHeap(), 0, afmt);
1487 * Close Windows clipboard
1489 if ( bClipboardOpen && !CloseClipboard() )
1490 hr = CLIPBRD_E_CANT_CLOSE;
1492 return hr;
1495 /************************************************************************
1496 * OLEClipbrd_IDataObject_DAdvise (IDataObject)
1498 * The OLE Clipboard's does not implement this method
1500 * See Windows documentation for more details on IDataObject methods.
1502 static HRESULT WINAPI OLEClipbrd_IDataObject_DAdvise(
1503 IDataObject* iface,
1504 FORMATETC* pformatetc,
1505 DWORD advf,
1506 IAdviseSink* pAdvSink,
1507 DWORD* pdwConnection)
1509 TRACE("\n");
1510 return E_NOTIMPL;
1513 /************************************************************************
1514 * OLEClipbrd_IDataObject_DUnadvise (IDataObject)
1516 * The OLE Clipboard's does not implement this method
1518 * See Windows documentation for more details on IDataObject methods.
1520 static HRESULT WINAPI OLEClipbrd_IDataObject_DUnadvise(
1521 IDataObject* iface,
1522 DWORD dwConnection)
1524 TRACE("\n");
1525 return E_NOTIMPL;
1528 /************************************************************************
1529 * OLEClipbrd_IDataObject_EnumDAdvise (IDataObject)
1531 * The OLE Clipboard does not implement this method
1533 * See Windows documentation for more details on IDataObject methods.
1535 static HRESULT WINAPI OLEClipbrd_IDataObject_EnumDAdvise(
1536 IDataObject* iface,
1537 IEnumSTATDATA** ppenumAdvise)
1539 TRACE("\n");
1540 return E_NOTIMPL;
1544 /*---------------------------------------------------------------------*
1545 * Implementation of the internal IEnumFORMATETC interface returned by
1546 * the OLE clipboard's IDataObject.
1547 *---------------------------------------------------------------------*/
1549 /************************************************************************
1550 * OLEClipbrd_IEnumFORMATETC_Construct (UINT, const FORMATETC, LPUNKNOWN)
1552 * Creates an IEnumFORMATETC enumerator from an array of FORMATETC
1553 * Structures. pUnkOuter is the outer unknown for reference counting only.
1554 * NOTE: this does not AddRef the interface.
1557 static LPENUMFORMATETC OLEClipbrd_IEnumFORMATETC_Construct(UINT cfmt, const FORMATETC afmt[],
1558 LPUNKNOWN pUnkDataObj)
1560 IEnumFORMATETCImpl* ef;
1561 DWORD size=cfmt * sizeof(FORMATETC);
1562 LPMALLOC pIMalloc;
1564 ef = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IEnumFORMATETCImpl));
1565 if (!ef)
1566 return NULL;
1568 ef->ref = 0;
1569 ef->lpVtbl = &efvt;
1570 ef->pUnkDataObj = pUnkDataObj;
1572 ef->posFmt = 0;
1573 ef->countFmt = cfmt;
1574 if (FAILED(CoGetMalloc(MEMCTX_TASK, &pIMalloc))) {
1575 HeapFree(GetProcessHeap(), 0, ef);
1576 return NULL;
1578 ef->pFmt = (LPFORMATETC)IMalloc_Alloc(pIMalloc, size);
1579 IMalloc_Release(pIMalloc);
1581 if (ef->pFmt)
1582 memcpy(ef->pFmt, afmt, size);
1584 TRACE("(%p)->()\n",ef);
1585 return (LPENUMFORMATETC)ef;
1589 /************************************************************************
1590 * OLEClipbrd_IEnumFORMATETC_QueryInterface (IUnknown)
1592 * See Windows documentation for more details on IUnknown methods.
1594 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_QueryInterface
1595 (LPENUMFORMATETC iface, REFIID riid, LPVOID* ppvObj)
1597 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1599 TRACE("(%p)->(\n\tIID:\t%s,%p)\n",This,debugstr_guid(riid),ppvObj);
1602 * Since enumerators are separate objects from the parent data object
1603 * we only need to support the IUnknown and IEnumFORMATETC interfaces
1606 *ppvObj = NULL;
1608 if(IsEqualIID(riid, &IID_IUnknown))
1610 *ppvObj = This;
1612 else if(IsEqualIID(riid, &IID_IEnumFORMATETC))
1614 *ppvObj = (IDataObject*)This;
1617 if(*ppvObj)
1619 IEnumFORMATETC_AddRef((IEnumFORMATETC*)*ppvObj);
1620 TRACE("-- Interface: (%p)->(%p)\n",ppvObj,*ppvObj);
1621 return S_OK;
1624 TRACE("-- Interface: E_NOINTERFACE\n");
1625 return E_NOINTERFACE;
1628 /************************************************************************
1629 * OLEClipbrd_IEnumFORMATETC_AddRef (IUnknown)
1631 * Since enumerating formats only makes sense when our data object is around,
1632 * we insure that it stays as long as we stay by calling our parents IUnknown
1633 * for AddRef and Release. But since we are not controlled by the lifetime of
1634 * the outer object, we still keep our own reference count in order to
1635 * free ourselves.
1637 static ULONG WINAPI OLEClipbrd_IEnumFORMATETC_AddRef(LPENUMFORMATETC iface)
1639 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1640 TRACE("(%p)->(count=%lu)\n",This, This->ref);
1642 if (This->pUnkDataObj)
1643 IUnknown_AddRef(This->pUnkDataObj);
1645 return InterlockedIncrement(&This->ref);
1648 /************************************************************************
1649 * OLEClipbrd_IEnumFORMATETC_Release (IUnknown)
1651 * See Windows documentation for more details on IUnknown methods.
1653 static ULONG WINAPI OLEClipbrd_IEnumFORMATETC_Release(LPENUMFORMATETC iface)
1655 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1656 LPMALLOC pIMalloc;
1657 ULONG ref;
1659 TRACE("(%p)->(count=%lu)\n",This, This->ref);
1661 if (This->pUnkDataObj)
1662 IUnknown_Release(This->pUnkDataObj); /* Release parent data object */
1664 ref = InterlockedDecrement(&This->ref);
1665 if (!ref)
1667 TRACE("() - destroying IEnumFORMATETC(%p)\n",This);
1668 if (SUCCEEDED(CoGetMalloc(MEMCTX_TASK, &pIMalloc)))
1670 IMalloc_Free(pIMalloc, This->pFmt);
1671 IMalloc_Release(pIMalloc);
1674 HeapFree(GetProcessHeap(),0,This);
1676 return ref;
1679 /************************************************************************
1680 * OLEClipbrd_IEnumFORMATETC_Next (IEnumFORMATETC)
1682 * Standard enumerator members for IEnumFORMATETC
1684 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Next
1685 (LPENUMFORMATETC iface, ULONG celt, FORMATETC *rgelt, ULONG *pceltFethed)
1687 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1688 UINT cfetch;
1689 HRESULT hres = S_FALSE;
1691 TRACE("(%p)->(pos=%u)\n", This, This->posFmt);
1693 if (This->posFmt < This->countFmt)
1695 cfetch = This->countFmt - This->posFmt;
1696 if (cfetch >= celt)
1698 cfetch = celt;
1699 hres = S_OK;
1702 memcpy(rgelt, &This->pFmt[This->posFmt], cfetch * sizeof(FORMATETC));
1703 This->posFmt += cfetch;
1705 else
1707 cfetch = 0;
1710 if (pceltFethed)
1712 *pceltFethed = cfetch;
1715 return hres;
1718 /************************************************************************
1719 * OLEClipbrd_IEnumFORMATETC_Skip (IEnumFORMATETC)
1721 * Standard enumerator members for IEnumFORMATETC
1723 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Skip(LPENUMFORMATETC iface, ULONG celt)
1725 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1726 TRACE("(%p)->(num=%lu)\n", This, celt);
1728 This->posFmt += celt;
1729 if (This->posFmt > This->countFmt)
1731 This->posFmt = This->countFmt;
1732 return S_FALSE;
1734 return S_OK;
1737 /************************************************************************
1738 * OLEClipbrd_IEnumFORMATETC_Reset (IEnumFORMATETC)
1740 * Standard enumerator members for IEnumFORMATETC
1742 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Reset(LPENUMFORMATETC iface)
1744 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1745 TRACE("(%p)->()\n", This);
1747 This->posFmt = 0;
1748 return S_OK;
1751 /************************************************************************
1752 * OLEClipbrd_IEnumFORMATETC_Clone (IEnumFORMATETC)
1754 * Standard enumerator members for IEnumFORMATETC
1756 static HRESULT WINAPI OLEClipbrd_IEnumFORMATETC_Clone
1757 (LPENUMFORMATETC iface, LPENUMFORMATETC* ppenum)
1759 IEnumFORMATETCImpl *This = (IEnumFORMATETCImpl *)iface;
1760 HRESULT hr = S_OK;
1762 TRACE("(%p)->(ppenum=%p)\n", This, ppenum);
1764 if ( !ppenum )
1765 return E_INVALIDARG;
1767 *ppenum = OLEClipbrd_IEnumFORMATETC_Construct(This->countFmt,
1768 This->pFmt,
1769 This->pUnkDataObj);
1771 if (FAILED( hr = IEnumFORMATETC_AddRef(*ppenum)))
1772 return ( hr );
1774 return (*ppenum) ? S_OK : E_OUTOFMEMORY;