cppquickfixes.cpp 59.1 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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

#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>
60
#include <cpptools/cpprefactoringchanges.h>
61
#include <cpptools/insertionpointlocator.h>
62 63
#include <extensionsystem/iplugin.h>

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

using namespace CppEditor;
using namespace CppEditor::Internal;
71
using namespace CppTools;
72 73 74 75 76 77 78 79 80 81 82
using namespace TextEditor;
using namespace CPlusPlus;
using namespace Utils;

namespace {

/*
    Rewrite
    a op b -> !(a invop b)
    (a op b) -> !(a invop b)
    !(a op b) -> (a invob b)
83 84

    Activates on: <= < > >= == !=
85 86 87 88
*/
class UseInverseOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
89
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
90 91
    {
        QList<CppQuickFixOperation::Ptr> result;
92
        CppRefactoringFilePtr file = interface->currentFile();
93

Leandro Melo's avatar
Leandro Melo committed
94
        const QList<AST *> &path = interface->path();
95 96 97 98
        int index = path.size() - 1;
        BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
        if (! binary)
            return result;
Leandro Melo's avatar
Leandro Melo committed
99
        if (! interface->isCursorOn(binary->binary_op_token))
100 101 102
            return result;

        Kind invertToken;
103
        switch (file->tokenAt(binary->binary_op_token).kind()) {
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
        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
126
        result.append(CppQuickFixOperation::Ptr(new Operation(interface, index, binary, invertToken)));
127 128 129 130 131 132 133 134 135 136 137 138 139
        return result;
    }

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

        QString replacement;

    public:
Leandro Melo's avatar
Leandro Melo committed
140 141 142
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface,
            int priority, BinaryExpressionAST *binary, Kind invertToken)
            : CppQuickFixOperation(interface, priority)
143
            , binary(binary), nested(0), negation(0)
144 145 146 147 148 149 150
        {
            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
151
                nested = interface->path()[priority - 1]->asNestedExpression();
152 153 154

            // check for ! before parentheses
            if (nested && priority - 2 >= 0) {
Leandro Melo's avatar
Leandro Melo committed
155
                negation = interface->path()[priority - 2]->asUnaryExpression();
156
                if (negation && ! interface->currentFile()->tokenAt(negation->unary_op_token).is(T_EXCLAIM))
157 158 159 160 161 162 163 164 165
                    negation = 0;
            }
        }

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

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

/*
    Rewrite
    a op b

    As
    b flipop a
191 192

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

        int index = path.size() - 1;
        BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
        if (! binary)
            return result;
Leandro Melo's avatar
Leandro Melo committed
207
        if (! interface->isCursorOn(binary->binary_op_token))
208 209 210
            return result;

        Kind flipToken;
211
        switch (file->tokenAt(binary->binary_op_token).kind()) {
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
        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
241
        result.append(QuickFixOperation::Ptr(new Operation(interface, index, binary, replacement)));
242 243 244 245 246 247 248
        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
249 250 251
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface,
                  int priority, BinaryExpressionAST *binary, QString replacement)
            : CppQuickFixOperation(interface)
252 253 254 255 256 257 258 259 260 261 262 263 264 265
            , 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);
        }

266
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
267 268 269
        {
            ChangeSet changes;

270
            changes.flip(currentFile->range(binary->left_expression), currentFile->range(binary->right_expression));
271
            if (! replacement.isEmpty())
272
                changes.replace(currentFile->range(binary->binary_op_token), replacement);
273

274 275
            currentFile->setChangeSet(changes);
            currentFile->apply();
276 277 278 279 280 281 282 283 284 285 286 287 288 289
        }

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

/*
    Rewrite
    !a && !b

    As
    !(a || b)
290 291

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

        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
313
        if (! interface->isCursorOn(expression->binary_op_token))
314 315
            return result;

Leandro Melo's avatar
Leandro Melo committed
316
        QSharedPointer<Operation> op(new Operation(interface));
317 318

        if (expression->match(op->pattern, &matcher) &&
319 320 321
                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)) {
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
            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
339 340
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
341 342 343 344 345 346 347
            , mk(new ASTPatternBuilder)
        {
            left = mk->UnaryExpression();
            right = mk->UnaryExpression();
            pattern = mk->BinaryExpression(left, right);
        }

348
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
349 350
        {
            ChangeSet changes;
351 352 353 354 355
            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);
356 357 358
            changes.insert(start, QLatin1String("!("));
            changes.insert(end, QLatin1String(")"));

359 360 361
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
362 363 364 365 366 367 368
        }
    };

private:
    ASTMatcher matcher;
};

369 370 371 372 373 374 375
/*
    Rewrite
    int *a, b;

    As
    int *a;
    int b;
376 377

    Activates on: the type or the variable names.
378
*/
379 380 381 382 383 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
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
409
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
410 411 412
    {
        QList<CppQuickFixOperation::Ptr> result;
        CoreDeclaratorAST *core_declarator = 0;
Leandro Melo's avatar
Leandro Melo committed
413
        const QList<AST *> &path = interface->path();
414
        CppRefactoringFilePtr file = interface->currentFile();
415 416 417 418 419 420 421 422 423 424 425

        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;

426
                    const int cursorPosition = file->cursor().selectionStart();
427

428 429
                    const int startOfDeclSpecifier = file->startOf(declaration->decl_specifier_list->firstToken());
                    const int endOfDeclSpecifier = file->endOf(declaration->decl_specifier_list->lastToken() - 1);
430 431 432

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

Leandro Melo's avatar
Leandro Melo committed
436
                    if (core_declarator && interface->isCursorOn(core_declarator)) {
437
                        // got a core-declarator under the text cursor.
Leandro Melo's avatar
Leandro Melo committed
438
                        return singleResult(new Operation(interface, index, declaration));
439 440 441 442 443 444 445 446 447 448 449 450 451 452
                    }
                }

                break;
            }
        }

        return result;
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
453 454
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, SimpleDeclarationAST *decl)
            : CppQuickFixOperation(interface, priority)
455 456 457 458 459 460
            , declaration(decl)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Split Declaration"));
        }

461
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
462 463 464 465
        {
            ChangeSet changes;

            SpecifierListAST *specifiers = declaration->decl_specifier_list;
466 467 468
            int declSpecifiersStart = currentFile->startOf(specifiers->firstToken());
            int declSpecifiersEnd = currentFile->endOf(specifiers->lastToken() - 1);
            int insertPos = currentFile->endOf(declaration->semicolon_token);
469 470 471 472 473 474 475 476 477

            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(" "));
478
                changes.move(currentFile->range(declarator), insertPos);
479 480
                changes.insert(insertPos, QLatin1String(";"));

481 482
                const int prevDeclEnd = currentFile->endOf(prevDeclarator);
                changes.remove(prevDeclEnd, currentFile->startOf(declarator));
483 484 485 486

                prevDeclarator = declarator;
            }

487 488 489
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(declaration));
            currentFile->apply();
490 491 492 493 494 495 496 497 498
        }

    private:
        SimpleDeclarationAST *declaration;
    };
};

/*
    Add curly braces to a if statement that doesn't already contain a
499 500 501 502 503 504 505 506
    compound statement. I.e.

    if (a)
        b;
    becomes
    if (a) {
        b;
    }
507 508

    Activates on: the if
509 510 511 512
*/
class AddBracesToIfOp: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
513
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
514
    {
Leandro Melo's avatar
Leandro Melo committed
515
        const QList<AST *> &path = interface->path();
516 517 518 519

        // 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
520
        if (ifStatement && interface->isCursorOn(ifStatement->if_token) && ifStatement->statement
521
            && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
522
            return singleResult(new Operation(interface, index, ifStatement->statement));
523 524 525 526 527 528 529
        }

        // 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
530
                && interface->isCursorOn(ifStatement->statement)
531
                && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
532
                return singleResult(new Operation(interface, index, ifStatement->statement));
533 534 535 536 537 538 539 540 541 542 543 544 545
            }
        }

        // ### 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
546 547
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, StatementAST *statement)
            : CppQuickFixOperation(interface, priority)
548 549 550 551 552 553
            , _statement(statement)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Add Curly Braces"));
        }

554
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
555 556 557
        {
            ChangeSet changes;

558
            const int start = currentFile->endOf(_statement->firstToken() - 1);
559 560
            changes.insert(start, QLatin1String(" {"));

561
            const int end = currentFile->endOf(_statement->lastToken() - 1);
562 563
            changes.insert(end, "\n}");

564 565 566
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(Utils::ChangeSet::Range(start, end));
            currentFile->apply();
567 568 569 570 571 572 573 574 575 576 577 578 579 580
        }

    private:
        StatementAST *_statement;
    };
};

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

    With
    Type name = foo;
    if (name) {...}
581 582

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

        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
601
                    if (interface->isCursorOn(op->core)) {
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
                        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
618 619
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
620 621 622 623 624 625 626 627
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Move Declaration out of Condition"));

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

628
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
629 630 631
        {
            ChangeSet changes;

632
            changes.copy(currentFile->range(core), currentFile->startOf(condition));
633

634 635
            int insertPos = currentFile->startOf(pattern);
            changes.move(currentFile->range(condition), insertPos);
636 637
            changes.insert(insertPos, QLatin1String(";\n"));

638 639 640
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
641 642 643 644
        }

        ASTMatcher matcher;
        ASTPatternBuilder mk;
645
        CPPEditorWidget *editor;
646 647 648 649 650 651 652 653 654 655 656 657 658
        ConditionAST *condition;
        IfStatementAST *pattern;
        CoreDeclaratorAST *core;
    };
};

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

    With
    Type name;
    while ((name = foo()) != 0) {...}
659 660

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

        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();

680
                    else if (! declarator->equal_token)
681 682 683 684 685
                        return noResult();

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

Leandro Melo's avatar
Leandro Melo committed
686
                    if (interface->isCursorOn(op->core)) {
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
                        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
703 704
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
            : CppQuickFixOperation(interface)
705 706 707 708 709 710 711 712
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Move Declaration out of Condition"));

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

713
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
714 715 716
        {
            ChangeSet changes;

717 718
            changes.insert(currentFile->startOf(condition), QLatin1String("("));
            changes.insert(currentFile->endOf(condition), QLatin1String(") != 0"));
719

720 721 722 723
            int insertPos = currentFile->startOf(pattern);
            const int conditionStart = currentFile->startOf(condition);
            changes.move(conditionStart, currentFile->startOf(core), insertPos);
            changes.copy(currentFile->range(core), insertPos);
724 725
            changes.insert(insertPos, QLatin1String(";\n"));

726 727 728
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
729 730 731 732
        }

        ASTMatcher matcher;
        ASTPatternBuilder mk;
733
        CPPEditorWidget *editor;
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
        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;
760 761

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

        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();

790
            Token binaryToken = interface->currentFile()->tokenAt(condition->binary_op_token);
791 792 793 794 795 796 797 798 799 800 801 802 803

            // 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
804 805
            if (interface->isCursorOn(condition->binary_op_token))
                return singleResult(new Operation(interface, index, pattern, condition));
806 807 808 809 810 811 812 813 814
        }

        return noResult();
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
815
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority,
816
                  IfStatementAST *pattern, BinaryExpressionAST *condition)
Leandro Melo's avatar
Leandro Melo committed
817
            : CppQuickFixOperation(interface, priority)
818 819 820 821 822 823 824
            , pattern(pattern)
            , condition(condition)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Split if Statement"));
        }

825
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
826
        {
827
            const Token binaryToken = currentFile->tokenAt(condition->binary_op_token);
828 829

            if (binaryToken.is(T_AMPER_AMPER))
830
                splitAndCondition(currentFile);
831
            else
832
                splitOrCondition(currentFile);
833 834
        }

835
        void splitAndCondition(CppRefactoringFilePtr currentFile)
836 837 838
        {
            ChangeSet changes;

839
            int startPos = currentFile->startOf(pattern);
840
            changes.insert(startPos, QLatin1String("if ("));
841
            changes.move(currentFile->range(condition->left_expression), startPos);
842 843
            changes.insert(startPos, QLatin1String(") {\n"));

844 845 846
            const int lExprEnd = currentFile->endOf(condition->left_expression);
            changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));
            changes.insert(currentFile->endOf(pattern), QLatin1String("\n}"));
847

848 849 850
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
851 852
        }

853
        void splitOrCondition(CppRefactoringFilePtr currentFile)
854 855 856 857 858 859
        {
            ChangeSet changes;

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

860
            int insertPos = currentFile->endOf(ifTrueStatement);
861 862 863 864 865 866
            if (compoundStatement)
                changes.insert(insertPos, QLatin1String(" "));
            else
                changes.insert(insertPos, QLatin1String("\n"));
            changes.insert(insertPos, QLatin1String("else if ("));

867 868
            const int rExprStart = currentFile->startOf(condition->right_expression);
            changes.move(rExprStart, currentFile->startOf(pattern->rparen_token), insertPos);
869 870
            changes.insert(insertPos, QLatin1String(")"));

871 872
            const int rParenEnd = currentFile->endOf(pattern->rparen_token);
            changes.copy(rParenEnd, currentFile->endOf(pattern->statement), insertPos);
873

874 875
            const int lExprEnd = currentFile->endOf(condition->left_expression);
            changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));
876

877 878 879
            currentFile->setChangeSet(changes);
            currentFile->appendIndentRange(currentFile->range(pattern));
            currentFile->apply();
880 881 882 883 884 885 886 887 888 889
        }

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

/*
  Replace
890
    "abcd" -> QLatin1String("abcd")
891
    @"abcd" -> QLatin1String("abcd")
892 893 894 895
    'a' -> QLatin1Char('a')
  Except if they are already enclosed in
    QLatin1Char, QT_TRANSLATE_NOOP, tr,
    trUtf8, QLatin1Literal, QLatin1String
896 897

    Activates on: the string literal
898 899 900 901 902 903
*/
class WrapStringLiteral: public CppQuickFixFactory
{
public:
    enum Type { TypeString, TypeObjCString, TypeChar, TypeNone };

Leandro Melo's avatar
Leandro Melo committed
904
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
905 906 907
    {
        ExpressionAST *literal = 0;
        Type type = TypeNone;
Leandro Melo's avatar
Leandro Melo committed
908
        const QList<AST *> &path = interface->path();
909
        CppRefactoringFilePtr file = interface->currentFile();
910 911 912 913 914 915 916 917

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

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

        if (! literal) {
            literal = path.last()->asNumericLiteral();
918
            if (!literal || !file->tokenAt(literal->asNumericLiteral()->literal_token).is(T_CHAR_LITERAL))
919 920 921 922 923 924 925 926 927 928
                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
929 930
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
931
                            const QByteArray id(file->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
932 933 934 935 936 937

                            if (id == "QT_TRANSLATE_NOOP" || id == "tr" || id == "trUtf8"
                                    || (type == TypeString && (id == "QLatin1String" || id == "QLatin1Literal"))
                                    || (type == TypeChar && id == "QLatin1Char"))
                                return noResult(); // skip it
                        }
938 939 940 941 942 943
                    }
                }
            }
        }

        if (type == TypeString) {
944
            if (file->charAt(file->startOf(literal)) == QLatin1Char('@'))
945 946
                type = TypeObjCString;
        }
Leandro Melo's avatar
Leandro Melo committed
947
        return singleResult(new Operation(interface,
948 949 950 951 952 953 954 955 956
                                          path.size() - 1, // very high priority
                                          type,
                                          literal));
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
957
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, Type type,
958
                  ExpressionAST *literal)
Leandro Melo's avatar
Leandro Melo committed
959
            : CppQuickFixOperation(interface, priority)
960 961 962 963 964 965 966 967 968 969 970
            , type(type)
            , literal(literal)
        {
            if (type == TypeChar)
                setDescription(QApplication::translate("CppTools::QuickFix",
                                                       "Enclose in QLatin1Char(...)"));
            else
                setDescription(QApplication::translate("CppTools::QuickFix",
                                                       "Enclose in QLatin1String(...)"));
        }

971
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
972 973 974
        {
            ChangeSet changes;

975
            const int startPos = currentFile->startOf(literal);
976 977 978 979 980 981 982 983
            QLatin1String replacement = (type == TypeChar ? QLatin1String("QLatin1Char(")
                                                          : QLatin1String("QLatin1String("));

            if (type == TypeObjCString)
                changes.replace(startPos, startPos + 1, replacement);
            else
                changes.insert(startPos, replacement);

984
            changes.insert(currentFile->endOf(literal), ")");
985

986 987
            currentFile->setChangeSet(changes);
            currentFile->apply();
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
        }

    private:
        Type type;
        ExpressionAST *literal;
    };
};

/*
  Replace
    "abcd"
  With
    tr("abcd") or
    QCoreApplication::translate("CONTEXT", "abcd") or
    QT_TRANSLATE_NOOP("GLOBAL", "abcd")
1003
  depending on what is available.
1004 1005

    Activates on: the string literal
1006 1007 1008 1009 1010 1011
*/
class TranslateStringLiteral: public CppQuickFixFactory
{
public:
    enum TranslationOption { unknown, useTr, useQCoreApplicationTranslate, useMacro };

Leandro Melo's avatar
Leandro Melo committed
1012
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
1013
    {
Leandro Melo's avatar
Leandro Melo committed
1014
        const QList<AST *> &path = interface->path();
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
        // 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
1030 1031
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
1032
                            const QByteArray id(interface->currentFile()->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
1033 1034 1035 1036 1037 1038 1039

                            if (id == "tr" || id == "trUtf8"
                                    || id == "translate"
                                    || id == "QT_TRANSLATE_NOOP"
                                    || id == "QLatin1String" || id == "QLatin1Literal")
                                return noResult(); // skip it
                        }
1040 1041 1042 1043 1044
                    }
                }
            }
        }

Leandro Melo's avatar
Leandro Melo committed
1045
        QSharedPointer<Control> control = interface->context().control();
1046
        const Name *trName = control->identifier("tr");
1047 1048 1049 1050 1051 1052

        // 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
1053
                ClassOrNamespace *b = interface->context().lookupType(function);
1054 1055 1056 1057 1058 1059
                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
1060
                            return singleResult(new Operation(interface, path.size() - 1, literal, useTr, trContext));
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
                        }
                    }
                }
                // 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
1075
                return singleResult(new Operation(interface, path.size() - 1, literal, useQCoreApplicationTranslate, trContext));
1076 1077 1078 1079
            }
        }

        // We need to use Q_TRANSLATE_NOOP
Leandro Melo's avatar
Leandro Melo committed
1080
        return singleResult(new Operation(interface, path.size() - 1, literal, useMacro, QLatin1String("GLOBAL")));
1081 1082 1083 1084 1085 1086
    }

private:
    class Operation: public CppQuickFixOperation
    {
    public:
Leandro Melo's avatar
Leandro Melo committed
1087 1088
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, ExpressionAST *literal, TranslationOption option, const QString &context)
            : CppQuickFixOperation(interface, priority)
1089 1090 1091 1092
            , m_literal(literal)
            , m_option(option)
            , m_context(context)
        {
1093
            setDescription(QApplication::translate("CppTools::QuickFix", "Mark as Translatable"));
1094 1095
        }