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
|
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file. Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.2, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
#ifndef BUILDSTEP_H
#define BUILDSTEP_H
#include "buildparserinterface.h"
#include "project.h"
#include "projectexplorer_export.h"
#include <QtGui/QWidget>
#include <QtCore/QFutureInterface>
namespace ProjectExplorer {
class BuildConfiguration;
/*
// BuildSteps are the primary way plugin developers can customize
// how their projects (or projects from other plugins) are build.
//
// Building a project, is done by taking the list of buildsteps
// from the project and calling first init() than run() on them.
//
// That means to change the way your project is build, reimplemnt
// this class and add your Step to the buildStep list of the project.
//
// Note: The projects own the buildstep, do not delete them yourself.
//
// init() is called in the GUI thread and can be used to query the
// project for any information you need.
//
// run() is run via QtConccurrent in a own thread, if you need an
// eventloop you need to create it yourself!
//
// You can use setValue() to store settings which a specific
// to your buildstep. (You can set settings to apply only
// to one buildconfiguration.
// And later retrieve the same information with value()
*/
class BuildStepConfigWidget;
class PROJECTEXPLORER_EXPORT BuildStep : public QObject
{
Q_OBJECT
friend class Project; //for managing BuildConfigurations
public:
BuildStep(Project *p);
virtual ~BuildStep();
// This function is run in the gui thread,
// use it to retrieve any information that you need in run()
virtual bool init(const QString &buildConfiguration) = 0;
// Reimplement this. This function is called when the project is build.
// This function is NOT run in the gui thread. It runs in its own thread
// If you need an event loop, you need to create one.
// The absolute minimal implementation is:
// fi.reportResult(true);
virtual void run(QFutureInterface<bool> &fi) = 0;
// The internal name
virtual QString name() = 0;
// The name shown to the user
virtual QString displayName() = 0;
// sets a value, which can be retrieved with value()
// these values are automatically saved and restored when qt creator is quit and restarted
void setValue(const QString &name, const QVariant &value);
// sets a value specific to a buildConfiguration
void setValue(const QString &buildConfiguration, const QString &name, const QVariant &value);
// retrieves a value
QVariant value(const QString &name) const;
// retrieves a value specific to a buildConfiguration
QVariant value(const QString &buildConfiguration, const QString & name) const;
// the Widget shown in the project settings dialog for this buildStep
// ownership is transfered to the caller
virtual BuildStepConfigWidget *createConfigWidget() = 0;
// if this function returns true, the user can't delete this BuildStep for this project
// and the user is prevented from changing the order immutable steps are run
// the default implementation returns false
virtual bool immutable() const;
Project *project() const;
protected:
// internal function for restoring the configuration
void setValuesFromMap(const QMap<QString, QVariant> &values);
// internal function for restoring the configuration
void setValuesFromMap(const QString &buildConfiguration, const QMap<QString, QVariant> &values);
// internal function for storing the configuration
QMap<QString, QVariant> valuesToMap();
// internal function for storing the configuration
QMap<QString, QVariant> valuesToMap(const QString & buildConfiguration);
Q_SIGNALS:
void addToTaskWindow(const QString &filename, int type, int linenumber, const QString &description);
void addToOutputWindow(const QString &string);
void displayNameChanged(BuildStep *, const QString &displayName);
private:
QList<BuildConfiguration *> buildConfigurations();
void addBuildConfiguration(const QString & name);
void removeBuildConfiguration(const QString & name);
BuildConfiguration *getBuildConfiguration(const QString & name) const;
void copyBuildConfiguration(const QString &source, const QString &dest);
QList<BuildConfiguration *> m_buildConfigurations;
BuildConfiguration *m_configuration;
Project *m_project;
};
class PROJECTEXPLORER_EXPORT IBuildStepFactory
: public QObject
{
Q_OBJECT
public:
IBuildStepFactory();
virtual ~IBuildStepFactory();
// Called to check wheter this factory can restore the named BuildStep
virtual bool canCreate(const QString &name) const = 0;
// Called to restore a buildstep
virtual BuildStep *create(Project *pro, const QString &name) const = 0;
// Caleld by the add BuildStep action to check which BuildSteps could be added
// to the project by this factory, should return a list of names
virtual QStringList canCreateForProject(Project *pro) const = 0;
// Called to convert an internal name to a displayName
virtual QString displayNameForName(const QString &name) const = 0;
};
class PROJECTEXPLORER_EXPORT BuildStepConfigWidget
: public QWidget
{
Q_OBJECT
public:
BuildStepConfigWidget()
:QWidget(0)
{}
virtual QString displayName() const = 0;
// This is called to set up the config widget before showing it
// buildConfiguration is QString::null for the non buildConfiguration specific page
virtual void init(const QString &buildConfiguration) = 0;
};
} // namespace ProjectExplorer
#endif // BUILDSTEP_H
|
