cppquickfixes.cpp 73.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29

Nikolai Kosjar's avatar
Nikolai Kosjar committed
30 31
#include "cppquickfixes.h"

32
#include "cppcompleteswitch.h"
33
#include "cppeditor.h"
34
#include "cppinsertdecldef.h"
35
#include "cppinsertqtpropertymembers.h"
Leandro Melo's avatar
Leandro Melo committed
36
#include "cppquickfixassistant.h"
37

38
#include <cpptools/cppclassesfilter.h>
39
#include <cpptools/cppcodestylesettings.h>
40 41
#include <cpptools/cpppointerdeclarationformatter.h>
#include <cpptools/cpptoolsconstants.h>
42
#include <cpptools/symbolfinder.h>
43 44 45 46 47

#include <cplusplus/CppRewriter.h>
#include <cplusplus/DependencyTable.h>
#include <cplusplus/TypeOfExpression.h>

48
#include <extensionsystem/pluginmanager.h>
49 50
#include <utils/qtcassert.h>

51
#include <QApplication>
52
#include <QFileInfo>
Nikolai Kosjar's avatar
Nikolai Kosjar committed
53
#include <QSharedPointer>
54 55
#include <QTextBlock>
#include <QTextCursor>
56

Nikolai Kosjar's avatar
Nikolai Kosjar committed
57 58
#include <cctype>

59 60
using namespace CppEditor;
using namespace CppEditor::Internal;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

void CppEditor::Internal::registerQuickFixes(ExtensionSystem::IPlugin *plugIn)
{
    plugIn->addAutoReleasedObject(new AddIncludeForUndefinedIdentifier);
    plugIn->addAutoReleasedObject(new AddIncludeForForwardDeclaration);

    plugIn->addAutoReleasedObject(new FlipLogicalOperands);
    plugIn->addAutoReleasedObject(new InverseLogicalComparison);
    plugIn->addAutoReleasedObject(new RewriteLogicalAnd);

    plugIn->addAutoReleasedObject(new ConvertToCamelCase);

    plugIn->addAutoReleasedObject(new ConvertCStringToNSString);
    plugIn->addAutoReleasedObject(new ConvertNumericLiteral);
    plugIn->addAutoReleasedObject(new TranslateStringLiteral);
    plugIn->addAutoReleasedObject(new WrapStringLiteral);

    plugIn->addAutoReleasedObject(new MoveDeclarationOutOfIf);
    plugIn->addAutoReleasedObject(new MoveDeclarationOutOfWhile);

    plugIn->addAutoReleasedObject(new SplitIfStatement);
    plugIn->addAutoReleasedObject(new SplitSimpleDeclaration);

    plugIn->addAutoReleasedObject(new AddLocalDeclaration);
    plugIn->addAutoReleasedObject(new AddBracesToIf);
    plugIn->addAutoReleasedObject(new RearrangeParamDeclarationList);
    plugIn->addAutoReleasedObject(new ReformatPointerDeclaration);

    plugIn->addAutoReleasedObject(new CompleteSwitchCaseStatement);
    plugIn->addAutoReleasedObject(new InsertQtPropertyMembers);

    plugIn->addAutoReleasedObject(new ApplyDeclDefLinkChanges);
    plugIn->addAutoReleasedObject(new ExtractFunction);
    plugIn->addAutoReleasedObject(new GenerateGetterSetter);
    plugIn->addAutoReleasedObject(new InsertDeclFromDef);
    plugIn->addAutoReleasedObject(new InsertDefFromDecl);
}
98

99 100 101 102 103
static inline bool isQtStringLiteral(const QByteArray &id)
{
    return id == "QLatin1String" || id == "QLatin1Literal" || id == "QStringLiteral";
}

104 105 106 107 108
static inline bool isQtStringTranslation(const QByteArray &id)
{
    return id == "tr" || id == "trUtf8" || id == "translate" || id == "QT_TRANSLATE_NOOP";
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
109
class InverseLogicalComparisonOp: public CppQuickFixOperation
110 111
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
112 113 114 115
    InverseLogicalComparisonOp(const CppQuickFixInterface &interface, int priority,
                               BinaryExpressionAST *binary, Kind invertToken)
        : CppQuickFixOperation(interface, priority)
        , binary(binary), nested(0), negation(0)
116
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
117 118 119
        Token tok;
        tok.f.kind = invertToken;
        replacement = QLatin1String(tok.spell());
120

Nikolai Kosjar's avatar
Nikolai Kosjar committed
121 122 123
        // check for enclosing nested expression
        if (priority - 1 >= 0)
            nested = interface->path()[priority - 1]->asNestedExpression();
124

Nikolai Kosjar's avatar
Nikolai Kosjar committed
125 126 127 128 129
        // check for ! before parentheses
        if (nested && priority - 2 >= 0) {
            negation = interface->path()[priority - 2]->asUnaryExpression();
            if (negation && ! interface->currentFile()->tokenAt(negation->unary_op_token).is(T_EXCLAIM))
                negation = 0;
130 131 132
        }
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
133
    QString description() const
134
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
135 136
        return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
137

Nikolai Kosjar's avatar
Nikolai Kosjar committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());

        ChangeSet changes;
        if (negation) {
            // can't remove parentheses since that might break precedence
            changes.remove(currentFile->range(negation->unary_op_token));
        } else if (nested) {
            changes.insert(currentFile->startOf(nested), QLatin1String("!"));
        } else {
            changes.insert(currentFile->startOf(binary), QLatin1String("!("));
            changes.insert(currentFile->endOf(binary), QLatin1String(")"));
152
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
153 154 155 156
        changes.replace(currentFile->range(binary->binary_op_token), replacement);
        currentFile->setChangeSet(changes);
        currentFile->apply();
    }
157

Nikolai Kosjar's avatar
Nikolai Kosjar committed
158 159 160 161
private:
    BinaryExpressionAST *binary;
    NestedExpressionAST *nested;
    UnaryExpressionAST *negation;
162

Nikolai Kosjar's avatar
Nikolai Kosjar committed
163
    QString replacement;
164 165
};

Nikolai Kosjar's avatar
Nikolai Kosjar committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
void InverseLogicalComparison::match(const CppQuickFixInterface &interface,
                                     QuickFixOperations &result)
{
    CppRefactoringFilePtr file = interface->currentFile();

    const QList<AST *> &path = interface->path();
    int index = path.size() - 1;
    BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
    if (! binary)
        return;
    if (! interface->isCursorOn(binary->binary_op_token))
        return;

    Kind invertToken;
    switch (file->tokenAt(binary->binary_op_token).kind()) {
    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;
    }
202

Nikolai Kosjar's avatar
Nikolai Kosjar committed
203 204 205
    result.append(CppQuickFixOperation::Ptr(
        new InverseLogicalComparisonOp(interface, index, binary, invertToken)));
}
206

Nikolai Kosjar's avatar
Nikolai Kosjar committed
207
class FlipLogicalOperandsOp: public CppQuickFixOperation
208 209
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
210 211 212 213 214
    FlipLogicalOperandsOp(const CppQuickFixInterface &interface, int priority,
                          BinaryExpressionAST *binary, QString replacement)
        : CppQuickFixOperation(interface)
        , binary(binary)
        , replacement(replacement)
215
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
216 217
        setPriority(priority);
    }
218

Nikolai Kosjar's avatar
Nikolai Kosjar committed
219 220 221 222 223 224 225
    QString description() const
    {
        if (replacement.isEmpty())
            return QApplication::translate("CppTools::QuickFix", "Swap Operands");
        else
            return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
226

Nikolai Kosjar's avatar
Nikolai Kosjar committed
227 228 229 230
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
231

Nikolai Kosjar's avatar
Nikolai Kosjar committed
232 233 234 235
        ChangeSet changes;
        changes.flip(currentFile->range(binary->left_expression), currentFile->range(binary->right_expression));
        if (! replacement.isEmpty())
            changes.replace(currentFile->range(binary->binary_op_token), replacement);
236

Nikolai Kosjar's avatar
Nikolai Kosjar committed
237 238
        currentFile->setChangeSet(changes);
        currentFile->apply();
239 240 241
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
242 243 244
    BinaryExpressionAST *binary;
    QString replacement;
};
245

Nikolai Kosjar's avatar
Nikolai Kosjar committed
246 247 248 249
void FlipLogicalOperands::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
250

Nikolai Kosjar's avatar
Nikolai Kosjar committed
251 252 253 254 255 256
    int index = path.size() - 1;
    BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
    if (! binary)
        return;
    if (! interface->isCursorOn(binary->binary_op_token))
        return;
257

Nikolai Kosjar's avatar
Nikolai Kosjar committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
    Kind flipToken;
    switch (file->tokenAt(binary->binary_op_token).kind()) {
    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;
    }
281

Nikolai Kosjar's avatar
Nikolai Kosjar committed
282 283 284 285 286 287
    QString replacement;
    if (flipToken != T_EOF_SYMBOL) {
        Token tok;
        tok.f.kind = flipToken;
        replacement = QLatin1String(tok.spell());
    }
288

Nikolai Kosjar's avatar
Nikolai Kosjar committed
289 290 291
    result.append(QuickFixOperation::Ptr(
        new FlipLogicalOperandsOp(interface, index, binary, replacement)));
}
292

Nikolai Kosjar's avatar
Nikolai Kosjar committed
293
class RewriteLogicalAndOp: public CppQuickFixOperation
294 295
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
296 297 298 299 300 301 302 303
    QSharedPointer<ASTPatternBuilder> mk;
    UnaryExpressionAST *left;
    UnaryExpressionAST *right;
    BinaryExpressionAST *pattern;

    RewriteLogicalAndOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
        , mk(new ASTPatternBuilder)
304
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
305 306 307 308
        left = mk->UnaryExpression();
        right = mk->UnaryExpression();
        pattern = mk->BinaryExpression(left, right);
    }
309

Nikolai Kosjar's avatar
Nikolai Kosjar committed
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());

        ChangeSet changes;
        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);
        changes.insert(start, QLatin1String("!("));
        changes.insert(end, QLatin1String(")"));

        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
};
329

Nikolai Kosjar's avatar
Nikolai Kosjar committed
330 331 332 333 334
void RewriteLogicalAnd::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    BinaryExpressionAST *expression = 0;
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
335

Nikolai Kosjar's avatar
Nikolai Kosjar committed
336 337 338 339 340
    int index = path.size() - 1;
    for (; index != -1; --index) {
        expression = path.at(index)->asBinaryExpression();
        if (expression)
            break;
341 342
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
343 344
    if (! expression)
        return;
345

Nikolai Kosjar's avatar
Nikolai Kosjar committed
346 347
    if (! interface->isCursorOn(expression->binary_op_token))
        return;
348

Nikolai Kosjar's avatar
Nikolai Kosjar committed
349
    QSharedPointer<RewriteLogicalAndOp> op(new RewriteLogicalAndOp(interface));
350

Nikolai Kosjar's avatar
Nikolai Kosjar committed
351 352 353 354 355 356 357 358 359
    if (expression->match(op->pattern, &matcher) &&
            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)) {
        op->setDescription(QApplication::translate("CppTools::QuickFix", "Rewrite Condition Using ||"));
        op->setPriority(index);
        result.append(op);
    }
}
360

Nikolai Kosjar's avatar
Nikolai Kosjar committed
361 362 363 364
bool SplitSimpleDeclaration::checkDeclaration(SimpleDeclarationAST *declaration)
{
    if (! declaration->semicolon_token)
        return false;
365

Nikolai Kosjar's avatar
Nikolai Kosjar committed
366 367
    if (! declaration->decl_specifier_list)
        return false;
368

Nikolai Kosjar's avatar
Nikolai Kosjar committed
369 370
    for (SpecifierListAST *it = declaration->decl_specifier_list; it; it = it->next) {
        SpecifierAST *specifier = it->value;
371

Nikolai Kosjar's avatar
Nikolai Kosjar committed
372
        if (specifier->asEnumSpecifier() != 0)
373 374
            return false;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
375
        else if (specifier->asClassSpecifier() != 0)
376
            return false;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
377
    }
378

Nikolai Kosjar's avatar
Nikolai Kosjar committed
379 380
    if (! declaration->declarator_list)
        return false;
381

Nikolai Kosjar's avatar
Nikolai Kosjar committed
382 383
    else if (! declaration->declarator_list->next)
        return false;
384

Nikolai Kosjar's avatar
Nikolai Kosjar committed
385 386
    return true;
}
387

Nikolai Kosjar's avatar
Nikolai Kosjar committed
388 389 390 391 392 393 394 395 396 397
class SplitSimpleDeclarationOp: public CppQuickFixOperation
{
public:
    SplitSimpleDeclarationOp(const CppQuickFixInterface &interface, int priority,
                             SimpleDeclarationAST *decl)
        : CppQuickFixOperation(interface, priority)
        , declaration(decl)
    {
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Split Declaration"));
398 399
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
400
    void perform()
401
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
402 403
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
404

Nikolai Kosjar's avatar
Nikolai Kosjar committed
405
        ChangeSet changes;
406

Nikolai Kosjar's avatar
Nikolai Kosjar committed
407 408 409 410
        SpecifierListAST *specifiers = declaration->decl_specifier_list;
        int declSpecifiersStart = currentFile->startOf(specifiers->firstToken());
        int declSpecifiersEnd = currentFile->endOf(specifiers->lastToken() - 1);
        int insertPos = currentFile->endOf(declaration->semicolon_token);
411

Nikolai Kosjar's avatar
Nikolai Kosjar committed
412
        DeclaratorAST *prevDeclarator = declaration->declarator_list->value;
413

Nikolai Kosjar's avatar
Nikolai Kosjar committed
414 415
        for (DeclaratorListAST *it = declaration->declarator_list->next; it; it = it->next) {
            DeclaratorAST *declarator = it->value;
416

Nikolai Kosjar's avatar
Nikolai Kosjar committed
417 418 419 420 421
            changes.insert(insertPos, QLatin1String("\n"));
            changes.copy(declSpecifiersStart, declSpecifiersEnd, insertPos);
            changes.insert(insertPos, QLatin1String(" "));
            changes.move(currentFile->range(declarator), insertPos);
            changes.insert(insertPos, QLatin1String(";"));
422

Nikolai Kosjar's avatar
Nikolai Kosjar committed
423 424
            const int prevDeclEnd = currentFile->endOf(prevDeclarator);
            changes.remove(prevDeclEnd, currentFile->startOf(declarator));
425

Nikolai Kosjar's avatar
Nikolai Kosjar committed
426
            prevDeclarator = declarator;
427
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
428 429 430 431

        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(declaration));
        currentFile->apply();
432 433 434
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
435 436
    SimpleDeclarationAST *declaration;
};
437

Nikolai Kosjar's avatar
Nikolai Kosjar committed
438 439 440 441 442 443 444
void SplitSimpleDeclaration::match(const CppQuickFixInterface &interface,
                                   QuickFixOperations &result)
{
    CoreDeclaratorAST *core_declarator = 0;
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
    const int cursorPosition = file->cursor().selectionStart();
445

Nikolai Kosjar's avatar
Nikolai Kosjar committed
446 447
    for (int index = path.size() - 1; index != -1; --index) {
        AST *node = path.at(index);
448

Nikolai Kosjar's avatar
Nikolai Kosjar committed
449 450
        if (CoreDeclaratorAST *coreDecl = node->asCoreDeclarator())
            core_declarator = coreDecl;
451

Nikolai Kosjar's avatar
Nikolai Kosjar committed
452 453 454
        else if (SimpleDeclarationAST *simpleDecl = node->asSimpleDeclaration()) {
            if (checkDeclaration(simpleDecl)) {
                SimpleDeclarationAST *declaration = simpleDecl;
455

Nikolai Kosjar's avatar
Nikolai Kosjar committed
456 457
                const int startOfDeclSpecifier = file->startOf(declaration->decl_specifier_list->firstToken());
                const int endOfDeclSpecifier = file->endOf(declaration->decl_specifier_list->lastToken() - 1);
458

Nikolai Kosjar's avatar
Nikolai Kosjar committed
459 460 461 462 463 464
                if (cursorPosition >= startOfDeclSpecifier && cursorPosition <= endOfDeclSpecifier) {
                    // the AST node under cursor is a specifier.
                    result.append(QuickFixOperation::Ptr(
                        new SplitSimpleDeclarationOp(interface, index, declaration)));
                    return;
                }
465

Nikolai Kosjar's avatar
Nikolai Kosjar committed
466 467 468 469 470 471
                if (core_declarator && interface->isCursorOn(core_declarator)) {
                    // got a core-declarator under the text cursor.
                    result.append(QuickFixOperation::Ptr(
                        new SplitSimpleDeclarationOp(interface, index, declaration)));
                    return;
                }
472 473
            }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
474
            return;
475
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
476 477
    }
}
478

Nikolai Kosjar's avatar
Nikolai Kosjar committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
class AddBracesToIfOp: public CppQuickFixOperation
{
public:
    AddBracesToIfOp(const CppQuickFixInterface &interface, int priority, StatementAST *statement)
        : CppQuickFixOperation(interface, priority)
        , _statement(statement)
    {
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Add Curly Braces"));
    }

    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());

        ChangeSet changes;
496

Nikolai Kosjar's avatar
Nikolai Kosjar committed
497 498
        const int start = currentFile->endOf(_statement->firstToken() - 1);
        changes.insert(start, QLatin1String(" {"));
499

Nikolai Kosjar's avatar
Nikolai Kosjar committed
500 501
        const int end = currentFile->endOf(_statement->lastToken() - 1);
        changes.insert(end, QLatin1String("\n}"));
502

Nikolai Kosjar's avatar
Nikolai Kosjar committed
503 504 505 506 507 508 509 510 511 512
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(Utils::ChangeSet::Range(start, end));
        currentFile->apply();
    }

private:
    StatementAST *_statement;
};

void AddBracesToIf::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
513
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
514
    const QList<AST *> &path = interface->path();
515

Nikolai Kosjar's avatar
Nikolai Kosjar committed
516 517 518 519 520 521 522 523 524 525 526 527 528
    // show when we're on the 'if' of an if statement
    int index = path.size() - 1;
    IfStatementAST *ifStatement = path.at(index)->asIfStatement();
    if (ifStatement && interface->isCursorOn(ifStatement->if_token) && ifStatement->statement
        && ! ifStatement->statement->asCompoundStatement()) {
        result.append(QuickFixOperation::Ptr(
            new AddBracesToIfOp(interface, index, ifStatement->statement)));
        return;
    }

    // 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) {
529
        IfStatementAST *ifStatement = path.at(index)->asIfStatement();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
530 531
        if (ifStatement && ifStatement->statement
            && interface->isCursorOn(ifStatement->statement)
532
            && ! ifStatement->statement->asCompoundStatement()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
533 534
            result.append(QuickFixOperation::Ptr(
                new AddBracesToIfOp(interface, index, ifStatement->statement)));
535
            return;
536
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
537
    }
538

Nikolai Kosjar's avatar
Nikolai Kosjar committed
539 540 541
    // ### This could very well be extended to the else branch
    // and other nodes entirely.
}
542

Nikolai Kosjar's avatar
Nikolai Kosjar committed
543 544 545 546 547 548 549 550 551 552 553
class MoveDeclarationOutOfIfOp: public CppQuickFixOperation
{
public:
    MoveDeclarationOutOfIfOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
    {
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Move Declaration out of Condition"));

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
556
    void perform()
557
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
558 559
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
560

Nikolai Kosjar's avatar
Nikolai Kosjar committed
561
        ChangeSet changes;
562

Nikolai Kosjar's avatar
Nikolai Kosjar committed
563
        changes.copy(currentFile->range(core), currentFile->startOf(condition));
564

Nikolai Kosjar's avatar
Nikolai Kosjar committed
565 566 567
        int insertPos = currentFile->startOf(pattern);
        changes.move(currentFile->range(condition), insertPos);
        changes.insert(insertPos, QLatin1String(";\n"));
568

Nikolai Kosjar's avatar
Nikolai Kosjar committed
569 570 571 572
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
573

Nikolai Kosjar's avatar
Nikolai Kosjar committed
574 575 576 577 578 579
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    CPPEditorWidget *editor;
    ConditionAST *condition;
    IfStatementAST *pattern;
    CoreDeclaratorAST *core;
580 581
};

Nikolai Kosjar's avatar
Nikolai Kosjar committed
582 583
void MoveDeclarationOutOfIf::match(const CppQuickFixInterface &interface,
                                   QuickFixOperations &result)
584
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
585 586 587 588 589 590 591 592 593 594 595 596
    const QList<AST *> &path = interface->path();
    typedef QSharedPointer<MoveDeclarationOutOfIfOp> Ptr;
    Ptr op(new MoveDeclarationOutOfIfOp(interface));

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
598 599 600 601
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
602 603 604 605
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
606
}
607

Nikolai Kosjar's avatar
Nikolai Kosjar committed
608 609 610 611 612
class MoveDeclarationOutOfWhileOp: public CppQuickFixOperation
{
public:
    MoveDeclarationOutOfWhileOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
613
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
614 615
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Move Declaration out of Condition"));
616

Nikolai Kosjar's avatar
Nikolai Kosjar committed
617 618 619
        condition = mk.Condition();
        pattern = mk.WhileStatement(condition);
    }
620

Nikolai Kosjar's avatar
Nikolai Kosjar committed
621 622 623 624
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
625

Nikolai Kosjar's avatar
Nikolai Kosjar committed
626
        ChangeSet changes;
627

Nikolai Kosjar's avatar
Nikolai Kosjar committed
628 629
        changes.insert(currentFile->startOf(condition), QLatin1String("("));
        changes.insert(currentFile->endOf(condition), QLatin1String(") != 0"));
630

Nikolai Kosjar's avatar
Nikolai Kosjar committed
631 632 633 634 635
        int insertPos = currentFile->startOf(pattern);
        const int conditionStart = currentFile->startOf(condition);
        changes.move(conditionStart, currentFile->startOf(core), insertPos);
        changes.copy(currentFile->range(core), insertPos);
        changes.insert(insertPos, QLatin1String(";\n"));
636

Nikolai Kosjar's avatar
Nikolai Kosjar committed
637 638 639 640
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
641

Nikolai Kosjar's avatar
Nikolai Kosjar committed
642 643 644 645 646 647 648
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    CPPEditorWidget *editor;
    ConditionAST *condition;
    WhileStatementAST *pattern;
    CoreDeclaratorAST *core;
};
649

Nikolai Kosjar's avatar
Nikolai Kosjar committed
650 651
void MoveDeclarationOutOfWhile::match(const CppQuickFixInterface &interface,
                                      QuickFixOperations &result)
652
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
653 654
    const QList<AST *> &path = interface->path();
    QSharedPointer<MoveDeclarationOutOfWhileOp> op(new MoveDeclarationOutOfWhileOp(interface));
655

Nikolai Kosjar's avatar
Nikolai Kosjar committed
656 657 658 659 660 661
    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;
662

Nikolai Kosjar's avatar
Nikolai Kosjar committed
663 664
                if (! op->core)
                    return;
665

Nikolai Kosjar's avatar
Nikolai Kosjar committed
666 667
                if (! declarator->equal_token)
                    return;
668

Nikolai Kosjar's avatar
Nikolai Kosjar committed
669 670
                if (! declarator->initializer)
                    return;
671

Nikolai Kosjar's avatar
Nikolai Kosjar committed
672 673 674 675
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
676 677 678 679
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
680
}
681

Nikolai Kosjar's avatar
Nikolai Kosjar committed
682 683 684 685 686 687 688 689
class SplitIfStatementOp: public CppQuickFixOperation
{
public:
    SplitIfStatementOp(const CppQuickFixInterface &interface, int priority,
                       IfStatementAST *pattern, BinaryExpressionAST *condition)
        : CppQuickFixOperation(interface, priority)
        , pattern(pattern)
        , condition(condition)
690
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
691 692 693 694 695 696 697 698
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Split if Statement"));
    }

    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
699

Nikolai Kosjar's avatar
Nikolai Kosjar committed
700
        const Token binaryToken = currentFile->tokenAt(condition->binary_op_token);
701

Nikolai Kosjar's avatar
Nikolai Kosjar committed
702 703 704 705 706
        if (binaryToken.is(T_AMPER_AMPER))
            splitAndCondition(currentFile);
        else
            splitOrCondition(currentFile);
    }
707

Nikolai Kosjar's avatar
Nikolai Kosjar committed
708 709 710
    void splitAndCondition(CppRefactoringFilePtr currentFile) const
    {
        ChangeSet changes;
711

Nikolai Kosjar's avatar
Nikolai Kosjar committed
712 713 714 715
        int startPos = currentFile->startOf(pattern);
        changes.insert(startPos, QLatin1String("if ("));
        changes.move(currentFile->range(condition->left_expression), startPos);
        changes.insert(startPos, QLatin1String(") {\n"));
716

Nikolai Kosjar's avatar
Nikolai Kosjar committed
717 718 719
        const int lExprEnd = currentFile->endOf(condition->left_expression);
        changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));
        changes.insert(currentFile->endOf(pattern), QLatin1String("\n}"));
720

Nikolai Kosjar's avatar
Nikolai Kosjar committed
721 722 723 724
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
725

Nikolai Kosjar's avatar
Nikolai Kosjar committed
726
    void splitOrCondition(CppRefactoringFilePtr currentFile) const
727
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
728
        ChangeSet changes;
729

Nikolai Kosjar's avatar
Nikolai Kosjar committed
730 731
        StatementAST *ifTrueStatement = pattern->statement;
        CompoundStatementAST *compoundStatement = ifTrueStatement->asCompoundStatement();
732

Nikolai Kosjar's avatar
Nikolai Kosjar committed
733 734 735 736 737 738
        int insertPos = currentFile->endOf(ifTrueStatement);
        if (compoundStatement)
            changes.insert(insertPos, QLatin1String(" "));
        else
            changes.insert(insertPos, QLatin1String("\n"));
        changes.insert(insertPos, QLatin1String("else if ("));
739

Nikolai Kosjar's avatar
Nikolai Kosjar committed
740 741 742
        const int rExprStart = currentFile->startOf(condition->right_expression);
        changes.move(rExprStart, currentFile->startOf(pattern->rparen_token), insertPos);
        changes.insert(insertPos, QLatin1String(")"));
743

Nikolai Kosjar's avatar
Nikolai Kosjar committed
744 745
        const int rParenEnd = currentFile->endOf(pattern->rparen_token);
        changes.copy(rParenEnd, currentFile->endOf(pattern->statement), insertPos);
746

Nikolai Kosjar's avatar
Nikolai Kosjar committed
747 748 749 750 751 752
        const int lExprEnd = currentFile->endOf(condition->left_expression);
        changes.remove(lExprEnd, currentFile->startOf(condition->right_expression));

        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
753 754 755
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
756 757 758
    IfStatementAST *pattern;
    BinaryExpressionAST *condition;
};
759

Nikolai Kosjar's avatar
Nikolai Kosjar committed
760 761 762 763
void SplitIfStatement::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    IfStatementAST *pattern = 0;
    const QList<AST *> &path = interface->path();
764

Nikolai Kosjar's avatar
Nikolai Kosjar committed
765 766 767 768 769 770
    int index = path.size() - 1;
    for (; index != -1; --index) {
        AST *node = path.at(index);
        if (IfStatementAST *stmt = node->asIfStatement()) {
            pattern = stmt;
            break;
771
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
772
    }
773

Nikolai Kosjar's avatar
Nikolai Kosjar committed
774 775
    if (! pattern || ! pattern->statement)
        return;
776

Nikolai Kosjar's avatar
Nikolai Kosjar committed
777 778 779 780 781 782
    unsigned splitKind = 0;
    for (++index; index < path.size(); ++index) {
        AST *node = path.at(index);
        BinaryExpressionAST *condition = node->asBinaryExpression();
        if (! condition)
            return;
783

Nikolai Kosjar's avatar
Nikolai Kosjar committed
784
        Token binaryToken = interface->currentFile()->tokenAt(condition->binary_op_token);
785

Nikolai Kosjar's avatar
Nikolai Kosjar committed
786 787 788 789 790 791 792 793 794 795
        // 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;
            // we can't reliably split &&s in ifs with an else branch
            if (splitKind == T_AMPER_AMPER && pattern->else_statement)
                return;
        } else if (splitKind != binaryToken.kind()) {
            return;
796 797
        }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
798 799 800 801
        if (interface->isCursorOn(condition->binary_op_token)) {
            result.append(QuickFixOperation::Ptr(
                new SplitIfStatementOp(interface, index, pattern, condition)));
            return;
802
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
803 804
    }
}
805 806 807 808 809 810 811

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

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
static inline QString msgQtStringLiteralDescription(const QString &replacement)
{
    return QApplication::translate("CppTools::QuickFix", "Enclose in %1(...)").arg(replacement);
}

/* Analze a string/character literal like "x", QLatin1String("x") and return the literal
 * (StringLiteral or NumericLiteral for characters) and its type
 * and the enclosing function (QLatin1String, tr...) */
ExpressionAST *WrapStringLiteral::analyze(const QList<AST *> &path,
                                          const CppRefactoringFilePtr &file,
                                          Type *type,
                                          QByteArray *enclosingFunction /* = 0 */,
                                          CallAST **enclosingFunctionCall /* = 0 */)
{
    *type = TypeNone;
    if (enclosingFunction)
        enclosingFunction->clear();
    if (enclosingFunctionCall)
        *enclosingFunctionCall = 0;

    if (path.isEmpty())
        return 0;

    ExpressionAST *literal = path.last()->asExpression();
    if (literal) {
        if (literal->asStringLiteral()) {
            // Check for Objective C string (@"bla")
            const QChar firstChar = file->charAt(file->startOf(literal));
            *type = firstChar == QLatin1Char('@') ? TypeObjCString : TypeString;
        } else if (NumericLiteralAST *numericLiteral = literal->asNumericLiteral()) {
            // character ('c') constants are numeric.
            if (file->tokenAt(numericLiteral->literal_token).is(T_CHAR_LITERAL))
                *type = TypeChar;
845
        }
846
    }
847

848 849 850 851 852 853 854 855
    if (*type != TypeNone && enclosingFunction && path.size() > 1) {
        if (CallAST *call = path.at(path.size() - 2)->asCall()) {
            if (call->base_expression) {
                if (IdExpressionAST *idExpr = call->base_expression->asIdExpression()) {
                    if (SimpleNameAST *functionName = idExpr->name->asSimpleName()) {
                        *enclosingFunction = file->tokenAt(functionName->identifier_token).identifier->chars();
                        if (enclosingFunctionCall)
                            *enclosingFunctionCall = call;
856 857 858 859
                    }
                }
            }
        }
860 861 862
    }
    return literal;
}
863

Nikolai Kosjar's avatar
Nikolai Kosjar committed
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
/// Operation performs the operations of type ActionFlags passed in as actions.
class WrapStringLiteralOp : public CppQuickFixOperation
{
public:
    typedef WrapStringLiteral Factory;

    WrapStringLiteralOp(const CppQuickFixInterface &interface, int priority,
                        unsigned actions, const QString &description, ExpressionAST *literal,
                        const QString &translationContext = QString())
        : CppQuickFixOperation(interface, priority), m_actions(actions), m_literal(literal),
          m_translationContext(translationContext)
    {
        setDescription(description);
    }

    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());

        ChangeSet changes;

        const int startPos = currentFile->startOf(m_literal);
        const int endPos = currentFile->endOf(m_literal);

        // kill leading '@'. No need to adapt endPos, that is done by ChangeSet
        if (m_actions & Factory::RemoveObjectiveCAction)
            changes.remove(startPos, startPos + 1);

        // Fix quotes
        if (m_actions & (Factory::SingleQuoteAction | Factory::DoubleQuoteAction)) {
            const QString newQuote((m_actions & Factory::SingleQuoteAction) ? QLatin1Char('\'') : QLatin1Char('"'));
            changes.replace(startPos, startPos + 1, newQuote);
            changes.replace(endPos - 1, endPos, newQuote);
        }

        // Convert single character strings into character constants
        if (m_actions & Factory::ConvertEscapeSequencesToCharAction) {
            StringLiteralAST *stringLiteral = m_literal->asStringLiteral();
            QTC_ASSERT(stringLiteral, return ;);
            const QByteArray oldContents(currentFile->tokenAt(stringLiteral->literal_token).identifier->chars());
            const QByteArray newContents = Factory::stringToCharEscapeSequences(oldContents);
            QTC_ASSERT(!newContents.isEmpty(), return ;);
            if (oldContents != newContents)
                changes.replace(startPos + 1, endPos -1, QString::fromLatin1(newContents));
        }

        // Convert character constants into strings constants
        if (m_actions & Factory::ConvertEscapeSequencesToStringAction) {
            NumericLiteralAST *charLiteral = m_literal->asNumericLiteral(); // char 'c' constants are numerical.
            QTC_ASSERT(charLiteral, return ;);
            const QByteArray oldContents(currentFile->tokenAt(charLiteral->literal_token).identifier->chars());
            const QByteArray newContents = Factory::charToStringEscapeSequences(oldContents);
            QTC_ASSERT(!newContents.isEmpty(), return ;);
            if (oldContents != newContents)
                changes.replace(startPos + 1, endPos -1, QString::fromLatin1(newContents));
        }

        // Enclose in literal or translation function, macro.
        if (m_actions & (Factory::EncloseActionMask | Factory::TranslationMask)) {
            changes.insert(endPos, QString(QLatin1Char(')')));
            QString leading = Factory::replacement(m_actions);
            leading += QLatin1Char('(');
            if (m_actions & (Factory::TranslateQCoreApplicationAction | Factory::TranslateNoopAction)) {
                leading += QLatin1Char('"');
                leading += m_translationContext;
                leading += QLatin1String("\", ");
            }
            changes.insert(startPos, leading);
        }

        currentFile->setChangeSet(changes);
        currentFile->apply();
    }

private:
    const unsigned m_actions;
    ExpressionAST *m_literal;
    const QString m_translationContext;
};

945
void WrapStringLiteral::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
946 947 948 949 950 951 952
{
    typedef CppQuickFixOperation::Ptr OperationPtr;

    Type type = TypeNone;
    QByteArray enclosingFunction;
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
953
    ExpressionAST *literal = analyze(path, file, &type, &enclosingFunction);
954
    if (!literal || type == TypeNone)
955
        return;
956 957 958
    if ((type == TypeChar && enclosingFunction == "QLatin1Char")
        || isQtStringLiteral(enclosingFunction)
        || isQtStringTranslation(enclosingFunction))
959
        return;
960

961 962 963
    const int priority = path.size() - 1; // very high priority
    if (type == TypeChar) {
        unsigned actions = EncloseInQLatin1CharAction;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
964 965 966
        QString description = msgQtStringLiteralDescription(replacement(actions));
        result << OperationPtr(new WrapStringLiteralOp(interface, priority, actions,
                                                             description, literal));
967 968 969 970 971 972
        if (NumericLiteralAST *charLiteral = literal->asNumericLiteral()) {
            const QByteArray contents(file->tokenAt(charLiteral->literal_token).identifier->chars());
            if (!charToStringEscapeSequences(contents).isEmpty()) {
                actions = DoubleQuoteAction | ConvertEscapeSequencesToStringAction;
                description = QApplication::translate("CppTools::QuickFix",
                              "Convert to String Literal");
Nikolai Kosjar's avatar
Nikolai Kosjar committed
973 974
                result << OperationPtr(new WrapStringLiteralOp(interface, priority, actions,
                                                                     description, literal));
975
            }
976
        }
977 978 979 980 981 982 983 984 985 986 987
    } else {
        const unsigned objectiveCActions = type == TypeObjCString ?
                                           unsigned(RemoveObjectiveCAction) : 0u;
        unsigned actions = 0;
        if (StringLiteralAST *stringLiteral = literal->asStringLiteral()) {
            const QByteArray contents(file->tokenAt(stringLiteral->literal_token).identifier->chars());
            if (!stringToCharEscapeSequences(contents).isEmpty()) {
                actions = EncloseInQLatin1CharAction | SingleQuoteAction
                          | ConvertEscapeSequencesToCharAction | objectiveCActions;
                QString description = QApplication::translate("CppTools::QuickFix",
                                      "Convert to Character Literal and Enclose in QLatin1Char(...)");
Nikolai Kosjar's avatar
Nikolai Kosjar committed
988 989
                result << OperationPtr(new WrapStringLiteralOp(interface, priority,
                                                                     actions, description, literal));
990 991 992
                actions &= ~EncloseInQLatin1CharAction;
                description = QApplication::translate("CppTools::QuickFix",
                              "Convert to Character Literal");
Nikolai Kosjar's avatar
Nikolai Kosjar committed
993 994
                result << OperationPtr(new WrapStringLiteralOp(interface, priority,
                                                                     actions, description, literal));
995 996 997
            }
        }
        actions = EncloseInQLatin1StringAction | objectiveCActions;
Nikolai Kosjar's avatar