3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jürgen Spitzmüller
9 * Full author contact details are available in file CREDITS.
13 #include "InsetIndex.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
20 #include "DispatchResult.h"
22 #include "FuncRequest.h"
23 #include "FuncStatus.h"
24 #include "IndicesList.h"
26 #include "LaTeXFeatures.h"
28 #include "output_latex.h"
29 #include "output_xhtml.h"
31 #include "texstream.h"
32 #include "TextClass.h"
33 #include "TocBackend.h"
35 #include "support/debug.h"
36 #include "support/docstream.h"
37 #include "support/gettext.h"
38 #include "support/lstrings.h"
40 #include "frontends/alert.h"
46 #include <QThreadStorage>
49 using namespace lyx::support;
53 /////////////////////////////////////////////////////////////////////
57 ///////////////////////////////////////////////////////////////////////
60 InsetIndex::InsetIndex(Buffer * buf, InsetIndexParams const & params)
61 : InsetCollapsible(buf), params_(params)
65 void InsetIndex::latex(otexstream & ios, OutputParams const & runparams_in) const
67 OutputParams runparams(runparams_in);
68 runparams.inIndexEntry = true;
72 if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
73 && params_.index != "idx") {
75 os << escape(params_.index);
82 odocstringstream ourlatex;
83 otexstream ots(ourlatex);
84 InsetText::latex(ots, runparams);
85 if (runparams.for_search) {
86 // No need for special handling, if we are only searching for some patterns
87 os << ourlatex.str() << "}";
90 // get contents of InsetText as LaTeX and plaintext
91 odocstringstream ourplain;
92 InsetText::plaintext(ourplain, runparams);
93 // FIXME: do Tex/Row correspondence (I don't currently understand what is
94 // being generated from latexstr below)
95 docstring latexstr = ourlatex.str();
96 docstring plainstr = ourplain.str();
98 // this will get what follows | if anything does
101 // check for the | separator
102 // FIXME This would go wrong on an escaped "|", but
103 // how far do we want to go here?
104 size_t pos = latexstr.find(from_ascii("|"));
105 if (pos != docstring::npos) {
106 // put the bit after "|" into cmd...
107 cmd = latexstr.substr(pos + 1);
108 // ...and erase that stuff from latexstr
109 latexstr = latexstr.erase(pos);
110 // ...and similarly from plainstr
111 size_t ppos = plainstr.find(from_ascii("|"));
112 if (ppos < plainstr.size())
113 plainstr.erase(ppos);
115 LYXERR0("The `|' separator was not found in the plaintext version!");
118 // Separate the entries and subentries, i.e., split on "!"
119 // FIXME This would do the wrong thing with escaped ! characters
120 std::vector<docstring> const levels =
121 getVectorFromString(latexstr, from_ascii("!"), true);
122 std::vector<docstring> const levels_plain =
123 getVectorFromString(plainstr, from_ascii("!"), true);
125 vector<docstring>::const_iterator it = levels.begin();
126 vector<docstring>::const_iterator end = levels.end();
127 vector<docstring>::const_iterator it2 = levels_plain.begin();
129 for (; it != end; ++it) {
130 // write the separator except the first time
136 // correctly sort macros and formatted strings
137 // if we do find a command, prepend a plain text
138 // version of the content to get sorting right,
139 // e.g. \index{LyX@\LyX}, \index{text@\textbf{text}}
140 // Don't do that if the user entered '@' himself, though.
141 if (contains(*it, '\\') && !contains(*it, '@')) {
142 // Plaintext might return nothing (e.g. for ERTs)
143 docstring const spart =
144 (it2 < levels_plain.end() && !(*it2).empty())
146 // Now we need to validate that all characters in
147 // the sorting part are representable in the current
148 // encoding. If not try the LaTeX macro which might
149 // or might not be a good choice, and issue a warning.
150 pair<docstring, docstring> spart_latexed =
151 runparams.encoding->latexString(spart, runparams.dryrun);
152 if (!spart_latexed.second.empty())
153 LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
154 if (spart != spart_latexed.first && !runparams.dryrun) {
155 // FIXME: warning should be passed to the error dialog
156 frontend::Alert::warning(_("Index sorting failed"),
157 bformat(_("LyX's automatic index sorting algorithm faced\n"
158 "problems with the entry '%1$s'.\n"
159 "Please specify the sorting of this entry manually, as\n"
160 "explained in the User Guide."), spart));
162 // remove remaining \'s for the sorting part
163 docstring const ppart =
164 subst(spart_latexed.first, from_ascii("\\"), docstring());
168 docstring const tpart = *it;
170 if (it2 < levels_plain.end())
173 // write the bit that followed "|"
179 // In macros with moving arguments, such as \section,
180 // we store the index and output it after the macro (#2154)
181 if (runparams_in.postpone_fragile_stuff)
182 runparams_in.post_macro += os.str();
188 void InsetIndex::docbook(XMLStream & xs, OutputParams const & runparams) const
190 // Get the content of the inset as LaTeX, as some things may be encoded as ERT (like {}).
191 odocstringstream odss;
192 otexstream ots(odss);
193 InsetText::latex(ots, runparams);
194 docstring latexString = trim(odss.str());
196 // Check whether there are unsupported things.
197 if (latexString.find(from_utf8("@")) != latexString.npos) {
198 docstring error = from_utf8("Unsupported feature: an index entry contains an @. "
199 "Complete entry: \"") + latexString + from_utf8("\"");
201 xs << XMLStream::ESCAPE_NONE << (from_utf8("<!-- Output Error: ") + error + from_utf8(" -->\n"));
204 // Handle several indices.
205 docstring indexType = from_utf8("");
206 if (buffer().masterBuffer()->params().use_indices) {
207 indexType += " type=\"" + params_.index + "\"";
210 // Split the string into its main constituents: terms, and command (see, see also, range).
211 size_t positionVerticalBar = latexString.find(from_ascii("|")); // What comes before | is (sub)(sub)entries.
212 docstring indexTerms = latexString.substr(0, positionVerticalBar);
213 docstring command = latexString.substr(positionVerticalBar + 1);
215 // Handle primary, secondary, and tertiary terms (entries, subentries, and subsubentries, for LaTeX).
216 vector<docstring> terms = getVectorFromString(indexTerms, from_ascii("!"), false);
218 // Handle ranges. Happily, (| and |) can only be at the end of the string! However, | may be trapped by the
219 bool hasStartRange = latexString.find(from_ascii("|(")) != latexString.npos;
220 bool hasEndRange = latexString.find(from_ascii("|)")) != latexString.npos;
221 if (hasStartRange || hasEndRange) {
222 // Remove the ranges from the command if they do not appear at the beginning.
224 while ((index = command.find(from_utf8("|("), index)) != std::string::npos)
225 command.erase(index, 1);
227 while ((index = command.find(from_utf8("|)"), index)) != std::string::npos)
228 command.erase(index, 1);
230 // Remove the ranges when they are the only vertical bar in the complete string.
231 if (command[0] == '(' || command[0] == ')')
235 // Handle see and seealso. As "see" is a prefix of "seealso", the order of the comparisons is important.
236 // Both commands are mutually exclusive!
237 docstring see = from_utf8("");
238 vector<docstring> seeAlsoes;
239 if (command.substr(0, 3) == "see") {
240 // Unescape brackets.
242 while ((index = command.find(from_utf8("\\{"), index)) != std::string::npos)
243 command.erase(index, 1);
245 while ((index = command.find(from_utf8("\\}"), index)) != std::string::npos)
246 command.erase(index, 1);
248 // Retrieve the part between brackets, and remove the complete seealso.
249 size_t positionOpeningBracket = command.find(from_ascii("{"));
250 size_t positionClosingBracket = command.find(from_ascii("}"));
251 docstring list = command.substr(positionOpeningBracket + 1, positionClosingBracket - positionOpeningBracket - 1);
253 // Parse the list of referenced entries (or a single one for see).
254 if (command.substr(0, 7) == "seealso") {
255 seeAlsoes = getVectorFromString(list, from_ascii(","), false);
259 if (see.find(from_ascii(",")) != see.npos) {
260 docstring error = from_utf8("Several index terms found as \"see\"! Only one is acceptable. "
261 "Complete entry: \"") + latexString + from_utf8("\"");
263 xs << XMLStream::ESCAPE_NONE << (from_utf8("<!-- Output Error: ") + error + from_utf8(" -->\n"));
267 // Remove the complete see/seealso from the commands, in case there is something else to parse.
268 command = command.substr(positionClosingBracket + 1);
271 // Some parts of the strings are not parsed, as they do not have anything matching in DocBook: things like
272 // formatting the entry or the page number, other strings for sorting. https://wiki.lyx.org/Tips/Indexing
273 // If there are such things in the index entry, then this code may miserably fail. For example, for "Peter|(textbf",
274 // no range will be detected.
275 // TODO: Could handle formatting as significance="preferred"?
277 // Write all of this down.
278 if (terms.empty() && !hasEndRange) {
279 docstring error = from_utf8("No index term found! Complete entry: \"") + latexString + from_utf8("\"");
281 xs << XMLStream::ESCAPE_NONE << (from_utf8("<!-- Output Error: ") + error + from_utf8(" -->\n"));
283 // Generate the attributes for ranges. It is based on the terms that are indexed, but the ID must be unique
284 // to this indexing area (xml::cleanID does not guarantee this: for each call with the same arguments,
285 // the same legal ID is produced; here, as the input would be the same, the output must be, by design).
286 // Hence the thread-local storage, as the numbers must strictly be unique, and thus cannot be shared across
287 // a paragraph (making the solution used for HTML worthless). This solution is very similar to the one used in
289 docstring attrs = indexType;
290 if (hasStartRange || hasEndRange) {
291 // Append an ID if uniqueness is not guaranteed across the document.
292 static QThreadStorage<set<docstring>> tKnownTermLists;
293 static QThreadStorage<int> tID;
295 set<docstring> & knownTermLists = tKnownTermLists.localData();
296 int & ID = tID.localData();
298 if (!tID.hasLocalData()) {
302 // Modify the index terms to add the unique ID if needed.
303 docstring newIndexTerms = indexTerms;
304 if (knownTermLists.find(indexTerms) != knownTermLists.end()) {
305 newIndexTerms += from_ascii(string("-") + to_string(ID));
307 // Only increment for the end of range, so that the same number is used for the start of range.
313 // Term list not yet known: add it to the set AFTER the end of range. After
314 if (knownTermLists.find(indexTerms) == knownTermLists.end() && hasEndRange) {
315 knownTermLists.insert(indexTerms);
318 // Generate the attributes.
319 docstring id = xml::cleanID(newIndexTerms);
321 attrs += " class=\"startofrange\" xml:id=\"" + id + "\"";
323 attrs += " class=\"endofrange\" startref=\"" + id + "\"";
327 // Handle the index terms (including the specific index for this entry).
328 xs << xml::StartTag("indexterm", attrs);
329 if (terms.size() > 0) { // hasEndRange has no content.
330 xs << xml::StartTag("primary");
332 xs << xml::EndTag("primary");
334 if (terms.size() > 1) {
335 xs << xml::StartTag("secondary");
337 xs << xml::EndTag("secondary");
339 if (terms.size() > 2) {
340 xs << xml::StartTag("tertiary");
342 xs << xml::EndTag("tertiary");
345 // Handle see and see also.
347 xs << xml::StartTag("see");
349 xs << xml::EndTag("see");
352 if (!seeAlsoes.empty()) {
353 for (auto & entry : seeAlsoes) {
354 xs << xml::StartTag("seealso");
356 xs << xml::EndTag("seealso");
361 xs << xml::EndTag("indexterm");
366 docstring InsetIndex::xhtml(XMLStream & xs, OutputParams const &) const
368 // we just print an anchor, taking the paragraph ID from
369 // our own interior paragraph, which doesn't get printed
370 std::string const magic = paragraphs().front().magicLabel();
371 std::string const attr = "id='" + magic + "'";
372 xs << xml::CompTag("a", attr);
377 bool InsetIndex::showInsetDialog(BufferView * bv) const
379 bv->showDialog("index", params2string(params_),
380 const_cast<InsetIndex *>(this));
385 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
387 switch (cmd.action()) {
389 case LFUN_INSET_MODIFY: {
390 if (cmd.getArg(0) == "changetype") {
391 cur.recordUndoInset(this);
392 params_.index = from_utf8(cmd.getArg(1));
395 InsetIndexParams params;
396 InsetIndex::string2params(to_utf8(cmd.argument()), params);
397 cur.recordUndoInset(this);
398 params_.index = params.index;
399 // what we really want here is a TOC update, but that means
400 // a full buffer update
401 cur.forceBufferUpdate();
405 case LFUN_INSET_DIALOG_UPDATE:
406 cur.bv().updateDialog("index", params2string(params_));
410 InsetCollapsible::doDispatch(cur, cmd);
416 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
417 FuncStatus & flag) const
419 switch (cmd.action()) {
421 case LFUN_INSET_MODIFY:
422 if (cmd.getArg(0) == "changetype") {
423 docstring const newtype = from_utf8(cmd.getArg(1));
424 Buffer const & realbuffer = *buffer().masterBuffer();
425 IndicesList const & indiceslist = realbuffer.params().indiceslist();
426 Index const * index = indiceslist.findShortcut(newtype);
427 flag.setEnabled(index != 0);
429 from_utf8(cmd.getArg(1)) == params_.index);
432 return InsetCollapsible::getStatus(cur, cmd, flag);
434 case LFUN_INSET_DIALOG_UPDATE: {
435 Buffer const & realbuffer = *buffer().masterBuffer();
436 flag.setEnabled(realbuffer.params().use_indices);
441 return InsetCollapsible::getStatus(cur, cmd, flag);
446 ColorCode InsetIndex::labelColor() const
448 if (params_.index.empty() || params_.index == from_ascii("idx"))
449 return InsetCollapsible::labelColor();
451 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
453 c = InsetCollapsible::labelColor();
458 docstring InsetIndex::toolTip(BufferView const &, int, int) const
460 docstring tip = _("Index Entry");
461 if (buffer().params().use_indices && !params_.index.empty()) {
462 Buffer const & realbuffer = *buffer().masterBuffer();
463 IndicesList const & indiceslist = realbuffer.params().indiceslist();
465 Index const * index = indiceslist.findShortcut(params_.index);
467 tip += _("unknown type!");
469 tip += index->index();
473 return toolTipText(tip);
477 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
479 InsetLayout const & il = getLayout();
480 docstring label = translateIfPossible(il.labelstring());
482 if (buffer().params().use_indices && !params_.index.empty()) {
483 Buffer const & realbuffer = *buffer().masterBuffer();
484 IndicesList const & indiceslist = realbuffer.params().indiceslist();
486 Index const * index = indiceslist.findShortcut(params_.index);
488 label += _("unknown type!");
490 label += index->index();
494 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
496 return getNewLabel(label);
500 void InsetIndex::write(ostream & os) const
502 os << to_utf8(layoutName());
504 InsetCollapsible::write(os);
508 void InsetIndex::read(Lexer & lex)
511 InsetCollapsible::read(lex);
515 string InsetIndex::params2string(InsetIndexParams const & params)
524 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
526 params = InsetIndexParams();
530 istringstream data(in);
533 lex.setContext("InsetIndex::string2params");
539 void InsetIndex::addToToc(DocIterator const & cpit, bool output_active,
540 UpdateType utype, TocBackend & backend) const
542 DocIterator pit = cpit;
543 pit.push_back(CursorSlice(const_cast<InsetIndex &>(*this)));
545 string type = "index";
546 if (buffer().masterBuffer()->params().use_indices)
547 type += ":" + to_utf8(params_.index);
548 // this is unlikely to be terribly long
549 text().forOutliner(str, INT_MAX);
550 TocBuilder & b = backend.builder(type);
551 b.pushItem(pit, str, output_active);
552 // Proceed with the rest of the inset.
553 InsetCollapsible::addToToc(cpit, output_active, utype, backend);
558 void InsetIndex::validate(LaTeXFeatures & features) const
560 if (buffer().masterBuffer()->params().use_indices
561 && !params_.index.empty()
562 && params_.index != "idx")
563 features.require("splitidx");
564 InsetCollapsible::validate(features);
568 string InsetIndex::contextMenuName() const
570 return "context-index";
574 bool InsetIndex::hasSettings() const
576 return buffer().masterBuffer()->params().use_indices;
582 /////////////////////////////////////////////////////////////////////
586 ///////////////////////////////////////////////////////////////////////
589 void InsetIndexParams::write(ostream & os) const
593 os << to_utf8(index);
600 void InsetIndexParams::read(Lexer & lex)
603 index = lex.getDocString();
605 index = from_ascii("idx");
609 /////////////////////////////////////////////////////////////////////
613 ///////////////////////////////////////////////////////////////////////
615 InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
616 : InsetCommand(buf, p)
620 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
622 static ParamInfo param_info_;
623 if (param_info_.empty()) {
624 param_info_.add("type", ParamInfo::LATEX_OPTIONAL,
625 ParamInfo::HANDLING_ESCAPE);
626 param_info_.add("name", ParamInfo::LATEX_OPTIONAL,
627 ParamInfo::HANDLING_LATEXIFY);
628 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
634 docstring InsetPrintIndex::screenLabel() const
636 bool const printall = suffixIs(getCmdName(), '*');
637 bool const multind = buffer().masterBuffer()->params().use_indices;
639 && getParam("type") == from_ascii("idx"))
640 || (getParam("type").empty() && !printall))
642 Buffer const & realbuffer = *buffer().masterBuffer();
643 IndicesList const & indiceslist = realbuffer.params().indiceslist();
644 Index const * index = indiceslist.findShortcut(getParam("type"));
645 if (!index && !printall)
646 return _("Unknown index type!");
647 docstring res = printall ? _("All indexes") : index->index();
649 res += " (" + _("non-active") + ")";
650 else if (contains(getCmdName(), "printsubindex"))
651 res += " (" + _("subindex") + ")";
656 bool InsetPrintIndex::isCompatibleCommand(string const & s)
658 return s == "printindex" || s == "printsubindex"
659 || s == "printindex*" || s == "printsubindex*";
663 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
665 switch (cmd.action()) {
667 case LFUN_INSET_MODIFY: {
668 if (cmd.argument() == from_ascii("toggle-subindex")) {
669 string scmd = getCmdName();
670 if (contains(scmd, "printindex"))
671 scmd = subst(scmd, "printindex", "printsubindex");
673 scmd = subst(scmd, "printsubindex", "printindex");
677 } else if (cmd.argument() == from_ascii("check-printindex*")) {
678 string scmd = getCmdName();
679 if (suffixIs(scmd, '*'))
683 setParam("type", docstring());
687 InsetCommandParams p(INDEX_PRINT_CODE);
689 InsetCommand::string2params(to_utf8(cmd.argument()), p);
690 if (p.getCmdName().empty()) {
691 cur.noScreenUpdate();
700 InsetCommand::doDispatch(cur, cmd);
706 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
707 FuncStatus & status) const
709 switch (cmd.action()) {
711 case LFUN_INSET_MODIFY: {
712 if (cmd.argument() == from_ascii("toggle-subindex")) {
713 status.setEnabled(buffer().masterBuffer()->params().use_indices);
714 status.setOnOff(contains(getCmdName(), "printsubindex"));
716 } else if (cmd.argument() == from_ascii("check-printindex*")) {
717 status.setEnabled(buffer().masterBuffer()->params().use_indices);
718 status.setOnOff(suffixIs(getCmdName(), '*'));
720 } if (cmd.getArg(0) == "index_print"
721 && cmd.getArg(1) == "CommandInset") {
722 InsetCommandParams p(INDEX_PRINT_CODE);
723 InsetCommand::string2params(to_utf8(cmd.argument()), p);
724 if (suffixIs(p.getCmdName(), '*')) {
725 status.setEnabled(true);
726 status.setOnOff(false);
729 Buffer const & realbuffer = *buffer().masterBuffer();
730 IndicesList const & indiceslist =
731 realbuffer.params().indiceslist();
732 Index const * index = indiceslist.findShortcut(p["type"]);
733 status.setEnabled(index != 0);
734 status.setOnOff(p["type"] == getParam("type"));
737 return InsetCommand::getStatus(cur, cmd, status);
740 case LFUN_INSET_DIALOG_UPDATE: {
741 status.setEnabled(buffer().masterBuffer()->params().use_indices);
746 return InsetCommand::getStatus(cur, cmd, status);
751 void InsetPrintIndex::updateBuffer(ParIterator const &, UpdateType, bool const /*deleted*/)
753 Index const * index =
754 buffer().masterParams().indiceslist().findShortcut(getParam("type"));
756 setParam("name", index->index());
760 void InsetPrintIndex::latex(otexstream & os, OutputParams const & runparams_in) const
762 if (!buffer().masterBuffer()->params().use_indices) {
763 if (getParam("type") == from_ascii("idx"))
764 os << "\\printindex" << termcmd;
767 OutputParams runparams = runparams_in;
768 os << getCommand(runparams);
772 void InsetPrintIndex::validate(LaTeXFeatures & features) const
774 features.require("makeidx");
775 if (buffer().masterBuffer()->params().use_indices)
776 features.require("splitidx");
777 InsetCommand::validate(features);
781 string InsetPrintIndex::contextMenuName() const
783 return buffer().masterBuffer()->params().use_indices ?
784 "context-indexprint" : string();
788 bool InsetPrintIndex::hasSettings() const
790 return buffer().masterBuffer()->params().use_indices;
796 void parseItem(docstring & s, bool for_output)
798 // this does not yet check for escaped things
799 size_type loc = s.find(from_ascii("@"));
800 if (loc != string::npos) {
806 loc = s.find(from_ascii("|"));
807 if (loc != string::npos)
812 void extractSubentries(docstring const & entry, docstring & main,
813 docstring & sub1, docstring & sub2)
817 size_type const loc = entry.find(from_ascii(" ! "));
818 if (loc == string::npos)
821 main = trim(entry.substr(0, loc));
822 size_t const locend = loc + 3;
823 size_type const loc2 = entry.find(from_ascii(" ! "), locend);
824 if (loc2 == string::npos) {
825 sub1 = trim(entry.substr(locend));
827 sub1 = trim(entry.substr(locend, loc2 - locend));
828 sub2 = trim(entry.substr(loc2 + 3));
839 IndexEntry(docstring const & s, DocIterator const & d)
842 extractSubentries(s, main, sub, subsub);
843 parseItem(main, false);
844 parseItem(sub, false);
845 parseItem(subsub, false);
848 bool equal(IndexEntry const & rhs) const
850 return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
853 bool same_sub(IndexEntry const & rhs) const
855 return main == rhs.main && sub == rhs.sub;
858 bool same_main(IndexEntry const & rhs) const
860 return main == rhs.main;
869 bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
871 int comp = compare_no_case(lhs.main, rhs.main);
873 comp = compare_no_case(lhs.sub, rhs.sub);
875 comp = compare_no_case(lhs.subsub, rhs.subsub);
882 docstring InsetPrintIndex::xhtml(XMLStream &, OutputParams const & op) const
884 BufferParams const & bp = buffer().masterBuffer()->params();
886 // we do not presently support multiple indices, so we refuse to print
887 // anything but the main index, so as not to generate multiple indices.
888 // NOTE Multiple index support would require some work. The reason
889 // is that the TOC does not know about multiple indices. Either it would
890 // need to be told about them (not a bad idea), or else the index entries
891 // would need to be collected differently, say, during validation.
892 if (bp.use_indices && getParam("type") != from_ascii("idx"))
895 shared_ptr<Toc const> toc = buffer().tocBackend().toc("index");
899 // Collect the index entries in a form we can use them.
900 Toc::const_iterator it = toc->begin();
901 Toc::const_iterator const en = toc->end();
902 vector<IndexEntry> entries;
903 for (; it != en; ++it)
905 entries.push_back(IndexEntry(it->str(), it->dit()));
908 // not very likely that all the index entries are in notes or
912 stable_sort(entries.begin(), entries.end());
914 Layout const & lay = bp.documentClass().htmlTOCLayout();
915 string const & tocclass = lay.defaultCSSClass();
916 string const tocattr = "class='index " + tocclass + "'";
918 // we'll use our own stream, because we are going to defer everything.
919 // that's how we deal with the fact that we're probably inside a standard
920 // paragraph, and we don't want to be.
921 odocstringstream ods;
924 xs << xml::StartTag("div", tocattr);
925 xs << xml::StartTag(lay.htmltag(), lay.htmlattr())
926 << translateIfPossible(from_ascii("Index"),
927 op.local_font->language()->lang())
928 << xml::EndTag(lay.htmltag());
929 xs << xml::StartTag("ul", "class='main'");
932 vector<IndexEntry>::const_iterator eit = entries.begin();
933 vector<IndexEntry>::const_iterator const een = entries.end();
934 // tracks whether we are already inside a main entry (1),
935 // a sub-entry (2), or a sub-sub-entry (3). see below for the
938 // the last one we saw
940 int entry_number = -1;
941 for (; eit != een; ++eit) {
942 Paragraph const & par = eit->dit.innerParagraph();
943 if (entry_number == -1 || !eit->equal(last)) {
944 if (entry_number != -1) {
945 // not the first time through the loop, so
946 // close last entry or entries, depending.
948 // close this sub-sub-entry
949 xs << xml::EndTag("li") << xml::CR();
950 // is this another sub-sub-entry within the same sub-entry?
951 if (!eit->same_sub(last)) {
953 xs << xml::EndTag("ul") << xml::CR();
957 // the point of the second test here is that we might get
958 // here two ways: (i) by falling through from above; (ii) because,
959 // though the sub-entry hasn't changed, the sub-sub-entry has,
960 // which means that it is the first sub-sub-entry within this
961 // sub-entry. In that case, we do not want to close anything.
962 if (level == 2 && !eit->same_sub(last)) {
964 xs << xml::EndTag("li") << xml::CR();
965 // is this another sub-entry with the same main entry?
966 if (!eit->same_main(last)) {
968 xs << xml::EndTag("ul") << xml::CR();
972 // again, we can get here two ways: from above, or because we have
973 // found the first sub-entry. in the latter case, we do not want to
975 if (level == 1 && !eit->same_main(last)) {
977 xs << xml::EndTag("li") << xml::CR();
981 // we'll be starting new entries
984 // We need to use our own stream, since we will have to
985 // modify what we get back.
986 odocstringstream ent;
987 XMLStream entstream(ent);
988 OutputParams ours = op;
990 par.simpleLyXHTMLOnePar(buffer(), entstream, ours, dummy);
992 // these will contain XHTML versions of the main entry, etc
993 // remember that everything will already have been escaped,
994 // so we'll need to use NextRaw() during output.
998 extractSubentries(ent.str(), main, sub, subsub);
999 parseItem(main, true);
1000 parseItem(sub, true);
1001 parseItem(subsub, true);
1004 // another subsubentry
1005 xs << xml::StartTag("li", "class='subsubentry'")
1006 << XMLStream::ESCAPE_NONE << subsub;
1007 } else if (level == 2) {
1008 // there are two ways we can be here:
1009 // (i) we can actually be inside a sub-entry already and be about
1010 // to output the first sub-sub-entry. in this case, our sub
1011 // and the last sub will be the same.
1012 // (ii) we can just have closed a sub-entry, possibly after also
1013 // closing a list of sub-sub-entries. here our sub and the last
1014 // sub are different.
1015 // only in the latter case do we need to output the new sub-entry.
1016 // note that in this case, too, though, the sub-entry might already
1017 // have a sub-sub-entry.
1018 if (eit->sub != last.sub)
1019 xs << xml::StartTag("li", "class='subentry'")
1020 << XMLStream::ESCAPE_NONE << sub;
1021 if (!subsub.empty()) {
1022 // it's actually a subsubentry, so we need to start that list
1024 << xml::StartTag("ul", "class='subsubentry'")
1025 << xml::StartTag("li", "class='subsubentry'")
1026 << XMLStream::ESCAPE_NONE << subsub;
1030 // there are also two ways we can be here:
1031 // (i) we can actually be inside an entry already and be about
1032 // to output the first sub-entry. in this case, our main
1033 // and the last main will be the same.
1034 // (ii) we can just have closed an entry, possibly after also
1035 // closing a list of sub-entries. here our main and the last
1036 // main are different.
1037 // only in the latter case do we need to output the new main entry.
1038 // note that in this case, too, though, the main entry might already
1039 // have a sub-entry, or even a sub-sub-entry.
1040 if (eit->main != last.main)
1041 xs << xml::StartTag("li", "class='main'") << main;
1043 // there's a sub-entry, too
1045 << xml::StartTag("ul", "class='subentry'")
1046 << xml::StartTag("li", "class='subentry'")
1047 << XMLStream::ESCAPE_NONE << sub;
1049 if (!subsub.empty()) {
1050 // and a sub-sub-entry
1052 << xml::StartTag("ul", "class='subsubentry'")
1053 << xml::StartTag("li", "class='subsubentry'")
1054 << XMLStream::ESCAPE_NONE << subsub;
1060 // finally, then, we can output the index link itself
1061 string const parattr = "href='#" + par.magicLabel() + "'";
1062 xs << (entry_number == 0 ? ":" : ",");
1063 xs << " " << xml::StartTag("a", parattr)
1064 << ++entry_number << xml::EndTag("a");
1067 // now we have to close all the open levels
1069 xs << xml::EndTag("li") << xml::EndTag("ul") << xml::CR();
1072 xs << xml::EndTag("div") << xml::CR();