istream.c File Reference

#include <stdarg.h>
#include <string.h>
#include "windef.h"
#include "winbase.h"
#include "winerror.h"
#include "winnls.h"
#include "shlwapi.h"
#include "wine/debug.h"

Include dependency graph for istream.c:

Go to the source code of this file.

Classes
struct	ISHFileStream

Macros
#define	COBJMACROS
#define	NONAMELESSUNION
#define	NO_SHLWAPI_REG
#define	NO_SHLWAPI_PATH
#define	STGM_ACCESS_MODE(stgm)   ((stgm)&0x0000f)
#define	STGM_SHARE_MODE(stgm)   ((stgm)&0x000f0)
#define	STGM_CREATE_MODE(stgm)   ((stgm)&0x0f000)

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (shell)
static ISHFileStream *	impl_from_IStream (IStream *iface)
static HRESULT WINAPI	IStream_fnCommit (IStream *, DWORD)
static HRESULT WINAPI	IStream_fnQueryInterface (IStream *iface, REFIID riid, LPVOID *ppvObj)
static ULONG WINAPI	IStream_fnAddRef (IStream *iface)
static ULONG WINAPI	IStream_fnRelease (IStream *iface)
static HRESULT WINAPI	IStream_fnRead (IStream *iface, void *pv, ULONG cb, ULONG *pcbRead)
static HRESULT WINAPI	IStream_fnWrite (IStream *iface, const void *pv, ULONG cb, ULONG *pcbWritten)
static HRESULT WINAPI	IStream_fnSeek (IStream *iface, LARGE_INTEGER dlibMove, DWORD dwOrigin, ULARGE_INTEGER *pNewPos)
static HRESULT WINAPI	IStream_fnSetSize (IStream *iface, ULARGE_INTEGER libNewSize)
static HRESULT WINAPI	IStream_fnCopyTo (IStream *iface, IStream *pstm, ULARGE_INTEGER cb, ULARGE_INTEGER *pcbRead, ULARGE_INTEGER *pcbWritten)
static HRESULT WINAPI	IStream_fnRevert (IStream *iface)
static HRESULT WINAPI	IStream_fnLockUnlockRegion (IStream *iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType)
static HRESULT WINAPI	IStream_fnStat (IStream *iface, STATSTG *lpStat, DWORD grfStatFlag)
static HRESULT WINAPI	IStream_fnClone (IStream *iface, IStream **ppstm)
static IStream *	IStream_Create (LPCWSTR lpszPath, HANDLE hFile, DWORD dwMode)
HRESULT WINAPI	SHCreateStreamOnFileEx (LPCWSTR lpszPath, DWORD dwMode, DWORD dwAttributes, BOOL bCreate, IStream *lpTemplate, IStream **lppStream)
HRESULT WINAPI	SHCreateStreamOnFileW (LPCWSTR lpszPath, DWORD dwMode, IStream **lppStream)
HRESULT WINAPI	SHCreateStreamOnFileA (LPCSTR lpszPath, DWORD dwMode, IStream **lppStream)
HRESULT WINAPI	SHIStream_Read (IStream *lpStream, LPVOID lpvDest, ULONG ulSize)
BOOL WINAPI	SHIsEmptyStream (IStream *lpStream)
HRESULT WINAPI	SHIStream_Write (IStream *lpStream, LPCVOID lpvSrc, ULONG ulSize)
HRESULT WINAPI	IStream_Reset (IStream *lpStream)
HRESULT WINAPI	IStream_Size (IStream *lpStream, ULARGE_INTEGER *lpulSize)

Variables
static const IStreamVtbl	SHLWAPI_fsVTable

Macro Definition Documentation

COBJMACROS

#define COBJMACROS

Definition at line 23 of file istream.c.

NO_SHLWAPI_PATH

#define NO_SHLWAPI_PATH

Definition at line 31 of file istream.c.

NO_SHLWAPI_REG

#define NO_SHLWAPI_REG

Definition at line 30 of file istream.c.

NONAMELESSUNION

#define NONAMELESSUNION

Definition at line 24 of file istream.c.

STGM_ACCESS_MODE

#define STGM_ACCESS_MODE

(

stgm

)

((stgm)&0x0000f)

Definition at line 37 of file istream.c.

STGM_CREATE_MODE

#define STGM_CREATE_MODE

(

stgm

)

((stgm)&0x0f000)

Definition at line 39 of file istream.c.

STGM_SHARE_MODE

#define STGM_SHARE_MODE

(

stgm

)

((stgm)&0x000f0)

Definition at line 38 of file istream.c.

Function Documentation

impl_from_IStream()

static ISHFileStream * impl_from_IStream ( IStream *  iface )

inlinestatic

Definition at line 53 of file istream.c.

{
  return CONTAINING_RECORD(iface, ISHFileStream, IStream_iface);
}

Referenced by IStream_fnAddRef(), IStream_fnClone(), IStream_fnCommit(), IStream_fnCopyTo(), IStream_fnLockUnlockRegion(), IStream_fnQueryInterface(), IStream_fnRead(), IStream_fnRelease(), IStream_fnRevert(), IStream_fnSeek(), IStream_fnSetSize(), IStream_fnStat(), and IStream_fnWrite().

IStream_Create()

static IStream * IStream_Create ( LPCWSTR  lpszPath, HANDLE  hFile, DWORD  dwMode  )

static

Definition at line 362 of file istream.c.

{
    ISHFileStream *fileStream;
 
    fileStream = HeapAlloc(GetProcessHeap(), 0, sizeof(ISHFileStream));
    if (!fileStream) return NULL;
 
    fileStream->IStream_iface.lpVtbl = &SHLWAPI_fsVTable;
    fileStream->ref = 1;
    fileStream->hFile = hFile;
    fileStream->dwMode = dwMode;
    fileStream->lpszPath = StrDupW(lpszPath);
    fileStream->type = 0; /* FIXME */
    fileStream->grfStateBits = 0; /* FIXME */
 
    TRACE ("Returning %p\n", fileStream);
    return &fileStream->IStream_iface;
}

Referenced by SHCreateStreamOnFileEx().

IStream_fnAddRef()

static ULONG WINAPI IStream_fnAddRef ( IStream *  iface )

static

Definition at line 85 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  ULONG refCount = InterlockedIncrement(&This->ref);
  
  TRACE("(%p)->(ref before=%u)\n",This, refCount - 1);
 
  return refCount;
}

IStream_fnClone()

static HRESULT WINAPI IStream_fnClone ( IStream *  iface, IStream **  ppstm  )

static

Definition at line 329 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
 
  TRACE("(%p)\n",This);
  if (ppstm)
    *ppstm = NULL;
  return E_NOTIMPL;
}

IStream_fnCommit()

static HRESULT WINAPI IStream_fnCommit ( IStream *  iface, DWORD  grfCommitFlags  )

static

Definition at line 259 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
 
  TRACE("(%p,%d)\n", This, grfCommitFlags);
  /* Currently unbuffered: This function is not needed */
  return S_OK;
}

Referenced by IStream_fnCopyTo(), IStream_fnRelease(), IStream_fnSeek(), and IStream_fnSetSize().

IStream_fnCopyTo()

static HRESULT WINAPI IStream_fnCopyTo ( IStream *  iface, IStream *  pstm, ULARGE_INTEGER  cb, ULARGE_INTEGER *  pcbRead, ULARGE_INTEGER *  pcbWritten  )

static

Definition at line 209 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  char copyBuff[1024];
  ULONGLONG ulSize;
  HRESULT hRet = S_OK;
 
  TRACE("(%p,%p,%d,%p,%p)\n", This, pstm, cb.u.LowPart, pcbRead, pcbWritten);
 
  if (pcbRead)
    pcbRead->QuadPart = 0;
  if (pcbWritten)
    pcbWritten->QuadPart = 0;
 
  if (!pstm)
    return S_OK;
 
  IStream_fnCommit(iface, 0); /* If ever buffered, this will be needed */
 
  /* Copy data */
  ulSize = cb.QuadPart;
  while (ulSize)
  {
    ULONG ulLeft, ulRead, ulWritten;
 
    ulLeft = ulSize > sizeof(copyBuff) ? sizeof(copyBuff) : ulSize;
 
    /* Read */
    hRet = IStream_fnRead(iface, copyBuff, ulLeft, &ulRead);
    if (FAILED(hRet) || ulRead == 0)
      break;
    if (pcbRead)
      pcbRead->QuadPart += ulRead;
 
    /* Write */
    hRet = IStream_fnWrite(pstm, copyBuff, ulRead, &ulWritten);
    if (pcbWritten)
      pcbWritten->QuadPart += ulWritten;
    if (FAILED(hRet) || ulWritten != ulLeft)
      break;
 
    ulSize -= ulLeft;
  }
  return hRet;
}

IStream_fnLockUnlockRegion()

static HRESULT WINAPI IStream_fnLockUnlockRegion ( IStream *  iface, ULARGE_INTEGER  libOffset, ULARGE_INTEGER  cb, DWORD  dwLockType  )

static

Definition at line 282 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  TRACE("(%p,%d,%d,%d)\n", This, libOffset.u.LowPart, cb.u.LowPart, dwLockType);
  return E_NOTIMPL;
}

IStream_fnQueryInterface()

static HRESULT WINAPI IStream_fnQueryInterface ( IStream *  iface, REFIID  riid, LPVOID *  ppvObj  )

static

Definition at line 64 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
 
  TRACE("(%p,%s,%p)\n", This, debugstr_guid(riid), ppvObj);
 
  *ppvObj = NULL;
 
  if(IsEqualIID(riid, &IID_IUnknown) ||
     IsEqualIID(riid, &IID_IStream))
  {
    IStream_AddRef(iface);
    *ppvObj = iface;
    return S_OK;
  }
  return E_NOINTERFACE;
}

IStream_fnRead()

static HRESULT WINAPI IStream_fnRead ( IStream *  iface, void *  pv, ULONG  cb, ULONG *  pcbRead  )

static

Definition at line 119 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  DWORD dwRead = 0;
 
  TRACE("(%p,%p,0x%08x,%p)\n", This, pv, cb, pcbRead);
 
  if (!ReadFile(This->hFile, pv, cb, &dwRead, NULL))
  {
    WARN("error %d reading file\n", GetLastError());
    return S_FALSE;
  }
  if (pcbRead)
    *pcbRead = dwRead;
  return dwRead == cb ? S_OK : S_FALSE;
}

Referenced by IStream_fnCopyTo().

IStream_fnRelease()

static ULONG WINAPI IStream_fnRelease ( IStream *  iface )

static

Definition at line 98 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  ULONG refCount = InterlockedDecrement(&This->ref); 
 
  TRACE("(%p)->(ref before=%u)\n",This, refCount + 1);
  
  if (!refCount)
  {
    IStream_fnCommit(iface, 0); /* If ever buffered, this will be needed */
    LocalFree(This->lpszPath);
    CloseHandle(This->hFile);
    HeapFree(GetProcessHeap(), 0, This);
  }
  
  return refCount;
}

IStream_fnRevert()

static HRESULT WINAPI IStream_fnRevert ( IStream *  iface )

static

Definition at line 271 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
 
  TRACE("(%p)\n", This);
  return E_NOTIMPL;
}

IStream_fnSeek()

static HRESULT WINAPI IStream_fnSeek ( IStream *  iface, LARGE_INTEGER  dlibMove, DWORD  dwOrigin, ULARGE_INTEGER *  pNewPos  )

static

Definition at line 166 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  DWORD dwPos;
 
  TRACE("(%p,%d,%d,%p)\n", This, dlibMove.u.LowPart, dwOrigin, pNewPos);
 
  IStream_fnCommit(iface, 0); /* If ever buffered, this will be needed */
  dwPos = SetFilePointer(This->hFile, dlibMove.u.LowPart, NULL, dwOrigin);
  if( dwPos == INVALID_SET_FILE_POINTER )
     return HRESULT_FROM_WIN32(GetLastError());
 
  if (pNewPos)
  {
    pNewPos->u.HighPart = 0;
    pNewPos->u.LowPart = dwPos;
  }
  return S_OK;
}

IStream_fnSetSize()

static HRESULT WINAPI IStream_fnSetSize ( IStream *  iface, ULARGE_INTEGER  libNewSize  )

static

Definition at line 190 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
 
  TRACE("(%p,%d)\n", This, libNewSize.u.LowPart);
 
  IStream_fnCommit(iface, 0); /* If ever buffered, this will be needed */
  if( ! SetFilePointer( This->hFile, libNewSize.QuadPart, NULL, FILE_BEGIN ) )
    return E_FAIL;
 
  if( ! SetEndOfFile( This->hFile ) )
    return E_FAIL;
 
  return S_OK;
}

IStream_fnStat()

static HRESULT WINAPI IStream_fnStat ( IStream *  iface, STATSTG *  lpStat, DWORD  grfStatFlag  )

static

Definition at line 293 of file istream.c.

{
    ISHFileStream *This = impl_from_IStream(iface);
    BY_HANDLE_FILE_INFORMATION fi;
 
    TRACE("(%p,%p,%d)\n", This, lpStat, grfStatFlag);
 
    if (!lpStat)
        return STG_E_INVALIDPOINTER;
 
    memset(&fi, 0, sizeof(fi));
    GetFileInformationByHandle(This->hFile, &fi);
 
    if (grfStatFlag & STATFLAG_NONAME)
      lpStat->pwcsName = NULL;
    else
      lpStat->pwcsName = StrDupW(This->lpszPath);
    lpStat->type = This->type;
    lpStat->cbSize.u.LowPart = fi.nFileSizeLow;
    lpStat->cbSize.u.HighPart = fi.nFileSizeHigh;
    lpStat->mtime = fi.ftLastWriteTime;
    lpStat->ctime = fi.ftCreationTime;
    lpStat->atime = fi.ftLastAccessTime;
    lpStat->grfMode = This->dwMode;
    lpStat->grfLocksSupported = 0;
    memcpy(&lpStat->clsid, &IID_IStream, sizeof(CLSID));
    lpStat->grfStateBits = This->grfStateBits;
    lpStat->reserved = 0;
 
    return S_OK;
}

IStream_fnWrite()

static HRESULT WINAPI IStream_fnWrite ( IStream *  iface, const void *  pv, ULONG  cb, ULONG *  pcbWritten  )

static

Definition at line 139 of file istream.c.

{
  ISHFileStream *This = impl_from_IStream(iface);
  DWORD dwWritten = 0;
 
  TRACE("(%p,%p,0x%08x,%p)\n", This, pv, cb, pcbWritten);
 
  switch (STGM_ACCESS_MODE(This->dwMode))
  {
  case STGM_WRITE:
  case STGM_READWRITE:
    break;
  default:
    return STG_E_ACCESSDENIED;
  }
 
  if (!WriteFile(This->hFile, pv, cb, &dwWritten, NULL))
    return HRESULT_FROM_WIN32(GetLastError());
 
  if (pcbWritten)
    *pcbWritten = dwWritten;
  return S_OK;
}

Referenced by IStream_fnCopyTo().

IStream_Reset()

HRESULT WINAPI IStream_Reset

(

IStream *

lpStream

)

Definition at line 640 of file istream.c.

{
  LARGE_INTEGER zero;
  TRACE("(%p)\n", lpStream);
  zero.QuadPart = 0;
  return IStream_Seek(lpStream, zero, 0, NULL);
}

IStream_Size()

HRESULT WINAPI IStream_Size	(	IStream *	lpStream,
		ULARGE_INTEGER *	lpulSize
	)

Definition at line 661 of file istream.c.

{
  STATSTG statstg;
  HRESULT hRet;
 
  TRACE("(%p,%p)\n", lpStream, lpulSize);
 
  memset(&statstg, 0, sizeof(statstg));
 
  hRet = IStream_Stat(lpStream, &statstg, 1);
 
  if (SUCCEEDED(hRet) && lpulSize)
    *lpulSize = statstg.cbSize;
  return hRet;
}

Referenced by CDesktopUpgradePropertyBag::_GetOldDesktopViewStream(), CRegPropertyBag::_GetStreamSize(), and CDesktopUpgradePropertyBag::_NewStreamFromOld().

SHCreateStreamOnFileA()

HRESULT WINAPI SHCreateStreamOnFileA	(	LPCSTR	lpszPath,
		DWORD	dwMode,
		IStream **	lppStream
	)

Definition at line 512 of file istream.c.

{
  WCHAR szPath[MAX_PATH];
 
  TRACE("(%s,%d,%p)\n", debugstr_a(lpszPath), dwMode, lppStream);
 
  if (!lpszPath)
    return HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND);
 
  MultiByteToWideChar(CP_ACP, 0, lpszPath, -1, szPath, MAX_PATH);
  return SHCreateStreamOnFileW(szPath, dwMode, lppStream);
}

Referenced by test_SHCreateStreamOnFileA().

SHCreateStreamOnFileEx()

HRESULT WINAPI SHCreateStreamOnFileEx	(	LPCWSTR	lpszPath,
		DWORD	dwMode,
		DWORD	dwAttributes,
		BOOL	bCreate,
		IStream *	lpTemplate,
		IStream **	lppStream
	)

Definition at line 401 of file istream.c.

{
  DWORD dwAccess, dwShare, dwCreate;
  HANDLE hFile;
 
  TRACE("(%s,%d,0x%08X,%d,%p,%p)\n", debugstr_w(lpszPath), dwMode,
        dwAttributes, bCreate, lpTemplate, lppStream);
 
  if (!lpszPath || !lppStream || lpTemplate)
    return E_INVALIDARG;
 
  *lppStream = NULL;
 
  /* Access */
  switch (STGM_ACCESS_MODE(dwMode))
  {
  case STGM_WRITE:
  case STGM_READWRITE:
    dwAccess = GENERIC_READ|GENERIC_WRITE;
    break;
  case STGM_READ:
    dwAccess = GENERIC_READ;
    break;
  default:
    return E_INVALIDARG;
  }
 
  /* Sharing */
  switch (STGM_SHARE_MODE(dwMode))
  {
  case 0:
  case STGM_SHARE_DENY_NONE:
    dwShare = FILE_SHARE_READ|FILE_SHARE_WRITE;
    break;
  case STGM_SHARE_DENY_READ:
    dwShare = FILE_SHARE_WRITE;
    break;
  case STGM_SHARE_DENY_WRITE:
    dwShare = FILE_SHARE_READ;
    break;
  case STGM_SHARE_EXCLUSIVE:
    dwShare = 0;
    break;
  default:
    return E_INVALIDARG;
  }
 
  switch(STGM_CREATE_MODE(dwMode))
  {
  case STGM_FAILIFTHERE:
    dwCreate = bCreate ? CREATE_NEW : OPEN_EXISTING;
    break;
  case STGM_CREATE:
    dwCreate = CREATE_ALWAYS;
    break;
  default:
    return E_INVALIDARG;
  }
 
  /* Open HANDLE to file */
  hFile = CreateFileW(lpszPath, dwAccess, dwShare, NULL, dwCreate,
                      dwAttributes, 0);
 
  if(hFile == INVALID_HANDLE_VALUE)
    return HRESULT_FROM_WIN32(GetLastError());
 
  *lppStream = IStream_Create(lpszPath, hFile, dwMode);
 
  if(!*lppStream)
  {
    CloseHandle(hFile);
    return E_OUTOFMEMORY;
  }
  return S_OK;
}

Referenced by DoLoadPicture(), OpenStreamOnFile(), SHCreateStreamOnFileW(), test_SHCreateStreamOnFileEx(), and test_SHCreateStreamOnFileEx_CopyTo().

SHCreateStreamOnFileW()

HRESULT WINAPI SHCreateStreamOnFileW	(	LPCWSTR	lpszPath,
		DWORD	dwMode,
		IStream **	lppStream
	)

Definition at line 484 of file istream.c.

{
  TRACE("(%s,%d,%p)\n", debugstr_w(lpszPath), dwMode, lppStream);
 
  if (!lpszPath || !lppStream)
    return E_INVALIDARG;
 
  if ((dwMode & (STGM_CONVERT|STGM_DELETEONRELEASE|STGM_TRANSACTED)) != 0)
    return E_INVALIDARG;
 
  return SHCreateStreamOnFileEx(lpszPath, dwMode, 0, FALSE, NULL, lppStream);
}

Referenced by dump_stream_to_file(), GdipCreateStreamOnFile(), IWICStreamImpl_InitializeFromFilename(), CShellLink::Load(), parse_config_file(), CShellLink::Save(), SHCreateStreamOnFileA(), and test_SHCreateStreamOnFileW().

SHIsEmptyStream()

BOOL WINAPI SHIsEmptyStream

(

IStream *

lpStream

)

Definition at line 567 of file istream.c.

{
  STATSTG statstg;
  BOOL bRet = TRUE;
 
  TRACE("(%p)\n", lpStream);
 
  memset(&statstg, 0, sizeof(statstg));
 
  if(SUCCEEDED(IStream_Stat(lpStream, &statstg, 1)))
  {
    if(statstg.cbSize.QuadPart)
      bRet = FALSE; /* Non-Zero */
  }
  else
  {
    DWORD dwDummy;
 
    /* Try to read from the stream */
    if(SUCCEEDED(SHIStream_Read(lpStream, &dwDummy, sizeof(dwDummy))))
    {
      LARGE_INTEGER zero;
      zero.QuadPart = 0;
 
      IStream_Seek(lpStream, zero, 0, NULL);
      bRet = FALSE; /* Non-Zero */
    }
  }
  return bRet;
}

SHIStream_Read()

HRESULT WINAPI SHIStream_Read	(	IStream *	lpStream,
		LPVOID	lpvDest,
		ULONG	ulSize
	)

Definition at line 541 of file istream.c.

{
  ULONG ulRead;
  HRESULT hRet;
 
  TRACE("(%p,%p,%d)\n", lpStream, lpvDest, ulSize);
 
  hRet = IStream_Read(lpStream, lpvDest, ulSize, &ulRead);
 
  if (SUCCEEDED(hRet) && ulRead != ulSize)
    hRet = E_FAIL;
  return hRet;
}

Referenced by SHIsEmptyStream().

SHIStream_Write()

HRESULT WINAPI SHIStream_Write	(	IStream *	lpStream,
		LPCVOID	lpvSrc,
		ULONG	ulSize
	)

Definition at line 613 of file istream.c.

{
  ULONG ulWritten;
  HRESULT hRet;
 
  TRACE("(%p,%p,%d)\n", lpStream, lpvSrc, ulSize);
 
  hRet = IStream_Write(lpStream, lpvSrc, ulSize, &ulWritten);
 
  if (SUCCEEDED(hRet) && ulWritten != ulSize)
    hRet = E_FAIL;
 
  return hRet;
}

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

shell

)

Variable Documentation

SHLWAPI_fsVTable

const IStreamVtbl SHLWAPI_fsVTable

static

Initial value:

=
{
  IStream_fnQueryInterface,
  IStream_fnAddRef,
  IStream_fnRelease,
  IStream_fnRead,
  IStream_fnWrite,
  IStream_fnSeek,
  IStream_fnSetSize,
  IStream_fnCopyTo,
  IStream_fnCommit,
  IStream_fnRevert,
  IStream_fnLockUnlockRegion,
  IStream_fnLockUnlockRegion,
  IStream_fnStat,
  IStream_fnClone
}

Definition at line 339 of file istream.c.

Referenced by IStream_Create().