Logger.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2025 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_LOGGER_H
#define H2C_LOGGER_H
 
#include <cassert>
#include <list>
#include <pthread.h>
#include <memory>
#include <QtCore/QString>
#include <QStringList>
 
#include <core/config.h>
 
namespace H2Core {

class Logger {
        public:
                enum log_levels {
                        None            = 0x00,
                        Error           = 0x01,
                        Warning         = 0x02,
                        Info            = 0x04,
                        Debug           = 0x08,
                        Constructors    = 0x10,
                        Locks   = 0x20
                };

                typedef std::list<QString> queue_t;

        static Logger* bootstrap( unsigned msk,
                                                          const QString& sLogFilePath = QString(),
                                                          bool bUseStdout = true,
                                                          bool bLogTimestamps = false,
                                                          bool bLogColors = true );
        static Logger* create_instance( const QString& sLogFilePath = QString(),
                                                                        bool bUseStdout = true,
                                                                        bool bLogTimestamps = false,
                                                                        bool bLogColors = true );

                static Logger* get_instance(){ assert(__instance); return __instance; }

                ~Logger();

                static bool isAvailable() {
                        return __instance == nullptr ? false : true;
                }

                bool should_log( unsigned lvl ) const       { return (lvl&__bit_msk); }
                static void set_bit_mask( unsigned msk )    { __bit_msk = msk; }
                static unsigned bit_mask()                  { return __bit_msk; }

        void flush() const;

                static unsigned parse_log_level( const char* lvl );

                void log( unsigned level, const QString& sClassName,
                                  const char* func_name, const QString& sMsg,
                                  const QString& sColor = "" );
                friend void* loggerThread_func( void* param );

                static void setCrashContext( QString *pContext ) { Logger::pCrashContext = pContext; }
                static QString *getCrashContext() { return Logger::pCrashContext; }
 
                bool getLogColors() const;

                class CrashContext {
                        QString *pSavedContext;
                        QString *pThisContext;
                public:
                        CrashContext( QString *pContext );
                        CrashContext( QString sContext );
                        ~CrashContext();
                };
 
        private:
                static Logger* __instance;
                bool __running;                 
                pthread_mutex_t __mutex;        
                queue_t __msg_queue;            
                static unsigned __bit_msk;      
                static const char* __levels[];  
                pthread_cond_t __messages_available;
        QString m_sLogFilePath;
 
                QStringList m_prefixList;
                QStringList m_colorList;
                QString m_sColorOff;
 
        bool m_bUseStdout;
                bool m_bLogTimestamps;
                bool m_bLogColors;
 
                thread_local static QString *pCrashContext;

        Logger( const QString& sLogFilePath = QString(), bool bUseStdout = true,
                        bool bLogTimestamps = false, bool bLogColors = true );
 
#ifndef HAVE_SSCANF
                static int hextoi( const char* str, long len );
#endif // HAVE_SSCANF
};
 
inline bool Logger::getLogColors() const {
        return m_bLogColors;
}
 
};
 
#endif // H2C_LOGGER_H
 
/* vim: set softtabstop=4 noexpandtab: */