debuggerrunner.cpp 16.3 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) 2010 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
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "debuggerrunner.h"

32 33 34 35 36
#include "debuggeractions.h"
#include "debuggerconstants.h"
#include "debuggerengine.h"
#include "debuggerplugin.h"
#include "debuggerstringutils.h"
37

Friedemann Kleint's avatar
Friedemann Kleint committed
38 39 40 41
#ifdef Q_OS_WIN
#  include "peutils.h"
#endif

hjk's avatar
hjk committed
42
#include <projectexplorer/debugginghelper.h>
con's avatar
con committed
43 44 45
#include <projectexplorer/environment.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
46
#include <projectexplorer/target.h>
47
#include <projectexplorer/buildconfiguration.h>
48
#include <projectexplorer/applicationrunconfiguration.h> // For LocalApplication*
con's avatar
con committed
49

hjk's avatar
hjk committed
50
#include <utils/qtcassert.h>
51
#include <coreplugin/icore.h>
hjk's avatar
hjk committed
52

con's avatar
con committed
53 54 55
#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
56
#include <QtCore/QTimer>
Friedemann Kleint's avatar
Friedemann Kleint committed
57
#include <QtCore/QStringList>
hjk's avatar
hjk committed
58

59
#include <QtGui/QAbstractItemView>
60
#include <QtGui/QTextDocument>
61
#include <QtGui/QTreeWidget>
con's avatar
con committed
62

63
using namespace ProjectExplorer;
64 65
using namespace Debugger::Internal;

66 67 68 69 70 71 72 73 74
namespace Debugger {
namespace Internal {

DebuggerEngine *createGdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createScriptEngine(const DebuggerStartParameters &);
DebuggerEngine *createPdbEngine(const DebuggerStartParameters &);
DebuggerEngine *createTcfEngine(const DebuggerStartParameters &);
DebuggerEngine *createQmlEngine(const DebuggerStartParameters &);

hjk's avatar
hjk committed
75
bool checkGdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
76 77 78 79 80 81 82

// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

hjk's avatar
hjk committed
83 84
#ifdef CDB_ENABLED
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &);
85
bool checkCdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
hjk's avatar
hjk committed
86 87 88 89
#else
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &) { return 0; }
bool checkCdbConfiguration(int, QString *, QString *) { return false; }
#endif
90

hjk's avatar
hjk committed
91
} // namespace Internal
92 93 94 95 96 97

static QString toolChainName(int toolChainType)
{
    return ToolChain::toolChainName(ToolChain::ToolChainType(toolChainType));
}

98

con's avatar
con committed
99 100
////////////////////////////////////////////////////////////////////////
//
101
// DebuggerRunControlFactory
con's avatar
con committed
102 103 104
//
////////////////////////////////////////////////////////////////////////

105 106 107 108 109 110 111
static QString msgEngineNotAvailable(const char *engine)
{
    return DebuggerPlugin::tr("The application requires the debugger engine '%1', "
        "which is disabled.").arg(QLatin1String(engine));
}

static DebuggerPlugin *plugin() { return DebuggerPlugin::instance(); }
112

113
// A factory to create DebuggerRunControls
114 115 116
DebuggerRunControlFactory::DebuggerRunControlFactory(QObject *parent,
        DebuggerEngineType enabledEngines)
    : IRunControlFactory(parent), m_enabledEngines(enabledEngines)
con's avatar
con committed
117 118
{}

119
bool DebuggerRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
con's avatar
con committed
120
{
121
//    return mode == ProjectExplorer::Constants::DEBUGMODE;
122
    return mode == ProjectExplorer::Constants::DEBUGMODE
123
            && qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
con's avatar
con committed
124 125
}

126
QString DebuggerRunControlFactory::displayName() const
con's avatar
con committed
127
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
128
    return tr("Debug");
con's avatar
con committed
129 130
}

131
static DebuggerStartParameters localStartParameters(RunConfiguration *runConfiguration)
132
{
133
    DebuggerStartParameters sp;
134 135 136 137 138
    QTC_ASSERT(runConfiguration, return sp);
    LocalApplicationRunConfiguration *rc =
            qobject_cast<LocalApplicationRunConfiguration *>(runConfiguration);
    QTC_ASSERT(rc, return sp);

139 140 141 142 143 144 145 146 147 148
    sp.startMode = StartInternal;
    sp.executable = rc->executable();
    sp.environment = rc->environment().toStringList();
    sp.workingDirectory = rc->workingDirectory();
    sp.processArgs = rc->commandLineArguments();
    sp.toolChainType = rc->toolChainType();
    sp.useTerminal = rc->runMode() == LocalApplicationRunConfiguration::Console;
    sp.dumperLibrary = rc->dumperLibrary();
    sp.dumperLibraryLocations = rc->dumperLibraryLocations();
    sp.displayName = rc->displayName();
149

150 151
    // Find qtInstallPath.
    QString qmakePath = DebuggingHelperLibrary::findSystemQt(rc->environment());
152 153 154 155 156 157 158 159 160
    if (!qmakePath.isEmpty()) {
        QProcess proc;
        QStringList args;
        args.append(QLatin1String("-query"));
        args.append(QLatin1String("QT_INSTALL_HEADERS"));
        proc.start(qmakePath, args);
        proc.waitForFinished();
        QByteArray ba = proc.readAllStandardOutput().trimmed();
        QFileInfo fi(QString::fromLocal8Bit(ba) + "/..");
161
        sp.qtInstallPath = fi.absoluteFilePath();
162 163
    }
    return sp;
164 165
}

166 167
RunControl *DebuggerRunControlFactory::create
    (RunConfiguration *runConfiguration, const QString &mode)
con's avatar
con committed
168
{
hjk's avatar
hjk committed
169
    QTC_ASSERT(mode == ProjectExplorer::Constants::DEBUGMODE, return 0);
170
    DebuggerStartParameters sp = localStartParameters(runConfiguration);
171
    return create(sp);
172 173
}

174
RunControl *DebuggerRunControlFactory::create(const DebuggerStartParameters &sp)
175
{
176 177 178 179 180 181 182 183 184 185 186
    DebuggerRunControl *runControl = new DebuggerRunControl;
    runControl->setEnabledEngines(m_enabledEngines);
    runControl->createEngine(sp);
    if (!runControl->engine()) {
        qDebug() << "FAILED TO CREATE ENGINE";
        delete runControl;
        return 0;
    }
    connect(runControl, SIGNAL(started()), runControl, SLOT(handleStarted()));
    connect(runControl, SIGNAL(finished()), runControl, SLOT(handleFinished()));
    return runControl;
con's avatar
con committed
187 188
}

189
QWidget *DebuggerRunControlFactory::createConfigurationWidget(RunConfiguration *runConfiguration)
con's avatar
con committed
190 191
{
    // NBS TODO: Add GDB-specific configuration widget
192
    Q_UNUSED(runConfiguration)
con's avatar
con committed
193 194 195 196
    return 0;
}


197 198
////////////////////////////////////////////////////////////////////////
//
199
// DebuggerRunControl
200 201 202
//
////////////////////////////////////////////////////////////////////////

203 204
DebuggerRunControl::DebuggerRunControl(QObject *parent)
    : RunControl(0, ProjectExplorer::Constants::DEBUGMODE)
205
{
206
    Q_UNUSED(parent);
207
    m_running = false;
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
    m_engine = 0;
    m_enabledEngines = AllEngineTypes;
}

static DebuggerEngineType engineForToolChain(int toolChainType)
{
    switch (toolChainType) {
        case ProjectExplorer::ToolChain::LINUX_ICC:
        case ProjectExplorer::ToolChain::MinGW:
        case ProjectExplorer::ToolChain::GCC:
        case ProjectExplorer::ToolChain::WINSCW: // S60
        case ProjectExplorer::ToolChain::GCCE:
        case ProjectExplorer::ToolChain::RVCT_ARMV5:
        case ProjectExplorer::ToolChain::RVCT_ARMV6:
        case ProjectExplorer::ToolChain::RVCT_ARMV5_GNUPOC:
        case ProjectExplorer::ToolChain::GCCE_GNUPOC:
            return GdbEngineType;

        case ProjectExplorer::ToolChain::MSVC:
        case ProjectExplorer::ToolChain::WINCE:
            return CdbEngineType;

        case ProjectExplorer::ToolChain::OTHER:
        case ProjectExplorer::ToolChain::UNKNOWN:
        case ProjectExplorer::ToolChain::INVALID:
        default:
            break;
    }
    return NoEngineType;
237 238
}

239 240 241 242

// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
DebuggerEngineType DebuggerRunControl::engineForExecutable(const QString &executable)
243
{
244 245 246 247 248
    if (executable.endsWith(_("qmlviewer"))) {
        if (m_enabledEngines & QmlEngineType)
            return QmlEngineType;
        m_errorMessage = msgEngineNotAvailable("Qml Engine");
    }
249

250 251 252 253 254
    if (executable.endsWith(_(".js"))) {
        if (m_enabledEngines & ScriptEngineType)
            return ScriptEngineType;
        m_errorMessage = msgEngineNotAvailable("Script Engine");
    }
con's avatar
con committed
255

256 257 258 259 260
    if (executable.endsWith(_(".py"))) {
        if (m_enabledEngines & PdbEngineType)
            return PdbEngineType;
        m_errorMessage = msgEngineNotAvailable("Pdb Engine");
    }
con's avatar
con committed
261

262 263 264
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
Friedemann Kleint's avatar
Friedemann Kleint committed
265
        return GdbEngineType;
266 267 268

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
Friedemann Kleint's avatar
Friedemann Kleint committed
269
    if (!getPDBFiles(executable, &pdbFiles, &m_errorMessage)) {
270 271
        qWarning("Cannot determine type of executable %s: %s",
                 qPrintable(executable), qPrintable(m_errorMessage));
Friedemann Kleint's avatar
Friedemann Kleint committed
272
        return NoEngineType;
273 274 275
    }
    if (pdbFiles.empty())
        return GdbEngineType;
276

277 278
    // We need the CDB debugger in order to be able to debug VS
    // executables
Friedemann Kleint's avatar
Friedemann Kleint committed
279
    if (checkDebugConfiguration(ToolChain::MSVC, &m_errorMessage, 0, &m_settingsIdHint))
280 281 282 283 284 285
        return CdbEngineType;
#else
    if (m_enabledEngines & GdbEngineType)
        return GdbEngineType;
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
#endif
286

287
    return NoEngineType;
288 289
}

290 291
// Debugger type for mode.
DebuggerEngineType DebuggerRunControl::engineForMode(DebuggerStartMode startMode)
292
{
293 294
    if (startMode == AttachTcf)
        return TcfEngineType;
295

296 297
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
Friedemann Kleint's avatar
Friedemann Kleint committed
298
    if (startMode != AttachToRemote)
299
        return CdbEngineType;
Friedemann Kleint's avatar
Friedemann Kleint committed
300
    return GdbEngineType;
301 302 303 304 305 306 307
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return NoEngineType;
#else
    Q_UNUSED(startMode)
    //  m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return GdbEngineType;
#endif
308 309
}

310
void DebuggerRunControl::setEnabledEngines(DebuggerEngineType enabledEngines)
311
{
312
    m_enabledEngines = enabledEngines;
313 314
}

315
void DebuggerRunControl::createEngine(const DebuggerStartParameters &sp)
316
{
317
    // Figure out engine according to toolchain, executable, attach or default.
con's avatar
con committed
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
    DebuggerEngineType engineType = NoEngineType;
    QString errorMessage;
    QString settingsIdHint;

    if (sp.executable.endsWith(_("qmlviewer")))
        engineType = QmlEngineType;
    else if (sp.executable.endsWith(_(".js")))
        engineType = ScriptEngineType;
    else if (sp.executable.endsWith(_(".py")))
        engineType = PdbEngineType;
    else
        engineType = engineForToolChain(sp.toolChainType);

    if (engineType == NoEngineType
            && sp.startMode != AttachToRemote
            && !sp.executable.isEmpty())
        engineType = engineForExecutable(sp.executable);

    if (!engineType)
        engineType = engineForMode(sp.startMode);

Friedemann Kleint's avatar
Friedemann Kleint committed
340
    // qDebug() << "USING ENGINE : " << engineType;
341 342 343 344

    switch (engineType) {
        case GdbEngineType:
            m_engine = createGdbEngine(sp);
345
            break;
346 347
        case ScriptEngineType:
            m_engine = createScriptEngine(sp);
348
            break;
349 350
        case CdbEngineType:
            m_engine = createCdbEngine(sp);
351
            break;
352 353
        case PdbEngineType:
            m_engine = createPdbEngine(sp);
354
            break;
355 356
        case TcfEngineType:
            m_engine = createTcfEngine(sp);
357
            break;
358 359 360 361 362 363 364 365 366 367 368 369
        case QmlEngineType:
            m_engine = createQmlEngine(sp);
            break;
        default: {
            // Could not find anything suitable.
            emit debuggingFinished();
            // Create Message box with possibility to go to settings
            const QString msg = tr("Cannot debug '%1' (tool chain: '%2'): %3")
                .arg(sp.executable, toolChainName(sp.toolChainType), m_errorMessage);
            Core::ICore::instance()->showWarningWithOptions(tr("Warning"),
                msg, QString(), QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY),
                m_settingsIdHint);
370
            break;
371
        }
372
    }
373 374
}

375
DebuggerRunControl::~DebuggerRunControl()
376
{
377
    delete m_engine;
378 379
}

380
QString DebuggerRunControl::displayName() const
381
{
382 383
    QTC_ASSERT(m_engine, return QString());
    return m_engine->startParameters().displayName;
384 385
}

386
void DebuggerRunControl::setCustomEnvironment(ProjectExplorer::Environment env)
387
{
388
    m_engine->startParameters().environment = env.toStringList();
389 390
}

391
void DebuggerRunControl::init()
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
bool DebuggerRunControl::checkDebugConfiguration(int toolChain,
                                              QString *errorMessage,
                                              QString *settingsCategory /* = 0 */,
                                              QString *settingsPage /* = 0 */)
{
    errorMessage->clear();
    if (settingsCategory)
        settingsCategory->clear();
    if (settingsPage)
        settingsPage->clear();

    bool success = true;

    switch(toolChain) {
    case ProjectExplorer::ToolChain::GCC:
    case ProjectExplorer::ToolChain::LINUX_ICC:
    case ProjectExplorer::ToolChain::MinGW:
    case ProjectExplorer::ToolChain::WINCE: // S60
    case ProjectExplorer::ToolChain::WINSCW:
    case ProjectExplorer::ToolChain::GCCE:
    case ProjectExplorer::ToolChain::RVCT_ARMV5:
    case ProjectExplorer::ToolChain::RVCT_ARMV6:
        success = checkGdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success)
            *errorMessage = msgEngineNotAvailable("Gdb");
        break;
    case ProjectExplorer::ToolChain::MSVC:
        success = checkCdbConfiguration(toolChain, errorMessage, settingsPage);
        if (!success) {
            *errorMessage = msgEngineNotAvailable("Cdb");
            if (settingsPage)
                *settingsPage = QLatin1String("Cdb");
        }
        break;
    }
    if (!success && settingsCategory && settingsPage && !settingsPage->isEmpty())
        *settingsCategory = QLatin1String(Constants::DEBUGGER_SETTINGS_CATEGORY);
hjk's avatar
hjk committed
432

433
    return success;
434 435
}

436
void DebuggerRunControl::start()
437
{
438 439
    QTC_ASSERT(m_engine, return);
    const DebuggerStartParameters &sp = m_engine->startParameters();
440

441 442 443 444
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
    QString settingsIdHint;
445

446 447 448 449 450 451
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
452
        return;
453
    }
454

455
    plugin()->activateDebugMode();
456

457 458 459
    showMessage(tr("Starting debugger for tool chain '%1'...")
        .arg(toolChainName(sp.toolChainType)), LogStatus);
    showMessage(DebuggerSettings::instance()->dump(), LogDebug);
460

461 462
    plugin()->setBusyCursor(false);
    engine()->startDebugger(this);
463 464
}

465
void DebuggerRunControl::startSuccessful()
466
{
467 468
    m_running = true;
    emit started();
469 470
}

471
void DebuggerRunControl::startFailed()
472
{
473 474
    m_running = false;
    emit finished();
475 476
}

477
void DebuggerRunControl::handleStarted()
478
{
479
    plugin()->runControlStarted(this);
480 481
}

482
void DebuggerRunControl::handleFinished()
483
{
484
    plugin()->runControlFinished(this);
485 486
}

487
void DebuggerRunControl::showMessage(const QString &msg, int channel)
488
{
489 490 491 492 493 494 495 496 497 498 499
    switch (channel) {
        case AppOutput:
            emit addToOutputWindowInline(this, msg, false);
            break;
        case AppError:
            emit addToOutputWindowInline(this, msg, true);
            break;
        case AppStuff:
            emit appendMessage(this, msg, true);
            break;
    }
500 501
}

502
void DebuggerRunControl::stop()
503
{
504 505 506
    m_running = false;
    QTC_ASSERT(m_engine, return);
    m_engine->exitDebugger();
507 508
}

509
void DebuggerRunControl::debuggingFinished()
510
{
511 512
    m_running = false;
    emit finished();
513 514
}

515
bool DebuggerRunControl::isRunning() const
516
{
517
    return m_running;
518 519
}

Friedemann Kleint's avatar
Friedemann Kleint committed
520 521 522 523 524 525
DebuggerState DebuggerRunControl::state() const
{
    QTC_ASSERT(m_engine, return DebuggerNotReady);
    return m_engine->state();
}

526
Internal::DebuggerEngine *DebuggerRunControl::engine()
527
{
528 529
    QTC_ASSERT(m_engine, /**/);
    return m_engine;
530 531 532
}


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