lyx_mirror/src/TocBackend.cpp

250 lines
5.8 KiB
C++
Raw Normal View History

/**
* \file TocBackend.cpp
* 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.
*/
#include <config.h>
#include "TocBackend.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "FloatList.h"
#include "FuncRequest.h"
#include "InsetList.h"
#include "Layout.h"
#include "LyXAction.h"
#include "Paragraph.h"
#include "TextClass.h"
#include "insets/InsetOptArg.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/docstream.h"
#include <boost/assert.hpp>
using namespace std;
namespace lyx {
///////////////////////////////////////////////////////////////////////////
//
// TocItem implementation
//
///////////////////////////////////////////////////////////////////////////
TocItem::TocItem(ParConstIterator const & par_it, int d, docstring const & s)
: par_it_(par_it), depth_(d), str_(s)
{
}
int TocItem::id() const
{
return par_it_->id();
}
int TocItem::depth() const
{
return depth_;
}
docstring const & TocItem::str() const
{
return str_;
}
docstring const TocItem::asString() const
{
return docstring(4 * depth_, ' ') + str_;
}
FuncRequest TocItem::action() const
{
return FuncRequest(LFUN_PARAGRAPH_GOTO, convert<string>(id()));
}
///////////////////////////////////////////////////////////////////////////
//
// TocBackend implementation
//
///////////////////////////////////////////////////////////////////////////
Toc const & TocBackend::toc(string const & type) const
{
// Is the type already supported?
TocList::const_iterator it = tocs_.find(type);
BOOST_ASSERT(it != tocs_.end());
return it->second;
}
Toc & TocBackend::toc(string const & type)
{
return tocs_[type];
}
void TocBackend::updateItem(ParConstIterator const & par_it)
{
if (toc("tableofcontents").empty()) {
// FIXME: should not happen,
// a call to TocBackend::update() is missing somewhere
LYXERR0("TocBackend::updateItem called but the TOC is empty!");
return;
}
BufferParams const & bufparams = buffer_->params();
const int min_toclevel = bufparams.documentClass().min_toclevel();
TocIterator toc_item = item("tableofcontents", par_it);
docstring tocstring;
// For each paragraph, traverse its insets and let them add
// their toc items
InsetList::const_iterator it = toc_item->par_it_->insetList().begin();
InsetList::const_iterator end = toc_item->par_it_->insetList().end();
for (; it != end; ++it) {
Inset & inset = *it->inset;
if (inset.lyxCode() == OPTARG_CODE) {
if (!tocstring.empty())
break;
Paragraph const & par =
*static_cast<InsetOptArg&>(inset).paragraphs().begin();
if (!toc_item->par_it_->labelString().empty())
tocstring = toc_item->par_it_->labelString() + ' ';
tocstring += par.asString(false);
break;
}
}
int const toclevel = toc_item->par_it_->layout().toclevel;
if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
&& tocstring.empty())
tocstring = toc_item->par_it_->asString(true);
const_cast<TocItem &>(*toc_item).str_ = tocstring;
}
void TocBackend::update()
{
tocs_.clear();
BufferParams const & bufparams = buffer_->params();
const int min_toclevel = bufparams.documentClass().min_toclevel();
Toc & toc = tocs_["tableofcontents"];
ParConstIterator pit = buffer_->par_iterator_begin();
ParConstIterator end = buffer_->par_iterator_end();
for (; pit != end; ++pit) {
// the string that goes to the toc (could be the optarg)
docstring tocstring;
// For each paragraph, traverse its insets and let them add
// their toc items
InsetList::const_iterator it = pit->insetList().begin();
InsetList::const_iterator end = pit->insetList().end();
for (; it != end; ++it) {
Inset & inset = *it->inset;
//lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
inset.addToToc(pit);
switch (inset.lyxCode()) {
case OPTARG_CODE: {
if (!tocstring.empty())
break;
Paragraph const & par =
*static_cast<InsetOptArg&>(inset).paragraphs().begin();
if (!pit->labelString().empty())
tocstring = pit->labelString() + ' ';
tocstring += par.asString(false);
break;
}
default:
break;
}
}
/// now the toc entry for the paragraph
int const toclevel = pit->layout().toclevel;
if (toclevel != Layout::NOT_IN_TOC
&& toclevel >= min_toclevel) {
// insert this into the table of contents
if (tocstring.empty())
tocstring = pit->asString(true);
toc.push_back(TocItem(pit, toclevel - min_toclevel,
tocstring));
}
}
}
TocIterator TocBackend::item(string const & type,
ParConstIterator const & par_it) const
{
TocList::const_iterator toclist_it = tocs_.find(type);
// Is the type supported?
BOOST_ASSERT(toclist_it != tocs_.end());
Toc const & toc_vector = toclist_it->second;
TocIterator last = toc_vector.begin();
TocIterator it = toc_vector.end();
if (it == last)
return it;
--it;
ParConstIterator par_it_text = par_it;
if (par_it_text.inMathed()) {
// We are only interested in text so remove the math CursorSlice.
while (par_it_text.inMathed())
par_it_text.pop_back();
}
for (; it != last; --it) {
// We verify that we don't compare contents of two
// different document. This happens when you
// have parent and child documents.
if (&it->par_it_[0].inset() != &par_it_text[0].inset())
continue;
if (it->par_it_ <= par_it_text)
return it;
}
// We are before the first Toc Item:
return last;
}
void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
{
TocList::const_iterator cit = tocs_.find(type);
if (cit != tocs_.end()) {
TocIterator ccit = cit->second.begin();
TocIterator end = cit->second.end();
for (; ccit != end; ++ccit)
os << ccit->asString() << from_utf8("\n");
}
}
} // namespace lyx