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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "projectnodes.h"
#include "project.h"
#include "task.h"
#include <coreplugin/editormanager/ieditor.h>
#include <utils/fileutils.h>
#include <utils/environment.h>
#include <QByteArray>
#include <QFuture>
#include <QHash>
#include <QList>
#include <functional>
#include <memory>
QT_FORWARD_DECLARE_CLASS(QProcess);
QT_FORWARD_DECLARE_CLASS(QThreadPool);
namespace ProjectExplorer {
class ExtraCompilerPrivate;
using FileNameToContentsHash = QHash<Utils::FilePath, QByteArray>;
class PROJECTEXPLORER_EXPORT ExtraCompiler : public QObject
{
Q_OBJECT
public:
ExtraCompiler(const Project *project, const Utils::FilePath &source,
const Utils::FilePaths &targets, QObject *parent = nullptr);
~ExtraCompiler() override;
const Project *project() const;
Utils::FilePath source() const;
// You can set the contents from the outside. This is done if the file has been (re)created by
// the regular build process.
void setContent(const Utils::FilePath &file, const QByteArray &content);
QByteArray content(const Utils::FilePath &file) const;
Utils::FilePaths targets() const;
void forEachTarget(std::function<void(const Utils::FilePath &)> func);
void setCompileTime(const QDateTime &time);
QDateTime compileTime() const;
static QThreadPool *extraCompilerThreadPool();
signals:
void contentsChanged(const Utils::FilePath &file);
protected:
Utils::Environment buildEnvironment() const;
void setCompileIssues(const Tasks &issues);
private:
void onTargetsBuilt(Project *project);
void onEditorChanged(Core::IEditor *editor);
void onEditorAboutToClose(Core::IEditor *editor);
void setDirty();
// This method may not block!
virtual void run(const QByteArray &sourceContent) = 0;
virtual void run(const Utils::FilePath &file) = 0;
const std::unique_ptr<ExtraCompilerPrivate> d;
};
class PROJECTEXPLORER_EXPORT ProcessExtraCompiler : public ExtraCompiler
{
Q_OBJECT
public:
ProcessExtraCompiler(const Project *project, const Utils::FilePath &source,
const Utils::FilePaths &targets, QObject *parent = nullptr);
~ProcessExtraCompiler() override;
protected:
// This will run a process in a thread, if
// * command() does not return an empty file name
// * command() is exectuable
// * prepareToRun returns true
// * The process is not yet running
void run(const QByteArray &sourceContents) override;
void run(const Utils::FilePath &fileName) override;
// Information about the process to run:
virtual Utils::FilePath workingDirectory() const;
virtual Utils::FilePath command() const = 0;
virtual QStringList arguments() const;
virtual bool prepareToRun(const QByteArray &sourceContents);
virtual void handleProcessError(QProcess *process) { Q_UNUSED(process) }
virtual void handleProcessStarted(QProcess *process, const QByteArray &sourceContents)
{ Q_UNUSED(process); Q_UNUSED(sourceContents) }
virtual FileNameToContentsHash handleProcessFinished(QProcess *process) = 0;
virtual Tasks parseIssues(const QByteArray &stdErr);
private:
using ContentProvider = std::function<QByteArray()>;
void runImpl(const ContentProvider &sourceContents);
void runInThread(QFutureInterface<FileNameToContentsHash> &futureInterface,
const Utils::FilePath &cmd, const Utils::FilePath &workDir,
const QStringList &args, const ContentProvider &provider,
const Utils::Environment &env);
void cleanUp();
QFutureWatcher<FileNameToContentsHash> *m_watcher = nullptr;
};
class PROJECTEXPLORER_EXPORT ExtraCompilerFactoryObserver
{
friend class ExtraCompilerFactory;
protected:
ExtraCompilerFactoryObserver();
~ExtraCompilerFactoryObserver();
virtual void newExtraCompiler(const Project *project,
const Utils::FilePath &source,
const Utils::FilePaths &targets)
= 0;
};
class PROJECTEXPLORER_EXPORT ExtraCompilerFactory : public QObject
{
Q_OBJECT
public:
explicit ExtraCompilerFactory(QObject *parent = nullptr);
~ExtraCompilerFactory() override;
virtual FileType sourceType() const = 0;
virtual QString sourceTag() const = 0;
virtual ExtraCompiler *create(const Project *project,
const Utils::FilePath &source,
const Utils::FilePaths &targets)
= 0;
void annouceCreation(const Project *project,
const Utils::FilePath &source,
const Utils::FilePaths &targets);
static QList<ExtraCompilerFactory *> extraCompilerFactories();
};
} // namespace ProjectExplorer
|
