#include "wx/string.h"
#include "wx/intl.h"
#include "wx/log.h"
+#include "wx/file.h"
+#include "wx/wfstream.h"
// Windows headers
-/*
-#define STRICT
-#define WIN32_LEAN_AND_MEAN
-*/
-
#include "wx/msw/wrapwin.h"
#ifdef __WXWINCE__
aStdKeys[] =
{
{ HKEY_CLASSES_ROOT, wxT("HKEY_CLASSES_ROOT"), wxT("HKCR") },
-#ifdef __WIN32__
{ HKEY_CURRENT_USER, wxT("HKEY_CURRENT_USER"), wxT("HKCU") },
{ HKEY_LOCAL_MACHINE, wxT("HKEY_LOCAL_MACHINE"), wxT("HKLM") },
{ HKEY_USERS, wxT("HKEY_USERS"), wxT("HKU") }, // short name?
{ HKEY_DYN_DATA, wxT("HKEY_DYN_DATA"), wxT("HKDD") }, // short name?
#endif //GNUWIN32
#endif //WINVER >= 4.0
-#endif //WIN32
};
// the registry name separator (perhaps one day MS will change it to '/' ;-)
// removes the trailing backslash from the string if it has one
static inline void RemoveTrailingSeparator(wxString& str);
-// returns TRUE if given registry key exists
+// returns true if given registry key exists
static bool KeyExists(WXHKEY hRootKey, const wxChar *szKey);
// combines value and key name (uses static buffer!)
// info about the key
// ----------------------------------------------------------------------------
-// returns TRUE if the key exists
+// returns true if the key exists
bool wxRegKey::Exists() const
{
// opened key has to exist, try to open it if not done yet
- return IsOpened() ? TRUE : KeyExists(m_hRootKey, m_strKey);
+ return IsOpened() ? true : KeyExists(m_hRootKey, m_strKey);
}
// returns the full name of the key (prefix is abbreviated if bShortPrefix)
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't get info about registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
bool wxRegKey::Open(AccessMode mode)
{
if ( IsOpened() )
- return TRUE;
+ return true;
HKEY tmpKey;
m_dwLastError = ::RegOpenKeyEx
{
wxLogSysError(m_dwLastError, _("Can't open registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
m_hKey = (WXHKEY) tmpKey;
- return TRUE;
+ return true;
}
// creates key, failing if it exists and !bOkIfExists
{
// check for existence only if asked (i.e. order is important!)
if ( !bOkIfExists && Exists() )
- return FALSE;
+ return false;
if ( IsOpened() )
- return TRUE;
+ return true;
HKEY tmpKey;
#ifdef __WXWINCE__
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't create registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
else
{
m_hKey = (WXHKEY) tmpKey;
- return TRUE;
+ return true;
}
}
wxLogSysError(m_dwLastError, _("Can't close registry key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
}
- return TRUE;
+ return true;
}
bool wxRegKey::RenameValue(const wxChar *szValueOld, const wxChar *szValueNew)
{
- bool ok = TRUE;
+ bool ok = true;
if ( HasValue(szValueNew) ) {
wxLogError(_("Registry value '%s' already exists."), szValueNew);
- ok = FALSE;
+ ok = false;
}
if ( !ok ||
wxLogError(_("Failed to rename registry value '%s' to '%s'."),
szValueOld, szValueNew);
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
bool wxRegKey::CopyValue(const wxChar *szValue,
keyDst.SetValue(szValueNew, dwVal);
}
-#ifdef __WIN32__
case Type_Binary:
- {
- wxMemoryBuffer buf;
- return QueryValue(szValue,buf) &&
- keyDst.SetValue(szValueNew,buf);
- }
+ {
+ wxMemoryBuffer buf;
+ return QueryValue(szValue,buf) &&
+ keyDst.SetValue(szValueNew,buf);
+ }
+
// these types are unsupported because I am not sure about how
// exactly they should be copied and because they shouldn't
// occur among the application keys (supposedly created with
case Type_Resource_list:
case Type_Full_resource_descriptor:
case Type_Resource_requirements_list:
-#endif // Win32
default:
wxLogError(_("Can't copy values of unsupported type %d."),
GetValueType(szValue));
- return FALSE;
+ return false;
}
}
bool wxRegKey::Rename(const wxChar *szNewName)
{
- wxCHECK_MSG( !!m_strKey, FALSE, _T("registry hives can't be renamed") );
+ wxCHECK_MSG( !m_strKey.IsEmpty(), false, _T("registry hives can't be renamed") );
if ( !Exists() ) {
wxLogError(_("Registry key '%s' does not exist, cannot rename it."),
GetFullName(this));
- return FALSE;
+ return false;
}
// do we stay in the same hive?
if ( inSameHive ) {
// rename the key to the new name under the same parent
wxString strKey = m_strKey.BeforeLast(REG_SEPARATOR);
- if ( !!strKey ) {
+ if ( !strKey.IsEmpty() ) {
// don't add '\\' in the start if strFullNewName is empty
strKey += REG_SEPARATOR;
}
keyDst.SetName(szNewName);
}
- bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
if ( !ok ) {
wxLogError(_("Registry key '%s' already exists."),
GetFullName(&keyDst));
{
// create the new key first
wxRegKey keyDst(szNewName);
- bool ok = keyDst.Create(FALSE /* fail if alredy exists */);
+ bool ok = keyDst.Create(false /* fail if alredy exists */);
if ( ok ) {
ok = Copy(keyDst);
bool wxRegKey::Copy(wxRegKey& keyDst)
{
- bool ok = TRUE;
+ bool ok = true;
// copy all sub keys to the new location
wxString strKey;
if ( ok )
bCont = GetNextKey(strKey, lIndex);
- else
- wxLogError(_("Failed to copy the registry subkey '%s' to '%s'."),
+ else
+ wxLogError(_("Failed to copy the registry subkey '%s' to '%s'."),
GetFullName(&key), keyName.c_str());
-
+
}
// copy all values
wxLogNull nolog;
if ( !Open() ) {
// it already doesn't exist - ok!
- return TRUE;
+ return true;
}
}
wxLogError(_("Registry key '%s' is needed for normal system operation,\ndeleting it will leave your system in unusable state:\noperation aborted."),
GetFullName(this));
- return FALSE;
+ return false;
}
// we can't delete keys while enumerating because it confuses GetNextKey, so
for ( size_t nKey = 0; nKey < nKeyCount; nKey++ ) {
wxRegKey key(*this, astrSubkeys[nKey]);
if ( !key.DeleteSelf() )
- return FALSE;
+ return false;
}
// now delete this key itself
m_dwLastError != ERROR_FILE_NOT_FOUND ) {
wxLogSysError(m_dwLastError, _("Can't delete key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
bool wxRegKey::DeleteKey(const wxChar *szKey)
{
if ( !Open() )
- return FALSE;
+ return false;
wxRegKey key(*this, szKey);
return key.DeleteSelf();
bool wxRegKey::DeleteValue(const wxChar *szValue)
{
if ( !Open() )
- return FALSE;
+ return false;
m_dwLastError = RegDeleteValue((HKEY) m_hKey, WXSTRINGCAST szValue);
(m_dwLastError != ERROR_FILE_NOT_FOUND) ) {
wxLogSysError(m_dwLastError, _("Can't delete value '%s' from key '%s'"),
szValue, GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// access to values and subkeys
// ----------------------------------------------------------------------------
-// return TRUE if value exists
+// return true if value exists
bool wxRegKey::HasValue(const wxChar *szValue) const
{
// this function should be silent, so suppress possible messages from Open()
wxLogNull nolog;
if ( !CONST_CAST Open(Read) )
- return FALSE;
+ return false;
LONG dwRet = ::RegQueryValueEx((HKEY) m_hKey,
WXSTRINGCAST szValue,
return dwRet == ERROR_SUCCESS;
}
-// returns TRUE if this key has any values
+// returns true if this key has any values
bool wxRegKey::HasValues() const
{
// suppress possible messages from GetFirstValue()
return CONST_CAST GetFirstValue(str, l);
}
-// returns TRUE if this key has any subkeys
+// returns true if this key has any subkeys
bool wxRegKey::HasSubkeys() const
{
// suppress possible messages from GetFirstKey()
return CONST_CAST GetFirstKey(str, l);
}
-// returns TRUE if given subkey exists
+// returns true if given subkey exists
bool wxRegKey::HasSubKey(const wxChar *szKey) const
{
// this function should be silent, so suppress possible messages from Open()
wxLogNull nolog;
if ( !CONST_CAST Open(Read) )
- return FALSE;
+ return false;
return KeyExists(m_hKey, szKey);
}
return (ValueType)dwType;
}
-#ifdef __WIN32__
bool wxRegKey::SetValue(const wxChar *szValue, long lValue)
{
if ( CONST_CAST Open() ) {
m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_DWORD,
(RegString)&lValue, sizeof(lValue));
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
+ return true;
}
wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
bool wxRegKey::QueryValue(const wxChar *szValue, long *plValue) const
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
else {
// check that we read the value of right type
wxASSERT_MSG( IsNumericValue(szValue),
wxT("Type mismatch in wxRegKey::QueryValue().") );
- return TRUE;
+ return true;
}
}
else
- return FALSE;
+ return false;
}
bool wxRegKey::SetValue(const wxChar *szValue,const wxMemoryBuffer& buffer)
{
#ifdef __TWIN32__
wxFAIL_MSG("RegSetValueEx not implemented by TWIN32");
- return FALSE;
+ return false;
#else
if ( CONST_CAST Open() ) {
m_dwLastError = RegSetValueEx((HKEY) m_hKey, szValue, (DWORD) RESERVED, REG_BINARY,
(RegBinary)buffer.GetData(),buffer.GetDataLen());
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
+ return true;
}
wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
#endif
}
DWORD dwType, dwSize;
m_dwLastError = RegQueryValueEx((HKEY) m_hKey, WXSTRINGCAST szValue, RESERVED,
&dwType, NULL, &dwSize);
-
+
if ( m_dwLastError == ERROR_SUCCESS ) {
if ( dwSize ) {
const RegBinary pBuf = (RegBinary)buffer.GetWriteBuf(dwSize);
pBuf,
&dwSize);
buffer.UngetWriteBuf(dwSize);
- } else {
- buffer.SetDataLen(0);
+ } else {
+ buffer.SetDataLen(0);
}
}
-
+
if ( m_dwLastError != ERROR_SUCCESS ) {
wxLogSysError(m_dwLastError, _("Can't read value of key '%s'"),
GetName().c_str());
- return FALSE;
+ return false;
}
- return TRUE;
+ return true;
}
- return FALSE;
+ return false;
}
-#endif //Win32
-
bool wxRegKey::QueryValue(const wxChar *szValue,
wxString& strValue,
bool raw) const
wxASSERT_MSG( !IsNumericValue(szValue),
wxT("Type mismatch in wxRegKey::QueryValue().") );
- return TRUE;
+ return true;
}
}
}
wxLogSysError(m_dwLastError, _("Can't read value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
bool wxRegKey::SetValue(const wxChar *szValue, const wxString& strValue)
(RegString)strValue.c_str(),
(strValue.Len() + 1)*sizeof(wxChar));
if ( m_dwLastError == ERROR_SUCCESS )
- return TRUE;
+ return true;
}
wxLogSysError(m_dwLastError, _("Can't set value of '%s'"),
GetFullName(this, szValue));
- return FALSE;
+ return false;
}
wxString wxRegKey::QueryDefaultValue() const
bool wxRegKey::GetFirstValue(wxString& strValueName, long& lIndex)
{
if ( !Open(Read) )
- return FALSE;
+ return false;
lIndex = 0;
return GetNextValue(strValueName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return FALSE;
+ return false;
wxChar szValueName[1024]; // @@ use RegQueryInfoKey...
DWORD dwValueLen = WXSIZEOF(szValueName);
GetName().c_str());
}
- return FALSE;
+ return false;
}
strValueName = szValueName;
- return TRUE;
+ return true;
}
bool wxRegKey::GetFirstKey(wxString& strKeyName, long& lIndex)
{
if ( !Open(Read) )
- return FALSE;
+ return false;
lIndex = 0;
return GetNextKey(strKeyName, lIndex);
// are we already at the end of enumeration?
if ( lIndex == -1 )
- return FALSE;
+ return false;
wxChar szKeyName[_MAX_PATH + 1];
GetName().c_str());
}
- return FALSE;
+ return false;
}
strKeyName = szKeyName;
- return TRUE;
+ return true;
}
-// returns TRUE if the value contains a number (else it's some string)
+// returns true if the value contains a number (else it's some string)
bool wxRegKey::IsNumericValue(const wxChar *szValue) const
- {
- ValueType type = GetValueType(szValue);
- switch ( type ) {
+{
+ ValueType type = GetValueType(szValue);
+ switch ( type ) {
case Type_Dword:
/* case Type_Dword_little_endian: == Type_Dword */
case Type_Dword_big_endian:
- return TRUE;
+ return true;
default:
- return FALSE;
- }
- }
+ return false;
+ }
+}
+
+// ----------------------------------------------------------------------------
+// exporting registry keys to file
+// ----------------------------------------------------------------------------
+
+// helper functions for writing ASCII strings (even in Unicode build)
+static inline bool WriteAsciiChar(wxOutputStream& ostr, char ch)
+{
+ ostr.PutC(ch);
+ return ostr.IsOk();
+}
+
+static inline bool WriteAsciiEOL(wxOutputStream& ostr)
+{
+ // as we open the file in text mode, it is enough to write LF without CR
+ return WriteAsciiChar(ostr, '\n');
+}
+
+static inline bool WriteAsciiString(wxOutputStream& ostr, const char *p)
+{
+ return ostr.Write(p, strlen(p)).IsOk();
+}
+
+static inline bool WriteAsciiString(wxOutputStream& ostr, const wxString& s)
+{
+#if wxUSE_UNICODE
+ wxCharBuffer name(s.mb_str());
+ ostr.Write(name, strlen(name));
+#else
+ ostr.Write(s, s.length());
+#endif
+
+ return ostr.IsOk();
+}
+
+bool wxRegKey::Export(const wxString& filename) const
+{
+ if ( wxFile::Exists(filename) )
+ {
+ wxLogError(_("Exporting registry key: file \"%s\" already exists and won't be overwritten."),
+ filename.c_str());
+ return false;
+ }
+
+ wxFFileOutputStream ostr(filename, _T("w"));
+
+ return ostr.Ok() && Export(ostr);
+}
+
+bool wxRegKey::Export(wxOutputStream& ostr) const
+{
+ // write out the header
+ if ( !WriteAsciiString(ostr, "REGEDIT4\n\n") )
+ return false;
+
+ return DoExport(ostr);
+}
+
+static
+wxString
+FormatAsHex(const void *data,
+ size_t size,
+ wxRegKey::ValueType type = wxRegKey::Type_Binary)
+{
+ wxString value(_T("hex"));
+
+ // binary values use just "hex:" prefix while the other ones must indicate
+ // the real type
+ if ( type != wxRegKey::Type_Binary )
+ value << _T('(') << type << _T(')');
+ value << _T(':');
+
+ // write all the rest as comma-separated bytes
+ value.reserve(3*size + 10);
+ const char * const p = wx_static_cast(const char *, data);
+ for ( size_t n = 0; n < size; n++ )
+ {
+ // TODO: line wrapping: although not required by regedit, this makes
+ // the generated files easier to read and compare with the files
+ // produced by regedit
+ if ( n )
+ value << _T(',');
+
+ value << wxString::Format(_T("%02x"), (unsigned char)p[n]);
+ }
+
+ return value;
+}
+
+static inline
+wxString FormatAsHex(const wxString& value, wxRegKey::ValueType type)
+{
+ return FormatAsHex(value.c_str(), value.length() + 1, type);
+}
+
+wxString wxRegKey::FormatValue(const wxString& name) const
+{
+ wxString rhs;
+ const ValueType type = GetValueType(name);
+ switch ( type )
+ {
+ case Type_String:
+ {
+ wxString value;
+ if ( !QueryValue(name, value) )
+ break;
+
+ // quotes and backslashes must be quoted, linefeeds are not
+ // allowed in string values
+ rhs.reserve(value.length() + 2);
+ rhs = _T('"');
+
+ // there can be no NULs here
+ bool useHex = false;
+ for ( const wxChar *p = value.c_str(); *p && !useHex; p++ )
+ {
+ switch ( *p )
+ {
+ case _T('\n'):
+ // we can only represent this string in hex
+ useHex = true;
+ break;
+
+ case _T('"'):
+ case _T('\\'):
+ // escape special symbol
+ rhs += _T('\\');
+ // fall through
+
+ default:
+ rhs += *p;
+ }
+ }
+
+ if ( useHex )
+ rhs = FormatAsHex(value, Type_String);
+ else
+ rhs += _T('"');
+ }
+ break;
+
+ case Type_Dword:
+ /* case Type_Dword_little_endian: == Type_Dword */
+ {
+ long value;
+ if ( !QueryValue(name, &value) )
+ break;
+
+ rhs.Printf(_T("dword:%08x"), (unsigned int)value);
+ }
+ break;
+
+ case Type_Expand_String:
+ case Type_Multi_String:
+ {
+ wxString value;
+ if ( !QueryRawValue(name, value) )
+ break;
+
+ rhs = FormatAsHex(value, type);
+ }
+ break;
+
+ case Type_Binary:
+ {
+ wxMemoryBuffer buf;
+ if ( !QueryValue(name, buf) )
+ break;
+
+ rhs = FormatAsHex(buf.GetData(), buf.GetDataLen());
+ }
+ break;
+
+ // no idea how those appear in REGEDIT4 files
+ case Type_None:
+ case Type_Dword_big_endian:
+ case Type_Link:
+ case Type_Resource_list:
+ case Type_Full_resource_descriptor:
+ case Type_Resource_requirements_list:
+ default:
+ wxLogWarning(_("Can't export value of unsupported type %d."), type);
+ }
+
+ return rhs;
+}
+
+bool wxRegKey::DoExportValue(wxOutputStream& ostr, const wxString& name) const
+{
+ // first examine the value type: if it's unsupported, simply skip it
+ // instead of aborting the entire export process because we failed to
+ // export a single value
+ wxString value = FormatValue(name);
+ if ( value.empty() )
+ {
+ wxLogWarning(_("Ignoring value \"%s\" of the key \"%s\"."),
+ name.c_str(), GetName().c_str());
+ return true;
+ }
+
+ // we do have the text representation of the value, now write everything
+ // out
+
+ // special case: unnamed/default value is represented as just "@"
+ if ( name.empty() )
+ {
+ if ( !WriteAsciiChar(ostr, '@') )
+ return false;
+ }
+ else // normal, named, value
+ {
+ if ( !WriteAsciiChar(ostr, '"') ||
+ !WriteAsciiString(ostr, name) ||
+ !WriteAsciiChar(ostr, '"') )
+ return false;
+ }
+
+ if ( !WriteAsciiChar(ostr, '=') )
+ return false;
+
+ return WriteAsciiString(ostr, value) && WriteAsciiEOL(ostr);
+}
+
+bool wxRegKey::DoExport(wxOutputStream& ostr) const
+{
+ // write out this key name
+ if ( !WriteAsciiChar(ostr, '[') )
+ return false;
+
+ if ( !WriteAsciiString(ostr, GetName(false /* no short prefix */)) )
+ return false;
+
+ if ( !WriteAsciiChar(ostr, ']') || !WriteAsciiEOL(ostr) )
+ return false;
+
+ // dump all our values
+ long dummy;
+ wxString name;
+ wxRegKey& self = wx_const_cast(wxRegKey&, *this);
+ bool cont = self.GetFirstValue(name, dummy);
+ while ( cont )
+ {
+ if ( !DoExportValue(ostr, name) )
+ return false;
+
+ cont = GetNextValue(name, dummy);
+ }
+
+ // always terminate values by blank line, even if there were no values
+ if ( !WriteAsciiEOL(ostr) )
+ return false;
+
+ // recurse to subkeys
+ cont = self.GetFirstKey(name, dummy);
+ while ( cont )
+ {
+ wxRegKey subkey(*this, name);
+ if ( !subkey.DoExport(ostr) )
+ return false;
+
+ cont = GetNextKey(name, dummy);
+ }
+
+ return true;
+}
// ============================================================================
// implementation of global private functions
{
// don't close this key itself for the case of empty szKey!
if ( wxIsEmpty(szKey) )
- return TRUE;
+ return true;
HKEY hkeyDummy;
if ( ::RegOpenKeyEx
{
::RegCloseKey(hkeyDummy);
- return TRUE;
+ return true;
}
- return FALSE;
+ return false;
}
const wxChar *GetFullName(const wxRegKey *pKey, const wxChar *szValue)
projects / wxWidgets.git / blobdiff