debuggerrunner.cpp 16.9 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
    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();
148 149 150 151
    // 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;
152
    sp.displayName = rc->displayName();
153

154 155
    // Find qtInstallPath.
    QString qmakePath = DebuggingHelperLibrary::findSystemQt(rc->environment());
156 157 158 159 160 161 162 163 164
    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) + "/..");
165
        sp.qtInstallPath = fi.absoluteFilePath();
166 167
    }
    return sp;
168 169
}

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

178 179
DebuggerRunControl *DebuggerRunControlFactory::create(
    const DebuggerStartParameters &sp,
180
    RunConfiguration *runConfiguration)
181
{
182 183
    DebuggerRunControl *runControl =
        new DebuggerRunControl(runConfiguration, m_enabledEngines, sp);
184 185 186 187 188 189 190 191
    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
192 193
}

194 195
QWidget *DebuggerRunControlFactory::createConfigurationWidget
    (RunConfiguration *runConfiguration)
con's avatar
con committed
196 197
{
    // NBS TODO: Add GDB-specific configuration widget
198
    Q_UNUSED(runConfiguration)
con's avatar
con committed
199 200 201 202
    return 0;
}


203 204
////////////////////////////////////////////////////////////////////////
//
205
// DebuggerRunControl
206 207 208
//
////////////////////////////////////////////////////////////////////////

209 210
DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
        DebuggerEngineType enabledEngines, const DebuggerStartParameters &sp)
211
    : RunControl(runConfiguration, ProjectExplorer::Constants::DEBUGMODE)
212
{
213
    m_running = false;
214
    m_enabledEngines = enabledEngines;
215
    m_engine = 0;
216
    createEngine(sp);
217 218
}

219 220 221 222 223 224 225 226 227
DebuggerRunControl::~DebuggerRunControl()
{
    disconnect();
    DebuggerEngine *engine = m_engine;
    m_engine = 0;
    engine->disconnect();
    delete engine;
}

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
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;
253 254
}

255 256 257 258

// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
DebuggerEngineType DebuggerRunControl::engineForExecutable(const QString &executable)
259
{
260 261 262 263 264
    if (executable.endsWith(_("qmlviewer"))) {
        if (m_enabledEngines & QmlEngineType)
            return QmlEngineType;
        m_errorMessage = msgEngineNotAvailable("Qml Engine");
    }
265

266 267 268 269 270
    if (executable.endsWith(_(".js"))) {
        if (m_enabledEngines & ScriptEngineType)
            return ScriptEngineType;
        m_errorMessage = msgEngineNotAvailable("Script Engine");
    }
con's avatar
con committed
271

272 273 274 275 276
    if (executable.endsWith(_(".py"))) {
        if (m_enabledEngines & PdbEngineType)
            return PdbEngineType;
        m_errorMessage = msgEngineNotAvailable("Pdb Engine");
    }
con's avatar
con committed
277

278 279 280
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
Friedemann Kleint's avatar
Friedemann Kleint committed
281
        return GdbEngineType;
282 283 284

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
Friedemann Kleint's avatar
Friedemann Kleint committed
285
    if (!getPDBFiles(executable, &pdbFiles, &m_errorMessage)) {
286 287
        qWarning("Cannot determine type of executable %s: %s",
                 qPrintable(executable), qPrintable(m_errorMessage));
Friedemann Kleint's avatar
Friedemann Kleint committed
288
        return NoEngineType;
289 290 291
    }
    if (pdbFiles.empty())
        return GdbEngineType;
292

293 294
    // We need the CDB debugger in order to be able to debug VS
    // executables
Friedemann Kleint's avatar
Friedemann Kleint committed
295
    if (checkDebugConfiguration(ToolChain::MSVC, &m_errorMessage, 0, &m_settingsIdHint))
296 297 298 299 300 301
        return CdbEngineType;
#else
    if (m_enabledEngines & GdbEngineType)
        return GdbEngineType;
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
#endif
302

303
    return NoEngineType;
304 305
}

306 307
// Debugger type for mode.
DebuggerEngineType DebuggerRunControl::engineForMode(DebuggerStartMode startMode)
308
{
309 310
    if (startMode == AttachTcf)
        return TcfEngineType;
311

312 313
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
Friedemann Kleint's avatar
Friedemann Kleint committed
314
    if (startMode != AttachToRemote)
315
        return CdbEngineType;
Friedemann Kleint's avatar
Friedemann Kleint committed
316
    return GdbEngineType;
317 318 319 320 321 322 323
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return NoEngineType;
#else
    Q_UNUSED(startMode)
    //  m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return GdbEngineType;
#endif
324 325
}

326
void DebuggerRunControl::createEngine(const DebuggerStartParameters &sp)
327
{
328 329 330 331 332 333 334 335 336 337 338 339 340 341
    // Figure out engine according to toolchain, executable, attach or default.
    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);

342 343 344 345
    // Fixme: 1 of 3 testing hacks.
    if (sp.processArgs.size() >= 5 && sp.processArgs.at(0) == _("@tcf@"))
        engineType = GdbEngineType;

346 347 348 349 350 351 352 353
    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
354
    // qDebug() << "USING ENGINE : " << engineType;
355 356 357 358

    switch (engineType) {
        case GdbEngineType:
            m_engine = createGdbEngine(sp);
359
            break;
360 361
        case ScriptEngineType:
            m_engine = createScriptEngine(sp);
362
            break;
363 364
        case CdbEngineType:
            m_engine = createCdbEngine(sp);
365
            break;
366 367
        case PdbEngineType:
            m_engine = createPdbEngine(sp);
368
            break;
369 370
        case TcfEngineType:
            m_engine = createTcfEngine(sp);
371
            break;
372 373 374 375 376
        case QmlEngineType:
            m_engine = createQmlEngine(sp);
            break;
        default: {
            // Could not find anything suitable.
377
            debuggingFinished();
378 379 380 381 382 383
            // 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);
384
            break;
385
        }
386
    }
387 388
}

389
QString DebuggerRunControl::displayName() const
390
{
391 392
    QTC_ASSERT(m_engine, return QString());
    return m_engine->startParameters().displayName;
393 394
}

395
void DebuggerRunControl::setCustomEnvironment(ProjectExplorer::Environment env)
396
{
397
    m_engine->startParameters().environment = env.toStringList();
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
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
437

438
    return success;
439 440
}

441
void DebuggerRunControl::start()
442
{
443 444
    QTC_ASSERT(m_engine, return);
    const DebuggerStartParameters &sp = m_engine->startParameters();
445

446 447 448 449
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
    QString settingsIdHint;
450

451 452 453 454 455 456
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
457
        return;
458
    }
459

460
    plugin()->activateDebugMode();
461 462 463
    plugin()->showMessage(tr("Starting debugger for tool chain '%1'...")
        .arg(toolChainName(sp.toolChainType)), StatusBar);
    plugin()->showMessage(DebuggerSettings::instance()->dump(), LogDebug);
464

465
    engine()->startDebugger(this);
466 467
}

468
void DebuggerRunControl::startSuccessful()
469
{
470 471
    m_running = true;
    emit started();
472 473
}

474
void DebuggerRunControl::startFailed()
475
{
476 477
    m_running = false;
    emit finished();
478
    engine()->handleStartFailed();
479 480
}

481
void DebuggerRunControl::handleStarted()
482
{
483
    plugin()->runControlStarted(this);
484 485
}

486
void DebuggerRunControl::handleFinished()
487
{
488
    engine()->handleFinished();
489
    plugin()->runControlFinished(this);
490 491
}

492
void DebuggerRunControl::showMessage(const QString &msg, int channel)
493
{
494 495 496 497 498 499 500 501 502 503 504
    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;
    }
505 506
}

507
void DebuggerRunControl::stop()
508
{
509 510
    m_running = false;
    QTC_ASSERT(m_engine, return);
511
    m_engine->quitDebugger();
512 513
}

514
void DebuggerRunControl::debuggingFinished()
515
{
516 517
    m_running = false;
    emit finished();
518 519
}

520
bool DebuggerRunControl::isRunning() const
521
{
522
    return m_running;
523 524
}

Friedemann Kleint's avatar
Friedemann Kleint committed
525 526 527 528 529 530
DebuggerState DebuggerRunControl::state() const
{
    QTC_ASSERT(m_engine, return DebuggerNotReady);
    return m_engine->state();
}

531
Internal::DebuggerEngine *DebuggerRunControl::engine()
532
{
533 534
    QTC_ASSERT(m_engine, /**/);
    return m_engine;
535 536 537
}


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