src/msw/registry.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/registry.cpp
   3 // Purpose:     implementation of registry classes and functions
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     03.04.98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 // TODO:        - parsing of registry key names
  11 //              - support of other (than REG_SZ/REG_DWORD) registry types
  12 //              - add high level functions (RegisterOleServer, ...)
  13 ///////////////////////////////////////////////////////////////////////////////
  14
  15 #ifdef __GNUG__
  16 #pragma implementation "registry.h"
  17 #endif
  18
  19 // for compilers that support precompilation, includes "wx.h".
  20 #include  "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23 #pragma hdrstop
  24 #endif
  25
  26 // other wxWindows headers
  27 #include  "wx/string.h"
  28 #include  "wx/intl.h"
  29 #include  "wx/log.h"
  30
  31 #ifndef __WIN16__
  32
  33 // Windows headers
  34 /*
  35 #define   STRICT
  36 #define   WIN32_LEAN_AND_MEAN
  37 */
  38
  39 #include  <windows.h>
  40
  41 // other std headers
  42 #include  <stdlib.h>      // for _MAX_PATH
  43
  44 #ifndef _MAX_PATH
  45     #define _MAX_PATH 512
  46 #endif
  47
  48 // our header
  49 #define   HKEY_DEFINED    // already defined in windows.h
  50 #include  "wx/msw/registry.h"
  51
  52 // some registry functions don't like signed chars
  53 typedef unsigned char *RegString;
  54
  55 // ----------------------------------------------------------------------------
  56 // constants
  57 // ----------------------------------------------------------------------------
  58
  59 // the standard key names, short names and handles all bundled together for
  60 // convenient access
  61 static struct
  62 {
  63   HKEY        hkey;
  64   const wxChar *szName;
  65   const wxChar *szShortName;
  66 }
  67 aStdKeys[] =
  68 {
  69   { HKEY_CLASSES_ROOT,      wxT("HKEY_CLASSES_ROOT"),      wxT("HKCR") },
  70 #ifdef  __WIN32__
  71   { HKEY_CURRENT_USER,      wxT("HKEY_CURRENT_USER"),      wxT("HKCU") },
  72   { HKEY_LOCAL_MACHINE,     wxT("HKEY_LOCAL_MACHINE"),     wxT("HKLM") },
  73   { HKEY_USERS,             wxT("HKEY_USERS"),             wxT("HKU")  }, // short name?
  74   { HKEY_PERFORMANCE_DATA,  wxT("HKEY_PERFORMANCE_DATA"),  wxT("HKPD") },
  75 #if     WINVER >= 0x0400
  76   { HKEY_CURRENT_CONFIG,    wxT("HKEY_CURRENT_CONFIG"),    wxT("HKCC") },
  77 #ifndef __GNUWIN32__
  78   { HKEY_DYN_DATA,          wxT("HKEY_DYN_DATA"),          wxT("HKDD") }, // short name?
  79 #endif  //GNUWIN32
  80 #endif  //WINVER >= 4.0
  81 #endif  //WIN32
  82 };
  83
  84 // the registry name separator (perhaps one day MS will change it to '/' ;-)
  85 #define   REG_SEPARATOR     wxT('\\')
  86
  87 // useful for Windows programmers: makes somewhat more clear all these zeroes
  88 // being passed to Windows APIs
  89 #define   RESERVED        (NULL)
  90
  91 // ----------------------------------------------------------------------------
  92 // macros
  93 // ----------------------------------------------------------------------------
  94 // @ const_cast<> is not yet supported by all compilers
  95 #define CONST_CAST    ((wxRegKey *)this)->
  96
  97 #if   !USE_MUTABLE
  98   #define m_dwLastError   CONST_CAST m_dwLastError
  99 #endif
 100
 101 // ----------------------------------------------------------------------------
 102 // non member functions
 103 // ----------------------------------------------------------------------------
 104
 105 // removes the trailing backslash from the string if it has one
 106 static inline void RemoveTrailingSeparator(wxString& str);
 107
 108 // returns TRUE if given registry key exists
 109 static bool KeyExists(WXHKEY hRootKey, const wxChar *szKey);
 110
 111 // combines value and key name (uses static buffer!)
 112 static const wxChar *GetFullName(const wxRegKey *pKey,
 113                                const wxChar *szValue = NULL);
 114
 115 // ============================================================================
 116 // implementation of wxRegKey class
 117 // ============================================================================
 118
 119 // ----------------------------------------------------------------------------
 120 // static functions and variables
 121 // ----------------------------------------------------------------------------
 122
 123 const size_t wxRegKey::nStdKeys = WXSIZEOF(aStdKeys);
 124
 125 // @@ should take a `StdKey key', but as it's often going to be used in loops
 126 //    it would require casts in user code.
 127 const wxChar *wxRegKey::GetStdKeyName(size_t key)
 128 {
 129   // return empty string if key is invalid
 130   wxCHECK_MSG( key < nStdKeys, wxT(""), wxT("invalid key in wxRegKey::GetStdKeyName") );
 131
 132   return aStdKeys[key].szName;
 133 }
 134
 135 const wxChar *wxRegKey::GetStdKeyShortName(size_t key)
 136 {
 137   // return empty string if key is invalid
 138   wxCHECK( key < nStdKeys, wxT("") );
 139
 140   return aStdKeys[key].szShortName;
 141 }
 142
 143 wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey)
 144 {
 145   wxString strRoot = strKey.BeforeFirst(REG_SEPARATOR);
 146
 147   HKEY hRootKey = 0;
 148   size_t ui;
 149   for ( ui = 0; ui < nStdKeys; ui++ ) {
 150     if ( strRoot.CmpNoCase(aStdKeys[ui].szName) == 0 ||
 151          strRoot.CmpNoCase(aStdKeys[ui].szShortName) == 0 ) {
 152       hRootKey = aStdKeys[ui].hkey;
 153       break;
 154     }
 155   }
 156
 157   if ( ui == nStdKeys ) {
 158     wxFAIL_MSG(wxT("invalid key prefix in wxRegKey::ExtractKeyName."));
 159
 160     hRootKey = HKEY_CLASSES_ROOT;
 161   }
 162   else {
 163     strKey = strKey.After(REG_SEPARATOR);
 164     if ( !strKey.IsEmpty() && strKey.Last() == REG_SEPARATOR )
 165       strKey.Truncate(strKey.Len() - 1);
 166   }
 167
 168   return (wxRegKey::StdKey)(int)hRootKey;
 169 }
 170
 171 wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey)
 172 {
 173   for ( size_t ui = 0; ui < nStdKeys; ui++ ) {
 174     if ( (int) aStdKeys[ui].hkey == (int) hkey )
 175       return (StdKey)ui;
 176   }
 177
 178   wxFAIL_MSG(wxT("non root hkey passed to wxRegKey::GetStdKeyFromHkey."));
 179
 180   return HKCR;
 181 }
 182
 183 // ----------------------------------------------------------------------------
 184 // ctors and dtor
 185 // ----------------------------------------------------------------------------
 186
 187 wxRegKey::wxRegKey()
 188 {
 189   m_hKey = 0;
 190   m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey;
 191   m_dwLastError = 0;
 192 }
 193
 194 wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey)
 195 {
 196   m_hRootKey  = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey;
 197   m_hKey      = (WXHKEY) NULL;
 198   m_dwLastError = 0;
 199 }
 200
 201 // parent is a predefined (and preopened) key
 202 wxRegKey::wxRegKey(StdKey keyParent, const wxString& strKey) : m_strKey(strKey)
 203 {
 204   RemoveTrailingSeparator(m_strKey);
 205   m_hRootKey  = (WXHKEY) aStdKeys[keyParent].hkey;
 206   m_hKey      = (WXHKEY) NULL;
 207   m_dwLastError = 0;
 208 }
 209
 210 // parent is a normal regkey
 211 wxRegKey::wxRegKey(const wxRegKey& keyParent, const wxString& strKey)
 212         : m_strKey(keyParent.m_strKey)
 213 {
 214   // combine our name with parent's to get the full name
 215   if ( !m_strKey.IsEmpty() &&
 216        (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) {
 217       m_strKey += REG_SEPARATOR;
 218   }
 219
 220   m_strKey += strKey;
 221   RemoveTrailingSeparator(m_strKey);
 222
 223   m_hRootKey  = keyParent.m_hRootKey;
 224   m_hKey      = (WXHKEY) NULL;
 225   m_dwLastError = 0;
 226 }
 227
 228 // dtor closes the key releasing system resource
 229 wxRegKey::~wxRegKey()
 230 {
 231   Close();
 232 }
 233
 234 // ----------------------------------------------------------------------------
 235 // change the key name/hkey
 236 // ----------------------------------------------------------------------------
 237
 238 // set the full key name
 239 void wxRegKey::SetName(const wxString& strKey)
 240 {
 241   Close();
 242
 243   m_strKey = strKey;
 244   m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey;
 245 }
 246
 247 // the name is relative to the parent key
 248 void wxRegKey::SetName(StdKey keyParent, const wxString& strKey)
 249 {
 250   Close();
 251
 252   m_strKey = strKey;
 253   RemoveTrailingSeparator(m_strKey);
 254   m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey;
 255 }
 256
 257 // the name is relative to the parent key
 258 void wxRegKey::SetName(const wxRegKey& keyParent, const wxString& strKey)
 259 {
 260   Close();
 261
 262   // combine our name with parent's to get the full name
 263   m_strKey = keyParent.m_strKey;
 264   if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR )
 265     m_strKey += REG_SEPARATOR;
 266   m_strKey += strKey;
 267
 268   RemoveTrailingSeparator(m_strKey);
 269
 270   m_hRootKey = keyParent.m_hRootKey;
 271 }
 272
 273 // hKey should be opened and will be closed in wxRegKey dtor
 274 void wxRegKey::SetHkey(WXHKEY hKey)
 275 {
 276   Close();
 277
 278   m_hKey = hKey;
 279 }
 280
 281 // ----------------------------------------------------------------------------
 282 // info about the key
 283 // ----------------------------------------------------------------------------
 284
 285 // returns TRUE if the key exists
 286 bool wxRegKey::Exists() const
 287 {
 288   // opened key has to exist, try to open it if not done yet
 289   return IsOpened() ? TRUE : KeyExists(m_hRootKey, m_strKey);
 290 }
 291
 292 // returns the full name of the key (prefix is abbreviated if bShortPrefix)
 293 wxString wxRegKey::GetName(bool bShortPrefix) const
 294 {
 295   StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey);
 296   wxString str = bShortPrefix ? aStdKeys[key].szShortName
 297                               : aStdKeys[key].szName;
 298   if ( !m_strKey.IsEmpty() )
 299     str << "\\" << m_strKey;
 300
 301   return str;
 302 }
 303
 304 bool wxRegKey::GetKeyInfo(size_t *pnSubKeys,
 305                           size_t *pnMaxKeyLen,
 306                           size_t *pnValues,
 307                           size_t *pnMaxValueLen) const
 308 {
 309 #if defined(__WIN32__) && !defined(__TWIN32__)
 310
 311     // old gcc headers incorrectly prototype RegQueryInfoKey()
 312 #ifdef __GNUWIN32_OLD__
 313     #define REG_PARAM   (size_t *)
 314 #else
 315     #define REG_PARAM   (LPDWORD)
 316 #endif
 317
 318   // it might be unexpected to some that this function doesn't open the key
 319   wxASSERT_MSG( IsOpened(), _T("key should be opened in GetKeyInfo") );
 320
 321   m_dwLastError = ::RegQueryInfoKey
 322                   (
 323                     (HKEY) m_hKey,
 324                     NULL,           // class name
 325                     NULL,           // (ptr to) size of class name buffer
 326                     RESERVED,
 327                     REG_PARAM
 328                     pnSubKeys,      // [out] number of subkeys
 329                     REG_PARAM
 330                     pnMaxKeyLen,    // [out] max length of a subkey name
 331                     NULL,           // longest subkey class name
 332                     REG_PARAM
 333                     pnValues,       // [out] number of values
 334                     REG_PARAM
 335                     pnMaxValueLen,  // [out] max length of a value name
 336                     NULL,           // longest value data
 337                     NULL,           // security descriptor
 338                     NULL            // time of last modification
 339                   );
 340
 341 #undef REG_PARAM
 342
 343   if ( m_dwLastError != ERROR_SUCCESS ) {
 344     wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"),
 345                   GetName().c_str());
 346     return FALSE;
 347   }
 348
 349   return TRUE;
 350 #else // Win16
 351   wxFAIL_MSG("GetKeyInfo() not implemented");
 352
 353   return FALSE;
 354 #endif
 355 }
 356
 357 // ----------------------------------------------------------------------------
 358 // operations
 359 // ----------------------------------------------------------------------------
 360
 361 // opens key (it's not an error to call Open() on an already opened key)
 362 bool wxRegKey::Open()
 363 {
 364   if ( IsOpened() )
 365     return TRUE;
 366
 367   HKEY tmpKey;
 368   m_dwLastError = RegOpenKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
 369   if ( m_dwLastError != ERROR_SUCCESS ) {
 370     wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"),
 371                   GetName().c_str());
 372     return FALSE;
 373   }
 374   else
 375   {
 376     m_hKey = (WXHKEY) tmpKey;
 377     return TRUE;
 378   }
 379 }
 380
 381 // creates key, failing if it exists and !bOkIfExists
 382 bool wxRegKey::Create(bool bOkIfExists)
 383 {
 384   // check for existence only if asked (i.e. order is important!)
 385   if ( !bOkIfExists && Exists() ) {
 386     return FALSE;
 387   }
 388
 389   if ( IsOpened() )
 390     return TRUE;
 391
 392   HKEY tmpKey;
 393   m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
 394   if ( m_dwLastError != ERROR_SUCCESS ) {
 395     wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"),
 396                   GetName().c_str());
 397     return FALSE;
 398   }
 399   else
 400   {
 401     m_hKey = (WXHKEY) tmpKey;
 402     return TRUE;
 403   }
 404 }
 405
 406 // close the key, it's not an error to call it when not opened
 407 bool wxRegKey::Close()
 408 {
 409   if ( IsOpened() ) {
 410     m_dwLastError = RegCloseKey((HKEY) m_hKey);
 411     if ( m_dwLastError != ERROR_SUCCESS ) {
 412       wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"),
 413                     GetName().c_str());
 414
 415       m_hKey = 0;
 416       return FALSE;
 417     }
 418     else {
 419       m_hKey = 0;
 420     }
 421   }
 422
 423   return TRUE;
 424 }
 425
 426 bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew)
 427 {
 428     bool ok = TRUE;
 429     if ( HasValue(szValueNew) ) {
 430         wxLogError(_("Registry value '%s' already exists."), szValueNew);
 431
 432         ok = FALSE;
 433     }
 434
 435     if ( !ok ||
 436          !CopyValue(szValueOld, *this, szValueNew) ||
 437          !DeleteValue(szValueOld) ) {
 438         wxLogError(_("Failed to rename registry value '%s' to '%s'."),
 439                    szValueOld, szValueNew);
 440
 441         return FALSE;
 442     }
 443
 444     return TRUE;
 445 }
 446
 447 bool wxRegKey::CopyValue(const wxChar *szValue,
 448                          wxRegKey& keyDst,
 449                          const wxChar *szValueNew)
 450 {
 451     if ( !szValueNew ) {
 452         // by default, use the same name
 453         szValueNew = szValue;
 454     }
 455
 456     switch ( GetValueType(szValue) ) {
 457         case Type_String:
 458             {
 459                 wxString strVal;
 460                 return QueryValue(szValue, strVal) &&
 461                        keyDst.SetValue(szValueNew, strVal);
 462             }
 463
 464         case Type_Dword:
 465         /* case Type_Dword_little_endian: == Type_Dword */
 466             {
 467                 long dwVal;
 468                 return QueryValue(szValue, &dwVal) &&
 469                        keyDst.SetValue(szValueNew, dwVal);
 470             }
 471
 472         // these types are unsupported because I am not sure about how
 473         // exactly they should be copied and because they shouldn't
 474         // occur among the application keys (supposedly created with
 475         // this class)
 476 #ifdef  __WIN32__
 477         case Type_None:
 478         case Type_Expand_String:
 479         case Type_Binary:
 480         case Type_Dword_big_endian:
 481         case Type_Link:
 482         case Type_Multi_String:
 483         case Type_Resource_list:
 484         case Type_Full_resource_descriptor:
 485         case Type_Resource_requirements_list:
 486 #endif // Win32
 487         default:
 488             wxLogError(_("Can't copy values of unsupported type %d."),
 489                        GetValueType(szValue));
 490             return FALSE;
 491     }
 492 }
 493
 494 bool wxRegKey::Rename(const wxChar *szNewName)
 495 {
 496     wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") );
 497
 498     if ( !Exists() ) {
 499         wxLogError(_("Registry key '%s' does not exist, cannot rename it."),
 500                    GetFullName(this));
 501
 502         return FALSE;
 503     }
 504
 505     // do we stay in the same hive?
 506     bool inSameHive = !wxStrchr(szNewName, REG_SEPARATOR);
 507
 508     // construct the full new name of the key
 509     wxRegKey keyDst;
 510
 511     if ( inSameHive ) {
 512         // rename the key to the new name under the same parent
 513         wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR);
 514         if ( !!strKey ) {
 515             // don't add '\\' in the start if strFullNewName is empty
 516             strKey += REG_SEPARATOR;
 517         }
 518
 519         strKey += szNewName;
 520
 521         keyDst.SetName(GetStdKeyFromHkey(m_hRootKey), strKey);
 522     }
 523     else {
 524         // this is the full name already
 525         keyDst.SetName(szNewName);
 526     }
 527
 528     bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
 529     if ( !ok ) {
 530         wxLogError(_("Registry key '%s' already exists."),
 531                    GetFullName(&keyDst));
 532     }
 533     else {
 534         ok = Copy(keyDst) && DeleteSelf();
 535     }
 536
 537     if ( !ok ) {
 538         wxLogError(_("Failed to rename the registry key '%s' to '%s'."),
 539                    GetFullName(this), GetFullName(&keyDst));
 540     }
 541     else {
 542         m_hRootKey = keyDst.m_hRootKey;
 543         m_strKey = keyDst.m_strKey;
 544     }
 545
 546     return ok;
 547 }
 548
 549 bool wxRegKey::Copy(const wxChar *szNewName)
 550 {
 551     // create the new key first
 552     wxRegKey keyDst(szNewName);
 553     bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
 554     if ( ok ) {
 555         ok = Copy(keyDst);
 556
 557         // we created the dest key but copying to it failed - delete it
 558         if ( !ok ) {
 559             (void)keyDst.DeleteSelf();
 560         }
 561     }
 562
 563     return ok;
 564 }
 565
 566 bool wxRegKey::Copy(wxRegKey& keyDst)
 567 {
 568     bool ok = TRUE;
 569
 570     // copy all sub keys to the new location
 571     wxString strKey;
 572     long lIndex;
 573     bool bCont = GetFirstKey(strKey, lIndex);
 574     while ( ok && bCont ) {
 575         wxRegKey key(*this, strKey);
 576         wxString keyName;
 577         keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey;
 578         ok = key.Copy((const wxChar*) keyName);
 579
 580         if ( ok )
 581             bCont = GetNextKey(strKey, lIndex);
 582     }
 583
 584     // copy all values
 585     wxString strVal;
 586     bCont = GetFirstValue(strVal, lIndex);
 587     while ( ok && bCont ) {
 588         ok = CopyValue(strVal, keyDst);
 589
 590         if ( !ok ) {
 591             wxLogSysError(m_dwLastError,
 592                           _("Failed to copy registry value '%s'"),
 593                           strVal.c_str());
 594         }
 595         else {
 596             bCont = GetNextValue(strVal, lIndex);
 597         }
 598     }
 599
 600     if ( !ok ) {
 601         wxLogError(_("Failed to copy the contents of registry key '%s' to '%s'."), GetFullName(this), GetFullName(&keyDst));
 602     }
 603
 604     return ok;
 605 }
 606
 607 // ----------------------------------------------------------------------------
 608 // delete keys/values
 609 // ----------------------------------------------------------------------------
 610 bool wxRegKey::DeleteSelf()
 611 {
 612   {
 613     wxLogNull nolog;
 614     if ( !Open() ) {
 615       // it already doesn't exist - ok!
 616       return TRUE;
 617     }
 618   }
 619
 620   // prevent a buggy program from erasing one of the root registry keys or an
 621   // immediate subkey (i.e. one which doesn't have '\\' inside) of any other
 622   // key except HKCR (HKCR has some "deleteable" subkeys)
 623   if ( m_strKey.IsEmpty() ||
 624        ((m_hRootKey != (WXHKEY) aStdKeys[HKCR].hkey) &&
 625         (m_strKey.Find(REG_SEPARATOR) == wxNOT_FOUND)) ) {
 626       wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."), GetFullName(this));
 627
 628       return FALSE;
 629   }
 630
 631   // we can't delete keys while enumerating because it confuses GetNextKey, so
 632   // we first save the key names and then delete them all
 633   wxArrayString astrSubkeys;
 634
 635   wxString strKey;
 636   long lIndex;
 637   bool bCont = GetFirstKey(strKey, lIndex);
 638   while ( bCont ) {
 639     astrSubkeys.Add(strKey);
 640
 641     bCont = GetNextKey(strKey, lIndex);
 642   }
 643
 644   size_t nKeyCount = astrSubkeys.Count();
 645   for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
 646     wxRegKey key(*this, astrSubkeys[nKey]);
 647     if ( !key.DeleteSelf() )
 648       return FALSE;
 649   }
 650
 651   // now delete this key itself
 652   Close();
 653
 654   m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey);
 655   if ( m_dwLastError != ERROR_SUCCESS ) {
 656     wxLogSysError(m_dwLastError, _("Can't delete key '%s'"),
 657                   GetName().c_str());
 658     return FALSE;
 659   }
 660
 661   return TRUE;
 662 }
 663
 664 bool wxRegKey::DeleteKey(const wxChar *szKey)
 665 {
 666   if ( !Open() )
 667     return FALSE;
 668
 669   wxRegKey key(*this, szKey);
 670   return key.DeleteSelf();
 671 }
 672
 673 bool wxRegKey::DeleteValue(const wxChar *szValue)
 674 {
 675   if ( !Open() )
 676     return FALSE;
 677
 678 #if defined(__WIN32__) && !defined(__TWIN32__)
 679     m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue);
 680     if ( m_dwLastError != ERROR_SUCCESS ) {
 681       wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"),
 682                     szValue, GetName().c_str());
 683       return FALSE;
 684     }
 685   #else   //WIN16
 686     // named registry values don't exist in Win16 world
 687     wxASSERT( IsEmpty(szValue) );
 688
 689     // just set the (default and unique) value of the key to ""
 690     m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED);
 691     if ( m_dwLastError != ERROR_SUCCESS ) {
 692       wxLogSysError(m_dwLastError, _("Can't delete value of key '%s'"),
 693                     GetName().c_str());
 694       return FALSE;
 695     }
 696   #endif  //WIN16/32
 697
 698   return TRUE;
 699 }
 700
 701 // ----------------------------------------------------------------------------
 702 // access to values and subkeys
 703 // ----------------------------------------------------------------------------
 704
 705 // return TRUE if value exists
 706 bool wxRegKey::HasValue(const wxChar *szValue) const
 707 {
 708   // this function should be silent, so suppress possible messages from Open()
 709   wxLogNull nolog;
 710
 711   #ifdef  __WIN32__
 712     if ( !CONST_CAST Open() )
 713         return FALSE;
 714
 715     LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey,
 716                                    WXSTRINGCAST szValue,
 717                                    RESERVED,
 718                                    NULL, NULL, NULL);
 719     return dwRet == ERROR_SUCCESS;
 720   #else   // WIN16
 721     // only unnamed value exists
 722     return IsEmpty(szValue);
 723   #endif  // WIN16/32
 724 }
 725
 726 // returns TRUE if this key has any values
 727 bool wxRegKey::HasValues() const
 728 {
 729   // suppress possible messages from GetFirstValue()
 730   wxLogNull nolog;
 731
 732   // just call GetFirstValue with dummy parameters
 733   wxString str;
 734   long     l;
 735   return CONST_CAST GetFirstValue(str, l);
 736 }
 737
 738 // returns TRUE if this key has any subkeys
 739 bool wxRegKey::HasSubkeys() const
 740 {
 741   // suppress possible messages from GetFirstKey()
 742   wxLogNull nolog;
 743
 744   // just call GetFirstKey with dummy parameters
 745   wxString str;
 746   long     l;
 747   return CONST_CAST GetFirstKey(str, l);
 748 }
 749
 750 // returns TRUE if given subkey exists
 751 bool wxRegKey::HasSubKey(const wxChar *szKey) const
 752 {
 753   // this function should be silent, so suppress possible messages from Open()
 754   wxLogNull nolog;
 755
 756   if ( !CONST_CAST Open() )
 757     return FALSE;
 758
 759   return KeyExists(m_hKey, szKey);
 760 }
 761
 762 wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const
 763 {
 764   #ifdef  __WIN32__
 765     if ( ! CONST_CAST Open() )
 766       return Type_None;
 767
 768     DWORD dwType;
 769     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 770                                     &dwType, NULL, NULL);
 771     if ( m_dwLastError != ERROR_SUCCESS ) {
 772       wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
 773                     GetName().c_str());
 774       return Type_None;
 775     }
 776
 777     return (ValueType)dwType;
 778   #else   //WIN16
 779     return IsEmpty(szValue) ? Type_String : Type_None;
 780   #endif  //WIN16/32
 781 }
 782
 783 #ifdef  __WIN32__
 784 bool wxRegKey::SetValue(const wxChar *szValue, long lValue)
 785 {
 786 #ifdef __TWIN32__
 787   wxFAIL_MSG("RegSetValueEx not implemented by TWIN32");
 788   return FALSE;
 789 #else
 790   if ( CONST_CAST Open() ) {
 791     m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD,
 792                                   (RegString)&lValue, sizeof(lValue));
 793     if ( m_dwLastError == ERROR_SUCCESS )
 794       return TRUE;
 795   }
 796
 797   wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
 798                 GetFullName(this, szValue));
 799   return FALSE;
 800 #endif
 801 }
 802
 803 bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const
 804 {
 805   if ( CONST_CAST Open() ) {
 806     DWORD dwType, dwSize = sizeof(DWORD);
 807     RegString pBuf = (RegString)plValue;
 808     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 809                                     &dwType, pBuf, &dwSize);
 810     if ( m_dwLastError != ERROR_SUCCESS ) {
 811       wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
 812                     GetName().c_str());
 813       return FALSE;
 814     }
 815     else {
 816       // check that we read the value of right type
 817       wxASSERT_MSG( IsNumericValue(szValue),
 818                     wxT("Type mismatch in wxRegKey::QueryValue().")  );
 819
 820       return TRUE;
 821     }
 822   }
 823   else
 824     return FALSE;
 825 }
 826
 827 #endif  //Win32
 828
 829 bool wxRegKey::QueryValue(const wxChar *szValue,
 830                           wxString& strValue,
 831                           bool raw) const
 832 {
 833   if ( CONST_CAST Open() ) {
 834     #ifdef  __WIN32__
 835       // first get the type and size of the data
 836       DWORD dwType, dwSize;
 837       m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 838                                       &dwType, NULL, &dwSize);
 839       if ( m_dwLastError == ERROR_SUCCESS ) {
 840         if ( !dwSize ) {
 841             // must treat this case specially as GetWriteBuf() doesn't like
 842             // being called with 0 size
 843             strValue.Empty();
 844         }
 845         else {
 846             RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
 847             m_dwLastError = RegQueryValueEx((HKEY) m_hKey,
 848                                             WXSTRINGCAST szValue,
 849                                             RESERVED,
 850                                             &dwType,
 851                                             pBuf,
 852                                             &dwSize);
 853             strValue.UngetWriteBuf();
 854
 855             // expand the var expansions in the string unless disabled
 856             if ( (dwType == REG_EXPAND_SZ) && !raw )
 857             {
 858                 DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue, NULL, 0);
 859                 bool ok = dwExpSize != 0;
 860                 if ( ok )
 861                 {
 862                     wxString strExpValue;
 863                     ok = ::ExpandEnvironmentStrings
 864                            (
 865                             strValue,
 866                             strExpValue.GetWriteBuf(dwExpSize),
 867                             dwExpSize
 868                            ) != 0;
 869                     strExpValue.UngetWriteBuf();
 870                     strValue = strExpValue;
 871                 }
 872
 873                 if ( !ok )
 874                 {
 875                     wxLogLastError(_T("ExpandEnvironmentStrings"));
 876                 }
 877             }
 878         }
 879
 880         if ( m_dwLastError == ERROR_SUCCESS ) {
 881           // check that it was the right type
 882           wxASSERT_MSG( !IsNumericValue(szValue),
 883                         wxT("Type mismatch in wxRegKey::QueryValue().") );
 884
 885           return TRUE;
 886         }
 887       }
 888     #else   //WIN16
 889       // named registry values don't exist in Win16
 890       wxASSERT( IsEmpty(szValue) );
 891
 892       m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l);
 893       strValue.UngetWriteBuf();
 894       if ( m_dwLastError == ERROR_SUCCESS )
 895         return TRUE;
 896     #endif  //WIN16/32
 897   }
 898
 899   wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
 900                 GetFullName(this, szValue));
 901   return FALSE;
 902 }
 903
 904 bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue)
 905 {
 906   if ( CONST_CAST Open() ) {
 907 #if defined( __WIN32__) && !defined(__TWIN32__)
 908       m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
 909                                     (RegString)strValue.c_str(),
 910                                     (strValue.Len() + 1)*sizeof(wxChar));
 911       if ( m_dwLastError == ERROR_SUCCESS )
 912         return TRUE;
 913     #else   //WIN16
 914       // named registry values don't exist in Win16
 915       wxASSERT( IsEmpty(szValue) );
 916
 917       m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL);
 918       if ( m_dwLastError == ERROR_SUCCESS )
 919         return TRUE;
 920     #endif  //WIN16/32
 921   }
 922
 923   wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
 924                 GetFullName(this, szValue));
 925   return FALSE;
 926 }
 927
 928 wxRegKey::operator wxString() const
 929 {
 930   wxString str;
 931   QueryValue(NULL, str);
 932   return str;
 933 }
 934
 935 // ----------------------------------------------------------------------------
 936 // enumeration
 937 // NB: all these functions require an index variable which allows to have
 938 //     several concurrently running indexations on the same key
 939 // ----------------------------------------------------------------------------
 940
 941 bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
 942 {
 943   if ( !Open() )
 944     return FALSE;
 945
 946   lIndex = 0;
 947   return GetNextValue(strValueName, lIndex);
 948 }
 949
 950 bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
 951 {
 952   wxASSERT( IsOpened() );
 953
 954   // are we already at the end of enumeration?
 955   if ( lIndex == -1 )
 956     return FALSE;
 957
 958 #if defined( __WIN32__) && !defined(__TWIN32__)
 959     wxChar  szValueName[1024];                  // @@ use RegQueryInfoKey...
 960     DWORD dwValueLen = WXSIZEOF(szValueName);
 961
 962     m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex++,
 963                                  szValueName, &dwValueLen,
 964                                  RESERVED,
 965                                  NULL,            // [out] type
 966                                  NULL,            // [out] buffer for value
 967                                  NULL);           // [i/o]  it's length
 968
 969     if ( m_dwLastError != ERROR_SUCCESS ) {
 970       if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
 971         m_dwLastError = ERROR_SUCCESS;
 972         lIndex = -1;
 973       }
 974       else {
 975         wxLogSysError(m_dwLastError, _("Can't enumerate values of key '%s'"),
 976                       GetName().c_str());
 977       }
 978
 979       return FALSE;
 980     }
 981
 982     strValueName = szValueName;
 983   #else   //WIN16
 984     // only one unnamed value
 985     wxASSERT( lIndex == 0 );
 986
 987     lIndex = -1;
 988     strValueName.Empty();
 989   #endif
 990
 991   return TRUE;
 992 }
 993
 994 bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
 995 {
 996   if ( !Open() )
 997     return FALSE;
 998
 999   lIndex = 0;
1000   return GetNextKey(strKeyName, lIndex);
1001 }
1002
1003 bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
1004 {
1005   wxASSERT( IsOpened() );
1006
1007   // are we already at the end of enumeration?
1008   if ( lIndex == -1 )
1009     return FALSE;
1010
1011   wxChar szKeyName[_MAX_PATH + 1];
1012   m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
1013
1014   if ( m_dwLastError != ERROR_SUCCESS ) {
1015     if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
1016       m_dwLastError = ERROR_SUCCESS;
1017       lIndex = -1;
1018     }
1019     else {
1020       wxLogSysError(m_dwLastError, _("Can't enumerate subkeys of key '%s'"),
1021                     GetName().c_str());
1022     }
1023
1024     return FALSE;
1025   }
1026
1027   strKeyName = szKeyName;
1028   return TRUE;
1029 }
1030
1031 // returns TRUE if the value contains a number (else it's some string)
1032 bool wxRegKey::IsNumericValue(const wxChar *szValue) const
1033   {
1034       ValueType type = GetValueType(szValue);
1035       switch ( type ) {
1036         case Type_Dword:
1037         /* case Type_Dword_little_endian: == Type_Dword */
1038         case Type_Dword_big_endian:
1039             return TRUE;
1040
1041         default:
1042             return FALSE;
1043       }
1044   }
1045
1046 // ============================================================================
1047 // implementation of global private functions
1048 // ============================================================================
1049
1050 bool KeyExists(WXHKEY hRootKey, const wxChar *szKey)
1051 {
1052   // don't close this key itself for the case of empty szKey!
1053   if ( wxIsEmpty(szKey) )
1054     return TRUE;
1055
1056   HKEY hkeyDummy;
1057   if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
1058     RegCloseKey(hkeyDummy);
1059     return TRUE;
1060   }
1061   else
1062     return FALSE;
1063 }
1064
1065 const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue)
1066 {
1067   static wxString s_str;
1068   s_str = pKey->GetName();
1069   if ( !wxIsEmpty(szValue) )
1070     s_str << wxT("\\") << szValue;
1071
1072   return s_str.c_str();
1073 }
1074
1075 void RemoveTrailingSeparator(wxString& str)
1076 {
1077   if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
1078     str.Truncate(str.Len() - 1);
1079 }
1080
1081 #endif
1082   // __WIN16__
1083