feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

SSH: Use enum for signals API.

Browse Source 
There is no reason to bother the user with the protocol-internal
strings.

Change-Id: I7ebec9147b2d00cfdc779920d9ceb18e26c59755
Reviewed-by: hjk <qthjk@ovi.com>
This commit is contained in:
Christian Kandeler
2012-01-20 14:35:13 +01:00
committed by hjk
parent f5aa8d4658
commit 8287cbe1fa
5 changed files with 55 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
src/libs/utils/ssh/sshremoteprocess.cpp
View File

@@ -43,6 +43,7 @@
#include <QtCore/QTimer> #include <QtCore/QTimer>
#include <cstring> #include <cstring>
#include <cstdlib>
/*! /*!
\class Utils::SshRemoteProcess \class Utils::SshRemoteProcess
@@ -59,19 +60,18 @@
namespace Utils { namespace Utils {
const QByteArray SshRemoteProcess::AbrtSignal("ABRT"); const struct {
const QByteArray SshRemoteProcess::AlrmSignal("ALRM"); SshRemoteProcess::Signal signalEnum;
const QByteArray SshRemoteProcess::FpeSignal("FPE"); const char * const signalString;
const QByteArray SshRemoteProcess::HupSignal("HUP"); } signalMap[] = {
const QByteArray SshRemoteProcess::IllSignal("ILL"); { SshRemoteProcess::AbrtSignal, "ABRT" }, { SshRemoteProcess::AlrmSignal, "ALRM" },
const QByteArray SshRemoteProcess::IntSignal("INT"); { SshRemoteProcess::FpeSignal, "FPE" }, { SshRemoteProcess::HupSignal, "HUP" },
const QByteArray SshRemoteProcess::KillSignal("KILL"); { SshRemoteProcess::IllSignal, "ILL" }, { SshRemoteProcess::IntSignal, "INT" },
const QByteArray SshRemoteProcess::PipeSignal("PIPE"); { SshRemoteProcess::KillSignal, "KILL" }, { SshRemoteProcess::PipeSignal, "PIPE" },
const QByteArray SshRemoteProcess::QuitSignal("QUIT"); { SshRemoteProcess::QuitSignal, "QUIT" }, { SshRemoteProcess::SegvSignal, "SEGV" },
const QByteArray SshRemoteProcess::SegvSignal("SEGV"); { SshRemoteProcess::TermSignal, "TERM" }, { SshRemoteProcess::Usr1Signal, "USR1" },
const QByteArray SshRemoteProcess::TermSignal("TERM"); { SshRemoteProcess::Usr2Signal, "USR2" }
const QByteArray SshRemoteProcess::Usr1Signal("USR1"); };
const QByteArray SshRemoteProcess::Usr2Signal("USR2");
SshRemoteProcess::SshRemoteProcess(const QByteArray &command, quint32 channelId, SshRemoteProcess::SshRemoteProcess(const QByteArray &command, quint32 channelId,
Internal::SshSendFacility &sendFacility) Internal::SshSendFacility &sendFacility)
@@ -197,12 +197,18 @@ void SshRemoteProcess::start()
} }
} }
void SshRemoteProcess::sendSignal(const QByteArray &signal) void SshRemoteProcess::sendSignal(Signal signal)
{ {
try { try {
if (isRunning()) if (isRunning()) {
d->m_sendFacility.sendChannelSignalPacket(d->remoteChannel(), const char *signalString = 0;
signal); for (size_t i = 0; i < sizeof signalMap/sizeof *signalMap && !signalString; ++i) {
if (signalMap[i].signalEnum == signal)
signalString = signalMap[i].signalString;
}
QTC_ASSERT(signalString, return);
d->m_sendFacility.sendChannelSignalPacket(d->remoteChannel(), signalString);
}
} catch (Botan::Exception &e) { } catch (Botan::Exception &e) {
setErrorString(QString::fromAscii(e.what())); setErrorString(QString::fromAscii(e.what()));
d->closeChannel(); d->closeChannel();
@@ -215,7 +221,11 @@ bool SshRemoteProcess::isRunning() const
} }
int SshRemoteProcess::exitCode() const { return d->m_exitCode; } int SshRemoteProcess::exitCode() const { return d->m_exitCode; }
QByteArray SshRemoteProcess::exitSignal() const { return d->m_signal; }
SshRemoteProcess::Signal SshRemoteProcess::exitSignal() const
{
return static_cast<SshRemoteProcess::Signal>(d->m_signal);
}
namespace Internal { namespace Internal {
@@ -246,6 +256,7 @@ void SshRemoteProcessPrivate::init()
m_wasRunning = false; m_wasRunning = false;
m_exitCode = 0; m_exitCode = 0;
m_readChannel = QProcess::StandardOutput; m_readChannel = QProcess::StandardOutput;
m_signal = SshRemoteProcess::NoSignal;
} }
void SshRemoteProcessPrivate::setProcState(ProcessState newState) void SshRemoteProcessPrivate::setProcState(ProcessState newState)
@@ -270,7 +281,7 @@ QByteArray &SshRemoteProcessPrivate::data()
void SshRemoteProcessPrivate::closeHook() void SshRemoteProcessPrivate::closeHook()
{ {
if (m_wasRunning) { if (m_wasRunning) {
if (!m_signal.isEmpty()) if (m_signal != SshRemoteProcess::NoSignal)
emit closed(SshRemoteProcess::KilledBySignal); emit closed(SshRemoteProcess::KilledBySignal);
else else
emit closed(SshRemoteProcess::ExitedNormally); emit closed(SshRemoteProcess::ExitedNormally);
@@ -357,9 +368,18 @@ void SshRemoteProcessPrivate::handleExitSignal(const SshChannelExitSignal &signa
#ifdef CREATOR_SSH_DEBUG #ifdef CREATOR_SSH_DEBUG
qDebug("Exit due to signal %s", signal.signal.data()); qDebug("Exit due to signal %s", signal.signal.data());
#endif #endif
m_signal = signal.signal;
m_procState = Exited; for (size_t i = 0; i < sizeof signalMap/sizeof *signalMap; ++i) {
m_proc->setErrorString(tr("Process killed by signal")); if (signalMap[i].signalString == signal.signal) {
m_signal = signalMap[i].signalEnum;
m_procState = Exited;
m_proc->setErrorString(tr("Process killed by signal"));
return;
}
}
throw SshServerException(SSH_DISCONNECT_PROTOCOL_ERROR, "Invalid signal",
tr("Server sent invalid signal '%1'").arg(QString::fromUtf8(signal.signal)));
} }
} // namespace Internal } // namespace Internal

22
src/libs/utils/ssh/sshremoteprocess.h
View File

@@ -61,20 +61,10 @@ class QTCREATOR_UTILS_EXPORT SshRemoteProcess : public QIODevice
public: public:
typedef QSharedPointer<SshRemoteProcess> Ptr; typedef QSharedPointer<SshRemoteProcess> Ptr;
enum ExitStatus { FailedToStart, KilledBySignal, ExitedNormally }; enum ExitStatus { FailedToStart, KilledBySignal, ExitedNormally };
enum Signal {
static const QByteArray AbrtSignal; AbrtSignal, AlrmSignal, FpeSignal, HupSignal, IllSignal, IntSignal, KillSignal, PipeSignal,
static const QByteArray AlrmSignal; QuitSignal, SegvSignal, TermSignal, Usr1Signal, Usr2Signal, NoSignal
static const QByteArray FpeSignal; };
static const QByteArray HupSignal;
static const QByteArray IllSignal;
static const QByteArray IntSignal;
static const QByteArray KillSignal;
static const QByteArray PipeSignal;
static const QByteArray QuitSignal;
static const QByteArray SegvSignal;
static const QByteArray TermSignal;
static const QByteArray Usr1Signal;
static const QByteArray Usr2Signal;
~SshRemoteProcess(); ~SshRemoteProcess();
@@ -99,13 +89,13 @@ public:
bool isRunning() const; bool isRunning() const;
int exitCode() const; int exitCode() const;
QByteArray exitSignal() const; Signal exitSignal() const;
QByteArray readAllStandardOutput(); QByteArray readAllStandardOutput();
QByteArray readAllStandardError(); QByteArray readAllStandardError();
// Note: This is ignored by the OpenSSH server. // Note: This is ignored by the OpenSSH server.
void sendSignal(const QByteArray &signal); void sendSignal(Signal signal);
void kill() { sendSignal(KillSignal); } void kill() { sendSignal(KillSignal); }
signals: signals:

2
src/libs/utils/ssh/sshremoteprocess_p.h
View File

@@ -91,7 +91,7 @@ private:
ProcessState m_procState; ProcessState m_procState;
bool m_wasRunning; bool m_wasRunning;
QByteArray m_signal; int m_signal;
int m_exitCode; int m_exitCode;
const QByteArray m_command; const QByteArray m_command;

8
src/libs/utils/ssh/sshremoteprocessrunner.cpp
View File

@@ -63,7 +63,7 @@ public:
Utils::SshError m_lastConnectionError; Utils::SshError m_lastConnectionError;
QString m_lastConnectionErrorString; QString m_lastConnectionErrorString;
SshRemoteProcess::ExitStatus m_exitStatus; SshRemoteProcess::ExitStatus m_exitStatus;
QByteArray m_exitSignal; SshRemoteProcess::Signal m_exitSignal;
int m_exitCode; int m_exitCode;
QString m_processErrorString; QString m_processErrorString;
State m_state; State m_state;
@@ -110,7 +110,7 @@ void SshRemoteProcessRunner::runInternal(const QByteArray &command,
d->m_lastConnectionError = SshNoError; d->m_lastConnectionError = SshNoError;
d->m_lastConnectionErrorString.clear(); d->m_lastConnectionErrorString.clear();
d->m_processErrorString.clear(); d->m_processErrorString.clear();
d->m_exitSignal.clear(); d->m_exitSignal = SshRemoteProcess::NoSignal;
d->m_exitCode = -1; d->m_exitCode = -1;
d->m_command = command; d->m_command = command;
d->m_connection = SshConnectionManager::instance().acquireConnection(sshParams); d->m_connection = SshConnectionManager::instance().acquireConnection(sshParams);
@@ -234,7 +234,7 @@ SshRemoteProcess::ExitStatus SshRemoteProcessRunner::processExitStatus() const
return d->m_exitStatus; return d->m_exitStatus;
} }
QByteArray SshRemoteProcessRunner::processExitSignal() const SshRemoteProcess::Signal SshRemoteProcessRunner::processExitSignal() const
{ {
QTC_CHECK(processExitStatus() == SshRemoteProcess::KilledBySignal); QTC_CHECK(processExitStatus() == SshRemoteProcess::KilledBySignal);
return d->m_exitSignal; return d->m_exitSignal;
@@ -257,7 +257,7 @@ void SshRemoteProcessRunner::writeDataToProcess(const QByteArray &data)
d->m_process->write(data); d->m_process->write(data);
} }
void SshRemoteProcessRunner::sendSignalToProcess(const QByteArray &signal) void SshRemoteProcessRunner::sendSignalToProcess(SshRemoteProcess::Signal signal)
{ {
QTC_ASSERT(isProcessRunning(), return); QTC_ASSERT(isProcessRunning(), return);
d->m_process->sendSignal(signal); d->m_process->sendSignal(signal);

4
src/libs/utils/ssh/sshremoteprocessrunner.h
View File

@@ -59,10 +59,10 @@ public:
bool isProcessRunning() const; bool isProcessRunning() const;
void writeDataToProcess(const QByteArray &data); void writeDataToProcess(const QByteArray &data);
void sendSignalToProcess(const QByteArray &signal); // No effect with OpenSSH server. void sendSignalToProcess(SshRemoteProcess::Signal signal); // No effect with OpenSSH server.
void cancel(); // Does not stop remote process, just frees SSH-related process resources. void cancel(); // Does not stop remote process, just frees SSH-related process resources.
SshRemoteProcess::ExitStatus processExitStatus() const; SshRemoteProcess::ExitStatus processExitStatus() const;
QByteArray processExitSignal() const; SshRemoteProcess::Signal processExitSignal() const;
int processExitCode() const; int processExitCode() const;
QString processErrorString() const; QString processErrorString() const;