debuggerrunner.cpp 26.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 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 "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
    debuggerCore()->runControlStarted(d->m_engine);
252

253 254
    // We might get a synchronous startFailed() notification on Windows,
    // when launching the process fails. Emit a proper finished() sequence.
255
    emit started();
256 257
    d->m_running = true;

258
    d->m_engine->startDebugger(this);
259

260
    if (d->m_running)
con's avatar
con committed
261
        appendMessage(tr("Debugging starts\n"), Utils::NormalMessageFormat);
262 263
}

264
void DebuggerRunControl::startFailed()
265
{
con's avatar
con committed
266
    appendMessage(tr("Debugging has failed\n"), Utils::NormalMessageFormat);
267
    d->m_running = false;
268
    emit finished();
269
    d->m_engine->handleStartFailed();
270 271
}

272
void DebuggerRunControl::handleFinished()
273
{
con's avatar
con committed
274
    appendMessage(tr("Debugging has finished\n"), Utils::NormalMessageFormat);
275 276 277
    if (d->m_engine)
        d->m_engine->handleFinished();
    debuggerCore()->runControlFinished(d->m_engine);
278 279
}

280
void DebuggerRunControl::showMessage(const QString &msg, int channel)
281
{
282 283
    switch (channel) {
        case AppOutput:
con's avatar
con committed
284
            appendMessage(msg, Utils::StdOutFormatSameLine);
285 286
            break;
        case AppError:
con's avatar
con committed
287
            appendMessage(msg, Utils::StdErrFormatSameLine);
288 289
            break;
        case AppStuff:
con's avatar
con committed
290
            appendMessage(msg, Utils::NormalMessageFormat);
291 292
            break;
    }
293 294
}

295
bool DebuggerRunControl::promptToStop(bool *optionalPrompt) const
296
{
297 298
    QTC_ASSERT(isRunning(), return true;)

299 300 301
    if (optionalPrompt && !*optionalPrompt)
        return true;

Jarek Kobus's avatar
Jarek Kobus committed
302
    const QString question = tr("A debugging session is still in progress. "
303 304 305
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");
306 307
    return showPromptToStopDialog(tr("Close Debugging Session"), question,
                                  QString(), QString(), optionalPrompt);
308 309 310 311
}

RunControl::StopResult DebuggerRunControl::stop()
{
312 313
    QTC_ASSERT(d->m_engine, return StoppedSynchronously);
    d->m_engine->quitDebugger();
314
    return AsynchronousStop;
315 316
}

317
void DebuggerRunControl::debuggingFinished()
318
{
319
    d->m_running = false;
320
    emit finished();
321 322
}

323
bool DebuggerRunControl::isRunning() const
324
{
325
    return d->m_running;
326 327
}

328
DebuggerEngine *DebuggerRunControl::engine()
329
{
330 331
    QTC_ASSERT(d->m_engine, /**/);
    return d->m_engine;
332 333
}

334 335 336 337
RunConfiguration *DebuggerRunControl::runConfiguration() const
{
    return d->m_myRunConfiguration.data();
}
338

339 340
////////////////////////////////////////////////////////////////////////
//
341
// Engine detection logic: Detection functions depending on tool chain, binary,
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 410 411 412 413 414 415 416 417 418 419 420
// 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
421
    case NoStartMode:
422
        break;
hjk's avatar
hjk committed
423 424
    case StartInternal:
    case StartExternal:
425 426 427 428 429 430 431 432
    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
433 434
    case AttachCore:
    case StartRemoteGdb:
435 436
        result.push_back(GdbEngineType);
        break;
hjk's avatar
hjk committed
437
    case AttachToRemote:
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 490 491 492 493 494 495 496 497 498 499 500
        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
501 502 503
    return errorMessage.isEmpty()
        && errorDetails.isEmpty()
        && masterSlaveEngineTypes.first != NoEngineType;
504 505 506 507 508
}

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

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
// 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
526
    case CdbEngineType:
527
        return checkCdbConfiguration(sp, result);
hjk's avatar
hjk committed
528
    case GdbEngineType:
529 530 531 532 533 534 535
        return checkGdbConfiguration(sp, result);
    default:
        break;
    }
    return true;
}

536
/*!
537
    \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
538 539 540 541 542 543 544 545 546 547 548 549

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

////////////////////////////////////////////////////////////////////////
//
// 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
646
    return DebuggerRunControl::tr("Debug");
647 648 649 650 651 652 653
}

// Find Qt installation by running qmake
static inline QString findQtInstallPath(const QString &qmakePath)
{
    QProcess proc;
    QStringList args;
654 655
    args.append(_("-query"));
    args.append(_("QT_INSTALL_HEADERS"));
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 681 682 683 684 685 686 687 688 689
    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();
690 691 692 693 694 695

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

696 697
    sp.executable = rc->executable();
    sp.processArgs = rc->commandLineArguments();
698
    sp.toolChainAbi = rc->abi();
699 700 701 702
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();

703
    if (const ProjectExplorer::Target *target = runConfiguration->target()) {
704 705 706 707 708
        if (QByteArray(target->metaObject()->className()).contains("Qt4")) {
            const QString qmake = Utils::BuildableHelperLibrary::findSystemQt(sp.environment);
            if (!qmake.isEmpty())
                sp.qtInstallPath = findQtInstallPath(qmake);
        }
709 710 711 712 713 714 715 716 717 718
        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();
              }
        }
    }

719
    if (debuggerCore()->isActiveDebugLanguage(QmlLanguage)) {
720
        sp.qmlServerAddress = _("127.0.0.1");
721 722
        sp.qmlServerPort = runConfiguration->qmlDebugServerPort();

723 724
        // Makes sure that all bindings go through the JavaScript engine, so that
        // breakpoints are actually hit!
725 726 727
        const QString optimizerKey = _("QML_DISABLE_OPTIMIZER");
        if (!sp.environment.hasKey(optimizerKey)) {
            sp.environment.set(optimizerKey, _("1"));
728 729
        }

730
        Utils::QtcProcess::addArg(&sp.processArgs, _("-qmljsdebugger=port:")
731
                                  + QString::number(sp.qmlServerPort));
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
    }

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

751
RunConfigWidget *DebuggerRunControlFactory::createConfigurationWidget
752 753 754 755 756 757 758 759
    (RunConfiguration *runConfiguration)
{
    // NBS TODO: Add GDB-specific configuration widget
    Q_UNUSED(runConfiguration)
    return 0;
}

DebuggerRunControl *DebuggerRunControlFactory::create
760
    (const DebuggerStartParameters &sp, RunConfiguration *runConfiguration)
761
{
762
    const ConfigurationCheck check = checkDebugConfiguration(sp);
763

764
    if (!check) {
765
        //appendMessage(errorMessage, true);
Friedemann Kleint's avatar
Friedemann Kleint committed
766
        Core::ICore::instance()->showWarningWithOptions(DebuggerRunControl::tr("Debugger"),
767
            check.errorMessage, check.errorDetailsString(), check.settingsCategory, check.settingsPage);
768 769 770
        return 0;
    }

771 772 773
    return new DebuggerRunControl(runConfiguration, sp, check.masterSlaveEngineTypes);
}

hjk's avatar
hjk committed
774 775 776 777 778
DebuggerEngine *DebuggerRunControlFactory::createEngine
    (DebuggerEngineType et,
     const DebuggerStartParameters &sp,
     DebuggerEngine *masterEngine,
     QString *errorMessage)
779 780 781 782 783 784 785 786 787 788 789 790 791 792
{
    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);
793 794
    default:
        break;
795 796 797
    }
    *errorMessage = DebuggerRunControl::tr("Unable to create a debugger engine of the type '%1'").
                    arg(_(engineTypeName(et)));
798 799 800
    return 0;
}

801

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