1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* This file is a part of QTerminal - http://gitorious.org/qterminal
*
* This file was un-linked from KDE and modified
* by Maxim Bourmistrov <maxim@unixconn.com>
*
*/
/*
This file is part of the KDE libraries
Copyright (C) 2007 Oswald Buddenhagen <ossi@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KPTYPROCESS_H
#define KPTYPROCESS_H
#include "kprocess.h"
#include "kptydevice.h"
#include <csignal>
class KPtyDevice;
class KPtyProcessPrivate;
/**
* This class extends KProcess by support for PTYs (pseudo TTYs).
*
* The PTY is opened as soon as the class is instantiated. Verify that
* it was opened successfully by checking that pty()->masterFd() is not -1.
*
* The PTY is always made the process' controlling TTY.
* Utmp registration and connecting the stdio handles to the PTY are optional.
*
* No attempt to integrate with QProcess' waitFor*() functions was made,
* for it is impossible. Note that execute() does not work with the PTY, too.
* Use the PTY device's waitFor*() functions or use it asynchronously.
*
* @author Oswald Buddenhagen <ossi@kde.org>
*/
class KPtyProcess : public KProcess
{
Q_OBJECT
Q_DECLARE_PRIVATE(KPtyProcess)
public:
enum PtyChannelFlag {
NoChannels = 0, /**< The PTY is not connected to any channel. */
StdinChannel = 1, /**< Connect PTY to stdin. */
StdoutChannel = 2, /**< Connect PTY to stdout. */
StderrChannel = 4, /**< Connect PTY to stderr. */
AllOutputChannels = 6, /**< Connect PTY to all output channels. */
AllChannels = 7 /**< Connect PTY to all channels. */
};
Q_DECLARE_FLAGS(PtyChannels, PtyChannelFlag)
/**
* Constructor
*/
explicit KPtyProcess(QObject *parent = nullptr);
/**
* Construct a process using an open pty master.
*
* @param ptyMasterFd an open pty master file descriptor.
* The process does not take ownership of the descriptor;
* it will not be automatically closed at any point.
*/
KPtyProcess(int ptyMasterFd, QObject *parent = nullptr);
/**
* Destructor
*/
~KPtyProcess() override;
/**
* Set to which channels the PTY should be assigned.
*
* This function must be called before starting the process.
*
* @param channels the output channel handling mode
*/
void setPtyChannels(PtyChannels channels);
bool isRunning() const
{
bool rval;
(processId() > 0) ? rval= true : rval= false;
return rval;
}
/**
* Query to which channels the PTY is assigned.
*
* @return the output channel handling mode
*/
PtyChannels ptyChannels() const;
/**
* Set whether to register the process as a TTY login in utmp.
*
* Utmp is disabled by default.
* It should enabled for interactively fed processes, like terminal
* emulations.
*
* This function must be called before starting the process.
*
* @param value whether to register in utmp.
*/
void setUseUtmp(bool value);
/**
* Get whether to register the process as a TTY login in utmp.
*
* @return whether to register in utmp
*/
bool isUseUtmp() const;
/**
* Get the PTY device of this process.
*
* @return the PTY device
*/
KPtyDevice *pty() const;
protected:
/**
* @reimp
*/
void setupChildProcess() override;
private:
Q_PRIVATE_SLOT(d_func(), void _k_onStateChanged(QProcess::ProcessState))
};
//////////////////
// private data //
//////////////////
class KPtyProcessPrivate : public KProcessPrivate {
public:
KPtyProcessPrivate() :
ptyChannels(KPtyProcess::NoChannels),
addUtmp(false)
{
}
void _k_onStateChanged(QProcess::ProcessState newState)
{
if (newState == QProcess::NotRunning && addUtmp)
pty->logout();
}
KPtyDevice *pty;
KPtyProcess::PtyChannels ptyChannels;
bool addUtmp : 1;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KPtyProcess::PtyChannels)
#endif
|
