Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: // (C) Copyright Ion Gaztanaga 2012-2012.
Chris@16: // Distributed under the Boost Software License, Version 1.0.
Chris@16: // (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: // See http://www.boost.org/libs/move for documentation.
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: //! \file
Chris@16: 
Chris@16: #ifndef BOOST_MOVE_ITERATOR_HPP
Chris@16: #define BOOST_MOVE_ITERATOR_HPP
Chris@16: 
Chris@101: #ifndef BOOST_CONFIG_HPP
Chris@101: #  include <boost/config.hpp>
Chris@101: #endif
Chris@101: #
Chris@101: #if defined(BOOST_HAS_PRAGMA_ONCE)
Chris@101: #  pragma once
Chris@101: #endif
Chris@101: 
Chris@16: #include <boost/move/detail/config_begin.hpp>
Chris@101: #include <boost/move/detail/iterator_traits.hpp>
Chris@101: #include <boost/move/utility_core.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: //                            move_iterator
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: //! Class template move_iterator is an iterator adaptor with the same behavior
Chris@16: //! as the underlying iterator except that its dereference operator implicitly
Chris@16: //! converts the value returned by the underlying iterator's dereference operator
Chris@16: //! to an rvalue reference. Some generic algorithms can be called with move
Chris@16: //! iterators to replace copying with moving.
Chris@16: template <class It>
Chris@16: class move_iterator
Chris@16: {
Chris@16:    public:
Chris@16:    typedef It                                                              iterator_type;
Chris@101:    typedef typename boost::movelib::iterator_traits<iterator_type>::value_type        value_type;
Chris@16:    #if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES) || defined(BOOST_MOVE_DOXYGEN_INVOKED)
Chris@16:    typedef value_type &&                                                   reference;
Chris@16:    #else
Chris@16:    typedef typename ::boost::move_detail::if_
Chris@16:       < ::boost::has_move_emulation_enabled<value_type>
Chris@16:       , ::boost::rv<value_type>&
Chris@16:       , value_type & >::type                                               reference;
Chris@16:    #endif
Chris@16:    typedef It                                                              pointer;
Chris@101:    typedef typename boost::movelib::iterator_traits<iterator_type>::difference_type   difference_type;
Chris@101:    typedef typename boost::movelib::iterator_traits<iterator_type>::iterator_category iterator_category;
Chris@16: 
Chris@16:    move_iterator()
Chris@16:    {}
Chris@16: 
Chris@16:    explicit move_iterator(It i)
Chris@16:       :  m_it(i)
Chris@16:    {}
Chris@16: 
Chris@16:    template <class U>
Chris@16:    move_iterator(const move_iterator<U>& u)
Chris@16:       :  m_it(u.base())
Chris@16:    {}
Chris@16: 
Chris@16:    iterator_type base() const
Chris@16:    {  return m_it;   }
Chris@16: 
Chris@16:    reference operator*() const
Chris@16:    {
Chris@16:       #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES) || defined(BOOST_MOVE_OLD_RVALUE_REF_BINDING_RULES)
Chris@16:       return *m_it;
Chris@16:       #else
Chris@16:       return ::boost::move(*m_it);
Chris@16:       #endif
Chris@16:    }
Chris@16: 
Chris@16:    pointer   operator->() const
Chris@16:    {  return m_it;   }
Chris@16: 
Chris@16:    move_iterator& operator++()
Chris@16:    {  ++m_it; return *this;   }
Chris@16: 
Chris@16:    move_iterator<iterator_type>  operator++(int)
Chris@16:    {  move_iterator<iterator_type> tmp(*this); ++(*this); return tmp;   }
Chris@16: 
Chris@16:    move_iterator& operator--()
Chris@16:    {  --m_it; return *this;   }
Chris@16: 
Chris@16:    move_iterator<iterator_type>  operator--(int)
Chris@16:    {  move_iterator<iterator_type> tmp(*this); --(*this); return tmp;   }
Chris@16: 
Chris@16:    move_iterator<iterator_type>  operator+ (difference_type n) const
Chris@16:    {  return move_iterator<iterator_type>(m_it + n);  }
Chris@16: 
Chris@16:    move_iterator& operator+=(difference_type n)
Chris@16:    {  m_it += n; return *this;   }
Chris@16: 
Chris@16:    move_iterator<iterator_type>  operator- (difference_type n) const
Chris@16:    {  return move_iterator<iterator_type>(m_it - n);  }
Chris@16: 
Chris@16:    move_iterator& operator-=(difference_type n)
Chris@16:    {  m_it -= n; return *this;   }
Chris@16: 
Chris@16:    reference operator[](difference_type n) const
Chris@16:    {
Chris@16:       #if defined(BOOST_NO_CXX11_RVALUE_REFERENCES) || defined(BOOST_MOVE_OLD_RVALUE_REF_BINDING_RULES)
Chris@16:       return m_it[n];
Chris@16:       #else
Chris@16:       return ::boost::move(m_it[n]);
Chris@16:       #endif
Chris@16:    }
Chris@16: 
Chris@16:    friend bool operator==(const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() == y.base();  }
Chris@16: 
Chris@16:    friend bool operator!=(const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() != y.base();  }
Chris@16: 
Chris@16:    friend bool operator< (const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() < y.base();   }
Chris@16: 
Chris@16:    friend bool operator<=(const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() <= y.base();  }
Chris@16: 
Chris@16:    friend bool operator> (const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() > y.base();  }
Chris@16: 
Chris@16:    friend bool operator>=(const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() >= y.base();  }
Chris@16: 
Chris@16:    friend difference_type operator-(const move_iterator& x, const move_iterator& y)
Chris@16:    {  return x.base() - y.base();   }
Chris@16: 
Chris@16:    friend move_iterator operator+(difference_type n, const move_iterator& x)
Chris@16:    {  return move_iterator(x.base() + n);   }
Chris@16: 
Chris@16:    private:
Chris@16:    It m_it;
Chris@16: };
Chris@16: 
Chris@16: //is_move_iterator
Chris@16: namespace move_detail {
Chris@16: 
Chris@16: template <class I>
Chris@16: struct is_move_iterator
Chris@16: {
Chris@101:    static const bool value = false;
Chris@16: };
Chris@16: 
Chris@16: template <class I>
Chris@16: struct is_move_iterator< ::boost::move_iterator<I> >
Chris@16: {
Chris@101:    static const bool value = true;
Chris@16: };
Chris@16: 
Chris@16: }  //namespace move_detail {
Chris@16: 
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: //                            move_iterator
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: //!
Chris@16: //! <b>Returns</b>: move_iterator<It>(i).
Chris@16: template<class It>
Chris@16: inline move_iterator<It> make_move_iterator(const It &it)
Chris@16: {  return move_iterator<It>(it); }
Chris@16: 
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: //                         back_move_insert_iterator
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: 
Chris@16: //! A move insert iterator that move constructs elements at the
Chris@16: //! back of a container
Chris@16: template <typename C> // C models Container
Chris@16: class back_move_insert_iterator
Chris@16: {
Chris@16:    C* container_m;
Chris@16: 
Chris@16:    public:
Chris@101:    typedef C                           container_type;
Chris@101:    typedef typename C::value_type      value_type;
Chris@101:    typedef typename C::reference       reference;
Chris@101:    typedef typename C::pointer         pointer;
Chris@101:    typedef typename C::difference_type difference_type;
Chris@101:    typedef std::output_iterator_tag    iterator_category;
Chris@16: 
Chris@16:    explicit back_move_insert_iterator(C& x) : container_m(&x) { }
Chris@16: 
Chris@16:    back_move_insert_iterator& operator=(reference x)
Chris@16:    { container_m->push_back(boost::move(x)); return *this; }
Chris@16: 
Chris@16:    back_move_insert_iterator& operator=(BOOST_RV_REF(value_type) x)
Chris@16:    {  reference rx = x; return this->operator=(rx);  }
Chris@16: 
Chris@16:    back_move_insert_iterator& operator*()     { return *this; }
Chris@16:    back_move_insert_iterator& operator++()    { return *this; }
Chris@16:    back_move_insert_iterator& operator++(int) { return *this; }
Chris@16: };
Chris@16: 
Chris@16: //!
Chris@16: //! <b>Returns</b>: back_move_insert_iterator<C>(x).
Chris@16: template <typename C> // C models Container
Chris@16: inline back_move_insert_iterator<C> back_move_inserter(C& x)
Chris@16: {
Chris@16:    return back_move_insert_iterator<C>(x);
Chris@16: }
Chris@16: 
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: //                         front_move_insert_iterator
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: 
Chris@16: //! A move insert iterator that move constructs elements int the
Chris@16: //! front of a container
Chris@16: template <typename C> // C models Container
Chris@16: class front_move_insert_iterator
Chris@16: {
Chris@16:    C* container_m;
Chris@16: 
Chris@16: public:
Chris@101:    typedef C                           container_type;
Chris@101:    typedef typename C::value_type      value_type;
Chris@101:    typedef typename C::reference       reference;
Chris@101:    typedef typename C::pointer         pointer;
Chris@101:    typedef typename C::difference_type difference_type;
Chris@101:    typedef std::output_iterator_tag    iterator_category;
Chris@16: 
Chris@16:    explicit front_move_insert_iterator(C& x) : container_m(&x) { }
Chris@16: 
Chris@16:    front_move_insert_iterator& operator=(reference x)
Chris@16:    { container_m->push_front(boost::move(x)); return *this; }
Chris@16: 
Chris@16:    front_move_insert_iterator& operator=(BOOST_RV_REF(value_type) x)
Chris@16:    {  reference rx = x; return this->operator=(rx);  }
Chris@16: 
Chris@16:    front_move_insert_iterator& operator*()     { return *this; }
Chris@16:    front_move_insert_iterator& operator++()    { return *this; }
Chris@16:    front_move_insert_iterator& operator++(int) { return *this; }
Chris@16: };
Chris@16: 
Chris@16: //!
Chris@16: //! <b>Returns</b>: front_move_insert_iterator<C>(x).
Chris@16: template <typename C> // C models Container
Chris@16: inline front_move_insert_iterator<C> front_move_inserter(C& x)
Chris@16: {
Chris@16:    return front_move_insert_iterator<C>(x);
Chris@16: }
Chris@16: 
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: //
Chris@16: //                         insert_move_iterator
Chris@16: //
Chris@16: //////////////////////////////////////////////////////////////////////////////
Chris@16: template <typename C> // C models Container
Chris@16: class move_insert_iterator
Chris@16: {
Chris@16:    C* container_m;
Chris@16:    typename C::iterator pos_;
Chris@16: 
Chris@16:    public:
Chris@101:    typedef C                           container_type;
Chris@101:    typedef typename C::value_type      value_type;
Chris@101:    typedef typename C::reference       reference;
Chris@101:    typedef typename C::pointer         pointer;
Chris@101:    typedef typename C::difference_type difference_type;
Chris@101:    typedef std::output_iterator_tag    iterator_category;
Chris@16: 
Chris@16:    explicit move_insert_iterator(C& x, typename C::iterator pos)
Chris@16:       : container_m(&x), pos_(pos)
Chris@16:    {}
Chris@16: 
Chris@16:    move_insert_iterator& operator=(reference x)
Chris@16:    {
Chris@16:       pos_ = container_m->insert(pos_, ::boost::move(x));
Chris@16:       ++pos_;
Chris@16:       return *this;
Chris@16:    }
Chris@16: 
Chris@16:    move_insert_iterator& operator=(BOOST_RV_REF(value_type) x)
Chris@16:    {  reference rx = x; return this->operator=(rx);  }
Chris@16: 
Chris@16:    move_insert_iterator& operator*()     { return *this; }
Chris@16:    move_insert_iterator& operator++()    { return *this; }
Chris@16:    move_insert_iterator& operator++(int) { return *this; }
Chris@16: };
Chris@16: 
Chris@16: //!
Chris@16: //! <b>Returns</b>: move_insert_iterator<C>(x, it).
Chris@16: template <typename C> // C models Container
Chris@16: inline move_insert_iterator<C> move_inserter(C& x, typename C::iterator it)
Chris@16: {
Chris@16:    return move_insert_iterator<C>(x, it);
Chris@16: }
Chris@16: 
Chris@16: }  //namespace boost {
Chris@16: 
Chris@16: #include <boost/move/detail/config_end.hpp>
Chris@16: 
Chris@16: #endif //#ifndef BOOST_MOVE_ITERATOR_HPP