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