qDebug: Avoid implicit QVariant conversion

This commit restricts operator<<(QDebug lhs, QVariant rhs) to only work
if rhs is actually of type QVariant (instead of any type convertible to
QVariant). This is especially important as
a) we check in QMetaType whether (slightly simplified) QDebug{} <<
   std::declval<T>() is valid, and if so, register a function which
   simply uses the operator.
b) In QVariant, we ask the metatype system for the contained types
   registered debug function and then use it.
If a type now does not have its own operator<< for QDebug, but is
implicitly convertible to QVariant containing itself, this would lead to
an infinite recursion, when trying to use qDebug with that type. The
registered function in a) would just convert the type to QVariant, and
then ask the QVariant to print itself.
Disallowing implicit conversions in qDebug in general was considered
(i.e. adding template<typename T> operator<<(T) = delete in QDebug ),
but discarded as it breaks too much code relying on conversions.

Fixes: QTBUG-87122
Change-Id: Ib709297670cbc6cc307efd0dfd8e5b0279df9414
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Fabian Kosmale 2020-10-09 17:53:53 +02:00
parent 9aa2be236f
commit b83225fcc3
3 changed files with 26 additions and 8 deletions

View File

@ -2396,16 +2396,16 @@ bool QVariant::isNull() const
}
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QVariant &v)
QDebug QVariant::qdebugHelper(QDebug dbg) const
{
QDebugStateSaver saver(dbg);
const uint typeId = v.d.typeId();
const uint typeId = d.typeId();
dbg.nospace() << "QVariant(";
if (typeId != QMetaType::UnknownType) {
dbg << v.d.type().name() << ", ";
bool streamed = v.d.type().debugStream(dbg, v.d.storage());
if (!streamed && v.canConvert<QString>())
dbg << v.toString();
dbg << d.type().name() << ", ";
bool streamed = d.type().debugStream(dbg, d.storage());
if (!streamed && canConvert<QString>())
dbg << toString();
} else {
dbg << "Invalid";
}

View File

@ -494,7 +494,11 @@ private:
friend inline bool operator!=(const QVariant &a, const QVariant &b)
{ return !a.equals(b); }
#ifndef QT_NO_DEBUG_STREAM
friend Q_CORE_EXPORT QDebug operator<<(QDebug, const QVariant &);
template <typename T>
friend auto operator<<(const QDebug &debug, const T &variant) -> std::enable_if_t<std::is_same_v<T, QVariant>, QDebug> {
return variant.qdebugHelper(debug);
}
QDebug qdebugHelper(QDebug) const;
#endif
template<typename T>
friend inline T qvariant_cast(const QVariant &);
@ -595,7 +599,6 @@ template<> inline QVariant qvariant_cast<QVariant>(const QVariant &v)
#endif
#ifndef QT_NO_DEBUG_STREAM
Q_CORE_EXPORT QDebug operator<<(QDebug, const QVariant &);
Q_CORE_EXPORT QDebug operator<<(QDebug, const QVariant::Type);
#endif

View File

@ -34,6 +34,7 @@
#include <QtConcurrentRun>
#include <QFutureSynchronizer>
#include <QVariant>
static_assert(QTypeTraits::has_ostream_operator_v<QDebug, int>);
static_assert(QTypeTraits::has_ostream_operator_v<QDebug, QList<int>>);
@ -42,6 +43,11 @@ struct NonStreamable {};
static_assert(!QTypeTraits::has_ostream_operator_v<QDebug, NonStreamable>);
static_assert(!QTypeTraits::has_ostream_operator_v<QDebug, QList<NonStreamable>>);
static_assert(!QTypeTraits::has_ostream_operator_v<QDebug, QMap<int, NonStreamable>>);
struct ConvertsToQVariant {
operator QVariant() {return QVariant::fromValue(*this);};
};
static_assert(!QTypeTraits::has_ostream_operator_v<QDebug, ConvertsToQVariant>);
class tst_QDebug: public QObject
{
@ -75,6 +81,7 @@ private slots:
void defaultMessagehandler() const;
void threadSafety() const;
void toString() const;
void noQVariantEndlessRecursion() const;
};
void tst_QDebug::assignment() const
@ -770,6 +777,14 @@ void tst_QDebug::toString() const
}
}
void tst_QDebug::noQVariantEndlessRecursion() const
{
ConvertsToQVariant conv;
QVariant var = QVariant::fromValue(conv);
QTest::ignoreMessage(QtDebugMsg, "QVariant(ConvertsToQVariant, )");
qDebug() << var;
}
// Should compile: instentiation of unrelated operator<< should not cause cause compilation
// error in QDebug operators (QTBUG-47375)
class TestClassA {};