Chris@16: /*=============================================================================
Chris@16:     Copyright (c) 2001-2011 Joel de Guzman
Chris@16:     Copyright (c) 2001-2011 Hartmut Kaiser
Chris@16:     http://spirit.sourceforge.net/
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_CONTAINER_FEBRUARY_06_2007_1001AM)
Chris@16: #define BOOST_SPIRIT_CONTAINER_FEBRUARY_06_2007_1001AM
Chris@16: 
Chris@16: #if defined(_MSC_VER)
Chris@16: #pragma once
Chris@16: #endif
Chris@16: 
Chris@16: #include <boost/spirit/home/support/unused.hpp>
Chris@16: #include <boost/spirit/home/support/attributes_fwd.hpp>
Chris@16: #include <boost/detail/iterator.hpp> // for boost::detail::iterator_traits
Chris@16: #include <boost/mpl/has_xxx.hpp>
Chris@16: #include <boost/mpl/bool.hpp>
Chris@16: #include <boost/optional.hpp>
Chris@16: #include <boost/variant.hpp>
Chris@16: #include <boost/preprocessor/cat.hpp>
Chris@16: #include <boost/preprocessor/repeat.hpp>
Chris@16: #include <boost/range/iterator_range.hpp>
Chris@16: 
Chris@16: namespace boost { namespace spirit { namespace traits
Chris@16: {
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     //  This file contains some container utils for stl containers. The
Chris@16:     //  utilities provided also accept spirit's unused_type; all no-ops.
Chris@16:     //  Compiler optimization will easily strip these away.
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16:     namespace detail
Chris@16:     {
Chris@16:         BOOST_MPL_HAS_XXX_TRAIT_DEF(value_type)
Chris@16:         BOOST_MPL_HAS_XXX_TRAIT_DEF(iterator)
Chris@16:         BOOST_MPL_HAS_XXX_TRAIT_DEF(size_type)
Chris@16:         BOOST_MPL_HAS_XXX_TRAIT_DEF(reference)
Chris@16:     }
Chris@16: 
Chris@16:     template <typename T, typename Enable/* = void*/>
Chris@16:     struct is_container
Chris@16:       : mpl::bool_<
Chris@16:             detail::has_value_type<T>::value &&
Chris@16:             detail::has_iterator<T>::value &&
Chris@16:             detail::has_size_type<T>::value &&
Chris@16:             detail::has_reference<T>::value>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct is_container<T&>
Chris@16:       : is_container<T>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct is_container<boost::optional<T> >
Chris@16:       : is_container<T>
Chris@16:     {};
Chris@16: 
Chris@101: #if !defined(BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES)
Chris@101:     template<typename T>
Chris@101:     struct is_container<boost::variant<T> >
Chris@101:       : is_container<T>
Chris@101:     {};
Chris@101: 
Chris@101:     template<typename T0, typename T1, typename ...TN>
Chris@101:     struct is_container<boost::variant<T0, T1, TN...> >
Chris@101:       : mpl::bool_<is_container<T0>::value ||
Chris@101:             is_container<boost::variant<T1, TN...> >::value>
Chris@101:     {};
Chris@101: 
Chris@101: #else
Chris@16: #define BOOST_SPIRIT_IS_CONTAINER(z, N, data)                                 \
Chris@16:         is_container<BOOST_PP_CAT(T, N)>::value ||                            \
Chris@16:     /***/
Chris@16: 
Chris@16:     // make sure unused variant parameters do not affect the outcome
Chris@16:     template <>
Chris@16:     struct is_container<boost::detail::variant::void_>
Chris@16:       : mpl::false_
Chris@16:     {};
Chris@16: 
Chris@16:     template <BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@16:     struct is_container<variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
Chris@16:        : mpl::bool_<BOOST_PP_REPEAT(BOOST_VARIANT_LIMIT_TYPES
Chris@16:             , BOOST_SPIRIT_IS_CONTAINER, _) false>
Chris@16:     {};
Chris@16: 
Chris@16: #undef BOOST_SPIRIT_IS_CONTAINER
Chris@101: #endif
Chris@16: 
Chris@16:     template <typename T, typename Enable/* = void*/>
Chris@16:     struct is_iterator_range
Chris@16:       : mpl::false_
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct is_iterator_range<iterator_range<T> >
Chris@16:       : mpl::true_
Chris@16:     {};
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     namespace detail
Chris@16:     {
Chris@16:         template <typename T>
Chris@16:         struct remove_value_const
Chris@16:         {
Chris@16:             typedef T type;
Chris@16:         };
Chris@16: 
Chris@16:         template <typename T>
Chris@16:         struct remove_value_const<T const>
Chris@16:           : remove_value_const<T>
Chris@16:         {};
Chris@16: 
Chris@16:         template <typename F, typename S>
Chris@16:         struct remove_value_const<std::pair<F, S> >
Chris@16:         {
Chris@16:             typedef typename remove_value_const<F>::type first_type;
Chris@16:             typedef typename remove_value_const<S>::type second_type;
Chris@16:             typedef std::pair<first_type, second_type> type;
Chris@16:         };
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////
Chris@16:     //[customization_container_value_default
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct container_value
Chris@16:       : detail::remove_value_const<typename Container::value_type>
Chris@16:     {};
Chris@16:     //]
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct container_value<T&>
Chris@16:       : container_value<T>
Chris@16:     {};
Chris@16: 
Chris@16:     // this will be instantiated if the optional holds a container
Chris@16:     template <typename T>
Chris@16:     struct container_value<boost::optional<T> >
Chris@16:       : container_value<T>
Chris@16:     {};
Chris@16: 
Chris@16:     // this will be instantiated if the variant holds a container
Chris@16:     template <BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@16:     struct container_value<variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
Chris@16:     {
Chris@16:         typedef typename
Chris@16:             variant<BOOST_VARIANT_ENUM_PARAMS(T)>::types
Chris@16:         types;
Chris@16:         typedef typename
Chris@16:             mpl::find_if<types, is_container<mpl::_1> >::type
Chris@16:         iter;
Chris@16: 
Chris@16:         typedef typename container_value<
Chris@16:             typename mpl::if_<
Chris@16:                 is_same<iter, typename mpl::end<types>::type>
Chris@16:               , unused_type, typename mpl::deref<iter>::type
Chris@16:             >::type
Chris@16:         >::type type;
Chris@16:     };
Chris@16: 
Chris@16:     //[customization_container_value_unused
Chris@16:     template <>
Chris@16:     struct container_value<unused_type>
Chris@16:     {
Chris@16:         typedef unused_type type;
Chris@16:     };
Chris@16:     //]
Chris@16: 
Chris@16:     template <>
Chris@16:     struct container_value<unused_type const>
Chris@16:     {
Chris@16:         typedef unused_type type;
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct container_iterator
Chris@16:     {
Chris@16:         typedef typename Container::iterator type;
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     struct container_iterator<Container&>
Chris@16:       : container_iterator<Container>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     struct container_iterator<Container const>
Chris@16:     {
Chris@16:         typedef typename Container::const_iterator type;
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct container_iterator<optional<T> >
Chris@16:       : container_iterator<T>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct container_iterator<optional<T> const>
Chris@16:       : container_iterator<T const>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename Iterator>
Chris@16:     struct container_iterator<iterator_range<Iterator> >
Chris@16:     {
Chris@16:         typedef typename range_const_iterator<
Chris@16:               iterator_range<Iterator> >::type type;
Chris@16:     };
Chris@16: 
Chris@16:     template <>
Chris@16:     struct container_iterator<unused_type>
Chris@16:     {
Chris@16:         typedef unused_type const* type;
Chris@16:     };
Chris@16: 
Chris@16:     template <>
Chris@16:     struct container_iterator<unused_type const>
Chris@16:     {
Chris@16:         typedef unused_type const* type;
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename T, typename Enable/* = void*/>
Chris@16:     struct optional_attribute
Chris@16:     {
Chris@16:         typedef T const& type;
Chris@16: 
Chris@16:         static type call(T const& val)
Chris@16:         {
Chris@16:             return val;
Chris@16:         }
Chris@16: 
Chris@16:         static bool is_valid(T const&)
Chris@16:         {
Chris@16:             return true;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct optional_attribute<boost::optional<T> >
Chris@16:     {
Chris@16:         typedef T const& type;
Chris@16: 
Chris@16:         static type call(boost::optional<T> const& val)
Chris@16:         {
Chris@16:             return boost::get<T>(val);
Chris@16:         }
Chris@16: 
Chris@16:         static bool is_valid(boost::optional<T> const& val)
Chris@16:         {
Chris@101:             return !!val;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     typename optional_attribute<T>::type
Chris@16:     optional_value(T const& val)
Chris@16:     {
Chris@16:         return optional_attribute<T>::call(val);
Chris@16:     }
Chris@16: 
Chris@16:     inline unused_type optional_value(unused_type)
Chris@16:     {
Chris@16:         return unused;
Chris@16:     }
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     bool has_optional_value(T const& val)
Chris@16:     {
Chris@16:         return optional_attribute<T>::is_valid(val);
Chris@16:     }
Chris@16: 
Chris@16:     inline bool has_optional_value(unused_type)
Chris@16:     {
Chris@16:         return true;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container, typename T>
Chris@16:     bool push_back(Container& c, T const& val);
Chris@16: 
Chris@16:     //[customization_push_back_default
Chris@16:     template <typename Container, typename T, typename Enable/* = void*/>
Chris@16:     struct push_back_container
Chris@16:     {
Chris@16:         static bool call(Container& c, T const& val)
Chris@16:         {
Chris@16:             c.insert(c.end(), val);
Chris@16:             return true;
Chris@16:         }
Chris@16:     };
Chris@16:     //]
Chris@16: 
Chris@16:     template <typename Container, typename T>
Chris@16:     struct push_back_container<optional<Container>, T>
Chris@16:     {
Chris@16:         static bool call(boost::optional<Container>& c, T const& val)
Chris@16:         {
Chris@16:             if (!c)
Chris@16:                 c = Container();
Chris@16:             return push_back(boost::get<Container>(c), val);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     namespace detail
Chris@16:     {
Chris@16:         template <typename T>
Chris@16:         struct push_back_visitor : public static_visitor<>
Chris@16:         {
Chris@16:             typedef bool result_type;
Chris@16: 
Chris@16:             push_back_visitor(T const& t) : t_(t) {}
Chris@16: 
Chris@16:             template <typename Container>
Chris@16:             bool push_back_impl(Container& c, mpl::true_) const
Chris@16:             {
Chris@16:                 return push_back(c, t_);
Chris@16:             }
Chris@16: 
Chris@16:             template <typename T_>
Chris@16:             bool push_back_impl(T_&, mpl::false_) const
Chris@16:             {
Chris@16:                 // this variant doesn't hold a container
Chris@16:                 BOOST_ASSERT(false && "This variant doesn't hold a container");
Chris@16:                 return false;
Chris@16:             }
Chris@16: 
Chris@16:             template <typename T_>
Chris@16:             bool operator()(T_& c) const
Chris@16:             {
Chris@16:                 return push_back_impl(c, typename is_container<T_>::type());
Chris@16:             }
Chris@16: 
Chris@16:             T const& t_;
Chris@16:         };
Chris@16:     }
Chris@16: 
Chris@16:     template <BOOST_VARIANT_ENUM_PARAMS(typename T_), typename T>
Chris@16:     struct push_back_container<variant<BOOST_VARIANT_ENUM_PARAMS(T_)>, T>
Chris@16:     {
Chris@16:         static bool call(variant<BOOST_VARIANT_ENUM_PARAMS(T_)>& c, T const& val)
Chris@16:         {
Chris@16:             return apply_visitor(detail::push_back_visitor<T>(val), c);
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Container, typename T>
Chris@16:     bool push_back(Container& c, T const& val)
Chris@16:     {
Chris@16:         return push_back_container<Container, T>::call(c, val);
Chris@16:     }
Chris@16: 
Chris@16:     //[customization_push_back_unused
Chris@16:     template <typename Container>
Chris@16:     bool push_back(Container&, unused_type)
Chris@16:     {
Chris@16:         return true;
Chris@16:     }
Chris@16:     //]
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     bool push_back(unused_type, T const&)
Chris@16:     {
Chris@16:         return true;
Chris@16:     }
Chris@16: 
Chris@16:     inline bool push_back(unused_type, unused_type)
Chris@16:     {
Chris@16:         return true;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct is_empty_container
Chris@16:     {
Chris@16:         static bool call(Container const& c)
Chris@16:         {
Chris@16:             return c.empty();
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     bool is_empty(Container const& c)
Chris@16:     {
Chris@16:         return is_empty_container<Container>::call(c);
Chris@16:     }
Chris@16: 
Chris@16:     inline bool is_empty(unused_type)
Chris@16:     {
Chris@16:         return true;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     // Ensure the attribute is actually a container type
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct make_container_attribute
Chris@16:     {
Chris@16:         static void call(Container&)
Chris@16:         {
Chris@16:             // for static types this function does nothing
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     void make_container(T& t)
Chris@16:     {
Chris@16:         make_container_attribute<T>::call(t);
Chris@16:     }
Chris@16: 
Chris@16:     inline void make_container(unused_type)
Chris@16:     {
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct begin_container
Chris@16:     {
Chris@16:         static typename container_iterator<Container>::type call(Container& c)
Chris@16:         {
Chris@16:             return c.begin();
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     typename spirit::result_of::begin<Container>::type
Chris@16:     begin(Container& c)
Chris@16:     {
Chris@16:         return begin_container<Container>::call(c);
Chris@16:     }
Chris@16: 
Chris@16:     inline unused_type const*
Chris@16:     begin(unused_type)
Chris@16:     {
Chris@16:         return &unused;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container, typename Enable/* = void*/>
Chris@16:     struct end_container
Chris@16:     {
Chris@16:         static typename container_iterator<Container>::type call(Container& c)
Chris@16:         {
Chris@16:             return c.end();
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     inline typename spirit::result_of::end<Container>::type
Chris@16:     end(Container& c)
Chris@16:     {
Chris@16:         return end_container<Container>::call(c);
Chris@16:     }
Chris@16: 
Chris@16:     inline unused_type const*
Chris@16:     end(unused_type)
Chris@16:     {
Chris@16:         return &unused;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Iterator, typename Enable/* = void*/>
Chris@16:     struct deref_iterator
Chris@16:     {
Chris@16:         typedef typename boost::detail::iterator_traits<Iterator>::reference type;
Chris@16:         static type call(Iterator& it)
Chris@16:         {
Chris@16:             return *it;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Iterator>
Chris@16:     typename deref_iterator<Iterator>::type
Chris@16:     deref(Iterator& it)
Chris@16:     {
Chris@16:         return deref_iterator<Iterator>::call(it);
Chris@16:     }
Chris@16: 
Chris@16:     inline unused_type
Chris@16:     deref(unused_type const*)
Chris@16:     {
Chris@16:         return unused;
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Iterator, typename Enable/* = void*/>
Chris@16:     struct next_iterator
Chris@16:     {
Chris@16:         static void call(Iterator& it)
Chris@16:         {
Chris@16:             ++it;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Iterator>
Chris@16:     void next(Iterator& it)
Chris@16:     {
Chris@16:         next_iterator<Iterator>::call(it);
Chris@16:     }
Chris@16: 
Chris@16:     inline void next(unused_type const*)
Chris@16:     {
Chris@16:         // do nothing
Chris@16:     }
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Iterator, typename Enable/* = void*/>
Chris@16:     struct compare_iterators
Chris@16:     {
Chris@16:         static bool call(Iterator const& it1, Iterator const& it2)
Chris@16:         {
Chris@16:             return it1 == it2;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template <typename Iterator>
Chris@16:     bool compare(Iterator& it1, Iterator& it2)
Chris@16:     {
Chris@16:         return compare_iterators<Iterator>::call(it1, it2);
Chris@16:     }
Chris@16: 
Chris@16:     inline bool compare(unused_type const*, unused_type const*)
Chris@16:     {
Chris@16:         return false;
Chris@16:     }
Chris@16: }}}
Chris@16: 
Chris@16: ///////////////////////////////////////////////////////////////////////////////
Chris@16: namespace boost { namespace spirit { namespace result_of
Chris@16: {
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename T>
Chris@16:     struct optional_value
Chris@16:     {
Chris@16:         typedef T type;
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct optional_value<boost::optional<T> >
Chris@16:     {
Chris@16:         typedef T type;
Chris@16:     };
Chris@16: 
Chris@16:     template <typename T>
Chris@16:     struct optional_value<boost::optional<T> const>
Chris@16:     {
Chris@16:         typedef T const type;
Chris@16:     };
Chris@16: 
Chris@16:     template <>
Chris@16:     struct optional_value<unused_type>
Chris@16:     {
Chris@16:         typedef unused_type type;
Chris@16:     };
Chris@16: 
Chris@16:     template <>
Chris@16:     struct optional_value<unused_type const>
Chris@16:     {
Chris@16:         typedef unused_type type;
Chris@16:     };
Chris@16: 
Chris@16:     ///////////////////////////////////////////////////////////////////////////
Chris@16:     template <typename Container>
Chris@16:     struct begin
Chris@16:       : traits::container_iterator<Container>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename Container>
Chris@16:     struct end
Chris@16:       : traits::container_iterator<Container>
Chris@16:     {};
Chris@16: 
Chris@16:     template <typename Iterator>
Chris@16:     struct deref
Chris@16:       : traits::deref_iterator<Iterator>
Chris@16:     {};
Chris@16: 
Chris@16:     template <>
Chris@16:     struct deref<unused_type const*>
Chris@16:     {
Chris@16:         typedef unused_type type;
Chris@16:     };
Chris@16: 
Chris@16: }}}
Chris@16: 
Chris@16: #endif