4 * Copyright 1999, 2000 Marcus Meissner
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
38 #include "wine/debug.h"
40 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
42 static BOOL BSTR_bCache
= TRUE
; /* Cache allocations to minimise alloc calls? */
44 HMODULE OLEAUT32_hModule
= NULL
;
46 /******************************************************************************
50 * BSTR is a simple typedef for a wide-character string used as the principle
51 * string type in ole automation. When encapsulated in a Variant type they are
52 * automatically copied and destroyed as the variant is processed.
54 * The low level BSTR Api allows manipulation of these strings and is used by
55 * higher level Api calls to manage the strings transparently to the caller.
57 * Internally the BSTR type is allocated with space for a DWORD byte count before
58 * the string data begins. This is undocumented and non-system code should not
59 * access the count directly. Use SysStringLen() or SysStringByteLen()
60 * instead. Note that the byte count does not include the terminating NUL.
62 * To create a new BSTR, use SysAllocString(), SysAllocStringLen() or
63 * SysAllocStringByteLen(). To change the size of an existing BSTR, use SysReAllocString()
64 * or SysReAllocStringLen(). Finally to destroy a string use SysFreeString().
66 * BSTR's are cached by Ole Automation by default. To override this behaviour
67 * either set the environment variable 'OANOCACHE', or call SetOaNoCache().
70 * 'Inside OLE, second edition' by Kraig Brockshmidt.
73 /******************************************************************************
74 * SysStringLen [OLEAUT32.7]
76 * Get the allocated length of a BSTR in wide characters.
79 * str [I] BSTR to find the length of
82 * The allocated length of str, or 0 if str is NULL.
86 * The returned length may be different from the length of the string as
87 * calculated by lstrlenW(), since it returns the length that was used to
88 * allocate the string by SysAllocStringLen().
90 UINT WINAPI
SysStringLen(BSTR str
)
96 * The length of the string (in bytes) is contained in a DWORD placed
97 * just before the BSTR pointer
99 bufferPointer
= (DWORD
*)str
;
103 return (int)(*bufferPointer
/sizeof(WCHAR
));
106 /******************************************************************************
107 * SysStringByteLen [OLEAUT32.149]
109 * Get the allocated length of a BSTR in bytes.
112 * str [I] BSTR to find the length of
115 * The allocated length of str, or 0 if str is NULL.
118 * See SysStringLen(), BSTR().
120 UINT WINAPI
SysStringByteLen(BSTR str
)
122 DWORD
* bufferPointer
;
126 * The length of the string (in bytes) is contained in a DWORD placed
127 * just before the BSTR pointer
129 bufferPointer
= (DWORD
*)str
;
133 return (int)(*bufferPointer
);
136 /******************************************************************************
137 * SysAllocString [OLEAUT32.2]
139 * Create a BSTR from an OLESTR.
142 * str [I] Source to create BSTR from
145 * Success: A BSTR allocated with SysAllocStringLen().
146 * Failure: NULL, if oleStr is NULL.
150 * MSDN (October 2001) incorrectly states that NULL is returned if oleStr has
151 * a length of 0. Native Win32 and this implementation both return a valid
152 * empty BSTR in this case.
154 BSTR WINAPI
SysAllocString(LPCOLESTR str
)
158 /* Delegate this to the SysAllocStringLen32 method. */
159 return SysAllocStringLen(str
, lstrlenW(str
));
162 /******************************************************************************
163 * SysFreeString [OLEAUT32.6]
168 * str [I] BSTR to free.
175 * str may be NULL, in which case this function does nothing.
177 void WINAPI
SysFreeString(BSTR str
)
179 DWORD
* bufferPointer
;
181 /* NULL is a valid parameter */
185 * We have to be careful when we free a BSTR pointer, it points to
186 * the beginning of the string but it skips the byte count contained
189 bufferPointer
= (DWORD
*)str
;
194 * Free the memory from its "real" origin.
196 HeapFree(GetProcessHeap(), 0, bufferPointer
);
199 /******************************************************************************
200 * SysAllocStringLen [OLEAUT32.4]
202 * Create a BSTR from an OLESTR of a given wide character length.
205 * str [I] Source to create BSTR from
206 * len [I] Length of oleStr in wide characters
209 * Success: A newly allocated BSTR from SysAllocStringByteLen()
210 * Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
213 * See BSTR(), SysAllocStringByteLen().
215 BSTR WINAPI
SysAllocStringLen(const OLECHAR
*str
, unsigned int len
)
221 /* Detect integer overflow. */
222 if (len
>= ((UINT_MAX
-sizeof(WCHAR
)-sizeof(DWORD
))/sizeof(WCHAR
)))
225 * Find the length of the buffer passed-in, in bytes.
227 bufferSize
= len
* sizeof (WCHAR
);
230 * Allocate a new buffer to hold the string.
231 * don't forget to keep an empty spot at the beginning of the
232 * buffer for the character count and an extra character at the
235 newBuffer
= HeapAlloc(GetProcessHeap(), 0,
236 bufferSize
+ sizeof(WCHAR
) + sizeof(DWORD
));
239 * If the memory allocation failed, return a null pointer.
245 * Copy the length of the string in the placeholder.
247 *newBuffer
= bufferSize
;
250 * Skip the byte count.
255 * Copy the information in the buffer.
256 * Since it is valid to pass a NULL pointer here, we'll initialize the
257 * buffer to nul if it is the case.
260 memcpy(newBuffer
, str
, bufferSize
);
262 memset(newBuffer
, 0, bufferSize
);
265 * Make sure that there is a nul character at the end of the
268 stringBuffer
= (WCHAR
*)newBuffer
;
269 stringBuffer
[len
] = L
'\0';
271 return (LPWSTR
)stringBuffer
;
274 /******************************************************************************
275 * SysReAllocStringLen [OLEAUT32.5]
277 * Change the length of a previously created BSTR.
280 * old [O] BSTR to change the length of
281 * str [I] New source for pbstr
282 * len [I] Length of oleStr in wide characters
285 * Success: 1. The size of pbstr is updated.
286 * Failure: 0, if len >= 0x80000000 or memory allocation fails.
289 * See BSTR(), SysAllocStringByteLen().
290 * *pbstr may be changed by this function.
292 int WINAPI
SysReAllocStringLen(BSTR
* old
, const OLECHAR
* str
, unsigned int len
)
295 DWORD newbytelen
= len
*sizeof(WCHAR
);
296 DWORD
*ptr
= HeapReAlloc(GetProcessHeap(),0,((DWORD
*)*old
)-1,newbytelen
+sizeof(WCHAR
)+sizeof(DWORD
));
297 *old
= (BSTR
)(ptr
+1);
300 memcpy(*old
, str
, newbytelen
);
303 /* Subtle hidden feature: The old string data is still there
305 * Some Microsoft program needs it.
310 * Allocate the new string
312 *old
= SysAllocStringLen(str
, len
);
318 /******************************************************************************
319 * SysAllocStringByteLen [OLEAUT32.150]
321 * Create a BSTR from an OLESTR of a given byte length.
324 * str [I] Source to create BSTR from
325 * len [I] Length of oleStr in bytes
328 * Success: A newly allocated BSTR
329 * Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
332 * -If len is 0 or oleStr is NULL the resulting string is empty ("").
333 * -This function always NUL terminates the resulting BSTR.
334 * -oleStr may be either an LPCSTR or LPCOLESTR, since it is copied
335 * without checking for a terminating NUL.
338 BSTR WINAPI
SysAllocStringByteLen(LPCSTR str
, UINT len
)
344 * Allocate a new buffer to hold the string.
345 * don't forget to keep an empty spot at the beginning of the
346 * buffer for the character count and an extra character at the
349 newBuffer
= HeapAlloc(GetProcessHeap(), 0,
350 len
+ sizeof(WCHAR
) + sizeof(DWORD
));
353 * If the memory allocation failed, return a null pointer.
359 * Copy the length of the string in the placeholder.
364 * Skip the byte count.
369 * Copy the information in the buffer.
370 * Since it is valid to pass a NULL pointer here, we'll initialize the
371 * buffer to nul if it is the case.
374 memcpy(newBuffer
, str
, len
);
377 * Make sure that there is a nul character at the end of the
380 stringBuffer
= (char *)newBuffer
;
381 stringBuffer
[len
] = 0;
382 stringBuffer
[len
+1] = 0;
384 return (LPWSTR
)stringBuffer
;
387 /******************************************************************************
388 * SysReAllocString [OLEAUT32.3]
390 * Change the length of a previously created BSTR.
393 * old [I/O] BSTR to change the length of
394 * str [I] New source for pbstr
401 * See BSTR(), SysAllocStringStringLen().
403 INT WINAPI
SysReAllocString(LPBSTR old
,LPCOLESTR str
)
412 * Make sure we free the old string.
418 * Allocate the new string
420 *old
= SysAllocString(str
);
425 /******************************************************************************
426 * SetOaNoCache (OLEAUT32.327)
428 * Instruct Ole Automation not to cache BSTR allocations.
439 void WINAPI
SetOaNoCache(void)
444 static const WCHAR _delimiter
[2] = {'!',0}; /* default delimiter apparently */
445 static const WCHAR
*pdelimiter
= &_delimiter
[0];
447 /***********************************************************************
448 * RegisterActiveObject (OLEAUT32.33)
450 * Registers an object in the global item table.
453 * punk [I] Object to register.
454 * rcid [I] CLSID of the object.
456 * pdwRegister [O] Address to store cookie of object registration in.
460 * Failure: HRESULT code.
462 HRESULT WINAPI
RegisterActiveObject(
463 LPUNKNOWN punk
,REFCLSID rcid
,DWORD dwFlags
,LPDWORD pdwRegister
467 LPRUNNINGOBJECTTABLE runobtable
;
470 StringFromGUID2(rcid
,guidbuf
,39);
471 ret
= CreateItemMoniker(pdelimiter
,guidbuf
,&moniker
);
474 ret
= GetRunningObjectTable(0,&runobtable
);
476 IMoniker_Release(moniker
);
479 ret
= IRunningObjectTable_Register(runobtable
,dwFlags
,punk
,moniker
,pdwRegister
);
480 IRunningObjectTable_Release(runobtable
);
481 IMoniker_Release(moniker
);
485 /***********************************************************************
486 * RevokeActiveObject (OLEAUT32.34)
488 * Revokes an object from the global item table.
491 * xregister [I] Registration cookie.
492 * reserved [I] Reserved. Set to NULL.
496 * Failure: HRESULT code.
498 HRESULT WINAPI
RevokeActiveObject(DWORD xregister
,LPVOID reserved
)
500 LPRUNNINGOBJECTTABLE runobtable
;
503 ret
= GetRunningObjectTable(0,&runobtable
);
504 if (FAILED(ret
)) return ret
;
505 ret
= IRunningObjectTable_Revoke(runobtable
,xregister
);
506 if (SUCCEEDED(ret
)) ret
= S_OK
;
507 IRunningObjectTable_Release(runobtable
);
511 /***********************************************************************
512 * GetActiveObject (OLEAUT32.35)
514 * Gets an object from the global item table.
517 * rcid [I] CLSID of the object.
518 * preserved [I] Reserved. Set to NULL.
519 * ppunk [O] Address to store object into.
523 * Failure: HRESULT code.
525 HRESULT WINAPI
GetActiveObject(REFCLSID rcid
,LPVOID preserved
,LPUNKNOWN
*ppunk
)
529 LPRUNNINGOBJECTTABLE runobtable
;
532 StringFromGUID2(rcid
,guidbuf
,39);
533 ret
= CreateItemMoniker(pdelimiter
,guidbuf
,&moniker
);
536 ret
= GetRunningObjectTable(0,&runobtable
);
538 IMoniker_Release(moniker
);
541 ret
= IRunningObjectTable_GetObject(runobtable
,moniker
,ppunk
);
542 IRunningObjectTable_Release(runobtable
);
543 IMoniker_Release(moniker
);
548 /***********************************************************************
549 * OaBuildVersion [OLEAUT32.170]
551 * Get the Ole Automation build version.
560 * Known oleaut32.dll versions:
561 *| OLE Ver. Comments Date Build Ver.
562 *| -------- ------------------------- ---- ---------
563 *| OLE 2.1 NT 1993-95 10 3023
565 *| Win32s Ver 1.1e 20 4049
566 *| OLE 2.20 W95/NT 1993-96 20 4112
567 *| OLE 2.20 W95/NT 1993-96 20 4118
568 *| OLE 2.20 W95/NT 1993-96 20 4122
569 *| OLE 2.30 W95/NT 1993-98 30 4265
570 *| OLE 2.40 NT?? 1993-98 40 4267
571 *| OLE 2.40 W98 SE orig. file 1993-98 40 4275
572 *| OLE 2.40 W2K orig. file 1993-XX 40 4514
574 * Currently the versions returned are 2.20 for Win3.1, 2.30 for Win95 & NT 3.51,
575 * and 2.40 for all later versions. The build number is maximum, i.e. 0xffff.
577 ULONG WINAPI
OaBuildVersion()
579 switch(GetVersion() & 0x8000ffff) /* mask off build number */
581 case 0x80000a03: /* WIN31 */
582 return MAKELONG(0xffff, 20);
583 case 0x00003303: /* NT351 */
584 return MAKELONG(0xffff, 30);
585 case 0x80000004: /* WIN95; I'd like to use the "standard" w95 minor
586 version here (30), but as we still use w95
587 as default winver (which is good IMHO), I better
588 play safe and use the latest value for w95 for now.
589 Change this as soon as default winver gets changed
590 to something more recent */
591 case 0x80000a04: /* WIN98 */
592 case 0x00000004: /* NT40 */
593 case 0x00000005: /* W2K */
594 case 0x00000105: /* WinXP */
595 return MAKELONG(0xffff, 40);
597 FIXME("Version value not known yet. Please investigate it !\n");
598 return MAKELONG(0xffff, 40); /* for now return the same value as for w2k */
602 /******************************************************************************
603 * OleTranslateColor [OLEAUT32.421]
605 * Convert an OLE_COLOR to a COLORREF.
608 * clr [I] Color to convert
609 * hpal [I] Handle to a palette for the conversion
610 * pColorRef [O] Destination for converted color, or NULL to test if the conversion is ok
613 * Success: S_OK. The conversion is ok, and pColorRef contains the converted color if non-NULL.
614 * Failure: E_INVALIDARG, if any argument is invalid.
617 * Document the conversion rules.
619 HRESULT WINAPI
OleTranslateColor(
625 BYTE b
= HIBYTE(HIWORD(clr
));
627 TRACE("(%08x, %p, %p)\n", clr
, hpal
, pColorRef
);
630 * In case pColorRef is NULL, provide our own to simplify the code.
632 if (pColorRef
== NULL
)
633 pColorRef
= &colorref
;
640 *pColorRef
= PALETTERGB(GetRValue(clr
),
655 * Validate the palette index.
657 if (GetPaletteEntries(hpal
, LOWORD(clr
), 1, &pe
) == 0)
672 int index
= LOBYTE(LOWORD(clr
));
675 * Validate GetSysColor index.
677 if ((index
< COLOR_SCROLLBAR
) || (index
> COLOR_MENUBAR
))
680 *pColorRef
= GetSysColor(index
);
692 extern HRESULT
OLEAUTPS_DllGetClassObject(REFCLSID rclsid
, REFIID riid
, LPVOID
*ppv
);
694 extern void _get_STDFONT_CF(LPVOID
*);
695 extern void _get_STDPIC_CF(LPVOID
*);
697 static HRESULT WINAPI
PSDispatchFacBuf_QueryInterface(IPSFactoryBuffer
*iface
, REFIID riid
, void **ppv
)
699 if (IsEqualIID(riid
, &IID_IUnknown
) ||
700 IsEqualIID(riid
, &IID_IPSFactoryBuffer
))
702 IUnknown_AddRef(iface
);
703 *ppv
= (void *)iface
;
706 return E_NOINTERFACE
;
709 static ULONG WINAPI
PSDispatchFacBuf_AddRef(IPSFactoryBuffer
*iface
)
714 static ULONG WINAPI
PSDispatchFacBuf_Release(IPSFactoryBuffer
*iface
)
719 static HRESULT WINAPI
PSDispatchFacBuf_CreateProxy(IPSFactoryBuffer
*iface
, IUnknown
*pUnkOuter
, REFIID riid
, IRpcProxyBuffer
**ppProxy
, void **ppv
)
721 IPSFactoryBuffer
*pPSFB
;
724 if (IsEqualIID(riid
, &IID_IDispatch
))
725 hr
= OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch
, &IID_IPSFactoryBuffer
, (void **)&pPSFB
);
727 hr
= TMARSHAL_DllGetClassObject(&CLSID_PSOAInterface
, &IID_IPSFactoryBuffer
, (void **)&pPSFB
);
729 if (FAILED(hr
)) return hr
;
731 hr
= IPSFactoryBuffer_CreateProxy(pPSFB
, pUnkOuter
, riid
, ppProxy
, ppv
);
733 IPSFactoryBuffer_Release(pPSFB
);
737 static HRESULT WINAPI
PSDispatchFacBuf_CreateStub(IPSFactoryBuffer
*iface
, REFIID riid
, IUnknown
*pUnkOuter
, IRpcStubBuffer
**ppStub
)
739 IPSFactoryBuffer
*pPSFB
;
742 if (IsEqualIID(riid
, &IID_IDispatch
))
743 hr
= OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch
, &IID_IPSFactoryBuffer
, (void **)&pPSFB
);
745 hr
= TMARSHAL_DllGetClassObject(&CLSID_PSOAInterface
, &IID_IPSFactoryBuffer
, (void **)&pPSFB
);
747 if (FAILED(hr
)) return hr
;
749 hr
= IPSFactoryBuffer_CreateStub(pPSFB
, riid
, pUnkOuter
, ppStub
);
751 IPSFactoryBuffer_Release(pPSFB
);
755 static const IPSFactoryBufferVtbl PSDispatchFacBuf_Vtbl
=
757 PSDispatchFacBuf_QueryInterface
,
758 PSDispatchFacBuf_AddRef
,
759 PSDispatchFacBuf_Release
,
760 PSDispatchFacBuf_CreateProxy
,
761 PSDispatchFacBuf_CreateStub
764 /* This is the whole PSFactoryBuffer object, just the vtableptr */
765 static const IPSFactoryBufferVtbl
*pPSDispatchFacBuf
= &PSDispatchFacBuf_Vtbl
;
767 /***********************************************************************
768 * DllGetClassObject (OLEAUT32.@)
770 HRESULT WINAPI
DllGetClassObject(REFCLSID rclsid
, REFIID iid
, LPVOID
*ppv
)
773 if (IsEqualGUID(rclsid
,&CLSID_StdFont
)) {
774 if (IsEqualGUID(iid
,&IID_IClassFactory
)) {
775 _get_STDFONT_CF(ppv
);
776 IClassFactory_AddRef((IClassFactory
*)*ppv
);
780 if (IsEqualGUID(rclsid
,&CLSID_StdPicture
)) {
781 if (IsEqualGUID(iid
,&IID_IClassFactory
)) {
783 IClassFactory_AddRef((IClassFactory
*)*ppv
);
787 if (IsEqualCLSID(rclsid
, &CLSID_PSTypeInfo
) ||
788 IsEqualCLSID(rclsid
, &CLSID_PSTypeLib
) ||
789 IsEqualCLSID(rclsid
, &CLSID_PSEnumVariant
)) {
790 return OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch
, iid
, ppv
);
792 if (IsEqualCLSID(rclsid
, &CLSID_PSDispatch
) && IsEqualIID(iid
, &IID_IPSFactoryBuffer
)) {
793 *ppv
= &pPSDispatchFacBuf
;
794 IPSFactoryBuffer_AddRef((IPSFactoryBuffer
*)*ppv
);
797 if (IsEqualGUID(rclsid
,&CLSID_PSOAInterface
)) {
798 if (S_OK
==TMARSHAL_DllGetClassObject(rclsid
,iid
,ppv
))
802 FIXME("\n\tCLSID:\t%s,\n\tIID:\t%s\n",debugstr_guid(rclsid
),debugstr_guid(iid
));
803 return CLASS_E_CLASSNOTAVAILABLE
;
806 /***********************************************************************
807 * DllCanUnloadNow (OLEAUT32.@)
809 * Determine if this dll can be unloaded from the callers address space.
815 * Always returns S_FALSE. This dll cannot be unloaded.
817 HRESULT WINAPI
DllCanUnloadNow(void)
822 /*****************************************************************************
823 * DllMain [OLEAUT32.@]
825 BOOL WINAPI
DllMain(HINSTANCE hInstDll
, DWORD fdwReason
, LPVOID lpvReserved
)
827 TRACE("(%p,%d,%p)\n", hInstDll
, fdwReason
, lpvReserved
);
830 case DLL_PROCESS_ATTACH
:
831 DisableThreadLibraryCalls(hInstDll
);
832 OLEAUT32_hModule
= (HMODULE
)hInstDll
;
834 case DLL_PROCESS_DETACH
:
841 /***********************************************************************
842 * OleIconToCursor (OLEAUT32.415)
844 HCURSOR WINAPI
OleIconToCursor( HINSTANCE hinstExe
, HICON hIcon
)
846 FIXME("(%p,%p), partially implemented.\n",hinstExe
,hIcon
);
847 /* FIXME: make a extended conversation from HICON to HCURSOR */
848 return CopyCursor(hIcon
);