Editor: add and use editor toolbar outline setter

Simplifies switching between c++ builtin code model and clangd since we
can now react on new outlines in the c++ editor widget.

Fixes: QTCREATORBUG-27594
Change-Id: I76bdc301d78572cbdf4196658f751b5204743fbb
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
David Schulz
2022-08-17 13:27:33 +02:00
parent 10c7b810b2
commit 0bc3d74ea4
8 changed files with 76 additions and 34 deletions

View File

@@ -165,7 +165,7 @@ void CppEditorOutline::updateIndex()
void CppEditorOutline::updateIndexNow()
{
if (m_model->editorRevision() != m_editorWidget->document()->revision()) {
m_updateIndexTimer->start();
m_editorWidget->cppEditorDocument()->updateOutline();
return;
}

View File

@@ -411,8 +411,6 @@ public:
CppEditorDocument *m_cppEditorDocument;
CppEditorOutline *m_cppEditorOutline = nullptr;
QAction *m_outlineAction = nullptr;
QTimer m_outlineTimer;
QTimer m_updateFunctionDeclDefLinkTimer;
SemanticInfo m_lastSemanticInfo;
@@ -489,7 +487,7 @@ void CppEditorWidget::finalizeInitialization()
connect(&d->m_localRenaming, &CppLocalRenaming::processKeyPressNormally,
this, &CppEditorWidget::processKeyNormally);
connect(this, &QPlainTextEdit::cursorPositionChanged, this, [this] {
if (d->shouldOfferOutline())
if (d->m_cppEditorOutline)
d->m_cppEditorOutline->updateIndex();
});
@@ -527,8 +525,7 @@ void CppEditorWidget::finalizeInitialization()
});
// Toolbar: Outline/Overview combo box
d->m_outlineAction = insertExtraToolBarWidget(TextEditorWidget::Left,
d->m_cppEditorOutline->widget());
setToolbarOutline(d->m_cppEditorOutline->widget());
// clang-format on
// Toolbar: '#' Button
@@ -546,17 +543,8 @@ void CppEditorWidget::finalizeInitialization()
insertExtraToolBarWidget(TextEditorWidget::Left, d->m_preprocessorButton);
}
d->m_outlineTimer.setInterval(5000);
d->m_outlineTimer.setSingleShot(true);
connect(&d->m_outlineTimer, &QTimer::timeout, this, [this] {
d->m_outlineAction->setVisible(d->shouldOfferOutline());
if (d->m_outlineAction->isVisible())
d->m_cppEditorDocument->updateOutline();
});
connect(&ClangdSettings::instance(), &ClangdSettings::changed,
&d->m_outlineTimer, qOverload<>(&QTimer::start));
connect(d->m_cppEditorDocument, &CppEditorDocument::changed,
&d->m_outlineTimer, qOverload<>(&QTimer::start));
connect(this, &TextEditor::TextEditorWidget::toolbarOutlineChanged,
this, &CppEditorWidget::handleOutlineChanged);
}
void CppEditorWidget::finalizeInitializationAfterDuplication(TextEditorWidget *other)
@@ -758,6 +746,20 @@ const ProjectPart *CppEditorWidget::projectPart() const
ProjectExplorer::ProjectTree::currentProject());
}
void CppEditorWidget::handleOutlineChanged(const QWidget *newOutline)
{
if (d->m_cppEditorOutline && newOutline != d->m_cppEditorOutline->widget()) {
delete d->m_cppEditorOutline;
d->m_cppEditorOutline = nullptr;
}
if (newOutline == nullptr) {
if (!d->m_cppEditorOutline)
d->m_cppEditorOutline = new CppEditorOutline(this);
d->m_cppEditorOutline->updateIndex();
setToolbarOutline(d->m_cppEditorOutline->widget());
}
}
namespace {
using Utils::Text::selectAt;

View File

@@ -149,6 +149,8 @@ private:
const ProjectPart *projectPart() const;
void handleOutlineChanged(const QWidget* newOutline);
private:
QScopedPointer<Internal::CppEditorWidgetPrivate> d;
};

View File

@@ -183,7 +183,6 @@ void CppOutlineWidget::updateIndexNow()
const auto revision = static_cast<unsigned>(m_editor->document()->revision());
if (m_model->editorRevision() != revision) {
m_editor->cppEditorDocument()->updateOutline();
m_updateIndexTimer.start();
return;
}

View File

@@ -212,7 +212,7 @@ void OverviewModel::update(CPlusPlus::Document::Ptr doc)
int OverviewModel::editorRevision()
{
return m_cppDocument ? m_cppDocument->editorRevision() : 0;
return m_cppDocument ? m_cppDocument->editorRevision() : -1;
}
void OverviewModel::rebuild()

View File

@@ -228,7 +228,7 @@ public:
QPointer<QAction> m_popupAction;
QPointer<Client> m_client;
QPointer<QAction> m_outlineAction;
QPointer<QWidget> m_outline;
};
void updateEditorToolBar(Core::IEditor *editor)
@@ -292,19 +292,16 @@ void updateEditorToolBar(Core::IEditor *editor)
if (!extras->m_client || !client || extras->m_client != client
|| !client->supportsDocumentSymbols(document)) {
if (extras->m_outlineAction) {
widget->toolBar()->removeAction(extras->m_outlineAction);
delete extras->m_outlineAction;
}
if (extras->m_outline && widget->toolbarOutlineWidget() == extras->m_outline)
widget->setToolbarOutline(nullptr);
extras->m_client.clear();
}
if (!extras->m_client) {
QWidget *comboBox = LanguageClientOutlineWidgetFactory::createComboBox(client, textEditor);
if (comboBox) {
extras->m_outline = LanguageClientOutlineWidgetFactory::createComboBox(client, textEditor);
if (extras->m_outline) {
widget->setToolbarOutline(extras->m_outline);
extras->m_client = client;
extras->m_outlineAction = widget->insertExtraToolBarWidget(TextEditorWidget::Left,
comboBox);
}
}
}

View File

@@ -658,6 +658,8 @@ public:
QWidget *m_toolBarWidget = nullptr;
QToolBar *m_toolBar = nullptr;
QWidget *m_stretchWidget = nullptr;
QAction *m_stretchAction = nullptr;
QAction *m_toolbarOutlineAction = nullptr;
LineColumnLabel *m_cursorPositionLabel = nullptr;
FixedSizeClickLabel *m_fileEncodingLabel = nullptr;
QAction *m_fileEncodingLabelAction = nullptr;
@@ -945,7 +947,7 @@ TextEditorWidgetPrivate::TextEditorWidgetPrivate(TextEditorWidget *parent)
m_stretchWidget->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
m_toolBar = new QToolBar;
m_toolBar->setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Minimum);
m_toolBar->addWidget(m_stretchWidget);
m_stretchAction = m_toolBar->addWidget(m_stretchWidget);
m_toolBarWidget->layout()->addWidget(m_toolBar);
m_cursorPositionLabel = new LineColumnLabel(q);
@@ -7894,11 +7896,8 @@ QWidget *BaseTextEditor::toolBar()
QAction * TextEditorWidget::insertExtraToolBarWidget(TextEditorWidget::Side side,
QWidget *widget)
{
if (widget->sizePolicy().horizontalPolicy() & QSizePolicy::ExpandFlag) {
if (d->m_stretchWidget)
d->m_stretchWidget->deleteLater();
d->m_stretchWidget = nullptr;
}
if (widget->sizePolicy().horizontalPolicy() & QSizePolicy::ExpandFlag)
d->m_stretchAction->setVisible(false);
if (side == Left) {
QAction *before = Utils::findOr(d->m_toolBar->actions(),
@@ -7912,6 +7911,46 @@ QAction * TextEditorWidget::insertExtraToolBarWidget(TextEditorWidget::Side side
}
}
void TextEditorWidget::setToolbarOutline(QWidget *widget)
{
if (d->m_toolbarOutlineAction) {
if (d->m_toolBar->widgetForAction(d->m_toolbarOutlineAction) == widget)
return;
d->m_toolBar->removeAction(d->m_toolbarOutlineAction);
delete d->m_toolbarOutlineAction;
d->m_toolbarOutlineAction = nullptr;
} else if (!widget) {
return;
}
if (widget) {
if (widget->sizePolicy().horizontalPolicy() & QSizePolicy::ExpandFlag)
d->m_stretchAction->setVisible(false);
d->m_toolbarOutlineAction = d->m_toolBar->insertWidget(d->m_stretchAction, widget);
} else {
// check for a widget with an expanding size policy otherwise re-enable the stretcher
for (auto action : d->m_toolBar->actions()) {
if (QWidget *toolbarWidget = d->m_toolBar->widgetForAction(action)) {
if (toolbarWidget->isVisible()
&& toolbarWidget->sizePolicy().horizontalPolicy() & QSizePolicy::ExpandFlag) {
d->m_stretchAction->setVisible(false);
return;
}
}
}
d->m_stretchAction->setVisible(true);
}
emit toolbarOutlineChanged(widget);
}
const QWidget *TextEditorWidget::toolbarOutlineWidget()
{
return d->m_toolbarOutlineAction ? d->m_toolBar->widgetForAction(d->m_toolbarOutlineAction)
: nullptr;
}
void TextEditorWidget::keepAutoCompletionHighlight(bool keepHighlight)
{
d->m_keepAutoCompletionHighlight = keepHighlight;

View File

@@ -332,6 +332,8 @@ public:
enum Side { Left, Right };
QAction *insertExtraToolBarWidget(Side side, QWidget *widget);
void setToolbarOutline(QWidget* widget);
const QWidget *toolbarOutlineWidget();
// keep the auto completion even if the focus is lost
void keepAutoCompletionHighlight(bool keepHighlight);
@@ -501,6 +503,7 @@ signals:
void requestUsages(const QTextCursor &cursor);
void requestRename(const QTextCursor &cursor);
void optionalActionMaskChanged();
void toolbarOutlineChanged(QWidget *newOutline);
protected:
QTextBlock blockForVisibleRow(int row) const;