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)
659 WCHAR wszName[] = {2,'O','l','e','P','r','e','s',
660 '0' + (This->stream_number / 100) % 10,
661 '0' + (This->stream_number / 10) % 10,
662 '0' + This->stream_number % 10, 0};
664 /* FIXME: cache the created stream in This? */
665 hr = IStorage_CreateStream(storage, wszName,
666 STGM_READWRITE | STGM_SHARE_EXCLUSIVE | STGM_CREATE,
671 static HRESULT DataCacheEntry_Save(DataCacheEntry *This, IStorage *storage,
674 PresentationDataHeader header;
676 IStream *pres_stream;
679 TRACE("stream_number = %d, fmtetc = %s\n", This->stream_number, debugstr_formatetc(&This->fmtetc));
681 hr = DataCacheEntry_CreateStream(This, storage, &pres_stream);
685 hr = write_clipformat(pres_stream, This->data_cf);
689 if (This->fmtetc.ptd)
690 FIXME("ptd not serialized\n");
692 header.dvAspect = This->fmtetc.dwAspect;
693 header.lindex = This->fmtetc.lindex;
694 header.tymed = This->stgmedium.tymed;
696 header.dwObjectExtentX = 0;
697 header.dwObjectExtentY = 0;
701 switch (This->data_cf)
703 case CF_METAFILEPICT:
705 if (This->stgmedium.tymed != TYMED_NULL)
707 const METAFILEPICT *mfpict = GlobalLock(This->stgmedium.u.hMetaFilePict);
710 IStream_Release(pres_stream);
711 return DV_E_STGMEDIUM;
713 header.dwObjectExtentX = mfpict->xExt;
714 header.dwObjectExtentY = mfpict->yExt;
715 header.dwSize = GetMetaFileBitsEx(mfpict->hMF, 0, NULL);
716 GlobalUnlock(This->stgmedium.u.hMetaFilePict);
727 hr = IStream_Write(pres_stream, &header, sizeof(PresentationDataHeader),
731 IStream_Release(pres_stream);
736 switch (This->data_cf)
738 case CF_METAFILEPICT:
740 if (This->stgmedium.tymed != TYMED_NULL)
742 const METAFILEPICT *mfpict = GlobalLock(This->stgmedium.u.hMetaFilePict);
745 IStream_Release(pres_stream);
746 return DV_E_STGMEDIUM;
748 data = HeapAlloc(GetProcessHeap(), 0, header.dwSize);
749 GetMetaFileBitsEx(mfpict->hMF, header.dwSize, data);
750 GlobalUnlock(This->stgmedium.u.hMetaFilePict);
759 hr = IStream_Write(pres_stream, data, header.dwSize, NULL);
760 HeapFree(GetProcessHeap(), 0, data);
762 IStream_Release(pres_stream);
766 /* helper for copying STGMEDIUM of type bitmap, MF, EMF or HGLOBAL.
767 * does no checking of whether src_stgm has a supported tymed, so this should be
768 * done in the caller */
769 static HRESULT copy_stg_medium(CLIPFORMAT cf, STGMEDIUM *dest_stgm,
770 const STGMEDIUM *src_stgm)
772 if (src_stgm->tymed == TYMED_MFPICT)
774 const METAFILEPICT *src_mfpict = GlobalLock(src_stgm->u.hMetaFilePict);
775 METAFILEPICT *dest_mfpict;
778 return DV_E_STGMEDIUM;
779 dest_stgm->u.hMetaFilePict = GlobalAlloc(GMEM_MOVEABLE, sizeof(METAFILEPICT));
780 dest_mfpict = GlobalLock(dest_stgm->u.hMetaFilePict);
783 GlobalUnlock(src_stgm->u.hMetaFilePict);
784 return E_OUTOFMEMORY;
786 *dest_mfpict = *src_mfpict;
787 dest_mfpict->hMF = CopyMetaFileW(src_mfpict->hMF, NULL);
788 GlobalUnlock(src_stgm->u.hMetaFilePict);
789 GlobalUnlock(dest_stgm->u.hMetaFilePict);
791 else if (src_stgm->tymed != TYMED_NULL)
793 dest_stgm->u.hGlobal = OleDuplicateData(src_stgm->u.hGlobal, cf,
795 if (!dest_stgm->u.hGlobal)
796 return E_OUTOFMEMORY;
798 dest_stgm->tymed = src_stgm->tymed;
799 dest_stgm->pUnkForRelease = src_stgm->pUnkForRelease;
800 if (dest_stgm->pUnkForRelease)
801 IUnknown_AddRef(dest_stgm->pUnkForRelease);
805 static HRESULT DataCacheEntry_SetData(DataCacheEntry *This,
806 const FORMATETC *formatetc,
807 const STGMEDIUM *stgmedium,
810 if ((!This->fmtetc.cfFormat && !formatetc->cfFormat) ||
811 (This->fmtetc.tymed == TYMED_NULL && formatetc->tymed == TYMED_NULL) ||
812 stgmedium->tymed == TYMED_NULL)
814 WARN("invalid formatetc\n");
815 return DV_E_FORMATETC;
819 ReleaseStgMedium(&This->stgmedium);
820 This->data_cf = This->fmtetc.cfFormat ? This->fmtetc.cfFormat : formatetc->cfFormat;
823 This->stgmedium = *stgmedium;
827 return copy_stg_medium(This->data_cf,
828 &This->stgmedium, stgmedium);
831 static HRESULT DataCacheEntry_GetData(DataCacheEntry *This,
832 STGMEDIUM *stgmedium)
834 if (stgmedium->tymed == TYMED_NULL && This->storage)
836 HRESULT hr = DataCacheEntry_LoadData(This);
840 if (This->stgmedium.tymed == TYMED_NULL)
842 return copy_stg_medium(This->data_cf, stgmedium, &This->stgmedium);
845 static inline HRESULT DataCacheEntry_DiscardData(DataCacheEntry *This)
847 ReleaseStgMedium(&This->stgmedium);
848 This->data_cf = This->fmtetc.cfFormat;
852 static inline void DataCacheEntry_HandsOffStorage(DataCacheEntry *This)
856 IStorage_Release(This->storage);
857 This->storage = NULL;
861 /*********************************************************
862 * Method implementation for the non delegating IUnknown
863 * part of the DataCache class.
866 /************************************************************************
867 * DataCache_NDIUnknown_QueryInterface (IUnknown)
869 * See Windows documentation for more details on IUnknown methods.
871 * This version of QueryInterface will not delegate it's implementation
872 * to the outer unknown.
874 static HRESULT WINAPI DataCache_NDIUnknown_QueryInterface(
879 DataCache *this = impl_from_NDIUnknown(iface);
882 * Perform a sanity check on the parameters.
884 if ( (this==0) || (ppvObject==0) )
888 * Initialize the return parameter.
893 * Compare the riid with the interface IDs implemented by this object.
895 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
899 else if (memcmp(&IID_IDataObject, riid, sizeof(IID_IDataObject)) == 0)
901 *ppvObject = &this->lpVtbl;
903 else if ( (memcmp(&IID_IPersistStorage, riid, sizeof(IID_IPersistStorage)) == 0) ||
904 (memcmp(&IID_IPersist, riid, sizeof(IID_IPersist)) == 0) )
906 *ppvObject = &this->lpvtblIPersistStorage;
908 else if ( (memcmp(&IID_IViewObject, riid, sizeof(IID_IViewObject)) == 0) ||
909 (memcmp(&IID_IViewObject2, riid, sizeof(IID_IViewObject2)) == 0) )
911 *ppvObject = &this->lpvtblIViewObject;
913 else if ( (memcmp(&IID_IOleCache, riid, sizeof(IID_IOleCache)) == 0) ||
914 (memcmp(&IID_IOleCache2, riid, sizeof(IID_IOleCache2)) == 0) )
916 *ppvObject = &this->lpvtblIOleCache2;
918 else if (memcmp(&IID_IOleCacheControl, riid, sizeof(IID_IOleCacheControl)) == 0)
920 *ppvObject = &this->lpvtblIOleCacheControl;
924 * Check that we obtained an interface.
928 WARN( "() : asking for unsupported interface %s\n", debugstr_guid(riid));
929 return E_NOINTERFACE;
933 * Query Interface always increases the reference count by one when it is
936 IUnknown_AddRef((IUnknown*)*ppvObject);
941 /************************************************************************
942 * DataCache_NDIUnknown_AddRef (IUnknown)
944 * See Windows documentation for more details on IUnknown methods.
946 * This version of QueryInterface will not delegate it's implementation
947 * to the outer unknown.
949 static ULONG WINAPI DataCache_NDIUnknown_AddRef(
952 DataCache *this = impl_from_NDIUnknown(iface);
953 return InterlockedIncrement(&this->ref);
956 /************************************************************************
957 * DataCache_NDIUnknown_Release (IUnknown)
959 * See Windows documentation for more details on IUnknown methods.
961 * This version of QueryInterface will not delegate it's implementation
962 * to the outer unknown.
964 static ULONG WINAPI DataCache_NDIUnknown_Release(
967 DataCache *this = impl_from_NDIUnknown(iface);
971 * Decrease the reference count on this object.
973 ref = InterlockedDecrement(&this->ref);
976 * If the reference count goes down to 0, perform suicide.
978 if (ref == 0) DataCache_Destroy(this);
983 /*********************************************************
984 * Method implementation for the IDataObject
985 * part of the DataCache class.
988 /************************************************************************
989 * DataCache_IDataObject_QueryInterface (IUnknown)
991 * See Windows documentation for more details on IUnknown methods.
993 static HRESULT WINAPI DataCache_IDataObject_QueryInterface(
998 DataCache *this = impl_from_IDataObject(iface);
1000 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1003 /************************************************************************
1004 * DataCache_IDataObject_AddRef (IUnknown)
1006 * See Windows documentation for more details on IUnknown methods.
1008 static ULONG WINAPI DataCache_IDataObject_AddRef(
1011 DataCache *this = impl_from_IDataObject(iface);
1013 return IUnknown_AddRef(this->outerUnknown);
1016 /************************************************************************
1017 * DataCache_IDataObject_Release (IUnknown)
1019 * See Windows documentation for more details on IUnknown methods.
1021 static ULONG WINAPI DataCache_IDataObject_Release(
1024 DataCache *this = impl_from_IDataObject(iface);
1026 return IUnknown_Release(this->outerUnknown);
1029 /************************************************************************
1032 * Get Data from a source dataobject using format pformatetcIn->cfFormat
1033 * See Windows documentation for more details on GetData.
1035 static HRESULT WINAPI DataCache_GetData(
1037 LPFORMATETC pformatetcIn,
1040 DataCache *This = impl_from_IDataObject(iface);
1041 DataCacheEntry *cache_entry;
1043 memset(pmedium, 0, sizeof(*pmedium));
1045 cache_entry = DataCache_GetEntryForFormatEtc(This, pformatetcIn);
1049 return DataCacheEntry_GetData(cache_entry, pmedium);
1052 static HRESULT WINAPI DataCache_GetDataHere(
1054 LPFORMATETC pformatetc,
1061 static HRESULT WINAPI DataCache_QueryGetData(
1063 LPFORMATETC pformatetc)
1069 /************************************************************************
1070 * DataCache_EnumFormatEtc (IDataObject)
1072 * The data cache doesn't implement this method.
1074 * See Windows documentation for more details on IDataObject methods.
1076 static HRESULT WINAPI DataCache_GetCanonicalFormatEtc(
1078 LPFORMATETC pformatectIn,
1079 LPFORMATETC pformatetcOut)
1085 /************************************************************************
1086 * DataCache_IDataObject_SetData (IDataObject)
1088 * This method is delegated to the IOleCache2 implementation.
1090 * See Windows documentation for more details on IDataObject methods.
1092 static HRESULT WINAPI DataCache_IDataObject_SetData(
1094 LPFORMATETC pformatetc,
1098 IOleCache2* oleCache = NULL;
1101 TRACE("(%p, %p, %p, %d)\n", iface, pformatetc, pmedium, fRelease);
1103 hres = IDataObject_QueryInterface(iface, &IID_IOleCache2, (void**)&oleCache);
1106 return E_UNEXPECTED;
1108 hres = IOleCache2_SetData(oleCache, pformatetc, pmedium, fRelease);
1110 IOleCache2_Release(oleCache);
1115 /************************************************************************
1116 * DataCache_EnumFormatEtc (IDataObject)
1118 * The data cache doesn't implement this method.
1120 * See Windows documentation for more details on IDataObject methods.
1122 static HRESULT WINAPI DataCache_EnumFormatEtc(
1125 IEnumFORMATETC** ppenumFormatEtc)
1131 /************************************************************************
1132 * DataCache_DAdvise (IDataObject)
1134 * The data cache doesn't support connections.
1136 * See Windows documentation for more details on IDataObject methods.
1138 static HRESULT WINAPI DataCache_DAdvise(
1140 FORMATETC* pformatetc,
1142 IAdviseSink* pAdvSink,
1143 DWORD* pdwConnection)
1146 return OLE_E_ADVISENOTSUPPORTED;
1149 /************************************************************************
1150 * DataCache_DUnadvise (IDataObject)
1152 * The data cache doesn't support connections.
1154 * See Windows documentation for more details on IDataObject methods.
1156 static HRESULT WINAPI DataCache_DUnadvise(
1161 return OLE_E_NOCONNECTION;
1164 /************************************************************************
1165 * DataCache_EnumDAdvise (IDataObject)
1167 * The data cache doesn't support connections.
1169 * See Windows documentation for more details on IDataObject methods.
1171 static HRESULT WINAPI DataCache_EnumDAdvise(
1173 IEnumSTATDATA** ppenumAdvise)
1176 return OLE_E_ADVISENOTSUPPORTED;
1179 /*********************************************************
1180 * Method implementation for the IDataObject
1181 * part of the DataCache class.
1184 /************************************************************************
1185 * DataCache_IPersistStorage_QueryInterface (IUnknown)
1187 * See Windows documentation for more details on IUnknown methods.
1189 static HRESULT WINAPI DataCache_IPersistStorage_QueryInterface(
1190 IPersistStorage* iface,
1194 DataCache *this = impl_from_IPersistStorage(iface);
1196 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1199 /************************************************************************
1200 * DataCache_IPersistStorage_AddRef (IUnknown)
1202 * See Windows documentation for more details on IUnknown methods.
1204 static ULONG WINAPI DataCache_IPersistStorage_AddRef(
1205 IPersistStorage* iface)
1207 DataCache *this = impl_from_IPersistStorage(iface);
1209 return IUnknown_AddRef(this->outerUnknown);
1212 /************************************************************************
1213 * DataCache_IPersistStorage_Release (IUnknown)
1215 * See Windows documentation for more details on IUnknown methods.
1217 static ULONG WINAPI DataCache_IPersistStorage_Release(
1218 IPersistStorage* iface)
1220 DataCache *this = impl_from_IPersistStorage(iface);
1222 return IUnknown_Release(this->outerUnknown);
1225 /************************************************************************
1226 * DataCache_GetClassID (IPersistStorage)
1228 * The data cache doesn't implement this method.
1230 * See Windows documentation for more details on IPersistStorage methods.
1232 static HRESULT WINAPI DataCache_GetClassID(
1233 IPersistStorage* iface,
1236 DataCache *This = impl_from_IPersistStorage(iface);
1237 DataCacheEntry *cache_entry;
1239 TRACE("(%p, %p)\n", iface, pClassID);
1241 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1243 if (cache_entry->storage != NULL)
1246 HRESULT hr = IStorage_Stat(cache_entry->storage, &statstg, STATFLAG_NONAME);
1249 *pClassID = statstg.clsid;
1255 *pClassID = CLSID_NULL;
1260 /************************************************************************
1261 * DataCache_IsDirty (IPersistStorage)
1263 * See Windows documentation for more details on IPersistStorage methods.
1265 static HRESULT WINAPI DataCache_IsDirty(
1266 IPersistStorage* iface)
1268 DataCache *This = impl_from_IPersistStorage(iface);
1269 DataCacheEntry *cache_entry;
1271 TRACE("(%p)\n", iface);
1276 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1277 if (cache_entry->dirty)
1283 /************************************************************************
1284 * DataCache_InitNew (IPersistStorage)
1286 * The data cache implementation of IPersistStorage_InitNew simply stores
1287 * the storage pointer.
1289 * See Windows documentation for more details on IPersistStorage methods.
1291 static HRESULT WINAPI DataCache_InitNew(
1292 IPersistStorage* iface,
1295 DataCache *This = impl_from_IPersistStorage(iface);
1297 TRACE("(%p, %p)\n", iface, pStg);
1299 if (This->presentationStorage != NULL)
1300 IStorage_Release(This->presentationStorage);
1302 This->presentationStorage = pStg;
1304 IStorage_AddRef(This->presentationStorage);
1310 /************************************************************************
1311 * DataCache_Load (IPersistStorage)
1313 * The data cache implementation of IPersistStorage_Load doesn't
1314 * actually load anything. Instead, it holds on to the storage pointer
1315 * and it will load the presentation information when the
1316 * IDataObject_GetData or IViewObject2_Draw methods are called.
1318 * See Windows documentation for more details on IPersistStorage methods.
1320 static HRESULT WINAPI DataCache_Load(
1321 IPersistStorage* iface,
1324 DataCache *This = impl_from_IPersistStorage(iface);
1326 IEnumSTATSTG *pEnum;
1329 TRACE("(%p, %p)\n", iface, pStg);
1331 if (This->presentationStorage != NULL)
1332 IStorage_Release(This->presentationStorage);
1334 This->presentationStorage = pStg;
1336 hr = IStorage_EnumElements(pStg, 0, NULL, 0, &pEnum);
1337 if (FAILED(hr)) return hr;
1339 while ((hr = IEnumSTATSTG_Next(pEnum, 1, &elem, NULL)) == S_OK)
1341 if (DataCache_IsPresentationStream(&elem))
1345 hr = IStorage_OpenStream(This->presentationStorage, elem.pwcsName,
1346 NULL, STGM_READ | STGM_SHARE_EXCLUSIVE, 0,
1350 PresentationDataHeader header;
1352 CLIPFORMAT clipformat;
1354 hr = read_clipformat(pStm, &clipformat);
1357 hr = IStream_Read(pStm, &header, sizeof(header),
1360 /* can't use SUCCEEDED(hr): S_FALSE counts as an error */
1361 if (hr == S_OK && actual_read == sizeof(header))
1363 DataCacheEntry *cache_entry;
1366 fmtetc.cfFormat = clipformat;
1367 fmtetc.ptd = NULL; /* FIXME */
1368 fmtetc.dwAspect = header.dvAspect;
1369 fmtetc.lindex = header.lindex;
1370 fmtetc.tymed = header.tymed;
1372 TRACE("loading entry with formatetc: %s\n", debugstr_formatetc(&fmtetc));
1374 cache_entry = DataCache_GetEntryForFormatEtc(This, &fmtetc);
1376 hr = DataCache_CreateEntry(This, &fmtetc, &cache_entry);
1379 DataCacheEntry_DiscardData(cache_entry);
1380 if (cache_entry->storage) IStorage_Release(cache_entry->storage);
1381 cache_entry->storage = pStg;
1382 IStorage_AddRef(pStg);
1383 cache_entry->dirty = FALSE;
1387 IStream_Release(pStm);
1391 CoTaskMemFree(elem.pwcsName);
1394 This->dirty = FALSE;
1396 IEnumSTATSTG_Release(pEnum);
1398 IStorage_AddRef(This->presentationStorage);
1402 /************************************************************************
1403 * DataCache_Save (IPersistStorage)
1405 * Until we actually connect to a running object and retrieve new
1406 * information to it, we never have to save anything. However, it is
1407 * our responsibility to copy the information when saving to a new
1410 * See Windows documentation for more details on IPersistStorage methods.
1412 static HRESULT WINAPI DataCache_Save(
1413 IPersistStorage* iface,
1417 DataCache *This = impl_from_IPersistStorage(iface);
1418 DataCacheEntry *cache_entry;
1421 unsigned short stream_number = 0;
1423 TRACE("(%p, %p, %d)\n", iface, pStg, fSameAsLoad);
1425 dirty = This->dirty;
1428 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1430 dirty = cache_entry->dirty;
1436 /* this is a shortcut if nothing changed */
1437 if (!dirty && !fSameAsLoad && This->presentationStorage)
1439 return IStorage_CopyTo(This->presentationStorage, 0, NULL, NULL, pStg);
1442 /* assign stream numbers to the cache entries */
1443 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1445 if (cache_entry->stream_number != stream_number)
1447 cache_entry->dirty = TRUE; /* needs to be written out again */
1448 cache_entry->stream_number = stream_number;
1453 /* write out the cache entries */
1454 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1456 if (!fSameAsLoad || cache_entry->dirty)
1458 hr = DataCacheEntry_Save(cache_entry, pStg, fSameAsLoad);
1462 cache_entry->dirty = FALSE;
1466 This->dirty = FALSE;
1470 /************************************************************************
1471 * DataCache_SaveCompleted (IPersistStorage)
1473 * This method is called to tell the cache to release the storage
1474 * pointer it's currently holding.
1476 * See Windows documentation for more details on IPersistStorage methods.
1478 static HRESULT WINAPI DataCache_SaveCompleted(
1479 IPersistStorage* iface,
1482 TRACE("(%p, %p)\n", iface, pStgNew);
1487 * First, make sure we get our hands off any storage we have.
1490 IPersistStorage_HandsOffStorage(iface);
1493 * Then, attach to the new storage.
1496 DataCache_Load(iface, pStgNew);
1502 /************************************************************************
1503 * DataCache_HandsOffStorage (IPersistStorage)
1505 * This method is called to tell the cache to release the storage
1506 * pointer it's currently holding.
1508 * See Windows documentation for more details on IPersistStorage methods.
1510 static HRESULT WINAPI DataCache_HandsOffStorage(
1511 IPersistStorage* iface)
1513 DataCache *this = impl_from_IPersistStorage(iface);
1514 DataCacheEntry *cache_entry;
1516 TRACE("(%p)\n", iface);
1518 if (this->presentationStorage != NULL)
1520 IStorage_Release(this->presentationStorage);
1521 this->presentationStorage = NULL;
1524 LIST_FOR_EACH_ENTRY(cache_entry, &this->cache_list, DataCacheEntry, entry)
1525 DataCacheEntry_HandsOffStorage(cache_entry);
1530 /*********************************************************
1531 * Method implementation for the IViewObject2
1532 * part of the DataCache class.
1535 /************************************************************************
1536 * DataCache_IViewObject2_QueryInterface (IUnknown)
1538 * See Windows documentation for more details on IUnknown methods.
1540 static HRESULT WINAPI DataCache_IViewObject2_QueryInterface(
1541 IViewObject2* iface,
1545 DataCache *this = impl_from_IViewObject2(iface);
1547 return IUnknown_QueryInterface(this->outerUnknown, riid, ppvObject);
1550 /************************************************************************
1551 * DataCache_IViewObject2_AddRef (IUnknown)
1553 * See Windows documentation for more details on IUnknown methods.
1555 static ULONG WINAPI DataCache_IViewObject2_AddRef(
1556 IViewObject2* iface)
1558 DataCache *this = impl_from_IViewObject2(iface);
1560 return IUnknown_AddRef(this->outerUnknown);
1563 /************************************************************************
1564 * DataCache_IViewObject2_Release (IUnknown)
1566 * See Windows documentation for more details on IUnknown methods.
1568 static ULONG WINAPI DataCache_IViewObject2_Release(
1569 IViewObject2* iface)
1571 DataCache *this = impl_from_IViewObject2(iface);
1573 return IUnknown_Release(this->outerUnknown);
1576 /************************************************************************
1577 * DataCache_Draw (IViewObject2)
1579 * This method will draw the cached representation of the object
1580 * to the given device context.
1582 * See Windows documentation for more details on IViewObject2 methods.
1584 static HRESULT WINAPI DataCache_Draw(
1585 IViewObject2* iface,
1589 DVTARGETDEVICE* ptd,
1592 LPCRECTL lprcBounds,
1593 LPCRECTL lprcWBounds,
1594 BOOL (CALLBACK *pfnContinue)(ULONG_PTR dwContinue),
1595 ULONG_PTR dwContinue)
1597 DataCache *This = impl_from_IViewObject2(iface);
1599 DataCacheEntry *cache_entry;
1601 TRACE("(%p, %x, %d, %p, %p, %p, %p, %p, %p, %lx)\n",
1616 if (lprcBounds==NULL)
1617 return E_INVALIDARG;
1619 LIST_FOR_EACH_ENTRY(cache_entry, &This->cache_list, DataCacheEntry, entry)
1621 /* FIXME: compare ptd too */
1622 if ((cache_entry->fmtetc.dwAspect != dwDrawAspect) ||
1623 (cache_entry->fmtetc.lindex != lindex))
1626 /* if the data hasn't been loaded yet, do it now */
1627 if ((cache_entry->stgmedium.tymed == TYMED_NULL) && cache_entry->storage)
1629 hres = DataCacheEntry_LoadData(cache_entry);
1635 if (cache_entry->stgmedium.tymed == TYMED_NULL)
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!=NULL) &&
2290 (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) != 0) )
2291 return CLASS_E_NOAGGREGATION;
2294 * Try to construct a new instance of the class.
2296 newCache = DataCache_Construct(rclsid,
2300 return E_OUTOFMEMORY;
2303 * Make sure it supports the interface required by the caller.
2305 hr = IUnknown_QueryInterface((IUnknown*)&(newCache->lpvtblNDIUnknown), riid, ppvObj);
2308 * Release the reference obtained in the constructor. If
2309 * the QueryInterface was unsuccessful, it will free the class.
2311 IUnknown_Release((IUnknown*)&(newCache->lpvtblNDIUnknown));
2316 /*********************************************************
2317 * Method implementation for DataCache class.
2319 static DataCache* DataCache_Construct(
2321 LPUNKNOWN pUnkOuter)
2323 DataCache* newObject = 0;
2326 * Allocate space for the object.
2328 newObject = HeapAlloc(GetProcessHeap(), 0, sizeof(DataCache));
2334 * Initialize the virtual function table.
2336 newObject->lpVtbl = &DataCache_IDataObject_VTable;
2337 newObject->lpvtblNDIUnknown = &DataCache_NDIUnknown_VTable;
2338 newObject->lpvtblIPersistStorage = &DataCache_IPersistStorage_VTable;
2339 newObject->lpvtblIViewObject = &DataCache_IViewObject2_VTable;
2340 newObject->lpvtblIOleCache2 = &DataCache_IOleCache2_VTable;
2341 newObject->lpvtblIOleCacheControl = &DataCache_IOleCacheControl_VTable;
2344 * Start with one reference count. The caller of this function
2345 * must release the interface pointer when it is done.
2350 * Initialize the outer unknown
2351 * We don't keep a reference on the outer unknown since, the way
2352 * aggregation works, our lifetime is at least as large as its
2355 if (pUnkOuter==NULL)
2356 pUnkOuter = (IUnknown*)&(newObject->lpvtblNDIUnknown);
2358 newObject->outerUnknown = pUnkOuter;
2361 * Initialize the other members of the structure.
2363 newObject->sinkAspects = 0;
2364 newObject->sinkAdviseFlag = 0;
2365 newObject->sinkInterface = 0;
2366 newObject->presentationStorage = NULL;
2367 list_init(&newObject->cache_list);
2368 newObject->last_cache_id = 1;
2369 newObject->dirty = FALSE;