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
|
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008-2009 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.3, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
#ifndef RUNCONFIGURATION_H
#define RUNCONFIGURATION_H
#include "projectexplorer_export.h"
#include <QtCore/QObject>
#include <QtCore/QMetaType>
#include <QtCore/QPointer>
#include <QtCore/QSharedPointer>
QT_BEGIN_NAMESPACE
class QString;
class QWidget;
QT_END_NAMESPACE
namespace ProjectExplorer {
class Project;
class PersistentSettingsReader;
class PersistentSettingsWriter;
class RunControl;
/* Base class for a run configuration. A run configuration specifies how a
* project should be run, while the runner (see below) does the actual running.
*
* Note that all RunControls and the project hold a shared pointer to the RunConfiguration.
* That is the lifetime of the RunConfiguration might exceed the life of the project.
* The user might still have a RunControl running (or output tab of that RunControl open)
* and yet unloaded the project.
* Also a RunConfiguration might be already removed from the list of RunConfigurations
* for a project, but stil be runnable via the output tab.
*/
class PROJECTEXPLORER_EXPORT RunConfiguration : public QObject
{
Q_OBJECT
public:
RunConfiguration(Project *project);
virtual ~RunConfiguration();
Project *project() const;
// The type of this RunConfiguration, e.g. "ProjectExplorer.ApplicationRunConfiguration"
virtual QString type() const = 0;
// Name shown to the user
QString name() const;
void setName(const QString &name);
// Returns the widget used to configure this run configuration. Ownership is transferred to the caller
// rename to createConfigurationWidget
virtual QWidget *configurationWidget() = 0;
virtual void save(PersistentSettingsWriter &writer) const;
virtual void restore(const PersistentSettingsReader &reader);
signals:
void nameChanged();
private:
QPointer<Project> m_project;
QString m_name;
};
/* The run configuration factory is used for restoring run configurations from
* settings. And used to create new runconfigurations in the "Run Settings" Dialog.
* For the first case bool canCreate(const QString &type) and
* QSharedPointer<RunConfiguration> create(Project *project, QString type) are used.
* For the second type the functions QStringList canCreate(Project *pro) and
* QString nameForType(const QString&) are used to generate a list of creatable
* RunConfigurations, and create(..) is used to create it.
*/
class PROJECTEXPLORER_EXPORT IRunConfigurationFactory : public QObject
{
Q_OBJECT
public:
IRunConfigurationFactory();
virtual ~IRunConfigurationFactory();
// used to recreate the runConfigurations when restoring settings
virtual bool canCreate(const QString &type) const = 0;
// used to show the list of possible additons to a project, returns a list of types
virtual QStringList canCreate(Project *pro) const = 0;
// used to translate the types to names to display to the user
virtual QString nameForType(const QString &type) const = 0;
virtual QSharedPointer<RunConfiguration> create(Project *project, const QString &type) = 0;
};
class PROJECTEXPLORER_EXPORT IRunConfigurationRunner : public QObject
{
Q_OBJECT
public:
IRunConfigurationRunner();
virtual ~IRunConfigurationRunner();
virtual bool canRun(QSharedPointer<RunConfiguration> runConfiguration, const QString &mode) = 0;
virtual RunControl* run(QSharedPointer<RunConfiguration> runConfiguration, const QString &mode) = 0;
virtual QString displayName() const = 0;
// Returns the widget used to configure this runner. Ownership is transferred to the caller
virtual QWidget *configurationWidget(QSharedPointer<RunConfiguration> runConfiguration) = 0;
};
/* Each instance of this class represents one item that is run.
*/
class PROJECTEXPLORER_EXPORT RunControl : public QObject {
Q_OBJECT
public:
RunControl(QSharedPointer<RunConfiguration> runConfiguration);
virtual ~RunControl();
virtual void start() = 0;
virtual void stop() = 0;
virtual bool isRunning() const = 0;
QSharedPointer<RunConfiguration> runConfiguration();
signals:
void addToOutputWindow(RunControl *, const QString &line);
void error(RunControl *, const QString &error);
void started();
void finished();
public slots:
void bringApplicationToForeground(qint64 pid);
private slots:
void bringApplicationToForegroundInternal();
private:
QSharedPointer<RunConfiguration> m_runConfiguration;
#ifdef Q_OS_MAC
//these two are used to bring apps in the foreground on Mac
qint64 m_internalPid;
int m_foregroundCount;
#endif
};
} // namespace ProjectExplorer
// Allow a RunConfiguration to be stored in a QVariant
Q_DECLARE_METATYPE(ProjectExplorer::RunConfiguration*)
#endif // RUNCONFIGURATION_H
|
