aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/ConsoleChannel.h
blob: d89cd737539ebaaca3eb001bd4c8ddbc8a1ea433 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// 
// ConsoleChannel.h 
// 
// Library: Foundation 
// Package: Logging 
// Module:  ConsoleChannel 
// 
// Definition of the ConsoleChannel class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_ConsoleChannel_INCLUDED 
#define Foundation_ConsoleChannel_INCLUDED 
 
 
#include "Poco/Foundation.h" 
#include "Poco/Channel.h" 
#include "Poco/Mutex.h" 
#include <ostream> 
 
 
namespace Poco { 
 
 
class Foundation_API ConsoleChannel: public Channel 
	/// A channel that writes to an ostream. 
	/// 
	/// Only the message's text is written, followed 
	/// by a newline. 
	/// 
	/// Chain this channel to a FormattingChannel with an 
	/// appropriate Formatter to control what is contained  
	/// in the text. 
	/// 
	/// Similar to StreamChannel, except that a static 
	/// mutex is used to protect against multiple 
	/// console channels concurrently writing to the 
	/// same stream. 
{ 
public: 
	ConsoleChannel(); 
		/// Creates the channel and attaches std::clog. 
		 
	ConsoleChannel(std::ostream& str); 
		/// Creates the channel using the given stream. 
 
	void log(const Message& msg); 
		/// Logs the given message to the channel's stream. 
		 
protected: 
	~ConsoleChannel(); 
 
private: 
	std::ostream& _str; 
	static FastMutex _mutex; 
}; 
 
 
class Foundation_API ColorConsoleChannel: public Channel 
	/// A channel that writes to an ostream. 
	/// 
	/// Only the message's text is written, followed 
	/// by a newline. 
	/// 
	/// Messages can be colored depending on priority. 
	/// The console device must support ANSI escape codes 
	/// in order to display colored messages. 
	/// 
	/// To enable message coloring, set the "enableColors" 
	/// property to true (default). Furthermore, colors can be 
	/// configured by setting the following properties 
	/// (default values are given in parenthesis): 
	///  
	///   * traceColor (gray) 
	///   * debugColor (gray) 
	///   * informationColor (default) 
	///   * noticeColor (default) 
	///   * warningColor (yellow) 
	///   * errorColor (lightRed) 
	///   * criticalColor (lightRed) 
	///   * fatalColor (lightRed) 
	/// 
	/// The following color values are supported: 
	///  
	///   * default 
	///   * black 
	///   * red 
	///   * green 
	///   * brown 
	///   * blue 
	///   * magenta 
	///   * cyan 
	///   * gray 
	///   * darkgray 
	///   * lightRed 
	///   * lightGreen 
	///   * yellow 
	///   * lightBlue 
	///   * lightMagenta 
	///   * lightCyan 
	///   * white 
	/// 
	/// Chain this channel to a FormattingChannel with an 
	/// appropriate Formatter to control what is contained  
	/// in the text. 
	/// 
	/// Similar to StreamChannel, except that a static 
	/// mutex is used to protect against multiple 
	/// console channels concurrently writing to the 
	/// same stream. 
{ 
public:	 
	ColorConsoleChannel(); 
		/// Creates the channel and attaches std::clog. 
		 
	ColorConsoleChannel(std::ostream& str); 
		/// Creates the channel using the given stream. 
 
	void log(const Message& msg); 
		/// Logs the given message to the channel's stream. 
	 
	void setProperty(const std::string& name, const std::string& value); 
		/// Sets the property with the given name.  
		///  
		/// The following properties are supported: 
		///   * enableColors:      Enable or disable colors. 
		///   * traceColor:        Specify color for trace messages. 
		///   * debugColor:        Specify color for debug messages. 
		///   * informationColor:  Specify color for information messages. 
		///   * noticeColor:       Specify color for notice messages. 
		///   * warningColor:      Specify color for warning messages. 
		///   * errorColor:        Specify color for error messages. 
		///   * criticalColor:     Specify color for critical messages. 
		///   * fatalColor:        Specify color for fatal messages. 
		/// 
		/// See the class documentation for a list of supported color values. 
 
	std::string getProperty(const std::string& name) const; 
		/// Returns the value of the property with the given name. 
		/// See setProperty() for a description of the supported 
		/// properties. 
 
protected:	 
	enum Color 
	{ 
		CC_DEFAULT      = 0x0027, 
		CC_BLACK        = 0x001e, 
		CC_RED          = 0x001f, 
		CC_GREEN        = 0x0020, 
		CC_BROWN        = 0x0021, 
		CC_BLUE         = 0x0022, 
		CC_MAGENTA      = 0x0023, 
		CC_CYAN         = 0x0024, 
		CC_GRAY         = 0x0025, 
		CC_DARKGRAY     = 0x011e, 
		CC_LIGHTRED     = 0x011f, 
		CC_LIGHTGREEN   = 0x0120, 
		CC_YELLOW       = 0x0121, 
		CC_LIGHTBLUE    = 0x0122, 
		CC_LIGHTMAGENTA = 0x0123, 
		CC_LIGHTCYAN    = 0x0124, 
		CC_WHITE        = 0x0125 
	}; 
 
	~ColorConsoleChannel(); 
	Color parseColor(const std::string& color) const; 
	std::string formatColor(Color color) const; 
	void initColors(); 
 
private: 
	std::ostream& _str; 
	bool _enableColors; 
	Color _colors[9]; 
	static FastMutex _mutex; 
	static const std::string CSI; 
}; 
 
 
} // namespace Poco 
 
 
#endif // Foundation_ConsoleChannel_INCLUDED