1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QWINDOWSPIPEREADER_P_H
41 #define QWINDOWSPIPEREADER_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <qobject.h>
55 #include <private/qringbuffer_p.h>
56 
57 #include <qt_windows.h>
58 
59 QT_BEGIN_NAMESPACE
60 
61 class Q_CORE_EXPORT QWindowsPipeReader : public QObject
62 {
63     Q_OBJECT
64 public:
65     explicit QWindowsPipeReader(QObject *parent = 0);
66     ~QWindowsPipeReader();
67 
68     void setHandle(HANDLE hPipeReadEnd);
69     void startAsyncRead();
70     void stop();
71 
setMaxReadBufferSize(qint64 size)72     void setMaxReadBufferSize(qint64 size) { readBufferMaxSize = size; }
maxReadBufferSize()73     qint64 maxReadBufferSize() const { return readBufferMaxSize; }
74 
isPipeClosed()75     bool isPipeClosed() const { return pipeBroken; }
76     qint64 bytesAvailable() const;
77     qint64 read(char *data, qint64 maxlen);
78     bool canReadLine() const;
79     bool waitForReadyRead(int msecs);
80     bool waitForPipeClosed(int msecs);
81 
isReadOperationActive()82     bool isReadOperationActive() const { return readSequenceStarted; }
83 
84 Q_SIGNALS:
85     void winError(ulong, const QString &);
86     void readyRead();
87     void pipeClosed();
88     void _q_queueReadyRead(QPrivateSignal);
89 
90 private:
91     static void CALLBACK readFileCompleted(DWORD errorCode, DWORD numberOfBytesTransfered,
92                                            OVERLAPPED *overlappedBase);
93     void notified(DWORD errorCode, DWORD numberOfBytesRead);
94     DWORD checkPipeState();
95     bool waitForNotification(int timeout);
96     void emitPendingReadyRead();
97 
98     class Overlapped : public OVERLAPPED
99     {
100         Q_DISABLE_COPY_MOVE(Overlapped)
101     public:
102         explicit Overlapped(QWindowsPipeReader *reader);
103         void clear();
104         QWindowsPipeReader *pipeReader;
105     };
106 
107     HANDLE handle;
108     Overlapped overlapped;
109     qint64 readBufferMaxSize;
110     QRingBuffer readBuffer;
111     qint64 actualReadBufferSize;
112     bool stopped;
113     bool readSequenceStarted;
114     bool notifiedCalled;
115     bool pipeBroken;
116     bool readyReadPending;
117     bool inReadyRead;
118 };
119 
120 QT_END_NAMESPACE
121 
122 #endif // QWINDOWSPIPEREADER_P_H
123