File: Debug.cpp

package info (click to toggle)
sonic-visualiser 5.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 24,640 kB
  • sloc: cpp: 158,888; ansic: 11,920; sh: 1,785; makefile: 517; xml: 64; perl: 31
file content (191 lines) | stat: -rw-r--r-- 4,814 bytes parent folder | download | duplicates (2)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/* -*- 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 <QMutex>
#include <QDir>
#include <QUrl>
#include <QCoreApplication>
#include <QDateTime>

#include <stdexcept>
#include <sstream>
#include <memory>

static std::unique_ptr<SVDebug> svdebug = nullptr;
static std::unique_ptr<SVCerr> svcerr = nullptr;
static QMutex mutex;

SVDebug &getSVDebug()
{
    static std::once_flag f;
    std::call_once(f, [&]() {
        svdebug = std::unique_ptr<SVDebug>(new SVDebug());
    });
    return *svdebug;
}

SVCerr &getSVCerr()
{
    SVDebug &svdebug = getSVDebug();
    static std::once_flag f;
    std::call_once(f, [&]() {
        svcerr = std::unique_ptr<SVCerr>(new SVCerr(svdebug));
    });
    return *svcerr;
}

QtMessageHandler SVDebug::m_formerQtMessageHandler = nullptr;
QtMessageHandler SVCerr::m_formerQtMessageHandler = nullptr;
bool SVDebug::m_silenced = false;
bool SVCerr::m_silenced = false;

SVDebug::SVDebug() :
    m_prefix(nullptr),
    m_ok(false),
    m_eol(true)
{
    if (m_silenced) return;

    m_timer.start();
    
    if (qApp->applicationName() == "") {
        std::cerr << "ERROR: Can't use SVDEBUG before setting application name" << std::endl;
        throw std::logic_error("Can't use SVDEBUG before setting application name");
    }
    
    QString pfx = sv::ResourceFinder().getUserResourcePrefix();
    QDir logdir(QString("%1/%2").arg(pfx).arg("log"));

    m_prefix = strdup(QString("[%1]")
                      .arg(QCoreApplication::applicationPid())
                      .toLatin1().data());

    //!!! what to do if mkpath fails?
    if (!logdir.exists()) logdir.mkpath(logdir.path());

    QString fileName = logdir.path() + "/sv-debug.log";

    m_stream.open(fileName.toLocal8Bit().data(), std::ios_base::out);

    if (!m_stream) {
        QDebug(QtWarningMsg) << (const char *)m_prefix
                             << "Failed to open debug log file "
                             << fileName << " for writing";
    } else {
        m_ok = true;
//        cerr << "Log file is " << fileName << endl;
        (*this) << "Debug log started at "
                << QDateTime::currentDateTime().toString() << endl;
    }
}

SVDebug::~SVDebug()
{
    if (m_stream) {
        (*this) << "Debug log ends" << endl;
        m_stream.close();
    }
}

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.toUtf8().data();
}

std::ostream &
operator<<(std::ostream &target, const QUrl &u)
{
    return target << "<" << u.toString() << ">";
}

static void
svDebugQtMessageHandler(QtMsgType type,
                        const QMessageLogContext &context,
                        const QString &msg)
{
    SVDEBUG << qPrintable(qFormatLogMessage(type, context, msg)) << endl;
}

void
SVDebug::installQtMessageHandler()
{
    m_formerQtMessageHandler = qInstallMessageHandler(svDebugQtMessageHandler);
}

void
SVDebug::restoreQtMessageHandler()
{
    (void)qInstallMessageHandler(m_formerQtMessageHandler);
}

static void
svCerrQtMessageHandler(QtMsgType type,
                        const QMessageLogContext &context,
                        const QString &msg)
{
    SVCERR << qPrintable(qFormatLogMessage(type, context, msg)) << endl;
}

void
SVCerr::installQtMessageHandler()
{
    m_formerQtMessageHandler = qInstallMessageHandler(svCerrQtMessageHandler);
}

void
SVCerr::restoreQtMessageHandler()
{
    (void)qInstallMessageHandler(m_formerQtMessageHandler);
}

static int funcLoggerDepth = 0;
static QMutex funcLoggerMutex;

FunctionLogger::FunctionLogger(const char *name) :
    m_name(name)
{
    QMutexLocker locker(&funcLoggerMutex);
    std::ostringstream os;
    for (int i = 0; i < funcLoggerDepth; ++i) {
        os << "  ";
    }
    os << "-[>] " << m_name;
    SVDEBUG << os.str() << endl;
    ++funcLoggerDepth;
}

FunctionLogger::~FunctionLogger()
{
    QMutexLocker locker(&funcLoggerMutex);
    --funcLoggerDepth;
    std::ostringstream os;
    for (int i = 0; i < funcLoggerDepth; ++i) {
        os << "  ";
    }
    os << "<[-] " << m_name;
    SVDEBUG << os.str() << endl;
}