debuggerrunner.cpp 26.2 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
#include "debuggeractions.h"
33
#include "debuggercore.h"
34 35 36
#include "debuggerengine.h"
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
37
#include "debuggeruiswitcher.h"
38 39 40
#include "gdb/gdbengine.h"
#include "gdb/remotegdbserveradapter.h"
#include "gdb/remoteplaingdbadapter.h"
hjk's avatar
hjk committed
41
#include "gdb/gdboptionspage.h"
42
#include "qml/qmlengine.h"
43
#include "qml/qmlcppengine.h"
44
#include "lldb/lldbenginehost.h"
45

Friedemann Kleint's avatar
Friedemann Kleint committed
46 47 48 49
#ifdef Q_OS_WIN
#  include "peutils.h"
#endif

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

58
#include <utils/synchronousprocess.h>
hjk's avatar
hjk committed
59
#include <utils/qtcassert.h>
60
#include <utils/fancymainwindow.h>
61
#include <coreplugin/icore.h>
hjk's avatar
hjk committed
62

con's avatar
con committed
63
#include <QtCore/QDir>
64
#include <QtGui/QMessageBox>
con's avatar
con committed
65

66
using namespace ProjectExplorer;
67 68
using namespace Debugger::Internal;

69 70 71 72 73 74 75 76
namespace Debugger {
namespace Internal {

DebuggerEngine *createGdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createScriptEngine(const DebuggerStartParameters &);
DebuggerEngine *createPdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createTcfEngine(const DebuggerStartParameters &);
DebuggerEngine *createQmlEngine(const DebuggerStartParameters &);
77
DebuggerEngine *createQmlCppEngine(const DebuggerStartParameters &);
hjk's avatar
hjk committed
78
DebuggerEngine *createLldbEngine(const DebuggerStartParameters &);
79

hjk's avatar
hjk committed
80
extern QString msgNoBinaryForToolChain(int tc);
81 82 83 84 85 86 87

// 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
88
#ifdef CDB_ENABLED
hjk's avatar
hjk committed
89 90

DebuggerEngine *createCdbEngine(const DebuggerStartParameters &, QString *error);
91
bool checkCdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
92
bool isCdbEngineEnabled(); // Check the configuration page
hjk's avatar
hjk committed
93

hjk's avatar
hjk committed
94
#else
hjk's avatar
hjk committed
95 96 97 98 99 100 101 102 103 104 105

DebuggerEngine *createCdbEngine(const DebuggerStartParameters &, QString *)
{
    return 0;
}

bool checkCdbConfiguration(int, QString *, QString *)
{
    return false;
}

hjk's avatar
hjk committed
106
#endif
107

hjk's avatar
hjk committed
108
} // namespace Internal
hjk's avatar
hjk committed
109 110


111
namespace Cdb {
hjk's avatar
hjk committed
112
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &, QString *error);
113 114
bool isCdbEngineEnabled(); // Check the configuration page
}
115 116 117

static QString toolChainName(int toolChainType)
{
118
    return ToolChain::toolChainName(ProjectExplorer::ToolChainType(toolChainType));
119 120
}

121

con's avatar
con committed
122 123
////////////////////////////////////////////////////////////////////////
//
124
// DebuggerRunControlFactory
con's avatar
con committed
125 126 127
//
////////////////////////////////////////////////////////////////////////

128 129 130 131 132 133
static QString msgEngineNotAvailable(const char *engine)
{
    return DebuggerPlugin::tr("The application requires the debugger engine '%1', "
        "which is disabled.").arg(QLatin1String(engine));
}

134
// A factory to create DebuggerRunControls
135
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent,
136
        unsigned enabledEngines)
137
    : IRunControlFactory(parent), m_enabledEngines(enabledEngines)
con's avatar
con committed
138 139
{}

140
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
con's avatar
con committed
141
{
142
//    return mode == ProjectExplorer::Constants::DEBUGMODE;
143
    return mode == Constants::DEBUGMODE
144
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
con's avatar
con committed
145 146
}

147
QString DebuggerRunControlFactory::displayName() const
con's avatar
con committed
148
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
149
    return tr("Debug");
con's avatar
con committed
150 151
}

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
// 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();
}

182
static DebuggerStartParameters localStartParameters(RunConfiguration *runConfiguration)
183
{
184
    DebuggerStartParameters sp;
185 186 187 188 189
    QTC_ASSERT(runConfiguration, return sp);
    LocalApplicationRunConfiguration *rc =
            qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
    QTC_ASSERT(rc, return sp);

190
    sp.startMode = StartInternal;
191
    sp.environment = rc->environment();
192 193 194
    sp.workingDirectory = rc->workingDirectory();
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
195 196 197 198
    sp.toolChainType = rc->toolChainType();
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();
199

200
    if (debuggerCore()->isActiveDebugLanguage(QmlLanguage)) {
201
        sp.qmlServerAddress = QLatin1String("127.0.0.1");
202
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();
203

204 205
        sp.projectDir = runConfiguration->target()->project()->projectDirectory();
        if (runConfiguration->target()->activeBuildConfiguration())
206 207
            sp.projectBuildDir = runConfiguration->target()
                ->activeBuildConfiguration()->buildDirectory();
208

209 210
        sp.processArgs.append(QLatin1String("-qmljsdebugger=port:")
            + QString::number(sp.qmlServerPort));
211 212
    }

213 214 215 216
    // 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;
217
    sp.displayName = rc->displayName();
218

219 220
    // Find qtInstallPath.
    QString qmakePath = DebuggingHelperLibrary::findSystemQt(rc->environment());
221 222
    if (!qmakePath.isEmpty())
        sp.qtInstallPath = findQtInstallPath(qmakePath);
223
    return sp;
224 225
}

226 227
RunControl *DebuggerRunControlFactory::create
    (RunConfiguration *runConfiguration, const QString &mode)
con's avatar
con committed
228
{
229
    QTC_ASSERT(mode == Constants::DEBUGMODE, return 0);
230
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
231
    return create(sp, runConfiguration);
232 233
}

hjk's avatar
hjk committed
234 235
DebuggerRunControl *DebuggerRunControlFactory::create
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
236
{
237 238
    DebuggerRunControl *runControl =
        new DebuggerRunControl(runConfiguration, m_enabledEngines, sp);
hjk's avatar
hjk committed
239 240 241 242 243
    if (runControl->engine())
        return runControl;
    qDebug() << "FAILED TO CREATE ENGINE";
    delete runControl;
    return 0;
con's avatar
con committed
244 245
}

246 247
QWidget *DebuggerRunControlFactory::createConfigurationWidget
    (RunConfiguration *runConfiguration)
con's avatar
con committed
248 249
{
    // NBS TODO: Add GDB-specific configuration widget
250
    Q_UNUSED(runConfiguration)
con's avatar
con committed
251 252 253 254
    return 0;
}


255 256
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
257
// DebuggerRunControlPrivate
258 259 260
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
261 262 263 264 265
class DebuggerRunControlPrivate
{
public:
    DebuggerRunControlPrivate(DebuggerRunControl *parent,
        RunConfiguration *runConfiguration, unsigned enabledEngines);
266
    unsigned enabledEngines() const;
267

hjk's avatar
hjk committed
268 269 270 271 272 273 274 275 276 277 278
    DebuggerEngineType engineForExecutable(unsigned enabledEngineTypes,
        const QString &executable);
    DebuggerEngineType engineForMode(unsigned enabledEngineTypes,
        DebuggerStartMode mode);

    void initGdbEngine(GdbEngine *engine);
    GdbEngine *gdbEngine() const;
    AbstractGdbAdapter *gdbAdapter() const;

public:
    DebuggerRunControl *q;
279 280 281
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
282
    const unsigned m_cmdLineEnabledEngines;
283 284 285 286
    QString m_errorMessage;
    QString m_settingsIdHint;
};

hjk's avatar
hjk committed
287
unsigned DebuggerRunControlPrivate::enabledEngines() const
288 289 290
{
    unsigned rc = m_cmdLineEnabledEngines;
#ifdef CDB_ENABLED
hjk's avatar
hjk committed
291
    if (!isCdbEngineEnabled() && !Cdb::isCdbEngineEnabled())
292 293 294 295 296
        rc &= ~CdbEngineType;
#endif
    return rc;
}

hjk's avatar
hjk committed
297 298 299 300
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
        RunConfiguration *runConfiguration, unsigned enabledEngines)
    : q(parent)
    , m_engine(0)
301
    , m_myRunConfiguration(runConfiguration)
302
    , m_running(false)
303
    , m_cmdLineEnabledEngines(enabledEngines)
304 305
{
}
306

307 308
// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
hjk's avatar
hjk committed
309 310
DebuggerEngineType DebuggerRunControlPrivate::engineForExecutable
    (unsigned enabledEngineTypes, const QString &executable)
311
{
312
    /*if (executable.endsWith(_("qmlviewer"))) {
313
        if (enabledEngineTypes & QmlEngineType)
314
            return QmlEngineType;
315
        d->m_errorMessage = msgEngineNotAvailable("Qml Engine");
316
    }*/
317

318
    if (executable.endsWith(_(".js"))) {
319
        if (enabledEngineTypes & ScriptEngineType)
320
            return ScriptEngineType;
hjk's avatar
hjk committed
321
        m_errorMessage = msgEngineNotAvailable("Script Engine");
322
    }
con's avatar
con committed
323

324
    if (executable.endsWith(_(".py"))) {
325
        if (enabledEngineTypes & PdbEngineType)
326
            return PdbEngineType;
hjk's avatar
hjk committed
327
        m_errorMessage = msgEngineNotAvailable("Pdb Engine");
328
    }
con's avatar
con committed
329

330 331 332
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
Friedemann Kleint's avatar
Friedemann Kleint committed
333
        return GdbEngineType;
334 335 336

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
hjk's avatar
hjk committed
337
    if (!getPDBFiles(executable, &pdbFiles, &m_errorMessage)) {
338
        qWarning("Cannot determine type of executable %s: %s",
hjk's avatar
hjk committed
339
                 qPrintable(executable), qPrintable(m_errorMessage));
Friedemann Kleint's avatar
Friedemann Kleint committed
340
        return NoEngineType;
341 342 343
    }
    if (pdbFiles.empty())
        return GdbEngineType;
344

345
    // We need the CDB debugger in order to be able to debug VS
hjk's avatar
hjk committed
346 347 348
    // executables.
    if (d->checkDebugConfiguration(ProjectExplorer::ToolChain_MSVC,
            &m_errorMessage, 0, &m_settingsIdHint)) {
349 350
        if (enabledEngineTypes & CdbEngineType)
            return CdbEngineType;
hjk's avatar
hjk committed
351
        m_errorMessage = msgEngineNotAvailable("Cdb Engine");
352 353
        return NoEngineType;
    }
354
#else
355
    if (enabledEngineTypes & GdbEngineType)
356
        return GdbEngineType;
hjk's avatar
hjk committed
357
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
358
#endif
359

360
    return NoEngineType;
361 362
}

363
// Debugger type for mode.
hjk's avatar
hjk committed
364 365
DebuggerEngineType DebuggerRunControlPrivate::engineForMode
    (unsigned enabledEngineTypes, DebuggerStartMode startMode)
366
{
367 368
    if (startMode == AttachTcf)
        return TcfEngineType;
369

370 371
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
372
    if (startMode != AttachToRemote && (enabledEngineTypes & CdbEngineType))
373
        return CdbEngineType;
374
    if (startMode == AttachCrashedExternal) {
hjk's avatar
hjk committed
375
        m_errorMessage = tr("There is no debugging engine available for post-mortem debugging.");
376 377
        return NoEngineType;
    }
Friedemann Kleint's avatar
Friedemann Kleint committed
378
    return GdbEngineType;
379 380
#else
    Q_UNUSED(startMode)
381
    Q_UNUSED(enabledEngineTypes)
hjk's avatar
hjk committed
382
    //  >m_errorMessage = msgEngineNotAvailable("Gdb Engine");
383 384
    return GdbEngineType;
#endif
385 386
}

hjk's avatar
hjk committed
387 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 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
void DebuggerRunControlPrivate::initGdbEngine(GdbEngine *engine)
{
    QTC_ASSERT(engine, return)

    // Forward adapter signals.
    AbstractGdbAdapter *adapter = engine->gdbAdapter();
    RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter);
    RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter);
    if (rpga)
        q->connect(rpga, SIGNAL(requestSetup()), SIGNAL(engineRequestSetup()));
    else if (rgsa)
        q->connect(rgsa, SIGNAL(requestSetup()), SIGNAL(engineRequestSetup()));
}

GdbEngine *DebuggerRunControlPrivate::gdbEngine() const
{
    QTC_ASSERT(m_engine, return 0);
    if (GdbEngine *gdbEngine = qobject_cast<GdbEngine *>(m_engine))
        return gdbEngine;
    if (QmlCppEngine *qmlEngine = qobject_cast<QmlCppEngine *>(m_engine))
        if (GdbEngine *embeddedGdbEngine = qobject_cast<GdbEngine *>(qmlEngine->cppEngine()))
            return embeddedGdbEngine;
    return 0;
}

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

////////////////////////////////////////////////////////////////////////
//
// DebuggerRunControl
//
////////////////////////////////////////////////////////////////////////

DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
        unsigned enabledEngines, const DebuggerStartParameters &sp)
    : RunControl(runConfiguration, Constants::DEBUGMODE),
      d(new DebuggerRunControlPrivate(this, runConfiguration, enabledEngines))
{
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
    createEngine(sp);
}

DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
}

const DebuggerStartParameters &DebuggerRunControl::startParameters() const
{
    QTC_ASSERT(d->m_engine, return *(new DebuggerStartParameters()));
    return d->m_engine->startParameters();
}

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:
        case ProjectExplorer::ToolChain_GCC_MAEMO:
            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;
}

478
void DebuggerRunControl::createEngine(const DebuggerStartParameters &startParams)
479
{
480 481
    DebuggerStartParameters sp = startParams;

482 483
    // Figure out engine according to toolchain, executable, attach or default.
    DebuggerEngineType engineType = NoEngineType;
484
    DebuggerLanguages activeLangs = debuggerCore()->activeLanguages();
485
    const unsigned enabledEngineTypes = d->enabledEngines();
486
    if (sp.executable.endsWith(_(".js")))
487 488 489
        engineType = ScriptEngineType;
    else if (sp.executable.endsWith(_(".py")))
        engineType = PdbEngineType;
490
    else {
491
        engineType = engineForToolChain(sp.toolChainType);
492 493 494 495 496
        if (engineType == CdbEngineType && !(enabledEngineTypes & CdbEngineType)) {
            d->m_errorMessage = msgEngineNotAvailable("Cdb Engine");
            engineType = NoEngineType;
        }
    }
497

498
    // Fixme: 1 of 3 testing hacks.
499
    if (sp.processArgs.startsWith(__("@tcf@ ")))
500 501
        engineType = GdbEngineType;

502
    if (sp.processArgs.contains( _("@lldb@")))
hjk's avatar
hjk committed
503
        engineType = LldbEngineType;
504

505 506 507
    if (engineType == NoEngineType
            && sp.startMode != AttachToRemote
            && !sp.executable.isEmpty())
hjk's avatar
hjk committed
508
        engineType = d->engineForExecutable(enabledEngineTypes, sp.executable);
509

510
    if (engineType == NoEngineType)
hjk's avatar
hjk committed
511
        engineType = d->engineForMode(enabledEngineTypes, sp.startMode);
512

513 514
    if ((engineType != QmlEngineType && engineType != NoEngineType)
        && (activeLangs & QmlLanguage)) {
515
        if (activeLangs & CppLanguage) {
516 517 518 519 520 521 522
            sp.cppEngineType = engineType;
            engineType = QmlCppEngineType;
        } else {
            engineType = QmlEngineType;
        }
    }

Friedemann Kleint's avatar
Friedemann Kleint committed
523
    // qDebug() << "USING ENGINE : " << engineType;
524 525 526

    switch (engineType) {
        case GdbEngineType:
527
            d->m_engine = createGdbEngine(sp);
hjk's avatar
hjk committed
528
            d->initGdbEngine(qobject_cast<GdbEngine *>(d->m_engine));
529
            break;
530
        case ScriptEngineType:
hjk's avatar
hjk committed
531
            d->m_engine = createScriptEngine(sp);
532
            break;
533
        case CdbEngineType:
534
            // Try new engine, fall back to old.
hjk's avatar
hjk committed
535 536 537 538
            if (Cdb::isCdbEngineEnabled())
                d->m_engine = Cdb::createCdbEngine(sp, &d->m_errorMessage);
            else
                d->m_engine = Internal::createCdbEngine(sp, &d->m_errorMessage);
539
            break;
540
        case PdbEngineType:
hjk's avatar
hjk committed
541
            d->m_engine = createPdbEngine(sp);
542
            break;
543
        case TcfEngineType:
hjk's avatar
hjk committed
544
            d->m_engine = createTcfEngine(sp);
545
            break;
546
        case QmlEngineType:
hjk's avatar
hjk committed
547
            d->m_engine = createQmlEngine(sp);
548
            connect(qobject_cast<QmlEngine *>(d->m_engine),
hjk's avatar
hjk committed
549
                SIGNAL(remoteStartupRequested()),
550
                SIGNAL(engineRequestSetup()));
551
            break;
552
        case QmlCppEngineType:
hjk's avatar
hjk committed
553 554 555
            d->m_engine = createQmlCppEngine(sp);
            if (GdbEngine *embeddedGdbEngine = d->gdbEngine())
                d->initGdbEngine(embeddedGdbEngine);
556
            break;
hjk's avatar
hjk committed
557 558
        case LldbEngineType:
            d->m_engine = createLldbEngine(sp);
559 560
       case NoEngineType:
       case AllEngineTypes:
561
            break;
562 563 564 565 566
    }

    if (!d->m_engine) {
        // Could not find anything suitable.
        debuggingFinished();
hjk's avatar
hjk committed
567
        // Create Message box with possibility to go to settings.
568
        const QString msg = tr("Cannot debug '%1' (tool chain: '%2'): %3")
hjk's avatar
hjk committed
569
            .arg(sp.executable, toolChainName(sp.toolChainType), d->m_errorMessage);
570
        Core::ICore::instance()->showWarningWithOptions(tr("Warning"),
hjk's avatar
hjk committed
571 572
            msg, QString(), QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY),
            d->m_settingsIdHint);
573
    }
574 575
}

576
QString DebuggerRunControl::displayName() const
577
{
578 579
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
580 581
}

582
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
583
{
584
    d->m_engine->startParameters().environment = env;
585 586
}

587 588 589 590 591 592 593 594 595 596 597 598 599
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;

600
    if (!(debuggerCore()->activeLanguages() & CppLanguage))
601 602
        return success;

603
    switch(toolChain) {
604 605 606 607 608 609 610 611
    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:
hjk's avatar
hjk committed
612 613 614
        if (debuggerCore()->gdbBinaryForToolChain(toolChain).isEmpty()) {
            *errorMessage = msgNoBinaryForToolChain(toolChain);
            *settingsPage = GdbOptionsPage::settingsId();
615
            *errorMessage += msgEngineNotAvailable("Gdb");
hjk's avatar
hjk committed
616 617 618 619
            success = false;
        } else {
            success = true;
        }
620
        break;
621
    case ProjectExplorer::ToolChain_MSVC:
622 623
        success = checkCdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success) {
624
            *errorMessage += msgEngineNotAvailable("Cdb");
625 626 627 628 629 630 631
            if (settingsPage)
                *settingsPage = QLatin1String("Cdb");
        }
        break;
    }
    if (!success && settingsCategory && settingsPage && !settingsPage->isEmpty())
        *settingsCategory = QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY);
hjk's avatar
hjk committed
632

633
    return success;
634 635
}

636
void DebuggerRunControl::start()
637
{
638 639
    QTC_ASSERT(d->m_engine, return);
    const DebuggerStartParameters &sp = d->m_engine->startParameters();
640

641 642 643
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
644

645 646 647 648 649 650
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
651
        return;
652
    }
653

654
    debuggerCore()->runControlStarted(this);
655

656 657
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
658
    emit started();
659 660 661 662 663 664 665 666
    d->m_running = true;

    engine()->startDebugger(this);

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

669 670 671 672 673 674 675
QString DebuggerRunControl::idString() const
{
    return tr("Starting debugger '%1' for tool chain '%2'...")
        .arg(d->m_engine->objectName())
        .arg(toolChainName(d->m_engine->startParameters().toolChainType));
}

676
void DebuggerRunControl::startFailed()
677
{
678
    emit addToOutputWindowInline(this, tr("Debugging has failed"), false);
679
    d->m_running = false;
680
    emit finished();
681
    engine()->handleStartFailed();
682 683
}

684
void DebuggerRunControl::handleFinished()
685
{
686
    emit addToOutputWindowInline(this, tr("Debugging has finished"), false);
687 688
    if (engine())
        engine()->handleFinished();
689
    debuggerCore()->runControlFinished(this);
690 691
}

692
void DebuggerRunControl::showMessage(const QString &msg, int channel)
693
{
694 695 696 697 698 699 700 701 702 703 704
    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;
    }
705 706
}

707
bool DebuggerRunControl::aboutToStop() const
708
{
709 710
    QTC_ASSERT(isRunning(), return true;)

Jarek Kobus's avatar
Jarek Kobus committed
711
    const QString question = tr("A debugging session is still in progress. "
712 713 714 715 716
            "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 =
717
            QMessageBox::question(debuggerCore()->mainWindow(),
718 719 720 721 722 723 724
                                  tr("Close Debugging Session"), question,
                                  QMessageBox::Yes|QMessageBox::No);
    return answer == QMessageBox::Yes;
}

RunControl::StopResult DebuggerRunControl::stop()
{
725 726
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
727
    return AsynchronousStop;
728 729
}

730
void DebuggerRunControl::debuggingFinished()
731
{
732
    d->m_running = false;
733
    emit finished();
734 735
}

736
bool DebuggerRunControl::isRunning() const
737
{
738
    return d->m_running;
739 740
}

Friedemann Kleint's avatar
Friedemann Kleint committed
741 742
DebuggerState DebuggerRunControl::state() const
{
743 744
    QTC_ASSERT(d->m_engine, return DebuggerNotReady);
    return d->m_engine->state();
Friedemann Kleint's avatar
Friedemann Kleint committed
745 746
}

747
DebuggerEngine *DebuggerRunControl::engine()
748
{
749 750
    QTC_ASSERT(d->m_engine, /**/);
    return d->m_engine;
751 752
}

753
void DebuggerRunControl::handleRemoteSetupDone(int gdbServerPort, int qmlPort)
754
{
hjk's avatar
hjk committed
755
    // FIXME: Use virtual functions?
756
    if (QmlEngine *qmlEngine = qobject_cast<QmlEngine *>(d->m_engine)) {
757
        qmlEngine->handleRemoteSetupDone(qmlPort);
hjk's avatar
hjk committed
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
        return;
    }

    AbstractGdbAdapter *adapter = d->gdbAdapter();
    QTC_ASSERT(adapter, return);

    RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter);
    if (rpga) {
        rpga->handleSetupDone(qmlPort);
        return;
    }

    RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter);
    if (rgsa) {
        rgsa->handleSetupDone(gdbServerPort, qmlPort);
        return;
774
    }
hjk's avatar
hjk committed
775
    QTC_ASSERT(false, /**/);
776 777
}

778
void DebuggerRunControl::handleRemoteSetupFailed(const QString &message)
779
{
hjk's avatar
hjk committed
780
    // FIXME: Use virtual functions?
781 782
    if (QmlEngine *qmlEngine = qobject_cast<QmlEngine *>(d->m_engine)) {
        qmlEngine->handleRemoteSetupFailed(message);
hjk's avatar
hjk committed
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
        return;
    }

    AbstractGdbAdapter *adapter = d->gdbAdapter();
    QTC_ASSERT(adapter, return);

    RemotePlainGdbAdapter *rpga = qobject_cast<RemotePlainGdbAdapter *>(adapter);
    if (rpga) {
        rpga->handleSetupFailed(message);
        return;
    }

    RemoteGdbServerAdapter *rgsa = qobject_cast<RemoteGdbServerAdapter *>(adapter);
    if (rgsa) {
        rgsa->handleSetupFailed(message);
        return;
799
    }
hjk's avatar
hjk committed
800
    QTC_ASSERT(false, /**/);
801
}
802 803 804 805 806 807 808 809 810 811

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);
}
812 813 814 815 816

RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
817

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