Sweden-Number/dlls/oleaut32/safearray.c

1202 lines
35 KiB
C
Raw Normal View History

/*************************************************************************
* OLE Automation
* SafeArray Implementation
*
* This file contains the implementation of the SafeArray interface.
*
* Copyright 1999 Sylvain St-Germain
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include <stdio.h>
1999-03-25 16:52:09 +01:00
#include <string.h>
1999-03-14 17:35:05 +01:00
#include "windef.h"
1999-02-28 20:14:33 +01:00
#include "winerror.h"
#include "winbase.h"
#include "oleauto.h"
#include "wine/debug.h"
WINE_DEFAULT_DEBUG_CHANNEL(ole);
#define SYSDUPSTRING(str) SysAllocStringLen((str), SysStringLen(str))
2002-01-29 03:44:44 +01:00
/* Locally used methods */
2002-06-01 01:06:46 +02:00
static INT
endOfDim(LONG *coor, SAFEARRAYBOUND *mat, LONG dim, LONG realDim);
2002-06-01 01:06:46 +02:00
static ULONG
calcDisplacement(LONG *coor, SAFEARRAYBOUND *mat, LONG dim);
2002-06-01 01:06:46 +02:00
static BOOL
isPointer(USHORT feature);
2002-06-01 01:06:46 +02:00
static INT
getFeatures(VARTYPE vt);
2002-06-01 01:06:46 +02:00
static BOOL
validCoordinate(LONG *coor, SAFEARRAY *psa);
2002-06-01 01:06:46 +02:00
static BOOL
resizeSafeArray(SAFEARRAY *psa, LONG lDelta);
2002-06-01 01:06:46 +02:00
static BOOL
validArg(SAFEARRAY *psa);
2002-06-01 01:06:46 +02:00
static ULONG
getArraySize(SAFEARRAY *psa);
2002-06-01 01:06:46 +02:00
static HRESULT
duplicateData(SAFEARRAY *psa, SAFEARRAY **ppsaOut);
/* Association between VARTYPE and their size.
A size of zero is defined for the unsupported types. */
#define VARTYPE_NOT_SUPPORTED 0
static const ULONG VARTYPE_SIZE[] =
{
/* this is taken from wtypes.h. Only [S]es are supported by the SafeArray */
VARTYPE_NOT_SUPPORTED, /* VT_EMPTY [V] [P] nothing */
VARTYPE_NOT_SUPPORTED, /* VT_NULL [V] [P] SQL style Nul */
2, /* VT_I2 [V][T][P][S] 2 byte signed int */
4, /* VT_I4 [V][T][P][S] 4 byte signed int */
4, /* VT_R4 [V][T][P][S] 4 byte real */
8, /* VT_R8 [V][T][P][S] 8 byte real */
8, /* VT_CY [V][T][P][S] currency */
8, /* VT_DATE [V][T][P][S] date */
sizeof(BSTR), /* VT_BSTR [V][T][P][S] OLE Automation string*/
sizeof(LPDISPATCH), /* VT_DISPATCH [V][T][P][S] IDispatch * */
4, /* VT_ERROR [V][T] [S] SCODE */
2, /* VT_BOOL [V][T][P][S] True=-1, False=0*/
sizeof(VARIANT), /* VT_VARIANT [V][T][P][S] VARIANT * */
sizeof(LPUNKNOWN), /* VT_UNKNOWN [V][T] [S] IUnknown * */
sizeof(DECIMAL), /* VT_DECIMAL [V][T] [S] 16 byte fixed point */
VARTYPE_NOT_SUPPORTED, /* no VARTYPE here..... */
1, /* VT_I1 [T] [S] signed char */
1, /* VT_UI1 [V][T][P][S] unsigned char */
2, /* VT_UI2 [T][P][S] unsigned short */
4, /* VT_UI4 [T][P][S] unsigned int */
VARTYPE_NOT_SUPPORTED, /* VT_I8 [T][P] signed 64-bit int */
VARTYPE_NOT_SUPPORTED, /* VT_UI8 [T][P] unsigned 64-bit int */
sizeof(INT), /* VT_INT [T] signed machine int */
sizeof(UINT), /* VT_UINT [T] unsigned machine int */
VARTYPE_NOT_SUPPORTED, /* VT_VOID [T] C style void */
VARTYPE_NOT_SUPPORTED, /* VT_HRESULT [T] Standard return type */
VARTYPE_NOT_SUPPORTED, /* VT_PTR [T] pointer type */
VARTYPE_NOT_SUPPORTED, /* VT_SAFEARRAY [T] (use VT_ARRAY in VARIANT)*/
VARTYPE_NOT_SUPPORTED, /* VT_CARRAY [T] C style array */
VARTYPE_NOT_SUPPORTED, /* VT_USERDEFINED [T] user defined type */
VARTYPE_NOT_SUPPORTED, /* VT_LPSTR [T][P] null terminated string */
VARTYPE_NOT_SUPPORTED, /* VT_LPWSTR [T][P] wide null term string */
VARTYPE_NOT_SUPPORTED, /* VT_FILETIME [P] FILETIME */
VARTYPE_NOT_SUPPORTED, /* VT_BLOB [P] Length prefixed bytes */
VARTYPE_NOT_SUPPORTED, /* VT_STREAM [P] Name of stream follows */
VARTYPE_NOT_SUPPORTED, /* VT_STORAGE [P] Name of storage follows */
VARTYPE_NOT_SUPPORTED, /* VT_STREAMED_OBJECT[P] Stream contains an object*/
VARTYPE_NOT_SUPPORTED, /* VT_STORED_OBJECT [P] Storage contains object*/
VARTYPE_NOT_SUPPORTED, /* VT_BLOB_OBJECT [P] Blob contains an object*/
VARTYPE_NOT_SUPPORTED, /* VT_CF [P] Clipboard format */
VARTYPE_NOT_SUPPORTED, /* VT_CLSID [P] A Class ID */
VARTYPE_NOT_SUPPORTED, /* VT_VECTOR [P] simple counted array */
VARTYPE_NOT_SUPPORTED, /* VT_ARRAY [V] SAFEARRAY* */
VARTYPE_NOT_SUPPORTED /* VT_BYREF [V] void* for local use */
};
2002-01-29 03:44:44 +01:00
static const int LAST_VARTYPE = sizeof(VARTYPE_SIZE)/sizeof(VARTYPE_SIZE[0]);
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayAllocDescriptor (OLEAUT32.36)
* Allocate the appropriate amount of memory for the SafeArray descriptor
*/
2002-06-01 01:06:46 +02:00
HRESULT WINAPI SafeArrayAllocDescriptor(
UINT cDims,
SAFEARRAY **ppsaOut)
{
SAFEARRAYBOUND *sab;
LONG allocSize = 0;
if (!cDims || cDims >= 0x10000) /* 65536 appears to be the limit */
return E_INVALIDARG;
if (!ppsaOut)
return E_POINTER;
/* SAFEARRAY + SAFEARRAYBOUND * (cDims -1) ( -1 because there is already one
( in SAFEARRAY struct */
allocSize = sizeof(**ppsaOut) + (sizeof(*sab) * (cDims-1));
/* Allocate memory for SAFEARRAY struc */
2002-06-01 01:06:46 +02:00
if(( (*ppsaOut)=HeapAlloc(
GetProcessHeap(), HEAP_ZERO_MEMORY, allocSize)) == NULL){
return(E_UNEXPECTED);
}
(*ppsaOut)->cDims = cDims;
TRACE("(%d): %lu bytes allocated for descriptor.\n", cDims, allocSize);
return(S_OK);
}
2002-01-29 03:44:44 +01:00
/*************************************************************************
* SafeArrayAllocDescriptorEx (OLEAUT32.41)
2002-01-29 03:44:44 +01:00
* Allocate the appropriate amount of memory for the SafeArray descriptor
*
* This is a minimal implementation just to get things moving.
*
* The MSDN documentation on this doesn't tell us much.
*/
2002-06-01 01:06:46 +02:00
HRESULT WINAPI SafeArrayAllocDescriptorEx(
2002-01-29 03:44:44 +01:00
VARTYPE vt,
2002-06-01 01:06:46 +02:00
UINT cDims,
SAFEARRAY **ppsaOut)
2002-01-29 03:44:44 +01:00
{
if ( (vt >= LAST_VARTYPE) ||
( VARTYPE_SIZE[vt] == VARTYPE_NOT_SUPPORTED ) )
return E_UNEXPECTED;
return SafeArrayAllocDescriptor (cDims, ppsaOut);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayAllocData (OLEAUT32.37)
* Allocate the appropriate amount of data for the SafeArray data
*/
HRESULT WINAPI SafeArrayAllocData(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa)
{
ULONG ulWholeArraySize; /* to store the size of the whole thing */
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
ulWholeArraySize = getArraySize(psa);
/* Allocate memory for the data itself */
2002-06-01 01:06:46 +02:00
if((psa->pvData = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY,
psa->cbElements*ulWholeArraySize)) == NULL)
return(E_UNEXPECTED);
2002-06-01 01:06:46 +02:00
TRACE("SafeArray: %lu bytes allocated for data at %p (%lu objects).\n",
psa->cbElements*ulWholeArraySize, psa->pvData, ulWholeArraySize);
return(S_OK);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayCreate (OLEAUT32.15)
2002-06-01 01:06:46 +02:00
* Create a SafeArray object by encapsulating AllocDescriptor and AllocData
*/
SAFEARRAY* WINAPI SafeArrayCreate(
2002-06-01 01:06:46 +02:00
VARTYPE vt,
UINT cDims,
SAFEARRAYBOUND *rgsabound)
{
SAFEARRAY *psa;
HRESULT hRes;
USHORT cDim;
/* Validate supported VARTYPE */
if ( (vt >= LAST_VARTYPE) ||
( VARTYPE_SIZE[vt] == VARTYPE_NOT_SUPPORTED ) )
return NULL;
/* Allocate memory for the array descriptor */
if( FAILED( hRes = SafeArrayAllocDescriptor(cDims, &psa)))
return NULL;
2002-06-01 01:06:46 +02:00
/* setup data members... */
psa->cDims = cDims;
psa->fFeatures = getFeatures(vt);
psa->cLocks = 0;
psa->pvData = NULL;
psa->cbElements= VARTYPE_SIZE[vt];
/* Invert the bounds ... */
for(cDim=0; cDim < psa->cDims; cDim++) {
psa->rgsabound[cDim].cElements = rgsabound[psa->cDims-cDim-1].cElements;
psa->rgsabound[cDim].lLbound = rgsabound[psa->cDims-cDim-1].lLbound;
}
2002-06-01 01:06:46 +02:00
/* allocate memory for the data... */
if( FAILED( hRes = SafeArrayAllocData(psa))) {
2002-06-01 01:06:46 +02:00
SafeArrayDestroyDescriptor(psa);
ERR("() : Failed to allocate the Safe Array data\n");
return NULL;
}
2002-06-01 01:06:46 +02:00
return(psa);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayDestroyDescriptor (OLEAUT32.38)
* Frees the memory associated with the descriptor.
*/
HRESULT WINAPI SafeArrayDestroyDescriptor(
SAFEARRAY *psa)
{
/* Check for lockness before to free... */
2002-06-01 01:06:46 +02:00
if(psa->cLocks > 0)
return DISP_E_ARRAYISLOCKED;
/* The array is unlocked, then, deallocate memory */
2002-06-01 01:06:46 +02:00
if(HeapFree( GetProcessHeap(), 0, psa) == FALSE)
return E_UNEXPECTED;
2002-06-01 01:06:46 +02:00
return(S_OK);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayLock (OLEAUT32.21)
* Increment the lock counter
*
* Doc says (MSDN Library ) that psa->pvData should be made available (!= NULL)
2002-06-01 01:06:46 +02:00
* only when psa->cLocks is > 0... I don't get it since pvData is allocated
* before the array is locked, therefore
*/
HRESULT WINAPI SafeArrayLock(
SAFEARRAY *psa)
{
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
psa->cLocks++;
return(S_OK);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayUnlock (OLEAUT32.22)
* Decrement the lock counter
*/
HRESULT WINAPI SafeArrayUnlock(
SAFEARRAY *psa)
{
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if (psa->cLocks > 0)
psa->cLocks--;
return(S_OK);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayPutElement (OLEAUT32.26)
* Set the data at the given coordinate
*/
HRESULT WINAPI SafeArrayPutElement(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
LONG *rgIndices,
void *pv)
{
2002-06-01 01:06:46 +02:00
ULONG stepCountInSAData = 0; /* Number of array item to skip to get to
the desired one... */
PVOID elementStorageAddress = NULL; /* Adress to store the data */
/* Validate the index given */
2002-06-01 01:06:46 +02:00
if(! validCoordinate(rgIndices, psa))
return DISP_E_BADINDEX;
if(! validArg(psa))
return E_INVALIDARG;
if( SafeArrayLock(psa) == S_OK) {
/* Figure out the number of items to skip */
stepCountInSAData = calcDisplacement(rgIndices, psa->rgsabound, psa->cDims);
2002-06-01 01:06:46 +02:00
/* Figure out the number of byte to skip ... */
1999-04-25 21:01:52 +02:00
elementStorageAddress = (char *) psa->pvData+(stepCountInSAData*psa->cbElements);
2002-06-01 01:06:46 +02:00
if(isPointer(psa->fFeatures)) { /* increment ref count for this pointer */
2002-06-01 01:06:46 +02:00
*((PVOID*)elementStorageAddress) = *(PVOID*)pv;
IUnknown_AddRef( *(IUnknown**)pv);
2002-06-01 01:06:46 +02:00
} else {
if(psa->fFeatures == FADF_BSTR) { /* Create a new object */
BSTR pbstrReAllocStr = NULL;
if(pv &&
((pbstrReAllocStr = SYSDUPSTRING( (OLECHAR*)pv )) == NULL)) {
2002-06-01 01:06:46 +02:00
SafeArrayUnlock(psa);
return E_OUTOFMEMORY;
2002-06-01 01:06:46 +02:00
} else
*((BSTR*)elementStorageAddress) = pbstrReAllocStr;
}
else if(psa->fFeatures == FADF_VARIANT) {
HRESULT hr = VariantCopy(elementStorageAddress, pv);
if (FAILED(hr)) {
SafeArrayUnlock(psa);
return hr;
}
}
else /* duplicate the memory */
memcpy(elementStorageAddress, pv, SafeArrayGetElemsize(psa) );
}
} else {
ERR("SafeArray: Cannot lock array....\n");
return E_UNEXPECTED; /* UNDOC error condition */
}
TRACE("SafeArray: item put at adress %p.\n",elementStorageAddress);
2002-06-01 01:06:46 +02:00
return SafeArrayUnlock(psa);
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayGetElement (OLEAUT32.25)
* Return the data element corresponding the the given coordinate
*/
HRESULT WINAPI SafeArrayGetElement(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
LONG *rgIndices,
void *pv)
{
2002-06-01 01:06:46 +02:00
ULONG stepCountInSAData = 0; /* Number of array item to skip to get to
the desired one... */
PVOID elementStorageAddress = NULL; /* Adress to store the data */
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(! validCoordinate(rgIndices, psa)) /* Validate the index given */
return(DISP_E_BADINDEX);
if( SafeArrayLock(psa) == S_OK) {
/* Figure out the number of items to skip */
stepCountInSAData = calcDisplacement(rgIndices, psa->rgsabound, psa->cDims);
2002-06-01 01:06:46 +02:00
/* Figure out the number of byte to skip ... */
1999-04-25 21:01:52 +02:00
elementStorageAddress = (char *) psa->pvData+(stepCountInSAData*psa->cbElements);
2002-06-01 01:06:46 +02:00
if( psa->fFeatures == FADF_BSTR) { /* reallocate the obj */
BSTR pbstrStoredStr = *(OLECHAR**)elementStorageAddress;
BSTR pbstrReturnedStr = NULL;
if( pbstrStoredStr &&
((pbstrReturnedStr = SYSDUPSTRING( pbstrStoredStr )) == NULL) ) {
SafeArrayUnlock(psa);
return E_OUTOFMEMORY;
2002-06-01 01:06:46 +02:00
} else
*((BSTR*)pv) = pbstrReturnedStr;
}
else if( psa->fFeatures == FADF_VARIANT) {
HRESULT hr;
VariantInit(pv);
hr = VariantCopy(pv, elementStorageAddress);
if (FAILED(hr)) {
SafeArrayUnlock(psa);
return hr;
}
}
else if( isPointer(psa->fFeatures) ) /* simply copy the pointer */
2002-06-01 01:06:46 +02:00
*(PVOID*)pv = *((PVOID*)elementStorageAddress);
else /* copy the bytes */
memcpy(pv, elementStorageAddress, psa->cbElements );
} else {
ERR("SafeArray: Cannot lock array....\n");
return E_UNEXPECTED; /* UNDOC error condition */
}
2002-06-01 01:06:46 +02:00
return( SafeArrayUnlock(psa) );
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayGetUBound (OLEAUT32.19)
* return the UP bound for a given array dimension
*/
HRESULT WINAPI SafeArrayGetUBound(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
UINT nDim,
LONG *plUbound)
{
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(nDim > psa->cDims)
return DISP_E_BADINDEX;
if(0 == nDim)
return DISP_E_BADINDEX;
2002-06-01 01:06:46 +02:00
*plUbound = psa->rgsabound[nDim-1].lLbound +
psa->rgsabound[nDim-1].cElements - 1;
return S_OK;
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayGetLBound (OLEAUT32.20)
2002-06-01 01:06:46 +02:00
* Return the LO bound for a given array dimension
*/
HRESULT WINAPI SafeArrayGetLBound(
SAFEARRAY *psa,
2002-06-01 01:06:46 +02:00
UINT nDim,
LONG *plLbound)
{
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(nDim > psa->cDims)
return DISP_E_BADINDEX;
if(0 == nDim)
return DISP_E_BADINDEX;
2002-06-01 01:06:46 +02:00
*plLbound = psa->rgsabound[nDim-1].lLbound;
return S_OK;
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayGetDim (OLEAUT32.17)
* returns the number of dimension in the array
*/
UINT WINAPI SafeArrayGetDim(
SAFEARRAY * psa)
2002-06-01 01:06:46 +02:00
{
/*
* A quick test in Windows shows that the behavior here for an invalid
* pointer is to return 0.
*/
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return 0;
return psa->cDims;
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayGetElemsize (OLEAUT32.18)
* Return the size of the element in the array
*/
UINT WINAPI SafeArrayGetElemsize(
SAFEARRAY * psa)
2002-06-01 01:06:46 +02:00
{
/*
* A quick test in Windows shows that the behavior here for an invalid
* pointer is to return 0.
*/
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return 0;
return psa->cbElements;
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayAccessData (OLEAUT32.23)
2002-06-01 01:06:46 +02:00
* increment the access count and return the data
*/
HRESULT WINAPI SafeArrayAccessData(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
void **ppvData)
2002-06-01 01:06:46 +02:00
{
HRESULT hRes;
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
hRes = SafeArrayLock(psa);
switch (hRes) {
2002-06-01 01:06:46 +02:00
case S_OK:
(*ppvData) = psa->pvData;
break;
case E_INVALIDARG:
(*ppvData) = NULL;
return E_INVALIDARG;
}
2002-06-01 01:06:46 +02:00
return S_OK;
}
/*************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayUnaccessData (OLEAUT32.24)
* Decrement the access count
*/
HRESULT WINAPI SafeArrayUnaccessData(
SAFEARRAY * psa)
2002-06-01 01:06:46 +02:00
{
if(! validArg(psa))
return E_INVALIDARG;
return(SafeArrayUnlock(psa));
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayPtrOfIndex (OLEAUT32.148)
* Return a pointer to the element at rgIndices
*/
HRESULT WINAPI SafeArrayPtrOfIndex(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
LONG *rgIndices,
void **ppvData)
2002-06-01 01:06:46 +02:00
{
ULONG stepCountInSAData = 0; /* Number of array item to skip to get to
the desired one... */
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(! validCoordinate(rgIndices, psa))
return DISP_E_BADINDEX;
2002-01-29 03:44:44 +01:00
/* Although it is dangerous to do this without having a lock, it is not
* illegal. Microsoft do warn of the danger.
*/
/* Figure out the number of items to skip */
stepCountInSAData = calcDisplacement(rgIndices, psa->rgsabound, psa->cDims);
2002-06-01 01:06:46 +02:00
1999-04-25 21:01:52 +02:00
*ppvData = (char *) psa->pvData+(stepCountInSAData*psa->cbElements);
return S_OK;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayDestroyData (OLEAUT32.39)
* Frees the memory data bloc
*/
HRESULT WINAPI SafeArrayDestroyData(
SAFEARRAY *psa)
2002-06-01 01:06:46 +02:00
{
HRESULT hRes;
ULONG ulWholeArraySize; /* count spot in array */
ULONG ulDataIter; /* to iterate the data space */
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(psa->cLocks > 0)
return DISP_E_ARRAYISLOCKED;
if(psa->pvData==NULL)
return S_OK;
ulWholeArraySize = getArraySize(psa);
if(isPointer(psa->fFeatures)) { /* release the pointers */
IUnknown *punk;
for(ulDataIter=0; ulDataIter < ulWholeArraySize; ulDataIter++) {
2002-06-01 01:06:46 +02:00
punk = *(IUnknown**)((char *) psa->pvData+(ulDataIter*(psa->cbElements)));
2002-06-01 01:06:46 +02:00
if( punk != NULL)
IUnknown_Release(punk);
}
}
else if(psa->fFeatures & FADF_BSTR) { /* deallocate the obj */
BSTR bstr;
for(ulDataIter=0; ulDataIter < ulWholeArraySize; ulDataIter++) {
1999-04-25 21:01:52 +02:00
bstr = *(BSTR*)((char *) psa->pvData+(ulDataIter*(psa->cbElements)));
2002-06-01 01:06:46 +02:00
if( bstr != NULL)
SysFreeString( bstr );
}
}
else if(psa->fFeatures & FADF_VARIANT) { /* deallocate the obj */
for(ulDataIter=0; ulDataIter < ulWholeArraySize; ulDataIter++) {
VariantClear((VARIANT*)((char *) psa->pvData+(ulDataIter*(psa->cbElements))));
}
}
2002-06-01 01:06:46 +02:00
/* check if this array is a Vector, in which case do not free the data
block since it has been allocated by AllocDescriptor and therefore
deserve to be freed by DestroyDescriptor */
if(!(psa->fFeatures & FADF_CREATEVECTOR)) { /* Set when we do CreateVector */
/* free the whole chunk */
if((hRes = HeapFree( GetProcessHeap(), 0, psa->pvData)) == 0) /*falied*/
return E_UNEXPECTED; /* UNDOC error condition */
psa->pvData = NULL;
}
2002-06-01 01:06:46 +02:00
return S_OK;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayCopyData (OLEAUT32.412)
* Copy the psaSource's data block into psaTarget if dimension and size
* permits it.
*/
HRESULT WINAPI SafeArrayCopyData(
SAFEARRAY *psaSource,
SAFEARRAY **psaTarget)
2002-06-01 01:06:46 +02:00
{
USHORT cDimCount; /* looper */
LONG lDelta; /* looper */
2002-06-01 01:06:46 +02:00
IUnknown *punk;
ULONG ulWholeArraySize; /* Number of item in SA */
BSTR bstr;
2002-06-01 01:06:46 +02:00
if(! (validArg(psaSource) && validArg(*psaTarget)) )
return E_INVALIDARG;
if(SafeArrayGetDim(psaSource) != SafeArrayGetDim(*psaTarget))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
ulWholeArraySize = getArraySize(psaSource);
/* The two arrays boundaries must be of same lenght */
for(cDimCount=0;cDimCount < psaSource->cDims; cDimCount++)
2002-06-01 01:06:46 +02:00
if( psaSource->rgsabound[cDimCount].cElements !=
(*psaTarget)->rgsabound[cDimCount].cElements)
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if( isPointer((*psaTarget)->fFeatures) ) { /* the target contains ptr
that must be released */
for(lDelta=0;lDelta < ulWholeArraySize; lDelta++) {
punk = *(IUnknown**)
1999-04-25 21:01:52 +02:00
((char *) (*psaTarget)->pvData + (lDelta * (*psaTarget)->cbElements));
2002-06-01 01:06:46 +02:00
if( punk != NULL)
IUnknown_Release(punk);
}
}
else if( (*psaTarget)->fFeatures & FADF_BSTR) { /* the target contain BSTR
2002-06-01 01:06:46 +02:00
that must be freed */
for(lDelta=0;lDelta < ulWholeArraySize; lDelta++) {
2002-06-01 01:06:46 +02:00
bstr =
1999-04-25 21:01:52 +02:00
*(BSTR*)((char *) (*psaTarget)->pvData + (lDelta * (*psaTarget)->cbElements));
2002-06-01 01:06:46 +02:00
if( bstr != NULL)
SysFreeString( bstr );
}
}
else if( (*psaTarget)->fFeatures & FADF_VARIANT) {
for(lDelta=0;lDelta < ulWholeArraySize; lDelta++) {
VariantClear((VARIANT*)((char *) (*psaTarget)->pvData + (lDelta * (*psaTarget)->cbElements)));
}
}
return duplicateData(psaSource, psaTarget);
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayDestroy (OLEAUT32.16)
* Deallocates all memory reserved for the SafeArray
*/
HRESULT WINAPI SafeArrayDestroy(
SAFEARRAY * psa)
2002-06-01 01:06:46 +02:00
{
HRESULT hRes;
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if(psa->cLocks > 0)
return DISP_E_ARRAYISLOCKED;
if((hRes = SafeArrayDestroyData( psa )) == S_OK)
if((hRes = SafeArrayDestroyDescriptor( psa )) == S_OK)
return S_OK;
return E_UNEXPECTED; /* UNDOC error condition */
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayCopy (OLEAUT32.27)
* Make a dupplicate of a SafeArray
*/
HRESULT WINAPI SafeArrayCopy(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
SAFEARRAY **ppsaOut)
2002-06-01 01:06:46 +02:00
{
HRESULT hRes;
DWORD dAllocSize;
ULONG ulWholeArraySize; /* size of the thing */
2002-06-01 01:06:46 +02:00
if(! validArg(psa))
return E_INVALIDARG;
if((hRes=SafeArrayAllocDescriptor(psa->cDims, ppsaOut)) == S_OK){
/* Duplicate the SAFEARRAY struc */
2002-06-01 01:06:46 +02:00
memcpy(*ppsaOut, psa,
sizeof(*psa)+(sizeof(*(psa->rgsabound))*(psa->cDims-1)));
(*ppsaOut)->pvData = NULL; /* do not point to the same data area */
/* make sure the new safe array doesn't have the FADF_CREATEVECTOR flag,
because the data has not been allocated with the descriptor. */
2002-06-01 01:06:46 +02:00
(*ppsaOut)->fFeatures &= ~FADF_CREATEVECTOR;
/* Get the allocated memory size for source and allocate it for target */
ulWholeArraySize = getArraySize(psa); /* Number of item in SA */
dAllocSize = ulWholeArraySize*psa->cbElements;
2002-06-01 01:06:46 +02:00
(*ppsaOut)->pvData =
HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dAllocSize);
if( (*ppsaOut)->pvData != NULL) { /* HeapAlloc succeed */
if( (hRes=duplicateData(psa, ppsaOut)) != S_OK) { /* E_OUTOFMEMORY */
HeapFree(GetProcessHeap(), 0, (*ppsaOut)->pvData);
(*ppsaOut)->pvData = NULL;
SafeArrayDestroyDescriptor(*ppsaOut);
return hRes;
}
2002-06-01 01:06:46 +02:00
} else { /* failed to allocate or dupplicate... */
SafeArrayDestroyDescriptor(*ppsaOut);
return E_UNEXPECTED; /* UNDOC error condition */
}
} else { /* failed to allocate mem for descriptor */
return E_OUTOFMEMORY; /* UNDOC error condiftion */
}
return S_OK;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayCreateVector (OLEAUT32.411)
2002-06-01 01:06:46 +02:00
* Creates a one dimension safearray where the data is next to the
* SAFEARRAY structure.
*/
SAFEARRAY* WINAPI SafeArrayCreateVector(
2002-06-01 01:06:46 +02:00
VARTYPE vt,
LONG lLbound,
ULONG cElements)
{
SAFEARRAY *psa;
/* Validate supported VARTYPE */
if ( (vt >= LAST_VARTYPE) ||
( VARTYPE_SIZE[vt] == VARTYPE_NOT_SUPPORTED ) )
return NULL;
/* Allocate memory for the array descriptor and data contiguously */
2002-06-01 01:06:46 +02:00
if( FAILED( psa = HeapAlloc( GetProcessHeap(),
HEAP_ZERO_MEMORY,
(sizeof(*psa) + (VARTYPE_SIZE[vt] * cElements))))) {
return NULL;
}
2002-06-01 01:06:46 +02:00
/* setup data members... */
psa->cDims = 1; /* always and forever */
psa->fFeatures = getFeatures(vt) | FADF_CREATEVECTOR; /* undocumented flag used by Microsoft */
psa->cLocks = 0;
psa->pvData = (BYTE*)psa + sizeof(*psa);
psa->cbElements = VARTYPE_SIZE[vt];
psa->rgsabound[0].cElements = cElements;
psa->rgsabound[0].lLbound = lLbound;
2002-06-01 01:06:46 +02:00
return(psa);
}
2002-06-01 01:06:46 +02:00
/************************************************************************
2001-06-19 20:20:47 +02:00
* SafeArrayRedim (OLEAUT32.40)
* Changes the caracteristics of the last dimension of the SafeArray
*/
HRESULT WINAPI SafeArrayRedim(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
SAFEARRAYBOUND *psaboundNew)
2002-06-01 01:06:46 +02:00
{
LONG lDelta; /* hold difference in size */
USHORT cDims=1; /* dims counter */
2002-06-01 01:06:46 +02:00
if( !validArg(psa) )
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if( psa->cLocks > 0 )
return DISP_E_ARRAYISLOCKED;
2002-06-01 01:06:46 +02:00
if( psa->fFeatures & FADF_FIXEDSIZE )
return E_INVALIDARG;
2002-06-01 01:06:46 +02:00
if( SafeArrayLock(psa)==E_UNEXPECTED )
return E_UNEXPECTED;/* UNDOC error condition */
/* find the delta in number of array spot to apply to the new array */
lDelta = psaboundNew->cElements - psa->rgsabound[0].cElements;
for(; cDims < psa->cDims; cDims++)
/* delta in number of spot implied by modifying the last dimension */
lDelta *= psa->rgsabound[cDims].cElements;
TRACE("elements=%ld, Lbound=%ld (delta=%ld)\n", psaboundNew->cElements, psaboundNew->lLbound, lDelta);
if (lDelta == 0) { ;/* same size, maybe a change of lLbound, just set it */
} else /* need to enlarge (lDelta +) reduce (lDelta -) */
2002-06-01 01:06:46 +02:00
if(! resizeSafeArray(psa, lDelta))
return E_UNEXPECTED; /* UNDOC error condition */
2002-06-01 01:06:46 +02:00
/* the only modifyable dimension sits in [0] as the dimensions were reversed
at array creation time... */
psa->rgsabound[0].cElements = psaboundNew->cElements;
psa->rgsabound[0].lLbound = psaboundNew->lLbound;
return SafeArrayUnlock(psa);
}
/************************************************************************
* NOT WINDOWS API - SafeArray* Utility functions
************************************************************************/
2002-06-01 01:06:46 +02:00
/************************************************************************
* Used to validate the SAFEARRAY type of arg
*/
static BOOL validArg(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa)
{
SAFEARRAYBOUND *sab;
LONG psaSize = 0;
LONG descSize = 0;
LONG fullSize = 0;
/*
* Let's check for the null pointer just in case.
*/
if (psa == NULL)
return FALSE;
/* Check whether the size of the chunk makes sense... That's the only thing
I can think of now... */
psaSize = HeapSize(GetProcessHeap(), 0, psa);
if (psaSize == -1)
/* uh, foreign heap. Better don't mess with it ! */
return TRUE;
/* size of the descriptor when the SA is not created with CreateVector */
descSize = sizeof(*psa) + (sizeof(*sab) * (psa->cDims-1));
/* size of the descriptor + data when created with CreateVector */
fullSize = sizeof(*psa) + (psa->cbElements * psa->rgsabound[0].cElements);
return((psaSize >= descSize) || (psaSize >= fullSize));
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Used to reallocate memory
*/
static BOOL resizeSafeArray(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
LONG lDelta)
{
ULONG ulWholeArraySize; /* use as multiplicator */
2002-06-01 01:06:46 +02:00
PVOID pvNewBlock = NULL;
IUnknown *punk;
BSTR bstr;
ulWholeArraySize = getArraySize(psa);
if(lDelta < 0) { /* array needs to be shorthen */
if( isPointer(psa->fFeatures)) /* ptr that need to be released */
for(;lDelta < 0; lDelta++) {
punk = *(IUnknown**)
1999-04-25 21:01:52 +02:00
((char *) psa->pvData+((ulWholeArraySize+lDelta)*psa->cbElements));
2002-06-01 01:06:46 +02:00
if( punk != NULL )
IUnknown_Release(punk);
}
else if(psa->fFeatures & FADF_BSTR) /* BSTR that need to be freed */
for(;lDelta < 0; lDelta++) {
bstr = *(BSTR*)
1999-04-25 21:01:52 +02:00
((char *) psa->pvData+((ulWholeArraySize+lDelta)*psa->cbElements));
if( bstr != NULL )
SysFreeString( bstr );
}
else if(psa->fFeatures & FADF_VARIANT)
for(;lDelta < 0; lDelta++) {
VariantClear((VARIANT*)((char *) psa->pvData+((ulWholeArraySize+lDelta)*psa->cbElements)));
}
}
if (!(psa->fFeatures & FADF_CREATEVECTOR))
{
2002-06-01 01:06:46 +02:00
/* Ok now, if we are enlarging the array, we *MUST* move the whole block
pointed to by pvData. If we are shorthening the array, this move is
2002-06-01 01:06:46 +02:00
optional but we do it anyway becuase the benefit is that we are
releasing to the system the unused memory */
2002-06-01 01:06:46 +02:00
if((pvNewBlock = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, psa->pvData,
(ulWholeArraySize + lDelta) * psa->cbElements)) == NULL)
return FALSE; /* TODO If we get here it means:
SHRINK situation : we've deleted the undesired
data and did not release the memory
GROWING situation: we've been unable to grow the array
*/
}
else
{
2002-06-01 01:06:46 +02:00
/* Allocate a new block, because the previous data has been allocated with
the descriptor in SafeArrayCreateVector function. */
if((pvNewBlock = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
2002-06-01 01:06:46 +02:00
ulWholeArraySize * psa->cbElements)) == NULL)
return FALSE;
psa->fFeatures &= ~FADF_CREATEVECTOR;
}
/* reassign to the new block of data */
psa->pvData = pvNewBlock;
return TRUE;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Used to set the fFeatures data member of the SAFEARRAY structure.
*/
static INT getFeatures(
2002-06-01 01:06:46 +02:00
VARTYPE vt)
{
switch(vt) {
case VT_BSTR: return FADF_BSTR;
case VT_UNKNOWN: return FADF_UNKNOWN;
case VT_DISPATCH: return FADF_DISPATCH;
case VT_VARIANT: return FADF_VARIANT;
}
return 0;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Used to figure out if the fFeatures data member of the SAFEARRAY
* structure contain any information about the type of data stored...
*/
static BOOL isPointer(
2002-06-01 01:06:46 +02:00
USHORT feature)
{
switch(feature) {
case FADF_UNKNOWN: return TRUE; /* those are pointers */
case FADF_DISPATCH: return TRUE;
}
return FALSE;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Used to calculate the displacement when accessing or modifying
* safearray data set.
*
* Parameters: - LONG *coor is the desired location in the multidimension
* table. Ex for a 3 dim table: coor[] = {1,2,3};
* - ULONG *mat is the format of the table. Ex for a 3 dim
* table mat[] = {4,4,4};
* - USHORT dim is the number of dimension of the SafeArray
*/
static ULONG calcDisplacement(
2002-06-01 01:06:46 +02:00
LONG *coor,
SAFEARRAYBOUND *mat,
LONG dim)
{
ULONG res = 0;
LONG iterDim;
2002-06-01 01:06:46 +02:00
for(iterDim=0; iterDim<dim; iterDim++)
/* the -mat[dim] bring coor[dim] relative to 0 for calculation */
2002-06-01 01:06:46 +02:00
res += ((coor[iterDim]-mat[iterDim].lLbound) *
endOfDim(coor, mat, iterDim+1, dim));
TRACE("SafeArray: calculated displacement is %lu.\n", res);
return(res);
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Recursivity agent for calcDisplacement method. Used within Put and
* Get methods.
*/
static INT endOfDim(
2002-06-01 01:06:46 +02:00
LONG *coor,
SAFEARRAYBOUND *mat,
LONG dim,
LONG realDim)
{
2002-06-01 01:06:46 +02:00
if(dim==realDim)
return 1;
2002-06-01 01:06:46 +02:00
else
return (endOfDim(coor, mat, dim+1, realDim) * mat[dim].cElements);
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Method used to validate the coordinate received in Put and Get
* methods.
*/
static BOOL validCoordinate(
2002-06-01 01:06:46 +02:00
LONG *coor,
SAFEARRAY *psa)
{
INT iter=0;
LONG lUBound;
LONG lLBound;
HRESULT hRes;
if (!psa->cDims) { FIXME("no dims?\n");return FALSE; }
for(; iter<psa->cDims; iter++) {
TRACE("coor[%d]=%ld\n", iter, coor[iter]);
if((hRes = SafeArrayGetLBound(psa, (iter+1), &lLBound)) != S_OK) {
FIXME("No lbound?\n");
return FALSE;
}
if((hRes = SafeArrayGetUBound(psa, (iter+1), &lUBound)) != S_OK) {
FIXME("No ubound?\n");
return FALSE;
}
if(lLBound > lUBound) {
FIXME("lbound larger than ubound?\n");
2002-06-01 01:06:46 +02:00
return FALSE;
}
if((coor[iter] < lLBound) || (coor[iter] > lUBound)) {
FIXME("coordinate %ld not within %ld - %ld\n",coor[iter], lLBound, lUBound);
return FALSE;
}
}
return TRUE;
2002-06-01 01:06:46 +02:00
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Method used to calculate the number of cells of the SA
*/
static ULONG getArraySize(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa)
{
2002-06-01 01:06:46 +02:00
USHORT cCount;
ULONG ulWholeArraySize = 1;
for(cCount=0; cCount < psa->cDims; cCount++) /* foreach dimensions... */
ulWholeArraySize *= psa->rgsabound[cCount].cElements;
2002-06-01 01:06:46 +02:00
return ulWholeArraySize;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* Method used to handle data space dupplication for Copy32 and CopyData32
*/
static HRESULT duplicateData(
2002-06-01 01:06:46 +02:00
SAFEARRAY *psa,
SAFEARRAY **ppsaOut)
{
ULONG ulWholeArraySize; /* size of the thing */
LONG lDelta;
ulWholeArraySize = getArraySize(psa); /* Number of item in SA */
2002-06-01 01:06:46 +02:00
SafeArrayLock(*ppsaOut);
2002-06-01 01:06:46 +02:00
if( isPointer(psa->fFeatures) ) { /* If datatype is object increment
object's reference count */
IUnknown *punk;
for(lDelta=0; lDelta < ulWholeArraySize; lDelta++) {
1999-04-25 21:01:52 +02:00
punk = *(IUnknown**)((char *) psa->pvData+(lDelta * psa->cbElements));
if( punk != NULL)
IUnknown_AddRef(punk);
}
/* Copy the source array data into target array */
2002-06-01 01:06:46 +02:00
memcpy((*ppsaOut)->pvData, psa->pvData,
ulWholeArraySize*psa->cbElements);
}
2002-06-01 01:06:46 +02:00
else if( psa->fFeatures & FADF_BSTR ) { /* if datatype is BSTR allocate
the BSTR in the new array */
BSTR pbstrReAllocStr = NULL;
for(lDelta=0; lDelta < ulWholeArraySize; lDelta++) {
if(( pbstrReAllocStr = SYSDUPSTRING(
1999-04-25 21:01:52 +02:00
*(BSTR*)((char *) psa->pvData+(lDelta * psa->cbElements)))) == NULL) {
SafeArrayUnlock(*ppsaOut);
return E_OUTOFMEMORY;
}
2002-06-01 01:06:46 +02:00
*((BSTR*)((char *) (*ppsaOut)->pvData+(lDelta * psa->cbElements))) =
pbstrReAllocStr;
}
}
else if( psa->fFeatures & FADF_VARIANT ) {
for(lDelta=0; lDelta < ulWholeArraySize; lDelta++) {
VariantCopy((VARIANT*)((char *) (*ppsaOut)->pvData+(lDelta * psa->cbElements)),
(VARIANT*)((char *) psa->pvData+(lDelta * psa->cbElements)));
}
}
else { /* Simply copy the source array data into target array */
2002-06-01 01:06:46 +02:00
memcpy((*ppsaOut)->pvData, psa->pvData,
ulWholeArraySize*psa->cbElements);
}
SafeArrayUnlock(*ppsaOut);
return S_OK;
}
2002-06-01 01:06:46 +02:00
/************************************************************************
* SafeArrayGetVartype (OLEAUT32.77)
* Returns the VARTYPE stored in the given safearray
*/
HRESULT WINAPI SafeArrayGetVartype(
SAFEARRAY* psa,
VARTYPE* pvt)
{
HRESULT hr = E_INVALIDARG;
VARTYPE vt = VT_EMPTY;
/* const short VARTYPE_OFFSET = -4; */
if (psa->fFeatures & FADF_HAVEVARTYPE)
{
/* VT tag @ negative offset 4 in the array descriptor */
2001-05-09 19:31:31 +02:00
FIXME("Returning VT_BSTR instead of VT_...\n");
vt = VT_BSTR;
}
else if (psa->fFeatures & FADF_RECORD)
{
vt = VT_RECORD;
}
else if (psa->fFeatures & FADF_BSTR)
{
vt = VT_BSTR;
}
else if (psa->fFeatures & FADF_UNKNOWN)
{
vt = VT_UNKNOWN;
}
else if (psa->fFeatures & FADF_DISPATCH)
{
vt = VT_DISPATCH;
}
else if (psa->fFeatures & FADF_VARIANT)
{
vt = VT_VARIANT;
}
if (vt != VT_EMPTY)
{
*pvt = vt;
hr = S_OK;
}
2001-05-09 19:31:31 +02:00
TRACE("HRESULT = %08lx\n", hr);
return hr;
}