wined3d: Use a proper structure for "loop_control".
[wine] / dlls / oleaut32 / regsvr.c
1 /*
2  *      self-registerable dll functions for oleaut32.dll
3  *
4  * Copyright (C) 2003 John K. Hohm
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include <stdarg.h>
22 #include <string.h>
23
24 #include "windef.h"
25 #include "winbase.h"
26 #include "winuser.h"
27 #include "winreg.h"
28 #include "winerror.h"
29
30 #include "ole2.h"
31 #include "olectl.h"
32 #include "oleauto.h"
33 #include "initguid.h"
34 #include "typelib.h"
35
36 #include "wine/debug.h"
37 #include "wine/unicode.h"
38
39 WINE_DEFAULT_DEBUG_CHANNEL(ole);
40
41 /*
42  * Near the bottom of this file are the exported DllRegisterServer and
43  * DllUnregisterServer, which make all this worthwhile.
44  */
45
46 /***********************************************************************
47  *              interface for self-registering
48  */
49 struct regsvr_interface
50 {
51     IID const *iid;             /* NULL for end of list */
52     LPCSTR name;                /* can be NULL to omit */
53     IID const *base_iid;        /* can be NULL to omit */
54     int num_methods;            /* can be <0 to omit */
55     CLSID const *ps_clsid;      /* can be NULL to omit */
56     CLSID const *ps_clsid32;    /* can be NULL to omit */
57 };
58
59 static HRESULT register_interfaces(struct regsvr_interface const *list);
60 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
61
62 struct regsvr_coclass
63 {
64     CLSID const *clsid;         /* NULL for end of list */
65     LPCSTR name;                /* can be NULL to omit */
66     LPCSTR ips;                 /* can be NULL to omit */
67     LPCSTR ips32;               /* can be NULL to omit */
68     LPCSTR ips32_tmodel;        /* can be NULL to omit */
69     LPCSTR clsid_str;           /* can be NULL to omit */
70     LPCSTR progid;              /* can be NULL to omit */
71 };
72
73 static HRESULT register_coclasses(struct regsvr_coclass const *list);
74 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
75
76 /***********************************************************************
77  *              static string constants
78  */
79 static WCHAR const interface_keyname[10] = {
80     'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
81 static WCHAR const base_ifa_keyname[14] = {
82     'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
83     'e', 0 };
84 static WCHAR const num_methods_keyname[11] = {
85     'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
86 static WCHAR const ps_clsid_keyname[15] = {
87     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
88     'i', 'd', 0 };
89 static WCHAR const ps_clsid32_keyname[17] = {
90     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
91     'i', 'd', '3', '2', 0 };
92 static WCHAR const clsid_keyname[6] = {
93     'C', 'L', 'S', 'I', 'D', 0 };
94 static WCHAR const ips_keyname[13] = {
95     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
96     0 };
97 static WCHAR const ips32_keyname[15] = {
98     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
99     '3', '2', 0 };
100 static WCHAR const progid_keyname[7] = {
101     'P', 'r', 'o', 'g', 'I', 'D', 0 };
102 static char const tmodel_valuename[] = "ThreadingModel";
103
104 /***********************************************************************
105  *              static helper functions
106  */
107 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
108 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
109                                    WCHAR const *value);
110 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
111                                    char const *value);
112
113 /***********************************************************************
114  *              register_interfaces
115  */
116 static HRESULT register_interfaces(struct regsvr_interface const *list)
117 {
118     LONG res = ERROR_SUCCESS;
119     HKEY interface_key;
120
121     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
122                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
123     if (res != ERROR_SUCCESS) goto error_return;
124
125     for (; res == ERROR_SUCCESS && list->iid; ++list) {
126         WCHAR buf[39];
127         HKEY iid_key;
128
129         StringFromGUID2(list->iid, buf, 39);
130         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
131                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
132         if (res != ERROR_SUCCESS) goto error_close_interface_key;
133
134         if (list->name) {
135             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
136                                  (CONST BYTE*)(list->name),
137                                  strlen(list->name) + 1);
138             if (res != ERROR_SUCCESS) goto error_close_iid_key;
139         }
140
141         if (list->base_iid) {
142             res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
143             if (res != ERROR_SUCCESS) goto error_close_iid_key;
144         }
145
146         if (0 <= list->num_methods) {
147             static WCHAR const fmt[3] = { '%', 'd', 0 };
148             HKEY key;
149
150             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
151                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
152             if (res != ERROR_SUCCESS) goto error_close_iid_key;
153
154             sprintfW(buf, fmt, list->num_methods);
155             res = RegSetValueExW(key, NULL, 0, REG_SZ,
156                                  (CONST BYTE*)buf,
157                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
158             RegCloseKey(key);
159
160             if (res != ERROR_SUCCESS) goto error_close_iid_key;
161         }
162
163         if (list->ps_clsid) {
164             res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
165             if (res != ERROR_SUCCESS) goto error_close_iid_key;
166         }
167
168         if (list->ps_clsid32) {
169             res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
170             if (res != ERROR_SUCCESS) goto error_close_iid_key;
171         }
172
173     error_close_iid_key:
174         RegCloseKey(iid_key);
175     }
176
177 error_close_interface_key:
178     RegCloseKey(interface_key);
179 error_return:
180     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
181 }
182
183 /***********************************************************************
184  *              unregister_interfaces
185  */
186 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
187 {
188     LONG res = ERROR_SUCCESS;
189     HKEY interface_key;
190
191     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
192                         KEY_READ | KEY_WRITE, &interface_key);
193     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
194     if (res != ERROR_SUCCESS) goto error_return;
195
196     for (; res == ERROR_SUCCESS && list->iid; ++list) {
197         WCHAR buf[39];
198
199         StringFromGUID2(list->iid, buf, 39);
200         res = RegDeleteTreeW(interface_key, buf);
201         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
202     }
203
204     RegCloseKey(interface_key);
205 error_return:
206     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
207 }
208
209 /***********************************************************************
210  *              register_coclasses
211  */
212 static HRESULT register_coclasses(struct regsvr_coclass const *list)
213 {
214     LONG res = ERROR_SUCCESS;
215     HKEY coclass_key;
216
217     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
218                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
219     if (res != ERROR_SUCCESS) goto error_return;
220
221     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
222         WCHAR buf[39];
223         HKEY clsid_key;
224
225         StringFromGUID2(list->clsid, buf, 39);
226         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
227                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
228         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
229
230         if (list->name) {
231             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
232                                  (CONST BYTE*)(list->name),
233                                  strlen(list->name) + 1);
234             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
235         }
236
237         if (list->ips) {
238             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
239             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
240         }
241
242         if (list->ips32) {
243             HKEY ips32_key;
244
245             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
246                                   KEY_READ | KEY_WRITE, NULL,
247                                   &ips32_key, NULL);
248             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
249
250             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
251                                  (CONST BYTE*)list->ips32,
252                                  lstrlenA(list->ips32) + 1);
253             if (res == ERROR_SUCCESS && list->ips32_tmodel)
254                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
255                                      (CONST BYTE*)list->ips32_tmodel,
256                                      strlen(list->ips32_tmodel) + 1);
257             RegCloseKey(ips32_key);
258             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
259         }
260
261         if (list->clsid_str) {
262             res = register_key_defvalueA(clsid_key, clsid_keyname,
263                                          list->clsid_str);
264             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
265         }
266
267         if (list->progid) {
268             HKEY progid_key;
269
270             res = register_key_defvalueA(clsid_key, progid_keyname,
271                                          list->progid);
272             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
273
274             res = RegCreateKeyExA(HKEY_CLASSES_ROOT, list->progid, 0,
275                                   NULL, 0, KEY_READ | KEY_WRITE, NULL,
276                                   &progid_key, NULL);
277             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
278
279             res = register_key_defvalueW(progid_key, clsid_keyname, buf);
280             RegCloseKey(progid_key);
281             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
282         }
283
284     error_close_clsid_key:
285         RegCloseKey(clsid_key);
286     }
287
288 error_close_coclass_key:
289     RegCloseKey(coclass_key);
290 error_return:
291     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
292 }
293
294 /***********************************************************************
295  *              unregister_coclasses
296  */
297 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
298 {
299     LONG res = ERROR_SUCCESS;
300     HKEY coclass_key;
301
302     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
303                         KEY_READ | KEY_WRITE, &coclass_key);
304     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
305     if (res != ERROR_SUCCESS) goto error_return;
306
307     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
308         WCHAR buf[39];
309
310         StringFromGUID2(list->clsid, buf, 39);
311         res = RegDeleteTreeW(coclass_key, buf);
312         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
313         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
314
315         if (list->progid) {
316             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->progid);
317             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
318             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
319         }
320     }
321
322 error_close_coclass_key:
323     RegCloseKey(coclass_key);
324 error_return:
325     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
326 }
327
328 /***********************************************************************
329  *              regsvr_key_guid
330  */
331 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
332 {
333     WCHAR buf[39];
334
335     StringFromGUID2(guid, buf, 39);
336     return register_key_defvalueW(base, name, buf);
337 }
338
339 /***********************************************************************
340  *              regsvr_key_defvalueW
341  */
342 static LONG register_key_defvalueW(
343     HKEY base,
344     WCHAR const *name,
345     WCHAR const *value)
346 {
347     LONG res;
348     HKEY key;
349
350     res = RegCreateKeyExW(base, name, 0, NULL, 0,
351                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
352     if (res != ERROR_SUCCESS) return res;
353     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
354                          (lstrlenW(value) + 1) * sizeof(WCHAR));
355     RegCloseKey(key);
356     return res;
357 }
358
359 /***********************************************************************
360  *              regsvr_key_defvalueA
361  */
362 static LONG register_key_defvalueA(
363     HKEY base,
364     WCHAR const *name,
365     char const *value)
366 {
367     LONG res;
368     HKEY key;
369
370     res = RegCreateKeyExW(base, name, 0, NULL, 0,
371                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
372     if (res != ERROR_SUCCESS) return res;
373     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
374                          lstrlenA(value) + 1);
375     RegCloseKey(key);
376     return res;
377 }
378
379 /***********************************************************************
380  *              coclass list
381  */
382 static GUID const CLSID_RecordInfo = {
383     0x0000002F, 0x0000, 0x0000, {0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46} };
384
385 static GUID const CLSID_OldFont = {
386     0x46763EE0, 0xCAB2, 0x11CE, {0x8C,0x20,0x00,0xAA,0x00,0x51,0xE5,0xD4} };
387
388 static GUID const CLSID_PSFactoryBuffer = {
389     0xB196B286, 0xBAB4, 0x101A, {0xB6,0x9C,0x00,0xAA,0x00,0x34,0x1D,0x07} };
390
391 static struct regsvr_coclass const coclass_list[] = {
392     {   &CLSID_RecordInfo,
393         "CLSID_RecordInfo",
394         NULL,
395         "oleaut32.dll",
396         "Both"
397     },
398     {   &CLSID_PSDispatch,
399         "PSDispatch",
400         "ole2disp.dll",
401         "oleaut32.dll",
402         "Both"
403     },
404     {   &CLSID_StdFont,
405         "CLSID_StdFont",
406         NULL,
407         "oleaut32.dll",
408         "Both",
409         "Standard Font",
410         "StdFont"
411     },
412     {   &CLSID_StdPicture,
413         "CLSID_StdPict",
414         NULL,
415         "oleaut32.dll",
416         "Apartment",
417         "Standard Picture",
418         "StdPicture"
419     },
420     {   &CLSID_PSEnumVariant,
421         "PSEnumVariant",
422         "ole2disp.dll",
423         "oleaut32.dll",
424         "Both"
425     },
426     {   &CLSID_PSTypeInfo,
427         "PSTypeInfo",
428         "ole2disp.dll",
429         "oleaut32.dll",
430         "Both"
431     },
432     {   &CLSID_PSTypeLib,
433         "PSTypeLib",
434         "ole2disp.dll",
435         "oleaut32.dll",
436         "Both"
437     },
438     {   &CLSID_PSOAInterface,
439         "PSOAInterface",
440         "ole2disp.dll",
441         "oleaut32.dll",
442         "Both"
443     },
444     {   &CLSID_PSTypeComp,
445         "PSTypeComp",
446         "ole2disp.dll",
447         "oleaut32.dll",
448         "Both"
449     },
450     {   &CLSID_OldFont,
451         "Obsolete Font",
452         NULL,
453         "oleaut32.dll",
454         NULL,
455         "Obsolete Font",
456         "OldFont"
457     },
458     {   &CLSID_PSFactoryBuffer,
459         "PSFactoryBuffer",
460         NULL,
461         "oleaut32.dll",
462         "Both"
463     },
464     { NULL }                    /* list terminator */
465 };
466
467 /***********************************************************************
468  *              interface list
469  */
470 #define INTERFACE_ENTRY(interface, clsid16, clsid32) { &IID_##interface, #interface, NULL, sizeof(interface##Vtbl)/sizeof(void*), clsid16, clsid32 }
471 #define LCL_INTERFACE_ENTRY(interface) INTERFACE_ENTRY(interface, NULL, NULL)
472 #define PSFAC_INTERFACE_ENTRY(interface) INTERFACE_ENTRY(interface, NULL, &CLSID_PSFactoryBuffer)
473 #define CLSID_INTERFACE_ENTRY(interface,clsid) INTERFACE_ENTRY(interface, clsid, clsid)
474
475 static struct regsvr_interface const interface_list[] = {
476     LCL_INTERFACE_ENTRY(ICreateTypeInfo),
477     LCL_INTERFACE_ENTRY(ICreateTypeLib),
478     CLSID_INTERFACE_ENTRY(IDispatch,&CLSID_PSDispatch),
479     CLSID_INTERFACE_ENTRY(IEnumVARIANT,&CLSID_PSEnumVariant),
480     CLSID_INTERFACE_ENTRY(ITypeComp,&CLSID_PSTypeComp),
481     CLSID_INTERFACE_ENTRY(ITypeInfo,&CLSID_PSTypeInfo),
482     CLSID_INTERFACE_ENTRY(ITypeLib,&CLSID_PSTypeLib),
483     PSFAC_INTERFACE_ENTRY(IAdviseSinkEx),
484     PSFAC_INTERFACE_ENTRY(IClassFactory2),
485     PSFAC_INTERFACE_ENTRY(IConnectionPoint),
486     PSFAC_INTERFACE_ENTRY(IConnectionPointContainer),
487     PSFAC_INTERFACE_ENTRY(ICreateErrorInfo),
488     PSFAC_INTERFACE_ENTRY(IEnumConnectionPoints),
489     PSFAC_INTERFACE_ENTRY(IEnumConnections),
490     PSFAC_INTERFACE_ENTRY(IEnumOleUndoUnits),
491     PSFAC_INTERFACE_ENTRY(IErrorInfo),
492     PSFAC_INTERFACE_ENTRY(IErrorLog),
493     PSFAC_INTERFACE_ENTRY(IFont),
494     PSFAC_INTERFACE_ENTRY(IObjectWithSite),
495     PSFAC_INTERFACE_ENTRY(IOleControl),
496     PSFAC_INTERFACE_ENTRY(IOleControlSite),
497     PSFAC_INTERFACE_ENTRY(IOleInPlaceSiteEx),
498     PSFAC_INTERFACE_ENTRY(IOleParentUndoUnit),
499     PSFAC_INTERFACE_ENTRY(IOleUndoManager),
500     PSFAC_INTERFACE_ENTRY(IOleUndoUnit),
501     PSFAC_INTERFACE_ENTRY(IPerPropertyBrowsing),
502     PSFAC_INTERFACE_ENTRY(IPersistMemory),
503     PSFAC_INTERFACE_ENTRY(IPersistPropertyBag),
504     PSFAC_INTERFACE_ENTRY(IPersistPropertyBag2),
505     PSFAC_INTERFACE_ENTRY(IPersistStreamInit),
506     PSFAC_INTERFACE_ENTRY(IPicture),
507     PSFAC_INTERFACE_ENTRY(IPointerInactive),
508     PSFAC_INTERFACE_ENTRY(IPropertyBag),
509     PSFAC_INTERFACE_ENTRY(IPropertyBag2),
510     PSFAC_INTERFACE_ENTRY(IPropertyNotifySink),
511     PSFAC_INTERFACE_ENTRY(IPropertyPage),
512     PSFAC_INTERFACE_ENTRY(IPropertyPage2),
513     PSFAC_INTERFACE_ENTRY(IPropertyPageSite),
514     PSFAC_INTERFACE_ENTRY(IProvideClassInfo),
515     PSFAC_INTERFACE_ENTRY(IProvideClassInfo2),
516     PSFAC_INTERFACE_ENTRY(IProvideMultipleClassInfo),
517     PSFAC_INTERFACE_ENTRY(IQuickActivate),
518     PSFAC_INTERFACE_ENTRY(ISimpleFrameSite),
519     PSFAC_INTERFACE_ENTRY(ISpecifyPropertyPages),
520     { NULL }                    /* list terminator */
521 };
522
523 extern HRESULT WINAPI OLEAUTPS_DllRegisterServer(void) DECLSPEC_HIDDEN;
524 extern HRESULT WINAPI OLEAUTPS_DllUnregisterServer(void) DECLSPEC_HIDDEN;
525
526 /***********************************************************************
527  *              DllRegisterServer (OLEAUT32.@)
528  */
529 HRESULT WINAPI DllRegisterServer(void)
530 {
531     HRESULT hr;
532
533     TRACE("\n");
534
535     hr = OLEAUTPS_DllRegisterServer();
536     if (SUCCEEDED(hr))
537         hr = register_coclasses(coclass_list);
538     if (SUCCEEDED(hr))
539         hr = register_interfaces(interface_list);
540     return hr;
541 }
542
543 /***********************************************************************
544  *              DllUnregisterServer (OLEAUT32.@)
545  */
546 HRESULT WINAPI DllUnregisterServer(void)
547 {
548     HRESULT hr;
549
550     TRACE("\n");
551
552     hr = unregister_coclasses(coclass_list);
553     if (SUCCEEDED(hr))
554         hr = unregister_interfaces(interface_list);
555     if (SUCCEEDED(hr))
556         hr = OLEAUTPS_DllUnregisterServer();
557     return hr;
558 }