debuggerplugin.cpp 55.6 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 "debuggerplugin.h"

32
#include "breakhandler.h"
33
#include "debuggeractions.h"
34
#include "debuggerdialogs.h"
con's avatar
con committed
35 36 37
#include "debuggerconstants.h"
#include "debuggermanager.h"
#include "debuggerrunner.h"
38
#include "debuggerstringutils.h"
39 40
#include "debuggeruiswitcher.h"
#include "debuggermainwindow.h"
con's avatar
con committed
41

42
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
43
#include "ui_dumperoptionpage.h"
44

45
#include <coreplugin/actionmanager/actionmanager.h>
46 47
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
hjk's avatar
hjk committed
48
#include <coreplugin/basemode.h>
con's avatar
con committed
49
#include <coreplugin/coreconstants.h>
50
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
51
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
52
#include <coreplugin/findplaceholder.h>
con's avatar
con committed
53
#include <coreplugin/icore.h>
54
#include <coreplugin/icorelistener.h>
con's avatar
con committed
55
#include <coreplugin/messagemanager.h>
hjk's avatar
hjk committed
56
#include <coreplugin/minisplitter.h>
con's avatar
con committed
57
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
58 59 60
#include <coreplugin/navigationwidget.h>
#include <coreplugin/outputpane.h>
#include <coreplugin/rightpane.h>
con's avatar
con committed
61
#include <coreplugin/uniqueidmanager.h>
hjk's avatar
hjk committed
62

con's avatar
con committed
63
#include <cplusplus/ExpressionUnderCursor.h>
hjk's avatar
hjk committed
64

con's avatar
con committed
65
#include <cppeditor/cppeditorconstants.h>
hjk's avatar
hjk committed
66

67 68
#include <extensionsystem/pluginmanager.h>

69
#include <coreplugin/manhattanstyle.h>
70
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
71 72
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
73
#include <projectexplorer/project.h>
hjk's avatar
hjk committed
74 75

#include <texteditor/basetexteditor.h>
con's avatar
con committed
76 77 78
#include <texteditor/basetextmark.h>
#include <texteditor/itexteditor.h>
#include <texteditor/texteditorconstants.h>
79
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
80 81

#include <utils/qtcassert.h>
82
#include <utils/styledbar.h>
83
#include <utils/savedaction.h>
con's avatar
con committed
84 85 86 87 88

#include <QtCore/QDebug>
#include <QtCore/QObject>
#include <QtCore/QPoint>
#include <QtCore/QSettings>
89
#include <QtCore/QtPlugin>
90
#include <QtCore/QCoreApplication>
91
#include <QtCore/QTimer>
92
#include <QtCore/QVariant>
hjk's avatar
hjk committed
93

94
#include <QtGui/QLineEdit>
95
#include <QtGui/QDockWidget>
con's avatar
con committed
96 97 98
#include <QtGui/QPlainTextEdit>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
99
#include <QtGui/QToolButton>
100
#include <QtGui/QMessageBox>
101 102
#include <QtGui/QAction>
#include <QtGui/QMenu>
con's avatar
con committed
103

104 105
#include <climits>

con's avatar
con committed
106
using namespace Core;
107
using namespace Debugger;
hjk's avatar
hjk committed
108 109
using namespace Debugger::Constants;
using namespace Debugger::Internal;
con's avatar
con committed
110
using namespace ProjectExplorer;
hjk's avatar
hjk committed
111
using namespace TextEditor;
con's avatar
con committed
112

hjk's avatar
hjk committed
113 114 115
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
116 117 118 119

namespace Debugger {
namespace Constants {

120 121
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
122 123
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
124
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
125
const char * const ATTACHTCF            = "Debugger.AttachTcf";
126
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
127
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
128

129 130
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
131
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
132 133
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
134
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
135
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
136 137 138
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
139 140
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
141
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
con's avatar
con committed
142

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
143
#ifdef Q_WS_MAC
con's avatar
con committed
144 145 146 147 148
const char * const INTERRUPT_KEY            = "Shift+F5";
const char * const RESET_KEY                = "Ctrl+Shift+F5";
const char * const STEP_KEY                 = "F7";
const char * const STEPOUT_KEY              = "Shift+F7";
const char * const NEXT_KEY                 = "F6";
149
const char * const REVERSE_KEY              = "";
con's avatar
con committed
150 151 152 153 154 155 156
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
const char * const JUMP_TO_LINE_KEY         = "Alt+D,Alt+L";
const char * const TOGGLE_BREAK_KEY         = "F8";
const char * const BREAK_BY_FUNCTION_KEY    = "Alt+D,Alt+F";
const char * const BREAK_AT_MAIN_KEY        = "Alt+D,Alt+M";
const char * const ADD_TO_WATCH_KEY         = "Alt+D,Alt+W";
157
const char * const SNAPSHOT_KEY             = "Alt+D,Alt+S";
con's avatar
con committed
158 159 160 161 162 163
#else
const char * const INTERRUPT_KEY            = "Shift+F5";
const char * const RESET_KEY                = "Ctrl+Shift+F5";
const char * const STEP_KEY                 = "F11";
const char * const STEPOUT_KEY              = "Shift+F11";
const char * const NEXT_KEY                 = "F10";
164
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
165 166 167 168 169 170 171
const char * const RUN_TO_LINE_KEY          = "";
const char * const RUN_TO_FUNCTION_KEY      = "";
const char * const JUMP_TO_LINE_KEY         = "";
const char * const TOGGLE_BREAK_KEY         = "F9";
const char * const BREAK_BY_FUNCTION_KEY    = "";
const char * const BREAK_AT_MAIN_KEY        = "";
const char * const ADD_TO_WATCH_KEY         = "Ctrl+Alt+Q";
172
const char * const SNAPSHOT_KEY             = "Alt+D,Alt+S";
con's avatar
con committed
173 174 175 176 177 178
#endif

} // namespace Constants
} // namespace Debugger


179 180 181 182 183
static ProjectExplorer::SessionManager *sessionManager()
{
    return ProjectExplorer::ProjectExplorerPlugin::instance()->session();
}

184 185 186 187 188
static QSettings *settings()
{
    return ICore::instance()->settings();
}

189 190 191 192 193 194 195
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

196 197 198 199 200 201
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
202 203 204 205 206 207 208 209 210 211 212 213 214
namespace Debugger {
namespace Internal {

class DebugMode : public Core::BaseMode
{
    Q_OBJECT

public:
    DebugMode(QObject *parent = 0);
    ~DebugMode();
};

DebugMode::DebugMode(QObject *parent)
hjk's avatar
hjk committed
215
  : BaseMode(parent)
hjk's avatar
hjk committed
216
{
217
    setDisplayName(tr("Debug"));
hjk's avatar
hjk committed
218
    setId(MODE_DEBUG);
hjk's avatar
hjk committed
219
    setIcon(QIcon(":/fancyactionbar/images/mode_Debug.png"));
hjk's avatar
hjk committed
220
    setPriority(P_MODE_DEBUG);
hjk's avatar
hjk committed
221 222 223 224 225 226 227 228
}

DebugMode::~DebugMode()
{
    // Make sure the editor manager does not get deleted
    EditorManager::instance()->setParent(0);
}

229 230 231 232 233 234
///////////////////////////////////////////////////////////////////////
//
// DebuggerListener: Close the debugging session if running.
//
///////////////////////////////////////////////////////////////////////

235 236
class DebuggerListener : public Core::ICoreListener
{
237 238
    Q_OBJECT
public:
hjk's avatar
hjk committed
239
    DebuggerListener() {}
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    virtual bool coreAboutToClose();
};

bool DebuggerListener::coreAboutToClose()
{
    DebuggerManager *mgr = DebuggerManager::instance();
    if (!mgr)
        return true;
    // Ask to terminate the session.
    bool cleanTermination = false;
    switch (mgr->state()) {
    case DebuggerNotReady:
        return true;
    case AdapterStarted:     // Most importantly, terminating a running
    case AdapterStartFailed: // debuggee can cause problems.
    case InferiorUnrunnable:
    case InferiorStartFailed:
    case InferiorStopped:
    case InferiorShutDown:
        cleanTermination = true;
        break;
    default:
        break;
    }
hjk's avatar
hjk committed
264

265
    const QString question = cleanTermination ?
hjk's avatar
hjk committed
266 267 268 269
        tr("A debugging session is still in progress.\n"
           "Would you like to terminate it?") :
        tr("A debugging session is still in progress. "
           "Terminating the session in the current"
270
           " state (%1) can leave the target in an inconsistent state."
271
           " Would you still like to terminate it?")
hjk's avatar
hjk committed
272 273 274 275 276 277 278
        .arg(_(DebuggerManager::stateName(mgr->state())));

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

279
    if (answer != QMessageBox::Yes)
280
        return false;
hjk's avatar
hjk committed
281

282
    mgr->exitDebugger();
283
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
284 285 286
    return true;
}

287 288 289
} // namespace Internal
} // namespace Debugger

hjk's avatar
hjk committed
290

con's avatar
con committed
291 292 293 294 295 296
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

297 298 299
namespace Debugger {
namespace Internal {

300
// Used in "real" editors
301
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
302 303 304 305 306 307
{
    Q_OBJECT

public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
308
    {}
con's avatar
con committed
309

310
    QIcon icon() const { return DebuggerManager::instance()->locationMarkIcon(); }
con's avatar
con committed
311 312
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
313
    void removedFromEditor() {}
con's avatar
con committed
314 315
};

316 317 318 319 320 321
} // namespace Internal
} // namespace Debugger


///////////////////////////////////////////////////////////////////////
//
322
// CommonOptionsPage
323 324 325 326 327 328
//
///////////////////////////////////////////////////////////////////////

namespace Debugger {
namespace Internal {

329
class CommonOptionsPage : public Core::IOptionsPage
330 331 332 333
{
    Q_OBJECT

public:
334
    CommonOptionsPage() {}
335 336

    // IOptionsPage
337
    QString id() const
hjk's avatar
hjk committed
338
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
339
    QString displayName() const
hjk's avatar
hjk committed
340
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
341
    QString category() const
hjk's avatar
hjk committed
342
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
343
    QString displayCategory() const
hjk's avatar
hjk committed
344
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
345 346
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
347 348

    QWidget *createPage(QWidget *parent);
349
    void apply() { m_group.apply(settings()); }
350
    void finish() { m_group.finish(); }
351
    virtual bool matches(const QString &s) const;
352 353

private:
354
    Ui::CommonOptionsPage m_ui;
355
    Utils::SavedActionSet m_group;
356
    QString m_searchKeywords;
357 358
};

359
QWidget *CommonOptionsPage::createPage(QWidget *parent)
360 361 362
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
363
    m_group.clear();
364

365 366 367
    m_group.insert(theDebuggerAction(SwitchLanguageAutomatically),
        m_ui.checkBoxChangeLanguageAutomatically);

368
    m_group.insert(theDebuggerAction(ListSourceFiles),
369
        m_ui.checkBoxListSourceFiles);
370
    m_group.insert(theDebuggerAction(UseAlternatingRowColors),
371
        m_ui.checkBoxUseAlternatingRowColors);
372
    m_group.insert(theDebuggerAction(UseToolTipsInMainEditor),
373
        m_ui.checkBoxUseToolTipsInMainEditor);
374
    m_group.insert(theDebuggerAction(AutoDerefPointers), 0);
375 376 377 378
    m_group.insert(theDebuggerAction(UseToolTipsInLocalsView), 0);
    m_group.insert(theDebuggerAction(UseToolTipsInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInStackView), 0);
379
    m_group.insert(theDebuggerAction(MaximalStackDepth),
380
        m_ui.spinBoxMaximalStackDepth);
381 382
    m_group.insert(theDebuggerAction(ShowStdNamespace), 0);
    m_group.insert(theDebuggerAction(ShowQtNamespace), 0);
383
    m_group.insert(theDebuggerAction(LogTimeStamps), 0);
384
    m_group.insert(theDebuggerAction(VerboseLog), 0);
385
    m_group.insert(theDebuggerAction(UsePreciseBreakpoints), 0);
386 387
    m_group.insert(theDebuggerAction(BreakOnThrow), 0);
    m_group.insert(theDebuggerAction(BreakOnCatch), 0);
388 389 390 391 392 393 394
#ifdef Q_OS_WIN
    Utils::SavedAction *registerAction = theDebuggerAction(RegisterForPostMortem);
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
395

396
    if (m_searchKeywords.isEmpty()) {
397 398 399
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxChangeLanguageAutomatically->text()
                << m_ui.checkBoxListSourceFiles->text()
400 401
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
402 403 404
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
405 406 407
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
408 409 410
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
411 412 413
    return w;
}

414 415 416 417 418
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

419 420 421
} // namespace Internal
} // namespace Debugger

hjk's avatar
hjk committed
422

hjk's avatar
hjk committed
423 424
///////////////////////////////////////////////////////////////////////
//
425
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
426 427 428
//
///////////////////////////////////////////////////////////////////////

429 430 431
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
432
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
433 434 435
    return false;
}

hjk's avatar
hjk committed
436 437 438
namespace Debugger {
namespace Internal {

439
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
440 441 442 443
{
    Q_OBJECT

public:
444
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
445 446

    // IOptionsPage
hjk's avatar
hjk committed
447
    QString id() const { return _("Z.DebuggingHelper"); }
448
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
449 450
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
    QString displayCategory() const { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
451
    QIcon categoryIcon() const { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
hjk's avatar
hjk committed
452 453

    QWidget *createPage(QWidget *parent);
454
    void apply() { m_group.apply(settings()); }
455
    void finish() { m_group.finish(); }
456
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
457 458

private:
459
    Ui::DebuggingHelperOptionPage m_ui;
460
    Utils::SavedActionSet m_group;
461
    QString m_searchKeywords;
hjk's avatar
hjk committed
462 463
};

464
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
465 466 467 468
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

469
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
470
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
471 472
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
        Core::ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
473

474
    m_group.clear();
475
    m_group.insert(theDebuggerAction(UseDebuggingHelpers),
476
        m_ui.debuggingHelperGroupBox);
477
    m_group.insert(theDebuggerAction(UseCustomDebuggingHelperLocation),
478
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
479
    // Suppress Oxygen style's giving flat group boxes bold titles.
480
    if (oxygenStyle())
hjk's avatar
hjk committed
481
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
482

483
    m_group.insert(theDebuggerAction(CustomDebuggingHelperLocation),
484
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
485

486 487 488
    m_group.insert(theDebuggerAction(UseCodeModel),
        m_ui.checkBoxUseCodeModel);

489
#ifdef QT_DEBUG
490 491
    m_group.insert(theDebuggerAction(DebugDebuggingHelpers),
        m_ui.checkBoxDebugDebuggingHelpers);
492 493 494
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
495 496 497 498

#ifndef QT_DEBUG
#if 0
    cmd = am->registerAction(m_manager->m_dumpLogAction,
hjk's avatar
hjk committed
499
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
500 501 502 503 504 505
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

506 507 508 509 510 511 512 513 514
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
                << ' ' << m_ui.checkBoxUseCodeModel->text()
                << ' ' << m_ui.checkBoxDebugDebuggingHelpers->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
515 516 517
    return w;
}

518
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
519
{
520
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
521 522
}

hjk's avatar
hjk committed
523 524 525
} // namespace Internal
} // namespace Debugger

526

con's avatar
con committed
527 528 529 530 531 532
///////////////////////////////////////////////////////////////////////
//
// DebuggerPlugin
//
///////////////////////////////////////////////////////////////////////

533 534 535 536 537 538 539

DebuggerPlugin::AttachRemoteParameters::AttachRemoteParameters() :
    attachPid(0),
    winCrashEvent(0)
{
}

540 541
DebuggerPlugin::DebuggerPlugin()
  : m_manager(0),
542 543 544
    m_debugMode(0),
    m_locationMark(0),
    m_gdbRunningContext(0),
545
    m_cmdLineEnabledEngines(AllEngineTypes)
546
{}
con's avatar
con committed
547 548 549

DebuggerPlugin::~DebuggerPlugin()
{
dt's avatar
dt committed
550
    delete DebuggerSettings::instance();
hjk's avatar
hjk committed
551

con's avatar
con committed
552 553 554 555 556 557 558 559
    removeObject(m_debugMode);

    delete m_debugMode;
    m_debugMode = 0;

    delete m_locationMark;
    m_locationMark = 0;

ck's avatar
ck committed
560
    removeObject(m_manager);
con's avatar
con committed
561 562
    delete m_manager;
    m_manager = 0;
563 564 565 566

    removeObject(m_uiSwitcher);
    delete m_uiSwitcher;
    m_uiSwitcher = 0;
con's avatar
con committed
567 568
}

569
void DebuggerPlugin::aboutToShutdown()
570 571 572
{
    QTC_ASSERT(m_manager, /**/);
    if (m_manager)
573
        m_manager->aboutToShutdown();
574 575 576 577

    writeSettings();

    if (m_uiSwitcher)
578
        m_uiSwitcher->aboutToShutdown();
579 580
}

581
static QString msgParameterMissing(const QString &a)
582 583 584 585
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

586
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
587 588 589 590 591
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

// Parse arguments
592 593 594 595
static bool parseArgument(QStringList::const_iterator &it,
                          const QStringList::const_iterator &cend,
                          DebuggerPlugin::AttachRemoteParameters *attachRemoteParameters,
                          unsigned *enabledEngines, QString *errorMessage)
596 597 598
{
    const QString &option = *it;
    // '-debug <pid>'
hjk's avatar
hjk committed
599
    if (*it == _("-debug")) {
600 601 602 603 604 605
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
606
        attachRemoteParameters->attachPid = it->toULongLong(&ok);
607
        if (!ok) {
608 609
            attachRemoteParameters->attachPid = 0;
            attachRemoteParameters->attachCore = *it;
610 611 612
        }
        return true;
    }
613 614
    // -wincrashevent <event-handle>. A handle used for
    // a handshake when attaching to a crashed Windows process.
hjk's avatar
hjk committed
615
    if (*it == _("-wincrashevent")) {
616 617 618 619 620 621
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
622
        attachRemoteParameters->winCrashEvent = it->toULongLong(&ok);
623 624 625 626 627 628
        if (!ok) {
            *errorMessage = msgInvalidNumericParameter(option, *it);
            return false;
        }
        return true;
    }
hjk's avatar
hjk committed
629
    // Engine disabling.
hjk's avatar
hjk committed
630
    if (option == _("-disable-cdb")) {
631
        *enabledEngines &= ~Debugger::CdbEngineType;
632 633
        return true;
    }
hjk's avatar
hjk committed
634
    if (option == _("-disable-gdb")) {
635
        *enabledEngines &= ~Debugger::GdbEngineType;
636 637
        return true;
    }
hjk's avatar
hjk committed
638
    if (option == _("-disable-sdb")) {
639
        *enabledEngines &= ~Debugger::ScriptEngineType;
640 641
        return true;
    }
hjk's avatar
hjk committed
642 643 644 645
    if (option == QLatin1String("-disable-tcf")) {
        *enabledEngines &= ~TcfEngineType;
        return true;
    }
646

647
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
648 649 650
    return false;
}

651
static bool parseArguments(const QStringList &args,
hjk's avatar
hjk committed
652 653
   DebuggerPlugin::AttachRemoteParameters *attachRemoteParameters,
   unsigned *enabledEngines, QString *errorMessage)
654 655 656
{
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
657
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
658 659
            return false;
    if (Debugger::Constants::Internal::debug)
660
        qDebug().nospace() << args << "engines=0x"
661 662 663
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
            << " core" << attachRemoteParameters->attachCore << '\n';
664 665 666
    return true;
}

667 668 669 670 671 672 673 674 675 676 677 678 679
void DebuggerPlugin::remoteCommand(const QStringList &options, const QStringList &)
{
    QString errorMessage;
    AttachRemoteParameters parameters;
    unsigned dummy = 0;
    // Did we receive a request for debugging (unless it is ourselves)?
    if (parseArguments(options, &parameters, &dummy, &errorMessage)
        && parameters.attachPid != quint64(QCoreApplication::applicationPid())) {
        m_attachRemoteParameters = parameters;
        attachCmdLine();
    }
}

hjk's avatar
hjk committed
680
bool DebuggerPlugin::initialize(const QStringList &arguments, QString *errorMessage)
con's avatar
con committed
681
{
hjk's avatar
hjk committed
682
    // Do not fail the whole plugin if something goes wrong here.
683
    if (!parseArguments(arguments, &m_attachRemoteParameters, &m_cmdLineEnabledEngines, errorMessage)) {
684 685
        *errorMessage = tr("Error evaluating command line arguments: %1")
            .arg(*errorMessage);
686 687 688
        qWarning("%s\n", qPrintable(*errorMessage));
        errorMessage->clear();
    }
con's avatar
con committed
689

hjk's avatar
hjk committed
690
    // Debug mode setup.
691 692 693 694
    m_debugMode = new DebugMode(this);
    m_uiSwitcher = new DebuggerUISwitcher(m_debugMode, this);
    ExtensionSystem::PluginManager::instance()->addObject(m_uiSwitcher);

695
    ICore *core = ICore::instance();
hjk's avatar
hjk committed
696
    QTC_ASSERT(core, return false);
con's avatar
con committed
697

698 699
    Core::ActionManager *am = core->actionManager();
    QTC_ASSERT(am, return false);
con's avatar
con committed
700 701

    Core::UniqueIDManager *uidm = core->uniqueIDManager();
hjk's avatar
hjk committed
702
    QTC_ASSERT(uidm, return false);
con's avatar
con committed
703 704

    QList<int> globalcontext;
hjk's avatar
hjk committed
705
    globalcontext << CC::C_GLOBAL_ID;
con's avatar
con committed
706 707

    QList<int> cppcontext;
hjk's avatar
hjk committed
708
    cppcontext << uidm->uniqueIdentifier(PE::LANG_CXX);
con's avatar
con committed
709

710 711
    QList<int> cppDebuggercontext;
    cppDebuggercontext << uidm->uniqueIdentifier(C_CPPDEBUGGER);
con's avatar
con committed
712 713

    QList<int> cppeditorcontext;
714
    cppeditorcontext << uidm->uniqueIdentifier(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
715 716 717 718 719 720

    QList<int> texteditorcontext;
    texteditorcontext << uidm->uniqueIdentifier(TextEditor::Constants::C_TEXTEDITOR);

    m_gdbRunningContext = uidm->uniqueIdentifier(Constants::GDBRUNNING);

721
    m_uiSwitcher->addLanguage(LANG_CPP, cppDebuggercontext);
722

723 724 725 726 727
    DebuggerManager *manager = new DebuggerManager(this);
    ExtensionSystem::PluginManager::instance()->addObject(manager);
    const QList<Core::IOptionsPage *> engineOptionPages =
        manager->initializeEngines(m_cmdLineEnabledEngines);

728
    // Register factory of DebuggerRunControl.
729
    m_debuggerRunControlFactory = new DebuggerRunControlFactory(manager);
730 731 732
    addAutoReleasedObject(m_debuggerRunControlFactory);

    QList<int> context;
hjk's avatar
hjk committed
733
    context.append(uidm->uniqueIdentifier(CC::C_EDITORMANAGER));
734
    context.append(uidm->uniqueIdentifier(C_DEBUGMODE));
hjk's avatar
hjk committed
735
    context.append(uidm->uniqueIdentifier(CC::C_NAVIGATION_PANE));
736 737
    m_debugMode->setContext(context);

738
    m_reverseToolButton = 0;
con's avatar
con committed
739

740
    // Handling of external applications.
741 742 743 744 745 746 747 748 749 750 751 752 753 754
    m_startExternalAction = new QAction(this);
    m_startExternalAction->setText(tr("Start and Debug External Application..."));
    connect(m_startExternalAction, SIGNAL(triggered()),
        this, SLOT(startExternalApplication()));

    m_attachExternalAction = new QAction(this);
    m_attachExternalAction->setText(tr("Attach to Running External Application..."));
    connect(m_attachExternalAction, SIGNAL(triggered()),
        this, SLOT(attachExternalApplication()));

    m_attachCoreAction = new QAction(this);
    m_attachCoreAction->setText(tr("Attach to Core..."));
    connect(m_attachCoreAction, SIGNAL(triggered()), this, SLOT(attachCore()));

hjk's avatar
hjk committed
755 756 757 758 759 760 761
    m_attachTcfAction = new QAction(this);
    m_attachTcfAction->setText(tr("Attach to Running Tcf Agent..."));
    m_attachTcfAction->setToolTip(tr("This attaches to a running "
        "'Target Communication Framework' agent."));
    connect(m_attachTcfAction, SIGNAL(triggered()),
        this, SLOT(attachRemoteTcf()));

762 763 764 765
    m_startRemoteAction = new QAction(this);
    m_startRemoteAction->setText(tr("Start and Attach to Remote Application..."));
    connect(m_startRemoteAction, SIGNAL(triggered()),
        this, SLOT(startRemoteApplication()));
766

767
    m_detachAction = new QAction(this);
768
    m_detachAction->setText(tr("Detach Debugger"));
769
    connect(m_detachAction, SIGNAL(triggered()),
770
        manager, SLOT(detachDebugger()));
771

772
    Core::Command *cmd = 0;
773
    const DebuggerManagerActions actions = manager->debuggerManagerActions();
774

775
    Core::ActionContainer *mstart =
hjk's avatar
hjk committed
776
        am->actionContainer(PE::M_DEBUG_STARTDEBUGGING);
777

778
    cmd = am->registerAction(actions.continueAction,
hjk's avatar
hjk committed
779 780
        PE::DEBUG, QList<int>() << m_gdbRunningContext);
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
781

782
    cmd = am->registerAction(m_startExternalAction,
con's avatar
con committed
783
        Constants::STARTEXTERNAL, globalcontext);
784
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
785
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
786

787
    cmd = am->registerAction(m_attachExternalAction,
con's avatar
con committed
788
        Constants::ATTACHEXTERNAL, globalcontext);
789
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
790
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
791

792 793
    cmd = am->registerAction(m_attachCoreAction,
        Constants::ATTACHCORE, globalcontext);
hjk's avatar
hjk committed
794

795
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
796
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
797

hjk's avatar
hjk committed
798 799 800 801
    cmd = am->registerAction(m_attachTcfAction,
        Constants::ATTACHTCF, globalcontext);
    mstart->addAction(cmd, Core::Constants::G_DEFAULT_ONE);

802
    cmd = am->registerAction(m_startRemoteAction,
803
        Constants::ATTACHREMOTE, globalcontext);
804
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
805
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
806

807 808
    cmd = am->registerAction(m_detachAction,
        Constants::DETACH, globalcontext);
809
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
810
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
811

812
    cmd = am->registerAction(actions.stopAction,
con's avatar
con committed
813
        Constants::INTERRUPT, globalcontext);
hjk's avatar
hjk committed
814 815
    cmd->setAttribute(Command::CA_UpdateText);
    cmd->setAttribute(Command::CA_UpdateIcon);
con's avatar
con committed
816 817
    cmd->setDefaultKeySequence(QKeySequence(Constants::INTERRUPT_KEY));
    cmd->setDefaultText(tr("Stop Debugger/Interrupt Debugger"));
hjk's avatar
hjk committed
818
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
819

820
    cmd = am->registerAction(actions.resetAction,
con's avatar
con committed
821
        Constants::RESET, globalcontext);
con's avatar
con committed
822
    cmd->setAttribute(Core::Command::CA_UpdateText);
823
    //cmd->setDefaultKeySequence(QKeySequence(Constants::RESET_KEY));
con's avatar
con committed
824
    cmd->setDefaultText(tr("Reset Debugger"));
hjk's avatar
hjk committed
825
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
826 827 828

    QAction *sep = new QAction(this);
    sep->setSeparator(true);
hjk's avatar
hjk committed
829
    cmd = am->registerAction(sep, _("Debugger.Sep.Step"), globalcontext);
830
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);
con's avatar
con committed
831

832
    cmd = am->registerAction(actions.nextAction,
833
        Constants::NEXT, cppDebuggercontext);
con's avatar
con committed
834
    cmd->setDefaultKeySequence(QKeySequence(Constants::NEXT_KEY));
835
    cmd->setAttribute(Command::CA_Hide);
836
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);
con's avatar
con committed
837

838
    cmd = am->registerAction(actions.stepAction,
839
        Constants::STEP, cppDebuggercontext);
con's avatar
con committed
840
    cmd->setDefaultKeySequence(QKeySequence(Constants::STEP_KEY));
841
    cmd->setAttribute(Command::CA_Hide);
842 843
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);

con's avatar
con committed
844

845
    cmd = am->registerAction(actions.stepOutAction,
846
        Constants::STEPOUT, cppDebuggercontext);
con's avatar
con committed
847
    cmd->setDefaultKeySequence(QKeySequence(Constants::STEPOUT_KEY));
848
    cmd->setAttribute(Command::CA_Hide);
849 850
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);

con's avatar
con committed
851

852
    cmd = am->registerAction(actions.runToLineAction1,
853
        Constants::RUN_TO_LINE1, cppDebuggercontext);
con's avatar
con committed
854
    cmd->setDefaultKeySequence(QKeySequence(Constants::RUN_TO_LINE_KEY));
855
    cmd->setAttribute(Command::CA_Hide);
856 857
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);

con's avatar
con committed
858

859
    cmd = am->registerAction(actions.runToFunctionAction,
860
        Constants::RUN_TO_FUNCTION, cppDebuggercontext);
con's avatar
con committed
861
    cmd->setDefaultKeySequence(QKeySequence(Constants::RUN_TO_FUNCTION_KEY));
862
    cmd->setAttribute(Command::CA_Hide);
863