log/utility/string_literal_fwd.hpp

0001 /*
0002  *          Copyright Andrey Semashev 2007 - 2015.
0003  * Distributed under the Boost Software License, Version 1.0.
0004  *    (See accompanying file LICENSE_1_0.txt or copy at
0005  *          http://www.boost.org/LICENSE_1_0.txt)
0006  */
0007 /*!
0008  * \file   string_literal_fwd.hpp
0009  * \author Andrey Semashev
0010  * \date   24.06.2007
0011  *
0012  * The header contains forward declaration of a constant string literal wrapper.
0013  */
0014
0015 #ifndef BOOST_LOG_UTILITY_STRING_LITERAL_FWD_HPP_INCLUDED_
0016 #define BOOST_LOG_UTILITY_STRING_LITERAL_FWD_HPP_INCLUDED_
0017
0018 #include <string>
0019 #include <boost/log/detail/config.hpp>
0020
0021 #ifdef BOOST_HAS_PRAGMA_ONCE
0022 #pragma once
0023 #endif
0024
0025 namespace boost {
0026
0027 BOOST_LOG_OPEN_NAMESPACE
0028
0029 /*!
0030  * \brief String literal wrapper
0031  *
0032  * The \c basic_string_literal is a thin wrapper around a constant string literal.
0033  * It provides interface similar to STL strings, but because of read-only nature
0034  * of string literals, lacks ability to modify string contents. However,
0035  * \c basic_string_literal objects can be assigned to and cleared.
0036  *
0037  * The main advantage of this class comparing to other string classes is that
0038  * it doesn't dynamically allocate memory and therefore is fast, thin and exception safe.
0039  */
0040 template< typename CharT, typename TraitsT = std::char_traits< CharT > >
0041 class basic_string_literal;
0042
0043 //  Convenience typedefs
0044 #ifdef BOOST_LOG_USE_CHAR
0045 typedef basic_string_literal< char > string_literal;        //!< String literal type for narrow characters
0046 #endif
0047 #ifdef BOOST_LOG_USE_WCHAR_T
0048 typedef basic_string_literal< wchar_t > wstring_literal;    //!< String literal type for wide characters
0049 #endif
0050
0051 BOOST_LOG_CLOSE_NAMESPACE // namespace log
0052
0053 } // namespace boost
0054
0055 #endif // BOOST_LOG_UTILITY_STRING_LITERAL_FWD_HPP_INCLUDED_