Log.hpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2016 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 * 
 * 
 *  Copyright (C) 2021 - 2025 Leonid Kostrykin
 * 
 */
 
#ifndef LOG_H_6014714286
#define LOG_H_6014714286
 
#include <LibCarna/LibCarna.hpp>
#include <LibCarna/base/Singleton.hpp>
#include <LibCarna/base/noncopyable.hpp>
#include <functional>
#include <string>
#include <memory>
 
namespace LibCarna
{
 
namespace base
{
 
 
 
// ----------------------------------------------------------------------------------
// Log
// ----------------------------------------------------------------------------------
    
class LIBCARNA Log : public Singleton< Log >
{
 
    struct Details;
    const std::unique_ptr< Details > pimpl;
 
    NON_COPYABLE
    
    void pushTag( const std::string& tag );
    
    void popTag();
 
protected:
 
    friend class Singleton< Log >;
 
    Log();
 
public:
 
    virtual ~Log();
    
    const std::string& tag() const;
 
    enum Severity
    {
        fatal,   
        error,   
        warning, 
        debug,   
        verbose  
    };
    
    // ------------------------------------------------------------------------------
    // Log :: TagScope
    // ------------------------------------------------------------------------------
 
    struct LIBCARNA TagScope
    {
        explicit TagScope( const std::string& tag );
        
        ~TagScope();
        
    private:
    
        const bool valid;
        static void* operator new( std::size_t );   
        static void* operator new[]( std::size_t ); 
    };
 
    // ------------------------------------------------------------------------------
    // Log :: Writer
    // ------------------------------------------------------------------------------
 
    class LIBCARNA Writer
    {
 
        NON_COPYABLE
 
    public:
 
        virtual ~Writer();
 
        virtual void write( Severity severity, const std::string& entry ) const = 0;
 
    }; // Log :: Writer
 
    // ------------------------------------------------------------------------------
    // Log :: TextWriter
    // ------------------------------------------------------------------------------
    
    class LIBCARNA TextWriter : public Writer
    {
 
    public:
 
        virtual void write( Severity, const std::string& ) const override;
 
    protected:
 
        virtual void writeLine( Severity severity, const std::string& formattedEntry ) const = 0;
 
    }; // Log :: TextWriter
 
    // ------------------------------------------------------------------------------
    // Log :: StdWriter
    // ------------------------------------------------------------------------------
 
    class LIBCARNA StdWriter : public TextWriter
    {
 
    protected:
 
        virtual void writeLine( Severity, const std::string& ) const override;
 
    }; // Log :: StdWriter
 
    void setWriter( Writer* );
 
    void record( Severity severity, const std::string& entry ) const;
 
    // ------------------------------------------------------------------------------
    // Log :: OnShutdownListener
    // ------------------------------------------------------------------------------
 
    class LIBCARNA OnShutdownListener
    {
 
    public:
 
        virtual ~OnShutdownListener();
 
        virtual void onLogShutdown() = 0;
 
    }; // Log :: OnShutdownListener
 
    void addOnShutdownListener( OnShutdownListener& listener );
    
    void removeOnShutdownListener( const OnShutdownListener& listener );
 
    void shutdown();
 
}; // Log
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_LOG_TAG_SCOPE
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_LOG_TAG_SCOPE( tag ) \
    const ::LibCarna::base::Log::TagScope _tagScope##__COUNTER__( tag )
 
 
 
}  // namespace LibCarna :: base
 
}  // namespace LibCarna
 
#endif // LOG_H_6014714286