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 case LFUN_INSET_SETTINGS: {
231 Buffer const & realbuffer = *buffer().masterBuffer();
232 flag.setEnabled(realbuffer.params().use_indices);
237 return InsetCollapsable::getStatus(cur, cmd, flag);
242 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
244 docstring s = _("Idx");
245 if (decoration() == InsetLayout::CLASSIC)
246 return isOpen(bv) ? s : getNewLabel(s);
248 return getNewLabel(s);
252 docstring InsetIndex::toolTip(BufferView const &, int, int) const
254 docstring tip = _("Index Entry");
255 if (buffer().params().use_indices && !params_.index.empty()) {
256 Buffer const & realbuffer = *buffer().masterBuffer();
257 IndicesList const & indiceslist = realbuffer.params().indiceslist();
259 Index const * index = indiceslist.findShortcut(params_.index);
261 tip += _("unknown type!");
263 tip += index->index();
267 OutputParams rp(&buffer().params().encoding());
268 odocstringstream ods;
269 InsetText::plaintext(ods, rp);
271 // shorten it if necessary
272 if (tip.size() > 200)
273 tip = tip.substr(0, 200) + "...";
278 void InsetIndex::write(ostream & os) const
280 os << to_utf8(name());
282 InsetCollapsable::write(os);
286 void InsetIndex::read(Lexer & lex)
289 InsetCollapsable::read(lex);
293 string InsetIndex::params2string(InsetIndexParams const & params)
302 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
304 params = InsetIndexParams();
308 istringstream data(in);
311 lex.setContext("InsetIndex::string2params");
317 void InsetIndex::addToToc(DocIterator const & cpit)
319 DocIterator pit = cpit;
320 pit.push_back(CursorSlice(*this));
321 docstring const item = text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
322 buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, item));
323 // Proceed with the rest of the inset.
324 InsetCollapsable::addToToc(cpit);
328 void InsetIndex::validate(LaTeXFeatures & features) const
330 if (buffer().masterBuffer()->params().use_indices
331 && !params_.index.empty()
332 && params_.index != "idx")
333 features.require("splitidx");
337 docstring InsetIndex::contextMenu(BufferView const &, int, int) const
339 return from_ascii("context-index");
343 void InsetIndexParams::write(ostream & os) const
347 os << to_utf8(index);
354 void InsetIndexParams::read(Lexer & lex)
357 index = lex.getDocString();
359 index = from_ascii("idx");
363 /////////////////////////////////////////////////////////////////////
367 ///////////////////////////////////////////////////////////////////////
369 InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
370 : InsetCommand(p, "index_print")
374 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
376 static ParamInfo param_info_;
377 if (param_info_.empty()) {
378 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
379 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
385 docstring InsetPrintIndex::screenLabel() const
387 if ((!buffer().masterBuffer()->params().use_indices
388 && getParam("type") == from_ascii("idx"))
389 || getParam("type").empty())
391 Buffer const & realbuffer = *buffer().masterBuffer();
392 IndicesList const & indiceslist = realbuffer.params().indiceslist();
393 Index const * index = indiceslist.findShortcut(getParam("type"));
395 return _("Unknown index type!");
396 docstring res = index->index();
397 if (!buffer().masterBuffer()->params().use_indices)
398 res += " (" + _("non-active") + ")";
403 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
405 switch (cmd.action) {
407 case LFUN_INSET_MODIFY: {
408 InsetCommandParams p(INDEX_PRINT_CODE);
410 InsetCommand::string2params("index_print",
411 to_utf8(cmd.argument()), p);
412 if (p.getCmdName().empty()) {
416 setParam("type", p["type"]);
421 InsetCommand::doDispatch(cur, cmd);
427 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
428 FuncStatus & status) const
430 switch (cmd.action) {
432 case LFUN_INSET_MODIFY: {
433 if (cmd.getArg(0) == "index_print"
434 && cmd.getArg(1) == "InsetCommand") {
435 InsetCommandParams p(INDEX_PRINT_CODE);
436 InsetCommand::string2params("index_print",
437 to_utf8(cmd.argument()), p);
438 Buffer const & realbuffer = *buffer().masterBuffer();
439 IndicesList const & indiceslist =
440 realbuffer.params().indiceslist();
441 Index const * index = indiceslist.findShortcut(p["type"]);
442 status.setEnabled(index != 0);
443 status.setOnOff(p["type"] == getParam("type"));
448 case LFUN_INSET_DIALOG_UPDATE:
449 case LFUN_INSET_SETTINGS: {
450 Buffer const & realbuffer = *buffer().masterBuffer();
451 status.setEnabled(realbuffer.params().use_indices);
456 return InsetCommand::getStatus(cur, cmd, status);
461 int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
463 if (!buffer().masterBuffer()->params().use_indices) {
464 if (getParam("type") == from_ascii("idx"))
465 os << "\\printindex{}";
473 void InsetPrintIndex::validate(LaTeXFeatures & features) const
475 features.require("makeidx");
476 if (buffer().masterBuffer()->params().use_indices)
477 features.require("splitidx");
481 docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
483 return buffer().masterBuffer()->params().use_indices ?
484 from_ascii("context-indexprint") : docstring();
488 Inset::EDITABLE InsetPrintIndex::editable() const
490 return buffer().masterBuffer()->params().use_indices ?
491 IS_EDITABLE : NOT_EDITABLE;