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
|
// 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 "cppeditoroutline.h"
#include "cppeditorconstants.h"
#include "cppeditordocument.h"
#include "cppeditortr.h"
#include "cppeditorwidget.h"
#include "cppmodelmanager.h"
#include "cppoutlinemodel.h"
#include "cpptoolssettings.h"
#include <texteditor/texteditor.h>
#include <texteditor/textdocument.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/icore.h>
#include <utils/storekey.h>
#include <utils/treeviewcombobox.h>
#include <QAction>
#include <QSortFilterProxyModel>
#include <QTimer>
/*!
\class CppEditor::CppEditorOutline
\brief A helper class that provides the outline model and widget,
e.g. for the editor's tool bar.
The caller is responsible for deleting the widget returned by widget().
*/
enum { UpdateOutlineIntervalInMs = 500 };
using namespace Core;
using namespace Utils;
namespace {
class OutlineProxyModel : public QSortFilterProxyModel
{
Q_OBJECT
public:
OutlineProxyModel(CppEditor::Internal::OutlineModel &sourceModel, QObject *parent)
: QSortFilterProxyModel(parent)
, m_sourceModel(sourceModel)
{
}
bool filterAcceptsRow(int sourceRow,const QModelIndex &sourceParent) const override
{
// Ignore generated symbols, e.g. by macro expansion (Q_OBJECT)
const QModelIndex sourceIndex = m_sourceModel.index(sourceRow, 0, sourceParent);
if (m_sourceModel.isGenerated(sourceIndex))
return false;
return QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
}
private:
CppEditor::Internal::OutlineModel &m_sourceModel;
};
QTimer *newSingleShotTimer(QObject *parent, int msInternal, const QString &objectName)
{
auto *timer = new QTimer(parent);
timer->setObjectName(objectName);
timer->setSingleShot(true);
timer->setInterval(msInternal);
return timer;
}
} // anonymous namespace
namespace CppEditor::Internal {
static Key sortEditorDocumentOutlineKey()
{
return Key(Constants::CPPEDITOR_SETTINGSGROUP)
+ '/' + Constants::CPPEDITOR_SORT_EDITOR_DOCUMENT_OUTLINE;
}
const bool kSortEditorDocumentOutlineDefault = true;
static bool sortedEditorDocumentOutline()
{
return ICore::settings()
->value(sortEditorDocumentOutlineKey(), kSortEditorDocumentOutlineDefault)
.toBool();
}
static void setSortedEditorDocumentOutline(bool sorted)
{
ICore::settings()->setValueWithDefault(sortEditorDocumentOutlineKey(),
sorted,
kSortEditorDocumentOutlineDefault);
}
CppEditorOutline::CppEditorOutline(CppEditorWidget *editorWidget)
: QObject(editorWidget)
, m_editorWidget(editorWidget)
, m_combo(new Utils::TreeViewComboBox)
{
m_model = &editorWidget->cppEditorDocument()->outlineModel();
m_proxyModel = new OutlineProxyModel(*m_model, this);
m_proxyModel->setSourceModel(m_model);
// Set up proxy model
if (sortedEditorDocumentOutline())
m_proxyModel->sort(0, Qt::AscendingOrder);
else
m_proxyModel->sort(-1, Qt::AscendingOrder); // don't sort yet, but set column for sortedOutline()
m_proxyModel->setDynamicSortFilter(true);
// Set up combo box
m_combo->setModel(m_proxyModel);
m_combo->setMinimumContentsLength(13);
QSizePolicy policy = m_combo->sizePolicy();
policy.setHorizontalPolicy(QSizePolicy::Expanding);
m_combo->setSizePolicy(policy);
m_combo->setMaxVisibleItems(40);
m_combo->setContextMenuPolicy(Qt::ActionsContextMenu);
m_sortAction = new QAction(Tr::tr("Sort Alphabetically"), m_combo);
m_sortAction->setCheckable(true);
m_sortAction->setChecked(isSorted());
connect(m_sortAction, &QAction::toggled, &setSortedEditorDocumentOutline);
m_combo->addAction(m_sortAction);
connect(m_combo, &QComboBox::activated, this, &CppEditorOutline::gotoSymbolInEditor);
connect(m_combo, &QComboBox::currentIndexChanged, this, &CppEditorOutline::updateToolTip);
connect(m_model, &OutlineModel::modelReset, this, &CppEditorOutline::updateNow);
// Set up timers
m_updateIndexTimer = newSingleShotTimer(this, UpdateOutlineIntervalInMs,
QLatin1String("CppEditorOutline::m_updateIndexTimer"));
connect(m_updateIndexTimer, &QTimer::timeout, this, &CppEditorOutline::updateIndexNow);
}
bool CppEditorOutline::isSorted() const
{
return m_proxyModel->sortColumn() == 0;
}
QWidget *CppEditorOutline::widget() const
{
return m_combo;
}
void CppEditorOutline::updateNow()
{
m_combo->view()->expandAll();
updateIndexNow();
}
void CppEditorOutline::updateIndex()
{
m_updateIndexTimer->start();
}
void CppEditorOutline::updateIndexNow()
{
if (m_model->editorRevision() != m_editorWidget->document()->revision()) {
m_editorWidget->cppEditorDocument()->updateOutline();
return;
}
m_updateIndexTimer->stop();
int line = 0, column = 0;
m_editorWidget->convertPosition(m_editorWidget->position(), &line, &column);
QModelIndex comboIndex = m_model->indexForPosition(line, column);
if (comboIndex.isValid()) {
QSignalBlocker blocker(m_combo);
m_combo->setCurrentIndex(m_proxyModel->mapFromSource(comboIndex));
updateToolTip();
}
}
void CppEditorOutline::updateToolTip()
{
m_combo->setToolTip(m_combo->currentText());
}
void CppEditorOutline::gotoSymbolInEditor()
{
const QModelIndex modelIndex = m_combo->view()->currentIndex();
const QModelIndex sourceIndex = m_proxyModel->mapToSource(modelIndex);
const Utils::Link link = m_model->linkFromIndex(sourceIndex);
if (!link.hasValidTarget())
return;
Core::EditorManager::cutForwardNavigationHistory();
Core::EditorManager::addCurrentPositionToNavigationHistory();
m_editorWidget->gotoLine(link.targetLine, link.targetColumn, true, true);
emit m_editorWidget->activateEditor();
}
} // namespace CppEditor::Internal
#include <cppeditoroutline.moc>
|
