cppquickfixes.cpp 59.2 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
30 31 32
**
**************************************************************************/

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

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

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

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

using namespace CppEditor;
using namespace CppEditor::Internal;
72
using namespace CppTools;
73 74 75 76 77 78 79 80 81 82 83
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)
84 85

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

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

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

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

        QString replacement;

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

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

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

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

/*
    Rewrite
    a op b

    As
    b flipop a
192 193

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

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

        Kind flipToken;
212
        switch (file->tokenAt(binary->binary_op_token).kind()) {
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 241
        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
242
        result.append(QuickFixOperation::Ptr(new Operation(interface, index, binary, replacement)));
243 244 245 246 247 248 249
        return result;
    }

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

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

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

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

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

/*
    Rewrite
    !a && !b

    As
    !(a || b)
291 292

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

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

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

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

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

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

private:
    ASTMatcher matcher;
};

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

    As
    int *a;
    int b;
377 378

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

        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;

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

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

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

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

                break;
            }
        }

        return result;
    }

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

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

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

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

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

                prevDeclarator = declarator;
            }

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

    private:
        SimpleDeclarationAST *declaration;
    };
};

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

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

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

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

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

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

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

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

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

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

    private:
        StatementAST *_statement;
    };
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        ASTMatcher matcher;
        ASTPatternBuilder mk;
734
        CPPEditorWidget *editor;
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 760
        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;
761 762

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

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

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

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

        return noResult();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1097
        virtual void performChanges(const CppRefactoringFilePtr &currentFile, const CppRefactoringChanges &)
1098 1099 1100
        {
            ChangeSet changes;

1101
            const int startPos = currentFile->startOf(m_literal);
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
            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);
1112
            changes.insert(currentFile->endOf(m_literal), QLatin1String(")"));
1113

1114 1115
            currentFile->setChangeSet(changes);
            currentFile->apply();
1116 1117 1118 1119 1120 1121 1122 1123 1124
        }

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

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
/**
 * Replace
 *    "abcd"
 *    QLatin1String("abcd")
 *    QLatin1Literal("abcd")
 * With
 *    @"abcd"
 *
 * Activates on: the string literal, if the file type is a Objective-C(++) file.
 */
1135 1136 1137
class CStringToNSString: public CppQuickFixFactory
{
public:
Leandro Melo's avatar
Leandro Melo committed
1138
    virtual QList<CppQuickFixOperation::Ptr> match(const QSharedPointer<const CppQuickFixAssistInterface> &interface)
1139
    {
1140
        CppRefactoringFilePtr file = interface->currentFile();
1141

Leandro Melo's avatar
Leandro Melo committed
1142
        if (interface->editor()->mimeType() != CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE)
1143 1144 1145 1146
            return noResult();

        StringLiteralAST *stringLiteral = 0;
        CallAST *qlatin1Call = 0;
Leandro Melo's avatar
Leandro Melo committed
1147
        const QList<AST *> &path = interface->path();
1148 1149 1150 1151 1152 1153 1154 1155 1156

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

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

        if (! stringLiteral)
            return noResult();

1157
        else if (file->charAt(file->startOf(stringLiteral)) == QLatin1Char('@'))
1158 1159 1160 1161 1162
            return noResult(); // it's already an objc string literal.

        else if (path.size() > 1) {
            if (CallAST *call = path.at(path.size() - 2)->asCall()) {
                if (call->base_expression) {
Roberto Raggi's avatar
Roberto Raggi committed
1163 1164
                    if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                        if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
1165
                            const QByteArray id(interface->currentFile()->tokenAt(functionName->identifier_token).identifier->chars());
1166

Roberto Raggi's avatar
Roberto Raggi committed
1167 1168 1169
                            if (id == "QLatin1String" || id == "QLatin1Literal")
                                qlatin1Call = call;
                        }
1170 1171 1172 1173 1174
                    }
                }
            }
        }

Leandro Melo's avatar
Leandro Melo committed
1175
        return singleResult(new Operation(interface, path.size() - 1, stringLiteral, qlatin1Call));