2 * Copyright Andrey Semashev 2007 - 2015.
3 * Distributed under the Boost Software License, Version 1.0.
4 * (See accompanying file LICENSE_1_0.txt or copy at
5 * http://www.boost.org/LICENSE_1_0.txt)
8 * \file text_multifile_backend.hpp
9 * \author Andrey Semashev
12 * The header contains implementation of a text multi-file sink backend.
15 #ifndef BOOST_LOG_SINKS_TEXT_MULTIFILE_BACKEND_HPP_INCLUDED_
16 #define BOOST_LOG_SINKS_TEXT_MULTIFILE_BACKEND_HPP_INCLUDED_
22 #include <boost/mpl/if.hpp>
23 #include <boost/mpl/bool.hpp>
24 #include <boost/type_traits/is_same.hpp>
25 #include <boost/filesystem/path.hpp>
26 #include <boost/log/detail/config.hpp>
27 #include <boost/log/detail/light_function.hpp>
28 #include <boost/log/detail/cleanup_scope_guard.hpp>
29 #include <boost/log/sinks/basic_sink_backend.hpp>
30 #include <boost/log/utility/formatting_ostream.hpp>
31 #include <boost/log/detail/header.hpp>
33 #ifdef BOOST_HAS_PRAGMA_ONCE
39 BOOST_LOG_OPEN_NAMESPACE
46 * An adapter class that allows to use regular formatters as file name generators.
48 template< typename FormatterT >
49 class file_name_composer_adapter
52 //! Functor result type
53 typedef filesystem::path result_type;
54 //! File name character type
55 typedef result_type::string_type::value_type native_char_type;
56 //! The adopted formatter type
57 typedef FormatterT formatter_type;
58 //! Formatting stream type
59 typedef basic_formatting_ostream< native_char_type > stream_type;
62 //! The adopted formatter
63 formatter_type m_Formatter;
64 //! Formatted file name storage
65 mutable result_type::string_type m_FileName;
67 mutable stream_type m_FormattingStream;
71 * Initializing constructor
73 explicit file_name_composer_adapter(formatter_type const& formatter, std::locale const& loc = std::locale()) :
74 m_Formatter(formatter),
75 m_FormattingStream(m_FileName)
77 m_FormattingStream.exceptions(std::ios_base::badbit | std::ios_base::failbit);
78 m_FormattingStream.imbue(loc);
83 file_name_composer_adapter(file_name_composer_adapter const& that) :
84 m_Formatter(that.m_Formatter),
85 m_FormattingStream(m_FileName)
87 m_FormattingStream.exceptions(std::ios_base::badbit | std::ios_base::failbit);
88 m_FormattingStream.imbue(that.m_FormattingStream.getloc());
93 file_name_composer_adapter& operator= (file_name_composer_adapter const& that)
95 m_Formatter = that.m_Formatter;
100 * The operator generates a file name based on the log record
102 result_type operator() (record_view const& rec) const
104 boost::log::aux::cleanup_guard< stream_type > cleanup1(m_FormattingStream);
105 boost::log::aux::cleanup_guard< result_type::string_type > cleanup2(m_FileName);
107 m_Formatter(rec, m_FormattingStream);
108 m_FormattingStream.flush();
110 return result_type(m_FileName);
115 * The function adopts a log record formatter into a file name generator
117 * \param fmt The formatter function object to adopt
118 * \param loc The locale to use to character code conversion and formatting
120 template< typename FormatterT >
121 inline file_name_composer_adapter< FormatterT > as_file_name_composer(
122 FormatterT const& fmt, std::locale const& loc = std::locale())
124 return file_name_composer_adapter< FormatterT >(fmt, loc);
131 * \brief An implementation of a text multiple files logging sink backend
133 * The sink backend puts formatted log records to one of the text files.
134 * The particular file is chosen upon each record's attribute values, which allows
135 * to distribute records into individual files or to group records related to
136 * some entity or process in a separate file.
138 class text_multifile_backend :
139 public basic_formatted_sink_backend< char >
142 typedef basic_formatted_sink_backend< char > base_type;
146 typedef base_type::char_type char_type;
147 //! String type to be used as a message text holder
148 typedef base_type::string_type string_type;
150 //! File name composer functor type
151 typedef boost::log::aux::light_function< filesystem::path (record_view const&) > file_name_composer_type;
156 struct implementation;
157 implementation* m_pImpl;
163 * Default constructor. The constructed sink backend has no file name composer and
164 * thus will not write any files.
166 BOOST_LOG_API text_multifile_backend();
171 BOOST_LOG_API ~text_multifile_backend();
174 * The method sets file name composer functional object. Log record formatters are accepted, too.
176 * \param composer File name composer functor
178 template< typename ComposerT >
179 void set_file_name_composer(ComposerT const& composer)
181 set_file_name_composer_internal(composer);
185 * The method writes the message to the sink
187 BOOST_LOG_API void consume(record_view const& rec, string_type const& formatted_message);
190 #ifndef BOOST_LOG_DOXYGEN_PASS
191 //! The method sets the file name composer
192 BOOST_LOG_API void set_file_name_composer_internal(file_name_composer_type const& composer);
193 #endif // BOOST_LOG_DOXYGEN_PASS
198 BOOST_LOG_CLOSE_NAMESPACE // namespace log
202 #include <boost/log/detail/footer.hpp>
204 #endif // BOOST_LOG_SINKS_TEXT_MULTIFILE_BACKEND_HPP_INCLUDED_