Log.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2015 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 *
 */

#ifndef LOG_H_6014714286
#define LOG_H_6014714286

#include <Carna/Carna.h>
#include <Carna/base/Singleton.h>
#include <Carna/base/noncopyable.h>
#include <functional>
#include <string>
#include <memory>

namespace Carna
{

namespace base
{



// ----------------------------------------------------------------------------------
// Log
// ----------------------------------------------------------------------------------
    
class CARNA_LIB 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 CARNA_LIB 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 CARNA_LIB Writer
    {

        NON_COPYABLE

    public:

        virtual ~Writer();

        virtual void write( Severity severity, const std::string& entry ) const = 0;

    }; // Log :: Writer

    // ------------------------------------------------------------------------------
    // Log :: TextWriter
    // ------------------------------------------------------------------------------
    
    class CARNA_LIB 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 CARNA_LIB 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 CARNA_LIB OnShutdownListener
    {

    public:

        virtual ~OnShutdownListener();

        virtual void onLogShutdown() = 0;

    }; // Log :: OnShutdownListener

    void addOnShutdownListener( OnShutdownListener& listener );
    
    void removeOnShutdownListener( const OnShutdownListener& listener );

    void shutdown();

}; // Log



// ----------------------------------------------------------------------------------
// CARNA_LOG_TAG_SCOPE
// ----------------------------------------------------------------------------------

#define CARNA_LOG_TAG_SCOPE( tag ) \
    const ::Carna::base::Log::TagScope _tagScope##__COUNTER__( tag )



}  // namespace Carna :: base

}  // namespace Carna

#endif // LOG_H_6014714286