debug.h

Go to the documentation of this file.

/*
    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 St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef OMGUI_DEBUG_H
#define OMGUI_DEBUG_H

#include <iostream>
#include <sstream>

// userful headers for output manipulation
#include <iomanip>

#ifdef _MSC_VER
#include <crtdbg.h>
#endif

// windows headers are anoying and #define ERROR so get rid of it if needed
#ifdef ERROR
#undef ERROR
#endif

namespace omgui {

class DebugReport
{
public:
    enum REPORT_TYPE {
        MESSAGE,
        ERROR
    };

    DebugReport(REPORT_TYPE report_type = MESSAGE, const char *file = 0, int line = 0, const char *module = 0)
#ifdef _DEBUG
        : m_type(report_type), m_line(line), m_file(file), m_module(module)
#endif
    { }

#ifdef _DEBUG
    ~DebugReport() { flush(); }
#endif

    template<typename T> friend const DebugReport &operator << (const DebugReport &r, const T &t)
    {
#ifdef _DEBUG
        r.m_ss << t;
#endif
        return r;
    }

    friend const DebugReport &operator << (const DebugReport &r, std::ios_base& (*func)(std::ios_base&))
    {
#ifdef _DEBUG
        r.m_ss << func;
#endif
        return r;
    }

    friend const DebugReport &operator << (const DebugReport &r, std::basic_ostream<char, std::char_traits<char> >& (*func)(std::basic_ostream<char, std::char_traits<char> >&) )
    {
#ifdef _DEBUG
        r.flush();
#endif
        return r;
    }

    friend const DebugReport &operator << (const DebugReport &r, std::basic_ostream<wchar_t, std::char_traits<wchar_t> >& (*func)(std::basic_ostream<wchar_t, std::char_traits<wchar_t> >&) )
    {
#ifdef _DEBUG
        r.flush();
#endif
        return r;
    }

#ifdef _DEBUG
private:
    mutable std::stringstream m_ss;
    int m_type, m_line;
    const char *m_file, *m_module;

    std::ostream &get_ostream() const
    {
        switch(m_type)
        {
        case MESSAGE:
            return std::cout;
        case ERROR:
            return std::cerr;
        default:
            return std::cout;
        }
    }

    void flush() const
    {
        if( !m_ss.str().empty() )
        {

#ifdef _MSC_VER // Visual Studio debug output

            int type;
            switch(m_type)
            {
            case MESSAGE:
                type = _CRT_WARN;
                break;
            case ERROR:
                type = _CRT_ERROR;
                break;
            default:
                type = _CRT_WARN;
            }

            // if _CRT_ERROR is used and "Retry" is selected, break
            if( ::_CrtDbgReport(type, m_file, m_line, m_module, "%s\n", m_ss.str().c_str()) == 1 )
                ::_CrtDbgBreak();

#else // !_MSC_VER Debug output for other compilers

            std::ostream &out = get_ostream();

            if( m_file )
            {
                if( m_line )
                    out << m_file << "(" << m_line << ")";
                else
                    out << m_file;
                out << ": ";
            }

            out << m_ss.str() << "\n";

#endif // _MSC_VER

            m_ss.str("");
        }
    }
#endif // _DEBUG

public:
    /*
        stringstreams have a private copy ctor, so we need to write
        our own
    */
    DebugReport(const DebugReport &r)
#ifdef _DEBUG
        : m_type(r.m_type),
        m_line(r.m_line),
        m_file(r.m_file),
        m_module(r.m_module)
    {
        m_ss.str(r.m_ss.str());
    }
#else 
    { }
#endif
};

} // omgui

#endif // OMGUI_DEBUG_H

---