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);
418 * Do we have permission to write to this stream?
420 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE))) {
421 return STG_E_ACCESSDENIED;
425 * If the caller is not interested in the number of bytes written,
426 * we use another buffer to avoid "if" statements in the code.
429 pcbWritten = &bytesWritten;
432 * Initialize the out parameter
442 newSize.s.HighPart = 0;
443 newSize.s.LowPart = This->currentPosition.s.LowPart + cb;
447 * Verify if we need to grow the stream
449 if (newSize.s.LowPart > This->streamSize.s.LowPart)
452 IStream_SetSize(iface, newSize);
456 * Depending on the type of chain that was opened when the stream was constructed,
457 * we delegate the work to the method that readwrites to the block chains.
459 if (This->smallBlockChain!=0)
461 SmallBlockChainStream_WriteAt(This->smallBlockChain,
462 This->currentPosition,
468 else if (This->bigBlockChain!=0)
470 BlockChainStream_WriteAt(This->bigBlockChain,
471 This->currentPosition,
480 * Advance the position pointer for the number of positions written.
482 This->currentPosition.s.LowPart += *pcbWritten;
488 * This method is part of the IStream interface.
490 * It will move the current stream pointer according to the parameters
493 * See the documentation of IStream for more info.
495 HRESULT WINAPI StgStreamImpl_Seek(
497 LARGE_INTEGER dlibMove, /* [in] */
498 DWORD dwOrigin, /* [in] */
499 ULARGE_INTEGER* plibNewPosition) /* [out] */
501 StgStreamImpl* const This=(StgStreamImpl*)iface;
503 ULARGE_INTEGER newPosition;
505 TRACE("(%p, %ld, %ld, %p)\n",
506 iface, dlibMove.s.LowPart, dwOrigin, plibNewPosition);
509 * The caller is allowed to pass in NULL as the new position return value.
510 * If it happens, we assign it to a dynamic variable to avoid special cases
513 if (plibNewPosition == 0)
515 plibNewPosition = &newPosition;
519 * The file pointer is moved depending on the given "function"
524 case STREAM_SEEK_SET:
525 plibNewPosition->s.HighPart = 0;
526 plibNewPosition->s.LowPart = 0;
528 case STREAM_SEEK_CUR:
529 *plibNewPosition = This->currentPosition;
531 case STREAM_SEEK_END:
532 *plibNewPosition = This->streamSize;
535 return STG_E_INVALIDFUNCTION;
538 #if SIZEOF_LONG_LONG >= 8
539 plibNewPosition->QuadPart += dlibMove.QuadPart;
542 * do some multiword arithmetic:
543 * treat HighPart as a signed value
544 * treat LowPart as unsigned
545 * NOTE: this stuff is two's complement specific!
547 if (dlibMove.s.HighPart < 0) { /* dlibMove is < 0 */
548 /* calculate the absolute value of dlibMove ... */
549 dlibMove.s.HighPart = -dlibMove.s.HighPart;
550 dlibMove.s.LowPart ^= -1;
551 /* ... and subtract with carry */
552 if (dlibMove.s.LowPart > plibNewPosition->s.LowPart) {
553 /* carry needed, This accounts for any underflows at [1]*/
554 plibNewPosition->s.HighPart -= 1;
556 plibNewPosition->s.LowPart -= dlibMove.s.LowPart; /* [1] */
557 plibNewPosition->s.HighPart -= dlibMove.s.HighPart;
560 int initialLowPart = plibNewPosition->s.LowPart;
561 plibNewPosition->s.LowPart += dlibMove.s.LowPart;
562 if((plibNewPosition->s.LowPart < initialLowPart) ||
563 (plibNewPosition->s.LowPart < dlibMove.s.LowPart)) {
564 /* LowPart has rolled over => add the carry digit to HighPart */
565 plibNewPosition->s.HighPart++;
567 plibNewPosition->s.HighPart += dlibMove.s.HighPart;
570 * Check if we end-up before the beginning of the file. That should
573 if (plibNewPosition->s.HighPart < 0) {
574 return STG_E_INVALIDPOINTER;
578 * We currently don't support files with offsets of >32 bits.
579 * Note that we have checked for a negative offset already
581 assert(plibNewPosition->s.HighPart <= 0);
586 * tell the caller what we calculated
588 This->currentPosition = *plibNewPosition;
594 * This method is part of the IStream interface.
596 * It will change the size of a stream.
598 * TODO: Switch from small blocks to big blocks and vice versa.
600 * See the documentation of IStream for more info.
602 HRESULT WINAPI StgStreamImpl_SetSize(
604 ULARGE_INTEGER libNewSize) /* [in] */
606 StgStreamImpl* const This=(StgStreamImpl*)iface;
608 StgProperty curProperty;
611 TRACE("(%p, %ld)\n", iface, libNewSize.s.LowPart);
616 if (libNewSize.s.HighPart != 0)
617 return STG_E_INVALIDFUNCTION;
620 * Do we have permission?
622 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
623 return STG_E_ACCESSDENIED;
625 if (This->streamSize.s.LowPart == libNewSize.s.LowPart)
629 * This will happen if we're creating a stream
631 if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
633 if (libNewSize.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
635 This->smallBlockChain = SmallBlockChainStream_Construct(
636 This->parentStorage->ancestorStorage,
637 This->ownerProperty);
641 This->bigBlockChain = BlockChainStream_Construct(
642 This->parentStorage->ancestorStorage,
644 This->ownerProperty);
649 * Read this stream's property to see if it's small blocks or big blocks
651 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
655 * Determine if we have to switch from small to big blocks or vice versa
657 if ( (This->smallBlockChain!=0) &&
658 (curProperty.size.s.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
660 if (libNewSize.s.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
663 * Transform the small block chain into a big block chain
665 This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
666 This->parentStorage->ancestorStorage,
667 &This->smallBlockChain);
671 if (This->smallBlockChain!=0)
673 Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
677 Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
681 * Write to the property the new information about this stream
683 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
687 curProperty.size.s.HighPart = libNewSize.s.HighPart;
688 curProperty.size.s.LowPart = libNewSize.s.LowPart;
692 StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
697 This->streamSize = libNewSize;
703 * This method is part of the IStream interface.
705 * It will copy the 'cb' Bytes to 'pstm' IStream.
707 * See the documentation of IStream for more info.
709 HRESULT WINAPI StgStreamImpl_CopyTo(
711 IStream* pstm, /* [unique][in] */
712 ULARGE_INTEGER cb, /* [in] */
713 ULARGE_INTEGER* pcbRead, /* [out] */
714 ULARGE_INTEGER* pcbWritten) /* [out] */
718 ULONG bytesRead, bytesWritten, copySize;
719 ULARGE_INTEGER totalBytesRead;
720 ULARGE_INTEGER totalBytesWritten;
722 TRACE("(%p, %p, %ld, %p, %p)\n",
723 iface, pstm, cb.s.LowPart, pcbRead, pcbWritten);
729 return STG_E_INVALIDPOINTER;
731 totalBytesRead.s.LowPart = totalBytesRead.s.HighPart = 0;
732 totalBytesWritten.s.LowPart = totalBytesWritten.s.HighPart = 0;
735 * use stack to store data temporarly
736 * there is surely more performant way of doing it, for now this basic
737 * implementation will do the job
739 while ( cb.s.LowPart > 0 )
741 if ( cb.s.LowPart >= 128 )
744 copySize = cb.s.LowPart;
746 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
748 totalBytesRead.s.LowPart += bytesRead;
750 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
752 totalBytesWritten.s.LowPart += bytesWritten;
755 * Check that read & write operations were succesfull
757 if (bytesRead != bytesWritten)
759 hr = STG_E_MEDIUMFULL;
763 if (bytesRead!=copySize)
766 cb.s.LowPart -= bytesRead;
770 * Update number of bytes read and written
774 pcbRead->s.LowPart = totalBytesRead.s.LowPart;
775 pcbRead->s.HighPart = totalBytesRead.s.HighPart;
780 pcbWritten->s.LowPart = totalBytesWritten.s.LowPart;
781 pcbWritten->s.HighPart = totalBytesWritten.s.HighPart;
787 * This method is part of the IStream interface.
789 * For streams contained in structured storages, this method
790 * does nothing. This is what the documentation tells us.
792 * See the documentation of IStream for more info.
794 HRESULT WINAPI StgStreamImpl_Commit(
796 DWORD grfCommitFlags) /* [in] */
802 * This method is part of the IStream interface.
804 * For streams contained in structured storages, this method
805 * does nothing. This is what the documentation tells us.
807 * See the documentation of IStream for more info.
809 HRESULT WINAPI StgStreamImpl_Revert(
815 HRESULT WINAPI StgStreamImpl_LockRegion(
817 ULARGE_INTEGER libOffset, /* [in] */
818 ULARGE_INTEGER cb, /* [in] */
819 DWORD dwLockType) /* [in] */
821 FIXME("not implemented!\n");
825 HRESULT WINAPI StgStreamImpl_UnlockRegion(
827 ULARGE_INTEGER libOffset, /* [in] */
828 ULARGE_INTEGER cb, /* [in] */
829 DWORD dwLockType) /* [in] */
831 FIXME("not implemented!\n");
836 * This method is part of the IStream interface.
838 * This method returns information about the current
841 * See the documentation of IStream for more info.
843 HRESULT WINAPI StgStreamImpl_Stat(
845 STATSTG* pstatstg, /* [out] */
846 DWORD grfStatFlag) /* [in] */
848 StgStreamImpl* const This=(StgStreamImpl*)iface;
850 StgProperty curProperty;
854 * Read the information from the property.
856 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
862 StorageUtl_CopyPropertyToSTATSTG(pstatstg,
866 pstatstg->grfMode = This->grfMode;
874 HRESULT WINAPI StgStreamImpl_Clone(
876 IStream** ppstm) /* [out] */
878 FIXME("not implemented!\n");