dlls/ddraw/regsvr.c

   1 /*
   2  *      self-registerable dll functions for ddraw.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 "winreg.h"
  27 #include "wingdi.h"
  28 #include "winuser.h"
  29 #include "winerror.h"
  30
  31 #include "ddraw.h"
  32
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(ddraw);
  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 clsid_str;           /* can be NULL to omit */
  66     LPCSTR progid;              /* can be NULL to omit */
  67 };
  68
  69 static HRESULT register_coclasses(struct regsvr_coclass const *list);
  70 static HRESULT unregister_coclasses(struct regsvr_coclass const *list);
  71
  72 /***********************************************************************
  73  *              static string constants
  74  */
  75 static WCHAR const interface_keyname[10] = {
  76     'I', 'n', 't', 'e', 'r', 'f', 'a', 'c', 'e', 0 };
  77 static WCHAR const base_ifa_keyname[14] = {
  78     'B', 'a', 's', 'e', 'I', 'n', 't', 'e', 'r', 'f', 'a', 'c',
  79     'e', 0 };
  80 static WCHAR const num_methods_keyname[11] = {
  81     'N', 'u', 'm', 'M', 'e', 't', 'h', 'o', 'd', 's', 0 };
  82 static WCHAR const ps_clsid_keyname[15] = {
  83     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  84     'i', 'd', 0 };
  85 static WCHAR const ps_clsid32_keyname[17] = {
  86     'P', 'r', 'o', 'x', 'y', 'S', 't', 'u', 'b', 'C', 'l', 's',
  87     'i', 'd', '3', '2', 0 };
  88 static WCHAR const clsid_keyname[6] = {
  89     'C', 'L', 'S', 'I', 'D', 0 };
  90 static WCHAR const ips_keyname[13] = {
  91     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
  92     0 };
  93 static WCHAR const ips32_keyname[15] = {
  94     'I', 'n', 'P', 'r', 'o', 'c', 'S', 'e', 'r', 'v', 'e', 'r',
  95     '3', '2', 0 };
  96 static WCHAR const progid_keyname[7] = {
  97     'P', 'r', 'o', 'g', 'I', 'D', 0 };
  98 static char const tmodel_valuename[] = "ThreadingModel";
  99
 100 /***********************************************************************
 101  *              static helper functions
 102  */
 103 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid);
 104 static LONG register_key_defvalueW(HKEY base, WCHAR const *name,
 105                                    WCHAR const *value);
 106 static LONG register_key_defvalueA(HKEY base, WCHAR const *name,
 107                                    char const *value);
 108
 109 /***********************************************************************
 110  *              register_interfaces
 111  */
 112 static HRESULT register_interfaces(struct regsvr_interface const *list)
 113 {
 114     LONG res = ERROR_SUCCESS;
 115     HKEY interface_key;
 116
 117     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0, NULL, 0,
 118                           KEY_READ | KEY_WRITE, NULL, &interface_key, NULL);
 119     if (res != ERROR_SUCCESS) goto error_return;
 120
 121     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 122         WCHAR buf[39];
 123         HKEY iid_key;
 124
 125         StringFromGUID2(list->iid, buf, 39);
 126         res = RegCreateKeyExW(interface_key, buf, 0, NULL, 0,
 127                               KEY_READ | KEY_WRITE, NULL, &iid_key, NULL);
 128         if (res != ERROR_SUCCESS) goto error_close_interface_key;
 129
 130         if (list->name) {
 131             res = RegSetValueExA(iid_key, NULL, 0, REG_SZ,
 132                                  (CONST BYTE*)(list->name),
 133                                  strlen(list->name) + 1);
 134             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 135         }
 136
 137         if (list->base_iid) {
 138             res = register_key_guid(iid_key, base_ifa_keyname, list->base_iid);
 139             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 140         }
 141
 142         if (0 <= list->num_methods) {
 143             static WCHAR const fmt[3] = { '%', 'd', 0 };
 144             HKEY key;
 145
 146             res = RegCreateKeyExW(iid_key, num_methods_keyname, 0, NULL, 0,
 147                                   KEY_READ | KEY_WRITE, NULL, &key, NULL);
 148             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 149
 150             wsprintfW(buf, fmt, list->num_methods);
 151             res = RegSetValueExW(key, NULL, 0, REG_SZ,
 152                                  (CONST BYTE*)buf,
 153                                  (lstrlenW(buf) + 1) * sizeof(WCHAR));
 154             RegCloseKey(key);
 155
 156             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 157         }
 158
 159         if (list->ps_clsid) {
 160             res = register_key_guid(iid_key, ps_clsid_keyname, list->ps_clsid);
 161             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 162         }
 163
 164         if (list->ps_clsid32) {
 165             res = register_key_guid(iid_key, ps_clsid32_keyname, list->ps_clsid32);
 166             if (res != ERROR_SUCCESS) goto error_close_iid_key;
 167         }
 168
 169     error_close_iid_key:
 170         RegCloseKey(iid_key);
 171     }
 172
 173 error_close_interface_key:
 174     RegCloseKey(interface_key);
 175 error_return:
 176     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 177 }
 178
 179 /***********************************************************************
 180  *              unregister_interfaces
 181  */
 182 static HRESULT unregister_interfaces(struct regsvr_interface const *list)
 183 {
 184     LONG res = ERROR_SUCCESS;
 185     HKEY interface_key;
 186
 187     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, interface_keyname, 0,
 188                         KEY_READ | KEY_WRITE, &interface_key);
 189     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 190     if (res != ERROR_SUCCESS) goto error_return;
 191
 192     for (; res == ERROR_SUCCESS && list->iid; ++list) {
 193         WCHAR buf[39];
 194
 195         StringFromGUID2(list->iid, buf, 39);
 196         res = RegDeleteTreeW(interface_key, buf);
 197         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 198     }
 199
 200     RegCloseKey(interface_key);
 201 error_return:
 202     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 203 }
 204
 205 /***********************************************************************
 206  *              register_coclasses
 207  */
 208 static HRESULT register_coclasses(struct regsvr_coclass const *list)
 209 {
 210     LONG res = ERROR_SUCCESS;
 211     HKEY coclass_key;
 212
 213     res = RegCreateKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0, NULL, 0,
 214                           KEY_READ | KEY_WRITE, NULL, &coclass_key, NULL);
 215     if (res != ERROR_SUCCESS) goto error_return;
 216
 217     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 218         WCHAR buf[39];
 219         HKEY clsid_key;
 220
 221         StringFromGUID2(list->clsid, buf, 39);
 222         res = RegCreateKeyExW(coclass_key, buf, 0, NULL, 0,
 223                               KEY_READ | KEY_WRITE, NULL, &clsid_key, NULL);
 224         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 225
 226         if (list->name) {
 227             res = RegSetValueExA(clsid_key, NULL, 0, REG_SZ,
 228                                  (CONST BYTE*)(list->name),
 229                                  strlen(list->name) + 1);
 230             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 231         }
 232
 233         if (list->ips) {
 234             res = register_key_defvalueA(clsid_key, ips_keyname, list->ips);
 235             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 236         }
 237
 238         if (list->ips32) {
 239             HKEY ips32_key;
 240
 241             res = RegCreateKeyExW(clsid_key, ips32_keyname, 0, NULL, 0,
 242                                   KEY_READ | KEY_WRITE, NULL,
 243                                   &ips32_key, NULL);
 244             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 245
 246             res = RegSetValueExA(ips32_key, NULL, 0, REG_SZ,
 247                                  (CONST BYTE*)list->ips32,
 248                                  lstrlenA(list->ips32) + 1);
 249             if (res == ERROR_SUCCESS && list->ips32_tmodel)
 250                 res = RegSetValueExA(ips32_key, tmodel_valuename, 0, REG_SZ,
 251                                      (CONST BYTE*)list->ips32_tmodel,
 252                                      strlen(list->ips32_tmodel) + 1);
 253             RegCloseKey(ips32_key);
 254             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 255         }
 256
 257         if (list->clsid_str) {
 258             res = register_key_defvalueA(clsid_key, clsid_keyname,
 259                                          list->clsid_str);
 260             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 261         }
 262
 263         if (list->progid) {
 264             HKEY progid_key;
 265
 266             res = register_key_defvalueA(clsid_key, progid_keyname,
 267                                          list->progid);
 268             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 269
 270             res = RegCreateKeyExA(HKEY_CLASSES_ROOT, list->progid, 0,
 271                                   NULL, 0, KEY_READ | KEY_WRITE, NULL,
 272                                   &progid_key, NULL);
 273             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 274
 275             res = register_key_defvalueW(progid_key, clsid_keyname, buf);
 276             RegCloseKey(progid_key);
 277             if (res != ERROR_SUCCESS) goto error_close_clsid_key;
 278         }
 279
 280     error_close_clsid_key:
 281         RegCloseKey(clsid_key);
 282     }
 283
 284 error_close_coclass_key:
 285     RegCloseKey(coclass_key);
 286 error_return:
 287     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 288 }
 289
 290 /***********************************************************************
 291  *              unregister_coclasses
 292  */
 293 static HRESULT unregister_coclasses(struct regsvr_coclass const *list)
 294 {
 295     LONG res = ERROR_SUCCESS;
 296     HKEY coclass_key;
 297
 298     res = RegOpenKeyExW(HKEY_CLASSES_ROOT, clsid_keyname, 0,
 299                         KEY_READ | KEY_WRITE, &coclass_key);
 300     if (res == ERROR_FILE_NOT_FOUND) return S_OK;
 301     if (res != ERROR_SUCCESS) goto error_return;
 302
 303     for (; res == ERROR_SUCCESS && list->clsid; ++list) {
 304         WCHAR buf[39];
 305
 306         StringFromGUID2(list->clsid, buf, 39);
 307         res = RegDeleteTreeW(coclass_key, buf);
 308         if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 309         if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 310
 311         if (list->progid) {
 312             res = RegDeleteTreeA(HKEY_CLASSES_ROOT, list->progid);
 313             if (res == ERROR_FILE_NOT_FOUND) res = ERROR_SUCCESS;
 314             if (res != ERROR_SUCCESS) goto error_close_coclass_key;
 315         }
 316     }
 317
 318 error_close_coclass_key:
 319     RegCloseKey(coclass_key);
 320 error_return:
 321     return res != ERROR_SUCCESS ? HRESULT_FROM_WIN32(res) : S_OK;
 322 }
 323
 324 /***********************************************************************
 325  *              regsvr_key_guid
 326  */
 327 static LONG register_key_guid(HKEY base, WCHAR const *name, GUID const *guid)
 328 {
 329     WCHAR buf[39];
 330
 331     StringFromGUID2(guid, buf, 39);
 332     return register_key_defvalueW(base, name, buf);
 333 }
 334
 335 /***********************************************************************
 336  *              regsvr_key_defvalueW
 337  */
 338 static LONG register_key_defvalueW(
 339     HKEY base,
 340     WCHAR const *name,
 341     WCHAR const *value)
 342 {
 343     LONG res;
 344     HKEY key;
 345
 346     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 347                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 348     if (res != ERROR_SUCCESS) return res;
 349     res = RegSetValueExW(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 350                          (lstrlenW(value) + 1) * sizeof(WCHAR));
 351     RegCloseKey(key);
 352     return res;
 353 }
 354
 355 /***********************************************************************
 356  *              regsvr_key_defvalueA
 357  */
 358 static LONG register_key_defvalueA(
 359     HKEY base,
 360     WCHAR const *name,
 361     char const *value)
 362 {
 363     LONG res;
 364     HKEY key;
 365
 366     res = RegCreateKeyExW(base, name, 0, NULL, 0,
 367                           KEY_READ | KEY_WRITE, NULL, &key, NULL);
 368     if (res != ERROR_SUCCESS) return res;
 369     res = RegSetValueExA(key, NULL, 0, REG_SZ, (CONST BYTE*)value,
 370                          lstrlenA(value) + 1);
 371     RegCloseKey(key);
 372     return res;
 373 }
 374
 375 /***********************************************************************
 376  *              coclass list
 377  */
 378
 379 static struct regsvr_coclass const coclass_list[] = {
 380     {   &CLSID_DirectDraw,
 381         "DirectDraw Object",
 382         NULL,
 383         "ddraw.dll",
 384         "Both"
 385     },
 386     {   &CLSID_DirectDrawClipper,
 387         "DirectDraw Clipper Object",
 388         NULL,
 389         "ddraw.dll",
 390         "Both"
 391     },
 392     { NULL }                    /* list terminator */
 393 };
 394
 395 /***********************************************************************
 396  *              interface list
 397  */
 398
 399 static struct regsvr_interface const interface_list[] = {
 400     { NULL }                    /* list terminator */
 401 };
 402
 403 /***********************************************************************
 404  *              DllRegisterServer (DDRAW.@)
 405  */
 406 HRESULT WINAPI DllRegisterServer(void)
 407 {
 408     HRESULT hr;
 409
 410     TRACE("\n");
 411
 412     hr = register_coclasses(coclass_list);
 413     if (SUCCEEDED(hr))
 414         hr = register_interfaces(interface_list);
 415     return hr;
 416 }
 417
 418 /***********************************************************************
 419  *              DllUnregisterServer (DDRAW.@)
 420  */
 421 HRESULT WINAPI DllUnregisterServer(void)
 422 {
 423     HRESULT hr;
 424
 425     TRACE("\n");
 426
 427     hr = unregister_coclasses(coclass_list);
 428     if (SUCCEEDED(hr))
 429         hr = unregister_interfaces(interface_list);
 430     return hr;
 431 }