debuggerrunner.cpp 33.8 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>
con's avatar
con committed
54
55
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
56
#include <projectexplorer/target.h>
57
#include <projectexplorer/buildconfiguration.h>
58
#include <projectexplorer/toolchain.h>
59
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*
con's avatar
con committed
60

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

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

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

82
83
enum { debug = 0 };

84
namespace Debugger {
85
namespace Internal {
86

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

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

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

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

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

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

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

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

154
155
156
157
158
159
////////////////////////////////////////////////////////////////////////
//
// DebuggerRunConfigWidget
//
////////////////////////////////////////////////////////////////////////

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

505
506
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
507
508
509
510
511
512
513
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
514
515
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
516
517
518
519
520
521
522
        break;
   case Abi::PEFormat:
        if (toolChain.osFlavor() == Abi::WindowsMSysFlavor) {
            result.push_back(GdbEngineType);
            result.push_back(CdbEngineType);
        } else {
            result.push_back(CdbEngineType);
523
            //result.push_back(GdbEngineType);
524
        }
525
526
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
        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,
580
                                                DebuggerLanguages languages,
581
582
583
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
584
585
586
587
588
589
590
591
592
593
594
595

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

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

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

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

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

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

675
676
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
hjk's avatar
hjk committed
677
            && sp.startMode != LoadRemoteCore
678
            && !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
{
hjk's avatar
hjk committed
838
    return DebuggerPlugin::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::showWarningWit