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
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef BUILDSTEP_H
#define BUILDSTEP_H
#include "projectconfiguration.h"
#include "projectexplorer_export.h"
#include "task.h"
#include <QtCore/QFutureInterface>
#include <QtGui/QWidget>
namespace ProjectExplorer {
class BuildConfiguration;
class BuildStepList;
class DeployConfiguration;
class Target;
/*
// 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!
//
*/
class BuildStepConfigWidget;
class PROJECTEXPLORER_EXPORT BuildStep : public ProjectConfiguration
{
Q_OBJECT
protected:
BuildStep(BuildStepList *bsl, const QString &id);
BuildStep(BuildStepList *bsl, BuildStep *bs);
public:
virtual ~BuildStep();
// This function is run in the gui thread,
// use it to retrieve any information that you need in run()
virtual bool init() = 0;
// Reimplement this. This function is called when the target 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 Widget shown in the target settings dialog for this buildStep
// ownership is transferred to the caller
virtual BuildStepConfigWidget *createConfigWidget() = 0;
// if this function returns true, the user can't delete this BuildStep for this target
// and the user is prevented from changing the order immutable steps are run
// the default implementation returns false
virtual bool immutable() const;
BuildConfiguration *buildConfiguration() const;
DeployConfiguration *deployConfiguration() const;
Target *target() const;
enum OutputFormat { NormalOutput, ErrorOutput, MessageOutput, ErrorMessageOutput };
signals:
// Add a task.
void addTask(const ProjectExplorer::Task &task);
// The string is added to the generated output, usually in the output
// window.
// It should be in plain text, with the format in the parameter
void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format);
};
class PROJECTEXPLORER_EXPORT IBuildStepFactory :
public QObject
{
Q_OBJECT
public:
explicit IBuildStepFactory(QObject *parent = 0);
virtual ~IBuildStepFactory();
// used to show the list of possible additons to a target, returns a list of types
virtual QStringList availableCreationIds(BuildStepList *parent) const = 0;
// used to translate the types to names to display to the user
virtual QString displayNameForId(const QString &id) const = 0;
virtual bool canCreate(BuildStepList *parent, const QString &id) const = 0;
virtual BuildStep *create(BuildStepList *parent, const QString &id) = 0;
// used to recreate the runConfigurations when restoring settings
virtual bool canRestore(BuildStepList *parent, const QVariantMap &map) const = 0;
virtual BuildStep *restore(BuildStepList *parent, const QVariantMap &map) = 0;
virtual bool canClone(BuildStepList *parent, BuildStep *product) const = 0;
virtual BuildStep *clone(BuildStepList *parent, BuildStep *product) = 0;
};
class PROJECTEXPLORER_EXPORT BuildConfigWidget
: public QWidget
{
Q_OBJECT
public:
BuildConfigWidget()
:QWidget(0)
{}
virtual QString displayName() const = 0;
// This is called to set up the config widget before showing it
virtual void init(BuildConfiguration *bc) = 0;
signals:
void displayNameChanged(const QString &);
};
class PROJECTEXPLORER_EXPORT BuildStepConfigWidget
: public QWidget
{
Q_OBJECT
public:
BuildStepConfigWidget()
: QWidget()
{}
virtual void init() = 0;
virtual QString summaryText() const = 0;
virtual QString displayName() const = 0;
signals:
void updateSummary();
};
} // namespace ProjectExplorer
Q_DECLARE_METATYPE(ProjectExplorer::BuildStep::OutputFormat)
#endif // BUILDSTEP_H
|
