Include stdio.h for MinGW.
[wine] / dlls / ole32 / stg_stream.c
1 /*
2  * Compound Storage (32 bit version)
3  * Stream implementation
4  *
5  * This file contains the implementation of the stream interface
6  * for streams contained in a compound storage.
7  *
8  * Copyright 1999 Francis Beaudet
9  * Copyright 1999 Thuy Nguyen
10  *
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.
15  *
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.
20  *
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
24  */
25
26 #include <assert.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <string.h>
31
32 #define COBJMACROS
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
35
36 #include "windef.h"
37 #include "winbase.h"
38 #include "winerror.h"
39 #include "winreg.h"
40 #include "winternl.h"
41 #include "wine/debug.h"
42
43 #include "storage32.h"
44
45 WINE_DEFAULT_DEBUG_CHANNEL(storage);
46
47
48 /*
49  * Virtual function table for the StgStreamImpl class.
50  */
51 static IStreamVtbl StgStreamImpl_Vtbl =
52 {
53     StgStreamImpl_QueryInterface,
54     StgStreamImpl_AddRef,
55     StgStreamImpl_Release,
56     StgStreamImpl_Read,
57     StgStreamImpl_Write,
58     StgStreamImpl_Seek,
59     StgStreamImpl_SetSize,
60     StgStreamImpl_CopyTo,
61     StgStreamImpl_Commit,
62     StgStreamImpl_Revert,
63     StgStreamImpl_LockRegion,
64     StgStreamImpl_UnlockRegion,
65     StgStreamImpl_Stat,
66     StgStreamImpl_Clone
67 };
68
69 /******************************************************************************
70 ** StgStreamImpl implementation
71 */
72
73 /***
74  * This is the constructor for the StgStreamImpl class.
75  *
76  * Params:
77  *    parentStorage - Pointer to the storage that contains the stream to open
78  *    ownerProperty - Index of the property that points to this stream.
79  */
80 StgStreamImpl* StgStreamImpl_Construct(
81                 StorageBaseImpl* parentStorage,
82     DWORD            grfMode,
83     ULONG            ownerProperty)
84 {
85   StgStreamImpl* newStream;
86
87   newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(StgStreamImpl));
88
89   if (newStream!=0)
90   {
91     /*
92      * Set-up the virtual function table and reference count.
93      */
94     newStream->lpVtbl    = &StgStreamImpl_Vtbl;
95     newStream->ref       = 0;
96
97     /*
98      * We want to nail-down the reference to the storage in case the
99      * stream out-lives the storage in the client application.
100      */
101     newStream->parentStorage = parentStorage;
102     IStorage_AddRef((IStorage*)newStream->parentStorage);
103
104     newStream->grfMode = grfMode;
105     newStream->ownerProperty = ownerProperty;
106
107     /*
108      * Start the stream at the beginning.
109      */
110     newStream->currentPosition.u.HighPart = 0;
111     newStream->currentPosition.u.LowPart = 0;
112
113     /*
114      * Initialize the rest of the data.
115      */
116     newStream->streamSize.u.HighPart = 0;
117     newStream->streamSize.u.LowPart  = 0;
118     newStream->bigBlockChain       = 0;
119     newStream->smallBlockChain     = 0;
120
121     /*
122      * Read the size from the property and determine if the blocks forming
123      * this stream are large or small.
124      */
125     StgStreamImpl_OpenBlockChain(newStream);
126   }
127
128   return newStream;
129 }
130
131 /***
132  * This is the destructor of the StgStreamImpl class.
133  *
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
136  * be valid anymore.
137  */
138 void StgStreamImpl_Destroy(StgStreamImpl* This)
139 {
140   TRACE("(%p)\n", This);
141
142   /*
143    * Release the reference we are holding on the parent storage.
144    */
145   IStorage_Release((IStorage*)This->parentStorage);
146   This->parentStorage = 0;
147
148   /*
149    * Make sure we clean-up the block chain stream objects that we were using.
150    */
151   if (This->bigBlockChain != 0)
152   {
153     BlockChainStream_Destroy(This->bigBlockChain);
154     This->bigBlockChain = 0;
155   }
156
157   if (This->smallBlockChain != 0)
158   {
159     SmallBlockChainStream_Destroy(This->smallBlockChain);
160     This->smallBlockChain = 0;
161   }
162
163   /*
164    * Finally, free the memory used-up by the class.
165    */
166   HeapFree(GetProcessHeap(), 0, This);
167 }
168
169 /***
170  * This implements the IUnknown method QueryInterface for this
171  * class
172  */
173 HRESULT WINAPI StgStreamImpl_QueryInterface(
174                   IStream*     iface,
175                   REFIID         riid,        /* [in] */
176                   void**         ppvObject)   /* [iid_is][out] */
177 {
178   StgStreamImpl* const This=(StgStreamImpl*)iface;
179
180   /*
181    * Perform a sanity check on the parameters.
182    */
183   if (ppvObject==0)
184     return E_INVALIDARG;
185
186   /*
187    * Initialize the return parameter.
188    */
189   *ppvObject = 0;
190
191   /*
192    * Compare the riid with the interface IDs implemented by this object.
193    */
194   if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
195   {
196     *ppvObject = (IStream*)This;
197   }
198   else if (memcmp(&IID_IStream, riid, sizeof(IID_IStream)) == 0)
199   {
200     *ppvObject = (IStream*)This;
201   }
202
203   /*
204    * Check that we obtained an interface.
205    */
206   if ((*ppvObject)==0)
207     return E_NOINTERFACE;
208
209   /*
210    * Query Interface always increases the reference count by one when it is
211    * successful
212    */
213   StgStreamImpl_AddRef(iface);
214
215   return S_OK;
216 }
217
218 /***
219  * This implements the IUnknown method AddRef for this
220  * class
221  */
222 ULONG WINAPI StgStreamImpl_AddRef(
223                 IStream* iface)
224 {
225   StgStreamImpl* const This=(StgStreamImpl*)iface;
226   return InterlockedIncrement(&This->ref);
227 }
228
229 /***
230  * This implements the IUnknown method Release for this
231  * class
232  */
233 ULONG WINAPI StgStreamImpl_Release(
234                 IStream* iface)
235 {
236   StgStreamImpl* const This=(StgStreamImpl*)iface;
237
238   ULONG ref;
239
240   ref = InterlockedDecrement(&This->ref);
241
242   /*
243    * If the reference count goes down to 0, perform suicide.
244    */
245   if (ref==0)
246   {
247     StgStreamImpl_Destroy(This);
248   }
249
250   return ref;
251 }
252
253 /***
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.
257  */
258 void StgStreamImpl_OpenBlockChain(
259         StgStreamImpl* This)
260 {
261   StgProperty    curProperty;
262   BOOL         readSucessful;
263
264   /*
265    * Make sure no old object is left over.
266    */
267   if (This->smallBlockChain != 0)
268   {
269     SmallBlockChainStream_Destroy(This->smallBlockChain);
270     This->smallBlockChain = 0;
271   }
272
273   if (This->bigBlockChain != 0)
274   {
275     BlockChainStream_Destroy(This->bigBlockChain);
276     This->bigBlockChain = 0;
277   }
278
279   /*
280    * Read the information from the property.
281    */
282   readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
283                                              This->ownerProperty,
284                                              &curProperty);
285
286   if (readSucessful)
287   {
288     This->streamSize = curProperty.size;
289
290     /*
291      * This code supports only streams that are <32 bits in size.
292      */
293     assert(This->streamSize.u.HighPart == 0);
294
295     if(curProperty.startingBlock == BLOCK_END_OF_CHAIN)
296     {
297       assert( (This->streamSize.u.HighPart == 0) && (This->streamSize.u.LowPart == 0) );
298     }
299     else
300     {
301       if ( (This->streamSize.u.HighPart == 0) &&
302            (This->streamSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
303       {
304         This->smallBlockChain = SmallBlockChainStream_Construct(
305                                                                 This->parentStorage->ancestorStorage,
306                                                                 This->ownerProperty);
307       }
308       else
309       {
310         This->bigBlockChain = BlockChainStream_Construct(
311                                                          This->parentStorage->ancestorStorage,
312                                                          NULL,
313                                                          This->ownerProperty);
314       }
315     }
316   }
317 }
318
319 /***
320  * This method is part of the ISequentialStream interface.
321  *
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
324  * read block
325  *
326  * See the documentation of ISequentialStream for more info.
327  */
328 HRESULT WINAPI StgStreamImpl_Read(
329                   IStream*     iface,
330                   void*          pv,        /* [length_is][size_is][out] */
331                   ULONG          cb,        /* [in] */
332                   ULONG*         pcbRead)   /* [out] */
333 {
334   StgStreamImpl* const This=(StgStreamImpl*)iface;
335
336   ULONG bytesReadBuffer;
337   ULONG bytesToReadFromBuffer;
338   HRESULT res = S_FALSE;
339
340   TRACE("(%p, %p, %ld, %p)\n",
341         iface, pv, cb, pcbRead);
342
343   /*
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.
346    */
347   if (pcbRead==0)
348     pcbRead = &bytesReadBuffer;
349
350   /*
351    * Using the known size of the stream, calculate the number of bytes
352    * to read from the block chain
353    */
354   bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
355
356   /*
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.
359    */
360   if (This->smallBlockChain!=0)
361   {
362     SmallBlockChainStream_ReadAt(This->smallBlockChain,
363                                  This->currentPosition,
364                                  bytesToReadFromBuffer,
365                                  pv,
366                                  pcbRead);
367
368   }
369   else if (This->bigBlockChain!=0)
370   {
371     BlockChainStream_ReadAt(This->bigBlockChain,
372                             This->currentPosition,
373                             bytesToReadFromBuffer,
374                             pv,
375                             pcbRead);
376   }
377   else
378   {
379     /*
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.
382      */
383
384     *pcbRead = 0;
385     res = S_OK;
386     goto end;
387   }
388
389   /*
390    * We should always be able to read the proper amount of data from the
391    * chain.
392    */
393   assert(bytesToReadFromBuffer == *pcbRead);
394
395   /*
396    * Advance the pointer for the number of positions read.
397    */
398   This->currentPosition.u.LowPart += *pcbRead;
399
400   if(*pcbRead != cb)
401   {
402     WARN("read %ld instead of the required %ld bytes !\n", *pcbRead, cb);
403     /*
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.
408      */
409     res = S_OK;
410   }
411   else
412     res = S_OK;
413
414 end:
415   TRACE("<-- %08lx\n", res);
416   return res;
417 }
418
419 /***
420  * This method is part of the ISequentialStream interface.
421  *
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.
426  *
427  * See the documentation of ISequentialStream for more info.
428  */
429 HRESULT WINAPI StgStreamImpl_Write(
430                   IStream*     iface,
431                   const void*    pv,          /* [size_is][in] */
432                   ULONG          cb,          /* [in] */
433                   ULONG*         pcbWritten)  /* [out] */
434 {
435   StgStreamImpl* const This=(StgStreamImpl*)iface;
436
437   ULARGE_INTEGER newSize;
438   ULONG bytesWritten = 0;
439
440   TRACE("(%p, %p, %ld, %p)\n",
441         iface, pv, cb, pcbWritten);
442
443   /*
444    * Do we have permission to write to this stream?
445    */
446   if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE))) {
447       return STG_E_ACCESSDENIED;
448   }
449
450   /*
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.
453    */
454   if (pcbWritten == 0)
455     pcbWritten = &bytesWritten;
456
457   /*
458    * Initialize the out parameter
459    */
460   *pcbWritten = 0;
461
462   if (cb == 0)
463   {
464     return S_OK;
465   }
466   else
467   {
468     newSize.u.HighPart = 0;
469     newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
470   }
471
472   /*
473    * Verify if we need to grow the stream
474    */
475   if (newSize.u.LowPart > This->streamSize.u.LowPart)
476   {
477     /* grow stream */
478     IStream_SetSize(iface, newSize);
479   }
480
481   /*
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.
484    */
485   if (This->smallBlockChain!=0)
486   {
487     SmallBlockChainStream_WriteAt(This->smallBlockChain,
488                                   This->currentPosition,
489                                   cb,
490                                   pv,
491                                   pcbWritten);
492
493   }
494   else if (This->bigBlockChain!=0)
495   {
496     BlockChainStream_WriteAt(This->bigBlockChain,
497                              This->currentPosition,
498                              cb,
499                              pv,
500                              pcbWritten);
501   }
502   else
503     assert(FALSE);
504
505   /*
506    * Advance the position pointer for the number of positions written.
507    */
508   This->currentPosition.u.LowPart += *pcbWritten;
509
510   return S_OK;
511 }
512
513 /***
514  * This method is part of the IStream interface.
515  *
516  * It will move the current stream pointer according to the parameters
517  * given.
518  *
519  * See the documentation of IStream for more info.
520  */
521 HRESULT WINAPI StgStreamImpl_Seek(
522                   IStream*      iface,
523                   LARGE_INTEGER   dlibMove,         /* [in] */
524                   DWORD           dwOrigin,         /* [in] */
525                   ULARGE_INTEGER* plibNewPosition) /* [out] */
526 {
527   StgStreamImpl* const This=(StgStreamImpl*)iface;
528
529   ULARGE_INTEGER newPosition;
530
531   TRACE("(%p, %ld, %ld, %p)\n",
532         iface, dlibMove.u.LowPart, dwOrigin, plibNewPosition);
533
534   /*
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
537    * in the code below.
538    */
539   if (plibNewPosition == 0)
540   {
541     plibNewPosition = &newPosition;
542   }
543
544   /*
545    * The file pointer is moved depending on the given "function"
546    * parameter.
547    */
548   switch (dwOrigin)
549   {
550     case STREAM_SEEK_SET:
551       plibNewPosition->u.HighPart = 0;
552       plibNewPosition->u.LowPart  = 0;
553       break;
554     case STREAM_SEEK_CUR:
555       *plibNewPosition = This->currentPosition;
556       break;
557     case STREAM_SEEK_END:
558       *plibNewPosition = This->streamSize;
559       break;
560     default:
561       return STG_E_INVALIDFUNCTION;
562   }
563
564   plibNewPosition->QuadPart = RtlLargeIntegerAdd( plibNewPosition->QuadPart, dlibMove.QuadPart );
565
566   /*
567    * tell the caller what we calculated
568    */
569   This->currentPosition = *plibNewPosition;
570
571   return S_OK;
572 }
573
574 /***
575  * This method is part of the IStream interface.
576  *
577  * It will change the size of a stream.
578  *
579  * TODO: Switch from small blocks to big blocks and vice versa.
580  *
581  * See the documentation of IStream for more info.
582  */
583 HRESULT WINAPI StgStreamImpl_SetSize(
584                                      IStream*      iface,
585                                      ULARGE_INTEGER  libNewSize)   /* [in] */
586 {
587   StgStreamImpl* const This=(StgStreamImpl*)iface;
588
589   StgProperty    curProperty;
590   BOOL         Success;
591
592   TRACE("(%p, %ld)\n", iface, libNewSize.u.LowPart);
593
594   /*
595    * As documented.
596    */
597   if (libNewSize.u.HighPart != 0)
598     return STG_E_INVALIDFUNCTION;
599
600   /*
601    * Do we have permission?
602    */
603   if (!(This->grfMode & (STGM_WRITE | STGM_READWRITE)))
604     return STG_E_ACCESSDENIED;
605
606   if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
607     return S_OK;
608
609   /*
610    * This will happen if we're creating a stream
611    */
612   if ((This->smallBlockChain == 0) && (This->bigBlockChain == 0))
613   {
614     if (libNewSize.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK)
615     {
616       This->smallBlockChain = SmallBlockChainStream_Construct(
617                                     This->parentStorage->ancestorStorage,
618                                     This->ownerProperty);
619     }
620     else
621     {
622       This->bigBlockChain = BlockChainStream_Construct(
623                                 This->parentStorage->ancestorStorage,
624                                 NULL,
625                                 This->ownerProperty);
626     }
627   }
628
629   /*
630    * Read this stream's property to see if it's small blocks or big blocks
631    */
632   Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
633                                        This->ownerProperty,
634                                        &curProperty);
635   /*
636    * Determine if we have to switch from small to big blocks or vice versa
637    */
638   if ( (This->smallBlockChain!=0) &&
639        (curProperty.size.u.LowPart < LIMIT_TO_USE_SMALL_BLOCK) )
640   {
641     if (libNewSize.u.LowPart >= LIMIT_TO_USE_SMALL_BLOCK)
642     {
643       /*
644        * Transform the small block chain into a big block chain
645        */
646       This->bigBlockChain = Storage32Impl_SmallBlocksToBigBlocks(
647                                 This->parentStorage->ancestorStorage,
648                                 &This->smallBlockChain);
649     }
650   }
651
652   if (This->smallBlockChain!=0)
653   {
654     Success = SmallBlockChainStream_SetSize(This->smallBlockChain, libNewSize);
655   }
656   else
657   {
658     Success = BlockChainStream_SetSize(This->bigBlockChain, libNewSize);
659   }
660
661   /*
662    * Write the new information about this stream to the property
663    */
664   Success = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
665                                        This->ownerProperty,
666                                        &curProperty);
667
668   curProperty.size.u.HighPart = libNewSize.u.HighPart;
669   curProperty.size.u.LowPart = libNewSize.u.LowPart;
670
671   if (Success)
672   {
673     StorageImpl_WriteProperty(This->parentStorage->ancestorStorage,
674                                 This->ownerProperty,
675                                 &curProperty);
676   }
677
678   This->streamSize = libNewSize;
679
680   return S_OK;
681 }
682
683 /***
684  * This method is part of the IStream interface.
685  *
686  * It will copy the 'cb' Bytes to 'pstm' IStream.
687  *
688  * See the documentation of IStream for more info.
689  */
690 HRESULT WINAPI StgStreamImpl_CopyTo(
691                                     IStream*      iface,
692                                     IStream*      pstm,         /* [unique][in] */
693                                     ULARGE_INTEGER  cb,           /* [in] */
694                                     ULARGE_INTEGER* pcbRead,      /* [out] */
695                                     ULARGE_INTEGER* pcbWritten)   /* [out] */
696 {
697   HRESULT        hr = S_OK;
698   BYTE           tmpBuffer[128];
699   ULONG          bytesRead, bytesWritten, copySize;
700   ULARGE_INTEGER totalBytesRead;
701   ULARGE_INTEGER totalBytesWritten;
702
703   TRACE("(%p, %p, %ld, %p, %p)\n",
704         iface, pstm, cb.u.LowPart, pcbRead, pcbWritten);
705
706   /*
707    * Sanity check
708    */
709   if ( pstm == 0 )
710     return STG_E_INVALIDPOINTER;
711
712   totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
713   totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
714
715   /*
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
719    */
720   while ( cb.u.LowPart > 0 )
721   {
722     if ( cb.u.LowPart >= 128 )
723       copySize = 128;
724     else
725       copySize = cb.u.LowPart;
726
727     IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
728
729     totalBytesRead.u.LowPart += bytesRead;
730
731     IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
732
733     totalBytesWritten.u.LowPart += bytesWritten;
734
735     /*
736      * Check that read & write operations were successful
737      */
738     if (bytesRead != bytesWritten)
739     {
740       hr = STG_E_MEDIUMFULL;
741       break;
742     }
743
744     if (bytesRead!=copySize)
745       cb.u.LowPart = 0;
746     else
747       cb.u.LowPart -= bytesRead;
748   }
749
750   /*
751    * Update number of bytes read and written
752    */
753   if (pcbRead)
754   {
755     pcbRead->u.LowPart = totalBytesRead.u.LowPart;
756     pcbRead->u.HighPart = totalBytesRead.u.HighPart;
757   }
758
759   if (pcbWritten)
760   {
761     pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
762     pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
763   }
764   return hr;
765 }
766
767 /***
768  * This method is part of the IStream interface.
769  *
770  * For streams contained in structured storages, this method
771  * does nothing. This is what the documentation tells us.
772  *
773  * See the documentation of IStream for more info.
774  */
775 HRESULT WINAPI StgStreamImpl_Commit(
776                   IStream*      iface,
777                   DWORD           grfCommitFlags)  /* [in] */
778 {
779   return S_OK;
780 }
781
782 /***
783  * This method is part of the IStream interface.
784  *
785  * For streams contained in structured storages, this method
786  * does nothing. This is what the documentation tells us.
787  *
788  * See the documentation of IStream for more info.
789  */
790 HRESULT WINAPI StgStreamImpl_Revert(
791                   IStream* iface)
792 {
793   return S_OK;
794 }
795
796 HRESULT WINAPI StgStreamImpl_LockRegion(
797                                         IStream*     iface,
798                                         ULARGE_INTEGER libOffset,   /* [in] */
799                                         ULARGE_INTEGER cb,          /* [in] */
800                                         DWORD          dwLockType)  /* [in] */
801 {
802   FIXME("not implemented!\n");
803   return E_NOTIMPL;
804 }
805
806 HRESULT WINAPI StgStreamImpl_UnlockRegion(
807                                           IStream*     iface,
808                                           ULARGE_INTEGER libOffset,   /* [in] */
809                                           ULARGE_INTEGER cb,          /* [in] */
810                                           DWORD          dwLockType)  /* [in] */
811 {
812   FIXME("not implemented!\n");
813   return E_NOTIMPL;
814 }
815
816 /***
817  * This method is part of the IStream interface.
818  *
819  * This method returns information about the current
820  * stream.
821  *
822  * See the documentation of IStream for more info.
823  */
824 HRESULT WINAPI StgStreamImpl_Stat(
825                   IStream*     iface,
826                   STATSTG*       pstatstg,     /* [out] */
827                   DWORD          grfStatFlag)  /* [in] */
828 {
829   StgStreamImpl* const This=(StgStreamImpl*)iface;
830
831   StgProperty    curProperty;
832   BOOL         readSucessful;
833
834   /*
835    * Read the information from the property.
836    */
837   readSucessful = StorageImpl_ReadProperty(This->parentStorage->ancestorStorage,
838                                              This->ownerProperty,
839                                              &curProperty);
840
841   if (readSucessful)
842   {
843     StorageUtl_CopyPropertyToSTATSTG(pstatstg,
844                                      &curProperty,
845                                      grfStatFlag);
846
847     pstatstg->grfMode = This->grfMode;
848
849     return S_OK;
850   }
851
852   return E_FAIL;
853 }
854
855 /***
856  * This method is part of the IStream interface.
857  *
858  * This method returns a clone of the interface that allows for
859  * another seek pointer
860  *
861  * See the documentation of IStream for more info.
862  *
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.
866  */
867 HRESULT WINAPI StgStreamImpl_Clone(
868                                    IStream*     iface,
869                                    IStream**    ppstm) /* [out] */
870 {
871   StgStreamImpl* const This=(StgStreamImpl*)iface;
872   HRESULT hres;
873   StgStreamImpl* new_stream;
874   LARGE_INTEGER seek_pos;
875
876   /*
877    * Sanity check
878    */
879   if ( ppstm == 0 )
880     return STG_E_INVALIDPOINTER;
881
882   new_stream = StgStreamImpl_Construct (This->parentStorage, This->grfMode, This->ownerProperty);
883
884   if (!new_stream)
885     return STG_E_INSUFFICIENTMEMORY; /* Currently the only reason for new_stream=0 */
886
887   *ppstm = (IStream*) new_stream;
888   seek_pos.QuadPart = This->currentPosition.QuadPart;
889
890   hres=StgStreamImpl_Seek (*ppstm, seek_pos, STREAM_SEEK_SET, NULL);
891
892   assert (SUCCEEDED(hres));
893
894   return S_OK;
895 }