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"
19 #include "DispatchResult.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
23 #include "IndicesList.h"
24 #include "LaTeXFeatures.h"
26 #include "MetricsInfo.h"
27 #include "output_latex.h"
28 #include "output_xhtml.h"
30 #include "TocBackend.h"
32 #include "support/debug.h"
33 #include "support/docstream.h"
34 #include "support/gettext.h"
35 #include "support/lstrings.h"
37 #include "frontends/alert.h"
42 using namespace lyx::support;
46 /////////////////////////////////////////////////////////////////////
50 ///////////////////////////////////////////////////////////////////////
53 InsetIndex::InsetIndex(Buffer * buf, InsetIndexParams const & params)
54 : InsetCollapsable(buf), params_(params)
58 int InsetIndex::latex(odocstream & os,
59 OutputParams const & runparams_in) const
61 OutputParams runparams(runparams_in);
62 runparams.inIndexEntry = true;
64 if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
65 && params_.index != "idx") {
75 // get contents of InsetText as LaTeX and plaintext
76 odocstringstream ourlatex;
77 InsetText::latex(ourlatex, runparams);
78 odocstringstream ourplain;
79 InsetText::plaintext(ourplain, runparams);
80 docstring latexstr = ourlatex.str();
81 docstring plainstr = ourplain.str();
83 // this will get what follows | if anything does
86 // check for the | separator
87 // FIXME This would go wrong on an escaped "|", but
88 // how far do we want to go here?
89 size_t pos = latexstr.find(from_ascii("|"));
90 if (pos != docstring::npos) {
91 // put the bit after "|" into cmd...
92 cmd = latexstr.substr(pos + 1);
93 // ...and erase that stuff from latexstr
94 latexstr = latexstr.erase(pos);
95 // ...and similarly from plainstr
96 size_t ppos = plainstr.find(from_ascii("|"));
97 if (ppos < plainstr.size())
100 LYXERR0("The `|' separator was not found in the plaintext version!");
103 // Separate the entires and subentries, i.e., split on "!"
104 // FIXME This would do the wrong thing with escaped ! characters
105 std::vector<docstring> const levels =
106 getVectorFromString(latexstr, from_ascii("!"), true);
107 std::vector<docstring> const levels_plain =
108 getVectorFromString(plainstr, from_ascii("!"), true);
110 vector<docstring>::const_iterator it = levels.begin();
111 vector<docstring>::const_iterator end = levels.end();
112 vector<docstring>::const_iterator it2 = levels_plain.begin();
114 for (; it != end; ++it) {
115 // write the separator except the first time
121 // correctly sort macros and formatted strings
122 // if we do find a command, prepend a plain text
123 // version of the content to get sorting right,
124 // e.g. \index{LyX@\LyX}, \index{text@\textbf{text}}
125 // Don't do that if the user entered '@' himself, though.
126 if (contains(*it, '\\') && !contains(*it, '@')) {
127 // Plaintext might return nothing (e.g. for ERTs)
128 docstring const spart =
129 (it2 < levels_plain.end() && !(*it2).empty())
131 // Now we need to validate that all characters in
132 // the sorting part are representable in the current
133 // encoding. If not try the LaTeX macro which might
134 // or might not be a good choice, and issue a warning.
136 for (size_t n = 0; n < spart.size(); ++n) {
138 spart2 += runparams.encoding->latexChar(spart[n]);
139 } catch (EncodingException & /* e */) {
140 LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
143 if (spart != spart2 && !runparams.dryrun) {
144 // FIXME: warning should be passed to the error dialog
145 frontend::Alert::warning(_("Index sorting failed"),
146 bformat(_("LyX's automatic index sorting algorithm faced\n"
147 "problems with the entry '%1$s'.\n"
148 "Please specify the sorting of this entry manually, as\n"
149 "explained in the User Guide."), spart));
151 // remove remaining \'s for the sorting part
152 docstring const ppart =
153 subst(spart2, from_ascii("\\"), docstring());
157 docstring const tpart = *it;
159 if (it2 < levels_plain.end())
162 // write the bit that followed "|"
170 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
172 os << "<indexterm><primary>";
173 int const i = InsetText::docbook(os, runparams);
174 os << "</primary></indexterm>";
179 docstring InsetIndex::xhtml(XHTMLStream & xs, OutputParams const &) const
181 // we just print an anchor, taking the paragraph ID from
182 // our own interior paragraph, which doesn't get printed
183 std::string const magic = paragraphs().front().magicLabel();
184 std::string const attr = "id='" + magic + "'";
185 xs << CompTag("a", attr);
190 bool InsetIndex::showInsetDialog(BufferView * bv) const
192 bv->showDialog("index", params2string(params_),
193 const_cast<InsetIndex *>(this));
198 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
200 switch (cmd.action) {
202 case LFUN_INSET_MODIFY: {
203 if (cmd.getArg(0) == "changetype") {
204 params_.index = from_utf8(cmd.getArg(1));
207 InsetIndexParams params;
208 InsetIndex::string2params(to_utf8(cmd.argument()), params);
209 params_.index = params.index;
213 case LFUN_INSET_DIALOG_UPDATE:
214 cur.bv().updateDialog("index", params2string(params_));
218 InsetCollapsable::doDispatch(cur, cmd);
224 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
225 FuncStatus & flag) const
227 switch (cmd.action) {
229 case LFUN_INSET_MODIFY:
230 if (cmd.getArg(0) == "changetype") {
231 docstring const newtype = from_utf8(cmd.getArg(1));
232 Buffer const & realbuffer = *buffer().masterBuffer();
233 IndicesList const & indiceslist = realbuffer.params().indiceslist();
234 Index const * index = indiceslist.findShortcut(newtype);
235 flag.setEnabled(index != 0);
237 from_utf8(cmd.getArg(1)) == params_.index);
240 flag.setEnabled(true);
243 case LFUN_INSET_DIALOG_UPDATE: {
244 Buffer const & realbuffer = *buffer().masterBuffer();
245 flag.setEnabled(realbuffer.params().use_indices);
250 return InsetCollapsable::getStatus(cur, cmd, flag);
255 ColorCode InsetIndex::labelColor() const
257 if (params_.index.empty() || params_.index == from_ascii("idx"))
258 return InsetCollapsable::labelColor();
260 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
262 c = InsetCollapsable::labelColor();
267 docstring InsetIndex::toolTip(BufferView const &, int, int) const
269 docstring tip = _("Index Entry");
270 if (buffer().params().use_indices && !params_.index.empty()) {
271 Buffer const & realbuffer = *buffer().masterBuffer();
272 IndicesList const & indiceslist = realbuffer.params().indiceslist();
274 Index const * index = indiceslist.findShortcut(params_.index);
276 tip += _("unknown type!");
278 tip += index->index();
282 OutputParams rp(&buffer().params().encoding());
283 odocstringstream ods;
284 InsetText::plaintext(ods, rp);
286 return wrapParas(tip);
290 void InsetIndex::write(ostream & os) const
292 os << to_utf8(name());
294 InsetCollapsable::write(os);
298 void InsetIndex::read(Lexer & lex)
301 InsetCollapsable::read(lex);
305 string InsetIndex::params2string(InsetIndexParams const & params)
314 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
316 params = InsetIndexParams();
320 istringstream data(in);
323 lex.setContext("InsetIndex::string2params");
329 void InsetIndex::addToToc(DocIterator const & cpit)
331 DocIterator pit = cpit;
332 pit.push_back(CursorSlice(*this));
333 docstring const item = text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
334 buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, item));
335 // Proceed with the rest of the inset.
336 InsetCollapsable::addToToc(cpit);
340 void InsetIndex::validate(LaTeXFeatures & features) const
342 if (buffer().masterBuffer()->params().use_indices
343 && !params_.index.empty()
344 && params_.index != "idx")
345 features.require("splitidx");
349 docstring InsetIndex::contextMenu(BufferView const &, int, int) const
351 return from_ascii("context-index");
355 bool InsetIndex::hasSettings() const
357 return buffer().masterBuffer()->params().use_indices;
363 /////////////////////////////////////////////////////////////////////
367 ///////////////////////////////////////////////////////////////////////
370 void InsetIndexParams::write(ostream & os) const
374 os << to_utf8(index);
381 void InsetIndexParams::read(Lexer & lex)
384 index = lex.getDocString();
386 index = from_ascii("idx");
390 /////////////////////////////////////////////////////////////////////
394 ///////////////////////////////////////////////////////////////////////
396 InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
397 : InsetCommand(buf, p, "index_print")
401 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
403 static ParamInfo param_info_;
404 if (param_info_.empty()) {
405 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
406 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
412 docstring InsetPrintIndex::screenLabel() const
414 bool const printall = suffixIs(getCmdName(), '*');
415 bool const multind = buffer().masterBuffer()->params().use_indices;
417 && getParam("type") == from_ascii("idx"))
418 || (getParam("type").empty() && !printall))
420 Buffer const & realbuffer = *buffer().masterBuffer();
421 IndicesList const & indiceslist = realbuffer.params().indiceslist();
422 Index const * index = indiceslist.findShortcut(getParam("type"));
423 if (!index && !printall)
424 return _("Unknown index type!");
425 docstring res = printall ? _("All indices") : index->index();
427 res += " (" + _("non-active") + ")";
428 else if (contains(getCmdName(), "printsubindex"))
429 res += " (" + _("subindex") + ")";
434 bool InsetPrintIndex::isCompatibleCommand(string const & s)
436 return s == "printindex" || s == "printsubindex"
437 || s == "printindex*" || s == "printsubindex*";
441 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
443 switch (cmd.action) {
445 case LFUN_INSET_MODIFY: {
446 if (cmd.argument() == from_ascii("toggle-subindex")) {
447 string cmd = getCmdName();
448 if (contains(cmd, "printindex"))
449 cmd = subst(cmd, "printindex", "printsubindex");
451 cmd = subst(cmd, "printsubindex", "printindex");
454 } else if (cmd.argument() == from_ascii("check-printindex*")) {
455 string cmd = getCmdName();
456 if (suffixIs(cmd, '*'))
459 setParam("type", docstring());
463 InsetCommandParams p(INDEX_PRINT_CODE);
465 InsetCommand::string2params("index_print",
466 to_utf8(cmd.argument()), p);
467 if (p.getCmdName().empty()) {
476 InsetCommand::doDispatch(cur, cmd);
482 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
483 FuncStatus & status) const
485 switch (cmd.action) {
487 case LFUN_INSET_MODIFY: {
488 if (cmd.argument() == from_ascii("toggle-subindex")) {
489 status.setEnabled(buffer().masterBuffer()->params().use_indices);
490 status.setOnOff(contains(getCmdName(), "printsubindex"));
492 } else if (cmd.argument() == from_ascii("check-printindex*")) {
493 status.setEnabled(buffer().masterBuffer()->params().use_indices);
494 status.setOnOff(suffixIs(getCmdName(), '*'));
496 } if (cmd.getArg(0) == "index_print"
497 && cmd.getArg(1) == "CommandInset") {
498 InsetCommandParams p(INDEX_PRINT_CODE);
499 InsetCommand::string2params("index_print",
500 to_utf8(cmd.argument()), p);
501 if (suffixIs(p.getCmdName(), '*')) {
502 status.setEnabled(true);
503 status.setOnOff(false);
506 Buffer const & realbuffer = *buffer().masterBuffer();
507 IndicesList const & indiceslist =
508 realbuffer.params().indiceslist();
509 Index const * index = indiceslist.findShortcut(p["type"]);
510 status.setEnabled(index != 0);
511 status.setOnOff(p["type"] == getParam("type"));
514 return InsetCommand::getStatus(cur, cmd, status);
517 case LFUN_INSET_DIALOG_UPDATE: {
518 status.setEnabled(buffer().masterBuffer()->params().use_indices);
523 return InsetCommand::getStatus(cur, cmd, status);
528 int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
530 if (!buffer().masterBuffer()->params().use_indices) {
531 if (getParam("type") == from_ascii("idx"))
532 os << "\\printindex{}";
540 void InsetPrintIndex::validate(LaTeXFeatures & features) const
542 features.require("makeidx");
543 if (buffer().masterBuffer()->params().use_indices)
544 features.require("splitidx");
548 docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
550 return buffer().masterBuffer()->params().use_indices ?
551 from_ascii("context-indexprint") : docstring();
555 bool InsetPrintIndex::hasSettings() const
557 return buffer().masterBuffer()->params().use_indices;
563 void parseItem(docstring & s, bool for_output)
565 // this does not yet check for escaped things
566 size_type loc = s.find(from_ascii("@"));
567 if (loc != string::npos) {
573 loc = s.find(from_ascii("|"));
574 if (loc != string::npos)
579 void extractSubentries(docstring const & entry, docstring & main,
580 docstring & sub1, docstring & sub2)
584 size_type const loc = entry.find(from_ascii(" ! "));
585 if (loc == string::npos)
588 main = trim(entry.substr(0, loc));
589 size_t const locend = loc + 3;
590 size_type const loc2 = entry.find(from_ascii(" ! "), locend);
591 if (loc2 == string::npos) {
592 sub1 = trim(entry.substr(locend));
594 sub1 = trim(entry.substr(locend, loc2 - locend));
595 sub2 = trim(entry.substr(loc2 + 3));
606 IndexEntry(docstring const & s, DocIterator const & d)
609 extractSubentries(s, main, sub, subsub);
610 parseItem(main, false);
611 parseItem(sub, false);
612 parseItem(subsub, false);
615 bool equal(IndexEntry const & rhs) const
617 return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
620 bool same_sub(IndexEntry const & rhs) const
622 return main == rhs.main && sub == rhs.sub;
625 bool same_main(IndexEntry const & rhs) const
627 return main == rhs.main;
636 bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
638 return lhs.main < rhs.main
639 || (lhs.main == rhs.main && lhs.sub < rhs.sub)
640 || (lhs.main == rhs.main && lhs.sub == rhs.sub && lhs.subsub < rhs.subsub);
646 docstring InsetPrintIndex::xhtml(XHTMLStream &, OutputParams const & op) const
648 BufferParams const & bp = buffer().masterBuffer()->params();
650 // we do not presently support multiple indices, so we refuse to print
651 // anything but the main index, so as not to generate multiple indices.
652 // NOTE Multiple index support would require some work. The reason
653 // is that the TOC does not know about multiple indices. Either it would
654 // need to be told about them (not a bad idea), or else the index entries
655 // would need to be collected differently, say, during validation.
656 if (bp.use_indices && getParam("type") != from_ascii("idx"))
659 Toc const & toc = buffer().tocBackend().toc("index");
663 // Collection the index entries in a form we can use them.
664 Toc::const_iterator it = toc.begin();
665 Toc::const_iterator const en = toc.end();
666 vector<IndexEntry> entries;
667 for (; it != en; ++it)
668 entries.push_back(IndexEntry(it->str(), it->dit()));
669 stable_sort(entries.begin(), entries.end());
671 Layout const & lay = bp.documentClass().htmlTOCLayout();
672 string const & tocclass = lay.defaultCSSClass();
673 string const tocattr = "class='tochead " + tocclass + "'";
675 // we'll use our own stream, because we are going to defer everything.
676 // that's how we deal with the fact that we're probably inside a standard
677 // paragraph, and we don't want to be.
678 odocstringstream ods;
681 xs << StartTag("div", "class='index'");
682 xs << StartTag(lay.htmltag(), lay.htmlattr())
684 << EndTag(lay.htmltag());
685 xs << StartTag("ul", "class='main'");
688 vector<IndexEntry>::const_iterator eit = entries.begin();
689 vector<IndexEntry>::const_iterator const een = entries.end();
690 // tracks whether we are already inside a main entry (1),
691 // a sub-entry (2), or a sub-sub-entry (3). see below for the
694 // the last one we saw
696 int entry_number = -1;
697 for (; eit != een; ++eit) {
698 Paragraph const & par = eit->dit.innerParagraph();
699 if (entry_number == -1 || !eit->equal(last)) {
700 if (entry_number != -1) {
701 // not the first time through the loop, so
702 // close last entry or entries, depending.
704 // close this sub-sub-entry
707 // is this another sub-sub-entry within the same sub-entry?
708 if (!eit->same_sub(last)) {
715 // the point of the second test here is that we might get
716 // here two ways: (i) by falling through from above; (ii) because,
717 // though the sub-entry hasn't changed, the sub-sub-entry has,
718 // which means that it is the first sub-sub-entry within this
719 // sub-entry. In that case, we do not want to close anything.
720 if (level == 2 && !eit->same_sub(last)) {
724 // is this another sub-entry with the same main entry?
725 if (!eit->same_main(last)) {
732 // again, we can get here two ways: from above, or because we have
733 // found the first sub-entry. in the latter case, we do not want to
735 if (level == 1 && !eit->same_main(last)) {
742 // we'll be starting new entries
745 // We need to use our own stream, since we will have to
746 // modify what we get back.
747 odocstringstream ent;
748 XHTMLStream entstream(ent);
749 par.simpleLyXHTMLOnePar(buffer(), entstream, op, dummy, true);
751 // these will contain XHTML versions of the main entry, etc
752 // remember that everything will already have been escaped,
753 // so we'll need to use NextRaw() during output.
757 extractSubentries(ent.str(), main, sub, subsub);
758 parseItem(main, true);
759 parseItem(sub, true);
760 parseItem(subsub, true);
763 // another subsubentry
764 xs << StartTag("li", "class='subsubentry'")
765 << XHTMLStream::NextRaw() << subsub;
766 } else if (level == 2) {
767 // there are two ways we can be here:
768 // (i) we can actually be inside a sub-entry already and be about
769 // to output the first sub-sub-entry. in this case, our sub
770 // and the last sub will be the same.
771 // (ii) we can just have closed a sub-entry, possibly after also
772 // closing a list of sub-sub-entries. here our sub and the last
773 // sub are different.
774 // only in the latter case do we need to output the new sub-entry.
775 // note that in this case, too, though, the sub-entry might already
776 // have a sub-sub-entry.
777 if (eit->sub != last.sub)
778 xs << StartTag("li", "class='subentry'")
779 << XHTMLStream::NextRaw() << sub;
780 if (!subsub.empty()) {
781 // it's actually a subsubentry, so we need to start that list
783 xs << StartTag("ul", "class='subsubentry'")
784 << StartTag("li", "class='subsubentry'")
785 << XHTMLStream::NextRaw() << subsub;
789 // there are also two ways we can be here:
790 // (i) we can actually be inside an entry already and be about
791 // to output the first sub-entry. in this case, our main
792 // and the last main will be the same.
793 // (ii) we can just have closed an entry, possibly after also
794 // closing a list of sub-entries. here our main and the last
795 // main are different.
796 // only in the latter case do we need to output the new main entry.
797 // note that in this case, too, though, the main entry might already
798 // have a sub-entry, or even a sub-sub-entry.
799 if (eit->main != last.main)
800 xs << StartTag("li", "class='main'") << main;
802 // there's a sub-entry, too
804 xs << StartTag("ul", "class='subentry'")
805 << StartTag("li", "class='subentry'")
806 << XHTMLStream::NextRaw() << sub;
808 if (!subsub.empty()) {
809 // and a sub-sub-entry
811 xs << StartTag("ul", "class='subsubentry'")
812 << StartTag("li", "class='subsubentry'")
813 << XHTMLStream::NextRaw() << subsub;
819 // finally, then, we can output the index link itself
820 string const parattr = "href='#" + par.magicLabel() + "'";
821 xs << (entry_number == 0 ? ":" : ",");
822 xs << " " << StartTag("a", parattr)
823 << ++entry_number << EndTag("a");
826 // now we have to close all the open levels
828 xs << EndTag("li") << EndTag("ul");