Object.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_OBJECT_H
#define H2C_OBJECT_H
 
#include "core/Logger.h"
#include <core/config.h>
#include "core/Globals.h"
 
#ifndef _WIN32
#include <sys/time.h>
#endif
#include <unistd.h>
#include <iostream>
#include <atomic>
#include <map>
#include <QtCore>
#include <QDebug>
 
namespace H2Core {

typedef struct atomic_obj_cpt_t {
        std::atomic<int> constructed;
        std::atomic<int> destructed;
        atomic_obj_cpt_t() : constructed(0), destructed(0) {}
} atomic_obj_cpt_t;
 
typedef struct {
        int constructed;
        int destructed;
} obj_cpt_t;

typedef std::map<const char*, obj_cpt_t> object_map_t;
typedef std::map<const char*, const atomic_obj_cpt_t*> object_internal_map_t;

class Base {
        public:
                Base() {
#ifdef H2CORE_HAVE_DEBUG
                        if ( __count ) {
                                ++__objects_count;
                        }
#endif
                }
                Base(const Base &other) {
#ifdef H2CORE_HAVE_DEBUG
                        if ( __count ) {
                                ++__objects_count;
                        }
#endif
                }
                static const char *_class_name() { return "Object"; }        
                virtual const char* class_name() const { return _class_name(); }
                static void set_count( bool flag );
                static bool count_active() { return __count; }
                static int objects_count() { return __objects_count; }

                static void write_objects_map_to( std::ostream& out, object_map_t* map = nullptr );
                static void write_objects_map_to_cerr() { Base::write_objects_map_to( std::cerr ); }  

                static int bootstrap( Logger* logger, bool count=false );
                static Logger* logger()                 { return __logger; }            

        static QString base_clock( const QString& sMsg );
        static QString base_clock_in( const QString& sMsg );
        
                static int getAliveObjectCount();
 
                static object_map_t getObjectMap();
                static void printObjectMapDiff( object_map_t map );
                static QString sPrintIndention;

                virtual QString toQString( const QString& sPrefix = "", bool bShort = true ) const;
                void Print( bool bShort = true ) const;

                void logBacktrace() const;
        protected:
                ~Base() {
#ifdef H2CORE_HAVE_DEBUG
                        if ( __count ) {
                                --__objects_count;
                        }
#endif
                }
                static bool __count;               
                static Logger * __logger;
                static bool bLogColors;
                static void registerClass(const char *name, const atomic_obj_cpt_t *counters);
        static timeval __last_clock;
        
        private:
                static std::atomic<int> __objects_count;        
                static object_internal_map_t __objects_map;      
                static pthread_mutex_t __mutex;         
};
 
std::ostream& operator<<( std::ostream& os, const Base& object );
std::ostream& operator<<( std::ostream& os, const Base* object );
 
 
inline QDebug operator<<( QDebug d, Base *o ) {
        d << ( o ? o->toQString( "", true ) : "(nullptr)" );
        return d;
}
 
inline QDebug operator<<( QDebug d, std::shared_ptr<Base> o ) {
        d << ( o ? o->toQString( "", true ) : "(nullptr)" );
        return d;
}
 
template<typename T> class Object: public Base {
        public:
                Object() {
#ifdef H2CORE_HAVE_DEBUG
                        if ( __logger && __logger->should_log( Logger::Constructors ) ) {
                                __logger->log( Logger::Debug, nullptr, T::_class_name(), "Constructor" );
                        }
                        if ( __count ) {
                                if ( ! counters.constructed ) {
                                        registerClass(T::_class_name(), &counters);
                                }
                                ++counters.constructed;
                        }
#endif
                }
                Object(const Object<T> &other) {
#ifdef H2CORE_HAVE_DEBUG
                        if( __logger && __logger->should_log( Logger::Constructors ) ) {
                                __logger->log( Logger::Debug, nullptr, T::_class_name(), "Copy Constructor" );
                        }
                        if ( __count ) {
                                if ( ! counters.constructed ) {
                                        registerClass(T::_class_name(), &counters);
                                }
                                ++counters.constructed;
                        }
#endif
                }
        protected:
                ~Object() {
#ifdef H2CORE_HAVE_DEBUG
                        if( __logger && __logger->should_log( Logger::Constructors ) ) {
                                __logger->log( Logger::Debug, nullptr, T::_class_name(), "Destructor" );
                        }
                        if ( __count ) {
                                ++counters.destructed;
                        }
#endif
                }
        private:
                static atomic_obj_cpt_t counters;
};
template<typename T> atomic_obj_cpt_t Object<T>::counters;
 
 
// Object inherited class declaration macro
#define H2_OBJECT(name)                                                 \
        public: static const char* _class_name() { return #name; } \
                        const char* class_name() const override { return _class_name(); }
 
// LOG MACROS
#define __LOG_METHOD(   lvl, msg )  if( __logger->should_log( (lvl) ) )                 { __logger->log( (lvl), _class_name(), __FUNCTION__, QString( "%1" ).arg( msg ) ); }
#define __LOG_CLASS(    lvl, msg )  if( logger()->should_log( (lvl) ) )                 { logger()->log( (lvl), _class_name(), __FUNCTION__, QString( "%1" ).arg( msg ) ); }
#define __LOG_OBJ(      lvl, msg )  if( __object->logger()->should_log( (lvl) ) )       { __object->logger()->log( (lvl), 0, __PRETTY_FUNCTION__, QString( "%1" ).arg( msg ) ); }
#define __LOG_STATIC(   lvl, msg )  if( H2Core::Logger::get_instance()->should_log( (lvl) ) )   { H2Core::Logger::get_instance()->log( (lvl), 0, __PRETTY_FUNCTION__, QString( "%1" ).arg( msg ) ); }
#define __LOG( logger,  lvl, msg )  if( (logger)->should_log( (lvl) ) )                 { (logger)->log( (lvl), 0, 0, QString( "%1" ).arg( msg ) ); }
 
// Object instance method logging macros
#define DEBUGLOG(x)     __LOG_METHOD( H2Core::Logger::Debug,   (x) );
#define INFOLOG(x)      __LOG_METHOD( H2Core::Logger::Info,    (x) );
#define WARNINGLOG(x)   __LOG_METHOD( H2Core::Logger::Warning, (x) );
#define ERRORLOG(x)     __LOG_METHOD( H2Core::Logger::Error,   (x) );
 
// Object class method logging macros
#define _DEBUGLOG(x)    __LOG_CLASS( H2Core::Logger::Debug,   (x) );
#define _INFOLOG(x)     __LOG_CLASS( H2Core::Logger::Info,    (x) );
#define _WARNINGLOG(x)  __LOG_CLASS( H2Core::Logger::Warning, (x) );
#define _ERRORLOG(x)    __LOG_CLASS( H2Core::Logger::Error,   (x) );
 
// logging macros using an Base *__object ( thread :  Base * __object = ( Base * )param; )
#define __DEBUGLOG(x)   __LOG_OBJ( H2Core::Logger::Debug,      (x) );
#define __INFOLOG(x)    __LOG_OBJ( H2Core::Logger::Info,       (x) );
#define __WARNINGLOG(x) __LOG_OBJ( H2Core::Logger::Warning,    (x) );
#define __ERRORLOG(x)   __LOG_OBJ( H2Core::Logger::Error,      (x) );
 
// logging macros using  ( thread :  Base * __object = ( Base * )param; )
#define ___DEBUGLOG(x)  __LOG_STATIC( H2Core::Logger::Debug,    (x) );
#define ___INFOLOG(x)   __LOG_STATIC( H2Core::Logger::Info,     (x) );
#define ___WARNINGLOG(x) __LOG_STATIC(H2Core::Logger::Warning,  (x) );
#define ___ERRORLOG(x)  __LOG_STATIC( H2Core::Logger::Error,    (x) );
 
// Can be called without or with a single argument
#define CLOCK(...)      __LOG_METHOD( H2Core::Logger::Debug, base_clock( QString( "%1" ).arg( #__VA_ARGS__ ) ) );
#define CLOCKIN(...)    __LOG_METHOD( H2Core::Logger::Debug, base_clock_in( QString( "%1" ).arg( #__VA_ARGS__ ) ) );
 
};
 
#endif // H2C_OBJECT_H
 
/* vim: set softtabstop=4 noexpandtab: */