1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "enginemanager.h"
#include "debuggerengine.h"
#include "debuggerinternalconstants.h"
#include "debuggericons.h"
#include "debuggermainwindow.h"
#include "debuggertr.h"
#include <coreplugin/icontext.h>
#include <coreplugin/icore.h>
#include <coreplugin/modemanager.h>
#include <utils/basetreeview.h>
#include <utils/stylehelper.h>
#include <utils/treemodel.h>
#include <utils/qtcassert.h>
#include <QAbstractProxyModel>
#include <QComboBox>
#include <QDebug>
#include <QMenu>
#include <QSortFilterProxyModel>
#include <QTimer>
using namespace Core;
using namespace Utils;
namespace Debugger::Internal {
const bool hideSwitcherUnlessNeeded = false;
const char INDEX_ID[] = "Debugger/Debugger.SelectedEngineIndex";
#if 0
SnapshotData::SnapshotData()
{}
void SnapshotData::clear()
{
m_frames.clear();
m_location.clear();
m_date = QDateTime();
}
QString SnapshotData::function() const
{
if (m_frames.isEmpty())
return QString();
const StackFrame &frame = m_frames.at(0);
return frame.function + ':' + QString::number(frame.line);
}
QString SnapshotData::toString() const
{
QString res;
QTextStream str(&res);
/* str << Tr::tr("Function:") << ' ' << function() << ' '
<< Tr::tr("File:") << ' ' << m_location << ' '
<< Tr::tr("Date:") << ' ' << m_date.toString(); */
return res;
}
QString SnapshotData::toToolTip() const
{
QString res;
QTextStream str(&res);
str << "<html><body><table>"
/*
<< "<tr><td>" << Tr::tr("Function:")
<< "</td><td>" << function() << "</td></tr>"
<< "<tr><td>" << Tr::tr("File:")
<< "</td><td>" << QDir::toNativeSeparators(m_location) << "</td></tr>"
<< "</table></body></html>"; */
return res;
}
QDebug operator<<(QDebug d, const SnapshotData &f)
{
QString res;
QTextStream str(&res);
str << f.location();
/*
str << "level=" << f.level << " address=" << f.address;
if (!f.function.isEmpty())
str << ' ' << f.function;
if (!f.location.isEmpty())
str << ' ' << f.location << ':' << f.line;
if (!f.from.isEmpty())
str << " from=" << f.from;
if (!f.to.isEmpty())
str << " to=" << f.to;
*/
d.nospace() << res;
return d;
}
#endif
class EngineTypeFilterProxyModel : public QSortFilterProxyModel
{
public:
explicit EngineTypeFilterProxyModel(const QString &type, QObject *parent = nullptr)
: QSortFilterProxyModel(parent)
, m_type(type)
{
}
protected:
bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override
{
QModelIndex index = sourceModel()->index(sourceRow, 0, sourceParent);
if (index.isValid()) {
QVariant data = sourceModel()->data(index, Qt::UserRole);
if (data.isValid() && data.toString() == m_type) {
return true; // Display only DapEngines
}
}
return false;
}
private:
QString m_type;
};
class ModelChooser : public QObject
{
Q_OBJECT
public:
ModelChooser(QAbstractItemModel *sourceModel,
const QString &engineType,
QObject *parent = nullptr)
: QObject(parent)
, m_engineChooser(new QComboBox())
, m_proxyModel(new EngineTypeFilterProxyModel(engineType))
, m_sourceModel(sourceModel)
, m_enginType(engineType)
, m_key(engineType.isEmpty() ? Utils::Key(INDEX_ID) + "." + engineType.toUtf8()
: Utils::Key(INDEX_ID))
{
m_proxyModel->setSourceModel(sourceModel);
StyleHelper::setPanelWidget(m_engineChooser);
m_engineChooser->setModel(m_proxyModel);
m_engineChooser->setIconSize(QSize(0, 0));
if (hideSwitcherUnlessNeeded)
m_engineChooser->hide();
connect(m_engineChooser, &QComboBox::activated, this, [this](int index) {
QModelIndex sourceIndex = m_proxyModel->mapToSource(m_proxyModel->index(index, 0));
emit activated(sourceIndex.row());
m_lastActivatedIndex = sourceIndex.row();
ICore::settings()->setValue(m_key, m_lastActivatedIndex);
});
connect(m_proxyModel, &QAbstractItemModel::rowsRemoved, this, [this] {
setCurrentIndex(m_lastActivatedIndex);
});
}
~ModelChooser()
{
delete m_engineChooser;
delete m_proxyModel;
}
QComboBox *comboBox() const { return m_engineChooser; }
QAbstractItemModel *model() const { return m_proxyModel; }
const QString &engineType() const { return m_enginType; }
void restoreIndex()
{
m_lastActivatedIndex = ICore::settings()->value(m_key, 0).toInt();
if (m_lastActivatedIndex <= m_engineChooser->count())
setCurrentIndex(m_lastActivatedIndex);
}
void setCurrentIndex(int index)
{
const QModelIndex sourceIndex = m_proxyModel->mapFromSource(m_sourceModel->index(index, 0));
if (sourceIndex.isValid())
m_engineChooser->setCurrentIndex(sourceIndex.row());
else
m_engineChooser->setCurrentIndex(0);
}
void adjustUiForEngine(int row)
{
setCurrentIndex(row);
const int contentWidth = m_engineChooser->fontMetrics().horizontalAdvance(
m_engineChooser->currentText() + "xx");
QStyleOptionComboBox option;
option.initFrom(m_engineChooser);
const QSize sz(contentWidth, 1);
const int width = m_engineChooser->style()
->sizeFromContents(QStyle::CT_ComboBox, &option, sz)
.width();
m_engineChooser->setFixedWidth(width);
}
signals:
void activated(int index);
private:
QPointer<QComboBox> m_engineChooser;
QPointer<EngineTypeFilterProxyModel> m_proxyModel;
QAbstractItemModel *m_sourceModel;
QString m_enginType;
const Utils::Key m_key;
int m_lastActivatedIndex = -1;
};
struct PerspectiveItem
{
QString name;
QString type;
QString id;
};
class EngineItem : public QObject, public TreeItem
{
public:
QVariant data(int column, int role) const final;
bool setData(int row, const QVariant &data, int role) final;
const bool m_isPreset = false;
QPointer<DebuggerEngine> m_engine;
PerspectiveItem m_perspective;
};
class EngineManagerPrivate : public QObject
{
public:
EngineManagerPrivate()
{
m_engineModel.setHeader({Tr::tr("Perspective"), Tr::tr("Debugged Application")});
m_engineChooser = new ModelChooser(&m_engineModel, "", this);
m_engineDAPChooser = new ModelChooser(&m_engineModel, "DAP", this);
connect(m_engineChooser, &ModelChooser::activated, this, [this](int index) {
activateEngineByIndex(index);
});
connect(m_engineDAPChooser, &ModelChooser::activated, this, [this](int index) {
activateEngineByIndex(index);
});
}
~EngineManagerPrivate() = default;
EngineItem *findEngineItem(DebuggerEngine *engine);
void activateEngineItem(EngineItem *engineItem);
void activateEngineByIndex(int index);
void selectUiForCurrentEngine();
void updateEngineChooserVisibility();
void updatePerspectives();
TreeModel<TypedTreeItem<EngineItem>, EngineItem> m_engineModel;
QPointer<EngineItem> m_currentItem; // The primary information is DebuggerMainWindow::d->m_currentPerspective
Utils::Id m_previousMode;
QPointer<ModelChooser> m_engineChooser;
QPointer<ModelChooser> m_engineDAPChooser;
QList<PerspectiveItem> m_perspectives;
// This contains the contexts that need to be removed when switching
// away from the current engine item. Since the plugin itself adds
// C_DEBUGGER_NOTRUNNING on initialization this is set here as well,
// so it can be removed when switching away from the initial (null)
// engine. See QTCREATORBUG-22330.
Context m_currentAdditionalContext{Constants::C_DEBUGGER_NOTRUNNING};
};
////////////////////////////////////////////////////////////////////////
//
// EngineManager
//
////////////////////////////////////////////////////////////////////////
/*!
\class Debugger::Internal::EngineManager
\brief The EngineManager manages running debugger engines.
*/
static EngineManager *theEngineManager = nullptr;
static EngineManagerPrivate *d = nullptr;
EngineManager::EngineManager()
{
theEngineManager = this;
d = new EngineManagerPrivate;
}
QWidget *EngineManager::engineChooser()
{
return d->m_engineChooser->comboBox();
}
QWidget *EngineManager::dapEngineChooser()
{
return d->m_engineDAPChooser->comboBox();
}
void EngineManager::updatePerspectives()
{
d->updatePerspectives();
}
EngineManager::~EngineManager()
{
theEngineManager = nullptr;
delete d;
}
EngineManager *EngineManager::instance()
{
return theEngineManager;
}
QAbstractItemModel *EngineManager::model()
{
return d->m_engineChooser->model();
}
QAbstractItemModel *EngineManager::dapModel()
{
return d->m_engineDAPChooser->model();
}
QVariant EngineItem::data(int column, int role) const
{
if (m_engine) {
if (role == SnapshotCapabilityRole)
return m_engine->hasCapability(SnapshotCapability);
const DebuggerRunParameters &rp = m_engine->runParameters();
switch (role) {
case Qt::DisplayRole:
switch (column) {
case 0: {
QString myName = m_engine->displayName();
int count = 0;
for (TreeItem *item : *TreeItem::parent()) {
DebuggerEngine *engine = static_cast<EngineItem *>(item)->m_engine;
count += engine && engine->displayName() == myName;
}
if (count > 1)
myName += QString(" (%1)").arg(m_engine->runId());
return myName;
}
case 1:
return (rp.coreFile().isEmpty() ? rp.inferior().command.executable() : rp.coreFile()).toUserOutput();
}
return QVariant();
case Qt::ToolTipRole:
return QVariant();
case Qt::DecorationRole:
// Return icon that indicates whether this is the active engine
if (column == 0)
return d->m_currentItem == this ? Icons::LOCATION.icon() : Icons::EMPTY.icon();
break;
case Qt::UserRole:
return QVariant::fromValue(m_engine->debuggerType());
default:
break;
}
} else {
switch (role) {
case Qt::DisplayRole:
if (column == 0)
return m_perspective.name;
return QString("-");
case Qt::UserRole:
return m_perspective.type;
default:
break;
}
}
return QVariant();
}
bool EngineItem::setData(int row, const QVariant &value, int role)
{
Q_UNUSED(row)
if (!m_engine)
return false;
if (role == BaseTreeView::ItemActivatedRole) {
EngineItem *engineItem = d->findEngineItem(m_engine);
d->activateEngineByIndex(engineItem->indexInParent());
return true;
}
if (role == BaseTreeView::ItemViewEventRole) {
ItemViewEvent ev = value.value<ItemViewEvent>();
if (auto cmev = ev.as<QContextMenuEvent>()) {
auto menu = new QMenu(ev.view());
QAction *actCreate = menu->addAction(Tr::tr("Create Snapshot"));
actCreate->setEnabled(m_engine->hasCapability(SnapshotCapabilityRole));
menu->addSeparator();
QAction *actRemove = menu->addAction(Tr::tr("Abort Debugger"));
actRemove->setEnabled(true);
QAction *act = menu->exec(cmev->globalPos());
if (act == actCreate && m_engine)
m_engine->createSnapshot();
else if (act == actRemove && m_engine)
m_engine->quitDebugger();
return true;
}
if (auto kev = ev.as<QKeyEvent>(QEvent::KeyPress)) {
if ((kev->key() == Qt::Key_Delete || kev->key() == Qt::Key_Backspace) && m_engine) {
m_engine->quitDebugger();
} else if (kev->key() == Qt::Key_Return || kev->key() == Qt::Key_Enter) {
d->activateEngineByIndex(row);
}
return true;
}
}
return false;
}
void EngineManagerPrivate::activateEngineByIndex(int index)
{
// The actual activation is triggered indirectly via the perspective change.
Perspective *perspective = nullptr;
EngineItem *engineItem = m_engineModel.rootItem()->childAt(index);
if (engineItem && !engineItem->m_engine) {
perspective = Perspective::findPerspective(engineItem->m_perspective.id);
} else {
QTC_ASSERT(engineItem, return);
QTC_ASSERT(engineItem->m_engine, return);
perspective = engineItem->m_engine->perspective();
}
QTC_ASSERT(perspective, return);
perspective->select();
}
void EngineManagerPrivate::activateEngineItem(EngineItem *engineItem)
{
if (m_currentItem == engineItem)
return;
QTC_ASSERT(engineItem, return);
m_currentItem = engineItem;
Context newContext;
if (m_currentItem) {
if (DebuggerEngine *engine = m_currentItem->m_engine) {
newContext.add(engine->languageContext());
newContext.add(engine->debuggerContext());
} else {
newContext.add(Context(Constants::C_DEBUGGER_NOTRUNNING));
}
}
ICore::updateAdditionalContexts(m_currentAdditionalContext, newContext);
m_currentAdditionalContext = newContext;
// In case this was triggered externally by some Perspective::select() call.
const int idx = engineItem->indexInParent();
if ((engineItem->m_engine
&& engineItem->m_engine->debuggerType() == m_engineDAPChooser->engineType())
|| (engineItem->m_engine
&& engineItem->m_perspective.type == m_engineDAPChooser->engineType()))
m_engineDAPChooser->setCurrentIndex(idx);
else
m_engineChooser->setCurrentIndex(idx);
selectUiForCurrentEngine();
}
void EngineManagerPrivate::selectUiForCurrentEngine()
{
if (ModeManager::currentModeId() != Constants::MODE_DEBUG)
return;
int row = 0;
if (m_currentItem)
row = m_engineModel.rootItem()->indexOf(m_currentItem);
if ((m_currentItem->m_engine
&& m_currentItem->m_engine->debuggerType() == m_engineDAPChooser->engineType())
|| (m_currentItem->m_engine
&& m_currentItem->m_perspective.type == m_engineDAPChooser->engineType()))
m_engineDAPChooser->adjustUiForEngine(row);
else
m_engineChooser->adjustUiForEngine(row);
m_engineModel.rootItem()->forFirstLevelChildren([this](EngineItem *engineItem) {
if (engineItem && engineItem->m_engine)
engineItem->m_engine->updateUi(engineItem == m_currentItem);
});
emit theEngineManager->currentEngineChanged();
}
EngineItem *EngineManagerPrivate::findEngineItem(DebuggerEngine *engine)
{
return m_engineModel.rootItem()->findFirstLevelChild([engine](EngineItem *engineItem) {
return engineItem->m_engine == engine;
});
}
void EngineManagerPrivate::updateEngineChooserVisibility()
{
// Show it if there's more than one option (i.e. not the preset engine only)
if (hideSwitcherUnlessNeeded) {
const int count = m_engineModel.rootItem()->childCount();
m_engineChooser->comboBox()->setVisible(count >= 2);
m_engineDAPChooser->comboBox()->setVisible(count >= 2);
}
}
void EngineManagerPrivate::updatePerspectives()
{
d->updateEngineChooserVisibility();
Perspective *current = DebuggerMainWindow::currentPerspective();
if (!current) {
return;
}
m_engineModel.rootItem()->forFirstLevelChildren([this, current](EngineItem *engineItem) {
if (engineItem == m_currentItem)
return;
bool shouldBeActive = false;
if (engineItem->m_engine) {
// Normal engine.
shouldBeActive = engineItem->m_engine->perspective()->isCurrent();
} else {
// Preset.
shouldBeActive = current->id() == Debugger::Constants::PRESET_PERSPECTIVE_ID;
}
if (shouldBeActive && engineItem != m_currentItem)
activateEngineItem(engineItem);
});
}
QString EngineManager::registerEngine(DebuggerEngine *engine)
{
auto engineItem = new EngineItem;
engineItem->m_engine = engine;
d->m_engineModel.rootItem()->appendChild(engineItem);
d->updateEngineChooserVisibility();
return QString::number(d->m_engineModel.rootItem()->childCount());
}
void EngineManager::unregisterEngine(DebuggerEngine *engine)
{
EngineItem *engineItem = d->findEngineItem(engine);
QTC_ASSERT(engineItem, return);
d->m_engineModel.destroyItem(engineItem);
d->updateEngineChooserVisibility();
}
QString EngineManager::registerDefaultPerspective(const QString &name,
const QString &type,
const QString &id)
{
auto engineItem = new EngineItem;
engineItem->m_perspective.name = name;
engineItem->m_perspective.type = type;
engineItem->m_perspective.id = id;
d->m_engineModel.rootItem()->appendChild(engineItem);
d->m_engineDAPChooser->restoreIndex();
d->m_engineChooser->restoreIndex();
return QString::number(d->m_engineModel.rootItem()->childCount());
}
void EngineManager::activateDebugMode()
{
if (ModeManager::currentModeId() != Constants::MODE_DEBUG) {
d->m_previousMode = ModeManager::currentModeId();
ModeManager::activateMode(Constants::MODE_DEBUG);
}
}
void EngineManager::activateByIndex(int index)
{
d->activateEngineByIndex(index);
}
void EngineManager::deactivateDebugMode()
{
if (ModeManager::currentModeId() == Constants::MODE_DEBUG && d->m_previousMode.isValid()) {
// If stopping the application also makes Qt Creator active (as the
// "previously active application"), doing the switch synchronously
// leads to funny effects with floating dock widgets
const Utils::Id mode = d->m_previousMode;
QTimer::singleShot(0, d, [mode] { ModeManager::activateMode(mode); });
d->m_previousMode = Id();
}
}
QList<QPointer<DebuggerEngine>> EngineManager::engines()
{
QList<QPointer<DebuggerEngine>> result;
d->m_engineModel.forItemsAtLevel<1>([&result](EngineItem *engineItem) {
if (engineItem->m_engine)
result.append(engineItem->m_engine);
});
return result;
}
QPointer<DebuggerEngine> EngineManager::currentEngine()
{
return d->m_currentItem ? d->m_currentItem->m_engine : nullptr;
}
static int s_runningEngineCount = 0;
bool EngineManager::shutDown()
{
for (DebuggerEngine *engine : EngineManager::engines()) {
if (engine && engine->state() != Debugger::DebuggerNotReady) {
++s_runningEngineCount;
connect(engine, &DebuggerEngine::engineFinished, instance(), [] {
if (--s_runningEngineCount == 0) {
emit instance()->shutDownCompleted();
}
});
engine->abortDebugger();
}
}
return s_runningEngineCount > 0;
}
} // Debugger::Internal
#include "enginemanager.moc"
|
