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"
25 #include "LaTeXFeatures.h"
27 #include "output_latex.h"
28 #include "output_xhtml.h"
30 #include "TextClass.h"
31 #include "TocBackend.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
35 #include "support/gettext.h"
36 #include "support/lstrings.h"
38 #include "frontends/alert.h"
44 using namespace lyx::support;
48 /////////////////////////////////////////////////////////////////////
52 ///////////////////////////////////////////////////////////////////////
55 InsetIndex::InsetIndex(Buffer * buf, InsetIndexParams const & params)
56 : InsetCollapsable(buf), params_(params)
60 void InsetIndex::latex(otexstream & os, OutputParams const & runparams_in) const
62 OutputParams runparams(runparams_in);
63 runparams.inIndexEntry = true;
65 if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
66 && params_.index != "idx") {
75 // get contents of InsetText as LaTeX and plaintext
77 odocstringstream ourlatex;
78 otexstream ots(ourlatex, texrow);
79 InsetText::latex(ots, runparams);
80 odocstringstream ourplain;
81 InsetText::plaintext(ourplain, runparams);
82 docstring latexstr = ourlatex.str();
83 docstring plainstr = ourplain.str();
85 // this will get what follows | if anything does
88 // check for the | separator
89 // FIXME This would go wrong on an escaped "|", but
90 // how far do we want to go here?
91 size_t pos = latexstr.find(from_ascii("|"));
92 if (pos != docstring::npos) {
93 // put the bit after "|" into cmd...
94 cmd = latexstr.substr(pos + 1);
95 // ...and erase that stuff from latexstr
96 latexstr = latexstr.erase(pos);
97 // ...and similarly from plainstr
98 size_t ppos = plainstr.find(from_ascii("|"));
99 if (ppos < plainstr.size())
100 plainstr.erase(ppos);
102 LYXERR0("The `|' separator was not found in the plaintext version!");
105 // Separate the entires and subentries, i.e., split on "!"
106 // FIXME This would do the wrong thing with escaped ! characters
107 std::vector<docstring> const levels =
108 getVectorFromString(latexstr, from_ascii("!"), true);
109 std::vector<docstring> const levels_plain =
110 getVectorFromString(plainstr, from_ascii("!"), true);
112 vector<docstring>::const_iterator it = levels.begin();
113 vector<docstring>::const_iterator end = levels.end();
114 vector<docstring>::const_iterator it2 = levels_plain.begin();
116 for (; it != end; ++it) {
117 // write the separator except the first time
123 // correctly sort macros and formatted strings
124 // if we do find a command, prepend a plain text
125 // version of the content to get sorting right,
126 // e.g. \index{LyX@\LyX}, \index{text@\textbf{text}}
127 // Don't do that if the user entered '@' himself, though.
128 if (contains(*it, '\\') && !contains(*it, '@')) {
129 // Plaintext might return nothing (e.g. for ERTs)
130 docstring const spart =
131 (it2 < levels_plain.end() && !(*it2).empty())
133 // Now we need to validate that all characters in
134 // the sorting part are representable in the current
135 // encoding. If not try the LaTeX macro which might
136 // or might not be a good choice, and issue a warning.
138 for (size_t n = 0; n < spart.size(); ++n) {
140 spart2 += runparams.encoding->latexChar(spart[n]).first;
141 } catch (EncodingException & /* e */) {
142 LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
145 if (spart != spart2 && !runparams.dryrun) {
146 // FIXME: warning should be passed to the error dialog
147 frontend::Alert::warning(_("Index sorting failed"),
148 bformat(_("LyX's automatic index sorting algorithm faced\n"
149 "problems with the entry '%1$s'.\n"
150 "Please specify the sorting of this entry manually, as\n"
151 "explained in the User Guide."), spart));
153 // remove remaining \'s for the sorting part
154 docstring const ppart =
155 subst(spart2, from_ascii("\\"), docstring());
159 docstring const tpart = *it;
161 if (it2 < levels_plain.end())
164 // write the bit that followed "|"
172 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
174 os << "<indexterm><primary>";
175 int const i = InsetText::docbook(os, runparams);
176 os << "</primary></indexterm>";
181 docstring InsetIndex::xhtml(XHTMLStream & xs, OutputParams const &) const
183 // we just print an anchor, taking the paragraph ID from
184 // our own interior paragraph, which doesn't get printed
185 std::string const magic = paragraphs().front().magicLabel();
186 std::string const attr = "id='" + magic + "'";
187 xs << html::CompTag("a", attr);
192 bool InsetIndex::showInsetDialog(BufferView * bv) const
194 bv->showDialog("index", params2string(params_),
195 const_cast<InsetIndex *>(this));
200 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
202 switch (cmd.action()) {
204 case LFUN_INSET_MODIFY: {
205 if (cmd.getArg(0) == "changetype") {
206 cur.recordUndoInset(ATOMIC_UNDO, this);
207 params_.index = from_utf8(cmd.getArg(1));
210 InsetIndexParams params;
211 InsetIndex::string2params(to_utf8(cmd.argument()), params);
212 cur.recordUndoInset(ATOMIC_UNDO, this);
213 params_.index = params.index;
214 // what we really want here is a TOC update, but that means
215 // a full buffer update
216 cur.forceBufferUpdate();
220 case LFUN_INSET_DIALOG_UPDATE:
221 cur.bv().updateDialog("index", params2string(params_));
225 InsetCollapsable::doDispatch(cur, cmd);
231 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
232 FuncStatus & flag) const
234 switch (cmd.action()) {
236 case LFUN_INSET_MODIFY:
237 if (cmd.getArg(0) == "changetype") {
238 docstring const newtype = from_utf8(cmd.getArg(1));
239 Buffer const & realbuffer = *buffer().masterBuffer();
240 IndicesList const & indiceslist = realbuffer.params().indiceslist();
241 Index const * index = indiceslist.findShortcut(newtype);
242 flag.setEnabled(index != 0);
244 from_utf8(cmd.getArg(1)) == params_.index);
247 return InsetCollapsable::getStatus(cur, cmd, flag);
249 case LFUN_INSET_DIALOG_UPDATE: {
250 Buffer const & realbuffer = *buffer().masterBuffer();
251 flag.setEnabled(realbuffer.params().use_indices);
256 return InsetCollapsable::getStatus(cur, cmd, flag);
261 ColorCode InsetIndex::labelColor() const
263 if (params_.index.empty() || params_.index == from_ascii("idx"))
264 return InsetCollapsable::labelColor();
266 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
268 c = InsetCollapsable::labelColor();
273 docstring InsetIndex::toolTip(BufferView const &, int, int) const
275 docstring tip = _("Index Entry");
276 if (buffer().params().use_indices && !params_.index.empty()) {
277 Buffer const & realbuffer = *buffer().masterBuffer();
278 IndicesList const & indiceslist = realbuffer.params().indiceslist();
280 Index const * index = indiceslist.findShortcut(params_.index);
282 tip += _("unknown type!");
284 tip += index->index();
288 return toolTipText(tip);
292 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
294 InsetLayout const & il = getLayout();
295 docstring label = translateIfPossible(il.labelstring());
297 if (buffer().params().use_indices && !params_.index.empty()) {
298 Buffer const & realbuffer = *buffer().masterBuffer();
299 IndicesList const & indiceslist = realbuffer.params().indiceslist();
301 Index const * index = indiceslist.findShortcut(params_.index);
303 label += _("unknown type!");
305 label += index->index();
309 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
311 return getNewLabel(label);
315 void InsetIndex::write(ostream & os) const
317 os << to_utf8(layoutName());
319 InsetCollapsable::write(os);
323 void InsetIndex::read(Lexer & lex)
326 InsetCollapsable::read(lex);
330 string InsetIndex::params2string(InsetIndexParams const & params)
339 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
341 params = InsetIndexParams();
345 istringstream data(in);
348 lex.setContext("InsetIndex::string2params");
354 void InsetIndex::addToToc(DocIterator const & cpit) const
356 DocIterator pit = cpit;
357 pit.push_back(CursorSlice(const_cast<InsetIndex &>(*this)));
359 text().forToc(str, 0);
360 buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, str));
361 // Proceed with the rest of the inset.
362 InsetCollapsable::addToToc(cpit);
366 void InsetIndex::validate(LaTeXFeatures & features) const
368 if (buffer().masterBuffer()->params().use_indices
369 && !params_.index.empty()
370 && params_.index != "idx")
371 features.require("splitidx");
372 InsetCollapsable::validate(features);
376 string InsetIndex::contextMenuName() const
378 return "context-index";
382 bool InsetIndex::hasSettings() const
384 return buffer().masterBuffer()->params().use_indices;
390 /////////////////////////////////////////////////////////////////////
394 ///////////////////////////////////////////////////////////////////////
397 void InsetIndexParams::write(ostream & os) const
401 os << to_utf8(index);
408 void InsetIndexParams::read(Lexer & lex)
411 index = lex.getDocString();
413 index = from_ascii("idx");
417 /////////////////////////////////////////////////////////////////////
421 ///////////////////////////////////////////////////////////////////////
423 InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
424 : InsetCommand(buf, p)
428 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
430 static ParamInfo param_info_;
431 if (param_info_.empty()) {
432 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
433 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
439 docstring InsetPrintIndex::screenLabel() const
441 bool const printall = suffixIs(getCmdName(), '*');
442 bool const multind = buffer().masterBuffer()->params().use_indices;
444 && getParam("type") == from_ascii("idx"))
445 || (getParam("type").empty() && !printall))
447 Buffer const & realbuffer = *buffer().masterBuffer();
448 IndicesList const & indiceslist = realbuffer.params().indiceslist();
449 Index const * index = indiceslist.findShortcut(getParam("type"));
450 if (!index && !printall)
451 return _("Unknown index type!");
452 docstring res = printall ? _("All indexes") : index->index();
454 res += " (" + _("non-active") + ")";
455 else if (contains(getCmdName(), "printsubindex"))
456 res += " (" + _("subindex") + ")";
461 bool InsetPrintIndex::isCompatibleCommand(string const & s)
463 return s == "printindex" || s == "printsubindex"
464 || s == "printindex*" || s == "printsubindex*";
468 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
470 switch (cmd.action()) {
472 case LFUN_INSET_MODIFY: {
473 if (cmd.argument() == from_ascii("toggle-subindex")) {
474 string cmd = getCmdName();
475 if (contains(cmd, "printindex"))
476 cmd = subst(cmd, "printindex", "printsubindex");
478 cmd = subst(cmd, "printsubindex", "printindex");
482 } else if (cmd.argument() == from_ascii("check-printindex*")) {
483 string cmd = getCmdName();
484 if (suffixIs(cmd, '*'))
488 setParam("type", docstring());
492 InsetCommandParams p(INDEX_PRINT_CODE);
494 InsetCommand::string2params(to_utf8(cmd.argument()), p);
495 if (p.getCmdName().empty()) {
496 cur.noScreenUpdate();
504 InsetCommand::doDispatch(cur, cmd);
510 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
511 FuncStatus & status) const
513 switch (cmd.action()) {
515 case LFUN_INSET_MODIFY: {
516 if (cmd.argument() == from_ascii("toggle-subindex")) {
517 status.setEnabled(buffer().masterBuffer()->params().use_indices);
518 status.setOnOff(contains(getCmdName(), "printsubindex"));
520 } else if (cmd.argument() == from_ascii("check-printindex*")) {
521 status.setEnabled(buffer().masterBuffer()->params().use_indices);
522 status.setOnOff(suffixIs(getCmdName(), '*'));
524 } if (cmd.getArg(0) == "index_print"
525 && cmd.getArg(1) == "CommandInset") {
526 InsetCommandParams p(INDEX_PRINT_CODE);
527 InsetCommand::string2params(to_utf8(cmd.argument()), p);
528 if (suffixIs(p.getCmdName(), '*')) {
529 status.setEnabled(true);
530 status.setOnOff(false);
533 Buffer const & realbuffer = *buffer().masterBuffer();
534 IndicesList const & indiceslist =
535 realbuffer.params().indiceslist();
536 Index const * index = indiceslist.findShortcut(p["type"]);
537 status.setEnabled(index != 0);
538 status.setOnOff(p["type"] == getParam("type"));
541 return InsetCommand::getStatus(cur, cmd, status);
544 case LFUN_INSET_DIALOG_UPDATE: {
545 status.setEnabled(buffer().masterBuffer()->params().use_indices);
550 return InsetCommand::getStatus(cur, cmd, status);
555 void InsetPrintIndex::latex(otexstream & os, OutputParams const & runparams_in) const
557 if (!buffer().masterBuffer()->params().use_indices) {
558 if (getParam("type") == from_ascii("idx"))
559 os << "\\printindex{}";
562 OutputParams runparams = runparams_in;
563 os << getCommand(runparams);
567 void InsetPrintIndex::validate(LaTeXFeatures & features) const
569 features.require("makeidx");
570 if (buffer().masterBuffer()->params().use_indices)
571 features.require("splitidx");
575 string InsetPrintIndex::contextMenuName() const
577 return buffer().masterBuffer()->params().use_indices ?
578 "context-indexprint" : string();
582 bool InsetPrintIndex::hasSettings() const
584 return buffer().masterBuffer()->params().use_indices;
590 void parseItem(docstring & s, bool for_output)
592 // this does not yet check for escaped things
593 size_type loc = s.find(from_ascii("@"));
594 if (loc != string::npos) {
600 loc = s.find(from_ascii("|"));
601 if (loc != string::npos)
606 void extractSubentries(docstring const & entry, docstring & main,
607 docstring & sub1, docstring & sub2)
611 size_type const loc = entry.find(from_ascii(" ! "));
612 if (loc == string::npos)
615 main = trim(entry.substr(0, loc));
616 size_t const locend = loc + 3;
617 size_type const loc2 = entry.find(from_ascii(" ! "), locend);
618 if (loc2 == string::npos) {
619 sub1 = trim(entry.substr(locend));
621 sub1 = trim(entry.substr(locend, loc2 - locend));
622 sub2 = trim(entry.substr(loc2 + 3));
633 IndexEntry(docstring const & s, DocIterator const & d)
636 extractSubentries(s, main, sub, subsub);
637 parseItem(main, false);
638 parseItem(sub, false);
639 parseItem(subsub, false);
642 bool equal(IndexEntry const & rhs) const
644 return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
647 bool same_sub(IndexEntry const & rhs) const
649 return main == rhs.main && sub == rhs.sub;
652 bool same_main(IndexEntry const & rhs) const
654 return main == rhs.main;
663 bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
665 int comp = compare_no_case(lhs.main, rhs.main);
667 comp = compare_no_case(lhs.sub, rhs.sub);
669 comp = compare_no_case(lhs.subsub, rhs.subsub);
676 docstring InsetPrintIndex::xhtml(XHTMLStream &, OutputParams const & op) const
678 BufferParams const & bp = buffer().masterBuffer()->params();
680 // we do not presently support multiple indices, so we refuse to print
681 // anything but the main index, so as not to generate multiple indices.
682 // NOTE Multiple index support would require some work. The reason
683 // is that the TOC does not know about multiple indices. Either it would
684 // need to be told about them (not a bad idea), or else the index entries
685 // would need to be collected differently, say, during validation.
686 if (bp.use_indices && getParam("type") != from_ascii("idx"))
689 Toc const & toc = buffer().tocBackend().toc("index");
693 // Collection the index entries in a form we can use them.
694 Toc::const_iterator it = toc.begin();
695 Toc::const_iterator const en = toc.end();
696 vector<IndexEntry> entries;
697 for (; it != en; ++it)
698 entries.push_back(IndexEntry(it->str(), it->dit()));
699 stable_sort(entries.begin(), entries.end());
701 Layout const & lay = bp.documentClass().htmlTOCLayout();
702 string const & tocclass = lay.defaultCSSClass();
703 string const tocattr = "class='tochead " + tocclass + "'";
705 // we'll use our own stream, because we are going to defer everything.
706 // that's how we deal with the fact that we're probably inside a standard
707 // paragraph, and we don't want to be.
708 odocstringstream ods;
711 xs << html::StartTag("div", "class='index'");
712 xs << html::StartTag(lay.htmltag(), lay.htmlattr())
714 << html::EndTag(lay.htmltag());
715 xs << html::StartTag("ul", "class='main'");
718 vector<IndexEntry>::const_iterator eit = entries.begin();
719 vector<IndexEntry>::const_iterator const een = entries.end();
720 // tracks whether we are already inside a main entry (1),
721 // a sub-entry (2), or a sub-sub-entry (3). see below for the
724 // the last one we saw
726 int entry_number = -1;
727 for (; eit != een; ++eit) {
728 Paragraph const & par = eit->dit.innerParagraph();
729 if (entry_number == -1 || !eit->equal(last)) {
730 if (entry_number != -1) {
731 // not the first time through the loop, so
732 // close last entry or entries, depending.
734 // close this sub-sub-entry
735 xs << html::EndTag("li") << html::CR();
736 // is this another sub-sub-entry within the same sub-entry?
737 if (!eit->same_sub(last)) {
739 xs << html::EndTag("ul") << html::CR();
743 // the point of the second test here is that we might get
744 // here two ways: (i) by falling through from above; (ii) because,
745 // though the sub-entry hasn't changed, the sub-sub-entry has,
746 // which means that it is the first sub-sub-entry within this
747 // sub-entry. In that case, we do not want to close anything.
748 if (level == 2 && !eit->same_sub(last)) {
750 xs << html::EndTag("li") << html::CR();
751 // is this another sub-entry with the same main entry?
752 if (!eit->same_main(last)) {
754 xs << html::EndTag("ul") << html::CR();
758 // again, we can get here two ways: from above, or because we have
759 // found the first sub-entry. in the latter case, we do not want to
761 if (level == 1 && !eit->same_main(last)) {
763 xs << html::EndTag("li") << html::CR();
767 // we'll be starting new entries
770 // We need to use our own stream, since we will have to
771 // modify what we get back.
772 odocstringstream ent;
773 XHTMLStream entstream(ent);
774 OutputParams ours = op;
776 par.simpleLyXHTMLOnePar(buffer(), entstream, ours, dummy);
778 // these will contain XHTML versions of the main entry, etc
779 // remember that everything will already have been escaped,
780 // so we'll need to use NextRaw() during output.
784 extractSubentries(ent.str(), main, sub, subsub);
785 parseItem(main, true);
786 parseItem(sub, true);
787 parseItem(subsub, true);
790 // another subsubentry
791 xs << html::StartTag("li", "class='subsubentry'")
792 << XHTMLStream::ESCAPE_NONE << subsub;
793 } else if (level == 2) {
794 // there are two ways we can be here:
795 // (i) we can actually be inside a sub-entry already and be about
796 // to output the first sub-sub-entry. in this case, our sub
797 // and the last sub will be the same.
798 // (ii) we can just have closed a sub-entry, possibly after also
799 // closing a list of sub-sub-entries. here our sub and the last
800 // sub are different.
801 // only in the latter case do we need to output the new sub-entry.
802 // note that in this case, too, though, the sub-entry might already
803 // have a sub-sub-entry.
804 if (eit->sub != last.sub)
805 xs << html::StartTag("li", "class='subentry'")
806 << XHTMLStream::ESCAPE_NONE << sub;
807 if (!subsub.empty()) {
808 // it's actually a subsubentry, so we need to start that list
810 << html::StartTag("ul", "class='subsubentry'")
811 << html::StartTag("li", "class='subsubentry'")
812 << XHTMLStream::ESCAPE_NONE << subsub;
816 // there are also two ways we can be here:
817 // (i) we can actually be inside an entry already and be about
818 // to output the first sub-entry. in this case, our main
819 // and the last main will be the same.
820 // (ii) we can just have closed an entry, possibly after also
821 // closing a list of sub-entries. here our main and the last
822 // main are different.
823 // only in the latter case do we need to output the new main entry.
824 // note that in this case, too, though, the main entry might already
825 // have a sub-entry, or even a sub-sub-entry.
826 if (eit->main != last.main)
827 xs << html::StartTag("li", "class='main'") << main;
829 // there's a sub-entry, too
831 << html::StartTag("ul", "class='subentry'")
832 << html::StartTag("li", "class='subentry'")
833 << XHTMLStream::ESCAPE_NONE << sub;
835 if (!subsub.empty()) {
836 // and a sub-sub-entry
838 << html::StartTag("ul", "class='subsubentry'")
839 << html::StartTag("li", "class='subsubentry'")
840 << XHTMLStream::ESCAPE_NONE << subsub;
846 // finally, then, we can output the index link itself
847 string const parattr = "href='#" + par.magicLabel() + "'";
848 xs << (entry_number == 0 ? ":" : ",");
849 xs << " " << html::StartTag("a", parattr)
850 << ++entry_number << html::EndTag("a");
853 // now we have to close all the open levels
855 xs << html::EndTag("li") << html::EndTag("ul") << html::CR();
858 xs << html::EndTag("div") << html::CR();