]>
Commit | Line | Data |
---|---|---|
2bda0e17 KB |
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 | ||
27529614 JS |
15 | #ifdef __GNUG__ |
16 | #pragma implementation "registry.h" | |
17 | #endif | |
18 | ||
2bda0e17 KB |
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" | |
41286812 VZ |
30 | #include "wx/config.h" // for wxExpandEnvVars |
31 | ||
3d05544e JS |
32 | #ifndef __WIN16__ |
33 | ||
2bda0e17 | 34 | // Windows headers |
57a7b7c1 | 35 | /* |
2bda0e17 KB |
36 | #define STRICT |
37 | #define WIN32_LEAN_AND_MEAN | |
57a7b7c1 JS |
38 | */ |
39 | ||
2bda0e17 KB |
40 | #include <windows.h> |
41 | ||
42 | // other std headers | |
43 | #include <stdlib.h> // for _MAX_PATH | |
44 | ||
45 | #ifndef _MAX_PATH | |
0b1c5a6c | 46 | #define _MAX_PATH 512 |
2bda0e17 KB |
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 char *szName; | |
66 | const char *szShortName; | |
67 | } | |
68 | aStdKeys[] = | |
69 | { | |
70 | { HKEY_CLASSES_ROOT, "HKEY_CLASSES_ROOT", "HKCR" }, | |
71 | #ifdef __WIN32__ | |
72 | { HKEY_CURRENT_USER, "HKEY_CURRENT_USER", "HKCU" }, | |
73 | { HKEY_LOCAL_MACHINE, "HKEY_LOCAL_MACHINE", "HKLM" }, | |
74 | { HKEY_USERS, "HKEY_USERS", "HKU" }, // short name? | |
75 | { HKEY_PERFORMANCE_DATA, "HKEY_PERFORMANCE_DATA", "HKPD" }, | |
76 | #if WINVER >= 0x0400 | |
77 | { HKEY_CURRENT_CONFIG, "HKEY_CURRENT_CONFIG", "HKCC" }, | |
78 | #ifndef __GNUWIN32__ | |
79 | { HKEY_DYN_DATA, "HKEY_DYN_DATA", "HKDD" }, // short name? | |
0b1c5a6c | 80 | #endif //GNUWIN32 |
2bda0e17 KB |
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 '\\' | |
87 | ||
c86f1403 VZ |
88 | // useful for Windows programmers: makes somewhat more clear all these zeroes |
89 | // being passed to Windows APIs | |
90 | #define RESERVED (NULL) | |
91 | ||
2bda0e17 KB |
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 | ||
0b1c5a6c VZ |
106 | // removes the trailing backslash from the string if it has one |
107 | static inline void RemoveTrailingSeparator(wxString& str); | |
108 | ||
cf447356 | 109 | // returns TRUE if given registry key exists |
fd6c844b | 110 | static bool KeyExists(WXHKEY hRootKey, const char *szKey); |
2bda0e17 KB |
111 | |
112 | // combines value and key name (uses static buffer!) | |
113 | static const char *GetFullName(const wxRegKey *pKey, | |
114 | const char *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. | |
c86f1403 | 128 | const char *wxRegKey::GetStdKeyName(size_t key) |
2bda0e17 KB |
129 | { |
130 | // return empty string if key is invalid | |
1311c7a9 | 131 | wxCHECK_MSG( key < nStdKeys, "", "invalid key in wxRegKey::GetStdKeyName" ); |
2bda0e17 KB |
132 | |
133 | return aStdKeys[key].szName; | |
134 | } | |
135 | ||
c86f1403 | 136 | const char *wxRegKey::GetStdKeyShortName(size_t key) |
2bda0e17 KB |
137 | { |
138 | // return empty string if key is invalid | |
1311c7a9 | 139 | wxCHECK( key < nStdKeys, "" ); |
2bda0e17 KB |
140 | |
141 | return aStdKeys[key].szShortName; | |
142 | } | |
143 | ||
144 | wxRegKey::StdKey wxRegKey::ExtractKeyName(wxString& strKey) | |
145 | { | |
146 | wxString strRoot = strKey.Left(REG_SEPARATOR); | |
147 | ||
fd3f686c | 148 | HKEY hRootKey = 0; |
c86f1403 | 149 | size_t ui; |
2bda0e17 KB |
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("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 | ||
fd6c844b | 172 | wxRegKey::StdKey wxRegKey::GetStdKeyFromHkey(WXHKEY hkey) |
2bda0e17 | 173 | { |
c86f1403 | 174 | for ( size_t ui = 0; ui < nStdKeys; ui++ ) { |
fd6c844b | 175 | if ( (int) aStdKeys[ui].hkey == (int) hkey ) |
2bda0e17 KB |
176 | return (StdKey)ui; |
177 | } | |
178 | ||
179 | wxFAIL_MSG("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; | |
fd6c844b | 191 | m_hRootKey = (WXHKEY) aStdKeys[HKCR].hkey; |
2bda0e17 KB |
192 | m_dwLastError = 0; |
193 | } | |
194 | ||
195 | wxRegKey::wxRegKey(const wxString& strKey) : m_strKey(strKey) | |
196 | { | |
fd6c844b | 197 | m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey; |
6b037754 | 198 | m_hKey = (WXHKEY) NULL; |
2bda0e17 KB |
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 | { | |
0b1c5a6c | 205 | RemoveTrailingSeparator(m_strKey); |
fd6c844b | 206 | m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; |
6b037754 | 207 | m_hKey = (WXHKEY) NULL; |
2bda0e17 KB |
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 | |
32c66ea2 VZ |
216 | if ( !m_strKey.IsEmpty() && |
217 | (strKey.IsEmpty() || strKey[0] != REG_SEPARATOR) ) { | |
218 | m_strKey += REG_SEPARATOR; | |
219 | } | |
2bda0e17 KB |
220 | |
221 | m_strKey += strKey; | |
0b1c5a6c | 222 | RemoveTrailingSeparator(m_strKey); |
2bda0e17 KB |
223 | |
224 | m_hRootKey = keyParent.m_hRootKey; | |
6b037754 | 225 | m_hKey = (WXHKEY) NULL; |
2bda0e17 KB |
226 | m_dwLastError = 0; |
227 | } | |
228 | ||
229 | // dtor closes the key releasing system resource | |
230 | wxRegKey::~wxRegKey() | |
231 | { | |
232 | Close(); | |
233 | } | |
234 | ||
0b1c5a6c VZ |
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; | |
fd6c844b | 245 | m_hRootKey = (WXHKEY) aStdKeys[ExtractKeyName(m_strKey)].hkey; |
0b1c5a6c VZ |
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); | |
fd6c844b | 255 | m_hRootKey = (WXHKEY) aStdKeys[keyParent].hkey; |
0b1c5a6c VZ |
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 | |
02569ba8 | 264 | m_strKey = keyParent.m_strKey; |
0b1c5a6c VZ |
265 | if ( !strKey.IsEmpty() && strKey[0] != REG_SEPARATOR ) |
266 | m_strKey += REG_SEPARATOR; | |
02569ba8 | 267 | m_strKey += strKey; |
0b1c5a6c VZ |
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 | |
fd6c844b | 275 | void wxRegKey::SetHkey(WXHKEY hKey) |
0b1c5a6c VZ |
276 | { |
277 | Close(); | |
278 | ||
279 | m_hKey = hKey; | |
280 | } | |
281 | ||
2bda0e17 KB |
282 | // ---------------------------------------------------------------------------- |
283 | // info about the key | |
284 | // ---------------------------------------------------------------------------- | |
285 | ||
cf447356 | 286 | // returns TRUE if the key exists |
2bda0e17 KB |
287 | bool wxRegKey::Exists() const |
288 | { | |
289 | // opened key has to exist, try to open it if not done yet | |
cf447356 | 290 | return IsOpened() ? TRUE : KeyExists(m_hRootKey, m_strKey); |
2bda0e17 KB |
291 | } |
292 | ||
293 | // returns the full name of the key (prefix is abbreviated if bShortPrefix) | |
294 | wxString wxRegKey::GetName(bool bShortPrefix) const | |
295 | { | |
fd6c844b | 296 | StdKey key = GetStdKeyFromHkey((StdKey) m_hRootKey); |
2bda0e17 KB |
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 | ||
088a95f5 | 305 | #ifdef __GNUWIN32__ |
c86f1403 VZ |
306 | bool wxRegKey::GetKeyInfo(size_t* pnSubKeys, |
307 | size_t* pnMaxKeyLen, | |
308 | size_t* pnValues, | |
309 | size_t* pnMaxValueLen) const | |
088a95f5 | 310 | #else |
02569ba8 VZ |
311 | bool wxRegKey::GetKeyInfo(ulong *pnSubKeys, |
312 | ulong *pnMaxKeyLen, | |
313 | ulong *pnValues, | |
314 | ulong *pnMaxValueLen) const | |
088a95f5 | 315 | #endif |
02569ba8 | 316 | { |
57c208c5 | 317 | #if defined(__WIN32__) && !defined(__TWIN32__) |
02569ba8 VZ |
318 | m_dwLastError = ::RegQueryInfoKey |
319 | ( | |
fd6c844b | 320 | (HKEY) m_hKey, |
02569ba8 VZ |
321 | NULL, // class name |
322 | NULL, // (ptr to) size of class name buffer | |
323 | RESERVED, | |
324 | pnSubKeys, // [out] number of subkeys | |
325 | pnMaxKeyLen, // [out] max length of a subkey name | |
326 | NULL, // longest subkey class name | |
327 | pnValues, // [out] number of values | |
328 | pnMaxValueLen, // [out] max length of a value name | |
329 | NULL, // longest value data | |
330 | NULL, // security descriptor | |
331 | NULL // time of last modification | |
332 | ); | |
333 | ||
334 | if ( m_dwLastError != ERROR_SUCCESS ) { | |
335 | wxLogSysError(m_dwLastError, _("can't get info about registry key '%s'"), | |
336 | GetName().c_str()); | |
337 | return FALSE; | |
338 | } | |
339 | else | |
340 | return TRUE; | |
341 | #else // Win16 | |
342 | wxFAIL_MSG("GetKeyInfo() not implemented"); | |
343 | ||
344 | return FALSE; | |
345 | #endif | |
346 | } | |
347 | ||
2bda0e17 KB |
348 | // ---------------------------------------------------------------------------- |
349 | // operations | |
350 | // ---------------------------------------------------------------------------- | |
351 | ||
352 | // opens key (it's not an error to call Open() on an already opened key) | |
353 | bool wxRegKey::Open() | |
354 | { | |
355 | if ( IsOpened() ) | |
cf447356 | 356 | return TRUE; |
2bda0e17 | 357 | |
fd6c844b JS |
358 | HKEY tmpKey; |
359 | m_dwLastError = RegOpenKey((HKEY) m_hRootKey, m_strKey, &tmpKey); | |
2bda0e17 | 360 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 | 361 | wxLogSysError(m_dwLastError, _("can't open registry key '%s'"), |
2bda0e17 | 362 | GetName().c_str()); |
cf447356 | 363 | return FALSE; |
2bda0e17 KB |
364 | } |
365 | else | |
fd6c844b JS |
366 | { |
367 | m_hKey = (WXHKEY) tmpKey; | |
cf447356 | 368 | return TRUE; |
fd6c844b | 369 | } |
2bda0e17 KB |
370 | } |
371 | ||
372 | // creates key, failing if it exists and !bOkIfExists | |
373 | bool wxRegKey::Create(bool bOkIfExists) | |
374 | { | |
375 | // check for existence only if asked (i.e. order is important!) | |
376 | if ( !bOkIfExists && Exists() ) { | |
cf447356 | 377 | return FALSE; |
2bda0e17 KB |
378 | } |
379 | ||
380 | if ( IsOpened() ) | |
cf447356 | 381 | return TRUE; |
2bda0e17 | 382 | |
fd6c844b JS |
383 | HKEY tmpKey; |
384 | m_dwLastError = RegCreateKey((HKEY) m_hRootKey, m_strKey, &tmpKey); | |
2bda0e17 | 385 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 | 386 | wxLogSysError(m_dwLastError, _("can't create registry key '%s'"), |
2bda0e17 | 387 | GetName().c_str()); |
cf447356 | 388 | return FALSE; |
2bda0e17 KB |
389 | } |
390 | else | |
fd6c844b JS |
391 | { |
392 | m_hKey = (WXHKEY) tmpKey; | |
cf447356 | 393 | return TRUE; |
fd6c844b | 394 | } |
2bda0e17 KB |
395 | } |
396 | ||
0b1c5a6c VZ |
397 | // close the key, it's not an error to call it when not opened |
398 | bool wxRegKey::Close() | |
399 | { | |
400 | if ( IsOpened() ) { | |
fd6c844b | 401 | m_dwLastError = RegCloseKey((HKEY) m_hKey); |
0b1c5a6c | 402 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 | 403 | wxLogSysError(m_dwLastError, _("can't close registry key '%s'"), |
0b1c5a6c VZ |
404 | GetName().c_str()); |
405 | ||
406 | m_hKey = 0; | |
cf447356 | 407 | return FALSE; |
0b1c5a6c VZ |
408 | } |
409 | else { | |
410 | m_hKey = 0; | |
411 | } | |
412 | } | |
413 | ||
cf447356 | 414 | return TRUE; |
0b1c5a6c VZ |
415 | } |
416 | ||
417 | // ---------------------------------------------------------------------------- | |
418 | // delete keys/values | |
419 | // ---------------------------------------------------------------------------- | |
2bda0e17 KB |
420 | bool wxRegKey::DeleteSelf() |
421 | { | |
0b1c5a6c VZ |
422 | { |
423 | wxLogNull nolog; | |
424 | if ( !Open() ) { | |
425 | // it already doesn't exist - ok! | |
426 | return TRUE; | |
427 | } | |
428 | } | |
429 | ||
90186e52 VZ |
430 | // prevent a buggy program from erasing one of the root registry keys or an |
431 | // immediate subkey (i.e. one which doesn't have '\\' inside) of any other | |
432 | // key except HKCR (HKCR has some "deleteable" subkeys) | |
433 | if ( m_strKey.IsEmpty() || (m_hRootKey != HKCR && | |
434 | m_strKey.Find(REG_SEPARATOR) == wxNOT_FOUND) ) { | |
435 | wxLogError(_("Registry key '%s' is needed for normal system operation,\n" | |
436 | "deleting it will leave your system in unusable state:\n" | |
437 | "operation aborted."), GetFullName(this)); | |
438 | ||
439 | return FALSE; | |
440 | } | |
441 | ||
0b1c5a6c VZ |
442 | // we can't delete keys while enumerating because it confuses GetNextKey, so |
443 | // we first save the key names and then delete them all | |
444 | wxArrayString astrSubkeys; | |
2bda0e17 KB |
445 | |
446 | wxString strKey; | |
447 | long lIndex; | |
448 | bool bCont = GetFirstKey(strKey, lIndex); | |
449 | while ( bCont ) { | |
0b1c5a6c | 450 | astrSubkeys.Add(strKey); |
2bda0e17 KB |
451 | |
452 | bCont = GetNextKey(strKey, lIndex); | |
453 | } | |
454 | ||
c86f1403 VZ |
455 | size_t nKeyCount = astrSubkeys.Count(); |
456 | for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) { | |
0b1c5a6c VZ |
457 | wxRegKey key(*this, astrSubkeys[nKey]); |
458 | if ( !key.DeleteSelf() ) | |
459 | return FALSE; | |
460 | } | |
461 | ||
462 | // now delete this key itself | |
2bda0e17 KB |
463 | Close(); |
464 | ||
fd6c844b | 465 | m_dwLastError = RegDeleteKey((HKEY) m_hRootKey, m_strKey); |
2bda0e17 | 466 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 VZ |
467 | wxLogSysError(m_dwLastError, _("can't delete key '%s'"), |
468 | GetName().c_str()); | |
2bda0e17 KB |
469 | return FALSE; |
470 | } | |
471 | ||
472 | return TRUE; | |
473 | } | |
474 | ||
475 | bool wxRegKey::DeleteKey(const char *szKey) | |
476 | { | |
477 | if ( !Open() ) | |
cf447356 | 478 | return FALSE; |
2bda0e17 KB |
479 | |
480 | wxRegKey key(*this, szKey); | |
481 | return key.DeleteSelf(); | |
482 | } | |
483 | ||
484 | bool wxRegKey::DeleteValue(const char *szValue) | |
485 | { | |
486 | if ( !Open() ) | |
cf447356 | 487 | return FALSE; |
2bda0e17 | 488 | |
57c208c5 | 489 | #if defined(__WIN32__) && !defined(__TWIN32__) |
2432b92d | 490 | m_dwLastError = RegDeleteValue((HKEY) m_hKey, (char*) (const char*) szValue); |
2bda0e17 | 491 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 | 492 | wxLogSysError(m_dwLastError, _("can't delete value '%s' from key '%s'"), |
2bda0e17 | 493 | szValue, GetName().c_str()); |
cf447356 | 494 | return FALSE; |
2bda0e17 KB |
495 | } |
496 | #else //WIN16 | |
497 | // named registry values don't exist in Win16 world | |
498 | wxASSERT( IsEmpty(szValue) ); | |
499 | ||
500 | // just set the (default and unique) value of the key to "" | |
fd6c844b | 501 | m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, "", RESERVED); |
2bda0e17 | 502 | if ( m_dwLastError != ERROR_SUCCESS ) { |
02569ba8 | 503 | wxLogSysError(m_dwLastError, _("can't delete value of key '%s'"), |
2bda0e17 | 504 | GetName().c_str()); |
cf447356 | 505 | return FALSE; |
2bda0e17 KB |
506 | } |
507 | #endif //WIN16/32 | |
508 | ||
cf447356 | 509 | return TRUE; |
2bda0e17 KB |
510 | } |
511 | ||
512 | // ---------------------------------------------------------------------------- | |
513 | // access to values and subkeys | |
514 | // ---------------------------------------------------------------------------- | |
515 | ||
cf447356 | 516 | // return TRUE if value exists |
0b1c5a6c VZ |
517 | bool wxRegKey::HasValue(const char *szValue) const |
518 | { | |
32c66ea2 VZ |
519 | // this function should be silent, so suppress possible messages from Open() |
520 | wxLogNull nolog; | |
521 | ||
0b1c5a6c VZ |
522 | #ifdef __WIN32__ |
523 | if ( CONST_CAST Open() ) { | |
2432b92d | 524 | return RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED, |
0b1c5a6c VZ |
525 | NULL, NULL, NULL) == ERROR_SUCCESS; |
526 | } | |
527 | else | |
cf447356 | 528 | return FALSE; |
0b1c5a6c VZ |
529 | #else // WIN16 |
530 | // only unnamed value exists | |
531 | return IsEmpty(szValue); | |
532 | #endif // WIN16/32 | |
533 | } | |
534 | ||
cf447356 | 535 | // returns TRUE if this key has any subkeys |
2bda0e17 KB |
536 | bool wxRegKey::HasSubkeys() const |
537 | { | |
c19a8a9a VZ |
538 | // suppress possible messages from GetFirstKey() |
539 | wxLogNull nolog; | |
540 | ||
2bda0e17 KB |
541 | // just call GetFirstKey with dummy parameters |
542 | wxString str; | |
543 | long l; | |
544 | return CONST_CAST GetFirstKey(str, l); | |
545 | } | |
546 | ||
cf447356 | 547 | // returns TRUE if given subkey exists |
2bda0e17 KB |
548 | bool wxRegKey::HasSubKey(const char *szKey) const |
549 | { | |
c19a8a9a VZ |
550 | // this function should be silent, so suppress possible messages from Open() |
551 | wxLogNull nolog; | |
552 | ||
2bda0e17 KB |
553 | if ( CONST_CAST Open() ) |
554 | return KeyExists(m_hKey, szKey); | |
555 | else | |
cf447356 | 556 | return FALSE; |
2bda0e17 KB |
557 | } |
558 | ||
89077ebc | 559 | wxRegKey::ValueType wxRegKey::GetValueType(const char *szValue) const |
2bda0e17 KB |
560 | { |
561 | #ifdef __WIN32__ | |
89077ebc | 562 | if ( ! CONST_CAST Open() ) |
2bda0e17 KB |
563 | return Type_None; |
564 | ||
565 | DWORD dwType; | |
2432b92d | 566 | m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED, |
2bda0e17 KB |
567 | &dwType, NULL, NULL); |
568 | if ( m_dwLastError != ERROR_SUCCESS ) { | |
02569ba8 | 569 | wxLogSysError(m_dwLastError, _("can't read value of key '%s'"), |
2bda0e17 KB |
570 | GetName().c_str()); |
571 | return Type_None; | |
572 | } | |
573 | ||
574 | return (ValueType)dwType; | |
575 | #else //WIN16 | |
576 | return IsEmpty(szValue) ? Type_String : Type_None; | |
577 | #endif //WIN16/32 | |
578 | } | |
579 | ||
580 | #ifdef __WIN32__ | |
581 | bool wxRegKey::SetValue(const char *szValue, long lValue) | |
582 | { | |
57c208c5 JS |
583 | #ifdef __TWIN32__ |
584 | wxFAIL_MSG("RegSetValueEx not implemented by TWIN32"); | |
585 | return FALSE; | |
586 | #else | |
2bda0e17 | 587 | if ( CONST_CAST Open() ) { |
6b037754 | 588 | m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD, |
2bda0e17 KB |
589 | (RegString)&lValue, sizeof(lValue)); |
590 | if ( m_dwLastError == ERROR_SUCCESS ) | |
cf447356 | 591 | return TRUE; |
2bda0e17 KB |
592 | } |
593 | ||
02569ba8 | 594 | wxLogSysError(m_dwLastError, _("can't set value of '%s'"), |
2bda0e17 | 595 | GetFullName(this, szValue)); |
cf447356 | 596 | return FALSE; |
57c208c5 | 597 | #endif |
2bda0e17 KB |
598 | } |
599 | ||
600 | bool wxRegKey::QueryValue(const char *szValue, long *plValue) const | |
601 | { | |
602 | if ( CONST_CAST Open() ) { | |
603 | DWORD dwType, dwSize = sizeof(DWORD); | |
604 | RegString pBuf = (RegString)plValue; | |
2432b92d | 605 | m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED, |
2bda0e17 KB |
606 | &dwType, pBuf, &dwSize); |
607 | if ( m_dwLastError != ERROR_SUCCESS ) { | |
02569ba8 | 608 | wxLogSysError(m_dwLastError, _("can't read value of key '%s'"), |
2bda0e17 | 609 | GetName().c_str()); |
cf447356 | 610 | return FALSE; |
2bda0e17 KB |
611 | } |
612 | else { | |
613 | // check that we read the value of right type | |
614 | wxASSERT_MSG( dwType == REG_DWORD, | |
615 | "Type mismatch in wxRegKey::QueryValue()." ); | |
616 | ||
cf447356 | 617 | return TRUE; |
2bda0e17 KB |
618 | } |
619 | } | |
620 | else | |
cf447356 | 621 | return FALSE; |
2bda0e17 KB |
622 | } |
623 | ||
624 | #endif //Win32 | |
625 | ||
626 | bool wxRegKey::QueryValue(const char *szValue, wxString& strValue) const | |
627 | { | |
628 | if ( CONST_CAST Open() ) { | |
629 | #ifdef __WIN32__ | |
630 | // first get the type and size of the data | |
631 | DWORD dwType, dwSize; | |
2432b92d | 632 | m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED, |
2bda0e17 KB |
633 | &dwType, NULL, &dwSize); |
634 | if ( m_dwLastError == ERROR_SUCCESS ) { | |
635 | RegString pBuf = (RegString)strValue.GetWriteBuf(dwSize); | |
2432b92d | 636 | m_dwLastError = RegQueryValueEx((HKEY) m_hKey, (char*) (const char*) szValue, RESERVED, |
2bda0e17 | 637 | &dwType, pBuf, &dwSize); |
44a6c8e6 | 638 | strValue.UngetWriteBuf(); |
2bda0e17 KB |
639 | if ( m_dwLastError == ERROR_SUCCESS ) { |
640 | // check that it was the right type | |
641 | wxASSERT_MSG( dwType == REG_SZ, | |
642 | "Type mismatch in wxRegKey::QueryValue()." ); | |
643 | ||
cf447356 | 644 | return TRUE; |
2bda0e17 KB |
645 | } |
646 | } | |
647 | #else //WIN16 | |
648 | // named registry values don't exist in Win16 | |
649 | wxASSERT( IsEmpty(szValue) ); | |
650 | ||
fd6c844b | 651 | m_dwLastError = RegQueryValue((HKEY) m_hKey, 0, strValue.GetWriteBuf(256), &l); |
44a6c8e6 | 652 | strValue.UngetWriteBuf(); |
2bda0e17 | 653 | if ( m_dwLastError == ERROR_SUCCESS ) |
cf447356 | 654 | return TRUE; |
2bda0e17 KB |
655 | #endif //WIN16/32 |
656 | } | |
657 | ||
02569ba8 | 658 | wxLogSysError(m_dwLastError, _("can't read value of '%s'"), |
2bda0e17 | 659 | GetFullName(this, szValue)); |
cf447356 | 660 | return FALSE; |
2bda0e17 KB |
661 | } |
662 | ||
663 | bool wxRegKey::SetValue(const char *szValue, const wxString& strValue) | |
664 | { | |
665 | if ( CONST_CAST Open() ) { | |
57c208c5 | 666 | #if defined( __WIN32__) && !defined(__TWIN32__) |
6b037754 | 667 | m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_SZ, |
2bda0e17 KB |
668 | (RegString)strValue.c_str(), |
669 | strValue.Len() + 1); | |
670 | if ( m_dwLastError == ERROR_SUCCESS ) | |
cf447356 | 671 | return TRUE; |
2bda0e17 KB |
672 | #else //WIN16 |
673 | // named registry values don't exist in Win16 | |
674 | wxASSERT( IsEmpty(szValue) ); | |
675 | ||
fd6c844b | 676 | m_dwLastError = RegSetValue((HKEY) m_hKey, NULL, REG_SZ, strValue, NULL); |
2bda0e17 | 677 | if ( m_dwLastError == ERROR_SUCCESS ) |
cf447356 | 678 | return TRUE; |
2bda0e17 KB |
679 | #endif //WIN16/32 |
680 | } | |
681 | ||
02569ba8 | 682 | wxLogSysError(m_dwLastError, _("can't set value of '%s'"), |
2bda0e17 | 683 | GetFullName(this, szValue)); |
cf447356 | 684 | return FALSE; |
2bda0e17 KB |
685 | } |
686 | ||
687 | wxRegKey::operator wxString() const | |
688 | { | |
689 | wxString str; | |
690 | QueryValue(NULL, str); | |
691 | return str; | |
692 | } | |
693 | ||
694 | // ---------------------------------------------------------------------------- | |
695 | // enumeration | |
696 | // NB: all these functions require an index variable which allows to have | |
697 | // several concurrently running indexations on the same key | |
698 | // ---------------------------------------------------------------------------- | |
699 | ||
2bda0e17 KB |
700 | bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex) |
701 | { | |
702 | if ( !Open() ) | |
cf447356 | 703 | return FALSE; |
2bda0e17 KB |
704 | |
705 | lIndex = 0; | |
0b1c5a6c | 706 | return GetNextValue(strValueName, lIndex); |
2bda0e17 KB |
707 | } |
708 | ||
709 | bool wxRegKey::GetNextValue(wxString& strValueName, long& lIndex) const | |
710 | { | |
711 | wxASSERT( IsOpened() ); | |
2bda0e17 | 712 | |
0b1c5a6c VZ |
713 | // are we already at the end of enumeration? |
714 | if ( lIndex == -1 ) | |
cf447356 | 715 | return FALSE; |
2bda0e17 | 716 | |
57c208c5 | 717 | #if defined( __WIN32__) && !defined(__TWIN32__) |
0b1c5a6c VZ |
718 | char szValueName[1024]; // @@ use RegQueryInfoKey... |
719 | DWORD dwValueLen = WXSIZEOF(szValueName); | |
2bda0e17 | 720 | |
0b1c5a6c | 721 | lIndex++; |
fd6c844b | 722 | m_dwLastError = RegEnumValue((HKEY) m_hKey, lIndex, |
0b1c5a6c VZ |
723 | szValueName, &dwValueLen, |
724 | RESERVED, | |
725 | NULL, // [out] type | |
726 | NULL, // [out] buffer for value | |
727 | NULL); // [i/o] it's length | |
728 | ||
729 | if ( m_dwLastError != ERROR_SUCCESS ) { | |
730 | if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) { | |
731 | m_dwLastError = ERROR_SUCCESS; | |
732 | lIndex = -1; | |
733 | } | |
734 | else { | |
02569ba8 | 735 | wxLogSysError(m_dwLastError, _("can't enumerate values of key '%s'"), |
0b1c5a6c VZ |
736 | GetName().c_str()); |
737 | } | |
738 | ||
cf447356 | 739 | return FALSE; |
2bda0e17 KB |
740 | } |
741 | ||
0b1c5a6c VZ |
742 | strValueName = szValueName; |
743 | #else //WIN16 | |
744 | // only one unnamed value | |
745 | wxASSERT( lIndex == 0 ); | |
2bda0e17 | 746 | |
0b1c5a6c VZ |
747 | lIndex = -1; |
748 | strValueName.Empty(); | |
749 | #endif | |
750 | ||
cf447356 | 751 | return TRUE; |
2bda0e17 | 752 | } |
2bda0e17 KB |
753 | |
754 | bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex) | |
755 | { | |
756 | if ( !Open() ) | |
cf447356 | 757 | return FALSE; |
2bda0e17 | 758 | |
2bda0e17 | 759 | lIndex = 0; |
0b1c5a6c | 760 | return GetNextKey(strKeyName, lIndex); |
2bda0e17 KB |
761 | } |
762 | ||
763 | bool wxRegKey::GetNextKey(wxString& strKeyName, long& lIndex) const | |
764 | { | |
765 | wxASSERT( IsOpened() ); | |
0b1c5a6c VZ |
766 | |
767 | // are we already at the end of enumeration? | |
768 | if ( lIndex == -1 ) | |
cf447356 | 769 | return FALSE; |
2bda0e17 KB |
770 | |
771 | char szKeyName[_MAX_PATH + 1]; | |
fd6c844b | 772 | m_dwLastError = RegEnumKey((HKEY) m_hKey, lIndex++, szKeyName, WXSIZEOF(szKeyName)); |
2bda0e17 KB |
773 | |
774 | if ( m_dwLastError != ERROR_SUCCESS ) { | |
775 | if ( m_dwLastError == ERROR_NO_MORE_ITEMS ) { | |
776 | m_dwLastError = ERROR_SUCCESS; | |
777 | lIndex = -1; | |
778 | } | |
779 | else { | |
02569ba8 | 780 | wxLogSysError(m_dwLastError, _("can't enumerate subkeys of key '%s'"), |
2bda0e17 KB |
781 | GetName().c_str()); |
782 | } | |
783 | ||
cf447356 | 784 | return FALSE; |
2bda0e17 KB |
785 | } |
786 | ||
787 | strKeyName = szKeyName; | |
cf447356 | 788 | return TRUE; |
2bda0e17 KB |
789 | } |
790 | ||
791 | // ============================================================================ | |
1880e452 | 792 | // implementation of global private functions |
2bda0e17 | 793 | // ============================================================================ |
fd6c844b | 794 | bool KeyExists(WXHKEY hRootKey, const char *szKey) |
2bda0e17 KB |
795 | { |
796 | HKEY hkeyDummy; | |
fd6c844b | 797 | if ( RegOpenKey( (HKEY) hRootKey, szKey, &hkeyDummy) == ERROR_SUCCESS ) { |
2bda0e17 | 798 | RegCloseKey(hkeyDummy); |
cf447356 | 799 | return TRUE; |
2bda0e17 KB |
800 | } |
801 | else | |
cf447356 | 802 | return FALSE; |
2bda0e17 KB |
803 | } |
804 | ||
805 | const char *GetFullName(const wxRegKey *pKey, const char *szValue) | |
806 | { | |
807 | static wxString s_str; | |
808 | s_str = pKey->GetName(); | |
809 | if ( !IsEmpty(szValue) ) | |
810 | s_str << "\\" << szValue; | |
811 | ||
812 | return s_str.c_str(); | |
0b1c5a6c VZ |
813 | } |
814 | ||
815 | void RemoveTrailingSeparator(wxString& str) | |
816 | { | |
817 | if ( !str.IsEmpty() && str.Last() == REG_SEPARATOR ) | |
818 | str.Truncate(str.Len() - 1); | |
819 | } | |
3d05544e JS |
820 | |
821 | #endif | |
822 | // __WIN16__ | |
823 |