C++: Moved completion/highlighting into the model manager.

This way the editor does not need to know all the details of
instantiating or maintaining classes for highlighting and/or completion,
it can just ask the model manager. The change also enables different
highlighting- or completion-engines without changes to the cppeditor.

Change-Id: I8000d9d9fe446b292defddb2295493cf77d0f14a
Reviewed-by: Leandro Melo <leandro.melo@nokia.com>

src/libs/cplusplus/ModelManagerInterface.h

@@ -55,6 +55,8 @@ namespace ProjectExplorer {
 
 namespace CppTools {
     class AbstractEditorSupport;
+    class CppCompletionSupport;
+    class CppHighlightingSupport;
 }
 
 namespace CPlusPlus {
@@ -151,6 +153,9 @@ public:
     virtual QList<CPlusPlus::Document::DiagnosticMessage> extraDiagnostics(
             const QString &fileName, int key = AllExtraDiagnostics) const = 0;
 
+    virtual CppTools::CppCompletionSupport *completionSupport(Core::IEditor *editor) const = 0;
+    virtual CppTools::CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const = 0;
+
 Q_SIGNALS:
     void documentUpdated(CPlusPlus::Document::Ptr doc);
     void sourceFilesRefreshed(const QStringList &files);

src/plugins/cppeditor/cppeditor.cpp

@@ -34,8 +34,6 @@
 #include "cppeditorconstants.h"
 #include "cppplugin.h"
 #include "cpphighlighter.h"
-#include "cppchecksymbols.h"
-#include "cpplocalsymbols.h"
 #include "cppautocompleter.h"
 #include "cppquickfixassistant.h"
 
@@ -63,8 +61,11 @@
 
 #include <cpptools/cpptoolsplugin.h>
 #include <cpptools/cpptoolsconstants.h>
+#include <cpptools/cppchecksymbols.h>
 #include <cpptools/cppcodeformatter.h>
-#include <cpptools/cppcompletionassist.h>
+#include <cpptools/cppcompletionsupport.h>
+#include <cpptools/cpphighlightingsupport.h>
+#include <cpptools/cpplocalsymbols.h>
 #include <cpptools/cppqtstyleindenter.h>
 #include <cpptools/cppcodestylesettings.h>
 #include <cpptools/cpprefactoringchanges.h>
@@ -124,6 +125,7 @@ enum {
 };
 
 using namespace CPlusPlus;
+using namespace CppTools;
 using namespace CppEditor::Internal;
 
 namespace {
@@ -424,7 +426,7 @@ CPPEditorWidget::CPPEditorWidget(QWidget *parent)
     , m_commentsSettings(CppTools::CppToolsSettings::instance()->commentsSettings())
 {
     m_initialized = false;
-    qRegisterMetaType<CppEditor::Internal::SemanticInfo>("CppEditor::Internal::SemanticInfo");
+    qRegisterMetaType<SemanticInfo>("CppTools::SemanticInfo");
 
     m_semanticHighlighter = new SemanticHighlighter(this);
     m_semanticHighlighter->start();
@@ -552,8 +554,8 @@ void CPPEditorWidget::createToolBar(CPPEditor *editor)
     connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateUses()));
     connect(this, SIGNAL(textChanged()), this, SLOT(updateUses()));
 
-    connect(m_semanticHighlighter, SIGNAL(changed(CppEditor::Internal::SemanticInfo)),
-            this, SLOT(updateSemanticInfo(CppEditor::Internal::SemanticInfo)));
+    connect(m_semanticHighlighter, SIGNAL(changed(CppTools::SemanticInfo)),
+            this, SLOT(updateSemanticInfo(CppTools::SemanticInfo)));
 
     editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
 }
@@ -1849,11 +1851,11 @@ void CPPEditorWidget::updateSemanticInfo(const SemanticInfo &semanticInfo)
 
         if (! semanticHighlighterDisabled && semanticInfo.doc) {
             if (Core::EditorManager::instance()->currentEditor() == editor()) {
-                LookupContext context(semanticInfo.doc, semanticInfo.snapshot);
-                CheckSymbols::Future f = CheckSymbols::go(semanticInfo.doc, context);
-                m_highlighter = f;
-                m_highlightRevision = semanticInfo.revision;
-                m_highlightWatcher.setFuture(m_highlighter);
+                if (CppTools::CppHighlightingSupport *hs = modelManager()->highlightingSupport(editor())) {
+                    m_highlighter = hs->highlightingFuture(semanticInfo.doc, semanticInfo.snapshot);
+                    m_highlightRevision = semanticInfo.revision;
+                    m_highlightWatcher.setFuture(m_highlighter);
+                }
             }
         }
 
@@ -2154,21 +2156,9 @@ TextEditor::IAssistInterface *CPPEditorWidget::createAssistInterface(
     TextEditor::AssistReason reason) const
 {
     if (kind == TextEditor::Completion) {
-        QStringList includePaths;
-        QStringList frameworkPaths;
-        if (ProjectExplorer::Project *project =
-                ProjectExplorer::ProjectExplorerPlugin::currentProject()) {
-            includePaths = m_modelManager->projectInfo(project).includePaths;
-            frameworkPaths = m_modelManager->projectInfo(project).frameworkPaths;
-        }
-        return new CppTools::Internal::CppCompletionAssistInterface(
-                    document(),
-                    position(),
-                    editor()->file(),
-                    reason,
-                    m_modelManager->snapshot(),
-                    includePaths,
-                    frameworkPaths);
+        if (CppTools::CppCompletionSupport *cs = m_modelManager->completionSupport(editor()))
+            return cs->createAssistInterface(ProjectExplorer::ProjectExplorerPlugin::currentProject(),
+                                             document(), position(), reason);
     } else if (kind == TextEditor::QuickFix) {
         if (!semanticInfo().doc || isOutdated())
             return 0;

src/plugins/cppeditor/cppeditor.h

@@ -34,7 +34,6 @@
 #define CPPEDITOR_H
 
 #include "cppeditorenums.h"
-#include "cppsemanticinfo.h"
 #include "cppfunctiondecldeflink.h"
 
 #include <cplusplus/ModelManagerInterface.h>
@@ -43,6 +42,7 @@
 #include <texteditor/basetexteditor.h>
 #include <texteditor/quickfix.h>
 #include <cpptools/commentssettings.h>
+#include <cpptools/cppsemanticinfo.h>
 
 #include <QtCore/QThread>
 #include <QtCore/QMutex>
@@ -124,12 +124,12 @@ public:
         }
     };
 
-    SemanticInfo semanticInfo(const Source &source);
+    CppTools::SemanticInfo semanticInfo(const Source &source);
 
     void rehighlight(const Source &source);
 
 Q_SIGNALS:
-    void changed(const CppEditor::Internal::SemanticInfo &semanticInfo);
+    void changed(const CppTools::SemanticInfo &semanticInfo);
 
 protected:
     virtual void run();
@@ -142,7 +142,7 @@ private:
     QWaitCondition m_condition;
     bool m_done;
     Source m_source;
-    SemanticInfo m_lastSemanticInfo;
+    CppTools::SemanticInfo m_lastSemanticInfo;
 };
 
 class CPPEditor : public TextEditor::BaseTextEditor
@@ -172,7 +172,7 @@ public:
 
     unsigned editorRevision() const;
     bool isOutdated() const;
-    SemanticInfo semanticInfo() const;
+    CppTools::SemanticInfo semanticInfo() const;
 
     CPlusPlus::OverviewModel *outlineModel() const;
     QModelIndex outlineModelIndex();
@@ -242,7 +242,7 @@ private Q_SLOTS:
     void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
     void onContentsChanged(int position, int charsRemoved, int charsAdded);
 
-    void updateSemanticInfo(const CppEditor::Internal::SemanticInfo &semanticInfo);
+    void updateSemanticInfo(const CppTools::SemanticInfo &semanticInfo);
     void highlightSymbolUsages(int from, int to);
     void finishHighlightSymbolUsages();
 
@@ -255,7 +255,7 @@ private Q_SLOTS:
     void onCommentsSettingsChanged(const CppTools::CommentsSettings &settings);
 
 private:
-    void markSymbols(const QTextCursor &tc, const SemanticInfo &info);
+    void markSymbols(const QTextCursor &tc, const CppTools::SemanticInfo &info);
     bool sortedOutline() const;
     CPlusPlus::Symbol *findDefinition(CPlusPlus::Symbol *symbol, const CPlusPlus::Snapshot &snapshot) const;
 
@@ -264,8 +264,8 @@ private:
 
     SemanticHighlighter::Source currentSource(bool force = false);
 
-    void highlightUses(const QList<SemanticInfo::Use> &uses,
-                       const SemanticInfo &semanticInfo,
+    void highlightUses(const QList<TextEditor::SemanticHighlighter::Result> &uses,
+                       const CppTools::SemanticInfo &semanticInfo,
                        QList<QTextEdit::ExtraSelection> *selections);
 
     void createToolBar(CPPEditor *editable);
@@ -315,13 +315,13 @@ private:
     QTextCursor m_currentRenameSelectionEnd;
 
     SemanticHighlighter *m_semanticHighlighter;
-    SemanticInfo m_lastSemanticInfo;
+    CppTools::SemanticInfo m_lastSemanticInfo;
     QList<TextEditor::QuickFixOperation::Ptr> m_quickFixes;
     bool m_objcEnabled;
     bool m_initialized;
 
-    QFuture<SemanticInfo::Use> m_highlighter;
-    QFutureWatcher<SemanticInfo::Use> m_highlightWatcher;
+    QFuture<TextEditor::SemanticHighlighter::Result> m_highlighter;
+    QFutureWatcher<TextEditor::SemanticHighlighter::Result> m_highlightWatcher;
     unsigned m_highlightRevision; // the editor revision that requested the highlight
 
     QFuture<QList<int> > m_references;

src/plugins/cppeditor/cppeditor.pro

@@ -14,11 +14,8 @@ HEADERS += cppplugin.h \
     cppeditorenums.h \
     cppeditor_global.h \
     cppclasswizard.h \
-    cppchecksymbols.h \
-    cppsemanticinfo.h \
     cppoutline.h \
     cppinsertdecldef.h \
-    cpplocalsymbols.h \
     cpptypehierarchy.h \
     cppelementevaluator.h \
     cppautocompleter.h \
@@ -36,11 +33,8 @@ SOURCES += cppplugin.cpp \
     cppfilewizard.cpp \
     cppclasswizard.cpp \
     cppquickfixes.cpp \
-    cppchecksymbols.cpp \
-    cppsemanticinfo.cpp \
     cppoutline.cpp \
     cppinsertdecldef.cpp \
-    cpplocalsymbols.cpp \
     cpptypehierarchy.cpp \
     cppelementevaluator.cpp \
     cppautocompleter.cpp \

src/plugins/cppeditor/cppfunctiondecldeflink.cpp

@@ -34,7 +34,6 @@
 
 #include "cppeditor.h"
 #include "cppquickfixassistant.h"
-#include "cpplocalsymbols.h"
 
 #include <cplusplus/CppRewriter.h>
 #include <cplusplus/ASTPath.h>
@@ -44,6 +43,7 @@
 #include <cplusplus/TranslationUnit.h>
 #include <cplusplus/LookupContext.h>
 #include <cplusplus/Overview.h>
+#include <cpptools/cpplocalsymbols.h>
 #include <cpptools/cpprefactoringchanges.h>
 #include <cpptools/symbolfinder.h>
 #include <texteditor/refactoroverlay.h>
@@ -61,6 +61,7 @@
 using namespace CPlusPlus;
 using namespace CppEditor;
 using namespace CppEditor::Internal;
+using namespace CppTools;
 
 FunctionDeclDefLinkFinder::FunctionDeclDefLinkFinder(QObject *parent)
     : QObject(parent)

src/plugins/cppeditor/cppquickfixassistant.h

@@ -33,7 +33,7 @@
 #ifndef CPPQUICKFIXASSISTANT_H
 #define CPPQUICKFIXASSISTANT_H
 
-#include "cppsemanticinfo.h"
+#include <cpptools/cppsemanticinfo.h>
 
 #include <ASTfwd.h>
 #include <cplusplus/CppDocument.h>
@@ -59,7 +59,7 @@ public:
 
     const QList<CPlusPlus::AST *> &path() const;
     CPlusPlus::Snapshot snapshot() const;
-    CppEditor::Internal::SemanticInfo semanticInfo() const;
+    CppTools::SemanticInfo semanticInfo() const;
     const CPlusPlus::LookupContext &context() const;
     CPPEditorWidget *editor() const;
 
@@ -70,7 +70,7 @@ public:
 
 private:
     CPPEditorWidget *m_editor;
-    CppEditor::Internal::SemanticInfo m_semanticInfo;
+    CppTools::SemanticInfo m_semanticInfo;
     CPlusPlus::Snapshot m_snapshot;
     CppTools::CppRefactoringFilePtr m_currentFile;
     CPlusPlus::LookupContext m_context;

src/plugins/cppeditor/cppchecksymbols.cpp → src/plugins/cpptools/cppchecksymbols.cpp

@@ -52,7 +52,7 @@
 #include <qtconcurrent/runextensions.h>
 
 using namespace CPlusPlus;
-using namespace CppEditor::Internal;
+using namespace CppTools;
 
 namespace {
 

src/plugins/cppeditor/cppchecksymbols.h → src/plugins/cpptools/cppchecksymbols.h

@@ -39,6 +39,8 @@
 #include <cplusplus/LookupContext.h>
 #include <cplusplus/TypeOfExpression.h>
 
+#include <texteditor/semantichighlighter.h>
+
 #include <ASTVisitor.h>
 #include <QtCore/QSet>
 #include <QtCore/QFuture>
@@ -49,13 +51,13 @@ namespace CPlusPlus {
 class CheckSymbols:
         protected ASTVisitor,
         public QRunnable,
-        public QFutureInterface<CppEditor::Internal::SemanticInfo::Use>
+        public QFutureInterface<TextEditor::SemanticHighlighter::Result>
 {
 public:
     virtual ~CheckSymbols();
 
-    typedef CppEditor::Internal::SemanticInfo::Use Use;
-    typedef CppEditor::Internal::SemanticInfo::UseKind UseKind;
+    typedef TextEditor::SemanticHighlighter::Result Use;
+    typedef CppTools::SemanticInfo::UseKind UseKind;
 
     virtual void run();
 

src/plugins/cpptools/cppcompletionsupport.cpp

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#include "cppcompletionassist.h"
+#include "cppcompletionsupport.h"
+#include "cppmodelmanager.h"
+#include "cpptoolseditorsupport.h"
+
+#include <coreplugin/ifile.h>
+#include <projectexplorer/project.h>
+#include <texteditor/codeassist/iassistinterface.h>
+
+using namespace CPlusPlus;
+using namespace CppTools;
+using namespace CppTools::Internal;
+
+CppCompletionSupport::CppCompletionSupport(CppEditorSupport *editorSupport)
+    : m_editorSupport(editorSupport)
+{
+    Q_ASSERT(editorSupport);
+}
+
+TextEditor::IAssistInterface *CppCompletionSupport::createAssistInterface(ProjectExplorer::Project *project,
+                                                                          QTextDocument *document,
+                                                                          int position,
+                                                                          TextEditor::AssistReason reason) const
+{
+    CppModelManagerInterface *modelManager = CppModelManagerInterface::instance();
+    QStringList includePaths;
+    QStringList frameworkPaths;
+    if (project) {
+        includePaths = modelManager->projectInfo(project).includePaths;
+        frameworkPaths = modelManager->projectInfo(project).frameworkPaths;
+    }
+    return new CppTools::Internal::CppCompletionAssistInterface(
+                document,
+                position,
+                m_editorSupport->textEditor()->file(),
+                reason,
+                modelManager->snapshot(),
+                includePaths,
+                frameworkPaths);
+}

src/plugins/cpptools/cppcompletionsupport.h

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#ifndef CPPTOOLS_CPPCOMPLETIONSUPPORT_H
+#define CPPTOOLS_CPPCOMPLETIONSUPPORT_H
+
+#include "cpptools_global.h"
+
+#include <texteditor/codeassist/assistenums.h>
+
+QT_BEGIN_NAMESPACE
+class QTextDocument;
+QT_END_NAMESPACE
+
+namespace Core {
+class IFile;
+}
+
+namespace ProjectExplorer {
+class Project;
+}
+
+namespace TextEditor {
+class IAssistInterface;
+}
+
+namespace CppTools {
+namespace Internal {
+class CppEditorSupport;
+}
+
+class CPPTOOLS_EXPORT CppCompletionSupport
+{
+public:
+    CppCompletionSupport(Internal::CppEditorSupport *editorSupport);
+
+    TextEditor::IAssistInterface *createAssistInterface(ProjectExplorer::Project *project,
+                                                        QTextDocument *document,
+                                                        int position,
+                                                        TextEditor::AssistReason reason) const;
+
+private:
+    Internal::CppEditorSupport *m_editorSupport;
+};
+
+} // namespace CppTools
+
+#endif // CPPTOOLS_CPPCOMPLETIONSUPPORT_H

src/plugins/cpptools/cpphighlightingsupport.cpp

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#include "cppchecksymbols.h"
+#include "cpphighlightingsupport.h"
+#include "cpptoolseditorsupport.h"
+
+#include <cplusplus/LookupContext.h>
+
+using namespace CPlusPlus;
+using namespace CppTools;
+using namespace CppTools::Internal;
+
+CppHighlightingSupport::CppHighlightingSupport()
+{
+}
+
+QFuture<CppHighlightingSupport::Use> CppHighlightingSupport::highlightingFuture(
+        const Document::Ptr &doc, const Snapshot &snapshot) const
+{
+    LookupContext context(doc, snapshot);
+    return CheckSymbols::go(doc, context);
+}

src/plugins/cpptools/cpphighlightingsupport.h

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#ifndef CPPTOOLS_CPPHIGHLIGHTINGSUPPORT_H
+#define CPPTOOLS_CPPHIGHLIGHTINGSUPPORT_H
+
+#include "cpptools_global.h"
+
+#include <cplusplus/CppDocument.h>
+#include <texteditor/semantichighlighter.h>
+
+#include <QtCore/QFuture>
+
+namespace CppTools {
+namespace Internal {
+class CppEditorSupport;
+}
+
+class CPPTOOLS_EXPORT CppHighlightingSupport
+{
+public:
+    typedef TextEditor::SemanticHighlighter::Result Use;
+
+public:
+    CppHighlightingSupport();
+
+    QFuture<Use> highlightingFuture(const CPlusPlus::Document::Ptr &doc,
+                                    const CPlusPlus::Snapshot &snapshot) const;
+};
+
+} // namespace CppTools
+
+#endif // CPPTOOLS_CPPHIGHLIGHTINGSUPPORT_H

src/plugins/cppeditor/cpplocalsymbols.cpp → src/plugins/cpptools/cpplocalsymbols.cpp

@@ -43,7 +43,7 @@
 #include <Literals.h>
 
 using namespace CPlusPlus;
-using namespace CppEditor::Internal;
+using namespace CppTools;
 
 namespace {
 

src/plugins/cppeditor/cpplocalsymbols.h → src/plugins/cpptools/cpplocalsymbols.h

@@ -33,14 +33,15 @@
 #ifndef CPPLOCALSYMBOLS_H
 #define CPPLOCALSYMBOLS_H
 
+#include "cpptools_global.h"
 #include "cppsemanticinfo.h"
+
 #include <cplusplus/CppDocument.h>
 #include <ASTfwd.h>
 
-namespace CppEditor {
-namespace Internal {
+namespace CppTools {
 
-class LocalSymbols
+class CPPTOOLS_EXPORT LocalSymbols
 {
     Q_DISABLE_COPY(LocalSymbols)