FindUsages.cpp 13.8 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
{
81
    _processed.clear();
82
    _references.clear();
Roberto Raggi's avatar
Roberto Raggi committed
83
    _usages.clear();
84
    _declSymbol = symbol;
85
    _inSimpleDeclaration = 0;
86
    _inQProperty = false;
Roberto Raggi's avatar
Roberto Raggi committed
87 88

    _id = 0;
Roberto Raggi's avatar
Roberto Raggi committed
89
    if (_declSymbol && 0 != (_id = _declSymbol->identifier()))
Roberto Raggi's avatar
Roberto Raggi committed
90 91 92
        _id = _doc->control()->findOrInsertIdentifier(_id->chars(), _id->size());

    if (_id) {
Roberto Raggi's avatar
Roberto Raggi committed
93
        _exprDoc = Document::create("<references>");
Roberto Raggi's avatar
Roberto Raggi committed
94
        accept(_doc->translationUnit()->ast());
Roberto Raggi's avatar
Roberto Raggi committed
95
    }
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
}

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

119 120 121 122 123 124 125 126
Scope *FindUsages::scopeAt(unsigned tokenIndex) const
{
    TranslationUnit *unit = _doc->translationUnit();
    unsigned line, column;
    unit->getTokenPosition(tokenIndex, &line, &column);
    return _doc->scopeAt(line, column);
}

127 128
void FindUsages::reportResult(unsigned tokenIndex, const QList<Symbol *> &candidates)
{
129 130 131
    if (_processed.contains(tokenIndex))
        return;

132 133 134 135 136 137 138 139
    const bool isStrongResult = checkCandidates(candidates);

    if (isStrongResult)
        reportResult(tokenIndex);
}

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

    _processed.insert(tokenIndex);

148 149 150 151 152 153 154 155 156 157
    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;

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

bool FindUsages::checkCandidates(const QList<Symbol *> &candidates) const
{
Roberto Raggi's avatar
Roberto Raggi committed
165 166 167 168 169 170
    if (ClassOrNamespace *c = _context.lookupType(_declSymbol)) {
        for (int i = candidates.size() - 1; i != -1; --i) {
            Symbol *s = candidates.at(i);
            if (_context.lookupType(s) == c)
                return true;
        }
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    }

    return false;
}

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) {
189
            const QList<Symbol *> candidates = _context.lookup(simple->name, scopeAt(simple->identifier_token));
190 191 192
            reportResult(simple->identifier_token, candidates);
        }
    }
193
    accept(ast->expression_list);
194 195 196 197 198 199 200 201
    return false;
}

bool FindUsages::visit(MemberAccessAST *ast)
{
    if (ast->member_name) {
        if (SimpleNameAST *simple = ast->member_name->asSimpleName()) {
            if (identifier(simple->identifier_token) == _id) {
202
                checkExpression(ast->firstToken(), simple->identifier_token);
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
                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);
221
    Scope *scope = _doc->scopeAt(line, column);
222

223
    const QList<LookupItem> results = typeofExpression(expression, scope,
224
                                                       TypeOfExpression::Preprocess);
225 226 227

    QList<Symbol *> candidates;

228
    foreach (const LookupItem &r, results) {
229
        Symbol *lastVisibleSymbol = r.declaration();
230 231 232 233 234 235 236 237
        candidates.append(lastVisibleSymbol);
    }

    reportResult(endToken, candidates);
}

bool FindUsages::visit(QualifiedNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
238
    for (NestedNameSpecifierListAST *it = ast->nested_name_specifier_list; it; it = it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
239
        NestedNameSpecifierAST *nested_name_specifier = it->value;
240 241 242 243 244 245 246 247 248

        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
249
                    for (TemplateArgumentListAST *arg_it = template_id->template_argument_list; arg_it; arg_it = arg_it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
250
                        accept(arg_it->value);
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
                    }
                }
            }

            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
282
                for (TemplateArgumentListAST *template_arguments = template_id->template_argument_list;
283
                     template_arguments; template_arguments = template_arguments->next) {
284
                    accept(template_arguments->value);
285 286 287 288 289 290 291 292 293 294 295 296 297
                }
            }
        }

        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
298
    const Identifier *id = identifier(ast->identifier_token);
299
    if (id == _id) {
300
        const QList<Symbol *> candidates = _context.lookup(control()->nameId(id), scopeAt(ast->identifier_token));
301 302 303 304 305 306 307 308 309 310
        reportResult(ast->identifier_token, candidates);
    }

    accept(ast->expression);

    return false;
}

bool FindUsages::visit(SimpleNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
311
    const Identifier *id = identifier(ast->identifier_token);
312
    if (id == _id) {
313
        const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
314 315 316 317 318 319 320 321
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(DestructorNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
322
    const Identifier *id = identifier(ast->identifier_token);
323
    if (id == _id) {
324
        const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
325 326 327 328 329 330 331 332 333
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(TemplateIdAST *ast)
{
    if (_id == identifier(ast->identifier_token)) {
334
        const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
335 336 337
        reportResult(ast->identifier_token, candidates);
    }

Roberto Raggi's avatar
Roberto Raggi committed
338
    for (TemplateArgumentListAST *template_arguments = ast->template_argument_list;
339
         template_arguments; template_arguments = template_arguments->next) {
340
        accept(template_arguments->value);
341 342 343 344 345 346 347
    }

    return false;
}

bool FindUsages::visit(ParameterDeclarationAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
348
    for (SpecifierListAST *it = ast->type_specifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
349
        accept(it->value);
350 351

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

Roberto Raggi's avatar
Roberto Raggi committed
355
        for (PtrOperatorListAST *it = declarator->ptr_operator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
356
            accept(it->value);
357 358 359 360

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

Roberto Raggi's avatar
Roberto Raggi committed
364
        for (SpecifierListAST *it = declarator->post_attribute_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
365
            accept(it->value);
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

        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
384
    for (SpecifierListAST *it = ast->cv_qualifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
385
        accept(it->value);
386 387 388 389 390 391

    accept(ast->exception_specification);

    return false;
}

392
bool FindUsages::visit(SimpleDeclarationAST *ast)
393
{
394 395 396
    for  (SpecifierListAST *it = ast->decl_specifier_list; it; it = it->next)
        accept(it->value);

397
    ++_inSimpleDeclaration;
398 399 400 401
    for (DeclaratorListAST *it = ast->declarator_list; it; it = it->next)
        accept(it->value);
    --_inSimpleDeclaration;
    return false;
402 403
}

404
bool FindUsages::visit(ObjCSelectorAST *ast)
405
{
Erik Verbruggen's avatar
Erik Verbruggen committed
406 407
    if (ast->name) {
        const Identifier *id = ast->name->identifier();
408
        if (id == _id) {
409
            const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->firstToken()));
Erik Verbruggen's avatar
Erik Verbruggen committed
410
            reportResult(ast->firstToken(), candidates);
411 412 413 414 415
        }
    }

    return false;
}
416 417 418 419 420 421 422 423 424

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

void FindUsages::endVisit(QtPropertyDeclarationAST *)
{ _inQProperty = false; }
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

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());
            const QList<Symbol *> candidates = _context.lookup(name->name, scopeAt(start));
            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());
            const QList<Symbol *> candidates = _context.lookup(name->name, scopeAt(start));
            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();
}