src/insets/InsetIndex.cpp

   1 /**
   2  * \file InsetIndex.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11 #include <config.h>
  12
  13 #include "InsetIndex.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.h"
  18 #include "ColorSet.h"
  19 #include "DispatchResult.h"
  20 #include "Encoding.h"
  21 #include "FuncRequest.h"
  22 #include "FuncStatus.h"
  23 #include "IndicesList.h"
  24 #include "LaTeXFeatures.h"
  25 #include "Lexer.h"
  26 #include "MetricsInfo.h"
  27 #include "sgml.h"
  28 #include "TocBackend.h"
  29
  30 #include "support/debug.h"
  31 #include "support/docstream.h"
  32 #include "support/gettext.h"
  33 #include "support/lstrings.h"
  34
  35 #include "frontends/alert.h"
  36
  37 #include <ostream>
  38
  39 using namespace std;
  40 using namespace lyx::support;
  41
  42 namespace lyx {
  43
  44 /////////////////////////////////////////////////////////////////////
  45 //
  46 // InsetIndex
  47 //
  48 ///////////////////////////////////////////////////////////////////////
  49
  50
  51 InsetIndex::InsetIndex(Buffer const & buf, InsetIndexParams const & params)
  52         : InsetCollapsable(buf), params_(params)
  53 {}
  54
  55
  56 int InsetIndex::latex(odocstream & os,
  57                       OutputParams const & runparams) const
  58 {
  59         if (buffer().masterBuffer()->params().use_indices && !params_.index.empty()
  60             && params_.index != "idx") {
  61                 os << "\\sindex[";
  62                 os << params_.index;
  63                 os << "]{";
  64         } else {
  65                 os << "\\index";
  66                 os << '{';
  67         }
  68         int i = 0;
  69
  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();
  77
  78         // this will get what follows | if anything does
  79         docstring cmd;
  80
  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())
  93                         plainstr.erase(ppos);
  94                 else
  95                         LYXERR0("The `|' separator was not found in the plaintext version!");
  96         }
  97
  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);
 104
 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();
 108         bool first = true;
 109         for (; it != end; ++it) {
 110                 // write the separator except the first time
 111                 if (!first)
 112                         os << '!';
 113                 else
 114                         first = false;
 115
 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())
 125                                 ? *it2 : *it;
 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.
 130                         docstring spart2;
 131                         for (size_t n = 0; n < spart.size(); ++n) {
 132                                 try {
 133                                         spart2 += runparams.encoding->latexChar(spart[n]);
 134                                 } catch (EncodingException & /* e */) {
 135                                         LYXERR0("Uncodable character in index entry. Sorting might be wrong!");
 136                                 }
 137                         }
 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));
 145                         }
 146                         // remove remaining \'s for the sorting part
 147                         docstring const ppart =
 148                                 subst(spart2, from_ascii("\\"), docstring());
 149                         os << ppart;
 150                         os << '@';
 151                 }
 152                 docstring const tpart = *it;
 153                 os << tpart;
 154                 if (it2 < levels_plain.end())
 155                         ++it2;
 156         }
 157         // write the bit that followed "|"
 158         if (!cmd.empty())
 159                 os << "|" << cmd;
 160         os << '}';
 161         return i;
 162 }
 163
 164
 165 int InsetIndex::docbook(odocstream & os, OutputParams const & runparams) const
 166 {
 167         os << "<indexterm><primary>";
 168         int const i = InsetText::docbook(os, runparams);
 169         os << "</primary></indexterm>";
 170         return i;
 171 }
 172
 173
 174 bool InsetIndex::showInsetDialog(BufferView * bv) const
 175 {
 176         bv->showDialog("index", params2string(params_),
 177                         const_cast<InsetIndex *>(this));
 178         return true;
 179 }
 180
 181
 182 void InsetIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 183 {
 184         switch (cmd.action) {
 185
 186         case LFUN_INSET_MODIFY: {
 187                 if (cmd.getArg(0) == "changetype") {
 188                         params_.index = from_utf8(cmd.getArg(1));
 189                         setLayout(cur.buffer()->params());
 190                         break;
 191                 }
 192                 InsetIndexParams params;
 193                 InsetIndex::string2params(to_utf8(cmd.argument()), params);
 194                 params_.index = params.index;
 195                 setLayout(cur.buffer()->params());
 196                 break;
 197         }
 198
 199         case LFUN_INSET_DIALOG_UPDATE:
 200                 cur.bv().updateDialog("index", params2string(params_));
 201                 break;
 202
 203         default:
 204                 InsetCollapsable::doDispatch(cur, cmd);
 205                 break;
 206         }
 207 }
 208
 209
 210 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 211                 FuncStatus & flag) const
 212 {
 213         switch (cmd.action) {
 214
 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);
 222                         flag.setOnOff(
 223                                 from_utf8(cmd.getArg(1)) == params_.index);
 224                         return true;
 225                 }
 226                 flag.setEnabled(true);
 227                 return true;
 228
 229         case LFUN_INSET_DIALOG_UPDATE:
 230         case LFUN_INSET_SETTINGS: {
 231                 Buffer const & realbuffer = *buffer().masterBuffer();
 232                 flag.setEnabled(realbuffer.params().use_indices);
 233                 return true;
 234         }
 235
 236         default:
 237                 return InsetCollapsable::getStatus(cur, cmd, flag);
 238         }
 239 }
 240
 241
 242 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
 243 {
 244         docstring s = _("Idx");
 245         if (decoration() == InsetLayout::CLASSIC)
 246                 return isOpen(bv) ? s : getNewLabel(s);
 247         else
 248                 return getNewLabel(s);
 249 }
 250
 251
 252 docstring InsetIndex::toolTip(BufferView const &, int, int) const
 253 {
 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();
 258                 tip += " (";
 259                 Index const * index = indiceslist.findShortcut(params_.index);
 260                 if (!index)
 261                         tip += _("unknown type!");
 262                 else
 263                         tip += index->index();
 264                 tip += ")";
 265         }
 266         tip += ": ";
 267         OutputParams rp(&buffer().params().encoding());
 268         odocstringstream ods;
 269         InsetText::plaintext(ods, rp);
 270         tip += ods.str();
 271         // shorten it if necessary
 272         if (tip.size() > 200)
 273                 tip = tip.substr(0, 200) + "...";
 274         return tip;
 275 }
 276
 277
 278 void InsetIndex::write(ostream & os) const
 279 {
 280         os << to_utf8(name());
 281         params_.write(os);
 282         InsetCollapsable::write(os);
 283 }
 284
 285
 286 void InsetIndex::read(Lexer & lex)
 287 {
 288         params_.read(lex);
 289         InsetCollapsable::read(lex);
 290 }
 291
 292
 293 string InsetIndex::params2string(InsetIndexParams const & params)
 294 {
 295         ostringstream data;
 296         data << "index";
 297         params.write(data);
 298         return data.str();
 299 }
 300
 301
 302 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
 303 {
 304         params = InsetIndexParams();
 305         if (in.empty())
 306                 return;
 307
 308         istringstream data(in);
 309         Lexer lex;
 310         lex.setStream(data);
 311         lex.setContext("InsetIndex::string2params");
 312         lex >> "index";
 313         params.read(lex);
 314 }
 315
 316
 317 void InsetIndex::addToToc(DocIterator const & cpit)
 318 {
 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);
 325 }
 326
 327
 328 void InsetIndex::validate(LaTeXFeatures & features) const
 329 {
 330         if (buffer().masterBuffer()->params().use_indices
 331             && !params_.index.empty()
 332             && params_.index != "idx")
 333                 features.require("splitidx");
 334 }
 335
 336
 337 docstring InsetIndex::contextMenu(BufferView const &, int, int) const
 338 {
 339         return from_ascii("context-index");
 340 }
 341
 342
 343 void InsetIndexParams::write(ostream & os) const
 344 {
 345         os << ' ';
 346         if (!index.empty())
 347                 os << to_utf8(index);
 348         else
 349                 os << "idx";
 350         os << '\n';
 351 }
 352
 353
 354 void InsetIndexParams::read(Lexer & lex)
 355 {
 356         if (lex.eatLine())
 357                 index = lex.getDocString();
 358         else
 359                 index = from_ascii("idx");
 360 }
 361
 362
 363 /////////////////////////////////////////////////////////////////////
 364 //
 365 // InsetPrintIndex
 366 //
 367 ///////////////////////////////////////////////////////////////////////
 368
 369 InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
 370         : InsetCommand(p, "index_print")
 371 {}
 372
 373
 374 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
 375 {
 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);
 380         }
 381         return param_info_;
 382 }
 383
 384
 385 docstring InsetPrintIndex::screenLabel() const
 386 {
 387         if ((!buffer().masterBuffer()->params().use_indices
 388              && getParam("type") == from_ascii("idx"))
 389             || getParam("type").empty())
 390                 return _("Index");
 391         Buffer const & realbuffer = *buffer().masterBuffer();
 392         IndicesList const & indiceslist = realbuffer.params().indiceslist();
 393         Index const * index = indiceslist.findShortcut(getParam("type"));
 394         if (!index)
 395                 return _("Unknown index type!");
 396         docstring res = index->index();
 397         if (!buffer().masterBuffer()->params().use_indices)
 398                 res += " (" + _("non-active") + ")";
 399         return res;
 400 }
 401
 402
 403 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 404 {
 405         switch (cmd.action) {
 406
 407         case LFUN_INSET_MODIFY: {
 408                 InsetCommandParams p(INDEX_PRINT_CODE);
 409                 // FIXME UNICODE
 410                 InsetCommand::string2params("index_print",
 411                         to_utf8(cmd.argument()), p);
 412                 if (p.getCmdName().empty()) {
 413                         cur.noUpdate();
 414                         break;
 415                 }
 416                 setParam("type", p["type"]);
 417                 break;
 418         }
 419
 420         default:
 421                 InsetCommand::doDispatch(cur, cmd);
 422                 break;
 423         }
 424 }
 425
 426
 427 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 428         FuncStatus & status) const
 429 {
 430         switch (cmd.action) {
 431
 432         case LFUN_INSET_MODIFY: {
 433                 if (cmd.getArg(0) == "index_print"
 434                     && cmd.getArg(1) == "CommandInset") {
 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"));
 444                         return true;
 445                 }
 446         }
 447
 448         case LFUN_INSET_DIALOG_UPDATE:
 449         case LFUN_INSET_SETTINGS: {
 450                 Buffer const & realbuffer = *buffer().masterBuffer();
 451                 status.setEnabled(realbuffer.params().use_indices);
 452                 return true;
 453         }
 454
 455         default:
 456                 return InsetCommand::getStatus(cur, cmd, status);
 457         }
 458 }
 459
 460
 461 int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
 462 {
 463         if (!buffer().masterBuffer()->params().use_indices) {
 464                 if (getParam("type") == from_ascii("idx"))
 465                         os << "\\printindex{}";
 466                 return 0;
 467         }
 468         os << getCommand();
 469         return 0;
 470 }
 471
 472
 473 void InsetPrintIndex::validate(LaTeXFeatures & features) const
 474 {
 475         features.require("makeidx");
 476         if (buffer().masterBuffer()->params().use_indices)
 477                 features.require("splitidx");
 478 }
 479
 480
 481 docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
 482 {
 483         return buffer().masterBuffer()->params().use_indices ?
 484                 from_ascii("context-indexprint") : docstring();
 485 }
 486
 487
 488 Inset::EDITABLE InsetPrintIndex::editable() const
 489 {
 490         return buffer().masterBuffer()->params().use_indices ?
 491                 IS_EDITABLE : NOT_EDITABLE;
 492 }
 493
 494
 495 } // namespace lyx