dinput: Zero out returned information struct.
[wine] / dlls / dinput / regsvr.c
1 /*
2  *      self-registerable dll functions for dinput.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 "wingdi.h"
27 #include "winuser.h"
28 #include "winreg.h"
29 #include "winerror.h"
30
31 #include "dinput.h"
32
33 #include "wine/debug.h"
34
35 WINE_DEFAULT_DEBUG_CHANNEL(dinput);
36
37 /*
38  * Near the bottom of this file are the exported DllRegisterServer and
39  * DllUnregisterServer, which make all this worthwhile.
40  */
41
42 /***********************************************************************
43  *              interface for self-registering
44  */
45 struct regsvr_interface
46 {
47     IID const *iid;             /* NULL for end of list */
48     LPCSTR name;                /* can be NULL to omit */
49     IID const *base_iid;        /* can be NULL to omit */
50     int num_methods;            /* can be <0 to omit */
51     CLSID const *ps_clsid;      /* can be NULL to omit */
52     CLSID const *ps_clsid32;    /* can be NULL to omit */
53 };
54
55 static HRESULT register_interfaces(struct regsvr_interface const *list);
56 static HRESULT unregister_interfaces(struct regsvr_interface const *list);
57
58 struct regsvr_coclass
59 {
60     CLSID const *clsid;         /* NULL for end of list */
61     LPCSTR name;                /* can be NULL to omit */
62     LPCSTR ips;                 /* can be NULL to omit */
63     LPCSTR ips32;               /* can be NULL to omit */
64     LPCSTR ips32_tmodel;        /* can be NULL to omit */
65     LPCSTR progid;              /* can be NULL to omit */
66     LPCSTR viprogid;            /* can be NULL to omit */
67     LPCSTR progid_extra;        /* can be NULL to omit */
68 };
69
70 static HRESULT register_coclasses(struct regsvr_coclass const *list);
71 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
72
73 /***********************************************************************
74  *              static string constants
75  */
76 static WCHAR const interface_keyname[10] = {
77     'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
78 static WCHAR const base_ifa_keyname[14] = {
79     'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
80     'e', 0 };
81 static WCHAR const num_methods_keyname[11] = {
82     'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
83 static WCHAR const ps_clsid_keyname[15] = {
84     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
85     'i', 'd', 0 };
86 static WCHAR const ps_clsid32_keyname[17] = {
87     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
88     'i', 'd', '3', '2', 0 };
89 static WCHAR const clsid_keyname[6] = {
90     'C', 'L', 'S', 'I', 'D', 0 };
91 static WCHAR const curver_keyname[7] = {
92     'C', 'u', 'r', 'V', 'e', 'r', 0 };
93 static WCHAR const ips_keyname[13] = {
94     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
95     0 };
96 static WCHAR const ips32_keyname[15] = {
97     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
98     '3', '2', 0 };
99 static WCHAR const progid_keyname[7] = {
100     'P', 'r', 'o', 'g', 'I', 'D', 0 };
101 static WCHAR const viprogid_keyname[25] = {
102     'V', 'e', 'r', 's', 'i', 'o', 'n', 'I', 'n', 'd', 'e', 'p',
103     'e', 'n', 'd', 'e', 'n', 't', 'P', 'r', 'o', 'g', 'I', 'D',
104     0 };
105 static char const tmodel_valuename[] = "ThreadingModel";
106
107 /***********************************************************************
108  *              static helper functions
109  */
110 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
111 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
112                                    WCHAR const *value);
113 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
114                                    char const *value);
115 static LONG register_progid(WCHAR const *clsid,
116                             char const *progid, char const *curver_progid,
117                             char const *name, char const *extra);
118 static LONG recursive_delete_key(HKEY key);
119 static LONG recursive_delete_keyA(HKEY base, char const *name);
120 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name);
121
122 /***********************************************************************
123  *              register_interfaces
124  */
125 static HRESULT register_interfaces(struct regsvr_interface const *list)
126 {
127     LONG res = ERROR_SUCCESS;
128     HKEY interface_key;
129
130     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
131                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
132     if (res != ERROR_SUCCESS) goto error_return;
133
134     for (; res == ERROR_SUCCESS && list->iid; ++list) {
135         WCHAR buf[39];
136         HKEY iid_key;
137
138         StringFromGUID2(list->iid, buf, 39);
139         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
140                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
141         if (res != ERROR_SUCCESS) goto error_close_interface_key;
142
143         if (list->name) {
144             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
145                                  (CONST BYTE*)(list->name),
146                                  strlen(list->name) + 1);
147             if (res != ERROR_SUCCESS) goto error_close_iid_key;
148         }
149
150         if (list->base_iid) {
151             res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
152             if (res != ERROR_SUCCESS) goto error_close_iid_key;
153         }
154
155         if (0 <= list->num_methods) {
156             static WCHAR const fmt[3] = { '%', 'd', 0 };
157             HKEY key;
158
159             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
160                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
161             if (res != ERROR_SUCCESS) goto error_close_iid_key;
162
163             wsprintfW(buf, fmt, list->num_methods);
164             res = RegSetValueExW(key, NULL, 0, REG_SZ,
165                                  (CONST BYTE*)buf,
166                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
167             RegCloseKey(key);
168
169             if (res != ERROR_SUCCESS) goto error_close_iid_key;
170         }
171
172         if (list->ps_clsid) {
173             res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
174             if (res != ERROR_SUCCESS) goto error_close_iid_key;
175         }
176
177         if (list->ps_clsid32) {
178             res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
179             if (res != ERROR_SUCCESS) goto error_close_iid_key;
180         }
181
182     error_close_iid_key:
183         RegCloseKey(iid_key);
184     }
185
186 error_close_interface_key:
187     RegCloseKey(interface_key);
188 error_return:
189     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
190 }
191
192 /***********************************************************************
193  *              unregister_interfaces
194  */
195 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
196 {
197     LONG res = ERROR_SUCCESS;
198     HKEY interface_key;
199
200     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
201                         KEY_READ | KEY_WRITE, &interface_key);
202     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
203     if (res != ERROR_SUCCESS) goto error_return;
204
205     for (; res == ERROR_SUCCESS && list->iid; ++list) {
206         WCHAR buf[39];
207
208         StringFromGUID2(list->iid, buf, 39);
209         res = recursive_delete_keyW(interface_key, buf);
210     }
211
212     RegCloseKey(interface_key);
213 error_return:
214     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
215 }
216
217 /***********************************************************************
218  *              register_coclasses
219  */
220 static HRESULT register_coclasses(struct regsvr_coclass const *list)
221 {
222     LONG res = ERROR_SUCCESS;
223     HKEY coclass_key;
224
225     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
226                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
227     if (res != ERROR_SUCCESS) goto error_return;
228
229     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
230         WCHAR buf[39];
231         HKEY clsid_key;
232
233         StringFromGUID2(list->clsid, buf, 39);
234         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
235                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
236         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
237
238         if (list->name) {
239             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
240                                  (CONST BYTE*)(list->name),
241                                  strlen(list->name) + 1);
242             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
243         }
244
245         if (list->ips) {
246             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
247             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
248         }
249
250         if (list->ips32) {
251             HKEY ips32_key;
252
253             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
254                                   KEY_READ | KEY_WRITE, NULL,
255                                   &ips32_key, NULL);
256             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
257
258             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
259                                  (CONST BYTE*)list->ips32,
260                                  lstrlenA(list->ips32) + 1);
261             if (res == ERROR_SUCCESS && list->ips32_tmodel)
262                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
263                                      (CONST BYTE*)list->ips32_tmodel,
264                                      strlen(list->ips32_tmodel) + 1);
265             RegCloseKey(ips32_key);
266             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
267         }
268
269         if (list->progid) {
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 = register_progid(buf, list->progid, NULL,
275                                   list->name, list->progid_extra);
276             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
277         }
278
279         if (list->viprogid) {
280             res = register_key_defvalueA(clsid_key, viprogid_keyname,
281                                          list->viprogid);
282             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
283
284             res = register_progid(buf, list->viprogid, list->progid,
285                                   list->name, list->progid_extra);
286             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
287         }
288
289     error_close_clsid_key:
290         RegCloseKey(clsid_key);
291     }
292
293 error_close_coclass_key:
294     RegCloseKey(coclass_key);
295 error_return:
296     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
297 }
298
299 /***********************************************************************
300  *              unregister_coclasses
301  */
302 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
303 {
304     LONG res = ERROR_SUCCESS;
305     HKEY coclass_key;
306
307     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
308                         KEY_READ | KEY_WRITE, &coclass_key);
309     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
310     if (res != ERROR_SUCCESS) goto error_return;
311
312     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
313         WCHAR buf[39];
314
315         StringFromGUID2(list->clsid, buf, 39);
316         res = recursive_delete_keyW(coclass_key, buf);
317         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
318
319         if (list->progid) {
320             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->progid);
321             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
322         }
323
324         if (list->viprogid) {
325             res = recursive_delete_keyA(HKEY_CLASSES_ROOT, list->viprogid);
326             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
327         }
328     }
329
330 error_close_coclass_key:
331     RegCloseKey(coclass_key);
332 error_return:
333     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
334 }
335
336 /***********************************************************************
337  *              regsvr_key_guid
338  */
339 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
340 {
341     WCHAR buf[39];
342
343     StringFromGUID2(guid, buf, 39);
344     return register_key_defvalueW(base, name, buf);
345 }
346
347 /***********************************************************************
348  *              regsvr_key_defvalueW
349  */
350 static LONG register_key_defvalueW(
351     HKEY base,
352     WCHAR const *name,
353     WCHAR const *value)
354 {
355     LONG res;
356     HKEY key;
357
358     res = RegCreateKeyExW(base, name, 0, NULL, 0,
359                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
360     if (res != ERROR_SUCCESS) return res;
361     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
362                          (lstrlenW(value) + 1) * sizeof(WCHAR));
363     RegCloseKey(key);
364     return res;
365 }
366
367 /***********************************************************************
368  *              regsvr_key_defvalueA
369  */
370 static LONG register_key_defvalueA(
371     HKEY base,
372     WCHAR const *name,
373     char const *value)
374 {
375     LONG res;
376     HKEY key;
377
378     res = RegCreateKeyExW(base, name, 0, NULL, 0,
379                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
380     if (res != ERROR_SUCCESS) return res;
381     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
382                          lstrlenA(value) + 1);
383     RegCloseKey(key);
384     return res;
385 }
386
387 /***********************************************************************
388  *              regsvr_progid
389  */
390 static LONG register_progid(
391     WCHAR const *clsid,
392     char const *progid,
393     char const *curver_progid,
394     char const *name,
395     char const *extra)
396 {
397     LONG res;
398     HKEY progid_key;
399
400     res = RegCreateKeyExA(HKEY_CLASSES_ROOT, progid, 0,
401                           NULL, 0, KEY_READ | KEY_WRITE, NULL,
402                           &progid_key, NULL);
403     if (res != ERROR_SUCCESS) return res;
404
405     if (name) {
406         res = RegSetValueExA(progid_key, NULL, 0, REG_SZ,
407                              (CONST BYTE*)name, strlen(name) + 1);
408         if (res != ERROR_SUCCESS) goto error_close_progid_key;
409     }
410
411     if (clsid) {
412         res = register_key_defvalueW(progid_key, clsid_keyname, clsid);
413         if (res != ERROR_SUCCESS) goto error_close_progid_key;
414     }
415
416     if (curver_progid) {
417         res = register_key_defvalueA(progid_key, curver_keyname,
418                                      curver_progid);
419         if (res != ERROR_SUCCESS) goto error_close_progid_key;
420     }
421
422     if (extra) {
423         HKEY extra_key;
424
425         res = RegCreateKeyExA(progid_key, extra, 0,
426                               NULL, 0, KEY_READ | KEY_WRITE, NULL,
427                               &extra_key, NULL);
428         if (res == ERROR_SUCCESS)
429             RegCloseKey(extra_key);
430     }
431
432 error_close_progid_key:
433     RegCloseKey(progid_key);
434     return res;
435 }
436
437 /***********************************************************************
438  *              recursive_delete_key
439  */
440 static LONG recursive_delete_key(HKEY key)
441 {
442     LONG res;
443     WCHAR subkey_name[MAX_PATH];
444     DWORD cName;
445     HKEY subkey;
446
447     for (;;) {
448         cName = sizeof(subkey_name) / sizeof(WCHAR);
449         res = RegEnumKeyExW(key, 0, subkey_name, &cName,
450                             NULL, NULL, NULL, NULL);
451         if (res != ERROR_SUCCESS && res != ERROR_MORE_DATA) {
452             res = ERROR_SUCCESS; /* presumably we're done enumerating */
453             break;
454         }
455         res = RegOpenKeyExW(key, subkey_name, 0,
456                             KEY_READ | KEY_WRITE, &subkey);
457         if (res == ERROR_FILE_NOT_FOUND) continue;
458         if (res != ERROR_SUCCESS) break;
459
460         res = recursive_delete_key(subkey);
461         RegCloseKey(subkey);
462         if (res != ERROR_SUCCESS) break;
463     }
464
465     if (res == ERROR_SUCCESS) res = RegDeleteKeyW(key, 0);
466     return res;
467 }
468
469 /***********************************************************************
470  *              recursive_delete_keyA
471  */
472 static LONG recursive_delete_keyA(HKEY base, char const *name)
473 {
474     LONG res;
475     HKEY key;
476
477     res = RegOpenKeyExA(base, name, 0, KEY_READ | KEY_WRITE, &key);
478     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
479     if (res != ERROR_SUCCESS) return res;
480     res = recursive_delete_key(key);
481     RegCloseKey(key);
482     return res;
483 }
484
485 /***********************************************************************
486  *              recursive_delete_keyW
487  */
488 static LONG recursive_delete_keyW(HKEY base, WCHAR const *name)
489 {
490     LONG res;
491     HKEY key;
492
493     res = RegOpenKeyExW(base, name, 0, KEY_READ | KEY_WRITE, &key);
494     if (res == ERROR_FILE_NOT_FOUND) return ERROR_SUCCESS;
495     if (res != ERROR_SUCCESS) return res;
496     res = recursive_delete_key(key);
497     RegCloseKey(key);
498     return res;
499 }
500
501 /***********************************************************************
502  *              coclass list
503  */
504 static struct regsvr_coclass const coclass_list[] = {
505     {
506         &CLSID_DirectInput,
507         "DirectInput Object",
508         NULL,
509         "dinput.dll",
510         "Both"
511     },
512     {
513         &CLSID_DirectInputDevice,
514         "DirectInputDevice Object",
515         NULL,
516         "dinput.dll",
517         "Both"
518     },
519     { NULL }                    /* list terminator */
520 };
521
522 /***********************************************************************
523  *              interface list
524  */
525
526 static struct regsvr_interface const interface_list[] = {
527     { NULL }                    /* list terminator */
528 };
529
530 /***********************************************************************
531  *              DllRegisterServer (DINPUT.@)
532  */
533 HRESULT WINAPI DllRegisterServer(void)
534 {
535     HRESULT hr;
536
537     TRACE("\n");
538
539     hr = register_coclasses(coclass_list);
540     if (SUCCEEDED(hr))
541         hr = register_interfaces(interface_list);
542     return hr;
543 }
544
545 /***********************************************************************
546  *              DllUnregisterServer (DINPUT.@)
547  */
548 HRESULT WINAPI DllUnregisterServer(void)
549 {
550     HRESULT hr;
551
552     TRACE("\n");
553
554     hr = unregister_coclasses(coclass_list);
555     if (SUCCEEDED(hr))
556         hr = unregister_interfaces(interface_list);
557     return hr;
558 }