debuggerrunner.cpp 29.4 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "debuggerrunner.h"
34
#include "debuggerruncontrolfactory.h"
con's avatar
con committed
35

36
#include "debuggeractions.h"
37
#include "debuggerinternalconstants.h"
38
#include "debuggercore.h"
39
#include "debuggerengine.h"
40
#include "debuggermainwindow.h"
41 42
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
43
#include "debuggerstartparameters.h"
44
#include "lldb/lldbenginehost.h"
45
#include "debuggertooltipmanager.h"
46
#include "qml/qmlengine.h"
47

Friedemann Kleint's avatar
Friedemann Kleint committed
48 49
#ifdef Q_OS_WIN
#  include "peutils.h"
50
#  include <utils/winutils.h>
Friedemann Kleint's avatar
Friedemann Kleint committed
51 52
#endif

53
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
54
#include <projectexplorer/debugginghelper.h>
con's avatar
con committed
55 56
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
57
#include <projectexplorer/target.h>
58
#include <projectexplorer/buildconfiguration.h>
59
#include <projectexplorer/toolchain.h>
60
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*
con's avatar
con committed
61

con's avatar
con committed
62
#include <utils/outputformat.h>
63
#include <utils/synchronousprocess.h>
hjk's avatar
hjk committed
64
#include <utils/qtcassert.h>
65
#include <utils/fancymainwindow.h>
66
#include <utils/qtcprocess.h>
67
#include <coreplugin/icore.h>
68
#include <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)
188
    : RunControl(runConfiguration, ProjectExplorer::DebugRunMode),
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();
hjk's avatar
hjk committed
203
        Core::ICore::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
QIcon DebuggerRunControl::icon() const
{
232
    return QIcon(QLatin1String(ProjectExplorer::Constants::ICON_DEBUG_SMALL));
233 234
}

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
// etc. Return a list of possible engines (order of prefererence) without
// consideration of configuration, etc.
//
////////////////////////////////////////////////////////////////////////

368 369
static QList<DebuggerEngineType> enginesForToolChain(const Abi &toolChain,
                                                     DebuggerLanguages languages)
370 371 372 373 374 375 376
{
    QList<DebuggerEngineType> result;
    switch (toolChain.binaryFormat()) {
    case Abi::ElfFormat:
    case Abi::MachOFormat:
        result.push_back(LldbEngineType);
        result.push_back(GdbEngineType);
377 378
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
379 380 381 382 383 384 385 386 387
        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);
        }
388 389
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
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 442
        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,
443
                                                DebuggerLanguages languages,
444 445 446
                                                bool hardConstraintsOnly)
{
    QList<DebuggerEngineType> result;
447 448 449 450 451 452 453 454 455 456 457 458

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

459
    switch (startMode) {
hjk's avatar
hjk committed
460
    case NoStartMode:
461
        break;
hjk's avatar
hjk committed
462 463
    case StartInternal:
    case StartExternal:
464 465 466 467 468 469
    case AttachExternal:
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType); // Preferably Windows debugger for attaching locally.
#endif
            result.push_back(GdbEngineType);
470 471 472

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
473 474
        }
        break;
hjk's avatar
hjk committed
475
    case AttachCore:
476 477 478 479 480
#ifdef Q_OS_WIN
        result.push_back(CdbEngineType);
#endif
        result.push_back(GdbEngineType);
        break;
481
    case StartRemoteProcess:
hjk's avatar
hjk committed
482
    case StartRemoteGdb:
483
        result.push_back(GdbEngineType);
484 485
        if (languages & QmlLanguage)
            result.push_back(QmlEngineType);
486
        break;
487
    case AttachToRemoteProcess:
488
    case AttachToRemoteServer:
489 490 491 492 493
        if (!hardConstraintsOnly) {
#ifdef Q_OS_WIN
            result.push_back(CdbEngineType);
#endif
            result.push_back(GdbEngineType);
494 495 496

            if (languages & QmlLanguage)
                result.push_back(QmlEngineType);
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
        }
        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;

520
    result = enginesForMode(sp.startMode, sp.languages, true);
521 522 523 524 525 526
    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()) {
527
        result = enginesForToolChain(sp.toolChainAbi, sp.languages);
528 529 530 531 532 533 534 535 536 537
        if (!result.isEmpty())
            return result;
    }

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

538 539 540
    if (sp.startMode != AttachToRemoteServer
            && sp.startMode != AttachToRemoteProcess
            && !sp.executable.isEmpty())
541 542 543 544
        result = enginesForExecutable(sp.executable);
    if (!result.isEmpty())
        return result;

545
    result = enginesForMode(sp.startMode, sp.languages, false);
546 547 548 549 550 551 552 553 554 555 556
    return result;
}

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

ConfigurationCheck::operator bool() const
{
hjk's avatar
hjk committed
557 558 559
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
560 561 562 563 564
}

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

567 568 569 570 571 572 573 574 575 576
// 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.").
577
                                       arg(QLatin1String(engineTypeName(et))));
578 579 580 581
        return false;
    }
    // Configured.
    switch (et) {
hjk's avatar
hjk committed
582
    case CdbEngineType:
583
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
584
    case GdbEngineType:
585 586 587 588 589 590 591
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

592
/*!
593
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
594 595 596 597 598 599 600 601 602

    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;
603 604 605 606
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
607
    // Get all applicable types.
608
    QList<DebuggerEngineType> requiredTypes = engineTypes(sp);
609
    if (requiredTypes.isEmpty()) {
Friedemann Kleint's avatar
Friedemann Kleint committed
610
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
611 612
        return result;
    }
613 614
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
615
    // Filter out disabled types, command line + current settings.
616 617
    unsigned cmdLineEnabledEngines = debuggerCore()->enabledEngines();
#ifdef WITH_LLDB
hjk's avatar
hjk committed
618
    if (!Core::ICore::settings()->value(QLatin1String("LLDB/enabled")).toBool())
619 620 621 622
        cmdLineEnabledEngines &= ~LldbEngineType;
#else
     cmdLineEnabledEngines &= ~LldbEngineType;
#endif
623

624 625 626 627 628 629
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
630
        } else {
631
            unavailableTypes.push_back(et);
632
        }
633
    }
634 635 636 637 638 639
    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());
640
        } else {
641 642 643 644
            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());
645
        }
646
        return result;
647
    }
648
    if (debug)
649 650 651 652 653 654
        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").
655
                arg(sp.toolChainAbi.toString(), QLatin1String(engineTypeName(usableType)),
656 657
                    result.errorDetails.join(QString(QLatin1Char('\n'))));
        debuggerCore()->showMessage(msg, LogWarning);
Kai Koehne's avatar
Kai Koehne committed
658
        showMessageBox(QMessageBox::Warning, DebuggerPlugin::tr("Warning"), msg);
659 660
    }
    // Anything left: Happy.
661 662
    result.errorMessage.clear();
    result.errorDetails.clear();
663 664 665 666 667 668 669 670 671 672 673


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

674 675
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
676 677
    return result;
}
678 679 680 681 682 683 684 685 686 687 688 689 690

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

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

691
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, RunMode mode) const
692
{
693
    return (mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain)
694 695 696 697 698
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
699
    return DebuggerRunControl::tr("Debug");
700 701 702
}

// Find Qt installation by running qmake
703
static inline QString findQtInstallPath(const Utils::FileName &qmakePath)
704 705 706
{
    QProcess proc;
    QStringList args;
707 708
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
709
    proc.start(qmakePath.toString(), args);
710
    if (!proc.waitForStarted()) {
711
        qWarning("%s: Cannot start '%s': %s", Q_FUNC_INFO, qPrintable(qmakePath.toString()),
712 713 714 715 716 717
           qPrintable(proc.errorString()));
        return QString();
    }
    proc.closeWriteChannel();
    if (!proc.waitForFinished()) {
        Utils::SynchronousProcess::stopProcess(proc);
718
        qWarning("%s: Timeout running '%s'.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
719 720 721
        return QString();
    }
    if (proc.exitStatus() != QProcess::NormalExit) {
722
        qWarning("%s: '%s' crashed.", Q_FUNC_INFO, qPrintable(qmakePath.toString()));
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
        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();
742 743 744 745 746 747

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

748
    sp.executable = rc->executable();
749 750 751
    if (sp.executable.isEmpty())
        return sp;
    sp.startMode = StartInternal;
752
    sp.processArgs = rc->commandLineArguments();
753
    sp.toolChainAbi = rc->abi();
Tobias Hunger's avatar
Tobias Hunger committed
754
    if (!sp.toolChainAbi.isValid()) {
Tobias Hunger's avatar
Tobias Hunger committed
755
        QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(sp.executable));
Tobias Hunger's avatar
Tobias Hunger committed
756 757 758
        if (!abis.isEmpty())
            sp.toolChainAbi = abis.at(0);
    }
759 760 761 762
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

763
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
764
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
765
            const Utils::FileName qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
766 767 768
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
769
        if (const ProjectExplorer::Project *project = target->project()) {
770 771 772 773
            sp.projectSourceDirectory = project->projectDirectory();
            if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                sp.projectBuildDirectory = buildConfig->buildDirectory();
                if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
774
                    sp.debuggerCommand = tc->debuggerCommand().toString();
775 776
            }
            sp.projectSourceFiles = project->files(Project::ExcludeGeneratedFiles);
777 778 779
        }
    }

780 781 782 783
    if (runConfiguration->useCppDebugger())
        sp.languages |= CppLanguage;

    if (runConfiguration->useQmlDebugger()) {
784
        sp.qmlServerAddress = _("127.0.0.1");
785
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();
786
        sp.languages |= QmlLanguage;
787

788 789
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
790 791 792
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
793 794
        }

795 796
        Utils::QtcProcess::addArg(&sp.processArgs,
                                  QString::fromLatin1("-qmljsdebugger=port:%1,block").arg(sp.qmlServerPort));
797 798 799 800 801 802 803 804 805 806 807 808
    }

    // 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
809
    (RunConfiguration *runConfiguration, RunMode mode)
810
{
811
    QTC_ASSERT(mode == DebugRunMode || mode == DebugRunModeWithBreakOnMain, return 0);
812
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
813 814
    if (sp.startMode == NoStartMode)
        return 0;
815
    if (mode == DebugRunModeWithBreakOnMain)
816
        sp.breakOnMain = true;
817 818 819
    return create(sp, runConfiguration);
}

820
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
821 822 823 824 825 826 827 828
    (RunConfiguration *runConfiguration)
{
    // NBS TODO: Add GDB-specific configuration widget
    Q_UNUSED(runConfiguration)
    return 0;
}

DebuggerRunControl *DebuggerRunControlFactory::create
829
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
830
{
831
    const ConfigurationCheck check = checkDebugConfiguration(sp);
832

833
    if (!check) {
834
        //appendMessage(errorMessage, true);
hjk's avatar
hjk committed
835
        Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
836
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
837 838 839
        return 0;
    }

840 841 842
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
843 844 845 846 847
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
848 849 850 851 852 853 854 855 856 857 858 859 860 861
{
    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);
862 863
    default:
        break;
864 865 866
    }
    *errorMessage = DebuggerRunControl::tr("Unable to create a debugger engine of the type '%1'").
                    arg(_(engineTypeName(et)));
867 868 869
    return 0;
}

870

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