debuggerrunner.cpp 18 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
#include "debuggeruiswitcher.h"
38

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

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

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

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

61
#include <QtGui/QAbstractItemView>
62
#include <QtGui/QTextDocument>
63
#include <QtGui/QTreeWidget>
64
#include <QtGui/QMessageBox>
con's avatar
con committed
65

66
using namespace ProjectExplorer;
67 68
using namespace Debugger::Internal;

69 70 71 72 73 74 75 76 77
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
78
bool checkGdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
79 80 81 82 83 84 85

// 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
86 87
#ifdef CDB_ENABLED
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &);
88
bool checkCdbConfiguration(int toolChain, QString *errorMsg, QString *settingsPage);
hjk's avatar
hjk committed
89 90 91 92
#else
DebuggerEngine *createCdbEngine(const DebuggerStartParameters &) { return 0; }
bool checkCdbConfiguration(int, QString *, QString *) { return false; }
#endif
93

hjk's avatar
hjk committed
94
} // namespace Internal
95 96 97 98 99 100

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

101

con's avatar
con committed
102 103
////////////////////////////////////////////////////////////////////////
//
104
// DebuggerRunControlFactory
con's avatar
con committed
105 106 107
//
////////////////////////////////////////////////////////////////////////

108 109 110 111 112 113 114
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(); }
115

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

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

129
QString DebuggerRunControlFactory::displayName() const
con's avatar
con committed
130
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
131
    return tr("Debug");
con's avatar
con committed
132 133
}

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

142 143 144 145 146 147 148 149 150
    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();
151 152 153 154
    // 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;
155
    sp.displayName = rc->displayName();
156

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

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

181 182
DebuggerRunControl *DebuggerRunControlFactory::create(
    const DebuggerStartParameters &sp,
183
    RunConfiguration *runConfiguration)
184
{
185 186
    DebuggerRunControl *runControl =
        new DebuggerRunControl(runConfiguration, m_enabledEngines, sp);
187 188 189 190 191 192 193
    if (!runControl->engine()) {
        qDebug() << "FAILED TO CREATE ENGINE";
        delete runControl;
        return 0;
    }
    connect(runControl, SIGNAL(finished()), runControl, SLOT(handleFinished()));
    return runControl;
con's avatar
con committed
194 195
}

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


205 206
////////////////////////////////////////////////////////////////////////
//
207
// DebuggerRunControl
208 209 210
//
////////////////////////////////////////////////////////////////////////

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

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

231 232 233 234 235 236
const DebuggerStartParameters &DebuggerRunControl::startParameters() const
{
    QTC_ASSERT(m_engine, return *(new DebuggerStartParameters()));
    return m_engine->startParameters();
}

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
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;
262 263
}

264 265 266 267

// Figure out the debugger type of an executable. Analyze executable
// unless the toolchain provides a hint.
DebuggerEngineType DebuggerRunControl::engineForExecutable(const QString &executable)
268
{
269 270 271 272 273
    if (executable.endsWith(_("qmlviewer"))) {
        if (m_enabledEngines & QmlEngineType)
            return QmlEngineType;
        m_errorMessage = msgEngineNotAvailable("Qml Engine");
    }
274

275 276 277 278 279
    if (executable.endsWith(_(".js"))) {
        if (m_enabledEngines & ScriptEngineType)
            return ScriptEngineType;
        m_errorMessage = msgEngineNotAvailable("Script Engine");
    }
con's avatar
con committed
280

281 282 283 284 285
    if (executable.endsWith(_(".py"))) {
        if (m_enabledEngines & PdbEngineType)
            return PdbEngineType;
        m_errorMessage = msgEngineNotAvailable("Pdb Engine");
    }
con's avatar
con committed
286

287 288 289
#ifdef Q_OS_WIN
    // A remote executable?
    if (!executable.endsWith(_(".exe")))
Friedemann Kleint's avatar
Friedemann Kleint committed
290
        return GdbEngineType;
291 292 293

    // If a file has PDB files, it has been compiled by VS.
    QStringList pdbFiles;
Friedemann Kleint's avatar
Friedemann Kleint committed
294
    if (!getPDBFiles(executable, &pdbFiles, &m_errorMessage)) {
295 296
        qWarning("Cannot determine type of executable %s: %s",
                 qPrintable(executable), qPrintable(m_errorMessage));
Friedemann Kleint's avatar
Friedemann Kleint committed
297
        return NoEngineType;
298 299 300
    }
    if (pdbFiles.empty())
        return GdbEngineType;
301

302 303
    // We need the CDB debugger in order to be able to debug VS
    // executables
Friedemann Kleint's avatar
Friedemann Kleint committed
304
    if (checkDebugConfiguration(ToolChain::MSVC, &m_errorMessage, 0, &m_settingsIdHint))
305 306 307 308 309 310
        return CdbEngineType;
#else
    if (m_enabledEngines & GdbEngineType)
        return GdbEngineType;
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
#endif
311

312
    return NoEngineType;
313 314
}

315 316
// Debugger type for mode.
DebuggerEngineType DebuggerRunControl::engineForMode(DebuggerStartMode startMode)
317
{
318 319
    if (startMode == AttachTcf)
        return TcfEngineType;
320

321 322
#ifdef Q_OS_WIN
    // Preferably Windows debugger for attaching locally.
Friedemann Kleint's avatar
Friedemann Kleint committed
323
    if (startMode != AttachToRemote)
324
        return CdbEngineType;
Friedemann Kleint's avatar
Friedemann Kleint committed
325
    return GdbEngineType;
326 327 328 329 330 331 332
    m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return NoEngineType;
#else
    Q_UNUSED(startMode)
    //  m_errorMessage = msgEngineNotAvailable("Gdb Engine");
    return GdbEngineType;
#endif
333 334
}

335
void DebuggerRunControl::createEngine(const DebuggerStartParameters &sp)
336
{
337 338 339 340 341
    // Figure out engine according to toolchain, executable, attach or default.
    DebuggerEngineType engineType = NoEngineType;
    QString errorMessage;
    QString settingsIdHint;

342 343 344 345 346
    bool isQmlExecutable = sp.executable.endsWith(_("qmlviewer")) || sp.executable.endsWith(_("qmlobserver"));
#ifdef Q_OS_MAC
    isQmlExecutable = sp.executable.endsWith(_("QMLViewer.app")) || sp.executable.endsWith(_("QMLObserver.app"));
#endif
    if (isQmlExecutable)
347 348 349 350 351 352 353 354
        engineType = QmlEngineType;
    else if (sp.executable.endsWith(_(".js")))
        engineType = ScriptEngineType;
    else if (sp.executable.endsWith(_(".py")))
        engineType = PdbEngineType;
    else
        engineType = engineForToolChain(sp.toolChainType);

355 356 357 358
    // Fixme: 1 of 3 testing hacks.
    if (sp.processArgs.size() >= 5 && sp.processArgs.at(0) == _("@tcf@"))
        engineType = GdbEngineType;

359 360 361 362 363 364 365 366
    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
367
    // qDebug() << "USING ENGINE : " << engineType;
368 369 370 371

    switch (engineType) {
        case GdbEngineType:
            m_engine = createGdbEngine(sp);
372
            break;
373 374
        case ScriptEngineType:
            m_engine = createScriptEngine(sp);
375
            break;
376 377
        case CdbEngineType:
            m_engine = createCdbEngine(sp);
378
            break;
379 380
        case PdbEngineType:
            m_engine = createPdbEngine(sp);
381
            break;
382 383
        case TcfEngineType:
            m_engine = createTcfEngine(sp);
384
            break;
385 386 387 388 389
        case QmlEngineType:
            m_engine = createQmlEngine(sp);
            break;
        default: {
            // Could not find anything suitable.
390
            debuggingFinished();
391 392 393 394 395 396
            // 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);
397
            break;
398
        }
399
    }
400 401
}

402
QString DebuggerRunControl::displayName() const
403
{
404 405
    QTC_ASSERT(m_engine, return QString());
    return m_engine->startParameters().displayName;
406 407
}

408
void DebuggerRunControl::setCustomEnvironment(ProjectExplorer::Environment env)
409
{
410
    m_engine->startParameters().environment = env.toStringList();
411 412
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
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
450

451
    return success;
452 453
}

454
void DebuggerRunControl::start()
455
{
456 457
    QTC_ASSERT(m_engine, return);
    const DebuggerStartParameters &sp = m_engine->startParameters();
458

459 460 461
    QString errorMessage;
    QString settingsCategory;
    QString settingsPage;
462

463 464 465 466 467 468
    if (!checkDebugConfiguration(sp.toolChainType,
            &errorMessage, &settingsCategory, &settingsPage)) {
        emit appendMessage(this, errorMessage, true);
        emit finished();
        Core::ICore::instance()->showWarningWithOptions(tr("Debugger"),
            errorMessage, QString(), settingsCategory, settingsPage);
469
        return;
470
    }
471

Friedemann Kleint's avatar
Friedemann Kleint committed
472 473 474 475 476
    plugin()->activateDebugMode();    

    const QString message = tr("Starting debugger '%1' for tool chain '%2'...").
                  arg(m_engine->objectName(), toolChainName(sp.toolChainType));
    plugin()->showMessage(message, StatusBar);
477
    plugin()->showMessage(DebuggerSettings::instance()->dump(), LogDebug);
478

479 480
    engine()->startDebugger(this);
    m_running = true;
Friedemann Kleint's avatar
Friedemann Kleint committed
481
    plugin()->runControlStarted(this);
482
    emit started();
483 484
}

485
void DebuggerRunControl::startFailed()
486
{
487 488
    m_running = false;
    emit finished();
489
    engine()->handleStartFailed();
490 491
}

492
void DebuggerRunControl::handleFinished()
493
{
494
    engine()->handleFinished();
495
    plugin()->runControlFinished(this);
496 497
}

498
void DebuggerRunControl::showMessage(const QString &msg, int channel)
499
{
500 501 502 503 504 505 506 507 508 509 510
    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;
    }
511 512
}

513
bool DebuggerRunControl::aboutToStop() const
514
{
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
    QTC_ASSERT(isRunning(), return true;)

    const QString question = tr("A debugging session are still in progress. "
            "Terminating the session in the current"
            " state can leave the target in an inconsistent state."
            " Would you still like to terminate it?");

    const QMessageBox::StandardButton answer =
            QMessageBox::question(DebuggerUISwitcher::instance()->mainWindow(),
                                  tr("Close Debugging Session"), question,
                                  QMessageBox::Yes|QMessageBox::No);
    return answer == QMessageBox::Yes;
}

RunControl::StopResult DebuggerRunControl::stop()
{
    QTC_ASSERT(m_engine, return StoppedSynchronously);
532
    m_engine->quitDebugger();
533
    return AsynchronousStop;
534 535
}

536
void DebuggerRunControl::debuggingFinished()
537
{
538 539
    m_running = false;
    emit finished();
540 541
}

542
bool DebuggerRunControl::isRunning() const
543
{
544
    return m_running;
545 546
}

Friedemann Kleint's avatar
Friedemann Kleint committed
547 548 549 550 551 552
DebuggerState DebuggerRunControl::state() const
{
    QTC_ASSERT(m_engine, return DebuggerNotReady);
    return m_engine->state();
}

553
Internal::DebuggerEngine *DebuggerRunControl::engine()
554
{
555 556
    QTC_ASSERT(m_engine, /**/);
    return m_engine;
557 558 559
}


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