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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "cppsourceprocessor_test.h"
#include "baseeditordocumentprocessor.h"
#include "cppmodelmanager.h"
#include "cppsourceprocessertesthelper.h"
#include "cppsourceprocessor.h"
#include "cpptoolstestcase.h"
#include "editordocumenthandle.h"
#include <coreplugin/testdatadir.h>
#include <texteditor/texteditor.h>
#include <cplusplus/CppDocument.h>
#include <utils/fileutils.h>
#include <QFile>
#include <QFileInfo>
#include <QtTest>
using namespace CPlusPlus;
using namespace ProjectExplorer;
using namespace Utils;
using Include = Document::Include;
using CppEditor::Tests::TestCase;
using CppEditor::Tests::Internal::TestIncludePaths;
namespace CppEditor::Internal {
class SourcePreprocessor
{
public:
SourcePreprocessor()
: m_cmm(CppModelManager::instance())
{
cleanUp();
}
Document::Ptr run(const FilePath &filePath) const
{
QScopedPointer<CppSourceProcessor> sourceProcessor(
CppModelManager::createSourceProcessor());
sourceProcessor->setHeaderPaths({ProjectExplorer::HeaderPath::makeUser(
TestIncludePaths::directoryOfTestFile())});
sourceProcessor->run(filePath);
Document::Ptr document = m_cmm->document(filePath);
return document;
}
~SourcePreprocessor()
{
cleanUp();
}
private:
void cleanUp()
{
m_cmm->GC();
QVERIFY(m_cmm->snapshot().isEmpty());
}
private:
CppModelManager *m_cmm;
};
/// Check: Resolved and unresolved includes are properly tracked.
void SourceProcessorTest::testIncludesResolvedUnresolved()
{
const FilePath testFilePath
= TestIncludePaths::testFilePath(QLatin1String("test_main_resolvedUnresolved.cpp"));
SourcePreprocessor processor;
Document::Ptr document = processor.run(testFilePath);
QVERIFY(document);
const QList<Document::Include> resolvedIncludes = document->resolvedIncludes();
QCOMPARE(resolvedIncludes.size(), 1);
QCOMPARE(resolvedIncludes.at(0).type(), Client::IncludeLocal);
QCOMPARE(resolvedIncludes.at(0).unresolvedFileName(), QLatin1String("header.h"));
const FilePath expectedResolvedFileName
= TestIncludePaths::testFilePath(QLatin1String("header.h"));
QCOMPARE(resolvedIncludes.at(0).resolvedFileName(), expectedResolvedFileName);
const QList<Document::Include> unresolvedIncludes = document->unresolvedIncludes();
QCOMPARE(unresolvedIncludes.size(), 1);
QCOMPARE(unresolvedIncludes.at(0).type(), Client::IncludeLocal);
QCOMPARE(unresolvedIncludes.at(0).unresolvedFileName(), QLatin1String("notresolvable.h"));
QVERIFY(unresolvedIncludes.at(0).resolvedFileName().isEmpty());
}
/// Check: Avoid self-include entries due to cyclic includes.
void SourceProcessorTest::testIncludesCyclic()
{
const FilePath filePath1 = TestIncludePaths::testFilePath(QLatin1String("cyclic1.h"));
const FilePath filePath2 = TestIncludePaths::testFilePath(QLatin1String("cyclic2.h"));
const QSet<FilePath> sourceFiles = {filePath1, filePath2};
// Create global snapshot (needed in BuiltinEditorDocumentParser)
TestCase testCase;
testCase.parseFiles(sourceFiles);
// Open editor
TextEditor::BaseTextEditor *editor;
QVERIFY(testCase.openCppEditor(filePath1, &editor));
testCase.closeEditorAtEndOfTestCase(editor);
// Check editor snapshot
const FilePath filePath = editor->document()->filePath();
auto processor = CppModelManager::cppEditorDocumentProcessor(filePath);
QVERIFY(processor);
QVERIFY(TestCase::waitForProcessedEditorDocument(filePath));
Snapshot snapshot = processor->snapshot();
QCOMPARE(snapshot.size(), 3); // Configuration file included
// Check includes
Document::Ptr doc1 = snapshot.document(filePath1);
QVERIFY(doc1);
Document::Ptr doc2 = snapshot.document(filePath2);
QVERIFY(doc2);
QCOMPARE(doc1->unresolvedIncludes().size(), 0);
QCOMPARE(doc1->resolvedIncludes().size(), 1);
QCOMPARE(doc1->resolvedIncludes().first().resolvedFileName(), filePath2);
QCOMPARE(doc2->unresolvedIncludes().size(), 0);
QCOMPARE(doc2->resolvedIncludes().size(), 1);
QCOMPARE(doc2->resolvedIncludes().first().resolvedFileName(), filePath1);
}
/// Check: All include errors are reported as diagnostic messages.
void SourceProcessorTest::testIncludesAllDiagnostics()
{
const FilePath testFilePath
= TestIncludePaths::testFilePath(QLatin1String("test_main_allDiagnostics.cpp"));
SourcePreprocessor processor;
Document::Ptr document = processor.run(testFilePath);
QVERIFY(document);
QCOMPARE(document->resolvedIncludes().size(), 0);
QCOMPARE(document->unresolvedIncludes().size(), 3);
QCOMPARE(document->diagnosticMessages().size(), 3);
}
void SourceProcessorTest::testMacroUses()
{
const FilePath testFilePath
= TestIncludePaths::testFilePath(QLatin1String("test_main_macroUses.cpp"));
SourcePreprocessor processor;
Document::Ptr document = processor.run(testFilePath);
QVERIFY(document);
const QList<Document::MacroUse> macroUses = document->macroUses();
QCOMPARE(macroUses.size(), 1);
const Document::MacroUse macroUse = macroUses.at(0);
QCOMPARE(macroUse.bytesBegin(), 25);
QCOMPARE(macroUse.bytesEnd(), 35);
QCOMPARE(macroUse.utf16charsBegin(), 25);
QCOMPARE(macroUse.utf16charsEnd(), 35);
QCOMPARE(macroUse.beginLine(), 2);
}
static bool isMacroDefinedInDocument(const QByteArray ¯oName, const Document::Ptr &document)
{
for (const CPlusPlus::Macro ¯o : document->definedMacros()) {
if (macro.name() == macroName)
return true;
}
return false;
}
static inline QString _(const QByteArray &ba) { return QString::fromLatin1(ba, ba.size()); }
void SourceProcessorTest::testIncludeNext()
{
const Core::Tests::TestDataDir data(
_(SRCDIR "/../../../tests/auto/cplusplus/preprocessor/data/include_next-data/"));
const FilePath mainFilePath = data.filePath(QLatin1String("main.cpp"));
const QString customHeaderPath = data.directory(QLatin1String("customIncludePath"));
const QString systemHeaderPath = data.directory(QLatin1String("systemIncludePath"));
CppSourceProcessor::DocumentCallback documentCallback = [](const Document::Ptr &){};
CppSourceProcessor sourceProcessor(Snapshot(), documentCallback);
sourceProcessor.setHeaderPaths(ProjectExplorer::toUserHeaderPaths(
QStringList{customHeaderPath, systemHeaderPath}));
sourceProcessor.run(mainFilePath);
const Snapshot snapshot = sourceProcessor.snapshot();
QVERIFY(!snapshot.isEmpty());
const Document::Ptr mainDocument = snapshot.document(mainFilePath);
QVERIFY(mainDocument);
QVERIFY(isMacroDefinedInDocument("OK_FEATURE_X_ENABLED", mainDocument));
}
} // namespace CppEditor::Internal
|
