lyx_mirror/src/ParIterator.h
Pavel Sanda 154319d063 Remove some header leftovers based on Scott's script hints.
False positive rate of hints is quite high. Although the includes can be
technically removed (due to other includes) they logically belong to the
header.
2013-05-02 00:30:16 -07:00

124 lines
2.8 KiB
C++

// -*- C++ -*-
/* \file ParIterator.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author unknown
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef PARITERATOR_H
#define PARITERATOR_H
#include "DocIterator.h"
#include "support/types.h"
namespace lyx {
class Buffer;
class Inset;
class Text;
class ParagraphList;
class ParIterator : public std::iterator<std::forward_iterator_tag, Paragraph>,
public DocIterator
{
public:
typedef std::iterator<std::forward_iterator_tag, Paragraph> StdIt;
typedef StdIt::value_type value_type;
typedef StdIt::difference_type difference_type;
typedef StdIt::pointer pointer;
typedef StdIt::reference reference;
///
///
ParIterator(Buffer * buf) : DocIterator(buf) {}
///
ParIterator(Buffer * buf, Inset &, pit_type pit);
///
ParIterator(ParIterator const &);
///
explicit ParIterator(DocIterator const &);
/// This really should be implemented...
//ParIterator & operator=(ParIterator const &);
///
ParIterator & operator++();
///
ParIterator operator++(int);
/// See comment in ParIterator.cpp
//ParIterator & operator--();
///
Paragraph & operator*() const;
///
Paragraph * operator->() const;
/// This gives us the top-most parent paragraph
pit_type outerPar() const;
///
pit_type pit() const;
///
/// return the paragraph this cursor is in
pit_type & pit() { return DocIterator::pit(); }
ParagraphList & plist() const;
};
ParIterator par_iterator_begin(Inset & inset);
ParIterator par_iterator_end(Inset & inset);
///
//bool operator==(ParIterator const & it1, ParIterator const & it2);
// FIXME: Unfortunately operator!=(ParIterator &, ParIterator &) is
// implemented with operator!=(DocIterator &, DocIterator &) that gives
// false if the positions are different, even if the pars are the same.
// So ultimately it's a bug in operator!=(ParIterator &, ParIterator &)
// I'd say (nevertheless, I would be reluctant to change it, because I
// fear that some part of the code could rely on this "bug". --Alfredo
//bool operator!=(ParIterator const & it1, ParIterator const & it2);
class ParConstIterator : public std::iterator<std::forward_iterator_tag,
Paragraph>,
public DocIterator
{
public:
///
ParConstIterator(Buffer const * buf);
///
ParConstIterator(ParConstIterator const &);
///
explicit ParConstIterator(DocIterator const &);
///
void push_back(Inset const &);
ParConstIterator & operator++();
///
ParConstIterator & operator--();
///
Paragraph const & operator*() const;
///
Paragraph const * operator->() const;
///
ParagraphList const & plist() const;
};
//bool operator==(ParConstIterator const & it1, ParConstIterator const & it2);
//bool operator!=(ParConstIterator const & it1, ParConstIterator const & it2);
} // namespace lyx
#endif