source: trunk/yat/utility/GetlineIterator.h @ 1878

#ifndef _theplu_yat_utility_getline_iterator_
#define _theplu_yat_utility_getline_iterator_

// $Id: GetlineIterator.h 1878 2009-03-27 11:52:28Z peter $

/*
  Copyright (C) 2009 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library 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 3 of the
  License, or (at your option) any later version.

  The yat library 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include <boost/iterator/iterator_facade.hpp>

#include <iterator>
#include <string>

namespace theplu {
namespace yat {
namespace utility {

  /**
     \brief Read from std::istream with std::getline.

     An GetlineIterator is an \input_iterator similar to
     std::istream_iterator that can be used to read from an \c
     istream. The main difference is that GetlineIterator reads from
     the istream using \c std::getline rather than \c operator>>. \c
     value_type is std::string and \c operator* returns \c const \c
     std::string&. When end of stream is reached iterator gets into a
     special state \a end \a of \a stream. Two iterators are equal if
     they are \a end \a of \a stream or if they are pointing to the
     same stream (and not being \a end \a of \a stream).

     Here is an example copying lines in a file to a \c vector<std::string>:
     \code
     std::ifstream is("file.txt");
     std::vector<std::std::string> vec;
     GetlineIterator begin(is);
     GetlineIterator end;
     std::copy(begin, end, std::back_inserter(vec));
     \endcode
  */
  class GetlineIterator
    : public boost::iterator_facade<
    GetlineIterator, const std::string, std::input_iterator_tag
    >
  {
  public:
    /**
       \brief Constructor of end of stream iterator
    */
    GetlineIterator(void);

    /**
       \brief Constructor
       
       \param is istream to extract string elements from.
       \param delimiter the delimiting character. 
    */
    GetlineIterator(std::istream& is, char delimiter='\n');

  private:
    friend class boost::iterator_core_access;

    char delimiter_;
    std::istream* istream_;
    std::string line_;

    GetlineIterator::reference dereference(void) const; 

    bool equal(const GetlineIterator& other) const;

    void increment(void); 

    // Using compiler generated copy
    //GetlineIterator(const GetlineIterator&);
    //GetlineIterator& operator=(const GetlineIterator&);
  };

}}} // of namespace utility, yat, and theplu

#endif