qiodevice.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:8k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
  4. ** Contact: Qt Software Information (qt-info@nokia.com)
  5. **
  6. ** This file is part of the QtCore module of the Qt Toolkit.
  7. **
  8. ** Commercial Usage
  9. ** Licensees holding valid Qt Commercial licenses may use this file in
  10. ** accordance with the Qt Commercial License Agreement provided with the
  11. ** Software or, alternatively, in accordance with the terms contained in
  12. ** a written agreement between you and Nokia.
  13. **
  14. **
  15. ** GNU General Public License Usage
  16. ** Alternatively, this file may be used under the terms of the GNU
  17. ** General Public License versions 2.0 or 3.0 as published by the Free
  18. ** Software Foundation and appearing in the file LICENSE.GPL included in
  19. ** the packaging of this file.  Please review the following information
  20. ** to ensure GNU General Public Licensing requirements will be met:
  21. ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22. ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23. ** exception, Nokia gives you certain additional rights. These rights
  24. ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25. ** the file GPL_EXCEPTION.txt in this package.
  26. **
  27. ** Qt for Windows(R) Licensees
  28. ** As a special exception, Nokia, as the sole copyright holder for Qt
  29. ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30. ** right for the Qt/Eclipse Integration to link to functionality
  31. ** provided by Qt Designer and its related libraries.
  32. **
  33. ** If you are unsure which license is appropriate for your use, please
  34. ** contact the sales department at qt-sales@nokia.com.
  35. **
  36. ****************************************************************************/
  37. #ifndef QIODEVICE_H
  38. #define QIODEVICE_H
  39. #ifndef QT_NO_QOBJECT
  40. #include <QtCore/qobject.h>
  41. #else
  42. #include <QtCore/qobjectdefs.h>
  43. #endif
  44. #include <QtCore/qstring.h>
  45. #ifdef open
  46. #error qiodevice.h must be included before any header file that defines open
  47. #endif
  48. QT_BEGIN_HEADER
  49. QT_BEGIN_NAMESPACE
  50. QT_MODULE(Core)
  51. class QByteArray;
  52. class QIODevicePrivate;
  53. class Q_CORE_EXPORT QIODevice
  54. #ifndef QT_NO_QOBJECT
  55.     : public QObject
  56. #endif
  57. {
  58. #ifndef QT_NO_QOBJECT
  59.     Q_OBJECT
  60. #endif
  61. public:
  62.     enum OpenModeFlag {
  63.         NotOpen = 0x0000,
  64.         ReadOnly = 0x0001,
  65.         WriteOnly = 0x0002,
  66.         ReadWrite = ReadOnly | WriteOnly,
  67.         Append = 0x0004,
  68.         Truncate = 0x0008,
  69.         Text = 0x0010,
  70.         Unbuffered = 0x0020
  71.     };
  72.     Q_DECLARE_FLAGS(OpenMode, OpenModeFlag)
  73.     QIODevice();
  74. #ifndef QT_NO_QOBJECT
  75.     explicit QIODevice(QObject *parent);
  76. #endif
  77.     virtual ~QIODevice();
  78.     OpenMode openMode() const;
  79.     void setTextModeEnabled(bool enabled);
  80.     bool isTextModeEnabled() const;
  81.     bool isOpen() const;
  82.     bool isReadable() const;
  83.     bool isWritable() const;
  84.     virtual bool isSequential() const;
  85.     virtual bool open(OpenMode mode);
  86.     virtual void close();
  87.     // ### Qt 5: pos() and seek() should not be virtual, and
  88.     // ### seek() should call a virtual seekData() function.
  89.     virtual qint64 pos() const;
  90.     virtual qint64 size() const;
  91.     virtual bool seek(qint64 pos);
  92.     virtual bool atEnd() const;
  93.     virtual bool reset();
  94.     virtual qint64 bytesAvailable() const;
  95.     virtual qint64 bytesToWrite() const;
  96.     qint64 read(char *data, qint64 maxlen);
  97.     QByteArray read(qint64 maxlen);
  98.     QByteArray readAll();
  99.     qint64 readLine(char *data, qint64 maxlen);
  100.     QByteArray readLine(qint64 maxlen = 0);
  101.     virtual bool canReadLine() const;
  102.     qint64 write(const char *data, qint64 len);
  103.     inline qint64 write(const QByteArray &data)
  104.     { return write(data.constData(), data.size()); }
  105.     qint64 peek(char *data, qint64 maxlen);
  106.     QByteArray peek(qint64 maxlen);
  107.     virtual bool waitForReadyRead(int msecs);
  108.     virtual bool waitForBytesWritten(int msecs);
  109.     void ungetChar(char c);
  110.     bool putChar(char c);
  111.     bool getChar(char *c);
  112.     QString errorString() const;
  113. #ifndef QT_NO_QOBJECT
  114. Q_SIGNALS:
  115.     void readyRead();
  116.     void bytesWritten(qint64 bytes);
  117.     void aboutToClose();
  118.     void readChannelFinished();
  119. #endif
  120. protected:
  121. #ifdef QT_NO_QOBJECT
  122.     QIODevice(QIODevicePrivate &dd);
  123. #else
  124.     QIODevice(QIODevicePrivate &dd, QObject *parent = 0);
  125. #endif
  126.     virtual qint64 readData(char *data, qint64 maxlen) = 0;
  127.     virtual qint64 readLineData(char *data, qint64 maxlen);
  128.     virtual qint64 writeData(const char *data, qint64 len) = 0;
  129.     void setOpenMode(OpenMode openMode);
  130.     void setErrorString(const QString &errorString);
  131. #ifdef QT_NO_QOBJECT
  132.     QIODevicePrivate *d_ptr;
  133. #endif
  134. private:
  135.     Q_DECLARE_PRIVATE(QIODevice)
  136.     Q_DISABLE_COPY(QIODevice)
  137. #ifdef QT3_SUPPORT
  138. public:
  139.     typedef qint64 Offset;
  140.     inline QT3_SUPPORT int flags() const { return static_cast<int>(openMode()); }
  141.     inline QT3_SUPPORT int mode() const { return static_cast<int>(openMode()); }
  142.     inline QT3_SUPPORT int state() const;
  143.     inline QT3_SUPPORT bool isDirectAccess() const { return !isSequential(); }
  144.     inline QT3_SUPPORT bool isSequentialAccess() const { return isSequential(); }
  145.     inline QT3_SUPPORT bool isCombinedAccess() const { return false; }
  146.     inline QT3_SUPPORT bool isBuffered() const { return true; }
  147.     inline QT3_SUPPORT bool isRaw() const { return false; }
  148.     inline QT3_SUPPORT bool isSynchronous() const { return true; }
  149.     inline QT3_SUPPORT bool isAsynchronous() const { return false; }
  150.     inline QT3_SUPPORT bool isTranslated() const { return (openMode() & Text) != 0; }
  151.     inline QT3_SUPPORT bool isInactive() const { return !isOpen(); }
  152.     typedef int Status;
  153.     QT3_SUPPORT Status status() const;
  154.     QT3_SUPPORT void resetStatus();
  155.     inline QT3_SUPPORT Offset at() const { return pos(); }
  156.     inline QT3_SUPPORT bool at(Offset offset) { return seek(offset); }
  157.     inline QT3_SUPPORT qint64 readBlock(char *data, quint64 maxlen) { return read(data, maxlen); }
  158.     inline QT3_SUPPORT qint64 writeBlock(const char *data, quint64 len) { return write(data, len); }
  159.     inline QT3_SUPPORT qint64 writeBlock(const QByteArray &data) { return write(data); }
  160.     inline QT3_SUPPORT int getch() { char c; return getChar(&c) ? int(uchar(c)) : -1; }
  161.     inline QT3_SUPPORT int putch(int c) { return putChar(c) ? int(uchar(c)) : -1; }
  162.     inline QT3_SUPPORT int ungetch(int c) { ungetChar(uchar(c)); return c; }
  163. #endif
  164. };
  165. Q_DECLARE_OPERATORS_FOR_FLAGS(QIODevice::OpenMode)
  166. #ifdef QT3_SUPPORT
  167. static QT3_SUPPORT_VARIABLE const uint IO_Direct = 0x0100;
  168. static QT3_SUPPORT_VARIABLE const uint IO_Sequential = 0x0200;
  169. static QT3_SUPPORT_VARIABLE const uint IO_Combined = 0x0300;
  170. static QT3_SUPPORT_VARIABLE const uint IO_TypeMask = 0x0300;
  171. static QT3_SUPPORT_VARIABLE const uint IO_Raw = 0x0000;
  172. static QT3_SUPPORT_VARIABLE const uint IO_Async = 0x0000;
  173. #define IO_ReadOnly QIODevice::ReadOnly
  174. #define IO_WriteOnly QIODevice::WriteOnly
  175. #define IO_ReadWrite QIODevice::ReadWrite
  176. #define IO_Append QIODevice::Append
  177. #define IO_Truncate QIODevice::Truncate
  178. #define IO_Translate QIODevice::Text
  179. #define IO_ModeMask 0x00ff
  180. static QT3_SUPPORT_VARIABLE const uint IO_Open = 0x1000;
  181. static QT3_SUPPORT_VARIABLE const uint IO_StateMask = 0xf000;
  182. static QT3_SUPPORT_VARIABLE const uint IO_Ok = 0;
  183. static QT3_SUPPORT_VARIABLE const uint IO_ReadError = 1;
  184. static QT3_SUPPORT_VARIABLE const uint IO_WriteError = 2;
  185. static QT3_SUPPORT_VARIABLE const uint IO_FatalError = 3;
  186. static QT3_SUPPORT_VARIABLE const uint IO_ResourceError = 4;
  187. static QT3_SUPPORT_VARIABLE const uint IO_OpenError = 5;
  188. static QT3_SUPPORT_VARIABLE const uint IO_ConnectError = 5;
  189. static QT3_SUPPORT_VARIABLE const uint IO_AbortError = 6;
  190. static QT3_SUPPORT_VARIABLE const uint IO_TimeOutError = 7;
  191. static QT3_SUPPORT_VARIABLE const uint IO_UnspecifiedError = 8;
  192. inline QT3_SUPPORT int QIODevice::state() const
  193. {
  194.     return isOpen() ? 0x1000 : 0;
  195. }
  196. #endif
  197. #if !defined(QT_NO_DEBUG_STREAM)
  198. class QDebug;
  199. Q_CORE_EXPORT QDebug operator<<(QDebug debug, QIODevice::OpenMode modes);
  200. #endif
  201. QT_END_NAMESPACE
  202. QT_END_HEADER
  203. #endif // QIODEVICE_H