debuggerplugin.cpp 56.1 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";
142 143
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
144

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
145
#ifdef Q_WS_MAC
con's avatar
con committed
146 147 148 149 150
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";
151
const char * const REVERSE_KEY              = "";
con's avatar
con committed
152 153 154 155 156 157 158
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";
159
const char * const SNAPSHOT_KEY             = "Alt+D,Alt+S";
con's avatar
con committed
160 161 162 163 164 165
#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";
166
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
167 168 169 170 171 172 173
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";
174
const char * const SNAPSHOT_KEY             = "Alt+D,Alt+S";
con's avatar
con committed
175 176 177 178 179 180
#endif

} // namespace Constants
} // namespace Debugger


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

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

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

198 199 200 201 202 203
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
204 205 206 207 208 209 210 211 212 213 214 215 216
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
217
  : BaseMode(parent)
hjk's avatar
hjk committed
218
{
219
    setDisplayName(tr("Debug"));
hjk's avatar
hjk committed
220
    setId(MODE_DEBUG);
hjk's avatar
hjk committed
221
    setIcon(QIcon(":/fancyactionbar/images/mode_Debug.png"));
hjk's avatar
hjk committed
222
    setPriority(P_MODE_DEBUG);
hjk's avatar
hjk committed
223 224 225 226 227 228 229 230
}

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

231 232 233 234 235 236
///////////////////////////////////////////////////////////////////////
//
// DebuggerListener: Close the debugging session if running.
//
///////////////////////////////////////////////////////////////////////

237 238
class DebuggerListener : public Core::ICoreListener
{
239 240
    Q_OBJECT
public:
hjk's avatar
hjk committed
241
    DebuggerListener() {}
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    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
266

267
    const QString question = cleanTermination ?
hjk's avatar
hjk committed
268 269 270 271
        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"
272
           " state (%1) can leave the target in an inconsistent state."
273
           " Would you still like to terminate it?")
hjk's avatar
hjk committed
274 275 276 277 278 279 280
        .arg(_(DebuggerManager::stateName(mgr->state())));

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

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

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

289 290 291
} // namespace Internal
} // namespace Debugger

hjk's avatar
hjk committed
292

con's avatar
con committed
293 294 295 296 297 298
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

299 300 301
namespace Debugger {
namespace Internal {

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

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

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

318 319 320 321 322 323
} // namespace Internal
} // namespace Debugger


///////////////////////////////////////////////////////////////////////
//
324
// CommonOptionsPage
325 326 327 328 329 330
//
///////////////////////////////////////////////////////////////////////

namespace Debugger {
namespace Internal {

331
class CommonOptionsPage : public Core::IOptionsPage
332 333 334 335
{
    Q_OBJECT

public:
336
    CommonOptionsPage() {}
337 338

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

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

private:
356
    Ui::CommonOptionsPage m_ui;
357
    Utils::SavedActionSet m_group;
358
    QString m_searchKeywords;
359 360
};

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

367 368 369
    m_group.insert(theDebuggerAction(SwitchLanguageAutomatically),
        m_ui.checkBoxChangeLanguageAutomatically);

370
    m_group.insert(theDebuggerAction(ListSourceFiles),
371
        m_ui.checkBoxListSourceFiles);
372
    m_group.insert(theDebuggerAction(UseAlternatingRowColors),
373
        m_ui.checkBoxUseAlternatingRowColors);
374
    m_group.insert(theDebuggerAction(UseToolTipsInMainEditor),
375
        m_ui.checkBoxUseToolTipsInMainEditor);
376
    m_group.insert(theDebuggerAction(AutoDerefPointers), 0);
377 378 379 380
    m_group.insert(theDebuggerAction(UseToolTipsInLocalsView), 0);
    m_group.insert(theDebuggerAction(UseToolTipsInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInStackView), 0);
381
    m_group.insert(theDebuggerAction(MaximalStackDepth),
382
        m_ui.spinBoxMaximalStackDepth);
383 384
    m_group.insert(theDebuggerAction(ShowStdNamespace), 0);
    m_group.insert(theDebuggerAction(ShowQtNamespace), 0);
385
    m_group.insert(theDebuggerAction(LogTimeStamps), 0);
386
    m_group.insert(theDebuggerAction(VerboseLog), 0);
387
    m_group.insert(theDebuggerAction(UsePreciseBreakpoints), 0);
388 389
    m_group.insert(theDebuggerAction(BreakOnThrow), 0);
    m_group.insert(theDebuggerAction(BreakOnCatch), 0);
390 391 392 393 394 395 396
#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
397

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

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

421 422 423
} // namespace Internal
} // namespace Debugger

hjk's avatar
hjk committed
424

hjk's avatar
hjk committed
425 426
///////////////////////////////////////////////////////////////////////
//
427
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
428 429 430
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
438 439 440
namespace Debugger {
namespace Internal {

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

public:
446
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
447 448

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

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

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

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

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

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

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

488 489 490
    m_group.insert(theDebuggerAction(UseCodeModel),
        m_ui.checkBoxUseCodeModel);

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

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

508 509 510 511 512 513 514 515 516
    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
517 518 519
    return w;
}

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

hjk's avatar
hjk committed
525 526 527
} // namespace Internal
} // namespace Debugger

528

con's avatar
con committed
529 530 531 532 533 534
///////////////////////////////////////////////////////////////////////
//
// DebuggerPlugin
//
///////////////////////////////////////////////////////////////////////

535 536 537 538 539 540 541

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

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

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

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

    delete m_debugMode;
    m_debugMode = 0;

    delete m_locationMark;
    m_locationMark = 0;

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

    removeObject(m_uiSwitcher);
    delete m_uiSwitcher;
    m_uiSwitcher = 0;
con's avatar
con committed
569 570
}

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

    writeSettings();

    if (m_uiSwitcher)
580
        m_uiSwitcher->aboutToShutdown();
581 582
}

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

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

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

653
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
654 655 656
    return false;
}

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

673 674 675 676 677 678 679 680 681 682 683 684 685
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
686
bool DebuggerPlugin::initialize(const QStringList &arguments, QString *errorMessage)
con's avatar
con committed
687
{
hjk's avatar
hjk committed
688
    // Do not fail the whole plugin if something goes wrong here.
689
    if (!parseArguments(arguments, &m_attachRemoteParameters, &m_cmdLineEnabledEngines, errorMessage)) {
690 691
        *errorMessage = tr("Error evaluating command line arguments: %1")
            .arg(*errorMessage);
692 693 694
        qWarning("%s\n", qPrintable(*errorMessage));
        errorMessage->clear();
    }
con's avatar
con committed
695

hjk's avatar
hjk committed
696
    // Debug mode setup.
697 698 699 700
    m_debugMode = new DebugMode(this);
    m_uiSwitcher = new DebuggerUISwitcher(m_debugMode, this);
    ExtensionSystem::PluginManager::instance()->addObject(m_uiSwitcher);

701
    ICore *core = ICore::instance();
hjk's avatar
hjk committed
702
    QTC_ASSERT(core, return false);
con's avatar
con committed
703

704 705
    Core::ActionManager *am = core->actionManager();
    QTC_ASSERT(am, return false);
con's avatar
con committed
706 707

    Core::UniqueIDManager *uidm = core->uniqueIDManager();
hjk's avatar
hjk committed
708
    QTC_ASSERT(uidm, return false);
con's avatar
con committed
709 710

    QList<int> globalcontext;
hjk's avatar
hjk committed
711
    globalcontext << CC::C_GLOBAL_ID;
con's avatar
con committed
712 713

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

716 717
    QList<int> cppDebuggercontext;
    cppDebuggercontext << uidm->uniqueIdentifier(C_CPPDEBUGGER);
con's avatar
con committed
718 719

    QList<int> cppeditorcontext;
720
    cppeditorcontext << uidm->uniqueIdentifier(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
721 722 723 724 725 726

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

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

727
    m_uiSwitcher->addLanguage(LANG_CPP, cppDebuggercontext);
728

729 730 731 732 733
    DebuggerManager *manager = new DebuggerManager(this);
    ExtensionSystem::PluginManager::instance()->addObject(manager);
    const QList<Core::IOptionsPage *> engineOptionPages =
        manager->initializeEngines(m_cmdLineEnabledEngines);

734
    // Register factory of DebuggerRunControl.
735
    m_debuggerRunControlFactory = new DebuggerRunControlFactory(manager);
736 737 738
    addAutoReleasedObject(m_debuggerRunControlFactory);

    QList<int> context;
hjk's avatar
hjk committed
739
    context.append(uidm->uniqueIdentifier(CC::C_EDITORMANAGER));
740
    context.append(uidm->uniqueIdentifier(C_DEBUGMODE));
hjk's avatar
hjk committed
741
    context.append(uidm->uniqueIdentifier(CC::C_NAVIGATION_PANE));
742 743
    m_debugMode->setContext(context);

744
    m_reverseToolButton = 0;
con's avatar
con committed
745

746
    // Handling of external applications.
747 748 749 750 751 752 753 754 755 756 757 758 759 760
    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
761 762 763 764 765 766 767
    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()));

768 769 770 771
    m_startRemoteAction = new QAction(this);
    m_startRemoteAction->setText(tr("Start and Attach to Remote Application..."));
    connect(m_startRemoteAction, SIGNAL(triggered()),
        this, SLOT(startRemoteApplication()));
772

773
    m_detachAction = new QAction(this);
774
    m_detachAction->setText(tr("Detach Debugger"));
775
    connect(m_detachAction, SIGNAL(triggered()),
776
        manager, SLOT(detachDebugger()));
777

778
    Core::Command *cmd = 0;
779
    const DebuggerManagerActions actions = manager->debuggerManagerActions();
780

781
    Core::ActionContainer *mstart =
hjk's avatar
hjk committed
782
        am->actionContainer(PE::M_DEBUG_STARTDEBUGGING);
783

784
    cmd = am->registerAction(actions.continueAction,
hjk's avatar
hjk committed
785 786
        PE::DEBUG, QList<int>() << m_gdbRunningContext);
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
787

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

793
    cmd = am->registerAction(m_attachExternalAction,
con's avatar
con committed
794
        Constants::ATTACHEXTERNAL, globalcontext);
795
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
796
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
797

798 799
    cmd = am->registerAction(m_attachCoreAction,
        Constants::ATTACHCORE, globalcontext);
hjk's avatar
hjk committed
800

801
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
802
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
803

hjk's avatar
hjk committed
804 805 806 807
    cmd = am->registerAction(m_attachTcfAction,
        Constants::ATTACHTCF, globalcontext);
    mstart->addAction(cmd, Core::Constants::G_DEFAULT_ONE);

808
    cmd = am->registerAction(m_startRemoteAction,
809
        Constants::ATTACHREMOTE, globalcontext);
810
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
811
    mstart->addAction(cmd, CC::G_DEFAULT_ONE);
812

813 814
    cmd = am->registerAction(m_detachAction,
        Constants::DETACH, globalcontext);
815
    cmd->setAttribute(Command::CA_Hide);
hjk's avatar
hjk committed
816
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
817

818
    cmd = am->registerAction(actions.stopAction,
con's avatar
con committed
819
        Constants::INTERRUPT, globalcontext);
hjk's avatar
hjk committed
820 821
    cmd->setAttribute(Command::CA_UpdateText);
    cmd->setAttribute(Command::CA_UpdateIcon);
con's avatar
con committed
822 823
    cmd->setDefaultKeySequence(QKeySequence(Constants::INTERRUPT_KEY));
    cmd->setDefaultText(tr("Stop Debugger/Interrupt Debugger"));
hjk's avatar
hjk committed
824
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
825

826
    cmd = am->registerAction(actions.resetAction,
con's avatar
con committed
827
        Constants::RESET, globalcontext);
con's avatar
con committed
828
    cmd->setAttribute(Core::Command::CA_UpdateText);
829
    //cmd->setDefaultKeySequence(QKeySequence(Constants::RESET_KEY));
con's avatar
con committed
830
    cmd->setDefaultText(tr("Reset Debugger"));
hjk's avatar
hjk committed
831
    m_uiSwitcher->addMenuAction(cmd, CC::G_DEFAULT_ONE);
con's avatar
con committed
832 833 834

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

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

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

con's avatar
con committed
850

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

con's avatar
con committed
857

858
    cmd = am->registerAction(actions.runToLineAction1,
859
        Constants::RUN_TO_LINE1, cppDebuggercontext);
con's avatar
con committed
860
    cmd->setDefaultKeySequence(QKeySequence(Constants::RUN_TO_LINE_KEY));
861
    cmd->setAttribute(Command::CA_Hide);
862 863
    m_uiSwitcher->addMenuAction(cmd, Constants::LANG_CPP);

con's avatar
con committed
864

865
    cmd = am->registerAction(actions.runToFunctionAction,