Merge lp:~agateau/unity-2d/debug-tools into lp:unity-2d/3.0

[Aurélien Gâteau]

[plumbing] Unify message handling between Qt, GTK and part of the code from debug_p.h

Makes it possible to get timestamps as well as colored output. Timestamps will make it easier to investigate bugs like 703542.

Unify message handling between Qt, GTK and part of the code from debug_p.h

Makes it possible to get timestamps as well as colored output. Timestamps will make it easier to investigate bugs like 703542.

[lp:~agateau/unity-2d/debug-tools]

431. By Aurélien Gâteau on 2011-03-08

Use fputs to avoid flushing stderr before the end of line

flushing before EOL can lead to mixed log lines

[Florian Boucault (fboucault)]

Good job!

review: Approve

=== modified file 'config.h.in'
--- config.h.in	2011-01-27 23:00:24 +0000
+++ config.h.in	2011-03-08 10:13:05 +0000
@@ -3,8 +3,6 @@
 #define UNITY_DIR "${UNITY_DIR}"
 
 #include <QCoreApplication>
-#include <cstdio>
-#include <cstdlib>
 
 inline bool isRunningInstalled() {
     static bool cachedResult = QCoreApplication::applicationDirPath() == INSTALL_PREFIX "/bin";
@@ -26,21 +24,3 @@
         return QString(QCoreApplication::applicationDirPath()+"/../");
     }
 }
-
-inline void globalMessageHandler(QtMsgType type, const char *message)
-{
-    switch (type) {
-        case QtDebugMsg:
-            fprintf(stderr, "%s: [DEBUG] %s\n", qPrintable(QCoreApplication::applicationName()), message);
-            break;
-        case QtWarningMsg:
-            fprintf(stderr, "%s: [WARNING] %s\n", qPrintable(QCoreApplication::applicationName()), message);
-            break;
-        case QtCriticalMsg:
-            fprintf(stderr, "%s: [CRITICAL] %s\n", qPrintable(QCoreApplication::applicationName()), message);
-            break;
-        case QtFatalMsg:
-            fprintf(stderr, "%s: [FATAL] %s\n", qPrintable(QCoreApplication::applicationName()), message);
-            abort();
-    }
-}

=== modified file 'launcher/app/launcher.cpp'
--- launcher/app/launcher.cpp	2011-02-24 01:13:42 +0000
+++ launcher/app/launcher.cpp	2011-03-08 10:13:05 +0000
@@ -41,6 +41,7 @@
 #include "launcherview.h"
 #include "launchercontrol.h"
 #include "hidemodecontroller.h"
+#include "unity2ddebug.h"
 #include "unity2dpanel.h"
 #include "gesturehandler.h"
 
@@ -50,8 +51,7 @@
        (gtk_icon_theme_get_default) and requires a call to gtk_init */
     gtk_init(&argc, &argv);
 
-    QApplication::setApplicationName("Unity 2D Launcher");
-    qInstallMsgHandler(globalMessageHandler);
+    Unity2dDebug::installHandlers();
 
     /* Forcing graphics system to 'raster' instead of the default 'native'
        which on X11 is 'XRender'.

=== modified file 'libunity-2d-private/src/CMakeLists.txt'
--- libunity-2d-private/src/CMakeLists.txt	2011-02-24 01:13:42 +0000
+++ libunity-2d-private/src/CMakeLists.txt	2011-03-08 10:13:05 +0000
@@ -1,3 +1,6 @@
+# Dependencies
+pkg_check_modules(GLIB REQUIRED glib-2.0)
+
 # Sources
 set(libunity-2d-private_SRCS
     gettexttranslator.cpp
@@ -7,6 +10,7 @@
     hotkey.cpp
     mousearea.cpp
     unity2dapplication.cpp
+    unity2ddebug.cpp
     unity2dpanel.cpp
     mimedata.cpp
     dragdropevent.cpp
@@ -19,6 +23,7 @@
 include_directories(
     ${CMAKE_CURRENT_BINARY_DIR}
     ${CMAKE_CURRENT_SOURCE_DIR}
+    ${GLIB_INCLUDE_DIRS}
     )
 
 add_library(unity-2d-private SHARED ${libunity-2d-private_SRCS})
@@ -32,6 +37,7 @@
     ${QT_QTCORE_LIBRARIES}
     ${QT_QTDBUS_LIBRARIES}
     ${X11_LIBRARIES}
+    ${GLIB_LDFLAGS}
     )
 
 # Install

=== modified file 'libunity-2d-private/src/debug_p.h'
--- libunity-2d-private/src/debug_p.h	2011-02-10 00:48:58 +0000
+++ libunity-2d-private/src/debug_p.h	2011-03-08 10:13:05 +0000
@@ -19,14 +19,11 @@
 
 #include <QDebug>
 
-#define _UQ_BLUE  "\033[34m"
-#define _UQ_RED   "\033[31m"
-#define _UQ_RESET "\033[0m"
-#define _UQ_TRACE(level, color) (level().nospace() << color << __PRETTY_FUNCTION__ << _UQ_RESET ":").space()
+#define _UQ_TRACE(level) (level().nospace() << __PRETTY_FUNCTION__ << ":").space()
 
 // Simple macros to get KDebug like support
-#define UQ_DEBUG   _UQ_TRACE(qDebug, _UQ_BLUE)
-#define UQ_WARNING _UQ_TRACE(qWarning, _UQ_RED)
+#define UQ_DEBUG   _UQ_TRACE(qDebug)
+#define UQ_WARNING _UQ_TRACE(qWarning)
 
 // Log a variable name and value
 #define UQ_VAR(var) UQ_DEBUG << #var ":" << var

=== added file 'libunity-2d-private/src/unity2ddebug.cpp'
--- libunity-2d-private/src/unity2ddebug.cpp	1970-01-01 00:00:00 +0000
+++ libunity-2d-private/src/unity2ddebug.cpp	2011-03-08 10:13:05 +0000
@@ -0,0 +1,127 @@
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * Authors:
+ * - Aurélien Gâteau <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+// Self
+#include "unity2ddebug.h"
+
+// Local
+
+// Qt
+#include <QCoreApplication>
+#include <QTime>
+
+// Glib
+#include <glib.h>
+
+// libc
+#include <cstdio>
+#include <cstdlib>
+
+namespace Unity2dDebug
+{
+
+static const char* COLOR_BLUE = "\033[34m";
+static const char* COLOR_RED = "\033[31m";
+
+static bool getenvBool(const char* name, bool defaultValue)
+{
+    QByteArray value = qgetenv(name);
+    if (value.isEmpty()) {
+        return defaultValue;
+    }
+    return value != "0";
+}
+
+static void unity2dQtHandlerPrint(const char* color, const char* level, const char* message)
+{
+    static bool useColor = isatty(fileno(stderr)) && getenvBool("UNITY2D_DEBUG_COLOR", true);
+    if (useColor) {
+        fprintf(stderr, "%s[%s]\033[0m %s\n", color, level, message);
+    } else {
+        fprintf(stderr, "[%s] %s\n", level, message);
+    }
+}
+
+static void unity2dQtHandler(QtMsgType type, const char *message)
+{
+    static QByteArray name = QCoreApplication::applicationFilePath().section("/", -1).toLocal8Bit();
+    static bool useTimeStamp = getenvBool("UNITY2D_DEBUG_TIMESTAMP", false);
+
+    // We use fputs here because we don't want stderr to be flushed before the
+    // end of the line
+    if (useTimeStamp) {
+        QString timeStr = QTime::currentTime().toString("HH:mm:ss.zzz: ");
+        fputs(qPrintable(timeStr), stderr);
+    }
+
+    fputs(name.constData(), stderr);
+    fputs(": ", stderr);
+
+    switch (type) {
+    case QtDebugMsg:
+        unity2dQtHandlerPrint(COLOR_BLUE, "DEBUG", message);
+        break;
+    case QtWarningMsg:
+        unity2dQtHandlerPrint(COLOR_RED, "WARNING", message);
+        break;
+    case QtCriticalMsg:
+        unity2dQtHandlerPrint(COLOR_RED, "CRITICAL", message);
+        break;
+    case QtFatalMsg:
+        unity2dQtHandlerPrint(COLOR_RED, "FATAL", message);
+        abort();
+    }
+}
+
+static void unity2dGlibHandler(const gchar* domain, GLogLevelFlags level, const gchar* message, gpointer /* user_data */)
+{
+    switch (level & G_LOG_LEVEL_MASK) {
+    case G_LOG_LEVEL_ERROR:
+        qFatal("%s: %s", domain, message);
+        break;
+    case G_LOG_LEVEL_CRITICAL:
+        qCritical("%s: %s", domain, message);
+        break;
+    case G_LOG_LEVEL_WARNING:
+        qWarning("%s: %s", domain, message);
+        break;
+    case G_LOG_LEVEL_MESSAGE:
+    case G_LOG_LEVEL_INFO:
+    case G_LOG_LEVEL_DEBUG:
+        qDebug("%s: %s", domain, message);
+        break;
+    default:
+        qWarning("(Unknown level value %d!) %s: %s", int(level), domain, message);
+        break;
+    }
+
+    if (level & G_LOG_FLAG_FATAL) {
+        // Could happen if g_log_set_fatal_mask() has been called.
+        abort();
+    }
+}
+
+void installHandlers()
+{
+    g_log_set_default_handler(unity2dGlibHandler, 0);
+    qInstallMsgHandler(unity2dQtHandler);
+}
+
+} // namespace

=== added file 'libunity-2d-private/src/unity2ddebug.h'
--- libunity-2d-private/src/unity2ddebug.h	1970-01-01 00:00:00 +0000
+++ libunity-2d-private/src/unity2ddebug.h	2011-03-08 10:13:05 +0000
@@ -0,0 +1,39 @@
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2011 Canonical Ltd.
+ *
+ * Authors:
+ * - Aurélien Gâteau <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef UNITY2DDEBUG_H
+#define UNITY2DDEBUG_H
+
+// Local
+
+// Qt
+#include <QObject>
+
+/**
+ *
+ */
+namespace Unity2dDebug
+{
+
+void installHandlers();
+
+}
+
+#endif /* UNITY2DDEBUG_H */

=== modified file 'panel/app/main.cpp'
--- panel/app/main.cpp	2011-02-18 15:47:38 +0000
+++ panel/app/main.cpp	2011-03-08 10:13:05 +0000
@@ -32,6 +32,7 @@
 // Unity
 #include <gettexttranslator.h>
 #include <gnomesessionclient.h>
+#include <unity2ddebug.h>
 #include <unity2dpanel.h>
 #include <unity2dapplication.h>
 #include <unity2dstyle.h>
@@ -88,8 +89,7 @@
 {
     ThemeEngineHandler handler;
 
-    QApplication::setApplicationName("Unity 2D Panel");
-    qInstallMsgHandler(globalMessageHandler);
+    Unity2dDebug::installHandlers();
 
     /* Forcing graphics system to 'raster' instead of the default 'native'
        which on X11 is 'XRender'.

=== modified file 'places/app/places.cpp'
--- places/app/places.cpp	2011-02-24 01:13:42 +0000
+++ places/app/places.cpp	2011-03-08 10:13:05 +0000
@@ -35,6 +35,7 @@
 
 // unity-2d
 #include <gettexttranslator.h>
+#include <unity2ddebug.h>
 
 #include "dashdeclarativeview.h"
 #include "config.h"
@@ -70,8 +71,7 @@
 {
     /* gtk needs to be inited, otherwise we get an assert failure in gdk */
     gtk_init(&argc, &argv);
-    QApplication::setApplicationName("Unity 2D Dash");
-    qInstallMsgHandler(globalMessageHandler);
+    Unity2dDebug::installHandlers();
 
     /* Forcing graphics system to 'raster' instead of the default 'native'
        which on X11 is 'XRender'.

=== modified file 'spread/app/CMakeLists.txt'
--- spread/app/CMakeLists.txt	2011-01-14 20:45:02 +0000
+++ spread/app/CMakeLists.txt	2011-03-08 10:13:05 +0000
@@ -29,6 +29,7 @@
     ${CMAKE_CURRENT_SOURCE_DIR}
     ${CMAKE_CURRENT_BINARY_DIR}
     ${GTK_INCLUDE_DIRS}
+    ${libunity-2d-private_SOURCE_DIR}/src
     )
 
 target_link_libraries(unity-2d-spread
@@ -39,6 +40,7 @@
     ${GTK_LDFLAGS}
     ${X11_Xext_LIB}
     ${X11_X11_LIB}
+    unity-2d-private
     )
 
 # Install

=== modified file 'spread/app/spread.cpp'
--- spread/app/spread.cpp	2011-02-10 08:40:03 +0000
+++ spread/app/spread.cpp	2011-03-08 10:13:05 +0000
@@ -27,6 +27,8 @@
 #include "spreadview.h"
 #include "spreadcontrol.h"
 
+#include <unity2ddebug.h>
+
 #include "config.h"
 
 int main(int argc, char *argv[])
@@ -35,8 +37,7 @@
        (gtk_icon_theme_get_default) and requires a call to gtk_init */
     gtk_init(&argc, &argv);
 
-    QApplication::setApplicationName("Unity 2D Spread");
-    qInstallMsgHandler(globalMessageHandler);
+    Unity2dDebug::installHandlers();
 
     /* Forcing graphics system to 'raster' instead of the default 'native'
        which on X11 is 'XRender'.