aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/cppeditor/cppuseselectionsupdater.h
diff options
context:
space:
mode:
authorNikolai Kosjar <nikolai.kosjar@digia.com>2014-08-19 15:59:29 +0200
committerNikolai Kosjar <nikolai.kosjar@digia.com>2014-08-25 13:06:01 +0200
commit89bd4ee3c4e4be4b39dee9ef12e798d21be3d2cb (patch)
tree520ad32c8ff76c22e3ea41006c07012c3053d1d9 /src/plugins/cppeditor/cppuseselectionsupdater.h
parent2fa15f221fc2ff2c36995fe904cc3a4837d62760 (diff)
C++: Base parsing on editor document instead of widget
This mainly takes CppEditorSupport apart. * Parsing is now invoked by CPPEditorDocument itself by listening to QTextDocument::contentsChanged(). * Upon construction and destruction CPPEditorDocument creates and deletes an EditorDocumentHandle for (un)registration in the model manager. This handle provides everything to generate the working copy and to access the editor document processor. * A CPPEditorDocument owns a BaseEditorDocumentProcessor instance that controls parsing, semantic info recalculation and the semantic highlighting for the document. This is more or less what is left from CppEditorSupport and can be considered as the backend of a CPPEditorDocument. CPPEditorDocument itself is quite small. * BuiltinEditorDocumentProcessor and ClangEditorDocumentProcessor derive from BaseEditorDocumentProcessor and implement the gaps. * Since the semantic info calculation was bound to the widget, it also calculated the local uses, which depend on the cursor position. This calculation got moved into the extracted class UseSeletionsUpdater in the cppeditor plugin, which is run once the cursor position changes or the semantic info document is updated. * Some more logic got extracted: - SemanticInfoUpdater (logic was in CppEditorSupport) - SemanticHighlighter (logic was in CppEditorSupport) * The *Parser and *Processor classes can be easily accessed by the static function get(). * CppHighlightingSupport is gone since it turned out to be useless. * The editor dependency in CompletionAssistProviders is gone since we actually only need the file path now. Change-Id: I49d3a7bd138c5ed9620123e34480772535156508 Reviewed-by: Orgad Shaneh <orgads@gmail.com> Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>
Diffstat (limited to 'src/plugins/cppeditor/cppuseselectionsupdater.h')
-rw-r--r--src/plugins/cppeditor/cppuseselectionsupdater.h119
1 files changed, 119 insertions, 0 deletions
diff --git a/src/plugins/cppeditor/cppuseselectionsupdater.h b/src/plugins/cppeditor/cppuseselectionsupdater.h
new file mode 100644
index 0000000000..277785afa2
--- /dev/null
+++ b/src/plugins/cppeditor/cppuseselectionsupdater.h
@@ -0,0 +1,119 @@
+/****************************************************************************
+**
+** 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 CPPUSESELECTIONSUPDATER_H
+#define CPPUSESELECTIONSUPDATER_H
+
+#include <cpptools/cppsemanticinfo.h>
+#include <texteditor/texteditorconstants.h>
+
+#include <cplusplus/CppDocument.h>
+
+#include <QFutureWatcher>
+#include <QTextEdit>
+#include <QTimer>
+
+QT_BEGIN_NAMESPACE
+class QTextCharFormat;
+class QTextCursor;
+QT_END_NAMESPACE
+
+namespace TextEditor { class BaseTextEditorWidget; }
+
+namespace CppEditor {
+namespace Internal {
+
+typedef QList<QTextEdit::ExtraSelection> ExtraSelections;
+typedef QList<CppTools::SemanticInfo::Use> SemanticUses;
+
+struct UseSelectionsResult
+{
+ CppTools::SemanticInfo::LocalUseMap localUses;
+ SemanticUses selectionsForLocalVariableUnderCursor;
+ SemanticUses selectionsForLocalUnusedVariables;
+ QList<int> references;
+};
+
+class CppUseSelectionsUpdater : public QObject
+{
+ Q_OBJECT
+ Q_DISABLE_COPY(CppUseSelectionsUpdater)
+
+public:
+ explicit CppUseSelectionsUpdater(TextEditor::BaseTextEditorWidget *editorWidget);
+
+public slots:
+ void scheduleUpdate();
+ void abortSchedule();
+ void update();
+
+signals:
+ void finished(CppTools::SemanticInfo::LocalUseMap localUses);
+ void selectionsForVariableUnderCursorUpdated(const QList<QTextEdit::ExtraSelection> &);
+
+private slots:
+ void onFindUsesFinished();
+
+private:
+ CppUseSelectionsUpdater();
+
+ bool handleMacroCase(const QTextCursor &textCursor,
+ const CPlusPlus::Document::Ptr document);
+ void handleSymbolCase(const QTextCursor &textCursor,
+ const CPlusPlus::Document::Ptr document,
+ const CPlusPlus::Snapshot &snapshot);
+
+ ExtraSelections toExtraSelections(const SemanticUses &uses, TextEditor::TextStyle style) const;
+ ExtraSelections toExtraSelections(const QList<int> &references,
+ TextEditor::TextStyle style) const;
+
+ // Convenience
+ ExtraSelections currentUseSelections() const;
+ void updateUseSelections(const ExtraSelections &selections);
+ void updateUnusedSelections(const ExtraSelections &selections);
+ QTextCharFormat textCharFormat(TextEditor::TextStyle category) const;
+ QTextDocument *textDocument() const;
+
+private:
+ TextEditor::BaseTextEditorWidget *m_editorWidget;
+
+ QTimer m_timer;
+
+ CPlusPlus::Document::Ptr m_document;
+ CPlusPlus::Snapshot m_snapshot;
+
+ QScopedPointer<QFutureWatcher<UseSelectionsResult>> m_findUsesWatcher;
+ int m_findUsesRevision;
+ int m_findUsesCursorPosition;
+};
+
+} // namespace Internal
+} // namespace CppEditor
+
+#endif // CPPUSESELECTIONSUPDATER_H