FindUsages.cpp 13.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** 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.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "FindUsages.h"
#include "TypeOfExpression.h"

#include <Control.h>
#include <Literals.h>
#include <Names.h>
#include <Symbols.h>
#include <AST.h>

#include <QtCore/QDir>

using namespace CPlusPlus;

FindUsages::FindUsages(Document::Ptr doc, const Snapshot &snapshot, QFutureInterface<Usage> *future)
Roberto Raggi's avatar
Roberto Raggi committed
44
    : ASTVisitor(doc->translationUnit()),
45 46 47 48
      _future(future),
      _doc(doc),
      _snapshot(snapshot),
      _source(_doc->source()),
Roberto Raggi's avatar
Roberto Raggi committed
49
      _sem(doc->translationUnit()),
50 51 52 53 54 55 56 57 58 59
      _inSimpleDeclaration(0)
{
    _snapshot.insert(_doc);
}

void FindUsages::setGlobalNamespaceBinding(NamespaceBindingPtr globalNamespaceBinding)
{
    _globalNamespaceBinding = globalNamespaceBinding;
}

Roberto Raggi's avatar
Roberto Raggi committed
60
QList<int> FindUsages::operator()(Symbol *symbol, const Identifier *id, AST *ast)
61
{
62
    _processed.clear();
63 64 65
    _references.clear();
    _declSymbol = symbol;
    _id = id;
Roberto Raggi's avatar
Roberto Raggi committed
66 67 68 69
    if (_declSymbol && _id) {
        _exprDoc = Document::create("<references>");
        accept(ast);
    }
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
    return _references;
}

QString FindUsages::matchingLine(const Token &tk) const
{
    const char *beg = _source.constData();
    const char *cp = beg + tk.offset;
    for (; cp != beg - 1; --cp) {
        if (*cp == '\n')
            break;
    }

    ++cp;

    const char *lineEnd = cp + 1;
    for (; *lineEnd; ++lineEnd) {
        if (*lineEnd == '\n')
            break;
    }

    const QString matchingLine = QString::fromUtf8(cp, lineEnd - cp);
    return matchingLine;
}

void FindUsages::reportResult(unsigned tokenIndex, const QList<Symbol *> &candidates)
{
96 97 98
    if (_processed.contains(tokenIndex))
        return;

99 100 101 102 103 104 105 106
    const bool isStrongResult = checkCandidates(candidates);

    if (isStrongResult)
        reportResult(tokenIndex);
}

void FindUsages::reportResult(unsigned tokenIndex)
{
107 108 109 110 111
    if (_processed.contains(tokenIndex))
        return;

    _processed.insert(tokenIndex);

112 113 114 115 116 117 118 119 120 121 122 123
    const Token &tk = tokenAt(tokenIndex);
    const QString lineText = matchingLine(tk);

    unsigned line, col;
    getTokenStartPosition(tokenIndex, &line, &col);

    if (col)
        --col;  // adjust the column position.

    const int len = tk.f.length;

    if (_future) {
124
        _future->reportResult(Usage(_doc->fileName(), line, lineText, col, len));
125 126 127 128 129 130 131 132 133 134
    }

    _references.append(tokenIndex);
}

bool FindUsages::checkCandidates(const QList<Symbol *> &candidates) const
{
    if (Symbol *canonicalSymbol = LookupContext::canonicalSymbol(candidates, _globalNamespaceBinding.data())) {

#if 0
135
        Symbol *c = candidates.first();
136 137
        qDebug() << "*** canonical symbol:" << canonicalSymbol->fileName()
                << canonicalSymbol->line() << canonicalSymbol->column()
138 139
                << "candidates:" << candidates.size()
                << c->fileName() << c->line() << c->column();
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 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
#endif

        return checkSymbol(canonicalSymbol);
    }

    return false;
}

bool FindUsages::checkScope(Symbol *symbol, Symbol *otherSymbol) const
{
    if (! (symbol && otherSymbol))
        return false;

    else if (symbol->scope() == otherSymbol->scope())
        return true;

    else if (symbol->name() && otherSymbol->name()) {

        if (! symbol->name()->isEqualTo(otherSymbol->name()))
            return false;

    } else if (symbol->name() != otherSymbol->name()) {
        return false;
    }

    return checkScope(symbol->enclosingSymbol(), otherSymbol->enclosingSymbol());
}

bool FindUsages::checkSymbol(Symbol *symbol) const
{
    if (! symbol) {
        return false;

    } else if (symbol == _declSymbol) {
        return true;

    } else if (symbol->line() == _declSymbol->line() && symbol->column() == _declSymbol->column()) {
        if (! qstrcmp(symbol->fileName(), _declSymbol->fileName()))
            return true;

    } else if (symbol->isForwardClassDeclaration() && (_declSymbol->isClass() ||
                                                       _declSymbol->isForwardClassDeclaration())) {
        return checkScope(symbol, _declSymbol);

    } else if (_declSymbol->isForwardClassDeclaration() && (symbol->isClass() ||
                                                            symbol->isForwardClassDeclaration())) {
        return checkScope(symbol, _declSymbol);
    }

    return false;
}

LookupContext FindUsages::currentContext(AST *ast)
{
    unsigned line, column;
    getTokenStartPosition(ast->firstToken(), &line, &column);
    Symbol *lastVisibleSymbol = _doc->findSymbolAt(line, column);

    if (lastVisibleSymbol && lastVisibleSymbol == _previousContext.symbol())
        return _previousContext;

    LookupContext ctx(lastVisibleSymbol, _exprDoc, _doc, _snapshot);
    _previousContext = ctx;
    return ctx;
}

void FindUsages::ensureNameIsValid(NameAST *ast)
{
    if (ast && ! ast->name)
        ast->name = _sem.check(ast, /*scope = */ 0);
}

bool FindUsages::visit(MemInitializerAST *ast)
{
    if (ast->name && ast->name->asSimpleName() != 0) {
        ensureNameIsValid(ast->name);

        SimpleNameAST *simple = ast->name->asSimpleName();
        if (identifier(simple->identifier_token) == _id) {
            LookupContext context = currentContext(ast);
            const QList<Symbol *> candidates = context.resolve(simple->name);
            reportResult(simple->identifier_token, candidates);
        }
    }
224
    accept(ast->expression_list);
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 259 260 261 262 263 264 265 266 267 268 269 270 271
    return false;
}

bool FindUsages::visit(PostfixExpressionAST *ast)
{
    _postfixExpressionStack.append(ast);
    return true;
}

void FindUsages::endVisit(PostfixExpressionAST *)
{
    _postfixExpressionStack.removeLast();
}

bool FindUsages::visit(MemberAccessAST *ast)
{
    if (ast->member_name) {
        if (SimpleNameAST *simple = ast->member_name->asSimpleName()) {
            if (identifier(simple->identifier_token) == _id) {
                Q_ASSERT(! _postfixExpressionStack.isEmpty());

                checkExpression(_postfixExpressionStack.last()->firstToken(),
                                simple->identifier_token);

                return false;
            }
        }
    }

    return true;
}

void FindUsages::checkExpression(unsigned startToken, unsigned endToken)
{
    const unsigned begin = tokenAt(startToken).begin();
    const unsigned end = tokenAt(endToken).end();

    const QString expression = _source.mid(begin, end - begin);
    // qDebug() << "*** check expression:" << expression;

    TypeOfExpression typeofExpression;
    typeofExpression.setSnapshot(_snapshot);

    unsigned line, column;
    getTokenStartPosition(startToken, &line, &column);
    Symbol *lastVisibleSymbol = _doc->findSymbolAt(line, column);

272 273
    const QList<LookupItem> results = typeofExpression(expression, _doc, lastVisibleSymbol,
                                                   TypeOfExpression::Preprocess);
274 275 276

    QList<Symbol *> candidates;

277 278
    foreach (const LookupItem &r, results) {
        Symbol *lastVisibleSymbol = r.lastVisibleSymbol();
279 280 281 282 283 284 285 286
        candidates.append(lastVisibleSymbol);
    }

    reportResult(endToken, candidates);
}

bool FindUsages::visit(QualifiedNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
287
    for (NestedNameSpecifierListAST *it = ast->nested_name_specifier_list; it; it = it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
288
        NestedNameSpecifierAST *nested_name_specifier = it->value;
289 290 291 292 293 294 295 296 297

        if (NameAST *class_or_namespace_name = nested_name_specifier->class_or_namespace_name) {
            SimpleNameAST *simple_name = class_or_namespace_name->asSimpleName();

            TemplateIdAST *template_id = 0;
            if (! simple_name) {
                template_id = class_or_namespace_name->asTemplateId();

                if (template_id) {
Roberto Raggi's avatar
Roberto Raggi committed
298
                    for (TemplateArgumentListAST *arg_it = template_id->template_argument_list; arg_it; arg_it = arg_it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
299
                        accept(arg_it->value);
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
                    }
                }
            }

            if (simple_name || template_id) {
                const unsigned identifier_token = simple_name
                           ? simple_name->identifier_token
                           : template_id->identifier_token;

                if (identifier(identifier_token) == _id)
                    checkExpression(ast->firstToken(), identifier_token);
            }
        }
    }

    if (NameAST *unqualified_name = ast->unqualified_name) {
        unsigned identifier_token = 0;

        if (SimpleNameAST *simple_name = unqualified_name->asSimpleName())
            identifier_token = simple_name->identifier_token;

        else if (DestructorNameAST *dtor_name = unqualified_name->asDestructorName())
            identifier_token = dtor_name->identifier_token;

        TemplateIdAST *template_id = 0;
        if (! identifier_token) {
            template_id = unqualified_name->asTemplateId();

            if (template_id) {
                identifier_token = template_id->identifier_token;

Roberto Raggi's avatar
Roberto Raggi committed
331
                for (TemplateArgumentListAST *template_arguments = template_id->template_argument_list;
332
                     template_arguments; template_arguments = template_arguments->next) {
333
                    accept(template_arguments->value);
334 335 336 337 338 339 340 341 342 343 344 345 346
                }
            }
        }

        if (identifier_token && identifier(identifier_token) == _id)
            checkExpression(ast->firstToken(), identifier_token);
    }

    return false;
}

bool FindUsages::visit(EnumeratorAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
347
    const Identifier *id = identifier(ast->identifier_token);
348 349 350 351 352 353 354 355 356 357 358 359 360
    if (id == _id) {
        LookupContext context = currentContext(ast);
        const QList<Symbol *> candidates = context.resolve(control()->nameId(id));
        reportResult(ast->identifier_token, candidates);
    }

    accept(ast->expression);

    return false;
}

bool FindUsages::visit(SimpleNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
361
    const Identifier *id = identifier(ast->identifier_token);
362 363 364 365 366 367 368 369 370 371 372
    if (id == _id) {
        LookupContext context = currentContext(ast);
        const QList<Symbol *> candidates = context.resolve(ast->name);
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(DestructorNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
373
    const Identifier *id = identifier(ast->identifier_token);
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    if (id == _id) {
        LookupContext context = currentContext(ast);
        const QList<Symbol *> candidates = context.resolve(ast->name);
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(TemplateIdAST *ast)
{
    if (_id == identifier(ast->identifier_token)) {
        LookupContext context = currentContext(ast);
        const QList<Symbol *> candidates = context.resolve(ast->name);
        reportResult(ast->identifier_token, candidates);
    }

Roberto Raggi's avatar
Roberto Raggi committed
391
    for (TemplateArgumentListAST *template_arguments = ast->template_argument_list;
392
         template_arguments; template_arguments = template_arguments->next) {
393
        accept(template_arguments->value);
394 395 396 397 398 399 400
    }

    return false;
}

bool FindUsages::visit(ParameterDeclarationAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
401
    for (SpecifierListAST *it = ast->type_specifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
402
        accept(it->value);
403 404

    if (DeclaratorAST *declarator = ast->declarator) {
Roberto Raggi's avatar
Roberto Raggi committed
405
        for (SpecifierListAST *it = declarator->attribute_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
406
            accept(it->value);
407

Roberto Raggi's avatar
Roberto Raggi committed
408
        for (PtrOperatorListAST *it = declarator->ptr_operator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
409
            accept(it->value);
410 411 412 413

        if (! _inSimpleDeclaration) // visit the core declarator only if we are not in simple-declaration.
            accept(declarator->core_declarator);

Roberto Raggi's avatar
Roberto Raggi committed
414
        for (PostfixDeclaratorListAST *it = declarator->postfix_declarator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
415
            accept(it->value);
416

Roberto Raggi's avatar
Roberto Raggi committed
417
        for (SpecifierListAST *it = declarator->post_attribute_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
418
            accept(it->value);
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

        accept(declarator->initializer);
    }

    accept(ast->expression);
    return false;
}

bool FindUsages::visit(ExpressionOrDeclarationStatementAST *ast)
{
    accept(ast->declaration);
    return false;
}

bool FindUsages::visit(FunctionDeclaratorAST *ast)
{
    accept(ast->parameters);

Roberto Raggi's avatar
Roberto Raggi committed
437
    for (SpecifierListAST *it = ast->cv_qualifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
438
        accept(it->value);
439 440 441 442 443 444 445 446 447 448 449 450 451 452

    accept(ast->exception_specification);

    return false;
}

bool FindUsages::visit(SimpleDeclarationAST *)
{
    ++_inSimpleDeclaration;
    return true;
}

void FindUsages::endVisit(SimpleDeclarationAST *)
{ --_inSimpleDeclaration; }