changeset 685:99222d4bfc78 debug-output

Add Debug class
author Chris Cannam
date Thu, 12 May 2011 16:56:08 +0100
parents bd527db65d20
children b4a8d8221eaf
files base/Debug.cpp base/Debug.h svcore.pro
diffstat 3 files changed, 153 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/base/Debug.cpp	Thu May 12 16:56:08 2011 +0100
@@ -0,0 +1,86 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2010-2011 Chris Cannam and QMUL.
+    
+    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; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#include "Debug.h"
+#include "ResourceFinder.h"
+
+#include <QString>
+#include <QUrl>
+#include <QMutex>
+#include <QMutexLocker>
+#include <QFile>
+#include <QDir>
+#include <QCoreApplication>
+#include <QDateTime>
+
+#include <cstdio>
+
+QDebug &
+getSVDebug()
+{
+    static QFile *logFile = 0;
+    static QDebug *debug = 0;
+    static QMutex mutex;
+    static char *prefix;
+    mutex.lock();
+    if (!debug) {
+        prefix = new char[20];
+        sprintf(prefix, "[%lu]", (unsigned long)QCoreApplication::applicationPid());
+	QString pfx = ResourceFinder().getUserResourcePrefix();
+	QDir logdir(QString("%1/%2").arg(pfx).arg("log"));
+	if (!logdir.exists()) logdir.mkpath(logdir.path());
+        logFile = new QFile(logdir.path() + "/debug.log");
+        if (logFile->open(QIODevice::WriteOnly | QIODevice::Truncate)) {
+            QDebug(QtDebugMsg) << (const char *)prefix
+                               << "Opened debug log file "
+                               << logFile->fileName();
+            debug = new QDebug(logFile);
+        } else {
+            QDebug(QtWarningMsg) << (const char *)prefix
+                                 << "Failed to open debug log file "
+                                 << logFile->fileName()
+                                 << " for writing, using console debug instead";
+            debug = new QDebug(QtDebugMsg);
+            delete logFile;
+            logFile = 0;
+        }
+        *debug << endl << (const char *)prefix << "Log started at "
+               << QDateTime::currentDateTime().toString();
+    }
+    mutex.unlock();
+
+    QDebug &dref = *debug;
+    return dref << endl << (const char *)prefix;
+}
+
+QDebug &
+operator<<(QDebug &dbg, const std::string &s)
+{
+    dbg << QString::fromUtf8(s.c_str());
+    return dbg;
+}
+
+std::ostream &
+operator<<(std::ostream &target, const QString &str)
+{
+    return target << str.toLocal8Bit().data();
+}
+
+std::ostream &
+operator<<(std::ostream &target, const QUrl &u)
+{
+    return target << "<" << u.toString() << ">";
+}
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/base/Debug.h	Thu May 12 16:56:08 2011 +0100
@@ -0,0 +1,65 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2010-2011 Chris Cannam and QMUL.
+    
+    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; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#ifndef _DEBUG_H_
+#define _DEBUG_H_
+
+#include <QDebug>
+#include <QTextStream>
+#include <string>
+#include <iostream>
+
+class QString;
+class QUrl;
+
+QDebug &operator<<(QDebug &, const std::string &);
+std::ostream &operator<<(std::ostream &, const QString &);
+std::ostream &operator<<(std::ostream &, const QUrl &);
+
+#ifndef NDEBUG
+
+extern QDebug &getSVDebug();
+
+#define DEBUG getSVDebug()
+
+template <typename T>
+inline QDebug &operator<<(QDebug &d, const T &t) {
+    QString s;
+    QTextStream ts(&s);
+    ts << t;
+    d << s;
+    return d;
+}
+
+#else
+
+class NoDebug
+{
+public:
+    inline NoDebug() {}
+    inline ~NoDebug(){}
+
+    template <typename T>
+    inline NoDebug &operator<<(const T &) { return *this; }
+
+    inline NoDebug &operator<<(QTextStreamFunction) { return *this; }
+};
+
+#define DEBUG NoDebug()
+
+#endif /* !NDEBUG */
+
+#endif /* !_DEBUG_H_ */
+
--- a/svcore.pro	Tue May 10 17:55:57 2011 +0100
+++ b/svcore.pro	Thu May 12 16:56:08 2011 +0100
@@ -27,6 +27,7 @@
            base/AudioPlaySource.h \
            base/Clipboard.h \
            base/Command.h \
+           base/Debug.h \
            base/Exceptions.h \
            base/LogRange.h \
            base/Pitch.h \
@@ -62,6 +63,7 @@
 SOURCES += base/AudioLevel.cpp \
            base/Clipboard.cpp \
            base/Command.cpp \
+           base/Debug.cpp \
            base/Exceptions.cpp \
            base/LogRange.cpp \
            base/Pitch.cpp \