-
Notifications
You must be signed in to change notification settings - Fork 106
/
record_ostream.hpp
585 lines (512 loc) · 18.7 KB
/
record_ostream.hpp
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/*
* Copyright Andrey Semashev 2007 - 2015.
* Distributed under the Boost Software License, Version 1.0.
* (See accompanying file LICENSE_1_0.txt or copy at
* http://www.boost.org/LICENSE_1_0.txt)
*/
/*!
* \file record_ostream.hpp
* \author Andrey Semashev
* \date 09.03.2009
*
* This header contains a wrapper class around a logging record that allows to compose the
* record message with a streaming expression.
*/
#ifndef BOOST_LOG_SOURCES_RECORD_OSTREAM_HPP_INCLUDED_
#define BOOST_LOG_SOURCES_RECORD_OSTREAM_HPP_INCLUDED_
#include <string>
#include <iosfwd>
#include <ostream>
#include <boost/assert.hpp>
#include <boost/move/core.hpp>
#include <boost/move/utility_core.hpp>
#include <boost/type_traits/is_enum.hpp>
#include <boost/type_traits/is_scalar.hpp>
#include <boost/type_traits/remove_cv.hpp>
#include <boost/core/addressof.hpp>
#include <boost/core/enable_if.hpp>
#include <boost/core/explicit_operator_bool.hpp>
#include <boost/core/uncaught_exceptions.hpp>
#include <boost/log/detail/config.hpp>
#include <boost/log/detail/native_typeof.hpp>
#include <boost/log/core/record.hpp>
#include <boost/log/utility/unique_identifier_name.hpp>
#include <boost/log/utility/formatting_ostream.hpp>
#include <boost/log/detail/header.hpp>
#ifdef BOOST_HAS_PRAGMA_ONCE
#pragma once
#endif
namespace boost {
BOOST_LOG_OPEN_NAMESPACE
template< typename CharT >
class basic_record_ostream;
namespace aux {
template< typename StreamT, typename T, bool ByValueV, typename R >
struct enable_record_ostream_generic_operator {};
template< typename CharT, typename T, typename R >
struct enable_record_ostream_generic_operator< basic_record_ostream< CharT >, T, false, R > :
public boost::disable_if_c< boost::is_scalar< typename boost::remove_cv< T >::type >::value, R >
{
};
template< typename CharT, typename T, typename R >
struct enable_record_ostream_generic_operator< basic_record_ostream< CharT >, T, true, R > :
public boost::enable_if_c< boost::is_enum< typename boost::remove_cv< T >::type >::value, R >
{
};
template< typename CharT, typename T, typename R >
struct enable_record_ostream_generic_operator< basic_record_ostream< CharT >, T*, true, R > :
public disable_if_streamable_char_type< typename boost::remove_cv< T >::type, R >
{
};
} // namespace aux
/*!
* \brief Logging record adapter with a streaming capability
*
* This class allows to compose the logging record message by streaming operations. It
* aggregates the log record and provides the standard output stream interface.
*/
template< typename CharT >
class basic_record_ostream :
public basic_formatting_ostream< CharT >
{
//! Self type
typedef basic_record_ostream< CharT > this_type;
//! Base stream class
typedef basic_formatting_ostream< CharT > base_type;
public:
//! Character type
typedef CharT char_type;
//! String type to be used as a message text holder
typedef std::basic_string< char_type > string_type;
//! Stream type
typedef std::basic_ostream< char_type > stream_type;
//! Character traits
typedef typename base_type::traits_type traits_type;
private:
//! Log record
record* m_record;
public:
/*!
* Default constructor. Creates an empty record that is equivalent to the invalid record handle.
* The stream capability is not available after construction.
*
* \post <tt>!*this == true</tt>
*/
basic_record_ostream() BOOST_NOEXCEPT : m_record(NULL) {}
/*!
* Constructor from a record object. Attaches to the provided record.
*
* \pre <tt>!!rec == true</tt>
* \post <tt>&this->get_record() == &rec</tt>
* \param rec The record handle being attached to
*/
explicit basic_record_ostream(record& rec)
{
BOOST_ASSERT_MSG(!!rec, "Boost.Log: basic_record_ostream should only be attached to a valid record");
m_record = &rec;
init_stream();
}
/*!
* Destructor. Destroys the record, releases any sinks and attribute values that were involved in processing this record.
*/
~basic_record_ostream() BOOST_NOEXCEPT
{
detach_from_record();
}
/*!
* Conversion to an unspecified boolean type
*
* \return \c true, if stream is valid and ready for formatting, \c false, if the stream is not valid. The latter also applies to
* the case when the stream is not attached to a log record.
*/
BOOST_EXPLICIT_OPERATOR_BOOL_NOEXCEPT()
/*!
* Inverted conversion to an unspecified boolean type
*
* \return \c false, if stream is valid and ready for formatting, \c true, if the stream is not valid. The latter also applies to
* the case when the stream is not attached to a log record.
*/
bool operator! () const BOOST_NOEXCEPT
{
return (!m_record || base_type::fail());
}
/*!
* Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record
*
* \return The aggregated record object
*/
record& get_record()
{
BOOST_ASSERT(m_record != NULL);
this->flush();
return *m_record;
}
/*!
* Flushes internal buffers to complete all pending formatting operations and returns the aggregated log record
*
* \return The aggregated record object
*/
record const& get_record() const
{
BOOST_ASSERT(m_record != NULL);
const_cast< this_type* >(this)->flush();
return *m_record;
}
/*!
* If the stream is attached to a log record, flushes internal buffers to complete all pending formatting operations.
* Then reattaches the stream to another log record.
*
* \param rec New log record to attach to
*/
void attach_record(record& rec)
{
BOOST_ASSERT_MSG(!!rec, "Boost.Log: basic_record_ostream should only be attached to a valid record");
detach_from_record();
m_record = &rec;
init_stream();
}
//! The function resets the stream into a detached (default initialized) state
BOOST_LOG_API void detach_from_record() BOOST_NOEXCEPT;
basic_record_ostream& operator<< (typename base_type::ios_base_manip manip)
{
static_cast< base_type& >(*this) << manip;
return *this;
}
basic_record_ostream& operator<< (typename base_type::basic_ios_manip manip)
{
static_cast< base_type& >(*this) << manip;
return *this;
}
basic_record_ostream& operator<< (typename base_type::stream_manip manip)
{
static_cast< base_type& >(*this) << manip;
return *this;
}
basic_record_ostream& operator<< (char c)
{
static_cast< base_type& >(*this) << c;
return *this;
}
basic_record_ostream& operator<< (const char* p)
{
static_cast< base_type& >(*this) << p;
return *this;
}
// When no native character type is supported, the following overloads are disabled as they have ambiguous meaning.
// Use basic_string_view or basic_string to explicitly indicate that the data is a string.
#if !defined(BOOST_NO_INTRINSIC_WCHAR_T)
basic_record_ostream& operator<< (wchar_t c)
{
static_cast< base_type& >(*this) << c;
return *this;
}
basic_record_ostream& operator<< (const wchar_t* p)
{
static_cast< base_type& >(*this) << p;
return *this;
}
#endif
#if !defined(BOOST_LOG_NO_CXX11_CODECVT_FACETS)
#if !defined(BOOST_NO_CXX11_CHAR16_T)
basic_record_ostream& operator<< (char16_t c)
{
static_cast< base_type& >(*this) << c;
return *this;
}
basic_record_ostream& operator<< (const char16_t* p)
{
static_cast< base_type& >(*this) << p;
return *this;
}
#endif
#if !defined(BOOST_NO_CXX11_CHAR32_T)
basic_record_ostream& operator<< (char32_t c)
{
static_cast< base_type& >(*this) << c;
return *this;
}
basic_record_ostream& operator<< (const char32_t* p)
{
static_cast< base_type& >(*this) << p;
return *this;
}
#endif
#endif
basic_record_ostream& operator<< (bool value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (signed char value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (unsigned char value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (short value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (unsigned short value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (int value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (unsigned int value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (long value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (unsigned long value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
#if !defined(BOOST_NO_LONG_LONG)
basic_record_ostream& operator<< (long long value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (unsigned long long value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
#endif
basic_record_ostream& operator<< (float value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (double value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (long double value)
{
static_cast< base_type& >(*this) << value;
return *this;
}
basic_record_ostream& operator<< (std::basic_streambuf< char_type, traits_type >* buf)
{
static_cast< base_type& >(*this) << buf;
return *this;
}
private:
//! The function initializes the stream and the stream buffer
BOOST_LOG_API void init_stream();
// Copy and assignment are closed
BOOST_DELETED_FUNCTION(basic_record_ostream(basic_record_ostream const&))
BOOST_DELETED_FUNCTION(basic_record_ostream& operator= (basic_record_ostream const&))
};
#ifdef BOOST_LOG_USE_CHAR
typedef basic_record_ostream< char > record_ostream; //!< Convenience typedef for narrow-character logging
#endif
#ifdef BOOST_LOG_USE_WCHAR_T
typedef basic_record_ostream< wchar_t > wrecord_ostream; //!< Convenience typedef for wide-character logging
#endif
// Implementation note: these operators below should be the least attractive for the compiler
// so that user's overloads are chosen, when present. We use function template partial ordering for this purpose.
// We also don't use perfect forwarding for the right hand argument because in ths case the generic overload
// would be more preferred than the typical one written by users:
//
// record_ostream& operator<< (record_ostream& strm, my_type const& arg);
//
// This is because my_type rvalues require adding const to the type, which counts as a conversion that is not required
// if there is a perfect forwarding overload.
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, true, StreamT& >::type
operator<< (StreamT& strm, T value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, false, StreamT& >::type
operator<< (StreamT& strm, T const& value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, false, StreamT& >::type
operator<< (StreamT& strm, T& value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
#if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, true, StreamT& >::type
operator<< (StreamT&& strm, T value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, false, StreamT& >::type
operator<< (StreamT&& strm, T const& value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
template< typename StreamT, typename T >
inline typename boost::log::aux::enable_record_ostream_generic_operator< StreamT, T, false, StreamT& >::type
operator<< (StreamT&& strm, T& value)
{
typedef basic_formatting_ostream< typename StreamT::char_type > formatting_ostream_type;
static_cast< formatting_ostream_type& >(strm) << value;
return strm;
}
#endif // !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
namespace aux {
//! Internal class that provides formatting streams for record pumps
template< typename CharT >
struct stream_provider
{
//! Character type
typedef CharT char_type;
//! Formatting stream compound
struct stream_compound
{
stream_compound* next;
//! Log record stream adapter
basic_record_ostream< char_type > stream;
//! Initializing constructor
explicit stream_compound(record& rec) : next(NULL), stream(rec) {}
};
//! The method returns an allocated stream compound
BOOST_LOG_API static stream_compound* allocate_compound(record& rec);
//! The method releases a compound
BOOST_LOG_API static void release_compound(stream_compound* compound) BOOST_NOEXCEPT;
// Non-constructible, non-copyable, non-assignable
BOOST_DELETED_FUNCTION(stream_provider())
BOOST_DELETED_FUNCTION(stream_provider(stream_provider const&))
BOOST_DELETED_FUNCTION(stream_provider& operator= (stream_provider const&))
};
/*!
* \brief Logging record pump implementation
*
* The pump is used to format the logging record message text and then
* push it to the logging core. It is constructed on each attempt to write
* a log record and destroyed afterwards.
*
* The pump class template is instantiated on the logger type.
*/
template< typename LoggerT >
class record_pump
{
BOOST_MOVABLE_BUT_NOT_COPYABLE(record_pump)
private:
//! Logger type
typedef LoggerT logger_type;
//! Character type
typedef typename logger_type::char_type char_type;
//! Stream compound provider
typedef stream_provider< char_type > stream_provider_type;
//! Stream compound type
typedef typename stream_provider_type::stream_compound stream_compound;
//! Stream compound release guard
class auto_release;
friend class auto_release;
class auto_release
{
stream_compound* m_pCompound;
public:
explicit auto_release(stream_compound* p) BOOST_NOEXCEPT : m_pCompound(p) {}
~auto_release() BOOST_NOEXCEPT { stream_provider_type::release_compound(m_pCompound); }
};
protected:
//! A reference to the logger
logger_type* m_pLogger;
//! Stream compound
stream_compound* m_pStreamCompound;
//! Exception state
const unsigned int m_ExceptionCount;
public:
//! Constructor
explicit record_pump(logger_type& lg, record& rec) :
m_pLogger(boost::addressof(lg)),
m_pStreamCompound(stream_provider_type::allocate_compound(rec)),
m_ExceptionCount(boost::core::uncaught_exceptions())
{
}
//! Move constructor
record_pump(BOOST_RV_REF(record_pump) that) BOOST_NOEXCEPT :
m_pLogger(that.m_pLogger),
m_pStreamCompound(that.m_pStreamCompound),
m_ExceptionCount(that.m_ExceptionCount)
{
that.m_pLogger = 0;
that.m_pStreamCompound = 0;
}
//! Destructor. Pushes the composed message to log.
~record_pump() BOOST_NOEXCEPT_IF(false)
{
if (m_pLogger)
{
auto_release cleanup(m_pStreamCompound); // destructor doesn't throw
// Only push the record if no exception has been thrown in the streaming expression (if possible)
if (m_ExceptionCount >= boost::core::uncaught_exceptions())
m_pLogger->push_record(boost::move(m_pStreamCompound->stream.get_record()));
}
}
//! Returns the stream to be used for message text formatting
basic_record_ostream< char_type >& stream() const BOOST_NOEXCEPT
{
BOOST_ASSERT(m_pStreamCompound != 0);
return m_pStreamCompound->stream;
}
};
template< typename LoggerT >
BOOST_FORCEINLINE record_pump< LoggerT > make_record_pump(LoggerT& lg, record& rec)
{
return record_pump< LoggerT >(lg, rec);
}
} // namespace aux
#ifndef BOOST_LOG_DOXYGEN_PASS
#define BOOST_LOG_STREAM_INTERNAL(logger, rec_var)\
for (::boost::log::record rec_var = (logger).open_record(); !!rec_var;)\
::boost::log::aux::make_record_pump((logger), rec_var).stream()
#define BOOST_LOG_STREAM_WITH_PARAMS_INTERNAL(logger, rec_var, params_seq)\
for (::boost::log::record rec_var = (logger).open_record((BOOST_PP_SEQ_ENUM(params_seq))); !!rec_var;)\
::boost::log::aux::make_record_pump((logger), rec_var).stream()
#endif // BOOST_LOG_DOXYGEN_PASS
//! The macro writes a record to the log
#define BOOST_LOG_STREAM(logger)\
BOOST_LOG_STREAM_INTERNAL(logger, BOOST_LOG_UNIQUE_IDENTIFIER_NAME(_boost_log_record_))
//! The macro writes a record to the log and allows to pass additional named arguments to the logger
#define BOOST_LOG_STREAM_WITH_PARAMS(logger, params_seq)\
BOOST_LOG_STREAM_WITH_PARAMS_INTERNAL(logger, BOOST_LOG_UNIQUE_IDENTIFIER_NAME(_boost_log_record_), params_seq)
#ifndef BOOST_LOG_NO_SHORTHAND_NAMES
//! An equivalent to BOOST_LOG_STREAM(logger)
#define BOOST_LOG(logger) BOOST_LOG_STREAM(logger)
//! An equivalent to BOOST_LOG_STREAM_WITH_PARAMS(logger, params_seq)
#define BOOST_LOG_WITH_PARAMS(logger, params_seq) BOOST_LOG_STREAM_WITH_PARAMS(logger, params_seq)
#endif // BOOST_LOG_NO_SHORTHAND_NAMES
BOOST_LOG_CLOSE_NAMESPACE // namespace log
} // namespace boost
#include <boost/log/detail/footer.hpp>
#endif // BOOST_LOG_SOURCES_RECORD_OSTREAM_HPP_INCLUDED_