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 /******************************************************************************
48 * BSTR is a simple typedef for a wide-character string used as the principle
49 * string type in ole automation. When encapsulated in a Variant type they are
50 * automatically copied and destroyed as the variant is processed.
52 * The low level BSTR Api allows manipulation of these strings and is used by
53 * higher level Api calls to manage the strings transparently to the caller.
55 * Internally the BSTR type is allocated with space for a DWORD byte count before
56 * the string data begins. This is undocumented and non-system code should not
57 * access the count directly. Use SysStringLen() or SysStringByteLen()
58 * instead. Note that the byte count does not include the terminating NUL.
60 * To create a new BSTR, use SysAllocString(), SysAllocStringLen() or
61 * SysAllocStringByteLen(). To change the size of an existing BSTR, use SysReAllocString()
62 * or SysReAllocStringLen(). Finally to destroy a string use SysFreeString().
64 * BSTR's are cached by Ole Automation by default. To override this behaviour
65 * either set the environment variable 'OANOCACHE', or call SetOaNoCache().
68 * 'Inside OLE, second edition' by Kraig Brockshmidt.
71 /******************************************************************************
72 * SysStringLen [OLEAUT32.7]
74 * Get the allocated length of a BSTR in wide characters.
77 * str [I] BSTR to find the length of
80 * The allocated length of str, or 0 if str is NULL.
84 * The returned length may be different from the length of the string as
85 * calculated by lstrlenW(), since it returns the length that was used to
86 * allocate the string by SysAllocStringLen().
88 UINT WINAPI SysStringLen(BSTR str)
94 * The length of the string (in bytes) is contained in a DWORD placed
95 * just before the BSTR pointer
97 bufferPointer = (DWORD*)str;
101 return (int)(*bufferPointer/sizeof(WCHAR));
104 /******************************************************************************
105 * SysStringByteLen [OLEAUT32.149]
107 * Get the allocated length of a BSTR in bytes.
110 * str [I] BSTR to find the length of
113 * The allocated length of str, or 0 if str is NULL.
116 * See SysStringLen(), BSTR().
118 UINT WINAPI SysStringByteLen(BSTR str)
120 DWORD* bufferPointer;
124 * The length of the string (in bytes) is contained in a DWORD placed
125 * just before the BSTR pointer
127 bufferPointer = (DWORD*)str;
131 return (int)(*bufferPointer);
134 /******************************************************************************
135 * SysAllocString [OLEAUT32.2]
137 * Create a BSTR from an OLESTR.
140 * str [I] Source to create BSTR from
143 * Success: A BSTR allocated with SysAllocStringLen().
144 * Failure: NULL, if oleStr is NULL.
148 * MSDN (October 2001) incorrectly states that NULL is returned if oleStr has
149 * a length of 0. Native Win32 and this implementation both return a valid
150 * empty BSTR in this case.
152 BSTR WINAPI SysAllocString(LPCOLESTR str)
156 /* Delegate this to the SysAllocStringLen32 method. */
157 return SysAllocStringLen(str, lstrlenW(str));
160 /******************************************************************************
161 * SysFreeString [OLEAUT32.6]
166 * str [I] BSTR to free.
173 * str may be NULL, in which case this function does nothing.
175 void WINAPI SysFreeString(BSTR str)
177 DWORD* bufferPointer;
179 /* NULL is a valid parameter */
183 * We have to be careful when we free a BSTR pointer, it points to
184 * the beginning of the string but it skips the byte count contained
187 bufferPointer = (DWORD*)str;
192 * Free the memory from its "real" origin.
194 HeapFree(GetProcessHeap(), 0, bufferPointer);
197 /******************************************************************************
198 * SysAllocStringLen [OLEAUT32.4]
200 * Create a BSTR from an OLESTR of a given wide character length.
203 * str [I] Source to create BSTR from
204 * len [I] Length of oleStr in wide characters
207 * Success: A newly allocated BSTR from SysAllocStringByteLen()
208 * Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
211 * See BSTR(), SysAllocStringByteLen().
213 BSTR WINAPI SysAllocStringLen(const OLECHAR *str, unsigned int len)
219 /* Detect integer overflow. */
220 if (len >= ((UINT_MAX-sizeof(WCHAR)-sizeof(DWORD))/sizeof(WCHAR)))
223 * Find the length of the buffer passed-in, in bytes.
225 bufferSize = len * sizeof (WCHAR);
228 * Allocate a new buffer to hold the string.
229 * don't forget to keep an empty spot at the beginning of the
230 * buffer for the character count and an extra character at the
233 newBuffer = HeapAlloc(GetProcessHeap(), 0,
234 bufferSize + sizeof(WCHAR) + sizeof(DWORD));
237 * If the memory allocation failed, return a null pointer.
243 * Copy the length of the string in the placeholder.
245 *newBuffer = bufferSize;
248 * Skip the byte count.
253 * Copy the information in the buffer.
254 * Since it is valid to pass a NULL pointer here, we'll initialize the
255 * buffer to nul if it is the case.
258 memcpy(newBuffer, str, bufferSize);
260 memset(newBuffer, 0, bufferSize);
263 * Make sure that there is a nul character at the end of the
266 stringBuffer = (WCHAR*)newBuffer;
267 stringBuffer[len] = '\0';
269 return (LPWSTR)stringBuffer;
272 /******************************************************************************
273 * SysReAllocStringLen [OLEAUT32.5]
275 * Change the length of a previously created BSTR.
278 * old [O] BSTR to change the length of
279 * str [I] New source for pbstr
280 * len [I] Length of oleStr in wide characters
283 * Success: 1. The size of pbstr is updated.
284 * Failure: 0, if len >= 0x80000000 or memory allocation fails.
287 * See BSTR(), SysAllocStringByteLen().
288 * *old may be changed by this function.
290 int WINAPI SysReAllocStringLen(BSTR* old, const OLECHAR* str, unsigned int len)
292 /* Detect integer overflow. */
293 if (len >= ((UINT_MAX-sizeof(WCHAR)-sizeof(DWORD))/sizeof(WCHAR)))
297 DWORD newbytelen = len*sizeof(WCHAR);
298 DWORD *ptr = HeapReAlloc(GetProcessHeap(),0,((DWORD*)*old)-1,newbytelen+sizeof(WCHAR)+sizeof(DWORD));
299 *old = (BSTR)(ptr+1);
302 memmove(*old, str, newbytelen);
305 /* Subtle hidden feature: The old string data is still there
307 * Some Microsoft program needs it.
312 * Allocate the new string
314 *old = SysAllocStringLen(str, len);
320 /******************************************************************************
321 * SysAllocStringByteLen [OLEAUT32.150]
323 * Create a BSTR from an OLESTR of a given byte length.
326 * str [I] Source to create BSTR from
327 * len [I] Length of oleStr in bytes
330 * Success: A newly allocated BSTR
331 * Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
334 * -If len is 0 or oleStr is NULL the resulting string is empty ("").
335 * -This function always NUL terminates the resulting BSTR.
336 * -oleStr may be either an LPCSTR or LPCOLESTR, since it is copied
337 * without checking for a terminating NUL.
340 BSTR WINAPI SysAllocStringByteLen(LPCSTR str, UINT len)
345 /* Detect integer overflow. */
346 if (len >= (UINT_MAX-sizeof(WCHAR)-sizeof(DWORD)))
350 * Allocate a new buffer to hold the string.
351 * don't forget to keep an empty spot at the beginning of the
352 * buffer for the character count and an extra character at the
355 newBuffer = HeapAlloc(GetProcessHeap(), 0,
356 len + sizeof(WCHAR) + sizeof(DWORD));
359 * If the memory allocation failed, return a null pointer.
365 * Copy the length of the string in the placeholder.
370 * Skip the byte count.
375 * Copy the information in the buffer.
376 * Since it is valid to pass a NULL pointer here, we'll initialize the
377 * buffer to nul if it is the case.
380 memcpy(newBuffer, str, len);
383 * Make sure that there is a nul character at the end of the
386 stringBuffer = (char *)newBuffer;
387 stringBuffer[len] = 0;
388 stringBuffer[len+1] = 0;
390 return (LPWSTR)stringBuffer;
393 /******************************************************************************
394 * SysReAllocString [OLEAUT32.3]
396 * Change the length of a previously created BSTR.
399 * old [I/O] BSTR to change the length of
400 * str [I] New source for pbstr
407 * See BSTR(), SysAllocStringStringLen().
409 INT WINAPI SysReAllocString(LPBSTR old,LPCOLESTR str)
418 * Make sure we free the old string.
423 * Allocate the new string
425 *old = SysAllocString(str);
430 /******************************************************************************
431 * SetOaNoCache (OLEAUT32.327)
433 * Instruct Ole Automation not to cache BSTR allocations.
444 void WINAPI SetOaNoCache(void)
449 static const WCHAR _delimiter[2] = {'!',0}; /* default delimiter apparently */
450 static const WCHAR *pdelimiter = &_delimiter[0];
452 /***********************************************************************
453 * RegisterActiveObject (OLEAUT32.33)
455 * Registers an object in the global item table.
458 * punk [I] Object to register.
459 * rcid [I] CLSID of the object.
461 * pdwRegister [O] Address to store cookie of object registration in.
465 * Failure: HRESULT code.
467 HRESULT WINAPI RegisterActiveObject(
468 LPUNKNOWN punk,REFCLSID rcid,DWORD dwFlags,LPDWORD pdwRegister
472 LPRUNNINGOBJECTTABLE runobtable;
475 StringFromGUID2(rcid,guidbuf,39);
476 ret = CreateItemMoniker(pdelimiter,guidbuf,&moniker);
479 ret = GetRunningObjectTable(0,&runobtable);
481 IMoniker_Release(moniker);
484 ret = IRunningObjectTable_Register(runobtable,dwFlags,punk,moniker,pdwRegister);
485 IRunningObjectTable_Release(runobtable);
486 IMoniker_Release(moniker);
490 /***********************************************************************
491 * RevokeActiveObject (OLEAUT32.34)
493 * Revokes an object from the global item table.
496 * xregister [I] Registration cookie.
497 * reserved [I] Reserved. Set to NULL.
501 * Failure: HRESULT code.
503 HRESULT WINAPI RevokeActiveObject(DWORD xregister,LPVOID reserved)
505 LPRUNNINGOBJECTTABLE runobtable;
508 ret = GetRunningObjectTable(0,&runobtable);
509 if (FAILED(ret)) return ret;
510 ret = IRunningObjectTable_Revoke(runobtable,xregister);
511 if (SUCCEEDED(ret)) ret = S_OK;
512 IRunningObjectTable_Release(runobtable);
516 /***********************************************************************
517 * GetActiveObject (OLEAUT32.35)
519 * Gets an object from the global item table.
522 * rcid [I] CLSID of the object.
523 * preserved [I] Reserved. Set to NULL.
524 * ppunk [O] Address to store object into.
528 * Failure: HRESULT code.
530 HRESULT WINAPI GetActiveObject(REFCLSID rcid,LPVOID preserved,LPUNKNOWN *ppunk)
534 LPRUNNINGOBJECTTABLE runobtable;
537 StringFromGUID2(rcid,guidbuf,39);
538 ret = CreateItemMoniker(pdelimiter,guidbuf,&moniker);
541 ret = GetRunningObjectTable(0,&runobtable);
543 IMoniker_Release(moniker);
546 ret = IRunningObjectTable_GetObject(runobtable,moniker,ppunk);
547 IRunningObjectTable_Release(runobtable);
548 IMoniker_Release(moniker);
553 /***********************************************************************
554 * OaBuildVersion [OLEAUT32.170]
556 * Get the Ole Automation build version.
565 * Known oleaut32.dll versions:
566 *| OLE Ver. Comments Date Build Ver.
567 *| -------- ------------------------- ---- ---------
568 *| OLE 2.1 NT 1993-95 10 3023
570 *| Win32s Ver 1.1e 20 4049
571 *| OLE 2.20 W95/NT 1993-96 20 4112
572 *| OLE 2.20 W95/NT 1993-96 20 4118
573 *| OLE 2.20 W95/NT 1993-96 20 4122
574 *| OLE 2.30 W95/NT 1993-98 30 4265
575 *| OLE 2.40 NT?? 1993-98 40 4267
576 *| OLE 2.40 W98 SE orig. file 1993-98 40 4275
577 *| OLE 2.40 W2K orig. file 1993-XX 40 4514
579 * Currently the versions returned are 2.20 for Win3.1, 2.30 for Win95 & NT 3.51,
580 * and 2.40 for all later versions. The build number is maximum, i.e. 0xffff.
582 ULONG WINAPI OaBuildVersion(void)
584 switch(GetVersion() & 0x8000ffff) /* mask off build number */
586 case 0x80000a03: /* WIN31 */
587 return MAKELONG(0xffff, 20);
588 case 0x00003303: /* NT351 */
589 return MAKELONG(0xffff, 30);
590 case 0x80000004: /* WIN95; I'd like to use the "standard" w95 minor
591 version here (30), but as we still use w95
592 as default winver (which is good IMHO), I better
593 play safe and use the latest value for w95 for now.
594 Change this as soon as default winver gets changed
595 to something more recent */
596 case 0x80000a04: /* WIN98 */
597 case 0x00000004: /* NT40 */
598 case 0x00000005: /* W2K */
599 case 0x00000105: /* WinXP */
600 return MAKELONG(0xffff, 40);
602 FIXME("Version value not known yet. Please investigate it !\n");
603 return MAKELONG(0xffff, 40); /* for now return the same value as for w2k */
607 /******************************************************************************
608 * OleTranslateColor [OLEAUT32.421]
610 * Convert an OLE_COLOR to a COLORREF.
613 * clr [I] Color to convert
614 * hpal [I] Handle to a palette for the conversion
615 * pColorRef [O] Destination for converted color, or NULL to test if the conversion is ok
618 * Success: S_OK. The conversion is ok, and pColorRef contains the converted color if non-NULL.
619 * Failure: E_INVALIDARG, if any argument is invalid.
622 * Document the conversion rules.
624 HRESULT WINAPI OleTranslateColor(
630 BYTE b = HIBYTE(HIWORD(clr));
632 TRACE("(%08x, %p, %p)\n", clr, hpal, pColorRef);
635 * In case pColorRef is NULL, provide our own to simplify the code.
637 if (pColorRef == NULL)
638 pColorRef = &colorref;
645 *pColorRef = PALETTERGB(GetRValue(clr),
660 * Validate the palette index.
662 if (GetPaletteEntries(hpal, LOWORD(clr), 1, &pe) == 0)
677 int index = LOBYTE(LOWORD(clr));
680 * Validate GetSysColor index.
682 if ((index < COLOR_SCROLLBAR) || (index > COLOR_MENUBAR))
685 *pColorRef = GetSysColor(index);
697 extern HRESULT WINAPI OLEAUTPS_DllGetClassObject(REFCLSID, REFIID, LPVOID *) DECLSPEC_HIDDEN;
698 extern BOOL WINAPI OLEAUTPS_DllMain(HINSTANCE, DWORD, LPVOID) DECLSPEC_HIDDEN;
700 extern void _get_STDFONT_CF(LPVOID *);
701 extern void _get_STDPIC_CF(LPVOID *);
703 static HRESULT WINAPI PSDispatchFacBuf_QueryInterface(IPSFactoryBuffer *iface, REFIID riid, void **ppv)
705 if (IsEqualIID(riid, &IID_IUnknown) ||
706 IsEqualIID(riid, &IID_IPSFactoryBuffer))
708 IUnknown_AddRef(iface);
709 *ppv = (void *)iface;
712 return E_NOINTERFACE;
715 static ULONG WINAPI PSDispatchFacBuf_AddRef(IPSFactoryBuffer *iface)
720 static ULONG WINAPI PSDispatchFacBuf_Release(IPSFactoryBuffer *iface)
725 static HRESULT WINAPI PSDispatchFacBuf_CreateProxy(IPSFactoryBuffer *iface, IUnknown *pUnkOuter, REFIID riid, IRpcProxyBuffer **ppProxy, void **ppv)
727 IPSFactoryBuffer *pPSFB;
730 if (IsEqualIID(riid, &IID_IDispatch))
731 hr = OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch, &IID_IPSFactoryBuffer, (void **)&pPSFB);
733 hr = TMARSHAL_DllGetClassObject(&CLSID_PSOAInterface, &IID_IPSFactoryBuffer, (void **)&pPSFB);
735 if (FAILED(hr)) return hr;
737 hr = IPSFactoryBuffer_CreateProxy(pPSFB, pUnkOuter, riid, ppProxy, ppv);
739 IPSFactoryBuffer_Release(pPSFB);
743 static HRESULT WINAPI PSDispatchFacBuf_CreateStub(IPSFactoryBuffer *iface, REFIID riid, IUnknown *pUnkOuter, IRpcStubBuffer **ppStub)
745 IPSFactoryBuffer *pPSFB;
748 if (IsEqualIID(riid, &IID_IDispatch))
749 hr = OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch, &IID_IPSFactoryBuffer, (void **)&pPSFB);
751 hr = TMARSHAL_DllGetClassObject(&CLSID_PSOAInterface, &IID_IPSFactoryBuffer, (void **)&pPSFB);
753 if (FAILED(hr)) return hr;
755 hr = IPSFactoryBuffer_CreateStub(pPSFB, riid, pUnkOuter, ppStub);
757 IPSFactoryBuffer_Release(pPSFB);
761 static const IPSFactoryBufferVtbl PSDispatchFacBuf_Vtbl =
763 PSDispatchFacBuf_QueryInterface,
764 PSDispatchFacBuf_AddRef,
765 PSDispatchFacBuf_Release,
766 PSDispatchFacBuf_CreateProxy,
767 PSDispatchFacBuf_CreateStub
770 /* This is the whole PSFactoryBuffer object, just the vtableptr */
771 static const IPSFactoryBufferVtbl *pPSDispatchFacBuf = &PSDispatchFacBuf_Vtbl;
773 /***********************************************************************
774 * DllGetClassObject (OLEAUT32.@)
776 HRESULT WINAPI DllGetClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
779 if (IsEqualGUID(rclsid,&CLSID_StdFont)) {
780 if (IsEqualGUID(iid,&IID_IClassFactory)) {
781 _get_STDFONT_CF(ppv);
782 IClassFactory_AddRef((IClassFactory*)*ppv);
786 if (IsEqualGUID(rclsid,&CLSID_StdPicture)) {
787 if (IsEqualGUID(iid,&IID_IClassFactory)) {
789 IClassFactory_AddRef((IClassFactory*)*ppv);
793 if (IsEqualCLSID(rclsid, &CLSID_PSTypeInfo) ||
794 IsEqualCLSID(rclsid, &CLSID_PSTypeLib) ||
795 IsEqualCLSID(rclsid, &CLSID_PSEnumVariant)) {
796 return OLEAUTPS_DllGetClassObject(&CLSID_PSDispatch, iid, ppv);
798 if (IsEqualCLSID(rclsid, &CLSID_PSDispatch) && IsEqualIID(iid, &IID_IPSFactoryBuffer)) {
799 *ppv = &pPSDispatchFacBuf;
800 IPSFactoryBuffer_AddRef((IPSFactoryBuffer *)*ppv);
803 if (IsEqualGUID(rclsid,&CLSID_PSOAInterface)) {
804 if (S_OK==TMARSHAL_DllGetClassObject(rclsid,iid,ppv))
808 return OLEAUTPS_DllGetClassObject(rclsid, iid, ppv);
811 /***********************************************************************
812 * DllCanUnloadNow (OLEAUT32.@)
814 * Determine if this dll can be unloaded from the callers address space.
820 * Always returns S_FALSE. This dll cannot be unloaded.
822 HRESULT WINAPI DllCanUnloadNow(void)
827 /*****************************************************************************
828 * DllMain [OLEAUT32.@]
830 BOOL WINAPI DllMain(HINSTANCE hInstDll, DWORD fdwReason, LPVOID lpvReserved)
832 return OLEAUTPS_DllMain( hInstDll, fdwReason, lpvReserved );
835 /***********************************************************************
836 * OleIconToCursor (OLEAUT32.415)
838 HCURSOR WINAPI OleIconToCursor( HINSTANCE hinstExe, HICON hIcon)
840 FIXME("(%p,%p), partially implemented.\n",hinstExe,hIcon);
841 /* FIXME: make a extended conversation from HICON to HCURSOR */
842 return CopyCursor(hIcon);