Skip to content
Snippets Groups Projects
Commit be3d859f authored by Robert Loehning's avatar Robert Loehning
Browse files

Moved code for accessing Windows Registry to src/shared.

parent 2f0e30c1
No related branches found
No related tags found
No related merge requests found
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#include "registryaccess.h"
#include <QtGui/QApplication>
#include <QtCore/QDir>
#include <QtCore/QTextStream>
namespace RegistryAccess {
static QString winErrorMessage(unsigned long error)
{
QString rc = QString::fromLatin1("#%1: ").arg(error);
ushort *lpMsgBuf;
const int len = FormatMessage(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
NULL, error, 0, (LPTSTR)&lpMsgBuf, 0, NULL);
if (len) {
rc = QString::fromUtf16(lpMsgBuf, len);
LocalFree(lpMsgBuf);
} else {
rc += QString::fromLatin1("<unknown error>");
}
return rc;
}
QString msgFunctionFailed(const char *f, unsigned long error)
{
return QString::fromLatin1("'%1' failed: %2").arg(QLatin1String(f), winErrorMessage(error));
}
static bool registryReadBinaryKey(HKEY handle, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *valueName,
QByteArray *data,
QString *errorMessage)
{
data->clear();
DWORD type;
DWORD size;
// get size and retrieve
LONG rc = RegQueryValueEx(handle, valueName, 0, &type, 0, &size);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgRegistryOperationFailed("read", valueName, msgFunctionFailed("RegQueryValueEx1", rc));
return false;
}
BYTE *dataC = new BYTE[size + 1];
// Will be Utf16 in case of a string
rc = RegQueryValueEx(handle, valueName, 0, &type, dataC, &size);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgRegistryOperationFailed("read", valueName, msgFunctionFailed("RegQueryValueEx2", rc));
return false;
}
*data = QByteArray(reinterpret_cast<const char*>(dataC), size);
delete [] dataC;
return true;
}
bool registryReadStringKey(HKEY handle, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *valueName,
QString *s,
QString *errorMessage)
{
QByteArray data;
if (!registryReadBinaryKey(handle, valueName, &data, errorMessage))
return false;
data += '\0';
data += '\0';
*s = QString::fromUtf16(reinterpret_cast<const unsigned short*>(data.data()));
return true;
}
bool openRegistryKey(HKEY category, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *key,
bool readWrite,
HKEY *keyHandle,
QString *errorMessage)
{
REGSAM accessRights = KEY_READ;
if (readWrite)
accessRights |= KEY_SET_VALUE;
const LONG rc = RegOpenKeyEx(category, key, 0, accessRights, keyHandle);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgFunctionFailed("RegOpenKeyEx", rc);
return false;
}
return true;
}
// Installation helpers: Format the debugger call with placeholders for PID and event
// '"[path]\qtcdebugger" [-wow] %ld %ld'.
QString debuggerCall(const QString &additionalOption)
{
QString rc;
QTextStream str(&rc);
str << '"' << QDir::toNativeSeparators(QApplication::applicationDirPath() + QLatin1Char('/')
+ debuggerApplicationFileC + QLatin1String(".exe")) << '"';
if (!additionalOption.isEmpty())
str << ' ' << additionalOption;
str << " %ld %ld";
return rc;
}
bool isRegistered(HKEY handle, const QString &call, QString *errorMessage, QString *oldDebugger)
{
QString registeredDebugger;
registryReadStringKey(handle, debuggerRegistryValueNameC, &registeredDebugger, errorMessage);
if (oldDebugger)
*oldDebugger = registeredDebugger;
return !registeredDebugger.compare(call, Qt::CaseInsensitive);
}
} // namespace RegistryAccess
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
// Some functions used by qtcreator.exe and qtcdebugger.exe to check if
// qtcdebugger is currently registered for post-mortem debugging.
// This is only needed on Windows.
#ifndef REGISTRYACCESS_H
#define REGISTRYACCESS_H
#include <QtCore/QString>
#include <QtCore/QLatin1String>
#include <Windows.h>
namespace RegistryAccess {
static const char *debuggerApplicationFileC = "qtcdebugger";
static const WCHAR *debuggerRegistryKeyC = L"Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
static const WCHAR *debuggerRegistryValueNameC = L"Debugger";
static inline QString wCharToQString(const WCHAR *w)
{
return QString::fromUtf16(reinterpret_cast<const ushort *>(w));
}
QString msgFunctionFailed(const char *f, unsigned long error);
static inline QString msgRegistryOperationFailed(const char *op, const WCHAR *valueName, const QString &why)
{
QString rc = QLatin1String("Registry ");
rc += QLatin1String(op);
rc += QLatin1String(" of ");
rc += wCharToQString(valueName);
rc += QLatin1String(" failed: ");
rc += why;
return rc;
}
bool registryReadStringKey(HKEY handle, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *valueName,
QString *s,
QString *errorMessage);
bool openRegistryKey(HKEY category, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *key,
bool readWrite,
HKEY *keyHandle,
QString *errorMessage);
QString debuggerCall(const QString &additionalOption = QString());
bool isRegistered(HKEY handle, const QString &call, QString *errorMessage, QString *oldDebugger = 0);
} // namespace RegistryAccess
#endif // REGISTRYACCESS_H
INCLUDEPATH *= $$PWD
SOURCES += $$PWD/registryaccess.cpp
HEADERS += $$PWD/registryaccess.h
LIBS *= -lpsapi
# PS API and registry functions
contains(QMAKE_CXX, cl) {
LIBS *= -ladvapi32
}
...@@ -45,26 +45,26 @@ ...@@ -45,26 +45,26 @@
#include <QtCore/QProcess> #include <QtCore/QProcess>
#include <QtGui/QPushButton> #include <QtGui/QPushButton>
#include "registryaccess.h"
#include <windows.h> #include <windows.h>
#include <psapi.h> #include <psapi.h>
using namespace RegistryAccess;
enum { debug = 0 }; enum { debug = 0 };
static const char *titleC = "Qt Creator Debugger"; static const char *titleC = "Qt Creator Debugger";
static const char *organizationC = "Nokia"; static const char *organizationC = "Nokia";
static const char *applicationFileC = "qtcdebugger";
static const WCHAR *debuggerRegistryKeyC = L"Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
// Optional // Optional
static const WCHAR *debuggerWow32RegistryKeyC = L"Software\\Wow6432Node\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug"; static const WCHAR *debuggerWow32RegistryKeyC = L"Software\\Wow6432Node\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
static const WCHAR *debuggerRegistryValueNameC = L"Debugger";
static const WCHAR *debuggerRegistryDefaultValueNameC = L"Debugger.Default"; static const WCHAR *debuggerRegistryDefaultValueNameC = L"Debugger.Default";
static const char *linkC = "http://msdn.microsoft.com/en-us/library/cc266343.aspx"; static const char *linkC = "http://msdn.microsoft.com/en-us/library/cc266343.aspx";
static const char *creatorBinaryC = "qtcreator.exe"; static const char *creatorBinaryC = "qtcreator.exe";
static inline QString wCharToQString(const WCHAR *w) { return QString::fromUtf16(reinterpret_cast<const ushort *>(w)); }
#ifdef __GNUC__ #ifdef __GNUC__
#define RRF_RT_ANY 0x0000ffff // no type restriction #define RRF_RT_ANY 0x0000ffff // no type restriction
#endif #endif
...@@ -78,28 +78,6 @@ bool noguiMode = false; ...@@ -78,28 +78,6 @@ bool noguiMode = false;
unsigned long argProcessId = 0; unsigned long argProcessId = 0;
quint64 argWinCrashEvent = 0; quint64 argWinCrashEvent = 0;
static QString winErrorMessage(unsigned long error)
{
QString rc = QString::fromLatin1("#%1: ").arg(error);
ushort *lpMsgBuf;
const int len = FormatMessage(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
NULL, error, 0, (LPTSTR)&lpMsgBuf, 0, NULL);
if (len) {
rc = QString::fromUtf16(lpMsgBuf, len);
LocalFree(lpMsgBuf);
} else {
rc += QString::fromLatin1("<unknown error>");
}
return rc;
}
static inline QString msgFunctionFailed(const char *f, unsigned long error)
{
return QString::fromLatin1("'%1' failed: %2").arg(QLatin1String(f), winErrorMessage(error));
}
static bool parseArguments(const QStringList &args, QString *errorMessage) static bool parseArguments(const QStringList &args, QString *errorMessage)
{ {
int argNumber = 0; int argNumber = 0;
...@@ -199,75 +177,6 @@ static void usage(const QString &binary, const QString &message = QString()) ...@@ -199,75 +177,6 @@ static void usage(const QString &binary, const QString &message = QString())
// ------- Registry helpers // ------- Registry helpers
static bool openRegistryKey(HKEY category, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *key,
bool readWrite,
HKEY *keyHandle,
QString *errorMessage)
{
REGSAM accessRights = KEY_READ;
if (readWrite)
accessRights |= KEY_SET_VALUE;
const LONG rc = RegOpenKeyEx(category, key, 0, accessRights, keyHandle);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgFunctionFailed("RegOpenKeyEx", rc);
return false;
}
return true;
}
static inline QString msgRegistryOperationFailed(const char *op, const WCHAR *valueName, const QString &why)
{
QString rc = QLatin1String("Registry ");
rc += QLatin1String(op);
rc += QLatin1String(" of ");
rc += wCharToQString(valueName);
rc += QLatin1String(" failed: ");
rc += why;
return rc;
}
static bool registryReadBinaryKey(HKEY handle, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *valueName,
QByteArray *data,
QString *errorMessage)
{
data->clear();
DWORD type;
DWORD size;
// get size and retrieve
LONG rc = RegQueryValueEx(handle, valueName, 0, &type, 0, &size);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgRegistryOperationFailed("read", valueName, msgFunctionFailed("RegQueryValueEx1", rc));
return false;
}
BYTE *dataC = new BYTE[size + 1];
// Will be Utf16 in case of a string
rc = RegQueryValueEx(handle, valueName, 0, &type, dataC, &size);
if (rc != ERROR_SUCCESS) {
*errorMessage = msgRegistryOperationFailed("read", valueName, msgFunctionFailed("RegQueryValueEx2", rc));
return false;
}
*data = QByteArray(reinterpret_cast<const char*>(dataC), size);
delete [] dataC;
return true;
}
static bool registryReadStringKey(HKEY handle, // HKEY_LOCAL_MACHINE, etc.
const WCHAR *valueName,
QString *s,
QString *errorMessage)
{
QByteArray data;
if (!registryReadBinaryKey(handle, valueName, &data, errorMessage))
return false;
data += '\0';
data += '\0';
*s = QString::fromUtf16(reinterpret_cast<const unsigned short*>(data.data()));
return true;
}
static inline bool registryWriteBinaryKey(HKEY handle, static inline bool registryWriteBinaryKey(HKEY handle,
const WCHAR *valueName, const WCHAR *valueName,
DWORD type, DWORD type,
...@@ -457,29 +366,6 @@ bool chooseDebugger(QString *errorMessage) ...@@ -457,29 +366,6 @@ bool chooseDebugger(QString *errorMessage)
return true; return true;
} }
// Installation helpers: Format the debugger call with placeholders for PID and event
// '"[path]\qtcdebugger" [-wow] %ld %ld'.
static QString debuggerCall(const QString &additionalOption = QString())
{
QString rc;
QTextStream str(&rc);
str << '"' << QDir::toNativeSeparators(QApplication::applicationFilePath()) << '"';
if (!additionalOption.isEmpty())
str << ' ' << additionalOption;
str << " %ld %ld";
return rc;
}
static bool isRegistered(HKEY handle, const QString &call, QString *errorMessage, QString *oldDebugger = 0)
{
QString registeredDebugger;
registryReadStringKey(handle, debuggerRegistryValueNameC, &registeredDebugger, errorMessage);
if (oldDebugger)
*oldDebugger = registeredDebugger;
return !registeredDebugger.compare(call, Qt::CaseInsensitive);
}
// registration helper: Register ourselves in a debugger registry key. // registration helper: Register ourselves in a debugger registry key.
// Make a copy of the old value as "Debugger.Default" and have the // Make a copy of the old value as "Debugger.Default" and have the
// "Debug" key point to us. // "Debug" key point to us.
...@@ -499,7 +385,7 @@ static bool registerDebuggerKey(const WCHAR *key, ...@@ -499,7 +385,7 @@ static bool registerDebuggerKey(const WCHAR *key,
*errorMessage = QLatin1String("The program is already registered as post mortem debugger."); *errorMessage = QLatin1String("The program is already registered as post mortem debugger.");
break; break;
} }
if (!(oldDebugger.contains(QLatin1String(applicationFileC), Qt::CaseInsensitive) if (!(oldDebugger.contains(QLatin1String(debuggerApplicationFileC), Qt::CaseInsensitive)
|| registryWriteStringKey(handle, debuggerRegistryDefaultValueNameC, oldDebugger, errorMessage))) || registryWriteStringKey(handle, debuggerRegistryDefaultValueNameC, oldDebugger, errorMessage)))
break; break;
if (debug) if (debug)
......
include(../../shared/registryaccess/registryaccess.pri)
TARGET = qtcdebugger TARGET = qtcdebugger
TEMPLATE = app TEMPLATE = app
SOURCES += main.cpp SOURCES += main.cpp
LIBS *= -lpsapi
# PS API and registry functions
contains(QMAKE_CXX, cl) {
LIBS *= -ladvapi32
}
DESTDIR=..\..\..\bin DESTDIR=..\..\..\bin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment