Chris@16: //  Copyright (c) 2001-2011 Hartmut Kaiser
Chris@16: //  Copyright (c)      2010 Bryce Lelbach
Chris@16: //
Chris@16: //  Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16: //  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: #if !defined(BOOST_SPIRIT_KARMA_LIT_FEB_22_2007_0534PM)
Chris@16: #define BOOST_SPIRIT_KARMA_LIT_FEB_22_2007_0534PM
Chris@16: 
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma once
Chris@16: #endif
Chris@16: 
Chris@16: #include <boost/spirit/home/support/common_terminals.hpp>
Chris@16: #include <boost/spirit/home/support/string_traits.hpp>
Chris@16: #include <boost/spirit/home/support/info.hpp>
Chris@16: #include <boost/spirit/home/support/char_class.hpp>
Chris@16: #include <boost/spirit/home/support/container.hpp>
Chris@16: #include <boost/spirit/home/support/handles_container.hpp>
Chris@16: #include <boost/spirit/home/support/detail/get_encoding.hpp>
Chris@16: #include <boost/spirit/home/karma/domain.hpp>
Chris@16: #include <boost/spirit/home/karma/meta_compiler.hpp>
Chris@16: #include <boost/spirit/home/karma/delimit_out.hpp>
Chris@16: #include <boost/spirit/home/karma/auxiliary/lazy.hpp>
Chris@16: #include <boost/spirit/home/karma/detail/get_casetag.hpp>
Chris@16: #include <boost/spirit/home/karma/detail/extract_from.hpp>
Chris@16: #include <boost/spirit/home/karma/detail/string_generate.hpp>
Chris@16: #include <boost/spirit/home/karma/detail/string_compare.hpp>
Chris@16: #include <boost/spirit/home/karma/detail/enable_lit.hpp>
Chris@16: #include <boost/fusion/include/at.hpp>
Chris@16: #include <boost/fusion/include/vector.hpp>
Chris@16: #include <boost/fusion/include/cons.hpp>
Chris@16: #include <boost/mpl/if.hpp>
Chris@16: #include <boost/mpl/or.hpp>
Chris@16: #include <boost/mpl/assert.hpp>
Chris@16: #include <boost/mpl/bool.hpp>
Chris@16: #include <boost/utility/enable_if.hpp>
Chris@16: #include <string>
Chris@16: 
Chris@16: ///////////////////////////////////////////////////////////////////////////////
Chris@16: namespace boost { namespace spirit
Chris@16: {
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     // Enablers
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename CharEncoding>
Chris@16:     struct use_terminal<karma::domain
Chris@16:         , tag::char_code<tag::string, CharEncoding> >     // enables string
Chris@16:       : mpl::true_ {};
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct use_terminal<karma::domain, T
Chris@16:       , typename enable_if<traits::is_string<T> >::type>  // enables string literals
Chris@16:       : mpl::true_ {};
Chris@16: 
Chris@16:     template <typename CharEncoding, typename A0>
Chris@16:     struct use_terminal<karma::domain
Chris@16:       , terminal_ex<
Chris@16:             tag::char_code<tag::string, CharEncoding>     // enables string(str)
Chris@16:           , fusion::vector1<A0> >
Chris@16:     > : traits::is_string<A0> {};
Chris@16: 
Chris@16:     template <typename CharEncoding>                      // enables string(f)
Chris@16:     struct use_lazy_terminal<
Chris@16:         karma::domain
Chris@16:       , tag::char_code<tag::string, CharEncoding>
Chris@16:       , 1 /*arity*/
Chris@16:     > : mpl::true_ {};
Chris@16: 
Chris@16:     // enables lit(str)
Chris@16:     template <typename A0>
Chris@16:     struct use_terminal<karma::domain
Chris@16:           , terminal_ex<tag::lit, fusion::vector1<A0> >
Chris@16:           , typename enable_if<traits::is_string<A0> >::type>
Chris@16:       : mpl::true_ {};
Chris@16: }} 
Chris@16: 
Chris@16: ///////////////////////////////////////////////////////////////////////////////
Chris@16: namespace boost { namespace spirit { namespace karma
Chris@16: {
Chris@16: #ifndef BOOST_SPIRIT_NO_PREDEFINED_TERMINALS
Chris@16:     using spirit::lit;
Chris@16: #endif
Chris@16:     using spirit::lit_type;
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     // generate literal strings from a given parameter
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename CharEncoding, typename Tag>
Chris@16:     struct any_string
Chris@16:       : primitive_generator<any_string<CharEncoding, Tag> >
Chris@16:     {
Chris@16:         typedef typename CharEncoding::char_type char_type;
Chris@16:         typedef CharEncoding char_encoding;
Chris@16: 
Chris@16:         template <typename Context, typename Unused = unused_type>
Chris@16:         struct attribute
Chris@16:         {
Chris@16:             typedef std::basic_string<char_type> type;
Chris@16:         };
Chris@16: 
Chris@16:         // lit has an attached attribute
Chris@16:         template <typename OutputIterator, typename Context, typename Delimiter
Chris@16:           , typename Attribute>
Chris@16:         static bool
Chris@16:         generate(OutputIterator& sink, Context& context, Delimiter const& d, 
Chris@16:             Attribute const& attr)
Chris@16:         {
Chris@16:             if (!traits::has_optional_value(attr))
Chris@16:                 return false;
Chris@16: 
Chris@16:             typedef typename attribute<Context>::type attribute_type;
Chris@16:             return 
Chris@16:                 karma::detail::string_generate(sink
Chris@16:                   , traits::extract_from<attribute_type>(attr, context)
Chris@16:                   , char_encoding(), Tag()) &&
Chris@16:                 karma::delimit_out(sink, d);      // always do post-delimiting
Chris@16:         }
Chris@16: 
Chris@16:         // this lit has no attribute attached, it needs to have been
Chris@16:         // initialized from a direct literal
Chris@16:         template <typename OutputIterator, typename Context, typename Delimiter>
Chris@16:         static bool generate(OutputIterator&, Context&, Delimiter const&, 
Chris@16:             unused_type const&)
Chris@16:         {
Chris@16:             // It is not possible (doesn't make sense) to use string without
Chris@16:             // providing any attribute, as the generator doesn't 'know' what
Chris@16:             // character to output. The following assertion fires if this
Chris@16:             // situation is detected in your code.
Chris@16:             BOOST_SPIRIT_ASSERT_FAIL(OutputIterator, string_not_usable_without_attribute, ());
Chris@16:             return false;
Chris@16:         }
Chris@16: 
Chris@16:         template <typename Context>
Chris@16:         static info what(Context const& /*context*/)
Chris@16:         {
Chris@16:             return info("any-string");
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     // generate literal strings
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename String, typename CharEncoding, typename Tag, bool no_attribute>
Chris@16:     struct literal_string
Chris@16:       : primitive_generator<literal_string<String, CharEncoding, Tag, no_attribute> >
Chris@16:     {
Chris@16:         typedef CharEncoding char_encoding;
Chris@16:         typedef typename
Chris@16:             remove_const<typename traits::char_type_of<String>::type>::type
Chris@16:         char_type;
Chris@16:         typedef std::basic_string<char_type> string_type;
Chris@16: 
Chris@16:         template <typename Context, typename Unused = unused_type>
Chris@16:         struct attribute
Chris@16:           : mpl::if_c<no_attribute, unused_type, string_type>
Chris@16:         {};
Chris@16: 
Chris@16:         literal_string(typename add_reference<String>::type str)
Chris@16:           : str_(str)
Chris@16:         {}
Chris@16: 
Chris@16:         // A string("...") which additionally has an associated attribute emits
Chris@16:         // its immediate literal only if it matches the attribute, otherwise
Chris@16:         // it fails.
Chris@16:         template <
Chris@16:             typename OutputIterator, typename Context, typename Delimiter
Chris@16:           , typename Attribute>
Chris@16:         bool generate(OutputIterator& sink, Context& context
Chris@16:           , Delimiter const& d, Attribute const& attr) const
Chris@16:         {
Chris@16:             if (!traits::has_optional_value(attr))
Chris@16:                 return false;
Chris@16: 
Chris@16:             // fail if attribute isn't matched by immediate literal
Chris@16:             typedef typename attribute<Context>::type attribute_type;
Chris@16: 
Chris@16:             typedef typename spirit::result_of::extract_from<attribute_type, Attribute>::type
Chris@16:                 extracted_string_type;
Chris@16: 
Chris@16:             using spirit::traits::get_c_string;
Chris@16:             if (!detail::string_compare(
Chris@16:                     get_c_string(
Chris@16:                         traits::extract_from<attribute_type>(attr, context))
Chris@16:                   , get_c_string(str_), char_encoding(), Tag()))
Chris@16:             {
Chris@16:                 return false;
Chris@16:             }
Chris@16:             return detail::string_generate(sink, str_, char_encoding(), Tag()) && 
Chris@16:                    karma::delimit_out(sink, d);      // always do post-delimiting
Chris@16:         }
Chris@16: 
Chris@16:         // A string("...") without any associated attribute just emits its 
Chris@16:         // immediate literal
Chris@16:         template <typename OutputIterator, typename Context, typename Delimiter>
Chris@16:         bool generate(OutputIterator& sink, Context&, Delimiter const& d
Chris@16:           , unused_type) const
Chris@16:         {
Chris@16:             return detail::string_generate(sink, str_, char_encoding(), Tag()) && 
Chris@16:                    karma::delimit_out(sink, d);      // always do post-delimiting
Chris@16:         }
Chris@16: 
Chris@16:         template <typename Context>
Chris@16:         info what(Context const& /*context*/) const
Chris@16:         {
Chris@16:             return info("literal-string", str_);
Chris@16:         }
Chris@16: 
Chris@16:         string_type str_;
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     // Generator generators: make_xxx function (objects)
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16:     // string
Chris@16:     template <typename CharEncoding, typename Modifiers>
Chris@16:     struct make_primitive<
Chris@16:         tag::char_code<tag::string, CharEncoding>
Chris@16:       , Modifiers>
Chris@16:     {
Chris@16:         static bool const lower = 
Chris@16:             has_modifier<Modifiers, tag::char_code_base<tag::lower> >::value;
Chris@16:         static bool const upper = 
Chris@16:             has_modifier<Modifiers, tag::char_code_base<tag::upper> >::value;
Chris@16: 
Chris@16:         typedef any_string<
Chris@16:             typename spirit::detail::get_encoding_with_case<
Chris@16:                 Modifiers, CharEncoding, lower || upper>::type
Chris@16:           , typename detail::get_casetag<Modifiers, lower || upper>::type
Chris@16:         > result_type;
Chris@16: 
Chris@16:         result_type operator()(unused_type, unused_type) const
Chris@16:         {
Chris@16:             return result_type();
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     // string literal 
Chris@16:     template <typename T, typename Modifiers>
Chris@16:     struct make_primitive<T, Modifiers
Chris@16:       , typename enable_if<traits::is_string<T> >::type>
Chris@16:     {
Chris@16:         static bool const lower =
Chris@16:             has_modifier<Modifiers, tag::char_code_base<tag::lower> >::value;
Chris@16: 
Chris@16:         static bool const upper =
Chris@16:             has_modifier<Modifiers, tag::char_code_base<tag::upper> >::value;
Chris@16: 
Chris@16:         typedef typename add_const<T>::type const_string;
Chris@16:         typedef literal_string<
Chris@16:             const_string
Chris@16:           , typename spirit::detail::get_encoding_with_case<
Chris@16:                 Modifiers, unused_type, lower || upper>::type
Chris@16:           , typename detail::get_casetag<Modifiers, lower || upper>::type
Chris@16:           , true
Chris@16:         > result_type;
Chris@16: 
Chris@16:         result_type operator()(
Chris@16:             typename add_reference<const_string>::type str, unused_type) const
Chris@16:         {
Chris@16:             return result_type(str);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     namespace detail
Chris@16:     {
Chris@16:         template <typename CharEncoding, typename Modifiers, typename A0
Chris@16:           , bool no_attribute>
Chris@16:         struct make_string_direct
Chris@16:         {
Chris@16:             static bool const lower = 
Chris@16:                 has_modifier<Modifiers, tag::char_code_base<tag::lower> >::value;
Chris@16:             static bool const upper = 
Chris@16:                 has_modifier<Modifiers, tag::char_code_base<tag::upper> >::value;
Chris@16: 
Chris@16:             typedef typename add_const<A0>::type const_string;
Chris@16:             typedef literal_string<
Chris@16:                 const_string
Chris@16:               , typename spirit::detail::get_encoding_with_case<
Chris@16:                     Modifiers, unused_type, lower || upper>::type
Chris@16:               , typename detail::get_casetag<Modifiers, lower || upper>::type
Chris@16:               , no_attribute
Chris@16:             > result_type;
Chris@16: 
Chris@16:             template <typename Terminal>
Chris@16:             result_type operator()(Terminal const& term, unused_type) const
Chris@16:             {
Chris@16:                 return result_type(fusion::at_c<0>(term.args));
Chris@16:             }
Chris@16:         };
Chris@16:     }
Chris@16: 
Chris@16:     // string("..."), lit("...")
Chris@16:     template <typename CharEncoding, typename Modifiers, typename A0>
Chris@16:     struct make_primitive<
Chris@16:             terminal_ex<
Chris@16:                 tag::char_code<tag::string, CharEncoding>
Chris@16:               , fusion::vector1<A0> >
Chris@16:           , Modifiers>
Chris@16:       : detail::make_string_direct<CharEncoding, Modifiers, A0, false>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename Modifiers, typename A0>
Chris@16:     struct make_primitive<
Chris@16:             terminal_ex<tag::lit, fusion::vector1<A0> >
Chris@16:           , Modifiers
Chris@16:           , typename enable_if<traits::is_string<A0> >::type>
Chris@16:       : detail::make_string_direct<
Chris@16:             typename traits::char_encoding_from_char<
Chris@16:                 typename traits::char_type_of<A0>::type>::type
Chris@16:           , Modifiers, A0, true>
Chris@16:     {};
Chris@16: }}}   // namespace boost::spirit::karma
Chris@16: 
Chris@16: namespace boost { namespace spirit { namespace traits
Chris@16: {
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename CharEncoding, typename Tag, typename Attribute
Chris@16:             , typename Context, typename Iterator>
Chris@16:     struct handles_container<karma::any_string<CharEncoding, Tag>, Attribute
Chris@16:       , Context, Iterator>
Chris@16:       : mpl::false_ {};
Chris@16: 
Chris@16:     template <typename String, typename CharEncoding, typename Tag
Chris@16:             , bool no_attribute, typename Attribute, typename Context
Chris@16:             , typename Iterator>
Chris@16:     struct handles_container<karma::literal_string<String, CharEncoding, Tag
Chris@16:       , no_attribute>, Attribute, Context, Iterator>
Chris@16:       : mpl::false_ {};
Chris@16: }}}
Chris@16: 
Chris@16: #endif