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         LYXERR0( cmd.action);
 185         LYXERR0( cmd.getArg(0));
 186         switch (cmd.action) {
 187
 188         case LFUN_INSET_MODIFY: {
 189                 if (cmd.getArg(0) == "changetype") {
 190                         params_.index = from_utf8(cmd.getArg(1));
 191                         setLayout(cur.buffer()->params());
 192                         break;
 193                 }
 194                 InsetIndexParams params;
 195                 InsetIndex::string2params(to_utf8(cmd.argument()), params);
 196                 params_.index = params.index;
 197                 setLayout(cur.buffer()->params());
 198                 break;
 199         }
 200
 201         case LFUN_INSET_DIALOG_UPDATE:
 202                 cur.bv().updateDialog("index", params2string(params_));
 203                 break;
 204
 205         default:
 206                 InsetCollapsable::doDispatch(cur, cmd);
 207                 break;
 208         }
 209 }
 210
 211
 212 bool InsetIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 213                 FuncStatus & flag) const
 214 {
 215                 LYXERR0( cmd.action);
 216         LYXERR0( cmd.getArg(0));
 217         switch (cmd.action) {
 218
 219         case LFUN_INSET_MODIFY:
 220                 if (cmd.getArg(0) == "changetype") {
 221                         docstring const newtype = from_utf8(cmd.getArg(1));
 222                         Buffer const & realbuffer = *buffer().masterBuffer();
 223                         IndicesList const & indiceslist = realbuffer.params().indiceslist();
 224                         Index const * index = indiceslist.findShortcut(newtype);
 225                         flag.setEnabled(index != 0);
 226                         flag.setOnOff(
 227                                 from_utf8(cmd.getArg(1)) == params_.index);
 228                         return true;
 229                 }
 230                 flag.setEnabled(true);
 231                 return true;
 232
 233         case LFUN_INSET_DIALOG_UPDATE: {
 234                 Buffer const & realbuffer = *buffer().masterBuffer();
 235                 flag.setEnabled(realbuffer.params().use_indices);
 236                 return true;
 237         }
 238
 239         default:
 240                 return InsetCollapsable::getStatus(cur, cmd, flag);
 241         }
 242 }
 243
 244
 245 docstring const InsetIndex::buttonLabel(BufferView const & bv) const
 246 {
 247         docstring s = _("Idx");
 248         if (decoration() == InsetLayout::CLASSIC)
 249                 return isOpen(bv) ? s : getNewLabel(s);
 250         else
 251                 return getNewLabel(s);
 252 }
 253
 254
 255 docstring InsetIndex::toolTip(BufferView const &, int, int) const
 256 {
 257         docstring tip = _("Index Entry");
 258         if (buffer().params().use_indices && !params_.index.empty()) {
 259                 Buffer const & realbuffer = *buffer().masterBuffer();
 260                 IndicesList const & indiceslist = realbuffer.params().indiceslist();
 261                 tip += " (";
 262                 Index const * index = indiceslist.findShortcut(params_.index);
 263                 if (!index)
 264                         tip += _("unknown type!");
 265                 else
 266                         tip += index->index();
 267                 tip += ")";
 268         }
 269         tip += ": ";
 270         OutputParams rp(&buffer().params().encoding());
 271         odocstringstream ods;
 272         InsetText::plaintext(ods, rp);
 273         tip += ods.str();
 274         // shorten it if necessary
 275         if (tip.size() > 200)
 276                 tip = tip.substr(0, 200) + "...";
 277         return tip;
 278 }
 279
 280
 281 void InsetIndex::write(ostream & os) const
 282 {
 283         os << to_utf8(name());
 284         params_.write(os);
 285         InsetCollapsable::write(os);
 286 }
 287
 288
 289 void InsetIndex::read(Lexer & lex)
 290 {
 291         params_.read(lex);
 292         InsetCollapsable::read(lex);
 293 }
 294
 295
 296 string InsetIndex::params2string(InsetIndexParams const & params)
 297 {
 298         ostringstream data;
 299         data << "index";
 300         params.write(data);
 301         return data.str();
 302 }
 303
 304
 305 void InsetIndex::string2params(string const & in, InsetIndexParams & params)
 306 {
 307         params = InsetIndexParams();
 308         if (in.empty())
 309                 return;
 310
 311         istringstream data(in);
 312         Lexer lex;
 313         lex.setStream(data);
 314         lex.setContext("InsetIndex::string2params");
 315         lex >> "index";
 316         params.read(lex);
 317 }
 318
 319
 320 void InsetIndex::addToToc(DocIterator const & cpit)
 321 {
 322         DocIterator pit = cpit;
 323         pit.push_back(CursorSlice(*this));
 324         docstring const item = text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
 325         buffer().tocBackend().toc("index").push_back(TocItem(pit, 0, item));
 326         // Proceed with the rest of the inset.
 327         InsetCollapsable::addToToc(cpit);
 328 }
 329
 330
 331 void InsetIndex::validate(LaTeXFeatures & features) const
 332 {
 333         if (buffer().masterBuffer()->params().use_indices
 334             && !params_.index.empty()
 335             && params_.index != "idx")
 336                 features.require("splitidx");
 337 }
 338
 339
 340 docstring InsetIndex::contextMenu(BufferView const &, int, int) const
 341 {
 342         return from_ascii("context-index");
 343 }
 344
 345
 346 bool InsetIndex::hasSettings() const
 347 {
 348         return buffer().masterBuffer()->params().use_indices;
 349 }
 350
 351
 352
 353
 354 /////////////////////////////////////////////////////////////////////
 355 //
 356 // InsetIndexParams
 357 //
 358 ///////////////////////////////////////////////////////////////////////
 359
 360
 361 void InsetIndexParams::write(ostream & os) const
 362 {
 363         os << ' ';
 364         if (!index.empty())
 365                 os << to_utf8(index);
 366         else
 367                 os << "idx";
 368         os << '\n';
 369 }
 370
 371
 372 void InsetIndexParams::read(Lexer & lex)
 373 {
 374         if (lex.eatLine())
 375                 index = lex.getDocString();
 376         else
 377                 index = from_ascii("idx");
 378 }
 379
 380
 381 /////////////////////////////////////////////////////////////////////
 382 //
 383 // InsetPrintIndex
 384 //
 385 ///////////////////////////////////////////////////////////////////////
 386
 387 InsetPrintIndex::InsetPrintIndex(InsetCommandParams const & p)
 388         : InsetCommand(p, "index_print")
 389 {}
 390
 391
 392 ParamInfo const & InsetPrintIndex::findInfo(string const & /* cmdName */)
 393 {
 394         static ParamInfo param_info_;
 395         if (param_info_.empty()) {
 396                 param_info_.add("type", ParamInfo::LATEX_OPTIONAL);
 397                 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
 398         }
 399         return param_info_;
 400 }
 401
 402
 403 docstring InsetPrintIndex::screenLabel() const
 404 {
 405         if ((!buffer().masterBuffer()->params().use_indices
 406              && getParam("type") == from_ascii("idx"))
 407             || getParam("type").empty())
 408                 return _("Index");
 409         Buffer const & realbuffer = *buffer().masterBuffer();
 410         IndicesList const & indiceslist = realbuffer.params().indiceslist();
 411         Index const * index = indiceslist.findShortcut(getParam("type"));
 412         if (!index)
 413                 return _("Unknown index type!");
 414         docstring res = index->index();
 415         if (!buffer().masterBuffer()->params().use_indices)
 416                 res += " (" + _("non-active") + ")";
 417         return res;
 418 }
 419
 420
 421 void InsetPrintIndex::doDispatch(Cursor & cur, FuncRequest & cmd)
 422 {
 423         switch (cmd.action) {
 424
 425         case LFUN_INSET_MODIFY: {
 426                 InsetCommandParams p(INDEX_PRINT_CODE);
 427                 // FIXME UNICODE
 428                 InsetCommand::string2params("index_print",
 429                         to_utf8(cmd.argument()), p);
 430                 if (p.getCmdName().empty()) {
 431                         cur.noUpdate();
 432                         break;
 433                 }
 434                 setParam("type", p["type"]);
 435                 break;
 436         }
 437
 438         default:
 439                 InsetCommand::doDispatch(cur, cmd);
 440                 break;
 441         }
 442 }
 443
 444
 445 bool InsetPrintIndex::getStatus(Cursor & cur, FuncRequest const & cmd,
 446         FuncStatus & status) const
 447 {
 448         switch (cmd.action) {
 449
 450         case LFUN_INSET_MODIFY: {
 451                 if (cmd.getArg(0) == "index_print"
 452                     && cmd.getArg(1) == "CommandInset") {
 453                         InsetCommandParams p(INDEX_PRINT_CODE);
 454                         InsetCommand::string2params("index_print",
 455                                 to_utf8(cmd.argument()), p);
 456                         Buffer const & realbuffer = *buffer().masterBuffer();
 457                         IndicesList const & indiceslist =
 458                                 realbuffer.params().indiceslist();
 459                         Index const * index = indiceslist.findShortcut(p["type"]);
 460                         status.setEnabled(index != 0);
 461                         status.setOnOff(p["type"] == getParam("type"));
 462                         return true;
 463                 } else
 464                         return InsetCommand::getStatus(cur, cmd, status);
 465         }
 466
 467         case LFUN_INSET_DIALOG_UPDATE: {
 468                 Buffer const & realbuffer = *buffer().masterBuffer();
 469                 status.setEnabled(realbuffer.params().use_indices);
 470                 return true;
 471         }
 472
 473         default:
 474                 return InsetCommand::getStatus(cur, cmd, status);
 475         }
 476 }
 477
 478
 479 int InsetPrintIndex::latex(odocstream & os, OutputParams const &) const
 480 {
 481         if (!buffer().masterBuffer()->params().use_indices) {
 482                 if (getParam("type") == from_ascii("idx"))
 483                         os << "\\printindex{}";
 484                 return 0;
 485         }
 486         os << getCommand();
 487         return 0;
 488 }
 489
 490
 491 void InsetPrintIndex::validate(LaTeXFeatures & features) const
 492 {
 493         features.require("makeidx");
 494         if (buffer().masterBuffer()->params().use_indices)
 495                 features.require("splitidx");
 496 }
 497
 498
 499 docstring InsetPrintIndex::contextMenu(BufferView const &, int, int) const
 500 {
 501         return buffer().masterBuffer()->params().use_indices ?
 502                 from_ascii("context-indexprint") : docstring();
 503 }
 504
 505
 506 bool InsetPrintIndex::hasSettings() const
 507 {
 508         return buffer().masterBuffer()->params().use_indices;
 509 }
 510
 511
 512 } // namespace lyx