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
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
41 #include "wine/debug.h"
43 #include "storage32.h"
45 WINE_DEFAULT_DEBUG_CHANNEL(storage);
49 * Virtual function table for the StgStreamImpl class.
51 static IStreamVtbl StgStreamImpl_Vtbl =
53 StgStreamImpl_QueryInterface,
55 StgStreamImpl_Release,
59 StgStreamImpl_SetSize,
63 StgStreamImpl_LockRegion,
64 StgStreamImpl_UnlockRegion,
69 /******************************************************************************
70 ** StgStreamImpl implementation
74 * This is the constructor for the StgStreamImpl class.
77 * parentStorage - Pointer to the storage that contains the stream to open
78 * ownerProperty - Index of the property that points to this stream.
80 StgStreamImpl* StgStreamImpl_Construct(
81 StorageBaseImpl* parentStorage,
85 StgStreamImpl* newStream;
87 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(StgStreamImpl));
92 * Set-up the virtual function table and reference count.
94 newStream->lpVtbl = &StgStreamImpl_Vtbl;
98 * We want to nail-down the reference to the storage in case the
99 * stream out-lives the storage in the client application.
101 newStream->parentStorage = parentStorage;
102 IStorage_AddRef((IStorage*)newStream->parentStorage);
104 newStream->grfMode = grfMode;
105 newStream->ownerProperty = ownerProperty;
108 * Start the stream at the beginning.
110 newStream->currentPosition.u.HighPart = 0;
111 newStream->currentPosition.u.LowPart = 0;
114 * Initialize the rest of the data.
116 newStream->streamSize.u.HighPart = 0;
117 newStream->streamSize.u.LowPart = 0;
118 newStream->bigBlockChain = 0;
119 newStream->smallBlockChain = 0;
122 * Read the size from the property and determine if the blocks forming
123 * this stream are large or small.
125 StgStreamImpl_OpenBlockChain(newStream);
132 * This is the destructor of the StgStreamImpl class.
134 * This method will clean-up all the resources used-up by the given StgStreamImpl
135 * class. The pointer passed-in to this function will be freed and will not
138 void StgStreamImpl_Destroy(StgStreamImpl* This)
140 TRACE("(%p)\n", This);
143 * Release the reference we are holding on the parent storage.
145 IStorage_Release((IStorage*)This->parentStorage);
146 This->parentStorage = 0;
149 * Make sure we clean-up the block chain stream objects that we were using.
151 if (This->bigBlockChain != 0)
153 BlockChainStream_Destroy(This->bigBlockChain);
154 This->bigBlockChain = 0;
157 if (This->smallBlockChain != 0)
159 SmallBlockChainStream_Destroy(This->smallBlockChain);
160 This->smallBlockChain = 0;
164 * Finally, free the memory used-up by the class.
166 HeapFree(GetProcessHeap(), 0, This);
170 * This implements the IUnknown method QueryInterface for this
173 HRESULT WINAPI StgStreamImpl_QueryInterface(
175 REFIID riid, /* [in] */
176 void** ppvObject) /* [iid_is][out] */
178 StgStreamImpl* const This=(StgStreamImpl*)iface;
181 * Perform a sanity check on the parameters.
187 * Initialize the return parameter.
192 * Compare the riid with the interface IDs implemented by this object.
194 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
196 *ppvObject = (IStream*)This;
198 else if (memcmp(&IID_IStream, riid, sizeof(IID_IStream)) == 0)
200 *ppvObject = (IStream*)This;
204 * Check that we obtained an interface.
207 return E_NOINTERFACE;
210 * Query Interface always increases the reference count by one when it is
213 StgStreamImpl_AddRef(iface);
219 * This implements the IUnknown method AddRef for this
222 ULONG WINAPI StgStreamImpl_AddRef(
225 StgStreamImpl* const This=(StgStreamImpl*)iface;
226 return InterlockedIncrement(&This->ref);
230 * This implements the IUnknown method Release for this
233 ULONG WINAPI StgStreamImpl_Release(
236 StgStreamImpl* const This=(StgStreamImpl*)iface;
240 ref = InterlockedDecrement(&This->ref);
243 * If the reference count goes down to 0, perform suicide.
247 StgStreamImpl_Destroy(This);
254 * This method will open the block chain pointed by the property
255 * that describes the stream.
256 * If the stream's size is null, no chain is opened.
258 void StgStreamImpl_OpenBlockChain(
261 StgProperty curProperty;
265 * Make sure no old object is left over.
267 if (This->smallBlockChain != 0)
269 SmallBlockChainStream_Destroy(This->smallBlockChain);
270 This->smallBlockChain = 0;
273 if (This->bigBlockChain != 0)
275 BlockChainStream_Destroy(This->bigBlockChain);
276 This->bigBlockChain = 0;
280 * Read the information from the property.
282 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
288 This->streamSize = curProperty.size;
291 * This code supports only streams that are <32 bits in size.
293 assert(This->streamSize.u.HighPart == 0);
295 if(curProperty.startingBlock == BLOCK_END_OF_CHAIN)
297 assert( (This->streamSize.u.HighPart == 0) && (This->streamSize.u.LowPart == 0) );
301 if ( (This->streamSize.u.HighPart == 0) &&
302 (This->streamSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
304 This->smallBlockChain = SmallBlockChainStream_Construct(
305 This->parentStorage->ancestorStorage,
306 This->ownerProperty);
310 This->bigBlockChain = BlockChainStream_Construct(
311 This->parentStorage->ancestorStorage,
313 This->ownerProperty);
320 * This method is part of the ISequentialStream interface.
322 * It reads a block of information from the stream at the current
323 * position. It then moves the current position at the end of the
326 * See the documentation of ISequentialStream for more info.
328 HRESULT WINAPI StgStreamImpl_Read(
330 void* pv, /* [length_is][size_is][out] */
332 ULONG* pcbRead) /* [out] */
334 StgStreamImpl* const This=(StgStreamImpl*)iface;
336 ULONG bytesReadBuffer;
337 ULONG bytesToReadFromBuffer;
338 HRESULT res = S_FALSE;
340 TRACE("(%p, %p, %ld, %p)\n",
341 iface, pv, cb, pcbRead);
344 * If the caller is not interested in the number of bytes read,
345 * we use another buffer to avoid "if" statements in the code.
348 pcbRead = &bytesReadBuffer;
351 * Using the known size of the stream, calculate the number of bytes
352 * to read from the block chain
354 bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
357 * Depending on the type of chain that was opened when the stream was constructed,
358 * we delegate the work to the method that reads the block chains.
360 if (This->smallBlockChain!=0)
362 SmallBlockChainStream_ReadAt(This->smallBlockChain,
363 This->currentPosition,
364 bytesToReadFromBuffer,
369 else if (This->bigBlockChain!=0)
371 BlockChainStream_ReadAt(This->bigBlockChain,
372 This->currentPosition,
373 bytesToReadFromBuffer,
380 * Small and big block chains are both NULL. This case will happen
381 * when a stream starts with BLOCK_END_OF_CHAIN and has size zero.
390 * We should always be able to read the proper amount of data from the
393 assert(bytesToReadFromBuffer == *pcbRead);
396 * Advance the pointer for the number of positions read.
398 This->currentPosition.u.LowPart += *pcbRead;
402 WARN("read %ld instead of the required %ld bytes !\n", *pcbRead, cb);
404 * this used to return S_FALSE, however MSDN docu says that an app should
405 * be prepared to handle error in case of stream end reached, as *some*
406 * implementations *might* return an error (IOW: most do *not*).
407 * As some program fails on returning S_FALSE, I better use S_OK here.
415 TRACE("<-- %08lx\n", res);
420 * This method is part of the ISequentialStream interface.
422 * It writes a block of information to the stream at the current
423 * position. It then moves the current position at the end of the
424 * written block. If the stream is too small to fit the block,
425 * the stream is grown to fit.
427 * See the documentation of ISequentialStream for more info.
429 HRESULT WINAPI StgStreamImpl_Write(
431 const void* pv, /* [size_is][in] */
433 ULONG* pcbWritten) /* [out] */
435 StgStreamImpl* const This=(StgStreamImpl*)iface;
437 ULARGE_INTEGER newSize;
438 ULONG bytesWritten = 0;
440 TRACE("(%p, %p, %ld, %p)\n",
441 iface, pv, cb, pcbWritten);
444 * Do we have permission to write to this stream?
446 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE))) {
447 return STG_E_ACCESSDENIED;
451 return STG_E_INVALIDPOINTER;
454 * If the caller is not interested in the number of bytes written,
455 * we use another buffer to avoid "if" statements in the code.
458 pcbWritten = &bytesWritten;
461 * Initialize the out parameter
471 newSize.u.HighPart = 0;
472 newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
476 * Verify if we need to grow the stream
478 if (newSize.u.LowPart > This->streamSize.u.LowPart)
481 IStream_SetSize(iface, newSize);
485 * Depending on the type of chain that was opened when the stream was constructed,
486 * we delegate the work to the method that readwrites to the block chains.
488 if (This->smallBlockChain!=0)
490 SmallBlockChainStream_WriteAt(This->smallBlockChain,
491 This->currentPosition,
497 else if (This->bigBlockChain!=0)
499 BlockChainStream_WriteAt(This->bigBlockChain,
500 This->currentPosition,
509 * Advance the position pointer for the number of positions written.
511 This->currentPosition.u.LowPart += *pcbWritten;
517 * This method is part of the IStream interface.
519 * It will move the current stream pointer according to the parameters
522 * See the documentation of IStream for more info.
524 HRESULT WINAPI StgStreamImpl_Seek(
526 LARGE_INTEGER dlibMove, /* [in] */
527 DWORD dwOrigin, /* [in] */
528 ULARGE_INTEGER* plibNewPosition) /* [out] */
530 StgStreamImpl* const This=(StgStreamImpl*)iface;
532 ULARGE_INTEGER newPosition;
534 TRACE("(%p, %ld, %ld, %p)\n",
535 iface, dlibMove.u.LowPart, dwOrigin, plibNewPosition);
538 * The caller is allowed to pass in NULL as the new position return value.
539 * If it happens, we assign it to a dynamic variable to avoid special cases
542 if (plibNewPosition == 0)
544 plibNewPosition = &newPosition;
548 * The file pointer is moved depending on the given "function"
553 case STREAM_SEEK_SET:
554 plibNewPosition->u.HighPart = 0;
555 plibNewPosition->u.LowPart = 0;
557 case STREAM_SEEK_CUR:
558 *plibNewPosition = This->currentPosition;
560 case STREAM_SEEK_END:
561 *plibNewPosition = This->streamSize;
564 return STG_E_INVALIDFUNCTION;
567 plibNewPosition->QuadPart = RtlLargeIntegerAdd( plibNewPosition->QuadPart, dlibMove.QuadPart );
570 * tell the caller what we calculated
572 This->currentPosition = *plibNewPosition;
578 * This method is part of the IStream interface.
580 * It will change the size of a stream.
582 * TODO: Switch from small blocks to big blocks and vice versa.
584 * See the documentation of IStream for more info.
586 HRESULT WINAPI StgStreamImpl_SetSize(
588 ULARGE_INTEGER libNewSize) /* [in] */
590 StgStreamImpl* const This=(StgStreamImpl*)iface;
592 StgProperty curProperty;
595 TRACE("(%p, %ld)\n", iface, libNewSize.u.LowPart);
600 if (libNewSize.u.HighPart != 0)
601 return STG_E_INVALIDFUNCTION;
604 * Do we have permission?
606 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
607 return STG_E_ACCESSDENIED;
609 if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
613 * This will happen if we're creating a stream
615 if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
617 if (libNewSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
619 This->smallBlockChain = SmallBlockChainStream_Construct(
620 This->parentStorage->ancestorStorage,
621 This->ownerProperty);
625 This->bigBlockChain = BlockChainStream_Construct(
626 This->parentStorage->ancestorStorage,
628 This->ownerProperty);
633 * Read this stream's property to see if it's small blocks or big blocks
635 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
639 * Determine if we have to switch from small to big blocks or vice versa
641 if ( (This->smallBlockChain!=0) &&
642 (curProperty.size.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
644 if (libNewSize.u.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
647 * Transform the small block chain into a big block chain
649 This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
650 This->parentStorage->ancestorStorage,
651 &This->smallBlockChain);
655 if (This->smallBlockChain!=0)
657 Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
661 Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
665 * Write the new information about this stream to the property
667 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
671 curProperty.size.u.HighPart = libNewSize.u.HighPart;
672 curProperty.size.u.LowPart = libNewSize.u.LowPart;
676 StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
681 This->streamSize = libNewSize;
687 * This method is part of the IStream interface.
689 * It will copy the 'cb' Bytes to 'pstm' IStream.
691 * See the documentation of IStream for more info.
693 HRESULT WINAPI StgStreamImpl_CopyTo(
695 IStream* pstm, /* [unique][in] */
696 ULARGE_INTEGER cb, /* [in] */
697 ULARGE_INTEGER* pcbRead, /* [out] */
698 ULARGE_INTEGER* pcbWritten) /* [out] */
702 ULONG bytesRead, bytesWritten, copySize;
703 ULARGE_INTEGER totalBytesRead;
704 ULARGE_INTEGER totalBytesWritten;
706 TRACE("(%p, %p, %ld, %p, %p)\n",
707 iface, pstm, cb.u.LowPart, pcbRead, pcbWritten);
713 return STG_E_INVALIDPOINTER;
715 totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
716 totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
719 * use stack to store data temporarily
720 * there is surely a more performant way of doing it, for now this basic
721 * implementation will do the job
723 while ( cb.u.LowPart > 0 )
725 if ( cb.u.LowPart >= 128 )
728 copySize = cb.u.LowPart;
730 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
732 totalBytesRead.u.LowPart += bytesRead;
734 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
736 totalBytesWritten.u.LowPart += bytesWritten;
739 * Check that read & write operations were successful
741 if (bytesRead != bytesWritten)
743 hr = STG_E_MEDIUMFULL;
747 if (bytesRead!=copySize)
750 cb.u.LowPart -= bytesRead;
754 * Update number of bytes read and written
758 pcbRead->u.LowPart = totalBytesRead.u.LowPart;
759 pcbRead->u.HighPart = totalBytesRead.u.HighPart;
764 pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
765 pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
771 * This method is part of the IStream interface.
773 * For streams contained in structured storages, this method
774 * does nothing. This is what the documentation tells us.
776 * See the documentation of IStream for more info.
778 HRESULT WINAPI StgStreamImpl_Commit(
780 DWORD grfCommitFlags) /* [in] */
786 * This method is part of the IStream interface.
788 * For streams contained in structured storages, this method
789 * does nothing. This is what the documentation tells us.
791 * See the documentation of IStream for more info.
793 HRESULT WINAPI StgStreamImpl_Revert(
799 HRESULT WINAPI StgStreamImpl_LockRegion(
801 ULARGE_INTEGER libOffset, /* [in] */
802 ULARGE_INTEGER cb, /* [in] */
803 DWORD dwLockType) /* [in] */
805 FIXME("not implemented!\n");
809 HRESULT WINAPI StgStreamImpl_UnlockRegion(
811 ULARGE_INTEGER libOffset, /* [in] */
812 ULARGE_INTEGER cb, /* [in] */
813 DWORD dwLockType) /* [in] */
815 FIXME("not implemented!\n");
820 * This method is part of the IStream interface.
822 * This method returns information about the current
825 * See the documentation of IStream for more info.
827 HRESULT WINAPI StgStreamImpl_Stat(
829 STATSTG* pstatstg, /* [out] */
830 DWORD grfStatFlag) /* [in] */
832 StgStreamImpl* const This=(StgStreamImpl*)iface;
834 StgProperty curProperty;
838 * Read the information from the property.
840 readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
846 StorageUtl_CopyPropertyToSTATSTG(pstatstg,
850 pstatstg->grfMode = This->grfMode;
859 * This method is part of the IStream interface.
861 * This method returns a clone of the interface that allows for
862 * another seek pointer
864 * See the documentation of IStream for more info.
866 * I am not totally sure what I am doing here but I presume that this
867 * should be basically as simple as creating a new stream with the same
868 * parent etc and positioning its seek cursor.
870 HRESULT WINAPI StgStreamImpl_Clone(
872 IStream** ppstm) /* [out] */
874 StgStreamImpl* const This=(StgStreamImpl*)iface;
876 StgStreamImpl* new_stream;
877 LARGE_INTEGER seek_pos;
883 return STG_E_INVALIDPOINTER;
885 new_stream = StgStreamImpl_Construct (This->parentStorage, This->grfMode, This->ownerProperty);
888 return STG_E_INSUFFICIENTMEMORY; /* Currently the only reason for new_stream=0 */
890 *ppstm = (IStream*) new_stream;
891 seek_pos.QuadPart = This->currentPosition.QuadPart;
893 hres=StgStreamImpl_Seek (*ppstm, seek_pos, STREAM_SEEK_SET, NULL);
895 assert (SUCCEEDED(hres));