libzypp: zypp-core/base/LogControl.h Source File

libzypp 17.36.6

LogControl.h
Go to the documentation of this file.
1/*---------------------------------------------------------------------\
2| ____ _ __ __ ___ |
3| |__ / \ / / . \ . \ |
4| / / \ V /| _/ _/ |
5| / /__ | | | | | | |
6| /_____||_| |_| |_| |
7| |
8\---------------------------------------------------------------------*/
12#ifndef ZYPP_BASE_LOGCONTROL_H
13#define ZYPP_BASE_LOGCONTROL_H
14
15#include <iosfwd>
16#include <ostream> //for std::endl
17
18#include <zypp-core/base/Logger.h>
19#include <zypp-core/base/PtrTypes.h>
20#include <zypp-core/Pathname.h>
21
23namespace zypp
24{
25
27 namespace log
28 {
29
35 struct ZYPP_API LineWriter
36 {
37 virtual void writeOut( const std::string & /*formated_r*/ )
38 {}
39 virtual ~LineWriter()
40 {}
41 };
42
44 struct StreamLineWriter : public LineWriter
45 {
46 StreamLineWriter( std::ostream & str_r ) : _str( &str_r ) {}
47
48 void writeOut( const std::string & formated_r ) override
49 { (*_str) << formated_r << std::endl; }
50
51 protected:
52 StreamLineWriter() : _str( 0 ) {}
53 std::ostream *_str;
54 };
55
57 struct StdoutLineWriter : public StreamLineWriter
58 {
59 StdoutLineWriter();
60 };
61
63 struct StderrLineWriter : public StreamLineWriter
64 {
65 StderrLineWriter();
66 };
67
72 struct ZYPP_API FileLineWriter : public StreamLineWriter
73 {
74 FileLineWriter( const Pathname & file_r, mode_t mode_r = 0 );
75 protected:
76 shared_ptr<void> _outs;
77 };
78
80 } // namespace log
82
83
85 namespace base
86 {
87
89 //
90 // CLASS NAME : LogControl
91 //
96 class ZYPP_API LogControl
97 {
98 friend std::ostream & operator<<( std::ostream & str, const LogControl & obj );
99
100 public:
102 static LogControl instance()
103 { return LogControl(); }
104
105
107 using LineWriter = log::LineWriter;
108
114 struct ZYPP_API LineFormater
115 {
116 virtual std::string format( const std::string & /*group_r*/,
117 logger::LogLevel /*level_r*/,
118 const char * /*file_r*/,
119 const char * /*func_r*/,
120 int /*line_r*/,
121 const std::string & /*message_r*/ );
122 virtual ~LineFormater() {}
123 };
124
125 public:
130 void setLineFormater( const shared_ptr<LineFormater> & formater_r );
131
137 void enableLogForwardingMode ( bool enable = true );
138
139 public:
146 void logfile( const Pathname & logfile_r );
147 void logfile( const Pathname & logfile_r, mode_t mode_r );
148
150 void logNothing();
151
153 void logToStdErr();
154
156 void emergencyShutdown();
157
163 static void notifyFork();
164
166 void logRawLine ( std::string &&line );
167
168 public:
170 shared_ptr<LineWriter> getLineWriter() const;
171
177 void setLineWriter( const shared_ptr<LineWriter> & writer_r );
178
179 public:
181 struct TmpExcessive
182 {
183 TmpExcessive();
184 ~TmpExcessive();
185 };
186
190 struct ZYPP_API TmpLineWriter
191 {
192 TmpLineWriter( const shared_ptr<LineWriter> & writer_r = shared_ptr<LineWriter>() )
193 : _writer( LogControl::instance().getLineWriter() )
194 { LogControl::instance().setLineWriter( writer_r ); }
195
201 template<class TLineWriter>
202 TmpLineWriter( TLineWriter * _allocated_r )
203 : _writer( LogControl::instance().getLineWriter() )
204 { LogControl::instance().setLineWriter( shared_ptr<LineWriter>( _allocated_r ) ); }
205
206 ~TmpLineWriter()
207 { LogControl::instance().setLineWriter( _writer ); }
208
209 private:
210 shared_ptr<LineWriter> _writer;
211 };
212
213 private:
215 LogControl()
216 {}
217 };
218
219
221 std::ostream & operator<<( std::ostream & str, const LogControl & obj ) ZYPP_API;
222
224 } // namespace base
227} // namespace zypp
229#endif // ZYPP_BASE_LOGCONTROL_H
operator<<
std::ostream & operator<<(std::ostream &str, const zypp::sat::detail::CDataiterator *obj)
Definition LookupAttr.cc:808
shared_ptr
zypp::base::LogControl::LogControl
LogControl()
Default ctor: Singleton.
Definition LogControl.h:215
zypp::base::LogControl::getLineWriter
shared_ptr< LineWriter > getLineWriter() const
Get the current LineWriter.
Definition LogControl.cc:880
zypp::base::LogControl::LineWriter
log::LineWriter LineWriter
Definition LogControl.h:107
zypp::base::LogControl::instance
static LogControl instance()
Singleton access.
Definition LogControl.h:102
zypp::filesystem::Pathname
Pathname.
Definition Pathname.h:47
str
String related utilities and Regular expression matching.
zypp::base::logger::LogLevel
LogLevel
Definition of log levels.
Definition Logger.h:156
zypp::base
Definition Random.cc:7
zypp::base::operator<<
std::ostream & operator<<(std::ostream &str, const Flags< TEnum > &obj)
Definition Flags.h:166
zypp::log
Definition LogControl.cc:362
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition Application.cc:20
zypp::ZYPP_API
const Arch Arch_armv7hnl Arch_armv7nhl ZYPP_API
Definition Arch.h:247
zypp::base::LogControl::LineFormater
If you want to format loglines by yourself, derive from this, and overload format.
Definition LogControl.h:115
zypp::base::LogControl::LineFormater::~LineFormater
virtual ~LineFormater()
Definition LogControl.h:122
zypp::base::LogControl::LineFormater::format
virtual std::string format(const std::string &, logger::LogLevel, const char *, const char *, int, const std::string &)
Definition LogControl.cc:821
zypp::base::LogControl::TmpExcessive::TmpExcessive
TmpExcessive()
Definition LogControl.cc:946
zypp::base::LogControl::TmpLineWriter::TmpLineWriter
TmpLineWriter(const shared_ptr< LineWriter > &writer_r=shared_ptr< LineWriter >())
Definition LogControl.h:192
zypp::base::LogControl::TmpLineWriter::_writer
shared_ptr< LineWriter > _writer
Definition LogControl.h:210
zypp::base::LogControl::TmpLineWriter::~TmpLineWriter
~TmpLineWriter()
Definition LogControl.h:206
zypp::base::LogControl::TmpLineWriter::TmpLineWriter
TmpLineWriter(TLineWriter *_allocated_r)
Convenience ctor taking over ownership of an allocated LineWriter.
Definition LogControl.h:202
zypp::log::FileLineWriter::_outs
shared_ptr< void > _outs
Definition LogControl.h:76
zypp::log::FileLineWriter::FileLineWriter
FileLineWriter(const Pathname &file_r, mode_t mode_r=0)
Definition LogControl.cc:372
zypp::log::LineWriter
If you want to log the (formated) loglines by yourself, derive from this, and overload writeOut.
Definition LogControl.h:36
zypp::log::LineWriter::writeOut
virtual void writeOut(const std::string &)
Definition LogControl.h:37
zypp::log::LineWriter::~LineWriter
virtual ~LineWriter()
Definition LogControl.h:39
zypp::log::StderrLineWriter::StderrLineWriter
StderrLineWriter()
Definition LogControl.cc:368
zypp::log::StdoutLineWriter::StdoutLineWriter
StdoutLineWriter()
Definition LogControl.cc:364
zypp::log::StreamLineWriter::StreamLineWriter
StreamLineWriter()
Definition LogControl.h:52
zypp::log::StreamLineWriter::_str
std::ostream * _str
Definition LogControl.h:53
zypp::log::StreamLineWriter::StreamLineWriter
StreamLineWriter(std::ostream &str_r)
Definition LogControl.h:46
zypp::log::StreamLineWriter::writeOut
void writeOut(const std::string &formated_r) override
Definition LogControl.h:48
Pathname.h
Logger.h
PtrTypes.h