view base/Debug.h @ 1376:d9511f9e04d7 dev/refactor-piper-related

Introduce some POD structs for describing an external server application and the desired libraries to load from it, and disambiguating between empty list request and invalid list request. This allows for overriding PiperVampPluginFactory behaviour for using a PluginScan to populate the list request.

/* -*- 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 SV_DEBUG_H
#define SV_DEBUG_H

#include <QDebug>
#include <QTextStream>

#include "RealTime.h"

#include <string>
#include <iostream>
#include <fstream>

class QString;
class QUrl;

QDebug &operator<<(QDebug &, const std::string &);
std::ostream &operator<<(std::ostream &, const QString &);
std::ostream &operator<<(std::ostream &, const QUrl &);

using std::cout;
using std::cerr;
using std::endl;

class SVDebug {
public:
    SVDebug();
    ~SVDebug();

    template <typename T>
    inline SVDebug &operator<<(const T &t) {
        if (m_silenced) return *this;
        if (m_ok) {
            if (m_eol) {
                m_stream << m_prefix << " ";
            }
            m_stream << t;
            m_eol = false;
        }
        return *this;
    }

    inline SVDebug &operator<<(QTextStreamFunction) {
        if (m_silenced) return *this;
        m_stream << std::endl;
        m_eol = true;
        return *this;
    }

    static void silence() { m_silenced = true; }
    
private:
    std::fstream m_stream;
    char *m_prefix;
    bool m_ok;
    bool m_eol;
    static bool m_silenced;
};

class SVCerr {
public:
    SVCerr(SVDebug &d) : m_d(d) { }
    
    template <typename T>
    inline SVCerr &operator<<(const T &t) {
        if (m_silenced) return *this;
        m_d << t;
        cerr << t;
        return *this;
    }

    inline SVCerr &operator<<(QTextStreamFunction f) {
        if (m_silenced) return *this;
        m_d << f;
        cerr << std::endl;
        return *this;
    }

    static void silence() { m_silenced = true; }
    
private:
    SVDebug &m_d;
    static bool m_silenced;
};

extern SVDebug &getSVDebug();
extern SVCerr &getSVCerr();

// Writes to debug log only
#define SVDEBUG getSVDebug()

// Writes to both SVDEBUG and cerr
#define SVCERR getSVCerr()

#endif /* !_DEBUG_H_ */