include/wipal/tool/valued_iterator.hh

/*
 * WiPal - A library and a set of tools to manipulate wireless traces.
 * Copyright (C) 2007, 2008, 2009  Universite Pierre et Marie Curie - Paris 6
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301  USA
 *
 * Author: Thomas Claveirole <thomas.claveirole@lip6.fr>
 */
#ifndef TOOL_VALUED_ITERATOR_HH_
# define TOOL_VALUED_ITERATOR_HH_

# include <boost/optional.hpp>

# include <wipal/tool/iterator.hh>

namespace wpl
{

  namespace tool
  {

    /*---------------------.
    | Forward declarations |
    `---------------------*/

    template <class B>
    struct valued_iterator;


    /*--------------.
    | Virtual types |
    `--------------*/

    template <class B>
    struct types< valued_iterator<B> >
    {
      typedef undefined_type    value_type;

      typedef undefined_type    iterable_type;
    };

    /*-------------.
    | Declarations |
    `-------------*/

    template <class Bottom>
    struct valued_iterator: WP_INHERIT(public iterator, valued_iterator<Bottom>)
    {


      typedef WP_GET_EXACT(Bottom, valued_iterator<Bottom>)     exact_type;
      typedef iterator<exact_type>                              super_type;
      typedef WP_TYPE(value_type, exact_type)                   value_type;


      const value_type&         get() const;
      value_type&               get();


      const value_type*         get_ptr() const;
      value_type*               get_ptr();

    protected:

      ~valued_iterator();

      typedef typename boost::optional<value_type>      optional_value;


      const optional_value&     value() const;
      optional_value&           value();

    private:

      optional_value            v_;

    };

  } // End of namespace wpl::tool.

} // End of namespace wpl.

# include "valued_iterator.hxx"

#endif // ! TOOL_VALUED_ITERATOR_HH_

---