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
|
/**************************************************************************
**
** 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 ABSTRACTPROCESSSTEP_H
#define ABSTRACTPROCESSSTEP_H
#include "buildstep.h"
#include "processparameters.h"
#include <utils/environment.h>
#include <utils/qtcprocess.h>
#include <QtCore/QString>
QT_BEGIN_NAMESPACE
class QEventLoop;
class QTimer;
QT_END_NAMESPACE
namespace ProjectExplorer {
class IOutputParser;
/*!
AbstractProcessStep is a convenience class, which can be used as a base class instead of BuildStep.
It should be used as a base class if your buildstep just needs to run a process.
Usage:
Use processParameters() to configure the process you want to run
(you need to do that before calling AbstractProcessStep::init()).
Inside YourBuildStep::init() call AbstractProcessStep::init().
Inside YourBuildStep::run() call AbstractProcessStep::run(), which automatically starts the proces
and by default adds the output on stdOut and stdErr to the OutputWindow.
If you need to process the process output override stdOut() and/or stdErr.
The two functions processStarted() and processFinished() are called after starting/finishing the process.
By default they add a message to the output window.
Use setEnabled() to control whether the BuildStep needs to run. (A disabled BuildStep immediately returns true,
from the run function.)
*/
class PROJECTEXPLORER_EXPORT AbstractProcessStep : public BuildStep
{
Q_OBJECT
public:
virtual ~AbstractProcessStep();
/// reimplemented from BuildStep::init()
/// You need to call this from YourBuildStep::init()
virtual bool init();
/// reimplemented from BuildStep::init()
/// You need to call this from YourBuildStep::run()
virtual void run(QFutureInterface<bool> &);
virtual BuildStepConfigWidget *createConfigWidget() = 0;
virtual bool immutable() const = 0;
/// enables or disables a BuildStep
/// Disabled BuildSteps immediately return true from their run method
/// should be called from init()
void setEnabled(bool b) { m_enabled = b; }
/// obtain a reference to the parameters for the actual process to run.
/// should be used in init()
ProcessParameters *processParameters() { return &m_param; }
/// If ignoreReturnValue is set to true, then the abstractprocess step will
/// return success even if the return value indicates otherwise
/// should be called from init
void setIgnoreReturnValue(bool b);
// derived classes needs to call this function
/// Delete all existing output parsers and start a new chain with the
/// given parser.
void setOutputParser(ProjectExplorer::IOutputParser *parser);
/// Append the given output parser to the existing chain of parsers.
void appendOutputParser(ProjectExplorer::IOutputParser *parser);
ProjectExplorer::IOutputParser *outputParser() const;
protected:
AbstractProcessStep(BuildStepList *bsl, const QString &id);
AbstractProcessStep(BuildStepList *bsl, AbstractProcessStep *bs);
/// Called after the process is started
/// the default implementation adds a process started message to the output message
virtual void processStarted();
/// Called after the process Finished
/// the default implementation adds a line to the output window
virtual void processFinished(int exitCode, QProcess::ExitStatus status);
/// Called if the process could not be started,
/// by default adds a message to the output window
virtual void processStartupFailed();
/// Called to test whether a prcess succeeded or not.
virtual bool processSucceeded(int exitCode, QProcess::ExitStatus status);
/// Called for each line of output on stdOut()
/// the default implementation adds the line to the
/// application output window
virtual void stdOutput(const QString &line);
/// Called for each line of output on StdErrror()
/// the default implementation adds the line to the
/// application output window
virtual void stdError(const QString &line);
private slots:
void processReadyReadStdOutput();
void processReadyReadStdError();
void slotProcessFinished(int, QProcess::ExitStatus);
void checkForCancel();
void taskAdded(const ProjectExplorer::Task &task);
void outputAdded(const QString &string, ProjectExplorer::BuildStep::OutputFormat format);
private:
QTimer *m_timer;
QFutureInterface<bool> *m_futureInterface;
ProcessParameters m_param;
bool m_enabled;
bool m_ignoreReturnValue;
Utils::QtcProcess *m_process;
QEventLoop *m_eventLoop;
ProjectExplorer::IOutputParser *m_outputParserChain;
};
} // namespace ProjectExplorer
#endif // ABSTRACTPROCESSSTEP_H
|
