FindUsages.cpp 14.6 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 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
**
** 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>
36
#include <Scope.h>
37 38
#include <Symbols.h>
#include <AST.h>
Roberto Raggi's avatar
Roberto Raggi committed
39
#include <TranslationUnit.h>
40 41 42 43 44

#include <QtCore/QDir>

using namespace CPlusPlus;

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

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

Roberto Raggi's avatar
Roberto Raggi committed
62 63 64 65 66 67
QList<Usage> FindUsages::usages() const
{ return _usages; }

QList<int> FindUsages::references() const
{ return _references; }

Roberto Raggi's avatar
Roberto Raggi committed
68
void FindUsages::operator()(Symbol *symbol)
69
{
70
    _processed.clear();
71
    _references.clear();
Roberto Raggi's avatar
Roberto Raggi committed
72
    _usages.clear();
73
    _declSymbol = symbol;
74
    _inSimpleDeclaration = 0;
75
    _inQProperty = false;
Roberto Raggi's avatar
Roberto Raggi committed
76 77

    _id = 0;
Roberto Raggi's avatar
Roberto Raggi committed
78
    if (_declSymbol && 0 != (_id = _declSymbol->identifier()))
Roberto Raggi's avatar
Roberto Raggi committed
79 80 81
        _id = _doc->control()->findOrInsertIdentifier(_id->chars(), _id->size());

    if (_id) {
Roberto Raggi's avatar
Roberto Raggi committed
82
        _exprDoc = Document::create("<references>");
Roberto Raggi's avatar
Roberto Raggi committed
83
        accept(_doc->translationUnit()->ast());
Roberto Raggi's avatar
Roberto Raggi committed
84
    }
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
}

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)
{
110 111 112
    if (_processed.contains(tokenIndex))
        return;

113 114 115 116 117 118 119 120
    const bool isStrongResult = checkCandidates(candidates);

    if (isStrongResult)
        reportResult(tokenIndex);
}

void FindUsages::reportResult(unsigned tokenIndex)
{
121 122 123 124 125
    if (_processed.contains(tokenIndex))
        return;

    _processed.insert(tokenIndex);

126 127 128 129 130 131 132 133 134 135 136
    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;

137
    const Usage u(_doc->fileName(), lineText, line, col, len);
Roberto Raggi's avatar
Roberto Raggi committed
138
    _usages.append(u);
139 140 141 142 143
    _references.append(tokenIndex);
}

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

#if 0
147
        Symbol *c = candidates.first();
148 149
        qDebug() << "*** canonical symbol:" << canonicalSymbol->fileName()
                << canonicalSymbol->line() << canonicalSymbol->column()
150 151
                << "candidates:" << candidates.size()
                << c->fileName() << c->line() << c->column();
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
#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;
}

204
DeprecatedLookupContext FindUsages::currentContext(AST *ast)
205 206 207 208 209
{
    unsigned line, column;
    getTokenStartPosition(ast->firstToken(), &line, &column);
    Symbol *lastVisibleSymbol = _doc->findSymbolAt(line, column);

210 211 212 213 214 215 216
    if (_inQProperty && lastVisibleSymbol->isClass()) {
        Scope *memberScope = lastVisibleSymbol->asClass()->members();

        if (unsigned count = memberScope->symbolCount())
            lastVisibleSymbol = memberScope->symbolAt(count - 1);
    }

217 218 219
    if (lastVisibleSymbol && lastVisibleSymbol == _previousContext.symbol())
        return _previousContext;

220
    DeprecatedLookupContext ctx(lastVisibleSymbol, _exprDoc, _doc, _snapshot);
221
    _previousContext = ctx;
222
    return _previousContext;
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
}

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) {
238
            DeprecatedLookupContext context = currentContext(ast);
239 240 241 242
            const QList<Symbol *> candidates = context.resolve(simple->name);
            reportResult(simple->identifier_token, candidates);
        }
    }
243
    accept(ast->expression_list);
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 272 273 274 275 276 277 278 279 280 281 282 283 284
    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;
285
    typeofExpression.init(_doc, _snapshot);
286 287 288 289 290

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

291 292
    const QList<LookupItem> results = typeofExpression(expression, lastVisibleSymbol,
                                                       TypeOfExpression::Preprocess);
293 294 295

    QList<Symbol *> candidates;

296 297
    foreach (const LookupItem &r, results) {
        Symbol *lastVisibleSymbol = r.lastVisibleSymbol();
298 299 300 301 302 303 304 305
        candidates.append(lastVisibleSymbol);
    }

    reportResult(endToken, candidates);
}

bool FindUsages::visit(QualifiedNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
306
    for (NestedNameSpecifierListAST *it = ast->nested_name_specifier_list; it; it = it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
307
        NestedNameSpecifierAST *nested_name_specifier = it->value;
308 309 310 311 312 313 314 315 316

        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
317
                    for (TemplateArgumentListAST *arg_it = template_id->template_argument_list; arg_it; arg_it = arg_it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
318
                        accept(arg_it->value);
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
                    }
                }
            }

            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
350
                for (TemplateArgumentListAST *template_arguments = template_id->template_argument_list;
351
                     template_arguments; template_arguments = template_arguments->next) {
352
                    accept(template_arguments->value);
353 354 355 356 357 358 359 360 361 362 363 364 365
                }
            }
        }

        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
366
    const Identifier *id = identifier(ast->identifier_token);
367
    if (id == _id) {
368
        DeprecatedLookupContext context = currentContext(ast);
369 370 371 372 373 374 375 376 377 378 379
        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
380
    const Identifier *id = identifier(ast->identifier_token);
381
    if (id == _id) {
382
        DeprecatedLookupContext context = currentContext(ast);
383 384 385 386 387 388 389 390 391
        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
392
    const Identifier *id = identifier(ast->identifier_token);
393
    if (id == _id) {
394
        DeprecatedLookupContext context = currentContext(ast);
395 396 397 398 399 400 401 402 403 404
        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)) {
405
        DeprecatedLookupContext context = currentContext(ast);
406 407 408 409
        const QList<Symbol *> candidates = context.resolve(ast->name);
        reportResult(ast->identifier_token, candidates);
    }

Roberto Raggi's avatar
Roberto Raggi committed
410
    for (TemplateArgumentListAST *template_arguments = ast->template_argument_list;
411
         template_arguments; template_arguments = template_arguments->next) {
412
        accept(template_arguments->value);
413 414 415 416 417 418 419
    }

    return false;
}

bool FindUsages::visit(ParameterDeclarationAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
420
    for (SpecifierListAST *it = ast->type_specifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
421
        accept(it->value);
422 423

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

Roberto Raggi's avatar
Roberto Raggi committed
427
        for (PtrOperatorListAST *it = declarator->ptr_operator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
428
            accept(it->value);
429 430 431 432

        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
433
        for (PostfixDeclaratorListAST *it = declarator->postfix_declarator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
434
            accept(it->value);
435

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

        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
456
    for (SpecifierListAST *it = ast->cv_qualifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
457
        accept(it->value);
458 459 460 461 462 463

    accept(ast->exception_specification);

    return false;
}

464
bool FindUsages::visit(SimpleDeclarationAST *ast)
465
{
466 467 468
    for  (SpecifierListAST *it = ast->decl_specifier_list; it; it = it->next)
        accept(it->value);

469
    ++_inSimpleDeclaration;
470 471 472 473
    for (DeclaratorListAST *it = ast->declarator_list; it; it = it->next)
        accept(it->value);
    --_inSimpleDeclaration;
    return false;
474 475
}

476
bool FindUsages::visit(ObjCSelectorAST *ast)
477
{
Erik Verbruggen's avatar
Erik Verbruggen committed
478 479
    if (ast->name) {
        const Identifier *id = ast->name->identifier();
480
        if (id == _id) {
481
            DeprecatedLookupContext context = currentContext(ast);
482
            const QList<Symbol *> candidates = context.resolve(ast->name);
Erik Verbruggen's avatar
Erik Verbruggen committed
483
            reportResult(ast->firstToken(), candidates);
484 485 486 487 488
        }
    }

    return false;
}
489 490 491 492 493 494 495 496 497

bool FindUsages::visit(QtPropertyDeclarationAST *)
{
    _inQProperty = true;
    return true;
}

void FindUsages::endVisit(QtPropertyDeclarationAST *)
{ _inQProperty = false; }