debuggerrunner.cpp 25.4 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
#include "debuggeractions.h"
#include "debuggerengine.h"
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
36
#include "debuggeruiswitcher.h"
37 38 39
#include "gdb/gdbengine.h"
#include "gdb/remotegdbserveradapter.h"
#include "gdb/remoteplaingdbadapter.h"
40
#include "qml/qmlengine.h"
41
#include "qml/qmlcppengine.h"
42

Friedemann Kleint's avatar
Friedemann Kleint committed
43 44 45 46
#ifdef Q_OS_WIN
#  include "peutils.h"
#endif

hjk's avatar
hjk committed
47
#include <projectexplorer/debugginghelper.h>
con's avatar
con committed
48
#include <projectexplorer/project.h>
49
#include <projectexplorer/toolchain.h>
con's avatar
con committed
50
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
51
#include <projectexplorer/target.h>
52
#include <projectexplorer/buildconfiguration.h>
53
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*
con's avatar
con committed
54

55
#include <utils/synchronousprocess.h>
hjk's avatar
hjk committed
56
#include <utils/qtcassert.h>
57
#include <utils/fancymainwindow.h>
58
#include <coreplugin/icore.h>
hjk's avatar
hjk committed
59

con's avatar
con committed
60
#include <QtCore/QDir>
61
#include <QtGui/QMessageBox>
con's avatar
con committed
62

63
using namespace ProjectExplorer;
64 65
using namespace Debugger::Internal;

66 67 68 69 70 71 72 73
namespace Debugger {
namespace Internal {

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

hjk's avatar
hjk committed
76
bool checkGdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
77 78 79 80 81 82 83

// 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.

hjk's avatar
hjk committed
84
#ifdef CDB_ENABLED
85
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &, QString *errorMessage);
86
bool checkCdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
87
bool isCdbEngineEnabled(); // Check the configuration page
hjk's avatar
hjk committed
88
#else
89
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &, QString *) { return 0; }
hjk's avatar
hjk committed
90 91
bool checkCdbConfiguration(int, QString *, QString *) { return false; }
#endif
92

hjk's avatar
hjk committed
93
} // namespace Internal
94 95 96

static QString toolChainName(int toolChainType)
{
97
    return ToolChain::toolChainName(ProjectExplorer::ToolChainType(toolChainType));
98 99
}

100

con's avatar
con committed
101 102
////////////////////////////////////////////////////////////////////////
//
103
// DebuggerRunControlFactory
con's avatar
con committed
104 105 106
//
////////////////////////////////////////////////////////////////////////

107 108 109 110 111 112 113
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(); }
114

115
// A factory to create DebuggerRunControls
116
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent,
117
        unsigned enabledEngines)
118
    : IRunControlFactory(parent), m_enabledEngines(enabledEngines)
con's avatar
con committed
119 120
{}

121
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
con's avatar
con committed
122
{
123
//    return mode == ProjectExplorer::Constants::DEBUGMODE;
124
    return mode == ProjectExplorer::Constants::DEBUGMODE
125
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
con's avatar
con committed
126 127
}

128
QString DebuggerRunControlFactory::displayName() const
con's avatar
con committed
129
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
130
    return tr("Debug");
con's avatar
con committed
131 132
}

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
// Find Qt installation by running qmake
static inline QString findQtInstallPath(const QString &qmakePath)
{
    QProcess proc;
    QStringList args;
    args.append(QLatin1String("-query"));
    args.append(QLatin1String("QT_INSTALL_HEADERS"));
    proc.start(qmakePath, args);
    if (!proc.waitForStarted()) {
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath),
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath));
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath));
        return QString();
    }
    const QByteArray ba = proc.readAllStandardOutput().trimmed();
    QDir dir(QString::fromLocal8Bit(ba));
    if (dir.exists() && dir.cdUp())
        return dir.absolutePath();
    return QString();
}

163
static DebuggerStartParameters localStartParameters(RunConfiguration *runConfiguration)
164
{
165
    DebuggerStartParameters sp;
166 167 168 169 170
    QTC_ASSERT(runConfiguration, return sp);
    LocalApplicationRunConfiguration *rc =
            qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
    QTC_ASSERT(rc, return sp);

171 172
    sp.startMode = StartInternal;
    sp.environment = rc->environment().toStringList();
173 174 175
    sp.workingDirectory = rc->workingDirectory();
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
176 177 178 179
    sp.toolChainType = rc->toolChainType();
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();
180

181 182
    DebuggerLanguages activeLangs = DebuggerUISwitcher::instance()->activeDebugLanguages();
    if (activeLangs & QmlLanguage) {
183
        sp.qmlServerAddress = QLatin1String("127.0.0.1");
184
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();
185

186 187 188 189
        sp.projectDir = runConfiguration->target()->project()->projectDirectory();
        if (runConfiguration->target()->activeBuildConfiguration())
            sp.projectBuildDir = runConfiguration->target()->activeBuildConfiguration()->buildDirectory();

190
        sp.processArgs.append(QLatin1String("-qmljsdebugger=port:") + QString::number(sp.qmlServerPort));
191 192
    }

193 194 195 196
    // FIXME: If it's not yet build this will be empty and not filled
    // when rebuild as the runConfiguration is not stored and therefore
    // cannot be used to retrieve the dumper location.
    //qDebug() << "DUMPER: " << sp.dumperLibrary << sp.dumperLibraryLocations;
197
    sp.displayName = rc->displayName();
198

199 200
    // Find qtInstallPath.
    QString qmakePath = DebuggingHelperLibrary::findSystemQt(rc->environment());
201 202
    if (!qmakePath.isEmpty())
        sp.qtInstallPath = findQtInstallPath(qmakePath);
203
    return sp;
204 205
}

206 207
RunControl *DebuggerRunControlFactory::create
    (RunConfiguration *runConfiguration, const QString &mode)
con's avatar
con committed
208
{
hjk's avatar
hjk committed
209
    QTC_ASSERT(mode == ProjectExplorer::Constants::DEBUGMODE, return 0);
210
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
211
    return create(sp, runConfiguration);
212 213
}

214 215
DebuggerRunControl *DebuggerRunControlFactory::create(
    const DebuggerStartParameters &sp,
216
    RunConfiguration *runConfiguration)
217
{
218 219
    DebuggerRunControl *runControl =
        new DebuggerRunControl(runConfiguration, m_enabledEngines, sp);
220 221 222 223 224 225
    if (!runControl->engine()) {
        qDebug() << "FAILED TO CREATE ENGINE";
        delete runControl;
        return 0;
    }
    return runControl;
con's avatar
con committed
226 227
}

228 229
QWidget *DebuggerRunControlFactory::createConfigurationWidget
    (RunConfiguration *runConfiguration)
con's avatar
con committed
230 231
{
    // NBS TODO: Add GDB-specific configuration widget
232
    Q_UNUSED(runConfiguration)
con's avatar
con committed
233 234 235 236
    return 0;
}


237 238
////////////////////////////////////////////////////////////////////////
//
239
// DebuggerRunControl
240 241 242
//
////////////////////////////////////////////////////////////////////////

243 244
struct DebuggerRunnerPrivate {
    explicit DebuggerRunnerPrivate(RunConfiguration *runConfiguration,
245 246 247
                                   unsigned enabledEngines);

    unsigned enabledEngines() const;
248 249 250 251

    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
252
    const unsigned m_cmdLineEnabledEngines;
253 254 255 256
    QString m_errorMessage;
    QString m_settingsIdHint;
};

257 258 259 260 261 262 263 264 265 266
unsigned DebuggerRunnerPrivate::enabledEngines() const
{
    unsigned rc = m_cmdLineEnabledEngines;
#ifdef CDB_ENABLED
    if (!Internal::isCdbEngineEnabled())
        rc &= ~CdbEngineType;
#endif
    return rc;
}

267
DebuggerRunnerPrivate::DebuggerRunnerPrivate(RunConfiguration *runConfiguration,
268
                                             unsigned enabledEngines) :
269 270
      m_engine(0)
    , m_myRunConfiguration(runConfiguration)
271
    , m_running(false)
272
    , m_cmdLineEnabledEngines(enabledEngines)
273 274
{
}
275

276
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
277
        unsigned enabledEngines, const DebuggerStartParameters &sp)
278 279
    : RunControl(runConfiguration, ProjectExplorer::Constants::DEBUGMODE),
      d(new DebuggerRunnerPrivate(runConfiguration, enabledEngines))
280
{
Friedemann Kleint's avatar
Friedemann Kleint committed
281
    connect(this, SIGNAL(finished()), this, SLOT(handleFinished()));
282 283
    DebuggerStartParameters startParams = sp;
    createEngine(startParams);
284 285
}

286 287 288
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
289 290 291 292 293
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
294 295
}

296 297
const DebuggerStartParameters &DebuggerRunControl::startParameters() const
{
298 299
    QTC_ASSERT(d->m_engine, return *(new DebuggerStartParameters()));
    return d->m_engine->startParameters();
300 301
}

302 303 304
static DebuggerEngineType engineForToolChain(int toolChainType)
{
    switch (toolChainType) {
305 306 307 308 309 310 311 312 313 314
        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:
        case ProjectExplorer::ToolChain_GCC_MAEMO:
315 316
            return GdbEngineType;

317 318
        case ProjectExplorer::ToolChain_MSVC:
        case ProjectExplorer::ToolChain_WINCE:
319 320
            return CdbEngineType;

321 322 323
        case ProjectExplorer::ToolChain_OTHER:
        case ProjectExplorer::ToolChain_UNKNOWN:
        case ProjectExplorer::ToolChain_INVALID:
324 325 326 327
        default:
            break;
    }
    return NoEngineType;
328 329
}

330 331 332

// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
333
DebuggerEngineType DebuggerRunControl::engineForExecutable(unsigned enabledEngineTypes, const QString &executable)
334
{
335
    /*if (executable.endsWith(_("qmlviewer"))) {
336
        if (enabledEngineTypes & QmlEngineType)
337
            return QmlEngineType;
338
        d->m_errorMessage = msgEngineNotAvailable("Qml Engine");
339
    }*/
340

341
    if (executable.endsWith(_(".js"))) {
342
        if (enabledEngineTypes & ScriptEngineType)
343
            return ScriptEngineType;
344
        d->m_errorMessage = msgEngineNotAvailable("Script Engine");
345
    }
con's avatar
con committed
346

347
    if (executable.endsWith(_(".py"))) {
348
        if (enabledEngineTypes & PdbEngineType)
349
            return PdbEngineType;
350
        d->m_errorMessage = msgEngineNotAvailable("Pdb Engine");
351
    }
con's avatar
con committed
352

353 354 355
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
Friedemann Kleint's avatar
Friedemann Kleint committed
356
        return GdbEngineType;
357 358 359

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
360
    if (!getPDBFiles(executable, &pdbFiles, &d->m_errorMessage)) {
361
        qWarning("Cannot determine type of executable %s: %s",
362
                 qPrintable(executable), qPrintable(d->m_errorMessage));
Friedemann Kleint's avatar
Friedemann Kleint committed
363
        return NoEngineType;
364 365 366
    }
    if (pdbFiles.empty())
        return GdbEngineType;
367

368 369
    // We need the CDB debugger in order to be able to debug VS
    // executables
370
    if (checkDebugConfiguration(ProjectExplorer::ToolChain_MSVC, &d->m_errorMessage, 0, &d->m_settingsIdHint)) {
371 372 373 374 375
        if (enabledEngineTypes & CdbEngineType)
            return CdbEngineType;
        d->m_errorMessage = msgEngineNotAvailable("Cdb Engine");
        return NoEngineType;
    }
376
#else
377
    if (enabledEngineTypes & GdbEngineType)
378
        return GdbEngineType;
379
    d->m_errorMessage = msgEngineNotAvailable("Gdb Engine");
380
#endif
381

382
    return NoEngineType;
383 384
}

385
// Debugger type for mode.
386
DebuggerEngineType DebuggerRunControl::engineForMode(unsigned enabledEngineTypes, DebuggerStartMode startMode)
387
{
388 389
    if (startMode == AttachTcf)
        return TcfEngineType;
390

391 392
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
393
    if (startMode != AttachToRemote && (enabledEngineTypes & CdbEngineType))
394
        return CdbEngineType;
395 396 397 398
    if (startMode == AttachCrashedExternal) {
        d->m_errorMessage = tr("There is no debugging engine available for post-mortem debugging.");
        return NoEngineType;
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
399
    return GdbEngineType;
400 401
#else
    Q_UNUSED(startMode)
402
    Q_UNUSED(enabledEngineTypes)
403
    //  d->m_errorMessage = msgEngineNotAvailable("Gdb Engine");
404 405
    return GdbEngineType;
#endif
406 407
}

408
void DebuggerRunControl::createEngine(const DebuggerStartParameters &startParams)
409
{
410 411
    DebuggerStartParameters sp = startParams;

412 413
    // Figure out engine according to toolchain, executable, attach or default.
    DebuggerEngineType engineType = NoEngineType;
414
    DebuggerLanguages activeLangs = DebuggerPlugin::instance()->activeLanguages();
415
    const unsigned enabledEngineTypes = d->enabledEngines();
416
    if (sp.executable.endsWith(_(".js")))
417 418 419
        engineType = ScriptEngineType;
    else if (sp.executable.endsWith(_(".py")))
        engineType = PdbEngineType;
420
    else {
421
        engineType = engineForToolChain(sp.toolChainType);
422 423 424 425 426
        if (engineType == CdbEngineType && !(enabledEngineTypes & CdbEngineType)) {
            d->m_errorMessage = msgEngineNotAvailable("Cdb Engine");
            engineType = NoEngineType;
        }
    }
427

428 429 430 431
    // Fixme: 1 of 3 testing hacks.
    if (sp.processArgs.size() >= 5 && sp.processArgs.at(0) == _("@tcf@"))
        engineType = GdbEngineType;

432 433 434
    if (engineType == NoEngineType
            && sp.startMode != AttachToRemote
            && !sp.executable.isEmpty())
435
        engineType = engineForExecutable(enabledEngineTypes, sp.executable);
436

437
    if (engineType == NoEngineType)
438
        engineType = engineForMode(enabledEngineTypes, sp.startMode);
439

440 441
    if ((engineType != QmlEngineType && engineType != NoEngineType)
        && (activeLangs & QmlLanguage)) {
442
        if (activeLangs & CppLanguage) {
443 444 445 446 447 448 449
            sp.cppEngineType = engineType;
            engineType = QmlCppEngineType;
        } else {
            engineType = QmlEngineType;
        }
    }

Friedemann Kleint's avatar
Friedemann Kleint committed
450
    // qDebug() << "USING ENGINE : " << engineType;
451 452 453

    switch (engineType) {
        case GdbEngineType:
454 455
            d->m_engine = createGdbEngine(sp);
            initGdbEngine(qobject_cast<Internal::GdbEngine *>(d->m_engine));
456
            break;
457
        case ScriptEngineType:
458
            d->m_engine = Internal::createScriptEngine(sp);
459
            break;
460
        case CdbEngineType:
461
            d->m_engine = Internal::createCdbEngine(sp, &d->m_errorMessage);
462
            break;
463
        case PdbEngineType:
464
            d->m_engine = Internal::createPdbEngine(sp);
465
            break;
466
        case TcfEngineType:
467
            d->m_engine = Internal::createTcfEngine(sp);
468
            break;
469
        case QmlEngineType:
470
            d->m_engine = Internal::createQmlEngine(sp);
471 472 473
            connect(qobject_cast<QmlEngine *>(d->m_engine),
                SIGNAL(remoteStartupRequested()), this,
                SIGNAL(engineRequestSetup()));
474
            break;
475
        case QmlCppEngineType:
476
            d->m_engine = Internal::createQmlCppEngine(sp);
477 478
            if (Internal::GdbEngine *embeddedGdbEngine = gdbEngine())
                initGdbEngine(embeddedGdbEngine);
479
            break;
480 481
       case NoEngineType:
       case AllEngineTypes:
482
            break;
483 484 485 486 487 488 489 490 491 492 493
    }

    if (!d->m_engine) {
        // Could not find anything suitable.
        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), d->m_errorMessage);
        Core::ICore::instance()->showWarningWithOptions(tr("Warning"),
                                                        msg, QString(), QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY),
                                                        d->m_settingsIdHint);
494
    }
495 496
}

497 498 499 500 501 502 503 504
void DebuggerRunControl::initGdbEngine(Internal::GdbEngine *engine)
{
    QTC_ASSERT(engine, return)

    // Forward adapter signals.
    Internal::AbstractGdbAdapter *adapter = engine->gdbAdapter();
    if (RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter)) {
        connect(rpga, SIGNAL(requestSetup()), this,
505
                SIGNAL(engineRequestSetup()));
506 507
    } else if (RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter)) {
        connect(rgsa, SIGNAL(requestSetup()),
508
                this, SIGNAL(engineRequestSetup()));
509 510 511
    }
}

512
QString DebuggerRunControl::displayName() const
513
{
514 515
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
516 517
}

518
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
519
{
520
    d->m_engine->startParameters().environment = env.toStringList();
521 522
}

523 524 525 526 527 528 529 530 531 532 533 534 535
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;

536 537 538
    if (!(DebuggerPlugin::instance()->activeLanguages() & CppLanguage))
        return success;

539
    switch(toolChain) {
540 541 542 543 544 545 546 547
    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:
548 549
        success = checkGdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success)
550
            *errorMessage += msgEngineNotAvailable("Gdb");
551
        break;
552
    case ProjectExplorer::ToolChain_MSVC:
553 554
        success = checkCdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success) {
555
            *errorMessage += msgEngineNotAvailable("Cdb");
556 557 558 559 560 561 562
            if (settingsPage)
                *settingsPage = QLatin1String("Cdb");
        }
        break;
    }
    if (!success && settingsCategory && settingsPage && !settingsPage->isEmpty())
        *settingsCategory = QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY);
hjk's avatar
hjk committed
563

564
    return success;
565 566
}

567
void DebuggerRunControl::start()
568
{
569 570
    QTC_ASSERT(d->m_engine, return);
    const DebuggerStartParameters &sp = d->m_engine->startParameters();
571

572 573 574
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
575

576 577 578 579 580 581
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
582
        return;
583
    }
584

585
    plugin()->activateDebugMode();
586
    DebuggerUISwitcher::instance()->aboutToStartDebugger();
Friedemann Kleint's avatar
Friedemann Kleint committed
587 588

    const QString message = tr("Starting debugger '%1' for tool chain '%2'...").
589
                  arg(d->m_engine->objectName(), toolChainName(sp.toolChainType));
Friedemann Kleint's avatar
Friedemann Kleint committed
590
    plugin()->showMessage(message, StatusBar);
591
    plugin()->showMessage(DebuggerSettings::instance()->dump(), LogDebug);
Friedemann Kleint's avatar
Friedemann Kleint committed
592
    plugin()->runControlStarted(this);
593

594 595
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
596
    emit started();
597 598 599 600 601 602 603 604
    d->m_running = true;

    engine()->startDebugger(this);

    if (d->m_running) {
        emit addToOutputWindowInline(this, tr("Debugging starts"), false);
        emit addToOutputWindowInline(this, "\n", false);
    }
605 606
}

607
void DebuggerRunControl::startFailed()
608
{
609
    emit addToOutputWindowInline(this, tr("Debugging has failed"), false);
610
    d->m_running = false;
611
    emit finished();
612
    engine()->handleStartFailed();
613 614
}

615
void DebuggerRunControl::handleFinished()
616
{
617
    emit addToOutputWindowInline(this, tr("Debugging has finished"), false);
618 619
    if (engine())
        engine()->handleFinished();
620
    plugin()->runControlFinished(this);
621 622
}

623
void DebuggerRunControl::showMessage(const QString &msg, int channel)
624
{
625 626 627 628 629 630 631 632 633 634 635
    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;
    }
636 637
}

638
bool DebuggerRunControl::aboutToStop() const
639
{
640 641
    QTC_ASSERT(isRunning(), return true;)

Jarek Kobus's avatar
Jarek Kobus committed
642
    const QString question = tr("A debugging session is still in progress. "
643 644 645 646 647 648 649 650 651 652 653 654 655
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");

    const QMessageBox::StandardButton answer =
            QMessageBox::question(DebuggerUISwitcher::instance()->mainWindow(),
                                  tr("Close Debugging Session"), question,
                                  QMessageBox::Yes|QMessageBox::No);
    return answer == QMessageBox::Yes;
}

RunControl::StopResult DebuggerRunControl::stop()
{
656 657
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
658
    return AsynchronousStop;
659 660
}

661
void DebuggerRunControl::debuggingFinished()
662
{
663
    d->m_running = false;
664
    emit finished();
665 666
}

667
bool DebuggerRunControl::isRunning() const
668
{
669
    return d->m_running;
670 671
}

Friedemann Kleint's avatar
Friedemann Kleint committed
672 673
DebuggerState DebuggerRunControl::state() const
{
674 675
    QTC_ASSERT(d->m_engine, return DebuggerNotReady);
    return d->m_engine->state();
Friedemann Kleint's avatar
Friedemann Kleint committed
676 677
}

678
DebuggerEngine *DebuggerRunControl::engine()
679
{
680 681
    QTC_ASSERT(d->m_engine, /**/);
    return d->m_engine;
682 683
}

684 685
Internal::GdbEngine *DebuggerRunControl::gdbEngine() const
{
686 687
    QTC_ASSERT(d->m_engine, return 0);
    if (GdbEngine *gdbEngine = qobject_cast<GdbEngine *>(d->m_engine))
688
        return gdbEngine;
689
    if (QmlCppEngine * const qmlEngine = qobject_cast<QmlCppEngine *>(d->m_engine))
690
        if (Internal::GdbEngine *embeddedGdbEngine = qobject_cast<GdbEngine *>(qmlEngine->cppEngine()))
691 692 693 694 695 696 697 698 699 700 701
            return embeddedGdbEngine;
    return 0;
}

Internal::AbstractGdbAdapter *DebuggerRunControl::gdbAdapter() const
{
    GdbEngine *engine = gdbEngine();
    QTC_ASSERT(engine, return 0)
    return engine->gdbAdapter();
}

702
void DebuggerRunControl::handleRemoteSetupDone(int gdbServerPort, int qmlPort)
703
{
704
    if (QmlEngine *qmlEngine = qobject_cast<QmlEngine *>(d->m_engine)) {
705
        qmlEngine->handleRemoteSetupDone(qmlPort);
706 707
    } else if (Internal::AbstractGdbAdapter *adapter = gdbAdapter()) {
        if (RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter)) {
708
            rpga->handleSetupDone(qmlPort);
709
        } else if (RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter)) {
710
            rgsa->handleSetupDone(gdbServerPort, qmlPort);
711 712 713
        } else {
            QTC_ASSERT(false, /* */ );
        }
714 715 716 717 718
    } else {
        QTC_ASSERT(false, /* */ );
    }
}

719
void DebuggerRunControl::handleRemoteSetupFailed(const QString &message)
720
{
721 722 723 724 725 726 727 728 729 730
    if (QmlEngine *qmlEngine = qobject_cast<QmlEngine *>(d->m_engine)) {
        qmlEngine->handleRemoteSetupFailed(message);
    } else if (Internal::AbstractGdbAdapter *adapter = gdbAdapter()) {
        if (RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter)) {
            rpga->handleSetupFailed(message);
        } else if (RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter)) {
            rgsa->handleSetupFailed(message);
        } else {
            QTC_ASSERT(false, /* */ );
        }
731 732 733 734
    } else {
        QTC_ASSERT(false, /* */ );
    }
}
735 736 737 738 739 740 741 742 743 744

void DebuggerRunControl::emitAddToOutputWindow(const QString &line, bool onStdErr)
{
    emit addToOutputWindow(this, line, onStdErr);
}

void DebuggerRunControl::emitAppendMessage(const QString &m, bool isError)
{
    emit appendMessage(this, m, isError);
}
745 746 747 748 749

RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
hjk's avatar
hjk committed
750
} // namespace Debugger