debuggerrunner.cpp 33.7 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) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
**
29
**************************************************************************/
hjk's avatar
hjk committed
30

con's avatar
con committed
31
#include "debuggerrunner.h"
32
#include "debuggerruncontrolfactory.h"
con's avatar
con committed
33

34
#include "debuggeractions.h"
35
#include "debuggerinternalconstants.h"
36
#include "debuggercore.h"
37
#include "debuggerengine.h"
38
#include "debuggermainwindow.h"
39 40
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
41
#include "debuggerstartparameters.h"
Tobias Hunger's avatar
Tobias Hunger committed
42
#include "debuggerprofileinformation.h"
43
#include "lldb/lldbenginehost.h"
44
#include "debuggertooltipmanager.h"
45
#include "qml/qmlengine.h"
46

Friedemann Kleint's avatar
Friedemann Kleint committed
47 48
#ifdef Q_OS_WIN
#  include "peutils.h"
49
#  include <utils/winutils.h>
Friedemann Kleint's avatar
Friedemann Kleint committed
50 51
#endif

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

con's avatar
con committed
60
#include <utils/outputformat.h>
61
#include <utils/synchronousprocess.h>
hjk's avatar
hjk committed
62
#include <utils/qtcassert.h>
63
#include <utils/fancymainwindow.h>
64
#include <utils/qtcprocess.h>
65
#include <coreplugin/icore.h>
66
#include <coreplugin/helpmanager.h>
67
#include <utils/buildablehelperlibrary.h>
hjk's avatar
hjk committed
68

69
#include <QDir>
70 71
#include <QCheckBox>
#include <QSpinBox>
72 73
#include <QDebug>
#include <QErrorMessage>
74 75 76
#include <QFormLayout>
#include <QLabel>
#include <QMessageBox>
con's avatar
con committed
77

78
using namespace ProjectExplorer;
79 80
using namespace Debugger::Internal;

81 82
enum { debug = 0 };

83
namespace Debugger {
84
namespace Internal {
85

hjk's avatar
hjk committed
86
bool isCdbEngineEnabled(); // Check the configuration page
87
bool checkCdbConfiguration(const DebuggerStartParameters &sp, ConfigurationCheck *check);
hjk's avatar
hjk committed
88
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &sp,
89
    DebuggerEngine *masterEngine, QString *error);
90 91

bool checkGdbConfiguration(const DebuggerStartParameters &sp, ConfigurationCheck *check);
hjk's avatar
hjk committed
92
DebuggerEngine *createGdbEngine(const DebuggerStartParameters &sp,
93
    DebuggerEngine *masterEngine);
94

hjk's avatar
hjk committed
95 96
DebuggerEngine *createScriptEngine(const DebuggerStartParameters &sp);
DebuggerEngine *createPdbEngine(const DebuggerStartParameters &sp);
97
QmlEngine *createQmlEngine(const DebuggerStartParameters &sp,
98
    DebuggerEngine *masterEngine);
99 100 101
DebuggerEngine *createQmlCppEngine(const DebuggerStartParameters &sp,
                                   DebuggerEngineType slaveEngineType,
                                   QString *errorMessage);
hjk's avatar
hjk committed
102
DebuggerEngine *createLldbEngine(const DebuggerStartParameters &sp);
103

hjk's avatar
hjk committed
104
extern QString msgNoBinaryForToolChain(const Abi &abi);
105

106 107 108 109 110 111
static const char *engineTypeName(DebuggerEngineType et)
{
    switch (et) {
    case Debugger::NoEngineType:
        break;
    case Debugger::GdbEngineType:
112
        return "Gdb engine";
113 114 115 116 117
    case Debugger::ScriptEngineType:
        return "Script engine";
    case Debugger::CdbEngineType:
        return "Cdb engine";
    case Debugger::PdbEngineType:
118
        return "Pdb engine";
119 120 121 122 123 124 125 126 127 128 129 130
    case Debugger::QmlEngineType:
        return "QML engine";
    case Debugger::QmlCppEngineType:
        return "QML C++ engine";
    case Debugger::LldbEngineType:
        return "LLDB engine";
    case Debugger::AllEngineTypes:
        break;
    }
    return "No engine";
}

131 132 133 134 135
static inline QString engineTypeNames(const QList<DebuggerEngineType> &l)
{
    QString rc;
    foreach (DebuggerEngineType et, l) {
        if (!rc.isEmpty())
136
            rc.append(QLatin1String(", "));
137 138 139 140 141
        rc += QLatin1String(engineTypeName(et));
    }
    return rc;
}

142 143 144
static QString msgEngineNotAvailable(const char *engine)
{
    return DebuggerPlugin::tr("The application requires the debugger engine '%1', "
145
        "which is disabled.").arg(_(engine));
146 147
}

148 149 150 151 152
static inline QString msgEngineNotAvailable(DebuggerEngineType et)
{
    return msgEngineNotAvailable(engineTypeName(et));
}

153 154 155 156 157 158
////////////////////////////////////////////////////////////////////////
//
// DebuggerRunConfigWidget
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
159
class DebuggerRunConfigWidget : public RunConfigWidget
160 161 162 163
{
    Q_OBJECT

public:
164 165
    explicit DebuggerRunConfigWidget(RunConfiguration *runConfiguration);
    QString displayName() const { return tr("Debugger Settings"); }
166 167

private slots:
168 169
    void useCppDebuggerToggled(bool on);
    void useQmlDebuggerToggled(bool on);
170
    void qmlDebugServerPortChanged(int port);
171
    void useMultiProcessToggled(bool on);
172 173

public:
174
    DebuggerRunConfigurationAspect *m_aspect; // not owned
175 176 177 178 179 180

    QCheckBox *m_useCppDebugger;
    QCheckBox *m_useQmlDebugger;
    QSpinBox *m_debugServerPort;
    QLabel *m_debugServerPortLabel;
    QLabel *m_qmlDebuggerInfoLabel;
181
    QCheckBox *m_useMultiProcess;
182 183
};

184
DebuggerRunConfigWidget::DebuggerRunConfigWidget(RunConfiguration *runConfiguration)
185
{
186
    m_aspect = runConfiguration->debuggerAspect();
187

188 189
    m_useCppDebugger = new QCheckBox(tr("Enable C++"), this);
    m_useQmlDebugger = new QCheckBox(tr("Enable QML"), this);
190 191 192 193 194

    m_debugServerPort = new QSpinBox(this);
    m_debugServerPort->setMinimum(1);
    m_debugServerPort->setMaximum(65535);

195
    m_debugServerPortLabel = new QLabel(tr("Debug port:"), this);
196 197 198 199 200 201
    m_debugServerPortLabel->setBuddy(m_debugServerPort);

    m_qmlDebuggerInfoLabel = new QLabel(tr("<a href=\""
        "qthelp://com.nokia.qtcreator/doc/creator-debugging-qml.html"
        "\">What are the prerequisites?</a>"));

202 203 204
    m_useCppDebugger->setChecked(m_aspect->useCppDebugger());
    m_useQmlDebugger->setChecked(m_aspect->useQmlDebugger());

205
    m_debugServerPort->setValue(m_aspect->qmlDebugServerPort());
206

207 208 209 210 211 212
    static const QByteArray env = qgetenv("QTC_DEBUGGER_MULTIPROCESS");
    m_useMultiProcess =
        new QCheckBox(tr("Enable Debugging of Subprocesses"), this);
    m_useMultiProcess->setChecked(m_aspect->useMultiProcess());
    m_useMultiProcess->setVisible(env.toInt());

213
    connect(m_qmlDebuggerInfoLabel, SIGNAL(linkActivated(QString)),
214
            Core::HelpManager::instance(), SLOT(handleHelpRequest(QString)));
215
    connect(m_useQmlDebugger, SIGNAL(toggled(bool)),
216 217 218
            SLOT(useQmlDebuggerToggled(bool)));
    connect(m_useCppDebugger, SIGNAL(toggled(bool)),
            SLOT(useCppDebuggerToggled(bool)));
219
    connect(m_debugServerPort, SIGNAL(valueChanged(int)),
220
            SLOT(qmlDebugServerPortChanged(int)));
221 222
    connect(m_useMultiProcess, SIGNAL(toggled(bool)),
            SLOT(useMultiProcessToggled(bool)));
223

224 225 226
    if (m_aspect->isDisplaySuppressed())
        hide();

227
    if (m_aspect->areQmlDebuggingOptionsSuppressed()) {
228 229 230 231
        m_debugServerPortLabel->hide();
        m_debugServerPort->hide();
        m_useQmlDebugger->hide();
    }
232

233 234 235
    if (m_aspect->areCppDebuggingOptionsSuppressed())
        m_useCppDebugger->hide();

236 237 238 239 240
    if (m_aspect->isQmlDebuggingSpinboxSuppressed()) {
        m_debugServerPort->hide();
        m_debugServerPortLabel->hide();
    }

241 242 243 244 245 246 247 248 249 250 251 252
    QHBoxLayout *qmlLayout = new QHBoxLayout;
    qmlLayout->setMargin(0);
    qmlLayout->addWidget(m_useQmlDebugger);
    qmlLayout->addWidget(m_debugServerPortLabel);
    qmlLayout->addWidget(m_debugServerPort);
    qmlLayout->addWidget(m_qmlDebuggerInfoLabel);
    qmlLayout->addStretch();

    QVBoxLayout *layout = new QVBoxLayout;
    layout->setMargin(0);
    layout->addWidget(m_useCppDebugger);
    layout->addLayout(qmlLayout);
253
    layout->addWidget(m_useMultiProcess);
254 255 256
    setLayout(layout);
}

257
void DebuggerRunConfigWidget::qmlDebugServerPortChanged(int port)
258
{
259
    m_aspect->m_qmlDebugServerPort = port;
260 261
}

262
void DebuggerRunConfigWidget::useCppDebuggerToggled(bool on)
263
{
264 265
    m_aspect->m_useCppDebugger = on;
    if (!on && !m_useQmlDebugger->isChecked())
266 267 268
        m_useQmlDebugger->setChecked(true);
}

269
void DebuggerRunConfigWidget::useQmlDebuggerToggled(bool on)
270
{
271 272
    m_debugServerPort->setEnabled(on);
    m_debugServerPortLabel->setEnabled(on);
273

274
    m_aspect->m_useQmlDebugger = on
275 276
            ? DebuggerRunConfigurationAspect::EnableQmlDebugger
            : DebuggerRunConfigurationAspect::DisableQmlDebugger;
277
    if (!on && !m_useCppDebugger->isChecked())
278 279 280
        m_useCppDebugger->setChecked(true);
}

281 282 283 284 285
void DebuggerRunConfigWidget::useMultiProcessToggled(bool on)
{
    m_aspect->m_useMultiProcess = on;
}

286 287
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
288
// DebuggerRunControlPrivate
289 290 291
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
292 293 294
class DebuggerRunControlPrivate
{
public:
295 296
    explicit DebuggerRunControlPrivate(DebuggerRunControl *parent,
                                       RunConfiguration *runConfiguration);
297

hjk's avatar
hjk committed
298 299 300 301 302 303 304
    DebuggerEngineType engineForExecutable(unsigned enabledEngineTypes,
        const QString &executable);
    DebuggerEngineType engineForMode(unsigned enabledEngineTypes,
        DebuggerStartMode mode);

public:
    DebuggerRunControl *q;
305 306 307 308 309
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
};

hjk's avatar
hjk committed
310
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
311
                                                     RunConfiguration *runConfiguration)
hjk's avatar
hjk committed
312 313
    : q(parent)
    , m_engine(0)
314
    , m_myRunConfiguration(runConfiguration)
315
    , m_running(false)
316 317
{
}
318

hjk's avatar
hjk committed
319 320
} // namespace Internal

hjk's avatar
hjk committed
321
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
322 323
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
hjk's avatar
hjk committed
324
    : RunControl(runConfiguration, DebugRunMode),
325
      d(new DebuggerRunControlPrivate(this, runConfiguration))
326
{
hjk's avatar
hjk committed
327
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
328 329 330 331 332 333 334
    // Create the engine. Could arguably be moved to the factory, but
    // we still have a derived S60DebugControl. Should rarely fail, though.
    QString errorMessage;
    d->m_engine = masterSlaveEngineTypes.first == QmlCppEngineType ?
            createQmlCppEngine(sp, masterSlaveEngineTypes.second, &errorMessage) :
            DebuggerRunControlFactory::createEngine(masterSlaveEngineTypes.first, sp,
                                                    0, &errorMessage);
335 336 337
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
338
        debuggingFinished();
hjk's avatar
hjk committed
339
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
340
    }
341 342
}

hjk's avatar
hjk committed
343 344 345 346 347 348 349 350
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
hjk's avatar
hjk committed
351
    delete d;
hjk's avatar
hjk committed
352 353 354 355 356 357 358 359
}

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

360
QString DebuggerRunControl::displayName() const
361
{
362 363
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
364 365
}

366 367
QIcon DebuggerRunControl::icon() const
{
368
    return QIcon(QLatin1String(ProjectExplorer::Constants::ICON_DEBUG_SMALL));
369 370
}

371
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
372
{
373
    QTC_ASSERT(d->m_engine, return);
374
    d->m_engine->startParameters().environment = env;
375 376
}

377
void DebuggerRunControl::start()
378
{
379
    QTC_ASSERT(d->m_engine, return);
380 381 382
    // User canceled input dialog asking for executable when working on library project.
    if (d->m_engine->startParameters().startMode == StartInternal
        && d->m_engine->startParameters().executable.isEmpty()) {
con's avatar
con committed
383
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
384 385 386 387 388
        emit started();
        emit finished();
        return;
    }

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
    if (d->m_engine->startParameters().startMode == StartInternal) {
        foreach (const BreakpointModelId &id, debuggerCore()->breakHandler()->allBreakpointIds()) {
            if (d->m_engine->breakHandler()->breakpointData(id).enabled
                    && !d->m_engine->acceptsBreakpoint(id)) {

                QString warningMessage =
                        DebuggerPlugin::tr("Some breakpoints cannot be handled by the debugger "
                                           "languages currently active, and will be ignored.");

                debuggerCore()->showMessage(warningMessage, LogWarning);

                QErrorMessage *msgBox = new QErrorMessage(debuggerCore()->mainWindow());
                msgBox->setAttribute(Qt::WA_DeleteOnClose);
                msgBox->showMessage(warningMessage);
                break;
            }
405 406 407
        }
    }

408
    debuggerCore()->runControlStarted(d->m_engine);
409

410 411
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
412
    emit started();
413 414
    d->m_running = true;

415
    d->m_engine->startDebugger(this);
416

417
    if (d->m_running)
con's avatar
con committed
418
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
419 420
}

421
void DebuggerRunControl::startFailed()
422
{
con's avatar
con committed
423
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
424
    d->m_running = false;
425
    emit finished();
426
    d->m_engine->handleStartFailed();
427 428
}

429
void DebuggerRunControl::handleFinished()
430
{
con's avatar
con committed
431
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
432 433 434
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
435 436
}

437
void DebuggerRunControl::showMessage(const QString &msg, int channel)
438
{
439 440
    switch (channel) {
        case AppOutput:
con's avatar
con committed
441
            appendMessage(msg, Utils::StdOutFormatSameLine);
442 443
            break;
        case AppError:
con's avatar
con committed
444
            appendMessage(msg, Utils::StdErrFormatSameLine);
445 446
            break;
        case AppStuff:
447
            appendMessage(msg, Utils::DebugFormat);
448 449
            break;
    }
450 451
}

452
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
453
{
454
    QTC_ASSERT(isRunning(), return true);
455

456 457 458
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
459
    const QString question = tr("A debugging session is still in progress. "
460 461 462
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
463 464
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
465 466 467 468
}

RunControl::StopResult DebuggerRunControl::stop()
{
469 470
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
471
    return AsynchronousStop;
472 473
}

474
void DebuggerRunControl::debuggingFinished()
475
{
476
    d->m_running = false;
477
    emit finished();
478 479
}

480
bool DebuggerRunControl::isRunning() const
481
{
482
    return d->m_running;
483 484
}

485
DebuggerEngine *DebuggerRunControl::engine()
486
{
487
    QTC_CHECK(d->m_engine);
488
    return d->m_engine;
489 490
}

491 492 493 494
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
495

496 497
////////////////////////////////////////////////////////////////////////
//
498
// Engine detection logic: Detection functions depending on tool chain, binary,
499 500 501 502 503
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

504 505
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
506 507 508 509 510 511 512
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
513 514
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
515 516 517 518 519 520 521
        break;
   case Abi::PEFormat:
        if (toolChain.osFlavor() == Abi::WindowsMSysFlavor) {
            result.push_back(GdbEngineType);
            result.push_back(CdbEngineType);
        } else {
            result.push_back(CdbEngineType);
522
            //result.push_back(GdbEngineType);
523
        }
524 525
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
        break;
    case Abi::RuntimeQmlFormat:
        result.push_back(QmlEngineType);
        break;
    default:
        break;
    }
    return result;
}

static inline QList<DebuggerEngineType> enginesForScriptExecutables(const QString &executable)
{
    QList<DebuggerEngineType> result;
    if (executable.endsWith(_(".js"))) {
        result.push_back(ScriptEngineType);
    } else if (executable.endsWith(_(".py"))) {
        result.push_back(PdbEngineType);
    }
    return result;
}

static QList<DebuggerEngineType> enginesForExecutable(const QString &executable)
{
    QList<DebuggerEngineType> result = enginesForScriptExecutables(executable);
    if (!result.isEmpty())
        return result;
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe"), Qt::CaseInsensitive)) {
        result.push_back(GdbEngineType);
        return result;
    }

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
    QString errorMessage;
    if (getPDBFiles(executable, &pdbFiles, &errorMessage) && !pdbFiles.isEmpty()) {
        result.push_back(CdbEngineType);
        result.push_back(GdbEngineType);
        return result;
    }
    // Fixme: Gdb should only be preferred if MinGW can positively be detected.
    result.push_back(GdbEngineType);
    result.push_back(CdbEngineType);
#else
    result.push_back(LldbEngineType);
    result.push_back(GdbEngineType);
#endif
    return result;
}

// Debugger type for mode.
static QList<DebuggerEngineType> enginesForMode(DebuggerStartMode startMode,
579
                                                DebuggerLanguages languages,
580 581 582
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
583 584 585

    if (languages == QmlLanguage) {
        QTC_ASSERT(startMode == StartInternal
586 587
                   || startMode == AttachToRemoteServer
                   || startMode == AttachToRemoteProcess,
588 589 590 591 592 593 594 595
                   qDebug() << "qml debugging not supported for mode"
                            << startMode);

        // Qml language only
        result.push_back(QmlEngineType);
        return result;
    }

596
    switch (startMode) {
hjk's avatar
hjk committed
597
    case NoStartMode:
598
        break;
hjk's avatar
hjk committed
599 600
    case StartInternal:
    case StartExternal:
601 602 603 604 605 606
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
607 608 609

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
610 611
        }
        break;
612 613 614
    case LoadRemoteCore:
        result.push_back(GdbEngineType);
        break;
hjk's avatar
hjk committed
615
    case AttachCore:
616 617 618 619 620
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
621
    case StartRemoteProcess:
hjk's avatar
hjk committed
622
    case StartRemoteGdb:
623
        result.push_back(GdbEngineType);
624 625
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
626
        break;
627
    case AttachToRemoteProcess:
628
    case AttachToRemoteServer:
629 630 631 632 633
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
634 635 636

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
        }
        break;
    case AttachCrashedExternal:
        result.push_back(CdbEngineType); // Only CDB can do this
        break;
    case StartRemoteEngine:
        // FIXME: Unclear IPC override. Someone please have a better idea.
        // For now thats the only supported IPC engine.
        result.push_back(LldbEngineType);
        break;
    }
    return result;
}

// Engine detection logic: Call all detection functions in order.

static QList<DebuggerEngineType> engineTypes(const DebuggerStartParameters &sp)
{
    // Script executables and certain start modes are 'hard constraints'.
    QList<DebuggerEngineType> result = enginesForScriptExecutables(sp.executable);
    if (!result.isEmpty())
        return result;

660
    result = enginesForMode(sp.startMode, sp.languages, true);
661 662 663 664 665 666
    if (!result.isEmpty())
        return result;

    //  'hard constraints' done (with the exception of QML ABI checked here),
    // further try to restrict available engines.
    if (sp.toolChainAbi.isValid()) {
667
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
668 669 670 671
        if (!result.isEmpty())
            return result;
    }

672 673
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
hjk's avatar
hjk committed
674
            && sp.startMode != LoadRemoteCore
675
            && !sp.executable.isEmpty())
676 677 678 679
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

680
    result = enginesForMode(sp.startMode, sp.languages, false);
681 682 683 684 685 686 687 688 689 690 691
    return result;
}

// Engine detection logic: ConfigurationCheck.
ConfigurationCheck::ConfigurationCheck() :
    masterSlaveEngineTypes(NoEngineType, NoEngineType)
{
}

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
692 693 694
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
695 696 697 698 699
}

QString ConfigurationCheck::errorDetailsString() const
{
    return errorDetails.join(QLatin1String("\n\n"));
700 701
}

702 703 704 705 706 707 708 709 710 711
// Convenience helper to check whether an engine is enabled and configured
// correctly.
static inline bool canUseEngine(DebuggerEngineType et,
                                const DebuggerStartParameters &sp,
                                unsigned cmdLineEnabledEngines,
                                ConfigurationCheck *result)
{
    // Enabled?
    if ((et & cmdLineEnabledEngines) == 0) {
        result->errorDetails.push_back(DebuggerPlugin::tr("The debugger engine '%1' is disabled.").
712
                                       arg(QLatin1String(engineTypeName(et))));
713 714 715 716
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
717
    case CdbEngineType:
718
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
719
    case GdbEngineType:
720 721 722 723 724 725 726
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

727
/*!
728
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
729 730 731 732 733 734 735 736 737

    This is the master engine detection function that returns the
    engine types for a given set of start parameters and checks their
    configuration.
*/

DEBUGGER_EXPORT ConfigurationCheck checkDebugConfiguration(const DebuggerStartParameters &sp)
{
    ConfigurationCheck result;
hjk's avatar
hjk committed
738
    QString abi = sp.toolChainAbi.toString();
739
    if (debug)
hjk's avatar
hjk committed
740
        qDebug().nospace() << "checkDebugConfiguration " << abi
741 742
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
743
    // Get all applicable types.
744
    QList<DebuggerEngineType> requiredTypes = engineTypes(sp);
745
    if (requiredTypes.isEmpty()) {
Friedemann Kleint's avatar
Friedemann Kleint committed
746
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
747 748
        return result;
    }
749 750
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
751
    // Filter out disabled types, command line + current settings.
752 753
    unsigned cmdLineEnabledEngines = debuggerCore()->enabledEngines();
#ifdef WITH_LLDB
hjk's avatar
hjk committed
754
    if (!Core::ICore::settings()->value(QLatin1String("LLDB/enabled")).toBool())
755 756 757 758
        cmdLineEnabledEngines &= ~LldbEngineType;
#else
     cmdLineEnabledEngines &= ~LldbEngineType;
#endif
759

760 761 762 763
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
764
            result.errorDetails.clear();
765 766
            usableType = et;
            break;
767
        } else {
768
            unavailableTypes.push_back(et);
769
        }
770
    }
771 772 773 774 775
    if (usableType == NoEngineType) {
        if (requiredTypes.size() == 1) {
            result.errorMessage = DebuggerPlugin::tr(
                "The debugger engine '%1' required for debugging binaries of the type '%2'"
                " is not configured correctly.").
hjk's avatar
hjk committed
776
                arg(QLatin1String(engineTypeName(requiredTypes.front())), abi);
777
        } else {
778 779 780
            result.errorMessage = DebuggerPlugin::tr(
                "None of the debugger engines '%1' capable of debugging binaries of the type '%2'"
                " is configured correctly.").
hjk's avatar
hjk committed
781
                arg(engineTypeNames(requiredTypes), abi);
782
        }
783
        return result;
784
    }
785
    if (debug)
786 787 788 789 790 791
        qDebug() << "Configured engine: " << engineTypeName(usableType);
    // Inform verbosely about MinGW-gdb/CDB fallbacks. Do not complain about LLDB, for now.
    if (!result.errorDetails.isEmpty() && unavailableTypes.count(LldbEngineType) != unavailableTypes.size()) {
        const QString msg = DebuggerPlugin::tr(
            "The preferred debugger engine for debugging binaries of type '%1' is not available.\n"
            "The debugger engine '%2' will be used as a fallback.\nDetails: %3").
hjk's avatar
hjk committed
792
                arg(abi, QLatin1String(engineTypeName(usableType)),
793 794
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
795
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
796 797
    }
    // Anything left: Happy.
798 799
    result.errorMessage.clear();
    result.errorDetails.clear();
800 801 802 803 804 805 806 807 808 809 810


    // Could we actually use a combined qml/cpp-engine?
     if (usableType != QmlEngineType
             && requiredTypes.contains(QmlEngineType)) {
         result.masterSlaveEngineTypes.first = QmlCppEngineType;
         result.masterSlaveEngineTypes.second = usableType;
     } else {
         result.masterSlaveEngineTypes.first = usableType;
     }

811 812
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
813 814
    return result;
}
815 816 817 818 819 820 821 822

////////////////////////////////////////////////////////////////////////
//
// DebuggerRunControlFactory
//
////////////////////////////////////////////////////////////////////////

// A factory to create DebuggerRunControls
823 824
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent)
    : IRunControlFactory(parent)
825 826
{}

827
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, RunMode mode) const
828
{
829
    return (mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain)
830 831 832 833 834
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
hjk's avatar
hjk committed
835
    return DebuggerPlugin::tr("Debug");
836 837 838
}

// Find Qt installation by running qmake
839
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
840 841 842
{
    QProcess proc;
    QStringList args;
843 844
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
845
    proc.start(qmakePath.toString(), args);
846
    if (!proc.waitForStarted()) {
847
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
848 849 850 851 852 853
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
854
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
855 856 857
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
858
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
        return QString();
    }
    const QByteArray ba = proc.readAllStandardOutput().trimmed();
    QDir dir(QString::fromLocal8Bit(ba));
    if (dir.exists() && dir.cdUp())
        return dir.absolutePath();
    return QString();
}

static DebuggerStartParameters localStartParameters(RunConfiguration *runConfiguration)
{
    DebuggerStartParameters sp;
    QTC_ASSERT(runConfiguration, return sp);
    LocalApplicationRunConfiguration *rc =
            qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
    QTC_ASSERT(rc, return sp);

hjk's avatar
hjk committed
876 877 878
    Target *target = runConfiguration->target();
    Profile *profile = target ? target->profile() : ProfileManager::instance()->defaultProfile();
    fillParameters(&sp, profile->id());
879 880
    sp.environment = rc->environment();
    sp.workingDirectory = rc->workingDirectory();
881 882 883 884 885 886

#if defined(Q_OS_WIN)
    // Work around QTBUG-17529 (QtDeclarative fails with 'File name case mismatch' ...)
    sp.workingDirectory = Utils::normalizePathName(sp.workingDirectory);
#endif

887
    sp.executable = rc->executable();
888 889 890
    if (sp.executable.isEmpty())
        return sp;
    sp.startMode = StartInternal;
891 892 893 894 895
    sp.processArgs = rc->commandLineArguments();
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

hjk's avatar
hjk committed
896
    if (target) {
897
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
Tobias Hunger's avatar
Tobias Hunger committed
898 899 900 901 902 903
            // FIXME: Get this from the profile?
            //        We could query the QtVersion for this information directly, but then we
            //        will need to add a dependency on QtSupport to the debugger.
            //
            //        The profile could also get a method to extract the required information from
            //        its information to avoid this dependecy (as we do for the environment).
904
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);