Commit 4ecadb38 authored by Nikolai Kosjar's avatar Nikolai Kosjar

CppEditor: Extract CppEditorOutline

Change-Id: I3b41f91f17ce9fb24796f2f6bff353fb3c6177ec
Reviewed-by: default avatarErik Verbruggen <erik.verbruggen@digia.com>
parent eaecac2f
This diff is collapsed.
......@@ -43,10 +43,7 @@
#include <QScopedPointer>
namespace CPlusPlus {
class OverviewModel;
class Symbol;
}
namespace CPlusPlus { class Symbol; }
namespace CppTools {
class SemanticInfo;
......@@ -56,6 +53,7 @@ class CommentsSettings;
namespace CppEditor {
namespace Internal {
class CppEditorOutline;
class CPPEditorWidget;
class CPPEditorWidgetPrivate;
class FollowSymbolUnderCursor;
......@@ -93,12 +91,10 @@ public:
~CPPEditorWidget();
CPPEditorDocument *cppEditorDocument() const;
CppEditorOutline *outline() const;
CppTools::SemanticInfo semanticInfo() const;
CPlusPlus::OverviewModel *outlineModel() const;
QModelIndex outlineModelIndex();
QSharedPointer<FunctionDeclDefLink> declDefLink() const;
void applyDeclDefLinkChanges(bool jumpToMatch);
......@@ -108,16 +104,12 @@ public:
FollowSymbolUnderCursor *followSymbolUnderCursorDelegate(); // exposed for tests
signals:
void outlineModelIndexChanged(const QModelIndex &index);
public slots:
void paste() QTC_OVERRIDE;
void cut() QTC_OVERRIDE;
void selectAll() QTC_OVERRIDE;
void unCommentSelection() QTC_OVERRIDE;
void setSortedOutline(bool sort);
void switchDeclarationDefinition(bool inNextSplit);
void showPreProcessorWidget();
......@@ -147,11 +139,6 @@ protected slots:
void slotCodeStyleSettingsChanged(const QVariant &) QTC_OVERRIDE;
private slots:
void jumpToOutlineElement();
void updateOutlineNow();
void updateOutlineIndex();
void updateOutlineIndexNow();
void updateOutlineToolTip();
void updateUses();
void updateUsesNow();
void updateFunctionDeclDefLink();
......@@ -192,14 +179,10 @@ private:
QTextCharFormat textCharFormat(TextEditor::TextStyle category);
void markSymbols(const QTextCursor &tc, const CppTools::SemanticInfo &info);
bool sortedOutline() const;
QList<QTextEdit::ExtraSelection> createSelectionsFromUses(
const QList<TextEditor::HighlightingResult> &uses);
QModelIndex indexForPosition(int line, int column,
const QModelIndex &rootIndex = QModelIndex()) const;
bool handleDocumentationComment(QKeyEvent *e);
bool isStartOfDoxygenComment(const QTextCursor &cursor) const;
......
......@@ -10,6 +10,7 @@ HEADERS += \
cppeditordocument.h \
cppeditorconstants.h \
cppeditorenums.h \
cppeditoroutline.h \
cppeditorplugin.h \
cppelementevaluator.h \
cppfilewizard.h \
......@@ -40,6 +41,7 @@ SOURCES += \
cppcodemodelinspectordialog.cpp \
cppeditor.cpp \
cppeditordocument.cpp \
cppeditoroutline.cpp \
cppeditorplugin.cpp \
cppelementevaluator.cpp \
cppfilewizard.cpp \
......
......@@ -28,6 +28,7 @@ QtcPlugin {
"cppeditorconstants.h",
"cppeditordocument.cpp", "cppeditordocument.h",
"cppeditorenums.h",
"cppeditoroutline.cpp", "cppeditoroutline.h",
"cppeditorplugin.cpp", "cppeditorplugin.h",
"cppelementevaluator.cpp", "cppelementevaluator.h",
"cppfilewizard.cpp", "cppfilewizard.h",
......
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "cppeditoroutline.h"
#include "cppeditor.h"
#include "cppeditorplugin.h"
#include <cpptools/cppmodelmanagerinterface.h>
#include <cplusplus/OverviewModel.h>
#include <utils/treeviewcombobox.h>
#include <QSortFilterProxyModel>
#include <QTimer>
/*!
\class CppEditor::Internal::CppEditorOutline
\brief A helper class of CPPEditorWidget that provides the outline model
and widget, e.g. for the editor's tool bar.
\internal
The caller is responsible for deleting the widget returned by widget().
\sa CppEditor::Internal::CPPEditorWidget
*/
enum { UpdateOutlineIntervalInMs = 500 };
namespace {
class OverviewProxyModel : public QSortFilterProxyModel
{
Q_OBJECT
public:
OverviewProxyModel(CPlusPlus::OverviewModel *sourceModel, QObject *parent)
: QSortFilterProxyModel(parent)
, m_sourceModel(sourceModel)
{
setSourceModel(m_sourceModel);
}
bool filterAcceptsRow(int sourceRow,const QModelIndex &sourceParent) const
{
// Ignore generated symbols, e.g. by macro expansion (Q_OBJECT)
const QModelIndex sourceIndex = m_sourceModel->index(sourceRow, 0, sourceParent);
CPlusPlus::Symbol *symbol = m_sourceModel->symbolFromIndex(sourceIndex);
if (symbol && symbol->isGenerated())
return false;
return QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
}
private:
CPlusPlus::OverviewModel *m_sourceModel;
};
QTimer *newSingleShotTimer(QObject *parent, int msInternal)
{
QTimer *timer = new QTimer(parent);
timer->setSingleShot(true);
timer->setInterval(msInternal);
return timer;
}
} // anonymous namespace
namespace CppEditor {
namespace Internal {
CppEditorOutline::CppEditorOutline(CPPEditorWidget *editorWidget)
: QObject(editorWidget)
, m_editorWidget(editorWidget)
, m_combo(new Utils::TreeViewComboBox)
, m_model(new CPlusPlus::OverviewModel(this))
, m_proxyModel(new OverviewProxyModel(m_model, this))
{
// Set up proxy model
if (CppEditorPlugin::instance()->sortedOutline())
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);
m_proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive);
// Set up combo box
m_combo->setModel(m_proxyModel);
m_combo->setMinimumContentsLength(22);
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("Sort Alphabetically"), m_combo);
m_sortAction->setCheckable(true);
m_sortAction->setChecked(isSorted());
connect(m_sortAction, SIGNAL(toggled(bool)),
CppEditorPlugin::instance(), SLOT(setSortedOutline(bool)));
m_combo->addAction(m_sortAction);
connect(m_combo, SIGNAL(activated(int)), this, SLOT(gotoSymbolInEditor()));
connect(m_combo, SIGNAL(currentIndexChanged(int)), this, SLOT(updateToolTip()));
// Set up timers
m_updateTimer = newSingleShotTimer(this, UpdateOutlineIntervalInMs);
connect(m_updateTimer, SIGNAL(timeout()), this, SLOT(updateNow()));
m_updateIndexTimer = newSingleShotTimer(this, UpdateOutlineIntervalInMs);
connect(m_updateIndexTimer, SIGNAL(timeout()), this, SLOT(updateIndexNow()));
}
void CppEditorOutline::update()
{
m_updateTimer->start();
}
bool CppEditorOutline::isSorted() const
{
return m_proxyModel->sortColumn() == 0;
}
void CppEditorOutline::setSorted(bool sort)
{
if (sort != isSorted()) {
if (sort)
m_proxyModel->sort(0, Qt::AscendingOrder);
else
m_proxyModel->sort(-1, Qt::AscendingOrder);
bool block = m_sortAction->blockSignals(true);
m_sortAction->setChecked(m_proxyModel->sortColumn() == 0);
m_sortAction->blockSignals(block);
updateIndexNow();
}
}
CPlusPlus::OverviewModel *CppEditorOutline::model() const
{
return m_model;
}
QModelIndex CppEditorOutline::modelIndex()
{
if (!m_modelIndex.isValid()) {
int line = 0, column = 0;
m_editorWidget->convertPosition(m_editorWidget->position(), &line, &column);
m_modelIndex = indexForPosition(line, column);
emit modelIndexChanged(m_modelIndex);
}
return m_modelIndex;
}
QWidget *CppEditorOutline::widget() const
{
return m_combo;
}
void CppEditorOutline::updateNow()
{
CppTools::CppModelManagerInterface *cmmi = CppTools::CppModelManagerInterface::instance();
if (!cmmi)
return;
const CPlusPlus::Snapshot snapshot = cmmi->snapshot();
const QString filePath = m_editorWidget->baseTextDocument()->filePath();
CPlusPlus::Document::Ptr document = snapshot.document(filePath);
if (!document)
return;
if (document->editorRevision() != (unsigned) m_editorWidget->document()->revision()) {
m_updateTimer->start();
return;
}
m_model->rebuild(document);
m_combo->view()->expandAll();
updateIndexNow();
}
void CppEditorOutline::updateIndex()
{
m_updateIndexTimer->start();
}
void CppEditorOutline::updateIndexNow()
{
if (!m_model->document())
return;
const unsigned revision = m_editorWidget->document()->revision();
if (m_model->document()->editorRevision() != revision) {
m_updateIndexTimer->start();
return;
}
m_updateIndexTimer->stop();
m_modelIndex = QModelIndex(); //invalidate
QModelIndex comboIndex = modelIndex();
if (comboIndex.isValid()) {
bool blocked = m_combo->blockSignals(true);
m_combo->setCurrentIndex(m_proxyModel->mapFromSource(comboIndex));
updateToolTip();
m_combo->blockSignals(blocked);
}
}
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);
CPlusPlus::Symbol *symbol = m_model->symbolFromIndex(sourceIndex);
if (!symbol)
return;
const TextEditor::BaseTextEditorWidget::Link &link = CPPEditorWidget::linkToSymbol(symbol);
m_editorWidget->gotoLine(link.targetLine, link.targetColumn);
Core::EditorManager::activateEditor(m_editorWidget->editor());
}
QModelIndex CppEditorOutline::indexForPosition(int line, int column,
const QModelIndex &rootIndex) const
{
QModelIndex lastIndex = rootIndex;
const int rowCount = m_model->rowCount(rootIndex);
for (int row = 0; row < rowCount; ++row) {
const QModelIndex index = m_model->index(row, 0, rootIndex);
CPlusPlus::Symbol *symbol = m_model->symbolFromIndex(index);
if (symbol && symbol->line() > unsigned(line))
break;
lastIndex = index;
}
if (lastIndex != rootIndex) {
// recurse
lastIndex = indexForPosition(line, column, lastIndex);
}
return lastIndex;
}
} // namespace Internal
} // namespace CppEditor
#include <cppeditoroutline.moc>
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef CPPEDITOROUTLINE_H
#define CPPEDITOROUTLINE_H
#include <QModelIndex>
#include <QObject>
QT_BEGIN_NAMESPACE
class QAction;
class QSortFilterProxyModel;
class QTimer;
QT_END_NAMESPACE
namespace CPlusPlus { class OverviewModel; }
namespace Utils { class TreeViewComboBox; }
namespace CppEditor {
namespace Internal {
class CPPEditorWidget;
class CppEditorOutline : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(CppEditorOutline)
public:
explicit CppEditorOutline(CPPEditorWidget *editorWidget);
void update();
CPlusPlus::OverviewModel *model() const;
QModelIndex modelIndex();
QWidget *widget() const; // Must be deleted by client.
signals:
void modelIndexChanged(const QModelIndex &index);
public slots:
void updateIndex();
void setSorted(bool sort);
private slots:
void updateNow();
void updateIndexNow();
void updateToolTip();
void gotoSymbolInEditor();
private:
CppEditorOutline();
bool isSorted() const;
QModelIndex indexForPosition(int line, int column,
const QModelIndex &rootIndex = QModelIndex()) const;
private:
CPPEditorWidget *m_editorWidget;
Utils::TreeViewComboBox *m_combo; // Not owned
CPlusPlus::OverviewModel *m_model;
QSortFilterProxyModel *m_proxyModel;
QModelIndex m_modelIndex;
QAction *m_sortAction;
QTimer *m_updateTimer;
QTimer *m_updateIndexTimer;
};
} // namespace Internal
} // namespace CppEditor
#endif // CPPEDITOROUTLINE_H
......@@ -30,19 +30,19 @@
#include "cppeditorplugin.h"
#include "cppclasswizard.h"
#include "cppeditor.h"
#include "cppcodemodelinspectordialog.h"
#include "cppeditorconstants.h"
#include "cppeditor.h"
#include "cppeditoroutline.h"
#include "cppfilewizard.h"
#include "cpphighlighterfactory.h"
#include "cpphoverhandler.h"
#include "cppoutline.h"
#include "cpptypehierarchy.h"
#include "cppincludehierarchy.h"
#include "cppsnippetprovider.h"
#include "cppoutline.h"
#include "cppquickfixassistant.h"
#include "cppquickfixes.h"
#include "cpphighlighterfactory.h"
#include "cppcodemodelinspectordialog.h"
#include "cppsnippetprovider.h"
#include "cpptypehierarchy.h"
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.h>
......@@ -135,7 +135,7 @@ void CppEditorPlugin::initializeEditor(CPPEditorWidget *editor)
// function combo box sorting
connect(this, SIGNAL(outlineSortingChanged(bool)),
editor, SLOT(setSortedOutline(bool)));
editor->outline(), SLOT(setSorted(bool)));
}
void CppEditorPlugin::setSortedOutline(bool sorted)
......
......@@ -29,6 +29,8 @@
#include "cppoutline.h"
#include "cppeditoroutline.h"
#include <cplusplus/OverviewModel.h>
#include <coreplugin/find/treeviewfind.h>
......@@ -92,7 +94,7 @@ CppOutlineWidget::CppOutlineWidget(CPPEditorWidget *editor) :
TextEditor::IOutlineWidget(),
m_editor(editor),
m_treeView(new CppOutlineTreeView(this)),
m_model(m_editor->outlineModel()),
m_model(m_editor->outline()->model()),
m_proxyModel(new CppOutlineFilterModel(m_model, this)),
m_enableCursorSync(true),
m_blockCursorSync(false)
......@@ -109,7 +111,7 @@ CppOutlineWidget::CppOutlineWidget(CPPEditorWidget *editor) :
connect(m_model, SIGNAL(modelReset()), this, SLOT(modelUpdated()));
modelUpdated();
connect(m_editor, SIGNAL(outlineModelIndexChanged(QModelIndex)),
connect(m_editor->outline(), SIGNAL(modelIndexChanged(QModelIndex)),
this, SLOT(updateSelectionInTree(QModelIndex)));
connect(m_treeView->selectionModel(), SIGNAL(selectionChanged(QItemSelection,QItemSelection)),
this, SLOT(updateSelectionInText(QItemSelection)));
......@@ -126,7 +128,7 @@ void CppOutlineWidget::setCursorSynchronization(bool syncWithCursor)
{
m_enableCursorSync = syncWithCursor;
if (m_enableCursorSync)
updateSelectionInTree(m_editor->outlineModelIndex());
updateSelectionInTree(m_editor->outline()->modelIndex());
}
void CppOutlineWidget::modelUpdated()
......
......@@ -38,6 +38,8 @@
#include <QSortFilterProxyModel>
namespace CPlusPlus { class OverviewModel; }
namespace CppEditor {
namespace Internal {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment