debuggerrunner.cpp 33.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) 2012 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
**
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
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "debuggerrunner.h"
34
#include "debuggerruncontrolfactory.h"
con's avatar
con committed
35

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

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

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

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

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

80
using namespace ProjectExplorer;
81 82
using namespace Debugger::Internal;

83 84
enum { debug = 0 };

85
namespace Debugger {
86
namespace Internal {
87

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

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

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

hjk's avatar
hjk committed
106
extern QString msgNoBinaryForToolChain(const Abi &abi);
107

108 109 110 111 112 113
static const char *engineTypeName(DebuggerEngineType et)
{
    switch (et) {
    case Debugger::NoEngineType:
        break;
    case Debugger::GdbEngineType:
114
        return "Gdb engine";
115 116 117 118 119
    case Debugger::ScriptEngineType:
        return "Script engine";
    case Debugger::CdbEngineType:
        return "Cdb engine";
    case Debugger::PdbEngineType:
120
        return "Pdb engine";
121 122 123 124 125 126 127 128 129 130 131 132
    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";
}

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

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

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

155 156 157 158 159 160
////////////////////////////////////////////////////////////////////////
//
// DebuggerRunConfigWidget
//
////////////////////////////////////////////////////////////////////////

161
class DebuggerRunConfigWidget : public ProjectExplorer::RunConfigWidget
162 163 164 165
{
    Q_OBJECT

public:
166 167
    explicit DebuggerRunConfigWidget(RunConfiguration *runConfiguration);
    QString displayName() const { return tr("Debugger Settings"); }
168 169 170 171

private slots:
    void useCppDebuggerToggled(bool toggled);
    void useQmlDebuggerToggled(bool toggled);
172 173 174
    void qmlDebugServerPortChanged(int port);

public:
175
    DebuggerRunConfigurationAspect *m_aspect; // not owned
176 177 178 179 180 181 182 183

    QCheckBox *m_useCppDebugger;
    QCheckBox *m_useQmlDebugger;
    QSpinBox *m_debugServerPort;
    QLabel *m_debugServerPortLabel;
    QLabel *m_qmlDebuggerInfoLabel;
};

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
    useCppDebuggerToggled(m_aspect->useCppDebugger());
    useQmlDebuggerToggled(m_aspect->useQmlDebugger());
    m_debugServerPort->setValue(m_aspect->qmlDebugServerPort());
205

206
    connect(m_qmlDebuggerInfoLabel, SIGNAL(linkActivated(QString)),
207
            Core::HelpManager::instance(), SLOT(handleHelpRequest(QString)));
208
    connect(m_useQmlDebugger, SIGNAL(toggled(bool)),
209 210 211
            SLOT(useQmlDebuggerToggled(bool)));
    connect(m_useCppDebugger, SIGNAL(toggled(bool)),
            SLOT(useCppDebuggerToggled(bool)));
212
    connect(m_debugServerPort, SIGNAL(valueChanged(int)),
213 214
            SLOT(qmlDebugServerPortChanged(int)));

215 216 217
    if (m_aspect->isDisplaySuppressed())
        hide();

218
    if (m_aspect->areQmlDebuggingOptionsSuppressed()) {
219 220 221 222
        m_debugServerPortLabel->hide();
        m_debugServerPort->hide();
        m_useQmlDebugger->hide();
    }
223

224 225 226
    if (m_aspect->areCppDebuggingOptionsSuppressed())
        m_useCppDebugger->hide();

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

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
    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);
    setLayout(layout);
}

247
void DebuggerRunConfigWidget::qmlDebugServerPortChanged(int port)
248
{
249
    m_aspect->m_qmlDebugServerPort = port;
250 251
}

252
void DebuggerRunConfigWidget::useCppDebuggerToggled(bool toggled)
253
{
254
    m_aspect->m_useCppDebugger = toggled;
255 256 257 258
    if (!toggled && !m_useQmlDebugger->isChecked())
        m_useQmlDebugger->setChecked(true);
}

259
void DebuggerRunConfigWidget::useQmlDebuggerToggled(bool toggled)
260
{
261 262 263
    m_debugServerPort->setEnabled(toggled);
    m_debugServerPortLabel->setEnabled(toggled);

264 265 266
    m_aspect->m_useQmlDebugger = toggled
            ? DebuggerRunConfigurationAspect::EnableQmlDebugger
            : DebuggerRunConfigurationAspect::DisableQmlDebugger;
267 268 269 270
    if (!toggled && !m_useCppDebugger->isChecked())
        m_useCppDebugger->setChecked(true);
}

271 272
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
273
// DebuggerRunControlPrivate
274 275 276
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
277 278 279
class DebuggerRunControlPrivate
{
public:
280 281
    explicit DebuggerRunControlPrivate(DebuggerRunControl *parent,
                                       RunConfiguration *runConfiguration);
282

hjk's avatar
hjk committed
283 284 285 286 287 288 289
    DebuggerEngineType engineForExecutable(unsigned enabledEngineTypes,
        const QString &executable);
    DebuggerEngineType engineForMode(unsigned enabledEngineTypes,
        DebuggerStartMode mode);

public:
    DebuggerRunControl *q;
290 291 292 293 294
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
};

hjk's avatar
hjk committed
295
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
296
                                                     RunConfiguration *runConfiguration)
hjk's avatar
hjk committed
297 298
    : q(parent)
    , m_engine(0)
299
    , m_myRunConfiguration(runConfiguration)
300
    , m_running(false)
301 302
{
}
303

hjk's avatar
hjk committed
304 305
} // namespace Internal

hjk's avatar
hjk committed
306
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
307 308
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
309
    : RunControl(runConfiguration, ProjectExplorer::DebugRunMode),
310
      d(new DebuggerRunControlPrivate(this, runConfiguration))
311
{
hjk's avatar
hjk committed
312
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
313 314 315 316 317 318 319
    // 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);
320 321 322
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
323
        debuggingFinished();
hjk's avatar
hjk committed
324
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
325
    }
326 327
}

hjk's avatar
hjk committed
328 329 330 331 332 333 334 335
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
hjk's avatar
hjk committed
336
    delete d;
hjk's avatar
hjk committed
337 338 339 340 341 342 343 344
}

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

345
QString DebuggerRunControl::displayName() const
346
{
347 348
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
349 350
}

351 352
QIcon DebuggerRunControl::icon() const
{
353
    return QIcon(QLatin1String(ProjectExplorer::Constants::ICON_DEBUG_SMALL));
354 355
}

356
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
357
{
358
    QTC_ASSERT(d->m_engine, return);
359
    d->m_engine->startParameters().environment = env;
360 361
}

362
void DebuggerRunControl::start()
363
{
364
    QTC_ASSERT(d->m_engine, return);
365 366 367
    // 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
368
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
369 370 371 372 373
        emit started();
        emit finished();
        return;
    }

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    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;
            }
390 391 392
        }
    }

393
    debuggerCore()->runControlStarted(d->m_engine);
394

395 396
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
397
    emit started();
398 399
    d->m_running = true;

400
    d->m_engine->startDebugger(this);
401

402
    if (d->m_running)
con's avatar
con committed
403
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
404 405
}

406
void DebuggerRunControl::startFailed()
407
{
con's avatar
con committed
408
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
409
    d->m_running = false;
410
    emit finished();
411
    d->m_engine->handleStartFailed();
412 413
}

414
void DebuggerRunControl::handleFinished()
415
{
con's avatar
con committed
416
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
417 418 419
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
420 421
}

422
void DebuggerRunControl::showMessage(const QString &msg, int channel)
423
{
424 425
    switch (channel) {
        case AppOutput:
con's avatar
con committed
426
            appendMessage(msg, Utils::StdOutFormatSameLine);
427 428
            break;
        case AppError:
con's avatar
con committed
429
            appendMessage(msg, Utils::StdErrFormatSameLine);
430 431
            break;
        case AppStuff:
432
            appendMessage(msg, Utils::DebugFormat);
433 434
            break;
    }
435 436
}

437
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
438
{
439 440
    QTC_ASSERT(isRunning(), return true;)

441 442 443
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
444
    const QString question = tr("A debugging session is still in progress. "
445 446 447
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
448 449
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
450 451 452 453
}

RunControl::StopResult DebuggerRunControl::stop()
{
454 455
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
456
    return AsynchronousStop;
457 458
}

459
void DebuggerRunControl::debuggingFinished()
460
{
461
    d->m_running = false;
462
    emit finished();
463 464
}

465
bool DebuggerRunControl::isRunning() const
466
{
467
    return d->m_running;
468 469
}

470
DebuggerEngine *DebuggerRunControl::engine()
471
{
472
    QTC_CHECK(d->m_engine);
473
    return d->m_engine;
474 475
}

476 477 478 479
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
480

481 482
////////////////////////////////////////////////////////////////////////
//
483
// Engine detection logic: Detection functions depending on tool chain, binary,
484 485 486 487 488
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

489 490
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
491 492 493 494 495 496 497
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
498 499
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
500 501 502 503 504 505 506 507 508
        break;
   case Abi::PEFormat:
        if (toolChain.osFlavor() == Abi::WindowsMSysFlavor) {
            result.push_back(GdbEngineType);
            result.push_back(CdbEngineType);
        } else {
            result.push_back(CdbEngineType);
            result.push_back(GdbEngineType);
        }
509 510
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 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
        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,
564
                                                DebuggerLanguages languages,
565 566 567
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
568 569 570 571 572 573 574 575 576 577 578 579

    if (languages == QmlLanguage) {
        QTC_ASSERT(startMode == StartInternal
                   || startMode == AttachToRemoteServer,
                   qDebug() << "qml debugging not supported for mode"
                            << startMode);

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

580
    switch (startMode) {
hjk's avatar
hjk committed
581
    case NoStartMode:
582
        break;
hjk's avatar
hjk committed
583 584
    case StartInternal:
    case StartExternal:
585 586 587 588 589 590
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
591 592 593

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
594 595
        }
        break;
hjk's avatar
hjk committed
596
    case AttachCore:
597 598 599 600 601
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
602
    case StartRemoteProcess:
hjk's avatar
hjk committed
603
    case StartRemoteGdb:
604
        result.push_back(GdbEngineType);
605 606
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
607
        break;
608
    case AttachToRemoteProcess:
609
    case AttachToRemoteServer:
610 611 612 613 614
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
615 616 617

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
        }
        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;

641
    result = enginesForMode(sp.startMode, sp.languages, true);
642 643 644 645 646 647
    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()) {
648
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
649 650 651 652 653
        if (!result.isEmpty())
            return result;
    }

    // FIXME: 1 of 3 testing hacks.
654
    if (sp.processArgs.startsWith(QLatin1String("@tcf@ "))) {
655 656 657 658
        result.push_back(GdbEngineType);
        return result;
    }

659 660 661
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
            && !sp.executable.isEmpty())
662 663 664 665
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

666
    result = enginesForMode(sp.startMode, sp.languages, false);
667 668 669 670 671 672 673 674 675 676 677
    return result;
}

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

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
678 679 680
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
681 682 683 684 685
}

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

688 689 690 691 692 693 694 695 696 697
// 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.").
698
                                       arg(QLatin1String(engineTypeName(et))));
699 700 701 702
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
703
    case CdbEngineType:
704
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
705
    case GdbEngineType:
706 707 708 709 710 711 712
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

713
/*!
714
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
715 716 717 718 719 720 721 722 723

    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;
724 725 726 727
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
728
    // Get all applicable types.
729
    QList<DebuggerEngineType> requiredTypes = engineTypes(sp);
730
    if (requiredTypes.isEmpty()) {
Friedemann Kleint's avatar
Friedemann Kleint committed
731
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
732 733
        return result;
    }
734 735
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
736
    // Filter out disabled types, command line + current settings.
737 738
    unsigned cmdLineEnabledEngines = debuggerCore()->enabledEngines();
#ifdef WITH_LLDB
hjk's avatar
hjk committed
739
    if (!Core::ICore::settings()->value(QLatin1String("LLDB/enabled")).toBool())
740 741 742 743
        cmdLineEnabledEngines &= ~LldbEngineType;
#else
     cmdLineEnabledEngines &= ~LldbEngineType;
#endif
744

745 746 747 748 749 750
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
751
        } else {
752
            unavailableTypes.push_back(et);
753
        }
754
    }
755 756 757 758 759 760
    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.").
                arg(QLatin1String(engineTypeName(requiredTypes.front())), sp.toolChainAbi.toString());
761
        } else {
762 763 764 765
            result.errorMessage = DebuggerPlugin::tr(
                "None of the debugger engines '%1' capable of debugging binaries of the type '%2'"
                " is configured correctly.").
                arg(engineTypeNames(requiredTypes), sp.toolChainAbi.toString());
766
        }
767
        return result;
768
    }
769
    if (debug)
770 771 772 773 774 775
        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").
776
                arg(sp.toolChainAbi.toString(), QLatin1String(engineTypeName(usableType)),
777 778
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
779
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
780 781
    }
    // Anything left: Happy.
782 783
    result.errorMessage.clear();
    result.errorDetails.clear();
784 785 786 787 788 789 790 791 792 793 794


    // 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;
     }

795 796
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
797 798
    return result;
}
799 800 801 802 803 804 805 806 807 808 809 810 811

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

// A factory to create DebuggerRunControls
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent,
        unsigned enabledEngines)
    : IRunControlFactory(parent), m_enabledEngines(enabledEngines)
{}

812
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, RunMode mode) const
813
{
814
    return (mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain)
815 816 817 818 819
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
820
    return DebuggerRunControl::tr("Debug");
821 822 823
}

// Find Qt installation by running qmake
824
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
825 826 827
{
    QProcess proc;
    QStringList args;
828 829
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
830
    proc.start(qmakePath.toString(), args);
831
    if (!proc.waitForStarted()) {
832
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
833 834 835 836 837 838
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
839
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
840 841 842
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
843
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
        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);

    sp.environment = rc->environment();
    sp.workingDirectory = rc->workingDirectory();
863 864 865 866 867 868

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

869
    sp.executable = rc->executable();
870 871 872
    if (sp.executable.isEmpty())
        return sp;
    sp.startMode = StartInternal;
873
    sp.processArgs = rc->commandLineArguments();
874
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
875
    if (!sp.toolChainAbi.isValid()) {
Tobias Hunger's avatar
Tobias Hunger committed
876
        QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(sp.executable));
Tobias Hunger's avatar
Tobias Hunger committed
877 878 879
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
880 881 882 883
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

884
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
885
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
886
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
887 888 889
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
890
        if (const ProjectExplorer::Project *project = target->project()) {
891 892 893 894
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
895
                    sp.debuggerCommand = tc->debuggerCommand().toString();
896 897
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
898 899 900
        }
    }

901
    if (runConfiguration->debuggerAspect()->useCppDebugger())
902 903
        sp.languages |= CppLanguage;

904
    if (runConfiguration->debuggerAspect()->useQmlDebugger()) {
905
        sp.qmlServerAddress = _("127.0.0.1");
906
        sp.qmlServerPort = runConfiguration->debuggerAspect()->qmlDebugServerPort();
907
        sp.languages |= QmlLanguage;
908

909 910
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
911 912 913
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
914 915
        }

916 917
        Utils::QtcProcess::addArg(&sp.processArgs,
                                  QString::fromLatin1("-qmljsdebugger=port:%1,block").arg(sp.qmlServerPort));
918 919 920 921 922 923 924 925 926 927 928 929
    }