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

627
        if (CoreDeclaratorAST *coreDecl = node->asCoreDeclarator()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
628
            core_declarator = coreDecl;
629
        } else if (SimpleDeclarationAST *simpleDecl = node->asSimpleDeclaration()) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
630
631
            if (checkDeclaration(simpleDecl)) {
                SimpleDeclarationAST *declaration = simpleDecl;
632

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

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

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

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

656
657
namespace {

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

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

        ChangeSet changes;
674

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

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

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

private:
    StatementAST *_statement;
};

690
691
} // anonymous namespace

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

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

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

723
724
namespace {

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

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

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

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

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

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

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

763
764
} // anonymous namespace

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

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

791
792
namespace {

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

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

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

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

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

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

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

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

834
835
} // anonymous namespace

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

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

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

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

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

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

868
869
namespace {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

948
949
} // anonymous namespace

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

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
964
965
    if (! pattern || ! pattern->statement)
        return;
966

Nikolai Kosjar's avatar
Nikolai Kosjar committed
967
968
969
970
971
972
    unsigned splitKind = 0;
    for (++index; index < path.size(); ++index) {
        AST *node = path.at(index);
        BinaryExpressionAST *condition = node->asBinaryExpression();
        if (! condition)
            return;
973

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

Nikolai Kosjar's avatar
Nikolai Kosjar committed
976
977
978
979
980
981
982
983
984
985
        // 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;
986
987
        }

Nikolai Kosjar's avatar
Nikolai Kosjar committed
988
989
990
991
        if (interface->isCursorOn(condition->binary_op_token)) {
            result.append(QuickFixOperation::Ptr(
                new SplitIfStatementOp(interface, index, pattern, condition)));
            return;
992
        }
Nikolai Kosjar's avatar
Nikolai Kosjar committed
993
994
    }
}
995

996
997
998
999
/* 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,
1000
                                          const CppRefactoringFilePtr &file, Type *type,
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
                                          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;
1023
        }
1024
    }
1025

1026
1027
1028
1029
1030
1031
1032
1033
    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;
1034
1035
1036
1037
                    }
                }
            }
        }
1038
1039
1040
    }
    return literal;
}
1041

1042
1043
namespace {

Nikolai Kosjar's avatar
Nikolai Kosjar committed
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
/// 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)) {
1075
1076
            const QString newQuote((m_actions & Factory::SingleQuoteAction)
                                   ? QLatin1Char('\'') : QLatin1Char('"'));
Nikolai Kosjar's avatar
Nikolai Kosjar committed
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
            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('(');
1108
1109
            if (m_actions
                    & (Factory::TranslateQCoreApplicationAction | Factory::TranslateNoopAction)) {
Nikolai Kosjar's avatar
Nikolai Kosjar committed
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
                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;
};

1127
1128
} // anonymous namespace

1129
void WrapStringLiteral::match(const CppQuickFixInterface &interface, QuickFixOperations &result)
1130
1131
1132
1133
1134
1135
1136
{
    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
1137
    ExpressionAST *literal = analyze(path, file, &type, &enclosingFunction);
1138
    if (!literal || type == TypeNone)
1139
        return;
1140
1141
1142
    if ((type == TypeChar && enclosingFunction == "QLatin1Char")
        || isQtStringLiteral(enclosingFunction)
        || isQtStringTranslation(enclosingFunction))
1143
        return;
1144

1145
1146
1147
    const int priority = path.size() - 1; // very high priority
    if (type == TypeChar) {
        unsigned actions = EncloseInQLatin1CharAction;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
1148
1149
1150
        QString description = msgQtStringLiteralDescription(replacement(actions));
        result << OperationPtr(new WrapStringLiteralOp(interface, priority, actions,
                                                             description, literal));
1151
1152
1153
1154
1155
1156
        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
1157
1158
                result << OperationPtr(new WrapStringLiteralOp(interface, priority, actions,
                                                                     description, literal));
1159
            }
1160
        }