Vcs: Split up VcsCommand

Move the biggest chunk into Utils::ShellCommand, add some Qt Creator
specific magic in Core::ShellCommand and leave the rest in
VcsBase::VcsCommand.

Change-Id: I5fe6f7076e96023ad2164bcfaacfb3b65a7ff8a8
Reviewed-by: Orgad Shaneh <orgads@gmail.com>

src/libs/utils/shellcommand.h

@@ -0,0 +1,185 @@
+/**************************************************************************
+**
+** Copyright (C) 2015 Brian McGillion and Hugues Delorme
+** Contact: http://www.qt.io/licensing
+**
+** 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 The Qt Company.  For licensing terms and
+** conditions see http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef UTILS_SHELLCOMMAND_H
+#define UTILS_SHELLCOMMAND_H
+
+#include "utils_global.h"
+
+#include <QObject>
+
+#include <functional>
+
+QT_BEGIN_NAMESPACE
+class QMutex;
+class QStringList;
+class QVariant;
+class QProcessEnvironment;
+template <typename T>
+class QFutureInterface;
+template <typename T>
+class QFuture;
+QT_END_NAMESPACE
+
+namespace Utils {
+struct SynchronousProcessResponse;
+class ExitCodeInterpreter;
+class FileName;
+}
+
+namespace Utils {
+
+namespace Internal { class ShellCommandPrivate; }
+
+class QTCREATOR_UTILS_EXPORT ProgressParser
+{
+public:
+    ProgressParser();
+    virtual ~ProgressParser();
+
+protected:
+    virtual void parseProgress(const QString &text) = 0;
+    void setProgressAndMaximum(int value, int maximum);
+
+private:
+    void setFuture(QFutureInterface<void> *future);
+
+    QFutureInterface<void> *m_future;
+    QMutex *m_futureMutex;
+    friend class ShellCommand;
+};
+
+// Users of this class can either be in the GUI thread or in other threads.
+// Use Qt::AutoConnection to always append in the GUI thread (directly or queued)
+class QTCREATOR_UTILS_EXPORT OutputProxy : public QObject
+{
+    Q_OBJECT
+
+    friend class ShellCommand;
+
+signals:
+    void append(const QString &text);
+    void appendSilently(const QString &text);
+    void appendError(const QString &text);
+    void appendCommand(const QString &workingDirectory, const Utils::FileName &binary,
+                       const QStringList &args);
+    void appendMessage(const QString &text);
+};
+
+class QTCREATOR_UTILS_EXPORT ShellCommand : public QObject
+{
+    Q_OBJECT
+
+public:
+    // Convenience to synchronously run commands
+    enum RunFlags {
+        ShowStdOut = 0x1, // Show standard output.
+        MergeOutputChannels = 0x2, // see QProcess: Merge stderr/stdout.
+        SuppressStdErr = 0x4, // Suppress standard error output.
+        SuppressFailMessage = 0x8, // No message about command failure.
+        SuppressCommandLogging = 0x10, // No command log entry.
+        ShowSuccessMessage = 0x20, // Show message about successful completion of command.
+        ForceCLocale = 0x40, // Force C-locale for commands whose output is parsed.
+        FullySynchronously = 0x80, // Suppress local event loop (in case UI actions are
+                                   // triggered by file watchers).
+        SilentOutput = 0x100, // Suppress user notifications about the output happening.
+        NoOutput = SuppressStdErr | SuppressFailMessage | SuppressCommandLogging
+    };
+
+
+    ShellCommand(const QString &workingDirectory, const QProcessEnvironment &environment);
+    ~ShellCommand();
+
+    QString displayName() const;
+    void setDisplayName(const QString &name);
+
+    void addJob(const FileName &binary, const QStringList &arguments, ExitCodeInterpreter *interpreter = 0);
+    void addJob(const FileName &binary, const QStringList &arguments, int timeoutS,
+                ExitCodeInterpreter *interpreter = 0);
+    void execute();
+    void abort();
+    bool lastExecutionSuccess() const;
+    int lastExecutionExitCode() const;
+
+    const QString &workingDirectory() const;
+    virtual const QProcessEnvironment processEnvironment() const;
+
+    int defaultTimeoutS() const;
+    void setDefaultTimeoutS(int timeout);
+
+    unsigned flags() const;
+    void addFlags(unsigned f);
+
+    const QVariant &cookie() const;
+    void setCookie(const QVariant &cookie);
+
+    QTextCodec *codec() const;
+    void setCodec(QTextCodec *codec);
+
+    void setProgressParser(ProgressParser *parser);
+    void setProgressiveOutput(bool progressive);
+
+    void setOutputProxyFactory(const std::function<OutputProxy *()> &factory);
+
+    virtual SynchronousProcessResponse runCommand(const FileName &binary, const QStringList &arguments,
+                                                  int timeoutS, ExitCodeInterpreter *interpreter = 0);
+    // Make sure to not pass through the event loop at all:
+    virtual bool runFullySynchronous(const FileName &binary, const QStringList &arguments,
+                                     int timeoutS, QByteArray *outputData, QByteArray *errorData);
+
+public slots:
+    void cancel();
+
+signals:
+    void output(const QString &);
+    void errorText(const QString &);
+    void finished(bool ok, int exitCode, const QVariant &cookie);
+    void success(const QVariant &cookie);
+
+    void terminate(); // Internal
+
+protected:
+    virtual unsigned processFlags() const;
+    virtual void addTask(QFuture<void> &future);
+
+private:
+    void bufferedOutput(const QString &text);
+    void bufferedError(const QString &text);
+
+    void run(QFutureInterface<void> &future);
+    SynchronousProcessResponse runSynchronous(const FileName &binary, const QStringList &arguments,
+                                              int timeoutS, ExitCodeInterpreter *interpreter = 0);
+
+    class Internal::ShellCommandPrivate *const d;
+};
+
+} // namespace Utils
+
+#endif // UTILS_SHELLCOMMAND_H