1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/******************************************************************************
* Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file logging_util.h - a collection of utilities to facilitate debug logging.
*/
#pragma once
#include <QtCore/QDebug>
namespace QMatrixClient {
// QDebug manipulators
using QDebugManip = QDebug (*)(QDebug);
/**
* @brief QDebug manipulator to setup the stream for JSON output.
*
* Originally made to encapsulate the change in QDebug behavior in Qt 5.4
* and the respective addition of QDebug::noquote().
* Together with the operator<<() helper, the proposed usage is
* (similar to std:: I/O manipulators):
*
* @example qDebug() << formatJson << json_object; // (QJsonObject, or QJsonValue, etc.)
*/
static QDebugManip formatJson = [](QDebug debug_object) {
#if QT_VERSION < QT_VERSION_CHECK(5, 4, 0)
return debug_object;
#else
return debug_object.noquote();
#endif
};
/**
* @brief A helper operator to facilitate using formatJson (and possibly other manipulators)
*
* @param debug_object to output the json to
* @param qdm a QDebug manipulator
* @return a copy of debug_object that has its mode altered by qdm
*/
inline QDebug operator<< (QDebug debug_object, QDebugManip qdm) {
return qdm(debug_object);
}
}
|