Move CanonicalSymbol from CppEditor to CppTools

Needed for a follow-up change.

Change-Id: Ibb4815f3411f0d63deac8c32583178470668f67b
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>

src/plugins/cpptools/cppcanonicalsymbol.cpp

@@ -0,0 +1,131 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 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 "cppcanonicalsymbol.h"
+
+#include <cpptools/cpptoolsreuse.h>
+#include <texteditor/convenience.h>
+
+#include <cplusplus/ExpressionUnderCursor.h>
+
+#include <QTextCursor>
+#include <QTextDocument>
+
+using namespace CPlusPlus;
+
+namespace CppTools {
+
+CanonicalSymbol::CanonicalSymbol(const Document::Ptr &document,
+                                 const Snapshot &snapshot)
+    : m_document(document),
+      m_snapshot(snapshot)
+{
+    m_typeOfExpression.init(document, snapshot);
+    m_typeOfExpression.setExpandTemplates(true);
+}
+
+const LookupContext &CanonicalSymbol::context() const
+{
+    return m_typeOfExpression.context();
+}
+
+Scope *CanonicalSymbol::getScopeAndExpression(const QTextCursor &cursor, QString *code)
+{
+    if (!m_document)
+        return 0;
+
+    QTextCursor tc = cursor;
+    int line, column;
+    TextEditor::Convenience::convertPosition(cursor.document(), tc.position(), &line, &column);
+    ++column; // 1-based line and 1-based column
+
+    int pos = tc.position();
+    QTextDocument *textDocument = cursor.document();
+    if (!CppTools::isValidIdentifierChar(textDocument->characterAt(pos)))
+        if (!(pos > 0 && CppTools::isValidIdentifierChar(textDocument->characterAt(pos - 1))))
+            return 0;
+
+    while (CppTools::isValidIdentifierChar(textDocument->characterAt(pos)))
+        ++pos;
+    tc.setPosition(pos);
+
+    ExpressionUnderCursor expressionUnderCursor(m_document->languageFeatures());
+    *code = expressionUnderCursor(tc);
+    return m_document->scopeAt(line, column);
+}
+
+Symbol *CanonicalSymbol::operator()(const QTextCursor &cursor)
+{
+    QString code;
+
+    if (Scope *scope = getScopeAndExpression(cursor, &code))
+        return operator()(scope, code);
+
+    return 0;
+}
+
+Symbol *CanonicalSymbol::operator()(Scope *scope, const QString &code)
+{
+    return canonicalSymbol(scope, code, m_typeOfExpression);
+}
+
+Symbol *CanonicalSymbol::canonicalSymbol(Scope *scope, const QString &code,
+                                         TypeOfExpression &typeOfExpression)
+{
+    const QList<LookupItem> results =
+            typeOfExpression(code.toUtf8(), scope, TypeOfExpression::Preprocess);
+
+    for (int i = results.size() - 1; i != -1; --i) {
+        const LookupItem &r = results.at(i);
+        Symbol *decl = r.declaration();
+
+        if (!(decl && decl->enclosingScope()))
+            break;
+
+        if (Class *classScope = r.declaration()->enclosingScope()->asClass()) {
+            const Identifier *declId = decl->identifier();
+            const Identifier *classId = classScope->identifier();
+
+            if (classId && classId->match(declId))
+                continue; // skip it, it's a ctor or a dtor.
+
+            if (Function *funTy = r.declaration()->type()->asFunctionType()) {
+                if (funTy->isVirtual())
+                    return r.declaration();
+            }
+        }
+    }
+
+    for (int i = 0; i < results.size(); ++i) {
+        const LookupItem &r = results.at(i);
+
+        if (r.declaration())
+            return r.declaration();
+    }
+
+    return 0;
+}
+
+} // namespace CppEditor

src/plugins/cpptools/cppcanonicalsymbol.h

@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 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 "cpptools_global.h"
+
+#include <cplusplus/LookupContext.h>
+#include <cplusplus/Symbol.h>
+#include <cplusplus/TypeOfExpression.h>
+
+QT_FORWARD_DECLARE_CLASS(QTextCursor)
+
+namespace CppTools {
+
+class CPPTOOLS_EXPORT CanonicalSymbol
+{
+public:
+    CanonicalSymbol(const CPlusPlus::Document::Ptr &document,
+                    const CPlusPlus::Snapshot &snapshot);
+
+    const CPlusPlus::LookupContext &context() const;
+
+    CPlusPlus::Scope *getScopeAndExpression(const QTextCursor &cursor, QString *code);
+
+    CPlusPlus::Symbol *operator()(const QTextCursor &cursor);
+    CPlusPlus::Symbol *operator()(CPlusPlus::Scope *scope, const QString &code);
+
+public:
+    static CPlusPlus::Symbol *canonicalSymbol(CPlusPlus::Scope *scope,
+                                              const QString &code,
+                                              CPlusPlus::TypeOfExpression &typeOfExpression);
+
+private:
+    CPlusPlus::Document::Ptr m_document;
+    CPlusPlus::Snapshot m_snapshot;
+    CPlusPlus::TypeOfExpression m_typeOfExpression;
+};
+
+} // namespace CppTools

src/plugins/cpptools/cpptools.pro

@@ -12,6 +12,7 @@ HEADERS += \
     clangdiagnosticconfig.h \
     clangdiagnosticconfigsmodel.h \
     clangdiagnosticconfigswidget.h \
+    cppcanonicalsymbol.h \
     cppchecksymbols.h \
     cppclassesfilter.h \
     cppcodeformatter.h \
@@ -95,6 +96,7 @@ SOURCES += \
     clangdiagnosticconfig.cpp \
     clangdiagnosticconfigsmodel.cpp \
     clangdiagnosticconfigswidget.cpp \
+    cppcanonicalsymbol.cpp \
     cppchecksymbols.cpp \
     cppclassesfilter.cpp \
     cppcodeformatter.cpp \

src/plugins/cpptools/cpptools.qbs

@@ -51,6 +51,8 @@ Project {
             "clangdiagnosticconfigswidget.ui",
             "compileroptionsbuilder.cpp",
             "compileroptionsbuilder.h",
+            "cppcanonicalsymbol.cpp",
+            "cppcanonicalsymbol.h",
             "cppchecksymbols.cpp",
             "cppchecksymbols.h",
             "cppclassesfilter.cpp",