debuggerrunner.cpp 27.8 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
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.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
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.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>
con's avatar
con committed
73

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

77
78
enum { debug = 0 };

79
namespace Debugger {
80
namespace Internal {
81

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

251
252
253
254
255
256
    foreach (const BreakpointId &id, debuggerCore()->breakHandler()->allBreakpointIds()) {
        if (!d->m_engine->acceptsBreakpoint(id)) {
            debuggerCore()->showMessage(DebuggerPlugin::tr("Some breakpoints cannot be handled by the current debugger, and will be ignored."), LogWarning);

            int result = QMessageBox::warning(debuggerCore()->mainWindow(),
                                          DebuggerPlugin::tr("Warning"), DebuggerPlugin::tr("Some breakpoints cannot be handled by the debugger, and will be ignored. Do you want to continue?"),
257
                                          QMessageBox::Yes | QMessageBox::No);
258
259
260
261
262
263
264
265
266
267

            if (result == QMessageBox::Cancel) {
                emit started();
                emit finished();
                return;
            }
            break;
        }
    }

268
    debuggerCore()->runControlStarted(d->m_engine);
269

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

275
    d->m_engine->startDebugger(this);
276

277
    if (d->m_running)
con's avatar
con committed
278
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
279
280
}

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

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

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

312
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
313
{
314
315
    QTC_ASSERT(isRunning(), return true;)

316
317
318
    if (optionalPrompt && !*optionalPrompt)
        return true;

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

RunControl::StopResult DebuggerRunControl::stop()
{
329
330
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
331
    return AsynchronousStop;
332
333
}

334
void DebuggerRunControl::debuggingFinished()
335
{
336
    d->m_running = false;
337
    emit finished();
338
339
}

340
bool DebuggerRunControl::isRunning() const
341
{
342
    return d->m_running;
343
344
}

345
DebuggerEngine *DebuggerRunControl::engine()
346
{
347
348
    QTC_ASSERT(d->m_engine, /**/);
    return d->m_engine;
349
350
}

351
352
353
354
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
355

356
357
////////////////////////////////////////////////////////////////////////
//
358
// Engine detection logic: Detection functions depending on tool chain, binary,
359
360
361
362
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
// 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
438
    case NoStartMode:
439
        break;
hjk's avatar
hjk committed
440
441
    case StartInternal:
    case StartExternal:
442
443
444
445
446
447
448
449
    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
450
451
    case AttachCore:
    case StartRemoteGdb:
452
453
        result.push_back(GdbEngineType);
        break;
hjk's avatar
hjk committed
454
    case AttachToRemote:
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
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
515
516
517
        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;
    }
    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;
    }

    if (sp.startMode != AttachToRemote && !sp.executable.isEmpty())
        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
518
519
520
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
521
522
523
524
525
}

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

528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
// 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
543
    case CdbEngineType:
544
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
545
    case GdbEngineType:
546
547
548
549
550
551
552
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

553
/*!
554
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
555
556
557
558
559
560
561
562
563
564
565
566

    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;
567
568
569
570
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
571
572
573
574
575
576
577
578
    // 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
579
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
580
581
        return result;
    }
582
583
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
584
585
586
587
588
589
590
591
    // 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
592
593
594
595
596
597
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
598
        } else {
599
            unavailableTypes.push_back(et);
600
        }
601
    }
602
603
604
605
606
607
    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());
608
        } else {
609
610
611
612
            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());
613
        }
614
        return result;
615
    }
616
    if (debug)
617
618
619
620
621
622
623
624
625
        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
626
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
627
628
    }
    // Anything left: Happy.
629
630
    result.errorMessage.clear();
    result.errorDetails.clear();
631
632
    if (qmlLanguage && cppLanguage) {
        result.masterSlaveEngineTypes.first = QmlCppEngineType;
633
        result.masterSlaveEngineTypes.second = usableType;
634
    } else {
635
        result.masterSlaveEngineTypes.first = usableType;
636
    }
637
638
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
639
640
    return result;
}
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656

////////////////////////////////////////////////////////////////////////
//
// 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;
657
    return (mode == Constants::DEBUGMODE || mode == Constants::DEBUGMODE2)
658
659
660
661
662
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
663
    return DebuggerRunControl::tr("Debug");
664
665
666
667
668
669
670
}

// Find Qt installation by running qmake
static inline QString findQtInstallPath(const QString &qmakePath)
{
    QProcess proc;
    QStringList args;
671
672
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
    proc.start(qmakePath, args);
    if (!proc.waitForStarted()) {
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath),
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath));
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath));
        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();
707
708
709
710
711
712

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

713
714
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
715
    sp.toolChainAbi = rc->abi();
716
717
718
719
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

720
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
721
722
723
724
725
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
            const QString qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
726
        if (const ProjectExplorer::Project *project = target->project()) {
727
728
729
730
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
731
                    sp.debuggerCommand = tc->debuggerCommand();
732
733
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
734
735
736
        }
    }

737
    if (debuggerCore()->isActiveDebugLanguage(QmlLanguage)) {
738
        sp.qmlServerAddress = _("127.0.0.1");
739
740
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();

741
742
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
743
744
745
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
746
747
        }

748
        Utils::QtcProcess::addArg(&sp.processArgs, _("-qmljsdebugger=port:")
749
                                  + QString::number(sp.qmlServerPort));
750
751
752
753
754
755
756
757
758
759
760
761
762
763
    }

    // 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)
{
764
    QTC_ASSERT(mode == Constants::DEBUGMODE || mode == Constants::DEBUGMODE2, return 0);
765
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
766
767
    if (mode == Constants::DEBUGMODE2)
        sp.breakOnMain = true;
768
769
770
    return create(sp, runConfiguration);
}

771
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
772
773
774
775
776
777
778
779
    (RunConfiguration *runConfiguration)
{
    // NBS TODO: Add GDB-specific configuration widget
    Q_UNUSED(runConfiguration)
    return 0;
}

DebuggerRunControl *DebuggerRunControlFactory::create
780
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
781
{
782
    const ConfigurationCheck check = checkDebugConfiguration(sp);
783

784
    if (!check) {
785
        //appendMessage(errorMessage, true);
Friedemann Kleint's avatar
Friedemann Kleint committed
786
        Core::ICore::instance()->showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
787
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
788
789
790
        return 0;
    }

791
792
793
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
794
795
796
797
798
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
799
800
801
802
803
804
805
806
807
808
809
810
811
812
{
    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);
813
814
    default:
        break;
815
816
817
    }
    *errorMessage = DebuggerRunControl::tr("Unable to create a debugger engine of the type '%1'").
                    arg(_(engineTypeName(et)));
818
819
820
    return 0;
}

821

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