debuggerrunner.cpp 32.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
170
171

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

public:
    DebuggerProjectSettings *m_settings; // 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_settings = 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
205
    useCppDebuggerToggled(m_settings->useCppDebugger());
    useQmlDebuggerToggled(m_settings->useQmlDebugger());
    m_debugServerPort->setValue(m_settings->qmlDebugServerPort());

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
215
216
217
218
219
            SLOT(qmlDebugServerPortChanged(int)));

    if (m_settings->areQmlDebuggingOptionsSuppressed()) {
        m_debugServerPortLabel->hide();
        m_debugServerPort->hide();
        m_useQmlDebugger->hide();
    }
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

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

236
void DebuggerRunConfigWidget::qmlDebugServerPortChanged(int port)
237
{
238
    m_settings->m_qmlDebugServerPort = port;
239
240
}

241
void DebuggerRunConfigWidget::useCppDebuggerToggled(bool toggled)
242
{
243
    m_settings->m_useCppDebugger = toggled;
244
245
246
247
    if (!toggled && !m_useQmlDebugger->isChecked())
        m_useQmlDebugger->setChecked(true);
}

248
void DebuggerRunConfigWidget::useQmlDebuggerToggled(bool toggled)
249
{
250
251
252
253
254
255
    m_debugServerPort->setEnabled(toggled);
    m_debugServerPortLabel->setEnabled(toggled);

    m_settings->m_useQmlDebugger = toggled
            ? DebuggerProjectSettings::EnableQmlDebugger
            : DebuggerProjectSettings::DisableQmlDebugger;
256
257
258
259
    if (!toggled && !m_useCppDebugger->isChecked())
        m_useCppDebugger->setChecked(true);
}

260
261
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
262
// DebuggerRunControlPrivate
263
264
265
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
266
267
268
class DebuggerRunControlPrivate
{
public:
269
270
    explicit DebuggerRunControlPrivate(DebuggerRunControl *parent,
                                       RunConfiguration *runConfiguration);
271

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

public:
    DebuggerRunControl *q;
279
280
281
282
283
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
};

hjk's avatar
hjk committed
284
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
285
                                                     RunConfiguration *runConfiguration)
hjk's avatar
hjk committed
286
287
    : q(parent)
    , m_engine(0)
288
    , m_myRunConfiguration(runConfiguration)
289
    , m_running(false)
290
291
{
}
292

hjk's avatar
hjk committed
293
294
} // namespace Internal

hjk's avatar
hjk committed
295
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
296
297
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
298
    : RunControl(runConfiguration, ProjectExplorer::DebugRunMode),
299
      d(new DebuggerRunControlPrivate(this, runConfiguration))
300
{
hjk's avatar
hjk committed
301
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
302
303
304
305
306
307
308
    // 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);
309
310
311
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
312
        debuggingFinished();
hjk's avatar
hjk committed
313
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
314
    }
315
316
}

hjk's avatar
hjk committed
317
318
319
320
321
322
323
324
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
hjk's avatar
hjk committed
325
    delete d;
hjk's avatar
hjk committed
326
327
328
329
330
331
332
333
}

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

334
QString DebuggerRunControl::displayName() const
335
{
336
337
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
338
339
}

340
341
QIcon DebuggerRunControl::icon() const
{
342
    return QIcon(QLatin1String(ProjectExplorer::Constants::ICON_DEBUG_SMALL));
343
344
}

345
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
346
{
347
    QTC_ASSERT(d->m_engine, return);
348
    d->m_engine->startParameters().environment = env;
349
350
}

351
void DebuggerRunControl::start()
352
{
353
    QTC_ASSERT(d->m_engine, return);
354
355
356
    // 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
357
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
358
359
360
361
362
        emit started();
        emit finished();
        return;
    }

363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
    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;
            }
379
380
381
        }
    }

382
    debuggerCore()->runControlStarted(d->m_engine);
383

384
385
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
386
    emit started();
387
388
    d->m_running = true;

389
    d->m_engine->startDebugger(this);
390

391
    if (d->m_running)
con's avatar
con committed
392
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
393
394
}

395
void DebuggerRunControl::startFailed()
396
{
con's avatar
con committed
397
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
398
    d->m_running = false;
399
    emit finished();
400
    d->m_engine->handleStartFailed();
401
402
}

403
void DebuggerRunControl::handleFinished()
404
{
con's avatar
con committed
405
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
406
407
408
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
409
410
}

411
void DebuggerRunControl::showMessage(const QString &msg, int channel)
412
{
413
414
    switch (channel) {
        case AppOutput:
con's avatar
con committed
415
            appendMessage(msg, Utils::StdOutFormatSameLine);
416
417
            break;
        case AppError:
con's avatar
con committed
418
            appendMessage(msg, Utils::StdErrFormatSameLine);
419
420
            break;
        case AppStuff:
421
            appendMessage(msg, Utils::DebugFormat);
422
423
            break;
    }
424
425
}

426
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
427
{
428
429
    QTC_ASSERT(isRunning(), return true;)

430
431
432
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
433
    const QString question = tr("A debugging session is still in progress. "
434
435
436
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
437
438
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
439
440
441
442
}

RunControl::StopResult DebuggerRunControl::stop()
{
443
444
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
445
    return AsynchronousStop;
446
447
}

448
void DebuggerRunControl::debuggingFinished()
449
{
450
    d->m_running = false;
451
    emit finished();
452
453
}

454
bool DebuggerRunControl::isRunning() const
455
{
456
    return d->m_running;
457
458
}

459
DebuggerEngine *DebuggerRunControl::engine()
460
{
461
    QTC_CHECK(d->m_engine);
462
    return d->m_engine;
463
464
}

465
466
467
468
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
469

470
471
////////////////////////////////////////////////////////////////////////
//
472
// Engine detection logic: Detection functions depending on tool chain, binary,
473
474
475
476
477
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

478
479
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
480
481
482
483
484
485
486
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
487
488
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
489
490
491
492
493
494
495
496
497
        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);
        }
498
499
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
500
501
502
503
504
505
506
507
508
509
510
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
        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,
553
                                                DebuggerLanguages languages,
554
555
556
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
557
558
559
560
561
562
563
564
565
566
567
568

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

569
    switch (startMode) {
hjk's avatar
hjk committed
570
    case NoStartMode:
571
        break;
hjk's avatar
hjk committed
572
573
    case StartInternal:
    case StartExternal:
574
575
576
577
578
579
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
580
581
582

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
583
584
        }
        break;
hjk's avatar
hjk committed
585
    case AttachCore:
586
587
588
589
590
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
591
    case StartRemoteProcess:
hjk's avatar
hjk committed
592
    case StartRemoteGdb:
593
        result.push_back(GdbEngineType);
594
595
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
596
        break;
597
    case AttachToRemoteProcess:
598
    case AttachToRemoteServer:
599
600
601
602
603
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
604
605
606

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
        }
        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;

630
    result = enginesForMode(sp.startMode, sp.languages, true);
631
632
633
634
635
636
    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()) {
637
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
638
639
640
641
642
        if (!result.isEmpty())
            return result;
    }

    // FIXME: 1 of 3 testing hacks.
643
    if (sp.processArgs.startsWith(QLatin1String("@tcf@ "))) {
644
645
646
647
        result.push_back(GdbEngineType);
        return result;
    }

648
649
650
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
            && !sp.executable.isEmpty())
651
652
653
654
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

655
    result = enginesForMode(sp.startMode, sp.languages, false);
656
657
658
659
660
661
662
663
664
665
666
    return result;
}

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

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
667
668
669
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
670
671
672
673
674
}

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

677
678
679
680
681
682
683
684
685
686
// 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.").
687
                                       arg(QLatin1String(engineTypeName(et))));
688
689
690
691
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
692
    case CdbEngineType:
693
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
694
    case GdbEngineType:
695
696
697
698
699
700
701
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

702
/*!
703
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
704
705
706
707
708
709
710
711
712

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

734
735
736
737
738
739
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
740
        } else {
741
            unavailableTypes.push_back(et);
742
        }
743
    }
744
745
746
747
748
749
    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());
750
        } else {
751
752
753
754
            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());
755
        }
756
        return result;
757
    }
758
    if (debug)
759
760
761
762
763
764
        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").
765
                arg(sp.toolChainAbi.toString(), QLatin1String(engineTypeName(usableType)),
766
767
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
768
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
769
770
    }
    // Anything left: Happy.
771
772
    result.errorMessage.clear();
    result.errorDetails.clear();
773
774
775
776
777
778
779
780
781
782
783


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

784
785
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
786
787
    return result;
}
788
789
790
791
792
793
794
795
796
797
798
799
800

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

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

801
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, RunMode mode) const
802
{
803
    return (mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain)
804
805
806
807
808
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
809
    return DebuggerRunControl::tr("Debug");
810
811
812
}

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

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

858
    sp.executable = rc->executable();
859
860
861
    if (sp.executable.isEmpty())
        return sp;
    sp.startMode = StartInternal;
862
    sp.processArgs = rc->commandLineArguments();
863
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
864
    if (!sp.toolChainAbi.isValid()) {
Tobias Hunger's avatar
Tobias Hunger committed
865
        QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(sp.executable));
Tobias Hunger's avatar
Tobias Hunger committed
866
867
868
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
869
870
871
872
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

873
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
874
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
875
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
876
877
878
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
879
        if (const ProjectExplorer::Project *project = target->project()) {
880
881
882
883
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
884
                    sp.debuggerCommand = tc->debuggerCommand().toString();
885
886
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
887
888
889
        }
    }

890
    if (runConfiguration->debuggerAspect()->useCppDebugger())
891
892
        sp.languages |= CppLanguage;

893
    if (runConfiguration->debuggerAspect()->useQmlDebugger()) {
894
        sp.qmlServerAddress = _("127.0.0.1");
895
        sp.qmlServerPort = runConfiguration->debuggerAspect()->qmlDebugServerPort();
896
        sp.languages |= QmlLanguage;
897

898
899
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
900
901
902
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
903
904
        }

905
906
        Utils::QtcProcess::addArg(&sp.processArgs,
                                  QString::fromLatin1("-qmljsdebugger=port:%1,block").arg(sp.qmlServerPort));
907
908
909
910
911
912
913
914
915
916
917
918
    }

    // 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
919
    (RunConfiguration *runConfiguration, RunMode mode)
920
{
921
    QTC_ASSERT(mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain, return 0);
922
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
923
924
    if (sp.startMode == NoStartMode)
        return 0;
925
    if (mode == DebugRunModeWithBreakOnMain)
926
        sp.breakOnMain = true;
927
928
929
    return create(sp, runConfiguration);
}

930
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
931
932
    (RunConfiguration *runConfiguration)
{
933
    return new DebuggerRunConfigWidget(runConfiguration);
934
935
936
}

DebuggerRunControl *DebuggerRunControlFactory::create
937
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
938
{
939
    const ConfigurationCheck check = checkDebugConfiguration(sp);
940

941
    if (!check) {
942
        //appendMessage(errorMessage, true);
hjk's avatar
hjk committed
943
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
944
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
945
946
947
        return 0;
    }

948
949
950
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
951
952
953
954
955
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
956
957
958
959
960
961
962
963
964
965
966
967
968
969
{
    switch (et) {
    case GdbEngineType:
        return createGdbEngine(sp, masterEngine);
    case ScriptEngineType:
        return createScriptEngine(sp);
    case CdbEngineType:
        return createCdbEngine(sp, masterEngine, errorMessage);
    case