cppquickfix_test.cpp 16.2 KB
Newer Older
1
2
/****************************************************************************
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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.
**
** GNU Lesser General Public License Usage
** 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
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include <AST.h>
31
#include <Bind.h>
32
33
34
35
#include <Control.h>
#include <CppDocument.h>
#include <DiagnosticClient.h>
#include <Literals.h>
36
#include <Scope.h>
37
#include <Symbols.h>
38
39
#include <TranslationUnit.h>

40
41
#include <coreplugin/editormanager/editormanager.h>
#include <cppeditor/cppeditor.h>
42
#include <cppeditor/cppinsertdecldef.h>
43
44
#include <cppeditor/cppplugin.h>
#include <cppeditor/cppquickfixassistant.h>
45
#include <cppeditor/cppquickfix.h>
46
#include <extensionsystem/pluginmanager.h>
47
48
49
50
51
52
#include <texteditor/basetextdocument.h>
#include <texteditor/codeassist/basicproposalitemlistmodel.h>
#include <texteditor/codeassist/iassistproposal.h>
#include <texteditor/codeassist/iassistproposalmodel.h>
#include <texteditor/plaintexteditor.h>
#include <utils/changeset.h>
53
54
55
56
#include <utils/fileutils.h>

#include <QDebug>
#include <QDir>
57
58
59
#include <QTextDocument>
#include <QtTest>

60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

/*!
    Tests for quick-fixes.
 */
using namespace CPlusPlus;
using namespace CppEditor;
using namespace CppEditor::Internal;
using namespace CppTools;
using namespace TextEditor;
using namespace Core;

namespace {
/**
 * Encapsulates the whole process of setting up an editor, getting the
 * quick-fix, applying it, and checking the result.
 */
struct TestCase
{
    QByteArray originalText;
    int pos;
    CPPEditor *editor;
    CPPEditorWidget *editorWidget;

    TestCase(const QByteArray &input);
    ~TestCase();

    QuickFixOperation::Ptr getFix(CppQuickFixFactory *factory);

88
89
    void run(CppQuickFixFactory *factory, const QByteArray &expected, bool changesExpected = true,
             int undoCount = 1);
90
91
92
93
94
95

private:
    TestCase(const TestCase &);
    TestCase &operator=(const TestCase &);
};

96
/// Apply the factory on the source and get back the first result or a null pointer.
97
98
99
100
101
QuickFixOperation::Ptr TestCase::getFix(CppQuickFixFactory *factory)
{
    CppQuickFixInterface qfi(new CppQuickFixAssistInterface(editorWidget, ExplicitlyInvoked));
    TextEditor::QuickFixOperations results;
    factory->match(qfi, results);
102
    return results.isEmpty() ? QuickFixOperation::Ptr() : results.first();
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
}

/// The '@' in the input is the position from where the quick-fix discovery is triggered.
TestCase::TestCase(const QByteArray &input)
    : originalText(input)
{
    pos = originalText.indexOf('@');
    QVERIFY(pos != -1);
    originalText.remove(pos, 1);
    QString fileName(QDir::tempPath() + QLatin1String("/file.cpp"));
    Utils::FileSaver srcSaver(fileName);
    srcSaver.write(originalText);
    srcSaver.finalize();
    CPlusPlus::CppModelManagerInterface::instance()->updateSourceFiles(QStringList()<<fileName);

    // wait for the parser in the future to give us the document:
    while (true) {
        Snapshot s = CPlusPlus::CppModelManagerInterface::instance()->snapshot();
        if (s.contains(fileName))
            break;
        QCoreApplication::processEvents();
    }

    editor = dynamic_cast<CPPEditor *>(EditorManager::openEditor(fileName));
    QVERIFY(editor);
    editor->setCursorPosition(pos);
    editorWidget = dynamic_cast<CPPEditorWidget *>(editor->editorWidget());
    QVERIFY(editorWidget);
    editorWidget->semanticRehighlight(true);

    // wait for the semantic info from the future:
    while (editorWidget->semanticInfo().doc.isNull())
        QCoreApplication::processEvents();
}

TestCase::~TestCase()
{
    EditorManager::instance()->closeEditors(QList<Core::IEditor *>() << editor,
                                            false);
    QCoreApplication::processEvents(); // process any pending events

    // Remove the test file from the code-model:
    CppModelManagerInterface *mmi = CPlusPlus::CppModelManagerInterface::instance();
    mmi->GC();
    QCOMPARE(mmi->snapshot().size(), 0);
}

/// Leading whitespace is not removed, so we can check if the indetation ranges
/// have been set correctly by the quick-fix.
QByteArray &removeTrailingWhitespace(QByteArray &input)
{
    QList<QByteArray> lines = input.split('\n');
    input.resize(0);
    foreach (QByteArray line, lines) {
        while (line.length() > 0) {
            char lastChar = line[line.length() - 1];
            if (lastChar == ' ' || lastChar == '\t')
                line = line.left(line.length() - 1);
            else
                break;
        }
        input.append(line);
        input.append('\n');
    }
    return input;
}

170
171
void TestCase::run(CppQuickFixFactory *factory, const QByteArray &expected,
                   bool changesExpected, int undoCount)
172
173
{
    QuickFixOperation::Ptr fix = getFix(factory);
174
175
176
177
178
    if (!fix) {
        QVERIFY2(!changesExpected, "No QuickFixOperation");
        return;
    }

179
180
181
182
    fix->perform();
    QByteArray result = editorWidget->document()->toPlainText().toUtf8();
    removeTrailingWhitespace(result);

183
    QCOMPARE(QLatin1String(result), QLatin1String(expected));
184
185
186
187
188
189
190
191
192

    for (int i = 0; i < undoCount; ++i)
        editorWidget->undo();

    result = editorWidget->document()->toPlainText().toUtf8();
    QCOMPARE(result, originalText);
}
} // anonymous namespace

193
194
195
196
/// Checks:
/// 1. If the name does not start with ("m_" or "_") and does not
///    end with "_", we are forced to prefix the getter with "get".
/// 2. Setter: Use pass by value on integer/float and pointer types.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
197
void CppPlugin::test_quickfix_GenerateGetterSetter_basicGetterWithPrefix()
198
199
200
201
202
203
204
205
206
207
208
209
210
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    int @it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    int it;\n"
            "\n"
            "public:\n"
211
            "    int getIt() const;\n"
212
213
214
            "    void setIt(int value);\n"
            "};\n"
            "\n"
215
216
217
218
219
220
221
222
223
224
225
226
            "int Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(int value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
227
    GenerateGetterSetter factory(/*testMode=*/ true);
228
229
230
231
232
233
    data.run(&factory, expected);
}

/// Checks:
/// 1. Getter: "get" prefix is not necessary.
/// 2. Setter: Parameter name is base name.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
234
void CppPlugin::test_quickfix_GenerateGetterSetter_basicGetterWithoutPrefix()
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    int @m_it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    int m_it;\n"
            "\n"
            "public:\n"
            "    int it() const;\n"
            "    void setIt(int it);\n"
            "};\n"
            "\n"
252
253
            "int Something::it() const\n"
            "{\n"
254
255
256
257
258
259
260
261
262
263
            "    return m_it;\n"
            "}\n"
            "\n"
            "void Something::setIt(int it)\n"
            "{\n"
            "    m_it = it;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
264
    GenerateGetterSetter factory(/*testMode=*/ true);
265
266
267
268
269
    data.run(&factory, expected);
}

/// Check: Setter: Use pass by reference for parameters which
/// are not integer, float or pointers.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
270
void CppPlugin::test_quickfix_GenerateGetterSetter_customType()
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    MyType @it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    MyType it;\n"
            "\n"
            "public:\n"
            "    MyType getIt() const;\n"
            "    void setIt(const MyType &value);\n"
            "};\n"
            "\n"
            "MyType Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(const MyType &value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
300
    GenerateGetterSetter factory(/*testMode=*/ true);
301
302
303
304
305
306
    data.run(&factory, expected);
}

/// Checks:
/// 1. Setter: No setter is generated for const members.
/// 2. Getter: Return a non-const type since it pass by value anyway.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
307
void CppPlugin::test_quickfix_GenerateGetterSetter_constMember()
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    const int @it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    const int it;\n"
            "\n"
            "public:\n"
            "    int getIt() const;\n"
            "};\n"
            "\n"
            "int Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
331
    GenerateGetterSetter factory(/*testMode=*/ true);
332
333
334
335
    data.run(&factory, expected);
}

/// Checks: No special treatment for pointer to non const.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
336
void CppPlugin::test_quickfix_GenerateGetterSetter_pointerToNonConst()
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
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    int *it@;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    int *it;\n"
            "\n"
            "public:\n"
            "    int *getIt() const;\n"
            "    void setIt(int *value);\n"
            "};\n"
            "\n"
            "int *Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(int *value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
366
    GenerateGetterSetter factory(/*testMode=*/ true);
367
368
369
370
    data.run(&factory, expected);
}

/// Checks: No special treatment for pointer to const.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
371
void CppPlugin::test_quickfix_GenerateGetterSetter_pointerToConst()
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    const int *it@;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    const int *it;\n"
            "\n"
            "public:\n"
            "    const int *getIt() const;\n"
            "    void setIt(const int *value);\n"
            "};\n"
            "\n"
            "const int *Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(const int *value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
401
    GenerateGetterSetter factory(/*testMode=*/ true);
402
403
404
405
406
407
    data.run(&factory, expected);
}

/// Checks:
/// 1. Setter: Setter is a static function.
/// 2. Getter: Getter is a static, non const function.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
408
void CppPlugin::test_quickfix_GenerateGetterSetter_staticMember()
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    static int @m_member;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    static int m_member;\n"
            "\n"
            "public:\n"
            "    static int member();\n"
            "    static void setMember(int member);\n"
            "};\n"
            "\n"
            "int Something::member()\n"
            "{\n"
            "    return m_member;\n"
            "}\n"
            "\n"
            "void Something::setMember(int member)\n"
            "{\n"
            "    m_member = member;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
438
    GenerateGetterSetter factory(/*testMode=*/ true);
439
440
441
442
    data.run(&factory, expected);
}

/// Check: Check if it works on the second declarator
Nikolai Kosjar's avatar
Nikolai Kosjar committed
443
void CppPlugin::test_quickfix_GenerateGetterSetter_secondDeclarator()
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    int *foo, @it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    int *foo, it;\n"
            "\n"
            "public:\n"
            "    int getIt() const;\n"
            "    void setIt(int value);\n"
            "};\n"
            "\n"
            "int Something::getIt() const\n"
            "{\n"
463
464
465
466
467
468
469
470
471
472
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(int value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
473
    GenerateGetterSetter factory(/*testMode=*/ true);
474
475
    data.run(&factory, expected);
}
476
477

/// Check: Quick fix is offered for "int *@it;" ('@' denotes the text cursor position)
Nikolai Kosjar's avatar
Nikolai Kosjar committed
478
void CppPlugin::test_quickfix_GenerateGetterSetter_triggeringRightAfterPointerSign()
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
{
    TestCase data("\n"
                  "class Something\n"
                  "{\n"
                  "    int *@it;\n"
                  "};\n"
                  );
    QByteArray expected = "\n"
            "class Something\n"
            "{\n"
            "    int *it;\n"
            "\n"
            "public:\n"
            "    int *getIt() const;\n"
            "    void setIt(int *value);\n"
            "};\n"
            "\n"
            "int *Something::getIt() const\n"
            "{\n"
            "    return it;\n"
            "}\n"
            "\n"
            "void Something::setIt(int *value)\n"
            "{\n"
            "    it = value;\n"
            "}\n"
            "\n"
            ;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
508
    GenerateGetterSetter factory(/*testMode=*/ true);
509
510
511
512
    data.run(&factory, expected);
}

/// Check: Quick fix is not triggered on a member function.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
513
void CppPlugin::test_quickfix_GenerateGetterSetter_notTriggeringOnMemberFunction()
514
515
516
517
{
    TestCase data("class Something { void @f(); };");
    QByteArray expected = data.originalText;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
518
    GenerateGetterSetter factory(/*testMode=*/ true);
519
520
521
522
    data.run(&factory, expected, /*changesExpected=*/ false);
}

/// Check: Quick fix is not triggered on an member array;
Nikolai Kosjar's avatar
Nikolai Kosjar committed
523
void CppPlugin::test_quickfix_GenerateGetterSetter_notTriggeringOnMemberArray()
524
525
526
527
{
    TestCase data("class Something { void @a[10]; };");
    QByteArray expected = data.originalText;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
528
    GenerateGetterSetter factory(/*testMode=*/ true);
529
530
531
532
533
    data.run(&factory, expected, /*changesExpected=*/ false);
}

/// Check: Do not offer the quick fix if there is already a member with the
/// getter or setter name we would generate.
Nikolai Kosjar's avatar
Nikolai Kosjar committed
534
void CppPlugin::test_quickfix_GenerateGetterSetter_notTriggeringWhenGetterOrSetterExist()
535
536
537
538
539
540
541
542
{
    TestCase data("\n"
                  "class Something {\n"
                  "     int @it;\n"
                  "     void setIt();\n"
                  "};\n");
    QByteArray expected = data.originalText;

Nikolai Kosjar's avatar
Nikolai Kosjar committed
543
    GenerateGetterSetter factory(/*testMode=*/ true);
544
545
    data.run(&factory, expected, /*changesExpected=*/ false);
}