FindUsages.cpp 14.7 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
**
** 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"
31
#include "Overview.h"
32 33 34 35

#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

#include <QtCore/QDir>
Roberto Raggi's avatar
Roberto Raggi committed
42
#include <QtCore/QDebug>
43 44 45

using namespace CPlusPlus;

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

60 61 62 63 64 65 66 67 68 69 70 71 72
FindUsages::FindUsages(const LookupContext &context)
    : ASTVisitor(context.thisDocument()->translationUnit()),
      _doc(context.thisDocument()),
      _snapshot(context.snapshot()),
      _context(context),
      _source(_doc->source()),
      _sem(_doc->translationUnit()),
      _inSimpleDeclaration(0),
      _inQProperty(false)
{
    typeofExpression.init(_doc, _snapshot, _context.bindings());
}

Roberto Raggi's avatar
Roberto Raggi committed
73 74 75 76 77 78
QList<Usage> FindUsages::usages() const
{ return _usages; }

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

Roberto Raggi's avatar
Roberto Raggi committed
79
void FindUsages::operator()(Symbol *symbol)
80
{
Roberto Raggi's avatar
Roberto Raggi committed
81 82 83 84 85 86 87 88
    if (! symbol)
        return;

    _id = symbol->identifier();

    if (! _id)
        return;

89
    _processed.clear();
90
    _references.clear();
Roberto Raggi's avatar
Roberto Raggi committed
91
    _usages.clear();
Roberto Raggi's avatar
Roberto Raggi committed
92
    _declSymbolFullyQualifiedName = LookupContext::fullyQualifiedName(symbol);
93
    _inSimpleDeclaration = 0;
94
    _inQProperty = false;
Roberto Raggi's avatar
Roberto Raggi committed
95

Roberto Raggi's avatar
Roberto Raggi committed
96 97
    // get the canonical id
    _id = _doc->control()->findOrInsertIdentifier(_id->chars(), _id->size());
Roberto Raggi's avatar
Roberto Raggi committed
98

Roberto Raggi's avatar
Roberto Raggi committed
99
    accept(_doc->translationUnit()->ast());
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
}

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;
}

123 124 125 126 127 128 129 130
Scope *FindUsages::scopeAt(unsigned tokenIndex) const
{
    TranslationUnit *unit = _doc->translationUnit();
    unsigned line, column;
    unit->getTokenPosition(tokenIndex, &line, &column);
    return _doc->scopeAt(line, column);
}

131
void FindUsages::reportResult(unsigned tokenIndex, const QList<LookupItem> &candidates)
132
{
133 134 135
    if (_processed.contains(tokenIndex))
        return;

136 137 138 139 140 141 142 143
    const bool isStrongResult = checkCandidates(candidates);

    if (isStrongResult)
        reportResult(tokenIndex);
}

void FindUsages::reportResult(unsigned tokenIndex)
{
Roberto Raggi's avatar
Roberto Raggi committed
144 145 146 147
    const Token &tk = tokenAt(tokenIndex);
    if (tk.generated())
        return;
    else if (_processed.contains(tokenIndex))
148 149 150 151
        return;

    _processed.insert(tokenIndex);

152 153 154 155 156 157 158 159 160 161
    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;

162
    const Usage u(_doc->fileName(), lineText, line, col, len);
Roberto Raggi's avatar
Roberto Raggi committed
163
    _usages.append(u);
164 165 166
    _references.append(tokenIndex);
}

Roberto Raggi's avatar
Roberto Raggi committed
167 168 169 170 171 172
bool FindUsages::compareFullyQualifiedName(const QList<const Name *> &path, const QList<const Name *> &other)
{
    if (path.length() != other.length())
        return false;

    for (int i = 0; i < path.length(); ++i) {
173
        if (! compareName(path.at(i), other.at(i)))
Roberto Raggi's avatar
Roberto Raggi committed
174 175 176 177 178 179
            return false;
    }

    return true;
}

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
bool FindUsages::compareName(const Name *name, const Name *other)
{
    if (name == other)
        return true;

    else if (name && other) {
        const Identifier *id = name->identifier();
        const Identifier *otherId = other->identifier();

        if (id == otherId || (id && id->isEqualTo(otherId)))
            return true;
    }

    return false;
}


197
bool FindUsages::checkCandidates(const QList<LookupItem> &candidates) const
198
{
Roberto Raggi's avatar
Roberto Raggi committed
199 200 201 202 203
    for (int i = candidates.size() - 1; i != -1; --i) {
        const LookupItem &r = candidates.at(i);

        if (Symbol *s = r.declaration()) {
            if (compareFullyQualifiedName(LookupContext::fullyQualifiedName(s), _declSymbolFullyQualifiedName))
Roberto Raggi's avatar
Roberto Raggi committed
204 205
                return true;
        }
206 207 208 209 210 211 212 213 214 215 216
    }

    return false;
}

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

Roberto Raggi's avatar
Roberto Raggi committed
217 218 219 220 221 222 223 224 225 226
bool FindUsages::visit(NamespaceAST *ast)
{
    const Identifier *id = identifier(ast->identifier_token);
    if (id == _id && ast->symbol) {
        const QList<LookupItem> candidates = _context.lookup(ast->symbol->name(), scopeAt(ast->identifier_token));
        reportResult(ast->identifier_token, candidates);
    }
    return true;
}

227 228 229 230 231 232 233
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) {
234
            const QList<LookupItem> candidates = _context.lookup(simple->name, scopeAt(simple->identifier_token));
235 236 237
            reportResult(simple->identifier_token, candidates);
        }
    }
238
    accept(ast->expression_list);
239 240 241 242 243 244 245 246
    return false;
}

bool FindUsages::visit(MemberAccessAST *ast)
{
    if (ast->member_name) {
        if (SimpleNameAST *simple = ast->member_name->asSimpleName()) {
            if (identifier(simple->identifier_token) == _id) {
247
                checkExpression(ast->firstToken(), simple->identifier_token);
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
                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;

    unsigned line, column;
    getTokenStartPosition(startToken, &line, &column);
266
    Scope *scope = _doc->scopeAt(line, column);
267

268
    const QList<LookupItem> results = typeofExpression(expression, scope,
269
                                                       TypeOfExpression::Preprocess);
270

271
    reportResult(endToken, results);
272 273 274 275
}

bool FindUsages::visit(QualifiedNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
276
    for (NestedNameSpecifierListAST *it = ast->nested_name_specifier_list; it; it = it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
277
        NestedNameSpecifierAST *nested_name_specifier = it->value;
278 279 280 281 282 283 284 285 286

        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
287
                    for (TemplateArgumentListAST *arg_it = template_id->template_argument_list; arg_it; arg_it = arg_it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
288
                        accept(arg_it->value);
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
                    }
                }
            }

            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
320
                for (TemplateArgumentListAST *template_arguments = template_id->template_argument_list;
321
                     template_arguments; template_arguments = template_arguments->next) {
322
                    accept(template_arguments->value);
323 324 325 326 327 328 329 330 331 332 333 334 335
                }
            }
        }

        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
336
    const Identifier *id = identifier(ast->identifier_token);
337
    if (id == _id) {
338
        const QList<LookupItem> candidates = _context.lookup(control()->nameId(id), scopeAt(ast->identifier_token));
339 340 341 342 343 344 345 346 347 348
        reportResult(ast->identifier_token, candidates);
    }

    accept(ast->expression);

    return false;
}

bool FindUsages::visit(SimpleNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
349
    const Identifier *id = identifier(ast->identifier_token);
350
    if (id == _id) {
351
        const QList<LookupItem> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
352 353 354 355 356 357 358 359
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(DestructorNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
360
    const Identifier *id = identifier(ast->identifier_token);
361
    if (id == _id) {
362
        const QList<LookupItem> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
363 364 365 366 367 368 369 370 371
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(TemplateIdAST *ast)
{
    if (_id == identifier(ast->identifier_token)) {
372
        const QList<LookupItem> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
373 374 375
        reportResult(ast->identifier_token, candidates);
    }

Roberto Raggi's avatar
Roberto Raggi committed
376
    for (TemplateArgumentListAST *template_arguments = ast->template_argument_list;
377
         template_arguments; template_arguments = template_arguments->next) {
378
        accept(template_arguments->value);
379 380 381 382 383 384 385
    }

    return false;
}

bool FindUsages::visit(ParameterDeclarationAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
386
    for (SpecifierListAST *it = ast->type_specifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
387
        accept(it->value);
388 389

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

Roberto Raggi's avatar
Roberto Raggi committed
393
        for (PtrOperatorListAST *it = declarator->ptr_operator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
394
            accept(it->value);
395 396 397 398

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

Roberto Raggi's avatar
Roberto Raggi committed
402
        for (SpecifierListAST *it = declarator->post_attribute_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
403
            accept(it->value);
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421

        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
422
    for (SpecifierListAST *it = ast->cv_qualifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
423
        accept(it->value);
424 425 426 427 428 429

    accept(ast->exception_specification);

    return false;
}

430
bool FindUsages::visit(SimpleDeclarationAST *ast)
431
{
432 433 434
    for  (SpecifierListAST *it = ast->decl_specifier_list; it; it = it->next)
        accept(it->value);

435
    ++_inSimpleDeclaration;
436 437 438 439
    for (DeclaratorListAST *it = ast->declarator_list; it; it = it->next)
        accept(it->value);
    --_inSimpleDeclaration;
    return false;
440 441
}

442
bool FindUsages::visit(ObjCSelectorAST *ast)
443
{
Erik Verbruggen's avatar
Erik Verbruggen committed
444 445
    if (ast->name) {
        const Identifier *id = ast->name->identifier();
446
        if (id == _id) {
447
            const QList<LookupItem> candidates = _context.lookup(ast->name, scopeAt(ast->firstToken()));
Erik Verbruggen's avatar
Erik Verbruggen committed
448
            reportResult(ast->firstToken(), candidates);
449 450 451 452 453
        }
    }

    return false;
}
454 455 456 457 458 459 460 461 462

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

void FindUsages::endVisit(QtPropertyDeclarationAST *)
{ _inQProperty = false; }
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

bool FindUsages::visit(TemplateDeclarationAST *ast)
{
    _templateDeclarationStack.append(ast);
    return true;
}

void FindUsages::endVisit(TemplateDeclarationAST *)
{
    _templateDeclarationStack.takeFirst();
}

bool FindUsages::visit(TypenameTypeParameterAST *ast)
{
    if (NameAST *name = ast->name) {
        const Identifier *id = name->name->identifier();
        if (id == _id) {
            unsigned start = startOfTemplateDeclaration(_templateDeclarationStack.back());
481
            const QList<LookupItem> candidates = _context.lookup(name->name, scopeAt(start));
482 483 484 485 486 487 488 489 490 491 492 493 494
            reportResult(ast->name->firstToken(), candidates);
        }
    }
    accept(ast->type_id);
    return false;
}

bool FindUsages::visit(TemplateTypeParameterAST *ast)
{
    if (NameAST *name = ast->name) {
        const Identifier *id = name->name->identifier();
        if (id == _id) {
            unsigned start = startOfTemplateDeclaration(_templateDeclarationStack.back());
495
            const QList<LookupItem> candidates = _context.lookup(name->name, scopeAt(start));
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
            reportResult(ast->name->firstToken(), candidates);
        }
    }
    accept(ast->type_id);
    return false;
}

unsigned FindUsages::startOfTemplateDeclaration(TemplateDeclarationAST *ast) const
{
    if (ast->declaration) {
        if (TemplateDeclarationAST *templ = ast->declaration->asTemplateDeclaration())
            return startOfTemplateDeclaration(templ);

        return ast->declaration->firstToken();
    }

    return ast->firstToken();
}