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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** 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://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** 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.
**
****************************************************************************/
#ifndef CPPTOOLSTESTCASE_H
#define CPPTOOLSTESTCASE_H
#include "cppmodelmanager.h"
#include "cpptools_global.h"
#include <coreplugin/editormanager/ieditor.h>
#include <QStringList>
#include <QTemporaryDir>
namespace CPlusPlus {
class Document;
class Snapshot;
}
namespace Core { class IEditor; }
namespace ProjectExplorer { class Project; }
namespace TextEditor {
class BaseTextEditor;
class IAssistProposal;
}
namespace CppTools {
namespace Tests {
class CPPTOOLS_EXPORT TestDocument
{
public:
TestDocument(const QByteArray &fileName, const QByteArray &source, char cursorMarker = '@');
void setBaseDirectory(const QString &baseDirectory) { m_baseDirectory = baseDirectory; }
QString filePath() const;
bool writeToDisk() const;
public:
QString m_baseDirectory;
QString m_fileName;
QString m_source;
char m_cursorMarker;
};
class CPPTOOLS_EXPORT TestCase
{
Q_DISABLE_COPY(TestCase)
public:
TestCase(bool runGarbageCollector = true);
~TestCase();
bool succeededSoFar() const;
bool openBaseTextEditor(const QString &fileName, TextEditor::BaseTextEditor **editor);
void closeEditorAtEndOfTestCase(Core::IEditor *editor);
static bool closeEditorWithoutGarbageCollectorInvocation(Core::IEditor *editor);
static bool parseFiles(const QString &filePath);
static bool parseFiles(const QSet<QString> &filePaths);
static CPlusPlus::Snapshot globalSnapshot();
static bool garbageCollectGlobalSnapshot();
static bool waitUntilCppModelManagerIsAwareOf(ProjectExplorer::Project *project,
int timeOut = 30 * 1000 /*= 30 secs*/);
static CPlusPlus::Document::Ptr waitForFileInGlobalSnapshot(const QString &filePath);
static QList<CPlusPlus::Document::Ptr> waitForFilesInGlobalSnapshot(
const QStringList &filePaths);
static bool writeFile(const QString &filePath, const QByteArray &contents);
protected:
CppModelManager *m_modelManager;
bool m_succeededSoFar;
private:
QList<Core::IEditor *> m_editorsToClose;
bool m_runGarbageCollector;
};
class CPPTOOLS_EXPORT ProjectOpenerAndCloser : public QObject
{
Q_OBJECT
public:
ProjectOpenerAndCloser(bool waitForFinishedGcOnDestruction = true);
~ProjectOpenerAndCloser(); // Closes opened projects
ProjectInfo open(const QString &projectFile, bool configureAsExampleProject = false);
private:
void onGcFinished();
bool m_waitForFinishedGcOnDestruction;
bool m_gcFinished;
QList<ProjectExplorer::Project *> m_openProjects;
};
class TemporaryDir
{
Q_DISABLE_COPY(TemporaryDir)
public:
TemporaryDir();
bool isValid() const { return m_isValid; }
QString path() const { return m_temporaryDir.path(); }
QString createFile(const QByteArray &relativePath, const QByteArray &contents);
protected:
QTemporaryDir m_temporaryDir;
bool m_isValid;
};
class CPPTOOLS_EXPORT TemporaryCopiedDir : public TemporaryDir
{
public:
TemporaryCopiedDir(const QString &sourceDirPath);
QString absolutePath(const QByteArray &relativePath) const;
private:
TemporaryCopiedDir();
};
class CPPTOOLS_EXPORT VerifyCleanCppModelManager
{
public:
VerifyCleanCppModelManager() { verify(); }
~VerifyCleanCppModelManager() { verify(); }
static void verify();
};
class FileWriterAndRemover
{
public:
FileWriterAndRemover(const QString &filePath, const QByteArray &contents); // Writes file
bool writtenSuccessfully() const { return m_writtenSuccessfully; }
~FileWriterAndRemover(); // Removes file
private:
const QString m_filePath;
bool m_writtenSuccessfully;
};
// Normally the proposal is deleted by the ProcessorRunner or the
// GenericProposalWidget, but in tests we usually don't make use of them.
class CPPTOOLS_EXPORT IAssistProposalScopedPointer
{
public:
IAssistProposalScopedPointer(TextEditor::IAssistProposal *proposal);
~IAssistProposalScopedPointer();
QScopedPointer<TextEditor::IAssistProposal> d;
};
} // namespace Tests
} // namespace CppTools
#endif // CPPTOOLSTESTCASE_H
|
