cppquickfixes.cpp 60.3 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
30 31 32
**
**************************************************************************/

33
#include "cppcompleteswitch.h"
34 35
#include "cppeditor.h"
#include "cppquickfix.h"
36
#include "cppinsertdecldef.h"
37
#include "cppinsertqtpropertymembers.h"
Leandro Melo's avatar
Leandro Melo committed
38 39
#include "cppquickfixassistant.h"
#include "cppcompleteswitch.h"
40
#include "cppfunctiondecldeflink.h"
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

#include <ASTVisitor.h>
#include <AST.h>
#include <ASTMatcher.h>
#include <ASTPatternBuilder.h>
#include <CoreTypes.h>
#include <Literals.h>
#include <Name.h>
#include <Names.h>
#include <Symbol.h>
#include <Symbols.h>
#include <Token.h>
#include <TranslationUnit.h>
#include <Type.h>

#include <cplusplus/DependencyTable.h>
#include <cplusplus/Overview.h>
#include <cplusplus/TypeOfExpression.h>
#include <cplusplus/CppRewriter.h>
#include <cpptools/cpptoolsconstants.h>
61
#include <cpptools/cpprefactoringchanges.h>
62
#include <cpptools/insertionpointlocator.h>
63 64
#include <extensionsystem/iplugin.h>

Friedemann Kleint's avatar
Friedemann Kleint committed
65
#include <QtCore/QFileInfo>
66 67 68 69 70 71
#include <QtGui/QApplication>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>

using namespace CppEditor;
using namespace CppEditor::Internal;
72
using namespace CppTools;
73 74 75 76
using namespace TextEditor;
using namespace CPlusPlus;
using namespace Utils;

77 78 79 80 81
static inline bool isQtStringLiteral(const QByteArray &id)
{
    return id == "QLatin1String" || id == "QLatin1Literal" || id == "QStringLiteral";
}

82 83 84 85 86 87 88
namespace {

/*
    Rewrite
    a op b -> !(a invop b)
    (a op b) -> !(a invop b)
    !(a op b) -> (a invob b)
89 90

    Activates on: <= < > >= == !=
91 92 93 94
*/
class UseInverseOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
95
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
96 97
    {
        QList<CppQuickFixOperation::Ptr> result;
98
        CppRefactoringFilePtr file = interface->currentFile();
99

Leandro Melo's avatar
Leandro Melo committed
100
        const QList<AST *> &path = interface->path();
101 102 103 104
        int index = path.size() - 1;
        BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
        if (! binary)
            return result;
Leandro Melo's avatar
Leandro Melo committed
105
        if (! interface->isCursorOn(binary->binary_op_token))
106 107 108
            return result;

        Kind invertToken;
109
        switch (file->tokenAt(binary->binary_op_token).kind()) {
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
        case T_LESS_EQUAL:
            invertToken = T_GREATER;
            break;
        case T_LESS:
            invertToken = T_GREATER_EQUAL;
            break;
        case T_GREATER:
            invertToken = T_LESS_EQUAL;
            break;
        case T_GREATER_EQUAL:
            invertToken = T_LESS;
            break;
        case T_EQUAL_EQUAL:
            invertToken = T_EXCLAIM_EQUAL;
            break;
        case T_EXCLAIM_EQUAL:
            invertToken = T_EQUAL_EQUAL;
            break;
        default:
            return result;
        }

Leandro Melo's avatar
Leandro Melo committed
132
        result.append(CppQuickFixOperation::Ptr(new Operation(interface, index, binary, invertToken)));
133 134 135 136 137 138 139 140 141 142 143 144 145
        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
        BinaryExpressionAST *binary;
        NestedExpressionAST *nested;
        UnaryExpressionAST *negation;

        QString replacement;

    public:
Leandro Melo's avatar
Leandro Melo committed
146 147 148
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface,
            int priority, BinaryExpressionAST *binary, Kind invertToken)
            : CppQuickFixOperation(interface, priority)
149
            , binary(binary), nested(0), negation(0)
150 151 152 153 154 155 156
        {
            Token tok;
            tok.f.kind = invertToken;
            replacement = QLatin1String(tok.spell());

            // check for enclosing nested expression
            if (priority - 1 >= 0)
Leandro Melo's avatar
Leandro Melo committed
157
                nested = interface->path()[priority - 1]->asNestedExpression();
158 159 160

            // check for ! before parentheses
            if (nested && priority - 2 >= 0) {
Leandro Melo's avatar
Leandro Melo committed
161
                negation = interface->path()[priority - 2]->asUnaryExpression();
162
                if (negation && ! interface->currentFile()->tokenAt(negation->unary_op_token).is(T_EXCLAIM))
163 164 165 166 167 168 169 170 171
                    negation = 0;
            }
        }

        virtual QString description() const
        {
            return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
        }

172
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
173 174 175 176
        {
            ChangeSet changes;
            if (negation) {
                // can't remove parentheses since that might break precedence
177
                changes.remove(currentFile->range(negation->unary_op_token));
178
            } else if (nested) {
179
                changes.insert(currentFile->startOf(nested), "!");
180
            } else {
181 182
                changes.insert(currentFile->startOf(binary), "!(");
                changes.insert(currentFile->endOf(binary), ")");
183
            }
184
            changes.replace(currentFile->range(binary->binary_op_token), replacement);
185 186
            currentFile->setChangeSet(changes);
            currentFile->apply();
187 188 189 190 191 192 193 194 195 196
        }
    };
};

/*
    Rewrite
    a op b

    As
    b flipop a
197 198

    Activates on: <= < > >= == != && ||
199 200 201 202
*/
class FlipBinaryOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
203
    virtual QList<QuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
204 205
    {
        QList<QuickFixOperation::Ptr> result;
Leandro Melo's avatar
Leandro Melo committed
206
        const QList<AST *> &path = interface->path();
207
        CppRefactoringFilePtr file = interface->currentFile();
208 209 210 211 212

        int index = path.size() - 1;
        BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
        if (! binary)
            return result;
Leandro Melo's avatar
Leandro Melo committed
213
        if (! interface->isCursorOn(binary->binary_op_token))
214 215 216
            return result;

        Kind flipToken;
217
        switch (file->tokenAt(binary->binary_op_token).kind()) {
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        case T_LESS_EQUAL:
            flipToken = T_GREATER_EQUAL;
            break;
        case T_LESS:
            flipToken = T_GREATER;
            break;
        case T_GREATER:
            flipToken = T_LESS;
            break;
        case T_GREATER_EQUAL:
            flipToken = T_LESS_EQUAL;
            break;
        case T_EQUAL_EQUAL:
        case T_EXCLAIM_EQUAL:
        case T_AMPER_AMPER:
        case T_PIPE_PIPE:
            flipToken = T_EOF_SYMBOL;
            break;
        default:
            return result;
        }

        QString replacement;
        if (flipToken != T_EOF_SYMBOL) {
            Token tok;
            tok.f.kind = flipToken;
            replacement = QLatin1String(tok.spell());
        }

Leandro Melo's avatar
Leandro Melo committed
247
        result.append(QuickFixOperation::Ptr(new Operation(interface, index, binary, replacement)));
248 249 250 251 252 253 254
        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
255 256 257
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface,
                  int priority, BinaryExpressionAST *binary, QString replacement)
            : CppQuickFixOperation(interface)
258 259 260 261 262 263 264 265 266 267 268 269 270 271
            , binary(binary)
            , replacement(replacement)
        {
            setPriority(priority);
        }

        virtual QString description() const
        {
            if (replacement.isEmpty())
                return QApplication::translate("CppTools::QuickFix", "Swap Operands");
            else
                return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
        }

272
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
273 274 275
        {
            ChangeSet changes;

276
            changes.flip(currentFile->range(binary->left_expression), currentFile->range(binary->right_expression));
277
            if (! replacement.isEmpty())
278
                changes.replace(currentFile->range(binary->binary_op_token), replacement);
279

280 281
            currentFile->setChangeSet(changes);
            currentFile->apply();
282 283 284 285 286 287 288 289 290 291 292 293 294 295
        }

    private:
        BinaryExpressionAST *binary;
        QString replacement;
    };
};

/*
    Rewrite
    !a && !b

    As
    !(a || b)
296 297

    Activates on: &&
298 299 300 301
*/
class RewriteLogicalAndOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
302
    virtual QList<QuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
303 304 305
    {
        QList<QuickFixOperation::Ptr> result;
        BinaryExpressionAST *expression = 0;
Leandro Melo's avatar
Leandro Melo committed
306
        const QList<AST *> &path = interface->path();
307
        CppRefactoringFilePtr file = interface->currentFile();
308 309 310 311 312 313 314 315 316 317 318

        int index = path.size() - 1;
        for (; index != -1; --index) {
            expression = path.at(index)->asBinaryExpression();
            if (expression)
                break;
        }

        if (! expression)
            return result;

Leandro Melo's avatar
Leandro Melo committed
319
        if (! interface->isCursorOn(expression->binary_op_token))
320 321
            return result;

Leandro Melo's avatar
Leandro Melo committed
322
        QSharedPointer<Operation> op(new Operation(interface));
323 324

        if (expression->match(op->pattern, &matcher) &&
325 326 327
                file->tokenAt(op->pattern->binary_op_token).is(T_AMPER_AMPER) &&
                file->tokenAt(op->left->unary_op_token).is(T_EXCLAIM) &&
                file->tokenAt(op->right->unary_op_token).is(T_EXCLAIM)) {
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
            op->setDescription(QApplication::translate("CppTools::QuickFix", "Rewrite Condition Using ||"));
            op->setPriority(index);
            result.append(op);
        }

        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
        QSharedPointer<ASTPatternBuilder> mk;
        UnaryExpressionAST *left;
        UnaryExpressionAST *right;
        BinaryExpressionAST *pattern;

Leandro Melo's avatar
Leandro Melo committed
345 346
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
347 348 349 350 351 352 353
            , mk(new ASTPatternBuilder)
        {
            left = mk->UnaryExpression();
            right = mk->UnaryExpression();
            pattern = mk->BinaryExpression(left, right);
        }

354
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
355 356
        {
            ChangeSet changes;
357 358 359 360 361
            changes.replace(currentFile->range(pattern->binary_op_token), QLatin1String("||"));
            changes.remove(currentFile->range(left->unary_op_token));
            changes.remove(currentFile->range(right->unary_op_token));
            const int start = currentFile->startOf(pattern);
            const int end = currentFile->endOf(pattern);
362 363 364
            changes.insert(start, QLatin1String("!("));
            changes.insert(end, QLatin1String(")"));

365 366 367
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
368 369 370 371 372 373 374
        }
    };

private:
    ASTMatcher matcher;
};

375 376 377 378 379 380 381
/*
    Rewrite
    int *a, b;

    As
    int *a;
    int b;
382 383

    Activates on: the type or the variable names.
384
*/
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
class SplitSimpleDeclarationOp: public CppQuickFixFactory
{
    static bool checkDeclaration(SimpleDeclarationAST *declaration)
    {
        if (! declaration->semicolon_token)
            return false;

        if (! declaration->decl_specifier_list)
            return false;

        for (SpecifierListAST *it = declaration->decl_specifier_list; it; it = it->next) {
            SpecifierAST *specifier = it->value;

            if (specifier->asEnumSpecifier() != 0)
                return false;

            else if (specifier->asClassSpecifier() != 0)
                return false;
        }

        if (! declaration->declarator_list)
            return false;

        else if (! declaration->declarator_list->next)
            return false;

        return true;
    }

public:
Leandro Melo's avatar
Leandro Melo committed
415
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
416 417 418
    {
        QList<CppQuickFixOperation::Ptr> result;
        CoreDeclaratorAST *core_declarator = 0;
Leandro Melo's avatar
Leandro Melo committed
419
        const QList<AST *> &path = interface->path();
420
        CppRefactoringFilePtr file = interface->currentFile();
421 422 423 424 425 426 427 428 429 430 431

        for (int index = path.size() - 1; index != -1; --index) {
            AST *node = path.at(index);

            if (CoreDeclaratorAST *coreDecl = node->asCoreDeclarator())
                core_declarator = coreDecl;

            else if (SimpleDeclarationAST *simpleDecl = node->asSimpleDeclaration()) {
                if (checkDeclaration(simpleDecl)) {
                    SimpleDeclarationAST *declaration = simpleDecl;

432
                    const int cursorPosition = file->cursor().selectionStart();
433

434 435
                    const int startOfDeclSpecifier = file->startOf(declaration->decl_specifier_list->firstToken());
                    const int endOfDeclSpecifier = file->endOf(declaration->decl_specifier_list->lastToken() - 1);
436 437 438

                    if (cursorPosition >= startOfDeclSpecifier && cursorPosition <= endOfDeclSpecifier) {
                        // the AST node under cursor is a specifier.
Leandro Melo's avatar
Leandro Melo committed
439
                        return singleResult(new Operation(interface, index, declaration));
440 441
                    }

Leandro Melo's avatar
Leandro Melo committed
442
                    if (core_declarator && interface->isCursorOn(core_declarator)) {
443
                        // got a core-declarator under the text cursor.
Leandro Melo's avatar
Leandro Melo committed
444
                        return singleResult(new Operation(interface, index, declaration));
445 446 447 448 449 450 451 452 453 454 455 456 457 458
                    }
                }

                break;
            }
        }

        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
459 460
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, SimpleDeclarationAST *decl)
            : CppQuickFixOperation(interface, priority)
461 462 463 464 465 466
            , declaration(decl)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Split Declaration"));
        }

467
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
468 469 470 471
        {
            ChangeSet changes;

            SpecifierListAST *specifiers = declaration->decl_specifier_list;
472 473 474
            int declSpecifiersStart = currentFile->startOf(specifiers->firstToken());
            int declSpecifiersEnd = currentFile->endOf(specifiers->lastToken() - 1);
            int insertPos = currentFile->endOf(declaration->semicolon_token);
475 476 477 478 479 480 481 482 483

            DeclaratorAST *prevDeclarator = declaration->declarator_list->value;

            for (DeclaratorListAST *it = declaration->declarator_list->next; it; it = it->next) {
                DeclaratorAST *declarator = it->value;

                changes.insert(insertPos, QLatin1String("\n"));
                changes.copy(declSpecifiersStart, declSpecifiersEnd, insertPos);
                changes.insert(insertPos, QLatin1String(" "));
484
                changes.move(currentFile->range(declarator), insertPos);
485 486
                changes.insert(insertPos, QLatin1String(";"));

487 488
                const int prevDeclEnd = currentFile->endOf(prevDeclarator);
                changes.remove(prevDeclEnd, currentFile->startOf(declarator));
489 490 491 492

                prevDeclarator = declarator;
            }

493 494 495
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(declaration));
            currentFile->apply();
496 497 498 499 500 501 502 503 504
        }

    private:
        SimpleDeclarationAST *declaration;
    };
};

/*
    Add curly braces to a if statement that doesn't already contain a
505 506 507 508 509 510 511 512
    compound statement. I.e.

    if (a)
        b;
    becomes
    if (a) {
        b;
    }
513 514

    Activates on: the if
515 516 517 518
*/
class AddBracesToIfOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
519
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
520
    {
Leandro Melo's avatar
Leandro Melo committed
521
        const QList<AST *> &path = interface->path();
522 523 524 525

        // show when we're on the 'if' of an if statement
        int index = path.size() - 1;
        IfStatementAST *ifStatement = path.at(index)->asIfStatement();
Leandro Melo's avatar
Leandro Melo committed
526
        if (ifStatement && interface->isCursorOn(ifStatement->if_token) && ifStatement->statement
527
            && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
528
            return singleResult(new Operation(interface, index, ifStatement->statement));
529 530 531 532 533 534 535
        }

        // or if we're on the statement contained in the if
        // ### This may not be such a good idea, consider nested ifs...
        for (; index != -1; --index) {
            IfStatementAST *ifStatement = path.at(index)->asIfStatement();
            if (ifStatement && ifStatement->statement
Leandro Melo's avatar
Leandro Melo committed
536
                && interface->isCursorOn(ifStatement->statement)
537
                && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
538
                return singleResult(new Operation(interface, index, ifStatement->statement));
539 540 541 542 543 544 545 546 547 548 549 550 551
            }
        }

        // ### This could very well be extended to the else branch
        // and other nodes entirely.

        return noResult();
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
552 553
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, StatementAST *statement)
            : CppQuickFixOperation(interface, priority)
554 555 556 557 558 559
            , _statement(statement)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Add Curly Braces"));
        }

560
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
561 562 563
        {
            ChangeSet changes;

564
            const int start = currentFile->endOf(_statement->firstToken() - 1);
565 566
            changes.insert(start, QLatin1String(" {"));

567
            const int end = currentFile->endOf(_statement->lastToken() - 1);
568 569
            changes.insert(end, "\n}");

570 571 572
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(Utils::ChangeSet::Range(start, end));
            currentFile->apply();
573 574 575 576 577 578 579 580 581 582 583 584 585 586
        }

    private:
        StatementAST *_statement;
    };
};

/*
    Replace
    if (Type name = foo()) {...}

    With
    Type name = foo;
    if (name) {...}
587 588

    Activates on: the name of the introduced variable
589 590 591 592
*/
class MoveDeclarationOutOfIfOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
593
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
594
    {
Leandro Melo's avatar
Leandro Melo committed
595 596
        const QList<AST *> &path = interface->path();
        QSharedPointer<Operation> op(new Operation(interface));
597 598 599 600 601 602 603 604 605 606

        int index = path.size() - 1;
        for (; index != -1; --index) {
            if (IfStatementAST *statement = path.at(index)->asIfStatement()) {
                if (statement->match(op->pattern, &op->matcher) && op->condition->declarator) {
                    DeclaratorAST *declarator = op->condition->declarator;
                    op->core = declarator->core_declarator;
                    if (! op->core)
                        return noResult();

Leandro Melo's avatar
Leandro Melo committed
607
                    if (interface->isCursorOn(op->core)) {
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
                        QList<CppQuickFixOperation::Ptr> result;
                        op->setPriority(index);
                        result.append(op);
                        return result;
                    }
                }
            }
        }

        return noResult();
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
624 625
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
626 627 628 629 630 631 632 633
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Move Declaration out of Condition"));

            condition = mk.Condition();
            pattern = mk.IfStatement(condition);
        }

634
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
635 636 637
        {
            ChangeSet changes;

638
            changes.copy(currentFile->range(core), currentFile->startOf(condition));
639

640 641
            int insertPos = currentFile->startOf(pattern);
            changes.move(currentFile->range(condition), insertPos);
642 643
            changes.insert(insertPos, QLatin1String(";\n"));

644 645 646
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
647 648 649 650
        }

        ASTMatcher matcher;
        ASTPatternBuilder mk;
651
        CPPEditorWidget *editor;
652 653 654 655 656 657 658 659 660 661 662 663 664
        ConditionAST *condition;
        IfStatementAST *pattern;
        CoreDeclaratorAST *core;
    };
};

/*
    Replace
    while (Type name = foo()) {...}

    With
    Type name;
    while ((name = foo()) != 0) {...}
665 666

    Activates on: the name of the introduced variable
667 668 669 670
*/
class MoveDeclarationOutOfWhileOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
671
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
672
    {
Leandro Melo's avatar
Leandro Melo committed
673 674
        const QList<AST *> &path = interface->path();
        QSharedPointer<Operation> op(new Operation(interface));
675 676 677 678 679 680 681 682 683 684 685

        int index = path.size() - 1;
        for (; index != -1; --index) {
            if (WhileStatementAST *statement = path.at(index)->asWhileStatement()) {
                if (statement->match(op->pattern, &op->matcher) && op->condition->declarator) {
                    DeclaratorAST *declarator = op->condition->declarator;
                    op->core = declarator->core_declarator;

                    if (! op->core)
                        return noResult();

686
                    else if (! declarator->equal_token)
687 688 689 690 691
                        return noResult();

                    else if (! declarator->initializer)
                        return noResult();

Leandro Melo's avatar
Leandro Melo committed
692
                    if (interface->isCursorOn(op->core)) {
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
                        QList<CppQuickFixOperation::Ptr> result;
                        op->setPriority(index);
                        result.append(op);
                        return result;
                    }
                }
            }
        }

        return noResult();
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
709 710
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
711 712 713 714 715 716 717 718
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Move Declaration out of Condition"));

            condition = mk.Condition();
            pattern = mk.WhileStatement(condition);
        }

719
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
720 721 722
        {
            ChangeSet changes;

723 724
            changes.insert(currentFile->startOf(condition), QLatin1String("("));
            changes.insert(currentFile->endOf(condition), QLatin1String(") != 0"));
725

726 727 728 729
            int insertPos = currentFile->startOf(pattern);
            const int conditionStart = currentFile->startOf(condition);
            changes.move(conditionStart, currentFile->startOf(core), insertPos);
            changes.copy(currentFile->range(core), insertPos);
730 731
            changes.insert(insertPos, QLatin1String(";\n"));

732 733 734
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
735 736 737 738
        }

        ASTMatcher matcher;
        ASTPatternBuilder mk;
739
        CPPEditorWidget *editor;
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
        ConditionAST *condition;
        WhileStatementAST *pattern;
        CoreDeclaratorAST *core;
    };
};

/*
  Replace
     if (something && something_else) {
     }

  with
     if (something) {
        if (something_else) {
        }
     }

  and
    if (something || something_else)
      x;

  with
    if (something)
      x;
    else if (something_else)
      x;
766 767

    Activates on: && or ||
768 769 770 771
*/
class SplitIfStatementOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
772
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
773 774
    {
        IfStatementAST *pattern = 0;
Leandro Melo's avatar
Leandro Melo committed
775
        const QList<AST *> &path = interface->path();
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

        int index = path.size() - 1;
        for (; index != -1; --index) {
            AST *node = path.at(index);
            if (IfStatementAST *stmt = node->asIfStatement()) {
                pattern = stmt;
                break;
            }
        }

        if (! pattern || ! pattern->statement)
            return noResult();

        unsigned splitKind = 0;
        for (++index; index < path.size(); ++index) {
            AST *node = path.at(index);
            BinaryExpressionAST *condition = node->asBinaryExpression();
            if (! condition)
                return noResult();

796
            Token binaryToken = interface->currentFile()->tokenAt(condition->binary_op_token);
797 798 799 800 801 802 803 804 805 806 807 808 809

            // only accept a chain of ||s or &&s - no mixing
            if (! splitKind) {
                splitKind = binaryToken.kind();
                if (splitKind != T_AMPER_AMPER && splitKind != T_PIPE_PIPE)
                    return noResult();
                // we can't reliably split &&s in ifs with an else branch
                if (splitKind == T_AMPER_AMPER && pattern->else_statement)
                    return noResult();
            } else if (splitKind != binaryToken.kind()) {
                return noResult();
            }

Leandro Melo's avatar
Leandro Melo committed
810 811
            if (interface->isCursorOn(condition->binary_op_token))
                return singleResult(new Operation(interface, index, pattern, condition));
812 813 814 815 816 817 818 819 820
        }

        return noResult();
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
821
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority,
822
                  IfStatementAST *pattern, BinaryExpressionAST *condition)
Leandro Melo's avatar
Leandro Melo committed
823
            : CppQuickFixOperation(interface, priority)
824 825 826 827 828 829 830
            , pattern(pattern)
            , condition(condition)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Split if Statement"));
        }

831
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
832
        {
833
            const Token binaryToken = currentFile->tokenAt(condition->binary_op_token);
834 835

            if (binaryToken.is(T_AMPER_AMPER))
836
                splitAndCondition(currentFile);
837
            else
838
                splitOrCondition(currentFile);
839 840
        }

841
        void splitAndCondition(CppRefactoringFilePtr currentFile)
842 843 844
        {
            ChangeSet changes;

845
            int startPos = currentFile->startOf(pattern);
846
            changes.insert(startPos, QLatin1String("if ("));
847
            changes.move(currentFile->range(condition->left_expression), startPos);
848 849
            changes.insert(startPos, QLatin1String(") {\n"));

850 851 852
            const int lExprEnd = currentFile->endOf(condition->left_expression);
            changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));
            changes.insert(currentFile->endOf(pattern), QLatin1String("\n}"));
853

854 855 856
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
857 858
        }

859
        void splitOrCondition(CppRefactoringFilePtr currentFile)
860 861 862 863 864 865
        {
            ChangeSet changes;

            StatementAST *ifTrueStatement = pattern->statement;
            CompoundStatementAST *compoundStatement = ifTrueStatement->asCompoundStatement();

866
            int insertPos = currentFile->endOf(ifTrueStatement);
867 868 869 870 871 872
            if (compoundStatement)
                changes.insert(insertPos, QLatin1String(" "));
            else
                changes.insert(insertPos, QLatin1String("\n"));
            changes.insert(insertPos, QLatin1String("else if ("));

873 874
            const int rExprStart = currentFile->startOf(condition->right_expression);
            changes.move(rExprStart, currentFile->startOf(pattern->rparen_token), insertPos);
875 876
            changes.insert(insertPos, QLatin1String(")"));

877 878
            const int rParenEnd = currentFile->endOf(pattern->rparen_token);
            changes.copy(rParenEnd, currentFile->endOf(pattern->statement), insertPos);
879

880 881
            const int lExprEnd = currentFile->endOf(condition->left_expression);
            changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));
882

883 884 885
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
886 887 888 889 890 891 892 893 894 895
        }

    private:
        IfStatementAST *pattern;
        BinaryExpressionAST *condition;
    };
};

/*
  Replace
896
    "abcd" -> QLatin1String("abcd")
897
    @"abcd" -> QLatin1String("abcd")
898 899 900 901
    'a' -> QLatin1Char('a')
  Except if they are already enclosed in
    QLatin1Char, QT_TRANSLATE_NOOP, tr,
    trUtf8, QLatin1Literal, QLatin1String
902 903

    Activates on: the string literal
904
*/
905 906 907 908 909 910 911

static inline QString msgQtStringLiteralDescription(const QString &replacement, int qtVersion)
{
    return QApplication::translate("CppTools::QuickFix", "Enclose in %1(...) (Qt %2)")
           .arg(replacement).arg(qtVersion);
}

912 913 914 915 916
class WrapStringLiteral: public CppQuickFixFactory
{
public:
    enum Type { TypeString, TypeObjCString, TypeChar, TypeNone };

Leandro Melo's avatar
Leandro Melo committed
917
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
918 919 920
    {
        ExpressionAST *literal = 0;
        Type type = TypeNone;
Leandro Melo's avatar
Leandro Melo committed
921
        const QList<AST *> &path = interface->path();
922
        CppRefactoringFilePtr file = interface->currentFile();
923 924 925 926 927 928 929 930

        if (path.isEmpty())
            return noResult(); // nothing to do

        literal = path.last()->asStringLiteral();

        if (! literal) {
            literal = path.last()->asNumericLiteral();
931
            if (!literal || !file->tokenAt(literal->asNumericLiteral()->literal_token).is(T_CHAR_LITERAL))
932 933 934 935 936 937 938 939 940 941
                return noResult();
            else
                type = TypeChar;
        } else {
            type = TypeString;
        }

        if (path.size() > 1) {
            if (CallAST *call = path.at(path.size() - 2)->asCall()) {
                if (call->base_expression) {
Roberto Raggi's avatar
Roberto Raggi committed
942 943
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
944
                            const QByteArray id(file->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
945 946

                            if (id == "QT_TRANSLATE_NOOP" || id == "tr" || id == "trUtf8"
947
                                    || (type == TypeString && isQtStringLiteral(id))
Roberto Raggi's avatar
Roberto Raggi committed
948 949 950
                                    || (type == TypeChar && id == "QLatin1Char"))
                                return noResult(); // skip it
                        }
951 952 953 954 955 956
                    }
                }
            }
        }

        if (type == TypeString) {
957
            if (file->charAt(file->startOf(literal)) == QLatin1Char('@'))
958 959
                type = TypeObjCString;
        }
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982

        QList<CppQuickFixOperation::Ptr> result;

        const int priority = path.size() - 1; // very high priority
        if (type == TypeChar) {
            const QString replacement = QLatin1String("QLatin1Char");
            const QString description =
                QApplication::translate("CppTools::QuickFix", "Enclose in %1(...)")
                           .arg(replacement);

            result.push_back(CppQuickFixOperation::Ptr(new Operation(interface, priority, type,
                                                       replacement, description, literal)));
        } else {
            QString replacement = QLatin1String("QLatin1String");
            result.push_back(CppQuickFixOperation::Ptr(new Operation(interface, priority, type,
                                                                     replacement, msgQtStringLiteralDescription(replacement, 4),
                                                                     literal)));
            replacement = QLatin1String("QStringLiteral");
            result.push_back(CppQuickFixOperation::Ptr(new Operation(interface, priority, type,
                                                                     replacement, msgQtStringLiteralDescription(replacement, 5),
                                                                     literal)));
        }
        return result;
983 984 985 986 987 988
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
989 990
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority,
                  Type type, const QString &replacement, const QString &description,
991
                  ExpressionAST *literal)
Leandro Melo's avatar
Leandro Melo committed
992
            : CppQuickFixOperation(interface, priority)
993
            , type(type), replacement(replacement)
994 995
            , literal(literal)
        {
996 997
            setDescription(description);
       }
998

999
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
1000 1001 1002
        {
            ChangeSet changes;

1003
            const int startPos = currentFile->startOf(literal);
1004
            const QString fullReplacement = replacement + QLatin1Char('(');
1005
            if (type == TypeObjCString)
1006
                changes.replace(startPos, startPos + 1, fullReplacement);
1007
            else
1008
                changes.insert(startPos, fullReplacement);
1009

1010
            changes.insert(currentFile->endOf(literal), QLatin1String(")"));
1011

1012 1013
            currentFile->setChangeSet(changes);
            currentFile->apply();
1014 1015 1016
        }

    private:
1017 1018
        const Type type;
        const QString replacement;
1019 1020
        ExpressionAST *literal;
    };
1021

1022 1023 1024 1025 1026 1027 1028 1029 1030
};

/*
  Replace
    "abcd"
  With
    tr("abcd") or
    QCoreApplication::translate("CONTEXT", "abcd") or
    QT_TRANSLATE_NOOP("GLOBAL", "abcd")
1031
  depending on what is available.
1032 1033

    Activates on: the string literal
1034 1035 1036 1037 1038 1039
*/
class TranslateStringLiteral: public CppQuickFixFactory
{
public:
    enum TranslationOption { unknown, useTr, useQCoreApplicationTranslate, useMacro };

Leandro Melo's avatar
Leandro Melo committed
1040
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
1041
    {
Leandro Melo's avatar
Leandro Melo committed
1042
        const QList<AST *> &path = interface->path();
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
        // Initialize
        ExpressionAST *literal = 0;
        QString trContext;

        if (path.isEmpty())
            return noResult();

        literal = path.last()->asStringLiteral();
        if (!literal)
            return noResult(); // No string, nothing to do

        // Do we already have a translation markup?
        if (path.size() >= 2) {
            if (CallAST *call = path.at(path.size() - 2)->asCall()) {
                if (call->base_expression) {
Roberto Raggi's avatar
Roberto Raggi committed
1058 1059
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
1060
                            const QByteArray id(interface->currentFile()->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
1061 1062 1063 1064

                            if (id == "tr" || id == "trUtf8"
                                    || id == "translate"
                                    || id == "QT_TRANSLATE_NOOP"
1065
                                    || isQtStringLiteral(id))
Roberto Raggi's avatar
Roberto Raggi committed
1066 1067
                                return noResult(); // skip it
                        }
1068 1069 1070 1071 1072
                    }
                }
            }
        }

Leandro Melo's avatar
Leandro Melo committed
1073
        QSharedPointer<Control> control = interface->context().control();
1074
        const Name *trName = control->identifier("tr");
1075 1076 1077 1078 1079 1080

        // Check whether we are in a method:
        for (int i = path.size() - 1; i >= 0; --i)
        {
            if (FunctionDefinitionAST *definition = path.at(i)->asFunctionDefinition()) {
                Function *function = definition->symbol;
Leandro Melo's avatar
Leandro Melo committed
1081
                ClassOrNamespace *b = interface->context().lookupType(function);
1082 1083 1084 1085 1086 1087
                if (b) {
                    // Do we have a tr method?
                    foreach(const LookupItem &r, b->find(trName)) {
                        Symbol *s = r.declaration();
                        if (s->type()->isFunctionType()) {
                            // no context required for tr
Leandro Melo's avatar
Leandro Melo committed
1088
                            return singleResult(new Operation(interface, path.size() - 1, literal, useTr, trContext));
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
                        }
                    }
                }
                // We need to do a QCA::translate, so we need a context.
                // Use fully qualified class name:
                Overview oo;
                foreach (const Name *n, LookupContext::path(function)) {
                    if (!trContext.isEmpty())
                        trContext.append(QLatin1String("::"));
                    trContext.append(oo.prettyName(n));
                }
                // ... or global if none available!
                if (trContext.isEmpty())
                    trContext = QLatin1String("GLOBAL");
Leandro Melo's avatar
Leandro Melo committed
1103
                return singleResult(new Operation(interface, path.size() - 1, literal, useQCoreApplicationTranslate, trContext));
1104 1105 1106 1107
            }
        }

        // We need to use Q_TRANSLATE_NOOP
Leandro Melo's avatar
Leandro Melo committed
1108
        return singleResult(new Operation(interface, path.size() - 1, literal, useMacro, QLatin1String("GLOBAL")));
1109 1110 1111 1112 1113 1114
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
1115 1116
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, ExpressionAST *literal, TranslationOption option, const QString &context)
            : CppQuickFixOperation(interface, priority)
1117 1118 1119 1120
            , m_literal(literal)
            , m_option(option)
            , m_context(context)
        {
1121
            setDescription(QApplication::translate("CppTools::QuickFix", "Mark as Translatable"));
1122 1123
        }

1124
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
1125 1126 1127
        {
            ChangeSet changes;

1128
            const int startPos = currentFile->startOf(m_literal);
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
            QString replacement(QLatin1String("tr("));
            if (m_option == useQCoreApplicationTranslate) {
                replacement = QLatin1String("QCoreApplication::translate(\"")
                        + m_context + QLatin1String("\", ");
            } else if (m_option == useMacro) {
                replacement = QLatin1String("QT_TRANSLATE_NOOP(\"")
                        + m_context + QLatin1String("\", ");
            }

            changes.insert(startPos, replacement);
1139
            changes.insert(currentFile->endOf(m_literal), QLatin1String(")"));
1140

1141 1142
            currentFile->setChangeSet(changes);
            currentFile->apply();
1143 1144 1145 1146 1147 1148 1149 1150 1151
        }

    private:
        ExpressionAST *m_literal;
        TranslationOption m_option;
        QString m_context;
    };
};

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/**
 * Replace
 *    "abcd"
 *    QLatin1String("abcd")
 *    QLatin1Literal("abcd")
 * With
 *    @"abcd"
 *
 * Activates on: the string literal, if the file type is a Objective-C(++) file.
 */
1162