searchsymbols.cpp 9.85 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 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

#include "searchsymbols.h"

32
#include <cplusplus/LookupContext.h>
33 34
#include <utils/qtcassert.h>
#include <utils/scopedswap.h>
35

Roberto Raggi's avatar
Roberto Raggi committed
36
#include <QDebug>
37 38

using namespace CPlusPlus;
39
using namespace CppTools;
40

41 42 43
typedef Utils::ScopedSwap<ModelItemInfo::Ptr> ScopedModelItemInfoPtr;
typedef Utils::ScopedSwap<QString> ScopedScope;

44
SearchSymbols::SymbolTypes SearchSymbols::AllTypes =
45 46 47 48
        SymbolSearcher::Classes
        | SymbolSearcher::Functions
        | SymbolSearcher::Enums
        | SymbolSearcher::Declarations;
49

50
SearchSymbols::SearchSymbols(CppTools::Internal::StringTable &stringTable)
51 52
    : strings(stringTable)
    , symbolsToSearchFor(SymbolSearcher::Classes | SymbolSearcher::Functions | SymbolSearcher::Enums)
53 54 55
{
}

56
void SearchSymbols::setSymbolsToSearchFor(const SymbolTypes &types)
57
{
58
    symbolsToSearchFor = types;
59 60
}

61
ModelItemInfo::Ptr SearchSymbols::operator()(Document::Ptr doc, int sizeHint, const QString &scope)
62
{
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    ModelItemInfo::Ptr root = ModelItemInfo::create(findOrInsert(doc->fileName()), sizeHint);

    { // RAII scope
        ScopedModelItemInfoPtr parentRaii(_parent, root);
        QString newScope = scope;
        ScopedScope scopeRaii(_scope, newScope);

        QTC_ASSERT(_parent, return ModelItemInfo::Ptr());
        QTC_ASSERT(root, return ModelItemInfo::Ptr());
        QTC_ASSERT(_parent->fileName() == findOrInsert(doc->fileName()),
                   return ModelItemInfo::Ptr());

        for (unsigned i = 0, ei = doc->globalSymbolCount(); i != ei; ++i)
            accept(doc->globalSymbolAt(i));

        strings.scheduleGC();
        m_paths.clear();
80 81
    }

82 83
    root->squeeze();
    return root;
84 85 86 87
}

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

91
    QString name = overview.prettyName(symbol->name());
92 93 94 95 96 97 98 99 100 101
    ModelItemInfo::Ptr newParent =
            addChildItem(name, QString(), _scope, ModelItemInfo::Enum, symbol);
    if (!newParent)
        newParent = _parent;
    ScopedModelItemInfoPtr parentRaii(_parent, newParent);

    QString newScope = scopedSymbolName(name, symbol);
    ScopedScope scopeRaii(_scope, newScope);

    for (unsigned i = 0, ei = symbol->memberCount(); i != ei; ++i)
102
        accept(symbol->memberAt(i));
103

104 105 106 107 108
    return false;
}

bool SearchSymbols::visit(Function *symbol)
{
109
    if (!(symbolsToSearchFor & SymbolSearcher::Functions) || !symbol->name())
110
        return false;
111
    QString name = overview.prettyName(symbol->name());
112
    QString type = overview.prettyType(symbol->type());
113
    addChildItem(name, type, _scope, ModelItemInfo::Function, symbol);
114 115 116 117 118
    return false;
}

bool SearchSymbols::visit(Namespace *symbol)
{
Roberto Raggi's avatar
Roberto Raggi committed
119
    QString name = scopedSymbolName(symbol);
120 121
    QString newScope = name;
    ScopedScope raii(_scope, newScope);
122 123
    for (unsigned i = 0; i < symbol->memberCount(); ++i) {
        accept(symbol->memberAt(i));
124 125 126 127 128 129
    }
    return false;
}

bool SearchSymbols::visit(Declaration *symbol)
{
130
    if (!(symbolsToSearchFor & SymbolSearcher::Declarations)) {
131
        // if we're searching for functions, still allow signal declarations to show up.
132
        if (symbolsToSearchFor & SymbolSearcher::Functions) {
133 134 135 136
            Function *funTy = symbol->type()->asFunctionType();
            if (!funTy)
                return false;
            if (!funTy->isSignal())
137 138 139 140 141
                return false;
        } else {
            return false;
        }
    }
142

143 144 145
    if (symbol->name()) {
        QString name = overview.prettyName(symbol->name());
        QString type = overview.prettyType(symbol->type());
146 147 148 149
        addChildItem(name, type, _scope,
                     symbol->type()->asFunctionType() ? ModelItemInfo::Function
                                                      : ModelItemInfo::Declaration,
                     symbol);
150 151
    }

152 153 154 155 156
    return false;
}

bool SearchSymbols::visit(Class *symbol)
{
157
    QString name = overview.prettyName(symbol->name());
158 159

    ModelItemInfo::Ptr newParent;
Orgad Shaneh's avatar
Orgad Shaneh committed
160
    if (symbolsToSearchFor & SymbolSearcher::Classes)
161 162 163 164 165 166 167 168
        newParent = addChildItem(name, QString(), _scope, ModelItemInfo::Class, symbol);
    if (!newParent)
        newParent = _parent;
    ScopedModelItemInfoPtr parentRaii(_parent, newParent);

    QString newScope = scopedSymbolName(name, symbol);
    ScopedScope scopeRaii(_scope, newScope);
    for (unsigned i = 0, ei = symbol->memberCount(); i != ei; ++i)
169
        accept(symbol->memberAt(i));
170

171 172 173
    return false;
}

Roberto Raggi's avatar
Roberto Raggi committed
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 258
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;
}

259
QString SearchSymbols::scopedSymbolName(const QString &symbolName, const Symbol *symbol) const
260 261
{
    QString name = _scope;
262
    if (!name.isEmpty())
263
        name += QLatin1String("::");
264
    name += scopeName(symbolName, symbol);
265 266 267 268 269
    return name;
}

QString SearchSymbols::scopedSymbolName(const Symbol *symbol) const
{
270
    return scopedSymbolName(overview.prettyName(symbol->name()), symbol);
271 272
}

273
QString SearchSymbols::scopeName(const QString &name, const Symbol *symbol) const
274
{
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    if (!name.isEmpty())
        return name;

    if (symbol->isNamespace()) {
        return QLatin1String("<anonymous namespace>");
    } else if (symbol->isEnum()) {
        return QLatin1String("<anonymous enum>");
    } else if (const Class *c = symbol->asClass())  {
        if (c->isUnion())
            return QLatin1String("<anonymous union>");
        else if (c->isStruct())
            return QLatin1String("<anonymous struct>");
        else
            return QLatin1String("<anonymous class>");
    } else {
        return QLatin1String("<anonymous symbol>");
291
    }
292 293
}

294 295 296 297
ModelItemInfo::Ptr SearchSymbols::addChildItem(const QString &symbolName, const QString &symbolType,
                                               const QString &symbolScope,
                                               ModelItemInfo::ItemType itemType,
                                               Symbol *symbol)
298
{
299
    if (!symbol->name() || symbol->isGenerated())
300
        return ModelItemInfo::Ptr();
301

302 303 304 305 306 307
    QString path = m_paths.value(symbol->fileId(), QString());
    if (path.isEmpty()) {
        path = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
        m_paths.insert(symbol->fileId(), path);
    }

308
    const QIcon icon = icons.iconForSymbol(symbol);
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    ModelItemInfo::Ptr newItem = ModelItemInfo::create(findOrInsert(symbolName),
                                                       findOrInsert(symbolType),
                                                       findOrInsert(symbolScope),
                                                       itemType,
                                                       findOrInsert(path),
                                                       symbol->line(),
                                                       symbol->column() - 1, // 1-based vs 0-based column
                                                       icon);
    _parent->addChild(newItem);
    return newItem;
}

void ModelItemInfo::squeeze()
{
    m_children.squeeze();
    for (int i = 0, ei = m_children.size(); i != ei; ++i)
        m_children[i]->squeeze();
}

void ModelItemInfo::visitAllChildren(std::function<void (const ModelItemInfo::Ptr &)> f) const
{
    foreach (const ModelItemInfo::Ptr &child, m_children) {
        f(child);
        if (!child->m_children.isEmpty())
            child->visitAllChildren(f);
    }
335
}