#define ZYPP_BASE_LOGCONTROL_H
#include <iosfwd>
+#include <ostream> //for std::endl
+#include "zypp/base/Logger.h"
#include "zypp/base/PtrTypes.h"
#include "zypp/Pathname.h"
///////////////////////////////////////////////////////////////////
namespace zypp
{ /////////////////////////////////////////////////////////////////
+
///////////////////////////////////////////////////////////////////
- namespace base
+ namespace log
{ /////////////////////////////////////////////////////////////////
- namespace logger
+ /** If you want to log the (formated) loglines by yourself,
+ * derive from this, and overload \c writeOut.
+ * Expect \a formated_r to be a formated log line without trailing \c NL.
+ * Ready to be written to the log.
+ */
+ struct LineWriter
+ {
+ virtual void writeOut( const std::string & /*formated_r*/ )
+ {}
+ virtual ~LineWriter()
+ {}
+ };
+
+ /** Base class for ostream based \ref LineWriter */
+ struct StreamLineWriter : public LineWriter
+ {
+ StreamLineWriter( std::ostream & str_r ) : _str( &str_r ) {}
+
+ virtual void writeOut( const std::string & formated_r )
+ { (*_str) << formated_r << std::endl; }
+
+ protected:
+ StreamLineWriter() : _str( 0 ) {}
+ std::ostream *_str;
+ };
+
+ /** \ref LineWriter to stdout. */
+ struct StdoutLineWriter : public StreamLineWriter
{
- class LogControlImpl;
- }
+ StdoutLineWriter();
+ };
+
+ /** \ref LineWriter to stderr. */
+ struct StderrLineWriter : public StreamLineWriter
+ {
+ StderrLineWriter();
+ };
+
+ /** \ref LineWriter to file.
+ * If \c mode_r is not \c 0, \c file_r persissions are changed
+ * accordingly. \c "-" logs to \c cerr.
+ */
+ struct 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
//
/** Maintain logfile related options.
- * Singleton
+ * \note A Singleton using a Singleton implementation class,
+ * that's why there is no _pimpl like in other classes.
*/
class LogControl
{
friend std::ostream & operator<<( std::ostream & str, const LogControl & obj );
- typedef logger::LogControlImpl Impl;
public:
/** Singleton access. */
- static LogControl instance();
- /** Dtor */
- ~LogControl();
+ static LogControl instance()
+ { return LogControl(); }
+
+
+ /** \see \ref log::LineWriter */
+ typedef log::LineWriter LineWriter;
+
+ /** If you want to format loglines by yourself,
+ * derive from this, and overload \c format.
+ * Return a formated logline without trailing \c NL.
+ * Ready to be written to the log.
+ */
+ struct 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() {}
+ };
public:
- /** Return path to the logfile.
- * An emty pathname for std::err.
+ /** Assign a LineFormater.
+ * If you want to format loglines by yourself. NULL installs the
+ * default formater.
*/
- const Pathname & logfile() const;
+ void setLineFormater( const shared_ptr<LineFormater> & formater_r );
+ public:
/** Set path for the logfile.
- * An emty pathname for std::err.
+ * Permission for logfiles is set to 0640 unless an explicit mode_t
+ * value is given. An empty pathname turns off logging. <tt>"-"</tt>
+ * logs to std::err.
* \throw if \a logfile_r is not usable.
*/
void logfile( const Pathname & logfile_r );
+ void logfile( const Pathname & logfile_r, mode_t mode_r );
+
+ /** Turn off logging. */
+ void logNothing();
+
+ /** Log to std::err. */
+ void logToStdErr();
+
+ public:
+ /** Get the current LineWriter */
+ shared_ptr<LineWriter> getLineWriter() const;
+
+ /** Assign a LineWriter.
+ * If you want to log the (formated) loglines by yourself.
+ * NULL turns off logging (same as logNothing)
+ * \see \ref log::LineWriter
+ */
+ void setLineWriter( const shared_ptr<LineWriter> & writer_r );
public:
/** Turn on excessive logging for the lifetime of this object.*/
~TmpExcessive();
};
+ /** Exchange LineWriter for the lifetime of this object.
+ * \see \ref log::LineWriter
+ */
+ struct TmpLineWriter
+ {
+ TmpLineWriter( const shared_ptr<LineWriter> & writer_r = shared_ptr<LineWriter>() )
+ : _writer( LogControl::instance().getLineWriter() )
+ { LogControl::instance().setLineWriter( writer_r ); }
+
+ /** Convenience ctor taking over ownership of an allocated LineWriter.
+ *\code
+ * TmpLineWriter mylw( new log::StderrLineWriter );
+ * \endcode
+ */
+ 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:
- /** Default ctor: Singleton*/
- LogControl();
- /** Pointer to implementation */
- RW_pointer<Impl> _pimpl;
+ /** Default ctor: Singleton */
+ LogControl()
+ {}
};
///////////////////////////////////////////////////////////////////
projects / platform / upstream / libzypp.git / blobdiff