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