Changeset 932

Timestamp:

Aug 2, 2011, 3:03:13 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

QFile: Fixed open() docs.

The comment "Sequential devices, such as stdin and stdout..." in
the Windows section is true only partly -- as long as these devices are
attached to the console which performs all kinds of CRLF normalization
on its own. If they are redirected to regular files, then this normalzation
is not done which leads to all kinds of weird behavior (duplicate CR
symbols on output, hangs due to atEnd() returning false on input).

The affected warning is also valid on OS/2 so it now mentions this.

Location:

trunk

Files:

• doc/src/snippets/code/src_corelib_io_qfile.cpp (modified) (1 diff)
• src/corelib/io/qfile.cpp (modified) (2 diffs)

trunk/doc/src/snippets/code/src_corelib_io_qfile.cpp

@@ -74 +74 @@
 CONFIG += console
 //! [4]
+
+
+//! [5]
+#if defined(Q_OS_WIN) || defined(Q_OS_OS2)
+#include <io.h>
+#include <fcntl.h>
+#endif
+
+#if defined(Q_OS_WIN)
+    _setmode(_fileno(stdin), _O_BINARY);
+#elif defined(Q_OS_OS2)
+    setmode(fileno(stdin), O_BINARY);
+#endif
+//! [5]

trunk/src/corelib/io/qfile.cpp

@@ -1041 +1041 @@
     \sa close(), {qmake Variable Reference#CONFIG}{qmake Variable Reference}
 
-    \bold{Note for the Windows Platform}
+    \bold{Note for the Windows and OS/2 Platforms}
 
     \a fh must be opened in binary mode (i.e., the mode string must contain
     'b', as in "rb" or "wb") when accessing files and other random-access
     devices. Qt will translate the end-of-line characters if you pass
-    QIODevice::Text to \a mode. Sequential devices, such as stdin and stdout,
-    are unaffected by this limitation.
+    QIODevice::Text to \a mode. Predefined console devices, such as stdin and
+    stdout, should be put to binary mode using \c _setmode() before passing them
+    to this method:
+
+    \snippet doc/src/snippets/code/src_corelib_io_qfile.cpp 5
 
     You need to enable support for console applications in order to use the
@@ -1114 +1117 @@
 
     \sa close()
+
+     \bold{Note for the Windows and OS/2 Platforms}
+
+    \a fd must be opened in binary mode (i.e., the open flags must contain
+    _O_BINARY) when accessing files and other random-access devices. Qt will
+    translate the end-of-line characters if you pass QIODevice::Text to
+    \a mode. Predefined console devices, such as stdin and stdout, should be put
+    to binary mode using \c _setmode() before passing them to this method:
+
+    \snippet doc/src/snippets/code/src_corelib_io_qfile.cpp 5
 */
 bool QFile::open(int fd, OpenMode mode)