]> git.saurik.com Git - wxWidgets.git/blob - src/msw/regconf.cpp
added wrapper for <commctrl.h> as well
[wxWidgets.git] / src / msw / regconf.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: msw/regconf.cpp
3 // Purpose:
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 27.04.98
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifdef __GNUG__
13 #pragma implementation "regconf.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #ifndef WX_PRECOMP
24 #include "wx/string.h"
25 #include "wx/intl.h"
26 #endif //WX_PRECOMP
27
28 #include "wx/event.h"
29 #include "wx/app.h"
30 #include "wx/log.h"
31
32 #if wxUSE_CONFIG
33
34 #include "wx/config.h"
35
36 #ifndef __WIN16__
37
38 #include "wx/msw/registry.h"
39 #include "wx/msw/regconf.h"
40
41 // ----------------------------------------------------------------------------
42 // constants
43 // ----------------------------------------------------------------------------
44
45 // we put our data in HKLM\SOFTWARE_KEY\appname
46 #define SOFTWARE_KEY wxString(wxT("Software\\"))
47
48 // ----------------------------------------------------------------------------
49 // global functions
50 // ----------------------------------------------------------------------------
51
52 // get the value if the key is opened and it exists
53 bool TryGetValue(const wxRegKey& key, const wxString& str, wxString& strVal)
54 {
55 return key.IsOpened() && key.HasValue(str) && key.QueryValue(str, strVal);
56 }
57
58 bool TryGetValue(const wxRegKey& key, const wxString& str, long *plVal)
59 {
60 return key.IsOpened() && key.HasValue(str) && key.QueryValue(str, plVal);
61 }
62
63 // ============================================================================
64 // implementation
65 // ============================================================================
66
67 // ----------------------------------------------------------------------------
68 // ctor/dtor
69 // ----------------------------------------------------------------------------
70
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,
75 long style)
76 : wxConfigBase(appName, vendorName, strLocal, strGlobal, style)
77 {
78 wxString strRoot;
79
80 bool bDoUseGlobal = (style & wxCONFIG_USE_GLOBAL_FILE) != 0;
81
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
84 // and/or strGlobal)
85 if ( strLocal.IsEmpty() || (strGlobal.IsEmpty() && bDoUseGlobal) )
86 {
87 if ( vendorName.IsEmpty() )
88 {
89 if ( wxTheApp )
90 strRoot = wxTheApp->GetVendorName();
91 }
92 else
93 {
94 strRoot = vendorName;
95 }
96
97 // no '\\' needed if no vendor name
98 if ( !strRoot.IsEmpty() )
99 {
100 strRoot += '\\';
101 }
102
103 if ( appName.IsEmpty() )
104 {
105 wxCHECK_RET( wxTheApp, wxT("No application name in wxRegConfig ctor!") );
106 strRoot << wxTheApp->GetAppName();
107 }
108 else
109 {
110 strRoot << appName;
111 }
112 }
113 //else: we don't need to do all the complicated stuff above
114
115 wxString str = strLocal.IsEmpty() ? strRoot : strLocal;
116
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;
122
123 m_keyLocalRoot.ReserveMemoryForName(MEMORY_PREALLOC);
124 m_keyLocal.ReserveMemoryForName(MEMORY_PREALLOC);
125
126 m_keyLocalRoot.SetName(wxRegKey::HKCU, SOFTWARE_KEY + str);
127 m_keyLocal.SetName(m_keyLocalRoot, wxEmptyString);
128
129 if ( bDoUseGlobal )
130 {
131 str = strGlobal.IsEmpty() ? strRoot : strGlobal;
132
133 m_keyGlobalRoot.ReserveMemoryForName(MEMORY_PREALLOC);
134 m_keyGlobal.ReserveMemoryForName(MEMORY_PREALLOC);
135
136 m_keyGlobalRoot.SetName(wxRegKey::HKLM, SOFTWARE_KEY + str);
137 m_keyGlobal.SetName(m_keyGlobalRoot, wxEmptyString);
138 }
139
140 // Create() will Open() if key already exists
141 m_keyLocalRoot.Create();
142
143 // as it's the same key, Open() shouldn't fail (i.e. no need for Create())
144 m_keyLocal.Open();
145
146 // OTOH, this key may perfectly not exist, so suppress error messages the call
147 // to Open() might generate
148 if ( bDoUseGlobal )
149 {
150 wxLogNull nolog;
151 m_keyGlobalRoot.Open();
152 m_keyGlobal.Open();
153 }
154 }
155
156 wxRegConfig::~wxRegConfig()
157 {
158 // nothing to do - key will be closed in their dtors
159 }
160
161 // ----------------------------------------------------------------------------
162 // path management
163 // ----------------------------------------------------------------------------
164
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
169 //
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)
173 {
174 // remember the old path
175 wxString strOldPath = m_strPath;
176
177 #ifdef WX_DEBUG_SET_PATH // non optimized version kept here for testing
178 wxString m_strPathAlt;
179
180 {
181 wxArrayString aParts;
182
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) ) {
186 // absolute path
187 wxSplitPath(aParts, strPath);
188 }
189 else {
190 // relative path, combine with current one
191 wxString strFullPath = GetPath();
192 strFullPath << wxCONFIG_PATH_SEPARATOR << strPath;
193 wxSplitPath(aParts, strFullPath);
194 }
195
196 // recombine path parts in one variable
197 wxString strRegPath;
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];
202 }
203 }
204 #endif // 0
205
206 // check for the most common case first
207 if ( strPath.empty() )
208 {
209 m_strPath = wxCONFIG_PATH_SEPARATOR;
210 }
211 else // not root
212 {
213 // construct the full path
214 wxString strFullPath;
215 if ( strPath[0u] == wxCONFIG_PATH_SEPARATOR )
216 {
217 // absolute path
218 strFullPath = strPath;
219 }
220 else // relative path
221 {
222 strFullPath.reserve(2*m_strPath.length());
223
224 strFullPath << m_strPath;
225 if ( strFullPath.Len() == 0 ||
226 strFullPath.Last() != wxCONFIG_PATH_SEPARATOR )
227 strFullPath << wxCONFIG_PATH_SEPARATOR;
228 strFullPath << strPath;
229 }
230
231 // simplify it: we need to handle ".." here
232
233 // count the total number of slashes we have to know if we can go upper
234 size_t totalSlashes = 0;
235
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
238 //
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;
243
244 const wxChar *src = strFullPath.c_str();
245 size_t len = strFullPath.length();
246 const wxChar *end = src + len;
247
248 wxStringBufferLength buf(m_strPath, len);
249 wxChar *dst = buf;
250 wxChar *start = dst;
251
252 for ( ; src < end; src++, dst++ )
253 {
254 if ( *src == wxCONFIG_PATH_SEPARATOR )
255 {
256 // check for "/.."
257
258 // note that we don't have to check for src < end here as
259 // *end == 0 so can't be '.'
260 if ( src[1] == _T('.') && src[2] == _T('.') &&
261 (src + 3 == end || src[3] == wxCONFIG_PATH_SEPARATOR) )
262 {
263 if ( !totalSlashes )
264 {
265 wxLogWarning(_("'%s' has extra '..', ignored."),
266 strFullPath.c_str());
267 }
268 else // return to the previous path component
269 {
270 // do we already have its position?
271 if ( posLastSlash == -1 )
272 {
273 // no, find it: note that we are sure to have one
274 // because totalSlashes > 0 so we don't have to
275 // check the boundary condition below
276
277 // this is more efficient than strrchr()
278 dst--;
279 while ( *dst != wxCONFIG_PATH_SEPARATOR )
280 {
281 dst--;
282 }
283 }
284 else // the position of last slash was stored
285 {
286 // go directly there
287 dst = start + posLastSlash;
288
289 // invalidate posLastSlash
290 posLastSlash = -1;
291 }
292
293 // we must have found a slash one way or another!
294 wxASSERT_MSG( *dst == wxCONFIG_PATH_SEPARATOR,
295 _T("error in wxRegConfig::SetPath") );
296
297 // stay at the same position
298 dst--;
299
300 // we killed one
301 totalSlashes--;
302 }
303
304 // skip both dots
305 src += 2;
306 }
307 else // not "/.."
308 {
309 if ( (dst == start) || (dst[-1] != wxCONFIG_PATH_SEPARATOR) )
310 {
311 *dst = wxCONFIG_PATH_SEPARATOR;
312
313 posLastSlash = dst - start;
314
315 totalSlashes++;
316 }
317 else // previous char was a slash too
318 {
319 // squeeze several subsequent slashes into one: i.e.
320 // just ignore this one
321 dst--;
322 }
323 }
324 }
325 else // normal character
326 {
327 // just copy
328 *dst = *src;
329 }
330 }
331
332 // NUL terminate the string
333 if ( dst[-1] == wxCONFIG_PATH_SEPARATOR && (dst != start + 1) )
334 {
335 // if it has a trailing slash we remove it unless it is the only
336 // string character
337 dst--;
338 }
339
340 *dst = _T('\0');
341 buf.SetLength(dst - start);
342 }
343
344 #ifdef WX_DEBUG_SET_PATH
345 wxASSERT( m_strPath == m_strPathAlt );
346 #endif
347
348 if ( m_strPath == strOldPath )
349 return;
350
351 // registry APIs want backslashes instead of slashes
352 wxString strRegPath;
353 if ( !m_strPath.empty() )
354 {
355 size_t len = m_strPath.length();
356
357 const wxChar *src = m_strPath.c_str();
358 wxStringBufferLength buf(strRegPath, len);
359 wxChar *dst = buf;
360
361 const wxChar *end = src + len;
362 for ( ; src < end; src++, dst++ )
363 {
364 if ( *src == wxCONFIG_PATH_SEPARATOR )
365 *dst = _T('\\');
366 else
367 *dst = *src;
368 }
369
370 buf.SetLength(len);
371 }
372
373 // this is not needed any longer as we don't create keys unnecessarily any
374 // more (now it is done on demand, i.e. only when they're going to contain
375 // something)
376 #if 0
377 // as we create the registry key when SetPath(key) is done, we can be left
378 // with plenty of empty keys if this was only done to try to read some
379 // value which, in fact, doesn't exist - to prevent this from happening we
380 // automatically delete the old key if it was empty
381 if ( m_keyLocal.Exists() && LocalKey().IsEmpty() )
382 {
383 m_keyLocal.DeleteSelf();
384 }
385 #endif // 0
386
387 // change current key(s)
388 m_keyLocal.SetName(m_keyLocalRoot, strRegPath);
389 m_keyGlobal.SetName(m_keyGlobalRoot, strRegPath);
390
391 // don't create it right now, wait until it is accessed
392 //m_keyLocal.Create();
393
394 wxLogNull nolog;
395 m_keyGlobal.Open();
396 }
397
398 // ----------------------------------------------------------------------------
399 // enumeration (works only with current group)
400 // ----------------------------------------------------------------------------
401
402 /*
403 We want to enumerate all local keys/values after the global ones, but, of
404 course, we don't want to repeat a key which appears locally as well as
405 globally twice.
406
407 We use the 15th bit of lIndex for distinction between global and local.
408 */
409
410 #define LOCAL_MASK 0x8000
411 #define IS_LOCAL_INDEX(l) (((l) & LOCAL_MASK) != 0)
412
413 bool wxRegConfig::GetFirstGroup(wxString& str, long& lIndex) const
414 {
415 lIndex = 0;
416 return GetNextGroup(str, lIndex);
417 }
418
419 bool wxRegConfig::GetNextGroup(wxString& str, long& lIndex) const
420 {
421 // are we already enumerating local entries?
422 if ( m_keyGlobal.IsOpened() && !IS_LOCAL_INDEX(lIndex) ) {
423 // try to find a global entry which doesn't appear locally
424 while ( m_keyGlobal.GetNextKey(str, lIndex) ) {
425 if ( !m_keyLocal.Exists() || !LocalKey().HasSubKey(str) ) {
426 // ok, found one - return it
427 return TRUE;
428 }
429 }
430
431 // no more global entries
432 lIndex |= LOCAL_MASK;
433 }
434
435 // if we don't have the key at all, don't try to enumerate anything under it
436 if ( !m_keyLocal.Exists() )
437 return FALSE;
438
439 // much easier with local entries: get the next one we find
440 // (don't forget to clear our flag bit and set it again later)
441 lIndex &= ~LOCAL_MASK;
442 bool bOk = LocalKey().GetNextKey(str, lIndex);
443 lIndex |= LOCAL_MASK;
444
445 return bOk;
446 }
447
448 bool wxRegConfig::GetFirstEntry(wxString& str, long& lIndex) const
449 {
450 lIndex = 0;
451 return GetNextEntry(str, lIndex);
452 }
453
454 bool wxRegConfig::GetNextEntry(wxString& str, long& lIndex) const
455 {
456 // are we already enumerating local entries?
457 if ( m_keyGlobal.IsOpened() && !IS_LOCAL_INDEX(lIndex) ) {
458 // try to find a global entry which doesn't appear locally
459 while ( m_keyGlobal.GetNextValue(str, lIndex) ) {
460 if ( !m_keyLocal.Exists() || !LocalKey().HasValue(str) ) {
461 // ok, found one - return it
462 return TRUE;
463 }
464 }
465
466 // no more global entries
467 lIndex |= LOCAL_MASK;
468 }
469
470 // if we don't have the key at all, don't try to enumerate anything under it
471 if ( !m_keyLocal.Exists() )
472 return FALSE;
473
474 // much easier with local entries: get the next one we find
475 // (don't forget to clear our flag bit and set it again later)
476 lIndex &= ~LOCAL_MASK;
477 bool bOk = LocalKey().GetNextValue(str, lIndex);
478 lIndex |= LOCAL_MASK;
479
480 return bOk;
481 }
482
483 size_t wxRegConfig::GetNumberOfEntries(bool WXUNUSED(bRecursive)) const
484 {
485 size_t nEntries = 0;
486
487 // dummy vars
488 wxString str;
489 long l;
490 bool bCont = ((wxRegConfig*)this)->GetFirstEntry(str, l);
491 while ( bCont ) {
492 nEntries++;
493
494 bCont = ((wxRegConfig*)this)->GetNextEntry(str, l);
495 }
496
497 return nEntries;
498 }
499
500 size_t wxRegConfig::GetNumberOfGroups(bool WXUNUSED(bRecursive)) const
501 {
502 size_t nGroups = 0;
503
504 // dummy vars
505 wxString str;
506 long l;
507 bool bCont = ((wxRegConfig*)this)->GetFirstGroup(str, l);
508 while ( bCont ) {
509 nGroups++;
510
511 bCont = ((wxRegConfig*)this)->GetNextGroup(str, l);
512 }
513
514 return nGroups;
515 }
516
517 // ----------------------------------------------------------------------------
518 // tests for existence
519 // ----------------------------------------------------------------------------
520
521 bool wxRegConfig::HasGroup(const wxString& key) const
522 {
523 wxConfigPathChanger path(this, key);
524
525 wxString strName(path.Name());
526
527 return (m_keyLocal.Exists() && LocalKey().HasSubKey(strName)) ||
528 m_keyGlobal.HasSubKey(strName);
529 }
530
531 bool wxRegConfig::HasEntry(const wxString& key) const
532 {
533 wxConfigPathChanger path(this, key);
534
535 wxString strName(path.Name());
536
537 return (m_keyLocal.Exists() && LocalKey().HasValue(strName)) ||
538 m_keyGlobal.HasValue(strName);
539 }
540
541 wxConfigBase::EntryType wxRegConfig::GetEntryType(const wxString& key) const
542 {
543 wxConfigPathChanger path(this, key);
544
545 wxString strName(path.Name());
546
547 bool isNumeric;
548 if ( m_keyLocal.Exists() && LocalKey().HasValue(strName) )
549 isNumeric = m_keyLocal.IsNumericValue(strName);
550 else if ( m_keyGlobal.HasValue(strName) )
551 isNumeric = m_keyGlobal.IsNumericValue(strName);
552 else
553 return wxConfigBase::Type_Unknown;
554
555 return isNumeric ? wxConfigBase::Type_Integer : wxConfigBase::Type_String;
556 }
557
558 // ----------------------------------------------------------------------------
559 // reading/writing
560 // ----------------------------------------------------------------------------
561
562 bool wxRegConfig::DoReadString(const wxString& key, wxString *pStr) const
563 {
564 wxCHECK_MSG( pStr, FALSE, _T("wxRegConfig::Read(): NULL param") );
565
566 wxConfigPathChanger path(this, key);
567
568 bool bQueryGlobal = TRUE;
569
570 // if immutable key exists in global key we must check that it's not
571 // overriden by the local key with the same name
572 if ( IsImmutable(path.Name()) ) {
573 if ( TryGetValue(m_keyGlobal, path.Name(), *pStr) ) {
574 if ( m_keyLocal.Exists() && LocalKey().HasValue(path.Name()) ) {
575 wxLogWarning(wxT("User value for immutable key '%s' ignored."),
576 path.Name().c_str());
577 }
578
579 return TRUE;
580 }
581 else {
582 // don't waste time - it's not there anyhow
583 bQueryGlobal = FALSE;
584 }
585 }
586
587 // first try local key
588 if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), *pStr)) ||
589 (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), *pStr)) ) {
590 return TRUE;
591 }
592
593 return FALSE;
594 }
595
596 // this exactly reproduces the string version above except for ExpandEnvVars(),
597 // we really should avoid this code duplication somehow...
598
599 bool wxRegConfig::DoReadLong(const wxString& key, long *plResult) const
600 {
601 wxCHECK_MSG( plResult, FALSE, _T("wxRegConfig::Read(): NULL param") );
602
603 wxConfigPathChanger path(this, key);
604
605 bool bQueryGlobal = TRUE;
606
607 // if immutable key exists in global key we must check that it's not
608 // overriden by the local key with the same name
609 if ( IsImmutable(path.Name()) ) {
610 if ( TryGetValue(m_keyGlobal, path.Name(), plResult) ) {
611 if ( m_keyLocal.Exists() && LocalKey().HasValue(path.Name()) ) {
612 wxLogWarning(wxT("User value for immutable key '%s' ignored."),
613 path.Name().c_str());
614 }
615
616 return TRUE;
617 }
618 else {
619 // don't waste time - it's not there anyhow
620 bQueryGlobal = FALSE;
621 }
622 }
623
624 // first try local key
625 if ( (m_keyLocal.Exists() && TryGetValue(LocalKey(), path.Name(), plResult)) ||
626 (bQueryGlobal && TryGetValue(m_keyGlobal, path.Name(), plResult)) ) {
627 return TRUE;
628 }
629
630 return FALSE;
631 }
632
633 bool wxRegConfig::DoWriteString(const wxString& key, const wxString& szValue)
634 {
635 wxConfigPathChanger path(this, key);
636
637 if ( IsImmutable(path.Name()) ) {
638 wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());
639 return FALSE;
640 }
641
642 return LocalKey().SetValue(path.Name(), szValue);
643 }
644
645 bool wxRegConfig::DoWriteLong(const wxString& key, long lValue)
646 {
647 wxConfigPathChanger path(this, key);
648
649 if ( IsImmutable(path.Name()) ) {
650 wxLogError(wxT("Can't change immutable entry '%s'."), path.Name().c_str());
651 return FALSE;
652 }
653
654 return LocalKey().SetValue(path.Name(), lValue);
655 }
656
657 // ----------------------------------------------------------------------------
658 // renaming
659 // ----------------------------------------------------------------------------
660
661 bool wxRegConfig::RenameEntry(const wxString& oldName, const wxString& newName)
662 {
663 // check that the old entry exists...
664 if ( !HasEntry(oldName) )
665 return FALSE;
666
667 // and that the new one doesn't
668 if ( HasEntry(newName) )
669 return FALSE;
670
671 return m_keyLocal.RenameValue(oldName, newName);
672 }
673
674 bool wxRegConfig::RenameGroup(const wxString& oldName, const wxString& newName)
675 {
676 // check that the old group exists...
677 if ( !HasGroup(oldName) )
678 return FALSE;
679
680 // and that the new one doesn't
681 if ( HasGroup(newName) )
682 return FALSE;
683
684 return wxRegKey(m_keyLocal, oldName).Rename(newName);
685 }
686
687 // ----------------------------------------------------------------------------
688 // deleting
689 // ----------------------------------------------------------------------------
690 bool wxRegConfig::DeleteEntry(const wxString& value, bool WXUNUSED(bGroupIfEmptyAlso))
691 {
692 wxConfigPathChanger path(this, value);
693
694 if ( m_keyLocal.Exists() ) {
695 if ( !m_keyLocal.DeleteValue(path.Name()) )
696 return FALSE;
697
698 if ( m_keyLocal.IsEmpty() ) {
699 wxString strKey = GetPath().AfterLast(wxCONFIG_PATH_SEPARATOR);
700 SetPath(_T("..")); // changes m_keyLocal
701 return LocalKey().DeleteKey(strKey);
702 }
703 }
704
705 return TRUE;
706 }
707
708 bool wxRegConfig::DeleteGroup(const wxString& key)
709 {
710 wxConfigPathChanger path(this, key);
711
712 return m_keyLocal.Exists() ? LocalKey().DeleteKey(path.Name()) : TRUE;
713 }
714
715 bool wxRegConfig::DeleteAll()
716 {
717 m_keyLocal.Close();
718 m_keyGlobal.Close();
719
720 bool bOk = m_keyLocalRoot.DeleteSelf();
721
722 // make sure that we opened m_keyGlobalRoot and so it has a reasonable name:
723 // otherwise we will delete HKEY_CLASSES_ROOT recursively
724 if ( bOk && m_keyGlobalRoot.IsOpened() )
725 bOk = m_keyGlobalRoot.DeleteSelf();
726
727 return bOk;
728 }
729
730 #endif
731 // __WIN16__
732
733 #endif
734 // wxUSE_CONFIG