cppquickfixes.cpp 194 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
InsertionLocation insertLocationForMethodDefinition(Symbol *symbol, const bool useSymbolFinder,
147 148 149 150 151 152 153
                                                    CppRefactoringChanges& refactoring,
                                                    const QString& fileName)
{
    QTC_ASSERT(symbol, return InsertionLocation());

    // Try to find optimal location
    const InsertionPointLocator locator(refactoring);
154 155
    const QList<InsertionLocation> list
            = locator.methodDefinition(symbol, useSymbolFinder, fileName);
156 157 158 159 160 161 162 163
    for (int i = 0; i < list.count(); ++i) {
        InsertionLocation location = list.at(i);
        if (location.isValid() && location.fileName() == fileName) {
            return location;
            break;
        }
    }

164 165
    // ...failed,
    // if class member try to get position right after class
166
    CppRefactoringFilePtr file = refactoring.file(fileName);
167 168 169 170 171 172 173 174 175 176 177 178 179
    unsigned line = 0, column = 0;
    if (Class *clazz = symbol->enclosingClass()) {
        if (symbol->fileName() == fileName.toUtf8()) {
            file->cppDocument()->translationUnit()->getPosition(clazz->endOffset(), &line, &column);
            if (line != 0) {
                ++column; // Skipping the ";"
                return InsertionLocation(fileName, QLatin1String("\n\n"), QLatin1String(""),
                                         line, column);
            }
        }
    }

    // fall through: position at end of file
180 181 182 183 184 185 186 187 188 189
    const QTextDocument *doc = file->document();
    int pos = qMax(0, doc->characterCount() - 1);

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

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

190
inline bool isQtStringLiteral(const QByteArray &id)
191 192 193 194
{
    return id == "QLatin1String" || id == "QLatin1Literal" || id == "QStringLiteral";
}

195
inline bool isQtStringTranslation(const QByteArray &id)
196 197 198 199
{
    return id == "tr" || id == "trUtf8" || id == "translate" || id == "QT_TRANSLATE_NOOP";
}

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
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;
}

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
// 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();
}

261 262 263 264 265 266
bool nameIncludesOperatorName(const Name *name)
{
    return name->isOperatorNameId()
        || (name->isQualifiedNameId() && name->asQualifiedNameId()->name()->isOperatorNameId());
}

267 268 269 270
} // anonymous namespace

namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
271
class InverseLogicalComparisonOp: public CppQuickFixOperation
272 273
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
274 275 276 277
    InverseLogicalComparisonOp(const CppQuickFixInterface &interface, int priority,
                               BinaryExpressionAST *binary, Kind invertToken)
        : CppQuickFixOperation(interface, priority)
        , binary(binary), nested(0), negation(0)
278
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
279 280 281
        Token tok;
        tok.f.kind = invertToken;
        replacement = QLatin1String(tok.spell());
282

Nikolai Kosjar's avatar
Nikolai Kosjar committed
283 284 285
        // check for enclosing nested expression
        if (priority - 1 >= 0)
            nested = interface->path()[priority - 1]->asNestedExpression();
286

Nikolai Kosjar's avatar
Nikolai Kosjar committed
287 288 289 290 291
        // 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;
292 293 294
        }
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
295
    QString description() const
296
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
297 298
        return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
299

Nikolai Kosjar's avatar
Nikolai Kosjar committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313
    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(")"));
314
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
315 316 317 318
        changes.replace(currentFile->range(binary->binary_op_token), replacement);
        currentFile->setChangeSet(changes);
        currentFile->apply();
    }
319

Nikolai Kosjar's avatar
Nikolai Kosjar committed
320 321 322 323
private:
    BinaryExpressionAST *binary;
    NestedExpressionAST *nested;
    UnaryExpressionAST *negation;
324

Nikolai Kosjar's avatar
Nikolai Kosjar committed
325
    QString replacement;
326 327
};

328 329
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
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;
    }
366

Nikolai Kosjar's avatar
Nikolai Kosjar committed
367 368 369
    result.append(CppQuickFixOperation::Ptr(
        new InverseLogicalComparisonOp(interface, index, binary, invertToken)));
}
370

371 372
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
373
class FlipLogicalOperandsOp: public CppQuickFixOperation
374 375
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
376 377 378 379 380
    FlipLogicalOperandsOp(const CppQuickFixInterface &interface, int priority,
                          BinaryExpressionAST *binary, QString replacement)
        : CppQuickFixOperation(interface)
        , binary(binary)
        , replacement(replacement)
381
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
382 383
        setPriority(priority);
    }
384

Nikolai Kosjar's avatar
Nikolai Kosjar committed
385 386 387 388 389 390 391
    QString description() const
    {
        if (replacement.isEmpty())
            return QApplication::translate("CppTools::QuickFix", "Swap Operands");
        else
            return QApplication::translate("CppTools::QuickFix", "Rewrite Using %1").arg(replacement);
    }
392

Nikolai Kosjar's avatar
Nikolai Kosjar committed
393 394 395 396
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
397

Nikolai Kosjar's avatar
Nikolai Kosjar committed
398
        ChangeSet changes;
399 400
        changes.flip(currentFile->range(binary->left_expression),
                     currentFile->range(binary->right_expression));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
401 402
        if (! replacement.isEmpty())
            changes.replace(currentFile->range(binary->binary_op_token), replacement);
403

Nikolai Kosjar's avatar
Nikolai Kosjar committed
404 405
        currentFile->setChangeSet(changes);
        currentFile->apply();
406 407 408
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
409 410 411
    BinaryExpressionAST *binary;
    QString replacement;
};
412

413 414
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
415 416 417 418
void FlipLogicalOperands::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
419

Nikolai Kosjar's avatar
Nikolai Kosjar committed
420 421 422 423 424 425
    int index = path.size() - 1;
    BinaryExpressionAST *binary = path.at(index)->asBinaryExpression();
    if (! binary)
        return;
    if (! interface->isCursorOn(binary->binary_op_token))
        return;
426

Nikolai Kosjar's avatar
Nikolai Kosjar committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
    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;
    }
450

Nikolai Kosjar's avatar
Nikolai Kosjar committed
451 452 453 454 455 456
    QString replacement;
    if (flipToken != T_EOF_SYMBOL) {
        Token tok;
        tok.f.kind = flipToken;
        replacement = QLatin1String(tok.spell());
    }
457

Nikolai Kosjar's avatar
Nikolai Kosjar committed
458 459 460
    result.append(QuickFixOperation::Ptr(
        new FlipLogicalOperandsOp(interface, index, binary, replacement)));
}
461

462 463
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
464
class RewriteLogicalAndOp: public CppQuickFixOperation
465 466
{
public:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
467 468 469 470 471 472 473 474
    QSharedPointer<ASTPatternBuilder> mk;
    UnaryExpressionAST *left;
    UnaryExpressionAST *right;
    BinaryExpressionAST *pattern;

    RewriteLogicalAndOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
        , mk(new ASTPatternBuilder)
475
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
476 477 478 479
        left = mk->UnaryExpression();
        right = mk->UnaryExpression();
        pattern = mk->BinaryExpression(left, right);
    }
480

Nikolai Kosjar's avatar
Nikolai Kosjar committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
    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();
    }
};
500

501 502
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
503 504 505 506 507
void RewriteLogicalAnd::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    BinaryExpressionAST *expression = 0;
    const QList<AST *> &path = interface->path();
    CppRefactoringFilePtr file = interface->currentFile();
508

Nikolai Kosjar's avatar
Nikolai Kosjar committed
509 510 511 512 513
    int index = path.size() - 1;
    for (; index != -1; --index) {
        expression = path.at(index)->asBinaryExpression();
        if (expression)
            break;
514 515
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
516 517
    if (! expression)
        return;
518

Nikolai Kosjar's avatar
Nikolai Kosjar committed
519 520
    if (! interface->isCursorOn(expression->binary_op_token))
        return;
521

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
524 525 526 527
    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)) {
528 529
        op->setDescription(QApplication::translate("CppTools::QuickFix",
                                                   "Rewrite Condition Using ||"));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
530 531 532 533
        op->setPriority(index);
        result.append(op);
    }
}
534

Nikolai Kosjar's avatar
Nikolai Kosjar committed
535 536 537 538
bool SplitSimpleDeclaration::checkDeclaration(SimpleDeclarationAST *declaration)
{
    if (! declaration->semicolon_token)
        return false;
539

Nikolai Kosjar's avatar
Nikolai Kosjar committed
540 541
    if (! declaration->decl_specifier_list)
        return false;
542

Nikolai Kosjar's avatar
Nikolai Kosjar committed
543 544
    for (SpecifierListAST *it = declaration->decl_specifier_list; it; it = it->next) {
        SpecifierAST *specifier = it->value;
545

Nikolai Kosjar's avatar
Nikolai Kosjar committed
546
        if (specifier->asEnumSpecifier() != 0)
547 548
            return false;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
549
        else if (specifier->asClassSpecifier() != 0)
550
            return false;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
551
    }
552

Nikolai Kosjar's avatar
Nikolai Kosjar committed
553 554
    if (! declaration->declarator_list)
        return false;
555

Nikolai Kosjar's avatar
Nikolai Kosjar committed
556 557
    else if (! declaration->declarator_list->next)
        return false;
558

Nikolai Kosjar's avatar
Nikolai Kosjar committed
559 560
    return true;
}
561

562 563
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
564 565 566 567 568 569 570 571 572 573
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"));
574 575
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
576
    void perform()
577
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
578 579
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
580

Nikolai Kosjar's avatar
Nikolai Kosjar committed
581
        ChangeSet changes;
582

Nikolai Kosjar's avatar
Nikolai Kosjar committed
583 584 585 586
        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);
587

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
590 591
        for (DeclaratorListAST *it = declaration->declarator_list->next; it; it = it->next) {
            DeclaratorAST *declarator = it->value;
592

Nikolai Kosjar's avatar
Nikolai Kosjar committed
593 594 595 596 597
            changes.insert(insertPos, QLatin1String("\n"));
            changes.copy(declSpecifiersStart, declSpecifiersEnd, insertPos);
            changes.insert(insertPos, QLatin1String(" "));
            changes.move(currentFile->range(declarator), insertPos);
            changes.insert(insertPos, QLatin1String(";"));
598

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
602
            prevDeclarator = declarator;
603
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
604 605 606 607

        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(declaration));
        currentFile->apply();
608 609 610
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
611 612
    SimpleDeclarationAST *declaration;
};
613

614 615
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
616 617 618 619 620 621 622
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();
623

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
627 628
        if (CoreDeclaratorAST *coreDecl = node->asCoreDeclarator())
            core_declarator = coreDecl;
629

Nikolai Kosjar's avatar
Nikolai Kosjar committed
630 631 632
        else if (SimpleDeclarationAST *simpleDecl = node->asSimpleDeclaration()) {
            if (checkDeclaration(simpleDecl)) {
                SimpleDeclarationAST *declaration = simpleDecl;
633

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
637 638 639 640 641 642
                if (cursorPosition >= startOfDeclSpecifier && cursorPosition <= endOfDeclSpecifier) {
                    // the AST node under cursor is a specifier.
                    result.append(QuickFixOperation::Ptr(
                        new SplitSimpleDeclarationOp(interface, index, declaration)));
                    return;
                }
643

Nikolai Kosjar's avatar
Nikolai Kosjar committed
644 645 646 647 648 649
                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;
                }
650 651
            }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
652
            return;
653
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
654 655
    }
}
656

657 658
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
659 660 661 662 663 664 665
class AddBracesToIfOp: public CppQuickFixOperation
{
public:
    AddBracesToIfOp(const CppQuickFixInterface &interface, int priority, StatementAST *statement)
        : CppQuickFixOperation(interface, priority)
        , _statement(statement)
    {
666
        setDescription(QApplication::translate("CppTools::QuickFix", "Add Curly Braces"));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
667 668 669 670 671 672 673 674
    }

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

        ChangeSet changes;
675

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
682
        currentFile->setChangeSet(changes);
683
        currentFile->appendIndentRange(ChangeSet::Range(start, end));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
684 685 686 687 688 689 690
        currentFile->apply();
    }

private:
    StatementAST *_statement;
};

691 692
} // anonymous namespace

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
697 698 699 700 701 702 703 704 705 706 707 708 709
    // 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) {
710
        IfStatementAST *ifStatement = path.at(index)->asIfStatement();
Nikolai Kosjar's avatar
Nikolai Kosjar committed
711 712
        if (ifStatement && ifStatement->statement
            && interface->isCursorOn(ifStatement->statement)
713
            && ! ifStatement->statement->asCompoundStatement()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
714 715
            result.append(QuickFixOperation::Ptr(
                new AddBracesToIfOp(interface, index, ifStatement->statement)));
716
            return;
717
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
718
    }
719

Nikolai Kosjar's avatar
Nikolai Kosjar committed
720 721 722
    // ### This could very well be extended to the else branch
    // and other nodes entirely.
}
723

724 725
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
726 727 728 729 730 731 732 733 734 735 736
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);
737 738
    }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
739
    void perform()
740
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
741 742
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
743

Nikolai Kosjar's avatar
Nikolai Kosjar committed
744
        ChangeSet changes;
745

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
748 749 750
        int insertPos = currentFile->startOf(pattern);
        changes.move(currentFile->range(condition), insertPos);
        changes.insert(insertPos, QLatin1String(";\n"));
751

Nikolai Kosjar's avatar
Nikolai Kosjar committed
752 753 754 755
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
756

Nikolai Kosjar's avatar
Nikolai Kosjar committed
757 758 759 760 761
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    ConditionAST *condition;
    IfStatementAST *pattern;
    CoreDeclaratorAST *core;
762 763
};

764 765
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
766 767
void MoveDeclarationOutOfIf::match(const CppQuickFixInterface &interface,
                                   QuickFixOperations &result)
768
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
769 770 771 772 773 774 775 776 777 778 779 780
    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;
781

Nikolai Kosjar's avatar
Nikolai Kosjar committed
782 783 784 785
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
786 787 788 789
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
790
}
791

792 793
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
794 795 796 797 798
class MoveDeclarationOutOfWhileOp: public CppQuickFixOperation
{
public:
    MoveDeclarationOutOfWhileOp(const CppQuickFixInterface &interface)
        : CppQuickFixOperation(interface)
799
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
800 801
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Move Declaration out of Condition"));
802

Nikolai Kosjar's avatar
Nikolai Kosjar committed
803 804 805
        condition = mk.Condition();
        pattern = mk.WhileStatement(condition);
    }
806

Nikolai Kosjar's avatar
Nikolai Kosjar committed
807 808 809 810
    void perform()
    {
        CppRefactoringChanges refactoring(snapshot());
        CppRefactoringFilePtr currentFile = refactoring.file(fileName());
811

Nikolai Kosjar's avatar
Nikolai Kosjar committed
812
        ChangeSet changes;
813

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
817 818 819 820 821
        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"));
822

Nikolai Kosjar's avatar
Nikolai Kosjar committed
823 824 825 826
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
827

Nikolai Kosjar's avatar
Nikolai Kosjar committed
828 829 830 831 832 833
    ASTMatcher matcher;
    ASTPatternBuilder mk;
    ConditionAST *condition;
    WhileStatementAST *pattern;
    CoreDeclaratorAST *core;
};
834

835 836
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
837 838
void MoveDeclarationOutOfWhile::match(const CppQuickFixInterface &interface,
                                      QuickFixOperations &result)
839
{
Nikolai Kosjar's avatar
Nikolai Kosjar committed
840 841
    const QList<AST *> &path = interface->path();
    QSharedPointer<MoveDeclarationOutOfWhileOp> op(new MoveDeclarationOutOfWhileOp(interface));
842

Nikolai Kosjar's avatar
Nikolai Kosjar committed
843 844 845 846 847 848
    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;
849

Nikolai Kosjar's avatar
Nikolai Kosjar committed
850 851
                if (! op->core)
                    return;
852

Nikolai Kosjar's avatar
Nikolai Kosjar committed
853 854
                if (! declarator->equal_token)
                    return;
855

Nikolai Kosjar's avatar
Nikolai Kosjar committed
856 857
                if (! declarator->initializer)
                    return;
858

Nikolai Kosjar's avatar
Nikolai Kosjar committed
859 860 861 862
                if (interface->isCursorOn(op->core)) {
                    op->setPriority(index);
                    result.append(op);
                    return;
863 864 865 866
                }
            }
        }
    }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
867
}
868

869 870
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
871 872 873 874 875 876 877 878
class SplitIfStatementOp: public CppQuickFixOperation
{
public:
    SplitIfStatementOp(const CppQuickFixInterface &interface, int priority,
                       IfStatementAST *pattern, BinaryExpressionAST *condition)
        : CppQuickFixOperation(interface, priority)
        , pattern(pattern)
        , condition(condition)
879
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
880 881 882 883 884 885 886 887
        setDescription(QApplication::translate("CppTools::QuickFix",
                                               "Split if Statement"));
    }

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
891 892 893 894 895
        if (binaryToken.is(T_AMPER_AMPER))
            splitAndCondition(currentFile);
        else
            splitOrCondition(currentFile);
    }
896

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
901 902 903 904
        int startPos = currentFile->startOf(pattern);
        changes.insert(startPos, QLatin1String("if ("));
        changes.move(currentFile->range(condition->left_expression), startPos);
        changes.insert(startPos, QLatin1String(") {\n"));
905

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
910 911 912 913
        currentFile->setChangeSet(changes);
        currentFile->appendIndentRange(currentFile->range(pattern));
        currentFile->apply();
    }
914

Nikolai Kosjar's avatar
Nikolai Kosjar committed
915
    void splitOrCondition(CppRefactoringFilePtr currentFile) const
916
    {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
917
        ChangeSet changes;
918

Nikolai Kosjar's avatar
Nikolai Kosjar committed
919 920
        StatementAST *ifTrueStatement = pattern->statement;
        CompoundStatementAST *compoundStatement = ifTrueStatement->asCompoundStatement();
921

Nikolai Kosjar's avatar
Nikolai Kosjar committed
922 923 924 925 926 927
        int insertPos = currentFile->endOf(ifTrueStatement);
        if (compoundStatement)
            changes.insert(insertPos, QLatin1String(" "));
        else
            changes.insert(insertPos, QLatin1String("\n"));
        changes.insert(insertPos, QLatin1String("else if ("));
928

Nikolai Kosjar's avatar
Nikolai Kosjar committed
929 930 931
        const int rExprStart = currentFile->startOf(condition->right_expression);
        changes.move(rExprStart, currentFile->startOf(pattern->rparen_token), insertPos);
        changes.insert(insertPos, QLatin1String(")"));
932

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
936 937 938 939 940 941
        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();
942 943 944
    }

private:
Nikolai Kosjar's avatar
Nikolai Kosjar committed
945 946 947
    IfStatementAST *pattern;
    BinaryExpressionAST *condition;
};
948

949 950
} // anonymous namespace

Nikolai Kosjar's avatar
Nikolai Kosjar committed
951 952 953 954
void SplitIfStatement::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
{
    IfStatementAST *pattern = 0;
    const QList<AST *> &path = interface->path();
955

Nikolai Kosjar's avatar
Nikolai Kosjar committed
956 957 958 959 960 961
    int index = path.size() - 1;
    for (; index != -1; --index) {
        AST *node = path.at(index);
        if (IfStatementAST *stmt = node->asIfStatement()) {
            pattern = stmt;
            break;
962
        }