debug.hpp

/* Copyright (c) 2014-2015, The Nuria Project
 * The NuriaProject Framework 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 3 of the License,
 * or (at your option) any later version.
 * 
 * The NuriaProject Framework 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 The NuriaProject Framework.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NURIA_DEBUG_HPP
#define NURIA_DEBUG_HPP

#include "essentials.hpp"
#include "callback.hpp"
#include <QDebug>

namespace Nuria {

class NURIA_CORE_EXPORT Debug : public QDebug {
public:
        
        enum Type {
                DebugMsg = 0,
                LogMsg = 1,
                WarnMsg = 2,
                ErrorMsg = 3,
                CriticalMsg = 4,
                
                AllLevels = CriticalMsg + 1,
                DefaultLowestMsgLevel = DebugMsg
                
        };
        
        Debug (Type type, const char *module, const char *fileName, int line,
               const char *className, const char *methodName);
        
        ~Debug ();
        
        static void setModuleLevel (const char *module, Type leastLevel);
        
        static bool isModuleDisabled (const char *module, Type level);
        
        static inline bool isModuleDisabled (uint32_t module, Type level) {
                return (level < m_lowestLevel ||
                        level < m_disabledModules.value (module, DefaultLowestMsgLevel));
        }
        
        static void qtMessageHandler (QtMsgType type, const QMessageLogContext &context, const QString &message);

        static void installMessageHandler ();
        
        static void setOutputDisabled (bool disabled);
        
        static bool isOutputDisabled ();
        
        static void setDestination (FILE *handle);
        
        static void setDestination (QIODevice *device);
        
        static void installOutputHandler (const Callback &callback);
        
        static void uninstallOutputHandler (const Callback &callback);
        
        static void setOutputFormat (const char *format);
        
private:
        
        void setBuffer (const QString &buffer);
        
        // Exposing these for faster access
        static Type m_lowestLevel;
        static QMap< uint32_t, Type > m_disabledModules;
        
        QString m_buffer;
        Type m_type;
        int m_line;
        QLatin1String m_module;
        QLatin1String m_file;
        QLatin1String m_class;
        QLatin1String m_method;
        
};

class NURIA_CORE_EXPORT DebugIgnore {
public:
        template< typename T >
        inline DebugIgnore &operator<< (const T &)
        { return *this; }
};

}

Q_DECLARE_METATYPE(Nuria::Debug::Type)

// Macro magic
#ifndef NURIA_MODULE
# define NURIA_MODULE ""
#endif

#define NURIA_DEBUG(type) \
        if (Nuria::Debug::isModuleDisabled \
        (Nuria::jenkinsHash (NURIA_MODULE, sizeof(NURIA_MODULE) - 1), type)) {} else \
        Nuria::Debug(type, NURIA_MODULE, __FILE__, __LINE__, Q_FUNC_INFO, 0)

#ifndef NURIA_DEBUG_NO_DEBUG
#define nDebug() NURIA_DEBUG(Nuria::Debug::DebugMsg)
#else
#define nDebug() Nuria::DebugIgnore()
#endif

#ifndef NURIA_DEBUG_NO_LOG
#define nLog() NURIA_DEBUG(Nuria::Debug::LogMsg)
#else
#define nLog() Nuria::DebugIgnore()
#endif

#ifndef NURIA_DEBUG_NO_WARN
#define nWarn() NURIA_DEBUG(Nuria::Debug::WarnMsg)
#else
#define nWarn() Nuria::DebugIgnore()
#endif

#ifndef NURIA_DEBUG_NO_ERROR
#define nError() NURIA_DEBUG(Nuria::Debug::ErrorMsg)
#else
#define nError() Nuria::DebugIgnore()
#endif

#ifndef NURIA_DEBUG_NO_CRITICAL
#define nCritical() NURIA_DEBUG(Nuria::Debug::CriticalMsg)
#else
#define nCritical() Nuria::DebugIgnore()
#endif

#endif // NURIA_DEBUG_HPP