synchronousprocess.h 5.43 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33 34 35
#ifndef SYNCHRONOUSPROCESS_H
#define SYNCHRONOUSPROCESS_H

hjk's avatar
hjk committed
36 37
#include "utils_global.h"

38 39 40 41
#include <QObject>
#include <QProcess>
#include <QStringList>
#include <QSharedPointer>
con's avatar
con committed
42 43 44 45 46 47 48 49 50 51 52

QT_BEGIN_NAMESPACE
class QTextCodec;
class QDebug;
QT_END_NAMESPACE

namespace Utils {

struct SynchronousProcessPrivate;

/* Result of SynchronousProcess execution */
53
struct QTCREATOR_UTILS_EXPORT SynchronousProcessResponse
hjk's avatar
hjk committed
54
{
con's avatar
con committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
    enum Result {
        // Finished with return code 0
        Finished,
        // Finished with return code != 0
        FinishedError,
        // Process terminated abnormally (kill)
        TerminatedAbnormally,
        // Executable could not be started
        StartFailed,
        // Hang, no output after time out
        Hang };

    SynchronousProcessResponse();
    void clear();

70 71 72
    // Helper to format an exit message.
    QString exitMessage(const QString &binary, int timeoutMS) const;

con's avatar
con committed
73 74 75 76 77 78
    Result result;
    int exitCode;
    QString stdOut;
    QString stdErr;
};

79
QTCREATOR_UTILS_EXPORT QDebug operator<<(QDebug str, const SynchronousProcessResponse &);
con's avatar
con committed
80

81
class QTCREATOR_UTILS_EXPORT SynchronousProcess : public QObject
hjk's avatar
hjk committed
82
{
con's avatar
con committed
83 84
    Q_OBJECT
public:
85 86 87 88 89
    enum Flags {
        // Unix: Do not give the child process a terminal for input prompting.
        UnixTerminalDisabled = 0x1
    };

con's avatar
con committed
90 91 92
    SynchronousProcess();
    virtual ~SynchronousProcess();

93 94
    /* Timeout for hanging processes (triggers after no more output
     * occurs on stderr/stdout). */
con's avatar
con committed
95 96 97 98 99 100
    void setTimeout(int timeoutMS);
    int timeout() const;

    void setStdOutCodec(QTextCodec *c);
    QTextCodec *stdOutCodec() const;

101 102 103
    QProcess::ProcessChannelMode processChannelMode () const;
    void setProcessChannelMode(QProcess::ProcessChannelMode m);

con's avatar
con committed
104 105 106 107 108 109
    bool stdOutBufferedSignalsEnabled() const;
    void setStdOutBufferedSignalsEnabled(bool);

    bool stdErrBufferedSignalsEnabled() const;
    void setStdErrBufferedSignalsEnabled(bool);

110 111 112
    bool timeOutMessageBoxEnabled() const;
    void setTimeOutMessageBoxEnabled(bool);

con's avatar
con committed
113 114 115
    QStringList environment() const;
    void setEnvironment(const QStringList &);

116 117 118
    void setProcessEnvironment(const QProcessEnvironment &environment);
    QProcessEnvironment processEnvironment() const;

119 120 121
    void setWorkingDirectory(const QString &workingDirectory);
    QString workingDirectory() const;

122 123 124
    unsigned flags() const;
    void setFlags(unsigned);

con's avatar
con committed
125 126
    SynchronousProcessResponse run(const QString &binary, const QStringList &args);

127 128 129
    // Create a (derived) processes with flags applied.
    static QSharedPointer<QProcess> createProcess(unsigned flags);

130 131 132 133 134
    // Static helper for running a process synchronously in the foreground with timeout
    // detection similar SynchronousProcess' handling (taking effect after no more output
    // occurs on stderr/stdout as opposed to waitForFinished()). Returns false if a timeout
    // occurs. Checking of the process' exit state/code still has to be done.
    static bool readDataFromProcess(QProcess &p, int timeOutMS,
135 136
                                    QByteArray *stdOut = 0, QByteArray *stdErr = 0,
                                    bool timeOutMessageBox = false);
137 138 139 140
    // Stop a process by first calling terminate() (allowing for signal handling) and
    // then kill().
    static bool stopProcess(QProcess &p);

141 142 143 144 145 146
    // Helpers to find binaries. Do not use it for other path variables
    // and file types.
    static QString locateBinary(const QString &binary);
    static QString locateBinary(const QString &path, const QString &binary);
    static QChar pathSeparator();

con's avatar
con committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
signals:
    void stdOut(const QByteArray &data, bool firstTime);
    void stdErr(const QByteArray &data, bool firstTime);

    void stdOutBuffered(const QString &data, bool firstTime);
    void stdErrBuffered(const QString &data, bool firstTime);

private slots:
    void slotTimeout();
    void finished(int exitCode, QProcess::ExitStatus e);
    void error(QProcess::ProcessError);
    void stdOutReady();
    void stdErrReady();

private:
    void processStdOut(bool emitSignals);
    void processStdErr(bool emitSignals);
    static QString convertStdErr(const QByteArray &);
    QString convertStdOut(const QByteArray &) const;

hjk's avatar
hjk committed
167
    SynchronousProcessPrivate *d;
con's avatar
con committed
168 169
};

hjk's avatar
hjk committed
170 171
} // namespace Utils

con's avatar
con committed
172
#endif