Split out some inline qdebug formatting helpers to qdebug_p.h.

Extract helpers to be able to format classes without type names
and use those for formatting QEvents to reduce clutter.

For example:

QWidgetWindow/"MainWindowClassWindow" QMouseEvent(QEvent::Type(MouseMove), buttons=QFlags<Qt::MouseButtons>(LeftButton), localPos=QPointF(50,116), screenPos=QPointF(948,652))
QWidget/"qt_scrollarea_viewport" QMouseEvent(QEvent::Type(MouseMove), buttons=QFlags<Qt::MouseButtons>(LeftButton), localPos=QPointF(45,32), screenPos=QPointF(948,652))

becomes

QWidgetWindow/"MainWindowClassWindow" QMouseEvent(MouseMove, LeftButton, localPos=50,116, screenPos=948,652)
QWidget/"qt_scrollarea_viewport" QMouseEvent(MouseMove, LeftButton, localPos=45,32, screenPos=948,652)

Change-Id: Ie5441d922962a05caed6b7079a74ea8a2b8a64fb
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>

6 files changed, 174 insertions, 18 deletions

diff --git a/src/corelib/io/io.pri b/src/corelib/io/io.pri
index 78349fbc49..4c189bfe57 100644
--- a/src/corelib/io/io.pri
+++ b/src/corelib/io/io.pri
@@ -7,6 +7,7 @@ HEADERS +=  \
         io/qdatastream_p.h \
         io/qdataurl_p.h \
         io/qdebug.h \
+        io/qdebug_p.h \
         io/qdir.h \
         io/qdir_p.h \
         io/qdiriterator.h \
diff --git a/src/corelib/io/qdebug_p.h b/src/corelib/io/qdebug_p.h
new file mode 100644
index 0000000000..0525929169
--- /dev/null
+++ b/src/corelib/io/qdebug_p.h
@@ -0,0 +1,129 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL21$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** As a special exception, The Qt Company gives you certain additional
+** rights. These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QDEBUG_P_H
+#define QDEBUG_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of other Qt classes.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "QtCore/qdebug.h"
+#include "QtCore/qmetaobject.h"
+#include "QtCore/qflags.h"
+
+QT_BEGIN_NAMESPACE
+
+namespace QtDebugUtils {
+
+// inline helpers for formatting basic classes.
+
+template <class Point>
+static inline void formatQPoint(QDebug &debug, const Point &point)
+{
+    debug << point.x() << ',' << point.y();
+}
+
+template <class Size>
+static inline void formatQSize(QDebug &debug, const Size &size)
+{
+    debug << size.width() << ", " << size.height();
+}
+
+template <class Rect>
+static inline void formatQRect(QDebug &debug, const Rect &rect)
+{
+    debug << rect.x() << ',' << rect.y() << ' ' << rect.width() << 'x' << rect.height();
+}
+
+template <class Margins>
+static inline void formatQMargins(QDebug &debug, const Margins &margins)
+{
+    debug << margins.left() << ", " << margins.top() << ", " << margins.right()
+        << ", " << margins.bottom();
+}
+
+#ifndef QT_NO_QOBJECT
+template <class QEnum>
+static inline void formatQEnum(QDebug &debug, QEnum value)
+{
+    const QMetaObject *metaObject = qt_getEnumMetaObject(value);
+    const QMetaEnum me = metaObject->enumerator(metaObject->indexOfEnumerator(qt_getEnumName(value)));
+    if (const char *key = me.valueToKey(value))
+        debug << key;
+    else
+        debug << int(value);
+}
+
+template <class QEnum>
+static inline void formatNonNullQEnum(QDebug &debug, const char *prefix, QEnum value)
+{
+    if (value) {
+         debug << prefix;
+         formatQEnum(debug, value);
+    }
+}
+
+template <class Enum>
+static inline void formatQFlags(QDebug &debug, const QFlags<Enum> &value)
+{
+    const QMetaObject *metaObject = qt_getEnumMetaObject(Enum());
+    const QMetaEnum me = metaObject->enumerator(metaObject->indexOfEnumerator(qt_getEnumName(Enum())));
+    const QDebugStateSaver saver(debug);
+    debug.noquote();
+    debug << me.valueToKeys(value);
+}
+
+template <class Enum>
+static inline void formatNonNullQFlags(QDebug &debug, const char *prefix, const QFlags<Enum> &value)
+{
+    if (value) {
+        debug << prefix;
+        formatQFlags(debug, value);
+    }
+}
+
+#endif // !QT_NO_QOBJECT
+
+} // namespace QtDebugUtils
+
+QT_END_NAMESPACE
+
+#endif // QDEBUG_P_H
diff --git a/src/corelib/tools/qmargins.cpp b/src/corelib/tools/qmargins.cpp
index a9413d6b5c..92c977a73b 100644
--- a/src/corelib/tools/qmargins.cpp
+++ b/src/corelib/tools/qmargins.cpp
@@ -33,7 +33,8 @@
 
 #include "qmargins.h"
 #include "qdatastream.h"
-#include "qdebug.h"
+
+#include <private/qdebug_p.h>
 
 QT_BEGIN_NAMESPACE
 
@@ -431,10 +432,13 @@ QDataStream &operator>>(QDataStream &s, QMargins &m)
 #endif // QT_NO_DATASTREAM
 
 #ifndef QT_NO_DEBUG_STREAM
-QDebug operator<<(QDebug dbg, const QMargins &m) {
+QDebug operator<<(QDebug dbg, const QMargins &m)
+{
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QMargins(" << m.left() << ", "
-            << m.top() << ", " << m.right() << ", " << m.bottom() << ')';
+    dbg.nospace();
+    dbg << "QMargins" << '(';
+    QtDebugUtils::formatQMargins(dbg, m);
+    dbg << ')';
     return dbg;
 }
 #endif
@@ -764,10 +768,13 @@ QDataStream &operator>>(QDataStream &s, QMarginsF &m)
 #endif // QT_NO_DATASTREAM
 
 #ifndef QT_NO_DEBUG_STREAM
-QDebug operator<<(QDebug dbg, const QMarginsF &m) {
+QDebug operator<<(QDebug dbg, const QMarginsF &m)
+{
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QMarginsF(" << m.left() << ", "
-            << m.top() << ", " << m.right() << ", " << m.bottom() << ')';
+    dbg.nospace();
+    dbg << "QMarginsF" << '(';
+    QtDebugUtils::formatQMargins(dbg, m);
+    dbg << ')';
     return dbg;
 }
 #endif
diff --git a/src/corelib/tools/qpoint.cpp b/src/corelib/tools/qpoint.cpp
index ebce6c9422..dc2a2d9739 100644
--- a/src/corelib/tools/qpoint.cpp
+++ b/src/corelib/tools/qpoint.cpp
@@ -33,7 +33,8 @@
 
 #include "qpoint.h"
 #include "qdatastream.h"
-#include "qdebug.h"
+
+#include <private/qdebug_p.h>
 
 QT_BEGIN_NAMESPACE
 
@@ -447,14 +448,20 @@ QDataStream &operator>>(QDataStream &s, QPoint &p)
 QDebug operator<<(QDebug dbg, const QPoint &p)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QPoint(" << p.x() << ',' << p.y() << ')';
+    dbg.nospace();
+    dbg << "QPoint" << '(';
+    QtDebugUtils::formatQPoint(dbg, p);
+    dbg << ')';
     return dbg;
 }
 
 QDebug operator<<(QDebug dbg, const QPointF &p)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QPointF(" << p.x() << ',' << p.y() << ')';
+    dbg.nospace();
+    dbg << "QPointF" << '(';
+    QtDebugUtils::formatQPoint(dbg, p);
+    dbg << ')';
     return dbg;
 }
 #endif
diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp
index 35cf2d5e5b..b2174745e4 100644
--- a/src/corelib/tools/qrect.cpp
+++ b/src/corelib/tools/qrect.cpp
@@ -33,9 +33,10 @@
 
 #include "qrect.h"
 #include "qdatastream.h"
-#include "qdebug.h"
 #include "qmath.h"
 
+#include <private/qdebug_p.h>
+
 QT_BEGIN_NAMESPACE
 
 /*!
@@ -1279,8 +1280,10 @@ QDataStream &operator>>(QDataStream &s, QRect &r)
 QDebug operator<<(QDebug dbg, const QRect &r)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QRect(" << r.x() << ',' << r.y() << ' '
-                  << r.width() << 'x' << r.height() << ')';
+    dbg.nospace();
+    dbg << "QRect" << '(';
+    QtDebugUtils::formatQRect(dbg, r);
+    dbg << ')';
     return dbg;
 }
 #endif
@@ -2488,8 +2491,10 @@ QDataStream &operator>>(QDataStream &s, QRectF &r)
 QDebug operator<<(QDebug dbg, const QRectF &r)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QRectF(" << r.x() << ',' << r.y() << ' '
-                  << r.width() << 'x' << r.height() << ')';
+    dbg.nospace();
+    dbg << "QRectF" << '(';
+    QtDebugUtils::formatQRect(dbg, r);
+    dbg << ')';
     return dbg;
 }
 #endif
diff --git a/src/corelib/tools/qsize.cpp b/src/corelib/tools/qsize.cpp
index d91dd0d130..19227432f2 100644
--- a/src/corelib/tools/qsize.cpp
+++ b/src/corelib/tools/qsize.cpp
@@ -33,7 +33,8 @@
 
 #include "qsize.h"
 #include "qdatastream.h"
-#include "qdebug.h"
+
+#include <private/qdebug_p.h>
 
 QT_BEGIN_NAMESPACE
 
@@ -440,7 +441,10 @@ QDataStream &operator>>(QDataStream &s, QSize &sz)
 QDebug operator<<(QDebug dbg, const QSize &s)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QSize(" << s.width() << ", " << s.height() << ')';
+    dbg.nospace();
+    dbg << "QSize(";
+    QtDebugUtils::formatQSize(dbg, s);
+    dbg << ')';
     return dbg;
 }
 #endif
@@ -867,7 +871,10 @@ QDataStream &operator>>(QDataStream &s, QSizeF &sz)
 QDebug operator<<(QDebug dbg, const QSizeF &s)
 {
     QDebugStateSaver saver(dbg);
-    dbg.nospace() << "QSizeF(" << s.width() << ", " << s.height() << ')';
+    dbg.nospace();
+    dbg << "QSizeF(";
+    QtDebugUtils::formatQSize(dbg, s);
+    dbg << ')';
     return dbg;
 }
 #endif