complex_iterator_base.hh

// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, version 2 of the License.
//
// Olena is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH
# define MLN_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH

# include <iosfwd>
# include <iostream>

# include <mln/core/concept/iterator.hh>
# include <mln/topo/complex.hh>


namespace mln
{

  namespace topo
  {

    namespace internal
    {

      template <typename F, typename E>
      class complex_iterator_base : public Iterator<E>
      {
        typedef complex_iterator_base<F, E> self_;

      public:
        typedef F face;

        const face& subject() const;
        operator const F&() const;

      protected:
        face f_;
      };


      template <typename F, typename E>
      inline
      std::ostream&
      operator<<(std::ostream& ostr, const complex_iterator_base<F, E>& p);



# ifndef MLN_INCLUDE_ONLY

      template <typename F, typename E>
      inline
      const F&
      complex_iterator_base<F, E>::subject() const
      {
        return f_;
      }

      template <typename F, typename E>
      inline
      complex_iterator_base<F, E>::operator const F& () const
      {
        return f_;
      }


      template <typename F, typename E>
      inline
      std::ostream&
      operator<<(std::ostream& ostr, const complex_iterator_base<F, E>& p)
      {
        return ostr << F(p);
      }

# endif // ! MLN_INCLUDE_ONLY

    } // end of namespace mln::topo::internal

  } // end of namespace mln::topo

} // end of namespace mln

#endif // ! MLN_TOPO_INTERNAL_COMPLEX_ITERATOR_BASE_HH