lyx_mirror/src/insets/InsetTOC.cpp

/**
 * \file InsetTOC.cpp
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Lars Gullik Bjønnes
 *
 * Full author contact details are available in file CREDITS.
 */

#include <config.h>

#include "InsetTOC.h"

#include "Buffer.h"
#include "BufferParams.h"
#include "DispatchResult.h"
#include "FuncRequest.h"
#include "LaTeXFeatures.h"
#include "MetricsInfo.h"
#include "OutputParams.h"
#include "output_xhtml.h"
#include "Paragraph.h"
#include "TextClass.h"
#include "TocBackend.h"

#include "support/debug.h"
#include "support/gettext.h"

#include <ostream>

using namespace std;

namespace lyx {


InsetTOC::InsetTOC(Buffer * buf, InsetCommandParams const & p)
	: InsetCommand(buf, p, "toc")
{}


ParamInfo const & InsetTOC::findInfo(string const & /* cmdName */)
{
	static ParamInfo param_info_;
	if (param_info_.empty()) {
		param_info_.add("type", ParamInfo::LATEX_REQUIRED);
	}
	return param_info_;
}


docstring InsetTOC::screenLabel() const
{
	if (getCmdName() == "tableofcontents")
		return buffer().B_("Table of Contents");
	return _("Unknown TOC type");
}


int InsetTOC::plaintext(odocstream & os, OutputParams const &) const
{
	os << screenLabel() << "\n\n";
	buffer().tocBackend().writePlaintextTocList(getCmdName(), os);
	return PLAINTEXT_NEWLINE;
}


int InsetTOC::docbook(odocstream & os, OutputParams const &) const
{
	if (getCmdName() == "tableofcontents")
		os << "<toc></toc>";
	return 0;
}


docstring InsetTOC::xhtml(XHTMLStream &, OutputParams const & op) const
{
	// we want to look like a chapter, section, or whatever.
	// so we're going to look for the layout with the minimum toclevel
	// number > 0, because we don't want Part. 
	// we'll take the first one, just because.
	// FIXME This could be specified in the layout file.
	DocumentClass const & dc = buffer().params().documentClass();
	TextClass::LayoutList::const_iterator lit = dc.begin();
	TextClass::LayoutList::const_iterator len = dc.end();
	int minlevel = 1000;
	Layout const * lay = NULL;
	for (; lit != len; ++lit) {
		int const level = lit->toclevel;
		if (level > 0 && (level == Layout::NOT_IN_TOC || level >= minlevel))
			continue;
		lay = &*lit;
		minlevel = level;
	}
	
	string const tocclass = lay ? " " + lay->defaultCSSClass(): "";
	string const tocattr = "class='tochead" + tocclass + "'";
	
	// we'll use our own stream, because we are going to defer everything.
	// that's how we deal with the fact that we're probably inside a standard
	// paragraph, and we don't want to be.
	odocstringstream ods;
	XHTMLStream xs(ods);

	string const & cmdname = getCmdName();
	if (cmdname == "tableofcontents") {
		Toc const & toc = buffer().tocBackend().toc("tableofcontents");
		if (toc.empty())
			return docstring();
	
		xs << StartTag("div", "class='toc'");
		xs << StartTag("div", tocattr) 
			 << _("Table of Contents") 
			 << EndTag("div");
		Toc::const_iterator it = toc.begin();
		Toc::const_iterator const en = toc.end();
		int lastdepth = 0;
		for (; it != en; ++it) {
			Paragraph const & par = it->dit().innerParagraph();
			int const depth = it->depth();
			if (depth > buffer().params().tocdepth)
				continue;
			Font const dummy;
			if (depth > lastdepth) {
				xs.cr();
				// open as many tags as we need to open to get to this level
				// this includes the tag for the current level
				for (int i = lastdepth + 1; i <= depth; ++i) {
					stringstream attr;
					attr << "class='lyxtoc-" << i << "'";
					xs << StartTag("div", attr.str());
				}
				lastdepth = depth;
			}
			else if (depth < lastdepth) {
				// close as many as we have to close to get back to this level
				// this includes closing the last tag at this level
				for (int i = lastdepth; i >= depth; --i) 
					xs << EndTag("div");
				// now open our tag
				stringstream attr;
				attr << "class='lyxtoc-" << depth << "'";
				xs << StartTag("div", attr.str());
				lastdepth = depth;
			} else {
				// no change of level, so close and open
				xs << EndTag("div");
				stringstream attr;
				attr << "class='lyxtoc-" << depth << "'";
				xs << StartTag("div", attr.str());
			}
			string const parattr = "href='#" + par.magicLabel() + "' class='tocarrow'";
			par.simpleLyXHTMLOnePar(buffer(), xs, op, dummy, true);
			xs << " ";
			xs << StartTag("a", parattr);
			// FIXME XHTML 
			// There ought to be a simple way to customize this.
			xs << XHTMLStream::NextRaw() << "&seArr;";
			xs << EndTag("a");		
		}
		for (int i = lastdepth; i > 0; --i) 
			xs << EndTag("div");
		xs << EndTag("div");
	}
	return ods.str();
}


} // namespace lyx