///////////////////////////////////////////////////////////////////////////////
-// Name: msw/registry.h
+// Name: wx/msw/registry.h
// Purpose: Registry classes and functions
// Author: Vadim Zeitlin
-// Modified by:
-// Created: 03.04.198
+// Modified by:
+// Created: 03.04.1998
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#ifndef _REGISTRY_H
-#define _REGISTRY_H
+#ifndef _WX_MSW_REGISTRY_H_
+#define _WX_MSW_REGISTRY_H_
-#ifdef __GNUG__
-#pragma interface "registry.h"
-#endif
+#include "wx/defs.h"
-// ----------------------------------------------------------------------------
-// mutable hack (see also registry.cpp)
-// ----------------------------------------------------------------------------
-#if wxUSE_MUTABLE
- #define MUTABLE mutable
-#else
- #define MUTABLE
-#endif
-
-// ----------------------------------------------------------------------------
-// types used in this module
-// ----------------------------------------------------------------------------
-
-/*
-#ifndef HKEY_DEFINED
- #define HKEY_DEFINED
- #define HKEY unsigned long
-#endif
-*/
+#if wxUSE_REGKEY
-typedef unsigned long ulong;
+class WXDLLIMPEXP_FWD_BASE wxOutputStream;
// ----------------------------------------------------------------------------
// class wxRegKey encapsulates window HKEY handle
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxRegKey
+
+class WXDLLIMPEXP_BASE wxRegKey
{
public:
// NB: do _not_ change the values of elements in these enumerations!
{
Type_None, // No value type
Type_String, // Unicode nul terminated string
-#ifdef __WIN32__
Type_Expand_String, // Unicode nul terminated string
// (with environment variable references)
Type_Binary, // Free form binary
Type_Dword, // 32-bit number
- Type_Dword_little_endian, // 32-bit number (same as Type_DWORD)
+ Type_Dword_little_endian // 32-bit number
+ = Type_Dword, // (same as Type_DWORD)
Type_Dword_big_endian, // 32-bit number
Type_Link, // Symbolic Link (unicode)
Type_Multi_String, // Multiple Unicode strings
Type_Resource_list, // Resource list in the resource map
Type_Full_resource_descriptor, // Resource list in the hardware description
Type_Resource_requirements_list // ???
-#endif //WIN32
};
// predefined registry keys
enum StdKey
{
- HKCR // classes root
-#ifdef __WIN32__
- , HKCU, // current user
- HKLM, // local machine
- HKUSR, // users
- HKPD // performance data (@@ NT only?)
-#if WINVER >= 0x0400
- , HKCC, // current config
- HKDD // dynamic data
-#endif // Winver
-#endif // Win32/16
+ HKCR, // classes root
+ HKCU, // current user
+ HKLM, // local machine
+ HKUSR, // users
+ HKPD, // performance data (WinNT/2K only)
+ HKCC, // current config
+ HKDD, // dynamic data (Win95/98 only)
+ HKMAX
+ };
+
+ // access mode for the key
+ enum AccessMode
+ {
+ Read, // read-only
+ Write // read and write
};
// information about standard (predefined) registry keys
wxRegKey(StdKey keyParent, const wxString& strKey);
// strKey is the name of key under (previously created) keyParent
wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
- //
+ // dtor closes the key
~wxRegKey();
// change key (closes the previously opened key if any)
// get infomation about the key
// get the (full) key name. Abbreviate std root keys if bShortPrefix.
- wxString GetName(bool bShortPrefix = TRUE) const;
+ wxString GetName(bool bShortPrefix = true) const;
// return true if the key exists
bool Exists() const;
// get the info about key (any number of these pointers may be NULL)
-
-#ifdef __GNUWIN32__
bool GetKeyInfo(size_t *pnSubKeys, // number of subkeys
size_t *pnMaxKeyLen, // max len of subkey name
size_t *pnValues, // number of values
size_t *pnMaxValueLen) const;
-#else
- bool GetKeyInfo(ulong *pnSubKeys, // number of subkeys
- ulong *pnMaxKeyLen, // max len of subkey name
- ulong *pnValues, // number of values
- ulong *pnMaxValueLen) const;
-#endif
// return true if the key is opened
bool IsOpened() const { return m_hKey != 0; }
// for "if ( !key ) wxLogError(...)" kind of expressions
// operations on the key itself
// explicitly open the key (will be automatically done by all functions
// which need the key to be opened if the key is not opened yet)
- bool Open();
- // create the key: will fail if the key already exists and bOkIfExists
- bool Create(bool bOkIfExists = TRUE);
+ bool Open(AccessMode mode = Write);
+ // create the key: will fail if the key already exists and !bOkIfExists
+ bool Create(bool bOkIfExists = true);
+ // rename a value from old name to new one
+ bool RenameValue(const wxString& szValueOld, const wxString& szValueNew);
+ // rename the key
+ bool Rename(const wxString& szNewName);
+ // copy value to another key possibly changing its name (by default it will
+ // remain the same)
+ bool CopyValue(const wxString& szValue, wxRegKey& keyDst,
+ const wxString& szNewName = wxEmptyString);
+
+ // copy the entire contents of the key recursively to another location
+ bool Copy(const wxString& szNewName);
+ // same as Copy() but using a key and not the name
+ bool Copy(wxRegKey& keyDst);
// close the key (will be automatically done in dtor)
bool Close();
// deletes this key and all of it's subkeys/values
bool DeleteSelf();
// deletes the subkey with all of it's subkeys/values recursively
- bool DeleteKey(const wxChar *szKey);
- // deletes the named value (may be NULL to remove the default value)
- bool DeleteValue(const wxChar *szValue);
+ bool DeleteKey(const wxString& szKey);
+ // deletes the named value (may be empty string to remove the default value)
+ bool DeleteValue(const wxString& szValue);
// access to values and subkeys
// get value type
- ValueType GetValueType(const wxChar *szValue) const;
- // returns TRUE if the value contains a number (else it's some string)
- bool IsNumericValue(const wxChar *szValue) const;
+ ValueType GetValueType(const wxString& szValue) const;
+ // returns true if the value contains a number (else it's some string)
+ bool IsNumericValue(const wxString& szValue) const;
// assignment operators set the default value of the key
wxRegKey& operator=(const wxString& strValue)
- { SetValue(NULL, strValue); return *this; }
- wxRegKey& operator=(long lValue)
- { SetValue(NULL, lValue); return *this; }
+ { SetValue(wxEmptyString, strValue); return *this; }
+
+ // query the default value of the key: implicitly or explicitly
+ wxString QueryDefaultValue() const;
+ operator wxString() const { return QueryDefaultValue(); }
- // conversion operators query the default value of the key
- operator wxString() const;
+ // named values
// set the string value
- bool SetValue(const wxChar *szValue, const wxString& strValue);
- // return the string value
- bool QueryValue(const wxChar *szValue, wxString& strValue) const;
+ bool SetValue(const wxString& szValue, const wxString& strValue);
+ // retrieve the string value
+ bool QueryValue(const wxString& szValue, wxString& strValue) const
+ { return QueryValue(szValue, strValue, false); }
+ // retrieve raw string value
+ bool QueryRawValue(const wxString& szValue, wxString& strValue) const
+ { return QueryValue(szValue, strValue, true); }
+ // retrieve either raw or expanded string value
+ bool QueryValue(const wxString& szValue, wxString& strValue, bool raw) const;
-#ifdef __WIN32__
// set the numeric value
- bool SetValue(const wxChar *szValue, long lValue);
+ bool SetValue(const wxString& szValue, long lValue);
// return the numeric value
- bool QueryValue(const wxChar *szValue, long *plValue) const;
-#endif //Win32
+ bool QueryValue(const wxString& szValue, long *plValue) const;
+ // set the binary value
+ bool SetValue(const wxString& szValue, const wxMemoryBuffer& buf);
+ // return the binary value
+ bool QueryValue(const wxString& szValue, wxMemoryBuffer& buf) const;
// query existence of a key/value
// return true if value exists
- bool HasValue(const wxChar *szKey) const;
+ bool HasValue(const wxString& szKey) const;
// return true if given subkey exists
- bool HasSubKey(const wxChar *szKey) const;
+ bool HasSubKey(const wxString& szKey) const;
// return true if any subkeys exist
- bool HasSubkeys() const;
+ bool HasSubkeys() const;
+ // return true if any values exist
+ bool HasValues() const;
+ // return true if the key is empty (nothing under this key)
+ bool IsEmpty() const { return !HasSubkeys() && !HasValues(); }
// enumerate values and subkeys
bool GetFirstValue(wxString& strValueName, long& lIndex);
bool GetFirstKey (wxString& strKeyName , long& lIndex);
bool GetNextKey (wxString& strKeyName , long& lIndex) const;
+ // export the contents of this key and all its subkeys to the given file
+ // (which won't be overwritten, it's an error if it already exists)
+ //
+ // note that we export the key in REGEDIT4 format, not RegSaveKey() binary
+ // format nor newer REGEDIT5 one
+ bool Export(const wxString& filename) const;
+
+ // same as above but write to the given (opened) stream
+ bool Export(wxOutputStream& ostr) const;
+
+
+ // for wxRegConfig usage only: preallocate some memory for the name
+ void ReserveMemoryForName(size_t bytes) { m_strKey.reserve(bytes); }
+
private:
- // no copy ctor/assignment operator
- wxRegKey(const wxRegKey& key); // not implemented
- wxRegKey& operator=(const wxRegKey& key); // not implemented
+ // common part of all ctors
+ void Init()
+ {
+ m_hKey = (WXHKEY) NULL;
+ m_dwLastError = 0;
+ }
+
+ // recursive helper for Export()
+ bool DoExport(wxOutputStream& ostr) const;
+
+ // export a single value
+ bool DoExportValue(wxOutputStream& ostr, const wxString& name) const;
+
+ // return the text representation (in REGEDIT4 format) of the value with the
+ // given name
+ wxString FormatValue(const wxString& name) const;
+
WXHKEY m_hKey, // our handle
m_hRootKey; // handle of the top key (i.e. StdKey)
wxString m_strKey; // key name (relative to m_hRootKey)
- MUTABLE long m_dwLastError; // last error (0 if none)
+ AccessMode m_mode; // valid only if key is opened
+ long m_dwLastError; // last error (0 if none)
+
+
+ wxDECLARE_NO_COPY_CLASS(wxRegKey);
};
-#endif //_REGISTRY_H
+#endif // wxUSE_REGKEY
+
+#endif // _WX_MSW_REGISTRY_H_
projects / wxWidgets.git / blobdiff