2 * Compound Storage (32 bit version)
3 * Stream implementation
5 * This file contains the implementation of the stream interface
6 * for streams contained in a compound storage.
8 * Copyright 1999 Francis Beaudet
9 * Copyright 1999 Thuy Nguyen
19 #include "debugtools.h"
21 #include "storage32.h"
23 DEFAULT_DEBUG_CHANNEL(storage);
27 * Virtual function table for the StgStreamImpl class.
29 static ICOM_VTABLE(IStream) StgStreamImpl_Vtbl =
31 ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
32 StgStreamImpl_QueryInterface,
34 StgStreamImpl_Release,
38 StgStreamImpl_SetSize,
42 StgStreamImpl_LockRegion,
43 StgStreamImpl_UnlockRegion,
48 /******************************************************************************
49 ** StgStreamImpl implementation
53 * This is the constructor for the StgStreamImpl class.
56 * parentStorage - Pointer to the storage that contains the stream to open
57 * ownerProperty - Index of the property that points to this stream.
59 StgStreamImpl* StgStreamImpl_Construct(
60 StorageBaseImpl* parentStorage,
64 StgStreamImpl* newStream;
66 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(StgStreamImpl));
71 * Set-up the virtual function table and reference count.
73 ICOM_VTBL(newStream) = &StgStreamImpl_Vtbl;
77 * We want to nail-down the reference to the storage in case the
78 * stream out-lives the storage in the client application.
80 newStream->parentStorage = parentStorage;
81 IStorage_AddRef((IStorage*)newStream->parentStorage);
83 newStream->grfMode = grfMode;
84 newStream->ownerProperty = ownerProperty;
87 * Start the stream at the beginning.
89 newStream->currentPosition.s.HighPart = 0;
90 newStream->currentPosition.s.LowPart = 0;
93 * Initialize the rest of the data.
95 newStream->streamSize.s.HighPart = 0;
96 newStream->streamSize.s.LowPart = 0;
97 newStream->bigBlockChain = 0;
98 newStream->smallBlockChain = 0;
101 * Read the size from the property and determine if the blocks forming
102 * this stream are large or small.
104 StgStreamImpl_OpenBlockChain(newStream);
111 * This is the destructor of the StgStreamImpl class.
113 * This method will clean-up all the resources used-up by the given StgStreamImpl
114 * class. The pointer passed-in to this function will be freed and will not
117 void StgStreamImpl_Destroy(StgStreamImpl* This)
119 TRACE("(%p)\n", This);
122 * Release the reference we are holding on the parent storage.
124 IStorage_Release((IStorage*)This->parentStorage);
125 This->parentStorage = 0;
128 * Make sure we clean-up the block chain stream objects that we were using.
130 if (This->bigBlockChain != 0)
132 BlockChainStream_Destroy(This->bigBlockChain);
133 This->bigBlockChain = 0;
136 if (This->smallBlockChain != 0)
138 SmallBlockChainStream_Destroy(This->smallBlockChain);
139 This->smallBlockChain = 0;
143 * Finally, free the memory used-up by the class.
145 HeapFree(GetProcessHeap(), 0, This);
149 * This implements the IUnknown method QueryInterface for this
152 HRESULT WINAPI StgStreamImpl_QueryInterface(
154 REFIID riid, /* [in] */
155 void** ppvObject) /* [iid_is][out] */
157 StgStreamImpl* const This=(StgStreamImpl*)iface;
160 * Perform a sanity check on the parameters.
166 * Initialize the return parameter.
171 * Compare the riid with the interface IDs implemented by this object.
173 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
175 *ppvObject = (IStream*)This;
177 else if (memcmp(&IID_IStream, riid, sizeof(IID_IStream)) == 0)
179 *ppvObject = (IStream*)This;
183 * Check that we obtained an interface.
186 return E_NOINTERFACE;
189 * Query Interface always increases the reference count by one when it is
192 StgStreamImpl_AddRef(iface);
198 * This implements the IUnknown method AddRef for this
201 ULONG WINAPI StgStreamImpl_AddRef(
204 StgStreamImpl* const This=(StgStreamImpl*)iface;
212 * This implements the IUnknown method Release for this
215 ULONG WINAPI StgStreamImpl_Release(
218 StgStreamImpl* const This=(StgStreamImpl*)iface;
227 * If the reference count goes down to 0, perform suicide.
231 StgStreamImpl_Destroy(This);
238 * This method will open the block chain pointed by the property
239 * that describes the stream.
240 * If the stream's size is null, no chain is opened.
242 void StgStreamImpl_OpenBlockChain(
245 StgProperty curProperty;
249 * Make sure no old object is staying behind.
251 if (This->smallBlockChain != 0)
253 SmallBlockChainStream_Destroy(This->smallBlockChain);
254 This->smallBlockChain = 0;
257 if (This->bigBlockChain != 0)
259 BlockChainStream_Destroy(This->bigBlockChain);
260 This->bigBlockChain = 0;
264 * Read the information from the property.
266 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
272 This->streamSize = curProperty.size;
275 * This code supports only streams that are <32 bits in size.
277 assert(This->streamSize.s.HighPart == 0);
279 if(curProperty.startingBlock == BLOCK_END_OF_CHAIN)
281 assert( (This->streamSize.s.HighPart == 0) && (This->streamSize.s.LowPart == 0) );
285 if ( (This->streamSize.s.HighPart == 0) &&
286 (This->streamSize.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
288 This->smallBlockChain = SmallBlockChainStream_Construct(
289 This->parentStorage->ancestorStorage,
290 This->ownerProperty);
294 This->bigBlockChain = BlockChainStream_Construct(
295 This->parentStorage->ancestorStorage,
297 This->ownerProperty);
304 * This method is part of the ISequentialStream interface.
306 * If reads a block of information from the stream at the current
307 * position. It then moves the current position at the end of the
310 * See the documentation of ISequentialStream for more info.
312 HRESULT WINAPI StgStreamImpl_Read(
314 void* pv, /* [length_is][size_is][out] */
316 ULONG* pcbRead) /* [out] */
318 StgStreamImpl* const This=(StgStreamImpl*)iface;
320 ULONG bytesReadBuffer;
321 ULONG bytesToReadFromBuffer;
323 TRACE("(%p, %p, %ld, %p)\n",
324 iface, pv, cb, pcbRead);
327 * If the caller is not interested in the nubmer of bytes read,
328 * we use another buffer to avoid "if" statements in the code.
331 pcbRead = &bytesReadBuffer;
334 * Using the known size of the stream, calculate the number of bytes
335 * to read from the block chain
337 bytesToReadFromBuffer = min( This->streamSize.s.LowPart - This->currentPosition.s.LowPart, cb);
340 * Depending on the type of chain that was opened when the stream was constructed,
341 * we delegate the work to the method that read the block chains.
343 if (This->smallBlockChain!=0)
345 SmallBlockChainStream_ReadAt(This->smallBlockChain,
346 This->currentPosition,
347 bytesToReadFromBuffer,
352 else if (This->bigBlockChain!=0)
354 BlockChainStream_ReadAt(This->bigBlockChain,
355 This->currentPosition,
356 bytesToReadFromBuffer,
363 * Small and big block chains are both NULL. This case will happen
364 * when a stream starts with BLOCK_END_OF_CHAIN and has size zero.
372 * We should always be able to read the proper amount of data from the
375 assert(bytesToReadFromBuffer == *pcbRead);
378 * Advance the pointer for the number of positions read.
380 This->currentPosition.s.LowPart += *pcbRead;
383 * The function returns S_OK if at least one byte could be read.
384 * FIXME: What should be returned if pcbRead argument is NULL?
393 * This method is part of the ISequentialStream interface.
395 * It writes a block of information to the stream at the current
396 * position. It then moves the current position at the end of the
397 * written block. If the stream is too small to fit the block,
398 * the stream is grown to fit.
400 * See the documentation of ISequentialStream for more info.
402 HRESULT WINAPI StgStreamImpl_Write(
404 const void* pv, /* [size_is][in] */
406 ULONG* pcbWritten) /* [out] */
408 StgStreamImpl* const This=(StgStreamImpl*)iface;
410 ULARGE_INTEGER newSize;
411 ULONG bytesWritten = 0;
413 TRACE("(%p, %p, %ld, %p)\n",
414 iface, pv, cb, pcbWritten);
417 * Do we have permission to write to this stream?
419 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE))) {
420 return STG_E_ACCESSDENIED;
424 * If the caller is not interested in the number of bytes written,
425 * we use another buffer to avoid "if" statements in the code.
428 pcbWritten = &bytesWritten;
431 * Initialize the out parameter
441 newSize.s.HighPart = 0;
442 newSize.s.LowPart = This->currentPosition.s.LowPart + cb;
446 * Verify if we need to grow the stream
448 if (newSize.s.LowPart > This->streamSize.s.LowPart)
451 IStream_SetSize(iface, newSize);
455 * Depending on the type of chain that was opened when the stream was constructed,
456 * we delegate the work to the method that readwrites to the block chains.
458 if (This->smallBlockChain!=0)
460 SmallBlockChainStream_WriteAt(This->smallBlockChain,
461 This->currentPosition,
467 else if (This->bigBlockChain!=0)
469 BlockChainStream_WriteAt(This->bigBlockChain,
470 This->currentPosition,
479 * Advance the position pointer for the number of positions written.
481 This->currentPosition.s.LowPart += *pcbWritten;
487 * This method is part of the IStream interface.
489 * It will move the current stream pointer according to the parameters
492 * See the documentation of IStream for more info.
494 HRESULT WINAPI StgStreamImpl_Seek(
496 LARGE_INTEGER dlibMove, /* [in] */
497 DWORD dwOrigin, /* [in] */
498 ULARGE_INTEGER* plibNewPosition) /* [out] */
500 StgStreamImpl* const This=(StgStreamImpl*)iface;
502 ULARGE_INTEGER newPosition;
504 TRACE("(%p, %ld, %ld, %p)\n",
505 iface, dlibMove.s.LowPart, dwOrigin, plibNewPosition);
508 * The caller is allowed to pass in NULL as the new position return value.
509 * If it happens, we assign it to a dynamic variable to avoid special cases
512 if (plibNewPosition == 0)
514 plibNewPosition = &newPosition;
518 * The file pointer is moved depending on the given "function"
523 case STREAM_SEEK_SET:
524 plibNewPosition->s.HighPart = 0;
525 plibNewPosition->s.LowPart = 0;
527 case STREAM_SEEK_CUR:
528 *plibNewPosition = This->currentPosition;
530 case STREAM_SEEK_END:
531 *plibNewPosition = This->streamSize;
534 return STG_E_INVALIDFUNCTION;
537 plibNewPosition->QuadPart = RtlLargeIntegerAdd( plibNewPosition->QuadPart, dlibMove.QuadPart );
540 * tell the caller what we calculated
542 This->currentPosition = *plibNewPosition;
548 * This method is part of the IStream interface.
550 * It will change the size of a stream.
552 * TODO: Switch from small blocks to big blocks and vice versa.
554 * See the documentation of IStream for more info.
556 HRESULT WINAPI StgStreamImpl_SetSize(
558 ULARGE_INTEGER libNewSize) /* [in] */
560 StgStreamImpl* const This=(StgStreamImpl*)iface;
562 StgProperty curProperty;
565 TRACE("(%p, %ld)\n", iface, libNewSize.s.LowPart);
570 if (libNewSize.s.HighPart != 0)
571 return STG_E_INVALIDFUNCTION;
574 * Do we have permission?
576 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
577 return STG_E_ACCESSDENIED;
579 if (This->streamSize.s.LowPart == libNewSize.s.LowPart)
583 * This will happen if we're creating a stream
585 if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
587 if (libNewSize.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
589 This->smallBlockChain = SmallBlockChainStream_Construct(
590 This->parentStorage->ancestorStorage,
591 This->ownerProperty);
595 This->bigBlockChain = BlockChainStream_Construct(
596 This->parentStorage->ancestorStorage,
598 This->ownerProperty);
603 * Read this stream's property to see if it's small blocks or big blocks
605 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
609 * Determine if we have to switch from small to big blocks or vice versa
611 if ( (This->smallBlockChain!=0) &&
612 (curProperty.size.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
614 if (libNewSize.s.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
617 * Transform the small block chain into a big block chain
619 This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
620 This->parentStorage->ancestorStorage,
621 &This->smallBlockChain);
625 if (This->smallBlockChain!=0)
627 Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
631 Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
635 * Write to the property the new information about this stream
637 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
641 curProperty.size.s.HighPart = libNewSize.s.HighPart;
642 curProperty.size.s.LowPart = libNewSize.s.LowPart;
646 StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
651 This->streamSize = libNewSize;
657 * This method is part of the IStream interface.
659 * It will copy the 'cb' Bytes to 'pstm' IStream.
661 * See the documentation of IStream for more info.
663 HRESULT WINAPI StgStreamImpl_CopyTo(
665 IStream* pstm, /* [unique][in] */
666 ULARGE_INTEGER cb, /* [in] */
667 ULARGE_INTEGER* pcbRead, /* [out] */
668 ULARGE_INTEGER* pcbWritten) /* [out] */
672 ULONG bytesRead, bytesWritten, copySize;
673 ULARGE_INTEGER totalBytesRead;
674 ULARGE_INTEGER totalBytesWritten;
676 TRACE("(%p, %p, %ld, %p, %p)\n",
677 iface, pstm, cb.s.LowPart, pcbRead, pcbWritten);
683 return STG_E_INVALIDPOINTER;
685 totalBytesRead.s.LowPart = totalBytesRead.s.HighPart = 0;
686 totalBytesWritten.s.LowPart = totalBytesWritten.s.HighPart = 0;
689 * use stack to store data temporarly
690 * there is surely more performant way of doing it, for now this basic
691 * implementation will do the job
693 while ( cb.s.LowPart > 0 )
695 if ( cb.s.LowPart >= 128 )
698 copySize = cb.s.LowPart;
700 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
702 totalBytesRead.s.LowPart += bytesRead;
704 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
706 totalBytesWritten.s.LowPart += bytesWritten;
709 * Check that read & write operations were succesfull
711 if (bytesRead != bytesWritten)
713 hr = STG_E_MEDIUMFULL;
717 if (bytesRead!=copySize)
720 cb.s.LowPart -= bytesRead;
724 * Update number of bytes read and written
728 pcbRead->s.LowPart = totalBytesRead.s.LowPart;
729 pcbRead->s.HighPart = totalBytesRead.s.HighPart;
734 pcbWritten->s.LowPart = totalBytesWritten.s.LowPart;
735 pcbWritten->s.HighPart = totalBytesWritten.s.HighPart;
741 * This method is part of the IStream interface.
743 * For streams contained in structured storages, this method
744 * does nothing. This is what the documentation tells us.
746 * See the documentation of IStream for more info.
748 HRESULT WINAPI StgStreamImpl_Commit(
750 DWORD grfCommitFlags) /* [in] */
756 * This method is part of the IStream interface.
758 * For streams contained in structured storages, this method
759 * does nothing. This is what the documentation tells us.
761 * See the documentation of IStream for more info.
763 HRESULT WINAPI StgStreamImpl_Revert(
769 HRESULT WINAPI StgStreamImpl_LockRegion(
771 ULARGE_INTEGER libOffset, /* [in] */
772 ULARGE_INTEGER cb, /* [in] */
773 DWORD dwLockType) /* [in] */
775 FIXME("not implemented!\n");
779 HRESULT WINAPI StgStreamImpl_UnlockRegion(
781 ULARGE_INTEGER libOffset, /* [in] */
782 ULARGE_INTEGER cb, /* [in] */
783 DWORD dwLockType) /* [in] */
785 FIXME("not implemented!\n");
790 * This method is part of the IStream interface.
792 * This method returns information about the current
795 * See the documentation of IStream for more info.
797 HRESULT WINAPI StgStreamImpl_Stat(
799 STATSTG* pstatstg, /* [out] */
800 DWORD grfStatFlag) /* [in] */
802 StgStreamImpl* const This=(StgStreamImpl*)iface;
804 StgProperty curProperty;
808 * Read the information from the property.
810 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
816 StorageUtl_CopyPropertyToSTATSTG(pstatstg,
820 pstatstg->grfMode = This->grfMode;
829 * This method is part of the IStream interface.
831 * This method returns a clone of the interface that allows for
832 * another seek pointer
834 * See the documentation of IStream for more info.
836 * I am not totally sure what I am doing here but I presume that this
837 * should be basically as simple as creating a new stream with the same
838 * parent etc and positioning its seek cursor.
840 HRESULT WINAPI StgStreamImpl_Clone(
842 IStream** ppstm) /* [out] */
844 StgStreamImpl* const This=(StgStreamImpl*)iface;
846 StgStreamImpl* new_stream;
847 LARGE_INTEGER seek_pos;
853 return STG_E_INVALIDPOINTER;
855 new_stream = StgStreamImpl_Construct (This->parentStorage, This->grfMode, This->ownerProperty);
858 return STG_E_INSUFFICIENTMEMORY; /* Currently the only reason for new_stream=0 */
860 *ppstm = (IStream*) new_stream;
861 seek_pos.QuadPart = This->currentPosition.QuadPart;
863 hres=StgStreamImpl_Seek (*ppstm, seek_pos, STREAM_SEEK_SET, NULL);
865 assert (SUCCEEDED(hres));