]>
git.saurik.com Git - wxWidgets.git/blob - src/msw/regconf.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: msw/regconf.cpp
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "regconf.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
24 #include "wx/string.h"
34 #include "wx/config.h"
38 #include "wx/msw/registry.h"
39 #include "wx/msw/regconf.h"
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 // we put our data in HKLM\SOFTWARE_KEY\appname
46 #define SOFTWARE_KEY wxString("Software\\")
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 // get the value if the key is opened and it exists
53 bool TryGetValue(const wxRegKey
& key
, const wxString
& str
, wxString
& strVal
)
55 return key
.IsOpened() && key
.HasValue(str
) && key
.QueryValue(str
, strVal
);
58 bool TryGetValue(const wxRegKey
& key
, const wxString
& str
, long *plVal
)
60 return key
.IsOpened() && key
.HasValue(str
) && key
.QueryValue(str
, plVal
);
63 // ============================================================================
65 // ============================================================================
67 // ----------------------------------------------------------------------------
69 // ----------------------------------------------------------------------------
71 // create the config object which stores its data under HKCU\vendor\app and, if
72 // style & wxCONFIG_USE_GLOBAL_FILE, under HKLM\vendor\app
73 wxRegConfig::wxRegConfig(const wxString
& appName
, const wxString
& vendorName
,
74 const wxString
& strLocal
, const wxString
& strGlobal
,
76 : wxConfigBase(appName
, vendorName
, strLocal
, strGlobal
, style
)
80 bool bDoUseGlobal
= (style
& wxCONFIG_USE_GLOBAL_FILE
) != 0;
82 // the convention is to put the programs keys under <vendor>\<appname>
83 // (but it can be overriden by specifying the pathes explicitly in strLocal
85 if ( strLocal
.IsEmpty() || (strGlobal
.IsEmpty() && bDoUseGlobal
) )
87 if ( vendorName
.IsEmpty() )
90 strRoot
= wxTheApp
->GetVendorName();
97 // no '\\' needed if no vendor name
98 if ( !strRoot
.IsEmpty() )
103 if ( appName
.IsEmpty() )
105 wxCHECK_RET( wxTheApp
, wxT("No application name in wxRegConfig ctor!") );
106 strRoot
<< wxTheApp
->GetAppName();
113 //else: we don't need to do all the complicated stuff above
115 wxString str
= strLocal
.IsEmpty() ? strRoot
: strLocal
;
117 // as we're going to change the name of these keys fairly often and as
118 // there are only few of wxRegConfig objects (usually 1), we can allow
119 // ourselves to be generous and spend some memory to significantly improve
120 // performance of SetPath()
121 static const size_t MEMORY_PREALLOC
= 512;
123 m_keyLocalRoot
.ReserveMemoryForName(MEMORY_PREALLOC
);
124 m_keyLocal
.ReserveMemoryForName(MEMORY_PREALLOC
);
126 m_keyLocalRoot
.SetName(wxRegKey::HKCU
, SOFTWARE_KEY
+ str
);
127 m_keyLocal
.SetName(m_keyLocalRoot
, _T(""));
131 str
= strGlobal
.IsEmpty() ? strRoot
: strGlobal
;
133 m_keyGlobalRoot
.ReserveMemoryForName(MEMORY_PREALLOC
);
134 m_keyGlobal
.ReserveMemoryForName(MEMORY_PREALLOC
);
136 m_keyGlobalRoot
.SetName(wxRegKey::HKLM
, SOFTWARE_KEY
+ str
);
137 m_keyGlobal
.SetName(m_keyGlobalRoot
, _T(""));
140 // Create() will Open() if key already exists
141 m_keyLocalRoot
.Create();
143 // as it's the same key, Open() shouldn't fail (i.e. no need for Create())
146 // OTOH, this key may perfectly not exist, so suppress error messages the call
147 // to Open() might generate
151 m_keyGlobalRoot
.Open();
156 wxRegConfig::~wxRegConfig()
158 // nothing to do - key will be closed in their dtors
161 // ----------------------------------------------------------------------------
163 // ----------------------------------------------------------------------------
165 // this function is called a *lot* of times (as I learned after seeing from
166 // profiler output that it is called ~12000 times from Mahogany start up code!)
167 // so it is important to optimize it - in particular, avoid using generic
168 // string functions here and do everything manually because it is faster
170 // I still kept the old version to be able to check that the optimized code has
171 // the same output as the non optimized version.
172 void wxRegConfig::SetPath(const wxString
& strPath
)
174 // remember the old path
175 wxString strOldPath
= m_strPath
;
177 #ifdef WX_DEBUG_SET_PATH // non optimized version kept here for testing
178 wxString m_strPathAlt
;
181 wxArrayString aParts
;
183 // because GetPath() returns "" when we're at root, we must understand
184 // empty string as "/"
185 if ( strPath
.IsEmpty() || (strPath
[0] == wxCONFIG_PATH_SEPARATOR
) ) {
187 wxSplitPath(aParts
, strPath
);
190 // relative path, combine with current one
191 wxString strFullPath
= GetPath();
192 strFullPath
<< wxCONFIG_PATH_SEPARATOR
<< strPath
;
193 wxSplitPath(aParts
, strFullPath
);
196 // recombine path parts in one variable
198 m_strPathAlt
.Empty();
199 for ( size_t n
= 0; n
< aParts
.Count(); n
++ ) {
200 strRegPath
<< '\\' << aParts
[n
];
201 m_strPathAlt
<< wxCONFIG_PATH_SEPARATOR
<< aParts
[n
];
206 // check for the most common case first
207 if ( strPath
.empty() )
209 m_strPath
= wxCONFIG_PATH_SEPARATOR
;
213 // construct the full path
214 wxString strFullPath
;
215 if ( strPath
[0u] == wxCONFIG_PATH_SEPARATOR
)
218 strFullPath
= strPath
;
220 else // relative path
222 strFullPath
.reserve(2*m_strPath
.length());
224 strFullPath
<< m_strPath
;
225 if ( strFullPath
.Len() == 0 ||
226 strFullPath
.Last() != wxCONFIG_PATH_SEPARATOR
)
227 strFullPath
<< wxCONFIG_PATH_SEPARATOR
;
228 strFullPath
<< strPath
;
231 // simplify it: we need to handle ".." here
233 // count the total number of slashes we have to know if we can go upper
234 size_t totalSlashes
= 0;
236 // position of the last slash to be able to backtrack to it quickly if
237 // needed, but we set it to -1 if we don't have a valid position
239 // we only remember the last position which means that we handle ".."
240 // quite efficiently but not "../.." - however the latter should be
241 // much more rare, so it is probably ok
242 int posLastSlash
= -1;
244 const wxChar
*src
= strFullPath
.c_str();
245 size_t len
= strFullPath
.length();
246 const wxChar
*end
= src
+ len
;
248 wxChar
*dst
= m_strPath
.GetWriteBuf(len
);
251 for ( ; src
< end
; src
++, dst
++ )
253 if ( *src
== wxCONFIG_PATH_SEPARATOR
)
257 // note that we don't have to check for src < end here as
258 // *end == 0 so can't be '.'
259 if ( src
[1] == _T('.') && src
[2] == _T('.') &&
260 (src
+ 3 == end
|| src
[3] == wxCONFIG_PATH_SEPARATOR
) )
264 wxLogWarning(_("'%s' has extra '..', ignored."),
265 strFullPath
.c_str());
267 else // return to the previous path component
269 // do we already have its position?
270 if ( posLastSlash
== -1 )
272 // no, find it: note that we are sure to have one
273 // because totalSlashes > 0 so we don't have to
274 // check the boundary condition below
276 // this is more efficient than strrchr()
277 while ( *dst
!= wxCONFIG_PATH_SEPARATOR
)
282 else // the position of last slash was stored
285 dst
= start
+ posLastSlash
;
287 // invalidate posLastSlash
291 // this shouldn't happen
292 wxASSERT_MSG( *dst
== wxCONFIG_PATH_SEPARATOR
,
293 _T("error in wxRegConfig::SetPath") );
304 if ( (dst
== start
) || (dst
[-1] != wxCONFIG_PATH_SEPARATOR
) )
306 *dst
= wxCONFIG_PATH_SEPARATOR
;
308 posLastSlash
= dst
- start
;
312 //else: nothing to do, we squeeze several subseuquent
316 else // normal character
323 // NUL terminate the string
324 if ( dst
[-1] == wxCONFIG_PATH_SEPARATOR
&& (dst
!= start
+ 1) )
326 // if it has a trailing slash we remove it unless it is the only
333 m_strPath
.UngetWriteBuf(dst
- start
);
336 #ifdef WX_DEBUG_SET_PATH
337 wxASSERT( m_strPath
== m_strPathAlt
);
340 if ( m_strPath
== strOldPath
)
343 // registry APIs want backslashes instead of slashes
345 size_t len
= m_strPath
.length();
347 const wxChar
*src
= m_strPath
.c_str();
348 wxChar
*dst
= strRegPath
.GetWriteBuf(len
);
350 const wxChar
*end
= src
+ len
;
351 for ( ; src
< end
; src
++, dst
++ )
353 if ( *src
== wxCONFIG_PATH_SEPARATOR
)
359 strRegPath
.UngetWriteBuf(len
);
361 // this is not needed any longer as we don't create keys unnecessarily any
362 // more (now it is done on demand, i.e. only when they're going to contain
365 // as we create the registry key when SetPath(key) is done, we can be left
366 // with plenty of empty keys if this was only done to try to read some
367 // value which, in fact, doesn't exist - to prevent this from happening we
368 // automatically delete the old key if it was empty
369 if ( m_keyLocal
.Exists() && LocalKey().IsEmpty() )
371 m_keyLocal
.DeleteSelf();
375 // change current key(s)
376 m_keyLocal
.SetName(m_keyLocalRoot
, strRegPath
);
377 m_keyGlobal
.SetName(m_keyGlobalRoot
, strRegPath
);
379 // don't create it right now, wait until it is accessed
380 //m_keyLocal.Create();
386 // ----------------------------------------------------------------------------
387 // enumeration (works only with current group)
388 // ----------------------------------------------------------------------------
391 We want to enumerate all local keys/values after the global ones, but, of
392 course, we don't want to repeat a key which appears locally as well as
395 We use the 15th bit of lIndex for distinction between global and local.
398 #define LOCAL_MASK 0x8000
399 #define IS_LOCAL_INDEX(l) (((l) & LOCAL_MASK) != 0)
401 bool wxRegConfig::GetFirstGroup(wxString
& str
, long& lIndex
) const
404 return GetNextGroup(str
, lIndex
);
407 bool wxRegConfig::GetNextGroup(wxString
& str
, long& lIndex
) const
409 // are we already enumerating local entries?
410 if ( m_keyGlobal
.IsOpened() && !IS_LOCAL_INDEX(lIndex
) ) {
411 // try to find a global entry which doesn't appear locally
412 while ( m_keyGlobal
.GetNextKey(str
, lIndex
) ) {
413 if ( !m_keyLocal
.Exists() || !LocalKey().HasSubKey(str
) ) {
414 // ok, found one - return it
419 // no more global entries
420 lIndex
|= LOCAL_MASK
;
423 // if we don't have the key at all, don't try to enumerate anything under it
424 if ( !m_keyLocal
.Exists() )
427 // much easier with local entries: get the next one we find
428 // (don't forget to clear our flag bit and set it again later)
429 lIndex
&= ~LOCAL_MASK
;
430 bool bOk
= LocalKey().GetNextKey(str
, lIndex
);
431 lIndex
|= LOCAL_MASK
;
436 bool wxRegConfig::GetFirstEntry(wxString
& str
, long& lIndex
) const
439 return GetNextEntry(str
, lIndex
);
442 bool wxRegConfig::GetNextEntry(wxString
& str
, long& lIndex
) const
444 // are we already enumerating local entries?
445 if ( m_keyGlobal
.IsOpened() && !IS_LOCAL_INDEX(lIndex
) ) {
446 // try to find a global entry which doesn't appear locally
447 while ( m_keyGlobal
.GetNextValue(str
, lIndex
) ) {
448 if ( !m_keyLocal
.Exists() || !LocalKey().HasValue(str
) ) {
449 // ok, found one - return it
454 // no more global entries
455 lIndex
|= LOCAL_MASK
;
458 // if we don't have the key at all, don't try to enumerate anything under it
459 if ( !m_keyLocal
.Exists() )
462 // much easier with local entries: get the next one we find
463 // (don't forget to clear our flag bit and set it again later)
464 lIndex
&= ~LOCAL_MASK
;
465 bool bOk
= LocalKey().GetNextValue(str
, lIndex
);
466 lIndex
|= LOCAL_MASK
;
471 size_t wxRegConfig::GetNumberOfEntries(bool WXUNUSED(bRecursive
)) const
478 bool bCont
= ((wxRegConfig
*)this)->GetFirstEntry(str
, l
);
482 bCont
= ((wxRegConfig
*)this)->GetNextEntry(str
, l
);
488 size_t wxRegConfig::GetNumberOfGroups(bool WXUNUSED(bRecursive
)) const
495 bool bCont
= ((wxRegConfig
*)this)->GetFirstGroup(str
, l
);
499 bCont
= ((wxRegConfig
*)this)->GetNextGroup(str
, l
);
505 // ----------------------------------------------------------------------------
506 // tests for existence
507 // ----------------------------------------------------------------------------
509 bool wxRegConfig::HasGroup(const wxString
& key
) const
511 wxConfigPathChanger
path(this, key
);
513 wxString
strName(path
.Name());
515 return (m_keyLocal
.Exists() && LocalKey().HasSubKey(strName
)) ||
516 m_keyGlobal
.HasSubKey(strName
);
519 bool wxRegConfig::HasEntry(const wxString
& key
) const
521 wxConfigPathChanger
path(this, key
);
523 wxString
strName(path
.Name());
525 return (m_keyLocal
.Exists() && LocalKey().HasValue(strName
)) ||
526 m_keyGlobal
.HasValue(strName
);
529 wxConfigBase::EntryType
wxRegConfig::GetEntryType(const wxString
& key
) const
531 wxConfigPathChanger
path(this, key
);
533 wxString
strName(path
.Name());
536 if ( m_keyLocal
.Exists() && LocalKey().HasValue(strName
) )
537 isNumeric
= m_keyLocal
.IsNumericValue(strName
);
538 else if ( m_keyGlobal
.HasValue(strName
) )
539 isNumeric
= m_keyGlobal
.IsNumericValue(strName
);
541 return wxConfigBase::Type_Unknown
;
543 return isNumeric
? wxConfigBase::Type_Integer
: wxConfigBase::Type_String
;
546 // ----------------------------------------------------------------------------
548 // ----------------------------------------------------------------------------
550 bool wxRegConfig::Read(const wxString
& key
, wxString
*pStr
) const
552 wxConfigPathChanger
path(this, key
);
554 bool bQueryGlobal
= TRUE
;
556 // if immutable key exists in global key we must check that it's not
557 // overriden by the local key with the same name
558 if ( IsImmutable(path
.Name()) ) {
559 if ( TryGetValue(m_keyGlobal
, path
.Name(), *pStr
) ) {
560 if ( m_keyLocal
.Exists() && LocalKey().HasValue(path
.Name()) ) {
561 wxLogWarning(wxT("User value for immutable key '%s' ignored."),
562 path
.Name().c_str());
564 *pStr
= wxConfigBase::ExpandEnvVars(*pStr
);
568 // don't waste time - it's not there anyhow
569 bQueryGlobal
= FALSE
;
573 // first try local key
574 if ( (m_keyLocal
.Exists() && TryGetValue(LocalKey(), path
.Name(), *pStr
)) ||
575 (bQueryGlobal
&& TryGetValue(m_keyGlobal
, path
.Name(), *pStr
)) ) {
578 *pStr
= wxConfigBase::ExpandEnvVars(*pStr
);
585 bool wxRegConfig::Read(const wxString
& key
, wxString
*pStr
,
586 const wxString
& szDefault
) const
588 wxConfigPathChanger
path(this, key
);
590 bool bQueryGlobal
= TRUE
;
592 // if immutable key exists in global key we must check that it's not
593 // overriden by the local key with the same name
594 if ( IsImmutable(path
.Name()) ) {
595 if ( TryGetValue(m_keyGlobal
, path
.Name(), *pStr
) ) {
596 if ( m_keyLocal
.Exists() && LocalKey().HasValue(path
.Name()) ) {
597 wxLogWarning(wxT("User value for immutable key '%s' ignored."),
598 path
.Name().c_str());
604 // don't waste time - it's not there anyhow
605 bQueryGlobal
= FALSE
;
609 // first try local key
610 if ( (m_keyLocal
.Exists() && TryGetValue(LocalKey(), path
.Name(), *pStr
)) ||
611 (bQueryGlobal
&& TryGetValue(m_keyGlobal
, path
.Name(), *pStr
)) ) {
612 *pStr
= wxConfigBase::ExpandEnvVars(*pStr
);
616 if ( IsRecordingDefaults() ) {
617 ((wxRegConfig
*)this)->Write(key
, szDefault
);
624 *pStr
= wxConfigBase::ExpandEnvVars(*pStr
);
629 bool wxRegConfig::Read(const wxString
& key
, long *plResult
) const
631 wxConfigPathChanger
path(this, key
);
633 bool bQueryGlobal
= TRUE
;
635 // if immutable key exists in global key we must check that it's not
636 // overriden by the local key with the same name
637 if ( IsImmutable(path
.Name()) ) {
638 if ( TryGetValue(m_keyGlobal
, path
.Name(), plResult
) ) {
639 if ( m_keyLocal
.Exists() && LocalKey().HasValue(path
.Name()) ) {
640 wxLogWarning(wxT("User value for immutable key '%s' ignored."),
641 path
.Name().c_str());
647 // don't waste time - it's not there anyhow
648 bQueryGlobal
= FALSE
;
652 // first try local key
653 if ( (m_keyLocal
.Exists() && TryGetValue(LocalKey(), path
.Name(), plResult
)) ||
654 (bQueryGlobal
&& TryGetValue(m_keyGlobal
, path
.Name(), plResult
)) ) {
660 bool wxRegConfig::Write(const wxString
& key
, const wxString
& szValue
)
662 wxConfigPathChanger
path(this, key
);
664 if ( IsImmutable(path
.Name()) ) {
665 wxLogError(wxT("Can't change immutable entry '%s'."), path
.Name().c_str());
669 return LocalKey().SetValue(path
.Name(), szValue
);
672 bool wxRegConfig::Write(const wxString
& key
, long lValue
)
674 wxConfigPathChanger
path(this, key
);
676 if ( IsImmutable(path
.Name()) ) {
677 wxLogError(wxT("Can't change immutable entry '%s'."), path
.Name().c_str());
681 return LocalKey().SetValue(path
.Name(), lValue
);
684 // ----------------------------------------------------------------------------
686 // ----------------------------------------------------------------------------
688 bool wxRegConfig::RenameEntry(const wxString
& oldName
, const wxString
& newName
)
690 // check that the old entry exists...
691 if ( !HasEntry(oldName
) )
694 // and that the new one doesn't
695 if ( HasEntry(newName
) )
698 // delete the old entry and create the new one - but do in the reverse
699 // order to not lose the data if Create() fails
702 if ( m_keyLocal
.IsNumericValue(oldName
) )
705 ok
= m_keyLocal
.QueryValue(oldName
, &val
) &&
706 m_keyLocal
.SetValue(newName
, val
);
711 ok
= m_keyLocal
.QueryValue(oldName
, val
) &&
712 m_keyLocal
.SetValue(newName
, val
);
718 if ( !m_keyLocal
.DeleteValue(oldName
) )
720 m_keyLocal
.DeleteValue(newName
);
728 bool wxRegConfig::RenameGroup(const wxString
& oldName
, const wxString
& newName
)
730 // check that the old group exists...
731 if ( !HasGroup(oldName
) )
734 // and that the new one doesn't
735 if ( HasGroup(newName
) )
738 // TODO there is no way to rename a registry key - we must do a deep copy
740 wxFAIL_MSG(wxT("Registry key renaming not implemented"));
745 // ----------------------------------------------------------------------------
747 // ----------------------------------------------------------------------------
748 bool wxRegConfig::DeleteEntry(const wxString
& value
, bool WXUNUSED(bGroupIfEmptyAlso
))
750 wxConfigPathChanger
path(this, value
);
752 if ( m_keyLocal
.Exists() ) {
753 if ( !m_keyLocal
.DeleteValue(path
.Name()) )
756 if ( m_keyLocal
.IsEmpty() ) {
757 wxString strKey
= GetPath().AfterLast(wxCONFIG_PATH_SEPARATOR
);
758 SetPath(".."); // changes m_keyLocal
759 return LocalKey().DeleteKey(strKey
);
766 bool wxRegConfig::DeleteGroup(const wxString
& key
)
768 wxConfigPathChanger
path(this, key
);
770 return m_keyLocal
.Exists() ? LocalKey().DeleteKey(path
.Name()) : TRUE
;
773 bool wxRegConfig::DeleteAll()
778 bool bOk
= m_keyLocalRoot
.DeleteSelf();
780 // make sure that we opened m_keyGlobalRoot and so it has a reasonable name:
781 // otherwise we will delete HKEY_CLASSES_ROOT recursively
782 if ( bOk
&& m_keyGlobalRoot
.IsOpened() )
783 bOk
= m_keyGlobalRoot
.DeleteSelf();