cppquickfixes.cpp 191 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 "cppeditor.h"
33
#include "cppfunctiondecldeflink.h"
Leandro Melo's avatar
Leandro Melo committed
34
#include "cppquickfixassistant.h"
35

36 37
#include <coreplugin/icore.h>

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

47
#include <cplusplus/ASTPath.h>
48
#include <cplusplus/CPlusPlusForwardDeclarations.h>
49 50 51 52
#include <cplusplus/CppRewriter.h>
#include <cplusplus/DependencyTable.h>
#include <cplusplus/TypeOfExpression.h>

53
#include <extensionsystem/pluginmanager.h>
54

55 56 57
#include <texteditor/fontsettings.h>
#include <texteditor/texteditorsettings.h>

58 59
#include <utils/qtcassert.h>

60
#include <QApplication>
61 62 63
#include <QCheckBox>
#include <QComboBox>
#include <QDialogButtonBox>
64
#include <QDir>
65
#include <QFileInfo>
66 67
#include <QGroupBox>
#include <QHBoxLayout>
68
#include <QInputDialog>
69 70
#include <QItemDelegate>
#include <QLabel>
71
#include <QMessageBox>
72 73 74
#include <QPointer>
#include <QPushButton>
#include <QQueue>
Nikolai Kosjar's avatar
Nikolai Kosjar committed
75
#include <QSharedPointer>
76 77
#include <QSortFilterProxyModel>
#include <QStandardItemModel>
78 79
#include <QTextBlock>
#include <QTextCursor>
80 81
#include <QTreeView>
#include <QVBoxLayout>
82

Nikolai Kosjar's avatar
Nikolai Kosjar committed
83 84
#include <cctype>

85
using namespace CPlusPlus;
86 87
using namespace CppEditor;
using namespace CppEditor::Internal;
88 89 90
using namespace CppTools;
using namespace TextEditor;
using namespace Utils;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

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);
127 128 129

    plugIn->addAutoReleasedObject(new MoveFuncDefOutside);
    plugIn->addAutoReleasedObject(new MoveFuncDefToDecl);
130 131

    plugIn->addAutoReleasedObject(new AssignToLocalVariable);
132 133

    plugIn->addAutoReleasedObject(new InsertVirtualMethods);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
134
}
135

136 137 138 139
// In the following anonymous namespace all functions are collected, which could be of interest for
// different quick fixes.
namespace {

140 141 142 143 144 145
enum DefPos {
    DefPosInsideClass,
    DefPosOutsideClass,
    DefPosImplementationFile
};

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
InsertionLocation insertLocationForMethodDefinition(Symbol *symbol,
                                                    CppRefactoringChanges& refactoring,
                                                    const QString& fileName)
{
    QTC_ASSERT(symbol, return InsertionLocation());

    // Try to find optimal location
    const InsertionPointLocator locator(refactoring);
    const QList<InsertionLocation> list = locator.methodDefinition(symbol, symbol->asDeclaration(),
                                                                   fileName);
    for (int i = 0; i < list.count(); ++i) {
        InsertionLocation location = list.at(i);
        if (location.isValid() && location.fileName() == fileName) {
            return location;
            break;
        }
    }

    // ...failed, so return location at end of file
    CppRefactoringFilePtr file = refactoring.file(fileName);
    const QTextDocument *doc = file->document();
    int pos = qMax(0, doc->characterCount() - 1);

    //TODO watch for matching namespace
    //TODO watch for moc-includes

    unsigned line, column;
    file->lineAndColumn(pos, &line, &column);
    return InsertionLocation(fileName, QLatin1String("\n\n"), QLatin1String("\n"), line, column);
}

177
inline bool isQtStringLiteral(const QByteArray &id)
178 179 180 181
{
    return id == "QLatin1String" || id == "QLatin1Literal" || id == "QStringLiteral";
}

182
inline bool isQtStringTranslation(const QByteArray &id)
183 184 185 186
{
    return id == "tr" || id == "trUtf8" || id == "translate" || id == "QT_TRANSLATE_NOOP";
}

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
Class *isMemberFunction(const LookupContext &context, Function *function)
{
    QTC_ASSERT(function, return 0);

    Scope *enclosingScope = function->enclosingScope();
    while (! (enclosingScope->isNamespace() || enclosingScope->isClass()))
        enclosingScope = enclosingScope->enclosingScope();
    QTC_ASSERT(enclosingScope != 0, return 0);

    const Name *functionName = function->name();
    if (! functionName)
        return 0; // anonymous function names are not valid c++

    if (! functionName->isQualifiedNameId())
        return 0; // trying to add a declaration for a global function

    const QualifiedNameId *q = functionName->asQualifiedNameId();
    if (!q->base())
        return 0;

    if (ClassOrNamespace *binding = context.lookupType(q->base(), enclosingScope)) {
        foreach (Symbol *s, binding->symbols()) {
            if (Class *matchingClass = s->asClass())
                return matchingClass;
        }
    }

    return 0;
}

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 242 243 244 245 246 247
// Given include is e.g. "afile.h" or <afile.h> (quotes/angle brackets included!).
void insertNewIncludeDirective(const QString &include, CppRefactoringFilePtr file)
{
    // Find optimal position
    using namespace IncludeUtils;
    LineForNewIncludeDirective finder(file->document(), file->cppDocument()->includes(),
                                      LineForNewIncludeDirective::IgnoreMocIncludes,
                                      LineForNewIncludeDirective::AutoDetect);
    unsigned newLinesToPrepend = 0;
    unsigned newLinesToAppend = 0;
    const int insertLine = finder(include, &newLinesToPrepend, &newLinesToAppend);
    QTC_ASSERT(insertLine >= 1, return);
    const int insertPosition = file->position(insertLine, 1);
    QTC_ASSERT(insertPosition >= 0, return);

    // Construct text to insert
    const QString includeLine = QLatin1String("#include ") + include + QLatin1Char('\n');
    QString prependedNewLines, appendedNewLines;
    while (newLinesToAppend--)
        appendedNewLines += QLatin1String("\n");
    while (newLinesToPrepend--)
        prependedNewLines += QLatin1String("\n");
    const QString textToInsert = prependedNewLines + includeLine + appendedNewLines;

    // Insert
    ChangeSet changes;
    changes.insert(insertPosition, textToInsert);
    file->setChangeSet(changes);
    file->apply();
}

248 249 250 251
} // anonymous namespace

namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
252
class InverseLogicalComparisonOp: public CppQuickFixOperation
253 254
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
255 256 257 258
    InverseLogicalComparisonOp(const CppQuickFixInterface &interface, int priority,
                               BinaryExpressionAST *binary, Kind invertToken)
        : CppQuickFixOperation(interface, priority)
        , binary(binary), nested(0), negation(0)
259
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
260 261 262
        Token tok;
        tok.f.kind = invertToken;
        replacement = QLatin1String(tok.spell());
263

Nikolai Kosjar's avatar
Nikolai Kosjar committed
264 265 266
        // check for enclosing nested expression
        if (priority - 1 >= 0)
            nested = interface->path()[priority - 1]->asNestedExpression();
267

Nikolai Kosjar's avatar
Nikolai Kosjar committed
268 269 270 271 272
        // 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;
273 274 275
        }
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
276
    QString description() const
277
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
278 279
        return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
280

Nikolai Kosjar's avatar
Nikolai Kosjar committed
281 282 283 284 285 286 287 288 289 290 291 292 293 294
    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(")"));
295
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
296 297 298 299
        changes.replace(currentFile->range(binary->binary_op_token), replacement);
        currentFile->setChangeSet(changes);
        currentFile->apply();
    }
300

Nikolai Kosjar's avatar
Nikolai Kosjar committed
301 302 303 304
private:
    BinaryExpressionAST *binary;
    NestedExpressionAST *nested;
    UnaryExpressionAST *negation;
305

Nikolai Kosjar's avatar
Nikolai Kosjar committed
306
    QString replacement;
307 308
};

309 310
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
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;
    }
347

Nikolai Kosjar's avatar
Nikolai Kosjar committed
348 349 350
    result.append(CppQuickFixOperation::Ptr(
        new InverseLogicalComparisonOp(interface, index, binary, invertToken)));
}
351

352 353
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
354
class FlipLogicalOperandsOp: public CppQuickFixOperation
355 356
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
357 358 359 360 361
    FlipLogicalOperandsOp(const CppQuickFixInterface &interface, int priority,
                          BinaryExpressionAST *binary, QString replacement)
        : CppQuickFixOperation(interface)
        , binary(binary)
        , replacement(replacement)
362
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
363 364
        setPriority(priority);
    }
365

Nikolai Kosjar's avatar
Nikolai Kosjar committed
366 367 368 369 370 371 372
    QString description() const
    {
        if (replacement.isEmpty())
            return QApplication::translate("CppTools::QuickFix", "Swap Operands");
        else
            return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
373

Nikolai Kosjar's avatar
Nikolai Kosjar committed
374 375 376 377
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
378

Nikolai Kosjar's avatar
Nikolai Kosjar committed
379
        ChangeSet changes;
380 381
        changes.flip(currentFile->range(binary->left_expression),
                     currentFile->range(binary->right_expression));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
382 383
        if (! replacement.isEmpty())
            changes.replace(currentFile->range(binary->binary_op_token), replacement);
384

Nikolai Kosjar's avatar
Nikolai Kosjar committed
385 386
        currentFile->setChangeSet(changes);
        currentFile->apply();
387 388 389
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
390 391 392
    BinaryExpressionAST *binary;
    QString replacement;
};
393

394 395
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
396 397 398 399
void FlipLogicalOperands::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
400

Nikolai Kosjar's avatar
Nikolai Kosjar committed
401 402 403 404 405 406
    int index = path.size() - 1;
    BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
    if (! binary)
        return;
    if (! interface->isCursorOn(binary->binary_op_token))
        return;
407

Nikolai Kosjar's avatar
Nikolai Kosjar committed
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    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;
    }
431

Nikolai Kosjar's avatar
Nikolai Kosjar committed
432 433 434 435 436 437
    QString replacement;
    if (flipToken != T_EOF_SYMBOL) {
        Token tok;
        tok.f.kind = flipToken;
        replacement = QLatin1String(tok.spell());
    }
438

Nikolai Kosjar's avatar
Nikolai Kosjar committed
439 440 441
    result.append(QuickFixOperation::Ptr(
        new FlipLogicalOperandsOp(interface, index, binary, replacement)));
}
442

443 444
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
445
class RewriteLogicalAndOp: public CppQuickFixOperation
446 447
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
448 449 450 451 452 453 454 455
    QSharedPointer<ASTPatternBuilder> mk;
    UnaryExpressionAST *left;
    UnaryExpressionAST *right;
    BinaryExpressionAST *pattern;

    RewriteLogicalAndOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
        , mk(new ASTPatternBuilder)
456
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
457 458 459 460
        left = mk->UnaryExpression();
        right = mk->UnaryExpression();
        pattern = mk->BinaryExpression(left, right);
    }
461

Nikolai Kosjar's avatar
Nikolai Kosjar committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    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();
    }
};
481

482 483
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
484 485 486 487 488
void RewriteLogicalAnd::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    BinaryExpressionAST *expression = 0;
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
489

Nikolai Kosjar's avatar
Nikolai Kosjar committed
490 491 492 493 494
    int index = path.size() - 1;
    for (; index != -1; --index) {
        expression = path.at(index)->asBinaryExpression();
        if (expression)
            break;
495 496
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
497 498
    if (! expression)
        return;
499

Nikolai Kosjar's avatar
Nikolai Kosjar committed
500 501
    if (! interface->isCursorOn(expression->binary_op_token))
        return;
502

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
505 506 507 508
    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)) {
509 510
        op->setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Rewrite Condition Using ||"));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
511 512 513 514
        op->setPriority(index);
        result.append(op);
    }
}
515

Nikolai Kosjar's avatar
Nikolai Kosjar committed
516 517 518 519
bool SplitSimpleDeclaration::checkDeclaration(SimpleDeclarationAST *declaration)
{
    if (! declaration->semicolon_token)
        return false;
520

Nikolai Kosjar's avatar
Nikolai Kosjar committed
521 522
    if (! declaration->decl_specifier_list)
        return false;
523

Nikolai Kosjar's avatar
Nikolai Kosjar committed
524 525
    for (SpecifierListAST *it = declaration->decl_specifier_list; it; it = it->next) {
        SpecifierAST *specifier = it->value;
526

Nikolai Kosjar's avatar
Nikolai Kosjar committed
527
        if (specifier->asEnumSpecifier() != 0)
528 529
            return false;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
530
        else if (specifier->asClassSpecifier() != 0)
531
            return false;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
532
    }
533

Nikolai Kosjar's avatar
Nikolai Kosjar committed
534 535
    if (! declaration->declarator_list)
        return false;
536

Nikolai Kosjar's avatar
Nikolai Kosjar committed
537 538
    else if (! declaration->declarator_list->next)
        return false;
539

Nikolai Kosjar's avatar
Nikolai Kosjar committed
540 541
    return true;
}
542

543 544
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
545 546 547 548 549 550 551 552 553 554
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"));
555 556
    }

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
564 565 566 567
        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);
568

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
571 572
        for (DeclaratorListAST *it = declaration->declarator_list->next; it; it = it->next) {
            DeclaratorAST *declarator = it->value;
573

Nikolai Kosjar's avatar
Nikolai Kosjar committed
574 575 576 577 578
            changes.insert(insertPos, QLatin1String("\n"));
            changes.copy(declSpecifiersStart, declSpecifiersEnd, insertPos);
            changes.insert(insertPos, QLatin1String(" "));
            changes.move(currentFile->range(declarator), insertPos);
            changes.insert(insertPos, QLatin1String(";"));
579

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
583
            prevDeclarator = declarator;
584
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
585 586 587 588

        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(declaration));
        currentFile->apply();
589 590 591
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
592 593
    SimpleDeclarationAST *declaration;
};
594

595 596
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
597 598 599 600 601 602 603
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();
604

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
608 609
        if (CoreDeclaratorAST *coreDecl = node->asCoreDeclarator())
            core_declarator = coreDecl;
610

Nikolai Kosjar's avatar
Nikolai Kosjar committed
611 612 613
        else if (SimpleDeclarationAST *simpleDecl = node->asSimpleDeclaration()) {
            if (checkDeclaration(simpleDecl)) {
                SimpleDeclarationAST *declaration = simpleDecl;
614

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
618 619 620 621 622 623
                if (cursorPosition >= startOfDeclSpecifier && cursorPosition <= endOfDeclSpecifier) {
                    // the AST node under cursor is a specifier.
                    result.append(QuickFixOperation::Ptr(
                        new SplitSimpleDeclarationOp(interface, index, declaration)));
                    return;
                }
624

Nikolai Kosjar's avatar
Nikolai Kosjar committed
625 626 627 628 629 630
                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;
                }
631 632
            }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
633
            return;
634
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
635 636
    }
}
637

638 639
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
640 641 642 643 644 645 646
class AddBracesToIfOp: public CppQuickFixOperation
{
public:
    AddBracesToIfOp(const CppQuickFixInterface &interface, int priority, StatementAST *statement)
        : CppQuickFixOperation(interface, priority)
        , _statement(statement)
    {
647
        setDescription(QApplication::translate("CppTools::QuickFix", "Add Curly Braces"));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
648 649 650 651 652 653 654 655
    }

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

        ChangeSet changes;
656

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
663
        currentFile->setChangeSet(changes);
664
        currentFile->appendIndentRange(ChangeSet::Range(start, end));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
665 666 667 668 669 670 671
        currentFile->apply();
    }

private:
    StatementAST *_statement;
};

672 673
} // anonymous namespace

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
678 679 680 681 682 683 684 685 686 687 688 689 690
    // 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) {
691
        IfStatementAST *ifStatement = path.at(index)->asIfStatement();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
692 693
        if (ifStatement && ifStatement->statement
            && interface->isCursorOn(ifStatement->statement)
694
            && ! ifStatement->statement->asCompoundStatement()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
695 696
            result.append(QuickFixOperation::Ptr(
                new AddBracesToIfOp(interface, index, ifStatement->statement)));
697
            return;
698
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
699
    }
700

Nikolai Kosjar's avatar
Nikolai Kosjar committed
701 702 703
    // ### This could very well be extended to the else branch
    // and other nodes entirely.
}
704

705 706
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
707 708 709 710 711 712 713 714 715 716 717
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);
718 719
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
720
    void perform()
721
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
722 723
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
724

Nikolai Kosjar's avatar
Nikolai Kosjar committed
725
        ChangeSet changes;
726

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
729 730 731
        int insertPos = currentFile->startOf(pattern);
        changes.move(currentFile->range(condition), insertPos);
        changes.insert(insertPos, QLatin1String(";\n"));
732

Nikolai Kosjar's avatar
Nikolai Kosjar committed
733 734 735 736
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
737

Nikolai Kosjar's avatar
Nikolai Kosjar committed
738 739 740 741 742
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    ConditionAST *condition;
    IfStatementAST *pattern;
    CoreDeclaratorAST *core;
743 744
};

745 746
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
747 748
void MoveDeclarationOutOfIf::match(const CppQuickFixInterface &interface,
                                   QuickFixOperations &result)
749
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
750 751 752 753 754 755 756 757 758 759 760 761
    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;
762

Nikolai Kosjar's avatar
Nikolai Kosjar committed
763 764 765 766
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
767 768 769 770
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
771
}
772

773 774
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
775 776 777 778 779
class MoveDeclarationOutOfWhileOp: public CppQuickFixOperation
{
public:
    MoveDeclarationOutOfWhileOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
780
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
781 782
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Move Declaration out of Condition"));
783

Nikolai Kosjar's avatar
Nikolai Kosjar committed
784 785 786
        condition = mk.Condition();
        pattern = mk.WhileStatement(condition);
    }
787

Nikolai Kosjar's avatar
Nikolai Kosjar committed
788 789 790 791
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
792

Nikolai Kosjar's avatar
Nikolai Kosjar committed
793
        ChangeSet changes;
794

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
798 799 800 801 802
        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"));
803

Nikolai Kosjar's avatar
Nikolai Kosjar committed
804 805 806 807
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
808

Nikolai Kosjar's avatar
Nikolai Kosjar committed
809 810 811 812 813 814
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    ConditionAST *condition;
    WhileStatementAST *pattern;
    CoreDeclaratorAST *core;
};
815

816 817
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
818 819
void MoveDeclarationOutOfWhile::match(const CppQuickFixInterface &interface,
                                      QuickFixOperations &result)
820
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
821 822
    const QList<AST *> &path = interface->path();
    QSharedPointer<MoveDeclarationOutOfWhileOp> op(new MoveDeclarationOutOfWhileOp(interface));
823

Nikolai Kosjar's avatar
Nikolai Kosjar committed
824 825 826 827 828 829
    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;
830

Nikolai Kosjar's avatar
Nikolai Kosjar committed
831 832
                if (! op->core)
                    return;
833

Nikolai Kosjar's avatar
Nikolai Kosjar committed
834 835
                if (! declarator->equal_token)
                    return;
836

Nikolai Kosjar's avatar
Nikolai Kosjar committed
837 838
                if (! declarator->initializer)
                    return;
839

Nikolai Kosjar's avatar
Nikolai Kosjar committed
840 841 842 843
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
844 845 846 847
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
848
}
849

850 851
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
852 853 854 855 856 857 858 859
class SplitIfStatementOp: public CppQuickFixOperation
{
public:
    SplitIfStatementOp(const CppQuickFixInterface &interface, int priority,
                       IfStatementAST *pattern, BinaryExpressionAST *condition)
        : CppQuickFixOperation(interface, priority)
        , pattern(pattern)
        , condition(condition)
860
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
861 862 863 864 865 866 867 868
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Split if Statement"));
    }

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
872 873 874 875 876
        if (binaryToken.is(T_AMPER_AMPER))
            splitAndCondition(currentFile);
        else
            splitOrCondition(currentFile);
    }
877

Nikolai Kosjar's avatar
Nikolai Kosjar committed
878 879 880
    void splitAndCondition(CppRefactoringFilePtr currentFile) const
    {
        ChangeSet changes;
881

Nikolai Kosjar's avatar
Nikolai Kosjar committed
882 883 884 885
        int startPos = currentFile->startOf(pattern);
        changes.insert(startPos, QLatin1String("if ("));
        changes.move(currentFile->range(condition->left_expression), startPos);
        changes.insert(startPos, QLatin1String(") {\n"));
886

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
891 892 893 894
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
895

Nikolai Kosjar's avatar
Nikolai Kosjar committed
896
    void splitOrCondition(CppRefactoringFilePtr currentFile) const
897
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
898
        ChangeSet changes;
899

Nikolai Kosjar's avatar
Nikolai Kosjar committed
900 901
        StatementAST *ifTrueStatement = pattern->statement;
        CompoundStatementAST *compoundStatement = ifTrueStatement->asCompoundStatement();
902

Nikolai Kosjar's avatar
Nikolai Kosjar committed
903 904 905 906 907 908
        int insertPos = currentFile->endOf(ifTrueStatement);
        if (compoundStatement)
            changes.insert(insertPos, QLatin1String(" "));
        else
            changes.insert(insertPos, QLatin1String("\n"));
        changes.insert(insertPos, QLatin1String("else if ("));
909

Nikolai Kosjar's avatar
Nikolai Kosjar committed
910 911 912
        const int rExprStart = currentFile->startOf(condition->right_expression);
        changes.move(rExprStart, currentFile->startOf(pattern->rparen_token), insertPos);
        changes.insert(insertPos, QLatin1String(")"));
913

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
917 918 919 920 921 922
        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();
923 924 925
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
926 927 928
    IfStatementAST *pattern;
    BinaryExpressionAST *condition;
};
929

930 931
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
932 933 934 935
void SplitIfStatement::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    IfStatementAST *pattern = 0;
    const QList<AST *> &path = interface->path();
936

Nikolai Kosjar's avatar
Nikolai Kosjar committed
937 938 939 940 941 942
    int index = path.size() - 1;
    for (; index != -1; --index) {
        AST *node = path.at(index);
        if (IfStatementAST *stmt = node->asIfStatement()) {
            pattern = stmt;
            break;
943
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
944
    }
945

Nikolai Kosjar's avatar
Nikolai Kosjar committed
946 947
    if (! pattern || ! pattern->statement)
        return;
948

Nikolai Kosjar's avatar
Nikolai Kosjar committed
949 950 951 952 953 954
    unsigned splitKind = 0;
    for (++index; index < path.size(); ++index) {
        AST *node = path.at(index);
        BinaryExpressionAST *condition = node->asBinaryExpression();
        if (! condition)
            return;
955

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
958 959 960 961 962 963 964