From 5e872c0fcd229a540f84f846504e8d874112c8eb Mon Sep 17 00:00:00 2001
From: Ivan Donchevskii <ivan.donchevskii@qt.io>
Date: Tue, 6 Feb 2018 08:19:42 +0100
Subject: [PATCH] Clang: Introduce OverviewModel for clang

Change-Id: I1473e3f679f4345a04c55f1ee80cfe35e21a4347
Reviewed-by: Marco Bubke <marco.bubke@qt.io>
Reviewed-by: hjk <hjk@qt.io>
---
 src/plugins/clangcodemodel/clangcodemodel.pro |   6 +-
 .../clangmodelmanagersupport.cpp              |   6 +-
 .../clangcodemodel/clangoverviewmodel.cpp     | 245 ++++++++++++++++++
 .../clangcodemodel/clangoverviewmodel.h       |  66 +++++
 src/plugins/cpptools/abstractoverviewmodel.h  |   7 +-
 src/plugins/cpptools/cppeditoroutline.cpp     |  15 +-
 6 files changed, 330 insertions(+), 15 deletions(-)
 create mode 100644 src/plugins/clangcodemodel/clangoverviewmodel.cpp
 create mode 100644 src/plugins/clangcodemodel/clangoverviewmodel.h

diff --git a/src/plugins/clangcodemodel/clangcodemodel.pro b/src/plugins/clangcodemodel/clangcodemodel.pro
index 6541f55f3cc..decfacf8bdc 100644
--- a/src/plugins/clangcodemodel/clangcodemodel.pro
+++ b/src/plugins/clangcodemodel/clangcodemodel.pro
@@ -40,7 +40,8 @@ SOURCES += \
     clangrefactoringengine.cpp \
     clangtextmark.cpp \
     clanguiheaderondiskmanager.cpp \
-    clangutils.cpp
+    clangutils.cpp \
+    clangoverviewmodel.cpp
 
 HEADERS += \
     clangactivationsequencecontextprocessor.h \
@@ -79,7 +80,8 @@ HEADERS += \
     clangrefactoringengine.h \
     clangtextmark.h \
     clanguiheaderondiskmanager.h \
-    clangutils.h
+    clangutils.h \
+    clangoverviewmodel.h
 
 FORMS += clangprojectsettingswidget.ui
 
diff --git a/src/plugins/clangcodemodel/clangmodelmanagersupport.cpp b/src/plugins/clangcodemodel/clangmodelmanagersupport.cpp
index 8ce75e5fdc1..ce7505a3dcf 100644
--- a/src/plugins/clangcodemodel/clangmodelmanagersupport.cpp
+++ b/src/plugins/clangcodemodel/clangmodelmanagersupport.cpp
@@ -33,12 +33,10 @@
 #include "clangprojectsettings.h"
 #include "clangrefactoringengine.h"
 #include "clangcurrentdocumentfilter.h"
+#include "clangoverviewmodel.h"
 
 #include <coreplugin/editormanager/editormanager.h>
 
-// TODO: replace with clang based overview model
-#include <cpptools/cppoverviewmodel.h>
-
 #include <cpptools/cppcodemodelsettings.h>
 #include <cpptools/cppfollowsymbolundercursor.h>
 #include <cpptools/cppmodelmanager.h>
@@ -153,7 +151,7 @@ CppTools::RefactoringEngineInterface &ModelManagerSupportClang::refactoringEngin
 
 std::unique_ptr<CppTools::AbstractOverviewModel> ModelManagerSupportClang::createOverviewModel()
 {
-    return std::make_unique<CppTools::OverviewModel>();
+    return std::make_unique<OverviewModel>();
 }
 
 CppTools::BaseEditorDocumentProcessor *ModelManagerSupportClang::createEditorDocumentProcessor(
diff --git a/src/plugins/clangcodemodel/clangoverviewmodel.cpp b/src/plugins/clangcodemodel/clangoverviewmodel.cpp
new file mode 100644
index 00000000000..d9cdebc4398
--- /dev/null
+++ b/src/plugins/clangcodemodel/clangoverviewmodel.cpp
@@ -0,0 +1,245 @@
+/****************************************************************************
+**
+** 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 "clangoverviewmodel.h"
+
+#include "clangeditordocumentprocessor.h"
+#include "clangutils.h"
+
+#include <cplusplus/Icons.h>
+
+#include <utils/dropsupport.h>
+#include <utils/linecolumn.h>
+#include <utils/qtcassert.h>
+
+using TokenContainer = ClangBackEnd::TokenInfoContainer;
+using TokenContainers = QVector<TokenContainer>;
+
+namespace ClangCodeModel {
+namespace Internal {
+
+static bool contains(const ClangBackEnd::SourceRangeContainer &range,
+                     unsigned line,
+                     unsigned column)
+{
+    if (line < range.start().line() || line > range.end().line())
+        return false;
+    if (line == range.start().line() && column < range.start().column())
+        return false;
+    if (line == range.end().line() && column > range.end().column())
+        return false;
+    return true;
+}
+
+static bool contains(const ClangBackEnd::SourceRangeContainer &range,
+                     const ClangBackEnd::SourceLocationContainer &location)
+{
+    return contains(range, location.line(), location.column());
+}
+
+void buildTree(TokenContainers::const_iterator containersBegin,
+               TokenContainers::const_iterator containersEnd,
+               TokenTreeItem *parent, bool isRoot = false)
+{
+    for (auto it = containersBegin; it != containersEnd;) {
+        if (!it->extraInfo().declaration) {
+            ++it;
+            continue;
+        }
+        if (it->types().mainHighlightingType == ClangBackEnd::HighlightingType::LocalVariable) {
+            ++it;
+            continue;
+        }
+
+        auto *item = new TokenTreeItem(*it);
+        parent->appendChild(item);
+        const auto &range = it->extraInfo().cursorRange;
+
+        ++it;
+        auto innerIt = it;
+        for (; innerIt != containersEnd; ++innerIt) {
+            if (!innerIt->extraInfo().declaration)
+                continue;
+            if (innerIt->types().mainHighlightingType
+                    == ClangBackEnd::HighlightingType::LocalVariable) {
+                continue;
+            }
+            const auto &start = innerIt->extraInfo().cursorRange.start();
+            if (!contains(range, start)) {
+                break;
+            }
+        }
+        if (innerIt != it) {
+            buildTree(it, innerIt, item);
+            it = innerIt;
+        }
+    }
+
+    if (isRoot) {
+        ClangBackEnd::ExtraInfo extraInfo;
+        if (!parent->childCount()) {
+            extraInfo.token = Utf8String::fromString(
+                        QString(QT_TRANSLATE_NOOP("ClangCodeModel", "<No Symbols>")));
+        } else {
+            extraInfo.token = Utf8String::fromString(
+                        QString(QT_TRANSLATE_NOOP("ClangCodeModel", "<Select Symbol>")));
+        }
+        ClangBackEnd::HighlightingTypes types;
+        types.mainHighlightingType = ClangBackEnd::HighlightingType::Invalid;
+        TokenContainer firstItem(0, 0, 0, types, extraInfo);
+        parent->prependChild(new TokenTreeItem(firstItem));
+    }
+}
+
+static QString addResultTypeToFunctionSignature(const QString &signature,
+                                                const ClangBackEnd::ExtraInfo &extraInfo)
+{
+    return signature + extraInfo.typeSpelling.toString() + QLatin1String(" -> ", 4)
+            + extraInfo.resultTypeSpelling.toString();
+}
+
+static QString addTypeToVariableName(const QString &name, const ClangBackEnd::ExtraInfo &extraInfo)
+{
+    return name + QLatin1String(" -> ", 4) + extraInfo.typeSpelling.toString();
+}
+
+QVariant TokenTreeItem::data(int column, int role) const
+{
+    Q_UNUSED(column)
+
+    if (token.types().mainHighlightingType == ClangBackEnd::HighlightingType::Invalid
+            && token.line() == 0 && token.column() == 0 && token.length() == 0) {
+        if (role == Qt::DisplayRole)
+            return token.extraInfo().token.toString();
+        return QVariant();
+    }
+
+    switch (role) {
+    case Qt::DisplayRole: {
+        QString name = token.extraInfo().token.toString();
+        ClangBackEnd::HighlightingType mainType = token.types().mainHighlightingType;
+
+        if (mainType == ClangBackEnd::HighlightingType::VirtualFunction
+                    || mainType == ClangBackEnd::HighlightingType::Function) {
+            name = addResultTypeToFunctionSignature(name, token.extraInfo());
+        } else if (mainType == ClangBackEnd::HighlightingType::GlobalVariable
+                   || mainType == ClangBackEnd::HighlightingType::Field
+                   || mainType == ClangBackEnd::HighlightingType::QtProperty) {
+            name = addTypeToVariableName(name, token.extraInfo());
+            if (token.types().mixinHighlightingTypes.contains(
+                                        ClangBackEnd::HighlightingType::ObjectiveCProperty)) {
+                name = QLatin1String("@property ") + name;
+            } else if (token.types().mixinHighlightingTypes.contains(
+                                               ClangBackEnd::HighlightingType::ObjectiveCMethod)) {
+                if (token.extraInfo().storageClass == ClangBackEnd::StorageClass::Static)
+                    name = QLatin1Char('+') + name;
+                else
+                    name = QLatin1Char('-') + name;
+            }
+        } else if (mainType == ClangBackEnd::HighlightingType::Type) {
+
+            if (token.types().mixinHighlightingTypes.contains(
+                        ClangBackEnd::HighlightingType::ObjectiveCClass)) {
+                name = QLatin1String("@class ") + name;
+            } else if (token.types().mixinHighlightingTypes.contains(
+                                               ClangBackEnd::HighlightingType::ObjectiveCProtocol)) {
+                name = QLatin1String("@protocol ") + name;
+            } else if (token.types().mixinHighlightingTypes.contains(
+                                               ClangBackEnd::HighlightingType::ObjectiveCInterface)) {
+                name = QLatin1String("@interface ") + name;
+            } else if (token.types().mixinHighlightingTypes.contains(
+                           ClangBackEnd::HighlightingType::ObjectiveCImplementation)) {
+                name = QLatin1String("@implementation ") + name;
+            } else if (token.types().mixinHighlightingTypes.contains(
+                                               ClangBackEnd::HighlightingType::ObjectiveCCategory)) {
+                name = name + " [category]";
+            }
+        }
+        return name;
+    }
+
+    case Qt::EditRole: {
+        return token.extraInfo().token.toString();
+    }
+
+    case Qt::DecorationRole: {
+        return CPlusPlus::Icons::iconForType(ClangCodeModel::Utils::iconTypeForToken(token));
+    }
+
+    case CppTools::AbstractOverviewModel::FileNameRole: {
+        return token.extraInfo().cursorRange.start().filePath().toString();
+    }
+
+    case CppTools::AbstractOverviewModel::LineNumberRole: {
+        return token.line();
+    }
+
+    default:
+        return QVariant();
+    } // switch
+}
+
+bool OverviewModel::rebuild(const QString &filePath)
+{
+    ClangEditorDocumentProcessor *processor = ClangEditorDocumentProcessor::get(filePath);
+    if (!processor)
+        return false;
+    m_filePath = filePath;
+
+    const TokenContainers &tokenContainers = processor->tokenInfos();
+    auto *root = new TokenTreeItem;
+    buildTree(tokenContainers.begin(), tokenContainers.end(), root, true);
+    setRootItem(root);
+
+    return true;
+}
+
+bool OverviewModel::isGenerated(const QModelIndex &) const
+{
+    return false;
+}
+
+::Utils::Link OverviewModel::linkFromIndex(const QModelIndex &sourceIndex) const
+{
+    TokenTreeItem *item = static_cast<TokenTreeItem *>(itemForIndex(sourceIndex));
+    if (!item)
+        return {};
+    return ::Utils::Link(m_filePath, static_cast<int>(item->token.line()),
+                         static_cast<int>(item->token.column()) - 1);
+}
+
+::Utils::LineColumn OverviewModel::lineColumnFromIndex(const QModelIndex &sourceIndex) const
+{
+    TokenTreeItem *item = static_cast<TokenTreeItem *>(itemForIndex(sourceIndex));
+    if (!item)
+        return {};
+    ::Utils::LineColumn lineColumn;
+    lineColumn.line = static_cast<int>(item->token.line());
+    lineColumn.column = static_cast<int>(item->token.column());
+    return lineColumn;
+}
+
+} // namespace Internal
+} // namespace ClangCodeModel
diff --git a/src/plugins/clangcodemodel/clangoverviewmodel.h b/src/plugins/clangcodemodel/clangoverviewmodel.h
new file mode 100644
index 00000000000..6e41c90c82a
--- /dev/null
+++ b/src/plugins/clangcodemodel/clangoverviewmodel.h
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** 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.
+**
+****************************************************************************/
+
+#pragma once
+
+#include "tokeninfocontainer.h"
+
+#include <cpptools/abstractoverviewmodel.h>
+
+namespace ClangBackEnd { class TokenInfoContainer; }
+
+namespace ClangCodeModel {
+namespace Internal {
+
+class ClangEditorDocumentProcessor;
+
+struct TokenTreeItem : public ::Utils::TypedTreeItem<TokenTreeItem>
+{
+    TokenTreeItem() = default;
+    TokenTreeItem(const ClangBackEnd::TokenInfoContainer &token) noexcept
+        : token(token)
+    {}
+
+    QVariant data(int column, int role) const override;
+
+    ClangBackEnd::TokenInfoContainer token;
+};
+
+class OverviewModel : public CppTools::AbstractOverviewModel
+{
+    Q_OBJECT
+
+public:
+    bool rebuild(const QString &filePath) override;
+
+    bool isGenerated(const QModelIndex &sourceIndex) const override;
+    ::Utils::Link linkFromIndex(const QModelIndex &sourceIndex) const override;
+    ::Utils::LineColumn lineColumnFromIndex(const QModelIndex &sourceIndex) const override;
+private:
+    QString m_filePath;
+};
+
+} // namespace Internal
+} // namespace ClangCodeModel
diff --git a/src/plugins/cpptools/abstractoverviewmodel.h b/src/plugins/cpptools/abstractoverviewmodel.h
index e0110084ed2..08d4777cc4a 100644
--- a/src/plugins/cpptools/abstractoverviewmodel.h
+++ b/src/plugins/cpptools/abstractoverviewmodel.h
@@ -28,8 +28,8 @@
 #include "cpptools_global.h"
 
 #include <utils/dropsupport.h>
+#include <utils/treemodel.h>
 
-#include <QAbstractItemModel>
 #include <QSharedPointer>
 
 namespace CPlusPlus { class Document; }
@@ -41,7 +41,7 @@ struct Link;
 
 namespace CppTools {
 
-class CPPTOOLS_EXPORT AbstractOverviewModel : public QAbstractItemModel
+class CPPTOOLS_EXPORT AbstractOverviewModel : public Utils::TreeModel<>
 {
     Q_OBJECT
 
@@ -51,9 +51,8 @@ public:
         LineNumberRole
     };
 
-    AbstractOverviewModel() : QAbstractItemModel(nullptr) {}
-
     virtual void rebuild(QSharedPointer<CPlusPlus::Document>) {}
+    virtual bool rebuild(const QString &) { return false; }
 
     Qt::ItemFlags flags(const QModelIndex &index) const override
     {
diff --git a/src/plugins/cpptools/cppeditoroutline.cpp b/src/plugins/cpptools/cppeditoroutline.cpp
index e629ea82305..3f92543f719 100644
--- a/src/plugins/cpptools/cppeditoroutline.cpp
+++ b/src/plugins/cpptools/cppeditoroutline.cpp
@@ -186,23 +186,28 @@ QWidget *CppEditorOutline::widget() const
     return m_combo;
 }
 
-void CppEditorOutline::updateNow()
+QSharedPointer<CPlusPlus::Document> getDocument(const QString &filePath)
 {
     CppTools::CppModelManager *cmmi = CppTools::CppModelManager::instance();
     const CPlusPlus::Snapshot snapshot = cmmi->snapshot();
+    return snapshot.document(filePath);
+}
+
+void CppEditorOutline::updateNow()
+{
     const QString filePath = m_editorWidget->textDocument()->filePath().toString();
-    CPlusPlus::Document::Ptr document = snapshot.document(filePath);
-    if (!document)
+    m_document = getDocument(filePath);
+    if (!m_document)
         return;
 
-    m_document = document;
     if (m_document->editorRevision()
             != static_cast<unsigned>(m_editorWidget->document()->revision())) {
         m_updateTimer->start();
         return;
     }
 
-    m_model->rebuild(m_document);
+    if (!m_model->rebuild(filePath))
+        m_model->rebuild(m_document);
 
     m_combo->view()->expandAll();
     updateIndexNow();