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
45 #include "wine/debug.h"
47 WINE_DEFAULT_DEBUG_CHANNEL(storage);
49 /****************************************************************************
50 * HGLOBALStreamImpl definition.
52 * This class imlements the IStream inteface and represents a stream
53 * supported by an HGLOBAL pointer.
55 struct HGLOBALStreamImpl
57 const IStreamVtbl *lpVtbl; /* Needs to be the first item in the struct
58 * since we want to cast this in an IStream pointer */
66 * Support for the stream
68 HGLOBAL supportHandle;
71 * This flag is TRUE if the HGLOBAL is destroyed when the stream
72 * is finally released.
77 * Helper variable that contains the size of the stream
79 ULARGE_INTEGER streamSize;
82 * This is the current position of the cursor in the stream
84 ULARGE_INTEGER currentPosition;
87 typedef struct HGLOBALStreamImpl HGLOBALStreamImpl;
90 * This is the destructor of the HGLOBALStreamImpl class.
92 * This method will clean-up all the resources used-up by the given HGLOBALStreamImpl
93 * class. The pointer passed-in to this function will be freed and will not
96 static void HGLOBALStreamImpl_Destroy(HGLOBALStreamImpl* This)
98 TRACE("(%p)\n", This);
101 * Release the HGlobal if the constructor asked for that.
103 if (This->deleteOnRelease)
105 GlobalFree(This->supportHandle);
106 This->supportHandle=0;
110 * Finally, free the memory used-up by the class.
112 HeapFree(GetProcessHeap(), 0, This);
116 * This implements the IUnknown method AddRef for this
119 static ULONG WINAPI HGLOBALStreamImpl_AddRef(
122 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
123 return InterlockedIncrement(&This->ref);
127 * This implements the IUnknown method QueryInterface for this
130 static HRESULT WINAPI HGLOBALStreamImpl_QueryInterface(
132 REFIID riid, /* [in] */
133 void** ppvObject) /* [iid_is][out] */
135 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
138 * Perform a sanity check on the parameters.
144 * Initialize the return parameter.
149 * Compare the riid with the interface IDs implemented by this object.
151 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
153 *ppvObject = (IStream*)This;
155 else if (memcmp(&IID_IStream, riid, sizeof(IID_IStream)) == 0)
157 *ppvObject = (IStream*)This;
161 * Check that we obtained an interface.
164 return E_NOINTERFACE;
167 * Query Interface always increases the reference count by one when it is
170 HGLOBALStreamImpl_AddRef(iface);
176 * This implements the IUnknown method Release for this
179 static ULONG WINAPI HGLOBALStreamImpl_Release(
182 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
185 newRef = InterlockedDecrement(&This->ref);
188 * If the reference count goes down to 0, perform suicide.
192 HGLOBALStreamImpl_Destroy(This);
199 * This method is part of the ISequentialStream interface.
201 * If reads a block of information from the stream at the current
202 * position. It then moves the current position at the end of the
205 * See the documentation of ISequentialStream for more info.
207 static HRESULT WINAPI HGLOBALStreamImpl_Read(
209 void* pv, /* [length_is][size_is][out] */
211 ULONG* pcbRead) /* [out] */
213 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
216 ULONG bytesReadBuffer;
217 ULONG bytesToReadFromBuffer;
219 TRACE("(%p, %p, %ld, %p)\n", iface,
223 * If the caller is not interested in the nubmer of bytes read,
224 * we use another buffer to avoid "if" statements in the code.
227 pcbRead = &bytesReadBuffer;
230 * Using the known size of the stream, calculate the number of bytes
231 * to read from the block chain
233 bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
236 * Lock the buffer in position and copy the data.
238 supportBuffer = GlobalLock(This->supportHandle);
240 memcpy(pv, (char *) supportBuffer+This->currentPosition.u.LowPart, bytesToReadFromBuffer);
243 * Move the current position to the new position
245 This->currentPosition.u.LowPart+=bytesToReadFromBuffer;
248 * Return the number of bytes read.
250 *pcbRead = bytesToReadFromBuffer;
255 GlobalUnlock(This->supportHandle);
258 * The function returns S_OK if the buffer was filled completely
259 * it returns S_FALSE 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, %ld, %p)\n", iface,
294 * If the caller is not interested in the number of bytes written,
295 * we use another buffer to avoid "if" statements in the code.
298 pcbWritten = &bytesWritten;
306 newSize.u.HighPart = 0;
307 newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
311 * Verify if we need to grow the stream
313 if (newSize.u.LowPart > This->streamSize.u.LowPart)
316 HRESULT hr = IStream_SetSize(iface, newSize);
319 ERR("IStream_SetSize failed with error 0x%08lx\n", hr);
325 * Lock the buffer in position and copy the data.
327 supportBuffer = GlobalLock(This->supportHandle);
329 memcpy((char *) supportBuffer+This->currentPosition.u.LowPart, pv, cb);
332 * Move the current position to the new position
334 This->currentPosition.u.LowPart+=cb;
337 * Return the number of bytes read.
344 GlobalUnlock(This->supportHandle);
350 * This method is part of the IStream interface.
352 * It will move the current stream pointer according to the parameters
355 * See the documentation of IStream for more info.
357 static HRESULT WINAPI HGLOBALStreamImpl_Seek(
359 LARGE_INTEGER dlibMove, /* [in] */
360 DWORD dwOrigin, /* [in] */
361 ULARGE_INTEGER* plibNewPosition) /* [out] */
363 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
365 ULARGE_INTEGER newPosition;
367 TRACE("(%p, %lx%08lx, %ld, %p)\n", iface, dlibMove.u.HighPart,
368 dlibMove.u.LowPart, dwOrigin, plibNewPosition);
371 * The file pointer is moved depending on the given "function"
376 case STREAM_SEEK_SET:
377 newPosition.u.HighPart = 0;
378 newPosition.u.LowPart = 0;
380 case STREAM_SEEK_CUR:
381 newPosition = This->currentPosition;
383 case STREAM_SEEK_END:
384 newPosition = This->streamSize;
387 return STG_E_INVALIDFUNCTION;
391 * Move the actual file pointer
392 * If the file pointer ends-up after the end of the stream, the next Write operation will
393 * make the file larger. This is how it is documented.
395 if (dlibMove.QuadPart < 0 && newPosition.QuadPart < -dlibMove.QuadPart) return STG_E_INVALIDFUNCTION;
397 newPosition.QuadPart = RtlLargeIntegerAdd(newPosition.QuadPart, dlibMove.QuadPart);
399 if (plibNewPosition) *plibNewPosition = newPosition;
400 This->currentPosition = newPosition;
406 * This method is part of the IStream interface.
408 * It will change the size of a stream.
410 * TODO: Switch from small blocks to big blocks and vice versa.
412 * See the documentation of IStream for more info.
414 static HRESULT WINAPI HGLOBALStreamImpl_SetSize(
416 ULARGE_INTEGER libNewSize) /* [in] */
418 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
419 HGLOBAL supportHandle;
421 TRACE("(%p, %ld)\n", iface, libNewSize.u.LowPart);
426 if (libNewSize.u.HighPart != 0)
427 return STG_E_INVALIDFUNCTION;
429 if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
433 * Re allocate the HGlobal to fit the new size of the stream.
435 supportHandle = GlobalReAlloc(This->supportHandle, libNewSize.u.LowPart, 0);
437 if (supportHandle == 0)
438 return STG_E_MEDIUMFULL;
440 This->supportHandle = supportHandle;
441 This->streamSize.u.LowPart = libNewSize.u.LowPart;
447 * This method is part of the IStream interface.
449 * It will copy the 'cb' Bytes to 'pstm' IStream.
451 * See the documentation of IStream for more info.
453 static HRESULT WINAPI HGLOBALStreamImpl_CopyTo(
455 IStream* pstm, /* [unique][in] */
456 ULARGE_INTEGER cb, /* [in] */
457 ULARGE_INTEGER* pcbRead, /* [out] */
458 ULARGE_INTEGER* pcbWritten) /* [out] */
462 ULONG bytesRead, bytesWritten, copySize;
463 ULARGE_INTEGER totalBytesRead;
464 ULARGE_INTEGER totalBytesWritten;
466 TRACE("(%p, %p, %ld, %p, %p)\n", iface, pstm,
467 cb.u.LowPart, pcbRead, pcbWritten);
473 return STG_E_INVALIDPOINTER;
475 totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
476 totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
479 * use stack to store data temporarly
480 * there is surely more performant way of doing it, for now this basic
481 * implementation will do the job
483 while ( cb.u.LowPart > 0 )
485 if ( cb.u.LowPart >= 128 )
488 copySize = cb.u.LowPart;
490 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
492 totalBytesRead.u.LowPart += bytesRead;
494 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
496 totalBytesWritten.u.LowPart += bytesWritten;
499 * Check that read & write operations were succesfull
501 if (bytesRead != bytesWritten)
503 hr = STG_E_MEDIUMFULL;
507 if (bytesRead!=copySize)
510 cb.u.LowPart -= bytesRead;
514 * Update number of bytes read and written
518 pcbRead->u.LowPart = totalBytesRead.u.LowPart;
519 pcbRead->u.HighPart = totalBytesRead.u.HighPart;
524 pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
525 pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
531 * This method is part of the IStream interface.
533 * For streams supported by HGLOBALS, this function does nothing.
534 * This is what the documentation tells us.
536 * See the documentation of IStream for more info.
538 static HRESULT WINAPI HGLOBALStreamImpl_Commit(
540 DWORD grfCommitFlags) /* [in] */
546 * This method is part of the IStream interface.
548 * For streams supported by HGLOBALS, this function does nothing.
549 * This is what the documentation tells us.
551 * See the documentation of IStream for more info.
553 static HRESULT WINAPI HGLOBALStreamImpl_Revert(
560 * This method is part of the IStream interface.
562 * For streams supported by HGLOBALS, this function does nothing.
563 * This is what the documentation tells us.
565 * See the documentation of IStream for more info.
567 static HRESULT WINAPI HGLOBALStreamImpl_LockRegion(
569 ULARGE_INTEGER libOffset, /* [in] */
570 ULARGE_INTEGER cb, /* [in] */
571 DWORD dwLockType) /* [in] */
577 * This method is part of the IStream interface.
579 * For streams supported by HGLOBALS, this function does nothing.
580 * This is what the documentation tells us.
582 * See the documentation of IStream for more info.
584 static HRESULT WINAPI HGLOBALStreamImpl_UnlockRegion(
586 ULARGE_INTEGER libOffset, /* [in] */
587 ULARGE_INTEGER cb, /* [in] */
588 DWORD dwLockType) /* [in] */
594 * This method is part of the IStream interface.
596 * This method returns information about the current
599 * See the documentation of IStream for more info.
601 static HRESULT WINAPI HGLOBALStreamImpl_Stat(
603 STATSTG* pstatstg, /* [out] */
604 DWORD grfStatFlag) /* [in] */
606 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
608 memset(pstatstg, 0, sizeof(STATSTG));
610 pstatstg->pwcsName = NULL;
611 pstatstg->type = STGTY_STREAM;
612 pstatstg->cbSize = This->streamSize;
617 static HRESULT WINAPI HGLOBALStreamImpl_Clone(
619 IStream** ppstm) /* [out] */
621 ULARGE_INTEGER dummy;
622 LARGE_INTEGER offset;
624 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
625 TRACE(" Cloning %p (deleteOnRelease=%d seek position=%ld)\n",iface,This->deleteOnRelease,(long)This->currentPosition.QuadPart);
626 hr=CreateStreamOnHGlobal(This->supportHandle, FALSE, ppstm);
629 offset.QuadPart=(LONGLONG)This->currentPosition.QuadPart;
630 HGLOBALStreamImpl_Seek(*ppstm,offset,STREAM_SEEK_SET,&dummy);
635 * Virtual function table for the HGLOBALStreamImpl class.
637 static const IStreamVtbl HGLOBALStreamImpl_Vtbl =
639 HGLOBALStreamImpl_QueryInterface,
640 HGLOBALStreamImpl_AddRef,
641 HGLOBALStreamImpl_Release,
642 HGLOBALStreamImpl_Read,
643 HGLOBALStreamImpl_Write,
644 HGLOBALStreamImpl_Seek,
645 HGLOBALStreamImpl_SetSize,
646 HGLOBALStreamImpl_CopyTo,
647 HGLOBALStreamImpl_Commit,
648 HGLOBALStreamImpl_Revert,
649 HGLOBALStreamImpl_LockRegion,
650 HGLOBALStreamImpl_UnlockRegion,
651 HGLOBALStreamImpl_Stat,
652 HGLOBALStreamImpl_Clone
655 /******************************************************************************
656 ** HGLOBALStreamImpl implementation
660 * This is the constructor for the HGLOBALStreamImpl class.
663 * hGlobal - Handle that will support the stream. can be NULL.
664 * fDeleteOnRelease - Flag set to TRUE if the HGLOBAL will be released
665 * when the IStream object is destroyed.
667 HGLOBALStreamImpl* HGLOBALStreamImpl_Construct(
669 BOOL fDeleteOnRelease)
671 HGLOBALStreamImpl* newStream;
673 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(HGLOBALStreamImpl));
678 * Set-up the virtual function table and reference count.
680 newStream->lpVtbl = &HGLOBALStreamImpl_Vtbl;
684 * Initialize the support.
686 newStream->supportHandle = hGlobal;
687 newStream->deleteOnRelease = fDeleteOnRelease;
690 * This method will allocate a handle if one is not supplied.
692 if (!newStream->supportHandle)
694 newStream->supportHandle = GlobalAlloc(GMEM_MOVEABLE | GMEM_NODISCARD |
699 * Start the stream at the beginning.
701 newStream->currentPosition.u.HighPart = 0;
702 newStream->currentPosition.u.LowPart = 0;
705 * Initialize the size of the stream to the size of the handle.
707 newStream->streamSize.u.HighPart = 0;
708 newStream->streamSize.u.LowPart = GlobalSize(newStream->supportHandle);
715 /***********************************************************************
716 * CreateStreamOnHGlobal [OLE32.@]
718 HRESULT WINAPI CreateStreamOnHGlobal(
720 BOOL fDeleteOnRelease,
723 HGLOBALStreamImpl* newStream;
725 newStream = HGLOBALStreamImpl_Construct(hGlobal,
730 return IUnknown_QueryInterface((IUnknown*)newStream,
735 return E_OUTOFMEMORY;
738 /***********************************************************************
739 * GetHGlobalFromStream [OLE32.@]
741 HRESULT WINAPI GetHGlobalFromStream(IStream* pstm, HGLOBAL* phglobal)
743 HGLOBALStreamImpl* pStream;
748 pStream = (HGLOBALStreamImpl*) pstm;
751 * Verify that the stream object was created with CreateStreamOnHGlobal.
753 if (pStream->lpVtbl == &HGLOBALStreamImpl_Vtbl)
754 *phglobal = pStream->supportHandle;