From 3823e310e39426043dc7f0529a6fba33fe4d49f0 Mon Sep 17 00:00:00 2001
From: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
Date: Fri, 16 Feb 2024 13:58:04 +0100
Subject: [PATCH] QDataStream: reimplement and constrain operator<<(bool)

Instead of offering it as a plain overload, make it a template
and constrain the argument to be precisely bool. This removes the
danger of accidentally streaming things that are convertible to bool,
such as pointers, by, indeed, converting them to bool.
This allows us to remove the deleted overloads for pointers to
objects and pointers to members.

The existing operator<<(bool) is exported, hence I moved it into
removed_api.cpp. Since the implementation required private
QDataStream APIs, I've just "inlined" the implementation that
simply routed through the operator<<(qint8) overload.

Change-Id: I3c0a9811bf5c9e734e28514b37bcaaddb09ada25
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
---
 src/corelib/compat/removed_api.cpp        |  5 +++++
 src/corelib/serialization/qdatastream.cpp | 11 +++--------
 src/corelib/serialization/qdatastream.h   | 14 +++++++++++---
 3 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/src/corelib/compat/removed_api.cpp b/src/corelib/compat/removed_api.cpp
index 6aa0d1cee95..0553d32807f 100644
--- a/src/corelib/compat/removed_api.cpp
+++ b/src/corelib/compat/removed_api.cpp
@@ -919,6 +919,11 @@ QUrl QUrl::fromEncoded(const QByteArray &input, ParsingMode mode)
 
 #include "qdatastream.h" // inlined API
 
+QDataStream &QDataStream::operator<<(bool i)
+{
+    return (*this << qint8(i));
+}
+
 #include "qdir.h" // inlined API
 
 bool QDir::operator==(const QDir &dir) const
diff --git a/src/corelib/serialization/qdatastream.cpp b/src/corelib/serialization/qdatastream.cpp
index 29fe9978011..14bbae53f43 100644
--- a/src/corelib/serialization/qdatastream.cpp
+++ b/src/corelib/serialization/qdatastream.cpp
@@ -1267,18 +1267,13 @@ QDataStream &QDataStream::operator<<(qint64 i)
 */
 
 /*!
+    \fn QDataStream &QDataStream::operator<<(bool i)
+    \overload
+
     Writes a boolean value, \a i, to the stream. Returns a reference
     to the stream.
 */
 
-QDataStream &QDataStream::operator<<(bool i)
-{
-    CHECK_STREAM_WRITE_PRECOND(*this)
-    if (!dev->putChar(qint8(i)))
-        q_status = WriteFailed;
-    return *this;
-}
-
 /*!
     \overload
 
diff --git a/src/corelib/serialization/qdatastream.h b/src/corelib/serialization/qdatastream.h
index 616f6330d94..5aa5cc28cdd 100644
--- a/src/corelib/serialization/qdatastream.h
+++ b/src/corelib/serialization/qdatastream.h
@@ -167,7 +167,18 @@ public:
     QDataStream &operator<<(qint64 i);
     QDataStream &operator<<(quint64 i);
     QDataStream &operator<<(std::nullptr_t) { return *this; }
+#if QT_CORE_REMOVED_SINCE(6, 8) || defined(Q_QDOC)
     QDataStream &operator<<(bool i);
+#endif
+#if !defined(Q_QDOC)
+    // Disable implicit conversions to bool (e.g. for pointers)
+    template <typename T,
+             std::enable_if_t<std::is_same_v<std::remove_cv_t<T>, bool>, bool> = true>
+    QDataStream &operator<<(T i)
+    {
+        return (*this << qint8(i));
+    }
+#endif
 #if QT_CORE_REMOVED_SINCE(6, 3)
     QDataStream &operator<<(qfloat16 f);
 #endif
@@ -176,9 +187,6 @@ public:
     QDataStream &operator<<(const char *str);
     QDataStream &operator<<(char16_t c);
     QDataStream &operator<<(char32_t c);
-    QDataStream &operator<<(const volatile void *) = delete;
-    template <typename T, typename C>
-    QDataStream &operator<<(T C::*) = delete;
 
 #if QT_DEPRECATED_SINCE(6, 11)
     QT_DEPRECATED_VERSION_X_6_11("Use an overload that takes qint64 length.")