4 * Copyright 1999 Francis Beaudet
5 * Copyright 2000 Abey George
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 * The OLE2 data cache supports a whole whack of
23 * interfaces including:
24 * IDataObject, IPersistStorage, IViewObject2,
25 * IOleCache2 and IOleCacheControl.
27 * Most of the implementation details are taken from: Inside OLE
28 * second edition by Kraig Brockschmidt,
31 * - This implementation of the datacache will let your application
32 * load documents that have embedded OLE objects in them and it will
33 * also retrieve the metafile representation of those objects.
34 * - This implementation of the datacache will also allow your
35 * application to save new documents with OLE objects in them.
36 * - The main thing that it doesn't do is allow you to activate
37 * or modify the OLE objects in any way.
38 * - I haven't found any good documentation on the real usage of
39 * the streams created by the data cache. In particular, How to
40 * determine what the XXX stands for in the stream name
41 * "\002OlePresXXX". It appears to just be a counter.
42 * - Also, I don't know the real content of the presentation stream
43 * header. I was able to figure-out where the extent of the object
44 * was stored and the aspect, but that's about it.
50 #define NONAMELESSUNION
51 #define NONAMELESSSTRUCT
58 #include "wine/unicode.h"
60 #include "wine/list.h"
61 #include "wine/debug.h"
63 WINE_DEFAULT_DEBUG_CHANNEL(ole);
65 /****************************************************************************
66 * PresentationDataHeader
68 * This structure represents the header of the \002OlePresXXX stream in
69 * the OLE object storage.
71 typedef struct PresentationDataHeader
74 * - standard clipformat:
75 * DWORD length = 0xffffffff;
77 * - or custom clipformat:
79 * CHAR format_name[length]; (null-terminated)
81 DWORD unknown3; /* 4, possibly TYMED_ISTREAM */
85 DWORD unknown7; /* 0 */
86 DWORD dwObjectExtentX;
87 DWORD dwObjectExtentY;
89 } PresentationDataHeader;
91 typedef struct DataCacheEntry
94 /* format of this entry */
96 /* the clipboard format of the data */
101 * This storage pointer is set through a call to
102 * IPersistStorage_Load. This is where the visual
103 * representation of the object is stored.
110 /* stream number (-1 if not set ) */
111 unsigned short stream_number;
114 /****************************************************************************
120 * List all interface VTables here
122 const IDataObjectVtbl* lpVtbl;
123 const IUnknownVtbl* lpvtblNDIUnknown;
124 const IPersistStorageVtbl* lpvtblIPersistStorage;
125 const IViewObject2Vtbl* lpvtblIViewObject;
126 const IOleCache2Vtbl* lpvtblIOleCache2;
127 const IOleCacheControlVtbl* lpvtblIOleCacheControl;
130 * Reference count of this object
135 * IUnknown implementation of the outer object.
137 IUnknown* outerUnknown;
140 * The user of this object can setup ONE advise sink
141 * connection with the object. These parameters describe
145 DWORD sinkAdviseFlag;
146 IAdviseSink* sinkInterface;
147 IStorage *presentationStorage;
149 /* list of cache entries */
150 struct list cache_list;
151 /* last id assigned to an entry */
157 typedef struct DataCache DataCache;
160 * Here, I define utility macros to help with the casting of the
162 * There is a version to accommodate all of the VTables implemented
166 static inline DataCache *impl_from_IDataObject( IDataObject *iface )
168 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpVtbl));
171 static inline DataCache *impl_from_NDIUnknown( IUnknown *iface )
173 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpvtblNDIUnknown));
176 static inline DataCache *impl_from_IPersistStorage( IPersistStorage *iface )
178 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpvtblIPersistStorage));
181 static inline DataCache *impl_from_IViewObject2( IViewObject2 *iface )
183 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpvtblIViewObject));
186 static inline DataCache *impl_from_IOleCache2( IOleCache2 *iface )
188 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpvtblIOleCache2));
191 static inline DataCache *impl_from_IOleCacheControl( IOleCacheControl *iface )
193 return (DataCache *)((char*)iface - FIELD_OFFSET(DataCache, lpvtblIOleCacheControl));
196 static const char * debugstr_formatetc(const FORMATETC *formatetc)
198 return wine_dbg_sprintf("{ cfFormat = 0x%x, ptd = %p, dwAspect = %d, lindex = %d, tymed = %d }",
199 formatetc->cfFormat, formatetc->ptd, formatetc->dwAspect,
200 formatetc->lindex, formatetc->tymed);
204 * Prototypes for the methods of the DataCache class.
206 static DataCache* DataCache_Construct(REFCLSID clsid,
207 LPUNKNOWN pUnkOuter);
208 static HRESULT DataCacheEntry_OpenPresStream(DataCacheEntry *This,
211 static void DataCacheEntry_Destroy(DataCacheEntry *This)
213 list_remove(&This->entry);
215 IStorage_Release(This->storage);
216 HeapFree(GetProcessHeap(), 0, This->fmtetc.ptd);
217 ReleaseStgMedium(&This->stgmedium);
218 HeapFree(GetProcessHeap(), 0, This);
221 static void DataCache_Destroy(
222 DataCache* ptrToDestroy)
224 DataCacheEntry *cache_entry, *next_cache_entry;
228 if (ptrToDestroy->sinkInterface != NULL)
230 IAdviseSink_Release(ptrToDestroy->sinkInterface);
231 ptrToDestroy->sinkInterface = NULL;
234 LIST_FOR_EACH_ENTRY_SAFE(cache_entry, next_cache_entry, &ptrToDestroy->cache_list, DataCacheEntry, entry)
235 DataCacheEntry_Destroy(cache_entry);
237 if (ptrToDestroy->presentationStorage != NULL)
239 IStorage_Release(ptrToDestroy->presentationStorage);
240 ptrToDestroy->presentationStorage = NULL;
244 * Free the datacache pointer.
246 HeapFree(GetProcessHeap(), 0, ptrToDestroy);
249 static DataCacheEntry *DataCache_GetEntryForFormatEtc(DataCache *This, const FORMATETC *formatetc)
251 DataCacheEntry *cache_entry;
252 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
254 /* FIXME: also compare DVTARGETDEVICEs */
255 if ((!cache_entry->fmtetc.cfFormat || !formatetc->cfFormat || (formatetc->cfFormat == cache_entry->fmtetc.cfFormat)) &&
256 (formatetc->dwAspect == cache_entry->fmtetc.dwAspect) &&
257 (formatetc->lindex == cache_entry->fmtetc.lindex) &&
258 (!cache_entry->fmtetc.tymed || !formatetc->tymed || (formatetc->tymed == cache_entry->fmtetc.tymed)))
264 /* checks that the clipformat and tymed are valid and returns an error if they
265 * aren't and CACHE_S_NOTSUPPORTED if they are valid, but can't be rendered by
267 static HRESULT check_valid_clipformat_and_tymed(CLIPFORMAT cfFormat, DWORD tymed)
269 if (!cfFormat || !tymed ||
270 (cfFormat == CF_METAFILEPICT && tymed == TYMED_MFPICT) ||
271 (cfFormat == CF_BITMAP && tymed == TYMED_GDI) ||
272 (cfFormat == CF_DIB && tymed == TYMED_HGLOBAL) ||
273 (cfFormat == CF_ENHMETAFILE && tymed == TYMED_ENHMF))
275 else if (tymed == TYMED_HGLOBAL)
276 return CACHE_S_FORMATETC_NOTSUPPORTED;
279 WARN("invalid clipformat/tymed combination: %d/%d\n", cfFormat, tymed);
284 static HRESULT DataCache_CreateEntry(DataCache *This, const FORMATETC *formatetc, DataCacheEntry **cache_entry)
288 hr = check_valid_clipformat_and_tymed(formatetc->cfFormat, formatetc->tymed);
291 if (hr == CACHE_S_FORMATETC_NOTSUPPORTED)
292 TRACE("creating unsupported format %d\n", formatetc->cfFormat);
294 *cache_entry = HeapAlloc(GetProcessHeap(), 0, sizeof(**cache_entry));
296 return E_OUTOFMEMORY;
298 (*cache_entry)->fmtetc = *formatetc;
301 (*cache_entry)->fmtetc.ptd = HeapAlloc(GetProcessHeap(), 0, formatetc->ptd->tdSize);
302 memcpy((*cache_entry)->fmtetc.ptd, formatetc->ptd, formatetc->ptd->tdSize);
304 (*cache_entry)->data_cf = 0;
305 (*cache_entry)->stgmedium.tymed = TYMED_NULL;
306 (*cache_entry)->stgmedium.pUnkForRelease = NULL;
307 (*cache_entry)->storage = NULL;
308 (*cache_entry)->id = This->last_cache_id++;
309 (*cache_entry)->dirty = TRUE;
310 (*cache_entry)->stream_number = -1;
311 list_add_tail(&This->cache_list, &(*cache_entry)->entry);
315 /************************************************************************
316 * DataCache_FireOnViewChange
318 * This method will fire an OnViewChange notification to the advise
319 * sink registered with the datacache.
321 * See IAdviseSink::OnViewChange for more details.
323 static void DataCache_FireOnViewChange(
328 TRACE("(%p, %x, %d)\n", this, aspect, lindex);
331 * The sink supplies a filter when it registers
332 * we make sure we only send the notifications when that
335 if ((this->sinkAspects & aspect) != 0)
337 if (this->sinkInterface != NULL)
339 IAdviseSink_OnViewChange(this->sinkInterface,
344 * Some sinks want to be unregistered automatically when
345 * the first notification goes out.
347 if ( (this->sinkAdviseFlag & ADVF_ONLYONCE) != 0)
349 IAdviseSink_Release(this->sinkInterface);
351 this->sinkInterface = NULL;
352 this->sinkAspects = 0;
353 this->sinkAdviseFlag = 0;
359 /* Helper for DataCacheEntry_OpenPresStream */
360 static BOOL DataCache_IsPresentationStream(const STATSTG *elem)
362 /* The presentation streams have names of the form "\002OlePresXXX",
363 * where XXX goes from 000 to 999. */
364 static const WCHAR OlePres[] = { 2,'O','l','e','P','r','e','s' };
366 LPCWSTR name = elem->pwcsName;
368 return (elem->type == STGTY_STREAM)
369 && (strlenW(name) == 11)
370 && (strncmpW(name, OlePres, 8) == 0)
371 && (name[8] >= '0') && (name[8] <= '9')
372 && (name[9] >= '0') && (name[9] <= '9')
373 && (name[10] >= '0') && (name[10] <= '9');
376 static HRESULT read_clipformat(IStream *stream, CLIPFORMAT *clipformat)
384 hr = IStream_Read(stream, &length, sizeof(length), &read);
385 if (hr != S_OK || read != sizeof(length))
386 return DV_E_CLIPFORMAT;
390 hr = IStream_Read(stream, &cf, sizeof(cf), 0);
391 if (hr != S_OK || read != sizeof(cf))
392 return DV_E_CLIPFORMAT;
397 char *format_name = HeapAlloc(GetProcessHeap(), 0, length);
399 return E_OUTOFMEMORY;
400 hr = IStream_Read(stream, format_name, length, &read);
401 if (hr != S_OK || read != length || format_name[length - 1] != '\0')
403 HeapFree(GetProcessHeap(), 0, format_name);
404 return DV_E_CLIPFORMAT;
406 *clipformat = RegisterClipboardFormatA(format_name);
407 HeapFree(GetProcessHeap(), 0, format_name);
412 static HRESULT write_clipformat(IStream *stream, CLIPFORMAT clipformat)
417 if (clipformat < 0xc000)
420 length = GetClipboardFormatNameA(clipformat, NULL, 0);
421 hr = IStream_Write(stream, &length, sizeof(length), NULL);
424 if (clipformat < 0xc000)
426 DWORD cf = clipformat;
427 hr = IStream_Write(stream, &cf, sizeof(cf), NULL);
431 char *format_name = HeapAlloc(GetProcessHeap(), 0, length);
433 return E_OUTOFMEMORY;
434 GetClipboardFormatNameA(clipformat, format_name, length);
435 hr = IStream_Write(stream, format_name, length, NULL);
436 HeapFree(GetProcessHeap(), 0, format_name);
441 /************************************************************************
442 * DataCacheEntry_OpenPresStream
444 * This method will find the stream for the given presentation. It makes
445 * no attempt at fallback.
448 * this - Pointer to the DataCache object
449 * drawAspect - The aspect of the object that we wish to draw.
450 * pStm - A returned stream. It points to the beginning of the
451 * - presentation data, including the header.
454 * S_OK The requested stream has been opened.
455 * OLE_E_BLANK The requested stream could not be found.
456 * Quite a few others I'm too lazy to map correctly.
459 * Algorithm: Scan the elements of the presentation storage, looking
460 * for presentation streams. For each presentation stream,
461 * load the header and check to see if the aspect matches.
463 * If a fallback is desired, just opening the first presentation stream
466 static HRESULT DataCacheEntry_OpenPresStream(
467 DataCacheEntry *This,
474 if (!ppStm) return E_POINTER;
476 hr = IStorage_EnumElements(This->storage, 0, NULL, 0, &pEnum);
477 if (FAILED(hr)) return hr;
479 while ((hr = IEnumSTATSTG_Next(pEnum, 1, &elem, NULL)) == S_OK)
481 if (DataCache_IsPresentationStream(&elem))
485 hr = IStorage_OpenStream(This->storage, elem.pwcsName,
486 NULL, STGM_READ | STGM_SHARE_EXCLUSIVE, 0,
490 PresentationDataHeader header;
492 CLIPFORMAT clipformat;
494 hr = read_clipformat(pStm, &clipformat);
497 hr = IStream_Read(pStm, &header, sizeof(header), &actual_read);
499 /* can't use SUCCEEDED(hr): S_FALSE counts as an error */
500 if (hr == S_OK && actual_read == sizeof(header)
501 && header.dvAspect == This->fmtetc.dwAspect)
503 /* Rewind the stream before returning it. */
504 LARGE_INTEGER offset;
505 offset.u.LowPart = 0;
506 offset.u.HighPart = 0;
507 IStream_Seek(pStm, offset, STREAM_SEEK_SET, NULL);
511 CoTaskMemFree(elem.pwcsName);
512 IEnumSTATSTG_Release(pEnum);
517 IStream_Release(pStm);
521 CoTaskMemFree(elem.pwcsName);
524 IEnumSTATSTG_Release(pEnum);
526 return (hr == S_FALSE ? OLE_E_BLANK : hr);
529 /************************************************************************
530 * DataCacheEntry_LoadData
532 * This method will read information for the requested presentation
533 * into the given structure.
536 * This - The entry to load the data from.
539 * This method returns a metafile handle if it is successful.
540 * it will return 0 if not.
542 static HRESULT DataCacheEntry_LoadData(DataCacheEntry *This)
544 IStream* presStream = NULL;
546 ULARGE_INTEGER current_pos;
549 METAFILEPICT *mfpict;
551 PresentationDataHeader header;
552 CLIPFORMAT clipformat;
553 static const LARGE_INTEGER offset_zero;
556 * Open the presentation stream.
558 hres = DataCacheEntry_OpenPresStream(
566 * Get the size of the stream.
568 hres = IStream_Stat(presStream,
576 hres = read_clipformat(presStream, &clipformat);
579 IStream_Release(presStream);
586 sizeof(PresentationDataHeader),
590 IStream_Release(presStream);
594 hres = IStream_Seek(presStream, offset_zero, STREAM_SEEK_CUR, ¤t_pos);
596 streamInfo.cbSize.QuadPart -= current_pos.QuadPart;
598 hmfpict = GlobalAlloc(GMEM_MOVEABLE, sizeof(METAFILEPICT));
601 IStream_Release(presStream);
602 return E_OUTOFMEMORY;
604 mfpict = GlobalLock(hmfpict);
607 * Allocate a buffer for the metafile bits.
609 metafileBits = HeapAlloc(GetProcessHeap(),
611 streamInfo.cbSize.u.LowPart);
614 * Read the metafile bits.
619 streamInfo.cbSize.u.LowPart,
623 * Create a metafile with those bits.
627 /* FIXME: get this from the stream */
628 mfpict->mm = MM_ANISOTROPIC;
629 mfpict->xExt = header.dwObjectExtentX;
630 mfpict->yExt = header.dwObjectExtentY;
631 mfpict->hMF = SetMetaFileBitsEx(streamInfo.cbSize.u.LowPart, metafileBits);
636 GlobalUnlock(hmfpict);
639 This->data_cf = This->fmtetc.cfFormat;
640 This->stgmedium.tymed = TYMED_MFPICT;
641 This->stgmedium.u.hMetaFilePict = hmfpict;
649 HeapFree(GetProcessHeap(), 0, metafileBits);
650 IStream_Release(presStream);
655 static HRESULT DataCacheEntry_CreateStream(DataCacheEntry *This,
656 IStorage *storage, IStream **stream)
658 WCHAR wszName[] = {2,'O','l','e','P','r','e','s',
659 '0' + (This->stream_number / 100) % 10,
660 '0' + (This->stream_number / 10) % 10,
661 '0' + This->stream_number % 10, 0};
663 /* FIXME: cache the created stream in This? */
664 return IStorage_CreateStream(storage, wszName,
665 STGM_READWRITE | STGM_SHARE_EXCLUSIVE | STGM_CREATE,
669 static HRESULT DataCacheEntry_Save(DataCacheEntry *This, IStorage *storage,
672 PresentationDataHeader header;
674 IStream *pres_stream;
677 TRACE("stream_number = %d, fmtetc = %s\n", This->stream_number, debugstr_formatetc(&This->fmtetc));
679 hr = DataCacheEntry_CreateStream(This, storage, &pres_stream);
683 hr = write_clipformat(pres_stream, This->data_cf);
687 if (This->fmtetc.ptd)
688 FIXME("ptd not serialized\n");
690 header.dvAspect = This->fmtetc.dwAspect;
691 header.lindex = This->fmtetc.lindex;
692 header.tymed = This->stgmedium.tymed;
694 header.dwObjectExtentX = 0;
695 header.dwObjectExtentY = 0;
699 switch (This->data_cf)
701 case CF_METAFILEPICT:
703 if (This->stgmedium.tymed != TYMED_NULL)
705 const METAFILEPICT *mfpict = GlobalLock(This->stgmedium.u.hMetaFilePict);
708 IStream_Release(pres_stream);
709 return DV_E_STGMEDIUM;
711 header.dwObjectExtentX = mfpict->xExt;
712 header.dwObjectExtentY = mfpict->yExt;
713 header.dwSize = GetMetaFileBitsEx(mfpict->hMF, 0, NULL);
714 GlobalUnlock(This->stgmedium.u.hMetaFilePict);
725 hr = IStream_Write(pres_stream, &header, sizeof(PresentationDataHeader),
729 IStream_Release(pres_stream);
734 switch (This->data_cf)
736 case CF_METAFILEPICT:
738 if (This->stgmedium.tymed != TYMED_NULL)
740 const METAFILEPICT *mfpict = GlobalLock(This->stgmedium.u.hMetaFilePict);
743 IStream_Release(pres_stream);
744 return DV_E_STGMEDIUM;
746 data = HeapAlloc(GetProcessHeap(), 0, header.dwSize);
747 GetMetaFileBitsEx(mfpict->hMF, header.dwSize, data);
748 GlobalUnlock(This->stgmedium.u.hMetaFilePict);
757 hr = IStream_Write(pres_stream, data, header.dwSize, NULL);
758 HeapFree(GetProcessHeap(), 0, data);
760 IStream_Release(pres_stream);
764 /* helper for copying STGMEDIUM of type bitmap, MF, EMF or HGLOBAL.
765 * does no checking of whether src_stgm has a supported tymed, so this should be
766 * done in the caller */
767 static HRESULT copy_stg_medium(CLIPFORMAT cf, STGMEDIUM *dest_stgm,
768 const STGMEDIUM *src_stgm)
770 if (src_stgm->tymed == TYMED_MFPICT)
772 const METAFILEPICT *src_mfpict = GlobalLock(src_stgm->u.hMetaFilePict);
773 METAFILEPICT *dest_mfpict;
776 return DV_E_STGMEDIUM;
777 dest_stgm->u.hMetaFilePict = GlobalAlloc(GMEM_MOVEABLE, sizeof(METAFILEPICT));
778 dest_mfpict = GlobalLock(dest_stgm->u.hMetaFilePict);
781 GlobalUnlock(src_stgm->u.hMetaFilePict);
782 return E_OUTOFMEMORY;
784 *dest_mfpict = *src_mfpict;
785 dest_mfpict->hMF = CopyMetaFileW(src_mfpict->hMF, NULL);
786 GlobalUnlock(src_stgm->u.hMetaFilePict);
787 GlobalUnlock(dest_stgm->u.hMetaFilePict);
789 else if (src_stgm->tymed != TYMED_NULL)
791 dest_stgm->u.hGlobal = OleDuplicateData(src_stgm->u.hGlobal, cf,
793 if (!dest_stgm->u.hGlobal)
794 return E_OUTOFMEMORY;
796 dest_stgm->tymed = src_stgm->tymed;
797 dest_stgm->pUnkForRelease = src_stgm->pUnkForRelease;
798 if (dest_stgm->pUnkForRelease)
799 IUnknown_AddRef(dest_stgm->pUnkForRelease);
803 static HRESULT DataCacheEntry_SetData(DataCacheEntry *This,
804 const FORMATETC *formatetc,
805 const STGMEDIUM *stgmedium,
808 if ((!This->fmtetc.cfFormat && !formatetc->cfFormat) ||
809 (This->fmtetc.tymed == TYMED_NULL && formatetc->tymed == TYMED_NULL) ||
810 stgmedium->tymed == TYMED_NULL)
812 WARN("invalid formatetc\n");
813 return DV_E_FORMATETC;
817 ReleaseStgMedium(&This->stgmedium);
818 This->data_cf = This->fmtetc.cfFormat ? This->fmtetc.cfFormat : formatetc->cfFormat;
821 This->stgmedium = *stgmedium;
825 return copy_stg_medium(This->data_cf,
826 &This->stgmedium, stgmedium);
829 static HRESULT DataCacheEntry_GetData(DataCacheEntry *This,
830 STGMEDIUM *stgmedium)
832 if (stgmedium->tymed == TYMED_NULL && This->storage)
834 HRESULT hr = DataCacheEntry_LoadData(This);
838 if (This->stgmedium.tymed == TYMED_NULL)
840 return copy_stg_medium(This->data_cf, stgmedium, &This->stgmedium);
843 static inline HRESULT DataCacheEntry_DiscardData(DataCacheEntry *This)
845 ReleaseStgMedium(&This->stgmedium);
846 This->data_cf = This->fmtetc.cfFormat;
850 static inline void DataCacheEntry_HandsOffStorage(DataCacheEntry *This)
854 IStorage_Release(This->storage);
855 This->storage = NULL;
859 /*********************************************************
860 * Method implementation for the non delegating IUnknown
861 * part of the DataCache class.
864 /************************************************************************
865 * DataCache_NDIUnknown_QueryInterface (IUnknown)
867 * See Windows documentation for more details on IUnknown methods.
869 * This version of QueryInterface will not delegate it's implementation
870 * to the outer unknown.
872 static HRESULT WINAPI DataCache_NDIUnknown_QueryInterface(
877 DataCache *this = impl_from_NDIUnknown(iface);
880 * Perform a sanity check on the parameters.
886 * Initialize the return parameter.
891 * Compare the riid with the interface IDs implemented by this object.
893 if (IsEqualIID(&IID_IUnknown, riid))
897 else if (IsEqualIID(&IID_IDataObject, riid))
899 *ppvObject = &this->lpVtbl;
901 else if ( IsEqualIID(&IID_IPersistStorage, riid) ||
902 IsEqualIID(&IID_IPersist, riid) )
904 *ppvObject = &this->lpvtblIPersistStorage;
906 else if ( IsEqualIID(&IID_IViewObject, riid) ||
907 IsEqualIID(&IID_IViewObject2, riid) )
909 *ppvObject = &this->lpvtblIViewObject;
911 else if ( IsEqualIID(&IID_IOleCache, riid) ||
912 IsEqualIID(&IID_IOleCache2, riid) )
914 *ppvObject = &this->lpvtblIOleCache2;
916 else if ( IsEqualIID(&IID_IOleCacheControl, riid) )
918 *ppvObject = &this->lpvtblIOleCacheControl;
922 * Check that we obtained an interface.
926 WARN( "() : asking for unsupported interface %s\n", debugstr_guid(riid));
927 return E_NOINTERFACE;
931 * Query Interface always increases the reference count by one when it is
934 IUnknown_AddRef((IUnknown*)*ppvObject);
939 /************************************************************************
940 * DataCache_NDIUnknown_AddRef (IUnknown)
942 * See Windows documentation for more details on IUnknown methods.
944 * This version of QueryInterface will not delegate it's implementation
945 * to the outer unknown.
947 static ULONG WINAPI DataCache_NDIUnknown_AddRef(
950 DataCache *this = impl_from_NDIUnknown(iface);
951 return InterlockedIncrement(&this->ref);
954 /************************************************************************
955 * DataCache_NDIUnknown_Release (IUnknown)
957 * See Windows documentation for more details on IUnknown methods.
959 * This version of QueryInterface will not delegate it's implementation
960 * to the outer unknown.
962 static ULONG WINAPI DataCache_NDIUnknown_Release(
965 DataCache *this = impl_from_NDIUnknown(iface);
969 * Decrease the reference count on this object.
971 ref = InterlockedDecrement(&this->ref);
974 * If the reference count goes down to 0, perform suicide.
976 if (ref == 0) DataCache_Destroy(this);
981 /*********************************************************
982 * Method implementation for the IDataObject
983 * part of the DataCache class.
986 /************************************************************************
987 * DataCache_IDataObject_QueryInterface (IUnknown)
989 * See Windows documentation for more details on IUnknown methods.
991 static HRESULT WINAPI DataCache_IDataObject_QueryInterface(
996 DataCache *this = impl_from_IDataObject(iface);
998 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1001 /************************************************************************
1002 * DataCache_IDataObject_AddRef (IUnknown)
1004 * See Windows documentation for more details on IUnknown methods.
1006 static ULONG WINAPI DataCache_IDataObject_AddRef(
1009 DataCache *this = impl_from_IDataObject(iface);
1011 return IUnknown_AddRef(this->outerUnknown);
1014 /************************************************************************
1015 * DataCache_IDataObject_Release (IUnknown)
1017 * See Windows documentation for more details on IUnknown methods.
1019 static ULONG WINAPI DataCache_IDataObject_Release(
1022 DataCache *this = impl_from_IDataObject(iface);
1024 return IUnknown_Release(this->outerUnknown);
1027 /************************************************************************
1030 * Get Data from a source dataobject using format pformatetcIn->cfFormat
1031 * See Windows documentation for more details on GetData.
1033 static HRESULT WINAPI DataCache_GetData(
1035 LPFORMATETC pformatetcIn,
1038 DataCache *This = impl_from_IDataObject(iface);
1039 DataCacheEntry *cache_entry;
1041 memset(pmedium, 0, sizeof(*pmedium));
1043 cache_entry = DataCache_GetEntryForFormatEtc(This, pformatetcIn);
1047 return DataCacheEntry_GetData(cache_entry, pmedium);
1050 static HRESULT WINAPI DataCache_GetDataHere(
1052 LPFORMATETC pformatetc,
1059 static HRESULT WINAPI DataCache_QueryGetData(
1061 LPFORMATETC pformatetc)
1067 /************************************************************************
1068 * DataCache_EnumFormatEtc (IDataObject)
1070 * The data cache doesn't implement this method.
1072 * See Windows documentation for more details on IDataObject methods.
1074 static HRESULT WINAPI DataCache_GetCanonicalFormatEtc(
1076 LPFORMATETC pformatectIn,
1077 LPFORMATETC pformatetcOut)
1083 /************************************************************************
1084 * DataCache_IDataObject_SetData (IDataObject)
1086 * This method is delegated to the IOleCache2 implementation.
1088 * See Windows documentation for more details on IDataObject methods.
1090 static HRESULT WINAPI DataCache_IDataObject_SetData(
1092 LPFORMATETC pformatetc,
1096 IOleCache2* oleCache = NULL;
1099 TRACE("(%p, %p, %p, %d)\n", iface, pformatetc, pmedium, fRelease);
1101 hres = IDataObject_QueryInterface(iface, &IID_IOleCache2, (void**)&oleCache);
1104 return E_UNEXPECTED;
1106 hres = IOleCache2_SetData(oleCache, pformatetc, pmedium, fRelease);
1108 IOleCache2_Release(oleCache);
1113 /************************************************************************
1114 * DataCache_EnumFormatEtc (IDataObject)
1116 * The data cache doesn't implement this method.
1118 * See Windows documentation for more details on IDataObject methods.
1120 static HRESULT WINAPI DataCache_EnumFormatEtc(
1123 IEnumFORMATETC** ppenumFormatEtc)
1129 /************************************************************************
1130 * DataCache_DAdvise (IDataObject)
1132 * The data cache doesn't support connections.
1134 * See Windows documentation for more details on IDataObject methods.
1136 static HRESULT WINAPI DataCache_DAdvise(
1138 FORMATETC* pformatetc,
1140 IAdviseSink* pAdvSink,
1141 DWORD* pdwConnection)
1144 return OLE_E_ADVISENOTSUPPORTED;
1147 /************************************************************************
1148 * DataCache_DUnadvise (IDataObject)
1150 * The data cache doesn't support connections.
1152 * See Windows documentation for more details on IDataObject methods.
1154 static HRESULT WINAPI DataCache_DUnadvise(
1159 return OLE_E_NOCONNECTION;
1162 /************************************************************************
1163 * DataCache_EnumDAdvise (IDataObject)
1165 * The data cache doesn't support connections.
1167 * See Windows documentation for more details on IDataObject methods.
1169 static HRESULT WINAPI DataCache_EnumDAdvise(
1171 IEnumSTATDATA** ppenumAdvise)
1174 return OLE_E_ADVISENOTSUPPORTED;
1177 /*********************************************************
1178 * Method implementation for the IDataObject
1179 * part of the DataCache class.
1182 /************************************************************************
1183 * DataCache_IPersistStorage_QueryInterface (IUnknown)
1185 * See Windows documentation for more details on IUnknown methods.
1187 static HRESULT WINAPI DataCache_IPersistStorage_QueryInterface(
1188 IPersistStorage* iface,
1192 DataCache *this = impl_from_IPersistStorage(iface);
1194 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1197 /************************************************************************
1198 * DataCache_IPersistStorage_AddRef (IUnknown)
1200 * See Windows documentation for more details on IUnknown methods.
1202 static ULONG WINAPI DataCache_IPersistStorage_AddRef(
1203 IPersistStorage* iface)
1205 DataCache *this = impl_from_IPersistStorage(iface);
1207 return IUnknown_AddRef(this->outerUnknown);
1210 /************************************************************************
1211 * DataCache_IPersistStorage_Release (IUnknown)
1213 * See Windows documentation for more details on IUnknown methods.
1215 static ULONG WINAPI DataCache_IPersistStorage_Release(
1216 IPersistStorage* iface)
1218 DataCache *this = impl_from_IPersistStorage(iface);
1220 return IUnknown_Release(this->outerUnknown);
1223 /************************************************************************
1224 * DataCache_GetClassID (IPersistStorage)
1226 * The data cache doesn't implement this method.
1228 * See Windows documentation for more details on IPersistStorage methods.
1230 static HRESULT WINAPI DataCache_GetClassID(
1231 IPersistStorage* iface,
1234 DataCache *This = impl_from_IPersistStorage(iface);
1235 DataCacheEntry *cache_entry;
1237 TRACE("(%p, %p)\n", iface, pClassID);
1239 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1241 if (cache_entry->storage != NULL)
1244 HRESULT hr = IStorage_Stat(cache_entry->storage, &statstg, STATFLAG_NONAME);
1247 *pClassID = statstg.clsid;
1253 *pClassID = CLSID_NULL;
1258 /************************************************************************
1259 * DataCache_IsDirty (IPersistStorage)
1261 * See Windows documentation for more details on IPersistStorage methods.
1263 static HRESULT WINAPI DataCache_IsDirty(
1264 IPersistStorage* iface)
1266 DataCache *This = impl_from_IPersistStorage(iface);
1267 DataCacheEntry *cache_entry;
1269 TRACE("(%p)\n", iface);
1274 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1275 if (cache_entry->dirty)
1281 /************************************************************************
1282 * DataCache_InitNew (IPersistStorage)
1284 * The data cache implementation of IPersistStorage_InitNew simply stores
1285 * the storage pointer.
1287 * See Windows documentation for more details on IPersistStorage methods.
1289 static HRESULT WINAPI DataCache_InitNew(
1290 IPersistStorage* iface,
1293 DataCache *This = impl_from_IPersistStorage(iface);
1295 TRACE("(%p, %p)\n", iface, pStg);
1297 if (This->presentationStorage != NULL)
1298 IStorage_Release(This->presentationStorage);
1300 This->presentationStorage = pStg;
1302 IStorage_AddRef(This->presentationStorage);
1308 /************************************************************************
1309 * DataCache_Load (IPersistStorage)
1311 * The data cache implementation of IPersistStorage_Load doesn't
1312 * actually load anything. Instead, it holds on to the storage pointer
1313 * and it will load the presentation information when the
1314 * IDataObject_GetData or IViewObject2_Draw methods are called.
1316 * See Windows documentation for more details on IPersistStorage methods.
1318 static HRESULT WINAPI DataCache_Load(
1319 IPersistStorage* iface,
1322 DataCache *This = impl_from_IPersistStorage(iface);
1324 IEnumSTATSTG *pEnum;
1327 TRACE("(%p, %p)\n", iface, pStg);
1329 if (This->presentationStorage != NULL)
1330 IStorage_Release(This->presentationStorage);
1332 This->presentationStorage = pStg;
1334 hr = IStorage_EnumElements(pStg, 0, NULL, 0, &pEnum);
1335 if (FAILED(hr)) return hr;
1337 while ((hr = IEnumSTATSTG_Next(pEnum, 1, &elem, NULL)) == S_OK)
1339 if (DataCache_IsPresentationStream(&elem))
1343 hr = IStorage_OpenStream(This->presentationStorage, elem.pwcsName,
1344 NULL, STGM_READ | STGM_SHARE_EXCLUSIVE, 0,
1348 PresentationDataHeader header;
1350 CLIPFORMAT clipformat;
1352 hr = read_clipformat(pStm, &clipformat);
1355 hr = IStream_Read(pStm, &header, sizeof(header),
1358 /* can't use SUCCEEDED(hr): S_FALSE counts as an error */
1359 if (hr == S_OK && actual_read == sizeof(header))
1361 DataCacheEntry *cache_entry;
1364 fmtetc.cfFormat = clipformat;
1365 fmtetc.ptd = NULL; /* FIXME */
1366 fmtetc.dwAspect = header.dvAspect;
1367 fmtetc.lindex = header.lindex;
1368 fmtetc.tymed = header.tymed;
1370 TRACE("loading entry with formatetc: %s\n", debugstr_formatetc(&fmtetc));
1372 cache_entry = DataCache_GetEntryForFormatEtc(This, &fmtetc);
1374 hr = DataCache_CreateEntry(This, &fmtetc, &cache_entry);
1377 DataCacheEntry_DiscardData(cache_entry);
1378 if (cache_entry->storage) IStorage_Release(cache_entry->storage);
1379 cache_entry->storage = pStg;
1380 IStorage_AddRef(pStg);
1381 cache_entry->dirty = FALSE;
1385 IStream_Release(pStm);
1389 CoTaskMemFree(elem.pwcsName);
1392 This->dirty = FALSE;
1394 IEnumSTATSTG_Release(pEnum);
1396 IStorage_AddRef(This->presentationStorage);
1400 /************************************************************************
1401 * DataCache_Save (IPersistStorage)
1403 * Until we actually connect to a running object and retrieve new
1404 * information to it, we never have to save anything. However, it is
1405 * our responsibility to copy the information when saving to a new
1408 * See Windows documentation for more details on IPersistStorage methods.
1410 static HRESULT WINAPI DataCache_Save(
1411 IPersistStorage* iface,
1415 DataCache *This = impl_from_IPersistStorage(iface);
1416 DataCacheEntry *cache_entry;
1419 unsigned short stream_number = 0;
1421 TRACE("(%p, %p, %d)\n", iface, pStg, fSameAsLoad);
1423 dirty = This->dirty;
1426 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1428 dirty = cache_entry->dirty;
1434 /* this is a shortcut if nothing changed */
1435 if (!dirty && !fSameAsLoad && This->presentationStorage)
1437 return IStorage_CopyTo(This->presentationStorage, 0, NULL, NULL, pStg);
1440 /* assign stream numbers to the cache entries */
1441 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1443 if (cache_entry->stream_number != stream_number)
1445 cache_entry->dirty = TRUE; /* needs to be written out again */
1446 cache_entry->stream_number = stream_number;
1451 /* write out the cache entries */
1452 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1454 if (!fSameAsLoad || cache_entry->dirty)
1456 hr = DataCacheEntry_Save(cache_entry, pStg, fSameAsLoad);
1460 cache_entry->dirty = FALSE;
1464 This->dirty = FALSE;
1468 /************************************************************************
1469 * DataCache_SaveCompleted (IPersistStorage)
1471 * This method is called to tell the cache to release the storage
1472 * pointer it's currently holding.
1474 * See Windows documentation for more details on IPersistStorage methods.
1476 static HRESULT WINAPI DataCache_SaveCompleted(
1477 IPersistStorage* iface,
1480 TRACE("(%p, %p)\n", iface, pStgNew);
1485 * First, make sure we get our hands off any storage we have.
1488 IPersistStorage_HandsOffStorage(iface);
1491 * Then, attach to the new storage.
1494 DataCache_Load(iface, pStgNew);
1500 /************************************************************************
1501 * DataCache_HandsOffStorage (IPersistStorage)
1503 * This method is called to tell the cache to release the storage
1504 * pointer it's currently holding.
1506 * See Windows documentation for more details on IPersistStorage methods.
1508 static HRESULT WINAPI DataCache_HandsOffStorage(
1509 IPersistStorage* iface)
1511 DataCache *this = impl_from_IPersistStorage(iface);
1512 DataCacheEntry *cache_entry;
1514 TRACE("(%p)\n", iface);
1516 if (this->presentationStorage != NULL)
1518 IStorage_Release(this->presentationStorage);
1519 this->presentationStorage = NULL;
1522 LIST_FOR_EACH_ENTRY(cache_entry, &this->cache_list, DataCacheEntry, entry)
1523 DataCacheEntry_HandsOffStorage(cache_entry);
1528 /*********************************************************
1529 * Method implementation for the IViewObject2
1530 * part of the DataCache class.
1533 /************************************************************************
1534 * DataCache_IViewObject2_QueryInterface (IUnknown)
1536 * See Windows documentation for more details on IUnknown methods.
1538 static HRESULT WINAPI DataCache_IViewObject2_QueryInterface(
1539 IViewObject2* iface,
1543 DataCache *this = impl_from_IViewObject2(iface);
1545 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1548 /************************************************************************
1549 * DataCache_IViewObject2_AddRef (IUnknown)
1551 * See Windows documentation for more details on IUnknown methods.
1553 static ULONG WINAPI DataCache_IViewObject2_AddRef(
1554 IViewObject2* iface)
1556 DataCache *this = impl_from_IViewObject2(iface);
1558 return IUnknown_AddRef(this->outerUnknown);
1561 /************************************************************************
1562 * DataCache_IViewObject2_Release (IUnknown)
1564 * See Windows documentation for more details on IUnknown methods.
1566 static ULONG WINAPI DataCache_IViewObject2_Release(
1567 IViewObject2* iface)
1569 DataCache *this = impl_from_IViewObject2(iface);
1571 return IUnknown_Release(this->outerUnknown);
1574 /************************************************************************
1575 * DataCache_Draw (IViewObject2)
1577 * This method will draw the cached representation of the object
1578 * to the given device context.
1580 * See Windows documentation for more details on IViewObject2 methods.
1582 static HRESULT WINAPI DataCache_Draw(
1583 IViewObject2* iface,
1587 DVTARGETDEVICE* ptd,
1590 LPCRECTL lprcBounds,
1591 LPCRECTL lprcWBounds,
1592 BOOL (CALLBACK *pfnContinue)(ULONG_PTR dwContinue),
1593 ULONG_PTR dwContinue)
1595 DataCache *This = impl_from_IViewObject2(iface);
1597 DataCacheEntry *cache_entry;
1599 TRACE("(%p, %x, %d, %p, %p, %p, %p, %p, %p, %lx)\n",
1614 if (lprcBounds==NULL)
1615 return E_INVALIDARG;
1617 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1619 /* FIXME: compare ptd too */
1620 if ((cache_entry->fmtetc.dwAspect != dwDrawAspect) ||
1621 (cache_entry->fmtetc.lindex != lindex))
1624 /* if the data hasn't been loaded yet, do it now */
1625 if ((cache_entry->stgmedium.tymed == TYMED_NULL) && cache_entry->storage)
1627 hres = DataCacheEntry_LoadData(cache_entry);
1633 if (cache_entry->stgmedium.tymed == TYMED_NULL)
1636 if (pfnContinue && !pfnContinue(dwContinue)) return E_ABORT;
1638 switch (cache_entry->data_cf)
1640 case CF_METAFILEPICT:
1643 * We have to be careful not to modify the state of the
1648 SIZE oldViewportExt;
1649 POINT oldViewportOrg;
1650 METAFILEPICT *mfpict;
1652 if ((cache_entry->stgmedium.tymed != TYMED_MFPICT) ||
1653 !((mfpict = GlobalLock(cache_entry->stgmedium.u.hMetaFilePict))))
1656 prevMapMode = SetMapMode(hdcDraw, mfpict->mm);
1658 SetWindowExtEx(hdcDraw,
1663 SetViewportExtEx(hdcDraw,
1664 lprcBounds->right - lprcBounds->left,
1665 lprcBounds->bottom - lprcBounds->top,
1668 SetViewportOrgEx(hdcDraw,
1673 PlayMetaFile(hdcDraw, mfpict->hMF);
1675 SetWindowExtEx(hdcDraw,
1680 SetViewportExtEx(hdcDraw,
1685 SetViewportOrgEx(hdcDraw,
1690 SetMapMode(hdcDraw, prevMapMode);
1692 GlobalUnlock(cache_entry->stgmedium.u.hMetaFilePict);
1699 WARN("no data could be found to be drawn\n");
1704 static HRESULT WINAPI DataCache_GetColorSet(
1705 IViewObject2* iface,
1709 DVTARGETDEVICE* ptd,
1710 HDC hicTargetDevice,
1711 LOGPALETTE** ppColorSet)
1717 static HRESULT WINAPI DataCache_Freeze(
1718 IViewObject2* iface,
1728 static HRESULT WINAPI DataCache_Unfreeze(
1729 IViewObject2* iface,
1736 /************************************************************************
1737 * DataCache_SetAdvise (IViewObject2)
1739 * This sets-up an advisory sink with the data cache. When the object's
1740 * view changes, this sink is called.
1742 * See Windows documentation for more details on IViewObject2 methods.
1744 static HRESULT WINAPI DataCache_SetAdvise(
1745 IViewObject2* iface,
1748 IAdviseSink* pAdvSink)
1750 DataCache *this = impl_from_IViewObject2(iface);
1752 TRACE("(%p, %x, %x, %p)\n", iface, aspects, advf, pAdvSink);
1755 * A call to this function removes the previous sink
1757 if (this->sinkInterface != NULL)
1759 IAdviseSink_Release(this->sinkInterface);
1760 this->sinkInterface = NULL;
1761 this->sinkAspects = 0;
1762 this->sinkAdviseFlag = 0;
1766 * Now, setup the new one.
1770 this->sinkInterface = pAdvSink;
1771 this->sinkAspects = aspects;
1772 this->sinkAdviseFlag = advf;
1774 IAdviseSink_AddRef(this->sinkInterface);
1778 * When the ADVF_PRIMEFIRST flag is set, we have to advise the
1781 if (advf & ADVF_PRIMEFIRST)
1783 DataCache_FireOnViewChange(this, aspects, -1);
1789 /************************************************************************
1790 * DataCache_GetAdvise (IViewObject2)
1792 * This method queries the current state of the advise sink
1793 * installed on the data cache.
1795 * See Windows documentation for more details on IViewObject2 methods.
1797 static HRESULT WINAPI DataCache_GetAdvise(
1798 IViewObject2* iface,
1801 IAdviseSink** ppAdvSink)
1803 DataCache *this = impl_from_IViewObject2(iface);
1805 TRACE("(%p, %p, %p, %p)\n", iface, pAspects, pAdvf, ppAdvSink);
1808 * Just copy all the requested values.
1811 *pAspects = this->sinkAspects;
1814 *pAdvf = this->sinkAdviseFlag;
1816 if (ppAdvSink!=NULL)
1818 if (this->sinkInterface != NULL)
1819 IAdviseSink_QueryInterface(this->sinkInterface,
1822 else *ppAdvSink = NULL;
1828 /************************************************************************
1829 * DataCache_GetExtent (IViewObject2)
1831 * This method retrieves the "natural" size of this cached object.
1833 * See Windows documentation for more details on IViewObject2 methods.
1835 static HRESULT WINAPI DataCache_GetExtent(
1836 IViewObject2* iface,
1839 DVTARGETDEVICE* ptd,
1842 DataCache *This = impl_from_IViewObject2(iface);
1843 HRESULT hres = E_FAIL;
1844 DataCacheEntry *cache_entry;
1846 TRACE("(%p, %x, %d, %p, %p)\n",
1847 iface, dwDrawAspect, lindex, ptd, lpsizel);
1856 * Initialize the out parameter.
1862 * This flag should be set to -1.
1865 FIXME("Unimplemented flag lindex = %d\n", lindex);
1868 * Right now, we support only the callback from
1869 * the default handler.
1872 FIXME("Unimplemented ptd = %p\n", ptd);
1874 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1876 /* FIXME: compare ptd too */
1877 if ((cache_entry->fmtetc.dwAspect != dwDrawAspect) ||
1878 (cache_entry->fmtetc.lindex != lindex))
1881 /* if the data hasn't been loaded yet, do it now */
1882 if ((cache_entry->stgmedium.tymed == TYMED_NULL) && cache_entry->storage)
1884 hres = DataCacheEntry_LoadData(cache_entry);
1890 if (cache_entry->stgmedium.tymed == TYMED_NULL)
1894 switch (cache_entry->data_cf)
1896 case CF_METAFILEPICT:
1898 METAFILEPICT *mfpict;
1900 if ((cache_entry->stgmedium.tymed != TYMED_MFPICT) ||
1901 !((mfpict = GlobalLock(cache_entry->stgmedium.u.hMetaFilePict))))
1904 lpsizel->cx = mfpict->xExt;
1905 lpsizel->cy = mfpict->yExt;
1907 GlobalUnlock(cache_entry->stgmedium.u.hMetaFilePict);
1914 WARN("no data could be found to get the extents from\n");
1917 * This method returns OLE_E_BLANK when it fails.
1923 /*********************************************************
1924 * Method implementation for the IOleCache2
1925 * part of the DataCache class.
1928 /************************************************************************
1929 * DataCache_IOleCache2_QueryInterface (IUnknown)
1931 * See Windows documentation for more details on IUnknown methods.
1933 static HRESULT WINAPI DataCache_IOleCache2_QueryInterface(
1938 DataCache *this = impl_from_IOleCache2(iface);
1940 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1943 /************************************************************************
1944 * DataCache_IOleCache2_AddRef (IUnknown)
1946 * See Windows documentation for more details on IUnknown methods.
1948 static ULONG WINAPI DataCache_IOleCache2_AddRef(
1951 DataCache *this = impl_from_IOleCache2(iface);
1953 return IUnknown_AddRef(this->outerUnknown);
1956 /************************************************************************
1957 * DataCache_IOleCache2_Release (IUnknown)
1959 * See Windows documentation for more details on IUnknown methods.
1961 static ULONG WINAPI DataCache_IOleCache2_Release(
1964 DataCache *this = impl_from_IOleCache2(iface);
1966 return IUnknown_Release(this->outerUnknown);
1969 static HRESULT WINAPI DataCache_Cache(
1971 FORMATETC* pformatetc,
1973 DWORD* pdwConnection)
1975 DataCache *This = impl_from_IOleCache2(iface);
1976 DataCacheEntry *cache_entry;
1979 TRACE("(%p, 0x%x, %p)\n", pformatetc, advf, pdwConnection);
1981 if (!pformatetc || !pdwConnection)
1982 return E_INVALIDARG;
1984 TRACE("pformatetc = %s\n", debugstr_formatetc(pformatetc));
1988 cache_entry = DataCache_GetEntryForFormatEtc(This, pformatetc);
1991 TRACE("found an existing cache entry\n");
1992 *pdwConnection = cache_entry->id;
1993 return CACHE_S_SAMECACHE;
1996 hr = DataCache_CreateEntry(This, pformatetc, &cache_entry);
1999 *pdwConnection = cache_entry->id;
2004 static HRESULT WINAPI DataCache_Uncache(
2008 DataCache *This = impl_from_IOleCache2(iface);
2009 DataCacheEntry *cache_entry;
2011 TRACE("(%d)\n", dwConnection);
2013 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
2014 if (cache_entry->id == dwConnection)
2016 DataCacheEntry_Destroy(cache_entry);
2020 WARN("no connection found for %d\n", dwConnection);
2022 return OLE_E_NOCONNECTION;
2025 static HRESULT WINAPI DataCache_EnumCache(
2027 IEnumSTATDATA** ppenumSTATDATA)
2033 static HRESULT WINAPI DataCache_InitCache(
2035 IDataObject* pDataObject)
2041 static HRESULT WINAPI DataCache_IOleCache2_SetData(
2043 FORMATETC* pformatetc,
2047 DataCache *This = impl_from_IOleCache2(iface);
2048 DataCacheEntry *cache_entry;
2051 TRACE("(%p, %p, %s)\n", pformatetc, pmedium, fRelease ? "TRUE" : "FALSE");
2052 TRACE("formatetc = %s\n", debugstr_formatetc(pformatetc));
2054 cache_entry = DataCache_GetEntryForFormatEtc(This, pformatetc);
2057 hr = DataCacheEntry_SetData(cache_entry, pformatetc, pmedium, fRelease);
2060 DataCache_FireOnViewChange(This, cache_entry->fmtetc.dwAspect,
2061 cache_entry->fmtetc.lindex);
2065 WARN("cache entry not found\n");
2070 static HRESULT WINAPI DataCache_UpdateCache(
2072 LPDATAOBJECT pDataObject,
2076 FIXME("(%p, 0x%x, %p): stub\n", pDataObject, grfUpdf, pReserved);
2080 static HRESULT WINAPI DataCache_DiscardCache(
2082 DWORD dwDiscardOptions)
2084 DataCache *This = impl_from_IOleCache2(iface);
2085 DataCacheEntry *cache_entry;
2088 TRACE("(%d)\n", dwDiscardOptions);
2090 if (dwDiscardOptions == DISCARDCACHE_SAVEIFDIRTY)
2091 hr = DataCache_Save((IPersistStorage *)&This->lpvtblIPersistStorage,
2092 This->presentationStorage, TRUE);
2094 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
2096 hr = DataCacheEntry_DiscardData(cache_entry);
2105 /*********************************************************
2106 * Method implementation for the IOleCacheControl
2107 * part of the DataCache class.
2110 /************************************************************************
2111 * DataCache_IOleCacheControl_QueryInterface (IUnknown)
2113 * See Windows documentation for more details on IUnknown methods.
2115 static HRESULT WINAPI DataCache_IOleCacheControl_QueryInterface(
2116 IOleCacheControl* iface,
2120 DataCache *this = impl_from_IOleCacheControl(iface);
2122 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
2125 /************************************************************************
2126 * DataCache_IOleCacheControl_AddRef (IUnknown)
2128 * See Windows documentation for more details on IUnknown methods.
2130 static ULONG WINAPI DataCache_IOleCacheControl_AddRef(
2131 IOleCacheControl* iface)
2133 DataCache *this = impl_from_IOleCacheControl(iface);
2135 return IUnknown_AddRef(this->outerUnknown);
2138 /************************************************************************
2139 * DataCache_IOleCacheControl_Release (IUnknown)
2141 * See Windows documentation for more details on IUnknown methods.
2143 static ULONG WINAPI DataCache_IOleCacheControl_Release(
2144 IOleCacheControl* iface)
2146 DataCache *this = impl_from_IOleCacheControl(iface);
2148 return IUnknown_Release(this->outerUnknown);
2151 static HRESULT WINAPI DataCache_OnRun(
2152 IOleCacheControl* iface,
2153 LPDATAOBJECT pDataObject)
2159 static HRESULT WINAPI DataCache_OnStop(
2160 IOleCacheControl* iface)
2167 * Virtual function tables for the DataCache class.
2169 static const IUnknownVtbl DataCache_NDIUnknown_VTable =
2171 DataCache_NDIUnknown_QueryInterface,
2172 DataCache_NDIUnknown_AddRef,
2173 DataCache_NDIUnknown_Release
2176 static const IDataObjectVtbl DataCache_IDataObject_VTable =
2178 DataCache_IDataObject_QueryInterface,
2179 DataCache_IDataObject_AddRef,
2180 DataCache_IDataObject_Release,
2182 DataCache_GetDataHere,
2183 DataCache_QueryGetData,
2184 DataCache_GetCanonicalFormatEtc,
2185 DataCache_IDataObject_SetData,
2186 DataCache_EnumFormatEtc,
2188 DataCache_DUnadvise,
2189 DataCache_EnumDAdvise
2192 static const IPersistStorageVtbl DataCache_IPersistStorage_VTable =
2194 DataCache_IPersistStorage_QueryInterface,
2195 DataCache_IPersistStorage_AddRef,
2196 DataCache_IPersistStorage_Release,
2197 DataCache_GetClassID,
2202 DataCache_SaveCompleted,
2203 DataCache_HandsOffStorage
2206 static const IViewObject2Vtbl DataCache_IViewObject2_VTable =
2208 DataCache_IViewObject2_QueryInterface,
2209 DataCache_IViewObject2_AddRef,
2210 DataCache_IViewObject2_Release,
2212 DataCache_GetColorSet,
2215 DataCache_SetAdvise,
2216 DataCache_GetAdvise,
2220 static const IOleCache2Vtbl DataCache_IOleCache2_VTable =
2222 DataCache_IOleCache2_QueryInterface,
2223 DataCache_IOleCache2_AddRef,
2224 DataCache_IOleCache2_Release,
2227 DataCache_EnumCache,
2228 DataCache_InitCache,
2229 DataCache_IOleCache2_SetData,
2230 DataCache_UpdateCache,
2231 DataCache_DiscardCache
2234 static const IOleCacheControlVtbl DataCache_IOleCacheControl_VTable =
2236 DataCache_IOleCacheControl_QueryInterface,
2237 DataCache_IOleCacheControl_AddRef,
2238 DataCache_IOleCacheControl_Release,
2243 /******************************************************************************
2244 * CreateDataCache [OLE32.@]
2246 * Creates a data cache to allow an object to render one or more of its views,
2247 * whether running or not.
2250 * pUnkOuter [I] Outer unknown for the object.
2252 * riid [I] IID of interface to return.
2253 * ppvObj [O] Address where the data cache object will be stored on return.
2257 * Failure: HRESULT code.
2260 * The following interfaces are supported by the returned data cache object:
2261 * IOleCache, IOleCache2, IOleCacheControl, IPersistStorage, IDataObject,
2262 * IViewObject and IViewObject2.
2264 HRESULT WINAPI CreateDataCache(
2265 LPUNKNOWN pUnkOuter,
2270 DataCache* newCache = NULL;
2273 TRACE("(%s, %p, %s, %p)\n", debugstr_guid(rclsid), pUnkOuter, debugstr_guid(riid), ppvObj);
2284 * If this cache is constructed for aggregation, make sure
2285 * the caller is requesting the IUnknown interface.
2286 * This is necessary because it's the only time the non-delegating
2287 * IUnknown pointer can be returned to the outside.
2289 if ( pUnkOuter && !IsEqualIID(&IID_IUnknown, riid) )
2290 return CLASS_E_NOAGGREGATION;
2293 * Try to construct a new instance of the class.
2295 newCache = DataCache_Construct(rclsid,
2299 return E_OUTOFMEMORY;
2302 * Make sure it supports the interface required by the caller.
2304 hr = IUnknown_QueryInterface((IUnknown*)&(newCache->lpvtblNDIUnknown), riid, ppvObj);
2307 * Release the reference obtained in the constructor. If
2308 * the QueryInterface was unsuccessful, it will free the class.
2310 IUnknown_Release((IUnknown*)&(newCache->lpvtblNDIUnknown));
2315 /*********************************************************
2316 * Method implementation for DataCache class.
2318 static DataCache* DataCache_Construct(
2320 LPUNKNOWN pUnkOuter)
2322 DataCache* newObject = 0;
2325 * Allocate space for the object.
2327 newObject = HeapAlloc(GetProcessHeap(), 0, sizeof(DataCache));
2333 * Initialize the virtual function table.
2335 newObject->lpVtbl = &DataCache_IDataObject_VTable;
2336 newObject->lpvtblNDIUnknown = &DataCache_NDIUnknown_VTable;
2337 newObject->lpvtblIPersistStorage = &DataCache_IPersistStorage_VTable;
2338 newObject->lpvtblIViewObject = &DataCache_IViewObject2_VTable;
2339 newObject->lpvtblIOleCache2 = &DataCache_IOleCache2_VTable;
2340 newObject->lpvtblIOleCacheControl = &DataCache_IOleCacheControl_VTable;
2343 * Start with one reference count. The caller of this function
2344 * must release the interface pointer when it is done.
2349 * Initialize the outer unknown
2350 * We don't keep a reference on the outer unknown since, the way
2351 * aggregation works, our lifetime is at least as large as its
2354 if (pUnkOuter==NULL)
2355 pUnkOuter = (IUnknown*)&(newObject->lpvtblNDIUnknown);
2357 newObject->outerUnknown = pUnkOuter;
2360 * Initialize the other members of the structure.
2362 newObject->sinkAspects = 0;
2363 newObject->sinkAdviseFlag = 0;
2364 newObject->sinkInterface = 0;
2365 newObject->presentationStorage = NULL;
2366 list_init(&newObject->cache_list);
2367 newObject->last_cache_id = 1;
2368 newObject->dirty = FALSE;