debuggerrunner.cpp 33.9 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

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

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

    QCheckBox *m_useCppDebugger;
    QCheckBox *m_useQmlDebugger;
    QSpinBox *m_debugServerPort;
    QLabel *m_debugServerPortLabel;
    QLabel *m_qmlDebuggerInfoLabel;
183
    QCheckBox *m_useMultiProcess;
184
185
};

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

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

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

197
    m_debugServerPortLabel = new QLabel(tr("Debug port:"), this);
198
199
200
201
202
203
    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>"));

204
205
206
    m_useCppDebugger->setChecked(m_aspect->useCppDebugger());
    m_useQmlDebugger->setChecked(m_aspect->useQmlDebugger());

207
    m_debugServerPort->setValue(m_aspect->qmlDebugServerPort());
208

209
210
211
212
213
214
    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());

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

226
227
228
    if (m_aspect->isDisplaySuppressed())
        hide();

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

235
236
237
    if (m_aspect->areCppDebuggingOptionsSuppressed())
        m_useCppDebugger->hide();

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

243
244
245
246
247
248
249
250
251
252
253
254
    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);
255
    layout->addWidget(m_useMultiProcess);
256
257
258
    setLayout(layout);
}

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

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

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

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

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

288
289
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
290
// DebuggerRunControlPrivate
291
292
293
//
////////////////////////////////////////////////////////////////////////

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

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

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

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

hjk's avatar
hjk committed
321
322
} // namespace Internal

hjk's avatar
hjk committed
323
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
324
325
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
326
    : RunControl(runConfiguration, ProjectExplorer::DebugRunMode),
327
      d(new DebuggerRunControlPrivate(this, runConfiguration))
328
{
hjk's avatar
hjk committed
329
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
330
331
332
333
334
335
336
    // 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);
337
338
339
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
340
        debuggingFinished();
hjk's avatar
hjk committed
341
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
342
    }
343
344
}

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

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

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

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

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

379
void DebuggerRunControl::start()
380
{
381
    QTC_ASSERT(d->m_engine, return);
382
383
384
    // 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
385
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
386
387
388
389
390
        emit started();
        emit finished();
        return;
    }

391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
    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;
            }
407
408
409
        }
    }

410
    debuggerCore()->runControlStarted(d->m_engine);
411

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

417
    d->m_engine->startDebugger(this);
418

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

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

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

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

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

458
459
460
    if (optionalPrompt && !*optionalPrompt)
        return true;

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

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

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

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

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

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

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

506
507
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
508
509
510
511
512
513
514
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
515
516
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
517
518
519
520
521
522
523
524
525
        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);
        }
526
527
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
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
579
580
        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,
581
                                                DebuggerLanguages languages,
582
583
584
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
585
586
587
588
589
590
591
592
593
594
595
596

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

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

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

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
        }
        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;

658
    result = enginesForMode(sp.startMode, sp.languages, true);
659
660
661
662
663
664
    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()) {
665
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
666
667
668
669
670
        if (!result.isEmpty())
            return result;
    }

    // FIXME: 1 of 3 testing hacks.
671
    if (sp.processArgs.startsWith(QLatin1String("@tcf@ "))) {
672
673
674
675
        result.push_back(GdbEngineType);
        return result;
    }

676
677
678
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
            && !sp.executable.isEmpty())
679
680
681
682
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

683
    result = enginesForMode(sp.startMode, sp.languages, false);
684
685
686
687
688
689
690
691
692
693
694
    return result;
}

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

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

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

705
706
707
708
709
710
711
712
713
714
// 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.").
715
                                       arg(QLatin1String(engineTypeName(et))));
716
717
718
719
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
720
    case CdbEngineType:
721
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
722
    case GdbEngineType:
723
724
725
726
727
728
729
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

730
/*!
731
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
732
733
734
735
736
737
738
739
740

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

762
763
764
765
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
766
            result.errorDetails.clear();
767
768
            usableType = et;
            break;
769
        } else {
770
            unavailableTypes.push_back(et);
771
        }
772
    }
773
774
775
776
777
778
    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());
779
        } else {
780
781
782
783
            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());
784
        }
785
        return result;
786
    }
787
    if (debug)
788
789
790
791
792
793
        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").
794
                arg(sp.toolChainAbi.toString(), QLatin1String(engineTypeName(usableType)),
795
796
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
797
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
798
799
    }
    // Anything left: Happy.
800
801
    result.errorMessage.clear();
    result.errorDetails.clear();
802
803
804
805
806
807
808
809
810
811
812


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

813
814
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
815
816
    return result;
}
817
818
819
820
821
822
823
824
825
826
827
828
829

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

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

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

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
838
    return DebuggerRunControl::tr("Debug");
839
840
841
}

// Find Qt installation by running qmake
842
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
843
844
845
{
    QProcess proc;
    QStringList args;
846
847
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
848
    proc.start(qmakePath.toString(), args);
849
    if (!proc.waitForStarted()) {
850
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
851
852
853
854
855
856
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
857
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
858
859
860
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
861
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
        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();
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
    sp.processArgs = rc->commandLineArguments();
892
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
893
    if (!sp.toolChainAbi.isValid()) {
Tobias Hunger's avatar
Tobias Hunger committed
894
        QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(sp.executable));
Tobias Hunger's avatar
Tobias Hunger committed
895
896
897
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
898
899
900
901
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

902
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
903
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
904
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
905
906
907
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
908
        if (const ProjectExplorer::Project *project = target->project()) {
909
910
911
912
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
913
                    sp.debuggerCommand = tc->debuggerCommand().toString();
914
915
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
916
917
918
        }
    }

919
920
921
922
    DebuggerRunConfigurationAspect *aspect = runConfiguration->debuggerAspect();
    sp.multiProcess = aspect->useMultiProcess();

    if (aspect->useCppDebugger())
923
924
        sp.languages |= CppLanguage;

925
    if (aspect->useQmlDebugger()) {
926
        sp.qmlServerAddress = _("127.0.0.1");
927
        sp.qmlServerPort = aspect->qmlDebugServerPort();
928
        sp.languages |= QmlLanguage;
929

930
931
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
932
933
934
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
935
936
        }

937
938
        Utils::QtcProcess::addArg(&sp.processArgs,
                                  QString::fromLatin1("-qmljsdebugger=port:%1,block").arg(sp.qmlServerPort));
939
940
941
942
943
944
945
946
947
948
949
950
    }

    // 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;
    sp.displayName = rc->displayName();

    return sp;
}

RunControl *DebuggerRunControlFactory::create
951
    (RunConfiguration *runConfiguration, RunMode mode)
952
{
953
    QTC_ASSERT(mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain, return 0);
954
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
955
956
    if (sp.startMode == NoStartMode)
        return 0;
957
    if (mode == DebugRunModeWithBreakOnMain)
958
        sp.breakOnMain = true;
959
960
961
    return create(sp, runConfiguration);
}

962
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
963
964
    (RunConfiguration *runConfiguration)
{
965
    return new DebuggerRunConfigWidget(runConfiguration);
966
967
968
}

DebuggerRunControl *DebuggerRunControlFactory::create
969
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
970
{
971
    const ConfigurationCheck check = checkDebugConfiguration(sp);
972

973
    if (!check) {
974
        //appendMessage(errorMessage, true);
hjk's avatar
hjk committed
975
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
976
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
977
978
979
        return