forked from qt-creator/qt-creator
b20ffaa109
The order we get from the server might not be in the order of appearance in the document. Fixes: QTCREATORBUG-4346 Change-Id: I0badba7fd40619b2aa20a81b6a86b43dc9e6a1b1 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
438 lines
15 KiB
C++
438 lines
15 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2018 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "languageclientoutline.h"
|
|
|
|
#include "documentsymbolcache.h"
|
|
#include "languageclientmanager.h"
|
|
#include "languageclientutils.h"
|
|
|
|
#include <coreplugin/editormanager/ieditor.h>
|
|
#include <coreplugin/find/itemviewfind.h>
|
|
#include <languageserverprotocol/languagefeatures.h>
|
|
#include <texteditor/outlinefactory.h>
|
|
#include <texteditor/textdocument.h>
|
|
#include <texteditor/texteditor.h>
|
|
#include <utils/itemviews.h>
|
|
#include <utils/treemodel.h>
|
|
#include <utils/treeviewcombobox.h>
|
|
#include <utils/utilsicons.h>
|
|
|
|
#include <QAction>
|
|
#include <QBoxLayout>
|
|
#include <QSortFilterProxyModel>
|
|
|
|
using namespace LanguageServerProtocol;
|
|
|
|
namespace LanguageClient {
|
|
|
|
const QList<SymbolInformation> sortedSymbols(const QList<SymbolInformation> &symbols)
|
|
{
|
|
auto result = symbols;
|
|
Utils::sort(result, [](const SymbolInformation &a, const SymbolInformation &b){
|
|
return a.location().range().start() < b.location().range().start();
|
|
});
|
|
return result;
|
|
}
|
|
const QList<DocumentSymbol> sortedSymbols(const QList<DocumentSymbol> &symbols)
|
|
{
|
|
auto result = symbols;
|
|
Utils::sort(result, [](const DocumentSymbol &a, const DocumentSymbol &b){
|
|
return a.range().start() < b.range().start();
|
|
});
|
|
return result;
|
|
}
|
|
|
|
class LanguageClientOutlineItem : public Utils::TypedTreeItem<LanguageClientOutlineItem>
|
|
{
|
|
public:
|
|
LanguageClientOutlineItem() = default;
|
|
LanguageClientOutlineItem(const SymbolInformation &info)
|
|
: m_name(info.name())
|
|
, m_range(info.location().range())
|
|
, m_type(info.kind())
|
|
{ }
|
|
|
|
LanguageClientOutlineItem(const DocumentSymbol &info, const SymbolStringifier &stringifier)
|
|
: m_name(info.name())
|
|
, m_detail(info.detail().value_or(QString()))
|
|
, m_range(info.range())
|
|
, m_symbolStringifier(stringifier)
|
|
, m_type(info.kind())
|
|
{
|
|
const QList<LanguageServerProtocol::DocumentSymbol> children = sortedSymbols(
|
|
info.children().value_or(QList<DocumentSymbol>()));
|
|
for (const DocumentSymbol &child : children)
|
|
appendChild(new LanguageClientOutlineItem(child, stringifier));
|
|
}
|
|
|
|
// TreeItem interface
|
|
QVariant data(int column, int role) const override
|
|
{
|
|
switch (role) {
|
|
case Qt::DecorationRole:
|
|
return symbolIcon(m_type);
|
|
case Qt::DisplayRole:
|
|
return m_symbolStringifier
|
|
? m_symbolStringifier(static_cast<SymbolKind>(m_type), m_name, m_detail)
|
|
: m_name;
|
|
default:
|
|
return Utils::TreeItem::data(column, role);
|
|
}
|
|
}
|
|
|
|
Range range() const { return m_range; }
|
|
Position pos() const { return m_range.start(); }
|
|
bool contains(const Position &pos) const { return m_range.contains(pos); }
|
|
|
|
private:
|
|
QString m_name;
|
|
QString m_detail;
|
|
Range m_range;
|
|
SymbolStringifier m_symbolStringifier;
|
|
int m_type = -1;
|
|
};
|
|
|
|
class LanguageClientOutlineModel : public Utils::TreeModel<LanguageClientOutlineItem>
|
|
{
|
|
public:
|
|
using Utils::TreeModel<LanguageClientOutlineItem>::TreeModel;
|
|
void setInfo(const QList<SymbolInformation> &info)
|
|
{
|
|
clear();
|
|
for (const SymbolInformation &symbol : sortedSymbols(info))
|
|
rootItem()->appendChild(new LanguageClientOutlineItem(symbol));
|
|
}
|
|
void setInfo(const QList<DocumentSymbol> &info)
|
|
{
|
|
clear();
|
|
for (const DocumentSymbol &symbol : sortedSymbols(info))
|
|
rootItem()->appendChild(new LanguageClientOutlineItem(symbol, m_symbolStringifier));
|
|
}
|
|
|
|
void setSymbolStringifier(const SymbolStringifier &stringifier)
|
|
{
|
|
m_symbolStringifier = stringifier;
|
|
}
|
|
|
|
private:
|
|
SymbolStringifier m_symbolStringifier;
|
|
};
|
|
|
|
class LanguageClientOutlineWidget : public TextEditor::IOutlineWidget
|
|
{
|
|
public:
|
|
LanguageClientOutlineWidget(Client *client, TextEditor::BaseTextEditor *editor);
|
|
|
|
// IOutlineWidget interface
|
|
public:
|
|
QList<QAction *> filterMenuActions() const override;
|
|
void setCursorSynchronization(bool syncWithCursor) override;
|
|
void setSorted(bool) override;
|
|
bool isSorted() const override;
|
|
void restoreSettings(const QVariantMap &map) override;
|
|
QVariantMap settings() const override;
|
|
|
|
private:
|
|
void handleResponse(const DocumentUri &uri, const DocumentSymbolsResult &response);
|
|
void updateTextCursor(const QModelIndex &proxyIndex);
|
|
void updateSelectionInTree(const QTextCursor ¤tCursor);
|
|
void onItemActivated(const QModelIndex &index);
|
|
|
|
QPointer<Client> m_client;
|
|
QPointer<TextEditor::BaseTextEditor> m_editor;
|
|
LanguageClientOutlineModel m_model;
|
|
QSortFilterProxyModel m_proxyModel;
|
|
Utils::TreeView m_view;
|
|
DocumentUri m_uri;
|
|
bool m_sync = false;
|
|
bool m_sorted = false;
|
|
};
|
|
|
|
LanguageClientOutlineWidget::LanguageClientOutlineWidget(Client *client,
|
|
TextEditor::BaseTextEditor *editor)
|
|
: m_client(client)
|
|
, m_editor(editor)
|
|
, m_view(this)
|
|
, m_uri(DocumentUri::fromFilePath(editor->textDocument()->filePath()))
|
|
{
|
|
connect(client->documentSymbolCache(),
|
|
&DocumentSymbolCache::gotSymbols,
|
|
this,
|
|
&LanguageClientOutlineWidget::handleResponse);
|
|
connect(client, &Client::documentUpdated, this, [this](TextEditor::TextDocument *document) {
|
|
if (m_client && m_uri == DocumentUri::fromFilePath(document->filePath()))
|
|
m_client->documentSymbolCache()->requestSymbols(m_uri, Schedule::Delayed);
|
|
});
|
|
|
|
client->documentSymbolCache()->requestSymbols(m_uri, Schedule::Delayed);
|
|
|
|
auto *layout = new QVBoxLayout;
|
|
layout->setContentsMargins(0, 0, 0, 0);
|
|
layout->setSpacing(0);
|
|
layout->addWidget(Core::ItemViewFind::createSearchableWrapper(&m_view));
|
|
setLayout(layout);
|
|
m_model.setSymbolStringifier(m_client->symbolStringifier());
|
|
m_proxyModel.setSourceModel(&m_model);
|
|
m_view.setModel(&m_proxyModel);
|
|
m_view.setHeaderHidden(true);
|
|
m_view.setExpandsOnDoubleClick(false);
|
|
m_view.setFrameStyle(QFrame::NoFrame);
|
|
connect(&m_view, &QAbstractItemView::activated,
|
|
this, &LanguageClientOutlineWidget::onItemActivated);
|
|
connect(m_editor->editorWidget(), &TextEditor::TextEditorWidget::cursorPositionChanged,
|
|
this, [this](){
|
|
if (m_sync)
|
|
updateSelectionInTree(m_editor->textCursor());
|
|
});
|
|
}
|
|
|
|
QList<QAction *> LanguageClientOutlineWidget::filterMenuActions() const
|
|
{
|
|
return {};
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::setCursorSynchronization(bool syncWithCursor)
|
|
{
|
|
m_sync = syncWithCursor;
|
|
if (m_sync && m_editor)
|
|
updateSelectionInTree(m_editor->textCursor());
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::setSorted(bool sorted)
|
|
{
|
|
m_sorted = sorted;
|
|
m_proxyModel.sort(sorted ? 0 : -1);
|
|
}
|
|
|
|
bool LanguageClientOutlineWidget::isSorted() const
|
|
{
|
|
return m_sorted;
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::restoreSettings(const QVariantMap &map)
|
|
{
|
|
setSorted(map.value(QString("LspOutline.Sort"), false).toBool());
|
|
}
|
|
|
|
QVariantMap LanguageClientOutlineWidget::settings() const
|
|
{
|
|
return {{QString("LspOutline.Sort"), m_sorted}};
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::handleResponse(const DocumentUri &uri,
|
|
const DocumentSymbolsResult &result)
|
|
{
|
|
if (uri != m_uri)
|
|
return;
|
|
if (Utils::holds_alternative<QList<SymbolInformation>>(result))
|
|
m_model.setInfo(Utils::get<QList<SymbolInformation>>(result));
|
|
else if (Utils::holds_alternative<QList<DocumentSymbol>>(result))
|
|
m_model.setInfo(Utils::get<QList<DocumentSymbol>>(result));
|
|
else
|
|
m_model.clear();
|
|
|
|
// The list has changed, update the current items
|
|
updateSelectionInTree(m_editor->textCursor());
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::updateTextCursor(const QModelIndex &proxyIndex)
|
|
{
|
|
LanguageClientOutlineItem *item = m_model.itemForIndex(m_proxyModel.mapToSource(proxyIndex));
|
|
const Position &pos = item->pos();
|
|
// line has to be 1 based, column 0 based!
|
|
m_editor->editorWidget()->gotoLine(pos.line() + 1, pos.character(), true, true);
|
|
}
|
|
|
|
static LanguageClientOutlineItem *itemForCursor(const LanguageClientOutlineModel &m_model,
|
|
const QTextCursor &cursor)
|
|
{
|
|
const Position pos(cursor);
|
|
LanguageClientOutlineItem *result = nullptr;
|
|
m_model.forAllItems([&](LanguageClientOutlineItem *candidate){
|
|
if (!candidate->contains(pos))
|
|
return;
|
|
if (result && candidate->range().contains(result->range()))
|
|
return; // skip item if the range is equal or bigger than the previous found range
|
|
result = candidate;
|
|
});
|
|
return result;
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::updateSelectionInTree(const QTextCursor ¤tCursor)
|
|
{
|
|
if (LanguageClientOutlineItem *item = itemForCursor(m_model, currentCursor)) {
|
|
const QModelIndex index = m_proxyModel.mapFromSource(m_model.indexForItem(item));
|
|
m_view.setCurrentIndex(index);
|
|
m_view.scrollTo(index);
|
|
} else {
|
|
m_view.clearSelection();
|
|
}
|
|
}
|
|
|
|
void LanguageClientOutlineWidget::onItemActivated(const QModelIndex &index)
|
|
{
|
|
if (!index.isValid() || !m_editor)
|
|
return;
|
|
|
|
updateTextCursor(index);
|
|
m_editor->widget()->setFocus();
|
|
}
|
|
|
|
bool LanguageClientOutlineWidgetFactory::supportsEditor(Core::IEditor *editor) const
|
|
{
|
|
if (auto doc = qobject_cast<TextEditor::TextDocument *>(editor->document())) {
|
|
if (Client *client = LanguageClientManager::clientForDocument(doc))
|
|
return client->supportsDocumentSymbols(doc);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
TextEditor::IOutlineWidget *LanguageClientOutlineWidgetFactory::createWidget(Core::IEditor *editor)
|
|
{
|
|
auto textEditor = qobject_cast<TextEditor::BaseTextEditor *>(editor);
|
|
QTC_ASSERT(textEditor, return nullptr);
|
|
if (Client *client = LanguageClientManager::clientForDocument(textEditor->textDocument())) {
|
|
if (client->supportsDocumentSymbols(textEditor->textDocument()))
|
|
return new LanguageClientOutlineWidget(client, textEditor);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
class OutlineComboBox : public Utils::TreeViewComboBox
|
|
{
|
|
Q_DECLARE_TR_FUNCTIONS(LanguageClient::OutlineComboBox)
|
|
public:
|
|
OutlineComboBox(Client *client, TextEditor::BaseTextEditor *editor);
|
|
|
|
private:
|
|
void updateModel(const DocumentUri &resultUri, const DocumentSymbolsResult &result);
|
|
void updateEntry();
|
|
void activateEntry();
|
|
void documentUpdated(TextEditor::TextDocument *document);
|
|
void setSorted(bool sorted);
|
|
|
|
LanguageClientOutlineModel m_model;
|
|
QSortFilterProxyModel m_proxyModel;
|
|
QPointer<Client> m_client;
|
|
TextEditor::TextEditorWidget *m_editorWidget;
|
|
const DocumentUri m_uri;
|
|
};
|
|
|
|
Utils::TreeViewComboBox *LanguageClientOutlineWidgetFactory::createComboBox(
|
|
Client *client, TextEditor::BaseTextEditor *editor)
|
|
{
|
|
if (client && client->supportsDocumentSymbols(editor->textDocument()))
|
|
return new OutlineComboBox(client, editor);
|
|
return nullptr;
|
|
}
|
|
|
|
OutlineComboBox::OutlineComboBox(Client *client, TextEditor::BaseTextEditor *editor)
|
|
: m_client(client)
|
|
, m_editorWidget(editor->editorWidget())
|
|
, m_uri(DocumentUri::fromFilePath(editor->document()->filePath()))
|
|
{
|
|
m_model.setSymbolStringifier(client->symbolStringifier());
|
|
m_proxyModel.setSourceModel(&m_model);
|
|
const bool sorted = LanguageClientSettings::outlineComboBoxIsSorted();
|
|
m_proxyModel.sort(sorted ? 0 : -1);
|
|
setModel(&m_proxyModel);
|
|
setMinimumContentsLength(13);
|
|
QSizePolicy policy = sizePolicy();
|
|
policy.setHorizontalPolicy(QSizePolicy::Expanding);
|
|
setSizePolicy(policy);
|
|
setMaxVisibleItems(40);
|
|
|
|
setContextMenuPolicy(Qt::ActionsContextMenu);
|
|
const QString sortActionText
|
|
= QCoreApplication::translate("TextEditor::Internal::OutlineWidgetStack",
|
|
"Sort Alphabetically");
|
|
auto sortAction = new QAction(sortActionText, this);
|
|
sortAction->setCheckable(true);
|
|
sortAction->setChecked(sorted);
|
|
addAction(sortAction);
|
|
|
|
connect(client->documentSymbolCache(),
|
|
&DocumentSymbolCache::gotSymbols,
|
|
this,
|
|
&OutlineComboBox::updateModel);
|
|
connect(client, &Client::documentUpdated, this, &OutlineComboBox::documentUpdated);
|
|
connect(m_editorWidget, &TextEditor::TextEditorWidget::cursorPositionChanged,
|
|
this, &OutlineComboBox::updateEntry);
|
|
connect(this, QOverload<int>::of(&QComboBox::activated), this, &OutlineComboBox::activateEntry);
|
|
connect(sortAction, &QAction::toggled, this, &OutlineComboBox::setSorted);
|
|
|
|
documentUpdated(editor->textDocument());
|
|
}
|
|
|
|
void OutlineComboBox::updateModel(const DocumentUri &resultUri, const DocumentSymbolsResult &result)
|
|
{
|
|
if (m_uri != resultUri)
|
|
return;
|
|
if (Utils::holds_alternative<QList<SymbolInformation>>(result))
|
|
m_model.setInfo(Utils::get<QList<SymbolInformation>>(result));
|
|
else if (Utils::holds_alternative<QList<DocumentSymbol>>(result))
|
|
m_model.setInfo(Utils::get<QList<DocumentSymbol>>(result));
|
|
else
|
|
m_model.clear();
|
|
|
|
view()->expandAll();
|
|
// The list has changed, update the current item
|
|
updateEntry();
|
|
}
|
|
|
|
void OutlineComboBox::updateEntry()
|
|
{
|
|
if (LanguageClientOutlineItem *item = itemForCursor(m_model, m_editorWidget->textCursor()))
|
|
setCurrentIndex(m_proxyModel.mapFromSource(m_model.indexForItem(item)));
|
|
}
|
|
|
|
void OutlineComboBox::activateEntry()
|
|
{
|
|
const QModelIndex modelIndex = m_proxyModel.mapToSource(view()->currentIndex());
|
|
if (modelIndex.isValid()) {
|
|
const Position &pos = m_model.itemForIndex(modelIndex)->pos();
|
|
Core::EditorManager::cutForwardNavigationHistory();
|
|
Core::EditorManager::addCurrentPositionToNavigationHistory();
|
|
// line has to be 1 based, column 0 based!
|
|
m_editorWidget->gotoLine(pos.line() + 1, pos.character(), true, true);
|
|
emit m_editorWidget->activateEditor();
|
|
}
|
|
}
|
|
|
|
void OutlineComboBox::documentUpdated(TextEditor::TextDocument *document)
|
|
{
|
|
if (document == m_editorWidget->textDocument())
|
|
m_client->documentSymbolCache()->requestSymbols(m_uri, Schedule::Delayed);
|
|
}
|
|
|
|
void OutlineComboBox::setSorted(bool sorted)
|
|
{
|
|
LanguageClientSettings::setOutlineComboBoxSorted(sorted);
|
|
m_proxyModel.sort(sorted ? 0 : -1);
|
|
}
|
|
|
|
} // namespace LanguageClient
|