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") {
68 os << escape(params_.index);
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.
137 pair<docstring, docstring> spart_latexed =
138 runparams.encoding->latexString(spart, runparams.dryrun);
139 if (!spart_latexed.second.empty())
140 LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
141 if (spart != spart_latexed.first && !runparams.dryrun) {
142 // FIXME: warning should be passed to the error dialog
143 frontend::Alert::warning(_("Index sorting failed"),
144 bformat(_("LyX's automatic index sorting algorithm faced\n"
145 "problems with the entry '%1$s'.\n"
146 "Please specify the sorting of this entry manually, as\n"
147 "explained in the User Guide."), spart));
149 // remove remaining \'s for the sorting part
150 docstring const ppart =
151 subst(spart_latexed.first, from_ascii("\\"), docstring());
155 docstring const tpart = *it;
157 if (it2 < levels_plain.end())
160 // write the bit that followed "|"
168 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
170 os << "<indexterm><primary>";
171 int const i = InsetText::docbook(os, runparams);
172 os << "</primary></indexterm>";
177 docstring InsetIndex::xhtml(XHTMLStream & xs, OutputParams const &) const
179 // we just print an anchor, taking the paragraph ID from
180 // our own interior paragraph, which doesn't get printed
181 std::string const magic = paragraphs().front().magicLabel();
182 std::string const attr = "id='" + magic + "'";
183 xs << html::CompTag("a", attr);
188 bool InsetIndex::showInsetDialog(BufferView * bv) const
190 bv->showDialog("index", params2string(params_),
191 const_cast<InsetIndex *>(this));
196 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
198 switch (cmd.action()) {
200 case LFUN_INSET_MODIFY: {
201 if (cmd.getArg(0) == "changetype") {
202 cur.recordUndoInset(ATOMIC_UNDO, this);
203 params_.index = from_utf8(cmd.getArg(1));
206 InsetIndexParams params;
207 InsetIndex::string2params(to_utf8(cmd.argument()), params);
208 cur.recordUndoInset(ATOMIC_UNDO, this);
209 params_.index = params.index;
210 // what we really want here is a TOC update, but that means
211 // a full buffer update
212 cur.forceBufferUpdate();
216 case LFUN_INSET_DIALOG_UPDATE:
217 cur.bv().updateDialog("index", params2string(params_));
221 InsetCollapsable::doDispatch(cur, cmd);
227 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
228 FuncStatus & flag) const
230 switch (cmd.action()) {
232 case LFUN_INSET_MODIFY:
233 if (cmd.getArg(0) == "changetype") {
234 docstring const newtype = from_utf8(cmd.getArg(1));
235 Buffer const & realbuffer = *buffer().masterBuffer();
236 IndicesList const & indiceslist = realbuffer.params().indiceslist();
237 Index const * index = indiceslist.findShortcut(newtype);
238 flag.setEnabled(index != 0);
240 from_utf8(cmd.getArg(1)) == params_.index);
243 return InsetCollapsable::getStatus(cur, cmd, flag);
245 case LFUN_INSET_DIALOG_UPDATE: {
246 Buffer const & realbuffer = *buffer().masterBuffer();
247 flag.setEnabled(realbuffer.params().use_indices);
252 return InsetCollapsable::getStatus(cur, cmd, flag);
257 ColorCode InsetIndex::labelColor() const
259 if (params_.index.empty() || params_.index == from_ascii("idx"))
260 return InsetCollapsable::labelColor();
262 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.index));
264 c = InsetCollapsable::labelColor();
269 docstring InsetIndex::toolTip(BufferView const &, int, int) const
271 docstring tip = _("Index Entry");
272 if (buffer().params().use_indices && !params_.index.empty()) {
273 Buffer const & realbuffer = *buffer().masterBuffer();
274 IndicesList const & indiceslist = realbuffer.params().indiceslist();
276 Index const * index = indiceslist.findShortcut(params_.index);
278 tip += _("unknown type!");
280 tip += index->index();
284 return toolTipText(tip);
288 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
290 InsetLayout const & il = getLayout();
291 docstring label = translateIfPossible(il.labelstring());
293 if (buffer().params().use_indices && !params_.index.empty()) {
294 Buffer const & realbuffer = *buffer().masterBuffer();
295 IndicesList const & indiceslist = realbuffer.params().indiceslist();
297 Index const * index = indiceslist.findShortcut(params_.index);
299 label += _("unknown type!");
301 label += index->index();
305 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
307 return getNewLabel(label);
311 void InsetIndex::write(ostream & os) const
313 os << to_utf8(layoutName());
315 InsetCollapsable::write(os);
319 void InsetIndex::read(Lexer & lex)
322 InsetCollapsable::read(lex);
326 string InsetIndex::params2string(InsetIndexParams const & params)
335 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
337 params = InsetIndexParams();
341 istringstream data(in);
344 lex.setContext("InsetIndex::string2params");
350 void InsetIndex::addToToc(DocIterator const & cpit) const
352 DocIterator pit = cpit;
353 pit.push_back(CursorSlice(const_cast<InsetIndex &>(*this)));
355 text().forToc(str, 0);
356 buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, str));
357 // Proceed with the rest of the inset.
358 InsetCollapsable::addToToc(cpit);
362 void InsetIndex::validate(LaTeXFeatures & features) const
364 if (buffer().masterBuffer()->params().use_indices
365 && !params_.index.empty()
366 && params_.index != "idx")
367 features.require("splitidx");
368 InsetCollapsable::validate(features);
372 string InsetIndex::contextMenuName() const
374 return "context-index";
378 bool InsetIndex::hasSettings() const
380 return buffer().masterBuffer()->params().use_indices;
386 /////////////////////////////////////////////////////////////////////
390 ///////////////////////////////////////////////////////////////////////
393 void InsetIndexParams::write(ostream & os) const
397 os << to_utf8(index);
404 void InsetIndexParams::read(Lexer & lex)
407 index = lex.getDocString();
409 index = from_ascii("idx");
413 /////////////////////////////////////////////////////////////////////
417 ///////////////////////////////////////////////////////////////////////
419 InsetPrintIndex::InsetPrintIndex(Buffer * buf, InsetCommandParams const & p)
420 : InsetCommand(buf, p)
424 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
426 static ParamInfo param_info_;
427 if (param_info_.empty()) {
428 param_info_.add("type", ParamInfo::LATEX_OPTIONAL,
429 ParamInfo::HANDLING_ESCAPE);
430 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
436 docstring InsetPrintIndex::screenLabel() const
438 bool const printall = suffixIs(getCmdName(), '*');
439 bool const multind = buffer().masterBuffer()->params().use_indices;
441 && getParam("type") == from_ascii("idx"))
442 || (getParam("type").empty() && !printall))
444 Buffer const & realbuffer = *buffer().masterBuffer();
445 IndicesList const & indiceslist = realbuffer.params().indiceslist();
446 Index const * index = indiceslist.findShortcut(getParam("type"));
447 if (!index && !printall)
448 return _("Unknown index type!");
449 docstring res = printall ? _("All indexes") : index->index();
451 res += " (" + _("non-active") + ")";
452 else if (contains(getCmdName(), "printsubindex"))
453 res += " (" + _("subindex") + ")";
458 bool InsetPrintIndex::isCompatibleCommand(string const & s)
460 return s == "printindex" || s == "printsubindex"
461 || s == "printindex*" || s == "printsubindex*";
465 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
467 switch (cmd.action()) {
469 case LFUN_INSET_MODIFY: {
470 if (cmd.argument() == from_ascii("toggle-subindex")) {
471 string cmd = getCmdName();
472 if (contains(cmd, "printindex"))
473 cmd = subst(cmd, "printindex", "printsubindex");
475 cmd = subst(cmd, "printsubindex", "printindex");
479 } else if (cmd.argument() == from_ascii("check-printindex*")) {
480 string cmd = getCmdName();
481 if (suffixIs(cmd, '*'))
485 setParam("type", docstring());
489 InsetCommandParams p(INDEX_PRINT_CODE);
491 InsetCommand::string2params(to_utf8(cmd.argument()), p);
492 if (p.getCmdName().empty()) {
493 cur.noScreenUpdate();
502 InsetCommand::doDispatch(cur, cmd);
508 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
509 FuncStatus & status) const
511 switch (cmd.action()) {
513 case LFUN_INSET_MODIFY: {
514 if (cmd.argument() == from_ascii("toggle-subindex")) {
515 status.setEnabled(buffer().masterBuffer()->params().use_indices);
516 status.setOnOff(contains(getCmdName(), "printsubindex"));
518 } else if (cmd.argument() == from_ascii("check-printindex*")) {
519 status.setEnabled(buffer().masterBuffer()->params().use_indices);
520 status.setOnOff(suffixIs(getCmdName(), '*'));
522 } if (cmd.getArg(0) == "index_print"
523 && cmd.getArg(1) == "CommandInset") {
524 InsetCommandParams p(INDEX_PRINT_CODE);
525 InsetCommand::string2params(to_utf8(cmd.argument()), p);
526 if (suffixIs(p.getCmdName(), '*')) {
527 status.setEnabled(true);
528 status.setOnOff(false);
531 Buffer const & realbuffer = *buffer().masterBuffer();
532 IndicesList const & indiceslist =
533 realbuffer.params().indiceslist();
534 Index const * index = indiceslist.findShortcut(p["type"]);
535 status.setEnabled(index != 0);
536 status.setOnOff(p["type"] == getParam("type"));
539 return InsetCommand::getStatus(cur, cmd, status);
542 case LFUN_INSET_DIALOG_UPDATE: {
543 status.setEnabled(buffer().masterBuffer()->params().use_indices);
548 return InsetCommand::getStatus(cur, cmd, status);
553 void InsetPrintIndex::latex(otexstream & os, OutputParams const & runparams_in) const
555 if (!buffer().masterBuffer()->params().use_indices) {
556 if (getParam("type") == from_ascii("idx"))
557 os << "\\printindex{}";
560 OutputParams runparams = runparams_in;
561 os << getCommand(runparams);
565 void InsetPrintIndex::validate(LaTeXFeatures & features) const
567 features.require("makeidx");
568 if (buffer().masterBuffer()->params().use_indices)
569 features.require("splitidx");
573 string InsetPrintIndex::contextMenuName() const
575 return buffer().masterBuffer()->params().use_indices ?
576 "context-indexprint" : string();
580 bool InsetPrintIndex::hasSettings() const
582 return buffer().masterBuffer()->params().use_indices;
588 void parseItem(docstring & s, bool for_output)
590 // this does not yet check for escaped things
591 size_type loc = s.find(from_ascii("@"));
592 if (loc != string::npos) {
598 loc = s.find(from_ascii("|"));
599 if (loc != string::npos)
604 void extractSubentries(docstring const & entry, docstring & main,
605 docstring & sub1, docstring & sub2)
609 size_type const loc = entry.find(from_ascii(" ! "));
610 if (loc == string::npos)
613 main = trim(entry.substr(0, loc));
614 size_t const locend = loc + 3;
615 size_type const loc2 = entry.find(from_ascii(" ! "), locend);
616 if (loc2 == string::npos) {
617 sub1 = trim(entry.substr(locend));
619 sub1 = trim(entry.substr(locend, loc2 - locend));
620 sub2 = trim(entry.substr(loc2 + 3));
631 IndexEntry(docstring const & s, DocIterator const & d)
634 extractSubentries(s, main, sub, subsub);
635 parseItem(main, false);
636 parseItem(sub, false);
637 parseItem(subsub, false);
640 bool equal(IndexEntry const & rhs) const
642 return main == rhs.main && sub == rhs.sub && subsub == rhs.subsub;
645 bool same_sub(IndexEntry const & rhs) const
647 return main == rhs.main && sub == rhs.sub;
650 bool same_main(IndexEntry const & rhs) const
652 return main == rhs.main;
661 bool operator<(IndexEntry const & lhs, IndexEntry const & rhs)
663 int comp = compare_no_case(lhs.main, rhs.main);
665 comp = compare_no_case(lhs.sub, rhs.sub);
667 comp = compare_no_case(lhs.subsub, rhs.subsub);
674 docstring InsetPrintIndex::xhtml(XHTMLStream &, OutputParams const & op) const
676 BufferParams const & bp = buffer().masterBuffer()->params();
678 // we do not presently support multiple indices, so we refuse to print
679 // anything but the main index, so as not to generate multiple indices.
680 // NOTE Multiple index support would require some work. The reason
681 // is that the TOC does not know about multiple indices. Either it would
682 // need to be told about them (not a bad idea), or else the index entries
683 // would need to be collected differently, say, during validation.
684 if (bp.use_indices && getParam("type") != from_ascii("idx"))
687 Toc const & toc = buffer().tocBackend().toc("index");
691 // Collection the index entries in a form we can use them.
692 Toc::const_iterator it = toc.begin();
693 Toc::const_iterator const en = toc.end();
694 vector<IndexEntry> entries;
695 for (; it != en; ++it)
696 entries.push_back(IndexEntry(it->str(), it->dit()));
697 stable_sort(entries.begin(), entries.end());
699 Layout const & lay = bp.documentClass().htmlTOCLayout();
700 string const & tocclass = lay.defaultCSSClass();
701 string const tocattr = "class='tochead " + tocclass + "'";
703 // we'll use our own stream, because we are going to defer everything.
704 // that's how we deal with the fact that we're probably inside a standard
705 // paragraph, and we don't want to be.
706 odocstringstream ods;
709 xs << html::StartTag("div", "class='index'");
710 xs << html::StartTag(lay.htmltag(), lay.htmlattr())
712 << html::EndTag(lay.htmltag());
713 xs << html::StartTag("ul", "class='main'");
716 vector<IndexEntry>::const_iterator eit = entries.begin();
717 vector<IndexEntry>::const_iterator const een = entries.end();
718 // tracks whether we are already inside a main entry (1),
719 // a sub-entry (2), or a sub-sub-entry (3). see below for the
722 // the last one we saw
724 int entry_number = -1;
725 for (; eit != een; ++eit) {
726 Paragraph const & par = eit->dit.innerParagraph();
727 if (entry_number == -1 || !eit->equal(last)) {
728 if (entry_number != -1) {
729 // not the first time through the loop, so
730 // close last entry or entries, depending.
732 // close this sub-sub-entry
733 xs << html::EndTag("li") << html::CR();
734 // is this another sub-sub-entry within the same sub-entry?
735 if (!eit->same_sub(last)) {
737 xs << html::EndTag("ul") << html::CR();
741 // the point of the second test here is that we might get
742 // here two ways: (i) by falling through from above; (ii) because,
743 // though the sub-entry hasn't changed, the sub-sub-entry has,
744 // which means that it is the first sub-sub-entry within this
745 // sub-entry. In that case, we do not want to close anything.
746 if (level == 2 && !eit->same_sub(last)) {
748 xs << html::EndTag("li") << html::CR();
749 // is this another sub-entry with the same main entry?
750 if (!eit->same_main(last)) {
752 xs << html::EndTag("ul") << html::CR();
756 // again, we can get here two ways: from above, or because we have
757 // found the first sub-entry. in the latter case, we do not want to
759 if (level == 1 && !eit->same_main(last)) {
761 xs << html::EndTag("li") << html::CR();
765 // we'll be starting new entries
768 // We need to use our own stream, since we will have to
769 // modify what we get back.
770 odocstringstream ent;
771 XHTMLStream entstream(ent);
772 OutputParams ours = op;
774 par.simpleLyXHTMLOnePar(buffer(), entstream, ours, dummy);
776 // these will contain XHTML versions of the main entry, etc
777 // remember that everything will already have been escaped,
778 // so we'll need to use NextRaw() during output.
782 extractSubentries(ent.str(), main, sub, subsub);
783 parseItem(main, true);
784 parseItem(sub, true);
785 parseItem(subsub, true);
788 // another subsubentry
789 xs << html::StartTag("li", "class='subsubentry'")
790 << XHTMLStream::ESCAPE_NONE << subsub;
791 } else if (level == 2) {
792 // there are two ways we can be here:
793 // (i) we can actually be inside a sub-entry already and be about
794 // to output the first sub-sub-entry. in this case, our sub
795 // and the last sub will be the same.
796 // (ii) we can just have closed a sub-entry, possibly after also
797 // closing a list of sub-sub-entries. here our sub and the last
798 // sub are different.
799 // only in the latter case do we need to output the new sub-entry.
800 // note that in this case, too, though, the sub-entry might already
801 // have a sub-sub-entry.
802 if (eit->sub != last.sub)
803 xs << html::StartTag("li", "class='subentry'")
804 << XHTMLStream::ESCAPE_NONE << sub;
805 if (!subsub.empty()) {
806 // it's actually a subsubentry, so we need to start that list
808 << html::StartTag("ul", "class='subsubentry'")
809 << html::StartTag("li", "class='subsubentry'")
810 << XHTMLStream::ESCAPE_NONE << subsub;
814 // there are also two ways we can be here:
815 // (i) we can actually be inside an entry already and be about
816 // to output the first sub-entry. in this case, our main
817 // and the last main will be the same.
818 // (ii) we can just have closed an entry, possibly after also
819 // closing a list of sub-entries. here our main and the last
820 // main are different.
821 // only in the latter case do we need to output the new main entry.
822 // note that in this case, too, though, the main entry might already
823 // have a sub-entry, or even a sub-sub-entry.
824 if (eit->main != last.main)
825 xs << html::StartTag("li", "class='main'") << main;
827 // there's a sub-entry, too
829 << html::StartTag("ul", "class='subentry'")
830 << html::StartTag("li", "class='subentry'")
831 << XHTMLStream::ESCAPE_NONE << sub;
833 if (!subsub.empty()) {
834 // and a sub-sub-entry
836 << html::StartTag("ul", "class='subsubentry'")
837 << html::StartTag("li", "class='subsubentry'")
838 << XHTMLStream::ESCAPE_NONE << subsub;
844 // finally, then, we can output the index link itself
845 string const parattr = "href='#" + par.magicLabel() + "'";
846 xs << (entry_number == 0 ? ":" : ",");
847 xs << " " << html::StartTag("a", parattr)
848 << ++entry_number << html::EndTag("a");
851 // now we have to close all the open levels
853 xs << html::EndTag("li") << html::EndTag("ul") << html::CR();
856 xs << html::EndTag("div") << html::CR();