/usr/include/KF5/KPty/kptydevice.h is in libkf5pty-dev 5.28.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* 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 kptydev_h
#define kptydev_h
#include "kpty.h"
#include <QtCore/QIODevice>
struct KPtyDevicePrivate;
#define Q_DECLARE_PRIVATE_MI(Class, SuperClass) \
inline Class##Private* d_func() { return reinterpret_cast<Class##Private *>(SuperClass::d_ptr); } \
inline const Class##Private* d_func() const { return reinterpret_cast<const Class##Private *>(SuperClass::d_ptr); } \
friend struct Class##Private;
/**
* Encapsulates KPty into a QIODevice, so it can be used with Q*Stream, etc.
*/
class KPTY_EXPORT KPtyDevice : public QIODevice, public KPty //krazy:exclude=dpointer (via macro)
{
Q_OBJECT
Q_DECLARE_PRIVATE_MI(KPtyDevice, KPty)
public:
/**
* Constructor
*/
KPtyDevice(QObject *parent = 0);
/**
* Destructor:
*
* If the pty is still open, it will be closed. Note, however, that
* an utmp registration is @em not undone.
*/
virtual ~KPtyDevice();
/**
* Create a pty master/slave pair.
*
* @return true if a pty pair was successfully opened
*/
bool open(OpenMode mode = ReadWrite | Unbuffered) Q_DECL_OVERRIDE;
/**
* Open using an existing pty master. The ownership of the fd
* remains with the caller, i.e., close() will not close the fd.
*
* This is useful if you wish to attach a secondary "controller" to an
* existing pty device such as a terminal widget.
* Note that you will need to use setSuspended() on both devices to
* control which one gets the incoming data from the pty.
*
* @param fd an open pty master file descriptor.
* @param mode the device mode to open the pty with.
* @return true if a pty pair was successfully opened
*/
bool open(int fd, OpenMode mode = ReadWrite | Unbuffered);
/**
* Close the pty master/slave pair.
*/
void close() Q_DECL_OVERRIDE;
/**
* Sets whether the KPtyDevice monitors the pty for incoming data.
*
* When the KPtyDevice is suspended, it will no longer attempt to buffer
* data that becomes available from the pty and it will not emit any
* signals.
*
* Do not use on closed ptys.
* After a call to open(), the pty is not suspended. If you need to
* ensure that no data is read, call this function before the main loop
* is entered again (i.e., immediately after opening the pty).
*/
void setSuspended(bool suspended);
/**
* Returns true if the KPtyDevice is not monitoring the pty for incoming
* data.
*
* Do not use on closed ptys.
*
* See setSuspended()
*/
bool isSuspended() const;
/**
* @return always true
*/
bool isSequential() const Q_DECL_OVERRIDE;
/**
* @reimp
*/
bool canReadLine() const Q_DECL_OVERRIDE;
/**
* @reimp
*/
bool atEnd() const Q_DECL_OVERRIDE;
/**
* @reimp
*/
qint64 bytesAvailable() const Q_DECL_OVERRIDE;
/**
* @reimp
*/
qint64 bytesToWrite() const Q_DECL_OVERRIDE;
bool waitForBytesWritten(int msecs = -1) Q_DECL_OVERRIDE;
bool waitForReadyRead(int msecs = -1) Q_DECL_OVERRIDE;
Q_SIGNALS:
/**
* Emitted when EOF is read from the PTY.
*
* Data may still remain in the buffers.
*/
void readEof();
protected:
qint64 readData(char *data, qint64 maxSize) Q_DECL_OVERRIDE;
qint64 readLineData(char *data, qint64 maxSize) Q_DECL_OVERRIDE;
qint64 writeData(const char *data, qint64 maxSize) Q_DECL_OVERRIDE;
private:
Q_PRIVATE_SLOT(d_func(), bool _k_canRead())
Q_PRIVATE_SLOT(d_func(), bool _k_canWrite())
};
#endif
|