window.hh

Go to the documentation of this file.

// window.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 The Vaucanson Group.
//
// 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.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//
#ifndef VCSN_MISC_WINDOW_HH
# define VCSN_MISC_WINDOW_HH

# include <iostream>
# include <string>

namespace vcsn {
  namespace misc {

    template <class InputIterator, class Letter>
    struct Window
    {
        typedef InputIterator                           iterator_t;
        typedef Letter                                  letter_t;
        typedef typename std::basic_string<letter_t>    string_t;
        typedef unsigned int                            length_t;

        Window (const iterator_t& stream,
                const iterator_t& eof,
                letter_t eol,
                length_t length);

        bool            eof () const;
        bool            eol () const;

        void            shift (unsigned int n);
        void            shift ();


        void            moveto (length_t offset);
        void            moveto (iterator_t position);

        length_t        size () const;

        letter_t        operator[] (length_t i) const;

        std::ostream&   print (std::ostream& ostr) const;



        iterator_t      begin () const;
        iterator_t      stream () const;
        iterator_t      end () const;
        size_t          offset () const;
        letter_t        eol_value () const;
        length_t        length () const;
        string_t        window () const;
      protected:
        void            compute_size ();

        iterator_t      begin_;
        iterator_t      stream_;
        iterator_t      end_;
        letter_t        eol_;
        length_t        length_;
        length_t        size_;
    };

    template <class InputIterator, class Letter>
    std::ostream&
    operator<< (std::ostream& ostr, const Window<InputIterator, Letter>& w);

  } // misc
} // vcsn

# if !defined VCSN_USE_INTERFACE_ONLY || defined VCSN_USE_LIB
#  include <vaucanson/misc/window.hxx>
# endif // VCSN_USE_INTERFACE_ONLY

#endif // ! VCSN_MISC_WINDOW_HH