X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetIndex.cpp;h=86da890e02dab8654dad6a399eb7f88f1239cb87;hb=5eb7add4092708a5a0dbabf303164be624aff72f;hp=27ed354e41f663c3e1278980cd9e343387a1f0cd;hpb=82c7e15e6444a8566a9b7b8053b830d03058383e;p=lyx.git

diff --git a/src/insets/InsetIndex.cpp b/src/insets/InsetIndex.cpp
index 27ed354e41..86da890e02 100644
--- a/src/insets/InsetIndex.cpp
+++ b/src/insets/InsetIndex.cpp
@@ -16,6 +16,7 @@
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "ColorSet.h"
+#include "Cursor.h"
 #include "DispatchResult.h"
 #include "Encoding.h"
 #include "FuncRequest.h"
@@ -23,8 +24,10 @@
 #include "IndicesList.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "MetricsInfo.h"
+#include "output_latex.h"
+#include "output_xhtml.h"
 #include "sgml.h"
+#include "TextClass.h"
 #include "TocBackend.h"
 
 #include "support/debug.h"
@@ -35,6 +38,7 @@
 #include "frontends/alert.h"
 
 #include <ostream>
+#include <algorithm>
 
 using namespace std;
 using namespace lyx::support;
@@ -151,15 +155,19 @@ int InsetIndex::latex(odocstream & os,
 				subst(spart2, from_ascii("\\"), docstring());
 			os << ppart;
 			os << '@';
+			i += count_char(ppart, '\n');
 		}
 		docstring const tpart = *it;
 		os << tpart;
+		i += count_char(tpart, '\n');
 		if (it2 < levels_plain.end())
 			++it2;
 	}
 	// write the bit that followed "|"
-	if (!cmd.empty())
+	if (!cmd.empty()) {
 		os << "|" << cmd;
+		i += count_char(cmd, '\n');
+	}
 	os << '}';
 	return i;
 }
@@ -174,8 +182,13 @@ int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
 }
 
 
-docstring InsetIndex::xhtml(odocstream &, OutputParams const &) const
+docstring InsetIndex::xhtml(XHTMLStream & xs, OutputParams const &) const
 {
+	// we just print an anchor, taking the paragraph ID from 
+	// our own interior paragraph, which doesn't get printed
+	std::string const magic = paragraphs().front().magicLabel();
+	std::string const attr = "id='" + magic + "'";
+	xs << html::CompTag("a", attr);
 	return docstring();
 }
 
@@ -190,16 +203,20 @@ bool InsetIndex::showInsetDialog(BufferView * bv) const
 
 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY: {
 		if (cmd.getArg(0) == "changetype") {
+			cur.recordUndoInset(ATOMIC_UNDO, this);
 			params_.index = from_utf8(cmd.getArg(1));
 			break;
 		}
 		InsetIndexParams params;
 		InsetIndex::string2params(to_utf8(cmd.argument()), params);
 		params_.index = params.index;
+		// what we really want here is a TOC update, but that means
+		// a full buffer update
+		cur.forceBufferUpdate();
 		break;
 	}
 
@@ -217,7 +234,7 @@ void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 		FuncStatus & flag) const
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY:
 		if (cmd.getArg(0) == "changetype") {
@@ -245,16 +262,6 @@ bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-docstring const InsetIndex::buttonLabel(BufferView const & bv) const
-{
-	docstring s = _("Idx");
-	if (decoration() == InsetLayout::CLASSIC)
-		return isOpen(bv) ? s : getNewLabel(s);
-	else
-		return getNewLabel(s);
-}
-
-
 ColorCode InsetIndex::labelColor() const
 {
 	if (params_.index.empty() || params_.index == from_ascii("idx"))
@@ -282,11 +289,30 @@ docstring InsetIndex::toolTip(BufferView const &, int, int) const
 		tip += ")";
 	}
 	tip += ": ";
-	OutputParams rp(&buffer().params().encoding());
-	odocstringstream ods;
-	InsetText::plaintext(ods, rp);
-	tip += ods.str();
-	return wrapParas(tip);
+	return toolTipText(tip);
+}
+
+
+docstring const InsetIndex::buttonLabel(BufferView const & bv) const
+{
+	InsetLayout const & il = getLayout();
+	docstring label = translateIfPossible(il.labelstring());
+
+	if (buffer().params().use_indices && !params_.index.empty()) {
+		Buffer const & realbuffer = *buffer().masterBuffer();
+		IndicesList const & indiceslist = realbuffer.params().indiceslist();
+		label += " (";
+		Index const * index = indiceslist.findShortcut(params_.index);
+		if (!index)
+			label += _("unknown type!");
+		else
+			label += index->index();
+		label += ")";
+	}
+
+	if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
+		return label;
+	return getNewLabel(label);
 }
 
 
@@ -346,6 +372,7 @@ void InsetIndex::validate(LaTeXFeatures & features) const
 	    && !params_.index.empty()
 	    && params_.index != "idx")
 		features.require("splitidx");
+	InsetCollapsable::validate(features);
 }
 
 
@@ -396,8 +423,8 @@ void InsetIndexParams::read(Lexer & lex)
 //
 ///////////////////////////////////////////////////////////////////////
 
-InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
-	: InsetCommand(p, "index_print")
+InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
+	: InsetCommand(buf, p)
 {}
 
 
@@ -425,7 +452,7 @@ docstring InsetPrintIndex::screenLabel() const
 	Index const * index = indiceslist.findShortcut(getParam("type"));
 	if (!index && !printall)
 		return _("Unknown index type!");
-	docstring res = printall ? _("All indices") : index->index();
+	docstring res = printall ? _("All indexes") : index->index();
 	if (!multind)
 		res += " (" + _("non-active") + ")";
 	else if (contains(getCmdName(), "printsubindex"))
@@ -443,7 +470,7 @@ bool InsetPrintIndex::isCompatibleCommand(string const & s)
 
 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY: {
 		if (cmd.argument() == from_ascii("toggle-subindex")) {
@@ -452,6 +479,7 @@ void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 				cmd = subst(cmd, "printindex", "printsubindex");
 			else
 				cmd = subst(cmd, "printsubindex", "printindex");
+			cur.recordUndo();
 			setCmdName(cmd);
 			break;
 		} else if (cmd.argument() == from_ascii("check-printindex*")) {
@@ -459,16 +487,16 @@ void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 			if (suffixIs(cmd, '*'))
 				break;
 			cmd += '*';
+			cur.recordUndo();
 			setParam("type", docstring());
 			setCmdName(cmd);
 			break;
 		}
 		InsetCommandParams p(INDEX_PRINT_CODE);
 		// FIXME UNICODE
-		InsetCommand::string2params("index_print",
-			to_utf8(cmd.argument()), p);
+		InsetCommand::string2params(to_utf8(cmd.argument()), p);
 		if (p.getCmdName().empty()) {
-			cur.noUpdate();
+			cur.noScreenUpdate();
 			break;
 		}
 		setParams(p);
@@ -485,7 +513,7 @@ void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 	FuncStatus & status) const
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY: {
 		if (cmd.argument() == from_ascii("toggle-subindex")) {
@@ -499,8 +527,7 @@ bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 		} if (cmd.getArg(0) == "index_print"
 		    && cmd.getArg(1) == "CommandInset") {
 			InsetCommandParams p(INDEX_PRINT_CODE);
-			InsetCommand::string2params("index_print",
-				to_utf8(cmd.argument()), p);
+			InsetCommand::string2params(to_utf8(cmd.argument()), p);
 			if (suffixIs(p.getCmdName(), '*')) {
 				status.setEnabled(true);
 				status.setOnOff(false);
@@ -528,14 +555,15 @@ bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
+int InsetPrintIndex::latex(odocstream & os, OutputParams const & runparams_in) const
 {
 	if (!buffer().masterBuffer()->params().use_indices) {
 		if (getParam("type") == from_ascii("idx"))
 			os << "\\printindex{}";
 		return 0;
 	}
-	os << getCommand();
+	OutputParams runparams = runparams_in;
+	os << getCommand(runparams);
 	return 0;
 }
 
@@ -560,9 +588,283 @@ bool InsetPrintIndex::hasSettings() const
 	return buffer().masterBuffer()->params().use_indices;
 }
 
-docstring InsetPrintIndex::xhtml(odocstream &, OutputParams const &) const
+
+namespace {
+
+void parseItem(docstring & s, bool for_output)
 {
-	return docstring();
+	// this does not yet check for escaped things
+	size_type loc = s.find(from_ascii("@"));
+	if (loc != string::npos) {
+		if (for_output)
+			s.erase(0, loc + 1);
+		else
+			s.erase(loc);
+	}
+	loc = s.find(from_ascii("|"));
+	if (loc != string::npos)
+		s.erase(loc);
+}
+
+	
+void extractSubentries(docstring const & entry, docstring & main,
+		docstring & sub1, docstring & sub2)
+{
+	if (entry.empty())
+		return;
+	size_type const loc = entry.find(from_ascii(" ! "));
+	if (loc == string::npos)
+		main = entry;
+	else {
+		main = trim(entry.substr(0, loc));
+		size_t const locend = loc + 3;
+		size_type const loc2 = entry.find(from_ascii(" ! "), locend);
+		if (loc2 == string::npos) {
+			sub1 = trim(entry.substr(locend));
+		} else {
+			sub1 = trim(entry.substr(locend, loc2 - locend));
+			sub2 = trim(entry.substr(loc2 + 3));
+		}
+	}
+}
+
+
+struct IndexEntry
+{
+	IndexEntry() 
+	{}
+	
+	IndexEntry(docstring const & s, DocIterator const & d) 
+			: dit(d)
+	{
+		extractSubentries(s, main, sub, subsub);
+		parseItem(main, false);
+		parseItem(sub, false);
+		parseItem(subsub, false);
+	}
+	
+	bool equal(IndexEntry const & rhs) const
+	{
+		return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
+	}
+	
+	bool same_sub(IndexEntry const & rhs) const
+	{
+		return main == rhs.main && sub == rhs.sub;
+	}
+	
+	bool same_main(IndexEntry const & rhs) const
+	{
+		return main == rhs.main;
+	}
+	
+	docstring main;
+	docstring sub;
+	docstring subsub;
+	DocIterator dit;
+};
+
+bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
+{
+	return lhs.main < rhs.main
+			|| (lhs.main == rhs.main && lhs.sub < rhs.sub)
+			|| (lhs.main == rhs.main && lhs.sub == rhs.sub && lhs.subsub < rhs.subsub);
+}
+
+} // anon namespace
+
+
+docstring InsetPrintIndex::xhtml(XHTMLStream &, OutputParams const & op) const
+{
+	BufferParams const & bp = buffer().masterBuffer()->params();
+
+	// we do not presently support multiple indices, so we refuse to print
+	// anything but the main index, so as not to generate multiple indices.
+	// NOTE Multiple index support would require some work. The reason
+	// is that the TOC does not know about multiple indices. Either it would
+	// need to be told about them (not a bad idea), or else the index entries
+	// would need to be collected differently, say, during validation.
+	if (bp.use_indices && getParam("type") != from_ascii("idx"))
+		return docstring();
+	
+	Toc const & toc = buffer().tocBackend().toc("index");
+	if (toc.empty())
+		return docstring();
+
+	// Collection the index entries in a form we can use them.
+	Toc::const_iterator it = toc.begin();
+	Toc::const_iterator const en = toc.end();
+	vector<IndexEntry> entries;
+	for (; it != en; ++it)
+		entries.push_back(IndexEntry(it->str(), it->dit()));
+	stable_sort(entries.begin(), entries.end());
+
+	Layout const & lay = bp.documentClass().htmlTOCLayout();
+	string const & tocclass = 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);
+
+	xs << html::StartTag("div", "class='index'");
+	xs << html::StartTag(lay.htmltag(), lay.htmlattr()) 
+		 << _("Index") 
+		 << html::EndTag(lay.htmltag());
+	xs << html::StartTag("ul", "class='main'");
+	Font const dummy;
+
+	vector<IndexEntry>::const_iterator eit = entries.begin();
+	vector<IndexEntry>::const_iterator const een = entries.end();
+	// tracks whether we are already inside a main entry (1),
+	// a sub-entry (2), or a sub-sub-entry (3). see below for the
+	// details.
+	int level = 1;
+	// the last one we saw
+	IndexEntry last;
+	int entry_number = -1;
+	for (; eit != een; ++eit) {
+		Paragraph const & par = eit->dit.innerParagraph();
+		if (entry_number == -1 || !eit->equal(last)) {
+			if (entry_number != -1) {
+				// not the first time through the loop, so
+				// close last entry or entries, depending.
+				if (level == 3) {
+					// close this sub-sub-entry
+					xs << html::EndTag("li");
+					xs.cr();
+					// is this another sub-sub-entry within the same sub-entry?
+					if (!eit->same_sub(last)) {
+						// close this level
+						xs << html::EndTag("ul");
+						xs.cr();
+						level = 2;
+					}
+				}
+				// the point of the second test here is that we might get
+				// here two ways: (i) by falling through from above; (ii) because,
+				// though the sub-entry hasn't changed, the sub-sub-entry has,
+				// which means that it is the first sub-sub-entry within this
+				// sub-entry. In that case, we do not want to close anything.
+				if (level == 2 && !eit->same_sub(last)) {
+					// close sub-entry 
+					xs << html::EndTag("li");
+					xs.cr();
+					// is this another sub-entry with the same main entry?
+					if (!eit->same_main(last)) {
+						// close this level
+						xs << html::EndTag("ul");
+						xs.cr();
+						level = 1;
+					}
+				}
+				// again, we can get here two ways: from above, or because we have
+				// found the first sub-entry. in the latter case, we do not want to
+				// close the entry.
+				if (level == 1 && !eit->same_main(last)) {
+					// close entry
+					xs << html::EndTag("li");
+					xs.cr();
+				}
+			}
+
+			// we'll be starting new entries
+			entry_number = 0;
+
+			// We need to use our own stream, since we will have to
+			// modify what we get back.
+			odocstringstream ent;
+			XHTMLStream entstream(ent);
+			OutputParams ours = op;
+			ours.for_toc = true;
+			par.simpleLyXHTMLOnePar(buffer(), entstream, ours, dummy);
+	
+			// these will contain XHTML versions of the main entry, etc
+			// remember that everything will already have been escaped,
+			// so we'll need to use NextRaw() during output.
+			docstring main;
+			docstring sub;
+			docstring subsub;
+			extractSubentries(ent.str(), main, sub, subsub);
+			parseItem(main, true);
+			parseItem(sub, true);
+			parseItem(subsub, true);
+	
+			if (level == 3) {
+				// another subsubentry
+				xs << html::StartTag("li", "class='subsubentry'") 
+				   << XHTMLStream::ESCAPE_NONE << subsub;
+			} else if (level == 2) {
+				// there are two ways we can be here: 
+				// (i) we can actually be inside a sub-entry already and be about
+				//     to output the first sub-sub-entry. in this case, our sub
+				//     and the last sub will be the same.
+				// (ii) we can just have closed a sub-entry, possibly after also
+				//     closing a list of sub-sub-entries. here our sub and the last
+				//     sub are different.
+				// only in the latter case do we need to output the new sub-entry.
+				// note that in this case, too, though, the sub-entry might already
+				// have a sub-sub-entry.
+				if (eit->sub != last.sub)
+					xs << html::StartTag("li", "class='subentry'") 
+					   << XHTMLStream::ESCAPE_NONE << sub;
+				if (!subsub.empty()) {
+					// it's actually a subsubentry, so we need to start that list
+					xs.cr();
+					xs << html::StartTag("ul", "class='subsubentry'") 
+					   << html::StartTag("li", "class='subsubentry'") 
+					   << XHTMLStream::ESCAPE_NONE << subsub;
+					level = 3;
+				} 
+			} else {
+				// there are also two ways we can be here: 
+				// (i) we can actually be inside an entry already and be about
+				//     to output the first sub-entry. in this case, our main
+				//     and the last main will be the same.
+				// (ii) we can just have closed an entry, possibly after also
+				//     closing a list of sub-entries. here our main and the last
+				//     main are different.
+				// only in the latter case do we need to output the new main entry.
+				// note that in this case, too, though, the main entry might already
+				// have a sub-entry, or even a sub-sub-entry.
+				if (eit->main != last.main)
+					xs << html::StartTag("li", "class='main'") << main;
+				if (!sub.empty()) {
+					// there's a sub-entry, too
+					xs.cr();
+					xs << html::StartTag("ul", "class='subentry'") 
+					   << html::StartTag("li", "class='subentry'") 
+					   << XHTMLStream::ESCAPE_NONE << sub;
+					level = 2;
+					if (!subsub.empty()) {
+						// and a sub-sub-entry
+						xs.cr();
+						xs << html::StartTag("ul", "class='subsubentry'") 
+						   << html::StartTag("li", "class='subsubentry'") 
+						   << XHTMLStream::ESCAPE_NONE << subsub;
+						level = 3;
+					}
+				} 
+			}
+		}
+		// finally, then, we can output the index link itself
+		string const parattr = "href='#" + par.magicLabel() + "'";
+		xs << (entry_number == 0 ? ":" : ",");
+		xs << " " << html::StartTag("a", parattr)
+		   << ++entry_number << html::EndTag("a");
+		last = *eit;
+	}
+	// now we have to close all the open levels
+	while (level > 0) {
+		xs << html::EndTag("li") << html::EndTag("ul");
+		xs.cr();
+		--level;
+	}
+	xs << html::EndTag("div");
+	xs.cr();
+	return ods.str();
 }
 
 } // namespace lyx