LogControl.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_BASE_LOGCONTROL_H
#define ZYPP_BASE_LOGCONTROL_H

#include <iosfwd>
#include <ostream> //for std::endl

#include <zypp-core/base/Logger.h>
#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/Pathname.h>

namespace zypp
{ 

  namespace log
  { 

    struct ZYPP_API LineWriter
    {
      virtual void writeOut( const std::string & /*formated_r*/ )
      {}
      virtual ~LineWriter()
      {}
    };

    struct StreamLineWriter : public LineWriter
    {
      StreamLineWriter( std::ostream & str_r ) : _str( &str_r ) {}

      void writeOut( const std::string & formated_r ) override
      { (*_str) << formated_r << std::endl; }

      protected:
        StreamLineWriter() : _str( 0 ) {}
        std::ostream *_str;
    };

    struct StdoutLineWriter : public StreamLineWriter
    {
      StdoutLineWriter();
    };

    struct StderrLineWriter : public StreamLineWriter
    {
      StderrLineWriter();
    };

    struct ZYPP_API FileLineWriter : public StreamLineWriter
    {
      FileLineWriter( const Pathname & file_r, mode_t mode_r = 0 );
      protected:
        shared_ptr<void> _outs;
    };

  } // namespace log


  namespace base
  { 

    //
    //  CLASS NAME : LogControl
    //
    class ZYPP_API LogControl
    {
      friend std::ostream & operator<<( std::ostream & str, const LogControl & obj );

    public:
      static LogControl instance()
      { return LogControl(); }


      using LineWriter = log::LineWriter;

      struct ZYPP_API LineFormater
      {
        virtual std::string format( const std::string & /*group_r*/,
                                    logger::LogLevel    /*level_r*/,
                                    const char *        /*file_r*/,
                                    const char *        /*func_r*/,
                                    int                 /*line_r*/,
                                    const std::string & /*message_r*/ );
        virtual ~LineFormater() {}
      };

      struct ZYPP_API JournalLineFormater: public LineFormater
      {
        std::string format( const std::string & /*group_r*/,
                            logger::LogLevel    /*level_r*/,
                            const char *        /*file_r*/,
                            const char *        /*func_r*/,
                            int                 /*line_r*/,
                            const std::string & /*message_r*/ ) override;
      };

    public:
      void setLineFormater( const shared_ptr<LineFormater> & formater_r );

      void enableLogForwardingMode ( bool enable = true );

    public:
      void logfile( const Pathname & logfile_r );
      void logfile( const Pathname & logfile_r, mode_t mode_r );

      void logNothing();

      void logToStdErr();

      void emergencyShutdown();

      static void notifyFork();

      void logRawLine ( std::string &&line );

    public:
      shared_ptr<LineWriter> getLineWriter() const;

      void setLineWriter( const shared_ptr<LineWriter> & writer_r );

    public:
      struct TmpExcessive
      {
        TmpExcessive();
        ~TmpExcessive();
      };

      struct ZYPP_API TmpLineWriter
      {
        TmpLineWriter( const shared_ptr<LineWriter> & writer_r = shared_ptr<LineWriter>() )
          : _writer( LogControl::instance().getLineWriter() )
        { LogControl::instance().setLineWriter( writer_r ); }

        template<class TLineWriter>
        TmpLineWriter( TLineWriter * _allocated_r )
          : _writer( LogControl::instance().getLineWriter() )
        { LogControl::instance().setLineWriter( shared_ptr<LineWriter>( _allocated_r ) ); }

        ~TmpLineWriter()
        { LogControl::instance().setLineWriter( _writer ); }

      private:
        shared_ptr<LineWriter> _writer;
      };

    private:
      LogControl()
      {}
    };

    std::ostream & operator<<( std::ostream & str, const LogControl & obj ) ZYPP_API;

  } // namespace base
} // namespace zypp
#endif // ZYPP_BASE_LOGCONTROL_H