FindUsages.cpp 12.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
**
** 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 <Control.h>
#include <Literals.h>
#include <Names.h>
35
#include <Scope.h>
36 37
#include <Symbols.h>
#include <AST.h>
Roberto Raggi's avatar
Roberto Raggi committed
38
#include <TranslationUnit.h>
39 40

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

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
      _doc(doc),
      _snapshot(snapshot),
49
      _context(doc, snapshot),
50
      _source(_doc->source()),
Roberto Raggi's avatar
Roberto Raggi committed
51
      _sem(doc->translationUnit()),
52 53
      _inSimpleDeclaration(0),
      _inQProperty(false)
54 55
{
    _snapshot.insert(_doc);
Roberto Raggi's avatar
Roberto Raggi committed
56
    typeofExpression.init(_doc, _snapshot, _context.bindings());
57 58
}

59 60 61 62 63 64 65 66 67 68 69 70 71
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
72 73 74 75 76 77
QList<Usage> FindUsages::usages() const
{ return _usages; }

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

Roberto Raggi's avatar
Roberto Raggi committed
78
void FindUsages::operator()(Symbol *symbol)
79
{
80
    _processed.clear();
81
    _references.clear();
Roberto Raggi's avatar
Roberto Raggi committed
82
    _usages.clear();
83
    _declSymbol = symbol;
84
    _inSimpleDeclaration = 0;
85
    _inQProperty = false;
Roberto Raggi's avatar
Roberto Raggi committed
86 87

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

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

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

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

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

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

    if (isStrongResult)
        reportResult(tokenIndex);
}

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

    _processed.insert(tokenIndex);

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

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

bool FindUsages::checkCandidates(const QList<Symbol *> &candidates) const
{
Roberto Raggi's avatar
Roberto Raggi committed
164 165 166 167 168 169
    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;
        }
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    }

    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) {
188
            const QList<Symbol *> candidates = _context.lookup(simple->name, scopeAt(simple->identifier_token));
189 190 191
            reportResult(simple->identifier_token, candidates);
        }
    }
192
    accept(ast->expression_list);
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
    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;

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

237
    const QList<LookupItem> results = typeofExpression(expression, scope,
238
                                                       TypeOfExpression::Preprocess);
239 240 241

    QList<Symbol *> candidates;

242
    foreach (const LookupItem &r, results) {
243
        Symbol *lastVisibleSymbol = r.declaration();
244 245 246 247 248 249 250 251
        candidates.append(lastVisibleSymbol);
    }

    reportResult(endToken, candidates);
}

bool FindUsages::visit(QualifiedNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
252
    for (NestedNameSpecifierListAST *it = ast->nested_name_specifier_list; it; it = it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
253
        NestedNameSpecifierAST *nested_name_specifier = it->value;
254 255 256 257 258 259 260 261 262

        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
263
                    for (TemplateArgumentListAST *arg_it = template_id->template_argument_list; arg_it; arg_it = arg_it->next) {
Roberto Raggi's avatar
Roberto Raggi committed
264
                        accept(arg_it->value);
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
                    }
                }
            }

            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
296
                for (TemplateArgumentListAST *template_arguments = template_id->template_argument_list;
297
                     template_arguments; template_arguments = template_arguments->next) {
298
                    accept(template_arguments->value);
299 300 301 302 303 304 305 306 307 308 309 310 311
                }
            }
        }

        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
312
    const Identifier *id = identifier(ast->identifier_token);
313
    if (id == _id) {
314
        const QList<Symbol *> candidates = _context.lookup(control()->nameId(id), scopeAt(ast->identifier_token));
315 316 317 318 319 320 321 322 323 324
        reportResult(ast->identifier_token, candidates);
    }

    accept(ast->expression);

    return false;
}

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

    return false;
}

bool FindUsages::visit(DestructorNameAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
336
    const Identifier *id = identifier(ast->identifier_token);
337
    if (id == _id) {
338
        const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
339 340 341 342 343 344 345 346 347
        reportResult(ast->identifier_token, candidates);
    }

    return false;
}

bool FindUsages::visit(TemplateIdAST *ast)
{
    if (_id == identifier(ast->identifier_token)) {
348
        const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->identifier_token));
349 350 351
        reportResult(ast->identifier_token, candidates);
    }

Roberto Raggi's avatar
Roberto Raggi committed
352
    for (TemplateArgumentListAST *template_arguments = ast->template_argument_list;
353
         template_arguments; template_arguments = template_arguments->next) {
354
        accept(template_arguments->value);
355 356 357 358 359 360 361
    }

    return false;
}

bool FindUsages::visit(ParameterDeclarationAST *ast)
{
Roberto Raggi's avatar
Roberto Raggi committed
362
    for (SpecifierListAST *it = ast->type_specifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
363
        accept(it->value);
364 365

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

Roberto Raggi's avatar
Roberto Raggi committed
369
        for (PtrOperatorListAST *it = declarator->ptr_operator_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
370
            accept(it->value);
371 372 373 374

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

Roberto Raggi's avatar
Roberto Raggi committed
378
        for (SpecifierListAST *it = declarator->post_attribute_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
379
            accept(it->value);
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

        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
398
    for (SpecifierListAST *it = ast->cv_qualifier_list; it; it = it->next)
Roberto Raggi's avatar
Roberto Raggi committed
399
        accept(it->value);
400 401 402 403 404 405

    accept(ast->exception_specification);

    return false;
}

406
bool FindUsages::visit(SimpleDeclarationAST *ast)
407
{
408 409 410
    for  (SpecifierListAST *it = ast->decl_specifier_list; it; it = it->next)
        accept(it->value);

411
    ++_inSimpleDeclaration;
412 413 414 415
    for (DeclaratorListAST *it = ast->declarator_list; it; it = it->next)
        accept(it->value);
    --_inSimpleDeclaration;
    return false;
416 417
}

418
bool FindUsages::visit(ObjCSelectorAST *ast)
419
{
Erik Verbruggen's avatar
Erik Verbruggen committed
420 421
    if (ast->name) {
        const Identifier *id = ast->name->identifier();
422
        if (id == _id) {
423
            const QList<Symbol *> candidates = _context.lookup(ast->name, scopeAt(ast->firstToken()));
Erik Verbruggen's avatar
Erik Verbruggen committed
424
            reportResult(ast->firstToken(), candidates);
425 426 427 428 429
        }
    }

    return false;
}
430 431 432 433 434 435 436 437 438

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

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