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
#include <cpptools/cpptoolsreuse.h>
64 65
#include <extensionsystem/iplugin.h>

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

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

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

83 84 85 86 87 88 89
namespace {

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

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

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

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

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

        QString replacement;

    public:
Leandro Melo's avatar
Leandro Melo committed
147 148 149
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface,
            int priority, BinaryExpressionAST *binary, Kind invertToken)
            : CppQuickFixOperation(interface, priority)
150
            , binary(binary), nested(0), negation(0)
151 152 153 154 155 156 157
        {
            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
158
                nested = interface->path()[priority - 1]->asNestedExpression();
159 160 161

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

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

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

/*
    Rewrite
    a op b

    As
    b flipop a
198 199

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

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

        Kind flipToken;
218
        switch (file->tokenAt(binary->binary_op_token).kind()) {
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 247
        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
248
        result.append(QuickFixOperation::Ptr(new Operation(interface, index, binary, replacement)));
249 250 251 252 253 254 255
        return result;
    }

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

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

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

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

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

/*
    Rewrite
    !a && !b

    As
    !(a || b)
297 298

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

        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
320
        if (! interface->isCursorOn(expression->binary_op_token))
321 322
            return result;

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

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

355
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
356 357
        {
            ChangeSet changes;
358 359 360 361 362
            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);
363 364 365
            changes.insert(start, QLatin1String("!("));
            changes.insert(end, QLatin1String(")"));

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

private:
    ASTMatcher matcher;
};

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

    As
    int *a;
    int b;
383 384

    Activates on: the type or the variable names.
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 415
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
416
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
417 418 419
    {
        QList<CppQuickFixOperation::Ptr> result;
        CoreDeclaratorAST *core_declarator = 0;
Leandro Melo's avatar
Leandro Melo committed
420
        const QList<AST *> &path = interface->path();
421
        CppRefactoringFilePtr file = interface->currentFile();
422 423 424 425 426 427 428 429 430 431 432

        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;

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

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

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

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

                break;
            }
        }

        return result;
    }

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

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

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

            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(" "));
485
                changes.move(currentFile->range(declarator), insertPos);
486 487
                changes.insert(insertPos, QLatin1String(";"));

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

                prevDeclarator = declarator;
            }

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

    private:
        SimpleDeclarationAST *declaration;
    };
};

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

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

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

        // 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
527
        if (ifStatement && interface->isCursorOn(ifStatement->if_token) && ifStatement->statement
528
            && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
529
            return singleResult(new Operation(interface, index, ifStatement->statement));
530 531 532 533 534 535 536
        }

        // 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
537
                && interface->isCursorOn(ifStatement->statement)
538
                && ! ifStatement->statement->asCompoundStatement()) {
Leandro Melo's avatar
Leandro Melo committed
539
                return singleResult(new Operation(interface, index, ifStatement->statement));
540 541 542 543 544 545 546 547 548 549 550 551 552
            }
        }

        // ### 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
553 554
        Operation(const QSharedPointer<const CppQuickFixAssistInterface> &interface, int priority, StatementAST *statement)
            : CppQuickFixOperation(interface, priority)
555 556 557 558 559 560
            , _statement(statement)
        {
            setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Add Curly Braces"));
        }

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

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

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

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

    private:
        StatementAST *_statement;
    };
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        ASTMatcher matcher;
        ASTPatternBuilder mk;
740
        CPPEditorWidget *editor;
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 766
        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;
767 768

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

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

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

            // 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
811 812
            if (interface->isCursorOn(condition->binary_op_token))
                return singleResult(new Operation(interface, index, pattern, condition));
813 814 815 816 817 818 819 820 821
        }

        return noResult();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        if (! literal) {
            literal = path.last()->asNumericLiteral();
932
            if (!literal || !file->tokenAt(literal->asNumericLiteral()->literal_token).is(T_CHAR_LITERAL))
933 934 935 936 937 938 939 940 941 942
                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
943 944
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
945
                            const QByteArray id(file->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
946 947

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

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

        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;
984 985 986 987 988 989
    }

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

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

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

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

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

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

1023 1024 1025 1026 1027 1028 1029 1030 1031
};

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

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

Leandro Melo's avatar
Leandro Melo committed
1041
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
1042
    {
Leandro Melo's avatar
Leandro Melo committed
1043
        const QList<AST *> &path = interface->path();
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
        // 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
1059 1060
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
1061
                            const QByteArray id(interface->currentFile()->tokenAt(functionName->identifier_token).identifier->chars());
Roberto Raggi's avatar
Roberto Raggi committed
1062 1063 1064 1065

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

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

        // 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
1082
                ClassOrNamespace *b = interface->context().lookupType(function);
1083 1084 1085 1086 1087 1088
                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
1089
                            return singleResult(new Operation(interface, path.size() - 1, literal, useTr, trContext));
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
                        }
                    }
                }
                // 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
1104
                return singleResult(new Operation(interface, path.size() - 1, literal, useQCoreApplicationTranslate, trContext));
1105 1106 1107 1108
            }
        }

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

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

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

1129
            const int startPos = currentFile->startOf(m_literal);
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
            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);
1140
            changes.insert(currentFile->endOf(m_literal), QLatin1String(")"));
1141

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

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

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