Move ShellCommand into VcsBase plugin

Rename it to VcsCommand. Move also ShellCommandPage into
VcsBase plugin.

Change-Id: I335ac47e3090f2be497643ebcda0eaad2987ac81
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>

src/plugins/vcsbase/vcscommand.h

@@ -0,0 +1,201 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Brian McGillion and Hugues Delorme
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#pragma once
+
+#include "vcsbase_global.h"
+
+#include <utils/filepath.h>
+#include <utils/processenums.h>
+
+#include <QObject>
+
+QT_BEGIN_NAMESPACE
+class QMutex;
+class QVariant;
+template <typename T>
+class QFutureInterface;
+template <typename T>
+class QFuture;
+class QTextCodec;
+QT_END_NAMESPACE
+
+namespace Utils {
+class CommandLine;
+class Environment;
+class QtcProcess;
+}
+
+namespace VcsBase {
+
+namespace Internal { class VcsCommandPrivate; }
+
+class VCSBASE_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 = nullptr;
+    friend class VcsCommand;
+};
+
+class VCSBASE_EXPORT CommandResult
+{
+public:
+    CommandResult() = default;
+    CommandResult(const Utils::QtcProcess &process);
+
+    Utils::ProcessResult result() const { return m_result; }
+    int exitCode() const { return m_exitCode; }
+    QString exitMessage() const { return m_exitMessage; }
+
+    QString cleanedStdOut() const { return m_cleanedStdOut; }
+    QString cleanedStdErr() const { return m_cleanedStdErr; }
+
+    QByteArray rawStdOut() const { return m_rawStdOut; }
+
+private:
+    Utils::ProcessResult m_result = Utils::ProcessResult::StartFailed;
+    int m_exitCode = 0;
+    QString m_exitMessage;
+
+    QString m_cleanedStdOut;
+    QString m_cleanedStdErr;
+
+    QByteArray m_rawStdOut;
+};
+
+class VCSBASE_EXPORT VcsCommand final : 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.
+        NoFullySync = 0x200, // Avoid fully synchronous execution even in UI thread.
+        SshPasswordPrompt = 0x400, // Disable terminal on UNIX to force graphical prompt.
+        ExpectRepoChanges = 0x800, // Expect changes in repository by the command
+        NoOutput = SuppressStdErr | SuppressFailMessage | SuppressCommandLogging
+    };
+
+
+    VcsCommand(const Utils::FilePath &workingDirectory, const Utils::Environment &environment);
+    ~VcsCommand() override;
+
+    QString displayName() const;
+    void setDisplayName(const QString &name);
+
+    const Utils::FilePath &defaultWorkingDirectory() const;
+
+    Utils::Environment environment() const;
+    void setEnvironment(const Utils::Environment &env);
+
+    void addJob(const Utils::CommandLine &command,
+                const Utils::FilePath &workingDirectory = {},
+                const Utils::ExitCodeInterpreter &interpreter = {});
+    void addJob(const Utils::CommandLine &command, int timeoutS,
+                const Utils::FilePath &workingDirectory = {},
+                const Utils::ExitCodeInterpreter &interpreter = {});
+    void execute(); // Execute tasks asynchronously!
+    void abort();
+
+    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);
+    bool hasProgressParser() const;
+    void setProgressiveOutput(bool progressive);
+
+    // This is called once per job in a thread.
+    // When called from the UI thread it will execute fully synchronously, so no signals will
+    // be triggered!
+    CommandResult runCommand(const Utils::CommandLine &command,
+                             const Utils::FilePath &workingDirectory = {},
+                             int timeoutS = 10, const Utils::ExitCodeInterpreter &interpreter = {});
+
+    void cancel();
+
+    void setDisableUnixTerminal();
+    int timeoutS() const;
+
+signals:
+    void stdOutText(const QString &);
+    void stdErrText(const QString &);
+    void started();
+    void finished(bool success, const QVariant &cookie);
+
+    void terminate(); // Internal
+
+    void append(const QString &text);
+    void appendSilently(const QString &text);
+    void appendError(const QString &text);
+    // TODO: remove Utils:: scope when support for Qt5 is dropped (Creator 9.0)
+    void appendCommand(const Utils::FilePath &workingDirectory, const Utils::CommandLine &command);
+    void appendMessage(const QString &text);
+
+    void executedAsync(const QFuture<void> &future);
+    void runCommandFinished(const Utils::FilePath &workingDirectory);
+
+private:
+    Utils::FilePath workDirectory(const Utils::FilePath &wd) const;
+    void run(QFutureInterface<void> &future);
+
+    // Run without a event loop in fully blocking mode. No signals will be delivered.
+    void runFullySynchronous(Utils::QtcProcess &proc);
+    // Run with an event loop. Signals will be delivered.
+    void runSynchronous(Utils::QtcProcess &proc);
+
+    class Internal::VcsCommandPrivate *const d;
+};
+
+} // namespace Utils