1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDEBUG_P_H
41#define QDEBUG_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/private/qglobal_p.h>
55#include "QtCore/qdebug.h"
56#include "QtCore/qmetaobject.h"
57#include "QtCore/qflags.h"
58
59QT_BEGIN_NAMESPACE
60
61namespace QtDebugUtils {
62
63// inline helpers for formatting basic classes.
64
65template <class Point>
66static inline void formatQPoint(QDebug &debug, const Point &point)
67{
68 debug << point.x() << ',' << point.y();
69}
70
71template <class Size>
72static inline void formatQSize(QDebug &debug, const Size &size)
73{
74 debug << size.width() << ", " << size.height();
75}
76
77template <class Rect>
78static inline void formatQRect(QDebug &debug, const Rect &rect)
79{
80 debug << rect.x() << ',' << rect.y() << ' ' << rect.width() << 'x' << rect.height();
81}
82
83template <class Margins>
84static inline void formatQMargins(QDebug &debug, const Margins &margins)
85{
86 debug << margins.left() << ", " << margins.top() << ", " << margins.right()
87 << ", " << margins.bottom();
88}
89
90#ifndef QT_NO_QOBJECT
91template <class QEnum>
92static inline void formatQEnum(QDebug &debug, QEnum value)
93{
94 const QMetaObject *metaObject = qt_getEnumMetaObject(value);
95 const QMetaEnum me = metaObject->enumerator(metaObject->indexOfEnumerator(qt_getEnumName(value)));
96 if (const char *key = me.valueToKey(int(value)))
97 debug << key;
98 else
99 debug << int(value);
100}
101
102template <class QEnum>
103static inline void formatNonNullQEnum(QDebug &debug, const char *prefix, QEnum value)
104{
105 if (value) {
106 debug << prefix;
107 formatQEnum(debug, value);
108 }
109}
110
111template <class Enum>
112static inline void formatQFlags(QDebug &debug, const QFlags<Enum> &value)
113{
114 const QMetaObject *metaObject = qt_getEnumMetaObject(Enum());
115 const QMetaEnum me = metaObject->enumerator(metaObject->indexOfEnumerator(qt_getEnumName(Enum())));
116 const QDebugStateSaver saver(debug);
117 debug.noquote();
118 debug << me.valueToKeys(value);
119}
120
121template <class Enum>
122static inline void formatNonNullQFlags(QDebug &debug, const char *prefix, const QFlags<Enum> &value)
123{
124 if (value) {
125 debug << prefix;
126 formatQFlags(debug, value);
127 }
128}
129
130#endif // !QT_NO_QOBJECT
131
132} // namespace QtDebugUtils
133
134QT_END_NAMESPACE
135
136#endif // QDEBUG_P_H
137