Files
qt-creator/src/libs/utils/consoleprocess.h
hjk 404a4295ce Utils: Lump ConsoleProcess files together
... to reduce scope of conditionally compiled code which causes
regularly problems when forgetting about their special nature.

The code model isn't a big fan either.

Change-Id: I6a85b694b59a293daf4b9aab7c8e81c7ca284f0d
Reviewed-by: David Schulz <david.schulz@qt.io>
2019-07-25 06:38:26 +00:00

146 lines
4.4 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** 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 "utils_global.h"
#include <QProcess>
#include <QVector>
QT_BEGIN_NAMESPACE
class QSettings;
QT_END_NAMESPACE
namespace Utils {
class Environment;
class CommandLine;
class QTCREATOR_UTILS_EXPORT TerminalCommand
{
public:
TerminalCommand() = default;
TerminalCommand(const QString &command, const QString &openArgs, const QString &executeArgs);
bool operator==(const TerminalCommand &other) const;
bool operator<(const TerminalCommand &other) const;
QString command;
QString openArgs;
QString executeArgs;
};
class QTCREATOR_UTILS_EXPORT ConsoleProcess : public QObject
{
Q_OBJECT
public:
enum Mode { Run, Debug, Suspend };
explicit ConsoleProcess(QObject *parent = nullptr);
~ConsoleProcess() override;
void setCommand(const Utils::CommandLine &command);
void setAbortOnMetaChars(bool abort);
void setWorkingDirectory(const QString &dir);
QString workingDirectory() const;
void setEnvironment(const Environment &env);
Environment environment() const;
QProcess::ProcessError error() const;
QString errorString() const;
bool start();
void stop();
public:
void setMode(Mode m);
Mode mode() const;
bool isRunning() const; // This reflects the state of the console+stub
qint64 applicationPID() const;
void killProcess();
void killStub();
qint64 applicationMainThreadID() const;
void detachStub();
int exitCode() const;
QProcess::ExitStatus exitStatus() const;
void setSettings(QSettings *);
static TerminalCommand defaultTerminalEmulator();
static QVector<TerminalCommand> availableTerminalEmulators();
static TerminalCommand terminalEmulator(const QSettings *settings);
static void setTerminalEmulator(QSettings *settings, const TerminalCommand &term);
static bool startTerminalEmulator(QSettings *settings, const QString &workingDir,
const Utils::Environment &env);
signals:
void error(QProcess::ProcessError error);
void processError(const QString &errorString);
// These reflect the state of the actual client process
void processStarted();
void processStopped(int, QProcess::ExitStatus);
// These reflect the state of the console+stub
void stubStarted();
void stubStopped();
private:
void stubConnectionAvailable();
void readStubOutput();
void stubExited();
static QString modeOption(Mode m);
static QString msgCommChannelFailed(const QString &error);
static QString msgPromptToClose();
static QString msgCannotCreateTempFile(const QString &why);
static QString msgCannotWriteTempFile();
static QString msgCannotCreateTempDir(const QString & dir, const QString &why);
static QString msgUnexpectedOutput(const QByteArray &what);
static QString msgCannotChangeToWorkDir(const QString & dir, const QString &why);
static QString msgCannotExecute(const QString & p, const QString &why);
void emitError(QProcess::ProcessError err, const QString &errorString);
QString stubServerListen();
void stubServerShutdown();
void cleanupStub();
void cleanupInferior();
class ConsoleProcessPrivate *d;
};
} // Utils
Q_DECLARE_METATYPE(Utils::TerminalCommand)