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        (NULL)
  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((HKEY) m_hRootKey, m_strKey,
 384       0, 0, &tmpKey);
 385   if ( m_dwLastError != ERROR_SUCCESS ) {
 386     wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"),
 387                   GetName().c_str());
 388     return FALSE;
 389   }
 390   else
 391   {
 392     m_hKey = (WXHKEY) tmpKey;
 393     return TRUE;
 394   }
 395 }
 396
 397 // creates key, failing if it exists and !bOkIfExists
 398 bool wxRegKey::Create(bool bOkIfExists)
 399 {
 400   // check for existence only if asked (i.e. order is important!)
 401   if ( !bOkIfExists && Exists() ) {
 402     return FALSE;
 403   }
 404
 405   if ( IsOpened() )
 406     return TRUE;
 407
 408   HKEY tmpKey;
 409 #ifdef __WXWINCE__
 410   DWORD disposition;
 411   m_dwLastError = RegCreateKeyEx((HKEY) m_hRootKey, m_strKey,
 412       NULL, // reserved
 413       NULL, // class string
 414       0,
 415       0,
 416       NULL,
 417       &tmpKey,
 418       &disposition);
 419 #else
 420   m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey);
 421 #endif
 422   if ( m_dwLastError != ERROR_SUCCESS ) {
 423     wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"),
 424                   GetName().c_str());
 425     return FALSE;
 426   }
 427   else
 428   {
 429     m_hKey = (WXHKEY) tmpKey;
 430     return TRUE;
 431   }
 432 }
 433
 434 // close the key, it's not an error to call it when not opened
 435 bool wxRegKey::Close()
 436 {
 437   if ( IsOpened() ) {
 438     m_dwLastError = RegCloseKey((HKEY) m_hKey);
 439     m_hKey = 0;
 440
 441     if ( m_dwLastError != ERROR_SUCCESS ) {
 442       wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"),
 443                     GetName().c_str());
 444
 445       return FALSE;
 446     }
 447   }
 448
 449   return TRUE;
 450 }
 451
 452 bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew)
 453 {
 454     bool ok = TRUE;
 455     if ( HasValue(szValueNew) ) {
 456         wxLogError(_("Registry value '%s' already exists."), szValueNew);
 457
 458         ok = FALSE;
 459     }
 460
 461     if ( !ok ||
 462          !CopyValue(szValueOld, *this, szValueNew) ||
 463          !DeleteValue(szValueOld) ) {
 464         wxLogError(_("Failed to rename registry value '%s' to '%s'."),
 465                    szValueOld, szValueNew);
 466
 467         return FALSE;
 468     }
 469
 470     return TRUE;
 471 }
 472
 473 bool wxRegKey::CopyValue(const wxChar *szValue,
 474                          wxRegKey& keyDst,
 475                          const wxChar *szValueNew)
 476 {
 477     if ( !szValueNew ) {
 478         // by default, use the same name
 479         szValueNew = szValue;
 480     }
 481
 482     switch ( GetValueType(szValue) ) {
 483         case Type_String:
 484             {
 485                 wxString strVal;
 486                 return QueryValue(szValue, strVal) &&
 487                        keyDst.SetValue(szValueNew, strVal);
 488             }
 489
 490         case Type_Dword:
 491         /* case Type_Dword_little_endian: == Type_Dword */
 492             {
 493                 long dwVal;
 494                 return QueryValue(szValue, &dwVal) &&
 495                        keyDst.SetValue(szValueNew, dwVal);
 496             }
 497
 498         // these types are unsupported because I am not sure about how
 499         // exactly they should be copied and because they shouldn't
 500         // occur among the application keys (supposedly created with
 501         // this class)
 502 #ifdef  __WIN32__
 503         case Type_None:
 504         case Type_Expand_String:
 505         case Type_Binary:
 506         case Type_Dword_big_endian:
 507         case Type_Link:
 508         case Type_Multi_String:
 509         case Type_Resource_list:
 510         case Type_Full_resource_descriptor:
 511         case Type_Resource_requirements_list:
 512 #endif // Win32
 513         default:
 514             wxLogError(_("Can't copy values of unsupported type %d."),
 515                        GetValueType(szValue));
 516             return FALSE;
 517     }
 518 }
 519
 520 bool wxRegKey::Rename(const wxChar *szNewName)
 521 {
 522     wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") );
 523
 524     if ( !Exists() ) {
 525         wxLogError(_("Registry key '%s' does not exist, cannot rename it."),
 526                    GetFullName(this));
 527
 528         return FALSE;
 529     }
 530
 531     // do we stay in the same hive?
 532     bool inSameHive = !wxStrchr(szNewName, REG_SEPARATOR);
 533
 534     // construct the full new name of the key
 535     wxRegKey keyDst;
 536
 537     if ( inSameHive ) {
 538         // rename the key to the new name under the same parent
 539         wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR);
 540         if ( !!strKey ) {
 541             // don't add '\\' in the start if strFullNewName is empty
 542             strKey += REG_SEPARATOR;
 543         }
 544
 545         strKey += szNewName;
 546
 547         keyDst.SetName(GetStdKeyFromHkey(m_hRootKey), strKey);
 548     }
 549     else {
 550         // this is the full name already
 551         keyDst.SetName(szNewName);
 552     }
 553
 554     bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
 555     if ( !ok ) {
 556         wxLogError(_("Registry key '%s' already exists."),
 557                    GetFullName(&keyDst));
 558     }
 559     else {
 560         ok = Copy(keyDst) && DeleteSelf();
 561     }
 562
 563     if ( !ok ) {
 564         wxLogError(_("Failed to rename the registry key '%s' to '%s'."),
 565                    GetFullName(this), GetFullName(&keyDst));
 566     }
 567     else {
 568         m_hRootKey = keyDst.m_hRootKey;
 569         m_strKey = keyDst.m_strKey;
 570     }
 571
 572     return ok;
 573 }
 574
 575 bool wxRegKey::Copy(const wxChar *szNewName)
 576 {
 577     // create the new key first
 578     wxRegKey keyDst(szNewName);
 579     bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
 580     if ( ok ) {
 581         ok = Copy(keyDst);
 582
 583         // we created the dest key but copying to it failed - delete it
 584         if ( !ok ) {
 585             (void)keyDst.DeleteSelf();
 586         }
 587     }
 588
 589     return ok;
 590 }
 591
 592 bool wxRegKey::Copy(wxRegKey& keyDst)
 593 {
 594     bool ok = TRUE;
 595
 596     // copy all sub keys to the new location
 597     wxString strKey;
 598     long lIndex;
 599     bool bCont = GetFirstKey(strKey, lIndex);
 600     while ( ok && bCont ) {
 601         wxRegKey key(*this, strKey);
 602         wxString keyName;
 603         keyName << GetFullName(&keyDst) << REG_SEPARATOR << strKey;
 604         ok = key.Copy((const wxChar*) keyName);
 605
 606         if ( ok )
 607             bCont = GetNextKey(strKey, lIndex);
 608     }
 609
 610     // copy all values
 611     wxString strVal;
 612     bCont = GetFirstValue(strVal, lIndex);
 613     while ( ok && bCont ) {
 614         ok = CopyValue(strVal, keyDst);
 615
 616         if ( !ok ) {
 617             wxLogSysError(m_dwLastError,
 618                           _("Failed to copy registry value '%s'"),
 619                           strVal.c_str());
 620         }
 621         else {
 622             bCont = GetNextValue(strVal, lIndex);
 623         }
 624     }
 625
 626     if ( !ok ) {
 627         wxLogError(_("Failed to copy the contents of registry key '%s' to '%s'."), GetFullName(this), GetFullName(&keyDst));
 628     }
 629
 630     return ok;
 631 }
 632
 633 // ----------------------------------------------------------------------------
 634 // delete keys/values
 635 // ----------------------------------------------------------------------------
 636 bool wxRegKey::DeleteSelf()
 637 {
 638   {
 639     wxLogNull nolog;
 640     if ( !Open() ) {
 641       // it already doesn't exist - ok!
 642       return TRUE;
 643     }
 644   }
 645
 646   // prevent a buggy program from erasing one of the root registry keys or an
 647   // immediate subkey (i.e. one which doesn't have '\\' inside) of any other
 648   // key except HKCR (HKCR has some "deleteable" subkeys)
 649   if ( m_strKey.IsEmpty() ||
 650        ((m_hRootKey != (WXHKEY) aStdKeys[HKCR].hkey) &&
 651         (m_strKey.Find(REG_SEPARATOR) == wxNOT_FOUND)) ) {
 652       wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."), GetFullName(this));
 653
 654       return FALSE;
 655   }
 656
 657   // we can't delete keys while enumerating because it confuses GetNextKey, so
 658   // we first save the key names and then delete them all
 659   wxArrayString astrSubkeys;
 660
 661   wxString strKey;
 662   long lIndex;
 663   bool bCont = GetFirstKey(strKey, lIndex);
 664   while ( bCont ) {
 665     astrSubkeys.Add(strKey);
 666
 667     bCont = GetNextKey(strKey, lIndex);
 668   }
 669
 670   size_t nKeyCount = astrSubkeys.Count();
 671   for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
 672     wxRegKey key(*this, astrSubkeys[nKey]);
 673     if ( !key.DeleteSelf() )
 674       return FALSE;
 675   }
 676
 677   // now delete this key itself
 678   Close();
 679
 680   m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey);
 681   if ( m_dwLastError != ERROR_SUCCESS ) {
 682     wxLogSysError(m_dwLastError, _("Can't delete key '%s'"),
 683                   GetName().c_str());
 684     return FALSE;
 685   }
 686
 687   return TRUE;
 688 }
 689
 690 bool wxRegKey::DeleteKey(const wxChar *szKey)
 691 {
 692   if ( !Open() )
 693     return FALSE;
 694
 695   wxRegKey key(*this, szKey);
 696   return key.DeleteSelf();
 697 }
 698
 699 bool wxRegKey::DeleteValue(const wxChar *szValue)
 700 {
 701   if ( !Open() )
 702     return FALSE;
 703
 704 #if defined(__WIN32__)
 705     m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue);
 706
 707     // deleting a value which doesn't exist is not considered an error
 708     if ( (m_dwLastError != ERROR_SUCCESS) &&
 709          (m_dwLastError != ERROR_FILE_NOT_FOUND) ) {
 710       wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"),
 711                     szValue, GetName().c_str());
 712       return FALSE;
 713     }
 714 #else   //WIN16
 715     // named registry values don't exist in Win16 world
 716     wxASSERT( IsEmpty(szValue) );
 717
 718     // just set the (default and unique) value of the key to ""
 719     m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED);
 720     if ( m_dwLastError != ERROR_SUCCESS ) {
 721       wxLogSysError(m_dwLastError, _("Can't delete value of key '%s'"),
 722                     GetName().c_str());
 723       return FALSE;
 724     }
 725 #endif  //WIN16/32
 726
 727   return TRUE;
 728 }
 729
 730 // ----------------------------------------------------------------------------
 731 // access to values and subkeys
 732 // ----------------------------------------------------------------------------
 733
 734 // return TRUE if value exists
 735 bool wxRegKey::HasValue(const wxChar *szValue) const
 736 {
 737   // this function should be silent, so suppress possible messages from Open()
 738   wxLogNull nolog;
 739
 740   #ifdef  __WIN32__
 741     if ( !CONST_CAST Open() )
 742         return FALSE;
 743
 744     LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey,
 745                                    WXSTRINGCAST szValue,
 746                                    RESERVED,
 747                                    NULL, NULL, NULL);
 748     return dwRet == ERROR_SUCCESS;
 749   #else   // WIN16
 750     // only unnamed value exists
 751     return IsEmpty(szValue);
 752   #endif  // WIN16/32
 753 }
 754
 755 // returns TRUE if this key has any values
 756 bool wxRegKey::HasValues() const
 757 {
 758   // suppress possible messages from GetFirstValue()
 759   wxLogNull nolog;
 760
 761   // just call GetFirstValue with dummy parameters
 762   wxString str;
 763   long     l;
 764   return CONST_CAST GetFirstValue(str, l);
 765 }
 766
 767 // returns TRUE if this key has any subkeys
 768 bool wxRegKey::HasSubkeys() const
 769 {
 770   // suppress possible messages from GetFirstKey()
 771   wxLogNull nolog;
 772
 773   // just call GetFirstKey with dummy parameters
 774   wxString str;
 775   long     l;
 776   return CONST_CAST GetFirstKey(str, l);
 777 }
 778
 779 // returns TRUE if given subkey exists
 780 bool wxRegKey::HasSubKey(const wxChar *szKey) const
 781 {
 782   // this function should be silent, so suppress possible messages from Open()
 783   wxLogNull nolog;
 784
 785   if ( !CONST_CAST Open() )
 786     return FALSE;
 787
 788   return KeyExists(m_hKey, szKey);
 789 }
 790
 791 wxRegKey::ValueType wxRegKey::GetValueType(const wxChar *szValue) const
 792 {
 793   #ifdef  __WIN32__
 794     if ( ! CONST_CAST Open() )
 795       return Type_None;
 796
 797     DWORD dwType;
 798     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 799                                     &dwType, NULL, NULL);
 800     if ( m_dwLastError != ERROR_SUCCESS ) {
 801       wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
 802                     GetName().c_str());
 803       return Type_None;
 804     }
 805
 806     return (ValueType)dwType;
 807   #else   //WIN16
 808     return IsEmpty(szValue) ? Type_String : Type_None;
 809   #endif  //WIN16/32
 810 }
 811
 812 #ifdef  __WIN32__
 813 bool wxRegKey::SetValue(const wxChar *szValue, long lValue)
 814 {
 815   if ( CONST_CAST Open() ) {
 816     m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD,
 817                                   (RegString)&lValue, sizeof(lValue));
 818     if ( m_dwLastError == ERROR_SUCCESS )
 819       return TRUE;
 820   }
 821
 822   wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
 823                 GetFullName(this, szValue));
 824   return FALSE;
 825 }
 826
 827 bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const
 828 {
 829   if ( CONST_CAST Open() ) {
 830     DWORD dwType, dwSize = sizeof(DWORD);
 831     RegString pBuf = (RegString)plValue;
 832     m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 833                                     &dwType, pBuf, &dwSize);
 834     if ( m_dwLastError != ERROR_SUCCESS ) {
 835       wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
 836                     GetName().c_str());
 837       return FALSE;
 838     }
 839     else {
 840       // check that we read the value of right type
 841       wxASSERT_MSG( IsNumericValue(szValue),
 842                     wxT("Type mismatch in wxRegKey::QueryValue().")  );
 843
 844       return TRUE;
 845     }
 846   }
 847   else
 848     return FALSE;
 849 }
 850
 851 #endif  //Win32
 852
 853 bool wxRegKey::QueryValue(const wxChar *szValue,
 854                           wxString& strValue,
 855                           bool raw) const
 856 {
 857   if ( CONST_CAST Open() ) {
 858     #ifdef  __WIN32__
 859       // first get the type and size of the data
 860       DWORD dwType, dwSize;
 861       m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
 862                                       &dwType, NULL, &dwSize);
 863       if ( m_dwLastError == ERROR_SUCCESS ) {
 864         if ( !dwSize ) {
 865             // must treat this case specially as GetWriteBuf() doesn't like
 866             // being called with 0 size
 867             strValue.Empty();
 868         }
 869         else {
 870             RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize);
 871             m_dwLastError = RegQueryValueEx((HKEY) m_hKey,
 872                                             WXSTRINGCAST szValue,
 873                                             RESERVED,
 874                                             &dwType,
 875                                             pBuf,
 876                                             &dwSize);
 877             strValue.UngetWriteBuf();
 878
 879             // expand the var expansions in the string unless disabled
 880 #ifndef __WXWINCE__
 881             if ( (dwType == REG_EXPAND_SZ) && !raw )
 882             {
 883                 DWORD dwExpSize = ::ExpandEnvironmentStrings(strValue, NULL, 0);
 884                 bool ok = dwExpSize != 0;
 885                 if ( ok )
 886                 {
 887                     wxString strExpValue;
 888                     ok = ::ExpandEnvironmentStrings
 889                            (
 890                             strValue,
 891                             strExpValue.GetWriteBuf(dwExpSize),
 892                             dwExpSize
 893                            ) != 0;
 894                     strExpValue.UngetWriteBuf();
 895                     strValue = strExpValue;
 896                 }
 897
 898                 if ( !ok )
 899                 {
 900                     wxLogLastError(_T("ExpandEnvironmentStrings"));
 901                 }
 902             }
 903 #endif
 904             // __WXWINCE__
 905         }
 906
 907         if ( m_dwLastError == ERROR_SUCCESS ) {
 908           // check that it was the right type
 909           wxASSERT_MSG( !IsNumericValue(szValue),
 910                         wxT("Type mismatch in wxRegKey::QueryValue().") );
 911
 912           return TRUE;
 913         }
 914       }
 915     #else   //WIN16
 916       // named registry values don't exist in Win16
 917       wxASSERT( IsEmpty(szValue) );
 918
 919       m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l);
 920       strValue.UngetWriteBuf();
 921       if ( m_dwLastError == ERROR_SUCCESS )
 922         return TRUE;
 923     #endif  //WIN16/32
 924   }
 925
 926   wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
 927                 GetFullName(this, szValue));
 928   return FALSE;
 929 }
 930
 931 bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue)
 932 {
 933   if ( CONST_CAST Open() ) {
 934 #if defined( __WIN32__)
 935       m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ,
 936                                     (RegString)strValue.c_str(),
 937                                     (strValue.Len() + 1)*sizeof(wxChar));
 938       if ( m_dwLastError == ERROR_SUCCESS )
 939         return TRUE;
 940 #else   //WIN16
 941       // named registry values don't exist in Win16
 942       wxASSERT( IsEmpty(szValue) );
 943
 944       m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL);
 945       if ( m_dwLastError == ERROR_SUCCESS )
 946         return TRUE;
 947 #endif  //WIN16/32
 948   }
 949
 950   wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
 951                 GetFullName(this, szValue));
 952   return FALSE;
 953 }
 954
 955 wxString wxRegKey::QueryDefaultValue() const
 956 {
 957   wxString str;
 958   QueryValue(NULL, str);
 959   return str;
 960 }
 961
 962 // ----------------------------------------------------------------------------
 963 // enumeration
 964 // NB: all these functions require an index variable which allows to have
 965 //     several concurrently running indexations on the same key
 966 // ----------------------------------------------------------------------------
 967
 968 bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
 969 {
 970   if ( !Open() )
 971     return FALSE;
 972
 973   lIndex = 0;
 974   return GetNextValue(strValueName, lIndex);
 975 }
 976
 977 bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const
 978 {
 979   wxASSERT( IsOpened() );
 980
 981   // are we already at the end of enumeration?
 982   if ( lIndex == -1 )
 983     return FALSE;
 984
 985 #if defined( __WIN32__)
 986     wxChar  szValueName[1024];                  // @@ use RegQueryInfoKey...
 987     DWORD dwValueLen = WXSIZEOF(szValueName);
 988
 989     m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex++,
 990                                  szValueName, &dwValueLen,
 991                                  RESERVED,
 992                                  NULL,            // [out] type
 993                                  NULL,            // [out] buffer for value
 994                                  NULL);           // [i/o]  it's length
 995
 996     if ( m_dwLastError != ERROR_SUCCESS ) {
 997       if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
 998         m_dwLastError = ERROR_SUCCESS;
 999         lIndex = -1;
1000       }
1001       else {
1002         wxLogSysError(m_dwLastError, _("Can't enumerate values of key '%s'"),
1003                       GetName().c_str());
1004       }
1005
1006       return FALSE;
1007     }
1008
1009     strValueName = szValueName;
1010 #else   //WIN16
1011     // only one unnamed value
1012     wxASSERT( lIndex == 0 );
1013
1014     lIndex = -1;
1015     strValueName.Empty();
1016 #endif
1017
1018   return TRUE;
1019 }
1020
1021 bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
1022 {
1023   if ( !Open() )
1024     return FALSE;
1025
1026   lIndex = 0;
1027   return GetNextKey(strKeyName, lIndex);
1028 }
1029
1030 bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const
1031 {
1032   wxASSERT( IsOpened() );
1033
1034   // are we already at the end of enumeration?
1035   if ( lIndex == -1 )
1036     return FALSE;
1037
1038   wxChar szKeyName[_MAX_PATH + 1];
1039
1040 #ifdef __WXWINCE__
1041   DWORD sizeName = WXSIZEOF(szKeyName);
1042   m_dwLastError = RegEnumKeyEx((HKEY) m_hKey, lIndex++, szKeyName, & sizeName,
1043       0, NULL, NULL, NULL);
1044 #else
1045   m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName));
1046 #endif
1047
1048   if ( m_dwLastError != ERROR_SUCCESS ) {
1049     if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) {
1050       m_dwLastError = ERROR_SUCCESS;
1051       lIndex = -1;
1052     }
1053     else {
1054       wxLogSysError(m_dwLastError, _("Can't enumerate subkeys of key '%s'"),
1055                     GetName().c_str());
1056     }
1057
1058     return FALSE;
1059   }
1060
1061   strKeyName = szKeyName;
1062   return TRUE;
1063 }
1064
1065 // returns TRUE if the value contains a number (else it's some string)
1066 bool wxRegKey::IsNumericValue(const wxChar *szValue) const
1067   {
1068       ValueType type = GetValueType(szValue);
1069       switch ( type ) {
1070         case Type_Dword:
1071         /* case Type_Dword_little_endian: == Type_Dword */
1072         case Type_Dword_big_endian:
1073             return TRUE;
1074
1075         default:
1076             return FALSE;
1077       }
1078   }
1079
1080 // ============================================================================
1081 // implementation of global private functions
1082 // ============================================================================
1083
1084 bool KeyExists(WXHKEY hRootKey, const wxChar *szKey)
1085 {
1086   // don't close this key itself for the case of empty szKey!
1087   if ( wxIsEmpty(szKey) )
1088     return TRUE;
1089
1090   HKEY hkeyDummy;
1091   if ( RegOpenKeyEx( (HKEY) hRootKey, szKey, 0, 0, &hkeyDummy) == ERROR_SUCCESS ) {
1092     RegCloseKey(hkeyDummy);
1093     return TRUE;
1094   }
1095   else
1096     return FALSE;
1097 }
1098
1099 const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue)
1100 {
1101   static wxString s_str;
1102   s_str = pKey->GetName();
1103   if ( !wxIsEmpty(szValue) )
1104     s_str << wxT("\\") << szValue;
1105
1106   return s_str.c_str();
1107 }
1108
1109 void RemoveTrailingSeparator(wxString& str)
1110 {
1111   if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR )
1112     str.Truncate(str.Len() - 1);
1113 }
1114
1115 #endif
1116   // __WIN16__
1117