1 files changed, 63 insertions, 0 deletions
diff --git a/logging_util.h b/logging_util.h
new file mode 100644
index 00000000..47b2e062
--- /dev/null
+++ b/logging_util.h
@@ -0,0 +1,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);
+}
+
+}
+