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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
40 #include "wine/debug.h"
42 #include "storage32.h"
44 WINE_DEFAULT_DEBUG_CHANNEL(storage);
48 * This is the destructor of the StgStreamImpl class.
50 * This method will clean-up all the resources used-up by the given StgStreamImpl
51 * class. The pointer passed-in to this function will be freed and will not
54 static void StgStreamImpl_Destroy(StgStreamImpl* This)
56 TRACE("(%p)\n", This);
59 * Release the reference we are holding on the parent storage.
60 * IStorage_Release((IStorage*)This->parentStorage);
62 * No, don't do this. Some apps call IStorage_Release without
63 * calling IStream_Release first. If we grab a reference the
64 * file is not closed, and the app fails when it tries to
65 * reopen the file (Easy-PC, for example). Just inform the
66 * storage that we have closed the stream
69 if(This->parentStorage) {
71 StorageBaseImpl_RemoveStream(This->parentStorage, This);
75 This->parentStorage = 0;
78 * Make sure we clean-up the block chain stream objects that we were using.
80 if (This->bigBlockChain != 0)
82 BlockChainStream_Destroy(This->bigBlockChain);
83 This->bigBlockChain = 0;
86 if (This->smallBlockChain != 0)
88 SmallBlockChainStream_Destroy(This->smallBlockChain);
89 This->smallBlockChain = 0;
93 * Finally, free the memory used-up by the class.
95 HeapFree(GetProcessHeap(), 0, This);
99 * This implements the IUnknown method QueryInterface for this
102 static HRESULT WINAPI StgStreamImpl_QueryInterface(
104 REFIID riid, /* [in] */
105 void** ppvObject) /* [iid_is][out] */
107 StgStreamImpl* const This=(StgStreamImpl*)iface;
110 * Perform a sanity check on the parameters.
116 * Initialize the return parameter.
121 * Compare the riid with the interface IDs implemented by this object.
123 if (IsEqualIID(&IID_IUnknown, riid) ||
124 IsEqualIID(&IID_IPersist, riid) ||
125 IsEqualIID(&IID_IPersistStream, riid) ||
126 IsEqualIID(&IID_ISequentialStream, riid) ||
127 IsEqualIID(&IID_IStream, riid))
129 *ppvObject = (IStream*)This;
133 * Check that we obtained an interface.
136 return E_NOINTERFACE;
139 * Query Interface always increases the reference count by one when it is
142 IStream_AddRef(iface);
148 * This implements the IUnknown method AddRef for this
151 static ULONG WINAPI StgStreamImpl_AddRef(
154 StgStreamImpl* const This=(StgStreamImpl*)iface;
155 return InterlockedIncrement(&This->ref);
159 * This implements the IUnknown method Release for this
162 static ULONG WINAPI StgStreamImpl_Release(
165 StgStreamImpl* const This=(StgStreamImpl*)iface;
169 ref = InterlockedDecrement(&This->ref);
172 * If the reference count goes down to 0, perform suicide.
176 StgStreamImpl_Destroy(This);
183 * This method will open the block chain pointed by the property
184 * that describes the stream.
185 * If the stream's size is null, no chain is opened.
187 static void StgStreamImpl_OpenBlockChain(
190 StgProperty curProperty;
194 * Make sure no old object is left over.
196 if (This->smallBlockChain != 0)
198 SmallBlockChainStream_Destroy(This->smallBlockChain);
199 This->smallBlockChain = 0;
202 if (This->bigBlockChain != 0)
204 BlockChainStream_Destroy(This->bigBlockChain);
205 This->bigBlockChain = 0;
209 * Read the information from the property.
211 readSuccessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
217 This->streamSize = curProperty.size;
220 * This code supports only streams that are <32 bits in size.
222 assert(This->streamSize.u.HighPart == 0);
224 if(curProperty.startingBlock == BLOCK_END_OF_CHAIN)
226 assert( (This->streamSize.u.HighPart == 0) && (This->streamSize.u.LowPart == 0) );
230 if ( (This->streamSize.u.HighPart == 0) &&
231 (This->streamSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
233 This->smallBlockChain = SmallBlockChainStream_Construct(
234 This->parentStorage->ancestorStorage,
235 This->ownerProperty);
239 This->bigBlockChain = BlockChainStream_Construct(
240 This->parentStorage->ancestorStorage,
242 This->ownerProperty);
249 * This method is part of the ISequentialStream interface.
251 * It reads a block of information from the stream at the current
252 * position. It then moves the current position at the end of the
255 * See the documentation of ISequentialStream for more info.
257 static HRESULT WINAPI StgStreamImpl_Read(
259 void* pv, /* [length_is][size_is][out] */
261 ULONG* pcbRead) /* [out] */
263 StgStreamImpl* const This=(StgStreamImpl*)iface;
265 ULONG bytesReadBuffer;
266 ULONG bytesToReadFromBuffer;
269 TRACE("(%p, %p, %d, %p)\n",
270 iface, pv, cb, pcbRead);
272 if (!This->parentStorage)
274 WARN("storage reverted\n");
275 return STG_E_REVERTED;
279 * If the caller is not interested in the number of bytes read,
280 * we use another buffer to avoid "if" statements in the code.
283 pcbRead = &bytesReadBuffer;
286 * Using the known size of the stream, calculate the number of bytes
287 * to read from the block chain
289 bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
292 * Depending on the type of chain that was opened when the stream was constructed,
293 * we delegate the work to the method that reads the block chains.
295 if (This->smallBlockChain!=0)
297 res = SmallBlockChainStream_ReadAt(This->smallBlockChain,
298 This->currentPosition,
299 bytesToReadFromBuffer,
304 else if (This->bigBlockChain!=0)
306 res = BlockChainStream_ReadAt(This->bigBlockChain,
307 This->currentPosition,
308 bytesToReadFromBuffer,
315 * Small and big block chains are both NULL. This case will happen
316 * when a stream starts with BLOCK_END_OF_CHAIN and has size zero.
327 * We should always be able to read the proper amount of data from the
330 assert(bytesToReadFromBuffer == *pcbRead);
333 * Advance the pointer for the number of positions read.
335 This->currentPosition.u.LowPart += *pcbRead;
339 TRACE("<-- %08x\n", res);
344 * This method is part of the ISequentialStream interface.
346 * It writes a block of information to the stream at the current
347 * position. It then moves the current position at the end of the
348 * written block. If the stream is too small to fit the block,
349 * the stream is grown to fit.
351 * See the documentation of ISequentialStream for more info.
353 static HRESULT WINAPI StgStreamImpl_Write(
355 const void* pv, /* [size_is][in] */
357 ULONG* pcbWritten) /* [out] */
359 StgStreamImpl* const This=(StgStreamImpl*)iface;
361 ULARGE_INTEGER newSize;
362 ULONG bytesWritten = 0;
365 TRACE("(%p, %p, %d, %p)\n",
366 iface, pv, cb, pcbWritten);
369 * Do we have permission to write to this stream?
371 switch(STGM_ACCESS_MODE(This->grfMode))
377 WARN("access denied by flags: 0x%x\n", STGM_ACCESS_MODE(This->grfMode));
378 return STG_E_ACCESSDENIED;
382 return STG_E_INVALIDPOINTER;
384 if (!This->parentStorage)
386 WARN("storage reverted\n");
387 return STG_E_REVERTED;
391 * If the caller is not interested in the number of bytes written,
392 * we use another buffer to avoid "if" statements in the code.
395 pcbWritten = &bytesWritten;
398 * Initialize the out parameter
404 TRACE("<-- S_OK, written 0\n");
409 newSize.u.HighPart = 0;
410 newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
414 * Verify if we need to grow the stream
416 if (newSize.u.LowPart > This->streamSize.u.LowPart)
419 res = IStream_SetSize(iface, newSize);
425 * Depending on the type of chain that was opened when the stream was constructed,
426 * we delegate the work to the method that readwrites to the block chains.
428 if (This->smallBlockChain!=0)
430 res = SmallBlockChainStream_WriteAt(This->smallBlockChain,
431 This->currentPosition,
437 else if (This->bigBlockChain!=0)
439 res = BlockChainStream_WriteAt(This->bigBlockChain,
440 This->currentPosition,
447 /* this should never happen because the IStream_SetSize call above will
448 * make sure a big or small block chain is created */
454 * Advance the position pointer for the number of positions written.
456 This->currentPosition.u.LowPart += *pcbWritten;
458 TRACE("<-- S_OK, written %u\n", *pcbWritten);
463 * This method is part of the IStream interface.
465 * It will move the current stream pointer according to the parameters
468 * See the documentation of IStream for more info.
470 static HRESULT WINAPI StgStreamImpl_Seek(
472 LARGE_INTEGER dlibMove, /* [in] */
473 DWORD dwOrigin, /* [in] */
474 ULARGE_INTEGER* plibNewPosition) /* [out] */
476 StgStreamImpl* const This=(StgStreamImpl*)iface;
478 ULARGE_INTEGER newPosition;
480 TRACE("(%p, %d, %d, %p)\n",
481 iface, dlibMove.u.LowPart, dwOrigin, plibNewPosition);
484 * fail if the stream has no parent (as does windows)
487 if (!This->parentStorage)
489 WARN("storage reverted\n");
490 return STG_E_REVERTED;
494 * The caller is allowed to pass in NULL as the new position return value.
495 * If it happens, we assign it to a dynamic variable to avoid special cases
498 if (plibNewPosition == 0)
500 plibNewPosition = &newPosition;
504 * The file pointer is moved depending on the given "function"
509 case STREAM_SEEK_SET:
510 plibNewPosition->u.HighPart = 0;
511 plibNewPosition->u.LowPart = 0;
513 case STREAM_SEEK_CUR:
514 *plibNewPosition = This->currentPosition;
516 case STREAM_SEEK_END:
517 *plibNewPosition = This->streamSize;
520 WARN("invalid dwOrigin %d\n", dwOrigin);
521 return STG_E_INVALIDFUNCTION;
524 plibNewPosition->QuadPart = RtlLargeIntegerAdd( plibNewPosition->QuadPart, dlibMove.QuadPart );
527 * tell the caller what we calculated
529 This->currentPosition = *plibNewPosition;
535 * This method is part of the IStream interface.
537 * It will change the size of a stream.
539 * TODO: Switch from small blocks to big blocks and vice versa.
541 * See the documentation of IStream for more info.
543 static HRESULT WINAPI StgStreamImpl_SetSize(
545 ULARGE_INTEGER libNewSize) /* [in] */
547 StgStreamImpl* const This=(StgStreamImpl*)iface;
549 StgProperty curProperty;
552 TRACE("(%p, %d)\n", iface, libNewSize.u.LowPart);
554 if(!This->parentStorage)
556 WARN("storage reverted\n");
557 return STG_E_REVERTED;
563 if (libNewSize.u.HighPart != 0)
565 WARN("invalid value for libNewSize.u.HighPart %d\n", libNewSize.u.HighPart);
566 return STG_E_INVALIDFUNCTION;
570 * Do we have permission?
572 if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
574 WARN("access denied\n");
575 return STG_E_ACCESSDENIED;
578 if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
582 * This will happen if we're creating a stream
584 if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
586 if (libNewSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
588 This->smallBlockChain = SmallBlockChainStream_Construct(
589 This->parentStorage->ancestorStorage,
590 This->ownerProperty);
594 This->bigBlockChain = BlockChainStream_Construct(
595 This->parentStorage->ancestorStorage,
597 This->ownerProperty);
602 * Read this stream's property to see if it's small blocks or big blocks
604 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
608 * Determine if we have to switch from small to big blocks or vice versa
610 if ( (This->smallBlockChain!=0) &&
611 (curProperty.size.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
613 if (libNewSize.u.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
616 * Transform the small block chain into a big block chain
618 This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
619 This->parentStorage->ancestorStorage,
620 &This->smallBlockChain);
624 if (This->smallBlockChain!=0)
626 Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
630 Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
634 * Write the new information about this stream to the property
636 Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
640 curProperty.size.u.HighPart = libNewSize.u.HighPart;
641 curProperty.size.u.LowPart = libNewSize.u.LowPart;
645 StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
650 This->streamSize = libNewSize;
656 * This method is part of the IStream interface.
658 * It will copy the 'cb' Bytes to 'pstm' IStream.
660 * See the documentation of IStream for more info.
662 static HRESULT WINAPI StgStreamImpl_CopyTo(
664 IStream* pstm, /* [unique][in] */
665 ULARGE_INTEGER cb, /* [in] */
666 ULARGE_INTEGER* pcbRead, /* [out] */
667 ULARGE_INTEGER* pcbWritten) /* [out] */
669 StgStreamImpl* const This=(StgStreamImpl*)iface;
672 ULONG bytesRead, bytesWritten, copySize;
673 ULARGE_INTEGER totalBytesRead;
674 ULARGE_INTEGER totalBytesWritten;
676 TRACE("(%p, %p, %d, %p, %p)\n",
677 iface, pstm, cb.u.LowPart, pcbRead, pcbWritten);
683 if (!This->parentStorage)
685 WARN("storage reverted\n");
686 return STG_E_REVERTED;
690 return STG_E_INVALIDPOINTER;
692 totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
693 totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
696 * use stack to store data temporarily
697 * there is surely a more performant way of doing it, for now this basic
698 * implementation will do the job
700 while ( cb.u.LowPart > 0 )
702 if ( cb.u.LowPart >= 128 )
705 copySize = cb.u.LowPart;
707 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
709 totalBytesRead.u.LowPart += bytesRead;
711 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
713 totalBytesWritten.u.LowPart += bytesWritten;
716 * Check that read & write operations were successful
718 if (bytesRead != bytesWritten)
720 hr = STG_E_MEDIUMFULL;
721 WARN("medium full\n");
725 if (bytesRead!=copySize)
728 cb.u.LowPart -= bytesRead;
732 * Update number of bytes read and written
736 pcbRead->u.LowPart = totalBytesRead.u.LowPart;
737 pcbRead->u.HighPart = totalBytesRead.u.HighPart;
742 pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
743 pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
749 * This method is part of the IStream interface.
751 * For streams contained in structured storages, this method
752 * does nothing. This is what the documentation tells us.
754 * See the documentation of IStream for more info.
756 static HRESULT WINAPI StgStreamImpl_Commit(
758 DWORD grfCommitFlags) /* [in] */
760 StgStreamImpl* const This=(StgStreamImpl*)iface;
762 if (!This->parentStorage)
764 WARN("storage reverted\n");
765 return STG_E_REVERTED;
772 * This method is part of the IStream interface.
774 * For streams contained in structured storages, this method
775 * does nothing. This is what the documentation tells us.
777 * See the documentation of IStream for more info.
779 static HRESULT WINAPI StgStreamImpl_Revert(
785 static HRESULT WINAPI StgStreamImpl_LockRegion(
787 ULARGE_INTEGER libOffset, /* [in] */
788 ULARGE_INTEGER cb, /* [in] */
789 DWORD dwLockType) /* [in] */
791 StgStreamImpl* const This=(StgStreamImpl*)iface;
793 if (!This->parentStorage)
795 WARN("storage reverted\n");
796 return STG_E_REVERTED;
799 FIXME("not implemented!\n");
803 static HRESULT WINAPI StgStreamImpl_UnlockRegion(
805 ULARGE_INTEGER libOffset, /* [in] */
806 ULARGE_INTEGER cb, /* [in] */
807 DWORD dwLockType) /* [in] */
809 StgStreamImpl* const This=(StgStreamImpl*)iface;
811 if (!This->parentStorage)
813 WARN("storage reverted\n");
814 return STG_E_REVERTED;
817 FIXME("not implemented!\n");
822 * This method is part of the IStream interface.
824 * This method returns information about the current
827 * See the documentation of IStream for more info.
829 static HRESULT WINAPI StgStreamImpl_Stat(
831 STATSTG* pstatstg, /* [out] */
832 DWORD grfStatFlag) /* [in] */
834 StgStreamImpl* const This=(StgStreamImpl*)iface;
836 StgProperty curProperty;
839 TRACE("%p %p %d\n", This, pstatstg, grfStatFlag);
842 * if stream has no parent, return STG_E_REVERTED
845 if (!This->parentStorage)
847 WARN("storage reverted\n");
848 return STG_E_REVERTED;
852 * Read the information from the property.
854 readSuccessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
860 StorageUtl_CopyPropertyToSTATSTG(pstatstg,
864 pstatstg->grfMode = This->grfMode;
869 WARN("failed to read properties\n");
874 * This method is part of the IStream interface.
876 * This method returns a clone of the interface that allows for
877 * another seek pointer
879 * See the documentation of IStream for more info.
881 * I am not totally sure what I am doing here but I presume that this
882 * should be basically as simple as creating a new stream with the same
883 * parent etc and positioning its seek cursor.
885 static HRESULT WINAPI StgStreamImpl_Clone(
887 IStream** ppstm) /* [out] */
889 StgStreamImpl* const This=(StgStreamImpl*)iface;
891 StgStreamImpl* new_stream;
892 LARGE_INTEGER seek_pos;
894 TRACE("%p %p\n", This, ppstm);
900 if (!This->parentStorage)
901 return STG_E_REVERTED;
904 return STG_E_INVALIDPOINTER;
906 new_stream = StgStreamImpl_Construct (This->parentStorage, This->grfMode, This->ownerProperty);
909 return STG_E_INSUFFICIENTMEMORY; /* Currently the only reason for new_stream=0 */
911 *ppstm = (IStream*) new_stream;
912 IStream_AddRef(*ppstm);
914 seek_pos.QuadPart = This->currentPosition.QuadPart;
916 hres=StgStreamImpl_Seek (*ppstm, seek_pos, STREAM_SEEK_SET, NULL);
918 assert (SUCCEEDED(hres));
924 * Virtual function table for the StgStreamImpl class.
926 static const IStreamVtbl StgStreamImpl_Vtbl =
928 StgStreamImpl_QueryInterface,
929 StgStreamImpl_AddRef,
930 StgStreamImpl_Release,
934 StgStreamImpl_SetSize,
935 StgStreamImpl_CopyTo,
936 StgStreamImpl_Commit,
937 StgStreamImpl_Revert,
938 StgStreamImpl_LockRegion,
939 StgStreamImpl_UnlockRegion,
944 /******************************************************************************
945 ** StgStreamImpl implementation
949 * This is the constructor for the StgStreamImpl class.
952 * parentStorage - Pointer to the storage that contains the stream to open
953 * ownerProperty - Index of the property that points to this stream.
955 StgStreamImpl* StgStreamImpl_Construct(
956 StorageBaseImpl* parentStorage,
960 StgStreamImpl* newStream;
962 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(StgStreamImpl));
967 * Set-up the virtual function table and reference count.
969 newStream->lpVtbl = &StgStreamImpl_Vtbl;
972 newStream->parentStorage = parentStorage;
975 * We want to nail-down the reference to the storage in case the
976 * stream out-lives the storage in the client application.
978 * -- IStorage_AddRef((IStorage*)newStream->parentStorage);
980 * No, don't do this. Some apps call IStorage_Release without
981 * calling IStream_Release first. If we grab a reference the
982 * file is not closed, and the app fails when it tries to
983 * reopen the file (Easy-PC, for example)
986 newStream->grfMode = grfMode;
987 newStream->ownerProperty = ownerProperty;
990 * Start the stream at the beginning.
992 newStream->currentPosition.u.HighPart = 0;
993 newStream->currentPosition.u.LowPart = 0;
996 * Initialize the rest of the data.
998 newStream->streamSize.u.HighPart = 0;
999 newStream->streamSize.u.LowPart = 0;
1000 newStream->bigBlockChain = 0;
1001 newStream->smallBlockChain = 0;
1004 * Read the size from the property and determine if the blocks forming
1005 * this stream are large or small.
1007 StgStreamImpl_OpenBlockChain(newStream);
1009 /* add us to the storage's list of active streams */
1010 StorageBaseImpl_AddStream(parentStorage, newStream);