Add prototype and fix RtlpNtCreateKey.
[wine] / dlls / oleaut32 / oleaut.c
1 /*
2  *      OLEAUT32
3  *
4  * Copyright 1999, 2000 Marcus Meissner
5  *
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.
10  *
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.
15  *
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include <stdarg.h>
22 #include <string.h>
23
24 #define COBJMACROS
25
26 #include "windef.h"
27 #include "winbase.h"
28 #include "wingdi.h"
29 #include "winuser.h"
30 #include "winerror.h"
31
32 #include "ole2.h"
33 #include "olectl.h"
34 #include "oleauto.h"
35
36 #include "tmarshal.h"
37
38 #include "wine/debug.h"
39
40 WINE_DEFAULT_DEBUG_CHANNEL(ole);
41
42 /* The OLE Automation ProxyStub Interface Class (aka Typelib Marshaler) */
43 extern const GUID CLSID_PSOAInterface;
44
45 /* IDispatch marshaler */
46 extern const GUID CLSID_PSDispatch;
47
48 static BOOL BSTR_bCache = TRUE; /* Cache allocations to minimise alloc calls? */
49
50 HMODULE OLEAUT32_hModule = NULL;
51
52 /******************************************************************************
53  * BSTR  {OLEAUT32}
54  *
55  * NOTES
56  *  BSTR is a simple typedef for a wide-character string used as the principle
57  *  string type in ole automation. When encapsulated in a Variant type they are
58  *  automatically copied and destroyed as the variant is processed.
59  *
60  *  The low level BSTR Api allows manipulation of these strings and is used by
61  *  higher level Api calls to manage the strings transparently to the caller.
62  *
63  *  Internally the BSTR type is allocated with space for a DWORD byte count before
64  *  the string data begins. This is undocumented and non-system code should not
65  *  access the count directly. Use SysStringLen() or SysStringByteLen()
66  *  instead. Note that the byte count does not include the terminating NUL.
67  *
68  *  To create a new BSTR, use SysAllocString(), SysAllocStringLen() or
69  *  SysAllocStringByteLen(). To change the size of an existing BSTR, use SysReAllocString()
70  *  or SysReAllocStringLen(). Finally to destroy a string use SysFreeString().
71  *
72  *  BSTR's are cached by Ole Automation by default. To override this behaviour
73  *  either set the environment variable 'OANOCACHE', or call SetOaNoCache().
74  *
75  * SEE ALSO
76  *  'Inside OLE, second edition' by Kraig Brockshmidt.
77  */
78
79 /******************************************************************************
80  *             SysStringLen  [OLEAUT32.7]
81  *
82  * Get the allocated length of a BSTR in wide characters.
83  *
84  * PARAMS
85  *  str [I] BSTR to find the length of
86  *
87  * RETURNS
88  *  The allocated length of str, or 0 if str is NULL.
89  *
90  * NOTES
91  *  See BSTR.
92  *  The returned length may be different from the length of the string as
93  *  calculated by lstrlenW(), since it returns the length that was used to
94  *  allocate the string by SysAllocStringLen().
95  */
96 UINT WINAPI SysStringLen(BSTR str)
97 {
98     DWORD* bufferPointer;
99
100      if (!str) return 0;
101     /*
102      * The length of the string (in bytes) is contained in a DWORD placed
103      * just before the BSTR pointer
104      */
105     bufferPointer = (DWORD*)str;
106
107     bufferPointer--;
108
109     return (int)(*bufferPointer/sizeof(WCHAR));
110 }
111
112 /******************************************************************************
113  *             SysStringByteLen  [OLEAUT32.149]
114  *
115  * Get the allocated length of a BSTR in bytes.
116  *
117  * PARAMS
118  *  str [I] BSTR to find the length of
119  *
120  * RETURNS
121  *  The allocated length of str, or 0 if str is NULL.
122  *
123  * NOTES
124  *  See SysStringLen(), BSTR().
125  */
126 UINT WINAPI SysStringByteLen(BSTR str)
127 {
128     DWORD* bufferPointer;
129
130      if (!str) return 0;
131     /*
132      * The length of the string (in bytes) is contained in a DWORD placed
133      * just before the BSTR pointer
134      */
135     bufferPointer = (DWORD*)str;
136
137     bufferPointer--;
138
139     return (int)(*bufferPointer);
140 }
141
142 /******************************************************************************
143  *              SysAllocString  [OLEAUT32.2]
144  *
145  * Create a BSTR from an OLESTR.
146  *
147  * PARAMS
148  *  str [I] Source to create BSTR from
149  *
150  * RETURNS
151  *  Success: A BSTR allocated with SysAllocStringLen().
152  *  Failure: NULL, if oleStr is NULL.
153  *
154  * NOTES
155  *  See BSTR.
156  *  MSDN (October 2001) incorrectly states that NULL is returned if oleStr has
157  *  a length of 0. Native Win32 and this implementation both return a valid
158  *  empty BSTR in this case.
159  */
160 BSTR WINAPI SysAllocString(LPCOLESTR str)
161 {
162     if (!str) return 0;
163
164     /* Delegate this to the SysAllocStringLen32 method. */
165     return SysAllocStringLen(str, lstrlenW(str));
166 }
167
168 /******************************************************************************
169  *              SysFreeString   [OLEAUT32.6]
170  *
171  * Free a BSTR.
172  *
173  * PARAMS
174  *  str [I] BSTR to free.
175  *
176  * RETURNS
177  *  Nothing.
178  *
179  * NOTES
180  *  See BSTR.
181  *  str may be NULL, in which case this function does nothing.
182  */
183 void WINAPI SysFreeString(BSTR str)
184 {
185     DWORD* bufferPointer;
186
187     /* NULL is a valid parameter */
188     if(!str) return;
189
190     /*
191      * We have to be careful when we free a BSTR pointer, it points to
192      * the beginning of the string but it skips the byte count contained
193      * before the string.
194      */
195     bufferPointer = (DWORD*)str;
196
197     bufferPointer--;
198
199     /*
200      * Free the memory from its "real" origin.
201      */
202     HeapFree(GetProcessHeap(), 0, bufferPointer);
203 }
204
205 /******************************************************************************
206  *             SysAllocStringLen     [OLEAUT32.4]
207  *
208  * Create a BSTR from an OLESTR of a given wide character length.
209  *
210  * PARAMS
211  *  str [I] Source to create BSTR from
212  *  len [I] Length of oleStr in wide characters
213  *
214  * RETURNS
215  *  Success: A newly allocated BSTR from SysAllocStringByteLen()
216  *  Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
217  *
218  * NOTES
219  *  See BSTR(), SysAllocStringByteLen().
220  */
221 BSTR WINAPI SysAllocStringLen(const OLECHAR *str, unsigned int len)
222 {
223     DWORD  bufferSize;
224     DWORD* newBuffer;
225     WCHAR* stringBuffer;
226
227     /*
228      * Find the length of the buffer passed-in in bytes.
229      */
230     bufferSize = len * sizeof (WCHAR);
231
232     /*
233      * Allocate a new buffer to hold the string.
234      * don't forget to keep an empty spot at the beginning of the
235      * buffer for the character count and an extra character at the
236      * end for the NULL.
237      */
238     newBuffer = HeapAlloc(GetProcessHeap(), 0,
239                           bufferSize + sizeof(WCHAR) + sizeof(DWORD));
240
241     /*
242      * If the memory allocation failed, return a null pointer.
243      */
244     if (newBuffer==0)
245       return 0;
246
247     /*
248      * Copy the length of the string in the placeholder.
249      */
250     *newBuffer = bufferSize;
251
252     /*
253      * Skip the byte count.
254      */
255     newBuffer++;
256
257     /*
258      * Copy the information in the buffer.
259      * Since it is valid to pass a NULL pointer here, we'll initialize the
260      * buffer to nul if it is the case.
261      */
262     if (str != 0)
263       memcpy(newBuffer, str, bufferSize);
264     else
265       memset(newBuffer, 0, bufferSize);
266
267     /*
268      * Make sure that there is a nul character at the end of the
269      * string.
270      */
271     stringBuffer = (WCHAR*)newBuffer;
272     stringBuffer[len] = L'\0';
273
274     return (LPWSTR)stringBuffer;
275 }
276
277 /******************************************************************************
278  *             SysReAllocStringLen   [OLEAUT32.5]
279  *
280  * Change the length of a previously created BSTR.
281  *
282  * PARAMS
283  *  old [O] BSTR to change the length of
284  *  str [I] New source for pbstr
285  *  len [I] Length of oleStr in wide characters
286  *
287  * RETURNS
288  *  Success: 1. The size of pbstr is updated.
289  *  Failure: 0, if len >= 0x80000000 or memory allocation fails.
290  *
291  * NOTES
292  *  See BSTR(), SysAllocStringByteLen().
293  *  *pbstr may be changed by this function.
294  */
295 int WINAPI SysReAllocStringLen(BSTR* old, const OLECHAR* str, unsigned int len)
296 {
297     if (*old!=NULL) {
298       DWORD newbytelen = len*sizeof(WCHAR);
299       DWORD *ptr = HeapReAlloc(GetProcessHeap(),0,((DWORD*)*old)-1,newbytelen+sizeof(WCHAR)+sizeof(DWORD));
300       *old = (BSTR)(ptr+1);
301       *ptr = newbytelen;
302       if (str) {
303         memcpy(*old, str, newbytelen);
304         (*old)[len] = 0;
305       } else {
306         /* Subtle hidden feature: The old string data is still there
307          * when 'in' is NULL!
308          * Some Microsoft program needs it.
309          */
310       }
311     } else {
312       /*
313        * Allocate the new string
314        */
315       *old = SysAllocStringLen(str, len);
316     }
317
318     return 1;
319 }
320
321 /******************************************************************************
322  *             SysAllocStringByteLen     [OLEAUT32.150]
323  *
324  * Create a BSTR from an OLESTR of a given byte length.
325  *
326  * PARAMS
327  *  str [I] Source to create BSTR from
328  *  len [I] Length of oleStr in bytes
329  *
330  * RETURNS
331  *  Success: A newly allocated BSTR
332  *  Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
333  *
334  * NOTES
335  *  -If len is 0 or oleStr is NULL the resulting string is empty ("").
336  *  -This function always NUL terminates the resulting BSTR.
337  *  -oleStr may be either an LPCSTR or LPCOLESTR, since it is copied
338  *  without checking for a terminating NUL.
339  *  See BSTR.
340  */
341 BSTR WINAPI SysAllocStringByteLen(LPCSTR str, UINT len)
342 {
343     DWORD* newBuffer;
344     char* stringBuffer;
345
346     /*
347      * Allocate a new buffer to hold the string.
348      * don't forget to keep an empty spot at the beginning of the
349      * buffer for the character count and an extra character at the
350      * end for the NULL.
351      */
352     newBuffer = HeapAlloc(GetProcessHeap(), 0,
353                           len + sizeof(WCHAR) + sizeof(DWORD));
354
355     /*
356      * If the memory allocation failed, return a null pointer.
357      */
358     if (newBuffer==0)
359       return 0;
360
361     /*
362      * Copy the length of the string in the placeholder.
363      */
364     *newBuffer = len;
365
366     /*
367      * Skip the byte count.
368      */
369     newBuffer++;
370
371     /*
372      * Copy the information in the buffer.
373      * Since it is valid to pass a NULL pointer here, we'll initialize the
374      * buffer to nul if it is the case.
375      */
376     if (str != 0)
377       memcpy(newBuffer, str, len);
378
379     /*
380      * Make sure that there is a nul character at the end of the
381      * string.
382      */
383     stringBuffer = (char *)newBuffer;
384     stringBuffer[len] = 0;
385     stringBuffer[len+1] = 0;
386
387     return (LPWSTR)stringBuffer;
388 }
389
390 /******************************************************************************
391  *              SysReAllocString        [OLEAUT32.3]
392  *
393  * Change the length of a previously created BSTR.
394  *
395  * PARAMS
396  *  old [I/O] BSTR to change the length of
397  *  str [I]   New source for pbstr
398  *
399  * RETURNS
400  *  Success: 1
401  *  Failure: 0.
402  *
403  * NOTES
404  *  See BSTR(), SysAllocStringStringLen().
405  */
406 INT WINAPI SysReAllocString(LPBSTR old,LPCOLESTR str)
407 {
408     /*
409      * Sanity check
410      */
411     if (old==NULL)
412       return 0;
413
414     /*
415      * Make sure we free the old string.
416      */
417     if (*old!=NULL)
418       SysFreeString(*old);
419
420     /*
421      * Allocate the new string
422      */
423     *old = SysAllocString(str);
424
425      return 1;
426 }
427
428 /******************************************************************************
429  *              SetOaNoCache (OLEAUT32.327)
430  *
431  * Instruct Ole Automation not to cache BSTR allocations.
432  *
433  * PARAMS
434  *  None.
435  *
436  * RETURNS
437  *  Nothing.
438  *
439  * NOTES
440  *  See BSTR.
441  */
442 void WINAPI SetOaNoCache(void)
443 {
444   BSTR_bCache = FALSE;
445 }
446
447 static WCHAR    _delimiter[2] = {'!',0}; /* default delimiter apparently */
448 static WCHAR    *pdelimiter = &_delimiter[0];
449
450 /***********************************************************************
451  *              RegisterActiveObject (OLEAUT32.33)
452  */
453 HRESULT WINAPI RegisterActiveObject(
454         LPUNKNOWN punk,REFCLSID rcid,DWORD dwFlags,LPDWORD pdwRegister
455 ) {
456         WCHAR                   guidbuf[80];
457         HRESULT                 ret;
458         LPRUNNINGOBJECTTABLE    runobtable;
459         LPMONIKER               moniker;
460
461         StringFromGUID2(rcid,guidbuf,39);
462         ret = CreateItemMoniker(pdelimiter,guidbuf,&moniker);
463         if (FAILED(ret))
464                 return ret;
465         ret = GetRunningObjectTable(0,&runobtable);
466         if (FAILED(ret)) {
467                 IMoniker_Release(moniker);
468                 return ret;
469         }
470         ret = IRunningObjectTable_Register(runobtable,dwFlags,punk,moniker,pdwRegister);
471         IRunningObjectTable_Release(runobtable);
472         IMoniker_Release(moniker);
473         return ret;
474 }
475
476 /***********************************************************************
477  *              RevokeActiveObject (OLEAUT32.34)
478  */
479 HRESULT WINAPI RevokeActiveObject(DWORD xregister,LPVOID reserved)
480 {
481         LPRUNNINGOBJECTTABLE    runobtable;
482         HRESULT                 ret;
483
484         ret = GetRunningObjectTable(0,&runobtable);
485         if (FAILED(ret)) return ret;
486         ret = IRunningObjectTable_Revoke(runobtable,xregister);
487         if (SUCCEEDED(ret)) ret = S_OK;
488         IRunningObjectTable_Release(runobtable);
489         return ret;
490 }
491
492 /***********************************************************************
493  *              GetActiveObject (OLEAUT32.35)
494  */
495 HRESULT WINAPI GetActiveObject(REFCLSID rcid,LPVOID preserved,LPUNKNOWN *ppunk)
496 {
497         WCHAR                   guidbuf[80];
498         HRESULT                 ret;
499         LPRUNNINGOBJECTTABLE    runobtable;
500         LPMONIKER               moniker;
501
502         StringFromGUID2(rcid,guidbuf,39);
503         ret = CreateItemMoniker(pdelimiter,guidbuf,&moniker);
504         if (FAILED(ret))
505                 return ret;
506         ret = GetRunningObjectTable(0,&runobtable);
507         if (FAILED(ret)) {
508                 IMoniker_Release(moniker);
509                 return ret;
510         }
511         ret = IRunningObjectTable_GetObject(runobtable,moniker,ppunk);
512         IRunningObjectTable_Release(runobtable);
513         IMoniker_Release(moniker);
514         return ret;
515 }
516
517
518 /***********************************************************************
519  *           OaBuildVersion           [OLEAUT32.170]
520  *
521  * Get the Ole Automation build version.
522  *
523  * PARAMS
524  *  None
525  *
526  * RETURNS
527  *  The build version.
528  *
529  * NOTES
530  *  Known oleaut32.dll versions:
531  *| OLE Ver.  Comments                   Date     Build Ver.
532  *| --------  -------------------------  ----     ---------
533  *| OLE 2.1   NT                         1993-95  10 3023
534  *| OLE 2.1                                       10 3027
535  *| Win32s    Ver 1.1e                            20 4049
536  *| OLE 2.20  W95/NT                     1993-96  20 4112
537  *| OLE 2.20  W95/NT                     1993-96  20 4118
538  *| OLE 2.20  W95/NT                     1993-96  20 4122
539  *| OLE 2.30  W95/NT                     1993-98  30 4265
540  *| OLE 2.40  NT??                       1993-98  40 4267
541  *| OLE 2.40  W98 SE orig. file          1993-98  40 4275
542  *| OLE 2.40  W2K orig. file             1993-XX  40 4514
543  *
544  * Currently the versions returned are 2.20 for Win3.1, 2.30 for Win95 & NT 3.51,
545  * and 2.40 for all later versions. The build number is maximum, i.e. 0xffff.
546  */
547 ULONG WINAPI OaBuildVersion()
548 {
549     switch(GetVersion() & 0x8000ffff)  /* mask off build number */
550     {
551     case 0x80000a03:  /* WIN31 */
552                 return MAKELONG(0xffff, 20);
553     case 0x00003303:  /* NT351 */
554                 return MAKELONG(0xffff, 30);
555     case 0x80000004:  /* WIN95; I'd like to use the "standard" w95 minor
556                          version here (30), but as we still use w95
557                          as default winver (which is good IMHO), I better
558                          play safe and use the latest value for w95 for now.
559                          Change this as soon as default winver gets changed
560                          to something more recent */
561     case 0x80000a04:  /* WIN98 */
562     case 0x00000004:  /* NT40 */
563     case 0x00000005:  /* W2K */
564     case 0x00000105:  /* WinXP */
565                 return MAKELONG(0xffff, 40);
566     default:
567                 FIXME("Version value not known yet. Please investigate it !\n");
568                 return MAKELONG(0xffff, 40);  /* for now return the same value as for w2k */
569     }
570 }
571
572 /******************************************************************************
573  *              OleTranslateColor       [OLEAUT32.421]
574  *
575  * Convert an OLE_COLOR to a COLORREF.
576  *
577  * PARAMS
578  *  clr       [I] Color to convert
579  *  hpal      [I] Handle to a palette for the conversion
580  *  pColorRef [O] Destination for converted color, or NULL to test if the conversion is ok
581  *
582  * RETURNS
583  *  Success: S_OK. The conversion is ok, and pColorRef contains the converted color if non-NULL.
584  *  Failure: E_INVALIDARG, if any argument is invalid.
585  *
586  * FIXME
587  *  Document the conversion rules.
588  */
589 HRESULT WINAPI OleTranslateColor(
590   OLE_COLOR clr,
591   HPALETTE  hpal,
592   COLORREF* pColorRef)
593 {
594   COLORREF colorref;
595   BYTE b = HIBYTE(HIWORD(clr));
596
597   TRACE("(%08lx, %p, %p):stub\n", clr, hpal, pColorRef);
598
599   /*
600    * In case pColorRef is NULL, provide our own to simplify the code.
601    */
602   if (pColorRef == NULL)
603     pColorRef = &colorref;
604
605   switch (b)
606   {
607     case 0x00:
608     {
609       if (hpal != 0)
610         *pColorRef =  PALETTERGB(GetRValue(clr),
611                                  GetGValue(clr),
612                                  GetBValue(clr));
613       else
614         *pColorRef = clr;
615
616       break;
617     }
618
619     case 0x01:
620     {
621       if (hpal != 0)
622       {
623         PALETTEENTRY pe;
624         /*
625          * Validate the palette index.
626          */
627         if (GetPaletteEntries(hpal, LOWORD(clr), 1, &pe) == 0)
628           return E_INVALIDARG;
629       }
630
631       *pColorRef = clr;
632
633       break;
634     }
635
636     case 0x02:
637       *pColorRef = clr;
638       break;
639
640     case 0x80:
641     {
642       int index = LOBYTE(LOWORD(clr));
643
644       /*
645        * Validate GetSysColor index.
646        */
647       if ((index < COLOR_SCROLLBAR) || (index > COLOR_MENUBAR))
648         return E_INVALIDARG;
649
650       *pColorRef =  GetSysColor(index);
651
652       break;
653     }
654
655     default:
656       return E_INVALIDARG;
657   }
658
659   return S_OK;
660 }
661
662 extern HRESULT OLEAUTPS_DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv);
663
664 extern void _get_STDFONT_CF(LPVOID);
665 extern void _get_STDPIC_CF(LPVOID);
666
667 /***********************************************************************
668  *              DllGetClassObject (OLEAUT32.1)
669  */
670 HRESULT WINAPI OLEAUT32_DllGetClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv)
671 {
672     *ppv = NULL;
673     if (IsEqualGUID(rclsid,&CLSID_StdFont)) {
674         if (IsEqualGUID(iid,&IID_IClassFactory)) {
675             _get_STDFONT_CF(ppv);
676             IClassFactory_AddRef((IClassFactory*)*ppv);
677             return S_OK;
678         }
679     }
680     if (IsEqualGUID(rclsid,&CLSID_StdPicture)) {
681         if (IsEqualGUID(iid,&IID_IClassFactory)) {
682             _get_STDPIC_CF(ppv);
683             IClassFactory_AddRef((IClassFactory*)*ppv);
684             return S_OK;
685         }
686     }
687     if (IsEqualGUID(rclsid,&CLSID_PSDispatch)) {
688         return OLEAUTPS_DllGetClassObject(rclsid,iid,ppv);
689     }
690     if (IsEqualGUID(rclsid,&CLSID_PSOAInterface)) {
691         if (S_OK==TypeLibFac_DllGetClassObject(rclsid,iid,ppv))
692             return S_OK;
693         /*FALLTHROUGH*/
694     }
695     FIXME("\n\tCLSID:\t%s,\n\tIID:\t%s\n",debugstr_guid(rclsid),debugstr_guid(iid));
696     return CLASS_E_CLASSNOTAVAILABLE;
697 }
698
699 /***********************************************************************
700  *              DllCanUnloadNow (OLEAUT32.410)
701  *
702  * Determine if this dll can be unloaded from the callers address space.
703  *
704  * PARAMS
705  *  None.
706  *
707  * RETURNS
708  *  Always returns S_FALSE. This dll cannot be unloaded.
709  */
710 HRESULT WINAPI OLEAUT32_DllCanUnloadNow(void)
711 {
712     return S_FALSE;
713 }
714
715 /*****************************************************************************
716  *              DllMain         [OLEAUT32.@]
717  */
718 BOOL WINAPI DllMain(HINSTANCE hInstDll, DWORD fdwReason, LPVOID lpvReserved)
719 {
720   TRACE("(%p,%lu,%p)\n", hInstDll, fdwReason, lpvReserved);
721
722   switch (fdwReason) {
723   case DLL_PROCESS_ATTACH:
724     DisableThreadLibraryCalls(hInstDll);
725     OLEAUT32_hModule = (HMODULE)hInstDll;
726     break;
727   case DLL_PROCESS_DETACH:
728     break;
729   };
730
731   return TRUE;
732 }