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
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef EXTERNALTOOL_H
#define EXTERNALTOOL_H
#include <QObject>
#include <QStringList>
#include <QProcess>
#include <QSharedPointer>
#include <QTextCodec>
#include <QMetaType>
namespace Utils {
class QtcProcess;
}
namespace Core {
namespace Internal {
class ExternalTool : public QObject
{
Q_OBJECT
public:
enum OutputHandling {
Ignore,
ShowInPane,
ReplaceSelection
};
ExternalTool();
explicit ExternalTool(const ExternalTool *other);
~ExternalTool();
QString id() const;
QString description() const;
QString displayName() const;
QString displayCategory() const;
int order() const;
OutputHandling outputHandling() const;
OutputHandling errorHandling() const;
bool modifiesCurrentDocument() const;
QStringList executables() const;
QString arguments() const;
QString input() const;
QString workingDirectory() const;
void setFileName(const QString &fileName);
void setPreset(QSharedPointer<ExternalTool> preset);
QString fileName() const;
// all tools that are preset (changed or unchanged) have the original value here:
QSharedPointer<ExternalTool> preset() const;
static ExternalTool *createFromXml(const QByteArray &xml, QString *errorMessage = 0, const QString &locale = QString());
static ExternalTool *createFromFile(const QString &fileName, QString *errorMessage = 0,
const QString &locale = QString());
bool save(QString *errorMessage = 0) const;
bool operator==(const ExternalTool &other) const;
bool operator!=(const ExternalTool &other) const { return !((*this) == other); }
ExternalTool &operator=(const ExternalTool &other);
void setId(const QString &id);
void setDisplayCategory(const QString &category);
void setDisplayName(const QString &name);
void setDescription(const QString &description);
void setOutputHandling(OutputHandling handling);
void setErrorHandling(OutputHandling handling);
void setModifiesCurrentDocument(bool modifies);
void setExecutables(const QStringList &executables);
void setArguments(const QString &arguments);
void setInput(const QString &input);
void setWorkingDirectory(const QString &workingDirectory);
private:
QString m_id;
QString m_description;
QString m_displayName;
QString m_displayCategory;
int m_order;
QStringList m_executables;
QString m_arguments;
QString m_input;
QString m_workingDirectory;
OutputHandling m_outputHandling;
OutputHandling m_errorHandling;
bool m_modifiesCurrentDocument;
QString m_fileName;
QString m_presetFileName;
QSharedPointer<ExternalTool> m_presetTool;
};
class ExternalToolRunner : public QObject
{
Q_OBJECT
public:
ExternalToolRunner(const ExternalTool *tool);
~ExternalToolRunner();
bool hasError() const;
QString errorString() const;
private slots:
void started();
void finished(int exitCode, QProcess::ExitStatus status);
void error(QProcess::ProcessError error);
void readStandardOutput();
void readStandardError();
private:
void run();
bool resolve();
const ExternalTool *m_tool; // is a copy of the tool that was passed in
QString m_resolvedExecutable;
QString m_resolvedArguments;
QString m_resolvedInput;
QString m_resolvedWorkingDirectory;
Utils::QtcProcess *m_process;
QTextCodec *m_outputCodec;
QTextCodec::ConverterState m_outputCodecState;
QTextCodec::ConverterState m_errorCodecState;
QString m_processOutput;
QString m_expectedFileName;
bool m_hasError;
QString m_errorString;
};
} // Internal
} // Core
Q_DECLARE_METATYPE(Core::Internal::ExternalTool *)
#endif // EXTERNALTOOL_H
|
