debuggerrunner.cpp 16.1 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11 12 13 14
** 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.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "debuggerrunner.h"

32 33 34 35 36
#include "debuggeractions.h"
#include "debuggerconstants.h"
#include "debuggerengine.h"
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
37

hjk's avatar
hjk committed
38
#include <projectexplorer/debugginghelper.h>
con's avatar
con committed
39 40 41
#include <projectexplorer/environment.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
42
#include <projectexplorer/target.h>
43
#include <projectexplorer/buildconfiguration.h>
44
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*
con's avatar
con committed
45

hjk's avatar
hjk committed
46
#include <utils/qtcassert.h>
47
#include <coreplugin/icore.h>
hjk's avatar
hjk committed
48

con's avatar
con committed
49 50 51
#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
52
#include <QtCore/QTimer>
hjk's avatar
hjk committed
53

54
#include <QtGui/QAbstractItemView>
55
#include <QtGui/QTextDocument>
56
#include <QtGui/QTreeWidget>
con's avatar
con committed
57

58
using namespace ProjectExplorer;
59 60
using namespace Debugger::Internal;

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
namespace Debugger {
namespace Internal {

DebuggerEngine *createGdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createScriptEngine(const DebuggerStartParameters &);
DebuggerEngine *createPdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createTcfEngine(const DebuggerStartParameters &);
DebuggerEngine *createQmlEngine(const DebuggerStartParameters &);

#ifdef CDB_ENABLED
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &);
#else
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &) { return 0; }
#endif

// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

bool checkGdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
bool checkCdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);

}


static QString toolChainName(int toolChainType)
{
    return ToolChain::toolChainName(ToolChain::ToolChainType(toolChainType));
}

93

con's avatar
con committed
94 95
////////////////////////////////////////////////////////////////////////
//
96
// DebuggerRunControlFactory
con's avatar
con committed
97 98 99
//
////////////////////////////////////////////////////////////////////////

100 101 102 103 104 105 106
static QString msgEngineNotAvailable(const char *engine)
{
    return DebuggerPlugin::tr("The application requires the debugger engine '%1', "
        "which is disabled.").arg(QLatin1String(engine));
}

static DebuggerPlugin *plugin() { return DebuggerPlugin::instance(); }
107

108
// A factory to create DebuggerRunControls
109 110 111
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent,
        DebuggerEngineType enabledEngines)
    : IRunControlFactory(parent), m_enabledEngines(enabledEngines)
con's avatar
con committed
112 113
{}

114
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
con's avatar
con committed
115
{
116
//    return mode == ProjectExplorer::Constants::DEBUGMODE;
117
    return mode == ProjectExplorer::Constants::DEBUGMODE
118
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
con's avatar
con committed
119 120
}

121
QString DebuggerRunControlFactory::displayName() const
con's avatar
con committed
122
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
123
    return tr("Debug");
con's avatar
con committed
124 125
}

126
static DebuggerStartParameters localStartParameters(RunConfiguration *runConfiguration)
127
{
128
    DebuggerStartParameters sp;
129 130 131 132 133
    QTC_ASSERT(runConfiguration, return sp);
    LocalApplicationRunConfiguration *rc =
            qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
    QTC_ASSERT(rc, return sp);

134 135 136 137 138 139 140 141 142 143
    sp.startMode = StartInternal;
    sp.executable = rc->executable();
    sp.environment = rc->environment().toStringList();
    sp.workingDirectory = rc->workingDirectory();
    sp.processArgs = rc->commandLineArguments();
    sp.toolChainType = rc->toolChainType();
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();
    sp.displayName = rc->displayName();
144

145 146
    // Find qtInstallPath.
    QString qmakePath = DebuggingHelperLibrary::findSystemQt(rc->environment());
147 148 149 150 151 152 153 154 155
    if (!qmakePath.isEmpty()) {
        QProcess proc;
        QStringList args;
        args.append(QLatin1String("-query"));
        args.append(QLatin1String("QT_INSTALL_HEADERS"));
        proc.start(qmakePath, args);
        proc.waitForFinished();
        QByteArray ba = proc.readAllStandardOutput().trimmed();
        QFileInfo fi(QString::fromLocal8Bit(ba) + "/..");
156
        sp.qtInstallPath = fi.absoluteFilePath();
157 158
    }
    return sp;
159 160
}

161 162
RunControl *DebuggerRunControlFactory::create
    (RunConfiguration *runConfiguration, const QString &mode)
con's avatar
con committed
163
{
hjk's avatar
hjk committed
164
    QTC_ASSERT(mode == ProjectExplorer::Constants::DEBUGMODE, return 0);
165
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
166
    return create(sp);
167 168
}

169
RunControl *DebuggerRunControlFactory::create(const DebuggerStartParameters &sp)
170
{
171 172 173 174 175 176 177 178 179 180 181
    DebuggerRunControl *runControl = new DebuggerRunControl;
    runControl->setEnabledEngines(m_enabledEngines);
    runControl->createEngine(sp);
    if (!runControl->engine()) {
        qDebug() << "FAILED TO CREATE ENGINE";
        delete runControl;
        return 0;
    }
    connect(runControl, SIGNAL(started()), runControl, SLOT(handleStarted()));
    connect(runControl, SIGNAL(finished()), runControl, SLOT(handleFinished()));
    return runControl;
con's avatar
con committed
182 183
}

184
QWidget *DebuggerRunControlFactory::createConfigurationWidget(RunConfiguration *runConfiguration)
con's avatar
con committed
185 186
{
    // NBS TODO: Add GDB-specific configuration widget
187
    Q_UNUSED(runConfiguration)
con's avatar
con committed
188 189 190 191
    return 0;
}


192 193
////////////////////////////////////////////////////////////////////////
//
194
// DebuggerRunControl
195 196 197
//
////////////////////////////////////////////////////////////////////////

198 199
DebuggerRunControl::DebuggerRunControl(QObject *parent)
    : RunControl(0, ProjectExplorer::Constants::DEBUGMODE)
200
{
201
    Q_UNUSED(parent);
202
    m_running = false;
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
    m_engine = 0;
    m_enabledEngines = AllEngineTypes;
}

static DebuggerEngineType engineForToolChain(int toolChainType)
{
    switch (toolChainType) {
        case ProjectExplorer::ToolChain::LINUX_ICC:
        case ProjectExplorer::ToolChain::MinGW:
        case ProjectExplorer::ToolChain::GCC:
        case ProjectExplorer::ToolChain::WINSCW: // S60
        case ProjectExplorer::ToolChain::GCCE:
        case ProjectExplorer::ToolChain::RVCT_ARMV5:
        case ProjectExplorer::ToolChain::RVCT_ARMV6:
        case ProjectExplorer::ToolChain::RVCT_ARMV5_GNUPOC:
        case ProjectExplorer::ToolChain::GCCE_GNUPOC:
            return GdbEngineType;

        case ProjectExplorer::ToolChain::MSVC:
        case ProjectExplorer::ToolChain::WINCE:
            return CdbEngineType;

        case ProjectExplorer::ToolChain::OTHER:
        case ProjectExplorer::ToolChain::UNKNOWN:
        case ProjectExplorer::ToolChain::INVALID:
        default:
            break;
    }
    return NoEngineType;
232 233
}

234 235 236 237

// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
DebuggerEngineType DebuggerRunControl::engineForExecutable(const QString &executable)
238
{
239 240 241 242 243
    if (executable.endsWith(_("qmlviewer"))) {
        if (m_enabledEngines & QmlEngineType)
            return QmlEngineType;
        m_errorMessage = msgEngineNotAvailable("Qml Engine");
    }
244

245 246 247 248 249
    if (executable.endsWith(_(".js"))) {
        if (m_enabledEngines & ScriptEngineType)
            return ScriptEngineType;
        m_errorMessage = msgEngineNotAvailable("Script Engine");
    }
con's avatar
con committed
250

251 252 253 254 255
    if (executable.endsWith(_(".py"))) {
        if (m_enabledEngines & PdbEngineType)
            return PdbEngineType;
        m_errorMessage = msgEngineNotAvailable("Pdb Engine");
    }
con's avatar
con committed
256

257 258 259 260 261 262 263 264 265 266 267 268 269 270
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
        return GdbEngineType

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
    if (!getPDBFiles(executable, &pdbFiles, errorMessage)) {
        qWarning("Cannot determine type of executable %s: %s",
                 qPrintable(executable), qPrintable(m_errorMessage));
        return 0;
    }
    if (pdbFiles.empty())
        return GdbEngineType;
271

272 273 274 275 276 277 278 279 280
    // We need the CDB debugger in order to be able to debug VS
    // executables
    if (checkDebugConfiguration(ToolChain::MSVC, errorMessage, 0, &m_settingsIdHint))
        return CdbEngineType;
#else
    if (m_enabledEngines & GdbEngineType)
        return GdbEngineType;
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
#endif
281

282
    return NoEngineType;
283 284
}

285 286
// Debugger type for mode.
DebuggerEngineType DebuggerRunControl::engineForMode(DebuggerStartMode startMode)
287
{
288 289
    if (startMode == AttachTcf)
        return TcfEngineType;
290

291 292 293 294 295 296 297 298 299 300 301 302 303
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
    if (startMode != AttachToRemote && cdbEngine)
        return CdbEngineType;
    if (gdbEngine)
        return GdbEngineType;
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return NoEngineType;
#else
    Q_UNUSED(startMode)
    //  m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return GdbEngineType;
#endif
304 305
}

306
void DebuggerRunControl::setEnabledEngines(DebuggerEngineType enabledEngines)
307
{
308
    m_enabledEngines = enabledEngines;
309 310
}

311
void DebuggerRunControl::createEngine(const DebuggerStartParameters &sp)
312
{
313
    // Figure out engine according to toolchain, executable, attach or default.
con's avatar
con committed
314

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    DebuggerEngineType engineType = NoEngineType;
    QString errorMessage;
    QString settingsIdHint;

    if (sp.executable.endsWith(_("qmlviewer")))
        engineType = QmlEngineType;
    else if (sp.executable.endsWith(_(".js")))
        engineType = ScriptEngineType;
    else if (sp.executable.endsWith(_(".py")))
        engineType = PdbEngineType;
    else
        engineType = engineForToolChain(sp.toolChainType);

    if (engineType == NoEngineType
            && sp.startMode != AttachToRemote
            && !sp.executable.isEmpty())
        engineType = engineForExecutable(sp.executable);

    if (!engineType)
        engineType = engineForMode(sp.startMode);

    //qDebug() << "USING ENGINE : " << engineType;

    switch (engineType) {
        case GdbEngineType:
            m_engine = createGdbEngine(sp);
341
            break;
342 343
        case ScriptEngineType:
            m_engine = createScriptEngine(sp);
344
            break;
345 346
        case CdbEngineType:
            m_engine = createCdbEngine(sp);
347
            break;
348 349
        case PdbEngineType:
            m_engine = createPdbEngine(sp);
350
            break;
351 352
        case TcfEngineType:
            m_engine = createTcfEngine(sp);
353
            break;
354 355 356 357 358 359 360 361 362 363 364 365
        case QmlEngineType:
            m_engine = createQmlEngine(sp);
            break;
        default: {
            // Could not find anything suitable.
            emit debuggingFinished();
            // Create Message box with possibility to go to settings
            const QString msg = tr("Cannot debug '%1' (tool chain: '%2'): %3")
                .arg(sp.executable, toolChainName(sp.toolChainType), m_errorMessage);
            Core::ICore::instance()->showWarningWithOptions(tr("Warning"),
                msg, QString(), QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY),
                m_settingsIdHint);
366
            break;
367
        }
368
    }
369 370
}

371
DebuggerRunControl::~DebuggerRunControl()
372
{
373
    delete m_engine;
374 375
}

376
QString DebuggerRunControl::displayName() const
377
{
378 379
    QTC_ASSERT(m_engine, return QString());
    return m_engine->startParameters().displayName;
380 381
}

382
void DebuggerRunControl::setCustomEnvironment(ProjectExplorer::Environment env)
383
{
384
    m_engine->startParameters().environment = env.toStringList();
385 386
}

387
void DebuggerRunControl::init()
388 389 390
{
}

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
bool DebuggerRunControl::checkDebugConfiguration(int toolChain,
                                              QString *errorMessage,
                                              QString *settingsCategory /* = 0 */,
                                              QString *settingsPage /* = 0 */)
{
    errorMessage->clear();
    if (settingsCategory)
        settingsCategory->clear();
    if (settingsPage)
        settingsPage->clear();

    bool success = true;

    switch(toolChain) {
    case ProjectExplorer::ToolChain::GCC:
    case ProjectExplorer::ToolChain::LINUX_ICC:
    case ProjectExplorer::ToolChain::MinGW:
    case ProjectExplorer::ToolChain::WINCE: // S60
    case ProjectExplorer::ToolChain::WINSCW:
    case ProjectExplorer::ToolChain::GCCE:
    case ProjectExplorer::ToolChain::RVCT_ARMV5:
    case ProjectExplorer::ToolChain::RVCT_ARMV6:
        success = checkGdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success)
            *errorMessage = msgEngineNotAvailable("Gdb");
        break;
    case ProjectExplorer::ToolChain::MSVC:
        success = checkCdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success) {
            *errorMessage = msgEngineNotAvailable("Cdb");
            if (settingsPage)
                *settingsPage = QLatin1String("Cdb");
        }
        break;
    }
    if (!success && settingsCategory && settingsPage && !settingsPage->isEmpty())
        *settingsCategory = QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY);
hjk's avatar
hjk committed
428

429
    return success;
430 431
}

432
void DebuggerRunControl::start()
433
{
434 435
    QTC_ASSERT(m_engine, return);
    const DebuggerStartParameters &sp = m_engine->startParameters();
436

437 438 439 440
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
    QString settingsIdHint;
441

442 443 444 445 446 447
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
448
        return;
449
    }
450

451
    plugin()->activateDebugMode();
452

453 454 455
    showMessage(tr("Starting debugger for tool chain '%1'...")
        .arg(toolChainName(sp.toolChainType)), LogStatus);
    showMessage(DebuggerSettings::instance()->dump(), LogDebug);
456

457 458
    plugin()->setBusyCursor(false);
    engine()->startDebugger(this);
459 460
}

461
void DebuggerRunControl::startSuccessful()
462
{
463 464
    m_running = true;
    emit started();
465 466
}

467
void DebuggerRunControl::startFailed()
468
{
469 470
    m_running = false;
    emit finished();
471 472
}

473
void DebuggerRunControl::handleStarted()
474
{
475
    plugin()->runControlStarted(this);
476 477
}

478
void DebuggerRunControl::handleFinished()
479
{
480
    plugin()->runControlFinished(this);
481 482
}

483
void DebuggerRunControl::showMessage(const QString &msg, int channel)
484
{
485 486 487 488 489 490 491 492 493 494 495
    switch (channel) {
        case AppOutput:
            emit addToOutputWindowInline(this, msg, false);
            break;
        case AppError:
            emit addToOutputWindowInline(this, msg, true);
            break;
        case AppStuff:
            emit appendMessage(this, msg, true);
            break;
    }
496 497
}

498
void DebuggerRunControl::stop()
499
{
500 501 502
    m_running = false;
    QTC_ASSERT(m_engine, return);
    m_engine->exitDebugger();
503 504
}

505
void DebuggerRunControl::debuggingFinished()
506
{
507 508
    m_running = false;
    emit finished();
509 510
}

511
bool DebuggerRunControl::isRunning() const
512
{
513
    return m_running;
514 515
}

516
Internal::DebuggerEngine *DebuggerRunControl::engine()
517
{
518 519
    QTC_ASSERT(m_engine, /**/);
    return m_engine;
520 521 522
}


hjk's avatar
hjk committed
523
} // namespace Debugger