debuggerrunner.cpp 28.4 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 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 <utils/buildablehelperlibrary.h>
hjk's avatar
hjk committed
69

con's avatar
con committed
70
#include <QtCore/QDir>
71
#include <QtCore/QDebug>
72
#include <QtGui/QMessageBox>
73
#include <QtGui/QErrorMessage>
con's avatar
con committed
74

75
using namespace ProjectExplorer;
76
77
using namespace Debugger::Internal;

78
79
enum { debug = 0 };

80
namespace Debugger {
81
namespace Internal {
82

hjk's avatar
hjk committed
83
bool isCdbEngineEnabled(); // Check the configuration page
84
bool checkCdbConfiguration(const DebuggerStartParameters &sp, ConfigurationCheck *check);
hjk's avatar
hjk committed
85
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &sp,
86
    DebuggerEngine *masterEngine, QString *error);
87
88

bool checkGdbConfiguration(const DebuggerStartParameters &sp, ConfigurationCheck *check);
hjk's avatar
hjk committed
89
DebuggerEngine *createGdbEngine(const DebuggerStartParameters &sp,
90
    DebuggerEngine *masterEngine);
91

hjk's avatar
hjk committed
92
93
DebuggerEngine *createScriptEngine(const DebuggerStartParameters &sp);
DebuggerEngine *createPdbEngine(const DebuggerStartParameters &sp);
94
QmlEngine *createQmlEngine(const DebuggerStartParameters &sp,
95
    DebuggerEngine *masterEngine);
96
97
98
DebuggerEngine *createQmlCppEngine(const DebuggerStartParameters &sp,
                                   DebuggerEngineType slaveEngineType,
                                   QString *errorMessage);
hjk's avatar
hjk committed
99
DebuggerEngine *createLldbEngine(const DebuggerStartParameters &sp);
100

hjk's avatar
hjk committed
101
extern QString msgNoBinaryForToolChain(const Abi &abi);
102

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

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

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

145
146
147
148
149
static inline QString msgEngineNotAvailable(DebuggerEngineType et)
{
    return msgEngineNotAvailable(engineTypeName(et));
}

150
151
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
152
// DebuggerRunControlPrivate
153
154
155
//
////////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
156
157
158
class DebuggerRunControlPrivate
{
public:
159
160
    explicit DebuggerRunControlPrivate(DebuggerRunControl *parent,
                                       RunConfiguration *runConfiguration);
161

hjk's avatar
hjk committed
162
163
164
165
166
167
168
    DebuggerEngineType engineForExecutable(unsigned enabledEngineTypes,
        const QString &executable);
    DebuggerEngineType engineForMode(unsigned enabledEngineTypes,
        DebuggerStartMode mode);

public:
    DebuggerRunControl *q;
169
170
171
172
173
    DebuggerEngine *m_engine;
    const QWeakPointer<RunConfiguration> m_myRunConfiguration;
    bool m_running;
};

hjk's avatar
hjk committed
174
DebuggerRunControlPrivate::DebuggerRunControlPrivate(DebuggerRunControl *parent,
175
                                                     RunConfiguration *runConfiguration)
hjk's avatar
hjk committed
176
177
    : q(parent)
    , m_engine(0)
178
    , m_myRunConfiguration(runConfiguration)
179
    , m_running(false)
180
181
{
}
182

hjk's avatar
hjk committed
183
184
} // namespace Internal

hjk's avatar
hjk committed
185
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
186
187
                                       const DebuggerStartParameters &sp,
                                       const QPair<DebuggerEngineType, DebuggerEngineType> &masterSlaveEngineTypes)
hjk's avatar
hjk committed
188
    : RunControl(runConfiguration, Constants::DEBUGMODE),
189
      d(new DebuggerRunControlPrivate(this, runConfiguration))
190
{
hjk's avatar
hjk committed
191
    connect(this, SIGNAL(finished()), SLOT(handleFinished()));
192
193
194
195
196
197
198
    // 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);
199
200
201
    if (d->m_engine) {
        DebuggerToolTipManager::instance()->registerEngine(d->m_engine);
    } else {
202
        debuggingFinished();
203
        Core::ICore::instance()->showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
204
    }
205
206
}

hjk's avatar
hjk committed
207
208
209
210
211
212
213
214
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    if (DebuggerEngine *engine = d->m_engine) {
        d->m_engine = 0;
        engine->disconnect();
        delete engine;
    }
hjk's avatar
hjk committed
215
    delete d;
hjk's avatar
hjk committed
216
217
218
219
220
221
222
223
}

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

224
QString DebuggerRunControl::displayName() const
225
{
226
227
    QTC_ASSERT(d->m_engine, return QString());
    return d->m_engine->startParameters().displayName;
228
229
}

230
231
232
233
234
QIcon DebuggerRunControl::icon() const
{
    return QIcon(ProjectExplorer::Constants::ICON_DEBUG_SMALL);
}

235
void DebuggerRunControl::setCustomEnvironment(Utils::Environment env)
236
{
237
    QTC_ASSERT(d->m_engine, return);
238
    d->m_engine->startParameters().environment = env;
239
240
}

241
void DebuggerRunControl::start()
242
{
243
    QTC_ASSERT(d->m_engine, return);
244
245
246
    // 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
247
        appendMessage(tr("No executable specified.\n"), Utils::ErrorMessageFormat);
248
249
250
251
252
        emit started();
        emit finished();
        return;
    }

253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
    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;
            }
269
270
271
        }
    }

272
    debuggerCore()->runControlStarted(d->m_engine);
273

274
275
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
276
    emit started();
277
278
    d->m_running = true;

279
    d->m_engine->startDebugger(this);
280

281
    if (d->m_running)
con's avatar
con committed
282
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
283
284
}

285
void DebuggerRunControl::startFailed()
286
{
con's avatar
con committed
287
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
288
    d->m_running = false;
289
    emit finished();
290
    d->m_engine->handleStartFailed();
291
292
}

293
void DebuggerRunControl::handleFinished()
294
{
con's avatar
con committed
295
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
296
297
298
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
299
300
}

301
void DebuggerRunControl::showMessage(const QString &msg, int channel)
302
{
303
304
    switch (channel) {
        case AppOutput:
con's avatar
con committed
305
            appendMessage(msg, Utils::StdOutFormatSameLine);
306
307
            break;
        case AppError:
con's avatar
con committed
308
            appendMessage(msg, Utils::StdErrFormatSameLine);
309
310
            break;
        case AppStuff:
311
            appendMessage(msg, Utils::DebugFormat);
312
313
            break;
    }
314
315
}

316
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
317
{
318
319
    QTC_ASSERT(isRunning(), return true;)

320
321
322
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
323
    const QString question = tr("A debugging session is still in progress. "
324
325
326
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
327
328
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
329
330
331
332
}

RunControl::StopResult DebuggerRunControl::stop()
{
333
334
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
335
    return AsynchronousStop;
336
337
}

338
void DebuggerRunControl::debuggingFinished()
339
{
340
    d->m_running = false;
341
    emit finished();
342
343
}

344
bool DebuggerRunControl::isRunning() const
345
{
346
    return d->m_running;
347
348
}

349
DebuggerEngine *DebuggerRunControl::engine()
350
{
351
    QTC_CHECK(d->m_engine);
352
    return d->m_engine;
353
354
}

355
356
357
358
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
359

360
361
////////////////////////////////////////////////////////////////////////
//
362
// Engine detection logic: Detection functions depending on tool chain, binary,
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain)
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
        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);
        }
        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,
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
    switch (startMode) {
hjk's avatar
hjk committed
442
    case NoStartMode:
443
        break;
hjk's avatar
hjk committed
444
445
    case StartInternal:
    case StartExternal:
446
447
448
449
450
451
452
453
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
        }
        break;
hjk's avatar
hjk committed
454
    case AttachCore:
455
456
457
458
459
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
460
    case StartRemoteProcess:
hjk's avatar
hjk committed
461
    case StartRemoteGdb:
462
463
        result.push_back(GdbEngineType);
        break;
464
    case AttachToRemoteProcess:
465
    case AttachToRemoteServer:
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
        }
        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;
481
482
483
    case AttachToQmlPort:
        result.push_back(QmlEngineType); // Only QML can do this
        break;
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
    }
    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;

    result = enginesForMode(sp.startMode, true);
    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()) {
        result = enginesForToolChain(sp.toolChainAbi);
        if (!result.isEmpty())
            return result;
    }

    // FIXME: 1 of 3 testing hacks.
    if (sp.processArgs.startsWith(__("@tcf@ "))) {
        result.push_back(GdbEngineType);
        return result;
    }

515
    if (sp.startMode != AttachToRemoteServer && !sp.executable.isEmpty())
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

    result = enginesForMode(sp.startMode, false);
    return result;
}

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

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
532
533
534
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
535
536
537
538
539
}

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

542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
// 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.").
                                       arg(engineTypeName(et)));
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
557
    case CdbEngineType:
558
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
559
    case GdbEngineType:
560
561
562
563
564
565
566
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

567
/*!
568
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
569
570
571
572
573
574
575
576
577
578
579
580

    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;
    const unsigned activeLangs = debuggerCore()->activeLanguages();
    const bool qmlLanguage = activeLangs & QmlLanguage;
    const bool cppLanguage = activeLangs & CppLanguage;
581
582
583
584
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
585
586
587
588
589
590
591
592
    // Get all applicable types.
    QList<DebuggerEngineType> requiredTypes;
    if (qmlLanguage && !cppLanguage) {
        requiredTypes.push_back(QmlEngineType);
    } else {
        requiredTypes = engineTypes(sp);
    }
    if (requiredTypes.isEmpty()) {
Friedemann Kleint's avatar
Friedemann Kleint committed
593
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
594
595
        return result;
    }
596
597
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
598
599
600
601
602
603
604
605
    // Filter out disables types, command line + current settings.
    unsigned cmdLineEnabledEngines = debuggerCore()->enabledEngines();
#ifdef WITH_LLDB
    if (!Core::ICore::instance()->settings()->value(QLatin1String("LLDB/enabled")).toBool())
        cmdLineEnabledEngines &= ~LldbEngineType;
#else
     cmdLineEnabledEngines &= ~LldbEngineType;
#endif
606
607
608
609
610
611
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
612
        } else {
613
            unavailableTypes.push_back(et);
614
        }
615
    }
616
617
618
619
620
621
    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());
622
        } else {
623
624
625
626
            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());
627
        }
628
        return result;
629
    }
630
    if (debug)
631
632
633
634
635
636
637
638
639
        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").
                arg(sp.toolChainAbi.toString(), engineTypeName(usableType),
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
640
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
641
642
    }
    // Anything left: Happy.
643
644
    result.errorMessage.clear();
    result.errorDetails.clear();
645
646
    if (qmlLanguage && cppLanguage) {
        result.masterSlaveEngineTypes.first = QmlCppEngineType;
647
        result.masterSlaveEngineTypes.second = usableType;
648
    } else {
649
        result.masterSlaveEngineTypes.first = usableType;
650
    }
651
652
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
653
654
    return result;
}
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670

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

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

bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
{
//    return mode == ProjectExplorer::Constants::DEBUGMODE;
671
    return (mode == Constants::DEBUGMODE || mode == Constants::DEBUGMODE2)
672
673
674
675
676
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
677
    return DebuggerRunControl::tr("Debug");
678
679
680
}

// Find Qt installation by running qmake
681
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
682
683
684
{
    QProcess proc;
    QStringList args;
685
686
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
687
    proc.start(qmakePath.toString(), args);
688
    if (!proc.waitForStarted()) {
689
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
690
691
692
693
694
695
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
696
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
697
698
699
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
700
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
        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.startMode = StartInternal;
    sp.environment = rc->environment();
    sp.workingDirectory = rc->workingDirectory();
721
722
723
724
725
726

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

727
728
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
729
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
730
731
732
733
734
    if (!sp.toolChainAbi.isValid()) {
        QList<Abi> abis = Abi::abisOfBinary(sp.executable);
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
735
736
737
738
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

739
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
740
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
741
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
742
743
744
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
745
        if (const ProjectExplorer::Project *project = target->project()) {
746
747
748
749
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
750
                    sp.debuggerCommand = tc->debuggerCommand();
751
752
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
753
754
755
        }
    }

756
    if (debuggerCore()->isActiveDebugLanguage(QmlLanguage)) {
757
        sp.qmlServerAddress = _("127.0.0.1");
758
759
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();

760
761
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
762
763
764
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
765
766
        }

767
768
        Utils::QtcProcess::addArg(&sp.processArgs, QString("-qmljsdebugger=port:%1,block").arg(
                                      sp.qmlServerPort));
769
770
771
772
773
774
775
776
777
778
779
780
781
782
    }

    // 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
    (RunConfiguration *runConfiguration, const QString &mode)
{
783
    QTC_ASSERT(mode == Constants::DEBUGMODE || mode == Constants::DEBUGMODE2, return 0);
784
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
785
786
    if (mode == Constants::DEBUGMODE2)
        sp.breakOnMain = true;
787
788
789
    return create(sp, runConfiguration);
}

790
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
791
792
793
794
795
796
797
798
    (RunConfiguration *runConfiguration)
{
    // NBS TODO: Add GDB-specific configuration widget
    Q_UNUSED(runConfiguration)
    return 0;
}

DebuggerRunControl *DebuggerRunControlFactory::create
799
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
800
{
801
    const ConfigurationCheck check = checkDebugConfiguration(sp);
802

803
    if (!check) {
804
        //appendMessage(errorMessage, true);
Friedemann Kleint's avatar
Friedemann Kleint committed
805
        Core::ICore::instance()->showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
806
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
807
808
809
        return 0;
    }

810
811
812
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
813
814
815
816
817
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
818
819
820
821
822
823
824
825
826
827
828
829
830
831
{
    switch (et) {
    case GdbEngineType:
        return createGdbEngine(sp, masterEngine);
    case ScriptEngineType:
        return createScriptEngine(sp);
    case CdbEngineType:
        return createCdbEngine(sp, masterEngine, errorMessage);
    case PdbEngineType:
        return createPdbEngine(sp);
    case QmlEngineType:
        return createQmlEngine(sp, masterEngine);
    case LldbEngineType:
        return createLldbEngine(sp);
832
833
    default:
        break;
834
835
836
    }
    *errorMessage = DebuggerRunControl::tr("Unable to create a debugger engine of the type '%1'").
                    arg(_(engineTypeName(et)));
837
838
839
    return 0;
}

840

hjk's avatar
hjk committed
841
} // namespace Debugger