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 #include  "wx/config.h"    // for wxExpandEnvVars
  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 char *szName;
  65   const char *szShortName;
  66 }
  67 aStdKeys[] =
  68 {
  69   { HKEY_CLASSES_ROOT,      "HKEY_CLASSES_ROOT",      "HKCR" },
  70 #ifdef  __WIN32__
  71   { HKEY_CURRENT_USER,      "HKEY_CURRENT_USER",      "HKCU" },
  72   { HKEY_LOCAL_MACHINE,     "HKEY_LOCAL_MACHINE",     "HKLM" },
  73   { HKEY_USERS,             "HKEY_USERS",             "HKU"  }, // short name?
  74   { HKEY_PERFORMANCE_DATA,  "HKEY_PERFORMANCE_DATA",  "HKPD" },
  75 #if     WINVER >= 0x0400
  76   { HKEY_CURRENT_CONFIG,    "HKEY_CURRENT_CONFIG",    "HKCC" },
  77 #ifndef __GNUWIN32__
  78   { HKEY_DYN_DATA,          "HKEY_DYN_DATA",          "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     '\\'
  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 char *szKey);
 110
 111 // combines value and key name (uses static buffer!)
 112 static const char *GetFullName(const wxRegKey *pKey,
 113                                const char *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 char *wxRegKey::GetStdKeyName(size_t key)
 128 {
 129   // return empty string if key is invalid
 130   wxCHECK_MSG( key < nStdKeys, "", "invalid key in wxRegKey::GetStdKeyName" );
 131
 132   return aStdKeys[key].szName;
 133 }
 134
 135 const char *wxRegKey::GetStdKeyShortName(size_t key)
 136 {
 137   // return empty string if key is invalid
 138   wxCHECK( key < nStdKeys, "" );
 139
 140   return aStdKeys[key].szShortName;
 141 }
 142
 143 wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey)
 144 {
 145   wxString strRoot = strKey.Left(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("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("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 #ifdef __GNUWIN32__
 305 bool wxRegKey::GetKeyInfo(size_t* pnSubKeys,
 306                           size_t* pnMaxKeyLen,
 307                           size_t* pnValues,
 308                           size_t* pnMaxValueLen) const
 309 #else
 310 bool wxRegKey::GetKeyInfo(ulong *pnSubKeys,
 311                           ulong *pnMaxKeyLen,
 312                           ulong *pnValues,
 313                           ulong *pnMaxValueLen) const
 314 #endif
 315 {
 316 #ifdef  __WIN32__
 317   m_dwLastError = ::RegQueryInfoKey
 318                   (
 319                     (HKEY) m_hKey,
 320                     NULL,           // class name
 321                     NULL,           // (ptr to) size of class name buffer
 322                     RESERVED,
 323                     pnSubKeys,      // [out] number of subkeys
 324                     pnMaxKeyLen,    // [out] max length of a subkey name
 325                     NULL,           // longest subkey class name
 326                     pnValues,       // [out] number of values
 327                     pnMaxValueLen,  // [out] max length of a value name
 328                     NULL,           // longest value data
 329                     NULL,           // security descriptor
 330                     NULL            // time of last modification
 331                   );
 332
 333   if ( m_dwLastError != ERROR_SUCCESS ) {
 334     wxLogSysError(m_dwLastError, _("can't get info about registry key '%s'"),
 335                   GetName().c_str());
 336     return FALSE;
 337   }
 338   else
 339     return TRUE;
 340 #else // Win16
 341   wxFAIL_MSG("GetKeyInfo() not implemented");
 342
 343   return FALSE;
 344 #endif
 345 }
 346
 347 // ----------------------------------------------------------------------------
 348 // operations
 349 // ----------------------------------------------------------------------------
 350
 351 // opens key (it's not an error to call Open() on an already opened key)
 352 bool wxRegKey::Open()
 353 {
 354   if ( IsOpened() )
 355     return TRUE;
 356
 357   HKEY tmpKey;
 358   m_dwLastError = RegOpenKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
 359   if ( m_dwLastError != ERROR_SUCCESS ) {
 360     wxLogSysError(m_dwLastError, _("can't open registry key '%s'"),
 361                   GetName().c_str());
 362     return FALSE;
 363   }
 364   else
 365   {
 366     m_hKey = (WXHKEY) tmpKey;
 367     return TRUE;
 368   }
 369 }
 370
 371 // creates key, failing if it exists and !bOkIfExists
 372 bool wxRegKey::Create(bool bOkIfExists)
 373 {
 374   // check for existence only if asked (i.e. order is important!)
 375   if ( !bOkIfExists && Exists() ) {
 376     return FALSE;
 377   }
 378
 379   if ( IsOpened() )
 380     return TRUE;
 381
 382   HKEY tmpKey;
 383   m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
 384   if ( m_dwLastError != ERROR_SUCCESS ) {
 385     wxLogSysError(m_dwLastError, _("can't create registry key '%s'"),
 386                   GetName().c_str());
 387     return FALSE;
 388   }
 389   else
 390   {
 391     m_hKey = (WXHKEY) tmpKey;
 392     return TRUE;
 393   }
 394 }
 395
 396 // close the key, it's not an error to call it when not opened
 397 bool wxRegKey::Close()
 398 {
 399   if ( IsOpened() ) {
 400     m_dwLastError = RegCloseKey((HKEY) m_hKey);
 401     if ( m_dwLastError != ERROR_SUCCESS ) {
 402       wxLogSysError(m_dwLastError, _("can't close registry key '%s'"),
 403                     GetName().c_str());
 404
 405       m_hKey = 0;
 406       return FALSE;
 407     }
 408     else {
 409       m_hKey = 0;
 410     }
 411   }
 412
 413   return TRUE;
 414 }
 415
 416 // ----------------------------------------------------------------------------
 417 // delete keys/values
 418 // ----------------------------------------------------------------------------
 419 bool wxRegKey::DeleteSelf()
 420 {
 421   {
 422     wxLogNull nolog;
 423     if ( !Open() ) {
 424       // it already doesn't exist - ok!
 425       return TRUE;
 426     }
 427   }
 428
 429   // we can't delete keys while enumerating because it confuses GetNextKey, so
 430   // we first save the key names and then delete them all
 431   wxArrayString astrSubkeys;
 432
 433   wxString strKey;
 434   long lIndex;
 435   bool bCont = GetFirstKey(strKey, lIndex);
 436   while ( bCont ) {
 437     astrSubkeys.Add(strKey);
 438
 439     bCont = GetNextKey(strKey, lIndex);
 440   }
 441
 442   size_t nKeyCount = astrSubkeys.Count();
 443   for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
 444     wxRegKey key(*this, astrSubkeys[nKey]);
 445     if ( !key.DeleteSelf() )
 446       return FALSE;
 447   }
 448
 449   // now delete this key itself
 450   Close();
 451
 452   m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey);
 453   if ( m_dwLastError != ERROR_SUCCESS ) {
 454     wxLogSysError(m_dwLastError, _("can't delete key '%s'"),
 455                   GetName().c_str());
 456     return FALSE;
 457   }
 458
 459   return TRUE;
 460 }
 461
 462 bool wxRegKey::DeleteKey(const char *szKey)
 463 {
 464   if ( !Open() )
 465     return FALSE;
 466
 467   wxRegKey key(*this, szKey);
 468   return key.DeleteSelf();
 469 }
 470
 471 bool wxRegKey::DeleteValue(const char *szValue)
 472 {
 473   if ( !Open() )
 474     return FALSE;
 475
 476   #ifdef  __WIN32__
 477     m_dwLastError = RegDeleteValue((HKEY) m_hKey, szValue);
 478     if ( m_dwLastError != ERROR_SUCCESS ) {
 479       wxLogSysError(m_dwLastError, _("can't delete value '%s' from key '%s'"),
 480                     szValue, GetName().c_str());
 481       return FALSE;
 482     }
 483   #else   //WIN16
 484     // named registry values don't exist in Win16 world
 485     wxASSERT( IsEmpty(szValue) );
 486
 487     // just set the (default and unique) value of the key to ""
 488     m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED);
 489     if ( m_dwLastError != ERROR_SUCCESS ) {
 490       wxLogSysError(m_dwLastError, _("can't delete value of key '%s'"),
 491                     GetName().c_str());
 492       return FALSE;
 493     }
 494   #endif  //WIN16/32
 495
 496   return TRUE;
 497 }
 498
 499 // ----------------------------------------------------------------------------
 500 // access to values and subkeys
 501 // ----------------------------------------------------------------------------
 502
 503 // return TRUE if value exists
 504 bool wxRegKey::HasValue(const char *szValue) const
 505 {
 506   // this function should be silent, so suppress possible messages from Open()
 507   wxLogNull nolog;
 508
 509   #ifdef  __WIN32__
 510     if ( CONST_CAST Open() ) {
 511       return RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
 512                              NULL, NULL, NULL) == ERROR_SUCCESS;
 513     }
 514     else
 515       return FALSE;
 516   #else   // WIN16
 517     // only unnamed value exists
 518     return IsEmpty(szValue);
 519   #endif  // WIN16/32
 520 }
 521
 522 // returns TRUE if this key has any subkeys
 523 bool wxRegKey::HasSubkeys() const
 524 {
 525   // just call GetFirstKey with dummy parameters
 526   wxString str;
 527   long     l;
 528   return CONST_CAST GetFirstKey(str, l);
 529 }
 530
 531 // returns TRUE if given subkey exists
 532 bool wxRegKey::HasSubKey(const char *szKey) const
 533 {
 534   if ( CONST_CAST Open() )
 535     return KeyExists(m_hKey, szKey);
 536   else
 537     return FALSE;
 538 }
 539
 540 wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue)
 541 {
 542   #ifdef  __WIN32__
 543     if ( !Open() )
 544       return Type_None;
 545
 546     DWORD dwType;
 547     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
 548                                     &dwType, NULL, NULL);
 549     if ( m_dwLastError != ERROR_SUCCESS ) {
 550       wxLogSysError(m_dwLastError, _("can't read value of key '%s'"),
 551                     GetName().c_str());
 552       return Type_None;
 553     }
 554
 555     return (ValueType)dwType;
 556   #else   //WIN16
 557     return IsEmpty(szValue) ? Type_String : Type_None;
 558   #endif  //WIN16/32
 559 }
 560
 561 #ifdef  __WIN32__
 562 bool wxRegKey::SetValue(const char *szValue, long lValue)
 563 {
 564   if ( CONST_CAST Open() ) {
 565     m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD,
 566                                   (RegString)&lValue, sizeof(lValue));
 567     if ( m_dwLastError == ERROR_SUCCESS )
 568       return TRUE;
 569   }
 570
 571   wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
 572                 GetFullName(this, szValue));
 573   return FALSE;
 574 }
 575
 576 bool wxRegKey::QueryValue(const char *szValue, long *plValue) const
 577 {
 578   if ( CONST_CAST Open() ) {
 579     DWORD dwType, dwSize = sizeof(DWORD);
 580     RegString pBuf = (RegString)plValue;
 581     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
 582                                     &dwType, pBuf, &dwSize);
 583     if ( m_dwLastError != ERROR_SUCCESS ) {
 584       wxLogSysError(m_dwLastError, _("can't read value of key '%s'"),
 585                     GetName().c_str());
 586       return FALSE;
 587     }
 588     else {
 589       // check that we read the value of right type
 590       wxASSERT_MSG( dwType == REG_DWORD,
 591                     "Type mismatch in wxRegKey::QueryValue()."  );
 592
 593       return TRUE;
 594     }
 595   }
 596   else
 597     return FALSE;
 598 }
 599
 600 #endif  //Win32
 601
 602 bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const
 603 {
 604   if ( CONST_CAST Open() ) {
 605     #ifdef  __WIN32__
 606       // first get the type and size of the data
 607       DWORD dwType, dwSize;
 608       m_dwLastError = RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
 609                                       &dwType, NULL, &dwSize);
 610       if ( m_dwLastError == ERROR_SUCCESS ) {
 611         RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
 612         m_dwLastError = RegQueryValueEx((HKEY) m_hKey, szValue, RESERVED,
 613                                         &dwType, pBuf, &dwSize);
 614         strValue.UngetWriteBuf();
 615         if ( m_dwLastError == ERROR_SUCCESS ) {
 616           // check that it was the right type
 617           wxASSERT_MSG( dwType == REG_SZ,
 618                         "Type mismatch in wxRegKey::QueryValue()." );
 619
 620           return TRUE;
 621         }
 622       }
 623     #else   //WIN16
 624       // named registry values don't exist in Win16
 625       wxASSERT( IsEmpty(szValue) );
 626
 627       m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l);
 628       strValue.UngetWriteBuf();
 629       if ( m_dwLastError == ERROR_SUCCESS )
 630         return TRUE;
 631     #endif  //WIN16/32
 632   }
 633
 634   wxLogSysError(m_dwLastError, _("can't read value of '%s'"),
 635                 GetFullName(this, szValue));
 636   return FALSE;
 637 }
 638
 639 bool wxRegKey::SetValue(const char *szValue, const wxString& strValue)
 640 {
 641   if ( CONST_CAST Open() ) {
 642     #ifdef  __WIN32__
 643       m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
 644                                     (RegString)strValue.c_str(),
 645                                     strValue.Len() + 1);
 646       if ( m_dwLastError == ERROR_SUCCESS )
 647         return TRUE;
 648     #else   //WIN16
 649       // named registry values don't exist in Win16
 650       wxASSERT( IsEmpty(szValue) );
 651
 652       m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL);
 653       if ( m_dwLastError == ERROR_SUCCESS )
 654         return TRUE;
 655     #endif  //WIN16/32
 656   }
 657
 658   wxLogSysError(m_dwLastError, _("can't set value of '%s'"),
 659                 GetFullName(this, szValue));
 660   return FALSE;
 661 }
 662
 663 wxRegKey::operator wxString() const
 664 {
 665   wxString str;
 666   QueryValue(NULL, str);
 667   return str;
 668 }
 669
 670 // ----------------------------------------------------------------------------
 671 // enumeration
 672 // NB: all these functions require an index variable which allows to have
 673 //     several concurrently running indexations on the same key
 674 // ----------------------------------------------------------------------------
 675
 676 bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
 677 {
 678   if ( !Open() )
 679     return FALSE;
 680
 681   lIndex = 0;
 682   return GetNextValue(strValueName, lIndex);
 683 }
 684
 685 bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
 686 {
 687   wxASSERT( IsOpened() );
 688
 689   // are we already at the end of enumeration?
 690   if ( lIndex == -1 )
 691     return FALSE;
 692
 693   #ifdef  __WIN32__
 694     char  szValueName[1024];                  // @@ use RegQueryInfoKey...
 695     DWORD dwValueLen = WXSIZEOF(szValueName);
 696
 697     lIndex++;
 698     m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex,
 699                                  szValueName, &dwValueLen,
 700                                  RESERVED,
 701                                  NULL,            // [out] type
 702                                  NULL,            // [out] buffer for value
 703                                  NULL);           // [i/o]  it's length
 704
 705     if ( m_dwLastError != ERROR_SUCCESS ) {
 706       if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
 707         m_dwLastError = ERROR_SUCCESS;
 708         lIndex = -1;
 709       }
 710       else {
 711         wxLogSysError(m_dwLastError, _("can't enumerate values of key '%s'"),
 712                       GetName().c_str());
 713       }
 714
 715       return FALSE;
 716     }
 717
 718     strValueName = szValueName;
 719   #else   //WIN16
 720     // only one unnamed value
 721     wxASSERT( lIndex == 0 );
 722
 723     lIndex = -1;
 724     strValueName.Empty();
 725   #endif
 726
 727   return TRUE;
 728 }
 729
 730 bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
 731 {
 732   if ( !Open() )
 733     return FALSE;
 734
 735   lIndex = 0;
 736   return GetNextKey(strKeyName, lIndex);
 737 }
 738
 739 bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
 740 {
 741   wxASSERT( IsOpened() );
 742
 743   // are we already at the end of enumeration?
 744   if ( lIndex == -1 )
 745     return FALSE;
 746
 747   char szKeyName[_MAX_PATH + 1];
 748   m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
 749
 750   if ( m_dwLastError != ERROR_SUCCESS ) {
 751     if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
 752       m_dwLastError = ERROR_SUCCESS;
 753       lIndex = -1;
 754     }
 755     else {
 756       wxLogSysError(m_dwLastError, _("can't enumerate subkeys of key '%s'"),
 757                     GetName().c_str());
 758     }
 759
 760     return FALSE;
 761   }
 762
 763   strKeyName = szKeyName;
 764   return TRUE;
 765 }
 766
 767 // ============================================================================
 768 // implementation of global private functions
 769 // ============================================================================
 770 bool KeyExists(WXHKEY hRootKey, const char *szKey)
 771 {
 772   HKEY hkeyDummy;
 773   if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) {
 774     RegCloseKey(hkeyDummy);
 775     return TRUE;
 776   }
 777   else
 778     return FALSE;
 779 }
 780
 781 const char *GetFullName(const wxRegKey *pKey, const char *szValue)
 782 {
 783   static wxString s_str;
 784   s_str = pKey->GetName();
 785   if ( !IsEmpty(szValue) )
 786     s_str << "\\" << szValue;
 787
 788   return s_str.c_str();
 789 }
 790
 791 void RemoveTrailingSeparator(wxString& str)
 792 {
 793   if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
 794     str.Truncate(str.Len() - 1);
 795 }