3 // Copyright Neil Groves & Thorsten Ottosen & Pavol Droba 2003-2004.
4 // Use, modification and distribution is subject to the Boost Software
5 // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt)
8 // For more information, see http://www.boost.org/libs/range/
11 // 'michel' reported Trac 9072 which included a patch for allowing references
14 #ifndef BOOST_RANGE_ITERATOR_RANGE_CORE_HPP_INCLUDED
15 #define BOOST_RANGE_ITERATOR_RANGE_CORE_HPP_INCLUDED
17 #include <boost/config.hpp> // Define __STL_CONFIG_H, if appropriate.
18 #include <boost/detail/workaround.hpp>
20 #if BOOST_WORKAROUND(BOOST_MSVC, BOOST_TESTED_AT(1500))
21 #pragma warning( push )
22 #pragma warning( disable : 4996 )
25 #include <boost/assert.hpp>
26 #include <boost/iterator/iterator_traits.hpp>
27 #include <boost/iterator/iterator_facade.hpp>
28 #include <boost/mpl/if.hpp>
29 #include <boost/mpl/not.hpp>
30 #include <boost/mpl/or.hpp>
31 #include <boost/type_traits/is_abstract.hpp>
32 #include <boost/type_traits/is_array.hpp>
33 #include <boost/type_traits/is_base_and_derived.hpp>
34 #include <boost/type_traits/is_convertible.hpp>
35 #include <boost/type_traits/is_function.hpp>
36 #include <boost/type_traits/is_pointer.hpp>
37 #include <boost/type_traits/is_same.hpp>
38 #include <boost/range/functions.hpp>
39 #include <boost/range/iterator.hpp>
40 #include <boost/range/difference_type.hpp>
41 #include <boost/range/has_range_iterator.hpp>
42 #include <boost/range/algorithm/equal.hpp>
43 #include <boost/range/detail/safe_bool.hpp>
44 #include <boost/utility/enable_if.hpp>
45 #include <boost/next_prior.hpp>
51 Defines the \c iterator_class and related functions.
52 \c iterator_range is a simple wrapper of iterator pair idiom. It provides
53 a rich subset of Container interface.
59 namespace iterator_range_detail
62 // The functions adl_begin and adl_end are implemented in a separate
65 template<class IteratorT>
66 struct iterator_range_impl {
67 template< class ForwardRange >
68 static IteratorT adl_begin( ForwardRange& r )
70 return IteratorT( boost::begin( r ) );
73 template< class ForwardRange >
74 static IteratorT adl_end( ForwardRange& r )
76 return IteratorT( boost::end( r ) );
80 template< class Left, class Right >
81 inline bool less_than( const Left& l, const Right& r )
83 return std::lexicographical_compare( boost::begin(l),
89 template< class Left, class Right >
90 inline bool greater_than( const Left& l, const Right& r )
92 return iterator_range_detail::less_than(r,l);
95 template< class Left, class Right >
96 inline bool less_or_equal_than( const Left& l, const Right& r )
98 return !iterator_range_detail::less_than(r,l);
101 template< class Left, class Right >
102 inline bool greater_or_equal_than( const Left& l, const Right& r )
104 return !iterator_range_detail::less_than(l,r);
107 // This version is maintained since it is used in other boost libraries
108 // such as Boost.Assign
109 template< class Left, class Right >
110 inline bool equal(const Left& l, const Right& r)
112 return boost::equal(l, r);
119 struct const_range_tag
123 struct iterator_range_tag
127 typedef char (&incrementable_t)[1];
128 typedef char (&bidirectional_t)[2];
129 typedef char (&random_access_t)[3];
131 incrementable_t test_traversal_tag(boost::incrementable_traversal_tag);
132 bidirectional_t test_traversal_tag(boost::bidirectional_traversal_tag);
133 random_access_t test_traversal_tag(boost::random_access_traversal_tag);
135 template<std::size_t S>
136 struct pure_iterator_traversal_impl
138 typedef boost::incrementable_traversal_tag type;
142 struct pure_iterator_traversal_impl<sizeof(bidirectional_t)>
144 typedef boost::bidirectional_traversal_tag type;
148 struct pure_iterator_traversal_impl<sizeof(random_access_t)>
150 typedef boost::random_access_traversal_tag type;
153 template<typename IteratorT>
154 struct pure_iterator_traversal
157 BOOST_DEDUCED_TYPENAME iterator_traversal<IteratorT>::type
159 BOOST_STATIC_CONSTANT(
161 traversal_i = sizeof(iterator_range_detail::test_traversal_tag((traversal_t())))
164 BOOST_DEDUCED_TYPENAME pure_iterator_traversal_impl<traversal_i>::type
168 template<class IteratorT, class TraversalTag>
169 class iterator_range_base
170 : public iterator_range_tag
172 typedef range_detail::safe_bool<
173 IteratorT iterator_range_base<IteratorT, TraversalTag>::*
176 typedef iterator_range_base<IteratorT, TraversalTag> type;
179 typedef iterator_range_impl<IteratorT> impl;
182 typedef BOOST_DEDUCED_TYPENAME
183 safe_bool_t::unspecified_bool_type unspecified_bool_type;
185 typedef BOOST_DEDUCED_TYPENAME
186 iterator_value<IteratorT>::type value_type;
188 typedef BOOST_DEDUCED_TYPENAME
189 iterator_difference<IteratorT>::type difference_type;
191 typedef std::size_t size_type; // note: must be unsigned
193 // Needed because value-type is the same for
194 // const and non-const iterators
195 typedef BOOST_DEDUCED_TYPENAME
196 iterator_reference<IteratorT>::type reference;
198 //! const_iterator type
200 There is no distinction between const_iterator and iterator.
201 These typedefs are provides to fulfill container interface
203 typedef IteratorT const_iterator;
205 typedef IteratorT iterator;
208 iterator_range_base()
214 template<class Iterator>
215 iterator_range_base(Iterator Begin, Iterator End)
222 IteratorT begin() const
227 IteratorT end() const
234 return m_Begin == m_End;
237 operator unspecified_bool_type() const
239 return safe_bool_t::to_unspecified_bool(
240 m_Begin != m_End, &iterator_range_base::m_Begin);
243 bool operator!() const
248 bool equal(const iterator_range_base& r) const
250 return m_Begin == r.m_Begin && m_End == r.m_End;
253 reference front() const
255 BOOST_ASSERT(!empty());
261 BOOST_ASSERT(!empty());
265 void drop_front(difference_type n)
267 BOOST_ASSERT(n >= difference_type());
268 std::advance(this->m_Begin, n);
272 void pop_front() { drop_front(); }
275 template<class Iterator>
276 void assign(Iterator first, Iterator last)
282 template<class SinglePassRange>
283 void assign(const SinglePassRange& r)
285 m_Begin = impl::adl_begin(r);
286 m_End = impl::adl_end(r);
289 template<class SinglePassRange>
290 void assign(SinglePassRange& r)
292 m_Begin = impl::adl_begin(r);
293 m_End = impl::adl_end(r);
300 template<class IteratorT>
301 class iterator_range_base<IteratorT, bidirectional_traversal_tag>
302 : public iterator_range_base<IteratorT, incrementable_traversal_tag>
304 typedef iterator_range_base<IteratorT, incrementable_traversal_tag> base_type;
307 iterator_range_base()
311 template<class Iterator>
312 iterator_range_base(Iterator first, Iterator last)
313 : base_type(first, last)
318 typedef BOOST_DEDUCED_TYPENAME base_type::difference_type difference_type;
319 typedef BOOST_DEDUCED_TYPENAME base_type::reference reference;
321 reference back() const
323 BOOST_ASSERT(!this->empty());
324 return *boost::prior(this->m_End);
329 BOOST_ASSERT(!this->empty());
333 void drop_back(difference_type n)
335 BOOST_ASSERT(n >= difference_type());
336 std::advance(this->m_End, -n);
340 void pop_back() { drop_back(); }
343 template<class IteratorT>
344 class iterator_range_base<IteratorT, random_access_traversal_tag>
345 : public iterator_range_base<IteratorT, bidirectional_traversal_tag>
347 typedef iterator_range_base<
348 IteratorT, bidirectional_traversal_tag> base_type;
351 typedef BOOST_DEDUCED_TYPENAME
355 BOOST_DEDUCED_TYPENAME base_type::value_type
358 BOOST_DEDUCED_TYPENAME base_type::value_type
361 BOOST_DEDUCED_TYPENAME base_type::value_type
364 BOOST_DEDUCED_TYPENAME base_type::reference,
365 BOOST_DEDUCED_TYPENAME base_type::value_type
366 >::type abstract_value_type;
369 // typedef these here to reduce verbiage in the implementation of this
371 typedef BOOST_DEDUCED_TYPENAME base_type::difference_type difference_type;
372 typedef BOOST_DEDUCED_TYPENAME base_type::size_type size_type;
373 typedef BOOST_DEDUCED_TYPENAME base_type::reference reference;
376 iterator_range_base()
380 template<class Iterator>
381 iterator_range_base(Iterator first, Iterator last)
382 : base_type(first, last)
387 reference operator[](difference_type at) const
389 BOOST_ASSERT(at >= 0);
390 BOOST_ASSERT(static_cast<typename base_type::size_type>(at) < size());
391 return this->m_Begin[at];
395 // When storing transform iterators, operator[]()
396 // fails because it returns by reference. Therefore
397 // operator()() is provided for these cases.
399 abstract_value_type operator()(difference_type at) const
401 BOOST_ASSERT(at >= 0);
402 BOOST_ASSERT(static_cast<typename base_type::size_type>(at) < size());
403 return this->m_Begin[at];
406 BOOST_DEDUCED_TYPENAME base_type::size_type size() const
408 return this->m_End - this->m_Begin;
414 // iterator range template class -----------------------------------------//
416 //! iterator_range class
418 An \c iterator_range delimits a range in a sequence by beginning and ending iterators.
419 An iterator_range can be passed to an algorithm which requires a sequence as an input.
420 For example, the \c toupper() function may be used most frequently on strings,
421 but can also be used on iterator_ranges:
424 boost::tolower( find( s, "UPPERCASE STRING" ) );
427 Many algorithms working with sequences take a pair of iterators,
428 delimiting a working range, as an arguments. The \c iterator_range class is an
429 encapsulation of a range identified by a pair of iterators.
430 It provides a collection interface,
431 so it is possible to pass an instance to an algorithm requiring a collection as an input.
433 template<class IteratorT>
435 : public iterator_range_detail::iterator_range_base<
437 BOOST_DEDUCED_TYPENAME iterator_range_detail::pure_iterator_traversal<IteratorT>::type
440 typedef iterator_range_detail::iterator_range_base<
442 BOOST_DEDUCED_TYPENAME iterator_range_detail::pure_iterator_traversal<IteratorT>::type
445 template<class Source>
446 struct is_compatible_range_
448 BOOST_DEDUCED_TYPENAME mpl::eval_if<
449 has_range_iterator<Source>,
450 range_iterator<Source>,
453 BOOST_DEDUCED_TYPENAME base_type::iterator
458 template<class Source>
459 struct is_compatible_range
464 BOOST_DEDUCED_TYPENAME base_type::iterator
467 is_compatible_range_<Source>
473 typedef iterator_range_detail::iterator_range_impl<IteratorT> impl;
476 typedef iterator_range<IteratorT> type;
482 template<class Iterator>
483 iterator_range(Iterator first, Iterator last)
484 : base_type(first, last)
488 template<class SinglePassRange>
490 const SinglePassRange& r,
491 BOOST_DEDUCED_TYPENAME ::boost::enable_if<
492 is_compatible_range<const SinglePassRange>
495 : base_type(impl::adl_begin(r), impl::adl_end(r))
499 template<class SinglePassRange>
502 BOOST_DEDUCED_TYPENAME ::boost::enable_if<
503 is_compatible_range<SinglePassRange>
506 : base_type(impl::adl_begin(r), impl::adl_end(r))
510 template<class SinglePassRange>
511 iterator_range(const SinglePassRange& r,
512 iterator_range_detail::const_range_tag)
513 : base_type(impl::adl_begin(r), impl::adl_end(r))
517 template<class SinglePassRange>
518 iterator_range(SinglePassRange& r,
519 iterator_range_detail::range_tag)
520 : base_type(impl::adl_begin(r), impl::adl_end(r))
524 template<class Iterator>
525 iterator_range& operator=(const iterator_range<Iterator>& other)
527 this->assign(other.begin(), other.end());
531 template<class Iterator>
532 iterator_range& operator=(iterator_range<Iterator>& other)
534 this->assign(other.begin(), other.end());
538 template<class SinglePassRange>
539 iterator_range& operator=(SinglePassRange& r)
545 template<class SinglePassRange>
546 iterator_range& operator=(const SinglePassRange& r)
552 iterator_range& advance_begin(
553 BOOST_DEDUCED_TYPENAME base_type::difference_type n)
555 std::advance(this->m_Begin, n);
559 iterator_range& advance_end(
560 BOOST_DEDUCED_TYPENAME base_type::difference_type n)
562 std::advance(this->m_End, n);
568 // Allow subclasses an easy way to access the
571 typedef iterator_range iterator_range_;
574 // iterator range free-standing operators ---------------------------//
576 /////////////////////////////////////////////////////////////////////
577 // comparison operators
578 /////////////////////////////////////////////////////////////////////
580 template< class IteratorT, class ForwardRange >
581 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
582 mpl::not_<is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
585 operator==( const ForwardRange& l, const iterator_range<IteratorT>& r )
587 return boost::equal( l, r );
590 template< class IteratorT, class ForwardRange >
591 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
592 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
595 operator!=( const ForwardRange& l, const iterator_range<IteratorT>& r )
597 return !boost::equal( l, r );
600 template< class IteratorT, class ForwardRange >
601 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
602 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
605 operator<( const ForwardRange& l, const iterator_range<IteratorT>& r )
607 return iterator_range_detail::less_than( l, r );
610 template< class IteratorT, class ForwardRange >
611 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
612 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
615 operator<=( const ForwardRange& l, const iterator_range<IteratorT>& r )
617 return iterator_range_detail::less_or_equal_than( l, r );
620 template< class IteratorT, class ForwardRange >
621 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
622 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
625 operator>( const ForwardRange& l, const iterator_range<IteratorT>& r )
627 return iterator_range_detail::greater_than( l, r );
630 template< class IteratorT, class ForwardRange >
631 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
632 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
635 operator>=( const ForwardRange& l, const iterator_range<IteratorT>& r )
637 return iterator_range_detail::greater_or_equal_than( l, r );
640 #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
642 template< class Iterator1T, class Iterator2T >
644 operator==( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
646 return boost::equal( l, r );
649 template< class IteratorT, class ForwardRange >
650 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
651 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
654 operator==( const iterator_range<IteratorT>& l, const ForwardRange& r )
656 return boost::equal( l, r );
660 template< class Iterator1T, class Iterator2T >
662 operator!=( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
664 return !boost::equal( l, r );
667 template< class IteratorT, class ForwardRange >
668 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
669 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
672 operator!=( const iterator_range<IteratorT>& l, const ForwardRange& r )
674 return !boost::equal( l, r );
678 template< class Iterator1T, class Iterator2T >
680 operator<( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
682 return iterator_range_detail::less_than( l, r );
685 template< class IteratorT, class ForwardRange >
686 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
687 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
690 operator<( const iterator_range<IteratorT>& l, const ForwardRange& r )
692 return iterator_range_detail::less_than( l, r );
695 template< class Iterator1T, class Iterator2T >
697 operator<=( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
699 return iterator_range_detail::less_or_equal_than( l, r );
702 template< class IteratorT, class ForwardRange >
703 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
704 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
707 operator<=( const iterator_range<IteratorT>& l, const ForwardRange& r )
709 return iterator_range_detail::less_or_equal_than( l, r );
712 template< class Iterator1T, class Iterator2T >
714 operator>( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
716 return iterator_range_detail::greater_than( l, r );
719 template< class IteratorT, class ForwardRange >
720 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
721 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
724 operator>( const iterator_range<IteratorT>& l, const ForwardRange& r )
726 return iterator_range_detail::greater_than( l, r );
729 template< class Iterator1T, class Iterator2T >
731 operator>=( const iterator_range<Iterator1T>& l, const iterator_range<Iterator2T>& r )
733 return iterator_range_detail::greater_or_equal_than( l, r );
736 template< class IteratorT, class ForwardRange >
737 inline BOOST_DEDUCED_TYPENAME boost::enable_if<
738 mpl::not_<boost::is_base_and_derived<iterator_range_detail::iterator_range_tag, ForwardRange> >,
741 operator>=( const iterator_range<IteratorT>& l, const ForwardRange& r )
743 return iterator_range_detail::greater_or_equal_than( l, r );
746 #endif // BOOST_NO_FUNCTION_TEMPLATE_ORDERING
748 // iterator range utilities -----------------------------------------//
750 //! iterator_range construct helper
752 Construct an \c iterator_range from a pair of iterators
754 \param Begin A begin iterator
755 \param End An end iterator
756 \return iterator_range object
758 template< typename IteratorT >
759 inline iterator_range< IteratorT >
760 make_iterator_range( IteratorT Begin, IteratorT End )
762 return iterator_range<IteratorT>( Begin, End );
765 template<typename IteratorT, typename IntegerT>
766 inline iterator_range<IteratorT>
767 make_iterator_range_n(IteratorT first, IntegerT n)
769 return iterator_range<IteratorT>(first, boost::next(first, n));
772 #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
774 template< typename Range >
775 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<Range>::type >
776 make_iterator_range( Range& r )
778 return iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<Range>::type >
779 ( boost::begin( r ), boost::end( r ) );
783 //! iterator_range construct helper
785 Construct an \c iterator_range from a \c Range containing the begin
788 template< class ForwardRange >
789 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type >
790 make_iterator_range( ForwardRange& r )
792 return iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type >
793 ( r, iterator_range_detail::range_tag() );
796 template< class ForwardRange >
797 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type >
798 make_iterator_range( const ForwardRange& r )
800 return iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type >
801 ( r, iterator_range_detail::const_range_tag() );
804 #endif // BOOST_NO_FUNCTION_TEMPLATE_ORDERING
806 namespace iterator_range_detail
808 template< class Range >
809 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<Range>::type >
810 make_range_impl( Range& r,
811 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_begin,
812 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_end )
815 // Not worth the effort
817 //if( advance_begin == 0 && advance_end == 0 )
818 // return make_iterator_range( r );
821 BOOST_DEDUCED_TYPENAME range_iterator<Range>::type
822 new_begin = boost::begin( r ),
823 new_end = boost::end( r );
824 std::advance( new_begin, advance_begin );
825 std::advance( new_end, advance_end );
826 return make_iterator_range( new_begin, new_end );
830 #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
832 template< class Range >
833 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<Range>::type >
834 make_iterator_range( Range& r,
835 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_begin,
836 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_end )
838 return iterator_range_detail::make_range_impl( r, advance_begin, advance_end );
843 template< class Range >
844 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<Range>::type >
845 make_iterator_range( Range& r,
846 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_begin,
847 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_end )
849 return iterator_range_detail::make_range_impl( r, advance_begin, advance_end );
852 template< class Range >
853 inline iterator_range< BOOST_DEDUCED_TYPENAME range_iterator<const Range>::type >
854 make_iterator_range( const Range& r,
855 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_begin,
856 BOOST_DEDUCED_TYPENAME range_difference<Range>::type advance_end )
858 return iterator_range_detail::make_range_impl( r, advance_begin, advance_end );
861 #endif // BOOST_NO_FUNCTION_TEMPLATE_ORDERING
863 //! copy a range into a sequence
865 Construct a new sequence of the specified type from the elements
868 \param Range An input range
871 template< typename SeqT, typename Range >
872 inline SeqT copy_range( const Range& r )
874 return SeqT( boost::begin( r ), boost::end( r ) );
877 } // namespace 'boost'
879 #if BOOST_WORKAROUND(BOOST_MSVC, BOOST_TESTED_AT(1500))
880 #pragma warning( pop )