cppelementevaluator.cpp 16.6 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22
** 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.
23
**
hjk's avatar
hjk committed
24 25
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31

#include "cppelementevaluator.h"

32
#include <cpptools/cpptoolsreuse.h>
33
#include <cpptools/typehierarchybuilder.h>
34

35
#include <cplusplus/ExpressionUnderCursor.h>
36 37
#include <cplusplus/Icons.h>
#include <cplusplus/TypeOfExpression.h>
38

39 40 41 42
#include <QDir>
#include <QFileInfo>
#include <QSet>
#include <QQueue>
43 44 45 46 47 48

using namespace CppEditor;
using namespace Internal;
using namespace CPlusPlus;

namespace {
49 50 51 52 53 54 55 56 57 58 59
    QStringList stripName(const QString &name) {
        QStringList all;
        all << name;
        int colonColon = 0;
        const int size = name.size();
        while ((colonColon = name.indexOf(QLatin1String("::"), colonColon)) != -1) {
            all << name.right(size - colonColon - 2);
            colonColon += 2;
        }
        return all;
    }
60 61
}

62
CppElementEvaluator::CppElementEvaluator(CPPEditorWidget *editor) :
63
    m_editor(editor),
64
    m_modelManager(CppTools::CppModelManagerInterface::instance()),
65
    m_tc(editor->textCursor()),
66 67
    m_lookupBaseClasses(false),
    m_lookupDerivedClasses(false)
68 69 70 71 72 73 74 75
{}

void CppElementEvaluator::setTextCursor(const QTextCursor &tc)
{ m_tc = tc; }

void CppElementEvaluator::setLookupBaseClasses(const bool lookup)
{ m_lookupBaseClasses = lookup; }

76 77 78
void CppElementEvaluator::setLookupDerivedClasses(const bool lookup)
{ m_lookupDerivedClasses = lookup; }

79
// @todo: Consider refactoring code from CPPEditor::findLinkAt into here.
80
void CppElementEvaluator::execute()
81
{
82 83
    clear();

84 85 86 87
    if (!m_modelManager)
        return;

    const Snapshot &snapshot = m_modelManager->snapshot();
88
    Document::Ptr doc = snapshot.document(m_editor->editorDocument()->filePath());
89 90 91 92 93 94 95 96
    if (!doc)
        return;

    int line = 0;
    int column = 0;
    const int pos = m_tc.position();
    m_editor->convertPosition(pos, &line, &column);

97
    checkDiagnosticMessage(pos);
98

99
    if (!matchIncludeFile(doc, line) && !matchMacroInUse(doc, pos)) {
100
        CppTools::moveCursorToEndOfIdentifier(&m_tc);
101

102 103 104 105
        // Fetch the expression's code
        ExpressionUnderCursor expressionUnderCursor;
        const QString &expression = expressionUnderCursor(m_tc);
        Scope *scope = doc->scopeAt(line, column);
106

107 108
        TypeOfExpression typeOfExpression;
        typeOfExpression.init(doc, snapshot);
109 110
        // make possible to instantiate templates
        typeOfExpression.setExpandTemplates(true);
111
        const QList<LookupItem> &lookupItems = typeOfExpression(expression.toUtf8(), scope);
112 113 114 115
        if (lookupItems.isEmpty())
            return;

        const LookupItem &lookupItem = lookupItems.first(); // ### TODO: select best candidate.
116
        handleLookupItemMatch(snapshot, lookupItem, typeOfExpression.context(), scope);
117 118 119
    }
}

120
void CppElementEvaluator::checkDiagnosticMessage(int pos)
121
{
122 123 124 125
    foreach (const QTextEdit::ExtraSelection &sel,
             m_editor->extraSelections(TextEditor::BaseTextEditorWidget::CodeWarningsSelection)) {
        if (pos >= sel.cursor.selectionStart() && pos <= sel.cursor.selectionEnd()) {
            m_diagnosis = sel.format.toolTip();
126
            break;
127 128 129 130 131 132
        }
    }
}

bool CppElementEvaluator::matchIncludeFile(const CPlusPlus::Document::Ptr &document, unsigned line)
{
133
    foreach (const Document::Include &includeFile, document->resolvedIncludes()) {
134 135 136 137 138 139 140 141 142 143 144 145 146
        if (includeFile.line() == line) {
            m_element = QSharedPointer<CppElement>(new CppInclude(includeFile));
            return true;
        }
    }
    return false;
}

bool CppElementEvaluator::matchMacroInUse(const CPlusPlus::Document::Ptr &document, unsigned pos)
{
    foreach (const Document::MacroUse &use, document->macroUses()) {
        if (use.contains(pos)) {
            const unsigned begin = use.begin();
147
            if (pos < begin + use.macro().name().length()) {
148 149 150 151 152 153 154 155 156 157
                m_element = QSharedPointer<CppElement>(new CppMacro(use.macro()));
                return true;
            }
        }
    }
    return false;
}

void CppElementEvaluator::handleLookupItemMatch(const Snapshot &snapshot,
                                                const LookupItem &lookupItem,
158 159
                                                const LookupContext &context,
                                                const Scope *scope)
160 161 162 163
{
    Symbol *declaration = lookupItem.declaration();
    if (!declaration) {
        const QString &type = Overview().prettyType(lookupItem.type(), QString());
164 165 166 167 168
        //  special case for bug QTCREATORBUG-4780
        if (scope && scope->isFunction()
                && lookupItem.type().isEqualTo(scope->asFunction()->returnType())) {
            return;
        }
169 170 171 172 173
        m_element = QSharedPointer<CppElement>(new Unknown(type));
    } else {
        const FullySpecifiedType &type = declaration->type();
        if (declaration->isNamespace()) {
            m_element = QSharedPointer<CppElement>(new CppNamespace(declaration));
174 175 176 177 178
        } else if (declaration->isClass()
                   || declaration->isForwardClassDeclaration()
                   || (declaration->isTemplate() && declaration->asTemplate()->declaration()
                       && (declaration->asTemplate()->declaration()->isClass()
                           || declaration->asTemplate()->declaration()->isForwardClassDeclaration()))) {
179
            LookupContext contextToUse = context;
180
            if (declaration->isForwardClassDeclaration())
181
                if (Symbol *classDeclaration =
182
                        m_symbolFinder.findMatchingClassDeclaration(declaration, snapshot)) {
183
                    declaration = classDeclaration;
184 185 186 187 188
                    const QString fileName = QString::fromUtf8(declaration->fileName(),
                                                               declaration->fileNameLength());
                    const Document::Ptr declarationDocument = snapshot.document(fileName);
                    if (declarationDocument != context.thisDocument())
                        contextToUse = LookupContext(declarationDocument, snapshot);
189
                }
190

191 192
            CppClass *cppClass = new CppClass(declaration);
            if (m_lookupBaseClasses)
193
                cppClass->lookupBases(declaration, contextToUse);
194 195
            if (m_lookupDerivedClasses)
                cppClass->lookupDerived(declaration, snapshot);
196
            m_element = QSharedPointer<CppElement>(cppClass);
197 198 199 200
        } else if (Enum *enumDecl = declaration->asEnum()) {
            m_element = QSharedPointer<CppElement>(new CppEnum(enumDecl));
        } else if (EnumeratorDeclaration *enumerator = dynamic_cast<EnumeratorDeclaration *>(declaration)) {
            m_element = QSharedPointer<CppElement>(new CppEnumerator(enumerator));
201 202
        } else if (declaration->isTypedef()) {
            m_element = QSharedPointer<CppElement>(new CppTypedef(declaration));
203 204 205
        } else if (declaration->isFunction()
                   || (type.isValid() && type->isFunctionType())
                   || declaration->isTemplate()) {
206 207 208 209 210 211 212 213 214 215
            m_element = QSharedPointer<CppElement>(new CppFunction(declaration));
        } else if (declaration->isDeclaration() && type.isValid()) {
            m_element = QSharedPointer<CppElement>(
                new CppVariable(declaration, context, lookupItem.scope()));
        } else {
            m_element = QSharedPointer<CppElement>(new CppDeclarableElement(declaration));
        }
    }
}

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
bool CppElementEvaluator::identifiedCppElement() const
{
    return !m_element.isNull();
}

const QSharedPointer<CppElement> &CppElementEvaluator::cppElement() const
{
    return m_element;
}

bool CppElementEvaluator::hasDiagnosis() const
{
    return !m_diagnosis.isEmpty();
}

const QString &CppElementEvaluator::diagnosis() const
{
    return m_diagnosis;
}

void CppEditor::Internal::CppElementEvaluator::clear()
{
    m_element.clear();
    m_diagnosis.clear();
}

242
// CppElement
243
CppElement::CppElement() : helpCategory(TextEditor::HelpItem::Unknown)
244 245 246 247 248 249
{}

CppElement::~CppElement()
{}

// Unknown
250
Unknown::Unknown(const QString &type) : type(type)
251
{
252
    tooltip = type;
253 254 255 256 257 258
}


// CppInclude

CppInclude::CppInclude(const Document::Include &includeFile) :
259 260
    path(QDir::toNativeSeparators(includeFile.resolvedFileName())),
    fileName(QFileInfo(includeFile.resolvedFileName()).fileName())
261
{
262 263 264 265 266
    helpCategory = TextEditor::HelpItem::Brief;
    helpIdCandidates = QStringList(fileName);
    helpMark = fileName;
    link = CPPEditorWidget::Link(path);
    tooltip = path;
267 268 269
}

// CppMacro
270
CppMacro::CppMacro(const Macro &macro)
271
{
272
    helpCategory = TextEditor::HelpItem::Macro;
273
    const QString macroName = QLatin1String(macro.name());
274 275 276 277
    helpIdCandidates = QStringList(macroName);
    helpMark = macroName;
    link = CPPEditorWidget::Link(macro.fileName(), macro.line());
    tooltip = macro.toStringWithLineBreaks();
278 279 280
}

// CppDeclarableElement
281

282 283 284 285
CppDeclarableElement::CppDeclarableElement(Symbol *declaration)
    : CppElement()
    , declaration(declaration)
    , icon(Icons().iconForSymbol(declaration))
286 287
{
    Overview overview;
288 289
    overview.showArgumentNames = true;
    overview.showReturnTypes = true;
290
    name = overview.prettyName(declaration->name());
291 292 293
    if (declaration->enclosingScope()->isClass() ||
        declaration->enclosingScope()->isNamespace() ||
        declaration->enclosingScope()->isEnum()) {
294 295
        qualifiedName = overview.prettyName(LookupContext::fullyQualifiedName(declaration));
        helpIdCandidates = stripName(qualifiedName);
296
    } else {
297 298
        qualifiedName = name;
        helpIdCandidates.append(name);
299 300
    }

301 302 303
    tooltip = overview.prettyType(declaration->type(), qualifiedName);
    link = CPPEditorWidget::linkToSymbol(declaration);
    helpMark = name;
304 305 306 307 308
}

// CppNamespace
CppNamespace::CppNamespace(Symbol *declaration) : CppDeclarableElement(declaration)
{
309 310
    helpCategory = TextEditor::HelpItem::ClassOrNamespace;
    tooltip = qualifiedName;
311 312 313 314 315
}

// CppClass
CppClass::CppClass(Symbol *declaration) : CppDeclarableElement(declaration)
{
316 317
    helpCategory = TextEditor::HelpItem::ClassOrNamespace;
    tooltip = qualifiedName;
318 319
}

320 321 322 323 324
bool CppClass::operator==(const CppClass &other)
{
    return this->declaration == other.declaration;
}

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
void CppClass::lookupBases(Symbol *declaration, const CPlusPlus::LookupContext &context)
{
    typedef QPair<ClassOrNamespace *, CppClass *> Data;

    if (ClassOrNamespace *clazz = context.lookupType(declaration)) {
        QSet<ClassOrNamespace *> visited;

        QQueue<Data> q;
        q.enqueue(qMakePair(clazz, this));
        while (!q.isEmpty()) {
            Data current = q.dequeue();
            clazz = current.first;
            visited.insert(clazz);
            const QList<ClassOrNamespace *> &bases = clazz->usings();
            foreach (ClassOrNamespace *baseClass, bases) {
                const QList<Symbol *> &symbols = baseClass->symbols();
                foreach (Symbol *symbol, symbols) {
                    if (symbol->isClass() && (
                        clazz = context.lookupType(symbol)) &&
                        !visited.contains(clazz)) {
                        CppClass baseCppClass(symbol);
                        CppClass *cppClass = current.second;
347 348
                        cppClass->bases.append(baseCppClass);
                        q.enqueue(qMakePair(clazz, &cppClass->bases.last()));
349 350 351 352 353 354 355
                    }
                }
            }
        }
    }
}

356 357
void CppClass::lookupDerived(CPlusPlus::Symbol *declaration, const CPlusPlus::Snapshot &snapshot)
{
358
    typedef QPair<CppClass *, CppTools::TypeHierarchy> Data;
359

360 361
    CppTools::TypeHierarchyBuilder builder(declaration, snapshot);
    const CppTools::TypeHierarchy &completeHierarchy = builder.buildDerivedTypeHierarchy();
362 363 364 365 366 367

    QQueue<Data> q;
    q.enqueue(qMakePair(this, completeHierarchy));
    while (!q.isEmpty()) {
        const Data &current = q.dequeue();
        CppClass *clazz = current.first;
368 369
        const CppTools::TypeHierarchy &classHierarchy = current.second;
        foreach (const CppTools::TypeHierarchy &derivedHierarchy, classHierarchy.hierarchy()) {
370 371
            clazz->derived.append(CppClass(derivedHierarchy.symbol()));
            q.enqueue(qMakePair(&clazz->derived.last(), derivedHierarchy));
372 373 374 375
        }
    }
}

376
// CppFunction
377 378
CppFunction::CppFunction(Symbol *declaration)
    : CppDeclarableElement(declaration)
379
{
380
    helpCategory = TextEditor::HelpItem::Function;
381 382 383 384 385 386

    const FullySpecifiedType &type = declaration->type();

    // Functions marks can be found either by the main overload or signature based
    // (with no argument names and no return). Help ids have no signature at all.
    Overview overview;
387
    overview.showDefaultArguments = false;
388
    helpMark = overview.prettyType(type, name);
389

390
    overview.showFunctionSignatures = false;
391
    helpIdCandidates.append(overview.prettyName(declaration->name()));
392 393 394
}

// CppEnum
395 396
CppEnum::CppEnum(Enum *declaration)
    : CppDeclarableElement(declaration)
397
{
398 399
    helpCategory = TextEditor::HelpItem::Enum;
    tooltip = qualifiedName;
400 401 402
}

// CppTypedef
403
CppTypedef::CppTypedef(Symbol *declaration) : CppDeclarableElement(declaration)
404
{
405 406
    helpCategory = TextEditor::HelpItem::Typedef;
    tooltip = Overview().prettyType(declaration->type(), qualifiedName);
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
}

// CppVariable
CppVariable::CppVariable(Symbol *declaration, const LookupContext &context, Scope *scope) :
    CppDeclarableElement(declaration)
{
    const FullySpecifiedType &type = declaration->type();

    const Name *typeName = 0;
    if (type->isNamedType()) {
        typeName = type->asNamedType()->name();
    } else if (type->isPointerType() || type->isReferenceType()) {
        FullySpecifiedType associatedType;
        if (type->isPointerType())
            associatedType = type->asPointerType()->elementType();
        else
            associatedType = type->asReferenceType()->elementType();
        if (associatedType->isNamedType())
            typeName = associatedType->asNamedType()->name();
    }

    if (typeName) {
        if (ClassOrNamespace *clazz = context.lookupType(typeName, scope)) {
            if (!clazz->symbols().isEmpty()) {
                Overview overview;
                Symbol *symbol = clazz->symbols().at(0);
                const QString &name =
                    overview.prettyName(LookupContext::fullyQualifiedName(symbol));
435
                if (!name.isEmpty()) {
436 437
                    tooltip = name;
                    helpCategory = TextEditor::HelpItem::ClassOrNamespace;
438 439
                    const QStringList &allNames = stripName(name);
                    if (!allNames.isEmpty()) {
440 441
                        helpMark = allNames.last();
                        helpIdCandidates = allNames;
442 443
                    }
                }
444 445 446 447 448
            }
        }
    }
}

449 450 451
CppEnumerator::CppEnumerator(CPlusPlus::EnumeratorDeclaration *declaration)
    : CppDeclarableElement(declaration)
{
452
    helpCategory = TextEditor::HelpItem::Enum;
453 454 455 456 457 458 459

    Overview overview;

    Symbol *enumSymbol = declaration->enclosingScope()->asEnum();
    const QString enumName = overview.prettyName(LookupContext::fullyQualifiedName(enumSymbol));
    const QString enumeratorName = overview.prettyName(declaration->name());
    QString enumeratorValue;
460
    if (const StringLiteral *value = declaration->constantValue())
461 462
        enumeratorValue = QString::fromUtf8(value->chars(), value->size());

463
    helpMark = overview.prettyName(enumSymbol->name());
464

465
    tooltip = enumeratorName;
466 467 468 469 470
    if (!enumName.isEmpty())
        tooltip.prepend(enumName + QLatin1Char(' '));
    if (!enumeratorValue.isEmpty())
        tooltip.append(QLatin1String(" = ") + enumeratorValue);
}