2 * HGLOBAL Stream implementation
4 * This file contains the implementation of the stream interface
5 * for streams contained supported by an HGLOBAL pointer.
7 * Copyright 1999 Francis Beaudet
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
44 #include "wine/debug.h"
46 WINE_DEFAULT_DEBUG_CHANNEL(storage);
48 /****************************************************************************
49 * HGLOBALStreamImpl definition.
51 * This class implements the IStream interface and represents a stream
52 * supported by an HGLOBAL pointer.
54 struct HGLOBALStreamImpl
56 const IStreamVtbl *lpVtbl; /* Needs to be the first item in the struct
57 * since we want to cast this in an IStream pointer */
65 * Support for the stream
67 HGLOBAL supportHandle;
70 * This flag is TRUE if the HGLOBAL is destroyed when the stream
71 * is finally released.
76 * Helper variable that contains the size of the stream
78 ULARGE_INTEGER streamSize;
81 * This is the current position of the cursor in the stream
83 ULARGE_INTEGER currentPosition;
86 typedef struct HGLOBALStreamImpl HGLOBALStreamImpl;
89 * This is the destructor of the HGLOBALStreamImpl class.
91 * This method will clean-up all the resources used-up by the given HGLOBALStreamImpl
92 * class. The pointer passed-in to this function will be freed and will not
95 static void HGLOBALStreamImpl_Destroy(HGLOBALStreamImpl* This)
97 TRACE("(%p)\n", This);
100 * Release the HGlobal if the constructor asked for that.
102 if (This->deleteOnRelease)
104 GlobalFree(This->supportHandle);
105 This->supportHandle=0;
109 * Finally, free the memory used-up by the class.
111 HeapFree(GetProcessHeap(), 0, This);
115 * This implements the IUnknown method AddRef for this
118 static ULONG WINAPI HGLOBALStreamImpl_AddRef(
121 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
122 return InterlockedIncrement(&This->ref);
126 * This implements the IUnknown method QueryInterface for this
129 static HRESULT WINAPI HGLOBALStreamImpl_QueryInterface(
131 REFIID riid, /* [in] */
132 void** ppvObject) /* [iid_is][out] */
134 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
137 * Perform a sanity check on the parameters.
143 * Initialize the return parameter.
148 * Compare the riid with the interface IDs implemented by this object.
150 if (IsEqualIID(&IID_IUnknown, riid) ||
151 IsEqualIID(&IID_ISequentialStream, riid) ||
152 IsEqualIID(&IID_IStream, riid))
154 *ppvObject = (IStream*)This;
158 * Check that we obtained an interface.
161 return E_NOINTERFACE;
164 * Query Interface always increases the reference count by one when it is
167 HGLOBALStreamImpl_AddRef(iface);
173 * This implements the IUnknown method Release for this
176 static ULONG WINAPI HGLOBALStreamImpl_Release(
179 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
182 newRef = InterlockedDecrement(&This->ref);
185 * If the reference count goes down to 0, perform suicide.
189 HGLOBALStreamImpl_Destroy(This);
196 * This method is part of the ISequentialStream interface.
198 * If reads a block of information from the stream at the current
199 * position. It then moves the current position at the end of the
202 * See the documentation of ISequentialStream for more info.
204 static HRESULT WINAPI HGLOBALStreamImpl_Read(
206 void* pv, /* [length_is][size_is][out] */
208 ULONG* pcbRead) /* [out] */
210 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
213 ULONG bytesReadBuffer;
214 ULONG bytesToReadFromBuffer;
216 TRACE("(%p, %p, %d, %p)\n", iface,
220 * If the caller is not interested in the nubmer of bytes read,
221 * we use another buffer to avoid "if" statements in the code.
224 pcbRead = &bytesReadBuffer;
227 * Using the known size of the stream, calculate the number of bytes
228 * to read from the block chain
230 bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
233 * Lock the buffer in position and copy the data.
235 supportBuffer = GlobalLock(This->supportHandle);
238 WARN("read from invalid hglobal %p\n", This->supportHandle);
243 memcpy(pv, (char *) supportBuffer+This->currentPosition.u.LowPart, bytesToReadFromBuffer);
246 * Move the current position to the new position
248 This->currentPosition.u.LowPart+=bytesToReadFromBuffer;
251 * Return the number of bytes read.
253 *pcbRead = bytesToReadFromBuffer;
258 GlobalUnlock(This->supportHandle);
261 * Always returns S_OK even if the end of the stream is reached before the
269 * This method is part of the ISequentialStream interface.
271 * It writes a block of information to the stream at the current
272 * position. It then moves the current position at the end of the
273 * written block. If the stream is too small to fit the block,
274 * the stream is grown to fit.
276 * See the documentation of ISequentialStream for more info.
278 static HRESULT WINAPI HGLOBALStreamImpl_Write(
280 const void* pv, /* [size_is][in] */
282 ULONG* pcbWritten) /* [out] */
284 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
287 ULARGE_INTEGER newSize;
288 ULONG bytesWritten = 0;
290 TRACE("(%p, %p, %d, %p)\n", iface, pv, cb, pcbWritten);
293 * If the caller is not interested in the number of bytes written,
294 * we use another buffer to avoid "if" statements in the code.
297 pcbWritten = &bytesWritten;
304 newSize.u.HighPart = 0;
305 newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
308 * Verify if we need to grow the stream
310 if (newSize.u.LowPart > This->streamSize.u.LowPart)
313 HRESULT hr = IStream_SetSize(iface, newSize);
316 ERR("IStream_SetSize failed with error 0x%08x\n", hr);
322 * Lock the buffer in position and copy the data.
324 supportBuffer = GlobalLock(This->supportHandle);
327 WARN("write to invalid hglobal %p\n", This->supportHandle);
331 memcpy((char *) supportBuffer+This->currentPosition.u.LowPart, pv, cb);
334 * Move the current position to the new position
336 This->currentPosition.u.LowPart+=cb;
341 GlobalUnlock(This->supportHandle);
345 * Return the number of bytes read.
353 * This method is part of the IStream interface.
355 * It will move the current stream pointer according to the parameters
358 * See the documentation of IStream for more info.
360 static HRESULT WINAPI HGLOBALStreamImpl_Seek(
362 LARGE_INTEGER dlibMove, /* [in] */
363 DWORD dwOrigin, /* [in] */
364 ULARGE_INTEGER* plibNewPosition) /* [out] */
366 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
368 ULARGE_INTEGER newPosition;
370 TRACE("(%p, %x%08x, %d, %p)\n", iface, dlibMove.u.HighPart,
371 dlibMove.u.LowPart, dwOrigin, plibNewPosition);
374 * The file pointer is moved depending on the given "function"
379 case STREAM_SEEK_SET:
380 newPosition.u.HighPart = 0;
381 newPosition.u.LowPart = 0;
383 case STREAM_SEEK_CUR:
384 newPosition = This->currentPosition;
386 case STREAM_SEEK_END:
387 newPosition = This->streamSize;
390 return STG_E_INVALIDFUNCTION;
394 * Move the actual file pointer
395 * If the file pointer ends-up after the end of the stream, the next Write operation will
396 * make the file larger. This is how it is documented.
398 if (dlibMove.QuadPart < 0 && newPosition.QuadPart < -dlibMove.QuadPart) return STG_E_INVALIDFUNCTION;
400 newPosition.QuadPart = RtlLargeIntegerAdd(newPosition.QuadPart, dlibMove.QuadPart);
402 if (plibNewPosition) *plibNewPosition = newPosition;
403 This->currentPosition = newPosition;
409 * This method is part of the IStream interface.
411 * It will change the size of a stream.
413 * TODO: Switch from small blocks to big blocks and vice versa.
415 * See the documentation of IStream for more info.
417 static HRESULT WINAPI HGLOBALStreamImpl_SetSize(
419 ULARGE_INTEGER libNewSize) /* [in] */
421 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
422 HGLOBAL supportHandle;
424 TRACE("(%p, %d)\n", iface, libNewSize.u.LowPart);
427 * HighPart is ignored as shown in tests
430 if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
434 * Re allocate the HGlobal to fit the new size of the stream.
436 supportHandle = GlobalReAlloc(This->supportHandle, libNewSize.u.LowPart, 0);
438 if (supportHandle == 0)
439 return E_OUTOFMEMORY;
441 This->supportHandle = supportHandle;
442 This->streamSize.u.LowPart = libNewSize.u.LowPart;
448 * This method is part of the IStream interface.
450 * It will copy the 'cb' Bytes to 'pstm' IStream.
452 * See the documentation of IStream for more info.
454 static HRESULT WINAPI HGLOBALStreamImpl_CopyTo(
456 IStream* pstm, /* [unique][in] */
457 ULARGE_INTEGER cb, /* [in] */
458 ULARGE_INTEGER* pcbRead, /* [out] */
459 ULARGE_INTEGER* pcbWritten) /* [out] */
463 ULONG bytesRead, bytesWritten, copySize;
464 ULARGE_INTEGER totalBytesRead;
465 ULARGE_INTEGER totalBytesWritten;
467 TRACE("(%p, %p, %d, %p, %p)\n", iface, pstm,
468 cb.u.LowPart, pcbRead, pcbWritten);
474 return STG_E_INVALIDPOINTER;
476 totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
477 totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
480 * use stack to store data temporarly
481 * there is surely more performant way of doing it, for now this basic
482 * implementation will do the job
484 while ( cb.u.LowPart > 0 )
486 if ( cb.u.LowPart >= 128 )
489 copySize = cb.u.LowPart;
491 hr = IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
495 totalBytesRead.u.LowPart += bytesRead;
499 hr = IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
503 totalBytesWritten.u.LowPart += bytesWritten;
506 if (bytesRead!=copySize)
509 cb.u.LowPart -= bytesRead;
513 * Update number of bytes read and written
517 pcbRead->u.LowPart = totalBytesRead.u.LowPart;
518 pcbRead->u.HighPart = totalBytesRead.u.HighPart;
523 pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
524 pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
530 * This method is part of the IStream interface.
532 * For streams supported by HGLOBALS, this function does nothing.
533 * This is what the documentation tells us.
535 * See the documentation of IStream for more info.
537 static HRESULT WINAPI HGLOBALStreamImpl_Commit(
539 DWORD grfCommitFlags) /* [in] */
545 * This method is part of the IStream interface.
547 * For streams supported by HGLOBALS, this function does nothing.
548 * This is what the documentation tells us.
550 * See the documentation of IStream for more info.
552 static HRESULT WINAPI HGLOBALStreamImpl_Revert(
559 * This method is part of the IStream interface.
561 * For streams supported by HGLOBALS, this function does nothing.
562 * This is what the documentation tells us.
564 * See the documentation of IStream for more info.
566 static HRESULT WINAPI HGLOBALStreamImpl_LockRegion(
568 ULARGE_INTEGER libOffset, /* [in] */
569 ULARGE_INTEGER cb, /* [in] */
570 DWORD dwLockType) /* [in] */
572 return STG_E_INVALIDFUNCTION;
576 * This method is part of the IStream interface.
578 * For streams supported by HGLOBALS, this function does nothing.
579 * This is what the documentation tells us.
581 * See the documentation of IStream for more info.
583 static HRESULT WINAPI HGLOBALStreamImpl_UnlockRegion(
585 ULARGE_INTEGER libOffset, /* [in] */
586 ULARGE_INTEGER cb, /* [in] */
587 DWORD dwLockType) /* [in] */
593 * This method is part of the IStream interface.
595 * This method returns information about the current
598 * See the documentation of IStream for more info.
600 static HRESULT WINAPI HGLOBALStreamImpl_Stat(
602 STATSTG* pstatstg, /* [out] */
603 DWORD grfStatFlag) /* [in] */
605 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
607 memset(pstatstg, 0, sizeof(STATSTG));
609 pstatstg->pwcsName = NULL;
610 pstatstg->type = STGTY_STREAM;
611 pstatstg->cbSize = This->streamSize;
616 static HRESULT WINAPI HGLOBALStreamImpl_Clone(
618 IStream** ppstm) /* [out] */
620 ULARGE_INTEGER dummy;
621 LARGE_INTEGER offset;
623 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
624 TRACE(" Cloning %p (deleteOnRelease=%d seek position=%ld)\n",iface,This->deleteOnRelease,(long)This->currentPosition.QuadPart);
625 hr=CreateStreamOnHGlobal(This->supportHandle, FALSE, ppstm);
628 offset.QuadPart=(LONGLONG)This->currentPosition.QuadPart;
629 HGLOBALStreamImpl_Seek(*ppstm,offset,STREAM_SEEK_SET,&dummy);
634 * Virtual function table for the HGLOBALStreamImpl class.
636 static const IStreamVtbl HGLOBALStreamImpl_Vtbl =
638 HGLOBALStreamImpl_QueryInterface,
639 HGLOBALStreamImpl_AddRef,
640 HGLOBALStreamImpl_Release,
641 HGLOBALStreamImpl_Read,
642 HGLOBALStreamImpl_Write,
643 HGLOBALStreamImpl_Seek,
644 HGLOBALStreamImpl_SetSize,
645 HGLOBALStreamImpl_CopyTo,
646 HGLOBALStreamImpl_Commit,
647 HGLOBALStreamImpl_Revert,
648 HGLOBALStreamImpl_LockRegion,
649 HGLOBALStreamImpl_UnlockRegion,
650 HGLOBALStreamImpl_Stat,
651 HGLOBALStreamImpl_Clone
654 /******************************************************************************
655 ** HGLOBALStreamImpl implementation
659 * This is the constructor for the HGLOBALStreamImpl class.
662 * hGlobal - Handle that will support the stream. can be NULL.
663 * fDeleteOnRelease - Flag set to TRUE if the HGLOBAL will be released
664 * when the IStream object is destroyed.
666 static HGLOBALStreamImpl* HGLOBALStreamImpl_Construct(
668 BOOL fDeleteOnRelease)
670 HGLOBALStreamImpl* newStream;
672 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(HGLOBALStreamImpl));
677 * Set-up the virtual function table and reference count.
679 newStream->lpVtbl = &HGLOBALStreamImpl_Vtbl;
683 * Initialize the support.
685 newStream->supportHandle = hGlobal;
686 newStream->deleteOnRelease = fDeleteOnRelease;
689 * This method will allocate a handle if one is not supplied.
691 if (!newStream->supportHandle)
693 newStream->supportHandle = GlobalAlloc(GMEM_MOVEABLE | GMEM_NODISCARD |
698 * Start the stream at the beginning.
700 newStream->currentPosition.u.HighPart = 0;
701 newStream->currentPosition.u.LowPart = 0;
704 * Initialize the size of the stream to the size of the handle.
706 newStream->streamSize.u.HighPart = 0;
707 newStream->streamSize.u.LowPart = GlobalSize(newStream->supportHandle);
714 /***********************************************************************
715 * CreateStreamOnHGlobal [OLE32.@]
717 HRESULT WINAPI CreateStreamOnHGlobal(
719 BOOL fDeleteOnRelease,
722 HGLOBALStreamImpl* newStream;
724 newStream = HGLOBALStreamImpl_Construct(hGlobal,
729 return IUnknown_QueryInterface((IUnknown*)newStream,
734 return E_OUTOFMEMORY;
737 /***********************************************************************
738 * GetHGlobalFromStream [OLE32.@]
740 HRESULT WINAPI GetHGlobalFromStream(IStream* pstm, HGLOBAL* phglobal)
742 HGLOBALStreamImpl* pStream;
747 pStream = (HGLOBALStreamImpl*) pstm;
750 * Verify that the stream object was created with CreateStreamOnHGlobal.
752 if (pStream->lpVtbl == &HGLOBALStreamImpl_Vtbl)
753 *phglobal = pStream->supportHandle;