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"
28 #include "TocBackend.h"
30 #include "support/debug.h"
31 #include "support/docstream.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
35 #include "frontends/alert.h"
40 using namespace lyx::support;
44 /////////////////////////////////////////////////////////////////////
48 ///////////////////////////////////////////////////////////////////////
51 InsetIndex::InsetIndex(Buffer const & buf, InsetIndexParams const & params)
52 : InsetCollapsable(buf), params_(params)
56 int InsetIndex::latex(odocstream & os,
57 OutputParams const & runparams) const
59 if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
60 && params_.index != "idx") {
70 // get contents of InsetText as LaTeX and plaintext
71 odocstringstream ourlatex;
72 InsetText::latex(ourlatex, runparams);
73 odocstringstream ourplain;
74 InsetText::plaintext(ourplain, runparams);
75 docstring latexstr = ourlatex.str();
76 docstring plainstr = ourplain.str();
78 // this will get what follows | if anything does
81 // check for the | separator
82 // FIXME This would go wrong on an escaped "|", but
83 // how far do we want to go here?
84 size_t pos = latexstr.find(from_ascii("|"));
85 if (pos != docstring::npos) {
86 // put the bit after "|" into cmd...
87 cmd = latexstr.substr(pos + 1);
88 // ...and erase that stuff from latexstr
89 latexstr = latexstr.erase(pos);
90 // ...and similarly from plainstr
91 size_t ppos = plainstr.find(from_ascii("|"));
92 if (ppos < plainstr.size())
95 LYXERR0("The `|' separator was not found in the plaintext version!");
98 // Separate the entires and subentries, i.e., split on "!"
99 // FIXME This would do the wrong thing with escaped ! characters
100 std::vector<docstring> const levels =
101 getVectorFromString(latexstr, from_ascii("!"), true);
102 std::vector<docstring> const levels_plain =
103 getVectorFromString(plainstr, from_ascii("!"), true);
105 vector<docstring>::const_iterator it = levels.begin();
106 vector<docstring>::const_iterator end = levels.end();
107 vector<docstring>::const_iterator it2 = levels_plain.begin();
109 for (; it != end; ++it) {
110 // write the separator except the first time
116 // correctly sort macros and formatted strings
117 // if we do find a command, prepend a plain text
118 // version of the content to get sorting right,
119 // e.g. \index{LyX@\LyX}, \index{text@\textbf{text}}
120 // Don't do that if the user entered '@' himself, though.
121 if (contains(*it, '\\') && !contains(*it, '@')) {
122 // Plaintext might return nothing (e.g. for ERTs)
123 docstring const spart =
124 (it2 < levels_plain.end() && !(*it2).empty())
126 // Now we need to validate that all characters in
127 // the sorting part are representable in the current
128 // encoding. If not try the LaTeX macro which might
129 // or might not be a good choice, and issue a warning.
131 for (size_t n = 0; n < spart.size(); ++n) {
133 spart2 += runparams.encoding->latexChar(spart[n]);
134 } catch (EncodingException & /* e */) {
135 LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
138 if (spart != spart2 && !runparams.dryrun) {
139 // FIXME: warning should be passed to the error dialog
140 frontend::Alert::warning(_("Index sorting failed"),
141 bformat(_("LyX's automatic index sorting algorithm faced\n"
142 "problems with the entry '%1$s'.\n"
143 "Please specify the sorting of this entry manually, as\n"
144 "explained in the User Guide."), spart));
146 // remove remaining \'s for the sorting part
147 docstring const ppart =
148 subst(spart2, from_ascii("\\"), docstring());
152 docstring const tpart = *it;
154 if (it2 < levels_plain.end())
157 // write the bit that followed "|"
165 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
167 os << "<indexterm><primary>";
168 int const i = InsetText::docbook(os, runparams);
169 os << "</primary></indexterm>";
174 bool InsetIndex::showInsetDialog(BufferView * bv) const
176 bv->showDialog("index", params2string(params_),
177 const_cast<InsetIndex *>(this));
182 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
184 switch (cmd.action) {
186 case LFUN_INSET_MODIFY: {
187 if (cmd.getArg(0) == "changetype") {
188 params_.index = from_utf8(cmd.getArg(1));
189 setLayout(cur.buffer()->params());
192 InsetIndexParams params;
193 InsetIndex::string2params(to_utf8(cmd.argument()), params);
194 params_.index = params.index;
195 setLayout(cur.buffer()->params());
199 case LFUN_INSET_DIALOG_UPDATE:
200 cur.bv().updateDialog("index", params2string(params_));
204 InsetCollapsable::doDispatch(cur, cmd);
210 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
211 FuncStatus & flag) const
213 switch (cmd.action) {
215 case LFUN_INSET_MODIFY:
216 if (cmd.getArg(0) == "changetype") {
217 docstring const newtype = from_utf8(cmd.getArg(1));
218 Buffer const & realbuffer = *buffer().masterBuffer();
219 IndicesList const & indiceslist = realbuffer.params().indiceslist();
220 Index const * index = indiceslist.findShortcut(newtype);
221 flag.setEnabled(index != 0);
223 from_utf8(cmd.getArg(1)) == params_.index);
226 flag.setEnabled(true);
229 case LFUN_INSET_DIALOG_UPDATE: {
230 Buffer const & realbuffer = *buffer().masterBuffer();
231 flag.setEnabled(realbuffer.params().use_indices);
236 return InsetCollapsable::getStatus(cur, cmd, flag);
241 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
243 docstring s = _("Idx");
244 if (decoration() == InsetLayout::CLASSIC)
245 return isOpen(bv) ? s : getNewLabel(s);
247 return getNewLabel(s);
251 docstring InsetIndex::toolTip(BufferView const &, int, int) const
253 docstring tip = _("Index Entry");
254 if (buffer().params().use_indices && !params_.index.empty()) {
255 Buffer const & realbuffer = *buffer().masterBuffer();
256 IndicesList const & indiceslist = realbuffer.params().indiceslist();
258 Index const * index = indiceslist.findShortcut(params_.index);
260 tip += _("unknown type!");
262 tip += index->index();
266 OutputParams rp(&buffer().params().encoding());
267 odocstringstream ods;
268 InsetText::plaintext(ods, rp);
270 return wrapParas(tip);
274 void InsetIndex::write(ostream & os) const
276 os << to_utf8(name());
278 InsetCollapsable::write(os);
282 void InsetIndex::read(Lexer & lex)
285 InsetCollapsable::read(lex);
289 string InsetIndex::params2string(InsetIndexParams const & params)
298 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
300 params = InsetIndexParams();
304 istringstream data(in);
307 lex.setContext("InsetIndex::string2params");
313 void InsetIndex::addToToc(DocIterator const & cpit)
315 DocIterator pit = cpit;
316 pit.push_back(CursorSlice(*this));
317 docstring const item = text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
318 buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, item));
319 // Proceed with the rest of the inset.
320 InsetCollapsable::addToToc(cpit);
324 void InsetIndex::validate(LaTeXFeatures & features) const
326 if (buffer().masterBuffer()->params().use_indices
327 && !params_.index.empty()
328 && params_.index != "idx")
329 features.require("splitidx");
333 docstring InsetIndex::contextMenu(BufferView const &, int, int) const
335 return from_ascii("context-index");
339 bool InsetIndex::hasSettings() const
341 return buffer().masterBuffer()->params().use_indices;
347 /////////////////////////////////////////////////////////////////////
351 ///////////////////////////////////////////////////////////////////////
354 void InsetIndexParams::write(ostream & os) const
358 os << to_utf8(index);
365 void InsetIndexParams::read(Lexer & lex)
368 index = lex.getDocString();
370 index = from_ascii("idx");
374 /////////////////////////////////////////////////////////////////////
378 ///////////////////////////////////////////////////////////////////////
380 InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
381 : InsetCommand(p, "index_print")
385 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
387 static ParamInfo param_info_;
388 if (param_info_.empty()) {
389 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
390 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
396 docstring InsetPrintIndex::screenLabel() const
398 bool const printall = suffixIs(getCmdName(), '*');
399 bool const multind = buffer().masterBuffer()->params().use_indices;
401 && getParam("type") == from_ascii("idx"))
402 || (getParam("type").empty() && !printall))
404 Buffer const & realbuffer = *buffer().masterBuffer();
405 IndicesList const & indiceslist = realbuffer.params().indiceslist();
406 Index const * index = indiceslist.findShortcut(getParam("type"));
407 if (!index && !printall)
408 return _("Unknown index type!");
409 docstring res = printall ? _("All indices") : index->index();
411 res += " (" + _("non-active") + ")";
412 else if (contains(getCmdName(), "printsubindex"))
413 res += " (" + _("subindex") + ")";
418 bool InsetPrintIndex::isCompatibleCommand(string const & s)
420 return s == "printindex" || s == "printsubindex"
421 || s == "printindex*" || s == "printsubindex*";
425 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
427 switch (cmd.action) {
429 case LFUN_INSET_MODIFY: {
430 if (cmd.argument() == from_ascii("toggle-subindex")) {
431 string cmd = getCmdName();
432 if (contains(cmd, "printindex"))
433 cmd = subst(cmd, "printindex", "printsubindex");
435 cmd = subst(cmd, "printsubindex", "printindex");
438 } else if (cmd.argument() == from_ascii("check-printindex*")) {
439 string cmd = getCmdName();
440 if (suffixIs(cmd, '*'))
443 setParam("type", docstring());
447 InsetCommandParams p(INDEX_PRINT_CODE);
449 InsetCommand::string2params("index_print",
450 to_utf8(cmd.argument()), p);
451 if (p.getCmdName().empty()) {
460 InsetCommand::doDispatch(cur, cmd);
466 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
467 FuncStatus & status) const
469 switch (cmd.action) {
471 case LFUN_INSET_MODIFY: {
472 if (cmd.argument() == from_ascii("toggle-subindex")) {
473 status.setEnabled(buffer().masterBuffer()->params().use_indices);
474 status.setOnOff(contains(getCmdName(), "printsubindex"));
476 } else if (cmd.argument() == from_ascii("check-printindex*")) {
477 status.setEnabled(buffer().masterBuffer()->params().use_indices);
478 status.setOnOff(suffixIs(getCmdName(), '*'));
480 } if (cmd.getArg(0) == "index_print"
481 && cmd.getArg(1) == "CommandInset") {
482 InsetCommandParams p(INDEX_PRINT_CODE);
483 InsetCommand::string2params("index_print",
484 to_utf8(cmd.argument()), p);
485 if (suffixIs(p.getCmdName(), '*')) {
486 status.setEnabled(true);
487 status.setOnOff(false);
490 Buffer const & realbuffer = *buffer().masterBuffer();
491 IndicesList const & indiceslist =
492 realbuffer.params().indiceslist();
493 Index const * index = indiceslist.findShortcut(p["type"]);
494 status.setEnabled(index != 0);
495 status.setOnOff(p["type"] == getParam("type"));
498 return InsetCommand::getStatus(cur, cmd, status);
501 case LFUN_INSET_DIALOG_UPDATE: {
502 status.setEnabled(buffer().masterBuffer()->params().use_indices);
507 return InsetCommand::getStatus(cur, cmd, status);
512 int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
514 if (!buffer().masterBuffer()->params().use_indices) {
515 if (getParam("type") == from_ascii("idx"))
516 os << "\\printindex{}";
524 void InsetPrintIndex::validate(LaTeXFeatures & features) const
526 features.require("makeidx");
527 if (buffer().masterBuffer()->params().use_indices)
528 features.require("splitidx");
532 docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
534 return buffer().masterBuffer()->params().use_indices ?
535 from_ascii("context-indexprint") : docstring();
539 bool InsetPrintIndex::hasSettings() const
541 return buffer().masterBuffer()->params().use_indices;