X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/655719367ac5e131d9642e5783f3ecf64d1a3385..14b682f7c36ecf660c2f0bd5c791b8d36d9775f8:/include/wx/msw/registry.h diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h index 4a8c26ac6f..7969edba45 100644 --- a/include/wx/msw/registry.h +++ b/include/wx/msw/registry.h @@ -1,38 +1,28 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/registry.h +// Name: wx/msw/registry.h // Purpose: Registry classes and functions // Author: Vadim Zeitlin // Modified by: -// Created: 03.04.198 +// Created: 03.04.1998 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifndef _REGISTRY_H -#define _REGISTRY_H +#ifndef _WX_MSW_REGISTRY_H_ +#define _WX_MSW_REGISTRY_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "registry.h" -#endif +#include "wx/defs.h" -// ---------------------------------------------------------------------------- -// 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 WXDLLIMPEXP_BASE wxRegKey + +class WXDLLIMPEXP_BASE wxRegKey { public: // NB: do _not_ change the values of elements in these enumerations! @@ -42,7 +32,6 @@ public: { 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 @@ -55,25 +44,19 @@ public: 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__ - , + HKCR, // classes root HKCU, // current user HKLM, // local machine HKUSR, // users - HKPD // performance data (WinNT/2K only) -#if WINVER >= 0x0400 - , - HKCC, // current config (starting from Win95/NT 4.0) - HKDD // dynamic data (Win95/98 only) -#endif // Winver -#endif // Win32/16 + HKPD, // performance data (WinNT/2K only) + HKCC, // current config + HKDD, // dynamic data (Win95/98 only) + HKMAX }; // access mode for the key @@ -83,6 +66,22 @@ public: Write // read and write }; + // Different registry views supported under WOW64. + enum WOW64ViewMode + { + // 32 bit registry for 32 bit applications, 64 bit registry + // for 64 bit ones. + WOW64ViewMode_Default, + + // Can be used in 64 bit apps to access 32 bit registry, + // has no effect (i.e. treated as default) in 32 bit apps. + WOW64ViewMode_32, + + // Can be used in 32 bit apps to access 64 bit registry, + // has no effect (i.e. treated as default) in 64 bit apps. + WOW64ViewMode_64 + }; + // information about standard (predefined) registry keys // number of standard keys static const size_t nStdKeys; @@ -93,17 +92,23 @@ public: // get StdKey from root HKEY static StdKey GetStdKeyFromHkey(WXHKEY hkey); - // extacts the std key prefix from the string (return value) and + // extracts the std key prefix from the string (return value) and // leaves only the part after it (i.e. modifies the string passed!) static StdKey ExtractKeyName(wxString& str); // ctors // root key is set to HKCR (the only root key under Win16) - wxRegKey(); + wxRegKey(WOW64ViewMode viewMode = WOW64ViewMode_Default); + // strKey is the full name of the key (i.e. starting with HKEY_xxx...) - wxRegKey(const wxString& strKey); + wxRegKey(const wxString& strKey, + WOW64ViewMode viewMode = WOW64ViewMode_Default); + // strKey is the name of key under (standard key) keyParent - wxRegKey(StdKey keyParent, const wxString& strKey); + wxRegKey(StdKey keyParent, + const wxString& strKey, + WOW64ViewMode viewMode = WOW64ViewMode_Default); + // strKey is the name of key under (previously created) keyParent wxRegKey(const wxRegKey& keyParent, const wxString& strKey); // dtor closes the key @@ -121,7 +126,9 @@ public: // 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; + // Retrieves the registry view used by this key. + WOW64ViewMode GetView() const { return m_viewMode; } // return true if the key exists bool Exists() const; // get the info about key (any number of these pointers may be NULL) @@ -139,17 +146,18 @@ public: // which need the key to be opened if the key is not opened yet) bool Open(AccessMode mode = Write); // create the key: will fail if the key already exists and !bOkIfExists - bool Create(bool bOkIfExists = TRUE); + bool Create(bool bOkIfExists = true); // rename a value from old name to new one - bool RenameValue(const wxChar *szValueOld, const wxChar *szValueNew); + bool RenameValue(const wxString& szValueOld, const wxString& szValueNew); // rename the key - bool Rename(const wxChar *szNewName); + bool Rename(const wxString& szNewName); // copy value to another key possibly changing its name (by default it will // remain the same) - bool CopyValue(const wxChar *szValue, wxRegKey& keyDst, - const wxChar *szNewName = NULL); + 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 wxChar *szNewName); + 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) @@ -159,21 +167,19 @@ public: // 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; @@ -182,28 +188,30 @@ public: // named values // set the string value - bool SetValue(const wxChar *szValue, const wxString& strValue); + bool SetValue(const wxString& szValue, const wxString& strValue); // retrieve the string value - bool QueryValue(const wxChar *szValue, wxString& strValue) const - { return QueryValue(szValue, strValue, FALSE); } + bool QueryValue(const wxString& szValue, wxString& strValue) const + { return QueryValue(szValue, strValue, false); } // retrieve raw string value - bool QueryRawValue(const wxChar *szValue, wxString& strValue) const - { return QueryValue(szValue, strValue, TRUE); } + bool QueryRawValue(const wxString& szValue, wxString& strValue) const + { return QueryValue(szValue, strValue, true); } // retrieve either raw or expanded string value - bool QueryValue(const wxChar *szValue, wxString& strValue, bool raw) const; + 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; // return true if any values exist @@ -218,6 +226,17 @@ public: 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); } @@ -229,16 +248,29 @@ private: m_dwLastError = 0; } - // no copy ctor/assignment operator - wxRegKey(const wxRegKey& key); // not implemented - wxRegKey& operator=(const wxRegKey& key); // not implemented + // recursive helper for Export() + bool DoExport(wxOutputStream& ostr) 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) + // export a single value + bool DoExportValue(wxOutputStream& ostr, const wxString& name) const; - long m_dwLastError; // last error (0 if none) + // 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) + WOW64ViewMode m_viewMode; // which view to select under WOW64 + 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_