debuggerrunner.cpp 26.1 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 29
** If you have questions regarding the use of this file, please contact
** 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 "debuggercore.h"
38
#include "debuggerengine.h"
39
#include "debuggermainwindow.h"
40 41
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
42
#include "debuggerstartparameters.h"
43
#include "lldb/lldbenginehost.h"
44
#include "debuggertooltipmanager.h"
45
#include "qml/qmlengine.h"
46

Friedemann Kleint's avatar
Friedemann Kleint committed
47 48 49 50
#ifdef Q_OS_WIN
#  include "peutils.h"
#endif

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

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

con's avatar
con committed
68
#include <QtCore/QDir>
69
#include <QtCore/QDebug>
70
#include <QtGui/QMessageBox>
con's avatar
con committed
71

72
using namespace ProjectExplorer;
73 74
using namespace Debugger::Internal;

75 76
enum { debug = 0 };

77
namespace Debugger {
78
namespace Internal {
79

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

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

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

hjk's avatar
hjk committed
98
extern QString msgNoBinaryForToolChain(const Abi &abi);
99

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

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

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

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

147 148
////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
149
// DebuggerRunControlPrivate
150 151 152
//
////////////////////////////////////////////////////////////////////////

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

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

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

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

hjk's avatar
hjk committed
180 181
} // namespace Internal

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

hjk's avatar
hjk committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
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();
}

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

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

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

237
void DebuggerRunControl::start()
238
{
239
    QTC_ASSERT(d->m_engine, return);
240
    debuggerCore()->runControlStarted(d->m_engine);
241

242 243
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
244
    emit started();
245 246
    d->m_running = true;

247
    d->m_engine->startDebugger(this);
248

249
    if (d->m_running)
dt's avatar
dt committed
250
        appendMessage(tr("Debugging starts\n"), NormalMessageFormat);
251 252
}

253
void DebuggerRunControl::startFailed()
254
{
dt's avatar
dt committed
255
    appendMessage(tr("Debugging has failed\n"), NormalMessageFormat);
256
    d->m_running = false;
257
    emit finished();
258
    d->m_engine->handleStartFailed();
259 260
}

261
void DebuggerRunControl::handleFinished()
262
{
dt's avatar
dt committed
263
    appendMessage(tr("Debugging has finished\n"), NormalMessageFormat);
264 265 266
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
267 268
}

269
void DebuggerRunControl::showMessage(const QString &msg, int channel)
270
{
271 272
    switch (channel) {
        case AppOutput:
273
            appendMessage(msg, StdOutFormatSameLine);
274 275
            break;
        case AppError:
276
            appendMessage(msg, StdErrFormatSameLine);
277 278
            break;
        case AppStuff:
279
            appendMessage(msg, NormalMessageFormat);
280 281
            break;
    }
282 283
}

284
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
285
{
286 287
    QTC_ASSERT(isRunning(), return true;)

288 289 290
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
291
    const QString question = tr("A debugging session is still in progress. "
292 293 294
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
295 296
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
297 298 299 300
}

RunControl::StopResult DebuggerRunControl::stop()
{
301 302
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
303
    return AsynchronousStop;
304 305
}

306
void DebuggerRunControl::debuggingFinished()
307
{
308
    d->m_running = false;
309
    emit finished();
310 311
}

312
bool DebuggerRunControl::isRunning() const
313
{
314
    return d->m_running;
315 316
}

317
DebuggerEngine *DebuggerRunControl::engine()
318
{
319 320
    QTC_ASSERT(d->m_engine, /**/);
    return d->m_engine;
321 322
}

323 324 325 326
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
327

328 329
////////////////////////////////////////////////////////////////////////
//
330
// Engine detection logic: Detection functions depending on tool chain, binary,
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 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
// 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
410
    case NoStartMode:
411
        break;
hjk's avatar
hjk committed
412 413
    case StartInternal:
    case StartExternal:
414 415 416 417 418 419 420 421
    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
422 423
    case AttachCore:
    case StartRemoteGdb:
424 425
        result.push_back(GdbEngineType);
        break;
hjk's avatar
hjk committed
426
    case AttachToRemote:
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 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
        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
490 491 492
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
493 494 495 496 497
}

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

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
// 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
515
    case CdbEngineType:
516
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
517
    case GdbEngineType:
518 519 520 521 522 523 524
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

525
/*!
526
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
527 528 529 530 531 532 533 534 535 536 537 538

    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;
539 540 541 542
    if (debug)
        qDebug().nospace() << "checkDebugConfiguration " << sp.toolChainAbi.toString()
                           << " Start mode=" << sp.startMode << " Executable=" << sp.executable
                           << " Debugger command=" << sp.debuggerCommand;
543 544 545 546 547 548 549 550
    // 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
551
        result.errorMessage = QLatin1String("Internal error: Unable to determine debugger engine type for this configuration");
552 553
        return result;
    }
554 555
    if (debug)
        qDebug() << " Required: " << engineTypeNames(requiredTypes);
556 557 558 559 560 561 562 563
    // 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
564 565 566 567 568 569
    DebuggerEngineType usableType = NoEngineType;
    QList<DebuggerEngineType> unavailableTypes;
    foreach (DebuggerEngineType et, requiredTypes) {
        if (canUseEngine(et, sp, cmdLineEnabledEngines, &result)) {
            usableType = et;
            break;
570
        } else {
571
            unavailableTypes.push_back(et);
572
        }
573
    }
574 575 576 577 578 579
    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());
580
        } else {
581 582 583 584
            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());
585
        }
586
        return result;
587
    }
588
    if (debug)
589 590 591 592 593 594 595 596 597 598
        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);
        showMessageBox(QMessageBox::Warning, "Warning", msg);
599 600
    }
    // Anything left: Happy.
601 602
    result.errorMessage.clear();
    result.errorDetails.clear();
603 604
    if (qmlLanguage && cppLanguage) {
        result.masterSlaveEngineTypes.first = QmlCppEngineType;
605
        result.masterSlaveEngineTypes.second = usableType;
606
    } else {
607
        result.masterSlaveEngineTypes.first = usableType;
608
    }
609 610
    if (debug)
        qDebug() << engineTypeName(result.masterSlaveEngineTypes.first) << engineTypeName(result.masterSlaveEngineTypes.second);
611 612
    return result;
}
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634

////////////////////////////////////////////////////////////////////////
//
// 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;
    return mode == Constants::DEBUGMODE
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
}

QString DebuggerRunControlFactory::displayName() const
{
Friedemann Kleint's avatar
Friedemann Kleint committed
635
    return DebuggerRunControl::tr("Debug");
636 637 638 639 640 641 642
}

// Find Qt installation by running qmake
static inline QString findQtInstallPath(const QString &qmakePath)
{
    QProcess proc;
    QStringList args;
643 644
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
    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();
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
681
    sp.toolChainAbi = rc->abi();
682 683 684 685
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

686
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
687 688 689 690 691
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
            const QString qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
692 693 694 695 696 697 698 699 700 701
        if (const ProjectExplorer::Project *project = target->project()) {
              sp.projectDir = project->projectDirectory();
              if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) {
                  sp.projectBuildDir = buildConfig->buildDirectory();
                  if (const ProjectExplorer::ToolChain *tc = buildConfig->toolChain())
                    sp.debuggerCommand = tc->debuggerCommand();
              }
        }
    }

702
    if (debuggerCore()->isActiveDebugLanguage(QmlLanguage)) {
703
        sp.qmlServerAddress = _("127.0.0.1");
704 705
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();

706 707
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
708 709 710
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
711 712
        }

713
        Utils::QtcProcess::addArg(&sp.processArgs, _("-qmljsdebugger=port:")
714
                                  + QString::number(sp.qmlServerPort));
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
    }

    // 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)
{
    QTC_ASSERT(mode == Constants::DEBUGMODE, return 0);
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
    return create(sp, runConfiguration);
}

734
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
735 736 737 738 739 740 741 742
    (RunConfiguration *runConfiguration)
{
    // NBS TODO: Add GDB-specific configuration widget
    Q_UNUSED(runConfiguration)
    return 0;
}

DebuggerRunControl *DebuggerRunControlFactory::create
743
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
744
{
745
    const ConfigurationCheck check = checkDebugConfiguration(sp);
746

747
    if (!check) {
748
        //appendMessage(errorMessage, true);
Friedemann Kleint's avatar
Friedemann Kleint committed
749
        Core::ICore::instance()->showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
750
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
751 752 753
        return 0;
    }

754 755 756
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
757 758 759 760 761
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
762 763 764 765 766 767 768 769 770 771 772 773 774 775
{
    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);
776 777
    default:
        break;
778 779 780
    }
    *errorMessage = DebuggerRunControl::tr("Unable to create a debugger engine of the type '%1'").
                    arg(_(engineTypeName(et)));
781 782 783
    return 0;
}

784

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