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
18 #include "debugtools.h"
19 #include "wine/obj_storage.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 begining.
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 the buffer was filled completely
384 * it returns S_FALSE if the end of the stream is reached before the
394 * This method is part of the ISequentialStream interface.
396 * It writes a block of information to the stream at the current
397 * position. It then moves the current position at the end of the
398 * written block. If the stream is too small to fit the block,
399 * the stream is grown to fit.
401 * See the documentation of ISequentialStream for more info.
403 HRESULT WINAPI StgStreamImpl_Write(
405 const void* pv, /* [size_is][in] */
407 ULONG* pcbWritten) /* [out] */
409 StgStreamImpl* const This=(StgStreamImpl*)iface;
411 ULARGE_INTEGER newSize;
412 ULONG bytesWritten = 0;
414 TRACE("(%p, %p, %ld, %p)\n",
415 iface, pv, cb, pcbWritten);
417 if (!(This->grfMode & STGM_WRITE))
418 return STG_E_ACCESSDENIED;
421 * If the caller is not interested in the number of bytes written,
422 * we use another buffer to avoid "if" statements in the code.
425 pcbWritten = &bytesWritten;
428 * Initialize the out parameter
433 * Do we have permission to write to this stream?
435 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
436 return STG_E_ACCESSDENIED;
444 newSize.s.HighPart = 0;
445 newSize.s.LowPart = This->currentPosition.s.LowPart + cb;
449 * Verify if we need to grow the stream
451 if (newSize.s.LowPart > This->streamSize.s.LowPart)
454 IStream_SetSize(iface, newSize);
458 * Depending on the type of chain that was opened when the stream was constructed,
459 * we delegate the work to the method that readwrites to the block chains.
461 if (This->smallBlockChain!=0)
463 SmallBlockChainStream_WriteAt(This->smallBlockChain,
464 This->currentPosition,
470 else if (This->bigBlockChain!=0)
472 BlockChainStream_WriteAt(This->bigBlockChain,
473 This->currentPosition,
482 * Advance the position pointer for the number of positions written.
484 This->currentPosition.s.LowPart += *pcbWritten;
490 * This method is part of the IStream interface.
492 * It will move the current stream pointer according to the parameters
495 * See the documentation of IStream for more info.
497 HRESULT WINAPI StgStreamImpl_Seek(
499 LARGE_INTEGER dlibMove, /* [in] */
500 DWORD dwOrigin, /* [in] */
501 ULARGE_INTEGER* plibNewPosition) /* [out] */
503 StgStreamImpl* const This=(StgStreamImpl*)iface;
505 ULARGE_INTEGER newPosition;
507 TRACE("(%p, %ld, %ld, %p)\n",
508 iface, dlibMove.s.LowPart, dwOrigin, plibNewPosition);
511 * The caller is allowed to pass in NULL as the new position return value.
512 * If it happens, we assign it to a dynamic variable to avoid special cases
515 if (plibNewPosition == 0)
517 plibNewPosition = &newPosition;
521 * The file pointer is moved depending on the given "function"
526 case STREAM_SEEK_SET:
527 plibNewPosition->s.HighPart = 0;
528 plibNewPosition->s.LowPart = 0;
530 case STREAM_SEEK_CUR:
531 *plibNewPosition = This->currentPosition;
533 case STREAM_SEEK_END:
534 *plibNewPosition = This->streamSize;
537 return STG_E_INVALIDFUNCTION;
540 #if SIZEOF_LONG_LONG >= 8
541 plibNewPosition->QuadPart += dlibMove.QuadPart;
544 * do some multiword arithmetic:
545 * treat HighPart as a signed value
546 * treat LowPart as unsigned
547 * NOTE: this stuff is two's complement specific!
549 if (dlibMove.s.HighPart < 0) { /* dlibMove is < 0 */
550 /* calculate the absolute value of dlibMove ... */
551 dlibMove.s.HighPart = -dlibMove.s.HighPart;
552 dlibMove.s.LowPart ^= -1;
553 /* ... and subtract with carry */
554 if (dlibMove.s.LowPart > plibNewPosition->s.LowPart) {
555 /* carry needed, This accounts for any underflows at [1]*/
556 plibNewPosition->s.HighPart -= 1;
558 plibNewPosition->s.LowPart -= dlibMove.s.LowPart; /* [1] */
559 plibNewPosition->s.HighPart -= dlibMove.s.HighPart;
562 int initialLowPart = plibNewPosition->s.LowPart;
563 plibNewPosition->s.LowPart += dlibMove.s.LowPart;
564 if((plibNewPosition->s.LowPart < initialLowPart) ||
565 (plibNewPosition->s.LowPart < dlibMove.s.LowPart)) {
566 /* LowPart has rolled over => add the carry digit to HighPart */
567 plibNewPosition->s.HighPart++;
569 plibNewPosition->s.HighPart += dlibMove.s.HighPart;
572 * Check if we end-up before the beginning of the file. That should
575 if (plibNewPosition->s.HighPart < 0) {
576 return STG_E_INVALIDPOINTER;
580 * We currently don't support files with offsets of >32 bits.
581 * Note that we have checked for a negative offset already
583 assert(plibNewPosition->s.HighPart <= 0);
588 * tell the caller what we calculated
590 This->currentPosition = *plibNewPosition;
596 * This method is part of the IStream interface.
598 * It will change the size of a stream.
600 * TODO: Switch from small blocks to big blocks and vice versa.
602 * See the documentation of IStream for more info.
604 HRESULT WINAPI StgStreamImpl_SetSize(
606 ULARGE_INTEGER libNewSize) /* [in] */
608 StgStreamImpl* const This=(StgStreamImpl*)iface;
610 StgProperty curProperty;
613 TRACE("(%p, %ld)\n", iface, libNewSize.s.LowPart);
618 if (libNewSize.s.HighPart != 0)
619 return STG_E_INVALIDFUNCTION;
622 * Do we have permission?
624 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
625 return STG_E_ACCESSDENIED;
627 if (This->streamSize.s.LowPart == libNewSize.s.LowPart)
631 * This will happen if we're creating a stream
633 if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
635 if (libNewSize.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
637 This->smallBlockChain = SmallBlockChainStream_Construct(
638 This->parentStorage->ancestorStorage,
639 This->ownerProperty);
643 This->bigBlockChain = BlockChainStream_Construct(
644 This->parentStorage->ancestorStorage,
646 This->ownerProperty);
651 * Read this stream's property to see if it's small blocks or big blocks
653 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
657 * Determine if we have to switch from small to big blocks or vice versa
659 if ( (This->smallBlockChain!=0) &&
660 (curProperty.size.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
662 if (libNewSize.s.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
665 * Transform the small block chain into a big block chain
667 This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
668 This->parentStorage->ancestorStorage,
669 &This->smallBlockChain);
673 if (This->smallBlockChain!=0)
675 Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
679 Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
683 * Write to the property the new information about this stream
685 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
689 curProperty.size.s.HighPart = libNewSize.s.HighPart;
690 curProperty.size.s.LowPart = libNewSize.s.LowPart;
694 StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
699 This->streamSize = libNewSize;
705 * This method is part of the IStream interface.
707 * It will copy the 'cb' Bytes to 'pstm' IStream.
709 * See the documentation of IStream for more info.
711 HRESULT WINAPI StgStreamImpl_CopyTo(
713 IStream* pstm, /* [unique][in] */
714 ULARGE_INTEGER cb, /* [in] */
715 ULARGE_INTEGER* pcbRead, /* [out] */
716 ULARGE_INTEGER* pcbWritten) /* [out] */
720 ULONG bytesRead, bytesWritten, copySize;
721 ULARGE_INTEGER totalBytesRead;
722 ULARGE_INTEGER totalBytesWritten;
724 TRACE("(%p, %p, %ld, %p, %p)\n",
725 iface, pstm, cb.s.LowPart, pcbRead, pcbWritten);
731 return STG_E_INVALIDPOINTER;
733 totalBytesRead.s.LowPart = totalBytesRead.s.HighPart = 0;
734 totalBytesWritten.s.LowPart = totalBytesWritten.s.HighPart = 0;
737 * use stack to store data temporarly
738 * there is surely more performant way of doing it, for now this basic
739 * implementation will do the job
741 while ( cb.s.LowPart > 0 )
743 if ( cb.s.LowPart >= 128 )
746 copySize = cb.s.LowPart;
748 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
750 totalBytesRead.s.LowPart += bytesRead;
752 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
754 totalBytesWritten.s.LowPart += bytesWritten;
757 * Check that read & write operations were succesfull
759 if (bytesRead != bytesWritten)
761 hr = STG_E_MEDIUMFULL;
765 if (bytesRead!=copySize)
768 cb.s.LowPart -= bytesRead;
772 * Update number of bytes read and written
776 pcbRead->s.LowPart = totalBytesRead.s.LowPart;
777 pcbRead->s.HighPart = totalBytesRead.s.HighPart;
782 pcbWritten->s.LowPart = totalBytesWritten.s.LowPart;
783 pcbWritten->s.HighPart = totalBytesWritten.s.HighPart;
789 * This method is part of the IStream interface.
791 * For streams contained in structured storages, this method
792 * does nothing. This is what the documentation tells us.
794 * See the documentation of IStream for more info.
796 HRESULT WINAPI StgStreamImpl_Commit(
798 DWORD grfCommitFlags) /* [in] */
804 * This method is part of the IStream interface.
806 * For streams contained in structured storages, this method
807 * does nothing. This is what the documentation tells us.
809 * See the documentation of IStream for more info.
811 HRESULT WINAPI StgStreamImpl_Revert(
817 HRESULT WINAPI StgStreamImpl_LockRegion(
819 ULARGE_INTEGER libOffset, /* [in] */
820 ULARGE_INTEGER cb, /* [in] */
821 DWORD dwLockType) /* [in] */
823 FIXME("not implemented!\n");
827 HRESULT WINAPI StgStreamImpl_UnlockRegion(
829 ULARGE_INTEGER libOffset, /* [in] */
830 ULARGE_INTEGER cb, /* [in] */
831 DWORD dwLockType) /* [in] */
833 FIXME("not implemented!\n");
838 * This method is part of the IStream interface.
840 * This method returns information about the current
843 * See the documentation of IStream for more info.
845 HRESULT WINAPI StgStreamImpl_Stat(
847 STATSTG* pstatstg, /* [out] */
848 DWORD grfStatFlag) /* [in] */
850 StgStreamImpl* const This=(StgStreamImpl*)iface;
852 StgProperty curProperty;
856 * Read the information from the property.
858 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
864 StorageUtl_CopyPropertyToSTATSTG(pstatstg,
868 pstatstg->grfMode = This->grfMode;
876 HRESULT WINAPI StgStreamImpl_Clone(
878 IStream** ppstm) /* [out] */
880 FIXME("not implemented!\n");