1
2
3
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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
88
89
90
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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "formeditorplugin.h"
#include "formeditorw.h"
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/testdatadir.h>
#include <cppeditor/builtineditordocumentprocessor.h>
#include <cppeditor/cppmodelmanager.h>
#include <cppeditor/cpptoolstestcase.h>
#include <cppeditor/editordocumenthandle.h>
#include <cplusplus/CppDocument.h>
#include <cplusplus/Overview.h>
#include <utils/fileutils.h>
#include <QDesignerFormEditorInterface>
#include <QDesignerIntegrationInterface>
#include <QStringList>
#include <QtTest>
using namespace Core;
using namespace Core::Tests;
using namespace CppEditor;
using namespace CPlusPlus;
using namespace Designer;
using namespace Designer::Internal;
namespace {
QTC_DECLARE_MYTESTDATADIR("../../../tests/designer/")
class DocumentContainsFunctionDefinition: protected SymbolVisitor
{
public:
bool operator()(Scope *scope, const QString function)
{
if (!scope)
return false;
m_referenceFunction = function;
m_result = false;
accept(scope);
return m_result;
}
protected:
bool preVisit(Symbol *) { return !m_result; }
bool visit(Function *symbol)
{
const QString function = m_overview.prettyName(symbol->name());
if (function == m_referenceFunction)
m_result = true;
return false;
}
private:
bool m_result;
QString m_referenceFunction;
Overview m_overview;
};
class DocumentContainsDeclaration: protected SymbolVisitor
{
public:
bool operator()(Scope *scope, const QString &function)
{
if (!scope)
return false;
m_referenceFunction = function;
m_result = false;
accept(scope);
return m_result;
}
protected:
bool preVisit(Symbol *) { return !m_result; }
void postVisit(Symbol *symbol)
{
if (symbol->asClass())
m_currentClass.clear();
}
bool visit(Class *symbol)
{
m_currentClass = m_overview.prettyName(symbol->name());
return true;
}
bool visit(Declaration *symbol)
{
QString declaration = m_overview.prettyName(symbol->name());
if (!m_currentClass.isEmpty())
declaration = m_currentClass + "::" + declaration;
if (m_referenceFunction == declaration)
m_result = true;
return false;
}
private:
bool m_result;
QString m_referenceFunction;
QString m_currentClass;
Overview m_overview;
};
bool documentContainsFunctionDefinition(const Document::Ptr &document, const QString &function)
{
return DocumentContainsFunctionDefinition()(document->globalNamespace(), function);
}
bool documentContainsMemberFunctionDeclaration(const Document::Ptr &document,
const QString &declaration)
{
return DocumentContainsDeclaration()(document->globalNamespace(), declaration);
}
class GoToSlotTestCase : public CppEditor::Tests::TestCase
{
public:
GoToSlotTestCase(const QStringList &files)
{
QVERIFY(succeededSoFar());
QCOMPARE(files.size(), 3);
QList<TextEditor::BaseTextEditor *> editors;
for (const QString &file : files) {
IEditor *editor = EditorManager::openEditor(Utils::FilePath::fromString(file));
TextEditor::BaseTextEditor *e = qobject_cast<TextEditor::BaseTextEditor *>(editor);
QVERIFY(e);
closeEditorAtEndOfTestCase(editor);
editors << e;
}
const QString cppFile = files.at(0);
const QString hFile = files.at(1);
QCOMPARE(DocumentModel::openedDocuments().size(), files.size());
waitForFilesInGlobalSnapshot({cppFile, hFile});
// Execute "Go To Slot"
QDesignerIntegrationInterface *integration = FormEditorW::designerEditor()->integration();
QVERIFY(integration);
integration->emitNavigateToSlot("pushButton", "clicked()", QStringList());
QCOMPARE(EditorManager::currentDocument()->filePath().toString(), cppFile);
QVERIFY(EditorManager::currentDocument()->isModified());
// Wait for updated documents
for (TextEditor::BaseTextEditor *editor : qAsConst(editors)) {
QElapsedTimer t;
t.start();
const QString filePath = editor->document()->filePath().toString();
if (auto parser = BuiltinEditorDocumentParser::get(filePath)) {
while (t.elapsed() < 2000) {
if (Document::Ptr document = parser->document()) {
if (document->editorRevision() == 2)
break;
}
QApplication::processEvents();
}
}
}
// Compare
const auto cppDocumentParser = BuiltinEditorDocumentParser::get(cppFile);
QVERIFY(cppDocumentParser);
const Document::Ptr cppDocument = cppDocumentParser->document();
QVERIFY(cppDocument->editorRevision() >= 2);
QVERIFY(checkDiagsnosticMessages(cppDocument));
const auto hDocumentParser = BuiltinEditorDocumentParser::get(hFile);
QVERIFY(hDocumentParser);
const Document::Ptr hDocument = hDocumentParser->document();
QVERIFY(checkDiagsnosticMessages(hDocument));
QVERIFY(documentContainsFunctionDefinition(cppDocument, "Form::on_pushButton_clicked"));
QVERIFY(documentContainsMemberFunctionDeclaration(hDocument, "Form::on_pushButton_clicked"));
}
static bool checkDiagsnosticMessages(const Document::Ptr &document)
{
if (!document)
return false;
// Since no project is opened and the ui_*.h is not generated,
// the following diagnostic messages will be ignored.
const QStringList ignoreList = QStringList({"ui_form.h: No such file or directory",
"QWidget: No such file or directory"});
QList<Document::DiagnosticMessage> cleanedDiagnosticMessages;
const auto diagnosticMessages = document->diagnosticMessages();
for (const Document::DiagnosticMessage &message : diagnosticMessages) {
if (!ignoreList.contains(message.text()))
cleanedDiagnosticMessages << message;
}
return cleanedDiagnosticMessages.isEmpty();
}
};
} // anonymous namespace
namespace Designer {
namespace Internal {
/// Check: Executes "Go To Slot..." on a QPushButton in a *.ui file and checks if the respective
/// header and source files are correctly updated.
void FormEditorPlugin::test_gotoslot()
{
QFETCH(QStringList, files);
(GoToSlotTestCase(files));
}
void FormEditorPlugin::test_gotoslot_data()
{
typedef QLatin1String _;
QTest::addColumn<QStringList>("files");
MyTestDataDir testDataDirWithoutProject(_("gotoslot_withoutProject"));
QTest::newRow("withoutProject")
<< QStringList({testDataDirWithoutProject.file(_("form.cpp")),
testDataDirWithoutProject.file(_("form.h")),
testDataDirWithoutProject.file(_("form.ui"))});
// Finding the right class for inserting definitions/declarations is based on
// finding a class with a member whose type is the class from the "ui_xxx.h" header.
// In the following test data the header files contain an extra class referencing
// the same class name.
MyTestDataDir testDataDir;
testDataDir = MyTestDataDir(_("gotoslot_insertIntoCorrectClass_pointer"));
QTest::newRow("insertIntoCorrectClass_pointer")
<< QStringList({testDataDir.file(_("form.cpp")), testDataDir.file(_("form.h")),
testDataDirWithoutProject.file(_("form.ui"))}); // reuse
testDataDir = MyTestDataDir(_("gotoslot_insertIntoCorrectClass_non-pointer"));
QTest::newRow("insertIntoCorrectClass_non-pointer")
<< QStringList({testDataDir.file(_("form.cpp")), testDataDir.file(_("form.h")),
testDataDirWithoutProject.file(_("form.ui"))}); // reuse
testDataDir = MyTestDataDir(_("gotoslot_insertIntoCorrectClass_pointer_ns_using"));
QTest::newRow("insertIntoCorrectClass_pointer_ns_using")
<< QStringList({testDataDir.file(_("form.cpp")), testDataDir.file(_("form.h")),
testDataDir.file(_("form.ui"))});
}
} // namespace Internal
} // namespace Designer
|
