user/tests: Fix a compiler warning, and remove some useless casts.
[wine/testsucceed.git] / dlls / ole32 / hglobalstream.c
blobeb2af3024fb729a2188e0c8512177e320b202e4a
1 /*
2 * HGLOBAL Stream implementation
4 * This file contains the implementation of the stream interface
5 * for streams contained supported by an HGLOBAL pointer.
7 * Copyright 1999 Francis Beaudet
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #include "config.h"
26 #include <assert.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #include <string.h>
32 #define COBJMACROS
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
36 #include "windef.h"
37 #include "winbase.h"
38 #include "winuser.h"
39 #include "objbase.h"
40 #include "ole2.h"
41 #include "winerror.h"
42 #include "winreg.h"
43 #include "winternl.h"
45 #include "wine/debug.h"
47 WINE_DEFAULT_DEBUG_CHANNEL(storage);
49 /****************************************************************************
50 * HGLOBALStreamImpl definition.
52 * This class imlements the IStream inteface and represents a stream
53 * supported by an HGLOBAL pointer.
55 struct HGLOBALStreamImpl
57 const IStreamVtbl *lpVtbl; /* Needs to be the first item in the struct
58 * since we want to cast this in an IStream pointer */
61 * Reference count
63 LONG ref;
66 * Support for the stream
68 HGLOBAL supportHandle;
71 * This flag is TRUE if the HGLOBAL is destroyed when the stream
72 * is finally released.
74 BOOL deleteOnRelease;
77 * Helper variable that contains the size of the stream
79 ULARGE_INTEGER streamSize;
82 * This is the current position of the cursor in the stream
84 ULARGE_INTEGER currentPosition;
87 typedef struct HGLOBALStreamImpl HGLOBALStreamImpl;
89 /***
90 * This is the destructor of the HGLOBALStreamImpl class.
92 * This method will clean-up all the resources used-up by the given HGLOBALStreamImpl
93 * class. The pointer passed-in to this function will be freed and will not
94 * be valid anymore.
96 static void HGLOBALStreamImpl_Destroy(HGLOBALStreamImpl* This)
98 TRACE("(%p)\n", This);
101 * Release the HGlobal if the constructor asked for that.
103 if (This->deleteOnRelease)
105 GlobalFree(This->supportHandle);
106 This->supportHandle=0;
110 * Finally, free the memory used-up by the class.
112 HeapFree(GetProcessHeap(), 0, This);
115 /***
116 * This implements the IUnknown method AddRef for this
117 * class
119 static ULONG WINAPI HGLOBALStreamImpl_AddRef(
120 IStream* iface)
122 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
123 return InterlockedIncrement(&This->ref);
126 /***
127 * This implements the IUnknown method QueryInterface for this
128 * class
130 static HRESULT WINAPI HGLOBALStreamImpl_QueryInterface(
131 IStream* iface,
132 REFIID riid, /* [in] */
133 void** ppvObject) /* [iid_is][out] */
135 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
138 * Perform a sanity check on the parameters.
140 if (ppvObject==0)
141 return E_INVALIDARG;
144 * Initialize the return parameter.
146 *ppvObject = 0;
149 * Compare the riid with the interface IDs implemented by this object.
151 if (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0)
153 *ppvObject = (IStream*)This;
155 else if (memcmp(&IID_IStream, riid, sizeof(IID_IStream)) == 0)
157 *ppvObject = (IStream*)This;
161 * Check that we obtained an interface.
163 if ((*ppvObject)==0)
164 return E_NOINTERFACE;
167 * Query Interface always increases the reference count by one when it is
168 * successful
170 HGLOBALStreamImpl_AddRef(iface);
172 return S_OK;
175 /***
176 * This implements the IUnknown method Release for this
177 * class
179 static ULONG WINAPI HGLOBALStreamImpl_Release(
180 IStream* iface)
182 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
183 ULONG newRef;
185 newRef = InterlockedDecrement(&This->ref);
188 * If the reference count goes down to 0, perform suicide.
190 if (newRef==0)
192 HGLOBALStreamImpl_Destroy(This);
195 return newRef;
198 /***
199 * This method is part of the ISequentialStream interface.
201 * If reads a block of information from the stream at the current
202 * position. It then moves the current position at the end of the
203 * read block
205 * See the documentation of ISequentialStream for more info.
207 static HRESULT WINAPI HGLOBALStreamImpl_Read(
208 IStream* iface,
209 void* pv, /* [length_is][size_is][out] */
210 ULONG cb, /* [in] */
211 ULONG* pcbRead) /* [out] */
213 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
215 void* supportBuffer;
216 ULONG bytesReadBuffer;
217 ULONG bytesToReadFromBuffer;
219 TRACE("(%p, %p, %ld, %p)\n", iface,
220 pv, cb, pcbRead);
223 * If the caller is not interested in the nubmer of bytes read,
224 * we use another buffer to avoid "if" statements in the code.
226 if (pcbRead==0)
227 pcbRead = &bytesReadBuffer;
230 * Using the known size of the stream, calculate the number of bytes
231 * to read from the block chain
233 bytesToReadFromBuffer = min( This->streamSize.u.LowPart - This->currentPosition.u.LowPart, cb);
236 * Lock the buffer in position and copy the data.
238 supportBuffer = GlobalLock(This->supportHandle);
240 memcpy(pv, (char *) supportBuffer+This->currentPosition.u.LowPart, bytesToReadFromBuffer);
243 * Move the current position to the new position
245 This->currentPosition.u.LowPart+=bytesToReadFromBuffer;
248 * Return the number of bytes read.
250 *pcbRead = bytesToReadFromBuffer;
253 * Cleanup
255 GlobalUnlock(This->supportHandle);
258 * The function returns S_OK if the buffer was filled completely
259 * it returns S_FALSE if the end of the stream is reached before the
260 * buffer is filled
262 if(*pcbRead == cb)
263 return S_OK;
265 return S_FALSE;
268 /***
269 * This method is part of the ISequentialStream interface.
271 * It writes a block of information to the stream at the current
272 * position. It then moves the current position at the end of the
273 * written block. If the stream is too small to fit the block,
274 * the stream is grown to fit.
276 * See the documentation of ISequentialStream for more info.
278 static HRESULT WINAPI HGLOBALStreamImpl_Write(
279 IStream* iface,
280 const void* pv, /* [size_is][in] */
281 ULONG cb, /* [in] */
282 ULONG* pcbWritten) /* [out] */
284 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
286 void* supportBuffer;
287 ULARGE_INTEGER newSize;
288 ULONG bytesWritten = 0;
290 TRACE("(%p, %p, %ld, %p)\n", iface, pv, cb, pcbWritten);
293 * If the caller is not interested in the number of bytes written,
294 * we use another buffer to avoid "if" statements in the code.
296 if (pcbWritten == 0)
297 pcbWritten = &bytesWritten;
299 if (cb == 0)
300 goto out;
302 newSize.u.HighPart = 0;
303 newSize.u.LowPart = This->currentPosition.u.LowPart + cb;
306 * Verify if we need to grow the stream
308 if (newSize.u.LowPart > This->streamSize.u.LowPart)
310 /* grow stream */
311 HRESULT hr = IStream_SetSize(iface, newSize);
312 if (FAILED(hr))
314 ERR("IStream_SetSize failed with error 0x%08lx\n", hr);
315 return hr;
320 * Lock the buffer in position and copy the data.
322 supportBuffer = GlobalLock(This->supportHandle);
324 memcpy((char *) supportBuffer+This->currentPosition.u.LowPart, pv, cb);
327 * Move the current position to the new position
329 This->currentPosition.u.LowPart+=cb;
332 * Cleanup
334 GlobalUnlock(This->supportHandle);
336 out:
338 * Return the number of bytes read.
340 *pcbWritten = cb;
342 return S_OK;
345 /***
346 * This method is part of the IStream interface.
348 * It will move the current stream pointer according to the parameters
349 * given.
351 * See the documentation of IStream for more info.
353 static HRESULT WINAPI HGLOBALStreamImpl_Seek(
354 IStream* iface,
355 LARGE_INTEGER dlibMove, /* [in] */
356 DWORD dwOrigin, /* [in] */
357 ULARGE_INTEGER* plibNewPosition) /* [out] */
359 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
361 ULARGE_INTEGER newPosition;
363 TRACE("(%p, %lx%08lx, %ld, %p)\n", iface, dlibMove.u.HighPart,
364 dlibMove.u.LowPart, dwOrigin, plibNewPosition);
367 * The file pointer is moved depending on the given "function"
368 * parameter.
370 switch (dwOrigin)
372 case STREAM_SEEK_SET:
373 newPosition.u.HighPart = 0;
374 newPosition.u.LowPart = 0;
375 break;
376 case STREAM_SEEK_CUR:
377 newPosition = This->currentPosition;
378 break;
379 case STREAM_SEEK_END:
380 newPosition = This->streamSize;
381 break;
382 default:
383 return STG_E_INVALIDFUNCTION;
387 * Move the actual file pointer
388 * If the file pointer ends-up after the end of the stream, the next Write operation will
389 * make the file larger. This is how it is documented.
391 if (dlibMove.QuadPart < 0 && newPosition.QuadPart < -dlibMove.QuadPart) return STG_E_INVALIDFUNCTION;
393 newPosition.QuadPart = RtlLargeIntegerAdd(newPosition.QuadPart, dlibMove.QuadPart);
395 if (plibNewPosition) *plibNewPosition = newPosition;
396 This->currentPosition = newPosition;
398 return S_OK;
401 /***
402 * This method is part of the IStream interface.
404 * It will change the size of a stream.
406 * TODO: Switch from small blocks to big blocks and vice versa.
408 * See the documentation of IStream for more info.
410 static HRESULT WINAPI HGLOBALStreamImpl_SetSize(
411 IStream* iface,
412 ULARGE_INTEGER libNewSize) /* [in] */
414 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
415 HGLOBAL supportHandle;
417 TRACE("(%p, %ld)\n", iface, libNewSize.u.LowPart);
420 * As documented.
422 if (libNewSize.u.HighPart != 0)
423 return STG_E_INVALIDFUNCTION;
425 if (This->streamSize.u.LowPart == libNewSize.u.LowPart)
426 return S_OK;
429 * Re allocate the HGlobal to fit the new size of the stream.
431 supportHandle = GlobalReAlloc(This->supportHandle, libNewSize.u.LowPart, 0);
433 if (supportHandle == 0)
434 return STG_E_MEDIUMFULL;
436 This->supportHandle = supportHandle;
437 This->streamSize.u.LowPart = libNewSize.u.LowPart;
439 return S_OK;
442 /***
443 * This method is part of the IStream interface.
445 * It will copy the 'cb' Bytes to 'pstm' IStream.
447 * See the documentation of IStream for more info.
449 static HRESULT WINAPI HGLOBALStreamImpl_CopyTo(
450 IStream* iface,
451 IStream* pstm, /* [unique][in] */
452 ULARGE_INTEGER cb, /* [in] */
453 ULARGE_INTEGER* pcbRead, /* [out] */
454 ULARGE_INTEGER* pcbWritten) /* [out] */
456 HRESULT hr = S_OK;
457 BYTE tmpBuffer[128];
458 ULONG bytesRead, bytesWritten, copySize;
459 ULARGE_INTEGER totalBytesRead;
460 ULARGE_INTEGER totalBytesWritten;
462 TRACE("(%p, %p, %ld, %p, %p)\n", iface, pstm,
463 cb.u.LowPart, pcbRead, pcbWritten);
466 * Sanity check
468 if ( pstm == 0 )
469 return STG_E_INVALIDPOINTER;
471 totalBytesRead.u.LowPart = totalBytesRead.u.HighPart = 0;
472 totalBytesWritten.u.LowPart = totalBytesWritten.u.HighPart = 0;
475 * use stack to store data temporarly
476 * there is surely more performant way of doing it, for now this basic
477 * implementation will do the job
479 while ( cb.u.LowPart > 0 )
481 if ( cb.u.LowPart >= 128 )
482 copySize = 128;
483 else
484 copySize = cb.u.LowPart;
486 IStream_Read(iface, tmpBuffer, copySize, &bytesRead);
488 totalBytesRead.u.LowPart += bytesRead;
490 IStream_Write(pstm, tmpBuffer, bytesRead, &bytesWritten);
492 totalBytesWritten.u.LowPart += bytesWritten;
495 * Check that read & write operations were succesfull
497 if (bytesRead != bytesWritten)
499 hr = STG_E_MEDIUMFULL;
500 break;
503 if (bytesRead!=copySize)
504 cb.u.LowPart = 0;
505 else
506 cb.u.LowPart -= bytesRead;
510 * Update number of bytes read and written
512 if (pcbRead)
514 pcbRead->u.LowPart = totalBytesRead.u.LowPart;
515 pcbRead->u.HighPart = totalBytesRead.u.HighPart;
518 if (pcbWritten)
520 pcbWritten->u.LowPart = totalBytesWritten.u.LowPart;
521 pcbWritten->u.HighPart = totalBytesWritten.u.HighPart;
523 return hr;
526 /***
527 * This method is part of the IStream interface.
529 * For streams supported by HGLOBALS, this function does nothing.
530 * This is what the documentation tells us.
532 * See the documentation of IStream for more info.
534 static HRESULT WINAPI HGLOBALStreamImpl_Commit(
535 IStream* iface,
536 DWORD grfCommitFlags) /* [in] */
538 return S_OK;
541 /***
542 * This method is part of the IStream interface.
544 * For streams supported by HGLOBALS, this function does nothing.
545 * This is what the documentation tells us.
547 * See the documentation of IStream for more info.
549 static HRESULT WINAPI HGLOBALStreamImpl_Revert(
550 IStream* iface)
552 return S_OK;
555 /***
556 * This method is part of the IStream interface.
558 * For streams supported by HGLOBALS, this function does nothing.
559 * This is what the documentation tells us.
561 * See the documentation of IStream for more info.
563 static HRESULT WINAPI HGLOBALStreamImpl_LockRegion(
564 IStream* iface,
565 ULARGE_INTEGER libOffset, /* [in] */
566 ULARGE_INTEGER cb, /* [in] */
567 DWORD dwLockType) /* [in] */
569 return S_OK;
573 * This method is part of the IStream interface.
575 * For streams supported by HGLOBALS, this function does nothing.
576 * This is what the documentation tells us.
578 * See the documentation of IStream for more info.
580 static HRESULT WINAPI HGLOBALStreamImpl_UnlockRegion(
581 IStream* iface,
582 ULARGE_INTEGER libOffset, /* [in] */
583 ULARGE_INTEGER cb, /* [in] */
584 DWORD dwLockType) /* [in] */
586 return S_OK;
589 /***
590 * This method is part of the IStream interface.
592 * This method returns information about the current
593 * stream.
595 * See the documentation of IStream for more info.
597 static HRESULT WINAPI HGLOBALStreamImpl_Stat(
598 IStream* iface,
599 STATSTG* pstatstg, /* [out] */
600 DWORD grfStatFlag) /* [in] */
602 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
604 memset(pstatstg, 0, sizeof(STATSTG));
606 pstatstg->pwcsName = NULL;
607 pstatstg->type = STGTY_STREAM;
608 pstatstg->cbSize = This->streamSize;
610 return S_OK;
613 static HRESULT WINAPI HGLOBALStreamImpl_Clone(
614 IStream* iface,
615 IStream** ppstm) /* [out] */
617 ULARGE_INTEGER dummy;
618 LARGE_INTEGER offset;
619 HRESULT hr;
620 HGLOBALStreamImpl* const This=(HGLOBALStreamImpl*)iface;
621 TRACE(" Cloning %p (deleteOnRelease=%d seek position=%ld)\n",iface,This->deleteOnRelease,(long)This->currentPosition.QuadPart);
622 hr=CreateStreamOnHGlobal(This->supportHandle, FALSE, ppstm);
623 if(FAILED(hr))
624 return hr;
625 offset.QuadPart=(LONGLONG)This->currentPosition.QuadPart;
626 HGLOBALStreamImpl_Seek(*ppstm,offset,STREAM_SEEK_SET,&dummy);
627 return S_OK;
631 * Virtual function table for the HGLOBALStreamImpl class.
633 static const IStreamVtbl HGLOBALStreamImpl_Vtbl =
635 HGLOBALStreamImpl_QueryInterface,
636 HGLOBALStreamImpl_AddRef,
637 HGLOBALStreamImpl_Release,
638 HGLOBALStreamImpl_Read,
639 HGLOBALStreamImpl_Write,
640 HGLOBALStreamImpl_Seek,
641 HGLOBALStreamImpl_SetSize,
642 HGLOBALStreamImpl_CopyTo,
643 HGLOBALStreamImpl_Commit,
644 HGLOBALStreamImpl_Revert,
645 HGLOBALStreamImpl_LockRegion,
646 HGLOBALStreamImpl_UnlockRegion,
647 HGLOBALStreamImpl_Stat,
648 HGLOBALStreamImpl_Clone
651 /******************************************************************************
652 ** HGLOBALStreamImpl implementation
655 /***
656 * This is the constructor for the HGLOBALStreamImpl class.
658 * Params:
659 * hGlobal - Handle that will support the stream. can be NULL.
660 * fDeleteOnRelease - Flag set to TRUE if the HGLOBAL will be released
661 * when the IStream object is destroyed.
663 HGLOBALStreamImpl* HGLOBALStreamImpl_Construct(
664 HGLOBAL hGlobal,
665 BOOL fDeleteOnRelease)
667 HGLOBALStreamImpl* newStream;
669 newStream = HeapAlloc(GetProcessHeap(), 0, sizeof(HGLOBALStreamImpl));
671 if (newStream!=0)
674 * Set-up the virtual function table and reference count.
676 newStream->lpVtbl = &HGLOBALStreamImpl_Vtbl;
677 newStream->ref = 0;
680 * Initialize the support.
682 newStream->supportHandle = hGlobal;
683 newStream->deleteOnRelease = fDeleteOnRelease;
686 * This method will allocate a handle if one is not supplied.
688 if (!newStream->supportHandle)
690 newStream->supportHandle = GlobalAlloc(GMEM_MOVEABLE | GMEM_NODISCARD |
691 GMEM_SHARE, 0);
695 * Start the stream at the beginning.
697 newStream->currentPosition.u.HighPart = 0;
698 newStream->currentPosition.u.LowPart = 0;
701 * Initialize the size of the stream to the size of the handle.
703 newStream->streamSize.u.HighPart = 0;
704 newStream->streamSize.u.LowPart = GlobalSize(newStream->supportHandle);
707 return newStream;
711 /***********************************************************************
712 * CreateStreamOnHGlobal [OLE32.@]
714 HRESULT WINAPI CreateStreamOnHGlobal(
715 HGLOBAL hGlobal,
716 BOOL fDeleteOnRelease,
717 LPSTREAM* ppstm)
719 HGLOBALStreamImpl* newStream;
721 newStream = HGLOBALStreamImpl_Construct(hGlobal,
722 fDeleteOnRelease);
724 if (newStream!=NULL)
726 return IUnknown_QueryInterface((IUnknown*)newStream,
727 &IID_IStream,
728 (void**)ppstm);
731 return E_OUTOFMEMORY;
734 /***********************************************************************
735 * GetHGlobalFromStream [OLE32.@]
737 HRESULT WINAPI GetHGlobalFromStream(IStream* pstm, HGLOBAL* phglobal)
739 HGLOBALStreamImpl* pStream;
741 if (pstm == NULL)
742 return E_INVALIDARG;
744 pStream = (HGLOBALStreamImpl*) pstm;
747 * Verify that the stream object was created with CreateStreamOnHGlobal.
749 if (pStream->lpVtbl == &HGLOBALStreamImpl_Vtbl)
750 *phglobal = pStream->supportHandle;
751 else
753 *phglobal = 0;
754 return E_INVALIDARG;
757 return S_OK;