debuggerrunner.cpp 35.5 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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
////////////////////////////////////////////////////////////////////////
//
// DebuggerRunConfigWidget
//
////////////////////////////////////////////////////////////////////////

class DebuggerLanguageChooser : public QWidget
{
    Q_OBJECT

public:
    explicit DebuggerLanguageChooser(QWidget *parent = 0);

    bool cppChecked() const;
    bool qmlChecked() const;
    uint qmlDebugServerPort() const;

    void setCppChecked(bool value);
    void setQmlChecked(bool value);
    void setQmlDebugServerPort(uint port);

signals:
    void cppLanguageToggled(bool value);
    void qmlLanguageToggled(bool value);
    void qmlDebugServerPortChanged(uint port);
    void openHelpUrl(const QString &url);

private slots:
    void useCppDebuggerToggled(bool toggled);
    void useQmlDebuggerToggled(bool toggled);
    void onDebugServerPortChanged(int port);

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

DebuggerLanguageChooser::DebuggerLanguageChooser(QWidget *parent)
    : QWidget(parent)
{
    m_useCppDebugger = new QCheckBox(tr("C++"), this);
    m_useQmlDebugger = new QCheckBox(tr("QML"), this);

    connect(m_useCppDebugger, SIGNAL(toggled(bool)),
            this, SLOT(useCppDebuggerToggled(bool)));
    connect(m_useQmlDebugger, SIGNAL(toggled(bool)),
            this, SLOT(useQmlDebuggerToggled(bool)));

    m_debugServerPortLabel = new QLabel(tr("Debug port:"), this);
    m_debugServerPort = new QSpinBox(this);
    m_debugServerPort->setMinimum(1);
    m_debugServerPort->setMaximum(65535);

    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>"));

    connect(m_qmlDebuggerInfoLabel, SIGNAL(linkActivated(QString)),
        this, SIGNAL(openHelpUrl(QString)));
    connect(m_useQmlDebugger, SIGNAL(toggled(bool)),
        m_debugServerPort, SLOT(setEnabled(bool)));
    connect(m_useQmlDebugger, SIGNAL(toggled(bool)),
        m_debugServerPortLabel, SLOT(setEnabled(bool)));
    connect(m_debugServerPort, SIGNAL(valueChanged(int)),
        this, SLOT(onDebugServerPortChanged(int)));

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

bool DebuggerLanguageChooser::cppChecked() const
{
    return m_useCppDebugger->isChecked();
}

bool DebuggerLanguageChooser::qmlChecked() const
{
    return m_useQmlDebugger->isChecked();
}

uint DebuggerLanguageChooser::qmlDebugServerPort() const
{
    return m_debugServerPort->value();
}

void DebuggerLanguageChooser::setCppChecked(bool value)
{
    m_useCppDebugger->setChecked(value);
}

void DebuggerLanguageChooser::setQmlChecked(bool value)
{
    m_useQmlDebugger->setChecked(value);
    m_debugServerPortLabel->setEnabled(value);
    m_debugServerPort->setEnabled(value);
}

void DebuggerLanguageChooser::setQmlDebugServerPort(uint port)
{
    m_debugServerPort->setValue(port);
}

void DebuggerLanguageChooser::useCppDebuggerToggled(bool toggled)
{
    emit cppLanguageToggled(toggled);
    if (!toggled && !m_useQmlDebugger->isChecked())
        m_useQmlDebugger->setChecked(true);
}

void DebuggerLanguageChooser::useQmlDebuggerToggled(bool toggled)
{
    emit qmlLanguageToggled(toggled);
    if (!toggled && !m_useCppDebugger->isChecked())
        m_useCppDebugger->setChecked(true);
}

void DebuggerLanguageChooser::onDebugServerPortChanged(int port)
{
    emit qmlDebugServerPortChanged((uint)port);
}

class DebuggerRunConfigWidget : public ProjectExplorer::RunConfigWidget
{
    Q_OBJECT

public:
    explicit DebuggerRunConfigWidget(RunConfiguration *runConfiguration)
    {
        m_settings = runConfiguration->debuggerAspect();

        QLabel *debuggerLabel = new QLabel(tr("Languages:"), this);
        debuggerLabel->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::MinimumExpanding);

        m_debuggerLanguageChooser = new DebuggerLanguageChooser(this);
        m_debuggerLanguageChooser->setCppChecked(m_settings->useCppDebugger());
        m_debuggerLanguageChooser->setQmlChecked(runConfiguration->useQmlDebugger());
        m_debuggerLanguageChooser->setQmlDebugServerPort(m_settings->qmlDebugServerPort());

        QFormLayout *layout = new QFormLayout(this);
        layout->addRow(debuggerLabel, m_debuggerLanguageChooser);
        setLayout(layout);

        connect(m_debuggerLanguageChooser, SIGNAL(cppLanguageToggled(bool)),
                this, SLOT(useCppDebuggerToggled(bool)));
        connect(m_debuggerLanguageChooser, SIGNAL(qmlLanguageToggled(bool)),
                this, SLOT(useQmlDebuggerToggled(bool)));
        connect(m_debuggerLanguageChooser, SIGNAL(qmlDebugServerPortChanged(uint)),
                this, SLOT(qmlDebugServerPortChanged(uint)));
        connect(m_debuggerLanguageChooser, SIGNAL(openHelpUrl(QString)),
                Core::HelpManager::instance(), SLOT(handleHelpRequest(QString)));
    }

    QString displayName() const
    {
        return tr("Debugger Settings");
    }

public slots:
    void useCppDebuggerToggled(bool toggled)
    {
        m_settings->m_useCppDebugger = toggled;
    }

    void useQmlDebuggerToggled(bool toggled)
    {
        m_settings->m_useQmlDebugger = toggled
                ? DebuggerProjectSettings::EnableQmlDebugger
                : DebuggerProjectSettings::DisableQmlDebugger;
    }

    void qmlDebugServerPortChanged(uint port)
    {
        m_settings->m_qmlDebugServerPort = port;
    }

public:
    DebuggerProjectSettings *m_settings; // not owned
    DebuggerLanguageChooser *m_debuggerLanguageChooser; // owned
};

352
353
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
354
// DebuggerRunControlPrivate
355
356
357
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
358
359
360
class DebuggerRunControlPrivate
{
public:
361
362
    explicit DebuggerRunControlPrivate(DebuggerRunControl *parent,
                                       RunConfiguration *runConfiguration);
363

hjk's avatar
hjk committed
364
365
366
367
368
369
370
    DebuggerEngineType engineForExecutable(unsigned enabledEngineTypes,
        const QString &executable);
    DebuggerEngineType engineForMode(unsigned enabledEngineTypes,
        DebuggerStartMode mode);

public:
    DebuggerRunControl *q;
371
372
373
374
375
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
};

hjk's avatar
hjk committed
376
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
377
                                                     RunConfiguration *runConfiguration)
hjk's avatar
hjk committed
378
379
    : q(parent)
    , m_engine(0)
380
    , m_myRunConfiguration(runConfiguration)
381
    , m_running(false)
382
383
{
}
384

hjk's avatar
hjk committed
385
386
} // namespace Internal

hjk's avatar
hjk committed
387
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
388
389
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
390
    : RunControl(runConfiguration, ProjectExplorer::DebugRunMode),
391
      d(new DebuggerRunControlPrivate(this, runConfiguration))
392
{
hjk's avatar
hjk committed
393
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
394
395
396
397
398
399
400
    // 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);
401
402
403
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
404
        debuggingFinished();
hjk's avatar
hjk committed
405
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
406
    }
407
408
}

hjk's avatar
hjk committed
409
410
411
412
413
414
415
416
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
hjk's avatar
hjk committed
417
    delete d;
hjk's avatar
hjk committed
418
419
420
421
422
423
424
425
}

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

426
QString DebuggerRunControl::displayName() const
427
{
428
429
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
430
431
}

432
433
QIcon DebuggerRunControl::icon() const
{
434
    return QIcon(QLatin1String(ProjectExplorer::Constants::ICON_DEBUG_SMALL));
435
436
}

437
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
438
{
439
    QTC_ASSERT(d->m_engine, return);
440
    d->m_engine->startParameters().environment = env;
441
442
}

443
void DebuggerRunControl::start()
444
{
445
    QTC_ASSERT(d->m_engine, return);
446
447
448
    // 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
449
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
450
451
452
453
454
        emit started();
        emit finished();
        return;
    }

455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
    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;
            }
471
472
473
        }
    }

474
    debuggerCore()->runControlStarted(d->m_engine);
475

476
477
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
478
    emit started();
479
480
    d->m_running = true;

481
    d->m_engine->startDebugger(this);
482

483
    if (d->m_running)
con's avatar
con committed
484
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
485
486
}

487
void DebuggerRunControl::startFailed()
488
{
con's avatar
con committed
489
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
490
    d->m_running = false;
491
    emit finished();
492
    d->m_engine->handleStartFailed();
493
494
}

495
void DebuggerRunControl::handleFinished()
496
{
con's avatar
con committed
497
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
498
499
500
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
501
502
}

503
void DebuggerRunControl::showMessage(const QString &msg, int channel)
504
{
505
506
    switch (channel) {
        case AppOutput:
con's avatar
con committed
507
            appendMessage(msg, Utils::StdOutFormatSameLine);
508
509
            break;
        case AppError:
con's avatar
con committed
510
            appendMessage(msg, Utils::StdErrFormatSameLine);
511
512
            break;
        case AppStuff:
513
            appendMessage(msg, Utils::DebugFormat);
514
515
            break;
    }
516
517
}

518
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
519
{
520
521
    QTC_ASSERT(isRunning(), return true;)

522
523
524
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
525
    const QString question = tr("A debugging session is still in progress. "
526
527
528
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
529
530
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
531
532
533
534
}

RunControl::StopResult DebuggerRunControl::stop()
{
535
536
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
537
    return AsynchronousStop;
538
539
}

540
void DebuggerRunControl::debuggingFinished()
541
{
542
    d->m_running = false;
543
    emit finished();
544
545
}

546
bool DebuggerRunControl::isRunning() const
547
{
548
    return d->m_running;
549
550
}

551
DebuggerEngine *DebuggerRunControl::engine()
552
{
553
    QTC_CHECK(d->m_engine);
554
    return d->m_engine;
555
556
}

557
558
559
560
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
561

562
563
////////////////////////////////////////////////////////////////////////
//
564
// Engine detection logic: Detection functions depending on tool chain, binary,
565
566
567
568
569
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

570
571
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
572
573
574
575
576
577
578
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
579
580
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
581
582
583
584
585
586
587
588
589
        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);
        }
590
591
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
        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,
645
                                                DebuggerLanguages languages,
646
647
648
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
649
650
651
652
653
654
655
656
657
658
659
660

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

661
    switch (startMode) {
hjk's avatar
hjk committed
662
    case NoStartMode:
663
        break;
hjk's avatar
hjk committed
664
665
    case StartInternal:
    case StartExternal:
666
667
668
669
670
671
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
672
673
674

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
675
676
        }
        break;
hjk's avatar
hjk committed
677
    case AttachCore:
678
679
680
681
682
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
683
    case StartRemoteProcess:
hjk's avatar
hjk committed
684
    case StartRemoteGdb:
685
        result.push_back(GdbEngineType);
686
687
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
688
        break;
689
    case AttachToRemoteProcess:
690
    case AttachToRemoteServer:
691
692
693
694
695
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
696
697
698

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
        }
        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;

722
    result = enginesForMode(sp.startMode, sp.languages, true);
723
724
725
726
727
728
    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()) {
729
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
730
731
732
733
734
        if (!result.isEmpty())
            return result;
    }

    // FIXME: 1 of 3 testing hacks.
735
    if (sp.processArgs.startsWith(QLatin1String("@tcf@ "))) {
736
737
738
739
        result.push_back(GdbEngineType);
        return result;
    }

740
741
742
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
            && !sp.executable.isEmpty())
743
744
745
746
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

747
    result = enginesForMode(sp.startMode, sp.languages, false);
748
749
750
751
752
753
754
755
756
757
758
    return result;
}

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

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
759
760
761
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
762
763
764
765
766
}

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

769
770
771
772
773
774
775
776
777
778
// 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.").
779
                                       arg(QLatin1String(engineTypeName(et))));
780
781
782
783
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
784
    case CdbEngineType:
785
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
786
    case GdbEngineType:
787
788
789
790
791
792
793
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

794
/*!
795
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
796
797
798
799
800
801
802
803
804

    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;
805
806
807
808
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
809
    // Get all applicable types.
810
    QList<DebuggerEngineType> requiredTypes = engineTypes(sp);
811
    if (requiredTypes.isEmpty()) {
Friedemann Kleint's avatar
Friedemann Kleint committed
812
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
813
814
        return result;
    }
815
816
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
817
    // Filter out disabled types, command line + current settings.
818
819
    unsigned cmdLineEnabledEngines = debuggerCore()->enabledEngines();
#ifdef WITH_LLDB
hjk's avatar
hjk committed
820
    if (!Core::ICore::settings()->value(QLatin1String("LLDB/enabled")).toBool())
821
822
823
824
        cmdLineEnabledEngines &= ~LldbEngineType;
#else
     cmdLineEnabledEngines &= ~LldbEngineType;
#endif
825

826
827
828
829
830
831
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
832
        } else {
833
            unavailableTypes.push_back(et);
834
        }
835
    }
836
837
838
839
840
841
    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());
842
        } else {
843
844
845
846
            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());
847
        }
848
        return result;
849
    }
850
    if (debug)
851
852
853
854
855
856
        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").
857
                arg(sp.toolChainAbi.toString(), QLatin1String(engineTypeName(usableType)),
858
859
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
860
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
861
862
    }
    // Anything left: Happy.
863
864
    result.errorMessage.clear();
    result.errorDetails.clear();
865
866
867
868
869
870
871
872
873
874
875


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

876
877
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
878
879
    return result;
}
880
881
882
883
884
885
886
887
888
889
890
891
892

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

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

893
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, RunMode mode) const
894
{
895
    return (mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain)
896
897
898
899
900
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
901
    return DebuggerRunControl::tr("Debug");
902
903
904
}

// Find Qt installation by running qmake
905
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
906
907
908
{
    QProcess proc;
    QStringList args;
909
910
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
911
    proc.start(qmakePath.toString(), args);
912
    if (!proc.waitForStarted()) {
913
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
914
915
916
917
918
919
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
920
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
921
922
923
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
924
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
        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();
944
945
946
947
948
949

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

950
    sp.executable = rc->executable();
951
952
953
    if (sp.executable.isEmpty())
        return sp;
    sp.startMode = StartInternal;
954
    sp.processArgs = rc->commandLineArguments();
955
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
956
    if (!sp.toolChainAbi.isValid()) {
Tobias Hunger's avatar
Tobias Hunger committed
957
        QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(sp.executable));
Tobias Hunger's avatar
Tobias Hunger committed
958
959
960
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
961
962
963
964
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

965
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
966
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
967
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
968
969
970
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
971
        if (const ProjectExplorer::Project *project = target->project()) {
972
973
974
975
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
976
                    sp.debuggerCommand = tc->debuggerCommand().toString();
977
978
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
979
980
981
        }
    }

982
    if (runConfiguration->debuggerAspect()->useCppDebugger())
983
984
985
        sp.languages |= CppLanguage;

    if (runConfiguration->useQmlDebugger()) {
986
        sp.qmlServerAddress = _("127.0.0.1");
987
        sp.qmlServerPort = runConfiguration->debuggerAspect()->qmlDebugServerPort();
988
        sp.languages |= QmlLanguage;
989

990
991
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
992
993
994
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
995
996
        }

997
998
        Utils::QtcProcess::addArg(&sp.processArgs,
                                  QString::fromLatin1("-qmljsdebugger=port:%1,block").arg(sp.qmlServerPort));
999
1000
    }

For faster browsing, not all history is shown. View entire blame