searchsymbols.cpp 9.09 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 23 24 25
** 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.
**
** 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 32 33

#include "searchsymbols.h"

#include <Literals.h>
#include <Scope.h>
34
#include <Names.h>
35
#include <cplusplus/LookupContext.h>
Roberto Raggi's avatar
Roberto Raggi committed
36
#include <QDebug>
37 38

using namespace CPlusPlus;
39
using namespace CppTools;
40

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

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

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

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

63
QList<ModelItemInfo> SearchSymbols::operator()(Document::Ptr doc, int sizeHint, const QString &scope)
64 65 66
{
    QString previousScope = switchScope(scope);
    items.clear();
67
    items.reserve(sizeHint);
68 69 70 71
    for (unsigned i = 0; i < doc->globalSymbolCount(); ++i) {
        accept(doc->globalSymbolAt(i));
    }
    (void) switchScope(previousScope);
Roberto Raggi's avatar
Roberto Raggi committed
72
    QList<ModelItemInfo> result = items;
73
    strings.clear();
Roberto Raggi's avatar
Roberto Raggi committed
74 75 76
    items.clear();
    m_paths.clear();
    return result;
77 78 79 80 81 82 83 84 85 86 87
}

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

bool SearchSymbols::visit(Enum *symbol)
{
88
    if (!(symbolsToSearchFor & SymbolSearcher::Enums))
89 90 91
        return false;

    QString name = symbolName(symbol);
92 93 94 95 96
    QString scopedName = scopedSymbolName(name);
    QString previousScope = switchScope(scopedName);
    appendItem(separateScope ? name : scopedName,
               separateScope ? previousScope : QString(),
               ModelItemInfo::Enum, symbol);
97 98
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
99 100 101 102 103 104 105
    }
    (void) switchScope(previousScope);
    return false;
}

bool SearchSymbols::visit(Function *symbol)
{
106
    if (!(symbolsToSearchFor & SymbolSearcher::Functions))
107 108
        return false;

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

bool SearchSymbols::visit(Namespace *symbol)
{
Roberto Raggi's avatar
Roberto Raggi committed
132
    QString name = scopedSymbolName(symbol);
133
    QString previousScope = switchScope(name);
134 135
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
136 137 138 139 140 141 142
    }
    (void) switchScope(previousScope);
    return false;
}

bool SearchSymbols::visit(Declaration *symbol)
{
143
    if (!(symbolsToSearchFor & SymbolSearcher::Declarations))
144 145 146 147 148
        return false;

    QString name = symbolName(symbol);
    QString scopedName = scopedSymbolName(name);
    QString type = overview.prettyType(symbol->type(),
149
                                       separateScope ? symbol->unqualifiedName() : 0);
150 151 152
    appendItem(separateScope ? type : scopedName,
               separateScope ? _scope : type,
               ModelItemInfo::Declaration, symbol);
153 154 155 156 157 158
    return false;
}

bool SearchSymbols::visit(Class *symbol)
{
    QString name = symbolName(symbol);
159 160
    QString scopedName = scopedSymbolName(name);
    QString previousScope = switchScope(scopedName);
161
    if (symbolsToSearchFor & SymbolSearcher::Classes) {
162 163 164 165
        appendItem(separateScope ? name : scopedName,
                   separateScope ? previousScope : QString(),
                   ModelItemInfo::Class, symbol);
    }
166 167
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
168 169 170 171 172
    }
    (void) switchScope(previousScope);
    return false;
}

Roberto Raggi's avatar
Roberto Raggi committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
bool SearchSymbols::visit(CPlusPlus::UsingNamespaceDirective *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::UsingDeclaration *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::NamespaceAlias *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::Argument *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::TypenameArgument *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::BaseClass *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::Template *)
{
    return true;
}

bool SearchSymbols::visit(CPlusPlus::Block *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ForwardClassDeclaration *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCBaseClass *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCBaseProtocol *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCClass *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCForwardClassDeclaration *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCProtocol *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCForwardProtocolDeclaration *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCMethod *)
{
    return false;
}

bool SearchSymbols::visit(CPlusPlus::ObjCPropertyDeclaration *)
{
    return false;
}

258
QString SearchSymbols::scopedSymbolName(const QString &symbolName) const
259 260
{
    QString name = _scope;
261
    if (!name.isEmpty())
262
        name += QLatin1String("::");
263 264 265 266 267 268 269 270 271 272 273
    name += symbolName;
    return name;
}

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

QString SearchSymbols::symbolName(const Symbol *symbol) const
{
274 275 276 277 278 279 280 281
    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())  {
282
            if (c->isUnion())
283
                type = QLatin1String("union");
284
            else if (c->isStruct())
285
                type = QLatin1String("struct");
286
            else
287 288 289 290 291 292
                type = QLatin1String("class");
        } else {
            type = QLatin1String("symbol");
        }
        symbolName = QLatin1String("<anonymous ");
        symbolName += type;
293
        symbolName += QLatin1Char('>');
294
    }
295 296 297 298 299 300
    return symbolName;
}

void SearchSymbols::appendItem(const QString &name,
                               const QString &info,
                               ModelItemInfo::ItemType type,
301
                               Symbol *symbol)
302
{
303 304 305
    if (!symbol->name())
        return;

306 307
    QStringList fullyQualifiedName;
    foreach (const Name *name, LookupContext::fullyQualifiedName(symbol))
Roberto Raggi's avatar
Roberto Raggi committed
308
        fullyQualifiedName.append(findOrInsert(overview.prettyName(name)));
309 310 311 312 313 314 315

    QString path = m_paths.value(symbol->fileId(), QString());
    if (path.isEmpty()) {
        path = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
        m_paths.insert(symbol->fileId(), path);
    }

316
    const QIcon icon = icons.iconForSymbol(symbol);
Roberto Raggi's avatar
Roberto Raggi committed
317
    items.append(ModelItemInfo(findOrInsert(name), findOrInsert(info), type,
318
                               fullyQualifiedName,
319
                               path,
320
                               symbol->line(),
321
                               symbol->column() - 1, // 1-based vs 0-based column
322
                               icon));
323
}