searchsymbols.cpp 7.13 KB
Newer Older
1
/**************************************************************************
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
8
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
27
**
28
**************************************************************************/
29 30 31 32 33

#include "searchsymbols.h"

#include <Literals.h>
#include <Scope.h>
34
#include <Names.h>
35
#include <cplusplus/LookupContext.h>
36 37 38 39

using namespace CPlusPlus;
using namespace CppTools::Internal;

40 41 42 43 44 45
SearchSymbols::SymbolTypes SearchSymbols::AllTypes =
        SearchSymbols::Classes
        | SearchSymbols::Functions
        | SearchSymbols::Enums
        | SearchSymbols::Declarations;

46
SearchSymbols::SearchSymbols():
47 48
    symbolsToSearchFor(Classes | Functions | Enums),
    separateScope(false)
49 50 51
{
}

52
void SearchSymbols::setSymbolsToSearchFor(SymbolTypes types)
53
{
54
    symbolsToSearchFor = types;
55 56
}

57 58 59 60 61
void SearchSymbols::setSeparateScope(bool separateScope)
{
    this->separateScope = separateScope;
}

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
QList<ModelItemInfo> SearchSymbols::operator()(Document::Ptr doc, const QString &scope)
{
    QString previousScope = switchScope(scope);
    items.clear();
    for (unsigned i = 0; i < doc->globalSymbolCount(); ++i) {
        accept(doc->globalSymbolAt(i));
    }
    (void) switchScope(previousScope);
    return items;
}

QString SearchSymbols::switchScope(const QString &scope)
{
    QString previousScope = _scope;
    _scope = scope;
    return previousScope;
}

bool SearchSymbols::visit(Enum *symbol)
{
82
    if (!(symbolsToSearchFor & Enums))
83 84 85
        return false;

    QString name = symbolName(symbol);
86 87 88 89 90
    QString scopedName = scopedSymbolName(name);
    QString previousScope = switchScope(scopedName);
    appendItem(separateScope ? name : scopedName,
               separateScope ? previousScope : QString(),
               ModelItemInfo::Enum, symbol);
91 92
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
93 94 95 96 97 98 99
    }
    (void) switchScope(previousScope);
    return false;
}

bool SearchSymbols::visit(Function *symbol)
{
100
    if (!(symbolsToSearchFor & Functions))
101 102
        return false;

103
    QString extraScope;
Roberto Raggi's avatar
Roberto Raggi committed
104
    if (const Name *name = symbol->name()) {
105 106 107
        if (const QualifiedNameId *q = name->asQualifiedNameId()) {
            if (q->base())
                extraScope = overview.prettyName(q->base());
108 109 110 111 112 113
        }
    }
    QString fullScope = _scope;
    if (!_scope.isEmpty() && !extraScope.isEmpty())
        fullScope += QLatin1String("::");
    fullScope += extraScope;
114
    QString name = symbolName(symbol);
115 116
    QString scopedName = scopedSymbolName(name);
    QString type = overview.prettyType(symbol->type(),
117
                                       separateScope ? symbol->unqualifiedName() : 0);
118
    appendItem(separateScope ? type : scopedName,
119
               separateScope ? fullScope : type,
120
               ModelItemInfo::Method, symbol);
121 122 123 124 125
    return false;
}

bool SearchSymbols::visit(Namespace *symbol)
{
126
    QString name = findOrInsert(scopedSymbolName(symbol));
127
    QString previousScope = switchScope(name);
128 129
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
130 131 132 133 134 135 136
    }
    (void) switchScope(previousScope);
    return false;
}

bool SearchSymbols::visit(Declaration *symbol)
{
137 138 139 140 141 142
    if (!(symbolsToSearchFor & Declarations))
        return false;

    QString name = symbolName(symbol);
    QString scopedName = scopedSymbolName(name);
    QString type = overview.prettyType(symbol->type(),
143
                                       separateScope ? symbol->unqualifiedName() : 0);
144 145 146
    appendItem(separateScope ? type : scopedName,
               separateScope ? _scope : type,
               ModelItemInfo::Declaration, symbol);
147 148 149 150 151 152
    return false;
}

bool SearchSymbols::visit(Class *symbol)
{
    QString name = symbolName(symbol);
153 154
    QString scopedName = scopedSymbolName(name);
    QString previousScope = switchScope(scopedName);
155 156 157 158 159
    if (symbolsToSearchFor & Classes) {
        appendItem(separateScope ? name : scopedName,
                   separateScope ? previousScope : QString(),
                   ModelItemInfo::Class, symbol);
    }
160 161
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
162 163 164 165 166
    }
    (void) switchScope(previousScope);
    return false;
}

167
QString SearchSymbols::scopedSymbolName(const QString &symbolName) const
168 169
{
    QString name = _scope;
170
    if (!name.isEmpty())
171
        name += QLatin1String("::");
172 173 174 175 176 177 178 179 180 181 182
    name += symbolName;
    return name;
}

QString SearchSymbols::scopedSymbolName(const Symbol *symbol) const
{
    return scopedSymbolName(symbolName(symbol));
}

QString SearchSymbols::symbolName(const Symbol *symbol) const
{
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    QString symbolName = overview.prettyName(symbol->name());
    if (symbolName.isEmpty()) {
        QString type;
        if (symbol->isNamespace()) {
            type = QLatin1String("namespace");
        } else if (symbol->isEnum()) {
            type = QLatin1String("enum");
        } else if (const Class *c = symbol->asClass())  {
            if (c->isUnion()) {
                type = QLatin1String("union");
            } else if (c->isStruct()) {
                type = QLatin1String("struct");
            } else {
                type = QLatin1String("class");
            }
        } else {
            type = QLatin1String("symbol");
        }
        symbolName = QLatin1String("<anonymous ");
        symbolName += type;
203
        symbolName += QLatin1Char('>');
204
    }
205 206 207 208 209 210
    return symbolName;
}

void SearchSymbols::appendItem(const QString &name,
                               const QString &info,
                               ModelItemInfo::ItemType type,
211
                               Symbol *symbol)
212
{
213 214 215
    if (!symbol->name())
        return;

216 217 218
    QStringList fullyQualifiedName;
    foreach (const Name *name, LookupContext::fullyQualifiedName(symbol))
        fullyQualifiedName.append(overview.prettyName(name));
219 220
    const QIcon icon = icons.iconForSymbol(symbol);
    items.append(ModelItemInfo(name, info, type,
221
                               fullyQualifiedName,
222 223
                               QString::fromUtf8(symbol->fileName(), symbol->fileNameLength()),
                               symbol->line(),
224
                               symbol->column() - 1, // 1-based vs 0-based column
225
                               icon));
226
}