forked from qt-creator/qt-creator
Debugger: Move classes into their own files
Change-Id: I89853ffb4192b0da1f34d471e250d4ec32daa3da Reviewed-by: hjk <hjk121@nokiamail.com>
This commit is contained in:
Tobias Hunger
hjk
408
src/plugins/debugger/debuggeritemmanager.cpp
Normal file
408
src/plugins/debugger/debuggeritemmanager.cpp
Normal file
@@ -0,0 +1,408 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of Qt Creator.
|
||||
**
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and Digia. For licensing terms and
|
||||
** conditions see http://qt.digia.com/licensing. For further information
|
||||
** use the contact form at http://qt.digia.com/contact-us.
|
||||
**
|
||||
** 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.
|
||||
**
|
||||
** In addition, as a special exception, Digia gives you certain additional
|
||||
** rights. These rights are described in the Digia Qt LGPL Exception
|
||||
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#include "debuggeritemmanager.h"
|
||||
|
||||
#include "debuggeritemmodel.h"
|
||||
#include "debuggerkitinformation.h"
|
||||
|
||||
#include <coreplugin/icore.h>
|
||||
|
||||
#include <utils/environment.h>
|
||||
#include <utils/fileutils.h>
|
||||
#include <utils/persistentsettings.h>
|
||||
#include <utils/qtcassert.h>
|
||||
|
||||
#include <QDebug>
|
||||
#include <QDir>
|
||||
#include <QFileInfo>
|
||||
|
||||
using namespace ProjectExplorer;
|
||||
using namespace Utils;
|
||||
|
||||
namespace Debugger {
|
||||
|
||||
static const char DEBUGGER_COUNT_KEY[] = "DebuggerItem.Count";
|
||||
static const char DEBUGGER_DATA_KEY[] = "DebuggerItem.";
|
||||
static const char DEBUGGER_LEGACY_FILENAME[] = "/qtcreator/profiles.xml";
|
||||
static const char DEBUGGER_FILE_VERSION_KEY[] = "Version";
|
||||
static const char DEBUGGER_FILENAME[] = "/qtcreator/debuggers.xml";
|
||||
|
||||
// --------------------------------------------------------------------------
|
||||
// DebuggerItemManager
|
||||
// --------------------------------------------------------------------------
|
||||
|
||||
static DebuggerItemManager *m_instance = 0;
|
||||
|
||||
static FileName userSettingsFileName()
|
||||
{
|
||||
QFileInfo settingsLocation(Core::ICore::settings()->fileName());
|
||||
return FileName::fromString(settingsLocation.absolutePath() + QLatin1String(DEBUGGER_FILENAME));
|
||||
}
|
||||
|
||||
static void readDebuggers(const FileName &fileName, bool isSystem)
|
||||
{
|
||||
PersistentSettingsReader reader;
|
||||
if (!reader.load(fileName))
|
||||
return;
|
||||
QVariantMap data = reader.restoreValues();
|
||||
|
||||
// Check version
|
||||
int version = data.value(QLatin1String(DEBUGGER_FILE_VERSION_KEY), 0).toInt();
|
||||
if (version < 1)
|
||||
return;
|
||||
|
||||
int count = data.value(QLatin1String(DEBUGGER_COUNT_KEY), 0).toInt();
|
||||
for (int i = 0; i < count; ++i) {
|
||||
const QString key = QString::fromLatin1(DEBUGGER_DATA_KEY) + QString::number(i);
|
||||
if (!data.contains(key))
|
||||
continue;
|
||||
const QVariantMap dbMap = data.value(key).toMap();
|
||||
DebuggerItem item(dbMap);
|
||||
if (isSystem) {
|
||||
item.setAutoDetected(true);
|
||||
// SDK debuggers are always considered to be up-to-date, so no need to recheck them.
|
||||
} else {
|
||||
// User settings.
|
||||
if (item.isAutoDetected() && !item.isValid()) {
|
||||
qWarning() << QString::fromLatin1("DebuggerItem \"%1\" (%2) dropped since it is not valid")
|
||||
.arg(item.command().toString()).arg(item.id().toString());
|
||||
continue;
|
||||
}
|
||||
}
|
||||
DebuggerItemManager::registerDebugger(item);
|
||||
}
|
||||
}
|
||||
|
||||
QList<DebuggerItem> DebuggerItemManager::m_debuggers;
|
||||
Internal::DebuggerItemModel* DebuggerItemManager::m_model = 0;
|
||||
PersistentSettingsWriter * DebuggerItemManager::m_writer = 0;
|
||||
|
||||
DebuggerItemManager::DebuggerItemManager(QObject *parent)
|
||||
: QObject(parent)
|
||||
{
|
||||
m_instance = this;
|
||||
m_writer = new PersistentSettingsWriter(userSettingsFileName(), QLatin1String("QtCreatorDebugger"));
|
||||
m_model = new Debugger::Internal::DebuggerItemModel(this);
|
||||
connect(Core::ICore::instance(), SIGNAL(saveSettingsRequested()),
|
||||
this, SLOT(saveDebuggers()));
|
||||
}
|
||||
|
||||
QObject *DebuggerItemManager::instance()
|
||||
{
|
||||
return m_instance;
|
||||
}
|
||||
|
||||
DebuggerItemManager::~DebuggerItemManager()
|
||||
{
|
||||
disconnect(Core::ICore::instance(), SIGNAL(saveSettingsRequested()),
|
||||
this, SLOT(saveDebuggers()));
|
||||
delete m_writer;
|
||||
}
|
||||
|
||||
QList<DebuggerItem> DebuggerItemManager::debuggers()
|
||||
{
|
||||
return m_debuggers;
|
||||
}
|
||||
|
||||
Internal::DebuggerItemModel *DebuggerItemManager::model()
|
||||
{
|
||||
return m_model;
|
||||
}
|
||||
|
||||
void DebuggerItemManager::autoDetectCdbDebuggers()
|
||||
{
|
||||
QList<FileName> cdbs;
|
||||
|
||||
QStringList programDirs;
|
||||
programDirs.append(QString::fromLocal8Bit(qgetenv("ProgramFiles")));
|
||||
programDirs.append(QString::fromLocal8Bit(qgetenv("ProgramFiles(x86)")));
|
||||
programDirs.append(QString::fromLocal8Bit(qgetenv("ProgramW6432")));
|
||||
|
||||
foreach (const QString &dirName, programDirs) {
|
||||
if (dirName.isEmpty())
|
||||
continue;
|
||||
QDir dir(dirName);
|
||||
// Windows SDK's starting from version 8 live in
|
||||
// "ProgramDir\Windows Kits\<version>"
|
||||
const QString windowsKitsFolderName = QLatin1String("Windows Kits");
|
||||
if (dir.exists(windowsKitsFolderName)) {
|
||||
QDir windowKitsFolder = dir;
|
||||
if (windowKitsFolder.cd(windowsKitsFolderName)) {
|
||||
// Check in reverse order (latest first)
|
||||
const QFileInfoList kitFolders =
|
||||
windowKitsFolder.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot,
|
||||
QDir::Time | QDir::Reversed);
|
||||
foreach (const QFileInfo &kitFolderFi, kitFolders) {
|
||||
const QString path = kitFolderFi.absoluteFilePath();
|
||||
const QFileInfo cdb32(path + QLatin1String("/Debuggers/x86/cdb.exe"));
|
||||
if (cdb32.isExecutable())
|
||||
cdbs.append(FileName::fromString(cdb32.absoluteFilePath()));
|
||||
const QFileInfo cdb64(path + QLatin1String("/Debuggers/x64/cdb.exe"));
|
||||
if (cdb64.isExecutable())
|
||||
cdbs.append(FileName::fromString(cdb64.absoluteFilePath()));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Pre Windows SDK 8: Check 'Debugging Tools for Windows'
|
||||
foreach (const QFileInfo &fi, dir.entryInfoList(QStringList(QLatin1String("Debugging Tools for Windows*")),
|
||||
QDir::Dirs | QDir::NoDotAndDotDot)) {
|
||||
FileName filePath(fi);
|
||||
filePath.appendPath(QLatin1String("cdb.exe"));
|
||||
if (!cdbs.contains(filePath))
|
||||
cdbs.append(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
foreach (const FileName &cdb, cdbs) {
|
||||
if (findByCommand(cdb))
|
||||
continue;
|
||||
DebuggerItem item;
|
||||
item.setAutoDetected(true);
|
||||
item.setAbis(Abi::abisOfBinary(cdb));
|
||||
item.setCommand(cdb);
|
||||
item.setEngineType(CdbEngineType);
|
||||
item.setDisplayName(uniqueDisplayName(tr("Auto-detected CDB at %1").arg(cdb.toUserOutput())));
|
||||
addDebugger(item);
|
||||
}
|
||||
}
|
||||
|
||||
void DebuggerItemManager::autoDetectGdbOrLldbDebuggers()
|
||||
{
|
||||
QStringList filters;
|
||||
filters.append(QLatin1String("gdb-i686-pc-mingw32"));
|
||||
filters.append(QLatin1String("gdb"));
|
||||
filters.append(QLatin1String("lldb"));
|
||||
filters.append(QLatin1String("lldb-*"));
|
||||
|
||||
// DebuggerItem result;
|
||||
// result.setAutoDetected(true);
|
||||
// result.setDisplayName(tr("Auto-detected for Tool Chain %1").arg(tc->displayName()));
|
||||
/*
|
||||
// Check suggestions from the SDK.
|
||||
Environment env = Environment::systemEnvironment();
|
||||
if (tc) {
|
||||
tc->addToEnvironment(env); // Find MinGW gdb in toolchain environment.
|
||||
QString path = tc->suggestedDebugger().toString();
|
||||
if (!path.isEmpty()) {
|
||||
const QFileInfo fi(path);
|
||||
if (!fi.isAbsolute())
|
||||
path = env.searchInPath(path);
|
||||
result.command = FileName::fromString(path);
|
||||
result.engineType = engineTypeFromBinary(path);
|
||||
return maybeAddDebugger(result, false);
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
QFileInfoList suspects;
|
||||
|
||||
QStringList path = Environment::systemEnvironment().path();
|
||||
foreach (const QString &base, path) {
|
||||
QDir dir(base);
|
||||
dir.setNameFilters(filters);
|
||||
suspects += dir.entryInfoList();
|
||||
}
|
||||
|
||||
foreach (const QFileInfo &fi, suspects) {
|
||||
if (fi.exists()) {
|
||||
FileName command = FileName::fromString(fi.absoluteFilePath());
|
||||
if (findByCommand(command))
|
||||
continue;
|
||||
DebuggerItem item;
|
||||
item.setCommand(command);
|
||||
item.reinitializeFromFile();
|
||||
//: %1: Debugger engine type (GDB, LLDB, CDB...), %2: Path
|
||||
item.setDisplayName(tr("System %1 at %2")
|
||||
.arg(item.engineTypeName()).arg(QDir::toNativeSeparators(fi.absoluteFilePath())));
|
||||
item.setAutoDetected(true);
|
||||
addDebugger(item);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void DebuggerItemManager::readLegacyDebuggers()
|
||||
{
|
||||
QFileInfo settingsLocation(Core::ICore::settings()->fileName());
|
||||
FileName legacyKits = FileName::fromString(settingsLocation.absolutePath() + QLatin1String(DEBUGGER_LEGACY_FILENAME));
|
||||
|
||||
PersistentSettingsReader reader;
|
||||
if (!reader.load(legacyKits))
|
||||
return;
|
||||
|
||||
foreach (const QVariant &v, reader.restoreValues()) {
|
||||
QVariantMap data1 = v.toMap();
|
||||
QString kitName = data1.value(QLatin1String("PE.Profile.Name")).toString();
|
||||
QVariantMap data2 = data1.value(QLatin1String("PE.Profile.Data")).toMap();
|
||||
QVariant v3 = data2.value(DebuggerKitInformation::id().toString());
|
||||
QString fn;
|
||||
if (v3.type() == QVariant::String)
|
||||
fn = v3.toString();
|
||||
else
|
||||
fn = v3.toMap().value(QLatin1String("Binary")).toString();
|
||||
if (fn.isEmpty())
|
||||
continue;
|
||||
if (fn.startsWith(QLatin1Char('{')))
|
||||
continue;
|
||||
if (fn == QLatin1String("auto"))
|
||||
continue;
|
||||
FileName command = FileName::fromUserInput(fn);
|
||||
if (findByCommand(command))
|
||||
continue;
|
||||
DebuggerItem item;
|
||||
item.setCommand(command);
|
||||
item.setAutoDetected(true);
|
||||
item.reinitializeFromFile();
|
||||
item.setDisplayName(tr("Extracted from Kit %1").arg(kitName));
|
||||
addDebugger(item);
|
||||
}
|
||||
}
|
||||
|
||||
const DebuggerItem *DebuggerItemManager::findByCommand(const FileName &command)
|
||||
{
|
||||
foreach (const DebuggerItem &item, m_debuggers)
|
||||
if (item.command() == command)
|
||||
return &item;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
const DebuggerItem *DebuggerItemManager::findById(const QVariant &id)
|
||||
{
|
||||
foreach (const DebuggerItem &item, m_debuggers)
|
||||
if (item.id() == id)
|
||||
return &item;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
void DebuggerItemManager::restoreDebuggers()
|
||||
{
|
||||
// Read debuggers from SDK
|
||||
QFileInfo systemSettingsFile(Core::ICore::settings(QSettings::SystemScope)->fileName());
|
||||
readDebuggers(FileName::fromString(systemSettingsFile.absolutePath() + QLatin1String(DEBUGGER_FILENAME)), true);
|
||||
|
||||
// Read all debuggers from user file.
|
||||
readDebuggers(userSettingsFileName(), false);
|
||||
|
||||
// Auto detect current.
|
||||
autoDetectCdbDebuggers();
|
||||
autoDetectGdbOrLldbDebuggers();
|
||||
|
||||
// Add debuggers from pre-3.x profiles.xml
|
||||
readLegacyDebuggers();
|
||||
}
|
||||
|
||||
void DebuggerItemManager::saveDebuggers()
|
||||
{
|
||||
QTC_ASSERT(m_writer, return);
|
||||
QVariantMap data;
|
||||
data.insert(QLatin1String(DEBUGGER_FILE_VERSION_KEY), 1);
|
||||
|
||||
int count = 0;
|
||||
foreach (const DebuggerItem &item, m_debuggers) {
|
||||
if (item.isValid()) {
|
||||
QVariantMap tmp = item.toMap();
|
||||
if (tmp.isEmpty())
|
||||
continue;
|
||||
data.insert(QString::fromLatin1(DEBUGGER_DATA_KEY) + QString::number(count), tmp);
|
||||
++count;
|
||||
}
|
||||
}
|
||||
data.insert(QLatin1String(DEBUGGER_COUNT_KEY), count);
|
||||
m_writer->save(data, Core::ICore::mainWindow());
|
||||
|
||||
// Do not save default debuggers as they are set by the SDK.
|
||||
}
|
||||
|
||||
QVariant DebuggerItemManager::registerDebugger(const DebuggerItem &item)
|
||||
{
|
||||
if (findByCommand(item.command()))
|
||||
return item.id();
|
||||
|
||||
return addDebugger(item);
|
||||
}
|
||||
|
||||
void DebuggerItemManager::deregisterDebugger(const DebuggerItem &item)
|
||||
{
|
||||
if (findByCommand(item.command()))
|
||||
removeDebugger(item.id());
|
||||
}
|
||||
|
||||
QVariant DebuggerItemManager::addDebugger(const DebuggerItem &item)
|
||||
{
|
||||
QTC_ASSERT(!item.command().isEmpty(), return QVariant());
|
||||
QTC_ASSERT(!item.displayName().isEmpty(), return QVariant());
|
||||
QTC_ASSERT(item.engineType() != NoEngineType, return QVariant());
|
||||
QTC_ASSERT(item.id().isValid(), return QVariant());
|
||||
m_debuggers.append(item);
|
||||
m_model->addDebugger(item);
|
||||
return item.id();
|
||||
}
|
||||
|
||||
void DebuggerItemManager::removeDebugger(const QVariant &id)
|
||||
{
|
||||
bool ok = false;
|
||||
for (int i = 0, n = m_debuggers.size(); i != n; ++i) {
|
||||
if (m_debuggers.at(i).id() == id) {
|
||||
m_debuggers.removeAt(i);
|
||||
ok = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
QTC_ASSERT(ok, return);
|
||||
m_model->removeDebugger(id);
|
||||
}
|
||||
|
||||
QString DebuggerItemManager::uniqueDisplayName(const QString &base)
|
||||
{
|
||||
foreach (const DebuggerItem &item, m_debuggers)
|
||||
if (item.displayName() == base)
|
||||
return uniqueDisplayName(base + QLatin1String(" (1)"));
|
||||
|
||||
return base;
|
||||
}
|
||||
|
||||
void DebuggerItemManager::setItemData(const QVariant &id, const QString &displayName, const FileName &fileName)
|
||||
{
|
||||
for (int i = 0, n = m_debuggers.size(); i != n; ++i) {
|
||||
DebuggerItem &item = m_debuggers[i];
|
||||
if (item.id() == id) {
|
||||
item.setDisplayName(displayName);
|
||||
item.setCommand(fileName);
|
||||
item.reinitializeFromFile();
|
||||
emit m_model->updateDebugger(item.id());
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace Debugger;
|
||||
Reference in New Issue
Block a user