lyx_mirror/src/TocBackend.h
Lars Gullik Bjønnes 26f336769a Remove warnings reported with gcc 4.3:
- Modifier on return type ignored
	- Ambigous else
	- Ambigous logical operators
	- Semi-colon instead of empty block
	- Missing header files
	- Missing using std::XX
	- Initialization out of order


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@20304 a592a061-630c-0410-9148-cb99ea01b6c8
2007-09-16 10:36:57 +00:00

141 lines
2.3 KiB
C++

// -*- C++ -*-
/**
* \file TocBackend.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Jean-Marc Lasgouttes
* \author Angus Leeming
* \author Abdelrazak Younes
*
* Full author contact details are available in file CREDITS.
*
* TocBackend mainly used in toc.[Ch]
*/
#ifndef TOC_BACKEND_H
#define TOC_BACKEND_H
#include <map>
#include <vector>
#include <string>
#include "ParIterator.h"
#include "support/docstream.h"
namespace lyx {
class Buffer;
class FuncRequest;
///
/**
*/
class TocItem
{
friend class TocBackend;
public:
/// Default constructor for STL containers.
TocItem() {}
///
TocItem(ParConstIterator const & par_it,
int depth,
docstring const & s
);
///
~TocItem() {}
///
int id() const;
///
int depth() const;
///
docstring const & str() const;
///
docstring const asString() const;
/// the action corresponding to the goTo above
FuncRequest action() const;
protected:
/// Current position of item.
ParConstIterator par_it_;
/// nesting depth
int depth_;
/// Full item string
docstring str_;
};
///
typedef std::vector<TocItem> Toc;
typedef Toc::const_iterator TocIterator;
/// The ToC list.
/// A class and no typedef because we want to forward declare it.
class TocList : public std::map<std::string, Toc>
{
};
///
/**
*/
class TocBackend
{
public:
///
TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
///
~TocBackend() {}
///
void setBuffer(Buffer const * buffer)
{ buffer_ = buffer; }
///
void update();
///
void updateItem(ParConstIterator const & pit);
///
TocList const & tocs() const
{ return tocs_; }
///
Toc const & toc(std::string const & type) const;
/// Return the first Toc Item before the cursor
TocIterator const item(
std::string const & type, ///< Type of Toc.
ParConstIterator const & ///< The cursor location in the document.
) const;
void writePlaintextTocList(std::string const & type, odocstream & os) const;
private:
///
TocList tocs_;
///
Buffer const * buffer_;
}; // TocBackend
inline
bool operator==(TocItem const & a, TocItem const & b)
{
return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth();
}
inline
bool operator!=(TocItem const & a, TocItem const & b)
{
return !(a == b);
}
} // namespace lyx
#endif // TOC_BACKEND_H