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 * If the caller is not interested in the number of bytes written,
452 * we use another buffer to avoid "if" statements in the code.
455 pcbWritten
= &bytesWritten
;
458 * Initialize the out parameter
468 newSize
.u
.HighPart
= 0;
469 newSize
.u
.LowPart
= This
->currentPosition
.u
.LowPart
+ cb
;
473 * Verify if we need to grow the stream
475 if (newSize
.u
.LowPart
> This
->streamSize
.u
.LowPart
)
478 IStream_SetSize(iface
, newSize
);
482 * Depending on the type of chain that was opened when the stream was constructed,
483 * we delegate the work to the method that readwrites to the block chains.
485 if (This
->smallBlockChain
!=0)
487 SmallBlockChainStream_WriteAt(This
->smallBlockChain
,
488 This
->currentPosition
,
494 else if (This
->bigBlockChain
!=0)
496 BlockChainStream_WriteAt(This
->bigBlockChain
,
497 This
->currentPosition
,
506 * Advance the position pointer for the number of positions written.
508 This
->currentPosition
.u
.LowPart
+= *pcbWritten
;
514 * This method is part of the IStream interface.
516 * It will move the current stream pointer according to the parameters
519 * See the documentation of IStream for more info.
521 HRESULT WINAPI
StgStreamImpl_Seek(
523 LARGE_INTEGER dlibMove
, /* [in] */
524 DWORD dwOrigin
, /* [in] */
525 ULARGE_INTEGER
* plibNewPosition
) /* [out] */
527 StgStreamImpl
* const This
=(StgStreamImpl
*)iface
;
529 ULARGE_INTEGER newPosition
;
531 TRACE("(%p, %ld, %ld, %p)\n",
532 iface
, dlibMove
.u
.LowPart
, dwOrigin
, plibNewPosition
);
535 * The caller is allowed to pass in NULL as the new position return value.
536 * If it happens, we assign it to a dynamic variable to avoid special cases
539 if (plibNewPosition
== 0)
541 plibNewPosition
= &newPosition
;
545 * The file pointer is moved depending on the given "function"
550 case STREAM_SEEK_SET
:
551 plibNewPosition
->u
.HighPart
= 0;
552 plibNewPosition
->u
.LowPart
= 0;
554 case STREAM_SEEK_CUR
:
555 *plibNewPosition
= This
->currentPosition
;
557 case STREAM_SEEK_END
:
558 *plibNewPosition
= This
->streamSize
;
561 return STG_E_INVALIDFUNCTION
;
564 plibNewPosition
->QuadPart
= RtlLargeIntegerAdd( plibNewPosition
->QuadPart
, dlibMove
.QuadPart
);
567 * tell the caller what we calculated
569 This
->currentPosition
= *plibNewPosition
;
575 * This method is part of the IStream interface.
577 * It will change the size of a stream.
579 * TODO: Switch from small blocks to big blocks and vice versa.
581 * See the documentation of IStream for more info.
583 HRESULT WINAPI
StgStreamImpl_SetSize(
585 ULARGE_INTEGER libNewSize
) /* [in] */
587 StgStreamImpl
* const This
=(StgStreamImpl
*)iface
;
589 StgProperty curProperty
;
592 TRACE("(%p, %ld)\n", iface
, libNewSize
.u
.LowPart
);
597 if (libNewSize
.u
.HighPart
!= 0)
598 return STG_E_INVALIDFUNCTION
;
601 * Do we have permission?
603 if (!(This
->grfMode
& (STGM_WRITE
| STGM_READWRITE
)))
604 return STG_E_ACCESSDENIED
;
606 if (This
->streamSize
.u
.LowPart
== libNewSize
.u
.LowPart
)
610 * This will happen if we're creating a stream
612 if ((This
->smallBlockChain
== 0) && (This
->bigBlockChain
== 0))
614 if (libNewSize
.u
.LowPart
< LIMIT_TO_USE_SMALL_BLOCK
)
616 This
->smallBlockChain
= SmallBlockChainStream_Construct(
617 This
->parentStorage
->ancestorStorage
,
618 This
->ownerProperty
);
622 This
->bigBlockChain
= BlockChainStream_Construct(
623 This
->parentStorage
->ancestorStorage
,
625 This
->ownerProperty
);
630 * Read this stream's property to see if it's small blocks or big blocks
632 Success
= StorageImpl_ReadProperty(This
->parentStorage
->ancestorStorage
,
636 * Determine if we have to switch from small to big blocks or vice versa
638 if ( (This
->smallBlockChain
!=0) &&
639 (curProperty
.size
.u
.LowPart
< LIMIT_TO_USE_SMALL_BLOCK
) )
641 if (libNewSize
.u
.LowPart
>= LIMIT_TO_USE_SMALL_BLOCK
)
644 * Transform the small block chain into a big block chain
646 This
->bigBlockChain
= Storage32Impl_SmallBlocksToBigBlocks(
647 This
->parentStorage
->ancestorStorage
,
648 &This
->smallBlockChain
);
652 if (This
->smallBlockChain
!=0)
654 Success
= SmallBlockChainStream_SetSize(This
->smallBlockChain
, libNewSize
);
658 Success
= BlockChainStream_SetSize(This
->bigBlockChain
, libNewSize
);
662 * Write the new information about this stream to the property
664 Success
= StorageImpl_ReadProperty(This
->parentStorage
->ancestorStorage
,
668 curProperty
.size
.u
.HighPart
= libNewSize
.u
.HighPart
;
669 curProperty
.size
.u
.LowPart
= libNewSize
.u
.LowPart
;
673 StorageImpl_WriteProperty(This
->parentStorage
->ancestorStorage
,
678 This
->streamSize
= libNewSize
;
684 * This method is part of the IStream interface.
686 * It will copy the 'cb' Bytes to 'pstm' IStream.
688 * See the documentation of IStream for more info.
690 HRESULT WINAPI
StgStreamImpl_CopyTo(
692 IStream
* pstm
, /* [unique][in] */
693 ULARGE_INTEGER cb
, /* [in] */
694 ULARGE_INTEGER
* pcbRead
, /* [out] */
695 ULARGE_INTEGER
* pcbWritten
) /* [out] */
699 ULONG bytesRead
, bytesWritten
, copySize
;
700 ULARGE_INTEGER totalBytesRead
;
701 ULARGE_INTEGER totalBytesWritten
;
703 TRACE("(%p, %p, %ld, %p, %p)\n",
704 iface
, pstm
, cb
.u
.LowPart
, pcbRead
, pcbWritten
);
710 return STG_E_INVALIDPOINTER
;
712 totalBytesRead
.u
.LowPart
= totalBytesRead
.u
.HighPart
= 0;
713 totalBytesWritten
.u
.LowPart
= totalBytesWritten
.u
.HighPart
= 0;
716 * use stack to store data temporarily
717 * there is surely a more performant way of doing it, for now this basic
718 * implementation will do the job
720 while ( cb
.u
.LowPart
> 0 )
722 if ( cb
.u
.LowPart
>= 128 )
725 copySize
= cb
.u
.LowPart
;
727 IStream_Read(iface
, tmpBuffer
, copySize
, &bytesRead
);
729 totalBytesRead
.u
.LowPart
+= bytesRead
;
731 IStream_Write(pstm
, tmpBuffer
, bytesRead
, &bytesWritten
);
733 totalBytesWritten
.u
.LowPart
+= bytesWritten
;
736 * Check that read & write operations were successful
738 if (bytesRead
!= bytesWritten
)
740 hr
= STG_E_MEDIUMFULL
;
744 if (bytesRead
!=copySize
)
747 cb
.u
.LowPart
-= bytesRead
;
751 * Update number of bytes read and written
755 pcbRead
->u
.LowPart
= totalBytesRead
.u
.LowPart
;
756 pcbRead
->u
.HighPart
= totalBytesRead
.u
.HighPart
;
761 pcbWritten
->u
.LowPart
= totalBytesWritten
.u
.LowPart
;
762 pcbWritten
->u
.HighPart
= totalBytesWritten
.u
.HighPart
;
768 * This method is part of the IStream interface.
770 * For streams contained in structured storages, this method
771 * does nothing. This is what the documentation tells us.
773 * See the documentation of IStream for more info.
775 HRESULT WINAPI
StgStreamImpl_Commit(
777 DWORD grfCommitFlags
) /* [in] */
783 * This method is part of the IStream interface.
785 * For streams contained in structured storages, this method
786 * does nothing. This is what the documentation tells us.
788 * See the documentation of IStream for more info.
790 HRESULT WINAPI
StgStreamImpl_Revert(
796 HRESULT WINAPI
StgStreamImpl_LockRegion(
798 ULARGE_INTEGER libOffset
, /* [in] */
799 ULARGE_INTEGER cb
, /* [in] */
800 DWORD dwLockType
) /* [in] */
802 FIXME("not implemented!\n");
806 HRESULT WINAPI
StgStreamImpl_UnlockRegion(
808 ULARGE_INTEGER libOffset
, /* [in] */
809 ULARGE_INTEGER cb
, /* [in] */
810 DWORD dwLockType
) /* [in] */
812 FIXME("not implemented!\n");
817 * This method is part of the IStream interface.
819 * This method returns information about the current
822 * See the documentation of IStream for more info.
824 HRESULT WINAPI
StgStreamImpl_Stat(
826 STATSTG
* pstatstg
, /* [out] */
827 DWORD grfStatFlag
) /* [in] */
829 StgStreamImpl
* const This
=(StgStreamImpl
*)iface
;
831 StgProperty curProperty
;
835 * Read the information from the property.
837 readSucessful
= StorageImpl_ReadProperty(This
->parentStorage
->ancestorStorage
,
843 StorageUtl_CopyPropertyToSTATSTG(pstatstg
,
847 pstatstg
->grfMode
= This
->grfMode
;
856 * This method is part of the IStream interface.
858 * This method returns a clone of the interface that allows for
859 * another seek pointer
861 * See the documentation of IStream for more info.
863 * I am not totally sure what I am doing here but I presume that this
864 * should be basically as simple as creating a new stream with the same
865 * parent etc and positioning its seek cursor.
867 HRESULT WINAPI
StgStreamImpl_Clone(
869 IStream
** ppstm
) /* [out] */
871 StgStreamImpl
* const This
=(StgStreamImpl
*)iface
;
873 StgStreamImpl
* new_stream
;
874 LARGE_INTEGER seek_pos
;
880 return STG_E_INVALIDPOINTER
;
882 new_stream
= StgStreamImpl_Construct (This
->parentStorage
, This
->grfMode
, This
->ownerProperty
);
885 return STG_E_INSUFFICIENTMEMORY
; /* Currently the only reason for new_stream=0 */
887 *ppstm
= (IStream
*) new_stream
;
888 seek_pos
.QuadPart
= This
->currentPosition
.QuadPart
;
890 hres
=StgStreamImpl_Seek (*ppstm
, seek_pos
, STREAM_SEEK_SET
, NULL
);
892 assert (SUCCEEDED(hres
));