generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-11-07 05:58:43 +01:00
Code Issues Projects Releases Wiki Activity

Make WinRegistryKey easier to extend

Browse Source
This commit is contained in:
Scott Davis
2015-01-07 17:44:04 -05:00
parent d992509f6e
commit 7b347ea592
2 changed files with 51 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
Util/include/Poco/Util/WinRegistryKey.h
View File

@@ -38,14 +38,20 @@ class Util_API WinRegistryKey
public: public:
typedef std::vector<std::string> Keys; typedef std::vector<std::string> Keys;
typedef std::vector<std::string> Values; typedef std::vector<std::string> Values;
enum Type enum Type
{ {
REGT_NONE = 0, REGT_NONE = 0,
REGT_STRING = 1, REGT_STRING = 1,
REGT_STRING_EXPAND = 2, REGT_STRING_EXPAND = 2,
REGT_BINARY = 3, REGT_BINARY = 3,
REGT_DWORD = 4, REGT_DWORD = 4,
REGT_DWORD_BIG_ENDIAN = 5,
REGT_LINK = 6,
REGT_MULTI_STRING = 7,
REGT_RESOURCE_LIST = 8,
REGT_FULL_RESOURCE_DESCRIPTOR = 9,
REGT_RESOURCE_REQUIREMENTS_LIST = 10,
REGT_QWORD = 11 REGT_QWORD = 11
}; };
@@ -78,7 +84,7 @@ public:
void setString(const std::string& name, const std::string& value); void setString(const std::string& name, const std::string& value);
/// Sets the string value (REG_SZ) with the given name. /// Sets the string value (REG_SZ) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
std::string getString(const std::string& name); std::string getString(const std::string& name);
/// Returns the string value (REG_SZ) with the given name. /// Returns the string value (REG_SZ) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
@@ -88,7 +94,7 @@ public:
void setStringExpand(const std::string& name, const std::string& value); void setStringExpand(const std::string& name, const std::string& value);
/// Sets the expandable string value (REG_EXPAND_SZ) with the given name. /// Sets the expandable string value (REG_EXPAND_SZ) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
std::string getStringExpand(const std::string& name); std::string getStringExpand(const std::string& name);
/// Returns the string value (REG_EXPAND_SZ) with the given name. /// Returns the string value (REG_EXPAND_SZ) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
@@ -97,7 +103,7 @@ public:
/// ///
/// Throws a NotFoundException if the value does not exist. /// Throws a NotFoundException if the value does not exist.
void setBinary(const std::string& name, const std::vector<char>& value); void setBinary(const std::string& name, const std::vector<char>& value);
/// Sets the string value (REG_BINARY) with the given name. /// Sets the string value (REG_BINARY) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
@@ -110,7 +116,7 @@ public:
void setInt(const std::string& name, int value); void setInt(const std::string& name, int value);
/// Sets the numeric (REG_DWORD) value with the given name. /// Sets the numeric (REG_DWORD) value with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
int getInt(const std::string& name); int getInt(const std::string& name);
/// Returns the numeric value (REG_DWORD) with the given name. /// Returns the numeric value (REG_DWORD) with the given name.
/// An empty name denotes the default value. /// An empty name denotes the default value.
@@ -144,7 +150,7 @@ public:
Type type(const std::string& name); Type type(const std::string& name);
/// Returns the type of the key value. /// Returns the type of the key value.
bool exists(const std::string& name); bool exists(const std::string& name);
/// Returns true iff the given value exists under that key. /// Returns true iff the given value exists under that key.
@@ -153,7 +159,7 @@ public:
void values(Values& vals); void values(Values& vals);
/// Appends all value names to vals; /// Appends all value names to vals;
bool isReadOnly() const; bool isReadOnly() const;
/// Returns true iff the key has been opened for read-only access only. /// Returns true iff the key has been opened for read-only access only.
@@ -162,6 +168,7 @@ protected:
void close(); void close();
std::string key() const; std::string key() const;
std::string key(const std::string& valueName) const; std::string key(const std::string& valueName) const;
HKEY handle();
void handleSetError(const std::string& name); void handleSetError(const std::string& name);
static HKEY handleFor(const std::string& rootKey); static HKEY handleFor(const std::string& rootKey);
@@ -169,7 +176,7 @@ private:
WinRegistryKey(); WinRegistryKey();
WinRegistryKey(const WinRegistryKey&); WinRegistryKey(const WinRegistryKey&);
WinRegistryKey& operator = (const WinRegistryKey&); WinRegistryKey& operator = (const WinRegistryKey&);
HKEY _hRootKey; HKEY _hRootKey;
std::string _subKey; std::string _subKey;
HKEY _hKey; HKEY _hKey;

57
Util/src/WinRegistryKey.cpp
View File

@@ -40,17 +40,17 @@ namespace
_h(h) _h(h)
{ {
} }
~AutoHandle() ~AutoHandle()
{ {
FreeLibrary(_h); FreeLibrary(_h);
} }
HMODULE handle() HMODULE handle()
{ {
return _h; return _h;
} }
private: private:
HMODULE _h; HMODULE _h;
}; };
@@ -98,10 +98,10 @@ void WinRegistryKey::setString(const std::string& name, const std::string& value
std::wstring uvalue; std::wstring uvalue;
Poco::UnicodeConverter::toUTF16(value, uvalue); Poco::UnicodeConverter::toUTF16(value, uvalue);
if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_SZ, (CONST BYTE*) uvalue.c_str(), (DWORD) (uvalue.size() + 1)*sizeof(wchar_t)) != ERROR_SUCCESS) if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_SZ, (CONST BYTE*) uvalue.c_str(), (DWORD) (uvalue.size() + 1)*sizeof(wchar_t)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#else #else
if (RegSetValueExA(_hKey, name.c_str(), 0, REG_SZ, (CONST BYTE*) value.c_str(), (DWORD) value.size() + 1) != ERROR_SUCCESS) if (RegSetValueExA(_hKey, name.c_str(), 0, REG_SZ, (CONST BYTE*) value.c_str(), (DWORD) value.size() + 1) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#endif #endif
} }
@@ -114,7 +114,7 @@ std::string WinRegistryKey::getString(const std::string& name)
#if defined(POCO_WIN32_UTF8) #if defined(POCO_WIN32_UTF8)
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || type != REG_SZ && type != REG_EXPAND_SZ) if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || (type != REG_SZ && type != REG_EXPAND_SZ && type != REG_LINK))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
if (size > 0) if (size > 0)
{ {
@@ -128,7 +128,7 @@ std::string WinRegistryKey::getString(const std::string& name)
return result; return result;
} }
#else #else
if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || type != REG_SZ && type != REG_EXPAND_SZ) if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || (type != REG_SZ && type != REG_EXPAND_SZ && type != REG_LINK))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
if (size > 0) if (size > 0)
{ {
@@ -152,10 +152,10 @@ void WinRegistryKey::setStringExpand(const std::string& name, const std::string&
std::wstring uvalue; std::wstring uvalue;
Poco::UnicodeConverter::toUTF16(value, uvalue); Poco::UnicodeConverter::toUTF16(value, uvalue);
if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_EXPAND_SZ, (CONST BYTE*) uvalue.c_str(), (DWORD) (uvalue.size() + 1)*sizeof(wchar_t)) != ERROR_SUCCESS) if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_EXPAND_SZ, (CONST BYTE*) uvalue.c_str(), (DWORD) (uvalue.size() + 1)*sizeof(wchar_t)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#else #else
if (RegSetValueExA(_hKey, name.c_str(), 0, REG_EXPAND_SZ, (CONST BYTE*) value.c_str(), (DWORD) value.size() + 1) != ERROR_SUCCESS) if (RegSetValueExA(_hKey, name.c_str(), 0, REG_EXPAND_SZ, (CONST BYTE*) value.c_str(), (DWORD) value.size() + 1) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#endif #endif
} }
@@ -168,7 +168,7 @@ std::string WinRegistryKey::getStringExpand(const std::string& name)
#if defined(POCO_WIN32_UTF8) #if defined(POCO_WIN32_UTF8)
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || type != REG_SZ && type != REG_EXPAND_SZ) if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || (type != REG_SZ && type != REG_EXPAND_SZ && type != REG_LINK))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
if (size > 0) if (size > 0)
{ {
@@ -178,7 +178,7 @@ std::string WinRegistryKey::getStringExpand(const std::string& name)
buffer[len] = 0; buffer[len] = 0;
#if !defined(_WIN32_WCE) #if !defined(_WIN32_WCE)
wchar_t temp; wchar_t temp;
DWORD expSize = ExpandEnvironmentStringsW(buffer.begin(), &temp, 1); DWORD expSize = ExpandEnvironmentStringsW(buffer.begin(), &temp, 1);
Poco::Buffer<wchar_t> expBuffer(expSize); Poco::Buffer<wchar_t> expBuffer(expSize);
ExpandEnvironmentStringsW(buffer.begin(), expBuffer.begin(), expSize); ExpandEnvironmentStringsW(buffer.begin(), expBuffer.begin(), expSize);
std::string result; std::string result;
@@ -190,7 +190,7 @@ std::string WinRegistryKey::getStringExpand(const std::string& name)
return result; return result;
} }
#else #else
if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || type != REG_SZ && type != REG_EXPAND_SZ) if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS || (type != REG_SZ && type != REG_EXPAND_SZ && type != REG_LINK))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
if (size > 0) if (size > 0)
{ {
@@ -198,7 +198,7 @@ std::string WinRegistryKey::getStringExpand(const std::string& name)
RegQueryValueExA(_hKey, name.c_str(), NULL, NULL, (BYTE*) Buffer.begin(), &size); RegQueryValueExA(_hKey, name.c_str(), NULL, NULL, (BYTE*) Buffer.begin(), &size);
buffer[size] = 0; buffer[size] = 0;
char temp; char temp;
DWORD expSize = ExpandEnvironmentStringsA(buffer, &temp, 1); DWORD expSize = ExpandEnvironmentStringsA(buffer, &temp, 1);
Poco::Buffer<char> expBuffer(expSize); Poco::Buffer<char> expBuffer(expSize);
ExpandEnvironmentStringsA(Buffer.begin(), expBuffer.begin(), expSize); ExpandEnvironmentStringsA(Buffer.begin(), expBuffer.begin(), expSize);
std::string result(expBuffer.begin()); std::string result(expBuffer.begin());
@@ -217,10 +217,10 @@ void WinRegistryKey::setBinary( const std::string& name, const std::vector<char>
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_BINARY, (CONST BYTE*) &value[0], (DWORD) value.size()) != ERROR_SUCCESS) if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_BINARY, (CONST BYTE*) &value[0], (DWORD) value.size()) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#else #else
if (RegSetValueExA(_hKey, name.c_str(), 0, REG_BINARY, (CONST BYTE*) &value[0], (DWORD) value.size()) != ERROR_SUCCESS) if (RegSetValueExA(_hKey, name.c_str(), 0, REG_BINARY, (CONST BYTE*) &value[0], (DWORD) value.size()) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#endif #endif
} }
@@ -263,10 +263,10 @@ void WinRegistryKey::setInt(const std::string& name, int value)
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_DWORD, (CONST BYTE*) &data, sizeof(data)) != ERROR_SUCCESS) if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_DWORD, (CONST BYTE*) &data, sizeof(data)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#else #else
if (RegSetValueExA(_hKey, name.c_str(), 0, REG_DWORD, (CONST BYTE*) &data, sizeof(data)) != ERROR_SUCCESS) if (RegSetValueExA(_hKey, name.c_str(), 0, REG_DWORD, (CONST BYTE*) &data, sizeof(data)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#endif #endif
} }
@@ -280,10 +280,10 @@ int WinRegistryKey::getInt(const std::string& name)
#if defined(POCO_WIN32_UTF8) #if defined(POCO_WIN32_UTF8)
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, (BYTE*) &data, &size) != ERROR_SUCCESS || type != REG_DWORD) if (RegQueryValueExW(_hKey, uname.c_str(), NULL, &type, (BYTE*) &data, &size) != ERROR_SUCCESS || (type != REG_DWORD && type != REG_DWORD_BIG_ENDIAN))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
#else #else
if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, (BYTE*) &data, &size) != ERROR_SUCCESS || type != REG_DWORD) if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, (BYTE*) &data, &size) != ERROR_SUCCESS || (type != REG_DWORD && type != REG_DWORD_BIG_ENDIAN))
throw NotFoundException(key(name)); throw NotFoundException(key(name));
#endif #endif
return data; return data;
@@ -300,10 +300,10 @@ void WinRegistryKey::setInt64(const std::string& name, Poco::Int64 value)
std::wstring uname; std::wstring uname;
Poco::UnicodeConverter::toUTF16(name, uname); Poco::UnicodeConverter::toUTF16(name, uname);
if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_QWORD, (CONST BYTE*) &value, sizeof(value)) != ERROR_SUCCESS) if (RegSetValueExW(_hKey, uname.c_str(), 0, REG_QWORD, (CONST BYTE*) &value, sizeof(value)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#else #else
if (RegSetValueExA(_hKey, name.c_str(), 0, REG_QWORD, (CONST BYTE*) &value, sizeof(value)) != ERROR_SUCCESS) if (RegSetValueExA(_hKey, name.c_str(), 0, REG_QWORD, (CONST BYTE*) &value, sizeof(value)) != ERROR_SUCCESS)
handleSetError(name); handleSetError(name);
#endif #endif
} }
@@ -365,7 +365,7 @@ void WinRegistryKey::deleteKey()
#if defined(POCO_WIN32_UTF8) #if defined(POCO_WIN32_UTF8)
std::wstring usubKey; std::wstring usubKey;
Poco::UnicodeConverter::toUTF16(_subKey, usubKey); Poco::UnicodeConverter::toUTF16(_subKey, usubKey);
#if !defined(_WIN32_WCE) #if !defined(_WIN32_WCE)
typedef LONG (WINAPI *RegDeleteKeyExWFunc)(HKEY hKey, const wchar_t* lpSubKey, REGSAM samDesired, DWORD Reserved); typedef LONG (WINAPI *RegDeleteKeyExWFunc)(HKEY hKey, const wchar_t* lpSubKey, REGSAM samDesired, DWORD Reserved);
if (_extraSam != 0) if (_extraSam != 0)
@@ -443,8 +443,6 @@ WinRegistryKey::Type WinRegistryKey::type(const std::string& name)
if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS) if (RegQueryValueExA(_hKey, name.c_str(), NULL, &type, NULL, &size) != ERROR_SUCCESS)
throw NotFoundException(key(name)); throw NotFoundException(key(name));
#endif #endif
if (type != REG_SZ && type != REG_EXPAND_SZ && type != REG_DWORD && type != REG_QWORD && type != REG_BINARY)
throw NotFoundException(key(name)+": type not supported");
Type aType = (Type)type; Type aType = (Type)type;
return aType; return aType;
@@ -558,6 +556,13 @@ std::string WinRegistryKey::key(const std::string& valueName) const
} }
HKEY WinRegistryKey::handle()
{
open();
return _hKey;
}
HKEY WinRegistryKey::handleFor(const std::string& rootKey) HKEY WinRegistryKey::handleFor(const std::string& rootKey)
{ {
if (rootKey == "HKEY_CLASSES_ROOT") if (rootKey == "HKEY_CLASSES_ROOT")
@@ -594,7 +599,7 @@ void WinRegistryKey::subKeys(WinRegistryKey::Keys& keys)
DWORD subKeyCount = 0; DWORD subKeyCount = 0;
DWORD valueCount = 0; DWORD valueCount = 0;
if (RegQueryInfoKey(_hKey, NULL, NULL, NULL, &subKeyCount, NULL, NULL, &valueCount, NULL, NULL, NULL, NULL) != ERROR_SUCCESS) if (RegQueryInfoKey(_hKey, NULL, NULL, NULL, &subKeyCount, NULL, NULL, &valueCount, NULL, NULL, NULL, NULL) != ERROR_SUCCESS)
return; return;
@@ -633,7 +638,7 @@ void WinRegistryKey::values(WinRegistryKey::Values& vals)
open(); open();
DWORD valueCount = 0; DWORD valueCount = 0;
if (RegQueryInfoKey(_hKey, NULL, NULL, NULL, NULL, NULL, NULL, &valueCount, NULL, NULL, NULL, NULL) != ERROR_SUCCESS) if (RegQueryInfoKey(_hKey, NULL, NULL, NULL, NULL, NULL, NULL, &valueCount, NULL, NULL, NULL, NULL) != ERROR_SUCCESS)
return ; return ;